xref: /petsc/src/ksp/pc/impls/fieldsplit/fieldsplit.c (revision ccc738f73cdca4da6a86aae33987f346ef28fee4)
1dba47a55SKris Buschelman 
2af0996ceSBarry Smith #include <petsc/private/pcimpl.h>     /*I "petscpc.h" I*/
37c1391dbSSatish Balay #include <petsc/private/kspimpl.h>
41e25c274SJed Brown #include <petscdm.h>
50971522cSBarry Smith 
6443836d0SMatthew G Knepley 
72e71c61dSMatthew G. Knepley const char *const PCFieldSplitSchurPreTypes[] = {"SELF","SELFP","A11","USER","FULL","PCFieldSplitSchurPreType","PC_FIELDSPLIT_SCHUR_PRE_",0};
8c9c6ffaaSJed Brown const char *const PCFieldSplitSchurFactTypes[] = {"DIAG","LOWER","UPPER","FULL","PCFieldSplitSchurFactType","PC_FIELDSPLIT_SCHUR_FACT_",0};
9c5d2311dSJed Brown 
109df09d43SBarry Smith PetscLogEvent KSP_Solve_FS_0,KSP_Solve_FS_1,KSP_Solve_FS_S,KSP_Solve_FS_U,KSP_Solve_FS_L,KSP_Solve_FS_2,KSP_Solve_FS_3,KSP_Solve_FS_4;
119df09d43SBarry Smith 
120971522cSBarry Smith typedef struct _PC_FieldSplitLink *PC_FieldSplitLink;
130971522cSBarry Smith struct _PC_FieldSplitLink {
1469a612a9SBarry Smith   KSP               ksp;
15443836d0SMatthew G Knepley   Vec               x,y,z;
16db4c96c1SJed Brown   char              *splitname;
170971522cSBarry Smith   PetscInt          nfields;
185d4c12cdSJungho Lee   PetscInt          *fields,*fields_col;
191b9fc7fcSBarry Smith   VecScatter        sctx;
206dbb499eSCian Wilson   IS                is,is_col,is_orig;
2151f519a2SBarry Smith   PC_FieldSplitLink next,previous;
229df09d43SBarry Smith   PetscLogEvent     event;
230971522cSBarry Smith };
240971522cSBarry Smith 
250971522cSBarry Smith typedef struct {
2668dd23aaSBarry Smith   PCCompositeType type;
27ace3abfcSBarry Smith   PetscBool       defaultsplit;                    /* Flag for a system with a set of 'k' scalar fields with the same layout (and bs = k) */
28ace3abfcSBarry Smith   PetscBool       splitdefined;                    /* Flag is set after the splits have been defined, to prevent more splits from being added */
2930ad9308SMatthew Knepley   PetscInt        bs;                              /* Block size for IS and Mat structures */
3030ad9308SMatthew Knepley   PetscInt        nsplits;                         /* Number of field divisions defined */
3179416396SBarry Smith   Vec             *x,*y,w1,w2;
32519d70e2SJed Brown   Mat             *mat;                            /* The diagonal block for each split */
33519d70e2SJed Brown   Mat             *pmat;                           /* The preconditioning diagonal block for each split */
3430ad9308SMatthew Knepley   Mat             *Afield;                         /* The rows of the matrix associated with each split */
35ace3abfcSBarry Smith   PetscBool       issetup;
362fa5cd67SKarl Rupp 
3730ad9308SMatthew Knepley   /* Only used when Schur complement preconditioning is used */
3830ad9308SMatthew Knepley   Mat                       B;                     /* The (0,1) block */
3930ad9308SMatthew Knepley   Mat                       C;                     /* The (1,0) block */
40443836d0SMatthew G Knepley   Mat                       schur;                 /* The Schur complement S = A11 - A10 A00^{-1} A01, the KSP here, kspinner, is H_1 in [El08] */
41a7476a74SDmitry Karpeev   Mat                       schurp;                /* Assembled approximation to S built by MatSchurComplement to be used as a preconditioning matrix when solving with S */
42084e4875SJed Brown   Mat                       schur_user;            /* User-provided preconditioning matrix for the Schur complement */
43084e4875SJed Brown   PCFieldSplitSchurPreType  schurpre;              /* Determines which preconditioning matrix is used for the Schur complement */
44c9c6ffaaSJed Brown   PCFieldSplitSchurFactType schurfactorization;
4530ad9308SMatthew Knepley   KSP                       kspschur;              /* The solver for S */
46443836d0SMatthew G Knepley   KSP                       kspupper;              /* The solver for A in the upper diagonal part of the factorization (H_2 in [El08]) */
4797bbdb24SBarry Smith   PC_FieldSplitLink         head;
4863ec74ffSBarry Smith   PetscBool                 reset;                  /* indicates PCReset() has been last called on this object, hack */
496dbb499eSCian Wilson   PetscBool                 isrestrict;             /* indicates PCFieldSplitRestrictIS() has been last called on this object, hack */
50c1570756SJed Brown   PetscBool                 suboptionsset;          /* Indicates that the KSPSetFromOptions() has been called on the sub-KSPs */
514ab8060aSDmitry Karpeev   PetscBool                 dm_splits;              /* Whether to use DMCreateFieldDecomposition() whenever possible */
52c84da90fSDmitry Karpeev   PetscBool                 diag_use_amat;          /* Whether to extract diagonal matrix blocks from Amat, rather than Pmat (weaker than -pc_use_amat) */
53c84da90fSDmitry Karpeev   PetscBool                 offdiag_use_amat;       /* Whether to extract off-diagonal matrix blocks from Amat, rather than Pmat (weaker than -pc_use_amat) */
540971522cSBarry Smith } PC_FieldSplit;
550971522cSBarry Smith 
5616913363SBarry Smith /*
5716913363SBarry Smith     Notes: there is no particular reason that pmat, x, and y are stored as arrays in PC_FieldSplit instead of
5816913363SBarry Smith    inside PC_FieldSplitLink, just historical. If you want to be able to add new fields after already using the
5916913363SBarry Smith    PC you could change this.
6016913363SBarry Smith */
61084e4875SJed Brown 
62e6cab6aaSJed Brown /* This helper is so that setting a user-provided preconditioning matrix is orthogonal to choosing to use it.  This way the
63084e4875SJed Brown * application-provided FormJacobian can provide this matrix without interfering with the user's (command-line) choices. */
64084e4875SJed Brown static Mat FieldSplitSchurPre(PC_FieldSplit *jac)
65084e4875SJed Brown {
66084e4875SJed Brown   switch (jac->schurpre) {
67084e4875SJed Brown   case PC_FIELDSPLIT_SCHUR_PRE_SELF: return jac->schur;
68a7476a74SDmitry Karpeev   case PC_FIELDSPLIT_SCHUR_PRE_SELFP: return jac->schurp;
69e87fab1bSBarry Smith   case PC_FIELDSPLIT_SCHUR_PRE_A11: return jac->pmat[1];
70e74569cdSMatthew G. Knepley   case PC_FIELDSPLIT_SCHUR_PRE_FULL: /* We calculate this and store it in schur_user */
71084e4875SJed Brown   case PC_FIELDSPLIT_SCHUR_PRE_USER: /* Use a user-provided matrix if it is given, otherwise diagonal block */
72084e4875SJed Brown   default:
73084e4875SJed Brown     return jac->schur_user ? jac->schur_user : jac->pmat[1];
74084e4875SJed Brown   }
75084e4875SJed Brown }
76084e4875SJed Brown 
77084e4875SJed Brown 
789804daf3SBarry Smith #include <petscdraw.h>
790971522cSBarry Smith #undef __FUNCT__
800971522cSBarry Smith #define __FUNCT__ "PCView_FieldSplit"
810971522cSBarry Smith static PetscErrorCode PCView_FieldSplit(PC pc,PetscViewer viewer)
820971522cSBarry Smith {
830971522cSBarry Smith   PC_FieldSplit     *jac = (PC_FieldSplit*)pc->data;
840971522cSBarry Smith   PetscErrorCode    ierr;
85d9884438SBarry Smith   PetscBool         iascii,isdraw;
860971522cSBarry Smith   PetscInt          i,j;
875a9f2f41SSatish Balay   PC_FieldSplitLink ilink = jac->head;
880971522cSBarry Smith 
890971522cSBarry Smith   PetscFunctionBegin;
90251f4c67SDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&iascii);CHKERRQ(ierr);
91d9884438SBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERDRAW,&isdraw);CHKERRQ(ierr);
920971522cSBarry Smith   if (iascii) {
932c9966d7SBarry Smith     if (jac->bs > 0) {
9451f519a2SBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"  FieldSplit with %s composition: total splits = %D, blocksize = %D\n",PCCompositeTypes[jac->type],jac->nsplits,jac->bs);CHKERRQ(ierr);
952c9966d7SBarry Smith     } else {
962c9966d7SBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"  FieldSplit with %s composition: total splits = %D\n",PCCompositeTypes[jac->type],jac->nsplits);CHKERRQ(ierr);
972c9966d7SBarry Smith     }
98f5236f50SJed Brown     if (pc->useAmat) {
99f5236f50SJed Brown       ierr = PetscViewerASCIIPrintf(viewer,"  using Amat (not Pmat) as operator for blocks\n");CHKERRQ(ierr);
100a3df900dSMatthew G Knepley     }
101c84da90fSDmitry Karpeev     if (jac->diag_use_amat) {
102c84da90fSDmitry Karpeev       ierr = PetscViewerASCIIPrintf(viewer,"  using Amat (not Pmat) as operator for diagonal blocks\n");CHKERRQ(ierr);
103c84da90fSDmitry Karpeev     }
104c84da90fSDmitry Karpeev     if (jac->offdiag_use_amat) {
105c84da90fSDmitry Karpeev       ierr = PetscViewerASCIIPrintf(viewer,"  using Amat (not Pmat) as operator for off-diagonal blocks\n");CHKERRQ(ierr);
106c84da90fSDmitry Karpeev     }
10769a612a9SBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"  Solver info for each split is in the following KSP objects:\n");CHKERRQ(ierr);
1080971522cSBarry Smith     ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
1090971522cSBarry Smith     for (i=0; i<jac->nsplits; i++) {
1101ab39975SBarry Smith       if (ilink->fields) {
1110971522cSBarry Smith         ierr = PetscViewerASCIIPrintf(viewer,"Split number %D Fields ",i);CHKERRQ(ierr);
11279416396SBarry Smith         ierr = PetscViewerASCIIUseTabs(viewer,PETSC_FALSE);CHKERRQ(ierr);
1135a9f2f41SSatish Balay         for (j=0; j<ilink->nfields; j++) {
11479416396SBarry Smith           if (j > 0) {
11579416396SBarry Smith             ierr = PetscViewerASCIIPrintf(viewer,",");CHKERRQ(ierr);
11679416396SBarry Smith           }
1175a9f2f41SSatish Balay           ierr = PetscViewerASCIIPrintf(viewer," %D",ilink->fields[j]);CHKERRQ(ierr);
1180971522cSBarry Smith         }
1190971522cSBarry Smith         ierr = PetscViewerASCIIPrintf(viewer,"\n");CHKERRQ(ierr);
12079416396SBarry Smith         ierr = PetscViewerASCIIUseTabs(viewer,PETSC_TRUE);CHKERRQ(ierr);
1211ab39975SBarry Smith       } else {
1221ab39975SBarry Smith         ierr = PetscViewerASCIIPrintf(viewer,"Split number %D Defined by IS\n",i);CHKERRQ(ierr);
1231ab39975SBarry Smith       }
1245a9f2f41SSatish Balay       ierr  = KSPView(ilink->ksp,viewer);CHKERRQ(ierr);
1255a9f2f41SSatish Balay       ilink = ilink->next;
1260971522cSBarry Smith     }
1270971522cSBarry Smith     ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
1282fa5cd67SKarl Rupp   }
1292fa5cd67SKarl Rupp 
1302fa5cd67SKarl Rupp  if (isdraw) {
131d9884438SBarry Smith     PetscDraw draw;
132d9884438SBarry Smith     PetscReal x,y,w,wd;
133d9884438SBarry Smith 
134d9884438SBarry Smith     ierr = PetscViewerDrawGetDraw(viewer,0,&draw);CHKERRQ(ierr);
135d9884438SBarry Smith     ierr = PetscDrawGetCurrentPoint(draw,&x,&y);CHKERRQ(ierr);
136d9884438SBarry Smith     w    = 2*PetscMin(1.0 - x,x);
137d9884438SBarry Smith     wd   = w/(jac->nsplits + 1);
138d9884438SBarry Smith     x    = x - wd*(jac->nsplits-1)/2.0;
139d9884438SBarry Smith     for (i=0; i<jac->nsplits; i++) {
140d9884438SBarry Smith       ierr  = PetscDrawPushCurrentPoint(draw,x,y);CHKERRQ(ierr);
141d9884438SBarry Smith       ierr  = KSPView(ilink->ksp,viewer);CHKERRQ(ierr);
142d9884438SBarry Smith       ierr  = PetscDrawPopCurrentPoint(draw);CHKERRQ(ierr);
143d9884438SBarry Smith       x    += wd;
144d9884438SBarry Smith       ilink = ilink->next;
145d9884438SBarry Smith     }
1460971522cSBarry Smith   }
1470971522cSBarry Smith   PetscFunctionReturn(0);
1480971522cSBarry Smith }
1490971522cSBarry Smith 
1500971522cSBarry Smith #undef __FUNCT__
1513b224e63SBarry Smith #define __FUNCT__ "PCView_FieldSplit_Schur"
1523b224e63SBarry Smith static PetscErrorCode PCView_FieldSplit_Schur(PC pc,PetscViewer viewer)
1533b224e63SBarry Smith {
1543b224e63SBarry Smith   PC_FieldSplit     *jac = (PC_FieldSplit*)pc->data;
1553b224e63SBarry Smith   PetscErrorCode    ierr;
1564996c5bdSBarry Smith   PetscBool         iascii,isdraw;
1573b224e63SBarry Smith   PetscInt          i,j;
1583b224e63SBarry Smith   PC_FieldSplitLink ilink = jac->head;
1593b224e63SBarry Smith 
1603b224e63SBarry Smith   PetscFunctionBegin;
161251f4c67SDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&iascii);CHKERRQ(ierr);
1624996c5bdSBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERDRAW,&isdraw);CHKERRQ(ierr);
1633b224e63SBarry Smith   if (iascii) {
1642c9966d7SBarry Smith     if (jac->bs > 0) {
165c9c6ffaaSJed Brown       ierr = PetscViewerASCIIPrintf(viewer,"  FieldSplit with Schur preconditioner, blocksize = %D, factorization %s\n",jac->bs,PCFieldSplitSchurFactTypes[jac->schurfactorization]);CHKERRQ(ierr);
1662c9966d7SBarry Smith     } else {
1672c9966d7SBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"  FieldSplit with Schur preconditioner, factorization %s\n",PCFieldSplitSchurFactTypes[jac->schurfactorization]);CHKERRQ(ierr);
1682c9966d7SBarry Smith     }
169f5236f50SJed Brown     if (pc->useAmat) {
170f5236f50SJed Brown       ierr = PetscViewerASCIIPrintf(viewer,"  using Amat (not Pmat) as operator for blocks\n");CHKERRQ(ierr);
171a3df900dSMatthew G Knepley     }
1723e8b8b31SMatthew G Knepley     switch (jac->schurpre) {
1733e8b8b31SMatthew G Knepley     case PC_FIELDSPLIT_SCHUR_PRE_SELF:
1743e8b8b31SMatthew G Knepley       ierr = PetscViewerASCIIPrintf(viewer,"  Preconditioner for the Schur complement formed from S itself\n");CHKERRQ(ierr);break;
175a7476a74SDmitry Karpeev     case PC_FIELDSPLIT_SCHUR_PRE_SELFP:
1761d71051fSDmitry 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;
177e87fab1bSBarry Smith     case PC_FIELDSPLIT_SCHUR_PRE_A11:
178e87fab1bSBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"  Preconditioner for the Schur complement formed from A11\n");CHKERRQ(ierr);break;
179e74569cdSMatthew G. Knepley     case PC_FIELDSPLIT_SCHUR_PRE_FULL:
180e74569cdSMatthew G. Knepley       ierr = PetscViewerASCIIPrintf(viewer,"  Preconditioner for the Schur complement formed from the exact Schur complement\n");CHKERRQ(ierr);break;
1813e8b8b31SMatthew G Knepley     case PC_FIELDSPLIT_SCHUR_PRE_USER:
1823e8b8b31SMatthew G Knepley       if (jac->schur_user) {
1833e8b8b31SMatthew G Knepley         ierr = PetscViewerASCIIPrintf(viewer,"  Preconditioner for the Schur complement formed from user provided matrix\n");CHKERRQ(ierr);
1843e8b8b31SMatthew G Knepley       } else {
185e87fab1bSBarry Smith         ierr = PetscViewerASCIIPrintf(viewer,"  Preconditioner for the Schur complement formed from A11\n");CHKERRQ(ierr);
1863e8b8b31SMatthew G Knepley       }
1873e8b8b31SMatthew G Knepley       break;
1883e8b8b31SMatthew G Knepley     default:
18982f516ccSBarry Smith       SETERRQ1(PetscObjectComm((PetscObject)pc), PETSC_ERR_ARG_OUTOFRANGE, "Invalid Schur preconditioning type: %d", jac->schurpre);
1903e8b8b31SMatthew G Knepley     }
1913b224e63SBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"  Split info:\n");CHKERRQ(ierr);
1923b224e63SBarry Smith     ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
1933b224e63SBarry Smith     for (i=0; i<jac->nsplits; i++) {
1943b224e63SBarry Smith       if (ilink->fields) {
1953b224e63SBarry Smith         ierr = PetscViewerASCIIPrintf(viewer,"Split number %D Fields ",i);CHKERRQ(ierr);
1963b224e63SBarry Smith         ierr = PetscViewerASCIIUseTabs(viewer,PETSC_FALSE);CHKERRQ(ierr);
1973b224e63SBarry Smith         for (j=0; j<ilink->nfields; j++) {
1983b224e63SBarry Smith           if (j > 0) {
1993b224e63SBarry Smith             ierr = PetscViewerASCIIPrintf(viewer,",");CHKERRQ(ierr);
2003b224e63SBarry Smith           }
2013b224e63SBarry Smith           ierr = PetscViewerASCIIPrintf(viewer," %D",ilink->fields[j]);CHKERRQ(ierr);
2023b224e63SBarry Smith         }
2033b224e63SBarry Smith         ierr = PetscViewerASCIIPrintf(viewer,"\n");CHKERRQ(ierr);
2043b224e63SBarry Smith         ierr = PetscViewerASCIIUseTabs(viewer,PETSC_TRUE);CHKERRQ(ierr);
2053b224e63SBarry Smith       } else {
2063b224e63SBarry Smith         ierr = PetscViewerASCIIPrintf(viewer,"Split number %D Defined by IS\n",i);CHKERRQ(ierr);
2073b224e63SBarry Smith       }
2083b224e63SBarry Smith       ilink = ilink->next;
2093b224e63SBarry Smith     }
210435f959eSBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"KSP solver for A00 block\n");CHKERRQ(ierr);
2113b224e63SBarry Smith     ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
21206de4afeSJed Brown     if (jac->head) {
213443836d0SMatthew G Knepley       ierr = KSPView(jac->head->ksp,viewer);CHKERRQ(ierr);
21406de4afeSJed Brown     } else  {ierr = PetscViewerASCIIPrintf(viewer,"  not yet available\n");CHKERRQ(ierr);}
2153b224e63SBarry Smith     ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
21606de4afeSJed Brown     if (jac->head && jac->kspupper != jac->head->ksp) {
217443836d0SMatthew G Knepley       ierr = PetscViewerASCIIPrintf(viewer,"KSP solver for upper A00 in upper triangular factor \n");CHKERRQ(ierr);
218443836d0SMatthew G Knepley       ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
219b2750c55SJed Brown       if (jac->kspupper) {ierr = KSPView(jac->kspupper,viewer);CHKERRQ(ierr);}
220b2750c55SJed Brown       else {ierr = PetscViewerASCIIPrintf(viewer,"  not yet available\n");CHKERRQ(ierr);}
221443836d0SMatthew G Knepley       ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
222443836d0SMatthew G Knepley     }
223435f959eSBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"KSP solver for S = A11 - A10 inv(A00) A01 \n");CHKERRQ(ierr);
2243b224e63SBarry Smith     ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
22512cae6f2SJed Brown     if (jac->kspschur) {
2263b224e63SBarry Smith       ierr = KSPView(jac->kspschur,viewer);CHKERRQ(ierr);
22712cae6f2SJed Brown     } else {
22812cae6f2SJed Brown       ierr = PetscViewerASCIIPrintf(viewer,"  not yet available\n");CHKERRQ(ierr);
22912cae6f2SJed Brown     }
2303b224e63SBarry Smith     ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
2313b224e63SBarry Smith     ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
23206de4afeSJed Brown   } else if (isdraw && jac->head) {
2334996c5bdSBarry Smith     PetscDraw draw;
2344996c5bdSBarry Smith     PetscReal x,y,w,wd,h;
2354996c5bdSBarry Smith     PetscInt  cnt = 2;
2364996c5bdSBarry Smith     char      str[32];
2374996c5bdSBarry Smith 
2384996c5bdSBarry Smith     ierr = PetscViewerDrawGetDraw(viewer,0,&draw);CHKERRQ(ierr);
2394996c5bdSBarry Smith     ierr = PetscDrawGetCurrentPoint(draw,&x,&y);CHKERRQ(ierr);
240c74581afSBarry Smith     if (jac->kspupper != jac->head->ksp) cnt++;
241c74581afSBarry Smith     w  = 2*PetscMin(1.0 - x,x);
242c74581afSBarry Smith     wd = w/(cnt + 1);
243c74581afSBarry Smith 
2444996c5bdSBarry Smith     ierr = PetscSNPrintf(str,32,"Schur fact. %s",PCFieldSplitSchurFactTypes[jac->schurfactorization]);CHKERRQ(ierr);
24551fa3d41SBarry Smith     ierr = PetscDrawStringBoxed(draw,x,y,PETSC_DRAW_RED,PETSC_DRAW_BLACK,str,NULL,&h);CHKERRQ(ierr);
2464996c5bdSBarry Smith     y   -= h;
2474996c5bdSBarry Smith     if (jac->schurpre == PC_FIELDSPLIT_SCHUR_PRE_USER &&  !jac->schur_user) {
248e87fab1bSBarry Smith       ierr = PetscSNPrintf(str,32,"Prec. for Schur from %s",PCFieldSplitSchurPreTypes[PC_FIELDSPLIT_SCHUR_PRE_A11]);CHKERRQ(ierr);
2493b224e63SBarry Smith     } else {
2504996c5bdSBarry Smith       ierr = PetscSNPrintf(str,32,"Prec. for Schur from %s",PCFieldSplitSchurPreTypes[jac->schurpre]);CHKERRQ(ierr);
2514996c5bdSBarry Smith     }
25251fa3d41SBarry Smith     ierr = PetscDrawStringBoxed(draw,x+wd*(cnt-1)/2.0,y,PETSC_DRAW_RED,PETSC_DRAW_BLACK,str,NULL,&h);CHKERRQ(ierr);
2534996c5bdSBarry Smith     y   -= h;
2544996c5bdSBarry Smith     x    = x - wd*(cnt-1)/2.0;
2554996c5bdSBarry Smith 
2564996c5bdSBarry Smith     ierr = PetscDrawPushCurrentPoint(draw,x,y);CHKERRQ(ierr);
2574996c5bdSBarry Smith     ierr = KSPView(jac->head->ksp,viewer);CHKERRQ(ierr);
2584996c5bdSBarry Smith     ierr = PetscDrawPopCurrentPoint(draw);CHKERRQ(ierr);
2594996c5bdSBarry Smith     if (jac->kspupper != jac->head->ksp) {
2604996c5bdSBarry Smith       x   += wd;
2614996c5bdSBarry Smith       ierr = PetscDrawPushCurrentPoint(draw,x,y);CHKERRQ(ierr);
2624996c5bdSBarry Smith       ierr = KSPView(jac->kspupper,viewer);CHKERRQ(ierr);
2634996c5bdSBarry Smith       ierr = PetscDrawPopCurrentPoint(draw);CHKERRQ(ierr);
2644996c5bdSBarry Smith     }
2654996c5bdSBarry Smith     x   += wd;
2664996c5bdSBarry Smith     ierr = PetscDrawPushCurrentPoint(draw,x,y);CHKERRQ(ierr);
2674996c5bdSBarry Smith     ierr = KSPView(jac->kspschur,viewer);CHKERRQ(ierr);
2684996c5bdSBarry Smith     ierr = PetscDrawPopCurrentPoint(draw);CHKERRQ(ierr);
2693b224e63SBarry Smith   }
2703b224e63SBarry Smith   PetscFunctionReturn(0);
2713b224e63SBarry Smith }
2723b224e63SBarry Smith 
2733b224e63SBarry Smith #undef __FUNCT__
2746c924f48SJed Brown #define __FUNCT__ "PCFieldSplitSetRuntimeSplits_Private"
2756c924f48SJed Brown /* Precondition: jac->bs is set to a meaningful value */
2766c924f48SJed Brown static PetscErrorCode PCFieldSplitSetRuntimeSplits_Private(PC pc)
2776c924f48SJed Brown {
2786c924f48SJed Brown   PetscErrorCode ierr;
2796c924f48SJed Brown   PC_FieldSplit  *jac = (PC_FieldSplit*)pc->data;
2805d4c12cdSJungho Lee   PetscInt       i,nfields,*ifields,nfields_col,*ifields_col;
2815d4c12cdSJungho Lee   PetscBool      flg,flg_col;
2825d4c12cdSJungho Lee   char           optionname[128],splitname[8],optionname_col[128];
2836c924f48SJed Brown 
2846c924f48SJed Brown   PetscFunctionBegin;
285785e854fSJed Brown   ierr = PetscMalloc1(jac->bs,&ifields);CHKERRQ(ierr);
286785e854fSJed Brown   ierr = PetscMalloc1(jac->bs,&ifields_col);CHKERRQ(ierr);
2876c924f48SJed Brown   for (i=0,flg=PETSC_TRUE;; i++) {
2888caf3d72SBarry Smith     ierr        = PetscSNPrintf(splitname,sizeof(splitname),"%D",i);CHKERRQ(ierr);
2898caf3d72SBarry Smith     ierr        = PetscSNPrintf(optionname,sizeof(optionname),"-pc_fieldsplit_%D_fields",i);CHKERRQ(ierr);
2908caf3d72SBarry Smith     ierr        = PetscSNPrintf(optionname_col,sizeof(optionname_col),"-pc_fieldsplit_%D_fields_col",i);CHKERRQ(ierr);
2916c924f48SJed Brown     nfields     = jac->bs;
29229499fbbSJungho Lee     nfields_col = jac->bs;
293c5929fdfSBarry Smith     ierr        = PetscOptionsGetIntArray(((PetscObject)pc)->options,((PetscObject)pc)->prefix,optionname,ifields,&nfields,&flg);CHKERRQ(ierr);
294c5929fdfSBarry Smith     ierr        = PetscOptionsGetIntArray(((PetscObject)pc)->options,((PetscObject)pc)->prefix,optionname_col,ifields_col,&nfields_col,&flg_col);CHKERRQ(ierr);
2956c924f48SJed Brown     if (!flg) break;
2965d4c12cdSJungho Lee     else if (flg && !flg_col) {
2975d4c12cdSJungho Lee       if (!nfields) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_USER,"Cannot list zero fields");
2985d4c12cdSJungho Lee       ierr = PCFieldSplitSetFields(pc,splitname,nfields,ifields,ifields);CHKERRQ(ierr);
2992fa5cd67SKarl Rupp     } else {
3005d4c12cdSJungho Lee       if (!nfields || !nfields_col) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_USER,"Cannot list zero fields");
3015d4c12cdSJungho Lee       if (nfields != nfields_col) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_USER,"Number of row and column fields must match");
3025d4c12cdSJungho Lee       ierr = PCFieldSplitSetFields(pc,splitname,nfields,ifields,ifields_col);CHKERRQ(ierr);
3035d4c12cdSJungho Lee     }
3046c924f48SJed Brown   }
3056c924f48SJed Brown   if (i > 0) {
3066c924f48SJed Brown     /* Makes command-line setting of splits take precedence over setting them in code.
3076c924f48SJed Brown        Otherwise subsequent calls to PCFieldSplitSetIS() or PCFieldSplitSetFields() would
3086c924f48SJed Brown        create new splits, which would probably not be what the user wanted. */
3096c924f48SJed Brown     jac->splitdefined = PETSC_TRUE;
3106c924f48SJed Brown   }
3116c924f48SJed Brown   ierr = PetscFree(ifields);CHKERRQ(ierr);
3125d4c12cdSJungho Lee   ierr = PetscFree(ifields_col);CHKERRQ(ierr);
3136c924f48SJed Brown   PetscFunctionReturn(0);
3146c924f48SJed Brown }
3156c924f48SJed Brown 
3166c924f48SJed Brown #undef __FUNCT__
31769a612a9SBarry Smith #define __FUNCT__ "PCFieldSplitSetDefaults"
31869a612a9SBarry Smith static PetscErrorCode PCFieldSplitSetDefaults(PC pc)
3190971522cSBarry Smith {
3200971522cSBarry Smith   PC_FieldSplit     *jac = (PC_FieldSplit*)pc->data;
3210971522cSBarry Smith   PetscErrorCode    ierr;
3225a9f2f41SSatish Balay   PC_FieldSplitLink ilink              = jac->head;
3233a062f41SBarry Smith   PetscBool         fieldsplit_default = PETSC_FALSE,stokes = PETSC_FALSE,coupling = PETSC_FALSE;
3246c924f48SJed Brown   PetscInt          i;
3250971522cSBarry Smith 
3260971522cSBarry Smith   PetscFunctionBegin;
3277287d2a3SDmitry Karpeev   /*
3287287d2a3SDmitry Karpeev    Kinda messy, but at least this now uses DMCreateFieldDecomposition() even with jac->reset.
3297287d2a3SDmitry Karpeev    Should probably be rewritten.
3307287d2a3SDmitry Karpeev    */
3317287d2a3SDmitry Karpeev   if (!ilink || jac->reset) {
332c5929fdfSBarry Smith     ierr = PetscOptionsGetBool(((PetscObject)pc)->options,((PetscObject)pc)->prefix,"-pc_fieldsplit_detect_saddle_point",&stokes,NULL);CHKERRQ(ierr);
333c5929fdfSBarry Smith     ierr = PetscOptionsGetBool(((PetscObject)pc)->options,((PetscObject)pc)->prefix,"-pc_fieldsplit_detect_coupling",&coupling,NULL);CHKERRQ(ierr);
3343a062f41SBarry Smith     if (pc->dm && jac->dm_splits && !stokes && !coupling) {
335bafc1b83SMatthew G Knepley       PetscInt  numFields, f, i, j;
3360784a22cSJed Brown       char      **fieldNames;
3377b62db95SJungho Lee       IS        *fields;
338e7c4fc90SDmitry Karpeev       DM        *dms;
339bafc1b83SMatthew G Knepley       DM        subdm[128];
340bafc1b83SMatthew G Knepley       PetscBool flg;
341bafc1b83SMatthew G Knepley 
34216621825SDmitry Karpeev       ierr = DMCreateFieldDecomposition(pc->dm, &numFields, &fieldNames, &fields, &dms);CHKERRQ(ierr);
343bafc1b83SMatthew G Knepley       /* Allow the user to prescribe the splits */
344bafc1b83SMatthew G Knepley       for (i = 0, flg = PETSC_TRUE;; i++) {
345bafc1b83SMatthew G Knepley         PetscInt ifields[128];
346bafc1b83SMatthew G Knepley         IS       compField;
347bafc1b83SMatthew G Knepley         char     optionname[128], splitname[8];
348bafc1b83SMatthew G Knepley         PetscInt nfields = numFields;
349bafc1b83SMatthew G Knepley 
3508caf3d72SBarry Smith         ierr = PetscSNPrintf(optionname, sizeof(optionname), "-pc_fieldsplit_%D_fields", i);CHKERRQ(ierr);
351c5929fdfSBarry Smith         ierr = PetscOptionsGetIntArray(((PetscObject)pc)->options,((PetscObject)pc)->prefix, optionname, ifields, &nfields, &flg);CHKERRQ(ierr);
352bafc1b83SMatthew G Knepley         if (!flg) break;
35382f516ccSBarry Smith         if (numFields > 128) SETERRQ1(PetscObjectComm((PetscObject)pc),PETSC_ERR_SUP,"Cannot currently support %d > 128 fields", numFields);
354bafc1b83SMatthew G Knepley         ierr = DMCreateSubDM(pc->dm, nfields, ifields, &compField, &subdm[i]);CHKERRQ(ierr);
355bafc1b83SMatthew G Knepley         if (nfields == 1) {
356bafc1b83SMatthew G Knepley           ierr = PCFieldSplitSetIS(pc, fieldNames[ifields[0]], compField);CHKERRQ(ierr);
35782f516ccSBarry Smith           /* ierr = PetscPrintf(PetscObjectComm((PetscObject)pc), "%s Field Indices:", fieldNames[ifields[0]]);CHKERRQ(ierr);
3580298fd71SBarry Smith              ierr = ISView(compField, NULL);CHKERRQ(ierr); */
359bafc1b83SMatthew G Knepley         } else {
3608caf3d72SBarry Smith           ierr = PetscSNPrintf(splitname, sizeof(splitname), "%D", i);CHKERRQ(ierr);
361bafc1b83SMatthew G Knepley           ierr = PCFieldSplitSetIS(pc, splitname, compField);CHKERRQ(ierr);
36282f516ccSBarry Smith           /* ierr = PetscPrintf(PetscObjectComm((PetscObject)pc), "%s Field Indices:", splitname);CHKERRQ(ierr);
3630298fd71SBarry Smith              ierr = ISView(compField, NULL);CHKERRQ(ierr); */
3647287d2a3SDmitry Karpeev         }
365bafc1b83SMatthew G Knepley         ierr = ISDestroy(&compField);CHKERRQ(ierr);
366bafc1b83SMatthew G Knepley         for (j = 0; j < nfields; ++j) {
367bafc1b83SMatthew G Knepley           f    = ifields[j];
3687b62db95SJungho Lee           ierr = PetscFree(fieldNames[f]);CHKERRQ(ierr);
3697b62db95SJungho Lee           ierr = ISDestroy(&fields[f]);CHKERRQ(ierr);
3707b62db95SJungho Lee         }
371bafc1b83SMatthew G Knepley       }
372bafc1b83SMatthew G Knepley       if (i == 0) {
373bafc1b83SMatthew G Knepley         for (f = 0; f < numFields; ++f) {
374bafc1b83SMatthew G Knepley           ierr = PCFieldSplitSetIS(pc, fieldNames[f], fields[f]);CHKERRQ(ierr);
375bafc1b83SMatthew G Knepley           ierr = PetscFree(fieldNames[f]);CHKERRQ(ierr);
376bafc1b83SMatthew G Knepley           ierr = ISDestroy(&fields[f]);CHKERRQ(ierr);
377bafc1b83SMatthew G Knepley         }
378bafc1b83SMatthew G Knepley       } else {
379d724dfffSBarry Smith         for (j=0; j<numFields; j++) {
380d724dfffSBarry Smith           ierr = DMDestroy(dms+j);CHKERRQ(ierr);
381d724dfffSBarry Smith         }
382d724dfffSBarry Smith         ierr = PetscFree(dms);CHKERRQ(ierr);
383785e854fSJed Brown         ierr = PetscMalloc1(i, &dms);CHKERRQ(ierr);
3842fa5cd67SKarl Rupp         for (j = 0; j < i; ++j) dms[j] = subdm[j];
385bafc1b83SMatthew G Knepley       }
3867b62db95SJungho Lee       ierr = PetscFree(fieldNames);CHKERRQ(ierr);
3877b62db95SJungho Lee       ierr = PetscFree(fields);CHKERRQ(ierr);
388e7c4fc90SDmitry Karpeev       if (dms) {
3898b8307b2SJed Brown         ierr = PetscInfo(pc, "Setting up physics based fieldsplit preconditioner using the embedded DM\n");CHKERRQ(ierr);
390bafc1b83SMatthew G Knepley         for (ilink = jac->head, i = 0; ilink; ilink = ilink->next, ++i) {
3917287d2a3SDmitry Karpeev           const char *prefix;
3927287d2a3SDmitry Karpeev           ierr = PetscObjectGetOptionsPrefix((PetscObject)(ilink->ksp),&prefix);CHKERRQ(ierr);
3937287d2a3SDmitry Karpeev           ierr = PetscObjectSetOptionsPrefix((PetscObject)(dms[i]), prefix);CHKERRQ(ierr);
3947b62db95SJungho Lee           ierr = KSPSetDM(ilink->ksp, dms[i]);CHKERRQ(ierr);
3957b62db95SJungho Lee           ierr = KSPSetDMActive(ilink->ksp, PETSC_FALSE);CHKERRQ(ierr);
3967287d2a3SDmitry Karpeev           ierr = PetscObjectIncrementTabLevel((PetscObject)dms[i],(PetscObject)ilink->ksp,0);CHKERRQ(ierr);
397e7c4fc90SDmitry Karpeev           ierr = DMDestroy(&dms[i]);CHKERRQ(ierr);
3982fa5ba8aSJed Brown         }
3997b62db95SJungho Lee         ierr = PetscFree(dms);CHKERRQ(ierr);
4008b8307b2SJed Brown       }
40166ffff09SJed Brown     } else {
402521d7252SBarry Smith       if (jac->bs <= 0) {
403704ba839SBarry Smith         if (pc->pmat) {
404521d7252SBarry Smith           ierr = MatGetBlockSize(pc->pmat,&jac->bs);CHKERRQ(ierr);
4052fa5cd67SKarl Rupp         } else jac->bs = 1;
406521d7252SBarry Smith       }
407d32f9abdSBarry Smith 
4086ce1633cSBarry Smith       if (stokes) {
4096ce1633cSBarry Smith         IS       zerodiags,rest;
4106ce1633cSBarry Smith         PetscInt nmin,nmax;
4116ce1633cSBarry Smith 
4126ce1633cSBarry Smith         ierr = MatGetOwnershipRange(pc->mat,&nmin,&nmax);CHKERRQ(ierr);
4136ce1633cSBarry Smith         ierr = MatFindZeroDiagonals(pc->mat,&zerodiags);CHKERRQ(ierr);
4146ce1633cSBarry Smith         ierr = ISComplement(zerodiags,nmin,nmax,&rest);CHKERRQ(ierr);
4157287d2a3SDmitry Karpeev         if (jac->reset) {
4167287d2a3SDmitry Karpeev           jac->head->is       = rest;
4177287d2a3SDmitry Karpeev           jac->head->next->is = zerodiags;
4182fa5cd67SKarl Rupp         } else {
4196ce1633cSBarry Smith           ierr = PCFieldSplitSetIS(pc,"0",rest);CHKERRQ(ierr);
4206ce1633cSBarry Smith           ierr = PCFieldSplitSetIS(pc,"1",zerodiags);CHKERRQ(ierr);
4217287d2a3SDmitry Karpeev         }
422fcfd50ebSBarry Smith         ierr = ISDestroy(&zerodiags);CHKERRQ(ierr);
423fcfd50ebSBarry Smith         ierr = ISDestroy(&rest);CHKERRQ(ierr);
4243a062f41SBarry Smith       } else if (coupling) {
4253a062f41SBarry Smith         IS       coupling,rest;
4263a062f41SBarry Smith         PetscInt nmin,nmax;
4273a062f41SBarry Smith 
4283a062f41SBarry Smith         ierr = MatGetOwnershipRange(pc->mat,&nmin,&nmax);CHKERRQ(ierr);
4293a062f41SBarry Smith         ierr = MatFindOffBlockDiagonalEntries(pc->mat,&coupling);CHKERRQ(ierr);
4306bea0878SBarry Smith         ierr = ISCreateStride(PetscObjectComm((PetscObject)pc->mat),nmax-nmin,nmin,1,&rest);CHKERRQ(ierr);
431e52d2c62SBarry Smith         ierr = ISSetIdentity(rest);CHKERRQ(ierr);
4323a062f41SBarry Smith         if (jac->reset) {
433bb3d4b4cSBarry Smith           jac->head->is       = rest;
434bb3d4b4cSBarry Smith           jac->head->next->is = coupling;
4353a062f41SBarry Smith         } else {
436d020c841SBarry Smith           ierr = PCFieldSplitSetIS(pc,"0",rest);CHKERRQ(ierr);
437d020c841SBarry Smith           ierr = PCFieldSplitSetIS(pc,"1",coupling);CHKERRQ(ierr);
4383a062f41SBarry Smith         }
4393a062f41SBarry Smith         ierr = ISDestroy(&coupling);CHKERRQ(ierr);
4403a062f41SBarry Smith         ierr = ISDestroy(&rest);CHKERRQ(ierr);
4416ce1633cSBarry Smith       } else {
4426dbb499eSCian Wilson         if (jac->reset && !jac->isrestrict) SETERRQ(PetscObjectComm((PetscObject)pc),PETSC_ERR_SUP,"Cases not yet handled when PCReset() was used");
443c5929fdfSBarry Smith         ierr = PetscOptionsGetBool(((PetscObject)pc)->options,((PetscObject)pc)->prefix,"-pc_fieldsplit_default",&fieldsplit_default,NULL);CHKERRQ(ierr);
4447287d2a3SDmitry Karpeev         if (!fieldsplit_default) {
445d32f9abdSBarry Smith           /* Allow user to set fields from command line,  if bs was known at the time of PCSetFromOptions_FieldSplit()
446d32f9abdSBarry Smith            then it is set there. This is not ideal because we should only have options set in XXSetFromOptions(). */
4476c924f48SJed Brown           ierr = PCFieldSplitSetRuntimeSplits_Private(pc);CHKERRQ(ierr);
4486c924f48SJed Brown           if (jac->splitdefined) {ierr = PetscInfo(pc,"Splits defined using the options database\n");CHKERRQ(ierr);}
449d32f9abdSBarry Smith         }
4506dbb499eSCian Wilson         if ((fieldsplit_default || !jac->splitdefined) && !jac->isrestrict) {
451d32f9abdSBarry Smith           ierr = PetscInfo(pc,"Using default splitting of fields\n");CHKERRQ(ierr);
452db4c96c1SJed Brown           for (i=0; i<jac->bs; i++) {
4536c924f48SJed Brown             char splitname[8];
4548caf3d72SBarry Smith             ierr = PetscSNPrintf(splitname,sizeof(splitname),"%D",i);CHKERRQ(ierr);
4555d4c12cdSJungho Lee             ierr = PCFieldSplitSetFields(pc,splitname,1,&i,&i);CHKERRQ(ierr);
45679416396SBarry Smith           }
4575d4c12cdSJungho Lee           jac->defaultsplit = PETSC_TRUE;
458521d7252SBarry Smith         }
45966ffff09SJed Brown       }
4606ce1633cSBarry Smith     }
461edf189efSBarry Smith   } else if (jac->nsplits == 1) {
462edf189efSBarry Smith     if (ilink->is) {
463edf189efSBarry Smith       IS       is2;
464edf189efSBarry Smith       PetscInt nmin,nmax;
465edf189efSBarry Smith 
466edf189efSBarry Smith       ierr = MatGetOwnershipRange(pc->mat,&nmin,&nmax);CHKERRQ(ierr);
467edf189efSBarry Smith       ierr = ISComplement(ilink->is,nmin,nmax,&is2);CHKERRQ(ierr);
468db4c96c1SJed Brown       ierr = PCFieldSplitSetIS(pc,"1",is2);CHKERRQ(ierr);
469fcfd50ebSBarry Smith       ierr = ISDestroy(&is2);CHKERRQ(ierr);
47082f516ccSBarry Smith     } else SETERRQ(PetscObjectComm((PetscObject)pc),PETSC_ERR_SUP,"Must provide at least two sets of fields to PCFieldSplit()");
471edf189efSBarry Smith   }
472d0af7cd3SBarry Smith 
473d0af7cd3SBarry Smith 
47482f516ccSBarry Smith   if (jac->nsplits < 2) SETERRQ1(PetscObjectComm((PetscObject)pc),PETSC_ERR_PLIB,"Unhandled case, must have at least two fields, not %d", jac->nsplits);
47569a612a9SBarry Smith   PetscFunctionReturn(0);
47669a612a9SBarry Smith }
47769a612a9SBarry Smith 
478c5929fdfSBarry Smith PETSC_EXTERN PetscErrorCode PetscOptionsFindPairPrefix_Private(PetscOptions,const char pre[], const char name[], char *value[], PetscBool *flg);
479514bf10dSMatthew G Knepley 
48069a612a9SBarry Smith #undef __FUNCT__
48169a612a9SBarry Smith #define __FUNCT__ "PCSetUp_FieldSplit"
48269a612a9SBarry Smith static PetscErrorCode PCSetUp_FieldSplit(PC pc)
48369a612a9SBarry Smith {
48469a612a9SBarry Smith   PC_FieldSplit     *jac = (PC_FieldSplit*)pc->data;
48569a612a9SBarry Smith   PetscErrorCode    ierr;
4865a9f2f41SSatish Balay   PC_FieldSplitLink ilink;
4872c9966d7SBarry Smith   PetscInt          i,nsplit;
4885f4ab4e1SJungho Lee   PetscBool         sorted, sorted_col;
48969a612a9SBarry Smith 
49069a612a9SBarry Smith   PetscFunctionBegin;
49169a612a9SBarry Smith   ierr   = PCFieldSplitSetDefaults(pc);CHKERRQ(ierr);
49297bbdb24SBarry Smith   nsplit = jac->nsplits;
4935a9f2f41SSatish Balay   ilink  = jac->head;
49497bbdb24SBarry Smith 
49597bbdb24SBarry Smith   /* get the matrices for each split */
496704ba839SBarry Smith   if (!jac->issetup) {
4971b9fc7fcSBarry Smith     PetscInt rstart,rend,nslots,bs;
49897bbdb24SBarry Smith 
499704ba839SBarry Smith     jac->issetup = PETSC_TRUE;
500704ba839SBarry Smith 
5015d4c12cdSJungho Lee     /* This is done here instead of in PCFieldSplitSetFields() because may not have matrix at that point */
5022c9966d7SBarry Smith     if (jac->defaultsplit || !ilink->is) {
5032c9966d7SBarry Smith       if (jac->bs <= 0) jac->bs = nsplit;
5042c9966d7SBarry Smith     }
50551f519a2SBarry Smith     bs     = jac->bs;
50697bbdb24SBarry Smith     ierr   = MatGetOwnershipRange(pc->pmat,&rstart,&rend);CHKERRQ(ierr);
5071b9fc7fcSBarry Smith     nslots = (rend - rstart)/bs;
5081b9fc7fcSBarry Smith     for (i=0; i<nsplit; i++) {
5091b9fc7fcSBarry Smith       if (jac->defaultsplit) {
510ce94432eSBarry Smith         ierr = ISCreateStride(PetscObjectComm((PetscObject)pc),nslots,rstart+i,nsplit,&ilink->is);CHKERRQ(ierr);
5115f4ab4e1SJungho Lee         ierr = ISDuplicate(ilink->is,&ilink->is_col);CHKERRQ(ierr);
512704ba839SBarry Smith       } else if (!ilink->is) {
513ccb205f8SBarry Smith         if (ilink->nfields > 1) {
5145f4ab4e1SJungho Lee           PetscInt *ii,*jj,j,k,nfields = ilink->nfields,*fields = ilink->fields,*fields_col = ilink->fields_col;
515785e854fSJed Brown           ierr = PetscMalloc1(ilink->nfields*nslots,&ii);CHKERRQ(ierr);
516785e854fSJed Brown           ierr = PetscMalloc1(ilink->nfields*nslots,&jj);CHKERRQ(ierr);
5171b9fc7fcSBarry Smith           for (j=0; j<nslots; j++) {
5181b9fc7fcSBarry Smith             for (k=0; k<nfields; k++) {
5191b9fc7fcSBarry Smith               ii[nfields*j + k] = rstart + bs*j + fields[k];
5205f4ab4e1SJungho Lee               jj[nfields*j + k] = rstart + bs*j + fields_col[k];
52197bbdb24SBarry Smith             }
52297bbdb24SBarry Smith           }
523ce94432eSBarry Smith           ierr = ISCreateGeneral(PetscObjectComm((PetscObject)pc),nslots*nfields,ii,PETSC_OWN_POINTER,&ilink->is);CHKERRQ(ierr);
524ce94432eSBarry Smith           ierr = ISCreateGeneral(PetscObjectComm((PetscObject)pc),nslots*nfields,jj,PETSC_OWN_POINTER,&ilink->is_col);CHKERRQ(ierr);
52590e68f20SPatrick Farrell           ierr = ISSetBlockSize(ilink->is, nfields);CHKERRQ(ierr);
52690e68f20SPatrick Farrell           ierr = ISSetBlockSize(ilink->is_col, nfields);CHKERRQ(ierr);
527ccb205f8SBarry Smith         } else {
528ce94432eSBarry Smith           ierr = ISCreateStride(PetscObjectComm((PetscObject)pc),nslots,rstart+ilink->fields[0],bs,&ilink->is);CHKERRQ(ierr);
529ce94432eSBarry Smith           ierr = ISCreateStride(PetscObjectComm((PetscObject)pc),nslots,rstart+ilink->fields_col[0],bs,&ilink->is_col);CHKERRQ(ierr);
530ccb205f8SBarry Smith        }
5313e197d65SBarry Smith       }
532704ba839SBarry Smith       ierr = ISSorted(ilink->is,&sorted);CHKERRQ(ierr);
5335f4ab4e1SJungho Lee       if (ilink->is_col) { ierr = ISSorted(ilink->is_col,&sorted_col);CHKERRQ(ierr); }
5345f4ab4e1SJungho Lee       if (!sorted || !sorted_col) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_USER,"Fields must be sorted when creating split");
535704ba839SBarry Smith       ilink = ilink->next;
5361b9fc7fcSBarry Smith     }
5371b9fc7fcSBarry Smith   }
5381b9fc7fcSBarry Smith 
539704ba839SBarry Smith   ilink = jac->head;
54097bbdb24SBarry Smith   if (!jac->pmat) {
541bdddcaaaSMatthew G Knepley     Vec xtmp;
542bdddcaaaSMatthew G Knepley 
5432a7a6963SBarry Smith     ierr = MatCreateVecs(pc->pmat,&xtmp,NULL);CHKERRQ(ierr);
544785e854fSJed Brown     ierr = PetscMalloc1(nsplit,&jac->pmat);CHKERRQ(ierr);
545dcca6d9dSJed Brown     ierr = PetscMalloc2(nsplit,&jac->x,nsplit,&jac->y);CHKERRQ(ierr);
546cf502942SBarry Smith     for (i=0; i<nsplit; i++) {
547bdddcaaaSMatthew G Knepley       MatNullSpace sp;
548bdddcaaaSMatthew G Knepley 
549a3df900dSMatthew G Knepley       /* Check for preconditioning matrix attached to IS */
550a3df900dSMatthew G Knepley       ierr = PetscObjectQuery((PetscObject) ilink->is, "pmat", (PetscObject*) &jac->pmat[i]);CHKERRQ(ierr);
551a3df900dSMatthew G Knepley       if (jac->pmat[i]) {
552a3df900dSMatthew G Knepley         ierr = PetscObjectReference((PetscObject) jac->pmat[i]);CHKERRQ(ierr);
553a3df900dSMatthew G Knepley         if (jac->type == PC_COMPOSITE_SCHUR) {
554a3df900dSMatthew G Knepley           jac->schur_user = jac->pmat[i];
5552fa5cd67SKarl Rupp 
556a3df900dSMatthew G Knepley           ierr = PetscObjectReference((PetscObject) jac->schur_user);CHKERRQ(ierr);
557a3df900dSMatthew G Knepley         }
558a3df900dSMatthew G Knepley       } else {
5593a062f41SBarry Smith         const char *prefix;
5605f4ab4e1SJungho Lee         ierr = MatGetSubMatrix(pc->pmat,ilink->is,ilink->is_col,MAT_INITIAL_MATRIX,&jac->pmat[i]);CHKERRQ(ierr);
5613a062f41SBarry Smith         ierr = KSPGetOptionsPrefix(ilink->ksp,&prefix);CHKERRQ(ierr);
5623a062f41SBarry Smith         ierr = MatSetOptionsPrefix(jac->pmat[i],prefix);CHKERRQ(ierr);
5633a062f41SBarry Smith         ierr = MatViewFromOptions(jac->pmat[i],NULL,"-mat_view");CHKERRQ(ierr);
564a3df900dSMatthew G Knepley       }
565bdddcaaaSMatthew G Knepley       /* create work vectors for each split */
5662a7a6963SBarry Smith       ierr     = MatCreateVecs(jac->pmat[i],&jac->x[i],&jac->y[i]);CHKERRQ(ierr);
5670298fd71SBarry Smith       ilink->x = jac->x[i]; ilink->y = jac->y[i]; ilink->z = NULL;
568bdddcaaaSMatthew G Knepley       /* compute scatter contexts needed by multiplicative versions and non-default splits */
5690298fd71SBarry Smith       ierr = VecScatterCreate(xtmp,ilink->is,jac->x[i],NULL,&ilink->sctx);CHKERRQ(ierr);
570ed1f0337SMatthew G Knepley       ierr = PetscObjectQuery((PetscObject) ilink->is, "nearnullspace", (PetscObject*) &sp);CHKERRQ(ierr);
571ed1f0337SMatthew G Knepley       if (sp) {
572ed1f0337SMatthew G Knepley         ierr = MatSetNearNullSpace(jac->pmat[i], sp);CHKERRQ(ierr);
573ed1f0337SMatthew G Knepley       }
574704ba839SBarry Smith       ilink = ilink->next;
575cf502942SBarry Smith     }
576bdddcaaaSMatthew G Knepley     ierr = VecDestroy(&xtmp);CHKERRQ(ierr);
57797bbdb24SBarry Smith   } else {
578cf502942SBarry Smith     for (i=0; i<nsplit; i++) {
579a3df900dSMatthew G Knepley       Mat pmat;
580a3df900dSMatthew G Knepley 
581a3df900dSMatthew G Knepley       /* Check for preconditioning matrix attached to IS */
582a3df900dSMatthew G Knepley       ierr = PetscObjectQuery((PetscObject) ilink->is, "pmat", (PetscObject*) &pmat);CHKERRQ(ierr);
583a3df900dSMatthew G Knepley       if (!pmat) {
5845f4ab4e1SJungho Lee         ierr = MatGetSubMatrix(pc->pmat,ilink->is,ilink->is_col,MAT_REUSE_MATRIX,&jac->pmat[i]);CHKERRQ(ierr);
585a3df900dSMatthew G Knepley       }
586704ba839SBarry Smith       ilink = ilink->next;
587cf502942SBarry Smith     }
58897bbdb24SBarry Smith   }
5894e39094bSDmitry Karpeev   if (jac->diag_use_amat) {
590519d70e2SJed Brown     ilink = jac->head;
591519d70e2SJed Brown     if (!jac->mat) {
592785e854fSJed Brown       ierr = PetscMalloc1(nsplit,&jac->mat);CHKERRQ(ierr);
593519d70e2SJed Brown       for (i=0; i<nsplit; i++) {
5945f4ab4e1SJungho Lee         ierr  = MatGetSubMatrix(pc->mat,ilink->is,ilink->is_col,MAT_INITIAL_MATRIX,&jac->mat[i]);CHKERRQ(ierr);
595519d70e2SJed Brown         ilink = ilink->next;
596519d70e2SJed Brown       }
597519d70e2SJed Brown     } else {
598519d70e2SJed Brown       for (i=0; i<nsplit; i++) {
5995f4ab4e1SJungho Lee         if (jac->mat[i]) {ierr = MatGetSubMatrix(pc->mat,ilink->is,ilink->is_col,MAT_REUSE_MATRIX,&jac->mat[i]);CHKERRQ(ierr);}
600519d70e2SJed Brown         ilink = ilink->next;
601519d70e2SJed Brown       }
602519d70e2SJed Brown     }
603519d70e2SJed Brown   } else {
604519d70e2SJed Brown     jac->mat = jac->pmat;
605519d70e2SJed Brown   }
60697bbdb24SBarry Smith 
60753935eafSBarry Smith   /* Check for null space attached to IS */
60853935eafSBarry Smith   ilink = jac->head;
60953935eafSBarry Smith   for (i=0; i<nsplit; i++) {
61053935eafSBarry Smith     MatNullSpace sp;
61153935eafSBarry Smith 
61253935eafSBarry Smith     ierr = PetscObjectQuery((PetscObject) ilink->is, "nullspace", (PetscObject*) &sp);CHKERRQ(ierr);
61353935eafSBarry Smith     if (sp) {
61453935eafSBarry Smith       ierr = MatSetNullSpace(jac->mat[i], sp);CHKERRQ(ierr);
61553935eafSBarry Smith     }
61653935eafSBarry Smith     ilink = ilink->next;
61753935eafSBarry Smith   }
61853935eafSBarry Smith 
6196c8605c2SJed Brown   if (jac->type != PC_COMPOSITE_ADDITIVE  && jac->type != PC_COMPOSITE_SCHUR) {
62068dd23aaSBarry Smith     /* extract the rows of the matrix associated with each field: used for efficient computation of residual inside algorithm */
6214e39094bSDmitry Karpeev     /* FIXME: Can/should we reuse jac->mat whenever (jac->diag_use_amat) is true? */
62268dd23aaSBarry Smith     ilink = jac->head;
623e52d2c62SBarry Smith     if (nsplit == 2 && jac->type == PC_COMPOSITE_MULTIPLICATIVE) {
624e52d2c62SBarry 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 */
625e52d2c62SBarry Smith       if (!jac->Afield) {
626e52d2c62SBarry Smith         ierr = PetscCalloc1(nsplit,&jac->Afield);CHKERRQ(ierr);
627e52d2c62SBarry Smith         ierr  = MatGetSubMatrix(pc->mat,ilink->next->is,ilink->is,MAT_INITIAL_MATRIX,&jac->Afield[1]);CHKERRQ(ierr);
628e52d2c62SBarry Smith       } else {
629e52d2c62SBarry Smith         ierr  = MatGetSubMatrix(pc->mat,ilink->next->is,ilink->is,MAT_REUSE_MATRIX,&jac->Afield[1]);CHKERRQ(ierr);
630e52d2c62SBarry Smith       }
631e52d2c62SBarry Smith     } else {
63268dd23aaSBarry Smith       if (!jac->Afield) {
633785e854fSJed Brown         ierr = PetscMalloc1(nsplit,&jac->Afield);CHKERRQ(ierr);
63468dd23aaSBarry Smith         for (i=0; i<nsplit; i++) {
6350298fd71SBarry Smith           ierr  = MatGetSubMatrix(pc->mat,ilink->is,NULL,MAT_INITIAL_MATRIX,&jac->Afield[i]);CHKERRQ(ierr);
63668dd23aaSBarry Smith           ilink = ilink->next;
63768dd23aaSBarry Smith         }
63868dd23aaSBarry Smith       } else {
63968dd23aaSBarry Smith         for (i=0; i<nsplit; i++) {
6400298fd71SBarry Smith           ierr  = MatGetSubMatrix(pc->mat,ilink->is,NULL,MAT_REUSE_MATRIX,&jac->Afield[i]);CHKERRQ(ierr);
64168dd23aaSBarry Smith           ilink = ilink->next;
64268dd23aaSBarry Smith         }
64368dd23aaSBarry Smith       }
64468dd23aaSBarry Smith     }
645e52d2c62SBarry Smith   }
64668dd23aaSBarry Smith 
6473b224e63SBarry Smith   if (jac->type == PC_COMPOSITE_SCHUR) {
6483b224e63SBarry Smith     IS          ccis;
6494aa3045dSJed Brown     PetscInt    rstart,rend;
650093c86ffSJed Brown     char        lscname[256];
651093c86ffSJed Brown     PetscObject LSC_L;
652ce94432eSBarry Smith 
653ce94432eSBarry Smith     if (nsplit != 2) SETERRQ(PetscObjectComm((PetscObject)pc),PETSC_ERR_ARG_INCOMP,"To use Schur complement preconditioner you must have exactly 2 fields");
65468dd23aaSBarry Smith 
655e6cab6aaSJed Brown     /* When extracting off-diagonal submatrices, we take complements from this range */
656e6cab6aaSJed Brown     ierr = MatGetOwnershipRangeColumn(pc->mat,&rstart,&rend);CHKERRQ(ierr);
657e6cab6aaSJed Brown 
6583b224e63SBarry Smith     /* need to handle case when one is resetting up the preconditioner */
6593b224e63SBarry Smith     if (jac->schur) {
6600298fd71SBarry Smith       KSP kspA = jac->head->ksp, kspInner = NULL, kspUpper = jac->kspupper;
661443836d0SMatthew G Knepley 
662fb3147dbSMatthew G Knepley       ierr  = MatSchurComplementGetKSP(jac->schur, &kspInner);CHKERRQ(ierr);
6633b224e63SBarry Smith       ilink = jac->head;
66449bb4cd7SJungho Lee       ierr  = ISComplement(ilink->is_col,rstart,rend,&ccis);CHKERRQ(ierr);
6654e39094bSDmitry Karpeev       if (jac->offdiag_use_amat) {
6664aa3045dSJed Brown 	ierr  = MatGetSubMatrix(pc->mat,ilink->is,ccis,MAT_REUSE_MATRIX,&jac->B);CHKERRQ(ierr);
667c84da90fSDmitry Karpeev       } else {
668df06c9e3SDmitry Karpeev 	ierr  = MatGetSubMatrix(pc->pmat,ilink->is,ccis,MAT_REUSE_MATRIX,&jac->B);CHKERRQ(ierr);
669c84da90fSDmitry Karpeev       }
670fcfd50ebSBarry Smith       ierr  = ISDestroy(&ccis);CHKERRQ(ierr);
6713b224e63SBarry Smith       ilink = ilink->next;
67249bb4cd7SJungho Lee       ierr  = ISComplement(ilink->is_col,rstart,rend,&ccis);CHKERRQ(ierr);
6734e39094bSDmitry Karpeev       if (jac->offdiag_use_amat) {
6744aa3045dSJed Brown 	ierr  = MatGetSubMatrix(pc->mat,ilink->is,ccis,MAT_REUSE_MATRIX,&jac->C);CHKERRQ(ierr);
675c84da90fSDmitry Karpeev       } else {
676df06c9e3SDmitry Karpeev 	ierr  = MatGetSubMatrix(pc->pmat,ilink->is,ccis,MAT_REUSE_MATRIX,&jac->C);CHKERRQ(ierr);
677c84da90fSDmitry Karpeev       }
678fcfd50ebSBarry Smith       ierr  = ISDestroy(&ccis);CHKERRQ(ierr);
679aa6c7ce3SBarry Smith       ierr  = MatSchurComplementUpdateSubMatrices(jac->schur,jac->mat[0],jac->pmat[0],jac->B,jac->C,jac->mat[1]);CHKERRQ(ierr);
680a7476a74SDmitry Karpeev       if (jac->schurpre == PC_FIELDSPLIT_SCHUR_PRE_SELFP) {
681a7476a74SDmitry Karpeev 	ierr = MatDestroy(&jac->schurp);CHKERRQ(ierr);
682a7476a74SDmitry Karpeev 	ierr = MatSchurComplementGetPmat(jac->schur,MAT_INITIAL_MATRIX,&jac->schurp);CHKERRQ(ierr);
683a7476a74SDmitry Karpeev       }
684443836d0SMatthew G Knepley       if (kspA != kspInner) {
68523ee1639SBarry Smith         ierr = KSPSetOperators(kspA,jac->mat[0],jac->pmat[0]);CHKERRQ(ierr);
686443836d0SMatthew G Knepley       }
687443836d0SMatthew G Knepley       if (kspUpper != kspA) {
68823ee1639SBarry Smith         ierr = KSPSetOperators(kspUpper,jac->mat[0],jac->pmat[0]);CHKERRQ(ierr);
689443836d0SMatthew G Knepley       }
69023ee1639SBarry Smith       ierr = KSPSetOperators(jac->kspschur,jac->schur,FieldSplitSchurPre(jac));CHKERRQ(ierr);
6913b224e63SBarry Smith     } else {
692bafc1b83SMatthew G Knepley       const char   *Dprefix;
693470b340bSDmitry Karpeev       char         schurprefix[256], schurmatprefix[256];
694514bf10dSMatthew G Knepley       char         schurtestoption[256];
695bdddcaaaSMatthew G Knepley       MatNullSpace sp;
696514bf10dSMatthew G Knepley       PetscBool    flg;
6973b224e63SBarry Smith 
698a04f6461SBarry Smith       /* extract the A01 and A10 matrices */
6993b224e63SBarry Smith       ilink = jac->head;
70049bb4cd7SJungho Lee       ierr  = ISComplement(ilink->is_col,rstart,rend,&ccis);CHKERRQ(ierr);
7014e39094bSDmitry Karpeev       if (jac->offdiag_use_amat) {
7024aa3045dSJed Brown 	ierr  = MatGetSubMatrix(pc->mat,ilink->is,ccis,MAT_INITIAL_MATRIX,&jac->B);CHKERRQ(ierr);
703c84da90fSDmitry Karpeev       } else {
704df06c9e3SDmitry Karpeev 	ierr  = MatGetSubMatrix(pc->pmat,ilink->is,ccis,MAT_INITIAL_MATRIX,&jac->B);CHKERRQ(ierr);
705c84da90fSDmitry Karpeev       }
706fcfd50ebSBarry Smith       ierr  = ISDestroy(&ccis);CHKERRQ(ierr);
7073b224e63SBarry Smith       ilink = ilink->next;
70849bb4cd7SJungho Lee       ierr  = ISComplement(ilink->is_col,rstart,rend,&ccis);CHKERRQ(ierr);
7094e39094bSDmitry Karpeev       if (jac->offdiag_use_amat) {
7104aa3045dSJed Brown 	ierr  = MatGetSubMatrix(pc->mat,ilink->is,ccis,MAT_INITIAL_MATRIX,&jac->C);CHKERRQ(ierr);
711c84da90fSDmitry Karpeev       } else {
712df06c9e3SDmitry Karpeev 	ierr  = MatGetSubMatrix(pc->pmat,ilink->is,ccis,MAT_INITIAL_MATRIX,&jac->C);CHKERRQ(ierr);
713c84da90fSDmitry Karpeev       }
714fcfd50ebSBarry Smith       ierr  = ISDestroy(&ccis);CHKERRQ(ierr);
71520252d06SBarry Smith 
716f5236f50SJed Brown       /* Use mat[0] (diagonal block of Amat) preconditioned by pmat[0] to define Schur complement */
71720252d06SBarry Smith       ierr = MatCreate(((PetscObject)jac->mat[0])->comm,&jac->schur);CHKERRQ(ierr);
71820252d06SBarry Smith       ierr = MatSetType(jac->schur,MATSCHURCOMPLEMENT);CHKERRQ(ierr);
719bee83525SDmitry Karpeev       ierr = MatSchurComplementSetSubMatrices(jac->schur,jac->mat[0],jac->pmat[0],jac->B,jac->C,jac->mat[1]);CHKERRQ(ierr);
720470b340bSDmitry Karpeev       ierr = PetscSNPrintf(schurmatprefix, sizeof(schurmatprefix), "%sfieldsplit_%s_", ((PetscObject)pc)->prefix ? ((PetscObject)pc)->prefix : "", ilink->splitname);CHKERRQ(ierr);
721470b340bSDmitry 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? */
722470b340bSDmitry Karpeev       ierr = MatSetOptionsPrefix(jac->schur,schurmatprefix);CHKERRQ(ierr);
723470b340bSDmitry Karpeev       ierr = MatSetFromOptions(jac->schur);CHKERRQ(ierr);
724895c21f2SBarry Smith       ierr = MatGetNullSpace(jac->mat[1], &sp);CHKERRQ(ierr);
72520252d06SBarry Smith       if (sp) {
72620252d06SBarry Smith         ierr = MatSetNullSpace(jac->schur, sp);CHKERRQ(ierr);
72720252d06SBarry Smith       }
72820252d06SBarry Smith 
72920252d06SBarry Smith       ierr = PetscSNPrintf(schurtestoption, sizeof(schurtestoption), "-fieldsplit_%s_inner_", ilink->splitname);CHKERRQ(ierr);
730c5929fdfSBarry Smith       ierr = PetscOptionsFindPairPrefix_Private(((PetscObject)pc)->options,((PetscObject)pc)->prefix, schurtestoption, NULL, &flg);CHKERRQ(ierr);
731514bf10dSMatthew G Knepley       if (flg) {
732514bf10dSMatthew G Knepley         DM  dmInner;
73321635b76SJed Brown         KSP kspInner;
73421635b76SJed Brown 
73521635b76SJed Brown         ierr = MatSchurComplementGetKSP(jac->schur, &kspInner);CHKERRQ(ierr);
73621635b76SJed Brown         ierr = PetscSNPrintf(schurprefix, sizeof(schurprefix), "%sfieldsplit_%s_inner_", ((PetscObject)pc)->prefix ? ((PetscObject)pc)->prefix : "", ilink->splitname);CHKERRQ(ierr);
73721635b76SJed Brown         /* Indent this deeper to emphasize the "inner" nature of this solver. */
73821635b76SJed Brown         ierr = PetscObjectIncrementTabLevel((PetscObject)kspInner, (PetscObject) pc, 2);CHKERRQ(ierr);
73921635b76SJed Brown         ierr = KSPSetOptionsPrefix(kspInner, schurprefix);CHKERRQ(ierr);
740514bf10dSMatthew G Knepley 
741514bf10dSMatthew G Knepley         /* Set DM for new solver */
742bafc1b83SMatthew G Knepley         ierr = KSPGetDM(jac->head->ksp, &dmInner);CHKERRQ(ierr);
74321635b76SJed Brown         ierr = KSPSetDM(kspInner, dmInner);CHKERRQ(ierr);
74421635b76SJed Brown         ierr = KSPSetDMActive(kspInner, PETSC_FALSE);CHKERRQ(ierr);
745514bf10dSMatthew G Knepley       } else {
74621635b76SJed Brown          /* Use the outer solver for the inner solve, but revert the KSPPREONLY from PCFieldSplitSetFields_FieldSplit or
74721635b76SJed Brown           * PCFieldSplitSetIS_FieldSplit. We don't want KSPPREONLY because it makes the Schur complement inexact,
74821635b76SJed Brown           * preventing Schur complement reduction to be an accurate solve. Usually when an iterative solver is used for
74921635b76SJed 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
75021635b76SJed Brown           * GMRES the default. Note that it is also common to use PREONLY for S, in which case S may not be used
75121635b76SJed Brown           * directly, and the user is responsible for setting an inexact method for fieldsplit's A^{-1}. */
75221635b76SJed Brown         ierr = KSPSetType(jac->head->ksp,KSPGMRES);CHKERRQ(ierr);
753514bf10dSMatthew G Knepley         ierr = MatSchurComplementSetKSP(jac->schur,jac->head->ksp);CHKERRQ(ierr);
754bafc1b83SMatthew G Knepley       }
75523ee1639SBarry Smith       ierr = KSPSetOperators(jac->head->ksp,jac->mat[0],jac->pmat[0]);CHKERRQ(ierr);
7565a9f2f41SSatish Balay       ierr = KSPSetFromOptions(jac->head->ksp);CHKERRQ(ierr);
75797bbdb24SBarry Smith       ierr = MatSetFromOptions(jac->schur);CHKERRQ(ierr);
75897bbdb24SBarry Smith 
759443836d0SMatthew G Knepley       ierr = PetscSNPrintf(schurtestoption, sizeof(schurtestoption), "-fieldsplit_%s_upper_", ilink->splitname);CHKERRQ(ierr);
760c5929fdfSBarry Smith       ierr = PetscOptionsFindPairPrefix_Private(((PetscObject)pc)->options,((PetscObject)pc)->prefix, schurtestoption, NULL, &flg);CHKERRQ(ierr);
761443836d0SMatthew G Knepley       if (flg) {
762443836d0SMatthew G Knepley         DM dmInner;
763443836d0SMatthew G Knepley 
764443836d0SMatthew G Knepley         ierr = PetscSNPrintf(schurprefix, sizeof(schurprefix), "%sfieldsplit_%s_upper_", ((PetscObject)pc)->prefix ? ((PetscObject)pc)->prefix : "", ilink->splitname);CHKERRQ(ierr);
76582f516ccSBarry Smith         ierr = KSPCreate(PetscObjectComm((PetscObject)pc), &jac->kspupper);CHKERRQ(ierr);
766422a814eSBarry Smith         ierr = KSPSetErrorIfNotConverged(jac->kspupper,pc->erroriffailure);CHKERRQ(ierr);
767443836d0SMatthew G Knepley         ierr = KSPSetOptionsPrefix(jac->kspupper, schurprefix);CHKERRQ(ierr);
768443836d0SMatthew G Knepley         ierr = KSPGetDM(jac->head->ksp, &dmInner);CHKERRQ(ierr);
769443836d0SMatthew G Knepley         ierr = KSPSetDM(jac->kspupper, dmInner);CHKERRQ(ierr);
770443836d0SMatthew G Knepley         ierr = KSPSetDMActive(jac->kspupper, PETSC_FALSE);CHKERRQ(ierr);
771443836d0SMatthew G Knepley         ierr = KSPSetFromOptions(jac->kspupper);CHKERRQ(ierr);
77223ee1639SBarry Smith         ierr = KSPSetOperators(jac->kspupper,jac->mat[0],jac->pmat[0]);CHKERRQ(ierr);
773443836d0SMatthew G Knepley         ierr = VecDuplicate(jac->head->x, &jac->head->z);CHKERRQ(ierr);
774443836d0SMatthew G Knepley       } else {
775443836d0SMatthew G Knepley         jac->kspupper = jac->head->ksp;
776443836d0SMatthew G Knepley         ierr          = PetscObjectReference((PetscObject) jac->head->ksp);CHKERRQ(ierr);
777443836d0SMatthew G Knepley       }
778443836d0SMatthew G Knepley 
779a7476a74SDmitry Karpeev       if (jac->schurpre == PC_FIELDSPLIT_SCHUR_PRE_SELFP) {
780a7476a74SDmitry Karpeev 	ierr = MatSchurComplementGetPmat(jac->schur,MAT_INITIAL_MATRIX,&jac->schurp);CHKERRQ(ierr);
781a7476a74SDmitry Karpeev       }
782ce94432eSBarry Smith       ierr = KSPCreate(PetscObjectComm((PetscObject)pc),&jac->kspschur);CHKERRQ(ierr);
783422a814eSBarry Smith       ierr = KSPSetErrorIfNotConverged(jac->kspschur,pc->erroriffailure);CHKERRQ(ierr);
78497bbdb24SBarry Smith       ierr = PetscLogObjectParent((PetscObject)pc,(PetscObject)jac->kspschur);CHKERRQ(ierr);
78520252d06SBarry Smith       ierr = PetscObjectIncrementTabLevel((PetscObject)jac->kspschur,(PetscObject)pc,1);CHKERRQ(ierr);
78697bbdb24SBarry Smith       if (jac->schurpre == PC_FIELDSPLIT_SCHUR_PRE_SELF) {
7877233a360SDmitry Karpeev         PC pcschur;
7887233a360SDmitry Karpeev         ierr = KSPGetPC(jac->kspschur,&pcschur);CHKERRQ(ierr);
7897233a360SDmitry Karpeev         ierr = PCSetType(pcschur,PCNONE);CHKERRQ(ierr);
79097bbdb24SBarry Smith         /* Note: This is bad if there exist preconditioners for MATSCHURCOMPLEMENT */
791e74569cdSMatthew G. Knepley       } else if (jac->schurpre == PC_FIELDSPLIT_SCHUR_PRE_FULL) {
792e74569cdSMatthew G. Knepley         ierr = MatSchurComplementComputeExplicitOperator(jac->schur, &jac->schur_user);CHKERRQ(ierr);
79397bbdb24SBarry Smith       }
79423ee1639SBarry Smith       ierr = KSPSetOperators(jac->kspschur,jac->schur,FieldSplitSchurPre(jac));CHKERRQ(ierr);
79597bbdb24SBarry Smith       ierr = KSPGetOptionsPrefix(jac->head->next->ksp, &Dprefix);CHKERRQ(ierr);
79697bbdb24SBarry Smith       ierr = KSPSetOptionsPrefix(jac->kspschur,         Dprefix);CHKERRQ(ierr);
797b20b4189SMatthew G. Knepley       /* propogate DM */
798b20b4189SMatthew G. Knepley       {
799b20b4189SMatthew G. Knepley         DM sdm;
800b20b4189SMatthew G. Knepley         ierr = KSPGetDM(jac->head->next->ksp, &sdm);CHKERRQ(ierr);
801b20b4189SMatthew G. Knepley         if (sdm) {
802b20b4189SMatthew G. Knepley           ierr = KSPSetDM(jac->kspschur, sdm);CHKERRQ(ierr);
803b20b4189SMatthew G. Knepley           ierr = KSPSetDMActive(jac->kspschur, PETSC_FALSE);CHKERRQ(ierr);
804b20b4189SMatthew G. Knepley         }
805b20b4189SMatthew G. Knepley       }
80697bbdb24SBarry Smith       /* really want setfromoptions called in PCSetFromOptions_FieldSplit(), but it is not ready yet */
80797bbdb24SBarry Smith       /* need to call this every time, since the jac->kspschur is freshly created, otherwise its options never get set */
80897bbdb24SBarry Smith       ierr = KSPSetFromOptions(jac->kspschur);CHKERRQ(ierr);
80997bbdb24SBarry Smith     }
81097bbdb24SBarry Smith 
8115a9f2f41SSatish Balay     /* HACK: special support to forward L and Lp matrices that might be used by PCLSC */
8128caf3d72SBarry Smith     ierr = PetscSNPrintf(lscname,sizeof(lscname),"%s_LSC_L",ilink->splitname);CHKERRQ(ierr);
813519d70e2SJed Brown     ierr = PetscObjectQuery((PetscObject)pc->mat,lscname,(PetscObject*)&LSC_L);CHKERRQ(ierr);
8143b224e63SBarry Smith     if (!LSC_L) {ierr = PetscObjectQuery((PetscObject)pc->pmat,lscname,(PetscObject*)&LSC_L);CHKERRQ(ierr);}
815c1570756SJed Brown     if (LSC_L) {ierr = PetscObjectCompose((PetscObject)jac->schur,"LSC_L",(PetscObject)LSC_L);CHKERRQ(ierr);}
8168caf3d72SBarry Smith     ierr = PetscSNPrintf(lscname,sizeof(lscname),"%s_LSC_Lp",ilink->splitname);CHKERRQ(ierr);
81797bbdb24SBarry Smith     ierr = PetscObjectQuery((PetscObject)pc->pmat,lscname,(PetscObject*)&LSC_L);CHKERRQ(ierr);
8185a9f2f41SSatish Balay     if (!LSC_L) {ierr = PetscObjectQuery((PetscObject)pc->mat,lscname,(PetscObject*)&LSC_L);CHKERRQ(ierr);}
8190971522cSBarry Smith     if (LSC_L) {ierr = PetscObjectCompose((PetscObject)jac->schur,"LSC_Lp",(PetscObject)LSC_L);CHKERRQ(ierr);}
82097bbdb24SBarry Smith   } else {
82168bd789dSDmitry Karpeev     /* set up the individual splits' PCs */
8220971522cSBarry Smith     i     = 0;
8230971522cSBarry Smith     ilink = jac->head;
8240971522cSBarry Smith     while (ilink) {
82523ee1639SBarry Smith       ierr = KSPSetOperators(ilink->ksp,jac->mat[i],jac->pmat[i]);CHKERRQ(ierr);
8260971522cSBarry Smith       /* really want setfromoptions called in PCSetFromOptions_FieldSplit(), but it is not ready yet */
8270971522cSBarry Smith       if (!jac->suboptionsset) {ierr = KSPSetFromOptions(ilink->ksp);CHKERRQ(ierr);}
8280971522cSBarry Smith       i++;
8290971522cSBarry Smith       ilink = ilink->next;
8300971522cSBarry Smith     }
8313b224e63SBarry Smith   }
8323b224e63SBarry Smith 
833c1570756SJed Brown   jac->suboptionsset = PETSC_TRUE;
8340971522cSBarry Smith   PetscFunctionReturn(0);
8350971522cSBarry Smith }
8360971522cSBarry Smith 
8375a9f2f41SSatish Balay #define FieldSplitSplitSolveAdd(ilink,xx,yy) \
838ca9f406cSSatish Balay   (VecScatterBegin(ilink->sctx,xx,ilink->x,INSERT_VALUES,SCATTER_FORWARD) || \
839ca9f406cSSatish Balay    VecScatterEnd(ilink->sctx,xx,ilink->x,INSERT_VALUES,SCATTER_FORWARD) || \
8409df09d43SBarry Smith    PetscLogEventBegin(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL) ||\
8415a9f2f41SSatish Balay    KSPSolve(ilink->ksp,ilink->x,ilink->y) ||                               \
8429df09d43SBarry Smith    PetscLogEventEnd(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL) ||\
843ca9f406cSSatish Balay    VecScatterBegin(ilink->sctx,ilink->y,yy,ADD_VALUES,SCATTER_REVERSE) ||  \
844ca9f406cSSatish Balay    VecScatterEnd(ilink->sctx,ilink->y,yy,ADD_VALUES,SCATTER_REVERSE))
84579416396SBarry Smith 
8460971522cSBarry Smith #undef __FUNCT__
8473b224e63SBarry Smith #define __FUNCT__ "PCApply_FieldSplit_Schur"
8483b224e63SBarry Smith static PetscErrorCode PCApply_FieldSplit_Schur(PC pc,Vec x,Vec y)
8493b224e63SBarry Smith {
8503b224e63SBarry Smith   PC_FieldSplit     *jac = (PC_FieldSplit*)pc->data;
8513b224e63SBarry Smith   PetscErrorCode    ierr;
8523b224e63SBarry Smith   PC_FieldSplitLink ilinkA = jac->head, ilinkD = ilinkA->next;
853443836d0SMatthew G Knepley   KSP               kspA   = ilinkA->ksp, kspLower = kspA, kspUpper = jac->kspupper;
8543b224e63SBarry Smith 
8553b224e63SBarry Smith   PetscFunctionBegin;
856c5d2311dSJed Brown   switch (jac->schurfactorization) {
857c9c6ffaaSJed Brown   case PC_FIELDSPLIT_SCHUR_FACT_DIAG:
858a04f6461SBarry Smith     /* [A00 0; 0 -S], positive definite, suitable for MINRES */
859c5d2311dSJed Brown     ierr = VecScatterBegin(ilinkA->sctx,x,ilinkA->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
860c5d2311dSJed Brown     ierr = VecScatterBegin(ilinkD->sctx,x,ilinkD->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
861c5d2311dSJed Brown     ierr = VecScatterEnd(ilinkA->sctx,x,ilinkA->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
8629df09d43SBarry Smith     ierr = PetscLogEventBegin(ilinkA->event,kspA,ilinkA->x,ilinkA->y,NULL);CHKERRQ(ierr);
863443836d0SMatthew G Knepley     ierr = KSPSolve(kspA,ilinkA->x,ilinkA->y);CHKERRQ(ierr);
8649df09d43SBarry Smith     ierr = PetscLogEventEnd(ilinkA->event,kspA,ilinkA->x,ilinkA->y,NULL);CHKERRQ(ierr);
865c5d2311dSJed Brown     ierr = VecScatterBegin(ilinkA->sctx,ilinkA->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
866c5d2311dSJed Brown     ierr = VecScatterEnd(ilinkD->sctx,x,ilinkD->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
8679df09d43SBarry Smith     ierr = PetscLogEventBegin(KSP_Solve_FS_S,jac->kspschur,ilinkD->x,ilinkD->y,NULL);CHKERRQ(ierr);
868c5d2311dSJed Brown     ierr = KSPSolve(jac->kspschur,ilinkD->x,ilinkD->y);CHKERRQ(ierr);
8699df09d43SBarry Smith     ierr = PetscLogEventEnd(KSP_Solve_FS_S,jac->kspschur,ilinkD->x,ilinkD->y,NULL);CHKERRQ(ierr);
870c5d2311dSJed Brown     ierr = VecScale(ilinkD->y,-1.);CHKERRQ(ierr);
871c5d2311dSJed Brown     ierr = VecScatterBegin(ilinkD->sctx,ilinkD->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
872c5d2311dSJed Brown     ierr = VecScatterEnd(ilinkA->sctx,ilinkA->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
873c5d2311dSJed Brown     ierr = VecScatterEnd(ilinkD->sctx,ilinkD->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
874c5d2311dSJed Brown     break;
875c9c6ffaaSJed Brown   case PC_FIELDSPLIT_SCHUR_FACT_LOWER:
876a04f6461SBarry Smith     /* [A00 0; A10 S], suitable for left preconditioning */
877c5d2311dSJed Brown     ierr = VecScatterBegin(ilinkA->sctx,x,ilinkA->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
878c5d2311dSJed Brown     ierr = VecScatterEnd(ilinkA->sctx,x,ilinkA->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
8799df09d43SBarry Smith     ierr = PetscLogEventBegin(ilinkA->event,kspA,ilinkA->x,ilinkA->y,NULL);CHKERRQ(ierr);
880443836d0SMatthew G Knepley     ierr = KSPSolve(kspA,ilinkA->x,ilinkA->y);CHKERRQ(ierr);
8819df09d43SBarry Smith     ierr = PetscLogEventEnd(ilinkA->event,kspA,ilinkA->x,ilinkA->y,NULL);CHKERRQ(ierr);
882c5d2311dSJed Brown     ierr = MatMult(jac->C,ilinkA->y,ilinkD->x);CHKERRQ(ierr);
883c5d2311dSJed Brown     ierr = VecScale(ilinkD->x,-1.);CHKERRQ(ierr);
884c5d2311dSJed Brown     ierr = VecScatterBegin(ilinkD->sctx,x,ilinkD->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
885c5d2311dSJed Brown     ierr = VecScatterBegin(ilinkA->sctx,ilinkA->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
886c5d2311dSJed Brown     ierr = VecScatterEnd(ilinkD->sctx,x,ilinkD->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
8879df09d43SBarry Smith     ierr = PetscLogEventBegin(KSP_Solve_FS_S,jac->kspschur,ilinkD->x,ilinkD->y,NULL);CHKERRQ(ierr);
888c5d2311dSJed Brown     ierr = KSPSolve(jac->kspschur,ilinkD->x,ilinkD->y);CHKERRQ(ierr);
8899df09d43SBarry Smith     ierr = PetscLogEventEnd(KSP_Solve_FS_S,jac->kspschur,ilinkD->x,ilinkD->y,NULL);CHKERRQ(ierr);
890c5d2311dSJed Brown     ierr = VecScatterBegin(ilinkD->sctx,ilinkD->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
891c5d2311dSJed Brown     ierr = VecScatterEnd(ilinkA->sctx,ilinkA->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
892c5d2311dSJed Brown     ierr = VecScatterEnd(ilinkD->sctx,ilinkD->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
893c5d2311dSJed Brown     break;
894c9c6ffaaSJed Brown   case PC_FIELDSPLIT_SCHUR_FACT_UPPER:
895a04f6461SBarry Smith     /* [A00 A01; 0 S], suitable for right preconditioning */
896c5d2311dSJed Brown     ierr = VecScatterBegin(ilinkD->sctx,x,ilinkD->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
897c5d2311dSJed Brown     ierr = VecScatterEnd(ilinkD->sctx,x,ilinkD->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
8989df09d43SBarry Smith     ierr = PetscLogEventBegin(KSP_Solve_FS_S,jac->kspschur,ilinkD->x,ilinkD->y,NULL);CHKERRQ(ierr);
899c5d2311dSJed Brown     ierr = KSPSolve(jac->kspschur,ilinkD->x,ilinkD->y);CHKERRQ(ierr);
9009df09d43SBarry 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);
901c5d2311dSJed Brown     ierr = VecScale(ilinkA->x,-1.);CHKERRQ(ierr);
902c5d2311dSJed Brown     ierr = VecScatterBegin(ilinkA->sctx,x,ilinkA->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
903c5d2311dSJed Brown     ierr = VecScatterBegin(ilinkD->sctx,ilinkD->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
904c5d2311dSJed Brown     ierr = VecScatterEnd(ilinkA->sctx,x,ilinkA->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
9059df09d43SBarry Smith     ierr = PetscLogEventBegin(ilinkA->event,kspA,ilinkA->x,ilinkA->y,NULL);CHKERRQ(ierr);
906443836d0SMatthew G Knepley     ierr = KSPSolve(kspA,ilinkA->x,ilinkA->y);CHKERRQ(ierr);
9079df09d43SBarry 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);
9169df09d43SBarry 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);
9189df09d43SBarry 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 
9249df09d43SBarry 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);
9269df09d43SBarry 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);
9339df09d43SBarry 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);
9359df09d43SBarry Smith       ierr = PetscLogEventEnd(ilinkA->event,kspA,ilinkA->x,ilinkA->y,NULL);CHKERRQ(ierr);
936443836d0SMatthew G Knepley     } else {
9379df09d43SBarry 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);
9399df09d43SBarry 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);
9419df09d43SBarry 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);
9439df09d43SBarry 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;
960568ed31eSHong Zhang   KSPConvergedReason reason;
9610971522cSBarry Smith 
9620971522cSBarry Smith   PetscFunctionBegin;
96379416396SBarry Smith   if (jac->type == PC_COMPOSITE_ADDITIVE) {
9641b9fc7fcSBarry Smith     if (jac->defaultsplit) {
965939b8a20SBarry Smith       ierr = VecGetBlockSize(x,&bs);CHKERRQ(ierr);
966ce94432eSBarry 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);
967939b8a20SBarry Smith       ierr = VecGetBlockSize(y,&bs);CHKERRQ(ierr);
968ce94432eSBarry 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);
9690971522cSBarry Smith       ierr = VecStrideGatherAll(x,jac->x,INSERT_VALUES);CHKERRQ(ierr);
9705a9f2f41SSatish Balay       while (ilink) {
9719df09d43SBarry Smith         ierr  = PetscLogEventBegin(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL);CHKERRQ(ierr);
9725a9f2f41SSatish Balay         ierr  = KSPSolve(ilink->ksp,ilink->x,ilink->y);CHKERRQ(ierr);
9739df09d43SBarry Smith         ierr  = PetscLogEventEnd(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL);CHKERRQ(ierr);
974568ed31eSHong Zhang         ierr = KSPGetConvergedReason(ilink->ksp,&reason);CHKERRQ(ierr);
975568ed31eSHong Zhang         if (reason == KSP_DIVERGED_PCSETUP_FAILED) {
976568ed31eSHong Zhang           pc->failedreason = PC_SUBPC_ERROR;
977568ed31eSHong Zhang         }
9785a9f2f41SSatish Balay         ilink = ilink->next;
9790971522cSBarry Smith       }
9800971522cSBarry Smith       ierr = VecStrideScatterAll(jac->y,y,INSERT_VALUES);CHKERRQ(ierr);
9811b9fc7fcSBarry Smith     } else {
982efb30889SBarry Smith       ierr = VecSet(y,0.0);CHKERRQ(ierr);
9835a9f2f41SSatish Balay       while (ilink) {
9845a9f2f41SSatish Balay         ierr  = FieldSplitSplitSolveAdd(ilink,x,y);CHKERRQ(ierr);
985568ed31eSHong Zhang         ierr = KSPGetConvergedReason(ilink->ksp,&reason);CHKERRQ(ierr);
986568ed31eSHong Zhang         if (reason == KSP_DIVERGED_PCSETUP_FAILED) {
987568ed31eSHong Zhang           pc->failedreason = PC_SUBPC_ERROR;
988568ed31eSHong Zhang         }
9895a9f2f41SSatish Balay         ilink = ilink->next;
9901b9fc7fcSBarry Smith       }
9911b9fc7fcSBarry Smith     }
992e52d2c62SBarry Smith   } else if (jac->type == PC_COMPOSITE_MULTIPLICATIVE && jac->nsplits == 2) {
993e52d2c62SBarry Smith     ierr = VecSet(y,0.0);CHKERRQ(ierr);
994e52d2c62SBarry Smith     /* solve on first block for first block variables */
995e52d2c62SBarry Smith     ierr = VecScatterBegin(ilink->sctx,x,ilink->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
996e52d2c62SBarry Smith     ierr = VecScatterEnd(ilink->sctx,x,ilink->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
9979df09d43SBarry Smith     ierr = PetscLogEventBegin(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL);CHKERRQ(ierr);
998e52d2c62SBarry Smith     ierr = KSPSolve(ilink->ksp,ilink->x,ilink->y);CHKERRQ(ierr);
9999df09d43SBarry Smith     ierr = PetscLogEventEnd(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL);CHKERRQ(ierr);
1000568ed31eSHong Zhang     ierr = KSPGetConvergedReason(ilink->ksp,&reason);CHKERRQ(ierr);
1001568ed31eSHong Zhang     if (reason == KSP_DIVERGED_PCSETUP_FAILED) {
1002568ed31eSHong Zhang       pc->failedreason = PC_SUBPC_ERROR;
1003568ed31eSHong Zhang     }
1004e52d2c62SBarry Smith     ierr = VecScatterBegin(ilink->sctx,ilink->y,y,ADD_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
1005e52d2c62SBarry Smith     ierr = VecScatterEnd(ilink->sctx,ilink->y,y,ADD_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
1006e52d2c62SBarry Smith 
1007e52d2c62SBarry Smith     /* compute the residual only onto second block variables using first block variables */
1008e52d2c62SBarry Smith     ierr = MatMult(jac->Afield[1],ilink->y,ilink->next->x);CHKERRQ(ierr);
1009e52d2c62SBarry Smith     ilink = ilink->next;
1010e52d2c62SBarry Smith     ierr = VecScale(ilink->x,-1.0);CHKERRQ(ierr);
1011e52d2c62SBarry Smith     ierr = VecScatterBegin(ilink->sctx,x,ilink->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
1012e52d2c62SBarry Smith     ierr = VecScatterEnd(ilink->sctx,x,ilink->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
1013e52d2c62SBarry Smith 
1014e52d2c62SBarry Smith     /* solve on second block variables */
10159df09d43SBarry Smith     ierr = PetscLogEventBegin(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL);CHKERRQ(ierr);
1016e52d2c62SBarry Smith     ierr = KSPSolve(ilink->ksp,ilink->x,ilink->y);CHKERRQ(ierr);
10179df09d43SBarry Smith     ierr = PetscLogEventEnd(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL);CHKERRQ(ierr);
1018568ed31eSHong Zhang     ierr = KSPGetConvergedReason(ilink->ksp,&reason);CHKERRQ(ierr);
1019568ed31eSHong Zhang     if (reason == KSP_DIVERGED_PCSETUP_FAILED) {
1020568ed31eSHong Zhang       pc->failedreason = PC_SUBPC_ERROR;
1021568ed31eSHong Zhang     }
1022e52d2c62SBarry Smith     ierr = VecScatterBegin(ilink->sctx,ilink->y,y,ADD_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
1023e52d2c62SBarry Smith     ierr = VecScatterEnd(ilink->sctx,ilink->y,y,ADD_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
102416913363SBarry Smith   } else if (jac->type == PC_COMPOSITE_MULTIPLICATIVE || jac->type == PC_COMPOSITE_SYMMETRIC_MULTIPLICATIVE) {
102579416396SBarry Smith     if (!jac->w1) {
102679416396SBarry Smith       ierr = VecDuplicate(x,&jac->w1);CHKERRQ(ierr);
102779416396SBarry Smith       ierr = VecDuplicate(x,&jac->w2);CHKERRQ(ierr);
102879416396SBarry Smith     }
1029efb30889SBarry Smith     ierr = VecSet(y,0.0);CHKERRQ(ierr);
10305a9f2f41SSatish Balay     ierr = FieldSplitSplitSolveAdd(ilink,x,y);CHKERRQ(ierr);
1031568ed31eSHong Zhang     ierr = KSPGetConvergedReason(ilink->ksp,&reason);CHKERRQ(ierr);
1032568ed31eSHong Zhang     if (reason == KSP_DIVERGED_PCSETUP_FAILED) {
1033568ed31eSHong Zhang       pc->failedreason = PC_SUBPC_ERROR;
1034568ed31eSHong Zhang     }
10353e197d65SBarry Smith     cnt  = 1;
10365a9f2f41SSatish Balay     while (ilink->next) {
10375a9f2f41SSatish Balay       ilink = ilink->next;
10383e197d65SBarry Smith       /* compute the residual only over the part of the vector needed */
10393e197d65SBarry Smith       ierr = MatMult(jac->Afield[cnt++],y,ilink->x);CHKERRQ(ierr);
10403e197d65SBarry Smith       ierr = VecScale(ilink->x,-1.0);CHKERRQ(ierr);
10413e197d65SBarry Smith       ierr = VecScatterBegin(ilink->sctx,x,ilink->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
10423e197d65SBarry Smith       ierr = VecScatterEnd(ilink->sctx,x,ilink->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
10439df09d43SBarry Smith       ierr = PetscLogEventBegin(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL);CHKERRQ(ierr);
10443e197d65SBarry Smith       ierr = KSPSolve(ilink->ksp,ilink->x,ilink->y);CHKERRQ(ierr);
10459df09d43SBarry Smith       ierr = PetscLogEventEnd(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL);CHKERRQ(ierr);
10462618eb8fSHong Zhang       ierr = KSPGetConvergedReason(ilink->ksp,&reason);CHKERRQ(ierr);
10472618eb8fSHong Zhang       if (reason == KSP_DIVERGED_PCSETUP_FAILED) {
10482618eb8fSHong Zhang         pc->failedreason = PC_SUBPC_ERROR;
10492618eb8fSHong Zhang       }
10503e197d65SBarry Smith       ierr = VecScatterBegin(ilink->sctx,ilink->y,y,ADD_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
10513e197d65SBarry Smith       ierr = VecScatterEnd(ilink->sctx,ilink->y,y,ADD_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
10523e197d65SBarry Smith     }
105351f519a2SBarry Smith     if (jac->type == PC_COMPOSITE_SYMMETRIC_MULTIPLICATIVE) {
105411755939SBarry Smith       cnt -= 2;
105551f519a2SBarry Smith       while (ilink->previous) {
105651f519a2SBarry Smith         ilink = ilink->previous;
105711755939SBarry Smith         /* compute the residual only over the part of the vector needed */
105811755939SBarry Smith         ierr = MatMult(jac->Afield[cnt--],y,ilink->x);CHKERRQ(ierr);
105911755939SBarry Smith         ierr = VecScale(ilink->x,-1.0);CHKERRQ(ierr);
106011755939SBarry Smith         ierr = VecScatterBegin(ilink->sctx,x,ilink->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
106111755939SBarry Smith         ierr = VecScatterEnd(ilink->sctx,x,ilink->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
10629df09d43SBarry Smith         ierr = PetscLogEventBegin(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL);CHKERRQ(ierr);
106311755939SBarry Smith         ierr = KSPSolve(ilink->ksp,ilink->x,ilink->y);CHKERRQ(ierr);
10649df09d43SBarry Smith         ierr = PetscLogEventEnd(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL);CHKERRQ(ierr);
1065568ed31eSHong Zhang         ierr = KSPGetConvergedReason(ilink->ksp,&reason);CHKERRQ(ierr);
1066568ed31eSHong Zhang         if (reason == KSP_DIVERGED_PCSETUP_FAILED) {
1067568ed31eSHong Zhang           pc->failedreason = PC_SUBPC_ERROR;
1068568ed31eSHong Zhang         }
106911755939SBarry Smith         ierr = VecScatterBegin(ilink->sctx,ilink->y,y,ADD_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
107011755939SBarry Smith         ierr = VecScatterEnd(ilink->sctx,ilink->y,y,ADD_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
107151f519a2SBarry Smith       }
107211755939SBarry Smith     }
1073ce94432eSBarry Smith   } else SETERRQ1(PetscObjectComm((PetscObject)pc),PETSC_ERR_SUP,"Unsupported or unknown composition",(int) jac->type);
10740971522cSBarry Smith   PetscFunctionReturn(0);
10750971522cSBarry Smith }
10760971522cSBarry Smith 
1077421e10b8SBarry Smith #define FieldSplitSplitSolveAddTranspose(ilink,xx,yy) \
1078ca9f406cSSatish Balay   (VecScatterBegin(ilink->sctx,xx,ilink->y,INSERT_VALUES,SCATTER_FORWARD) || \
1079ca9f406cSSatish Balay    VecScatterEnd(ilink->sctx,xx,ilink->y,INSERT_VALUES,SCATTER_FORWARD) || \
10809df09d43SBarry Smith    PetscLogEventBegin(ilink->event,ilink->ksp,ilink->y,ilink->x,NULL) || \
1081421e10b8SBarry Smith    KSPSolveTranspose(ilink->ksp,ilink->y,ilink->x) ||                  \
10829df09d43SBarry Smith    PetscLogEventBegin(ilink->event,ilink->ksp,ilink->y,ilink->x,NULL) || \
1083ca9f406cSSatish Balay    VecScatterBegin(ilink->sctx,ilink->x,yy,ADD_VALUES,SCATTER_REVERSE) || \
1084ca9f406cSSatish Balay    VecScatterEnd(ilink->sctx,ilink->x,yy,ADD_VALUES,SCATTER_REVERSE))
1085421e10b8SBarry Smith 
1086421e10b8SBarry Smith #undef __FUNCT__
10878c03b21aSDmitry Karpeev #define __FUNCT__ "PCApplyTranspose_FieldSplit"
1088421e10b8SBarry Smith static PetscErrorCode PCApplyTranspose_FieldSplit(PC pc,Vec x,Vec y)
1089421e10b8SBarry Smith {
1090421e10b8SBarry Smith   PC_FieldSplit      *jac = (PC_FieldSplit*)pc->data;
1091421e10b8SBarry Smith   PetscErrorCode     ierr;
1092421e10b8SBarry Smith   PC_FieldSplitLink  ilink = jac->head;
1093939b8a20SBarry Smith   PetscInt           bs;
1094291dd214SHong Zhang   KSPConvergedReason reason;
1095421e10b8SBarry Smith 
1096421e10b8SBarry Smith   PetscFunctionBegin;
1097421e10b8SBarry Smith   if (jac->type == PC_COMPOSITE_ADDITIVE) {
1098421e10b8SBarry Smith     if (jac->defaultsplit) {
1099939b8a20SBarry Smith       ierr = VecGetBlockSize(x,&bs);CHKERRQ(ierr);
1100ce94432eSBarry 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);
1101939b8a20SBarry Smith       ierr = VecGetBlockSize(y,&bs);CHKERRQ(ierr);
1102ce94432eSBarry 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);
1103421e10b8SBarry Smith       ierr = VecStrideGatherAll(x,jac->x,INSERT_VALUES);CHKERRQ(ierr);
1104421e10b8SBarry Smith       while (ilink) {
11059df09d43SBarry Smith         ierr = PetscLogEventBegin(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL);CHKERRQ(ierr);
1106421e10b8SBarry Smith         ierr  = KSPSolveTranspose(ilink->ksp,ilink->x,ilink->y);CHKERRQ(ierr);
11079df09d43SBarry Smith         ierr = PetscLogEventEnd(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL);CHKERRQ(ierr);
11082618eb8fSHong Zhang         ierr = KSPGetConvergedReason(ilink->ksp,&reason);CHKERRQ(ierr);
11092618eb8fSHong Zhang         if (reason == KSP_DIVERGED_PCSETUP_FAILED) {
11102618eb8fSHong Zhang           pc->failedreason = PC_SUBPC_ERROR;
11112618eb8fSHong Zhang         }
1112421e10b8SBarry Smith         ilink = ilink->next;
1113421e10b8SBarry Smith       }
1114421e10b8SBarry Smith       ierr = VecStrideScatterAll(jac->y,y,INSERT_VALUES);CHKERRQ(ierr);
1115421e10b8SBarry Smith     } else {
1116421e10b8SBarry Smith       ierr = VecSet(y,0.0);CHKERRQ(ierr);
1117421e10b8SBarry Smith       while (ilink) {
1118421e10b8SBarry Smith         ierr = FieldSplitSplitSolveAddTranspose(ilink,x,y);CHKERRQ(ierr);
11192618eb8fSHong Zhang         ierr = KSPGetConvergedReason(ilink->ksp,&reason);CHKERRQ(ierr);
11202618eb8fSHong Zhang         if (reason == KSP_DIVERGED_PCSETUP_FAILED) {
11212618eb8fSHong Zhang           pc->failedreason = PC_SUBPC_ERROR;
11222618eb8fSHong Zhang         }
1123421e10b8SBarry Smith         ilink = ilink->next;
1124421e10b8SBarry Smith       }
1125421e10b8SBarry Smith     }
1126421e10b8SBarry Smith   } else {
1127421e10b8SBarry Smith     if (!jac->w1) {
1128421e10b8SBarry Smith       ierr = VecDuplicate(x,&jac->w1);CHKERRQ(ierr);
1129421e10b8SBarry Smith       ierr = VecDuplicate(x,&jac->w2);CHKERRQ(ierr);
1130421e10b8SBarry Smith     }
1131421e10b8SBarry Smith     ierr = VecSet(y,0.0);CHKERRQ(ierr);
1132421e10b8SBarry Smith     if (jac->type == PC_COMPOSITE_SYMMETRIC_MULTIPLICATIVE) {
1133421e10b8SBarry Smith       ierr = FieldSplitSplitSolveAddTranspose(ilink,x,y);CHKERRQ(ierr);
11342618eb8fSHong Zhang       ierr = KSPGetConvergedReason(ilink->ksp,&reason);CHKERRQ(ierr);
11352618eb8fSHong Zhang       if (reason == KSP_DIVERGED_PCSETUP_FAILED) {
11362618eb8fSHong Zhang         pc->failedreason = PC_SUBPC_ERROR;
11372618eb8fSHong Zhang       }
1138421e10b8SBarry Smith       while (ilink->next) {
1139421e10b8SBarry Smith         ilink = ilink->next;
11409989ab13SBarry Smith         ierr  = MatMultTranspose(pc->mat,y,jac->w1);CHKERRQ(ierr);
1141421e10b8SBarry Smith         ierr  = VecWAXPY(jac->w2,-1.0,jac->w1,x);CHKERRQ(ierr);
1142421e10b8SBarry Smith         ierr  = FieldSplitSplitSolveAddTranspose(ilink,jac->w2,y);CHKERRQ(ierr);
1143421e10b8SBarry Smith       }
1144421e10b8SBarry Smith       while (ilink->previous) {
1145421e10b8SBarry Smith         ilink = ilink->previous;
11469989ab13SBarry Smith         ierr  = MatMultTranspose(pc->mat,y,jac->w1);CHKERRQ(ierr);
1147421e10b8SBarry Smith         ierr  = VecWAXPY(jac->w2,-1.0,jac->w1,x);CHKERRQ(ierr);
1148421e10b8SBarry Smith         ierr  = FieldSplitSplitSolveAddTranspose(ilink,jac->w2,y);CHKERRQ(ierr);
1149421e10b8SBarry Smith       }
1150421e10b8SBarry Smith     } else {
1151421e10b8SBarry Smith       while (ilink->next) {   /* get to last entry in linked list */
1152421e10b8SBarry Smith         ilink = ilink->next;
1153421e10b8SBarry Smith       }
1154421e10b8SBarry Smith       ierr = FieldSplitSplitSolveAddTranspose(ilink,x,y);CHKERRQ(ierr);
11552618eb8fSHong Zhang       ierr = KSPGetConvergedReason(ilink->ksp,&reason);CHKERRQ(ierr);
11562618eb8fSHong Zhang       if (reason == KSP_DIVERGED_PCSETUP_FAILED) {
11572618eb8fSHong Zhang         pc->failedreason = PC_SUBPC_ERROR;
11582618eb8fSHong Zhang       }
1159421e10b8SBarry Smith       while (ilink->previous) {
1160421e10b8SBarry Smith         ilink = ilink->previous;
11619989ab13SBarry Smith         ierr  = MatMultTranspose(pc->mat,y,jac->w1);CHKERRQ(ierr);
1162421e10b8SBarry Smith         ierr  = VecWAXPY(jac->w2,-1.0,jac->w1,x);CHKERRQ(ierr);
1163421e10b8SBarry Smith         ierr  = FieldSplitSplitSolveAddTranspose(ilink,jac->w2,y);CHKERRQ(ierr);
1164421e10b8SBarry Smith       }
1165421e10b8SBarry Smith     }
1166421e10b8SBarry Smith   }
1167421e10b8SBarry Smith   PetscFunctionReturn(0);
1168421e10b8SBarry Smith }
1169421e10b8SBarry Smith 
11700971522cSBarry Smith #undef __FUNCT__
1171574deadeSBarry Smith #define __FUNCT__ "PCReset_FieldSplit"
1172574deadeSBarry Smith static PetscErrorCode PCReset_FieldSplit(PC pc)
11730971522cSBarry Smith {
11740971522cSBarry Smith   PC_FieldSplit     *jac = (PC_FieldSplit*)pc->data;
11750971522cSBarry Smith   PetscErrorCode    ierr;
11765a9f2f41SSatish Balay   PC_FieldSplitLink ilink = jac->head,next;
11770971522cSBarry Smith 
11780971522cSBarry Smith   PetscFunctionBegin;
11795a9f2f41SSatish Balay   while (ilink) {
1180574deadeSBarry Smith     ierr  = KSPReset(ilink->ksp);CHKERRQ(ierr);
1181fcfd50ebSBarry Smith     ierr  = VecDestroy(&ilink->x);CHKERRQ(ierr);
1182fcfd50ebSBarry Smith     ierr  = VecDestroy(&ilink->y);CHKERRQ(ierr);
1183443836d0SMatthew G Knepley     ierr  = VecDestroy(&ilink->z);CHKERRQ(ierr);
1184fcfd50ebSBarry Smith     ierr  = VecScatterDestroy(&ilink->sctx);CHKERRQ(ierr);
11851c7cfba8SBarry Smith     if (!ilink->is_orig) {             /* save the original IS */
11866dbb499eSCian Wilson       ierr = PetscObjectReference((PetscObject)ilink->is);CHKERRQ(ierr);
11876dbb499eSCian Wilson       ilink->is_orig = ilink->is;
11886dbb499eSCian Wilson     }
1189fcfd50ebSBarry Smith     ierr  = ISDestroy(&ilink->is);CHKERRQ(ierr);
1190b5787286SJed Brown     ierr  = ISDestroy(&ilink->is_col);CHKERRQ(ierr);
11915a9f2f41SSatish Balay     next  = ilink->next;
11925a9f2f41SSatish Balay     ilink = next;
11930971522cSBarry Smith   }
119405b42c5fSBarry Smith   ierr = PetscFree2(jac->x,jac->y);CHKERRQ(ierr);
1195574deadeSBarry Smith   if (jac->mat && jac->mat != jac->pmat) {
1196574deadeSBarry Smith     ierr = MatDestroyMatrices(jac->nsplits,&jac->mat);CHKERRQ(ierr);
1197574deadeSBarry Smith   } else if (jac->mat) {
11980298fd71SBarry Smith     jac->mat = NULL;
1199574deadeSBarry Smith   }
120097bbdb24SBarry Smith   if (jac->pmat) {ierr = MatDestroyMatrices(jac->nsplits,&jac->pmat);CHKERRQ(ierr);}
120168dd23aaSBarry Smith   if (jac->Afield) {ierr = MatDestroyMatrices(jac->nsplits,&jac->Afield);CHKERRQ(ierr);}
12026bf464f9SBarry Smith   ierr       = VecDestroy(&jac->w1);CHKERRQ(ierr);
12036bf464f9SBarry Smith   ierr       = VecDestroy(&jac->w2);CHKERRQ(ierr);
12046bf464f9SBarry Smith   ierr       = MatDestroy(&jac->schur);CHKERRQ(ierr);
1205a7476a74SDmitry Karpeev   ierr       = MatDestroy(&jac->schurp);CHKERRQ(ierr);
12066bf464f9SBarry Smith   ierr       = MatDestroy(&jac->schur_user);CHKERRQ(ierr);
12076bf464f9SBarry Smith   ierr       = KSPDestroy(&jac->kspschur);CHKERRQ(ierr);
1208d78dad28SBarry Smith   ierr       = KSPDestroy(&jac->kspupper);CHKERRQ(ierr);
12096bf464f9SBarry Smith   ierr       = MatDestroy(&jac->B);CHKERRQ(ierr);
12106bf464f9SBarry Smith   ierr       = MatDestroy(&jac->C);CHKERRQ(ierr);
121163ec74ffSBarry Smith   jac->reset = PETSC_TRUE;
12126dbb499eSCian Wilson   jac->isrestrict = PETSC_FALSE;
1213574deadeSBarry Smith   PetscFunctionReturn(0);
1214574deadeSBarry Smith }
1215574deadeSBarry Smith 
1216574deadeSBarry Smith #undef __FUNCT__
1217574deadeSBarry Smith #define __FUNCT__ "PCDestroy_FieldSplit"
1218574deadeSBarry Smith static PetscErrorCode PCDestroy_FieldSplit(PC pc)
1219574deadeSBarry Smith {
1220574deadeSBarry Smith   PC_FieldSplit     *jac = (PC_FieldSplit*)pc->data;
1221574deadeSBarry Smith   PetscErrorCode    ierr;
1222574deadeSBarry Smith   PC_FieldSplitLink ilink = jac->head,next;
1223574deadeSBarry Smith 
1224574deadeSBarry Smith   PetscFunctionBegin;
1225574deadeSBarry Smith   ierr = PCReset_FieldSplit(pc);CHKERRQ(ierr);
1226574deadeSBarry Smith   while (ilink) {
12276bf464f9SBarry Smith     ierr  = KSPDestroy(&ilink->ksp);CHKERRQ(ierr);
12286dbb499eSCian Wilson     ierr  = ISDestroy(&ilink->is_orig);CHKERRQ(ierr);
1229574deadeSBarry Smith     next  = ilink->next;
1230574deadeSBarry Smith     ierr  = PetscFree(ilink->splitname);CHKERRQ(ierr);
1231574deadeSBarry Smith     ierr  = PetscFree(ilink->fields);CHKERRQ(ierr);
12325d4c12cdSJungho Lee     ierr  = PetscFree(ilink->fields_col);CHKERRQ(ierr);
1233574deadeSBarry Smith     ierr  = PetscFree(ilink);CHKERRQ(ierr);
1234574deadeSBarry Smith     ilink = next;
1235574deadeSBarry Smith   }
1236574deadeSBarry Smith   ierr = PetscFree2(jac->x,jac->y);CHKERRQ(ierr);
1237c31cb41cSBarry Smith   ierr = PetscFree(pc->data);CHKERRQ(ierr);
1238bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitGetSubKSP_C",NULL);CHKERRQ(ierr);
1239bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetFields_C",NULL);CHKERRQ(ierr);
1240bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetIS_C",NULL);CHKERRQ(ierr);
1241bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetType_C",NULL);CHKERRQ(ierr);
1242bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetBlockSize_C",NULL);CHKERRQ(ierr);
124329f8a81cSJed Brown   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetSchurPre_C",NULL);CHKERRQ(ierr);
124437a82bf0SJed Brown   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitGetSchurPre_C",NULL);CHKERRQ(ierr);
1245bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetSchurFactType_C",NULL);CHKERRQ(ierr);
12466dbb499eSCian Wilson   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitRestrictIS_C",NULL);CHKERRQ(ierr);
12470971522cSBarry Smith   PetscFunctionReturn(0);
12480971522cSBarry Smith }
12490971522cSBarry Smith 
12500971522cSBarry Smith #undef __FUNCT__
12510971522cSBarry Smith #define __FUNCT__ "PCSetFromOptions_FieldSplit"
12524416b707SBarry Smith static PetscErrorCode PCSetFromOptions_FieldSplit(PetscOptionItems *PetscOptionsObject,PC pc)
12530971522cSBarry Smith {
12541b9fc7fcSBarry Smith   PetscErrorCode  ierr;
12556c924f48SJed Brown   PetscInt        bs;
1256bc59fbc5SBarry Smith   PetscBool       flg,stokes = PETSC_FALSE;
12579dcbbd2bSBarry Smith   PC_FieldSplit   *jac = (PC_FieldSplit*)pc->data;
12583b224e63SBarry Smith   PCCompositeType ctype;
12591b9fc7fcSBarry Smith 
12600971522cSBarry Smith   PetscFunctionBegin;
1261e55864a3SBarry Smith   ierr = PetscOptionsHead(PetscOptionsObject,"FieldSplit options");CHKERRQ(ierr);
12624ab8060aSDmitry Karpeev   ierr = PetscOptionsBool("-pc_fieldsplit_dm_splits","Whether to use DMCreateFieldDecomposition() for splits","PCFieldSplitSetDMSplits",jac->dm_splits,&jac->dm_splits,NULL);CHKERRQ(ierr);
126351f519a2SBarry Smith   ierr = PetscOptionsInt("-pc_fieldsplit_block_size","Blocksize that defines number of fields","PCFieldSplitSetBlockSize",jac->bs,&bs,&flg);CHKERRQ(ierr);
126451f519a2SBarry Smith   if (flg) {
126551f519a2SBarry Smith     ierr = PCFieldSplitSetBlockSize(pc,bs);CHKERRQ(ierr);
126651f519a2SBarry Smith   }
12672686e3e9SMatthew G. Knepley   jac->diag_use_amat = pc->useAmat;
12682686e3e9SMatthew 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);
12692686e3e9SMatthew G. Knepley   jac->offdiag_use_amat = pc->useAmat;
12702686e3e9SMatthew 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);
127100216929SDmitry Karpeev   /* FIXME: No programmatic equivalent to the following. */
1272c5929fdfSBarry Smith   ierr = PetscOptionsGetBool(((PetscObject)pc)->options,((PetscObject)pc)->prefix,"-pc_fieldsplit_detect_saddle_point",&stokes,NULL);CHKERRQ(ierr);
1273c0adfefeSBarry Smith   if (stokes) {
1274c0adfefeSBarry Smith     ierr          = PCFieldSplitSetType(pc,PC_COMPOSITE_SCHUR);CHKERRQ(ierr);
1275c0adfefeSBarry Smith     jac->schurpre = PC_FIELDSPLIT_SCHUR_PRE_SELF;
1276c0adfefeSBarry Smith   }
1277c0adfefeSBarry Smith 
12783b224e63SBarry Smith   ierr = PetscOptionsEnum("-pc_fieldsplit_type","Type of composition","PCFieldSplitSetType",PCCompositeTypes,(PetscEnum)jac->type,(PetscEnum*)&ctype,&flg);CHKERRQ(ierr);
12793b224e63SBarry Smith   if (flg) {
12803b224e63SBarry Smith     ierr = PCFieldSplitSetType(pc,ctype);CHKERRQ(ierr);
12813b224e63SBarry Smith   }
1282c30613efSMatthew Knepley   /* Only setup fields once */
1283c30613efSMatthew Knepley   if ((jac->bs > 0) && (jac->nsplits == 0)) {
1284d32f9abdSBarry Smith     /* only allow user to set fields from command line if bs is already known.
1285d32f9abdSBarry Smith        otherwise user can set them in PCFieldSplitSetDefaults() */
12866c924f48SJed Brown     ierr = PCFieldSplitSetRuntimeSplits_Private(pc);CHKERRQ(ierr);
12876c924f48SJed Brown     if (jac->splitdefined) {ierr = PetscInfo(pc,"Splits defined using the options database\n");CHKERRQ(ierr);}
1288d32f9abdSBarry Smith   }
1289c5d2311dSJed Brown   if (jac->type == PC_COMPOSITE_SCHUR) {
1290c5929fdfSBarry Smith     ierr = PetscOptionsGetEnum(((PetscObject)pc)->options,((PetscObject)pc)->prefix,"-pc_fieldsplit_schur_factorization_type",PCFieldSplitSchurFactTypes,(PetscEnum*)&jac->schurfactorization,&flg);CHKERRQ(ierr);
1291c9c6ffaaSJed Brown     if (flg) {ierr = PetscInfo(pc,"Deprecated use of -pc_fieldsplit_schur_factorization_type\n");CHKERRQ(ierr);}
12920298fd71SBarry 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);
129329f8a81cSJed 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);
1294c5d2311dSJed Brown   }
12951b9fc7fcSBarry Smith   ierr = PetscOptionsTail();CHKERRQ(ierr);
12960971522cSBarry Smith   PetscFunctionReturn(0);
12970971522cSBarry Smith }
12980971522cSBarry Smith 
12990971522cSBarry Smith /*------------------------------------------------------------------------------------*/
13000971522cSBarry Smith 
13010971522cSBarry Smith #undef __FUNCT__
13020971522cSBarry Smith #define __FUNCT__ "PCFieldSplitSetFields_FieldSplit"
13031e6b0712SBarry Smith static PetscErrorCode  PCFieldSplitSetFields_FieldSplit(PC pc,const char splitname[],PetscInt n,const PetscInt *fields,const PetscInt *fields_col)
13040971522cSBarry Smith {
130597bbdb24SBarry Smith   PC_FieldSplit     *jac = (PC_FieldSplit*)pc->data;
13060971522cSBarry Smith   PetscErrorCode    ierr;
13075a9f2f41SSatish Balay   PC_FieldSplitLink ilink,next = jac->head;
130869a612a9SBarry Smith   char              prefix[128];
13095d4c12cdSJungho Lee   PetscInt          i;
13100971522cSBarry Smith 
13110971522cSBarry Smith   PetscFunctionBegin;
13126c924f48SJed Brown   if (jac->splitdefined) {
13136c924f48SJed Brown     ierr = PetscInfo1(pc,"Ignoring new split \"%s\" because the splits have already been defined\n",splitname);CHKERRQ(ierr);
13146c924f48SJed Brown     PetscFunctionReturn(0);
13156c924f48SJed Brown   }
131651f519a2SBarry Smith   for (i=0; i<n; i++) {
1317e32f2f54SBarry 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);
1318e32f2f54SBarry Smith     if (fields[i] < 0) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Negative field %D requested",fields[i]);
131951f519a2SBarry Smith   }
1320b00a9115SJed Brown   ierr = PetscNew(&ilink);CHKERRQ(ierr);
1321a04f6461SBarry Smith   if (splitname) {
1322db4c96c1SJed Brown     ierr = PetscStrallocpy(splitname,&ilink->splitname);CHKERRQ(ierr);
1323a04f6461SBarry Smith   } else {
1324785e854fSJed Brown     ierr = PetscMalloc1(3,&ilink->splitname);CHKERRQ(ierr);
1325a04f6461SBarry Smith     ierr = PetscSNPrintf(ilink->splitname,2,"%s",jac->nsplits);CHKERRQ(ierr);
1326a04f6461SBarry Smith   }
13279df09d43SBarry 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 */
1328785e854fSJed Brown   ierr = PetscMalloc1(n,&ilink->fields);CHKERRQ(ierr);
13295a9f2f41SSatish Balay   ierr = PetscMemcpy(ilink->fields,fields,n*sizeof(PetscInt));CHKERRQ(ierr);
1330785e854fSJed Brown   ierr = PetscMalloc1(n,&ilink->fields_col);CHKERRQ(ierr);
13315d4c12cdSJungho Lee   ierr = PetscMemcpy(ilink->fields_col,fields_col,n*sizeof(PetscInt));CHKERRQ(ierr);
13322fa5cd67SKarl Rupp 
13335a9f2f41SSatish Balay   ilink->nfields = n;
13340298fd71SBarry Smith   ilink->next    = NULL;
1335ce94432eSBarry Smith   ierr           = KSPCreate(PetscObjectComm((PetscObject)pc),&ilink->ksp);CHKERRQ(ierr);
1336422a814eSBarry Smith   ierr           = KSPSetErrorIfNotConverged(ilink->ksp,pc->erroriffailure);CHKERRQ(ierr);
133720252d06SBarry Smith   ierr           = PetscObjectIncrementTabLevel((PetscObject)ilink->ksp,(PetscObject)pc,1);CHKERRQ(ierr);
13385a9f2f41SSatish Balay   ierr           = KSPSetType(ilink->ksp,KSPPREONLY);CHKERRQ(ierr);
13399005cf84SBarry Smith   ierr           = PetscLogObjectParent((PetscObject)pc,(PetscObject)ilink->ksp);CHKERRQ(ierr);
134069a612a9SBarry Smith 
13418caf3d72SBarry Smith   ierr = PetscSNPrintf(prefix,sizeof(prefix),"%sfieldsplit_%s_",((PetscObject)pc)->prefix ? ((PetscObject)pc)->prefix : "",ilink->splitname);CHKERRQ(ierr);
13425a9f2f41SSatish Balay   ierr = KSPSetOptionsPrefix(ilink->ksp,prefix);CHKERRQ(ierr);
13430971522cSBarry Smith 
13440971522cSBarry Smith   if (!next) {
13455a9f2f41SSatish Balay     jac->head       = ilink;
13460298fd71SBarry Smith     ilink->previous = NULL;
13470971522cSBarry Smith   } else {
13480971522cSBarry Smith     while (next->next) {
13490971522cSBarry Smith       next = next->next;
13500971522cSBarry Smith     }
13515a9f2f41SSatish Balay     next->next      = ilink;
135251f519a2SBarry Smith     ilink->previous = next;
13530971522cSBarry Smith   }
13540971522cSBarry Smith   jac->nsplits++;
13550971522cSBarry Smith   PetscFunctionReturn(0);
13560971522cSBarry Smith }
13570971522cSBarry Smith 
1358e69d4d44SBarry Smith #undef __FUNCT__
1359e69d4d44SBarry Smith #define __FUNCT__ "PCFieldSplitGetSubKSP_FieldSplit_Schur"
13601e6b0712SBarry Smith static PetscErrorCode  PCFieldSplitGetSubKSP_FieldSplit_Schur(PC pc,PetscInt *n,KSP **subksp)
1361e69d4d44SBarry Smith {
1362e69d4d44SBarry Smith   PC_FieldSplit  *jac = (PC_FieldSplit*)pc->data;
1363e69d4d44SBarry Smith   PetscErrorCode ierr;
1364e69d4d44SBarry Smith 
1365e69d4d44SBarry Smith   PetscFunctionBegin;
1366785e854fSJed Brown   ierr = PetscMalloc1(jac->nsplits,subksp);CHKERRQ(ierr);
1367e69d4d44SBarry Smith   ierr = MatSchurComplementGetKSP(jac->schur,*subksp);CHKERRQ(ierr);
13682fa5cd67SKarl Rupp 
1369e69d4d44SBarry Smith   (*subksp)[1] = jac->kspschur;
137013e0d083SBarry Smith   if (n) *n = jac->nsplits;
1371e69d4d44SBarry Smith   PetscFunctionReturn(0);
1372e69d4d44SBarry Smith }
13730971522cSBarry Smith 
13740971522cSBarry Smith #undef __FUNCT__
137569a612a9SBarry Smith #define __FUNCT__ "PCFieldSplitGetSubKSP_FieldSplit"
13761e6b0712SBarry Smith static PetscErrorCode  PCFieldSplitGetSubKSP_FieldSplit(PC pc,PetscInt *n,KSP **subksp)
13770971522cSBarry Smith {
13780971522cSBarry Smith   PC_FieldSplit     *jac = (PC_FieldSplit*)pc->data;
13790971522cSBarry Smith   PetscErrorCode    ierr;
13800971522cSBarry Smith   PetscInt          cnt   = 0;
13815a9f2f41SSatish Balay   PC_FieldSplitLink ilink = jac->head;
13820971522cSBarry Smith 
13830971522cSBarry Smith   PetscFunctionBegin;
1384785e854fSJed Brown   ierr = PetscMalloc1(jac->nsplits,subksp);CHKERRQ(ierr);
13855a9f2f41SSatish Balay   while (ilink) {
13865a9f2f41SSatish Balay     (*subksp)[cnt++] = ilink->ksp;
13875a9f2f41SSatish Balay     ilink            = ilink->next;
13880971522cSBarry Smith   }
13895d480477SMatthew 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);
139013e0d083SBarry Smith   if (n) *n = jac->nsplits;
13910971522cSBarry Smith   PetscFunctionReturn(0);
13920971522cSBarry Smith }
13930971522cSBarry Smith 
1394704ba839SBarry Smith #undef __FUNCT__
13956dbb499eSCian Wilson #define __FUNCT__ "PCFieldSplitRestrictIS"
13966dbb499eSCian Wilson /*@C
13976dbb499eSCian Wilson     PCFieldSplitRestrictIS - Restricts the fieldsplit ISs to be within a given IS.
13986dbb499eSCian Wilson 
13996dbb499eSCian Wilson     Input Parameters:
14006dbb499eSCian Wilson +   pc  - the preconditioner context
14016dbb499eSCian Wilson +   is - the index set that defines the indices to which the fieldsplit is to be restricted
14026dbb499eSCian Wilson 
14036dbb499eSCian Wilson     Level: advanced
14046dbb499eSCian Wilson 
14056dbb499eSCian Wilson @*/
14066dbb499eSCian Wilson PetscErrorCode  PCFieldSplitRestrictIS(PC pc,IS isy)
14076dbb499eSCian Wilson {
14086dbb499eSCian Wilson   PetscErrorCode ierr;
14096dbb499eSCian Wilson 
14106dbb499eSCian Wilson   PetscFunctionBegin;
14116dbb499eSCian Wilson   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
14126dbb499eSCian Wilson   PetscValidHeaderSpecific(isy,IS_CLASSID,2);
14130246f55cSBarry Smith   ierr = PetscTryMethod(pc,"PCFieldSplitRestrictIS_C",(PC,IS),(pc,isy));CHKERRQ(ierr);
14146dbb499eSCian Wilson   PetscFunctionReturn(0);
14156dbb499eSCian Wilson }
14166dbb499eSCian Wilson 
14176dbb499eSCian Wilson 
14186dbb499eSCian Wilson #undef __FUNCT__
14196dbb499eSCian Wilson #define __FUNCT__ "PCFieldSplitRestrictIS_FieldSplit"
14206dbb499eSCian Wilson static PetscErrorCode  PCFieldSplitRestrictIS_FieldSplit(PC pc, IS isy)
14216dbb499eSCian Wilson {
14226dbb499eSCian Wilson   PC_FieldSplit     *jac = (PC_FieldSplit*)pc->data;
14236dbb499eSCian Wilson   PetscErrorCode    ierr;
14246dbb499eSCian Wilson   PC_FieldSplitLink ilink = jac->head, next;
14256dbb499eSCian Wilson   PetscInt          localsize,size,sizez,i;
14266dbb499eSCian Wilson   const PetscInt    *ind, *indz;
14276dbb499eSCian Wilson   PetscInt          *indc, *indcz;
14286dbb499eSCian Wilson   PetscBool         flg;
14296dbb499eSCian Wilson 
14306dbb499eSCian Wilson   PetscFunctionBegin;
14316dbb499eSCian Wilson   ierr = ISGetLocalSize(isy,&localsize);CHKERRQ(ierr);
14326dbb499eSCian Wilson   ierr = MPI_Scan(&localsize,&size,1,MPIU_INT,MPI_SUM,PetscObjectComm((PetscObject)isy));CHKERRQ(ierr);
14336dbb499eSCian Wilson   size -= localsize;
14346dbb499eSCian Wilson   while(ilink) {
14356dbb499eSCian Wilson     IS isrl,isr;
14361c7cfba8SBarry Smith     PC subpc;
14376dbb499eSCian Wilson     if (jac->reset) {
14386dbb499eSCian Wilson       ierr = ISEmbed(ilink->is_orig, isy, PETSC_TRUE, &isrl);CHKERRQ(ierr);
14396dbb499eSCian Wilson     } else {
14406dbb499eSCian Wilson       ierr = ISEmbed(ilink->is, isy, PETSC_TRUE, &isrl);CHKERRQ(ierr);
14416dbb499eSCian Wilson     }
14426dbb499eSCian Wilson     ierr          = ISGetLocalSize(isrl,&localsize);CHKERRQ(ierr);
14436dbb499eSCian Wilson     ierr          = PetscMalloc1(localsize,&indc);CHKERRQ(ierr);
14446dbb499eSCian Wilson     ierr          = ISGetIndices(isrl,&ind);CHKERRQ(ierr);
14456dbb499eSCian Wilson     ierr          = PetscMemcpy(indc,ind,localsize*sizeof(PetscInt));CHKERRQ(ierr);
14466dbb499eSCian Wilson     ierr          = ISRestoreIndices(isrl,&ind);CHKERRQ(ierr);
14476dbb499eSCian Wilson     ierr          = ISDestroy(&isrl);CHKERRQ(ierr);
14486dbb499eSCian Wilson     for (i=0; i<localsize; i++) *(indc+i) += size;
14496dbb499eSCian Wilson     ierr          = ISCreateGeneral(PetscObjectComm((PetscObject)isy),localsize,indc,PETSC_OWN_POINTER,&isr);CHKERRQ(ierr);
14506dbb499eSCian Wilson     ierr          = PetscObjectReference((PetscObject)isr);CHKERRQ(ierr);
14516dbb499eSCian Wilson     ierr          = ISDestroy(&ilink->is);CHKERRQ(ierr);
14526dbb499eSCian Wilson     ilink->is     = isr;
14536dbb499eSCian Wilson     ierr          = PetscObjectReference((PetscObject)isr);CHKERRQ(ierr);
14546dbb499eSCian Wilson     ierr          = ISDestroy(&ilink->is_col);CHKERRQ(ierr);
14556dbb499eSCian Wilson     ilink->is_col = isr;
14566dbb499eSCian Wilson     ierr          = ISDestroy(&isr);CHKERRQ(ierr);
14576dbb499eSCian Wilson     ierr          = KSPGetPC(ilink->ksp, &subpc);CHKERRQ(ierr);
14586dbb499eSCian Wilson     ierr          = PetscObjectTypeCompare((PetscObject)subpc,PCFIELDSPLIT,&flg);CHKERRQ(ierr);
14596dbb499eSCian Wilson     if(flg) {
14606dbb499eSCian Wilson       IS iszl,isz;
14616dbb499eSCian Wilson       MPI_Comm comm;
14626dbb499eSCian Wilson       if (jac->reset) {
14636dbb499eSCian Wilson         ierr = ISGetLocalSize(ilink->is_orig,&localsize);CHKERRQ(ierr);
14646dbb499eSCian Wilson         comm = PetscObjectComm((PetscObject)ilink->is_orig);
14656dbb499eSCian Wilson         ierr = ISEmbed(isy, ilink->is_orig, PETSC_TRUE, &iszl);CHKERRQ(ierr);
14666dbb499eSCian Wilson       } else {
14676dbb499eSCian Wilson         ierr = ISGetLocalSize(ilink->is,&localsize);CHKERRQ(ierr);
14686dbb499eSCian Wilson         comm = PetscObjectComm((PetscObject)ilink->is);
14696dbb499eSCian Wilson         ierr = ISEmbed(isy, ilink->is, PETSC_TRUE, &iszl);CHKERRQ(ierr);
14706dbb499eSCian Wilson       }
14716dbb499eSCian Wilson       ierr   = MPI_Scan(&localsize,&sizez,1,MPIU_INT,MPI_SUM,comm);CHKERRQ(ierr);
14726dbb499eSCian Wilson       sizez -= localsize;
14736dbb499eSCian Wilson       ierr   = ISGetLocalSize(iszl,&localsize);CHKERRQ(ierr);
14746dbb499eSCian Wilson       ierr   = PetscMalloc1(localsize,&indcz);CHKERRQ(ierr);
14756dbb499eSCian Wilson       ierr   = ISGetIndices(iszl,&indz);CHKERRQ(ierr);
14766dbb499eSCian Wilson       ierr   = PetscMemcpy(indcz,indz,localsize*sizeof(PetscInt));CHKERRQ(ierr);
14776dbb499eSCian Wilson       ierr   = ISRestoreIndices(iszl,&indz);CHKERRQ(ierr);
14786dbb499eSCian Wilson       ierr   = ISDestroy(&iszl);CHKERRQ(ierr);
14796dbb499eSCian Wilson       for (i=0; i<localsize; i++) *(indcz+i) += sizez;
14806dbb499eSCian Wilson       ierr   = ISCreateGeneral(comm,localsize,indcz,PETSC_OWN_POINTER,&isz);CHKERRQ(ierr);
14816dbb499eSCian Wilson       ierr   = PCFieldSplitRestrictIS(subpc,isz);CHKERRQ(ierr);
14826dbb499eSCian Wilson       ierr   = ISDestroy(&isz);CHKERRQ(ierr);
14836dbb499eSCian Wilson     }
14846dbb499eSCian Wilson     next = ilink->next;
14856dbb499eSCian Wilson     ilink = next;
14866dbb499eSCian Wilson   }
14876dbb499eSCian Wilson   jac->isrestrict = PETSC_TRUE;
14886dbb499eSCian Wilson   PetscFunctionReturn(0);
14896dbb499eSCian Wilson }
14906dbb499eSCian Wilson 
14916dbb499eSCian Wilson #undef __FUNCT__
1492704ba839SBarry Smith #define __FUNCT__ "PCFieldSplitSetIS_FieldSplit"
14931e6b0712SBarry Smith static PetscErrorCode  PCFieldSplitSetIS_FieldSplit(PC pc,const char splitname[],IS is)
1494704ba839SBarry Smith {
1495704ba839SBarry Smith   PC_FieldSplit     *jac = (PC_FieldSplit*)pc->data;
1496704ba839SBarry Smith   PetscErrorCode    ierr;
1497704ba839SBarry Smith   PC_FieldSplitLink ilink, next = jac->head;
1498704ba839SBarry Smith   char              prefix[128];
1499704ba839SBarry Smith 
1500704ba839SBarry Smith   PetscFunctionBegin;
15016c924f48SJed Brown   if (jac->splitdefined) {
15026c924f48SJed Brown     ierr = PetscInfo1(pc,"Ignoring new split \"%s\" because the splits have already been defined\n",splitname);CHKERRQ(ierr);
15036c924f48SJed Brown     PetscFunctionReturn(0);
15046c924f48SJed Brown   }
1505b00a9115SJed Brown   ierr = PetscNew(&ilink);CHKERRQ(ierr);
1506a04f6461SBarry Smith   if (splitname) {
1507db4c96c1SJed Brown     ierr = PetscStrallocpy(splitname,&ilink->splitname);CHKERRQ(ierr);
1508a04f6461SBarry Smith   } else {
1509785e854fSJed Brown     ierr = PetscMalloc1(8,&ilink->splitname);CHKERRQ(ierr);
1510b5787286SJed Brown     ierr = PetscSNPrintf(ilink->splitname,7,"%D",jac->nsplits);CHKERRQ(ierr);
1511a04f6461SBarry Smith   }
15129df09d43SBarry 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 */
15131ab39975SBarry Smith   ierr          = PetscObjectReference((PetscObject)is);CHKERRQ(ierr);
1514b5787286SJed Brown   ierr          = ISDestroy(&ilink->is);CHKERRQ(ierr);
1515b5787286SJed Brown   ilink->is     = is;
1516b5787286SJed Brown   ierr          = PetscObjectReference((PetscObject)is);CHKERRQ(ierr);
1517b5787286SJed Brown   ierr          = ISDestroy(&ilink->is_col);CHKERRQ(ierr);
1518b5787286SJed Brown   ilink->is_col = is;
15190298fd71SBarry Smith   ilink->next   = NULL;
1520ce94432eSBarry Smith   ierr          = KSPCreate(PetscObjectComm((PetscObject)pc),&ilink->ksp);CHKERRQ(ierr);
1521422a814eSBarry Smith   ierr          = KSPSetErrorIfNotConverged(ilink->ksp,pc->erroriffailure);CHKERRQ(ierr);
152220252d06SBarry Smith   ierr          = PetscObjectIncrementTabLevel((PetscObject)ilink->ksp,(PetscObject)pc,1);CHKERRQ(ierr);
1523704ba839SBarry Smith   ierr          = KSPSetType(ilink->ksp,KSPPREONLY);CHKERRQ(ierr);
15249005cf84SBarry Smith   ierr          = PetscLogObjectParent((PetscObject)pc,(PetscObject)ilink->ksp);CHKERRQ(ierr);
1525704ba839SBarry Smith 
15268caf3d72SBarry Smith   ierr = PetscSNPrintf(prefix,sizeof(prefix),"%sfieldsplit_%s_",((PetscObject)pc)->prefix ? ((PetscObject)pc)->prefix : "",ilink->splitname);CHKERRQ(ierr);
1527704ba839SBarry Smith   ierr = KSPSetOptionsPrefix(ilink->ksp,prefix);CHKERRQ(ierr);
1528704ba839SBarry Smith 
1529704ba839SBarry Smith   if (!next) {
1530704ba839SBarry Smith     jac->head       = ilink;
15310298fd71SBarry Smith     ilink->previous = NULL;
1532704ba839SBarry Smith   } else {
1533704ba839SBarry Smith     while (next->next) {
1534704ba839SBarry Smith       next = next->next;
1535704ba839SBarry Smith     }
1536704ba839SBarry Smith     next->next      = ilink;
1537704ba839SBarry Smith     ilink->previous = next;
1538704ba839SBarry Smith   }
1539704ba839SBarry Smith   jac->nsplits++;
1540704ba839SBarry Smith   PetscFunctionReturn(0);
1541704ba839SBarry Smith }
1542704ba839SBarry Smith 
15430971522cSBarry Smith #undef __FUNCT__
15440971522cSBarry Smith #define __FUNCT__ "PCFieldSplitSetFields"
15450971522cSBarry Smith /*@
15460971522cSBarry Smith     PCFieldSplitSetFields - Sets the fields for one particular split in the field split preconditioner
15470971522cSBarry Smith 
1548ad4df100SBarry Smith     Logically Collective on PC
15490971522cSBarry Smith 
15500971522cSBarry Smith     Input Parameters:
15510971522cSBarry Smith +   pc  - the preconditioner context
15520298fd71SBarry Smith .   splitname - name of this split, if NULL the number of the split is used
15530971522cSBarry Smith .   n - the number of fields in this split
1554db4c96c1SJed Brown -   fields - the fields in this split
15550971522cSBarry Smith 
15560971522cSBarry Smith     Level: intermediate
15570971522cSBarry Smith 
1558d32f9abdSBarry Smith     Notes: Use PCFieldSplitSetIS() to set a completely general set of indices as a field.
1559d32f9abdSBarry Smith 
15607287d2a3SDmitry Karpeev      The PCFieldSplitSetFields() is for defining fields as strided blocks. For example, if the block
1561d32f9abdSBarry 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
1562d32f9abdSBarry Smith      0xx3xx6xx9xx12 ... x1xx4xx7xx ... xx2xx5xx8xx.. 01x34x67x... 0x1x3x5x7.. x12x45x78x....
1563d32f9abdSBarry Smith      where the numbered entries indicate what is in the field.
1564d32f9abdSBarry Smith 
1565db4c96c1SJed Brown      This function is called once per split (it creates a new split each time).  Solve options
1566db4c96c1SJed Brown      for this split will be available under the prefix -fieldsplit_SPLITNAME_.
1567db4c96c1SJed Brown 
15685d4c12cdSJungho Lee      Developer Note: This routine does not actually create the IS representing the split, that is delayed
15695d4c12cdSJungho Lee      until PCSetUp_FieldSplit(), because information about the vector/matrix layouts may not be
15705d4c12cdSJungho Lee      available when this routine is called.
15715d4c12cdSJungho Lee 
1572d32f9abdSBarry Smith .seealso: PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitSetBlockSize(), PCFieldSplitSetIS()
15730971522cSBarry Smith 
15740971522cSBarry Smith @*/
15755d4c12cdSJungho Lee PetscErrorCode  PCFieldSplitSetFields(PC pc,const char splitname[],PetscInt n,const PetscInt *fields,const PetscInt *fields_col)
15760971522cSBarry Smith {
15774ac538c5SBarry Smith   PetscErrorCode ierr;
15780971522cSBarry Smith 
15790971522cSBarry Smith   PetscFunctionBegin;
15800700a824SBarry Smith   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
1581db4c96c1SJed Brown   PetscValidCharPointer(splitname,2);
1582ce94432eSBarry Smith   if (n < 1) SETERRQ2(PetscObjectComm((PetscObject)pc),PETSC_ERR_ARG_OUTOFRANGE,"Provided number of fields %D in split \"%s\" not positive",n,splitname);
1583db4c96c1SJed Brown   PetscValidIntPointer(fields,3);
15840246f55cSBarry Smith   ierr = PetscTryMethod(pc,"PCFieldSplitSetFields_C",(PC,const char[],PetscInt,const PetscInt*,const PetscInt*),(pc,splitname,n,fields,fields_col));CHKERRQ(ierr);
15850971522cSBarry Smith   PetscFunctionReturn(0);
15860971522cSBarry Smith }
15870971522cSBarry Smith 
15880971522cSBarry Smith #undef __FUNCT__
1589c84da90fSDmitry Karpeev #define __FUNCT__ "PCFieldSplitSetDiagUseAmat"
1590c84da90fSDmitry Karpeev /*@
1591c84da90fSDmitry Karpeev     PCFieldSplitSetDiagUseAmat - set flag indicating whether to extract diagonal blocks from Amat (rather than Pmat)
1592c84da90fSDmitry Karpeev 
1593c84da90fSDmitry Karpeev     Logically Collective on PC
1594c84da90fSDmitry Karpeev 
1595c84da90fSDmitry Karpeev     Input Parameters:
1596c84da90fSDmitry Karpeev +   pc  - the preconditioner object
1597c84da90fSDmitry Karpeev -   flg - boolean flag indicating whether or not to use Amat to extract the diagonal blocks from
1598c84da90fSDmitry Karpeev 
15999506b623SDmitry Karpeev     Options Database:
16009506b623SDmitry Karpeev .     -pc_fieldsplit_diag_use_amat
1601c84da90fSDmitry Karpeev 
1602c84da90fSDmitry Karpeev     Level: intermediate
1603c84da90fSDmitry Karpeev 
1604c84da90fSDmitry Karpeev .seealso: PCFieldSplitGetDiagUseAmat(), PCFieldSplitSetOffDiagUseAmat(), PCFIELDSPLIT
1605c84da90fSDmitry Karpeev 
1606c84da90fSDmitry Karpeev @*/
1607c84da90fSDmitry Karpeev PetscErrorCode  PCFieldSplitSetDiagUseAmat(PC pc,PetscBool flg)
1608c84da90fSDmitry Karpeev {
1609c84da90fSDmitry Karpeev   PC_FieldSplit  *jac = (PC_FieldSplit*)pc->data;
1610c84da90fSDmitry Karpeev   PetscBool      isfs;
1611c84da90fSDmitry Karpeev   PetscErrorCode ierr;
1612c84da90fSDmitry Karpeev 
1613c84da90fSDmitry Karpeev   PetscFunctionBegin;
1614c84da90fSDmitry Karpeev   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
1615c84da90fSDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)pc,PCFIELDSPLIT,&isfs);CHKERRQ(ierr);
1616c84da90fSDmitry Karpeev   if (!isfs) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"PC not of type %s",PCFIELDSPLIT);
1617c84da90fSDmitry Karpeev   jac->diag_use_amat = flg;
1618c84da90fSDmitry Karpeev   PetscFunctionReturn(0);
1619c84da90fSDmitry Karpeev }
1620c84da90fSDmitry Karpeev 
1621c84da90fSDmitry Karpeev #undef __FUNCT__
1622c84da90fSDmitry Karpeev #define __FUNCT__ "PCFieldSplitGetDiagUseAmat"
1623c84da90fSDmitry Karpeev /*@
1624c84da90fSDmitry Karpeev     PCFieldSplitGetDiagUseAmat - get the flag indicating whether to extract diagonal blocks from Amat (rather than Pmat)
1625c84da90fSDmitry Karpeev 
1626c84da90fSDmitry Karpeev     Logically Collective on PC
1627c84da90fSDmitry Karpeev 
1628c84da90fSDmitry Karpeev     Input Parameters:
1629c84da90fSDmitry Karpeev .   pc  - the preconditioner object
1630c84da90fSDmitry Karpeev 
1631c84da90fSDmitry Karpeev     Output Parameters:
1632c84da90fSDmitry Karpeev .   flg - boolean flag indicating whether or not to use Amat to extract the diagonal blocks from
1633c84da90fSDmitry Karpeev 
1634c84da90fSDmitry Karpeev 
1635c84da90fSDmitry Karpeev     Level: intermediate
1636c84da90fSDmitry Karpeev 
1637c84da90fSDmitry Karpeev .seealso: PCFieldSplitSetDiagUseAmat(), PCFieldSplitGetOffDiagUseAmat(), PCFIELDSPLIT
1638c84da90fSDmitry Karpeev 
1639c84da90fSDmitry Karpeev @*/
1640c84da90fSDmitry Karpeev PetscErrorCode  PCFieldSplitGetDiagUseAmat(PC pc,PetscBool *flg)
1641c84da90fSDmitry Karpeev {
1642c84da90fSDmitry Karpeev   PC_FieldSplit  *jac = (PC_FieldSplit*)pc->data;
1643c84da90fSDmitry Karpeev   PetscBool      isfs;
1644c84da90fSDmitry Karpeev   PetscErrorCode ierr;
1645c84da90fSDmitry Karpeev 
1646c84da90fSDmitry Karpeev   PetscFunctionBegin;
1647c84da90fSDmitry Karpeev   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
1648c84da90fSDmitry Karpeev   PetscValidPointer(flg,2);
1649c84da90fSDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)pc,PCFIELDSPLIT,&isfs);CHKERRQ(ierr);
1650c84da90fSDmitry Karpeev   if (!isfs) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"PC not of type %s",PCFIELDSPLIT);
1651c84da90fSDmitry Karpeev   *flg = jac->diag_use_amat;
1652c84da90fSDmitry Karpeev   PetscFunctionReturn(0);
1653c84da90fSDmitry Karpeev }
1654c84da90fSDmitry Karpeev 
1655c84da90fSDmitry Karpeev #undef __FUNCT__
1656c84da90fSDmitry Karpeev #define __FUNCT__ "PCFieldSplitSetOffDiagUseAmat"
1657c84da90fSDmitry Karpeev /*@
1658c84da90fSDmitry Karpeev     PCFieldSplitSetOffDiagUseAmat - set flag indicating whether to extract off-diagonal blocks from Amat (rather than Pmat)
1659c84da90fSDmitry Karpeev 
1660c84da90fSDmitry Karpeev     Logically Collective on PC
1661c84da90fSDmitry Karpeev 
1662c84da90fSDmitry Karpeev     Input Parameters:
1663c84da90fSDmitry Karpeev +   pc  - the preconditioner object
1664c84da90fSDmitry Karpeev -   flg - boolean flag indicating whether or not to use Amat to extract the off-diagonal blocks from
1665c84da90fSDmitry Karpeev 
16669506b623SDmitry Karpeev     Options Database:
16679506b623SDmitry Karpeev .     -pc_fieldsplit_off_diag_use_amat
1668c84da90fSDmitry Karpeev 
1669c84da90fSDmitry Karpeev     Level: intermediate
1670c84da90fSDmitry Karpeev 
1671c84da90fSDmitry Karpeev .seealso: PCFieldSplitGetOffDiagUseAmat(), PCFieldSplitSetDiagUseAmat(), PCFIELDSPLIT
1672c84da90fSDmitry Karpeev 
1673c84da90fSDmitry Karpeev @*/
1674c84da90fSDmitry Karpeev PetscErrorCode  PCFieldSplitSetOffDiagUseAmat(PC pc,PetscBool flg)
1675c84da90fSDmitry Karpeev {
1676c84da90fSDmitry Karpeev   PC_FieldSplit *jac = (PC_FieldSplit*)pc->data;
1677c84da90fSDmitry Karpeev   PetscBool      isfs;
1678c84da90fSDmitry Karpeev   PetscErrorCode ierr;
1679c84da90fSDmitry Karpeev 
1680c84da90fSDmitry Karpeev   PetscFunctionBegin;
1681c84da90fSDmitry Karpeev   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
1682c84da90fSDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)pc,PCFIELDSPLIT,&isfs);CHKERRQ(ierr);
1683c84da90fSDmitry Karpeev   if (!isfs) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"PC not of type %s",PCFIELDSPLIT);
1684c84da90fSDmitry Karpeev   jac->offdiag_use_amat = flg;
1685c84da90fSDmitry Karpeev   PetscFunctionReturn(0);
1686c84da90fSDmitry Karpeev }
1687c84da90fSDmitry Karpeev 
1688c84da90fSDmitry Karpeev #undef __FUNCT__
1689c84da90fSDmitry Karpeev #define __FUNCT__ "PCFieldSplitGetOffDiagUseAmat"
1690c84da90fSDmitry Karpeev /*@
1691c84da90fSDmitry Karpeev     PCFieldSplitGetOffDiagUseAmat - get the flag indicating whether to extract off-diagonal blocks from Amat (rather than Pmat)
1692c84da90fSDmitry Karpeev 
1693c84da90fSDmitry Karpeev     Logically Collective on PC
1694c84da90fSDmitry Karpeev 
1695c84da90fSDmitry Karpeev     Input Parameters:
1696c84da90fSDmitry Karpeev .   pc  - the preconditioner object
1697c84da90fSDmitry Karpeev 
1698c84da90fSDmitry Karpeev     Output Parameters:
1699c84da90fSDmitry Karpeev .   flg - boolean flag indicating whether or not to use Amat to extract the off-diagonal blocks from
1700c84da90fSDmitry Karpeev 
1701c84da90fSDmitry Karpeev 
1702c84da90fSDmitry Karpeev     Level: intermediate
1703c84da90fSDmitry Karpeev 
1704c84da90fSDmitry Karpeev .seealso: PCFieldSplitSetOffDiagUseAmat(), PCFieldSplitGetDiagUseAmat(), PCFIELDSPLIT
1705c84da90fSDmitry Karpeev 
1706c84da90fSDmitry Karpeev @*/
1707c84da90fSDmitry Karpeev PetscErrorCode  PCFieldSplitGetOffDiagUseAmat(PC pc,PetscBool *flg)
1708c84da90fSDmitry Karpeev {
1709c84da90fSDmitry Karpeev   PC_FieldSplit  *jac = (PC_FieldSplit*)pc->data;
1710c84da90fSDmitry Karpeev   PetscBool      isfs;
1711c84da90fSDmitry Karpeev   PetscErrorCode ierr;
1712c84da90fSDmitry Karpeev 
1713c84da90fSDmitry Karpeev   PetscFunctionBegin;
1714c84da90fSDmitry Karpeev   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
1715c84da90fSDmitry Karpeev   PetscValidPointer(flg,2);
1716c84da90fSDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)pc,PCFIELDSPLIT,&isfs);CHKERRQ(ierr);
1717c84da90fSDmitry Karpeev   if (!isfs) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"PC not of type %s",PCFIELDSPLIT);
1718c84da90fSDmitry Karpeev   *flg = jac->offdiag_use_amat;
1719c84da90fSDmitry Karpeev   PetscFunctionReturn(0);
1720c84da90fSDmitry Karpeev }
1721c84da90fSDmitry Karpeev 
1722c84da90fSDmitry Karpeev 
1723c84da90fSDmitry Karpeev 
1724c84da90fSDmitry Karpeev #undef __FUNCT__
1725704ba839SBarry Smith #define __FUNCT__ "PCFieldSplitSetIS"
1726218d4943SBarry Smith /*@C
1727704ba839SBarry Smith     PCFieldSplitSetIS - Sets the exact elements for field
1728704ba839SBarry Smith 
1729ad4df100SBarry Smith     Logically Collective on PC
1730704ba839SBarry Smith 
1731704ba839SBarry Smith     Input Parameters:
1732704ba839SBarry Smith +   pc  - the preconditioner context
17330298fd71SBarry Smith .   splitname - name of this split, if NULL the number of the split is used
1734db4c96c1SJed Brown -   is - the index set that defines the vector elements in this field
1735704ba839SBarry Smith 
1736d32f9abdSBarry Smith 
1737a6ffb8dbSJed Brown     Notes:
1738a6ffb8dbSJed Brown     Use PCFieldSplitSetFields(), for fields defined by strided types.
1739a6ffb8dbSJed Brown 
1740db4c96c1SJed Brown     This function is called once per split (it creates a new split each time).  Solve options
1741db4c96c1SJed Brown     for this split will be available under the prefix -fieldsplit_SPLITNAME_.
1742d32f9abdSBarry Smith 
1743704ba839SBarry Smith     Level: intermediate
1744704ba839SBarry Smith 
1745704ba839SBarry Smith .seealso: PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitSetBlockSize()
1746704ba839SBarry Smith 
1747704ba839SBarry Smith @*/
17487087cfbeSBarry Smith PetscErrorCode  PCFieldSplitSetIS(PC pc,const char splitname[],IS is)
1749704ba839SBarry Smith {
17504ac538c5SBarry Smith   PetscErrorCode ierr;
1751704ba839SBarry Smith 
1752704ba839SBarry Smith   PetscFunctionBegin;
17530700a824SBarry Smith   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
17547b62db95SJungho Lee   if (splitname) PetscValidCharPointer(splitname,2);
1755db4c96c1SJed Brown   PetscValidHeaderSpecific(is,IS_CLASSID,3);
1756*ccc738f7SBarry Smith   ierr = PetscTryMethod(pc,"PCFieldSplitSetIS_C",(PC,const char[],IS),(pc,splitname,is));CHKERRQ(ierr);
1757704ba839SBarry Smith   PetscFunctionReturn(0);
1758704ba839SBarry Smith }
1759704ba839SBarry Smith 
1760704ba839SBarry Smith #undef __FUNCT__
176157a9adfeSMatthew G Knepley #define __FUNCT__ "PCFieldSplitGetIS"
176257a9adfeSMatthew G Knepley /*@
176357a9adfeSMatthew G Knepley     PCFieldSplitGetIS - Retrieves the elements for a field as an IS
176457a9adfeSMatthew G Knepley 
176557a9adfeSMatthew G Knepley     Logically Collective on PC
176657a9adfeSMatthew G Knepley 
176757a9adfeSMatthew G Knepley     Input Parameters:
176857a9adfeSMatthew G Knepley +   pc  - the preconditioner context
176957a9adfeSMatthew G Knepley -   splitname - name of this split
177057a9adfeSMatthew G Knepley 
177157a9adfeSMatthew G Knepley     Output Parameter:
17720298fd71SBarry Smith -   is - the index set that defines the vector elements in this field, or NULL if the field is not found
177357a9adfeSMatthew G Knepley 
177457a9adfeSMatthew G Knepley     Level: intermediate
177557a9adfeSMatthew G Knepley 
177657a9adfeSMatthew G Knepley .seealso: PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitSetIS()
177757a9adfeSMatthew G Knepley 
177857a9adfeSMatthew G Knepley @*/
177957a9adfeSMatthew G Knepley PetscErrorCode PCFieldSplitGetIS(PC pc,const char splitname[],IS *is)
178057a9adfeSMatthew G Knepley {
178157a9adfeSMatthew G Knepley   PetscErrorCode ierr;
178257a9adfeSMatthew G Knepley 
178357a9adfeSMatthew G Knepley   PetscFunctionBegin;
178457a9adfeSMatthew G Knepley   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
178557a9adfeSMatthew G Knepley   PetscValidCharPointer(splitname,2);
178657a9adfeSMatthew G Knepley   PetscValidPointer(is,3);
178757a9adfeSMatthew G Knepley   {
178857a9adfeSMatthew G Knepley     PC_FieldSplit     *jac  = (PC_FieldSplit*) pc->data;
178957a9adfeSMatthew G Knepley     PC_FieldSplitLink ilink = jac->head;
179057a9adfeSMatthew G Knepley     PetscBool         found;
179157a9adfeSMatthew G Knepley 
17920298fd71SBarry Smith     *is = NULL;
179357a9adfeSMatthew G Knepley     while (ilink) {
179457a9adfeSMatthew G Knepley       ierr = PetscStrcmp(ilink->splitname, splitname, &found);CHKERRQ(ierr);
179557a9adfeSMatthew G Knepley       if (found) {
179657a9adfeSMatthew G Knepley         *is = ilink->is;
179757a9adfeSMatthew G Knepley         break;
179857a9adfeSMatthew G Knepley       }
179957a9adfeSMatthew G Knepley       ilink = ilink->next;
180057a9adfeSMatthew G Knepley     }
180157a9adfeSMatthew G Knepley   }
180257a9adfeSMatthew G Knepley   PetscFunctionReturn(0);
180357a9adfeSMatthew G Knepley }
180457a9adfeSMatthew G Knepley 
180557a9adfeSMatthew G Knepley #undef __FUNCT__
180651f519a2SBarry Smith #define __FUNCT__ "PCFieldSplitSetBlockSize"
180751f519a2SBarry Smith /*@
180851f519a2SBarry Smith     PCFieldSplitSetBlockSize - Sets the block size for defining where fields start in the
180951f519a2SBarry Smith       fieldsplit preconditioner. If not set the matrix block size is used.
181051f519a2SBarry Smith 
1811ad4df100SBarry Smith     Logically Collective on PC
181251f519a2SBarry Smith 
181351f519a2SBarry Smith     Input Parameters:
181451f519a2SBarry Smith +   pc  - the preconditioner context
181551f519a2SBarry Smith -   bs - the block size
181651f519a2SBarry Smith 
181751f519a2SBarry Smith     Level: intermediate
181851f519a2SBarry Smith 
181951f519a2SBarry Smith .seealso: PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitSetFields()
182051f519a2SBarry Smith 
182151f519a2SBarry Smith @*/
18227087cfbeSBarry Smith PetscErrorCode  PCFieldSplitSetBlockSize(PC pc,PetscInt bs)
182351f519a2SBarry Smith {
18244ac538c5SBarry Smith   PetscErrorCode ierr;
182551f519a2SBarry Smith 
182651f519a2SBarry Smith   PetscFunctionBegin;
18270700a824SBarry Smith   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
1828c5eb9154SBarry Smith   PetscValidLogicalCollectiveInt(pc,bs,2);
18294ac538c5SBarry Smith   ierr = PetscTryMethod(pc,"PCFieldSplitSetBlockSize_C",(PC,PetscInt),(pc,bs));CHKERRQ(ierr);
183051f519a2SBarry Smith   PetscFunctionReturn(0);
183151f519a2SBarry Smith }
183251f519a2SBarry Smith 
183351f519a2SBarry Smith #undef __FUNCT__
183469a612a9SBarry Smith #define __FUNCT__ "PCFieldSplitGetSubKSP"
18350971522cSBarry Smith /*@C
183669a612a9SBarry Smith    PCFieldSplitGetSubKSP - Gets the KSP contexts for all splits
18370971522cSBarry Smith 
183869a612a9SBarry Smith    Collective on KSP
18390971522cSBarry Smith 
18400971522cSBarry Smith    Input Parameter:
18410971522cSBarry Smith .  pc - the preconditioner context
18420971522cSBarry Smith 
18430971522cSBarry Smith    Output Parameters:
184413e0d083SBarry Smith +  n - the number of splits
184569a612a9SBarry Smith -  pc - the array of KSP contexts
18460971522cSBarry Smith 
18470971522cSBarry Smith    Note:
1848d32f9abdSBarry Smith    After PCFieldSplitGetSubKSP() the array of KSPs IS to be freed by the user
1849d32f9abdSBarry Smith    (not the KSP just the array that contains them).
18500971522cSBarry Smith 
185169a612a9SBarry Smith    You must call KSPSetUp() before calling PCFieldSplitGetSubKSP().
18520971522cSBarry Smith 
1853196cc216SBarry Smith    Fortran Usage: You must pass in a KSP array that is large enough to contain all the local KSPs.
18540298fd71SBarry Smith       You can call PCFieldSplitGetSubKSP(pc,n,NULL_OBJECT,ierr) to determine how large the
1855196cc216SBarry Smith       KSP array must be.
1856196cc216SBarry Smith 
1857196cc216SBarry Smith 
18580971522cSBarry Smith    Level: advanced
18590971522cSBarry Smith 
18600971522cSBarry Smith .seealso: PCFIELDSPLIT
18610971522cSBarry Smith @*/
18627087cfbeSBarry Smith PetscErrorCode  PCFieldSplitGetSubKSP(PC pc,PetscInt *n,KSP *subksp[])
18630971522cSBarry Smith {
18644ac538c5SBarry Smith   PetscErrorCode ierr;
18650971522cSBarry Smith 
18660971522cSBarry Smith   PetscFunctionBegin;
18670700a824SBarry Smith   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
186813e0d083SBarry Smith   if (n) PetscValidIntPointer(n,2);
18694ac538c5SBarry Smith   ierr = PetscUseMethod(pc,"PCFieldSplitGetSubKSP_C",(PC,PetscInt*,KSP **),(pc,n,subksp));CHKERRQ(ierr);
18700971522cSBarry Smith   PetscFunctionReturn(0);
18710971522cSBarry Smith }
18720971522cSBarry Smith 
1873e69d4d44SBarry Smith #undef __FUNCT__
187429f8a81cSJed Brown #define __FUNCT__ "PCFieldSplitSetSchurPre"
1875e69d4d44SBarry Smith /*@
187629f8a81cSJed Brown     PCFieldSplitSetSchurPre -  Indicates if the Schur complement is preconditioned by a preconditioner constructed by the
1877a04f6461SBarry Smith       A11 matrix. Otherwise no preconditioner is used.
1878e69d4d44SBarry Smith 
1879e69d4d44SBarry Smith     Collective on PC
1880e69d4d44SBarry Smith 
1881e69d4d44SBarry Smith     Input Parameters:
1882e69d4d44SBarry Smith +   pc      - the preconditioner context
1883a7476a74SDmitry 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
18840298fd71SBarry Smith -   userpre - matrix to use for preconditioning, or NULL
1885084e4875SJed Brown 
1886e69d4d44SBarry Smith     Options Database:
18872e71c61dSMatthew G. Knepley .     -pc_fieldsplit_schur_precondition <self,selfp,user,a11,full> default is a11
1888e69d4d44SBarry Smith 
1889fd1303e9SJungho Lee     Notes:
1890fd1303e9SJungho Lee $    If ptype is
1891a6a584a2SBarry Smith $        user then the preconditioner for the Schur complement is generated from the user provided matrix (pre argument
1892fd1303e9SJungho Lee $             to this function).
1893a6a584a2SBarry Smith $        a11 then the preconditioner for the Schur complement is generated from the block diagonal part of the preconditioner
1894585af1b9SMatthew G. Knepley $             matrix associated with the Schur complement (i.e. A11), not he Schur complement matrix
1895a6a584a2SBarry Smith $        full then the preconditioner for the Schur complement is generated from the exact Schur complement matrix representation computed internally by PFIELDSPLIT (this is expensive)
1896a6a584a2SBarry Smith $        self the preconditioner for the Schur complement is generated from the symbolic representation of the Schur complement matrix:
1897a6a584a2SBarry Smith $             The only preconditioner that currently works with this symbolic respresentation matrix object is the PCLSC
1898fd1303e9SJungho Lee $             preconditioner
1899a6a584a2SBarry Smith $        selfp then the preconditioning for the Schur complement is generated from an explicitly-assembled approximation Sp = A11 - A10 inv(diag(A00)) A01
19001d71051fSDmitry Karpeev $             This is only a good preconditioner when diag(A00) is a good preconditioner for A00. Optionally, A00 can be
1901a6a584a2SBarry Smith $             lumped before extracting the diagonal: -fieldsplit_1_mat_schur_complement_ainv_type lump
1902fd1303e9SJungho Lee 
1903e87fab1bSBarry Smith      When solving a saddle point problem, where the A11 block is identically zero, using a11 as the ptype only makes sense
1904fd1303e9SJungho Lee     with the additional option -fieldsplit_1_pc_type none. Usually for saddle point problems one would use a ptype of self and
1905a7476a74SDmitry Karpeev     -fieldsplit_1_pc_type lsc which uses the least squares commutator to compute a preconditioner for the Schur complement.
1906fd1303e9SJungho Lee 
1907e69d4d44SBarry Smith     Level: intermediate
1908e69d4d44SBarry Smith 
19091d71051fSDmitry Karpeev .seealso: PCFieldSplitGetSchurPre(), PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitSetFields(), PCFieldSplitSchurPreType,
19101d71051fSDmitry Karpeev           MatSchurComplementSetAinvType(), PCLSC
1911e69d4d44SBarry Smith 
1912e69d4d44SBarry Smith @*/
191329f8a81cSJed Brown PetscErrorCode PCFieldSplitSetSchurPre(PC pc,PCFieldSplitSchurPreType ptype,Mat pre)
1914e69d4d44SBarry Smith {
19154ac538c5SBarry Smith   PetscErrorCode ierr;
1916e69d4d44SBarry Smith 
1917e69d4d44SBarry Smith   PetscFunctionBegin;
19180700a824SBarry Smith   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
191929f8a81cSJed Brown   ierr = PetscTryMethod(pc,"PCFieldSplitSetSchurPre_C",(PC,PCFieldSplitSchurPreType,Mat),(pc,ptype,pre));CHKERRQ(ierr);
1920e69d4d44SBarry Smith   PetscFunctionReturn(0);
1921e69d4d44SBarry Smith }
192229f8a81cSJed Brown PetscErrorCode PCFieldSplitSchurPrecondition(PC pc,PCFieldSplitSchurPreType ptype,Mat pre) {return PCFieldSplitSetSchurPre(pc,ptype,pre);} /* Deprecated name */
1923e69d4d44SBarry Smith 
1924e69d4d44SBarry Smith #undef __FUNCT__
192537a82bf0SJed Brown #define __FUNCT__ "PCFieldSplitGetSchurPre"
192637a82bf0SJed Brown /*@
192737a82bf0SJed Brown     PCFieldSplitGetSchurPre - For Schur complement fieldsplit, determine how the Schur complement will be
192829f8a81cSJed Brown     preconditioned.  See PCFieldSplitSetSchurPre() for details.
192937a82bf0SJed Brown 
193037a82bf0SJed Brown     Logically Collective on PC
193137a82bf0SJed Brown 
193237a82bf0SJed Brown     Input Parameters:
193337a82bf0SJed Brown .   pc      - the preconditioner context
193437a82bf0SJed Brown 
193537a82bf0SJed Brown     Output Parameters:
193637a82bf0SJed 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
193737a82bf0SJed Brown -   userpre - matrix to use for preconditioning (with PC_FIELDSPLIT_PRE_USER), or NULL
193837a82bf0SJed Brown 
193937a82bf0SJed Brown     Level: intermediate
194037a82bf0SJed Brown 
194129f8a81cSJed Brown .seealso: PCFieldSplitSetSchurPre(), PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitSetFields(), PCFieldSplitSchurPreType, PCLSC
194237a82bf0SJed Brown 
194337a82bf0SJed Brown @*/
194437a82bf0SJed Brown PetscErrorCode PCFieldSplitGetSchurPre(PC pc,PCFieldSplitSchurPreType *ptype,Mat *pre)
194537a82bf0SJed Brown {
194637a82bf0SJed Brown   PetscErrorCode ierr;
194737a82bf0SJed Brown 
194837a82bf0SJed Brown   PetscFunctionBegin;
194937a82bf0SJed Brown   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
195037a82bf0SJed Brown   ierr = PetscUseMethod(pc,"PCFieldSplitGetSchurPre_C",(PC,PCFieldSplitSchurPreType*,Mat*),(pc,ptype,pre));CHKERRQ(ierr);
1951e69d4d44SBarry Smith   PetscFunctionReturn(0);
1952e69d4d44SBarry Smith }
1953e69d4d44SBarry Smith 
1954e69d4d44SBarry Smith #undef __FUNCT__
1955470b340bSDmitry Karpeev #define __FUNCT__ "PCFieldSplitSchurGetS"
195645e7fc46SDmitry Karpeev /*@
1957470b340bSDmitry Karpeev     PCFieldSplitSchurGetS -  extract the MatSchurComplement object used by this PC in case it needs to be configured separately
195845e7fc46SDmitry Karpeev 
195945e7fc46SDmitry Karpeev     Not collective
196045e7fc46SDmitry Karpeev 
196145e7fc46SDmitry Karpeev     Input Parameter:
196245e7fc46SDmitry Karpeev .   pc      - the preconditioner context
196345e7fc46SDmitry Karpeev 
196445e7fc46SDmitry Karpeev     Output Parameter:
1965470b340bSDmitry Karpeev .   S       - the Schur complement matrix
196645e7fc46SDmitry Karpeev 
1967470b340bSDmitry Karpeev     Notes:
1968470b340bSDmitry Karpeev     This matrix should not be destroyed using MatDestroy(); rather, use PCFieldSplitSchurRestoreS().
196945e7fc46SDmitry Karpeev 
197045e7fc46SDmitry Karpeev     Level: advanced
197145e7fc46SDmitry Karpeev 
197229f8a81cSJed Brown .seealso: PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitSchurPreType, PCFieldSplitSetSchurPre(), MatSchurComplement, PCFieldSplitSchurRestoreS()
197345e7fc46SDmitry Karpeev 
197445e7fc46SDmitry Karpeev @*/
1975470b340bSDmitry Karpeev PetscErrorCode  PCFieldSplitSchurGetS(PC pc,Mat *S)
197645e7fc46SDmitry Karpeev {
197745e7fc46SDmitry Karpeev   PetscErrorCode ierr;
197845e7fc46SDmitry Karpeev   const char*    t;
197945e7fc46SDmitry Karpeev   PetscBool      isfs;
198045e7fc46SDmitry Karpeev   PC_FieldSplit  *jac;
198145e7fc46SDmitry Karpeev 
198245e7fc46SDmitry Karpeev   PetscFunctionBegin;
198345e7fc46SDmitry Karpeev   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
198445e7fc46SDmitry Karpeev   ierr = PetscObjectGetType((PetscObject)pc,&t);CHKERRQ(ierr);
198545e7fc46SDmitry Karpeev   ierr = PetscStrcmp(t,PCFIELDSPLIT,&isfs);CHKERRQ(ierr);
198645e7fc46SDmitry Karpeev   if (!isfs) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Expected PC of type PCFIELDSPLIT, got %s instead",t);
198745e7fc46SDmitry Karpeev   jac = (PC_FieldSplit*)pc->data;
1988470b340bSDmitry 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);
1989470b340bSDmitry Karpeev   if (S) *S = jac->schur;
199045e7fc46SDmitry Karpeev   PetscFunctionReturn(0);
199145e7fc46SDmitry Karpeev }
199245e7fc46SDmitry Karpeev 
199345e7fc46SDmitry Karpeev #undef __FUNCT__
1994470b340bSDmitry Karpeev #define __FUNCT__ "PCFieldSplitSchurRestoreS"
1995470b340bSDmitry Karpeev /*@
1996470b340bSDmitry Karpeev     PCFieldSplitSchurRestoreS -  restores the MatSchurComplement object used by this PC
1997470b340bSDmitry Karpeev 
1998470b340bSDmitry Karpeev     Not collective
1999470b340bSDmitry Karpeev 
2000470b340bSDmitry Karpeev     Input Parameters:
2001470b340bSDmitry Karpeev +   pc      - the preconditioner context
2002470b340bSDmitry Karpeev .   S       - the Schur complement matrix
2003470b340bSDmitry Karpeev 
2004470b340bSDmitry Karpeev     Level: advanced
2005470b340bSDmitry Karpeev 
200629f8a81cSJed Brown .seealso: PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitSchurPreType, PCFieldSplitSetSchurPre(), MatSchurComplement, PCFieldSplitSchurGetS()
2007470b340bSDmitry Karpeev 
2008470b340bSDmitry Karpeev @*/
2009bca69d2bSDmitry Karpeev PetscErrorCode  PCFieldSplitSchurRestoreS(PC pc,Mat *S)
2010470b340bSDmitry Karpeev {
2011470b340bSDmitry Karpeev   PetscErrorCode ierr;
2012470b340bSDmitry Karpeev   const char*    t;
2013470b340bSDmitry Karpeev   PetscBool      isfs;
2014470b340bSDmitry Karpeev   PC_FieldSplit  *jac;
2015470b340bSDmitry Karpeev 
2016470b340bSDmitry Karpeev   PetscFunctionBegin;
2017470b340bSDmitry Karpeev   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
2018470b340bSDmitry Karpeev   ierr = PetscObjectGetType((PetscObject)pc,&t);CHKERRQ(ierr);
2019470b340bSDmitry Karpeev   ierr = PetscStrcmp(t,PCFIELDSPLIT,&isfs);CHKERRQ(ierr);
2020470b340bSDmitry Karpeev   if (!isfs) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Expected PC of type PCFIELDSPLIT, got %s instead",t);
2021470b340bSDmitry Karpeev   jac = (PC_FieldSplit*)pc->data;
2022470b340bSDmitry 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);
2023bca69d2bSDmitry Karpeev   if (!S || *S != jac->schur) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"MatSchurComplement restored is not the same as gotten");
2024470b340bSDmitry Karpeev   PetscFunctionReturn(0);
2025470b340bSDmitry Karpeev }
2026470b340bSDmitry Karpeev 
2027470b340bSDmitry Karpeev 
2028470b340bSDmitry Karpeev #undef __FUNCT__
202929f8a81cSJed Brown #define __FUNCT__ "PCFieldSplitSetSchurPre_FieldSplit"
203029f8a81cSJed Brown static PetscErrorCode  PCFieldSplitSetSchurPre_FieldSplit(PC pc,PCFieldSplitSchurPreType ptype,Mat pre)
2031e69d4d44SBarry Smith {
2032e69d4d44SBarry Smith   PC_FieldSplit  *jac = (PC_FieldSplit*)pc->data;
2033084e4875SJed Brown   PetscErrorCode ierr;
2034e69d4d44SBarry Smith 
2035e69d4d44SBarry Smith   PetscFunctionBegin;
2036084e4875SJed Brown   jac->schurpre = ptype;
2037a7476a74SDmitry Karpeev   if (ptype == PC_FIELDSPLIT_SCHUR_PRE_USER && pre) {
20386bf464f9SBarry Smith     ierr            = MatDestroy(&jac->schur_user);CHKERRQ(ierr);
2039084e4875SJed Brown     jac->schur_user = pre;
2040084e4875SJed Brown     ierr            = PetscObjectReference((PetscObject)jac->schur_user);CHKERRQ(ierr);
2041084e4875SJed Brown   }
2042e69d4d44SBarry Smith   PetscFunctionReturn(0);
2043e69d4d44SBarry Smith }
2044e69d4d44SBarry Smith 
204530ad9308SMatthew Knepley #undef __FUNCT__
204637a82bf0SJed Brown #define __FUNCT__ "PCFieldSplitGetSchurPre_FieldSplit"
204737a82bf0SJed Brown static PetscErrorCode  PCFieldSplitGetSchurPre_FieldSplit(PC pc,PCFieldSplitSchurPreType *ptype,Mat *pre)
204837a82bf0SJed Brown {
204937a82bf0SJed Brown   PC_FieldSplit  *jac = (PC_FieldSplit*)pc->data;
205037a82bf0SJed Brown 
205137a82bf0SJed Brown   PetscFunctionBegin;
205237a82bf0SJed Brown   *ptype = jac->schurpre;
205337a82bf0SJed Brown   *pre   = jac->schur_user;
205437a82bf0SJed Brown   PetscFunctionReturn(0);
205537a82bf0SJed Brown }
205637a82bf0SJed Brown 
205737a82bf0SJed Brown #undef __FUNCT__
2058c9c6ffaaSJed Brown #define __FUNCT__ "PCFieldSplitSetSchurFactType"
2059ab1df9f5SJed Brown /*@
2060c9c6ffaaSJed Brown     PCFieldSplitSetSchurFactType -  sets which blocks of the approximate block factorization to retain
2061ab1df9f5SJed Brown 
2062ab1df9f5SJed Brown     Collective on PC
2063ab1df9f5SJed Brown 
2064ab1df9f5SJed Brown     Input Parameters:
2065ab1df9f5SJed Brown +   pc  - the preconditioner context
2066c9c6ffaaSJed Brown -   ftype - which blocks of factorization to retain, PC_FIELDSPLIT_SCHUR_FACT_FULL is default
2067ab1df9f5SJed Brown 
2068ab1df9f5SJed Brown     Options Database:
2069c9c6ffaaSJed Brown .     -pc_fieldsplit_schur_fact_type <diag,lower,upper,full> default is full
2070ab1df9f5SJed Brown 
2071ab1df9f5SJed Brown 
2072ab1df9f5SJed Brown     Level: intermediate
2073ab1df9f5SJed Brown 
2074ab1df9f5SJed Brown     Notes:
2075ab1df9f5SJed Brown     The FULL factorization is
2076ab1df9f5SJed Brown 
2077ab1df9f5SJed Brown $   (A   B)  = (1       0) (A   0) (1  Ainv*B)
2078ab1df9f5SJed Brown $   (C   D)    (C*Ainv  1) (0   S) (0     1  )
2079ab1df9f5SJed Brown 
20806be4592eSBarry 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,
20816be4592eSBarry 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).
2082ab1df9f5SJed Brown 
20836be4592eSBarry 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
20846be4592eSBarry 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
20856be4592eSBarry 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,
20866be4592eSBarry 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.
2087ab1df9f5SJed Brown 
20886be4592eSBarry 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
20896be4592eSBarry 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).
2090ab1df9f5SJed Brown 
2091ab1df9f5SJed Brown     References:
209296a0c994SBarry Smith +   1. - Murphy, Golub, and Wathen, A note on preconditioning indefinite linear systems, SIAM J. Sci. Comput., 21 (2000).
209396a0c994SBarry Smith -   2. - Ipsen, A note on preconditioning nonsymmetric matrices, SIAM J. Sci. Comput., 23 (2001).
2094ab1df9f5SJed Brown 
2095ab1df9f5SJed Brown .seealso: PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitSetFields(), PCFieldSplitSchurPreType
2096ab1df9f5SJed Brown @*/
2097c9c6ffaaSJed Brown PetscErrorCode  PCFieldSplitSetSchurFactType(PC pc,PCFieldSplitSchurFactType ftype)
2098ab1df9f5SJed Brown {
2099ab1df9f5SJed Brown   PetscErrorCode ierr;
2100ab1df9f5SJed Brown 
2101ab1df9f5SJed Brown   PetscFunctionBegin;
2102ab1df9f5SJed Brown   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
2103c9c6ffaaSJed Brown   ierr = PetscTryMethod(pc,"PCFieldSplitSetSchurFactType_C",(PC,PCFieldSplitSchurFactType),(pc,ftype));CHKERRQ(ierr);
2104ab1df9f5SJed Brown   PetscFunctionReturn(0);
2105ab1df9f5SJed Brown }
2106ab1df9f5SJed Brown 
2107ab1df9f5SJed Brown #undef __FUNCT__
2108c9c6ffaaSJed Brown #define __FUNCT__ "PCFieldSplitSetSchurFactType_FieldSplit"
21091e6b0712SBarry Smith static PetscErrorCode PCFieldSplitSetSchurFactType_FieldSplit(PC pc,PCFieldSplitSchurFactType ftype)
2110ab1df9f5SJed Brown {
2111ab1df9f5SJed Brown   PC_FieldSplit *jac = (PC_FieldSplit*)pc->data;
2112ab1df9f5SJed Brown 
2113ab1df9f5SJed Brown   PetscFunctionBegin;
2114ab1df9f5SJed Brown   jac->schurfactorization = ftype;
2115ab1df9f5SJed Brown   PetscFunctionReturn(0);
2116ab1df9f5SJed Brown }
2117ab1df9f5SJed Brown 
2118ab1df9f5SJed Brown #undef __FUNCT__
211930ad9308SMatthew Knepley #define __FUNCT__ "PCFieldSplitGetSchurBlocks"
212030ad9308SMatthew Knepley /*@C
21218c03b21aSDmitry Karpeev    PCFieldSplitGetSchurBlocks - Gets all matrix blocks for the Schur complement
212230ad9308SMatthew Knepley 
212330ad9308SMatthew Knepley    Collective on KSP
212430ad9308SMatthew Knepley 
212530ad9308SMatthew Knepley    Input Parameter:
212630ad9308SMatthew Knepley .  pc - the preconditioner context
212730ad9308SMatthew Knepley 
212830ad9308SMatthew Knepley    Output Parameters:
2129a04f6461SBarry Smith +  A00 - the (0,0) block
2130a04f6461SBarry Smith .  A01 - the (0,1) block
2131a04f6461SBarry Smith .  A10 - the (1,0) block
2132a04f6461SBarry Smith -  A11 - the (1,1) block
213330ad9308SMatthew Knepley 
213430ad9308SMatthew Knepley    Level: advanced
213530ad9308SMatthew Knepley 
213630ad9308SMatthew Knepley .seealso: PCFIELDSPLIT
213730ad9308SMatthew Knepley @*/
2138a04f6461SBarry Smith PetscErrorCode  PCFieldSplitGetSchurBlocks(PC pc,Mat *A00,Mat *A01,Mat *A10, Mat *A11)
213930ad9308SMatthew Knepley {
214030ad9308SMatthew Knepley   PC_FieldSplit *jac = (PC_FieldSplit*) pc->data;
214130ad9308SMatthew Knepley 
214230ad9308SMatthew Knepley   PetscFunctionBegin;
21430700a824SBarry Smith   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
2144ce94432eSBarry Smith   if (jac->type != PC_COMPOSITE_SCHUR) SETERRQ(PetscObjectComm((PetscObject)pc),PETSC_ERR_ARG_WRONG, "FieldSplit is not using a Schur complement approach.");
2145a04f6461SBarry Smith   if (A00) *A00 = jac->pmat[0];
2146a04f6461SBarry Smith   if (A01) *A01 = jac->B;
2147a04f6461SBarry Smith   if (A10) *A10 = jac->C;
2148a04f6461SBarry Smith   if (A11) *A11 = jac->pmat[1];
214930ad9308SMatthew Knepley   PetscFunctionReturn(0);
215030ad9308SMatthew Knepley }
215130ad9308SMatthew Knepley 
215279416396SBarry Smith #undef __FUNCT__
215379416396SBarry Smith #define __FUNCT__ "PCFieldSplitSetType_FieldSplit"
21541e6b0712SBarry Smith static PetscErrorCode  PCFieldSplitSetType_FieldSplit(PC pc,PCCompositeType type)
215579416396SBarry Smith {
215679416396SBarry Smith   PC_FieldSplit  *jac = (PC_FieldSplit*)pc->data;
2157e69d4d44SBarry Smith   PetscErrorCode ierr;
215879416396SBarry Smith 
215979416396SBarry Smith   PetscFunctionBegin;
216079416396SBarry Smith   jac->type = type;
21613b224e63SBarry Smith   if (type == PC_COMPOSITE_SCHUR) {
21623b224e63SBarry Smith     pc->ops->apply = PCApply_FieldSplit_Schur;
21633b224e63SBarry Smith     pc->ops->view  = PCView_FieldSplit_Schur;
21642fa5cd67SKarl Rupp 
2165bdf89e91SBarry Smith     ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitGetSubKSP_C",PCFieldSplitGetSubKSP_FieldSplit_Schur);CHKERRQ(ierr);
216629f8a81cSJed Brown     ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetSchurPre_C",PCFieldSplitSetSchurPre_FieldSplit);CHKERRQ(ierr);
216737a82bf0SJed Brown     ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitGetSchurPre_C",PCFieldSplitGetSchurPre_FieldSplit);CHKERRQ(ierr);
2168bdf89e91SBarry Smith     ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetSchurFactType_C",PCFieldSplitSetSchurFactType_FieldSplit);CHKERRQ(ierr);
2169e69d4d44SBarry Smith 
21703b224e63SBarry Smith   } else {
21713b224e63SBarry Smith     pc->ops->apply = PCApply_FieldSplit;
21723b224e63SBarry Smith     pc->ops->view  = PCView_FieldSplit;
21732fa5cd67SKarl Rupp 
2174bdf89e91SBarry Smith     ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitGetSubKSP_C",PCFieldSplitGetSubKSP_FieldSplit);CHKERRQ(ierr);
217529f8a81cSJed Brown     ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetSchurPre_C",0);CHKERRQ(ierr);
217637a82bf0SJed Brown     ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitGetSchurPre_C",0);CHKERRQ(ierr);
2177bdf89e91SBarry Smith     ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetSchurFactType_C",0);CHKERRQ(ierr);
21783b224e63SBarry Smith   }
217979416396SBarry Smith   PetscFunctionReturn(0);
218079416396SBarry Smith }
218179416396SBarry Smith 
218251f519a2SBarry Smith #undef __FUNCT__
218351f519a2SBarry Smith #define __FUNCT__ "PCFieldSplitSetBlockSize_FieldSplit"
21841e6b0712SBarry Smith static PetscErrorCode  PCFieldSplitSetBlockSize_FieldSplit(PC pc,PetscInt bs)
218551f519a2SBarry Smith {
218651f519a2SBarry Smith   PC_FieldSplit *jac = (PC_FieldSplit*)pc->data;
218751f519a2SBarry Smith 
218851f519a2SBarry Smith   PetscFunctionBegin;
2189ce94432eSBarry Smith   if (bs < 1) SETERRQ1(PetscObjectComm((PetscObject)pc),PETSC_ERR_ARG_OUTOFRANGE,"Blocksize must be positive, you gave %D",bs);
2190ce94432eSBarry 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);
219151f519a2SBarry Smith   jac->bs = bs;
219251f519a2SBarry Smith   PetscFunctionReturn(0);
219351f519a2SBarry Smith }
219451f519a2SBarry Smith 
219579416396SBarry Smith #undef __FUNCT__
219679416396SBarry Smith #define __FUNCT__ "PCFieldSplitSetType"
2197bc08b0f1SBarry Smith /*@
219879416396SBarry Smith    PCFieldSplitSetType - Sets the type of fieldsplit preconditioner.
219979416396SBarry Smith 
220079416396SBarry Smith    Collective on PC
220179416396SBarry Smith 
220279416396SBarry Smith    Input Parameter:
220379416396SBarry Smith .  pc - the preconditioner context
220481540f2fSBarry Smith .  type - PC_COMPOSITE_ADDITIVE, PC_COMPOSITE_MULTIPLICATIVE (default), PC_COMPOSITE_SYMMETRIC_MULTIPLICATIVE, PC_COMPOSITE_SPECIAL, PC_COMPOSITE_SCHUR
220579416396SBarry Smith 
220679416396SBarry Smith    Options Database Key:
2207a4efd8eaSMatthew Knepley .  -pc_fieldsplit_type <type: one of multiplicative, additive, symmetric_multiplicative, special, schur> - Sets fieldsplit preconditioner type
220879416396SBarry Smith 
2209b02e2d75SMatthew G Knepley    Level: Intermediate
221079416396SBarry Smith 
221179416396SBarry Smith .keywords: PC, set, type, composite preconditioner, additive, multiplicative
221279416396SBarry Smith 
221379416396SBarry Smith .seealso: PCCompositeSetType()
221479416396SBarry Smith 
221579416396SBarry Smith @*/
22167087cfbeSBarry Smith PetscErrorCode  PCFieldSplitSetType(PC pc,PCCompositeType type)
221779416396SBarry Smith {
22184ac538c5SBarry Smith   PetscErrorCode ierr;
221979416396SBarry Smith 
222079416396SBarry Smith   PetscFunctionBegin;
22210700a824SBarry Smith   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
22224ac538c5SBarry Smith   ierr = PetscTryMethod(pc,"PCFieldSplitSetType_C",(PC,PCCompositeType),(pc,type));CHKERRQ(ierr);
222379416396SBarry Smith   PetscFunctionReturn(0);
222479416396SBarry Smith }
222579416396SBarry Smith 
2226b02e2d75SMatthew G Knepley #undef __FUNCT__
2227b02e2d75SMatthew G Knepley #define __FUNCT__ "PCFieldSplitGetType"
2228b02e2d75SMatthew G Knepley /*@
2229b02e2d75SMatthew G Knepley   PCFieldSplitGetType - Gets the type of fieldsplit preconditioner.
2230b02e2d75SMatthew G Knepley 
2231b02e2d75SMatthew G Knepley   Not collective
2232b02e2d75SMatthew G Knepley 
2233b02e2d75SMatthew G Knepley   Input Parameter:
2234b02e2d75SMatthew G Knepley . pc - the preconditioner context
2235b02e2d75SMatthew G Knepley 
2236b02e2d75SMatthew G Knepley   Output Parameter:
2237b02e2d75SMatthew G Knepley . type - PC_COMPOSITE_ADDITIVE, PC_COMPOSITE_MULTIPLICATIVE (default), PC_COMPOSITE_SYMMETRIC_MULTIPLICATIVE, PC_COMPOSITE_SPECIAL, PC_COMPOSITE_SCHUR
2238b02e2d75SMatthew G Knepley 
2239b02e2d75SMatthew G Knepley   Level: Intermediate
2240b02e2d75SMatthew G Knepley 
2241b02e2d75SMatthew G Knepley .keywords: PC, set, type, composite preconditioner, additive, multiplicative
2242b02e2d75SMatthew G Knepley .seealso: PCCompositeSetType()
2243b02e2d75SMatthew G Knepley @*/
2244b02e2d75SMatthew G Knepley PetscErrorCode PCFieldSplitGetType(PC pc, PCCompositeType *type)
2245b02e2d75SMatthew G Knepley {
2246b02e2d75SMatthew G Knepley   PC_FieldSplit *jac = (PC_FieldSplit*) pc->data;
2247b02e2d75SMatthew G Knepley 
2248b02e2d75SMatthew G Knepley   PetscFunctionBegin;
2249b02e2d75SMatthew G Knepley   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
2250b02e2d75SMatthew G Knepley   PetscValidIntPointer(type,2);
2251b02e2d75SMatthew G Knepley   *type = jac->type;
2252b02e2d75SMatthew G Knepley   PetscFunctionReturn(0);
2253b02e2d75SMatthew G Knepley }
2254b02e2d75SMatthew G Knepley 
22554ab8060aSDmitry Karpeev #undef __FUNCT__
22564ab8060aSDmitry Karpeev #define __FUNCT__ "PCFieldSplitSetDMSplits"
22574ab8060aSDmitry Karpeev /*@
22584ab8060aSDmitry Karpeev    PCFieldSplitSetDMSplits - Flags whether DMCreateFieldDecomposition() should be used to define the splits, whenever possible.
22594ab8060aSDmitry Karpeev 
22604ab8060aSDmitry Karpeev    Logically Collective
22614ab8060aSDmitry Karpeev 
22624ab8060aSDmitry Karpeev    Input Parameters:
22634ab8060aSDmitry Karpeev +  pc   - the preconditioner context
22644ab8060aSDmitry Karpeev -  flg  - boolean indicating whether to use field splits defined by the DM
22654ab8060aSDmitry Karpeev 
22664ab8060aSDmitry Karpeev    Options Database Key:
22674ab8060aSDmitry Karpeev .  -pc_fieldsplit_dm_splits
22684ab8060aSDmitry Karpeev 
22694ab8060aSDmitry Karpeev    Level: Intermediate
22704ab8060aSDmitry Karpeev 
22714ab8060aSDmitry Karpeev .keywords: PC, DM, composite preconditioner, additive, multiplicative
22724ab8060aSDmitry Karpeev 
22734ab8060aSDmitry Karpeev .seealso: PCFieldSplitGetDMSplits()
22744ab8060aSDmitry Karpeev 
22754ab8060aSDmitry Karpeev @*/
22764ab8060aSDmitry Karpeev PetscErrorCode  PCFieldSplitSetDMSplits(PC pc,PetscBool flg)
22774ab8060aSDmitry Karpeev {
22784ab8060aSDmitry Karpeev   PC_FieldSplit  *jac = (PC_FieldSplit*)pc->data;
22794ab8060aSDmitry Karpeev   PetscBool      isfs;
22804ab8060aSDmitry Karpeev   PetscErrorCode ierr;
22814ab8060aSDmitry Karpeev 
22824ab8060aSDmitry Karpeev   PetscFunctionBegin;
22834ab8060aSDmitry Karpeev   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
22844ab8060aSDmitry Karpeev   PetscValidLogicalCollectiveBool(pc,flg,2);
22854ab8060aSDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)pc,PCFIELDSPLIT,&isfs);CHKERRQ(ierr);
22864ab8060aSDmitry Karpeev   if (isfs) {
22874ab8060aSDmitry Karpeev     jac->dm_splits = flg;
22884ab8060aSDmitry Karpeev   }
22894ab8060aSDmitry Karpeev   PetscFunctionReturn(0);
22904ab8060aSDmitry Karpeev }
22914ab8060aSDmitry Karpeev 
22924ab8060aSDmitry Karpeev 
22934ab8060aSDmitry Karpeev #undef __FUNCT__
22944ab8060aSDmitry Karpeev #define __FUNCT__ "PCFieldSplitGetDMSplits"
22954ab8060aSDmitry Karpeev /*@
22964ab8060aSDmitry Karpeev    PCFieldSplitGetDMSplits - Returns flag indicating whether DMCreateFieldDecomposition() should be used to define the splits, whenever possible.
22974ab8060aSDmitry Karpeev 
22984ab8060aSDmitry Karpeev    Logically Collective
22994ab8060aSDmitry Karpeev 
23004ab8060aSDmitry Karpeev    Input Parameter:
23014ab8060aSDmitry Karpeev .  pc   - the preconditioner context
23024ab8060aSDmitry Karpeev 
23034ab8060aSDmitry Karpeev    Output Parameter:
23044ab8060aSDmitry Karpeev .  flg  - boolean indicating whether to use field splits defined by the DM
23054ab8060aSDmitry Karpeev 
23064ab8060aSDmitry Karpeev    Level: Intermediate
23074ab8060aSDmitry Karpeev 
23084ab8060aSDmitry Karpeev .keywords: PC, DM, composite preconditioner, additive, multiplicative
23094ab8060aSDmitry Karpeev 
23104ab8060aSDmitry Karpeev .seealso: PCFieldSplitSetDMSplits()
23114ab8060aSDmitry Karpeev 
23124ab8060aSDmitry Karpeev @*/
23134ab8060aSDmitry Karpeev PetscErrorCode  PCFieldSplitGetDMSplits(PC pc,PetscBool* flg)
23144ab8060aSDmitry Karpeev {
23154ab8060aSDmitry Karpeev   PC_FieldSplit  *jac = (PC_FieldSplit*)pc->data;
23164ab8060aSDmitry Karpeev   PetscBool      isfs;
23174ab8060aSDmitry Karpeev   PetscErrorCode ierr;
23184ab8060aSDmitry Karpeev 
23194ab8060aSDmitry Karpeev   PetscFunctionBegin;
23204ab8060aSDmitry Karpeev   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
23214ab8060aSDmitry Karpeev   PetscValidPointer(flg,2);
23224ab8060aSDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)pc,PCFIELDSPLIT,&isfs);CHKERRQ(ierr);
23234ab8060aSDmitry Karpeev   if (isfs) {
23244ab8060aSDmitry Karpeev     if(flg) *flg = jac->dm_splits;
23254ab8060aSDmitry Karpeev   }
23264ab8060aSDmitry Karpeev   PetscFunctionReturn(0);
23274ab8060aSDmitry Karpeev }
23284ab8060aSDmitry Karpeev 
23290971522cSBarry Smith /* -------------------------------------------------------------------------------------*/
23300971522cSBarry Smith /*MC
2331a8c7a070SBarry Smith    PCFIELDSPLIT - Preconditioner created by combining separate preconditioners for individual
2332a04f6461SBarry Smith                   fields or groups of fields. See the users manual section "Solving Block Matrices" for more details.
23330971522cSBarry Smith 
2334edf189efSBarry Smith      To set options on the solvers for each block append -fieldsplit_ to all the PC
2335edf189efSBarry Smith         options database keys. For example, -fieldsplit_pc_type ilu -fieldsplit_pc_factor_levels 1
23360971522cSBarry Smith 
2337a8c7a070SBarry Smith      To set the options on the solvers separate for each block call PCFieldSplitGetSubKSP()
233869a612a9SBarry Smith          and set the options directly on the resulting KSP object
23390971522cSBarry Smith 
23400971522cSBarry Smith    Level: intermediate
23410971522cSBarry Smith 
234279416396SBarry Smith    Options Database Keys:
234381540f2fSBarry Smith +   -pc_fieldsplit_%d_fields <a,b,..> - indicates the fields to be used in the %d'th split
234481540f2fSBarry Smith .   -pc_fieldsplit_default - automatically add any fields to additional splits that have not
234581540f2fSBarry Smith                               been supplied explicitly by -pc_fieldsplit_%d_fields
234681540f2fSBarry Smith .   -pc_fieldsplit_block_size <bs> - size of block that defines fields (i.e. there are bs fields)
23470f188ba9SJed Brown .   -pc_fieldsplit_type <additive,multiplicative,symmetric_multiplicative,schur> - type of relaxation or factorization splitting
2348a6a584a2SBarry Smith .   -pc_fieldsplit_schur_precondition <self,selfp,user,a11,full> - default is a11; see PCFieldSplitSetSchurPre()
2349435f959eSBarry Smith .   -pc_fieldsplit_detect_saddle_point - automatically finds rows with zero or negative diagonal and uses Schur complement with no preconditioner as the solver
235079416396SBarry Smith 
23515d4c12cdSJungho Lee -    Options prefix for inner solvers when using Schur complement preconditioner are -fieldsplit_0_ and -fieldsplit_1_
23525d4c12cdSJungho Lee      for all other solvers they are -fieldsplit_%d_ for the dth field, use -fieldsplit_ for all fields
23535d4c12cdSJungho Lee 
2354c8a0d604SMatthew G Knepley    Notes:
2355c8a0d604SMatthew G Knepley     Use PCFieldSplitSetFields() to set fields defined by "strided" entries and PCFieldSplitSetIS()
2356d32f9abdSBarry Smith      to define a field by an arbitrary collection of entries.
2357d32f9abdSBarry Smith 
2358d32f9abdSBarry Smith       If no fields are set the default is used. The fields are defined by entries strided by bs,
2359d32f9abdSBarry Smith       beginning at 0 then 1, etc to bs-1. The block size can be set with PCFieldSplitSetBlockSize(),
2360d32f9abdSBarry Smith       if this is not called the block size defaults to the blocksize of the second matrix passed
2361d32f9abdSBarry Smith       to KSPSetOperators()/PCSetOperators().
2362d32f9abdSBarry Smith 
2363c8a0d604SMatthew G Knepley $     For the Schur complement preconditioner if J = ( A00 A01 )
2364c8a0d604SMatthew G Knepley $                                                    ( A10 A11 )
2365c8a0d604SMatthew G Knepley $     the preconditioner using full factorization is
236613b05affSJed Brown $              ( I   -ksp(A00) A01 ) ( inv(A00)     0  ) (     I          0  )
2367c8a0d604SMatthew G Knepley $              ( 0         I       ) (   0      ksp(S) ) ( -A10 ksp(A00)  I  )
236813b05affSJed Brown      where the action of inv(A00) is applied using the KSP solver with prefix -fieldsplit_0_.  S is the Schur complement
236913b05affSJed Brown $              S = A11 - A10 ksp(A00) A01
237013b05affSJed 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
2371c8a0d604SMatthew G Knepley      in providing the SECOND split or 1 if not give). For PCFieldSplitGetKSP() when field number is 0,
2372c8a0d604SMatthew G Knepley      it returns the KSP associated with -fieldsplit_0_ while field number 1 gives -fieldsplit_1_ KSP. By default
2373a6a584a2SBarry Smith      A11 is used to construct a preconditioner for S, use PCFieldSplitSetSchurPre() for all the possible ways to construct the preconditioner for S.
23741d71051fSDmitry Karpeev 
2375a7476a74SDmitry Karpeev      The factorization type is set using -pc_fieldsplit_schur_fact_type <diag, lower, upper, full>. The full is shown above,
23765668aaf4SBarry Smith      diag gives
2377c8a0d604SMatthew G Knepley $              ( inv(A00)     0   )
2378c8a0d604SMatthew G Knepley $              (   0      -ksp(S) )
23795668aaf4SBarry 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
2380c8a0d604SMatthew G Knepley $              (  A00   0 )
2381c8a0d604SMatthew G Knepley $              (  A10   S )
2382c8a0d604SMatthew G Knepley      where the inverses of A00 and S are applied using KSPs. The upper factorization is the inverse of
2383c8a0d604SMatthew G Knepley $              ( A00 A01 )
2384c8a0d604SMatthew G Knepley $              (  0   S  )
2385c8a0d604SMatthew G Knepley      where again the inverses of A00 and S are applied using KSPs.
2386e69d4d44SBarry Smith 
2387edf189efSBarry Smith      If only one set of indices (one IS) is provided with PCFieldSplitSetIS() then the complement of that IS
2388edf189efSBarry Smith      is used automatically for a second block.
2389edf189efSBarry Smith 
2390ff218e97SBarry Smith      The fieldsplit preconditioner cannot currently be used with the BAIJ or SBAIJ data formats if the blocksize is larger than 1.
2391ff218e97SBarry Smith      Generally it should be used with the AIJ format.
2392ff218e97SBarry Smith 
2393ff218e97SBarry Smith      The forms of these preconditioners are closely related if not identical to forms derived as "Distributive Iterations", see,
2394ff218e97SBarry Smith      for example, page 294 in "Principles of Computational Fluid Dynamics" by Pieter Wesseling. Note that one can also use PCFIELDSPLIT
2395ff218e97SBarry Smith      inside a smoother resulting in "Distributive Smoothers".
23960716a85fSBarry Smith 
2397a541d17aSBarry Smith    Concepts: physics based preconditioners, block preconditioners
23980971522cSBarry Smith 
23993bc631e0SBarry Smith    There is a nice discussion of block preconditioners in
24003bc631e0SBarry Smith 
24013bc631e0SBarry Smith [El08] A taxonomy and comparison of parallel block multi-level preconditioners for the incompressible Navier-Stokes equations
24023bc631e0SBarry Smith        Howard Elman, V.E. Howle, John Shadid, Robert Shuttleworth, Ray Tuminaro, Journal of Computational Physics 227 (2008) 1790--1808
24033bc631e0SBarry Smith        http://chess.cs.umd.edu/~elman/papers/tax.pdf
24043bc631e0SBarry Smith 
2405a6a584a2SBarry Smith    The Constrained Pressure Preconditioner (CPR) does not appear to be currently implementable directly with PCFIELDSPLIT. CPR solves first the Schur complemented pressure equation, updates the
2406a6a584a2SBarry Smith    residual on all variables and then applies a simple ILU like preconditioner on all the variables. So it is very much like the full Schur complement with selfp representing the Schur complement but instead
2407a6a584a2SBarry Smith    of backsolving for the saturations in the last step it solves a full coupled (ILU) system for updates to all the variables.
2408a6a584a2SBarry Smith 
24097e8cb189SBarry Smith .seealso:  PCCreate(), PCSetType(), PCType (for list of available types), PC, Block_Preconditioners, PCLSC,
24101d71051fSDmitry Karpeev            PCFieldSplitGetSubKSP(), PCFieldSplitSetFields(), PCFieldSplitSetType(), PCFieldSplitSetIS(), PCFieldSplitSetSchurPre(),
24111d71051fSDmitry Karpeev 	   MatSchurComplementSetAinvType()
24120971522cSBarry Smith M*/
24130971522cSBarry Smith 
24140971522cSBarry Smith #undef __FUNCT__
24150971522cSBarry Smith #define __FUNCT__ "PCCreate_FieldSplit"
24168cc058d9SJed Brown PETSC_EXTERN PetscErrorCode PCCreate_FieldSplit(PC pc)
24170971522cSBarry Smith {
24180971522cSBarry Smith   PetscErrorCode ierr;
24190971522cSBarry Smith   PC_FieldSplit  *jac;
24200971522cSBarry Smith 
24210971522cSBarry Smith   PetscFunctionBegin;
2422b00a9115SJed Brown   ierr = PetscNewLog(pc,&jac);CHKERRQ(ierr);
24232fa5cd67SKarl Rupp 
24240971522cSBarry Smith   jac->bs                 = -1;
24250971522cSBarry Smith   jac->nsplits            = 0;
24263e197d65SBarry Smith   jac->type               = PC_COMPOSITE_MULTIPLICATIVE;
2427e6cab6aaSJed Brown   jac->schurpre           = PC_FIELDSPLIT_SCHUR_PRE_USER; /* Try user preconditioner first, fall back on diagonal */
2428c9c6ffaaSJed Brown   jac->schurfactorization = PC_FIELDSPLIT_SCHUR_FACT_FULL;
2429fbe7908bSJed Brown   jac->dm_splits          = PETSC_TRUE;
243051f519a2SBarry Smith 
24310971522cSBarry Smith   pc->data = (void*)jac;
24320971522cSBarry Smith 
24330971522cSBarry Smith   pc->ops->apply           = PCApply_FieldSplit;
2434421e10b8SBarry Smith   pc->ops->applytranspose  = PCApplyTranspose_FieldSplit;
24350971522cSBarry Smith   pc->ops->setup           = PCSetUp_FieldSplit;
2436574deadeSBarry Smith   pc->ops->reset           = PCReset_FieldSplit;
24370971522cSBarry Smith   pc->ops->destroy         = PCDestroy_FieldSplit;
24380971522cSBarry Smith   pc->ops->setfromoptions  = PCSetFromOptions_FieldSplit;
24390971522cSBarry Smith   pc->ops->view            = PCView_FieldSplit;
24400971522cSBarry Smith   pc->ops->applyrichardson = 0;
24410971522cSBarry Smith 
2442bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitGetSubKSP_C",PCFieldSplitGetSubKSP_FieldSplit);CHKERRQ(ierr);
2443bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetFields_C",PCFieldSplitSetFields_FieldSplit);CHKERRQ(ierr);
2444bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetIS_C",PCFieldSplitSetIS_FieldSplit);CHKERRQ(ierr);
2445bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetType_C",PCFieldSplitSetType_FieldSplit);CHKERRQ(ierr);
2446bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetBlockSize_C",PCFieldSplitSetBlockSize_FieldSplit);CHKERRQ(ierr);
24476dbb499eSCian Wilson   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitRestrictIS_C",PCFieldSplitRestrictIS_FieldSplit);CHKERRQ(ierr);
24480971522cSBarry Smith   PetscFunctionReturn(0);
24490971522cSBarry Smith }
24500971522cSBarry Smith 
24510971522cSBarry Smith 
2452a541d17aSBarry Smith 
2453