xref: /petsc/src/ksp/pc/impls/fieldsplit/fieldsplit.c (revision 7b752e3de0b5f8523c4dec653dbf935e595837d1)
1dba47a55SKris Buschelman 
2f5f0d762SBarry Smith 
3af0996ceSBarry Smith #include <petsc/private/pcimpl.h>     /*I "petscpc.h" I*/
4a80b646eSBarry Smith #include <petsc/private/kspimpl.h>    /*  This is needed to provide the appropriate PETSC_EXTERN for KSP_Solve_FS ....*/
51e25c274SJed Brown #include <petscdm.h>
60971522cSBarry Smith 
72e71c61dSMatthew G. Knepley const char *const PCFieldSplitSchurPreTypes[] = {"SELF","SELFP","A11","USER","FULL","PCFieldSplitSchurPreType","PC_FIELDSPLIT_SCHUR_PRE_",0};
8c9c6ffaaSJed Brown const char *const PCFieldSplitSchurFactTypes[] = {"DIAG","LOWER","UPPER","FULL","PCFieldSplitSchurFactType","PC_FIELDSPLIT_SCHUR_FACT_",0};
9c5d2311dSJed Brown 
109df09d43SBarry Smith PetscLogEvent KSP_Solve_FS_0,KSP_Solve_FS_1,KSP_Solve_FS_S,KSP_Solve_FS_U,KSP_Solve_FS_L,KSP_Solve_FS_2,KSP_Solve_FS_3,KSP_Solve_FS_4;
119df09d43SBarry Smith 
120971522cSBarry Smith typedef struct _PC_FieldSplitLink *PC_FieldSplitLink;
130971522cSBarry Smith struct _PC_FieldSplitLink {
1469a612a9SBarry Smith   KSP               ksp;
15443836d0SMatthew G Knepley   Vec               x,y,z;
16db4c96c1SJed Brown   char              *splitname;
170971522cSBarry Smith   PetscInt          nfields;
185d4c12cdSJungho Lee   PetscInt          *fields,*fields_col;
191b9fc7fcSBarry Smith   VecScatter        sctx;
20f5f0d762SBarry Smith   IS                is,is_col;
2151f519a2SBarry Smith   PC_FieldSplitLink next,previous;
229df09d43SBarry Smith   PetscLogEvent     event;
230971522cSBarry Smith };
240971522cSBarry Smith 
250971522cSBarry Smith typedef struct {
2668dd23aaSBarry Smith   PCCompositeType type;
27ace3abfcSBarry Smith   PetscBool       defaultsplit;                    /* Flag for a system with a set of 'k' scalar fields with the same layout (and bs = k) */
28ace3abfcSBarry Smith   PetscBool       splitdefined;                    /* Flag is set after the splits have been defined, to prevent more splits from being added */
2930ad9308SMatthew Knepley   PetscInt        bs;                              /* Block size for IS and Mat structures */
3030ad9308SMatthew Knepley   PetscInt        nsplits;                         /* Number of field divisions defined */
3179416396SBarry Smith   Vec             *x,*y,w1,w2;
32519d70e2SJed Brown   Mat             *mat;                            /* The diagonal block for each split */
33519d70e2SJed Brown   Mat             *pmat;                           /* The preconditioning diagonal block for each split */
3430ad9308SMatthew Knepley   Mat             *Afield;                         /* The rows of the matrix associated with each split */
35ace3abfcSBarry Smith   PetscBool       issetup;
362fa5cd67SKarl Rupp 
3730ad9308SMatthew Knepley   /* Only used when Schur complement preconditioning is used */
3830ad9308SMatthew Knepley   Mat                       B;                     /* The (0,1) block */
3930ad9308SMatthew Knepley   Mat                       C;                     /* The (1,0) block */
40443836d0SMatthew G Knepley   Mat                       schur;                 /* The Schur complement S = A11 - A10 A00^{-1} A01, the KSP here, kspinner, is H_1 in [El08] */
41a7476a74SDmitry Karpeev   Mat                       schurp;                /* Assembled approximation to S built by MatSchurComplement to be used as a preconditioning matrix when solving with S */
42084e4875SJed Brown   Mat                       schur_user;            /* User-provided preconditioning matrix for the Schur complement */
43084e4875SJed Brown   PCFieldSplitSchurPreType  schurpre;              /* Determines which preconditioning matrix is used for the Schur complement */
44c9c6ffaaSJed Brown   PCFieldSplitSchurFactType schurfactorization;
4530ad9308SMatthew Knepley   KSP                       kspschur;              /* The solver for S */
46443836d0SMatthew G Knepley   KSP                       kspupper;              /* The solver for A in the upper diagonal part of the factorization (H_2 in [El08]) */
47c096484dSStefano Zampini   PetscScalar               schurscale;            /* Scaling factor for the Schur complement solution with DIAG factorization */
48c096484dSStefano Zampini 
4997bbdb24SBarry Smith   PC_FieldSplitLink         head;
506dbb499eSCian Wilson   PetscBool                 isrestrict;             /* indicates PCFieldSplitRestrictIS() has been last called on this object, hack */
51c1570756SJed Brown   PetscBool                 suboptionsset;          /* Indicates that the KSPSetFromOptions() has been called on the sub-KSPs */
524ab8060aSDmitry Karpeev   PetscBool                 dm_splits;              /* Whether to use DMCreateFieldDecomposition() whenever possible */
53c84da90fSDmitry Karpeev   PetscBool                 diag_use_amat;          /* Whether to extract diagonal matrix blocks from Amat, rather than Pmat (weaker than -pc_use_amat) */
54c84da90fSDmitry Karpeev   PetscBool                 offdiag_use_amat;       /* Whether to extract off-diagonal matrix blocks from Amat, rather than Pmat (weaker than -pc_use_amat) */
55*7b752e3dSPatrick Sanan   PetscBool                 detect;                 /* Whether to form 2-way split by finding zero diagonal entries */
560971522cSBarry Smith } PC_FieldSplit;
570971522cSBarry Smith 
5816913363SBarry Smith /*
5916913363SBarry Smith     Notes: there is no particular reason that pmat, x, and y are stored as arrays in PC_FieldSplit instead of
6016913363SBarry Smith    inside PC_FieldSplitLink, just historical. If you want to be able to add new fields after already using the
6116913363SBarry Smith    PC you could change this.
6216913363SBarry Smith */
63084e4875SJed Brown 
64e6cab6aaSJed Brown /* This helper is so that setting a user-provided preconditioning matrix is orthogonal to choosing to use it.  This way the
65084e4875SJed Brown * application-provided FormJacobian can provide this matrix without interfering with the user's (command-line) choices. */
66084e4875SJed Brown static Mat FieldSplitSchurPre(PC_FieldSplit *jac)
67084e4875SJed Brown {
68084e4875SJed Brown   switch (jac->schurpre) {
69084e4875SJed Brown   case PC_FIELDSPLIT_SCHUR_PRE_SELF: return jac->schur;
70a7476a74SDmitry Karpeev   case PC_FIELDSPLIT_SCHUR_PRE_SELFP: return jac->schurp;
71e87fab1bSBarry Smith   case PC_FIELDSPLIT_SCHUR_PRE_A11: return jac->pmat[1];
72e74569cdSMatthew G. Knepley   case PC_FIELDSPLIT_SCHUR_PRE_FULL: /* We calculate this and store it in schur_user */
73084e4875SJed Brown   case PC_FIELDSPLIT_SCHUR_PRE_USER: /* Use a user-provided matrix if it is given, otherwise diagonal block */
74084e4875SJed Brown   default:
75084e4875SJed Brown     return jac->schur_user ? jac->schur_user : jac->pmat[1];
76084e4875SJed Brown   }
77084e4875SJed Brown }
78084e4875SJed Brown 
79084e4875SJed Brown 
809804daf3SBarry Smith #include <petscdraw.h>
810971522cSBarry Smith static PetscErrorCode PCView_FieldSplit(PC pc,PetscViewer viewer)
820971522cSBarry Smith {
830971522cSBarry Smith   PC_FieldSplit     *jac = (PC_FieldSplit*)pc->data;
840971522cSBarry Smith   PetscErrorCode    ierr;
85d9884438SBarry Smith   PetscBool         iascii,isdraw;
860971522cSBarry Smith   PetscInt          i,j;
875a9f2f41SSatish Balay   PC_FieldSplitLink ilink = jac->head;
880971522cSBarry Smith 
890971522cSBarry Smith   PetscFunctionBegin;
90251f4c67SDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&iascii);CHKERRQ(ierr);
91d9884438SBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERDRAW,&isdraw);CHKERRQ(ierr);
920971522cSBarry Smith   if (iascii) {
932c9966d7SBarry Smith     if (jac->bs > 0) {
9451f519a2SBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"  FieldSplit with %s composition: total splits = %D, blocksize = %D\n",PCCompositeTypes[jac->type],jac->nsplits,jac->bs);CHKERRQ(ierr);
952c9966d7SBarry Smith     } else {
962c9966d7SBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"  FieldSplit with %s composition: total splits = %D\n",PCCompositeTypes[jac->type],jac->nsplits);CHKERRQ(ierr);
972c9966d7SBarry Smith     }
98f5236f50SJed Brown     if (pc->useAmat) {
99f5236f50SJed Brown       ierr = PetscViewerASCIIPrintf(viewer,"  using Amat (not Pmat) as operator for blocks\n");CHKERRQ(ierr);
100a3df900dSMatthew G Knepley     }
101c84da90fSDmitry Karpeev     if (jac->diag_use_amat) {
102c84da90fSDmitry Karpeev       ierr = PetscViewerASCIIPrintf(viewer,"  using Amat (not Pmat) as operator for diagonal blocks\n");CHKERRQ(ierr);
103c84da90fSDmitry Karpeev     }
104c84da90fSDmitry Karpeev     if (jac->offdiag_use_amat) {
105c84da90fSDmitry Karpeev       ierr = PetscViewerASCIIPrintf(viewer,"  using Amat (not Pmat) as operator for off-diagonal blocks\n");CHKERRQ(ierr);
106c84da90fSDmitry Karpeev     }
10769a612a9SBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"  Solver info for each split is in the following KSP objects:\n");CHKERRQ(ierr);
1080971522cSBarry Smith     ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
1090971522cSBarry Smith     for (i=0; i<jac->nsplits; i++) {
1101ab39975SBarry Smith       if (ilink->fields) {
1110971522cSBarry Smith         ierr = PetscViewerASCIIPrintf(viewer,"Split number %D Fields ",i);CHKERRQ(ierr);
11279416396SBarry Smith         ierr = PetscViewerASCIIUseTabs(viewer,PETSC_FALSE);CHKERRQ(ierr);
1135a9f2f41SSatish Balay         for (j=0; j<ilink->nfields; j++) {
11479416396SBarry Smith           if (j > 0) {
11579416396SBarry Smith             ierr = PetscViewerASCIIPrintf(viewer,",");CHKERRQ(ierr);
11679416396SBarry Smith           }
1175a9f2f41SSatish Balay           ierr = PetscViewerASCIIPrintf(viewer," %D",ilink->fields[j]);CHKERRQ(ierr);
1180971522cSBarry Smith         }
1190971522cSBarry Smith         ierr = PetscViewerASCIIPrintf(viewer,"\n");CHKERRQ(ierr);
12079416396SBarry Smith         ierr = PetscViewerASCIIUseTabs(viewer,PETSC_TRUE);CHKERRQ(ierr);
1211ab39975SBarry Smith       } else {
1221ab39975SBarry Smith         ierr = PetscViewerASCIIPrintf(viewer,"Split number %D Defined by IS\n",i);CHKERRQ(ierr);
1231ab39975SBarry Smith       }
1245a9f2f41SSatish Balay       ierr  = KSPView(ilink->ksp,viewer);CHKERRQ(ierr);
1255a9f2f41SSatish Balay       ilink = ilink->next;
1260971522cSBarry Smith     }
1270971522cSBarry Smith     ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
1282fa5cd67SKarl Rupp   }
1292fa5cd67SKarl Rupp 
1302fa5cd67SKarl Rupp  if (isdraw) {
131d9884438SBarry Smith     PetscDraw draw;
132d9884438SBarry Smith     PetscReal x,y,w,wd;
133d9884438SBarry Smith 
134d9884438SBarry Smith     ierr = PetscViewerDrawGetDraw(viewer,0,&draw);CHKERRQ(ierr);
135d9884438SBarry Smith     ierr = PetscDrawGetCurrentPoint(draw,&x,&y);CHKERRQ(ierr);
136d9884438SBarry Smith     w    = 2*PetscMin(1.0 - x,x);
137d9884438SBarry Smith     wd   = w/(jac->nsplits + 1);
138d9884438SBarry Smith     x    = x - wd*(jac->nsplits-1)/2.0;
139d9884438SBarry Smith     for (i=0; i<jac->nsplits; i++) {
140d9884438SBarry Smith       ierr  = PetscDrawPushCurrentPoint(draw,x,y);CHKERRQ(ierr);
141d9884438SBarry Smith       ierr  = KSPView(ilink->ksp,viewer);CHKERRQ(ierr);
142d9884438SBarry Smith       ierr  = PetscDrawPopCurrentPoint(draw);CHKERRQ(ierr);
143d9884438SBarry Smith       x    += wd;
144d9884438SBarry Smith       ilink = ilink->next;
145d9884438SBarry Smith     }
1460971522cSBarry Smith   }
1470971522cSBarry Smith   PetscFunctionReturn(0);
1480971522cSBarry Smith }
1490971522cSBarry Smith 
1503b224e63SBarry Smith static PetscErrorCode PCView_FieldSplit_Schur(PC pc,PetscViewer viewer)
1513b224e63SBarry Smith {
1523b224e63SBarry Smith   PC_FieldSplit              *jac = (PC_FieldSplit*)pc->data;
1533b224e63SBarry Smith   PetscErrorCode             ierr;
1544996c5bdSBarry Smith   PetscBool                  iascii,isdraw;
1553b224e63SBarry Smith   PetscInt                   i,j;
1563b224e63SBarry Smith   PC_FieldSplitLink          ilink = jac->head;
157a9908d51SBarry Smith   MatSchurComplementAinvType atype;
1583b224e63SBarry Smith 
1593b224e63SBarry Smith   PetscFunctionBegin;
160251f4c67SDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&iascii);CHKERRQ(ierr);
1614996c5bdSBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERDRAW,&isdraw);CHKERRQ(ierr);
1623b224e63SBarry Smith   if (iascii) {
1632c9966d7SBarry Smith     if (jac->bs > 0) {
164c9c6ffaaSJed Brown       ierr = PetscViewerASCIIPrintf(viewer,"  FieldSplit with Schur preconditioner, blocksize = %D, factorization %s\n",jac->bs,PCFieldSplitSchurFactTypes[jac->schurfactorization]);CHKERRQ(ierr);
1652c9966d7SBarry Smith     } else {
1662c9966d7SBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"  FieldSplit with Schur preconditioner, factorization %s\n",PCFieldSplitSchurFactTypes[jac->schurfactorization]);CHKERRQ(ierr);
1672c9966d7SBarry Smith     }
168f5236f50SJed Brown     if (pc->useAmat) {
169f5236f50SJed Brown       ierr = PetscViewerASCIIPrintf(viewer,"  using Amat (not Pmat) as operator for blocks\n");CHKERRQ(ierr);
170a3df900dSMatthew G Knepley     }
1713e8b8b31SMatthew G Knepley     switch (jac->schurpre) {
1723e8b8b31SMatthew G Knepley     case PC_FIELDSPLIT_SCHUR_PRE_SELF:
173a9908d51SBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"  Preconditioner for the Schur complement formed from S itself\n");CHKERRQ(ierr);
174a9908d51SBarry Smith       break;
175a7476a74SDmitry Karpeev     case PC_FIELDSPLIT_SCHUR_PRE_SELFP:
176a9908d51SBarry Smith       ierr = MatSchurComplementGetAinvType(jac->schur,&atype);CHKERRQ(ierr);
177d0a9c1a2SBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"  Preconditioner for the Schur complement formed from Sp, an assembled approximation to S, which uses A00's %sdiagonal's inverse\n",atype == MAT_SCHUR_COMPLEMENT_AINV_DIAG ? "" : (atype == MAT_SCHUR_COMPLEMENT_AINV_BLOCK_DIAG ? "block " : "lumped "));CHKERRQ(ierr);break;
178e87fab1bSBarry Smith     case PC_FIELDSPLIT_SCHUR_PRE_A11:
179a9908d51SBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"  Preconditioner for the Schur complement formed from A11\n");CHKERRQ(ierr);
180a9908d51SBarry Smith       break;
181e74569cdSMatthew G. Knepley     case PC_FIELDSPLIT_SCHUR_PRE_FULL:
182a9908d51SBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"  Preconditioner for the Schur complement formed from the exact Schur complement\n");CHKERRQ(ierr);
183a9908d51SBarry Smith       break;
1843e8b8b31SMatthew G Knepley     case PC_FIELDSPLIT_SCHUR_PRE_USER:
1853e8b8b31SMatthew G Knepley       if (jac->schur_user) {
1863e8b8b31SMatthew G Knepley         ierr = PetscViewerASCIIPrintf(viewer,"  Preconditioner for the Schur complement formed from user provided matrix\n");CHKERRQ(ierr);
1873e8b8b31SMatthew G Knepley       } else {
188e87fab1bSBarry Smith         ierr = PetscViewerASCIIPrintf(viewer,"  Preconditioner for the Schur complement formed from A11\n");CHKERRQ(ierr);
1893e8b8b31SMatthew G Knepley       }
1903e8b8b31SMatthew G Knepley       break;
1913e8b8b31SMatthew G Knepley     default:
19282f516ccSBarry Smith       SETERRQ1(PetscObjectComm((PetscObject)pc), PETSC_ERR_ARG_OUTOFRANGE, "Invalid Schur preconditioning type: %d", jac->schurpre);
1933e8b8b31SMatthew G Knepley     }
1943b224e63SBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"  Split info:\n");CHKERRQ(ierr);
1953b224e63SBarry Smith     ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
1963b224e63SBarry Smith     for (i=0; i<jac->nsplits; i++) {
1973b224e63SBarry Smith       if (ilink->fields) {
1983b224e63SBarry Smith         ierr = PetscViewerASCIIPrintf(viewer,"Split number %D Fields ",i);CHKERRQ(ierr);
1993b224e63SBarry Smith         ierr = PetscViewerASCIIUseTabs(viewer,PETSC_FALSE);CHKERRQ(ierr);
2003b224e63SBarry Smith         for (j=0; j<ilink->nfields; j++) {
2013b224e63SBarry Smith           if (j > 0) {
2023b224e63SBarry Smith             ierr = PetscViewerASCIIPrintf(viewer,",");CHKERRQ(ierr);
2033b224e63SBarry Smith           }
2043b224e63SBarry Smith           ierr = PetscViewerASCIIPrintf(viewer," %D",ilink->fields[j]);CHKERRQ(ierr);
2053b224e63SBarry Smith         }
2063b224e63SBarry Smith         ierr = PetscViewerASCIIPrintf(viewer,"\n");CHKERRQ(ierr);
2073b224e63SBarry Smith         ierr = PetscViewerASCIIUseTabs(viewer,PETSC_TRUE);CHKERRQ(ierr);
2083b224e63SBarry Smith       } else {
2093b224e63SBarry Smith         ierr = PetscViewerASCIIPrintf(viewer,"Split number %D Defined by IS\n",i);CHKERRQ(ierr);
2103b224e63SBarry Smith       }
2113b224e63SBarry Smith       ilink = ilink->next;
2123b224e63SBarry Smith     }
213435f959eSBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"KSP solver for A00 block\n");CHKERRQ(ierr);
2143b224e63SBarry Smith     ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
21506de4afeSJed Brown     if (jac->head) {
216443836d0SMatthew G Knepley       ierr = KSPView(jac->head->ksp,viewer);CHKERRQ(ierr);
21706de4afeSJed Brown     } else  {ierr = PetscViewerASCIIPrintf(viewer,"  not yet available\n");CHKERRQ(ierr);}
2183b224e63SBarry Smith     ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
21906de4afeSJed Brown     if (jac->head && jac->kspupper != jac->head->ksp) {
220443836d0SMatthew G Knepley       ierr = PetscViewerASCIIPrintf(viewer,"KSP solver for upper A00 in upper triangular factor \n");CHKERRQ(ierr);
221443836d0SMatthew G Knepley       ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
222b2750c55SJed Brown       if (jac->kspupper) {ierr = KSPView(jac->kspupper,viewer);CHKERRQ(ierr);}
223b2750c55SJed Brown       else {ierr = PetscViewerASCIIPrintf(viewer,"  not yet available\n");CHKERRQ(ierr);}
224443836d0SMatthew G Knepley       ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
225443836d0SMatthew G Knepley     }
226435f959eSBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"KSP solver for S = A11 - A10 inv(A00) A01 \n");CHKERRQ(ierr);
2273b224e63SBarry Smith     ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
22812cae6f2SJed Brown     if (jac->kspschur) {
2293b224e63SBarry Smith       ierr = KSPView(jac->kspschur,viewer);CHKERRQ(ierr);
23012cae6f2SJed Brown     } else {
23112cae6f2SJed Brown       ierr = PetscViewerASCIIPrintf(viewer,"  not yet available\n");CHKERRQ(ierr);
23212cae6f2SJed Brown     }
2333b224e63SBarry Smith     ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
2343b224e63SBarry Smith     ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
23506de4afeSJed Brown   } else if (isdraw && jac->head) {
2364996c5bdSBarry Smith     PetscDraw draw;
2374996c5bdSBarry Smith     PetscReal x,y,w,wd,h;
2384996c5bdSBarry Smith     PetscInt  cnt = 2;
2394996c5bdSBarry Smith     char      str[32];
2404996c5bdSBarry Smith 
2414996c5bdSBarry Smith     ierr = PetscViewerDrawGetDraw(viewer,0,&draw);CHKERRQ(ierr);
2424996c5bdSBarry Smith     ierr = PetscDrawGetCurrentPoint(draw,&x,&y);CHKERRQ(ierr);
243c74581afSBarry Smith     if (jac->kspupper != jac->head->ksp) cnt++;
244c74581afSBarry Smith     w  = 2*PetscMin(1.0 - x,x);
245c74581afSBarry Smith     wd = w/(cnt + 1);
246c74581afSBarry Smith 
2474996c5bdSBarry Smith     ierr = PetscSNPrintf(str,32,"Schur fact. %s",PCFieldSplitSchurFactTypes[jac->schurfactorization]);CHKERRQ(ierr);
24851fa3d41SBarry Smith     ierr = PetscDrawStringBoxed(draw,x,y,PETSC_DRAW_RED,PETSC_DRAW_BLACK,str,NULL,&h);CHKERRQ(ierr);
2494996c5bdSBarry Smith     y   -= h;
2504996c5bdSBarry Smith     if (jac->schurpre == PC_FIELDSPLIT_SCHUR_PRE_USER &&  !jac->schur_user) {
251e87fab1bSBarry Smith       ierr = PetscSNPrintf(str,32,"Prec. for Schur from %s",PCFieldSplitSchurPreTypes[PC_FIELDSPLIT_SCHUR_PRE_A11]);CHKERRQ(ierr);
2523b224e63SBarry Smith     } else {
2534996c5bdSBarry Smith       ierr = PetscSNPrintf(str,32,"Prec. for Schur from %s",PCFieldSplitSchurPreTypes[jac->schurpre]);CHKERRQ(ierr);
2544996c5bdSBarry Smith     }
25551fa3d41SBarry Smith     ierr = PetscDrawStringBoxed(draw,x+wd*(cnt-1)/2.0,y,PETSC_DRAW_RED,PETSC_DRAW_BLACK,str,NULL,&h);CHKERRQ(ierr);
2564996c5bdSBarry Smith     y   -= h;
2574996c5bdSBarry Smith     x    = x - wd*(cnt-1)/2.0;
2584996c5bdSBarry Smith 
2594996c5bdSBarry Smith     ierr = PetscDrawPushCurrentPoint(draw,x,y);CHKERRQ(ierr);
2604996c5bdSBarry Smith     ierr = KSPView(jac->head->ksp,viewer);CHKERRQ(ierr);
2614996c5bdSBarry Smith     ierr = PetscDrawPopCurrentPoint(draw);CHKERRQ(ierr);
2624996c5bdSBarry Smith     if (jac->kspupper != jac->head->ksp) {
2634996c5bdSBarry Smith       x   += wd;
2644996c5bdSBarry Smith       ierr = PetscDrawPushCurrentPoint(draw,x,y);CHKERRQ(ierr);
2654996c5bdSBarry Smith       ierr = KSPView(jac->kspupper,viewer);CHKERRQ(ierr);
2664996c5bdSBarry Smith       ierr = PetscDrawPopCurrentPoint(draw);CHKERRQ(ierr);
2674996c5bdSBarry Smith     }
2684996c5bdSBarry Smith     x   += wd;
2694996c5bdSBarry Smith     ierr = PetscDrawPushCurrentPoint(draw,x,y);CHKERRQ(ierr);
2704996c5bdSBarry Smith     ierr = KSPView(jac->kspschur,viewer);CHKERRQ(ierr);
2714996c5bdSBarry Smith     ierr = PetscDrawPopCurrentPoint(draw);CHKERRQ(ierr);
2723b224e63SBarry Smith   }
2733b224e63SBarry Smith   PetscFunctionReturn(0);
2743b224e63SBarry Smith }
2753b224e63SBarry Smith 
2766c924f48SJed Brown /* Precondition: jac->bs is set to a meaningful value */
2776c924f48SJed Brown static PetscErrorCode PCFieldSplitSetRuntimeSplits_Private(PC pc)
2786c924f48SJed Brown {
2796c924f48SJed Brown   PetscErrorCode ierr;
2806c924f48SJed Brown   PC_FieldSplit  *jac = (PC_FieldSplit*)pc->data;
2815d4c12cdSJungho Lee   PetscInt       i,nfields,*ifields,nfields_col,*ifields_col;
2825d4c12cdSJungho Lee   PetscBool      flg,flg_col;
2835d4c12cdSJungho Lee   char           optionname[128],splitname[8],optionname_col[128];
2846c924f48SJed Brown 
2856c924f48SJed Brown   PetscFunctionBegin;
286785e854fSJed Brown   ierr = PetscMalloc1(jac->bs,&ifields);CHKERRQ(ierr);
287785e854fSJed Brown   ierr = PetscMalloc1(jac->bs,&ifields_col);CHKERRQ(ierr);
2886c924f48SJed Brown   for (i=0,flg=PETSC_TRUE;; i++) {
2898caf3d72SBarry Smith     ierr        = PetscSNPrintf(splitname,sizeof(splitname),"%D",i);CHKERRQ(ierr);
2908caf3d72SBarry Smith     ierr        = PetscSNPrintf(optionname,sizeof(optionname),"-pc_fieldsplit_%D_fields",i);CHKERRQ(ierr);
2918caf3d72SBarry Smith     ierr        = PetscSNPrintf(optionname_col,sizeof(optionname_col),"-pc_fieldsplit_%D_fields_col",i);CHKERRQ(ierr);
2926c924f48SJed Brown     nfields     = jac->bs;
29329499fbbSJungho Lee     nfields_col = jac->bs;
294c5929fdfSBarry Smith     ierr        = PetscOptionsGetIntArray(((PetscObject)pc)->options,((PetscObject)pc)->prefix,optionname,ifields,&nfields,&flg);CHKERRQ(ierr);
295c5929fdfSBarry Smith     ierr        = PetscOptionsGetIntArray(((PetscObject)pc)->options,((PetscObject)pc)->prefix,optionname_col,ifields_col,&nfields_col,&flg_col);CHKERRQ(ierr);
2966c924f48SJed Brown     if (!flg) break;
2975d4c12cdSJungho Lee     else if (flg && !flg_col) {
2985d4c12cdSJungho Lee       if (!nfields) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_USER,"Cannot list zero fields");
2995d4c12cdSJungho Lee       ierr = PCFieldSplitSetFields(pc,splitname,nfields,ifields,ifields);CHKERRQ(ierr);
3002fa5cd67SKarl Rupp     } else {
3015d4c12cdSJungho Lee       if (!nfields || !nfields_col) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_USER,"Cannot list zero fields");
3025d4c12cdSJungho Lee       if (nfields != nfields_col) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_USER,"Number of row and column fields must match");
3035d4c12cdSJungho Lee       ierr = PCFieldSplitSetFields(pc,splitname,nfields,ifields,ifields_col);CHKERRQ(ierr);
3045d4c12cdSJungho Lee     }
3056c924f48SJed Brown   }
3066c924f48SJed Brown   if (i > 0) {
3076c924f48SJed Brown     /* Makes command-line setting of splits take precedence over setting them in code.
3086c924f48SJed Brown        Otherwise subsequent calls to PCFieldSplitSetIS() or PCFieldSplitSetFields() would
3096c924f48SJed Brown        create new splits, which would probably not be what the user wanted. */
3106c924f48SJed Brown     jac->splitdefined = PETSC_TRUE;
3116c924f48SJed Brown   }
3126c924f48SJed Brown   ierr = PetscFree(ifields);CHKERRQ(ierr);
3135d4c12cdSJungho Lee   ierr = PetscFree(ifields_col);CHKERRQ(ierr);
3146c924f48SJed Brown   PetscFunctionReturn(0);
3156c924f48SJed Brown }
3166c924f48SJed Brown 
31769a612a9SBarry Smith static PetscErrorCode PCFieldSplitSetDefaults(PC pc)
3180971522cSBarry Smith {
3190971522cSBarry Smith   PC_FieldSplit     *jac = (PC_FieldSplit*)pc->data;
3200971522cSBarry Smith   PetscErrorCode    ierr;
3215a9f2f41SSatish Balay   PC_FieldSplitLink ilink = jac->head;
322*7b752e3dSPatrick Sanan   PetscBool         fieldsplit_default = PETSC_FALSE,coupling = PETSC_FALSE;
3236c924f48SJed Brown   PetscInt          i;
3240971522cSBarry Smith 
3250971522cSBarry Smith   PetscFunctionBegin;
3267287d2a3SDmitry Karpeev   /*
327f5f0d762SBarry Smith    Kinda messy, but at least this now uses DMCreateFieldDecomposition().
3287287d2a3SDmitry Karpeev    Should probably be rewritten.
3297287d2a3SDmitry Karpeev    */
330f5f0d762SBarry Smith   if (!ilink) {
331c5929fdfSBarry Smith     ierr = PetscOptionsGetBool(((PetscObject)pc)->options,((PetscObject)pc)->prefix,"-pc_fieldsplit_detect_coupling",&coupling,NULL);CHKERRQ(ierr);
332*7b752e3dSPatrick Sanan     if (pc->dm && jac->dm_splits && !jac->detect && !coupling) {
333bafc1b83SMatthew G Knepley       PetscInt  numFields, f, i, j;
3340784a22cSJed Brown       char      **fieldNames;
3357b62db95SJungho Lee       IS        *fields;
336e7c4fc90SDmitry Karpeev       DM        *dms;
337bafc1b83SMatthew G Knepley       DM        subdm[128];
338bafc1b83SMatthew G Knepley       PetscBool flg;
339bafc1b83SMatthew G Knepley 
34016621825SDmitry Karpeev       ierr = DMCreateFieldDecomposition(pc->dm, &numFields, &fieldNames, &fields, &dms);CHKERRQ(ierr);
341bafc1b83SMatthew G Knepley       /* Allow the user to prescribe the splits */
342bafc1b83SMatthew G Knepley       for (i = 0, flg = PETSC_TRUE;; i++) {
343bafc1b83SMatthew G Knepley         PetscInt ifields[128];
344bafc1b83SMatthew G Knepley         IS       compField;
345bafc1b83SMatthew G Knepley         char     optionname[128], splitname[8];
346bafc1b83SMatthew G Knepley         PetscInt nfields = numFields;
347bafc1b83SMatthew G Knepley 
3488caf3d72SBarry Smith         ierr = PetscSNPrintf(optionname, sizeof(optionname), "-pc_fieldsplit_%D_fields", i);CHKERRQ(ierr);
349c5929fdfSBarry Smith         ierr = PetscOptionsGetIntArray(((PetscObject)pc)->options,((PetscObject)pc)->prefix, optionname, ifields, &nfields, &flg);CHKERRQ(ierr);
350bafc1b83SMatthew G Knepley         if (!flg) break;
35182f516ccSBarry Smith         if (numFields > 128) SETERRQ1(PetscObjectComm((PetscObject)pc),PETSC_ERR_SUP,"Cannot currently support %d > 128 fields", numFields);
352bafc1b83SMatthew G Knepley         ierr = DMCreateSubDM(pc->dm, nfields, ifields, &compField, &subdm[i]);CHKERRQ(ierr);
353bafc1b83SMatthew G Knepley         if (nfields == 1) {
354bafc1b83SMatthew G Knepley           ierr = PCFieldSplitSetIS(pc, fieldNames[ifields[0]], compField);CHKERRQ(ierr);
355bafc1b83SMatthew G Knepley         } else {
3568caf3d72SBarry Smith           ierr = PetscSNPrintf(splitname, sizeof(splitname), "%D", i);CHKERRQ(ierr);
357bafc1b83SMatthew G Knepley           ierr = PCFieldSplitSetIS(pc, splitname, compField);CHKERRQ(ierr);
3587287d2a3SDmitry Karpeev         }
359bafc1b83SMatthew G Knepley         ierr = ISDestroy(&compField);CHKERRQ(ierr);
360bafc1b83SMatthew G Knepley         for (j = 0; j < nfields; ++j) {
361bafc1b83SMatthew G Knepley           f    = ifields[j];
3627b62db95SJungho Lee           ierr = PetscFree(fieldNames[f]);CHKERRQ(ierr);
3637b62db95SJungho Lee           ierr = ISDestroy(&fields[f]);CHKERRQ(ierr);
3647b62db95SJungho Lee         }
365bafc1b83SMatthew G Knepley       }
366bafc1b83SMatthew G Knepley       if (i == 0) {
367bafc1b83SMatthew G Knepley         for (f = 0; f < numFields; ++f) {
368bafc1b83SMatthew G Knepley           ierr = PCFieldSplitSetIS(pc, fieldNames[f], fields[f]);CHKERRQ(ierr);
369bafc1b83SMatthew G Knepley           ierr = PetscFree(fieldNames[f]);CHKERRQ(ierr);
370bafc1b83SMatthew G Knepley           ierr = ISDestroy(&fields[f]);CHKERRQ(ierr);
371bafc1b83SMatthew G Knepley         }
372bafc1b83SMatthew G Knepley       } else {
373d724dfffSBarry Smith         for (j=0; j<numFields; j++) {
374d724dfffSBarry Smith           ierr = DMDestroy(dms+j);CHKERRQ(ierr);
375d724dfffSBarry Smith         }
376d724dfffSBarry Smith         ierr = PetscFree(dms);CHKERRQ(ierr);
377785e854fSJed Brown         ierr = PetscMalloc1(i, &dms);CHKERRQ(ierr);
3782fa5cd67SKarl Rupp         for (j = 0; j < i; ++j) dms[j] = subdm[j];
379bafc1b83SMatthew G Knepley       }
3807b62db95SJungho Lee       ierr = PetscFree(fieldNames);CHKERRQ(ierr);
3817b62db95SJungho Lee       ierr = PetscFree(fields);CHKERRQ(ierr);
382e7c4fc90SDmitry Karpeev       if (dms) {
3838b8307b2SJed Brown         ierr = PetscInfo(pc, "Setting up physics based fieldsplit preconditioner using the embedded DM\n");CHKERRQ(ierr);
384bafc1b83SMatthew G Knepley         for (ilink = jac->head, i = 0; ilink; ilink = ilink->next, ++i) {
3857287d2a3SDmitry Karpeev           const char *prefix;
3867287d2a3SDmitry Karpeev           ierr = PetscObjectGetOptionsPrefix((PetscObject)(ilink->ksp),&prefix);CHKERRQ(ierr);
3877287d2a3SDmitry Karpeev           ierr = PetscObjectSetOptionsPrefix((PetscObject)(dms[i]), prefix);CHKERRQ(ierr);
3887b62db95SJungho Lee           ierr = KSPSetDM(ilink->ksp, dms[i]);CHKERRQ(ierr);
3897b62db95SJungho Lee           ierr = KSPSetDMActive(ilink->ksp, PETSC_FALSE);CHKERRQ(ierr);
3907287d2a3SDmitry Karpeev           ierr = PetscObjectIncrementTabLevel((PetscObject)dms[i],(PetscObject)ilink->ksp,0);CHKERRQ(ierr);
391e7c4fc90SDmitry Karpeev           ierr = DMDestroy(&dms[i]);CHKERRQ(ierr);
3922fa5ba8aSJed Brown         }
3937b62db95SJungho Lee         ierr = PetscFree(dms);CHKERRQ(ierr);
3948b8307b2SJed Brown       }
39566ffff09SJed Brown     } else {
396521d7252SBarry Smith       if (jac->bs <= 0) {
397704ba839SBarry Smith         if (pc->pmat) {
398521d7252SBarry Smith           ierr = MatGetBlockSize(pc->pmat,&jac->bs);CHKERRQ(ierr);
3992fa5cd67SKarl Rupp         } else jac->bs = 1;
400521d7252SBarry Smith       }
401d32f9abdSBarry Smith 
402*7b752e3dSPatrick Sanan       if (jac->detect) {
4036ce1633cSBarry Smith         IS       zerodiags,rest;
4046ce1633cSBarry Smith         PetscInt nmin,nmax;
4056ce1633cSBarry Smith 
4066ce1633cSBarry Smith         ierr = MatGetOwnershipRange(pc->mat,&nmin,&nmax);CHKERRQ(ierr);
4076ce1633cSBarry Smith         ierr = MatFindZeroDiagonals(pc->mat,&zerodiags);CHKERRQ(ierr);
4086ce1633cSBarry Smith         ierr = ISComplement(zerodiags,nmin,nmax,&rest);CHKERRQ(ierr);
4096ce1633cSBarry Smith         ierr = PCFieldSplitSetIS(pc,"0",rest);CHKERRQ(ierr);
4106ce1633cSBarry Smith         ierr = PCFieldSplitSetIS(pc,"1",zerodiags);CHKERRQ(ierr);
411fcfd50ebSBarry Smith         ierr = ISDestroy(&zerodiags);CHKERRQ(ierr);
412fcfd50ebSBarry Smith         ierr = ISDestroy(&rest);CHKERRQ(ierr);
4133a062f41SBarry Smith       } else if (coupling) {
4143a062f41SBarry Smith         IS       coupling,rest;
4153a062f41SBarry Smith         PetscInt nmin,nmax;
4163a062f41SBarry Smith 
4173a062f41SBarry Smith         ierr = MatGetOwnershipRange(pc->mat,&nmin,&nmax);CHKERRQ(ierr);
4183a062f41SBarry Smith         ierr = MatFindOffBlockDiagonalEntries(pc->mat,&coupling);CHKERRQ(ierr);
4196bea0878SBarry Smith         ierr = ISCreateStride(PetscObjectComm((PetscObject)pc->mat),nmax-nmin,nmin,1,&rest);CHKERRQ(ierr);
420e52d2c62SBarry Smith         ierr = ISSetIdentity(rest);CHKERRQ(ierr);
421d020c841SBarry Smith         ierr = PCFieldSplitSetIS(pc,"0",rest);CHKERRQ(ierr);
422d020c841SBarry Smith         ierr = PCFieldSplitSetIS(pc,"1",coupling);CHKERRQ(ierr);
4233a062f41SBarry Smith         ierr = ISDestroy(&coupling);CHKERRQ(ierr);
4243a062f41SBarry Smith         ierr = ISDestroy(&rest);CHKERRQ(ierr);
4256ce1633cSBarry Smith       } else {
426c5929fdfSBarry Smith         ierr = PetscOptionsGetBool(((PetscObject)pc)->options,((PetscObject)pc)->prefix,"-pc_fieldsplit_default",&fieldsplit_default,NULL);CHKERRQ(ierr);
4277287d2a3SDmitry Karpeev         if (!fieldsplit_default) {
428d32f9abdSBarry Smith           /* Allow user to set fields from command line,  if bs was known at the time of PCSetFromOptions_FieldSplit()
429d32f9abdSBarry Smith            then it is set there. This is not ideal because we should only have options set in XXSetFromOptions(). */
4306c924f48SJed Brown           ierr = PCFieldSplitSetRuntimeSplits_Private(pc);CHKERRQ(ierr);
4316c924f48SJed Brown           if (jac->splitdefined) {ierr = PetscInfo(pc,"Splits defined using the options database\n");CHKERRQ(ierr);}
432d32f9abdSBarry Smith         }
4336dbb499eSCian Wilson         if ((fieldsplit_default || !jac->splitdefined) && !jac->isrestrict) {
434d32f9abdSBarry Smith           ierr = PetscInfo(pc,"Using default splitting of fields\n");CHKERRQ(ierr);
435db4c96c1SJed Brown           for (i=0; i<jac->bs; i++) {
4366c924f48SJed Brown             char splitname[8];
4378caf3d72SBarry Smith             ierr = PetscSNPrintf(splitname,sizeof(splitname),"%D",i);CHKERRQ(ierr);
4385d4c12cdSJungho Lee             ierr = PCFieldSplitSetFields(pc,splitname,1,&i,&i);CHKERRQ(ierr);
43979416396SBarry Smith           }
4405d4c12cdSJungho Lee           jac->defaultsplit = PETSC_TRUE;
441521d7252SBarry Smith         }
44266ffff09SJed Brown       }
4436ce1633cSBarry Smith     }
444edf189efSBarry Smith   } else if (jac->nsplits == 1) {
445edf189efSBarry Smith     if (ilink->is) {
446edf189efSBarry Smith       IS       is2;
447edf189efSBarry Smith       PetscInt nmin,nmax;
448edf189efSBarry Smith 
449edf189efSBarry Smith       ierr = MatGetOwnershipRange(pc->mat,&nmin,&nmax);CHKERRQ(ierr);
450edf189efSBarry Smith       ierr = ISComplement(ilink->is,nmin,nmax,&is2);CHKERRQ(ierr);
451db4c96c1SJed Brown       ierr = PCFieldSplitSetIS(pc,"1",is2);CHKERRQ(ierr);
452fcfd50ebSBarry Smith       ierr = ISDestroy(&is2);CHKERRQ(ierr);
45382f516ccSBarry Smith     } else SETERRQ(PetscObjectComm((PetscObject)pc),PETSC_ERR_SUP,"Must provide at least two sets of fields to PCFieldSplit()");
454edf189efSBarry Smith   }
455d0af7cd3SBarry Smith 
45682f516ccSBarry Smith   if (jac->nsplits < 2) SETERRQ1(PetscObjectComm((PetscObject)pc),PETSC_ERR_PLIB,"Unhandled case, must have at least two fields, not %d", jac->nsplits);
45769a612a9SBarry Smith   PetscFunctionReturn(0);
45869a612a9SBarry Smith }
45969a612a9SBarry Smith 
460c5929fdfSBarry Smith PETSC_EXTERN PetscErrorCode PetscOptionsFindPairPrefix_Private(PetscOptions,const char pre[], const char name[], char *value[], PetscBool *flg);
461514bf10dSMatthew G Knepley 
46269a612a9SBarry Smith static PetscErrorCode PCSetUp_FieldSplit(PC pc)
46369a612a9SBarry Smith {
46469a612a9SBarry Smith   PC_FieldSplit     *jac = (PC_FieldSplit*)pc->data;
46569a612a9SBarry Smith   PetscErrorCode    ierr;
4665a9f2f41SSatish Balay   PC_FieldSplitLink ilink;
4672c9966d7SBarry Smith   PetscInt          i,nsplit;
4685f4ab4e1SJungho Lee   PetscBool         sorted, sorted_col;
46969a612a9SBarry Smith 
47069a612a9SBarry Smith   PetscFunctionBegin;
47169a612a9SBarry Smith   ierr   = PCFieldSplitSetDefaults(pc);CHKERRQ(ierr);
47297bbdb24SBarry Smith   nsplit = jac->nsplits;
4735a9f2f41SSatish Balay   ilink  = jac->head;
47497bbdb24SBarry Smith 
47597bbdb24SBarry Smith   /* get the matrices for each split */
476704ba839SBarry Smith   if (!jac->issetup) {
4771b9fc7fcSBarry Smith     PetscInt rstart,rend,nslots,bs;
47897bbdb24SBarry Smith 
479704ba839SBarry Smith     jac->issetup = PETSC_TRUE;
480704ba839SBarry Smith 
4815d4c12cdSJungho Lee     /* This is done here instead of in PCFieldSplitSetFields() because may not have matrix at that point */
4822c9966d7SBarry Smith     if (jac->defaultsplit || !ilink->is) {
4832c9966d7SBarry Smith       if (jac->bs <= 0) jac->bs = nsplit;
4842c9966d7SBarry Smith     }
48551f519a2SBarry Smith     bs     = jac->bs;
48697bbdb24SBarry Smith     ierr   = MatGetOwnershipRange(pc->pmat,&rstart,&rend);CHKERRQ(ierr);
4871b9fc7fcSBarry Smith     nslots = (rend - rstart)/bs;
4881b9fc7fcSBarry Smith     for (i=0; i<nsplit; i++) {
4891b9fc7fcSBarry Smith       if (jac->defaultsplit) {
490ce94432eSBarry Smith         ierr = ISCreateStride(PetscObjectComm((PetscObject)pc),nslots,rstart+i,nsplit,&ilink->is);CHKERRQ(ierr);
4915f4ab4e1SJungho Lee         ierr = ISDuplicate(ilink->is,&ilink->is_col);CHKERRQ(ierr);
492704ba839SBarry Smith       } else if (!ilink->is) {
493ccb205f8SBarry Smith         if (ilink->nfields > 1) {
4945f4ab4e1SJungho Lee           PetscInt *ii,*jj,j,k,nfields = ilink->nfields,*fields = ilink->fields,*fields_col = ilink->fields_col;
495785e854fSJed Brown           ierr = PetscMalloc1(ilink->nfields*nslots,&ii);CHKERRQ(ierr);
496785e854fSJed Brown           ierr = PetscMalloc1(ilink->nfields*nslots,&jj);CHKERRQ(ierr);
4971b9fc7fcSBarry Smith           for (j=0; j<nslots; j++) {
4981b9fc7fcSBarry Smith             for (k=0; k<nfields; k++) {
4991b9fc7fcSBarry Smith               ii[nfields*j + k] = rstart + bs*j + fields[k];
5005f4ab4e1SJungho Lee               jj[nfields*j + k] = rstart + bs*j + fields_col[k];
50197bbdb24SBarry Smith             }
50297bbdb24SBarry Smith           }
503ce94432eSBarry Smith           ierr = ISCreateGeneral(PetscObjectComm((PetscObject)pc),nslots*nfields,ii,PETSC_OWN_POINTER,&ilink->is);CHKERRQ(ierr);
504ce94432eSBarry Smith           ierr = ISCreateGeneral(PetscObjectComm((PetscObject)pc),nslots*nfields,jj,PETSC_OWN_POINTER,&ilink->is_col);CHKERRQ(ierr);
50590e68f20SPatrick Farrell           ierr = ISSetBlockSize(ilink->is, nfields);CHKERRQ(ierr);
50690e68f20SPatrick Farrell           ierr = ISSetBlockSize(ilink->is_col, nfields);CHKERRQ(ierr);
507ccb205f8SBarry Smith         } else {
508ce94432eSBarry Smith           ierr = ISCreateStride(PetscObjectComm((PetscObject)pc),nslots,rstart+ilink->fields[0],bs,&ilink->is);CHKERRQ(ierr);
509ce94432eSBarry Smith           ierr = ISCreateStride(PetscObjectComm((PetscObject)pc),nslots,rstart+ilink->fields_col[0],bs,&ilink->is_col);CHKERRQ(ierr);
510ccb205f8SBarry Smith        }
5113e197d65SBarry Smith       }
512704ba839SBarry Smith       ierr = ISSorted(ilink->is,&sorted);CHKERRQ(ierr);
5135f4ab4e1SJungho Lee       if (ilink->is_col) { ierr = ISSorted(ilink->is_col,&sorted_col);CHKERRQ(ierr); }
5145f4ab4e1SJungho Lee       if (!sorted || !sorted_col) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_USER,"Fields must be sorted when creating split");
515704ba839SBarry Smith       ilink = ilink->next;
5161b9fc7fcSBarry Smith     }
5171b9fc7fcSBarry Smith   }
5181b9fc7fcSBarry Smith 
519704ba839SBarry Smith   ilink = jac->head;
52097bbdb24SBarry Smith   if (!jac->pmat) {
521bdddcaaaSMatthew G Knepley     Vec xtmp;
522bdddcaaaSMatthew G Knepley 
5232a7a6963SBarry Smith     ierr = MatCreateVecs(pc->pmat,&xtmp,NULL);CHKERRQ(ierr);
524785e854fSJed Brown     ierr = PetscMalloc1(nsplit,&jac->pmat);CHKERRQ(ierr);
525dcca6d9dSJed Brown     ierr = PetscMalloc2(nsplit,&jac->x,nsplit,&jac->y);CHKERRQ(ierr);
526cf502942SBarry Smith     for (i=0; i<nsplit; i++) {
527bdddcaaaSMatthew G Knepley       MatNullSpace sp;
528bdddcaaaSMatthew G Knepley 
529a3df900dSMatthew G Knepley       /* Check for preconditioning matrix attached to IS */
530a3df900dSMatthew G Knepley       ierr = PetscObjectQuery((PetscObject) ilink->is, "pmat", (PetscObject*) &jac->pmat[i]);CHKERRQ(ierr);
531a3df900dSMatthew G Knepley       if (jac->pmat[i]) {
532a3df900dSMatthew G Knepley         ierr = PetscObjectReference((PetscObject) jac->pmat[i]);CHKERRQ(ierr);
533a3df900dSMatthew G Knepley         if (jac->type == PC_COMPOSITE_SCHUR) {
534a3df900dSMatthew G Knepley           jac->schur_user = jac->pmat[i];
5352fa5cd67SKarl Rupp 
536a3df900dSMatthew G Knepley           ierr = PetscObjectReference((PetscObject) jac->schur_user);CHKERRQ(ierr);
537a3df900dSMatthew G Knepley         }
538a3df900dSMatthew G Knepley       } else {
5393a062f41SBarry Smith         const char *prefix;
5407dae84e0SHong Zhang         ierr = MatCreateSubMatrix(pc->pmat,ilink->is,ilink->is_col,MAT_INITIAL_MATRIX,&jac->pmat[i]);CHKERRQ(ierr);
5413a062f41SBarry Smith         ierr = KSPGetOptionsPrefix(ilink->ksp,&prefix);CHKERRQ(ierr);
5423a062f41SBarry Smith         ierr = MatSetOptionsPrefix(jac->pmat[i],prefix);CHKERRQ(ierr);
5433a062f41SBarry Smith         ierr = MatViewFromOptions(jac->pmat[i],NULL,"-mat_view");CHKERRQ(ierr);
544a3df900dSMatthew G Knepley       }
545bdddcaaaSMatthew G Knepley       /* create work vectors for each split */
5462a7a6963SBarry Smith       ierr     = MatCreateVecs(jac->pmat[i],&jac->x[i],&jac->y[i]);CHKERRQ(ierr);
5470298fd71SBarry Smith       ilink->x = jac->x[i]; ilink->y = jac->y[i]; ilink->z = NULL;
548bdddcaaaSMatthew G Knepley       /* compute scatter contexts needed by multiplicative versions and non-default splits */
5490298fd71SBarry Smith       ierr = VecScatterCreate(xtmp,ilink->is,jac->x[i],NULL,&ilink->sctx);CHKERRQ(ierr);
550ed1f0337SMatthew G Knepley       ierr = PetscObjectQuery((PetscObject) ilink->is, "nearnullspace", (PetscObject*) &sp);CHKERRQ(ierr);
551ed1f0337SMatthew G Knepley       if (sp) {
552ed1f0337SMatthew G Knepley         ierr = MatSetNearNullSpace(jac->pmat[i], sp);CHKERRQ(ierr);
553ed1f0337SMatthew G Knepley       }
554704ba839SBarry Smith       ilink = ilink->next;
555cf502942SBarry Smith     }
556bdddcaaaSMatthew G Knepley     ierr = VecDestroy(&xtmp);CHKERRQ(ierr);
55797bbdb24SBarry Smith   } else {
558cf502942SBarry Smith     for (i=0; i<nsplit; i++) {
559a3df900dSMatthew G Knepley       Mat pmat;
560a3df900dSMatthew G Knepley 
561a3df900dSMatthew G Knepley       /* Check for preconditioning matrix attached to IS */
562a3df900dSMatthew G Knepley       ierr = PetscObjectQuery((PetscObject) ilink->is, "pmat", (PetscObject*) &pmat);CHKERRQ(ierr);
563a3df900dSMatthew G Knepley       if (!pmat) {
5647dae84e0SHong Zhang         ierr = MatCreateSubMatrix(pc->pmat,ilink->is,ilink->is_col,MAT_REUSE_MATRIX,&jac->pmat[i]);CHKERRQ(ierr);
565a3df900dSMatthew G Knepley       }
566704ba839SBarry Smith       ilink = ilink->next;
567cf502942SBarry Smith     }
56897bbdb24SBarry Smith   }
5694e39094bSDmitry Karpeev   if (jac->diag_use_amat) {
570519d70e2SJed Brown     ilink = jac->head;
571519d70e2SJed Brown     if (!jac->mat) {
572785e854fSJed Brown       ierr = PetscMalloc1(nsplit,&jac->mat);CHKERRQ(ierr);
573519d70e2SJed Brown       for (i=0; i<nsplit; i++) {
5747dae84e0SHong Zhang         ierr  = MatCreateSubMatrix(pc->mat,ilink->is,ilink->is_col,MAT_INITIAL_MATRIX,&jac->mat[i]);CHKERRQ(ierr);
575519d70e2SJed Brown         ilink = ilink->next;
576519d70e2SJed Brown       }
577519d70e2SJed Brown     } else {
578519d70e2SJed Brown       for (i=0; i<nsplit; i++) {
5797dae84e0SHong Zhang         if (jac->mat[i]) {ierr = MatCreateSubMatrix(pc->mat,ilink->is,ilink->is_col,MAT_REUSE_MATRIX,&jac->mat[i]);CHKERRQ(ierr);}
580519d70e2SJed Brown         ilink = ilink->next;
581519d70e2SJed Brown       }
582519d70e2SJed Brown     }
583519d70e2SJed Brown   } else {
584519d70e2SJed Brown     jac->mat = jac->pmat;
585519d70e2SJed Brown   }
58697bbdb24SBarry Smith 
58753935eafSBarry Smith   /* Check for null space attached to IS */
58853935eafSBarry Smith   ilink = jac->head;
58953935eafSBarry Smith   for (i=0; i<nsplit; i++) {
59053935eafSBarry Smith     MatNullSpace sp;
59153935eafSBarry Smith 
59253935eafSBarry Smith     ierr = PetscObjectQuery((PetscObject) ilink->is, "nullspace", (PetscObject*) &sp);CHKERRQ(ierr);
59353935eafSBarry Smith     if (sp) {
59453935eafSBarry Smith       ierr = MatSetNullSpace(jac->mat[i], sp);CHKERRQ(ierr);
59553935eafSBarry Smith     }
59653935eafSBarry Smith     ilink = ilink->next;
59753935eafSBarry Smith   }
59853935eafSBarry Smith 
5996c8605c2SJed Brown   if (jac->type != PC_COMPOSITE_ADDITIVE  && jac->type != PC_COMPOSITE_SCHUR) {
60068dd23aaSBarry Smith     /* extract the rows of the matrix associated with each field: used for efficient computation of residual inside algorithm */
6014e39094bSDmitry Karpeev     /* FIXME: Can/should we reuse jac->mat whenever (jac->diag_use_amat) is true? */
60268dd23aaSBarry Smith     ilink = jac->head;
603e52d2c62SBarry Smith     if (nsplit == 2 && jac->type == PC_COMPOSITE_MULTIPLICATIVE) {
604e52d2c62SBarry 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 */
605e52d2c62SBarry Smith       if (!jac->Afield) {
606e52d2c62SBarry Smith         ierr = PetscCalloc1(nsplit,&jac->Afield);CHKERRQ(ierr);
60780c96bb1SFande Kong         if (jac->offdiag_use_amat) {
6087dae84e0SHong Zhang           ierr  = MatCreateSubMatrix(pc->mat,ilink->next->is,ilink->is,MAT_INITIAL_MATRIX,&jac->Afield[1]);CHKERRQ(ierr);
609e52d2c62SBarry Smith         } else {
6107dae84e0SHong Zhang           ierr  = MatCreateSubMatrix(pc->pmat,ilink->next->is,ilink->is,MAT_INITIAL_MATRIX,&jac->Afield[1]);CHKERRQ(ierr);
61180c96bb1SFande Kong         }
61280c96bb1SFande Kong       } else {
61380c96bb1SFande Kong         if (jac->offdiag_use_amat) {
6147dae84e0SHong Zhang           ierr  = MatCreateSubMatrix(pc->mat,ilink->next->is,ilink->is,MAT_REUSE_MATRIX,&jac->Afield[1]);CHKERRQ(ierr);
61580c96bb1SFande Kong         } else {
6167dae84e0SHong Zhang           ierr  = MatCreateSubMatrix(pc->pmat,ilink->next->is,ilink->is,MAT_REUSE_MATRIX,&jac->Afield[1]);CHKERRQ(ierr);
61780c96bb1SFande Kong         }
618e52d2c62SBarry Smith       }
619e52d2c62SBarry Smith     } else {
62068dd23aaSBarry Smith       if (!jac->Afield) {
621785e854fSJed Brown         ierr = PetscMalloc1(nsplit,&jac->Afield);CHKERRQ(ierr);
62268dd23aaSBarry Smith         for (i=0; i<nsplit; i++) {
62380c96bb1SFande Kong           if (jac->offdiag_use_amat) {
6247dae84e0SHong Zhang             ierr  = MatCreateSubMatrix(pc->mat,ilink->is,NULL,MAT_INITIAL_MATRIX,&jac->Afield[i]);CHKERRQ(ierr);
62580c96bb1SFande Kong           } else {
6267dae84e0SHong Zhang             ierr  = MatCreateSubMatrix(pc->pmat,ilink->is,NULL,MAT_INITIAL_MATRIX,&jac->Afield[i]);CHKERRQ(ierr);
62780c96bb1SFande Kong           }
62868dd23aaSBarry Smith           ilink = ilink->next;
62968dd23aaSBarry Smith         }
63068dd23aaSBarry Smith       } else {
63168dd23aaSBarry Smith         for (i=0; i<nsplit; i++) {
63280c96bb1SFande Kong           if (jac->offdiag_use_amat) {
6337dae84e0SHong Zhang             ierr  = MatCreateSubMatrix(pc->mat,ilink->is,NULL,MAT_REUSE_MATRIX,&jac->Afield[i]);CHKERRQ(ierr);
63480c96bb1SFande Kong           } else {
6357dae84e0SHong Zhang             ierr  = MatCreateSubMatrix(pc->pmat,ilink->is,NULL,MAT_REUSE_MATRIX,&jac->Afield[i]);CHKERRQ(ierr);
63680c96bb1SFande Kong           }
63768dd23aaSBarry Smith           ilink = ilink->next;
63868dd23aaSBarry Smith         }
63968dd23aaSBarry Smith       }
64068dd23aaSBarry Smith     }
641e52d2c62SBarry Smith   }
64268dd23aaSBarry Smith 
6433b224e63SBarry Smith   if (jac->type == PC_COMPOSITE_SCHUR) {
6443b224e63SBarry Smith     IS          ccis;
645c096484dSStefano Zampini     PetscBool   isspd;
6464aa3045dSJed Brown     PetscInt    rstart,rend;
647093c86ffSJed Brown     char        lscname[256];
648093c86ffSJed Brown     PetscObject LSC_L;
649ce94432eSBarry Smith 
650ce94432eSBarry Smith     if (nsplit != 2) SETERRQ(PetscObjectComm((PetscObject)pc),PETSC_ERR_ARG_INCOMP,"To use Schur complement preconditioner you must have exactly 2 fields");
65168dd23aaSBarry Smith 
652c096484dSStefano Zampini     /* If pc->mat is SPD, don't scale by -1 the Schur complement */
653c096484dSStefano Zampini     if (jac->schurscale == (PetscScalar)-1.0) {
654c096484dSStefano Zampini       ierr = MatGetOption(pc->pmat,MAT_SPD,&isspd);CHKERRQ(ierr);
655c096484dSStefano Zampini       jac->schurscale = (isspd == PETSC_TRUE) ? 1.0 : -1.0;
656c096484dSStefano Zampini     }
657c096484dSStefano Zampini 
658e6cab6aaSJed Brown     /* When extracting off-diagonal submatrices, we take complements from this range */
659e6cab6aaSJed Brown     ierr = MatGetOwnershipRangeColumn(pc->mat,&rstart,&rend);CHKERRQ(ierr);
660e6cab6aaSJed Brown 
6613b224e63SBarry Smith     /* need to handle case when one is resetting up the preconditioner */
6623b224e63SBarry Smith     if (jac->schur) {
6630298fd71SBarry Smith       KSP kspA = jac->head->ksp, kspInner = NULL, kspUpper = jac->kspupper;
664443836d0SMatthew G Knepley 
665fb3147dbSMatthew G Knepley       ierr  = MatSchurComplementGetKSP(jac->schur, &kspInner);CHKERRQ(ierr);
6663b224e63SBarry Smith       ilink = jac->head;
66749bb4cd7SJungho Lee       ierr  = ISComplement(ilink->is_col,rstart,rend,&ccis);CHKERRQ(ierr);
6684e39094bSDmitry Karpeev       if (jac->offdiag_use_amat) {
6697dae84e0SHong Zhang 	ierr  = MatCreateSubMatrix(pc->mat,ilink->is,ccis,MAT_REUSE_MATRIX,&jac->B);CHKERRQ(ierr);
670c84da90fSDmitry Karpeev       } else {
6717dae84e0SHong Zhang 	ierr  = MatCreateSubMatrix(pc->pmat,ilink->is,ccis,MAT_REUSE_MATRIX,&jac->B);CHKERRQ(ierr);
672c84da90fSDmitry Karpeev       }
673fcfd50ebSBarry Smith       ierr  = ISDestroy(&ccis);CHKERRQ(ierr);
6743b224e63SBarry Smith       ilink = ilink->next;
67549bb4cd7SJungho Lee       ierr  = ISComplement(ilink->is_col,rstart,rend,&ccis);CHKERRQ(ierr);
6764e39094bSDmitry Karpeev       if (jac->offdiag_use_amat) {
6777dae84e0SHong Zhang 	ierr  = MatCreateSubMatrix(pc->mat,ilink->is,ccis,MAT_REUSE_MATRIX,&jac->C);CHKERRQ(ierr);
678c84da90fSDmitry Karpeev       } else {
6797dae84e0SHong Zhang 	ierr  = MatCreateSubMatrix(pc->pmat,ilink->is,ccis,MAT_REUSE_MATRIX,&jac->C);CHKERRQ(ierr);
680c84da90fSDmitry Karpeev       }
681fcfd50ebSBarry Smith       ierr  = ISDestroy(&ccis);CHKERRQ(ierr);
682aa6c7ce3SBarry Smith       ierr  = MatSchurComplementUpdateSubMatrices(jac->schur,jac->mat[0],jac->pmat[0],jac->B,jac->C,jac->mat[1]);CHKERRQ(ierr);
683a7476a74SDmitry Karpeev       if (jac->schurpre == PC_FIELDSPLIT_SCHUR_PRE_SELFP) {
684a7476a74SDmitry Karpeev 	ierr = MatDestroy(&jac->schurp);CHKERRQ(ierr);
685a7476a74SDmitry Karpeev 	ierr = MatSchurComplementGetPmat(jac->schur,MAT_INITIAL_MATRIX,&jac->schurp);CHKERRQ(ierr);
686a7476a74SDmitry Karpeev       }
687443836d0SMatthew G Knepley       if (kspA != kspInner) {
68823ee1639SBarry Smith         ierr = KSPSetOperators(kspA,jac->mat[0],jac->pmat[0]);CHKERRQ(ierr);
689443836d0SMatthew G Knepley       }
690443836d0SMatthew G Knepley       if (kspUpper != kspA) {
69123ee1639SBarry Smith         ierr = KSPSetOperators(kspUpper,jac->mat[0],jac->pmat[0]);CHKERRQ(ierr);
692443836d0SMatthew G Knepley       }
69323ee1639SBarry Smith       ierr = KSPSetOperators(jac->kspschur,jac->schur,FieldSplitSchurPre(jac));CHKERRQ(ierr);
6943b224e63SBarry Smith     } else {
695bafc1b83SMatthew G Knepley       const char   *Dprefix;
696470b340bSDmitry Karpeev       char         schurprefix[256], schurmatprefix[256];
697514bf10dSMatthew G Knepley       char         schurtestoption[256];
698bdddcaaaSMatthew G Knepley       MatNullSpace sp;
699514bf10dSMatthew G Knepley       PetscBool    flg;
7003b224e63SBarry Smith 
701a04f6461SBarry Smith       /* extract the A01 and A10 matrices */
7023b224e63SBarry Smith       ilink = jac->head;
70349bb4cd7SJungho Lee       ierr  = ISComplement(ilink->is_col,rstart,rend,&ccis);CHKERRQ(ierr);
7044e39094bSDmitry Karpeev       if (jac->offdiag_use_amat) {
7057dae84e0SHong Zhang 	ierr  = MatCreateSubMatrix(pc->mat,ilink->is,ccis,MAT_INITIAL_MATRIX,&jac->B);CHKERRQ(ierr);
706c84da90fSDmitry Karpeev       } else {
7077dae84e0SHong Zhang 	ierr  = MatCreateSubMatrix(pc->pmat,ilink->is,ccis,MAT_INITIAL_MATRIX,&jac->B);CHKERRQ(ierr);
708c84da90fSDmitry Karpeev       }
709fcfd50ebSBarry Smith       ierr  = ISDestroy(&ccis);CHKERRQ(ierr);
7103b224e63SBarry Smith       ilink = ilink->next;
71149bb4cd7SJungho Lee       ierr  = ISComplement(ilink->is_col,rstart,rend,&ccis);CHKERRQ(ierr);
7124e39094bSDmitry Karpeev       if (jac->offdiag_use_amat) {
7137dae84e0SHong Zhang 	ierr  = MatCreateSubMatrix(pc->mat,ilink->is,ccis,MAT_INITIAL_MATRIX,&jac->C);CHKERRQ(ierr);
714c84da90fSDmitry Karpeev       } else {
7157dae84e0SHong Zhang 	ierr  = MatCreateSubMatrix(pc->pmat,ilink->is,ccis,MAT_INITIAL_MATRIX,&jac->C);CHKERRQ(ierr);
716c84da90fSDmitry Karpeev       }
717fcfd50ebSBarry Smith       ierr  = ISDestroy(&ccis);CHKERRQ(ierr);
71820252d06SBarry Smith 
719f5236f50SJed Brown       /* Use mat[0] (diagonal block of Amat) preconditioned by pmat[0] to define Schur complement */
72020252d06SBarry Smith       ierr = MatCreate(((PetscObject)jac->mat[0])->comm,&jac->schur);CHKERRQ(ierr);
72120252d06SBarry Smith       ierr = MatSetType(jac->schur,MATSCHURCOMPLEMENT);CHKERRQ(ierr);
722bee83525SDmitry Karpeev       ierr = MatSchurComplementSetSubMatrices(jac->schur,jac->mat[0],jac->pmat[0],jac->B,jac->C,jac->mat[1]);CHKERRQ(ierr);
723470b340bSDmitry Karpeev       ierr = PetscSNPrintf(schurmatprefix, sizeof(schurmatprefix), "%sfieldsplit_%s_", ((PetscObject)pc)->prefix ? ((PetscObject)pc)->prefix : "", ilink->splitname);CHKERRQ(ierr);
724470b340bSDmitry 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? */
725470b340bSDmitry Karpeev       ierr = MatSetOptionsPrefix(jac->schur,schurmatprefix);CHKERRQ(ierr);
726470b340bSDmitry Karpeev       ierr = MatSetFromOptions(jac->schur);CHKERRQ(ierr);
727895c21f2SBarry Smith       ierr = MatGetNullSpace(jac->mat[1], &sp);CHKERRQ(ierr);
72820252d06SBarry Smith       if (sp) {
72920252d06SBarry Smith         ierr = MatSetNullSpace(jac->schur, sp);CHKERRQ(ierr);
73020252d06SBarry Smith       }
73120252d06SBarry Smith 
73220252d06SBarry Smith       ierr = PetscSNPrintf(schurtestoption, sizeof(schurtestoption), "-fieldsplit_%s_inner_", ilink->splitname);CHKERRQ(ierr);
733c5929fdfSBarry Smith       ierr = PetscOptionsFindPairPrefix_Private(((PetscObject)pc)->options,((PetscObject)pc)->prefix, schurtestoption, NULL, &flg);CHKERRQ(ierr);
734514bf10dSMatthew G Knepley       if (flg) {
735514bf10dSMatthew G Knepley         DM  dmInner;
73621635b76SJed Brown         KSP kspInner;
73721635b76SJed Brown 
73821635b76SJed Brown         ierr = MatSchurComplementGetKSP(jac->schur, &kspInner);CHKERRQ(ierr);
73921635b76SJed Brown         ierr = PetscSNPrintf(schurprefix, sizeof(schurprefix), "%sfieldsplit_%s_inner_", ((PetscObject)pc)->prefix ? ((PetscObject)pc)->prefix : "", ilink->splitname);CHKERRQ(ierr);
74021635b76SJed Brown         /* Indent this deeper to emphasize the "inner" nature of this solver. */
74121635b76SJed Brown         ierr = PetscObjectIncrementTabLevel((PetscObject)kspInner, (PetscObject) pc, 2);CHKERRQ(ierr);
74221635b76SJed Brown         ierr = KSPSetOptionsPrefix(kspInner, schurprefix);CHKERRQ(ierr);
743514bf10dSMatthew G Knepley 
744514bf10dSMatthew G Knepley         /* Set DM for new solver */
745bafc1b83SMatthew G Knepley         ierr = KSPGetDM(jac->head->ksp, &dmInner);CHKERRQ(ierr);
74621635b76SJed Brown         ierr = KSPSetDM(kspInner, dmInner);CHKERRQ(ierr);
74721635b76SJed Brown         ierr = KSPSetDMActive(kspInner, PETSC_FALSE);CHKERRQ(ierr);
748514bf10dSMatthew G Knepley       } else {
74921635b76SJed Brown          /* Use the outer solver for the inner solve, but revert the KSPPREONLY from PCFieldSplitSetFields_FieldSplit or
75021635b76SJed Brown           * PCFieldSplitSetIS_FieldSplit. We don't want KSPPREONLY because it makes the Schur complement inexact,
75121635b76SJed Brown           * preventing Schur complement reduction to be an accurate solve. Usually when an iterative solver is used for
75221635b76SJed 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
75321635b76SJed Brown           * GMRES the default. Note that it is also common to use PREONLY for S, in which case S may not be used
75421635b76SJed Brown           * directly, and the user is responsible for setting an inexact method for fieldsplit's A^{-1}. */
75521635b76SJed Brown         ierr = KSPSetType(jac->head->ksp,KSPGMRES);CHKERRQ(ierr);
756514bf10dSMatthew G Knepley         ierr = MatSchurComplementSetKSP(jac->schur,jac->head->ksp);CHKERRQ(ierr);
757bafc1b83SMatthew G Knepley       }
75823ee1639SBarry Smith       ierr = KSPSetOperators(jac->head->ksp,jac->mat[0],jac->pmat[0]);CHKERRQ(ierr);
7595a9f2f41SSatish Balay       ierr = KSPSetFromOptions(jac->head->ksp);CHKERRQ(ierr);
76097bbdb24SBarry Smith       ierr = MatSetFromOptions(jac->schur);CHKERRQ(ierr);
76197bbdb24SBarry Smith 
762443836d0SMatthew G Knepley       ierr = PetscSNPrintf(schurtestoption, sizeof(schurtestoption), "-fieldsplit_%s_upper_", ilink->splitname);CHKERRQ(ierr);
763c5929fdfSBarry Smith       ierr = PetscOptionsFindPairPrefix_Private(((PetscObject)pc)->options,((PetscObject)pc)->prefix, schurtestoption, NULL, &flg);CHKERRQ(ierr);
764443836d0SMatthew G Knepley       if (flg) {
765443836d0SMatthew G Knepley         DM dmInner;
766443836d0SMatthew G Knepley 
767443836d0SMatthew G Knepley         ierr = PetscSNPrintf(schurprefix, sizeof(schurprefix), "%sfieldsplit_%s_upper_", ((PetscObject)pc)->prefix ? ((PetscObject)pc)->prefix : "", ilink->splitname);CHKERRQ(ierr);
76882f516ccSBarry Smith         ierr = KSPCreate(PetscObjectComm((PetscObject)pc), &jac->kspupper);CHKERRQ(ierr);
769422a814eSBarry Smith         ierr = KSPSetErrorIfNotConverged(jac->kspupper,pc->erroriffailure);CHKERRQ(ierr);
770443836d0SMatthew G Knepley         ierr = KSPSetOptionsPrefix(jac->kspupper, schurprefix);CHKERRQ(ierr);
771443836d0SMatthew G Knepley         ierr = KSPGetDM(jac->head->ksp, &dmInner);CHKERRQ(ierr);
772443836d0SMatthew G Knepley         ierr = KSPSetDM(jac->kspupper, dmInner);CHKERRQ(ierr);
773443836d0SMatthew G Knepley         ierr = KSPSetDMActive(jac->kspupper, PETSC_FALSE);CHKERRQ(ierr);
774443836d0SMatthew G Knepley         ierr = KSPSetFromOptions(jac->kspupper);CHKERRQ(ierr);
77523ee1639SBarry Smith         ierr = KSPSetOperators(jac->kspupper,jac->mat[0],jac->pmat[0]);CHKERRQ(ierr);
776443836d0SMatthew G Knepley         ierr = VecDuplicate(jac->head->x, &jac->head->z);CHKERRQ(ierr);
777443836d0SMatthew G Knepley       } else {
778443836d0SMatthew G Knepley         jac->kspupper = jac->head->ksp;
779443836d0SMatthew G Knepley         ierr          = PetscObjectReference((PetscObject) jac->head->ksp);CHKERRQ(ierr);
780443836d0SMatthew G Knepley       }
781443836d0SMatthew G Knepley 
782a7476a74SDmitry Karpeev       if (jac->schurpre == PC_FIELDSPLIT_SCHUR_PRE_SELFP) {
783a7476a74SDmitry Karpeev 	ierr = MatSchurComplementGetPmat(jac->schur,MAT_INITIAL_MATRIX,&jac->schurp);CHKERRQ(ierr);
784a7476a74SDmitry Karpeev       }
785ce94432eSBarry Smith       ierr = KSPCreate(PetscObjectComm((PetscObject)pc),&jac->kspschur);CHKERRQ(ierr);
786422a814eSBarry Smith       ierr = KSPSetErrorIfNotConverged(jac->kspschur,pc->erroriffailure);CHKERRQ(ierr);
78797bbdb24SBarry Smith       ierr = PetscLogObjectParent((PetscObject)pc,(PetscObject)jac->kspschur);CHKERRQ(ierr);
78820252d06SBarry Smith       ierr = PetscObjectIncrementTabLevel((PetscObject)jac->kspschur,(PetscObject)pc,1);CHKERRQ(ierr);
78997bbdb24SBarry Smith       if (jac->schurpre == PC_FIELDSPLIT_SCHUR_PRE_SELF) {
7907233a360SDmitry Karpeev         PC pcschur;
7917233a360SDmitry Karpeev         ierr = KSPGetPC(jac->kspschur,&pcschur);CHKERRQ(ierr);
7927233a360SDmitry Karpeev         ierr = PCSetType(pcschur,PCNONE);CHKERRQ(ierr);
79397bbdb24SBarry Smith         /* Note: This is bad if there exist preconditioners for MATSCHURCOMPLEMENT */
794e74569cdSMatthew G. Knepley       } else if (jac->schurpre == PC_FIELDSPLIT_SCHUR_PRE_FULL) {
795e74569cdSMatthew G. Knepley         ierr = MatSchurComplementComputeExplicitOperator(jac->schur, &jac->schur_user);CHKERRQ(ierr);
79697bbdb24SBarry Smith       }
79723ee1639SBarry Smith       ierr = KSPSetOperators(jac->kspschur,jac->schur,FieldSplitSchurPre(jac));CHKERRQ(ierr);
79897bbdb24SBarry Smith       ierr = KSPGetOptionsPrefix(jac->head->next->ksp, &Dprefix);CHKERRQ(ierr);
79997bbdb24SBarry Smith       ierr = KSPSetOptionsPrefix(jac->kspschur,         Dprefix);CHKERRQ(ierr);
800c096484dSStefano Zampini       /* propagate DM */
801b20b4189SMatthew G. Knepley       {
802b20b4189SMatthew G. Knepley         DM sdm;
803b20b4189SMatthew G. Knepley         ierr = KSPGetDM(jac->head->next->ksp, &sdm);CHKERRQ(ierr);
804b20b4189SMatthew G. Knepley         if (sdm) {
805b20b4189SMatthew G. Knepley           ierr = KSPSetDM(jac->kspschur, sdm);CHKERRQ(ierr);
806b20b4189SMatthew G. Knepley           ierr = KSPSetDMActive(jac->kspschur, PETSC_FALSE);CHKERRQ(ierr);
807b20b4189SMatthew G. Knepley         }
808b20b4189SMatthew G. Knepley       }
80997bbdb24SBarry Smith       /* really want setfromoptions called in PCSetFromOptions_FieldSplit(), but it is not ready yet */
81097bbdb24SBarry Smith       /* need to call this every time, since the jac->kspschur is freshly created, otherwise its options never get set */
81197bbdb24SBarry Smith       ierr = KSPSetFromOptions(jac->kspschur);CHKERRQ(ierr);
81297bbdb24SBarry Smith     }
81397bbdb24SBarry Smith 
8145a9f2f41SSatish Balay     /* HACK: special support to forward L and Lp matrices that might be used by PCLSC */
8158caf3d72SBarry Smith     ierr = PetscSNPrintf(lscname,sizeof(lscname),"%s_LSC_L",ilink->splitname);CHKERRQ(ierr);
816519d70e2SJed Brown     ierr = PetscObjectQuery((PetscObject)pc->mat,lscname,(PetscObject*)&LSC_L);CHKERRQ(ierr);
8173b224e63SBarry Smith     if (!LSC_L) {ierr = PetscObjectQuery((PetscObject)pc->pmat,lscname,(PetscObject*)&LSC_L);CHKERRQ(ierr);}
818c1570756SJed Brown     if (LSC_L) {ierr = PetscObjectCompose((PetscObject)jac->schur,"LSC_L",(PetscObject)LSC_L);CHKERRQ(ierr);}
8198caf3d72SBarry Smith     ierr = PetscSNPrintf(lscname,sizeof(lscname),"%s_LSC_Lp",ilink->splitname);CHKERRQ(ierr);
82097bbdb24SBarry Smith     ierr = PetscObjectQuery((PetscObject)pc->pmat,lscname,(PetscObject*)&LSC_L);CHKERRQ(ierr);
8215a9f2f41SSatish Balay     if (!LSC_L) {ierr = PetscObjectQuery((PetscObject)pc->mat,lscname,(PetscObject*)&LSC_L);CHKERRQ(ierr);}
8220971522cSBarry Smith     if (LSC_L) {ierr = PetscObjectCompose((PetscObject)jac->schur,"LSC_Lp",(PetscObject)LSC_L);CHKERRQ(ierr);}
82397bbdb24SBarry Smith   } else {
82468bd789dSDmitry Karpeev     /* set up the individual splits' PCs */
8250971522cSBarry Smith     i     = 0;
8260971522cSBarry Smith     ilink = jac->head;
8270971522cSBarry Smith     while (ilink) {
82823ee1639SBarry Smith       ierr = KSPSetOperators(ilink->ksp,jac->mat[i],jac->pmat[i]);CHKERRQ(ierr);
8290971522cSBarry Smith       /* really want setfromoptions called in PCSetFromOptions_FieldSplit(), but it is not ready yet */
8300971522cSBarry Smith       if (!jac->suboptionsset) {ierr = KSPSetFromOptions(ilink->ksp);CHKERRQ(ierr);}
8310971522cSBarry Smith       i++;
8320971522cSBarry Smith       ilink = ilink->next;
8330971522cSBarry Smith     }
8343b224e63SBarry Smith   }
8353b224e63SBarry Smith 
836c1570756SJed Brown   jac->suboptionsset = PETSC_TRUE;
8370971522cSBarry Smith   PetscFunctionReturn(0);
8380971522cSBarry Smith }
8390971522cSBarry Smith 
8405a9f2f41SSatish Balay #define FieldSplitSplitSolveAdd(ilink,xx,yy) \
841ca9f406cSSatish Balay   (VecScatterBegin(ilink->sctx,xx,ilink->x,INSERT_VALUES,SCATTER_FORWARD) || \
842ca9f406cSSatish Balay    VecScatterEnd(ilink->sctx,xx,ilink->x,INSERT_VALUES,SCATTER_FORWARD) || \
8439df09d43SBarry Smith    PetscLogEventBegin(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL) ||\
8445a9f2f41SSatish Balay    KSPSolve(ilink->ksp,ilink->x,ilink->y) ||                               \
8459df09d43SBarry Smith    PetscLogEventEnd(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL) ||\
846ca9f406cSSatish Balay    VecScatterBegin(ilink->sctx,ilink->y,yy,ADD_VALUES,SCATTER_REVERSE) ||  \
847ca9f406cSSatish Balay    VecScatterEnd(ilink->sctx,ilink->y,yy,ADD_VALUES,SCATTER_REVERSE))
84879416396SBarry Smith 
8493b224e63SBarry Smith static PetscErrorCode PCApply_FieldSplit_Schur(PC pc,Vec x,Vec y)
8503b224e63SBarry Smith {
8513b224e63SBarry Smith   PC_FieldSplit     *jac = (PC_FieldSplit*)pc->data;
8523b224e63SBarry Smith   PetscErrorCode    ierr;
8533b224e63SBarry Smith   PC_FieldSplitLink ilinkA = jac->head, ilinkD = ilinkA->next;
854443836d0SMatthew G Knepley   KSP               kspA   = ilinkA->ksp, kspLower = kspA, kspUpper = jac->kspupper;
8553b224e63SBarry Smith 
8563b224e63SBarry Smith   PetscFunctionBegin;
857c5d2311dSJed Brown   switch (jac->schurfactorization) {
858c9c6ffaaSJed Brown   case PC_FIELDSPLIT_SCHUR_FACT_DIAG:
859a04f6461SBarry Smith     /* [A00 0; 0 -S], positive definite, suitable for MINRES */
860c5d2311dSJed Brown     ierr = VecScatterBegin(ilinkA->sctx,x,ilinkA->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
861c5d2311dSJed Brown     ierr = VecScatterBegin(ilinkD->sctx,x,ilinkD->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
862c5d2311dSJed Brown     ierr = VecScatterEnd(ilinkA->sctx,x,ilinkA->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
8639df09d43SBarry Smith     ierr = PetscLogEventBegin(ilinkA->event,kspA,ilinkA->x,ilinkA->y,NULL);CHKERRQ(ierr);
864443836d0SMatthew G Knepley     ierr = KSPSolve(kspA,ilinkA->x,ilinkA->y);CHKERRQ(ierr);
8659df09d43SBarry Smith     ierr = PetscLogEventEnd(ilinkA->event,kspA,ilinkA->x,ilinkA->y,NULL);CHKERRQ(ierr);
866c5d2311dSJed Brown     ierr = VecScatterBegin(ilinkA->sctx,ilinkA->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
867c5d2311dSJed Brown     ierr = VecScatterEnd(ilinkD->sctx,x,ilinkD->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
8689df09d43SBarry Smith     ierr = PetscLogEventBegin(KSP_Solve_FS_S,jac->kspschur,ilinkD->x,ilinkD->y,NULL);CHKERRQ(ierr);
869c5d2311dSJed Brown     ierr = KSPSolve(jac->kspschur,ilinkD->x,ilinkD->y);CHKERRQ(ierr);
8709df09d43SBarry Smith     ierr = PetscLogEventEnd(KSP_Solve_FS_S,jac->kspschur,ilinkD->x,ilinkD->y,NULL);CHKERRQ(ierr);
871c096484dSStefano Zampini     ierr = VecScale(ilinkD->y,jac->schurscale);CHKERRQ(ierr);
872c5d2311dSJed Brown     ierr = VecScatterBegin(ilinkD->sctx,ilinkD->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
873c5d2311dSJed Brown     ierr = VecScatterEnd(ilinkA->sctx,ilinkA->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
874c5d2311dSJed Brown     ierr = VecScatterEnd(ilinkD->sctx,ilinkD->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
875c5d2311dSJed Brown     break;
876c9c6ffaaSJed Brown   case PC_FIELDSPLIT_SCHUR_FACT_LOWER:
877a04f6461SBarry Smith     /* [A00 0; A10 S], suitable for left preconditioning */
878c5d2311dSJed Brown     ierr = VecScatterBegin(ilinkA->sctx,x,ilinkA->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
879c5d2311dSJed Brown     ierr = VecScatterEnd(ilinkA->sctx,x,ilinkA->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
8809df09d43SBarry Smith     ierr = PetscLogEventBegin(ilinkA->event,kspA,ilinkA->x,ilinkA->y,NULL);CHKERRQ(ierr);
881443836d0SMatthew G Knepley     ierr = KSPSolve(kspA,ilinkA->x,ilinkA->y);CHKERRQ(ierr);
8829df09d43SBarry Smith     ierr = PetscLogEventEnd(ilinkA->event,kspA,ilinkA->x,ilinkA->y,NULL);CHKERRQ(ierr);
883c5d2311dSJed Brown     ierr = MatMult(jac->C,ilinkA->y,ilinkD->x);CHKERRQ(ierr);
884c5d2311dSJed Brown     ierr = VecScale(ilinkD->x,-1.);CHKERRQ(ierr);
885c5d2311dSJed Brown     ierr = VecScatterBegin(ilinkD->sctx,x,ilinkD->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
886c5d2311dSJed Brown     ierr = VecScatterBegin(ilinkA->sctx,ilinkA->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
887c5d2311dSJed Brown     ierr = VecScatterEnd(ilinkD->sctx,x,ilinkD->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
8889df09d43SBarry Smith     ierr = PetscLogEventBegin(KSP_Solve_FS_S,jac->kspschur,ilinkD->x,ilinkD->y,NULL);CHKERRQ(ierr);
889c5d2311dSJed Brown     ierr = KSPSolve(jac->kspschur,ilinkD->x,ilinkD->y);CHKERRQ(ierr);
8909df09d43SBarry Smith     ierr = PetscLogEventEnd(KSP_Solve_FS_S,jac->kspschur,ilinkD->x,ilinkD->y,NULL);CHKERRQ(ierr);
891c5d2311dSJed Brown     ierr = VecScatterBegin(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     ierr = VecScatterEnd(ilinkD->sctx,ilinkD->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
894c5d2311dSJed Brown     break;
895c9c6ffaaSJed Brown   case PC_FIELDSPLIT_SCHUR_FACT_UPPER:
896a04f6461SBarry Smith     /* [A00 A01; 0 S], suitable for right preconditioning */
897c5d2311dSJed Brown     ierr = VecScatterBegin(ilinkD->sctx,x,ilinkD->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
898c5d2311dSJed Brown     ierr = VecScatterEnd(ilinkD->sctx,x,ilinkD->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
8999df09d43SBarry Smith     ierr = PetscLogEventBegin(KSP_Solve_FS_S,jac->kspschur,ilinkD->x,ilinkD->y,NULL);CHKERRQ(ierr);
900c5d2311dSJed Brown     ierr = KSPSolve(jac->kspschur,ilinkD->x,ilinkD->y);CHKERRQ(ierr);
9019df09d43SBarry Smith     ierr = PetscLogEventEnd(KSP_Solve_FS_S,jac->kspschur,ilinkD->x,ilinkD->y,NULL);CHKERRQ(ierr);    ierr = MatMult(jac->B,ilinkD->y,ilinkA->x);CHKERRQ(ierr);
902c5d2311dSJed Brown     ierr = VecScale(ilinkA->x,-1.);CHKERRQ(ierr);
903c5d2311dSJed Brown     ierr = VecScatterBegin(ilinkA->sctx,x,ilinkA->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
904c5d2311dSJed Brown     ierr = VecScatterBegin(ilinkD->sctx,ilinkD->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
905c5d2311dSJed Brown     ierr = VecScatterEnd(ilinkA->sctx,x,ilinkA->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
9069df09d43SBarry Smith     ierr = PetscLogEventBegin(ilinkA->event,kspA,ilinkA->x,ilinkA->y,NULL);CHKERRQ(ierr);
907443836d0SMatthew G Knepley     ierr = KSPSolve(kspA,ilinkA->x,ilinkA->y);CHKERRQ(ierr);
9089df09d43SBarry Smith     ierr = PetscLogEventEnd(ilinkA->event,kspA,ilinkA->x,ilinkA->y,NULL);CHKERRQ(ierr);
909c5d2311dSJed Brown     ierr = VecScatterBegin(ilinkA->sctx,ilinkA->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
910c5d2311dSJed Brown     ierr = VecScatterEnd(ilinkD->sctx,ilinkD->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
911c5d2311dSJed Brown     ierr = VecScatterEnd(ilinkA->sctx,ilinkA->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
912c5d2311dSJed Brown     break;
913c9c6ffaaSJed Brown   case PC_FIELDSPLIT_SCHUR_FACT_FULL:
914a04f6461SBarry 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 */
9153b224e63SBarry Smith     ierr = VecScatterBegin(ilinkA->sctx,x,ilinkA->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
9163b224e63SBarry Smith     ierr = VecScatterEnd(ilinkA->sctx,x,ilinkA->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
9179df09d43SBarry Smith     ierr = PetscLogEventBegin(KSP_Solve_FS_L,kspLower,ilinkA->x,ilinkA->y,NULL);CHKERRQ(ierr);
918443836d0SMatthew G Knepley     ierr = KSPSolve(kspLower,ilinkA->x,ilinkA->y);CHKERRQ(ierr);
9199df09d43SBarry Smith     ierr = PetscLogEventEnd(KSP_Solve_FS_L,kspLower,ilinkA->x,ilinkA->y,NULL);CHKERRQ(ierr);
9203b224e63SBarry Smith     ierr = MatMult(jac->C,ilinkA->y,ilinkD->x);CHKERRQ(ierr);
9213b224e63SBarry Smith     ierr = VecScale(ilinkD->x,-1.0);CHKERRQ(ierr);
9223b224e63SBarry Smith     ierr = VecScatterBegin(ilinkD->sctx,x,ilinkD->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
9233b224e63SBarry Smith     ierr = VecScatterEnd(ilinkD->sctx,x,ilinkD->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
9243b224e63SBarry Smith 
9259df09d43SBarry Smith     ierr = PetscLogEventBegin(KSP_Solve_FS_S,jac->kspschur,ilinkD->x,ilinkD->y,NULL);CHKERRQ(ierr);
9263b224e63SBarry Smith     ierr = KSPSolve(jac->kspschur,ilinkD->x,ilinkD->y);CHKERRQ(ierr);
9279df09d43SBarry Smith     ierr = PetscLogEventEnd(KSP_Solve_FS_S,jac->kspschur,ilinkD->x,ilinkD->y,NULL);CHKERRQ(ierr);
9283b224e63SBarry Smith     ierr = VecScatterBegin(ilinkD->sctx,ilinkD->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
9293b224e63SBarry Smith     ierr = VecScatterEnd(ilinkD->sctx,ilinkD->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
9303b224e63SBarry Smith 
931443836d0SMatthew G Knepley     if (kspUpper == kspA) {
9323b224e63SBarry Smith       ierr = MatMult(jac->B,ilinkD->y,ilinkA->y);CHKERRQ(ierr);
9333b224e63SBarry Smith       ierr = VecAXPY(ilinkA->x,-1.0,ilinkA->y);CHKERRQ(ierr);
9349df09d43SBarry Smith       ierr = PetscLogEventBegin(ilinkA->event,kspA,ilinkA->x,ilinkA->y,NULL);CHKERRQ(ierr);
935443836d0SMatthew G Knepley       ierr = KSPSolve(kspA,ilinkA->x,ilinkA->y);CHKERRQ(ierr);
9369df09d43SBarry Smith       ierr = PetscLogEventEnd(ilinkA->event,kspA,ilinkA->x,ilinkA->y,NULL);CHKERRQ(ierr);
937443836d0SMatthew G Knepley     } else {
9389df09d43SBarry Smith       ierr = PetscLogEventBegin(ilinkA->event,kspA,ilinkA->x,ilinkA->y,NULL);CHKERRQ(ierr);
939443836d0SMatthew G Knepley       ierr = KSPSolve(kspA,ilinkA->x,ilinkA->y);CHKERRQ(ierr);
9409df09d43SBarry Smith       ierr = PetscLogEventEnd(ilinkA->event,kspA,ilinkA->x,ilinkA->y,NULL);CHKERRQ(ierr);
941443836d0SMatthew G Knepley       ierr = MatMult(jac->B,ilinkD->y,ilinkA->x);CHKERRQ(ierr);
9429df09d43SBarry Smith       ierr = PetscLogEventBegin(KSP_Solve_FS_U,kspUpper,ilinkA->x,ilinkA->z,NULL);CHKERRQ(ierr);
943443836d0SMatthew G Knepley       ierr = KSPSolve(kspUpper,ilinkA->x,ilinkA->z);CHKERRQ(ierr);
9449df09d43SBarry Smith       ierr = PetscLogEventEnd(KSP_Solve_FS_U,kspUpper,ilinkA->x,ilinkA->z,NULL);CHKERRQ(ierr);
945443836d0SMatthew G Knepley       ierr = VecAXPY(ilinkA->y,-1.0,ilinkA->z);CHKERRQ(ierr);
946443836d0SMatthew G Knepley     }
9473b224e63SBarry Smith     ierr = VecScatterBegin(ilinkA->sctx,ilinkA->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
9483b224e63SBarry Smith     ierr = VecScatterEnd(ilinkA->sctx,ilinkA->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
949c5d2311dSJed Brown   }
9503b224e63SBarry Smith   PetscFunctionReturn(0);
9513b224e63SBarry Smith }
9523b224e63SBarry Smith 
9530971522cSBarry Smith static PetscErrorCode PCApply_FieldSplit(PC pc,Vec x,Vec y)
9540971522cSBarry Smith {
9550971522cSBarry Smith   PC_FieldSplit      *jac = (PC_FieldSplit*)pc->data;
9560971522cSBarry Smith   PetscErrorCode     ierr;
9575a9f2f41SSatish Balay   PC_FieldSplitLink  ilink = jac->head;
958939b8a20SBarry Smith   PetscInt           cnt,bs;
959568ed31eSHong Zhang   KSPConvergedReason reason;
9600971522cSBarry Smith 
9610971522cSBarry Smith   PetscFunctionBegin;
96279416396SBarry Smith   if (jac->type == PC_COMPOSITE_ADDITIVE) {
9631b9fc7fcSBarry Smith     if (jac->defaultsplit) {
964939b8a20SBarry Smith       ierr = VecGetBlockSize(x,&bs);CHKERRQ(ierr);
965ce94432eSBarry 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);
966939b8a20SBarry Smith       ierr = VecGetBlockSize(y,&bs);CHKERRQ(ierr);
967ce94432eSBarry 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);
9680971522cSBarry Smith       ierr = VecStrideGatherAll(x,jac->x,INSERT_VALUES);CHKERRQ(ierr);
9695a9f2f41SSatish Balay       while (ilink) {
9709df09d43SBarry Smith         ierr  = PetscLogEventBegin(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL);CHKERRQ(ierr);
9715a9f2f41SSatish Balay         ierr  = KSPSolve(ilink->ksp,ilink->x,ilink->y);CHKERRQ(ierr);
9729df09d43SBarry Smith         ierr  = PetscLogEventEnd(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL);CHKERRQ(ierr);
973568ed31eSHong Zhang         ierr = KSPGetConvergedReason(ilink->ksp,&reason);CHKERRQ(ierr);
974568ed31eSHong Zhang         if (reason == KSP_DIVERGED_PCSETUP_FAILED) {
975568ed31eSHong Zhang           pc->failedreason = PC_SUBPC_ERROR;
976568ed31eSHong Zhang         }
9775a9f2f41SSatish Balay         ilink = ilink->next;
9780971522cSBarry Smith       }
9790971522cSBarry Smith       ierr = VecStrideScatterAll(jac->y,y,INSERT_VALUES);CHKERRQ(ierr);
9801b9fc7fcSBarry Smith     } else {
981efb30889SBarry Smith       ierr = VecSet(y,0.0);CHKERRQ(ierr);
9825a9f2f41SSatish Balay       while (ilink) {
9835a9f2f41SSatish Balay         ierr  = FieldSplitSplitSolveAdd(ilink,x,y);CHKERRQ(ierr);
984568ed31eSHong Zhang         ierr = KSPGetConvergedReason(ilink->ksp,&reason);CHKERRQ(ierr);
985568ed31eSHong Zhang         if (reason == KSP_DIVERGED_PCSETUP_FAILED) {
986568ed31eSHong Zhang           pc->failedreason = PC_SUBPC_ERROR;
987568ed31eSHong Zhang         }
9885a9f2f41SSatish Balay         ilink = ilink->next;
9891b9fc7fcSBarry Smith       }
9901b9fc7fcSBarry Smith     }
991e52d2c62SBarry Smith   } else if (jac->type == PC_COMPOSITE_MULTIPLICATIVE && jac->nsplits == 2) {
992e52d2c62SBarry Smith     ierr = VecSet(y,0.0);CHKERRQ(ierr);
993e52d2c62SBarry Smith     /* solve on first block for first block variables */
994e52d2c62SBarry Smith     ierr = VecScatterBegin(ilink->sctx,x,ilink->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
995e52d2c62SBarry Smith     ierr = VecScatterEnd(ilink->sctx,x,ilink->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
9969df09d43SBarry Smith     ierr = PetscLogEventBegin(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL);CHKERRQ(ierr);
997e52d2c62SBarry Smith     ierr = KSPSolve(ilink->ksp,ilink->x,ilink->y);CHKERRQ(ierr);
9989df09d43SBarry Smith     ierr = PetscLogEventEnd(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL);CHKERRQ(ierr);
999568ed31eSHong Zhang     ierr = KSPGetConvergedReason(ilink->ksp,&reason);CHKERRQ(ierr);
1000568ed31eSHong Zhang     if (reason == KSP_DIVERGED_PCSETUP_FAILED) {
1001568ed31eSHong Zhang       pc->failedreason = PC_SUBPC_ERROR;
1002568ed31eSHong Zhang     }
1003e52d2c62SBarry Smith     ierr = VecScatterBegin(ilink->sctx,ilink->y,y,ADD_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
1004e52d2c62SBarry Smith     ierr = VecScatterEnd(ilink->sctx,ilink->y,y,ADD_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
1005e52d2c62SBarry Smith 
1006e52d2c62SBarry Smith     /* compute the residual only onto second block variables using first block variables */
1007e52d2c62SBarry Smith     ierr = MatMult(jac->Afield[1],ilink->y,ilink->next->x);CHKERRQ(ierr);
1008e52d2c62SBarry Smith     ilink = ilink->next;
1009e52d2c62SBarry Smith     ierr = VecScale(ilink->x,-1.0);CHKERRQ(ierr);
1010e52d2c62SBarry Smith     ierr = VecScatterBegin(ilink->sctx,x,ilink->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
1011e52d2c62SBarry Smith     ierr = VecScatterEnd(ilink->sctx,x,ilink->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
1012e52d2c62SBarry Smith 
1013e52d2c62SBarry Smith     /* solve on second block variables */
10149df09d43SBarry Smith     ierr = PetscLogEventBegin(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL);CHKERRQ(ierr);
1015e52d2c62SBarry Smith     ierr = KSPSolve(ilink->ksp,ilink->x,ilink->y);CHKERRQ(ierr);
10169df09d43SBarry Smith     ierr = PetscLogEventEnd(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL);CHKERRQ(ierr);
1017568ed31eSHong Zhang     ierr = KSPGetConvergedReason(ilink->ksp,&reason);CHKERRQ(ierr);
1018568ed31eSHong Zhang     if (reason == KSP_DIVERGED_PCSETUP_FAILED) {
1019568ed31eSHong Zhang       pc->failedreason = PC_SUBPC_ERROR;
1020568ed31eSHong Zhang     }
1021e52d2c62SBarry Smith     ierr = VecScatterBegin(ilink->sctx,ilink->y,y,ADD_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
1022e52d2c62SBarry Smith     ierr = VecScatterEnd(ilink->sctx,ilink->y,y,ADD_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
102316913363SBarry Smith   } else if (jac->type == PC_COMPOSITE_MULTIPLICATIVE || jac->type == PC_COMPOSITE_SYMMETRIC_MULTIPLICATIVE) {
102479416396SBarry Smith     if (!jac->w1) {
102579416396SBarry Smith       ierr = VecDuplicate(x,&jac->w1);CHKERRQ(ierr);
102679416396SBarry Smith       ierr = VecDuplicate(x,&jac->w2);CHKERRQ(ierr);
102779416396SBarry Smith     }
1028efb30889SBarry Smith     ierr = VecSet(y,0.0);CHKERRQ(ierr);
10295a9f2f41SSatish Balay     ierr = FieldSplitSplitSolveAdd(ilink,x,y);CHKERRQ(ierr);
1030568ed31eSHong Zhang     ierr = KSPGetConvergedReason(ilink->ksp,&reason);CHKERRQ(ierr);
1031568ed31eSHong Zhang     if (reason == KSP_DIVERGED_PCSETUP_FAILED) {
1032568ed31eSHong Zhang       pc->failedreason = PC_SUBPC_ERROR;
1033568ed31eSHong Zhang     }
10343e197d65SBarry Smith     cnt  = 1;
10355a9f2f41SSatish Balay     while (ilink->next) {
10365a9f2f41SSatish Balay       ilink = ilink->next;
10373e197d65SBarry Smith       /* compute the residual only over the part of the vector needed */
10383e197d65SBarry Smith       ierr = MatMult(jac->Afield[cnt++],y,ilink->x);CHKERRQ(ierr);
10393e197d65SBarry Smith       ierr = VecScale(ilink->x,-1.0);CHKERRQ(ierr);
10403e197d65SBarry Smith       ierr = VecScatterBegin(ilink->sctx,x,ilink->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
10413e197d65SBarry Smith       ierr = VecScatterEnd(ilink->sctx,x,ilink->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
10429df09d43SBarry Smith       ierr = PetscLogEventBegin(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL);CHKERRQ(ierr);
10433e197d65SBarry Smith       ierr = KSPSolve(ilink->ksp,ilink->x,ilink->y);CHKERRQ(ierr);
10449df09d43SBarry Smith       ierr = PetscLogEventEnd(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL);CHKERRQ(ierr);
10452618eb8fSHong Zhang       ierr = KSPGetConvergedReason(ilink->ksp,&reason);CHKERRQ(ierr);
10462618eb8fSHong Zhang       if (reason == KSP_DIVERGED_PCSETUP_FAILED) {
10472618eb8fSHong Zhang         pc->failedreason = PC_SUBPC_ERROR;
10482618eb8fSHong Zhang       }
10493e197d65SBarry Smith       ierr = VecScatterBegin(ilink->sctx,ilink->y,y,ADD_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
10503e197d65SBarry Smith       ierr = VecScatterEnd(ilink->sctx,ilink->y,y,ADD_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
10513e197d65SBarry Smith     }
105251f519a2SBarry Smith     if (jac->type == PC_COMPOSITE_SYMMETRIC_MULTIPLICATIVE) {
105311755939SBarry Smith       cnt -= 2;
105451f519a2SBarry Smith       while (ilink->previous) {
105551f519a2SBarry Smith         ilink = ilink->previous;
105611755939SBarry Smith         /* compute the residual only over the part of the vector needed */
105711755939SBarry Smith         ierr = MatMult(jac->Afield[cnt--],y,ilink->x);CHKERRQ(ierr);
105811755939SBarry Smith         ierr = VecScale(ilink->x,-1.0);CHKERRQ(ierr);
105911755939SBarry Smith         ierr = VecScatterBegin(ilink->sctx,x,ilink->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
106011755939SBarry Smith         ierr = VecScatterEnd(ilink->sctx,x,ilink->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
10619df09d43SBarry Smith         ierr = PetscLogEventBegin(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL);CHKERRQ(ierr);
106211755939SBarry Smith         ierr = KSPSolve(ilink->ksp,ilink->x,ilink->y);CHKERRQ(ierr);
10639df09d43SBarry Smith         ierr = PetscLogEventEnd(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL);CHKERRQ(ierr);
1064568ed31eSHong Zhang         ierr = KSPGetConvergedReason(ilink->ksp,&reason);CHKERRQ(ierr);
1065568ed31eSHong Zhang         if (reason == KSP_DIVERGED_PCSETUP_FAILED) {
1066568ed31eSHong Zhang           pc->failedreason = PC_SUBPC_ERROR;
1067568ed31eSHong Zhang         }
106811755939SBarry Smith         ierr = VecScatterBegin(ilink->sctx,ilink->y,y,ADD_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
106911755939SBarry Smith         ierr = VecScatterEnd(ilink->sctx,ilink->y,y,ADD_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
107051f519a2SBarry Smith       }
107111755939SBarry Smith     }
1072ce94432eSBarry Smith   } else SETERRQ1(PetscObjectComm((PetscObject)pc),PETSC_ERR_SUP,"Unsupported or unknown composition",(int) jac->type);
10730971522cSBarry Smith   PetscFunctionReturn(0);
10740971522cSBarry Smith }
10750971522cSBarry Smith 
1076421e10b8SBarry Smith #define FieldSplitSplitSolveAddTranspose(ilink,xx,yy) \
1077ca9f406cSSatish Balay   (VecScatterBegin(ilink->sctx,xx,ilink->y,INSERT_VALUES,SCATTER_FORWARD) || \
1078ca9f406cSSatish Balay    VecScatterEnd(ilink->sctx,xx,ilink->y,INSERT_VALUES,SCATTER_FORWARD) || \
10799df09d43SBarry Smith    PetscLogEventBegin(ilink->event,ilink->ksp,ilink->y,ilink->x,NULL) || \
1080421e10b8SBarry Smith    KSPSolveTranspose(ilink->ksp,ilink->y,ilink->x) ||                  \
10819df09d43SBarry Smith    PetscLogEventBegin(ilink->event,ilink->ksp,ilink->y,ilink->x,NULL) || \
1082ca9f406cSSatish Balay    VecScatterBegin(ilink->sctx,ilink->x,yy,ADD_VALUES,SCATTER_REVERSE) || \
1083ca9f406cSSatish Balay    VecScatterEnd(ilink->sctx,ilink->x,yy,ADD_VALUES,SCATTER_REVERSE))
1084421e10b8SBarry Smith 
1085421e10b8SBarry Smith static PetscErrorCode PCApplyTranspose_FieldSplit(PC pc,Vec x,Vec y)
1086421e10b8SBarry Smith {
1087421e10b8SBarry Smith   PC_FieldSplit      *jac = (PC_FieldSplit*)pc->data;
1088421e10b8SBarry Smith   PetscErrorCode     ierr;
1089421e10b8SBarry Smith   PC_FieldSplitLink  ilink = jac->head;
1090939b8a20SBarry Smith   PetscInt           bs;
1091291dd214SHong Zhang   KSPConvergedReason reason;
1092421e10b8SBarry Smith 
1093421e10b8SBarry Smith   PetscFunctionBegin;
1094421e10b8SBarry Smith   if (jac->type == PC_COMPOSITE_ADDITIVE) {
1095421e10b8SBarry Smith     if (jac->defaultsplit) {
1096939b8a20SBarry Smith       ierr = VecGetBlockSize(x,&bs);CHKERRQ(ierr);
1097ce94432eSBarry 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);
1098939b8a20SBarry Smith       ierr = VecGetBlockSize(y,&bs);CHKERRQ(ierr);
1099ce94432eSBarry 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);
1100421e10b8SBarry Smith       ierr = VecStrideGatherAll(x,jac->x,INSERT_VALUES);CHKERRQ(ierr);
1101421e10b8SBarry Smith       while (ilink) {
11029df09d43SBarry Smith         ierr = PetscLogEventBegin(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL);CHKERRQ(ierr);
1103421e10b8SBarry Smith         ierr  = KSPSolveTranspose(ilink->ksp,ilink->x,ilink->y);CHKERRQ(ierr);
11049df09d43SBarry Smith         ierr = PetscLogEventEnd(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL);CHKERRQ(ierr);
11052618eb8fSHong Zhang         ierr = KSPGetConvergedReason(ilink->ksp,&reason);CHKERRQ(ierr);
11062618eb8fSHong Zhang         if (reason == KSP_DIVERGED_PCSETUP_FAILED) {
11072618eb8fSHong Zhang           pc->failedreason = PC_SUBPC_ERROR;
11082618eb8fSHong Zhang         }
1109421e10b8SBarry Smith         ilink = ilink->next;
1110421e10b8SBarry Smith       }
1111421e10b8SBarry Smith       ierr = VecStrideScatterAll(jac->y,y,INSERT_VALUES);CHKERRQ(ierr);
1112421e10b8SBarry Smith     } else {
1113421e10b8SBarry Smith       ierr = VecSet(y,0.0);CHKERRQ(ierr);
1114421e10b8SBarry Smith       while (ilink) {
1115421e10b8SBarry Smith         ierr = FieldSplitSplitSolveAddTranspose(ilink,x,y);CHKERRQ(ierr);
11162618eb8fSHong Zhang         ierr = KSPGetConvergedReason(ilink->ksp,&reason);CHKERRQ(ierr);
11172618eb8fSHong Zhang         if (reason == KSP_DIVERGED_PCSETUP_FAILED) {
11182618eb8fSHong Zhang           pc->failedreason = PC_SUBPC_ERROR;
11192618eb8fSHong Zhang         }
1120421e10b8SBarry Smith         ilink = ilink->next;
1121421e10b8SBarry Smith       }
1122421e10b8SBarry Smith     }
1123421e10b8SBarry Smith   } else {
1124421e10b8SBarry Smith     if (!jac->w1) {
1125421e10b8SBarry Smith       ierr = VecDuplicate(x,&jac->w1);CHKERRQ(ierr);
1126421e10b8SBarry Smith       ierr = VecDuplicate(x,&jac->w2);CHKERRQ(ierr);
1127421e10b8SBarry Smith     }
1128421e10b8SBarry Smith     ierr = VecSet(y,0.0);CHKERRQ(ierr);
1129421e10b8SBarry Smith     if (jac->type == PC_COMPOSITE_SYMMETRIC_MULTIPLICATIVE) {
1130421e10b8SBarry Smith       ierr = FieldSplitSplitSolveAddTranspose(ilink,x,y);CHKERRQ(ierr);
11312618eb8fSHong Zhang       ierr = KSPGetConvergedReason(ilink->ksp,&reason);CHKERRQ(ierr);
11322618eb8fSHong Zhang       if (reason == KSP_DIVERGED_PCSETUP_FAILED) {
11332618eb8fSHong Zhang         pc->failedreason = PC_SUBPC_ERROR;
11342618eb8fSHong Zhang       }
1135421e10b8SBarry Smith       while (ilink->next) {
1136421e10b8SBarry Smith         ilink = ilink->next;
11379989ab13SBarry Smith         ierr  = MatMultTranspose(pc->mat,y,jac->w1);CHKERRQ(ierr);
1138421e10b8SBarry Smith         ierr  = VecWAXPY(jac->w2,-1.0,jac->w1,x);CHKERRQ(ierr);
1139421e10b8SBarry Smith         ierr  = FieldSplitSplitSolveAddTranspose(ilink,jac->w2,y);CHKERRQ(ierr);
1140421e10b8SBarry Smith       }
1141421e10b8SBarry Smith       while (ilink->previous) {
1142421e10b8SBarry Smith         ilink = ilink->previous;
11439989ab13SBarry Smith         ierr  = MatMultTranspose(pc->mat,y,jac->w1);CHKERRQ(ierr);
1144421e10b8SBarry Smith         ierr  = VecWAXPY(jac->w2,-1.0,jac->w1,x);CHKERRQ(ierr);
1145421e10b8SBarry Smith         ierr  = FieldSplitSplitSolveAddTranspose(ilink,jac->w2,y);CHKERRQ(ierr);
1146421e10b8SBarry Smith       }
1147421e10b8SBarry Smith     } else {
1148421e10b8SBarry Smith       while (ilink->next) {   /* get to last entry in linked list */
1149421e10b8SBarry Smith         ilink = ilink->next;
1150421e10b8SBarry Smith       }
1151421e10b8SBarry Smith       ierr = FieldSplitSplitSolveAddTranspose(ilink,x,y);CHKERRQ(ierr);
11522618eb8fSHong Zhang       ierr = KSPGetConvergedReason(ilink->ksp,&reason);CHKERRQ(ierr);
11532618eb8fSHong Zhang       if (reason == KSP_DIVERGED_PCSETUP_FAILED) {
11542618eb8fSHong Zhang         pc->failedreason = PC_SUBPC_ERROR;
11552618eb8fSHong Zhang       }
1156421e10b8SBarry Smith       while (ilink->previous) {
1157421e10b8SBarry Smith         ilink = ilink->previous;
11589989ab13SBarry Smith         ierr  = MatMultTranspose(pc->mat,y,jac->w1);CHKERRQ(ierr);
1159421e10b8SBarry Smith         ierr  = VecWAXPY(jac->w2,-1.0,jac->w1,x);CHKERRQ(ierr);
1160421e10b8SBarry Smith         ierr  = FieldSplitSplitSolveAddTranspose(ilink,jac->w2,y);CHKERRQ(ierr);
1161421e10b8SBarry Smith       }
1162421e10b8SBarry Smith     }
1163421e10b8SBarry Smith   }
1164421e10b8SBarry Smith   PetscFunctionReturn(0);
1165421e10b8SBarry Smith }
1166421e10b8SBarry Smith 
1167574deadeSBarry Smith static PetscErrorCode PCReset_FieldSplit(PC pc)
11680971522cSBarry Smith {
11690971522cSBarry Smith   PC_FieldSplit     *jac = (PC_FieldSplit*)pc->data;
11700971522cSBarry Smith   PetscErrorCode    ierr;
11715a9f2f41SSatish Balay   PC_FieldSplitLink ilink = jac->head,next;
11720971522cSBarry Smith 
11730971522cSBarry Smith   PetscFunctionBegin;
11745a9f2f41SSatish Balay   while (ilink) {
1175f5f0d762SBarry Smith     ierr  = KSPDestroy(&ilink->ksp);CHKERRQ(ierr);
1176fcfd50ebSBarry Smith     ierr  = VecDestroy(&ilink->x);CHKERRQ(ierr);
1177fcfd50ebSBarry Smith     ierr  = VecDestroy(&ilink->y);CHKERRQ(ierr);
1178443836d0SMatthew G Knepley     ierr  = VecDestroy(&ilink->z);CHKERRQ(ierr);
1179fcfd50ebSBarry Smith     ierr  = VecScatterDestroy(&ilink->sctx);CHKERRQ(ierr);
1180fcfd50ebSBarry Smith     ierr  = ISDestroy(&ilink->is);CHKERRQ(ierr);
1181b5787286SJed Brown     ierr  = ISDestroy(&ilink->is_col);CHKERRQ(ierr);
1182f5f0d762SBarry Smith     ierr  = PetscFree(ilink->splitname);CHKERRQ(ierr);
1183f5f0d762SBarry Smith     ierr  = PetscFree(ilink->fields);CHKERRQ(ierr);
1184f5f0d762SBarry Smith     ierr  = PetscFree(ilink->fields_col);CHKERRQ(ierr);
11855a9f2f41SSatish Balay     next  = ilink->next;
1186f5f0d762SBarry Smith     ierr  = PetscFree(ilink);CHKERRQ(ierr);
11875a9f2f41SSatish Balay     ilink = next;
11880971522cSBarry Smith   }
1189f5f0d762SBarry Smith   jac->head = NULL;
119005b42c5fSBarry Smith   ierr = PetscFree2(jac->x,jac->y);CHKERRQ(ierr);
1191574deadeSBarry Smith   if (jac->mat && jac->mat != jac->pmat) {
1192574deadeSBarry Smith     ierr = MatDestroyMatrices(jac->nsplits,&jac->mat);CHKERRQ(ierr);
1193574deadeSBarry Smith   } else if (jac->mat) {
11940298fd71SBarry Smith     jac->mat = NULL;
1195574deadeSBarry Smith   }
119697bbdb24SBarry Smith   if (jac->pmat) {ierr = MatDestroyMatrices(jac->nsplits,&jac->pmat);CHKERRQ(ierr);}
119768dd23aaSBarry Smith   if (jac->Afield) {ierr = MatDestroyMatrices(jac->nsplits,&jac->Afield);CHKERRQ(ierr);}
1198f5f0d762SBarry Smith   jac->nsplits = 0;
11996bf464f9SBarry Smith   ierr       = VecDestroy(&jac->w1);CHKERRQ(ierr);
12006bf464f9SBarry Smith   ierr       = VecDestroy(&jac->w2);CHKERRQ(ierr);
12016bf464f9SBarry Smith   ierr       = MatDestroy(&jac->schur);CHKERRQ(ierr);
1202a7476a74SDmitry Karpeev   ierr       = MatDestroy(&jac->schurp);CHKERRQ(ierr);
12036bf464f9SBarry Smith   ierr       = MatDestroy(&jac->schur_user);CHKERRQ(ierr);
12046bf464f9SBarry Smith   ierr       = KSPDestroy(&jac->kspschur);CHKERRQ(ierr);
1205d78dad28SBarry Smith   ierr       = KSPDestroy(&jac->kspupper);CHKERRQ(ierr);
12066bf464f9SBarry Smith   ierr       = MatDestroy(&jac->B);CHKERRQ(ierr);
12076bf464f9SBarry Smith   ierr       = MatDestroy(&jac->C);CHKERRQ(ierr);
12086dbb499eSCian Wilson   jac->isrestrict = PETSC_FALSE;
1209574deadeSBarry Smith   PetscFunctionReturn(0);
1210574deadeSBarry Smith }
1211574deadeSBarry Smith 
1212574deadeSBarry Smith static PetscErrorCode PCDestroy_FieldSplit(PC pc)
1213574deadeSBarry Smith {
1214574deadeSBarry Smith   PetscErrorCode    ierr;
1215574deadeSBarry Smith 
1216574deadeSBarry Smith   PetscFunctionBegin;
1217574deadeSBarry Smith   ierr = PCReset_FieldSplit(pc);CHKERRQ(ierr);
1218c31cb41cSBarry Smith   ierr = PetscFree(pc->data);CHKERRQ(ierr);
1219bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitGetSubKSP_C",NULL);CHKERRQ(ierr);
1220bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetFields_C",NULL);CHKERRQ(ierr);
1221bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetIS_C",NULL);CHKERRQ(ierr);
1222bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetType_C",NULL);CHKERRQ(ierr);
1223bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetBlockSize_C",NULL);CHKERRQ(ierr);
122429f8a81cSJed Brown   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetSchurPre_C",NULL);CHKERRQ(ierr);
122537a82bf0SJed Brown   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitGetSchurPre_C",NULL);CHKERRQ(ierr);
1226bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetSchurFactType_C",NULL);CHKERRQ(ierr);
12276dbb499eSCian Wilson   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitRestrictIS_C",NULL);CHKERRQ(ierr);
12280971522cSBarry Smith   PetscFunctionReturn(0);
12290971522cSBarry Smith }
12300971522cSBarry Smith 
12314416b707SBarry Smith static PetscErrorCode PCSetFromOptions_FieldSplit(PetscOptionItems *PetscOptionsObject,PC pc)
12320971522cSBarry Smith {
12331b9fc7fcSBarry Smith   PetscErrorCode  ierr;
12346c924f48SJed Brown   PetscInt        bs;
1235*7b752e3dSPatrick Sanan   PetscBool       flg;
12369dcbbd2bSBarry Smith   PC_FieldSplit   *jac = (PC_FieldSplit*)pc->data;
12373b224e63SBarry Smith   PCCompositeType ctype;
12381b9fc7fcSBarry Smith 
12390971522cSBarry Smith   PetscFunctionBegin;
1240e55864a3SBarry Smith   ierr = PetscOptionsHead(PetscOptionsObject,"FieldSplit options");CHKERRQ(ierr);
12414ab8060aSDmitry Karpeev   ierr = PetscOptionsBool("-pc_fieldsplit_dm_splits","Whether to use DMCreateFieldDecomposition() for splits","PCFieldSplitSetDMSplits",jac->dm_splits,&jac->dm_splits,NULL);CHKERRQ(ierr);
124251f519a2SBarry Smith   ierr = PetscOptionsInt("-pc_fieldsplit_block_size","Blocksize that defines number of fields","PCFieldSplitSetBlockSize",jac->bs,&bs,&flg);CHKERRQ(ierr);
124351f519a2SBarry Smith   if (flg) {
124451f519a2SBarry Smith     ierr = PCFieldSplitSetBlockSize(pc,bs);CHKERRQ(ierr);
124551f519a2SBarry Smith   }
12462686e3e9SMatthew G. Knepley   jac->diag_use_amat = pc->useAmat;
12472686e3e9SMatthew 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);
12482686e3e9SMatthew G. Knepley   jac->offdiag_use_amat = pc->useAmat;
12492686e3e9SMatthew 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);
1250*7b752e3dSPatrick Sanan   ierr = PetscOptionsBool("-pc_fieldsplit_detect_saddle_point","Form 2-way split by detecting zero diagonal entries", "PCFieldSplitSetDetectSaddlePoint",jac->detect,&jac->detect,NULL);CHKERRQ(ierr);
1251*7b752e3dSPatrick Sanan   ierr = PCFieldSplitSetDetectSaddlePoint(pc,jac->detect);CHKERRQ(ierr); /* Sets split type and Schur PC type */
12523b224e63SBarry Smith   ierr = PetscOptionsEnum("-pc_fieldsplit_type","Type of composition","PCFieldSplitSetType",PCCompositeTypes,(PetscEnum)jac->type,(PetscEnum*)&ctype,&flg);CHKERRQ(ierr);
12533b224e63SBarry Smith   if (flg) {
12543b224e63SBarry Smith     ierr = PCFieldSplitSetType(pc,ctype);CHKERRQ(ierr);
12553b224e63SBarry Smith   }
1256c30613efSMatthew Knepley   /* Only setup fields once */
1257c30613efSMatthew Knepley   if ((jac->bs > 0) && (jac->nsplits == 0)) {
1258d32f9abdSBarry Smith     /* only allow user to set fields from command line if bs is already known.
1259d32f9abdSBarry Smith        otherwise user can set them in PCFieldSplitSetDefaults() */
12606c924f48SJed Brown     ierr = PCFieldSplitSetRuntimeSplits_Private(pc);CHKERRQ(ierr);
12616c924f48SJed Brown     if (jac->splitdefined) {ierr = PetscInfo(pc,"Splits defined using the options database\n");CHKERRQ(ierr);}
1262d32f9abdSBarry Smith   }
1263c5d2311dSJed Brown   if (jac->type == PC_COMPOSITE_SCHUR) {
1264c5929fdfSBarry Smith     ierr = PetscOptionsGetEnum(((PetscObject)pc)->options,((PetscObject)pc)->prefix,"-pc_fieldsplit_schur_factorization_type",PCFieldSplitSchurFactTypes,(PetscEnum*)&jac->schurfactorization,&flg);CHKERRQ(ierr);
1265c9c6ffaaSJed Brown     if (flg) {ierr = PetscInfo(pc,"Deprecated use of -pc_fieldsplit_schur_factorization_type\n");CHKERRQ(ierr);}
12660298fd71SBarry 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);
126729f8a81cSJed 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);
1268c096484dSStefano Zampini     ierr = PetscOptionsScalar("-pc_fieldsplit_schur_scale","Scale Schur complement","PCFieldSplitSetSchurScale",jac->schurscale,&jac->schurscale,NULL);CHKERRQ(ierr);
1269c5d2311dSJed Brown   }
12701b9fc7fcSBarry Smith   ierr = PetscOptionsTail();CHKERRQ(ierr);
12710971522cSBarry Smith   PetscFunctionReturn(0);
12720971522cSBarry Smith }
12730971522cSBarry Smith 
12740971522cSBarry Smith /*------------------------------------------------------------------------------------*/
12750971522cSBarry Smith 
12761e6b0712SBarry Smith static PetscErrorCode  PCFieldSplitSetFields_FieldSplit(PC pc,const char splitname[],PetscInt n,const PetscInt *fields,const PetscInt *fields_col)
12770971522cSBarry Smith {
127897bbdb24SBarry Smith   PC_FieldSplit     *jac = (PC_FieldSplit*)pc->data;
12790971522cSBarry Smith   PetscErrorCode    ierr;
12805a9f2f41SSatish Balay   PC_FieldSplitLink ilink,next = jac->head;
128169a612a9SBarry Smith   char              prefix[128];
12825d4c12cdSJungho Lee   PetscInt          i;
12830971522cSBarry Smith 
12840971522cSBarry Smith   PetscFunctionBegin;
12856c924f48SJed Brown   if (jac->splitdefined) {
12866c924f48SJed Brown     ierr = PetscInfo1(pc,"Ignoring new split \"%s\" because the splits have already been defined\n",splitname);CHKERRQ(ierr);
12876c924f48SJed Brown     PetscFunctionReturn(0);
12886c924f48SJed Brown   }
128951f519a2SBarry Smith   for (i=0; i<n; i++) {
1290e32f2f54SBarry 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);
1291e32f2f54SBarry Smith     if (fields[i] < 0) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Negative field %D requested",fields[i]);
129251f519a2SBarry Smith   }
1293b00a9115SJed Brown   ierr = PetscNew(&ilink);CHKERRQ(ierr);
1294a04f6461SBarry Smith   if (splitname) {
1295db4c96c1SJed Brown     ierr = PetscStrallocpy(splitname,&ilink->splitname);CHKERRQ(ierr);
1296a04f6461SBarry Smith   } else {
1297785e854fSJed Brown     ierr = PetscMalloc1(3,&ilink->splitname);CHKERRQ(ierr);
1298a04f6461SBarry Smith     ierr = PetscSNPrintf(ilink->splitname,2,"%s",jac->nsplits);CHKERRQ(ierr);
1299a04f6461SBarry Smith   }
13009df09d43SBarry Smith   ilink->event = jac->nsplits < 5 ? KSP_Solve_FS_0 + jac->nsplits : KSP_Solve_FS_0 + 4; /* Any split great than 4 gets logged in the 4th split */
1301785e854fSJed Brown   ierr = PetscMalloc1(n,&ilink->fields);CHKERRQ(ierr);
13025a9f2f41SSatish Balay   ierr = PetscMemcpy(ilink->fields,fields,n*sizeof(PetscInt));CHKERRQ(ierr);
1303785e854fSJed Brown   ierr = PetscMalloc1(n,&ilink->fields_col);CHKERRQ(ierr);
13045d4c12cdSJungho Lee   ierr = PetscMemcpy(ilink->fields_col,fields_col,n*sizeof(PetscInt));CHKERRQ(ierr);
13052fa5cd67SKarl Rupp 
13065a9f2f41SSatish Balay   ilink->nfields = n;
13070298fd71SBarry Smith   ilink->next    = NULL;
1308ce94432eSBarry Smith   ierr           = KSPCreate(PetscObjectComm((PetscObject)pc),&ilink->ksp);CHKERRQ(ierr);
1309422a814eSBarry Smith   ierr           = KSPSetErrorIfNotConverged(ilink->ksp,pc->erroriffailure);CHKERRQ(ierr);
131020252d06SBarry Smith   ierr           = PetscObjectIncrementTabLevel((PetscObject)ilink->ksp,(PetscObject)pc,1);CHKERRQ(ierr);
13115a9f2f41SSatish Balay   ierr           = KSPSetType(ilink->ksp,KSPPREONLY);CHKERRQ(ierr);
13129005cf84SBarry Smith   ierr           = PetscLogObjectParent((PetscObject)pc,(PetscObject)ilink->ksp);CHKERRQ(ierr);
131369a612a9SBarry Smith 
13148caf3d72SBarry Smith   ierr = PetscSNPrintf(prefix,sizeof(prefix),"%sfieldsplit_%s_",((PetscObject)pc)->prefix ? ((PetscObject)pc)->prefix : "",ilink->splitname);CHKERRQ(ierr);
13155a9f2f41SSatish Balay   ierr = KSPSetOptionsPrefix(ilink->ksp,prefix);CHKERRQ(ierr);
13160971522cSBarry Smith 
13170971522cSBarry Smith   if (!next) {
13185a9f2f41SSatish Balay     jac->head       = ilink;
13190298fd71SBarry Smith     ilink->previous = NULL;
13200971522cSBarry Smith   } else {
13210971522cSBarry Smith     while (next->next) {
13220971522cSBarry Smith       next = next->next;
13230971522cSBarry Smith     }
13245a9f2f41SSatish Balay     next->next      = ilink;
132551f519a2SBarry Smith     ilink->previous = next;
13260971522cSBarry Smith   }
13270971522cSBarry Smith   jac->nsplits++;
13280971522cSBarry Smith   PetscFunctionReturn(0);
13290971522cSBarry Smith }
13300971522cSBarry Smith 
13311e6b0712SBarry Smith static PetscErrorCode  PCFieldSplitGetSubKSP_FieldSplit_Schur(PC pc,PetscInt *n,KSP **subksp)
1332e69d4d44SBarry Smith {
1333e69d4d44SBarry Smith   PC_FieldSplit  *jac = (PC_FieldSplit*)pc->data;
1334e69d4d44SBarry Smith   PetscErrorCode ierr;
1335e69d4d44SBarry Smith 
1336e69d4d44SBarry Smith   PetscFunctionBegin;
133734a3b412SBarry Smith   if (!jac->schur) SETERRQ(PetscObjectComm((PetscObject)pc),PETSC_ERR_ARG_WRONGSTATE,"Must call KSPSetUp() or PCSetUp() before calling PCFieldSplitGetSubKSP()");
1338785e854fSJed Brown   ierr = PetscMalloc1(jac->nsplits,subksp);CHKERRQ(ierr);
1339e69d4d44SBarry Smith   ierr = MatSchurComplementGetKSP(jac->schur,*subksp);CHKERRQ(ierr);
13402fa5cd67SKarl Rupp 
1341e69d4d44SBarry Smith   (*subksp)[1] = jac->kspschur;
134213e0d083SBarry Smith   if (n) *n = jac->nsplits;
1343e69d4d44SBarry Smith   PetscFunctionReturn(0);
1344e69d4d44SBarry Smith }
13450971522cSBarry Smith 
13461e6b0712SBarry Smith static PetscErrorCode  PCFieldSplitGetSubKSP_FieldSplit(PC pc,PetscInt *n,KSP **subksp)
13470971522cSBarry Smith {
13480971522cSBarry Smith   PC_FieldSplit     *jac = (PC_FieldSplit*)pc->data;
13490971522cSBarry Smith   PetscErrorCode    ierr;
13500971522cSBarry Smith   PetscInt          cnt   = 0;
13515a9f2f41SSatish Balay   PC_FieldSplitLink ilink = jac->head;
13520971522cSBarry Smith 
13530971522cSBarry Smith   PetscFunctionBegin;
1354785e854fSJed Brown   ierr = PetscMalloc1(jac->nsplits,subksp);CHKERRQ(ierr);
13555a9f2f41SSatish Balay   while (ilink) {
13565a9f2f41SSatish Balay     (*subksp)[cnt++] = ilink->ksp;
13575a9f2f41SSatish Balay     ilink            = ilink->next;
13580971522cSBarry Smith   }
13595d480477SMatthew 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);
136013e0d083SBarry Smith   if (n) *n = jac->nsplits;
13610971522cSBarry Smith   PetscFunctionReturn(0);
13620971522cSBarry Smith }
13630971522cSBarry Smith 
13646dbb499eSCian Wilson /*@C
13656dbb499eSCian Wilson     PCFieldSplitRestrictIS - Restricts the fieldsplit ISs to be within a given IS.
13666dbb499eSCian Wilson 
13676dbb499eSCian Wilson     Input Parameters:
13686dbb499eSCian Wilson +   pc  - the preconditioner context
13696dbb499eSCian Wilson +   is - the index set that defines the indices to which the fieldsplit is to be restricted
13706dbb499eSCian Wilson 
13716dbb499eSCian Wilson     Level: advanced
13726dbb499eSCian Wilson 
13736dbb499eSCian Wilson @*/
13746dbb499eSCian Wilson PetscErrorCode  PCFieldSplitRestrictIS(PC pc,IS isy)
13756dbb499eSCian Wilson {
13766dbb499eSCian Wilson   PetscErrorCode ierr;
13776dbb499eSCian Wilson 
13786dbb499eSCian Wilson   PetscFunctionBegin;
13796dbb499eSCian Wilson   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
13806dbb499eSCian Wilson   PetscValidHeaderSpecific(isy,IS_CLASSID,2);
13810246f55cSBarry Smith   ierr = PetscTryMethod(pc,"PCFieldSplitRestrictIS_C",(PC,IS),(pc,isy));CHKERRQ(ierr);
13826dbb499eSCian Wilson   PetscFunctionReturn(0);
13836dbb499eSCian Wilson }
13846dbb499eSCian Wilson 
13856dbb499eSCian Wilson 
13866dbb499eSCian Wilson static PetscErrorCode  PCFieldSplitRestrictIS_FieldSplit(PC pc, IS isy)
13876dbb499eSCian Wilson {
13886dbb499eSCian Wilson   PC_FieldSplit     *jac = (PC_FieldSplit*)pc->data;
13896dbb499eSCian Wilson   PetscErrorCode    ierr;
13906dbb499eSCian Wilson   PC_FieldSplitLink ilink = jac->head, next;
13916dbb499eSCian Wilson   PetscInt          localsize,size,sizez,i;
13926dbb499eSCian Wilson   const PetscInt    *ind, *indz;
13936dbb499eSCian Wilson   PetscInt          *indc, *indcz;
13946dbb499eSCian Wilson   PetscBool         flg;
13956dbb499eSCian Wilson 
13966dbb499eSCian Wilson   PetscFunctionBegin;
13976dbb499eSCian Wilson   ierr = ISGetLocalSize(isy,&localsize);CHKERRQ(ierr);
13986dbb499eSCian Wilson   ierr = MPI_Scan(&localsize,&size,1,MPIU_INT,MPI_SUM,PetscObjectComm((PetscObject)isy));CHKERRQ(ierr);
13996dbb499eSCian Wilson   size -= localsize;
14006dbb499eSCian Wilson   while(ilink) {
14016dbb499eSCian Wilson     IS isrl,isr;
14021c7cfba8SBarry Smith     PC subpc;
14036dbb499eSCian Wilson     ierr          = ISEmbed(ilink->is, isy, PETSC_TRUE, &isrl);CHKERRQ(ierr);
14046dbb499eSCian Wilson     ierr          = ISGetLocalSize(isrl,&localsize);CHKERRQ(ierr);
14056dbb499eSCian Wilson     ierr          = PetscMalloc1(localsize,&indc);CHKERRQ(ierr);
14066dbb499eSCian Wilson     ierr          = ISGetIndices(isrl,&ind);CHKERRQ(ierr);
14076dbb499eSCian Wilson     ierr          = PetscMemcpy(indc,ind,localsize*sizeof(PetscInt));CHKERRQ(ierr);
14086dbb499eSCian Wilson     ierr          = ISRestoreIndices(isrl,&ind);CHKERRQ(ierr);
14096dbb499eSCian Wilson     ierr          = ISDestroy(&isrl);CHKERRQ(ierr);
14106dbb499eSCian Wilson     for (i=0; i<localsize; i++) *(indc+i) += size;
14116dbb499eSCian Wilson     ierr          = ISCreateGeneral(PetscObjectComm((PetscObject)isy),localsize,indc,PETSC_OWN_POINTER,&isr);CHKERRQ(ierr);
14126dbb499eSCian Wilson     ierr          = PetscObjectReference((PetscObject)isr);CHKERRQ(ierr);
14136dbb499eSCian Wilson     ierr          = ISDestroy(&ilink->is);CHKERRQ(ierr);
14146dbb499eSCian Wilson     ilink->is     = isr;
14156dbb499eSCian Wilson     ierr          = PetscObjectReference((PetscObject)isr);CHKERRQ(ierr);
14166dbb499eSCian Wilson     ierr          = ISDestroy(&ilink->is_col);CHKERRQ(ierr);
14176dbb499eSCian Wilson     ilink->is_col = isr;
14186dbb499eSCian Wilson     ierr          = ISDestroy(&isr);CHKERRQ(ierr);
14196dbb499eSCian Wilson     ierr          = KSPGetPC(ilink->ksp, &subpc);CHKERRQ(ierr);
14206dbb499eSCian Wilson     ierr          = PetscObjectTypeCompare((PetscObject)subpc,PCFIELDSPLIT,&flg);CHKERRQ(ierr);
14216dbb499eSCian Wilson     if(flg) {
14226dbb499eSCian Wilson       IS iszl,isz;
14236dbb499eSCian Wilson       MPI_Comm comm;
14246dbb499eSCian Wilson       ierr   = ISGetLocalSize(ilink->is,&localsize);CHKERRQ(ierr);
14256dbb499eSCian Wilson       comm   = PetscObjectComm((PetscObject)ilink->is);
14266dbb499eSCian Wilson       ierr   = ISEmbed(isy, ilink->is, PETSC_TRUE, &iszl);CHKERRQ(ierr);
14276dbb499eSCian Wilson       ierr   = MPI_Scan(&localsize,&sizez,1,MPIU_INT,MPI_SUM,comm);CHKERRQ(ierr);
14286dbb499eSCian Wilson       sizez -= localsize;
14296dbb499eSCian Wilson       ierr   = ISGetLocalSize(iszl,&localsize);CHKERRQ(ierr);
14306dbb499eSCian Wilson       ierr   = PetscMalloc1(localsize,&indcz);CHKERRQ(ierr);
14316dbb499eSCian Wilson       ierr   = ISGetIndices(iszl,&indz);CHKERRQ(ierr);
14326dbb499eSCian Wilson       ierr   = PetscMemcpy(indcz,indz,localsize*sizeof(PetscInt));CHKERRQ(ierr);
14336dbb499eSCian Wilson       ierr   = ISRestoreIndices(iszl,&indz);CHKERRQ(ierr);
14346dbb499eSCian Wilson       ierr   = ISDestroy(&iszl);CHKERRQ(ierr);
14356dbb499eSCian Wilson       for (i=0; i<localsize; i++) *(indcz+i) += sizez;
14366dbb499eSCian Wilson       ierr   = ISCreateGeneral(comm,localsize,indcz,PETSC_OWN_POINTER,&isz);CHKERRQ(ierr);
14376dbb499eSCian Wilson       ierr   = PCFieldSplitRestrictIS(subpc,isz);CHKERRQ(ierr);
14386dbb499eSCian Wilson       ierr   = ISDestroy(&isz);CHKERRQ(ierr);
14396dbb499eSCian Wilson     }
14406dbb499eSCian Wilson     next = ilink->next;
14416dbb499eSCian Wilson     ilink = next;
14426dbb499eSCian Wilson   }
14436dbb499eSCian Wilson   jac->isrestrict = PETSC_TRUE;
14446dbb499eSCian Wilson   PetscFunctionReturn(0);
14456dbb499eSCian Wilson }
14466dbb499eSCian Wilson 
14471e6b0712SBarry Smith static PetscErrorCode  PCFieldSplitSetIS_FieldSplit(PC pc,const char splitname[],IS is)
1448704ba839SBarry Smith {
1449704ba839SBarry Smith   PC_FieldSplit     *jac = (PC_FieldSplit*)pc->data;
1450704ba839SBarry Smith   PetscErrorCode    ierr;
1451704ba839SBarry Smith   PC_FieldSplitLink ilink, next = jac->head;
1452704ba839SBarry Smith   char              prefix[128];
1453704ba839SBarry Smith 
1454704ba839SBarry Smith   PetscFunctionBegin;
14556c924f48SJed Brown   if (jac->splitdefined) {
14566c924f48SJed Brown     ierr = PetscInfo1(pc,"Ignoring new split \"%s\" because the splits have already been defined\n",splitname);CHKERRQ(ierr);
14576c924f48SJed Brown     PetscFunctionReturn(0);
14586c924f48SJed Brown   }
1459b00a9115SJed Brown   ierr = PetscNew(&ilink);CHKERRQ(ierr);
1460a04f6461SBarry Smith   if (splitname) {
1461db4c96c1SJed Brown     ierr = PetscStrallocpy(splitname,&ilink->splitname);CHKERRQ(ierr);
1462a04f6461SBarry Smith   } else {
1463785e854fSJed Brown     ierr = PetscMalloc1(8,&ilink->splitname);CHKERRQ(ierr);
1464b5787286SJed Brown     ierr = PetscSNPrintf(ilink->splitname,7,"%D",jac->nsplits);CHKERRQ(ierr);
1465a04f6461SBarry Smith   }
14669df09d43SBarry Smith   ilink->event = jac->nsplits < 5 ? KSP_Solve_FS_0 + jac->nsplits : KSP_Solve_FS_0 + 4; /* Any split great than 4 gets logged in the 4th split */
14671ab39975SBarry Smith   ierr          = PetscObjectReference((PetscObject)is);CHKERRQ(ierr);
1468b5787286SJed Brown   ierr          = ISDestroy(&ilink->is);CHKERRQ(ierr);
1469b5787286SJed Brown   ilink->is     = is;
1470b5787286SJed Brown   ierr          = PetscObjectReference((PetscObject)is);CHKERRQ(ierr);
1471b5787286SJed Brown   ierr          = ISDestroy(&ilink->is_col);CHKERRQ(ierr);
1472b5787286SJed Brown   ilink->is_col = is;
14730298fd71SBarry Smith   ilink->next   = NULL;
1474ce94432eSBarry Smith   ierr          = KSPCreate(PetscObjectComm((PetscObject)pc),&ilink->ksp);CHKERRQ(ierr);
1475422a814eSBarry Smith   ierr          = KSPSetErrorIfNotConverged(ilink->ksp,pc->erroriffailure);CHKERRQ(ierr);
147620252d06SBarry Smith   ierr          = PetscObjectIncrementTabLevel((PetscObject)ilink->ksp,(PetscObject)pc,1);CHKERRQ(ierr);
1477704ba839SBarry Smith   ierr          = KSPSetType(ilink->ksp,KSPPREONLY);CHKERRQ(ierr);
14789005cf84SBarry Smith   ierr          = PetscLogObjectParent((PetscObject)pc,(PetscObject)ilink->ksp);CHKERRQ(ierr);
1479704ba839SBarry Smith 
14808caf3d72SBarry Smith   ierr = PetscSNPrintf(prefix,sizeof(prefix),"%sfieldsplit_%s_",((PetscObject)pc)->prefix ? ((PetscObject)pc)->prefix : "",ilink->splitname);CHKERRQ(ierr);
1481704ba839SBarry Smith   ierr = KSPSetOptionsPrefix(ilink->ksp,prefix);CHKERRQ(ierr);
1482704ba839SBarry Smith 
1483704ba839SBarry Smith   if (!next) {
1484704ba839SBarry Smith     jac->head       = ilink;
14850298fd71SBarry Smith     ilink->previous = NULL;
1486704ba839SBarry Smith   } else {
1487704ba839SBarry Smith     while (next->next) {
1488704ba839SBarry Smith       next = next->next;
1489704ba839SBarry Smith     }
1490704ba839SBarry Smith     next->next      = ilink;
1491704ba839SBarry Smith     ilink->previous = next;
1492704ba839SBarry Smith   }
1493704ba839SBarry Smith   jac->nsplits++;
1494704ba839SBarry Smith   PetscFunctionReturn(0);
1495704ba839SBarry Smith }
1496704ba839SBarry Smith 
149794ef8ddeSSatish Balay /*@C
14980971522cSBarry Smith     PCFieldSplitSetFields - Sets the fields for one particular split in the field split preconditioner
14990971522cSBarry Smith 
1500ad4df100SBarry Smith     Logically Collective on PC
15010971522cSBarry Smith 
15020971522cSBarry Smith     Input Parameters:
15030971522cSBarry Smith +   pc  - the preconditioner context
15040298fd71SBarry Smith .   splitname - name of this split, if NULL the number of the split is used
15050971522cSBarry Smith .   n - the number of fields in this split
1506db4c96c1SJed Brown -   fields - the fields in this split
15070971522cSBarry Smith 
15080971522cSBarry Smith     Level: intermediate
15090971522cSBarry Smith 
1510d32f9abdSBarry Smith     Notes: Use PCFieldSplitSetIS() to set a completely general set of indices as a field.
1511d32f9abdSBarry Smith 
15127287d2a3SDmitry Karpeev      The PCFieldSplitSetFields() is for defining fields as strided blocks. For example, if the block
1513d32f9abdSBarry 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
1514d32f9abdSBarry Smith      0xx3xx6xx9xx12 ... x1xx4xx7xx ... xx2xx5xx8xx.. 01x34x67x... 0x1x3x5x7.. x12x45x78x....
1515d32f9abdSBarry Smith      where the numbered entries indicate what is in the field.
1516d32f9abdSBarry Smith 
1517db4c96c1SJed Brown      This function is called once per split (it creates a new split each time).  Solve options
1518db4c96c1SJed Brown      for this split will be available under the prefix -fieldsplit_SPLITNAME_.
1519db4c96c1SJed Brown 
15205d4c12cdSJungho Lee      Developer Note: This routine does not actually create the IS representing the split, that is delayed
15215d4c12cdSJungho Lee      until PCSetUp_FieldSplit(), because information about the vector/matrix layouts may not be
15225d4c12cdSJungho Lee      available when this routine is called.
15235d4c12cdSJungho Lee 
1524d32f9abdSBarry Smith .seealso: PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitSetBlockSize(), PCFieldSplitSetIS()
15250971522cSBarry Smith 
15260971522cSBarry Smith @*/
15275d4c12cdSJungho Lee PetscErrorCode  PCFieldSplitSetFields(PC pc,const char splitname[],PetscInt n,const PetscInt *fields,const PetscInt *fields_col)
15280971522cSBarry Smith {
15294ac538c5SBarry Smith   PetscErrorCode ierr;
15300971522cSBarry Smith 
15310971522cSBarry Smith   PetscFunctionBegin;
15320700a824SBarry Smith   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
1533db4c96c1SJed Brown   PetscValidCharPointer(splitname,2);
1534ce94432eSBarry Smith   if (n < 1) SETERRQ2(PetscObjectComm((PetscObject)pc),PETSC_ERR_ARG_OUTOFRANGE,"Provided number of fields %D in split \"%s\" not positive",n,splitname);
1535db4c96c1SJed Brown   PetscValidIntPointer(fields,3);
15360246f55cSBarry Smith   ierr = PetscTryMethod(pc,"PCFieldSplitSetFields_C",(PC,const char[],PetscInt,const PetscInt*,const PetscInt*),(pc,splitname,n,fields,fields_col));CHKERRQ(ierr);
15370971522cSBarry Smith   PetscFunctionReturn(0);
15380971522cSBarry Smith }
15390971522cSBarry Smith 
1540c84da90fSDmitry Karpeev /*@
1541c84da90fSDmitry Karpeev     PCFieldSplitSetDiagUseAmat - set flag indicating whether to extract diagonal blocks from Amat (rather than Pmat)
1542c84da90fSDmitry Karpeev 
1543c84da90fSDmitry Karpeev     Logically Collective on PC
1544c84da90fSDmitry Karpeev 
1545c84da90fSDmitry Karpeev     Input Parameters:
1546c84da90fSDmitry Karpeev +   pc  - the preconditioner object
1547c84da90fSDmitry Karpeev -   flg - boolean flag indicating whether or not to use Amat to extract the diagonal blocks from
1548c84da90fSDmitry Karpeev 
15499506b623SDmitry Karpeev     Options Database:
15509506b623SDmitry Karpeev .     -pc_fieldsplit_diag_use_amat
1551c84da90fSDmitry Karpeev 
1552c84da90fSDmitry Karpeev     Level: intermediate
1553c84da90fSDmitry Karpeev 
1554c84da90fSDmitry Karpeev .seealso: PCFieldSplitGetDiagUseAmat(), PCFieldSplitSetOffDiagUseAmat(), PCFIELDSPLIT
1555c84da90fSDmitry Karpeev 
1556c84da90fSDmitry Karpeev @*/
1557c84da90fSDmitry Karpeev PetscErrorCode  PCFieldSplitSetDiagUseAmat(PC pc,PetscBool flg)
1558c84da90fSDmitry Karpeev {
1559c84da90fSDmitry Karpeev   PC_FieldSplit  *jac = (PC_FieldSplit*)pc->data;
1560c84da90fSDmitry Karpeev   PetscBool      isfs;
1561c84da90fSDmitry Karpeev   PetscErrorCode ierr;
1562c84da90fSDmitry Karpeev 
1563c84da90fSDmitry Karpeev   PetscFunctionBegin;
1564c84da90fSDmitry Karpeev   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
1565c84da90fSDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)pc,PCFIELDSPLIT,&isfs);CHKERRQ(ierr);
1566c84da90fSDmitry Karpeev   if (!isfs) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"PC not of type %s",PCFIELDSPLIT);
1567c84da90fSDmitry Karpeev   jac->diag_use_amat = flg;
1568c84da90fSDmitry Karpeev   PetscFunctionReturn(0);
1569c84da90fSDmitry Karpeev }
1570c84da90fSDmitry Karpeev 
1571c84da90fSDmitry Karpeev /*@
1572c84da90fSDmitry Karpeev     PCFieldSplitGetDiagUseAmat - get the flag indicating whether to extract diagonal blocks from Amat (rather than Pmat)
1573c84da90fSDmitry Karpeev 
1574c84da90fSDmitry Karpeev     Logically Collective on PC
1575c84da90fSDmitry Karpeev 
1576c84da90fSDmitry Karpeev     Input Parameters:
1577c84da90fSDmitry Karpeev .   pc  - the preconditioner object
1578c84da90fSDmitry Karpeev 
1579c84da90fSDmitry Karpeev     Output Parameters:
1580c84da90fSDmitry Karpeev .   flg - boolean flag indicating whether or not to use Amat to extract the diagonal blocks from
1581c84da90fSDmitry Karpeev 
1582c84da90fSDmitry Karpeev 
1583c84da90fSDmitry Karpeev     Level: intermediate
1584c84da90fSDmitry Karpeev 
1585c84da90fSDmitry Karpeev .seealso: PCFieldSplitSetDiagUseAmat(), PCFieldSplitGetOffDiagUseAmat(), PCFIELDSPLIT
1586c84da90fSDmitry Karpeev 
1587c84da90fSDmitry Karpeev @*/
1588c84da90fSDmitry Karpeev PetscErrorCode  PCFieldSplitGetDiagUseAmat(PC pc,PetscBool *flg)
1589c84da90fSDmitry Karpeev {
1590c84da90fSDmitry Karpeev   PC_FieldSplit  *jac = (PC_FieldSplit*)pc->data;
1591c84da90fSDmitry Karpeev   PetscBool      isfs;
1592c84da90fSDmitry Karpeev   PetscErrorCode ierr;
1593c84da90fSDmitry Karpeev 
1594c84da90fSDmitry Karpeev   PetscFunctionBegin;
1595c84da90fSDmitry Karpeev   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
1596c84da90fSDmitry Karpeev   PetscValidPointer(flg,2);
1597c84da90fSDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)pc,PCFIELDSPLIT,&isfs);CHKERRQ(ierr);
1598c84da90fSDmitry Karpeev   if (!isfs) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"PC not of type %s",PCFIELDSPLIT);
1599c84da90fSDmitry Karpeev   *flg = jac->diag_use_amat;
1600c84da90fSDmitry Karpeev   PetscFunctionReturn(0);
1601c84da90fSDmitry Karpeev }
1602c84da90fSDmitry Karpeev 
1603c84da90fSDmitry Karpeev /*@
1604c84da90fSDmitry Karpeev     PCFieldSplitSetOffDiagUseAmat - set flag indicating whether to extract off-diagonal blocks from Amat (rather than Pmat)
1605c84da90fSDmitry Karpeev 
1606c84da90fSDmitry Karpeev     Logically Collective on PC
1607c84da90fSDmitry Karpeev 
1608c84da90fSDmitry Karpeev     Input Parameters:
1609c84da90fSDmitry Karpeev +   pc  - the preconditioner object
1610c84da90fSDmitry Karpeev -   flg - boolean flag indicating whether or not to use Amat to extract the off-diagonal blocks from
1611c84da90fSDmitry Karpeev 
16129506b623SDmitry Karpeev     Options Database:
16139506b623SDmitry Karpeev .     -pc_fieldsplit_off_diag_use_amat
1614c84da90fSDmitry Karpeev 
1615c84da90fSDmitry Karpeev     Level: intermediate
1616c84da90fSDmitry Karpeev 
1617c84da90fSDmitry Karpeev .seealso: PCFieldSplitGetOffDiagUseAmat(), PCFieldSplitSetDiagUseAmat(), PCFIELDSPLIT
1618c84da90fSDmitry Karpeev 
1619c84da90fSDmitry Karpeev @*/
1620c84da90fSDmitry Karpeev PetscErrorCode  PCFieldSplitSetOffDiagUseAmat(PC pc,PetscBool flg)
1621c84da90fSDmitry Karpeev {
1622c84da90fSDmitry Karpeev   PC_FieldSplit *jac = (PC_FieldSplit*)pc->data;
1623c84da90fSDmitry Karpeev   PetscBool      isfs;
1624c84da90fSDmitry Karpeev   PetscErrorCode ierr;
1625c84da90fSDmitry Karpeev 
1626c84da90fSDmitry Karpeev   PetscFunctionBegin;
1627c84da90fSDmitry Karpeev   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
1628c84da90fSDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)pc,PCFIELDSPLIT,&isfs);CHKERRQ(ierr);
1629c84da90fSDmitry Karpeev   if (!isfs) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"PC not of type %s",PCFIELDSPLIT);
1630c84da90fSDmitry Karpeev   jac->offdiag_use_amat = flg;
1631c84da90fSDmitry Karpeev   PetscFunctionReturn(0);
1632c84da90fSDmitry Karpeev }
1633c84da90fSDmitry Karpeev 
1634c84da90fSDmitry Karpeev /*@
1635c84da90fSDmitry Karpeev     PCFieldSplitGetOffDiagUseAmat - get the flag indicating whether to extract off-diagonal blocks from Amat (rather than Pmat)
1636c84da90fSDmitry Karpeev 
1637c84da90fSDmitry Karpeev     Logically Collective on PC
1638c84da90fSDmitry Karpeev 
1639c84da90fSDmitry Karpeev     Input Parameters:
1640c84da90fSDmitry Karpeev .   pc  - the preconditioner object
1641c84da90fSDmitry Karpeev 
1642c84da90fSDmitry Karpeev     Output Parameters:
1643c84da90fSDmitry Karpeev .   flg - boolean flag indicating whether or not to use Amat to extract the off-diagonal blocks from
1644c84da90fSDmitry Karpeev 
1645c84da90fSDmitry Karpeev 
1646c84da90fSDmitry Karpeev     Level: intermediate
1647c84da90fSDmitry Karpeev 
1648c84da90fSDmitry Karpeev .seealso: PCFieldSplitSetOffDiagUseAmat(), PCFieldSplitGetDiagUseAmat(), PCFIELDSPLIT
1649c84da90fSDmitry Karpeev 
1650c84da90fSDmitry Karpeev @*/
1651c84da90fSDmitry Karpeev PetscErrorCode  PCFieldSplitGetOffDiagUseAmat(PC pc,PetscBool *flg)
1652c84da90fSDmitry Karpeev {
1653c84da90fSDmitry Karpeev   PC_FieldSplit  *jac = (PC_FieldSplit*)pc->data;
1654c84da90fSDmitry Karpeev   PetscBool      isfs;
1655c84da90fSDmitry Karpeev   PetscErrorCode ierr;
1656c84da90fSDmitry Karpeev 
1657c84da90fSDmitry Karpeev   PetscFunctionBegin;
1658c84da90fSDmitry Karpeev   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
1659c84da90fSDmitry Karpeev   PetscValidPointer(flg,2);
1660c84da90fSDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)pc,PCFIELDSPLIT,&isfs);CHKERRQ(ierr);
1661c84da90fSDmitry Karpeev   if (!isfs) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"PC not of type %s",PCFIELDSPLIT);
1662c84da90fSDmitry Karpeev   *flg = jac->offdiag_use_amat;
1663c84da90fSDmitry Karpeev   PetscFunctionReturn(0);
1664c84da90fSDmitry Karpeev }
1665c84da90fSDmitry Karpeev 
1666c84da90fSDmitry Karpeev 
1667c84da90fSDmitry Karpeev 
1668218d4943SBarry Smith /*@C
1669704ba839SBarry Smith     PCFieldSplitSetIS - Sets the exact elements for field
1670704ba839SBarry Smith 
1671ad4df100SBarry Smith     Logically Collective on PC
1672704ba839SBarry Smith 
1673704ba839SBarry Smith     Input Parameters:
1674704ba839SBarry Smith +   pc  - the preconditioner context
16750298fd71SBarry Smith .   splitname - name of this split, if NULL the number of the split is used
1676db4c96c1SJed Brown -   is - the index set that defines the vector elements in this field
1677704ba839SBarry Smith 
1678d32f9abdSBarry Smith 
1679a6ffb8dbSJed Brown     Notes:
1680a6ffb8dbSJed Brown     Use PCFieldSplitSetFields(), for fields defined by strided types.
1681a6ffb8dbSJed Brown 
1682db4c96c1SJed Brown     This function is called once per split (it creates a new split each time).  Solve options
1683db4c96c1SJed Brown     for this split will be available under the prefix -fieldsplit_SPLITNAME_.
1684d32f9abdSBarry Smith 
1685704ba839SBarry Smith     Level: intermediate
1686704ba839SBarry Smith 
1687704ba839SBarry Smith .seealso: PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitSetBlockSize()
1688704ba839SBarry Smith 
1689704ba839SBarry Smith @*/
16907087cfbeSBarry Smith PetscErrorCode  PCFieldSplitSetIS(PC pc,const char splitname[],IS is)
1691704ba839SBarry Smith {
16924ac538c5SBarry Smith   PetscErrorCode ierr;
1693704ba839SBarry Smith 
1694704ba839SBarry Smith   PetscFunctionBegin;
16950700a824SBarry Smith   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
16967b62db95SJungho Lee   if (splitname) PetscValidCharPointer(splitname,2);
1697db4c96c1SJed Brown   PetscValidHeaderSpecific(is,IS_CLASSID,3);
1698ccc738f7SBarry Smith   ierr = PetscTryMethod(pc,"PCFieldSplitSetIS_C",(PC,const char[],IS),(pc,splitname,is));CHKERRQ(ierr);
1699704ba839SBarry Smith   PetscFunctionReturn(0);
1700704ba839SBarry Smith }
1701704ba839SBarry Smith 
170294ef8ddeSSatish Balay /*@C
170357a9adfeSMatthew G Knepley     PCFieldSplitGetIS - Retrieves the elements for a field as an IS
170457a9adfeSMatthew G Knepley 
170557a9adfeSMatthew G Knepley     Logically Collective on PC
170657a9adfeSMatthew G Knepley 
170757a9adfeSMatthew G Knepley     Input Parameters:
170857a9adfeSMatthew G Knepley +   pc  - the preconditioner context
170957a9adfeSMatthew G Knepley -   splitname - name of this split
171057a9adfeSMatthew G Knepley 
171157a9adfeSMatthew G Knepley     Output Parameter:
17120298fd71SBarry Smith -   is - the index set that defines the vector elements in this field, or NULL if the field is not found
171357a9adfeSMatthew G Knepley 
171457a9adfeSMatthew G Knepley     Level: intermediate
171557a9adfeSMatthew G Knepley 
171657a9adfeSMatthew G Knepley .seealso: PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitSetIS()
171757a9adfeSMatthew G Knepley 
171857a9adfeSMatthew G Knepley @*/
171957a9adfeSMatthew G Knepley PetscErrorCode PCFieldSplitGetIS(PC pc,const char splitname[],IS *is)
172057a9adfeSMatthew G Knepley {
172157a9adfeSMatthew G Knepley   PetscErrorCode ierr;
172257a9adfeSMatthew G Knepley 
172357a9adfeSMatthew G Knepley   PetscFunctionBegin;
172457a9adfeSMatthew G Knepley   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
172557a9adfeSMatthew G Knepley   PetscValidCharPointer(splitname,2);
172657a9adfeSMatthew G Knepley   PetscValidPointer(is,3);
172757a9adfeSMatthew G Knepley   {
172857a9adfeSMatthew G Knepley     PC_FieldSplit     *jac  = (PC_FieldSplit*) pc->data;
172957a9adfeSMatthew G Knepley     PC_FieldSplitLink ilink = jac->head;
173057a9adfeSMatthew G Knepley     PetscBool         found;
173157a9adfeSMatthew G Knepley 
17320298fd71SBarry Smith     *is = NULL;
173357a9adfeSMatthew G Knepley     while (ilink) {
173457a9adfeSMatthew G Knepley       ierr = PetscStrcmp(ilink->splitname, splitname, &found);CHKERRQ(ierr);
173557a9adfeSMatthew G Knepley       if (found) {
173657a9adfeSMatthew G Knepley         *is = ilink->is;
173757a9adfeSMatthew G Knepley         break;
173857a9adfeSMatthew G Knepley       }
173957a9adfeSMatthew G Knepley       ilink = ilink->next;
174057a9adfeSMatthew G Knepley     }
174157a9adfeSMatthew G Knepley   }
174257a9adfeSMatthew G Knepley   PetscFunctionReturn(0);
174357a9adfeSMatthew G Knepley }
174457a9adfeSMatthew G Knepley 
174551f519a2SBarry Smith /*@
174651f519a2SBarry Smith     PCFieldSplitSetBlockSize - Sets the block size for defining where fields start in the
174751f519a2SBarry Smith       fieldsplit preconditioner. If not set the matrix block size is used.
174851f519a2SBarry Smith 
1749ad4df100SBarry Smith     Logically Collective on PC
175051f519a2SBarry Smith 
175151f519a2SBarry Smith     Input Parameters:
175251f519a2SBarry Smith +   pc  - the preconditioner context
175351f519a2SBarry Smith -   bs - the block size
175451f519a2SBarry Smith 
175551f519a2SBarry Smith     Level: intermediate
175651f519a2SBarry Smith 
175751f519a2SBarry Smith .seealso: PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitSetFields()
175851f519a2SBarry Smith 
175951f519a2SBarry Smith @*/
17607087cfbeSBarry Smith PetscErrorCode  PCFieldSplitSetBlockSize(PC pc,PetscInt bs)
176151f519a2SBarry Smith {
17624ac538c5SBarry Smith   PetscErrorCode ierr;
176351f519a2SBarry Smith 
176451f519a2SBarry Smith   PetscFunctionBegin;
17650700a824SBarry Smith   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
1766c5eb9154SBarry Smith   PetscValidLogicalCollectiveInt(pc,bs,2);
17674ac538c5SBarry Smith   ierr = PetscTryMethod(pc,"PCFieldSplitSetBlockSize_C",(PC,PetscInt),(pc,bs));CHKERRQ(ierr);
176851f519a2SBarry Smith   PetscFunctionReturn(0);
176951f519a2SBarry Smith }
177051f519a2SBarry Smith 
17710971522cSBarry Smith /*@C
177269a612a9SBarry Smith    PCFieldSplitGetSubKSP - Gets the KSP contexts for all splits
17730971522cSBarry Smith 
177469a612a9SBarry Smith    Collective on KSP
17750971522cSBarry Smith 
17760971522cSBarry Smith    Input Parameter:
17770971522cSBarry Smith .  pc - the preconditioner context
17780971522cSBarry Smith 
17790971522cSBarry Smith    Output Parameters:
178013e0d083SBarry Smith +  n - the number of splits
17813111de3cSBarry Smith -  subksp - the array of KSP contexts
17820971522cSBarry Smith 
17830971522cSBarry Smith    Note:
17849a4f7e47SBarry Smith    After PCFieldSplitGetSubKSP() the array of KSPs is to be freed by the user with PetscFree()
1785d32f9abdSBarry Smith    (not the KSP just the array that contains them).
17860971522cSBarry Smith 
178769a612a9SBarry Smith    You must call KSPSetUp() before calling PCFieldSplitGetSubKSP().
17880971522cSBarry Smith 
1789196cc216SBarry Smith    Fortran Usage: You must pass in a KSP array that is large enough to contain all the local KSPs.
17902bf68e3eSBarry Smith       You can call PCFieldSplitGetSubKSP(pc,n,PETSC_NULL_KSP,ierr) to determine how large the
1791196cc216SBarry Smith       KSP array must be.
1792196cc216SBarry Smith 
1793196cc216SBarry Smith 
17940971522cSBarry Smith    Level: advanced
17950971522cSBarry Smith 
17960971522cSBarry Smith .seealso: PCFIELDSPLIT
17970971522cSBarry Smith @*/
17987087cfbeSBarry Smith PetscErrorCode  PCFieldSplitGetSubKSP(PC pc,PetscInt *n,KSP *subksp[])
17990971522cSBarry Smith {
18004ac538c5SBarry Smith   PetscErrorCode ierr;
18010971522cSBarry Smith 
18020971522cSBarry Smith   PetscFunctionBegin;
18030700a824SBarry Smith   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
180413e0d083SBarry Smith   if (n) PetscValidIntPointer(n,2);
18054ac538c5SBarry Smith   ierr = PetscUseMethod(pc,"PCFieldSplitGetSubKSP_C",(PC,PetscInt*,KSP **),(pc,n,subksp));CHKERRQ(ierr);
18060971522cSBarry Smith   PetscFunctionReturn(0);
18070971522cSBarry Smith }
18080971522cSBarry Smith 
1809e69d4d44SBarry Smith /*@
181053f2277eSBarry Smith     PCFieldSplitSetSchurPre -  Indicates what operator is used to construct the preconditioner for the Schur complement.
1811a04f6461SBarry Smith       A11 matrix. Otherwise no preconditioner is used.
1812e69d4d44SBarry Smith 
1813e69d4d44SBarry Smith     Collective on PC
1814e69d4d44SBarry Smith 
1815e69d4d44SBarry Smith     Input Parameters:
1816e69d4d44SBarry Smith +   pc      - the preconditioner context
18176fdd48a9SBarry Smith .   ptype   - which matrix to use for preconditioning the Schur complement: PC_FIELDSPLIT_SCHUR_PRE_A11 (default), PC_FIELDSPLIT_SCHUR_PRE_SELF, PC_FIELDSPLIT_SCHUR_PRE_USER
18186fdd48a9SBarry Smith               PC_FIELDSPLIT_SCHUR_PRE_SELFP, and PC_FIELDSPLIT_SCHUR_PRE_FULL
18190298fd71SBarry Smith -   userpre - matrix to use for preconditioning, or NULL
1820084e4875SJed Brown 
1821e69d4d44SBarry Smith     Options Database:
18226fdd48a9SBarry Smith .     -pc_fieldsplit_schur_precondition <self,selfp,user,a11,full> - default is a11. See notes for meaning of various arguments
1823e69d4d44SBarry Smith 
1824fd1303e9SJungho Lee     Notes:
1825fd1303e9SJungho Lee $    If ptype is
1826a6a584a2SBarry Smith $        a11 then the preconditioner for the Schur complement is generated from the block diagonal part of the preconditioner
182753f2277eSBarry Smith $             matrix associated with the Schur complement (i.e. A11), not the Schur complement matrix
1828a6a584a2SBarry Smith $        self the preconditioner for the Schur complement is generated from the symbolic representation of the Schur complement matrix:
1829a6a584a2SBarry Smith $             The only preconditioner that currently works with this symbolic respresentation matrix object is the PCLSC
1830fd1303e9SJungho Lee $             preconditioner
18316fdd48a9SBarry Smith $        user then the preconditioner for the Schur complement is generated from the user provided matrix (pre argument
18326fdd48a9SBarry Smith $             to this function).
1833a6a584a2SBarry Smith $        selfp then the preconditioning for the Schur complement is generated from an explicitly-assembled approximation Sp = A11 - A10 inv(diag(A00)) A01
18341d71051fSDmitry Karpeev $             This is only a good preconditioner when diag(A00) is a good preconditioner for A00. Optionally, A00 can be
18356fdd48a9SBarry Smith $             lumped before extracting the diagonal using the additional option -fieldsplit_1_mat_schur_complement_ainv_type lump
18366fdd48a9SBarry 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)
18376fdd48a9SBarry Smith $             useful mostly as a test that the Schur complement approach can work for your problem
1838fd1303e9SJungho Lee 
1839e87fab1bSBarry Smith      When solving a saddle point problem, where the A11 block is identically zero, using a11 as the ptype only makes sense
1840fd1303e9SJungho Lee     with the additional option -fieldsplit_1_pc_type none. Usually for saddle point problems one would use a ptype of self and
1841a7476a74SDmitry Karpeev     -fieldsplit_1_pc_type lsc which uses the least squares commutator to compute a preconditioner for the Schur complement.
1842fd1303e9SJungho Lee 
1843e69d4d44SBarry Smith     Level: intermediate
1844e69d4d44SBarry Smith 
18451d71051fSDmitry Karpeev .seealso: PCFieldSplitGetSchurPre(), PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitSetFields(), PCFieldSplitSchurPreType,
18461d71051fSDmitry Karpeev           MatSchurComplementSetAinvType(), PCLSC
1847e69d4d44SBarry Smith 
1848e69d4d44SBarry Smith @*/
184929f8a81cSJed Brown PetscErrorCode PCFieldSplitSetSchurPre(PC pc,PCFieldSplitSchurPreType ptype,Mat pre)
1850e69d4d44SBarry Smith {
18514ac538c5SBarry Smith   PetscErrorCode ierr;
1852e69d4d44SBarry Smith 
1853e69d4d44SBarry Smith   PetscFunctionBegin;
18540700a824SBarry Smith   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
185529f8a81cSJed Brown   ierr = PetscTryMethod(pc,"PCFieldSplitSetSchurPre_C",(PC,PCFieldSplitSchurPreType,Mat),(pc,ptype,pre));CHKERRQ(ierr);
1856e69d4d44SBarry Smith   PetscFunctionReturn(0);
1857e69d4d44SBarry Smith }
185829f8a81cSJed Brown PetscErrorCode PCFieldSplitSchurPrecondition(PC pc,PCFieldSplitSchurPreType ptype,Mat pre) {return PCFieldSplitSetSchurPre(pc,ptype,pre);} /* Deprecated name */
1859e69d4d44SBarry Smith 
186037a82bf0SJed Brown /*@
186137a82bf0SJed Brown     PCFieldSplitGetSchurPre - For Schur complement fieldsplit, determine how the Schur complement will be
186229f8a81cSJed Brown     preconditioned.  See PCFieldSplitSetSchurPre() for details.
186337a82bf0SJed Brown 
186437a82bf0SJed Brown     Logically Collective on PC
186537a82bf0SJed Brown 
186637a82bf0SJed Brown     Input Parameters:
186737a82bf0SJed Brown .   pc      - the preconditioner context
186837a82bf0SJed Brown 
186937a82bf0SJed Brown     Output Parameters:
187037a82bf0SJed 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
187137a82bf0SJed Brown -   userpre - matrix to use for preconditioning (with PC_FIELDSPLIT_PRE_USER), or NULL
187237a82bf0SJed Brown 
187337a82bf0SJed Brown     Level: intermediate
187437a82bf0SJed Brown 
187529f8a81cSJed Brown .seealso: PCFieldSplitSetSchurPre(), PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitSetFields(), PCFieldSplitSchurPreType, PCLSC
187637a82bf0SJed Brown 
187737a82bf0SJed Brown @*/
187837a82bf0SJed Brown PetscErrorCode PCFieldSplitGetSchurPre(PC pc,PCFieldSplitSchurPreType *ptype,Mat *pre)
187937a82bf0SJed Brown {
188037a82bf0SJed Brown   PetscErrorCode ierr;
188137a82bf0SJed Brown 
188237a82bf0SJed Brown   PetscFunctionBegin;
188337a82bf0SJed Brown   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
188437a82bf0SJed Brown   ierr = PetscUseMethod(pc,"PCFieldSplitGetSchurPre_C",(PC,PCFieldSplitSchurPreType*,Mat*),(pc,ptype,pre));CHKERRQ(ierr);
1885e69d4d44SBarry Smith   PetscFunctionReturn(0);
1886e69d4d44SBarry Smith }
1887e69d4d44SBarry Smith 
188845e7fc46SDmitry Karpeev /*@
1889470b340bSDmitry Karpeev     PCFieldSplitSchurGetS -  extract the MatSchurComplement object used by this PC in case it needs to be configured separately
189045e7fc46SDmitry Karpeev 
189145e7fc46SDmitry Karpeev     Not collective
189245e7fc46SDmitry Karpeev 
189345e7fc46SDmitry Karpeev     Input Parameter:
189445e7fc46SDmitry Karpeev .   pc      - the preconditioner context
189545e7fc46SDmitry Karpeev 
189645e7fc46SDmitry Karpeev     Output Parameter:
1897470b340bSDmitry Karpeev .   S       - the Schur complement matrix
189845e7fc46SDmitry Karpeev 
1899470b340bSDmitry Karpeev     Notes:
1900470b340bSDmitry Karpeev     This matrix should not be destroyed using MatDestroy(); rather, use PCFieldSplitSchurRestoreS().
190145e7fc46SDmitry Karpeev 
190245e7fc46SDmitry Karpeev     Level: advanced
190345e7fc46SDmitry Karpeev 
190429f8a81cSJed Brown .seealso: PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitSchurPreType, PCFieldSplitSetSchurPre(), MatSchurComplement, PCFieldSplitSchurRestoreS()
190545e7fc46SDmitry Karpeev 
190645e7fc46SDmitry Karpeev @*/
1907470b340bSDmitry Karpeev PetscErrorCode  PCFieldSplitSchurGetS(PC pc,Mat *S)
190845e7fc46SDmitry Karpeev {
190945e7fc46SDmitry Karpeev   PetscErrorCode ierr;
191045e7fc46SDmitry Karpeev   const char*    t;
191145e7fc46SDmitry Karpeev   PetscBool      isfs;
191245e7fc46SDmitry Karpeev   PC_FieldSplit  *jac;
191345e7fc46SDmitry Karpeev 
191445e7fc46SDmitry Karpeev   PetscFunctionBegin;
191545e7fc46SDmitry Karpeev   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
191645e7fc46SDmitry Karpeev   ierr = PetscObjectGetType((PetscObject)pc,&t);CHKERRQ(ierr);
191745e7fc46SDmitry Karpeev   ierr = PetscStrcmp(t,PCFIELDSPLIT,&isfs);CHKERRQ(ierr);
191845e7fc46SDmitry Karpeev   if (!isfs) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Expected PC of type PCFIELDSPLIT, got %s instead",t);
191945e7fc46SDmitry Karpeev   jac = (PC_FieldSplit*)pc->data;
1920470b340bSDmitry 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);
1921470b340bSDmitry Karpeev   if (S) *S = jac->schur;
192245e7fc46SDmitry Karpeev   PetscFunctionReturn(0);
192345e7fc46SDmitry Karpeev }
192445e7fc46SDmitry Karpeev 
1925470b340bSDmitry Karpeev /*@
1926470b340bSDmitry Karpeev     PCFieldSplitSchurRestoreS -  restores the MatSchurComplement object used by this PC
1927470b340bSDmitry Karpeev 
1928470b340bSDmitry Karpeev     Not collective
1929470b340bSDmitry Karpeev 
1930470b340bSDmitry Karpeev     Input Parameters:
1931470b340bSDmitry Karpeev +   pc      - the preconditioner context
1932470b340bSDmitry Karpeev .   S       - the Schur complement matrix
1933470b340bSDmitry Karpeev 
1934470b340bSDmitry Karpeev     Level: advanced
1935470b340bSDmitry Karpeev 
193629f8a81cSJed Brown .seealso: PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitSchurPreType, PCFieldSplitSetSchurPre(), MatSchurComplement, PCFieldSplitSchurGetS()
1937470b340bSDmitry Karpeev 
1938470b340bSDmitry Karpeev @*/
1939bca69d2bSDmitry Karpeev PetscErrorCode  PCFieldSplitSchurRestoreS(PC pc,Mat *S)
1940470b340bSDmitry Karpeev {
1941470b340bSDmitry Karpeev   PetscErrorCode ierr;
1942470b340bSDmitry Karpeev   const char*    t;
1943470b340bSDmitry Karpeev   PetscBool      isfs;
1944470b340bSDmitry Karpeev   PC_FieldSplit  *jac;
1945470b340bSDmitry Karpeev 
1946470b340bSDmitry Karpeev   PetscFunctionBegin;
1947470b340bSDmitry Karpeev   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
1948470b340bSDmitry Karpeev   ierr = PetscObjectGetType((PetscObject)pc,&t);CHKERRQ(ierr);
1949470b340bSDmitry Karpeev   ierr = PetscStrcmp(t,PCFIELDSPLIT,&isfs);CHKERRQ(ierr);
1950470b340bSDmitry Karpeev   if (!isfs) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Expected PC of type PCFIELDSPLIT, got %s instead",t);
1951470b340bSDmitry Karpeev   jac = (PC_FieldSplit*)pc->data;
1952470b340bSDmitry 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);
1953bca69d2bSDmitry Karpeev   if (!S || *S != jac->schur) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"MatSchurComplement restored is not the same as gotten");
1954470b340bSDmitry Karpeev   PetscFunctionReturn(0);
1955470b340bSDmitry Karpeev }
1956470b340bSDmitry Karpeev 
1957470b340bSDmitry Karpeev 
195829f8a81cSJed Brown static PetscErrorCode  PCFieldSplitSetSchurPre_FieldSplit(PC pc,PCFieldSplitSchurPreType ptype,Mat pre)
1959e69d4d44SBarry Smith {
1960e69d4d44SBarry Smith   PC_FieldSplit  *jac = (PC_FieldSplit*)pc->data;
1961084e4875SJed Brown   PetscErrorCode ierr;
1962e69d4d44SBarry Smith 
1963e69d4d44SBarry Smith   PetscFunctionBegin;
1964084e4875SJed Brown   jac->schurpre = ptype;
1965a7476a74SDmitry Karpeev   if (ptype == PC_FIELDSPLIT_SCHUR_PRE_USER && pre) {
19666bf464f9SBarry Smith     ierr            = MatDestroy(&jac->schur_user);CHKERRQ(ierr);
1967084e4875SJed Brown     jac->schur_user = pre;
1968084e4875SJed Brown     ierr            = PetscObjectReference((PetscObject)jac->schur_user);CHKERRQ(ierr);
1969084e4875SJed Brown   }
1970e69d4d44SBarry Smith   PetscFunctionReturn(0);
1971e69d4d44SBarry Smith }
1972e69d4d44SBarry Smith 
197337a82bf0SJed Brown static PetscErrorCode  PCFieldSplitGetSchurPre_FieldSplit(PC pc,PCFieldSplitSchurPreType *ptype,Mat *pre)
197437a82bf0SJed Brown {
197537a82bf0SJed Brown   PC_FieldSplit  *jac = (PC_FieldSplit*)pc->data;
197637a82bf0SJed Brown 
197737a82bf0SJed Brown   PetscFunctionBegin;
197837a82bf0SJed Brown   *ptype = jac->schurpre;
197937a82bf0SJed Brown   *pre   = jac->schur_user;
198037a82bf0SJed Brown   PetscFunctionReturn(0);
198137a82bf0SJed Brown }
198237a82bf0SJed Brown 
1983ab1df9f5SJed Brown /*@
19840ffb0e17SBarry Smith     PCFieldSplitSetSchurFactType -  sets which blocks of the approximate block factorization to retain in the preconditioner
1985ab1df9f5SJed Brown 
1986ab1df9f5SJed Brown     Collective on PC
1987ab1df9f5SJed Brown 
1988ab1df9f5SJed Brown     Input Parameters:
1989ab1df9f5SJed Brown +   pc  - the preconditioner context
1990c9c6ffaaSJed Brown -   ftype - which blocks of factorization to retain, PC_FIELDSPLIT_SCHUR_FACT_FULL is default
1991ab1df9f5SJed Brown 
1992ab1df9f5SJed Brown     Options Database:
1993c9c6ffaaSJed Brown .     -pc_fieldsplit_schur_fact_type <diag,lower,upper,full> default is full
1994ab1df9f5SJed Brown 
1995ab1df9f5SJed Brown 
1996ab1df9f5SJed Brown     Level: intermediate
1997ab1df9f5SJed Brown 
1998ab1df9f5SJed Brown     Notes:
1999ab1df9f5SJed Brown     The FULL factorization is
2000ab1df9f5SJed Brown 
20010ffb0e17SBarry Smith $   (A   B)  = (1       0) (A   0) (1  Ainv*B)  = L D U
20020ffb0e17SBarry Smith $   (C   E)    (C*Ainv  1) (0   S) (0     1  )
2003ab1df9f5SJed Brown 
20040ffb0e17SBarry Smith     where S = E - C*Ainv*B. In practice, the full factorization is applied via block triangular solves with the grouping L*(D*U). UPPER uses D*U, LOWER uses L*D,
2005c096484dSStefano Zampini     and DIAG is the diagonal part with the sign of S flipped (because this makes the preconditioner positive definite for many formulations, thus allowing the use of KSPMINRES). Sign flipping of S can be turned off with PCFieldSplitSetSchurScale().
2006ab1df9f5SJed Brown 
20070ffb0e17SBarry Smith $    If A and S are solved exactly
20080ffb0e17SBarry Smith $      *) FULL factorization is a direct solver.
20090ffb0e17SBarry Smith $      *) The preconditioned operator with LOWER or UPPER has all eigenvalues equal to 1 and minimal polynomial of degree 2, so KSPGMRES converges in 2 iterations.
20100ffb0e17SBarry Smith $      *) With DIAG, the preconditioned operator has three distinct nonzero eigenvalues and minimal polynomial of degree at most 4, so KSPGMRES converges in at most 4 iterations.
2011ab1df9f5SJed Brown 
20120ffb0e17SBarry Smith     If the iteration count is very low, consider using KSPFGMRES or KSPGCR which can use one less preconditioner
20130ffb0e17SBarry 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.
20140ffb0e17SBarry Smith 
20150ffb0e17SBarry Smith     For symmetric problems in which A is positive definite and S is negative definite, DIAG can be used with KSPMINRES.
20160ffb0e17SBarry Smith 
20170ffb0e17SBarry Smith     Note that a flexible method like KSPFGMRES or KSPGCR must be used if the fieldsplit preconditioner is nonlinear (e.g. a few iterations of a Krylov method is used to solve with A or S).
2018ab1df9f5SJed Brown 
2019ab1df9f5SJed Brown     References:
202096a0c994SBarry Smith +   1. - Murphy, Golub, and Wathen, A note on preconditioning indefinite linear systems, SIAM J. Sci. Comput., 21 (2000).
202196a0c994SBarry Smith -   2. - Ipsen, A note on preconditioning nonsymmetric matrices, SIAM J. Sci. Comput., 23 (2001).
2022ab1df9f5SJed Brown 
2023c096484dSStefano Zampini .seealso: PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitSetFields(), PCFieldSplitSchurPreType, PCFieldSplitSetSchurScale()
2024ab1df9f5SJed Brown @*/
2025c9c6ffaaSJed Brown PetscErrorCode  PCFieldSplitSetSchurFactType(PC pc,PCFieldSplitSchurFactType ftype)
2026ab1df9f5SJed Brown {
2027ab1df9f5SJed Brown   PetscErrorCode ierr;
2028ab1df9f5SJed Brown 
2029ab1df9f5SJed Brown   PetscFunctionBegin;
2030ab1df9f5SJed Brown   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
2031c9c6ffaaSJed Brown   ierr = PetscTryMethod(pc,"PCFieldSplitSetSchurFactType_C",(PC,PCFieldSplitSchurFactType),(pc,ftype));CHKERRQ(ierr);
2032ab1df9f5SJed Brown   PetscFunctionReturn(0);
2033ab1df9f5SJed Brown }
2034ab1df9f5SJed Brown 
20351e6b0712SBarry Smith static PetscErrorCode PCFieldSplitSetSchurFactType_FieldSplit(PC pc,PCFieldSplitSchurFactType ftype)
2036ab1df9f5SJed Brown {
2037ab1df9f5SJed Brown   PC_FieldSplit *jac = (PC_FieldSplit*)pc->data;
2038ab1df9f5SJed Brown 
2039ab1df9f5SJed Brown   PetscFunctionBegin;
2040ab1df9f5SJed Brown   jac->schurfactorization = ftype;
2041ab1df9f5SJed Brown   PetscFunctionReturn(0);
2042ab1df9f5SJed Brown }
2043ab1df9f5SJed Brown 
2044c096484dSStefano Zampini /*@
2045c096484dSStefano Zampini     PCFieldSplitSetSchurScale -  Controls the sign flip of S for PC_FIELDSPLIT_SCHUR_FACT_DIAG.
2046c096484dSStefano Zampini 
2047c096484dSStefano Zampini     Collective on PC
2048c096484dSStefano Zampini 
2049c096484dSStefano Zampini     Input Parameters:
2050c096484dSStefano Zampini +   pc    - the preconditioner context
2051c096484dSStefano Zampini -   scale - scaling factor for the Schur complement
2052c096484dSStefano Zampini 
2053c096484dSStefano Zampini     Options Database:
2054c096484dSStefano Zampini .     -pc_fieldsplit_schur_scale - default is -1.0
2055c096484dSStefano Zampini 
2056c096484dSStefano Zampini     Level: intermediate
2057c096484dSStefano Zampini 
2058c096484dSStefano Zampini .seealso: PCFIELDSPLIT, PCFieldSplitSetFields(), PCFieldSplitSchurFactType, PCFieldSplitSetSchurScale()
2059c096484dSStefano Zampini @*/
2060c096484dSStefano Zampini PetscErrorCode PCFieldSplitSetSchurScale(PC pc,PetscScalar scale)
2061c096484dSStefano Zampini {
2062c096484dSStefano Zampini   PetscErrorCode ierr;
2063c096484dSStefano Zampini 
2064c096484dSStefano Zampini   PetscFunctionBegin;
2065c096484dSStefano Zampini   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
2066c096484dSStefano Zampini   PetscValidLogicalCollectiveScalar(pc,scale,2);
2067c096484dSStefano Zampini   ierr = PetscTryMethod(pc,"PCFieldSplitSetSchurScale_C",(PC,PetscScalar),(pc,scale));CHKERRQ(ierr);
2068c096484dSStefano Zampini   PetscFunctionReturn(0);
2069c096484dSStefano Zampini }
2070c096484dSStefano Zampini 
2071c096484dSStefano Zampini static PetscErrorCode PCFieldSplitSetSchurScale_FieldSplit(PC pc,PetscScalar scale)
2072c096484dSStefano Zampini {
2073c096484dSStefano Zampini   PC_FieldSplit *jac = (PC_FieldSplit*)pc->data;
2074c096484dSStefano Zampini 
2075c096484dSStefano Zampini   PetscFunctionBegin;
2076c096484dSStefano Zampini   jac->schurscale = scale;
2077c096484dSStefano Zampini   PetscFunctionReturn(0);
2078c096484dSStefano Zampini }
2079c096484dSStefano Zampini 
208030ad9308SMatthew Knepley /*@C
20818c03b21aSDmitry Karpeev    PCFieldSplitGetSchurBlocks - Gets all matrix blocks for the Schur complement
208230ad9308SMatthew Knepley 
208330ad9308SMatthew Knepley    Collective on KSP
208430ad9308SMatthew Knepley 
208530ad9308SMatthew Knepley    Input Parameter:
208630ad9308SMatthew Knepley .  pc - the preconditioner context
208730ad9308SMatthew Knepley 
208830ad9308SMatthew Knepley    Output Parameters:
2089a04f6461SBarry Smith +  A00 - the (0,0) block
2090a04f6461SBarry Smith .  A01 - the (0,1) block
2091a04f6461SBarry Smith .  A10 - the (1,0) block
2092a04f6461SBarry Smith -  A11 - the (1,1) block
209330ad9308SMatthew Knepley 
209430ad9308SMatthew Knepley    Level: advanced
209530ad9308SMatthew Knepley 
209630ad9308SMatthew Knepley .seealso: PCFIELDSPLIT
209730ad9308SMatthew Knepley @*/
2098a04f6461SBarry Smith PetscErrorCode  PCFieldSplitGetSchurBlocks(PC pc,Mat *A00,Mat *A01,Mat *A10, Mat *A11)
209930ad9308SMatthew Knepley {
210030ad9308SMatthew Knepley   PC_FieldSplit *jac = (PC_FieldSplit*) pc->data;
210130ad9308SMatthew Knepley 
210230ad9308SMatthew Knepley   PetscFunctionBegin;
21030700a824SBarry Smith   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
2104ce94432eSBarry Smith   if (jac->type != PC_COMPOSITE_SCHUR) SETERRQ(PetscObjectComm((PetscObject)pc),PETSC_ERR_ARG_WRONG, "FieldSplit is not using a Schur complement approach.");
2105a04f6461SBarry Smith   if (A00) *A00 = jac->pmat[0];
2106a04f6461SBarry Smith   if (A01) *A01 = jac->B;
2107a04f6461SBarry Smith   if (A10) *A10 = jac->C;
2108a04f6461SBarry Smith   if (A11) *A11 = jac->pmat[1];
210930ad9308SMatthew Knepley   PetscFunctionReturn(0);
211030ad9308SMatthew Knepley }
211130ad9308SMatthew Knepley 
21121e6b0712SBarry Smith static PetscErrorCode  PCFieldSplitSetType_FieldSplit(PC pc,PCCompositeType type)
211379416396SBarry Smith {
211479416396SBarry Smith   PC_FieldSplit  *jac = (PC_FieldSplit*)pc->data;
2115e69d4d44SBarry Smith   PetscErrorCode ierr;
211679416396SBarry Smith 
211779416396SBarry Smith   PetscFunctionBegin;
211879416396SBarry Smith   jac->type = type;
21193b224e63SBarry Smith   if (type == PC_COMPOSITE_SCHUR) {
21203b224e63SBarry Smith     pc->ops->apply = PCApply_FieldSplit_Schur;
21213b224e63SBarry Smith     pc->ops->view  = PCView_FieldSplit_Schur;
21222fa5cd67SKarl Rupp 
2123bdf89e91SBarry Smith     ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitGetSubKSP_C",PCFieldSplitGetSubKSP_FieldSplit_Schur);CHKERRQ(ierr);
212429f8a81cSJed Brown     ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetSchurPre_C",PCFieldSplitSetSchurPre_FieldSplit);CHKERRQ(ierr);
212537a82bf0SJed Brown     ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitGetSchurPre_C",PCFieldSplitGetSchurPre_FieldSplit);CHKERRQ(ierr);
2126bdf89e91SBarry Smith     ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetSchurFactType_C",PCFieldSplitSetSchurFactType_FieldSplit);CHKERRQ(ierr);
2127c096484dSStefano Zampini     ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetSchurScale_C",PCFieldSplitSetSchurScale_FieldSplit);CHKERRQ(ierr);
2128e69d4d44SBarry Smith 
21293b224e63SBarry Smith   } else {
21303b224e63SBarry Smith     pc->ops->apply = PCApply_FieldSplit;
21313b224e63SBarry Smith     pc->ops->view  = PCView_FieldSplit;
21322fa5cd67SKarl Rupp 
2133bdf89e91SBarry Smith     ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitGetSubKSP_C",PCFieldSplitGetSubKSP_FieldSplit);CHKERRQ(ierr);
213429f8a81cSJed Brown     ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetSchurPre_C",0);CHKERRQ(ierr);
213537a82bf0SJed Brown     ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitGetSchurPre_C",0);CHKERRQ(ierr);
2136bdf89e91SBarry Smith     ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetSchurFactType_C",0);CHKERRQ(ierr);
2137c096484dSStefano Zampini     ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetSchurScale_C",0);CHKERRQ(ierr);
21383b224e63SBarry Smith   }
213979416396SBarry Smith   PetscFunctionReturn(0);
214079416396SBarry Smith }
214179416396SBarry Smith 
21421e6b0712SBarry Smith static PetscErrorCode  PCFieldSplitSetBlockSize_FieldSplit(PC pc,PetscInt bs)
214351f519a2SBarry Smith {
214451f519a2SBarry Smith   PC_FieldSplit *jac = (PC_FieldSplit*)pc->data;
214551f519a2SBarry Smith 
214651f519a2SBarry Smith   PetscFunctionBegin;
2147ce94432eSBarry Smith   if (bs < 1) SETERRQ1(PetscObjectComm((PetscObject)pc),PETSC_ERR_ARG_OUTOFRANGE,"Blocksize must be positive, you gave %D",bs);
2148ce94432eSBarry 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);
214951f519a2SBarry Smith   jac->bs = bs;
215051f519a2SBarry Smith   PetscFunctionReturn(0);
215151f519a2SBarry Smith }
215251f519a2SBarry Smith 
2153bc08b0f1SBarry Smith /*@
215479416396SBarry Smith    PCFieldSplitSetType - Sets the type of fieldsplit preconditioner.
215579416396SBarry Smith 
215679416396SBarry Smith    Collective on PC
215779416396SBarry Smith 
215879416396SBarry Smith    Input Parameter:
215979416396SBarry Smith .  pc - the preconditioner context
216081540f2fSBarry Smith .  type - PC_COMPOSITE_ADDITIVE, PC_COMPOSITE_MULTIPLICATIVE (default), PC_COMPOSITE_SYMMETRIC_MULTIPLICATIVE, PC_COMPOSITE_SPECIAL, PC_COMPOSITE_SCHUR
216179416396SBarry Smith 
216279416396SBarry Smith    Options Database Key:
2163a4efd8eaSMatthew Knepley .  -pc_fieldsplit_type <type: one of multiplicative, additive, symmetric_multiplicative, special, schur> - Sets fieldsplit preconditioner type
216479416396SBarry Smith 
2165b02e2d75SMatthew G Knepley    Level: Intermediate
216679416396SBarry Smith 
216779416396SBarry Smith .keywords: PC, set, type, composite preconditioner, additive, multiplicative
216879416396SBarry Smith 
216979416396SBarry Smith .seealso: PCCompositeSetType()
217079416396SBarry Smith 
217179416396SBarry Smith @*/
21727087cfbeSBarry Smith PetscErrorCode  PCFieldSplitSetType(PC pc,PCCompositeType type)
217379416396SBarry Smith {
21744ac538c5SBarry Smith   PetscErrorCode ierr;
217579416396SBarry Smith 
217679416396SBarry Smith   PetscFunctionBegin;
21770700a824SBarry Smith   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
21784ac538c5SBarry Smith   ierr = PetscTryMethod(pc,"PCFieldSplitSetType_C",(PC,PCCompositeType),(pc,type));CHKERRQ(ierr);
217979416396SBarry Smith   PetscFunctionReturn(0);
218079416396SBarry Smith }
218179416396SBarry Smith 
2182b02e2d75SMatthew G Knepley /*@
2183b02e2d75SMatthew G Knepley   PCFieldSplitGetType - Gets the type of fieldsplit preconditioner.
2184b02e2d75SMatthew G Knepley 
2185b02e2d75SMatthew G Knepley   Not collective
2186b02e2d75SMatthew G Knepley 
2187b02e2d75SMatthew G Knepley   Input Parameter:
2188b02e2d75SMatthew G Knepley . pc - the preconditioner context
2189b02e2d75SMatthew G Knepley 
2190b02e2d75SMatthew G Knepley   Output Parameter:
2191b02e2d75SMatthew G Knepley . type - PC_COMPOSITE_ADDITIVE, PC_COMPOSITE_MULTIPLICATIVE (default), PC_COMPOSITE_SYMMETRIC_MULTIPLICATIVE, PC_COMPOSITE_SPECIAL, PC_COMPOSITE_SCHUR
2192b02e2d75SMatthew G Knepley 
2193b02e2d75SMatthew G Knepley   Level: Intermediate
2194b02e2d75SMatthew G Knepley 
2195b02e2d75SMatthew G Knepley .keywords: PC, set, type, composite preconditioner, additive, multiplicative
2196b02e2d75SMatthew G Knepley .seealso: PCCompositeSetType()
2197b02e2d75SMatthew G Knepley @*/
2198b02e2d75SMatthew G Knepley PetscErrorCode PCFieldSplitGetType(PC pc, PCCompositeType *type)
2199b02e2d75SMatthew G Knepley {
2200b02e2d75SMatthew G Knepley   PC_FieldSplit *jac = (PC_FieldSplit*) pc->data;
2201b02e2d75SMatthew G Knepley 
2202b02e2d75SMatthew G Knepley   PetscFunctionBegin;
2203b02e2d75SMatthew G Knepley   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
2204b02e2d75SMatthew G Knepley   PetscValidIntPointer(type,2);
2205b02e2d75SMatthew G Knepley   *type = jac->type;
2206b02e2d75SMatthew G Knepley   PetscFunctionReturn(0);
2207b02e2d75SMatthew G Knepley }
2208b02e2d75SMatthew G Knepley 
22094ab8060aSDmitry Karpeev /*@
22104ab8060aSDmitry Karpeev    PCFieldSplitSetDMSplits - Flags whether DMCreateFieldDecomposition() should be used to define the splits, whenever possible.
22114ab8060aSDmitry Karpeev 
22124ab8060aSDmitry Karpeev    Logically Collective
22134ab8060aSDmitry Karpeev 
22144ab8060aSDmitry Karpeev    Input Parameters:
22154ab8060aSDmitry Karpeev +  pc   - the preconditioner context
22164ab8060aSDmitry Karpeev -  flg  - boolean indicating whether to use field splits defined by the DM
22174ab8060aSDmitry Karpeev 
22184ab8060aSDmitry Karpeev    Options Database Key:
22194ab8060aSDmitry Karpeev .  -pc_fieldsplit_dm_splits
22204ab8060aSDmitry Karpeev 
22214ab8060aSDmitry Karpeev    Level: Intermediate
22224ab8060aSDmitry Karpeev 
22234ab8060aSDmitry Karpeev .keywords: PC, DM, composite preconditioner, additive, multiplicative
22244ab8060aSDmitry Karpeev 
22254ab8060aSDmitry Karpeev .seealso: PCFieldSplitGetDMSplits()
22264ab8060aSDmitry Karpeev 
22274ab8060aSDmitry Karpeev @*/
22284ab8060aSDmitry Karpeev PetscErrorCode  PCFieldSplitSetDMSplits(PC pc,PetscBool flg)
22294ab8060aSDmitry Karpeev {
22304ab8060aSDmitry Karpeev   PC_FieldSplit  *jac = (PC_FieldSplit*)pc->data;
22314ab8060aSDmitry Karpeev   PetscBool      isfs;
22324ab8060aSDmitry Karpeev   PetscErrorCode ierr;
22334ab8060aSDmitry Karpeev 
22344ab8060aSDmitry Karpeev   PetscFunctionBegin;
22354ab8060aSDmitry Karpeev   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
22364ab8060aSDmitry Karpeev   PetscValidLogicalCollectiveBool(pc,flg,2);
22374ab8060aSDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)pc,PCFIELDSPLIT,&isfs);CHKERRQ(ierr);
22384ab8060aSDmitry Karpeev   if (isfs) {
22394ab8060aSDmitry Karpeev     jac->dm_splits = flg;
22404ab8060aSDmitry Karpeev   }
22414ab8060aSDmitry Karpeev   PetscFunctionReturn(0);
22424ab8060aSDmitry Karpeev }
22434ab8060aSDmitry Karpeev 
22444ab8060aSDmitry Karpeev 
22454ab8060aSDmitry Karpeev /*@
22464ab8060aSDmitry Karpeev    PCFieldSplitGetDMSplits - Returns flag indicating whether DMCreateFieldDecomposition() should be used to define the splits, whenever possible.
22474ab8060aSDmitry Karpeev 
22484ab8060aSDmitry Karpeev    Logically Collective
22494ab8060aSDmitry Karpeev 
22504ab8060aSDmitry Karpeev    Input Parameter:
22514ab8060aSDmitry Karpeev .  pc   - the preconditioner context
22524ab8060aSDmitry Karpeev 
22534ab8060aSDmitry Karpeev    Output Parameter:
22544ab8060aSDmitry Karpeev .  flg  - boolean indicating whether to use field splits defined by the DM
22554ab8060aSDmitry Karpeev 
22564ab8060aSDmitry Karpeev    Level: Intermediate
22574ab8060aSDmitry Karpeev 
22584ab8060aSDmitry Karpeev .keywords: PC, DM, composite preconditioner, additive, multiplicative
22594ab8060aSDmitry Karpeev 
22604ab8060aSDmitry Karpeev .seealso: PCFieldSplitSetDMSplits()
22614ab8060aSDmitry Karpeev 
22624ab8060aSDmitry Karpeev @*/
22634ab8060aSDmitry Karpeev PetscErrorCode  PCFieldSplitGetDMSplits(PC pc,PetscBool* flg)
22644ab8060aSDmitry Karpeev {
22654ab8060aSDmitry Karpeev   PC_FieldSplit  *jac = (PC_FieldSplit*)pc->data;
22664ab8060aSDmitry Karpeev   PetscBool      isfs;
22674ab8060aSDmitry Karpeev   PetscErrorCode ierr;
22684ab8060aSDmitry Karpeev 
22694ab8060aSDmitry Karpeev   PetscFunctionBegin;
22704ab8060aSDmitry Karpeev   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
22714ab8060aSDmitry Karpeev   PetscValidPointer(flg,2);
22724ab8060aSDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)pc,PCFIELDSPLIT,&isfs);CHKERRQ(ierr);
22734ab8060aSDmitry Karpeev   if (isfs) {
22744ab8060aSDmitry Karpeev     if(flg) *flg = jac->dm_splits;
22754ab8060aSDmitry Karpeev   }
22764ab8060aSDmitry Karpeev   PetscFunctionReturn(0);
22774ab8060aSDmitry Karpeev }
22784ab8060aSDmitry Karpeev 
2279*7b752e3dSPatrick Sanan /*@
2280*7b752e3dSPatrick Sanan    PCFieldSplitGetDetectSaddlePoint - Returns flag indicating whether PCFieldSplit will attempt to automatically determine fields based on zero diagonal entries.
2281*7b752e3dSPatrick Sanan 
2282*7b752e3dSPatrick Sanan    Logically Collective
2283*7b752e3dSPatrick Sanan 
2284*7b752e3dSPatrick Sanan    Input Parameter:
2285*7b752e3dSPatrick Sanan .  pc   - the preconditioner context
2286*7b752e3dSPatrick Sanan 
2287*7b752e3dSPatrick Sanan    Output Parameter:
2288*7b752e3dSPatrick Sanan .  flg  - boolean indicating whether to detect fields or not
2289*7b752e3dSPatrick Sanan 
2290*7b752e3dSPatrick Sanan    Level: Intermediate
2291*7b752e3dSPatrick Sanan 
2292*7b752e3dSPatrick Sanan .seealso: PCFIELDSPLIT, PCFieldSplitSetDetectSaddlePoint()
2293*7b752e3dSPatrick Sanan 
2294*7b752e3dSPatrick Sanan @*/
2295*7b752e3dSPatrick Sanan PetscErrorCode PCFieldSplitGetDetectSaddlePoint(PC pc,PetscBool *flg)
2296*7b752e3dSPatrick Sanan {
2297*7b752e3dSPatrick Sanan   PC_FieldSplit *jac = (PC_FieldSplit*)pc->data;
2298*7b752e3dSPatrick Sanan 
2299*7b752e3dSPatrick Sanan   PetscFunctionBegin;
2300*7b752e3dSPatrick Sanan   *flg = jac->detect;
2301*7b752e3dSPatrick Sanan   PetscFunctionReturn(0);
2302*7b752e3dSPatrick Sanan }
2303*7b752e3dSPatrick Sanan 
2304*7b752e3dSPatrick Sanan /*@
2305*7b752e3dSPatrick Sanan    PCFieldSplitSetDetectSaddlePoint - Sets flag indicating whether PCFieldSplit will attempt to automatically determine fields based on zero diagonal entries.
2306*7b752e3dSPatrick Sanan 
2307*7b752e3dSPatrick Sanan    Logically Collective
2308*7b752e3dSPatrick Sanan 
2309*7b752e3dSPatrick Sanan    Notes:
2310*7b752e3dSPatrick Sanan    Also sets the split type to PC_COMPOSITE_SCHUR (see PCFieldSplitSetType()) and the Schur preconditioner type to PC_FIELDSPLIT_SCHUR_PRE_SELF (see PCFieldSplitSetSchurPre()).
2311*7b752e3dSPatrick Sanan 
2312*7b752e3dSPatrick Sanan    Input Parameter:
2313*7b752e3dSPatrick Sanan .  pc   - the preconditioner context
2314*7b752e3dSPatrick Sanan 
2315*7b752e3dSPatrick Sanan    Output Parameter:
2316*7b752e3dSPatrick Sanan .  flg  - boolean indicating whether to detect fields or not
2317*7b752e3dSPatrick Sanan 
2318*7b752e3dSPatrick Sanan    Options Database Key:
2319*7b752e3dSPatrick Sanan .  -pc_fieldsplit_detect_saddle_point
2320*7b752e3dSPatrick Sanan 
2321*7b752e3dSPatrick Sanan    Level: Intermediate
2322*7b752e3dSPatrick Sanan 
2323*7b752e3dSPatrick Sanan .seealso: PCFIELDSPLIT, PCFieldSplitSetDetectSaddlePoint(), PCFieldSplitSetType(), PCFieldSplitSetSchurPre()
2324*7b752e3dSPatrick Sanan 
2325*7b752e3dSPatrick Sanan @*/
2326*7b752e3dSPatrick Sanan PetscErrorCode PCFieldSplitSetDetectSaddlePoint(PC pc,PetscBool flg)
2327*7b752e3dSPatrick Sanan {
2328*7b752e3dSPatrick Sanan   PC_FieldSplit  *jac = (PC_FieldSplit*)pc->data;
2329*7b752e3dSPatrick Sanan   PetscErrorCode ierr;
2330*7b752e3dSPatrick Sanan 
2331*7b752e3dSPatrick Sanan   PetscFunctionBegin;
2332*7b752e3dSPatrick Sanan   jac->detect = flg;
2333*7b752e3dSPatrick Sanan   if (jac->detect) {
2334*7b752e3dSPatrick Sanan     ierr = PCFieldSplitSetType(pc,PC_COMPOSITE_SCHUR);CHKERRQ(ierr);
2335*7b752e3dSPatrick Sanan     ierr = PCFieldSplitSetSchurPre(pc,PC_FIELDSPLIT_SCHUR_PRE_SELF,NULL);CHKERRQ(ierr);
2336*7b752e3dSPatrick Sanan   }
2337*7b752e3dSPatrick Sanan   PetscFunctionReturn(0);
2338*7b752e3dSPatrick Sanan }
2339*7b752e3dSPatrick Sanan 
23400971522cSBarry Smith /* -------------------------------------------------------------------------------------*/
23410971522cSBarry Smith /*MC
2342a8c7a070SBarry Smith    PCFIELDSPLIT - Preconditioner created by combining separate preconditioners for individual
2343a04f6461SBarry Smith                   fields or groups of fields. See the users manual section "Solving Block Matrices" for more details.
23440971522cSBarry Smith 
2345edf189efSBarry Smith      To set options on the solvers for each block append -fieldsplit_ to all the PC
2346edf189efSBarry Smith         options database keys. For example, -fieldsplit_pc_type ilu -fieldsplit_pc_factor_levels 1
23470971522cSBarry Smith 
2348a8c7a070SBarry Smith      To set the options on the solvers separate for each block call PCFieldSplitGetSubKSP()
234969a612a9SBarry Smith          and set the options directly on the resulting KSP object
23500971522cSBarry Smith 
23510971522cSBarry Smith    Level: intermediate
23520971522cSBarry Smith 
235379416396SBarry Smith    Options Database Keys:
235481540f2fSBarry Smith +   -pc_fieldsplit_%d_fields <a,b,..> - indicates the fields to be used in the %d'th split
235581540f2fSBarry Smith .   -pc_fieldsplit_default - automatically add any fields to additional splits that have not
235681540f2fSBarry Smith                               been supplied explicitly by -pc_fieldsplit_%d_fields
235781540f2fSBarry Smith .   -pc_fieldsplit_block_size <bs> - size of block that defines fields (i.e. there are bs fields)
23580f188ba9SJed Brown .   -pc_fieldsplit_type <additive,multiplicative,symmetric_multiplicative,schur> - type of relaxation or factorization splitting
2359a6a584a2SBarry Smith .   -pc_fieldsplit_schur_precondition <self,selfp,user,a11,full> - default is a11; see PCFieldSplitSetSchurPre()
2360*7b752e3dSPatrick Sanan .   -pc_fieldsplit_detect_saddle_point - automatically finds rows with zero diagonal and uses Schur complement with no preconditioner as the solver
236179416396SBarry Smith 
23625d4c12cdSJungho Lee -    Options prefix for inner solvers when using Schur complement preconditioner are -fieldsplit_0_ and -fieldsplit_1_
23635d4c12cdSJungho Lee      for all other solvers they are -fieldsplit_%d_ for the dth field, use -fieldsplit_ for all fields
23645d4c12cdSJungho Lee 
2365c8a0d604SMatthew G Knepley    Notes:
2366c8a0d604SMatthew G Knepley     Use PCFieldSplitSetFields() to set fields defined by "strided" entries and PCFieldSplitSetIS()
2367d32f9abdSBarry Smith      to define a field by an arbitrary collection of entries.
2368d32f9abdSBarry Smith 
2369d32f9abdSBarry Smith       If no fields are set the default is used. The fields are defined by entries strided by bs,
2370d32f9abdSBarry Smith       beginning at 0 then 1, etc to bs-1. The block size can be set with PCFieldSplitSetBlockSize(),
2371d32f9abdSBarry Smith       if this is not called the block size defaults to the blocksize of the second matrix passed
2372d32f9abdSBarry Smith       to KSPSetOperators()/PCSetOperators().
2373d32f9abdSBarry Smith 
2374c8a0d604SMatthew G Knepley $     For the Schur complement preconditioner if J = ( A00 A01 )
2375c8a0d604SMatthew G Knepley $                                                    ( A10 A11 )
2376c8a0d604SMatthew G Knepley $     the preconditioner using full factorization is
237713b05affSJed Brown $              ( I   -ksp(A00) A01 ) ( inv(A00)     0  ) (     I          0  )
2378c8a0d604SMatthew G Knepley $              ( 0         I       ) (   0      ksp(S) ) ( -A10 ksp(A00)  I  )
237913b05affSJed Brown      where the action of inv(A00) is applied using the KSP solver with prefix -fieldsplit_0_.  S is the Schur complement
238013b05affSJed Brown $              S = A11 - A10 ksp(A00) A01
238113b05affSJed 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
2382c8a0d604SMatthew G Knepley      in providing the SECOND split or 1 if not give). For PCFieldSplitGetKSP() when field number is 0,
2383c8a0d604SMatthew G Knepley      it returns the KSP associated with -fieldsplit_0_ while field number 1 gives -fieldsplit_1_ KSP. By default
2384a6a584a2SBarry Smith      A11 is used to construct a preconditioner for S, use PCFieldSplitSetSchurPre() for all the possible ways to construct the preconditioner for S.
23851d71051fSDmitry Karpeev 
2386a7476a74SDmitry Karpeev      The factorization type is set using -pc_fieldsplit_schur_fact_type <diag, lower, upper, full>. The full is shown above,
23875668aaf4SBarry Smith      diag gives
2388c8a0d604SMatthew G Knepley $              ( inv(A00)     0   )
2389c8a0d604SMatthew G Knepley $              (   0      -ksp(S) )
2390c096484dSStefano Zampini      note that slightly counter intuitively there is a negative in front of the ksp(S) so that the preconditioner is positive definite. For SPD matrices J, the sign flip
2391c096484dSStefano Zampini      can be turned off with PCFieldSplitSetSchurScale() or by command line -pc_fieldsplit_schur_scale 1.0. The lower factorization is the inverse of
2392c8a0d604SMatthew G Knepley $              (  A00   0 )
2393c8a0d604SMatthew G Knepley $              (  A10   S )
2394c8a0d604SMatthew G Knepley      where the inverses of A00 and S are applied using KSPs. The upper factorization is the inverse of
2395c8a0d604SMatthew G Knepley $              ( A00 A01 )
2396c8a0d604SMatthew G Knepley $              (  0   S  )
2397c8a0d604SMatthew G Knepley      where again the inverses of A00 and S are applied using KSPs.
2398e69d4d44SBarry Smith 
2399edf189efSBarry Smith      If only one set of indices (one IS) is provided with PCFieldSplitSetIS() then the complement of that IS
2400edf189efSBarry Smith      is used automatically for a second block.
2401edf189efSBarry Smith 
2402ff218e97SBarry Smith      The fieldsplit preconditioner cannot currently be used with the BAIJ or SBAIJ data formats if the blocksize is larger than 1.
2403ff218e97SBarry Smith      Generally it should be used with the AIJ format.
2404ff218e97SBarry Smith 
2405ff218e97SBarry Smith      The forms of these preconditioners are closely related if not identical to forms derived as "Distributive Iterations", see,
2406ff218e97SBarry Smith      for example, page 294 in "Principles of Computational Fluid Dynamics" by Pieter Wesseling. Note that one can also use PCFIELDSPLIT
2407ff218e97SBarry Smith      inside a smoother resulting in "Distributive Smoothers".
24080716a85fSBarry Smith 
2409a541d17aSBarry Smith    Concepts: physics based preconditioners, block preconditioners
24100971522cSBarry Smith 
24113bc631e0SBarry Smith    There is a nice discussion of block preconditioners in
24123bc631e0SBarry Smith 
24133bc631e0SBarry Smith [El08] A taxonomy and comparison of parallel block multi-level preconditioners for the incompressible Navier-Stokes equations
24143bc631e0SBarry Smith        Howard Elman, V.E. Howle, John Shadid, Robert Shuttleworth, Ray Tuminaro, Journal of Computational Physics 227 (2008) 1790--1808
24153bc631e0SBarry Smith        http://chess.cs.umd.edu/~elman/papers/tax.pdf
24163bc631e0SBarry Smith 
24174d308398SBarry Smith    The Constrained Pressure Preconditioner (CPR) can be implemented using PCCOMPOSITE with PCGALERKIN. CPR first solves an R A P subsystem, updates the
24184d308398SBarry Smith    residual on all variables (PCCompositeSetType(pc,PC_COMPOSITE_MULTIPLICATIVE)), and then applies a simple ILU like preconditioner on all the variables.
2419a6a584a2SBarry Smith 
24207e8cb189SBarry Smith .seealso:  PCCreate(), PCSetType(), PCType (for list of available types), PC, Block_Preconditioners, PCLSC,
24211d71051fSDmitry Karpeev            PCFieldSplitGetSubKSP(), PCFieldSplitSetFields(), PCFieldSplitSetType(), PCFieldSplitSetIS(), PCFieldSplitSetSchurPre(),
2422*7b752e3dSPatrick Sanan           MatSchurComplementSetAinvType(), PCFieldSplitSetSchurScale(),
2423*7b752e3dSPatrick Sanan           PCFieldSplitSetDetectSaddlePoint()
24240971522cSBarry Smith M*/
24250971522cSBarry Smith 
24268cc058d9SJed Brown PETSC_EXTERN PetscErrorCode PCCreate_FieldSplit(PC pc)
24270971522cSBarry Smith {
24280971522cSBarry Smith   PetscErrorCode ierr;
24290971522cSBarry Smith   PC_FieldSplit  *jac;
24300971522cSBarry Smith 
24310971522cSBarry Smith   PetscFunctionBegin;
2432b00a9115SJed Brown   ierr = PetscNewLog(pc,&jac);CHKERRQ(ierr);
24332fa5cd67SKarl Rupp 
24340971522cSBarry Smith   jac->bs                 = -1;
24350971522cSBarry Smith   jac->nsplits            = 0;
24363e197d65SBarry Smith   jac->type               = PC_COMPOSITE_MULTIPLICATIVE;
2437e6cab6aaSJed Brown   jac->schurpre           = PC_FIELDSPLIT_SCHUR_PRE_USER; /* Try user preconditioner first, fall back on diagonal */
2438c9c6ffaaSJed Brown   jac->schurfactorization = PC_FIELDSPLIT_SCHUR_FACT_FULL;
2439c096484dSStefano Zampini   jac->schurscale         = -1.0;
2440fbe7908bSJed Brown   jac->dm_splits          = PETSC_TRUE;
2441*7b752e3dSPatrick Sanan   jac->detect             = PETSC_FALSE;
244251f519a2SBarry Smith 
24430971522cSBarry Smith   pc->data = (void*)jac;
24440971522cSBarry Smith 
24450971522cSBarry Smith   pc->ops->apply           = PCApply_FieldSplit;
2446421e10b8SBarry Smith   pc->ops->applytranspose  = PCApplyTranspose_FieldSplit;
24470971522cSBarry Smith   pc->ops->setup           = PCSetUp_FieldSplit;
2448574deadeSBarry Smith   pc->ops->reset           = PCReset_FieldSplit;
24490971522cSBarry Smith   pc->ops->destroy         = PCDestroy_FieldSplit;
24500971522cSBarry Smith   pc->ops->setfromoptions  = PCSetFromOptions_FieldSplit;
24510971522cSBarry Smith   pc->ops->view            = PCView_FieldSplit;
24520971522cSBarry Smith   pc->ops->applyrichardson = 0;
24530971522cSBarry Smith 
2454bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitGetSubKSP_C",PCFieldSplitGetSubKSP_FieldSplit);CHKERRQ(ierr);
2455bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetFields_C",PCFieldSplitSetFields_FieldSplit);CHKERRQ(ierr);
2456bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetIS_C",PCFieldSplitSetIS_FieldSplit);CHKERRQ(ierr);
2457bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetType_C",PCFieldSplitSetType_FieldSplit);CHKERRQ(ierr);
2458bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetBlockSize_C",PCFieldSplitSetBlockSize_FieldSplit);CHKERRQ(ierr);
24596dbb499eSCian Wilson   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitRestrictIS_C",PCFieldSplitRestrictIS_FieldSplit);CHKERRQ(ierr);
24600971522cSBarry Smith   PetscFunctionReturn(0);
24610971522cSBarry Smith }
2462