xref: /petsc/src/ksp/pc/impls/fieldsplit/fieldsplit.c (revision 9df09d4379155d4a89f92a1da77cf11d4ff886a0)
1dba47a55SKris Buschelman 
2af0996ceSBarry Smith #include <petsc/private/pcimpl.h>     /*I "petscpc.h" I*/
31e25c274SJed Brown #include <petscdm.h>
40971522cSBarry Smith 
5443836d0SMatthew G Knepley 
62e71c61dSMatthew G. Knepley const char *const PCFieldSplitSchurPreTypes[] = {"SELF","SELFP","A11","USER","FULL","PCFieldSplitSchurPreType","PC_FIELDSPLIT_SCHUR_PRE_",0};
7c9c6ffaaSJed Brown const char *const PCFieldSplitSchurFactTypes[] = {"DIAG","LOWER","UPPER","FULL","PCFieldSplitSchurFactType","PC_FIELDSPLIT_SCHUR_FACT_",0};
8c5d2311dSJed Brown 
9*9df09d43SBarry 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;
10*9df09d43SBarry Smith 
110971522cSBarry Smith typedef struct _PC_FieldSplitLink *PC_FieldSplitLink;
120971522cSBarry Smith struct _PC_FieldSplitLink {
1369a612a9SBarry Smith   KSP               ksp;
14443836d0SMatthew G Knepley   Vec               x,y,z;
15db4c96c1SJed Brown   char              *splitname;
160971522cSBarry Smith   PetscInt          nfields;
175d4c12cdSJungho Lee   PetscInt          *fields,*fields_col;
181b9fc7fcSBarry Smith   VecScatter        sctx;
195d4c12cdSJungho Lee   IS                is,is_col;
2051f519a2SBarry Smith   PC_FieldSplitLink next,previous;
21*9df09d43SBarry Smith   PetscLogEvent     event;
220971522cSBarry Smith };
230971522cSBarry Smith 
240971522cSBarry Smith typedef struct {
2568dd23aaSBarry Smith   PCCompositeType type;
26ace3abfcSBarry Smith   PetscBool       defaultsplit;                    /* Flag for a system with a set of 'k' scalar fields with the same layout (and bs = k) */
27ace3abfcSBarry Smith   PetscBool       splitdefined;                    /* Flag is set after the splits have been defined, to prevent more splits from being added */
2830ad9308SMatthew Knepley   PetscInt        bs;                              /* Block size for IS and Mat structures */
2930ad9308SMatthew Knepley   PetscInt        nsplits;                         /* Number of field divisions defined */
3079416396SBarry Smith   Vec             *x,*y,w1,w2;
31519d70e2SJed Brown   Mat             *mat;                            /* The diagonal block for each split */
32519d70e2SJed Brown   Mat             *pmat;                           /* The preconditioning diagonal block for each split */
3330ad9308SMatthew Knepley   Mat             *Afield;                         /* The rows of the matrix associated with each split */
34ace3abfcSBarry Smith   PetscBool       issetup;
352fa5cd67SKarl Rupp 
3630ad9308SMatthew Knepley   /* Only used when Schur complement preconditioning is used */
3730ad9308SMatthew Knepley   Mat                       B;                     /* The (0,1) block */
3830ad9308SMatthew Knepley   Mat                       C;                     /* The (1,0) block */
39443836d0SMatthew G Knepley   Mat                       schur;                 /* The Schur complement S = A11 - A10 A00^{-1} A01, the KSP here, kspinner, is H_1 in [El08] */
40a7476a74SDmitry Karpeev   Mat                       schurp;                /* Assembled approximation to S built by MatSchurComplement to be used as a preconditioning matrix when solving with S */
41084e4875SJed Brown   Mat                       schur_user;            /* User-provided preconditioning matrix for the Schur complement */
42084e4875SJed Brown   PCFieldSplitSchurPreType  schurpre;              /* Determines which preconditioning matrix is used for the Schur complement */
43c9c6ffaaSJed Brown   PCFieldSplitSchurFactType schurfactorization;
4430ad9308SMatthew Knepley   KSP                       kspschur;              /* The solver for S */
45443836d0SMatthew G Knepley   KSP                       kspupper;              /* The solver for A in the upper diagonal part of the factorization (H_2 in [El08]) */
4697bbdb24SBarry Smith   PC_FieldSplitLink         head;
4763ec74ffSBarry Smith   PetscBool                 reset;                  /* indicates PCReset() has been last called on this object, hack */
48c1570756SJed Brown   PetscBool                 suboptionsset;          /* Indicates that the KSPSetFromOptions() has been called on the sub-KSPs */
494ab8060aSDmitry Karpeev   PetscBool                 dm_splits;              /* Whether to use DMCreateFieldDecomposition() whenever possible */
50c84da90fSDmitry Karpeev   PetscBool                 diag_use_amat;          /* Whether to extract diagonal matrix blocks from Amat, rather than Pmat (weaker than -pc_use_amat) */
51c84da90fSDmitry Karpeev   PetscBool                 offdiag_use_amat;       /* Whether to extract off-diagonal matrix blocks from Amat, rather than Pmat (weaker than -pc_use_amat) */
520971522cSBarry Smith } PC_FieldSplit;
530971522cSBarry Smith 
5416913363SBarry Smith /*
5516913363SBarry Smith     Notes: there is no particular reason that pmat, x, and y are stored as arrays in PC_FieldSplit instead of
5616913363SBarry Smith    inside PC_FieldSplitLink, just historical. If you want to be able to add new fields after already using the
5716913363SBarry Smith    PC you could change this.
5816913363SBarry Smith */
59084e4875SJed Brown 
60e6cab6aaSJed Brown /* This helper is so that setting a user-provided preconditioning matrix is orthogonal to choosing to use it.  This way the
61084e4875SJed Brown * application-provided FormJacobian can provide this matrix without interfering with the user's (command-line) choices. */
62084e4875SJed Brown static Mat FieldSplitSchurPre(PC_FieldSplit *jac)
63084e4875SJed Brown {
64084e4875SJed Brown   switch (jac->schurpre) {
65084e4875SJed Brown   case PC_FIELDSPLIT_SCHUR_PRE_SELF: return jac->schur;
66a7476a74SDmitry Karpeev   case PC_FIELDSPLIT_SCHUR_PRE_SELFP: return jac->schurp;
67e87fab1bSBarry Smith   case PC_FIELDSPLIT_SCHUR_PRE_A11: return jac->pmat[1];
68e74569cdSMatthew G. Knepley   case PC_FIELDSPLIT_SCHUR_PRE_FULL: /* We calculate this and store it in schur_user */
69084e4875SJed Brown   case PC_FIELDSPLIT_SCHUR_PRE_USER: /* Use a user-provided matrix if it is given, otherwise diagonal block */
70084e4875SJed Brown   default:
71084e4875SJed Brown     return jac->schur_user ? jac->schur_user : jac->pmat[1];
72084e4875SJed Brown   }
73084e4875SJed Brown }
74084e4875SJed Brown 
75084e4875SJed Brown 
769804daf3SBarry Smith #include <petscdraw.h>
770971522cSBarry Smith #undef __FUNCT__
780971522cSBarry Smith #define __FUNCT__ "PCView_FieldSplit"
790971522cSBarry Smith static PetscErrorCode PCView_FieldSplit(PC pc,PetscViewer viewer)
800971522cSBarry Smith {
810971522cSBarry Smith   PC_FieldSplit     *jac = (PC_FieldSplit*)pc->data;
820971522cSBarry Smith   PetscErrorCode    ierr;
83d9884438SBarry Smith   PetscBool         iascii,isdraw;
840971522cSBarry Smith   PetscInt          i,j;
855a9f2f41SSatish Balay   PC_FieldSplitLink ilink = jac->head;
860971522cSBarry Smith 
870971522cSBarry Smith   PetscFunctionBegin;
88251f4c67SDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&iascii);CHKERRQ(ierr);
89d9884438SBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERDRAW,&isdraw);CHKERRQ(ierr);
900971522cSBarry Smith   if (iascii) {
912c9966d7SBarry Smith     if (jac->bs > 0) {
9251f519a2SBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"  FieldSplit with %s composition: total splits = %D, blocksize = %D\n",PCCompositeTypes[jac->type],jac->nsplits,jac->bs);CHKERRQ(ierr);
932c9966d7SBarry Smith     } else {
942c9966d7SBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"  FieldSplit with %s composition: total splits = %D\n",PCCompositeTypes[jac->type],jac->nsplits);CHKERRQ(ierr);
952c9966d7SBarry Smith     }
96f5236f50SJed Brown     if (pc->useAmat) {
97f5236f50SJed Brown       ierr = PetscViewerASCIIPrintf(viewer,"  using Amat (not Pmat) as operator for blocks\n");CHKERRQ(ierr);
98a3df900dSMatthew G Knepley     }
99c84da90fSDmitry Karpeev     if (jac->diag_use_amat) {
100c84da90fSDmitry Karpeev       ierr = PetscViewerASCIIPrintf(viewer,"  using Amat (not Pmat) as operator for diagonal blocks\n");CHKERRQ(ierr);
101c84da90fSDmitry Karpeev     }
102c84da90fSDmitry Karpeev     if (jac->offdiag_use_amat) {
103c84da90fSDmitry Karpeev       ierr = PetscViewerASCIIPrintf(viewer,"  using Amat (not Pmat) as operator for off-diagonal blocks\n");CHKERRQ(ierr);
104c84da90fSDmitry Karpeev     }
10569a612a9SBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"  Solver info for each split is in the following KSP objects:\n");CHKERRQ(ierr);
1060971522cSBarry Smith     ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
1070971522cSBarry Smith     for (i=0; i<jac->nsplits; i++) {
1081ab39975SBarry Smith       if (ilink->fields) {
1090971522cSBarry Smith         ierr = PetscViewerASCIIPrintf(viewer,"Split number %D Fields ",i);CHKERRQ(ierr);
11079416396SBarry Smith         ierr = PetscViewerASCIIUseTabs(viewer,PETSC_FALSE);CHKERRQ(ierr);
1115a9f2f41SSatish Balay         for (j=0; j<ilink->nfields; j++) {
11279416396SBarry Smith           if (j > 0) {
11379416396SBarry Smith             ierr = PetscViewerASCIIPrintf(viewer,",");CHKERRQ(ierr);
11479416396SBarry Smith           }
1155a9f2f41SSatish Balay           ierr = PetscViewerASCIIPrintf(viewer," %D",ilink->fields[j]);CHKERRQ(ierr);
1160971522cSBarry Smith         }
1170971522cSBarry Smith         ierr = PetscViewerASCIIPrintf(viewer,"\n");CHKERRQ(ierr);
11879416396SBarry Smith         ierr = PetscViewerASCIIUseTabs(viewer,PETSC_TRUE);CHKERRQ(ierr);
1191ab39975SBarry Smith       } else {
1201ab39975SBarry Smith         ierr = PetscViewerASCIIPrintf(viewer,"Split number %D Defined by IS\n",i);CHKERRQ(ierr);
1211ab39975SBarry Smith       }
1225a9f2f41SSatish Balay       ierr  = KSPView(ilink->ksp,viewer);CHKERRQ(ierr);
1235a9f2f41SSatish Balay       ilink = ilink->next;
1240971522cSBarry Smith     }
1250971522cSBarry Smith     ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
1262fa5cd67SKarl Rupp   }
1272fa5cd67SKarl Rupp 
1282fa5cd67SKarl Rupp  if (isdraw) {
129d9884438SBarry Smith     PetscDraw draw;
130d9884438SBarry Smith     PetscReal x,y,w,wd;
131d9884438SBarry Smith 
132d9884438SBarry Smith     ierr = PetscViewerDrawGetDraw(viewer,0,&draw);CHKERRQ(ierr);
133d9884438SBarry Smith     ierr = PetscDrawGetCurrentPoint(draw,&x,&y);CHKERRQ(ierr);
134d9884438SBarry Smith     w    = 2*PetscMin(1.0 - x,x);
135d9884438SBarry Smith     wd   = w/(jac->nsplits + 1);
136d9884438SBarry Smith     x    = x - wd*(jac->nsplits-1)/2.0;
137d9884438SBarry Smith     for (i=0; i<jac->nsplits; i++) {
138d9884438SBarry Smith       ierr  = PetscDrawPushCurrentPoint(draw,x,y);CHKERRQ(ierr);
139d9884438SBarry Smith       ierr  = KSPView(ilink->ksp,viewer);CHKERRQ(ierr);
140d9884438SBarry Smith       ierr  = PetscDrawPopCurrentPoint(draw);CHKERRQ(ierr);
141d9884438SBarry Smith       x    += wd;
142d9884438SBarry Smith       ilink = ilink->next;
143d9884438SBarry Smith     }
1440971522cSBarry Smith   }
1450971522cSBarry Smith   PetscFunctionReturn(0);
1460971522cSBarry Smith }
1470971522cSBarry Smith 
1480971522cSBarry Smith #undef __FUNCT__
1493b224e63SBarry Smith #define __FUNCT__ "PCView_FieldSplit_Schur"
1503b224e63SBarry Smith static PetscErrorCode PCView_FieldSplit_Schur(PC pc,PetscViewer viewer)
1513b224e63SBarry Smith {
1523b224e63SBarry Smith   PC_FieldSplit     *jac = (PC_FieldSplit*)pc->data;
1533b224e63SBarry Smith   PetscErrorCode    ierr;
1544996c5bdSBarry Smith   PetscBool         iascii,isdraw;
1553b224e63SBarry Smith   PetscInt          i,j;
1563b224e63SBarry Smith   PC_FieldSplitLink ilink = jac->head;
1573b224e63SBarry Smith 
1583b224e63SBarry Smith   PetscFunctionBegin;
159251f4c67SDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&iascii);CHKERRQ(ierr);
1604996c5bdSBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERDRAW,&isdraw);CHKERRQ(ierr);
1613b224e63SBarry Smith   if (iascii) {
1622c9966d7SBarry Smith     if (jac->bs > 0) {
163c9c6ffaaSJed Brown       ierr = PetscViewerASCIIPrintf(viewer,"  FieldSplit with Schur preconditioner, blocksize = %D, factorization %s\n",jac->bs,PCFieldSplitSchurFactTypes[jac->schurfactorization]);CHKERRQ(ierr);
1642c9966d7SBarry Smith     } else {
1652c9966d7SBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"  FieldSplit with Schur preconditioner, factorization %s\n",PCFieldSplitSchurFactTypes[jac->schurfactorization]);CHKERRQ(ierr);
1662c9966d7SBarry Smith     }
167f5236f50SJed Brown     if (pc->useAmat) {
168f5236f50SJed Brown       ierr = PetscViewerASCIIPrintf(viewer,"  using Amat (not Pmat) as operator for blocks\n");CHKERRQ(ierr);
169a3df900dSMatthew G Knepley     }
1703e8b8b31SMatthew G Knepley     switch (jac->schurpre) {
1713e8b8b31SMatthew G Knepley     case PC_FIELDSPLIT_SCHUR_PRE_SELF:
1723e8b8b31SMatthew G Knepley       ierr = PetscViewerASCIIPrintf(viewer,"  Preconditioner for the Schur complement formed from S itself\n");CHKERRQ(ierr);break;
173a7476a74SDmitry Karpeev     case PC_FIELDSPLIT_SCHUR_PRE_SELFP:
1741d71051fSDmitry Karpeev       ierr = PetscViewerASCIIPrintf(viewer,"  Preconditioner for the Schur complement formed from Sp, an assembled approximation to S, which uses (lumped, if requested) A00's diagonal's inverse\n");CHKERRQ(ierr);break;
175e87fab1bSBarry Smith     case PC_FIELDSPLIT_SCHUR_PRE_A11:
176e87fab1bSBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"  Preconditioner for the Schur complement formed from A11\n");CHKERRQ(ierr);break;
177e74569cdSMatthew G. Knepley     case PC_FIELDSPLIT_SCHUR_PRE_FULL:
178e74569cdSMatthew G. Knepley       ierr = PetscViewerASCIIPrintf(viewer,"  Preconditioner for the Schur complement formed from the exact Schur complement\n");CHKERRQ(ierr);break;
1793e8b8b31SMatthew G Knepley     case PC_FIELDSPLIT_SCHUR_PRE_USER:
1803e8b8b31SMatthew G Knepley       if (jac->schur_user) {
1813e8b8b31SMatthew G Knepley         ierr = PetscViewerASCIIPrintf(viewer,"  Preconditioner for the Schur complement formed from user provided matrix\n");CHKERRQ(ierr);
1823e8b8b31SMatthew G Knepley       } else {
183e87fab1bSBarry Smith         ierr = PetscViewerASCIIPrintf(viewer,"  Preconditioner for the Schur complement formed from A11\n");CHKERRQ(ierr);
1843e8b8b31SMatthew G Knepley       }
1853e8b8b31SMatthew G Knepley       break;
1863e8b8b31SMatthew G Knepley     default:
18782f516ccSBarry Smith       SETERRQ1(PetscObjectComm((PetscObject)pc), PETSC_ERR_ARG_OUTOFRANGE, "Invalid Schur preconditioning type: %d", jac->schurpre);
1883e8b8b31SMatthew G Knepley     }
1893b224e63SBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"  Split info:\n");CHKERRQ(ierr);
1903b224e63SBarry Smith     ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
1913b224e63SBarry Smith     for (i=0; i<jac->nsplits; i++) {
1923b224e63SBarry Smith       if (ilink->fields) {
1933b224e63SBarry Smith         ierr = PetscViewerASCIIPrintf(viewer,"Split number %D Fields ",i);CHKERRQ(ierr);
1943b224e63SBarry Smith         ierr = PetscViewerASCIIUseTabs(viewer,PETSC_FALSE);CHKERRQ(ierr);
1953b224e63SBarry Smith         for (j=0; j<ilink->nfields; j++) {
1963b224e63SBarry Smith           if (j > 0) {
1973b224e63SBarry Smith             ierr = PetscViewerASCIIPrintf(viewer,",");CHKERRQ(ierr);
1983b224e63SBarry Smith           }
1993b224e63SBarry Smith           ierr = PetscViewerASCIIPrintf(viewer," %D",ilink->fields[j]);CHKERRQ(ierr);
2003b224e63SBarry Smith         }
2013b224e63SBarry Smith         ierr = PetscViewerASCIIPrintf(viewer,"\n");CHKERRQ(ierr);
2023b224e63SBarry Smith         ierr = PetscViewerASCIIUseTabs(viewer,PETSC_TRUE);CHKERRQ(ierr);
2033b224e63SBarry Smith       } else {
2043b224e63SBarry Smith         ierr = PetscViewerASCIIPrintf(viewer,"Split number %D Defined by IS\n",i);CHKERRQ(ierr);
2053b224e63SBarry Smith       }
2063b224e63SBarry Smith       ilink = ilink->next;
2073b224e63SBarry Smith     }
208435f959eSBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"KSP solver for A00 block\n");CHKERRQ(ierr);
2093b224e63SBarry Smith     ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
21006de4afeSJed Brown     if (jac->head) {
211443836d0SMatthew G Knepley       ierr = KSPView(jac->head->ksp,viewer);CHKERRQ(ierr);
21206de4afeSJed Brown     } else  {ierr = PetscViewerASCIIPrintf(viewer,"  not yet available\n");CHKERRQ(ierr);}
2133b224e63SBarry Smith     ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
21406de4afeSJed Brown     if (jac->head && jac->kspupper != jac->head->ksp) {
215443836d0SMatthew G Knepley       ierr = PetscViewerASCIIPrintf(viewer,"KSP solver for upper A00 in upper triangular factor \n");CHKERRQ(ierr);
216443836d0SMatthew G Knepley       ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
217b2750c55SJed Brown       if (jac->kspupper) {ierr = KSPView(jac->kspupper,viewer);CHKERRQ(ierr);}
218b2750c55SJed Brown       else {ierr = PetscViewerASCIIPrintf(viewer,"  not yet available\n");CHKERRQ(ierr);}
219443836d0SMatthew G Knepley       ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
220443836d0SMatthew G Knepley     }
221435f959eSBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"KSP solver for S = A11 - A10 inv(A00) A01 \n");CHKERRQ(ierr);
2223b224e63SBarry Smith     ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
22312cae6f2SJed Brown     if (jac->kspschur) {
2243b224e63SBarry Smith       ierr = KSPView(jac->kspschur,viewer);CHKERRQ(ierr);
22512cae6f2SJed Brown     } else {
22612cae6f2SJed Brown       ierr = PetscViewerASCIIPrintf(viewer,"  not yet available\n");CHKERRQ(ierr);
22712cae6f2SJed Brown     }
2283b224e63SBarry Smith     ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
2293b224e63SBarry Smith     ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
23006de4afeSJed Brown   } else if (isdraw && jac->head) {
2314996c5bdSBarry Smith     PetscDraw draw;
2324996c5bdSBarry Smith     PetscReal x,y,w,wd,h;
2334996c5bdSBarry Smith     PetscInt  cnt = 2;
2344996c5bdSBarry Smith     char      str[32];
2354996c5bdSBarry Smith 
2364996c5bdSBarry Smith     ierr = PetscViewerDrawGetDraw(viewer,0,&draw);CHKERRQ(ierr);
2374996c5bdSBarry Smith     ierr = PetscDrawGetCurrentPoint(draw,&x,&y);CHKERRQ(ierr);
238c74581afSBarry Smith     if (jac->kspupper != jac->head->ksp) cnt++;
239c74581afSBarry Smith     w  = 2*PetscMin(1.0 - x,x);
240c74581afSBarry Smith     wd = w/(cnt + 1);
241c74581afSBarry Smith 
2424996c5bdSBarry Smith     ierr = PetscSNPrintf(str,32,"Schur fact. %s",PCFieldSplitSchurFactTypes[jac->schurfactorization]);CHKERRQ(ierr);
24351fa3d41SBarry Smith     ierr = PetscDrawStringBoxed(draw,x,y,PETSC_DRAW_RED,PETSC_DRAW_BLACK,str,NULL,&h);CHKERRQ(ierr);
2444996c5bdSBarry Smith     y   -= h;
2454996c5bdSBarry Smith     if (jac->schurpre == PC_FIELDSPLIT_SCHUR_PRE_USER &&  !jac->schur_user) {
246e87fab1bSBarry Smith       ierr = PetscSNPrintf(str,32,"Prec. for Schur from %s",PCFieldSplitSchurPreTypes[PC_FIELDSPLIT_SCHUR_PRE_A11]);CHKERRQ(ierr);
2473b224e63SBarry Smith     } else {
2484996c5bdSBarry Smith       ierr = PetscSNPrintf(str,32,"Prec. for Schur from %s",PCFieldSplitSchurPreTypes[jac->schurpre]);CHKERRQ(ierr);
2494996c5bdSBarry Smith     }
25051fa3d41SBarry Smith     ierr = PetscDrawStringBoxed(draw,x+wd*(cnt-1)/2.0,y,PETSC_DRAW_RED,PETSC_DRAW_BLACK,str,NULL,&h);CHKERRQ(ierr);
2514996c5bdSBarry Smith     y   -= h;
2524996c5bdSBarry Smith     x    = x - wd*(cnt-1)/2.0;
2534996c5bdSBarry Smith 
2544996c5bdSBarry Smith     ierr = PetscDrawPushCurrentPoint(draw,x,y);CHKERRQ(ierr);
2554996c5bdSBarry Smith     ierr = KSPView(jac->head->ksp,viewer);CHKERRQ(ierr);
2564996c5bdSBarry Smith     ierr = PetscDrawPopCurrentPoint(draw);CHKERRQ(ierr);
2574996c5bdSBarry Smith     if (jac->kspupper != jac->head->ksp) {
2584996c5bdSBarry Smith       x   += wd;
2594996c5bdSBarry Smith       ierr = PetscDrawPushCurrentPoint(draw,x,y);CHKERRQ(ierr);
2604996c5bdSBarry Smith       ierr = KSPView(jac->kspupper,viewer);CHKERRQ(ierr);
2614996c5bdSBarry Smith       ierr = PetscDrawPopCurrentPoint(draw);CHKERRQ(ierr);
2624996c5bdSBarry Smith     }
2634996c5bdSBarry Smith     x   += wd;
2644996c5bdSBarry Smith     ierr = PetscDrawPushCurrentPoint(draw,x,y);CHKERRQ(ierr);
2654996c5bdSBarry Smith     ierr = KSPView(jac->kspschur,viewer);CHKERRQ(ierr);
2664996c5bdSBarry Smith     ierr = PetscDrawPopCurrentPoint(draw);CHKERRQ(ierr);
2673b224e63SBarry Smith   }
2683b224e63SBarry Smith   PetscFunctionReturn(0);
2693b224e63SBarry Smith }
2703b224e63SBarry Smith 
2713b224e63SBarry Smith #undef __FUNCT__
2726c924f48SJed Brown #define __FUNCT__ "PCFieldSplitSetRuntimeSplits_Private"
2736c924f48SJed Brown /* Precondition: jac->bs is set to a meaningful value */
2746c924f48SJed Brown static PetscErrorCode PCFieldSplitSetRuntimeSplits_Private(PC pc)
2756c924f48SJed Brown {
2766c924f48SJed Brown   PetscErrorCode ierr;
2776c924f48SJed Brown   PC_FieldSplit  *jac = (PC_FieldSplit*)pc->data;
2785d4c12cdSJungho Lee   PetscInt       i,nfields,*ifields,nfields_col,*ifields_col;
2795d4c12cdSJungho Lee   PetscBool      flg,flg_col;
2805d4c12cdSJungho Lee   char           optionname[128],splitname[8],optionname_col[128];
2816c924f48SJed Brown 
2826c924f48SJed Brown   PetscFunctionBegin;
283785e854fSJed Brown   ierr = PetscMalloc1(jac->bs,&ifields);CHKERRQ(ierr);
284785e854fSJed Brown   ierr = PetscMalloc1(jac->bs,&ifields_col);CHKERRQ(ierr);
2856c924f48SJed Brown   for (i=0,flg=PETSC_TRUE;; i++) {
2868caf3d72SBarry Smith     ierr        = PetscSNPrintf(splitname,sizeof(splitname),"%D",i);CHKERRQ(ierr);
2878caf3d72SBarry Smith     ierr        = PetscSNPrintf(optionname,sizeof(optionname),"-pc_fieldsplit_%D_fields",i);CHKERRQ(ierr);
2888caf3d72SBarry Smith     ierr        = PetscSNPrintf(optionname_col,sizeof(optionname_col),"-pc_fieldsplit_%D_fields_col",i);CHKERRQ(ierr);
2896c924f48SJed Brown     nfields     = jac->bs;
29029499fbbSJungho Lee     nfields_col = jac->bs;
2916c924f48SJed Brown     ierr        = PetscOptionsGetIntArray(((PetscObject)pc)->prefix,optionname,ifields,&nfields,&flg);CHKERRQ(ierr);
2925d4c12cdSJungho Lee     ierr        = PetscOptionsGetIntArray(((PetscObject)pc)->prefix,optionname_col,ifields_col,&nfields_col,&flg_col);CHKERRQ(ierr);
2936c924f48SJed Brown     if (!flg) break;
2945d4c12cdSJungho Lee     else if (flg && !flg_col) {
2955d4c12cdSJungho Lee       if (!nfields) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_USER,"Cannot list zero fields");
2965d4c12cdSJungho Lee       ierr = PCFieldSplitSetFields(pc,splitname,nfields,ifields,ifields);CHKERRQ(ierr);
2972fa5cd67SKarl Rupp     } else {
2985d4c12cdSJungho Lee       if (!nfields || !nfields_col) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_USER,"Cannot list zero fields");
2995d4c12cdSJungho Lee       if (nfields != nfields_col) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_USER,"Number of row and column fields must match");
3005d4c12cdSJungho Lee       ierr = PCFieldSplitSetFields(pc,splitname,nfields,ifields,ifields_col);CHKERRQ(ierr);
3015d4c12cdSJungho Lee     }
3026c924f48SJed Brown   }
3036c924f48SJed Brown   if (i > 0) {
3046c924f48SJed Brown     /* Makes command-line setting of splits take precedence over setting them in code.
3056c924f48SJed Brown        Otherwise subsequent calls to PCFieldSplitSetIS() or PCFieldSplitSetFields() would
3066c924f48SJed Brown        create new splits, which would probably not be what the user wanted. */
3076c924f48SJed Brown     jac->splitdefined = PETSC_TRUE;
3086c924f48SJed Brown   }
3096c924f48SJed Brown   ierr = PetscFree(ifields);CHKERRQ(ierr);
3105d4c12cdSJungho Lee   ierr = PetscFree(ifields_col);CHKERRQ(ierr);
3116c924f48SJed Brown   PetscFunctionReturn(0);
3126c924f48SJed Brown }
3136c924f48SJed Brown 
3146c924f48SJed Brown #undef __FUNCT__
31569a612a9SBarry Smith #define __FUNCT__ "PCFieldSplitSetDefaults"
31669a612a9SBarry Smith static PetscErrorCode PCFieldSplitSetDefaults(PC pc)
3170971522cSBarry Smith {
3180971522cSBarry Smith   PC_FieldSplit     *jac = (PC_FieldSplit*)pc->data;
3190971522cSBarry Smith   PetscErrorCode    ierr;
3205a9f2f41SSatish Balay   PC_FieldSplitLink ilink              = jac->head;
3213a062f41SBarry Smith   PetscBool         fieldsplit_default = PETSC_FALSE,stokes = PETSC_FALSE,coupling = PETSC_FALSE;
3226c924f48SJed Brown   PetscInt          i;
3230971522cSBarry Smith 
3240971522cSBarry Smith   PetscFunctionBegin;
3257287d2a3SDmitry Karpeev   /*
3267287d2a3SDmitry Karpeev    Kinda messy, but at least this now uses DMCreateFieldDecomposition() even with jac->reset.
3277287d2a3SDmitry Karpeev    Should probably be rewritten.
3287287d2a3SDmitry Karpeev    */
3297287d2a3SDmitry Karpeev   if (!ilink || jac->reset) {
3300298fd71SBarry Smith     ierr = PetscOptionsGetBool(((PetscObject)pc)->prefix,"-pc_fieldsplit_detect_saddle_point",&stokes,NULL);CHKERRQ(ierr);
3313a062f41SBarry Smith     ierr = PetscOptionsGetBool(((PetscObject)pc)->prefix,"-pc_fieldsplit_detect_coupling",&coupling,NULL);CHKERRQ(ierr);
3323a062f41SBarry Smith     if (pc->dm && jac->dm_splits && !stokes && !coupling) {
333bafc1b83SMatthew G Knepley       PetscInt  numFields, f, i, j;
3340784a22cSJed Brown       char      **fieldNames;
3357b62db95SJungho Lee       IS        *fields;
336e7c4fc90SDmitry Karpeev       DM        *dms;
337bafc1b83SMatthew G Knepley       DM        subdm[128];
338bafc1b83SMatthew G Knepley       PetscBool flg;
339bafc1b83SMatthew G Knepley 
34016621825SDmitry Karpeev       ierr = DMCreateFieldDecomposition(pc->dm, &numFields, &fieldNames, &fields, &dms);CHKERRQ(ierr);
341bafc1b83SMatthew G Knepley       /* Allow the user to prescribe the splits */
342bafc1b83SMatthew G Knepley       for (i = 0, flg = PETSC_TRUE;; i++) {
343bafc1b83SMatthew G Knepley         PetscInt ifields[128];
344bafc1b83SMatthew G Knepley         IS       compField;
345bafc1b83SMatthew G Knepley         char     optionname[128], splitname[8];
346bafc1b83SMatthew G Knepley         PetscInt nfields = numFields;
347bafc1b83SMatthew G Knepley 
3488caf3d72SBarry Smith         ierr = PetscSNPrintf(optionname, sizeof(optionname), "-pc_fieldsplit_%D_fields", i);CHKERRQ(ierr);
349bafc1b83SMatthew G Knepley         ierr = PetscOptionsGetIntArray(((PetscObject) pc)->prefix, optionname, ifields, &nfields, &flg);CHKERRQ(ierr);
350bafc1b83SMatthew G Knepley         if (!flg) break;
35182f516ccSBarry Smith         if (numFields > 128) SETERRQ1(PetscObjectComm((PetscObject)pc),PETSC_ERR_SUP,"Cannot currently support %d > 128 fields", numFields);
352bafc1b83SMatthew G Knepley         ierr = DMCreateSubDM(pc->dm, nfields, ifields, &compField, &subdm[i]);CHKERRQ(ierr);
353bafc1b83SMatthew G Knepley         if (nfields == 1) {
354bafc1b83SMatthew G Knepley           ierr = PCFieldSplitSetIS(pc, fieldNames[ifields[0]], compField);CHKERRQ(ierr);
35582f516ccSBarry Smith           /* ierr = PetscPrintf(PetscObjectComm((PetscObject)pc), "%s Field Indices:", fieldNames[ifields[0]]);CHKERRQ(ierr);
3560298fd71SBarry Smith              ierr = ISView(compField, NULL);CHKERRQ(ierr); */
357bafc1b83SMatthew G Knepley         } else {
3588caf3d72SBarry Smith           ierr = PetscSNPrintf(splitname, sizeof(splitname), "%D", i);CHKERRQ(ierr);
359bafc1b83SMatthew G Knepley           ierr = PCFieldSplitSetIS(pc, splitname, compField);CHKERRQ(ierr);
36082f516ccSBarry Smith           /* ierr = PetscPrintf(PetscObjectComm((PetscObject)pc), "%s Field Indices:", splitname);CHKERRQ(ierr);
3610298fd71SBarry Smith              ierr = ISView(compField, NULL);CHKERRQ(ierr); */
3627287d2a3SDmitry Karpeev         }
363bafc1b83SMatthew G Knepley         ierr = ISDestroy(&compField);CHKERRQ(ierr);
364bafc1b83SMatthew G Knepley         for (j = 0; j < nfields; ++j) {
365bafc1b83SMatthew G Knepley           f    = ifields[j];
3667b62db95SJungho Lee           ierr = PetscFree(fieldNames[f]);CHKERRQ(ierr);
3677b62db95SJungho Lee           ierr = ISDestroy(&fields[f]);CHKERRQ(ierr);
3687b62db95SJungho Lee         }
369bafc1b83SMatthew G Knepley       }
370bafc1b83SMatthew G Knepley       if (i == 0) {
371bafc1b83SMatthew G Knepley         for (f = 0; f < numFields; ++f) {
372bafc1b83SMatthew G Knepley           ierr = PCFieldSplitSetIS(pc, fieldNames[f], fields[f]);CHKERRQ(ierr);
373bafc1b83SMatthew G Knepley           ierr = PetscFree(fieldNames[f]);CHKERRQ(ierr);
374bafc1b83SMatthew G Knepley           ierr = ISDestroy(&fields[f]);CHKERRQ(ierr);
375bafc1b83SMatthew G Knepley         }
376bafc1b83SMatthew G Knepley       } else {
377d724dfffSBarry Smith         for (j=0; j<numFields; j++) {
378d724dfffSBarry Smith           ierr = DMDestroy(dms+j);CHKERRQ(ierr);
379d724dfffSBarry Smith         }
380d724dfffSBarry Smith         ierr = PetscFree(dms);CHKERRQ(ierr);
381785e854fSJed Brown         ierr = PetscMalloc1(i, &dms);CHKERRQ(ierr);
3822fa5cd67SKarl Rupp         for (j = 0; j < i; ++j) dms[j] = subdm[j];
383bafc1b83SMatthew G Knepley       }
3847b62db95SJungho Lee       ierr = PetscFree(fieldNames);CHKERRQ(ierr);
3857b62db95SJungho Lee       ierr = PetscFree(fields);CHKERRQ(ierr);
386e7c4fc90SDmitry Karpeev       if (dms) {
3878b8307b2SJed Brown         ierr = PetscInfo(pc, "Setting up physics based fieldsplit preconditioner using the embedded DM\n");CHKERRQ(ierr);
388bafc1b83SMatthew G Knepley         for (ilink = jac->head, i = 0; ilink; ilink = ilink->next, ++i) {
3897287d2a3SDmitry Karpeev           const char *prefix;
3907287d2a3SDmitry Karpeev           ierr = PetscObjectGetOptionsPrefix((PetscObject)(ilink->ksp),&prefix);CHKERRQ(ierr);
3917287d2a3SDmitry Karpeev           ierr = PetscObjectSetOptionsPrefix((PetscObject)(dms[i]), prefix);CHKERRQ(ierr);
3927b62db95SJungho Lee           ierr = KSPSetDM(ilink->ksp, dms[i]);CHKERRQ(ierr);
3937b62db95SJungho Lee           ierr = KSPSetDMActive(ilink->ksp, PETSC_FALSE);CHKERRQ(ierr);
3947287d2a3SDmitry Karpeev           ierr = PetscObjectIncrementTabLevel((PetscObject)dms[i],(PetscObject)ilink->ksp,0);CHKERRQ(ierr);
395e7c4fc90SDmitry Karpeev           ierr = DMDestroy(&dms[i]);CHKERRQ(ierr);
3962fa5ba8aSJed Brown         }
3977b62db95SJungho Lee         ierr = PetscFree(dms);CHKERRQ(ierr);
3988b8307b2SJed Brown       }
39966ffff09SJed Brown     } else {
400521d7252SBarry Smith       if (jac->bs <= 0) {
401704ba839SBarry Smith         if (pc->pmat) {
402521d7252SBarry Smith           ierr = MatGetBlockSize(pc->pmat,&jac->bs);CHKERRQ(ierr);
4032fa5cd67SKarl Rupp         } else jac->bs = 1;
404521d7252SBarry Smith       }
405d32f9abdSBarry Smith 
4066ce1633cSBarry Smith       if (stokes) {
4076ce1633cSBarry Smith         IS       zerodiags,rest;
4086ce1633cSBarry Smith         PetscInt nmin,nmax;
4096ce1633cSBarry Smith 
4106ce1633cSBarry Smith         ierr = MatGetOwnershipRange(pc->mat,&nmin,&nmax);CHKERRQ(ierr);
4116ce1633cSBarry Smith         ierr = MatFindZeroDiagonals(pc->mat,&zerodiags);CHKERRQ(ierr);
4126ce1633cSBarry Smith         ierr = ISComplement(zerodiags,nmin,nmax,&rest);CHKERRQ(ierr);
4137287d2a3SDmitry Karpeev         if (jac->reset) {
4147287d2a3SDmitry Karpeev           jac->head->is       = rest;
4157287d2a3SDmitry Karpeev           jac->head->next->is = zerodiags;
4162fa5cd67SKarl Rupp         } else {
4176ce1633cSBarry Smith           ierr = PCFieldSplitSetIS(pc,"0",rest);CHKERRQ(ierr);
4186ce1633cSBarry Smith           ierr = PCFieldSplitSetIS(pc,"1",zerodiags);CHKERRQ(ierr);
4197287d2a3SDmitry Karpeev         }
420fcfd50ebSBarry Smith         ierr = ISDestroy(&zerodiags);CHKERRQ(ierr);
421fcfd50ebSBarry Smith         ierr = ISDestroy(&rest);CHKERRQ(ierr);
4223a062f41SBarry Smith       } else if (coupling) {
4233a062f41SBarry Smith         IS       coupling,rest;
4243a062f41SBarry Smith         PetscInt nmin,nmax;
4253a062f41SBarry Smith 
4263a062f41SBarry Smith         ierr = MatGetOwnershipRange(pc->mat,&nmin,&nmax);CHKERRQ(ierr);
4273a062f41SBarry Smith         ierr = MatFindOffBlockDiagonalEntries(pc->mat,&coupling);CHKERRQ(ierr);
4286bea0878SBarry Smith         ierr = ISCreateStride(PetscObjectComm((PetscObject)pc->mat),nmax-nmin,nmin,1,&rest);CHKERRQ(ierr);
429e52d2c62SBarry Smith         ierr = ISSetIdentity(rest);CHKERRQ(ierr);
4303a062f41SBarry Smith         if (jac->reset) {
4313a062f41SBarry Smith           jac->head->is       = coupling;
4323a062f41SBarry Smith           jac->head->next->is = rest;
4333a062f41SBarry Smith         } else {
4343a062f41SBarry Smith           ierr = PCFieldSplitSetIS(pc,"0",coupling);CHKERRQ(ierr);
4353a062f41SBarry Smith           ierr = PCFieldSplitSetIS(pc,"1",rest);CHKERRQ(ierr);
4363a062f41SBarry Smith         }
4373a062f41SBarry Smith         ierr = ISDestroy(&coupling);CHKERRQ(ierr);
4383a062f41SBarry Smith         ierr = ISDestroy(&rest);CHKERRQ(ierr);
4396ce1633cSBarry Smith       } else {
440ce94432eSBarry Smith         if (jac->reset) SETERRQ(PetscObjectComm((PetscObject)pc),PETSC_ERR_SUP,"Cases not yet handled when PCReset() was used");
4419eeaaa73SJed Brown         ierr = PetscOptionsGetBool(((PetscObject)pc)->prefix,"-pc_fieldsplit_default",&fieldsplit_default,NULL);CHKERRQ(ierr);
4427287d2a3SDmitry Karpeev         if (!fieldsplit_default) {
443d32f9abdSBarry Smith           /* Allow user to set fields from command line,  if bs was known at the time of PCSetFromOptions_FieldSplit()
444d32f9abdSBarry Smith            then it is set there. This is not ideal because we should only have options set in XXSetFromOptions(). */
4456c924f48SJed Brown           ierr = PCFieldSplitSetRuntimeSplits_Private(pc);CHKERRQ(ierr);
4466c924f48SJed Brown           if (jac->splitdefined) {ierr = PetscInfo(pc,"Splits defined using the options database\n");CHKERRQ(ierr);}
447d32f9abdSBarry Smith         }
4487287d2a3SDmitry Karpeev         if (fieldsplit_default || !jac->splitdefined) {
449d32f9abdSBarry Smith           ierr = PetscInfo(pc,"Using default splitting of fields\n");CHKERRQ(ierr);
450db4c96c1SJed Brown           for (i=0; i<jac->bs; i++) {
4516c924f48SJed Brown             char splitname[8];
4528caf3d72SBarry Smith             ierr = PetscSNPrintf(splitname,sizeof(splitname),"%D",i);CHKERRQ(ierr);
4535d4c12cdSJungho Lee             ierr = PCFieldSplitSetFields(pc,splitname,1,&i,&i);CHKERRQ(ierr);
45479416396SBarry Smith           }
4555d4c12cdSJungho Lee           jac->defaultsplit = PETSC_TRUE;
456521d7252SBarry Smith         }
45766ffff09SJed Brown       }
4586ce1633cSBarry Smith     }
459edf189efSBarry Smith   } else if (jac->nsplits == 1) {
460edf189efSBarry Smith     if (ilink->is) {
461edf189efSBarry Smith       IS       is2;
462edf189efSBarry Smith       PetscInt nmin,nmax;
463edf189efSBarry Smith 
464edf189efSBarry Smith       ierr = MatGetOwnershipRange(pc->mat,&nmin,&nmax);CHKERRQ(ierr);
465edf189efSBarry Smith       ierr = ISComplement(ilink->is,nmin,nmax,&is2);CHKERRQ(ierr);
466db4c96c1SJed Brown       ierr = PCFieldSplitSetIS(pc,"1",is2);CHKERRQ(ierr);
467fcfd50ebSBarry Smith       ierr = ISDestroy(&is2);CHKERRQ(ierr);
46882f516ccSBarry Smith     } else SETERRQ(PetscObjectComm((PetscObject)pc),PETSC_ERR_SUP,"Must provide at least two sets of fields to PCFieldSplit()");
469edf189efSBarry Smith   }
470d0af7cd3SBarry Smith 
471d0af7cd3SBarry Smith 
47282f516ccSBarry Smith   if (jac->nsplits < 2) SETERRQ1(PetscObjectComm((PetscObject)pc),PETSC_ERR_PLIB,"Unhandled case, must have at least two fields, not %d", jac->nsplits);
47369a612a9SBarry Smith   PetscFunctionReturn(0);
47469a612a9SBarry Smith }
47569a612a9SBarry Smith 
4765a576424SJed Brown PETSC_EXTERN PetscErrorCode PetscOptionsFindPairPrefix_Private(const char pre[], const char name[], char *value[], PetscBool *flg);
477514bf10dSMatthew G Knepley 
47869a612a9SBarry Smith #undef __FUNCT__
47969a612a9SBarry Smith #define __FUNCT__ "PCSetUp_FieldSplit"
48069a612a9SBarry Smith static PetscErrorCode PCSetUp_FieldSplit(PC pc)
48169a612a9SBarry Smith {
48269a612a9SBarry Smith   PC_FieldSplit     *jac = (PC_FieldSplit*)pc->data;
48369a612a9SBarry Smith   PetscErrorCode    ierr;
4845a9f2f41SSatish Balay   PC_FieldSplitLink ilink;
4852c9966d7SBarry Smith   PetscInt          i,nsplit;
4865f4ab4e1SJungho Lee   PetscBool         sorted, sorted_col;
48769a612a9SBarry Smith 
48869a612a9SBarry Smith   PetscFunctionBegin;
48969a612a9SBarry Smith   ierr   = PCFieldSplitSetDefaults(pc);CHKERRQ(ierr);
49097bbdb24SBarry Smith   nsplit = jac->nsplits;
4915a9f2f41SSatish Balay   ilink  = jac->head;
49297bbdb24SBarry Smith 
49397bbdb24SBarry Smith   /* get the matrices for each split */
494704ba839SBarry Smith   if (!jac->issetup) {
4951b9fc7fcSBarry Smith     PetscInt rstart,rend,nslots,bs;
49697bbdb24SBarry Smith 
497704ba839SBarry Smith     jac->issetup = PETSC_TRUE;
498704ba839SBarry Smith 
4995d4c12cdSJungho Lee     /* This is done here instead of in PCFieldSplitSetFields() because may not have matrix at that point */
5002c9966d7SBarry Smith     if (jac->defaultsplit || !ilink->is) {
5012c9966d7SBarry Smith       if (jac->bs <= 0) jac->bs = nsplit;
5022c9966d7SBarry Smith     }
50351f519a2SBarry Smith     bs     = jac->bs;
50497bbdb24SBarry Smith     ierr   = MatGetOwnershipRange(pc->pmat,&rstart,&rend);CHKERRQ(ierr);
5051b9fc7fcSBarry Smith     nslots = (rend - rstart)/bs;
5061b9fc7fcSBarry Smith     for (i=0; i<nsplit; i++) {
5071b9fc7fcSBarry Smith       if (jac->defaultsplit) {
508ce94432eSBarry Smith         ierr = ISCreateStride(PetscObjectComm((PetscObject)pc),nslots,rstart+i,nsplit,&ilink->is);CHKERRQ(ierr);
5095f4ab4e1SJungho Lee         ierr = ISDuplicate(ilink->is,&ilink->is_col);CHKERRQ(ierr);
510704ba839SBarry Smith       } else if (!ilink->is) {
511ccb205f8SBarry Smith         if (ilink->nfields > 1) {
5125f4ab4e1SJungho Lee           PetscInt *ii,*jj,j,k,nfields = ilink->nfields,*fields = ilink->fields,*fields_col = ilink->fields_col;
513785e854fSJed Brown           ierr = PetscMalloc1(ilink->nfields*nslots,&ii);CHKERRQ(ierr);
514785e854fSJed Brown           ierr = PetscMalloc1(ilink->nfields*nslots,&jj);CHKERRQ(ierr);
5151b9fc7fcSBarry Smith           for (j=0; j<nslots; j++) {
5161b9fc7fcSBarry Smith             for (k=0; k<nfields; k++) {
5171b9fc7fcSBarry Smith               ii[nfields*j + k] = rstart + bs*j + fields[k];
5185f4ab4e1SJungho Lee               jj[nfields*j + k] = rstart + bs*j + fields_col[k];
51997bbdb24SBarry Smith             }
52097bbdb24SBarry Smith           }
521ce94432eSBarry Smith           ierr = ISCreateGeneral(PetscObjectComm((PetscObject)pc),nslots*nfields,ii,PETSC_OWN_POINTER,&ilink->is);CHKERRQ(ierr);
522ce94432eSBarry Smith           ierr = ISCreateGeneral(PetscObjectComm((PetscObject)pc),nslots*nfields,jj,PETSC_OWN_POINTER,&ilink->is_col);CHKERRQ(ierr);
52390e68f20SPatrick Farrell           ierr = ISSetBlockSize(ilink->is, nfields);CHKERRQ(ierr);
52490e68f20SPatrick Farrell           ierr = ISSetBlockSize(ilink->is_col, nfields);CHKERRQ(ierr);
525ccb205f8SBarry Smith         } else {
526ce94432eSBarry Smith           ierr = ISCreateStride(PetscObjectComm((PetscObject)pc),nslots,rstart+ilink->fields[0],bs,&ilink->is);CHKERRQ(ierr);
527ce94432eSBarry Smith           ierr = ISCreateStride(PetscObjectComm((PetscObject)pc),nslots,rstart+ilink->fields_col[0],bs,&ilink->is_col);CHKERRQ(ierr);
528ccb205f8SBarry Smith        }
5293e197d65SBarry Smith       }
530704ba839SBarry Smith       ierr = ISSorted(ilink->is,&sorted);CHKERRQ(ierr);
5315f4ab4e1SJungho Lee       if (ilink->is_col) { ierr = ISSorted(ilink->is_col,&sorted_col);CHKERRQ(ierr); }
5325f4ab4e1SJungho Lee       if (!sorted || !sorted_col) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_USER,"Fields must be sorted when creating split");
533704ba839SBarry Smith       ilink = ilink->next;
5341b9fc7fcSBarry Smith     }
5351b9fc7fcSBarry Smith   }
5361b9fc7fcSBarry Smith 
537704ba839SBarry Smith   ilink = jac->head;
53897bbdb24SBarry Smith   if (!jac->pmat) {
539bdddcaaaSMatthew G Knepley     Vec xtmp;
540bdddcaaaSMatthew G Knepley 
5412a7a6963SBarry Smith     ierr = MatCreateVecs(pc->pmat,&xtmp,NULL);CHKERRQ(ierr);
542785e854fSJed Brown     ierr = PetscMalloc1(nsplit,&jac->pmat);CHKERRQ(ierr);
543dcca6d9dSJed Brown     ierr = PetscMalloc2(nsplit,&jac->x,nsplit,&jac->y);CHKERRQ(ierr);
544cf502942SBarry Smith     for (i=0; i<nsplit; i++) {
545bdddcaaaSMatthew G Knepley       MatNullSpace sp;
546bdddcaaaSMatthew G Knepley 
547a3df900dSMatthew G Knepley       /* Check for preconditioning matrix attached to IS */
548a3df900dSMatthew G Knepley       ierr = PetscObjectQuery((PetscObject) ilink->is, "pmat", (PetscObject*) &jac->pmat[i]);CHKERRQ(ierr);
549a3df900dSMatthew G Knepley       if (jac->pmat[i]) {
550a3df900dSMatthew G Knepley         ierr = PetscObjectReference((PetscObject) jac->pmat[i]);CHKERRQ(ierr);
551a3df900dSMatthew G Knepley         if (jac->type == PC_COMPOSITE_SCHUR) {
552a3df900dSMatthew G Knepley           jac->schur_user = jac->pmat[i];
5532fa5cd67SKarl Rupp 
554a3df900dSMatthew G Knepley           ierr = PetscObjectReference((PetscObject) jac->schur_user);CHKERRQ(ierr);
555a3df900dSMatthew G Knepley         }
556a3df900dSMatthew G Knepley       } else {
5573a062f41SBarry Smith         const char *prefix;
5585f4ab4e1SJungho Lee         ierr = MatGetSubMatrix(pc->pmat,ilink->is,ilink->is_col,MAT_INITIAL_MATRIX,&jac->pmat[i]);CHKERRQ(ierr);
5593a062f41SBarry Smith         ierr = KSPGetOptionsPrefix(ilink->ksp,&prefix);CHKERRQ(ierr);
5603a062f41SBarry Smith         ierr = MatSetOptionsPrefix(jac->pmat[i],prefix);CHKERRQ(ierr);
5613a062f41SBarry Smith         ierr = MatViewFromOptions(jac->pmat[i],NULL,"-mat_view");CHKERRQ(ierr);
562a3df900dSMatthew G Knepley       }
563bdddcaaaSMatthew G Knepley       /* create work vectors for each split */
5642a7a6963SBarry Smith       ierr     = MatCreateVecs(jac->pmat[i],&jac->x[i],&jac->y[i]);CHKERRQ(ierr);
5650298fd71SBarry Smith       ilink->x = jac->x[i]; ilink->y = jac->y[i]; ilink->z = NULL;
566bdddcaaaSMatthew G Knepley       /* compute scatter contexts needed by multiplicative versions and non-default splits */
5670298fd71SBarry Smith       ierr = VecScatterCreate(xtmp,ilink->is,jac->x[i],NULL,&ilink->sctx);CHKERRQ(ierr);
568ed1f0337SMatthew G Knepley       ierr = PetscObjectQuery((PetscObject) ilink->is, "nearnullspace", (PetscObject*) &sp);CHKERRQ(ierr);
569ed1f0337SMatthew G Knepley       if (sp) {
570ed1f0337SMatthew G Knepley         ierr = MatSetNearNullSpace(jac->pmat[i], sp);CHKERRQ(ierr);
571ed1f0337SMatthew G Knepley       }
572704ba839SBarry Smith       ilink = ilink->next;
573cf502942SBarry Smith     }
574bdddcaaaSMatthew G Knepley     ierr = VecDestroy(&xtmp);CHKERRQ(ierr);
57597bbdb24SBarry Smith   } else {
576cf502942SBarry Smith     for (i=0; i<nsplit; i++) {
577a3df900dSMatthew G Knepley       Mat pmat;
578a3df900dSMatthew G Knepley 
579a3df900dSMatthew G Knepley       /* Check for preconditioning matrix attached to IS */
580a3df900dSMatthew G Knepley       ierr = PetscObjectQuery((PetscObject) ilink->is, "pmat", (PetscObject*) &pmat);CHKERRQ(ierr);
581a3df900dSMatthew G Knepley       if (!pmat) {
5825f4ab4e1SJungho Lee         ierr = MatGetSubMatrix(pc->pmat,ilink->is,ilink->is_col,MAT_REUSE_MATRIX,&jac->pmat[i]);CHKERRQ(ierr);
583a3df900dSMatthew G Knepley       }
584704ba839SBarry Smith       ilink = ilink->next;
585cf502942SBarry Smith     }
58697bbdb24SBarry Smith   }
5874e39094bSDmitry Karpeev   if (jac->diag_use_amat) {
588519d70e2SJed Brown     ilink = jac->head;
589519d70e2SJed Brown     if (!jac->mat) {
590785e854fSJed Brown       ierr = PetscMalloc1(nsplit,&jac->mat);CHKERRQ(ierr);
591519d70e2SJed Brown       for (i=0; i<nsplit; i++) {
5925f4ab4e1SJungho Lee         ierr  = MatGetSubMatrix(pc->mat,ilink->is,ilink->is_col,MAT_INITIAL_MATRIX,&jac->mat[i]);CHKERRQ(ierr);
593519d70e2SJed Brown         ilink = ilink->next;
594519d70e2SJed Brown       }
595519d70e2SJed Brown     } else {
596519d70e2SJed Brown       for (i=0; i<nsplit; i++) {
5975f4ab4e1SJungho Lee         if (jac->mat[i]) {ierr = MatGetSubMatrix(pc->mat,ilink->is,ilink->is_col,MAT_REUSE_MATRIX,&jac->mat[i]);CHKERRQ(ierr);}
598519d70e2SJed Brown         ilink = ilink->next;
599519d70e2SJed Brown       }
600519d70e2SJed Brown     }
601519d70e2SJed Brown   } else {
602519d70e2SJed Brown     jac->mat = jac->pmat;
603519d70e2SJed Brown   }
60497bbdb24SBarry Smith 
60553935eafSBarry Smith   /* Check for null space attached to IS */
60653935eafSBarry Smith   ilink = jac->head;
60753935eafSBarry Smith   for (i=0; i<nsplit; i++) {
60853935eafSBarry Smith     MatNullSpace sp;
60953935eafSBarry Smith 
61053935eafSBarry Smith     ierr = PetscObjectQuery((PetscObject) ilink->is, "nullspace", (PetscObject*) &sp);CHKERRQ(ierr);
61153935eafSBarry Smith     if (sp) {
61253935eafSBarry Smith       ierr = MatSetNullSpace(jac->mat[i], sp);CHKERRQ(ierr);
61353935eafSBarry Smith     }
61453935eafSBarry Smith     ilink = ilink->next;
61553935eafSBarry Smith   }
61653935eafSBarry Smith 
6176c8605c2SJed Brown   if (jac->type != PC_COMPOSITE_ADDITIVE  && jac->type != PC_COMPOSITE_SCHUR) {
61868dd23aaSBarry Smith     /* extract the rows of the matrix associated with each field: used for efficient computation of residual inside algorithm */
6194e39094bSDmitry Karpeev     /* FIXME: Can/should we reuse jac->mat whenever (jac->diag_use_amat) is true? */
62068dd23aaSBarry Smith     ilink = jac->head;
621e52d2c62SBarry Smith     if (nsplit == 2 && jac->type == PC_COMPOSITE_MULTIPLICATIVE) {
622e52d2c62SBarry 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 */
623e52d2c62SBarry Smith       if (!jac->Afield) {
624e52d2c62SBarry Smith         ierr = PetscCalloc1(nsplit,&jac->Afield);CHKERRQ(ierr);
625e52d2c62SBarry Smith         ierr  = MatGetSubMatrix(pc->mat,ilink->next->is,ilink->is,MAT_INITIAL_MATRIX,&jac->Afield[1]);CHKERRQ(ierr);
626e52d2c62SBarry Smith       } else {
627e52d2c62SBarry Smith         ierr  = MatGetSubMatrix(pc->mat,ilink->next->is,ilink->is,MAT_REUSE_MATRIX,&jac->Afield[1]);CHKERRQ(ierr);
628e52d2c62SBarry Smith       }
629e52d2c62SBarry Smith     } else {
63068dd23aaSBarry Smith       if (!jac->Afield) {
631785e854fSJed Brown         ierr = PetscMalloc1(nsplit,&jac->Afield);CHKERRQ(ierr);
63268dd23aaSBarry Smith         for (i=0; i<nsplit; i++) {
6330298fd71SBarry Smith           ierr  = MatGetSubMatrix(pc->mat,ilink->is,NULL,MAT_INITIAL_MATRIX,&jac->Afield[i]);CHKERRQ(ierr);
63468dd23aaSBarry Smith           ilink = ilink->next;
63568dd23aaSBarry Smith         }
63668dd23aaSBarry Smith       } else {
63768dd23aaSBarry Smith         for (i=0; i<nsplit; i++) {
6380298fd71SBarry Smith           ierr  = MatGetSubMatrix(pc->mat,ilink->is,NULL,MAT_REUSE_MATRIX,&jac->Afield[i]);CHKERRQ(ierr);
63968dd23aaSBarry Smith           ilink = ilink->next;
64068dd23aaSBarry Smith         }
64168dd23aaSBarry Smith       }
64268dd23aaSBarry Smith     }
643e52d2c62SBarry Smith   }
64468dd23aaSBarry Smith 
6453b224e63SBarry Smith   if (jac->type == PC_COMPOSITE_SCHUR) {
6463b224e63SBarry Smith     IS          ccis;
6474aa3045dSJed Brown     PetscInt    rstart,rend;
648093c86ffSJed Brown     char        lscname[256];
649093c86ffSJed Brown     PetscObject LSC_L;
650ce94432eSBarry Smith 
651ce94432eSBarry Smith     if (nsplit != 2) SETERRQ(PetscObjectComm((PetscObject)pc),PETSC_ERR_ARG_INCOMP,"To use Schur complement preconditioner you must have exactly 2 fields");
65268dd23aaSBarry Smith 
653e6cab6aaSJed Brown     /* When extracting off-diagonal submatrices, we take complements from this range */
654e6cab6aaSJed Brown     ierr = MatGetOwnershipRangeColumn(pc->mat,&rstart,&rend);CHKERRQ(ierr);
655e6cab6aaSJed Brown 
6563b224e63SBarry Smith     /* need to handle case when one is resetting up the preconditioner */
6573b224e63SBarry Smith     if (jac->schur) {
6580298fd71SBarry Smith       KSP kspA = jac->head->ksp, kspInner = NULL, kspUpper = jac->kspupper;
659443836d0SMatthew G Knepley 
660fb3147dbSMatthew G Knepley       ierr  = MatSchurComplementGetKSP(jac->schur, &kspInner);CHKERRQ(ierr);
6613b224e63SBarry Smith       ilink = jac->head;
66249bb4cd7SJungho Lee       ierr  = ISComplement(ilink->is_col,rstart,rend,&ccis);CHKERRQ(ierr);
6634e39094bSDmitry Karpeev       if (jac->offdiag_use_amat) {
6644aa3045dSJed Brown 	ierr  = MatGetSubMatrix(pc->mat,ilink->is,ccis,MAT_REUSE_MATRIX,&jac->B);CHKERRQ(ierr);
665c84da90fSDmitry Karpeev       } else {
666df06c9e3SDmitry Karpeev 	ierr  = MatGetSubMatrix(pc->pmat,ilink->is,ccis,MAT_REUSE_MATRIX,&jac->B);CHKERRQ(ierr);
667c84da90fSDmitry Karpeev       }
668fcfd50ebSBarry Smith       ierr  = ISDestroy(&ccis);CHKERRQ(ierr);
6693b224e63SBarry Smith       ilink = ilink->next;
67049bb4cd7SJungho Lee       ierr  = ISComplement(ilink->is_col,rstart,rend,&ccis);CHKERRQ(ierr);
6714e39094bSDmitry Karpeev       if (jac->offdiag_use_amat) {
6724aa3045dSJed Brown 	ierr  = MatGetSubMatrix(pc->mat,ilink->is,ccis,MAT_REUSE_MATRIX,&jac->C);CHKERRQ(ierr);
673c84da90fSDmitry Karpeev       } else {
674df06c9e3SDmitry Karpeev 	ierr  = MatGetSubMatrix(pc->pmat,ilink->is,ccis,MAT_REUSE_MATRIX,&jac->C);CHKERRQ(ierr);
675c84da90fSDmitry Karpeev       }
676fcfd50ebSBarry Smith       ierr  = ISDestroy(&ccis);CHKERRQ(ierr);
677aa6c7ce3SBarry Smith       ierr  = MatSchurComplementUpdateSubMatrices(jac->schur,jac->mat[0],jac->pmat[0],jac->B,jac->C,jac->mat[1]);CHKERRQ(ierr);
678a7476a74SDmitry Karpeev       if (jac->schurpre == PC_FIELDSPLIT_SCHUR_PRE_SELFP) {
679a7476a74SDmitry Karpeev 	ierr = MatDestroy(&jac->schurp);CHKERRQ(ierr);
680a7476a74SDmitry Karpeev 	ierr = MatSchurComplementGetPmat(jac->schur,MAT_INITIAL_MATRIX,&jac->schurp);CHKERRQ(ierr);
681a7476a74SDmitry Karpeev       }
682443836d0SMatthew G Knepley       if (kspA != kspInner) {
68323ee1639SBarry Smith         ierr = KSPSetOperators(kspA,jac->mat[0],jac->pmat[0]);CHKERRQ(ierr);
684443836d0SMatthew G Knepley       }
685443836d0SMatthew G Knepley       if (kspUpper != kspA) {
68623ee1639SBarry Smith         ierr = KSPSetOperators(kspUpper,jac->mat[0],jac->pmat[0]);CHKERRQ(ierr);
687443836d0SMatthew G Knepley       }
68823ee1639SBarry Smith       ierr = KSPSetOperators(jac->kspschur,jac->schur,FieldSplitSchurPre(jac));CHKERRQ(ierr);
6893b224e63SBarry Smith     } else {
690bafc1b83SMatthew G Knepley       const char   *Dprefix;
691470b340bSDmitry Karpeev       char         schurprefix[256], schurmatprefix[256];
692514bf10dSMatthew G Knepley       char         schurtestoption[256];
693bdddcaaaSMatthew G Knepley       MatNullSpace sp;
694514bf10dSMatthew G Knepley       PetscBool    flg;
6953b224e63SBarry Smith 
696a04f6461SBarry Smith       /* extract the A01 and A10 matrices */
6973b224e63SBarry Smith       ilink = jac->head;
69849bb4cd7SJungho Lee       ierr  = ISComplement(ilink->is_col,rstart,rend,&ccis);CHKERRQ(ierr);
6994e39094bSDmitry Karpeev       if (jac->offdiag_use_amat) {
7004aa3045dSJed Brown 	ierr  = MatGetSubMatrix(pc->mat,ilink->is,ccis,MAT_INITIAL_MATRIX,&jac->B);CHKERRQ(ierr);
701c84da90fSDmitry Karpeev       } else {
702df06c9e3SDmitry Karpeev 	ierr  = MatGetSubMatrix(pc->pmat,ilink->is,ccis,MAT_INITIAL_MATRIX,&jac->B);CHKERRQ(ierr);
703c84da90fSDmitry Karpeev       }
704fcfd50ebSBarry Smith       ierr  = ISDestroy(&ccis);CHKERRQ(ierr);
7053b224e63SBarry Smith       ilink = ilink->next;
70649bb4cd7SJungho Lee       ierr  = ISComplement(ilink->is_col,rstart,rend,&ccis);CHKERRQ(ierr);
7074e39094bSDmitry Karpeev       if (jac->offdiag_use_amat) {
7084aa3045dSJed Brown 	ierr  = MatGetSubMatrix(pc->mat,ilink->is,ccis,MAT_INITIAL_MATRIX,&jac->C);CHKERRQ(ierr);
709c84da90fSDmitry Karpeev       } else {
710df06c9e3SDmitry Karpeev 	ierr  = MatGetSubMatrix(pc->pmat,ilink->is,ccis,MAT_INITIAL_MATRIX,&jac->C);CHKERRQ(ierr);
711c84da90fSDmitry Karpeev       }
712fcfd50ebSBarry Smith       ierr  = ISDestroy(&ccis);CHKERRQ(ierr);
71320252d06SBarry Smith 
714f5236f50SJed Brown       /* Use mat[0] (diagonal block of Amat) preconditioned by pmat[0] to define Schur complement */
71520252d06SBarry Smith       ierr = MatCreate(((PetscObject)jac->mat[0])->comm,&jac->schur);CHKERRQ(ierr);
71620252d06SBarry Smith       ierr = MatSetType(jac->schur,MATSCHURCOMPLEMENT);CHKERRQ(ierr);
717bee83525SDmitry Karpeev       ierr = MatSchurComplementSetSubMatrices(jac->schur,jac->mat[0],jac->pmat[0],jac->B,jac->C,jac->mat[1]);CHKERRQ(ierr);
718470b340bSDmitry Karpeev       ierr = PetscSNPrintf(schurmatprefix, sizeof(schurmatprefix), "%sfieldsplit_%s_", ((PetscObject)pc)->prefix ? ((PetscObject)pc)->prefix : "", ilink->splitname);CHKERRQ(ierr);
719470b340bSDmitry 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? */
720470b340bSDmitry Karpeev       ierr = MatSetOptionsPrefix(jac->schur,schurmatprefix);CHKERRQ(ierr);
721470b340bSDmitry Karpeev       ierr = MatSetFromOptions(jac->schur);CHKERRQ(ierr);
722895c21f2SBarry Smith       ierr = MatGetNullSpace(jac->mat[1], &sp);CHKERRQ(ierr);
72320252d06SBarry Smith       if (sp) {
72420252d06SBarry Smith         ierr = MatSetNullSpace(jac->schur, sp);CHKERRQ(ierr);
72520252d06SBarry Smith       }
72620252d06SBarry Smith 
72720252d06SBarry Smith       ierr = PetscSNPrintf(schurtestoption, sizeof(schurtestoption), "-fieldsplit_%s_inner_", ilink->splitname);CHKERRQ(ierr);
7280298fd71SBarry Smith       ierr = PetscOptionsFindPairPrefix_Private(((PetscObject)pc)->prefix, schurtestoption, NULL, &flg);CHKERRQ(ierr);
729514bf10dSMatthew G Knepley       if (flg) {
730514bf10dSMatthew G Knepley         DM  dmInner;
73121635b76SJed Brown         KSP kspInner;
73221635b76SJed Brown 
73321635b76SJed Brown         ierr = MatSchurComplementGetKSP(jac->schur, &kspInner);CHKERRQ(ierr);
73421635b76SJed Brown         ierr = PetscSNPrintf(schurprefix, sizeof(schurprefix), "%sfieldsplit_%s_inner_", ((PetscObject)pc)->prefix ? ((PetscObject)pc)->prefix : "", ilink->splitname);CHKERRQ(ierr);
73521635b76SJed Brown         /* Indent this deeper to emphasize the "inner" nature of this solver. */
73621635b76SJed Brown         ierr = PetscObjectIncrementTabLevel((PetscObject)kspInner, (PetscObject) pc, 2);CHKERRQ(ierr);
73721635b76SJed Brown         ierr = KSPSetOptionsPrefix(kspInner, schurprefix);CHKERRQ(ierr);
738514bf10dSMatthew G Knepley 
739514bf10dSMatthew G Knepley         /* Set DM for new solver */
740bafc1b83SMatthew G Knepley         ierr = KSPGetDM(jac->head->ksp, &dmInner);CHKERRQ(ierr);
74121635b76SJed Brown         ierr = KSPSetDM(kspInner, dmInner);CHKERRQ(ierr);
74221635b76SJed Brown         ierr = KSPSetDMActive(kspInner, PETSC_FALSE);CHKERRQ(ierr);
743514bf10dSMatthew G Knepley       } else {
74421635b76SJed Brown          /* Use the outer solver for the inner solve, but revert the KSPPREONLY from PCFieldSplitSetFields_FieldSplit or
74521635b76SJed Brown           * PCFieldSplitSetIS_FieldSplit. We don't want KSPPREONLY because it makes the Schur complement inexact,
74621635b76SJed Brown           * preventing Schur complement reduction to be an accurate solve. Usually when an iterative solver is used for
74721635b76SJed 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
74821635b76SJed Brown           * GMRES the default. Note that it is also common to use PREONLY for S, in which case S may not be used
74921635b76SJed Brown           * directly, and the user is responsible for setting an inexact method for fieldsplit's A^{-1}. */
75021635b76SJed Brown         ierr = KSPSetType(jac->head->ksp,KSPGMRES);CHKERRQ(ierr);
751514bf10dSMatthew G Knepley         ierr = MatSchurComplementSetKSP(jac->schur,jac->head->ksp);CHKERRQ(ierr);
752bafc1b83SMatthew G Knepley       }
75323ee1639SBarry Smith       ierr = KSPSetOperators(jac->head->ksp,jac->mat[0],jac->pmat[0]);CHKERRQ(ierr);
7545a9f2f41SSatish Balay       ierr = KSPSetFromOptions(jac->head->ksp);CHKERRQ(ierr);
75597bbdb24SBarry Smith       ierr = MatSetFromOptions(jac->schur);CHKERRQ(ierr);
75697bbdb24SBarry Smith 
757443836d0SMatthew G Knepley       ierr = PetscSNPrintf(schurtestoption, sizeof(schurtestoption), "-fieldsplit_%s_upper_", ilink->splitname);CHKERRQ(ierr);
7580298fd71SBarry Smith       ierr = PetscOptionsFindPairPrefix_Private(((PetscObject)pc)->prefix, schurtestoption, NULL, &flg);CHKERRQ(ierr);
759443836d0SMatthew G Knepley       if (flg) {
760443836d0SMatthew G Knepley         DM dmInner;
761443836d0SMatthew G Knepley 
762443836d0SMatthew G Knepley         ierr = PetscSNPrintf(schurprefix, sizeof(schurprefix), "%sfieldsplit_%s_upper_", ((PetscObject)pc)->prefix ? ((PetscObject)pc)->prefix : "", ilink->splitname);CHKERRQ(ierr);
76382f516ccSBarry Smith         ierr = KSPCreate(PetscObjectComm((PetscObject)pc), &jac->kspupper);CHKERRQ(ierr);
764422a814eSBarry Smith         ierr = KSPSetErrorIfNotConverged(jac->kspupper,pc->erroriffailure);CHKERRQ(ierr);
765443836d0SMatthew G Knepley         ierr = KSPSetOptionsPrefix(jac->kspupper, schurprefix);CHKERRQ(ierr);
766443836d0SMatthew G Knepley         ierr = KSPGetDM(jac->head->ksp, &dmInner);CHKERRQ(ierr);
767443836d0SMatthew G Knepley         ierr = KSPSetDM(jac->kspupper, dmInner);CHKERRQ(ierr);
768443836d0SMatthew G Knepley         ierr = KSPSetDMActive(jac->kspupper, PETSC_FALSE);CHKERRQ(ierr);
769443836d0SMatthew G Knepley         ierr = KSPSetFromOptions(jac->kspupper);CHKERRQ(ierr);
77023ee1639SBarry Smith         ierr = KSPSetOperators(jac->kspupper,jac->mat[0],jac->pmat[0]);CHKERRQ(ierr);
771443836d0SMatthew G Knepley         ierr = VecDuplicate(jac->head->x, &jac->head->z);CHKERRQ(ierr);
772443836d0SMatthew G Knepley       } else {
773443836d0SMatthew G Knepley         jac->kspupper = jac->head->ksp;
774443836d0SMatthew G Knepley         ierr          = PetscObjectReference((PetscObject) jac->head->ksp);CHKERRQ(ierr);
775443836d0SMatthew G Knepley       }
776443836d0SMatthew G Knepley 
777a7476a74SDmitry Karpeev       if (jac->schurpre == PC_FIELDSPLIT_SCHUR_PRE_SELFP) {
778a7476a74SDmitry Karpeev 	ierr = MatSchurComplementGetPmat(jac->schur,MAT_INITIAL_MATRIX,&jac->schurp);CHKERRQ(ierr);
779a7476a74SDmitry Karpeev       }
780ce94432eSBarry Smith       ierr = KSPCreate(PetscObjectComm((PetscObject)pc),&jac->kspschur);CHKERRQ(ierr);
781422a814eSBarry Smith       ierr = KSPSetErrorIfNotConverged(jac->kspschur,pc->erroriffailure);CHKERRQ(ierr);
78297bbdb24SBarry Smith       ierr = PetscLogObjectParent((PetscObject)pc,(PetscObject)jac->kspschur);CHKERRQ(ierr);
78320252d06SBarry Smith       ierr = PetscObjectIncrementTabLevel((PetscObject)jac->kspschur,(PetscObject)pc,1);CHKERRQ(ierr);
78497bbdb24SBarry Smith       if (jac->schurpre == PC_FIELDSPLIT_SCHUR_PRE_SELF) {
7857233a360SDmitry Karpeev         PC pcschur;
7867233a360SDmitry Karpeev         ierr = KSPGetPC(jac->kspschur,&pcschur);CHKERRQ(ierr);
7877233a360SDmitry Karpeev         ierr = PCSetType(pcschur,PCNONE);CHKERRQ(ierr);
78897bbdb24SBarry Smith         /* Note: This is bad if there exist preconditioners for MATSCHURCOMPLEMENT */
789e74569cdSMatthew G. Knepley       } else if (jac->schurpre == PC_FIELDSPLIT_SCHUR_PRE_FULL) {
790e74569cdSMatthew G. Knepley         ierr = MatSchurComplementComputeExplicitOperator(jac->schur, &jac->schur_user);CHKERRQ(ierr);
79197bbdb24SBarry Smith       }
79223ee1639SBarry Smith       ierr = KSPSetOperators(jac->kspschur,jac->schur,FieldSplitSchurPre(jac));CHKERRQ(ierr);
79397bbdb24SBarry Smith       ierr = KSPGetOptionsPrefix(jac->head->next->ksp, &Dprefix);CHKERRQ(ierr);
79497bbdb24SBarry Smith       ierr = KSPSetOptionsPrefix(jac->kspschur,         Dprefix);CHKERRQ(ierr);
795b20b4189SMatthew G. Knepley       /* propogate DM */
796b20b4189SMatthew G. Knepley       {
797b20b4189SMatthew G. Knepley         DM sdm;
798b20b4189SMatthew G. Knepley         ierr = KSPGetDM(jac->head->next->ksp, &sdm);CHKERRQ(ierr);
799b20b4189SMatthew G. Knepley         if (sdm) {
800b20b4189SMatthew G. Knepley           ierr = KSPSetDM(jac->kspschur, sdm);CHKERRQ(ierr);
801b20b4189SMatthew G. Knepley           ierr = KSPSetDMActive(jac->kspschur, PETSC_FALSE);CHKERRQ(ierr);
802b20b4189SMatthew G. Knepley         }
803b20b4189SMatthew G. Knepley       }
80497bbdb24SBarry Smith       /* really want setfromoptions called in PCSetFromOptions_FieldSplit(), but it is not ready yet */
80597bbdb24SBarry Smith       /* need to call this every time, since the jac->kspschur is freshly created, otherwise its options never get set */
80697bbdb24SBarry Smith       ierr = KSPSetFromOptions(jac->kspschur);CHKERRQ(ierr);
80797bbdb24SBarry Smith     }
80897bbdb24SBarry Smith 
8095a9f2f41SSatish Balay     /* HACK: special support to forward L and Lp matrices that might be used by PCLSC */
8108caf3d72SBarry Smith     ierr = PetscSNPrintf(lscname,sizeof(lscname),"%s_LSC_L",ilink->splitname);CHKERRQ(ierr);
811519d70e2SJed Brown     ierr = PetscObjectQuery((PetscObject)pc->mat,lscname,(PetscObject*)&LSC_L);CHKERRQ(ierr);
8123b224e63SBarry Smith     if (!LSC_L) {ierr = PetscObjectQuery((PetscObject)pc->pmat,lscname,(PetscObject*)&LSC_L);CHKERRQ(ierr);}
813c1570756SJed Brown     if (LSC_L) {ierr = PetscObjectCompose((PetscObject)jac->schur,"LSC_L",(PetscObject)LSC_L);CHKERRQ(ierr);}
8148caf3d72SBarry Smith     ierr = PetscSNPrintf(lscname,sizeof(lscname),"%s_LSC_Lp",ilink->splitname);CHKERRQ(ierr);
81597bbdb24SBarry Smith     ierr = PetscObjectQuery((PetscObject)pc->pmat,lscname,(PetscObject*)&LSC_L);CHKERRQ(ierr);
8165a9f2f41SSatish Balay     if (!LSC_L) {ierr = PetscObjectQuery((PetscObject)pc->mat,lscname,(PetscObject*)&LSC_L);CHKERRQ(ierr);}
8170971522cSBarry Smith     if (LSC_L) {ierr = PetscObjectCompose((PetscObject)jac->schur,"LSC_Lp",(PetscObject)LSC_L);CHKERRQ(ierr);}
81897bbdb24SBarry Smith   } else {
81968bd789dSDmitry Karpeev     /* set up the individual splits' PCs */
8200971522cSBarry Smith     i     = 0;
8210971522cSBarry Smith     ilink = jac->head;
8220971522cSBarry Smith     while (ilink) {
82323ee1639SBarry Smith       ierr = KSPSetOperators(ilink->ksp,jac->mat[i],jac->pmat[i]);CHKERRQ(ierr);
8240971522cSBarry Smith       /* really want setfromoptions called in PCSetFromOptions_FieldSplit(), but it is not ready yet */
8250971522cSBarry Smith       if (!jac->suboptionsset) {ierr = KSPSetFromOptions(ilink->ksp);CHKERRQ(ierr);}
8260971522cSBarry Smith       i++;
8270971522cSBarry Smith       ilink = ilink->next;
8280971522cSBarry Smith     }
8293b224e63SBarry Smith   }
8303b224e63SBarry Smith 
831c1570756SJed Brown   jac->suboptionsset = PETSC_TRUE;
8320971522cSBarry Smith   PetscFunctionReturn(0);
8330971522cSBarry Smith }
8340971522cSBarry Smith 
8355a9f2f41SSatish Balay #define FieldSplitSplitSolveAdd(ilink,xx,yy) \
836ca9f406cSSatish Balay   (VecScatterBegin(ilink->sctx,xx,ilink->x,INSERT_VALUES,SCATTER_FORWARD) || \
837ca9f406cSSatish Balay    VecScatterEnd(ilink->sctx,xx,ilink->x,INSERT_VALUES,SCATTER_FORWARD) || \
838*9df09d43SBarry Smith    PetscLogEventBegin(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL) ||\
8395a9f2f41SSatish Balay    KSPSolve(ilink->ksp,ilink->x,ilink->y) ||                               \
840*9df09d43SBarry Smith    PetscLogEventEnd(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL) ||\
841ca9f406cSSatish Balay    VecScatterBegin(ilink->sctx,ilink->y,yy,ADD_VALUES,SCATTER_REVERSE) ||  \
842ca9f406cSSatish Balay    VecScatterEnd(ilink->sctx,ilink->y,yy,ADD_VALUES,SCATTER_REVERSE))
84379416396SBarry Smith 
8440971522cSBarry Smith #undef __FUNCT__
8453b224e63SBarry Smith #define __FUNCT__ "PCApply_FieldSplit_Schur"
8463b224e63SBarry Smith static PetscErrorCode PCApply_FieldSplit_Schur(PC pc,Vec x,Vec y)
8473b224e63SBarry Smith {
8483b224e63SBarry Smith   PC_FieldSplit     *jac = (PC_FieldSplit*)pc->data;
8493b224e63SBarry Smith   PetscErrorCode    ierr;
8503b224e63SBarry Smith   PC_FieldSplitLink ilinkA = jac->head, ilinkD = ilinkA->next;
851443836d0SMatthew G Knepley   KSP               kspA   = ilinkA->ksp, kspLower = kspA, kspUpper = jac->kspupper;
8523b224e63SBarry Smith 
8533b224e63SBarry Smith   PetscFunctionBegin;
854c5d2311dSJed Brown   switch (jac->schurfactorization) {
855c9c6ffaaSJed Brown   case PC_FIELDSPLIT_SCHUR_FACT_DIAG:
856a04f6461SBarry Smith     /* [A00 0; 0 -S], positive definite, suitable for MINRES */
857c5d2311dSJed Brown     ierr = VecScatterBegin(ilinkA->sctx,x,ilinkA->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
858c5d2311dSJed Brown     ierr = VecScatterBegin(ilinkD->sctx,x,ilinkD->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
859c5d2311dSJed Brown     ierr = VecScatterEnd(ilinkA->sctx,x,ilinkA->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
860*9df09d43SBarry Smith     ierr = PetscLogEventBegin(ilinkA->event,kspA,ilinkA->x,ilinkA->y,NULL);CHKERRQ(ierr);
861443836d0SMatthew G Knepley     ierr = KSPSolve(kspA,ilinkA->x,ilinkA->y);CHKERRQ(ierr);
862*9df09d43SBarry Smith     ierr = PetscLogEventEnd(ilinkA->event,kspA,ilinkA->x,ilinkA->y,NULL);CHKERRQ(ierr);
863c5d2311dSJed Brown     ierr = VecScatterBegin(ilinkA->sctx,ilinkA->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
864c5d2311dSJed Brown     ierr = VecScatterEnd(ilinkD->sctx,x,ilinkD->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
865*9df09d43SBarry Smith     ierr = PetscLogEventBegin(KSP_Solve_FS_S,jac->kspschur,ilinkD->x,ilinkD->y,NULL);CHKERRQ(ierr);
866c5d2311dSJed Brown     ierr = KSPSolve(jac->kspschur,ilinkD->x,ilinkD->y);CHKERRQ(ierr);
867*9df09d43SBarry Smith     ierr = PetscLogEventEnd(KSP_Solve_FS_S,jac->kspschur,ilinkD->x,ilinkD->y,NULL);CHKERRQ(ierr);
868c5d2311dSJed Brown     ierr = VecScale(ilinkD->y,-1.);CHKERRQ(ierr);
869c5d2311dSJed Brown     ierr = VecScatterBegin(ilinkD->sctx,ilinkD->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
870c5d2311dSJed Brown     ierr = VecScatterEnd(ilinkA->sctx,ilinkA->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
871c5d2311dSJed Brown     ierr = VecScatterEnd(ilinkD->sctx,ilinkD->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
872c5d2311dSJed Brown     break;
873c9c6ffaaSJed Brown   case PC_FIELDSPLIT_SCHUR_FACT_LOWER:
874a04f6461SBarry Smith     /* [A00 0; A10 S], suitable for left preconditioning */
875c5d2311dSJed Brown     ierr = VecScatterBegin(ilinkA->sctx,x,ilinkA->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
876c5d2311dSJed Brown     ierr = VecScatterEnd(ilinkA->sctx,x,ilinkA->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
877*9df09d43SBarry Smith     ierr = PetscLogEventBegin(ilinkA->event,kspA,ilinkA->x,ilinkA->y,NULL);CHKERRQ(ierr);
878443836d0SMatthew G Knepley     ierr = KSPSolve(kspA,ilinkA->x,ilinkA->y);CHKERRQ(ierr);
879*9df09d43SBarry Smith     ierr = PetscLogEventEnd(ilinkA->event,kspA,ilinkA->x,ilinkA->y,NULL);CHKERRQ(ierr);
880c5d2311dSJed Brown     ierr = MatMult(jac->C,ilinkA->y,ilinkD->x);CHKERRQ(ierr);
881c5d2311dSJed Brown     ierr = VecScale(ilinkD->x,-1.);CHKERRQ(ierr);
882c5d2311dSJed Brown     ierr = VecScatterBegin(ilinkD->sctx,x,ilinkD->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
883c5d2311dSJed Brown     ierr = VecScatterBegin(ilinkA->sctx,ilinkA->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
884c5d2311dSJed Brown     ierr = VecScatterEnd(ilinkD->sctx,x,ilinkD->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
885*9df09d43SBarry Smith     ierr = PetscLogEventBegin(KSP_Solve_FS_S,jac->kspschur,ilinkD->x,ilinkD->y,NULL);CHKERRQ(ierr);
886c5d2311dSJed Brown     ierr = KSPSolve(jac->kspschur,ilinkD->x,ilinkD->y);CHKERRQ(ierr);
887*9df09d43SBarry Smith     ierr = PetscLogEventEnd(KSP_Solve_FS_S,jac->kspschur,ilinkD->x,ilinkD->y,NULL);CHKERRQ(ierr);
888c5d2311dSJed Brown     ierr = VecScatterBegin(ilinkD->sctx,ilinkD->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
889c5d2311dSJed Brown     ierr = VecScatterEnd(ilinkA->sctx,ilinkA->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
890c5d2311dSJed Brown     ierr = VecScatterEnd(ilinkD->sctx,ilinkD->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
891c5d2311dSJed Brown     break;
892c9c6ffaaSJed Brown   case PC_FIELDSPLIT_SCHUR_FACT_UPPER:
893a04f6461SBarry Smith     /* [A00 A01; 0 S], suitable for right preconditioning */
894c5d2311dSJed Brown     ierr = VecScatterBegin(ilinkD->sctx,x,ilinkD->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
895c5d2311dSJed Brown     ierr = VecScatterEnd(ilinkD->sctx,x,ilinkD->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
896*9df09d43SBarry Smith     ierr = PetscLogEventBegin(KSP_Solve_FS_S,jac->kspschur,ilinkD->x,ilinkD->y,NULL);CHKERRQ(ierr);
897c5d2311dSJed Brown     ierr = KSPSolve(jac->kspschur,ilinkD->x,ilinkD->y);CHKERRQ(ierr);
898*9df09d43SBarry 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);
899c5d2311dSJed Brown     ierr = VecScale(ilinkA->x,-1.);CHKERRQ(ierr);
900c5d2311dSJed Brown     ierr = VecScatterBegin(ilinkA->sctx,x,ilinkA->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
901c5d2311dSJed Brown     ierr = VecScatterBegin(ilinkD->sctx,ilinkD->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
902c5d2311dSJed Brown     ierr = VecScatterEnd(ilinkA->sctx,x,ilinkA->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
903*9df09d43SBarry Smith     ierr = PetscLogEventBegin(ilinkA->event,kspA,ilinkA->x,ilinkA->y,NULL);CHKERRQ(ierr);
904*9df09d43SBarry Smith     ierr = PetscLogEventBegin(ilinkA->event,kspA,ilinkA->x,ilinkA->y,NULL);CHKERRQ(ierr);
905443836d0SMatthew G Knepley     ierr = KSPSolve(kspA,ilinkA->x,ilinkA->y);CHKERRQ(ierr);
906*9df09d43SBarry Smith     ierr = PetscLogEventEnd(ilinkA->event,kspA,ilinkA->x,ilinkA->y,NULL);CHKERRQ(ierr);
907*9df09d43SBarry Smith     ierr = PetscLogEventEnd(ilinkA->event,kspA,ilinkA->x,ilinkA->y,NULL);CHKERRQ(ierr);
908c5d2311dSJed Brown     ierr = VecScatterBegin(ilinkA->sctx,ilinkA->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
909c5d2311dSJed Brown     ierr = VecScatterEnd(ilinkD->sctx,ilinkD->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
910c5d2311dSJed Brown     ierr = VecScatterEnd(ilinkA->sctx,ilinkA->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
911c5d2311dSJed Brown     break;
912c9c6ffaaSJed Brown   case PC_FIELDSPLIT_SCHUR_FACT_FULL:
913a04f6461SBarry 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 */
9143b224e63SBarry Smith     ierr = VecScatterBegin(ilinkA->sctx,x,ilinkA->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
9153b224e63SBarry Smith     ierr = VecScatterEnd(ilinkA->sctx,x,ilinkA->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
916*9df09d43SBarry Smith     ierr = PetscLogEventBegin(KSP_Solve_FS_L,kspLower,ilinkA->x,ilinkA->y,NULL);CHKERRQ(ierr);
917443836d0SMatthew G Knepley     ierr = KSPSolve(kspLower,ilinkA->x,ilinkA->y);CHKERRQ(ierr);
918*9df09d43SBarry Smith     ierr = PetscLogEventEnd(KSP_Solve_FS_L,kspLower,ilinkA->x,ilinkA->y,NULL);CHKERRQ(ierr);
9193b224e63SBarry Smith     ierr = MatMult(jac->C,ilinkA->y,ilinkD->x);CHKERRQ(ierr);
9203b224e63SBarry Smith     ierr = VecScale(ilinkD->x,-1.0);CHKERRQ(ierr);
9213b224e63SBarry Smith     ierr = VecScatterBegin(ilinkD->sctx,x,ilinkD->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
9223b224e63SBarry Smith     ierr = VecScatterEnd(ilinkD->sctx,x,ilinkD->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
9233b224e63SBarry Smith 
924*9df09d43SBarry Smith     ierr = PetscLogEventBegin(KSP_Solve_FS_S,jac->kspschur,ilinkD->x,ilinkD->y,NULL);CHKERRQ(ierr);
9253b224e63SBarry Smith     ierr = KSPSolve(jac->kspschur,ilinkD->x,ilinkD->y);CHKERRQ(ierr);
926*9df09d43SBarry Smith     ierr = PetscLogEventEnd(KSP_Solve_FS_S,jac->kspschur,ilinkD->x,ilinkD->y,NULL);CHKERRQ(ierr);
9273b224e63SBarry Smith     ierr = VecScatterBegin(ilinkD->sctx,ilinkD->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
9283b224e63SBarry Smith     ierr = VecScatterEnd(ilinkD->sctx,ilinkD->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
9293b224e63SBarry Smith 
930443836d0SMatthew G Knepley     if (kspUpper == kspA) {
9313b224e63SBarry Smith       ierr = MatMult(jac->B,ilinkD->y,ilinkA->y);CHKERRQ(ierr);
9323b224e63SBarry Smith       ierr = VecAXPY(ilinkA->x,-1.0,ilinkA->y);CHKERRQ(ierr);
933*9df09d43SBarry Smith       ierr = PetscLogEventBegin(ilinkA->event,kspA,ilinkA->x,ilinkA->y,NULL);CHKERRQ(ierr);
934443836d0SMatthew G Knepley       ierr = KSPSolve(kspA,ilinkA->x,ilinkA->y);CHKERRQ(ierr);
935*9df09d43SBarry Smith       ierr = PetscLogEventEnd(ilinkA->event,kspA,ilinkA->x,ilinkA->y,NULL);CHKERRQ(ierr);
936443836d0SMatthew G Knepley     } else {
937*9df09d43SBarry Smith       ierr = PetscLogEventBegin(ilinkA->event,kspA,ilinkA->x,ilinkA->y,NULL);CHKERRQ(ierr);
938443836d0SMatthew G Knepley       ierr = KSPSolve(kspA,ilinkA->x,ilinkA->y);CHKERRQ(ierr);
939*9df09d43SBarry Smith       ierr = PetscLogEventEnd(ilinkA->event,kspA,ilinkA->x,ilinkA->y,NULL);CHKERRQ(ierr);
940443836d0SMatthew G Knepley       ierr = MatMult(jac->B,ilinkD->y,ilinkA->x);CHKERRQ(ierr);
941*9df09d43SBarry Smith       ierr = PetscLogEventBegin(KSP_Solve_FS_U,kspUpper,ilinkA->x,ilinkA->z,NULL);CHKERRQ(ierr);
942443836d0SMatthew G Knepley       ierr = KSPSolve(kspUpper,ilinkA->x,ilinkA->z);CHKERRQ(ierr);
943*9df09d43SBarry Smith       ierr = PetscLogEventEnd(KSP_Solve_FS_U,kspUpper,ilinkA->x,ilinkA->z,NULL);CHKERRQ(ierr);
944443836d0SMatthew G Knepley       ierr = VecAXPY(ilinkA->y,-1.0,ilinkA->z);CHKERRQ(ierr);
945443836d0SMatthew G Knepley     }
9463b224e63SBarry Smith     ierr = VecScatterBegin(ilinkA->sctx,ilinkA->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
9473b224e63SBarry Smith     ierr = VecScatterEnd(ilinkA->sctx,ilinkA->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
948c5d2311dSJed Brown   }
9493b224e63SBarry Smith   PetscFunctionReturn(0);
9503b224e63SBarry Smith }
9513b224e63SBarry Smith 
9523b224e63SBarry Smith #undef __FUNCT__
9530971522cSBarry Smith #define __FUNCT__ "PCApply_FieldSplit"
9540971522cSBarry Smith static PetscErrorCode PCApply_FieldSplit(PC pc,Vec x,Vec y)
9550971522cSBarry Smith {
9560971522cSBarry Smith   PC_FieldSplit     *jac = (PC_FieldSplit*)pc->data;
9570971522cSBarry Smith   PetscErrorCode    ierr;
9585a9f2f41SSatish Balay   PC_FieldSplitLink ilink = jac->head;
959939b8a20SBarry Smith   PetscInt          cnt,bs;
9600971522cSBarry Smith 
9610971522cSBarry Smith   PetscFunctionBegin;
96279416396SBarry Smith   if (jac->type == PC_COMPOSITE_ADDITIVE) {
9631b9fc7fcSBarry Smith     if (jac->defaultsplit) {
964939b8a20SBarry Smith       ierr = VecGetBlockSize(x,&bs);CHKERRQ(ierr);
965ce94432eSBarry Smith       if (jac->bs > 0 && bs != jac->bs) SETERRQ2(PetscObjectComm((PetscObject)pc),PETSC_ERR_ARG_WRONGSTATE,"Blocksize of x vector %D does not match fieldsplit blocksize %D",bs,jac->bs);
966939b8a20SBarry Smith       ierr = VecGetBlockSize(y,&bs);CHKERRQ(ierr);
967ce94432eSBarry Smith       if (jac->bs > 0 && bs != jac->bs) SETERRQ2(PetscObjectComm((PetscObject)pc),PETSC_ERR_ARG_WRONGSTATE,"Blocksize of y vector %D does not match fieldsplit blocksize %D",bs,jac->bs);
9680971522cSBarry Smith       ierr = VecStrideGatherAll(x,jac->x,INSERT_VALUES);CHKERRQ(ierr);
9695a9f2f41SSatish Balay       while (ilink) {
970*9df09d43SBarry Smith         ierr  = PetscLogEventBegin(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL);CHKERRQ(ierr);
9715a9f2f41SSatish Balay         ierr  = KSPSolve(ilink->ksp,ilink->x,ilink->y);CHKERRQ(ierr);
972*9df09d43SBarry Smith         ierr  = PetscLogEventEnd(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL);CHKERRQ(ierr);
9735a9f2f41SSatish Balay         ilink = ilink->next;
9740971522cSBarry Smith       }
9750971522cSBarry Smith       ierr = VecStrideScatterAll(jac->y,y,INSERT_VALUES);CHKERRQ(ierr);
9761b9fc7fcSBarry Smith     } else {
977efb30889SBarry Smith       ierr = VecSet(y,0.0);CHKERRQ(ierr);
9785a9f2f41SSatish Balay       while (ilink) {
9795a9f2f41SSatish Balay         ierr  = FieldSplitSplitSolveAdd(ilink,x,y);CHKERRQ(ierr);
9805a9f2f41SSatish Balay         ilink = ilink->next;
9811b9fc7fcSBarry Smith       }
9821b9fc7fcSBarry Smith     }
983e52d2c62SBarry Smith   } else if (jac->type == PC_COMPOSITE_MULTIPLICATIVE && jac->nsplits == 2) {
984e52d2c62SBarry Smith     ierr = VecSet(y,0.0);CHKERRQ(ierr);
985e52d2c62SBarry Smith     /* solve on first block for first block variables */
986e52d2c62SBarry Smith     ierr = VecScatterBegin(ilink->sctx,x,ilink->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
987e52d2c62SBarry Smith     ierr = VecScatterEnd(ilink->sctx,x,ilink->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
988*9df09d43SBarry Smith     ierr = PetscLogEventBegin(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL);CHKERRQ(ierr);
989e52d2c62SBarry Smith     ierr = KSPSolve(ilink->ksp,ilink->x,ilink->y);CHKERRQ(ierr);
990*9df09d43SBarry Smith     ierr = PetscLogEventEnd(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL);CHKERRQ(ierr);
991e52d2c62SBarry Smith     ierr = VecScatterBegin(ilink->sctx,ilink->y,y,ADD_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
992e52d2c62SBarry Smith     ierr = VecScatterEnd(ilink->sctx,ilink->y,y,ADD_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
993e52d2c62SBarry Smith 
994e52d2c62SBarry Smith     /* compute the residual only onto second block variables using first block variables */
995e52d2c62SBarry Smith     ierr = MatMult(jac->Afield[1],ilink->y,ilink->next->x);CHKERRQ(ierr);
996e52d2c62SBarry Smith     ilink = ilink->next;
997e52d2c62SBarry Smith     ierr = VecScale(ilink->x,-1.0);CHKERRQ(ierr);
998e52d2c62SBarry Smith     ierr = VecScatterBegin(ilink->sctx,x,ilink->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
999e52d2c62SBarry Smith     ierr = VecScatterEnd(ilink->sctx,x,ilink->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
1000e52d2c62SBarry Smith 
1001e52d2c62SBarry Smith     /* solve on second block variables */
1002*9df09d43SBarry Smith     ierr = PetscLogEventBegin(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL);CHKERRQ(ierr);
1003e52d2c62SBarry Smith     ierr = KSPSolve(ilink->ksp,ilink->x,ilink->y);CHKERRQ(ierr);
1004*9df09d43SBarry Smith     ierr = PetscLogEventEnd(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL);CHKERRQ(ierr);
1005e52d2c62SBarry Smith     ierr = VecScatterBegin(ilink->sctx,ilink->y,y,ADD_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
1006e52d2c62SBarry Smith     ierr = VecScatterEnd(ilink->sctx,ilink->y,y,ADD_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
100716913363SBarry Smith   } else if (jac->type == PC_COMPOSITE_MULTIPLICATIVE || jac->type == PC_COMPOSITE_SYMMETRIC_MULTIPLICATIVE) {
100879416396SBarry Smith     if (!jac->w1) {
100979416396SBarry Smith       ierr = VecDuplicate(x,&jac->w1);CHKERRQ(ierr);
101079416396SBarry Smith       ierr = VecDuplicate(x,&jac->w2);CHKERRQ(ierr);
101179416396SBarry Smith     }
1012efb30889SBarry Smith     ierr = VecSet(y,0.0);CHKERRQ(ierr);
10135a9f2f41SSatish Balay     ierr = FieldSplitSplitSolveAdd(ilink,x,y);CHKERRQ(ierr);
10143e197d65SBarry Smith     cnt  = 1;
10155a9f2f41SSatish Balay     while (ilink->next) {
10165a9f2f41SSatish Balay       ilink = ilink->next;
10173e197d65SBarry Smith       /* compute the residual only over the part of the vector needed */
10183e197d65SBarry Smith       ierr = MatMult(jac->Afield[cnt++],y,ilink->x);CHKERRQ(ierr);
10193e197d65SBarry Smith       ierr = VecScale(ilink->x,-1.0);CHKERRQ(ierr);
10203e197d65SBarry Smith       ierr = VecScatterBegin(ilink->sctx,x,ilink->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
10213e197d65SBarry Smith       ierr = VecScatterEnd(ilink->sctx,x,ilink->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
1022*9df09d43SBarry Smith       ierr = PetscLogEventBegin(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL);CHKERRQ(ierr);
10233e197d65SBarry Smith       ierr = KSPSolve(ilink->ksp,ilink->x,ilink->y);CHKERRQ(ierr);
1024*9df09d43SBarry Smith       ierr = PetscLogEventEnd(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL);CHKERRQ(ierr);
10253e197d65SBarry Smith       ierr = VecScatterBegin(ilink->sctx,ilink->y,y,ADD_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
10263e197d65SBarry Smith       ierr = VecScatterEnd(ilink->sctx,ilink->y,y,ADD_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
10273e197d65SBarry Smith     }
102851f519a2SBarry Smith     if (jac->type == PC_COMPOSITE_SYMMETRIC_MULTIPLICATIVE) {
102911755939SBarry Smith       cnt -= 2;
103051f519a2SBarry Smith       while (ilink->previous) {
103151f519a2SBarry Smith         ilink = ilink->previous;
103211755939SBarry Smith         /* compute the residual only over the part of the vector needed */
103311755939SBarry Smith         ierr = MatMult(jac->Afield[cnt--],y,ilink->x);CHKERRQ(ierr);
103411755939SBarry Smith         ierr = VecScale(ilink->x,-1.0);CHKERRQ(ierr);
103511755939SBarry Smith         ierr = VecScatterBegin(ilink->sctx,x,ilink->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
103611755939SBarry Smith         ierr = VecScatterEnd(ilink->sctx,x,ilink->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
1037*9df09d43SBarry Smith         ierr = PetscLogEventBegin(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL);CHKERRQ(ierr);
103811755939SBarry Smith         ierr = KSPSolve(ilink->ksp,ilink->x,ilink->y);CHKERRQ(ierr);
1039*9df09d43SBarry Smith         ierr = PetscLogEventEnd(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL);CHKERRQ(ierr);
104011755939SBarry Smith         ierr = VecScatterBegin(ilink->sctx,ilink->y,y,ADD_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
104111755939SBarry Smith         ierr = VecScatterEnd(ilink->sctx,ilink->y,y,ADD_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
104251f519a2SBarry Smith       }
104311755939SBarry Smith     }
1044ce94432eSBarry Smith   } else SETERRQ1(PetscObjectComm((PetscObject)pc),PETSC_ERR_SUP,"Unsupported or unknown composition",(int) jac->type);
10450971522cSBarry Smith   PetscFunctionReturn(0);
10460971522cSBarry Smith }
10470971522cSBarry Smith 
1048421e10b8SBarry Smith #define FieldSplitSplitSolveAddTranspose(ilink,xx,yy) \
1049ca9f406cSSatish Balay   (VecScatterBegin(ilink->sctx,xx,ilink->y,INSERT_VALUES,SCATTER_FORWARD) || \
1050ca9f406cSSatish Balay    VecScatterEnd(ilink->sctx,xx,ilink->y,INSERT_VALUES,SCATTER_FORWARD) || \
1051*9df09d43SBarry Smith    PetscLogEventBegin(ilink->event,ilink->ksp,ilink->y,ilink->x,NULL) || \
1052421e10b8SBarry Smith    KSPSolveTranspose(ilink->ksp,ilink->y,ilink->x) ||                  \
1053*9df09d43SBarry Smith    PetscLogEventBegin(ilink->event,ilink->ksp,ilink->y,ilink->x,NULL) || \
1054ca9f406cSSatish Balay    VecScatterBegin(ilink->sctx,ilink->x,yy,ADD_VALUES,SCATTER_REVERSE) || \
1055ca9f406cSSatish Balay    VecScatterEnd(ilink->sctx,ilink->x,yy,ADD_VALUES,SCATTER_REVERSE))
1056421e10b8SBarry Smith 
1057421e10b8SBarry Smith #undef __FUNCT__
10588c03b21aSDmitry Karpeev #define __FUNCT__ "PCApplyTranspose_FieldSplit"
1059421e10b8SBarry Smith static PetscErrorCode PCApplyTranspose_FieldSplit(PC pc,Vec x,Vec y)
1060421e10b8SBarry Smith {
1061421e10b8SBarry Smith   PC_FieldSplit     *jac = (PC_FieldSplit*)pc->data;
1062421e10b8SBarry Smith   PetscErrorCode    ierr;
1063421e10b8SBarry Smith   PC_FieldSplitLink ilink = jac->head;
1064939b8a20SBarry Smith   PetscInt          bs;
1065421e10b8SBarry Smith 
1066421e10b8SBarry Smith   PetscFunctionBegin;
1067421e10b8SBarry Smith   if (jac->type == PC_COMPOSITE_ADDITIVE) {
1068421e10b8SBarry Smith     if (jac->defaultsplit) {
1069939b8a20SBarry Smith       ierr = VecGetBlockSize(x,&bs);CHKERRQ(ierr);
1070ce94432eSBarry 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);
1071939b8a20SBarry Smith       ierr = VecGetBlockSize(y,&bs);CHKERRQ(ierr);
1072ce94432eSBarry 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);
1073421e10b8SBarry Smith       ierr = VecStrideGatherAll(x,jac->x,INSERT_VALUES);CHKERRQ(ierr);
1074421e10b8SBarry Smith       while (ilink) {
1075*9df09d43SBarry Smith         ierr = PetscLogEventBegin(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL);CHKERRQ(ierr);
1076421e10b8SBarry Smith         ierr  = KSPSolveTranspose(ilink->ksp,ilink->x,ilink->y);CHKERRQ(ierr);
1077*9df09d43SBarry Smith         ierr = PetscLogEventEnd(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL);CHKERRQ(ierr);
1078421e10b8SBarry Smith         ilink = ilink->next;
1079421e10b8SBarry Smith       }
1080421e10b8SBarry Smith       ierr = VecStrideScatterAll(jac->y,y,INSERT_VALUES);CHKERRQ(ierr);
1081421e10b8SBarry Smith     } else {
1082421e10b8SBarry Smith       ierr = VecSet(y,0.0);CHKERRQ(ierr);
1083421e10b8SBarry Smith       while (ilink) {
1084421e10b8SBarry Smith         ierr  = FieldSplitSplitSolveAddTranspose(ilink,x,y);CHKERRQ(ierr);
1085421e10b8SBarry Smith         ilink = ilink->next;
1086421e10b8SBarry Smith       }
1087421e10b8SBarry Smith     }
1088421e10b8SBarry Smith   } else {
1089421e10b8SBarry Smith     if (!jac->w1) {
1090421e10b8SBarry Smith       ierr = VecDuplicate(x,&jac->w1);CHKERRQ(ierr);
1091421e10b8SBarry Smith       ierr = VecDuplicate(x,&jac->w2);CHKERRQ(ierr);
1092421e10b8SBarry Smith     }
1093421e10b8SBarry Smith     ierr = VecSet(y,0.0);CHKERRQ(ierr);
1094421e10b8SBarry Smith     if (jac->type == PC_COMPOSITE_SYMMETRIC_MULTIPLICATIVE) {
1095421e10b8SBarry Smith       ierr = FieldSplitSplitSolveAddTranspose(ilink,x,y);CHKERRQ(ierr);
1096421e10b8SBarry Smith       while (ilink->next) {
1097421e10b8SBarry Smith         ilink = ilink->next;
10989989ab13SBarry Smith         ierr  = MatMultTranspose(pc->mat,y,jac->w1);CHKERRQ(ierr);
1099421e10b8SBarry Smith         ierr  = VecWAXPY(jac->w2,-1.0,jac->w1,x);CHKERRQ(ierr);
1100421e10b8SBarry Smith         ierr  = FieldSplitSplitSolveAddTranspose(ilink,jac->w2,y);CHKERRQ(ierr);
1101421e10b8SBarry Smith       }
1102421e10b8SBarry Smith       while (ilink->previous) {
1103421e10b8SBarry Smith         ilink = ilink->previous;
11049989ab13SBarry Smith         ierr  = MatMultTranspose(pc->mat,y,jac->w1);CHKERRQ(ierr);
1105421e10b8SBarry Smith         ierr  = VecWAXPY(jac->w2,-1.0,jac->w1,x);CHKERRQ(ierr);
1106421e10b8SBarry Smith         ierr  = FieldSplitSplitSolveAddTranspose(ilink,jac->w2,y);CHKERRQ(ierr);
1107421e10b8SBarry Smith       }
1108421e10b8SBarry Smith     } else {
1109421e10b8SBarry Smith       while (ilink->next) {   /* get to last entry in linked list */
1110421e10b8SBarry Smith         ilink = ilink->next;
1111421e10b8SBarry Smith       }
1112421e10b8SBarry Smith       ierr = FieldSplitSplitSolveAddTranspose(ilink,x,y);CHKERRQ(ierr);
1113421e10b8SBarry Smith       while (ilink->previous) {
1114421e10b8SBarry Smith         ilink = ilink->previous;
11159989ab13SBarry Smith         ierr  = MatMultTranspose(pc->mat,y,jac->w1);CHKERRQ(ierr);
1116421e10b8SBarry Smith         ierr  = VecWAXPY(jac->w2,-1.0,jac->w1,x);CHKERRQ(ierr);
1117421e10b8SBarry Smith         ierr  = FieldSplitSplitSolveAddTranspose(ilink,jac->w2,y);CHKERRQ(ierr);
1118421e10b8SBarry Smith       }
1119421e10b8SBarry Smith     }
1120421e10b8SBarry Smith   }
1121421e10b8SBarry Smith   PetscFunctionReturn(0);
1122421e10b8SBarry Smith }
1123421e10b8SBarry Smith 
11240971522cSBarry Smith #undef __FUNCT__
1125574deadeSBarry Smith #define __FUNCT__ "PCReset_FieldSplit"
1126574deadeSBarry Smith static PetscErrorCode PCReset_FieldSplit(PC pc)
11270971522cSBarry Smith {
11280971522cSBarry Smith   PC_FieldSplit     *jac = (PC_FieldSplit*)pc->data;
11290971522cSBarry Smith   PetscErrorCode    ierr;
11305a9f2f41SSatish Balay   PC_FieldSplitLink ilink = jac->head,next;
11310971522cSBarry Smith 
11320971522cSBarry Smith   PetscFunctionBegin;
11335a9f2f41SSatish Balay   while (ilink) {
1134574deadeSBarry Smith     ierr  = KSPReset(ilink->ksp);CHKERRQ(ierr);
1135fcfd50ebSBarry Smith     ierr  = VecDestroy(&ilink->x);CHKERRQ(ierr);
1136fcfd50ebSBarry Smith     ierr  = VecDestroy(&ilink->y);CHKERRQ(ierr);
1137443836d0SMatthew G Knepley     ierr  = VecDestroy(&ilink->z);CHKERRQ(ierr);
1138fcfd50ebSBarry Smith     ierr  = VecScatterDestroy(&ilink->sctx);CHKERRQ(ierr);
1139fcfd50ebSBarry Smith     ierr  = ISDestroy(&ilink->is);CHKERRQ(ierr);
1140b5787286SJed Brown     ierr  = ISDestroy(&ilink->is_col);CHKERRQ(ierr);
11415a9f2f41SSatish Balay     next  = ilink->next;
11425a9f2f41SSatish Balay     ilink = next;
11430971522cSBarry Smith   }
114405b42c5fSBarry Smith   ierr = PetscFree2(jac->x,jac->y);CHKERRQ(ierr);
1145574deadeSBarry Smith   if (jac->mat && jac->mat != jac->pmat) {
1146574deadeSBarry Smith     ierr = MatDestroyMatrices(jac->nsplits,&jac->mat);CHKERRQ(ierr);
1147574deadeSBarry Smith   } else if (jac->mat) {
11480298fd71SBarry Smith     jac->mat = NULL;
1149574deadeSBarry Smith   }
115097bbdb24SBarry Smith   if (jac->pmat) {ierr = MatDestroyMatrices(jac->nsplits,&jac->pmat);CHKERRQ(ierr);}
115168dd23aaSBarry Smith   if (jac->Afield) {ierr = MatDestroyMatrices(jac->nsplits,&jac->Afield);CHKERRQ(ierr);}
11526bf464f9SBarry Smith   ierr       = VecDestroy(&jac->w1);CHKERRQ(ierr);
11536bf464f9SBarry Smith   ierr       = VecDestroy(&jac->w2);CHKERRQ(ierr);
11546bf464f9SBarry Smith   ierr       = MatDestroy(&jac->schur);CHKERRQ(ierr);
1155a7476a74SDmitry Karpeev   ierr       = MatDestroy(&jac->schurp);CHKERRQ(ierr);
11566bf464f9SBarry Smith   ierr       = MatDestroy(&jac->schur_user);CHKERRQ(ierr);
11576bf464f9SBarry Smith   ierr       = KSPDestroy(&jac->kspschur);CHKERRQ(ierr);
1158d78dad28SBarry Smith   ierr       = KSPDestroy(&jac->kspupper);CHKERRQ(ierr);
11596bf464f9SBarry Smith   ierr       = MatDestroy(&jac->B);CHKERRQ(ierr);
11606bf464f9SBarry Smith   ierr       = MatDestroy(&jac->C);CHKERRQ(ierr);
116163ec74ffSBarry Smith   jac->reset = PETSC_TRUE;
1162574deadeSBarry Smith   PetscFunctionReturn(0);
1163574deadeSBarry Smith }
1164574deadeSBarry Smith 
1165574deadeSBarry Smith #undef __FUNCT__
1166574deadeSBarry Smith #define __FUNCT__ "PCDestroy_FieldSplit"
1167574deadeSBarry Smith static PetscErrorCode PCDestroy_FieldSplit(PC pc)
1168574deadeSBarry Smith {
1169574deadeSBarry Smith   PC_FieldSplit     *jac = (PC_FieldSplit*)pc->data;
1170574deadeSBarry Smith   PetscErrorCode    ierr;
1171574deadeSBarry Smith   PC_FieldSplitLink ilink = jac->head,next;
1172574deadeSBarry Smith 
1173574deadeSBarry Smith   PetscFunctionBegin;
1174574deadeSBarry Smith   ierr = PCReset_FieldSplit(pc);CHKERRQ(ierr);
1175574deadeSBarry Smith   while (ilink) {
11766bf464f9SBarry Smith     ierr  = KSPDestroy(&ilink->ksp);CHKERRQ(ierr);
1177574deadeSBarry Smith     next  = ilink->next;
1178574deadeSBarry Smith     ierr  = PetscFree(ilink->splitname);CHKERRQ(ierr);
1179574deadeSBarry Smith     ierr  = PetscFree(ilink->fields);CHKERRQ(ierr);
11805d4c12cdSJungho Lee     ierr  = PetscFree(ilink->fields_col);CHKERRQ(ierr);
1181574deadeSBarry Smith     ierr  = PetscFree(ilink);CHKERRQ(ierr);
1182574deadeSBarry Smith     ilink = next;
1183574deadeSBarry Smith   }
1184574deadeSBarry Smith   ierr = PetscFree2(jac->x,jac->y);CHKERRQ(ierr);
1185c31cb41cSBarry Smith   ierr = PetscFree(pc->data);CHKERRQ(ierr);
1186bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitGetSubKSP_C",NULL);CHKERRQ(ierr);
1187bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetFields_C",NULL);CHKERRQ(ierr);
1188bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetIS_C",NULL);CHKERRQ(ierr);
1189bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetType_C",NULL);CHKERRQ(ierr);
1190bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetBlockSize_C",NULL);CHKERRQ(ierr);
119129f8a81cSJed Brown   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetSchurPre_C",NULL);CHKERRQ(ierr);
119237a82bf0SJed Brown   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitGetSchurPre_C",NULL);CHKERRQ(ierr);
1193bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetSchurFactType_C",NULL);CHKERRQ(ierr);
11940971522cSBarry Smith   PetscFunctionReturn(0);
11950971522cSBarry Smith }
11960971522cSBarry Smith 
11970971522cSBarry Smith #undef __FUNCT__
11980971522cSBarry Smith #define __FUNCT__ "PCSetFromOptions_FieldSplit"
11998c34d3f5SBarry Smith static PetscErrorCode PCSetFromOptions_FieldSplit(PetscOptions *PetscOptionsObject,PC pc)
12000971522cSBarry Smith {
12011b9fc7fcSBarry Smith   PetscErrorCode  ierr;
12026c924f48SJed Brown   PetscInt        bs;
1203bc59fbc5SBarry Smith   PetscBool       flg,stokes = PETSC_FALSE;
12049dcbbd2bSBarry Smith   PC_FieldSplit   *jac = (PC_FieldSplit*)pc->data;
12053b224e63SBarry Smith   PCCompositeType ctype;
12061b9fc7fcSBarry Smith 
12070971522cSBarry Smith   PetscFunctionBegin;
1208e55864a3SBarry Smith   ierr = PetscOptionsHead(PetscOptionsObject,"FieldSplit options");CHKERRQ(ierr);
12094ab8060aSDmitry Karpeev   ierr = PetscOptionsBool("-pc_fieldsplit_dm_splits","Whether to use DMCreateFieldDecomposition() for splits","PCFieldSplitSetDMSplits",jac->dm_splits,&jac->dm_splits,NULL);CHKERRQ(ierr);
121051f519a2SBarry Smith   ierr = PetscOptionsInt("-pc_fieldsplit_block_size","Blocksize that defines number of fields","PCFieldSplitSetBlockSize",jac->bs,&bs,&flg);CHKERRQ(ierr);
121151f519a2SBarry Smith   if (flg) {
121251f519a2SBarry Smith     ierr = PCFieldSplitSetBlockSize(pc,bs);CHKERRQ(ierr);
121351f519a2SBarry Smith   }
12142686e3e9SMatthew G. Knepley   jac->diag_use_amat = pc->useAmat;
12152686e3e9SMatthew 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);
12162686e3e9SMatthew G. Knepley   jac->offdiag_use_amat = pc->useAmat;
12172686e3e9SMatthew 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);
121800216929SDmitry Karpeev   /* FIXME: No programmatic equivalent to the following. */
12190298fd71SBarry Smith   ierr = PetscOptionsGetBool(((PetscObject)pc)->prefix,"-pc_fieldsplit_detect_saddle_point",&stokes,NULL);CHKERRQ(ierr);
1220c0adfefeSBarry Smith   if (stokes) {
1221c0adfefeSBarry Smith     ierr          = PCFieldSplitSetType(pc,PC_COMPOSITE_SCHUR);CHKERRQ(ierr);
1222c0adfefeSBarry Smith     jac->schurpre = PC_FIELDSPLIT_SCHUR_PRE_SELF;
1223c0adfefeSBarry Smith   }
1224c0adfefeSBarry Smith 
12253b224e63SBarry Smith   ierr = PetscOptionsEnum("-pc_fieldsplit_type","Type of composition","PCFieldSplitSetType",PCCompositeTypes,(PetscEnum)jac->type,(PetscEnum*)&ctype,&flg);CHKERRQ(ierr);
12263b224e63SBarry Smith   if (flg) {
12273b224e63SBarry Smith     ierr = PCFieldSplitSetType(pc,ctype);CHKERRQ(ierr);
12283b224e63SBarry Smith   }
1229c30613efSMatthew Knepley   /* Only setup fields once */
1230c30613efSMatthew Knepley   if ((jac->bs > 0) && (jac->nsplits == 0)) {
1231d32f9abdSBarry Smith     /* only allow user to set fields from command line if bs is already known.
1232d32f9abdSBarry Smith        otherwise user can set them in PCFieldSplitSetDefaults() */
12336c924f48SJed Brown     ierr = PCFieldSplitSetRuntimeSplits_Private(pc);CHKERRQ(ierr);
12346c924f48SJed Brown     if (jac->splitdefined) {ierr = PetscInfo(pc,"Splits defined using the options database\n");CHKERRQ(ierr);}
1235d32f9abdSBarry Smith   }
1236c5d2311dSJed Brown   if (jac->type == PC_COMPOSITE_SCHUR) {
1237c9c6ffaaSJed Brown     ierr = PetscOptionsGetEnum(((PetscObject)pc)->prefix,"-pc_fieldsplit_schur_factorization_type",PCFieldSplitSchurFactTypes,(PetscEnum*)&jac->schurfactorization,&flg);CHKERRQ(ierr);
1238c9c6ffaaSJed Brown     if (flg) {ierr = PetscInfo(pc,"Deprecated use of -pc_fieldsplit_schur_factorization_type\n");CHKERRQ(ierr);}
12390298fd71SBarry 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);
124029f8a81cSJed 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);
1241c5d2311dSJed Brown   }
12421b9fc7fcSBarry Smith   ierr = PetscOptionsTail();CHKERRQ(ierr);
12430971522cSBarry Smith   PetscFunctionReturn(0);
12440971522cSBarry Smith }
12450971522cSBarry Smith 
12460971522cSBarry Smith /*------------------------------------------------------------------------------------*/
12470971522cSBarry Smith 
12480971522cSBarry Smith #undef __FUNCT__
12490971522cSBarry Smith #define __FUNCT__ "PCFieldSplitSetFields_FieldSplit"
12501e6b0712SBarry Smith static PetscErrorCode  PCFieldSplitSetFields_FieldSplit(PC pc,const char splitname[],PetscInt n,const PetscInt *fields,const PetscInt *fields_col)
12510971522cSBarry Smith {
125297bbdb24SBarry Smith   PC_FieldSplit     *jac = (PC_FieldSplit*)pc->data;
12530971522cSBarry Smith   PetscErrorCode    ierr;
12545a9f2f41SSatish Balay   PC_FieldSplitLink ilink,next = jac->head;
125569a612a9SBarry Smith   char              prefix[128];
12565d4c12cdSJungho Lee   PetscInt          i;
12570971522cSBarry Smith 
12580971522cSBarry Smith   PetscFunctionBegin;
12596c924f48SJed Brown   if (jac->splitdefined) {
12606c924f48SJed Brown     ierr = PetscInfo1(pc,"Ignoring new split \"%s\" because the splits have already been defined\n",splitname);CHKERRQ(ierr);
12616c924f48SJed Brown     PetscFunctionReturn(0);
12626c924f48SJed Brown   }
126351f519a2SBarry Smith   for (i=0; i<n; i++) {
1264e32f2f54SBarry 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);
1265e32f2f54SBarry Smith     if (fields[i] < 0) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Negative field %D requested",fields[i]);
126651f519a2SBarry Smith   }
1267b00a9115SJed Brown   ierr = PetscNew(&ilink);CHKERRQ(ierr);
1268a04f6461SBarry Smith   if (splitname) {
1269db4c96c1SJed Brown     ierr = PetscStrallocpy(splitname,&ilink->splitname);CHKERRQ(ierr);
1270a04f6461SBarry Smith   } else {
1271785e854fSJed Brown     ierr = PetscMalloc1(3,&ilink->splitname);CHKERRQ(ierr);
1272a04f6461SBarry Smith     ierr = PetscSNPrintf(ilink->splitname,2,"%s",jac->nsplits);CHKERRQ(ierr);
1273a04f6461SBarry Smith   }
1274*9df09d43SBarry 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 */
1275785e854fSJed Brown   ierr = PetscMalloc1(n,&ilink->fields);CHKERRQ(ierr);
12765a9f2f41SSatish Balay   ierr = PetscMemcpy(ilink->fields,fields,n*sizeof(PetscInt));CHKERRQ(ierr);
1277785e854fSJed Brown   ierr = PetscMalloc1(n,&ilink->fields_col);CHKERRQ(ierr);
12785d4c12cdSJungho Lee   ierr = PetscMemcpy(ilink->fields_col,fields_col,n*sizeof(PetscInt));CHKERRQ(ierr);
12792fa5cd67SKarl Rupp 
12805a9f2f41SSatish Balay   ilink->nfields = n;
12810298fd71SBarry Smith   ilink->next    = NULL;
1282ce94432eSBarry Smith   ierr           = KSPCreate(PetscObjectComm((PetscObject)pc),&ilink->ksp);CHKERRQ(ierr);
1283422a814eSBarry Smith   ierr           = KSPSetErrorIfNotConverged(ilink->ksp,pc->erroriffailure);CHKERRQ(ierr);
128420252d06SBarry Smith   ierr           = PetscObjectIncrementTabLevel((PetscObject)ilink->ksp,(PetscObject)pc,1);CHKERRQ(ierr);
12855a9f2f41SSatish Balay   ierr           = KSPSetType(ilink->ksp,KSPPREONLY);CHKERRQ(ierr);
12869005cf84SBarry Smith   ierr           = PetscLogObjectParent((PetscObject)pc,(PetscObject)ilink->ksp);CHKERRQ(ierr);
128769a612a9SBarry Smith 
12888caf3d72SBarry Smith   ierr = PetscSNPrintf(prefix,sizeof(prefix),"%sfieldsplit_%s_",((PetscObject)pc)->prefix ? ((PetscObject)pc)->prefix : "",ilink->splitname);CHKERRQ(ierr);
12895a9f2f41SSatish Balay   ierr = KSPSetOptionsPrefix(ilink->ksp,prefix);CHKERRQ(ierr);
12900971522cSBarry Smith 
12910971522cSBarry Smith   if (!next) {
12925a9f2f41SSatish Balay     jac->head       = ilink;
12930298fd71SBarry Smith     ilink->previous = NULL;
12940971522cSBarry Smith   } else {
12950971522cSBarry Smith     while (next->next) {
12960971522cSBarry Smith       next = next->next;
12970971522cSBarry Smith     }
12985a9f2f41SSatish Balay     next->next      = ilink;
129951f519a2SBarry Smith     ilink->previous = next;
13000971522cSBarry Smith   }
13010971522cSBarry Smith   jac->nsplits++;
13020971522cSBarry Smith   PetscFunctionReturn(0);
13030971522cSBarry Smith }
13040971522cSBarry Smith 
1305e69d4d44SBarry Smith #undef __FUNCT__
1306e69d4d44SBarry Smith #define __FUNCT__ "PCFieldSplitGetSubKSP_FieldSplit_Schur"
13071e6b0712SBarry Smith static PetscErrorCode  PCFieldSplitGetSubKSP_FieldSplit_Schur(PC pc,PetscInt *n,KSP **subksp)
1308e69d4d44SBarry Smith {
1309e69d4d44SBarry Smith   PC_FieldSplit  *jac = (PC_FieldSplit*)pc->data;
1310e69d4d44SBarry Smith   PetscErrorCode ierr;
1311e69d4d44SBarry Smith 
1312e69d4d44SBarry Smith   PetscFunctionBegin;
1313785e854fSJed Brown   ierr = PetscMalloc1(jac->nsplits,subksp);CHKERRQ(ierr);
1314e69d4d44SBarry Smith   ierr = MatSchurComplementGetKSP(jac->schur,*subksp);CHKERRQ(ierr);
13152fa5cd67SKarl Rupp 
1316e69d4d44SBarry Smith   (*subksp)[1] = jac->kspschur;
131713e0d083SBarry Smith   if (n) *n = jac->nsplits;
1318e69d4d44SBarry Smith   PetscFunctionReturn(0);
1319e69d4d44SBarry Smith }
13200971522cSBarry Smith 
13210971522cSBarry Smith #undef __FUNCT__
132269a612a9SBarry Smith #define __FUNCT__ "PCFieldSplitGetSubKSP_FieldSplit"
13231e6b0712SBarry Smith static PetscErrorCode  PCFieldSplitGetSubKSP_FieldSplit(PC pc,PetscInt *n,KSP **subksp)
13240971522cSBarry Smith {
13250971522cSBarry Smith   PC_FieldSplit     *jac = (PC_FieldSplit*)pc->data;
13260971522cSBarry Smith   PetscErrorCode    ierr;
13270971522cSBarry Smith   PetscInt          cnt   = 0;
13285a9f2f41SSatish Balay   PC_FieldSplitLink ilink = jac->head;
13290971522cSBarry Smith 
13300971522cSBarry Smith   PetscFunctionBegin;
1331785e854fSJed Brown   ierr = PetscMalloc1(jac->nsplits,subksp);CHKERRQ(ierr);
13325a9f2f41SSatish Balay   while (ilink) {
13335a9f2f41SSatish Balay     (*subksp)[cnt++] = ilink->ksp;
13345a9f2f41SSatish Balay     ilink            = ilink->next;
13350971522cSBarry Smith   }
13365d480477SMatthew 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);
133713e0d083SBarry Smith   if (n) *n = jac->nsplits;
13380971522cSBarry Smith   PetscFunctionReturn(0);
13390971522cSBarry Smith }
13400971522cSBarry Smith 
1341704ba839SBarry Smith #undef __FUNCT__
1342704ba839SBarry Smith #define __FUNCT__ "PCFieldSplitSetIS_FieldSplit"
13431e6b0712SBarry Smith static PetscErrorCode  PCFieldSplitSetIS_FieldSplit(PC pc,const char splitname[],IS is)
1344704ba839SBarry Smith {
1345704ba839SBarry Smith   PC_FieldSplit     *jac = (PC_FieldSplit*)pc->data;
1346704ba839SBarry Smith   PetscErrorCode    ierr;
1347704ba839SBarry Smith   PC_FieldSplitLink ilink, next = jac->head;
1348704ba839SBarry Smith   char              prefix[128];
1349704ba839SBarry Smith 
1350704ba839SBarry Smith   PetscFunctionBegin;
13516c924f48SJed Brown   if (jac->splitdefined) {
13526c924f48SJed Brown     ierr = PetscInfo1(pc,"Ignoring new split \"%s\" because the splits have already been defined\n",splitname);CHKERRQ(ierr);
13536c924f48SJed Brown     PetscFunctionReturn(0);
13546c924f48SJed Brown   }
1355b00a9115SJed Brown   ierr = PetscNew(&ilink);CHKERRQ(ierr);
1356a04f6461SBarry Smith   if (splitname) {
1357db4c96c1SJed Brown     ierr = PetscStrallocpy(splitname,&ilink->splitname);CHKERRQ(ierr);
1358a04f6461SBarry Smith   } else {
1359785e854fSJed Brown     ierr = PetscMalloc1(8,&ilink->splitname);CHKERRQ(ierr);
1360b5787286SJed Brown     ierr = PetscSNPrintf(ilink->splitname,7,"%D",jac->nsplits);CHKERRQ(ierr);
1361a04f6461SBarry Smith   }
1362*9df09d43SBarry 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 */
13631ab39975SBarry Smith   ierr          = PetscObjectReference((PetscObject)is);CHKERRQ(ierr);
1364b5787286SJed Brown   ierr          = ISDestroy(&ilink->is);CHKERRQ(ierr);
1365b5787286SJed Brown   ilink->is     = is;
1366b5787286SJed Brown   ierr          = PetscObjectReference((PetscObject)is);CHKERRQ(ierr);
1367b5787286SJed Brown   ierr          = ISDestroy(&ilink->is_col);CHKERRQ(ierr);
1368b5787286SJed Brown   ilink->is_col = is;
13690298fd71SBarry Smith   ilink->next   = NULL;
1370ce94432eSBarry Smith   ierr          = KSPCreate(PetscObjectComm((PetscObject)pc),&ilink->ksp);CHKERRQ(ierr);
1371422a814eSBarry Smith   ierr          = KSPSetErrorIfNotConverged(ilink->ksp,pc->erroriffailure);CHKERRQ(ierr);
137220252d06SBarry Smith   ierr          = PetscObjectIncrementTabLevel((PetscObject)ilink->ksp,(PetscObject)pc,1);CHKERRQ(ierr);
1373704ba839SBarry Smith   ierr          = KSPSetType(ilink->ksp,KSPPREONLY);CHKERRQ(ierr);
13749005cf84SBarry Smith   ierr          = PetscLogObjectParent((PetscObject)pc,(PetscObject)ilink->ksp);CHKERRQ(ierr);
1375704ba839SBarry Smith 
13768caf3d72SBarry Smith   ierr = PetscSNPrintf(prefix,sizeof(prefix),"%sfieldsplit_%s_",((PetscObject)pc)->prefix ? ((PetscObject)pc)->prefix : "",ilink->splitname);CHKERRQ(ierr);
1377704ba839SBarry Smith   ierr = KSPSetOptionsPrefix(ilink->ksp,prefix);CHKERRQ(ierr);
1378704ba839SBarry Smith 
1379704ba839SBarry Smith   if (!next) {
1380704ba839SBarry Smith     jac->head       = ilink;
13810298fd71SBarry Smith     ilink->previous = NULL;
1382704ba839SBarry Smith   } else {
1383704ba839SBarry Smith     while (next->next) {
1384704ba839SBarry Smith       next = next->next;
1385704ba839SBarry Smith     }
1386704ba839SBarry Smith     next->next      = ilink;
1387704ba839SBarry Smith     ilink->previous = next;
1388704ba839SBarry Smith   }
1389704ba839SBarry Smith   jac->nsplits++;
1390704ba839SBarry Smith   PetscFunctionReturn(0);
1391704ba839SBarry Smith }
1392704ba839SBarry Smith 
13930971522cSBarry Smith #undef __FUNCT__
13940971522cSBarry Smith #define __FUNCT__ "PCFieldSplitSetFields"
13950971522cSBarry Smith /*@
13960971522cSBarry Smith     PCFieldSplitSetFields - Sets the fields for one particular split in the field split preconditioner
13970971522cSBarry Smith 
1398ad4df100SBarry Smith     Logically Collective on PC
13990971522cSBarry Smith 
14000971522cSBarry Smith     Input Parameters:
14010971522cSBarry Smith +   pc  - the preconditioner context
14020298fd71SBarry Smith .   splitname - name of this split, if NULL the number of the split is used
14030971522cSBarry Smith .   n - the number of fields in this split
1404db4c96c1SJed Brown -   fields - the fields in this split
14050971522cSBarry Smith 
14060971522cSBarry Smith     Level: intermediate
14070971522cSBarry Smith 
1408d32f9abdSBarry Smith     Notes: Use PCFieldSplitSetIS() to set a completely general set of indices as a field.
1409d32f9abdSBarry Smith 
14107287d2a3SDmitry Karpeev      The PCFieldSplitSetFields() is for defining fields as strided blocks. For example, if the block
1411d32f9abdSBarry 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
1412d32f9abdSBarry Smith      0xx3xx6xx9xx12 ... x1xx4xx7xx ... xx2xx5xx8xx.. 01x34x67x... 0x1x3x5x7.. x12x45x78x....
1413d32f9abdSBarry Smith      where the numbered entries indicate what is in the field.
1414d32f9abdSBarry Smith 
1415db4c96c1SJed Brown      This function is called once per split (it creates a new split each time).  Solve options
1416db4c96c1SJed Brown      for this split will be available under the prefix -fieldsplit_SPLITNAME_.
1417db4c96c1SJed Brown 
14185d4c12cdSJungho Lee      Developer Note: This routine does not actually create the IS representing the split, that is delayed
14195d4c12cdSJungho Lee      until PCSetUp_FieldSplit(), because information about the vector/matrix layouts may not be
14205d4c12cdSJungho Lee      available when this routine is called.
14215d4c12cdSJungho Lee 
1422d32f9abdSBarry Smith .seealso: PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitSetBlockSize(), PCFieldSplitSetIS()
14230971522cSBarry Smith 
14240971522cSBarry Smith @*/
14255d4c12cdSJungho Lee PetscErrorCode  PCFieldSplitSetFields(PC pc,const char splitname[],PetscInt n,const PetscInt *fields,const PetscInt *fields_col)
14260971522cSBarry Smith {
14274ac538c5SBarry Smith   PetscErrorCode ierr;
14280971522cSBarry Smith 
14290971522cSBarry Smith   PetscFunctionBegin;
14300700a824SBarry Smith   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
1431db4c96c1SJed Brown   PetscValidCharPointer(splitname,2);
1432ce94432eSBarry Smith   if (n < 1) SETERRQ2(PetscObjectComm((PetscObject)pc),PETSC_ERR_ARG_OUTOFRANGE,"Provided number of fields %D in split \"%s\" not positive",n,splitname);
1433db4c96c1SJed Brown   PetscValidIntPointer(fields,3);
14345d4c12cdSJungho Lee   ierr = PetscTryMethod(pc,"PCFieldSplitSetFields_C",(PC,const char[],PetscInt,const PetscInt*,const PetscInt*),(pc,splitname,n,fields,fields_col));CHKERRQ(ierr);
14350971522cSBarry Smith   PetscFunctionReturn(0);
14360971522cSBarry Smith }
14370971522cSBarry Smith 
14380971522cSBarry Smith #undef __FUNCT__
1439c84da90fSDmitry Karpeev #define __FUNCT__ "PCFieldSplitSetDiagUseAmat"
1440c84da90fSDmitry Karpeev /*@
1441c84da90fSDmitry Karpeev     PCFieldSplitSetDiagUseAmat - set flag indicating whether to extract diagonal blocks from Amat (rather than Pmat)
1442c84da90fSDmitry Karpeev 
1443c84da90fSDmitry Karpeev     Logically Collective on PC
1444c84da90fSDmitry Karpeev 
1445c84da90fSDmitry Karpeev     Input Parameters:
1446c84da90fSDmitry Karpeev +   pc  - the preconditioner object
1447c84da90fSDmitry Karpeev -   flg - boolean flag indicating whether or not to use Amat to extract the diagonal blocks from
1448c84da90fSDmitry Karpeev 
14499506b623SDmitry Karpeev     Options Database:
14509506b623SDmitry Karpeev .     -pc_fieldsplit_diag_use_amat
1451c84da90fSDmitry Karpeev 
1452c84da90fSDmitry Karpeev     Level: intermediate
1453c84da90fSDmitry Karpeev 
1454c84da90fSDmitry Karpeev .seealso: PCFieldSplitGetDiagUseAmat(), PCFieldSplitSetOffDiagUseAmat(), PCFIELDSPLIT
1455c84da90fSDmitry Karpeev 
1456c84da90fSDmitry Karpeev @*/
1457c84da90fSDmitry Karpeev PetscErrorCode  PCFieldSplitSetDiagUseAmat(PC pc,PetscBool flg)
1458c84da90fSDmitry Karpeev {
1459c84da90fSDmitry Karpeev   PC_FieldSplit  *jac = (PC_FieldSplit*)pc->data;
1460c84da90fSDmitry Karpeev   PetscBool      isfs;
1461c84da90fSDmitry Karpeev   PetscErrorCode ierr;
1462c84da90fSDmitry Karpeev 
1463c84da90fSDmitry Karpeev   PetscFunctionBegin;
1464c84da90fSDmitry Karpeev   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
1465c84da90fSDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)pc,PCFIELDSPLIT,&isfs);CHKERRQ(ierr);
1466c84da90fSDmitry Karpeev   if (!isfs) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"PC not of type %s",PCFIELDSPLIT);
1467c84da90fSDmitry Karpeev   jac->diag_use_amat = flg;
1468c84da90fSDmitry Karpeev   PetscFunctionReturn(0);
1469c84da90fSDmitry Karpeev }
1470c84da90fSDmitry Karpeev 
1471c84da90fSDmitry Karpeev #undef __FUNCT__
1472c84da90fSDmitry Karpeev #define __FUNCT__ "PCFieldSplitGetDiagUseAmat"
1473c84da90fSDmitry Karpeev /*@
1474c84da90fSDmitry Karpeev     PCFieldSplitGetDiagUseAmat - get the flag indicating whether to extract diagonal blocks from Amat (rather than Pmat)
1475c84da90fSDmitry Karpeev 
1476c84da90fSDmitry Karpeev     Logically Collective on PC
1477c84da90fSDmitry Karpeev 
1478c84da90fSDmitry Karpeev     Input Parameters:
1479c84da90fSDmitry Karpeev .   pc  - the preconditioner object
1480c84da90fSDmitry Karpeev 
1481c84da90fSDmitry Karpeev     Output Parameters:
1482c84da90fSDmitry Karpeev .   flg - boolean flag indicating whether or not to use Amat to extract the diagonal blocks from
1483c84da90fSDmitry Karpeev 
1484c84da90fSDmitry Karpeev 
1485c84da90fSDmitry Karpeev     Level: intermediate
1486c84da90fSDmitry Karpeev 
1487c84da90fSDmitry Karpeev .seealso: PCFieldSplitSetDiagUseAmat(), PCFieldSplitGetOffDiagUseAmat(), PCFIELDSPLIT
1488c84da90fSDmitry Karpeev 
1489c84da90fSDmitry Karpeev @*/
1490c84da90fSDmitry Karpeev PetscErrorCode  PCFieldSplitGetDiagUseAmat(PC pc,PetscBool *flg)
1491c84da90fSDmitry Karpeev {
1492c84da90fSDmitry Karpeev   PC_FieldSplit  *jac = (PC_FieldSplit*)pc->data;
1493c84da90fSDmitry Karpeev   PetscBool      isfs;
1494c84da90fSDmitry Karpeev   PetscErrorCode ierr;
1495c84da90fSDmitry Karpeev 
1496c84da90fSDmitry Karpeev   PetscFunctionBegin;
1497c84da90fSDmitry Karpeev   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
1498c84da90fSDmitry Karpeev   PetscValidPointer(flg,2);
1499c84da90fSDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)pc,PCFIELDSPLIT,&isfs);CHKERRQ(ierr);
1500c84da90fSDmitry Karpeev   if (!isfs) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"PC not of type %s",PCFIELDSPLIT);
1501c84da90fSDmitry Karpeev   *flg = jac->diag_use_amat;
1502c84da90fSDmitry Karpeev   PetscFunctionReturn(0);
1503c84da90fSDmitry Karpeev }
1504c84da90fSDmitry Karpeev 
1505c84da90fSDmitry Karpeev #undef __FUNCT__
1506c84da90fSDmitry Karpeev #define __FUNCT__ "PCFieldSplitSetOffDiagUseAmat"
1507c84da90fSDmitry Karpeev /*@
1508c84da90fSDmitry Karpeev     PCFieldSplitSetOffDiagUseAmat - set flag indicating whether to extract off-diagonal blocks from Amat (rather than Pmat)
1509c84da90fSDmitry Karpeev 
1510c84da90fSDmitry Karpeev     Logically Collective on PC
1511c84da90fSDmitry Karpeev 
1512c84da90fSDmitry Karpeev     Input Parameters:
1513c84da90fSDmitry Karpeev +   pc  - the preconditioner object
1514c84da90fSDmitry Karpeev -   flg - boolean flag indicating whether or not to use Amat to extract the off-diagonal blocks from
1515c84da90fSDmitry Karpeev 
15169506b623SDmitry Karpeev     Options Database:
15179506b623SDmitry Karpeev .     -pc_fieldsplit_off_diag_use_amat
1518c84da90fSDmitry Karpeev 
1519c84da90fSDmitry Karpeev     Level: intermediate
1520c84da90fSDmitry Karpeev 
1521c84da90fSDmitry Karpeev .seealso: PCFieldSplitGetOffDiagUseAmat(), PCFieldSplitSetDiagUseAmat(), PCFIELDSPLIT
1522c84da90fSDmitry Karpeev 
1523c84da90fSDmitry Karpeev @*/
1524c84da90fSDmitry Karpeev PetscErrorCode  PCFieldSplitSetOffDiagUseAmat(PC pc,PetscBool flg)
1525c84da90fSDmitry Karpeev {
1526c84da90fSDmitry Karpeev   PC_FieldSplit *jac = (PC_FieldSplit*)pc->data;
1527c84da90fSDmitry Karpeev   PetscBool      isfs;
1528c84da90fSDmitry Karpeev   PetscErrorCode ierr;
1529c84da90fSDmitry Karpeev 
1530c84da90fSDmitry Karpeev   PetscFunctionBegin;
1531c84da90fSDmitry Karpeev   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
1532c84da90fSDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)pc,PCFIELDSPLIT,&isfs);CHKERRQ(ierr);
1533c84da90fSDmitry Karpeev   if (!isfs) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"PC not of type %s",PCFIELDSPLIT);
1534c84da90fSDmitry Karpeev   jac->offdiag_use_amat = flg;
1535c84da90fSDmitry Karpeev   PetscFunctionReturn(0);
1536c84da90fSDmitry Karpeev }
1537c84da90fSDmitry Karpeev 
1538c84da90fSDmitry Karpeev #undef __FUNCT__
1539c84da90fSDmitry Karpeev #define __FUNCT__ "PCFieldSplitGetOffDiagUseAmat"
1540c84da90fSDmitry Karpeev /*@
1541c84da90fSDmitry Karpeev     PCFieldSplitGetOffDiagUseAmat - get the flag indicating whether to extract off-diagonal blocks from Amat (rather than Pmat)
1542c84da90fSDmitry Karpeev 
1543c84da90fSDmitry Karpeev     Logically Collective on PC
1544c84da90fSDmitry Karpeev 
1545c84da90fSDmitry Karpeev     Input Parameters:
1546c84da90fSDmitry Karpeev .   pc  - the preconditioner object
1547c84da90fSDmitry Karpeev 
1548c84da90fSDmitry Karpeev     Output Parameters:
1549c84da90fSDmitry Karpeev .   flg - boolean flag indicating whether or not to use Amat to extract the off-diagonal blocks from
1550c84da90fSDmitry Karpeev 
1551c84da90fSDmitry Karpeev 
1552c84da90fSDmitry Karpeev     Level: intermediate
1553c84da90fSDmitry Karpeev 
1554c84da90fSDmitry Karpeev .seealso: PCFieldSplitSetOffDiagUseAmat(), PCFieldSplitGetDiagUseAmat(), PCFIELDSPLIT
1555c84da90fSDmitry Karpeev 
1556c84da90fSDmitry Karpeev @*/
1557c84da90fSDmitry Karpeev PetscErrorCode  PCFieldSplitGetOffDiagUseAmat(PC pc,PetscBool *flg)
1558c84da90fSDmitry Karpeev {
1559c84da90fSDmitry Karpeev   PC_FieldSplit  *jac = (PC_FieldSplit*)pc->data;
1560c84da90fSDmitry Karpeev   PetscBool      isfs;
1561c84da90fSDmitry Karpeev   PetscErrorCode ierr;
1562c84da90fSDmitry Karpeev 
1563c84da90fSDmitry Karpeev   PetscFunctionBegin;
1564c84da90fSDmitry Karpeev   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
1565c84da90fSDmitry Karpeev   PetscValidPointer(flg,2);
1566c84da90fSDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)pc,PCFIELDSPLIT,&isfs);CHKERRQ(ierr);
1567c84da90fSDmitry Karpeev   if (!isfs) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"PC not of type %s",PCFIELDSPLIT);
1568c84da90fSDmitry Karpeev   *flg = jac->offdiag_use_amat;
1569c84da90fSDmitry Karpeev   PetscFunctionReturn(0);
1570c84da90fSDmitry Karpeev }
1571c84da90fSDmitry Karpeev 
1572c84da90fSDmitry Karpeev 
1573c84da90fSDmitry Karpeev 
1574c84da90fSDmitry Karpeev #undef __FUNCT__
1575704ba839SBarry Smith #define __FUNCT__ "PCFieldSplitSetIS"
1576218d4943SBarry Smith /*@C
1577704ba839SBarry Smith     PCFieldSplitSetIS - Sets the exact elements for field
1578704ba839SBarry Smith 
1579ad4df100SBarry Smith     Logically Collective on PC
1580704ba839SBarry Smith 
1581704ba839SBarry Smith     Input Parameters:
1582704ba839SBarry Smith +   pc  - the preconditioner context
15830298fd71SBarry Smith .   splitname - name of this split, if NULL the number of the split is used
1584db4c96c1SJed Brown -   is - the index set that defines the vector elements in this field
1585704ba839SBarry Smith 
1586d32f9abdSBarry Smith 
1587a6ffb8dbSJed Brown     Notes:
1588a6ffb8dbSJed Brown     Use PCFieldSplitSetFields(), for fields defined by strided types.
1589a6ffb8dbSJed Brown 
1590db4c96c1SJed Brown     This function is called once per split (it creates a new split each time).  Solve options
1591db4c96c1SJed Brown     for this split will be available under the prefix -fieldsplit_SPLITNAME_.
1592d32f9abdSBarry Smith 
1593704ba839SBarry Smith     Level: intermediate
1594704ba839SBarry Smith 
1595704ba839SBarry Smith .seealso: PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitSetBlockSize()
1596704ba839SBarry Smith 
1597704ba839SBarry Smith @*/
15987087cfbeSBarry Smith PetscErrorCode  PCFieldSplitSetIS(PC pc,const char splitname[],IS is)
1599704ba839SBarry Smith {
16004ac538c5SBarry Smith   PetscErrorCode ierr;
1601704ba839SBarry Smith 
1602704ba839SBarry Smith   PetscFunctionBegin;
16030700a824SBarry Smith   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
16047b62db95SJungho Lee   if (splitname) PetscValidCharPointer(splitname,2);
1605db4c96c1SJed Brown   PetscValidHeaderSpecific(is,IS_CLASSID,3);
16064ac538c5SBarry Smith   ierr = PetscTryMethod(pc,"PCFieldSplitSetIS_C",(PC,const char[],IS),(pc,splitname,is));CHKERRQ(ierr);
1607704ba839SBarry Smith   PetscFunctionReturn(0);
1608704ba839SBarry Smith }
1609704ba839SBarry Smith 
1610704ba839SBarry Smith #undef __FUNCT__
161157a9adfeSMatthew G Knepley #define __FUNCT__ "PCFieldSplitGetIS"
161257a9adfeSMatthew G Knepley /*@
161357a9adfeSMatthew G Knepley     PCFieldSplitGetIS - Retrieves the elements for a field as an IS
161457a9adfeSMatthew G Knepley 
161557a9adfeSMatthew G Knepley     Logically Collective on PC
161657a9adfeSMatthew G Knepley 
161757a9adfeSMatthew G Knepley     Input Parameters:
161857a9adfeSMatthew G Knepley +   pc  - the preconditioner context
161957a9adfeSMatthew G Knepley -   splitname - name of this split
162057a9adfeSMatthew G Knepley 
162157a9adfeSMatthew G Knepley     Output Parameter:
16220298fd71SBarry Smith -   is - the index set that defines the vector elements in this field, or NULL if the field is not found
162357a9adfeSMatthew G Knepley 
162457a9adfeSMatthew G Knepley     Level: intermediate
162557a9adfeSMatthew G Knepley 
162657a9adfeSMatthew G Knepley .seealso: PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitSetIS()
162757a9adfeSMatthew G Knepley 
162857a9adfeSMatthew G Knepley @*/
162957a9adfeSMatthew G Knepley PetscErrorCode PCFieldSplitGetIS(PC pc,const char splitname[],IS *is)
163057a9adfeSMatthew G Knepley {
163157a9adfeSMatthew G Knepley   PetscErrorCode ierr;
163257a9adfeSMatthew G Knepley 
163357a9adfeSMatthew G Knepley   PetscFunctionBegin;
163457a9adfeSMatthew G Knepley   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
163557a9adfeSMatthew G Knepley   PetscValidCharPointer(splitname,2);
163657a9adfeSMatthew G Knepley   PetscValidPointer(is,3);
163757a9adfeSMatthew G Knepley   {
163857a9adfeSMatthew G Knepley     PC_FieldSplit     *jac  = (PC_FieldSplit*) pc->data;
163957a9adfeSMatthew G Knepley     PC_FieldSplitLink ilink = jac->head;
164057a9adfeSMatthew G Knepley     PetscBool         found;
164157a9adfeSMatthew G Knepley 
16420298fd71SBarry Smith     *is = NULL;
164357a9adfeSMatthew G Knepley     while (ilink) {
164457a9adfeSMatthew G Knepley       ierr = PetscStrcmp(ilink->splitname, splitname, &found);CHKERRQ(ierr);
164557a9adfeSMatthew G Knepley       if (found) {
164657a9adfeSMatthew G Knepley         *is = ilink->is;
164757a9adfeSMatthew G Knepley         break;
164857a9adfeSMatthew G Knepley       }
164957a9adfeSMatthew G Knepley       ilink = ilink->next;
165057a9adfeSMatthew G Knepley     }
165157a9adfeSMatthew G Knepley   }
165257a9adfeSMatthew G Knepley   PetscFunctionReturn(0);
165357a9adfeSMatthew G Knepley }
165457a9adfeSMatthew G Knepley 
165557a9adfeSMatthew G Knepley #undef __FUNCT__
165651f519a2SBarry Smith #define __FUNCT__ "PCFieldSplitSetBlockSize"
165751f519a2SBarry Smith /*@
165851f519a2SBarry Smith     PCFieldSplitSetBlockSize - Sets the block size for defining where fields start in the
165951f519a2SBarry Smith       fieldsplit preconditioner. If not set the matrix block size is used.
166051f519a2SBarry Smith 
1661ad4df100SBarry Smith     Logically Collective on PC
166251f519a2SBarry Smith 
166351f519a2SBarry Smith     Input Parameters:
166451f519a2SBarry Smith +   pc  - the preconditioner context
166551f519a2SBarry Smith -   bs - the block size
166651f519a2SBarry Smith 
166751f519a2SBarry Smith     Level: intermediate
166851f519a2SBarry Smith 
166951f519a2SBarry Smith .seealso: PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitSetFields()
167051f519a2SBarry Smith 
167151f519a2SBarry Smith @*/
16727087cfbeSBarry Smith PetscErrorCode  PCFieldSplitSetBlockSize(PC pc,PetscInt bs)
167351f519a2SBarry Smith {
16744ac538c5SBarry Smith   PetscErrorCode ierr;
167551f519a2SBarry Smith 
167651f519a2SBarry Smith   PetscFunctionBegin;
16770700a824SBarry Smith   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
1678c5eb9154SBarry Smith   PetscValidLogicalCollectiveInt(pc,bs,2);
16794ac538c5SBarry Smith   ierr = PetscTryMethod(pc,"PCFieldSplitSetBlockSize_C",(PC,PetscInt),(pc,bs));CHKERRQ(ierr);
168051f519a2SBarry Smith   PetscFunctionReturn(0);
168151f519a2SBarry Smith }
168251f519a2SBarry Smith 
168351f519a2SBarry Smith #undef __FUNCT__
168469a612a9SBarry Smith #define __FUNCT__ "PCFieldSplitGetSubKSP"
16850971522cSBarry Smith /*@C
168669a612a9SBarry Smith    PCFieldSplitGetSubKSP - Gets the KSP contexts for all splits
16870971522cSBarry Smith 
168869a612a9SBarry Smith    Collective on KSP
16890971522cSBarry Smith 
16900971522cSBarry Smith    Input Parameter:
16910971522cSBarry Smith .  pc - the preconditioner context
16920971522cSBarry Smith 
16930971522cSBarry Smith    Output Parameters:
169413e0d083SBarry Smith +  n - the number of splits
169569a612a9SBarry Smith -  pc - the array of KSP contexts
16960971522cSBarry Smith 
16970971522cSBarry Smith    Note:
1698d32f9abdSBarry Smith    After PCFieldSplitGetSubKSP() the array of KSPs IS to be freed by the user
1699d32f9abdSBarry Smith    (not the KSP just the array that contains them).
17000971522cSBarry Smith 
170169a612a9SBarry Smith    You must call KSPSetUp() before calling PCFieldSplitGetSubKSP().
17020971522cSBarry Smith 
1703196cc216SBarry Smith    Fortran Usage: You must pass in a KSP array that is large enough to contain all the local KSPs.
17040298fd71SBarry Smith       You can call PCFieldSplitGetSubKSP(pc,n,NULL_OBJECT,ierr) to determine how large the
1705196cc216SBarry Smith       KSP array must be.
1706196cc216SBarry Smith 
1707196cc216SBarry Smith 
17080971522cSBarry Smith    Level: advanced
17090971522cSBarry Smith 
17100971522cSBarry Smith .seealso: PCFIELDSPLIT
17110971522cSBarry Smith @*/
17127087cfbeSBarry Smith PetscErrorCode  PCFieldSplitGetSubKSP(PC pc,PetscInt *n,KSP *subksp[])
17130971522cSBarry Smith {
17144ac538c5SBarry Smith   PetscErrorCode ierr;
17150971522cSBarry Smith 
17160971522cSBarry Smith   PetscFunctionBegin;
17170700a824SBarry Smith   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
171813e0d083SBarry Smith   if (n) PetscValidIntPointer(n,2);
17194ac538c5SBarry Smith   ierr = PetscUseMethod(pc,"PCFieldSplitGetSubKSP_C",(PC,PetscInt*,KSP **),(pc,n,subksp));CHKERRQ(ierr);
17200971522cSBarry Smith   PetscFunctionReturn(0);
17210971522cSBarry Smith }
17220971522cSBarry Smith 
1723e69d4d44SBarry Smith #undef __FUNCT__
172429f8a81cSJed Brown #define __FUNCT__ "PCFieldSplitSetSchurPre"
1725e69d4d44SBarry Smith /*@
172629f8a81cSJed Brown     PCFieldSplitSetSchurPre -  Indicates if the Schur complement is preconditioned by a preconditioner constructed by the
1727a04f6461SBarry Smith       A11 matrix. Otherwise no preconditioner is used.
1728e69d4d44SBarry Smith 
1729e69d4d44SBarry Smith     Collective on PC
1730e69d4d44SBarry Smith 
1731e69d4d44SBarry Smith     Input Parameters:
1732e69d4d44SBarry Smith +   pc      - the preconditioner context
1733a7476a74SDmitry Karpeev .   ptype   - which matrix to use for preconditioning the Schur complement: PC_FIELDSPLIT_SCHUR_PRE_A11 (default), PC_FIELDSPLIT_SCHUR_PRE_SELF, PC_FIELDSPLIT_PRE_USER
17340298fd71SBarry Smith -   userpre - matrix to use for preconditioning, or NULL
1735084e4875SJed Brown 
1736e69d4d44SBarry Smith     Options Database:
17372e71c61dSMatthew G. Knepley .     -pc_fieldsplit_schur_precondition <self,selfp,user,a11,full> default is a11
1738e69d4d44SBarry Smith 
1739fd1303e9SJungho Lee     Notes:
1740fd1303e9SJungho Lee $    If ptype is
1741fd1303e9SJungho Lee $        user then the preconditioner for the Schur complement is generated by the provided matrix (pre argument
1742fd1303e9SJungho Lee $             to this function).
1743585af1b9SMatthew G. Knepley $        a11 then the preconditioner for the Schur complement is generated by the block diagonal part of the preconditioner
1744585af1b9SMatthew G. Knepley $             matrix associated with the Schur complement (i.e. A11), not he Schur complement matrix
1745e74569cdSMatthew G. Knepley $        full then the preconditioner uses the exact Schur complement (this is expensive)
1746fd1303e9SJungho Lee $        self the preconditioner for the Schur complement is generated from the Schur complement matrix itself:
1747fd1303e9SJungho Lee $             The only preconditioner that currently works directly with the Schur complement matrix object is the PCLSC
1748fd1303e9SJungho Lee $             preconditioner
1749a7476a74SDmitry Karpeev $        selfp then the preconditioning matrix is an explicitly-assembled approximation Sp = A11 - A10 inv(diag(A00)) A01
17501d71051fSDmitry Karpeev $             This is only a good preconditioner when diag(A00) is a good preconditioner for A00. Optionally, A00 can be
17511d71051fSDmitry Karpeev $             lumped before extracting the diagonal: -fieldsplit_1_mat_schur_complement_ainv_type lump; diag is the default.
1752fd1303e9SJungho Lee 
1753e87fab1bSBarry Smith      When solving a saddle point problem, where the A11 block is identically zero, using a11 as the ptype only makes sense
1754fd1303e9SJungho Lee     with the additional option -fieldsplit_1_pc_type none. Usually for saddle point problems one would use a ptype of self and
1755a7476a74SDmitry Karpeev     -fieldsplit_1_pc_type lsc which uses the least squares commutator to compute a preconditioner for the Schur complement.
1756fd1303e9SJungho Lee 
1757e69d4d44SBarry Smith     Level: intermediate
1758e69d4d44SBarry Smith 
17591d71051fSDmitry Karpeev .seealso: PCFieldSplitGetSchurPre(), PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitSetFields(), PCFieldSplitSchurPreType,
17601d71051fSDmitry Karpeev           MatSchurComplementSetAinvType(), PCLSC
1761e69d4d44SBarry Smith 
1762e69d4d44SBarry Smith @*/
176329f8a81cSJed Brown PetscErrorCode PCFieldSplitSetSchurPre(PC pc,PCFieldSplitSchurPreType ptype,Mat pre)
1764e69d4d44SBarry Smith {
17654ac538c5SBarry Smith   PetscErrorCode ierr;
1766e69d4d44SBarry Smith 
1767e69d4d44SBarry Smith   PetscFunctionBegin;
17680700a824SBarry Smith   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
176929f8a81cSJed Brown   ierr = PetscTryMethod(pc,"PCFieldSplitSetSchurPre_C",(PC,PCFieldSplitSchurPreType,Mat),(pc,ptype,pre));CHKERRQ(ierr);
1770e69d4d44SBarry Smith   PetscFunctionReturn(0);
1771e69d4d44SBarry Smith }
177229f8a81cSJed Brown PetscErrorCode PCFieldSplitSchurPrecondition(PC pc,PCFieldSplitSchurPreType ptype,Mat pre) {return PCFieldSplitSetSchurPre(pc,ptype,pre);} /* Deprecated name */
1773e69d4d44SBarry Smith 
1774e69d4d44SBarry Smith #undef __FUNCT__
177537a82bf0SJed Brown #define __FUNCT__ "PCFieldSplitGetSchurPre"
177637a82bf0SJed Brown /*@
177737a82bf0SJed Brown     PCFieldSplitGetSchurPre - For Schur complement fieldsplit, determine how the Schur complement will be
177829f8a81cSJed Brown     preconditioned.  See PCFieldSplitSetSchurPre() for details.
177937a82bf0SJed Brown 
178037a82bf0SJed Brown     Logically Collective on PC
178137a82bf0SJed Brown 
178237a82bf0SJed Brown     Input Parameters:
178337a82bf0SJed Brown .   pc      - the preconditioner context
178437a82bf0SJed Brown 
178537a82bf0SJed Brown     Output Parameters:
178637a82bf0SJed 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
178737a82bf0SJed Brown -   userpre - matrix to use for preconditioning (with PC_FIELDSPLIT_PRE_USER), or NULL
178837a82bf0SJed Brown 
178937a82bf0SJed Brown     Level: intermediate
179037a82bf0SJed Brown 
179129f8a81cSJed Brown .seealso: PCFieldSplitSetSchurPre(), PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitSetFields(), PCFieldSplitSchurPreType, PCLSC
179237a82bf0SJed Brown 
179337a82bf0SJed Brown @*/
179437a82bf0SJed Brown PetscErrorCode PCFieldSplitGetSchurPre(PC pc,PCFieldSplitSchurPreType *ptype,Mat *pre)
179537a82bf0SJed Brown {
179637a82bf0SJed Brown   PetscErrorCode ierr;
179737a82bf0SJed Brown 
179837a82bf0SJed Brown   PetscFunctionBegin;
179937a82bf0SJed Brown   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
180037a82bf0SJed Brown   ierr = PetscUseMethod(pc,"PCFieldSplitGetSchurPre_C",(PC,PCFieldSplitSchurPreType*,Mat*),(pc,ptype,pre));CHKERRQ(ierr);
1801e69d4d44SBarry Smith   PetscFunctionReturn(0);
1802e69d4d44SBarry Smith }
1803e69d4d44SBarry Smith 
1804e69d4d44SBarry Smith #undef __FUNCT__
1805470b340bSDmitry Karpeev #define __FUNCT__ "PCFieldSplitSchurGetS"
180645e7fc46SDmitry Karpeev /*@
1807470b340bSDmitry Karpeev     PCFieldSplitSchurGetS -  extract the MatSchurComplement object used by this PC in case it needs to be configured separately
180845e7fc46SDmitry Karpeev 
180945e7fc46SDmitry Karpeev     Not collective
181045e7fc46SDmitry Karpeev 
181145e7fc46SDmitry Karpeev     Input Parameter:
181245e7fc46SDmitry Karpeev .   pc      - the preconditioner context
181345e7fc46SDmitry Karpeev 
181445e7fc46SDmitry Karpeev     Output Parameter:
1815470b340bSDmitry Karpeev .   S       - the Schur complement matrix
181645e7fc46SDmitry Karpeev 
1817470b340bSDmitry Karpeev     Notes:
1818470b340bSDmitry Karpeev     This matrix should not be destroyed using MatDestroy(); rather, use PCFieldSplitSchurRestoreS().
181945e7fc46SDmitry Karpeev 
182045e7fc46SDmitry Karpeev     Level: advanced
182145e7fc46SDmitry Karpeev 
182229f8a81cSJed Brown .seealso: PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitSchurPreType, PCFieldSplitSetSchurPre(), MatSchurComplement, PCFieldSplitSchurRestoreS()
182345e7fc46SDmitry Karpeev 
182445e7fc46SDmitry Karpeev @*/
1825470b340bSDmitry Karpeev PetscErrorCode  PCFieldSplitSchurGetS(PC pc,Mat *S)
182645e7fc46SDmitry Karpeev {
182745e7fc46SDmitry Karpeev   PetscErrorCode ierr;
182845e7fc46SDmitry Karpeev   const char*    t;
182945e7fc46SDmitry Karpeev   PetscBool      isfs;
183045e7fc46SDmitry Karpeev   PC_FieldSplit  *jac;
183145e7fc46SDmitry Karpeev 
183245e7fc46SDmitry Karpeev   PetscFunctionBegin;
183345e7fc46SDmitry Karpeev   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
183445e7fc46SDmitry Karpeev   ierr = PetscObjectGetType((PetscObject)pc,&t);CHKERRQ(ierr);
183545e7fc46SDmitry Karpeev   ierr = PetscStrcmp(t,PCFIELDSPLIT,&isfs);CHKERRQ(ierr);
183645e7fc46SDmitry Karpeev   if (!isfs) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Expected PC of type PCFIELDSPLIT, got %s instead",t);
183745e7fc46SDmitry Karpeev   jac = (PC_FieldSplit*)pc->data;
1838470b340bSDmitry 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);
1839470b340bSDmitry Karpeev   if (S) *S = jac->schur;
184045e7fc46SDmitry Karpeev   PetscFunctionReturn(0);
184145e7fc46SDmitry Karpeev }
184245e7fc46SDmitry Karpeev 
184345e7fc46SDmitry Karpeev #undef __FUNCT__
1844470b340bSDmitry Karpeev #define __FUNCT__ "PCFieldSplitSchurRestoreS"
1845470b340bSDmitry Karpeev /*@
1846470b340bSDmitry Karpeev     PCFieldSplitSchurRestoreS -  restores the MatSchurComplement object used by this PC
1847470b340bSDmitry Karpeev 
1848470b340bSDmitry Karpeev     Not collective
1849470b340bSDmitry Karpeev 
1850470b340bSDmitry Karpeev     Input Parameters:
1851470b340bSDmitry Karpeev +   pc      - the preconditioner context
1852470b340bSDmitry Karpeev .   S       - the Schur complement matrix
1853470b340bSDmitry Karpeev 
1854470b340bSDmitry Karpeev     Level: advanced
1855470b340bSDmitry Karpeev 
185629f8a81cSJed Brown .seealso: PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitSchurPreType, PCFieldSplitSetSchurPre(), MatSchurComplement, PCFieldSplitSchurGetS()
1857470b340bSDmitry Karpeev 
1858470b340bSDmitry Karpeev @*/
1859bca69d2bSDmitry Karpeev PetscErrorCode  PCFieldSplitSchurRestoreS(PC pc,Mat *S)
1860470b340bSDmitry Karpeev {
1861470b340bSDmitry Karpeev   PetscErrorCode ierr;
1862470b340bSDmitry Karpeev   const char*    t;
1863470b340bSDmitry Karpeev   PetscBool      isfs;
1864470b340bSDmitry Karpeev   PC_FieldSplit  *jac;
1865470b340bSDmitry Karpeev 
1866470b340bSDmitry Karpeev   PetscFunctionBegin;
1867470b340bSDmitry Karpeev   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
1868470b340bSDmitry Karpeev   ierr = PetscObjectGetType((PetscObject)pc,&t);CHKERRQ(ierr);
1869470b340bSDmitry Karpeev   ierr = PetscStrcmp(t,PCFIELDSPLIT,&isfs);CHKERRQ(ierr);
1870470b340bSDmitry Karpeev   if (!isfs) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Expected PC of type PCFIELDSPLIT, got %s instead",t);
1871470b340bSDmitry Karpeev   jac = (PC_FieldSplit*)pc->data;
1872470b340bSDmitry 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);
1873bca69d2bSDmitry Karpeev   if (!S || *S != jac->schur) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"MatSchurComplement restored is not the same as gotten");
1874470b340bSDmitry Karpeev   PetscFunctionReturn(0);
1875470b340bSDmitry Karpeev }
1876470b340bSDmitry Karpeev 
1877470b340bSDmitry Karpeev 
1878470b340bSDmitry Karpeev #undef __FUNCT__
187929f8a81cSJed Brown #define __FUNCT__ "PCFieldSplitSetSchurPre_FieldSplit"
188029f8a81cSJed Brown static PetscErrorCode  PCFieldSplitSetSchurPre_FieldSplit(PC pc,PCFieldSplitSchurPreType ptype,Mat pre)
1881e69d4d44SBarry Smith {
1882e69d4d44SBarry Smith   PC_FieldSplit  *jac = (PC_FieldSplit*)pc->data;
1883084e4875SJed Brown   PetscErrorCode ierr;
1884e69d4d44SBarry Smith 
1885e69d4d44SBarry Smith   PetscFunctionBegin;
1886084e4875SJed Brown   jac->schurpre = ptype;
1887a7476a74SDmitry Karpeev   if (ptype == PC_FIELDSPLIT_SCHUR_PRE_USER && pre) {
18886bf464f9SBarry Smith     ierr            = MatDestroy(&jac->schur_user);CHKERRQ(ierr);
1889084e4875SJed Brown     jac->schur_user = pre;
1890084e4875SJed Brown     ierr            = PetscObjectReference((PetscObject)jac->schur_user);CHKERRQ(ierr);
1891084e4875SJed Brown   }
1892e69d4d44SBarry Smith   PetscFunctionReturn(0);
1893e69d4d44SBarry Smith }
1894e69d4d44SBarry Smith 
189530ad9308SMatthew Knepley #undef __FUNCT__
189637a82bf0SJed Brown #define __FUNCT__ "PCFieldSplitGetSchurPre_FieldSplit"
189737a82bf0SJed Brown static PetscErrorCode  PCFieldSplitGetSchurPre_FieldSplit(PC pc,PCFieldSplitSchurPreType *ptype,Mat *pre)
189837a82bf0SJed Brown {
189937a82bf0SJed Brown   PC_FieldSplit  *jac = (PC_FieldSplit*)pc->data;
190037a82bf0SJed Brown 
190137a82bf0SJed Brown   PetscFunctionBegin;
190237a82bf0SJed Brown   *ptype = jac->schurpre;
190337a82bf0SJed Brown   *pre   = jac->schur_user;
190437a82bf0SJed Brown   PetscFunctionReturn(0);
190537a82bf0SJed Brown }
190637a82bf0SJed Brown 
190737a82bf0SJed Brown #undef __FUNCT__
1908c9c6ffaaSJed Brown #define __FUNCT__ "PCFieldSplitSetSchurFactType"
1909ab1df9f5SJed Brown /*@
1910c9c6ffaaSJed Brown     PCFieldSplitSetSchurFactType -  sets which blocks of the approximate block factorization to retain
1911ab1df9f5SJed Brown 
1912ab1df9f5SJed Brown     Collective on PC
1913ab1df9f5SJed Brown 
1914ab1df9f5SJed Brown     Input Parameters:
1915ab1df9f5SJed Brown +   pc  - the preconditioner context
1916c9c6ffaaSJed Brown -   ftype - which blocks of factorization to retain, PC_FIELDSPLIT_SCHUR_FACT_FULL is default
1917ab1df9f5SJed Brown 
1918ab1df9f5SJed Brown     Options Database:
1919c9c6ffaaSJed Brown .     -pc_fieldsplit_schur_fact_type <diag,lower,upper,full> default is full
1920ab1df9f5SJed Brown 
1921ab1df9f5SJed Brown 
1922ab1df9f5SJed Brown     Level: intermediate
1923ab1df9f5SJed Brown 
1924ab1df9f5SJed Brown     Notes:
1925ab1df9f5SJed Brown     The FULL factorization is
1926ab1df9f5SJed Brown 
1927ab1df9f5SJed Brown $   (A   B)  = (1       0) (A   0) (1  Ainv*B)
1928ab1df9f5SJed Brown $   (C   D)    (C*Ainv  1) (0   S) (0     1  )
1929ab1df9f5SJed Brown 
19306be4592eSBarry Smith     where S = D - C*Ainv*B. In practice, the full factorization is applied via block triangular solves with the grouping L*(D*U). UPPER uses D*U, LOWER uses L*D,
19316be4592eSBarry Smith     and DIAG is the diagonal part with the sign of S flipped (because this makes the preconditioner positive definite for many formulations, thus allowing the use of KSPMINRES).
1932ab1df9f5SJed Brown 
19336be4592eSBarry Smith     If applied exactly, FULL factorization is a direct solver. The preconditioned operator with LOWER or UPPER has all eigenvalues equal to 1 and minimal polynomial
19346be4592eSBarry Smith     of degree 2, so KSPGMRES converges in 2 iterations. If the iteration count is very low, consider using KSPFGMRES or KSPGCR which can use one less preconditioner
19356be4592eSBarry Smith     application in this case. Note that the preconditioned operator may be highly non-normal, so such fast convergence may not be observed in practice. With DIAG,
19366be4592eSBarry Smith     the preconditioned operator has three distinct nonzero eigenvalues and minimal polynomial of degree at most 4, so KSPGMRES converges in at most 4 iterations.
1937ab1df9f5SJed Brown 
19386be4592eSBarry Smith     For symmetric problems in which A is positive definite and S is negative definite, DIAG can be used with KSPMINRES. Note that a flexible method like KSPFGMRES
19396be4592eSBarry Smith     or KSPGCR must be used if the fieldsplit preconditioner is nonlinear (e.g. a few iterations of a Krylov method is used inside a split).
1940ab1df9f5SJed Brown 
1941ab1df9f5SJed Brown     References:
1942ab1df9f5SJed Brown     Murphy, Golub, and Wathen, A note on preconditioning indefinite linear systems, SIAM J. Sci. Comput., 21 (2000) pp. 1969-1972.
1943ab1df9f5SJed Brown 
1944ab1df9f5SJed Brown     Ipsen, A note on preconditioning nonsymmetric matrices, SIAM J. Sci. Comput., 23 (2001), pp. 1050-1051.
1945ab1df9f5SJed Brown 
1946ab1df9f5SJed Brown .seealso: PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitSetFields(), PCFieldSplitSchurPreType
1947ab1df9f5SJed Brown @*/
1948c9c6ffaaSJed Brown PetscErrorCode  PCFieldSplitSetSchurFactType(PC pc,PCFieldSplitSchurFactType ftype)
1949ab1df9f5SJed Brown {
1950ab1df9f5SJed Brown   PetscErrorCode ierr;
1951ab1df9f5SJed Brown 
1952ab1df9f5SJed Brown   PetscFunctionBegin;
1953ab1df9f5SJed Brown   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
1954c9c6ffaaSJed Brown   ierr = PetscTryMethod(pc,"PCFieldSplitSetSchurFactType_C",(PC,PCFieldSplitSchurFactType),(pc,ftype));CHKERRQ(ierr);
1955ab1df9f5SJed Brown   PetscFunctionReturn(0);
1956ab1df9f5SJed Brown }
1957ab1df9f5SJed Brown 
1958ab1df9f5SJed Brown #undef __FUNCT__
1959c9c6ffaaSJed Brown #define __FUNCT__ "PCFieldSplitSetSchurFactType_FieldSplit"
19601e6b0712SBarry Smith static PetscErrorCode PCFieldSplitSetSchurFactType_FieldSplit(PC pc,PCFieldSplitSchurFactType ftype)
1961ab1df9f5SJed Brown {
1962ab1df9f5SJed Brown   PC_FieldSplit *jac = (PC_FieldSplit*)pc->data;
1963ab1df9f5SJed Brown 
1964ab1df9f5SJed Brown   PetscFunctionBegin;
1965ab1df9f5SJed Brown   jac->schurfactorization = ftype;
1966ab1df9f5SJed Brown   PetscFunctionReturn(0);
1967ab1df9f5SJed Brown }
1968ab1df9f5SJed Brown 
1969ab1df9f5SJed Brown #undef __FUNCT__
197030ad9308SMatthew Knepley #define __FUNCT__ "PCFieldSplitGetSchurBlocks"
197130ad9308SMatthew Knepley /*@C
19728c03b21aSDmitry Karpeev    PCFieldSplitGetSchurBlocks - Gets all matrix blocks for the Schur complement
197330ad9308SMatthew Knepley 
197430ad9308SMatthew Knepley    Collective on KSP
197530ad9308SMatthew Knepley 
197630ad9308SMatthew Knepley    Input Parameter:
197730ad9308SMatthew Knepley .  pc - the preconditioner context
197830ad9308SMatthew Knepley 
197930ad9308SMatthew Knepley    Output Parameters:
1980a04f6461SBarry Smith +  A00 - the (0,0) block
1981a04f6461SBarry Smith .  A01 - the (0,1) block
1982a04f6461SBarry Smith .  A10 - the (1,0) block
1983a04f6461SBarry Smith -  A11 - the (1,1) block
198430ad9308SMatthew Knepley 
198530ad9308SMatthew Knepley    Level: advanced
198630ad9308SMatthew Knepley 
198730ad9308SMatthew Knepley .seealso: PCFIELDSPLIT
198830ad9308SMatthew Knepley @*/
1989a04f6461SBarry Smith PetscErrorCode  PCFieldSplitGetSchurBlocks(PC pc,Mat *A00,Mat *A01,Mat *A10, Mat *A11)
199030ad9308SMatthew Knepley {
199130ad9308SMatthew Knepley   PC_FieldSplit *jac = (PC_FieldSplit*) pc->data;
199230ad9308SMatthew Knepley 
199330ad9308SMatthew Knepley   PetscFunctionBegin;
19940700a824SBarry Smith   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
1995ce94432eSBarry Smith   if (jac->type != PC_COMPOSITE_SCHUR) SETERRQ(PetscObjectComm((PetscObject)pc),PETSC_ERR_ARG_WRONG, "FieldSplit is not using a Schur complement approach.");
1996a04f6461SBarry Smith   if (A00) *A00 = jac->pmat[0];
1997a04f6461SBarry Smith   if (A01) *A01 = jac->B;
1998a04f6461SBarry Smith   if (A10) *A10 = jac->C;
1999a04f6461SBarry Smith   if (A11) *A11 = jac->pmat[1];
200030ad9308SMatthew Knepley   PetscFunctionReturn(0);
200130ad9308SMatthew Knepley }
200230ad9308SMatthew Knepley 
200379416396SBarry Smith #undef __FUNCT__
200479416396SBarry Smith #define __FUNCT__ "PCFieldSplitSetType_FieldSplit"
20051e6b0712SBarry Smith static PetscErrorCode  PCFieldSplitSetType_FieldSplit(PC pc,PCCompositeType type)
200679416396SBarry Smith {
200779416396SBarry Smith   PC_FieldSplit  *jac = (PC_FieldSplit*)pc->data;
2008e69d4d44SBarry Smith   PetscErrorCode ierr;
200979416396SBarry Smith 
201079416396SBarry Smith   PetscFunctionBegin;
201179416396SBarry Smith   jac->type = type;
20123b224e63SBarry Smith   if (type == PC_COMPOSITE_SCHUR) {
20133b224e63SBarry Smith     pc->ops->apply = PCApply_FieldSplit_Schur;
20143b224e63SBarry Smith     pc->ops->view  = PCView_FieldSplit_Schur;
20152fa5cd67SKarl Rupp 
2016bdf89e91SBarry Smith     ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitGetSubKSP_C",PCFieldSplitGetSubKSP_FieldSplit_Schur);CHKERRQ(ierr);
201729f8a81cSJed Brown     ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetSchurPre_C",PCFieldSplitSetSchurPre_FieldSplit);CHKERRQ(ierr);
201837a82bf0SJed Brown     ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitGetSchurPre_C",PCFieldSplitGetSchurPre_FieldSplit);CHKERRQ(ierr);
2019bdf89e91SBarry Smith     ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetSchurFactType_C",PCFieldSplitSetSchurFactType_FieldSplit);CHKERRQ(ierr);
2020e69d4d44SBarry Smith 
20213b224e63SBarry Smith   } else {
20223b224e63SBarry Smith     pc->ops->apply = PCApply_FieldSplit;
20233b224e63SBarry Smith     pc->ops->view  = PCView_FieldSplit;
20242fa5cd67SKarl Rupp 
2025bdf89e91SBarry Smith     ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitGetSubKSP_C",PCFieldSplitGetSubKSP_FieldSplit);CHKERRQ(ierr);
202629f8a81cSJed Brown     ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetSchurPre_C",0);CHKERRQ(ierr);
202737a82bf0SJed Brown     ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitGetSchurPre_C",0);CHKERRQ(ierr);
2028bdf89e91SBarry Smith     ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetSchurFactType_C",0);CHKERRQ(ierr);
20293b224e63SBarry Smith   }
203079416396SBarry Smith   PetscFunctionReturn(0);
203179416396SBarry Smith }
203279416396SBarry Smith 
203351f519a2SBarry Smith #undef __FUNCT__
203451f519a2SBarry Smith #define __FUNCT__ "PCFieldSplitSetBlockSize_FieldSplit"
20351e6b0712SBarry Smith static PetscErrorCode  PCFieldSplitSetBlockSize_FieldSplit(PC pc,PetscInt bs)
203651f519a2SBarry Smith {
203751f519a2SBarry Smith   PC_FieldSplit *jac = (PC_FieldSplit*)pc->data;
203851f519a2SBarry Smith 
203951f519a2SBarry Smith   PetscFunctionBegin;
2040ce94432eSBarry Smith   if (bs < 1) SETERRQ1(PetscObjectComm((PetscObject)pc),PETSC_ERR_ARG_OUTOFRANGE,"Blocksize must be positive, you gave %D",bs);
2041ce94432eSBarry 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);
204251f519a2SBarry Smith   jac->bs = bs;
204351f519a2SBarry Smith   PetscFunctionReturn(0);
204451f519a2SBarry Smith }
204551f519a2SBarry Smith 
204679416396SBarry Smith #undef __FUNCT__
204779416396SBarry Smith #define __FUNCT__ "PCFieldSplitSetType"
2048bc08b0f1SBarry Smith /*@
204979416396SBarry Smith    PCFieldSplitSetType - Sets the type of fieldsplit preconditioner.
205079416396SBarry Smith 
205179416396SBarry Smith    Collective on PC
205279416396SBarry Smith 
205379416396SBarry Smith    Input Parameter:
205479416396SBarry Smith .  pc - the preconditioner context
205581540f2fSBarry Smith .  type - PC_COMPOSITE_ADDITIVE, PC_COMPOSITE_MULTIPLICATIVE (default), PC_COMPOSITE_SYMMETRIC_MULTIPLICATIVE, PC_COMPOSITE_SPECIAL, PC_COMPOSITE_SCHUR
205679416396SBarry Smith 
205779416396SBarry Smith    Options Database Key:
2058a4efd8eaSMatthew Knepley .  -pc_fieldsplit_type <type: one of multiplicative, additive, symmetric_multiplicative, special, schur> - Sets fieldsplit preconditioner type
205979416396SBarry Smith 
2060b02e2d75SMatthew G Knepley    Level: Intermediate
206179416396SBarry Smith 
206279416396SBarry Smith .keywords: PC, set, type, composite preconditioner, additive, multiplicative
206379416396SBarry Smith 
206479416396SBarry Smith .seealso: PCCompositeSetType()
206579416396SBarry Smith 
206679416396SBarry Smith @*/
20677087cfbeSBarry Smith PetscErrorCode  PCFieldSplitSetType(PC pc,PCCompositeType type)
206879416396SBarry Smith {
20694ac538c5SBarry Smith   PetscErrorCode ierr;
207079416396SBarry Smith 
207179416396SBarry Smith   PetscFunctionBegin;
20720700a824SBarry Smith   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
20734ac538c5SBarry Smith   ierr = PetscTryMethod(pc,"PCFieldSplitSetType_C",(PC,PCCompositeType),(pc,type));CHKERRQ(ierr);
207479416396SBarry Smith   PetscFunctionReturn(0);
207579416396SBarry Smith }
207679416396SBarry Smith 
2077b02e2d75SMatthew G Knepley #undef __FUNCT__
2078b02e2d75SMatthew G Knepley #define __FUNCT__ "PCFieldSplitGetType"
2079b02e2d75SMatthew G Knepley /*@
2080b02e2d75SMatthew G Knepley   PCFieldSplitGetType - Gets the type of fieldsplit preconditioner.
2081b02e2d75SMatthew G Knepley 
2082b02e2d75SMatthew G Knepley   Not collective
2083b02e2d75SMatthew G Knepley 
2084b02e2d75SMatthew G Knepley   Input Parameter:
2085b02e2d75SMatthew G Knepley . pc - the preconditioner context
2086b02e2d75SMatthew G Knepley 
2087b02e2d75SMatthew G Knepley   Output Parameter:
2088b02e2d75SMatthew G Knepley . type - PC_COMPOSITE_ADDITIVE, PC_COMPOSITE_MULTIPLICATIVE (default), PC_COMPOSITE_SYMMETRIC_MULTIPLICATIVE, PC_COMPOSITE_SPECIAL, PC_COMPOSITE_SCHUR
2089b02e2d75SMatthew G Knepley 
2090b02e2d75SMatthew G Knepley   Level: Intermediate
2091b02e2d75SMatthew G Knepley 
2092b02e2d75SMatthew G Knepley .keywords: PC, set, type, composite preconditioner, additive, multiplicative
2093b02e2d75SMatthew G Knepley .seealso: PCCompositeSetType()
2094b02e2d75SMatthew G Knepley @*/
2095b02e2d75SMatthew G Knepley PetscErrorCode PCFieldSplitGetType(PC pc, PCCompositeType *type)
2096b02e2d75SMatthew G Knepley {
2097b02e2d75SMatthew G Knepley   PC_FieldSplit *jac = (PC_FieldSplit*) pc->data;
2098b02e2d75SMatthew G Knepley 
2099b02e2d75SMatthew G Knepley   PetscFunctionBegin;
2100b02e2d75SMatthew G Knepley   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
2101b02e2d75SMatthew G Knepley   PetscValidIntPointer(type,2);
2102b02e2d75SMatthew G Knepley   *type = jac->type;
2103b02e2d75SMatthew G Knepley   PetscFunctionReturn(0);
2104b02e2d75SMatthew G Knepley }
2105b02e2d75SMatthew G Knepley 
21064ab8060aSDmitry Karpeev #undef __FUNCT__
21074ab8060aSDmitry Karpeev #define __FUNCT__ "PCFieldSplitSetDMSplits"
21084ab8060aSDmitry Karpeev /*@
21094ab8060aSDmitry Karpeev    PCFieldSplitSetDMSplits - Flags whether DMCreateFieldDecomposition() should be used to define the splits, whenever possible.
21104ab8060aSDmitry Karpeev 
21114ab8060aSDmitry Karpeev    Logically Collective
21124ab8060aSDmitry Karpeev 
21134ab8060aSDmitry Karpeev    Input Parameters:
21144ab8060aSDmitry Karpeev +  pc   - the preconditioner context
21154ab8060aSDmitry Karpeev -  flg  - boolean indicating whether to use field splits defined by the DM
21164ab8060aSDmitry Karpeev 
21174ab8060aSDmitry Karpeev    Options Database Key:
21184ab8060aSDmitry Karpeev .  -pc_fieldsplit_dm_splits
21194ab8060aSDmitry Karpeev 
21204ab8060aSDmitry Karpeev    Level: Intermediate
21214ab8060aSDmitry Karpeev 
21224ab8060aSDmitry Karpeev .keywords: PC, DM, composite preconditioner, additive, multiplicative
21234ab8060aSDmitry Karpeev 
21244ab8060aSDmitry Karpeev .seealso: PCFieldSplitGetDMSplits()
21254ab8060aSDmitry Karpeev 
21264ab8060aSDmitry Karpeev @*/
21274ab8060aSDmitry Karpeev PetscErrorCode  PCFieldSplitSetDMSplits(PC pc,PetscBool flg)
21284ab8060aSDmitry Karpeev {
21294ab8060aSDmitry Karpeev   PC_FieldSplit  *jac = (PC_FieldSplit*)pc->data;
21304ab8060aSDmitry Karpeev   PetscBool      isfs;
21314ab8060aSDmitry Karpeev   PetscErrorCode ierr;
21324ab8060aSDmitry Karpeev 
21334ab8060aSDmitry Karpeev   PetscFunctionBegin;
21344ab8060aSDmitry Karpeev   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
21354ab8060aSDmitry Karpeev   PetscValidLogicalCollectiveBool(pc,flg,2);
21364ab8060aSDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)pc,PCFIELDSPLIT,&isfs);CHKERRQ(ierr);
21374ab8060aSDmitry Karpeev   if (isfs) {
21384ab8060aSDmitry Karpeev     jac->dm_splits = flg;
21394ab8060aSDmitry Karpeev   }
21404ab8060aSDmitry Karpeev   PetscFunctionReturn(0);
21414ab8060aSDmitry Karpeev }
21424ab8060aSDmitry Karpeev 
21434ab8060aSDmitry Karpeev 
21444ab8060aSDmitry Karpeev #undef __FUNCT__
21454ab8060aSDmitry Karpeev #define __FUNCT__ "PCFieldSplitGetDMSplits"
21464ab8060aSDmitry Karpeev /*@
21474ab8060aSDmitry Karpeev    PCFieldSplitGetDMSplits - Returns flag indicating whether DMCreateFieldDecomposition() should be used to define the splits, whenever possible.
21484ab8060aSDmitry Karpeev 
21494ab8060aSDmitry Karpeev    Logically Collective
21504ab8060aSDmitry Karpeev 
21514ab8060aSDmitry Karpeev    Input Parameter:
21524ab8060aSDmitry Karpeev .  pc   - the preconditioner context
21534ab8060aSDmitry Karpeev 
21544ab8060aSDmitry Karpeev    Output Parameter:
21554ab8060aSDmitry Karpeev .  flg  - boolean indicating whether to use field splits defined by the DM
21564ab8060aSDmitry Karpeev 
21574ab8060aSDmitry Karpeev    Level: Intermediate
21584ab8060aSDmitry Karpeev 
21594ab8060aSDmitry Karpeev .keywords: PC, DM, composite preconditioner, additive, multiplicative
21604ab8060aSDmitry Karpeev 
21614ab8060aSDmitry Karpeev .seealso: PCFieldSplitSetDMSplits()
21624ab8060aSDmitry Karpeev 
21634ab8060aSDmitry Karpeev @*/
21644ab8060aSDmitry Karpeev PetscErrorCode  PCFieldSplitGetDMSplits(PC pc,PetscBool* flg)
21654ab8060aSDmitry Karpeev {
21664ab8060aSDmitry Karpeev   PC_FieldSplit  *jac = (PC_FieldSplit*)pc->data;
21674ab8060aSDmitry Karpeev   PetscBool      isfs;
21684ab8060aSDmitry Karpeev   PetscErrorCode ierr;
21694ab8060aSDmitry Karpeev 
21704ab8060aSDmitry Karpeev   PetscFunctionBegin;
21714ab8060aSDmitry Karpeev   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
21724ab8060aSDmitry Karpeev   PetscValidPointer(flg,2);
21734ab8060aSDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)pc,PCFIELDSPLIT,&isfs);CHKERRQ(ierr);
21744ab8060aSDmitry Karpeev   if (isfs) {
21754ab8060aSDmitry Karpeev     if(flg) *flg = jac->dm_splits;
21764ab8060aSDmitry Karpeev   }
21774ab8060aSDmitry Karpeev   PetscFunctionReturn(0);
21784ab8060aSDmitry Karpeev }
21794ab8060aSDmitry Karpeev 
21800971522cSBarry Smith /* -------------------------------------------------------------------------------------*/
21810971522cSBarry Smith /*MC
2182a8c7a070SBarry Smith    PCFIELDSPLIT - Preconditioner created by combining separate preconditioners for individual
2183a04f6461SBarry Smith                   fields or groups of fields. See the users manual section "Solving Block Matrices" for more details.
21840971522cSBarry Smith 
2185edf189efSBarry Smith      To set options on the solvers for each block append -fieldsplit_ to all the PC
2186edf189efSBarry Smith         options database keys. For example, -fieldsplit_pc_type ilu -fieldsplit_pc_factor_levels 1
21870971522cSBarry Smith 
2188a8c7a070SBarry Smith      To set the options on the solvers separate for each block call PCFieldSplitGetSubKSP()
218969a612a9SBarry Smith          and set the options directly on the resulting KSP object
21900971522cSBarry Smith 
21910971522cSBarry Smith    Level: intermediate
21920971522cSBarry Smith 
219379416396SBarry Smith    Options Database Keys:
219481540f2fSBarry Smith +   -pc_fieldsplit_%d_fields <a,b,..> - indicates the fields to be used in the %d'th split
219581540f2fSBarry Smith .   -pc_fieldsplit_default - automatically add any fields to additional splits that have not
219681540f2fSBarry Smith                               been supplied explicitly by -pc_fieldsplit_%d_fields
219781540f2fSBarry Smith .   -pc_fieldsplit_block_size <bs> - size of block that defines fields (i.e. there are bs fields)
21980f188ba9SJed Brown .   -pc_fieldsplit_type <additive,multiplicative,symmetric_multiplicative,schur> - type of relaxation or factorization splitting
21992e71c61dSMatthew G. Knepley .   -pc_fieldsplit_schur_precondition <self,selfp,user,a11,full> - default is a11
2200435f959eSBarry Smith .   -pc_fieldsplit_detect_saddle_point - automatically finds rows with zero or negative diagonal and uses Schur complement with no preconditioner as the solver
220179416396SBarry Smith 
22025d4c12cdSJungho Lee -    Options prefix for inner solvers when using Schur complement preconditioner are -fieldsplit_0_ and -fieldsplit_1_
22035d4c12cdSJungho Lee      for all other solvers they are -fieldsplit_%d_ for the dth field, use -fieldsplit_ for all fields
22045d4c12cdSJungho Lee 
2205c8a0d604SMatthew G Knepley    Notes:
2206c8a0d604SMatthew G Knepley     Use PCFieldSplitSetFields() to set fields defined by "strided" entries and PCFieldSplitSetIS()
2207d32f9abdSBarry Smith      to define a field by an arbitrary collection of entries.
2208d32f9abdSBarry Smith 
2209d32f9abdSBarry Smith       If no fields are set the default is used. The fields are defined by entries strided by bs,
2210d32f9abdSBarry Smith       beginning at 0 then 1, etc to bs-1. The block size can be set with PCFieldSplitSetBlockSize(),
2211d32f9abdSBarry Smith       if this is not called the block size defaults to the blocksize of the second matrix passed
2212d32f9abdSBarry Smith       to KSPSetOperators()/PCSetOperators().
2213d32f9abdSBarry Smith 
2214c8a0d604SMatthew G Knepley $     For the Schur complement preconditioner if J = ( A00 A01 )
2215c8a0d604SMatthew G Knepley $                                                    ( A10 A11 )
2216c8a0d604SMatthew G Knepley $     the preconditioner using full factorization is
221713b05affSJed Brown $              ( I   -ksp(A00) A01 ) ( inv(A00)     0  ) (     I          0  )
2218c8a0d604SMatthew G Knepley $              ( 0         I       ) (   0      ksp(S) ) ( -A10 ksp(A00)  I  )
221913b05affSJed Brown      where the action of inv(A00) is applied using the KSP solver with prefix -fieldsplit_0_.  S is the Schur complement
222013b05affSJed Brown $              S = A11 - A10 ksp(A00) A01
222113b05affSJed 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
2222c8a0d604SMatthew G Knepley      in providing the SECOND split or 1 if not give). For PCFieldSplitGetKSP() when field number is 0,
2223c8a0d604SMatthew G Knepley      it returns the KSP associated with -fieldsplit_0_ while field number 1 gives -fieldsplit_1_ KSP. By default
222429f8a81cSJed Brown      A11 is used to construct a preconditioner for S, use PCFieldSplitSetSchurPre() to turn on or off this
2225a7476a74SDmitry Karpeev      option. You can use the preconditioner PCLSC to precondition the Schur complement with -fieldsplit_1_pc_type lsc.
2226a7476a74SDmitry Karpeev      When option -fieldsplit_schur_precondition selfp is given, an approximation to S is assembled --
2227a7476a74SDmitry Karpeev      Sp = A11 - A10 inv(diag(A00)) A01, which has type AIJ and can be used with a variety of preconditioners
22281d71051fSDmitry Karpeev      (e.g., -fieldsplit_1_pc_type asm). Optionally, A00 can be lumped before extracting the diagonal:
22291d71051fSDmitry Karpeev      -fieldsplit_1_mat_schur_complement_ainv_type lump; diag is the default.
22301d71051fSDmitry Karpeev 
2231a7476a74SDmitry Karpeev      The factorization type is set using -pc_fieldsplit_schur_fact_type <diag, lower, upper, full>. The full is shown above,
22325668aaf4SBarry Smith      diag gives
2233c8a0d604SMatthew G Knepley $              ( inv(A00)     0   )
2234c8a0d604SMatthew G Knepley $              (   0      -ksp(S) )
22355668aaf4SBarry Smith      note that slightly counter intuitively there is a negative in front of the ksp(S) so that the preconditioner is positive definite. The lower factorization is the inverse of
2236c8a0d604SMatthew G Knepley $              (  A00   0 )
2237c8a0d604SMatthew G Knepley $              (  A10   S )
2238c8a0d604SMatthew G Knepley      where the inverses of A00 and S are applied using KSPs. The upper factorization is the inverse of
2239c8a0d604SMatthew G Knepley $              ( A00 A01 )
2240c8a0d604SMatthew G Knepley $              (  0   S  )
2241c8a0d604SMatthew G Knepley      where again the inverses of A00 and S are applied using KSPs.
2242e69d4d44SBarry Smith 
2243edf189efSBarry Smith      If only one set of indices (one IS) is provided with PCFieldSplitSetIS() then the complement of that IS
2244edf189efSBarry Smith      is used automatically for a second block.
2245edf189efSBarry Smith 
2246ff218e97SBarry Smith      The fieldsplit preconditioner cannot currently be used with the BAIJ or SBAIJ data formats if the blocksize is larger than 1.
2247ff218e97SBarry Smith      Generally it should be used with the AIJ format.
2248ff218e97SBarry Smith 
2249ff218e97SBarry Smith      The forms of these preconditioners are closely related if not identical to forms derived as "Distributive Iterations", see,
2250ff218e97SBarry Smith      for example, page 294 in "Principles of Computational Fluid Dynamics" by Pieter Wesseling. Note that one can also use PCFIELDSPLIT
2251ff218e97SBarry Smith      inside a smoother resulting in "Distributive Smoothers".
22520716a85fSBarry Smith 
2253a541d17aSBarry Smith    Concepts: physics based preconditioners, block preconditioners
22540971522cSBarry Smith 
22553bc631e0SBarry Smith    There is a nice discussion of block preconditioners in
22563bc631e0SBarry Smith 
22573bc631e0SBarry Smith [El08] A taxonomy and comparison of parallel block multi-level preconditioners for the incompressible Navier-Stokes equations
22583bc631e0SBarry Smith        Howard Elman, V.E. Howle, John Shadid, Robert Shuttleworth, Ray Tuminaro, Journal of Computational Physics 227 (2008) 1790--1808
22593bc631e0SBarry Smith        http://chess.cs.umd.edu/~elman/papers/tax.pdf
22603bc631e0SBarry Smith 
22617e8cb189SBarry Smith .seealso:  PCCreate(), PCSetType(), PCType (for list of available types), PC, Block_Preconditioners, PCLSC,
22621d71051fSDmitry Karpeev            PCFieldSplitGetSubKSP(), PCFieldSplitSetFields(), PCFieldSplitSetType(), PCFieldSplitSetIS(), PCFieldSplitSetSchurPre(),
22631d71051fSDmitry Karpeev 	   MatSchurComplementSetAinvType()
22640971522cSBarry Smith M*/
22650971522cSBarry Smith 
22660971522cSBarry Smith #undef __FUNCT__
22670971522cSBarry Smith #define __FUNCT__ "PCCreate_FieldSplit"
22688cc058d9SJed Brown PETSC_EXTERN PetscErrorCode PCCreate_FieldSplit(PC pc)
22690971522cSBarry Smith {
22700971522cSBarry Smith   PetscErrorCode ierr;
22710971522cSBarry Smith   PC_FieldSplit  *jac;
22720971522cSBarry Smith 
22730971522cSBarry Smith   PetscFunctionBegin;
2274b00a9115SJed Brown   ierr = PetscNewLog(pc,&jac);CHKERRQ(ierr);
22752fa5cd67SKarl Rupp 
22760971522cSBarry Smith   jac->bs                 = -1;
22770971522cSBarry Smith   jac->nsplits            = 0;
22783e197d65SBarry Smith   jac->type               = PC_COMPOSITE_MULTIPLICATIVE;
2279e6cab6aaSJed Brown   jac->schurpre           = PC_FIELDSPLIT_SCHUR_PRE_USER; /* Try user preconditioner first, fall back on diagonal */
2280c9c6ffaaSJed Brown   jac->schurfactorization = PC_FIELDSPLIT_SCHUR_FACT_FULL;
2281fbe7908bSJed Brown   jac->dm_splits          = PETSC_TRUE;
228251f519a2SBarry Smith 
22830971522cSBarry Smith   pc->data = (void*)jac;
22840971522cSBarry Smith 
22850971522cSBarry Smith   pc->ops->apply           = PCApply_FieldSplit;
2286421e10b8SBarry Smith   pc->ops->applytranspose  = PCApplyTranspose_FieldSplit;
22870971522cSBarry Smith   pc->ops->setup           = PCSetUp_FieldSplit;
2288574deadeSBarry Smith   pc->ops->reset           = PCReset_FieldSplit;
22890971522cSBarry Smith   pc->ops->destroy         = PCDestroy_FieldSplit;
22900971522cSBarry Smith   pc->ops->setfromoptions  = PCSetFromOptions_FieldSplit;
22910971522cSBarry Smith   pc->ops->view            = PCView_FieldSplit;
22920971522cSBarry Smith   pc->ops->applyrichardson = 0;
22930971522cSBarry Smith 
2294bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitGetSubKSP_C",PCFieldSplitGetSubKSP_FieldSplit);CHKERRQ(ierr);
2295bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetFields_C",PCFieldSplitSetFields_FieldSplit);CHKERRQ(ierr);
2296bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetIS_C",PCFieldSplitSetIS_FieldSplit);CHKERRQ(ierr);
2297bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetType_C",PCFieldSplitSetType_FieldSplit);CHKERRQ(ierr);
2298bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetBlockSize_C",PCFieldSplitSetBlockSize_FieldSplit);CHKERRQ(ierr);
22990971522cSBarry Smith   PetscFunctionReturn(0);
23000971522cSBarry Smith }
23010971522cSBarry Smith 
23020971522cSBarry Smith 
2303a541d17aSBarry Smith 
2304