xref: /petsc/src/ksp/pc/impls/fieldsplit/fieldsplit.c (revision e52d2c62b911f45b6dbda30e9b6af029f19046ae)
1dba47a55SKris Buschelman 
2b45d2f2cSJed Brown #include <petsc-private/pcimpl.h>     /*I "petscpc.h" I*/
31e25c274SJed Brown #include <petscdm.h>
40971522cSBarry Smith 
5443836d0SMatthew G Knepley /*
6443836d0SMatthew G Knepley   There is a nice discussion of block preconditioners in
7443836d0SMatthew G Knepley 
81997fe2eSSatish Balay [El08] A taxonomy and comparison of parallel block multi-level preconditioners for the incompressible Navier-Stokes equations
9443836d0SMatthew G Knepley        Howard Elman, V.E. Howle, John Shadid, Robert Shuttleworth, Ray Tuminaro, Journal of Computational Physics 227 (2008) 1790--1808
101b8e4c5fSJed Brown        http://chess.cs.umd.edu/~elman/papers/tax.pdf
11443836d0SMatthew G Knepley */
12443836d0SMatthew G Knepley 
132e71c61dSMatthew G. Knepley const char *const PCFieldSplitSchurPreTypes[] = {"SELF","SELFP","A11","USER","FULL","PCFieldSplitSchurPreType","PC_FIELDSPLIT_SCHUR_PRE_",0};
14c9c6ffaaSJed Brown const char *const PCFieldSplitSchurFactTypes[] = {"DIAG","LOWER","UPPER","FULL","PCFieldSplitSchurFactType","PC_FIELDSPLIT_SCHUR_FACT_",0};
15c5d2311dSJed Brown 
160971522cSBarry Smith typedef struct _PC_FieldSplitLink *PC_FieldSplitLink;
170971522cSBarry Smith struct _PC_FieldSplitLink {
1869a612a9SBarry Smith   KSP               ksp;
19443836d0SMatthew G Knepley   Vec               x,y,z;
20db4c96c1SJed Brown   char              *splitname;
210971522cSBarry Smith   PetscInt          nfields;
225d4c12cdSJungho Lee   PetscInt          *fields,*fields_col;
231b9fc7fcSBarry Smith   VecScatter        sctx;
245d4c12cdSJungho Lee   IS                is,is_col;
2551f519a2SBarry Smith   PC_FieldSplitLink next,previous;
260971522cSBarry Smith };
270971522cSBarry Smith 
280971522cSBarry Smith typedef struct {
2968dd23aaSBarry Smith   PCCompositeType type;
30ace3abfcSBarry Smith   PetscBool       defaultsplit;                    /* Flag for a system with a set of 'k' scalar fields with the same layout (and bs = k) */
31ace3abfcSBarry Smith   PetscBool       splitdefined;                    /* Flag is set after the splits have been defined, to prevent more splits from being added */
3230ad9308SMatthew Knepley   PetscInt        bs;                              /* Block size for IS and Mat structures */
3330ad9308SMatthew Knepley   PetscInt        nsplits;                         /* Number of field divisions defined */
3479416396SBarry Smith   Vec             *x,*y,w1,w2;
35519d70e2SJed Brown   Mat             *mat;                            /* The diagonal block for each split */
36519d70e2SJed Brown   Mat             *pmat;                           /* The preconditioning diagonal block for each split */
3730ad9308SMatthew Knepley   Mat             *Afield;                         /* The rows of the matrix associated with each split */
38ace3abfcSBarry Smith   PetscBool       issetup;
392fa5cd67SKarl Rupp 
4030ad9308SMatthew Knepley   /* Only used when Schur complement preconditioning is used */
4130ad9308SMatthew Knepley   Mat                       B;                     /* The (0,1) block */
4230ad9308SMatthew Knepley   Mat                       C;                     /* The (1,0) block */
43443836d0SMatthew G Knepley   Mat                       schur;                 /* The Schur complement S = A11 - A10 A00^{-1} A01, the KSP here, kspinner, is H_1 in [El08] */
44a7476a74SDmitry Karpeev   Mat                       schurp;                /* Assembled approximation to S built by MatSchurComplement to be used as a preconditioning matrix when solving with S */
45084e4875SJed Brown   Mat                       schur_user;            /* User-provided preconditioning matrix for the Schur complement */
46084e4875SJed Brown   PCFieldSplitSchurPreType  schurpre;              /* Determines which preconditioning matrix is used for the Schur complement */
47c9c6ffaaSJed Brown   PCFieldSplitSchurFactType schurfactorization;
4830ad9308SMatthew Knepley   KSP                       kspschur;              /* The solver for S */
49443836d0SMatthew G Knepley   KSP                       kspupper;              /* The solver for A in the upper diagonal part of the factorization (H_2 in [El08]) */
5097bbdb24SBarry Smith   PC_FieldSplitLink         head;
5163ec74ffSBarry Smith   PetscBool                 reset;                  /* indicates PCReset() has been last called on this object, hack */
52c1570756SJed Brown   PetscBool                 suboptionsset;          /* Indicates that the KSPSetFromOptions() has been called on the sub-KSPs */
534ab8060aSDmitry Karpeev   PetscBool                 dm_splits;              /* Whether to use DMCreateFieldDecomposition() whenever possible */
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     }
10169a612a9SBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"  Solver info for each split is in the following KSP objects:\n");CHKERRQ(ierr);
1020971522cSBarry Smith     ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
1030971522cSBarry Smith     for (i=0; i<jac->nsplits; i++) {
1041ab39975SBarry Smith       if (ilink->fields) {
1050971522cSBarry Smith         ierr = PetscViewerASCIIPrintf(viewer,"Split number %D Fields ",i);CHKERRQ(ierr);
10679416396SBarry Smith         ierr = PetscViewerASCIIUseTabs(viewer,PETSC_FALSE);CHKERRQ(ierr);
1075a9f2f41SSatish Balay         for (j=0; j<ilink->nfields; j++) {
10879416396SBarry Smith           if (j > 0) {
10979416396SBarry Smith             ierr = PetscViewerASCIIPrintf(viewer,",");CHKERRQ(ierr);
11079416396SBarry Smith           }
1115a9f2f41SSatish Balay           ierr = PetscViewerASCIIPrintf(viewer," %D",ilink->fields[j]);CHKERRQ(ierr);
1120971522cSBarry Smith         }
1130971522cSBarry Smith         ierr = PetscViewerASCIIPrintf(viewer,"\n");CHKERRQ(ierr);
11479416396SBarry Smith         ierr = PetscViewerASCIIUseTabs(viewer,PETSC_TRUE);CHKERRQ(ierr);
1151ab39975SBarry Smith       } else {
1161ab39975SBarry Smith         ierr = PetscViewerASCIIPrintf(viewer,"Split number %D Defined by IS\n",i);CHKERRQ(ierr);
1171ab39975SBarry Smith       }
1185a9f2f41SSatish Balay       ierr  = KSPView(ilink->ksp,viewer);CHKERRQ(ierr);
1195a9f2f41SSatish Balay       ilink = ilink->next;
1200971522cSBarry Smith     }
1210971522cSBarry Smith     ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
1222fa5cd67SKarl Rupp   }
1232fa5cd67SKarl Rupp 
1242fa5cd67SKarl Rupp  if (isdraw) {
125d9884438SBarry Smith     PetscDraw draw;
126d9884438SBarry Smith     PetscReal x,y,w,wd;
127d9884438SBarry Smith 
128d9884438SBarry Smith     ierr = PetscViewerDrawGetDraw(viewer,0,&draw);CHKERRQ(ierr);
129d9884438SBarry Smith     ierr = PetscDrawGetCurrentPoint(draw,&x,&y);CHKERRQ(ierr);
130d9884438SBarry Smith     w    = 2*PetscMin(1.0 - x,x);
131d9884438SBarry Smith     wd   = w/(jac->nsplits + 1);
132d9884438SBarry Smith     x    = x - wd*(jac->nsplits-1)/2.0;
133d9884438SBarry Smith     for (i=0; i<jac->nsplits; i++) {
134d9884438SBarry Smith       ierr  = PetscDrawPushCurrentPoint(draw,x,y);CHKERRQ(ierr);
135d9884438SBarry Smith       ierr  = KSPView(ilink->ksp,viewer);CHKERRQ(ierr);
136d9884438SBarry Smith       ierr  = PetscDrawPopCurrentPoint(draw);CHKERRQ(ierr);
137d9884438SBarry Smith       x    += wd;
138d9884438SBarry Smith       ilink = ilink->next;
139d9884438SBarry Smith     }
1400971522cSBarry Smith   }
1410971522cSBarry Smith   PetscFunctionReturn(0);
1420971522cSBarry Smith }
1430971522cSBarry Smith 
1440971522cSBarry Smith #undef __FUNCT__
1453b224e63SBarry Smith #define __FUNCT__ "PCView_FieldSplit_Schur"
1463b224e63SBarry Smith static PetscErrorCode PCView_FieldSplit_Schur(PC pc,PetscViewer viewer)
1473b224e63SBarry Smith {
1483b224e63SBarry Smith   PC_FieldSplit     *jac = (PC_FieldSplit*)pc->data;
1493b224e63SBarry Smith   PetscErrorCode    ierr;
1504996c5bdSBarry Smith   PetscBool         iascii,isdraw;
1513b224e63SBarry Smith   PetscInt          i,j;
1523b224e63SBarry Smith   PC_FieldSplitLink ilink = jac->head;
1533b224e63SBarry Smith 
1543b224e63SBarry Smith   PetscFunctionBegin;
155251f4c67SDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&iascii);CHKERRQ(ierr);
1564996c5bdSBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERDRAW,&isdraw);CHKERRQ(ierr);
1573b224e63SBarry Smith   if (iascii) {
1582c9966d7SBarry Smith     if (jac->bs > 0) {
159c9c6ffaaSJed Brown       ierr = PetscViewerASCIIPrintf(viewer,"  FieldSplit with Schur preconditioner, blocksize = %D, factorization %s\n",jac->bs,PCFieldSplitSchurFactTypes[jac->schurfactorization]);CHKERRQ(ierr);
1602c9966d7SBarry Smith     } else {
1612c9966d7SBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"  FieldSplit with Schur preconditioner, factorization %s\n",PCFieldSplitSchurFactTypes[jac->schurfactorization]);CHKERRQ(ierr);
1622c9966d7SBarry Smith     }
163f5236f50SJed Brown     if (pc->useAmat) {
164f5236f50SJed Brown       ierr = PetscViewerASCIIPrintf(viewer,"  using Amat (not Pmat) as operator for blocks\n");CHKERRQ(ierr);
165a3df900dSMatthew G Knepley     }
1663e8b8b31SMatthew G Knepley     switch (jac->schurpre) {
1673e8b8b31SMatthew G Knepley     case PC_FIELDSPLIT_SCHUR_PRE_SELF:
1683e8b8b31SMatthew G Knepley       ierr = PetscViewerASCIIPrintf(viewer,"  Preconditioner for the Schur complement formed from S itself\n");CHKERRQ(ierr);break;
169a7476a74SDmitry Karpeev     case PC_FIELDSPLIT_SCHUR_PRE_SELFP:
170a7476a74SDmitry Karpeev       ierr = PetscViewerASCIIPrintf(viewer,"  Preconditioner for the Schur complement formed from Sp, an assembled approximation to S, which uses A00's diagonal's inverse\n");CHKERRQ(ierr);break;
171e87fab1bSBarry Smith     case PC_FIELDSPLIT_SCHUR_PRE_A11:
172e87fab1bSBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"  Preconditioner for the Schur complement formed from A11\n");CHKERRQ(ierr);break;
173e74569cdSMatthew G. Knepley     case PC_FIELDSPLIT_SCHUR_PRE_FULL:
174e74569cdSMatthew G. Knepley       ierr = PetscViewerASCIIPrintf(viewer,"  Preconditioner for the Schur complement formed from the exact Schur complement\n");CHKERRQ(ierr);break;
1753e8b8b31SMatthew G Knepley     case PC_FIELDSPLIT_SCHUR_PRE_USER:
1763e8b8b31SMatthew G Knepley       if (jac->schur_user) {
1773e8b8b31SMatthew G Knepley         ierr = PetscViewerASCIIPrintf(viewer,"  Preconditioner for the Schur complement formed from user provided matrix\n");CHKERRQ(ierr);
1783e8b8b31SMatthew G Knepley       } else {
179e87fab1bSBarry Smith         ierr = PetscViewerASCIIPrintf(viewer,"  Preconditioner for the Schur complement formed from A11\n");CHKERRQ(ierr);
1803e8b8b31SMatthew G Knepley       }
1813e8b8b31SMatthew G Knepley       break;
1823e8b8b31SMatthew G Knepley     default:
18382f516ccSBarry Smith       SETERRQ1(PetscObjectComm((PetscObject)pc), PETSC_ERR_ARG_OUTOFRANGE, "Invalid Schur preconditioning type: %d", jac->schurpre);
1843e8b8b31SMatthew G Knepley     }
1853b224e63SBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"  Split info:\n");CHKERRQ(ierr);
1863b224e63SBarry Smith     ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
1873b224e63SBarry Smith     for (i=0; i<jac->nsplits; i++) {
1883b224e63SBarry Smith       if (ilink->fields) {
1893b224e63SBarry Smith         ierr = PetscViewerASCIIPrintf(viewer,"Split number %D Fields ",i);CHKERRQ(ierr);
1903b224e63SBarry Smith         ierr = PetscViewerASCIIUseTabs(viewer,PETSC_FALSE);CHKERRQ(ierr);
1913b224e63SBarry Smith         for (j=0; j<ilink->nfields; j++) {
1923b224e63SBarry Smith           if (j > 0) {
1933b224e63SBarry Smith             ierr = PetscViewerASCIIPrintf(viewer,",");CHKERRQ(ierr);
1943b224e63SBarry Smith           }
1953b224e63SBarry Smith           ierr = PetscViewerASCIIPrintf(viewer," %D",ilink->fields[j]);CHKERRQ(ierr);
1963b224e63SBarry Smith         }
1973b224e63SBarry Smith         ierr = PetscViewerASCIIPrintf(viewer,"\n");CHKERRQ(ierr);
1983b224e63SBarry Smith         ierr = PetscViewerASCIIUseTabs(viewer,PETSC_TRUE);CHKERRQ(ierr);
1993b224e63SBarry Smith       } else {
2003b224e63SBarry Smith         ierr = PetscViewerASCIIPrintf(viewer,"Split number %D Defined by IS\n",i);CHKERRQ(ierr);
2013b224e63SBarry Smith       }
2023b224e63SBarry Smith       ilink = ilink->next;
2033b224e63SBarry Smith     }
204435f959eSBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"KSP solver for A00 block\n");CHKERRQ(ierr);
2053b224e63SBarry Smith     ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
20606de4afeSJed Brown     if (jac->head) {
207443836d0SMatthew G Knepley       ierr = KSPView(jac->head->ksp,viewer);CHKERRQ(ierr);
20806de4afeSJed Brown     } else  {ierr = PetscViewerASCIIPrintf(viewer,"  not yet available\n");CHKERRQ(ierr);}
2093b224e63SBarry Smith     ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
21006de4afeSJed Brown     if (jac->head && jac->kspupper != jac->head->ksp) {
211443836d0SMatthew G Knepley       ierr = PetscViewerASCIIPrintf(viewer,"KSP solver for upper A00 in upper triangular factor \n");CHKERRQ(ierr);
212443836d0SMatthew G Knepley       ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
213b2750c55SJed Brown       if (jac->kspupper) {ierr = KSPView(jac->kspupper,viewer);CHKERRQ(ierr);}
214b2750c55SJed Brown       else {ierr = PetscViewerASCIIPrintf(viewer,"  not yet available\n");CHKERRQ(ierr);}
215443836d0SMatthew G Knepley       ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
216443836d0SMatthew G Knepley     }
217435f959eSBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"KSP solver for S = A11 - A10 inv(A00) A01 \n");CHKERRQ(ierr);
2183b224e63SBarry Smith     ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
21912cae6f2SJed Brown     if (jac->kspschur) {
2203b224e63SBarry Smith       ierr = KSPView(jac->kspschur,viewer);CHKERRQ(ierr);
22112cae6f2SJed Brown     } else {
22212cae6f2SJed Brown       ierr = PetscViewerASCIIPrintf(viewer,"  not yet available\n");CHKERRQ(ierr);
22312cae6f2SJed Brown     }
2243b224e63SBarry Smith     ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
2253b224e63SBarry Smith     ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
22606de4afeSJed Brown   } else if (isdraw && jac->head) {
2274996c5bdSBarry Smith     PetscDraw draw;
2284996c5bdSBarry Smith     PetscReal x,y,w,wd,h;
2294996c5bdSBarry Smith     PetscInt  cnt = 2;
2304996c5bdSBarry Smith     char      str[32];
2314996c5bdSBarry Smith 
2324996c5bdSBarry Smith     ierr = PetscViewerDrawGetDraw(viewer,0,&draw);CHKERRQ(ierr);
2334996c5bdSBarry Smith     ierr = PetscDrawGetCurrentPoint(draw,&x,&y);CHKERRQ(ierr);
234c74581afSBarry Smith     if (jac->kspupper != jac->head->ksp) cnt++;
235c74581afSBarry Smith     w  = 2*PetscMin(1.0 - x,x);
236c74581afSBarry Smith     wd = w/(cnt + 1);
237c74581afSBarry Smith 
2384996c5bdSBarry Smith     ierr = PetscSNPrintf(str,32,"Schur fact. %s",PCFieldSplitSchurFactTypes[jac->schurfactorization]);CHKERRQ(ierr);
2390298fd71SBarry Smith     ierr = PetscDrawBoxedString(draw,x,y,PETSC_DRAW_RED,PETSC_DRAW_BLACK,str,NULL,&h);CHKERRQ(ierr);
2404996c5bdSBarry Smith     y   -= h;
2414996c5bdSBarry Smith     if (jac->schurpre == PC_FIELDSPLIT_SCHUR_PRE_USER &&  !jac->schur_user) {
242e87fab1bSBarry Smith       ierr = PetscSNPrintf(str,32,"Prec. for Schur from %s",PCFieldSplitSchurPreTypes[PC_FIELDSPLIT_SCHUR_PRE_A11]);CHKERRQ(ierr);
2433b224e63SBarry Smith     } else {
2444996c5bdSBarry Smith       ierr = PetscSNPrintf(str,32,"Prec. for Schur from %s",PCFieldSplitSchurPreTypes[jac->schurpre]);CHKERRQ(ierr);
2454996c5bdSBarry Smith     }
2460298fd71SBarry Smith     ierr = PetscDrawBoxedString(draw,x+wd*(cnt-1)/2.0,y,PETSC_DRAW_RED,PETSC_DRAW_BLACK,str,NULL,&h);CHKERRQ(ierr);
2474996c5bdSBarry Smith     y   -= h;
2484996c5bdSBarry Smith     x    = x - wd*(cnt-1)/2.0;
2494996c5bdSBarry Smith 
2504996c5bdSBarry Smith     ierr = PetscDrawPushCurrentPoint(draw,x,y);CHKERRQ(ierr);
2514996c5bdSBarry Smith     ierr = KSPView(jac->head->ksp,viewer);CHKERRQ(ierr);
2524996c5bdSBarry Smith     ierr = PetscDrawPopCurrentPoint(draw);CHKERRQ(ierr);
2534996c5bdSBarry Smith     if (jac->kspupper != jac->head->ksp) {
2544996c5bdSBarry Smith       x   += wd;
2554996c5bdSBarry Smith       ierr = PetscDrawPushCurrentPoint(draw,x,y);CHKERRQ(ierr);
2564996c5bdSBarry Smith       ierr = KSPView(jac->kspupper,viewer);CHKERRQ(ierr);
2574996c5bdSBarry Smith       ierr = PetscDrawPopCurrentPoint(draw);CHKERRQ(ierr);
2584996c5bdSBarry Smith     }
2594996c5bdSBarry Smith     x   += wd;
2604996c5bdSBarry Smith     ierr = PetscDrawPushCurrentPoint(draw,x,y);CHKERRQ(ierr);
2614996c5bdSBarry Smith     ierr = KSPView(jac->kspschur,viewer);CHKERRQ(ierr);
2624996c5bdSBarry Smith     ierr = PetscDrawPopCurrentPoint(draw);CHKERRQ(ierr);
2633b224e63SBarry Smith   }
2643b224e63SBarry Smith   PetscFunctionReturn(0);
2653b224e63SBarry Smith }
2663b224e63SBarry Smith 
2673b224e63SBarry Smith #undef __FUNCT__
2686c924f48SJed Brown #define __FUNCT__ "PCFieldSplitSetRuntimeSplits_Private"
2696c924f48SJed Brown /* Precondition: jac->bs is set to a meaningful value */
2706c924f48SJed Brown static PetscErrorCode PCFieldSplitSetRuntimeSplits_Private(PC pc)
2716c924f48SJed Brown {
2726c924f48SJed Brown   PetscErrorCode ierr;
2736c924f48SJed Brown   PC_FieldSplit  *jac = (PC_FieldSplit*)pc->data;
2745d4c12cdSJungho Lee   PetscInt       i,nfields,*ifields,nfields_col,*ifields_col;
2755d4c12cdSJungho Lee   PetscBool      flg,flg_col;
2765d4c12cdSJungho Lee   char           optionname[128],splitname[8],optionname_col[128];
2776c924f48SJed Brown 
2786c924f48SJed Brown   PetscFunctionBegin;
279785e854fSJed Brown   ierr = PetscMalloc1(jac->bs,&ifields);CHKERRQ(ierr);
280785e854fSJed Brown   ierr = PetscMalloc1(jac->bs,&ifields_col);CHKERRQ(ierr);
2816c924f48SJed Brown   for (i=0,flg=PETSC_TRUE;; i++) {
2828caf3d72SBarry Smith     ierr        = PetscSNPrintf(splitname,sizeof(splitname),"%D",i);CHKERRQ(ierr);
2838caf3d72SBarry Smith     ierr        = PetscSNPrintf(optionname,sizeof(optionname),"-pc_fieldsplit_%D_fields",i);CHKERRQ(ierr);
2848caf3d72SBarry Smith     ierr        = PetscSNPrintf(optionname_col,sizeof(optionname_col),"-pc_fieldsplit_%D_fields_col",i);CHKERRQ(ierr);
2856c924f48SJed Brown     nfields     = jac->bs;
28629499fbbSJungho Lee     nfields_col = jac->bs;
2876c924f48SJed Brown     ierr        = PetscOptionsGetIntArray(((PetscObject)pc)->prefix,optionname,ifields,&nfields,&flg);CHKERRQ(ierr);
2885d4c12cdSJungho Lee     ierr        = PetscOptionsGetIntArray(((PetscObject)pc)->prefix,optionname_col,ifields_col,&nfields_col,&flg_col);CHKERRQ(ierr);
2896c924f48SJed Brown     if (!flg) break;
2905d4c12cdSJungho Lee     else if (flg && !flg_col) {
2915d4c12cdSJungho Lee       if (!nfields) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_USER,"Cannot list zero fields");
2925d4c12cdSJungho Lee       ierr = PCFieldSplitSetFields(pc,splitname,nfields,ifields,ifields);CHKERRQ(ierr);
2932fa5cd67SKarl Rupp     } else {
2945d4c12cdSJungho Lee       if (!nfields || !nfields_col) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_USER,"Cannot list zero fields");
2955d4c12cdSJungho Lee       if (nfields != nfields_col) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_USER,"Number of row and column fields must match");
2965d4c12cdSJungho Lee       ierr = PCFieldSplitSetFields(pc,splitname,nfields,ifields,ifields_col);CHKERRQ(ierr);
2975d4c12cdSJungho Lee     }
2986c924f48SJed Brown   }
2996c924f48SJed Brown   if (i > 0) {
3006c924f48SJed Brown     /* Makes command-line setting of splits take precedence over setting them in code.
3016c924f48SJed Brown        Otherwise subsequent calls to PCFieldSplitSetIS() or PCFieldSplitSetFields() would
3026c924f48SJed Brown        create new splits, which would probably not be what the user wanted. */
3036c924f48SJed Brown     jac->splitdefined = PETSC_TRUE;
3046c924f48SJed Brown   }
3056c924f48SJed Brown   ierr = PetscFree(ifields);CHKERRQ(ierr);
3065d4c12cdSJungho Lee   ierr = PetscFree(ifields_col);CHKERRQ(ierr);
3076c924f48SJed Brown   PetscFunctionReturn(0);
3086c924f48SJed Brown }
3096c924f48SJed Brown 
3106c924f48SJed Brown #undef __FUNCT__
31169a612a9SBarry Smith #define __FUNCT__ "PCFieldSplitSetDefaults"
31269a612a9SBarry Smith static PetscErrorCode PCFieldSplitSetDefaults(PC pc)
3130971522cSBarry Smith {
3140971522cSBarry Smith   PC_FieldSplit     *jac = (PC_FieldSplit*)pc->data;
3150971522cSBarry Smith   PetscErrorCode    ierr;
3165a9f2f41SSatish Balay   PC_FieldSplitLink ilink              = jac->head;
3173a062f41SBarry Smith   PetscBool         fieldsplit_default = PETSC_FALSE,stokes = PETSC_FALSE,coupling = PETSC_FALSE;
3186c924f48SJed Brown   PetscInt          i;
3190971522cSBarry Smith 
3200971522cSBarry Smith   PetscFunctionBegin;
3217287d2a3SDmitry Karpeev   /*
3227287d2a3SDmitry Karpeev    Kinda messy, but at least this now uses DMCreateFieldDecomposition() even with jac->reset.
3237287d2a3SDmitry Karpeev    Should probably be rewritten.
3247287d2a3SDmitry Karpeev    */
3257287d2a3SDmitry Karpeev   if (!ilink || jac->reset) {
3260298fd71SBarry Smith     ierr = PetscOptionsGetBool(((PetscObject)pc)->prefix,"-pc_fieldsplit_detect_saddle_point",&stokes,NULL);CHKERRQ(ierr);
3273a062f41SBarry Smith     ierr = PetscOptionsGetBool(((PetscObject)pc)->prefix,"-pc_fieldsplit_detect_coupling",&coupling,NULL);CHKERRQ(ierr);
3283a062f41SBarry Smith     if (pc->dm && jac->dm_splits && !stokes && !coupling) {
329bafc1b83SMatthew G Knepley       PetscInt  numFields, f, i, j;
3300784a22cSJed Brown       char      **fieldNames;
3317b62db95SJungho Lee       IS        *fields;
332e7c4fc90SDmitry Karpeev       DM        *dms;
333bafc1b83SMatthew G Knepley       DM        subdm[128];
334bafc1b83SMatthew G Knepley       PetscBool flg;
335bafc1b83SMatthew G Knepley 
33616621825SDmitry Karpeev       ierr = DMCreateFieldDecomposition(pc->dm, &numFields, &fieldNames, &fields, &dms);CHKERRQ(ierr);
337bafc1b83SMatthew G Knepley       /* Allow the user to prescribe the splits */
338bafc1b83SMatthew G Knepley       for (i = 0, flg = PETSC_TRUE;; i++) {
339bafc1b83SMatthew G Knepley         PetscInt ifields[128];
340bafc1b83SMatthew G Knepley         IS       compField;
341bafc1b83SMatthew G Knepley         char     optionname[128], splitname[8];
342bafc1b83SMatthew G Knepley         PetscInt nfields = numFields;
343bafc1b83SMatthew G Knepley 
3448caf3d72SBarry Smith         ierr = PetscSNPrintf(optionname, sizeof(optionname), "-pc_fieldsplit_%D_fields", i);CHKERRQ(ierr);
345bafc1b83SMatthew G Knepley         ierr = PetscOptionsGetIntArray(((PetscObject) pc)->prefix, optionname, ifields, &nfields, &flg);CHKERRQ(ierr);
346bafc1b83SMatthew G Knepley         if (!flg) break;
34782f516ccSBarry Smith         if (numFields > 128) SETERRQ1(PetscObjectComm((PetscObject)pc),PETSC_ERR_SUP,"Cannot currently support %d > 128 fields", numFields);
348bafc1b83SMatthew G Knepley         ierr = DMCreateSubDM(pc->dm, nfields, ifields, &compField, &subdm[i]);CHKERRQ(ierr);
349bafc1b83SMatthew G Knepley         if (nfields == 1) {
350bafc1b83SMatthew G Knepley           ierr = PCFieldSplitSetIS(pc, fieldNames[ifields[0]], compField);CHKERRQ(ierr);
35182f516ccSBarry Smith           /* ierr = PetscPrintf(PetscObjectComm((PetscObject)pc), "%s Field Indices:", fieldNames[ifields[0]]);CHKERRQ(ierr);
3520298fd71SBarry Smith              ierr = ISView(compField, NULL);CHKERRQ(ierr); */
353bafc1b83SMatthew G Knepley         } else {
3548caf3d72SBarry Smith           ierr = PetscSNPrintf(splitname, sizeof(splitname), "%D", i);CHKERRQ(ierr);
355bafc1b83SMatthew G Knepley           ierr = PCFieldSplitSetIS(pc, splitname, compField);CHKERRQ(ierr);
35682f516ccSBarry Smith           /* ierr = PetscPrintf(PetscObjectComm((PetscObject)pc), "%s Field Indices:", splitname);CHKERRQ(ierr);
3570298fd71SBarry Smith              ierr = ISView(compField, NULL);CHKERRQ(ierr); */
3587287d2a3SDmitry Karpeev         }
359bafc1b83SMatthew G Knepley         ierr = ISDestroy(&compField);CHKERRQ(ierr);
360bafc1b83SMatthew G Knepley         for (j = 0; j < nfields; ++j) {
361bafc1b83SMatthew G Knepley           f    = ifields[j];
3627b62db95SJungho Lee           ierr = PetscFree(fieldNames[f]);CHKERRQ(ierr);
3637b62db95SJungho Lee           ierr = ISDestroy(&fields[f]);CHKERRQ(ierr);
3647b62db95SJungho Lee         }
365bafc1b83SMatthew G Knepley       }
366bafc1b83SMatthew G Knepley       if (i == 0) {
367bafc1b83SMatthew G Knepley         for (f = 0; f < numFields; ++f) {
368bafc1b83SMatthew G Knepley           ierr = PCFieldSplitSetIS(pc, fieldNames[f], fields[f]);CHKERRQ(ierr);
369bafc1b83SMatthew G Knepley           ierr = PetscFree(fieldNames[f]);CHKERRQ(ierr);
370bafc1b83SMatthew G Knepley           ierr = ISDestroy(&fields[f]);CHKERRQ(ierr);
371bafc1b83SMatthew G Knepley         }
372bafc1b83SMatthew G Knepley       } else {
373d724dfffSBarry Smith         for (j=0; j<numFields; j++) {
374d724dfffSBarry Smith           ierr = DMDestroy(dms+j);CHKERRQ(ierr);
375d724dfffSBarry Smith         }
376d724dfffSBarry Smith         ierr = PetscFree(dms);CHKERRQ(ierr);
377785e854fSJed Brown         ierr = PetscMalloc1(i, &dms);CHKERRQ(ierr);
3782fa5cd67SKarl Rupp         for (j = 0; j < i; ++j) dms[j] = subdm[j];
379bafc1b83SMatthew G Knepley       }
3807b62db95SJungho Lee       ierr = PetscFree(fieldNames);CHKERRQ(ierr);
3817b62db95SJungho Lee       ierr = PetscFree(fields);CHKERRQ(ierr);
382e7c4fc90SDmitry Karpeev       if (dms) {
3838b8307b2SJed Brown         ierr = PetscInfo(pc, "Setting up physics based fieldsplit preconditioner using the embedded DM\n");CHKERRQ(ierr);
384bafc1b83SMatthew G Knepley         for (ilink = jac->head, i = 0; ilink; ilink = ilink->next, ++i) {
3857287d2a3SDmitry Karpeev           const char *prefix;
3867287d2a3SDmitry Karpeev           ierr = PetscObjectGetOptionsPrefix((PetscObject)(ilink->ksp),&prefix);CHKERRQ(ierr);
3877287d2a3SDmitry Karpeev           ierr = PetscObjectSetOptionsPrefix((PetscObject)(dms[i]), prefix);CHKERRQ(ierr);
3887b62db95SJungho Lee           ierr = KSPSetDM(ilink->ksp, dms[i]);CHKERRQ(ierr);
3897b62db95SJungho Lee           ierr = KSPSetDMActive(ilink->ksp, PETSC_FALSE);CHKERRQ(ierr);
3907287d2a3SDmitry Karpeev           ierr = PetscObjectIncrementTabLevel((PetscObject)dms[i],(PetscObject)ilink->ksp,0);CHKERRQ(ierr);
391e7c4fc90SDmitry Karpeev           ierr = DMDestroy(&dms[i]);CHKERRQ(ierr);
3922fa5ba8aSJed Brown         }
3937b62db95SJungho Lee         ierr = PetscFree(dms);CHKERRQ(ierr);
3948b8307b2SJed Brown       }
39566ffff09SJed Brown     } else {
396521d7252SBarry Smith       if (jac->bs <= 0) {
397704ba839SBarry Smith         if (pc->pmat) {
398521d7252SBarry Smith           ierr = MatGetBlockSize(pc->pmat,&jac->bs);CHKERRQ(ierr);
3992fa5cd67SKarl Rupp         } else jac->bs = 1;
400521d7252SBarry Smith       }
401d32f9abdSBarry Smith 
4026ce1633cSBarry Smith       if (stokes) {
4036ce1633cSBarry Smith         IS       zerodiags,rest;
4046ce1633cSBarry Smith         PetscInt nmin,nmax;
4056ce1633cSBarry Smith 
4066ce1633cSBarry Smith         ierr = MatGetOwnershipRange(pc->mat,&nmin,&nmax);CHKERRQ(ierr);
4076ce1633cSBarry Smith         ierr = MatFindZeroDiagonals(pc->mat,&zerodiags);CHKERRQ(ierr);
4086ce1633cSBarry Smith         ierr = ISComplement(zerodiags,nmin,nmax,&rest);CHKERRQ(ierr);
4097287d2a3SDmitry Karpeev         if (jac->reset) {
4107287d2a3SDmitry Karpeev           jac->head->is       = rest;
4117287d2a3SDmitry Karpeev           jac->head->next->is = zerodiags;
4122fa5cd67SKarl Rupp         } else {
4136ce1633cSBarry Smith           ierr = PCFieldSplitSetIS(pc,"0",rest);CHKERRQ(ierr);
4146ce1633cSBarry Smith           ierr = PCFieldSplitSetIS(pc,"1",zerodiags);CHKERRQ(ierr);
4157287d2a3SDmitry Karpeev         }
416fcfd50ebSBarry Smith         ierr = ISDestroy(&zerodiags);CHKERRQ(ierr);
417fcfd50ebSBarry Smith         ierr = ISDestroy(&rest);CHKERRQ(ierr);
4183a062f41SBarry Smith       } else if (coupling) {
4193a062f41SBarry Smith         IS       coupling,rest;
4203a062f41SBarry Smith         PetscInt nmin,nmax;
4213a062f41SBarry Smith 
4223a062f41SBarry Smith         ierr = MatGetOwnershipRange(pc->mat,&nmin,&nmax);CHKERRQ(ierr);
4233a062f41SBarry Smith         ierr = MatFindOffBlockDiagonalEntries(pc->mat,&coupling);CHKERRQ(ierr);
4246bea0878SBarry Smith         ierr = ISCreateStride(PetscObjectComm((PetscObject)pc->mat),nmax-nmin,nmin,1,&rest);CHKERRQ(ierr);
425*e52d2c62SBarry Smith         ierr = ISSetIdentity(rest);CHKERRQ(ierr);
4263a062f41SBarry Smith         if (jac->reset) {
4273a062f41SBarry Smith           jac->head->is       = coupling;
4283a062f41SBarry Smith           jac->head->next->is = rest;
4293a062f41SBarry Smith         } else {
4303a062f41SBarry Smith           ierr = PCFieldSplitSetIS(pc,"0",coupling);CHKERRQ(ierr);
4313a062f41SBarry Smith           ierr = PCFieldSplitSetIS(pc,"1",rest);CHKERRQ(ierr);
4323a062f41SBarry Smith         }
4333a062f41SBarry Smith         ierr = ISDestroy(&coupling);CHKERRQ(ierr);
4343a062f41SBarry Smith         ierr = ISDestroy(&rest);CHKERRQ(ierr);
4356ce1633cSBarry Smith       } else {
436ce94432eSBarry Smith         if (jac->reset) SETERRQ(PetscObjectComm((PetscObject)pc),PETSC_ERR_SUP,"Cases not yet handled when PCReset() was used");
4379eeaaa73SJed Brown         ierr = PetscOptionsGetBool(((PetscObject)pc)->prefix,"-pc_fieldsplit_default",&fieldsplit_default,NULL);CHKERRQ(ierr);
4387287d2a3SDmitry Karpeev         if (!fieldsplit_default) {
439d32f9abdSBarry Smith           /* Allow user to set fields from command line,  if bs was known at the time of PCSetFromOptions_FieldSplit()
440d32f9abdSBarry Smith            then it is set there. This is not ideal because we should only have options set in XXSetFromOptions(). */
4416c924f48SJed Brown           ierr = PCFieldSplitSetRuntimeSplits_Private(pc);CHKERRQ(ierr);
4426c924f48SJed Brown           if (jac->splitdefined) {ierr = PetscInfo(pc,"Splits defined using the options database\n");CHKERRQ(ierr);}
443d32f9abdSBarry Smith         }
4447287d2a3SDmitry Karpeev         if (fieldsplit_default || !jac->splitdefined) {
445d32f9abdSBarry Smith           ierr = PetscInfo(pc,"Using default splitting of fields\n");CHKERRQ(ierr);
446db4c96c1SJed Brown           for (i=0; i<jac->bs; i++) {
4476c924f48SJed Brown             char splitname[8];
4488caf3d72SBarry Smith             ierr = PetscSNPrintf(splitname,sizeof(splitname),"%D",i);CHKERRQ(ierr);
4495d4c12cdSJungho Lee             ierr = PCFieldSplitSetFields(pc,splitname,1,&i,&i);CHKERRQ(ierr);
45079416396SBarry Smith           }
4515d4c12cdSJungho Lee           jac->defaultsplit = PETSC_TRUE;
452521d7252SBarry Smith         }
45366ffff09SJed Brown       }
4546ce1633cSBarry Smith     }
455edf189efSBarry Smith   } else if (jac->nsplits == 1) {
456edf189efSBarry Smith     if (ilink->is) {
457edf189efSBarry Smith       IS       is2;
458edf189efSBarry Smith       PetscInt nmin,nmax;
459edf189efSBarry Smith 
460edf189efSBarry Smith       ierr = MatGetOwnershipRange(pc->mat,&nmin,&nmax);CHKERRQ(ierr);
461edf189efSBarry Smith       ierr = ISComplement(ilink->is,nmin,nmax,&is2);CHKERRQ(ierr);
462db4c96c1SJed Brown       ierr = PCFieldSplitSetIS(pc,"1",is2);CHKERRQ(ierr);
463fcfd50ebSBarry Smith       ierr = ISDestroy(&is2);CHKERRQ(ierr);
46482f516ccSBarry Smith     } else SETERRQ(PetscObjectComm((PetscObject)pc),PETSC_ERR_SUP,"Must provide at least two sets of fields to PCFieldSplit()");
465edf189efSBarry Smith   }
466d0af7cd3SBarry Smith 
467d0af7cd3SBarry Smith 
46882f516ccSBarry Smith   if (jac->nsplits < 2) SETERRQ1(PetscObjectComm((PetscObject)pc),PETSC_ERR_PLIB,"Unhandled case, must have at least two fields, not %d", jac->nsplits);
46969a612a9SBarry Smith   PetscFunctionReturn(0);
47069a612a9SBarry Smith }
47169a612a9SBarry Smith 
4725a576424SJed Brown PETSC_EXTERN PetscErrorCode PetscOptionsFindPairPrefix_Private(const char pre[], const char name[], char *value[], PetscBool *flg);
473514bf10dSMatthew G Knepley 
47469a612a9SBarry Smith #undef __FUNCT__
47569a612a9SBarry Smith #define __FUNCT__ "PCSetUp_FieldSplit"
47669a612a9SBarry Smith static PetscErrorCode PCSetUp_FieldSplit(PC pc)
47769a612a9SBarry Smith {
47869a612a9SBarry Smith   PC_FieldSplit     *jac = (PC_FieldSplit*)pc->data;
47969a612a9SBarry Smith   PetscErrorCode    ierr;
4805a9f2f41SSatish Balay   PC_FieldSplitLink ilink;
4812c9966d7SBarry Smith   PetscInt          i,nsplit;
4825f4ab4e1SJungho Lee   PetscBool         sorted, sorted_col;
48369a612a9SBarry Smith 
48469a612a9SBarry Smith   PetscFunctionBegin;
48569a612a9SBarry Smith   ierr   = PCFieldSplitSetDefaults(pc);CHKERRQ(ierr);
48697bbdb24SBarry Smith   nsplit = jac->nsplits;
4875a9f2f41SSatish Balay   ilink  = jac->head;
48897bbdb24SBarry Smith 
48997bbdb24SBarry Smith   /* get the matrices for each split */
490704ba839SBarry Smith   if (!jac->issetup) {
4911b9fc7fcSBarry Smith     PetscInt rstart,rend,nslots,bs;
49297bbdb24SBarry Smith 
493704ba839SBarry Smith     jac->issetup = PETSC_TRUE;
494704ba839SBarry Smith 
4955d4c12cdSJungho Lee     /* This is done here instead of in PCFieldSplitSetFields() because may not have matrix at that point */
4962c9966d7SBarry Smith     if (jac->defaultsplit || !ilink->is) {
4972c9966d7SBarry Smith       if (jac->bs <= 0) jac->bs = nsplit;
4982c9966d7SBarry Smith     }
49951f519a2SBarry Smith     bs     = jac->bs;
50097bbdb24SBarry Smith     ierr   = MatGetOwnershipRange(pc->pmat,&rstart,&rend);CHKERRQ(ierr);
5011b9fc7fcSBarry Smith     nslots = (rend - rstart)/bs;
5021b9fc7fcSBarry Smith     for (i=0; i<nsplit; i++) {
5031b9fc7fcSBarry Smith       if (jac->defaultsplit) {
504ce94432eSBarry Smith         ierr = ISCreateStride(PetscObjectComm((PetscObject)pc),nslots,rstart+i,nsplit,&ilink->is);CHKERRQ(ierr);
5055f4ab4e1SJungho Lee         ierr = ISDuplicate(ilink->is,&ilink->is_col);CHKERRQ(ierr);
506704ba839SBarry Smith       } else if (!ilink->is) {
507ccb205f8SBarry Smith         if (ilink->nfields > 1) {
5085f4ab4e1SJungho Lee           PetscInt *ii,*jj,j,k,nfields = ilink->nfields,*fields = ilink->fields,*fields_col = ilink->fields_col;
509785e854fSJed Brown           ierr = PetscMalloc1(ilink->nfields*nslots,&ii);CHKERRQ(ierr);
510785e854fSJed Brown           ierr = PetscMalloc1(ilink->nfields*nslots,&jj);CHKERRQ(ierr);
5111b9fc7fcSBarry Smith           for (j=0; j<nslots; j++) {
5121b9fc7fcSBarry Smith             for (k=0; k<nfields; k++) {
5131b9fc7fcSBarry Smith               ii[nfields*j + k] = rstart + bs*j + fields[k];
5145f4ab4e1SJungho Lee               jj[nfields*j + k] = rstart + bs*j + fields_col[k];
51597bbdb24SBarry Smith             }
51697bbdb24SBarry Smith           }
517ce94432eSBarry Smith           ierr = ISCreateGeneral(PetscObjectComm((PetscObject)pc),nslots*nfields,ii,PETSC_OWN_POINTER,&ilink->is);CHKERRQ(ierr);
518ce94432eSBarry Smith           ierr = ISCreateGeneral(PetscObjectComm((PetscObject)pc),nslots*nfields,jj,PETSC_OWN_POINTER,&ilink->is_col);CHKERRQ(ierr);
519ccb205f8SBarry Smith         } else {
520ce94432eSBarry Smith           ierr = ISCreateStride(PetscObjectComm((PetscObject)pc),nslots,rstart+ilink->fields[0],bs,&ilink->is);CHKERRQ(ierr);
521ce94432eSBarry Smith           ierr = ISCreateStride(PetscObjectComm((PetscObject)pc),nslots,rstart+ilink->fields_col[0],bs,&ilink->is_col);CHKERRQ(ierr);
522ccb205f8SBarry Smith        }
5233e197d65SBarry Smith       }
524704ba839SBarry Smith       ierr = ISSorted(ilink->is,&sorted);CHKERRQ(ierr);
5255f4ab4e1SJungho Lee       if (ilink->is_col) { ierr = ISSorted(ilink->is_col,&sorted_col);CHKERRQ(ierr); }
5265f4ab4e1SJungho Lee       if (!sorted || !sorted_col) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_USER,"Fields must be sorted when creating split");
527704ba839SBarry Smith       ilink = ilink->next;
5281b9fc7fcSBarry Smith     }
5291b9fc7fcSBarry Smith   }
5301b9fc7fcSBarry Smith 
531704ba839SBarry Smith   ilink = jac->head;
53297bbdb24SBarry Smith   if (!jac->pmat) {
533bdddcaaaSMatthew G Knepley     Vec xtmp;
534bdddcaaaSMatthew G Knepley 
5350298fd71SBarry Smith     ierr = MatGetVecs(pc->pmat,&xtmp,NULL);CHKERRQ(ierr);
536785e854fSJed Brown     ierr = PetscMalloc1(nsplit,&jac->pmat);CHKERRQ(ierr);
537dcca6d9dSJed Brown     ierr = PetscMalloc2(nsplit,&jac->x,nsplit,&jac->y);CHKERRQ(ierr);
538cf502942SBarry Smith     for (i=0; i<nsplit; i++) {
539bdddcaaaSMatthew G Knepley       MatNullSpace sp;
540bdddcaaaSMatthew G Knepley 
541a3df900dSMatthew G Knepley       /* Check for preconditioning matrix attached to IS */
542a3df900dSMatthew G Knepley       ierr = PetscObjectQuery((PetscObject) ilink->is, "pmat", (PetscObject*) &jac->pmat[i]);CHKERRQ(ierr);
543a3df900dSMatthew G Knepley       if (jac->pmat[i]) {
544a3df900dSMatthew G Knepley         ierr = PetscObjectReference((PetscObject) jac->pmat[i]);CHKERRQ(ierr);
545a3df900dSMatthew G Knepley         if (jac->type == PC_COMPOSITE_SCHUR) {
546a3df900dSMatthew G Knepley           jac->schur_user = jac->pmat[i];
5472fa5cd67SKarl Rupp 
548a3df900dSMatthew G Knepley           ierr = PetscObjectReference((PetscObject) jac->schur_user);CHKERRQ(ierr);
549a3df900dSMatthew G Knepley         }
550a3df900dSMatthew G Knepley       } else {
5513a062f41SBarry Smith         const char *prefix;
5525f4ab4e1SJungho Lee         ierr = MatGetSubMatrix(pc->pmat,ilink->is,ilink->is_col,MAT_INITIAL_MATRIX,&jac->pmat[i]);CHKERRQ(ierr);
5533a062f41SBarry Smith         ierr = KSPGetOptionsPrefix(ilink->ksp,&prefix);CHKERRQ(ierr);
5543a062f41SBarry Smith         ierr = MatSetOptionsPrefix(jac->pmat[i],prefix);CHKERRQ(ierr);
5553a062f41SBarry Smith         ierr = MatViewFromOptions(jac->pmat[i],NULL,"-mat_view");CHKERRQ(ierr);
556a3df900dSMatthew G Knepley       }
557bdddcaaaSMatthew G Knepley       /* create work vectors for each split */
558bdddcaaaSMatthew G Knepley       ierr     = MatGetVecs(jac->pmat[i],&jac->x[i],&jac->y[i]);CHKERRQ(ierr);
5590298fd71SBarry Smith       ilink->x = jac->x[i]; ilink->y = jac->y[i]; ilink->z = NULL;
560bdddcaaaSMatthew G Knepley       /* compute scatter contexts needed by multiplicative versions and non-default splits */
5610298fd71SBarry Smith       ierr = VecScatterCreate(xtmp,ilink->is,jac->x[i],NULL,&ilink->sctx);CHKERRQ(ierr);
562ed1f0337SMatthew G Knepley       /* Check for null space attached to IS */
563bafc1b83SMatthew G Knepley       ierr = PetscObjectQuery((PetscObject) ilink->is, "nullspace", (PetscObject*) &sp);CHKERRQ(ierr);
564bafc1b83SMatthew G Knepley       if (sp) {
565bafc1b83SMatthew G Knepley         ierr = MatSetNullSpace(jac->pmat[i], sp);CHKERRQ(ierr);
566bafc1b83SMatthew G Knepley       }
567ed1f0337SMatthew G Knepley       ierr = PetscObjectQuery((PetscObject) ilink->is, "nearnullspace", (PetscObject*) &sp);CHKERRQ(ierr);
568ed1f0337SMatthew G Knepley       if (sp) {
569ed1f0337SMatthew G Knepley         ierr = MatSetNearNullSpace(jac->pmat[i], sp);CHKERRQ(ierr);
570ed1f0337SMatthew G Knepley       }
571704ba839SBarry Smith       ilink = ilink->next;
572cf502942SBarry Smith     }
573bdddcaaaSMatthew G Knepley     ierr = VecDestroy(&xtmp);CHKERRQ(ierr);
57497bbdb24SBarry Smith   } else {
575cf502942SBarry Smith     for (i=0; i<nsplit; i++) {
576a3df900dSMatthew G Knepley       Mat pmat;
577a3df900dSMatthew G Knepley 
578a3df900dSMatthew G Knepley       /* Check for preconditioning matrix attached to IS */
579a3df900dSMatthew G Knepley       ierr = PetscObjectQuery((PetscObject) ilink->is, "pmat", (PetscObject*) &pmat);CHKERRQ(ierr);
580a3df900dSMatthew G Knepley       if (!pmat) {
5815f4ab4e1SJungho Lee         ierr = MatGetSubMatrix(pc->pmat,ilink->is,ilink->is_col,MAT_REUSE_MATRIX,&jac->pmat[i]);CHKERRQ(ierr);
582a3df900dSMatthew G Knepley       }
583704ba839SBarry Smith       ilink = ilink->next;
584cf502942SBarry Smith     }
58597bbdb24SBarry Smith   }
586f5236f50SJed Brown   if (pc->useAmat) {
587519d70e2SJed Brown     ilink = jac->head;
588519d70e2SJed Brown     if (!jac->mat) {
589785e854fSJed Brown       ierr = PetscMalloc1(nsplit,&jac->mat);CHKERRQ(ierr);
590519d70e2SJed Brown       for (i=0; i<nsplit; i++) {
5915f4ab4e1SJungho Lee         ierr  = MatGetSubMatrix(pc->mat,ilink->is,ilink->is_col,MAT_INITIAL_MATRIX,&jac->mat[i]);CHKERRQ(ierr);
592519d70e2SJed Brown         ilink = ilink->next;
593519d70e2SJed Brown       }
594519d70e2SJed Brown     } else {
595519d70e2SJed Brown       for (i=0; i<nsplit; i++) {
5965f4ab4e1SJungho Lee         if (jac->mat[i]) {ierr = MatGetSubMatrix(pc->mat,ilink->is,ilink->is_col,MAT_REUSE_MATRIX,&jac->mat[i]);CHKERRQ(ierr);}
597519d70e2SJed Brown         ilink = ilink->next;
598519d70e2SJed Brown       }
599519d70e2SJed Brown     }
600519d70e2SJed Brown   } else {
601519d70e2SJed Brown     jac->mat = jac->pmat;
602519d70e2SJed Brown   }
60397bbdb24SBarry Smith 
6046c8605c2SJed Brown   if (jac->type != PC_COMPOSITE_ADDITIVE  && jac->type != PC_COMPOSITE_SCHUR) {
60568dd23aaSBarry Smith     /* extract the rows of the matrix associated with each field: used for efficient computation of residual inside algorithm */
60668dd23aaSBarry Smith     ilink = jac->head;
607*e52d2c62SBarry Smith     if (nsplit == 2 && jac->type == PC_COMPOSITE_MULTIPLICATIVE) {
608*e52d2c62SBarry 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 */
609*e52d2c62SBarry Smith       if (!jac->Afield) {
610*e52d2c62SBarry Smith         ierr = PetscCalloc1(nsplit,&jac->Afield);CHKERRQ(ierr);
611*e52d2c62SBarry Smith         ierr  = MatGetSubMatrix(pc->mat,ilink->next->is,ilink->is,MAT_INITIAL_MATRIX,&jac->Afield[1]);CHKERRQ(ierr);
612*e52d2c62SBarry Smith       } else {
613*e52d2c62SBarry Smith         ierr  = MatGetSubMatrix(pc->mat,ilink->next->is,ilink->is,MAT_REUSE_MATRIX,&jac->Afield[1]);CHKERRQ(ierr);
614*e52d2c62SBarry Smith       }
615*e52d2c62SBarry Smith     } else {
61668dd23aaSBarry Smith       if (!jac->Afield) {
617785e854fSJed Brown         ierr = PetscMalloc1(nsplit,&jac->Afield);CHKERRQ(ierr);
61868dd23aaSBarry Smith         for (i=0; i<nsplit; i++) {
6190298fd71SBarry Smith           ierr  = MatGetSubMatrix(pc->mat,ilink->is,NULL,MAT_INITIAL_MATRIX,&jac->Afield[i]);CHKERRQ(ierr);
62068dd23aaSBarry Smith           ilink = ilink->next;
62168dd23aaSBarry Smith         }
62268dd23aaSBarry Smith       } else {
62368dd23aaSBarry Smith         for (i=0; i<nsplit; i++) {
6240298fd71SBarry Smith           ierr  = MatGetSubMatrix(pc->mat,ilink->is,NULL,MAT_REUSE_MATRIX,&jac->Afield[i]);CHKERRQ(ierr);
62568dd23aaSBarry Smith           ilink = ilink->next;
62668dd23aaSBarry Smith         }
62768dd23aaSBarry Smith       }
62868dd23aaSBarry Smith     }
629*e52d2c62SBarry Smith   }
63068dd23aaSBarry Smith 
6313b224e63SBarry Smith   if (jac->type == PC_COMPOSITE_SCHUR) {
6323b224e63SBarry Smith     IS          ccis;
6334aa3045dSJed Brown     PetscInt    rstart,rend;
634093c86ffSJed Brown     char        lscname[256];
635093c86ffSJed Brown     PetscObject LSC_L;
636ce94432eSBarry Smith 
637ce94432eSBarry Smith     if (nsplit != 2) SETERRQ(PetscObjectComm((PetscObject)pc),PETSC_ERR_ARG_INCOMP,"To use Schur complement preconditioner you must have exactly 2 fields");
63868dd23aaSBarry Smith 
639e6cab6aaSJed Brown     /* When extracting off-diagonal submatrices, we take complements from this range */
640e6cab6aaSJed Brown     ierr = MatGetOwnershipRangeColumn(pc->mat,&rstart,&rend);CHKERRQ(ierr);
641e6cab6aaSJed Brown 
6423b224e63SBarry Smith     /* need to handle case when one is resetting up the preconditioner */
6433b224e63SBarry Smith     if (jac->schur) {
6440298fd71SBarry Smith       KSP kspA = jac->head->ksp, kspInner = NULL, kspUpper = jac->kspupper;
645443836d0SMatthew G Knepley 
646fb3147dbSMatthew G Knepley       ierr  = MatSchurComplementGetKSP(jac->schur, &kspInner);CHKERRQ(ierr);
6473b224e63SBarry Smith       ilink = jac->head;
64849bb4cd7SJungho Lee       ierr  = ISComplement(ilink->is_col,rstart,rend,&ccis);CHKERRQ(ierr);
6494aa3045dSJed Brown       ierr  = MatGetSubMatrix(pc->mat,ilink->is,ccis,MAT_REUSE_MATRIX,&jac->B);CHKERRQ(ierr);
650fcfd50ebSBarry Smith       ierr  = ISDestroy(&ccis);CHKERRQ(ierr);
6513b224e63SBarry Smith       ilink = ilink->next;
65249bb4cd7SJungho Lee       ierr  = ISComplement(ilink->is_col,rstart,rend,&ccis);CHKERRQ(ierr);
6534aa3045dSJed Brown       ierr  = MatGetSubMatrix(pc->mat,ilink->is,ccis,MAT_REUSE_MATRIX,&jac->C);CHKERRQ(ierr);
654fcfd50ebSBarry Smith       ierr  = ISDestroy(&ccis);CHKERRQ(ierr);
655aa6c7ce3SBarry Smith       ierr  = MatSchurComplementUpdateSubMatrices(jac->schur,jac->mat[0],jac->pmat[0],jac->B,jac->C,jac->mat[1]);CHKERRQ(ierr);
656a7476a74SDmitry Karpeev       if (jac->schurpre == PC_FIELDSPLIT_SCHUR_PRE_SELFP) {
657a7476a74SDmitry Karpeev 	ierr = MatDestroy(&jac->schurp);CHKERRQ(ierr);
658a7476a74SDmitry Karpeev 	ierr = MatSchurComplementGetPmat(jac->schur,MAT_INITIAL_MATRIX,&jac->schurp);CHKERRQ(ierr);
659a7476a74SDmitry Karpeev       }
660443836d0SMatthew G Knepley       if (kspA != kspInner) {
66123ee1639SBarry Smith         ierr = KSPSetOperators(kspA,jac->mat[0],jac->pmat[0]);CHKERRQ(ierr);
662443836d0SMatthew G Knepley       }
663443836d0SMatthew G Knepley       if (kspUpper != kspA) {
66423ee1639SBarry Smith         ierr = KSPSetOperators(kspUpper,jac->mat[0],jac->pmat[0]);CHKERRQ(ierr);
665443836d0SMatthew G Knepley       }
66623ee1639SBarry Smith       ierr = KSPSetOperators(jac->kspschur,jac->schur,FieldSplitSchurPre(jac));CHKERRQ(ierr);
6673b224e63SBarry Smith     } else {
668bafc1b83SMatthew G Knepley       const char   *Dprefix;
669470b340bSDmitry Karpeev       char         schurprefix[256], schurmatprefix[256];
670514bf10dSMatthew G Knepley       char         schurtestoption[256];
671bdddcaaaSMatthew G Knepley       MatNullSpace sp;
672514bf10dSMatthew G Knepley       PetscBool    flg;
6733b224e63SBarry Smith 
674a04f6461SBarry Smith       /* extract the A01 and A10 matrices */
6753b224e63SBarry Smith       ilink = jac->head;
67649bb4cd7SJungho Lee       ierr  = ISComplement(ilink->is_col,rstart,rend,&ccis);CHKERRQ(ierr);
6774aa3045dSJed Brown       ierr  = MatGetSubMatrix(pc->mat,ilink->is,ccis,MAT_INITIAL_MATRIX,&jac->B);CHKERRQ(ierr);
678fcfd50ebSBarry Smith       ierr  = ISDestroy(&ccis);CHKERRQ(ierr);
6793b224e63SBarry Smith       ilink = ilink->next;
68049bb4cd7SJungho Lee       ierr  = ISComplement(ilink->is_col,rstart,rend,&ccis);CHKERRQ(ierr);
6814aa3045dSJed Brown       ierr  = MatGetSubMatrix(pc->mat,ilink->is,ccis,MAT_INITIAL_MATRIX,&jac->C);CHKERRQ(ierr);
682fcfd50ebSBarry Smith       ierr  = ISDestroy(&ccis);CHKERRQ(ierr);
68320252d06SBarry Smith 
684f5236f50SJed Brown       /* Use mat[0] (diagonal block of Amat) preconditioned by pmat[0] to define Schur complement */
68520252d06SBarry Smith       ierr = MatCreate(((PetscObject)jac->mat[0])->comm,&jac->schur);CHKERRQ(ierr);
68620252d06SBarry Smith       ierr = MatSetType(jac->schur,MATSCHURCOMPLEMENT);CHKERRQ(ierr);
687bee83525SDmitry Karpeev       ierr = MatSchurComplementSetSubMatrices(jac->schur,jac->mat[0],jac->pmat[0],jac->B,jac->C,jac->mat[1]);CHKERRQ(ierr);
688470b340bSDmitry Karpeev       ierr = PetscSNPrintf(schurmatprefix, sizeof(schurmatprefix), "%sfieldsplit_%s_", ((PetscObject)pc)->prefix ? ((PetscObject)pc)->prefix : "", ilink->splitname);CHKERRQ(ierr);
689470b340bSDmitry 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? */
690470b340bSDmitry Karpeev       ierr = MatSetOptionsPrefix(jac->schur,schurmatprefix);CHKERRQ(ierr);
691470b340bSDmitry Karpeev       ierr = MatSetFromOptions(jac->schur);CHKERRQ(ierr);
692bdddcaaaSMatthew G Knepley       ierr = MatGetNullSpace(jac->pmat[1], &sp);CHKERRQ(ierr);
69320252d06SBarry Smith       if (sp) {
69420252d06SBarry Smith         ierr = MatSetNullSpace(jac->schur, sp);CHKERRQ(ierr);
69520252d06SBarry Smith       }
69620252d06SBarry Smith 
69720252d06SBarry Smith       ierr = PetscSNPrintf(schurtestoption, sizeof(schurtestoption), "-fieldsplit_%s_inner_", ilink->splitname);CHKERRQ(ierr);
6980298fd71SBarry Smith       ierr = PetscOptionsFindPairPrefix_Private(((PetscObject)pc)->prefix, schurtestoption, NULL, &flg);CHKERRQ(ierr);
699514bf10dSMatthew G Knepley       if (flg) {
700514bf10dSMatthew G Knepley         DM  dmInner;
70121635b76SJed Brown         KSP kspInner;
70221635b76SJed Brown 
70321635b76SJed Brown         ierr = MatSchurComplementGetKSP(jac->schur, &kspInner);CHKERRQ(ierr);
70421635b76SJed Brown         ierr = PetscSNPrintf(schurprefix, sizeof(schurprefix), "%sfieldsplit_%s_inner_", ((PetscObject)pc)->prefix ? ((PetscObject)pc)->prefix : "", ilink->splitname);CHKERRQ(ierr);
70521635b76SJed Brown         /* Indent this deeper to emphasize the "inner" nature of this solver. */
70621635b76SJed Brown         ierr = PetscObjectIncrementTabLevel((PetscObject)kspInner, (PetscObject) pc, 2);CHKERRQ(ierr);
70721635b76SJed Brown         ierr = KSPSetOptionsPrefix(kspInner, schurprefix);CHKERRQ(ierr);
708514bf10dSMatthew G Knepley 
709514bf10dSMatthew G Knepley         /* Set DM for new solver */
710bafc1b83SMatthew G Knepley         ierr = KSPGetDM(jac->head->ksp, &dmInner);CHKERRQ(ierr);
71121635b76SJed Brown         ierr = KSPSetDM(kspInner, dmInner);CHKERRQ(ierr);
71221635b76SJed Brown         ierr = KSPSetDMActive(kspInner, PETSC_FALSE);CHKERRQ(ierr);
713514bf10dSMatthew G Knepley       } else {
71421635b76SJed Brown          /* Use the outer solver for the inner solve, but revert the KSPPREONLY from PCFieldSplitSetFields_FieldSplit or
71521635b76SJed Brown           * PCFieldSplitSetIS_FieldSplit. We don't want KSPPREONLY because it makes the Schur complement inexact,
71621635b76SJed Brown           * preventing Schur complement reduction to be an accurate solve. Usually when an iterative solver is used for
71721635b76SJed 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
71821635b76SJed Brown           * GMRES the default. Note that it is also common to use PREONLY for S, in which case S may not be used
71921635b76SJed Brown           * directly, and the user is responsible for setting an inexact method for fieldsplit's A^{-1}. */
72021635b76SJed Brown         ierr = KSPSetType(jac->head->ksp,KSPGMRES);CHKERRQ(ierr);
721514bf10dSMatthew G Knepley         ierr = MatSchurComplementSetKSP(jac->schur,jac->head->ksp);CHKERRQ(ierr);
722bafc1b83SMatthew G Knepley       }
72323ee1639SBarry Smith       ierr = KSPSetOperators(jac->head->ksp,jac->mat[0],jac->pmat[0]);CHKERRQ(ierr);
7245a9f2f41SSatish Balay       ierr = KSPSetFromOptions(jac->head->ksp);CHKERRQ(ierr);
72597bbdb24SBarry Smith       ierr = MatSetFromOptions(jac->schur);CHKERRQ(ierr);
72697bbdb24SBarry Smith 
727443836d0SMatthew G Knepley       ierr = PetscSNPrintf(schurtestoption, sizeof(schurtestoption), "-fieldsplit_%s_upper_", ilink->splitname);CHKERRQ(ierr);
7280298fd71SBarry Smith       ierr = PetscOptionsFindPairPrefix_Private(((PetscObject)pc)->prefix, schurtestoption, NULL, &flg);CHKERRQ(ierr);
729443836d0SMatthew G Knepley       if (flg) {
730443836d0SMatthew G Knepley         DM dmInner;
731443836d0SMatthew G Knepley 
732443836d0SMatthew G Knepley         ierr = PetscSNPrintf(schurprefix, sizeof(schurprefix), "%sfieldsplit_%s_upper_", ((PetscObject)pc)->prefix ? ((PetscObject)pc)->prefix : "", ilink->splitname);CHKERRQ(ierr);
73382f516ccSBarry Smith         ierr = KSPCreate(PetscObjectComm((PetscObject)pc), &jac->kspupper);CHKERRQ(ierr);
734443836d0SMatthew G Knepley         ierr = KSPSetOptionsPrefix(jac->kspupper, schurprefix);CHKERRQ(ierr);
735443836d0SMatthew G Knepley         ierr = KSPGetDM(jac->head->ksp, &dmInner);CHKERRQ(ierr);
736443836d0SMatthew G Knepley         ierr = KSPSetDM(jac->kspupper, dmInner);CHKERRQ(ierr);
737443836d0SMatthew G Knepley         ierr = KSPSetDMActive(jac->kspupper, PETSC_FALSE);CHKERRQ(ierr);
738443836d0SMatthew G Knepley         ierr = KSPSetFromOptions(jac->kspupper);CHKERRQ(ierr);
73923ee1639SBarry Smith         ierr = KSPSetOperators(jac->kspupper,jac->mat[0],jac->pmat[0]);CHKERRQ(ierr);
740443836d0SMatthew G Knepley         ierr = VecDuplicate(jac->head->x, &jac->head->z);CHKERRQ(ierr);
741443836d0SMatthew G Knepley       } else {
742443836d0SMatthew G Knepley         jac->kspupper = jac->head->ksp;
743443836d0SMatthew G Knepley         ierr          = PetscObjectReference((PetscObject) jac->head->ksp);CHKERRQ(ierr);
744443836d0SMatthew G Knepley       }
745443836d0SMatthew G Knepley 
746a7476a74SDmitry Karpeev       if (jac->schurpre == PC_FIELDSPLIT_SCHUR_PRE_SELFP) {
747a7476a74SDmitry Karpeev 	ierr = MatSchurComplementGetPmat(jac->schur,MAT_INITIAL_MATRIX,&jac->schurp);CHKERRQ(ierr);
748a7476a74SDmitry Karpeev       }
749ce94432eSBarry Smith       ierr = KSPCreate(PetscObjectComm((PetscObject)pc),&jac->kspschur);CHKERRQ(ierr);
75097bbdb24SBarry Smith       ierr = PetscLogObjectParent((PetscObject)pc,(PetscObject)jac->kspschur);CHKERRQ(ierr);
75120252d06SBarry Smith       ierr = PetscObjectIncrementTabLevel((PetscObject)jac->kspschur,(PetscObject)pc,1);CHKERRQ(ierr);
75297bbdb24SBarry Smith       if (jac->schurpre == PC_FIELDSPLIT_SCHUR_PRE_SELF) {
7537233a360SDmitry Karpeev         PC pcschur;
7547233a360SDmitry Karpeev         ierr = KSPGetPC(jac->kspschur,&pcschur);CHKERRQ(ierr);
7557233a360SDmitry Karpeev         ierr = PCSetType(pcschur,PCNONE);CHKERRQ(ierr);
75697bbdb24SBarry Smith         /* Note: This is bad if there exist preconditioners for MATSCHURCOMPLEMENT */
757e74569cdSMatthew G. Knepley       } else if (jac->schurpre == PC_FIELDSPLIT_SCHUR_PRE_FULL) {
758e74569cdSMatthew G. Knepley         ierr = MatSchurComplementComputeExplicitOperator(jac->schur, &jac->schur_user);CHKERRQ(ierr);
75997bbdb24SBarry Smith       }
76023ee1639SBarry Smith       ierr = KSPSetOperators(jac->kspschur,jac->schur,FieldSplitSchurPre(jac));CHKERRQ(ierr);
76197bbdb24SBarry Smith       ierr = KSPGetOptionsPrefix(jac->head->next->ksp, &Dprefix);CHKERRQ(ierr);
76297bbdb24SBarry Smith       ierr = KSPSetOptionsPrefix(jac->kspschur,         Dprefix);CHKERRQ(ierr);
763b20b4189SMatthew G. Knepley       /* propogate DM */
764b20b4189SMatthew G. Knepley       {
765b20b4189SMatthew G. Knepley         DM sdm;
766b20b4189SMatthew G. Knepley         ierr = KSPGetDM(jac->head->next->ksp, &sdm);CHKERRQ(ierr);
767b20b4189SMatthew G. Knepley         if (sdm) {
768b20b4189SMatthew G. Knepley           ierr = KSPSetDM(jac->kspschur, sdm);CHKERRQ(ierr);
769b20b4189SMatthew G. Knepley           ierr = KSPSetDMActive(jac->kspschur, PETSC_FALSE);CHKERRQ(ierr);
770b20b4189SMatthew G. Knepley         }
771b20b4189SMatthew G. Knepley       }
77297bbdb24SBarry Smith       /* really want setfromoptions called in PCSetFromOptions_FieldSplit(), but it is not ready yet */
77397bbdb24SBarry Smith       /* need to call this every time, since the jac->kspschur is freshly created, otherwise its options never get set */
77497bbdb24SBarry Smith       ierr = KSPSetFromOptions(jac->kspschur);CHKERRQ(ierr);
77597bbdb24SBarry Smith     }
77697bbdb24SBarry Smith 
7775a9f2f41SSatish Balay     /* HACK: special support to forward L and Lp matrices that might be used by PCLSC */
7788caf3d72SBarry Smith     ierr = PetscSNPrintf(lscname,sizeof(lscname),"%s_LSC_L",ilink->splitname);CHKERRQ(ierr);
779519d70e2SJed Brown     ierr = PetscObjectQuery((PetscObject)pc->mat,lscname,(PetscObject*)&LSC_L);CHKERRQ(ierr);
7803b224e63SBarry Smith     if (!LSC_L) {ierr = PetscObjectQuery((PetscObject)pc->pmat,lscname,(PetscObject*)&LSC_L);CHKERRQ(ierr);}
781c1570756SJed Brown     if (LSC_L) {ierr = PetscObjectCompose((PetscObject)jac->schur,"LSC_L",(PetscObject)LSC_L);CHKERRQ(ierr);}
7828caf3d72SBarry Smith     ierr = PetscSNPrintf(lscname,sizeof(lscname),"%s_LSC_Lp",ilink->splitname);CHKERRQ(ierr);
78397bbdb24SBarry Smith     ierr = PetscObjectQuery((PetscObject)pc->pmat,lscname,(PetscObject*)&LSC_L);CHKERRQ(ierr);
7845a9f2f41SSatish Balay     if (!LSC_L) {ierr = PetscObjectQuery((PetscObject)pc->mat,lscname,(PetscObject*)&LSC_L);CHKERRQ(ierr);}
7850971522cSBarry Smith     if (LSC_L) {ierr = PetscObjectCompose((PetscObject)jac->schur,"LSC_Lp",(PetscObject)LSC_L);CHKERRQ(ierr);}
78697bbdb24SBarry Smith   } else {
78768bd789dSDmitry Karpeev     /* set up the individual splits' PCs */
7880971522cSBarry Smith     i     = 0;
7890971522cSBarry Smith     ilink = jac->head;
7900971522cSBarry Smith     while (ilink) {
79123ee1639SBarry Smith       ierr = KSPSetOperators(ilink->ksp,jac->mat[i],jac->pmat[i]);CHKERRQ(ierr);
7920971522cSBarry Smith       /* really want setfromoptions called in PCSetFromOptions_FieldSplit(), but it is not ready yet */
7930971522cSBarry Smith       if (!jac->suboptionsset) {ierr = KSPSetFromOptions(ilink->ksp);CHKERRQ(ierr);}
7940971522cSBarry Smith       i++;
7950971522cSBarry Smith       ilink = ilink->next;
7960971522cSBarry Smith     }
7973b224e63SBarry Smith   }
7983b224e63SBarry Smith 
799c1570756SJed Brown   jac->suboptionsset = PETSC_TRUE;
8000971522cSBarry Smith   PetscFunctionReturn(0);
8010971522cSBarry Smith }
8020971522cSBarry Smith 
8035a9f2f41SSatish Balay #define FieldSplitSplitSolveAdd(ilink,xx,yy) \
804ca9f406cSSatish Balay   (VecScatterBegin(ilink->sctx,xx,ilink->x,INSERT_VALUES,SCATTER_FORWARD) || \
805ca9f406cSSatish Balay    VecScatterEnd(ilink->sctx,xx,ilink->x,INSERT_VALUES,SCATTER_FORWARD) || \
8065a9f2f41SSatish Balay    KSPSolve(ilink->ksp,ilink->x,ilink->y) || \
807ca9f406cSSatish Balay    VecScatterBegin(ilink->sctx,ilink->y,yy,ADD_VALUES,SCATTER_REVERSE) || \
808ca9f406cSSatish Balay    VecScatterEnd(ilink->sctx,ilink->y,yy,ADD_VALUES,SCATTER_REVERSE))
80979416396SBarry Smith 
8100971522cSBarry Smith #undef __FUNCT__
8113b224e63SBarry Smith #define __FUNCT__ "PCApply_FieldSplit_Schur"
8123b224e63SBarry Smith static PetscErrorCode PCApply_FieldSplit_Schur(PC pc,Vec x,Vec y)
8133b224e63SBarry Smith {
8143b224e63SBarry Smith   PC_FieldSplit     *jac = (PC_FieldSplit*)pc->data;
8153b224e63SBarry Smith   PetscErrorCode    ierr;
8163b224e63SBarry Smith   PC_FieldSplitLink ilinkA = jac->head, ilinkD = ilinkA->next;
817443836d0SMatthew G Knepley   KSP               kspA   = ilinkA->ksp, kspLower = kspA, kspUpper = jac->kspupper;
8183b224e63SBarry Smith 
8193b224e63SBarry Smith   PetscFunctionBegin;
820c5d2311dSJed Brown   switch (jac->schurfactorization) {
821c9c6ffaaSJed Brown   case PC_FIELDSPLIT_SCHUR_FACT_DIAG:
822a04f6461SBarry Smith     /* [A00 0; 0 -S], positive definite, suitable for MINRES */
823c5d2311dSJed Brown     ierr = VecScatterBegin(ilinkA->sctx,x,ilinkA->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
824c5d2311dSJed Brown     ierr = VecScatterBegin(ilinkD->sctx,x,ilinkD->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
825c5d2311dSJed Brown     ierr = VecScatterEnd(ilinkA->sctx,x,ilinkA->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
826443836d0SMatthew G Knepley     ierr = KSPSolve(kspA,ilinkA->x,ilinkA->y);CHKERRQ(ierr);
827c5d2311dSJed Brown     ierr = VecScatterBegin(ilinkA->sctx,ilinkA->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
828c5d2311dSJed Brown     ierr = VecScatterEnd(ilinkD->sctx,x,ilinkD->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
829c5d2311dSJed Brown     ierr = KSPSolve(jac->kspschur,ilinkD->x,ilinkD->y);CHKERRQ(ierr);
830c5d2311dSJed Brown     ierr = VecScale(ilinkD->y,-1.);CHKERRQ(ierr);
831c5d2311dSJed Brown     ierr = VecScatterBegin(ilinkD->sctx,ilinkD->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
832c5d2311dSJed Brown     ierr = VecScatterEnd(ilinkA->sctx,ilinkA->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
833c5d2311dSJed Brown     ierr = VecScatterEnd(ilinkD->sctx,ilinkD->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
834c5d2311dSJed Brown     break;
835c9c6ffaaSJed Brown   case PC_FIELDSPLIT_SCHUR_FACT_LOWER:
836a04f6461SBarry Smith     /* [A00 0; A10 S], suitable for left preconditioning */
837c5d2311dSJed Brown     ierr = VecScatterBegin(ilinkA->sctx,x,ilinkA->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
838c5d2311dSJed Brown     ierr = VecScatterEnd(ilinkA->sctx,x,ilinkA->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
839443836d0SMatthew G Knepley     ierr = KSPSolve(kspA,ilinkA->x,ilinkA->y);CHKERRQ(ierr);
840c5d2311dSJed Brown     ierr = MatMult(jac->C,ilinkA->y,ilinkD->x);CHKERRQ(ierr);
841c5d2311dSJed Brown     ierr = VecScale(ilinkD->x,-1.);CHKERRQ(ierr);
842c5d2311dSJed Brown     ierr = VecScatterBegin(ilinkD->sctx,x,ilinkD->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
843c5d2311dSJed Brown     ierr = VecScatterBegin(ilinkA->sctx,ilinkA->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
844c5d2311dSJed Brown     ierr = VecScatterEnd(ilinkD->sctx,x,ilinkD->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
845c5d2311dSJed Brown     ierr = KSPSolve(jac->kspschur,ilinkD->x,ilinkD->y);CHKERRQ(ierr);
846c5d2311dSJed Brown     ierr = VecScatterBegin(ilinkD->sctx,ilinkD->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
847c5d2311dSJed Brown     ierr = VecScatterEnd(ilinkA->sctx,ilinkA->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
848c5d2311dSJed Brown     ierr = VecScatterEnd(ilinkD->sctx,ilinkD->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
849c5d2311dSJed Brown     break;
850c9c6ffaaSJed Brown   case PC_FIELDSPLIT_SCHUR_FACT_UPPER:
851a04f6461SBarry Smith     /* [A00 A01; 0 S], suitable for right preconditioning */
852c5d2311dSJed Brown     ierr = VecScatterBegin(ilinkD->sctx,x,ilinkD->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
853c5d2311dSJed Brown     ierr = VecScatterEnd(ilinkD->sctx,x,ilinkD->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
854c5d2311dSJed Brown     ierr = KSPSolve(jac->kspschur,ilinkD->x,ilinkD->y);CHKERRQ(ierr);
855c5d2311dSJed Brown     ierr = MatMult(jac->B,ilinkD->y,ilinkA->x);CHKERRQ(ierr);
856c5d2311dSJed Brown     ierr = VecScale(ilinkA->x,-1.);CHKERRQ(ierr);
857c5d2311dSJed Brown     ierr = VecScatterBegin(ilinkA->sctx,x,ilinkA->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
858c5d2311dSJed Brown     ierr = VecScatterBegin(ilinkD->sctx,ilinkD->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
859c5d2311dSJed Brown     ierr = VecScatterEnd(ilinkA->sctx,x,ilinkA->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
860443836d0SMatthew G Knepley     ierr = KSPSolve(kspA,ilinkA->x,ilinkA->y);CHKERRQ(ierr);
861c5d2311dSJed Brown     ierr = VecScatterBegin(ilinkA->sctx,ilinkA->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
862c5d2311dSJed Brown     ierr = VecScatterEnd(ilinkD->sctx,ilinkD->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
863c5d2311dSJed Brown     ierr = VecScatterEnd(ilinkA->sctx,ilinkA->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
864c5d2311dSJed Brown     break;
865c9c6ffaaSJed Brown   case PC_FIELDSPLIT_SCHUR_FACT_FULL:
866a04f6461SBarry 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 */
8673b224e63SBarry Smith     ierr = VecScatterBegin(ilinkA->sctx,x,ilinkA->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
8683b224e63SBarry Smith     ierr = VecScatterEnd(ilinkA->sctx,x,ilinkA->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
869443836d0SMatthew G Knepley     ierr = KSPSolve(kspLower,ilinkA->x,ilinkA->y);CHKERRQ(ierr);
8703b224e63SBarry Smith     ierr = MatMult(jac->C,ilinkA->y,ilinkD->x);CHKERRQ(ierr);
8713b224e63SBarry Smith     ierr = VecScale(ilinkD->x,-1.0);CHKERRQ(ierr);
8723b224e63SBarry Smith     ierr = VecScatterBegin(ilinkD->sctx,x,ilinkD->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
8733b224e63SBarry Smith     ierr = VecScatterEnd(ilinkD->sctx,x,ilinkD->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
8743b224e63SBarry Smith 
8753b224e63SBarry Smith     ierr = KSPSolve(jac->kspschur,ilinkD->x,ilinkD->y);CHKERRQ(ierr);
8763b224e63SBarry Smith     ierr = VecScatterBegin(ilinkD->sctx,ilinkD->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
8773b224e63SBarry Smith     ierr = VecScatterEnd(ilinkD->sctx,ilinkD->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
8783b224e63SBarry Smith 
879443836d0SMatthew G Knepley     if (kspUpper == kspA) {
8803b224e63SBarry Smith       ierr = MatMult(jac->B,ilinkD->y,ilinkA->y);CHKERRQ(ierr);
8813b224e63SBarry Smith       ierr = VecAXPY(ilinkA->x,-1.0,ilinkA->y);CHKERRQ(ierr);
882443836d0SMatthew G Knepley       ierr = KSPSolve(kspA,ilinkA->x,ilinkA->y);CHKERRQ(ierr);
883443836d0SMatthew G Knepley     } else {
884443836d0SMatthew G Knepley       ierr = KSPSolve(kspA,ilinkA->x,ilinkA->y);CHKERRQ(ierr);
885443836d0SMatthew G Knepley       ierr = MatMult(jac->B,ilinkD->y,ilinkA->x);CHKERRQ(ierr);
886443836d0SMatthew G Knepley       ierr = KSPSolve(kspUpper,ilinkA->x,ilinkA->z);CHKERRQ(ierr);
887443836d0SMatthew G Knepley       ierr = VecAXPY(ilinkA->y,-1.0,ilinkA->z);CHKERRQ(ierr);
888443836d0SMatthew G Knepley     }
8893b224e63SBarry Smith     ierr = VecScatterBegin(ilinkA->sctx,ilinkA->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
8903b224e63SBarry Smith     ierr = VecScatterEnd(ilinkA->sctx,ilinkA->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
891c5d2311dSJed Brown   }
8923b224e63SBarry Smith   PetscFunctionReturn(0);
8933b224e63SBarry Smith }
8943b224e63SBarry Smith 
8953b224e63SBarry Smith #undef __FUNCT__
8960971522cSBarry Smith #define __FUNCT__ "PCApply_FieldSplit"
8970971522cSBarry Smith static PetscErrorCode PCApply_FieldSplit(PC pc,Vec x,Vec y)
8980971522cSBarry Smith {
8990971522cSBarry Smith   PC_FieldSplit     *jac = (PC_FieldSplit*)pc->data;
9000971522cSBarry Smith   PetscErrorCode    ierr;
9015a9f2f41SSatish Balay   PC_FieldSplitLink ilink = jac->head;
902939b8a20SBarry Smith   PetscInt          cnt,bs;
9030971522cSBarry Smith 
9040971522cSBarry Smith   PetscFunctionBegin;
90579416396SBarry Smith   if (jac->type == PC_COMPOSITE_ADDITIVE) {
9061b9fc7fcSBarry Smith     if (jac->defaultsplit) {
907939b8a20SBarry Smith       ierr = VecGetBlockSize(x,&bs);CHKERRQ(ierr);
908ce94432eSBarry 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);
909939b8a20SBarry Smith       ierr = VecGetBlockSize(y,&bs);CHKERRQ(ierr);
910ce94432eSBarry 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);
9110971522cSBarry Smith       ierr = VecStrideGatherAll(x,jac->x,INSERT_VALUES);CHKERRQ(ierr);
9125a9f2f41SSatish Balay       while (ilink) {
9135a9f2f41SSatish Balay         ierr  = KSPSolve(ilink->ksp,ilink->x,ilink->y);CHKERRQ(ierr);
9145a9f2f41SSatish Balay         ilink = ilink->next;
9150971522cSBarry Smith       }
9160971522cSBarry Smith       ierr = VecStrideScatterAll(jac->y,y,INSERT_VALUES);CHKERRQ(ierr);
9171b9fc7fcSBarry Smith     } else {
918efb30889SBarry Smith       ierr = VecSet(y,0.0);CHKERRQ(ierr);
9195a9f2f41SSatish Balay       while (ilink) {
9205a9f2f41SSatish Balay         ierr  = FieldSplitSplitSolveAdd(ilink,x,y);CHKERRQ(ierr);
9215a9f2f41SSatish Balay         ilink = ilink->next;
9221b9fc7fcSBarry Smith       }
9231b9fc7fcSBarry Smith     }
924*e52d2c62SBarry Smith   } else if (jac->type == PC_COMPOSITE_MULTIPLICATIVE && jac->nsplits == 2) {
925*e52d2c62SBarry Smith     ierr = VecSet(y,0.0);CHKERRQ(ierr);
926*e52d2c62SBarry Smith     /* solve on first block for first block variables */
927*e52d2c62SBarry Smith     ierr = VecScatterBegin(ilink->sctx,x,ilink->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
928*e52d2c62SBarry Smith     ierr = VecScatterEnd(ilink->sctx,x,ilink->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
929*e52d2c62SBarry Smith     ierr = KSPSolve(ilink->ksp,ilink->x,ilink->y);CHKERRQ(ierr);
930*e52d2c62SBarry Smith     ierr = VecScatterBegin(ilink->sctx,ilink->y,y,ADD_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
931*e52d2c62SBarry Smith     ierr = VecScatterEnd(ilink->sctx,ilink->y,y,ADD_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
932*e52d2c62SBarry Smith 
933*e52d2c62SBarry Smith     /* compute the residual only onto second block variables using first block variables */
934*e52d2c62SBarry Smith     ierr = MatMult(jac->Afield[1],ilink->y,ilink->next->x);CHKERRQ(ierr);
935*e52d2c62SBarry Smith     ilink = ilink->next;
936*e52d2c62SBarry Smith     ierr = VecScale(ilink->x,-1.0);CHKERRQ(ierr);
937*e52d2c62SBarry Smith     ierr = VecScatterBegin(ilink->sctx,x,ilink->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
938*e52d2c62SBarry Smith     ierr = VecScatterEnd(ilink->sctx,x,ilink->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
939*e52d2c62SBarry Smith 
940*e52d2c62SBarry Smith     /* solve on second block variables */
941*e52d2c62SBarry Smith     ierr = KSPSolve(ilink->ksp,ilink->x,ilink->y);CHKERRQ(ierr);
942*e52d2c62SBarry Smith     ierr = VecScatterBegin(ilink->sctx,ilink->y,y,ADD_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
943*e52d2c62SBarry Smith     ierr = VecScatterEnd(ilink->sctx,ilink->y,y,ADD_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
94416913363SBarry Smith   } else if (jac->type == PC_COMPOSITE_MULTIPLICATIVE || jac->type == PC_COMPOSITE_SYMMETRIC_MULTIPLICATIVE) {
94579416396SBarry Smith     if (!jac->w1) {
94679416396SBarry Smith       ierr = VecDuplicate(x,&jac->w1);CHKERRQ(ierr);
94779416396SBarry Smith       ierr = VecDuplicate(x,&jac->w2);CHKERRQ(ierr);
94879416396SBarry Smith     }
949efb30889SBarry Smith     ierr = VecSet(y,0.0);CHKERRQ(ierr);
9505a9f2f41SSatish Balay     ierr = FieldSplitSplitSolveAdd(ilink,x,y);CHKERRQ(ierr);
9513e197d65SBarry Smith     cnt  = 1;
9525a9f2f41SSatish Balay     while (ilink->next) {
9535a9f2f41SSatish Balay       ilink = ilink->next;
9543e197d65SBarry Smith       /* compute the residual only over the part of the vector needed */
9553e197d65SBarry Smith       ierr = MatMult(jac->Afield[cnt++],y,ilink->x);CHKERRQ(ierr);
9563e197d65SBarry Smith       ierr = VecScale(ilink->x,-1.0);CHKERRQ(ierr);
9573e197d65SBarry Smith       ierr = VecScatterBegin(ilink->sctx,x,ilink->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
9583e197d65SBarry Smith       ierr = VecScatterEnd(ilink->sctx,x,ilink->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
9593e197d65SBarry Smith       ierr = KSPSolve(ilink->ksp,ilink->x,ilink->y);CHKERRQ(ierr);
9603e197d65SBarry Smith       ierr = VecScatterBegin(ilink->sctx,ilink->y,y,ADD_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
9613e197d65SBarry Smith       ierr = VecScatterEnd(ilink->sctx,ilink->y,y,ADD_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
9623e197d65SBarry Smith     }
96351f519a2SBarry Smith     if (jac->type == PC_COMPOSITE_SYMMETRIC_MULTIPLICATIVE) {
96411755939SBarry Smith       cnt -= 2;
96551f519a2SBarry Smith       while (ilink->previous) {
96651f519a2SBarry Smith         ilink = ilink->previous;
96711755939SBarry Smith         /* compute the residual only over the part of the vector needed */
96811755939SBarry Smith         ierr = MatMult(jac->Afield[cnt--],y,ilink->x);CHKERRQ(ierr);
96911755939SBarry Smith         ierr = VecScale(ilink->x,-1.0);CHKERRQ(ierr);
97011755939SBarry Smith         ierr = VecScatterBegin(ilink->sctx,x,ilink->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
97111755939SBarry Smith         ierr = VecScatterEnd(ilink->sctx,x,ilink->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
97211755939SBarry Smith         ierr = KSPSolve(ilink->ksp,ilink->x,ilink->y);CHKERRQ(ierr);
97311755939SBarry Smith         ierr = VecScatterBegin(ilink->sctx,ilink->y,y,ADD_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
97411755939SBarry Smith         ierr = VecScatterEnd(ilink->sctx,ilink->y,y,ADD_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
97551f519a2SBarry Smith       }
97611755939SBarry Smith     }
977ce94432eSBarry Smith   } else SETERRQ1(PetscObjectComm((PetscObject)pc),PETSC_ERR_SUP,"Unsupported or unknown composition",(int) jac->type);
9780971522cSBarry Smith   PetscFunctionReturn(0);
9790971522cSBarry Smith }
9800971522cSBarry Smith 
981421e10b8SBarry Smith #define FieldSplitSplitSolveAddTranspose(ilink,xx,yy) \
982ca9f406cSSatish Balay   (VecScatterBegin(ilink->sctx,xx,ilink->y,INSERT_VALUES,SCATTER_FORWARD) || \
983ca9f406cSSatish Balay    VecScatterEnd(ilink->sctx,xx,ilink->y,INSERT_VALUES,SCATTER_FORWARD) || \
984421e10b8SBarry Smith    KSPSolveTranspose(ilink->ksp,ilink->y,ilink->x) || \
985ca9f406cSSatish Balay    VecScatterBegin(ilink->sctx,ilink->x,yy,ADD_VALUES,SCATTER_REVERSE) || \
986ca9f406cSSatish Balay    VecScatterEnd(ilink->sctx,ilink->x,yy,ADD_VALUES,SCATTER_REVERSE))
987421e10b8SBarry Smith 
988421e10b8SBarry Smith #undef __FUNCT__
9898c03b21aSDmitry Karpeev #define __FUNCT__ "PCApplyTranspose_FieldSplit"
990421e10b8SBarry Smith static PetscErrorCode PCApplyTranspose_FieldSplit(PC pc,Vec x,Vec y)
991421e10b8SBarry Smith {
992421e10b8SBarry Smith   PC_FieldSplit     *jac = (PC_FieldSplit*)pc->data;
993421e10b8SBarry Smith   PetscErrorCode    ierr;
994421e10b8SBarry Smith   PC_FieldSplitLink ilink = jac->head;
995939b8a20SBarry Smith   PetscInt          bs;
996421e10b8SBarry Smith 
997421e10b8SBarry Smith   PetscFunctionBegin;
998421e10b8SBarry Smith   if (jac->type == PC_COMPOSITE_ADDITIVE) {
999421e10b8SBarry Smith     if (jac->defaultsplit) {
1000939b8a20SBarry Smith       ierr = VecGetBlockSize(x,&bs);CHKERRQ(ierr);
1001ce94432eSBarry 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);
1002939b8a20SBarry Smith       ierr = VecGetBlockSize(y,&bs);CHKERRQ(ierr);
1003ce94432eSBarry 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);
1004421e10b8SBarry Smith       ierr = VecStrideGatherAll(x,jac->x,INSERT_VALUES);CHKERRQ(ierr);
1005421e10b8SBarry Smith       while (ilink) {
1006421e10b8SBarry Smith         ierr  = KSPSolveTranspose(ilink->ksp,ilink->x,ilink->y);CHKERRQ(ierr);
1007421e10b8SBarry Smith         ilink = ilink->next;
1008421e10b8SBarry Smith       }
1009421e10b8SBarry Smith       ierr = VecStrideScatterAll(jac->y,y,INSERT_VALUES);CHKERRQ(ierr);
1010421e10b8SBarry Smith     } else {
1011421e10b8SBarry Smith       ierr = VecSet(y,0.0);CHKERRQ(ierr);
1012421e10b8SBarry Smith       while (ilink) {
1013421e10b8SBarry Smith         ierr  = FieldSplitSplitSolveAddTranspose(ilink,x,y);CHKERRQ(ierr);
1014421e10b8SBarry Smith         ilink = ilink->next;
1015421e10b8SBarry Smith       }
1016421e10b8SBarry Smith     }
1017421e10b8SBarry Smith   } else {
1018421e10b8SBarry Smith     if (!jac->w1) {
1019421e10b8SBarry Smith       ierr = VecDuplicate(x,&jac->w1);CHKERRQ(ierr);
1020421e10b8SBarry Smith       ierr = VecDuplicate(x,&jac->w2);CHKERRQ(ierr);
1021421e10b8SBarry Smith     }
1022421e10b8SBarry Smith     ierr = VecSet(y,0.0);CHKERRQ(ierr);
1023421e10b8SBarry Smith     if (jac->type == PC_COMPOSITE_SYMMETRIC_MULTIPLICATIVE) {
1024421e10b8SBarry Smith       ierr = FieldSplitSplitSolveAddTranspose(ilink,x,y);CHKERRQ(ierr);
1025421e10b8SBarry Smith       while (ilink->next) {
1026421e10b8SBarry Smith         ilink = ilink->next;
10279989ab13SBarry Smith         ierr  = MatMultTranspose(pc->mat,y,jac->w1);CHKERRQ(ierr);
1028421e10b8SBarry Smith         ierr  = VecWAXPY(jac->w2,-1.0,jac->w1,x);CHKERRQ(ierr);
1029421e10b8SBarry Smith         ierr  = FieldSplitSplitSolveAddTranspose(ilink,jac->w2,y);CHKERRQ(ierr);
1030421e10b8SBarry Smith       }
1031421e10b8SBarry Smith       while (ilink->previous) {
1032421e10b8SBarry Smith         ilink = ilink->previous;
10339989ab13SBarry Smith         ierr  = MatMultTranspose(pc->mat,y,jac->w1);CHKERRQ(ierr);
1034421e10b8SBarry Smith         ierr  = VecWAXPY(jac->w2,-1.0,jac->w1,x);CHKERRQ(ierr);
1035421e10b8SBarry Smith         ierr  = FieldSplitSplitSolveAddTranspose(ilink,jac->w2,y);CHKERRQ(ierr);
1036421e10b8SBarry Smith       }
1037421e10b8SBarry Smith     } else {
1038421e10b8SBarry Smith       while (ilink->next) {   /* get to last entry in linked list */
1039421e10b8SBarry Smith         ilink = ilink->next;
1040421e10b8SBarry Smith       }
1041421e10b8SBarry Smith       ierr = FieldSplitSplitSolveAddTranspose(ilink,x,y);CHKERRQ(ierr);
1042421e10b8SBarry Smith       while (ilink->previous) {
1043421e10b8SBarry Smith         ilink = ilink->previous;
10449989ab13SBarry Smith         ierr  = MatMultTranspose(pc->mat,y,jac->w1);CHKERRQ(ierr);
1045421e10b8SBarry Smith         ierr  = VecWAXPY(jac->w2,-1.0,jac->w1,x);CHKERRQ(ierr);
1046421e10b8SBarry Smith         ierr  = FieldSplitSplitSolveAddTranspose(ilink,jac->w2,y);CHKERRQ(ierr);
1047421e10b8SBarry Smith       }
1048421e10b8SBarry Smith     }
1049421e10b8SBarry Smith   }
1050421e10b8SBarry Smith   PetscFunctionReturn(0);
1051421e10b8SBarry Smith }
1052421e10b8SBarry Smith 
10530971522cSBarry Smith #undef __FUNCT__
1054574deadeSBarry Smith #define __FUNCT__ "PCReset_FieldSplit"
1055574deadeSBarry Smith static PetscErrorCode PCReset_FieldSplit(PC pc)
10560971522cSBarry Smith {
10570971522cSBarry Smith   PC_FieldSplit     *jac = (PC_FieldSplit*)pc->data;
10580971522cSBarry Smith   PetscErrorCode    ierr;
10595a9f2f41SSatish Balay   PC_FieldSplitLink ilink = jac->head,next;
10600971522cSBarry Smith 
10610971522cSBarry Smith   PetscFunctionBegin;
10625a9f2f41SSatish Balay   while (ilink) {
1063574deadeSBarry Smith     ierr  = KSPReset(ilink->ksp);CHKERRQ(ierr);
1064fcfd50ebSBarry Smith     ierr  = VecDestroy(&ilink->x);CHKERRQ(ierr);
1065fcfd50ebSBarry Smith     ierr  = VecDestroy(&ilink->y);CHKERRQ(ierr);
1066443836d0SMatthew G Knepley     ierr  = VecDestroy(&ilink->z);CHKERRQ(ierr);
1067fcfd50ebSBarry Smith     ierr  = VecScatterDestroy(&ilink->sctx);CHKERRQ(ierr);
1068fcfd50ebSBarry Smith     ierr  = ISDestroy(&ilink->is);CHKERRQ(ierr);
1069b5787286SJed Brown     ierr  = ISDestroy(&ilink->is_col);CHKERRQ(ierr);
10705a9f2f41SSatish Balay     next  = ilink->next;
10715a9f2f41SSatish Balay     ilink = next;
10720971522cSBarry Smith   }
107305b42c5fSBarry Smith   ierr = PetscFree2(jac->x,jac->y);CHKERRQ(ierr);
1074574deadeSBarry Smith   if (jac->mat && jac->mat != jac->pmat) {
1075574deadeSBarry Smith     ierr = MatDestroyMatrices(jac->nsplits,&jac->mat);CHKERRQ(ierr);
1076574deadeSBarry Smith   } else if (jac->mat) {
10770298fd71SBarry Smith     jac->mat = NULL;
1078574deadeSBarry Smith   }
107997bbdb24SBarry Smith   if (jac->pmat) {ierr = MatDestroyMatrices(jac->nsplits,&jac->pmat);CHKERRQ(ierr);}
108068dd23aaSBarry Smith   if (jac->Afield) {ierr = MatDestroyMatrices(jac->nsplits,&jac->Afield);CHKERRQ(ierr);}
10816bf464f9SBarry Smith   ierr       = VecDestroy(&jac->w1);CHKERRQ(ierr);
10826bf464f9SBarry Smith   ierr       = VecDestroy(&jac->w2);CHKERRQ(ierr);
10836bf464f9SBarry Smith   ierr       = MatDestroy(&jac->schur);CHKERRQ(ierr);
1084a7476a74SDmitry Karpeev   ierr       = MatDestroy(&jac->schurp);CHKERRQ(ierr);
10856bf464f9SBarry Smith   ierr       = MatDestroy(&jac->schur_user);CHKERRQ(ierr);
10866bf464f9SBarry Smith   ierr       = KSPDestroy(&jac->kspschur);CHKERRQ(ierr);
1087d78dad28SBarry Smith   ierr       = KSPDestroy(&jac->kspupper);CHKERRQ(ierr);
10886bf464f9SBarry Smith   ierr       = MatDestroy(&jac->B);CHKERRQ(ierr);
10896bf464f9SBarry Smith   ierr       = MatDestroy(&jac->C);CHKERRQ(ierr);
109063ec74ffSBarry Smith   jac->reset = PETSC_TRUE;
1091574deadeSBarry Smith   PetscFunctionReturn(0);
1092574deadeSBarry Smith }
1093574deadeSBarry Smith 
1094574deadeSBarry Smith #undef __FUNCT__
1095574deadeSBarry Smith #define __FUNCT__ "PCDestroy_FieldSplit"
1096574deadeSBarry Smith static PetscErrorCode PCDestroy_FieldSplit(PC pc)
1097574deadeSBarry Smith {
1098574deadeSBarry Smith   PC_FieldSplit     *jac = (PC_FieldSplit*)pc->data;
1099574deadeSBarry Smith   PetscErrorCode    ierr;
1100574deadeSBarry Smith   PC_FieldSplitLink ilink = jac->head,next;
1101574deadeSBarry Smith 
1102574deadeSBarry Smith   PetscFunctionBegin;
1103574deadeSBarry Smith   ierr = PCReset_FieldSplit(pc);CHKERRQ(ierr);
1104574deadeSBarry Smith   while (ilink) {
11056bf464f9SBarry Smith     ierr  = KSPDestroy(&ilink->ksp);CHKERRQ(ierr);
1106574deadeSBarry Smith     next  = ilink->next;
1107574deadeSBarry Smith     ierr  = PetscFree(ilink->splitname);CHKERRQ(ierr);
1108574deadeSBarry Smith     ierr  = PetscFree(ilink->fields);CHKERRQ(ierr);
11095d4c12cdSJungho Lee     ierr  = PetscFree(ilink->fields_col);CHKERRQ(ierr);
1110574deadeSBarry Smith     ierr  = PetscFree(ilink);CHKERRQ(ierr);
1111574deadeSBarry Smith     ilink = next;
1112574deadeSBarry Smith   }
1113574deadeSBarry Smith   ierr = PetscFree2(jac->x,jac->y);CHKERRQ(ierr);
1114c31cb41cSBarry Smith   ierr = PetscFree(pc->data);CHKERRQ(ierr);
1115bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitGetSubKSP_C",NULL);CHKERRQ(ierr);
1116bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetFields_C",NULL);CHKERRQ(ierr);
1117bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetIS_C",NULL);CHKERRQ(ierr);
1118bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetType_C",NULL);CHKERRQ(ierr);
1119bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetBlockSize_C",NULL);CHKERRQ(ierr);
112029f8a81cSJed Brown   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetSchurPre_C",NULL);CHKERRQ(ierr);
112137a82bf0SJed Brown   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitGetSchurPre_C",NULL);CHKERRQ(ierr);
1122bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetSchurFactType_C",NULL);CHKERRQ(ierr);
11230971522cSBarry Smith   PetscFunctionReturn(0);
11240971522cSBarry Smith }
11250971522cSBarry Smith 
11260971522cSBarry Smith #undef __FUNCT__
11270971522cSBarry Smith #define __FUNCT__ "PCSetFromOptions_FieldSplit"
11280971522cSBarry Smith static PetscErrorCode PCSetFromOptions_FieldSplit(PC pc)
11290971522cSBarry Smith {
11301b9fc7fcSBarry Smith   PetscErrorCode  ierr;
11316c924f48SJed Brown   PetscInt        bs;
1132bc59fbc5SBarry Smith   PetscBool       flg,stokes = PETSC_FALSE;
11339dcbbd2bSBarry Smith   PC_FieldSplit   *jac = (PC_FieldSplit*)pc->data;
11343b224e63SBarry Smith   PCCompositeType ctype;
11351b9fc7fcSBarry Smith 
11360971522cSBarry Smith   PetscFunctionBegin;
11371b9fc7fcSBarry Smith   ierr = PetscOptionsHead("FieldSplit options");CHKERRQ(ierr);
11384ab8060aSDmitry Karpeev   ierr = PetscOptionsBool("-pc_fieldsplit_dm_splits","Whether to use DMCreateFieldDecomposition() for splits","PCFieldSplitSetDMSplits",jac->dm_splits,&jac->dm_splits,NULL);CHKERRQ(ierr);
113951f519a2SBarry Smith   ierr = PetscOptionsInt("-pc_fieldsplit_block_size","Blocksize that defines number of fields","PCFieldSplitSetBlockSize",jac->bs,&bs,&flg);CHKERRQ(ierr);
114051f519a2SBarry Smith   if (flg) {
114151f519a2SBarry Smith     ierr = PCFieldSplitSetBlockSize(pc,bs);CHKERRQ(ierr);
114251f519a2SBarry Smith   }
1143704ba839SBarry Smith 
11440298fd71SBarry Smith   ierr = PetscOptionsGetBool(((PetscObject)pc)->prefix,"-pc_fieldsplit_detect_saddle_point",&stokes,NULL);CHKERRQ(ierr);
1145c0adfefeSBarry Smith   if (stokes) {
1146c0adfefeSBarry Smith     ierr          = PCFieldSplitSetType(pc,PC_COMPOSITE_SCHUR);CHKERRQ(ierr);
1147c0adfefeSBarry Smith     jac->schurpre = PC_FIELDSPLIT_SCHUR_PRE_SELF;
1148c0adfefeSBarry Smith   }
1149c0adfefeSBarry Smith 
11503b224e63SBarry Smith   ierr = PetscOptionsEnum("-pc_fieldsplit_type","Type of composition","PCFieldSplitSetType",PCCompositeTypes,(PetscEnum)jac->type,(PetscEnum*)&ctype,&flg);CHKERRQ(ierr);
11513b224e63SBarry Smith   if (flg) {
11523b224e63SBarry Smith     ierr = PCFieldSplitSetType(pc,ctype);CHKERRQ(ierr);
11533b224e63SBarry Smith   }
1154c30613efSMatthew Knepley   /* Only setup fields once */
1155c30613efSMatthew Knepley   if ((jac->bs > 0) && (jac->nsplits == 0)) {
1156d32f9abdSBarry Smith     /* only allow user to set fields from command line if bs is already known.
1157d32f9abdSBarry Smith        otherwise user can set them in PCFieldSplitSetDefaults() */
11586c924f48SJed Brown     ierr = PCFieldSplitSetRuntimeSplits_Private(pc);CHKERRQ(ierr);
11596c924f48SJed Brown     if (jac->splitdefined) {ierr = PetscInfo(pc,"Splits defined using the options database\n");CHKERRQ(ierr);}
1160d32f9abdSBarry Smith   }
1161c5d2311dSJed Brown   if (jac->type == PC_COMPOSITE_SCHUR) {
1162c9c6ffaaSJed Brown     ierr = PetscOptionsGetEnum(((PetscObject)pc)->prefix,"-pc_fieldsplit_schur_factorization_type",PCFieldSplitSchurFactTypes,(PetscEnum*)&jac->schurfactorization,&flg);CHKERRQ(ierr);
1163c9c6ffaaSJed Brown     if (flg) {ierr = PetscInfo(pc,"Deprecated use of -pc_fieldsplit_schur_factorization_type\n");CHKERRQ(ierr);}
11640298fd71SBarry 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);
116529f8a81cSJed 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);
1166c5d2311dSJed Brown   }
11671b9fc7fcSBarry Smith   ierr = PetscOptionsTail();CHKERRQ(ierr);
11680971522cSBarry Smith   PetscFunctionReturn(0);
11690971522cSBarry Smith }
11700971522cSBarry Smith 
11710971522cSBarry Smith /*------------------------------------------------------------------------------------*/
11720971522cSBarry Smith 
11730971522cSBarry Smith #undef __FUNCT__
11740971522cSBarry Smith #define __FUNCT__ "PCFieldSplitSetFields_FieldSplit"
11751e6b0712SBarry Smith static PetscErrorCode  PCFieldSplitSetFields_FieldSplit(PC pc,const char splitname[],PetscInt n,const PetscInt *fields,const PetscInt *fields_col)
11760971522cSBarry Smith {
117797bbdb24SBarry Smith   PC_FieldSplit     *jac = (PC_FieldSplit*)pc->data;
11780971522cSBarry Smith   PetscErrorCode    ierr;
11795a9f2f41SSatish Balay   PC_FieldSplitLink ilink,next = jac->head;
118069a612a9SBarry Smith   char              prefix[128];
11815d4c12cdSJungho Lee   PetscInt          i;
11820971522cSBarry Smith 
11830971522cSBarry Smith   PetscFunctionBegin;
11846c924f48SJed Brown   if (jac->splitdefined) {
11856c924f48SJed Brown     ierr = PetscInfo1(pc,"Ignoring new split \"%s\" because the splits have already been defined\n",splitname);CHKERRQ(ierr);
11866c924f48SJed Brown     PetscFunctionReturn(0);
11876c924f48SJed Brown   }
118851f519a2SBarry Smith   for (i=0; i<n; i++) {
1189e32f2f54SBarry 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);
1190e32f2f54SBarry Smith     if (fields[i] < 0) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Negative field %D requested",fields[i]);
119151f519a2SBarry Smith   }
1192b00a9115SJed Brown   ierr = PetscNew(&ilink);CHKERRQ(ierr);
1193a04f6461SBarry Smith   if (splitname) {
1194db4c96c1SJed Brown     ierr = PetscStrallocpy(splitname,&ilink->splitname);CHKERRQ(ierr);
1195a04f6461SBarry Smith   } else {
1196785e854fSJed Brown     ierr = PetscMalloc1(3,&ilink->splitname);CHKERRQ(ierr);
1197a04f6461SBarry Smith     ierr = PetscSNPrintf(ilink->splitname,2,"%s",jac->nsplits);CHKERRQ(ierr);
1198a04f6461SBarry Smith   }
1199785e854fSJed Brown   ierr = PetscMalloc1(n,&ilink->fields);CHKERRQ(ierr);
12005a9f2f41SSatish Balay   ierr = PetscMemcpy(ilink->fields,fields,n*sizeof(PetscInt));CHKERRQ(ierr);
1201785e854fSJed Brown   ierr = PetscMalloc1(n,&ilink->fields_col);CHKERRQ(ierr);
12025d4c12cdSJungho Lee   ierr = PetscMemcpy(ilink->fields_col,fields_col,n*sizeof(PetscInt));CHKERRQ(ierr);
12032fa5cd67SKarl Rupp 
12045a9f2f41SSatish Balay   ilink->nfields = n;
12050298fd71SBarry Smith   ilink->next    = NULL;
1206ce94432eSBarry Smith   ierr           = KSPCreate(PetscObjectComm((PetscObject)pc),&ilink->ksp);CHKERRQ(ierr);
120720252d06SBarry Smith   ierr           = PetscObjectIncrementTabLevel((PetscObject)ilink->ksp,(PetscObject)pc,1);CHKERRQ(ierr);
12085a9f2f41SSatish Balay   ierr           = KSPSetType(ilink->ksp,KSPPREONLY);CHKERRQ(ierr);
12099005cf84SBarry Smith   ierr           = PetscLogObjectParent((PetscObject)pc,(PetscObject)ilink->ksp);CHKERRQ(ierr);
121069a612a9SBarry Smith 
12118caf3d72SBarry Smith   ierr = PetscSNPrintf(prefix,sizeof(prefix),"%sfieldsplit_%s_",((PetscObject)pc)->prefix ? ((PetscObject)pc)->prefix : "",ilink->splitname);CHKERRQ(ierr);
12125a9f2f41SSatish Balay   ierr = KSPSetOptionsPrefix(ilink->ksp,prefix);CHKERRQ(ierr);
12130971522cSBarry Smith 
12140971522cSBarry Smith   if (!next) {
12155a9f2f41SSatish Balay     jac->head       = ilink;
12160298fd71SBarry Smith     ilink->previous = NULL;
12170971522cSBarry Smith   } else {
12180971522cSBarry Smith     while (next->next) {
12190971522cSBarry Smith       next = next->next;
12200971522cSBarry Smith     }
12215a9f2f41SSatish Balay     next->next      = ilink;
122251f519a2SBarry Smith     ilink->previous = next;
12230971522cSBarry Smith   }
12240971522cSBarry Smith   jac->nsplits++;
12250971522cSBarry Smith   PetscFunctionReturn(0);
12260971522cSBarry Smith }
12270971522cSBarry Smith 
1228e69d4d44SBarry Smith #undef __FUNCT__
1229e69d4d44SBarry Smith #define __FUNCT__ "PCFieldSplitGetSubKSP_FieldSplit_Schur"
12301e6b0712SBarry Smith static PetscErrorCode  PCFieldSplitGetSubKSP_FieldSplit_Schur(PC pc,PetscInt *n,KSP **subksp)
1231e69d4d44SBarry Smith {
1232e69d4d44SBarry Smith   PC_FieldSplit  *jac = (PC_FieldSplit*)pc->data;
1233e69d4d44SBarry Smith   PetscErrorCode ierr;
1234e69d4d44SBarry Smith 
1235e69d4d44SBarry Smith   PetscFunctionBegin;
1236785e854fSJed Brown   ierr = PetscMalloc1(jac->nsplits,subksp);CHKERRQ(ierr);
1237e69d4d44SBarry Smith   ierr = MatSchurComplementGetKSP(jac->schur,*subksp);CHKERRQ(ierr);
12382fa5cd67SKarl Rupp 
1239e69d4d44SBarry Smith   (*subksp)[1] = jac->kspschur;
124013e0d083SBarry Smith   if (n) *n = jac->nsplits;
1241e69d4d44SBarry Smith   PetscFunctionReturn(0);
1242e69d4d44SBarry Smith }
12430971522cSBarry Smith 
12440971522cSBarry Smith #undef __FUNCT__
124569a612a9SBarry Smith #define __FUNCT__ "PCFieldSplitGetSubKSP_FieldSplit"
12461e6b0712SBarry Smith static PetscErrorCode  PCFieldSplitGetSubKSP_FieldSplit(PC pc,PetscInt *n,KSP **subksp)
12470971522cSBarry Smith {
12480971522cSBarry Smith   PC_FieldSplit     *jac = (PC_FieldSplit*)pc->data;
12490971522cSBarry Smith   PetscErrorCode    ierr;
12500971522cSBarry Smith   PetscInt          cnt   = 0;
12515a9f2f41SSatish Balay   PC_FieldSplitLink ilink = jac->head;
12520971522cSBarry Smith 
12530971522cSBarry Smith   PetscFunctionBegin;
1254785e854fSJed Brown   ierr = PetscMalloc1(jac->nsplits,subksp);CHKERRQ(ierr);
12555a9f2f41SSatish Balay   while (ilink) {
12565a9f2f41SSatish Balay     (*subksp)[cnt++] = ilink->ksp;
12575a9f2f41SSatish Balay     ilink            = ilink->next;
12580971522cSBarry Smith   }
12595d480477SMatthew 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);
126013e0d083SBarry Smith   if (n) *n = jac->nsplits;
12610971522cSBarry Smith   PetscFunctionReturn(0);
12620971522cSBarry Smith }
12630971522cSBarry Smith 
1264704ba839SBarry Smith #undef __FUNCT__
1265704ba839SBarry Smith #define __FUNCT__ "PCFieldSplitSetIS_FieldSplit"
12661e6b0712SBarry Smith static PetscErrorCode  PCFieldSplitSetIS_FieldSplit(PC pc,const char splitname[],IS is)
1267704ba839SBarry Smith {
1268704ba839SBarry Smith   PC_FieldSplit     *jac = (PC_FieldSplit*)pc->data;
1269704ba839SBarry Smith   PetscErrorCode    ierr;
1270704ba839SBarry Smith   PC_FieldSplitLink ilink, next = jac->head;
1271704ba839SBarry Smith   char              prefix[128];
1272704ba839SBarry Smith 
1273704ba839SBarry Smith   PetscFunctionBegin;
12746c924f48SJed Brown   if (jac->splitdefined) {
12756c924f48SJed Brown     ierr = PetscInfo1(pc,"Ignoring new split \"%s\" because the splits have already been defined\n",splitname);CHKERRQ(ierr);
12766c924f48SJed Brown     PetscFunctionReturn(0);
12776c924f48SJed Brown   }
1278b00a9115SJed Brown   ierr = PetscNew(&ilink);CHKERRQ(ierr);
1279a04f6461SBarry Smith   if (splitname) {
1280db4c96c1SJed Brown     ierr = PetscStrallocpy(splitname,&ilink->splitname);CHKERRQ(ierr);
1281a04f6461SBarry Smith   } else {
1282785e854fSJed Brown     ierr = PetscMalloc1(8,&ilink->splitname);CHKERRQ(ierr);
1283b5787286SJed Brown     ierr = PetscSNPrintf(ilink->splitname,7,"%D",jac->nsplits);CHKERRQ(ierr);
1284a04f6461SBarry Smith   }
12851ab39975SBarry Smith   ierr          = PetscObjectReference((PetscObject)is);CHKERRQ(ierr);
1286b5787286SJed Brown   ierr          = ISDestroy(&ilink->is);CHKERRQ(ierr);
1287b5787286SJed Brown   ilink->is     = is;
1288b5787286SJed Brown   ierr          = PetscObjectReference((PetscObject)is);CHKERRQ(ierr);
1289b5787286SJed Brown   ierr          = ISDestroy(&ilink->is_col);CHKERRQ(ierr);
1290b5787286SJed Brown   ilink->is_col = is;
12910298fd71SBarry Smith   ilink->next   = NULL;
1292ce94432eSBarry Smith   ierr          = KSPCreate(PetscObjectComm((PetscObject)pc),&ilink->ksp);CHKERRQ(ierr);
129320252d06SBarry Smith   ierr          = PetscObjectIncrementTabLevel((PetscObject)ilink->ksp,(PetscObject)pc,1);CHKERRQ(ierr);
1294704ba839SBarry Smith   ierr          = KSPSetType(ilink->ksp,KSPPREONLY);CHKERRQ(ierr);
12959005cf84SBarry Smith   ierr          = PetscLogObjectParent((PetscObject)pc,(PetscObject)ilink->ksp);CHKERRQ(ierr);
1296704ba839SBarry Smith 
12978caf3d72SBarry Smith   ierr = PetscSNPrintf(prefix,sizeof(prefix),"%sfieldsplit_%s_",((PetscObject)pc)->prefix ? ((PetscObject)pc)->prefix : "",ilink->splitname);CHKERRQ(ierr);
1298704ba839SBarry Smith   ierr = KSPSetOptionsPrefix(ilink->ksp,prefix);CHKERRQ(ierr);
1299704ba839SBarry Smith 
1300704ba839SBarry Smith   if (!next) {
1301704ba839SBarry Smith     jac->head       = ilink;
13020298fd71SBarry Smith     ilink->previous = NULL;
1303704ba839SBarry Smith   } else {
1304704ba839SBarry Smith     while (next->next) {
1305704ba839SBarry Smith       next = next->next;
1306704ba839SBarry Smith     }
1307704ba839SBarry Smith     next->next      = ilink;
1308704ba839SBarry Smith     ilink->previous = next;
1309704ba839SBarry Smith   }
1310704ba839SBarry Smith   jac->nsplits++;
1311704ba839SBarry Smith   PetscFunctionReturn(0);
1312704ba839SBarry Smith }
1313704ba839SBarry Smith 
13140971522cSBarry Smith #undef __FUNCT__
13150971522cSBarry Smith #define __FUNCT__ "PCFieldSplitSetFields"
13160971522cSBarry Smith /*@
13170971522cSBarry Smith     PCFieldSplitSetFields - Sets the fields for one particular split in the field split preconditioner
13180971522cSBarry Smith 
1319ad4df100SBarry Smith     Logically Collective on PC
13200971522cSBarry Smith 
13210971522cSBarry Smith     Input Parameters:
13220971522cSBarry Smith +   pc  - the preconditioner context
13230298fd71SBarry Smith .   splitname - name of this split, if NULL the number of the split is used
13240971522cSBarry Smith .   n - the number of fields in this split
1325db4c96c1SJed Brown -   fields - the fields in this split
13260971522cSBarry Smith 
13270971522cSBarry Smith     Level: intermediate
13280971522cSBarry Smith 
1329d32f9abdSBarry Smith     Notes: Use PCFieldSplitSetIS() to set a completely general set of indices as a field.
1330d32f9abdSBarry Smith 
13317287d2a3SDmitry Karpeev      The PCFieldSplitSetFields() is for defining fields as strided blocks. For example, if the block
1332d32f9abdSBarry 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
1333d32f9abdSBarry Smith      0xx3xx6xx9xx12 ... x1xx4xx7xx ... xx2xx5xx8xx.. 01x34x67x... 0x1x3x5x7.. x12x45x78x....
1334d32f9abdSBarry Smith      where the numbered entries indicate what is in the field.
1335d32f9abdSBarry Smith 
1336db4c96c1SJed Brown      This function is called once per split (it creates a new split each time).  Solve options
1337db4c96c1SJed Brown      for this split will be available under the prefix -fieldsplit_SPLITNAME_.
1338db4c96c1SJed Brown 
13395d4c12cdSJungho Lee      Developer Note: This routine does not actually create the IS representing the split, that is delayed
13405d4c12cdSJungho Lee      until PCSetUp_FieldSplit(), because information about the vector/matrix layouts may not be
13415d4c12cdSJungho Lee      available when this routine is called.
13425d4c12cdSJungho Lee 
1343d32f9abdSBarry Smith .seealso: PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitSetBlockSize(), PCFieldSplitSetIS()
13440971522cSBarry Smith 
13450971522cSBarry Smith @*/
13465d4c12cdSJungho Lee PetscErrorCode  PCFieldSplitSetFields(PC pc,const char splitname[],PetscInt n,const PetscInt *fields,const PetscInt *fields_col)
13470971522cSBarry Smith {
13484ac538c5SBarry Smith   PetscErrorCode ierr;
13490971522cSBarry Smith 
13500971522cSBarry Smith   PetscFunctionBegin;
13510700a824SBarry Smith   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
1352db4c96c1SJed Brown   PetscValidCharPointer(splitname,2);
1353ce94432eSBarry Smith   if (n < 1) SETERRQ2(PetscObjectComm((PetscObject)pc),PETSC_ERR_ARG_OUTOFRANGE,"Provided number of fields %D in split \"%s\" not positive",n,splitname);
1354db4c96c1SJed Brown   PetscValidIntPointer(fields,3);
13555d4c12cdSJungho Lee   ierr = PetscTryMethod(pc,"PCFieldSplitSetFields_C",(PC,const char[],PetscInt,const PetscInt*,const PetscInt*),(pc,splitname,n,fields,fields_col));CHKERRQ(ierr);
13560971522cSBarry Smith   PetscFunctionReturn(0);
13570971522cSBarry Smith }
13580971522cSBarry Smith 
13590971522cSBarry Smith #undef __FUNCT__
1360704ba839SBarry Smith #define __FUNCT__ "PCFieldSplitSetIS"
1361704ba839SBarry Smith /*@
1362704ba839SBarry Smith     PCFieldSplitSetIS - Sets the exact elements for field
1363704ba839SBarry Smith 
1364ad4df100SBarry Smith     Logically Collective on PC
1365704ba839SBarry Smith 
1366704ba839SBarry Smith     Input Parameters:
1367704ba839SBarry Smith +   pc  - the preconditioner context
13680298fd71SBarry Smith .   splitname - name of this split, if NULL the number of the split is used
1369db4c96c1SJed Brown -   is - the index set that defines the vector elements in this field
1370704ba839SBarry Smith 
1371d32f9abdSBarry Smith 
1372a6ffb8dbSJed Brown     Notes:
1373a6ffb8dbSJed Brown     Use PCFieldSplitSetFields(), for fields defined by strided types.
1374a6ffb8dbSJed Brown 
1375db4c96c1SJed Brown     This function is called once per split (it creates a new split each time).  Solve options
1376db4c96c1SJed Brown     for this split will be available under the prefix -fieldsplit_SPLITNAME_.
1377d32f9abdSBarry Smith 
1378704ba839SBarry Smith     Level: intermediate
1379704ba839SBarry Smith 
1380704ba839SBarry Smith .seealso: PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitSetBlockSize()
1381704ba839SBarry Smith 
1382704ba839SBarry Smith @*/
13837087cfbeSBarry Smith PetscErrorCode  PCFieldSplitSetIS(PC pc,const char splitname[],IS is)
1384704ba839SBarry Smith {
13854ac538c5SBarry Smith   PetscErrorCode ierr;
1386704ba839SBarry Smith 
1387704ba839SBarry Smith   PetscFunctionBegin;
13880700a824SBarry Smith   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
13897b62db95SJungho Lee   if (splitname) PetscValidCharPointer(splitname,2);
1390db4c96c1SJed Brown   PetscValidHeaderSpecific(is,IS_CLASSID,3);
13914ac538c5SBarry Smith   ierr = PetscTryMethod(pc,"PCFieldSplitSetIS_C",(PC,const char[],IS),(pc,splitname,is));CHKERRQ(ierr);
1392704ba839SBarry Smith   PetscFunctionReturn(0);
1393704ba839SBarry Smith }
1394704ba839SBarry Smith 
1395704ba839SBarry Smith #undef __FUNCT__
139657a9adfeSMatthew G Knepley #define __FUNCT__ "PCFieldSplitGetIS"
139757a9adfeSMatthew G Knepley /*@
139857a9adfeSMatthew G Knepley     PCFieldSplitGetIS - Retrieves the elements for a field as an IS
139957a9adfeSMatthew G Knepley 
140057a9adfeSMatthew G Knepley     Logically Collective on PC
140157a9adfeSMatthew G Knepley 
140257a9adfeSMatthew G Knepley     Input Parameters:
140357a9adfeSMatthew G Knepley +   pc  - the preconditioner context
140457a9adfeSMatthew G Knepley -   splitname - name of this split
140557a9adfeSMatthew G Knepley 
140657a9adfeSMatthew G Knepley     Output Parameter:
14070298fd71SBarry Smith -   is - the index set that defines the vector elements in this field, or NULL if the field is not found
140857a9adfeSMatthew G Knepley 
140957a9adfeSMatthew G Knepley     Level: intermediate
141057a9adfeSMatthew G Knepley 
141157a9adfeSMatthew G Knepley .seealso: PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitSetIS()
141257a9adfeSMatthew G Knepley 
141357a9adfeSMatthew G Knepley @*/
141457a9adfeSMatthew G Knepley PetscErrorCode PCFieldSplitGetIS(PC pc,const char splitname[],IS *is)
141557a9adfeSMatthew G Knepley {
141657a9adfeSMatthew G Knepley   PetscErrorCode ierr;
141757a9adfeSMatthew G Knepley 
141857a9adfeSMatthew G Knepley   PetscFunctionBegin;
141957a9adfeSMatthew G Knepley   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
142057a9adfeSMatthew G Knepley   PetscValidCharPointer(splitname,2);
142157a9adfeSMatthew G Knepley   PetscValidPointer(is,3);
142257a9adfeSMatthew G Knepley   {
142357a9adfeSMatthew G Knepley     PC_FieldSplit     *jac  = (PC_FieldSplit*) pc->data;
142457a9adfeSMatthew G Knepley     PC_FieldSplitLink ilink = jac->head;
142557a9adfeSMatthew G Knepley     PetscBool         found;
142657a9adfeSMatthew G Knepley 
14270298fd71SBarry Smith     *is = NULL;
142857a9adfeSMatthew G Knepley     while (ilink) {
142957a9adfeSMatthew G Knepley       ierr = PetscStrcmp(ilink->splitname, splitname, &found);CHKERRQ(ierr);
143057a9adfeSMatthew G Knepley       if (found) {
143157a9adfeSMatthew G Knepley         *is = ilink->is;
143257a9adfeSMatthew G Knepley         break;
143357a9adfeSMatthew G Knepley       }
143457a9adfeSMatthew G Knepley       ilink = ilink->next;
143557a9adfeSMatthew G Knepley     }
143657a9adfeSMatthew G Knepley   }
143757a9adfeSMatthew G Knepley   PetscFunctionReturn(0);
143857a9adfeSMatthew G Knepley }
143957a9adfeSMatthew G Knepley 
144057a9adfeSMatthew G Knepley #undef __FUNCT__
144151f519a2SBarry Smith #define __FUNCT__ "PCFieldSplitSetBlockSize"
144251f519a2SBarry Smith /*@
144351f519a2SBarry Smith     PCFieldSplitSetBlockSize - Sets the block size for defining where fields start in the
144451f519a2SBarry Smith       fieldsplit preconditioner. If not set the matrix block size is used.
144551f519a2SBarry Smith 
1446ad4df100SBarry Smith     Logically Collective on PC
144751f519a2SBarry Smith 
144851f519a2SBarry Smith     Input Parameters:
144951f519a2SBarry Smith +   pc  - the preconditioner context
145051f519a2SBarry Smith -   bs - the block size
145151f519a2SBarry Smith 
145251f519a2SBarry Smith     Level: intermediate
145351f519a2SBarry Smith 
145451f519a2SBarry Smith .seealso: PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitSetFields()
145551f519a2SBarry Smith 
145651f519a2SBarry Smith @*/
14577087cfbeSBarry Smith PetscErrorCode  PCFieldSplitSetBlockSize(PC pc,PetscInt bs)
145851f519a2SBarry Smith {
14594ac538c5SBarry Smith   PetscErrorCode ierr;
146051f519a2SBarry Smith 
146151f519a2SBarry Smith   PetscFunctionBegin;
14620700a824SBarry Smith   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
1463c5eb9154SBarry Smith   PetscValidLogicalCollectiveInt(pc,bs,2);
14644ac538c5SBarry Smith   ierr = PetscTryMethod(pc,"PCFieldSplitSetBlockSize_C",(PC,PetscInt),(pc,bs));CHKERRQ(ierr);
146551f519a2SBarry Smith   PetscFunctionReturn(0);
146651f519a2SBarry Smith }
146751f519a2SBarry Smith 
146851f519a2SBarry Smith #undef __FUNCT__
146969a612a9SBarry Smith #define __FUNCT__ "PCFieldSplitGetSubKSP"
14700971522cSBarry Smith /*@C
147169a612a9SBarry Smith    PCFieldSplitGetSubKSP - Gets the KSP contexts for all splits
14720971522cSBarry Smith 
147369a612a9SBarry Smith    Collective on KSP
14740971522cSBarry Smith 
14750971522cSBarry Smith    Input Parameter:
14760971522cSBarry Smith .  pc - the preconditioner context
14770971522cSBarry Smith 
14780971522cSBarry Smith    Output Parameters:
147913e0d083SBarry Smith +  n - the number of splits
148069a612a9SBarry Smith -  pc - the array of KSP contexts
14810971522cSBarry Smith 
14820971522cSBarry Smith    Note:
1483d32f9abdSBarry Smith    After PCFieldSplitGetSubKSP() the array of KSPs IS to be freed by the user
1484d32f9abdSBarry Smith    (not the KSP just the array that contains them).
14850971522cSBarry Smith 
148669a612a9SBarry Smith    You must call KSPSetUp() before calling PCFieldSplitGetSubKSP().
14870971522cSBarry Smith 
1488196cc216SBarry Smith    Fortran Usage: You must pass in a KSP array that is large enough to contain all the local KSPs.
14890298fd71SBarry Smith       You can call PCFieldSplitGetSubKSP(pc,n,NULL_OBJECT,ierr) to determine how large the
1490196cc216SBarry Smith       KSP array must be.
1491196cc216SBarry Smith 
1492196cc216SBarry Smith 
14930971522cSBarry Smith    Level: advanced
14940971522cSBarry Smith 
14950971522cSBarry Smith .seealso: PCFIELDSPLIT
14960971522cSBarry Smith @*/
14977087cfbeSBarry Smith PetscErrorCode  PCFieldSplitGetSubKSP(PC pc,PetscInt *n,KSP *subksp[])
14980971522cSBarry Smith {
14994ac538c5SBarry Smith   PetscErrorCode ierr;
15000971522cSBarry Smith 
15010971522cSBarry Smith   PetscFunctionBegin;
15020700a824SBarry Smith   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
150313e0d083SBarry Smith   if (n) PetscValidIntPointer(n,2);
15044ac538c5SBarry Smith   ierr = PetscUseMethod(pc,"PCFieldSplitGetSubKSP_C",(PC,PetscInt*,KSP **),(pc,n,subksp));CHKERRQ(ierr);
15050971522cSBarry Smith   PetscFunctionReturn(0);
15060971522cSBarry Smith }
15070971522cSBarry Smith 
1508e69d4d44SBarry Smith #undef __FUNCT__
150929f8a81cSJed Brown #define __FUNCT__ "PCFieldSplitSetSchurPre"
1510e69d4d44SBarry Smith /*@
151129f8a81cSJed Brown     PCFieldSplitSetSchurPre -  Indicates if the Schur complement is preconditioned by a preconditioner constructed by the
1512a04f6461SBarry Smith       A11 matrix. Otherwise no preconditioner is used.
1513e69d4d44SBarry Smith 
1514e69d4d44SBarry Smith     Collective on PC
1515e69d4d44SBarry Smith 
1516e69d4d44SBarry Smith     Input Parameters:
1517e69d4d44SBarry Smith +   pc      - the preconditioner context
1518a7476a74SDmitry 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
15190298fd71SBarry Smith -   userpre - matrix to use for preconditioning, or NULL
1520084e4875SJed Brown 
1521e69d4d44SBarry Smith     Options Database:
15222e71c61dSMatthew G. Knepley .     -pc_fieldsplit_schur_precondition <self,selfp,user,a11,full> default is a11
1523e69d4d44SBarry Smith 
1524fd1303e9SJungho Lee     Notes:
1525fd1303e9SJungho Lee $    If ptype is
1526fd1303e9SJungho Lee $        user then the preconditioner for the Schur complement is generated by the provided matrix (pre argument
1527fd1303e9SJungho Lee $             to this function).
1528e87fab1bSBarry Smith $        a11 then the preconditioner for the Schur complement is generated by the block diagonal part of the original
1529fd1303e9SJungho Lee $             matrix associated with the Schur complement (i.e. A11)
1530e74569cdSMatthew G. Knepley $        full then the preconditioner uses the exact Schur complement (this is expensive)
1531fd1303e9SJungho Lee $        self the preconditioner for the Schur complement is generated from the Schur complement matrix itself:
1532fd1303e9SJungho Lee $             The only preconditioner that currently works directly with the Schur complement matrix object is the PCLSC
1533fd1303e9SJungho Lee $             preconditioner
1534a7476a74SDmitry Karpeev $        selfp then the preconditioning matrix is an explicitly-assembled approximation Sp = A11 - A10 inv(diag(A00)) A01
1535a7476a74SDmitry Karpeev $             This is only a good preconditioner when diag(A00) is a good preconditioner for A00.
1536fd1303e9SJungho Lee 
1537e87fab1bSBarry Smith      When solving a saddle point problem, where the A11 block is identically zero, using a11 as the ptype only makes sense
1538fd1303e9SJungho Lee     with the additional option -fieldsplit_1_pc_type none. Usually for saddle point problems one would use a ptype of self and
1539a7476a74SDmitry Karpeev     -fieldsplit_1_pc_type lsc which uses the least squares commutator to compute a preconditioner for the Schur complement.
1540fd1303e9SJungho Lee 
1541e69d4d44SBarry Smith     Level: intermediate
1542e69d4d44SBarry Smith 
154337a82bf0SJed Brown .seealso: PCFieldSplitGetSchurPre(), PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitSetFields(), PCFieldSplitSchurPreType, PCLSC
1544e69d4d44SBarry Smith 
1545e69d4d44SBarry Smith @*/
154629f8a81cSJed Brown PetscErrorCode PCFieldSplitSetSchurPre(PC pc,PCFieldSplitSchurPreType ptype,Mat pre)
1547e69d4d44SBarry Smith {
15484ac538c5SBarry Smith   PetscErrorCode ierr;
1549e69d4d44SBarry Smith 
1550e69d4d44SBarry Smith   PetscFunctionBegin;
15510700a824SBarry Smith   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
155229f8a81cSJed Brown   ierr = PetscTryMethod(pc,"PCFieldSplitSetSchurPre_C",(PC,PCFieldSplitSchurPreType,Mat),(pc,ptype,pre));CHKERRQ(ierr);
1553e69d4d44SBarry Smith   PetscFunctionReturn(0);
1554e69d4d44SBarry Smith }
155529f8a81cSJed Brown PetscErrorCode PCFieldSplitSchurPrecondition(PC pc,PCFieldSplitSchurPreType ptype,Mat pre) {return PCFieldSplitSetSchurPre(pc,ptype,pre);} /* Deprecated name */
1556e69d4d44SBarry Smith 
1557e69d4d44SBarry Smith #undef __FUNCT__
155837a82bf0SJed Brown #define __FUNCT__ "PCFieldSplitGetSchurPre"
155937a82bf0SJed Brown /*@
156037a82bf0SJed Brown     PCFieldSplitGetSchurPre - For Schur complement fieldsplit, determine how the Schur complement will be
156129f8a81cSJed Brown     preconditioned.  See PCFieldSplitSetSchurPre() for details.
156237a82bf0SJed Brown 
156337a82bf0SJed Brown     Logically Collective on PC
156437a82bf0SJed Brown 
156537a82bf0SJed Brown     Input Parameters:
156637a82bf0SJed Brown .   pc      - the preconditioner context
156737a82bf0SJed Brown 
156837a82bf0SJed Brown     Output Parameters:
156937a82bf0SJed 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
157037a82bf0SJed Brown -   userpre - matrix to use for preconditioning (with PC_FIELDSPLIT_PRE_USER), or NULL
157137a82bf0SJed Brown 
157237a82bf0SJed Brown     Level: intermediate
157337a82bf0SJed Brown 
157429f8a81cSJed Brown .seealso: PCFieldSplitSetSchurPre(), PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitSetFields(), PCFieldSplitSchurPreType, PCLSC
157537a82bf0SJed Brown 
157637a82bf0SJed Brown @*/
157737a82bf0SJed Brown PetscErrorCode PCFieldSplitGetSchurPre(PC pc,PCFieldSplitSchurPreType *ptype,Mat *pre)
157837a82bf0SJed Brown {
157937a82bf0SJed Brown   PetscErrorCode ierr;
158037a82bf0SJed Brown 
158137a82bf0SJed Brown   PetscFunctionBegin;
158237a82bf0SJed Brown   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
158337a82bf0SJed Brown   ierr = PetscUseMethod(pc,"PCFieldSplitGetSchurPre_C",(PC,PCFieldSplitSchurPreType*,Mat*),(pc,ptype,pre));CHKERRQ(ierr);
1584e69d4d44SBarry Smith   PetscFunctionReturn(0);
1585e69d4d44SBarry Smith }
1586e69d4d44SBarry Smith 
1587e69d4d44SBarry Smith #undef __FUNCT__
1588470b340bSDmitry Karpeev #define __FUNCT__ "PCFieldSplitSchurGetS"
158945e7fc46SDmitry Karpeev /*@
1590470b340bSDmitry Karpeev     PCFieldSplitSchurGetS -  extract the MatSchurComplement object used by this PC in case it needs to be configured separately
159145e7fc46SDmitry Karpeev 
159245e7fc46SDmitry Karpeev     Not collective
159345e7fc46SDmitry Karpeev 
159445e7fc46SDmitry Karpeev     Input Parameter:
159545e7fc46SDmitry Karpeev .   pc      - the preconditioner context
159645e7fc46SDmitry Karpeev 
159745e7fc46SDmitry Karpeev     Output Parameter:
1598470b340bSDmitry Karpeev .   S       - the Schur complement matrix
159945e7fc46SDmitry Karpeev 
1600470b340bSDmitry Karpeev     Notes:
1601470b340bSDmitry Karpeev     This matrix should not be destroyed using MatDestroy(); rather, use PCFieldSplitSchurRestoreS().
160245e7fc46SDmitry Karpeev 
160345e7fc46SDmitry Karpeev     Level: advanced
160445e7fc46SDmitry Karpeev 
160529f8a81cSJed Brown .seealso: PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitSchurPreType, PCFieldSplitSetSchurPre(), MatSchurComplement, PCFieldSplitSchurRestoreS()
160645e7fc46SDmitry Karpeev 
160745e7fc46SDmitry Karpeev @*/
1608470b340bSDmitry Karpeev PetscErrorCode  PCFieldSplitSchurGetS(PC pc,Mat *S)
160945e7fc46SDmitry Karpeev {
161045e7fc46SDmitry Karpeev   PetscErrorCode ierr;
161145e7fc46SDmitry Karpeev   const char*    t;
161245e7fc46SDmitry Karpeev   PetscBool      isfs;
161345e7fc46SDmitry Karpeev   PC_FieldSplit  *jac;
161445e7fc46SDmitry Karpeev 
161545e7fc46SDmitry Karpeev   PetscFunctionBegin;
161645e7fc46SDmitry Karpeev   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
161745e7fc46SDmitry Karpeev   ierr = PetscObjectGetType((PetscObject)pc,&t);CHKERRQ(ierr);
161845e7fc46SDmitry Karpeev   ierr = PetscStrcmp(t,PCFIELDSPLIT,&isfs);CHKERRQ(ierr);
161945e7fc46SDmitry Karpeev   if (!isfs) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Expected PC of type PCFIELDSPLIT, got %s instead",t);
162045e7fc46SDmitry Karpeev   jac = (PC_FieldSplit*)pc->data;
1621470b340bSDmitry 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);
1622470b340bSDmitry Karpeev   if (S) *S = jac->schur;
162345e7fc46SDmitry Karpeev   PetscFunctionReturn(0);
162445e7fc46SDmitry Karpeev }
162545e7fc46SDmitry Karpeev 
162645e7fc46SDmitry Karpeev #undef __FUNCT__
1627470b340bSDmitry Karpeev #define __FUNCT__ "PCFieldSplitSchurRestoreS"
1628470b340bSDmitry Karpeev /*@
1629470b340bSDmitry Karpeev     PCFieldSplitSchurRestoreS -  restores the MatSchurComplement object used by this PC
1630470b340bSDmitry Karpeev 
1631470b340bSDmitry Karpeev     Not collective
1632470b340bSDmitry Karpeev 
1633470b340bSDmitry Karpeev     Input Parameters:
1634470b340bSDmitry Karpeev +   pc      - the preconditioner context
1635470b340bSDmitry Karpeev .   S       - the Schur complement matrix
1636470b340bSDmitry Karpeev 
1637470b340bSDmitry Karpeev     Level: advanced
1638470b340bSDmitry Karpeev 
163929f8a81cSJed Brown .seealso: PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitSchurPreType, PCFieldSplitSetSchurPre(), MatSchurComplement, PCFieldSplitSchurGetS()
1640470b340bSDmitry Karpeev 
1641470b340bSDmitry Karpeev @*/
1642bca69d2bSDmitry Karpeev PetscErrorCode  PCFieldSplitSchurRestoreS(PC pc,Mat *S)
1643470b340bSDmitry Karpeev {
1644470b340bSDmitry Karpeev   PetscErrorCode ierr;
1645470b340bSDmitry Karpeev   const char*    t;
1646470b340bSDmitry Karpeev   PetscBool      isfs;
1647470b340bSDmitry Karpeev   PC_FieldSplit  *jac;
1648470b340bSDmitry Karpeev 
1649470b340bSDmitry Karpeev   PetscFunctionBegin;
1650470b340bSDmitry Karpeev   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
1651470b340bSDmitry Karpeev   ierr = PetscObjectGetType((PetscObject)pc,&t);CHKERRQ(ierr);
1652470b340bSDmitry Karpeev   ierr = PetscStrcmp(t,PCFIELDSPLIT,&isfs);CHKERRQ(ierr);
1653470b340bSDmitry Karpeev   if (!isfs) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Expected PC of type PCFIELDSPLIT, got %s instead",t);
1654470b340bSDmitry Karpeev   jac = (PC_FieldSplit*)pc->data;
1655470b340bSDmitry 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);
1656bca69d2bSDmitry Karpeev   if (!S || *S != jac->schur) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"MatSchurComplement restored is not the same as gotten");
1657470b340bSDmitry Karpeev   PetscFunctionReturn(0);
1658470b340bSDmitry Karpeev }
1659470b340bSDmitry Karpeev 
1660470b340bSDmitry Karpeev 
1661470b340bSDmitry Karpeev #undef __FUNCT__
166229f8a81cSJed Brown #define __FUNCT__ "PCFieldSplitSetSchurPre_FieldSplit"
166329f8a81cSJed Brown static PetscErrorCode  PCFieldSplitSetSchurPre_FieldSplit(PC pc,PCFieldSplitSchurPreType ptype,Mat pre)
1664e69d4d44SBarry Smith {
1665e69d4d44SBarry Smith   PC_FieldSplit  *jac = (PC_FieldSplit*)pc->data;
1666084e4875SJed Brown   PetscErrorCode ierr;
1667e69d4d44SBarry Smith 
1668e69d4d44SBarry Smith   PetscFunctionBegin;
1669084e4875SJed Brown   jac->schurpre = ptype;
1670a7476a74SDmitry Karpeev   if (ptype == PC_FIELDSPLIT_SCHUR_PRE_USER && pre) {
16716bf464f9SBarry Smith     ierr            = MatDestroy(&jac->schur_user);CHKERRQ(ierr);
1672084e4875SJed Brown     jac->schur_user = pre;
1673084e4875SJed Brown     ierr            = PetscObjectReference((PetscObject)jac->schur_user);CHKERRQ(ierr);
1674084e4875SJed Brown   }
1675e69d4d44SBarry Smith   PetscFunctionReturn(0);
1676e69d4d44SBarry Smith }
1677e69d4d44SBarry Smith 
167830ad9308SMatthew Knepley #undef __FUNCT__
167937a82bf0SJed Brown #define __FUNCT__ "PCFieldSplitGetSchurPre_FieldSplit"
168037a82bf0SJed Brown static PetscErrorCode  PCFieldSplitGetSchurPre_FieldSplit(PC pc,PCFieldSplitSchurPreType *ptype,Mat *pre)
168137a82bf0SJed Brown {
168237a82bf0SJed Brown   PC_FieldSplit  *jac = (PC_FieldSplit*)pc->data;
168337a82bf0SJed Brown 
168437a82bf0SJed Brown   PetscFunctionBegin;
168537a82bf0SJed Brown   *ptype = jac->schurpre;
168637a82bf0SJed Brown   *pre   = jac->schur_user;
168737a82bf0SJed Brown   PetscFunctionReturn(0);
168837a82bf0SJed Brown }
168937a82bf0SJed Brown 
169037a82bf0SJed Brown #undef __FUNCT__
1691c9c6ffaaSJed Brown #define __FUNCT__ "PCFieldSplitSetSchurFactType"
1692ab1df9f5SJed Brown /*@
1693c9c6ffaaSJed Brown     PCFieldSplitSetSchurFactType -  sets which blocks of the approximate block factorization to retain
1694ab1df9f5SJed Brown 
1695ab1df9f5SJed Brown     Collective on PC
1696ab1df9f5SJed Brown 
1697ab1df9f5SJed Brown     Input Parameters:
1698ab1df9f5SJed Brown +   pc  - the preconditioner context
1699c9c6ffaaSJed Brown -   ftype - which blocks of factorization to retain, PC_FIELDSPLIT_SCHUR_FACT_FULL is default
1700ab1df9f5SJed Brown 
1701ab1df9f5SJed Brown     Options Database:
1702c9c6ffaaSJed Brown .     -pc_fieldsplit_schur_fact_type <diag,lower,upper,full> default is full
1703ab1df9f5SJed Brown 
1704ab1df9f5SJed Brown 
1705ab1df9f5SJed Brown     Level: intermediate
1706ab1df9f5SJed Brown 
1707ab1df9f5SJed Brown     Notes:
1708ab1df9f5SJed Brown     The FULL factorization is
1709ab1df9f5SJed Brown 
1710ab1df9f5SJed Brown $   (A   B)  = (1       0) (A   0) (1  Ainv*B)
1711ab1df9f5SJed Brown $   (C   D)    (C*Ainv  1) (0   S) (0     1  )
1712ab1df9f5SJed Brown 
17136be4592eSBarry 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,
17146be4592eSBarry 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).
1715ab1df9f5SJed Brown 
17166be4592eSBarry 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
17176be4592eSBarry 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
17186be4592eSBarry 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,
17196be4592eSBarry 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.
1720ab1df9f5SJed Brown 
17216be4592eSBarry 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
17226be4592eSBarry 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).
1723ab1df9f5SJed Brown 
1724ab1df9f5SJed Brown     References:
1725ab1df9f5SJed Brown     Murphy, Golub, and Wathen, A note on preconditioning indefinite linear systems, SIAM J. Sci. Comput., 21 (2000) pp. 1969-1972.
1726ab1df9f5SJed Brown 
1727ab1df9f5SJed Brown     Ipsen, A note on preconditioning nonsymmetric matrices, SIAM J. Sci. Comput., 23 (2001), pp. 1050-1051.
1728ab1df9f5SJed Brown 
1729ab1df9f5SJed Brown .seealso: PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitSetFields(), PCFieldSplitSchurPreType
1730ab1df9f5SJed Brown @*/
1731c9c6ffaaSJed Brown PetscErrorCode  PCFieldSplitSetSchurFactType(PC pc,PCFieldSplitSchurFactType ftype)
1732ab1df9f5SJed Brown {
1733ab1df9f5SJed Brown   PetscErrorCode ierr;
1734ab1df9f5SJed Brown 
1735ab1df9f5SJed Brown   PetscFunctionBegin;
1736ab1df9f5SJed Brown   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
1737c9c6ffaaSJed Brown   ierr = PetscTryMethod(pc,"PCFieldSplitSetSchurFactType_C",(PC,PCFieldSplitSchurFactType),(pc,ftype));CHKERRQ(ierr);
1738ab1df9f5SJed Brown   PetscFunctionReturn(0);
1739ab1df9f5SJed Brown }
1740ab1df9f5SJed Brown 
1741ab1df9f5SJed Brown #undef __FUNCT__
1742c9c6ffaaSJed Brown #define __FUNCT__ "PCFieldSplitSetSchurFactType_FieldSplit"
17431e6b0712SBarry Smith static PetscErrorCode PCFieldSplitSetSchurFactType_FieldSplit(PC pc,PCFieldSplitSchurFactType ftype)
1744ab1df9f5SJed Brown {
1745ab1df9f5SJed Brown   PC_FieldSplit *jac = (PC_FieldSplit*)pc->data;
1746ab1df9f5SJed Brown 
1747ab1df9f5SJed Brown   PetscFunctionBegin;
1748ab1df9f5SJed Brown   jac->schurfactorization = ftype;
1749ab1df9f5SJed Brown   PetscFunctionReturn(0);
1750ab1df9f5SJed Brown }
1751ab1df9f5SJed Brown 
1752ab1df9f5SJed Brown #undef __FUNCT__
175330ad9308SMatthew Knepley #define __FUNCT__ "PCFieldSplitGetSchurBlocks"
175430ad9308SMatthew Knepley /*@C
17558c03b21aSDmitry Karpeev    PCFieldSplitGetSchurBlocks - Gets all matrix blocks for the Schur complement
175630ad9308SMatthew Knepley 
175730ad9308SMatthew Knepley    Collective on KSP
175830ad9308SMatthew Knepley 
175930ad9308SMatthew Knepley    Input Parameter:
176030ad9308SMatthew Knepley .  pc - the preconditioner context
176130ad9308SMatthew Knepley 
176230ad9308SMatthew Knepley    Output Parameters:
1763a04f6461SBarry Smith +  A00 - the (0,0) block
1764a04f6461SBarry Smith .  A01 - the (0,1) block
1765a04f6461SBarry Smith .  A10 - the (1,0) block
1766a04f6461SBarry Smith -  A11 - the (1,1) block
176730ad9308SMatthew Knepley 
176830ad9308SMatthew Knepley    Level: advanced
176930ad9308SMatthew Knepley 
177030ad9308SMatthew Knepley .seealso: PCFIELDSPLIT
177130ad9308SMatthew Knepley @*/
1772a04f6461SBarry Smith PetscErrorCode  PCFieldSplitGetSchurBlocks(PC pc,Mat *A00,Mat *A01,Mat *A10, Mat *A11)
177330ad9308SMatthew Knepley {
177430ad9308SMatthew Knepley   PC_FieldSplit *jac = (PC_FieldSplit*) pc->data;
177530ad9308SMatthew Knepley 
177630ad9308SMatthew Knepley   PetscFunctionBegin;
17770700a824SBarry Smith   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
1778ce94432eSBarry Smith   if (jac->type != PC_COMPOSITE_SCHUR) SETERRQ(PetscObjectComm((PetscObject)pc),PETSC_ERR_ARG_WRONG, "FieldSplit is not using a Schur complement approach.");
1779a04f6461SBarry Smith   if (A00) *A00 = jac->pmat[0];
1780a04f6461SBarry Smith   if (A01) *A01 = jac->B;
1781a04f6461SBarry Smith   if (A10) *A10 = jac->C;
1782a04f6461SBarry Smith   if (A11) *A11 = jac->pmat[1];
178330ad9308SMatthew Knepley   PetscFunctionReturn(0);
178430ad9308SMatthew Knepley }
178530ad9308SMatthew Knepley 
178679416396SBarry Smith #undef __FUNCT__
178779416396SBarry Smith #define __FUNCT__ "PCFieldSplitSetType_FieldSplit"
17881e6b0712SBarry Smith static PetscErrorCode  PCFieldSplitSetType_FieldSplit(PC pc,PCCompositeType type)
178979416396SBarry Smith {
179079416396SBarry Smith   PC_FieldSplit  *jac = (PC_FieldSplit*)pc->data;
1791e69d4d44SBarry Smith   PetscErrorCode ierr;
179279416396SBarry Smith 
179379416396SBarry Smith   PetscFunctionBegin;
179479416396SBarry Smith   jac->type = type;
17953b224e63SBarry Smith   if (type == PC_COMPOSITE_SCHUR) {
17963b224e63SBarry Smith     pc->ops->apply = PCApply_FieldSplit_Schur;
17973b224e63SBarry Smith     pc->ops->view  = PCView_FieldSplit_Schur;
17982fa5cd67SKarl Rupp 
1799bdf89e91SBarry Smith     ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitGetSubKSP_C",PCFieldSplitGetSubKSP_FieldSplit_Schur);CHKERRQ(ierr);
180029f8a81cSJed Brown     ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetSchurPre_C",PCFieldSplitSetSchurPre_FieldSplit);CHKERRQ(ierr);
180137a82bf0SJed Brown     ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitGetSchurPre_C",PCFieldSplitGetSchurPre_FieldSplit);CHKERRQ(ierr);
1802bdf89e91SBarry Smith     ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetSchurFactType_C",PCFieldSplitSetSchurFactType_FieldSplit);CHKERRQ(ierr);
1803e69d4d44SBarry Smith 
18043b224e63SBarry Smith   } else {
18053b224e63SBarry Smith     pc->ops->apply = PCApply_FieldSplit;
18063b224e63SBarry Smith     pc->ops->view  = PCView_FieldSplit;
18072fa5cd67SKarl Rupp 
1808bdf89e91SBarry Smith     ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitGetSubKSP_C",PCFieldSplitGetSubKSP_FieldSplit);CHKERRQ(ierr);
180929f8a81cSJed Brown     ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetSchurPre_C",0);CHKERRQ(ierr);
181037a82bf0SJed Brown     ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitGetSchurPre_C",0);CHKERRQ(ierr);
1811bdf89e91SBarry Smith     ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetSchurFactType_C",0);CHKERRQ(ierr);
18123b224e63SBarry Smith   }
181379416396SBarry Smith   PetscFunctionReturn(0);
181479416396SBarry Smith }
181579416396SBarry Smith 
181651f519a2SBarry Smith #undef __FUNCT__
181751f519a2SBarry Smith #define __FUNCT__ "PCFieldSplitSetBlockSize_FieldSplit"
18181e6b0712SBarry Smith static PetscErrorCode  PCFieldSplitSetBlockSize_FieldSplit(PC pc,PetscInt bs)
181951f519a2SBarry Smith {
182051f519a2SBarry Smith   PC_FieldSplit *jac = (PC_FieldSplit*)pc->data;
182151f519a2SBarry Smith 
182251f519a2SBarry Smith   PetscFunctionBegin;
1823ce94432eSBarry Smith   if (bs < 1) SETERRQ1(PetscObjectComm((PetscObject)pc),PETSC_ERR_ARG_OUTOFRANGE,"Blocksize must be positive, you gave %D",bs);
1824ce94432eSBarry 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);
182551f519a2SBarry Smith   jac->bs = bs;
182651f519a2SBarry Smith   PetscFunctionReturn(0);
182751f519a2SBarry Smith }
182851f519a2SBarry Smith 
182979416396SBarry Smith #undef __FUNCT__
183079416396SBarry Smith #define __FUNCT__ "PCFieldSplitSetType"
1831bc08b0f1SBarry Smith /*@
183279416396SBarry Smith    PCFieldSplitSetType - Sets the type of fieldsplit preconditioner.
183379416396SBarry Smith 
183479416396SBarry Smith    Collective on PC
183579416396SBarry Smith 
183679416396SBarry Smith    Input Parameter:
183779416396SBarry Smith .  pc - the preconditioner context
183881540f2fSBarry Smith .  type - PC_COMPOSITE_ADDITIVE, PC_COMPOSITE_MULTIPLICATIVE (default), PC_COMPOSITE_SYMMETRIC_MULTIPLICATIVE, PC_COMPOSITE_SPECIAL, PC_COMPOSITE_SCHUR
183979416396SBarry Smith 
184079416396SBarry Smith    Options Database Key:
1841a4efd8eaSMatthew Knepley .  -pc_fieldsplit_type <type: one of multiplicative, additive, symmetric_multiplicative, special, schur> - Sets fieldsplit preconditioner type
184279416396SBarry Smith 
1843b02e2d75SMatthew G Knepley    Level: Intermediate
184479416396SBarry Smith 
184579416396SBarry Smith .keywords: PC, set, type, composite preconditioner, additive, multiplicative
184679416396SBarry Smith 
184779416396SBarry Smith .seealso: PCCompositeSetType()
184879416396SBarry Smith 
184979416396SBarry Smith @*/
18507087cfbeSBarry Smith PetscErrorCode  PCFieldSplitSetType(PC pc,PCCompositeType type)
185179416396SBarry Smith {
18524ac538c5SBarry Smith   PetscErrorCode ierr;
185379416396SBarry Smith 
185479416396SBarry Smith   PetscFunctionBegin;
18550700a824SBarry Smith   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
18564ac538c5SBarry Smith   ierr = PetscTryMethod(pc,"PCFieldSplitSetType_C",(PC,PCCompositeType),(pc,type));CHKERRQ(ierr);
185779416396SBarry Smith   PetscFunctionReturn(0);
185879416396SBarry Smith }
185979416396SBarry Smith 
1860b02e2d75SMatthew G Knepley #undef __FUNCT__
1861b02e2d75SMatthew G Knepley #define __FUNCT__ "PCFieldSplitGetType"
1862b02e2d75SMatthew G Knepley /*@
1863b02e2d75SMatthew G Knepley   PCFieldSplitGetType - Gets the type of fieldsplit preconditioner.
1864b02e2d75SMatthew G Knepley 
1865b02e2d75SMatthew G Knepley   Not collective
1866b02e2d75SMatthew G Knepley 
1867b02e2d75SMatthew G Knepley   Input Parameter:
1868b02e2d75SMatthew G Knepley . pc - the preconditioner context
1869b02e2d75SMatthew G Knepley 
1870b02e2d75SMatthew G Knepley   Output Parameter:
1871b02e2d75SMatthew G Knepley . type - PC_COMPOSITE_ADDITIVE, PC_COMPOSITE_MULTIPLICATIVE (default), PC_COMPOSITE_SYMMETRIC_MULTIPLICATIVE, PC_COMPOSITE_SPECIAL, PC_COMPOSITE_SCHUR
1872b02e2d75SMatthew G Knepley 
1873b02e2d75SMatthew G Knepley   Level: Intermediate
1874b02e2d75SMatthew G Knepley 
1875b02e2d75SMatthew G Knepley .keywords: PC, set, type, composite preconditioner, additive, multiplicative
1876b02e2d75SMatthew G Knepley .seealso: PCCompositeSetType()
1877b02e2d75SMatthew G Knepley @*/
1878b02e2d75SMatthew G Knepley PetscErrorCode PCFieldSplitGetType(PC pc, PCCompositeType *type)
1879b02e2d75SMatthew G Knepley {
1880b02e2d75SMatthew G Knepley   PC_FieldSplit *jac = (PC_FieldSplit*) pc->data;
1881b02e2d75SMatthew G Knepley 
1882b02e2d75SMatthew G Knepley   PetscFunctionBegin;
1883b02e2d75SMatthew G Knepley   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
1884b02e2d75SMatthew G Knepley   PetscValidIntPointer(type,2);
1885b02e2d75SMatthew G Knepley   *type = jac->type;
1886b02e2d75SMatthew G Knepley   PetscFunctionReturn(0);
1887b02e2d75SMatthew G Knepley }
1888b02e2d75SMatthew G Knepley 
18894ab8060aSDmitry Karpeev #undef __FUNCT__
18904ab8060aSDmitry Karpeev #define __FUNCT__ "PCFieldSplitSetDMSplits"
18914ab8060aSDmitry Karpeev /*@
18924ab8060aSDmitry Karpeev    PCFieldSplitSetDMSplits - Flags whether DMCreateFieldDecomposition() should be used to define the splits, whenever possible.
18934ab8060aSDmitry Karpeev 
18944ab8060aSDmitry Karpeev    Logically Collective
18954ab8060aSDmitry Karpeev 
18964ab8060aSDmitry Karpeev    Input Parameters:
18974ab8060aSDmitry Karpeev +  pc   - the preconditioner context
18984ab8060aSDmitry Karpeev -  flg  - boolean indicating whether to use field splits defined by the DM
18994ab8060aSDmitry Karpeev 
19004ab8060aSDmitry Karpeev    Options Database Key:
19014ab8060aSDmitry Karpeev .  -pc_fieldsplit_dm_splits
19024ab8060aSDmitry Karpeev 
19034ab8060aSDmitry Karpeev    Level: Intermediate
19044ab8060aSDmitry Karpeev 
19054ab8060aSDmitry Karpeev .keywords: PC, DM, composite preconditioner, additive, multiplicative
19064ab8060aSDmitry Karpeev 
19074ab8060aSDmitry Karpeev .seealso: PCFieldSplitGetDMSplits()
19084ab8060aSDmitry Karpeev 
19094ab8060aSDmitry Karpeev @*/
19104ab8060aSDmitry Karpeev PetscErrorCode  PCFieldSplitSetDMSplits(PC pc,PetscBool flg)
19114ab8060aSDmitry Karpeev {
19124ab8060aSDmitry Karpeev   PC_FieldSplit  *jac = (PC_FieldSplit*)pc->data;
19134ab8060aSDmitry Karpeev   PetscBool      isfs;
19144ab8060aSDmitry Karpeev   PetscErrorCode ierr;
19154ab8060aSDmitry Karpeev 
19164ab8060aSDmitry Karpeev   PetscFunctionBegin;
19174ab8060aSDmitry Karpeev   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
19184ab8060aSDmitry Karpeev   PetscValidLogicalCollectiveBool(pc,flg,2);
19194ab8060aSDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)pc,PCFIELDSPLIT,&isfs);CHKERRQ(ierr);
19204ab8060aSDmitry Karpeev   if (isfs) {
19214ab8060aSDmitry Karpeev     jac->dm_splits = flg;
19224ab8060aSDmitry Karpeev   }
19234ab8060aSDmitry Karpeev   PetscFunctionReturn(0);
19244ab8060aSDmitry Karpeev }
19254ab8060aSDmitry Karpeev 
19264ab8060aSDmitry Karpeev 
19274ab8060aSDmitry Karpeev #undef __FUNCT__
19284ab8060aSDmitry Karpeev #define __FUNCT__ "PCFieldSplitGetDMSplits"
19294ab8060aSDmitry Karpeev /*@
19304ab8060aSDmitry Karpeev    PCFieldSplitGetDMSplits - Returns flag indicating whether DMCreateFieldDecomposition() should be used to define the splits, whenever possible.
19314ab8060aSDmitry Karpeev 
19324ab8060aSDmitry Karpeev    Logically Collective
19334ab8060aSDmitry Karpeev 
19344ab8060aSDmitry Karpeev    Input Parameter:
19354ab8060aSDmitry Karpeev .  pc   - the preconditioner context
19364ab8060aSDmitry Karpeev 
19374ab8060aSDmitry Karpeev    Output Parameter:
19384ab8060aSDmitry Karpeev .  flg  - boolean indicating whether to use field splits defined by the DM
19394ab8060aSDmitry Karpeev 
19404ab8060aSDmitry Karpeev    Level: Intermediate
19414ab8060aSDmitry Karpeev 
19424ab8060aSDmitry Karpeev .keywords: PC, DM, composite preconditioner, additive, multiplicative
19434ab8060aSDmitry Karpeev 
19444ab8060aSDmitry Karpeev .seealso: PCFieldSplitSetDMSplits()
19454ab8060aSDmitry Karpeev 
19464ab8060aSDmitry Karpeev @*/
19474ab8060aSDmitry Karpeev PetscErrorCode  PCFieldSplitGetDMSplits(PC pc,PetscBool* flg)
19484ab8060aSDmitry Karpeev {
19494ab8060aSDmitry Karpeev   PC_FieldSplit  *jac = (PC_FieldSplit*)pc->data;
19504ab8060aSDmitry Karpeev   PetscBool      isfs;
19514ab8060aSDmitry Karpeev   PetscErrorCode ierr;
19524ab8060aSDmitry Karpeev 
19534ab8060aSDmitry Karpeev   PetscFunctionBegin;
19544ab8060aSDmitry Karpeev   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
19554ab8060aSDmitry Karpeev   PetscValidPointer(flg,2);
19564ab8060aSDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)pc,PCFIELDSPLIT,&isfs);CHKERRQ(ierr);
19574ab8060aSDmitry Karpeev   if (isfs) {
19584ab8060aSDmitry Karpeev     if(flg) *flg = jac->dm_splits;
19594ab8060aSDmitry Karpeev   }
19604ab8060aSDmitry Karpeev   PetscFunctionReturn(0);
19614ab8060aSDmitry Karpeev }
19624ab8060aSDmitry Karpeev 
19630971522cSBarry Smith /* -------------------------------------------------------------------------------------*/
19640971522cSBarry Smith /*MC
1965a8c7a070SBarry Smith    PCFIELDSPLIT - Preconditioner created by combining separate preconditioners for individual
1966a04f6461SBarry Smith                   fields or groups of fields. See the users manual section "Solving Block Matrices" for more details.
19670971522cSBarry Smith 
1968edf189efSBarry Smith      To set options on the solvers for each block append -fieldsplit_ to all the PC
1969edf189efSBarry Smith         options database keys. For example, -fieldsplit_pc_type ilu -fieldsplit_pc_factor_levels 1
19700971522cSBarry Smith 
1971a8c7a070SBarry Smith      To set the options on the solvers separate for each block call PCFieldSplitGetSubKSP()
197269a612a9SBarry Smith          and set the options directly on the resulting KSP object
19730971522cSBarry Smith 
19740971522cSBarry Smith    Level: intermediate
19750971522cSBarry Smith 
197679416396SBarry Smith    Options Database Keys:
197781540f2fSBarry Smith +   -pc_fieldsplit_%d_fields <a,b,..> - indicates the fields to be used in the %d'th split
197881540f2fSBarry Smith .   -pc_fieldsplit_default - automatically add any fields to additional splits that have not
197981540f2fSBarry Smith                               been supplied explicitly by -pc_fieldsplit_%d_fields
198081540f2fSBarry Smith .   -pc_fieldsplit_block_size <bs> - size of block that defines fields (i.e. there are bs fields)
19810f188ba9SJed Brown .   -pc_fieldsplit_type <additive,multiplicative,symmetric_multiplicative,schur> - type of relaxation or factorization splitting
19822e71c61dSMatthew G. Knepley .   -pc_fieldsplit_schur_precondition <self,selfp,user,a11,full> - default is a11
1983435f959eSBarry Smith .   -pc_fieldsplit_detect_saddle_point - automatically finds rows with zero or negative diagonal and uses Schur complement with no preconditioner as the solver
198479416396SBarry Smith 
19855d4c12cdSJungho Lee -    Options prefix for inner solvers when using Schur complement preconditioner are -fieldsplit_0_ and -fieldsplit_1_
19865d4c12cdSJungho Lee      for all other solvers they are -fieldsplit_%d_ for the dth field, use -fieldsplit_ for all fields
19875d4c12cdSJungho Lee 
1988c8a0d604SMatthew G Knepley    Notes:
1989c8a0d604SMatthew G Knepley     Use PCFieldSplitSetFields() to set fields defined by "strided" entries and PCFieldSplitSetIS()
1990d32f9abdSBarry Smith      to define a field by an arbitrary collection of entries.
1991d32f9abdSBarry Smith 
1992d32f9abdSBarry Smith       If no fields are set the default is used. The fields are defined by entries strided by bs,
1993d32f9abdSBarry Smith       beginning at 0 then 1, etc to bs-1. The block size can be set with PCFieldSplitSetBlockSize(),
1994d32f9abdSBarry Smith       if this is not called the block size defaults to the blocksize of the second matrix passed
1995d32f9abdSBarry Smith       to KSPSetOperators()/PCSetOperators().
1996d32f9abdSBarry Smith 
1997c8a0d604SMatthew G Knepley $     For the Schur complement preconditioner if J = ( A00 A01 )
1998c8a0d604SMatthew G Knepley $                                                    ( A10 A11 )
1999c8a0d604SMatthew G Knepley $     the preconditioner using full factorization is
200013b05affSJed Brown $              ( I   -ksp(A00) A01 ) ( inv(A00)     0  ) (     I          0  )
2001c8a0d604SMatthew G Knepley $              ( 0         I       ) (   0      ksp(S) ) ( -A10 ksp(A00)  I  )
200213b05affSJed Brown      where the action of inv(A00) is applied using the KSP solver with prefix -fieldsplit_0_.  S is the Schur complement
200313b05affSJed Brown $              S = A11 - A10 ksp(A00) A01
200413b05affSJed 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
2005c8a0d604SMatthew G Knepley      in providing the SECOND split or 1 if not give). For PCFieldSplitGetKSP() when field number is 0,
2006c8a0d604SMatthew G Knepley      it returns the KSP associated with -fieldsplit_0_ while field number 1 gives -fieldsplit_1_ KSP. By default
200729f8a81cSJed Brown      A11 is used to construct a preconditioner for S, use PCFieldSplitSetSchurPre() to turn on or off this
2008a7476a74SDmitry Karpeev      option. You can use the preconditioner PCLSC to precondition the Schur complement with -fieldsplit_1_pc_type lsc.
2009a7476a74SDmitry Karpeev      When option -fieldsplit_schur_precondition selfp is given, an approximation to S is assembled --
2010a7476a74SDmitry Karpeev      Sp = A11 - A10 inv(diag(A00)) A01, which has type AIJ and can be used with a variety of preconditioners
2011a7476a74SDmitry Karpeev      (e.g., -fieldsplit_1_pc_type asm).
2012a7476a74SDmitry Karpeev      The factorization type is set using -pc_fieldsplit_schur_fact_type <diag, lower, upper, full>. The full is shown above,
20135668aaf4SBarry Smith      diag gives
2014c8a0d604SMatthew G Knepley $              ( inv(A00)     0   )
2015c8a0d604SMatthew G Knepley $              (   0      -ksp(S) )
20165668aaf4SBarry 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
2017c8a0d604SMatthew G Knepley $              (  A00   0 )
2018c8a0d604SMatthew G Knepley $              (  A10   S )
2019c8a0d604SMatthew G Knepley      where the inverses of A00 and S are applied using KSPs. The upper factorization is the inverse of
2020c8a0d604SMatthew G Knepley $              ( A00 A01 )
2021c8a0d604SMatthew G Knepley $              (  0   S  )
2022c8a0d604SMatthew G Knepley      where again the inverses of A00 and S are applied using KSPs.
2023e69d4d44SBarry Smith 
2024edf189efSBarry Smith      If only one set of indices (one IS) is provided with PCFieldSplitSetIS() then the complement of that IS
2025edf189efSBarry Smith      is used automatically for a second block.
2026edf189efSBarry Smith 
2027ff218e97SBarry Smith      The fieldsplit preconditioner cannot currently be used with the BAIJ or SBAIJ data formats if the blocksize is larger than 1.
2028ff218e97SBarry Smith      Generally it should be used with the AIJ format.
2029ff218e97SBarry Smith 
2030ff218e97SBarry Smith      The forms of these preconditioners are closely related if not identical to forms derived as "Distributive Iterations", see,
2031ff218e97SBarry Smith      for example, page 294 in "Principles of Computational Fluid Dynamics" by Pieter Wesseling. Note that one can also use PCFIELDSPLIT
2032ff218e97SBarry Smith      inside a smoother resulting in "Distributive Smoothers".
20330716a85fSBarry Smith 
2034a541d17aSBarry Smith    Concepts: physics based preconditioners, block preconditioners
20350971522cSBarry Smith 
20367e8cb189SBarry Smith .seealso:  PCCreate(), PCSetType(), PCType (for list of available types), PC, Block_Preconditioners, PCLSC,
203729f8a81cSJed Brown            PCFieldSplitGetSubKSP(), PCFieldSplitSetFields(), PCFieldSplitSetType(), PCFieldSplitSetIS(), PCFieldSplitSetSchurPre()
20380971522cSBarry Smith M*/
20390971522cSBarry Smith 
20400971522cSBarry Smith #undef __FUNCT__
20410971522cSBarry Smith #define __FUNCT__ "PCCreate_FieldSplit"
20428cc058d9SJed Brown PETSC_EXTERN PetscErrorCode PCCreate_FieldSplit(PC pc)
20430971522cSBarry Smith {
20440971522cSBarry Smith   PetscErrorCode ierr;
20450971522cSBarry Smith   PC_FieldSplit  *jac;
20460971522cSBarry Smith 
20470971522cSBarry Smith   PetscFunctionBegin;
2048b00a9115SJed Brown   ierr = PetscNewLog(pc,&jac);CHKERRQ(ierr);
20492fa5cd67SKarl Rupp 
20500971522cSBarry Smith   jac->bs                 = -1;
20510971522cSBarry Smith   jac->nsplits            = 0;
20523e197d65SBarry Smith   jac->type               = PC_COMPOSITE_MULTIPLICATIVE;
2053e6cab6aaSJed Brown   jac->schurpre           = PC_FIELDSPLIT_SCHUR_PRE_USER; /* Try user preconditioner first, fall back on diagonal */
2054c9c6ffaaSJed Brown   jac->schurfactorization = PC_FIELDSPLIT_SCHUR_FACT_FULL;
2055fbe7908bSJed Brown   jac->dm_splits          = PETSC_TRUE;
205651f519a2SBarry Smith 
20570971522cSBarry Smith   pc->data = (void*)jac;
20580971522cSBarry Smith 
20590971522cSBarry Smith   pc->ops->apply           = PCApply_FieldSplit;
2060421e10b8SBarry Smith   pc->ops->applytranspose  = PCApplyTranspose_FieldSplit;
20610971522cSBarry Smith   pc->ops->setup           = PCSetUp_FieldSplit;
2062574deadeSBarry Smith   pc->ops->reset           = PCReset_FieldSplit;
20630971522cSBarry Smith   pc->ops->destroy         = PCDestroy_FieldSplit;
20640971522cSBarry Smith   pc->ops->setfromoptions  = PCSetFromOptions_FieldSplit;
20650971522cSBarry Smith   pc->ops->view            = PCView_FieldSplit;
20660971522cSBarry Smith   pc->ops->applyrichardson = 0;
20670971522cSBarry Smith 
2068bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitGetSubKSP_C",PCFieldSplitGetSubKSP_FieldSplit);CHKERRQ(ierr);
2069bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetFields_C",PCFieldSplitSetFields_FieldSplit);CHKERRQ(ierr);
2070bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetIS_C",PCFieldSplitSetIS_FieldSplit);CHKERRQ(ierr);
2071bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetType_C",PCFieldSplitSetType_FieldSplit);CHKERRQ(ierr);
2072bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetBlockSize_C",PCFieldSplitSetBlockSize_FieldSplit);CHKERRQ(ierr);
20730971522cSBarry Smith   PetscFunctionReturn(0);
20740971522cSBarry Smith }
20750971522cSBarry Smith 
20760971522cSBarry Smith 
2077a541d17aSBarry Smith 
2078