xref: /petsc/src/ksp/pc/impls/fieldsplit/fieldsplit.c (revision ef7efd37182b12f7b7ab7c34390aae8e592a83c2)
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) */
557b752e3dSPatrick Sanan   PetscBool                 detect;                 /* Whether to form 2-way split by finding zero diagonal entries */
560971522cSBarry Smith } PC_FieldSplit;
570971522cSBarry Smith 
5816913363SBarry Smith /*
5995452b02SPatrick Sanan     Notes:
6095452b02SPatrick Sanan     there is no particular reason that pmat, x, and y are stored as arrays in PC_FieldSplit instead of
6116913363SBarry Smith    inside PC_FieldSplitLink, just historical. If you want to be able to add new fields after already using the
6216913363SBarry Smith    PC you could change this.
6316913363SBarry Smith */
64084e4875SJed Brown 
65e6cab6aaSJed Brown /* This helper is so that setting a user-provided preconditioning matrix is orthogonal to choosing to use it.  This way the
66084e4875SJed Brown * application-provided FormJacobian can provide this matrix without interfering with the user's (command-line) choices. */
67084e4875SJed Brown static Mat FieldSplitSchurPre(PC_FieldSplit *jac)
68084e4875SJed Brown {
69084e4875SJed Brown   switch (jac->schurpre) {
70084e4875SJed Brown   case PC_FIELDSPLIT_SCHUR_PRE_SELF: return jac->schur;
71a7476a74SDmitry Karpeev   case PC_FIELDSPLIT_SCHUR_PRE_SELFP: return jac->schurp;
72e87fab1bSBarry Smith   case PC_FIELDSPLIT_SCHUR_PRE_A11: return jac->pmat[1];
73e74569cdSMatthew G. Knepley   case PC_FIELDSPLIT_SCHUR_PRE_FULL: /* We calculate this and store it in schur_user */
74084e4875SJed Brown   case PC_FIELDSPLIT_SCHUR_PRE_USER: /* Use a user-provided matrix if it is given, otherwise diagonal block */
75084e4875SJed Brown   default:
76084e4875SJed Brown     return jac->schur_user ? jac->schur_user : jac->pmat[1];
77084e4875SJed Brown   }
78084e4875SJed Brown }
79084e4875SJed Brown 
80084e4875SJed Brown 
819804daf3SBarry Smith #include <petscdraw.h>
820971522cSBarry Smith static PetscErrorCode PCView_FieldSplit(PC pc,PetscViewer viewer)
830971522cSBarry Smith {
840971522cSBarry Smith   PC_FieldSplit     *jac = (PC_FieldSplit*)pc->data;
850971522cSBarry Smith   PetscErrorCode    ierr;
86d9884438SBarry Smith   PetscBool         iascii,isdraw;
870971522cSBarry Smith   PetscInt          i,j;
885a9f2f41SSatish Balay   PC_FieldSplitLink ilink = jac->head;
890971522cSBarry Smith 
900971522cSBarry Smith   PetscFunctionBegin;
91251f4c67SDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&iascii);CHKERRQ(ierr);
92d9884438SBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERDRAW,&isdraw);CHKERRQ(ierr);
930971522cSBarry Smith   if (iascii) {
942c9966d7SBarry Smith     if (jac->bs > 0) {
9551f519a2SBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"  FieldSplit with %s composition: total splits = %D, blocksize = %D\n",PCCompositeTypes[jac->type],jac->nsplits,jac->bs);CHKERRQ(ierr);
962c9966d7SBarry Smith     } else {
972c9966d7SBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"  FieldSplit with %s composition: total splits = %D\n",PCCompositeTypes[jac->type],jac->nsplits);CHKERRQ(ierr);
982c9966d7SBarry Smith     }
99f5236f50SJed Brown     if (pc->useAmat) {
100f5236f50SJed Brown       ierr = PetscViewerASCIIPrintf(viewer,"  using Amat (not Pmat) as operator for blocks\n");CHKERRQ(ierr);
101a3df900dSMatthew G Knepley     }
102c84da90fSDmitry Karpeev     if (jac->diag_use_amat) {
103c84da90fSDmitry Karpeev       ierr = PetscViewerASCIIPrintf(viewer,"  using Amat (not Pmat) as operator for diagonal blocks\n");CHKERRQ(ierr);
104c84da90fSDmitry Karpeev     }
105c84da90fSDmitry Karpeev     if (jac->offdiag_use_amat) {
106c84da90fSDmitry Karpeev       ierr = PetscViewerASCIIPrintf(viewer,"  using Amat (not Pmat) as operator for off-diagonal blocks\n");CHKERRQ(ierr);
107c84da90fSDmitry Karpeev     }
10869a612a9SBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"  Solver info for each split is in the following KSP objects:\n");CHKERRQ(ierr);
1090971522cSBarry Smith     ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
1100971522cSBarry Smith     for (i=0; i<jac->nsplits; i++) {
1111ab39975SBarry Smith       if (ilink->fields) {
1120971522cSBarry Smith         ierr = PetscViewerASCIIPrintf(viewer,"Split number %D Fields ",i);CHKERRQ(ierr);
11379416396SBarry Smith         ierr = PetscViewerASCIIUseTabs(viewer,PETSC_FALSE);CHKERRQ(ierr);
1145a9f2f41SSatish Balay         for (j=0; j<ilink->nfields; j++) {
11579416396SBarry Smith           if (j > 0) {
11679416396SBarry Smith             ierr = PetscViewerASCIIPrintf(viewer,",");CHKERRQ(ierr);
11779416396SBarry Smith           }
1185a9f2f41SSatish Balay           ierr = PetscViewerASCIIPrintf(viewer," %D",ilink->fields[j]);CHKERRQ(ierr);
1190971522cSBarry Smith         }
1200971522cSBarry Smith         ierr = PetscViewerASCIIPrintf(viewer,"\n");CHKERRQ(ierr);
12179416396SBarry Smith         ierr = PetscViewerASCIIUseTabs(viewer,PETSC_TRUE);CHKERRQ(ierr);
1221ab39975SBarry Smith       } else {
1231ab39975SBarry Smith         ierr = PetscViewerASCIIPrintf(viewer,"Split number %D Defined by IS\n",i);CHKERRQ(ierr);
1241ab39975SBarry Smith       }
1255a9f2f41SSatish Balay       ierr  = KSPView(ilink->ksp,viewer);CHKERRQ(ierr);
1265a9f2f41SSatish Balay       ilink = ilink->next;
1270971522cSBarry Smith     }
1280971522cSBarry Smith     ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
1292fa5cd67SKarl Rupp   }
1302fa5cd67SKarl Rupp 
1312fa5cd67SKarl Rupp  if (isdraw) {
132d9884438SBarry Smith     PetscDraw draw;
133d9884438SBarry Smith     PetscReal x,y,w,wd;
134d9884438SBarry Smith 
135d9884438SBarry Smith     ierr = PetscViewerDrawGetDraw(viewer,0,&draw);CHKERRQ(ierr);
136d9884438SBarry Smith     ierr = PetscDrawGetCurrentPoint(draw,&x,&y);CHKERRQ(ierr);
137d9884438SBarry Smith     w    = 2*PetscMin(1.0 - x,x);
138d9884438SBarry Smith     wd   = w/(jac->nsplits + 1);
139d9884438SBarry Smith     x    = x - wd*(jac->nsplits-1)/2.0;
140d9884438SBarry Smith     for (i=0; i<jac->nsplits; i++) {
141d9884438SBarry Smith       ierr  = PetscDrawPushCurrentPoint(draw,x,y);CHKERRQ(ierr);
142d9884438SBarry Smith       ierr  = KSPView(ilink->ksp,viewer);CHKERRQ(ierr);
143d9884438SBarry Smith       ierr  = PetscDrawPopCurrentPoint(draw);CHKERRQ(ierr);
144d9884438SBarry Smith       x    += wd;
145d9884438SBarry Smith       ilink = ilink->next;
146d9884438SBarry Smith     }
1470971522cSBarry Smith   }
1480971522cSBarry Smith   PetscFunctionReturn(0);
1490971522cSBarry Smith }
1500971522cSBarry Smith 
1513b224e63SBarry Smith static PetscErrorCode PCView_FieldSplit_Schur(PC pc,PetscViewer viewer)
1523b224e63SBarry Smith {
1533b224e63SBarry Smith   PC_FieldSplit              *jac = (PC_FieldSplit*)pc->data;
1543b224e63SBarry Smith   PetscErrorCode             ierr;
1554996c5bdSBarry Smith   PetscBool                  iascii,isdraw;
1563b224e63SBarry Smith   PetscInt                   i,j;
1573b224e63SBarry Smith   PC_FieldSplitLink          ilink = jac->head;
158a9908d51SBarry Smith   MatSchurComplementAinvType atype;
1593b224e63SBarry Smith 
1603b224e63SBarry Smith   PetscFunctionBegin;
161251f4c67SDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&iascii);CHKERRQ(ierr);
1624996c5bdSBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERDRAW,&isdraw);CHKERRQ(ierr);
1633b224e63SBarry Smith   if (iascii) {
1642c9966d7SBarry Smith     if (jac->bs > 0) {
165c9c6ffaaSJed Brown       ierr = PetscViewerASCIIPrintf(viewer,"  FieldSplit with Schur preconditioner, blocksize = %D, factorization %s\n",jac->bs,PCFieldSplitSchurFactTypes[jac->schurfactorization]);CHKERRQ(ierr);
1662c9966d7SBarry Smith     } else {
1672c9966d7SBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"  FieldSplit with Schur preconditioner, factorization %s\n",PCFieldSplitSchurFactTypes[jac->schurfactorization]);CHKERRQ(ierr);
1682c9966d7SBarry Smith     }
169f5236f50SJed Brown     if (pc->useAmat) {
170f5236f50SJed Brown       ierr = PetscViewerASCIIPrintf(viewer,"  using Amat (not Pmat) as operator for blocks\n");CHKERRQ(ierr);
171a3df900dSMatthew G Knepley     }
1723e8b8b31SMatthew G Knepley     switch (jac->schurpre) {
1733e8b8b31SMatthew G Knepley     case PC_FIELDSPLIT_SCHUR_PRE_SELF:
174a9908d51SBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"  Preconditioner for the Schur complement formed from S itself\n");CHKERRQ(ierr);
175a9908d51SBarry Smith       break;
176a7476a74SDmitry Karpeev     case PC_FIELDSPLIT_SCHUR_PRE_SELFP:
177a9908d51SBarry Smith       ierr = MatSchurComplementGetAinvType(jac->schur,&atype);CHKERRQ(ierr);
178d0a9c1a2SBarry 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;
179e87fab1bSBarry Smith     case PC_FIELDSPLIT_SCHUR_PRE_A11:
180a9908d51SBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"  Preconditioner for the Schur complement formed from A11\n");CHKERRQ(ierr);
181a9908d51SBarry Smith       break;
182e74569cdSMatthew G. Knepley     case PC_FIELDSPLIT_SCHUR_PRE_FULL:
183a9908d51SBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"  Preconditioner for the Schur complement formed from the exact Schur complement\n");CHKERRQ(ierr);
184a9908d51SBarry Smith       break;
1853e8b8b31SMatthew G Knepley     case PC_FIELDSPLIT_SCHUR_PRE_USER:
1863e8b8b31SMatthew G Knepley       if (jac->schur_user) {
1873e8b8b31SMatthew G Knepley         ierr = PetscViewerASCIIPrintf(viewer,"  Preconditioner for the Schur complement formed from user provided matrix\n");CHKERRQ(ierr);
1883e8b8b31SMatthew G Knepley       } else {
189e87fab1bSBarry Smith         ierr = PetscViewerASCIIPrintf(viewer,"  Preconditioner for the Schur complement formed from A11\n");CHKERRQ(ierr);
1903e8b8b31SMatthew G Knepley       }
1913e8b8b31SMatthew G Knepley       break;
1923e8b8b31SMatthew G Knepley     default:
19382f516ccSBarry Smith       SETERRQ1(PetscObjectComm((PetscObject)pc), PETSC_ERR_ARG_OUTOFRANGE, "Invalid Schur preconditioning type: %d", jac->schurpre);
1943e8b8b31SMatthew G Knepley     }
1953b224e63SBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"  Split info:\n");CHKERRQ(ierr);
1963b224e63SBarry Smith     ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
1973b224e63SBarry Smith     for (i=0; i<jac->nsplits; i++) {
1983b224e63SBarry Smith       if (ilink->fields) {
1993b224e63SBarry Smith         ierr = PetscViewerASCIIPrintf(viewer,"Split number %D Fields ",i);CHKERRQ(ierr);
2003b224e63SBarry Smith         ierr = PetscViewerASCIIUseTabs(viewer,PETSC_FALSE);CHKERRQ(ierr);
2013b224e63SBarry Smith         for (j=0; j<ilink->nfields; j++) {
2023b224e63SBarry Smith           if (j > 0) {
2033b224e63SBarry Smith             ierr = PetscViewerASCIIPrintf(viewer,",");CHKERRQ(ierr);
2043b224e63SBarry Smith           }
2053b224e63SBarry Smith           ierr = PetscViewerASCIIPrintf(viewer," %D",ilink->fields[j]);CHKERRQ(ierr);
2063b224e63SBarry Smith         }
2073b224e63SBarry Smith         ierr = PetscViewerASCIIPrintf(viewer,"\n");CHKERRQ(ierr);
2083b224e63SBarry Smith         ierr = PetscViewerASCIIUseTabs(viewer,PETSC_TRUE);CHKERRQ(ierr);
2093b224e63SBarry Smith       } else {
2103b224e63SBarry Smith         ierr = PetscViewerASCIIPrintf(viewer,"Split number %D Defined by IS\n",i);CHKERRQ(ierr);
2113b224e63SBarry Smith       }
2123b224e63SBarry Smith       ilink = ilink->next;
2133b224e63SBarry Smith     }
214435f959eSBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"KSP solver for A00 block\n");CHKERRQ(ierr);
2153b224e63SBarry Smith     ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
21606de4afeSJed Brown     if (jac->head) {
217443836d0SMatthew G Knepley       ierr = KSPView(jac->head->ksp,viewer);CHKERRQ(ierr);
21806de4afeSJed Brown     } else  {ierr = PetscViewerASCIIPrintf(viewer,"  not yet available\n");CHKERRQ(ierr);}
2193b224e63SBarry Smith     ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
22006de4afeSJed Brown     if (jac->head && jac->kspupper != jac->head->ksp) {
221443836d0SMatthew G Knepley       ierr = PetscViewerASCIIPrintf(viewer,"KSP solver for upper A00 in upper triangular factor \n");CHKERRQ(ierr);
222443836d0SMatthew G Knepley       ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
223b2750c55SJed Brown       if (jac->kspupper) {ierr = KSPView(jac->kspupper,viewer);CHKERRQ(ierr);}
224b2750c55SJed Brown       else {ierr = PetscViewerASCIIPrintf(viewer,"  not yet available\n");CHKERRQ(ierr);}
225443836d0SMatthew G Knepley       ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
226443836d0SMatthew G Knepley     }
227435f959eSBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"KSP solver for S = A11 - A10 inv(A00) A01 \n");CHKERRQ(ierr);
2283b224e63SBarry Smith     ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
22912cae6f2SJed Brown     if (jac->kspschur) {
2303b224e63SBarry Smith       ierr = KSPView(jac->kspschur,viewer);CHKERRQ(ierr);
23112cae6f2SJed Brown     } else {
23212cae6f2SJed Brown       ierr = PetscViewerASCIIPrintf(viewer,"  not yet available\n");CHKERRQ(ierr);
23312cae6f2SJed Brown     }
2343b224e63SBarry Smith     ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
2353b224e63SBarry Smith     ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
23606de4afeSJed Brown   } else if (isdraw && jac->head) {
2374996c5bdSBarry Smith     PetscDraw draw;
2384996c5bdSBarry Smith     PetscReal x,y,w,wd,h;
2394996c5bdSBarry Smith     PetscInt  cnt = 2;
2404996c5bdSBarry Smith     char      str[32];
2414996c5bdSBarry Smith 
2424996c5bdSBarry Smith     ierr = PetscViewerDrawGetDraw(viewer,0,&draw);CHKERRQ(ierr);
2434996c5bdSBarry Smith     ierr = PetscDrawGetCurrentPoint(draw,&x,&y);CHKERRQ(ierr);
244c74581afSBarry Smith     if (jac->kspupper != jac->head->ksp) cnt++;
245c74581afSBarry Smith     w  = 2*PetscMin(1.0 - x,x);
246c74581afSBarry Smith     wd = w/(cnt + 1);
247c74581afSBarry Smith 
2484996c5bdSBarry Smith     ierr = PetscSNPrintf(str,32,"Schur fact. %s",PCFieldSplitSchurFactTypes[jac->schurfactorization]);CHKERRQ(ierr);
24951fa3d41SBarry Smith     ierr = PetscDrawStringBoxed(draw,x,y,PETSC_DRAW_RED,PETSC_DRAW_BLACK,str,NULL,&h);CHKERRQ(ierr);
2504996c5bdSBarry Smith     y   -= h;
2514996c5bdSBarry Smith     if (jac->schurpre == PC_FIELDSPLIT_SCHUR_PRE_USER &&  !jac->schur_user) {
252e87fab1bSBarry Smith       ierr = PetscSNPrintf(str,32,"Prec. for Schur from %s",PCFieldSplitSchurPreTypes[PC_FIELDSPLIT_SCHUR_PRE_A11]);CHKERRQ(ierr);
2533b224e63SBarry Smith     } else {
2544996c5bdSBarry Smith       ierr = PetscSNPrintf(str,32,"Prec. for Schur from %s",PCFieldSplitSchurPreTypes[jac->schurpre]);CHKERRQ(ierr);
2554996c5bdSBarry Smith     }
25651fa3d41SBarry Smith     ierr = PetscDrawStringBoxed(draw,x+wd*(cnt-1)/2.0,y,PETSC_DRAW_RED,PETSC_DRAW_BLACK,str,NULL,&h);CHKERRQ(ierr);
2574996c5bdSBarry Smith     y   -= h;
2584996c5bdSBarry Smith     x    = x - wd*(cnt-1)/2.0;
2594996c5bdSBarry Smith 
2604996c5bdSBarry Smith     ierr = PetscDrawPushCurrentPoint(draw,x,y);CHKERRQ(ierr);
2614996c5bdSBarry Smith     ierr = KSPView(jac->head->ksp,viewer);CHKERRQ(ierr);
2624996c5bdSBarry Smith     ierr = PetscDrawPopCurrentPoint(draw);CHKERRQ(ierr);
2634996c5bdSBarry Smith     if (jac->kspupper != jac->head->ksp) {
2644996c5bdSBarry Smith       x   += wd;
2654996c5bdSBarry Smith       ierr = PetscDrawPushCurrentPoint(draw,x,y);CHKERRQ(ierr);
2664996c5bdSBarry Smith       ierr = KSPView(jac->kspupper,viewer);CHKERRQ(ierr);
2674996c5bdSBarry Smith       ierr = PetscDrawPopCurrentPoint(draw);CHKERRQ(ierr);
2684996c5bdSBarry Smith     }
2694996c5bdSBarry Smith     x   += wd;
2704996c5bdSBarry Smith     ierr = PetscDrawPushCurrentPoint(draw,x,y);CHKERRQ(ierr);
2714996c5bdSBarry Smith     ierr = KSPView(jac->kspschur,viewer);CHKERRQ(ierr);
2724996c5bdSBarry Smith     ierr = PetscDrawPopCurrentPoint(draw);CHKERRQ(ierr);
2733b224e63SBarry Smith   }
2743b224e63SBarry Smith   PetscFunctionReturn(0);
2753b224e63SBarry Smith }
2763b224e63SBarry Smith 
2776c924f48SJed Brown /* Precondition: jac->bs is set to a meaningful value */
2786c924f48SJed Brown static PetscErrorCode PCFieldSplitSetRuntimeSplits_Private(PC pc)
2796c924f48SJed Brown {
2806c924f48SJed Brown   PetscErrorCode ierr;
2816c924f48SJed Brown   PC_FieldSplit  *jac = (PC_FieldSplit*)pc->data;
2825d4c12cdSJungho Lee   PetscInt       i,nfields,*ifields,nfields_col,*ifields_col;
2835d4c12cdSJungho Lee   PetscBool      flg,flg_col;
2845d4c12cdSJungho Lee   char           optionname[128],splitname[8],optionname_col[128];
2856c924f48SJed Brown 
2866c924f48SJed Brown   PetscFunctionBegin;
287785e854fSJed Brown   ierr = PetscMalloc1(jac->bs,&ifields);CHKERRQ(ierr);
288785e854fSJed Brown   ierr = PetscMalloc1(jac->bs,&ifields_col);CHKERRQ(ierr);
2896c924f48SJed Brown   for (i=0,flg=PETSC_TRUE;; i++) {
2908caf3d72SBarry Smith     ierr        = PetscSNPrintf(splitname,sizeof(splitname),"%D",i);CHKERRQ(ierr);
2918caf3d72SBarry Smith     ierr        = PetscSNPrintf(optionname,sizeof(optionname),"-pc_fieldsplit_%D_fields",i);CHKERRQ(ierr);
2928caf3d72SBarry Smith     ierr        = PetscSNPrintf(optionname_col,sizeof(optionname_col),"-pc_fieldsplit_%D_fields_col",i);CHKERRQ(ierr);
2936c924f48SJed Brown     nfields     = jac->bs;
29429499fbbSJungho Lee     nfields_col = jac->bs;
295c5929fdfSBarry Smith     ierr        = PetscOptionsGetIntArray(((PetscObject)pc)->options,((PetscObject)pc)->prefix,optionname,ifields,&nfields,&flg);CHKERRQ(ierr);
296c5929fdfSBarry Smith     ierr        = PetscOptionsGetIntArray(((PetscObject)pc)->options,((PetscObject)pc)->prefix,optionname_col,ifields_col,&nfields_col,&flg_col);CHKERRQ(ierr);
2976c924f48SJed Brown     if (!flg) break;
2985d4c12cdSJungho Lee     else if (flg && !flg_col) {
2995d4c12cdSJungho Lee       if (!nfields) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_USER,"Cannot list zero fields");
3005d4c12cdSJungho Lee       ierr = PCFieldSplitSetFields(pc,splitname,nfields,ifields,ifields);CHKERRQ(ierr);
3012fa5cd67SKarl Rupp     } else {
3025d4c12cdSJungho Lee       if (!nfields || !nfields_col) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_USER,"Cannot list zero fields");
3035d4c12cdSJungho Lee       if (nfields != nfields_col) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_USER,"Number of row and column fields must match");
3045d4c12cdSJungho Lee       ierr = PCFieldSplitSetFields(pc,splitname,nfields,ifields,ifields_col);CHKERRQ(ierr);
3055d4c12cdSJungho Lee     }
3066c924f48SJed Brown   }
3076c924f48SJed Brown   if (i > 0) {
3086c924f48SJed Brown     /* Makes command-line setting of splits take precedence over setting them in code.
3096c924f48SJed Brown        Otherwise subsequent calls to PCFieldSplitSetIS() or PCFieldSplitSetFields() would
3106c924f48SJed Brown        create new splits, which would probably not be what the user wanted. */
3116c924f48SJed Brown     jac->splitdefined = PETSC_TRUE;
3126c924f48SJed Brown   }
3136c924f48SJed Brown   ierr = PetscFree(ifields);CHKERRQ(ierr);
3145d4c12cdSJungho Lee   ierr = PetscFree(ifields_col);CHKERRQ(ierr);
3156c924f48SJed Brown   PetscFunctionReturn(0);
3166c924f48SJed Brown }
3176c924f48SJed Brown 
31869a612a9SBarry Smith static PetscErrorCode PCFieldSplitSetDefaults(PC pc)
3190971522cSBarry Smith {
3200971522cSBarry Smith   PC_FieldSplit     *jac = (PC_FieldSplit*)pc->data;
3210971522cSBarry Smith   PetscErrorCode    ierr;
3225a9f2f41SSatish Balay   PC_FieldSplitLink ilink = jac->head;
3237b752e3dSPatrick Sanan   PetscBool         fieldsplit_default = PETSC_FALSE,coupling = PETSC_FALSE;
3246c924f48SJed Brown   PetscInt          i;
3250971522cSBarry Smith 
3260971522cSBarry Smith   PetscFunctionBegin;
3277287d2a3SDmitry Karpeev   /*
328f5f0d762SBarry Smith    Kinda messy, but at least this now uses DMCreateFieldDecomposition().
3297287d2a3SDmitry Karpeev    Should probably be rewritten.
3307287d2a3SDmitry Karpeev    */
331f5f0d762SBarry Smith   if (!ilink) {
332c5929fdfSBarry Smith     ierr = PetscOptionsGetBool(((PetscObject)pc)->options,((PetscObject)pc)->prefix,"-pc_fieldsplit_detect_coupling",&coupling,NULL);CHKERRQ(ierr);
3337b752e3dSPatrick Sanan     if (pc->dm && jac->dm_splits && !jac->detect && !coupling) {
334bafc1b83SMatthew G Knepley       PetscInt  numFields, f, i, j;
3350784a22cSJed Brown       char      **fieldNames;
3367b62db95SJungho Lee       IS        *fields;
337e7c4fc90SDmitry Karpeev       DM        *dms;
338bafc1b83SMatthew G Knepley       DM        subdm[128];
339bafc1b83SMatthew G Knepley       PetscBool flg;
340bafc1b83SMatthew G Knepley 
34116621825SDmitry Karpeev       ierr = DMCreateFieldDecomposition(pc->dm, &numFields, &fieldNames, &fields, &dms);CHKERRQ(ierr);
342bafc1b83SMatthew G Knepley       /* Allow the user to prescribe the splits */
343bafc1b83SMatthew G Knepley       for (i = 0, flg = PETSC_TRUE;; i++) {
344bafc1b83SMatthew G Knepley         PetscInt ifields[128];
345bafc1b83SMatthew G Knepley         IS       compField;
346bafc1b83SMatthew G Knepley         char     optionname[128], splitname[8];
347bafc1b83SMatthew G Knepley         PetscInt nfields = numFields;
348bafc1b83SMatthew G Knepley 
3498caf3d72SBarry Smith         ierr = PetscSNPrintf(optionname, sizeof(optionname), "-pc_fieldsplit_%D_fields", i);CHKERRQ(ierr);
350c5929fdfSBarry Smith         ierr = PetscOptionsGetIntArray(((PetscObject)pc)->options,((PetscObject)pc)->prefix, optionname, ifields, &nfields, &flg);CHKERRQ(ierr);
351bafc1b83SMatthew G Knepley         if (!flg) break;
35282f516ccSBarry Smith         if (numFields > 128) SETERRQ1(PetscObjectComm((PetscObject)pc),PETSC_ERR_SUP,"Cannot currently support %d > 128 fields", numFields);
353bafc1b83SMatthew G Knepley         ierr = DMCreateSubDM(pc->dm, nfields, ifields, &compField, &subdm[i]);CHKERRQ(ierr);
354bafc1b83SMatthew G Knepley         if (nfields == 1) {
355bafc1b83SMatthew G Knepley           ierr = PCFieldSplitSetIS(pc, fieldNames[ifields[0]], compField);CHKERRQ(ierr);
356bafc1b83SMatthew G Knepley         } else {
3578caf3d72SBarry Smith           ierr = PetscSNPrintf(splitname, sizeof(splitname), "%D", i);CHKERRQ(ierr);
358bafc1b83SMatthew G Knepley           ierr = PCFieldSplitSetIS(pc, splitname, compField);CHKERRQ(ierr);
3597287d2a3SDmitry Karpeev         }
360bafc1b83SMatthew G Knepley         ierr = ISDestroy(&compField);CHKERRQ(ierr);
361bafc1b83SMatthew G Knepley         for (j = 0; j < nfields; ++j) {
362bafc1b83SMatthew G Knepley           f    = ifields[j];
3637b62db95SJungho Lee           ierr = PetscFree(fieldNames[f]);CHKERRQ(ierr);
3647b62db95SJungho Lee           ierr = ISDestroy(&fields[f]);CHKERRQ(ierr);
3657b62db95SJungho Lee         }
366bafc1b83SMatthew G Knepley       }
367bafc1b83SMatthew G Knepley       if (i == 0) {
368bafc1b83SMatthew G Knepley         for (f = 0; f < numFields; ++f) {
369bafc1b83SMatthew G Knepley           ierr = PCFieldSplitSetIS(pc, fieldNames[f], fields[f]);CHKERRQ(ierr);
370bafc1b83SMatthew G Knepley           ierr = PetscFree(fieldNames[f]);CHKERRQ(ierr);
371bafc1b83SMatthew G Knepley           ierr = ISDestroy(&fields[f]);CHKERRQ(ierr);
372bafc1b83SMatthew G Knepley         }
373bafc1b83SMatthew G Knepley       } else {
374d724dfffSBarry Smith         for (j=0; j<numFields; j++) {
375d724dfffSBarry Smith           ierr = DMDestroy(dms+j);CHKERRQ(ierr);
376d724dfffSBarry Smith         }
377d724dfffSBarry Smith         ierr = PetscFree(dms);CHKERRQ(ierr);
378785e854fSJed Brown         ierr = PetscMalloc1(i, &dms);CHKERRQ(ierr);
3792fa5cd67SKarl Rupp         for (j = 0; j < i; ++j) dms[j] = subdm[j];
380bafc1b83SMatthew G Knepley       }
3817b62db95SJungho Lee       ierr = PetscFree(fieldNames);CHKERRQ(ierr);
3827b62db95SJungho Lee       ierr = PetscFree(fields);CHKERRQ(ierr);
383e7c4fc90SDmitry Karpeev       if (dms) {
3848b8307b2SJed Brown         ierr = PetscInfo(pc, "Setting up physics based fieldsplit preconditioner using the embedded DM\n");CHKERRQ(ierr);
385bafc1b83SMatthew G Knepley         for (ilink = jac->head, i = 0; ilink; ilink = ilink->next, ++i) {
3867287d2a3SDmitry Karpeev           const char *prefix;
3877287d2a3SDmitry Karpeev           ierr = PetscObjectGetOptionsPrefix((PetscObject)(ilink->ksp),&prefix);CHKERRQ(ierr);
3887287d2a3SDmitry Karpeev           ierr = PetscObjectSetOptionsPrefix((PetscObject)(dms[i]), prefix);CHKERRQ(ierr);
3897b62db95SJungho Lee           ierr = KSPSetDM(ilink->ksp, dms[i]);CHKERRQ(ierr);
3907b62db95SJungho Lee           ierr = KSPSetDMActive(ilink->ksp, PETSC_FALSE);CHKERRQ(ierr);
3917287d2a3SDmitry Karpeev           ierr = PetscObjectIncrementTabLevel((PetscObject)dms[i],(PetscObject)ilink->ksp,0);CHKERRQ(ierr);
392e7c4fc90SDmitry Karpeev           ierr = DMDestroy(&dms[i]);CHKERRQ(ierr);
3932fa5ba8aSJed Brown         }
3947b62db95SJungho Lee         ierr = PetscFree(dms);CHKERRQ(ierr);
3958b8307b2SJed Brown       }
39666ffff09SJed Brown     } else {
397521d7252SBarry Smith       if (jac->bs <= 0) {
398704ba839SBarry Smith         if (pc->pmat) {
399521d7252SBarry Smith           ierr = MatGetBlockSize(pc->pmat,&jac->bs);CHKERRQ(ierr);
4002fa5cd67SKarl Rupp         } else jac->bs = 1;
401521d7252SBarry Smith       }
402d32f9abdSBarry Smith 
4037b752e3dSPatrick Sanan       if (jac->detect) {
4046ce1633cSBarry Smith         IS       zerodiags,rest;
4056ce1633cSBarry Smith         PetscInt nmin,nmax;
4066ce1633cSBarry Smith 
4076ce1633cSBarry Smith         ierr = MatGetOwnershipRange(pc->mat,&nmin,&nmax);CHKERRQ(ierr);
4086ce1633cSBarry Smith         ierr = MatFindZeroDiagonals(pc->mat,&zerodiags);CHKERRQ(ierr);
4096ce1633cSBarry Smith         ierr = ISComplement(zerodiags,nmin,nmax,&rest);CHKERRQ(ierr);
4106ce1633cSBarry Smith         ierr = PCFieldSplitSetIS(pc,"0",rest);CHKERRQ(ierr);
4116ce1633cSBarry Smith         ierr = PCFieldSplitSetIS(pc,"1",zerodiags);CHKERRQ(ierr);
412fcfd50ebSBarry Smith         ierr = ISDestroy(&zerodiags);CHKERRQ(ierr);
413fcfd50ebSBarry Smith         ierr = ISDestroy(&rest);CHKERRQ(ierr);
4143a062f41SBarry Smith       } else if (coupling) {
4153a062f41SBarry Smith         IS       coupling,rest;
4163a062f41SBarry Smith         PetscInt nmin,nmax;
4173a062f41SBarry Smith 
4183a062f41SBarry Smith         ierr = MatGetOwnershipRange(pc->mat,&nmin,&nmax);CHKERRQ(ierr);
4193a062f41SBarry Smith         ierr = MatFindOffBlockDiagonalEntries(pc->mat,&coupling);CHKERRQ(ierr);
4206bea0878SBarry Smith         ierr = ISCreateStride(PetscObjectComm((PetscObject)pc->mat),nmax-nmin,nmin,1,&rest);CHKERRQ(ierr);
421e52d2c62SBarry Smith         ierr = ISSetIdentity(rest);CHKERRQ(ierr);
422d020c841SBarry Smith         ierr = PCFieldSplitSetIS(pc,"0",rest);CHKERRQ(ierr);
423d020c841SBarry Smith         ierr = PCFieldSplitSetIS(pc,"1",coupling);CHKERRQ(ierr);
4243a062f41SBarry Smith         ierr = ISDestroy(&coupling);CHKERRQ(ierr);
4253a062f41SBarry Smith         ierr = ISDestroy(&rest);CHKERRQ(ierr);
4266ce1633cSBarry Smith       } else {
427c5929fdfSBarry Smith         ierr = PetscOptionsGetBool(((PetscObject)pc)->options,((PetscObject)pc)->prefix,"-pc_fieldsplit_default",&fieldsplit_default,NULL);CHKERRQ(ierr);
4287287d2a3SDmitry Karpeev         if (!fieldsplit_default) {
429d32f9abdSBarry Smith           /* Allow user to set fields from command line,  if bs was known at the time of PCSetFromOptions_FieldSplit()
430d32f9abdSBarry Smith            then it is set there. This is not ideal because we should only have options set in XXSetFromOptions(). */
4316c924f48SJed Brown           ierr = PCFieldSplitSetRuntimeSplits_Private(pc);CHKERRQ(ierr);
4326c924f48SJed Brown           if (jac->splitdefined) {ierr = PetscInfo(pc,"Splits defined using the options database\n");CHKERRQ(ierr);}
433d32f9abdSBarry Smith         }
4346dbb499eSCian Wilson         if ((fieldsplit_default || !jac->splitdefined) && !jac->isrestrict) {
435d32f9abdSBarry Smith           ierr = PetscInfo(pc,"Using default splitting of fields\n");CHKERRQ(ierr);
436db4c96c1SJed Brown           for (i=0; i<jac->bs; i++) {
4376c924f48SJed Brown             char splitname[8];
4388caf3d72SBarry Smith             ierr = PetscSNPrintf(splitname,sizeof(splitname),"%D",i);CHKERRQ(ierr);
4395d4c12cdSJungho Lee             ierr = PCFieldSplitSetFields(pc,splitname,1,&i,&i);CHKERRQ(ierr);
44079416396SBarry Smith           }
4415d4c12cdSJungho Lee           jac->defaultsplit = PETSC_TRUE;
442521d7252SBarry Smith         }
44366ffff09SJed Brown       }
4446ce1633cSBarry Smith     }
445edf189efSBarry Smith   } else if (jac->nsplits == 1) {
446edf189efSBarry Smith     if (ilink->is) {
447edf189efSBarry Smith       IS       is2;
448edf189efSBarry Smith       PetscInt nmin,nmax;
449edf189efSBarry Smith 
450edf189efSBarry Smith       ierr = MatGetOwnershipRange(pc->mat,&nmin,&nmax);CHKERRQ(ierr);
451edf189efSBarry Smith       ierr = ISComplement(ilink->is,nmin,nmax,&is2);CHKERRQ(ierr);
452db4c96c1SJed Brown       ierr = PCFieldSplitSetIS(pc,"1",is2);CHKERRQ(ierr);
453fcfd50ebSBarry Smith       ierr = ISDestroy(&is2);CHKERRQ(ierr);
45482f516ccSBarry Smith     } else SETERRQ(PetscObjectComm((PetscObject)pc),PETSC_ERR_SUP,"Must provide at least two sets of fields to PCFieldSplit()");
455edf189efSBarry Smith   }
456d0af7cd3SBarry Smith 
45782f516ccSBarry Smith   if (jac->nsplits < 2) SETERRQ1(PetscObjectComm((PetscObject)pc),PETSC_ERR_PLIB,"Unhandled case, must have at least two fields, not %d", jac->nsplits);
45869a612a9SBarry Smith   PetscFunctionReturn(0);
45969a612a9SBarry Smith }
46069a612a9SBarry Smith 
461c5929fdfSBarry Smith PETSC_EXTERN PetscErrorCode PetscOptionsFindPairPrefix_Private(PetscOptions,const char pre[], const char name[], char *value[], PetscBool *flg);
462514bf10dSMatthew G Knepley 
46369a612a9SBarry Smith static PetscErrorCode PCSetUp_FieldSplit(PC pc)
46469a612a9SBarry Smith {
46569a612a9SBarry Smith   PC_FieldSplit     *jac = (PC_FieldSplit*)pc->data;
46669a612a9SBarry Smith   PetscErrorCode    ierr;
4675a9f2f41SSatish Balay   PC_FieldSplitLink ilink;
4682c9966d7SBarry Smith   PetscInt          i,nsplit;
4695f4ab4e1SJungho Lee   PetscBool         sorted, sorted_col;
47069a612a9SBarry Smith 
47169a612a9SBarry Smith   PetscFunctionBegin;
47269a612a9SBarry Smith   ierr   = PCFieldSplitSetDefaults(pc);CHKERRQ(ierr);
47397bbdb24SBarry Smith   nsplit = jac->nsplits;
4745a9f2f41SSatish Balay   ilink  = jac->head;
47597bbdb24SBarry Smith 
47697bbdb24SBarry Smith   /* get the matrices for each split */
477704ba839SBarry Smith   if (!jac->issetup) {
4781b9fc7fcSBarry Smith     PetscInt rstart,rend,nslots,bs;
47997bbdb24SBarry Smith 
480704ba839SBarry Smith     jac->issetup = PETSC_TRUE;
481704ba839SBarry Smith 
4825d4c12cdSJungho Lee     /* This is done here instead of in PCFieldSplitSetFields() because may not have matrix at that point */
4832c9966d7SBarry Smith     if (jac->defaultsplit || !ilink->is) {
4842c9966d7SBarry Smith       if (jac->bs <= 0) jac->bs = nsplit;
4852c9966d7SBarry Smith     }
48651f519a2SBarry Smith     bs     = jac->bs;
48797bbdb24SBarry Smith     ierr   = MatGetOwnershipRange(pc->pmat,&rstart,&rend);CHKERRQ(ierr);
4881b9fc7fcSBarry Smith     nslots = (rend - rstart)/bs;
4891b9fc7fcSBarry Smith     for (i=0; i<nsplit; i++) {
4901b9fc7fcSBarry Smith       if (jac->defaultsplit) {
491ce94432eSBarry Smith         ierr = ISCreateStride(PetscObjectComm((PetscObject)pc),nslots,rstart+i,nsplit,&ilink->is);CHKERRQ(ierr);
4925f4ab4e1SJungho Lee         ierr = ISDuplicate(ilink->is,&ilink->is_col);CHKERRQ(ierr);
493704ba839SBarry Smith       } else if (!ilink->is) {
494ccb205f8SBarry Smith         if (ilink->nfields > 1) {
4955f4ab4e1SJungho Lee           PetscInt *ii,*jj,j,k,nfields = ilink->nfields,*fields = ilink->fields,*fields_col = ilink->fields_col;
496785e854fSJed Brown           ierr = PetscMalloc1(ilink->nfields*nslots,&ii);CHKERRQ(ierr);
497785e854fSJed Brown           ierr = PetscMalloc1(ilink->nfields*nslots,&jj);CHKERRQ(ierr);
4981b9fc7fcSBarry Smith           for (j=0; j<nslots; j++) {
4991b9fc7fcSBarry Smith             for (k=0; k<nfields; k++) {
5001b9fc7fcSBarry Smith               ii[nfields*j + k] = rstart + bs*j + fields[k];
5015f4ab4e1SJungho Lee               jj[nfields*j + k] = rstart + bs*j + fields_col[k];
50297bbdb24SBarry Smith             }
50397bbdb24SBarry Smith           }
504ce94432eSBarry Smith           ierr = ISCreateGeneral(PetscObjectComm((PetscObject)pc),nslots*nfields,ii,PETSC_OWN_POINTER,&ilink->is);CHKERRQ(ierr);
505ce94432eSBarry Smith           ierr = ISCreateGeneral(PetscObjectComm((PetscObject)pc),nslots*nfields,jj,PETSC_OWN_POINTER,&ilink->is_col);CHKERRQ(ierr);
50690e68f20SPatrick Farrell           ierr = ISSetBlockSize(ilink->is, nfields);CHKERRQ(ierr);
50790e68f20SPatrick Farrell           ierr = ISSetBlockSize(ilink->is_col, nfields);CHKERRQ(ierr);
508ccb205f8SBarry Smith         } else {
509ce94432eSBarry Smith           ierr = ISCreateStride(PetscObjectComm((PetscObject)pc),nslots,rstart+ilink->fields[0],bs,&ilink->is);CHKERRQ(ierr);
510ce94432eSBarry Smith           ierr = ISCreateStride(PetscObjectComm((PetscObject)pc),nslots,rstart+ilink->fields_col[0],bs,&ilink->is_col);CHKERRQ(ierr);
511ccb205f8SBarry Smith        }
5123e197d65SBarry Smith       }
513704ba839SBarry Smith       ierr = ISSorted(ilink->is,&sorted);CHKERRQ(ierr);
5145f4ab4e1SJungho Lee       if (ilink->is_col) { ierr = ISSorted(ilink->is_col,&sorted_col);CHKERRQ(ierr); }
5155f4ab4e1SJungho Lee       if (!sorted || !sorted_col) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_USER,"Fields must be sorted when creating split");
516704ba839SBarry Smith       ilink = ilink->next;
5171b9fc7fcSBarry Smith     }
5181b9fc7fcSBarry Smith   }
5191b9fc7fcSBarry Smith 
520704ba839SBarry Smith   ilink = jac->head;
52197bbdb24SBarry Smith   if (!jac->pmat) {
522bdddcaaaSMatthew G Knepley     Vec xtmp;
523bdddcaaaSMatthew G Knepley 
5242a7a6963SBarry Smith     ierr = MatCreateVecs(pc->pmat,&xtmp,NULL);CHKERRQ(ierr);
525785e854fSJed Brown     ierr = PetscMalloc1(nsplit,&jac->pmat);CHKERRQ(ierr);
526dcca6d9dSJed Brown     ierr = PetscMalloc2(nsplit,&jac->x,nsplit,&jac->y);CHKERRQ(ierr);
527cf502942SBarry Smith     for (i=0; i<nsplit; i++) {
528bdddcaaaSMatthew G Knepley       MatNullSpace sp;
529bdddcaaaSMatthew G Knepley 
530a3df900dSMatthew G Knepley       /* Check for preconditioning matrix attached to IS */
531a3df900dSMatthew G Knepley       ierr = PetscObjectQuery((PetscObject) ilink->is, "pmat", (PetscObject*) &jac->pmat[i]);CHKERRQ(ierr);
532a3df900dSMatthew G Knepley       if (jac->pmat[i]) {
533a3df900dSMatthew G Knepley         ierr = PetscObjectReference((PetscObject) jac->pmat[i]);CHKERRQ(ierr);
534a3df900dSMatthew G Knepley         if (jac->type == PC_COMPOSITE_SCHUR) {
535a3df900dSMatthew G Knepley           jac->schur_user = jac->pmat[i];
5362fa5cd67SKarl Rupp 
537a3df900dSMatthew G Knepley           ierr = PetscObjectReference((PetscObject) jac->schur_user);CHKERRQ(ierr);
538a3df900dSMatthew G Knepley         }
539a3df900dSMatthew G Knepley       } else {
5403a062f41SBarry Smith         const char *prefix;
5417dae84e0SHong Zhang         ierr = MatCreateSubMatrix(pc->pmat,ilink->is,ilink->is_col,MAT_INITIAL_MATRIX,&jac->pmat[i]);CHKERRQ(ierr);
5423a062f41SBarry Smith         ierr = KSPGetOptionsPrefix(ilink->ksp,&prefix);CHKERRQ(ierr);
5433a062f41SBarry Smith         ierr = MatSetOptionsPrefix(jac->pmat[i],prefix);CHKERRQ(ierr);
5443a062f41SBarry Smith         ierr = MatViewFromOptions(jac->pmat[i],NULL,"-mat_view");CHKERRQ(ierr);
545a3df900dSMatthew G Knepley       }
546bdddcaaaSMatthew G Knepley       /* create work vectors for each split */
5472a7a6963SBarry Smith       ierr     = MatCreateVecs(jac->pmat[i],&jac->x[i],&jac->y[i]);CHKERRQ(ierr);
5480298fd71SBarry Smith       ilink->x = jac->x[i]; ilink->y = jac->y[i]; ilink->z = NULL;
549bdddcaaaSMatthew G Knepley       /* compute scatter contexts needed by multiplicative versions and non-default splits */
5500298fd71SBarry Smith       ierr = VecScatterCreate(xtmp,ilink->is,jac->x[i],NULL,&ilink->sctx);CHKERRQ(ierr);
551ed1f0337SMatthew G Knepley       ierr = PetscObjectQuery((PetscObject) ilink->is, "nearnullspace", (PetscObject*) &sp);CHKERRQ(ierr);
552ed1f0337SMatthew G Knepley       if (sp) {
553ed1f0337SMatthew G Knepley         ierr = MatSetNearNullSpace(jac->pmat[i], sp);CHKERRQ(ierr);
554ed1f0337SMatthew G Knepley       }
555704ba839SBarry Smith       ilink = ilink->next;
556cf502942SBarry Smith     }
557bdddcaaaSMatthew G Knepley     ierr = VecDestroy(&xtmp);CHKERRQ(ierr);
55897bbdb24SBarry Smith   } else {
559*ef7efd37SHong Zhang     MatReuse scall;
560*ef7efd37SHong Zhang     if (pc->flag == DIFFERENT_NONZERO_PATTERN) {
561*ef7efd37SHong Zhang       for (i=0; i<nsplit; i++) {
562*ef7efd37SHong Zhang         ierr = MatDestroy(&jac->pmat[i]);CHKERRQ(ierr);
563*ef7efd37SHong Zhang       }
564*ef7efd37SHong Zhang       scall = MAT_INITIAL_MATRIX;
565*ef7efd37SHong Zhang     } else scall = MAT_REUSE_MATRIX;
566*ef7efd37SHong Zhang 
567cf502942SBarry Smith     for (i=0; i<nsplit; i++) {
568a3df900dSMatthew G Knepley       Mat pmat;
569a3df900dSMatthew G Knepley 
570a3df900dSMatthew G Knepley       /* Check for preconditioning matrix attached to IS */
571a3df900dSMatthew G Knepley       ierr = PetscObjectQuery((PetscObject) ilink->is, "pmat", (PetscObject*) &pmat);CHKERRQ(ierr);
572a3df900dSMatthew G Knepley       if (!pmat) {
573*ef7efd37SHong Zhang         ierr = MatCreateSubMatrix(pc->pmat,ilink->is,ilink->is_col,scall,&jac->pmat[i]);CHKERRQ(ierr);
574a3df900dSMatthew G Knepley       }
575704ba839SBarry Smith       ilink = ilink->next;
576cf502942SBarry Smith     }
57797bbdb24SBarry Smith   }
5784e39094bSDmitry Karpeev   if (jac->diag_use_amat) {
579519d70e2SJed Brown     ilink = jac->head;
580519d70e2SJed Brown     if (!jac->mat) {
581785e854fSJed Brown       ierr = PetscMalloc1(nsplit,&jac->mat);CHKERRQ(ierr);
582519d70e2SJed Brown       for (i=0; i<nsplit; i++) {
5837dae84e0SHong Zhang         ierr  = MatCreateSubMatrix(pc->mat,ilink->is,ilink->is_col,MAT_INITIAL_MATRIX,&jac->mat[i]);CHKERRQ(ierr);
584519d70e2SJed Brown         ilink = ilink->next;
585519d70e2SJed Brown       }
586519d70e2SJed Brown     } else {
587*ef7efd37SHong Zhang       MatReuse scall;
588*ef7efd37SHong Zhang       if (pc->flag == DIFFERENT_NONZERO_PATTERN) {
589519d70e2SJed Brown         for (i=0; i<nsplit; i++) {
590*ef7efd37SHong Zhang           ierr = MatDestroy(&jac->mat[i]);CHKERRQ(ierr);
591*ef7efd37SHong Zhang         }
592*ef7efd37SHong Zhang         scall = MAT_INITIAL_MATRIX;
593*ef7efd37SHong Zhang       } else scall = MAT_REUSE_MATRIX;
594*ef7efd37SHong Zhang 
595*ef7efd37SHong Zhang       for (i=0; i<nsplit; i++) {
596*ef7efd37SHong Zhang         if (jac->mat[i]) {ierr = MatCreateSubMatrix(pc->mat,ilink->is,ilink->is_col,scall,&jac->mat[i]);CHKERRQ(ierr);}
597519d70e2SJed Brown         ilink = ilink->next;
598519d70e2SJed Brown       }
599519d70e2SJed Brown     }
600519d70e2SJed Brown   } else {
601519d70e2SJed Brown     jac->mat = jac->pmat;
602519d70e2SJed Brown   }
60397bbdb24SBarry Smith 
60453935eafSBarry Smith   /* Check for null space attached to IS */
60553935eafSBarry Smith   ilink = jac->head;
60653935eafSBarry Smith   for (i=0; i<nsplit; i++) {
60753935eafSBarry Smith     MatNullSpace sp;
60853935eafSBarry Smith 
60953935eafSBarry Smith     ierr = PetscObjectQuery((PetscObject) ilink->is, "nullspace", (PetscObject*) &sp);CHKERRQ(ierr);
61053935eafSBarry Smith     if (sp) {
61153935eafSBarry Smith       ierr = MatSetNullSpace(jac->mat[i], sp);CHKERRQ(ierr);
61253935eafSBarry Smith     }
61353935eafSBarry Smith     ilink = ilink->next;
61453935eafSBarry Smith   }
61553935eafSBarry Smith 
6166c8605c2SJed Brown   if (jac->type != PC_COMPOSITE_ADDITIVE  && jac->type != PC_COMPOSITE_SCHUR) {
61768dd23aaSBarry Smith     /* extract the rows of the matrix associated with each field: used for efficient computation of residual inside algorithm */
6184e39094bSDmitry Karpeev     /* FIXME: Can/should we reuse jac->mat whenever (jac->diag_use_amat) is true? */
61968dd23aaSBarry Smith     ilink = jac->head;
620e52d2c62SBarry Smith     if (nsplit == 2 && jac->type == PC_COMPOSITE_MULTIPLICATIVE) {
621e52d2c62SBarry 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 */
622e52d2c62SBarry Smith       if (!jac->Afield) {
623e52d2c62SBarry Smith         ierr = PetscCalloc1(nsplit,&jac->Afield);CHKERRQ(ierr);
62480c96bb1SFande Kong         if (jac->offdiag_use_amat) {
6257dae84e0SHong Zhang           ierr  = MatCreateSubMatrix(pc->mat,ilink->next->is,ilink->is,MAT_INITIAL_MATRIX,&jac->Afield[1]);CHKERRQ(ierr);
626e52d2c62SBarry Smith         } else {
6277dae84e0SHong Zhang           ierr  = MatCreateSubMatrix(pc->pmat,ilink->next->is,ilink->is,MAT_INITIAL_MATRIX,&jac->Afield[1]);CHKERRQ(ierr);
62880c96bb1SFande Kong         }
62980c96bb1SFande Kong       } else {
630*ef7efd37SHong Zhang         MatReuse scall;
631*ef7efd37SHong Zhang         if (pc->flag == DIFFERENT_NONZERO_PATTERN) {
632*ef7efd37SHong Zhang           for (i=0; i<nsplit; i++) {
633*ef7efd37SHong Zhang             ierr = MatDestroy(&jac->Afield[1]);CHKERRQ(ierr);
634*ef7efd37SHong Zhang           }
635*ef7efd37SHong Zhang           scall = MAT_INITIAL_MATRIX;
636*ef7efd37SHong Zhang         } else scall = MAT_REUSE_MATRIX;
637*ef7efd37SHong Zhang 
63880c96bb1SFande Kong         if (jac->offdiag_use_amat) {
639*ef7efd37SHong Zhang           ierr  = MatCreateSubMatrix(pc->mat,ilink->next->is,ilink->is,scall,&jac->Afield[1]);CHKERRQ(ierr);
64080c96bb1SFande Kong         } else {
641*ef7efd37SHong Zhang           ierr  = MatCreateSubMatrix(pc->pmat,ilink->next->is,ilink->is,scall,&jac->Afield[1]);CHKERRQ(ierr);
64280c96bb1SFande Kong         }
643e52d2c62SBarry Smith       }
644e52d2c62SBarry Smith     } else {
64568dd23aaSBarry Smith       if (!jac->Afield) {
646785e854fSJed Brown         ierr = PetscMalloc1(nsplit,&jac->Afield);CHKERRQ(ierr);
64768dd23aaSBarry Smith         for (i=0; i<nsplit; i++) {
64880c96bb1SFande Kong           if (jac->offdiag_use_amat) {
6497dae84e0SHong Zhang             ierr  = MatCreateSubMatrix(pc->mat,ilink->is,NULL,MAT_INITIAL_MATRIX,&jac->Afield[i]);CHKERRQ(ierr);
65080c96bb1SFande Kong           } else {
6517dae84e0SHong Zhang             ierr  = MatCreateSubMatrix(pc->pmat,ilink->is,NULL,MAT_INITIAL_MATRIX,&jac->Afield[i]);CHKERRQ(ierr);
65280c96bb1SFande Kong           }
65368dd23aaSBarry Smith           ilink = ilink->next;
65468dd23aaSBarry Smith         }
65568dd23aaSBarry Smith       } else {
656*ef7efd37SHong Zhang         MatReuse scall;
657*ef7efd37SHong Zhang         if (pc->flag == DIFFERENT_NONZERO_PATTERN) {
658*ef7efd37SHong Zhang           for (i=0; i<nsplit; i++) {
659*ef7efd37SHong Zhang             ierr = MatDestroy(&jac->Afield[i]);CHKERRQ(ierr);
660*ef7efd37SHong Zhang           }
661*ef7efd37SHong Zhang           scall = MAT_INITIAL_MATRIX;
662*ef7efd37SHong Zhang         } else scall = MAT_REUSE_MATRIX;
663*ef7efd37SHong Zhang 
66468dd23aaSBarry Smith         for (i=0; i<nsplit; i++) {
66580c96bb1SFande Kong           if (jac->offdiag_use_amat) {
666*ef7efd37SHong Zhang             ierr  = MatCreateSubMatrix(pc->mat,ilink->is,NULL,scall,&jac->Afield[i]);CHKERRQ(ierr);
66780c96bb1SFande Kong           } else {
668*ef7efd37SHong Zhang             ierr  = MatCreateSubMatrix(pc->pmat,ilink->is,NULL,scall,&jac->Afield[i]);CHKERRQ(ierr);
66980c96bb1SFande Kong           }
67068dd23aaSBarry Smith           ilink = ilink->next;
67168dd23aaSBarry Smith         }
67268dd23aaSBarry Smith       }
67368dd23aaSBarry Smith     }
674e52d2c62SBarry Smith   }
67568dd23aaSBarry Smith 
6763b224e63SBarry Smith   if (jac->type == PC_COMPOSITE_SCHUR) {
6773b224e63SBarry Smith     IS          ccis;
678c096484dSStefano Zampini     PetscBool   isspd;
6794aa3045dSJed Brown     PetscInt    rstart,rend;
680093c86ffSJed Brown     char        lscname[256];
681093c86ffSJed Brown     PetscObject LSC_L;
682ce94432eSBarry Smith 
683ce94432eSBarry Smith     if (nsplit != 2) SETERRQ(PetscObjectComm((PetscObject)pc),PETSC_ERR_ARG_INCOMP,"To use Schur complement preconditioner you must have exactly 2 fields");
68468dd23aaSBarry Smith 
685c096484dSStefano Zampini     /* If pc->mat is SPD, don't scale by -1 the Schur complement */
686c096484dSStefano Zampini     if (jac->schurscale == (PetscScalar)-1.0) {
687c096484dSStefano Zampini       ierr = MatGetOption(pc->pmat,MAT_SPD,&isspd);CHKERRQ(ierr);
688c096484dSStefano Zampini       jac->schurscale = (isspd == PETSC_TRUE) ? 1.0 : -1.0;
689c096484dSStefano Zampini     }
690c096484dSStefano Zampini 
691e6cab6aaSJed Brown     /* When extracting off-diagonal submatrices, we take complements from this range */
692e6cab6aaSJed Brown     ierr = MatGetOwnershipRangeColumn(pc->mat,&rstart,&rend);CHKERRQ(ierr);
693e6cab6aaSJed Brown 
6943b224e63SBarry Smith     /* need to handle case when one is resetting up the preconditioner */
6953b224e63SBarry Smith     if (jac->schur) {
6960298fd71SBarry Smith       KSP kspA = jac->head->ksp, kspInner = NULL, kspUpper = jac->kspupper;
697443836d0SMatthew G Knepley 
698fb3147dbSMatthew G Knepley       ierr  = MatSchurComplementGetKSP(jac->schur, &kspInner);CHKERRQ(ierr);
6993b224e63SBarry Smith       ilink = jac->head;
70049bb4cd7SJungho Lee       ierr  = ISComplement(ilink->is_col,rstart,rend,&ccis);CHKERRQ(ierr);
7014e39094bSDmitry Karpeev       if (jac->offdiag_use_amat) {
7027dae84e0SHong Zhang 	ierr  = MatCreateSubMatrix(pc->mat,ilink->is,ccis,MAT_REUSE_MATRIX,&jac->B);CHKERRQ(ierr);
703c84da90fSDmitry Karpeev       } else {
7047dae84e0SHong Zhang 	ierr  = MatCreateSubMatrix(pc->pmat,ilink->is,ccis,MAT_REUSE_MATRIX,&jac->B);CHKERRQ(ierr);
705c84da90fSDmitry Karpeev       }
706fcfd50ebSBarry Smith       ierr  = ISDestroy(&ccis);CHKERRQ(ierr);
7073b224e63SBarry Smith       ilink = ilink->next;
70849bb4cd7SJungho Lee       ierr  = ISComplement(ilink->is_col,rstart,rend,&ccis);CHKERRQ(ierr);
7094e39094bSDmitry Karpeev       if (jac->offdiag_use_amat) {
7107dae84e0SHong Zhang 	ierr  = MatCreateSubMatrix(pc->mat,ilink->is,ccis,MAT_REUSE_MATRIX,&jac->C);CHKERRQ(ierr);
711c84da90fSDmitry Karpeev       } else {
7127dae84e0SHong Zhang 	ierr  = MatCreateSubMatrix(pc->pmat,ilink->is,ccis,MAT_REUSE_MATRIX,&jac->C);CHKERRQ(ierr);
713c84da90fSDmitry Karpeev       }
714fcfd50ebSBarry Smith       ierr  = ISDestroy(&ccis);CHKERRQ(ierr);
715aa6c7ce3SBarry Smith       ierr  = MatSchurComplementUpdateSubMatrices(jac->schur,jac->mat[0],jac->pmat[0],jac->B,jac->C,jac->mat[1]);CHKERRQ(ierr);
716a7476a74SDmitry Karpeev       if (jac->schurpre == PC_FIELDSPLIT_SCHUR_PRE_SELFP) {
717a7476a74SDmitry Karpeev 	ierr = MatDestroy(&jac->schurp);CHKERRQ(ierr);
718a7476a74SDmitry Karpeev 	ierr = MatSchurComplementGetPmat(jac->schur,MAT_INITIAL_MATRIX,&jac->schurp);CHKERRQ(ierr);
719a7476a74SDmitry Karpeev       }
720443836d0SMatthew G Knepley       if (kspA != kspInner) {
72123ee1639SBarry Smith         ierr = KSPSetOperators(kspA,jac->mat[0],jac->pmat[0]);CHKERRQ(ierr);
722443836d0SMatthew G Knepley       }
723443836d0SMatthew G Knepley       if (kspUpper != kspA) {
72423ee1639SBarry Smith         ierr = KSPSetOperators(kspUpper,jac->mat[0],jac->pmat[0]);CHKERRQ(ierr);
725443836d0SMatthew G Knepley       }
72623ee1639SBarry Smith       ierr = KSPSetOperators(jac->kspschur,jac->schur,FieldSplitSchurPre(jac));CHKERRQ(ierr);
7273b224e63SBarry Smith     } else {
728bafc1b83SMatthew G Knepley       const char   *Dprefix;
729470b340bSDmitry Karpeev       char         schurprefix[256], schurmatprefix[256];
730514bf10dSMatthew G Knepley       char         schurtestoption[256];
731bdddcaaaSMatthew G Knepley       MatNullSpace sp;
732514bf10dSMatthew G Knepley       PetscBool    flg;
7333b224e63SBarry Smith 
734a04f6461SBarry Smith       /* extract the A01 and A10 matrices */
7353b224e63SBarry Smith       ilink = jac->head;
73649bb4cd7SJungho Lee       ierr  = ISComplement(ilink->is_col,rstart,rend,&ccis);CHKERRQ(ierr);
7374e39094bSDmitry Karpeev       if (jac->offdiag_use_amat) {
7387dae84e0SHong Zhang 	ierr  = MatCreateSubMatrix(pc->mat,ilink->is,ccis,MAT_INITIAL_MATRIX,&jac->B);CHKERRQ(ierr);
739c84da90fSDmitry Karpeev       } else {
7407dae84e0SHong Zhang 	ierr  = MatCreateSubMatrix(pc->pmat,ilink->is,ccis,MAT_INITIAL_MATRIX,&jac->B);CHKERRQ(ierr);
741c84da90fSDmitry Karpeev       }
742fcfd50ebSBarry Smith       ierr  = ISDestroy(&ccis);CHKERRQ(ierr);
7433b224e63SBarry Smith       ilink = ilink->next;
74449bb4cd7SJungho Lee       ierr  = ISComplement(ilink->is_col,rstart,rend,&ccis);CHKERRQ(ierr);
7454e39094bSDmitry Karpeev       if (jac->offdiag_use_amat) {
7467dae84e0SHong Zhang 	ierr  = MatCreateSubMatrix(pc->mat,ilink->is,ccis,MAT_INITIAL_MATRIX,&jac->C);CHKERRQ(ierr);
747c84da90fSDmitry Karpeev       } else {
7487dae84e0SHong Zhang 	ierr  = MatCreateSubMatrix(pc->pmat,ilink->is,ccis,MAT_INITIAL_MATRIX,&jac->C);CHKERRQ(ierr);
749c84da90fSDmitry Karpeev       }
750fcfd50ebSBarry Smith       ierr  = ISDestroy(&ccis);CHKERRQ(ierr);
75120252d06SBarry Smith 
752f5236f50SJed Brown       /* Use mat[0] (diagonal block of Amat) preconditioned by pmat[0] to define Schur complement */
75320252d06SBarry Smith       ierr = MatCreate(((PetscObject)jac->mat[0])->comm,&jac->schur);CHKERRQ(ierr);
75420252d06SBarry Smith       ierr = MatSetType(jac->schur,MATSCHURCOMPLEMENT);CHKERRQ(ierr);
755bee83525SDmitry Karpeev       ierr = MatSchurComplementSetSubMatrices(jac->schur,jac->mat[0],jac->pmat[0],jac->B,jac->C,jac->mat[1]);CHKERRQ(ierr);
756470b340bSDmitry Karpeev       ierr = PetscSNPrintf(schurmatprefix, sizeof(schurmatprefix), "%sfieldsplit_%s_", ((PetscObject)pc)->prefix ? ((PetscObject)pc)->prefix : "", ilink->splitname);CHKERRQ(ierr);
757470b340bSDmitry 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? */
758470b340bSDmitry Karpeev       ierr = MatSetOptionsPrefix(jac->schur,schurmatprefix);CHKERRQ(ierr);
759470b340bSDmitry Karpeev       ierr = MatSetFromOptions(jac->schur);CHKERRQ(ierr);
760895c21f2SBarry Smith       ierr = MatGetNullSpace(jac->mat[1], &sp);CHKERRQ(ierr);
76120252d06SBarry Smith       if (sp) {
76220252d06SBarry Smith         ierr = MatSetNullSpace(jac->schur, sp);CHKERRQ(ierr);
76320252d06SBarry Smith       }
76420252d06SBarry Smith 
76520252d06SBarry Smith       ierr = PetscSNPrintf(schurtestoption, sizeof(schurtestoption), "-fieldsplit_%s_inner_", ilink->splitname);CHKERRQ(ierr);
766c5929fdfSBarry Smith       ierr = PetscOptionsFindPairPrefix_Private(((PetscObject)pc)->options,((PetscObject)pc)->prefix, schurtestoption, NULL, &flg);CHKERRQ(ierr);
767514bf10dSMatthew G Knepley       if (flg) {
768514bf10dSMatthew G Knepley         DM  dmInner;
76921635b76SJed Brown         KSP kspInner;
77021635b76SJed Brown 
77121635b76SJed Brown         ierr = MatSchurComplementGetKSP(jac->schur, &kspInner);CHKERRQ(ierr);
77221635b76SJed Brown         ierr = PetscSNPrintf(schurprefix, sizeof(schurprefix), "%sfieldsplit_%s_inner_", ((PetscObject)pc)->prefix ? ((PetscObject)pc)->prefix : "", ilink->splitname);CHKERRQ(ierr);
77321635b76SJed Brown         /* Indent this deeper to emphasize the "inner" nature of this solver. */
77421635b76SJed Brown         ierr = PetscObjectIncrementTabLevel((PetscObject)kspInner, (PetscObject) pc, 2);CHKERRQ(ierr);
77521635b76SJed Brown         ierr = KSPSetOptionsPrefix(kspInner, schurprefix);CHKERRQ(ierr);
776514bf10dSMatthew G Knepley 
777514bf10dSMatthew G Knepley         /* Set DM for new solver */
778bafc1b83SMatthew G Knepley         ierr = KSPGetDM(jac->head->ksp, &dmInner);CHKERRQ(ierr);
77921635b76SJed Brown         ierr = KSPSetDM(kspInner, dmInner);CHKERRQ(ierr);
78021635b76SJed Brown         ierr = KSPSetDMActive(kspInner, PETSC_FALSE);CHKERRQ(ierr);
781514bf10dSMatthew G Knepley       } else {
78221635b76SJed Brown          /* Use the outer solver for the inner solve, but revert the KSPPREONLY from PCFieldSplitSetFields_FieldSplit or
78321635b76SJed Brown           * PCFieldSplitSetIS_FieldSplit. We don't want KSPPREONLY because it makes the Schur complement inexact,
78421635b76SJed Brown           * preventing Schur complement reduction to be an accurate solve. Usually when an iterative solver is used for
78521635b76SJed 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
78621635b76SJed Brown           * GMRES the default. Note that it is also common to use PREONLY for S, in which case S may not be used
78721635b76SJed Brown           * directly, and the user is responsible for setting an inexact method for fieldsplit's A^{-1}. */
78821635b76SJed Brown         ierr = KSPSetType(jac->head->ksp,KSPGMRES);CHKERRQ(ierr);
789514bf10dSMatthew G Knepley         ierr = MatSchurComplementSetKSP(jac->schur,jac->head->ksp);CHKERRQ(ierr);
790bafc1b83SMatthew G Knepley       }
79123ee1639SBarry Smith       ierr = KSPSetOperators(jac->head->ksp,jac->mat[0],jac->pmat[0]);CHKERRQ(ierr);
7925a9f2f41SSatish Balay       ierr = KSPSetFromOptions(jac->head->ksp);CHKERRQ(ierr);
79397bbdb24SBarry Smith       ierr = MatSetFromOptions(jac->schur);CHKERRQ(ierr);
79497bbdb24SBarry Smith 
795443836d0SMatthew G Knepley       ierr = PetscSNPrintf(schurtestoption, sizeof(schurtestoption), "-fieldsplit_%s_upper_", ilink->splitname);CHKERRQ(ierr);
796c5929fdfSBarry Smith       ierr = PetscOptionsFindPairPrefix_Private(((PetscObject)pc)->options,((PetscObject)pc)->prefix, schurtestoption, NULL, &flg);CHKERRQ(ierr);
797443836d0SMatthew G Knepley       if (flg) {
798443836d0SMatthew G Knepley         DM dmInner;
799443836d0SMatthew G Knepley 
800443836d0SMatthew G Knepley         ierr = PetscSNPrintf(schurprefix, sizeof(schurprefix), "%sfieldsplit_%s_upper_", ((PetscObject)pc)->prefix ? ((PetscObject)pc)->prefix : "", ilink->splitname);CHKERRQ(ierr);
80182f516ccSBarry Smith         ierr = KSPCreate(PetscObjectComm((PetscObject)pc), &jac->kspupper);CHKERRQ(ierr);
802422a814eSBarry Smith         ierr = KSPSetErrorIfNotConverged(jac->kspupper,pc->erroriffailure);CHKERRQ(ierr);
803443836d0SMatthew G Knepley         ierr = KSPSetOptionsPrefix(jac->kspupper, schurprefix);CHKERRQ(ierr);
804443836d0SMatthew G Knepley         ierr = KSPGetDM(jac->head->ksp, &dmInner);CHKERRQ(ierr);
805443836d0SMatthew G Knepley         ierr = KSPSetDM(jac->kspupper, dmInner);CHKERRQ(ierr);
806443836d0SMatthew G Knepley         ierr = KSPSetDMActive(jac->kspupper, PETSC_FALSE);CHKERRQ(ierr);
807443836d0SMatthew G Knepley         ierr = KSPSetFromOptions(jac->kspupper);CHKERRQ(ierr);
80823ee1639SBarry Smith         ierr = KSPSetOperators(jac->kspupper,jac->mat[0],jac->pmat[0]);CHKERRQ(ierr);
809443836d0SMatthew G Knepley         ierr = VecDuplicate(jac->head->x, &jac->head->z);CHKERRQ(ierr);
810443836d0SMatthew G Knepley       } else {
811443836d0SMatthew G Knepley         jac->kspupper = jac->head->ksp;
812443836d0SMatthew G Knepley         ierr          = PetscObjectReference((PetscObject) jac->head->ksp);CHKERRQ(ierr);
813443836d0SMatthew G Knepley       }
814443836d0SMatthew G Knepley 
815a7476a74SDmitry Karpeev       if (jac->schurpre == PC_FIELDSPLIT_SCHUR_PRE_SELFP) {
816a7476a74SDmitry Karpeev 	ierr = MatSchurComplementGetPmat(jac->schur,MAT_INITIAL_MATRIX,&jac->schurp);CHKERRQ(ierr);
817a7476a74SDmitry Karpeev       }
818ce94432eSBarry Smith       ierr = KSPCreate(PetscObjectComm((PetscObject)pc),&jac->kspschur);CHKERRQ(ierr);
819422a814eSBarry Smith       ierr = KSPSetErrorIfNotConverged(jac->kspschur,pc->erroriffailure);CHKERRQ(ierr);
82097bbdb24SBarry Smith       ierr = PetscLogObjectParent((PetscObject)pc,(PetscObject)jac->kspschur);CHKERRQ(ierr);
82120252d06SBarry Smith       ierr = PetscObjectIncrementTabLevel((PetscObject)jac->kspschur,(PetscObject)pc,1);CHKERRQ(ierr);
82297bbdb24SBarry Smith       if (jac->schurpre == PC_FIELDSPLIT_SCHUR_PRE_SELF) {
8237233a360SDmitry Karpeev         PC pcschur;
8247233a360SDmitry Karpeev         ierr = KSPGetPC(jac->kspschur,&pcschur);CHKERRQ(ierr);
8257233a360SDmitry Karpeev         ierr = PCSetType(pcschur,PCNONE);CHKERRQ(ierr);
82697bbdb24SBarry Smith         /* Note: This is bad if there exist preconditioners for MATSCHURCOMPLEMENT */
827e74569cdSMatthew G. Knepley       } else if (jac->schurpre == PC_FIELDSPLIT_SCHUR_PRE_FULL) {
828e74569cdSMatthew G. Knepley         ierr = MatSchurComplementComputeExplicitOperator(jac->schur, &jac->schur_user);CHKERRQ(ierr);
82997bbdb24SBarry Smith       }
83023ee1639SBarry Smith       ierr = KSPSetOperators(jac->kspschur,jac->schur,FieldSplitSchurPre(jac));CHKERRQ(ierr);
83197bbdb24SBarry Smith       ierr = KSPGetOptionsPrefix(jac->head->next->ksp, &Dprefix);CHKERRQ(ierr);
83297bbdb24SBarry Smith       ierr = KSPSetOptionsPrefix(jac->kspschur,         Dprefix);CHKERRQ(ierr);
833c096484dSStefano Zampini       /* propagate DM */
834b20b4189SMatthew G. Knepley       {
835b20b4189SMatthew G. Knepley         DM sdm;
836b20b4189SMatthew G. Knepley         ierr = KSPGetDM(jac->head->next->ksp, &sdm);CHKERRQ(ierr);
837b20b4189SMatthew G. Knepley         if (sdm) {
838b20b4189SMatthew G. Knepley           ierr = KSPSetDM(jac->kspschur, sdm);CHKERRQ(ierr);
839b20b4189SMatthew G. Knepley           ierr = KSPSetDMActive(jac->kspschur, PETSC_FALSE);CHKERRQ(ierr);
840b20b4189SMatthew G. Knepley         }
841b20b4189SMatthew G. Knepley       }
84297bbdb24SBarry Smith       /* really want setfromoptions called in PCSetFromOptions_FieldSplit(), but it is not ready yet */
84397bbdb24SBarry Smith       /* need to call this every time, since the jac->kspschur is freshly created, otherwise its options never get set */
84497bbdb24SBarry Smith       ierr = KSPSetFromOptions(jac->kspschur);CHKERRQ(ierr);
84597bbdb24SBarry Smith     }
84697bbdb24SBarry Smith 
8475a9f2f41SSatish Balay     /* HACK: special support to forward L and Lp matrices that might be used by PCLSC */
8488caf3d72SBarry Smith     ierr = PetscSNPrintf(lscname,sizeof(lscname),"%s_LSC_L",ilink->splitname);CHKERRQ(ierr);
849519d70e2SJed Brown     ierr = PetscObjectQuery((PetscObject)pc->mat,lscname,(PetscObject*)&LSC_L);CHKERRQ(ierr);
8503b224e63SBarry Smith     if (!LSC_L) {ierr = PetscObjectQuery((PetscObject)pc->pmat,lscname,(PetscObject*)&LSC_L);CHKERRQ(ierr);}
851c1570756SJed Brown     if (LSC_L) {ierr = PetscObjectCompose((PetscObject)jac->schur,"LSC_L",(PetscObject)LSC_L);CHKERRQ(ierr);}
8528caf3d72SBarry Smith     ierr = PetscSNPrintf(lscname,sizeof(lscname),"%s_LSC_Lp",ilink->splitname);CHKERRQ(ierr);
85397bbdb24SBarry Smith     ierr = PetscObjectQuery((PetscObject)pc->pmat,lscname,(PetscObject*)&LSC_L);CHKERRQ(ierr);
8545a9f2f41SSatish Balay     if (!LSC_L) {ierr = PetscObjectQuery((PetscObject)pc->mat,lscname,(PetscObject*)&LSC_L);CHKERRQ(ierr);}
8550971522cSBarry Smith     if (LSC_L) {ierr = PetscObjectCompose((PetscObject)jac->schur,"LSC_Lp",(PetscObject)LSC_L);CHKERRQ(ierr);}
85697bbdb24SBarry Smith   } else {
85768bd789dSDmitry Karpeev     /* set up the individual splits' PCs */
8580971522cSBarry Smith     i     = 0;
8590971522cSBarry Smith     ilink = jac->head;
8600971522cSBarry Smith     while (ilink) {
86123ee1639SBarry Smith       ierr = KSPSetOperators(ilink->ksp,jac->mat[i],jac->pmat[i]);CHKERRQ(ierr);
8620971522cSBarry Smith       /* really want setfromoptions called in PCSetFromOptions_FieldSplit(), but it is not ready yet */
8630971522cSBarry Smith       if (!jac->suboptionsset) {ierr = KSPSetFromOptions(ilink->ksp);CHKERRQ(ierr);}
8640971522cSBarry Smith       i++;
8650971522cSBarry Smith       ilink = ilink->next;
8660971522cSBarry Smith     }
8673b224e63SBarry Smith   }
8683b224e63SBarry Smith 
869c1570756SJed Brown   jac->suboptionsset = PETSC_TRUE;
8700971522cSBarry Smith   PetscFunctionReturn(0);
8710971522cSBarry Smith }
8720971522cSBarry Smith 
8735a9f2f41SSatish Balay #define FieldSplitSplitSolveAdd(ilink,xx,yy) \
874ca9f406cSSatish Balay   (VecScatterBegin(ilink->sctx,xx,ilink->x,INSERT_VALUES,SCATTER_FORWARD) || \
875ca9f406cSSatish Balay    VecScatterEnd(ilink->sctx,xx,ilink->x,INSERT_VALUES,SCATTER_FORWARD) || \
8769df09d43SBarry Smith    PetscLogEventBegin(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL) ||\
8775a9f2f41SSatish Balay    KSPSolve(ilink->ksp,ilink->x,ilink->y) ||                               \
8789df09d43SBarry Smith    PetscLogEventEnd(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL) ||\
879ca9f406cSSatish Balay    VecScatterBegin(ilink->sctx,ilink->y,yy,ADD_VALUES,SCATTER_REVERSE) ||  \
880ca9f406cSSatish Balay    VecScatterEnd(ilink->sctx,ilink->y,yy,ADD_VALUES,SCATTER_REVERSE))
88179416396SBarry Smith 
8823b224e63SBarry Smith static PetscErrorCode PCApply_FieldSplit_Schur(PC pc,Vec x,Vec y)
8833b224e63SBarry Smith {
8843b224e63SBarry Smith   PC_FieldSplit     *jac = (PC_FieldSplit*)pc->data;
8853b224e63SBarry Smith   PetscErrorCode    ierr;
8863b224e63SBarry Smith   PC_FieldSplitLink ilinkA = jac->head, ilinkD = ilinkA->next;
887443836d0SMatthew G Knepley   KSP               kspA   = ilinkA->ksp, kspLower = kspA, kspUpper = jac->kspupper;
8883b224e63SBarry Smith 
8893b224e63SBarry Smith   PetscFunctionBegin;
890c5d2311dSJed Brown   switch (jac->schurfactorization) {
891c9c6ffaaSJed Brown   case PC_FIELDSPLIT_SCHUR_FACT_DIAG:
892a04f6461SBarry Smith     /* [A00 0; 0 -S], positive definite, suitable for MINRES */
893c5d2311dSJed Brown     ierr = VecScatterBegin(ilinkA->sctx,x,ilinkA->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
894c5d2311dSJed Brown     ierr = VecScatterBegin(ilinkD->sctx,x,ilinkD->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
895c5d2311dSJed Brown     ierr = VecScatterEnd(ilinkA->sctx,x,ilinkA->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
8969df09d43SBarry Smith     ierr = PetscLogEventBegin(ilinkA->event,kspA,ilinkA->x,ilinkA->y,NULL);CHKERRQ(ierr);
897443836d0SMatthew G Knepley     ierr = KSPSolve(kspA,ilinkA->x,ilinkA->y);CHKERRQ(ierr);
8989df09d43SBarry Smith     ierr = PetscLogEventEnd(ilinkA->event,kspA,ilinkA->x,ilinkA->y,NULL);CHKERRQ(ierr);
899c5d2311dSJed Brown     ierr = VecScatterBegin(ilinkA->sctx,ilinkA->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
900c5d2311dSJed Brown     ierr = VecScatterEnd(ilinkD->sctx,x,ilinkD->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
9019df09d43SBarry Smith     ierr = PetscLogEventBegin(KSP_Solve_FS_S,jac->kspschur,ilinkD->x,ilinkD->y,NULL);CHKERRQ(ierr);
902c5d2311dSJed Brown     ierr = KSPSolve(jac->kspschur,ilinkD->x,ilinkD->y);CHKERRQ(ierr);
9039df09d43SBarry Smith     ierr = PetscLogEventEnd(KSP_Solve_FS_S,jac->kspschur,ilinkD->x,ilinkD->y,NULL);CHKERRQ(ierr);
904c096484dSStefano Zampini     ierr = VecScale(ilinkD->y,jac->schurscale);CHKERRQ(ierr);
905c5d2311dSJed Brown     ierr = VecScatterBegin(ilinkD->sctx,ilinkD->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
906c5d2311dSJed Brown     ierr = VecScatterEnd(ilinkA->sctx,ilinkA->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
907c5d2311dSJed Brown     ierr = VecScatterEnd(ilinkD->sctx,ilinkD->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
908c5d2311dSJed Brown     break;
909c9c6ffaaSJed Brown   case PC_FIELDSPLIT_SCHUR_FACT_LOWER:
910a04f6461SBarry Smith     /* [A00 0; A10 S], suitable for left preconditioning */
911c5d2311dSJed Brown     ierr = VecScatterBegin(ilinkA->sctx,x,ilinkA->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
912c5d2311dSJed Brown     ierr = VecScatterEnd(ilinkA->sctx,x,ilinkA->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
9139df09d43SBarry Smith     ierr = PetscLogEventBegin(ilinkA->event,kspA,ilinkA->x,ilinkA->y,NULL);CHKERRQ(ierr);
914443836d0SMatthew G Knepley     ierr = KSPSolve(kspA,ilinkA->x,ilinkA->y);CHKERRQ(ierr);
9159df09d43SBarry Smith     ierr = PetscLogEventEnd(ilinkA->event,kspA,ilinkA->x,ilinkA->y,NULL);CHKERRQ(ierr);
916c5d2311dSJed Brown     ierr = MatMult(jac->C,ilinkA->y,ilinkD->x);CHKERRQ(ierr);
917c5d2311dSJed Brown     ierr = VecScale(ilinkD->x,-1.);CHKERRQ(ierr);
918c5d2311dSJed Brown     ierr = VecScatterBegin(ilinkD->sctx,x,ilinkD->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
919c5d2311dSJed Brown     ierr = VecScatterBegin(ilinkA->sctx,ilinkA->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
920c5d2311dSJed Brown     ierr = VecScatterEnd(ilinkD->sctx,x,ilinkD->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
9219df09d43SBarry Smith     ierr = PetscLogEventBegin(KSP_Solve_FS_S,jac->kspschur,ilinkD->x,ilinkD->y,NULL);CHKERRQ(ierr);
922c5d2311dSJed Brown     ierr = KSPSolve(jac->kspschur,ilinkD->x,ilinkD->y);CHKERRQ(ierr);
9239df09d43SBarry Smith     ierr = PetscLogEventEnd(KSP_Solve_FS_S,jac->kspschur,ilinkD->x,ilinkD->y,NULL);CHKERRQ(ierr);
924c5d2311dSJed Brown     ierr = VecScatterBegin(ilinkD->sctx,ilinkD->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
925c5d2311dSJed Brown     ierr = VecScatterEnd(ilinkA->sctx,ilinkA->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
926c5d2311dSJed Brown     ierr = VecScatterEnd(ilinkD->sctx,ilinkD->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
927c5d2311dSJed Brown     break;
928c9c6ffaaSJed Brown   case PC_FIELDSPLIT_SCHUR_FACT_UPPER:
929a04f6461SBarry Smith     /* [A00 A01; 0 S], suitable for right preconditioning */
930c5d2311dSJed Brown     ierr = VecScatterBegin(ilinkD->sctx,x,ilinkD->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
931c5d2311dSJed Brown     ierr = VecScatterEnd(ilinkD->sctx,x,ilinkD->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
9329df09d43SBarry Smith     ierr = PetscLogEventBegin(KSP_Solve_FS_S,jac->kspschur,ilinkD->x,ilinkD->y,NULL);CHKERRQ(ierr);
933c5d2311dSJed Brown     ierr = KSPSolve(jac->kspschur,ilinkD->x,ilinkD->y);CHKERRQ(ierr);
9349df09d43SBarry 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);
935c5d2311dSJed Brown     ierr = VecScale(ilinkA->x,-1.);CHKERRQ(ierr);
936c5d2311dSJed Brown     ierr = VecScatterBegin(ilinkA->sctx,x,ilinkA->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
937c5d2311dSJed Brown     ierr = VecScatterBegin(ilinkD->sctx,ilinkD->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
938c5d2311dSJed Brown     ierr = VecScatterEnd(ilinkA->sctx,x,ilinkA->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
9399df09d43SBarry Smith     ierr = PetscLogEventBegin(ilinkA->event,kspA,ilinkA->x,ilinkA->y,NULL);CHKERRQ(ierr);
940443836d0SMatthew G Knepley     ierr = KSPSolve(kspA,ilinkA->x,ilinkA->y);CHKERRQ(ierr);
9419df09d43SBarry Smith     ierr = PetscLogEventEnd(ilinkA->event,kspA,ilinkA->x,ilinkA->y,NULL);CHKERRQ(ierr);
942c5d2311dSJed Brown     ierr = VecScatterBegin(ilinkA->sctx,ilinkA->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
943c5d2311dSJed Brown     ierr = VecScatterEnd(ilinkD->sctx,ilinkD->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
944c5d2311dSJed Brown     ierr = VecScatterEnd(ilinkA->sctx,ilinkA->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
945c5d2311dSJed Brown     break;
946c9c6ffaaSJed Brown   case PC_FIELDSPLIT_SCHUR_FACT_FULL:
947a04f6461SBarry 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 */
9483b224e63SBarry Smith     ierr = VecScatterBegin(ilinkA->sctx,x,ilinkA->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
9493b224e63SBarry Smith     ierr = VecScatterEnd(ilinkA->sctx,x,ilinkA->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
9509df09d43SBarry Smith     ierr = PetscLogEventBegin(KSP_Solve_FS_L,kspLower,ilinkA->x,ilinkA->y,NULL);CHKERRQ(ierr);
951443836d0SMatthew G Knepley     ierr = KSPSolve(kspLower,ilinkA->x,ilinkA->y);CHKERRQ(ierr);
9529df09d43SBarry Smith     ierr = PetscLogEventEnd(KSP_Solve_FS_L,kspLower,ilinkA->x,ilinkA->y,NULL);CHKERRQ(ierr);
9533b224e63SBarry Smith     ierr = MatMult(jac->C,ilinkA->y,ilinkD->x);CHKERRQ(ierr);
9543b224e63SBarry Smith     ierr = VecScale(ilinkD->x,-1.0);CHKERRQ(ierr);
9553b224e63SBarry Smith     ierr = VecScatterBegin(ilinkD->sctx,x,ilinkD->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
9563b224e63SBarry Smith     ierr = VecScatterEnd(ilinkD->sctx,x,ilinkD->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
9573b224e63SBarry Smith 
9589df09d43SBarry Smith     ierr = PetscLogEventBegin(KSP_Solve_FS_S,jac->kspschur,ilinkD->x,ilinkD->y,NULL);CHKERRQ(ierr);
9593b224e63SBarry Smith     ierr = KSPSolve(jac->kspschur,ilinkD->x,ilinkD->y);CHKERRQ(ierr);
9609df09d43SBarry Smith     ierr = PetscLogEventEnd(KSP_Solve_FS_S,jac->kspschur,ilinkD->x,ilinkD->y,NULL);CHKERRQ(ierr);
9613b224e63SBarry Smith     ierr = VecScatterBegin(ilinkD->sctx,ilinkD->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
9623b224e63SBarry Smith     ierr = VecScatterEnd(ilinkD->sctx,ilinkD->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
9633b224e63SBarry Smith 
964443836d0SMatthew G Knepley     if (kspUpper == kspA) {
9653b224e63SBarry Smith       ierr = MatMult(jac->B,ilinkD->y,ilinkA->y);CHKERRQ(ierr);
9663b224e63SBarry Smith       ierr = VecAXPY(ilinkA->x,-1.0,ilinkA->y);CHKERRQ(ierr);
9679df09d43SBarry Smith       ierr = PetscLogEventBegin(ilinkA->event,kspA,ilinkA->x,ilinkA->y,NULL);CHKERRQ(ierr);
968443836d0SMatthew G Knepley       ierr = KSPSolve(kspA,ilinkA->x,ilinkA->y);CHKERRQ(ierr);
9699df09d43SBarry Smith       ierr = PetscLogEventEnd(ilinkA->event,kspA,ilinkA->x,ilinkA->y,NULL);CHKERRQ(ierr);
970443836d0SMatthew G Knepley     } else {
9719df09d43SBarry Smith       ierr = PetscLogEventBegin(ilinkA->event,kspA,ilinkA->x,ilinkA->y,NULL);CHKERRQ(ierr);
972443836d0SMatthew G Knepley       ierr = KSPSolve(kspA,ilinkA->x,ilinkA->y);CHKERRQ(ierr);
9739df09d43SBarry Smith       ierr = PetscLogEventEnd(ilinkA->event,kspA,ilinkA->x,ilinkA->y,NULL);CHKERRQ(ierr);
974443836d0SMatthew G Knepley       ierr = MatMult(jac->B,ilinkD->y,ilinkA->x);CHKERRQ(ierr);
9759df09d43SBarry Smith       ierr = PetscLogEventBegin(KSP_Solve_FS_U,kspUpper,ilinkA->x,ilinkA->z,NULL);CHKERRQ(ierr);
976443836d0SMatthew G Knepley       ierr = KSPSolve(kspUpper,ilinkA->x,ilinkA->z);CHKERRQ(ierr);
9779df09d43SBarry Smith       ierr = PetscLogEventEnd(KSP_Solve_FS_U,kspUpper,ilinkA->x,ilinkA->z,NULL);CHKERRQ(ierr);
978443836d0SMatthew G Knepley       ierr = VecAXPY(ilinkA->y,-1.0,ilinkA->z);CHKERRQ(ierr);
979443836d0SMatthew G Knepley     }
9803b224e63SBarry Smith     ierr = VecScatterBegin(ilinkA->sctx,ilinkA->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
9813b224e63SBarry Smith     ierr = VecScatterEnd(ilinkA->sctx,ilinkA->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
982c5d2311dSJed Brown   }
9833b224e63SBarry Smith   PetscFunctionReturn(0);
9843b224e63SBarry Smith }
9853b224e63SBarry Smith 
9860971522cSBarry Smith static PetscErrorCode PCApply_FieldSplit(PC pc,Vec x,Vec y)
9870971522cSBarry Smith {
9880971522cSBarry Smith   PC_FieldSplit      *jac = (PC_FieldSplit*)pc->data;
9890971522cSBarry Smith   PetscErrorCode     ierr;
9905a9f2f41SSatish Balay   PC_FieldSplitLink  ilink = jac->head;
991939b8a20SBarry Smith   PetscInt           cnt,bs;
992568ed31eSHong Zhang   KSPConvergedReason reason;
9930971522cSBarry Smith 
9940971522cSBarry Smith   PetscFunctionBegin;
99579416396SBarry Smith   if (jac->type == PC_COMPOSITE_ADDITIVE) {
9961b9fc7fcSBarry Smith     if (jac->defaultsplit) {
997939b8a20SBarry Smith       ierr = VecGetBlockSize(x,&bs);CHKERRQ(ierr);
998ce94432eSBarry 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);
999939b8a20SBarry Smith       ierr = VecGetBlockSize(y,&bs);CHKERRQ(ierr);
1000ce94432eSBarry 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);
10010971522cSBarry Smith       ierr = VecStrideGatherAll(x,jac->x,INSERT_VALUES);CHKERRQ(ierr);
10025a9f2f41SSatish Balay       while (ilink) {
10039df09d43SBarry Smith         ierr  = PetscLogEventBegin(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL);CHKERRQ(ierr);
10045a9f2f41SSatish Balay         ierr  = KSPSolve(ilink->ksp,ilink->x,ilink->y);CHKERRQ(ierr);
10059df09d43SBarry Smith         ierr  = PetscLogEventEnd(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL);CHKERRQ(ierr);
1006568ed31eSHong Zhang         ierr = KSPGetConvergedReason(ilink->ksp,&reason);CHKERRQ(ierr);
1007568ed31eSHong Zhang         if (reason == KSP_DIVERGED_PCSETUP_FAILED) {
1008568ed31eSHong Zhang           pc->failedreason = PC_SUBPC_ERROR;
1009568ed31eSHong Zhang         }
10105a9f2f41SSatish Balay         ilink = ilink->next;
10110971522cSBarry Smith       }
10120971522cSBarry Smith       ierr = VecStrideScatterAll(jac->y,y,INSERT_VALUES);CHKERRQ(ierr);
10131b9fc7fcSBarry Smith     } else {
1014efb30889SBarry Smith       ierr = VecSet(y,0.0);CHKERRQ(ierr);
10155a9f2f41SSatish Balay       while (ilink) {
10165a9f2f41SSatish Balay         ierr  = FieldSplitSplitSolveAdd(ilink,x,y);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         }
10215a9f2f41SSatish Balay         ilink = ilink->next;
10221b9fc7fcSBarry Smith       }
10231b9fc7fcSBarry Smith     }
1024e52d2c62SBarry Smith   } else if (jac->type == PC_COMPOSITE_MULTIPLICATIVE && jac->nsplits == 2) {
1025e52d2c62SBarry Smith     ierr = VecSet(y,0.0);CHKERRQ(ierr);
1026e52d2c62SBarry Smith     /* solve on first block for first block variables */
1027e52d2c62SBarry Smith     ierr = VecScatterBegin(ilink->sctx,x,ilink->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
1028e52d2c62SBarry Smith     ierr = VecScatterEnd(ilink->sctx,x,ilink->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
10299df09d43SBarry Smith     ierr = PetscLogEventBegin(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL);CHKERRQ(ierr);
1030e52d2c62SBarry Smith     ierr = KSPSolve(ilink->ksp,ilink->x,ilink->y);CHKERRQ(ierr);
10319df09d43SBarry Smith     ierr = PetscLogEventEnd(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL);CHKERRQ(ierr);
1032568ed31eSHong Zhang     ierr = KSPGetConvergedReason(ilink->ksp,&reason);CHKERRQ(ierr);
1033568ed31eSHong Zhang     if (reason == KSP_DIVERGED_PCSETUP_FAILED) {
1034568ed31eSHong Zhang       pc->failedreason = PC_SUBPC_ERROR;
1035568ed31eSHong Zhang     }
1036e52d2c62SBarry Smith     ierr = VecScatterBegin(ilink->sctx,ilink->y,y,ADD_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
1037e52d2c62SBarry Smith     ierr = VecScatterEnd(ilink->sctx,ilink->y,y,ADD_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
1038e52d2c62SBarry Smith 
1039e52d2c62SBarry Smith     /* compute the residual only onto second block variables using first block variables */
1040e52d2c62SBarry Smith     ierr = MatMult(jac->Afield[1],ilink->y,ilink->next->x);CHKERRQ(ierr);
1041e52d2c62SBarry Smith     ilink = ilink->next;
1042e52d2c62SBarry Smith     ierr = VecScale(ilink->x,-1.0);CHKERRQ(ierr);
1043e52d2c62SBarry Smith     ierr = VecScatterBegin(ilink->sctx,x,ilink->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
1044e52d2c62SBarry Smith     ierr = VecScatterEnd(ilink->sctx,x,ilink->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
1045e52d2c62SBarry Smith 
1046e52d2c62SBarry Smith     /* solve on second block variables */
10479df09d43SBarry Smith     ierr = PetscLogEventBegin(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL);CHKERRQ(ierr);
1048e52d2c62SBarry Smith     ierr = KSPSolve(ilink->ksp,ilink->x,ilink->y);CHKERRQ(ierr);
10499df09d43SBarry Smith     ierr = PetscLogEventEnd(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL);CHKERRQ(ierr);
1050568ed31eSHong Zhang     ierr = KSPGetConvergedReason(ilink->ksp,&reason);CHKERRQ(ierr);
1051568ed31eSHong Zhang     if (reason == KSP_DIVERGED_PCSETUP_FAILED) {
1052568ed31eSHong Zhang       pc->failedreason = PC_SUBPC_ERROR;
1053568ed31eSHong Zhang     }
1054e52d2c62SBarry Smith     ierr = VecScatterBegin(ilink->sctx,ilink->y,y,ADD_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
1055e52d2c62SBarry Smith     ierr = VecScatterEnd(ilink->sctx,ilink->y,y,ADD_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
105616913363SBarry Smith   } else if (jac->type == PC_COMPOSITE_MULTIPLICATIVE || jac->type == PC_COMPOSITE_SYMMETRIC_MULTIPLICATIVE) {
105779416396SBarry Smith     if (!jac->w1) {
105879416396SBarry Smith       ierr = VecDuplicate(x,&jac->w1);CHKERRQ(ierr);
105979416396SBarry Smith       ierr = VecDuplicate(x,&jac->w2);CHKERRQ(ierr);
106079416396SBarry Smith     }
1061efb30889SBarry Smith     ierr = VecSet(y,0.0);CHKERRQ(ierr);
10625a9f2f41SSatish Balay     ierr = FieldSplitSplitSolveAdd(ilink,x,y);CHKERRQ(ierr);
1063568ed31eSHong Zhang     ierr = KSPGetConvergedReason(ilink->ksp,&reason);CHKERRQ(ierr);
1064568ed31eSHong Zhang     if (reason == KSP_DIVERGED_PCSETUP_FAILED) {
1065568ed31eSHong Zhang       pc->failedreason = PC_SUBPC_ERROR;
1066568ed31eSHong Zhang     }
10673e197d65SBarry Smith     cnt  = 1;
10685a9f2f41SSatish Balay     while (ilink->next) {
10695a9f2f41SSatish Balay       ilink = ilink->next;
10703e197d65SBarry Smith       /* compute the residual only over the part of the vector needed */
10713e197d65SBarry Smith       ierr = MatMult(jac->Afield[cnt++],y,ilink->x);CHKERRQ(ierr);
10723e197d65SBarry Smith       ierr = VecScale(ilink->x,-1.0);CHKERRQ(ierr);
10733e197d65SBarry Smith       ierr = VecScatterBegin(ilink->sctx,x,ilink->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
10743e197d65SBarry Smith       ierr = VecScatterEnd(ilink->sctx,x,ilink->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
10759df09d43SBarry Smith       ierr = PetscLogEventBegin(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL);CHKERRQ(ierr);
10763e197d65SBarry Smith       ierr = KSPSolve(ilink->ksp,ilink->x,ilink->y);CHKERRQ(ierr);
10779df09d43SBarry Smith       ierr = PetscLogEventEnd(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL);CHKERRQ(ierr);
10782618eb8fSHong Zhang       ierr = KSPGetConvergedReason(ilink->ksp,&reason);CHKERRQ(ierr);
10792618eb8fSHong Zhang       if (reason == KSP_DIVERGED_PCSETUP_FAILED) {
10802618eb8fSHong Zhang         pc->failedreason = PC_SUBPC_ERROR;
10812618eb8fSHong Zhang       }
10823e197d65SBarry Smith       ierr = VecScatterBegin(ilink->sctx,ilink->y,y,ADD_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
10833e197d65SBarry Smith       ierr = VecScatterEnd(ilink->sctx,ilink->y,y,ADD_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
10843e197d65SBarry Smith     }
108551f519a2SBarry Smith     if (jac->type == PC_COMPOSITE_SYMMETRIC_MULTIPLICATIVE) {
108611755939SBarry Smith       cnt -= 2;
108751f519a2SBarry Smith       while (ilink->previous) {
108851f519a2SBarry Smith         ilink = ilink->previous;
108911755939SBarry Smith         /* compute the residual only over the part of the vector needed */
109011755939SBarry Smith         ierr = MatMult(jac->Afield[cnt--],y,ilink->x);CHKERRQ(ierr);
109111755939SBarry Smith         ierr = VecScale(ilink->x,-1.0);CHKERRQ(ierr);
109211755939SBarry Smith         ierr = VecScatterBegin(ilink->sctx,x,ilink->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
109311755939SBarry Smith         ierr = VecScatterEnd(ilink->sctx,x,ilink->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
10949df09d43SBarry Smith         ierr = PetscLogEventBegin(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL);CHKERRQ(ierr);
109511755939SBarry Smith         ierr = KSPSolve(ilink->ksp,ilink->x,ilink->y);CHKERRQ(ierr);
10969df09d43SBarry Smith         ierr = PetscLogEventEnd(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL);CHKERRQ(ierr);
1097568ed31eSHong Zhang         ierr = KSPGetConvergedReason(ilink->ksp,&reason);CHKERRQ(ierr);
1098568ed31eSHong Zhang         if (reason == KSP_DIVERGED_PCSETUP_FAILED) {
1099568ed31eSHong Zhang           pc->failedreason = PC_SUBPC_ERROR;
1100568ed31eSHong Zhang         }
110111755939SBarry Smith         ierr = VecScatterBegin(ilink->sctx,ilink->y,y,ADD_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
110211755939SBarry Smith         ierr = VecScatterEnd(ilink->sctx,ilink->y,y,ADD_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
110351f519a2SBarry Smith       }
110411755939SBarry Smith     }
1105ce94432eSBarry Smith   } else SETERRQ1(PetscObjectComm((PetscObject)pc),PETSC_ERR_SUP,"Unsupported or unknown composition",(int) jac->type);
11060971522cSBarry Smith   PetscFunctionReturn(0);
11070971522cSBarry Smith }
11080971522cSBarry Smith 
1109421e10b8SBarry Smith #define FieldSplitSplitSolveAddTranspose(ilink,xx,yy) \
1110ca9f406cSSatish Balay   (VecScatterBegin(ilink->sctx,xx,ilink->y,INSERT_VALUES,SCATTER_FORWARD) || \
1111ca9f406cSSatish Balay    VecScatterEnd(ilink->sctx,xx,ilink->y,INSERT_VALUES,SCATTER_FORWARD) || \
11129df09d43SBarry Smith    PetscLogEventBegin(ilink->event,ilink->ksp,ilink->y,ilink->x,NULL) || \
1113421e10b8SBarry Smith    KSPSolveTranspose(ilink->ksp,ilink->y,ilink->x) ||                  \
11149df09d43SBarry Smith    PetscLogEventBegin(ilink->event,ilink->ksp,ilink->y,ilink->x,NULL) || \
1115ca9f406cSSatish Balay    VecScatterBegin(ilink->sctx,ilink->x,yy,ADD_VALUES,SCATTER_REVERSE) || \
1116ca9f406cSSatish Balay    VecScatterEnd(ilink->sctx,ilink->x,yy,ADD_VALUES,SCATTER_REVERSE))
1117421e10b8SBarry Smith 
1118421e10b8SBarry Smith static PetscErrorCode PCApplyTranspose_FieldSplit(PC pc,Vec x,Vec y)
1119421e10b8SBarry Smith {
1120421e10b8SBarry Smith   PC_FieldSplit      *jac = (PC_FieldSplit*)pc->data;
1121421e10b8SBarry Smith   PetscErrorCode     ierr;
1122421e10b8SBarry Smith   PC_FieldSplitLink  ilink = jac->head;
1123939b8a20SBarry Smith   PetscInt           bs;
1124291dd214SHong Zhang   KSPConvergedReason reason;
1125421e10b8SBarry Smith 
1126421e10b8SBarry Smith   PetscFunctionBegin;
1127421e10b8SBarry Smith   if (jac->type == PC_COMPOSITE_ADDITIVE) {
1128421e10b8SBarry Smith     if (jac->defaultsplit) {
1129939b8a20SBarry Smith       ierr = VecGetBlockSize(x,&bs);CHKERRQ(ierr);
1130ce94432eSBarry 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);
1131939b8a20SBarry Smith       ierr = VecGetBlockSize(y,&bs);CHKERRQ(ierr);
1132ce94432eSBarry 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);
1133421e10b8SBarry Smith       ierr = VecStrideGatherAll(x,jac->x,INSERT_VALUES);CHKERRQ(ierr);
1134421e10b8SBarry Smith       while (ilink) {
11359df09d43SBarry Smith         ierr = PetscLogEventBegin(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL);CHKERRQ(ierr);
1136421e10b8SBarry Smith         ierr  = KSPSolveTranspose(ilink->ksp,ilink->x,ilink->y);CHKERRQ(ierr);
11379df09d43SBarry Smith         ierr = PetscLogEventEnd(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL);CHKERRQ(ierr);
11382618eb8fSHong Zhang         ierr = KSPGetConvergedReason(ilink->ksp,&reason);CHKERRQ(ierr);
11392618eb8fSHong Zhang         if (reason == KSP_DIVERGED_PCSETUP_FAILED) {
11402618eb8fSHong Zhang           pc->failedreason = PC_SUBPC_ERROR;
11412618eb8fSHong Zhang         }
1142421e10b8SBarry Smith         ilink = ilink->next;
1143421e10b8SBarry Smith       }
1144421e10b8SBarry Smith       ierr = VecStrideScatterAll(jac->y,y,INSERT_VALUES);CHKERRQ(ierr);
1145421e10b8SBarry Smith     } else {
1146421e10b8SBarry Smith       ierr = VecSet(y,0.0);CHKERRQ(ierr);
1147421e10b8SBarry Smith       while (ilink) {
1148421e10b8SBarry Smith         ierr = FieldSplitSplitSolveAddTranspose(ilink,x,y);CHKERRQ(ierr);
11492618eb8fSHong Zhang         ierr = KSPGetConvergedReason(ilink->ksp,&reason);CHKERRQ(ierr);
11502618eb8fSHong Zhang         if (reason == KSP_DIVERGED_PCSETUP_FAILED) {
11512618eb8fSHong Zhang           pc->failedreason = PC_SUBPC_ERROR;
11522618eb8fSHong Zhang         }
1153421e10b8SBarry Smith         ilink = ilink->next;
1154421e10b8SBarry Smith       }
1155421e10b8SBarry Smith     }
1156421e10b8SBarry Smith   } else {
1157421e10b8SBarry Smith     if (!jac->w1) {
1158421e10b8SBarry Smith       ierr = VecDuplicate(x,&jac->w1);CHKERRQ(ierr);
1159421e10b8SBarry Smith       ierr = VecDuplicate(x,&jac->w2);CHKERRQ(ierr);
1160421e10b8SBarry Smith     }
1161421e10b8SBarry Smith     ierr = VecSet(y,0.0);CHKERRQ(ierr);
1162421e10b8SBarry Smith     if (jac->type == PC_COMPOSITE_SYMMETRIC_MULTIPLICATIVE) {
1163421e10b8SBarry Smith       ierr = FieldSplitSplitSolveAddTranspose(ilink,x,y);CHKERRQ(ierr);
11642618eb8fSHong Zhang       ierr = KSPGetConvergedReason(ilink->ksp,&reason);CHKERRQ(ierr);
11652618eb8fSHong Zhang       if (reason == KSP_DIVERGED_PCSETUP_FAILED) {
11662618eb8fSHong Zhang         pc->failedreason = PC_SUBPC_ERROR;
11672618eb8fSHong Zhang       }
1168421e10b8SBarry Smith       while (ilink->next) {
1169421e10b8SBarry Smith         ilink = ilink->next;
11709989ab13SBarry Smith         ierr  = MatMultTranspose(pc->mat,y,jac->w1);CHKERRQ(ierr);
1171421e10b8SBarry Smith         ierr  = VecWAXPY(jac->w2,-1.0,jac->w1,x);CHKERRQ(ierr);
1172421e10b8SBarry Smith         ierr  = FieldSplitSplitSolveAddTranspose(ilink,jac->w2,y);CHKERRQ(ierr);
1173421e10b8SBarry Smith       }
1174421e10b8SBarry Smith       while (ilink->previous) {
1175421e10b8SBarry Smith         ilink = ilink->previous;
11769989ab13SBarry Smith         ierr  = MatMultTranspose(pc->mat,y,jac->w1);CHKERRQ(ierr);
1177421e10b8SBarry Smith         ierr  = VecWAXPY(jac->w2,-1.0,jac->w1,x);CHKERRQ(ierr);
1178421e10b8SBarry Smith         ierr  = FieldSplitSplitSolveAddTranspose(ilink,jac->w2,y);CHKERRQ(ierr);
1179421e10b8SBarry Smith       }
1180421e10b8SBarry Smith     } else {
1181421e10b8SBarry Smith       while (ilink->next) {   /* get to last entry in linked list */
1182421e10b8SBarry Smith         ilink = ilink->next;
1183421e10b8SBarry Smith       }
1184421e10b8SBarry Smith       ierr = FieldSplitSplitSolveAddTranspose(ilink,x,y);CHKERRQ(ierr);
11852618eb8fSHong Zhang       ierr = KSPGetConvergedReason(ilink->ksp,&reason);CHKERRQ(ierr);
11862618eb8fSHong Zhang       if (reason == KSP_DIVERGED_PCSETUP_FAILED) {
11872618eb8fSHong Zhang         pc->failedreason = PC_SUBPC_ERROR;
11882618eb8fSHong Zhang       }
1189421e10b8SBarry Smith       while (ilink->previous) {
1190421e10b8SBarry Smith         ilink = ilink->previous;
11919989ab13SBarry Smith         ierr  = MatMultTranspose(pc->mat,y,jac->w1);CHKERRQ(ierr);
1192421e10b8SBarry Smith         ierr  = VecWAXPY(jac->w2,-1.0,jac->w1,x);CHKERRQ(ierr);
1193421e10b8SBarry Smith         ierr  = FieldSplitSplitSolveAddTranspose(ilink,jac->w2,y);CHKERRQ(ierr);
1194421e10b8SBarry Smith       }
1195421e10b8SBarry Smith     }
1196421e10b8SBarry Smith   }
1197421e10b8SBarry Smith   PetscFunctionReturn(0);
1198421e10b8SBarry Smith }
1199421e10b8SBarry Smith 
1200574deadeSBarry Smith static PetscErrorCode PCReset_FieldSplit(PC pc)
12010971522cSBarry Smith {
12020971522cSBarry Smith   PC_FieldSplit     *jac = (PC_FieldSplit*)pc->data;
12030971522cSBarry Smith   PetscErrorCode    ierr;
12045a9f2f41SSatish Balay   PC_FieldSplitLink ilink = jac->head,next;
12050971522cSBarry Smith 
12060971522cSBarry Smith   PetscFunctionBegin;
12075a9f2f41SSatish Balay   while (ilink) {
1208f5f0d762SBarry Smith     ierr  = KSPDestroy(&ilink->ksp);CHKERRQ(ierr);
1209fcfd50ebSBarry Smith     ierr  = VecDestroy(&ilink->x);CHKERRQ(ierr);
1210fcfd50ebSBarry Smith     ierr  = VecDestroy(&ilink->y);CHKERRQ(ierr);
1211443836d0SMatthew G Knepley     ierr  = VecDestroy(&ilink->z);CHKERRQ(ierr);
1212fcfd50ebSBarry Smith     ierr  = VecScatterDestroy(&ilink->sctx);CHKERRQ(ierr);
1213fcfd50ebSBarry Smith     ierr  = ISDestroy(&ilink->is);CHKERRQ(ierr);
1214b5787286SJed Brown     ierr  = ISDestroy(&ilink->is_col);CHKERRQ(ierr);
1215f5f0d762SBarry Smith     ierr  = PetscFree(ilink->splitname);CHKERRQ(ierr);
1216f5f0d762SBarry Smith     ierr  = PetscFree(ilink->fields);CHKERRQ(ierr);
1217f5f0d762SBarry Smith     ierr  = PetscFree(ilink->fields_col);CHKERRQ(ierr);
12185a9f2f41SSatish Balay     next  = ilink->next;
1219f5f0d762SBarry Smith     ierr  = PetscFree(ilink);CHKERRQ(ierr);
12205a9f2f41SSatish Balay     ilink = next;
12210971522cSBarry Smith   }
1222f5f0d762SBarry Smith   jac->head = NULL;
122305b42c5fSBarry Smith   ierr = PetscFree2(jac->x,jac->y);CHKERRQ(ierr);
1224574deadeSBarry Smith   if (jac->mat && jac->mat != jac->pmat) {
1225574deadeSBarry Smith     ierr = MatDestroyMatrices(jac->nsplits,&jac->mat);CHKERRQ(ierr);
1226574deadeSBarry Smith   } else if (jac->mat) {
12270298fd71SBarry Smith     jac->mat = NULL;
1228574deadeSBarry Smith   }
122997bbdb24SBarry Smith   if (jac->pmat) {ierr = MatDestroyMatrices(jac->nsplits,&jac->pmat);CHKERRQ(ierr);}
123068dd23aaSBarry Smith   if (jac->Afield) {ierr = MatDestroyMatrices(jac->nsplits,&jac->Afield);CHKERRQ(ierr);}
1231f5f0d762SBarry Smith   jac->nsplits = 0;
12326bf464f9SBarry Smith   ierr       = VecDestroy(&jac->w1);CHKERRQ(ierr);
12336bf464f9SBarry Smith   ierr       = VecDestroy(&jac->w2);CHKERRQ(ierr);
12346bf464f9SBarry Smith   ierr       = MatDestroy(&jac->schur);CHKERRQ(ierr);
1235a7476a74SDmitry Karpeev   ierr       = MatDestroy(&jac->schurp);CHKERRQ(ierr);
12366bf464f9SBarry Smith   ierr       = MatDestroy(&jac->schur_user);CHKERRQ(ierr);
12376bf464f9SBarry Smith   ierr       = KSPDestroy(&jac->kspschur);CHKERRQ(ierr);
1238d78dad28SBarry Smith   ierr       = KSPDestroy(&jac->kspupper);CHKERRQ(ierr);
12396bf464f9SBarry Smith   ierr       = MatDestroy(&jac->B);CHKERRQ(ierr);
12406bf464f9SBarry Smith   ierr       = MatDestroy(&jac->C);CHKERRQ(ierr);
12416dbb499eSCian Wilson   jac->isrestrict = PETSC_FALSE;
1242574deadeSBarry Smith   PetscFunctionReturn(0);
1243574deadeSBarry Smith }
1244574deadeSBarry Smith 
1245574deadeSBarry Smith static PetscErrorCode PCDestroy_FieldSplit(PC pc)
1246574deadeSBarry Smith {
1247574deadeSBarry Smith   PetscErrorCode    ierr;
1248574deadeSBarry Smith 
1249574deadeSBarry Smith   PetscFunctionBegin;
1250574deadeSBarry Smith   ierr = PCReset_FieldSplit(pc);CHKERRQ(ierr);
1251c31cb41cSBarry Smith   ierr = PetscFree(pc->data);CHKERRQ(ierr);
1252bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitGetSubKSP_C",NULL);CHKERRQ(ierr);
1253bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetFields_C",NULL);CHKERRQ(ierr);
1254bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetIS_C",NULL);CHKERRQ(ierr);
1255bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetType_C",NULL);CHKERRQ(ierr);
1256bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetBlockSize_C",NULL);CHKERRQ(ierr);
125729f8a81cSJed Brown   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetSchurPre_C",NULL);CHKERRQ(ierr);
125837a82bf0SJed Brown   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitGetSchurPre_C",NULL);CHKERRQ(ierr);
1259bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetSchurFactType_C",NULL);CHKERRQ(ierr);
12606dbb499eSCian Wilson   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitRestrictIS_C",NULL);CHKERRQ(ierr);
12610971522cSBarry Smith   PetscFunctionReturn(0);
12620971522cSBarry Smith }
12630971522cSBarry Smith 
12644416b707SBarry Smith static PetscErrorCode PCSetFromOptions_FieldSplit(PetscOptionItems *PetscOptionsObject,PC pc)
12650971522cSBarry Smith {
12661b9fc7fcSBarry Smith   PetscErrorCode  ierr;
12676c924f48SJed Brown   PetscInt        bs;
12687b752e3dSPatrick Sanan   PetscBool       flg;
12699dcbbd2bSBarry Smith   PC_FieldSplit   *jac = (PC_FieldSplit*)pc->data;
12703b224e63SBarry Smith   PCCompositeType ctype;
12711b9fc7fcSBarry Smith 
12720971522cSBarry Smith   PetscFunctionBegin;
1273e55864a3SBarry Smith   ierr = PetscOptionsHead(PetscOptionsObject,"FieldSplit options");CHKERRQ(ierr);
12744ab8060aSDmitry Karpeev   ierr = PetscOptionsBool("-pc_fieldsplit_dm_splits","Whether to use DMCreateFieldDecomposition() for splits","PCFieldSplitSetDMSplits",jac->dm_splits,&jac->dm_splits,NULL);CHKERRQ(ierr);
127551f519a2SBarry Smith   ierr = PetscOptionsInt("-pc_fieldsplit_block_size","Blocksize that defines number of fields","PCFieldSplitSetBlockSize",jac->bs,&bs,&flg);CHKERRQ(ierr);
127651f519a2SBarry Smith   if (flg) {
127751f519a2SBarry Smith     ierr = PCFieldSplitSetBlockSize(pc,bs);CHKERRQ(ierr);
127851f519a2SBarry Smith   }
12792686e3e9SMatthew G. Knepley   jac->diag_use_amat = pc->useAmat;
12802686e3e9SMatthew 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);
12812686e3e9SMatthew G. Knepley   jac->offdiag_use_amat = pc->useAmat;
12822686e3e9SMatthew 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);
12837b752e3dSPatrick 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);
12847b752e3dSPatrick Sanan   ierr = PCFieldSplitSetDetectSaddlePoint(pc,jac->detect);CHKERRQ(ierr); /* Sets split type and Schur PC type */
12853b224e63SBarry Smith   ierr = PetscOptionsEnum("-pc_fieldsplit_type","Type of composition","PCFieldSplitSetType",PCCompositeTypes,(PetscEnum)jac->type,(PetscEnum*)&ctype,&flg);CHKERRQ(ierr);
12863b224e63SBarry Smith   if (flg) {
12873b224e63SBarry Smith     ierr = PCFieldSplitSetType(pc,ctype);CHKERRQ(ierr);
12883b224e63SBarry Smith   }
1289c30613efSMatthew Knepley   /* Only setup fields once */
1290c30613efSMatthew Knepley   if ((jac->bs > 0) && (jac->nsplits == 0)) {
1291d32f9abdSBarry Smith     /* only allow user to set fields from command line if bs is already known.
1292d32f9abdSBarry Smith        otherwise user can set them in PCFieldSplitSetDefaults() */
12936c924f48SJed Brown     ierr = PCFieldSplitSetRuntimeSplits_Private(pc);CHKERRQ(ierr);
12946c924f48SJed Brown     if (jac->splitdefined) {ierr = PetscInfo(pc,"Splits defined using the options database\n");CHKERRQ(ierr);}
1295d32f9abdSBarry Smith   }
1296c5d2311dSJed Brown   if (jac->type == PC_COMPOSITE_SCHUR) {
1297c5929fdfSBarry Smith     ierr = PetscOptionsGetEnum(((PetscObject)pc)->options,((PetscObject)pc)->prefix,"-pc_fieldsplit_schur_factorization_type",PCFieldSplitSchurFactTypes,(PetscEnum*)&jac->schurfactorization,&flg);CHKERRQ(ierr);
1298c9c6ffaaSJed Brown     if (flg) {ierr = PetscInfo(pc,"Deprecated use of -pc_fieldsplit_schur_factorization_type\n");CHKERRQ(ierr);}
12990298fd71SBarry 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);
130029f8a81cSJed 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);
1301c096484dSStefano Zampini     ierr = PetscOptionsScalar("-pc_fieldsplit_schur_scale","Scale Schur complement","PCFieldSplitSetSchurScale",jac->schurscale,&jac->schurscale,NULL);CHKERRQ(ierr);
1302c5d2311dSJed Brown   }
13031b9fc7fcSBarry Smith   ierr = PetscOptionsTail();CHKERRQ(ierr);
13040971522cSBarry Smith   PetscFunctionReturn(0);
13050971522cSBarry Smith }
13060971522cSBarry Smith 
13070971522cSBarry Smith /*------------------------------------------------------------------------------------*/
13080971522cSBarry Smith 
13091e6b0712SBarry Smith static PetscErrorCode  PCFieldSplitSetFields_FieldSplit(PC pc,const char splitname[],PetscInt n,const PetscInt *fields,const PetscInt *fields_col)
13100971522cSBarry Smith {
131197bbdb24SBarry Smith   PC_FieldSplit     *jac = (PC_FieldSplit*)pc->data;
13120971522cSBarry Smith   PetscErrorCode    ierr;
13135a9f2f41SSatish Balay   PC_FieldSplitLink ilink,next = jac->head;
131469a612a9SBarry Smith   char              prefix[128];
13155d4c12cdSJungho Lee   PetscInt          i;
13160971522cSBarry Smith 
13170971522cSBarry Smith   PetscFunctionBegin;
13186c924f48SJed Brown   if (jac->splitdefined) {
13196c924f48SJed Brown     ierr = PetscInfo1(pc,"Ignoring new split \"%s\" because the splits have already been defined\n",splitname);CHKERRQ(ierr);
13206c924f48SJed Brown     PetscFunctionReturn(0);
13216c924f48SJed Brown   }
132251f519a2SBarry Smith   for (i=0; i<n; i++) {
1323e32f2f54SBarry 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);
1324e32f2f54SBarry Smith     if (fields[i] < 0) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Negative field %D requested",fields[i]);
132551f519a2SBarry Smith   }
1326b00a9115SJed Brown   ierr = PetscNew(&ilink);CHKERRQ(ierr);
1327a04f6461SBarry Smith   if (splitname) {
1328db4c96c1SJed Brown     ierr = PetscStrallocpy(splitname,&ilink->splitname);CHKERRQ(ierr);
1329a04f6461SBarry Smith   } else {
1330785e854fSJed Brown     ierr = PetscMalloc1(3,&ilink->splitname);CHKERRQ(ierr);
1331a04f6461SBarry Smith     ierr = PetscSNPrintf(ilink->splitname,2,"%s",jac->nsplits);CHKERRQ(ierr);
1332a04f6461SBarry Smith   }
13339df09d43SBarry 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 */
1334785e854fSJed Brown   ierr = PetscMalloc1(n,&ilink->fields);CHKERRQ(ierr);
13355a9f2f41SSatish Balay   ierr = PetscMemcpy(ilink->fields,fields,n*sizeof(PetscInt));CHKERRQ(ierr);
1336785e854fSJed Brown   ierr = PetscMalloc1(n,&ilink->fields_col);CHKERRQ(ierr);
13375d4c12cdSJungho Lee   ierr = PetscMemcpy(ilink->fields_col,fields_col,n*sizeof(PetscInt));CHKERRQ(ierr);
13382fa5cd67SKarl Rupp 
13395a9f2f41SSatish Balay   ilink->nfields = n;
13400298fd71SBarry Smith   ilink->next    = NULL;
1341ce94432eSBarry Smith   ierr           = KSPCreate(PetscObjectComm((PetscObject)pc),&ilink->ksp);CHKERRQ(ierr);
1342422a814eSBarry Smith   ierr           = KSPSetErrorIfNotConverged(ilink->ksp,pc->erroriffailure);CHKERRQ(ierr);
134320252d06SBarry Smith   ierr           = PetscObjectIncrementTabLevel((PetscObject)ilink->ksp,(PetscObject)pc,1);CHKERRQ(ierr);
13445a9f2f41SSatish Balay   ierr           = KSPSetType(ilink->ksp,KSPPREONLY);CHKERRQ(ierr);
13459005cf84SBarry Smith   ierr           = PetscLogObjectParent((PetscObject)pc,(PetscObject)ilink->ksp);CHKERRQ(ierr);
134669a612a9SBarry Smith 
13478caf3d72SBarry Smith   ierr = PetscSNPrintf(prefix,sizeof(prefix),"%sfieldsplit_%s_",((PetscObject)pc)->prefix ? ((PetscObject)pc)->prefix : "",ilink->splitname);CHKERRQ(ierr);
13485a9f2f41SSatish Balay   ierr = KSPSetOptionsPrefix(ilink->ksp,prefix);CHKERRQ(ierr);
13490971522cSBarry Smith 
13500971522cSBarry Smith   if (!next) {
13515a9f2f41SSatish Balay     jac->head       = ilink;
13520298fd71SBarry Smith     ilink->previous = NULL;
13530971522cSBarry Smith   } else {
13540971522cSBarry Smith     while (next->next) {
13550971522cSBarry Smith       next = next->next;
13560971522cSBarry Smith     }
13575a9f2f41SSatish Balay     next->next      = ilink;
135851f519a2SBarry Smith     ilink->previous = next;
13590971522cSBarry Smith   }
13600971522cSBarry Smith   jac->nsplits++;
13610971522cSBarry Smith   PetscFunctionReturn(0);
13620971522cSBarry Smith }
13630971522cSBarry Smith 
13641e6b0712SBarry Smith static PetscErrorCode  PCFieldSplitGetSubKSP_FieldSplit_Schur(PC pc,PetscInt *n,KSP **subksp)
1365e69d4d44SBarry Smith {
1366e69d4d44SBarry Smith   PC_FieldSplit  *jac = (PC_FieldSplit*)pc->data;
1367e69d4d44SBarry Smith   PetscErrorCode ierr;
1368e69d4d44SBarry Smith 
1369e69d4d44SBarry Smith   PetscFunctionBegin;
137034a3b412SBarry Smith   if (!jac->schur) SETERRQ(PetscObjectComm((PetscObject)pc),PETSC_ERR_ARG_WRONGSTATE,"Must call KSPSetUp() or PCSetUp() before calling PCFieldSplitGetSubKSP()");
1371785e854fSJed Brown   ierr = PetscMalloc1(jac->nsplits,subksp);CHKERRQ(ierr);
1372e69d4d44SBarry Smith   ierr = MatSchurComplementGetKSP(jac->schur,*subksp);CHKERRQ(ierr);
13732fa5cd67SKarl Rupp 
1374e69d4d44SBarry Smith   (*subksp)[1] = jac->kspschur;
137513e0d083SBarry Smith   if (n) *n = jac->nsplits;
1376e69d4d44SBarry Smith   PetscFunctionReturn(0);
1377e69d4d44SBarry Smith }
13780971522cSBarry Smith 
13791e6b0712SBarry Smith static PetscErrorCode  PCFieldSplitGetSubKSP_FieldSplit(PC pc,PetscInt *n,KSP **subksp)
13800971522cSBarry Smith {
13810971522cSBarry Smith   PC_FieldSplit     *jac = (PC_FieldSplit*)pc->data;
13820971522cSBarry Smith   PetscErrorCode    ierr;
13830971522cSBarry Smith   PetscInt          cnt   = 0;
13845a9f2f41SSatish Balay   PC_FieldSplitLink ilink = jac->head;
13850971522cSBarry Smith 
13860971522cSBarry Smith   PetscFunctionBegin;
1387785e854fSJed Brown   ierr = PetscMalloc1(jac->nsplits,subksp);CHKERRQ(ierr);
13885a9f2f41SSatish Balay   while (ilink) {
13895a9f2f41SSatish Balay     (*subksp)[cnt++] = ilink->ksp;
13905a9f2f41SSatish Balay     ilink            = ilink->next;
13910971522cSBarry Smith   }
13925d480477SMatthew 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);
139313e0d083SBarry Smith   if (n) *n = jac->nsplits;
13940971522cSBarry Smith   PetscFunctionReturn(0);
13950971522cSBarry Smith }
13960971522cSBarry Smith 
13976dbb499eSCian Wilson /*@C
13986dbb499eSCian Wilson     PCFieldSplitRestrictIS - Restricts the fieldsplit ISs to be within a given IS.
13996dbb499eSCian Wilson 
14006dbb499eSCian Wilson     Input Parameters:
14016dbb499eSCian Wilson +   pc  - the preconditioner context
14026dbb499eSCian Wilson +   is - the index set that defines the indices to which the fieldsplit is to be restricted
14036dbb499eSCian Wilson 
14046dbb499eSCian Wilson     Level: advanced
14056dbb499eSCian Wilson 
14066dbb499eSCian Wilson @*/
14076dbb499eSCian Wilson PetscErrorCode  PCFieldSplitRestrictIS(PC pc,IS isy)
14086dbb499eSCian Wilson {
14096dbb499eSCian Wilson   PetscErrorCode ierr;
14106dbb499eSCian Wilson 
14116dbb499eSCian Wilson   PetscFunctionBegin;
14126dbb499eSCian Wilson   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
14136dbb499eSCian Wilson   PetscValidHeaderSpecific(isy,IS_CLASSID,2);
14140246f55cSBarry Smith   ierr = PetscTryMethod(pc,"PCFieldSplitRestrictIS_C",(PC,IS),(pc,isy));CHKERRQ(ierr);
14156dbb499eSCian Wilson   PetscFunctionReturn(0);
14166dbb499eSCian Wilson }
14176dbb499eSCian Wilson 
14186dbb499eSCian Wilson 
14196dbb499eSCian Wilson static PetscErrorCode  PCFieldSplitRestrictIS_FieldSplit(PC pc, IS isy)
14206dbb499eSCian Wilson {
14216dbb499eSCian Wilson   PC_FieldSplit     *jac = (PC_FieldSplit*)pc->data;
14226dbb499eSCian Wilson   PetscErrorCode    ierr;
14236dbb499eSCian Wilson   PC_FieldSplitLink ilink = jac->head, next;
14246dbb499eSCian Wilson   PetscInt          localsize,size,sizez,i;
14256dbb499eSCian Wilson   const PetscInt    *ind, *indz;
14266dbb499eSCian Wilson   PetscInt          *indc, *indcz;
14276dbb499eSCian Wilson   PetscBool         flg;
14286dbb499eSCian Wilson 
14296dbb499eSCian Wilson   PetscFunctionBegin;
14306dbb499eSCian Wilson   ierr = ISGetLocalSize(isy,&localsize);CHKERRQ(ierr);
14316dbb499eSCian Wilson   ierr = MPI_Scan(&localsize,&size,1,MPIU_INT,MPI_SUM,PetscObjectComm((PetscObject)isy));CHKERRQ(ierr);
14326dbb499eSCian Wilson   size -= localsize;
14336dbb499eSCian Wilson   while(ilink) {
14346dbb499eSCian Wilson     IS isrl,isr;
14351c7cfba8SBarry Smith     PC subpc;
14366dbb499eSCian Wilson     ierr          = ISEmbed(ilink->is, isy, PETSC_TRUE, &isrl);CHKERRQ(ierr);
14376dbb499eSCian Wilson     ierr          = ISGetLocalSize(isrl,&localsize);CHKERRQ(ierr);
14386dbb499eSCian Wilson     ierr          = PetscMalloc1(localsize,&indc);CHKERRQ(ierr);
14396dbb499eSCian Wilson     ierr          = ISGetIndices(isrl,&ind);CHKERRQ(ierr);
14406dbb499eSCian Wilson     ierr          = PetscMemcpy(indc,ind,localsize*sizeof(PetscInt));CHKERRQ(ierr);
14416dbb499eSCian Wilson     ierr          = ISRestoreIndices(isrl,&ind);CHKERRQ(ierr);
14426dbb499eSCian Wilson     ierr          = ISDestroy(&isrl);CHKERRQ(ierr);
14436dbb499eSCian Wilson     for (i=0; i<localsize; i++) *(indc+i) += size;
14446dbb499eSCian Wilson     ierr          = ISCreateGeneral(PetscObjectComm((PetscObject)isy),localsize,indc,PETSC_OWN_POINTER,&isr);CHKERRQ(ierr);
14456dbb499eSCian Wilson     ierr          = PetscObjectReference((PetscObject)isr);CHKERRQ(ierr);
14466dbb499eSCian Wilson     ierr          = ISDestroy(&ilink->is);CHKERRQ(ierr);
14476dbb499eSCian Wilson     ilink->is     = isr;
14486dbb499eSCian Wilson     ierr          = PetscObjectReference((PetscObject)isr);CHKERRQ(ierr);
14496dbb499eSCian Wilson     ierr          = ISDestroy(&ilink->is_col);CHKERRQ(ierr);
14506dbb499eSCian Wilson     ilink->is_col = isr;
14516dbb499eSCian Wilson     ierr          = ISDestroy(&isr);CHKERRQ(ierr);
14526dbb499eSCian Wilson     ierr          = KSPGetPC(ilink->ksp, &subpc);CHKERRQ(ierr);
14536dbb499eSCian Wilson     ierr          = PetscObjectTypeCompare((PetscObject)subpc,PCFIELDSPLIT,&flg);CHKERRQ(ierr);
14546dbb499eSCian Wilson     if(flg) {
14556dbb499eSCian Wilson       IS iszl,isz;
14566dbb499eSCian Wilson       MPI_Comm comm;
14576dbb499eSCian Wilson       ierr   = ISGetLocalSize(ilink->is,&localsize);CHKERRQ(ierr);
14586dbb499eSCian Wilson       comm   = PetscObjectComm((PetscObject)ilink->is);
14596dbb499eSCian Wilson       ierr   = ISEmbed(isy, ilink->is, PETSC_TRUE, &iszl);CHKERRQ(ierr);
14606dbb499eSCian Wilson       ierr   = MPI_Scan(&localsize,&sizez,1,MPIU_INT,MPI_SUM,comm);CHKERRQ(ierr);
14616dbb499eSCian Wilson       sizez -= localsize;
14626dbb499eSCian Wilson       ierr   = ISGetLocalSize(iszl,&localsize);CHKERRQ(ierr);
14636dbb499eSCian Wilson       ierr   = PetscMalloc1(localsize,&indcz);CHKERRQ(ierr);
14646dbb499eSCian Wilson       ierr   = ISGetIndices(iszl,&indz);CHKERRQ(ierr);
14656dbb499eSCian Wilson       ierr   = PetscMemcpy(indcz,indz,localsize*sizeof(PetscInt));CHKERRQ(ierr);
14666dbb499eSCian Wilson       ierr   = ISRestoreIndices(iszl,&indz);CHKERRQ(ierr);
14676dbb499eSCian Wilson       ierr   = ISDestroy(&iszl);CHKERRQ(ierr);
14686dbb499eSCian Wilson       for (i=0; i<localsize; i++) *(indcz+i) += sizez;
14696dbb499eSCian Wilson       ierr   = ISCreateGeneral(comm,localsize,indcz,PETSC_OWN_POINTER,&isz);CHKERRQ(ierr);
14706dbb499eSCian Wilson       ierr   = PCFieldSplitRestrictIS(subpc,isz);CHKERRQ(ierr);
14716dbb499eSCian Wilson       ierr   = ISDestroy(&isz);CHKERRQ(ierr);
14726dbb499eSCian Wilson     }
14736dbb499eSCian Wilson     next = ilink->next;
14746dbb499eSCian Wilson     ilink = next;
14756dbb499eSCian Wilson   }
14766dbb499eSCian Wilson   jac->isrestrict = PETSC_TRUE;
14776dbb499eSCian Wilson   PetscFunctionReturn(0);
14786dbb499eSCian Wilson }
14796dbb499eSCian Wilson 
14801e6b0712SBarry Smith static PetscErrorCode  PCFieldSplitSetIS_FieldSplit(PC pc,const char splitname[],IS is)
1481704ba839SBarry Smith {
1482704ba839SBarry Smith   PC_FieldSplit     *jac = (PC_FieldSplit*)pc->data;
1483704ba839SBarry Smith   PetscErrorCode    ierr;
1484704ba839SBarry Smith   PC_FieldSplitLink ilink, next = jac->head;
1485704ba839SBarry Smith   char              prefix[128];
1486704ba839SBarry Smith 
1487704ba839SBarry Smith   PetscFunctionBegin;
14886c924f48SJed Brown   if (jac->splitdefined) {
14896c924f48SJed Brown     ierr = PetscInfo1(pc,"Ignoring new split \"%s\" because the splits have already been defined\n",splitname);CHKERRQ(ierr);
14906c924f48SJed Brown     PetscFunctionReturn(0);
14916c924f48SJed Brown   }
1492b00a9115SJed Brown   ierr = PetscNew(&ilink);CHKERRQ(ierr);
1493a04f6461SBarry Smith   if (splitname) {
1494db4c96c1SJed Brown     ierr = PetscStrallocpy(splitname,&ilink->splitname);CHKERRQ(ierr);
1495a04f6461SBarry Smith   } else {
1496785e854fSJed Brown     ierr = PetscMalloc1(8,&ilink->splitname);CHKERRQ(ierr);
1497b5787286SJed Brown     ierr = PetscSNPrintf(ilink->splitname,7,"%D",jac->nsplits);CHKERRQ(ierr);
1498a04f6461SBarry Smith   }
14999df09d43SBarry 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 */
15001ab39975SBarry Smith   ierr          = PetscObjectReference((PetscObject)is);CHKERRQ(ierr);
1501b5787286SJed Brown   ierr          = ISDestroy(&ilink->is);CHKERRQ(ierr);
1502b5787286SJed Brown   ilink->is     = is;
1503b5787286SJed Brown   ierr          = PetscObjectReference((PetscObject)is);CHKERRQ(ierr);
1504b5787286SJed Brown   ierr          = ISDestroy(&ilink->is_col);CHKERRQ(ierr);
1505b5787286SJed Brown   ilink->is_col = is;
15060298fd71SBarry Smith   ilink->next   = NULL;
1507ce94432eSBarry Smith   ierr          = KSPCreate(PetscObjectComm((PetscObject)pc),&ilink->ksp);CHKERRQ(ierr);
1508422a814eSBarry Smith   ierr          = KSPSetErrorIfNotConverged(ilink->ksp,pc->erroriffailure);CHKERRQ(ierr);
150920252d06SBarry Smith   ierr          = PetscObjectIncrementTabLevel((PetscObject)ilink->ksp,(PetscObject)pc,1);CHKERRQ(ierr);
1510704ba839SBarry Smith   ierr          = KSPSetType(ilink->ksp,KSPPREONLY);CHKERRQ(ierr);
15119005cf84SBarry Smith   ierr          = PetscLogObjectParent((PetscObject)pc,(PetscObject)ilink->ksp);CHKERRQ(ierr);
1512704ba839SBarry Smith 
15138caf3d72SBarry Smith   ierr = PetscSNPrintf(prefix,sizeof(prefix),"%sfieldsplit_%s_",((PetscObject)pc)->prefix ? ((PetscObject)pc)->prefix : "",ilink->splitname);CHKERRQ(ierr);
1514704ba839SBarry Smith   ierr = KSPSetOptionsPrefix(ilink->ksp,prefix);CHKERRQ(ierr);
1515704ba839SBarry Smith 
1516704ba839SBarry Smith   if (!next) {
1517704ba839SBarry Smith     jac->head       = ilink;
15180298fd71SBarry Smith     ilink->previous = NULL;
1519704ba839SBarry Smith   } else {
1520704ba839SBarry Smith     while (next->next) {
1521704ba839SBarry Smith       next = next->next;
1522704ba839SBarry Smith     }
1523704ba839SBarry Smith     next->next      = ilink;
1524704ba839SBarry Smith     ilink->previous = next;
1525704ba839SBarry Smith   }
1526704ba839SBarry Smith   jac->nsplits++;
1527704ba839SBarry Smith   PetscFunctionReturn(0);
1528704ba839SBarry Smith }
1529704ba839SBarry Smith 
153094ef8ddeSSatish Balay /*@C
15310971522cSBarry Smith     PCFieldSplitSetFields - Sets the fields for one particular split in the field split preconditioner
15320971522cSBarry Smith 
1533ad4df100SBarry Smith     Logically Collective on PC
15340971522cSBarry Smith 
15350971522cSBarry Smith     Input Parameters:
15360971522cSBarry Smith +   pc  - the preconditioner context
15370298fd71SBarry Smith .   splitname - name of this split, if NULL the number of the split is used
15380971522cSBarry Smith .   n - the number of fields in this split
1539db4c96c1SJed Brown -   fields - the fields in this split
15400971522cSBarry Smith 
15410971522cSBarry Smith     Level: intermediate
15420971522cSBarry Smith 
154395452b02SPatrick Sanan     Notes:
154495452b02SPatrick Sanan     Use PCFieldSplitSetIS() to set a completely general set of indices as a field.
1545d32f9abdSBarry Smith 
15467287d2a3SDmitry Karpeev      The PCFieldSplitSetFields() is for defining fields as strided blocks. For example, if the block
1547d32f9abdSBarry 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
1548d32f9abdSBarry Smith      0xx3xx6xx9xx12 ... x1xx4xx7xx ... xx2xx5xx8xx.. 01x34x67x... 0x1x3x5x7.. x12x45x78x....
1549d32f9abdSBarry Smith      where the numbered entries indicate what is in the field.
1550d32f9abdSBarry Smith 
1551db4c96c1SJed Brown      This function is called once per split (it creates a new split each time).  Solve options
1552db4c96c1SJed Brown      for this split will be available under the prefix -fieldsplit_SPLITNAME_.
1553db4c96c1SJed Brown 
15545d4c12cdSJungho Lee      Developer Note: This routine does not actually create the IS representing the split, that is delayed
15555d4c12cdSJungho Lee      until PCSetUp_FieldSplit(), because information about the vector/matrix layouts may not be
15565d4c12cdSJungho Lee      available when this routine is called.
15575d4c12cdSJungho Lee 
1558d32f9abdSBarry Smith .seealso: PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitSetBlockSize(), PCFieldSplitSetIS()
15590971522cSBarry Smith 
15600971522cSBarry Smith @*/
15615d4c12cdSJungho Lee PetscErrorCode  PCFieldSplitSetFields(PC pc,const char splitname[],PetscInt n,const PetscInt *fields,const PetscInt *fields_col)
15620971522cSBarry Smith {
15634ac538c5SBarry Smith   PetscErrorCode ierr;
15640971522cSBarry Smith 
15650971522cSBarry Smith   PetscFunctionBegin;
15660700a824SBarry Smith   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
1567db4c96c1SJed Brown   PetscValidCharPointer(splitname,2);
1568ce94432eSBarry Smith   if (n < 1) SETERRQ2(PetscObjectComm((PetscObject)pc),PETSC_ERR_ARG_OUTOFRANGE,"Provided number of fields %D in split \"%s\" not positive",n,splitname);
1569db4c96c1SJed Brown   PetscValidIntPointer(fields,3);
15700246f55cSBarry Smith   ierr = PetscTryMethod(pc,"PCFieldSplitSetFields_C",(PC,const char[],PetscInt,const PetscInt*,const PetscInt*),(pc,splitname,n,fields,fields_col));CHKERRQ(ierr);
15710971522cSBarry Smith   PetscFunctionReturn(0);
15720971522cSBarry Smith }
15730971522cSBarry Smith 
1574c84da90fSDmitry Karpeev /*@
1575c84da90fSDmitry Karpeev     PCFieldSplitSetDiagUseAmat - set flag indicating whether to extract diagonal blocks from Amat (rather than Pmat)
1576c84da90fSDmitry Karpeev 
1577c84da90fSDmitry Karpeev     Logically Collective on PC
1578c84da90fSDmitry Karpeev 
1579c84da90fSDmitry Karpeev     Input Parameters:
1580c84da90fSDmitry Karpeev +   pc  - the preconditioner object
1581c84da90fSDmitry Karpeev -   flg - boolean flag indicating whether or not to use Amat to extract the diagonal blocks from
1582c84da90fSDmitry Karpeev 
15839506b623SDmitry Karpeev     Options Database:
15849506b623SDmitry Karpeev .     -pc_fieldsplit_diag_use_amat
1585c84da90fSDmitry Karpeev 
1586c84da90fSDmitry Karpeev     Level: intermediate
1587c84da90fSDmitry Karpeev 
1588c84da90fSDmitry Karpeev .seealso: PCFieldSplitGetDiagUseAmat(), PCFieldSplitSetOffDiagUseAmat(), PCFIELDSPLIT
1589c84da90fSDmitry Karpeev 
1590c84da90fSDmitry Karpeev @*/
1591c84da90fSDmitry Karpeev PetscErrorCode  PCFieldSplitSetDiagUseAmat(PC pc,PetscBool flg)
1592c84da90fSDmitry Karpeev {
1593c84da90fSDmitry Karpeev   PC_FieldSplit  *jac = (PC_FieldSplit*)pc->data;
1594c84da90fSDmitry Karpeev   PetscBool      isfs;
1595c84da90fSDmitry Karpeev   PetscErrorCode ierr;
1596c84da90fSDmitry Karpeev 
1597c84da90fSDmitry Karpeev   PetscFunctionBegin;
1598c84da90fSDmitry Karpeev   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
1599c84da90fSDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)pc,PCFIELDSPLIT,&isfs);CHKERRQ(ierr);
1600c84da90fSDmitry Karpeev   if (!isfs) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"PC not of type %s",PCFIELDSPLIT);
1601c84da90fSDmitry Karpeev   jac->diag_use_amat = flg;
1602c84da90fSDmitry Karpeev   PetscFunctionReturn(0);
1603c84da90fSDmitry Karpeev }
1604c84da90fSDmitry Karpeev 
1605c84da90fSDmitry Karpeev /*@
1606c84da90fSDmitry Karpeev     PCFieldSplitGetDiagUseAmat - get the flag indicating whether to extract diagonal blocks from Amat (rather than Pmat)
1607c84da90fSDmitry Karpeev 
1608c84da90fSDmitry Karpeev     Logically Collective on PC
1609c84da90fSDmitry Karpeev 
1610c84da90fSDmitry Karpeev     Input Parameters:
1611c84da90fSDmitry Karpeev .   pc  - the preconditioner object
1612c84da90fSDmitry Karpeev 
1613c84da90fSDmitry Karpeev     Output Parameters:
1614c84da90fSDmitry Karpeev .   flg - boolean flag indicating whether or not to use Amat to extract the diagonal blocks from
1615c84da90fSDmitry Karpeev 
1616c84da90fSDmitry Karpeev 
1617c84da90fSDmitry Karpeev     Level: intermediate
1618c84da90fSDmitry Karpeev 
1619c84da90fSDmitry Karpeev .seealso: PCFieldSplitSetDiagUseAmat(), PCFieldSplitGetOffDiagUseAmat(), PCFIELDSPLIT
1620c84da90fSDmitry Karpeev 
1621c84da90fSDmitry Karpeev @*/
1622c84da90fSDmitry Karpeev PetscErrorCode  PCFieldSplitGetDiagUseAmat(PC pc,PetscBool *flg)
1623c84da90fSDmitry Karpeev {
1624c84da90fSDmitry Karpeev   PC_FieldSplit  *jac = (PC_FieldSplit*)pc->data;
1625c84da90fSDmitry Karpeev   PetscBool      isfs;
1626c84da90fSDmitry Karpeev   PetscErrorCode ierr;
1627c84da90fSDmitry Karpeev 
1628c84da90fSDmitry Karpeev   PetscFunctionBegin;
1629c84da90fSDmitry Karpeev   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
1630c84da90fSDmitry Karpeev   PetscValidPointer(flg,2);
1631c84da90fSDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)pc,PCFIELDSPLIT,&isfs);CHKERRQ(ierr);
1632c84da90fSDmitry Karpeev   if (!isfs) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"PC not of type %s",PCFIELDSPLIT);
1633c84da90fSDmitry Karpeev   *flg = jac->diag_use_amat;
1634c84da90fSDmitry Karpeev   PetscFunctionReturn(0);
1635c84da90fSDmitry Karpeev }
1636c84da90fSDmitry Karpeev 
1637c84da90fSDmitry Karpeev /*@
1638c84da90fSDmitry Karpeev     PCFieldSplitSetOffDiagUseAmat - set flag indicating whether to extract off-diagonal blocks from Amat (rather than Pmat)
1639c84da90fSDmitry Karpeev 
1640c84da90fSDmitry Karpeev     Logically Collective on PC
1641c84da90fSDmitry Karpeev 
1642c84da90fSDmitry Karpeev     Input Parameters:
1643c84da90fSDmitry Karpeev +   pc  - the preconditioner object
1644c84da90fSDmitry Karpeev -   flg - boolean flag indicating whether or not to use Amat to extract the off-diagonal blocks from
1645c84da90fSDmitry Karpeev 
16469506b623SDmitry Karpeev     Options Database:
16479506b623SDmitry Karpeev .     -pc_fieldsplit_off_diag_use_amat
1648c84da90fSDmitry Karpeev 
1649c84da90fSDmitry Karpeev     Level: intermediate
1650c84da90fSDmitry Karpeev 
1651c84da90fSDmitry Karpeev .seealso: PCFieldSplitGetOffDiagUseAmat(), PCFieldSplitSetDiagUseAmat(), PCFIELDSPLIT
1652c84da90fSDmitry Karpeev 
1653c84da90fSDmitry Karpeev @*/
1654c84da90fSDmitry Karpeev PetscErrorCode  PCFieldSplitSetOffDiagUseAmat(PC pc,PetscBool flg)
1655c84da90fSDmitry Karpeev {
1656c84da90fSDmitry Karpeev   PC_FieldSplit *jac = (PC_FieldSplit*)pc->data;
1657c84da90fSDmitry Karpeev   PetscBool      isfs;
1658c84da90fSDmitry Karpeev   PetscErrorCode ierr;
1659c84da90fSDmitry Karpeev 
1660c84da90fSDmitry Karpeev   PetscFunctionBegin;
1661c84da90fSDmitry Karpeev   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
1662c84da90fSDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)pc,PCFIELDSPLIT,&isfs);CHKERRQ(ierr);
1663c84da90fSDmitry Karpeev   if (!isfs) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"PC not of type %s",PCFIELDSPLIT);
1664c84da90fSDmitry Karpeev   jac->offdiag_use_amat = flg;
1665c84da90fSDmitry Karpeev   PetscFunctionReturn(0);
1666c84da90fSDmitry Karpeev }
1667c84da90fSDmitry Karpeev 
1668c84da90fSDmitry Karpeev /*@
1669c84da90fSDmitry Karpeev     PCFieldSplitGetOffDiagUseAmat - get the flag indicating whether to extract off-diagonal blocks from Amat (rather than Pmat)
1670c84da90fSDmitry Karpeev 
1671c84da90fSDmitry Karpeev     Logically Collective on PC
1672c84da90fSDmitry Karpeev 
1673c84da90fSDmitry Karpeev     Input Parameters:
1674c84da90fSDmitry Karpeev .   pc  - the preconditioner object
1675c84da90fSDmitry Karpeev 
1676c84da90fSDmitry Karpeev     Output Parameters:
1677c84da90fSDmitry Karpeev .   flg - boolean flag indicating whether or not to use Amat to extract the off-diagonal blocks from
1678c84da90fSDmitry Karpeev 
1679c84da90fSDmitry Karpeev 
1680c84da90fSDmitry Karpeev     Level: intermediate
1681c84da90fSDmitry Karpeev 
1682c84da90fSDmitry Karpeev .seealso: PCFieldSplitSetOffDiagUseAmat(), PCFieldSplitGetDiagUseAmat(), PCFIELDSPLIT
1683c84da90fSDmitry Karpeev 
1684c84da90fSDmitry Karpeev @*/
1685c84da90fSDmitry Karpeev PetscErrorCode  PCFieldSplitGetOffDiagUseAmat(PC pc,PetscBool *flg)
1686c84da90fSDmitry Karpeev {
1687c84da90fSDmitry Karpeev   PC_FieldSplit  *jac = (PC_FieldSplit*)pc->data;
1688c84da90fSDmitry Karpeev   PetscBool      isfs;
1689c84da90fSDmitry Karpeev   PetscErrorCode ierr;
1690c84da90fSDmitry Karpeev 
1691c84da90fSDmitry Karpeev   PetscFunctionBegin;
1692c84da90fSDmitry Karpeev   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
1693c84da90fSDmitry Karpeev   PetscValidPointer(flg,2);
1694c84da90fSDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)pc,PCFIELDSPLIT,&isfs);CHKERRQ(ierr);
1695c84da90fSDmitry Karpeev   if (!isfs) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"PC not of type %s",PCFIELDSPLIT);
1696c84da90fSDmitry Karpeev   *flg = jac->offdiag_use_amat;
1697c84da90fSDmitry Karpeev   PetscFunctionReturn(0);
1698c84da90fSDmitry Karpeev }
1699c84da90fSDmitry Karpeev 
1700c84da90fSDmitry Karpeev 
1701c84da90fSDmitry Karpeev 
1702218d4943SBarry Smith /*@C
1703704ba839SBarry Smith     PCFieldSplitSetIS - Sets the exact elements for field
1704704ba839SBarry Smith 
1705ad4df100SBarry Smith     Logically Collective on PC
1706704ba839SBarry Smith 
1707704ba839SBarry Smith     Input Parameters:
1708704ba839SBarry Smith +   pc  - the preconditioner context
17090298fd71SBarry Smith .   splitname - name of this split, if NULL the number of the split is used
1710db4c96c1SJed Brown -   is - the index set that defines the vector elements in this field
1711704ba839SBarry Smith 
1712d32f9abdSBarry Smith 
1713a6ffb8dbSJed Brown     Notes:
1714a6ffb8dbSJed Brown     Use PCFieldSplitSetFields(), for fields defined by strided types.
1715a6ffb8dbSJed Brown 
1716db4c96c1SJed Brown     This function is called once per split (it creates a new split each time).  Solve options
1717db4c96c1SJed Brown     for this split will be available under the prefix -fieldsplit_SPLITNAME_.
1718d32f9abdSBarry Smith 
1719704ba839SBarry Smith     Level: intermediate
1720704ba839SBarry Smith 
1721704ba839SBarry Smith .seealso: PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitSetBlockSize()
1722704ba839SBarry Smith 
1723704ba839SBarry Smith @*/
17247087cfbeSBarry Smith PetscErrorCode  PCFieldSplitSetIS(PC pc,const char splitname[],IS is)
1725704ba839SBarry Smith {
17264ac538c5SBarry Smith   PetscErrorCode ierr;
1727704ba839SBarry Smith 
1728704ba839SBarry Smith   PetscFunctionBegin;
17290700a824SBarry Smith   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
17307b62db95SJungho Lee   if (splitname) PetscValidCharPointer(splitname,2);
1731db4c96c1SJed Brown   PetscValidHeaderSpecific(is,IS_CLASSID,3);
1732ccc738f7SBarry Smith   ierr = PetscTryMethod(pc,"PCFieldSplitSetIS_C",(PC,const char[],IS),(pc,splitname,is));CHKERRQ(ierr);
1733704ba839SBarry Smith   PetscFunctionReturn(0);
1734704ba839SBarry Smith }
1735704ba839SBarry Smith 
173694ef8ddeSSatish Balay /*@C
173757a9adfeSMatthew G Knepley     PCFieldSplitGetIS - Retrieves the elements for a field as an IS
173857a9adfeSMatthew G Knepley 
173957a9adfeSMatthew G Knepley     Logically Collective on PC
174057a9adfeSMatthew G Knepley 
174157a9adfeSMatthew G Knepley     Input Parameters:
174257a9adfeSMatthew G Knepley +   pc  - the preconditioner context
174357a9adfeSMatthew G Knepley -   splitname - name of this split
174457a9adfeSMatthew G Knepley 
174557a9adfeSMatthew G Knepley     Output Parameter:
17460298fd71SBarry Smith -   is - the index set that defines the vector elements in this field, or NULL if the field is not found
174757a9adfeSMatthew G Knepley 
174857a9adfeSMatthew G Knepley     Level: intermediate
174957a9adfeSMatthew G Knepley 
175057a9adfeSMatthew G Knepley .seealso: PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitSetIS()
175157a9adfeSMatthew G Knepley 
175257a9adfeSMatthew G Knepley @*/
175357a9adfeSMatthew G Knepley PetscErrorCode PCFieldSplitGetIS(PC pc,const char splitname[],IS *is)
175457a9adfeSMatthew G Knepley {
175557a9adfeSMatthew G Knepley   PetscErrorCode ierr;
175657a9adfeSMatthew G Knepley 
175757a9adfeSMatthew G Knepley   PetscFunctionBegin;
175857a9adfeSMatthew G Knepley   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
175957a9adfeSMatthew G Knepley   PetscValidCharPointer(splitname,2);
176057a9adfeSMatthew G Knepley   PetscValidPointer(is,3);
176157a9adfeSMatthew G Knepley   {
176257a9adfeSMatthew G Knepley     PC_FieldSplit     *jac  = (PC_FieldSplit*) pc->data;
176357a9adfeSMatthew G Knepley     PC_FieldSplitLink ilink = jac->head;
176457a9adfeSMatthew G Knepley     PetscBool         found;
176557a9adfeSMatthew G Knepley 
17660298fd71SBarry Smith     *is = NULL;
176757a9adfeSMatthew G Knepley     while (ilink) {
176857a9adfeSMatthew G Knepley       ierr = PetscStrcmp(ilink->splitname, splitname, &found);CHKERRQ(ierr);
176957a9adfeSMatthew G Knepley       if (found) {
177057a9adfeSMatthew G Knepley         *is = ilink->is;
177157a9adfeSMatthew G Knepley         break;
177257a9adfeSMatthew G Knepley       }
177357a9adfeSMatthew G Knepley       ilink = ilink->next;
177457a9adfeSMatthew G Knepley     }
177557a9adfeSMatthew G Knepley   }
177657a9adfeSMatthew G Knepley   PetscFunctionReturn(0);
177757a9adfeSMatthew G Knepley }
177857a9adfeSMatthew G Knepley 
177951f519a2SBarry Smith /*@
178051f519a2SBarry Smith     PCFieldSplitSetBlockSize - Sets the block size for defining where fields start in the
178151f519a2SBarry Smith       fieldsplit preconditioner. If not set the matrix block size is used.
178251f519a2SBarry Smith 
1783ad4df100SBarry Smith     Logically Collective on PC
178451f519a2SBarry Smith 
178551f519a2SBarry Smith     Input Parameters:
178651f519a2SBarry Smith +   pc  - the preconditioner context
178751f519a2SBarry Smith -   bs - the block size
178851f519a2SBarry Smith 
178951f519a2SBarry Smith     Level: intermediate
179051f519a2SBarry Smith 
179151f519a2SBarry Smith .seealso: PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitSetFields()
179251f519a2SBarry Smith 
179351f519a2SBarry Smith @*/
17947087cfbeSBarry Smith PetscErrorCode  PCFieldSplitSetBlockSize(PC pc,PetscInt bs)
179551f519a2SBarry Smith {
17964ac538c5SBarry Smith   PetscErrorCode ierr;
179751f519a2SBarry Smith 
179851f519a2SBarry Smith   PetscFunctionBegin;
17990700a824SBarry Smith   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
1800c5eb9154SBarry Smith   PetscValidLogicalCollectiveInt(pc,bs,2);
18014ac538c5SBarry Smith   ierr = PetscTryMethod(pc,"PCFieldSplitSetBlockSize_C",(PC,PetscInt),(pc,bs));CHKERRQ(ierr);
180251f519a2SBarry Smith   PetscFunctionReturn(0);
180351f519a2SBarry Smith }
180451f519a2SBarry Smith 
18050971522cSBarry Smith /*@C
180669a612a9SBarry Smith    PCFieldSplitGetSubKSP - Gets the KSP contexts for all splits
18070971522cSBarry Smith 
180869a612a9SBarry Smith    Collective on KSP
18090971522cSBarry Smith 
18100971522cSBarry Smith    Input Parameter:
18110971522cSBarry Smith .  pc - the preconditioner context
18120971522cSBarry Smith 
18130971522cSBarry Smith    Output Parameters:
181413e0d083SBarry Smith +  n - the number of splits
18153111de3cSBarry Smith -  subksp - the array of KSP contexts
18160971522cSBarry Smith 
18170971522cSBarry Smith    Note:
18189a4f7e47SBarry Smith    After PCFieldSplitGetSubKSP() the array of KSPs is to be freed by the user with PetscFree()
1819d32f9abdSBarry Smith    (not the KSP just the array that contains them).
18200971522cSBarry Smith 
182169a612a9SBarry Smith    You must call KSPSetUp() before calling PCFieldSplitGetSubKSP().
18220971522cSBarry Smith 
1823196cc216SBarry Smith    Fortran Usage: You must pass in a KSP array that is large enough to contain all the local KSPs.
18242bf68e3eSBarry Smith       You can call PCFieldSplitGetSubKSP(pc,n,PETSC_NULL_KSP,ierr) to determine how large the
1825196cc216SBarry Smith       KSP array must be.
1826196cc216SBarry Smith 
1827196cc216SBarry Smith 
18280971522cSBarry Smith    Level: advanced
18290971522cSBarry Smith 
18300971522cSBarry Smith .seealso: PCFIELDSPLIT
18310971522cSBarry Smith @*/
18327087cfbeSBarry Smith PetscErrorCode  PCFieldSplitGetSubKSP(PC pc,PetscInt *n,KSP *subksp[])
18330971522cSBarry Smith {
18344ac538c5SBarry Smith   PetscErrorCode ierr;
18350971522cSBarry Smith 
18360971522cSBarry Smith   PetscFunctionBegin;
18370700a824SBarry Smith   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
183813e0d083SBarry Smith   if (n) PetscValidIntPointer(n,2);
18394ac538c5SBarry Smith   ierr = PetscUseMethod(pc,"PCFieldSplitGetSubKSP_C",(PC,PetscInt*,KSP **),(pc,n,subksp));CHKERRQ(ierr);
18400971522cSBarry Smith   PetscFunctionReturn(0);
18410971522cSBarry Smith }
18420971522cSBarry Smith 
1843e69d4d44SBarry Smith /*@
184453f2277eSBarry Smith     PCFieldSplitSetSchurPre -  Indicates what operator is used to construct the preconditioner for the Schur complement.
1845a04f6461SBarry Smith       A11 matrix. Otherwise no preconditioner is used.
1846e69d4d44SBarry Smith 
1847e69d4d44SBarry Smith     Collective on PC
1848e69d4d44SBarry Smith 
1849e69d4d44SBarry Smith     Input Parameters:
1850e69d4d44SBarry Smith +   pc      - the preconditioner context
18516fdd48a9SBarry 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
18526fdd48a9SBarry Smith               PC_FIELDSPLIT_SCHUR_PRE_SELFP, and PC_FIELDSPLIT_SCHUR_PRE_FULL
18530298fd71SBarry Smith -   userpre - matrix to use for preconditioning, or NULL
1854084e4875SJed Brown 
1855e69d4d44SBarry Smith     Options Database:
18566fdd48a9SBarry Smith .     -pc_fieldsplit_schur_precondition <self,selfp,user,a11,full> - default is a11. See notes for meaning of various arguments
1857e69d4d44SBarry Smith 
1858fd1303e9SJungho Lee     Notes:
1859fd1303e9SJungho Lee $    If ptype is
1860a6a584a2SBarry Smith $        a11 then the preconditioner for the Schur complement is generated from the block diagonal part of the preconditioner
186153f2277eSBarry Smith $             matrix associated with the Schur complement (i.e. A11), not the Schur complement matrix
1862a6a584a2SBarry Smith $        self the preconditioner for the Schur complement is generated from the symbolic representation of the Schur complement matrix:
1863a6a584a2SBarry Smith $             The only preconditioner that currently works with this symbolic respresentation matrix object is the PCLSC
1864fd1303e9SJungho Lee $             preconditioner
18656fdd48a9SBarry Smith $        user then the preconditioner for the Schur complement is generated from the user provided matrix (pre argument
18666fdd48a9SBarry Smith $             to this function).
1867a6a584a2SBarry Smith $        selfp then the preconditioning for the Schur complement is generated from an explicitly-assembled approximation Sp = A11 - A10 inv(diag(A00)) A01
18681d71051fSDmitry Karpeev $             This is only a good preconditioner when diag(A00) is a good preconditioner for A00. Optionally, A00 can be
18696fdd48a9SBarry Smith $             lumped before extracting the diagonal using the additional option -fieldsplit_1_mat_schur_complement_ainv_type lump
18706fdd48a9SBarry 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)
18716fdd48a9SBarry Smith $             useful mostly as a test that the Schur complement approach can work for your problem
1872fd1303e9SJungho Lee 
1873e87fab1bSBarry Smith      When solving a saddle point problem, where the A11 block is identically zero, using a11 as the ptype only makes sense
1874fd1303e9SJungho Lee     with the additional option -fieldsplit_1_pc_type none. Usually for saddle point problems one would use a ptype of self and
1875a7476a74SDmitry Karpeev     -fieldsplit_1_pc_type lsc which uses the least squares commutator to compute a preconditioner for the Schur complement.
1876fd1303e9SJungho Lee 
1877e69d4d44SBarry Smith     Level: intermediate
1878e69d4d44SBarry Smith 
18791d71051fSDmitry Karpeev .seealso: PCFieldSplitGetSchurPre(), PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitSetFields(), PCFieldSplitSchurPreType,
18801d71051fSDmitry Karpeev           MatSchurComplementSetAinvType(), PCLSC
1881e69d4d44SBarry Smith 
1882e69d4d44SBarry Smith @*/
188329f8a81cSJed Brown PetscErrorCode PCFieldSplitSetSchurPre(PC pc,PCFieldSplitSchurPreType ptype,Mat pre)
1884e69d4d44SBarry Smith {
18854ac538c5SBarry Smith   PetscErrorCode ierr;
1886e69d4d44SBarry Smith 
1887e69d4d44SBarry Smith   PetscFunctionBegin;
18880700a824SBarry Smith   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
188929f8a81cSJed Brown   ierr = PetscTryMethod(pc,"PCFieldSplitSetSchurPre_C",(PC,PCFieldSplitSchurPreType,Mat),(pc,ptype,pre));CHKERRQ(ierr);
1890e69d4d44SBarry Smith   PetscFunctionReturn(0);
1891e69d4d44SBarry Smith }
189229f8a81cSJed Brown PetscErrorCode PCFieldSplitSchurPrecondition(PC pc,PCFieldSplitSchurPreType ptype,Mat pre) {return PCFieldSplitSetSchurPre(pc,ptype,pre);} /* Deprecated name */
1893e69d4d44SBarry Smith 
189437a82bf0SJed Brown /*@
189537a82bf0SJed Brown     PCFieldSplitGetSchurPre - For Schur complement fieldsplit, determine how the Schur complement will be
189629f8a81cSJed Brown     preconditioned.  See PCFieldSplitSetSchurPre() for details.
189737a82bf0SJed Brown 
189837a82bf0SJed Brown     Logically Collective on PC
189937a82bf0SJed Brown 
190037a82bf0SJed Brown     Input Parameters:
190137a82bf0SJed Brown .   pc      - the preconditioner context
190237a82bf0SJed Brown 
190337a82bf0SJed Brown     Output Parameters:
190437a82bf0SJed 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
190537a82bf0SJed Brown -   userpre - matrix to use for preconditioning (with PC_FIELDSPLIT_PRE_USER), or NULL
190637a82bf0SJed Brown 
190737a82bf0SJed Brown     Level: intermediate
190837a82bf0SJed Brown 
190929f8a81cSJed Brown .seealso: PCFieldSplitSetSchurPre(), PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitSetFields(), PCFieldSplitSchurPreType, PCLSC
191037a82bf0SJed Brown 
191137a82bf0SJed Brown @*/
191237a82bf0SJed Brown PetscErrorCode PCFieldSplitGetSchurPre(PC pc,PCFieldSplitSchurPreType *ptype,Mat *pre)
191337a82bf0SJed Brown {
191437a82bf0SJed Brown   PetscErrorCode ierr;
191537a82bf0SJed Brown 
191637a82bf0SJed Brown   PetscFunctionBegin;
191737a82bf0SJed Brown   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
191837a82bf0SJed Brown   ierr = PetscUseMethod(pc,"PCFieldSplitGetSchurPre_C",(PC,PCFieldSplitSchurPreType*,Mat*),(pc,ptype,pre));CHKERRQ(ierr);
1919e69d4d44SBarry Smith   PetscFunctionReturn(0);
1920e69d4d44SBarry Smith }
1921e69d4d44SBarry Smith 
192245e7fc46SDmitry Karpeev /*@
1923470b340bSDmitry Karpeev     PCFieldSplitSchurGetS -  extract the MatSchurComplement object used by this PC in case it needs to be configured separately
192445e7fc46SDmitry Karpeev 
192545e7fc46SDmitry Karpeev     Not collective
192645e7fc46SDmitry Karpeev 
192745e7fc46SDmitry Karpeev     Input Parameter:
192845e7fc46SDmitry Karpeev .   pc      - the preconditioner context
192945e7fc46SDmitry Karpeev 
193045e7fc46SDmitry Karpeev     Output Parameter:
1931470b340bSDmitry Karpeev .   S       - the Schur complement matrix
193245e7fc46SDmitry Karpeev 
1933470b340bSDmitry Karpeev     Notes:
1934470b340bSDmitry Karpeev     This matrix should not be destroyed using MatDestroy(); rather, use PCFieldSplitSchurRestoreS().
193545e7fc46SDmitry Karpeev 
193645e7fc46SDmitry Karpeev     Level: advanced
193745e7fc46SDmitry Karpeev 
193829f8a81cSJed Brown .seealso: PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitSchurPreType, PCFieldSplitSetSchurPre(), MatSchurComplement, PCFieldSplitSchurRestoreS()
193945e7fc46SDmitry Karpeev 
194045e7fc46SDmitry Karpeev @*/
1941470b340bSDmitry Karpeev PetscErrorCode  PCFieldSplitSchurGetS(PC pc,Mat *S)
194245e7fc46SDmitry Karpeev {
194345e7fc46SDmitry Karpeev   PetscErrorCode ierr;
194445e7fc46SDmitry Karpeev   const char*    t;
194545e7fc46SDmitry Karpeev   PetscBool      isfs;
194645e7fc46SDmitry Karpeev   PC_FieldSplit  *jac;
194745e7fc46SDmitry Karpeev 
194845e7fc46SDmitry Karpeev   PetscFunctionBegin;
194945e7fc46SDmitry Karpeev   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
195045e7fc46SDmitry Karpeev   ierr = PetscObjectGetType((PetscObject)pc,&t);CHKERRQ(ierr);
195145e7fc46SDmitry Karpeev   ierr = PetscStrcmp(t,PCFIELDSPLIT,&isfs);CHKERRQ(ierr);
195245e7fc46SDmitry Karpeev   if (!isfs) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Expected PC of type PCFIELDSPLIT, got %s instead",t);
195345e7fc46SDmitry Karpeev   jac = (PC_FieldSplit*)pc->data;
1954470b340bSDmitry 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);
1955470b340bSDmitry Karpeev   if (S) *S = jac->schur;
195645e7fc46SDmitry Karpeev   PetscFunctionReturn(0);
195745e7fc46SDmitry Karpeev }
195845e7fc46SDmitry Karpeev 
1959470b340bSDmitry Karpeev /*@
1960470b340bSDmitry Karpeev     PCFieldSplitSchurRestoreS -  restores the MatSchurComplement object used by this PC
1961470b340bSDmitry Karpeev 
1962470b340bSDmitry Karpeev     Not collective
1963470b340bSDmitry Karpeev 
1964470b340bSDmitry Karpeev     Input Parameters:
1965470b340bSDmitry Karpeev +   pc      - the preconditioner context
1966470b340bSDmitry Karpeev .   S       - the Schur complement matrix
1967470b340bSDmitry Karpeev 
1968470b340bSDmitry Karpeev     Level: advanced
1969470b340bSDmitry Karpeev 
197029f8a81cSJed Brown .seealso: PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitSchurPreType, PCFieldSplitSetSchurPre(), MatSchurComplement, PCFieldSplitSchurGetS()
1971470b340bSDmitry Karpeev 
1972470b340bSDmitry Karpeev @*/
1973bca69d2bSDmitry Karpeev PetscErrorCode  PCFieldSplitSchurRestoreS(PC pc,Mat *S)
1974470b340bSDmitry Karpeev {
1975470b340bSDmitry Karpeev   PetscErrorCode ierr;
1976470b340bSDmitry Karpeev   const char*    t;
1977470b340bSDmitry Karpeev   PetscBool      isfs;
1978470b340bSDmitry Karpeev   PC_FieldSplit  *jac;
1979470b340bSDmitry Karpeev 
1980470b340bSDmitry Karpeev   PetscFunctionBegin;
1981470b340bSDmitry Karpeev   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
1982470b340bSDmitry Karpeev   ierr = PetscObjectGetType((PetscObject)pc,&t);CHKERRQ(ierr);
1983470b340bSDmitry Karpeev   ierr = PetscStrcmp(t,PCFIELDSPLIT,&isfs);CHKERRQ(ierr);
1984470b340bSDmitry Karpeev   if (!isfs) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Expected PC of type PCFIELDSPLIT, got %s instead",t);
1985470b340bSDmitry Karpeev   jac = (PC_FieldSplit*)pc->data;
1986470b340bSDmitry 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);
1987bca69d2bSDmitry Karpeev   if (!S || *S != jac->schur) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"MatSchurComplement restored is not the same as gotten");
1988470b340bSDmitry Karpeev   PetscFunctionReturn(0);
1989470b340bSDmitry Karpeev }
1990470b340bSDmitry Karpeev 
1991470b340bSDmitry Karpeev 
199229f8a81cSJed Brown static PetscErrorCode  PCFieldSplitSetSchurPre_FieldSplit(PC pc,PCFieldSplitSchurPreType ptype,Mat pre)
1993e69d4d44SBarry Smith {
1994e69d4d44SBarry Smith   PC_FieldSplit  *jac = (PC_FieldSplit*)pc->data;
1995084e4875SJed Brown   PetscErrorCode ierr;
1996e69d4d44SBarry Smith 
1997e69d4d44SBarry Smith   PetscFunctionBegin;
1998084e4875SJed Brown   jac->schurpre = ptype;
1999a7476a74SDmitry Karpeev   if (ptype == PC_FIELDSPLIT_SCHUR_PRE_USER && pre) {
20006bf464f9SBarry Smith     ierr            = MatDestroy(&jac->schur_user);CHKERRQ(ierr);
2001084e4875SJed Brown     jac->schur_user = pre;
2002084e4875SJed Brown     ierr            = PetscObjectReference((PetscObject)jac->schur_user);CHKERRQ(ierr);
2003084e4875SJed Brown   }
2004e69d4d44SBarry Smith   PetscFunctionReturn(0);
2005e69d4d44SBarry Smith }
2006e69d4d44SBarry Smith 
200737a82bf0SJed Brown static PetscErrorCode  PCFieldSplitGetSchurPre_FieldSplit(PC pc,PCFieldSplitSchurPreType *ptype,Mat *pre)
200837a82bf0SJed Brown {
200937a82bf0SJed Brown   PC_FieldSplit  *jac = (PC_FieldSplit*)pc->data;
201037a82bf0SJed Brown 
201137a82bf0SJed Brown   PetscFunctionBegin;
201237a82bf0SJed Brown   *ptype = jac->schurpre;
201337a82bf0SJed Brown   *pre   = jac->schur_user;
201437a82bf0SJed Brown   PetscFunctionReturn(0);
201537a82bf0SJed Brown }
201637a82bf0SJed Brown 
2017ab1df9f5SJed Brown /*@
20180ffb0e17SBarry Smith     PCFieldSplitSetSchurFactType -  sets which blocks of the approximate block factorization to retain in the preconditioner
2019ab1df9f5SJed Brown 
2020ab1df9f5SJed Brown     Collective on PC
2021ab1df9f5SJed Brown 
2022ab1df9f5SJed Brown     Input Parameters:
2023ab1df9f5SJed Brown +   pc  - the preconditioner context
2024c9c6ffaaSJed Brown -   ftype - which blocks of factorization to retain, PC_FIELDSPLIT_SCHUR_FACT_FULL is default
2025ab1df9f5SJed Brown 
2026ab1df9f5SJed Brown     Options Database:
2027c9c6ffaaSJed Brown .     -pc_fieldsplit_schur_fact_type <diag,lower,upper,full> default is full
2028ab1df9f5SJed Brown 
2029ab1df9f5SJed Brown 
2030ab1df9f5SJed Brown     Level: intermediate
2031ab1df9f5SJed Brown 
2032ab1df9f5SJed Brown     Notes:
2033ab1df9f5SJed Brown     The FULL factorization is
2034ab1df9f5SJed Brown 
20350ffb0e17SBarry Smith $   (A   B)  = (1       0) (A   0) (1  Ainv*B)  = L D U
20360ffb0e17SBarry Smith $   (C   E)    (C*Ainv  1) (0   S) (0     1  )
2037ab1df9f5SJed Brown 
20380ffb0e17SBarry 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,
2039c096484dSStefano 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().
2040ab1df9f5SJed Brown 
20410ffb0e17SBarry Smith $    If A and S are solved exactly
20420ffb0e17SBarry Smith $      *) FULL factorization is a direct solver.
20430ffb0e17SBarry 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.
20440ffb0e17SBarry 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.
2045ab1df9f5SJed Brown 
20460ffb0e17SBarry Smith     If the iteration count is very low, consider using KSPFGMRES or KSPGCR which can use one less preconditioner
20470ffb0e17SBarry 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.
20480ffb0e17SBarry Smith 
20490ffb0e17SBarry Smith     For symmetric problems in which A is positive definite and S is negative definite, DIAG can be used with KSPMINRES.
20500ffb0e17SBarry Smith 
20510ffb0e17SBarry 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).
2052ab1df9f5SJed Brown 
2053ab1df9f5SJed Brown     References:
205496a0c994SBarry Smith +   1. - Murphy, Golub, and Wathen, A note on preconditioning indefinite linear systems, SIAM J. Sci. Comput., 21 (2000).
205596a0c994SBarry Smith -   2. - Ipsen, A note on preconditioning nonsymmetric matrices, SIAM J. Sci. Comput., 23 (2001).
2056ab1df9f5SJed Brown 
2057c096484dSStefano Zampini .seealso: PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitSetFields(), PCFieldSplitSchurPreType, PCFieldSplitSetSchurScale()
2058ab1df9f5SJed Brown @*/
2059c9c6ffaaSJed Brown PetscErrorCode  PCFieldSplitSetSchurFactType(PC pc,PCFieldSplitSchurFactType ftype)
2060ab1df9f5SJed Brown {
2061ab1df9f5SJed Brown   PetscErrorCode ierr;
2062ab1df9f5SJed Brown 
2063ab1df9f5SJed Brown   PetscFunctionBegin;
2064ab1df9f5SJed Brown   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
2065c9c6ffaaSJed Brown   ierr = PetscTryMethod(pc,"PCFieldSplitSetSchurFactType_C",(PC,PCFieldSplitSchurFactType),(pc,ftype));CHKERRQ(ierr);
2066ab1df9f5SJed Brown   PetscFunctionReturn(0);
2067ab1df9f5SJed Brown }
2068ab1df9f5SJed Brown 
20691e6b0712SBarry Smith static PetscErrorCode PCFieldSplitSetSchurFactType_FieldSplit(PC pc,PCFieldSplitSchurFactType ftype)
2070ab1df9f5SJed Brown {
2071ab1df9f5SJed Brown   PC_FieldSplit *jac = (PC_FieldSplit*)pc->data;
2072ab1df9f5SJed Brown 
2073ab1df9f5SJed Brown   PetscFunctionBegin;
2074ab1df9f5SJed Brown   jac->schurfactorization = ftype;
2075ab1df9f5SJed Brown   PetscFunctionReturn(0);
2076ab1df9f5SJed Brown }
2077ab1df9f5SJed Brown 
2078c096484dSStefano Zampini /*@
2079c096484dSStefano Zampini     PCFieldSplitSetSchurScale -  Controls the sign flip of S for PC_FIELDSPLIT_SCHUR_FACT_DIAG.
2080c096484dSStefano Zampini 
2081c096484dSStefano Zampini     Collective on PC
2082c096484dSStefano Zampini 
2083c096484dSStefano Zampini     Input Parameters:
2084c096484dSStefano Zampini +   pc    - the preconditioner context
2085c096484dSStefano Zampini -   scale - scaling factor for the Schur complement
2086c096484dSStefano Zampini 
2087c096484dSStefano Zampini     Options Database:
2088c096484dSStefano Zampini .     -pc_fieldsplit_schur_scale - default is -1.0
2089c096484dSStefano Zampini 
2090c096484dSStefano Zampini     Level: intermediate
2091c096484dSStefano Zampini 
2092c096484dSStefano Zampini .seealso: PCFIELDSPLIT, PCFieldSplitSetFields(), PCFieldSplitSchurFactType, PCFieldSplitSetSchurScale()
2093c096484dSStefano Zampini @*/
2094c096484dSStefano Zampini PetscErrorCode PCFieldSplitSetSchurScale(PC pc,PetscScalar scale)
2095c096484dSStefano Zampini {
2096c096484dSStefano Zampini   PetscErrorCode ierr;
2097c096484dSStefano Zampini 
2098c096484dSStefano Zampini   PetscFunctionBegin;
2099c096484dSStefano Zampini   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
2100c096484dSStefano Zampini   PetscValidLogicalCollectiveScalar(pc,scale,2);
2101c096484dSStefano Zampini   ierr = PetscTryMethod(pc,"PCFieldSplitSetSchurScale_C",(PC,PetscScalar),(pc,scale));CHKERRQ(ierr);
2102c096484dSStefano Zampini   PetscFunctionReturn(0);
2103c096484dSStefano Zampini }
2104c096484dSStefano Zampini 
2105c096484dSStefano Zampini static PetscErrorCode PCFieldSplitSetSchurScale_FieldSplit(PC pc,PetscScalar scale)
2106c096484dSStefano Zampini {
2107c096484dSStefano Zampini   PC_FieldSplit *jac = (PC_FieldSplit*)pc->data;
2108c096484dSStefano Zampini 
2109c096484dSStefano Zampini   PetscFunctionBegin;
2110c096484dSStefano Zampini   jac->schurscale = scale;
2111c096484dSStefano Zampini   PetscFunctionReturn(0);
2112c096484dSStefano Zampini }
2113c096484dSStefano Zampini 
211430ad9308SMatthew Knepley /*@C
21158c03b21aSDmitry Karpeev    PCFieldSplitGetSchurBlocks - Gets all matrix blocks for the Schur complement
211630ad9308SMatthew Knepley 
211730ad9308SMatthew Knepley    Collective on KSP
211830ad9308SMatthew Knepley 
211930ad9308SMatthew Knepley    Input Parameter:
212030ad9308SMatthew Knepley .  pc - the preconditioner context
212130ad9308SMatthew Knepley 
212230ad9308SMatthew Knepley    Output Parameters:
2123a04f6461SBarry Smith +  A00 - the (0,0) block
2124a04f6461SBarry Smith .  A01 - the (0,1) block
2125a04f6461SBarry Smith .  A10 - the (1,0) block
2126a04f6461SBarry Smith -  A11 - the (1,1) block
212730ad9308SMatthew Knepley 
212830ad9308SMatthew Knepley    Level: advanced
212930ad9308SMatthew Knepley 
213030ad9308SMatthew Knepley .seealso: PCFIELDSPLIT
213130ad9308SMatthew Knepley @*/
2132a04f6461SBarry Smith PetscErrorCode  PCFieldSplitGetSchurBlocks(PC pc,Mat *A00,Mat *A01,Mat *A10, Mat *A11)
213330ad9308SMatthew Knepley {
213430ad9308SMatthew Knepley   PC_FieldSplit *jac = (PC_FieldSplit*) pc->data;
213530ad9308SMatthew Knepley 
213630ad9308SMatthew Knepley   PetscFunctionBegin;
21370700a824SBarry Smith   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
2138ce94432eSBarry Smith   if (jac->type != PC_COMPOSITE_SCHUR) SETERRQ(PetscObjectComm((PetscObject)pc),PETSC_ERR_ARG_WRONG, "FieldSplit is not using a Schur complement approach.");
2139a04f6461SBarry Smith   if (A00) *A00 = jac->pmat[0];
2140a04f6461SBarry Smith   if (A01) *A01 = jac->B;
2141a04f6461SBarry Smith   if (A10) *A10 = jac->C;
2142a04f6461SBarry Smith   if (A11) *A11 = jac->pmat[1];
214330ad9308SMatthew Knepley   PetscFunctionReturn(0);
214430ad9308SMatthew Knepley }
214530ad9308SMatthew Knepley 
21461e6b0712SBarry Smith static PetscErrorCode  PCFieldSplitSetType_FieldSplit(PC pc,PCCompositeType type)
214779416396SBarry Smith {
214879416396SBarry Smith   PC_FieldSplit  *jac = (PC_FieldSplit*)pc->data;
2149e69d4d44SBarry Smith   PetscErrorCode ierr;
215079416396SBarry Smith 
215179416396SBarry Smith   PetscFunctionBegin;
215279416396SBarry Smith   jac->type = type;
21533b224e63SBarry Smith   if (type == PC_COMPOSITE_SCHUR) {
21543b224e63SBarry Smith     pc->ops->apply = PCApply_FieldSplit_Schur;
21553b224e63SBarry Smith     pc->ops->view  = PCView_FieldSplit_Schur;
21562fa5cd67SKarl Rupp 
2157bdf89e91SBarry Smith     ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitGetSubKSP_C",PCFieldSplitGetSubKSP_FieldSplit_Schur);CHKERRQ(ierr);
215829f8a81cSJed Brown     ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetSchurPre_C",PCFieldSplitSetSchurPre_FieldSplit);CHKERRQ(ierr);
215937a82bf0SJed Brown     ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitGetSchurPre_C",PCFieldSplitGetSchurPre_FieldSplit);CHKERRQ(ierr);
2160bdf89e91SBarry Smith     ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetSchurFactType_C",PCFieldSplitSetSchurFactType_FieldSplit);CHKERRQ(ierr);
2161c096484dSStefano Zampini     ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetSchurScale_C",PCFieldSplitSetSchurScale_FieldSplit);CHKERRQ(ierr);
2162e69d4d44SBarry Smith 
21633b224e63SBarry Smith   } else {
21643b224e63SBarry Smith     pc->ops->apply = PCApply_FieldSplit;
21653b224e63SBarry Smith     pc->ops->view  = PCView_FieldSplit;
21662fa5cd67SKarl Rupp 
2167bdf89e91SBarry Smith     ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitGetSubKSP_C",PCFieldSplitGetSubKSP_FieldSplit);CHKERRQ(ierr);
216829f8a81cSJed Brown     ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetSchurPre_C",0);CHKERRQ(ierr);
216937a82bf0SJed Brown     ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitGetSchurPre_C",0);CHKERRQ(ierr);
2170bdf89e91SBarry Smith     ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetSchurFactType_C",0);CHKERRQ(ierr);
2171c096484dSStefano Zampini     ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetSchurScale_C",0);CHKERRQ(ierr);
21723b224e63SBarry Smith   }
217379416396SBarry Smith   PetscFunctionReturn(0);
217479416396SBarry Smith }
217579416396SBarry Smith 
21761e6b0712SBarry Smith static PetscErrorCode  PCFieldSplitSetBlockSize_FieldSplit(PC pc,PetscInt bs)
217751f519a2SBarry Smith {
217851f519a2SBarry Smith   PC_FieldSplit *jac = (PC_FieldSplit*)pc->data;
217951f519a2SBarry Smith 
218051f519a2SBarry Smith   PetscFunctionBegin;
2181ce94432eSBarry Smith   if (bs < 1) SETERRQ1(PetscObjectComm((PetscObject)pc),PETSC_ERR_ARG_OUTOFRANGE,"Blocksize must be positive, you gave %D",bs);
2182ce94432eSBarry 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);
218351f519a2SBarry Smith   jac->bs = bs;
218451f519a2SBarry Smith   PetscFunctionReturn(0);
218551f519a2SBarry Smith }
218651f519a2SBarry Smith 
2187bc08b0f1SBarry Smith /*@
218879416396SBarry Smith    PCFieldSplitSetType - Sets the type of fieldsplit preconditioner.
218979416396SBarry Smith 
219079416396SBarry Smith    Collective on PC
219179416396SBarry Smith 
219279416396SBarry Smith    Input Parameter:
219379416396SBarry Smith .  pc - the preconditioner context
219481540f2fSBarry Smith .  type - PC_COMPOSITE_ADDITIVE, PC_COMPOSITE_MULTIPLICATIVE (default), PC_COMPOSITE_SYMMETRIC_MULTIPLICATIVE, PC_COMPOSITE_SPECIAL, PC_COMPOSITE_SCHUR
219579416396SBarry Smith 
219679416396SBarry Smith    Options Database Key:
2197a4efd8eaSMatthew Knepley .  -pc_fieldsplit_type <type: one of multiplicative, additive, symmetric_multiplicative, special, schur> - Sets fieldsplit preconditioner type
219879416396SBarry Smith 
2199b02e2d75SMatthew G Knepley    Level: Intermediate
220079416396SBarry Smith 
220179416396SBarry Smith .keywords: PC, set, type, composite preconditioner, additive, multiplicative
220279416396SBarry Smith 
220379416396SBarry Smith .seealso: PCCompositeSetType()
220479416396SBarry Smith 
220579416396SBarry Smith @*/
22067087cfbeSBarry Smith PetscErrorCode  PCFieldSplitSetType(PC pc,PCCompositeType type)
220779416396SBarry Smith {
22084ac538c5SBarry Smith   PetscErrorCode ierr;
220979416396SBarry Smith 
221079416396SBarry Smith   PetscFunctionBegin;
22110700a824SBarry Smith   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
22124ac538c5SBarry Smith   ierr = PetscTryMethod(pc,"PCFieldSplitSetType_C",(PC,PCCompositeType),(pc,type));CHKERRQ(ierr);
221379416396SBarry Smith   PetscFunctionReturn(0);
221479416396SBarry Smith }
221579416396SBarry Smith 
2216b02e2d75SMatthew G Knepley /*@
2217b02e2d75SMatthew G Knepley   PCFieldSplitGetType - Gets the type of fieldsplit preconditioner.
2218b02e2d75SMatthew G Knepley 
2219b02e2d75SMatthew G Knepley   Not collective
2220b02e2d75SMatthew G Knepley 
2221b02e2d75SMatthew G Knepley   Input Parameter:
2222b02e2d75SMatthew G Knepley . pc - the preconditioner context
2223b02e2d75SMatthew G Knepley 
2224b02e2d75SMatthew G Knepley   Output Parameter:
2225b02e2d75SMatthew G Knepley . type - PC_COMPOSITE_ADDITIVE, PC_COMPOSITE_MULTIPLICATIVE (default), PC_COMPOSITE_SYMMETRIC_MULTIPLICATIVE, PC_COMPOSITE_SPECIAL, PC_COMPOSITE_SCHUR
2226b02e2d75SMatthew G Knepley 
2227b02e2d75SMatthew G Knepley   Level: Intermediate
2228b02e2d75SMatthew G Knepley 
2229b02e2d75SMatthew G Knepley .keywords: PC, set, type, composite preconditioner, additive, multiplicative
2230b02e2d75SMatthew G Knepley .seealso: PCCompositeSetType()
2231b02e2d75SMatthew G Knepley @*/
2232b02e2d75SMatthew G Knepley PetscErrorCode PCFieldSplitGetType(PC pc, PCCompositeType *type)
2233b02e2d75SMatthew G Knepley {
2234b02e2d75SMatthew G Knepley   PC_FieldSplit *jac = (PC_FieldSplit*) pc->data;
2235b02e2d75SMatthew G Knepley 
2236b02e2d75SMatthew G Knepley   PetscFunctionBegin;
2237b02e2d75SMatthew G Knepley   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
2238b02e2d75SMatthew G Knepley   PetscValidIntPointer(type,2);
2239b02e2d75SMatthew G Knepley   *type = jac->type;
2240b02e2d75SMatthew G Knepley   PetscFunctionReturn(0);
2241b02e2d75SMatthew G Knepley }
2242b02e2d75SMatthew G Knepley 
22434ab8060aSDmitry Karpeev /*@
22444ab8060aSDmitry Karpeev    PCFieldSplitSetDMSplits - Flags whether DMCreateFieldDecomposition() should be used to define the splits, whenever possible.
22454ab8060aSDmitry Karpeev 
22464ab8060aSDmitry Karpeev    Logically Collective
22474ab8060aSDmitry Karpeev 
22484ab8060aSDmitry Karpeev    Input Parameters:
22494ab8060aSDmitry Karpeev +  pc   - the preconditioner context
22504ab8060aSDmitry Karpeev -  flg  - boolean indicating whether to use field splits defined by the DM
22514ab8060aSDmitry Karpeev 
22524ab8060aSDmitry Karpeev    Options Database Key:
22534ab8060aSDmitry Karpeev .  -pc_fieldsplit_dm_splits
22544ab8060aSDmitry Karpeev 
22554ab8060aSDmitry Karpeev    Level: Intermediate
22564ab8060aSDmitry Karpeev 
22574ab8060aSDmitry Karpeev .keywords: PC, DM, composite preconditioner, additive, multiplicative
22584ab8060aSDmitry Karpeev 
22594ab8060aSDmitry Karpeev .seealso: PCFieldSplitGetDMSplits()
22604ab8060aSDmitry Karpeev 
22614ab8060aSDmitry Karpeev @*/
22624ab8060aSDmitry Karpeev PetscErrorCode  PCFieldSplitSetDMSplits(PC pc,PetscBool flg)
22634ab8060aSDmitry Karpeev {
22644ab8060aSDmitry Karpeev   PC_FieldSplit  *jac = (PC_FieldSplit*)pc->data;
22654ab8060aSDmitry Karpeev   PetscBool      isfs;
22664ab8060aSDmitry Karpeev   PetscErrorCode ierr;
22674ab8060aSDmitry Karpeev 
22684ab8060aSDmitry Karpeev   PetscFunctionBegin;
22694ab8060aSDmitry Karpeev   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
22704ab8060aSDmitry Karpeev   PetscValidLogicalCollectiveBool(pc,flg,2);
22714ab8060aSDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)pc,PCFIELDSPLIT,&isfs);CHKERRQ(ierr);
22724ab8060aSDmitry Karpeev   if (isfs) {
22734ab8060aSDmitry Karpeev     jac->dm_splits = flg;
22744ab8060aSDmitry Karpeev   }
22754ab8060aSDmitry Karpeev   PetscFunctionReturn(0);
22764ab8060aSDmitry Karpeev }
22774ab8060aSDmitry Karpeev 
22784ab8060aSDmitry Karpeev 
22794ab8060aSDmitry Karpeev /*@
22804ab8060aSDmitry Karpeev    PCFieldSplitGetDMSplits - Returns flag indicating whether DMCreateFieldDecomposition() should be used to define the splits, whenever possible.
22814ab8060aSDmitry Karpeev 
22824ab8060aSDmitry Karpeev    Logically Collective
22834ab8060aSDmitry Karpeev 
22844ab8060aSDmitry Karpeev    Input Parameter:
22854ab8060aSDmitry Karpeev .  pc   - the preconditioner context
22864ab8060aSDmitry Karpeev 
22874ab8060aSDmitry Karpeev    Output Parameter:
22884ab8060aSDmitry Karpeev .  flg  - boolean indicating whether to use field splits defined by the DM
22894ab8060aSDmitry Karpeev 
22904ab8060aSDmitry Karpeev    Level: Intermediate
22914ab8060aSDmitry Karpeev 
22924ab8060aSDmitry Karpeev .keywords: PC, DM, composite preconditioner, additive, multiplicative
22934ab8060aSDmitry Karpeev 
22944ab8060aSDmitry Karpeev .seealso: PCFieldSplitSetDMSplits()
22954ab8060aSDmitry Karpeev 
22964ab8060aSDmitry Karpeev @*/
22974ab8060aSDmitry Karpeev PetscErrorCode  PCFieldSplitGetDMSplits(PC pc,PetscBool* flg)
22984ab8060aSDmitry Karpeev {
22994ab8060aSDmitry Karpeev   PC_FieldSplit  *jac = (PC_FieldSplit*)pc->data;
23004ab8060aSDmitry Karpeev   PetscBool      isfs;
23014ab8060aSDmitry Karpeev   PetscErrorCode ierr;
23024ab8060aSDmitry Karpeev 
23034ab8060aSDmitry Karpeev   PetscFunctionBegin;
23044ab8060aSDmitry Karpeev   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
23054ab8060aSDmitry Karpeev   PetscValidPointer(flg,2);
23064ab8060aSDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)pc,PCFIELDSPLIT,&isfs);CHKERRQ(ierr);
23074ab8060aSDmitry Karpeev   if (isfs) {
23084ab8060aSDmitry Karpeev     if(flg) *flg = jac->dm_splits;
23094ab8060aSDmitry Karpeev   }
23104ab8060aSDmitry Karpeev   PetscFunctionReturn(0);
23114ab8060aSDmitry Karpeev }
23124ab8060aSDmitry Karpeev 
23137b752e3dSPatrick Sanan /*@
23147b752e3dSPatrick Sanan    PCFieldSplitGetDetectSaddlePoint - Returns flag indicating whether PCFieldSplit will attempt to automatically determine fields based on zero diagonal entries.
23157b752e3dSPatrick Sanan 
23167b752e3dSPatrick Sanan    Logically Collective
23177b752e3dSPatrick Sanan 
23187b752e3dSPatrick Sanan    Input Parameter:
23197b752e3dSPatrick Sanan .  pc   - the preconditioner context
23207b752e3dSPatrick Sanan 
23217b752e3dSPatrick Sanan    Output Parameter:
23227b752e3dSPatrick Sanan .  flg  - boolean indicating whether to detect fields or not
23237b752e3dSPatrick Sanan 
23247b752e3dSPatrick Sanan    Level: Intermediate
23257b752e3dSPatrick Sanan 
23267b752e3dSPatrick Sanan .seealso: PCFIELDSPLIT, PCFieldSplitSetDetectSaddlePoint()
23277b752e3dSPatrick Sanan 
23287b752e3dSPatrick Sanan @*/
23297b752e3dSPatrick Sanan PetscErrorCode PCFieldSplitGetDetectSaddlePoint(PC pc,PetscBool *flg)
23307b752e3dSPatrick Sanan {
23317b752e3dSPatrick Sanan   PC_FieldSplit *jac = (PC_FieldSplit*)pc->data;
23327b752e3dSPatrick Sanan 
23337b752e3dSPatrick Sanan   PetscFunctionBegin;
23347b752e3dSPatrick Sanan   *flg = jac->detect;
23357b752e3dSPatrick Sanan   PetscFunctionReturn(0);
23367b752e3dSPatrick Sanan }
23377b752e3dSPatrick Sanan 
23387b752e3dSPatrick Sanan /*@
23397b752e3dSPatrick Sanan    PCFieldSplitSetDetectSaddlePoint - Sets flag indicating whether PCFieldSplit will attempt to automatically determine fields based on zero diagonal entries.
23407b752e3dSPatrick Sanan 
23417b752e3dSPatrick Sanan    Logically Collective
23427b752e3dSPatrick Sanan 
23437b752e3dSPatrick Sanan    Notes:
23447b752e3dSPatrick 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()).
23457b752e3dSPatrick Sanan 
23467b752e3dSPatrick Sanan    Input Parameter:
23477b752e3dSPatrick Sanan .  pc   - the preconditioner context
23487b752e3dSPatrick Sanan 
23497b752e3dSPatrick Sanan    Output Parameter:
23507b752e3dSPatrick Sanan .  flg  - boolean indicating whether to detect fields or not
23517b752e3dSPatrick Sanan 
23527b752e3dSPatrick Sanan    Options Database Key:
23537b752e3dSPatrick Sanan .  -pc_fieldsplit_detect_saddle_point
23547b752e3dSPatrick Sanan 
23557b752e3dSPatrick Sanan    Level: Intermediate
23567b752e3dSPatrick Sanan 
23577b752e3dSPatrick Sanan .seealso: PCFIELDSPLIT, PCFieldSplitSetDetectSaddlePoint(), PCFieldSplitSetType(), PCFieldSplitSetSchurPre()
23587b752e3dSPatrick Sanan 
23597b752e3dSPatrick Sanan @*/
23607b752e3dSPatrick Sanan PetscErrorCode PCFieldSplitSetDetectSaddlePoint(PC pc,PetscBool flg)
23617b752e3dSPatrick Sanan {
23627b752e3dSPatrick Sanan   PC_FieldSplit  *jac = (PC_FieldSplit*)pc->data;
23637b752e3dSPatrick Sanan   PetscErrorCode ierr;
23647b752e3dSPatrick Sanan 
23657b752e3dSPatrick Sanan   PetscFunctionBegin;
23667b752e3dSPatrick Sanan   jac->detect = flg;
23677b752e3dSPatrick Sanan   if (jac->detect) {
23687b752e3dSPatrick Sanan     ierr = PCFieldSplitSetType(pc,PC_COMPOSITE_SCHUR);CHKERRQ(ierr);
23697b752e3dSPatrick Sanan     ierr = PCFieldSplitSetSchurPre(pc,PC_FIELDSPLIT_SCHUR_PRE_SELF,NULL);CHKERRQ(ierr);
23707b752e3dSPatrick Sanan   }
23717b752e3dSPatrick Sanan   PetscFunctionReturn(0);
23727b752e3dSPatrick Sanan }
23737b752e3dSPatrick Sanan 
23740971522cSBarry Smith /* -------------------------------------------------------------------------------------*/
23750971522cSBarry Smith /*MC
2376a8c7a070SBarry Smith    PCFIELDSPLIT - Preconditioner created by combining separate preconditioners for individual
2377a04f6461SBarry Smith                   fields or groups of fields. See the users manual section "Solving Block Matrices" for more details.
23780971522cSBarry Smith 
2379edf189efSBarry Smith      To set options on the solvers for each block append -fieldsplit_ to all the PC
2380edf189efSBarry Smith         options database keys. For example, -fieldsplit_pc_type ilu -fieldsplit_pc_factor_levels 1
23810971522cSBarry Smith 
2382a8c7a070SBarry Smith      To set the options on the solvers separate for each block call PCFieldSplitGetSubKSP()
238369a612a9SBarry Smith          and set the options directly on the resulting KSP object
23840971522cSBarry Smith 
23850971522cSBarry Smith    Level: intermediate
23860971522cSBarry Smith 
238779416396SBarry Smith    Options Database Keys:
238881540f2fSBarry Smith +   -pc_fieldsplit_%d_fields <a,b,..> - indicates the fields to be used in the %d'th split
238981540f2fSBarry Smith .   -pc_fieldsplit_default - automatically add any fields to additional splits that have not
239081540f2fSBarry Smith                               been supplied explicitly by -pc_fieldsplit_%d_fields
239181540f2fSBarry Smith .   -pc_fieldsplit_block_size <bs> - size of block that defines fields (i.e. there are bs fields)
23920f188ba9SJed Brown .   -pc_fieldsplit_type <additive,multiplicative,symmetric_multiplicative,schur> - type of relaxation or factorization splitting
2393a6a584a2SBarry Smith .   -pc_fieldsplit_schur_precondition <self,selfp,user,a11,full> - default is a11; see PCFieldSplitSetSchurPre()
23947b752e3dSPatrick Sanan .   -pc_fieldsplit_detect_saddle_point - automatically finds rows with zero diagonal and uses Schur complement with no preconditioner as the solver
239579416396SBarry Smith 
23965d4c12cdSJungho Lee -    Options prefix for inner solvers when using Schur complement preconditioner are -fieldsplit_0_ and -fieldsplit_1_
23975d4c12cdSJungho Lee      for all other solvers they are -fieldsplit_%d_ for the dth field, use -fieldsplit_ for all fields
23985d4c12cdSJungho Lee 
2399c8a0d604SMatthew G Knepley    Notes:
2400c8a0d604SMatthew G Knepley     Use PCFieldSplitSetFields() to set fields defined by "strided" entries and PCFieldSplitSetIS()
2401d32f9abdSBarry Smith      to define a field by an arbitrary collection of entries.
2402d32f9abdSBarry Smith 
2403d32f9abdSBarry Smith       If no fields are set the default is used. The fields are defined by entries strided by bs,
2404d32f9abdSBarry Smith       beginning at 0 then 1, etc to bs-1. The block size can be set with PCFieldSplitSetBlockSize(),
2405d32f9abdSBarry Smith       if this is not called the block size defaults to the blocksize of the second matrix passed
2406d32f9abdSBarry Smith       to KSPSetOperators()/PCSetOperators().
2407d32f9abdSBarry Smith 
2408c8a0d604SMatthew G Knepley $     For the Schur complement preconditioner if J = ( A00 A01 )
2409c8a0d604SMatthew G Knepley $                                                    ( A10 A11 )
2410c8a0d604SMatthew G Knepley $     the preconditioner using full factorization is
241113b05affSJed Brown $              ( I   -ksp(A00) A01 ) ( inv(A00)     0  ) (     I          0  )
2412c8a0d604SMatthew G Knepley $              ( 0         I       ) (   0      ksp(S) ) ( -A10 ksp(A00)  I  )
241313b05affSJed Brown      where the action of inv(A00) is applied using the KSP solver with prefix -fieldsplit_0_.  S is the Schur complement
241413b05affSJed Brown $              S = A11 - A10 ksp(A00) A01
241513b05affSJed 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
2416c8a0d604SMatthew G Knepley      in providing the SECOND split or 1 if not give). For PCFieldSplitGetKSP() when field number is 0,
2417c8a0d604SMatthew G Knepley      it returns the KSP associated with -fieldsplit_0_ while field number 1 gives -fieldsplit_1_ KSP. By default
2418a6a584a2SBarry Smith      A11 is used to construct a preconditioner for S, use PCFieldSplitSetSchurPre() for all the possible ways to construct the preconditioner for S.
24191d71051fSDmitry Karpeev 
2420a7476a74SDmitry Karpeev      The factorization type is set using -pc_fieldsplit_schur_fact_type <diag, lower, upper, full>. The full is shown above,
24215668aaf4SBarry Smith      diag gives
2422c8a0d604SMatthew G Knepley $              ( inv(A00)     0   )
2423c8a0d604SMatthew G Knepley $              (   0      -ksp(S) )
2424c096484dSStefano 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
2425c096484dSStefano Zampini      can be turned off with PCFieldSplitSetSchurScale() or by command line -pc_fieldsplit_schur_scale 1.0. The lower factorization is the inverse of
2426c8a0d604SMatthew G Knepley $              (  A00   0 )
2427c8a0d604SMatthew G Knepley $              (  A10   S )
2428c8a0d604SMatthew G Knepley      where the inverses of A00 and S are applied using KSPs. The upper factorization is the inverse of
2429c8a0d604SMatthew G Knepley $              ( A00 A01 )
2430c8a0d604SMatthew G Knepley $              (  0   S  )
2431c8a0d604SMatthew G Knepley      where again the inverses of A00 and S are applied using KSPs.
2432e69d4d44SBarry Smith 
2433edf189efSBarry Smith      If only one set of indices (one IS) is provided with PCFieldSplitSetIS() then the complement of that IS
2434edf189efSBarry Smith      is used automatically for a second block.
2435edf189efSBarry Smith 
2436ff218e97SBarry Smith      The fieldsplit preconditioner cannot currently be used with the BAIJ or SBAIJ data formats if the blocksize is larger than 1.
2437ff218e97SBarry Smith      Generally it should be used with the AIJ format.
2438ff218e97SBarry Smith 
2439ff218e97SBarry Smith      The forms of these preconditioners are closely related if not identical to forms derived as "Distributive Iterations", see,
2440ff218e97SBarry Smith      for example, page 294 in "Principles of Computational Fluid Dynamics" by Pieter Wesseling. Note that one can also use PCFIELDSPLIT
2441ff218e97SBarry Smith      inside a smoother resulting in "Distributive Smoothers".
24420716a85fSBarry Smith 
2443a541d17aSBarry Smith    Concepts: physics based preconditioners, block preconditioners
24440971522cSBarry Smith 
24453bc631e0SBarry Smith    There is a nice discussion of block preconditioners in
24463bc631e0SBarry Smith 
24473bc631e0SBarry Smith [El08] A taxonomy and comparison of parallel block multi-level preconditioners for the incompressible Navier-Stokes equations
24483bc631e0SBarry Smith        Howard Elman, V.E. Howle, John Shadid, Robert Shuttleworth, Ray Tuminaro, Journal of Computational Physics 227 (2008) 1790--1808
24493bc631e0SBarry Smith        http://chess.cs.umd.edu/~elman/papers/tax.pdf
24503bc631e0SBarry Smith 
24514d308398SBarry Smith    The Constrained Pressure Preconditioner (CPR) can be implemented using PCCOMPOSITE with PCGALERKIN. CPR first solves an R A P subsystem, updates the
24524d308398SBarry Smith    residual on all variables (PCCompositeSetType(pc,PC_COMPOSITE_MULTIPLICATIVE)), and then applies a simple ILU like preconditioner on all the variables.
2453a6a584a2SBarry Smith 
24547e8cb189SBarry Smith .seealso:  PCCreate(), PCSetType(), PCType (for list of available types), PC, Block_Preconditioners, PCLSC,
24551d71051fSDmitry Karpeev            PCFieldSplitGetSubKSP(), PCFieldSplitSetFields(), PCFieldSplitSetType(), PCFieldSplitSetIS(), PCFieldSplitSetSchurPre(),
24567b752e3dSPatrick Sanan           MatSchurComplementSetAinvType(), PCFieldSplitSetSchurScale(),
24577b752e3dSPatrick Sanan           PCFieldSplitSetDetectSaddlePoint()
24580971522cSBarry Smith M*/
24590971522cSBarry Smith 
24608cc058d9SJed Brown PETSC_EXTERN PetscErrorCode PCCreate_FieldSplit(PC pc)
24610971522cSBarry Smith {
24620971522cSBarry Smith   PetscErrorCode ierr;
24630971522cSBarry Smith   PC_FieldSplit  *jac;
24640971522cSBarry Smith 
24650971522cSBarry Smith   PetscFunctionBegin;
2466b00a9115SJed Brown   ierr = PetscNewLog(pc,&jac);CHKERRQ(ierr);
24672fa5cd67SKarl Rupp 
24680971522cSBarry Smith   jac->bs                 = -1;
24690971522cSBarry Smith   jac->nsplits            = 0;
24703e197d65SBarry Smith   jac->type               = PC_COMPOSITE_MULTIPLICATIVE;
2471e6cab6aaSJed Brown   jac->schurpre           = PC_FIELDSPLIT_SCHUR_PRE_USER; /* Try user preconditioner first, fall back on diagonal */
2472c9c6ffaaSJed Brown   jac->schurfactorization = PC_FIELDSPLIT_SCHUR_FACT_FULL;
2473c096484dSStefano Zampini   jac->schurscale         = -1.0;
2474fbe7908bSJed Brown   jac->dm_splits          = PETSC_TRUE;
24757b752e3dSPatrick Sanan   jac->detect             = PETSC_FALSE;
247651f519a2SBarry Smith 
24770971522cSBarry Smith   pc->data = (void*)jac;
24780971522cSBarry Smith 
24790971522cSBarry Smith   pc->ops->apply           = PCApply_FieldSplit;
2480421e10b8SBarry Smith   pc->ops->applytranspose  = PCApplyTranspose_FieldSplit;
24810971522cSBarry Smith   pc->ops->setup           = PCSetUp_FieldSplit;
2482574deadeSBarry Smith   pc->ops->reset           = PCReset_FieldSplit;
24830971522cSBarry Smith   pc->ops->destroy         = PCDestroy_FieldSplit;
24840971522cSBarry Smith   pc->ops->setfromoptions  = PCSetFromOptions_FieldSplit;
24850971522cSBarry Smith   pc->ops->view            = PCView_FieldSplit;
24860971522cSBarry Smith   pc->ops->applyrichardson = 0;
24870971522cSBarry Smith 
2488bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitGetSubKSP_C",PCFieldSplitGetSubKSP_FieldSplit);CHKERRQ(ierr);
2489bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetFields_C",PCFieldSplitSetFields_FieldSplit);CHKERRQ(ierr);
2490bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetIS_C",PCFieldSplitSetIS_FieldSplit);CHKERRQ(ierr);
2491bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetType_C",PCFieldSplitSetType_FieldSplit);CHKERRQ(ierr);
2492bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetBlockSize_C",PCFieldSplitSetBlockSize_FieldSplit);CHKERRQ(ierr);
24936dbb499eSCian Wilson   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitRestrictIS_C",PCFieldSplitRestrictIS_FieldSplit);CHKERRQ(ierr);
24940971522cSBarry Smith   PetscFunctionReturn(0);
24950971522cSBarry Smith }
2496