xref: /petsc/src/ksp/pc/impls/fieldsplit/fieldsplit.c (revision 568ed31e2bf0c8080c37db547eac2c44f6fbde60)
1dba47a55SKris Buschelman 
2af0996ceSBarry Smith #include <petsc/private/pcimpl.h>     /*I "petscpc.h" I*/
31e25c274SJed Brown #include <petscdm.h>
40971522cSBarry Smith 
5443836d0SMatthew G Knepley 
62e71c61dSMatthew G. Knepley const char *const PCFieldSplitSchurPreTypes[] = {"SELF","SELFP","A11","USER","FULL","PCFieldSplitSchurPreType","PC_FIELDSPLIT_SCHUR_PRE_",0};
7c9c6ffaaSJed Brown const char *const PCFieldSplitSchurFactTypes[] = {"DIAG","LOWER","UPPER","FULL","PCFieldSplitSchurFactType","PC_FIELDSPLIT_SCHUR_FACT_",0};
8c5d2311dSJed Brown 
90971522cSBarry Smith typedef struct _PC_FieldSplitLink *PC_FieldSplitLink;
100971522cSBarry Smith struct _PC_FieldSplitLink {
1169a612a9SBarry Smith   KSP               ksp;
12443836d0SMatthew G Knepley   Vec               x,y,z;
13db4c96c1SJed Brown   char              *splitname;
140971522cSBarry Smith   PetscInt          nfields;
155d4c12cdSJungho Lee   PetscInt          *fields,*fields_col;
161b9fc7fcSBarry Smith   VecScatter        sctx;
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:
1711d71051fSDmitry Karpeev       ierr = PetscViewerASCIIPrintf(viewer,"  Preconditioner for the Schur complement formed from Sp, an assembled approximation to S, which uses (lumped, if requested) A00's diagonal's inverse\n");CHKERRQ(ierr);break;
172e87fab1bSBarry Smith     case PC_FIELDSPLIT_SCHUR_PRE_A11:
173e87fab1bSBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"  Preconditioner for the Schur complement formed from A11\n");CHKERRQ(ierr);break;
174e74569cdSMatthew G. Knepley     case PC_FIELDSPLIT_SCHUR_PRE_FULL:
175e74569cdSMatthew G. Knepley       ierr = PetscViewerASCIIPrintf(viewer,"  Preconditioner for the Schur complement formed from the exact Schur complement\n");CHKERRQ(ierr);break;
1763e8b8b31SMatthew G Knepley     case PC_FIELDSPLIT_SCHUR_PRE_USER:
1773e8b8b31SMatthew G Knepley       if (jac->schur_user) {
1783e8b8b31SMatthew G Knepley         ierr = PetscViewerASCIIPrintf(viewer,"  Preconditioner for the Schur complement formed from user provided matrix\n");CHKERRQ(ierr);
1793e8b8b31SMatthew G Knepley       } else {
180e87fab1bSBarry Smith         ierr = PetscViewerASCIIPrintf(viewer,"  Preconditioner for the Schur complement formed from A11\n");CHKERRQ(ierr);
1813e8b8b31SMatthew G Knepley       }
1823e8b8b31SMatthew G Knepley       break;
1833e8b8b31SMatthew G Knepley     default:
18482f516ccSBarry Smith       SETERRQ1(PetscObjectComm((PetscObject)pc), PETSC_ERR_ARG_OUTOFRANGE, "Invalid Schur preconditioning type: %d", jac->schurpre);
1853e8b8b31SMatthew G Knepley     }
1863b224e63SBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"  Split info:\n");CHKERRQ(ierr);
1873b224e63SBarry Smith     ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
1883b224e63SBarry Smith     for (i=0; i<jac->nsplits; i++) {
1893b224e63SBarry Smith       if (ilink->fields) {
1903b224e63SBarry Smith         ierr = PetscViewerASCIIPrintf(viewer,"Split number %D Fields ",i);CHKERRQ(ierr);
1913b224e63SBarry Smith         ierr = PetscViewerASCIIUseTabs(viewer,PETSC_FALSE);CHKERRQ(ierr);
1923b224e63SBarry Smith         for (j=0; j<ilink->nfields; j++) {
1933b224e63SBarry Smith           if (j > 0) {
1943b224e63SBarry Smith             ierr = PetscViewerASCIIPrintf(viewer,",");CHKERRQ(ierr);
1953b224e63SBarry Smith           }
1963b224e63SBarry Smith           ierr = PetscViewerASCIIPrintf(viewer," %D",ilink->fields[j]);CHKERRQ(ierr);
1973b224e63SBarry Smith         }
1983b224e63SBarry Smith         ierr = PetscViewerASCIIPrintf(viewer,"\n");CHKERRQ(ierr);
1993b224e63SBarry Smith         ierr = PetscViewerASCIIUseTabs(viewer,PETSC_TRUE);CHKERRQ(ierr);
2003b224e63SBarry Smith       } else {
2013b224e63SBarry Smith         ierr = PetscViewerASCIIPrintf(viewer,"Split number %D Defined by IS\n",i);CHKERRQ(ierr);
2023b224e63SBarry Smith       }
2033b224e63SBarry Smith       ilink = ilink->next;
2043b224e63SBarry Smith     }
205435f959eSBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"KSP solver for A00 block\n");CHKERRQ(ierr);
2063b224e63SBarry Smith     ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
20706de4afeSJed Brown     if (jac->head) {
208443836d0SMatthew G Knepley       ierr = KSPView(jac->head->ksp,viewer);CHKERRQ(ierr);
20906de4afeSJed Brown     } else  {ierr = PetscViewerASCIIPrintf(viewer,"  not yet available\n");CHKERRQ(ierr);}
2103b224e63SBarry Smith     ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
21106de4afeSJed Brown     if (jac->head && jac->kspupper != jac->head->ksp) {
212443836d0SMatthew G Knepley       ierr = PetscViewerASCIIPrintf(viewer,"KSP solver for upper A00 in upper triangular factor \n");CHKERRQ(ierr);
213443836d0SMatthew G Knepley       ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
214b2750c55SJed Brown       if (jac->kspupper) {ierr = KSPView(jac->kspupper,viewer);CHKERRQ(ierr);}
215b2750c55SJed Brown       else {ierr = PetscViewerASCIIPrintf(viewer,"  not yet available\n");CHKERRQ(ierr);}
216443836d0SMatthew G Knepley       ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
217443836d0SMatthew G Knepley     }
218435f959eSBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"KSP solver for S = A11 - A10 inv(A00) A01 \n");CHKERRQ(ierr);
2193b224e63SBarry Smith     ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
22012cae6f2SJed Brown     if (jac->kspschur) {
2213b224e63SBarry Smith       ierr = KSPView(jac->kspschur,viewer);CHKERRQ(ierr);
22212cae6f2SJed Brown     } else {
22312cae6f2SJed Brown       ierr = PetscViewerASCIIPrintf(viewer,"  not yet available\n");CHKERRQ(ierr);
22412cae6f2SJed Brown     }
2253b224e63SBarry Smith     ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
2263b224e63SBarry Smith     ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
22706de4afeSJed Brown   } else if (isdraw && jac->head) {
2284996c5bdSBarry Smith     PetscDraw draw;
2294996c5bdSBarry Smith     PetscReal x,y,w,wd,h;
2304996c5bdSBarry Smith     PetscInt  cnt = 2;
2314996c5bdSBarry Smith     char      str[32];
2324996c5bdSBarry Smith 
2334996c5bdSBarry Smith     ierr = PetscViewerDrawGetDraw(viewer,0,&draw);CHKERRQ(ierr);
2344996c5bdSBarry Smith     ierr = PetscDrawGetCurrentPoint(draw,&x,&y);CHKERRQ(ierr);
235c74581afSBarry Smith     if (jac->kspupper != jac->head->ksp) cnt++;
236c74581afSBarry Smith     w  = 2*PetscMin(1.0 - x,x);
237c74581afSBarry Smith     wd = w/(cnt + 1);
238c74581afSBarry Smith 
2394996c5bdSBarry Smith     ierr = PetscSNPrintf(str,32,"Schur fact. %s",PCFieldSplitSchurFactTypes[jac->schurfactorization]);CHKERRQ(ierr);
24051fa3d41SBarry Smith     ierr = PetscDrawStringBoxed(draw,x,y,PETSC_DRAW_RED,PETSC_DRAW_BLACK,str,NULL,&h);CHKERRQ(ierr);
2414996c5bdSBarry Smith     y   -= h;
2424996c5bdSBarry Smith     if (jac->schurpre == PC_FIELDSPLIT_SCHUR_PRE_USER &&  !jac->schur_user) {
243e87fab1bSBarry Smith       ierr = PetscSNPrintf(str,32,"Prec. for Schur from %s",PCFieldSplitSchurPreTypes[PC_FIELDSPLIT_SCHUR_PRE_A11]);CHKERRQ(ierr);
2443b224e63SBarry Smith     } else {
2454996c5bdSBarry Smith       ierr = PetscSNPrintf(str,32,"Prec. for Schur from %s",PCFieldSplitSchurPreTypes[jac->schurpre]);CHKERRQ(ierr);
2464996c5bdSBarry Smith     }
24751fa3d41SBarry Smith     ierr = PetscDrawStringBoxed(draw,x+wd*(cnt-1)/2.0,y,PETSC_DRAW_RED,PETSC_DRAW_BLACK,str,NULL,&h);CHKERRQ(ierr);
2484996c5bdSBarry Smith     y   -= h;
2494996c5bdSBarry Smith     x    = x - wd*(cnt-1)/2.0;
2504996c5bdSBarry Smith 
2514996c5bdSBarry Smith     ierr = PetscDrawPushCurrentPoint(draw,x,y);CHKERRQ(ierr);
2524996c5bdSBarry Smith     ierr = KSPView(jac->head->ksp,viewer);CHKERRQ(ierr);
2534996c5bdSBarry Smith     ierr = PetscDrawPopCurrentPoint(draw);CHKERRQ(ierr);
2544996c5bdSBarry Smith     if (jac->kspupper != jac->head->ksp) {
2554996c5bdSBarry Smith       x   += wd;
2564996c5bdSBarry Smith       ierr = PetscDrawPushCurrentPoint(draw,x,y);CHKERRQ(ierr);
2574996c5bdSBarry Smith       ierr = KSPView(jac->kspupper,viewer);CHKERRQ(ierr);
2584996c5bdSBarry Smith       ierr = PetscDrawPopCurrentPoint(draw);CHKERRQ(ierr);
2594996c5bdSBarry Smith     }
2604996c5bdSBarry Smith     x   += wd;
2614996c5bdSBarry Smith     ierr = PetscDrawPushCurrentPoint(draw,x,y);CHKERRQ(ierr);
2624996c5bdSBarry Smith     ierr = KSPView(jac->kspschur,viewer);CHKERRQ(ierr);
2634996c5bdSBarry Smith     ierr = PetscDrawPopCurrentPoint(draw);CHKERRQ(ierr);
2643b224e63SBarry Smith   }
2653b224e63SBarry Smith   PetscFunctionReturn(0);
2663b224e63SBarry Smith }
2673b224e63SBarry Smith 
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;
288c5929fdfSBarry Smith     ierr        = PetscOptionsGetIntArray(((PetscObject)pc)->options,((PetscObject)pc)->prefix,optionname,ifields,&nfields,&flg);CHKERRQ(ierr);
289c5929fdfSBarry Smith     ierr        = PetscOptionsGetIntArray(((PetscObject)pc)->options,((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) {
327c5929fdfSBarry Smith     ierr = PetscOptionsGetBool(((PetscObject)pc)->options,((PetscObject)pc)->prefix,"-pc_fieldsplit_detect_saddle_point",&stokes,NULL);CHKERRQ(ierr);
328c5929fdfSBarry Smith     ierr = PetscOptionsGetBool(((PetscObject)pc)->options,((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);
346c5929fdfSBarry Smith         ierr = PetscOptionsGetIntArray(((PetscObject)pc)->options,((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);
426e52d2c62SBarry Smith         ierr = ISSetIdentity(rest);CHKERRQ(ierr);
4273a062f41SBarry Smith         if (jac->reset) {
428bb3d4b4cSBarry Smith           jac->head->is       = rest;
429bb3d4b4cSBarry Smith           jac->head->next->is = coupling;
4303a062f41SBarry Smith         } else {
431d020c841SBarry Smith           ierr = PCFieldSplitSetIS(pc,"0",rest);CHKERRQ(ierr);
432d020c841SBarry Smith           ierr = PCFieldSplitSetIS(pc,"1",coupling);CHKERRQ(ierr);
4333a062f41SBarry Smith         }
4343a062f41SBarry Smith         ierr = ISDestroy(&coupling);CHKERRQ(ierr);
4353a062f41SBarry Smith         ierr = ISDestroy(&rest);CHKERRQ(ierr);
4366ce1633cSBarry Smith       } else {
437ce94432eSBarry Smith         if (jac->reset) SETERRQ(PetscObjectComm((PetscObject)pc),PETSC_ERR_SUP,"Cases not yet handled when PCReset() was used");
438c5929fdfSBarry Smith         ierr = PetscOptionsGetBool(((PetscObject)pc)->options,((PetscObject)pc)->prefix,"-pc_fieldsplit_default",&fieldsplit_default,NULL);CHKERRQ(ierr);
4397287d2a3SDmitry Karpeev         if (!fieldsplit_default) {
440d32f9abdSBarry Smith           /* Allow user to set fields from command line,  if bs was known at the time of PCSetFromOptions_FieldSplit()
441d32f9abdSBarry Smith            then it is set there. This is not ideal because we should only have options set in XXSetFromOptions(). */
4426c924f48SJed Brown           ierr = PCFieldSplitSetRuntimeSplits_Private(pc);CHKERRQ(ierr);
4436c924f48SJed Brown           if (jac->splitdefined) {ierr = PetscInfo(pc,"Splits defined using the options database\n");CHKERRQ(ierr);}
444d32f9abdSBarry Smith         }
4457287d2a3SDmitry Karpeev         if (fieldsplit_default || !jac->splitdefined) {
446d32f9abdSBarry Smith           ierr = PetscInfo(pc,"Using default splitting of fields\n");CHKERRQ(ierr);
447db4c96c1SJed Brown           for (i=0; i<jac->bs; i++) {
4486c924f48SJed Brown             char splitname[8];
4498caf3d72SBarry Smith             ierr = PetscSNPrintf(splitname,sizeof(splitname),"%D",i);CHKERRQ(ierr);
4505d4c12cdSJungho Lee             ierr = PCFieldSplitSetFields(pc,splitname,1,&i,&i);CHKERRQ(ierr);
45179416396SBarry Smith           }
4525d4c12cdSJungho Lee           jac->defaultsplit = PETSC_TRUE;
453521d7252SBarry Smith         }
45466ffff09SJed Brown       }
4556ce1633cSBarry Smith     }
456edf189efSBarry Smith   } else if (jac->nsplits == 1) {
457edf189efSBarry Smith     if (ilink->is) {
458edf189efSBarry Smith       IS       is2;
459edf189efSBarry Smith       PetscInt nmin,nmax;
460edf189efSBarry Smith 
461edf189efSBarry Smith       ierr = MatGetOwnershipRange(pc->mat,&nmin,&nmax);CHKERRQ(ierr);
462edf189efSBarry Smith       ierr = ISComplement(ilink->is,nmin,nmax,&is2);CHKERRQ(ierr);
463db4c96c1SJed Brown       ierr = PCFieldSplitSetIS(pc,"1",is2);CHKERRQ(ierr);
464fcfd50ebSBarry Smith       ierr = ISDestroy(&is2);CHKERRQ(ierr);
46582f516ccSBarry Smith     } else SETERRQ(PetscObjectComm((PetscObject)pc),PETSC_ERR_SUP,"Must provide at least two sets of fields to PCFieldSplit()");
466edf189efSBarry Smith   }
467d0af7cd3SBarry Smith 
468d0af7cd3SBarry Smith 
46982f516ccSBarry Smith   if (jac->nsplits < 2) SETERRQ1(PetscObjectComm((PetscObject)pc),PETSC_ERR_PLIB,"Unhandled case, must have at least two fields, not %d", jac->nsplits);
47069a612a9SBarry Smith   PetscFunctionReturn(0);
47169a612a9SBarry Smith }
47269a612a9SBarry Smith 
473c5929fdfSBarry Smith PETSC_EXTERN PetscErrorCode PetscOptionsFindPairPrefix_Private(PetscOptions,const char pre[], const char name[], char *value[], PetscBool *flg);
474514bf10dSMatthew G Knepley 
47569a612a9SBarry Smith #undef __FUNCT__
47669a612a9SBarry Smith #define __FUNCT__ "PCSetUp_FieldSplit"
47769a612a9SBarry Smith static PetscErrorCode PCSetUp_FieldSplit(PC pc)
47869a612a9SBarry Smith {
47969a612a9SBarry Smith   PC_FieldSplit     *jac = (PC_FieldSplit*)pc->data;
48069a612a9SBarry Smith   PetscErrorCode    ierr;
4815a9f2f41SSatish Balay   PC_FieldSplitLink ilink;
4822c9966d7SBarry Smith   PetscInt          i,nsplit;
4835f4ab4e1SJungho Lee   PetscBool         sorted, sorted_col;
48469a612a9SBarry Smith 
48569a612a9SBarry Smith   PetscFunctionBegin;
48669a612a9SBarry Smith   ierr   = PCFieldSplitSetDefaults(pc);CHKERRQ(ierr);
48797bbdb24SBarry Smith   nsplit = jac->nsplits;
4885a9f2f41SSatish Balay   ilink  = jac->head;
48997bbdb24SBarry Smith 
49097bbdb24SBarry Smith   /* get the matrices for each split */
491704ba839SBarry Smith   if (!jac->issetup) {
4921b9fc7fcSBarry Smith     PetscInt rstart,rend,nslots,bs;
49397bbdb24SBarry Smith 
494704ba839SBarry Smith     jac->issetup = PETSC_TRUE;
495704ba839SBarry Smith 
4965d4c12cdSJungho Lee     /* This is done here instead of in PCFieldSplitSetFields() because may not have matrix at that point */
4972c9966d7SBarry Smith     if (jac->defaultsplit || !ilink->is) {
4982c9966d7SBarry Smith       if (jac->bs <= 0) jac->bs = nsplit;
4992c9966d7SBarry Smith     }
50051f519a2SBarry Smith     bs     = jac->bs;
50197bbdb24SBarry Smith     ierr   = MatGetOwnershipRange(pc->pmat,&rstart,&rend);CHKERRQ(ierr);
5021b9fc7fcSBarry Smith     nslots = (rend - rstart)/bs;
5031b9fc7fcSBarry Smith     for (i=0; i<nsplit; i++) {
5041b9fc7fcSBarry Smith       if (jac->defaultsplit) {
505ce94432eSBarry Smith         ierr = ISCreateStride(PetscObjectComm((PetscObject)pc),nslots,rstart+i,nsplit,&ilink->is);CHKERRQ(ierr);
5065f4ab4e1SJungho Lee         ierr = ISDuplicate(ilink->is,&ilink->is_col);CHKERRQ(ierr);
507704ba839SBarry Smith       } else if (!ilink->is) {
508ccb205f8SBarry Smith         if (ilink->nfields > 1) {
5095f4ab4e1SJungho Lee           PetscInt *ii,*jj,j,k,nfields = ilink->nfields,*fields = ilink->fields,*fields_col = ilink->fields_col;
510785e854fSJed Brown           ierr = PetscMalloc1(ilink->nfields*nslots,&ii);CHKERRQ(ierr);
511785e854fSJed Brown           ierr = PetscMalloc1(ilink->nfields*nslots,&jj);CHKERRQ(ierr);
5121b9fc7fcSBarry Smith           for (j=0; j<nslots; j++) {
5131b9fc7fcSBarry Smith             for (k=0; k<nfields; k++) {
5141b9fc7fcSBarry Smith               ii[nfields*j + k] = rstart + bs*j + fields[k];
5155f4ab4e1SJungho Lee               jj[nfields*j + k] = rstart + bs*j + fields_col[k];
51697bbdb24SBarry Smith             }
51797bbdb24SBarry Smith           }
518ce94432eSBarry Smith           ierr = ISCreateGeneral(PetscObjectComm((PetscObject)pc),nslots*nfields,ii,PETSC_OWN_POINTER,&ilink->is);CHKERRQ(ierr);
519ce94432eSBarry Smith           ierr = ISCreateGeneral(PetscObjectComm((PetscObject)pc),nslots*nfields,jj,PETSC_OWN_POINTER,&ilink->is_col);CHKERRQ(ierr);
52090e68f20SPatrick Farrell           ierr = ISSetBlockSize(ilink->is, nfields);CHKERRQ(ierr);
52190e68f20SPatrick Farrell           ierr = ISSetBlockSize(ilink->is_col, nfields);CHKERRQ(ierr);
522ccb205f8SBarry Smith         } else {
523ce94432eSBarry Smith           ierr = ISCreateStride(PetscObjectComm((PetscObject)pc),nslots,rstart+ilink->fields[0],bs,&ilink->is);CHKERRQ(ierr);
524ce94432eSBarry Smith           ierr = ISCreateStride(PetscObjectComm((PetscObject)pc),nslots,rstart+ilink->fields_col[0],bs,&ilink->is_col);CHKERRQ(ierr);
525ccb205f8SBarry Smith        }
5263e197d65SBarry Smith       }
527704ba839SBarry Smith       ierr = ISSorted(ilink->is,&sorted);CHKERRQ(ierr);
5285f4ab4e1SJungho Lee       if (ilink->is_col) { ierr = ISSorted(ilink->is_col,&sorted_col);CHKERRQ(ierr); }
5295f4ab4e1SJungho Lee       if (!sorted || !sorted_col) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_USER,"Fields must be sorted when creating split");
530704ba839SBarry Smith       ilink = ilink->next;
5311b9fc7fcSBarry Smith     }
5321b9fc7fcSBarry Smith   }
5331b9fc7fcSBarry Smith 
534704ba839SBarry Smith   ilink = jac->head;
53597bbdb24SBarry Smith   if (!jac->pmat) {
536bdddcaaaSMatthew G Knepley     Vec xtmp;
537bdddcaaaSMatthew G Knepley 
5382a7a6963SBarry Smith     ierr = MatCreateVecs(pc->pmat,&xtmp,NULL);CHKERRQ(ierr);
539785e854fSJed Brown     ierr = PetscMalloc1(nsplit,&jac->pmat);CHKERRQ(ierr);
540dcca6d9dSJed Brown     ierr = PetscMalloc2(nsplit,&jac->x,nsplit,&jac->y);CHKERRQ(ierr);
541cf502942SBarry Smith     for (i=0; i<nsplit; i++) {
542bdddcaaaSMatthew G Knepley       MatNullSpace sp;
543bdddcaaaSMatthew G Knepley 
544a3df900dSMatthew G Knepley       /* Check for preconditioning matrix attached to IS */
545a3df900dSMatthew G Knepley       ierr = PetscObjectQuery((PetscObject) ilink->is, "pmat", (PetscObject*) &jac->pmat[i]);CHKERRQ(ierr);
546a3df900dSMatthew G Knepley       if (jac->pmat[i]) {
547a3df900dSMatthew G Knepley         ierr = PetscObjectReference((PetscObject) jac->pmat[i]);CHKERRQ(ierr);
548a3df900dSMatthew G Knepley         if (jac->type == PC_COMPOSITE_SCHUR) {
549a3df900dSMatthew G Knepley           jac->schur_user = jac->pmat[i];
5502fa5cd67SKarl Rupp 
551a3df900dSMatthew G Knepley           ierr = PetscObjectReference((PetscObject) jac->schur_user);CHKERRQ(ierr);
552a3df900dSMatthew G Knepley         }
553a3df900dSMatthew G Knepley       } else {
5543a062f41SBarry Smith         const char *prefix;
5555f4ab4e1SJungho Lee         ierr = MatGetSubMatrix(pc->pmat,ilink->is,ilink->is_col,MAT_INITIAL_MATRIX,&jac->pmat[i]);CHKERRQ(ierr);
5563a062f41SBarry Smith         ierr = KSPGetOptionsPrefix(ilink->ksp,&prefix);CHKERRQ(ierr);
5573a062f41SBarry Smith         ierr = MatSetOptionsPrefix(jac->pmat[i],prefix);CHKERRQ(ierr);
5583a062f41SBarry Smith         ierr = MatViewFromOptions(jac->pmat[i],NULL,"-mat_view");CHKERRQ(ierr);
559a3df900dSMatthew G Knepley       }
560bdddcaaaSMatthew G Knepley       /* create work vectors for each split */
5612a7a6963SBarry Smith       ierr     = MatCreateVecs(jac->pmat[i],&jac->x[i],&jac->y[i]);CHKERRQ(ierr);
5620298fd71SBarry Smith       ilink->x = jac->x[i]; ilink->y = jac->y[i]; ilink->z = NULL;
563bdddcaaaSMatthew G Knepley       /* compute scatter contexts needed by multiplicative versions and non-default splits */
5640298fd71SBarry Smith       ierr = VecScatterCreate(xtmp,ilink->is,jac->x[i],NULL,&ilink->sctx);CHKERRQ(ierr);
565ed1f0337SMatthew G Knepley       ierr = PetscObjectQuery((PetscObject) ilink->is, "nearnullspace", (PetscObject*) &sp);CHKERRQ(ierr);
566ed1f0337SMatthew G Knepley       if (sp) {
567ed1f0337SMatthew G Knepley         ierr = MatSetNearNullSpace(jac->pmat[i], sp);CHKERRQ(ierr);
568ed1f0337SMatthew G Knepley       }
569704ba839SBarry Smith       ilink = ilink->next;
570cf502942SBarry Smith     }
571bdddcaaaSMatthew G Knepley     ierr = VecDestroy(&xtmp);CHKERRQ(ierr);
57297bbdb24SBarry Smith   } else {
573cf502942SBarry Smith     for (i=0; i<nsplit; i++) {
574a3df900dSMatthew G Knepley       Mat pmat;
575a3df900dSMatthew G Knepley 
576a3df900dSMatthew G Knepley       /* Check for preconditioning matrix attached to IS */
577a3df900dSMatthew G Knepley       ierr = PetscObjectQuery((PetscObject) ilink->is, "pmat", (PetscObject*) &pmat);CHKERRQ(ierr);
578a3df900dSMatthew G Knepley       if (!pmat) {
5795f4ab4e1SJungho Lee         ierr = MatGetSubMatrix(pc->pmat,ilink->is,ilink->is_col,MAT_REUSE_MATRIX,&jac->pmat[i]);CHKERRQ(ierr);
580a3df900dSMatthew G Knepley       }
581704ba839SBarry Smith       ilink = ilink->next;
582cf502942SBarry Smith     }
58397bbdb24SBarry Smith   }
5844e39094bSDmitry Karpeev   if (jac->diag_use_amat) {
585519d70e2SJed Brown     ilink = jac->head;
586519d70e2SJed Brown     if (!jac->mat) {
587785e854fSJed Brown       ierr = PetscMalloc1(nsplit,&jac->mat);CHKERRQ(ierr);
588519d70e2SJed Brown       for (i=0; i<nsplit; i++) {
5895f4ab4e1SJungho Lee         ierr  = MatGetSubMatrix(pc->mat,ilink->is,ilink->is_col,MAT_INITIAL_MATRIX,&jac->mat[i]);CHKERRQ(ierr);
590519d70e2SJed Brown         ilink = ilink->next;
591519d70e2SJed Brown       }
592519d70e2SJed Brown     } else {
593519d70e2SJed Brown       for (i=0; i<nsplit; i++) {
5945f4ab4e1SJungho Lee         if (jac->mat[i]) {ierr = MatGetSubMatrix(pc->mat,ilink->is,ilink->is_col,MAT_REUSE_MATRIX,&jac->mat[i]);CHKERRQ(ierr);}
595519d70e2SJed Brown         ilink = ilink->next;
596519d70e2SJed Brown       }
597519d70e2SJed Brown     }
598519d70e2SJed Brown   } else {
599519d70e2SJed Brown     jac->mat = jac->pmat;
600519d70e2SJed Brown   }
60197bbdb24SBarry Smith 
60253935eafSBarry Smith   /* Check for null space attached to IS */
60353935eafSBarry Smith   ilink = jac->head;
60453935eafSBarry Smith   for (i=0; i<nsplit; i++) {
60553935eafSBarry Smith     MatNullSpace sp;
60653935eafSBarry Smith 
60753935eafSBarry Smith     ierr = PetscObjectQuery((PetscObject) ilink->is, "nullspace", (PetscObject*) &sp);CHKERRQ(ierr);
60853935eafSBarry Smith     if (sp) {
60953935eafSBarry Smith       ierr = MatSetNullSpace(jac->mat[i], sp);CHKERRQ(ierr);
61053935eafSBarry Smith     }
61153935eafSBarry Smith     ilink = ilink->next;
61253935eafSBarry Smith   }
61353935eafSBarry Smith 
6146c8605c2SJed Brown   if (jac->type != PC_COMPOSITE_ADDITIVE  && jac->type != PC_COMPOSITE_SCHUR) {
61568dd23aaSBarry Smith     /* extract the rows of the matrix associated with each field: used for efficient computation of residual inside algorithm */
6164e39094bSDmitry Karpeev     /* FIXME: Can/should we reuse jac->mat whenever (jac->diag_use_amat) is true? */
61768dd23aaSBarry Smith     ilink = jac->head;
618e52d2c62SBarry Smith     if (nsplit == 2 && jac->type == PC_COMPOSITE_MULTIPLICATIVE) {
619e52d2c62SBarry Smith       /* special case need where Afield[0] is not needed and only certain columns of Afield[1] are needed since update is only on those rows of the solution */
620e52d2c62SBarry Smith       if (!jac->Afield) {
621e52d2c62SBarry Smith         ierr = PetscCalloc1(nsplit,&jac->Afield);CHKERRQ(ierr);
622e52d2c62SBarry Smith         ierr  = MatGetSubMatrix(pc->mat,ilink->next->is,ilink->is,MAT_INITIAL_MATRIX,&jac->Afield[1]);CHKERRQ(ierr);
623e52d2c62SBarry Smith       } else {
624e52d2c62SBarry Smith         ierr  = MatGetSubMatrix(pc->mat,ilink->next->is,ilink->is,MAT_REUSE_MATRIX,&jac->Afield[1]);CHKERRQ(ierr);
625e52d2c62SBarry Smith       }
626e52d2c62SBarry Smith     } else {
62768dd23aaSBarry Smith       if (!jac->Afield) {
628785e854fSJed Brown         ierr = PetscMalloc1(nsplit,&jac->Afield);CHKERRQ(ierr);
62968dd23aaSBarry Smith         for (i=0; i<nsplit; i++) {
6300298fd71SBarry Smith           ierr  = MatGetSubMatrix(pc->mat,ilink->is,NULL,MAT_INITIAL_MATRIX,&jac->Afield[i]);CHKERRQ(ierr);
63168dd23aaSBarry Smith           ilink = ilink->next;
63268dd23aaSBarry Smith         }
63368dd23aaSBarry Smith       } else {
63468dd23aaSBarry Smith         for (i=0; i<nsplit; i++) {
6350298fd71SBarry Smith           ierr  = MatGetSubMatrix(pc->mat,ilink->is,NULL,MAT_REUSE_MATRIX,&jac->Afield[i]);CHKERRQ(ierr);
63668dd23aaSBarry Smith           ilink = ilink->next;
63768dd23aaSBarry Smith         }
63868dd23aaSBarry Smith       }
63968dd23aaSBarry Smith     }
640e52d2c62SBarry Smith   }
64168dd23aaSBarry Smith 
6423b224e63SBarry Smith   if (jac->type == PC_COMPOSITE_SCHUR) {
6433b224e63SBarry Smith     IS          ccis;
6444aa3045dSJed Brown     PetscInt    rstart,rend;
645093c86ffSJed Brown     char        lscname[256];
646093c86ffSJed Brown     PetscObject LSC_L;
647ce94432eSBarry Smith 
648ce94432eSBarry Smith     if (nsplit != 2) SETERRQ(PetscObjectComm((PetscObject)pc),PETSC_ERR_ARG_INCOMP,"To use Schur complement preconditioner you must have exactly 2 fields");
64968dd23aaSBarry Smith 
650e6cab6aaSJed Brown     /* When extracting off-diagonal submatrices, we take complements from this range */
651e6cab6aaSJed Brown     ierr = MatGetOwnershipRangeColumn(pc->mat,&rstart,&rend);CHKERRQ(ierr);
652e6cab6aaSJed Brown 
6533b224e63SBarry Smith     /* need to handle case when one is resetting up the preconditioner */
6543b224e63SBarry Smith     if (jac->schur) {
6550298fd71SBarry Smith       KSP kspA = jac->head->ksp, kspInner = NULL, kspUpper = jac->kspupper;
656443836d0SMatthew G Knepley 
657fb3147dbSMatthew G Knepley       ierr  = MatSchurComplementGetKSP(jac->schur, &kspInner);CHKERRQ(ierr);
6583b224e63SBarry Smith       ilink = jac->head;
65949bb4cd7SJungho Lee       ierr  = ISComplement(ilink->is_col,rstart,rend,&ccis);CHKERRQ(ierr);
6604e39094bSDmitry Karpeev       if (jac->offdiag_use_amat) {
6614aa3045dSJed Brown 	ierr  = MatGetSubMatrix(pc->mat,ilink->is,ccis,MAT_REUSE_MATRIX,&jac->B);CHKERRQ(ierr);
662c84da90fSDmitry Karpeev       } else {
663df06c9e3SDmitry Karpeev 	ierr  = MatGetSubMatrix(pc->pmat,ilink->is,ccis,MAT_REUSE_MATRIX,&jac->B);CHKERRQ(ierr);
664c84da90fSDmitry Karpeev       }
665fcfd50ebSBarry Smith       ierr  = ISDestroy(&ccis);CHKERRQ(ierr);
6663b224e63SBarry Smith       ilink = ilink->next;
66749bb4cd7SJungho Lee       ierr  = ISComplement(ilink->is_col,rstart,rend,&ccis);CHKERRQ(ierr);
6684e39094bSDmitry Karpeev       if (jac->offdiag_use_amat) {
6694aa3045dSJed Brown 	ierr  = MatGetSubMatrix(pc->mat,ilink->is,ccis,MAT_REUSE_MATRIX,&jac->C);CHKERRQ(ierr);
670c84da90fSDmitry Karpeev       } else {
671df06c9e3SDmitry Karpeev 	ierr  = MatGetSubMatrix(pc->pmat,ilink->is,ccis,MAT_REUSE_MATRIX,&jac->C);CHKERRQ(ierr);
672c84da90fSDmitry Karpeev       }
673fcfd50ebSBarry Smith       ierr  = ISDestroy(&ccis);CHKERRQ(ierr);
674aa6c7ce3SBarry Smith       ierr  = MatSchurComplementUpdateSubMatrices(jac->schur,jac->mat[0],jac->pmat[0],jac->B,jac->C,jac->mat[1]);CHKERRQ(ierr);
675a7476a74SDmitry Karpeev       if (jac->schurpre == PC_FIELDSPLIT_SCHUR_PRE_SELFP) {
676a7476a74SDmitry Karpeev 	ierr = MatDestroy(&jac->schurp);CHKERRQ(ierr);
677a7476a74SDmitry Karpeev 	ierr = MatSchurComplementGetPmat(jac->schur,MAT_INITIAL_MATRIX,&jac->schurp);CHKERRQ(ierr);
678a7476a74SDmitry Karpeev       }
679443836d0SMatthew G Knepley       if (kspA != kspInner) {
68023ee1639SBarry Smith         ierr = KSPSetOperators(kspA,jac->mat[0],jac->pmat[0]);CHKERRQ(ierr);
681443836d0SMatthew G Knepley       }
682443836d0SMatthew G Knepley       if (kspUpper != kspA) {
68323ee1639SBarry Smith         ierr = KSPSetOperators(kspUpper,jac->mat[0],jac->pmat[0]);CHKERRQ(ierr);
684443836d0SMatthew G Knepley       }
68523ee1639SBarry Smith       ierr = KSPSetOperators(jac->kspschur,jac->schur,FieldSplitSchurPre(jac));CHKERRQ(ierr);
6863b224e63SBarry Smith     } else {
687bafc1b83SMatthew G Knepley       const char   *Dprefix;
688470b340bSDmitry Karpeev       char         schurprefix[256], schurmatprefix[256];
689514bf10dSMatthew G Knepley       char         schurtestoption[256];
690bdddcaaaSMatthew G Knepley       MatNullSpace sp;
691514bf10dSMatthew G Knepley       PetscBool    flg;
6923b224e63SBarry Smith 
693a04f6461SBarry Smith       /* extract the A01 and A10 matrices */
6943b224e63SBarry Smith       ilink = jac->head;
69549bb4cd7SJungho Lee       ierr  = ISComplement(ilink->is_col,rstart,rend,&ccis);CHKERRQ(ierr);
6964e39094bSDmitry Karpeev       if (jac->offdiag_use_amat) {
6974aa3045dSJed Brown 	ierr  = MatGetSubMatrix(pc->mat,ilink->is,ccis,MAT_INITIAL_MATRIX,&jac->B);CHKERRQ(ierr);
698c84da90fSDmitry Karpeev       } else {
699df06c9e3SDmitry Karpeev 	ierr  = MatGetSubMatrix(pc->pmat,ilink->is,ccis,MAT_INITIAL_MATRIX,&jac->B);CHKERRQ(ierr);
700c84da90fSDmitry Karpeev       }
701fcfd50ebSBarry Smith       ierr  = ISDestroy(&ccis);CHKERRQ(ierr);
7023b224e63SBarry Smith       ilink = ilink->next;
70349bb4cd7SJungho Lee       ierr  = ISComplement(ilink->is_col,rstart,rend,&ccis);CHKERRQ(ierr);
7044e39094bSDmitry Karpeev       if (jac->offdiag_use_amat) {
7054aa3045dSJed Brown 	ierr  = MatGetSubMatrix(pc->mat,ilink->is,ccis,MAT_INITIAL_MATRIX,&jac->C);CHKERRQ(ierr);
706c84da90fSDmitry Karpeev       } else {
707df06c9e3SDmitry Karpeev 	ierr  = MatGetSubMatrix(pc->pmat,ilink->is,ccis,MAT_INITIAL_MATRIX,&jac->C);CHKERRQ(ierr);
708c84da90fSDmitry Karpeev       }
709fcfd50ebSBarry Smith       ierr  = ISDestroy(&ccis);CHKERRQ(ierr);
71020252d06SBarry Smith 
711f5236f50SJed Brown       /* Use mat[0] (diagonal block of Amat) preconditioned by pmat[0] to define Schur complement */
71220252d06SBarry Smith       ierr = MatCreate(((PetscObject)jac->mat[0])->comm,&jac->schur);CHKERRQ(ierr);
71320252d06SBarry Smith       ierr = MatSetType(jac->schur,MATSCHURCOMPLEMENT);CHKERRQ(ierr);
714bee83525SDmitry Karpeev       ierr = MatSchurComplementSetSubMatrices(jac->schur,jac->mat[0],jac->pmat[0],jac->B,jac->C,jac->mat[1]);CHKERRQ(ierr);
715470b340bSDmitry Karpeev       ierr = PetscSNPrintf(schurmatprefix, sizeof(schurmatprefix), "%sfieldsplit_%s_", ((PetscObject)pc)->prefix ? ((PetscObject)pc)->prefix : "", ilink->splitname);CHKERRQ(ierr);
716470b340bSDmitry 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? */
717470b340bSDmitry Karpeev       ierr = MatSetOptionsPrefix(jac->schur,schurmatprefix);CHKERRQ(ierr);
718470b340bSDmitry Karpeev       ierr = MatSetFromOptions(jac->schur);CHKERRQ(ierr);
719895c21f2SBarry Smith       ierr = MatGetNullSpace(jac->mat[1], &sp);CHKERRQ(ierr);
72020252d06SBarry Smith       if (sp) {
72120252d06SBarry Smith         ierr = MatSetNullSpace(jac->schur, sp);CHKERRQ(ierr);
72220252d06SBarry Smith       }
72320252d06SBarry Smith 
72420252d06SBarry Smith       ierr = PetscSNPrintf(schurtestoption, sizeof(schurtestoption), "-fieldsplit_%s_inner_", ilink->splitname);CHKERRQ(ierr);
725c5929fdfSBarry Smith       ierr = PetscOptionsFindPairPrefix_Private(((PetscObject)pc)->options,((PetscObject)pc)->prefix, schurtestoption, NULL, &flg);CHKERRQ(ierr);
726514bf10dSMatthew G Knepley       if (flg) {
727514bf10dSMatthew G Knepley         DM  dmInner;
72821635b76SJed Brown         KSP kspInner;
72921635b76SJed Brown 
73021635b76SJed Brown         ierr = MatSchurComplementGetKSP(jac->schur, &kspInner);CHKERRQ(ierr);
73121635b76SJed Brown         ierr = PetscSNPrintf(schurprefix, sizeof(schurprefix), "%sfieldsplit_%s_inner_", ((PetscObject)pc)->prefix ? ((PetscObject)pc)->prefix : "", ilink->splitname);CHKERRQ(ierr);
73221635b76SJed Brown         /* Indent this deeper to emphasize the "inner" nature of this solver. */
73321635b76SJed Brown         ierr = PetscObjectIncrementTabLevel((PetscObject)kspInner, (PetscObject) pc, 2);CHKERRQ(ierr);
73421635b76SJed Brown         ierr = KSPSetOptionsPrefix(kspInner, schurprefix);CHKERRQ(ierr);
735514bf10dSMatthew G Knepley 
736514bf10dSMatthew G Knepley         /* Set DM for new solver */
737bafc1b83SMatthew G Knepley         ierr = KSPGetDM(jac->head->ksp, &dmInner);CHKERRQ(ierr);
73821635b76SJed Brown         ierr = KSPSetDM(kspInner, dmInner);CHKERRQ(ierr);
73921635b76SJed Brown         ierr = KSPSetDMActive(kspInner, PETSC_FALSE);CHKERRQ(ierr);
740514bf10dSMatthew G Knepley       } else {
74121635b76SJed Brown          /* Use the outer solver for the inner solve, but revert the KSPPREONLY from PCFieldSplitSetFields_FieldSplit or
74221635b76SJed Brown           * PCFieldSplitSetIS_FieldSplit. We don't want KSPPREONLY because it makes the Schur complement inexact,
74321635b76SJed Brown           * preventing Schur complement reduction to be an accurate solve. Usually when an iterative solver is used for
74421635b76SJed 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
74521635b76SJed Brown           * GMRES the default. Note that it is also common to use PREONLY for S, in which case S may not be used
74621635b76SJed Brown           * directly, and the user is responsible for setting an inexact method for fieldsplit's A^{-1}. */
74721635b76SJed Brown         ierr = KSPSetType(jac->head->ksp,KSPGMRES);CHKERRQ(ierr);
748514bf10dSMatthew G Knepley         ierr = MatSchurComplementSetKSP(jac->schur,jac->head->ksp);CHKERRQ(ierr);
749bafc1b83SMatthew G Knepley       }
75023ee1639SBarry Smith       ierr = KSPSetOperators(jac->head->ksp,jac->mat[0],jac->pmat[0]);CHKERRQ(ierr);
7515a9f2f41SSatish Balay       ierr = KSPSetFromOptions(jac->head->ksp);CHKERRQ(ierr);
75297bbdb24SBarry Smith       ierr = MatSetFromOptions(jac->schur);CHKERRQ(ierr);
75397bbdb24SBarry Smith 
754443836d0SMatthew G Knepley       ierr = PetscSNPrintf(schurtestoption, sizeof(schurtestoption), "-fieldsplit_%s_upper_", ilink->splitname);CHKERRQ(ierr);
755c5929fdfSBarry Smith       ierr = PetscOptionsFindPairPrefix_Private(((PetscObject)pc)->options,((PetscObject)pc)->prefix, schurtestoption, NULL, &flg);CHKERRQ(ierr);
756443836d0SMatthew G Knepley       if (flg) {
757443836d0SMatthew G Knepley         DM dmInner;
758443836d0SMatthew G Knepley 
759443836d0SMatthew G Knepley         ierr = PetscSNPrintf(schurprefix, sizeof(schurprefix), "%sfieldsplit_%s_upper_", ((PetscObject)pc)->prefix ? ((PetscObject)pc)->prefix : "", ilink->splitname);CHKERRQ(ierr);
76082f516ccSBarry Smith         ierr = KSPCreate(PetscObjectComm((PetscObject)pc), &jac->kspupper);CHKERRQ(ierr);
761422a814eSBarry Smith         ierr = KSPSetErrorIfNotConverged(jac->kspupper,pc->erroriffailure);CHKERRQ(ierr);
762443836d0SMatthew G Knepley         ierr = KSPSetOptionsPrefix(jac->kspupper, schurprefix);CHKERRQ(ierr);
763443836d0SMatthew G Knepley         ierr = KSPGetDM(jac->head->ksp, &dmInner);CHKERRQ(ierr);
764443836d0SMatthew G Knepley         ierr = KSPSetDM(jac->kspupper, dmInner);CHKERRQ(ierr);
765443836d0SMatthew G Knepley         ierr = KSPSetDMActive(jac->kspupper, PETSC_FALSE);CHKERRQ(ierr);
766443836d0SMatthew G Knepley         ierr = KSPSetFromOptions(jac->kspupper);CHKERRQ(ierr);
76723ee1639SBarry Smith         ierr = KSPSetOperators(jac->kspupper,jac->mat[0],jac->pmat[0]);CHKERRQ(ierr);
768443836d0SMatthew G Knepley         ierr = VecDuplicate(jac->head->x, &jac->head->z);CHKERRQ(ierr);
769443836d0SMatthew G Knepley       } else {
770443836d0SMatthew G Knepley         jac->kspupper = jac->head->ksp;
771443836d0SMatthew G Knepley         ierr          = PetscObjectReference((PetscObject) jac->head->ksp);CHKERRQ(ierr);
772443836d0SMatthew G Knepley       }
773443836d0SMatthew G Knepley 
774a7476a74SDmitry Karpeev       if (jac->schurpre == PC_FIELDSPLIT_SCHUR_PRE_SELFP) {
775a7476a74SDmitry Karpeev 	ierr = MatSchurComplementGetPmat(jac->schur,MAT_INITIAL_MATRIX,&jac->schurp);CHKERRQ(ierr);
776a7476a74SDmitry Karpeev       }
777ce94432eSBarry Smith       ierr = KSPCreate(PetscObjectComm((PetscObject)pc),&jac->kspschur);CHKERRQ(ierr);
778422a814eSBarry Smith       ierr = KSPSetErrorIfNotConverged(jac->kspschur,pc->erroriffailure);CHKERRQ(ierr);
77997bbdb24SBarry Smith       ierr = PetscLogObjectParent((PetscObject)pc,(PetscObject)jac->kspschur);CHKERRQ(ierr);
78020252d06SBarry Smith       ierr = PetscObjectIncrementTabLevel((PetscObject)jac->kspschur,(PetscObject)pc,1);CHKERRQ(ierr);
78197bbdb24SBarry Smith       if (jac->schurpre == PC_FIELDSPLIT_SCHUR_PRE_SELF) {
7827233a360SDmitry Karpeev         PC pcschur;
7837233a360SDmitry Karpeev         ierr = KSPGetPC(jac->kspschur,&pcschur);CHKERRQ(ierr);
7847233a360SDmitry Karpeev         ierr = PCSetType(pcschur,PCNONE);CHKERRQ(ierr);
78597bbdb24SBarry Smith         /* Note: This is bad if there exist preconditioners for MATSCHURCOMPLEMENT */
786e74569cdSMatthew G. Knepley       } else if (jac->schurpre == PC_FIELDSPLIT_SCHUR_PRE_FULL) {
787e74569cdSMatthew G. Knepley         ierr = MatSchurComplementComputeExplicitOperator(jac->schur, &jac->schur_user);CHKERRQ(ierr);
78897bbdb24SBarry Smith       }
78923ee1639SBarry Smith       ierr = KSPSetOperators(jac->kspschur,jac->schur,FieldSplitSchurPre(jac));CHKERRQ(ierr);
79097bbdb24SBarry Smith       ierr = KSPGetOptionsPrefix(jac->head->next->ksp, &Dprefix);CHKERRQ(ierr);
79197bbdb24SBarry Smith       ierr = KSPSetOptionsPrefix(jac->kspschur,         Dprefix);CHKERRQ(ierr);
792b20b4189SMatthew G. Knepley       /* propogate DM */
793b20b4189SMatthew G. Knepley       {
794b20b4189SMatthew G. Knepley         DM sdm;
795b20b4189SMatthew G. Knepley         ierr = KSPGetDM(jac->head->next->ksp, &sdm);CHKERRQ(ierr);
796b20b4189SMatthew G. Knepley         if (sdm) {
797b20b4189SMatthew G. Knepley           ierr = KSPSetDM(jac->kspschur, sdm);CHKERRQ(ierr);
798b20b4189SMatthew G. Knepley           ierr = KSPSetDMActive(jac->kspschur, PETSC_FALSE);CHKERRQ(ierr);
799b20b4189SMatthew G. Knepley         }
800b20b4189SMatthew G. Knepley       }
80197bbdb24SBarry Smith       /* really want setfromoptions called in PCSetFromOptions_FieldSplit(), but it is not ready yet */
80297bbdb24SBarry Smith       /* need to call this every time, since the jac->kspschur is freshly created, otherwise its options never get set */
80397bbdb24SBarry Smith       ierr = KSPSetFromOptions(jac->kspschur);CHKERRQ(ierr);
80497bbdb24SBarry Smith     }
80597bbdb24SBarry Smith 
8065a9f2f41SSatish Balay     /* HACK: special support to forward L and Lp matrices that might be used by PCLSC */
8078caf3d72SBarry Smith     ierr = PetscSNPrintf(lscname,sizeof(lscname),"%s_LSC_L",ilink->splitname);CHKERRQ(ierr);
808519d70e2SJed Brown     ierr = PetscObjectQuery((PetscObject)pc->mat,lscname,(PetscObject*)&LSC_L);CHKERRQ(ierr);
8093b224e63SBarry Smith     if (!LSC_L) {ierr = PetscObjectQuery((PetscObject)pc->pmat,lscname,(PetscObject*)&LSC_L);CHKERRQ(ierr);}
810c1570756SJed Brown     if (LSC_L) {ierr = PetscObjectCompose((PetscObject)jac->schur,"LSC_L",(PetscObject)LSC_L);CHKERRQ(ierr);}
8118caf3d72SBarry Smith     ierr = PetscSNPrintf(lscname,sizeof(lscname),"%s_LSC_Lp",ilink->splitname);CHKERRQ(ierr);
81297bbdb24SBarry Smith     ierr = PetscObjectQuery((PetscObject)pc->pmat,lscname,(PetscObject*)&LSC_L);CHKERRQ(ierr);
8135a9f2f41SSatish Balay     if (!LSC_L) {ierr = PetscObjectQuery((PetscObject)pc->mat,lscname,(PetscObject*)&LSC_L);CHKERRQ(ierr);}
8140971522cSBarry Smith     if (LSC_L) {ierr = PetscObjectCompose((PetscObject)jac->schur,"LSC_Lp",(PetscObject)LSC_L);CHKERRQ(ierr);}
81597bbdb24SBarry Smith   } else {
81668bd789dSDmitry Karpeev     /* set up the individual splits' PCs */
8170971522cSBarry Smith     i     = 0;
8180971522cSBarry Smith     ilink = jac->head;
8190971522cSBarry Smith     while (ilink) {
82023ee1639SBarry Smith       ierr = KSPSetOperators(ilink->ksp,jac->mat[i],jac->pmat[i]);CHKERRQ(ierr);
8210971522cSBarry Smith       /* really want setfromoptions called in PCSetFromOptions_FieldSplit(), but it is not ready yet */
8220971522cSBarry Smith       if (!jac->suboptionsset) {ierr = KSPSetFromOptions(ilink->ksp);CHKERRQ(ierr);}
8230971522cSBarry Smith       i++;
8240971522cSBarry Smith       ilink = ilink->next;
8250971522cSBarry Smith     }
8263b224e63SBarry Smith   }
8273b224e63SBarry Smith 
828c1570756SJed Brown   jac->suboptionsset = PETSC_TRUE;
8290971522cSBarry Smith   PetscFunctionReturn(0);
8300971522cSBarry Smith }
8310971522cSBarry Smith 
8325a9f2f41SSatish Balay #define FieldSplitSplitSolveAdd(ilink,xx,yy) \
833ca9f406cSSatish Balay   (VecScatterBegin(ilink->sctx,xx,ilink->x,INSERT_VALUES,SCATTER_FORWARD) || \
834ca9f406cSSatish Balay    VecScatterEnd(ilink->sctx,xx,ilink->x,INSERT_VALUES,SCATTER_FORWARD) || \
8355a9f2f41SSatish Balay    KSPSolve(ilink->ksp,ilink->x,ilink->y) || \
836ca9f406cSSatish Balay    VecScatterBegin(ilink->sctx,ilink->y,yy,ADD_VALUES,SCATTER_REVERSE) || \
837ca9f406cSSatish Balay    VecScatterEnd(ilink->sctx,ilink->y,yy,ADD_VALUES,SCATTER_REVERSE))
83879416396SBarry Smith 
8390971522cSBarry Smith #undef __FUNCT__
8403b224e63SBarry Smith #define __FUNCT__ "PCApply_FieldSplit_Schur"
8413b224e63SBarry Smith static PetscErrorCode PCApply_FieldSplit_Schur(PC pc,Vec x,Vec y)
8423b224e63SBarry Smith {
8433b224e63SBarry Smith   PC_FieldSplit     *jac = (PC_FieldSplit*)pc->data;
8443b224e63SBarry Smith   PetscErrorCode    ierr;
8453b224e63SBarry Smith   PC_FieldSplitLink ilinkA = jac->head, ilinkD = ilinkA->next;
846443836d0SMatthew G Knepley   KSP               kspA   = ilinkA->ksp, kspLower = kspA, kspUpper = jac->kspupper;
8473b224e63SBarry Smith 
8483b224e63SBarry Smith   PetscFunctionBegin;
849c5d2311dSJed Brown   switch (jac->schurfactorization) {
850c9c6ffaaSJed Brown   case PC_FIELDSPLIT_SCHUR_FACT_DIAG:
851a04f6461SBarry Smith     /* [A00 0; 0 -S], positive definite, suitable for MINRES */
852c5d2311dSJed Brown     ierr = VecScatterBegin(ilinkA->sctx,x,ilinkA->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
853c5d2311dSJed Brown     ierr = VecScatterBegin(ilinkD->sctx,x,ilinkD->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
854c5d2311dSJed Brown     ierr = VecScatterEnd(ilinkA->sctx,x,ilinkA->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
855443836d0SMatthew G Knepley     ierr = KSPSolve(kspA,ilinkA->x,ilinkA->y);CHKERRQ(ierr);
856c5d2311dSJed Brown     ierr = VecScatterBegin(ilinkA->sctx,ilinkA->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
857c5d2311dSJed Brown     ierr = VecScatterEnd(ilinkD->sctx,x,ilinkD->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
858c5d2311dSJed Brown     ierr = KSPSolve(jac->kspschur,ilinkD->x,ilinkD->y);CHKERRQ(ierr);
859c5d2311dSJed Brown     ierr = VecScale(ilinkD->y,-1.);CHKERRQ(ierr);
860c5d2311dSJed Brown     ierr = VecScatterBegin(ilinkD->sctx,ilinkD->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
861c5d2311dSJed Brown     ierr = VecScatterEnd(ilinkA->sctx,ilinkA->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
862c5d2311dSJed Brown     ierr = VecScatterEnd(ilinkD->sctx,ilinkD->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
863c5d2311dSJed Brown     break;
864c9c6ffaaSJed Brown   case PC_FIELDSPLIT_SCHUR_FACT_LOWER:
865a04f6461SBarry Smith     /* [A00 0; A10 S], suitable for left preconditioning */
866c5d2311dSJed Brown     ierr = VecScatterBegin(ilinkA->sctx,x,ilinkA->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
867c5d2311dSJed Brown     ierr = VecScatterEnd(ilinkA->sctx,x,ilinkA->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
868443836d0SMatthew G Knepley     ierr = KSPSolve(kspA,ilinkA->x,ilinkA->y);CHKERRQ(ierr);
869c5d2311dSJed Brown     ierr = MatMult(jac->C,ilinkA->y,ilinkD->x);CHKERRQ(ierr);
870c5d2311dSJed Brown     ierr = VecScale(ilinkD->x,-1.);CHKERRQ(ierr);
871c5d2311dSJed Brown     ierr = VecScatterBegin(ilinkD->sctx,x,ilinkD->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
872c5d2311dSJed Brown     ierr = VecScatterBegin(ilinkA->sctx,ilinkA->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
873c5d2311dSJed Brown     ierr = VecScatterEnd(ilinkD->sctx,x,ilinkD->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
874c5d2311dSJed Brown     ierr = KSPSolve(jac->kspschur,ilinkD->x,ilinkD->y);CHKERRQ(ierr);
875c5d2311dSJed Brown     ierr = VecScatterBegin(ilinkD->sctx,ilinkD->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
876c5d2311dSJed Brown     ierr = VecScatterEnd(ilinkA->sctx,ilinkA->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
877c5d2311dSJed Brown     ierr = VecScatterEnd(ilinkD->sctx,ilinkD->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
878c5d2311dSJed Brown     break;
879c9c6ffaaSJed Brown   case PC_FIELDSPLIT_SCHUR_FACT_UPPER:
880a04f6461SBarry Smith     /* [A00 A01; 0 S], suitable for right preconditioning */
881c5d2311dSJed Brown     ierr = VecScatterBegin(ilinkD->sctx,x,ilinkD->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
882c5d2311dSJed Brown     ierr = VecScatterEnd(ilinkD->sctx,x,ilinkD->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
883c5d2311dSJed Brown     ierr = KSPSolve(jac->kspschur,ilinkD->x,ilinkD->y);CHKERRQ(ierr);
884c5d2311dSJed Brown     ierr = MatMult(jac->B,ilinkD->y,ilinkA->x);CHKERRQ(ierr);
885c5d2311dSJed Brown     ierr = VecScale(ilinkA->x,-1.);CHKERRQ(ierr);
886c5d2311dSJed Brown     ierr = VecScatterBegin(ilinkA->sctx,x,ilinkA->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
887c5d2311dSJed Brown     ierr = VecScatterBegin(ilinkD->sctx,ilinkD->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
888c5d2311dSJed Brown     ierr = VecScatterEnd(ilinkA->sctx,x,ilinkA->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
889443836d0SMatthew G Knepley     ierr = KSPSolve(kspA,ilinkA->x,ilinkA->y);CHKERRQ(ierr);
890c5d2311dSJed Brown     ierr = VecScatterBegin(ilinkA->sctx,ilinkA->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
891c5d2311dSJed Brown     ierr = VecScatterEnd(ilinkD->sctx,ilinkD->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
892c5d2311dSJed Brown     ierr = VecScatterEnd(ilinkA->sctx,ilinkA->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
893c5d2311dSJed Brown     break;
894c9c6ffaaSJed Brown   case PC_FIELDSPLIT_SCHUR_FACT_FULL:
895a04f6461SBarry 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 */
8963b224e63SBarry Smith     ierr = VecScatterBegin(ilinkA->sctx,x,ilinkA->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
8973b224e63SBarry Smith     ierr = VecScatterEnd(ilinkA->sctx,x,ilinkA->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
898443836d0SMatthew G Knepley     ierr = KSPSolve(kspLower,ilinkA->x,ilinkA->y);CHKERRQ(ierr);
8993b224e63SBarry Smith     ierr = MatMult(jac->C,ilinkA->y,ilinkD->x);CHKERRQ(ierr);
9003b224e63SBarry Smith     ierr = VecScale(ilinkD->x,-1.0);CHKERRQ(ierr);
9013b224e63SBarry Smith     ierr = VecScatterBegin(ilinkD->sctx,x,ilinkD->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
9023b224e63SBarry Smith     ierr = VecScatterEnd(ilinkD->sctx,x,ilinkD->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
9033b224e63SBarry Smith 
9043b224e63SBarry Smith     ierr = KSPSolve(jac->kspschur,ilinkD->x,ilinkD->y);CHKERRQ(ierr);
9053b224e63SBarry Smith     ierr = VecScatterBegin(ilinkD->sctx,ilinkD->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
9063b224e63SBarry Smith     ierr = VecScatterEnd(ilinkD->sctx,ilinkD->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
9073b224e63SBarry Smith 
908443836d0SMatthew G Knepley     if (kspUpper == kspA) {
9093b224e63SBarry Smith       ierr = MatMult(jac->B,ilinkD->y,ilinkA->y);CHKERRQ(ierr);
9103b224e63SBarry Smith       ierr = VecAXPY(ilinkA->x,-1.0,ilinkA->y);CHKERRQ(ierr);
911443836d0SMatthew G Knepley       ierr = KSPSolve(kspA,ilinkA->x,ilinkA->y);CHKERRQ(ierr);
912443836d0SMatthew G Knepley     } else {
913443836d0SMatthew G Knepley       ierr = KSPSolve(kspA,ilinkA->x,ilinkA->y);CHKERRQ(ierr);
914443836d0SMatthew G Knepley       ierr = MatMult(jac->B,ilinkD->y,ilinkA->x);CHKERRQ(ierr);
915443836d0SMatthew G Knepley       ierr = KSPSolve(kspUpper,ilinkA->x,ilinkA->z);CHKERRQ(ierr);
916443836d0SMatthew G Knepley       ierr = VecAXPY(ilinkA->y,-1.0,ilinkA->z);CHKERRQ(ierr);
917443836d0SMatthew G Knepley     }
9183b224e63SBarry Smith     ierr = VecScatterBegin(ilinkA->sctx,ilinkA->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
9193b224e63SBarry Smith     ierr = VecScatterEnd(ilinkA->sctx,ilinkA->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
920c5d2311dSJed Brown   }
9213b224e63SBarry Smith   PetscFunctionReturn(0);
9223b224e63SBarry Smith }
9233b224e63SBarry Smith 
9243b224e63SBarry Smith #undef __FUNCT__
9250971522cSBarry Smith #define __FUNCT__ "PCApply_FieldSplit"
9260971522cSBarry Smith static PetscErrorCode PCApply_FieldSplit(PC pc,Vec x,Vec y)
9270971522cSBarry Smith {
9280971522cSBarry Smith   PC_FieldSplit     *jac = (PC_FieldSplit*)pc->data;
9290971522cSBarry Smith   PetscErrorCode    ierr;
9305a9f2f41SSatish Balay   PC_FieldSplitLink ilink = jac->head;
931939b8a20SBarry Smith   PetscInt          cnt,bs;
932*568ed31eSHong Zhang   KSPConvergedReason reason;
9330971522cSBarry Smith 
9340971522cSBarry Smith   PetscFunctionBegin;
93579416396SBarry Smith   if (jac->type == PC_COMPOSITE_ADDITIVE) {
9361b9fc7fcSBarry Smith     if (jac->defaultsplit) {
937939b8a20SBarry Smith       ierr = VecGetBlockSize(x,&bs);CHKERRQ(ierr);
938ce94432eSBarry 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);
939939b8a20SBarry Smith       ierr = VecGetBlockSize(y,&bs);CHKERRQ(ierr);
940ce94432eSBarry 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);
9410971522cSBarry Smith       ierr = VecStrideGatherAll(x,jac->x,INSERT_VALUES);CHKERRQ(ierr);
9425a9f2f41SSatish Balay       while (ilink) {
9435a9f2f41SSatish Balay         ierr  = KSPSolve(ilink->ksp,ilink->x,ilink->y);CHKERRQ(ierr);
944*568ed31eSHong Zhang         ierr = KSPGetConvergedReason(ilink->ksp,&reason);CHKERRQ(ierr);
945*568ed31eSHong Zhang         if (reason == KSP_DIVERGED_PCSETUP_FAILED) {
946*568ed31eSHong Zhang           pc->failedreason = PC_SUBPC_ERROR;
947*568ed31eSHong Zhang         }
9485a9f2f41SSatish Balay         ilink = ilink->next;
9490971522cSBarry Smith       }
9500971522cSBarry Smith       ierr = VecStrideScatterAll(jac->y,y,INSERT_VALUES);CHKERRQ(ierr);
9511b9fc7fcSBarry Smith     } else {
952efb30889SBarry Smith       ierr = VecSet(y,0.0);CHKERRQ(ierr);
9535a9f2f41SSatish Balay       while (ilink) {
9545a9f2f41SSatish Balay         ierr  = FieldSplitSplitSolveAdd(ilink,x,y);CHKERRQ(ierr);
955*568ed31eSHong Zhang         ierr = KSPGetConvergedReason(ilink->ksp,&reason);CHKERRQ(ierr);
956*568ed31eSHong Zhang         if (reason == KSP_DIVERGED_PCSETUP_FAILED) {
957*568ed31eSHong Zhang           pc->failedreason = PC_SUBPC_ERROR;
958*568ed31eSHong Zhang         }
9595a9f2f41SSatish Balay         ilink = ilink->next;
9601b9fc7fcSBarry Smith       }
9611b9fc7fcSBarry Smith     }
962e52d2c62SBarry Smith   } else if (jac->type == PC_COMPOSITE_MULTIPLICATIVE && jac->nsplits == 2) {
963e52d2c62SBarry Smith     ierr = VecSet(y,0.0);CHKERRQ(ierr);
964e52d2c62SBarry Smith     /* solve on first block for first block variables */
965e52d2c62SBarry Smith     ierr = VecScatterBegin(ilink->sctx,x,ilink->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
966e52d2c62SBarry Smith     ierr = VecScatterEnd(ilink->sctx,x,ilink->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
967e52d2c62SBarry Smith     ierr = KSPSolve(ilink->ksp,ilink->x,ilink->y);CHKERRQ(ierr);
968*568ed31eSHong Zhang     ierr = KSPGetConvergedReason(ilink->ksp,&reason);CHKERRQ(ierr);
969*568ed31eSHong Zhang     if (reason == KSP_DIVERGED_PCSETUP_FAILED) {
970*568ed31eSHong Zhang       pc->failedreason = PC_SUBPC_ERROR;
971*568ed31eSHong Zhang     }
972e52d2c62SBarry Smith     ierr = VecScatterBegin(ilink->sctx,ilink->y,y,ADD_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
973e52d2c62SBarry Smith     ierr = VecScatterEnd(ilink->sctx,ilink->y,y,ADD_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
974e52d2c62SBarry Smith 
975e52d2c62SBarry Smith     /* compute the residual only onto second block variables using first block variables */
976e52d2c62SBarry Smith     ierr = MatMult(jac->Afield[1],ilink->y,ilink->next->x);CHKERRQ(ierr);
977e52d2c62SBarry Smith     ilink = ilink->next;
978e52d2c62SBarry Smith     ierr = VecScale(ilink->x,-1.0);CHKERRQ(ierr);
979e52d2c62SBarry Smith     ierr = VecScatterBegin(ilink->sctx,x,ilink->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
980e52d2c62SBarry Smith     ierr = VecScatterEnd(ilink->sctx,x,ilink->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
981e52d2c62SBarry Smith 
982e52d2c62SBarry Smith     /* solve on second block variables */
983e52d2c62SBarry Smith     ierr = KSPSolve(ilink->ksp,ilink->x,ilink->y);CHKERRQ(ierr);
984*568ed31eSHong Zhang     ierr = KSPGetConvergedReason(ilink->ksp,&reason);CHKERRQ(ierr);
985*568ed31eSHong Zhang     if (reason == KSP_DIVERGED_PCSETUP_FAILED) {
986*568ed31eSHong Zhang       pc->failedreason = PC_SUBPC_ERROR;
987*568ed31eSHong Zhang     }
988e52d2c62SBarry Smith     ierr = VecScatterBegin(ilink->sctx,ilink->y,y,ADD_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
989e52d2c62SBarry Smith     ierr = VecScatterEnd(ilink->sctx,ilink->y,y,ADD_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
99016913363SBarry Smith   } else if (jac->type == PC_COMPOSITE_MULTIPLICATIVE || jac->type == PC_COMPOSITE_SYMMETRIC_MULTIPLICATIVE) {
99179416396SBarry Smith     if (!jac->w1) {
99279416396SBarry Smith       ierr = VecDuplicate(x,&jac->w1);CHKERRQ(ierr);
99379416396SBarry Smith       ierr = VecDuplicate(x,&jac->w2);CHKERRQ(ierr);
99479416396SBarry Smith     }
995efb30889SBarry Smith     ierr = VecSet(y,0.0);CHKERRQ(ierr);
9965a9f2f41SSatish Balay     ierr = FieldSplitSplitSolveAdd(ilink,x,y);CHKERRQ(ierr);
997*568ed31eSHong Zhang     ierr = KSPGetConvergedReason(ilink->ksp,&reason);CHKERRQ(ierr);
998*568ed31eSHong Zhang     if (reason == KSP_DIVERGED_PCSETUP_FAILED) {
999*568ed31eSHong Zhang       pc->failedreason = PC_SUBPC_ERROR;
1000*568ed31eSHong Zhang     }
10013e197d65SBarry Smith     cnt  = 1;
10025a9f2f41SSatish Balay     while (ilink->next) {
10035a9f2f41SSatish Balay       ilink = ilink->next;
10043e197d65SBarry Smith       /* compute the residual only over the part of the vector needed */
10053e197d65SBarry Smith       ierr = MatMult(jac->Afield[cnt++],y,ilink->x);CHKERRQ(ierr);
10063e197d65SBarry Smith       ierr = VecScale(ilink->x,-1.0);CHKERRQ(ierr);
10073e197d65SBarry Smith       ierr = VecScatterBegin(ilink->sctx,x,ilink->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
10083e197d65SBarry Smith       ierr = VecScatterEnd(ilink->sctx,x,ilink->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
10093e197d65SBarry Smith       ierr = KSPSolve(ilink->ksp,ilink->x,ilink->y);CHKERRQ(ierr);
10103e197d65SBarry Smith       ierr = VecScatterBegin(ilink->sctx,ilink->y,y,ADD_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
10113e197d65SBarry Smith       ierr = VecScatterEnd(ilink->sctx,ilink->y,y,ADD_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
10123e197d65SBarry Smith     }
101351f519a2SBarry Smith     if (jac->type == PC_COMPOSITE_SYMMETRIC_MULTIPLICATIVE) {
101411755939SBarry Smith       cnt -= 2;
101551f519a2SBarry Smith       while (ilink->previous) {
101651f519a2SBarry Smith         ilink = ilink->previous;
101711755939SBarry Smith         /* compute the residual only over the part of the vector needed */
101811755939SBarry Smith         ierr = MatMult(jac->Afield[cnt--],y,ilink->x);CHKERRQ(ierr);
101911755939SBarry Smith         ierr = VecScale(ilink->x,-1.0);CHKERRQ(ierr);
102011755939SBarry Smith         ierr = VecScatterBegin(ilink->sctx,x,ilink->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
102111755939SBarry Smith         ierr = VecScatterEnd(ilink->sctx,x,ilink->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
102211755939SBarry Smith         ierr = KSPSolve(ilink->ksp,ilink->x,ilink->y);CHKERRQ(ierr);
1023*568ed31eSHong Zhang         ierr = KSPGetConvergedReason(ilink->ksp,&reason);CHKERRQ(ierr);
1024*568ed31eSHong Zhang         if (reason == KSP_DIVERGED_PCSETUP_FAILED) {
1025*568ed31eSHong Zhang           pc->failedreason = PC_SUBPC_ERROR;
1026*568ed31eSHong Zhang         }
102711755939SBarry Smith         ierr = VecScatterBegin(ilink->sctx,ilink->y,y,ADD_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
102811755939SBarry Smith         ierr = VecScatterEnd(ilink->sctx,ilink->y,y,ADD_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
102951f519a2SBarry Smith       }
103011755939SBarry Smith     }
1031ce94432eSBarry Smith   } else SETERRQ1(PetscObjectComm((PetscObject)pc),PETSC_ERR_SUP,"Unsupported or unknown composition",(int) jac->type);
10320971522cSBarry Smith   PetscFunctionReturn(0);
10330971522cSBarry Smith }
10340971522cSBarry Smith 
1035421e10b8SBarry Smith #define FieldSplitSplitSolveAddTranspose(ilink,xx,yy) \
1036ca9f406cSSatish Balay   (VecScatterBegin(ilink->sctx,xx,ilink->y,INSERT_VALUES,SCATTER_FORWARD) || \
1037ca9f406cSSatish Balay    VecScatterEnd(ilink->sctx,xx,ilink->y,INSERT_VALUES,SCATTER_FORWARD) || \
1038421e10b8SBarry Smith    KSPSolveTranspose(ilink->ksp,ilink->y,ilink->x) || \
1039ca9f406cSSatish Balay    VecScatterBegin(ilink->sctx,ilink->x,yy,ADD_VALUES,SCATTER_REVERSE) || \
1040ca9f406cSSatish Balay    VecScatterEnd(ilink->sctx,ilink->x,yy,ADD_VALUES,SCATTER_REVERSE))
1041421e10b8SBarry Smith 
1042421e10b8SBarry Smith #undef __FUNCT__
10438c03b21aSDmitry Karpeev #define __FUNCT__ "PCApplyTranspose_FieldSplit"
1044421e10b8SBarry Smith static PetscErrorCode PCApplyTranspose_FieldSplit(PC pc,Vec x,Vec y)
1045421e10b8SBarry Smith {
1046421e10b8SBarry Smith   PC_FieldSplit     *jac = (PC_FieldSplit*)pc->data;
1047421e10b8SBarry Smith   PetscErrorCode    ierr;
1048421e10b8SBarry Smith   PC_FieldSplitLink ilink = jac->head;
1049939b8a20SBarry Smith   PetscInt          bs;
1050421e10b8SBarry Smith 
1051421e10b8SBarry Smith   PetscFunctionBegin;
1052421e10b8SBarry Smith   if (jac->type == PC_COMPOSITE_ADDITIVE) {
1053421e10b8SBarry Smith     if (jac->defaultsplit) {
1054939b8a20SBarry Smith       ierr = VecGetBlockSize(x,&bs);CHKERRQ(ierr);
1055ce94432eSBarry 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);
1056939b8a20SBarry Smith       ierr = VecGetBlockSize(y,&bs);CHKERRQ(ierr);
1057ce94432eSBarry 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);
1058421e10b8SBarry Smith       ierr = VecStrideGatherAll(x,jac->x,INSERT_VALUES);CHKERRQ(ierr);
1059421e10b8SBarry Smith       while (ilink) {
1060421e10b8SBarry Smith         ierr  = KSPSolveTranspose(ilink->ksp,ilink->x,ilink->y);CHKERRQ(ierr);
1061421e10b8SBarry Smith         ilink = ilink->next;
1062421e10b8SBarry Smith       }
1063421e10b8SBarry Smith       ierr = VecStrideScatterAll(jac->y,y,INSERT_VALUES);CHKERRQ(ierr);
1064421e10b8SBarry Smith     } else {
1065421e10b8SBarry Smith       ierr = VecSet(y,0.0);CHKERRQ(ierr);
1066421e10b8SBarry Smith       while (ilink) {
1067421e10b8SBarry Smith         ierr  = FieldSplitSplitSolveAddTranspose(ilink,x,y);CHKERRQ(ierr);
1068421e10b8SBarry Smith         ilink = ilink->next;
1069421e10b8SBarry Smith       }
1070421e10b8SBarry Smith     }
1071421e10b8SBarry Smith   } else {
1072421e10b8SBarry Smith     if (!jac->w1) {
1073421e10b8SBarry Smith       ierr = VecDuplicate(x,&jac->w1);CHKERRQ(ierr);
1074421e10b8SBarry Smith       ierr = VecDuplicate(x,&jac->w2);CHKERRQ(ierr);
1075421e10b8SBarry Smith     }
1076421e10b8SBarry Smith     ierr = VecSet(y,0.0);CHKERRQ(ierr);
1077421e10b8SBarry Smith     if (jac->type == PC_COMPOSITE_SYMMETRIC_MULTIPLICATIVE) {
1078421e10b8SBarry Smith       ierr = FieldSplitSplitSolveAddTranspose(ilink,x,y);CHKERRQ(ierr);
1079421e10b8SBarry Smith       while (ilink->next) {
1080421e10b8SBarry Smith         ilink = ilink->next;
10819989ab13SBarry Smith         ierr  = MatMultTranspose(pc->mat,y,jac->w1);CHKERRQ(ierr);
1082421e10b8SBarry Smith         ierr  = VecWAXPY(jac->w2,-1.0,jac->w1,x);CHKERRQ(ierr);
1083421e10b8SBarry Smith         ierr  = FieldSplitSplitSolveAddTranspose(ilink,jac->w2,y);CHKERRQ(ierr);
1084421e10b8SBarry Smith       }
1085421e10b8SBarry Smith       while (ilink->previous) {
1086421e10b8SBarry Smith         ilink = ilink->previous;
10879989ab13SBarry Smith         ierr  = MatMultTranspose(pc->mat,y,jac->w1);CHKERRQ(ierr);
1088421e10b8SBarry Smith         ierr  = VecWAXPY(jac->w2,-1.0,jac->w1,x);CHKERRQ(ierr);
1089421e10b8SBarry Smith         ierr  = FieldSplitSplitSolveAddTranspose(ilink,jac->w2,y);CHKERRQ(ierr);
1090421e10b8SBarry Smith       }
1091421e10b8SBarry Smith     } else {
1092421e10b8SBarry Smith       while (ilink->next) {   /* get to last entry in linked list */
1093421e10b8SBarry Smith         ilink = ilink->next;
1094421e10b8SBarry Smith       }
1095421e10b8SBarry Smith       ierr = FieldSplitSplitSolveAddTranspose(ilink,x,y);CHKERRQ(ierr);
1096421e10b8SBarry Smith       while (ilink->previous) {
1097421e10b8SBarry Smith         ilink = ilink->previous;
10989989ab13SBarry Smith         ierr  = MatMultTranspose(pc->mat,y,jac->w1);CHKERRQ(ierr);
1099421e10b8SBarry Smith         ierr  = VecWAXPY(jac->w2,-1.0,jac->w1,x);CHKERRQ(ierr);
1100421e10b8SBarry Smith         ierr  = FieldSplitSplitSolveAddTranspose(ilink,jac->w2,y);CHKERRQ(ierr);
1101421e10b8SBarry Smith       }
1102421e10b8SBarry Smith     }
1103421e10b8SBarry Smith   }
1104421e10b8SBarry Smith   PetscFunctionReturn(0);
1105421e10b8SBarry Smith }
1106421e10b8SBarry Smith 
11070971522cSBarry Smith #undef __FUNCT__
1108574deadeSBarry Smith #define __FUNCT__ "PCReset_FieldSplit"
1109574deadeSBarry Smith static PetscErrorCode PCReset_FieldSplit(PC pc)
11100971522cSBarry Smith {
11110971522cSBarry Smith   PC_FieldSplit     *jac = (PC_FieldSplit*)pc->data;
11120971522cSBarry Smith   PetscErrorCode    ierr;
11135a9f2f41SSatish Balay   PC_FieldSplitLink ilink = jac->head,next;
11140971522cSBarry Smith 
11150971522cSBarry Smith   PetscFunctionBegin;
11165a9f2f41SSatish Balay   while (ilink) {
1117574deadeSBarry Smith     ierr  = KSPReset(ilink->ksp);CHKERRQ(ierr);
1118fcfd50ebSBarry Smith     ierr  = VecDestroy(&ilink->x);CHKERRQ(ierr);
1119fcfd50ebSBarry Smith     ierr  = VecDestroy(&ilink->y);CHKERRQ(ierr);
1120443836d0SMatthew G Knepley     ierr  = VecDestroy(&ilink->z);CHKERRQ(ierr);
1121fcfd50ebSBarry Smith     ierr  = VecScatterDestroy(&ilink->sctx);CHKERRQ(ierr);
1122fcfd50ebSBarry Smith     ierr  = ISDestroy(&ilink->is);CHKERRQ(ierr);
1123b5787286SJed Brown     ierr  = ISDestroy(&ilink->is_col);CHKERRQ(ierr);
11245a9f2f41SSatish Balay     next  = ilink->next;
11255a9f2f41SSatish Balay     ilink = next;
11260971522cSBarry Smith   }
112705b42c5fSBarry Smith   ierr = PetscFree2(jac->x,jac->y);CHKERRQ(ierr);
1128574deadeSBarry Smith   if (jac->mat && jac->mat != jac->pmat) {
1129574deadeSBarry Smith     ierr = MatDestroyMatrices(jac->nsplits,&jac->mat);CHKERRQ(ierr);
1130574deadeSBarry Smith   } else if (jac->mat) {
11310298fd71SBarry Smith     jac->mat = NULL;
1132574deadeSBarry Smith   }
113397bbdb24SBarry Smith   if (jac->pmat) {ierr = MatDestroyMatrices(jac->nsplits,&jac->pmat);CHKERRQ(ierr);}
113468dd23aaSBarry Smith   if (jac->Afield) {ierr = MatDestroyMatrices(jac->nsplits,&jac->Afield);CHKERRQ(ierr);}
11356bf464f9SBarry Smith   ierr       = VecDestroy(&jac->w1);CHKERRQ(ierr);
11366bf464f9SBarry Smith   ierr       = VecDestroy(&jac->w2);CHKERRQ(ierr);
11376bf464f9SBarry Smith   ierr       = MatDestroy(&jac->schur);CHKERRQ(ierr);
1138a7476a74SDmitry Karpeev   ierr       = MatDestroy(&jac->schurp);CHKERRQ(ierr);
11396bf464f9SBarry Smith   ierr       = MatDestroy(&jac->schur_user);CHKERRQ(ierr);
11406bf464f9SBarry Smith   ierr       = KSPDestroy(&jac->kspschur);CHKERRQ(ierr);
1141d78dad28SBarry Smith   ierr       = KSPDestroy(&jac->kspupper);CHKERRQ(ierr);
11426bf464f9SBarry Smith   ierr       = MatDestroy(&jac->B);CHKERRQ(ierr);
11436bf464f9SBarry Smith   ierr       = MatDestroy(&jac->C);CHKERRQ(ierr);
114463ec74ffSBarry Smith   jac->reset = PETSC_TRUE;
1145574deadeSBarry Smith   PetscFunctionReturn(0);
1146574deadeSBarry Smith }
1147574deadeSBarry Smith 
1148574deadeSBarry Smith #undef __FUNCT__
1149574deadeSBarry Smith #define __FUNCT__ "PCDestroy_FieldSplit"
1150574deadeSBarry Smith static PetscErrorCode PCDestroy_FieldSplit(PC pc)
1151574deadeSBarry Smith {
1152574deadeSBarry Smith   PC_FieldSplit     *jac = (PC_FieldSplit*)pc->data;
1153574deadeSBarry Smith   PetscErrorCode    ierr;
1154574deadeSBarry Smith   PC_FieldSplitLink ilink = jac->head,next;
1155574deadeSBarry Smith 
1156574deadeSBarry Smith   PetscFunctionBegin;
1157574deadeSBarry Smith   ierr = PCReset_FieldSplit(pc);CHKERRQ(ierr);
1158574deadeSBarry Smith   while (ilink) {
11596bf464f9SBarry Smith     ierr  = KSPDestroy(&ilink->ksp);CHKERRQ(ierr);
1160574deadeSBarry Smith     next  = ilink->next;
1161574deadeSBarry Smith     ierr  = PetscFree(ilink->splitname);CHKERRQ(ierr);
1162574deadeSBarry Smith     ierr  = PetscFree(ilink->fields);CHKERRQ(ierr);
11635d4c12cdSJungho Lee     ierr  = PetscFree(ilink->fields_col);CHKERRQ(ierr);
1164574deadeSBarry Smith     ierr  = PetscFree(ilink);CHKERRQ(ierr);
1165574deadeSBarry Smith     ilink = next;
1166574deadeSBarry Smith   }
1167574deadeSBarry Smith   ierr = PetscFree2(jac->x,jac->y);CHKERRQ(ierr);
1168c31cb41cSBarry Smith   ierr = PetscFree(pc->data);CHKERRQ(ierr);
1169bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitGetSubKSP_C",NULL);CHKERRQ(ierr);
1170bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetFields_C",NULL);CHKERRQ(ierr);
1171bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetIS_C",NULL);CHKERRQ(ierr);
1172bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetType_C",NULL);CHKERRQ(ierr);
1173bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetBlockSize_C",NULL);CHKERRQ(ierr);
117429f8a81cSJed Brown   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetSchurPre_C",NULL);CHKERRQ(ierr);
117537a82bf0SJed Brown   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitGetSchurPre_C",NULL);CHKERRQ(ierr);
1176bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetSchurFactType_C",NULL);CHKERRQ(ierr);
11770971522cSBarry Smith   PetscFunctionReturn(0);
11780971522cSBarry Smith }
11790971522cSBarry Smith 
11800971522cSBarry Smith #undef __FUNCT__
11810971522cSBarry Smith #define __FUNCT__ "PCSetFromOptions_FieldSplit"
11824416b707SBarry Smith static PetscErrorCode PCSetFromOptions_FieldSplit(PetscOptionItems *PetscOptionsObject,PC pc)
11830971522cSBarry Smith {
11841b9fc7fcSBarry Smith   PetscErrorCode  ierr;
11856c924f48SJed Brown   PetscInt        bs;
1186bc59fbc5SBarry Smith   PetscBool       flg,stokes = PETSC_FALSE;
11879dcbbd2bSBarry Smith   PC_FieldSplit   *jac = (PC_FieldSplit*)pc->data;
11883b224e63SBarry Smith   PCCompositeType ctype;
11891b9fc7fcSBarry Smith 
11900971522cSBarry Smith   PetscFunctionBegin;
1191e55864a3SBarry Smith   ierr = PetscOptionsHead(PetscOptionsObject,"FieldSplit options");CHKERRQ(ierr);
11924ab8060aSDmitry Karpeev   ierr = PetscOptionsBool("-pc_fieldsplit_dm_splits","Whether to use DMCreateFieldDecomposition() for splits","PCFieldSplitSetDMSplits",jac->dm_splits,&jac->dm_splits,NULL);CHKERRQ(ierr);
119351f519a2SBarry Smith   ierr = PetscOptionsInt("-pc_fieldsplit_block_size","Blocksize that defines number of fields","PCFieldSplitSetBlockSize",jac->bs,&bs,&flg);CHKERRQ(ierr);
119451f519a2SBarry Smith   if (flg) {
119551f519a2SBarry Smith     ierr = PCFieldSplitSetBlockSize(pc,bs);CHKERRQ(ierr);
119651f519a2SBarry Smith   }
11972686e3e9SMatthew G. Knepley   jac->diag_use_amat = pc->useAmat;
11982686e3e9SMatthew 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);
11992686e3e9SMatthew G. Knepley   jac->offdiag_use_amat = pc->useAmat;
12002686e3e9SMatthew 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);
120100216929SDmitry Karpeev   /* FIXME: No programmatic equivalent to the following. */
1202c5929fdfSBarry Smith   ierr = PetscOptionsGetBool(((PetscObject)pc)->options,((PetscObject)pc)->prefix,"-pc_fieldsplit_detect_saddle_point",&stokes,NULL);CHKERRQ(ierr);
1203c0adfefeSBarry Smith   if (stokes) {
1204c0adfefeSBarry Smith     ierr          = PCFieldSplitSetType(pc,PC_COMPOSITE_SCHUR);CHKERRQ(ierr);
1205c0adfefeSBarry Smith     jac->schurpre = PC_FIELDSPLIT_SCHUR_PRE_SELF;
1206c0adfefeSBarry Smith   }
1207c0adfefeSBarry Smith 
12083b224e63SBarry Smith   ierr = PetscOptionsEnum("-pc_fieldsplit_type","Type of composition","PCFieldSplitSetType",PCCompositeTypes,(PetscEnum)jac->type,(PetscEnum*)&ctype,&flg);CHKERRQ(ierr);
12093b224e63SBarry Smith   if (flg) {
12103b224e63SBarry Smith     ierr = PCFieldSplitSetType(pc,ctype);CHKERRQ(ierr);
12113b224e63SBarry Smith   }
1212c30613efSMatthew Knepley   /* Only setup fields once */
1213c30613efSMatthew Knepley   if ((jac->bs > 0) && (jac->nsplits == 0)) {
1214d32f9abdSBarry Smith     /* only allow user to set fields from command line if bs is already known.
1215d32f9abdSBarry Smith        otherwise user can set them in PCFieldSplitSetDefaults() */
12166c924f48SJed Brown     ierr = PCFieldSplitSetRuntimeSplits_Private(pc);CHKERRQ(ierr);
12176c924f48SJed Brown     if (jac->splitdefined) {ierr = PetscInfo(pc,"Splits defined using the options database\n");CHKERRQ(ierr);}
1218d32f9abdSBarry Smith   }
1219c5d2311dSJed Brown   if (jac->type == PC_COMPOSITE_SCHUR) {
1220c5929fdfSBarry Smith     ierr = PetscOptionsGetEnum(((PetscObject)pc)->options,((PetscObject)pc)->prefix,"-pc_fieldsplit_schur_factorization_type",PCFieldSplitSchurFactTypes,(PetscEnum*)&jac->schurfactorization,&flg);CHKERRQ(ierr);
1221c9c6ffaaSJed Brown     if (flg) {ierr = PetscInfo(pc,"Deprecated use of -pc_fieldsplit_schur_factorization_type\n");CHKERRQ(ierr);}
12220298fd71SBarry 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);
122329f8a81cSJed 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);
1224c5d2311dSJed Brown   }
12251b9fc7fcSBarry Smith   ierr = PetscOptionsTail();CHKERRQ(ierr);
12260971522cSBarry Smith   PetscFunctionReturn(0);
12270971522cSBarry Smith }
12280971522cSBarry Smith 
12290971522cSBarry Smith /*------------------------------------------------------------------------------------*/
12300971522cSBarry Smith 
12310971522cSBarry Smith #undef __FUNCT__
12320971522cSBarry Smith #define __FUNCT__ "PCFieldSplitSetFields_FieldSplit"
12331e6b0712SBarry Smith static PetscErrorCode  PCFieldSplitSetFields_FieldSplit(PC pc,const char splitname[],PetscInt n,const PetscInt *fields,const PetscInt *fields_col)
12340971522cSBarry Smith {
123597bbdb24SBarry Smith   PC_FieldSplit     *jac = (PC_FieldSplit*)pc->data;
12360971522cSBarry Smith   PetscErrorCode    ierr;
12375a9f2f41SSatish Balay   PC_FieldSplitLink ilink,next = jac->head;
123869a612a9SBarry Smith   char              prefix[128];
12395d4c12cdSJungho Lee   PetscInt          i;
12400971522cSBarry Smith 
12410971522cSBarry Smith   PetscFunctionBegin;
12426c924f48SJed Brown   if (jac->splitdefined) {
12436c924f48SJed Brown     ierr = PetscInfo1(pc,"Ignoring new split \"%s\" because the splits have already been defined\n",splitname);CHKERRQ(ierr);
12446c924f48SJed Brown     PetscFunctionReturn(0);
12456c924f48SJed Brown   }
124651f519a2SBarry Smith   for (i=0; i<n; i++) {
1247e32f2f54SBarry 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);
1248e32f2f54SBarry Smith     if (fields[i] < 0) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Negative field %D requested",fields[i]);
124951f519a2SBarry Smith   }
1250b00a9115SJed Brown   ierr = PetscNew(&ilink);CHKERRQ(ierr);
1251a04f6461SBarry Smith   if (splitname) {
1252db4c96c1SJed Brown     ierr = PetscStrallocpy(splitname,&ilink->splitname);CHKERRQ(ierr);
1253a04f6461SBarry Smith   } else {
1254785e854fSJed Brown     ierr = PetscMalloc1(3,&ilink->splitname);CHKERRQ(ierr);
1255a04f6461SBarry Smith     ierr = PetscSNPrintf(ilink->splitname,2,"%s",jac->nsplits);CHKERRQ(ierr);
1256a04f6461SBarry Smith   }
1257785e854fSJed Brown   ierr = PetscMalloc1(n,&ilink->fields);CHKERRQ(ierr);
12585a9f2f41SSatish Balay   ierr = PetscMemcpy(ilink->fields,fields,n*sizeof(PetscInt));CHKERRQ(ierr);
1259785e854fSJed Brown   ierr = PetscMalloc1(n,&ilink->fields_col);CHKERRQ(ierr);
12605d4c12cdSJungho Lee   ierr = PetscMemcpy(ilink->fields_col,fields_col,n*sizeof(PetscInt));CHKERRQ(ierr);
12612fa5cd67SKarl Rupp 
12625a9f2f41SSatish Balay   ilink->nfields = n;
12630298fd71SBarry Smith   ilink->next    = NULL;
1264ce94432eSBarry Smith   ierr           = KSPCreate(PetscObjectComm((PetscObject)pc),&ilink->ksp);CHKERRQ(ierr);
1265422a814eSBarry Smith   ierr           = KSPSetErrorIfNotConverged(ilink->ksp,pc->erroriffailure);CHKERRQ(ierr);
126620252d06SBarry Smith   ierr           = PetscObjectIncrementTabLevel((PetscObject)ilink->ksp,(PetscObject)pc,1);CHKERRQ(ierr);
12675a9f2f41SSatish Balay   ierr           = KSPSetType(ilink->ksp,KSPPREONLY);CHKERRQ(ierr);
12689005cf84SBarry Smith   ierr           = PetscLogObjectParent((PetscObject)pc,(PetscObject)ilink->ksp);CHKERRQ(ierr);
126969a612a9SBarry Smith 
12708caf3d72SBarry Smith   ierr = PetscSNPrintf(prefix,sizeof(prefix),"%sfieldsplit_%s_",((PetscObject)pc)->prefix ? ((PetscObject)pc)->prefix : "",ilink->splitname);CHKERRQ(ierr);
12715a9f2f41SSatish Balay   ierr = KSPSetOptionsPrefix(ilink->ksp,prefix);CHKERRQ(ierr);
12720971522cSBarry Smith 
12730971522cSBarry Smith   if (!next) {
12745a9f2f41SSatish Balay     jac->head       = ilink;
12750298fd71SBarry Smith     ilink->previous = NULL;
12760971522cSBarry Smith   } else {
12770971522cSBarry Smith     while (next->next) {
12780971522cSBarry Smith       next = next->next;
12790971522cSBarry Smith     }
12805a9f2f41SSatish Balay     next->next      = ilink;
128151f519a2SBarry Smith     ilink->previous = next;
12820971522cSBarry Smith   }
12830971522cSBarry Smith   jac->nsplits++;
12840971522cSBarry Smith   PetscFunctionReturn(0);
12850971522cSBarry Smith }
12860971522cSBarry Smith 
1287e69d4d44SBarry Smith #undef __FUNCT__
1288e69d4d44SBarry Smith #define __FUNCT__ "PCFieldSplitGetSubKSP_FieldSplit_Schur"
12891e6b0712SBarry Smith static PetscErrorCode  PCFieldSplitGetSubKSP_FieldSplit_Schur(PC pc,PetscInt *n,KSP **subksp)
1290e69d4d44SBarry Smith {
1291e69d4d44SBarry Smith   PC_FieldSplit  *jac = (PC_FieldSplit*)pc->data;
1292e69d4d44SBarry Smith   PetscErrorCode ierr;
1293e69d4d44SBarry Smith 
1294e69d4d44SBarry Smith   PetscFunctionBegin;
1295785e854fSJed Brown   ierr = PetscMalloc1(jac->nsplits,subksp);CHKERRQ(ierr);
1296e69d4d44SBarry Smith   ierr = MatSchurComplementGetKSP(jac->schur,*subksp);CHKERRQ(ierr);
12972fa5cd67SKarl Rupp 
1298e69d4d44SBarry Smith   (*subksp)[1] = jac->kspschur;
129913e0d083SBarry Smith   if (n) *n = jac->nsplits;
1300e69d4d44SBarry Smith   PetscFunctionReturn(0);
1301e69d4d44SBarry Smith }
13020971522cSBarry Smith 
13030971522cSBarry Smith #undef __FUNCT__
130469a612a9SBarry Smith #define __FUNCT__ "PCFieldSplitGetSubKSP_FieldSplit"
13051e6b0712SBarry Smith static PetscErrorCode  PCFieldSplitGetSubKSP_FieldSplit(PC pc,PetscInt *n,KSP **subksp)
13060971522cSBarry Smith {
13070971522cSBarry Smith   PC_FieldSplit     *jac = (PC_FieldSplit*)pc->data;
13080971522cSBarry Smith   PetscErrorCode    ierr;
13090971522cSBarry Smith   PetscInt          cnt   = 0;
13105a9f2f41SSatish Balay   PC_FieldSplitLink ilink = jac->head;
13110971522cSBarry Smith 
13120971522cSBarry Smith   PetscFunctionBegin;
1313785e854fSJed Brown   ierr = PetscMalloc1(jac->nsplits,subksp);CHKERRQ(ierr);
13145a9f2f41SSatish Balay   while (ilink) {
13155a9f2f41SSatish Balay     (*subksp)[cnt++] = ilink->ksp;
13165a9f2f41SSatish Balay     ilink            = ilink->next;
13170971522cSBarry Smith   }
13185d480477SMatthew 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);
131913e0d083SBarry Smith   if (n) *n = jac->nsplits;
13200971522cSBarry Smith   PetscFunctionReturn(0);
13210971522cSBarry Smith }
13220971522cSBarry Smith 
1323704ba839SBarry Smith #undef __FUNCT__
1324704ba839SBarry Smith #define __FUNCT__ "PCFieldSplitSetIS_FieldSplit"
13251e6b0712SBarry Smith static PetscErrorCode  PCFieldSplitSetIS_FieldSplit(PC pc,const char splitname[],IS is)
1326704ba839SBarry Smith {
1327704ba839SBarry Smith   PC_FieldSplit     *jac = (PC_FieldSplit*)pc->data;
1328704ba839SBarry Smith   PetscErrorCode    ierr;
1329704ba839SBarry Smith   PC_FieldSplitLink ilink, next = jac->head;
1330704ba839SBarry Smith   char              prefix[128];
1331704ba839SBarry Smith 
1332704ba839SBarry Smith   PetscFunctionBegin;
13336c924f48SJed Brown   if (jac->splitdefined) {
13346c924f48SJed Brown     ierr = PetscInfo1(pc,"Ignoring new split \"%s\" because the splits have already been defined\n",splitname);CHKERRQ(ierr);
13356c924f48SJed Brown     PetscFunctionReturn(0);
13366c924f48SJed Brown   }
1337b00a9115SJed Brown   ierr = PetscNew(&ilink);CHKERRQ(ierr);
1338a04f6461SBarry Smith   if (splitname) {
1339db4c96c1SJed Brown     ierr = PetscStrallocpy(splitname,&ilink->splitname);CHKERRQ(ierr);
1340a04f6461SBarry Smith   } else {
1341785e854fSJed Brown     ierr = PetscMalloc1(8,&ilink->splitname);CHKERRQ(ierr);
1342b5787286SJed Brown     ierr = PetscSNPrintf(ilink->splitname,7,"%D",jac->nsplits);CHKERRQ(ierr);
1343a04f6461SBarry Smith   }
13441ab39975SBarry Smith   ierr          = PetscObjectReference((PetscObject)is);CHKERRQ(ierr);
1345b5787286SJed Brown   ierr          = ISDestroy(&ilink->is);CHKERRQ(ierr);
1346b5787286SJed Brown   ilink->is     = is;
1347b5787286SJed Brown   ierr          = PetscObjectReference((PetscObject)is);CHKERRQ(ierr);
1348b5787286SJed Brown   ierr          = ISDestroy(&ilink->is_col);CHKERRQ(ierr);
1349b5787286SJed Brown   ilink->is_col = is;
13500298fd71SBarry Smith   ilink->next   = NULL;
1351ce94432eSBarry Smith   ierr          = KSPCreate(PetscObjectComm((PetscObject)pc),&ilink->ksp);CHKERRQ(ierr);
1352422a814eSBarry Smith   ierr          = KSPSetErrorIfNotConverged(ilink->ksp,pc->erroriffailure);CHKERRQ(ierr);
135320252d06SBarry Smith   ierr          = PetscObjectIncrementTabLevel((PetscObject)ilink->ksp,(PetscObject)pc,1);CHKERRQ(ierr);
1354704ba839SBarry Smith   ierr          = KSPSetType(ilink->ksp,KSPPREONLY);CHKERRQ(ierr);
13559005cf84SBarry Smith   ierr          = PetscLogObjectParent((PetscObject)pc,(PetscObject)ilink->ksp);CHKERRQ(ierr);
1356704ba839SBarry Smith 
13578caf3d72SBarry Smith   ierr = PetscSNPrintf(prefix,sizeof(prefix),"%sfieldsplit_%s_",((PetscObject)pc)->prefix ? ((PetscObject)pc)->prefix : "",ilink->splitname);CHKERRQ(ierr);
1358704ba839SBarry Smith   ierr = KSPSetOptionsPrefix(ilink->ksp,prefix);CHKERRQ(ierr);
1359704ba839SBarry Smith 
1360704ba839SBarry Smith   if (!next) {
1361704ba839SBarry Smith     jac->head       = ilink;
13620298fd71SBarry Smith     ilink->previous = NULL;
1363704ba839SBarry Smith   } else {
1364704ba839SBarry Smith     while (next->next) {
1365704ba839SBarry Smith       next = next->next;
1366704ba839SBarry Smith     }
1367704ba839SBarry Smith     next->next      = ilink;
1368704ba839SBarry Smith     ilink->previous = next;
1369704ba839SBarry Smith   }
1370704ba839SBarry Smith   jac->nsplits++;
1371704ba839SBarry Smith   PetscFunctionReturn(0);
1372704ba839SBarry Smith }
1373704ba839SBarry Smith 
13740971522cSBarry Smith #undef __FUNCT__
13750971522cSBarry Smith #define __FUNCT__ "PCFieldSplitSetFields"
13760971522cSBarry Smith /*@
13770971522cSBarry Smith     PCFieldSplitSetFields - Sets the fields for one particular split in the field split preconditioner
13780971522cSBarry Smith 
1379ad4df100SBarry Smith     Logically Collective on PC
13800971522cSBarry Smith 
13810971522cSBarry Smith     Input Parameters:
13820971522cSBarry Smith +   pc  - the preconditioner context
13830298fd71SBarry Smith .   splitname - name of this split, if NULL the number of the split is used
13840971522cSBarry Smith .   n - the number of fields in this split
1385db4c96c1SJed Brown -   fields - the fields in this split
13860971522cSBarry Smith 
13870971522cSBarry Smith     Level: intermediate
13880971522cSBarry Smith 
1389d32f9abdSBarry Smith     Notes: Use PCFieldSplitSetIS() to set a completely general set of indices as a field.
1390d32f9abdSBarry Smith 
13917287d2a3SDmitry Karpeev      The PCFieldSplitSetFields() is for defining fields as strided blocks. For example, if the block
1392d32f9abdSBarry 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
1393d32f9abdSBarry Smith      0xx3xx6xx9xx12 ... x1xx4xx7xx ... xx2xx5xx8xx.. 01x34x67x... 0x1x3x5x7.. x12x45x78x....
1394d32f9abdSBarry Smith      where the numbered entries indicate what is in the field.
1395d32f9abdSBarry Smith 
1396db4c96c1SJed Brown      This function is called once per split (it creates a new split each time).  Solve options
1397db4c96c1SJed Brown      for this split will be available under the prefix -fieldsplit_SPLITNAME_.
1398db4c96c1SJed Brown 
13995d4c12cdSJungho Lee      Developer Note: This routine does not actually create the IS representing the split, that is delayed
14005d4c12cdSJungho Lee      until PCSetUp_FieldSplit(), because information about the vector/matrix layouts may not be
14015d4c12cdSJungho Lee      available when this routine is called.
14025d4c12cdSJungho Lee 
1403d32f9abdSBarry Smith .seealso: PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitSetBlockSize(), PCFieldSplitSetIS()
14040971522cSBarry Smith 
14050971522cSBarry Smith @*/
14065d4c12cdSJungho Lee PetscErrorCode  PCFieldSplitSetFields(PC pc,const char splitname[],PetscInt n,const PetscInt *fields,const PetscInt *fields_col)
14070971522cSBarry Smith {
14084ac538c5SBarry Smith   PetscErrorCode ierr;
14090971522cSBarry Smith 
14100971522cSBarry Smith   PetscFunctionBegin;
14110700a824SBarry Smith   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
1412db4c96c1SJed Brown   PetscValidCharPointer(splitname,2);
1413ce94432eSBarry Smith   if (n < 1) SETERRQ2(PetscObjectComm((PetscObject)pc),PETSC_ERR_ARG_OUTOFRANGE,"Provided number of fields %D in split \"%s\" not positive",n,splitname);
1414db4c96c1SJed Brown   PetscValidIntPointer(fields,3);
14155d4c12cdSJungho Lee   ierr = PetscTryMethod(pc,"PCFieldSplitSetFields_C",(PC,const char[],PetscInt,const PetscInt*,const PetscInt*),(pc,splitname,n,fields,fields_col));CHKERRQ(ierr);
14160971522cSBarry Smith   PetscFunctionReturn(0);
14170971522cSBarry Smith }
14180971522cSBarry Smith 
14190971522cSBarry Smith #undef __FUNCT__
1420c84da90fSDmitry Karpeev #define __FUNCT__ "PCFieldSplitSetDiagUseAmat"
1421c84da90fSDmitry Karpeev /*@
1422c84da90fSDmitry Karpeev     PCFieldSplitSetDiagUseAmat - set flag indicating whether to extract diagonal blocks from Amat (rather than Pmat)
1423c84da90fSDmitry Karpeev 
1424c84da90fSDmitry Karpeev     Logically Collective on PC
1425c84da90fSDmitry Karpeev 
1426c84da90fSDmitry Karpeev     Input Parameters:
1427c84da90fSDmitry Karpeev +   pc  - the preconditioner object
1428c84da90fSDmitry Karpeev -   flg - boolean flag indicating whether or not to use Amat to extract the diagonal blocks from
1429c84da90fSDmitry Karpeev 
14309506b623SDmitry Karpeev     Options Database:
14319506b623SDmitry Karpeev .     -pc_fieldsplit_diag_use_amat
1432c84da90fSDmitry Karpeev 
1433c84da90fSDmitry Karpeev     Level: intermediate
1434c84da90fSDmitry Karpeev 
1435c84da90fSDmitry Karpeev .seealso: PCFieldSplitGetDiagUseAmat(), PCFieldSplitSetOffDiagUseAmat(), PCFIELDSPLIT
1436c84da90fSDmitry Karpeev 
1437c84da90fSDmitry Karpeev @*/
1438c84da90fSDmitry Karpeev PetscErrorCode  PCFieldSplitSetDiagUseAmat(PC pc,PetscBool flg)
1439c84da90fSDmitry Karpeev {
1440c84da90fSDmitry Karpeev   PC_FieldSplit  *jac = (PC_FieldSplit*)pc->data;
1441c84da90fSDmitry Karpeev   PetscBool      isfs;
1442c84da90fSDmitry Karpeev   PetscErrorCode ierr;
1443c84da90fSDmitry Karpeev 
1444c84da90fSDmitry Karpeev   PetscFunctionBegin;
1445c84da90fSDmitry Karpeev   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
1446c84da90fSDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)pc,PCFIELDSPLIT,&isfs);CHKERRQ(ierr);
1447c84da90fSDmitry Karpeev   if (!isfs) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"PC not of type %s",PCFIELDSPLIT);
1448c84da90fSDmitry Karpeev   jac->diag_use_amat = flg;
1449c84da90fSDmitry Karpeev   PetscFunctionReturn(0);
1450c84da90fSDmitry Karpeev }
1451c84da90fSDmitry Karpeev 
1452c84da90fSDmitry Karpeev #undef __FUNCT__
1453c84da90fSDmitry Karpeev #define __FUNCT__ "PCFieldSplitGetDiagUseAmat"
1454c84da90fSDmitry Karpeev /*@
1455c84da90fSDmitry Karpeev     PCFieldSplitGetDiagUseAmat - get the flag indicating whether to extract diagonal blocks from Amat (rather than Pmat)
1456c84da90fSDmitry Karpeev 
1457c84da90fSDmitry Karpeev     Logically Collective on PC
1458c84da90fSDmitry Karpeev 
1459c84da90fSDmitry Karpeev     Input Parameters:
1460c84da90fSDmitry Karpeev .   pc  - the preconditioner object
1461c84da90fSDmitry Karpeev 
1462c84da90fSDmitry Karpeev     Output Parameters:
1463c84da90fSDmitry Karpeev .   flg - boolean flag indicating whether or not to use Amat to extract the diagonal blocks from
1464c84da90fSDmitry Karpeev 
1465c84da90fSDmitry Karpeev 
1466c84da90fSDmitry Karpeev     Level: intermediate
1467c84da90fSDmitry Karpeev 
1468c84da90fSDmitry Karpeev .seealso: PCFieldSplitSetDiagUseAmat(), PCFieldSplitGetOffDiagUseAmat(), PCFIELDSPLIT
1469c84da90fSDmitry Karpeev 
1470c84da90fSDmitry Karpeev @*/
1471c84da90fSDmitry Karpeev PetscErrorCode  PCFieldSplitGetDiagUseAmat(PC pc,PetscBool *flg)
1472c84da90fSDmitry Karpeev {
1473c84da90fSDmitry Karpeev   PC_FieldSplit  *jac = (PC_FieldSplit*)pc->data;
1474c84da90fSDmitry Karpeev   PetscBool      isfs;
1475c84da90fSDmitry Karpeev   PetscErrorCode ierr;
1476c84da90fSDmitry Karpeev 
1477c84da90fSDmitry Karpeev   PetscFunctionBegin;
1478c84da90fSDmitry Karpeev   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
1479c84da90fSDmitry Karpeev   PetscValidPointer(flg,2);
1480c84da90fSDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)pc,PCFIELDSPLIT,&isfs);CHKERRQ(ierr);
1481c84da90fSDmitry Karpeev   if (!isfs) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"PC not of type %s",PCFIELDSPLIT);
1482c84da90fSDmitry Karpeev   *flg = jac->diag_use_amat;
1483c84da90fSDmitry Karpeev   PetscFunctionReturn(0);
1484c84da90fSDmitry Karpeev }
1485c84da90fSDmitry Karpeev 
1486c84da90fSDmitry Karpeev #undef __FUNCT__
1487c84da90fSDmitry Karpeev #define __FUNCT__ "PCFieldSplitSetOffDiagUseAmat"
1488c84da90fSDmitry Karpeev /*@
1489c84da90fSDmitry Karpeev     PCFieldSplitSetOffDiagUseAmat - set flag indicating whether to extract off-diagonal blocks from Amat (rather than Pmat)
1490c84da90fSDmitry Karpeev 
1491c84da90fSDmitry Karpeev     Logically Collective on PC
1492c84da90fSDmitry Karpeev 
1493c84da90fSDmitry Karpeev     Input Parameters:
1494c84da90fSDmitry Karpeev +   pc  - the preconditioner object
1495c84da90fSDmitry Karpeev -   flg - boolean flag indicating whether or not to use Amat to extract the off-diagonal blocks from
1496c84da90fSDmitry Karpeev 
14979506b623SDmitry Karpeev     Options Database:
14989506b623SDmitry Karpeev .     -pc_fieldsplit_off_diag_use_amat
1499c84da90fSDmitry Karpeev 
1500c84da90fSDmitry Karpeev     Level: intermediate
1501c84da90fSDmitry Karpeev 
1502c84da90fSDmitry Karpeev .seealso: PCFieldSplitGetOffDiagUseAmat(), PCFieldSplitSetDiagUseAmat(), PCFIELDSPLIT
1503c84da90fSDmitry Karpeev 
1504c84da90fSDmitry Karpeev @*/
1505c84da90fSDmitry Karpeev PetscErrorCode  PCFieldSplitSetOffDiagUseAmat(PC pc,PetscBool flg)
1506c84da90fSDmitry Karpeev {
1507c84da90fSDmitry Karpeev   PC_FieldSplit *jac = (PC_FieldSplit*)pc->data;
1508c84da90fSDmitry Karpeev   PetscBool      isfs;
1509c84da90fSDmitry Karpeev   PetscErrorCode ierr;
1510c84da90fSDmitry Karpeev 
1511c84da90fSDmitry Karpeev   PetscFunctionBegin;
1512c84da90fSDmitry Karpeev   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
1513c84da90fSDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)pc,PCFIELDSPLIT,&isfs);CHKERRQ(ierr);
1514c84da90fSDmitry Karpeev   if (!isfs) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"PC not of type %s",PCFIELDSPLIT);
1515c84da90fSDmitry Karpeev   jac->offdiag_use_amat = flg;
1516c84da90fSDmitry Karpeev   PetscFunctionReturn(0);
1517c84da90fSDmitry Karpeev }
1518c84da90fSDmitry Karpeev 
1519c84da90fSDmitry Karpeev #undef __FUNCT__
1520c84da90fSDmitry Karpeev #define __FUNCT__ "PCFieldSplitGetOffDiagUseAmat"
1521c84da90fSDmitry Karpeev /*@
1522c84da90fSDmitry Karpeev     PCFieldSplitGetOffDiagUseAmat - get the flag indicating whether to extract off-diagonal blocks from Amat (rather than Pmat)
1523c84da90fSDmitry Karpeev 
1524c84da90fSDmitry Karpeev     Logically Collective on PC
1525c84da90fSDmitry Karpeev 
1526c84da90fSDmitry Karpeev     Input Parameters:
1527c84da90fSDmitry Karpeev .   pc  - the preconditioner object
1528c84da90fSDmitry Karpeev 
1529c84da90fSDmitry Karpeev     Output Parameters:
1530c84da90fSDmitry Karpeev .   flg - boolean flag indicating whether or not to use Amat to extract the off-diagonal blocks from
1531c84da90fSDmitry Karpeev 
1532c84da90fSDmitry Karpeev 
1533c84da90fSDmitry Karpeev     Level: intermediate
1534c84da90fSDmitry Karpeev 
1535c84da90fSDmitry Karpeev .seealso: PCFieldSplitSetOffDiagUseAmat(), PCFieldSplitGetDiagUseAmat(), PCFIELDSPLIT
1536c84da90fSDmitry Karpeev 
1537c84da90fSDmitry Karpeev @*/
1538c84da90fSDmitry Karpeev PetscErrorCode  PCFieldSplitGetOffDiagUseAmat(PC pc,PetscBool *flg)
1539c84da90fSDmitry Karpeev {
1540c84da90fSDmitry Karpeev   PC_FieldSplit  *jac = (PC_FieldSplit*)pc->data;
1541c84da90fSDmitry Karpeev   PetscBool      isfs;
1542c84da90fSDmitry Karpeev   PetscErrorCode ierr;
1543c84da90fSDmitry Karpeev 
1544c84da90fSDmitry Karpeev   PetscFunctionBegin;
1545c84da90fSDmitry Karpeev   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
1546c84da90fSDmitry Karpeev   PetscValidPointer(flg,2);
1547c84da90fSDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)pc,PCFIELDSPLIT,&isfs);CHKERRQ(ierr);
1548c84da90fSDmitry Karpeev   if (!isfs) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"PC not of type %s",PCFIELDSPLIT);
1549c84da90fSDmitry Karpeev   *flg = jac->offdiag_use_amat;
1550c84da90fSDmitry Karpeev   PetscFunctionReturn(0);
1551c84da90fSDmitry Karpeev }
1552c84da90fSDmitry Karpeev 
1553c84da90fSDmitry Karpeev 
1554c84da90fSDmitry Karpeev 
1555c84da90fSDmitry Karpeev #undef __FUNCT__
1556704ba839SBarry Smith #define __FUNCT__ "PCFieldSplitSetIS"
1557218d4943SBarry Smith /*@C
1558704ba839SBarry Smith     PCFieldSplitSetIS - Sets the exact elements for field
1559704ba839SBarry Smith 
1560ad4df100SBarry Smith     Logically Collective on PC
1561704ba839SBarry Smith 
1562704ba839SBarry Smith     Input Parameters:
1563704ba839SBarry Smith +   pc  - the preconditioner context
15640298fd71SBarry Smith .   splitname - name of this split, if NULL the number of the split is used
1565db4c96c1SJed Brown -   is - the index set that defines the vector elements in this field
1566704ba839SBarry Smith 
1567d32f9abdSBarry Smith 
1568a6ffb8dbSJed Brown     Notes:
1569a6ffb8dbSJed Brown     Use PCFieldSplitSetFields(), for fields defined by strided types.
1570a6ffb8dbSJed Brown 
1571db4c96c1SJed Brown     This function is called once per split (it creates a new split each time).  Solve options
1572db4c96c1SJed Brown     for this split will be available under the prefix -fieldsplit_SPLITNAME_.
1573d32f9abdSBarry Smith 
1574704ba839SBarry Smith     Level: intermediate
1575704ba839SBarry Smith 
1576704ba839SBarry Smith .seealso: PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitSetBlockSize()
1577704ba839SBarry Smith 
1578704ba839SBarry Smith @*/
15797087cfbeSBarry Smith PetscErrorCode  PCFieldSplitSetIS(PC pc,const char splitname[],IS is)
1580704ba839SBarry Smith {
15814ac538c5SBarry Smith   PetscErrorCode ierr;
1582704ba839SBarry Smith 
1583704ba839SBarry Smith   PetscFunctionBegin;
15840700a824SBarry Smith   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
15857b62db95SJungho Lee   if (splitname) PetscValidCharPointer(splitname,2);
1586db4c96c1SJed Brown   PetscValidHeaderSpecific(is,IS_CLASSID,3);
15874ac538c5SBarry Smith   ierr = PetscTryMethod(pc,"PCFieldSplitSetIS_C",(PC,const char[],IS),(pc,splitname,is));CHKERRQ(ierr);
1588704ba839SBarry Smith   PetscFunctionReturn(0);
1589704ba839SBarry Smith }
1590704ba839SBarry Smith 
1591704ba839SBarry Smith #undef __FUNCT__
159257a9adfeSMatthew G Knepley #define __FUNCT__ "PCFieldSplitGetIS"
159357a9adfeSMatthew G Knepley /*@
159457a9adfeSMatthew G Knepley     PCFieldSplitGetIS - Retrieves the elements for a field as an IS
159557a9adfeSMatthew G Knepley 
159657a9adfeSMatthew G Knepley     Logically Collective on PC
159757a9adfeSMatthew G Knepley 
159857a9adfeSMatthew G Knepley     Input Parameters:
159957a9adfeSMatthew G Knepley +   pc  - the preconditioner context
160057a9adfeSMatthew G Knepley -   splitname - name of this split
160157a9adfeSMatthew G Knepley 
160257a9adfeSMatthew G Knepley     Output Parameter:
16030298fd71SBarry Smith -   is - the index set that defines the vector elements in this field, or NULL if the field is not found
160457a9adfeSMatthew G Knepley 
160557a9adfeSMatthew G Knepley     Level: intermediate
160657a9adfeSMatthew G Knepley 
160757a9adfeSMatthew G Knepley .seealso: PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitSetIS()
160857a9adfeSMatthew G Knepley 
160957a9adfeSMatthew G Knepley @*/
161057a9adfeSMatthew G Knepley PetscErrorCode PCFieldSplitGetIS(PC pc,const char splitname[],IS *is)
161157a9adfeSMatthew G Knepley {
161257a9adfeSMatthew G Knepley   PetscErrorCode ierr;
161357a9adfeSMatthew G Knepley 
161457a9adfeSMatthew G Knepley   PetscFunctionBegin;
161557a9adfeSMatthew G Knepley   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
161657a9adfeSMatthew G Knepley   PetscValidCharPointer(splitname,2);
161757a9adfeSMatthew G Knepley   PetscValidPointer(is,3);
161857a9adfeSMatthew G Knepley   {
161957a9adfeSMatthew G Knepley     PC_FieldSplit     *jac  = (PC_FieldSplit*) pc->data;
162057a9adfeSMatthew G Knepley     PC_FieldSplitLink ilink = jac->head;
162157a9adfeSMatthew G Knepley     PetscBool         found;
162257a9adfeSMatthew G Knepley 
16230298fd71SBarry Smith     *is = NULL;
162457a9adfeSMatthew G Knepley     while (ilink) {
162557a9adfeSMatthew G Knepley       ierr = PetscStrcmp(ilink->splitname, splitname, &found);CHKERRQ(ierr);
162657a9adfeSMatthew G Knepley       if (found) {
162757a9adfeSMatthew G Knepley         *is = ilink->is;
162857a9adfeSMatthew G Knepley         break;
162957a9adfeSMatthew G Knepley       }
163057a9adfeSMatthew G Knepley       ilink = ilink->next;
163157a9adfeSMatthew G Knepley     }
163257a9adfeSMatthew G Knepley   }
163357a9adfeSMatthew G Knepley   PetscFunctionReturn(0);
163457a9adfeSMatthew G Knepley }
163557a9adfeSMatthew G Knepley 
163657a9adfeSMatthew G Knepley #undef __FUNCT__
163751f519a2SBarry Smith #define __FUNCT__ "PCFieldSplitSetBlockSize"
163851f519a2SBarry Smith /*@
163951f519a2SBarry Smith     PCFieldSplitSetBlockSize - Sets the block size for defining where fields start in the
164051f519a2SBarry Smith       fieldsplit preconditioner. If not set the matrix block size is used.
164151f519a2SBarry Smith 
1642ad4df100SBarry Smith     Logically Collective on PC
164351f519a2SBarry Smith 
164451f519a2SBarry Smith     Input Parameters:
164551f519a2SBarry Smith +   pc  - the preconditioner context
164651f519a2SBarry Smith -   bs - the block size
164751f519a2SBarry Smith 
164851f519a2SBarry Smith     Level: intermediate
164951f519a2SBarry Smith 
165051f519a2SBarry Smith .seealso: PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitSetFields()
165151f519a2SBarry Smith 
165251f519a2SBarry Smith @*/
16537087cfbeSBarry Smith PetscErrorCode  PCFieldSplitSetBlockSize(PC pc,PetscInt bs)
165451f519a2SBarry Smith {
16554ac538c5SBarry Smith   PetscErrorCode ierr;
165651f519a2SBarry Smith 
165751f519a2SBarry Smith   PetscFunctionBegin;
16580700a824SBarry Smith   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
1659c5eb9154SBarry Smith   PetscValidLogicalCollectiveInt(pc,bs,2);
16604ac538c5SBarry Smith   ierr = PetscTryMethod(pc,"PCFieldSplitSetBlockSize_C",(PC,PetscInt),(pc,bs));CHKERRQ(ierr);
166151f519a2SBarry Smith   PetscFunctionReturn(0);
166251f519a2SBarry Smith }
166351f519a2SBarry Smith 
166451f519a2SBarry Smith #undef __FUNCT__
166569a612a9SBarry Smith #define __FUNCT__ "PCFieldSplitGetSubKSP"
16660971522cSBarry Smith /*@C
166769a612a9SBarry Smith    PCFieldSplitGetSubKSP - Gets the KSP contexts for all splits
16680971522cSBarry Smith 
166969a612a9SBarry Smith    Collective on KSP
16700971522cSBarry Smith 
16710971522cSBarry Smith    Input Parameter:
16720971522cSBarry Smith .  pc - the preconditioner context
16730971522cSBarry Smith 
16740971522cSBarry Smith    Output Parameters:
167513e0d083SBarry Smith +  n - the number of splits
167669a612a9SBarry Smith -  pc - the array of KSP contexts
16770971522cSBarry Smith 
16780971522cSBarry Smith    Note:
1679d32f9abdSBarry Smith    After PCFieldSplitGetSubKSP() the array of KSPs IS to be freed by the user
1680d32f9abdSBarry Smith    (not the KSP just the array that contains them).
16810971522cSBarry Smith 
168269a612a9SBarry Smith    You must call KSPSetUp() before calling PCFieldSplitGetSubKSP().
16830971522cSBarry Smith 
1684196cc216SBarry Smith    Fortran Usage: You must pass in a KSP array that is large enough to contain all the local KSPs.
16850298fd71SBarry Smith       You can call PCFieldSplitGetSubKSP(pc,n,NULL_OBJECT,ierr) to determine how large the
1686196cc216SBarry Smith       KSP array must be.
1687196cc216SBarry Smith 
1688196cc216SBarry Smith 
16890971522cSBarry Smith    Level: advanced
16900971522cSBarry Smith 
16910971522cSBarry Smith .seealso: PCFIELDSPLIT
16920971522cSBarry Smith @*/
16937087cfbeSBarry Smith PetscErrorCode  PCFieldSplitGetSubKSP(PC pc,PetscInt *n,KSP *subksp[])
16940971522cSBarry Smith {
16954ac538c5SBarry Smith   PetscErrorCode ierr;
16960971522cSBarry Smith 
16970971522cSBarry Smith   PetscFunctionBegin;
16980700a824SBarry Smith   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
169913e0d083SBarry Smith   if (n) PetscValidIntPointer(n,2);
17004ac538c5SBarry Smith   ierr = PetscUseMethod(pc,"PCFieldSplitGetSubKSP_C",(PC,PetscInt*,KSP **),(pc,n,subksp));CHKERRQ(ierr);
17010971522cSBarry Smith   PetscFunctionReturn(0);
17020971522cSBarry Smith }
17030971522cSBarry Smith 
1704e69d4d44SBarry Smith #undef __FUNCT__
170529f8a81cSJed Brown #define __FUNCT__ "PCFieldSplitSetSchurPre"
1706e69d4d44SBarry Smith /*@
170729f8a81cSJed Brown     PCFieldSplitSetSchurPre -  Indicates if the Schur complement is preconditioned by a preconditioner constructed by the
1708a04f6461SBarry Smith       A11 matrix. Otherwise no preconditioner is used.
1709e69d4d44SBarry Smith 
1710e69d4d44SBarry Smith     Collective on PC
1711e69d4d44SBarry Smith 
1712e69d4d44SBarry Smith     Input Parameters:
1713e69d4d44SBarry Smith +   pc      - the preconditioner context
1714a7476a74SDmitry 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
17150298fd71SBarry Smith -   userpre - matrix to use for preconditioning, or NULL
1716084e4875SJed Brown 
1717e69d4d44SBarry Smith     Options Database:
17182e71c61dSMatthew G. Knepley .     -pc_fieldsplit_schur_precondition <self,selfp,user,a11,full> default is a11
1719e69d4d44SBarry Smith 
1720fd1303e9SJungho Lee     Notes:
1721fd1303e9SJungho Lee $    If ptype is
1722a6a584a2SBarry Smith $        user then the preconditioner for the Schur complement is generated from the user provided matrix (pre argument
1723fd1303e9SJungho Lee $             to this function).
1724a6a584a2SBarry Smith $        a11 then the preconditioner for the Schur complement is generated from the block diagonal part of the preconditioner
1725585af1b9SMatthew G. Knepley $             matrix associated with the Schur complement (i.e. A11), not he Schur complement matrix
1726a6a584a2SBarry Smith $        full then the preconditioner for the Schur complement is generated from the exact Schur complement matrix representation computed internally by PFIELDSPLIT (this is expensive)
1727a6a584a2SBarry Smith $        self the preconditioner for the Schur complement is generated from the symbolic representation of the Schur complement matrix:
1728a6a584a2SBarry Smith $             The only preconditioner that currently works with this symbolic respresentation matrix object is the PCLSC
1729fd1303e9SJungho Lee $             preconditioner
1730a6a584a2SBarry Smith $        selfp then the preconditioning for the Schur complement is generated from an explicitly-assembled approximation Sp = A11 - A10 inv(diag(A00)) A01
17311d71051fSDmitry Karpeev $             This is only a good preconditioner when diag(A00) is a good preconditioner for A00. Optionally, A00 can be
1732a6a584a2SBarry Smith $             lumped before extracting the diagonal: -fieldsplit_1_mat_schur_complement_ainv_type lump
1733fd1303e9SJungho Lee 
1734e87fab1bSBarry Smith      When solving a saddle point problem, where the A11 block is identically zero, using a11 as the ptype only makes sense
1735fd1303e9SJungho Lee     with the additional option -fieldsplit_1_pc_type none. Usually for saddle point problems one would use a ptype of self and
1736a7476a74SDmitry Karpeev     -fieldsplit_1_pc_type lsc which uses the least squares commutator to compute a preconditioner for the Schur complement.
1737fd1303e9SJungho Lee 
1738e69d4d44SBarry Smith     Level: intermediate
1739e69d4d44SBarry Smith 
17401d71051fSDmitry Karpeev .seealso: PCFieldSplitGetSchurPre(), PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitSetFields(), PCFieldSplitSchurPreType,
17411d71051fSDmitry Karpeev           MatSchurComplementSetAinvType(), PCLSC
1742e69d4d44SBarry Smith 
1743e69d4d44SBarry Smith @*/
174429f8a81cSJed Brown PetscErrorCode PCFieldSplitSetSchurPre(PC pc,PCFieldSplitSchurPreType ptype,Mat pre)
1745e69d4d44SBarry Smith {
17464ac538c5SBarry Smith   PetscErrorCode ierr;
1747e69d4d44SBarry Smith 
1748e69d4d44SBarry Smith   PetscFunctionBegin;
17490700a824SBarry Smith   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
175029f8a81cSJed Brown   ierr = PetscTryMethod(pc,"PCFieldSplitSetSchurPre_C",(PC,PCFieldSplitSchurPreType,Mat),(pc,ptype,pre));CHKERRQ(ierr);
1751e69d4d44SBarry Smith   PetscFunctionReturn(0);
1752e69d4d44SBarry Smith }
175329f8a81cSJed Brown PetscErrorCode PCFieldSplitSchurPrecondition(PC pc,PCFieldSplitSchurPreType ptype,Mat pre) {return PCFieldSplitSetSchurPre(pc,ptype,pre);} /* Deprecated name */
1754e69d4d44SBarry Smith 
1755e69d4d44SBarry Smith #undef __FUNCT__
175637a82bf0SJed Brown #define __FUNCT__ "PCFieldSplitGetSchurPre"
175737a82bf0SJed Brown /*@
175837a82bf0SJed Brown     PCFieldSplitGetSchurPre - For Schur complement fieldsplit, determine how the Schur complement will be
175929f8a81cSJed Brown     preconditioned.  See PCFieldSplitSetSchurPre() for details.
176037a82bf0SJed Brown 
176137a82bf0SJed Brown     Logically Collective on PC
176237a82bf0SJed Brown 
176337a82bf0SJed Brown     Input Parameters:
176437a82bf0SJed Brown .   pc      - the preconditioner context
176537a82bf0SJed Brown 
176637a82bf0SJed Brown     Output Parameters:
176737a82bf0SJed 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
176837a82bf0SJed Brown -   userpre - matrix to use for preconditioning (with PC_FIELDSPLIT_PRE_USER), or NULL
176937a82bf0SJed Brown 
177037a82bf0SJed Brown     Level: intermediate
177137a82bf0SJed Brown 
177229f8a81cSJed Brown .seealso: PCFieldSplitSetSchurPre(), PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitSetFields(), PCFieldSplitSchurPreType, PCLSC
177337a82bf0SJed Brown 
177437a82bf0SJed Brown @*/
177537a82bf0SJed Brown PetscErrorCode PCFieldSplitGetSchurPre(PC pc,PCFieldSplitSchurPreType *ptype,Mat *pre)
177637a82bf0SJed Brown {
177737a82bf0SJed Brown   PetscErrorCode ierr;
177837a82bf0SJed Brown 
177937a82bf0SJed Brown   PetscFunctionBegin;
178037a82bf0SJed Brown   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
178137a82bf0SJed Brown   ierr = PetscUseMethod(pc,"PCFieldSplitGetSchurPre_C",(PC,PCFieldSplitSchurPreType*,Mat*),(pc,ptype,pre));CHKERRQ(ierr);
1782e69d4d44SBarry Smith   PetscFunctionReturn(0);
1783e69d4d44SBarry Smith }
1784e69d4d44SBarry Smith 
1785e69d4d44SBarry Smith #undef __FUNCT__
1786470b340bSDmitry Karpeev #define __FUNCT__ "PCFieldSplitSchurGetS"
178745e7fc46SDmitry Karpeev /*@
1788470b340bSDmitry Karpeev     PCFieldSplitSchurGetS -  extract the MatSchurComplement object used by this PC in case it needs to be configured separately
178945e7fc46SDmitry Karpeev 
179045e7fc46SDmitry Karpeev     Not collective
179145e7fc46SDmitry Karpeev 
179245e7fc46SDmitry Karpeev     Input Parameter:
179345e7fc46SDmitry Karpeev .   pc      - the preconditioner context
179445e7fc46SDmitry Karpeev 
179545e7fc46SDmitry Karpeev     Output Parameter:
1796470b340bSDmitry Karpeev .   S       - the Schur complement matrix
179745e7fc46SDmitry Karpeev 
1798470b340bSDmitry Karpeev     Notes:
1799470b340bSDmitry Karpeev     This matrix should not be destroyed using MatDestroy(); rather, use PCFieldSplitSchurRestoreS().
180045e7fc46SDmitry Karpeev 
180145e7fc46SDmitry Karpeev     Level: advanced
180245e7fc46SDmitry Karpeev 
180329f8a81cSJed Brown .seealso: PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitSchurPreType, PCFieldSplitSetSchurPre(), MatSchurComplement, PCFieldSplitSchurRestoreS()
180445e7fc46SDmitry Karpeev 
180545e7fc46SDmitry Karpeev @*/
1806470b340bSDmitry Karpeev PetscErrorCode  PCFieldSplitSchurGetS(PC pc,Mat *S)
180745e7fc46SDmitry Karpeev {
180845e7fc46SDmitry Karpeev   PetscErrorCode ierr;
180945e7fc46SDmitry Karpeev   const char*    t;
181045e7fc46SDmitry Karpeev   PetscBool      isfs;
181145e7fc46SDmitry Karpeev   PC_FieldSplit  *jac;
181245e7fc46SDmitry Karpeev 
181345e7fc46SDmitry Karpeev   PetscFunctionBegin;
181445e7fc46SDmitry Karpeev   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
181545e7fc46SDmitry Karpeev   ierr = PetscObjectGetType((PetscObject)pc,&t);CHKERRQ(ierr);
181645e7fc46SDmitry Karpeev   ierr = PetscStrcmp(t,PCFIELDSPLIT,&isfs);CHKERRQ(ierr);
181745e7fc46SDmitry Karpeev   if (!isfs) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Expected PC of type PCFIELDSPLIT, got %s instead",t);
181845e7fc46SDmitry Karpeev   jac = (PC_FieldSplit*)pc->data;
1819470b340bSDmitry 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);
1820470b340bSDmitry Karpeev   if (S) *S = jac->schur;
182145e7fc46SDmitry Karpeev   PetscFunctionReturn(0);
182245e7fc46SDmitry Karpeev }
182345e7fc46SDmitry Karpeev 
182445e7fc46SDmitry Karpeev #undef __FUNCT__
1825470b340bSDmitry Karpeev #define __FUNCT__ "PCFieldSplitSchurRestoreS"
1826470b340bSDmitry Karpeev /*@
1827470b340bSDmitry Karpeev     PCFieldSplitSchurRestoreS -  restores the MatSchurComplement object used by this PC
1828470b340bSDmitry Karpeev 
1829470b340bSDmitry Karpeev     Not collective
1830470b340bSDmitry Karpeev 
1831470b340bSDmitry Karpeev     Input Parameters:
1832470b340bSDmitry Karpeev +   pc      - the preconditioner context
1833470b340bSDmitry Karpeev .   S       - the Schur complement matrix
1834470b340bSDmitry Karpeev 
1835470b340bSDmitry Karpeev     Level: advanced
1836470b340bSDmitry Karpeev 
183729f8a81cSJed Brown .seealso: PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitSchurPreType, PCFieldSplitSetSchurPre(), MatSchurComplement, PCFieldSplitSchurGetS()
1838470b340bSDmitry Karpeev 
1839470b340bSDmitry Karpeev @*/
1840bca69d2bSDmitry Karpeev PetscErrorCode  PCFieldSplitSchurRestoreS(PC pc,Mat *S)
1841470b340bSDmitry Karpeev {
1842470b340bSDmitry Karpeev   PetscErrorCode ierr;
1843470b340bSDmitry Karpeev   const char*    t;
1844470b340bSDmitry Karpeev   PetscBool      isfs;
1845470b340bSDmitry Karpeev   PC_FieldSplit  *jac;
1846470b340bSDmitry Karpeev 
1847470b340bSDmitry Karpeev   PetscFunctionBegin;
1848470b340bSDmitry Karpeev   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
1849470b340bSDmitry Karpeev   ierr = PetscObjectGetType((PetscObject)pc,&t);CHKERRQ(ierr);
1850470b340bSDmitry Karpeev   ierr = PetscStrcmp(t,PCFIELDSPLIT,&isfs);CHKERRQ(ierr);
1851470b340bSDmitry Karpeev   if (!isfs) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Expected PC of type PCFIELDSPLIT, got %s instead",t);
1852470b340bSDmitry Karpeev   jac = (PC_FieldSplit*)pc->data;
1853470b340bSDmitry 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);
1854bca69d2bSDmitry Karpeev   if (!S || *S != jac->schur) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"MatSchurComplement restored is not the same as gotten");
1855470b340bSDmitry Karpeev   PetscFunctionReturn(0);
1856470b340bSDmitry Karpeev }
1857470b340bSDmitry Karpeev 
1858470b340bSDmitry Karpeev 
1859470b340bSDmitry Karpeev #undef __FUNCT__
186029f8a81cSJed Brown #define __FUNCT__ "PCFieldSplitSetSchurPre_FieldSplit"
186129f8a81cSJed Brown static PetscErrorCode  PCFieldSplitSetSchurPre_FieldSplit(PC pc,PCFieldSplitSchurPreType ptype,Mat pre)
1862e69d4d44SBarry Smith {
1863e69d4d44SBarry Smith   PC_FieldSplit  *jac = (PC_FieldSplit*)pc->data;
1864084e4875SJed Brown   PetscErrorCode ierr;
1865e69d4d44SBarry Smith 
1866e69d4d44SBarry Smith   PetscFunctionBegin;
1867084e4875SJed Brown   jac->schurpre = ptype;
1868a7476a74SDmitry Karpeev   if (ptype == PC_FIELDSPLIT_SCHUR_PRE_USER && pre) {
18696bf464f9SBarry Smith     ierr            = MatDestroy(&jac->schur_user);CHKERRQ(ierr);
1870084e4875SJed Brown     jac->schur_user = pre;
1871084e4875SJed Brown     ierr            = PetscObjectReference((PetscObject)jac->schur_user);CHKERRQ(ierr);
1872084e4875SJed Brown   }
1873e69d4d44SBarry Smith   PetscFunctionReturn(0);
1874e69d4d44SBarry Smith }
1875e69d4d44SBarry Smith 
187630ad9308SMatthew Knepley #undef __FUNCT__
187737a82bf0SJed Brown #define __FUNCT__ "PCFieldSplitGetSchurPre_FieldSplit"
187837a82bf0SJed Brown static PetscErrorCode  PCFieldSplitGetSchurPre_FieldSplit(PC pc,PCFieldSplitSchurPreType *ptype,Mat *pre)
187937a82bf0SJed Brown {
188037a82bf0SJed Brown   PC_FieldSplit  *jac = (PC_FieldSplit*)pc->data;
188137a82bf0SJed Brown 
188237a82bf0SJed Brown   PetscFunctionBegin;
188337a82bf0SJed Brown   *ptype = jac->schurpre;
188437a82bf0SJed Brown   *pre   = jac->schur_user;
188537a82bf0SJed Brown   PetscFunctionReturn(0);
188637a82bf0SJed Brown }
188737a82bf0SJed Brown 
188837a82bf0SJed Brown #undef __FUNCT__
1889c9c6ffaaSJed Brown #define __FUNCT__ "PCFieldSplitSetSchurFactType"
1890ab1df9f5SJed Brown /*@
1891c9c6ffaaSJed Brown     PCFieldSplitSetSchurFactType -  sets which blocks of the approximate block factorization to retain
1892ab1df9f5SJed Brown 
1893ab1df9f5SJed Brown     Collective on PC
1894ab1df9f5SJed Brown 
1895ab1df9f5SJed Brown     Input Parameters:
1896ab1df9f5SJed Brown +   pc  - the preconditioner context
1897c9c6ffaaSJed Brown -   ftype - which blocks of factorization to retain, PC_FIELDSPLIT_SCHUR_FACT_FULL is default
1898ab1df9f5SJed Brown 
1899ab1df9f5SJed Brown     Options Database:
1900c9c6ffaaSJed Brown .     -pc_fieldsplit_schur_fact_type <diag,lower,upper,full> default is full
1901ab1df9f5SJed Brown 
1902ab1df9f5SJed Brown 
1903ab1df9f5SJed Brown     Level: intermediate
1904ab1df9f5SJed Brown 
1905ab1df9f5SJed Brown     Notes:
1906ab1df9f5SJed Brown     The FULL factorization is
1907ab1df9f5SJed Brown 
1908ab1df9f5SJed Brown $   (A   B)  = (1       0) (A   0) (1  Ainv*B)
1909ab1df9f5SJed Brown $   (C   D)    (C*Ainv  1) (0   S) (0     1  )
1910ab1df9f5SJed Brown 
19116be4592eSBarry 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,
19126be4592eSBarry 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).
1913ab1df9f5SJed Brown 
19146be4592eSBarry 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
19156be4592eSBarry 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
19166be4592eSBarry 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,
19176be4592eSBarry 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.
1918ab1df9f5SJed Brown 
19196be4592eSBarry 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
19206be4592eSBarry 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).
1921ab1df9f5SJed Brown 
1922ab1df9f5SJed Brown     References:
1923ab1df9f5SJed Brown     Murphy, Golub, and Wathen, A note on preconditioning indefinite linear systems, SIAM J. Sci. Comput., 21 (2000) pp. 1969-1972.
1924ab1df9f5SJed Brown 
1925ab1df9f5SJed Brown     Ipsen, A note on preconditioning nonsymmetric matrices, SIAM J. Sci. Comput., 23 (2001), pp. 1050-1051.
1926ab1df9f5SJed Brown 
1927ab1df9f5SJed Brown .seealso: PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitSetFields(), PCFieldSplitSchurPreType
1928ab1df9f5SJed Brown @*/
1929c9c6ffaaSJed Brown PetscErrorCode  PCFieldSplitSetSchurFactType(PC pc,PCFieldSplitSchurFactType ftype)
1930ab1df9f5SJed Brown {
1931ab1df9f5SJed Brown   PetscErrorCode ierr;
1932ab1df9f5SJed Brown 
1933ab1df9f5SJed Brown   PetscFunctionBegin;
1934ab1df9f5SJed Brown   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
1935c9c6ffaaSJed Brown   ierr = PetscTryMethod(pc,"PCFieldSplitSetSchurFactType_C",(PC,PCFieldSplitSchurFactType),(pc,ftype));CHKERRQ(ierr);
1936ab1df9f5SJed Brown   PetscFunctionReturn(0);
1937ab1df9f5SJed Brown }
1938ab1df9f5SJed Brown 
1939ab1df9f5SJed Brown #undef __FUNCT__
1940c9c6ffaaSJed Brown #define __FUNCT__ "PCFieldSplitSetSchurFactType_FieldSplit"
19411e6b0712SBarry Smith static PetscErrorCode PCFieldSplitSetSchurFactType_FieldSplit(PC pc,PCFieldSplitSchurFactType ftype)
1942ab1df9f5SJed Brown {
1943ab1df9f5SJed Brown   PC_FieldSplit *jac = (PC_FieldSplit*)pc->data;
1944ab1df9f5SJed Brown 
1945ab1df9f5SJed Brown   PetscFunctionBegin;
1946ab1df9f5SJed Brown   jac->schurfactorization = ftype;
1947ab1df9f5SJed Brown   PetscFunctionReturn(0);
1948ab1df9f5SJed Brown }
1949ab1df9f5SJed Brown 
1950ab1df9f5SJed Brown #undef __FUNCT__
195130ad9308SMatthew Knepley #define __FUNCT__ "PCFieldSplitGetSchurBlocks"
195230ad9308SMatthew Knepley /*@C
19538c03b21aSDmitry Karpeev    PCFieldSplitGetSchurBlocks - Gets all matrix blocks for the Schur complement
195430ad9308SMatthew Knepley 
195530ad9308SMatthew Knepley    Collective on KSP
195630ad9308SMatthew Knepley 
195730ad9308SMatthew Knepley    Input Parameter:
195830ad9308SMatthew Knepley .  pc - the preconditioner context
195930ad9308SMatthew Knepley 
196030ad9308SMatthew Knepley    Output Parameters:
1961a04f6461SBarry Smith +  A00 - the (0,0) block
1962a04f6461SBarry Smith .  A01 - the (0,1) block
1963a04f6461SBarry Smith .  A10 - the (1,0) block
1964a04f6461SBarry Smith -  A11 - the (1,1) block
196530ad9308SMatthew Knepley 
196630ad9308SMatthew Knepley    Level: advanced
196730ad9308SMatthew Knepley 
196830ad9308SMatthew Knepley .seealso: PCFIELDSPLIT
196930ad9308SMatthew Knepley @*/
1970a04f6461SBarry Smith PetscErrorCode  PCFieldSplitGetSchurBlocks(PC pc,Mat *A00,Mat *A01,Mat *A10, Mat *A11)
197130ad9308SMatthew Knepley {
197230ad9308SMatthew Knepley   PC_FieldSplit *jac = (PC_FieldSplit*) pc->data;
197330ad9308SMatthew Knepley 
197430ad9308SMatthew Knepley   PetscFunctionBegin;
19750700a824SBarry Smith   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
1976ce94432eSBarry Smith   if (jac->type != PC_COMPOSITE_SCHUR) SETERRQ(PetscObjectComm((PetscObject)pc),PETSC_ERR_ARG_WRONG, "FieldSplit is not using a Schur complement approach.");
1977a04f6461SBarry Smith   if (A00) *A00 = jac->pmat[0];
1978a04f6461SBarry Smith   if (A01) *A01 = jac->B;
1979a04f6461SBarry Smith   if (A10) *A10 = jac->C;
1980a04f6461SBarry Smith   if (A11) *A11 = jac->pmat[1];
198130ad9308SMatthew Knepley   PetscFunctionReturn(0);
198230ad9308SMatthew Knepley }
198330ad9308SMatthew Knepley 
198479416396SBarry Smith #undef __FUNCT__
198579416396SBarry Smith #define __FUNCT__ "PCFieldSplitSetType_FieldSplit"
19861e6b0712SBarry Smith static PetscErrorCode  PCFieldSplitSetType_FieldSplit(PC pc,PCCompositeType type)
198779416396SBarry Smith {
198879416396SBarry Smith   PC_FieldSplit  *jac = (PC_FieldSplit*)pc->data;
1989e69d4d44SBarry Smith   PetscErrorCode ierr;
199079416396SBarry Smith 
199179416396SBarry Smith   PetscFunctionBegin;
199279416396SBarry Smith   jac->type = type;
19933b224e63SBarry Smith   if (type == PC_COMPOSITE_SCHUR) {
19943b224e63SBarry Smith     pc->ops->apply = PCApply_FieldSplit_Schur;
19953b224e63SBarry Smith     pc->ops->view  = PCView_FieldSplit_Schur;
19962fa5cd67SKarl Rupp 
1997bdf89e91SBarry Smith     ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitGetSubKSP_C",PCFieldSplitGetSubKSP_FieldSplit_Schur);CHKERRQ(ierr);
199829f8a81cSJed Brown     ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetSchurPre_C",PCFieldSplitSetSchurPre_FieldSplit);CHKERRQ(ierr);
199937a82bf0SJed Brown     ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitGetSchurPre_C",PCFieldSplitGetSchurPre_FieldSplit);CHKERRQ(ierr);
2000bdf89e91SBarry Smith     ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetSchurFactType_C",PCFieldSplitSetSchurFactType_FieldSplit);CHKERRQ(ierr);
2001e69d4d44SBarry Smith 
20023b224e63SBarry Smith   } else {
20033b224e63SBarry Smith     pc->ops->apply = PCApply_FieldSplit;
20043b224e63SBarry Smith     pc->ops->view  = PCView_FieldSplit;
20052fa5cd67SKarl Rupp 
2006bdf89e91SBarry Smith     ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitGetSubKSP_C",PCFieldSplitGetSubKSP_FieldSplit);CHKERRQ(ierr);
200729f8a81cSJed Brown     ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetSchurPre_C",0);CHKERRQ(ierr);
200837a82bf0SJed Brown     ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitGetSchurPre_C",0);CHKERRQ(ierr);
2009bdf89e91SBarry Smith     ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetSchurFactType_C",0);CHKERRQ(ierr);
20103b224e63SBarry Smith   }
201179416396SBarry Smith   PetscFunctionReturn(0);
201279416396SBarry Smith }
201379416396SBarry Smith 
201451f519a2SBarry Smith #undef __FUNCT__
201551f519a2SBarry Smith #define __FUNCT__ "PCFieldSplitSetBlockSize_FieldSplit"
20161e6b0712SBarry Smith static PetscErrorCode  PCFieldSplitSetBlockSize_FieldSplit(PC pc,PetscInt bs)
201751f519a2SBarry Smith {
201851f519a2SBarry Smith   PC_FieldSplit *jac = (PC_FieldSplit*)pc->data;
201951f519a2SBarry Smith 
202051f519a2SBarry Smith   PetscFunctionBegin;
2021ce94432eSBarry Smith   if (bs < 1) SETERRQ1(PetscObjectComm((PetscObject)pc),PETSC_ERR_ARG_OUTOFRANGE,"Blocksize must be positive, you gave %D",bs);
2022ce94432eSBarry 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);
202351f519a2SBarry Smith   jac->bs = bs;
202451f519a2SBarry Smith   PetscFunctionReturn(0);
202551f519a2SBarry Smith }
202651f519a2SBarry Smith 
202779416396SBarry Smith #undef __FUNCT__
202879416396SBarry Smith #define __FUNCT__ "PCFieldSplitSetType"
2029bc08b0f1SBarry Smith /*@
203079416396SBarry Smith    PCFieldSplitSetType - Sets the type of fieldsplit preconditioner.
203179416396SBarry Smith 
203279416396SBarry Smith    Collective on PC
203379416396SBarry Smith 
203479416396SBarry Smith    Input Parameter:
203579416396SBarry Smith .  pc - the preconditioner context
203681540f2fSBarry Smith .  type - PC_COMPOSITE_ADDITIVE, PC_COMPOSITE_MULTIPLICATIVE (default), PC_COMPOSITE_SYMMETRIC_MULTIPLICATIVE, PC_COMPOSITE_SPECIAL, PC_COMPOSITE_SCHUR
203779416396SBarry Smith 
203879416396SBarry Smith    Options Database Key:
2039a4efd8eaSMatthew Knepley .  -pc_fieldsplit_type <type: one of multiplicative, additive, symmetric_multiplicative, special, schur> - Sets fieldsplit preconditioner type
204079416396SBarry Smith 
2041b02e2d75SMatthew G Knepley    Level: Intermediate
204279416396SBarry Smith 
204379416396SBarry Smith .keywords: PC, set, type, composite preconditioner, additive, multiplicative
204479416396SBarry Smith 
204579416396SBarry Smith .seealso: PCCompositeSetType()
204679416396SBarry Smith 
204779416396SBarry Smith @*/
20487087cfbeSBarry Smith PetscErrorCode  PCFieldSplitSetType(PC pc,PCCompositeType type)
204979416396SBarry Smith {
20504ac538c5SBarry Smith   PetscErrorCode ierr;
205179416396SBarry Smith 
205279416396SBarry Smith   PetscFunctionBegin;
20530700a824SBarry Smith   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
20544ac538c5SBarry Smith   ierr = PetscTryMethod(pc,"PCFieldSplitSetType_C",(PC,PCCompositeType),(pc,type));CHKERRQ(ierr);
205579416396SBarry Smith   PetscFunctionReturn(0);
205679416396SBarry Smith }
205779416396SBarry Smith 
2058b02e2d75SMatthew G Knepley #undef __FUNCT__
2059b02e2d75SMatthew G Knepley #define __FUNCT__ "PCFieldSplitGetType"
2060b02e2d75SMatthew G Knepley /*@
2061b02e2d75SMatthew G Knepley   PCFieldSplitGetType - Gets the type of fieldsplit preconditioner.
2062b02e2d75SMatthew G Knepley 
2063b02e2d75SMatthew G Knepley   Not collective
2064b02e2d75SMatthew G Knepley 
2065b02e2d75SMatthew G Knepley   Input Parameter:
2066b02e2d75SMatthew G Knepley . pc - the preconditioner context
2067b02e2d75SMatthew G Knepley 
2068b02e2d75SMatthew G Knepley   Output Parameter:
2069b02e2d75SMatthew G Knepley . type - PC_COMPOSITE_ADDITIVE, PC_COMPOSITE_MULTIPLICATIVE (default), PC_COMPOSITE_SYMMETRIC_MULTIPLICATIVE, PC_COMPOSITE_SPECIAL, PC_COMPOSITE_SCHUR
2070b02e2d75SMatthew G Knepley 
2071b02e2d75SMatthew G Knepley   Level: Intermediate
2072b02e2d75SMatthew G Knepley 
2073b02e2d75SMatthew G Knepley .keywords: PC, set, type, composite preconditioner, additive, multiplicative
2074b02e2d75SMatthew G Knepley .seealso: PCCompositeSetType()
2075b02e2d75SMatthew G Knepley @*/
2076b02e2d75SMatthew G Knepley PetscErrorCode PCFieldSplitGetType(PC pc, PCCompositeType *type)
2077b02e2d75SMatthew G Knepley {
2078b02e2d75SMatthew G Knepley   PC_FieldSplit *jac = (PC_FieldSplit*) pc->data;
2079b02e2d75SMatthew G Knepley 
2080b02e2d75SMatthew G Knepley   PetscFunctionBegin;
2081b02e2d75SMatthew G Knepley   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
2082b02e2d75SMatthew G Knepley   PetscValidIntPointer(type,2);
2083b02e2d75SMatthew G Knepley   *type = jac->type;
2084b02e2d75SMatthew G Knepley   PetscFunctionReturn(0);
2085b02e2d75SMatthew G Knepley }
2086b02e2d75SMatthew G Knepley 
20874ab8060aSDmitry Karpeev #undef __FUNCT__
20884ab8060aSDmitry Karpeev #define __FUNCT__ "PCFieldSplitSetDMSplits"
20894ab8060aSDmitry Karpeev /*@
20904ab8060aSDmitry Karpeev    PCFieldSplitSetDMSplits - Flags whether DMCreateFieldDecomposition() should be used to define the splits, whenever possible.
20914ab8060aSDmitry Karpeev 
20924ab8060aSDmitry Karpeev    Logically Collective
20934ab8060aSDmitry Karpeev 
20944ab8060aSDmitry Karpeev    Input Parameters:
20954ab8060aSDmitry Karpeev +  pc   - the preconditioner context
20964ab8060aSDmitry Karpeev -  flg  - boolean indicating whether to use field splits defined by the DM
20974ab8060aSDmitry Karpeev 
20984ab8060aSDmitry Karpeev    Options Database Key:
20994ab8060aSDmitry Karpeev .  -pc_fieldsplit_dm_splits
21004ab8060aSDmitry Karpeev 
21014ab8060aSDmitry Karpeev    Level: Intermediate
21024ab8060aSDmitry Karpeev 
21034ab8060aSDmitry Karpeev .keywords: PC, DM, composite preconditioner, additive, multiplicative
21044ab8060aSDmitry Karpeev 
21054ab8060aSDmitry Karpeev .seealso: PCFieldSplitGetDMSplits()
21064ab8060aSDmitry Karpeev 
21074ab8060aSDmitry Karpeev @*/
21084ab8060aSDmitry Karpeev PetscErrorCode  PCFieldSplitSetDMSplits(PC pc,PetscBool flg)
21094ab8060aSDmitry Karpeev {
21104ab8060aSDmitry Karpeev   PC_FieldSplit  *jac = (PC_FieldSplit*)pc->data;
21114ab8060aSDmitry Karpeev   PetscBool      isfs;
21124ab8060aSDmitry Karpeev   PetscErrorCode ierr;
21134ab8060aSDmitry Karpeev 
21144ab8060aSDmitry Karpeev   PetscFunctionBegin;
21154ab8060aSDmitry Karpeev   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
21164ab8060aSDmitry Karpeev   PetscValidLogicalCollectiveBool(pc,flg,2);
21174ab8060aSDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)pc,PCFIELDSPLIT,&isfs);CHKERRQ(ierr);
21184ab8060aSDmitry Karpeev   if (isfs) {
21194ab8060aSDmitry Karpeev     jac->dm_splits = flg;
21204ab8060aSDmitry Karpeev   }
21214ab8060aSDmitry Karpeev   PetscFunctionReturn(0);
21224ab8060aSDmitry Karpeev }
21234ab8060aSDmitry Karpeev 
21244ab8060aSDmitry Karpeev 
21254ab8060aSDmitry Karpeev #undef __FUNCT__
21264ab8060aSDmitry Karpeev #define __FUNCT__ "PCFieldSplitGetDMSplits"
21274ab8060aSDmitry Karpeev /*@
21284ab8060aSDmitry Karpeev    PCFieldSplitGetDMSplits - Returns flag indicating whether DMCreateFieldDecomposition() should be used to define the splits, whenever possible.
21294ab8060aSDmitry Karpeev 
21304ab8060aSDmitry Karpeev    Logically Collective
21314ab8060aSDmitry Karpeev 
21324ab8060aSDmitry Karpeev    Input Parameter:
21334ab8060aSDmitry Karpeev .  pc   - the preconditioner context
21344ab8060aSDmitry Karpeev 
21354ab8060aSDmitry Karpeev    Output Parameter:
21364ab8060aSDmitry Karpeev .  flg  - boolean indicating whether to use field splits defined by the DM
21374ab8060aSDmitry Karpeev 
21384ab8060aSDmitry Karpeev    Level: Intermediate
21394ab8060aSDmitry Karpeev 
21404ab8060aSDmitry Karpeev .keywords: PC, DM, composite preconditioner, additive, multiplicative
21414ab8060aSDmitry Karpeev 
21424ab8060aSDmitry Karpeev .seealso: PCFieldSplitSetDMSplits()
21434ab8060aSDmitry Karpeev 
21444ab8060aSDmitry Karpeev @*/
21454ab8060aSDmitry Karpeev PetscErrorCode  PCFieldSplitGetDMSplits(PC pc,PetscBool* flg)
21464ab8060aSDmitry Karpeev {
21474ab8060aSDmitry Karpeev   PC_FieldSplit  *jac = (PC_FieldSplit*)pc->data;
21484ab8060aSDmitry Karpeev   PetscBool      isfs;
21494ab8060aSDmitry Karpeev   PetscErrorCode ierr;
21504ab8060aSDmitry Karpeev 
21514ab8060aSDmitry Karpeev   PetscFunctionBegin;
21524ab8060aSDmitry Karpeev   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
21534ab8060aSDmitry Karpeev   PetscValidPointer(flg,2);
21544ab8060aSDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)pc,PCFIELDSPLIT,&isfs);CHKERRQ(ierr);
21554ab8060aSDmitry Karpeev   if (isfs) {
21564ab8060aSDmitry Karpeev     if(flg) *flg = jac->dm_splits;
21574ab8060aSDmitry Karpeev   }
21584ab8060aSDmitry Karpeev   PetscFunctionReturn(0);
21594ab8060aSDmitry Karpeev }
21604ab8060aSDmitry Karpeev 
21610971522cSBarry Smith /* -------------------------------------------------------------------------------------*/
21620971522cSBarry Smith /*MC
2163a8c7a070SBarry Smith    PCFIELDSPLIT - Preconditioner created by combining separate preconditioners for individual
2164a04f6461SBarry Smith                   fields or groups of fields. See the users manual section "Solving Block Matrices" for more details.
21650971522cSBarry Smith 
2166edf189efSBarry Smith      To set options on the solvers for each block append -fieldsplit_ to all the PC
2167edf189efSBarry Smith         options database keys. For example, -fieldsplit_pc_type ilu -fieldsplit_pc_factor_levels 1
21680971522cSBarry Smith 
2169a8c7a070SBarry Smith      To set the options on the solvers separate for each block call PCFieldSplitGetSubKSP()
217069a612a9SBarry Smith          and set the options directly on the resulting KSP object
21710971522cSBarry Smith 
21720971522cSBarry Smith    Level: intermediate
21730971522cSBarry Smith 
217479416396SBarry Smith    Options Database Keys:
217581540f2fSBarry Smith +   -pc_fieldsplit_%d_fields <a,b,..> - indicates the fields to be used in the %d'th split
217681540f2fSBarry Smith .   -pc_fieldsplit_default - automatically add any fields to additional splits that have not
217781540f2fSBarry Smith                               been supplied explicitly by -pc_fieldsplit_%d_fields
217881540f2fSBarry Smith .   -pc_fieldsplit_block_size <bs> - size of block that defines fields (i.e. there are bs fields)
21790f188ba9SJed Brown .   -pc_fieldsplit_type <additive,multiplicative,symmetric_multiplicative,schur> - type of relaxation or factorization splitting
2180a6a584a2SBarry Smith .   -pc_fieldsplit_schur_precondition <self,selfp,user,a11,full> - default is a11; see PCFieldSplitSetSchurPre()
2181435f959eSBarry Smith .   -pc_fieldsplit_detect_saddle_point - automatically finds rows with zero or negative diagonal and uses Schur complement with no preconditioner as the solver
218279416396SBarry Smith 
21835d4c12cdSJungho Lee -    Options prefix for inner solvers when using Schur complement preconditioner are -fieldsplit_0_ and -fieldsplit_1_
21845d4c12cdSJungho Lee      for all other solvers they are -fieldsplit_%d_ for the dth field, use -fieldsplit_ for all fields
21855d4c12cdSJungho Lee 
2186c8a0d604SMatthew G Knepley    Notes:
2187c8a0d604SMatthew G Knepley     Use PCFieldSplitSetFields() to set fields defined by "strided" entries and PCFieldSplitSetIS()
2188d32f9abdSBarry Smith      to define a field by an arbitrary collection of entries.
2189d32f9abdSBarry Smith 
2190d32f9abdSBarry Smith       If no fields are set the default is used. The fields are defined by entries strided by bs,
2191d32f9abdSBarry Smith       beginning at 0 then 1, etc to bs-1. The block size can be set with PCFieldSplitSetBlockSize(),
2192d32f9abdSBarry Smith       if this is not called the block size defaults to the blocksize of the second matrix passed
2193d32f9abdSBarry Smith       to KSPSetOperators()/PCSetOperators().
2194d32f9abdSBarry Smith 
2195c8a0d604SMatthew G Knepley $     For the Schur complement preconditioner if J = ( A00 A01 )
2196c8a0d604SMatthew G Knepley $                                                    ( A10 A11 )
2197c8a0d604SMatthew G Knepley $     the preconditioner using full factorization is
219813b05affSJed Brown $              ( I   -ksp(A00) A01 ) ( inv(A00)     0  ) (     I          0  )
2199c8a0d604SMatthew G Knepley $              ( 0         I       ) (   0      ksp(S) ) ( -A10 ksp(A00)  I  )
220013b05affSJed Brown      where the action of inv(A00) is applied using the KSP solver with prefix -fieldsplit_0_.  S is the Schur complement
220113b05affSJed Brown $              S = A11 - A10 ksp(A00) A01
220213b05affSJed 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
2203c8a0d604SMatthew G Knepley      in providing the SECOND split or 1 if not give). For PCFieldSplitGetKSP() when field number is 0,
2204c8a0d604SMatthew G Knepley      it returns the KSP associated with -fieldsplit_0_ while field number 1 gives -fieldsplit_1_ KSP. By default
2205a6a584a2SBarry Smith      A11 is used to construct a preconditioner for S, use PCFieldSplitSetSchurPre() for all the possible ways to construct the preconditioner for S.
22061d71051fSDmitry Karpeev 
2207a7476a74SDmitry Karpeev      The factorization type is set using -pc_fieldsplit_schur_fact_type <diag, lower, upper, full>. The full is shown above,
22085668aaf4SBarry Smith      diag gives
2209c8a0d604SMatthew G Knepley $              ( inv(A00)     0   )
2210c8a0d604SMatthew G Knepley $              (   0      -ksp(S) )
22115668aaf4SBarry 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
2212c8a0d604SMatthew G Knepley $              (  A00   0 )
2213c8a0d604SMatthew G Knepley $              (  A10   S )
2214c8a0d604SMatthew G Knepley      where the inverses of A00 and S are applied using KSPs. The upper factorization is the inverse of
2215c8a0d604SMatthew G Knepley $              ( A00 A01 )
2216c8a0d604SMatthew G Knepley $              (  0   S  )
2217c8a0d604SMatthew G Knepley      where again the inverses of A00 and S are applied using KSPs.
2218e69d4d44SBarry Smith 
2219edf189efSBarry Smith      If only one set of indices (one IS) is provided with PCFieldSplitSetIS() then the complement of that IS
2220edf189efSBarry Smith      is used automatically for a second block.
2221edf189efSBarry Smith 
2222ff218e97SBarry Smith      The fieldsplit preconditioner cannot currently be used with the BAIJ or SBAIJ data formats if the blocksize is larger than 1.
2223ff218e97SBarry Smith      Generally it should be used with the AIJ format.
2224ff218e97SBarry Smith 
2225ff218e97SBarry Smith      The forms of these preconditioners are closely related if not identical to forms derived as "Distributive Iterations", see,
2226ff218e97SBarry Smith      for example, page 294 in "Principles of Computational Fluid Dynamics" by Pieter Wesseling. Note that one can also use PCFIELDSPLIT
2227ff218e97SBarry Smith      inside a smoother resulting in "Distributive Smoothers".
22280716a85fSBarry Smith 
2229a541d17aSBarry Smith    Concepts: physics based preconditioners, block preconditioners
22300971522cSBarry Smith 
22313bc631e0SBarry Smith    There is a nice discussion of block preconditioners in
22323bc631e0SBarry Smith 
22333bc631e0SBarry Smith [El08] A taxonomy and comparison of parallel block multi-level preconditioners for the incompressible Navier-Stokes equations
22343bc631e0SBarry Smith        Howard Elman, V.E. Howle, John Shadid, Robert Shuttleworth, Ray Tuminaro, Journal of Computational Physics 227 (2008) 1790--1808
22353bc631e0SBarry Smith        http://chess.cs.umd.edu/~elman/papers/tax.pdf
22363bc631e0SBarry Smith 
2237a6a584a2SBarry Smith    The Constrained Pressure Preconditioner (CPR) does not appear to be currently implementable directly with PCFIELDSPLIT. CPR solves first the Schur complemented pressure equation, updates the
2238a6a584a2SBarry Smith    residual on all variables and then applies a simple ILU like preconditioner on all the variables. So it is very much like the full Schur complement with selfp representing the Schur complement but instead
2239a6a584a2SBarry Smith    of backsolving for the saturations in the last step it solves a full coupled (ILU) system for updates to all the variables.
2240a6a584a2SBarry Smith 
22417e8cb189SBarry Smith .seealso:  PCCreate(), PCSetType(), PCType (for list of available types), PC, Block_Preconditioners, PCLSC,
22421d71051fSDmitry Karpeev            PCFieldSplitGetSubKSP(), PCFieldSplitSetFields(), PCFieldSplitSetType(), PCFieldSplitSetIS(), PCFieldSplitSetSchurPre(),
22431d71051fSDmitry Karpeev 	   MatSchurComplementSetAinvType()
22440971522cSBarry Smith M*/
22450971522cSBarry Smith 
22460971522cSBarry Smith #undef __FUNCT__
22470971522cSBarry Smith #define __FUNCT__ "PCCreate_FieldSplit"
22488cc058d9SJed Brown PETSC_EXTERN PetscErrorCode PCCreate_FieldSplit(PC pc)
22490971522cSBarry Smith {
22500971522cSBarry Smith   PetscErrorCode ierr;
22510971522cSBarry Smith   PC_FieldSplit  *jac;
22520971522cSBarry Smith 
22530971522cSBarry Smith   PetscFunctionBegin;
2254b00a9115SJed Brown   ierr = PetscNewLog(pc,&jac);CHKERRQ(ierr);
22552fa5cd67SKarl Rupp 
22560971522cSBarry Smith   jac->bs                 = -1;
22570971522cSBarry Smith   jac->nsplits            = 0;
22583e197d65SBarry Smith   jac->type               = PC_COMPOSITE_MULTIPLICATIVE;
2259e6cab6aaSJed Brown   jac->schurpre           = PC_FIELDSPLIT_SCHUR_PRE_USER; /* Try user preconditioner first, fall back on diagonal */
2260c9c6ffaaSJed Brown   jac->schurfactorization = PC_FIELDSPLIT_SCHUR_FACT_FULL;
2261fbe7908bSJed Brown   jac->dm_splits          = PETSC_TRUE;
226251f519a2SBarry Smith 
22630971522cSBarry Smith   pc->data = (void*)jac;
22640971522cSBarry Smith 
22650971522cSBarry Smith   pc->ops->apply           = PCApply_FieldSplit;
2266421e10b8SBarry Smith   pc->ops->applytranspose  = PCApplyTranspose_FieldSplit;
22670971522cSBarry Smith   pc->ops->setup           = PCSetUp_FieldSplit;
2268574deadeSBarry Smith   pc->ops->reset           = PCReset_FieldSplit;
22690971522cSBarry Smith   pc->ops->destroy         = PCDestroy_FieldSplit;
22700971522cSBarry Smith   pc->ops->setfromoptions  = PCSetFromOptions_FieldSplit;
22710971522cSBarry Smith   pc->ops->view            = PCView_FieldSplit;
22720971522cSBarry Smith   pc->ops->applyrichardson = 0;
22730971522cSBarry Smith 
2274bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitGetSubKSP_C",PCFieldSplitGetSubKSP_FieldSplit);CHKERRQ(ierr);
2275bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetFields_C",PCFieldSplitSetFields_FieldSplit);CHKERRQ(ierr);
2276bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetIS_C",PCFieldSplitSetIS_FieldSplit);CHKERRQ(ierr);
2277bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetType_C",PCFieldSplitSetType_FieldSplit);CHKERRQ(ierr);
2278bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetBlockSize_C",PCFieldSplitSetBlockSize_FieldSplit);CHKERRQ(ierr);
22790971522cSBarry Smith   PetscFunctionReturn(0);
22800971522cSBarry Smith }
22810971522cSBarry Smith 
22820971522cSBarry Smith 
2283a541d17aSBarry Smith 
2284