xref: /petsc/src/ksp/pc/impls/fieldsplit/fieldsplit.c (revision 2cc093ac87fb9c89dbe65c18ab43b11e8f923c8b)
1dba47a55SKris Buschelman 
2f5f0d762SBarry Smith 
3af0996ceSBarry Smith #include <petsc/private/pcimpl.h>     /*I "petscpc.h" I*/
4a80b646eSBarry Smith #include <petsc/private/kspimpl.h>    /*  This is needed to provide the appropriate PETSC_EXTERN for KSP_Solve_FS ....*/
51e25c274SJed Brown #include <petscdm.h>
60971522cSBarry Smith 
72e71c61dSMatthew G. Knepley const char *const PCFieldSplitSchurPreTypes[] = {"SELF","SELFP","A11","USER","FULL","PCFieldSplitSchurPreType","PC_FIELDSPLIT_SCHUR_PRE_",0};
8c9c6ffaaSJed Brown const char *const PCFieldSplitSchurFactTypes[] = {"DIAG","LOWER","UPPER","FULL","PCFieldSplitSchurFactType","PC_FIELDSPLIT_SCHUR_FACT_",0};
9c5d2311dSJed Brown 
109df09d43SBarry Smith PetscLogEvent KSP_Solve_FS_0,KSP_Solve_FS_1,KSP_Solve_FS_S,KSP_Solve_FS_U,KSP_Solve_FS_L,KSP_Solve_FS_2,KSP_Solve_FS_3,KSP_Solve_FS_4;
119df09d43SBarry Smith 
120971522cSBarry Smith typedef struct _PC_FieldSplitLink *PC_FieldSplitLink;
130971522cSBarry Smith struct _PC_FieldSplitLink {
1469a612a9SBarry Smith   KSP               ksp;
15443836d0SMatthew G Knepley   Vec               x,y,z;
16db4c96c1SJed Brown   char              *splitname;
170971522cSBarry Smith   PetscInt          nfields;
185d4c12cdSJungho Lee   PetscInt          *fields,*fields_col;
191b9fc7fcSBarry Smith   VecScatter        sctx;
20f5f0d762SBarry Smith   IS                is,is_col;
2151f519a2SBarry Smith   PC_FieldSplitLink next,previous;
229df09d43SBarry Smith   PetscLogEvent     event;
230971522cSBarry Smith };
240971522cSBarry Smith 
250971522cSBarry Smith typedef struct {
2668dd23aaSBarry Smith   PCCompositeType type;
27ace3abfcSBarry Smith   PetscBool       defaultsplit;                    /* Flag for a system with a set of 'k' scalar fields with the same layout (and bs = k) */
28ace3abfcSBarry Smith   PetscBool       splitdefined;                    /* Flag is set after the splits have been defined, to prevent more splits from being added */
2930ad9308SMatthew Knepley   PetscInt        bs;                              /* Block size for IS and Mat structures */
3030ad9308SMatthew Knepley   PetscInt        nsplits;                         /* Number of field divisions defined */
3179416396SBarry Smith   Vec             *x,*y,w1,w2;
32519d70e2SJed Brown   Mat             *mat;                            /* The diagonal block for each split */
33519d70e2SJed Brown   Mat             *pmat;                           /* The preconditioning diagonal block for each split */
3430ad9308SMatthew Knepley   Mat             *Afield;                         /* The rows of the matrix associated with each split */
35ace3abfcSBarry Smith   PetscBool       issetup;
362fa5cd67SKarl Rupp 
3730ad9308SMatthew Knepley   /* Only used when Schur complement preconditioning is used */
3830ad9308SMatthew Knepley   Mat                       B;                     /* The (0,1) block */
3930ad9308SMatthew Knepley   Mat                       C;                     /* The (1,0) block */
40443836d0SMatthew G Knepley   Mat                       schur;                 /* The Schur complement S = A11 - A10 A00^{-1} A01, the KSP here, kspinner, is H_1 in [El08] */
41a7476a74SDmitry Karpeev   Mat                       schurp;                /* Assembled approximation to S built by MatSchurComplement to be used as a preconditioning matrix when solving with S */
42084e4875SJed Brown   Mat                       schur_user;            /* User-provided preconditioning matrix for the Schur complement */
43084e4875SJed Brown   PCFieldSplitSchurPreType  schurpre;              /* Determines which preconditioning matrix is used for the Schur complement */
44c9c6ffaaSJed Brown   PCFieldSplitSchurFactType schurfactorization;
4530ad9308SMatthew Knepley   KSP                       kspschur;              /* The solver for S */
46443836d0SMatthew G Knepley   KSP                       kspupper;              /* The solver for A in the upper diagonal part of the factorization (H_2 in [El08]) */
47c096484dSStefano Zampini   PetscScalar               schurscale;            /* Scaling factor for the Schur complement solution with DIAG factorization */
48c096484dSStefano Zampini 
4997bbdb24SBarry Smith   PC_FieldSplitLink         head;
506dbb499eSCian Wilson   PetscBool                 isrestrict;             /* indicates PCFieldSplitRestrictIS() has been last called on this object, hack */
51c1570756SJed Brown   PetscBool                 suboptionsset;          /* Indicates that the KSPSetFromOptions() has been called on the sub-KSPs */
524ab8060aSDmitry Karpeev   PetscBool                 dm_splits;              /* Whether to use DMCreateFieldDecomposition() whenever possible */
53c84da90fSDmitry Karpeev   PetscBool                 diag_use_amat;          /* Whether to extract diagonal matrix blocks from Amat, rather than Pmat (weaker than -pc_use_amat) */
54c84da90fSDmitry Karpeev   PetscBool                 offdiag_use_amat;       /* Whether to extract off-diagonal matrix blocks from Amat, rather than Pmat (weaker than -pc_use_amat) */
550971522cSBarry Smith } PC_FieldSplit;
560971522cSBarry Smith 
5716913363SBarry Smith /*
5816913363SBarry Smith     Notes: there is no particular reason that pmat, x, and y are stored as arrays in PC_FieldSplit instead of
5916913363SBarry Smith    inside PC_FieldSplitLink, just historical. If you want to be able to add new fields after already using the
6016913363SBarry Smith    PC you could change this.
6116913363SBarry Smith */
62084e4875SJed Brown 
63e6cab6aaSJed Brown /* This helper is so that setting a user-provided preconditioning matrix is orthogonal to choosing to use it.  This way the
64084e4875SJed Brown * application-provided FormJacobian can provide this matrix without interfering with the user's (command-line) choices. */
65084e4875SJed Brown static Mat FieldSplitSchurPre(PC_FieldSplit *jac)
66084e4875SJed Brown {
67084e4875SJed Brown   switch (jac->schurpre) {
68084e4875SJed Brown   case PC_FIELDSPLIT_SCHUR_PRE_SELF: return jac->schur;
69a7476a74SDmitry Karpeev   case PC_FIELDSPLIT_SCHUR_PRE_SELFP: return jac->schurp;
70e87fab1bSBarry Smith   case PC_FIELDSPLIT_SCHUR_PRE_A11: return jac->pmat[1];
71e74569cdSMatthew G. Knepley   case PC_FIELDSPLIT_SCHUR_PRE_FULL: /* We calculate this and store it in schur_user */
72084e4875SJed Brown   case PC_FIELDSPLIT_SCHUR_PRE_USER: /* Use a user-provided matrix if it is given, otherwise diagonal block */
73084e4875SJed Brown   default:
74084e4875SJed Brown     return jac->schur_user ? jac->schur_user : jac->pmat[1];
75084e4875SJed Brown   }
76084e4875SJed Brown }
77084e4875SJed Brown 
78084e4875SJed Brown 
799804daf3SBarry Smith #include <petscdraw.h>
800971522cSBarry Smith static PetscErrorCode PCView_FieldSplit(PC pc,PetscViewer viewer)
810971522cSBarry Smith {
820971522cSBarry Smith   PC_FieldSplit     *jac = (PC_FieldSplit*)pc->data;
830971522cSBarry Smith   PetscErrorCode    ierr;
84d9884438SBarry Smith   PetscBool         iascii,isdraw;
850971522cSBarry Smith   PetscInt          i,j;
865a9f2f41SSatish Balay   PC_FieldSplitLink ilink = jac->head;
870971522cSBarry Smith 
880971522cSBarry Smith   PetscFunctionBegin;
89251f4c67SDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&iascii);CHKERRQ(ierr);
90d9884438SBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERDRAW,&isdraw);CHKERRQ(ierr);
910971522cSBarry Smith   if (iascii) {
922c9966d7SBarry Smith     if (jac->bs > 0) {
9351f519a2SBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"  FieldSplit with %s composition: total splits = %D, blocksize = %D\n",PCCompositeTypes[jac->type],jac->nsplits,jac->bs);CHKERRQ(ierr);
942c9966d7SBarry Smith     } else {
952c9966d7SBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"  FieldSplit with %s composition: total splits = %D\n",PCCompositeTypes[jac->type],jac->nsplits);CHKERRQ(ierr);
962c9966d7SBarry Smith     }
97f5236f50SJed Brown     if (pc->useAmat) {
98f5236f50SJed Brown       ierr = PetscViewerASCIIPrintf(viewer,"  using Amat (not Pmat) as operator for blocks\n");CHKERRQ(ierr);
99a3df900dSMatthew G Knepley     }
100c84da90fSDmitry Karpeev     if (jac->diag_use_amat) {
101c84da90fSDmitry Karpeev       ierr = PetscViewerASCIIPrintf(viewer,"  using Amat (not Pmat) as operator for diagonal blocks\n");CHKERRQ(ierr);
102c84da90fSDmitry Karpeev     }
103c84da90fSDmitry Karpeev     if (jac->offdiag_use_amat) {
104c84da90fSDmitry Karpeev       ierr = PetscViewerASCIIPrintf(viewer,"  using Amat (not Pmat) as operator for off-diagonal blocks\n");CHKERRQ(ierr);
105c84da90fSDmitry Karpeev     }
10669a612a9SBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"  Solver info for each split is in the following KSP objects:\n");CHKERRQ(ierr);
1070971522cSBarry Smith     for (i=0; i<jac->nsplits; i++) {
1081ab39975SBarry Smith       if (ilink->fields) {
1090971522cSBarry Smith         ierr = PetscViewerASCIIPrintf(viewer,"Split number %D Fields ",i);CHKERRQ(ierr);
11079416396SBarry Smith         ierr = PetscViewerASCIIUseTabs(viewer,PETSC_FALSE);CHKERRQ(ierr);
1115a9f2f41SSatish Balay         for (j=0; j<ilink->nfields; j++) {
11279416396SBarry Smith           if (j > 0) {
11379416396SBarry Smith             ierr = PetscViewerASCIIPrintf(viewer,",");CHKERRQ(ierr);
11479416396SBarry Smith           }
1155a9f2f41SSatish Balay           ierr = PetscViewerASCIIPrintf(viewer," %D",ilink->fields[j]);CHKERRQ(ierr);
1160971522cSBarry Smith         }
1170971522cSBarry Smith         ierr = PetscViewerASCIIPrintf(viewer,"\n");CHKERRQ(ierr);
11879416396SBarry Smith         ierr = PetscViewerASCIIUseTabs(viewer,PETSC_TRUE);CHKERRQ(ierr);
1191ab39975SBarry Smith       } else {
1201ab39975SBarry Smith         ierr = PetscViewerASCIIPrintf(viewer,"Split number %D Defined by IS\n",i);CHKERRQ(ierr);
1211ab39975SBarry Smith       }
1225a9f2f41SSatish Balay       ierr  = KSPView(ilink->ksp,viewer);CHKERRQ(ierr);
1235a9f2f41SSatish Balay       ilink = ilink->next;
1240971522cSBarry Smith     }
1252fa5cd67SKarl Rupp   }
1262fa5cd67SKarl Rupp 
1272fa5cd67SKarl Rupp  if (isdraw) {
128d9884438SBarry Smith     PetscDraw draw;
129d9884438SBarry Smith     PetscReal x,y,w,wd;
130d9884438SBarry Smith 
131d9884438SBarry Smith     ierr = PetscViewerDrawGetDraw(viewer,0,&draw);CHKERRQ(ierr);
132d9884438SBarry Smith     ierr = PetscDrawGetCurrentPoint(draw,&x,&y);CHKERRQ(ierr);
133d9884438SBarry Smith     w    = 2*PetscMin(1.0 - x,x);
134d9884438SBarry Smith     wd   = w/(jac->nsplits + 1);
135d9884438SBarry Smith     x    = x - wd*(jac->nsplits-1)/2.0;
136d9884438SBarry Smith     for (i=0; i<jac->nsplits; i++) {
137d9884438SBarry Smith       ierr  = PetscDrawPushCurrentPoint(draw,x,y);CHKERRQ(ierr);
138d9884438SBarry Smith       ierr  = KSPView(ilink->ksp,viewer);CHKERRQ(ierr);
139d9884438SBarry Smith       ierr  = PetscDrawPopCurrentPoint(draw);CHKERRQ(ierr);
140d9884438SBarry Smith       x    += wd;
141d9884438SBarry Smith       ilink = ilink->next;
142d9884438SBarry Smith     }
1430971522cSBarry Smith   }
1440971522cSBarry Smith   PetscFunctionReturn(0);
1450971522cSBarry Smith }
1460971522cSBarry Smith 
1473b224e63SBarry Smith static PetscErrorCode PCView_FieldSplit_Schur(PC pc,PetscViewer viewer)
1483b224e63SBarry Smith {
1493b224e63SBarry Smith   PC_FieldSplit              *jac = (PC_FieldSplit*)pc->data;
1503b224e63SBarry Smith   PetscErrorCode             ierr;
1514996c5bdSBarry Smith   PetscBool                  iascii,isdraw;
1523b224e63SBarry Smith   PetscInt                   i,j;
1533b224e63SBarry Smith   PC_FieldSplitLink          ilink = jac->head;
154a9908d51SBarry Smith   MatSchurComplementAinvType atype;
1553b224e63SBarry Smith 
1563b224e63SBarry Smith   PetscFunctionBegin;
157251f4c67SDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&iascii);CHKERRQ(ierr);
1584996c5bdSBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERDRAW,&isdraw);CHKERRQ(ierr);
1593b224e63SBarry Smith   if (iascii) {
1602c9966d7SBarry Smith     if (jac->bs > 0) {
161c9c6ffaaSJed Brown       ierr = PetscViewerASCIIPrintf(viewer,"  FieldSplit with Schur preconditioner, blocksize = %D, factorization %s\n",jac->bs,PCFieldSplitSchurFactTypes[jac->schurfactorization]);CHKERRQ(ierr);
1622c9966d7SBarry Smith     } else {
1632c9966d7SBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"  FieldSplit with Schur preconditioner, factorization %s\n",PCFieldSplitSchurFactTypes[jac->schurfactorization]);CHKERRQ(ierr);
1642c9966d7SBarry Smith     }
165f5236f50SJed Brown     if (pc->useAmat) {
166f5236f50SJed Brown       ierr = PetscViewerASCIIPrintf(viewer,"  using Amat (not Pmat) as operator for blocks\n");CHKERRQ(ierr);
167a3df900dSMatthew G Knepley     }
1683e8b8b31SMatthew G Knepley     switch (jac->schurpre) {
1693e8b8b31SMatthew G Knepley     case PC_FIELDSPLIT_SCHUR_PRE_SELF:
170a9908d51SBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"  Preconditioner for the Schur complement formed from S itself\n");CHKERRQ(ierr);
171a9908d51SBarry Smith       break;
172a7476a74SDmitry Karpeev     case PC_FIELDSPLIT_SCHUR_PRE_SELFP:
173a9908d51SBarry Smith       ierr = MatSchurComplementGetAinvType(jac->schur,&atype);CHKERRQ(ierr);
174d0a9c1a2SBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"  Preconditioner for the Schur complement formed from Sp, an assembled approximation to S, which uses A00's %sdiagonal's inverse\n",atype == MAT_SCHUR_COMPLEMENT_AINV_DIAG ? "" : (atype == MAT_SCHUR_COMPLEMENT_AINV_BLOCK_DIAG ? "block " : "lumped "));CHKERRQ(ierr);break;
175e87fab1bSBarry Smith     case PC_FIELDSPLIT_SCHUR_PRE_A11:
176a9908d51SBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"  Preconditioner for the Schur complement formed from A11\n");CHKERRQ(ierr);
177a9908d51SBarry Smith       break;
178e74569cdSMatthew G. Knepley     case PC_FIELDSPLIT_SCHUR_PRE_FULL:
179a9908d51SBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"  Preconditioner for the Schur complement formed from the exact Schur complement\n");CHKERRQ(ierr);
180a9908d51SBarry Smith       break;
1813e8b8b31SMatthew G Knepley     case PC_FIELDSPLIT_SCHUR_PRE_USER:
1823e8b8b31SMatthew G Knepley       if (jac->schur_user) {
1833e8b8b31SMatthew G Knepley         ierr = PetscViewerASCIIPrintf(viewer,"  Preconditioner for the Schur complement formed from user provided matrix\n");CHKERRQ(ierr);
1843e8b8b31SMatthew G Knepley       } else {
185e87fab1bSBarry Smith         ierr = PetscViewerASCIIPrintf(viewer,"  Preconditioner for the Schur complement formed from A11\n");CHKERRQ(ierr);
1863e8b8b31SMatthew G Knepley       }
1873e8b8b31SMatthew G Knepley       break;
1883e8b8b31SMatthew G Knepley     default:
18982f516ccSBarry Smith       SETERRQ1(PetscObjectComm((PetscObject)pc), PETSC_ERR_ARG_OUTOFRANGE, "Invalid Schur preconditioning type: %d", jac->schurpre);
1903e8b8b31SMatthew G Knepley     }
1913b224e63SBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"  Split info:\n");CHKERRQ(ierr);
1923b224e63SBarry Smith     ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
1933b224e63SBarry Smith     for (i=0; i<jac->nsplits; i++) {
1943b224e63SBarry Smith       if (ilink->fields) {
1953b224e63SBarry Smith         ierr = PetscViewerASCIIPrintf(viewer,"Split number %D Fields ",i);CHKERRQ(ierr);
1963b224e63SBarry Smith         ierr = PetscViewerASCIIUseTabs(viewer,PETSC_FALSE);CHKERRQ(ierr);
1973b224e63SBarry Smith         for (j=0; j<ilink->nfields; j++) {
1983b224e63SBarry Smith           if (j > 0) {
1993b224e63SBarry Smith             ierr = PetscViewerASCIIPrintf(viewer,",");CHKERRQ(ierr);
2003b224e63SBarry Smith           }
2013b224e63SBarry Smith           ierr = PetscViewerASCIIPrintf(viewer," %D",ilink->fields[j]);CHKERRQ(ierr);
2023b224e63SBarry Smith         }
2033b224e63SBarry Smith         ierr = PetscViewerASCIIPrintf(viewer,"\n");CHKERRQ(ierr);
2043b224e63SBarry Smith         ierr = PetscViewerASCIIUseTabs(viewer,PETSC_TRUE);CHKERRQ(ierr);
2053b224e63SBarry Smith       } else {
2063b224e63SBarry Smith         ierr = PetscViewerASCIIPrintf(viewer,"Split number %D Defined by IS\n",i);CHKERRQ(ierr);
2073b224e63SBarry Smith       }
2083b224e63SBarry Smith       ilink = ilink->next;
2093b224e63SBarry Smith     }
210435f959eSBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"KSP solver for A00 block\n");CHKERRQ(ierr);
2113b224e63SBarry Smith     ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
21206de4afeSJed Brown     if (jac->head) {
213443836d0SMatthew G Knepley       ierr = KSPView(jac->head->ksp,viewer);CHKERRQ(ierr);
21406de4afeSJed Brown     } else  {ierr = PetscViewerASCIIPrintf(viewer,"  not yet available\n");CHKERRQ(ierr);}
2153b224e63SBarry Smith     ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
21606de4afeSJed Brown     if (jac->head && jac->kspupper != jac->head->ksp) {
217443836d0SMatthew G Knepley       ierr = PetscViewerASCIIPrintf(viewer,"KSP solver for upper A00 in upper triangular factor \n");CHKERRQ(ierr);
218443836d0SMatthew G Knepley       ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
219b2750c55SJed Brown       if (jac->kspupper) {ierr = KSPView(jac->kspupper,viewer);CHKERRQ(ierr);}
220b2750c55SJed Brown       else {ierr = PetscViewerASCIIPrintf(viewer,"  not yet available\n");CHKERRQ(ierr);}
221443836d0SMatthew G Knepley       ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
222443836d0SMatthew G Knepley     }
223435f959eSBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"KSP solver for S = A11 - A10 inv(A00) A01 \n");CHKERRQ(ierr);
2243b224e63SBarry Smith     ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
22512cae6f2SJed Brown     if (jac->kspschur) {
2263b224e63SBarry Smith       ierr = KSPView(jac->kspschur,viewer);CHKERRQ(ierr);
22712cae6f2SJed Brown     } else {
22812cae6f2SJed Brown       ierr = PetscViewerASCIIPrintf(viewer,"  not yet available\n");CHKERRQ(ierr);
22912cae6f2SJed Brown     }
2303b224e63SBarry Smith     ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
2313b224e63SBarry Smith     ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
23206de4afeSJed Brown   } else if (isdraw && jac->head) {
2334996c5bdSBarry Smith     PetscDraw draw;
2344996c5bdSBarry Smith     PetscReal x,y,w,wd,h;
2354996c5bdSBarry Smith     PetscInt  cnt = 2;
2364996c5bdSBarry Smith     char      str[32];
2374996c5bdSBarry Smith 
2384996c5bdSBarry Smith     ierr = PetscViewerDrawGetDraw(viewer,0,&draw);CHKERRQ(ierr);
2394996c5bdSBarry Smith     ierr = PetscDrawGetCurrentPoint(draw,&x,&y);CHKERRQ(ierr);
240c74581afSBarry Smith     if (jac->kspupper != jac->head->ksp) cnt++;
241c74581afSBarry Smith     w  = 2*PetscMin(1.0 - x,x);
242c74581afSBarry Smith     wd = w/(cnt + 1);
243c74581afSBarry Smith 
2444996c5bdSBarry Smith     ierr = PetscSNPrintf(str,32,"Schur fact. %s",PCFieldSplitSchurFactTypes[jac->schurfactorization]);CHKERRQ(ierr);
24551fa3d41SBarry Smith     ierr = PetscDrawStringBoxed(draw,x,y,PETSC_DRAW_RED,PETSC_DRAW_BLACK,str,NULL,&h);CHKERRQ(ierr);
2464996c5bdSBarry Smith     y   -= h;
2474996c5bdSBarry Smith     if (jac->schurpre == PC_FIELDSPLIT_SCHUR_PRE_USER &&  !jac->schur_user) {
248e87fab1bSBarry Smith       ierr = PetscSNPrintf(str,32,"Prec. for Schur from %s",PCFieldSplitSchurPreTypes[PC_FIELDSPLIT_SCHUR_PRE_A11]);CHKERRQ(ierr);
2493b224e63SBarry Smith     } else {
2504996c5bdSBarry Smith       ierr = PetscSNPrintf(str,32,"Prec. for Schur from %s",PCFieldSplitSchurPreTypes[jac->schurpre]);CHKERRQ(ierr);
2514996c5bdSBarry Smith     }
25251fa3d41SBarry Smith     ierr = PetscDrawStringBoxed(draw,x+wd*(cnt-1)/2.0,y,PETSC_DRAW_RED,PETSC_DRAW_BLACK,str,NULL,&h);CHKERRQ(ierr);
2534996c5bdSBarry Smith     y   -= h;
2544996c5bdSBarry Smith     x    = x - wd*(cnt-1)/2.0;
2554996c5bdSBarry Smith 
2564996c5bdSBarry Smith     ierr = PetscDrawPushCurrentPoint(draw,x,y);CHKERRQ(ierr);
2574996c5bdSBarry Smith     ierr = KSPView(jac->head->ksp,viewer);CHKERRQ(ierr);
2584996c5bdSBarry Smith     ierr = PetscDrawPopCurrentPoint(draw);CHKERRQ(ierr);
2594996c5bdSBarry Smith     if (jac->kspupper != jac->head->ksp) {
2604996c5bdSBarry Smith       x   += wd;
2614996c5bdSBarry Smith       ierr = PetscDrawPushCurrentPoint(draw,x,y);CHKERRQ(ierr);
2624996c5bdSBarry Smith       ierr = KSPView(jac->kspupper,viewer);CHKERRQ(ierr);
2634996c5bdSBarry Smith       ierr = PetscDrawPopCurrentPoint(draw);CHKERRQ(ierr);
2644996c5bdSBarry Smith     }
2654996c5bdSBarry Smith     x   += wd;
2664996c5bdSBarry Smith     ierr = PetscDrawPushCurrentPoint(draw,x,y);CHKERRQ(ierr);
2674996c5bdSBarry Smith     ierr = KSPView(jac->kspschur,viewer);CHKERRQ(ierr);
2684996c5bdSBarry Smith     ierr = PetscDrawPopCurrentPoint(draw);CHKERRQ(ierr);
2693b224e63SBarry Smith   }
2703b224e63SBarry Smith   PetscFunctionReturn(0);
2713b224e63SBarry Smith }
2723b224e63SBarry Smith 
2736c924f48SJed Brown /* Precondition: jac->bs is set to a meaningful value */
2746c924f48SJed Brown static PetscErrorCode PCFieldSplitSetRuntimeSplits_Private(PC pc)
2756c924f48SJed Brown {
2766c924f48SJed Brown   PetscErrorCode ierr;
2776c924f48SJed Brown   PC_FieldSplit  *jac = (PC_FieldSplit*)pc->data;
2785d4c12cdSJungho Lee   PetscInt       i,nfields,*ifields,nfields_col,*ifields_col;
2795d4c12cdSJungho Lee   PetscBool      flg,flg_col;
2805d4c12cdSJungho Lee   char           optionname[128],splitname[8],optionname_col[128];
2816c924f48SJed Brown 
2826c924f48SJed Brown   PetscFunctionBegin;
283785e854fSJed Brown   ierr = PetscMalloc1(jac->bs,&ifields);CHKERRQ(ierr);
284785e854fSJed Brown   ierr = PetscMalloc1(jac->bs,&ifields_col);CHKERRQ(ierr);
2856c924f48SJed Brown   for (i=0,flg=PETSC_TRUE;; i++) {
2868caf3d72SBarry Smith     ierr        = PetscSNPrintf(splitname,sizeof(splitname),"%D",i);CHKERRQ(ierr);
2878caf3d72SBarry Smith     ierr        = PetscSNPrintf(optionname,sizeof(optionname),"-pc_fieldsplit_%D_fields",i);CHKERRQ(ierr);
2888caf3d72SBarry Smith     ierr        = PetscSNPrintf(optionname_col,sizeof(optionname_col),"-pc_fieldsplit_%D_fields_col",i);CHKERRQ(ierr);
2896c924f48SJed Brown     nfields     = jac->bs;
29029499fbbSJungho Lee     nfields_col = jac->bs;
291c5929fdfSBarry Smith     ierr        = PetscOptionsGetIntArray(((PetscObject)pc)->options,((PetscObject)pc)->prefix,optionname,ifields,&nfields,&flg);CHKERRQ(ierr);
292c5929fdfSBarry Smith     ierr        = PetscOptionsGetIntArray(((PetscObject)pc)->options,((PetscObject)pc)->prefix,optionname_col,ifields_col,&nfields_col,&flg_col);CHKERRQ(ierr);
2936c924f48SJed Brown     if (!flg) break;
2945d4c12cdSJungho Lee     else if (flg && !flg_col) {
2955d4c12cdSJungho Lee       if (!nfields) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_USER,"Cannot list zero fields");
2965d4c12cdSJungho Lee       ierr = PCFieldSplitSetFields(pc,splitname,nfields,ifields,ifields);CHKERRQ(ierr);
2972fa5cd67SKarl Rupp     } else {
2985d4c12cdSJungho Lee       if (!nfields || !nfields_col) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_USER,"Cannot list zero fields");
2995d4c12cdSJungho Lee       if (nfields != nfields_col) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_USER,"Number of row and column fields must match");
3005d4c12cdSJungho Lee       ierr = PCFieldSplitSetFields(pc,splitname,nfields,ifields,ifields_col);CHKERRQ(ierr);
3015d4c12cdSJungho Lee     }
3026c924f48SJed Brown   }
3036c924f48SJed Brown   if (i > 0) {
3046c924f48SJed Brown     /* Makes command-line setting of splits take precedence over setting them in code.
3056c924f48SJed Brown        Otherwise subsequent calls to PCFieldSplitSetIS() or PCFieldSplitSetFields() would
3066c924f48SJed Brown        create new splits, which would probably not be what the user wanted. */
3076c924f48SJed Brown     jac->splitdefined = PETSC_TRUE;
3086c924f48SJed Brown   }
3096c924f48SJed Brown   ierr = PetscFree(ifields);CHKERRQ(ierr);
3105d4c12cdSJungho Lee   ierr = PetscFree(ifields_col);CHKERRQ(ierr);
3116c924f48SJed Brown   PetscFunctionReturn(0);
3126c924f48SJed Brown }
3136c924f48SJed Brown 
31469a612a9SBarry Smith static PetscErrorCode PCFieldSplitSetDefaults(PC pc)
3150971522cSBarry Smith {
3160971522cSBarry Smith   PC_FieldSplit     *jac = (PC_FieldSplit*)pc->data;
3170971522cSBarry Smith   PetscErrorCode    ierr;
3185a9f2f41SSatish Balay   PC_FieldSplitLink ilink = jac->head;
3193a062f41SBarry Smith   PetscBool         fieldsplit_default = PETSC_FALSE,stokes = PETSC_FALSE,coupling = PETSC_FALSE;
3206c924f48SJed Brown   PetscInt          i;
3210971522cSBarry Smith 
3220971522cSBarry Smith   PetscFunctionBegin;
3237287d2a3SDmitry Karpeev   /*
324f5f0d762SBarry Smith    Kinda messy, but at least this now uses DMCreateFieldDecomposition().
3257287d2a3SDmitry Karpeev    Should probably be rewritten.
3267287d2a3SDmitry Karpeev    */
327f5f0d762SBarry Smith   if (!ilink) {
328c5929fdfSBarry Smith     ierr = PetscOptionsGetBool(((PetscObject)pc)->options,((PetscObject)pc)->prefix,"-pc_fieldsplit_detect_saddle_point",&stokes,NULL);CHKERRQ(ierr);
329c5929fdfSBarry Smith     ierr = PetscOptionsGetBool(((PetscObject)pc)->options,((PetscObject)pc)->prefix,"-pc_fieldsplit_detect_coupling",&coupling,NULL);CHKERRQ(ierr);
3303a062f41SBarry Smith     if (pc->dm && jac->dm_splits && !stokes && !coupling) {
331bafc1b83SMatthew G Knepley       PetscInt  numFields, f, i, j;
3320784a22cSJed Brown       char      **fieldNames;
3337b62db95SJungho Lee       IS        *fields;
334e7c4fc90SDmitry Karpeev       DM        *dms;
335bafc1b83SMatthew G Knepley       DM        subdm[128];
336bafc1b83SMatthew G Knepley       PetscBool flg;
337bafc1b83SMatthew G Knepley 
33816621825SDmitry Karpeev       ierr = DMCreateFieldDecomposition(pc->dm, &numFields, &fieldNames, &fields, &dms);CHKERRQ(ierr);
339bafc1b83SMatthew G Knepley       /* Allow the user to prescribe the splits */
340bafc1b83SMatthew G Knepley       for (i = 0, flg = PETSC_TRUE;; i++) {
341bafc1b83SMatthew G Knepley         PetscInt ifields[128];
342bafc1b83SMatthew G Knepley         IS       compField;
343bafc1b83SMatthew G Knepley         char     optionname[128], splitname[8];
344bafc1b83SMatthew G Knepley         PetscInt nfields = numFields;
345bafc1b83SMatthew G Knepley 
3468caf3d72SBarry Smith         ierr = PetscSNPrintf(optionname, sizeof(optionname), "-pc_fieldsplit_%D_fields", i);CHKERRQ(ierr);
347c5929fdfSBarry Smith         ierr = PetscOptionsGetIntArray(((PetscObject)pc)->options,((PetscObject)pc)->prefix, optionname, ifields, &nfields, &flg);CHKERRQ(ierr);
348bafc1b83SMatthew G Knepley         if (!flg) break;
34982f516ccSBarry Smith         if (numFields > 128) SETERRQ1(PetscObjectComm((PetscObject)pc),PETSC_ERR_SUP,"Cannot currently support %d > 128 fields", numFields);
350bafc1b83SMatthew G Knepley         ierr = DMCreateSubDM(pc->dm, nfields, ifields, &compField, &subdm[i]);CHKERRQ(ierr);
351bafc1b83SMatthew G Knepley         if (nfields == 1) {
352bafc1b83SMatthew G Knepley           ierr = PCFieldSplitSetIS(pc, fieldNames[ifields[0]], compField);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);
3567287d2a3SDmitry Karpeev         }
357bafc1b83SMatthew G Knepley         ierr = ISDestroy(&compField);CHKERRQ(ierr);
358bafc1b83SMatthew G Knepley         for (j = 0; j < nfields; ++j) {
359bafc1b83SMatthew G Knepley           f    = ifields[j];
3607b62db95SJungho Lee           ierr = PetscFree(fieldNames[f]);CHKERRQ(ierr);
3617b62db95SJungho Lee           ierr = ISDestroy(&fields[f]);CHKERRQ(ierr);
3627b62db95SJungho Lee         }
363bafc1b83SMatthew G Knepley       }
364bafc1b83SMatthew G Knepley       if (i == 0) {
365bafc1b83SMatthew G Knepley         for (f = 0; f < numFields; ++f) {
366bafc1b83SMatthew G Knepley           ierr = PCFieldSplitSetIS(pc, fieldNames[f], fields[f]);CHKERRQ(ierr);
367bafc1b83SMatthew G Knepley           ierr = PetscFree(fieldNames[f]);CHKERRQ(ierr);
368bafc1b83SMatthew G Knepley           ierr = ISDestroy(&fields[f]);CHKERRQ(ierr);
369bafc1b83SMatthew G Knepley         }
370bafc1b83SMatthew G Knepley       } else {
371d724dfffSBarry Smith         for (j=0; j<numFields; j++) {
372d724dfffSBarry Smith           ierr = DMDestroy(dms+j);CHKERRQ(ierr);
373d724dfffSBarry Smith         }
374d724dfffSBarry Smith         ierr = PetscFree(dms);CHKERRQ(ierr);
375785e854fSJed Brown         ierr = PetscMalloc1(i, &dms);CHKERRQ(ierr);
3762fa5cd67SKarl Rupp         for (j = 0; j < i; ++j) dms[j] = subdm[j];
377bafc1b83SMatthew G Knepley       }
3787b62db95SJungho Lee       ierr = PetscFree(fieldNames);CHKERRQ(ierr);
3797b62db95SJungho Lee       ierr = PetscFree(fields);CHKERRQ(ierr);
380e7c4fc90SDmitry Karpeev       if (dms) {
3818b8307b2SJed Brown         ierr = PetscInfo(pc, "Setting up physics based fieldsplit preconditioner using the embedded DM\n");CHKERRQ(ierr);
382bafc1b83SMatthew G Knepley         for (ilink = jac->head, i = 0; ilink; ilink = ilink->next, ++i) {
3837287d2a3SDmitry Karpeev           const char *prefix;
3847287d2a3SDmitry Karpeev           ierr = PetscObjectGetOptionsPrefix((PetscObject)(ilink->ksp),&prefix);CHKERRQ(ierr);
3857287d2a3SDmitry Karpeev           ierr = PetscObjectSetOptionsPrefix((PetscObject)(dms[i]), prefix);CHKERRQ(ierr);
3867b62db95SJungho Lee           ierr = KSPSetDM(ilink->ksp, dms[i]);CHKERRQ(ierr);
3877b62db95SJungho Lee           ierr = KSPSetDMActive(ilink->ksp, PETSC_FALSE);CHKERRQ(ierr);
3887287d2a3SDmitry Karpeev           ierr = PetscObjectIncrementTabLevel((PetscObject)dms[i],(PetscObject)ilink->ksp,0);CHKERRQ(ierr);
389e7c4fc90SDmitry Karpeev           ierr = DMDestroy(&dms[i]);CHKERRQ(ierr);
3902fa5ba8aSJed Brown         }
3917b62db95SJungho Lee         ierr = PetscFree(dms);CHKERRQ(ierr);
3928b8307b2SJed Brown       }
39366ffff09SJed Brown     } else {
394521d7252SBarry Smith       if (jac->bs <= 0) {
395704ba839SBarry Smith         if (pc->pmat) {
396521d7252SBarry Smith           ierr = MatGetBlockSize(pc->pmat,&jac->bs);CHKERRQ(ierr);
3972fa5cd67SKarl Rupp         } else jac->bs = 1;
398521d7252SBarry Smith       }
399d32f9abdSBarry Smith 
4006ce1633cSBarry Smith       if (stokes) {
4016ce1633cSBarry Smith         IS       zerodiags,rest;
4026ce1633cSBarry Smith         PetscInt nmin,nmax;
4036ce1633cSBarry Smith 
4046ce1633cSBarry Smith         ierr = MatGetOwnershipRange(pc->mat,&nmin,&nmax);CHKERRQ(ierr);
4056ce1633cSBarry Smith         ierr = MatFindZeroDiagonals(pc->mat,&zerodiags);CHKERRQ(ierr);
4066ce1633cSBarry Smith         ierr = ISComplement(zerodiags,nmin,nmax,&rest);CHKERRQ(ierr);
4076ce1633cSBarry Smith         ierr = PCFieldSplitSetIS(pc,"0",rest);CHKERRQ(ierr);
4086ce1633cSBarry Smith         ierr = PCFieldSplitSetIS(pc,"1",zerodiags);CHKERRQ(ierr);
409fcfd50ebSBarry Smith         ierr = ISDestroy(&zerodiags);CHKERRQ(ierr);
410fcfd50ebSBarry Smith         ierr = ISDestroy(&rest);CHKERRQ(ierr);
4113a062f41SBarry Smith       } else if (coupling) {
4123a062f41SBarry Smith         IS       coupling,rest;
4133a062f41SBarry Smith         PetscInt nmin,nmax;
4143a062f41SBarry Smith 
4153a062f41SBarry Smith         ierr = MatGetOwnershipRange(pc->mat,&nmin,&nmax);CHKERRQ(ierr);
4163a062f41SBarry Smith         ierr = MatFindOffBlockDiagonalEntries(pc->mat,&coupling);CHKERRQ(ierr);
4176bea0878SBarry Smith         ierr = ISCreateStride(PetscObjectComm((PetscObject)pc->mat),nmax-nmin,nmin,1,&rest);CHKERRQ(ierr);
418e52d2c62SBarry Smith         ierr = ISSetIdentity(rest);CHKERRQ(ierr);
419d020c841SBarry Smith         ierr = PCFieldSplitSetIS(pc,"0",rest);CHKERRQ(ierr);
420d020c841SBarry Smith         ierr = PCFieldSplitSetIS(pc,"1",coupling);CHKERRQ(ierr);
4213a062f41SBarry Smith         ierr = ISDestroy(&coupling);CHKERRQ(ierr);
4223a062f41SBarry Smith         ierr = ISDestroy(&rest);CHKERRQ(ierr);
4236ce1633cSBarry Smith       } else {
424c5929fdfSBarry Smith         ierr = PetscOptionsGetBool(((PetscObject)pc)->options,((PetscObject)pc)->prefix,"-pc_fieldsplit_default",&fieldsplit_default,NULL);CHKERRQ(ierr);
4257287d2a3SDmitry Karpeev         if (!fieldsplit_default) {
426d32f9abdSBarry Smith           /* Allow user to set fields from command line,  if bs was known at the time of PCSetFromOptions_FieldSplit()
427d32f9abdSBarry Smith            then it is set there. This is not ideal because we should only have options set in XXSetFromOptions(). */
4286c924f48SJed Brown           ierr = PCFieldSplitSetRuntimeSplits_Private(pc);CHKERRQ(ierr);
4296c924f48SJed Brown           if (jac->splitdefined) {ierr = PetscInfo(pc,"Splits defined using the options database\n");CHKERRQ(ierr);}
430d32f9abdSBarry Smith         }
4316dbb499eSCian Wilson         if ((fieldsplit_default || !jac->splitdefined) && !jac->isrestrict) {
432d32f9abdSBarry Smith           ierr = PetscInfo(pc,"Using default splitting of fields\n");CHKERRQ(ierr);
433db4c96c1SJed Brown           for (i=0; i<jac->bs; i++) {
4346c924f48SJed Brown             char splitname[8];
4358caf3d72SBarry Smith             ierr = PetscSNPrintf(splitname,sizeof(splitname),"%D",i);CHKERRQ(ierr);
4365d4c12cdSJungho Lee             ierr = PCFieldSplitSetFields(pc,splitname,1,&i,&i);CHKERRQ(ierr);
43779416396SBarry Smith           }
4385d4c12cdSJungho Lee           jac->defaultsplit = PETSC_TRUE;
439521d7252SBarry Smith         }
44066ffff09SJed Brown       }
4416ce1633cSBarry Smith     }
442edf189efSBarry Smith   } else if (jac->nsplits == 1) {
443edf189efSBarry Smith     if (ilink->is) {
444edf189efSBarry Smith       IS       is2;
445edf189efSBarry Smith       PetscInt nmin,nmax;
446edf189efSBarry Smith 
447edf189efSBarry Smith       ierr = MatGetOwnershipRange(pc->mat,&nmin,&nmax);CHKERRQ(ierr);
448edf189efSBarry Smith       ierr = ISComplement(ilink->is,nmin,nmax,&is2);CHKERRQ(ierr);
449db4c96c1SJed Brown       ierr = PCFieldSplitSetIS(pc,"1",is2);CHKERRQ(ierr);
450fcfd50ebSBarry Smith       ierr = ISDestroy(&is2);CHKERRQ(ierr);
45182f516ccSBarry Smith     } else SETERRQ(PetscObjectComm((PetscObject)pc),PETSC_ERR_SUP,"Must provide at least two sets of fields to PCFieldSplit()");
452edf189efSBarry Smith   }
453d0af7cd3SBarry Smith 
45482f516ccSBarry Smith   if (jac->nsplits < 2) SETERRQ1(PetscObjectComm((PetscObject)pc),PETSC_ERR_PLIB,"Unhandled case, must have at least two fields, not %d", jac->nsplits);
45569a612a9SBarry Smith   PetscFunctionReturn(0);
45669a612a9SBarry Smith }
45769a612a9SBarry Smith 
458c5929fdfSBarry Smith PETSC_EXTERN PetscErrorCode PetscOptionsFindPairPrefix_Private(PetscOptions,const char pre[], const char name[], char *value[], PetscBool *flg);
459514bf10dSMatthew G Knepley 
46069a612a9SBarry Smith static PetscErrorCode PCSetUp_FieldSplit(PC pc)
46169a612a9SBarry Smith {
46269a612a9SBarry Smith   PC_FieldSplit     *jac = (PC_FieldSplit*)pc->data;
46369a612a9SBarry Smith   PetscErrorCode    ierr;
4645a9f2f41SSatish Balay   PC_FieldSplitLink ilink;
4652c9966d7SBarry Smith   PetscInt          i,nsplit;
4665f4ab4e1SJungho Lee   PetscBool         sorted, sorted_col;
46769a612a9SBarry Smith 
46869a612a9SBarry Smith   PetscFunctionBegin;
46969a612a9SBarry Smith   ierr   = PCFieldSplitSetDefaults(pc);CHKERRQ(ierr);
47097bbdb24SBarry Smith   nsplit = jac->nsplits;
4715a9f2f41SSatish Balay   ilink  = jac->head;
47297bbdb24SBarry Smith 
47397bbdb24SBarry Smith   /* get the matrices for each split */
474704ba839SBarry Smith   if (!jac->issetup) {
4751b9fc7fcSBarry Smith     PetscInt rstart,rend,nslots,bs;
47697bbdb24SBarry Smith 
477704ba839SBarry Smith     jac->issetup = PETSC_TRUE;
478704ba839SBarry Smith 
4795d4c12cdSJungho Lee     /* This is done here instead of in PCFieldSplitSetFields() because may not have matrix at that point */
4802c9966d7SBarry Smith     if (jac->defaultsplit || !ilink->is) {
4812c9966d7SBarry Smith       if (jac->bs <= 0) jac->bs = nsplit;
4822c9966d7SBarry Smith     }
48351f519a2SBarry Smith     bs     = jac->bs;
48497bbdb24SBarry Smith     ierr   = MatGetOwnershipRange(pc->pmat,&rstart,&rend);CHKERRQ(ierr);
4851b9fc7fcSBarry Smith     nslots = (rend - rstart)/bs;
4861b9fc7fcSBarry Smith     for (i=0; i<nsplit; i++) {
4871b9fc7fcSBarry Smith       if (jac->defaultsplit) {
488ce94432eSBarry Smith         ierr = ISCreateStride(PetscObjectComm((PetscObject)pc),nslots,rstart+i,nsplit,&ilink->is);CHKERRQ(ierr);
4895f4ab4e1SJungho Lee         ierr = ISDuplicate(ilink->is,&ilink->is_col);CHKERRQ(ierr);
490704ba839SBarry Smith       } else if (!ilink->is) {
491ccb205f8SBarry Smith         if (ilink->nfields > 1) {
4925f4ab4e1SJungho Lee           PetscInt *ii,*jj,j,k,nfields = ilink->nfields,*fields = ilink->fields,*fields_col = ilink->fields_col;
493785e854fSJed Brown           ierr = PetscMalloc1(ilink->nfields*nslots,&ii);CHKERRQ(ierr);
494785e854fSJed Brown           ierr = PetscMalloc1(ilink->nfields*nslots,&jj);CHKERRQ(ierr);
4951b9fc7fcSBarry Smith           for (j=0; j<nslots; j++) {
4961b9fc7fcSBarry Smith             for (k=0; k<nfields; k++) {
4971b9fc7fcSBarry Smith               ii[nfields*j + k] = rstart + bs*j + fields[k];
4985f4ab4e1SJungho Lee               jj[nfields*j + k] = rstart + bs*j + fields_col[k];
49997bbdb24SBarry Smith             }
50097bbdb24SBarry Smith           }
501ce94432eSBarry Smith           ierr = ISCreateGeneral(PetscObjectComm((PetscObject)pc),nslots*nfields,ii,PETSC_OWN_POINTER,&ilink->is);CHKERRQ(ierr);
502ce94432eSBarry Smith           ierr = ISCreateGeneral(PetscObjectComm((PetscObject)pc),nslots*nfields,jj,PETSC_OWN_POINTER,&ilink->is_col);CHKERRQ(ierr);
50390e68f20SPatrick Farrell           ierr = ISSetBlockSize(ilink->is, nfields);CHKERRQ(ierr);
50490e68f20SPatrick Farrell           ierr = ISSetBlockSize(ilink->is_col, nfields);CHKERRQ(ierr);
505ccb205f8SBarry Smith         } else {
506ce94432eSBarry Smith           ierr = ISCreateStride(PetscObjectComm((PetscObject)pc),nslots,rstart+ilink->fields[0],bs,&ilink->is);CHKERRQ(ierr);
507ce94432eSBarry Smith           ierr = ISCreateStride(PetscObjectComm((PetscObject)pc),nslots,rstart+ilink->fields_col[0],bs,&ilink->is_col);CHKERRQ(ierr);
508ccb205f8SBarry Smith        }
5093e197d65SBarry Smith       }
510704ba839SBarry Smith       ierr = ISSorted(ilink->is,&sorted);CHKERRQ(ierr);
5115f4ab4e1SJungho Lee       if (ilink->is_col) { ierr = ISSorted(ilink->is_col,&sorted_col);CHKERRQ(ierr); }
5125f4ab4e1SJungho Lee       if (!sorted || !sorted_col) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_USER,"Fields must be sorted when creating split");
513704ba839SBarry Smith       ilink = ilink->next;
5141b9fc7fcSBarry Smith     }
5151b9fc7fcSBarry Smith   }
5161b9fc7fcSBarry Smith 
517704ba839SBarry Smith   ilink = jac->head;
51897bbdb24SBarry Smith   if (!jac->pmat) {
519bdddcaaaSMatthew G Knepley     Vec xtmp;
520bdddcaaaSMatthew G Knepley 
5212a7a6963SBarry Smith     ierr = MatCreateVecs(pc->pmat,&xtmp,NULL);CHKERRQ(ierr);
522785e854fSJed Brown     ierr = PetscMalloc1(nsplit,&jac->pmat);CHKERRQ(ierr);
523dcca6d9dSJed Brown     ierr = PetscMalloc2(nsplit,&jac->x,nsplit,&jac->y);CHKERRQ(ierr);
524cf502942SBarry Smith     for (i=0; i<nsplit; i++) {
525bdddcaaaSMatthew G Knepley       MatNullSpace sp;
526bdddcaaaSMatthew G Knepley 
527a3df900dSMatthew G Knepley       /* Check for preconditioning matrix attached to IS */
528a3df900dSMatthew G Knepley       ierr = PetscObjectQuery((PetscObject) ilink->is, "pmat", (PetscObject*) &jac->pmat[i]);CHKERRQ(ierr);
529a3df900dSMatthew G Knepley       if (jac->pmat[i]) {
530a3df900dSMatthew G Knepley         ierr = PetscObjectReference((PetscObject) jac->pmat[i]);CHKERRQ(ierr);
531a3df900dSMatthew G Knepley         if (jac->type == PC_COMPOSITE_SCHUR) {
532a3df900dSMatthew G Knepley           jac->schur_user = jac->pmat[i];
5332fa5cd67SKarl Rupp 
534a3df900dSMatthew G Knepley           ierr = PetscObjectReference((PetscObject) jac->schur_user);CHKERRQ(ierr);
535a3df900dSMatthew G Knepley         }
536a3df900dSMatthew G Knepley       } else {
5373a062f41SBarry Smith         const char *prefix;
5387dae84e0SHong Zhang         ierr = MatCreateSubMatrix(pc->pmat,ilink->is,ilink->is_col,MAT_INITIAL_MATRIX,&jac->pmat[i]);CHKERRQ(ierr);
5393a062f41SBarry Smith         ierr = KSPGetOptionsPrefix(ilink->ksp,&prefix);CHKERRQ(ierr);
5403a062f41SBarry Smith         ierr = MatSetOptionsPrefix(jac->pmat[i],prefix);CHKERRQ(ierr);
5413a062f41SBarry Smith         ierr = MatViewFromOptions(jac->pmat[i],NULL,"-mat_view");CHKERRQ(ierr);
542a3df900dSMatthew G Knepley       }
543bdddcaaaSMatthew G Knepley       /* create work vectors for each split */
5442a7a6963SBarry Smith       ierr     = MatCreateVecs(jac->pmat[i],&jac->x[i],&jac->y[i]);CHKERRQ(ierr);
5450298fd71SBarry Smith       ilink->x = jac->x[i]; ilink->y = jac->y[i]; ilink->z = NULL;
546bdddcaaaSMatthew G Knepley       /* compute scatter contexts needed by multiplicative versions and non-default splits */
5470298fd71SBarry Smith       ierr = VecScatterCreate(xtmp,ilink->is,jac->x[i],NULL,&ilink->sctx);CHKERRQ(ierr);
548ed1f0337SMatthew G Knepley       ierr = PetscObjectQuery((PetscObject) ilink->is, "nearnullspace", (PetscObject*) &sp);CHKERRQ(ierr);
549ed1f0337SMatthew G Knepley       if (sp) {
550ed1f0337SMatthew G Knepley         ierr = MatSetNearNullSpace(jac->pmat[i], sp);CHKERRQ(ierr);
551ed1f0337SMatthew G Knepley       }
552704ba839SBarry Smith       ilink = ilink->next;
553cf502942SBarry Smith     }
554bdddcaaaSMatthew G Knepley     ierr = VecDestroy(&xtmp);CHKERRQ(ierr);
55597bbdb24SBarry Smith   } else {
556cf502942SBarry Smith     for (i=0; i<nsplit; i++) {
557a3df900dSMatthew G Knepley       Mat pmat;
558a3df900dSMatthew G Knepley 
559a3df900dSMatthew G Knepley       /* Check for preconditioning matrix attached to IS */
560a3df900dSMatthew G Knepley       ierr = PetscObjectQuery((PetscObject) ilink->is, "pmat", (PetscObject*) &pmat);CHKERRQ(ierr);
561a3df900dSMatthew G Knepley       if (!pmat) {
5627dae84e0SHong Zhang         ierr = MatCreateSubMatrix(pc->pmat,ilink->is,ilink->is_col,MAT_REUSE_MATRIX,&jac->pmat[i]);CHKERRQ(ierr);
563a3df900dSMatthew G Knepley       }
564704ba839SBarry Smith       ilink = ilink->next;
565cf502942SBarry Smith     }
56697bbdb24SBarry Smith   }
5674e39094bSDmitry Karpeev   if (jac->diag_use_amat) {
568519d70e2SJed Brown     ilink = jac->head;
569519d70e2SJed Brown     if (!jac->mat) {
570785e854fSJed Brown       ierr = PetscMalloc1(nsplit,&jac->mat);CHKERRQ(ierr);
571519d70e2SJed Brown       for (i=0; i<nsplit; i++) {
5727dae84e0SHong Zhang         ierr  = MatCreateSubMatrix(pc->mat,ilink->is,ilink->is_col,MAT_INITIAL_MATRIX,&jac->mat[i]);CHKERRQ(ierr);
573519d70e2SJed Brown         ilink = ilink->next;
574519d70e2SJed Brown       }
575519d70e2SJed Brown     } else {
576519d70e2SJed Brown       for (i=0; i<nsplit; i++) {
5777dae84e0SHong Zhang         if (jac->mat[i]) {ierr = MatCreateSubMatrix(pc->mat,ilink->is,ilink->is_col,MAT_REUSE_MATRIX,&jac->mat[i]);CHKERRQ(ierr);}
578519d70e2SJed Brown         ilink = ilink->next;
579519d70e2SJed Brown       }
580519d70e2SJed Brown     }
581519d70e2SJed Brown   } else {
582519d70e2SJed Brown     jac->mat = jac->pmat;
583519d70e2SJed Brown   }
58497bbdb24SBarry Smith 
58553935eafSBarry Smith   /* Check for null space attached to IS */
58653935eafSBarry Smith   ilink = jac->head;
58753935eafSBarry Smith   for (i=0; i<nsplit; i++) {
58853935eafSBarry Smith     MatNullSpace sp;
58953935eafSBarry Smith 
59053935eafSBarry Smith     ierr = PetscObjectQuery((PetscObject) ilink->is, "nullspace", (PetscObject*) &sp);CHKERRQ(ierr);
59153935eafSBarry Smith     if (sp) {
59253935eafSBarry Smith       ierr = MatSetNullSpace(jac->mat[i], sp);CHKERRQ(ierr);
59353935eafSBarry Smith     }
59453935eafSBarry Smith     ilink = ilink->next;
59553935eafSBarry Smith   }
59653935eafSBarry Smith 
5976c8605c2SJed Brown   if (jac->type != PC_COMPOSITE_ADDITIVE  && jac->type != PC_COMPOSITE_SCHUR) {
59868dd23aaSBarry Smith     /* extract the rows of the matrix associated with each field: used for efficient computation of residual inside algorithm */
5994e39094bSDmitry Karpeev     /* FIXME: Can/should we reuse jac->mat whenever (jac->diag_use_amat) is true? */
60068dd23aaSBarry Smith     ilink = jac->head;
601e52d2c62SBarry Smith     if (nsplit == 2 && jac->type == PC_COMPOSITE_MULTIPLICATIVE) {
602e52d2c62SBarry 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 */
603e52d2c62SBarry Smith       if (!jac->Afield) {
604e52d2c62SBarry Smith         ierr = PetscCalloc1(nsplit,&jac->Afield);CHKERRQ(ierr);
60580c96bb1SFande Kong         if (jac->offdiag_use_amat) {
6067dae84e0SHong Zhang           ierr  = MatCreateSubMatrix(pc->mat,ilink->next->is,ilink->is,MAT_INITIAL_MATRIX,&jac->Afield[1]);CHKERRQ(ierr);
607e52d2c62SBarry Smith         } else {
6087dae84e0SHong Zhang           ierr  = MatCreateSubMatrix(pc->pmat,ilink->next->is,ilink->is,MAT_INITIAL_MATRIX,&jac->Afield[1]);CHKERRQ(ierr);
60980c96bb1SFande Kong         }
61080c96bb1SFande Kong       } else {
61180c96bb1SFande Kong         if (jac->offdiag_use_amat) {
6127dae84e0SHong Zhang           ierr  = MatCreateSubMatrix(pc->mat,ilink->next->is,ilink->is,MAT_REUSE_MATRIX,&jac->Afield[1]);CHKERRQ(ierr);
61380c96bb1SFande Kong         } else {
6147dae84e0SHong Zhang           ierr  = MatCreateSubMatrix(pc->pmat,ilink->next->is,ilink->is,MAT_REUSE_MATRIX,&jac->Afield[1]);CHKERRQ(ierr);
61580c96bb1SFande Kong         }
616e52d2c62SBarry Smith       }
617e52d2c62SBarry Smith     } else {
61868dd23aaSBarry Smith       if (!jac->Afield) {
619785e854fSJed Brown         ierr = PetscMalloc1(nsplit,&jac->Afield);CHKERRQ(ierr);
62068dd23aaSBarry Smith         for (i=0; i<nsplit; i++) {
62180c96bb1SFande Kong           if (jac->offdiag_use_amat) {
6227dae84e0SHong Zhang             ierr  = MatCreateSubMatrix(pc->mat,ilink->is,NULL,MAT_INITIAL_MATRIX,&jac->Afield[i]);CHKERRQ(ierr);
62380c96bb1SFande Kong           } else {
6247dae84e0SHong Zhang             ierr  = MatCreateSubMatrix(pc->pmat,ilink->is,NULL,MAT_INITIAL_MATRIX,&jac->Afield[i]);CHKERRQ(ierr);
62580c96bb1SFande Kong           }
62668dd23aaSBarry Smith           ilink = ilink->next;
62768dd23aaSBarry Smith         }
62868dd23aaSBarry Smith       } else {
62968dd23aaSBarry Smith         for (i=0; i<nsplit; i++) {
63080c96bb1SFande Kong           if (jac->offdiag_use_amat) {
6317dae84e0SHong Zhang             ierr  = MatCreateSubMatrix(pc->mat,ilink->is,NULL,MAT_REUSE_MATRIX,&jac->Afield[i]);CHKERRQ(ierr);
63280c96bb1SFande Kong           } else {
6337dae84e0SHong Zhang             ierr  = MatCreateSubMatrix(pc->pmat,ilink->is,NULL,MAT_REUSE_MATRIX,&jac->Afield[i]);CHKERRQ(ierr);
63480c96bb1SFande Kong           }
63568dd23aaSBarry Smith           ilink = ilink->next;
63668dd23aaSBarry Smith         }
63768dd23aaSBarry Smith       }
63868dd23aaSBarry Smith     }
639e52d2c62SBarry Smith   }
64068dd23aaSBarry Smith 
6413b224e63SBarry Smith   if (jac->type == PC_COMPOSITE_SCHUR) {
6423b224e63SBarry Smith     IS          ccis;
643c096484dSStefano Zampini     PetscBool   isspd;
6444aa3045dSJed Brown     PetscInt    rstart,rend;
645093c86ffSJed Brown     char        lscname[256];
646093c86ffSJed Brown     PetscObject LSC_L;
647ce94432eSBarry Smith 
648ce94432eSBarry Smith     if (nsplit != 2) SETERRQ(PetscObjectComm((PetscObject)pc),PETSC_ERR_ARG_INCOMP,"To use Schur complement preconditioner you must have exactly 2 fields");
64968dd23aaSBarry Smith 
650c096484dSStefano Zampini     /* If pc->mat is SPD, don't scale by -1 the Schur complement */
651c096484dSStefano Zampini     if (jac->schurscale == (PetscScalar)-1.0) {
652c096484dSStefano Zampini       ierr = MatGetOption(pc->pmat,MAT_SPD,&isspd);CHKERRQ(ierr);
653c096484dSStefano Zampini       jac->schurscale = (isspd == PETSC_TRUE) ? 1.0 : -1.0;
654c096484dSStefano Zampini     }
655c096484dSStefano Zampini 
656e6cab6aaSJed Brown     /* When extracting off-diagonal submatrices, we take complements from this range */
657e6cab6aaSJed Brown     ierr = MatGetOwnershipRangeColumn(pc->mat,&rstart,&rend);CHKERRQ(ierr);
658e6cab6aaSJed Brown 
6593b224e63SBarry Smith     /* need to handle case when one is resetting up the preconditioner */
6603b224e63SBarry Smith     if (jac->schur) {
6610298fd71SBarry Smith       KSP kspA = jac->head->ksp, kspInner = NULL, kspUpper = jac->kspupper;
662443836d0SMatthew G Knepley 
663fb3147dbSMatthew G Knepley       ierr  = MatSchurComplementGetKSP(jac->schur, &kspInner);CHKERRQ(ierr);
6643b224e63SBarry Smith       ilink = jac->head;
66549bb4cd7SJungho Lee       ierr  = ISComplement(ilink->is_col,rstart,rend,&ccis);CHKERRQ(ierr);
6664e39094bSDmitry Karpeev       if (jac->offdiag_use_amat) {
6677dae84e0SHong Zhang 	ierr  = MatCreateSubMatrix(pc->mat,ilink->is,ccis,MAT_REUSE_MATRIX,&jac->B);CHKERRQ(ierr);
668c84da90fSDmitry Karpeev       } else {
6697dae84e0SHong Zhang 	ierr  = MatCreateSubMatrix(pc->pmat,ilink->is,ccis,MAT_REUSE_MATRIX,&jac->B);CHKERRQ(ierr);
670c84da90fSDmitry Karpeev       }
671fcfd50ebSBarry Smith       ierr  = ISDestroy(&ccis);CHKERRQ(ierr);
6723b224e63SBarry Smith       ilink = ilink->next;
67349bb4cd7SJungho Lee       ierr  = ISComplement(ilink->is_col,rstart,rend,&ccis);CHKERRQ(ierr);
6744e39094bSDmitry Karpeev       if (jac->offdiag_use_amat) {
6757dae84e0SHong Zhang 	ierr  = MatCreateSubMatrix(pc->mat,ilink->is,ccis,MAT_REUSE_MATRIX,&jac->C);CHKERRQ(ierr);
676c84da90fSDmitry Karpeev       } else {
6777dae84e0SHong Zhang 	ierr  = MatCreateSubMatrix(pc->pmat,ilink->is,ccis,MAT_REUSE_MATRIX,&jac->C);CHKERRQ(ierr);
678c84da90fSDmitry Karpeev       }
679fcfd50ebSBarry Smith       ierr  = ISDestroy(&ccis);CHKERRQ(ierr);
680aa6c7ce3SBarry Smith       ierr  = MatSchurComplementUpdateSubMatrices(jac->schur,jac->mat[0],jac->pmat[0],jac->B,jac->C,jac->mat[1]);CHKERRQ(ierr);
681a7476a74SDmitry Karpeev       if (jac->schurpre == PC_FIELDSPLIT_SCHUR_PRE_SELFP) {
682a7476a74SDmitry Karpeev 	ierr = MatDestroy(&jac->schurp);CHKERRQ(ierr);
683a7476a74SDmitry Karpeev 	ierr = MatSchurComplementGetPmat(jac->schur,MAT_INITIAL_MATRIX,&jac->schurp);CHKERRQ(ierr);
684a7476a74SDmitry Karpeev       }
685443836d0SMatthew G Knepley       if (kspA != kspInner) {
68623ee1639SBarry Smith         ierr = KSPSetOperators(kspA,jac->mat[0],jac->pmat[0]);CHKERRQ(ierr);
687443836d0SMatthew G Knepley       }
688443836d0SMatthew G Knepley       if (kspUpper != kspA) {
68923ee1639SBarry Smith         ierr = KSPSetOperators(kspUpper,jac->mat[0],jac->pmat[0]);CHKERRQ(ierr);
690443836d0SMatthew G Knepley       }
69123ee1639SBarry Smith       ierr = KSPSetOperators(jac->kspschur,jac->schur,FieldSplitSchurPre(jac));CHKERRQ(ierr);
6923b224e63SBarry Smith     } else {
693bafc1b83SMatthew G Knepley       const char   *Dprefix;
694470b340bSDmitry Karpeev       char         schurprefix[256], schurmatprefix[256];
695514bf10dSMatthew G Knepley       char         schurtestoption[256];
696bdddcaaaSMatthew G Knepley       MatNullSpace sp;
697514bf10dSMatthew G Knepley       PetscBool    flg;
6983b224e63SBarry Smith 
699a04f6461SBarry Smith       /* extract the A01 and A10 matrices */
7003b224e63SBarry Smith       ilink = jac->head;
70149bb4cd7SJungho Lee       ierr  = ISComplement(ilink->is_col,rstart,rend,&ccis);CHKERRQ(ierr);
7024e39094bSDmitry Karpeev       if (jac->offdiag_use_amat) {
7037dae84e0SHong Zhang 	ierr  = MatCreateSubMatrix(pc->mat,ilink->is,ccis,MAT_INITIAL_MATRIX,&jac->B);CHKERRQ(ierr);
704c84da90fSDmitry Karpeev       } else {
7057dae84e0SHong Zhang 	ierr  = MatCreateSubMatrix(pc->pmat,ilink->is,ccis,MAT_INITIAL_MATRIX,&jac->B);CHKERRQ(ierr);
706c84da90fSDmitry Karpeev       }
707fcfd50ebSBarry Smith       ierr  = ISDestroy(&ccis);CHKERRQ(ierr);
7083b224e63SBarry Smith       ilink = ilink->next;
70949bb4cd7SJungho Lee       ierr  = ISComplement(ilink->is_col,rstart,rend,&ccis);CHKERRQ(ierr);
7104e39094bSDmitry Karpeev       if (jac->offdiag_use_amat) {
7117dae84e0SHong Zhang 	ierr  = MatCreateSubMatrix(pc->mat,ilink->is,ccis,MAT_INITIAL_MATRIX,&jac->C);CHKERRQ(ierr);
712c84da90fSDmitry Karpeev       } else {
7137dae84e0SHong Zhang 	ierr  = MatCreateSubMatrix(pc->pmat,ilink->is,ccis,MAT_INITIAL_MATRIX,&jac->C);CHKERRQ(ierr);
714c84da90fSDmitry Karpeev       }
715fcfd50ebSBarry Smith       ierr  = ISDestroy(&ccis);CHKERRQ(ierr);
71620252d06SBarry Smith 
717f5236f50SJed Brown       /* Use mat[0] (diagonal block of Amat) preconditioned by pmat[0] to define Schur complement */
71820252d06SBarry Smith       ierr = MatCreate(((PetscObject)jac->mat[0])->comm,&jac->schur);CHKERRQ(ierr);
71920252d06SBarry Smith       ierr = MatSetType(jac->schur,MATSCHURCOMPLEMENT);CHKERRQ(ierr);
720bee83525SDmitry Karpeev       ierr = MatSchurComplementSetSubMatrices(jac->schur,jac->mat[0],jac->pmat[0],jac->B,jac->C,jac->mat[1]);CHKERRQ(ierr);
721470b340bSDmitry Karpeev       ierr = PetscSNPrintf(schurmatprefix, sizeof(schurmatprefix), "%sfieldsplit_%s_", ((PetscObject)pc)->prefix ? ((PetscObject)pc)->prefix : "", ilink->splitname);CHKERRQ(ierr);
722470b340bSDmitry 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? */
723470b340bSDmitry Karpeev       ierr = MatSetOptionsPrefix(jac->schur,schurmatprefix);CHKERRQ(ierr);
724470b340bSDmitry Karpeev       ierr = MatSetFromOptions(jac->schur);CHKERRQ(ierr);
725895c21f2SBarry Smith       ierr = MatGetNullSpace(jac->mat[1], &sp);CHKERRQ(ierr);
72620252d06SBarry Smith       if (sp) {
72720252d06SBarry Smith         ierr = MatSetNullSpace(jac->schur, sp);CHKERRQ(ierr);
72820252d06SBarry Smith       }
72920252d06SBarry Smith 
73020252d06SBarry Smith       ierr = PetscSNPrintf(schurtestoption, sizeof(schurtestoption), "-fieldsplit_%s_inner_", ilink->splitname);CHKERRQ(ierr);
731c5929fdfSBarry Smith       ierr = PetscOptionsFindPairPrefix_Private(((PetscObject)pc)->options,((PetscObject)pc)->prefix, schurtestoption, NULL, &flg);CHKERRQ(ierr);
732514bf10dSMatthew G Knepley       if (flg) {
733514bf10dSMatthew G Knepley         DM  dmInner;
73421635b76SJed Brown         KSP kspInner;
73521635b76SJed Brown 
73621635b76SJed Brown         ierr = MatSchurComplementGetKSP(jac->schur, &kspInner);CHKERRQ(ierr);
737*2cc093acSMatthew G. Knepley         ierr = KSPReset(kspInner);CHKERRQ(ierr);
738*2cc093acSMatthew G. Knepley         ierr = KSPSetOperators(kspInner,jac->mat[0],jac->pmat[0]);CHKERRQ(ierr);
73921635b76SJed Brown         ierr = PetscSNPrintf(schurprefix, sizeof(schurprefix), "%sfieldsplit_%s_inner_", ((PetscObject)pc)->prefix ? ((PetscObject)pc)->prefix : "", ilink->splitname);CHKERRQ(ierr);
74021635b76SJed Brown         /* Indent this deeper to emphasize the "inner" nature of this solver. */
74121635b76SJed Brown         ierr = PetscObjectIncrementTabLevel((PetscObject)kspInner, (PetscObject) pc, 2);CHKERRQ(ierr);
742*2cc093acSMatthew G. Knepley         ierr = PetscObjectIncrementTabLevel((PetscObject)kspInner->pc, (PetscObject) pc, 2);CHKERRQ(ierr);
74321635b76SJed Brown         ierr = KSPSetOptionsPrefix(kspInner, schurprefix);CHKERRQ(ierr);
744514bf10dSMatthew G Knepley 
745514bf10dSMatthew G Knepley         /* Set DM for new solver */
746bafc1b83SMatthew G Knepley         ierr = KSPGetDM(jac->head->ksp, &dmInner);CHKERRQ(ierr);
74721635b76SJed Brown         ierr = KSPSetDM(kspInner, dmInner);CHKERRQ(ierr);
74821635b76SJed Brown         ierr = KSPSetDMActive(kspInner, PETSC_FALSE);CHKERRQ(ierr);
749514bf10dSMatthew G Knepley       } else {
75021635b76SJed Brown          /* Use the outer solver for the inner solve, but revert the KSPPREONLY from PCFieldSplitSetFields_FieldSplit or
75121635b76SJed Brown           * PCFieldSplitSetIS_FieldSplit. We don't want KSPPREONLY because it makes the Schur complement inexact,
75221635b76SJed Brown           * preventing Schur complement reduction to be an accurate solve. Usually when an iterative solver is used for
75321635b76SJed 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
75421635b76SJed Brown           * GMRES the default. Note that it is also common to use PREONLY for S, in which case S may not be used
75521635b76SJed Brown           * directly, and the user is responsible for setting an inexact method for fieldsplit's A^{-1}. */
75621635b76SJed Brown         ierr = KSPSetType(jac->head->ksp,KSPGMRES);CHKERRQ(ierr);
757514bf10dSMatthew G Knepley         ierr = MatSchurComplementSetKSP(jac->schur,jac->head->ksp);CHKERRQ(ierr);
758bafc1b83SMatthew G Knepley       }
75923ee1639SBarry Smith       ierr = KSPSetOperators(jac->head->ksp,jac->mat[0],jac->pmat[0]);CHKERRQ(ierr);
7605a9f2f41SSatish Balay       ierr = KSPSetFromOptions(jac->head->ksp);CHKERRQ(ierr);
76197bbdb24SBarry Smith       ierr = MatSetFromOptions(jac->schur);CHKERRQ(ierr);
76297bbdb24SBarry Smith 
763443836d0SMatthew G Knepley       ierr = PetscSNPrintf(schurtestoption, sizeof(schurtestoption), "-fieldsplit_%s_upper_", ilink->splitname);CHKERRQ(ierr);
764c5929fdfSBarry Smith       ierr = PetscOptionsFindPairPrefix_Private(((PetscObject)pc)->options,((PetscObject)pc)->prefix, schurtestoption, NULL, &flg);CHKERRQ(ierr);
765443836d0SMatthew G Knepley       if (flg) {
766443836d0SMatthew G Knepley         DM dmInner;
767443836d0SMatthew G Knepley 
768443836d0SMatthew G Knepley         ierr = PetscSNPrintf(schurprefix, sizeof(schurprefix), "%sfieldsplit_%s_upper_", ((PetscObject)pc)->prefix ? ((PetscObject)pc)->prefix : "", ilink->splitname);CHKERRQ(ierr);
76982f516ccSBarry Smith         ierr = KSPCreate(PetscObjectComm((PetscObject)pc), &jac->kspupper);CHKERRQ(ierr);
770422a814eSBarry Smith         ierr = KSPSetErrorIfNotConverged(jac->kspupper,pc->erroriffailure);CHKERRQ(ierr);
771443836d0SMatthew G Knepley         ierr = KSPSetOptionsPrefix(jac->kspupper, schurprefix);CHKERRQ(ierr);
772*2cc093acSMatthew G. Knepley         ierr = PetscObjectIncrementTabLevel((PetscObject)jac->kspupper, (PetscObject) pc, 1);CHKERRQ(ierr);
773*2cc093acSMatthew G. Knepley         ierr = PetscObjectIncrementTabLevel((PetscObject)jac->kspupper->pc, (PetscObject) pc, 1);CHKERRQ(ierr);
774443836d0SMatthew G Knepley         ierr = KSPGetDM(jac->head->ksp, &dmInner);CHKERRQ(ierr);
775443836d0SMatthew G Knepley         ierr = KSPSetDM(jac->kspupper, dmInner);CHKERRQ(ierr);
776443836d0SMatthew G Knepley         ierr = KSPSetDMActive(jac->kspupper, PETSC_FALSE);CHKERRQ(ierr);
777443836d0SMatthew G Knepley         ierr = KSPSetFromOptions(jac->kspupper);CHKERRQ(ierr);
77823ee1639SBarry Smith         ierr = KSPSetOperators(jac->kspupper,jac->mat[0],jac->pmat[0]);CHKERRQ(ierr);
779443836d0SMatthew G Knepley         ierr = VecDuplicate(jac->head->x, &jac->head->z);CHKERRQ(ierr);
780443836d0SMatthew G Knepley       } else {
781443836d0SMatthew G Knepley         jac->kspupper = jac->head->ksp;
782443836d0SMatthew G Knepley         ierr          = PetscObjectReference((PetscObject) jac->head->ksp);CHKERRQ(ierr);
783443836d0SMatthew G Knepley       }
784443836d0SMatthew G Knepley 
785a7476a74SDmitry Karpeev       if (jac->schurpre == PC_FIELDSPLIT_SCHUR_PRE_SELFP) {
786a7476a74SDmitry Karpeev 	ierr = MatSchurComplementGetPmat(jac->schur,MAT_INITIAL_MATRIX,&jac->schurp);CHKERRQ(ierr);
787a7476a74SDmitry Karpeev       }
788ce94432eSBarry Smith       ierr = KSPCreate(PetscObjectComm((PetscObject)pc),&jac->kspschur);CHKERRQ(ierr);
789422a814eSBarry Smith       ierr = KSPSetErrorIfNotConverged(jac->kspschur,pc->erroriffailure);CHKERRQ(ierr);
79097bbdb24SBarry Smith       ierr = PetscLogObjectParent((PetscObject)pc,(PetscObject)jac->kspschur);CHKERRQ(ierr);
79120252d06SBarry Smith       ierr = PetscObjectIncrementTabLevel((PetscObject)jac->kspschur,(PetscObject)pc,1);CHKERRQ(ierr);
79297bbdb24SBarry Smith       if (jac->schurpre == PC_FIELDSPLIT_SCHUR_PRE_SELF) {
7937233a360SDmitry Karpeev         PC pcschur;
7947233a360SDmitry Karpeev         ierr = KSPGetPC(jac->kspschur,&pcschur);CHKERRQ(ierr);
7957233a360SDmitry Karpeev         ierr = PCSetType(pcschur,PCNONE);CHKERRQ(ierr);
79697bbdb24SBarry Smith         /* Note: This is bad if there exist preconditioners for MATSCHURCOMPLEMENT */
797e74569cdSMatthew G. Knepley       } else if (jac->schurpre == PC_FIELDSPLIT_SCHUR_PRE_FULL) {
798e74569cdSMatthew G. Knepley         ierr = MatSchurComplementComputeExplicitOperator(jac->schur, &jac->schur_user);CHKERRQ(ierr);
79997bbdb24SBarry Smith       }
80023ee1639SBarry Smith       ierr = KSPSetOperators(jac->kspschur,jac->schur,FieldSplitSchurPre(jac));CHKERRQ(ierr);
80197bbdb24SBarry Smith       ierr = KSPGetOptionsPrefix(jac->head->next->ksp, &Dprefix);CHKERRQ(ierr);
80297bbdb24SBarry Smith       ierr = KSPSetOptionsPrefix(jac->kspschur,         Dprefix);CHKERRQ(ierr);
803c096484dSStefano Zampini       /* propagate DM */
804b20b4189SMatthew G. Knepley       {
805b20b4189SMatthew G. Knepley         DM sdm;
806b20b4189SMatthew G. Knepley         ierr = KSPGetDM(jac->head->next->ksp, &sdm);CHKERRQ(ierr);
807b20b4189SMatthew G. Knepley         if (sdm) {
808b20b4189SMatthew G. Knepley           ierr = KSPSetDM(jac->kspschur, sdm);CHKERRQ(ierr);
809b20b4189SMatthew G. Knepley           ierr = KSPSetDMActive(jac->kspschur, PETSC_FALSE);CHKERRQ(ierr);
810b20b4189SMatthew G. Knepley         }
811b20b4189SMatthew G. Knepley       }
81297bbdb24SBarry Smith       /* really want setfromoptions called in PCSetFromOptions_FieldSplit(), but it is not ready yet */
81397bbdb24SBarry Smith       /* need to call this every time, since the jac->kspschur is freshly created, otherwise its options never get set */
81497bbdb24SBarry Smith       ierr = KSPSetFromOptions(jac->kspschur);CHKERRQ(ierr);
81597bbdb24SBarry Smith     }
81697bbdb24SBarry Smith 
8175a9f2f41SSatish Balay     /* HACK: special support to forward L and Lp matrices that might be used by PCLSC */
8188caf3d72SBarry Smith     ierr = PetscSNPrintf(lscname,sizeof(lscname),"%s_LSC_L",ilink->splitname);CHKERRQ(ierr);
819519d70e2SJed Brown     ierr = PetscObjectQuery((PetscObject)pc->mat,lscname,(PetscObject*)&LSC_L);CHKERRQ(ierr);
8203b224e63SBarry Smith     if (!LSC_L) {ierr = PetscObjectQuery((PetscObject)pc->pmat,lscname,(PetscObject*)&LSC_L);CHKERRQ(ierr);}
821c1570756SJed Brown     if (LSC_L) {ierr = PetscObjectCompose((PetscObject)jac->schur,"LSC_L",(PetscObject)LSC_L);CHKERRQ(ierr);}
8228caf3d72SBarry Smith     ierr = PetscSNPrintf(lscname,sizeof(lscname),"%s_LSC_Lp",ilink->splitname);CHKERRQ(ierr);
82397bbdb24SBarry Smith     ierr = PetscObjectQuery((PetscObject)pc->pmat,lscname,(PetscObject*)&LSC_L);CHKERRQ(ierr);
8245a9f2f41SSatish Balay     if (!LSC_L) {ierr = PetscObjectQuery((PetscObject)pc->mat,lscname,(PetscObject*)&LSC_L);CHKERRQ(ierr);}
8250971522cSBarry Smith     if (LSC_L) {ierr = PetscObjectCompose((PetscObject)jac->schur,"LSC_Lp",(PetscObject)LSC_L);CHKERRQ(ierr);}
82697bbdb24SBarry Smith   } else {
82768bd789dSDmitry Karpeev     /* set up the individual splits' PCs */
8280971522cSBarry Smith     i     = 0;
8290971522cSBarry Smith     ilink = jac->head;
8300971522cSBarry Smith     while (ilink) {
83123ee1639SBarry Smith       ierr = KSPSetOperators(ilink->ksp,jac->mat[i],jac->pmat[i]);CHKERRQ(ierr);
8320971522cSBarry Smith       /* really want setfromoptions called in PCSetFromOptions_FieldSplit(), but it is not ready yet */
8330971522cSBarry Smith       if (!jac->suboptionsset) {ierr = KSPSetFromOptions(ilink->ksp);CHKERRQ(ierr);}
8340971522cSBarry Smith       i++;
8350971522cSBarry Smith       ilink = ilink->next;
8360971522cSBarry Smith     }
8373b224e63SBarry Smith   }
8383b224e63SBarry Smith 
839c1570756SJed Brown   jac->suboptionsset = PETSC_TRUE;
8400971522cSBarry Smith   PetscFunctionReturn(0);
8410971522cSBarry Smith }
8420971522cSBarry Smith 
8435a9f2f41SSatish Balay #define FieldSplitSplitSolveAdd(ilink,xx,yy) \
844ca9f406cSSatish Balay   (VecScatterBegin(ilink->sctx,xx,ilink->x,INSERT_VALUES,SCATTER_FORWARD) || \
845ca9f406cSSatish Balay    VecScatterEnd(ilink->sctx,xx,ilink->x,INSERT_VALUES,SCATTER_FORWARD) || \
8469df09d43SBarry Smith    PetscLogEventBegin(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL) ||\
8475a9f2f41SSatish Balay    KSPSolve(ilink->ksp,ilink->x,ilink->y) ||                               \
8489df09d43SBarry Smith    PetscLogEventEnd(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL) ||\
849ca9f406cSSatish Balay    VecScatterBegin(ilink->sctx,ilink->y,yy,ADD_VALUES,SCATTER_REVERSE) ||  \
850ca9f406cSSatish Balay    VecScatterEnd(ilink->sctx,ilink->y,yy,ADD_VALUES,SCATTER_REVERSE))
85179416396SBarry Smith 
8523b224e63SBarry Smith static PetscErrorCode PCApply_FieldSplit_Schur(PC pc,Vec x,Vec y)
8533b224e63SBarry Smith {
8543b224e63SBarry Smith   PC_FieldSplit     *jac = (PC_FieldSplit*)pc->data;
8553b224e63SBarry Smith   PetscErrorCode    ierr;
8563b224e63SBarry Smith   PC_FieldSplitLink ilinkA = jac->head, ilinkD = ilinkA->next;
857443836d0SMatthew G Knepley   KSP               kspA   = ilinkA->ksp, kspLower = kspA, kspUpper = jac->kspupper;
8583b224e63SBarry Smith 
8593b224e63SBarry Smith   PetscFunctionBegin;
860c5d2311dSJed Brown   switch (jac->schurfactorization) {
861c9c6ffaaSJed Brown   case PC_FIELDSPLIT_SCHUR_FACT_DIAG:
862a04f6461SBarry Smith     /* [A00 0; 0 -S], positive definite, suitable for MINRES */
863c5d2311dSJed Brown     ierr = VecScatterBegin(ilinkA->sctx,x,ilinkA->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
864c5d2311dSJed Brown     ierr = VecScatterBegin(ilinkD->sctx,x,ilinkD->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
865c5d2311dSJed Brown     ierr = VecScatterEnd(ilinkA->sctx,x,ilinkA->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
8669df09d43SBarry Smith     ierr = PetscLogEventBegin(ilinkA->event,kspA,ilinkA->x,ilinkA->y,NULL);CHKERRQ(ierr);
867443836d0SMatthew G Knepley     ierr = KSPSolve(kspA,ilinkA->x,ilinkA->y);CHKERRQ(ierr);
8689df09d43SBarry Smith     ierr = PetscLogEventEnd(ilinkA->event,kspA,ilinkA->x,ilinkA->y,NULL);CHKERRQ(ierr);
869c5d2311dSJed Brown     ierr = VecScatterBegin(ilinkA->sctx,ilinkA->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
870c5d2311dSJed Brown     ierr = VecScatterEnd(ilinkD->sctx,x,ilinkD->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
8719df09d43SBarry Smith     ierr = PetscLogEventBegin(KSP_Solve_FS_S,jac->kspschur,ilinkD->x,ilinkD->y,NULL);CHKERRQ(ierr);
872c5d2311dSJed Brown     ierr = KSPSolve(jac->kspschur,ilinkD->x,ilinkD->y);CHKERRQ(ierr);
8739df09d43SBarry Smith     ierr = PetscLogEventEnd(KSP_Solve_FS_S,jac->kspschur,ilinkD->x,ilinkD->y,NULL);CHKERRQ(ierr);
874c096484dSStefano Zampini     ierr = VecScale(ilinkD->y,jac->schurscale);CHKERRQ(ierr);
875c5d2311dSJed Brown     ierr = VecScatterBegin(ilinkD->sctx,ilinkD->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
876c5d2311dSJed Brown     ierr = VecScatterEnd(ilinkA->sctx,ilinkA->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
877c5d2311dSJed Brown     ierr = VecScatterEnd(ilinkD->sctx,ilinkD->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
878c5d2311dSJed Brown     break;
879c9c6ffaaSJed Brown   case PC_FIELDSPLIT_SCHUR_FACT_LOWER:
880a04f6461SBarry Smith     /* [A00 0; A10 S], suitable for left preconditioning */
881c5d2311dSJed Brown     ierr = VecScatterBegin(ilinkA->sctx,x,ilinkA->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
882c5d2311dSJed Brown     ierr = VecScatterEnd(ilinkA->sctx,x,ilinkA->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
8839df09d43SBarry Smith     ierr = PetscLogEventBegin(ilinkA->event,kspA,ilinkA->x,ilinkA->y,NULL);CHKERRQ(ierr);
884443836d0SMatthew G Knepley     ierr = KSPSolve(kspA,ilinkA->x,ilinkA->y);CHKERRQ(ierr);
8859df09d43SBarry Smith     ierr = PetscLogEventEnd(ilinkA->event,kspA,ilinkA->x,ilinkA->y,NULL);CHKERRQ(ierr);
886c5d2311dSJed Brown     ierr = MatMult(jac->C,ilinkA->y,ilinkD->x);CHKERRQ(ierr);
887c5d2311dSJed Brown     ierr = VecScale(ilinkD->x,-1.);CHKERRQ(ierr);
888c5d2311dSJed Brown     ierr = VecScatterBegin(ilinkD->sctx,x,ilinkD->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
889c5d2311dSJed Brown     ierr = VecScatterBegin(ilinkA->sctx,ilinkA->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
890c5d2311dSJed Brown     ierr = VecScatterEnd(ilinkD->sctx,x,ilinkD->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
8919df09d43SBarry Smith     ierr = PetscLogEventBegin(KSP_Solve_FS_S,jac->kspschur,ilinkD->x,ilinkD->y,NULL);CHKERRQ(ierr);
892c5d2311dSJed Brown     ierr = KSPSolve(jac->kspschur,ilinkD->x,ilinkD->y);CHKERRQ(ierr);
8939df09d43SBarry Smith     ierr = PetscLogEventEnd(KSP_Solve_FS_S,jac->kspschur,ilinkD->x,ilinkD->y,NULL);CHKERRQ(ierr);
894c5d2311dSJed Brown     ierr = VecScatterBegin(ilinkD->sctx,ilinkD->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
895c5d2311dSJed Brown     ierr = VecScatterEnd(ilinkA->sctx,ilinkA->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
896c5d2311dSJed Brown     ierr = VecScatterEnd(ilinkD->sctx,ilinkD->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
897c5d2311dSJed Brown     break;
898c9c6ffaaSJed Brown   case PC_FIELDSPLIT_SCHUR_FACT_UPPER:
899a04f6461SBarry Smith     /* [A00 A01; 0 S], suitable for right preconditioning */
900c5d2311dSJed Brown     ierr = VecScatterBegin(ilinkD->sctx,x,ilinkD->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
901c5d2311dSJed Brown     ierr = VecScatterEnd(ilinkD->sctx,x,ilinkD->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
9029df09d43SBarry Smith     ierr = PetscLogEventBegin(KSP_Solve_FS_S,jac->kspschur,ilinkD->x,ilinkD->y,NULL);CHKERRQ(ierr);
903c5d2311dSJed Brown     ierr = KSPSolve(jac->kspschur,ilinkD->x,ilinkD->y);CHKERRQ(ierr);
9049df09d43SBarry Smith     ierr = PetscLogEventEnd(KSP_Solve_FS_S,jac->kspschur,ilinkD->x,ilinkD->y,NULL);CHKERRQ(ierr);    ierr = MatMult(jac->B,ilinkD->y,ilinkA->x);CHKERRQ(ierr);
905c5d2311dSJed Brown     ierr = VecScale(ilinkA->x,-1.);CHKERRQ(ierr);
906c5d2311dSJed Brown     ierr = VecScatterBegin(ilinkA->sctx,x,ilinkA->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
907c5d2311dSJed Brown     ierr = VecScatterBegin(ilinkD->sctx,ilinkD->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
908c5d2311dSJed Brown     ierr = VecScatterEnd(ilinkA->sctx,x,ilinkA->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
9099df09d43SBarry Smith     ierr = PetscLogEventBegin(ilinkA->event,kspA,ilinkA->x,ilinkA->y,NULL);CHKERRQ(ierr);
910443836d0SMatthew G Knepley     ierr = KSPSolve(kspA,ilinkA->x,ilinkA->y);CHKERRQ(ierr);
9119df09d43SBarry Smith     ierr = PetscLogEventEnd(ilinkA->event,kspA,ilinkA->x,ilinkA->y,NULL);CHKERRQ(ierr);
912c5d2311dSJed Brown     ierr = VecScatterBegin(ilinkA->sctx,ilinkA->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
913c5d2311dSJed Brown     ierr = VecScatterEnd(ilinkD->sctx,ilinkD->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
914c5d2311dSJed Brown     ierr = VecScatterEnd(ilinkA->sctx,ilinkA->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
915c5d2311dSJed Brown     break;
916c9c6ffaaSJed Brown   case PC_FIELDSPLIT_SCHUR_FACT_FULL:
917a04f6461SBarry 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 */
9183b224e63SBarry Smith     ierr = VecScatterBegin(ilinkA->sctx,x,ilinkA->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
9193b224e63SBarry Smith     ierr = VecScatterEnd(ilinkA->sctx,x,ilinkA->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
9209df09d43SBarry Smith     ierr = PetscLogEventBegin(KSP_Solve_FS_L,kspLower,ilinkA->x,ilinkA->y,NULL);CHKERRQ(ierr);
921443836d0SMatthew G Knepley     ierr = KSPSolve(kspLower,ilinkA->x,ilinkA->y);CHKERRQ(ierr);
9229df09d43SBarry Smith     ierr = PetscLogEventEnd(KSP_Solve_FS_L,kspLower,ilinkA->x,ilinkA->y,NULL);CHKERRQ(ierr);
9233b224e63SBarry Smith     ierr = MatMult(jac->C,ilinkA->y,ilinkD->x);CHKERRQ(ierr);
9243b224e63SBarry Smith     ierr = VecScale(ilinkD->x,-1.0);CHKERRQ(ierr);
9253b224e63SBarry Smith     ierr = VecScatterBegin(ilinkD->sctx,x,ilinkD->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
9263b224e63SBarry Smith     ierr = VecScatterEnd(ilinkD->sctx,x,ilinkD->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
9273b224e63SBarry Smith 
9289df09d43SBarry Smith     ierr = PetscLogEventBegin(KSP_Solve_FS_S,jac->kspschur,ilinkD->x,ilinkD->y,NULL);CHKERRQ(ierr);
9293b224e63SBarry Smith     ierr = KSPSolve(jac->kspschur,ilinkD->x,ilinkD->y);CHKERRQ(ierr);
9309df09d43SBarry Smith     ierr = PetscLogEventEnd(KSP_Solve_FS_S,jac->kspschur,ilinkD->x,ilinkD->y,NULL);CHKERRQ(ierr);
9313b224e63SBarry Smith     ierr = VecScatterBegin(ilinkD->sctx,ilinkD->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
9323b224e63SBarry Smith     ierr = VecScatterEnd(ilinkD->sctx,ilinkD->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
9333b224e63SBarry Smith 
934443836d0SMatthew G Knepley     if (kspUpper == kspA) {
9353b224e63SBarry Smith       ierr = MatMult(jac->B,ilinkD->y,ilinkA->y);CHKERRQ(ierr);
9363b224e63SBarry Smith       ierr = VecAXPY(ilinkA->x,-1.0,ilinkA->y);CHKERRQ(ierr);
9379df09d43SBarry Smith       ierr = PetscLogEventBegin(ilinkA->event,kspA,ilinkA->x,ilinkA->y,NULL);CHKERRQ(ierr);
938443836d0SMatthew G Knepley       ierr = KSPSolve(kspA,ilinkA->x,ilinkA->y);CHKERRQ(ierr);
9399df09d43SBarry Smith       ierr = PetscLogEventEnd(ilinkA->event,kspA,ilinkA->x,ilinkA->y,NULL);CHKERRQ(ierr);
940443836d0SMatthew G Knepley     } else {
9419df09d43SBarry Smith       ierr = PetscLogEventBegin(ilinkA->event,kspA,ilinkA->x,ilinkA->y,NULL);CHKERRQ(ierr);
942443836d0SMatthew G Knepley       ierr = KSPSolve(kspA,ilinkA->x,ilinkA->y);CHKERRQ(ierr);
9439df09d43SBarry Smith       ierr = PetscLogEventEnd(ilinkA->event,kspA,ilinkA->x,ilinkA->y,NULL);CHKERRQ(ierr);
944443836d0SMatthew G Knepley       ierr = MatMult(jac->B,ilinkD->y,ilinkA->x);CHKERRQ(ierr);
9459df09d43SBarry Smith       ierr = PetscLogEventBegin(KSP_Solve_FS_U,kspUpper,ilinkA->x,ilinkA->z,NULL);CHKERRQ(ierr);
946443836d0SMatthew G Knepley       ierr = KSPSolve(kspUpper,ilinkA->x,ilinkA->z);CHKERRQ(ierr);
9479df09d43SBarry Smith       ierr = PetscLogEventEnd(KSP_Solve_FS_U,kspUpper,ilinkA->x,ilinkA->z,NULL);CHKERRQ(ierr);
948443836d0SMatthew G Knepley       ierr = VecAXPY(ilinkA->y,-1.0,ilinkA->z);CHKERRQ(ierr);
949443836d0SMatthew G Knepley     }
9503b224e63SBarry Smith     ierr = VecScatterBegin(ilinkA->sctx,ilinkA->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
9513b224e63SBarry Smith     ierr = VecScatterEnd(ilinkA->sctx,ilinkA->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
952c5d2311dSJed Brown   }
9533b224e63SBarry Smith   PetscFunctionReturn(0);
9543b224e63SBarry Smith }
9553b224e63SBarry Smith 
9560971522cSBarry Smith static PetscErrorCode PCApply_FieldSplit(PC pc,Vec x,Vec y)
9570971522cSBarry Smith {
9580971522cSBarry Smith   PC_FieldSplit      *jac = (PC_FieldSplit*)pc->data;
9590971522cSBarry Smith   PetscErrorCode     ierr;
9605a9f2f41SSatish Balay   PC_FieldSplitLink  ilink = jac->head;
961939b8a20SBarry Smith   PetscInt           cnt,bs;
962568ed31eSHong Zhang   KSPConvergedReason reason;
9630971522cSBarry Smith 
9640971522cSBarry Smith   PetscFunctionBegin;
96579416396SBarry Smith   if (jac->type == PC_COMPOSITE_ADDITIVE) {
9661b9fc7fcSBarry Smith     if (jac->defaultsplit) {
967939b8a20SBarry Smith       ierr = VecGetBlockSize(x,&bs);CHKERRQ(ierr);
968ce94432eSBarry 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);
969939b8a20SBarry Smith       ierr = VecGetBlockSize(y,&bs);CHKERRQ(ierr);
970ce94432eSBarry 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);
9710971522cSBarry Smith       ierr = VecStrideGatherAll(x,jac->x,INSERT_VALUES);CHKERRQ(ierr);
9725a9f2f41SSatish Balay       while (ilink) {
9739df09d43SBarry Smith         ierr  = PetscLogEventBegin(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL);CHKERRQ(ierr);
9745a9f2f41SSatish Balay         ierr  = KSPSolve(ilink->ksp,ilink->x,ilink->y);CHKERRQ(ierr);
9759df09d43SBarry Smith         ierr  = PetscLogEventEnd(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL);CHKERRQ(ierr);
976568ed31eSHong Zhang         ierr = KSPGetConvergedReason(ilink->ksp,&reason);CHKERRQ(ierr);
977568ed31eSHong Zhang         if (reason == KSP_DIVERGED_PCSETUP_FAILED) {
978568ed31eSHong Zhang           pc->failedreason = PC_SUBPC_ERROR;
979568ed31eSHong Zhang         }
9805a9f2f41SSatish Balay         ilink = ilink->next;
9810971522cSBarry Smith       }
9820971522cSBarry Smith       ierr = VecStrideScatterAll(jac->y,y,INSERT_VALUES);CHKERRQ(ierr);
9831b9fc7fcSBarry Smith     } else {
984efb30889SBarry Smith       ierr = VecSet(y,0.0);CHKERRQ(ierr);
9855a9f2f41SSatish Balay       while (ilink) {
9865a9f2f41SSatish Balay         ierr  = FieldSplitSplitSolveAdd(ilink,x,y);CHKERRQ(ierr);
987568ed31eSHong Zhang         ierr = KSPGetConvergedReason(ilink->ksp,&reason);CHKERRQ(ierr);
988568ed31eSHong Zhang         if (reason == KSP_DIVERGED_PCSETUP_FAILED) {
989568ed31eSHong Zhang           pc->failedreason = PC_SUBPC_ERROR;
990568ed31eSHong Zhang         }
9915a9f2f41SSatish Balay         ilink = ilink->next;
9921b9fc7fcSBarry Smith       }
9931b9fc7fcSBarry Smith     }
994e52d2c62SBarry Smith   } else if (jac->type == PC_COMPOSITE_MULTIPLICATIVE && jac->nsplits == 2) {
995e52d2c62SBarry Smith     ierr = VecSet(y,0.0);CHKERRQ(ierr);
996e52d2c62SBarry Smith     /* solve on first block for first block variables */
997e52d2c62SBarry Smith     ierr = VecScatterBegin(ilink->sctx,x,ilink->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
998e52d2c62SBarry Smith     ierr = VecScatterEnd(ilink->sctx,x,ilink->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
9999df09d43SBarry Smith     ierr = PetscLogEventBegin(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL);CHKERRQ(ierr);
1000e52d2c62SBarry Smith     ierr = KSPSolve(ilink->ksp,ilink->x,ilink->y);CHKERRQ(ierr);
10019df09d43SBarry Smith     ierr = PetscLogEventEnd(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL);CHKERRQ(ierr);
1002568ed31eSHong Zhang     ierr = KSPGetConvergedReason(ilink->ksp,&reason);CHKERRQ(ierr);
1003568ed31eSHong Zhang     if (reason == KSP_DIVERGED_PCSETUP_FAILED) {
1004568ed31eSHong Zhang       pc->failedreason = PC_SUBPC_ERROR;
1005568ed31eSHong Zhang     }
1006e52d2c62SBarry Smith     ierr = VecScatterBegin(ilink->sctx,ilink->y,y,ADD_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
1007e52d2c62SBarry Smith     ierr = VecScatterEnd(ilink->sctx,ilink->y,y,ADD_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
1008e52d2c62SBarry Smith 
1009e52d2c62SBarry Smith     /* compute the residual only onto second block variables using first block variables */
1010e52d2c62SBarry Smith     ierr = MatMult(jac->Afield[1],ilink->y,ilink->next->x);CHKERRQ(ierr);
1011e52d2c62SBarry Smith     ilink = ilink->next;
1012e52d2c62SBarry Smith     ierr = VecScale(ilink->x,-1.0);CHKERRQ(ierr);
1013e52d2c62SBarry Smith     ierr = VecScatterBegin(ilink->sctx,x,ilink->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
1014e52d2c62SBarry Smith     ierr = VecScatterEnd(ilink->sctx,x,ilink->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
1015e52d2c62SBarry Smith 
1016e52d2c62SBarry Smith     /* solve on second block variables */
10179df09d43SBarry Smith     ierr = PetscLogEventBegin(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL);CHKERRQ(ierr);
1018e52d2c62SBarry Smith     ierr = KSPSolve(ilink->ksp,ilink->x,ilink->y);CHKERRQ(ierr);
10199df09d43SBarry Smith     ierr = PetscLogEventEnd(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL);CHKERRQ(ierr);
1020568ed31eSHong Zhang     ierr = KSPGetConvergedReason(ilink->ksp,&reason);CHKERRQ(ierr);
1021568ed31eSHong Zhang     if (reason == KSP_DIVERGED_PCSETUP_FAILED) {
1022568ed31eSHong Zhang       pc->failedreason = PC_SUBPC_ERROR;
1023568ed31eSHong Zhang     }
1024e52d2c62SBarry Smith     ierr = VecScatterBegin(ilink->sctx,ilink->y,y,ADD_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
1025e52d2c62SBarry Smith     ierr = VecScatterEnd(ilink->sctx,ilink->y,y,ADD_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
102616913363SBarry Smith   } else if (jac->type == PC_COMPOSITE_MULTIPLICATIVE || jac->type == PC_COMPOSITE_SYMMETRIC_MULTIPLICATIVE) {
102779416396SBarry Smith     if (!jac->w1) {
102879416396SBarry Smith       ierr = VecDuplicate(x,&jac->w1);CHKERRQ(ierr);
102979416396SBarry Smith       ierr = VecDuplicate(x,&jac->w2);CHKERRQ(ierr);
103079416396SBarry Smith     }
1031efb30889SBarry Smith     ierr = VecSet(y,0.0);CHKERRQ(ierr);
10325a9f2f41SSatish Balay     ierr = FieldSplitSplitSolveAdd(ilink,x,y);CHKERRQ(ierr);
1033568ed31eSHong Zhang     ierr = KSPGetConvergedReason(ilink->ksp,&reason);CHKERRQ(ierr);
1034568ed31eSHong Zhang     if (reason == KSP_DIVERGED_PCSETUP_FAILED) {
1035568ed31eSHong Zhang       pc->failedreason = PC_SUBPC_ERROR;
1036568ed31eSHong Zhang     }
10373e197d65SBarry Smith     cnt  = 1;
10385a9f2f41SSatish Balay     while (ilink->next) {
10395a9f2f41SSatish Balay       ilink = ilink->next;
10403e197d65SBarry Smith       /* compute the residual only over the part of the vector needed */
10413e197d65SBarry Smith       ierr = MatMult(jac->Afield[cnt++],y,ilink->x);CHKERRQ(ierr);
10423e197d65SBarry Smith       ierr = VecScale(ilink->x,-1.0);CHKERRQ(ierr);
10433e197d65SBarry Smith       ierr = VecScatterBegin(ilink->sctx,x,ilink->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
10443e197d65SBarry Smith       ierr = VecScatterEnd(ilink->sctx,x,ilink->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
10459df09d43SBarry Smith       ierr = PetscLogEventBegin(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL);CHKERRQ(ierr);
10463e197d65SBarry Smith       ierr = KSPSolve(ilink->ksp,ilink->x,ilink->y);CHKERRQ(ierr);
10479df09d43SBarry Smith       ierr = PetscLogEventEnd(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL);CHKERRQ(ierr);
10482618eb8fSHong Zhang       ierr = KSPGetConvergedReason(ilink->ksp,&reason);CHKERRQ(ierr);
10492618eb8fSHong Zhang       if (reason == KSP_DIVERGED_PCSETUP_FAILED) {
10502618eb8fSHong Zhang         pc->failedreason = PC_SUBPC_ERROR;
10512618eb8fSHong Zhang       }
10523e197d65SBarry Smith       ierr = VecScatterBegin(ilink->sctx,ilink->y,y,ADD_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
10533e197d65SBarry Smith       ierr = VecScatterEnd(ilink->sctx,ilink->y,y,ADD_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
10543e197d65SBarry Smith     }
105551f519a2SBarry Smith     if (jac->type == PC_COMPOSITE_SYMMETRIC_MULTIPLICATIVE) {
105611755939SBarry Smith       cnt -= 2;
105751f519a2SBarry Smith       while (ilink->previous) {
105851f519a2SBarry Smith         ilink = ilink->previous;
105911755939SBarry Smith         /* compute the residual only over the part of the vector needed */
106011755939SBarry Smith         ierr = MatMult(jac->Afield[cnt--],y,ilink->x);CHKERRQ(ierr);
106111755939SBarry Smith         ierr = VecScale(ilink->x,-1.0);CHKERRQ(ierr);
106211755939SBarry Smith         ierr = VecScatterBegin(ilink->sctx,x,ilink->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
106311755939SBarry Smith         ierr = VecScatterEnd(ilink->sctx,x,ilink->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
10649df09d43SBarry Smith         ierr = PetscLogEventBegin(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL);CHKERRQ(ierr);
106511755939SBarry Smith         ierr = KSPSolve(ilink->ksp,ilink->x,ilink->y);CHKERRQ(ierr);
10669df09d43SBarry Smith         ierr = PetscLogEventEnd(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL);CHKERRQ(ierr);
1067568ed31eSHong Zhang         ierr = KSPGetConvergedReason(ilink->ksp,&reason);CHKERRQ(ierr);
1068568ed31eSHong Zhang         if (reason == KSP_DIVERGED_PCSETUP_FAILED) {
1069568ed31eSHong Zhang           pc->failedreason = PC_SUBPC_ERROR;
1070568ed31eSHong Zhang         }
107111755939SBarry Smith         ierr = VecScatterBegin(ilink->sctx,ilink->y,y,ADD_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
107211755939SBarry Smith         ierr = VecScatterEnd(ilink->sctx,ilink->y,y,ADD_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
107351f519a2SBarry Smith       }
107411755939SBarry Smith     }
1075ce94432eSBarry Smith   } else SETERRQ1(PetscObjectComm((PetscObject)pc),PETSC_ERR_SUP,"Unsupported or unknown composition",(int) jac->type);
10760971522cSBarry Smith   PetscFunctionReturn(0);
10770971522cSBarry Smith }
10780971522cSBarry Smith 
1079421e10b8SBarry Smith #define FieldSplitSplitSolveAddTranspose(ilink,xx,yy) \
1080ca9f406cSSatish Balay   (VecScatterBegin(ilink->sctx,xx,ilink->y,INSERT_VALUES,SCATTER_FORWARD) || \
1081ca9f406cSSatish Balay    VecScatterEnd(ilink->sctx,xx,ilink->y,INSERT_VALUES,SCATTER_FORWARD) || \
10829df09d43SBarry Smith    PetscLogEventBegin(ilink->event,ilink->ksp,ilink->y,ilink->x,NULL) || \
1083421e10b8SBarry Smith    KSPSolveTranspose(ilink->ksp,ilink->y,ilink->x) ||                  \
10849df09d43SBarry Smith    PetscLogEventBegin(ilink->event,ilink->ksp,ilink->y,ilink->x,NULL) || \
1085ca9f406cSSatish Balay    VecScatterBegin(ilink->sctx,ilink->x,yy,ADD_VALUES,SCATTER_REVERSE) || \
1086ca9f406cSSatish Balay    VecScatterEnd(ilink->sctx,ilink->x,yy,ADD_VALUES,SCATTER_REVERSE))
1087421e10b8SBarry Smith 
1088421e10b8SBarry Smith static PetscErrorCode PCApplyTranspose_FieldSplit(PC pc,Vec x,Vec y)
1089421e10b8SBarry Smith {
1090421e10b8SBarry Smith   PC_FieldSplit      *jac = (PC_FieldSplit*)pc->data;
1091421e10b8SBarry Smith   PetscErrorCode     ierr;
1092421e10b8SBarry Smith   PC_FieldSplitLink  ilink = jac->head;
1093939b8a20SBarry Smith   PetscInt           bs;
1094291dd214SHong Zhang   KSPConvergedReason reason;
1095421e10b8SBarry Smith 
1096421e10b8SBarry Smith   PetscFunctionBegin;
1097421e10b8SBarry Smith   if (jac->type == PC_COMPOSITE_ADDITIVE) {
1098421e10b8SBarry Smith     if (jac->defaultsplit) {
1099939b8a20SBarry Smith       ierr = VecGetBlockSize(x,&bs);CHKERRQ(ierr);
1100ce94432eSBarry Smith       if (jac->bs > 0 && bs != jac->bs) SETERRQ2(PetscObjectComm((PetscObject)pc),PETSC_ERR_ARG_WRONGSTATE,"Blocksize of x vector %D does not match fieldsplit blocksize %D",bs,jac->bs);
1101939b8a20SBarry Smith       ierr = VecGetBlockSize(y,&bs);CHKERRQ(ierr);
1102ce94432eSBarry Smith       if (jac->bs > 0 && bs != jac->bs) SETERRQ2(PetscObjectComm((PetscObject)pc),PETSC_ERR_ARG_WRONGSTATE,"Blocksize of y vector %D does not match fieldsplit blocksize %D",bs,jac->bs);
1103421e10b8SBarry Smith       ierr = VecStrideGatherAll(x,jac->x,INSERT_VALUES);CHKERRQ(ierr);
1104421e10b8SBarry Smith       while (ilink) {
11059df09d43SBarry Smith         ierr = PetscLogEventBegin(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL);CHKERRQ(ierr);
1106421e10b8SBarry Smith         ierr  = KSPSolveTranspose(ilink->ksp,ilink->x,ilink->y);CHKERRQ(ierr);
11079df09d43SBarry Smith         ierr = PetscLogEventEnd(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL);CHKERRQ(ierr);
11082618eb8fSHong Zhang         ierr = KSPGetConvergedReason(ilink->ksp,&reason);CHKERRQ(ierr);
11092618eb8fSHong Zhang         if (reason == KSP_DIVERGED_PCSETUP_FAILED) {
11102618eb8fSHong Zhang           pc->failedreason = PC_SUBPC_ERROR;
11112618eb8fSHong Zhang         }
1112421e10b8SBarry Smith         ilink = ilink->next;
1113421e10b8SBarry Smith       }
1114421e10b8SBarry Smith       ierr = VecStrideScatterAll(jac->y,y,INSERT_VALUES);CHKERRQ(ierr);
1115421e10b8SBarry Smith     } else {
1116421e10b8SBarry Smith       ierr = VecSet(y,0.0);CHKERRQ(ierr);
1117421e10b8SBarry Smith       while (ilink) {
1118421e10b8SBarry Smith         ierr = FieldSplitSplitSolveAddTranspose(ilink,x,y);CHKERRQ(ierr);
11192618eb8fSHong Zhang         ierr = KSPGetConvergedReason(ilink->ksp,&reason);CHKERRQ(ierr);
11202618eb8fSHong Zhang         if (reason == KSP_DIVERGED_PCSETUP_FAILED) {
11212618eb8fSHong Zhang           pc->failedreason = PC_SUBPC_ERROR;
11222618eb8fSHong Zhang         }
1123421e10b8SBarry Smith         ilink = ilink->next;
1124421e10b8SBarry Smith       }
1125421e10b8SBarry Smith     }
1126421e10b8SBarry Smith   } else {
1127421e10b8SBarry Smith     if (!jac->w1) {
1128421e10b8SBarry Smith       ierr = VecDuplicate(x,&jac->w1);CHKERRQ(ierr);
1129421e10b8SBarry Smith       ierr = VecDuplicate(x,&jac->w2);CHKERRQ(ierr);
1130421e10b8SBarry Smith     }
1131421e10b8SBarry Smith     ierr = VecSet(y,0.0);CHKERRQ(ierr);
1132421e10b8SBarry Smith     if (jac->type == PC_COMPOSITE_SYMMETRIC_MULTIPLICATIVE) {
1133421e10b8SBarry Smith       ierr = FieldSplitSplitSolveAddTranspose(ilink,x,y);CHKERRQ(ierr);
11342618eb8fSHong Zhang       ierr = KSPGetConvergedReason(ilink->ksp,&reason);CHKERRQ(ierr);
11352618eb8fSHong Zhang       if (reason == KSP_DIVERGED_PCSETUP_FAILED) {
11362618eb8fSHong Zhang         pc->failedreason = PC_SUBPC_ERROR;
11372618eb8fSHong Zhang       }
1138421e10b8SBarry Smith       while (ilink->next) {
1139421e10b8SBarry Smith         ilink = ilink->next;
11409989ab13SBarry Smith         ierr  = MatMultTranspose(pc->mat,y,jac->w1);CHKERRQ(ierr);
1141421e10b8SBarry Smith         ierr  = VecWAXPY(jac->w2,-1.0,jac->w1,x);CHKERRQ(ierr);
1142421e10b8SBarry Smith         ierr  = FieldSplitSplitSolveAddTranspose(ilink,jac->w2,y);CHKERRQ(ierr);
1143421e10b8SBarry Smith       }
1144421e10b8SBarry Smith       while (ilink->previous) {
1145421e10b8SBarry Smith         ilink = ilink->previous;
11469989ab13SBarry Smith         ierr  = MatMultTranspose(pc->mat,y,jac->w1);CHKERRQ(ierr);
1147421e10b8SBarry Smith         ierr  = VecWAXPY(jac->w2,-1.0,jac->w1,x);CHKERRQ(ierr);
1148421e10b8SBarry Smith         ierr  = FieldSplitSplitSolveAddTranspose(ilink,jac->w2,y);CHKERRQ(ierr);
1149421e10b8SBarry Smith       }
1150421e10b8SBarry Smith     } else {
1151421e10b8SBarry Smith       while (ilink->next) {   /* get to last entry in linked list */
1152421e10b8SBarry Smith         ilink = ilink->next;
1153421e10b8SBarry Smith       }
1154421e10b8SBarry Smith       ierr = FieldSplitSplitSolveAddTranspose(ilink,x,y);CHKERRQ(ierr);
11552618eb8fSHong Zhang       ierr = KSPGetConvergedReason(ilink->ksp,&reason);CHKERRQ(ierr);
11562618eb8fSHong Zhang       if (reason == KSP_DIVERGED_PCSETUP_FAILED) {
11572618eb8fSHong Zhang         pc->failedreason = PC_SUBPC_ERROR;
11582618eb8fSHong Zhang       }
1159421e10b8SBarry Smith       while (ilink->previous) {
1160421e10b8SBarry Smith         ilink = ilink->previous;
11619989ab13SBarry Smith         ierr  = MatMultTranspose(pc->mat,y,jac->w1);CHKERRQ(ierr);
1162421e10b8SBarry Smith         ierr  = VecWAXPY(jac->w2,-1.0,jac->w1,x);CHKERRQ(ierr);
1163421e10b8SBarry Smith         ierr  = FieldSplitSplitSolveAddTranspose(ilink,jac->w2,y);CHKERRQ(ierr);
1164421e10b8SBarry Smith       }
1165421e10b8SBarry Smith     }
1166421e10b8SBarry Smith   }
1167421e10b8SBarry Smith   PetscFunctionReturn(0);
1168421e10b8SBarry Smith }
1169421e10b8SBarry Smith 
1170574deadeSBarry Smith static PetscErrorCode PCReset_FieldSplit(PC pc)
11710971522cSBarry Smith {
11720971522cSBarry Smith   PC_FieldSplit     *jac = (PC_FieldSplit*)pc->data;
11730971522cSBarry Smith   PetscErrorCode    ierr;
11745a9f2f41SSatish Balay   PC_FieldSplitLink ilink = jac->head,next;
11750971522cSBarry Smith 
11760971522cSBarry Smith   PetscFunctionBegin;
11775a9f2f41SSatish Balay   while (ilink) {
1178f5f0d762SBarry Smith     ierr  = KSPDestroy(&ilink->ksp);CHKERRQ(ierr);
1179fcfd50ebSBarry Smith     ierr  = VecDestroy(&ilink->x);CHKERRQ(ierr);
1180fcfd50ebSBarry Smith     ierr  = VecDestroy(&ilink->y);CHKERRQ(ierr);
1181443836d0SMatthew G Knepley     ierr  = VecDestroy(&ilink->z);CHKERRQ(ierr);
1182fcfd50ebSBarry Smith     ierr  = VecScatterDestroy(&ilink->sctx);CHKERRQ(ierr);
1183fcfd50ebSBarry Smith     ierr  = ISDestroy(&ilink->is);CHKERRQ(ierr);
1184b5787286SJed Brown     ierr  = ISDestroy(&ilink->is_col);CHKERRQ(ierr);
1185f5f0d762SBarry Smith     ierr  = PetscFree(ilink->splitname);CHKERRQ(ierr);
1186f5f0d762SBarry Smith     ierr  = PetscFree(ilink->fields);CHKERRQ(ierr);
1187f5f0d762SBarry Smith     ierr  = PetscFree(ilink->fields_col);CHKERRQ(ierr);
11885a9f2f41SSatish Balay     next  = ilink->next;
1189f5f0d762SBarry Smith     ierr  = PetscFree(ilink);CHKERRQ(ierr);
11905a9f2f41SSatish Balay     ilink = next;
11910971522cSBarry Smith   }
1192f5f0d762SBarry Smith   jac->head = NULL;
119305b42c5fSBarry Smith   ierr = PetscFree2(jac->x,jac->y);CHKERRQ(ierr);
1194574deadeSBarry Smith   if (jac->mat && jac->mat != jac->pmat) {
1195574deadeSBarry Smith     ierr = MatDestroyMatrices(jac->nsplits,&jac->mat);CHKERRQ(ierr);
1196574deadeSBarry Smith   } else if (jac->mat) {
11970298fd71SBarry Smith     jac->mat = NULL;
1198574deadeSBarry Smith   }
119997bbdb24SBarry Smith   if (jac->pmat) {ierr = MatDestroyMatrices(jac->nsplits,&jac->pmat);CHKERRQ(ierr);}
120068dd23aaSBarry Smith   if (jac->Afield) {ierr = MatDestroyMatrices(jac->nsplits,&jac->Afield);CHKERRQ(ierr);}
1201f5f0d762SBarry Smith   jac->nsplits = 0;
12026bf464f9SBarry Smith   ierr       = VecDestroy(&jac->w1);CHKERRQ(ierr);
12036bf464f9SBarry Smith   ierr       = VecDestroy(&jac->w2);CHKERRQ(ierr);
12046bf464f9SBarry Smith   ierr       = MatDestroy(&jac->schur);CHKERRQ(ierr);
1205a7476a74SDmitry Karpeev   ierr       = MatDestroy(&jac->schurp);CHKERRQ(ierr);
12066bf464f9SBarry Smith   ierr       = MatDestroy(&jac->schur_user);CHKERRQ(ierr);
12076bf464f9SBarry Smith   ierr       = KSPDestroy(&jac->kspschur);CHKERRQ(ierr);
1208d78dad28SBarry Smith   ierr       = KSPDestroy(&jac->kspupper);CHKERRQ(ierr);
12096bf464f9SBarry Smith   ierr       = MatDestroy(&jac->B);CHKERRQ(ierr);
12106bf464f9SBarry Smith   ierr       = MatDestroy(&jac->C);CHKERRQ(ierr);
12116dbb499eSCian Wilson   jac->isrestrict = PETSC_FALSE;
1212574deadeSBarry Smith   PetscFunctionReturn(0);
1213574deadeSBarry Smith }
1214574deadeSBarry Smith 
1215574deadeSBarry Smith static PetscErrorCode PCDestroy_FieldSplit(PC pc)
1216574deadeSBarry Smith {
1217574deadeSBarry Smith   PetscErrorCode    ierr;
1218574deadeSBarry Smith 
1219574deadeSBarry Smith   PetscFunctionBegin;
1220574deadeSBarry Smith   ierr = PCReset_FieldSplit(pc);CHKERRQ(ierr);
1221c31cb41cSBarry Smith   ierr = PetscFree(pc->data);CHKERRQ(ierr);
1222bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitGetSubKSP_C",NULL);CHKERRQ(ierr);
1223bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetFields_C",NULL);CHKERRQ(ierr);
1224bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetIS_C",NULL);CHKERRQ(ierr);
1225bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetType_C",NULL);CHKERRQ(ierr);
1226bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetBlockSize_C",NULL);CHKERRQ(ierr);
122729f8a81cSJed Brown   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetSchurPre_C",NULL);CHKERRQ(ierr);
122837a82bf0SJed Brown   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitGetSchurPre_C",NULL);CHKERRQ(ierr);
1229bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetSchurFactType_C",NULL);CHKERRQ(ierr);
12306dbb499eSCian Wilson   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitRestrictIS_C",NULL);CHKERRQ(ierr);
12310971522cSBarry Smith   PetscFunctionReturn(0);
12320971522cSBarry Smith }
12330971522cSBarry Smith 
12344416b707SBarry Smith static PetscErrorCode PCSetFromOptions_FieldSplit(PetscOptionItems *PetscOptionsObject,PC pc)
12350971522cSBarry Smith {
12361b9fc7fcSBarry Smith   PetscErrorCode  ierr;
12376c924f48SJed Brown   PetscInt        bs;
1238bc59fbc5SBarry Smith   PetscBool       flg,stokes = PETSC_FALSE;
12399dcbbd2bSBarry Smith   PC_FieldSplit   *jac = (PC_FieldSplit*)pc->data;
12403b224e63SBarry Smith   PCCompositeType ctype;
12411b9fc7fcSBarry Smith 
12420971522cSBarry Smith   PetscFunctionBegin;
1243e55864a3SBarry Smith   ierr = PetscOptionsHead(PetscOptionsObject,"FieldSplit options");CHKERRQ(ierr);
12444ab8060aSDmitry Karpeev   ierr = PetscOptionsBool("-pc_fieldsplit_dm_splits","Whether to use DMCreateFieldDecomposition() for splits","PCFieldSplitSetDMSplits",jac->dm_splits,&jac->dm_splits,NULL);CHKERRQ(ierr);
124551f519a2SBarry Smith   ierr = PetscOptionsInt("-pc_fieldsplit_block_size","Blocksize that defines number of fields","PCFieldSplitSetBlockSize",jac->bs,&bs,&flg);CHKERRQ(ierr);
124651f519a2SBarry Smith   if (flg) {
124751f519a2SBarry Smith     ierr = PCFieldSplitSetBlockSize(pc,bs);CHKERRQ(ierr);
124851f519a2SBarry Smith   }
12492686e3e9SMatthew G. Knepley   jac->diag_use_amat = pc->useAmat;
12502686e3e9SMatthew G. Knepley   ierr = PetscOptionsBool("-pc_fieldsplit_diag_use_amat","Use Amat (not Pmat) to extract diagonal fieldsplit blocks", "PCFieldSplitSetDiagUseAmat",jac->diag_use_amat,&jac->diag_use_amat,NULL);CHKERRQ(ierr);
12512686e3e9SMatthew G. Knepley   jac->offdiag_use_amat = pc->useAmat;
12522686e3e9SMatthew G. Knepley   ierr = PetscOptionsBool("-pc_fieldsplit_off_diag_use_amat","Use Amat (not Pmat) to extract off-diagonal fieldsplit blocks", "PCFieldSplitSetOffDiagUseAmat",jac->offdiag_use_amat,&jac->offdiag_use_amat,NULL);CHKERRQ(ierr);
125300216929SDmitry Karpeev   /* FIXME: No programmatic equivalent to the following. */
1254c5929fdfSBarry Smith   ierr = PetscOptionsGetBool(((PetscObject)pc)->options,((PetscObject)pc)->prefix,"-pc_fieldsplit_detect_saddle_point",&stokes,NULL);CHKERRQ(ierr);
1255c0adfefeSBarry Smith   if (stokes) {
1256c0adfefeSBarry Smith     ierr          = PCFieldSplitSetType(pc,PC_COMPOSITE_SCHUR);CHKERRQ(ierr);
1257c0adfefeSBarry Smith     jac->schurpre = PC_FIELDSPLIT_SCHUR_PRE_SELF;
1258c0adfefeSBarry Smith   }
1259c0adfefeSBarry Smith 
12603b224e63SBarry Smith   ierr = PetscOptionsEnum("-pc_fieldsplit_type","Type of composition","PCFieldSplitSetType",PCCompositeTypes,(PetscEnum)jac->type,(PetscEnum*)&ctype,&flg);CHKERRQ(ierr);
12613b224e63SBarry Smith   if (flg) {
12623b224e63SBarry Smith     ierr = PCFieldSplitSetType(pc,ctype);CHKERRQ(ierr);
12633b224e63SBarry Smith   }
1264c30613efSMatthew Knepley   /* Only setup fields once */
1265c30613efSMatthew Knepley   if ((jac->bs > 0) && (jac->nsplits == 0)) {
1266d32f9abdSBarry Smith     /* only allow user to set fields from command line if bs is already known.
1267d32f9abdSBarry Smith        otherwise user can set them in PCFieldSplitSetDefaults() */
12686c924f48SJed Brown     ierr = PCFieldSplitSetRuntimeSplits_Private(pc);CHKERRQ(ierr);
12696c924f48SJed Brown     if (jac->splitdefined) {ierr = PetscInfo(pc,"Splits defined using the options database\n");CHKERRQ(ierr);}
1270d32f9abdSBarry Smith   }
1271c5d2311dSJed Brown   if (jac->type == PC_COMPOSITE_SCHUR) {
1272c5929fdfSBarry Smith     ierr = PetscOptionsGetEnum(((PetscObject)pc)->options,((PetscObject)pc)->prefix,"-pc_fieldsplit_schur_factorization_type",PCFieldSplitSchurFactTypes,(PetscEnum*)&jac->schurfactorization,&flg);CHKERRQ(ierr);
1273c9c6ffaaSJed Brown     if (flg) {ierr = PetscInfo(pc,"Deprecated use of -pc_fieldsplit_schur_factorization_type\n");CHKERRQ(ierr);}
12740298fd71SBarry 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);
127529f8a81cSJed 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);
1276c096484dSStefano Zampini     ierr = PetscOptionsScalar("-pc_fieldsplit_schur_scale","Scale Schur complement","PCFieldSplitSetSchurScale",jac->schurscale,&jac->schurscale,NULL);CHKERRQ(ierr);
1277c5d2311dSJed Brown   }
12781b9fc7fcSBarry Smith   ierr = PetscOptionsTail();CHKERRQ(ierr);
12790971522cSBarry Smith   PetscFunctionReturn(0);
12800971522cSBarry Smith }
12810971522cSBarry Smith 
12820971522cSBarry Smith /*------------------------------------------------------------------------------------*/
12830971522cSBarry Smith 
12841e6b0712SBarry Smith static PetscErrorCode  PCFieldSplitSetFields_FieldSplit(PC pc,const char splitname[],PetscInt n,const PetscInt *fields,const PetscInt *fields_col)
12850971522cSBarry Smith {
128697bbdb24SBarry Smith   PC_FieldSplit     *jac = (PC_FieldSplit*)pc->data;
12870971522cSBarry Smith   PetscErrorCode    ierr;
12885a9f2f41SSatish Balay   PC_FieldSplitLink ilink,next = jac->head;
128969a612a9SBarry Smith   char              prefix[128];
12905d4c12cdSJungho Lee   PetscInt          i;
12910971522cSBarry Smith 
12920971522cSBarry Smith   PetscFunctionBegin;
12936c924f48SJed Brown   if (jac->splitdefined) {
12946c924f48SJed Brown     ierr = PetscInfo1(pc,"Ignoring new split \"%s\" because the splits have already been defined\n",splitname);CHKERRQ(ierr);
12956c924f48SJed Brown     PetscFunctionReturn(0);
12966c924f48SJed Brown   }
129751f519a2SBarry Smith   for (i=0; i<n; i++) {
1298e32f2f54SBarry 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);
1299e32f2f54SBarry Smith     if (fields[i] < 0) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Negative field %D requested",fields[i]);
130051f519a2SBarry Smith   }
1301b00a9115SJed Brown   ierr = PetscNew(&ilink);CHKERRQ(ierr);
1302a04f6461SBarry Smith   if (splitname) {
1303db4c96c1SJed Brown     ierr = PetscStrallocpy(splitname,&ilink->splitname);CHKERRQ(ierr);
1304a04f6461SBarry Smith   } else {
1305785e854fSJed Brown     ierr = PetscMalloc1(3,&ilink->splitname);CHKERRQ(ierr);
1306a04f6461SBarry Smith     ierr = PetscSNPrintf(ilink->splitname,2,"%s",jac->nsplits);CHKERRQ(ierr);
1307a04f6461SBarry Smith   }
13089df09d43SBarry Smith   ilink->event = jac->nsplits < 5 ? KSP_Solve_FS_0 + jac->nsplits : KSP_Solve_FS_0 + 4; /* Any split great than 4 gets logged in the 4th split */
1309785e854fSJed Brown   ierr = PetscMalloc1(n,&ilink->fields);CHKERRQ(ierr);
13105a9f2f41SSatish Balay   ierr = PetscMemcpy(ilink->fields,fields,n*sizeof(PetscInt));CHKERRQ(ierr);
1311785e854fSJed Brown   ierr = PetscMalloc1(n,&ilink->fields_col);CHKERRQ(ierr);
13125d4c12cdSJungho Lee   ierr = PetscMemcpy(ilink->fields_col,fields_col,n*sizeof(PetscInt));CHKERRQ(ierr);
13132fa5cd67SKarl Rupp 
13145a9f2f41SSatish Balay   ilink->nfields = n;
13150298fd71SBarry Smith   ilink->next    = NULL;
1316ce94432eSBarry Smith   ierr           = KSPCreate(PetscObjectComm((PetscObject)pc),&ilink->ksp);CHKERRQ(ierr);
1317422a814eSBarry Smith   ierr           = KSPSetErrorIfNotConverged(ilink->ksp,pc->erroriffailure);CHKERRQ(ierr);
131820252d06SBarry Smith   ierr           = PetscObjectIncrementTabLevel((PetscObject)ilink->ksp,(PetscObject)pc,1);CHKERRQ(ierr);
13195a9f2f41SSatish Balay   ierr           = KSPSetType(ilink->ksp,KSPPREONLY);CHKERRQ(ierr);
13209005cf84SBarry Smith   ierr           = PetscLogObjectParent((PetscObject)pc,(PetscObject)ilink->ksp);CHKERRQ(ierr);
132169a612a9SBarry Smith 
13228caf3d72SBarry Smith   ierr = PetscSNPrintf(prefix,sizeof(prefix),"%sfieldsplit_%s_",((PetscObject)pc)->prefix ? ((PetscObject)pc)->prefix : "",ilink->splitname);CHKERRQ(ierr);
13235a9f2f41SSatish Balay   ierr = KSPSetOptionsPrefix(ilink->ksp,prefix);CHKERRQ(ierr);
13240971522cSBarry Smith 
13250971522cSBarry Smith   if (!next) {
13265a9f2f41SSatish Balay     jac->head       = ilink;
13270298fd71SBarry Smith     ilink->previous = NULL;
13280971522cSBarry Smith   } else {
13290971522cSBarry Smith     while (next->next) {
13300971522cSBarry Smith       next = next->next;
13310971522cSBarry Smith     }
13325a9f2f41SSatish Balay     next->next      = ilink;
133351f519a2SBarry Smith     ilink->previous = next;
13340971522cSBarry Smith   }
13350971522cSBarry Smith   jac->nsplits++;
13360971522cSBarry Smith   PetscFunctionReturn(0);
13370971522cSBarry Smith }
13380971522cSBarry Smith 
13391e6b0712SBarry Smith static PetscErrorCode  PCFieldSplitGetSubKSP_FieldSplit_Schur(PC pc,PetscInt *n,KSP **subksp)
1340e69d4d44SBarry Smith {
1341e69d4d44SBarry Smith   PC_FieldSplit  *jac = (PC_FieldSplit*)pc->data;
1342e69d4d44SBarry Smith   PetscErrorCode ierr;
1343e69d4d44SBarry Smith 
1344e69d4d44SBarry Smith   PetscFunctionBegin;
134534a3b412SBarry Smith   if (!jac->schur) SETERRQ(PetscObjectComm((PetscObject)pc),PETSC_ERR_ARG_WRONGSTATE,"Must call KSPSetUp() or PCSetUp() before calling PCFieldSplitGetSubKSP()");
1346785e854fSJed Brown   ierr = PetscMalloc1(jac->nsplits,subksp);CHKERRQ(ierr);
1347e69d4d44SBarry Smith   ierr = MatSchurComplementGetKSP(jac->schur,*subksp);CHKERRQ(ierr);
13482fa5cd67SKarl Rupp 
1349e69d4d44SBarry Smith   (*subksp)[1] = jac->kspschur;
135013e0d083SBarry Smith   if (n) *n = jac->nsplits;
1351e69d4d44SBarry Smith   PetscFunctionReturn(0);
1352e69d4d44SBarry Smith }
13530971522cSBarry Smith 
13541e6b0712SBarry Smith static PetscErrorCode  PCFieldSplitGetSubKSP_FieldSplit(PC pc,PetscInt *n,KSP **subksp)
13550971522cSBarry Smith {
13560971522cSBarry Smith   PC_FieldSplit     *jac = (PC_FieldSplit*)pc->data;
13570971522cSBarry Smith   PetscErrorCode    ierr;
13580971522cSBarry Smith   PetscInt          cnt   = 0;
13595a9f2f41SSatish Balay   PC_FieldSplitLink ilink = jac->head;
13600971522cSBarry Smith 
13610971522cSBarry Smith   PetscFunctionBegin;
1362785e854fSJed Brown   ierr = PetscMalloc1(jac->nsplits,subksp);CHKERRQ(ierr);
13635a9f2f41SSatish Balay   while (ilink) {
13645a9f2f41SSatish Balay     (*subksp)[cnt++] = ilink->ksp;
13655a9f2f41SSatish Balay     ilink            = ilink->next;
13660971522cSBarry Smith   }
13675d480477SMatthew 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);
136813e0d083SBarry Smith   if (n) *n = jac->nsplits;
13690971522cSBarry Smith   PetscFunctionReturn(0);
13700971522cSBarry Smith }
13710971522cSBarry Smith 
13726dbb499eSCian Wilson /*@C
13736dbb499eSCian Wilson     PCFieldSplitRestrictIS - Restricts the fieldsplit ISs to be within a given IS.
13746dbb499eSCian Wilson 
13756dbb499eSCian Wilson     Input Parameters:
13766dbb499eSCian Wilson +   pc  - the preconditioner context
13776dbb499eSCian Wilson +   is - the index set that defines the indices to which the fieldsplit is to be restricted
13786dbb499eSCian Wilson 
13796dbb499eSCian Wilson     Level: advanced
13806dbb499eSCian Wilson 
13816dbb499eSCian Wilson @*/
13826dbb499eSCian Wilson PetscErrorCode  PCFieldSplitRestrictIS(PC pc,IS isy)
13836dbb499eSCian Wilson {
13846dbb499eSCian Wilson   PetscErrorCode ierr;
13856dbb499eSCian Wilson 
13866dbb499eSCian Wilson   PetscFunctionBegin;
13876dbb499eSCian Wilson   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
13886dbb499eSCian Wilson   PetscValidHeaderSpecific(isy,IS_CLASSID,2);
13890246f55cSBarry Smith   ierr = PetscTryMethod(pc,"PCFieldSplitRestrictIS_C",(PC,IS),(pc,isy));CHKERRQ(ierr);
13906dbb499eSCian Wilson   PetscFunctionReturn(0);
13916dbb499eSCian Wilson }
13926dbb499eSCian Wilson 
13936dbb499eSCian Wilson 
13946dbb499eSCian Wilson static PetscErrorCode  PCFieldSplitRestrictIS_FieldSplit(PC pc, IS isy)
13956dbb499eSCian Wilson {
13966dbb499eSCian Wilson   PC_FieldSplit     *jac = (PC_FieldSplit*)pc->data;
13976dbb499eSCian Wilson   PetscErrorCode    ierr;
13986dbb499eSCian Wilson   PC_FieldSplitLink ilink = jac->head, next;
13996dbb499eSCian Wilson   PetscInt          localsize,size,sizez,i;
14006dbb499eSCian Wilson   const PetscInt    *ind, *indz;
14016dbb499eSCian Wilson   PetscInt          *indc, *indcz;
14026dbb499eSCian Wilson   PetscBool         flg;
14036dbb499eSCian Wilson 
14046dbb499eSCian Wilson   PetscFunctionBegin;
14056dbb499eSCian Wilson   ierr = ISGetLocalSize(isy,&localsize);CHKERRQ(ierr);
14066dbb499eSCian Wilson   ierr = MPI_Scan(&localsize,&size,1,MPIU_INT,MPI_SUM,PetscObjectComm((PetscObject)isy));CHKERRQ(ierr);
14076dbb499eSCian Wilson   size -= localsize;
14086dbb499eSCian Wilson   while(ilink) {
14096dbb499eSCian Wilson     IS isrl,isr;
14101c7cfba8SBarry Smith     PC subpc;
14116dbb499eSCian Wilson     ierr          = ISEmbed(ilink->is, isy, PETSC_TRUE, &isrl);CHKERRQ(ierr);
14126dbb499eSCian Wilson     ierr          = ISGetLocalSize(isrl,&localsize);CHKERRQ(ierr);
14136dbb499eSCian Wilson     ierr          = PetscMalloc1(localsize,&indc);CHKERRQ(ierr);
14146dbb499eSCian Wilson     ierr          = ISGetIndices(isrl,&ind);CHKERRQ(ierr);
14156dbb499eSCian Wilson     ierr          = PetscMemcpy(indc,ind,localsize*sizeof(PetscInt));CHKERRQ(ierr);
14166dbb499eSCian Wilson     ierr          = ISRestoreIndices(isrl,&ind);CHKERRQ(ierr);
14176dbb499eSCian Wilson     ierr          = ISDestroy(&isrl);CHKERRQ(ierr);
14186dbb499eSCian Wilson     for (i=0; i<localsize; i++) *(indc+i) += size;
14196dbb499eSCian Wilson     ierr          = ISCreateGeneral(PetscObjectComm((PetscObject)isy),localsize,indc,PETSC_OWN_POINTER,&isr);CHKERRQ(ierr);
14206dbb499eSCian Wilson     ierr          = PetscObjectReference((PetscObject)isr);CHKERRQ(ierr);
14216dbb499eSCian Wilson     ierr          = ISDestroy(&ilink->is);CHKERRQ(ierr);
14226dbb499eSCian Wilson     ilink->is     = isr;
14236dbb499eSCian Wilson     ierr          = PetscObjectReference((PetscObject)isr);CHKERRQ(ierr);
14246dbb499eSCian Wilson     ierr          = ISDestroy(&ilink->is_col);CHKERRQ(ierr);
14256dbb499eSCian Wilson     ilink->is_col = isr;
14266dbb499eSCian Wilson     ierr          = ISDestroy(&isr);CHKERRQ(ierr);
14276dbb499eSCian Wilson     ierr          = KSPGetPC(ilink->ksp, &subpc);CHKERRQ(ierr);
14286dbb499eSCian Wilson     ierr          = PetscObjectTypeCompare((PetscObject)subpc,PCFIELDSPLIT,&flg);CHKERRQ(ierr);
14296dbb499eSCian Wilson     if(flg) {
14306dbb499eSCian Wilson       IS iszl,isz;
14316dbb499eSCian Wilson       MPI_Comm comm;
14326dbb499eSCian Wilson       ierr   = ISGetLocalSize(ilink->is,&localsize);CHKERRQ(ierr);
14336dbb499eSCian Wilson       comm   = PetscObjectComm((PetscObject)ilink->is);
14346dbb499eSCian Wilson       ierr   = ISEmbed(isy, ilink->is, PETSC_TRUE, &iszl);CHKERRQ(ierr);
14356dbb499eSCian Wilson       ierr   = MPI_Scan(&localsize,&sizez,1,MPIU_INT,MPI_SUM,comm);CHKERRQ(ierr);
14366dbb499eSCian Wilson       sizez -= localsize;
14376dbb499eSCian Wilson       ierr   = ISGetLocalSize(iszl,&localsize);CHKERRQ(ierr);
14386dbb499eSCian Wilson       ierr   = PetscMalloc1(localsize,&indcz);CHKERRQ(ierr);
14396dbb499eSCian Wilson       ierr   = ISGetIndices(iszl,&indz);CHKERRQ(ierr);
14406dbb499eSCian Wilson       ierr   = PetscMemcpy(indcz,indz,localsize*sizeof(PetscInt));CHKERRQ(ierr);
14416dbb499eSCian Wilson       ierr   = ISRestoreIndices(iszl,&indz);CHKERRQ(ierr);
14426dbb499eSCian Wilson       ierr   = ISDestroy(&iszl);CHKERRQ(ierr);
14436dbb499eSCian Wilson       for (i=0; i<localsize; i++) *(indcz+i) += sizez;
14446dbb499eSCian Wilson       ierr   = ISCreateGeneral(comm,localsize,indcz,PETSC_OWN_POINTER,&isz);CHKERRQ(ierr);
14456dbb499eSCian Wilson       ierr   = PCFieldSplitRestrictIS(subpc,isz);CHKERRQ(ierr);
14466dbb499eSCian Wilson       ierr   = ISDestroy(&isz);CHKERRQ(ierr);
14476dbb499eSCian Wilson     }
14486dbb499eSCian Wilson     next = ilink->next;
14496dbb499eSCian Wilson     ilink = next;
14506dbb499eSCian Wilson   }
14516dbb499eSCian Wilson   jac->isrestrict = PETSC_TRUE;
14526dbb499eSCian Wilson   PetscFunctionReturn(0);
14536dbb499eSCian Wilson }
14546dbb499eSCian Wilson 
14551e6b0712SBarry Smith static PetscErrorCode  PCFieldSplitSetIS_FieldSplit(PC pc,const char splitname[],IS is)
1456704ba839SBarry Smith {
1457704ba839SBarry Smith   PC_FieldSplit     *jac = (PC_FieldSplit*)pc->data;
1458704ba839SBarry Smith   PetscErrorCode    ierr;
1459704ba839SBarry Smith   PC_FieldSplitLink ilink, next = jac->head;
1460704ba839SBarry Smith   char              prefix[128];
1461704ba839SBarry Smith 
1462704ba839SBarry Smith   PetscFunctionBegin;
14636c924f48SJed Brown   if (jac->splitdefined) {
14646c924f48SJed Brown     ierr = PetscInfo1(pc,"Ignoring new split \"%s\" because the splits have already been defined\n",splitname);CHKERRQ(ierr);
14656c924f48SJed Brown     PetscFunctionReturn(0);
14666c924f48SJed Brown   }
1467b00a9115SJed Brown   ierr = PetscNew(&ilink);CHKERRQ(ierr);
1468a04f6461SBarry Smith   if (splitname) {
1469db4c96c1SJed Brown     ierr = PetscStrallocpy(splitname,&ilink->splitname);CHKERRQ(ierr);
1470a04f6461SBarry Smith   } else {
1471785e854fSJed Brown     ierr = PetscMalloc1(8,&ilink->splitname);CHKERRQ(ierr);
1472b5787286SJed Brown     ierr = PetscSNPrintf(ilink->splitname,7,"%D",jac->nsplits);CHKERRQ(ierr);
1473a04f6461SBarry Smith   }
14749df09d43SBarry Smith   ilink->event = jac->nsplits < 5 ? KSP_Solve_FS_0 + jac->nsplits : KSP_Solve_FS_0 + 4; /* Any split great than 4 gets logged in the 4th split */
14751ab39975SBarry Smith   ierr          = PetscObjectReference((PetscObject)is);CHKERRQ(ierr);
1476b5787286SJed Brown   ierr          = ISDestroy(&ilink->is);CHKERRQ(ierr);
1477b5787286SJed Brown   ilink->is     = is;
1478b5787286SJed Brown   ierr          = PetscObjectReference((PetscObject)is);CHKERRQ(ierr);
1479b5787286SJed Brown   ierr          = ISDestroy(&ilink->is_col);CHKERRQ(ierr);
1480b5787286SJed Brown   ilink->is_col = is;
14810298fd71SBarry Smith   ilink->next   = NULL;
1482ce94432eSBarry Smith   ierr          = KSPCreate(PetscObjectComm((PetscObject)pc),&ilink->ksp);CHKERRQ(ierr);
1483422a814eSBarry Smith   ierr          = KSPSetErrorIfNotConverged(ilink->ksp,pc->erroriffailure);CHKERRQ(ierr);
148420252d06SBarry Smith   ierr          = PetscObjectIncrementTabLevel((PetscObject)ilink->ksp,(PetscObject)pc,1);CHKERRQ(ierr);
1485704ba839SBarry Smith   ierr          = KSPSetType(ilink->ksp,KSPPREONLY);CHKERRQ(ierr);
14869005cf84SBarry Smith   ierr          = PetscLogObjectParent((PetscObject)pc,(PetscObject)ilink->ksp);CHKERRQ(ierr);
1487704ba839SBarry Smith 
14888caf3d72SBarry Smith   ierr = PetscSNPrintf(prefix,sizeof(prefix),"%sfieldsplit_%s_",((PetscObject)pc)->prefix ? ((PetscObject)pc)->prefix : "",ilink->splitname);CHKERRQ(ierr);
1489704ba839SBarry Smith   ierr = KSPSetOptionsPrefix(ilink->ksp,prefix);CHKERRQ(ierr);
1490704ba839SBarry Smith 
1491704ba839SBarry Smith   if (!next) {
1492704ba839SBarry Smith     jac->head       = ilink;
14930298fd71SBarry Smith     ilink->previous = NULL;
1494704ba839SBarry Smith   } else {
1495704ba839SBarry Smith     while (next->next) {
1496704ba839SBarry Smith       next = next->next;
1497704ba839SBarry Smith     }
1498704ba839SBarry Smith     next->next      = ilink;
1499704ba839SBarry Smith     ilink->previous = next;
1500704ba839SBarry Smith   }
1501704ba839SBarry Smith   jac->nsplits++;
1502704ba839SBarry Smith   PetscFunctionReturn(0);
1503704ba839SBarry Smith }
1504704ba839SBarry Smith 
150594ef8ddeSSatish Balay /*@C
15060971522cSBarry Smith     PCFieldSplitSetFields - Sets the fields for one particular split in the field split preconditioner
15070971522cSBarry Smith 
1508ad4df100SBarry Smith     Logically Collective on PC
15090971522cSBarry Smith 
15100971522cSBarry Smith     Input Parameters:
15110971522cSBarry Smith +   pc  - the preconditioner context
15120298fd71SBarry Smith .   splitname - name of this split, if NULL the number of the split is used
15130971522cSBarry Smith .   n - the number of fields in this split
1514db4c96c1SJed Brown -   fields - the fields in this split
15150971522cSBarry Smith 
15160971522cSBarry Smith     Level: intermediate
15170971522cSBarry Smith 
1518d32f9abdSBarry Smith     Notes: Use PCFieldSplitSetIS() to set a completely general set of indices as a field.
1519d32f9abdSBarry Smith 
15207287d2a3SDmitry Karpeev      The PCFieldSplitSetFields() is for defining fields as strided blocks. For example, if the block
1521d32f9abdSBarry 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
1522d32f9abdSBarry Smith      0xx3xx6xx9xx12 ... x1xx4xx7xx ... xx2xx5xx8xx.. 01x34x67x... 0x1x3x5x7.. x12x45x78x....
1523d32f9abdSBarry Smith      where the numbered entries indicate what is in the field.
1524d32f9abdSBarry Smith 
1525db4c96c1SJed Brown      This function is called once per split (it creates a new split each time).  Solve options
1526db4c96c1SJed Brown      for this split will be available under the prefix -fieldsplit_SPLITNAME_.
1527db4c96c1SJed Brown 
15285d4c12cdSJungho Lee      Developer Note: This routine does not actually create the IS representing the split, that is delayed
15295d4c12cdSJungho Lee      until PCSetUp_FieldSplit(), because information about the vector/matrix layouts may not be
15305d4c12cdSJungho Lee      available when this routine is called.
15315d4c12cdSJungho Lee 
1532d32f9abdSBarry Smith .seealso: PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitSetBlockSize(), PCFieldSplitSetIS()
15330971522cSBarry Smith 
15340971522cSBarry Smith @*/
15355d4c12cdSJungho Lee PetscErrorCode  PCFieldSplitSetFields(PC pc,const char splitname[],PetscInt n,const PetscInt *fields,const PetscInt *fields_col)
15360971522cSBarry Smith {
15374ac538c5SBarry Smith   PetscErrorCode ierr;
15380971522cSBarry Smith 
15390971522cSBarry Smith   PetscFunctionBegin;
15400700a824SBarry Smith   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
1541db4c96c1SJed Brown   PetscValidCharPointer(splitname,2);
1542ce94432eSBarry Smith   if (n < 1) SETERRQ2(PetscObjectComm((PetscObject)pc),PETSC_ERR_ARG_OUTOFRANGE,"Provided number of fields %D in split \"%s\" not positive",n,splitname);
1543db4c96c1SJed Brown   PetscValidIntPointer(fields,3);
15440246f55cSBarry Smith   ierr = PetscTryMethod(pc,"PCFieldSplitSetFields_C",(PC,const char[],PetscInt,const PetscInt*,const PetscInt*),(pc,splitname,n,fields,fields_col));CHKERRQ(ierr);
15450971522cSBarry Smith   PetscFunctionReturn(0);
15460971522cSBarry Smith }
15470971522cSBarry Smith 
1548c84da90fSDmitry Karpeev /*@
1549c84da90fSDmitry Karpeev     PCFieldSplitSetDiagUseAmat - set flag indicating whether to extract diagonal blocks from Amat (rather than Pmat)
1550c84da90fSDmitry Karpeev 
1551c84da90fSDmitry Karpeev     Logically Collective on PC
1552c84da90fSDmitry Karpeev 
1553c84da90fSDmitry Karpeev     Input Parameters:
1554c84da90fSDmitry Karpeev +   pc  - the preconditioner object
1555c84da90fSDmitry Karpeev -   flg - boolean flag indicating whether or not to use Amat to extract the diagonal blocks from
1556c84da90fSDmitry Karpeev 
15579506b623SDmitry Karpeev     Options Database:
15589506b623SDmitry Karpeev .     -pc_fieldsplit_diag_use_amat
1559c84da90fSDmitry Karpeev 
1560c84da90fSDmitry Karpeev     Level: intermediate
1561c84da90fSDmitry Karpeev 
1562c84da90fSDmitry Karpeev .seealso: PCFieldSplitGetDiagUseAmat(), PCFieldSplitSetOffDiagUseAmat(), PCFIELDSPLIT
1563c84da90fSDmitry Karpeev 
1564c84da90fSDmitry Karpeev @*/
1565c84da90fSDmitry Karpeev PetscErrorCode  PCFieldSplitSetDiagUseAmat(PC pc,PetscBool flg)
1566c84da90fSDmitry Karpeev {
1567c84da90fSDmitry Karpeev   PC_FieldSplit  *jac = (PC_FieldSplit*)pc->data;
1568c84da90fSDmitry Karpeev   PetscBool      isfs;
1569c84da90fSDmitry Karpeev   PetscErrorCode ierr;
1570c84da90fSDmitry Karpeev 
1571c84da90fSDmitry Karpeev   PetscFunctionBegin;
1572c84da90fSDmitry Karpeev   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
1573c84da90fSDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)pc,PCFIELDSPLIT,&isfs);CHKERRQ(ierr);
1574c84da90fSDmitry Karpeev   if (!isfs) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"PC not of type %s",PCFIELDSPLIT);
1575c84da90fSDmitry Karpeev   jac->diag_use_amat = flg;
1576c84da90fSDmitry Karpeev   PetscFunctionReturn(0);
1577c84da90fSDmitry Karpeev }
1578c84da90fSDmitry Karpeev 
1579c84da90fSDmitry Karpeev /*@
1580c84da90fSDmitry Karpeev     PCFieldSplitGetDiagUseAmat - get the flag indicating whether to extract diagonal blocks from Amat (rather than Pmat)
1581c84da90fSDmitry Karpeev 
1582c84da90fSDmitry Karpeev     Logically Collective on PC
1583c84da90fSDmitry Karpeev 
1584c84da90fSDmitry Karpeev     Input Parameters:
1585c84da90fSDmitry Karpeev .   pc  - the preconditioner object
1586c84da90fSDmitry Karpeev 
1587c84da90fSDmitry Karpeev     Output Parameters:
1588c84da90fSDmitry Karpeev .   flg - boolean flag indicating whether or not to use Amat to extract the diagonal blocks from
1589c84da90fSDmitry Karpeev 
1590c84da90fSDmitry Karpeev 
1591c84da90fSDmitry Karpeev     Level: intermediate
1592c84da90fSDmitry Karpeev 
1593c84da90fSDmitry Karpeev .seealso: PCFieldSplitSetDiagUseAmat(), PCFieldSplitGetOffDiagUseAmat(), PCFIELDSPLIT
1594c84da90fSDmitry Karpeev 
1595c84da90fSDmitry Karpeev @*/
1596c84da90fSDmitry Karpeev PetscErrorCode  PCFieldSplitGetDiagUseAmat(PC pc,PetscBool *flg)
1597c84da90fSDmitry Karpeev {
1598c84da90fSDmitry Karpeev   PC_FieldSplit  *jac = (PC_FieldSplit*)pc->data;
1599c84da90fSDmitry Karpeev   PetscBool      isfs;
1600c84da90fSDmitry Karpeev   PetscErrorCode ierr;
1601c84da90fSDmitry Karpeev 
1602c84da90fSDmitry Karpeev   PetscFunctionBegin;
1603c84da90fSDmitry Karpeev   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
1604c84da90fSDmitry Karpeev   PetscValidPointer(flg,2);
1605c84da90fSDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)pc,PCFIELDSPLIT,&isfs);CHKERRQ(ierr);
1606c84da90fSDmitry Karpeev   if (!isfs) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"PC not of type %s",PCFIELDSPLIT);
1607c84da90fSDmitry Karpeev   *flg = jac->diag_use_amat;
1608c84da90fSDmitry Karpeev   PetscFunctionReturn(0);
1609c84da90fSDmitry Karpeev }
1610c84da90fSDmitry Karpeev 
1611c84da90fSDmitry Karpeev /*@
1612c84da90fSDmitry Karpeev     PCFieldSplitSetOffDiagUseAmat - set flag indicating whether to extract off-diagonal blocks from Amat (rather than Pmat)
1613c84da90fSDmitry Karpeev 
1614c84da90fSDmitry Karpeev     Logically Collective on PC
1615c84da90fSDmitry Karpeev 
1616c84da90fSDmitry Karpeev     Input Parameters:
1617c84da90fSDmitry Karpeev +   pc  - the preconditioner object
1618c84da90fSDmitry Karpeev -   flg - boolean flag indicating whether or not to use Amat to extract the off-diagonal blocks from
1619c84da90fSDmitry Karpeev 
16209506b623SDmitry Karpeev     Options Database:
16219506b623SDmitry Karpeev .     -pc_fieldsplit_off_diag_use_amat
1622c84da90fSDmitry Karpeev 
1623c84da90fSDmitry Karpeev     Level: intermediate
1624c84da90fSDmitry Karpeev 
1625c84da90fSDmitry Karpeev .seealso: PCFieldSplitGetOffDiagUseAmat(), PCFieldSplitSetDiagUseAmat(), PCFIELDSPLIT
1626c84da90fSDmitry Karpeev 
1627c84da90fSDmitry Karpeev @*/
1628c84da90fSDmitry Karpeev PetscErrorCode  PCFieldSplitSetOffDiagUseAmat(PC pc,PetscBool flg)
1629c84da90fSDmitry Karpeev {
1630c84da90fSDmitry Karpeev   PC_FieldSplit *jac = (PC_FieldSplit*)pc->data;
1631c84da90fSDmitry Karpeev   PetscBool      isfs;
1632c84da90fSDmitry Karpeev   PetscErrorCode ierr;
1633c84da90fSDmitry Karpeev 
1634c84da90fSDmitry Karpeev   PetscFunctionBegin;
1635c84da90fSDmitry Karpeev   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
1636c84da90fSDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)pc,PCFIELDSPLIT,&isfs);CHKERRQ(ierr);
1637c84da90fSDmitry Karpeev   if (!isfs) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"PC not of type %s",PCFIELDSPLIT);
1638c84da90fSDmitry Karpeev   jac->offdiag_use_amat = flg;
1639c84da90fSDmitry Karpeev   PetscFunctionReturn(0);
1640c84da90fSDmitry Karpeev }
1641c84da90fSDmitry Karpeev 
1642c84da90fSDmitry Karpeev /*@
1643c84da90fSDmitry Karpeev     PCFieldSplitGetOffDiagUseAmat - get the flag indicating whether to extract off-diagonal blocks from Amat (rather than Pmat)
1644c84da90fSDmitry Karpeev 
1645c84da90fSDmitry Karpeev     Logically Collective on PC
1646c84da90fSDmitry Karpeev 
1647c84da90fSDmitry Karpeev     Input Parameters:
1648c84da90fSDmitry Karpeev .   pc  - the preconditioner object
1649c84da90fSDmitry Karpeev 
1650c84da90fSDmitry Karpeev     Output Parameters:
1651c84da90fSDmitry Karpeev .   flg - boolean flag indicating whether or not to use Amat to extract the off-diagonal blocks from
1652c84da90fSDmitry Karpeev 
1653c84da90fSDmitry Karpeev 
1654c84da90fSDmitry Karpeev     Level: intermediate
1655c84da90fSDmitry Karpeev 
1656c84da90fSDmitry Karpeev .seealso: PCFieldSplitSetOffDiagUseAmat(), PCFieldSplitGetDiagUseAmat(), PCFIELDSPLIT
1657c84da90fSDmitry Karpeev 
1658c84da90fSDmitry Karpeev @*/
1659c84da90fSDmitry Karpeev PetscErrorCode  PCFieldSplitGetOffDiagUseAmat(PC pc,PetscBool *flg)
1660c84da90fSDmitry Karpeev {
1661c84da90fSDmitry Karpeev   PC_FieldSplit  *jac = (PC_FieldSplit*)pc->data;
1662c84da90fSDmitry Karpeev   PetscBool      isfs;
1663c84da90fSDmitry Karpeev   PetscErrorCode ierr;
1664c84da90fSDmitry Karpeev 
1665c84da90fSDmitry Karpeev   PetscFunctionBegin;
1666c84da90fSDmitry Karpeev   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
1667c84da90fSDmitry Karpeev   PetscValidPointer(flg,2);
1668c84da90fSDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)pc,PCFIELDSPLIT,&isfs);CHKERRQ(ierr);
1669c84da90fSDmitry Karpeev   if (!isfs) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"PC not of type %s",PCFIELDSPLIT);
1670c84da90fSDmitry Karpeev   *flg = jac->offdiag_use_amat;
1671c84da90fSDmitry Karpeev   PetscFunctionReturn(0);
1672c84da90fSDmitry Karpeev }
1673c84da90fSDmitry Karpeev 
1674c84da90fSDmitry Karpeev 
1675c84da90fSDmitry Karpeev 
1676218d4943SBarry Smith /*@C
1677704ba839SBarry Smith     PCFieldSplitSetIS - Sets the exact elements for field
1678704ba839SBarry Smith 
1679ad4df100SBarry Smith     Logically Collective on PC
1680704ba839SBarry Smith 
1681704ba839SBarry Smith     Input Parameters:
1682704ba839SBarry Smith +   pc  - the preconditioner context
16830298fd71SBarry Smith .   splitname - name of this split, if NULL the number of the split is used
1684db4c96c1SJed Brown -   is - the index set that defines the vector elements in this field
1685704ba839SBarry Smith 
1686d32f9abdSBarry Smith 
1687a6ffb8dbSJed Brown     Notes:
1688a6ffb8dbSJed Brown     Use PCFieldSplitSetFields(), for fields defined by strided types.
1689a6ffb8dbSJed Brown 
1690db4c96c1SJed Brown     This function is called once per split (it creates a new split each time).  Solve options
1691db4c96c1SJed Brown     for this split will be available under the prefix -fieldsplit_SPLITNAME_.
1692d32f9abdSBarry Smith 
1693704ba839SBarry Smith     Level: intermediate
1694704ba839SBarry Smith 
1695704ba839SBarry Smith .seealso: PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitSetBlockSize()
1696704ba839SBarry Smith 
1697704ba839SBarry Smith @*/
16987087cfbeSBarry Smith PetscErrorCode  PCFieldSplitSetIS(PC pc,const char splitname[],IS is)
1699704ba839SBarry Smith {
17004ac538c5SBarry Smith   PetscErrorCode ierr;
1701704ba839SBarry Smith 
1702704ba839SBarry Smith   PetscFunctionBegin;
17030700a824SBarry Smith   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
17047b62db95SJungho Lee   if (splitname) PetscValidCharPointer(splitname,2);
1705db4c96c1SJed Brown   PetscValidHeaderSpecific(is,IS_CLASSID,3);
1706ccc738f7SBarry Smith   ierr = PetscTryMethod(pc,"PCFieldSplitSetIS_C",(PC,const char[],IS),(pc,splitname,is));CHKERRQ(ierr);
1707704ba839SBarry Smith   PetscFunctionReturn(0);
1708704ba839SBarry Smith }
1709704ba839SBarry Smith 
171094ef8ddeSSatish Balay /*@C
171157a9adfeSMatthew G Knepley     PCFieldSplitGetIS - Retrieves the elements for a field as an IS
171257a9adfeSMatthew G Knepley 
171357a9adfeSMatthew G Knepley     Logically Collective on PC
171457a9adfeSMatthew G Knepley 
171557a9adfeSMatthew G Knepley     Input Parameters:
171657a9adfeSMatthew G Knepley +   pc  - the preconditioner context
171757a9adfeSMatthew G Knepley -   splitname - name of this split
171857a9adfeSMatthew G Knepley 
171957a9adfeSMatthew G Knepley     Output Parameter:
17200298fd71SBarry Smith -   is - the index set that defines the vector elements in this field, or NULL if the field is not found
172157a9adfeSMatthew G Knepley 
172257a9adfeSMatthew G Knepley     Level: intermediate
172357a9adfeSMatthew G Knepley 
172457a9adfeSMatthew G Knepley .seealso: PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitSetIS()
172557a9adfeSMatthew G Knepley 
172657a9adfeSMatthew G Knepley @*/
172757a9adfeSMatthew G Knepley PetscErrorCode PCFieldSplitGetIS(PC pc,const char splitname[],IS *is)
172857a9adfeSMatthew G Knepley {
172957a9adfeSMatthew G Knepley   PetscErrorCode ierr;
173057a9adfeSMatthew G Knepley 
173157a9adfeSMatthew G Knepley   PetscFunctionBegin;
173257a9adfeSMatthew G Knepley   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
173357a9adfeSMatthew G Knepley   PetscValidCharPointer(splitname,2);
173457a9adfeSMatthew G Knepley   PetscValidPointer(is,3);
173557a9adfeSMatthew G Knepley   {
173657a9adfeSMatthew G Knepley     PC_FieldSplit     *jac  = (PC_FieldSplit*) pc->data;
173757a9adfeSMatthew G Knepley     PC_FieldSplitLink ilink = jac->head;
173857a9adfeSMatthew G Knepley     PetscBool         found;
173957a9adfeSMatthew G Knepley 
17400298fd71SBarry Smith     *is = NULL;
174157a9adfeSMatthew G Knepley     while (ilink) {
174257a9adfeSMatthew G Knepley       ierr = PetscStrcmp(ilink->splitname, splitname, &found);CHKERRQ(ierr);
174357a9adfeSMatthew G Knepley       if (found) {
174457a9adfeSMatthew G Knepley         *is = ilink->is;
174557a9adfeSMatthew G Knepley         break;
174657a9adfeSMatthew G Knepley       }
174757a9adfeSMatthew G Knepley       ilink = ilink->next;
174857a9adfeSMatthew G Knepley     }
174957a9adfeSMatthew G Knepley   }
175057a9adfeSMatthew G Knepley   PetscFunctionReturn(0);
175157a9adfeSMatthew G Knepley }
175257a9adfeSMatthew G Knepley 
175351f519a2SBarry Smith /*@
175451f519a2SBarry Smith     PCFieldSplitSetBlockSize - Sets the block size for defining where fields start in the
175551f519a2SBarry Smith       fieldsplit preconditioner. If not set the matrix block size is used.
175651f519a2SBarry Smith 
1757ad4df100SBarry Smith     Logically Collective on PC
175851f519a2SBarry Smith 
175951f519a2SBarry Smith     Input Parameters:
176051f519a2SBarry Smith +   pc  - the preconditioner context
176151f519a2SBarry Smith -   bs - the block size
176251f519a2SBarry Smith 
176351f519a2SBarry Smith     Level: intermediate
176451f519a2SBarry Smith 
176551f519a2SBarry Smith .seealso: PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitSetFields()
176651f519a2SBarry Smith 
176751f519a2SBarry Smith @*/
17687087cfbeSBarry Smith PetscErrorCode  PCFieldSplitSetBlockSize(PC pc,PetscInt bs)
176951f519a2SBarry Smith {
17704ac538c5SBarry Smith   PetscErrorCode ierr;
177151f519a2SBarry Smith 
177251f519a2SBarry Smith   PetscFunctionBegin;
17730700a824SBarry Smith   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
1774c5eb9154SBarry Smith   PetscValidLogicalCollectiveInt(pc,bs,2);
17754ac538c5SBarry Smith   ierr = PetscTryMethod(pc,"PCFieldSplitSetBlockSize_C",(PC,PetscInt),(pc,bs));CHKERRQ(ierr);
177651f519a2SBarry Smith   PetscFunctionReturn(0);
177751f519a2SBarry Smith }
177851f519a2SBarry Smith 
17790971522cSBarry Smith /*@C
178069a612a9SBarry Smith    PCFieldSplitGetSubKSP - Gets the KSP contexts for all splits
17810971522cSBarry Smith 
178269a612a9SBarry Smith    Collective on KSP
17830971522cSBarry Smith 
17840971522cSBarry Smith    Input Parameter:
17850971522cSBarry Smith .  pc - the preconditioner context
17860971522cSBarry Smith 
17870971522cSBarry Smith    Output Parameters:
178813e0d083SBarry Smith +  n - the number of splits
17893111de3cSBarry Smith -  subksp - the array of KSP contexts
17900971522cSBarry Smith 
17910971522cSBarry Smith    Note:
17929a4f7e47SBarry Smith    After PCFieldSplitGetSubKSP() the array of KSPs is to be freed by the user with PetscFree()
1793d32f9abdSBarry Smith    (not the KSP just the array that contains them).
17940971522cSBarry Smith 
179569a612a9SBarry Smith    You must call KSPSetUp() before calling PCFieldSplitGetSubKSP().
17960971522cSBarry Smith 
1797196cc216SBarry Smith    Fortran Usage: You must pass in a KSP array that is large enough to contain all the local KSPs.
17982bf68e3eSBarry Smith       You can call PCFieldSplitGetSubKSP(pc,n,PETSC_NULL_KSP,ierr) to determine how large the
1799196cc216SBarry Smith       KSP array must be.
1800196cc216SBarry Smith 
1801196cc216SBarry Smith 
18020971522cSBarry Smith    Level: advanced
18030971522cSBarry Smith 
18040971522cSBarry Smith .seealso: PCFIELDSPLIT
18050971522cSBarry Smith @*/
18067087cfbeSBarry Smith PetscErrorCode  PCFieldSplitGetSubKSP(PC pc,PetscInt *n,KSP *subksp[])
18070971522cSBarry Smith {
18084ac538c5SBarry Smith   PetscErrorCode ierr;
18090971522cSBarry Smith 
18100971522cSBarry Smith   PetscFunctionBegin;
18110700a824SBarry Smith   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
181213e0d083SBarry Smith   if (n) PetscValidIntPointer(n,2);
18134ac538c5SBarry Smith   ierr = PetscUseMethod(pc,"PCFieldSplitGetSubKSP_C",(PC,PetscInt*,KSP **),(pc,n,subksp));CHKERRQ(ierr);
18140971522cSBarry Smith   PetscFunctionReturn(0);
18150971522cSBarry Smith }
18160971522cSBarry Smith 
1817e69d4d44SBarry Smith /*@
181853f2277eSBarry Smith     PCFieldSplitSetSchurPre -  Indicates what operator is used to construct the preconditioner for the Schur complement.
1819a04f6461SBarry Smith       A11 matrix. Otherwise no preconditioner is used.
1820e69d4d44SBarry Smith 
1821e69d4d44SBarry Smith     Collective on PC
1822e69d4d44SBarry Smith 
1823e69d4d44SBarry Smith     Input Parameters:
1824e69d4d44SBarry Smith +   pc      - the preconditioner context
18256fdd48a9SBarry Smith .   ptype   - which matrix to use for preconditioning the Schur complement: PC_FIELDSPLIT_SCHUR_PRE_A11 (default), PC_FIELDSPLIT_SCHUR_PRE_SELF, PC_FIELDSPLIT_SCHUR_PRE_USER
18266fdd48a9SBarry Smith               PC_FIELDSPLIT_SCHUR_PRE_SELFP, and PC_FIELDSPLIT_SCHUR_PRE_FULL
18270298fd71SBarry Smith -   userpre - matrix to use for preconditioning, or NULL
1828084e4875SJed Brown 
1829e69d4d44SBarry Smith     Options Database:
18306fdd48a9SBarry Smith .     -pc_fieldsplit_schur_precondition <self,selfp,user,a11,full> - default is a11. See notes for meaning of various arguments
1831e69d4d44SBarry Smith 
1832fd1303e9SJungho Lee     Notes:
1833fd1303e9SJungho Lee $    If ptype is
1834a6a584a2SBarry Smith $        a11 then the preconditioner for the Schur complement is generated from the block diagonal part of the preconditioner
183553f2277eSBarry Smith $             matrix associated with the Schur complement (i.e. A11), not the Schur complement matrix
1836a6a584a2SBarry Smith $        self the preconditioner for the Schur complement is generated from the symbolic representation of the Schur complement matrix:
1837a6a584a2SBarry Smith $             The only preconditioner that currently works with this symbolic respresentation matrix object is the PCLSC
1838fd1303e9SJungho Lee $             preconditioner
18396fdd48a9SBarry Smith $        user then the preconditioner for the Schur complement is generated from the user provided matrix (pre argument
18406fdd48a9SBarry Smith $             to this function).
1841a6a584a2SBarry Smith $        selfp then the preconditioning for the Schur complement is generated from an explicitly-assembled approximation Sp = A11 - A10 inv(diag(A00)) A01
18421d71051fSDmitry Karpeev $             This is only a good preconditioner when diag(A00) is a good preconditioner for A00. Optionally, A00 can be
18436fdd48a9SBarry Smith $             lumped before extracting the diagonal using the additional option -fieldsplit_1_mat_schur_complement_ainv_type lump
18446fdd48a9SBarry Smith $        full then the preconditioner for the Schur complement is generated from the exact Schur complement matrix representation computed internally by PFIELDSPLIT (this is expensive)
18456fdd48a9SBarry Smith $             useful mostly as a test that the Schur complement approach can work for your problem
1846fd1303e9SJungho Lee 
1847e87fab1bSBarry Smith      When solving a saddle point problem, where the A11 block is identically zero, using a11 as the ptype only makes sense
1848fd1303e9SJungho Lee     with the additional option -fieldsplit_1_pc_type none. Usually for saddle point problems one would use a ptype of self and
1849a7476a74SDmitry Karpeev     -fieldsplit_1_pc_type lsc which uses the least squares commutator to compute a preconditioner for the Schur complement.
1850fd1303e9SJungho Lee 
1851e69d4d44SBarry Smith     Level: intermediate
1852e69d4d44SBarry Smith 
18531d71051fSDmitry Karpeev .seealso: PCFieldSplitGetSchurPre(), PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitSetFields(), PCFieldSplitSchurPreType,
18541d71051fSDmitry Karpeev           MatSchurComplementSetAinvType(), PCLSC
1855e69d4d44SBarry Smith 
1856e69d4d44SBarry Smith @*/
185729f8a81cSJed Brown PetscErrorCode PCFieldSplitSetSchurPre(PC pc,PCFieldSplitSchurPreType ptype,Mat pre)
1858e69d4d44SBarry Smith {
18594ac538c5SBarry Smith   PetscErrorCode ierr;
1860e69d4d44SBarry Smith 
1861e69d4d44SBarry Smith   PetscFunctionBegin;
18620700a824SBarry Smith   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
186329f8a81cSJed Brown   ierr = PetscTryMethod(pc,"PCFieldSplitSetSchurPre_C",(PC,PCFieldSplitSchurPreType,Mat),(pc,ptype,pre));CHKERRQ(ierr);
1864e69d4d44SBarry Smith   PetscFunctionReturn(0);
1865e69d4d44SBarry Smith }
186629f8a81cSJed Brown PetscErrorCode PCFieldSplitSchurPrecondition(PC pc,PCFieldSplitSchurPreType ptype,Mat pre) {return PCFieldSplitSetSchurPre(pc,ptype,pre);} /* Deprecated name */
1867e69d4d44SBarry Smith 
186837a82bf0SJed Brown /*@
186937a82bf0SJed Brown     PCFieldSplitGetSchurPre - For Schur complement fieldsplit, determine how the Schur complement will be
187029f8a81cSJed Brown     preconditioned.  See PCFieldSplitSetSchurPre() for details.
187137a82bf0SJed Brown 
187237a82bf0SJed Brown     Logically Collective on PC
187337a82bf0SJed Brown 
187437a82bf0SJed Brown     Input Parameters:
187537a82bf0SJed Brown .   pc      - the preconditioner context
187637a82bf0SJed Brown 
187737a82bf0SJed Brown     Output Parameters:
187837a82bf0SJed 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
187937a82bf0SJed Brown -   userpre - matrix to use for preconditioning (with PC_FIELDSPLIT_PRE_USER), or NULL
188037a82bf0SJed Brown 
188137a82bf0SJed Brown     Level: intermediate
188237a82bf0SJed Brown 
188329f8a81cSJed Brown .seealso: PCFieldSplitSetSchurPre(), PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitSetFields(), PCFieldSplitSchurPreType, PCLSC
188437a82bf0SJed Brown 
188537a82bf0SJed Brown @*/
188637a82bf0SJed Brown PetscErrorCode PCFieldSplitGetSchurPre(PC pc,PCFieldSplitSchurPreType *ptype,Mat *pre)
188737a82bf0SJed Brown {
188837a82bf0SJed Brown   PetscErrorCode ierr;
188937a82bf0SJed Brown 
189037a82bf0SJed Brown   PetscFunctionBegin;
189137a82bf0SJed Brown   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
189237a82bf0SJed Brown   ierr = PetscUseMethod(pc,"PCFieldSplitGetSchurPre_C",(PC,PCFieldSplitSchurPreType*,Mat*),(pc,ptype,pre));CHKERRQ(ierr);
1893e69d4d44SBarry Smith   PetscFunctionReturn(0);
1894e69d4d44SBarry Smith }
1895e69d4d44SBarry Smith 
189645e7fc46SDmitry Karpeev /*@
1897470b340bSDmitry Karpeev     PCFieldSplitSchurGetS -  extract the MatSchurComplement object used by this PC in case it needs to be configured separately
189845e7fc46SDmitry Karpeev 
189945e7fc46SDmitry Karpeev     Not collective
190045e7fc46SDmitry Karpeev 
190145e7fc46SDmitry Karpeev     Input Parameter:
190245e7fc46SDmitry Karpeev .   pc      - the preconditioner context
190345e7fc46SDmitry Karpeev 
190445e7fc46SDmitry Karpeev     Output Parameter:
1905470b340bSDmitry Karpeev .   S       - the Schur complement matrix
190645e7fc46SDmitry Karpeev 
1907470b340bSDmitry Karpeev     Notes:
1908470b340bSDmitry Karpeev     This matrix should not be destroyed using MatDestroy(); rather, use PCFieldSplitSchurRestoreS().
190945e7fc46SDmitry Karpeev 
191045e7fc46SDmitry Karpeev     Level: advanced
191145e7fc46SDmitry Karpeev 
191229f8a81cSJed Brown .seealso: PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitSchurPreType, PCFieldSplitSetSchurPre(), MatSchurComplement, PCFieldSplitSchurRestoreS()
191345e7fc46SDmitry Karpeev 
191445e7fc46SDmitry Karpeev @*/
1915470b340bSDmitry Karpeev PetscErrorCode  PCFieldSplitSchurGetS(PC pc,Mat *S)
191645e7fc46SDmitry Karpeev {
191745e7fc46SDmitry Karpeev   PetscErrorCode ierr;
191845e7fc46SDmitry Karpeev   const char*    t;
191945e7fc46SDmitry Karpeev   PetscBool      isfs;
192045e7fc46SDmitry Karpeev   PC_FieldSplit  *jac;
192145e7fc46SDmitry Karpeev 
192245e7fc46SDmitry Karpeev   PetscFunctionBegin;
192345e7fc46SDmitry Karpeev   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
192445e7fc46SDmitry Karpeev   ierr = PetscObjectGetType((PetscObject)pc,&t);CHKERRQ(ierr);
192545e7fc46SDmitry Karpeev   ierr = PetscStrcmp(t,PCFIELDSPLIT,&isfs);CHKERRQ(ierr);
192645e7fc46SDmitry Karpeev   if (!isfs) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Expected PC of type PCFIELDSPLIT, got %s instead",t);
192745e7fc46SDmitry Karpeev   jac = (PC_FieldSplit*)pc->data;
1928470b340bSDmitry 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);
1929470b340bSDmitry Karpeev   if (S) *S = jac->schur;
193045e7fc46SDmitry Karpeev   PetscFunctionReturn(0);
193145e7fc46SDmitry Karpeev }
193245e7fc46SDmitry Karpeev 
1933470b340bSDmitry Karpeev /*@
1934470b340bSDmitry Karpeev     PCFieldSplitSchurRestoreS -  restores the MatSchurComplement object used by this PC
1935470b340bSDmitry Karpeev 
1936470b340bSDmitry Karpeev     Not collective
1937470b340bSDmitry Karpeev 
1938470b340bSDmitry Karpeev     Input Parameters:
1939470b340bSDmitry Karpeev +   pc      - the preconditioner context
1940470b340bSDmitry Karpeev .   S       - the Schur complement matrix
1941470b340bSDmitry Karpeev 
1942470b340bSDmitry Karpeev     Level: advanced
1943470b340bSDmitry Karpeev 
194429f8a81cSJed Brown .seealso: PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitSchurPreType, PCFieldSplitSetSchurPre(), MatSchurComplement, PCFieldSplitSchurGetS()
1945470b340bSDmitry Karpeev 
1946470b340bSDmitry Karpeev @*/
1947bca69d2bSDmitry Karpeev PetscErrorCode  PCFieldSplitSchurRestoreS(PC pc,Mat *S)
1948470b340bSDmitry Karpeev {
1949470b340bSDmitry Karpeev   PetscErrorCode ierr;
1950470b340bSDmitry Karpeev   const char*    t;
1951470b340bSDmitry Karpeev   PetscBool      isfs;
1952470b340bSDmitry Karpeev   PC_FieldSplit  *jac;
1953470b340bSDmitry Karpeev 
1954470b340bSDmitry Karpeev   PetscFunctionBegin;
1955470b340bSDmitry Karpeev   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
1956470b340bSDmitry Karpeev   ierr = PetscObjectGetType((PetscObject)pc,&t);CHKERRQ(ierr);
1957470b340bSDmitry Karpeev   ierr = PetscStrcmp(t,PCFIELDSPLIT,&isfs);CHKERRQ(ierr);
1958470b340bSDmitry Karpeev   if (!isfs) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Expected PC of type PCFIELDSPLIT, got %s instead",t);
1959470b340bSDmitry Karpeev   jac = (PC_FieldSplit*)pc->data;
1960470b340bSDmitry 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);
1961bca69d2bSDmitry Karpeev   if (!S || *S != jac->schur) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"MatSchurComplement restored is not the same as gotten");
1962470b340bSDmitry Karpeev   PetscFunctionReturn(0);
1963470b340bSDmitry Karpeev }
1964470b340bSDmitry Karpeev 
1965470b340bSDmitry Karpeev 
196629f8a81cSJed Brown static PetscErrorCode  PCFieldSplitSetSchurPre_FieldSplit(PC pc,PCFieldSplitSchurPreType ptype,Mat pre)
1967e69d4d44SBarry Smith {
1968e69d4d44SBarry Smith   PC_FieldSplit  *jac = (PC_FieldSplit*)pc->data;
1969084e4875SJed Brown   PetscErrorCode ierr;
1970e69d4d44SBarry Smith 
1971e69d4d44SBarry Smith   PetscFunctionBegin;
1972084e4875SJed Brown   jac->schurpre = ptype;
1973a7476a74SDmitry Karpeev   if (ptype == PC_FIELDSPLIT_SCHUR_PRE_USER && pre) {
19746bf464f9SBarry Smith     ierr            = MatDestroy(&jac->schur_user);CHKERRQ(ierr);
1975084e4875SJed Brown     jac->schur_user = pre;
1976084e4875SJed Brown     ierr            = PetscObjectReference((PetscObject)jac->schur_user);CHKERRQ(ierr);
1977084e4875SJed Brown   }
1978e69d4d44SBarry Smith   PetscFunctionReturn(0);
1979e69d4d44SBarry Smith }
1980e69d4d44SBarry Smith 
198137a82bf0SJed Brown static PetscErrorCode  PCFieldSplitGetSchurPre_FieldSplit(PC pc,PCFieldSplitSchurPreType *ptype,Mat *pre)
198237a82bf0SJed Brown {
198337a82bf0SJed Brown   PC_FieldSplit  *jac = (PC_FieldSplit*)pc->data;
198437a82bf0SJed Brown 
198537a82bf0SJed Brown   PetscFunctionBegin;
198637a82bf0SJed Brown   *ptype = jac->schurpre;
198737a82bf0SJed Brown   *pre   = jac->schur_user;
198837a82bf0SJed Brown   PetscFunctionReturn(0);
198937a82bf0SJed Brown }
199037a82bf0SJed Brown 
1991ab1df9f5SJed Brown /*@
19920ffb0e17SBarry Smith     PCFieldSplitSetSchurFactType -  sets which blocks of the approximate block factorization to retain in the preconditioner
1993ab1df9f5SJed Brown 
1994ab1df9f5SJed Brown     Collective on PC
1995ab1df9f5SJed Brown 
1996ab1df9f5SJed Brown     Input Parameters:
1997ab1df9f5SJed Brown +   pc  - the preconditioner context
1998c9c6ffaaSJed Brown -   ftype - which blocks of factorization to retain, PC_FIELDSPLIT_SCHUR_FACT_FULL is default
1999ab1df9f5SJed Brown 
2000ab1df9f5SJed Brown     Options Database:
2001c9c6ffaaSJed Brown .     -pc_fieldsplit_schur_fact_type <diag,lower,upper,full> default is full
2002ab1df9f5SJed Brown 
2003ab1df9f5SJed Brown 
2004ab1df9f5SJed Brown     Level: intermediate
2005ab1df9f5SJed Brown 
2006ab1df9f5SJed Brown     Notes:
2007ab1df9f5SJed Brown     The FULL factorization is
2008ab1df9f5SJed Brown 
20090ffb0e17SBarry Smith $   (A   B)  = (1       0) (A   0) (1  Ainv*B)  = L D U
20100ffb0e17SBarry Smith $   (C   E)    (C*Ainv  1) (0   S) (0     1  )
2011ab1df9f5SJed Brown 
20120ffb0e17SBarry Smith     where S = E - C*Ainv*B. In practice, the full factorization is applied via block triangular solves with the grouping L*(D*U). UPPER uses D*U, LOWER uses L*D,
2013c096484dSStefano Zampini     and DIAG is the diagonal part with the sign of S flipped (because this makes the preconditioner positive definite for many formulations, thus allowing the use of KSPMINRES). Sign flipping of S can be turned off with PCFieldSplitSetSchurScale().
2014ab1df9f5SJed Brown 
20150ffb0e17SBarry Smith $    If A and S are solved exactly
20160ffb0e17SBarry Smith $      *) FULL factorization is a direct solver.
20170ffb0e17SBarry Smith $      *) The preconditioned operator with LOWER or UPPER has all eigenvalues equal to 1 and minimal polynomial of degree 2, so KSPGMRES converges in 2 iterations.
20180ffb0e17SBarry Smith $      *) With DIAG, the preconditioned operator has three distinct nonzero eigenvalues and minimal polynomial of degree at most 4, so KSPGMRES converges in at most 4 iterations.
2019ab1df9f5SJed Brown 
20200ffb0e17SBarry Smith     If the iteration count is very low, consider using KSPFGMRES or KSPGCR which can use one less preconditioner
20210ffb0e17SBarry 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.
20220ffb0e17SBarry Smith 
20230ffb0e17SBarry Smith     For symmetric problems in which A is positive definite and S is negative definite, DIAG can be used with KSPMINRES.
20240ffb0e17SBarry Smith 
20250ffb0e17SBarry Smith     Note that a flexible method like KSPFGMRES or KSPGCR must be used if the fieldsplit preconditioner is nonlinear (e.g. a few iterations of a Krylov method is used to solve with A or S).
2026ab1df9f5SJed Brown 
2027ab1df9f5SJed Brown     References:
202896a0c994SBarry Smith +   1. - Murphy, Golub, and Wathen, A note on preconditioning indefinite linear systems, SIAM J. Sci. Comput., 21 (2000).
202996a0c994SBarry Smith -   2. - Ipsen, A note on preconditioning nonsymmetric matrices, SIAM J. Sci. Comput., 23 (2001).
2030ab1df9f5SJed Brown 
2031c096484dSStefano Zampini .seealso: PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitSetFields(), PCFieldSplitSchurPreType, PCFieldSplitSetSchurScale()
2032ab1df9f5SJed Brown @*/
2033c9c6ffaaSJed Brown PetscErrorCode  PCFieldSplitSetSchurFactType(PC pc,PCFieldSplitSchurFactType ftype)
2034ab1df9f5SJed Brown {
2035ab1df9f5SJed Brown   PetscErrorCode ierr;
2036ab1df9f5SJed Brown 
2037ab1df9f5SJed Brown   PetscFunctionBegin;
2038ab1df9f5SJed Brown   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
2039c9c6ffaaSJed Brown   ierr = PetscTryMethod(pc,"PCFieldSplitSetSchurFactType_C",(PC,PCFieldSplitSchurFactType),(pc,ftype));CHKERRQ(ierr);
2040ab1df9f5SJed Brown   PetscFunctionReturn(0);
2041ab1df9f5SJed Brown }
2042ab1df9f5SJed Brown 
20431e6b0712SBarry Smith static PetscErrorCode PCFieldSplitSetSchurFactType_FieldSplit(PC pc,PCFieldSplitSchurFactType ftype)
2044ab1df9f5SJed Brown {
2045ab1df9f5SJed Brown   PC_FieldSplit *jac = (PC_FieldSplit*)pc->data;
2046ab1df9f5SJed Brown 
2047ab1df9f5SJed Brown   PetscFunctionBegin;
2048ab1df9f5SJed Brown   jac->schurfactorization = ftype;
2049ab1df9f5SJed Brown   PetscFunctionReturn(0);
2050ab1df9f5SJed Brown }
2051ab1df9f5SJed Brown 
2052c096484dSStefano Zampini /*@
2053c096484dSStefano Zampini     PCFieldSplitSetSchurScale -  Controls the sign flip of S for PC_FIELDSPLIT_SCHUR_FACT_DIAG.
2054c096484dSStefano Zampini 
2055c096484dSStefano Zampini     Collective on PC
2056c096484dSStefano Zampini 
2057c096484dSStefano Zampini     Input Parameters:
2058c096484dSStefano Zampini +   pc    - the preconditioner context
2059c096484dSStefano Zampini -   scale - scaling factor for the Schur complement
2060c096484dSStefano Zampini 
2061c096484dSStefano Zampini     Options Database:
2062c096484dSStefano Zampini .     -pc_fieldsplit_schur_scale - default is -1.0
2063c096484dSStefano Zampini 
2064c096484dSStefano Zampini     Level: intermediate
2065c096484dSStefano Zampini 
2066c096484dSStefano Zampini .seealso: PCFIELDSPLIT, PCFieldSplitSetFields(), PCFieldSplitSchurFactType, PCFieldSplitSetSchurScale()
2067c096484dSStefano Zampini @*/
2068c096484dSStefano Zampini PetscErrorCode PCFieldSplitSetSchurScale(PC pc,PetscScalar scale)
2069c096484dSStefano Zampini {
2070c096484dSStefano Zampini   PetscErrorCode ierr;
2071c096484dSStefano Zampini 
2072c096484dSStefano Zampini   PetscFunctionBegin;
2073c096484dSStefano Zampini   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
2074c096484dSStefano Zampini   PetscValidLogicalCollectiveScalar(pc,scale,2);
2075c096484dSStefano Zampini   ierr = PetscTryMethod(pc,"PCFieldSplitSetSchurScale_C",(PC,PetscScalar),(pc,scale));CHKERRQ(ierr);
2076c096484dSStefano Zampini   PetscFunctionReturn(0);
2077c096484dSStefano Zampini }
2078c096484dSStefano Zampini 
2079c096484dSStefano Zampini static PetscErrorCode PCFieldSplitSetSchurScale_FieldSplit(PC pc,PetscScalar scale)
2080c096484dSStefano Zampini {
2081c096484dSStefano Zampini   PC_FieldSplit *jac = (PC_FieldSplit*)pc->data;
2082c096484dSStefano Zampini 
2083c096484dSStefano Zampini   PetscFunctionBegin;
2084c096484dSStefano Zampini   jac->schurscale = scale;
2085c096484dSStefano Zampini   PetscFunctionReturn(0);
2086c096484dSStefano Zampini }
2087c096484dSStefano Zampini 
208830ad9308SMatthew Knepley /*@C
20898c03b21aSDmitry Karpeev    PCFieldSplitGetSchurBlocks - Gets all matrix blocks for the Schur complement
209030ad9308SMatthew Knepley 
209130ad9308SMatthew Knepley    Collective on KSP
209230ad9308SMatthew Knepley 
209330ad9308SMatthew Knepley    Input Parameter:
209430ad9308SMatthew Knepley .  pc - the preconditioner context
209530ad9308SMatthew Knepley 
209630ad9308SMatthew Knepley    Output Parameters:
2097a04f6461SBarry Smith +  A00 - the (0,0) block
2098a04f6461SBarry Smith .  A01 - the (0,1) block
2099a04f6461SBarry Smith .  A10 - the (1,0) block
2100a04f6461SBarry Smith -  A11 - the (1,1) block
210130ad9308SMatthew Knepley 
210230ad9308SMatthew Knepley    Level: advanced
210330ad9308SMatthew Knepley 
210430ad9308SMatthew Knepley .seealso: PCFIELDSPLIT
210530ad9308SMatthew Knepley @*/
2106a04f6461SBarry Smith PetscErrorCode  PCFieldSplitGetSchurBlocks(PC pc,Mat *A00,Mat *A01,Mat *A10, Mat *A11)
210730ad9308SMatthew Knepley {
210830ad9308SMatthew Knepley   PC_FieldSplit *jac = (PC_FieldSplit*) pc->data;
210930ad9308SMatthew Knepley 
211030ad9308SMatthew Knepley   PetscFunctionBegin;
21110700a824SBarry Smith   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
2112ce94432eSBarry Smith   if (jac->type != PC_COMPOSITE_SCHUR) SETERRQ(PetscObjectComm((PetscObject)pc),PETSC_ERR_ARG_WRONG, "FieldSplit is not using a Schur complement approach.");
2113a04f6461SBarry Smith   if (A00) *A00 = jac->pmat[0];
2114a04f6461SBarry Smith   if (A01) *A01 = jac->B;
2115a04f6461SBarry Smith   if (A10) *A10 = jac->C;
2116a04f6461SBarry Smith   if (A11) *A11 = jac->pmat[1];
211730ad9308SMatthew Knepley   PetscFunctionReturn(0);
211830ad9308SMatthew Knepley }
211930ad9308SMatthew Knepley 
21201e6b0712SBarry Smith static PetscErrorCode  PCFieldSplitSetType_FieldSplit(PC pc,PCCompositeType type)
212179416396SBarry Smith {
212279416396SBarry Smith   PC_FieldSplit  *jac = (PC_FieldSplit*)pc->data;
2123e69d4d44SBarry Smith   PetscErrorCode ierr;
212479416396SBarry Smith 
212579416396SBarry Smith   PetscFunctionBegin;
212679416396SBarry Smith   jac->type = type;
21273b224e63SBarry Smith   if (type == PC_COMPOSITE_SCHUR) {
21283b224e63SBarry Smith     pc->ops->apply = PCApply_FieldSplit_Schur;
21293b224e63SBarry Smith     pc->ops->view  = PCView_FieldSplit_Schur;
21302fa5cd67SKarl Rupp 
2131bdf89e91SBarry Smith     ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitGetSubKSP_C",PCFieldSplitGetSubKSP_FieldSplit_Schur);CHKERRQ(ierr);
213229f8a81cSJed Brown     ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetSchurPre_C",PCFieldSplitSetSchurPre_FieldSplit);CHKERRQ(ierr);
213337a82bf0SJed Brown     ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitGetSchurPre_C",PCFieldSplitGetSchurPre_FieldSplit);CHKERRQ(ierr);
2134bdf89e91SBarry Smith     ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetSchurFactType_C",PCFieldSplitSetSchurFactType_FieldSplit);CHKERRQ(ierr);
2135c096484dSStefano Zampini     ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetSchurScale_C",PCFieldSplitSetSchurScale_FieldSplit);CHKERRQ(ierr);
2136e69d4d44SBarry Smith 
21373b224e63SBarry Smith   } else {
21383b224e63SBarry Smith     pc->ops->apply = PCApply_FieldSplit;
21393b224e63SBarry Smith     pc->ops->view  = PCView_FieldSplit;
21402fa5cd67SKarl Rupp 
2141bdf89e91SBarry Smith     ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitGetSubKSP_C",PCFieldSplitGetSubKSP_FieldSplit);CHKERRQ(ierr);
214229f8a81cSJed Brown     ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetSchurPre_C",0);CHKERRQ(ierr);
214337a82bf0SJed Brown     ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitGetSchurPre_C",0);CHKERRQ(ierr);
2144bdf89e91SBarry Smith     ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetSchurFactType_C",0);CHKERRQ(ierr);
2145c096484dSStefano Zampini     ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetSchurScale_C",0);CHKERRQ(ierr);
21463b224e63SBarry Smith   }
214779416396SBarry Smith   PetscFunctionReturn(0);
214879416396SBarry Smith }
214979416396SBarry Smith 
21501e6b0712SBarry Smith static PetscErrorCode  PCFieldSplitSetBlockSize_FieldSplit(PC pc,PetscInt bs)
215151f519a2SBarry Smith {
215251f519a2SBarry Smith   PC_FieldSplit *jac = (PC_FieldSplit*)pc->data;
215351f519a2SBarry Smith 
215451f519a2SBarry Smith   PetscFunctionBegin;
2155ce94432eSBarry Smith   if (bs < 1) SETERRQ1(PetscObjectComm((PetscObject)pc),PETSC_ERR_ARG_OUTOFRANGE,"Blocksize must be positive, you gave %D",bs);
2156ce94432eSBarry 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);
215751f519a2SBarry Smith   jac->bs = bs;
215851f519a2SBarry Smith   PetscFunctionReturn(0);
215951f519a2SBarry Smith }
216051f519a2SBarry Smith 
2161bc08b0f1SBarry Smith /*@
216279416396SBarry Smith    PCFieldSplitSetType - Sets the type of fieldsplit preconditioner.
216379416396SBarry Smith 
216479416396SBarry Smith    Collective on PC
216579416396SBarry Smith 
216679416396SBarry Smith    Input Parameter:
216779416396SBarry Smith .  pc - the preconditioner context
216881540f2fSBarry Smith .  type - PC_COMPOSITE_ADDITIVE, PC_COMPOSITE_MULTIPLICATIVE (default), PC_COMPOSITE_SYMMETRIC_MULTIPLICATIVE, PC_COMPOSITE_SPECIAL, PC_COMPOSITE_SCHUR
216979416396SBarry Smith 
217079416396SBarry Smith    Options Database Key:
2171a4efd8eaSMatthew Knepley .  -pc_fieldsplit_type <type: one of multiplicative, additive, symmetric_multiplicative, special, schur> - Sets fieldsplit preconditioner type
217279416396SBarry Smith 
2173b02e2d75SMatthew G Knepley    Level: Intermediate
217479416396SBarry Smith 
217579416396SBarry Smith .keywords: PC, set, type, composite preconditioner, additive, multiplicative
217679416396SBarry Smith 
217779416396SBarry Smith .seealso: PCCompositeSetType()
217879416396SBarry Smith 
217979416396SBarry Smith @*/
21807087cfbeSBarry Smith PetscErrorCode  PCFieldSplitSetType(PC pc,PCCompositeType type)
218179416396SBarry Smith {
21824ac538c5SBarry Smith   PetscErrorCode ierr;
218379416396SBarry Smith 
218479416396SBarry Smith   PetscFunctionBegin;
21850700a824SBarry Smith   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
21864ac538c5SBarry Smith   ierr = PetscTryMethod(pc,"PCFieldSplitSetType_C",(PC,PCCompositeType),(pc,type));CHKERRQ(ierr);
218779416396SBarry Smith   PetscFunctionReturn(0);
218879416396SBarry Smith }
218979416396SBarry Smith 
2190b02e2d75SMatthew G Knepley /*@
2191b02e2d75SMatthew G Knepley   PCFieldSplitGetType - Gets the type of fieldsplit preconditioner.
2192b02e2d75SMatthew G Knepley 
2193b02e2d75SMatthew G Knepley   Not collective
2194b02e2d75SMatthew G Knepley 
2195b02e2d75SMatthew G Knepley   Input Parameter:
2196b02e2d75SMatthew G Knepley . pc - the preconditioner context
2197b02e2d75SMatthew G Knepley 
2198b02e2d75SMatthew G Knepley   Output Parameter:
2199b02e2d75SMatthew G Knepley . type - PC_COMPOSITE_ADDITIVE, PC_COMPOSITE_MULTIPLICATIVE (default), PC_COMPOSITE_SYMMETRIC_MULTIPLICATIVE, PC_COMPOSITE_SPECIAL, PC_COMPOSITE_SCHUR
2200b02e2d75SMatthew G Knepley 
2201b02e2d75SMatthew G Knepley   Level: Intermediate
2202b02e2d75SMatthew G Knepley 
2203b02e2d75SMatthew G Knepley .keywords: PC, set, type, composite preconditioner, additive, multiplicative
2204b02e2d75SMatthew G Knepley .seealso: PCCompositeSetType()
2205b02e2d75SMatthew G Knepley @*/
2206b02e2d75SMatthew G Knepley PetscErrorCode PCFieldSplitGetType(PC pc, PCCompositeType *type)
2207b02e2d75SMatthew G Knepley {
2208b02e2d75SMatthew G Knepley   PC_FieldSplit *jac = (PC_FieldSplit*) pc->data;
2209b02e2d75SMatthew G Knepley 
2210b02e2d75SMatthew G Knepley   PetscFunctionBegin;
2211b02e2d75SMatthew G Knepley   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
2212b02e2d75SMatthew G Knepley   PetscValidIntPointer(type,2);
2213b02e2d75SMatthew G Knepley   *type = jac->type;
2214b02e2d75SMatthew G Knepley   PetscFunctionReturn(0);
2215b02e2d75SMatthew G Knepley }
2216b02e2d75SMatthew G Knepley 
22174ab8060aSDmitry Karpeev /*@
22184ab8060aSDmitry Karpeev    PCFieldSplitSetDMSplits - Flags whether DMCreateFieldDecomposition() should be used to define the splits, whenever possible.
22194ab8060aSDmitry Karpeev 
22204ab8060aSDmitry Karpeev    Logically Collective
22214ab8060aSDmitry Karpeev 
22224ab8060aSDmitry Karpeev    Input Parameters:
22234ab8060aSDmitry Karpeev +  pc   - the preconditioner context
22244ab8060aSDmitry Karpeev -  flg  - boolean indicating whether to use field splits defined by the DM
22254ab8060aSDmitry Karpeev 
22264ab8060aSDmitry Karpeev    Options Database Key:
22274ab8060aSDmitry Karpeev .  -pc_fieldsplit_dm_splits
22284ab8060aSDmitry Karpeev 
22294ab8060aSDmitry Karpeev    Level: Intermediate
22304ab8060aSDmitry Karpeev 
22314ab8060aSDmitry Karpeev .keywords: PC, DM, composite preconditioner, additive, multiplicative
22324ab8060aSDmitry Karpeev 
22334ab8060aSDmitry Karpeev .seealso: PCFieldSplitGetDMSplits()
22344ab8060aSDmitry Karpeev 
22354ab8060aSDmitry Karpeev @*/
22364ab8060aSDmitry Karpeev PetscErrorCode  PCFieldSplitSetDMSplits(PC pc,PetscBool flg)
22374ab8060aSDmitry Karpeev {
22384ab8060aSDmitry Karpeev   PC_FieldSplit  *jac = (PC_FieldSplit*)pc->data;
22394ab8060aSDmitry Karpeev   PetscBool      isfs;
22404ab8060aSDmitry Karpeev   PetscErrorCode ierr;
22414ab8060aSDmitry Karpeev 
22424ab8060aSDmitry Karpeev   PetscFunctionBegin;
22434ab8060aSDmitry Karpeev   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
22444ab8060aSDmitry Karpeev   PetscValidLogicalCollectiveBool(pc,flg,2);
22454ab8060aSDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)pc,PCFIELDSPLIT,&isfs);CHKERRQ(ierr);
22464ab8060aSDmitry Karpeev   if (isfs) {
22474ab8060aSDmitry Karpeev     jac->dm_splits = flg;
22484ab8060aSDmitry Karpeev   }
22494ab8060aSDmitry Karpeev   PetscFunctionReturn(0);
22504ab8060aSDmitry Karpeev }
22514ab8060aSDmitry Karpeev 
22524ab8060aSDmitry Karpeev 
22534ab8060aSDmitry Karpeev /*@
22544ab8060aSDmitry Karpeev    PCFieldSplitGetDMSplits - Returns flag indicating whether DMCreateFieldDecomposition() should be used to define the splits, whenever possible.
22554ab8060aSDmitry Karpeev 
22564ab8060aSDmitry Karpeev    Logically Collective
22574ab8060aSDmitry Karpeev 
22584ab8060aSDmitry Karpeev    Input Parameter:
22594ab8060aSDmitry Karpeev .  pc   - the preconditioner context
22604ab8060aSDmitry Karpeev 
22614ab8060aSDmitry Karpeev    Output Parameter:
22624ab8060aSDmitry Karpeev .  flg  - boolean indicating whether to use field splits defined by the DM
22634ab8060aSDmitry Karpeev 
22644ab8060aSDmitry Karpeev    Level: Intermediate
22654ab8060aSDmitry Karpeev 
22664ab8060aSDmitry Karpeev .keywords: PC, DM, composite preconditioner, additive, multiplicative
22674ab8060aSDmitry Karpeev 
22684ab8060aSDmitry Karpeev .seealso: PCFieldSplitSetDMSplits()
22694ab8060aSDmitry Karpeev 
22704ab8060aSDmitry Karpeev @*/
22714ab8060aSDmitry Karpeev PetscErrorCode  PCFieldSplitGetDMSplits(PC pc,PetscBool* flg)
22724ab8060aSDmitry Karpeev {
22734ab8060aSDmitry Karpeev   PC_FieldSplit  *jac = (PC_FieldSplit*)pc->data;
22744ab8060aSDmitry Karpeev   PetscBool      isfs;
22754ab8060aSDmitry Karpeev   PetscErrorCode ierr;
22764ab8060aSDmitry Karpeev 
22774ab8060aSDmitry Karpeev   PetscFunctionBegin;
22784ab8060aSDmitry Karpeev   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
22794ab8060aSDmitry Karpeev   PetscValidPointer(flg,2);
22804ab8060aSDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)pc,PCFIELDSPLIT,&isfs);CHKERRQ(ierr);
22814ab8060aSDmitry Karpeev   if (isfs) {
22824ab8060aSDmitry Karpeev     if(flg) *flg = jac->dm_splits;
22834ab8060aSDmitry Karpeev   }
22844ab8060aSDmitry Karpeev   PetscFunctionReturn(0);
22854ab8060aSDmitry Karpeev }
22864ab8060aSDmitry Karpeev 
22870971522cSBarry Smith /* -------------------------------------------------------------------------------------*/
22880971522cSBarry Smith /*MC
2289a8c7a070SBarry Smith    PCFIELDSPLIT - Preconditioner created by combining separate preconditioners for individual
2290a04f6461SBarry Smith                   fields or groups of fields. See the users manual section "Solving Block Matrices" for more details.
22910971522cSBarry Smith 
2292edf189efSBarry Smith      To set options on the solvers for each block append -fieldsplit_ to all the PC
2293edf189efSBarry Smith         options database keys. For example, -fieldsplit_pc_type ilu -fieldsplit_pc_factor_levels 1
22940971522cSBarry Smith 
2295a8c7a070SBarry Smith      To set the options on the solvers separate for each block call PCFieldSplitGetSubKSP()
229669a612a9SBarry Smith          and set the options directly on the resulting KSP object
22970971522cSBarry Smith 
22980971522cSBarry Smith    Level: intermediate
22990971522cSBarry Smith 
230079416396SBarry Smith    Options Database Keys:
230181540f2fSBarry Smith +   -pc_fieldsplit_%d_fields <a,b,..> - indicates the fields to be used in the %d'th split
230281540f2fSBarry Smith .   -pc_fieldsplit_default - automatically add any fields to additional splits that have not
230381540f2fSBarry Smith                               been supplied explicitly by -pc_fieldsplit_%d_fields
230481540f2fSBarry Smith .   -pc_fieldsplit_block_size <bs> - size of block that defines fields (i.e. there are bs fields)
23050f188ba9SJed Brown .   -pc_fieldsplit_type <additive,multiplicative,symmetric_multiplicative,schur> - type of relaxation or factorization splitting
2306a6a584a2SBarry Smith .   -pc_fieldsplit_schur_precondition <self,selfp,user,a11,full> - default is a11; see PCFieldSplitSetSchurPre()
2307435f959eSBarry Smith .   -pc_fieldsplit_detect_saddle_point - automatically finds rows with zero or negative diagonal and uses Schur complement with no preconditioner as the solver
230879416396SBarry Smith 
23095d4c12cdSJungho Lee -    Options prefix for inner solvers when using Schur complement preconditioner are -fieldsplit_0_ and -fieldsplit_1_
23105d4c12cdSJungho Lee      for all other solvers they are -fieldsplit_%d_ for the dth field, use -fieldsplit_ for all fields
23115d4c12cdSJungho Lee 
2312c8a0d604SMatthew G Knepley    Notes:
2313c8a0d604SMatthew G Knepley     Use PCFieldSplitSetFields() to set fields defined by "strided" entries and PCFieldSplitSetIS()
2314d32f9abdSBarry Smith      to define a field by an arbitrary collection of entries.
2315d32f9abdSBarry Smith 
2316d32f9abdSBarry Smith       If no fields are set the default is used. The fields are defined by entries strided by bs,
2317d32f9abdSBarry Smith       beginning at 0 then 1, etc to bs-1. The block size can be set with PCFieldSplitSetBlockSize(),
2318d32f9abdSBarry Smith       if this is not called the block size defaults to the blocksize of the second matrix passed
2319d32f9abdSBarry Smith       to KSPSetOperators()/PCSetOperators().
2320d32f9abdSBarry Smith 
2321c8a0d604SMatthew G Knepley $     For the Schur complement preconditioner if J = ( A00 A01 )
2322c8a0d604SMatthew G Knepley $                                                    ( A10 A11 )
2323c8a0d604SMatthew G Knepley $     the preconditioner using full factorization is
232413b05affSJed Brown $              ( I   -ksp(A00) A01 ) ( inv(A00)     0  ) (     I          0  )
2325c8a0d604SMatthew G Knepley $              ( 0         I       ) (   0      ksp(S) ) ( -A10 ksp(A00)  I  )
232613b05affSJed Brown      where the action of inv(A00) is applied using the KSP solver with prefix -fieldsplit_0_.  S is the Schur complement
232713b05affSJed Brown $              S = A11 - A10 ksp(A00) A01
232813b05affSJed 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
2329c8a0d604SMatthew G Knepley      in providing the SECOND split or 1 if not give). For PCFieldSplitGetKSP() when field number is 0,
2330c8a0d604SMatthew G Knepley      it returns the KSP associated with -fieldsplit_0_ while field number 1 gives -fieldsplit_1_ KSP. By default
2331a6a584a2SBarry Smith      A11 is used to construct a preconditioner for S, use PCFieldSplitSetSchurPre() for all the possible ways to construct the preconditioner for S.
23321d71051fSDmitry Karpeev 
2333a7476a74SDmitry Karpeev      The factorization type is set using -pc_fieldsplit_schur_fact_type <diag, lower, upper, full>. The full is shown above,
23345668aaf4SBarry Smith      diag gives
2335c8a0d604SMatthew G Knepley $              ( inv(A00)     0   )
2336c8a0d604SMatthew G Knepley $              (   0      -ksp(S) )
2337c096484dSStefano Zampini      note that slightly counter intuitively there is a negative in front of the ksp(S) so that the preconditioner is positive definite. For SPD matrices J, the sign flip
2338c096484dSStefano Zampini      can be turned off with PCFieldSplitSetSchurScale() or by command line -pc_fieldsplit_schur_scale 1.0. The lower factorization is the inverse of
2339c8a0d604SMatthew G Knepley $              (  A00   0 )
2340c8a0d604SMatthew G Knepley $              (  A10   S )
2341c8a0d604SMatthew G Knepley      where the inverses of A00 and S are applied using KSPs. The upper factorization is the inverse of
2342c8a0d604SMatthew G Knepley $              ( A00 A01 )
2343c8a0d604SMatthew G Knepley $              (  0   S  )
2344c8a0d604SMatthew G Knepley      where again the inverses of A00 and S are applied using KSPs.
2345e69d4d44SBarry Smith 
2346edf189efSBarry Smith      If only one set of indices (one IS) is provided with PCFieldSplitSetIS() then the complement of that IS
2347edf189efSBarry Smith      is used automatically for a second block.
2348edf189efSBarry Smith 
2349ff218e97SBarry Smith      The fieldsplit preconditioner cannot currently be used with the BAIJ or SBAIJ data formats if the blocksize is larger than 1.
2350ff218e97SBarry Smith      Generally it should be used with the AIJ format.
2351ff218e97SBarry Smith 
2352ff218e97SBarry Smith      The forms of these preconditioners are closely related if not identical to forms derived as "Distributive Iterations", see,
2353ff218e97SBarry Smith      for example, page 294 in "Principles of Computational Fluid Dynamics" by Pieter Wesseling. Note that one can also use PCFIELDSPLIT
2354ff218e97SBarry Smith      inside a smoother resulting in "Distributive Smoothers".
23550716a85fSBarry Smith 
2356a541d17aSBarry Smith    Concepts: physics based preconditioners, block preconditioners
23570971522cSBarry Smith 
23583bc631e0SBarry Smith    There is a nice discussion of block preconditioners in
23593bc631e0SBarry Smith 
23603bc631e0SBarry Smith [El08] A taxonomy and comparison of parallel block multi-level preconditioners for the incompressible Navier-Stokes equations
23613bc631e0SBarry Smith        Howard Elman, V.E. Howle, John Shadid, Robert Shuttleworth, Ray Tuminaro, Journal of Computational Physics 227 (2008) 1790--1808
23623bc631e0SBarry Smith        http://chess.cs.umd.edu/~elman/papers/tax.pdf
23633bc631e0SBarry Smith 
23644d308398SBarry Smith    The Constrained Pressure Preconditioner (CPR) can be implemented using PCCOMPOSITE with PCGALERKIN. CPR first solves an R A P subsystem, updates the
23654d308398SBarry Smith    residual on all variables (PCCompositeSetType(pc,PC_COMPOSITE_MULTIPLICATIVE)), and then applies a simple ILU like preconditioner on all the variables.
2366a6a584a2SBarry Smith 
23677e8cb189SBarry Smith .seealso:  PCCreate(), PCSetType(), PCType (for list of available types), PC, Block_Preconditioners, PCLSC,
23681d71051fSDmitry Karpeev            PCFieldSplitGetSubKSP(), PCFieldSplitSetFields(), PCFieldSplitSetType(), PCFieldSplitSetIS(), PCFieldSplitSetSchurPre(),
2369c096484dSStefano Zampini           MatSchurComplementSetAinvType(), PCFieldSplitSetSchurScale()
23700971522cSBarry Smith M*/
23710971522cSBarry Smith 
23728cc058d9SJed Brown PETSC_EXTERN PetscErrorCode PCCreate_FieldSplit(PC pc)
23730971522cSBarry Smith {
23740971522cSBarry Smith   PetscErrorCode ierr;
23750971522cSBarry Smith   PC_FieldSplit  *jac;
23760971522cSBarry Smith 
23770971522cSBarry Smith   PetscFunctionBegin;
2378b00a9115SJed Brown   ierr = PetscNewLog(pc,&jac);CHKERRQ(ierr);
23792fa5cd67SKarl Rupp 
23800971522cSBarry Smith   jac->bs                 = -1;
23810971522cSBarry Smith   jac->nsplits            = 0;
23823e197d65SBarry Smith   jac->type               = PC_COMPOSITE_MULTIPLICATIVE;
2383e6cab6aaSJed Brown   jac->schurpre           = PC_FIELDSPLIT_SCHUR_PRE_USER; /* Try user preconditioner first, fall back on diagonal */
2384c9c6ffaaSJed Brown   jac->schurfactorization = PC_FIELDSPLIT_SCHUR_FACT_FULL;
2385c096484dSStefano Zampini   jac->schurscale         = -1.0;
2386fbe7908bSJed Brown   jac->dm_splits          = PETSC_TRUE;
238751f519a2SBarry Smith 
23880971522cSBarry Smith   pc->data = (void*)jac;
23890971522cSBarry Smith 
23900971522cSBarry Smith   pc->ops->apply           = PCApply_FieldSplit;
2391421e10b8SBarry Smith   pc->ops->applytranspose  = PCApplyTranspose_FieldSplit;
23920971522cSBarry Smith   pc->ops->setup           = PCSetUp_FieldSplit;
2393574deadeSBarry Smith   pc->ops->reset           = PCReset_FieldSplit;
23940971522cSBarry Smith   pc->ops->destroy         = PCDestroy_FieldSplit;
23950971522cSBarry Smith   pc->ops->setfromoptions  = PCSetFromOptions_FieldSplit;
23960971522cSBarry Smith   pc->ops->view            = PCView_FieldSplit;
23970971522cSBarry Smith   pc->ops->applyrichardson = 0;
23980971522cSBarry Smith 
2399bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitGetSubKSP_C",PCFieldSplitGetSubKSP_FieldSplit);CHKERRQ(ierr);
2400bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetFields_C",PCFieldSplitSetFields_FieldSplit);CHKERRQ(ierr);
2401bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetIS_C",PCFieldSplitSetIS_FieldSplit);CHKERRQ(ierr);
2402bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetType_C",PCFieldSplitSetType_FieldSplit);CHKERRQ(ierr);
2403bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetBlockSize_C",PCFieldSplitSetBlockSize_FieldSplit);CHKERRQ(ierr);
24046dbb499eSCian Wilson   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitRestrictIS_C",PCFieldSplitRestrictIS_FieldSplit);CHKERRQ(ierr);
24050971522cSBarry Smith   PetscFunctionReturn(0);
24060971522cSBarry Smith }
24070971522cSBarry Smith 
24080971522cSBarry Smith 
2409a541d17aSBarry Smith 
2410