xref: /petsc/src/ksp/pc/impls/fieldsplit/fieldsplit.c (revision 80c96bb15cfe73b1b943593be82cd1ebd32b7ab3)
1dba47a55SKris Buschelman 
2af0996ceSBarry Smith #include <petsc/private/pcimpl.h>     /*I "petscpc.h" I*/
3a80b646eSBarry Smith #include <petsc/private/kspimpl.h>    /*  This is needed to provide the appropriate PETSC_EXTERN for KSP_Solve_FS ....*/
41e25c274SJed Brown #include <petscdm.h>
50971522cSBarry Smith 
62e71c61dSMatthew G. Knepley const char *const PCFieldSplitSchurPreTypes[] = {"SELF","SELFP","A11","USER","FULL","PCFieldSplitSchurPreType","PC_FIELDSPLIT_SCHUR_PRE_",0};
7c9c6ffaaSJed Brown const char *const PCFieldSplitSchurFactTypes[] = {"DIAG","LOWER","UPPER","FULL","PCFieldSplitSchurFactType","PC_FIELDSPLIT_SCHUR_FACT_",0};
8c5d2311dSJed Brown 
99df09d43SBarry 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;
109df09d43SBarry Smith 
110971522cSBarry Smith typedef struct _PC_FieldSplitLink *PC_FieldSplitLink;
120971522cSBarry Smith struct _PC_FieldSplitLink {
1369a612a9SBarry Smith   KSP               ksp;
14443836d0SMatthew G Knepley   Vec               x,y,z;
15db4c96c1SJed Brown   char              *splitname;
160971522cSBarry Smith   PetscInt          nfields;
175d4c12cdSJungho Lee   PetscInt          *fields,*fields_col;
181b9fc7fcSBarry Smith   VecScatter        sctx;
196dbb499eSCian Wilson   IS                is,is_col,is_orig;
2051f519a2SBarry Smith   PC_FieldSplitLink next,previous;
219df09d43SBarry Smith   PetscLogEvent     event;
220971522cSBarry Smith };
230971522cSBarry Smith 
240971522cSBarry Smith typedef struct {
2568dd23aaSBarry Smith   PCCompositeType type;
26ace3abfcSBarry Smith   PetscBool       defaultsplit;                    /* Flag for a system with a set of 'k' scalar fields with the same layout (and bs = k) */
27ace3abfcSBarry Smith   PetscBool       splitdefined;                    /* Flag is set after the splits have been defined, to prevent more splits from being added */
2830ad9308SMatthew Knepley   PetscInt        bs;                              /* Block size for IS and Mat structures */
2930ad9308SMatthew Knepley   PetscInt        nsplits;                         /* Number of field divisions defined */
3079416396SBarry Smith   Vec             *x,*y,w1,w2;
31519d70e2SJed Brown   Mat             *mat;                            /* The diagonal block for each split */
32519d70e2SJed Brown   Mat             *pmat;                           /* The preconditioning diagonal block for each split */
3330ad9308SMatthew Knepley   Mat             *Afield;                         /* The rows of the matrix associated with each split */
34ace3abfcSBarry Smith   PetscBool       issetup;
352fa5cd67SKarl Rupp 
3630ad9308SMatthew Knepley   /* Only used when Schur complement preconditioning is used */
3730ad9308SMatthew Knepley   Mat                       B;                     /* The (0,1) block */
3830ad9308SMatthew Knepley   Mat                       C;                     /* The (1,0) block */
39443836d0SMatthew G Knepley   Mat                       schur;                 /* The Schur complement S = A11 - A10 A00^{-1} A01, the KSP here, kspinner, is H_1 in [El08] */
40a7476a74SDmitry Karpeev   Mat                       schurp;                /* Assembled approximation to S built by MatSchurComplement to be used as a preconditioning matrix when solving with S */
41084e4875SJed Brown   Mat                       schur_user;            /* User-provided preconditioning matrix for the Schur complement */
42084e4875SJed Brown   PCFieldSplitSchurPreType  schurpre;              /* Determines which preconditioning matrix is used for the Schur complement */
43c9c6ffaaSJed Brown   PCFieldSplitSchurFactType schurfactorization;
4430ad9308SMatthew Knepley   KSP                       kspschur;              /* The solver for S */
45443836d0SMatthew G Knepley   KSP                       kspupper;              /* The solver for A in the upper diagonal part of the factorization (H_2 in [El08]) */
4697bbdb24SBarry Smith   PC_FieldSplitLink         head;
4763ec74ffSBarry Smith   PetscBool                 reset;                  /* indicates PCReset() has been last called on this object, hack */
486dbb499eSCian Wilson   PetscBool                 isrestrict;             /* indicates PCFieldSplitRestrictIS() has been last called on this object, hack */
49c1570756SJed Brown   PetscBool                 suboptionsset;          /* Indicates that the KSPSetFromOptions() has been called on the sub-KSPs */
504ab8060aSDmitry Karpeev   PetscBool                 dm_splits;              /* Whether to use DMCreateFieldDecomposition() whenever possible */
51c84da90fSDmitry Karpeev   PetscBool                 diag_use_amat;          /* Whether to extract diagonal matrix blocks from Amat, rather than Pmat (weaker than -pc_use_amat) */
52c84da90fSDmitry Karpeev   PetscBool                 offdiag_use_amat;       /* Whether to extract off-diagonal matrix blocks from Amat, rather than Pmat (weaker than -pc_use_amat) */
530971522cSBarry Smith } PC_FieldSplit;
540971522cSBarry Smith 
5516913363SBarry Smith /*
5616913363SBarry Smith     Notes: there is no particular reason that pmat, x, and y are stored as arrays in PC_FieldSplit instead of
5716913363SBarry Smith    inside PC_FieldSplitLink, just historical. If you want to be able to add new fields after already using the
5816913363SBarry Smith    PC you could change this.
5916913363SBarry Smith */
60084e4875SJed Brown 
61e6cab6aaSJed Brown /* This helper is so that setting a user-provided preconditioning matrix is orthogonal to choosing to use it.  This way the
62084e4875SJed Brown * application-provided FormJacobian can provide this matrix without interfering with the user's (command-line) choices. */
63084e4875SJed Brown static Mat FieldSplitSchurPre(PC_FieldSplit *jac)
64084e4875SJed Brown {
65084e4875SJed Brown   switch (jac->schurpre) {
66084e4875SJed Brown   case PC_FIELDSPLIT_SCHUR_PRE_SELF: return jac->schur;
67a7476a74SDmitry Karpeev   case PC_FIELDSPLIT_SCHUR_PRE_SELFP: return jac->schurp;
68e87fab1bSBarry Smith   case PC_FIELDSPLIT_SCHUR_PRE_A11: return jac->pmat[1];
69e74569cdSMatthew G. Knepley   case PC_FIELDSPLIT_SCHUR_PRE_FULL: /* We calculate this and store it in schur_user */
70084e4875SJed Brown   case PC_FIELDSPLIT_SCHUR_PRE_USER: /* Use a user-provided matrix if it is given, otherwise diagonal block */
71084e4875SJed Brown   default:
72084e4875SJed Brown     return jac->schur_user ? jac->schur_user : jac->pmat[1];
73084e4875SJed Brown   }
74084e4875SJed Brown }
75084e4875SJed Brown 
76084e4875SJed Brown 
779804daf3SBarry Smith #include <petscdraw.h>
780971522cSBarry Smith #undef __FUNCT__
790971522cSBarry Smith #define __FUNCT__ "PCView_FieldSplit"
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     ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
1080971522cSBarry Smith     for (i=0; i<jac->nsplits; i++) {
1091ab39975SBarry Smith       if (ilink->fields) {
1100971522cSBarry Smith         ierr = PetscViewerASCIIPrintf(viewer,"Split number %D Fields ",i);CHKERRQ(ierr);
11179416396SBarry Smith         ierr = PetscViewerASCIIUseTabs(viewer,PETSC_FALSE);CHKERRQ(ierr);
1125a9f2f41SSatish Balay         for (j=0; j<ilink->nfields; j++) {
11379416396SBarry Smith           if (j > 0) {
11479416396SBarry Smith             ierr = PetscViewerASCIIPrintf(viewer,",");CHKERRQ(ierr);
11579416396SBarry Smith           }
1165a9f2f41SSatish Balay           ierr = PetscViewerASCIIPrintf(viewer," %D",ilink->fields[j]);CHKERRQ(ierr);
1170971522cSBarry Smith         }
1180971522cSBarry Smith         ierr = PetscViewerASCIIPrintf(viewer,"\n");CHKERRQ(ierr);
11979416396SBarry Smith         ierr = PetscViewerASCIIUseTabs(viewer,PETSC_TRUE);CHKERRQ(ierr);
1201ab39975SBarry Smith       } else {
1211ab39975SBarry Smith         ierr = PetscViewerASCIIPrintf(viewer,"Split number %D Defined by IS\n",i);CHKERRQ(ierr);
1221ab39975SBarry Smith       }
1235a9f2f41SSatish Balay       ierr  = KSPView(ilink->ksp,viewer);CHKERRQ(ierr);
1245a9f2f41SSatish Balay       ilink = ilink->next;
1250971522cSBarry Smith     }
1260971522cSBarry Smith     ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
1272fa5cd67SKarl Rupp   }
1282fa5cd67SKarl Rupp 
1292fa5cd67SKarl Rupp  if (isdraw) {
130d9884438SBarry Smith     PetscDraw draw;
131d9884438SBarry Smith     PetscReal x,y,w,wd;
132d9884438SBarry Smith 
133d9884438SBarry Smith     ierr = PetscViewerDrawGetDraw(viewer,0,&draw);CHKERRQ(ierr);
134d9884438SBarry Smith     ierr = PetscDrawGetCurrentPoint(draw,&x,&y);CHKERRQ(ierr);
135d9884438SBarry Smith     w    = 2*PetscMin(1.0 - x,x);
136d9884438SBarry Smith     wd   = w/(jac->nsplits + 1);
137d9884438SBarry Smith     x    = x - wd*(jac->nsplits-1)/2.0;
138d9884438SBarry Smith     for (i=0; i<jac->nsplits; i++) {
139d9884438SBarry Smith       ierr  = PetscDrawPushCurrentPoint(draw,x,y);CHKERRQ(ierr);
140d9884438SBarry Smith       ierr  = KSPView(ilink->ksp,viewer);CHKERRQ(ierr);
141d9884438SBarry Smith       ierr  = PetscDrawPopCurrentPoint(draw);CHKERRQ(ierr);
142d9884438SBarry Smith       x    += wd;
143d9884438SBarry Smith       ilink = ilink->next;
144d9884438SBarry Smith     }
1450971522cSBarry Smith   }
1460971522cSBarry Smith   PetscFunctionReturn(0);
1470971522cSBarry Smith }
1480971522cSBarry Smith 
1490971522cSBarry Smith #undef __FUNCT__
1503b224e63SBarry Smith #define __FUNCT__ "PCView_FieldSplit_Schur"
1513b224e63SBarry Smith static PetscErrorCode PCView_FieldSplit_Schur(PC pc,PetscViewer viewer)
1523b224e63SBarry Smith {
1533b224e63SBarry Smith   PC_FieldSplit     *jac = (PC_FieldSplit*)pc->data;
1543b224e63SBarry Smith   PetscErrorCode    ierr;
1554996c5bdSBarry Smith   PetscBool         iascii,isdraw;
1563b224e63SBarry Smith   PetscInt          i,j;
1573b224e63SBarry Smith   PC_FieldSplitLink ilink = jac->head;
1583b224e63SBarry Smith 
1593b224e63SBarry Smith   PetscFunctionBegin;
160251f4c67SDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&iascii);CHKERRQ(ierr);
1614996c5bdSBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERDRAW,&isdraw);CHKERRQ(ierr);
1623b224e63SBarry Smith   if (iascii) {
1632c9966d7SBarry Smith     if (jac->bs > 0) {
164c9c6ffaaSJed Brown       ierr = PetscViewerASCIIPrintf(viewer,"  FieldSplit with Schur preconditioner, blocksize = %D, factorization %s\n",jac->bs,PCFieldSplitSchurFactTypes[jac->schurfactorization]);CHKERRQ(ierr);
1652c9966d7SBarry Smith     } else {
1662c9966d7SBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"  FieldSplit with Schur preconditioner, factorization %s\n",PCFieldSplitSchurFactTypes[jac->schurfactorization]);CHKERRQ(ierr);
1672c9966d7SBarry Smith     }
168f5236f50SJed Brown     if (pc->useAmat) {
169f5236f50SJed Brown       ierr = PetscViewerASCIIPrintf(viewer,"  using Amat (not Pmat) as operator for blocks\n");CHKERRQ(ierr);
170a3df900dSMatthew G Knepley     }
1713e8b8b31SMatthew G Knepley     switch (jac->schurpre) {
1723e8b8b31SMatthew G Knepley     case PC_FIELDSPLIT_SCHUR_PRE_SELF:
1733e8b8b31SMatthew G Knepley       ierr = PetscViewerASCIIPrintf(viewer,"  Preconditioner for the Schur complement formed from S itself\n");CHKERRQ(ierr);break;
174a7476a74SDmitry Karpeev     case PC_FIELDSPLIT_SCHUR_PRE_SELFP:
1751d71051fSDmitry Karpeev       ierr = PetscViewerASCIIPrintf(viewer,"  Preconditioner for the Schur complement formed from Sp, an assembled approximation to S, which uses (lumped, if requested) A00's diagonal's inverse\n");CHKERRQ(ierr);break;
176e87fab1bSBarry Smith     case PC_FIELDSPLIT_SCHUR_PRE_A11:
177e87fab1bSBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"  Preconditioner for the Schur complement formed from A11\n");CHKERRQ(ierr);break;
178e74569cdSMatthew G. Knepley     case PC_FIELDSPLIT_SCHUR_PRE_FULL:
179e74569cdSMatthew G. Knepley       ierr = PetscViewerASCIIPrintf(viewer,"  Preconditioner for the Schur complement formed from the exact Schur complement\n");CHKERRQ(ierr);break;
1803e8b8b31SMatthew G Knepley     case PC_FIELDSPLIT_SCHUR_PRE_USER:
1813e8b8b31SMatthew G Knepley       if (jac->schur_user) {
1823e8b8b31SMatthew G Knepley         ierr = PetscViewerASCIIPrintf(viewer,"  Preconditioner for the Schur complement formed from user provided matrix\n");CHKERRQ(ierr);
1833e8b8b31SMatthew G Knepley       } else {
184e87fab1bSBarry Smith         ierr = PetscViewerASCIIPrintf(viewer,"  Preconditioner for the Schur complement formed from A11\n");CHKERRQ(ierr);
1853e8b8b31SMatthew G Knepley       }
1863e8b8b31SMatthew G Knepley       break;
1873e8b8b31SMatthew G Knepley     default:
18882f516ccSBarry Smith       SETERRQ1(PetscObjectComm((PetscObject)pc), PETSC_ERR_ARG_OUTOFRANGE, "Invalid Schur preconditioning type: %d", jac->schurpre);
1893e8b8b31SMatthew G Knepley     }
1903b224e63SBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"  Split info:\n");CHKERRQ(ierr);
1913b224e63SBarry Smith     ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
1923b224e63SBarry Smith     for (i=0; i<jac->nsplits; i++) {
1933b224e63SBarry Smith       if (ilink->fields) {
1943b224e63SBarry Smith         ierr = PetscViewerASCIIPrintf(viewer,"Split number %D Fields ",i);CHKERRQ(ierr);
1953b224e63SBarry Smith         ierr = PetscViewerASCIIUseTabs(viewer,PETSC_FALSE);CHKERRQ(ierr);
1963b224e63SBarry Smith         for (j=0; j<ilink->nfields; j++) {
1973b224e63SBarry Smith           if (j > 0) {
1983b224e63SBarry Smith             ierr = PetscViewerASCIIPrintf(viewer,",");CHKERRQ(ierr);
1993b224e63SBarry Smith           }
2003b224e63SBarry Smith           ierr = PetscViewerASCIIPrintf(viewer," %D",ilink->fields[j]);CHKERRQ(ierr);
2013b224e63SBarry Smith         }
2023b224e63SBarry Smith         ierr = PetscViewerASCIIPrintf(viewer,"\n");CHKERRQ(ierr);
2033b224e63SBarry Smith         ierr = PetscViewerASCIIUseTabs(viewer,PETSC_TRUE);CHKERRQ(ierr);
2043b224e63SBarry Smith       } else {
2053b224e63SBarry Smith         ierr = PetscViewerASCIIPrintf(viewer,"Split number %D Defined by IS\n",i);CHKERRQ(ierr);
2063b224e63SBarry Smith       }
2073b224e63SBarry Smith       ilink = ilink->next;
2083b224e63SBarry Smith     }
209435f959eSBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"KSP solver for A00 block\n");CHKERRQ(ierr);
2103b224e63SBarry Smith     ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
21106de4afeSJed Brown     if (jac->head) {
212443836d0SMatthew G Knepley       ierr = KSPView(jac->head->ksp,viewer);CHKERRQ(ierr);
21306de4afeSJed Brown     } else  {ierr = PetscViewerASCIIPrintf(viewer,"  not yet available\n");CHKERRQ(ierr);}
2143b224e63SBarry Smith     ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
21506de4afeSJed Brown     if (jac->head && jac->kspupper != jac->head->ksp) {
216443836d0SMatthew G Knepley       ierr = PetscViewerASCIIPrintf(viewer,"KSP solver for upper A00 in upper triangular factor \n");CHKERRQ(ierr);
217443836d0SMatthew G Knepley       ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
218b2750c55SJed Brown       if (jac->kspupper) {ierr = KSPView(jac->kspupper,viewer);CHKERRQ(ierr);}
219b2750c55SJed Brown       else {ierr = PetscViewerASCIIPrintf(viewer,"  not yet available\n");CHKERRQ(ierr);}
220443836d0SMatthew G Knepley       ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
221443836d0SMatthew G Knepley     }
222435f959eSBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"KSP solver for S = A11 - A10 inv(A00) A01 \n");CHKERRQ(ierr);
2233b224e63SBarry Smith     ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
22412cae6f2SJed Brown     if (jac->kspschur) {
2253b224e63SBarry Smith       ierr = KSPView(jac->kspschur,viewer);CHKERRQ(ierr);
22612cae6f2SJed Brown     } else {
22712cae6f2SJed Brown       ierr = PetscViewerASCIIPrintf(viewer,"  not yet available\n");CHKERRQ(ierr);
22812cae6f2SJed Brown     }
2293b224e63SBarry Smith     ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
2303b224e63SBarry Smith     ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
23106de4afeSJed Brown   } else if (isdraw && jac->head) {
2324996c5bdSBarry Smith     PetscDraw draw;
2334996c5bdSBarry Smith     PetscReal x,y,w,wd,h;
2344996c5bdSBarry Smith     PetscInt  cnt = 2;
2354996c5bdSBarry Smith     char      str[32];
2364996c5bdSBarry Smith 
2374996c5bdSBarry Smith     ierr = PetscViewerDrawGetDraw(viewer,0,&draw);CHKERRQ(ierr);
2384996c5bdSBarry Smith     ierr = PetscDrawGetCurrentPoint(draw,&x,&y);CHKERRQ(ierr);
239c74581afSBarry Smith     if (jac->kspupper != jac->head->ksp) cnt++;
240c74581afSBarry Smith     w  = 2*PetscMin(1.0 - x,x);
241c74581afSBarry Smith     wd = w/(cnt + 1);
242c74581afSBarry Smith 
2434996c5bdSBarry Smith     ierr = PetscSNPrintf(str,32,"Schur fact. %s",PCFieldSplitSchurFactTypes[jac->schurfactorization]);CHKERRQ(ierr);
24451fa3d41SBarry Smith     ierr = PetscDrawStringBoxed(draw,x,y,PETSC_DRAW_RED,PETSC_DRAW_BLACK,str,NULL,&h);CHKERRQ(ierr);
2454996c5bdSBarry Smith     y   -= h;
2464996c5bdSBarry Smith     if (jac->schurpre == PC_FIELDSPLIT_SCHUR_PRE_USER &&  !jac->schur_user) {
247e87fab1bSBarry Smith       ierr = PetscSNPrintf(str,32,"Prec. for Schur from %s",PCFieldSplitSchurPreTypes[PC_FIELDSPLIT_SCHUR_PRE_A11]);CHKERRQ(ierr);
2483b224e63SBarry Smith     } else {
2494996c5bdSBarry Smith       ierr = PetscSNPrintf(str,32,"Prec. for Schur from %s",PCFieldSplitSchurPreTypes[jac->schurpre]);CHKERRQ(ierr);
2504996c5bdSBarry Smith     }
25151fa3d41SBarry Smith     ierr = PetscDrawStringBoxed(draw,x+wd*(cnt-1)/2.0,y,PETSC_DRAW_RED,PETSC_DRAW_BLACK,str,NULL,&h);CHKERRQ(ierr);
2524996c5bdSBarry Smith     y   -= h;
2534996c5bdSBarry Smith     x    = x - wd*(cnt-1)/2.0;
2544996c5bdSBarry Smith 
2554996c5bdSBarry Smith     ierr = PetscDrawPushCurrentPoint(draw,x,y);CHKERRQ(ierr);
2564996c5bdSBarry Smith     ierr = KSPView(jac->head->ksp,viewer);CHKERRQ(ierr);
2574996c5bdSBarry Smith     ierr = PetscDrawPopCurrentPoint(draw);CHKERRQ(ierr);
2584996c5bdSBarry Smith     if (jac->kspupper != jac->head->ksp) {
2594996c5bdSBarry Smith       x   += wd;
2604996c5bdSBarry Smith       ierr = PetscDrawPushCurrentPoint(draw,x,y);CHKERRQ(ierr);
2614996c5bdSBarry Smith       ierr = KSPView(jac->kspupper,viewer);CHKERRQ(ierr);
2624996c5bdSBarry Smith       ierr = PetscDrawPopCurrentPoint(draw);CHKERRQ(ierr);
2634996c5bdSBarry Smith     }
2644996c5bdSBarry Smith     x   += wd;
2654996c5bdSBarry Smith     ierr = PetscDrawPushCurrentPoint(draw,x,y);CHKERRQ(ierr);
2664996c5bdSBarry Smith     ierr = KSPView(jac->kspschur,viewer);CHKERRQ(ierr);
2674996c5bdSBarry Smith     ierr = PetscDrawPopCurrentPoint(draw);CHKERRQ(ierr);
2683b224e63SBarry Smith   }
2693b224e63SBarry Smith   PetscFunctionReturn(0);
2703b224e63SBarry Smith }
2713b224e63SBarry Smith 
2723b224e63SBarry Smith #undef __FUNCT__
2736c924f48SJed Brown #define __FUNCT__ "PCFieldSplitSetRuntimeSplits_Private"
2746c924f48SJed Brown /* Precondition: jac->bs is set to a meaningful value */
2756c924f48SJed Brown static PetscErrorCode PCFieldSplitSetRuntimeSplits_Private(PC pc)
2766c924f48SJed Brown {
2776c924f48SJed Brown   PetscErrorCode ierr;
2786c924f48SJed Brown   PC_FieldSplit  *jac = (PC_FieldSplit*)pc->data;
2795d4c12cdSJungho Lee   PetscInt       i,nfields,*ifields,nfields_col,*ifields_col;
2805d4c12cdSJungho Lee   PetscBool      flg,flg_col;
2815d4c12cdSJungho Lee   char           optionname[128],splitname[8],optionname_col[128];
2826c924f48SJed Brown 
2836c924f48SJed Brown   PetscFunctionBegin;
284785e854fSJed Brown   ierr = PetscMalloc1(jac->bs,&ifields);CHKERRQ(ierr);
285785e854fSJed Brown   ierr = PetscMalloc1(jac->bs,&ifields_col);CHKERRQ(ierr);
2866c924f48SJed Brown   for (i=0,flg=PETSC_TRUE;; i++) {
2878caf3d72SBarry Smith     ierr        = PetscSNPrintf(splitname,sizeof(splitname),"%D",i);CHKERRQ(ierr);
2888caf3d72SBarry Smith     ierr        = PetscSNPrintf(optionname,sizeof(optionname),"-pc_fieldsplit_%D_fields",i);CHKERRQ(ierr);
2898caf3d72SBarry Smith     ierr        = PetscSNPrintf(optionname_col,sizeof(optionname_col),"-pc_fieldsplit_%D_fields_col",i);CHKERRQ(ierr);
2906c924f48SJed Brown     nfields     = jac->bs;
29129499fbbSJungho Lee     nfields_col = jac->bs;
292c5929fdfSBarry Smith     ierr        = PetscOptionsGetIntArray(((PetscObject)pc)->options,((PetscObject)pc)->prefix,optionname,ifields,&nfields,&flg);CHKERRQ(ierr);
293c5929fdfSBarry Smith     ierr        = PetscOptionsGetIntArray(((PetscObject)pc)->options,((PetscObject)pc)->prefix,optionname_col,ifields_col,&nfields_col,&flg_col);CHKERRQ(ierr);
2946c924f48SJed Brown     if (!flg) break;
2955d4c12cdSJungho Lee     else if (flg && !flg_col) {
2965d4c12cdSJungho Lee       if (!nfields) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_USER,"Cannot list zero fields");
2975d4c12cdSJungho Lee       ierr = PCFieldSplitSetFields(pc,splitname,nfields,ifields,ifields);CHKERRQ(ierr);
2982fa5cd67SKarl Rupp     } else {
2995d4c12cdSJungho Lee       if (!nfields || !nfields_col) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_USER,"Cannot list zero fields");
3005d4c12cdSJungho Lee       if (nfields != nfields_col) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_USER,"Number of row and column fields must match");
3015d4c12cdSJungho Lee       ierr = PCFieldSplitSetFields(pc,splitname,nfields,ifields,ifields_col);CHKERRQ(ierr);
3025d4c12cdSJungho Lee     }
3036c924f48SJed Brown   }
3046c924f48SJed Brown   if (i > 0) {
3056c924f48SJed Brown     /* Makes command-line setting of splits take precedence over setting them in code.
3066c924f48SJed Brown        Otherwise subsequent calls to PCFieldSplitSetIS() or PCFieldSplitSetFields() would
3076c924f48SJed Brown        create new splits, which would probably not be what the user wanted. */
3086c924f48SJed Brown     jac->splitdefined = PETSC_TRUE;
3096c924f48SJed Brown   }
3106c924f48SJed Brown   ierr = PetscFree(ifields);CHKERRQ(ierr);
3115d4c12cdSJungho Lee   ierr = PetscFree(ifields_col);CHKERRQ(ierr);
3126c924f48SJed Brown   PetscFunctionReturn(0);
3136c924f48SJed Brown }
3146c924f48SJed Brown 
3156c924f48SJed Brown #undef __FUNCT__
31669a612a9SBarry Smith #define __FUNCT__ "PCFieldSplitSetDefaults"
31769a612a9SBarry Smith static PetscErrorCode PCFieldSplitSetDefaults(PC pc)
3180971522cSBarry Smith {
3190971522cSBarry Smith   PC_FieldSplit     *jac = (PC_FieldSplit*)pc->data;
3200971522cSBarry Smith   PetscErrorCode    ierr;
3215a9f2f41SSatish Balay   PC_FieldSplitLink ilink = jac->head;
3223a062f41SBarry Smith   PetscBool         fieldsplit_default = PETSC_FALSE,stokes = PETSC_FALSE,coupling = PETSC_FALSE;
3236c924f48SJed Brown   PetscInt          i;
3240971522cSBarry Smith 
3250971522cSBarry Smith   PetscFunctionBegin;
3267287d2a3SDmitry Karpeev   /*
3277287d2a3SDmitry Karpeev    Kinda messy, but at least this now uses DMCreateFieldDecomposition() even with jac->reset.
3287287d2a3SDmitry Karpeev    Should probably be rewritten.
3297287d2a3SDmitry Karpeev    */
3307287d2a3SDmitry Karpeev   if (!ilink || jac->reset) {
331c5929fdfSBarry Smith     ierr = PetscOptionsGetBool(((PetscObject)pc)->options,((PetscObject)pc)->prefix,"-pc_fieldsplit_detect_saddle_point",&stokes,NULL);CHKERRQ(ierr);
332c5929fdfSBarry Smith     ierr = PetscOptionsGetBool(((PetscObject)pc)->options,((PetscObject)pc)->prefix,"-pc_fieldsplit_detect_coupling",&coupling,NULL);CHKERRQ(ierr);
3333a062f41SBarry Smith     if (pc->dm && jac->dm_splits && !stokes && !coupling) {
334bafc1b83SMatthew G Knepley       PetscInt  numFields, f, i, j;
3350784a22cSJed Brown       char      **fieldNames;
3367b62db95SJungho Lee       IS        *fields;
337e7c4fc90SDmitry Karpeev       DM        *dms;
338bafc1b83SMatthew G Knepley       DM        subdm[128];
339bafc1b83SMatthew G Knepley       PetscBool flg;
340bafc1b83SMatthew G Knepley 
34116621825SDmitry Karpeev       ierr = DMCreateFieldDecomposition(pc->dm, &numFields, &fieldNames, &fields, &dms);CHKERRQ(ierr);
342bafc1b83SMatthew G Knepley       /* Allow the user to prescribe the splits */
343bafc1b83SMatthew G Knepley       for (i = 0, flg = PETSC_TRUE;; i++) {
344bafc1b83SMatthew G Knepley         PetscInt ifields[128];
345bafc1b83SMatthew G Knepley         IS       compField;
346bafc1b83SMatthew G Knepley         char     optionname[128], splitname[8];
347bafc1b83SMatthew G Knepley         PetscInt nfields = numFields;
348bafc1b83SMatthew G Knepley 
3498caf3d72SBarry Smith         ierr = PetscSNPrintf(optionname, sizeof(optionname), "-pc_fieldsplit_%D_fields", i);CHKERRQ(ierr);
350c5929fdfSBarry Smith         ierr = PetscOptionsGetIntArray(((PetscObject)pc)->options,((PetscObject)pc)->prefix, optionname, ifields, &nfields, &flg);CHKERRQ(ierr);
351bafc1b83SMatthew G Knepley         if (!flg) break;
35282f516ccSBarry Smith         if (numFields > 128) SETERRQ1(PetscObjectComm((PetscObject)pc),PETSC_ERR_SUP,"Cannot currently support %d > 128 fields", numFields);
353bafc1b83SMatthew G Knepley         ierr = DMCreateSubDM(pc->dm, nfields, ifields, &compField, &subdm[i]);CHKERRQ(ierr);
354bafc1b83SMatthew G Knepley         if (nfields == 1) {
355bafc1b83SMatthew G Knepley           ierr = PCFieldSplitSetIS(pc, fieldNames[ifields[0]], compField);CHKERRQ(ierr);
356bafc1b83SMatthew G Knepley         } else {
3578caf3d72SBarry Smith           ierr = PetscSNPrintf(splitname, sizeof(splitname), "%D", i);CHKERRQ(ierr);
358bafc1b83SMatthew G Knepley           ierr = PCFieldSplitSetIS(pc, splitname, compField);CHKERRQ(ierr);
3597287d2a3SDmitry Karpeev         }
360bafc1b83SMatthew G Knepley         ierr = ISDestroy(&compField);CHKERRQ(ierr);
361bafc1b83SMatthew G Knepley         for (j = 0; j < nfields; ++j) {
362bafc1b83SMatthew G Knepley           f    = ifields[j];
3637b62db95SJungho Lee           ierr = PetscFree(fieldNames[f]);CHKERRQ(ierr);
3647b62db95SJungho Lee           ierr = ISDestroy(&fields[f]);CHKERRQ(ierr);
3657b62db95SJungho Lee         }
366bafc1b83SMatthew G Knepley       }
367bafc1b83SMatthew G Knepley       if (i == 0) {
368bafc1b83SMatthew G Knepley         for (f = 0; f < numFields; ++f) {
369bafc1b83SMatthew G Knepley           ierr = PCFieldSplitSetIS(pc, fieldNames[f], fields[f]);CHKERRQ(ierr);
370bafc1b83SMatthew G Knepley           ierr = PetscFree(fieldNames[f]);CHKERRQ(ierr);
371bafc1b83SMatthew G Knepley           ierr = ISDestroy(&fields[f]);CHKERRQ(ierr);
372bafc1b83SMatthew G Knepley         }
373bafc1b83SMatthew G Knepley       } else {
374d724dfffSBarry Smith         for (j=0; j<numFields; j++) {
375d724dfffSBarry Smith           ierr = DMDestroy(dms+j);CHKERRQ(ierr);
376d724dfffSBarry Smith         }
377d724dfffSBarry Smith         ierr = PetscFree(dms);CHKERRQ(ierr);
378785e854fSJed Brown         ierr = PetscMalloc1(i, &dms);CHKERRQ(ierr);
3792fa5cd67SKarl Rupp         for (j = 0; j < i; ++j) dms[j] = subdm[j];
380bafc1b83SMatthew G Knepley       }
3817b62db95SJungho Lee       ierr = PetscFree(fieldNames);CHKERRQ(ierr);
3827b62db95SJungho Lee       ierr = PetscFree(fields);CHKERRQ(ierr);
383e7c4fc90SDmitry Karpeev       if (dms) {
3848b8307b2SJed Brown         ierr = PetscInfo(pc, "Setting up physics based fieldsplit preconditioner using the embedded DM\n");CHKERRQ(ierr);
385bafc1b83SMatthew G Knepley         for (ilink = jac->head, i = 0; ilink; ilink = ilink->next, ++i) {
3867287d2a3SDmitry Karpeev           const char *prefix;
3877287d2a3SDmitry Karpeev           ierr = PetscObjectGetOptionsPrefix((PetscObject)(ilink->ksp),&prefix);CHKERRQ(ierr);
3887287d2a3SDmitry Karpeev           ierr = PetscObjectSetOptionsPrefix((PetscObject)(dms[i]), prefix);CHKERRQ(ierr);
3897b62db95SJungho Lee           ierr = KSPSetDM(ilink->ksp, dms[i]);CHKERRQ(ierr);
3907b62db95SJungho Lee           ierr = KSPSetDMActive(ilink->ksp, PETSC_FALSE);CHKERRQ(ierr);
3917287d2a3SDmitry Karpeev           ierr = PetscObjectIncrementTabLevel((PetscObject)dms[i],(PetscObject)ilink->ksp,0);CHKERRQ(ierr);
392e7c4fc90SDmitry Karpeev           ierr = DMDestroy(&dms[i]);CHKERRQ(ierr);
3932fa5ba8aSJed Brown         }
3947b62db95SJungho Lee         ierr = PetscFree(dms);CHKERRQ(ierr);
3958b8307b2SJed Brown       }
39666ffff09SJed Brown     } else {
397521d7252SBarry Smith       if (jac->bs <= 0) {
398704ba839SBarry Smith         if (pc->pmat) {
399521d7252SBarry Smith           ierr = MatGetBlockSize(pc->pmat,&jac->bs);CHKERRQ(ierr);
4002fa5cd67SKarl Rupp         } else jac->bs = 1;
401521d7252SBarry Smith       }
402d32f9abdSBarry Smith 
4036ce1633cSBarry Smith       if (stokes) {
4046ce1633cSBarry Smith         IS       zerodiags,rest;
4056ce1633cSBarry Smith         PetscInt nmin,nmax;
4066ce1633cSBarry Smith 
4076ce1633cSBarry Smith         ierr = MatGetOwnershipRange(pc->mat,&nmin,&nmax);CHKERRQ(ierr);
4086ce1633cSBarry Smith         ierr = MatFindZeroDiagonals(pc->mat,&zerodiags);CHKERRQ(ierr);
4096ce1633cSBarry Smith         ierr = ISComplement(zerodiags,nmin,nmax,&rest);CHKERRQ(ierr);
4107287d2a3SDmitry Karpeev         if (jac->reset) {
4112a808120SBarry Smith           if (!jac->head) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_PLIB,"At reset jac must have head from previous setup");
4127287d2a3SDmitry Karpeev           jac->head->is       = rest;
4137287d2a3SDmitry Karpeev           jac->head->next->is = zerodiags;
4142fa5cd67SKarl Rupp         } else {
4156ce1633cSBarry Smith           ierr = PCFieldSplitSetIS(pc,"0",rest);CHKERRQ(ierr);
4166ce1633cSBarry Smith           ierr = PCFieldSplitSetIS(pc,"1",zerodiags);CHKERRQ(ierr);
4177287d2a3SDmitry Karpeev         }
418fcfd50ebSBarry Smith         ierr = ISDestroy(&zerodiags);CHKERRQ(ierr);
419fcfd50ebSBarry Smith         ierr = ISDestroy(&rest);CHKERRQ(ierr);
4203a062f41SBarry Smith       } else if (coupling) {
4213a062f41SBarry Smith         IS       coupling,rest;
4223a062f41SBarry Smith         PetscInt nmin,nmax;
4233a062f41SBarry Smith 
4243a062f41SBarry Smith         ierr = MatGetOwnershipRange(pc->mat,&nmin,&nmax);CHKERRQ(ierr);
4253a062f41SBarry Smith         ierr = MatFindOffBlockDiagonalEntries(pc->mat,&coupling);CHKERRQ(ierr);
4266bea0878SBarry Smith         ierr = ISCreateStride(PetscObjectComm((PetscObject)pc->mat),nmax-nmin,nmin,1,&rest);CHKERRQ(ierr);
427e52d2c62SBarry Smith         ierr = ISSetIdentity(rest);CHKERRQ(ierr);
4283a062f41SBarry Smith         if (jac->reset) {
4292a808120SBarry Smith           if (!jac->head) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_PLIB,"At reset jac must have head from previous setup");
430bb3d4b4cSBarry Smith           jac->head->is       = rest;
431bb3d4b4cSBarry Smith           jac->head->next->is = coupling;
4323a062f41SBarry Smith         } else {
433d020c841SBarry Smith           ierr = PCFieldSplitSetIS(pc,"0",rest);CHKERRQ(ierr);
434d020c841SBarry Smith           ierr = PCFieldSplitSetIS(pc,"1",coupling);CHKERRQ(ierr);
4353a062f41SBarry Smith         }
4363a062f41SBarry Smith         ierr = ISDestroy(&coupling);CHKERRQ(ierr);
4373a062f41SBarry Smith         ierr = ISDestroy(&rest);CHKERRQ(ierr);
4386ce1633cSBarry Smith       } else {
4396dbb499eSCian Wilson         if (jac->reset && !jac->isrestrict) SETERRQ(PetscObjectComm((PetscObject)pc),PETSC_ERR_SUP,"Cases not yet handled when PCReset() was used");
440c5929fdfSBarry Smith         ierr = PetscOptionsGetBool(((PetscObject)pc)->options,((PetscObject)pc)->prefix,"-pc_fieldsplit_default",&fieldsplit_default,NULL);CHKERRQ(ierr);
4417287d2a3SDmitry Karpeev         if (!fieldsplit_default) {
442d32f9abdSBarry Smith           /* Allow user to set fields from command line,  if bs was known at the time of PCSetFromOptions_FieldSplit()
443d32f9abdSBarry Smith            then it is set there. This is not ideal because we should only have options set in XXSetFromOptions(). */
4446c924f48SJed Brown           ierr = PCFieldSplitSetRuntimeSplits_Private(pc);CHKERRQ(ierr);
4456c924f48SJed Brown           if (jac->splitdefined) {ierr = PetscInfo(pc,"Splits defined using the options database\n");CHKERRQ(ierr);}
446d32f9abdSBarry Smith         }
4476dbb499eSCian Wilson         if ((fieldsplit_default || !jac->splitdefined) && !jac->isrestrict) {
448d32f9abdSBarry Smith           ierr = PetscInfo(pc,"Using default splitting of fields\n");CHKERRQ(ierr);
449db4c96c1SJed Brown           for (i=0; i<jac->bs; i++) {
4506c924f48SJed Brown             char splitname[8];
4518caf3d72SBarry Smith             ierr = PetscSNPrintf(splitname,sizeof(splitname),"%D",i);CHKERRQ(ierr);
4525d4c12cdSJungho Lee             ierr = PCFieldSplitSetFields(pc,splitname,1,&i,&i);CHKERRQ(ierr);
45379416396SBarry Smith           }
4545d4c12cdSJungho Lee           jac->defaultsplit = PETSC_TRUE;
455521d7252SBarry Smith         }
45666ffff09SJed Brown       }
4576ce1633cSBarry Smith     }
458edf189efSBarry Smith   } else if (jac->nsplits == 1) {
459edf189efSBarry Smith     if (ilink->is) {
460edf189efSBarry Smith       IS       is2;
461edf189efSBarry Smith       PetscInt nmin,nmax;
462edf189efSBarry Smith 
463edf189efSBarry Smith       ierr = MatGetOwnershipRange(pc->mat,&nmin,&nmax);CHKERRQ(ierr);
464edf189efSBarry Smith       ierr = ISComplement(ilink->is,nmin,nmax,&is2);CHKERRQ(ierr);
465db4c96c1SJed Brown       ierr = PCFieldSplitSetIS(pc,"1",is2);CHKERRQ(ierr);
466fcfd50ebSBarry Smith       ierr = ISDestroy(&is2);CHKERRQ(ierr);
46782f516ccSBarry Smith     } else SETERRQ(PetscObjectComm((PetscObject)pc),PETSC_ERR_SUP,"Must provide at least two sets of fields to PCFieldSplit()");
468edf189efSBarry Smith   }
469d0af7cd3SBarry Smith 
47082f516ccSBarry Smith   if (jac->nsplits < 2) SETERRQ1(PetscObjectComm((PetscObject)pc),PETSC_ERR_PLIB,"Unhandled case, must have at least two fields, not %d", jac->nsplits);
47169a612a9SBarry Smith   PetscFunctionReturn(0);
47269a612a9SBarry Smith }
47369a612a9SBarry Smith 
474c5929fdfSBarry Smith PETSC_EXTERN PetscErrorCode PetscOptionsFindPairPrefix_Private(PetscOptions,const char pre[], const char name[], char *value[], PetscBool *flg);
475514bf10dSMatthew G Knepley 
47669a612a9SBarry Smith #undef __FUNCT__
47769a612a9SBarry Smith #define __FUNCT__ "PCSetUp_FieldSplit"
47869a612a9SBarry Smith static PetscErrorCode PCSetUp_FieldSplit(PC pc)
47969a612a9SBarry Smith {
48069a612a9SBarry Smith   PC_FieldSplit     *jac = (PC_FieldSplit*)pc->data;
48169a612a9SBarry Smith   PetscErrorCode    ierr;
4825a9f2f41SSatish Balay   PC_FieldSplitLink ilink;
4832c9966d7SBarry Smith   PetscInt          i,nsplit;
4845f4ab4e1SJungho Lee   PetscBool         sorted, sorted_col;
48569a612a9SBarry Smith 
48669a612a9SBarry Smith   PetscFunctionBegin;
48769a612a9SBarry Smith   ierr   = PCFieldSplitSetDefaults(pc);CHKERRQ(ierr);
48897bbdb24SBarry Smith   nsplit = jac->nsplits;
4895a9f2f41SSatish Balay   ilink  = jac->head;
49097bbdb24SBarry Smith 
49197bbdb24SBarry Smith   /* get the matrices for each split */
492704ba839SBarry Smith   if (!jac->issetup) {
4931b9fc7fcSBarry Smith     PetscInt rstart,rend,nslots,bs;
49497bbdb24SBarry Smith 
495704ba839SBarry Smith     jac->issetup = PETSC_TRUE;
496704ba839SBarry Smith 
4975d4c12cdSJungho Lee     /* This is done here instead of in PCFieldSplitSetFields() because may not have matrix at that point */
4982c9966d7SBarry Smith     if (jac->defaultsplit || !ilink->is) {
4992c9966d7SBarry Smith       if (jac->bs <= 0) jac->bs = nsplit;
5002c9966d7SBarry Smith     }
50151f519a2SBarry Smith     bs     = jac->bs;
50297bbdb24SBarry Smith     ierr   = MatGetOwnershipRange(pc->pmat,&rstart,&rend);CHKERRQ(ierr);
5031b9fc7fcSBarry Smith     nslots = (rend - rstart)/bs;
5041b9fc7fcSBarry Smith     for (i=0; i<nsplit; i++) {
5051b9fc7fcSBarry Smith       if (jac->defaultsplit) {
506ce94432eSBarry Smith         ierr = ISCreateStride(PetscObjectComm((PetscObject)pc),nslots,rstart+i,nsplit,&ilink->is);CHKERRQ(ierr);
5075f4ab4e1SJungho Lee         ierr = ISDuplicate(ilink->is,&ilink->is_col);CHKERRQ(ierr);
508704ba839SBarry Smith       } else if (!ilink->is) {
509ccb205f8SBarry Smith         if (ilink->nfields > 1) {
5105f4ab4e1SJungho Lee           PetscInt *ii,*jj,j,k,nfields = ilink->nfields,*fields = ilink->fields,*fields_col = ilink->fields_col;
511785e854fSJed Brown           ierr = PetscMalloc1(ilink->nfields*nslots,&ii);CHKERRQ(ierr);
512785e854fSJed Brown           ierr = PetscMalloc1(ilink->nfields*nslots,&jj);CHKERRQ(ierr);
5131b9fc7fcSBarry Smith           for (j=0; j<nslots; j++) {
5141b9fc7fcSBarry Smith             for (k=0; k<nfields; k++) {
5151b9fc7fcSBarry Smith               ii[nfields*j + k] = rstart + bs*j + fields[k];
5165f4ab4e1SJungho Lee               jj[nfields*j + k] = rstart + bs*j + fields_col[k];
51797bbdb24SBarry Smith             }
51897bbdb24SBarry Smith           }
519ce94432eSBarry Smith           ierr = ISCreateGeneral(PetscObjectComm((PetscObject)pc),nslots*nfields,ii,PETSC_OWN_POINTER,&ilink->is);CHKERRQ(ierr);
520ce94432eSBarry Smith           ierr = ISCreateGeneral(PetscObjectComm((PetscObject)pc),nslots*nfields,jj,PETSC_OWN_POINTER,&ilink->is_col);CHKERRQ(ierr);
52190e68f20SPatrick Farrell           ierr = ISSetBlockSize(ilink->is, nfields);CHKERRQ(ierr);
52290e68f20SPatrick Farrell           ierr = ISSetBlockSize(ilink->is_col, nfields);CHKERRQ(ierr);
523ccb205f8SBarry Smith         } else {
524ce94432eSBarry Smith           ierr = ISCreateStride(PetscObjectComm((PetscObject)pc),nslots,rstart+ilink->fields[0],bs,&ilink->is);CHKERRQ(ierr);
525ce94432eSBarry Smith           ierr = ISCreateStride(PetscObjectComm((PetscObject)pc),nslots,rstart+ilink->fields_col[0],bs,&ilink->is_col);CHKERRQ(ierr);
526ccb205f8SBarry Smith        }
5273e197d65SBarry Smith       }
528704ba839SBarry Smith       ierr = ISSorted(ilink->is,&sorted);CHKERRQ(ierr);
5295f4ab4e1SJungho Lee       if (ilink->is_col) { ierr = ISSorted(ilink->is_col,&sorted_col);CHKERRQ(ierr); }
5305f4ab4e1SJungho Lee       if (!sorted || !sorted_col) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_USER,"Fields must be sorted when creating split");
531704ba839SBarry Smith       ilink = ilink->next;
5321b9fc7fcSBarry Smith     }
5331b9fc7fcSBarry Smith   }
5341b9fc7fcSBarry Smith 
535704ba839SBarry Smith   ilink = jac->head;
53697bbdb24SBarry Smith   if (!jac->pmat) {
537bdddcaaaSMatthew G Knepley     Vec xtmp;
538bdddcaaaSMatthew G Knepley 
5392a7a6963SBarry Smith     ierr = MatCreateVecs(pc->pmat,&xtmp,NULL);CHKERRQ(ierr);
540785e854fSJed Brown     ierr = PetscMalloc1(nsplit,&jac->pmat);CHKERRQ(ierr);
541dcca6d9dSJed Brown     ierr = PetscMalloc2(nsplit,&jac->x,nsplit,&jac->y);CHKERRQ(ierr);
542cf502942SBarry Smith     for (i=0; i<nsplit; i++) {
543bdddcaaaSMatthew G Knepley       MatNullSpace sp;
544bdddcaaaSMatthew G Knepley 
545a3df900dSMatthew G Knepley       /* Check for preconditioning matrix attached to IS */
546a3df900dSMatthew G Knepley       ierr = PetscObjectQuery((PetscObject) ilink->is, "pmat", (PetscObject*) &jac->pmat[i]);CHKERRQ(ierr);
547a3df900dSMatthew G Knepley       if (jac->pmat[i]) {
548a3df900dSMatthew G Knepley         ierr = PetscObjectReference((PetscObject) jac->pmat[i]);CHKERRQ(ierr);
549a3df900dSMatthew G Knepley         if (jac->type == PC_COMPOSITE_SCHUR) {
550a3df900dSMatthew G Knepley           jac->schur_user = jac->pmat[i];
5512fa5cd67SKarl Rupp 
552a3df900dSMatthew G Knepley           ierr = PetscObjectReference((PetscObject) jac->schur_user);CHKERRQ(ierr);
553a3df900dSMatthew G Knepley         }
554a3df900dSMatthew G Knepley       } else {
5553a062f41SBarry Smith         const char *prefix;
5565f4ab4e1SJungho Lee         ierr = MatGetSubMatrix(pc->pmat,ilink->is,ilink->is_col,MAT_INITIAL_MATRIX,&jac->pmat[i]);CHKERRQ(ierr);
5573a062f41SBarry Smith         ierr = KSPGetOptionsPrefix(ilink->ksp,&prefix);CHKERRQ(ierr);
5583a062f41SBarry Smith         ierr = MatSetOptionsPrefix(jac->pmat[i],prefix);CHKERRQ(ierr);
5593a062f41SBarry Smith         ierr = MatViewFromOptions(jac->pmat[i],NULL,"-mat_view");CHKERRQ(ierr);
560a3df900dSMatthew G Knepley       }
561bdddcaaaSMatthew G Knepley       /* create work vectors for each split */
5622a7a6963SBarry Smith       ierr     = MatCreateVecs(jac->pmat[i],&jac->x[i],&jac->y[i]);CHKERRQ(ierr);
5630298fd71SBarry Smith       ilink->x = jac->x[i]; ilink->y = jac->y[i]; ilink->z = NULL;
564bdddcaaaSMatthew G Knepley       /* compute scatter contexts needed by multiplicative versions and non-default splits */
5650298fd71SBarry Smith       ierr = VecScatterCreate(xtmp,ilink->is,jac->x[i],NULL,&ilink->sctx);CHKERRQ(ierr);
566ed1f0337SMatthew G Knepley       ierr = PetscObjectQuery((PetscObject) ilink->is, "nearnullspace", (PetscObject*) &sp);CHKERRQ(ierr);
567ed1f0337SMatthew G Knepley       if (sp) {
568ed1f0337SMatthew G Knepley         ierr = MatSetNearNullSpace(jac->pmat[i], sp);CHKERRQ(ierr);
569ed1f0337SMatthew G Knepley       }
570704ba839SBarry Smith       ilink = ilink->next;
571cf502942SBarry Smith     }
572bdddcaaaSMatthew G Knepley     ierr = VecDestroy(&xtmp);CHKERRQ(ierr);
57397bbdb24SBarry Smith   } else {
574cf502942SBarry Smith     for (i=0; i<nsplit; i++) {
575a3df900dSMatthew G Knepley       Mat pmat;
576a3df900dSMatthew G Knepley 
577a3df900dSMatthew G Knepley       /* Check for preconditioning matrix attached to IS */
578a3df900dSMatthew G Knepley       ierr = PetscObjectQuery((PetscObject) ilink->is, "pmat", (PetscObject*) &pmat);CHKERRQ(ierr);
579a3df900dSMatthew G Knepley       if (!pmat) {
5805f4ab4e1SJungho Lee         ierr = MatGetSubMatrix(pc->pmat,ilink->is,ilink->is_col,MAT_REUSE_MATRIX,&jac->pmat[i]);CHKERRQ(ierr);
581a3df900dSMatthew G Knepley       }
582704ba839SBarry Smith       ilink = ilink->next;
583cf502942SBarry Smith     }
58497bbdb24SBarry Smith   }
5854e39094bSDmitry Karpeev   if (jac->diag_use_amat) {
586519d70e2SJed Brown     ilink = jac->head;
587519d70e2SJed Brown     if (!jac->mat) {
588785e854fSJed Brown       ierr = PetscMalloc1(nsplit,&jac->mat);CHKERRQ(ierr);
589519d70e2SJed Brown       for (i=0; i<nsplit; i++) {
5905f4ab4e1SJungho Lee         ierr  = MatGetSubMatrix(pc->mat,ilink->is,ilink->is_col,MAT_INITIAL_MATRIX,&jac->mat[i]);CHKERRQ(ierr);
591519d70e2SJed Brown         ilink = ilink->next;
592519d70e2SJed Brown       }
593519d70e2SJed Brown     } else {
594519d70e2SJed Brown       for (i=0; i<nsplit; i++) {
5955f4ab4e1SJungho Lee         if (jac->mat[i]) {ierr = MatGetSubMatrix(pc->mat,ilink->is,ilink->is_col,MAT_REUSE_MATRIX,&jac->mat[i]);CHKERRQ(ierr);}
596519d70e2SJed Brown         ilink = ilink->next;
597519d70e2SJed Brown       }
598519d70e2SJed Brown     }
599519d70e2SJed Brown   } else {
600519d70e2SJed Brown     jac->mat = jac->pmat;
601519d70e2SJed Brown   }
60297bbdb24SBarry Smith 
60353935eafSBarry Smith   /* Check for null space attached to IS */
60453935eafSBarry Smith   ilink = jac->head;
60553935eafSBarry Smith   for (i=0; i<nsplit; i++) {
60653935eafSBarry Smith     MatNullSpace sp;
60753935eafSBarry Smith 
60853935eafSBarry Smith     ierr = PetscObjectQuery((PetscObject) ilink->is, "nullspace", (PetscObject*) &sp);CHKERRQ(ierr);
60953935eafSBarry Smith     if (sp) {
61053935eafSBarry Smith       ierr = MatSetNullSpace(jac->mat[i], sp);CHKERRQ(ierr);
61153935eafSBarry Smith     }
61253935eafSBarry Smith     ilink = ilink->next;
61353935eafSBarry Smith   }
61453935eafSBarry Smith 
6156c8605c2SJed Brown   if (jac->type != PC_COMPOSITE_ADDITIVE  && jac->type != PC_COMPOSITE_SCHUR) {
61668dd23aaSBarry Smith     /* extract the rows of the matrix associated with each field: used for efficient computation of residual inside algorithm */
6174e39094bSDmitry Karpeev     /* FIXME: Can/should we reuse jac->mat whenever (jac->diag_use_amat) is true? */
61868dd23aaSBarry Smith     ilink = jac->head;
619e52d2c62SBarry Smith     if (nsplit == 2 && jac->type == PC_COMPOSITE_MULTIPLICATIVE) {
620e52d2c62SBarry 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 */
621e52d2c62SBarry Smith       if (!jac->Afield) {
622e52d2c62SBarry Smith         ierr = PetscCalloc1(nsplit,&jac->Afield);CHKERRQ(ierr);
623*80c96bb1SFande Kong         if (jac->offdiag_use_amat) {
624e52d2c62SBarry Smith           ierr  = MatGetSubMatrix(pc->mat,ilink->next->is,ilink->is,MAT_INITIAL_MATRIX,&jac->Afield[1]);CHKERRQ(ierr);
625e52d2c62SBarry Smith         } else {
626*80c96bb1SFande Kong           ierr  = MatGetSubMatrix(pc->pmat,ilink->next->is,ilink->is,MAT_INITIAL_MATRIX,&jac->Afield[1]);CHKERRQ(ierr);
627*80c96bb1SFande Kong         }
628*80c96bb1SFande Kong       } else {
629*80c96bb1SFande Kong         if (jac->offdiag_use_amat) {
630e52d2c62SBarry Smith           ierr  = MatGetSubMatrix(pc->mat,ilink->next->is,ilink->is,MAT_REUSE_MATRIX,&jac->Afield[1]);CHKERRQ(ierr);
631*80c96bb1SFande Kong         } else {
632*80c96bb1SFande Kong           ierr  = MatGetSubMatrix(pc->pmat,ilink->next->is,ilink->is,MAT_REUSE_MATRIX,&jac->Afield[1]);CHKERRQ(ierr);
633*80c96bb1SFande Kong         }
634e52d2c62SBarry Smith       }
635e52d2c62SBarry Smith     } else {
63668dd23aaSBarry Smith       if (!jac->Afield) {
637785e854fSJed Brown         ierr = PetscMalloc1(nsplit,&jac->Afield);CHKERRQ(ierr);
63868dd23aaSBarry Smith         for (i=0; i<nsplit; i++) {
639*80c96bb1SFande Kong           if (jac->offdiag_use_amat) {
6400298fd71SBarry Smith             ierr  = MatGetSubMatrix(pc->mat,ilink->is,NULL,MAT_INITIAL_MATRIX,&jac->Afield[i]);CHKERRQ(ierr);
641*80c96bb1SFande Kong           } else {
642*80c96bb1SFande Kong             ierr  = MatGetSubMatrix(pc->pmat,ilink->is,NULL,MAT_INITIAL_MATRIX,&jac->Afield[i]);CHKERRQ(ierr);
643*80c96bb1SFande Kong           }
64468dd23aaSBarry Smith           ilink = ilink->next;
64568dd23aaSBarry Smith         }
64668dd23aaSBarry Smith       } else {
64768dd23aaSBarry Smith         for (i=0; i<nsplit; i++) {
648*80c96bb1SFande Kong           if (jac->offdiag_use_amat) {
6490298fd71SBarry Smith             ierr  = MatGetSubMatrix(pc->mat,ilink->is,NULL,MAT_REUSE_MATRIX,&jac->Afield[i]);CHKERRQ(ierr);
650*80c96bb1SFande Kong           } else {
651*80c96bb1SFande Kong             ierr  = MatGetSubMatrix(pc->pmat,ilink->is,NULL,MAT_REUSE_MATRIX,&jac->Afield[i]);CHKERRQ(ierr);
652*80c96bb1SFande Kong           }
65368dd23aaSBarry Smith           ilink = ilink->next;
65468dd23aaSBarry Smith         }
65568dd23aaSBarry Smith       }
65668dd23aaSBarry Smith     }
657e52d2c62SBarry Smith   }
65868dd23aaSBarry Smith 
6593b224e63SBarry Smith   if (jac->type == PC_COMPOSITE_SCHUR) {
6603b224e63SBarry Smith     IS          ccis;
6614aa3045dSJed Brown     PetscInt    rstart,rend;
662093c86ffSJed Brown     char        lscname[256];
663093c86ffSJed Brown     PetscObject LSC_L;
664ce94432eSBarry Smith 
665ce94432eSBarry Smith     if (nsplit != 2) SETERRQ(PetscObjectComm((PetscObject)pc),PETSC_ERR_ARG_INCOMP,"To use Schur complement preconditioner you must have exactly 2 fields");
66668dd23aaSBarry Smith 
667e6cab6aaSJed Brown     /* When extracting off-diagonal submatrices, we take complements from this range */
668e6cab6aaSJed Brown     ierr = MatGetOwnershipRangeColumn(pc->mat,&rstart,&rend);CHKERRQ(ierr);
669e6cab6aaSJed Brown 
6703b224e63SBarry Smith     /* need to handle case when one is resetting up the preconditioner */
6713b224e63SBarry Smith     if (jac->schur) {
6720298fd71SBarry Smith       KSP kspA = jac->head->ksp, kspInner = NULL, kspUpper = jac->kspupper;
673443836d0SMatthew G Knepley 
674fb3147dbSMatthew G Knepley       ierr  = MatSchurComplementGetKSP(jac->schur, &kspInner);CHKERRQ(ierr);
6753b224e63SBarry Smith       ilink = jac->head;
67649bb4cd7SJungho Lee       ierr  = ISComplement(ilink->is_col,rstart,rend,&ccis);CHKERRQ(ierr);
6774e39094bSDmitry Karpeev       if (jac->offdiag_use_amat) {
6784aa3045dSJed Brown 	ierr  = MatGetSubMatrix(pc->mat,ilink->is,ccis,MAT_REUSE_MATRIX,&jac->B);CHKERRQ(ierr);
679c84da90fSDmitry Karpeev       } else {
680df06c9e3SDmitry Karpeev 	ierr  = MatGetSubMatrix(pc->pmat,ilink->is,ccis,MAT_REUSE_MATRIX,&jac->B);CHKERRQ(ierr);
681c84da90fSDmitry Karpeev       }
682fcfd50ebSBarry Smith       ierr  = ISDestroy(&ccis);CHKERRQ(ierr);
6833b224e63SBarry Smith       ilink = ilink->next;
68449bb4cd7SJungho Lee       ierr  = ISComplement(ilink->is_col,rstart,rend,&ccis);CHKERRQ(ierr);
6854e39094bSDmitry Karpeev       if (jac->offdiag_use_amat) {
6864aa3045dSJed Brown 	ierr  = MatGetSubMatrix(pc->mat,ilink->is,ccis,MAT_REUSE_MATRIX,&jac->C);CHKERRQ(ierr);
687c84da90fSDmitry Karpeev       } else {
688df06c9e3SDmitry Karpeev 	ierr  = MatGetSubMatrix(pc->pmat,ilink->is,ccis,MAT_REUSE_MATRIX,&jac->C);CHKERRQ(ierr);
689c84da90fSDmitry Karpeev       }
690fcfd50ebSBarry Smith       ierr  = ISDestroy(&ccis);CHKERRQ(ierr);
691aa6c7ce3SBarry Smith       ierr  = MatSchurComplementUpdateSubMatrices(jac->schur,jac->mat[0],jac->pmat[0],jac->B,jac->C,jac->mat[1]);CHKERRQ(ierr);
692a7476a74SDmitry Karpeev       if (jac->schurpre == PC_FIELDSPLIT_SCHUR_PRE_SELFP) {
693a7476a74SDmitry Karpeev 	ierr = MatDestroy(&jac->schurp);CHKERRQ(ierr);
694a7476a74SDmitry Karpeev 	ierr = MatSchurComplementGetPmat(jac->schur,MAT_INITIAL_MATRIX,&jac->schurp);CHKERRQ(ierr);
695a7476a74SDmitry Karpeev       }
696443836d0SMatthew G Knepley       if (kspA != kspInner) {
69723ee1639SBarry Smith         ierr = KSPSetOperators(kspA,jac->mat[0],jac->pmat[0]);CHKERRQ(ierr);
698443836d0SMatthew G Knepley       }
699443836d0SMatthew G Knepley       if (kspUpper != kspA) {
70023ee1639SBarry Smith         ierr = KSPSetOperators(kspUpper,jac->mat[0],jac->pmat[0]);CHKERRQ(ierr);
701443836d0SMatthew G Knepley       }
70223ee1639SBarry Smith       ierr = KSPSetOperators(jac->kspschur,jac->schur,FieldSplitSchurPre(jac));CHKERRQ(ierr);
7033b224e63SBarry Smith     } else {
704bafc1b83SMatthew G Knepley       const char   *Dprefix;
705470b340bSDmitry Karpeev       char         schurprefix[256], schurmatprefix[256];
706514bf10dSMatthew G Knepley       char         schurtestoption[256];
707bdddcaaaSMatthew G Knepley       MatNullSpace sp;
708514bf10dSMatthew G Knepley       PetscBool    flg;
7093b224e63SBarry Smith 
710a04f6461SBarry Smith       /* extract the A01 and A10 matrices */
7113b224e63SBarry Smith       ilink = jac->head;
71249bb4cd7SJungho Lee       ierr  = ISComplement(ilink->is_col,rstart,rend,&ccis);CHKERRQ(ierr);
7134e39094bSDmitry Karpeev       if (jac->offdiag_use_amat) {
7144aa3045dSJed Brown 	ierr  = MatGetSubMatrix(pc->mat,ilink->is,ccis,MAT_INITIAL_MATRIX,&jac->B);CHKERRQ(ierr);
715c84da90fSDmitry Karpeev       } else {
716df06c9e3SDmitry Karpeev 	ierr  = MatGetSubMatrix(pc->pmat,ilink->is,ccis,MAT_INITIAL_MATRIX,&jac->B);CHKERRQ(ierr);
717c84da90fSDmitry Karpeev       }
718fcfd50ebSBarry Smith       ierr  = ISDestroy(&ccis);CHKERRQ(ierr);
7193b224e63SBarry Smith       ilink = ilink->next;
72049bb4cd7SJungho Lee       ierr  = ISComplement(ilink->is_col,rstart,rend,&ccis);CHKERRQ(ierr);
7214e39094bSDmitry Karpeev       if (jac->offdiag_use_amat) {
7224aa3045dSJed Brown 	ierr  = MatGetSubMatrix(pc->mat,ilink->is,ccis,MAT_INITIAL_MATRIX,&jac->C);CHKERRQ(ierr);
723c84da90fSDmitry Karpeev       } else {
724df06c9e3SDmitry Karpeev 	ierr  = MatGetSubMatrix(pc->pmat,ilink->is,ccis,MAT_INITIAL_MATRIX,&jac->C);CHKERRQ(ierr);
725c84da90fSDmitry Karpeev       }
726fcfd50ebSBarry Smith       ierr  = ISDestroy(&ccis);CHKERRQ(ierr);
72720252d06SBarry Smith 
728f5236f50SJed Brown       /* Use mat[0] (diagonal block of Amat) preconditioned by pmat[0] to define Schur complement */
72920252d06SBarry Smith       ierr = MatCreate(((PetscObject)jac->mat[0])->comm,&jac->schur);CHKERRQ(ierr);
73020252d06SBarry Smith       ierr = MatSetType(jac->schur,MATSCHURCOMPLEMENT);CHKERRQ(ierr);
731bee83525SDmitry Karpeev       ierr = MatSchurComplementSetSubMatrices(jac->schur,jac->mat[0],jac->pmat[0],jac->B,jac->C,jac->mat[1]);CHKERRQ(ierr);
732470b340bSDmitry Karpeev       ierr = PetscSNPrintf(schurmatprefix, sizeof(schurmatprefix), "%sfieldsplit_%s_", ((PetscObject)pc)->prefix ? ((PetscObject)pc)->prefix : "", ilink->splitname);CHKERRQ(ierr);
733470b340bSDmitry 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? */
734470b340bSDmitry Karpeev       ierr = MatSetOptionsPrefix(jac->schur,schurmatprefix);CHKERRQ(ierr);
735470b340bSDmitry Karpeev       ierr = MatSetFromOptions(jac->schur);CHKERRQ(ierr);
736895c21f2SBarry Smith       ierr = MatGetNullSpace(jac->mat[1], &sp);CHKERRQ(ierr);
73720252d06SBarry Smith       if (sp) {
73820252d06SBarry Smith         ierr = MatSetNullSpace(jac->schur, sp);CHKERRQ(ierr);
73920252d06SBarry Smith       }
74020252d06SBarry Smith 
74120252d06SBarry Smith       ierr = PetscSNPrintf(schurtestoption, sizeof(schurtestoption), "-fieldsplit_%s_inner_", ilink->splitname);CHKERRQ(ierr);
742c5929fdfSBarry Smith       ierr = PetscOptionsFindPairPrefix_Private(((PetscObject)pc)->options,((PetscObject)pc)->prefix, schurtestoption, NULL, &flg);CHKERRQ(ierr);
743514bf10dSMatthew G Knepley       if (flg) {
744514bf10dSMatthew G Knepley         DM  dmInner;
74521635b76SJed Brown         KSP kspInner;
74621635b76SJed Brown 
74721635b76SJed Brown         ierr = MatSchurComplementGetKSP(jac->schur, &kspInner);CHKERRQ(ierr);
74821635b76SJed Brown         ierr = PetscSNPrintf(schurprefix, sizeof(schurprefix), "%sfieldsplit_%s_inner_", ((PetscObject)pc)->prefix ? ((PetscObject)pc)->prefix : "", ilink->splitname);CHKERRQ(ierr);
74921635b76SJed Brown         /* Indent this deeper to emphasize the "inner" nature of this solver. */
75021635b76SJed Brown         ierr = PetscObjectIncrementTabLevel((PetscObject)kspInner, (PetscObject) pc, 2);CHKERRQ(ierr);
75121635b76SJed Brown         ierr = KSPSetOptionsPrefix(kspInner, schurprefix);CHKERRQ(ierr);
752514bf10dSMatthew G Knepley 
753514bf10dSMatthew G Knepley         /* Set DM for new solver */
754bafc1b83SMatthew G Knepley         ierr = KSPGetDM(jac->head->ksp, &dmInner);CHKERRQ(ierr);
75521635b76SJed Brown         ierr = KSPSetDM(kspInner, dmInner);CHKERRQ(ierr);
75621635b76SJed Brown         ierr = KSPSetDMActive(kspInner, PETSC_FALSE);CHKERRQ(ierr);
757514bf10dSMatthew G Knepley       } else {
75821635b76SJed Brown          /* Use the outer solver for the inner solve, but revert the KSPPREONLY from PCFieldSplitSetFields_FieldSplit or
75921635b76SJed Brown           * PCFieldSplitSetIS_FieldSplit. We don't want KSPPREONLY because it makes the Schur complement inexact,
76021635b76SJed Brown           * preventing Schur complement reduction to be an accurate solve. Usually when an iterative solver is used for
76121635b76SJed 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
76221635b76SJed Brown           * GMRES the default. Note that it is also common to use PREONLY for S, in which case S may not be used
76321635b76SJed Brown           * directly, and the user is responsible for setting an inexact method for fieldsplit's A^{-1}. */
76421635b76SJed Brown         ierr = KSPSetType(jac->head->ksp,KSPGMRES);CHKERRQ(ierr);
765514bf10dSMatthew G Knepley         ierr = MatSchurComplementSetKSP(jac->schur,jac->head->ksp);CHKERRQ(ierr);
766bafc1b83SMatthew G Knepley       }
76723ee1639SBarry Smith       ierr = KSPSetOperators(jac->head->ksp,jac->mat[0],jac->pmat[0]);CHKERRQ(ierr);
7685a9f2f41SSatish Balay       ierr = KSPSetFromOptions(jac->head->ksp);CHKERRQ(ierr);
76997bbdb24SBarry Smith       ierr = MatSetFromOptions(jac->schur);CHKERRQ(ierr);
77097bbdb24SBarry Smith 
771443836d0SMatthew G Knepley       ierr = PetscSNPrintf(schurtestoption, sizeof(schurtestoption), "-fieldsplit_%s_upper_", ilink->splitname);CHKERRQ(ierr);
772c5929fdfSBarry Smith       ierr = PetscOptionsFindPairPrefix_Private(((PetscObject)pc)->options,((PetscObject)pc)->prefix, schurtestoption, NULL, &flg);CHKERRQ(ierr);
773443836d0SMatthew G Knepley       if (flg) {
774443836d0SMatthew G Knepley         DM dmInner;
775443836d0SMatthew G Knepley 
776443836d0SMatthew G Knepley         ierr = PetscSNPrintf(schurprefix, sizeof(schurprefix), "%sfieldsplit_%s_upper_", ((PetscObject)pc)->prefix ? ((PetscObject)pc)->prefix : "", ilink->splitname);CHKERRQ(ierr);
77782f516ccSBarry Smith         ierr = KSPCreate(PetscObjectComm((PetscObject)pc), &jac->kspupper);CHKERRQ(ierr);
778422a814eSBarry Smith         ierr = KSPSetErrorIfNotConverged(jac->kspupper,pc->erroriffailure);CHKERRQ(ierr);
779443836d0SMatthew G Knepley         ierr = KSPSetOptionsPrefix(jac->kspupper, schurprefix);CHKERRQ(ierr);
780443836d0SMatthew G Knepley         ierr = KSPGetDM(jac->head->ksp, &dmInner);CHKERRQ(ierr);
781443836d0SMatthew G Knepley         ierr = KSPSetDM(jac->kspupper, dmInner);CHKERRQ(ierr);
782443836d0SMatthew G Knepley         ierr = KSPSetDMActive(jac->kspupper, PETSC_FALSE);CHKERRQ(ierr);
783443836d0SMatthew G Knepley         ierr = KSPSetFromOptions(jac->kspupper);CHKERRQ(ierr);
78423ee1639SBarry Smith         ierr = KSPSetOperators(jac->kspupper,jac->mat[0],jac->pmat[0]);CHKERRQ(ierr);
785443836d0SMatthew G Knepley         ierr = VecDuplicate(jac->head->x, &jac->head->z);CHKERRQ(ierr);
786443836d0SMatthew G Knepley       } else {
787443836d0SMatthew G Knepley         jac->kspupper = jac->head->ksp;
788443836d0SMatthew G Knepley         ierr          = PetscObjectReference((PetscObject) jac->head->ksp);CHKERRQ(ierr);
789443836d0SMatthew G Knepley       }
790443836d0SMatthew G Knepley 
791a7476a74SDmitry Karpeev       if (jac->schurpre == PC_FIELDSPLIT_SCHUR_PRE_SELFP) {
792a7476a74SDmitry Karpeev 	ierr = MatSchurComplementGetPmat(jac->schur,MAT_INITIAL_MATRIX,&jac->schurp);CHKERRQ(ierr);
793a7476a74SDmitry Karpeev       }
794ce94432eSBarry Smith       ierr = KSPCreate(PetscObjectComm((PetscObject)pc),&jac->kspschur);CHKERRQ(ierr);
795422a814eSBarry Smith       ierr = KSPSetErrorIfNotConverged(jac->kspschur,pc->erroriffailure);CHKERRQ(ierr);
79697bbdb24SBarry Smith       ierr = PetscLogObjectParent((PetscObject)pc,(PetscObject)jac->kspschur);CHKERRQ(ierr);
79720252d06SBarry Smith       ierr = PetscObjectIncrementTabLevel((PetscObject)jac->kspschur,(PetscObject)pc,1);CHKERRQ(ierr);
79897bbdb24SBarry Smith       if (jac->schurpre == PC_FIELDSPLIT_SCHUR_PRE_SELF) {
7997233a360SDmitry Karpeev         PC pcschur;
8007233a360SDmitry Karpeev         ierr = KSPGetPC(jac->kspschur,&pcschur);CHKERRQ(ierr);
8017233a360SDmitry Karpeev         ierr = PCSetType(pcschur,PCNONE);CHKERRQ(ierr);
80297bbdb24SBarry Smith         /* Note: This is bad if there exist preconditioners for MATSCHURCOMPLEMENT */
803e74569cdSMatthew G. Knepley       } else if (jac->schurpre == PC_FIELDSPLIT_SCHUR_PRE_FULL) {
804e74569cdSMatthew G. Knepley         ierr = MatSchurComplementComputeExplicitOperator(jac->schur, &jac->schur_user);CHKERRQ(ierr);
80597bbdb24SBarry Smith       }
80623ee1639SBarry Smith       ierr = KSPSetOperators(jac->kspschur,jac->schur,FieldSplitSchurPre(jac));CHKERRQ(ierr);
80797bbdb24SBarry Smith       ierr = KSPGetOptionsPrefix(jac->head->next->ksp, &Dprefix);CHKERRQ(ierr);
80897bbdb24SBarry Smith       ierr = KSPSetOptionsPrefix(jac->kspschur,         Dprefix);CHKERRQ(ierr);
809b20b4189SMatthew G. Knepley       /* propogate DM */
810b20b4189SMatthew G. Knepley       {
811b20b4189SMatthew G. Knepley         DM sdm;
812b20b4189SMatthew G. Knepley         ierr = KSPGetDM(jac->head->next->ksp, &sdm);CHKERRQ(ierr);
813b20b4189SMatthew G. Knepley         if (sdm) {
814b20b4189SMatthew G. Knepley           ierr = KSPSetDM(jac->kspschur, sdm);CHKERRQ(ierr);
815b20b4189SMatthew G. Knepley           ierr = KSPSetDMActive(jac->kspschur, PETSC_FALSE);CHKERRQ(ierr);
816b20b4189SMatthew G. Knepley         }
817b20b4189SMatthew G. Knepley       }
81897bbdb24SBarry Smith       /* really want setfromoptions called in PCSetFromOptions_FieldSplit(), but it is not ready yet */
81997bbdb24SBarry Smith       /* need to call this every time, since the jac->kspschur is freshly created, otherwise its options never get set */
82097bbdb24SBarry Smith       ierr = KSPSetFromOptions(jac->kspschur);CHKERRQ(ierr);
82197bbdb24SBarry Smith     }
82297bbdb24SBarry Smith 
8235a9f2f41SSatish Balay     /* HACK: special support to forward L and Lp matrices that might be used by PCLSC */
8248caf3d72SBarry Smith     ierr = PetscSNPrintf(lscname,sizeof(lscname),"%s_LSC_L",ilink->splitname);CHKERRQ(ierr);
825519d70e2SJed Brown     ierr = PetscObjectQuery((PetscObject)pc->mat,lscname,(PetscObject*)&LSC_L);CHKERRQ(ierr);
8263b224e63SBarry Smith     if (!LSC_L) {ierr = PetscObjectQuery((PetscObject)pc->pmat,lscname,(PetscObject*)&LSC_L);CHKERRQ(ierr);}
827c1570756SJed Brown     if (LSC_L) {ierr = PetscObjectCompose((PetscObject)jac->schur,"LSC_L",(PetscObject)LSC_L);CHKERRQ(ierr);}
8288caf3d72SBarry Smith     ierr = PetscSNPrintf(lscname,sizeof(lscname),"%s_LSC_Lp",ilink->splitname);CHKERRQ(ierr);
82997bbdb24SBarry Smith     ierr = PetscObjectQuery((PetscObject)pc->pmat,lscname,(PetscObject*)&LSC_L);CHKERRQ(ierr);
8305a9f2f41SSatish Balay     if (!LSC_L) {ierr = PetscObjectQuery((PetscObject)pc->mat,lscname,(PetscObject*)&LSC_L);CHKERRQ(ierr);}
8310971522cSBarry Smith     if (LSC_L) {ierr = PetscObjectCompose((PetscObject)jac->schur,"LSC_Lp",(PetscObject)LSC_L);CHKERRQ(ierr);}
83297bbdb24SBarry Smith   } else {
83368bd789dSDmitry Karpeev     /* set up the individual splits' PCs */
8340971522cSBarry Smith     i     = 0;
8350971522cSBarry Smith     ilink = jac->head;
8360971522cSBarry Smith     while (ilink) {
83723ee1639SBarry Smith       ierr = KSPSetOperators(ilink->ksp,jac->mat[i],jac->pmat[i]);CHKERRQ(ierr);
8380971522cSBarry Smith       /* really want setfromoptions called in PCSetFromOptions_FieldSplit(), but it is not ready yet */
8390971522cSBarry Smith       if (!jac->suboptionsset) {ierr = KSPSetFromOptions(ilink->ksp);CHKERRQ(ierr);}
8400971522cSBarry Smith       i++;
8410971522cSBarry Smith       ilink = ilink->next;
8420971522cSBarry Smith     }
8433b224e63SBarry Smith   }
8443b224e63SBarry Smith 
845c1570756SJed Brown   jac->suboptionsset = PETSC_TRUE;
8460971522cSBarry Smith   PetscFunctionReturn(0);
8470971522cSBarry Smith }
8480971522cSBarry Smith 
8495a9f2f41SSatish Balay #define FieldSplitSplitSolveAdd(ilink,xx,yy) \
850ca9f406cSSatish Balay   (VecScatterBegin(ilink->sctx,xx,ilink->x,INSERT_VALUES,SCATTER_FORWARD) || \
851ca9f406cSSatish Balay    VecScatterEnd(ilink->sctx,xx,ilink->x,INSERT_VALUES,SCATTER_FORWARD) || \
8529df09d43SBarry Smith    PetscLogEventBegin(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL) ||\
8535a9f2f41SSatish Balay    KSPSolve(ilink->ksp,ilink->x,ilink->y) ||                               \
8549df09d43SBarry Smith    PetscLogEventEnd(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL) ||\
855ca9f406cSSatish Balay    VecScatterBegin(ilink->sctx,ilink->y,yy,ADD_VALUES,SCATTER_REVERSE) ||  \
856ca9f406cSSatish Balay    VecScatterEnd(ilink->sctx,ilink->y,yy,ADD_VALUES,SCATTER_REVERSE))
85779416396SBarry Smith 
8580971522cSBarry Smith #undef __FUNCT__
8593b224e63SBarry Smith #define __FUNCT__ "PCApply_FieldSplit_Schur"
8603b224e63SBarry Smith static PetscErrorCode PCApply_FieldSplit_Schur(PC pc,Vec x,Vec y)
8613b224e63SBarry Smith {
8623b224e63SBarry Smith   PC_FieldSplit     *jac = (PC_FieldSplit*)pc->data;
8633b224e63SBarry Smith   PetscErrorCode    ierr;
8643b224e63SBarry Smith   PC_FieldSplitLink ilinkA = jac->head, ilinkD = ilinkA->next;
865443836d0SMatthew G Knepley   KSP               kspA   = ilinkA->ksp, kspLower = kspA, kspUpper = jac->kspupper;
8663b224e63SBarry Smith 
8673b224e63SBarry Smith   PetscFunctionBegin;
868c5d2311dSJed Brown   switch (jac->schurfactorization) {
869c9c6ffaaSJed Brown   case PC_FIELDSPLIT_SCHUR_FACT_DIAG:
870a04f6461SBarry Smith     /* [A00 0; 0 -S], positive definite, suitable for MINRES */
871c5d2311dSJed Brown     ierr = VecScatterBegin(ilinkA->sctx,x,ilinkA->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
872c5d2311dSJed Brown     ierr = VecScatterBegin(ilinkD->sctx,x,ilinkD->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
873c5d2311dSJed Brown     ierr = VecScatterEnd(ilinkA->sctx,x,ilinkA->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
8749df09d43SBarry Smith     ierr = PetscLogEventBegin(ilinkA->event,kspA,ilinkA->x,ilinkA->y,NULL);CHKERRQ(ierr);
875443836d0SMatthew G Knepley     ierr = KSPSolve(kspA,ilinkA->x,ilinkA->y);CHKERRQ(ierr);
8769df09d43SBarry Smith     ierr = PetscLogEventEnd(ilinkA->event,kspA,ilinkA->x,ilinkA->y,NULL);CHKERRQ(ierr);
877c5d2311dSJed Brown     ierr = VecScatterBegin(ilinkA->sctx,ilinkA->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
878c5d2311dSJed Brown     ierr = VecScatterEnd(ilinkD->sctx,x,ilinkD->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
8799df09d43SBarry Smith     ierr = PetscLogEventBegin(KSP_Solve_FS_S,jac->kspschur,ilinkD->x,ilinkD->y,NULL);CHKERRQ(ierr);
880c5d2311dSJed Brown     ierr = KSPSolve(jac->kspschur,ilinkD->x,ilinkD->y);CHKERRQ(ierr);
8819df09d43SBarry Smith     ierr = PetscLogEventEnd(KSP_Solve_FS_S,jac->kspschur,ilinkD->x,ilinkD->y,NULL);CHKERRQ(ierr);
882c5d2311dSJed Brown     ierr = VecScale(ilinkD->y,-1.);CHKERRQ(ierr);
883c5d2311dSJed Brown     ierr = VecScatterBegin(ilinkD->sctx,ilinkD->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
884c5d2311dSJed Brown     ierr = VecScatterEnd(ilinkA->sctx,ilinkA->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
885c5d2311dSJed Brown     ierr = VecScatterEnd(ilinkD->sctx,ilinkD->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
886c5d2311dSJed Brown     break;
887c9c6ffaaSJed Brown   case PC_FIELDSPLIT_SCHUR_FACT_LOWER:
888a04f6461SBarry Smith     /* [A00 0; A10 S], suitable for left preconditioning */
889c5d2311dSJed Brown     ierr = VecScatterBegin(ilinkA->sctx,x,ilinkA->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
890c5d2311dSJed Brown     ierr = VecScatterEnd(ilinkA->sctx,x,ilinkA->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
8919df09d43SBarry Smith     ierr = PetscLogEventBegin(ilinkA->event,kspA,ilinkA->x,ilinkA->y,NULL);CHKERRQ(ierr);
892443836d0SMatthew G Knepley     ierr = KSPSolve(kspA,ilinkA->x,ilinkA->y);CHKERRQ(ierr);
8939df09d43SBarry Smith     ierr = PetscLogEventEnd(ilinkA->event,kspA,ilinkA->x,ilinkA->y,NULL);CHKERRQ(ierr);
894c5d2311dSJed Brown     ierr = MatMult(jac->C,ilinkA->y,ilinkD->x);CHKERRQ(ierr);
895c5d2311dSJed Brown     ierr = VecScale(ilinkD->x,-1.);CHKERRQ(ierr);
896c5d2311dSJed Brown     ierr = VecScatterBegin(ilinkD->sctx,x,ilinkD->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
897c5d2311dSJed Brown     ierr = VecScatterBegin(ilinkA->sctx,ilinkA->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
898c5d2311dSJed Brown     ierr = VecScatterEnd(ilinkD->sctx,x,ilinkD->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
8999df09d43SBarry Smith     ierr = PetscLogEventBegin(KSP_Solve_FS_S,jac->kspschur,ilinkD->x,ilinkD->y,NULL);CHKERRQ(ierr);
900c5d2311dSJed Brown     ierr = KSPSolve(jac->kspschur,ilinkD->x,ilinkD->y);CHKERRQ(ierr);
9019df09d43SBarry Smith     ierr = PetscLogEventEnd(KSP_Solve_FS_S,jac->kspschur,ilinkD->x,ilinkD->y,NULL);CHKERRQ(ierr);
902c5d2311dSJed Brown     ierr = VecScatterBegin(ilinkD->sctx,ilinkD->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
903c5d2311dSJed Brown     ierr = VecScatterEnd(ilinkA->sctx,ilinkA->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
904c5d2311dSJed Brown     ierr = VecScatterEnd(ilinkD->sctx,ilinkD->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
905c5d2311dSJed Brown     break;
906c9c6ffaaSJed Brown   case PC_FIELDSPLIT_SCHUR_FACT_UPPER:
907a04f6461SBarry Smith     /* [A00 A01; 0 S], suitable for right preconditioning */
908c5d2311dSJed Brown     ierr = VecScatterBegin(ilinkD->sctx,x,ilinkD->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
909c5d2311dSJed Brown     ierr = VecScatterEnd(ilinkD->sctx,x,ilinkD->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
9109df09d43SBarry Smith     ierr = PetscLogEventBegin(KSP_Solve_FS_S,jac->kspschur,ilinkD->x,ilinkD->y,NULL);CHKERRQ(ierr);
911c5d2311dSJed Brown     ierr = KSPSolve(jac->kspschur,ilinkD->x,ilinkD->y);CHKERRQ(ierr);
9129df09d43SBarry 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);
913c5d2311dSJed Brown     ierr = VecScale(ilinkA->x,-1.);CHKERRQ(ierr);
914c5d2311dSJed Brown     ierr = VecScatterBegin(ilinkA->sctx,x,ilinkA->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
915c5d2311dSJed Brown     ierr = VecScatterBegin(ilinkD->sctx,ilinkD->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
916c5d2311dSJed Brown     ierr = VecScatterEnd(ilinkA->sctx,x,ilinkA->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
9179df09d43SBarry Smith     ierr = PetscLogEventBegin(ilinkA->event,kspA,ilinkA->x,ilinkA->y,NULL);CHKERRQ(ierr);
918443836d0SMatthew G Knepley     ierr = KSPSolve(kspA,ilinkA->x,ilinkA->y);CHKERRQ(ierr);
9199df09d43SBarry Smith     ierr = PetscLogEventEnd(ilinkA->event,kspA,ilinkA->x,ilinkA->y,NULL);CHKERRQ(ierr);
920c5d2311dSJed Brown     ierr = VecScatterBegin(ilinkA->sctx,ilinkA->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
921c5d2311dSJed Brown     ierr = VecScatterEnd(ilinkD->sctx,ilinkD->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
922c5d2311dSJed Brown     ierr = VecScatterEnd(ilinkA->sctx,ilinkA->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
923c5d2311dSJed Brown     break;
924c9c6ffaaSJed Brown   case PC_FIELDSPLIT_SCHUR_FACT_FULL:
925a04f6461SBarry 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 */
9263b224e63SBarry Smith     ierr = VecScatterBegin(ilinkA->sctx,x,ilinkA->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
9273b224e63SBarry Smith     ierr = VecScatterEnd(ilinkA->sctx,x,ilinkA->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
9289df09d43SBarry Smith     ierr = PetscLogEventBegin(KSP_Solve_FS_L,kspLower,ilinkA->x,ilinkA->y,NULL);CHKERRQ(ierr);
929443836d0SMatthew G Knepley     ierr = KSPSolve(kspLower,ilinkA->x,ilinkA->y);CHKERRQ(ierr);
9309df09d43SBarry Smith     ierr = PetscLogEventEnd(KSP_Solve_FS_L,kspLower,ilinkA->x,ilinkA->y,NULL);CHKERRQ(ierr);
9313b224e63SBarry Smith     ierr = MatMult(jac->C,ilinkA->y,ilinkD->x);CHKERRQ(ierr);
9323b224e63SBarry Smith     ierr = VecScale(ilinkD->x,-1.0);CHKERRQ(ierr);
9333b224e63SBarry Smith     ierr = VecScatterBegin(ilinkD->sctx,x,ilinkD->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
9343b224e63SBarry Smith     ierr = VecScatterEnd(ilinkD->sctx,x,ilinkD->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
9353b224e63SBarry Smith 
9369df09d43SBarry Smith     ierr = PetscLogEventBegin(KSP_Solve_FS_S,jac->kspschur,ilinkD->x,ilinkD->y,NULL);CHKERRQ(ierr);
9373b224e63SBarry Smith     ierr = KSPSolve(jac->kspschur,ilinkD->x,ilinkD->y);CHKERRQ(ierr);
9389df09d43SBarry Smith     ierr = PetscLogEventEnd(KSP_Solve_FS_S,jac->kspschur,ilinkD->x,ilinkD->y,NULL);CHKERRQ(ierr);
9393b224e63SBarry Smith     ierr = VecScatterBegin(ilinkD->sctx,ilinkD->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
9403b224e63SBarry Smith     ierr = VecScatterEnd(ilinkD->sctx,ilinkD->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
9413b224e63SBarry Smith 
942443836d0SMatthew G Knepley     if (kspUpper == kspA) {
9433b224e63SBarry Smith       ierr = MatMult(jac->B,ilinkD->y,ilinkA->y);CHKERRQ(ierr);
9443b224e63SBarry Smith       ierr = VecAXPY(ilinkA->x,-1.0,ilinkA->y);CHKERRQ(ierr);
9459df09d43SBarry Smith       ierr = PetscLogEventBegin(ilinkA->event,kspA,ilinkA->x,ilinkA->y,NULL);CHKERRQ(ierr);
946443836d0SMatthew G Knepley       ierr = KSPSolve(kspA,ilinkA->x,ilinkA->y);CHKERRQ(ierr);
9479df09d43SBarry Smith       ierr = PetscLogEventEnd(ilinkA->event,kspA,ilinkA->x,ilinkA->y,NULL);CHKERRQ(ierr);
948443836d0SMatthew G Knepley     } else {
9499df09d43SBarry Smith       ierr = PetscLogEventBegin(ilinkA->event,kspA,ilinkA->x,ilinkA->y,NULL);CHKERRQ(ierr);
950443836d0SMatthew G Knepley       ierr = KSPSolve(kspA,ilinkA->x,ilinkA->y);CHKERRQ(ierr);
9519df09d43SBarry Smith       ierr = PetscLogEventEnd(ilinkA->event,kspA,ilinkA->x,ilinkA->y,NULL);CHKERRQ(ierr);
952443836d0SMatthew G Knepley       ierr = MatMult(jac->B,ilinkD->y,ilinkA->x);CHKERRQ(ierr);
9539df09d43SBarry Smith       ierr = PetscLogEventBegin(KSP_Solve_FS_U,kspUpper,ilinkA->x,ilinkA->z,NULL);CHKERRQ(ierr);
954443836d0SMatthew G Knepley       ierr = KSPSolve(kspUpper,ilinkA->x,ilinkA->z);CHKERRQ(ierr);
9559df09d43SBarry Smith       ierr = PetscLogEventEnd(KSP_Solve_FS_U,kspUpper,ilinkA->x,ilinkA->z,NULL);CHKERRQ(ierr);
956443836d0SMatthew G Knepley       ierr = VecAXPY(ilinkA->y,-1.0,ilinkA->z);CHKERRQ(ierr);
957443836d0SMatthew G Knepley     }
9583b224e63SBarry Smith     ierr = VecScatterBegin(ilinkA->sctx,ilinkA->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
9593b224e63SBarry Smith     ierr = VecScatterEnd(ilinkA->sctx,ilinkA->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
960c5d2311dSJed Brown   }
9613b224e63SBarry Smith   PetscFunctionReturn(0);
9623b224e63SBarry Smith }
9633b224e63SBarry Smith 
9643b224e63SBarry Smith #undef __FUNCT__
9650971522cSBarry Smith #define __FUNCT__ "PCApply_FieldSplit"
9660971522cSBarry Smith static PetscErrorCode PCApply_FieldSplit(PC pc,Vec x,Vec y)
9670971522cSBarry Smith {
9680971522cSBarry Smith   PC_FieldSplit      *jac = (PC_FieldSplit*)pc->data;
9690971522cSBarry Smith   PetscErrorCode     ierr;
9705a9f2f41SSatish Balay   PC_FieldSplitLink  ilink = jac->head;
971939b8a20SBarry Smith   PetscInt           cnt,bs;
972568ed31eSHong Zhang   KSPConvergedReason reason;
9730971522cSBarry Smith 
9740971522cSBarry Smith   PetscFunctionBegin;
97579416396SBarry Smith   if (jac->type == PC_COMPOSITE_ADDITIVE) {
9761b9fc7fcSBarry Smith     if (jac->defaultsplit) {
977939b8a20SBarry Smith       ierr = VecGetBlockSize(x,&bs);CHKERRQ(ierr);
978ce94432eSBarry 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);
979939b8a20SBarry Smith       ierr = VecGetBlockSize(y,&bs);CHKERRQ(ierr);
980ce94432eSBarry 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);
9810971522cSBarry Smith       ierr = VecStrideGatherAll(x,jac->x,INSERT_VALUES);CHKERRQ(ierr);
9825a9f2f41SSatish Balay       while (ilink) {
9839df09d43SBarry Smith         ierr  = PetscLogEventBegin(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL);CHKERRQ(ierr);
9845a9f2f41SSatish Balay         ierr  = KSPSolve(ilink->ksp,ilink->x,ilink->y);CHKERRQ(ierr);
9859df09d43SBarry Smith         ierr  = PetscLogEventEnd(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL);CHKERRQ(ierr);
986568ed31eSHong Zhang         ierr = KSPGetConvergedReason(ilink->ksp,&reason);CHKERRQ(ierr);
987568ed31eSHong Zhang         if (reason == KSP_DIVERGED_PCSETUP_FAILED) {
988568ed31eSHong Zhang           pc->failedreason = PC_SUBPC_ERROR;
989568ed31eSHong Zhang         }
9905a9f2f41SSatish Balay         ilink = ilink->next;
9910971522cSBarry Smith       }
9920971522cSBarry Smith       ierr = VecStrideScatterAll(jac->y,y,INSERT_VALUES);CHKERRQ(ierr);
9931b9fc7fcSBarry Smith     } else {
994efb30889SBarry Smith       ierr = VecSet(y,0.0);CHKERRQ(ierr);
9955a9f2f41SSatish Balay       while (ilink) {
9965a9f2f41SSatish Balay         ierr  = FieldSplitSplitSolveAdd(ilink,x,y);CHKERRQ(ierr);
997568ed31eSHong Zhang         ierr = KSPGetConvergedReason(ilink->ksp,&reason);CHKERRQ(ierr);
998568ed31eSHong Zhang         if (reason == KSP_DIVERGED_PCSETUP_FAILED) {
999568ed31eSHong Zhang           pc->failedreason = PC_SUBPC_ERROR;
1000568ed31eSHong Zhang         }
10015a9f2f41SSatish Balay         ilink = ilink->next;
10021b9fc7fcSBarry Smith       }
10031b9fc7fcSBarry Smith     }
1004e52d2c62SBarry Smith   } else if (jac->type == PC_COMPOSITE_MULTIPLICATIVE && jac->nsplits == 2) {
1005e52d2c62SBarry Smith     ierr = VecSet(y,0.0);CHKERRQ(ierr);
1006e52d2c62SBarry Smith     /* solve on first block for first block variables */
1007e52d2c62SBarry Smith     ierr = VecScatterBegin(ilink->sctx,x,ilink->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
1008e52d2c62SBarry Smith     ierr = VecScatterEnd(ilink->sctx,x,ilink->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
10099df09d43SBarry Smith     ierr = PetscLogEventBegin(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL);CHKERRQ(ierr);
1010e52d2c62SBarry Smith     ierr = KSPSolve(ilink->ksp,ilink->x,ilink->y);CHKERRQ(ierr);
10119df09d43SBarry Smith     ierr = PetscLogEventEnd(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL);CHKERRQ(ierr);
1012568ed31eSHong Zhang     ierr = KSPGetConvergedReason(ilink->ksp,&reason);CHKERRQ(ierr);
1013568ed31eSHong Zhang     if (reason == KSP_DIVERGED_PCSETUP_FAILED) {
1014568ed31eSHong Zhang       pc->failedreason = PC_SUBPC_ERROR;
1015568ed31eSHong Zhang     }
1016e52d2c62SBarry Smith     ierr = VecScatterBegin(ilink->sctx,ilink->y,y,ADD_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
1017e52d2c62SBarry Smith     ierr = VecScatterEnd(ilink->sctx,ilink->y,y,ADD_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
1018e52d2c62SBarry Smith 
1019e52d2c62SBarry Smith     /* compute the residual only onto second block variables using first block variables */
1020e52d2c62SBarry Smith     ierr = MatMult(jac->Afield[1],ilink->y,ilink->next->x);CHKERRQ(ierr);
1021e52d2c62SBarry Smith     ilink = ilink->next;
1022e52d2c62SBarry Smith     ierr = VecScale(ilink->x,-1.0);CHKERRQ(ierr);
1023e52d2c62SBarry Smith     ierr = VecScatterBegin(ilink->sctx,x,ilink->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
1024e52d2c62SBarry Smith     ierr = VecScatterEnd(ilink->sctx,x,ilink->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
1025e52d2c62SBarry Smith 
1026e52d2c62SBarry Smith     /* solve on second block variables */
10279df09d43SBarry Smith     ierr = PetscLogEventBegin(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL);CHKERRQ(ierr);
1028e52d2c62SBarry Smith     ierr = KSPSolve(ilink->ksp,ilink->x,ilink->y);CHKERRQ(ierr);
10299df09d43SBarry Smith     ierr = PetscLogEventEnd(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL);CHKERRQ(ierr);
1030568ed31eSHong Zhang     ierr = KSPGetConvergedReason(ilink->ksp,&reason);CHKERRQ(ierr);
1031568ed31eSHong Zhang     if (reason == KSP_DIVERGED_PCSETUP_FAILED) {
1032568ed31eSHong Zhang       pc->failedreason = PC_SUBPC_ERROR;
1033568ed31eSHong Zhang     }
1034e52d2c62SBarry Smith     ierr = VecScatterBegin(ilink->sctx,ilink->y,y,ADD_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
1035e52d2c62SBarry Smith     ierr = VecScatterEnd(ilink->sctx,ilink->y,y,ADD_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
103616913363SBarry Smith   } else if (jac->type == PC_COMPOSITE_MULTIPLICATIVE || jac->type == PC_COMPOSITE_SYMMETRIC_MULTIPLICATIVE) {
103779416396SBarry Smith     if (!jac->w1) {
103879416396SBarry Smith       ierr = VecDuplicate(x,&jac->w1);CHKERRQ(ierr);
103979416396SBarry Smith       ierr = VecDuplicate(x,&jac->w2);CHKERRQ(ierr);
104079416396SBarry Smith     }
1041efb30889SBarry Smith     ierr = VecSet(y,0.0);CHKERRQ(ierr);
10425a9f2f41SSatish Balay     ierr = FieldSplitSplitSolveAdd(ilink,x,y);CHKERRQ(ierr);
1043568ed31eSHong Zhang     ierr = KSPGetConvergedReason(ilink->ksp,&reason);CHKERRQ(ierr);
1044568ed31eSHong Zhang     if (reason == KSP_DIVERGED_PCSETUP_FAILED) {
1045568ed31eSHong Zhang       pc->failedreason = PC_SUBPC_ERROR;
1046568ed31eSHong Zhang     }
10473e197d65SBarry Smith     cnt  = 1;
10485a9f2f41SSatish Balay     while (ilink->next) {
10495a9f2f41SSatish Balay       ilink = ilink->next;
10503e197d65SBarry Smith       /* compute the residual only over the part of the vector needed */
10513e197d65SBarry Smith       ierr = MatMult(jac->Afield[cnt++],y,ilink->x);CHKERRQ(ierr);
10523e197d65SBarry Smith       ierr = VecScale(ilink->x,-1.0);CHKERRQ(ierr);
10533e197d65SBarry Smith       ierr = VecScatterBegin(ilink->sctx,x,ilink->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
10543e197d65SBarry Smith       ierr = VecScatterEnd(ilink->sctx,x,ilink->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
10559df09d43SBarry Smith       ierr = PetscLogEventBegin(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL);CHKERRQ(ierr);
10563e197d65SBarry Smith       ierr = KSPSolve(ilink->ksp,ilink->x,ilink->y);CHKERRQ(ierr);
10579df09d43SBarry Smith       ierr = PetscLogEventEnd(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL);CHKERRQ(ierr);
10582618eb8fSHong Zhang       ierr = KSPGetConvergedReason(ilink->ksp,&reason);CHKERRQ(ierr);
10592618eb8fSHong Zhang       if (reason == KSP_DIVERGED_PCSETUP_FAILED) {
10602618eb8fSHong Zhang         pc->failedreason = PC_SUBPC_ERROR;
10612618eb8fSHong Zhang       }
10623e197d65SBarry Smith       ierr = VecScatterBegin(ilink->sctx,ilink->y,y,ADD_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
10633e197d65SBarry Smith       ierr = VecScatterEnd(ilink->sctx,ilink->y,y,ADD_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
10643e197d65SBarry Smith     }
106551f519a2SBarry Smith     if (jac->type == PC_COMPOSITE_SYMMETRIC_MULTIPLICATIVE) {
106611755939SBarry Smith       cnt -= 2;
106751f519a2SBarry Smith       while (ilink->previous) {
106851f519a2SBarry Smith         ilink = ilink->previous;
106911755939SBarry Smith         /* compute the residual only over the part of the vector needed */
107011755939SBarry Smith         ierr = MatMult(jac->Afield[cnt--],y,ilink->x);CHKERRQ(ierr);
107111755939SBarry Smith         ierr = VecScale(ilink->x,-1.0);CHKERRQ(ierr);
107211755939SBarry Smith         ierr = VecScatterBegin(ilink->sctx,x,ilink->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
107311755939SBarry Smith         ierr = VecScatterEnd(ilink->sctx,x,ilink->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
10749df09d43SBarry Smith         ierr = PetscLogEventBegin(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL);CHKERRQ(ierr);
107511755939SBarry Smith         ierr = KSPSolve(ilink->ksp,ilink->x,ilink->y);CHKERRQ(ierr);
10769df09d43SBarry Smith         ierr = PetscLogEventEnd(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL);CHKERRQ(ierr);
1077568ed31eSHong Zhang         ierr = KSPGetConvergedReason(ilink->ksp,&reason);CHKERRQ(ierr);
1078568ed31eSHong Zhang         if (reason == KSP_DIVERGED_PCSETUP_FAILED) {
1079568ed31eSHong Zhang           pc->failedreason = PC_SUBPC_ERROR;
1080568ed31eSHong Zhang         }
108111755939SBarry Smith         ierr = VecScatterBegin(ilink->sctx,ilink->y,y,ADD_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
108211755939SBarry Smith         ierr = VecScatterEnd(ilink->sctx,ilink->y,y,ADD_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
108351f519a2SBarry Smith       }
108411755939SBarry Smith     }
1085ce94432eSBarry Smith   } else SETERRQ1(PetscObjectComm((PetscObject)pc),PETSC_ERR_SUP,"Unsupported or unknown composition",(int) jac->type);
10860971522cSBarry Smith   PetscFunctionReturn(0);
10870971522cSBarry Smith }
10880971522cSBarry Smith 
1089421e10b8SBarry Smith #define FieldSplitSplitSolveAddTranspose(ilink,xx,yy) \
1090ca9f406cSSatish Balay   (VecScatterBegin(ilink->sctx,xx,ilink->y,INSERT_VALUES,SCATTER_FORWARD) || \
1091ca9f406cSSatish Balay    VecScatterEnd(ilink->sctx,xx,ilink->y,INSERT_VALUES,SCATTER_FORWARD) || \
10929df09d43SBarry Smith    PetscLogEventBegin(ilink->event,ilink->ksp,ilink->y,ilink->x,NULL) || \
1093421e10b8SBarry Smith    KSPSolveTranspose(ilink->ksp,ilink->y,ilink->x) ||                  \
10949df09d43SBarry Smith    PetscLogEventBegin(ilink->event,ilink->ksp,ilink->y,ilink->x,NULL) || \
1095ca9f406cSSatish Balay    VecScatterBegin(ilink->sctx,ilink->x,yy,ADD_VALUES,SCATTER_REVERSE) || \
1096ca9f406cSSatish Balay    VecScatterEnd(ilink->sctx,ilink->x,yy,ADD_VALUES,SCATTER_REVERSE))
1097421e10b8SBarry Smith 
1098421e10b8SBarry Smith #undef __FUNCT__
10998c03b21aSDmitry Karpeev #define __FUNCT__ "PCApplyTranspose_FieldSplit"
1100421e10b8SBarry Smith static PetscErrorCode PCApplyTranspose_FieldSplit(PC pc,Vec x,Vec y)
1101421e10b8SBarry Smith {
1102421e10b8SBarry Smith   PC_FieldSplit      *jac = (PC_FieldSplit*)pc->data;
1103421e10b8SBarry Smith   PetscErrorCode     ierr;
1104421e10b8SBarry Smith   PC_FieldSplitLink  ilink = jac->head;
1105939b8a20SBarry Smith   PetscInt           bs;
1106291dd214SHong Zhang   KSPConvergedReason reason;
1107421e10b8SBarry Smith 
1108421e10b8SBarry Smith   PetscFunctionBegin;
1109421e10b8SBarry Smith   if (jac->type == PC_COMPOSITE_ADDITIVE) {
1110421e10b8SBarry Smith     if (jac->defaultsplit) {
1111939b8a20SBarry Smith       ierr = VecGetBlockSize(x,&bs);CHKERRQ(ierr);
1112ce94432eSBarry 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);
1113939b8a20SBarry Smith       ierr = VecGetBlockSize(y,&bs);CHKERRQ(ierr);
1114ce94432eSBarry 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);
1115421e10b8SBarry Smith       ierr = VecStrideGatherAll(x,jac->x,INSERT_VALUES);CHKERRQ(ierr);
1116421e10b8SBarry Smith       while (ilink) {
11179df09d43SBarry Smith         ierr = PetscLogEventBegin(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL);CHKERRQ(ierr);
1118421e10b8SBarry Smith         ierr  = KSPSolveTranspose(ilink->ksp,ilink->x,ilink->y);CHKERRQ(ierr);
11199df09d43SBarry Smith         ierr = PetscLogEventEnd(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL);CHKERRQ(ierr);
11202618eb8fSHong Zhang         ierr = KSPGetConvergedReason(ilink->ksp,&reason);CHKERRQ(ierr);
11212618eb8fSHong Zhang         if (reason == KSP_DIVERGED_PCSETUP_FAILED) {
11222618eb8fSHong Zhang           pc->failedreason = PC_SUBPC_ERROR;
11232618eb8fSHong Zhang         }
1124421e10b8SBarry Smith         ilink = ilink->next;
1125421e10b8SBarry Smith       }
1126421e10b8SBarry Smith       ierr = VecStrideScatterAll(jac->y,y,INSERT_VALUES);CHKERRQ(ierr);
1127421e10b8SBarry Smith     } else {
1128421e10b8SBarry Smith       ierr = VecSet(y,0.0);CHKERRQ(ierr);
1129421e10b8SBarry Smith       while (ilink) {
1130421e10b8SBarry Smith         ierr = FieldSplitSplitSolveAddTranspose(ilink,x,y);CHKERRQ(ierr);
11312618eb8fSHong Zhang         ierr = KSPGetConvergedReason(ilink->ksp,&reason);CHKERRQ(ierr);
11322618eb8fSHong Zhang         if (reason == KSP_DIVERGED_PCSETUP_FAILED) {
11332618eb8fSHong Zhang           pc->failedreason = PC_SUBPC_ERROR;
11342618eb8fSHong Zhang         }
1135421e10b8SBarry Smith         ilink = ilink->next;
1136421e10b8SBarry Smith       }
1137421e10b8SBarry Smith     }
1138421e10b8SBarry Smith   } else {
1139421e10b8SBarry Smith     if (!jac->w1) {
1140421e10b8SBarry Smith       ierr = VecDuplicate(x,&jac->w1);CHKERRQ(ierr);
1141421e10b8SBarry Smith       ierr = VecDuplicate(x,&jac->w2);CHKERRQ(ierr);
1142421e10b8SBarry Smith     }
1143421e10b8SBarry Smith     ierr = VecSet(y,0.0);CHKERRQ(ierr);
1144421e10b8SBarry Smith     if (jac->type == PC_COMPOSITE_SYMMETRIC_MULTIPLICATIVE) {
1145421e10b8SBarry Smith       ierr = FieldSplitSplitSolveAddTranspose(ilink,x,y);CHKERRQ(ierr);
11462618eb8fSHong Zhang       ierr = KSPGetConvergedReason(ilink->ksp,&reason);CHKERRQ(ierr);
11472618eb8fSHong Zhang       if (reason == KSP_DIVERGED_PCSETUP_FAILED) {
11482618eb8fSHong Zhang         pc->failedreason = PC_SUBPC_ERROR;
11492618eb8fSHong Zhang       }
1150421e10b8SBarry Smith       while (ilink->next) {
1151421e10b8SBarry Smith         ilink = ilink->next;
11529989ab13SBarry Smith         ierr  = MatMultTranspose(pc->mat,y,jac->w1);CHKERRQ(ierr);
1153421e10b8SBarry Smith         ierr  = VecWAXPY(jac->w2,-1.0,jac->w1,x);CHKERRQ(ierr);
1154421e10b8SBarry Smith         ierr  = FieldSplitSplitSolveAddTranspose(ilink,jac->w2,y);CHKERRQ(ierr);
1155421e10b8SBarry Smith       }
1156421e10b8SBarry Smith       while (ilink->previous) {
1157421e10b8SBarry Smith         ilink = ilink->previous;
11589989ab13SBarry Smith         ierr  = MatMultTranspose(pc->mat,y,jac->w1);CHKERRQ(ierr);
1159421e10b8SBarry Smith         ierr  = VecWAXPY(jac->w2,-1.0,jac->w1,x);CHKERRQ(ierr);
1160421e10b8SBarry Smith         ierr  = FieldSplitSplitSolveAddTranspose(ilink,jac->w2,y);CHKERRQ(ierr);
1161421e10b8SBarry Smith       }
1162421e10b8SBarry Smith     } else {
1163421e10b8SBarry Smith       while (ilink->next) {   /* get to last entry in linked list */
1164421e10b8SBarry Smith         ilink = ilink->next;
1165421e10b8SBarry Smith       }
1166421e10b8SBarry Smith       ierr = FieldSplitSplitSolveAddTranspose(ilink,x,y);CHKERRQ(ierr);
11672618eb8fSHong Zhang       ierr = KSPGetConvergedReason(ilink->ksp,&reason);CHKERRQ(ierr);
11682618eb8fSHong Zhang       if (reason == KSP_DIVERGED_PCSETUP_FAILED) {
11692618eb8fSHong Zhang         pc->failedreason = PC_SUBPC_ERROR;
11702618eb8fSHong Zhang       }
1171421e10b8SBarry Smith       while (ilink->previous) {
1172421e10b8SBarry Smith         ilink = ilink->previous;
11739989ab13SBarry Smith         ierr  = MatMultTranspose(pc->mat,y,jac->w1);CHKERRQ(ierr);
1174421e10b8SBarry Smith         ierr  = VecWAXPY(jac->w2,-1.0,jac->w1,x);CHKERRQ(ierr);
1175421e10b8SBarry Smith         ierr  = FieldSplitSplitSolveAddTranspose(ilink,jac->w2,y);CHKERRQ(ierr);
1176421e10b8SBarry Smith       }
1177421e10b8SBarry Smith     }
1178421e10b8SBarry Smith   }
1179421e10b8SBarry Smith   PetscFunctionReturn(0);
1180421e10b8SBarry Smith }
1181421e10b8SBarry Smith 
11820971522cSBarry Smith #undef __FUNCT__
1183574deadeSBarry Smith #define __FUNCT__ "PCReset_FieldSplit"
1184574deadeSBarry Smith static PetscErrorCode PCReset_FieldSplit(PC pc)
11850971522cSBarry Smith {
11860971522cSBarry Smith   PC_FieldSplit     *jac = (PC_FieldSplit*)pc->data;
11870971522cSBarry Smith   PetscErrorCode    ierr;
11885a9f2f41SSatish Balay   PC_FieldSplitLink ilink = jac->head,next;
11890971522cSBarry Smith 
11900971522cSBarry Smith   PetscFunctionBegin;
11915a9f2f41SSatish Balay   while (ilink) {
1192574deadeSBarry Smith     ierr  = KSPReset(ilink->ksp);CHKERRQ(ierr);
1193fcfd50ebSBarry Smith     ierr  = VecDestroy(&ilink->x);CHKERRQ(ierr);
1194fcfd50ebSBarry Smith     ierr  = VecDestroy(&ilink->y);CHKERRQ(ierr);
1195443836d0SMatthew G Knepley     ierr  = VecDestroy(&ilink->z);CHKERRQ(ierr);
1196fcfd50ebSBarry Smith     ierr  = VecScatterDestroy(&ilink->sctx);CHKERRQ(ierr);
11971c7cfba8SBarry Smith     if (!ilink->is_orig) {             /* save the original IS */
11986dbb499eSCian Wilson       ierr = PetscObjectReference((PetscObject)ilink->is);CHKERRQ(ierr);
11996dbb499eSCian Wilson       ilink->is_orig = ilink->is;
12006dbb499eSCian Wilson     }
1201fcfd50ebSBarry Smith     ierr  = ISDestroy(&ilink->is);CHKERRQ(ierr);
1202b5787286SJed Brown     ierr  = ISDestroy(&ilink->is_col);CHKERRQ(ierr);
12035a9f2f41SSatish Balay     next  = ilink->next;
12045a9f2f41SSatish Balay     ilink = next;
12050971522cSBarry Smith   }
120605b42c5fSBarry Smith   ierr = PetscFree2(jac->x,jac->y);CHKERRQ(ierr);
1207574deadeSBarry Smith   if (jac->mat && jac->mat != jac->pmat) {
1208574deadeSBarry Smith     ierr = MatDestroyMatrices(jac->nsplits,&jac->mat);CHKERRQ(ierr);
1209574deadeSBarry Smith   } else if (jac->mat) {
12100298fd71SBarry Smith     jac->mat = NULL;
1211574deadeSBarry Smith   }
121297bbdb24SBarry Smith   if (jac->pmat) {ierr = MatDestroyMatrices(jac->nsplits,&jac->pmat);CHKERRQ(ierr);}
121368dd23aaSBarry Smith   if (jac->Afield) {ierr = MatDestroyMatrices(jac->nsplits,&jac->Afield);CHKERRQ(ierr);}
12146bf464f9SBarry Smith   ierr       = VecDestroy(&jac->w1);CHKERRQ(ierr);
12156bf464f9SBarry Smith   ierr       = VecDestroy(&jac->w2);CHKERRQ(ierr);
12166bf464f9SBarry Smith   ierr       = MatDestroy(&jac->schur);CHKERRQ(ierr);
1217a7476a74SDmitry Karpeev   ierr       = MatDestroy(&jac->schurp);CHKERRQ(ierr);
12186bf464f9SBarry Smith   ierr       = MatDestroy(&jac->schur_user);CHKERRQ(ierr);
12196bf464f9SBarry Smith   ierr       = KSPDestroy(&jac->kspschur);CHKERRQ(ierr);
1220d78dad28SBarry Smith   ierr       = KSPDestroy(&jac->kspupper);CHKERRQ(ierr);
12216bf464f9SBarry Smith   ierr       = MatDestroy(&jac->B);CHKERRQ(ierr);
12226bf464f9SBarry Smith   ierr       = MatDestroy(&jac->C);CHKERRQ(ierr);
122363ec74ffSBarry Smith   jac->reset = PETSC_TRUE;
12246dbb499eSCian Wilson   jac->isrestrict = PETSC_FALSE;
1225574deadeSBarry Smith   PetscFunctionReturn(0);
1226574deadeSBarry Smith }
1227574deadeSBarry Smith 
1228574deadeSBarry Smith #undef __FUNCT__
1229574deadeSBarry Smith #define __FUNCT__ "PCDestroy_FieldSplit"
1230574deadeSBarry Smith static PetscErrorCode PCDestroy_FieldSplit(PC pc)
1231574deadeSBarry Smith {
1232574deadeSBarry Smith   PC_FieldSplit     *jac = (PC_FieldSplit*)pc->data;
1233574deadeSBarry Smith   PetscErrorCode    ierr;
1234574deadeSBarry Smith   PC_FieldSplitLink ilink = jac->head,next;
1235574deadeSBarry Smith 
1236574deadeSBarry Smith   PetscFunctionBegin;
1237574deadeSBarry Smith   ierr = PCReset_FieldSplit(pc);CHKERRQ(ierr);
1238574deadeSBarry Smith   while (ilink) {
12396bf464f9SBarry Smith     ierr  = KSPDestroy(&ilink->ksp);CHKERRQ(ierr);
12406dbb499eSCian Wilson     ierr  = ISDestroy(&ilink->is_orig);CHKERRQ(ierr);
1241574deadeSBarry Smith     next  = ilink->next;
1242574deadeSBarry Smith     ierr  = PetscFree(ilink->splitname);CHKERRQ(ierr);
1243574deadeSBarry Smith     ierr  = PetscFree(ilink->fields);CHKERRQ(ierr);
12445d4c12cdSJungho Lee     ierr  = PetscFree(ilink->fields_col);CHKERRQ(ierr);
1245574deadeSBarry Smith     ierr  = PetscFree(ilink);CHKERRQ(ierr);
1246574deadeSBarry Smith     ilink = next;
1247574deadeSBarry Smith   }
1248574deadeSBarry Smith   ierr = PetscFree2(jac->x,jac->y);CHKERRQ(ierr);
1249c31cb41cSBarry Smith   ierr = PetscFree(pc->data);CHKERRQ(ierr);
1250bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitGetSubKSP_C",NULL);CHKERRQ(ierr);
1251bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetFields_C",NULL);CHKERRQ(ierr);
1252bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetIS_C",NULL);CHKERRQ(ierr);
1253bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetType_C",NULL);CHKERRQ(ierr);
1254bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetBlockSize_C",NULL);CHKERRQ(ierr);
125529f8a81cSJed Brown   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetSchurPre_C",NULL);CHKERRQ(ierr);
125637a82bf0SJed Brown   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitGetSchurPre_C",NULL);CHKERRQ(ierr);
1257bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetSchurFactType_C",NULL);CHKERRQ(ierr);
12586dbb499eSCian Wilson   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitRestrictIS_C",NULL);CHKERRQ(ierr);
12590971522cSBarry Smith   PetscFunctionReturn(0);
12600971522cSBarry Smith }
12610971522cSBarry Smith 
12620971522cSBarry Smith #undef __FUNCT__
12630971522cSBarry Smith #define __FUNCT__ "PCSetFromOptions_FieldSplit"
12644416b707SBarry Smith static PetscErrorCode PCSetFromOptions_FieldSplit(PetscOptionItems *PetscOptionsObject,PC pc)
12650971522cSBarry Smith {
12661b9fc7fcSBarry Smith   PetscErrorCode  ierr;
12676c924f48SJed Brown   PetscInt        bs;
1268bc59fbc5SBarry Smith   PetscBool       flg,stokes = PETSC_FALSE;
12699dcbbd2bSBarry Smith   PC_FieldSplit   *jac = (PC_FieldSplit*)pc->data;
12703b224e63SBarry Smith   PCCompositeType ctype;
12711b9fc7fcSBarry Smith 
12720971522cSBarry Smith   PetscFunctionBegin;
1273e55864a3SBarry Smith   ierr = PetscOptionsHead(PetscOptionsObject,"FieldSplit options");CHKERRQ(ierr);
12744ab8060aSDmitry Karpeev   ierr = PetscOptionsBool("-pc_fieldsplit_dm_splits","Whether to use DMCreateFieldDecomposition() for splits","PCFieldSplitSetDMSplits",jac->dm_splits,&jac->dm_splits,NULL);CHKERRQ(ierr);
127551f519a2SBarry Smith   ierr = PetscOptionsInt("-pc_fieldsplit_block_size","Blocksize that defines number of fields","PCFieldSplitSetBlockSize",jac->bs,&bs,&flg);CHKERRQ(ierr);
127651f519a2SBarry Smith   if (flg) {
127751f519a2SBarry Smith     ierr = PCFieldSplitSetBlockSize(pc,bs);CHKERRQ(ierr);
127851f519a2SBarry Smith   }
12792686e3e9SMatthew G. Knepley   jac->diag_use_amat = pc->useAmat;
12802686e3e9SMatthew G. Knepley   ierr = PetscOptionsBool("-pc_fieldsplit_diag_use_amat","Use Amat (not Pmat) to extract diagonal fieldsplit blocks", "PCFieldSplitSetDiagUseAmat",jac->diag_use_amat,&jac->diag_use_amat,NULL);CHKERRQ(ierr);
12812686e3e9SMatthew G. Knepley   jac->offdiag_use_amat = pc->useAmat;
12822686e3e9SMatthew G. Knepley   ierr = PetscOptionsBool("-pc_fieldsplit_off_diag_use_amat","Use Amat (not Pmat) to extract off-diagonal fieldsplit blocks", "PCFieldSplitSetOffDiagUseAmat",jac->offdiag_use_amat,&jac->offdiag_use_amat,NULL);CHKERRQ(ierr);
128300216929SDmitry Karpeev   /* FIXME: No programmatic equivalent to the following. */
1284c5929fdfSBarry Smith   ierr = PetscOptionsGetBool(((PetscObject)pc)->options,((PetscObject)pc)->prefix,"-pc_fieldsplit_detect_saddle_point",&stokes,NULL);CHKERRQ(ierr);
1285c0adfefeSBarry Smith   if (stokes) {
1286c0adfefeSBarry Smith     ierr          = PCFieldSplitSetType(pc,PC_COMPOSITE_SCHUR);CHKERRQ(ierr);
1287c0adfefeSBarry Smith     jac->schurpre = PC_FIELDSPLIT_SCHUR_PRE_SELF;
1288c0adfefeSBarry Smith   }
1289c0adfefeSBarry Smith 
12903b224e63SBarry Smith   ierr = PetscOptionsEnum("-pc_fieldsplit_type","Type of composition","PCFieldSplitSetType",PCCompositeTypes,(PetscEnum)jac->type,(PetscEnum*)&ctype,&flg);CHKERRQ(ierr);
12913b224e63SBarry Smith   if (flg) {
12923b224e63SBarry Smith     ierr = PCFieldSplitSetType(pc,ctype);CHKERRQ(ierr);
12933b224e63SBarry Smith   }
1294c30613efSMatthew Knepley   /* Only setup fields once */
1295c30613efSMatthew Knepley   if ((jac->bs > 0) && (jac->nsplits == 0)) {
1296d32f9abdSBarry Smith     /* only allow user to set fields from command line if bs is already known.
1297d32f9abdSBarry Smith        otherwise user can set them in PCFieldSplitSetDefaults() */
12986c924f48SJed Brown     ierr = PCFieldSplitSetRuntimeSplits_Private(pc);CHKERRQ(ierr);
12996c924f48SJed Brown     if (jac->splitdefined) {ierr = PetscInfo(pc,"Splits defined using the options database\n");CHKERRQ(ierr);}
1300d32f9abdSBarry Smith   }
1301c5d2311dSJed Brown   if (jac->type == PC_COMPOSITE_SCHUR) {
1302c5929fdfSBarry Smith     ierr = PetscOptionsGetEnum(((PetscObject)pc)->options,((PetscObject)pc)->prefix,"-pc_fieldsplit_schur_factorization_type",PCFieldSplitSchurFactTypes,(PetscEnum*)&jac->schurfactorization,&flg);CHKERRQ(ierr);
1303c9c6ffaaSJed Brown     if (flg) {ierr = PetscInfo(pc,"Deprecated use of -pc_fieldsplit_schur_factorization_type\n");CHKERRQ(ierr);}
13040298fd71SBarry 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);
130529f8a81cSJed 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);
1306c5d2311dSJed Brown   }
13071b9fc7fcSBarry Smith   ierr = PetscOptionsTail();CHKERRQ(ierr);
13080971522cSBarry Smith   PetscFunctionReturn(0);
13090971522cSBarry Smith }
13100971522cSBarry Smith 
13110971522cSBarry Smith /*------------------------------------------------------------------------------------*/
13120971522cSBarry Smith 
13130971522cSBarry Smith #undef __FUNCT__
13140971522cSBarry Smith #define __FUNCT__ "PCFieldSplitSetFields_FieldSplit"
13151e6b0712SBarry Smith static PetscErrorCode  PCFieldSplitSetFields_FieldSplit(PC pc,const char splitname[],PetscInt n,const PetscInt *fields,const PetscInt *fields_col)
13160971522cSBarry Smith {
131797bbdb24SBarry Smith   PC_FieldSplit     *jac = (PC_FieldSplit*)pc->data;
13180971522cSBarry Smith   PetscErrorCode    ierr;
13195a9f2f41SSatish Balay   PC_FieldSplitLink ilink,next = jac->head;
132069a612a9SBarry Smith   char              prefix[128];
13215d4c12cdSJungho Lee   PetscInt          i;
13220971522cSBarry Smith 
13230971522cSBarry Smith   PetscFunctionBegin;
13246c924f48SJed Brown   if (jac->splitdefined) {
13256c924f48SJed Brown     ierr = PetscInfo1(pc,"Ignoring new split \"%s\" because the splits have already been defined\n",splitname);CHKERRQ(ierr);
13266c924f48SJed Brown     PetscFunctionReturn(0);
13276c924f48SJed Brown   }
132851f519a2SBarry Smith   for (i=0; i<n; i++) {
1329e32f2f54SBarry 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);
1330e32f2f54SBarry Smith     if (fields[i] < 0) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Negative field %D requested",fields[i]);
133151f519a2SBarry Smith   }
1332b00a9115SJed Brown   ierr = PetscNew(&ilink);CHKERRQ(ierr);
1333a04f6461SBarry Smith   if (splitname) {
1334db4c96c1SJed Brown     ierr = PetscStrallocpy(splitname,&ilink->splitname);CHKERRQ(ierr);
1335a04f6461SBarry Smith   } else {
1336785e854fSJed Brown     ierr = PetscMalloc1(3,&ilink->splitname);CHKERRQ(ierr);
1337a04f6461SBarry Smith     ierr = PetscSNPrintf(ilink->splitname,2,"%s",jac->nsplits);CHKERRQ(ierr);
1338a04f6461SBarry Smith   }
13399df09d43SBarry 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 */
1340785e854fSJed Brown   ierr = PetscMalloc1(n,&ilink->fields);CHKERRQ(ierr);
13415a9f2f41SSatish Balay   ierr = PetscMemcpy(ilink->fields,fields,n*sizeof(PetscInt));CHKERRQ(ierr);
1342785e854fSJed Brown   ierr = PetscMalloc1(n,&ilink->fields_col);CHKERRQ(ierr);
13435d4c12cdSJungho Lee   ierr = PetscMemcpy(ilink->fields_col,fields_col,n*sizeof(PetscInt));CHKERRQ(ierr);
13442fa5cd67SKarl Rupp 
13455a9f2f41SSatish Balay   ilink->nfields = n;
13460298fd71SBarry Smith   ilink->next    = NULL;
1347ce94432eSBarry Smith   ierr           = KSPCreate(PetscObjectComm((PetscObject)pc),&ilink->ksp);CHKERRQ(ierr);
1348422a814eSBarry Smith   ierr           = KSPSetErrorIfNotConverged(ilink->ksp,pc->erroriffailure);CHKERRQ(ierr);
134920252d06SBarry Smith   ierr           = PetscObjectIncrementTabLevel((PetscObject)ilink->ksp,(PetscObject)pc,1);CHKERRQ(ierr);
13505a9f2f41SSatish Balay   ierr           = KSPSetType(ilink->ksp,KSPPREONLY);CHKERRQ(ierr);
13519005cf84SBarry Smith   ierr           = PetscLogObjectParent((PetscObject)pc,(PetscObject)ilink->ksp);CHKERRQ(ierr);
135269a612a9SBarry Smith 
13538caf3d72SBarry Smith   ierr = PetscSNPrintf(prefix,sizeof(prefix),"%sfieldsplit_%s_",((PetscObject)pc)->prefix ? ((PetscObject)pc)->prefix : "",ilink->splitname);CHKERRQ(ierr);
13545a9f2f41SSatish Balay   ierr = KSPSetOptionsPrefix(ilink->ksp,prefix);CHKERRQ(ierr);
13550971522cSBarry Smith 
13560971522cSBarry Smith   if (!next) {
13575a9f2f41SSatish Balay     jac->head       = ilink;
13580298fd71SBarry Smith     ilink->previous = NULL;
13590971522cSBarry Smith   } else {
13600971522cSBarry Smith     while (next->next) {
13610971522cSBarry Smith       next = next->next;
13620971522cSBarry Smith     }
13635a9f2f41SSatish Balay     next->next      = ilink;
136451f519a2SBarry Smith     ilink->previous = next;
13650971522cSBarry Smith   }
13660971522cSBarry Smith   jac->nsplits++;
13670971522cSBarry Smith   PetscFunctionReturn(0);
13680971522cSBarry Smith }
13690971522cSBarry Smith 
1370e69d4d44SBarry Smith #undef __FUNCT__
1371e69d4d44SBarry Smith #define __FUNCT__ "PCFieldSplitGetSubKSP_FieldSplit_Schur"
13721e6b0712SBarry Smith static PetscErrorCode  PCFieldSplitGetSubKSP_FieldSplit_Schur(PC pc,PetscInt *n,KSP **subksp)
1373e69d4d44SBarry Smith {
1374e69d4d44SBarry Smith   PC_FieldSplit  *jac = (PC_FieldSplit*)pc->data;
1375e69d4d44SBarry Smith   PetscErrorCode ierr;
1376e69d4d44SBarry Smith 
1377e69d4d44SBarry Smith   PetscFunctionBegin;
1378785e854fSJed Brown   ierr = PetscMalloc1(jac->nsplits,subksp);CHKERRQ(ierr);
1379e69d4d44SBarry Smith   ierr = MatSchurComplementGetKSP(jac->schur,*subksp);CHKERRQ(ierr);
13802fa5cd67SKarl Rupp 
1381e69d4d44SBarry Smith   (*subksp)[1] = jac->kspschur;
138213e0d083SBarry Smith   if (n) *n = jac->nsplits;
1383e69d4d44SBarry Smith   PetscFunctionReturn(0);
1384e69d4d44SBarry Smith }
13850971522cSBarry Smith 
13860971522cSBarry Smith #undef __FUNCT__
138769a612a9SBarry Smith #define __FUNCT__ "PCFieldSplitGetSubKSP_FieldSplit"
13881e6b0712SBarry Smith static PetscErrorCode  PCFieldSplitGetSubKSP_FieldSplit(PC pc,PetscInt *n,KSP **subksp)
13890971522cSBarry Smith {
13900971522cSBarry Smith   PC_FieldSplit     *jac = (PC_FieldSplit*)pc->data;
13910971522cSBarry Smith   PetscErrorCode    ierr;
13920971522cSBarry Smith   PetscInt          cnt   = 0;
13935a9f2f41SSatish Balay   PC_FieldSplitLink ilink = jac->head;
13940971522cSBarry Smith 
13950971522cSBarry Smith   PetscFunctionBegin;
1396785e854fSJed Brown   ierr = PetscMalloc1(jac->nsplits,subksp);CHKERRQ(ierr);
13975a9f2f41SSatish Balay   while (ilink) {
13985a9f2f41SSatish Balay     (*subksp)[cnt++] = ilink->ksp;
13995a9f2f41SSatish Balay     ilink            = ilink->next;
14000971522cSBarry Smith   }
14015d480477SMatthew 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);
140213e0d083SBarry Smith   if (n) *n = jac->nsplits;
14030971522cSBarry Smith   PetscFunctionReturn(0);
14040971522cSBarry Smith }
14050971522cSBarry Smith 
1406704ba839SBarry Smith #undef __FUNCT__
14076dbb499eSCian Wilson #define __FUNCT__ "PCFieldSplitRestrictIS"
14086dbb499eSCian Wilson /*@C
14096dbb499eSCian Wilson     PCFieldSplitRestrictIS - Restricts the fieldsplit ISs to be within a given IS.
14106dbb499eSCian Wilson 
14116dbb499eSCian Wilson     Input Parameters:
14126dbb499eSCian Wilson +   pc  - the preconditioner context
14136dbb499eSCian Wilson +   is - the index set that defines the indices to which the fieldsplit is to be restricted
14146dbb499eSCian Wilson 
14156dbb499eSCian Wilson     Level: advanced
14166dbb499eSCian Wilson 
14176dbb499eSCian Wilson @*/
14186dbb499eSCian Wilson PetscErrorCode  PCFieldSplitRestrictIS(PC pc,IS isy)
14196dbb499eSCian Wilson {
14206dbb499eSCian Wilson   PetscErrorCode ierr;
14216dbb499eSCian Wilson 
14226dbb499eSCian Wilson   PetscFunctionBegin;
14236dbb499eSCian Wilson   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
14246dbb499eSCian Wilson   PetscValidHeaderSpecific(isy,IS_CLASSID,2);
14250246f55cSBarry Smith   ierr = PetscTryMethod(pc,"PCFieldSplitRestrictIS_C",(PC,IS),(pc,isy));CHKERRQ(ierr);
14266dbb499eSCian Wilson   PetscFunctionReturn(0);
14276dbb499eSCian Wilson }
14286dbb499eSCian Wilson 
14296dbb499eSCian Wilson 
14306dbb499eSCian Wilson #undef __FUNCT__
14316dbb499eSCian Wilson #define __FUNCT__ "PCFieldSplitRestrictIS_FieldSplit"
14326dbb499eSCian Wilson static PetscErrorCode  PCFieldSplitRestrictIS_FieldSplit(PC pc, IS isy)
14336dbb499eSCian Wilson {
14346dbb499eSCian Wilson   PC_FieldSplit     *jac = (PC_FieldSplit*)pc->data;
14356dbb499eSCian Wilson   PetscErrorCode    ierr;
14366dbb499eSCian Wilson   PC_FieldSplitLink ilink = jac->head, next;
14376dbb499eSCian Wilson   PetscInt          localsize,size,sizez,i;
14386dbb499eSCian Wilson   const PetscInt    *ind, *indz;
14396dbb499eSCian Wilson   PetscInt          *indc, *indcz;
14406dbb499eSCian Wilson   PetscBool         flg;
14416dbb499eSCian Wilson 
14426dbb499eSCian Wilson   PetscFunctionBegin;
14436dbb499eSCian Wilson   ierr = ISGetLocalSize(isy,&localsize);CHKERRQ(ierr);
14446dbb499eSCian Wilson   ierr = MPI_Scan(&localsize,&size,1,MPIU_INT,MPI_SUM,PetscObjectComm((PetscObject)isy));CHKERRQ(ierr);
14456dbb499eSCian Wilson   size -= localsize;
14466dbb499eSCian Wilson   while(ilink) {
14476dbb499eSCian Wilson     IS isrl,isr;
14481c7cfba8SBarry Smith     PC subpc;
14496dbb499eSCian Wilson     if (jac->reset) {
14506dbb499eSCian Wilson       ierr = ISEmbed(ilink->is_orig, isy, PETSC_TRUE, &isrl);CHKERRQ(ierr);
14516dbb499eSCian Wilson     } else {
14526dbb499eSCian Wilson       ierr = ISEmbed(ilink->is, isy, PETSC_TRUE, &isrl);CHKERRQ(ierr);
14536dbb499eSCian Wilson     }
14546dbb499eSCian Wilson     ierr          = ISGetLocalSize(isrl,&localsize);CHKERRQ(ierr);
14556dbb499eSCian Wilson     ierr          = PetscMalloc1(localsize,&indc);CHKERRQ(ierr);
14566dbb499eSCian Wilson     ierr          = ISGetIndices(isrl,&ind);CHKERRQ(ierr);
14576dbb499eSCian Wilson     ierr          = PetscMemcpy(indc,ind,localsize*sizeof(PetscInt));CHKERRQ(ierr);
14586dbb499eSCian Wilson     ierr          = ISRestoreIndices(isrl,&ind);CHKERRQ(ierr);
14596dbb499eSCian Wilson     ierr          = ISDestroy(&isrl);CHKERRQ(ierr);
14606dbb499eSCian Wilson     for (i=0; i<localsize; i++) *(indc+i) += size;
14616dbb499eSCian Wilson     ierr          = ISCreateGeneral(PetscObjectComm((PetscObject)isy),localsize,indc,PETSC_OWN_POINTER,&isr);CHKERRQ(ierr);
14626dbb499eSCian Wilson     ierr          = PetscObjectReference((PetscObject)isr);CHKERRQ(ierr);
14636dbb499eSCian Wilson     ierr          = ISDestroy(&ilink->is);CHKERRQ(ierr);
14646dbb499eSCian Wilson     ilink->is     = isr;
14656dbb499eSCian Wilson     ierr          = PetscObjectReference((PetscObject)isr);CHKERRQ(ierr);
14666dbb499eSCian Wilson     ierr          = ISDestroy(&ilink->is_col);CHKERRQ(ierr);
14676dbb499eSCian Wilson     ilink->is_col = isr;
14686dbb499eSCian Wilson     ierr          = ISDestroy(&isr);CHKERRQ(ierr);
14696dbb499eSCian Wilson     ierr          = KSPGetPC(ilink->ksp, &subpc);CHKERRQ(ierr);
14706dbb499eSCian Wilson     ierr          = PetscObjectTypeCompare((PetscObject)subpc,PCFIELDSPLIT,&flg);CHKERRQ(ierr);
14716dbb499eSCian Wilson     if(flg) {
14726dbb499eSCian Wilson       IS iszl,isz;
14736dbb499eSCian Wilson       MPI_Comm comm;
14746dbb499eSCian Wilson       if (jac->reset) {
14756dbb499eSCian Wilson         ierr = ISGetLocalSize(ilink->is_orig,&localsize);CHKERRQ(ierr);
14766dbb499eSCian Wilson         comm = PetscObjectComm((PetscObject)ilink->is_orig);
14776dbb499eSCian Wilson         ierr = ISEmbed(isy, ilink->is_orig, PETSC_TRUE, &iszl);CHKERRQ(ierr);
14786dbb499eSCian Wilson       } else {
14796dbb499eSCian Wilson         ierr = ISGetLocalSize(ilink->is,&localsize);CHKERRQ(ierr);
14806dbb499eSCian Wilson         comm = PetscObjectComm((PetscObject)ilink->is);
14816dbb499eSCian Wilson         ierr = ISEmbed(isy, ilink->is, PETSC_TRUE, &iszl);CHKERRQ(ierr);
14826dbb499eSCian Wilson       }
14836dbb499eSCian Wilson       ierr   = MPI_Scan(&localsize,&sizez,1,MPIU_INT,MPI_SUM,comm);CHKERRQ(ierr);
14846dbb499eSCian Wilson       sizez -= localsize;
14856dbb499eSCian Wilson       ierr   = ISGetLocalSize(iszl,&localsize);CHKERRQ(ierr);
14866dbb499eSCian Wilson       ierr   = PetscMalloc1(localsize,&indcz);CHKERRQ(ierr);
14876dbb499eSCian Wilson       ierr   = ISGetIndices(iszl,&indz);CHKERRQ(ierr);
14886dbb499eSCian Wilson       ierr   = PetscMemcpy(indcz,indz,localsize*sizeof(PetscInt));CHKERRQ(ierr);
14896dbb499eSCian Wilson       ierr   = ISRestoreIndices(iszl,&indz);CHKERRQ(ierr);
14906dbb499eSCian Wilson       ierr   = ISDestroy(&iszl);CHKERRQ(ierr);
14916dbb499eSCian Wilson       for (i=0; i<localsize; i++) *(indcz+i) += sizez;
14926dbb499eSCian Wilson       ierr   = ISCreateGeneral(comm,localsize,indcz,PETSC_OWN_POINTER,&isz);CHKERRQ(ierr);
14936dbb499eSCian Wilson       ierr   = PCFieldSplitRestrictIS(subpc,isz);CHKERRQ(ierr);
14946dbb499eSCian Wilson       ierr   = ISDestroy(&isz);CHKERRQ(ierr);
14956dbb499eSCian Wilson     }
14966dbb499eSCian Wilson     next = ilink->next;
14976dbb499eSCian Wilson     ilink = next;
14986dbb499eSCian Wilson   }
14996dbb499eSCian Wilson   jac->isrestrict = PETSC_TRUE;
15006dbb499eSCian Wilson   PetscFunctionReturn(0);
15016dbb499eSCian Wilson }
15026dbb499eSCian Wilson 
15036dbb499eSCian Wilson #undef __FUNCT__
1504704ba839SBarry Smith #define __FUNCT__ "PCFieldSplitSetIS_FieldSplit"
15051e6b0712SBarry Smith static PetscErrorCode  PCFieldSplitSetIS_FieldSplit(PC pc,const char splitname[],IS is)
1506704ba839SBarry Smith {
1507704ba839SBarry Smith   PC_FieldSplit     *jac = (PC_FieldSplit*)pc->data;
1508704ba839SBarry Smith   PetscErrorCode    ierr;
1509704ba839SBarry Smith   PC_FieldSplitLink ilink, next = jac->head;
1510704ba839SBarry Smith   char              prefix[128];
1511704ba839SBarry Smith 
1512704ba839SBarry Smith   PetscFunctionBegin;
15136c924f48SJed Brown   if (jac->splitdefined) {
15146c924f48SJed Brown     ierr = PetscInfo1(pc,"Ignoring new split \"%s\" because the splits have already been defined\n",splitname);CHKERRQ(ierr);
15156c924f48SJed Brown     PetscFunctionReturn(0);
15166c924f48SJed Brown   }
1517b00a9115SJed Brown   ierr = PetscNew(&ilink);CHKERRQ(ierr);
1518a04f6461SBarry Smith   if (splitname) {
1519db4c96c1SJed Brown     ierr = PetscStrallocpy(splitname,&ilink->splitname);CHKERRQ(ierr);
1520a04f6461SBarry Smith   } else {
1521785e854fSJed Brown     ierr = PetscMalloc1(8,&ilink->splitname);CHKERRQ(ierr);
1522b5787286SJed Brown     ierr = PetscSNPrintf(ilink->splitname,7,"%D",jac->nsplits);CHKERRQ(ierr);
1523a04f6461SBarry Smith   }
15249df09d43SBarry 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 */
15251ab39975SBarry Smith   ierr          = PetscObjectReference((PetscObject)is);CHKERRQ(ierr);
1526b5787286SJed Brown   ierr          = ISDestroy(&ilink->is);CHKERRQ(ierr);
1527b5787286SJed Brown   ilink->is     = is;
1528b5787286SJed Brown   ierr          = PetscObjectReference((PetscObject)is);CHKERRQ(ierr);
1529b5787286SJed Brown   ierr          = ISDestroy(&ilink->is_col);CHKERRQ(ierr);
1530b5787286SJed Brown   ilink->is_col = is;
15310298fd71SBarry Smith   ilink->next   = NULL;
1532ce94432eSBarry Smith   ierr          = KSPCreate(PetscObjectComm((PetscObject)pc),&ilink->ksp);CHKERRQ(ierr);
1533422a814eSBarry Smith   ierr          = KSPSetErrorIfNotConverged(ilink->ksp,pc->erroriffailure);CHKERRQ(ierr);
153420252d06SBarry Smith   ierr          = PetscObjectIncrementTabLevel((PetscObject)ilink->ksp,(PetscObject)pc,1);CHKERRQ(ierr);
1535704ba839SBarry Smith   ierr          = KSPSetType(ilink->ksp,KSPPREONLY);CHKERRQ(ierr);
15369005cf84SBarry Smith   ierr          = PetscLogObjectParent((PetscObject)pc,(PetscObject)ilink->ksp);CHKERRQ(ierr);
1537704ba839SBarry Smith 
15388caf3d72SBarry Smith   ierr = PetscSNPrintf(prefix,sizeof(prefix),"%sfieldsplit_%s_",((PetscObject)pc)->prefix ? ((PetscObject)pc)->prefix : "",ilink->splitname);CHKERRQ(ierr);
1539704ba839SBarry Smith   ierr = KSPSetOptionsPrefix(ilink->ksp,prefix);CHKERRQ(ierr);
1540704ba839SBarry Smith 
1541704ba839SBarry Smith   if (!next) {
1542704ba839SBarry Smith     jac->head       = ilink;
15430298fd71SBarry Smith     ilink->previous = NULL;
1544704ba839SBarry Smith   } else {
1545704ba839SBarry Smith     while (next->next) {
1546704ba839SBarry Smith       next = next->next;
1547704ba839SBarry Smith     }
1548704ba839SBarry Smith     next->next      = ilink;
1549704ba839SBarry Smith     ilink->previous = next;
1550704ba839SBarry Smith   }
1551704ba839SBarry Smith   jac->nsplits++;
1552704ba839SBarry Smith   PetscFunctionReturn(0);
1553704ba839SBarry Smith }
1554704ba839SBarry Smith 
15550971522cSBarry Smith #undef __FUNCT__
15560971522cSBarry Smith #define __FUNCT__ "PCFieldSplitSetFields"
15570971522cSBarry Smith /*@
15580971522cSBarry Smith     PCFieldSplitSetFields - Sets the fields for one particular split in the field split preconditioner
15590971522cSBarry Smith 
1560ad4df100SBarry Smith     Logically Collective on PC
15610971522cSBarry Smith 
15620971522cSBarry Smith     Input Parameters:
15630971522cSBarry Smith +   pc  - the preconditioner context
15640298fd71SBarry Smith .   splitname - name of this split, if NULL the number of the split is used
15650971522cSBarry Smith .   n - the number of fields in this split
1566db4c96c1SJed Brown -   fields - the fields in this split
15670971522cSBarry Smith 
15680971522cSBarry Smith     Level: intermediate
15690971522cSBarry Smith 
1570d32f9abdSBarry Smith     Notes: Use PCFieldSplitSetIS() to set a completely general set of indices as a field.
1571d32f9abdSBarry Smith 
15727287d2a3SDmitry Karpeev      The PCFieldSplitSetFields() is for defining fields as strided blocks. For example, if the block
1573d32f9abdSBarry 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
1574d32f9abdSBarry Smith      0xx3xx6xx9xx12 ... x1xx4xx7xx ... xx2xx5xx8xx.. 01x34x67x... 0x1x3x5x7.. x12x45x78x....
1575d32f9abdSBarry Smith      where the numbered entries indicate what is in the field.
1576d32f9abdSBarry Smith 
1577db4c96c1SJed Brown      This function is called once per split (it creates a new split each time).  Solve options
1578db4c96c1SJed Brown      for this split will be available under the prefix -fieldsplit_SPLITNAME_.
1579db4c96c1SJed Brown 
15805d4c12cdSJungho Lee      Developer Note: This routine does not actually create the IS representing the split, that is delayed
15815d4c12cdSJungho Lee      until PCSetUp_FieldSplit(), because information about the vector/matrix layouts may not be
15825d4c12cdSJungho Lee      available when this routine is called.
15835d4c12cdSJungho Lee 
1584d32f9abdSBarry Smith .seealso: PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitSetBlockSize(), PCFieldSplitSetIS()
15850971522cSBarry Smith 
15860971522cSBarry Smith @*/
15875d4c12cdSJungho Lee PetscErrorCode  PCFieldSplitSetFields(PC pc,const char splitname[],PetscInt n,const PetscInt *fields,const PetscInt *fields_col)
15880971522cSBarry Smith {
15894ac538c5SBarry Smith   PetscErrorCode ierr;
15900971522cSBarry Smith 
15910971522cSBarry Smith   PetscFunctionBegin;
15920700a824SBarry Smith   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
1593db4c96c1SJed Brown   PetscValidCharPointer(splitname,2);
1594ce94432eSBarry Smith   if (n < 1) SETERRQ2(PetscObjectComm((PetscObject)pc),PETSC_ERR_ARG_OUTOFRANGE,"Provided number of fields %D in split \"%s\" not positive",n,splitname);
1595db4c96c1SJed Brown   PetscValidIntPointer(fields,3);
15960246f55cSBarry Smith   ierr = PetscTryMethod(pc,"PCFieldSplitSetFields_C",(PC,const char[],PetscInt,const PetscInt*,const PetscInt*),(pc,splitname,n,fields,fields_col));CHKERRQ(ierr);
15970971522cSBarry Smith   PetscFunctionReturn(0);
15980971522cSBarry Smith }
15990971522cSBarry Smith 
16000971522cSBarry Smith #undef __FUNCT__
1601c84da90fSDmitry Karpeev #define __FUNCT__ "PCFieldSplitSetDiagUseAmat"
1602c84da90fSDmitry Karpeev /*@
1603c84da90fSDmitry Karpeev     PCFieldSplitSetDiagUseAmat - set flag indicating whether to extract diagonal blocks from Amat (rather than Pmat)
1604c84da90fSDmitry Karpeev 
1605c84da90fSDmitry Karpeev     Logically Collective on PC
1606c84da90fSDmitry Karpeev 
1607c84da90fSDmitry Karpeev     Input Parameters:
1608c84da90fSDmitry Karpeev +   pc  - the preconditioner object
1609c84da90fSDmitry Karpeev -   flg - boolean flag indicating whether or not to use Amat to extract the diagonal blocks from
1610c84da90fSDmitry Karpeev 
16119506b623SDmitry Karpeev     Options Database:
16129506b623SDmitry Karpeev .     -pc_fieldsplit_diag_use_amat
1613c84da90fSDmitry Karpeev 
1614c84da90fSDmitry Karpeev     Level: intermediate
1615c84da90fSDmitry Karpeev 
1616c84da90fSDmitry Karpeev .seealso: PCFieldSplitGetDiagUseAmat(), PCFieldSplitSetOffDiagUseAmat(), PCFIELDSPLIT
1617c84da90fSDmitry Karpeev 
1618c84da90fSDmitry Karpeev @*/
1619c84da90fSDmitry Karpeev PetscErrorCode  PCFieldSplitSetDiagUseAmat(PC pc,PetscBool flg)
1620c84da90fSDmitry Karpeev {
1621c84da90fSDmitry Karpeev   PC_FieldSplit  *jac = (PC_FieldSplit*)pc->data;
1622c84da90fSDmitry Karpeev   PetscBool      isfs;
1623c84da90fSDmitry Karpeev   PetscErrorCode ierr;
1624c84da90fSDmitry Karpeev 
1625c84da90fSDmitry Karpeev   PetscFunctionBegin;
1626c84da90fSDmitry Karpeev   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
1627c84da90fSDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)pc,PCFIELDSPLIT,&isfs);CHKERRQ(ierr);
1628c84da90fSDmitry Karpeev   if (!isfs) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"PC not of type %s",PCFIELDSPLIT);
1629c84da90fSDmitry Karpeev   jac->diag_use_amat = flg;
1630c84da90fSDmitry Karpeev   PetscFunctionReturn(0);
1631c84da90fSDmitry Karpeev }
1632c84da90fSDmitry Karpeev 
1633c84da90fSDmitry Karpeev #undef __FUNCT__
1634c84da90fSDmitry Karpeev #define __FUNCT__ "PCFieldSplitGetDiagUseAmat"
1635c84da90fSDmitry Karpeev /*@
1636c84da90fSDmitry Karpeev     PCFieldSplitGetDiagUseAmat - get the flag indicating whether to extract diagonal blocks from Amat (rather than Pmat)
1637c84da90fSDmitry Karpeev 
1638c84da90fSDmitry Karpeev     Logically Collective on PC
1639c84da90fSDmitry Karpeev 
1640c84da90fSDmitry Karpeev     Input Parameters:
1641c84da90fSDmitry Karpeev .   pc  - the preconditioner object
1642c84da90fSDmitry Karpeev 
1643c84da90fSDmitry Karpeev     Output Parameters:
1644c84da90fSDmitry Karpeev .   flg - boolean flag indicating whether or not to use Amat to extract the diagonal blocks from
1645c84da90fSDmitry Karpeev 
1646c84da90fSDmitry Karpeev 
1647c84da90fSDmitry Karpeev     Level: intermediate
1648c84da90fSDmitry Karpeev 
1649c84da90fSDmitry Karpeev .seealso: PCFieldSplitSetDiagUseAmat(), PCFieldSplitGetOffDiagUseAmat(), PCFIELDSPLIT
1650c84da90fSDmitry Karpeev 
1651c84da90fSDmitry Karpeev @*/
1652c84da90fSDmitry Karpeev PetscErrorCode  PCFieldSplitGetDiagUseAmat(PC pc,PetscBool *flg)
1653c84da90fSDmitry Karpeev {
1654c84da90fSDmitry Karpeev   PC_FieldSplit  *jac = (PC_FieldSplit*)pc->data;
1655c84da90fSDmitry Karpeev   PetscBool      isfs;
1656c84da90fSDmitry Karpeev   PetscErrorCode ierr;
1657c84da90fSDmitry Karpeev 
1658c84da90fSDmitry Karpeev   PetscFunctionBegin;
1659c84da90fSDmitry Karpeev   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
1660c84da90fSDmitry Karpeev   PetscValidPointer(flg,2);
1661c84da90fSDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)pc,PCFIELDSPLIT,&isfs);CHKERRQ(ierr);
1662c84da90fSDmitry Karpeev   if (!isfs) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"PC not of type %s",PCFIELDSPLIT);
1663c84da90fSDmitry Karpeev   *flg = jac->diag_use_amat;
1664c84da90fSDmitry Karpeev   PetscFunctionReturn(0);
1665c84da90fSDmitry Karpeev }
1666c84da90fSDmitry Karpeev 
1667c84da90fSDmitry Karpeev #undef __FUNCT__
1668c84da90fSDmitry Karpeev #define __FUNCT__ "PCFieldSplitSetOffDiagUseAmat"
1669c84da90fSDmitry Karpeev /*@
1670c84da90fSDmitry Karpeev     PCFieldSplitSetOffDiagUseAmat - set flag indicating whether to extract off-diagonal blocks from Amat (rather than Pmat)
1671c84da90fSDmitry Karpeev 
1672c84da90fSDmitry Karpeev     Logically Collective on PC
1673c84da90fSDmitry Karpeev 
1674c84da90fSDmitry Karpeev     Input Parameters:
1675c84da90fSDmitry Karpeev +   pc  - the preconditioner object
1676c84da90fSDmitry Karpeev -   flg - boolean flag indicating whether or not to use Amat to extract the off-diagonal blocks from
1677c84da90fSDmitry Karpeev 
16789506b623SDmitry Karpeev     Options Database:
16799506b623SDmitry Karpeev .     -pc_fieldsplit_off_diag_use_amat
1680c84da90fSDmitry Karpeev 
1681c84da90fSDmitry Karpeev     Level: intermediate
1682c84da90fSDmitry Karpeev 
1683c84da90fSDmitry Karpeev .seealso: PCFieldSplitGetOffDiagUseAmat(), PCFieldSplitSetDiagUseAmat(), PCFIELDSPLIT
1684c84da90fSDmitry Karpeev 
1685c84da90fSDmitry Karpeev @*/
1686c84da90fSDmitry Karpeev PetscErrorCode  PCFieldSplitSetOffDiagUseAmat(PC pc,PetscBool flg)
1687c84da90fSDmitry Karpeev {
1688c84da90fSDmitry Karpeev   PC_FieldSplit *jac = (PC_FieldSplit*)pc->data;
1689c84da90fSDmitry Karpeev   PetscBool      isfs;
1690c84da90fSDmitry Karpeev   PetscErrorCode ierr;
1691c84da90fSDmitry Karpeev 
1692c84da90fSDmitry Karpeev   PetscFunctionBegin;
1693c84da90fSDmitry Karpeev   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
1694c84da90fSDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)pc,PCFIELDSPLIT,&isfs);CHKERRQ(ierr);
1695c84da90fSDmitry Karpeev   if (!isfs) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"PC not of type %s",PCFIELDSPLIT);
1696c84da90fSDmitry Karpeev   jac->offdiag_use_amat = flg;
1697c84da90fSDmitry Karpeev   PetscFunctionReturn(0);
1698c84da90fSDmitry Karpeev }
1699c84da90fSDmitry Karpeev 
1700c84da90fSDmitry Karpeev #undef __FUNCT__
1701c84da90fSDmitry Karpeev #define __FUNCT__ "PCFieldSplitGetOffDiagUseAmat"
1702c84da90fSDmitry Karpeev /*@
1703c84da90fSDmitry Karpeev     PCFieldSplitGetOffDiagUseAmat - get the flag indicating whether to extract off-diagonal blocks from Amat (rather than Pmat)
1704c84da90fSDmitry Karpeev 
1705c84da90fSDmitry Karpeev     Logically Collective on PC
1706c84da90fSDmitry Karpeev 
1707c84da90fSDmitry Karpeev     Input Parameters:
1708c84da90fSDmitry Karpeev .   pc  - the preconditioner object
1709c84da90fSDmitry Karpeev 
1710c84da90fSDmitry Karpeev     Output Parameters:
1711c84da90fSDmitry Karpeev .   flg - boolean flag indicating whether or not to use Amat to extract the off-diagonal blocks from
1712c84da90fSDmitry Karpeev 
1713c84da90fSDmitry Karpeev 
1714c84da90fSDmitry Karpeev     Level: intermediate
1715c84da90fSDmitry Karpeev 
1716c84da90fSDmitry Karpeev .seealso: PCFieldSplitSetOffDiagUseAmat(), PCFieldSplitGetDiagUseAmat(), PCFIELDSPLIT
1717c84da90fSDmitry Karpeev 
1718c84da90fSDmitry Karpeev @*/
1719c84da90fSDmitry Karpeev PetscErrorCode  PCFieldSplitGetOffDiagUseAmat(PC pc,PetscBool *flg)
1720c84da90fSDmitry Karpeev {
1721c84da90fSDmitry Karpeev   PC_FieldSplit  *jac = (PC_FieldSplit*)pc->data;
1722c84da90fSDmitry Karpeev   PetscBool      isfs;
1723c84da90fSDmitry Karpeev   PetscErrorCode ierr;
1724c84da90fSDmitry Karpeev 
1725c84da90fSDmitry Karpeev   PetscFunctionBegin;
1726c84da90fSDmitry Karpeev   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
1727c84da90fSDmitry Karpeev   PetscValidPointer(flg,2);
1728c84da90fSDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)pc,PCFIELDSPLIT,&isfs);CHKERRQ(ierr);
1729c84da90fSDmitry Karpeev   if (!isfs) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"PC not of type %s",PCFIELDSPLIT);
1730c84da90fSDmitry Karpeev   *flg = jac->offdiag_use_amat;
1731c84da90fSDmitry Karpeev   PetscFunctionReturn(0);
1732c84da90fSDmitry Karpeev }
1733c84da90fSDmitry Karpeev 
1734c84da90fSDmitry Karpeev 
1735c84da90fSDmitry Karpeev 
1736c84da90fSDmitry Karpeev #undef __FUNCT__
1737704ba839SBarry Smith #define __FUNCT__ "PCFieldSplitSetIS"
1738218d4943SBarry Smith /*@C
1739704ba839SBarry Smith     PCFieldSplitSetIS - Sets the exact elements for field
1740704ba839SBarry Smith 
1741ad4df100SBarry Smith     Logically Collective on PC
1742704ba839SBarry Smith 
1743704ba839SBarry Smith     Input Parameters:
1744704ba839SBarry Smith +   pc  - the preconditioner context
17450298fd71SBarry Smith .   splitname - name of this split, if NULL the number of the split is used
1746db4c96c1SJed Brown -   is - the index set that defines the vector elements in this field
1747704ba839SBarry Smith 
1748d32f9abdSBarry Smith 
1749a6ffb8dbSJed Brown     Notes:
1750a6ffb8dbSJed Brown     Use PCFieldSplitSetFields(), for fields defined by strided types.
1751a6ffb8dbSJed Brown 
1752db4c96c1SJed Brown     This function is called once per split (it creates a new split each time).  Solve options
1753db4c96c1SJed Brown     for this split will be available under the prefix -fieldsplit_SPLITNAME_.
1754d32f9abdSBarry Smith 
1755704ba839SBarry Smith     Level: intermediate
1756704ba839SBarry Smith 
1757704ba839SBarry Smith .seealso: PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitSetBlockSize()
1758704ba839SBarry Smith 
1759704ba839SBarry Smith @*/
17607087cfbeSBarry Smith PetscErrorCode  PCFieldSplitSetIS(PC pc,const char splitname[],IS is)
1761704ba839SBarry Smith {
17624ac538c5SBarry Smith   PetscErrorCode ierr;
1763704ba839SBarry Smith 
1764704ba839SBarry Smith   PetscFunctionBegin;
17650700a824SBarry Smith   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
17667b62db95SJungho Lee   if (splitname) PetscValidCharPointer(splitname,2);
1767db4c96c1SJed Brown   PetscValidHeaderSpecific(is,IS_CLASSID,3);
1768ccc738f7SBarry Smith   ierr = PetscTryMethod(pc,"PCFieldSplitSetIS_C",(PC,const char[],IS),(pc,splitname,is));CHKERRQ(ierr);
1769704ba839SBarry Smith   PetscFunctionReturn(0);
1770704ba839SBarry Smith }
1771704ba839SBarry Smith 
1772704ba839SBarry Smith #undef __FUNCT__
177357a9adfeSMatthew G Knepley #define __FUNCT__ "PCFieldSplitGetIS"
177457a9adfeSMatthew G Knepley /*@
177557a9adfeSMatthew G Knepley     PCFieldSplitGetIS - Retrieves the elements for a field as an IS
177657a9adfeSMatthew G Knepley 
177757a9adfeSMatthew G Knepley     Logically Collective on PC
177857a9adfeSMatthew G Knepley 
177957a9adfeSMatthew G Knepley     Input Parameters:
178057a9adfeSMatthew G Knepley +   pc  - the preconditioner context
178157a9adfeSMatthew G Knepley -   splitname - name of this split
178257a9adfeSMatthew G Knepley 
178357a9adfeSMatthew G Knepley     Output Parameter:
17840298fd71SBarry Smith -   is - the index set that defines the vector elements in this field, or NULL if the field is not found
178557a9adfeSMatthew G Knepley 
178657a9adfeSMatthew G Knepley     Level: intermediate
178757a9adfeSMatthew G Knepley 
178857a9adfeSMatthew G Knepley .seealso: PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitSetIS()
178957a9adfeSMatthew G Knepley 
179057a9adfeSMatthew G Knepley @*/
179157a9adfeSMatthew G Knepley PetscErrorCode PCFieldSplitGetIS(PC pc,const char splitname[],IS *is)
179257a9adfeSMatthew G Knepley {
179357a9adfeSMatthew G Knepley   PetscErrorCode ierr;
179457a9adfeSMatthew G Knepley 
179557a9adfeSMatthew G Knepley   PetscFunctionBegin;
179657a9adfeSMatthew G Knepley   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
179757a9adfeSMatthew G Knepley   PetscValidCharPointer(splitname,2);
179857a9adfeSMatthew G Knepley   PetscValidPointer(is,3);
179957a9adfeSMatthew G Knepley   {
180057a9adfeSMatthew G Knepley     PC_FieldSplit     *jac  = (PC_FieldSplit*) pc->data;
180157a9adfeSMatthew G Knepley     PC_FieldSplitLink ilink = jac->head;
180257a9adfeSMatthew G Knepley     PetscBool         found;
180357a9adfeSMatthew G Knepley 
18040298fd71SBarry Smith     *is = NULL;
180557a9adfeSMatthew G Knepley     while (ilink) {
180657a9adfeSMatthew G Knepley       ierr = PetscStrcmp(ilink->splitname, splitname, &found);CHKERRQ(ierr);
180757a9adfeSMatthew G Knepley       if (found) {
180857a9adfeSMatthew G Knepley         *is = ilink->is;
180957a9adfeSMatthew G Knepley         break;
181057a9adfeSMatthew G Knepley       }
181157a9adfeSMatthew G Knepley       ilink = ilink->next;
181257a9adfeSMatthew G Knepley     }
181357a9adfeSMatthew G Knepley   }
181457a9adfeSMatthew G Knepley   PetscFunctionReturn(0);
181557a9adfeSMatthew G Knepley }
181657a9adfeSMatthew G Knepley 
181757a9adfeSMatthew G Knepley #undef __FUNCT__
181851f519a2SBarry Smith #define __FUNCT__ "PCFieldSplitSetBlockSize"
181951f519a2SBarry Smith /*@
182051f519a2SBarry Smith     PCFieldSplitSetBlockSize - Sets the block size for defining where fields start in the
182151f519a2SBarry Smith       fieldsplit preconditioner. If not set the matrix block size is used.
182251f519a2SBarry Smith 
1823ad4df100SBarry Smith     Logically Collective on PC
182451f519a2SBarry Smith 
182551f519a2SBarry Smith     Input Parameters:
182651f519a2SBarry Smith +   pc  - the preconditioner context
182751f519a2SBarry Smith -   bs - the block size
182851f519a2SBarry Smith 
182951f519a2SBarry Smith     Level: intermediate
183051f519a2SBarry Smith 
183151f519a2SBarry Smith .seealso: PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitSetFields()
183251f519a2SBarry Smith 
183351f519a2SBarry Smith @*/
18347087cfbeSBarry Smith PetscErrorCode  PCFieldSplitSetBlockSize(PC pc,PetscInt bs)
183551f519a2SBarry Smith {
18364ac538c5SBarry Smith   PetscErrorCode ierr;
183751f519a2SBarry Smith 
183851f519a2SBarry Smith   PetscFunctionBegin;
18390700a824SBarry Smith   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
1840c5eb9154SBarry Smith   PetscValidLogicalCollectiveInt(pc,bs,2);
18414ac538c5SBarry Smith   ierr = PetscTryMethod(pc,"PCFieldSplitSetBlockSize_C",(PC,PetscInt),(pc,bs));CHKERRQ(ierr);
184251f519a2SBarry Smith   PetscFunctionReturn(0);
184351f519a2SBarry Smith }
184451f519a2SBarry Smith 
184551f519a2SBarry Smith #undef __FUNCT__
184669a612a9SBarry Smith #define __FUNCT__ "PCFieldSplitGetSubKSP"
18470971522cSBarry Smith /*@C
184869a612a9SBarry Smith    PCFieldSplitGetSubKSP - Gets the KSP contexts for all splits
18490971522cSBarry Smith 
185069a612a9SBarry Smith    Collective on KSP
18510971522cSBarry Smith 
18520971522cSBarry Smith    Input Parameter:
18530971522cSBarry Smith .  pc - the preconditioner context
18540971522cSBarry Smith 
18550971522cSBarry Smith    Output Parameters:
185613e0d083SBarry Smith +  n - the number of splits
185769a612a9SBarry Smith -  pc - the array of KSP contexts
18580971522cSBarry Smith 
18590971522cSBarry Smith    Note:
1860d32f9abdSBarry Smith    After PCFieldSplitGetSubKSP() the array of KSPs IS to be freed by the user
1861d32f9abdSBarry Smith    (not the KSP just the array that contains them).
18620971522cSBarry Smith 
186369a612a9SBarry Smith    You must call KSPSetUp() before calling PCFieldSplitGetSubKSP().
18640971522cSBarry Smith 
1865196cc216SBarry Smith    Fortran Usage: You must pass in a KSP array that is large enough to contain all the local KSPs.
18660298fd71SBarry Smith       You can call PCFieldSplitGetSubKSP(pc,n,NULL_OBJECT,ierr) to determine how large the
1867196cc216SBarry Smith       KSP array must be.
1868196cc216SBarry Smith 
1869196cc216SBarry Smith 
18700971522cSBarry Smith    Level: advanced
18710971522cSBarry Smith 
18720971522cSBarry Smith .seealso: PCFIELDSPLIT
18730971522cSBarry Smith @*/
18747087cfbeSBarry Smith PetscErrorCode  PCFieldSplitGetSubKSP(PC pc,PetscInt *n,KSP *subksp[])
18750971522cSBarry Smith {
18764ac538c5SBarry Smith   PetscErrorCode ierr;
18770971522cSBarry Smith 
18780971522cSBarry Smith   PetscFunctionBegin;
18790700a824SBarry Smith   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
188013e0d083SBarry Smith   if (n) PetscValidIntPointer(n,2);
18814ac538c5SBarry Smith   ierr = PetscUseMethod(pc,"PCFieldSplitGetSubKSP_C",(PC,PetscInt*,KSP **),(pc,n,subksp));CHKERRQ(ierr);
18820971522cSBarry Smith   PetscFunctionReturn(0);
18830971522cSBarry Smith }
18840971522cSBarry Smith 
1885e69d4d44SBarry Smith #undef __FUNCT__
188629f8a81cSJed Brown #define __FUNCT__ "PCFieldSplitSetSchurPre"
1887e69d4d44SBarry Smith /*@
188829f8a81cSJed Brown     PCFieldSplitSetSchurPre -  Indicates if the Schur complement is preconditioned by a preconditioner constructed by the
1889a04f6461SBarry Smith       A11 matrix. Otherwise no preconditioner is used.
1890e69d4d44SBarry Smith 
1891e69d4d44SBarry Smith     Collective on PC
1892e69d4d44SBarry Smith 
1893e69d4d44SBarry Smith     Input Parameters:
1894e69d4d44SBarry Smith +   pc      - the preconditioner context
18956fdd48a9SBarry 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
18966fdd48a9SBarry Smith               PC_FIELDSPLIT_SCHUR_PRE_SELFP, and PC_FIELDSPLIT_SCHUR_PRE_FULL
18970298fd71SBarry Smith -   userpre - matrix to use for preconditioning, or NULL
1898084e4875SJed Brown 
1899e69d4d44SBarry Smith     Options Database:
19006fdd48a9SBarry Smith .     -pc_fieldsplit_schur_precondition <self,selfp,user,a11,full> - default is a11. See notes for meaning of various arguments
1901e69d4d44SBarry Smith 
1902fd1303e9SJungho Lee     Notes:
1903fd1303e9SJungho Lee $    If ptype is
1904a6a584a2SBarry Smith $        a11 then the preconditioner for the Schur complement is generated from the block diagonal part of the preconditioner
1905585af1b9SMatthew G. Knepley $             matrix associated with the Schur complement (i.e. A11), not he Schur complement matrix
1906a6a584a2SBarry Smith $        self the preconditioner for the Schur complement is generated from the symbolic representation of the Schur complement matrix:
1907a6a584a2SBarry Smith $             The only preconditioner that currently works with this symbolic respresentation matrix object is the PCLSC
1908fd1303e9SJungho Lee $             preconditioner
19096fdd48a9SBarry Smith $        user then the preconditioner for the Schur complement is generated from the user provided matrix (pre argument
19106fdd48a9SBarry Smith $             to this function).
1911a6a584a2SBarry Smith $        selfp then the preconditioning for the Schur complement is generated from an explicitly-assembled approximation Sp = A11 - A10 inv(diag(A00)) A01
19121d71051fSDmitry Karpeev $             This is only a good preconditioner when diag(A00) is a good preconditioner for A00. Optionally, A00 can be
19136fdd48a9SBarry Smith $             lumped before extracting the diagonal using the additional option -fieldsplit_1_mat_schur_complement_ainv_type lump
19146fdd48a9SBarry 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)
19156fdd48a9SBarry Smith $             useful mostly as a test that the Schur complement approach can work for your problem
1916fd1303e9SJungho Lee 
1917e87fab1bSBarry Smith      When solving a saddle point problem, where the A11 block is identically zero, using a11 as the ptype only makes sense
1918fd1303e9SJungho Lee     with the additional option -fieldsplit_1_pc_type none. Usually for saddle point problems one would use a ptype of self and
1919a7476a74SDmitry Karpeev     -fieldsplit_1_pc_type lsc which uses the least squares commutator to compute a preconditioner for the Schur complement.
1920fd1303e9SJungho Lee 
1921e69d4d44SBarry Smith     Level: intermediate
1922e69d4d44SBarry Smith 
19231d71051fSDmitry Karpeev .seealso: PCFieldSplitGetSchurPre(), PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitSetFields(), PCFieldSplitSchurPreType,
19241d71051fSDmitry Karpeev           MatSchurComplementSetAinvType(), PCLSC
1925e69d4d44SBarry Smith 
1926e69d4d44SBarry Smith @*/
192729f8a81cSJed Brown PetscErrorCode PCFieldSplitSetSchurPre(PC pc,PCFieldSplitSchurPreType ptype,Mat pre)
1928e69d4d44SBarry Smith {
19294ac538c5SBarry Smith   PetscErrorCode ierr;
1930e69d4d44SBarry Smith 
1931e69d4d44SBarry Smith   PetscFunctionBegin;
19320700a824SBarry Smith   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
193329f8a81cSJed Brown   ierr = PetscTryMethod(pc,"PCFieldSplitSetSchurPre_C",(PC,PCFieldSplitSchurPreType,Mat),(pc,ptype,pre));CHKERRQ(ierr);
1934e69d4d44SBarry Smith   PetscFunctionReturn(0);
1935e69d4d44SBarry Smith }
193629f8a81cSJed Brown PetscErrorCode PCFieldSplitSchurPrecondition(PC pc,PCFieldSplitSchurPreType ptype,Mat pre) {return PCFieldSplitSetSchurPre(pc,ptype,pre);} /* Deprecated name */
1937e69d4d44SBarry Smith 
1938e69d4d44SBarry Smith #undef __FUNCT__
193937a82bf0SJed Brown #define __FUNCT__ "PCFieldSplitGetSchurPre"
194037a82bf0SJed Brown /*@
194137a82bf0SJed Brown     PCFieldSplitGetSchurPre - For Schur complement fieldsplit, determine how the Schur complement will be
194229f8a81cSJed Brown     preconditioned.  See PCFieldSplitSetSchurPre() for details.
194337a82bf0SJed Brown 
194437a82bf0SJed Brown     Logically Collective on PC
194537a82bf0SJed Brown 
194637a82bf0SJed Brown     Input Parameters:
194737a82bf0SJed Brown .   pc      - the preconditioner context
194837a82bf0SJed Brown 
194937a82bf0SJed Brown     Output Parameters:
195037a82bf0SJed 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
195137a82bf0SJed Brown -   userpre - matrix to use for preconditioning (with PC_FIELDSPLIT_PRE_USER), or NULL
195237a82bf0SJed Brown 
195337a82bf0SJed Brown     Level: intermediate
195437a82bf0SJed Brown 
195529f8a81cSJed Brown .seealso: PCFieldSplitSetSchurPre(), PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitSetFields(), PCFieldSplitSchurPreType, PCLSC
195637a82bf0SJed Brown 
195737a82bf0SJed Brown @*/
195837a82bf0SJed Brown PetscErrorCode PCFieldSplitGetSchurPre(PC pc,PCFieldSplitSchurPreType *ptype,Mat *pre)
195937a82bf0SJed Brown {
196037a82bf0SJed Brown   PetscErrorCode ierr;
196137a82bf0SJed Brown 
196237a82bf0SJed Brown   PetscFunctionBegin;
196337a82bf0SJed Brown   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
196437a82bf0SJed Brown   ierr = PetscUseMethod(pc,"PCFieldSplitGetSchurPre_C",(PC,PCFieldSplitSchurPreType*,Mat*),(pc,ptype,pre));CHKERRQ(ierr);
1965e69d4d44SBarry Smith   PetscFunctionReturn(0);
1966e69d4d44SBarry Smith }
1967e69d4d44SBarry Smith 
1968e69d4d44SBarry Smith #undef __FUNCT__
1969470b340bSDmitry Karpeev #define __FUNCT__ "PCFieldSplitSchurGetS"
197045e7fc46SDmitry Karpeev /*@
1971470b340bSDmitry Karpeev     PCFieldSplitSchurGetS -  extract the MatSchurComplement object used by this PC in case it needs to be configured separately
197245e7fc46SDmitry Karpeev 
197345e7fc46SDmitry Karpeev     Not collective
197445e7fc46SDmitry Karpeev 
197545e7fc46SDmitry Karpeev     Input Parameter:
197645e7fc46SDmitry Karpeev .   pc      - the preconditioner context
197745e7fc46SDmitry Karpeev 
197845e7fc46SDmitry Karpeev     Output Parameter:
1979470b340bSDmitry Karpeev .   S       - the Schur complement matrix
198045e7fc46SDmitry Karpeev 
1981470b340bSDmitry Karpeev     Notes:
1982470b340bSDmitry Karpeev     This matrix should not be destroyed using MatDestroy(); rather, use PCFieldSplitSchurRestoreS().
198345e7fc46SDmitry Karpeev 
198445e7fc46SDmitry Karpeev     Level: advanced
198545e7fc46SDmitry Karpeev 
198629f8a81cSJed Brown .seealso: PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitSchurPreType, PCFieldSplitSetSchurPre(), MatSchurComplement, PCFieldSplitSchurRestoreS()
198745e7fc46SDmitry Karpeev 
198845e7fc46SDmitry Karpeev @*/
1989470b340bSDmitry Karpeev PetscErrorCode  PCFieldSplitSchurGetS(PC pc,Mat *S)
199045e7fc46SDmitry Karpeev {
199145e7fc46SDmitry Karpeev   PetscErrorCode ierr;
199245e7fc46SDmitry Karpeev   const char*    t;
199345e7fc46SDmitry Karpeev   PetscBool      isfs;
199445e7fc46SDmitry Karpeev   PC_FieldSplit  *jac;
199545e7fc46SDmitry Karpeev 
199645e7fc46SDmitry Karpeev   PetscFunctionBegin;
199745e7fc46SDmitry Karpeev   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
199845e7fc46SDmitry Karpeev   ierr = PetscObjectGetType((PetscObject)pc,&t);CHKERRQ(ierr);
199945e7fc46SDmitry Karpeev   ierr = PetscStrcmp(t,PCFIELDSPLIT,&isfs);CHKERRQ(ierr);
200045e7fc46SDmitry Karpeev   if (!isfs) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Expected PC of type PCFIELDSPLIT, got %s instead",t);
200145e7fc46SDmitry Karpeev   jac = (PC_FieldSplit*)pc->data;
2002470b340bSDmitry 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);
2003470b340bSDmitry Karpeev   if (S) *S = jac->schur;
200445e7fc46SDmitry Karpeev   PetscFunctionReturn(0);
200545e7fc46SDmitry Karpeev }
200645e7fc46SDmitry Karpeev 
200745e7fc46SDmitry Karpeev #undef __FUNCT__
2008470b340bSDmitry Karpeev #define __FUNCT__ "PCFieldSplitSchurRestoreS"
2009470b340bSDmitry Karpeev /*@
2010470b340bSDmitry Karpeev     PCFieldSplitSchurRestoreS -  restores the MatSchurComplement object used by this PC
2011470b340bSDmitry Karpeev 
2012470b340bSDmitry Karpeev     Not collective
2013470b340bSDmitry Karpeev 
2014470b340bSDmitry Karpeev     Input Parameters:
2015470b340bSDmitry Karpeev +   pc      - the preconditioner context
2016470b340bSDmitry Karpeev .   S       - the Schur complement matrix
2017470b340bSDmitry Karpeev 
2018470b340bSDmitry Karpeev     Level: advanced
2019470b340bSDmitry Karpeev 
202029f8a81cSJed Brown .seealso: PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitSchurPreType, PCFieldSplitSetSchurPre(), MatSchurComplement, PCFieldSplitSchurGetS()
2021470b340bSDmitry Karpeev 
2022470b340bSDmitry Karpeev @*/
2023bca69d2bSDmitry Karpeev PetscErrorCode  PCFieldSplitSchurRestoreS(PC pc,Mat *S)
2024470b340bSDmitry Karpeev {
2025470b340bSDmitry Karpeev   PetscErrorCode ierr;
2026470b340bSDmitry Karpeev   const char*    t;
2027470b340bSDmitry Karpeev   PetscBool      isfs;
2028470b340bSDmitry Karpeev   PC_FieldSplit  *jac;
2029470b340bSDmitry Karpeev 
2030470b340bSDmitry Karpeev   PetscFunctionBegin;
2031470b340bSDmitry Karpeev   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
2032470b340bSDmitry Karpeev   ierr = PetscObjectGetType((PetscObject)pc,&t);CHKERRQ(ierr);
2033470b340bSDmitry Karpeev   ierr = PetscStrcmp(t,PCFIELDSPLIT,&isfs);CHKERRQ(ierr);
2034470b340bSDmitry Karpeev   if (!isfs) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Expected PC of type PCFIELDSPLIT, got %s instead",t);
2035470b340bSDmitry Karpeev   jac = (PC_FieldSplit*)pc->data;
2036470b340bSDmitry 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);
2037bca69d2bSDmitry Karpeev   if (!S || *S != jac->schur) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"MatSchurComplement restored is not the same as gotten");
2038470b340bSDmitry Karpeev   PetscFunctionReturn(0);
2039470b340bSDmitry Karpeev }
2040470b340bSDmitry Karpeev 
2041470b340bSDmitry Karpeev 
2042470b340bSDmitry Karpeev #undef __FUNCT__
204329f8a81cSJed Brown #define __FUNCT__ "PCFieldSplitSetSchurPre_FieldSplit"
204429f8a81cSJed Brown static PetscErrorCode  PCFieldSplitSetSchurPre_FieldSplit(PC pc,PCFieldSplitSchurPreType ptype,Mat pre)
2045e69d4d44SBarry Smith {
2046e69d4d44SBarry Smith   PC_FieldSplit  *jac = (PC_FieldSplit*)pc->data;
2047084e4875SJed Brown   PetscErrorCode ierr;
2048e69d4d44SBarry Smith 
2049e69d4d44SBarry Smith   PetscFunctionBegin;
2050084e4875SJed Brown   jac->schurpre = ptype;
2051a7476a74SDmitry Karpeev   if (ptype == PC_FIELDSPLIT_SCHUR_PRE_USER && pre) {
20526bf464f9SBarry Smith     ierr            = MatDestroy(&jac->schur_user);CHKERRQ(ierr);
2053084e4875SJed Brown     jac->schur_user = pre;
2054084e4875SJed Brown     ierr            = PetscObjectReference((PetscObject)jac->schur_user);CHKERRQ(ierr);
2055084e4875SJed Brown   }
2056e69d4d44SBarry Smith   PetscFunctionReturn(0);
2057e69d4d44SBarry Smith }
2058e69d4d44SBarry Smith 
205930ad9308SMatthew Knepley #undef __FUNCT__
206037a82bf0SJed Brown #define __FUNCT__ "PCFieldSplitGetSchurPre_FieldSplit"
206137a82bf0SJed Brown static PetscErrorCode  PCFieldSplitGetSchurPre_FieldSplit(PC pc,PCFieldSplitSchurPreType *ptype,Mat *pre)
206237a82bf0SJed Brown {
206337a82bf0SJed Brown   PC_FieldSplit  *jac = (PC_FieldSplit*)pc->data;
206437a82bf0SJed Brown 
206537a82bf0SJed Brown   PetscFunctionBegin;
206637a82bf0SJed Brown   *ptype = jac->schurpre;
206737a82bf0SJed Brown   *pre   = jac->schur_user;
206837a82bf0SJed Brown   PetscFunctionReturn(0);
206937a82bf0SJed Brown }
207037a82bf0SJed Brown 
207137a82bf0SJed Brown #undef __FUNCT__
2072c9c6ffaaSJed Brown #define __FUNCT__ "PCFieldSplitSetSchurFactType"
2073ab1df9f5SJed Brown /*@
2074c9c6ffaaSJed Brown     PCFieldSplitSetSchurFactType -  sets which blocks of the approximate block factorization to retain
2075ab1df9f5SJed Brown 
2076ab1df9f5SJed Brown     Collective on PC
2077ab1df9f5SJed Brown 
2078ab1df9f5SJed Brown     Input Parameters:
2079ab1df9f5SJed Brown +   pc  - the preconditioner context
2080c9c6ffaaSJed Brown -   ftype - which blocks of factorization to retain, PC_FIELDSPLIT_SCHUR_FACT_FULL is default
2081ab1df9f5SJed Brown 
2082ab1df9f5SJed Brown     Options Database:
2083c9c6ffaaSJed Brown .     -pc_fieldsplit_schur_fact_type <diag,lower,upper,full> default is full
2084ab1df9f5SJed Brown 
2085ab1df9f5SJed Brown 
2086ab1df9f5SJed Brown     Level: intermediate
2087ab1df9f5SJed Brown 
2088ab1df9f5SJed Brown     Notes:
2089ab1df9f5SJed Brown     The FULL factorization is
2090ab1df9f5SJed Brown 
2091ab1df9f5SJed Brown $   (A   B)  = (1       0) (A   0) (1  Ainv*B)
2092ab1df9f5SJed Brown $   (C   D)    (C*Ainv  1) (0   S) (0     1  )
2093ab1df9f5SJed Brown 
20946be4592eSBarry Smith     where S = D - C*Ainv*B. In practice, the full factorization is applied via block triangular solves with the grouping L*(D*U). UPPER uses D*U, LOWER uses L*D,
20956be4592eSBarry Smith     and DIAG is the diagonal part with the sign of S flipped (because this makes the preconditioner positive definite for many formulations, thus allowing the use of KSPMINRES).
2096ab1df9f5SJed Brown 
20976be4592eSBarry Smith     If applied exactly, FULL factorization is a direct solver. The preconditioned operator with LOWER or UPPER has all eigenvalues equal to 1 and minimal polynomial
20986be4592eSBarry Smith     of degree 2, so KSPGMRES converges in 2 iterations. If the iteration count is very low, consider using KSPFGMRES or KSPGCR which can use one less preconditioner
20996be4592eSBarry Smith     application in this case. Note that the preconditioned operator may be highly non-normal, so such fast convergence may not be observed in practice. With DIAG,
21006be4592eSBarry Smith     the preconditioned operator has three distinct nonzero eigenvalues and minimal polynomial of degree at most 4, so KSPGMRES converges in at most 4 iterations.
2101ab1df9f5SJed Brown 
21026be4592eSBarry Smith     For symmetric problems in which A is positive definite and S is negative definite, DIAG can be used with KSPMINRES. Note that a flexible method like KSPFGMRES
21036be4592eSBarry Smith     or KSPGCR must be used if the fieldsplit preconditioner is nonlinear (e.g. a few iterations of a Krylov method is used inside a split).
2104ab1df9f5SJed Brown 
2105ab1df9f5SJed Brown     References:
210696a0c994SBarry Smith +   1. - Murphy, Golub, and Wathen, A note on preconditioning indefinite linear systems, SIAM J. Sci. Comput., 21 (2000).
210796a0c994SBarry Smith -   2. - Ipsen, A note on preconditioning nonsymmetric matrices, SIAM J. Sci. Comput., 23 (2001).
2108ab1df9f5SJed Brown 
2109ab1df9f5SJed Brown .seealso: PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitSetFields(), PCFieldSplitSchurPreType
2110ab1df9f5SJed Brown @*/
2111c9c6ffaaSJed Brown PetscErrorCode  PCFieldSplitSetSchurFactType(PC pc,PCFieldSplitSchurFactType ftype)
2112ab1df9f5SJed Brown {
2113ab1df9f5SJed Brown   PetscErrorCode ierr;
2114ab1df9f5SJed Brown 
2115ab1df9f5SJed Brown   PetscFunctionBegin;
2116ab1df9f5SJed Brown   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
2117c9c6ffaaSJed Brown   ierr = PetscTryMethod(pc,"PCFieldSplitSetSchurFactType_C",(PC,PCFieldSplitSchurFactType),(pc,ftype));CHKERRQ(ierr);
2118ab1df9f5SJed Brown   PetscFunctionReturn(0);
2119ab1df9f5SJed Brown }
2120ab1df9f5SJed Brown 
2121ab1df9f5SJed Brown #undef __FUNCT__
2122c9c6ffaaSJed Brown #define __FUNCT__ "PCFieldSplitSetSchurFactType_FieldSplit"
21231e6b0712SBarry Smith static PetscErrorCode PCFieldSplitSetSchurFactType_FieldSplit(PC pc,PCFieldSplitSchurFactType ftype)
2124ab1df9f5SJed Brown {
2125ab1df9f5SJed Brown   PC_FieldSplit *jac = (PC_FieldSplit*)pc->data;
2126ab1df9f5SJed Brown 
2127ab1df9f5SJed Brown   PetscFunctionBegin;
2128ab1df9f5SJed Brown   jac->schurfactorization = ftype;
2129ab1df9f5SJed Brown   PetscFunctionReturn(0);
2130ab1df9f5SJed Brown }
2131ab1df9f5SJed Brown 
2132ab1df9f5SJed Brown #undef __FUNCT__
213330ad9308SMatthew Knepley #define __FUNCT__ "PCFieldSplitGetSchurBlocks"
213430ad9308SMatthew Knepley /*@C
21358c03b21aSDmitry Karpeev    PCFieldSplitGetSchurBlocks - Gets all matrix blocks for the Schur complement
213630ad9308SMatthew Knepley 
213730ad9308SMatthew Knepley    Collective on KSP
213830ad9308SMatthew Knepley 
213930ad9308SMatthew Knepley    Input Parameter:
214030ad9308SMatthew Knepley .  pc - the preconditioner context
214130ad9308SMatthew Knepley 
214230ad9308SMatthew Knepley    Output Parameters:
2143a04f6461SBarry Smith +  A00 - the (0,0) block
2144a04f6461SBarry Smith .  A01 - the (0,1) block
2145a04f6461SBarry Smith .  A10 - the (1,0) block
2146a04f6461SBarry Smith -  A11 - the (1,1) block
214730ad9308SMatthew Knepley 
214830ad9308SMatthew Knepley    Level: advanced
214930ad9308SMatthew Knepley 
215030ad9308SMatthew Knepley .seealso: PCFIELDSPLIT
215130ad9308SMatthew Knepley @*/
2152a04f6461SBarry Smith PetscErrorCode  PCFieldSplitGetSchurBlocks(PC pc,Mat *A00,Mat *A01,Mat *A10, Mat *A11)
215330ad9308SMatthew Knepley {
215430ad9308SMatthew Knepley   PC_FieldSplit *jac = (PC_FieldSplit*) pc->data;
215530ad9308SMatthew Knepley 
215630ad9308SMatthew Knepley   PetscFunctionBegin;
21570700a824SBarry Smith   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
2158ce94432eSBarry Smith   if (jac->type != PC_COMPOSITE_SCHUR) SETERRQ(PetscObjectComm((PetscObject)pc),PETSC_ERR_ARG_WRONG, "FieldSplit is not using a Schur complement approach.");
2159a04f6461SBarry Smith   if (A00) *A00 = jac->pmat[0];
2160a04f6461SBarry Smith   if (A01) *A01 = jac->B;
2161a04f6461SBarry Smith   if (A10) *A10 = jac->C;
2162a04f6461SBarry Smith   if (A11) *A11 = jac->pmat[1];
216330ad9308SMatthew Knepley   PetscFunctionReturn(0);
216430ad9308SMatthew Knepley }
216530ad9308SMatthew Knepley 
216679416396SBarry Smith #undef __FUNCT__
216779416396SBarry Smith #define __FUNCT__ "PCFieldSplitSetType_FieldSplit"
21681e6b0712SBarry Smith static PetscErrorCode  PCFieldSplitSetType_FieldSplit(PC pc,PCCompositeType type)
216979416396SBarry Smith {
217079416396SBarry Smith   PC_FieldSplit  *jac = (PC_FieldSplit*)pc->data;
2171e69d4d44SBarry Smith   PetscErrorCode ierr;
217279416396SBarry Smith 
217379416396SBarry Smith   PetscFunctionBegin;
217479416396SBarry Smith   jac->type = type;
21753b224e63SBarry Smith   if (type == PC_COMPOSITE_SCHUR) {
21763b224e63SBarry Smith     pc->ops->apply = PCApply_FieldSplit_Schur;
21773b224e63SBarry Smith     pc->ops->view  = PCView_FieldSplit_Schur;
21782fa5cd67SKarl Rupp 
2179bdf89e91SBarry Smith     ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitGetSubKSP_C",PCFieldSplitGetSubKSP_FieldSplit_Schur);CHKERRQ(ierr);
218029f8a81cSJed Brown     ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetSchurPre_C",PCFieldSplitSetSchurPre_FieldSplit);CHKERRQ(ierr);
218137a82bf0SJed Brown     ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitGetSchurPre_C",PCFieldSplitGetSchurPre_FieldSplit);CHKERRQ(ierr);
2182bdf89e91SBarry Smith     ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetSchurFactType_C",PCFieldSplitSetSchurFactType_FieldSplit);CHKERRQ(ierr);
2183e69d4d44SBarry Smith 
21843b224e63SBarry Smith   } else {
21853b224e63SBarry Smith     pc->ops->apply = PCApply_FieldSplit;
21863b224e63SBarry Smith     pc->ops->view  = PCView_FieldSplit;
21872fa5cd67SKarl Rupp 
2188bdf89e91SBarry Smith     ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitGetSubKSP_C",PCFieldSplitGetSubKSP_FieldSplit);CHKERRQ(ierr);
218929f8a81cSJed Brown     ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetSchurPre_C",0);CHKERRQ(ierr);
219037a82bf0SJed Brown     ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitGetSchurPre_C",0);CHKERRQ(ierr);
2191bdf89e91SBarry Smith     ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetSchurFactType_C",0);CHKERRQ(ierr);
21923b224e63SBarry Smith   }
219379416396SBarry Smith   PetscFunctionReturn(0);
219479416396SBarry Smith }
219579416396SBarry Smith 
219651f519a2SBarry Smith #undef __FUNCT__
219751f519a2SBarry Smith #define __FUNCT__ "PCFieldSplitSetBlockSize_FieldSplit"
21981e6b0712SBarry Smith static PetscErrorCode  PCFieldSplitSetBlockSize_FieldSplit(PC pc,PetscInt bs)
219951f519a2SBarry Smith {
220051f519a2SBarry Smith   PC_FieldSplit *jac = (PC_FieldSplit*)pc->data;
220151f519a2SBarry Smith 
220251f519a2SBarry Smith   PetscFunctionBegin;
2203ce94432eSBarry Smith   if (bs < 1) SETERRQ1(PetscObjectComm((PetscObject)pc),PETSC_ERR_ARG_OUTOFRANGE,"Blocksize must be positive, you gave %D",bs);
2204ce94432eSBarry 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);
220551f519a2SBarry Smith   jac->bs = bs;
220651f519a2SBarry Smith   PetscFunctionReturn(0);
220751f519a2SBarry Smith }
220851f519a2SBarry Smith 
220979416396SBarry Smith #undef __FUNCT__
221079416396SBarry Smith #define __FUNCT__ "PCFieldSplitSetType"
2211bc08b0f1SBarry Smith /*@
221279416396SBarry Smith    PCFieldSplitSetType - Sets the type of fieldsplit preconditioner.
221379416396SBarry Smith 
221479416396SBarry Smith    Collective on PC
221579416396SBarry Smith 
221679416396SBarry Smith    Input Parameter:
221779416396SBarry Smith .  pc - the preconditioner context
221881540f2fSBarry Smith .  type - PC_COMPOSITE_ADDITIVE, PC_COMPOSITE_MULTIPLICATIVE (default), PC_COMPOSITE_SYMMETRIC_MULTIPLICATIVE, PC_COMPOSITE_SPECIAL, PC_COMPOSITE_SCHUR
221979416396SBarry Smith 
222079416396SBarry Smith    Options Database Key:
2221a4efd8eaSMatthew Knepley .  -pc_fieldsplit_type <type: one of multiplicative, additive, symmetric_multiplicative, special, schur> - Sets fieldsplit preconditioner type
222279416396SBarry Smith 
2223b02e2d75SMatthew G Knepley    Level: Intermediate
222479416396SBarry Smith 
222579416396SBarry Smith .keywords: PC, set, type, composite preconditioner, additive, multiplicative
222679416396SBarry Smith 
222779416396SBarry Smith .seealso: PCCompositeSetType()
222879416396SBarry Smith 
222979416396SBarry Smith @*/
22307087cfbeSBarry Smith PetscErrorCode  PCFieldSplitSetType(PC pc,PCCompositeType type)
223179416396SBarry Smith {
22324ac538c5SBarry Smith   PetscErrorCode ierr;
223379416396SBarry Smith 
223479416396SBarry Smith   PetscFunctionBegin;
22350700a824SBarry Smith   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
22364ac538c5SBarry Smith   ierr = PetscTryMethod(pc,"PCFieldSplitSetType_C",(PC,PCCompositeType),(pc,type));CHKERRQ(ierr);
223779416396SBarry Smith   PetscFunctionReturn(0);
223879416396SBarry Smith }
223979416396SBarry Smith 
2240b02e2d75SMatthew G Knepley #undef __FUNCT__
2241b02e2d75SMatthew G Knepley #define __FUNCT__ "PCFieldSplitGetType"
2242b02e2d75SMatthew G Knepley /*@
2243b02e2d75SMatthew G Knepley   PCFieldSplitGetType - Gets the type of fieldsplit preconditioner.
2244b02e2d75SMatthew G Knepley 
2245b02e2d75SMatthew G Knepley   Not collective
2246b02e2d75SMatthew G Knepley 
2247b02e2d75SMatthew G Knepley   Input Parameter:
2248b02e2d75SMatthew G Knepley . pc - the preconditioner context
2249b02e2d75SMatthew G Knepley 
2250b02e2d75SMatthew G Knepley   Output Parameter:
2251b02e2d75SMatthew G Knepley . type - PC_COMPOSITE_ADDITIVE, PC_COMPOSITE_MULTIPLICATIVE (default), PC_COMPOSITE_SYMMETRIC_MULTIPLICATIVE, PC_COMPOSITE_SPECIAL, PC_COMPOSITE_SCHUR
2252b02e2d75SMatthew G Knepley 
2253b02e2d75SMatthew G Knepley   Level: Intermediate
2254b02e2d75SMatthew G Knepley 
2255b02e2d75SMatthew G Knepley .keywords: PC, set, type, composite preconditioner, additive, multiplicative
2256b02e2d75SMatthew G Knepley .seealso: PCCompositeSetType()
2257b02e2d75SMatthew G Knepley @*/
2258b02e2d75SMatthew G Knepley PetscErrorCode PCFieldSplitGetType(PC pc, PCCompositeType *type)
2259b02e2d75SMatthew G Knepley {
2260b02e2d75SMatthew G Knepley   PC_FieldSplit *jac = (PC_FieldSplit*) pc->data;
2261b02e2d75SMatthew G Knepley 
2262b02e2d75SMatthew G Knepley   PetscFunctionBegin;
2263b02e2d75SMatthew G Knepley   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
2264b02e2d75SMatthew G Knepley   PetscValidIntPointer(type,2);
2265b02e2d75SMatthew G Knepley   *type = jac->type;
2266b02e2d75SMatthew G Knepley   PetscFunctionReturn(0);
2267b02e2d75SMatthew G Knepley }
2268b02e2d75SMatthew G Knepley 
22694ab8060aSDmitry Karpeev #undef __FUNCT__
22704ab8060aSDmitry Karpeev #define __FUNCT__ "PCFieldSplitSetDMSplits"
22714ab8060aSDmitry Karpeev /*@
22724ab8060aSDmitry Karpeev    PCFieldSplitSetDMSplits - Flags whether DMCreateFieldDecomposition() should be used to define the splits, whenever possible.
22734ab8060aSDmitry Karpeev 
22744ab8060aSDmitry Karpeev    Logically Collective
22754ab8060aSDmitry Karpeev 
22764ab8060aSDmitry Karpeev    Input Parameters:
22774ab8060aSDmitry Karpeev +  pc   - the preconditioner context
22784ab8060aSDmitry Karpeev -  flg  - boolean indicating whether to use field splits defined by the DM
22794ab8060aSDmitry Karpeev 
22804ab8060aSDmitry Karpeev    Options Database Key:
22814ab8060aSDmitry Karpeev .  -pc_fieldsplit_dm_splits
22824ab8060aSDmitry Karpeev 
22834ab8060aSDmitry Karpeev    Level: Intermediate
22844ab8060aSDmitry Karpeev 
22854ab8060aSDmitry Karpeev .keywords: PC, DM, composite preconditioner, additive, multiplicative
22864ab8060aSDmitry Karpeev 
22874ab8060aSDmitry Karpeev .seealso: PCFieldSplitGetDMSplits()
22884ab8060aSDmitry Karpeev 
22894ab8060aSDmitry Karpeev @*/
22904ab8060aSDmitry Karpeev PetscErrorCode  PCFieldSplitSetDMSplits(PC pc,PetscBool flg)
22914ab8060aSDmitry Karpeev {
22924ab8060aSDmitry Karpeev   PC_FieldSplit  *jac = (PC_FieldSplit*)pc->data;
22934ab8060aSDmitry Karpeev   PetscBool      isfs;
22944ab8060aSDmitry Karpeev   PetscErrorCode ierr;
22954ab8060aSDmitry Karpeev 
22964ab8060aSDmitry Karpeev   PetscFunctionBegin;
22974ab8060aSDmitry Karpeev   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
22984ab8060aSDmitry Karpeev   PetscValidLogicalCollectiveBool(pc,flg,2);
22994ab8060aSDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)pc,PCFIELDSPLIT,&isfs);CHKERRQ(ierr);
23004ab8060aSDmitry Karpeev   if (isfs) {
23014ab8060aSDmitry Karpeev     jac->dm_splits = flg;
23024ab8060aSDmitry Karpeev   }
23034ab8060aSDmitry Karpeev   PetscFunctionReturn(0);
23044ab8060aSDmitry Karpeev }
23054ab8060aSDmitry Karpeev 
23064ab8060aSDmitry Karpeev 
23074ab8060aSDmitry Karpeev #undef __FUNCT__
23084ab8060aSDmitry Karpeev #define __FUNCT__ "PCFieldSplitGetDMSplits"
23094ab8060aSDmitry Karpeev /*@
23104ab8060aSDmitry Karpeev    PCFieldSplitGetDMSplits - Returns flag indicating whether DMCreateFieldDecomposition() should be used to define the splits, whenever possible.
23114ab8060aSDmitry Karpeev 
23124ab8060aSDmitry Karpeev    Logically Collective
23134ab8060aSDmitry Karpeev 
23144ab8060aSDmitry Karpeev    Input Parameter:
23154ab8060aSDmitry Karpeev .  pc   - the preconditioner context
23164ab8060aSDmitry Karpeev 
23174ab8060aSDmitry Karpeev    Output Parameter:
23184ab8060aSDmitry Karpeev .  flg  - boolean indicating whether to use field splits defined by the DM
23194ab8060aSDmitry Karpeev 
23204ab8060aSDmitry Karpeev    Level: Intermediate
23214ab8060aSDmitry Karpeev 
23224ab8060aSDmitry Karpeev .keywords: PC, DM, composite preconditioner, additive, multiplicative
23234ab8060aSDmitry Karpeev 
23244ab8060aSDmitry Karpeev .seealso: PCFieldSplitSetDMSplits()
23254ab8060aSDmitry Karpeev 
23264ab8060aSDmitry Karpeev @*/
23274ab8060aSDmitry Karpeev PetscErrorCode  PCFieldSplitGetDMSplits(PC pc,PetscBool* flg)
23284ab8060aSDmitry Karpeev {
23294ab8060aSDmitry Karpeev   PC_FieldSplit  *jac = (PC_FieldSplit*)pc->data;
23304ab8060aSDmitry Karpeev   PetscBool      isfs;
23314ab8060aSDmitry Karpeev   PetscErrorCode ierr;
23324ab8060aSDmitry Karpeev 
23334ab8060aSDmitry Karpeev   PetscFunctionBegin;
23344ab8060aSDmitry Karpeev   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
23354ab8060aSDmitry Karpeev   PetscValidPointer(flg,2);
23364ab8060aSDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)pc,PCFIELDSPLIT,&isfs);CHKERRQ(ierr);
23374ab8060aSDmitry Karpeev   if (isfs) {
23384ab8060aSDmitry Karpeev     if(flg) *flg = jac->dm_splits;
23394ab8060aSDmitry Karpeev   }
23404ab8060aSDmitry Karpeev   PetscFunctionReturn(0);
23414ab8060aSDmitry Karpeev }
23424ab8060aSDmitry Karpeev 
23430971522cSBarry Smith /* -------------------------------------------------------------------------------------*/
23440971522cSBarry Smith /*MC
2345a8c7a070SBarry Smith    PCFIELDSPLIT - Preconditioner created by combining separate preconditioners for individual
2346a04f6461SBarry Smith                   fields or groups of fields. See the users manual section "Solving Block Matrices" for more details.
23470971522cSBarry Smith 
2348edf189efSBarry Smith      To set options on the solvers for each block append -fieldsplit_ to all the PC
2349edf189efSBarry Smith         options database keys. For example, -fieldsplit_pc_type ilu -fieldsplit_pc_factor_levels 1
23500971522cSBarry Smith 
2351a8c7a070SBarry Smith      To set the options on the solvers separate for each block call PCFieldSplitGetSubKSP()
235269a612a9SBarry Smith          and set the options directly on the resulting KSP object
23530971522cSBarry Smith 
23540971522cSBarry Smith    Level: intermediate
23550971522cSBarry Smith 
235679416396SBarry Smith    Options Database Keys:
235781540f2fSBarry Smith +   -pc_fieldsplit_%d_fields <a,b,..> - indicates the fields to be used in the %d'th split
235881540f2fSBarry Smith .   -pc_fieldsplit_default - automatically add any fields to additional splits that have not
235981540f2fSBarry Smith                               been supplied explicitly by -pc_fieldsplit_%d_fields
236081540f2fSBarry Smith .   -pc_fieldsplit_block_size <bs> - size of block that defines fields (i.e. there are bs fields)
23610f188ba9SJed Brown .   -pc_fieldsplit_type <additive,multiplicative,symmetric_multiplicative,schur> - type of relaxation or factorization splitting
2362a6a584a2SBarry Smith .   -pc_fieldsplit_schur_precondition <self,selfp,user,a11,full> - default is a11; see PCFieldSplitSetSchurPre()
2363435f959eSBarry Smith .   -pc_fieldsplit_detect_saddle_point - automatically finds rows with zero or negative diagonal and uses Schur complement with no preconditioner as the solver
236479416396SBarry Smith 
23655d4c12cdSJungho Lee -    Options prefix for inner solvers when using Schur complement preconditioner are -fieldsplit_0_ and -fieldsplit_1_
23665d4c12cdSJungho Lee      for all other solvers they are -fieldsplit_%d_ for the dth field, use -fieldsplit_ for all fields
23675d4c12cdSJungho Lee 
2368c8a0d604SMatthew G Knepley    Notes:
2369c8a0d604SMatthew G Knepley     Use PCFieldSplitSetFields() to set fields defined by "strided" entries and PCFieldSplitSetIS()
2370d32f9abdSBarry Smith      to define a field by an arbitrary collection of entries.
2371d32f9abdSBarry Smith 
2372d32f9abdSBarry Smith       If no fields are set the default is used. The fields are defined by entries strided by bs,
2373d32f9abdSBarry Smith       beginning at 0 then 1, etc to bs-1. The block size can be set with PCFieldSplitSetBlockSize(),
2374d32f9abdSBarry Smith       if this is not called the block size defaults to the blocksize of the second matrix passed
2375d32f9abdSBarry Smith       to KSPSetOperators()/PCSetOperators().
2376d32f9abdSBarry Smith 
2377c8a0d604SMatthew G Knepley $     For the Schur complement preconditioner if J = ( A00 A01 )
2378c8a0d604SMatthew G Knepley $                                                    ( A10 A11 )
2379c8a0d604SMatthew G Knepley $     the preconditioner using full factorization is
238013b05affSJed Brown $              ( I   -ksp(A00) A01 ) ( inv(A00)     0  ) (     I          0  )
2381c8a0d604SMatthew G Knepley $              ( 0         I       ) (   0      ksp(S) ) ( -A10 ksp(A00)  I  )
238213b05affSJed Brown      where the action of inv(A00) is applied using the KSP solver with prefix -fieldsplit_0_.  S is the Schur complement
238313b05affSJed Brown $              S = A11 - A10 ksp(A00) A01
238413b05affSJed 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
2385c8a0d604SMatthew G Knepley      in providing the SECOND split or 1 if not give). For PCFieldSplitGetKSP() when field number is 0,
2386c8a0d604SMatthew G Knepley      it returns the KSP associated with -fieldsplit_0_ while field number 1 gives -fieldsplit_1_ KSP. By default
2387a6a584a2SBarry Smith      A11 is used to construct a preconditioner for S, use PCFieldSplitSetSchurPre() for all the possible ways to construct the preconditioner for S.
23881d71051fSDmitry Karpeev 
2389a7476a74SDmitry Karpeev      The factorization type is set using -pc_fieldsplit_schur_fact_type <diag, lower, upper, full>. The full is shown above,
23905668aaf4SBarry Smith      diag gives
2391c8a0d604SMatthew G Knepley $              ( inv(A00)     0   )
2392c8a0d604SMatthew G Knepley $              (   0      -ksp(S) )
23935668aaf4SBarry Smith      note that slightly counter intuitively there is a negative in front of the ksp(S) so that the preconditioner is positive definite. The lower factorization is the inverse of
2394c8a0d604SMatthew G Knepley $              (  A00   0 )
2395c8a0d604SMatthew G Knepley $              (  A10   S )
2396c8a0d604SMatthew G Knepley      where the inverses of A00 and S are applied using KSPs. The upper factorization is the inverse of
2397c8a0d604SMatthew G Knepley $              ( A00 A01 )
2398c8a0d604SMatthew G Knepley $              (  0   S  )
2399c8a0d604SMatthew G Knepley      where again the inverses of A00 and S are applied using KSPs.
2400e69d4d44SBarry Smith 
2401edf189efSBarry Smith      If only one set of indices (one IS) is provided with PCFieldSplitSetIS() then the complement of that IS
2402edf189efSBarry Smith      is used automatically for a second block.
2403edf189efSBarry Smith 
2404ff218e97SBarry Smith      The fieldsplit preconditioner cannot currently be used with the BAIJ or SBAIJ data formats if the blocksize is larger than 1.
2405ff218e97SBarry Smith      Generally it should be used with the AIJ format.
2406ff218e97SBarry Smith 
2407ff218e97SBarry Smith      The forms of these preconditioners are closely related if not identical to forms derived as "Distributive Iterations", see,
2408ff218e97SBarry Smith      for example, page 294 in "Principles of Computational Fluid Dynamics" by Pieter Wesseling. Note that one can also use PCFIELDSPLIT
2409ff218e97SBarry Smith      inside a smoother resulting in "Distributive Smoothers".
24100716a85fSBarry Smith 
2411a541d17aSBarry Smith    Concepts: physics based preconditioners, block preconditioners
24120971522cSBarry Smith 
24133bc631e0SBarry Smith    There is a nice discussion of block preconditioners in
24143bc631e0SBarry Smith 
24153bc631e0SBarry Smith [El08] A taxonomy and comparison of parallel block multi-level preconditioners for the incompressible Navier-Stokes equations
24163bc631e0SBarry Smith        Howard Elman, V.E. Howle, John Shadid, Robert Shuttleworth, Ray Tuminaro, Journal of Computational Physics 227 (2008) 1790--1808
24173bc631e0SBarry Smith        http://chess.cs.umd.edu/~elman/papers/tax.pdf
24183bc631e0SBarry Smith 
2419a6a584a2SBarry Smith    The Constrained Pressure Preconditioner (CPR) does not appear to be currently implementable directly with PCFIELDSPLIT. CPR solves first the Schur complemented pressure equation, updates the
2420a6a584a2SBarry Smith    residual on all variables and then applies a simple ILU like preconditioner on all the variables. So it is very much like the full Schur complement with selfp representing the Schur complement but instead
2421a6a584a2SBarry Smith    of backsolving for the saturations in the last step it solves a full coupled (ILU) system for updates to all the variables.
2422a6a584a2SBarry Smith 
24237e8cb189SBarry Smith .seealso:  PCCreate(), PCSetType(), PCType (for list of available types), PC, Block_Preconditioners, PCLSC,
24241d71051fSDmitry Karpeev            PCFieldSplitGetSubKSP(), PCFieldSplitSetFields(), PCFieldSplitSetType(), PCFieldSplitSetIS(), PCFieldSplitSetSchurPre(),
24251d71051fSDmitry Karpeev 	   MatSchurComplementSetAinvType()
24260971522cSBarry Smith M*/
24270971522cSBarry Smith 
24280971522cSBarry Smith #undef __FUNCT__
24290971522cSBarry Smith #define __FUNCT__ "PCCreate_FieldSplit"
24308cc058d9SJed Brown PETSC_EXTERN PetscErrorCode PCCreate_FieldSplit(PC pc)
24310971522cSBarry Smith {
24320971522cSBarry Smith   PetscErrorCode ierr;
24330971522cSBarry Smith   PC_FieldSplit  *jac;
24340971522cSBarry Smith 
24350971522cSBarry Smith   PetscFunctionBegin;
2436b00a9115SJed Brown   ierr = PetscNewLog(pc,&jac);CHKERRQ(ierr);
24372fa5cd67SKarl Rupp 
24380971522cSBarry Smith   jac->bs                 = -1;
24390971522cSBarry Smith   jac->nsplits            = 0;
24403e197d65SBarry Smith   jac->type               = PC_COMPOSITE_MULTIPLICATIVE;
2441e6cab6aaSJed Brown   jac->schurpre           = PC_FIELDSPLIT_SCHUR_PRE_USER; /* Try user preconditioner first, fall back on diagonal */
2442c9c6ffaaSJed Brown   jac->schurfactorization = PC_FIELDSPLIT_SCHUR_FACT_FULL;
2443fbe7908bSJed Brown   jac->dm_splits          = PETSC_TRUE;
244451f519a2SBarry Smith 
24450971522cSBarry Smith   pc->data = (void*)jac;
24460971522cSBarry Smith 
24470971522cSBarry Smith   pc->ops->apply           = PCApply_FieldSplit;
2448421e10b8SBarry Smith   pc->ops->applytranspose  = PCApplyTranspose_FieldSplit;
24490971522cSBarry Smith   pc->ops->setup           = PCSetUp_FieldSplit;
2450574deadeSBarry Smith   pc->ops->reset           = PCReset_FieldSplit;
24510971522cSBarry Smith   pc->ops->destroy         = PCDestroy_FieldSplit;
24520971522cSBarry Smith   pc->ops->setfromoptions  = PCSetFromOptions_FieldSplit;
24530971522cSBarry Smith   pc->ops->view            = PCView_FieldSplit;
24540971522cSBarry Smith   pc->ops->applyrichardson = 0;
24550971522cSBarry Smith 
2456bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitGetSubKSP_C",PCFieldSplitGetSubKSP_FieldSplit);CHKERRQ(ierr);
2457bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetFields_C",PCFieldSplitSetFields_FieldSplit);CHKERRQ(ierr);
2458bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetIS_C",PCFieldSplitSetIS_FieldSplit);CHKERRQ(ierr);
2459bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetType_C",PCFieldSplitSetType_FieldSplit);CHKERRQ(ierr);
2460bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetBlockSize_C",PCFieldSplitSetBlockSize_FieldSplit);CHKERRQ(ierr);
24616dbb499eSCian Wilson   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitRestrictIS_C",PCFieldSplitRestrictIS_FieldSplit);CHKERRQ(ierr);
24620971522cSBarry Smith   PetscFunctionReturn(0);
24630971522cSBarry Smith }
24640971522cSBarry Smith 
24650971522cSBarry Smith 
2466a541d17aSBarry Smith 
2467