xref: /petsc/src/ksp/pc/impls/fieldsplit/fieldsplit.c (revision 218d4943ca41a4b1a0eb642c9b5de5a8b4116578)
1dba47a55SKris Buschelman 
2b45d2f2cSJed Brown #include <petsc-private/pcimpl.h>     /*I "petscpc.h" I*/
31e25c274SJed Brown #include <petscdm.h>
40971522cSBarry Smith 
5443836d0SMatthew G Knepley 
62e71c61dSMatthew G. Knepley const char *const PCFieldSplitSchurPreTypes[] = {"SELF","SELFP","A11","USER","FULL","PCFieldSplitSchurPreType","PC_FIELDSPLIT_SCHUR_PRE_",0};
7c9c6ffaaSJed Brown const char *const PCFieldSplitSchurFactTypes[] = {"DIAG","LOWER","UPPER","FULL","PCFieldSplitSchurFactType","PC_FIELDSPLIT_SCHUR_FACT_",0};
8c5d2311dSJed Brown 
90971522cSBarry Smith typedef struct _PC_FieldSplitLink *PC_FieldSplitLink;
100971522cSBarry Smith struct _PC_FieldSplitLink {
1169a612a9SBarry Smith   KSP               ksp;
12443836d0SMatthew G Knepley   Vec               x,y,z;
13db4c96c1SJed Brown   char              *splitname;
140971522cSBarry Smith   PetscInt          nfields;
155d4c12cdSJungho Lee   PetscInt          *fields,*fields_col;
161b9fc7fcSBarry Smith   VecScatter        sctx;
175d4c12cdSJungho Lee   IS                is,is_col;
1851f519a2SBarry Smith   PC_FieldSplitLink next,previous;
190971522cSBarry Smith };
200971522cSBarry Smith 
210971522cSBarry Smith typedef struct {
2268dd23aaSBarry Smith   PCCompositeType type;
23ace3abfcSBarry Smith   PetscBool       defaultsplit;                    /* Flag for a system with a set of 'k' scalar fields with the same layout (and bs = k) */
24ace3abfcSBarry Smith   PetscBool       splitdefined;                    /* Flag is set after the splits have been defined, to prevent more splits from being added */
2530ad9308SMatthew Knepley   PetscInt        bs;                              /* Block size for IS and Mat structures */
2630ad9308SMatthew Knepley   PetscInt        nsplits;                         /* Number of field divisions defined */
2779416396SBarry Smith   Vec             *x,*y,w1,w2;
28519d70e2SJed Brown   Mat             *mat;                            /* The diagonal block for each split */
29519d70e2SJed Brown   Mat             *pmat;                           /* The preconditioning diagonal block for each split */
3030ad9308SMatthew Knepley   Mat             *Afield;                         /* The rows of the matrix associated with each split */
31ace3abfcSBarry Smith   PetscBool       issetup;
322fa5cd67SKarl Rupp 
3330ad9308SMatthew Knepley   /* Only used when Schur complement preconditioning is used */
3430ad9308SMatthew Knepley   Mat                       B;                     /* The (0,1) block */
3530ad9308SMatthew Knepley   Mat                       C;                     /* The (1,0) block */
36443836d0SMatthew G Knepley   Mat                       schur;                 /* The Schur complement S = A11 - A10 A00^{-1} A01, the KSP here, kspinner, is H_1 in [El08] */
37a7476a74SDmitry Karpeev   Mat                       schurp;                /* Assembled approximation to S built by MatSchurComplement to be used as a preconditioning matrix when solving with S */
38084e4875SJed Brown   Mat                       schur_user;            /* User-provided preconditioning matrix for the Schur complement */
39084e4875SJed Brown   PCFieldSplitSchurPreType  schurpre;              /* Determines which preconditioning matrix is used for the Schur complement */
40c9c6ffaaSJed Brown   PCFieldSplitSchurFactType schurfactorization;
4130ad9308SMatthew Knepley   KSP                       kspschur;              /* The solver for S */
42443836d0SMatthew G Knepley   KSP                       kspupper;              /* The solver for A in the upper diagonal part of the factorization (H_2 in [El08]) */
4397bbdb24SBarry Smith   PC_FieldSplitLink         head;
4463ec74ffSBarry Smith   PetscBool                 reset;                  /* indicates PCReset() has been last called on this object, hack */
45c1570756SJed Brown   PetscBool                 suboptionsset;          /* Indicates that the KSPSetFromOptions() has been called on the sub-KSPs */
464ab8060aSDmitry Karpeev   PetscBool                 dm_splits;              /* Whether to use DMCreateFieldDecomposition() whenever possible */
47c84da90fSDmitry Karpeev   PetscBool                 diag_use_amat;          /* Whether to extract diagonal matrix blocks from Amat, rather than Pmat (weaker than -pc_use_amat) */
48c84da90fSDmitry Karpeev   PetscBool                 offdiag_use_amat;       /* Whether to extract off-diagonal matrix blocks from Amat, rather than Pmat (weaker than -pc_use_amat) */
490971522cSBarry Smith } PC_FieldSplit;
500971522cSBarry Smith 
5116913363SBarry Smith /*
5216913363SBarry Smith     Notes: there is no particular reason that pmat, x, and y are stored as arrays in PC_FieldSplit instead of
5316913363SBarry Smith    inside PC_FieldSplitLink, just historical. If you want to be able to add new fields after already using the
5416913363SBarry Smith    PC you could change this.
5516913363SBarry Smith */
56084e4875SJed Brown 
57e6cab6aaSJed Brown /* This helper is so that setting a user-provided preconditioning matrix is orthogonal to choosing to use it.  This way the
58084e4875SJed Brown * application-provided FormJacobian can provide this matrix without interfering with the user's (command-line) choices. */
59084e4875SJed Brown static Mat FieldSplitSchurPre(PC_FieldSplit *jac)
60084e4875SJed Brown {
61084e4875SJed Brown   switch (jac->schurpre) {
62084e4875SJed Brown   case PC_FIELDSPLIT_SCHUR_PRE_SELF: return jac->schur;
63a7476a74SDmitry Karpeev   case PC_FIELDSPLIT_SCHUR_PRE_SELFP: return jac->schurp;
64e87fab1bSBarry Smith   case PC_FIELDSPLIT_SCHUR_PRE_A11: return jac->pmat[1];
65e74569cdSMatthew G. Knepley   case PC_FIELDSPLIT_SCHUR_PRE_FULL: /* We calculate this and store it in schur_user */
66084e4875SJed Brown   case PC_FIELDSPLIT_SCHUR_PRE_USER: /* Use a user-provided matrix if it is given, otherwise diagonal block */
67084e4875SJed Brown   default:
68084e4875SJed Brown     return jac->schur_user ? jac->schur_user : jac->pmat[1];
69084e4875SJed Brown   }
70084e4875SJed Brown }
71084e4875SJed Brown 
72084e4875SJed Brown 
739804daf3SBarry Smith #include <petscdraw.h>
740971522cSBarry Smith #undef __FUNCT__
750971522cSBarry Smith #define __FUNCT__ "PCView_FieldSplit"
760971522cSBarry Smith static PetscErrorCode PCView_FieldSplit(PC pc,PetscViewer viewer)
770971522cSBarry Smith {
780971522cSBarry Smith   PC_FieldSplit     *jac = (PC_FieldSplit*)pc->data;
790971522cSBarry Smith   PetscErrorCode    ierr;
80d9884438SBarry Smith   PetscBool         iascii,isdraw;
810971522cSBarry Smith   PetscInt          i,j;
825a9f2f41SSatish Balay   PC_FieldSplitLink ilink = jac->head;
830971522cSBarry Smith 
840971522cSBarry Smith   PetscFunctionBegin;
85251f4c67SDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&iascii);CHKERRQ(ierr);
86d9884438SBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERDRAW,&isdraw);CHKERRQ(ierr);
870971522cSBarry Smith   if (iascii) {
882c9966d7SBarry Smith     if (jac->bs > 0) {
8951f519a2SBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"  FieldSplit with %s composition: total splits = %D, blocksize = %D\n",PCCompositeTypes[jac->type],jac->nsplits,jac->bs);CHKERRQ(ierr);
902c9966d7SBarry Smith     } else {
912c9966d7SBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"  FieldSplit with %s composition: total splits = %D\n",PCCompositeTypes[jac->type],jac->nsplits);CHKERRQ(ierr);
922c9966d7SBarry Smith     }
93f5236f50SJed Brown     if (pc->useAmat) {
94f5236f50SJed Brown       ierr = PetscViewerASCIIPrintf(viewer,"  using Amat (not Pmat) as operator for blocks\n");CHKERRQ(ierr);
95a3df900dSMatthew G Knepley     }
96c84da90fSDmitry Karpeev     if (jac->diag_use_amat) {
97c84da90fSDmitry Karpeev       ierr = PetscViewerASCIIPrintf(viewer,"  using Amat (not Pmat) as operator for diagonal blocks\n");CHKERRQ(ierr);
98c84da90fSDmitry Karpeev     }
99c84da90fSDmitry Karpeev     if (jac->offdiag_use_amat) {
100c84da90fSDmitry Karpeev       ierr = PetscViewerASCIIPrintf(viewer,"  using Amat (not Pmat) as operator for off-diagonal blocks\n");CHKERRQ(ierr);
101c84da90fSDmitry Karpeev     }
10269a612a9SBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"  Solver info for each split is in the following KSP objects:\n");CHKERRQ(ierr);
1030971522cSBarry Smith     ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
1040971522cSBarry Smith     for (i=0; i<jac->nsplits; i++) {
1051ab39975SBarry Smith       if (ilink->fields) {
1060971522cSBarry Smith         ierr = PetscViewerASCIIPrintf(viewer,"Split number %D Fields ",i);CHKERRQ(ierr);
10779416396SBarry Smith         ierr = PetscViewerASCIIUseTabs(viewer,PETSC_FALSE);CHKERRQ(ierr);
1085a9f2f41SSatish Balay         for (j=0; j<ilink->nfields; j++) {
10979416396SBarry Smith           if (j > 0) {
11079416396SBarry Smith             ierr = PetscViewerASCIIPrintf(viewer,",");CHKERRQ(ierr);
11179416396SBarry Smith           }
1125a9f2f41SSatish Balay           ierr = PetscViewerASCIIPrintf(viewer," %D",ilink->fields[j]);CHKERRQ(ierr);
1130971522cSBarry Smith         }
1140971522cSBarry Smith         ierr = PetscViewerASCIIPrintf(viewer,"\n");CHKERRQ(ierr);
11579416396SBarry Smith         ierr = PetscViewerASCIIUseTabs(viewer,PETSC_TRUE);CHKERRQ(ierr);
1161ab39975SBarry Smith       } else {
1171ab39975SBarry Smith         ierr = PetscViewerASCIIPrintf(viewer,"Split number %D Defined by IS\n",i);CHKERRQ(ierr);
1181ab39975SBarry Smith       }
1195a9f2f41SSatish Balay       ierr  = KSPView(ilink->ksp,viewer);CHKERRQ(ierr);
1205a9f2f41SSatish Balay       ilink = ilink->next;
1210971522cSBarry Smith     }
1220971522cSBarry Smith     ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
1232fa5cd67SKarl Rupp   }
1242fa5cd67SKarl Rupp 
1252fa5cd67SKarl Rupp  if (isdraw) {
126d9884438SBarry Smith     PetscDraw draw;
127d9884438SBarry Smith     PetscReal x,y,w,wd;
128d9884438SBarry Smith 
129d9884438SBarry Smith     ierr = PetscViewerDrawGetDraw(viewer,0,&draw);CHKERRQ(ierr);
130d9884438SBarry Smith     ierr = PetscDrawGetCurrentPoint(draw,&x,&y);CHKERRQ(ierr);
131d9884438SBarry Smith     w    = 2*PetscMin(1.0 - x,x);
132d9884438SBarry Smith     wd   = w/(jac->nsplits + 1);
133d9884438SBarry Smith     x    = x - wd*(jac->nsplits-1)/2.0;
134d9884438SBarry Smith     for (i=0; i<jac->nsplits; i++) {
135d9884438SBarry Smith       ierr  = PetscDrawPushCurrentPoint(draw,x,y);CHKERRQ(ierr);
136d9884438SBarry Smith       ierr  = KSPView(ilink->ksp,viewer);CHKERRQ(ierr);
137d9884438SBarry Smith       ierr  = PetscDrawPopCurrentPoint(draw);CHKERRQ(ierr);
138d9884438SBarry Smith       x    += wd;
139d9884438SBarry Smith       ilink = ilink->next;
140d9884438SBarry Smith     }
1410971522cSBarry Smith   }
1420971522cSBarry Smith   PetscFunctionReturn(0);
1430971522cSBarry Smith }
1440971522cSBarry Smith 
1450971522cSBarry Smith #undef __FUNCT__
1463b224e63SBarry Smith #define __FUNCT__ "PCView_FieldSplit_Schur"
1473b224e63SBarry Smith static PetscErrorCode PCView_FieldSplit_Schur(PC pc,PetscViewer viewer)
1483b224e63SBarry Smith {
1493b224e63SBarry Smith   PC_FieldSplit     *jac = (PC_FieldSplit*)pc->data;
1503b224e63SBarry Smith   PetscErrorCode    ierr;
1514996c5bdSBarry Smith   PetscBool         iascii,isdraw;
1523b224e63SBarry Smith   PetscInt          i,j;
1533b224e63SBarry Smith   PC_FieldSplitLink ilink = jac->head;
1543b224e63SBarry Smith 
1553b224e63SBarry Smith   PetscFunctionBegin;
156251f4c67SDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&iascii);CHKERRQ(ierr);
1574996c5bdSBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERDRAW,&isdraw);CHKERRQ(ierr);
1583b224e63SBarry Smith   if (iascii) {
1592c9966d7SBarry Smith     if (jac->bs > 0) {
160c9c6ffaaSJed Brown       ierr = PetscViewerASCIIPrintf(viewer,"  FieldSplit with Schur preconditioner, blocksize = %D, factorization %s\n",jac->bs,PCFieldSplitSchurFactTypes[jac->schurfactorization]);CHKERRQ(ierr);
1612c9966d7SBarry Smith     } else {
1622c9966d7SBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"  FieldSplit with Schur preconditioner, factorization %s\n",PCFieldSplitSchurFactTypes[jac->schurfactorization]);CHKERRQ(ierr);
1632c9966d7SBarry Smith     }
164f5236f50SJed Brown     if (pc->useAmat) {
165f5236f50SJed Brown       ierr = PetscViewerASCIIPrintf(viewer,"  using Amat (not Pmat) as operator for blocks\n");CHKERRQ(ierr);
166a3df900dSMatthew G Knepley     }
1673e8b8b31SMatthew G Knepley     switch (jac->schurpre) {
1683e8b8b31SMatthew G Knepley     case PC_FIELDSPLIT_SCHUR_PRE_SELF:
1693e8b8b31SMatthew G Knepley       ierr = PetscViewerASCIIPrintf(viewer,"  Preconditioner for the Schur complement formed from S itself\n");CHKERRQ(ierr);break;
170a7476a74SDmitry Karpeev     case PC_FIELDSPLIT_SCHUR_PRE_SELFP:
1719506b623SDmitry Karpeev       ierr = PetscViewerASCIIPrintf(viewer,"  Preconditioner for the Schur complement formed from Sp, an assembled approximation to S, which uses (the lumped) A00's diagonal's inverse\n");CHKERRQ(ierr);break;
172e87fab1bSBarry Smith     case PC_FIELDSPLIT_SCHUR_PRE_A11:
173e87fab1bSBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"  Preconditioner for the Schur complement formed from A11\n");CHKERRQ(ierr);break;
174e74569cdSMatthew G. Knepley     case PC_FIELDSPLIT_SCHUR_PRE_FULL:
175e74569cdSMatthew G. Knepley       ierr = PetscViewerASCIIPrintf(viewer,"  Preconditioner for the Schur complement formed from the exact Schur complement\n");CHKERRQ(ierr);break;
1763e8b8b31SMatthew G Knepley     case PC_FIELDSPLIT_SCHUR_PRE_USER:
1773e8b8b31SMatthew G Knepley       if (jac->schur_user) {
1783e8b8b31SMatthew G Knepley         ierr = PetscViewerASCIIPrintf(viewer,"  Preconditioner for the Schur complement formed from user provided matrix\n");CHKERRQ(ierr);
1793e8b8b31SMatthew G Knepley       } else {
180e87fab1bSBarry Smith         ierr = PetscViewerASCIIPrintf(viewer,"  Preconditioner for the Schur complement formed from A11\n");CHKERRQ(ierr);
1813e8b8b31SMatthew G Knepley       }
1823e8b8b31SMatthew G Knepley       break;
1833e8b8b31SMatthew G Knepley     default:
18482f516ccSBarry Smith       SETERRQ1(PetscObjectComm((PetscObject)pc), PETSC_ERR_ARG_OUTOFRANGE, "Invalid Schur preconditioning type: %d", jac->schurpre);
1853e8b8b31SMatthew G Knepley     }
1863b224e63SBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"  Split info:\n");CHKERRQ(ierr);
1873b224e63SBarry Smith     ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
1883b224e63SBarry Smith     for (i=0; i<jac->nsplits; i++) {
1893b224e63SBarry Smith       if (ilink->fields) {
1903b224e63SBarry Smith         ierr = PetscViewerASCIIPrintf(viewer,"Split number %D Fields ",i);CHKERRQ(ierr);
1913b224e63SBarry Smith         ierr = PetscViewerASCIIUseTabs(viewer,PETSC_FALSE);CHKERRQ(ierr);
1923b224e63SBarry Smith         for (j=0; j<ilink->nfields; j++) {
1933b224e63SBarry Smith           if (j > 0) {
1943b224e63SBarry Smith             ierr = PetscViewerASCIIPrintf(viewer,",");CHKERRQ(ierr);
1953b224e63SBarry Smith           }
1963b224e63SBarry Smith           ierr = PetscViewerASCIIPrintf(viewer," %D",ilink->fields[j]);CHKERRQ(ierr);
1973b224e63SBarry Smith         }
1983b224e63SBarry Smith         ierr = PetscViewerASCIIPrintf(viewer,"\n");CHKERRQ(ierr);
1993b224e63SBarry Smith         ierr = PetscViewerASCIIUseTabs(viewer,PETSC_TRUE);CHKERRQ(ierr);
2003b224e63SBarry Smith       } else {
2013b224e63SBarry Smith         ierr = PetscViewerASCIIPrintf(viewer,"Split number %D Defined by IS\n",i);CHKERRQ(ierr);
2023b224e63SBarry Smith       }
2033b224e63SBarry Smith       ilink = ilink->next;
2043b224e63SBarry Smith     }
205435f959eSBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"KSP solver for A00 block\n");CHKERRQ(ierr);
2063b224e63SBarry Smith     ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
20706de4afeSJed Brown     if (jac->head) {
208443836d0SMatthew G Knepley       ierr = KSPView(jac->head->ksp,viewer);CHKERRQ(ierr);
20906de4afeSJed Brown     } else  {ierr = PetscViewerASCIIPrintf(viewer,"  not yet available\n");CHKERRQ(ierr);}
2103b224e63SBarry Smith     ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
21106de4afeSJed Brown     if (jac->head && jac->kspupper != jac->head->ksp) {
212443836d0SMatthew G Knepley       ierr = PetscViewerASCIIPrintf(viewer,"KSP solver for upper A00 in upper triangular factor \n");CHKERRQ(ierr);
213443836d0SMatthew G Knepley       ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
214b2750c55SJed Brown       if (jac->kspupper) {ierr = KSPView(jac->kspupper,viewer);CHKERRQ(ierr);}
215b2750c55SJed Brown       else {ierr = PetscViewerASCIIPrintf(viewer,"  not yet available\n");CHKERRQ(ierr);}
216443836d0SMatthew G Knepley       ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
217443836d0SMatthew G Knepley     }
218435f959eSBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"KSP solver for S = A11 - A10 inv(A00) A01 \n");CHKERRQ(ierr);
2193b224e63SBarry Smith     ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
22012cae6f2SJed Brown     if (jac->kspschur) {
2213b224e63SBarry Smith       ierr = KSPView(jac->kspschur,viewer);CHKERRQ(ierr);
22212cae6f2SJed Brown     } else {
22312cae6f2SJed Brown       ierr = PetscViewerASCIIPrintf(viewer,"  not yet available\n");CHKERRQ(ierr);
22412cae6f2SJed Brown     }
2253b224e63SBarry Smith     ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
2263b224e63SBarry Smith     ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
22706de4afeSJed Brown   } else if (isdraw && jac->head) {
2284996c5bdSBarry Smith     PetscDraw draw;
2294996c5bdSBarry Smith     PetscReal x,y,w,wd,h;
2304996c5bdSBarry Smith     PetscInt  cnt = 2;
2314996c5bdSBarry Smith     char      str[32];
2324996c5bdSBarry Smith 
2334996c5bdSBarry Smith     ierr = PetscViewerDrawGetDraw(viewer,0,&draw);CHKERRQ(ierr);
2344996c5bdSBarry Smith     ierr = PetscDrawGetCurrentPoint(draw,&x,&y);CHKERRQ(ierr);
235c74581afSBarry Smith     if (jac->kspupper != jac->head->ksp) cnt++;
236c74581afSBarry Smith     w  = 2*PetscMin(1.0 - x,x);
237c74581afSBarry Smith     wd = w/(cnt + 1);
238c74581afSBarry Smith 
2394996c5bdSBarry Smith     ierr = PetscSNPrintf(str,32,"Schur fact. %s",PCFieldSplitSchurFactTypes[jac->schurfactorization]);CHKERRQ(ierr);
2400298fd71SBarry Smith     ierr = PetscDrawBoxedString(draw,x,y,PETSC_DRAW_RED,PETSC_DRAW_BLACK,str,NULL,&h);CHKERRQ(ierr);
2414996c5bdSBarry Smith     y   -= h;
2424996c5bdSBarry Smith     if (jac->schurpre == PC_FIELDSPLIT_SCHUR_PRE_USER &&  !jac->schur_user) {
243e87fab1bSBarry Smith       ierr = PetscSNPrintf(str,32,"Prec. for Schur from %s",PCFieldSplitSchurPreTypes[PC_FIELDSPLIT_SCHUR_PRE_A11]);CHKERRQ(ierr);
2443b224e63SBarry Smith     } else {
2454996c5bdSBarry Smith       ierr = PetscSNPrintf(str,32,"Prec. for Schur from %s",PCFieldSplitSchurPreTypes[jac->schurpre]);CHKERRQ(ierr);
2464996c5bdSBarry Smith     }
2470298fd71SBarry Smith     ierr = PetscDrawBoxedString(draw,x+wd*(cnt-1)/2.0,y,PETSC_DRAW_RED,PETSC_DRAW_BLACK,str,NULL,&h);CHKERRQ(ierr);
2484996c5bdSBarry Smith     y   -= h;
2494996c5bdSBarry Smith     x    = x - wd*(cnt-1)/2.0;
2504996c5bdSBarry Smith 
2514996c5bdSBarry Smith     ierr = PetscDrawPushCurrentPoint(draw,x,y);CHKERRQ(ierr);
2524996c5bdSBarry Smith     ierr = KSPView(jac->head->ksp,viewer);CHKERRQ(ierr);
2534996c5bdSBarry Smith     ierr = PetscDrawPopCurrentPoint(draw);CHKERRQ(ierr);
2544996c5bdSBarry Smith     if (jac->kspupper != jac->head->ksp) {
2554996c5bdSBarry Smith       x   += wd;
2564996c5bdSBarry Smith       ierr = PetscDrawPushCurrentPoint(draw,x,y);CHKERRQ(ierr);
2574996c5bdSBarry Smith       ierr = KSPView(jac->kspupper,viewer);CHKERRQ(ierr);
2584996c5bdSBarry Smith       ierr = PetscDrawPopCurrentPoint(draw);CHKERRQ(ierr);
2594996c5bdSBarry Smith     }
2604996c5bdSBarry Smith     x   += wd;
2614996c5bdSBarry Smith     ierr = PetscDrawPushCurrentPoint(draw,x,y);CHKERRQ(ierr);
2624996c5bdSBarry Smith     ierr = KSPView(jac->kspschur,viewer);CHKERRQ(ierr);
2634996c5bdSBarry Smith     ierr = PetscDrawPopCurrentPoint(draw);CHKERRQ(ierr);
2643b224e63SBarry Smith   }
2653b224e63SBarry Smith   PetscFunctionReturn(0);
2663b224e63SBarry Smith }
2673b224e63SBarry Smith 
2683b224e63SBarry Smith #undef __FUNCT__
2696c924f48SJed Brown #define __FUNCT__ "PCFieldSplitSetRuntimeSplits_Private"
2706c924f48SJed Brown /* Precondition: jac->bs is set to a meaningful value */
2716c924f48SJed Brown static PetscErrorCode PCFieldSplitSetRuntimeSplits_Private(PC pc)
2726c924f48SJed Brown {
2736c924f48SJed Brown   PetscErrorCode ierr;
2746c924f48SJed Brown   PC_FieldSplit  *jac = (PC_FieldSplit*)pc->data;
2755d4c12cdSJungho Lee   PetscInt       i,nfields,*ifields,nfields_col,*ifields_col;
2765d4c12cdSJungho Lee   PetscBool      flg,flg_col;
2775d4c12cdSJungho Lee   char           optionname[128],splitname[8],optionname_col[128];
2786c924f48SJed Brown 
2796c924f48SJed Brown   PetscFunctionBegin;
280785e854fSJed Brown   ierr = PetscMalloc1(jac->bs,&ifields);CHKERRQ(ierr);
281785e854fSJed Brown   ierr = PetscMalloc1(jac->bs,&ifields_col);CHKERRQ(ierr);
2826c924f48SJed Brown   for (i=0,flg=PETSC_TRUE;; i++) {
2838caf3d72SBarry Smith     ierr        = PetscSNPrintf(splitname,sizeof(splitname),"%D",i);CHKERRQ(ierr);
2848caf3d72SBarry Smith     ierr        = PetscSNPrintf(optionname,sizeof(optionname),"-pc_fieldsplit_%D_fields",i);CHKERRQ(ierr);
2858caf3d72SBarry Smith     ierr        = PetscSNPrintf(optionname_col,sizeof(optionname_col),"-pc_fieldsplit_%D_fields_col",i);CHKERRQ(ierr);
2866c924f48SJed Brown     nfields     = jac->bs;
28729499fbbSJungho Lee     nfields_col = jac->bs;
2886c924f48SJed Brown     ierr        = PetscOptionsGetIntArray(((PetscObject)pc)->prefix,optionname,ifields,&nfields,&flg);CHKERRQ(ierr);
2895d4c12cdSJungho Lee     ierr        = PetscOptionsGetIntArray(((PetscObject)pc)->prefix,optionname_col,ifields_col,&nfields_col,&flg_col);CHKERRQ(ierr);
2906c924f48SJed Brown     if (!flg) break;
2915d4c12cdSJungho Lee     else if (flg && !flg_col) {
2925d4c12cdSJungho Lee       if (!nfields) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_USER,"Cannot list zero fields");
2935d4c12cdSJungho Lee       ierr = PCFieldSplitSetFields(pc,splitname,nfields,ifields,ifields);CHKERRQ(ierr);
2942fa5cd67SKarl Rupp     } else {
2955d4c12cdSJungho Lee       if (!nfields || !nfields_col) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_USER,"Cannot list zero fields");
2965d4c12cdSJungho Lee       if (nfields != nfields_col) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_USER,"Number of row and column fields must match");
2975d4c12cdSJungho Lee       ierr = PCFieldSplitSetFields(pc,splitname,nfields,ifields,ifields_col);CHKERRQ(ierr);
2985d4c12cdSJungho Lee     }
2996c924f48SJed Brown   }
3006c924f48SJed Brown   if (i > 0) {
3016c924f48SJed Brown     /* Makes command-line setting of splits take precedence over setting them in code.
3026c924f48SJed Brown        Otherwise subsequent calls to PCFieldSplitSetIS() or PCFieldSplitSetFields() would
3036c924f48SJed Brown        create new splits, which would probably not be what the user wanted. */
3046c924f48SJed Brown     jac->splitdefined = PETSC_TRUE;
3056c924f48SJed Brown   }
3066c924f48SJed Brown   ierr = PetscFree(ifields);CHKERRQ(ierr);
3075d4c12cdSJungho Lee   ierr = PetscFree(ifields_col);CHKERRQ(ierr);
3086c924f48SJed Brown   PetscFunctionReturn(0);
3096c924f48SJed Brown }
3106c924f48SJed Brown 
3116c924f48SJed Brown #undef __FUNCT__
31269a612a9SBarry Smith #define __FUNCT__ "PCFieldSplitSetDefaults"
31369a612a9SBarry Smith static PetscErrorCode PCFieldSplitSetDefaults(PC pc)
3140971522cSBarry Smith {
3150971522cSBarry Smith   PC_FieldSplit     *jac = (PC_FieldSplit*)pc->data;
3160971522cSBarry Smith   PetscErrorCode    ierr;
3175a9f2f41SSatish Balay   PC_FieldSplitLink ilink              = jac->head;
3183a062f41SBarry Smith   PetscBool         fieldsplit_default = PETSC_FALSE,stokes = PETSC_FALSE,coupling = PETSC_FALSE;
3196c924f48SJed Brown   PetscInt          i;
3200971522cSBarry Smith 
3210971522cSBarry Smith   PetscFunctionBegin;
3227287d2a3SDmitry Karpeev   /*
3237287d2a3SDmitry Karpeev    Kinda messy, but at least this now uses DMCreateFieldDecomposition() even with jac->reset.
3247287d2a3SDmitry Karpeev    Should probably be rewritten.
3257287d2a3SDmitry Karpeev    */
3267287d2a3SDmitry Karpeev   if (!ilink || jac->reset) {
3270298fd71SBarry Smith     ierr = PetscOptionsGetBool(((PetscObject)pc)->prefix,"-pc_fieldsplit_detect_saddle_point",&stokes,NULL);CHKERRQ(ierr);
3283a062f41SBarry Smith     ierr = PetscOptionsGetBool(((PetscObject)pc)->prefix,"-pc_fieldsplit_detect_coupling",&coupling,NULL);CHKERRQ(ierr);
3293a062f41SBarry Smith     if (pc->dm && jac->dm_splits && !stokes && !coupling) {
330bafc1b83SMatthew G Knepley       PetscInt  numFields, f, i, j;
3310784a22cSJed Brown       char      **fieldNames;
3327b62db95SJungho Lee       IS        *fields;
333e7c4fc90SDmitry Karpeev       DM        *dms;
334bafc1b83SMatthew G Knepley       DM        subdm[128];
335bafc1b83SMatthew G Knepley       PetscBool flg;
336bafc1b83SMatthew G Knepley 
33716621825SDmitry Karpeev       ierr = DMCreateFieldDecomposition(pc->dm, &numFields, &fieldNames, &fields, &dms);CHKERRQ(ierr);
338bafc1b83SMatthew G Knepley       /* Allow the user to prescribe the splits */
339bafc1b83SMatthew G Knepley       for (i = 0, flg = PETSC_TRUE;; i++) {
340bafc1b83SMatthew G Knepley         PetscInt ifields[128];
341bafc1b83SMatthew G Knepley         IS       compField;
342bafc1b83SMatthew G Knepley         char     optionname[128], splitname[8];
343bafc1b83SMatthew G Knepley         PetscInt nfields = numFields;
344bafc1b83SMatthew G Knepley 
3458caf3d72SBarry Smith         ierr = PetscSNPrintf(optionname, sizeof(optionname), "-pc_fieldsplit_%D_fields", i);CHKERRQ(ierr);
346bafc1b83SMatthew G Knepley         ierr = PetscOptionsGetIntArray(((PetscObject) pc)->prefix, optionname, ifields, &nfields, &flg);CHKERRQ(ierr);
347bafc1b83SMatthew G Knepley         if (!flg) break;
34882f516ccSBarry Smith         if (numFields > 128) SETERRQ1(PetscObjectComm((PetscObject)pc),PETSC_ERR_SUP,"Cannot currently support %d > 128 fields", numFields);
349bafc1b83SMatthew G Knepley         ierr = DMCreateSubDM(pc->dm, nfields, ifields, &compField, &subdm[i]);CHKERRQ(ierr);
350bafc1b83SMatthew G Knepley         if (nfields == 1) {
351bafc1b83SMatthew G Knepley           ierr = PCFieldSplitSetIS(pc, fieldNames[ifields[0]], compField);CHKERRQ(ierr);
35282f516ccSBarry Smith           /* ierr = PetscPrintf(PetscObjectComm((PetscObject)pc), "%s Field Indices:", fieldNames[ifields[0]]);CHKERRQ(ierr);
3530298fd71SBarry Smith              ierr = ISView(compField, NULL);CHKERRQ(ierr); */
354bafc1b83SMatthew G Knepley         } else {
3558caf3d72SBarry Smith           ierr = PetscSNPrintf(splitname, sizeof(splitname), "%D", i);CHKERRQ(ierr);
356bafc1b83SMatthew G Knepley           ierr = PCFieldSplitSetIS(pc, splitname, compField);CHKERRQ(ierr);
35782f516ccSBarry Smith           /* ierr = PetscPrintf(PetscObjectComm((PetscObject)pc), "%s Field Indices:", splitname);CHKERRQ(ierr);
3580298fd71SBarry Smith              ierr = ISView(compField, NULL);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) {
4117287d2a3SDmitry Karpeev           jac->head->is       = rest;
4127287d2a3SDmitry Karpeev           jac->head->next->is = zerodiags;
4132fa5cd67SKarl Rupp         } else {
4146ce1633cSBarry Smith           ierr = PCFieldSplitSetIS(pc,"0",rest);CHKERRQ(ierr);
4156ce1633cSBarry Smith           ierr = PCFieldSplitSetIS(pc,"1",zerodiags);CHKERRQ(ierr);
4167287d2a3SDmitry Karpeev         }
417fcfd50ebSBarry Smith         ierr = ISDestroy(&zerodiags);CHKERRQ(ierr);
418fcfd50ebSBarry Smith         ierr = ISDestroy(&rest);CHKERRQ(ierr);
4193a062f41SBarry Smith       } else if (coupling) {
4203a062f41SBarry Smith         IS       coupling,rest;
4213a062f41SBarry Smith         PetscInt nmin,nmax;
4223a062f41SBarry Smith 
4233a062f41SBarry Smith         ierr = MatGetOwnershipRange(pc->mat,&nmin,&nmax);CHKERRQ(ierr);
4243a062f41SBarry Smith         ierr = MatFindOffBlockDiagonalEntries(pc->mat,&coupling);CHKERRQ(ierr);
4256bea0878SBarry Smith         ierr = ISCreateStride(PetscObjectComm((PetscObject)pc->mat),nmax-nmin,nmin,1,&rest);CHKERRQ(ierr);
426e52d2c62SBarry Smith         ierr = ISSetIdentity(rest);CHKERRQ(ierr);
4273a062f41SBarry Smith         if (jac->reset) {
4283a062f41SBarry Smith           jac->head->is       = coupling;
4293a062f41SBarry Smith           jac->head->next->is = rest;
4303a062f41SBarry Smith         } else {
4313a062f41SBarry Smith           ierr = PCFieldSplitSetIS(pc,"0",coupling);CHKERRQ(ierr);
4323a062f41SBarry Smith           ierr = PCFieldSplitSetIS(pc,"1",rest);CHKERRQ(ierr);
4333a062f41SBarry Smith         }
4343a062f41SBarry Smith         ierr = ISDestroy(&coupling);CHKERRQ(ierr);
4353a062f41SBarry Smith         ierr = ISDestroy(&rest);CHKERRQ(ierr);
4366ce1633cSBarry Smith       } else {
437ce94432eSBarry Smith         if (jac->reset) SETERRQ(PetscObjectComm((PetscObject)pc),PETSC_ERR_SUP,"Cases not yet handled when PCReset() was used");
4389eeaaa73SJed Brown         ierr = PetscOptionsGetBool(((PetscObject)pc)->prefix,"-pc_fieldsplit_default",&fieldsplit_default,NULL);CHKERRQ(ierr);
4397287d2a3SDmitry Karpeev         if (!fieldsplit_default) {
440d32f9abdSBarry Smith           /* Allow user to set fields from command line,  if bs was known at the time of PCSetFromOptions_FieldSplit()
441d32f9abdSBarry Smith            then it is set there. This is not ideal because we should only have options set in XXSetFromOptions(). */
4426c924f48SJed Brown           ierr = PCFieldSplitSetRuntimeSplits_Private(pc);CHKERRQ(ierr);
4436c924f48SJed Brown           if (jac->splitdefined) {ierr = PetscInfo(pc,"Splits defined using the options database\n");CHKERRQ(ierr);}
444d32f9abdSBarry Smith         }
4457287d2a3SDmitry Karpeev         if (fieldsplit_default || !jac->splitdefined) {
446d32f9abdSBarry Smith           ierr = PetscInfo(pc,"Using default splitting of fields\n");CHKERRQ(ierr);
447db4c96c1SJed Brown           for (i=0; i<jac->bs; i++) {
4486c924f48SJed Brown             char splitname[8];
4498caf3d72SBarry Smith             ierr = PetscSNPrintf(splitname,sizeof(splitname),"%D",i);CHKERRQ(ierr);
4505d4c12cdSJungho Lee             ierr = PCFieldSplitSetFields(pc,splitname,1,&i,&i);CHKERRQ(ierr);
45179416396SBarry Smith           }
4525d4c12cdSJungho Lee           jac->defaultsplit = PETSC_TRUE;
453521d7252SBarry Smith         }
45466ffff09SJed Brown       }
4556ce1633cSBarry Smith     }
456edf189efSBarry Smith   } else if (jac->nsplits == 1) {
457edf189efSBarry Smith     if (ilink->is) {
458edf189efSBarry Smith       IS       is2;
459edf189efSBarry Smith       PetscInt nmin,nmax;
460edf189efSBarry Smith 
461edf189efSBarry Smith       ierr = MatGetOwnershipRange(pc->mat,&nmin,&nmax);CHKERRQ(ierr);
462edf189efSBarry Smith       ierr = ISComplement(ilink->is,nmin,nmax,&is2);CHKERRQ(ierr);
463db4c96c1SJed Brown       ierr = PCFieldSplitSetIS(pc,"1",is2);CHKERRQ(ierr);
464fcfd50ebSBarry Smith       ierr = ISDestroy(&is2);CHKERRQ(ierr);
46582f516ccSBarry Smith     } else SETERRQ(PetscObjectComm((PetscObject)pc),PETSC_ERR_SUP,"Must provide at least two sets of fields to PCFieldSplit()");
466edf189efSBarry Smith   }
467d0af7cd3SBarry Smith 
468d0af7cd3SBarry Smith 
46982f516ccSBarry Smith   if (jac->nsplits < 2) SETERRQ1(PetscObjectComm((PetscObject)pc),PETSC_ERR_PLIB,"Unhandled case, must have at least two fields, not %d", jac->nsplits);
47069a612a9SBarry Smith   PetscFunctionReturn(0);
47169a612a9SBarry Smith }
47269a612a9SBarry Smith 
4735a576424SJed Brown PETSC_EXTERN PetscErrorCode PetscOptionsFindPairPrefix_Private(const char pre[], const char name[], char *value[], PetscBool *flg);
474514bf10dSMatthew G Knepley 
47569a612a9SBarry Smith #undef __FUNCT__
47669a612a9SBarry Smith #define __FUNCT__ "PCSetUp_FieldSplit"
47769a612a9SBarry Smith static PetscErrorCode PCSetUp_FieldSplit(PC pc)
47869a612a9SBarry Smith {
47969a612a9SBarry Smith   PC_FieldSplit     *jac = (PC_FieldSplit*)pc->data;
48069a612a9SBarry Smith   PetscErrorCode    ierr;
4815a9f2f41SSatish Balay   PC_FieldSplitLink ilink;
4822c9966d7SBarry Smith   PetscInt          i,nsplit;
4835f4ab4e1SJungho Lee   PetscBool         sorted, sorted_col;
48469a612a9SBarry Smith 
48569a612a9SBarry Smith   PetscFunctionBegin;
48669a612a9SBarry Smith   ierr   = PCFieldSplitSetDefaults(pc);CHKERRQ(ierr);
48797bbdb24SBarry Smith   nsplit = jac->nsplits;
4885a9f2f41SSatish Balay   ilink  = jac->head;
48997bbdb24SBarry Smith 
49097bbdb24SBarry Smith   /* get the matrices for each split */
491704ba839SBarry Smith   if (!jac->issetup) {
4921b9fc7fcSBarry Smith     PetscInt rstart,rend,nslots,bs;
49397bbdb24SBarry Smith 
494704ba839SBarry Smith     jac->issetup = PETSC_TRUE;
495704ba839SBarry Smith 
4965d4c12cdSJungho Lee     /* This is done here instead of in PCFieldSplitSetFields() because may not have matrix at that point */
4972c9966d7SBarry Smith     if (jac->defaultsplit || !ilink->is) {
4982c9966d7SBarry Smith       if (jac->bs <= 0) jac->bs = nsplit;
4992c9966d7SBarry Smith     }
50051f519a2SBarry Smith     bs     = jac->bs;
50197bbdb24SBarry Smith     ierr   = MatGetOwnershipRange(pc->pmat,&rstart,&rend);CHKERRQ(ierr);
5021b9fc7fcSBarry Smith     nslots = (rend - rstart)/bs;
5031b9fc7fcSBarry Smith     for (i=0; i<nsplit; i++) {
5041b9fc7fcSBarry Smith       if (jac->defaultsplit) {
505ce94432eSBarry Smith         ierr = ISCreateStride(PetscObjectComm((PetscObject)pc),nslots,rstart+i,nsplit,&ilink->is);CHKERRQ(ierr);
5065f4ab4e1SJungho Lee         ierr = ISDuplicate(ilink->is,&ilink->is_col);CHKERRQ(ierr);
507704ba839SBarry Smith       } else if (!ilink->is) {
508ccb205f8SBarry Smith         if (ilink->nfields > 1) {
5095f4ab4e1SJungho Lee           PetscInt *ii,*jj,j,k,nfields = ilink->nfields,*fields = ilink->fields,*fields_col = ilink->fields_col;
510785e854fSJed Brown           ierr = PetscMalloc1(ilink->nfields*nslots,&ii);CHKERRQ(ierr);
511785e854fSJed Brown           ierr = PetscMalloc1(ilink->nfields*nslots,&jj);CHKERRQ(ierr);
5121b9fc7fcSBarry Smith           for (j=0; j<nslots; j++) {
5131b9fc7fcSBarry Smith             for (k=0; k<nfields; k++) {
5141b9fc7fcSBarry Smith               ii[nfields*j + k] = rstart + bs*j + fields[k];
5155f4ab4e1SJungho Lee               jj[nfields*j + k] = rstart + bs*j + fields_col[k];
51697bbdb24SBarry Smith             }
51797bbdb24SBarry Smith           }
518ce94432eSBarry Smith           ierr = ISCreateGeneral(PetscObjectComm((PetscObject)pc),nslots*nfields,ii,PETSC_OWN_POINTER,&ilink->is);CHKERRQ(ierr);
519ce94432eSBarry Smith           ierr = ISCreateGeneral(PetscObjectComm((PetscObject)pc),nslots*nfields,jj,PETSC_OWN_POINTER,&ilink->is_col);CHKERRQ(ierr);
520ccb205f8SBarry Smith         } else {
521ce94432eSBarry Smith           ierr = ISCreateStride(PetscObjectComm((PetscObject)pc),nslots,rstart+ilink->fields[0],bs,&ilink->is);CHKERRQ(ierr);
522ce94432eSBarry Smith           ierr = ISCreateStride(PetscObjectComm((PetscObject)pc),nslots,rstart+ilink->fields_col[0],bs,&ilink->is_col);CHKERRQ(ierr);
523ccb205f8SBarry Smith        }
5243e197d65SBarry Smith       }
525704ba839SBarry Smith       ierr = ISSorted(ilink->is,&sorted);CHKERRQ(ierr);
5265f4ab4e1SJungho Lee       if (ilink->is_col) { ierr = ISSorted(ilink->is_col,&sorted_col);CHKERRQ(ierr); }
5275f4ab4e1SJungho Lee       if (!sorted || !sorted_col) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_USER,"Fields must be sorted when creating split");
528704ba839SBarry Smith       ilink = ilink->next;
5291b9fc7fcSBarry Smith     }
5301b9fc7fcSBarry Smith   }
5311b9fc7fcSBarry Smith 
532704ba839SBarry Smith   ilink = jac->head;
53397bbdb24SBarry Smith   if (!jac->pmat) {
534bdddcaaaSMatthew G Knepley     Vec xtmp;
535bdddcaaaSMatthew G Knepley 
5362a7a6963SBarry Smith     ierr = MatCreateVecs(pc->pmat,&xtmp,NULL);CHKERRQ(ierr);
537785e854fSJed Brown     ierr = PetscMalloc1(nsplit,&jac->pmat);CHKERRQ(ierr);
538dcca6d9dSJed Brown     ierr = PetscMalloc2(nsplit,&jac->x,nsplit,&jac->y);CHKERRQ(ierr);
539cf502942SBarry Smith     for (i=0; i<nsplit; i++) {
540bdddcaaaSMatthew G Knepley       MatNullSpace sp;
541bdddcaaaSMatthew G Knepley 
542a3df900dSMatthew G Knepley       /* Check for preconditioning matrix attached to IS */
543a3df900dSMatthew G Knepley       ierr = PetscObjectQuery((PetscObject) ilink->is, "pmat", (PetscObject*) &jac->pmat[i]);CHKERRQ(ierr);
544a3df900dSMatthew G Knepley       if (jac->pmat[i]) {
545a3df900dSMatthew G Knepley         ierr = PetscObjectReference((PetscObject) jac->pmat[i]);CHKERRQ(ierr);
546a3df900dSMatthew G Knepley         if (jac->type == PC_COMPOSITE_SCHUR) {
547a3df900dSMatthew G Knepley           jac->schur_user = jac->pmat[i];
5482fa5cd67SKarl Rupp 
549a3df900dSMatthew G Knepley           ierr = PetscObjectReference((PetscObject) jac->schur_user);CHKERRQ(ierr);
550a3df900dSMatthew G Knepley         }
551a3df900dSMatthew G Knepley       } else {
5523a062f41SBarry Smith         const char *prefix;
5535f4ab4e1SJungho Lee         ierr = MatGetSubMatrix(pc->pmat,ilink->is,ilink->is_col,MAT_INITIAL_MATRIX,&jac->pmat[i]);CHKERRQ(ierr);
5543a062f41SBarry Smith         ierr = KSPGetOptionsPrefix(ilink->ksp,&prefix);CHKERRQ(ierr);
5553a062f41SBarry Smith         ierr = MatSetOptionsPrefix(jac->pmat[i],prefix);CHKERRQ(ierr);
5563a062f41SBarry Smith         ierr = MatViewFromOptions(jac->pmat[i],NULL,"-mat_view");CHKERRQ(ierr);
557a3df900dSMatthew G Knepley       }
558bdddcaaaSMatthew G Knepley       /* create work vectors for each split */
5592a7a6963SBarry Smith       ierr     = MatCreateVecs(jac->pmat[i],&jac->x[i],&jac->y[i]);CHKERRQ(ierr);
5600298fd71SBarry Smith       ilink->x = jac->x[i]; ilink->y = jac->y[i]; ilink->z = NULL;
561bdddcaaaSMatthew G Knepley       /* compute scatter contexts needed by multiplicative versions and non-default splits */
5620298fd71SBarry Smith       ierr = VecScatterCreate(xtmp,ilink->is,jac->x[i],NULL,&ilink->sctx);CHKERRQ(ierr);
563ed1f0337SMatthew G Knepley       /* Check for null space attached to IS */
564bafc1b83SMatthew G Knepley       ierr = PetscObjectQuery((PetscObject) ilink->is, "nullspace", (PetscObject*) &sp);CHKERRQ(ierr);
565bafc1b83SMatthew G Knepley       if (sp) {
566bafc1b83SMatthew G Knepley         ierr = MatSetNullSpace(jac->pmat[i], sp);CHKERRQ(ierr);
567bafc1b83SMatthew G Knepley       }
568ed1f0337SMatthew G Knepley       ierr = PetscObjectQuery((PetscObject) ilink->is, "nearnullspace", (PetscObject*) &sp);CHKERRQ(ierr);
569ed1f0337SMatthew G Knepley       if (sp) {
570ed1f0337SMatthew G Knepley         ierr = MatSetNearNullSpace(jac->pmat[i], sp);CHKERRQ(ierr);
571ed1f0337SMatthew G Knepley       }
572704ba839SBarry Smith       ilink = ilink->next;
573cf502942SBarry Smith     }
574bdddcaaaSMatthew G Knepley     ierr = VecDestroy(&xtmp);CHKERRQ(ierr);
57597bbdb24SBarry Smith   } else {
576cf502942SBarry Smith     for (i=0; i<nsplit; i++) {
577a3df900dSMatthew G Knepley       Mat pmat;
578a3df900dSMatthew G Knepley 
579a3df900dSMatthew G Knepley       /* Check for preconditioning matrix attached to IS */
580a3df900dSMatthew G Knepley       ierr = PetscObjectQuery((PetscObject) ilink->is, "pmat", (PetscObject*) &pmat);CHKERRQ(ierr);
581a3df900dSMatthew G Knepley       if (!pmat) {
5825f4ab4e1SJungho Lee         ierr = MatGetSubMatrix(pc->pmat,ilink->is,ilink->is_col,MAT_REUSE_MATRIX,&jac->pmat[i]);CHKERRQ(ierr);
583a3df900dSMatthew G Knepley       }
584704ba839SBarry Smith       ilink = ilink->next;
585cf502942SBarry Smith     }
58697bbdb24SBarry Smith   }
5874e39094bSDmitry Karpeev   if (jac->diag_use_amat) {
588519d70e2SJed Brown     ilink = jac->head;
589519d70e2SJed Brown     if (!jac->mat) {
590785e854fSJed Brown       ierr = PetscMalloc1(nsplit,&jac->mat);CHKERRQ(ierr);
591519d70e2SJed Brown       for (i=0; i<nsplit; i++) {
5925f4ab4e1SJungho Lee         ierr  = MatGetSubMatrix(pc->mat,ilink->is,ilink->is_col,MAT_INITIAL_MATRIX,&jac->mat[i]);CHKERRQ(ierr);
593519d70e2SJed Brown         ilink = ilink->next;
594519d70e2SJed Brown       }
595519d70e2SJed Brown     } else {
596519d70e2SJed Brown       for (i=0; i<nsplit; i++) {
5975f4ab4e1SJungho Lee         if (jac->mat[i]) {ierr = MatGetSubMatrix(pc->mat,ilink->is,ilink->is_col,MAT_REUSE_MATRIX,&jac->mat[i]);CHKERRQ(ierr);}
598519d70e2SJed Brown         ilink = ilink->next;
599519d70e2SJed Brown       }
600519d70e2SJed Brown     }
601519d70e2SJed Brown   } else {
602519d70e2SJed Brown     jac->mat = jac->pmat;
603519d70e2SJed Brown   }
60497bbdb24SBarry Smith 
6056c8605c2SJed Brown   if (jac->type != PC_COMPOSITE_ADDITIVE  && jac->type != PC_COMPOSITE_SCHUR) {
60668dd23aaSBarry Smith     /* extract the rows of the matrix associated with each field: used for efficient computation of residual inside algorithm */
6074e39094bSDmitry Karpeev     /* FIXME: Can/should we reuse jac->mat whenever (jac->diag_use_amat) is true? */
60868dd23aaSBarry Smith     ilink = jac->head;
609e52d2c62SBarry Smith     if (nsplit == 2 && jac->type == PC_COMPOSITE_MULTIPLICATIVE) {
610e52d2c62SBarry 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 */
611e52d2c62SBarry Smith       if (!jac->Afield) {
612e52d2c62SBarry Smith         ierr = PetscCalloc1(nsplit,&jac->Afield);CHKERRQ(ierr);
613e52d2c62SBarry Smith         ierr  = MatGetSubMatrix(pc->mat,ilink->next->is,ilink->is,MAT_INITIAL_MATRIX,&jac->Afield[1]);CHKERRQ(ierr);
614e52d2c62SBarry Smith       } else {
615e52d2c62SBarry Smith         ierr  = MatGetSubMatrix(pc->mat,ilink->next->is,ilink->is,MAT_REUSE_MATRIX,&jac->Afield[1]);CHKERRQ(ierr);
616e52d2c62SBarry Smith       }
617e52d2c62SBarry Smith     } else {
61868dd23aaSBarry Smith       if (!jac->Afield) {
619785e854fSJed Brown         ierr = PetscMalloc1(nsplit,&jac->Afield);CHKERRQ(ierr);
62068dd23aaSBarry Smith         for (i=0; i<nsplit; i++) {
6210298fd71SBarry Smith           ierr  = MatGetSubMatrix(pc->mat,ilink->is,NULL,MAT_INITIAL_MATRIX,&jac->Afield[i]);CHKERRQ(ierr);
62268dd23aaSBarry Smith           ilink = ilink->next;
62368dd23aaSBarry Smith         }
62468dd23aaSBarry Smith       } else {
62568dd23aaSBarry Smith         for (i=0; i<nsplit; i++) {
6260298fd71SBarry Smith           ierr  = MatGetSubMatrix(pc->mat,ilink->is,NULL,MAT_REUSE_MATRIX,&jac->Afield[i]);CHKERRQ(ierr);
62768dd23aaSBarry Smith           ilink = ilink->next;
62868dd23aaSBarry Smith         }
62968dd23aaSBarry Smith       }
63068dd23aaSBarry Smith     }
631e52d2c62SBarry Smith   }
63268dd23aaSBarry Smith 
6333b224e63SBarry Smith   if (jac->type == PC_COMPOSITE_SCHUR) {
6343b224e63SBarry Smith     IS          ccis;
6354aa3045dSJed Brown     PetscInt    rstart,rend;
636093c86ffSJed Brown     char        lscname[256];
637093c86ffSJed Brown     PetscObject LSC_L;
638ce94432eSBarry Smith 
639ce94432eSBarry Smith     if (nsplit != 2) SETERRQ(PetscObjectComm((PetscObject)pc),PETSC_ERR_ARG_INCOMP,"To use Schur complement preconditioner you must have exactly 2 fields");
64068dd23aaSBarry Smith 
641e6cab6aaSJed Brown     /* When extracting off-diagonal submatrices, we take complements from this range */
642e6cab6aaSJed Brown     ierr = MatGetOwnershipRangeColumn(pc->mat,&rstart,&rend);CHKERRQ(ierr);
643e6cab6aaSJed Brown 
6443b224e63SBarry Smith     /* need to handle case when one is resetting up the preconditioner */
6453b224e63SBarry Smith     if (jac->schur) {
6460298fd71SBarry Smith       KSP kspA = jac->head->ksp, kspInner = NULL, kspUpper = jac->kspupper;
647443836d0SMatthew G Knepley 
648fb3147dbSMatthew G Knepley       ierr  = MatSchurComplementGetKSP(jac->schur, &kspInner);CHKERRQ(ierr);
6493b224e63SBarry Smith       ilink = jac->head;
65049bb4cd7SJungho Lee       ierr  = ISComplement(ilink->is_col,rstart,rend,&ccis);CHKERRQ(ierr);
6514e39094bSDmitry Karpeev       if (jac->offdiag_use_amat) {
6524aa3045dSJed Brown 	ierr  = MatGetSubMatrix(pc->mat,ilink->is,ccis,MAT_REUSE_MATRIX,&jac->B);CHKERRQ(ierr);
653c84da90fSDmitry Karpeev       } else {
654df06c9e3SDmitry Karpeev 	ierr  = MatGetSubMatrix(pc->pmat,ilink->is,ccis,MAT_REUSE_MATRIX,&jac->B);CHKERRQ(ierr);
655c84da90fSDmitry Karpeev       }
656fcfd50ebSBarry Smith       ierr  = ISDestroy(&ccis);CHKERRQ(ierr);
6573b224e63SBarry Smith       ilink = ilink->next;
65849bb4cd7SJungho Lee       ierr  = ISComplement(ilink->is_col,rstart,rend,&ccis);CHKERRQ(ierr);
6594e39094bSDmitry Karpeev       if (jac->offdiag_use_amat) {
6604aa3045dSJed Brown 	ierr  = MatGetSubMatrix(pc->mat,ilink->is,ccis,MAT_REUSE_MATRIX,&jac->C);CHKERRQ(ierr);
661c84da90fSDmitry Karpeev       } else {
662df06c9e3SDmitry Karpeev 	ierr  = MatGetSubMatrix(pc->pmat,ilink->is,ccis,MAT_REUSE_MATRIX,&jac->C);CHKERRQ(ierr);
663c84da90fSDmitry Karpeev       }
664fcfd50ebSBarry Smith       ierr  = ISDestroy(&ccis);CHKERRQ(ierr);
665aa6c7ce3SBarry Smith       ierr  = MatSchurComplementUpdateSubMatrices(jac->schur,jac->mat[0],jac->pmat[0],jac->B,jac->C,jac->mat[1]);CHKERRQ(ierr);
666a7476a74SDmitry Karpeev       if (jac->schurpre == PC_FIELDSPLIT_SCHUR_PRE_SELFP) {
667a7476a74SDmitry Karpeev 	ierr = MatDestroy(&jac->schurp);CHKERRQ(ierr);
668a7476a74SDmitry Karpeev 	ierr = MatSchurComplementGetPmat(jac->schur,MAT_INITIAL_MATRIX,&jac->schurp);CHKERRQ(ierr);
669a7476a74SDmitry Karpeev       }
670443836d0SMatthew G Knepley       if (kspA != kspInner) {
67123ee1639SBarry Smith         ierr = KSPSetOperators(kspA,jac->mat[0],jac->pmat[0]);CHKERRQ(ierr);
672443836d0SMatthew G Knepley       }
673443836d0SMatthew G Knepley       if (kspUpper != kspA) {
67423ee1639SBarry Smith         ierr = KSPSetOperators(kspUpper,jac->mat[0],jac->pmat[0]);CHKERRQ(ierr);
675443836d0SMatthew G Knepley       }
67623ee1639SBarry Smith       ierr = KSPSetOperators(jac->kspschur,jac->schur,FieldSplitSchurPre(jac));CHKERRQ(ierr);
6773b224e63SBarry Smith     } else {
678bafc1b83SMatthew G Knepley       const char   *Dprefix;
679470b340bSDmitry Karpeev       char         schurprefix[256], schurmatprefix[256];
680514bf10dSMatthew G Knepley       char         schurtestoption[256];
681bdddcaaaSMatthew G Knepley       MatNullSpace sp;
682514bf10dSMatthew G Knepley       PetscBool    flg;
6833b224e63SBarry Smith 
684a04f6461SBarry Smith       /* extract the A01 and A10 matrices */
6853b224e63SBarry Smith       ilink = jac->head;
68649bb4cd7SJungho Lee       ierr  = ISComplement(ilink->is_col,rstart,rend,&ccis);CHKERRQ(ierr);
6874e39094bSDmitry Karpeev       if (jac->offdiag_use_amat) {
6884aa3045dSJed Brown 	ierr  = MatGetSubMatrix(pc->mat,ilink->is,ccis,MAT_INITIAL_MATRIX,&jac->B);CHKERRQ(ierr);
689c84da90fSDmitry Karpeev       } else {
690df06c9e3SDmitry Karpeev 	ierr  = MatGetSubMatrix(pc->pmat,ilink->is,ccis,MAT_INITIAL_MATRIX,&jac->B);CHKERRQ(ierr);
691c84da90fSDmitry Karpeev       }
692fcfd50ebSBarry Smith       ierr  = ISDestroy(&ccis);CHKERRQ(ierr);
6933b224e63SBarry Smith       ilink = ilink->next;
69449bb4cd7SJungho Lee       ierr  = ISComplement(ilink->is_col,rstart,rend,&ccis);CHKERRQ(ierr);
6954e39094bSDmitry Karpeev       if (jac->offdiag_use_amat) {
6964aa3045dSJed Brown 	ierr  = MatGetSubMatrix(pc->mat,ilink->is,ccis,MAT_INITIAL_MATRIX,&jac->C);CHKERRQ(ierr);
697c84da90fSDmitry Karpeev       } else {
698df06c9e3SDmitry Karpeev 	ierr  = MatGetSubMatrix(pc->pmat,ilink->is,ccis,MAT_INITIAL_MATRIX,&jac->C);CHKERRQ(ierr);
699c84da90fSDmitry Karpeev       }
700fcfd50ebSBarry Smith       ierr  = ISDestroy(&ccis);CHKERRQ(ierr);
70120252d06SBarry Smith 
702f5236f50SJed Brown       /* Use mat[0] (diagonal block of Amat) preconditioned by pmat[0] to define Schur complement */
70320252d06SBarry Smith       ierr = MatCreate(((PetscObject)jac->mat[0])->comm,&jac->schur);CHKERRQ(ierr);
70420252d06SBarry Smith       ierr = MatSetType(jac->schur,MATSCHURCOMPLEMENT);CHKERRQ(ierr);
705bee83525SDmitry Karpeev       ierr = MatSchurComplementSetSubMatrices(jac->schur,jac->mat[0],jac->pmat[0],jac->B,jac->C,jac->mat[1]);CHKERRQ(ierr);
706470b340bSDmitry Karpeev       ierr = PetscSNPrintf(schurmatprefix, sizeof(schurmatprefix), "%sfieldsplit_%s_", ((PetscObject)pc)->prefix ? ((PetscObject)pc)->prefix : "", ilink->splitname);CHKERRQ(ierr);
707470b340bSDmitry 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? */
708470b340bSDmitry Karpeev       ierr = MatSetOptionsPrefix(jac->schur,schurmatprefix);CHKERRQ(ierr);
709470b340bSDmitry Karpeev       ierr = MatSetFromOptions(jac->schur);CHKERRQ(ierr);
710bdddcaaaSMatthew G Knepley       ierr = MatGetNullSpace(jac->pmat[1], &sp);CHKERRQ(ierr);
71120252d06SBarry Smith       if (sp) {
71220252d06SBarry Smith         ierr = MatSetNullSpace(jac->schur, sp);CHKERRQ(ierr);
71320252d06SBarry Smith       }
71420252d06SBarry Smith 
71520252d06SBarry Smith       ierr = PetscSNPrintf(schurtestoption, sizeof(schurtestoption), "-fieldsplit_%s_inner_", ilink->splitname);CHKERRQ(ierr);
7160298fd71SBarry Smith       ierr = PetscOptionsFindPairPrefix_Private(((PetscObject)pc)->prefix, schurtestoption, NULL, &flg);CHKERRQ(ierr);
717514bf10dSMatthew G Knepley       if (flg) {
718514bf10dSMatthew G Knepley         DM  dmInner;
71921635b76SJed Brown         KSP kspInner;
72021635b76SJed Brown 
72121635b76SJed Brown         ierr = MatSchurComplementGetKSP(jac->schur, &kspInner);CHKERRQ(ierr);
72221635b76SJed Brown         ierr = PetscSNPrintf(schurprefix, sizeof(schurprefix), "%sfieldsplit_%s_inner_", ((PetscObject)pc)->prefix ? ((PetscObject)pc)->prefix : "", ilink->splitname);CHKERRQ(ierr);
72321635b76SJed Brown         /* Indent this deeper to emphasize the "inner" nature of this solver. */
72421635b76SJed Brown         ierr = PetscObjectIncrementTabLevel((PetscObject)kspInner, (PetscObject) pc, 2);CHKERRQ(ierr);
72521635b76SJed Brown         ierr = KSPSetOptionsPrefix(kspInner, schurprefix);CHKERRQ(ierr);
726514bf10dSMatthew G Knepley 
727514bf10dSMatthew G Knepley         /* Set DM for new solver */
728bafc1b83SMatthew G Knepley         ierr = KSPGetDM(jac->head->ksp, &dmInner);CHKERRQ(ierr);
72921635b76SJed Brown         ierr = KSPSetDM(kspInner, dmInner);CHKERRQ(ierr);
73021635b76SJed Brown         ierr = KSPSetDMActive(kspInner, PETSC_FALSE);CHKERRQ(ierr);
731514bf10dSMatthew G Knepley       } else {
73221635b76SJed Brown          /* Use the outer solver for the inner solve, but revert the KSPPREONLY from PCFieldSplitSetFields_FieldSplit or
73321635b76SJed Brown           * PCFieldSplitSetIS_FieldSplit. We don't want KSPPREONLY because it makes the Schur complement inexact,
73421635b76SJed Brown           * preventing Schur complement reduction to be an accurate solve. Usually when an iterative solver is used for
73521635b76SJed 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
73621635b76SJed Brown           * GMRES the default. Note that it is also common to use PREONLY for S, in which case S may not be used
73721635b76SJed Brown           * directly, and the user is responsible for setting an inexact method for fieldsplit's A^{-1}. */
73821635b76SJed Brown         ierr = KSPSetType(jac->head->ksp,KSPGMRES);CHKERRQ(ierr);
739514bf10dSMatthew G Knepley         ierr = MatSchurComplementSetKSP(jac->schur,jac->head->ksp);CHKERRQ(ierr);
740bafc1b83SMatthew G Knepley       }
74123ee1639SBarry Smith       ierr = KSPSetOperators(jac->head->ksp,jac->mat[0],jac->pmat[0]);CHKERRQ(ierr);
7425a9f2f41SSatish Balay       ierr = KSPSetFromOptions(jac->head->ksp);CHKERRQ(ierr);
74397bbdb24SBarry Smith       ierr = MatSetFromOptions(jac->schur);CHKERRQ(ierr);
74497bbdb24SBarry Smith 
745443836d0SMatthew G Knepley       ierr = PetscSNPrintf(schurtestoption, sizeof(schurtestoption), "-fieldsplit_%s_upper_", ilink->splitname);CHKERRQ(ierr);
7460298fd71SBarry Smith       ierr = PetscOptionsFindPairPrefix_Private(((PetscObject)pc)->prefix, schurtestoption, NULL, &flg);CHKERRQ(ierr);
747443836d0SMatthew G Knepley       if (flg) {
748443836d0SMatthew G Knepley         DM dmInner;
749443836d0SMatthew G Knepley 
750443836d0SMatthew G Knepley         ierr = PetscSNPrintf(schurprefix, sizeof(schurprefix), "%sfieldsplit_%s_upper_", ((PetscObject)pc)->prefix ? ((PetscObject)pc)->prefix : "", ilink->splitname);CHKERRQ(ierr);
75182f516ccSBarry Smith         ierr = KSPCreate(PetscObjectComm((PetscObject)pc), &jac->kspupper);CHKERRQ(ierr);
752443836d0SMatthew G Knepley         ierr = KSPSetOptionsPrefix(jac->kspupper, schurprefix);CHKERRQ(ierr);
753443836d0SMatthew G Knepley         ierr = KSPGetDM(jac->head->ksp, &dmInner);CHKERRQ(ierr);
754443836d0SMatthew G Knepley         ierr = KSPSetDM(jac->kspupper, dmInner);CHKERRQ(ierr);
755443836d0SMatthew G Knepley         ierr = KSPSetDMActive(jac->kspupper, PETSC_FALSE);CHKERRQ(ierr);
756443836d0SMatthew G Knepley         ierr = KSPSetFromOptions(jac->kspupper);CHKERRQ(ierr);
75723ee1639SBarry Smith         ierr = KSPSetOperators(jac->kspupper,jac->mat[0],jac->pmat[0]);CHKERRQ(ierr);
758443836d0SMatthew G Knepley         ierr = VecDuplicate(jac->head->x, &jac->head->z);CHKERRQ(ierr);
759443836d0SMatthew G Knepley       } else {
760443836d0SMatthew G Knepley         jac->kspupper = jac->head->ksp;
761443836d0SMatthew G Knepley         ierr          = PetscObjectReference((PetscObject) jac->head->ksp);CHKERRQ(ierr);
762443836d0SMatthew G Knepley       }
763443836d0SMatthew G Knepley 
764a7476a74SDmitry Karpeev       if (jac->schurpre == PC_FIELDSPLIT_SCHUR_PRE_SELFP) {
765a7476a74SDmitry Karpeev 	ierr = MatSchurComplementGetPmat(jac->schur,MAT_INITIAL_MATRIX,&jac->schurp);CHKERRQ(ierr);
766a7476a74SDmitry Karpeev       }
767ce94432eSBarry Smith       ierr = KSPCreate(PetscObjectComm((PetscObject)pc),&jac->kspschur);CHKERRQ(ierr);
76897bbdb24SBarry Smith       ierr = PetscLogObjectParent((PetscObject)pc,(PetscObject)jac->kspschur);CHKERRQ(ierr);
76920252d06SBarry Smith       ierr = PetscObjectIncrementTabLevel((PetscObject)jac->kspschur,(PetscObject)pc,1);CHKERRQ(ierr);
77097bbdb24SBarry Smith       if (jac->schurpre == PC_FIELDSPLIT_SCHUR_PRE_SELF) {
7717233a360SDmitry Karpeev         PC pcschur;
7727233a360SDmitry Karpeev         ierr = KSPGetPC(jac->kspschur,&pcschur);CHKERRQ(ierr);
7737233a360SDmitry Karpeev         ierr = PCSetType(pcschur,PCNONE);CHKERRQ(ierr);
77497bbdb24SBarry Smith         /* Note: This is bad if there exist preconditioners for MATSCHURCOMPLEMENT */
775e74569cdSMatthew G. Knepley       } else if (jac->schurpre == PC_FIELDSPLIT_SCHUR_PRE_FULL) {
776e74569cdSMatthew G. Knepley         ierr = MatSchurComplementComputeExplicitOperator(jac->schur, &jac->schur_user);CHKERRQ(ierr);
77797bbdb24SBarry Smith       }
77823ee1639SBarry Smith       ierr = KSPSetOperators(jac->kspschur,jac->schur,FieldSplitSchurPre(jac));CHKERRQ(ierr);
77997bbdb24SBarry Smith       ierr = KSPGetOptionsPrefix(jac->head->next->ksp, &Dprefix);CHKERRQ(ierr);
78097bbdb24SBarry Smith       ierr = KSPSetOptionsPrefix(jac->kspschur,         Dprefix);CHKERRQ(ierr);
781b20b4189SMatthew G. Knepley       /* propogate DM */
782b20b4189SMatthew G. Knepley       {
783b20b4189SMatthew G. Knepley         DM sdm;
784b20b4189SMatthew G. Knepley         ierr = KSPGetDM(jac->head->next->ksp, &sdm);CHKERRQ(ierr);
785b20b4189SMatthew G. Knepley         if (sdm) {
786b20b4189SMatthew G. Knepley           ierr = KSPSetDM(jac->kspschur, sdm);CHKERRQ(ierr);
787b20b4189SMatthew G. Knepley           ierr = KSPSetDMActive(jac->kspschur, PETSC_FALSE);CHKERRQ(ierr);
788b20b4189SMatthew G. Knepley         }
789b20b4189SMatthew G. Knepley       }
79097bbdb24SBarry Smith       /* really want setfromoptions called in PCSetFromOptions_FieldSplit(), but it is not ready yet */
79197bbdb24SBarry Smith       /* need to call this every time, since the jac->kspschur is freshly created, otherwise its options never get set */
79297bbdb24SBarry Smith       ierr = KSPSetFromOptions(jac->kspschur);CHKERRQ(ierr);
79397bbdb24SBarry Smith     }
79497bbdb24SBarry Smith 
7955a9f2f41SSatish Balay     /* HACK: special support to forward L and Lp matrices that might be used by PCLSC */
7968caf3d72SBarry Smith     ierr = PetscSNPrintf(lscname,sizeof(lscname),"%s_LSC_L",ilink->splitname);CHKERRQ(ierr);
797519d70e2SJed Brown     ierr = PetscObjectQuery((PetscObject)pc->mat,lscname,(PetscObject*)&LSC_L);CHKERRQ(ierr);
7983b224e63SBarry Smith     if (!LSC_L) {ierr = PetscObjectQuery((PetscObject)pc->pmat,lscname,(PetscObject*)&LSC_L);CHKERRQ(ierr);}
799c1570756SJed Brown     if (LSC_L) {ierr = PetscObjectCompose((PetscObject)jac->schur,"LSC_L",(PetscObject)LSC_L);CHKERRQ(ierr);}
8008caf3d72SBarry Smith     ierr = PetscSNPrintf(lscname,sizeof(lscname),"%s_LSC_Lp",ilink->splitname);CHKERRQ(ierr);
80197bbdb24SBarry Smith     ierr = PetscObjectQuery((PetscObject)pc->pmat,lscname,(PetscObject*)&LSC_L);CHKERRQ(ierr);
8025a9f2f41SSatish Balay     if (!LSC_L) {ierr = PetscObjectQuery((PetscObject)pc->mat,lscname,(PetscObject*)&LSC_L);CHKERRQ(ierr);}
8030971522cSBarry Smith     if (LSC_L) {ierr = PetscObjectCompose((PetscObject)jac->schur,"LSC_Lp",(PetscObject)LSC_L);CHKERRQ(ierr);}
80497bbdb24SBarry Smith   } else {
80568bd789dSDmitry Karpeev     /* set up the individual splits' PCs */
8060971522cSBarry Smith     i     = 0;
8070971522cSBarry Smith     ilink = jac->head;
8080971522cSBarry Smith     while (ilink) {
80923ee1639SBarry Smith       ierr = KSPSetOperators(ilink->ksp,jac->mat[i],jac->pmat[i]);CHKERRQ(ierr);
8100971522cSBarry Smith       /* really want setfromoptions called in PCSetFromOptions_FieldSplit(), but it is not ready yet */
8110971522cSBarry Smith       if (!jac->suboptionsset) {ierr = KSPSetFromOptions(ilink->ksp);CHKERRQ(ierr);}
8120971522cSBarry Smith       i++;
8130971522cSBarry Smith       ilink = ilink->next;
8140971522cSBarry Smith     }
8153b224e63SBarry Smith   }
8163b224e63SBarry Smith 
817c1570756SJed Brown   jac->suboptionsset = PETSC_TRUE;
8180971522cSBarry Smith   PetscFunctionReturn(0);
8190971522cSBarry Smith }
8200971522cSBarry Smith 
8215a9f2f41SSatish Balay #define FieldSplitSplitSolveAdd(ilink,xx,yy) \
822ca9f406cSSatish Balay   (VecScatterBegin(ilink->sctx,xx,ilink->x,INSERT_VALUES,SCATTER_FORWARD) || \
823ca9f406cSSatish Balay    VecScatterEnd(ilink->sctx,xx,ilink->x,INSERT_VALUES,SCATTER_FORWARD) || \
8245a9f2f41SSatish Balay    KSPSolve(ilink->ksp,ilink->x,ilink->y) || \
825ca9f406cSSatish Balay    VecScatterBegin(ilink->sctx,ilink->y,yy,ADD_VALUES,SCATTER_REVERSE) || \
826ca9f406cSSatish Balay    VecScatterEnd(ilink->sctx,ilink->y,yy,ADD_VALUES,SCATTER_REVERSE))
82779416396SBarry Smith 
8280971522cSBarry Smith #undef __FUNCT__
8293b224e63SBarry Smith #define __FUNCT__ "PCApply_FieldSplit_Schur"
8303b224e63SBarry Smith static PetscErrorCode PCApply_FieldSplit_Schur(PC pc,Vec x,Vec y)
8313b224e63SBarry Smith {
8323b224e63SBarry Smith   PC_FieldSplit     *jac = (PC_FieldSplit*)pc->data;
8333b224e63SBarry Smith   PetscErrorCode    ierr;
8343b224e63SBarry Smith   PC_FieldSplitLink ilinkA = jac->head, ilinkD = ilinkA->next;
835443836d0SMatthew G Knepley   KSP               kspA   = ilinkA->ksp, kspLower = kspA, kspUpper = jac->kspupper;
8363b224e63SBarry Smith 
8373b224e63SBarry Smith   PetscFunctionBegin;
838c5d2311dSJed Brown   switch (jac->schurfactorization) {
839c9c6ffaaSJed Brown   case PC_FIELDSPLIT_SCHUR_FACT_DIAG:
840a04f6461SBarry Smith     /* [A00 0; 0 -S], positive definite, suitable for MINRES */
841c5d2311dSJed Brown     ierr = VecScatterBegin(ilinkA->sctx,x,ilinkA->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
842c5d2311dSJed Brown     ierr = VecScatterBegin(ilinkD->sctx,x,ilinkD->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
843c5d2311dSJed Brown     ierr = VecScatterEnd(ilinkA->sctx,x,ilinkA->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
844443836d0SMatthew G Knepley     ierr = KSPSolve(kspA,ilinkA->x,ilinkA->y);CHKERRQ(ierr);
845c5d2311dSJed Brown     ierr = VecScatterBegin(ilinkA->sctx,ilinkA->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
846c5d2311dSJed Brown     ierr = VecScatterEnd(ilinkD->sctx,x,ilinkD->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
847c5d2311dSJed Brown     ierr = KSPSolve(jac->kspschur,ilinkD->x,ilinkD->y);CHKERRQ(ierr);
848c5d2311dSJed Brown     ierr = VecScale(ilinkD->y,-1.);CHKERRQ(ierr);
849c5d2311dSJed Brown     ierr = VecScatterBegin(ilinkD->sctx,ilinkD->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
850c5d2311dSJed Brown     ierr = VecScatterEnd(ilinkA->sctx,ilinkA->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
851c5d2311dSJed Brown     ierr = VecScatterEnd(ilinkD->sctx,ilinkD->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
852c5d2311dSJed Brown     break;
853c9c6ffaaSJed Brown   case PC_FIELDSPLIT_SCHUR_FACT_LOWER:
854a04f6461SBarry Smith     /* [A00 0; A10 S], suitable for left preconditioning */
855c5d2311dSJed Brown     ierr = VecScatterBegin(ilinkA->sctx,x,ilinkA->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
856c5d2311dSJed Brown     ierr = VecScatterEnd(ilinkA->sctx,x,ilinkA->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
857443836d0SMatthew G Knepley     ierr = KSPSolve(kspA,ilinkA->x,ilinkA->y);CHKERRQ(ierr);
858c5d2311dSJed Brown     ierr = MatMult(jac->C,ilinkA->y,ilinkD->x);CHKERRQ(ierr);
859c5d2311dSJed Brown     ierr = VecScale(ilinkD->x,-1.);CHKERRQ(ierr);
860c5d2311dSJed Brown     ierr = VecScatterBegin(ilinkD->sctx,x,ilinkD->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
861c5d2311dSJed Brown     ierr = VecScatterBegin(ilinkA->sctx,ilinkA->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
862c5d2311dSJed Brown     ierr = VecScatterEnd(ilinkD->sctx,x,ilinkD->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
863c5d2311dSJed Brown     ierr = KSPSolve(jac->kspschur,ilinkD->x,ilinkD->y);CHKERRQ(ierr);
864c5d2311dSJed Brown     ierr = VecScatterBegin(ilinkD->sctx,ilinkD->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
865c5d2311dSJed Brown     ierr = VecScatterEnd(ilinkA->sctx,ilinkA->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
866c5d2311dSJed Brown     ierr = VecScatterEnd(ilinkD->sctx,ilinkD->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
867c5d2311dSJed Brown     break;
868c9c6ffaaSJed Brown   case PC_FIELDSPLIT_SCHUR_FACT_UPPER:
869a04f6461SBarry Smith     /* [A00 A01; 0 S], suitable for right preconditioning */
870c5d2311dSJed Brown     ierr = VecScatterBegin(ilinkD->sctx,x,ilinkD->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
871c5d2311dSJed Brown     ierr = VecScatterEnd(ilinkD->sctx,x,ilinkD->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
872c5d2311dSJed Brown     ierr = KSPSolve(jac->kspschur,ilinkD->x,ilinkD->y);CHKERRQ(ierr);
873c5d2311dSJed Brown     ierr = MatMult(jac->B,ilinkD->y,ilinkA->x);CHKERRQ(ierr);
874c5d2311dSJed Brown     ierr = VecScale(ilinkA->x,-1.);CHKERRQ(ierr);
875c5d2311dSJed Brown     ierr = VecScatterBegin(ilinkA->sctx,x,ilinkA->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
876c5d2311dSJed Brown     ierr = VecScatterBegin(ilinkD->sctx,ilinkD->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
877c5d2311dSJed Brown     ierr = VecScatterEnd(ilinkA->sctx,x,ilinkA->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
878443836d0SMatthew G Knepley     ierr = KSPSolve(kspA,ilinkA->x,ilinkA->y);CHKERRQ(ierr);
879c5d2311dSJed Brown     ierr = VecScatterBegin(ilinkA->sctx,ilinkA->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
880c5d2311dSJed Brown     ierr = VecScatterEnd(ilinkD->sctx,ilinkD->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
881c5d2311dSJed Brown     ierr = VecScatterEnd(ilinkA->sctx,ilinkA->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
882c5d2311dSJed Brown     break;
883c9c6ffaaSJed Brown   case PC_FIELDSPLIT_SCHUR_FACT_FULL:
884a04f6461SBarry 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 */
8853b224e63SBarry Smith     ierr = VecScatterBegin(ilinkA->sctx,x,ilinkA->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
8863b224e63SBarry Smith     ierr = VecScatterEnd(ilinkA->sctx,x,ilinkA->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
887443836d0SMatthew G Knepley     ierr = KSPSolve(kspLower,ilinkA->x,ilinkA->y);CHKERRQ(ierr);
8883b224e63SBarry Smith     ierr = MatMult(jac->C,ilinkA->y,ilinkD->x);CHKERRQ(ierr);
8893b224e63SBarry Smith     ierr = VecScale(ilinkD->x,-1.0);CHKERRQ(ierr);
8903b224e63SBarry Smith     ierr = VecScatterBegin(ilinkD->sctx,x,ilinkD->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
8913b224e63SBarry Smith     ierr = VecScatterEnd(ilinkD->sctx,x,ilinkD->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
8923b224e63SBarry Smith 
8933b224e63SBarry Smith     ierr = KSPSolve(jac->kspschur,ilinkD->x,ilinkD->y);CHKERRQ(ierr);
8943b224e63SBarry Smith     ierr = VecScatterBegin(ilinkD->sctx,ilinkD->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
8953b224e63SBarry Smith     ierr = VecScatterEnd(ilinkD->sctx,ilinkD->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
8963b224e63SBarry Smith 
897443836d0SMatthew G Knepley     if (kspUpper == kspA) {
8983b224e63SBarry Smith       ierr = MatMult(jac->B,ilinkD->y,ilinkA->y);CHKERRQ(ierr);
8993b224e63SBarry Smith       ierr = VecAXPY(ilinkA->x,-1.0,ilinkA->y);CHKERRQ(ierr);
900443836d0SMatthew G Knepley       ierr = KSPSolve(kspA,ilinkA->x,ilinkA->y);CHKERRQ(ierr);
901443836d0SMatthew G Knepley     } else {
902443836d0SMatthew G Knepley       ierr = KSPSolve(kspA,ilinkA->x,ilinkA->y);CHKERRQ(ierr);
903443836d0SMatthew G Knepley       ierr = MatMult(jac->B,ilinkD->y,ilinkA->x);CHKERRQ(ierr);
904443836d0SMatthew G Knepley       ierr = KSPSolve(kspUpper,ilinkA->x,ilinkA->z);CHKERRQ(ierr);
905443836d0SMatthew G Knepley       ierr = VecAXPY(ilinkA->y,-1.0,ilinkA->z);CHKERRQ(ierr);
906443836d0SMatthew G Knepley     }
9073b224e63SBarry Smith     ierr = VecScatterBegin(ilinkA->sctx,ilinkA->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
9083b224e63SBarry Smith     ierr = VecScatterEnd(ilinkA->sctx,ilinkA->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
909c5d2311dSJed Brown   }
9103b224e63SBarry Smith   PetscFunctionReturn(0);
9113b224e63SBarry Smith }
9123b224e63SBarry Smith 
9133b224e63SBarry Smith #undef __FUNCT__
9140971522cSBarry Smith #define __FUNCT__ "PCApply_FieldSplit"
9150971522cSBarry Smith static PetscErrorCode PCApply_FieldSplit(PC pc,Vec x,Vec y)
9160971522cSBarry Smith {
9170971522cSBarry Smith   PC_FieldSplit     *jac = (PC_FieldSplit*)pc->data;
9180971522cSBarry Smith   PetscErrorCode    ierr;
9195a9f2f41SSatish Balay   PC_FieldSplitLink ilink = jac->head;
920939b8a20SBarry Smith   PetscInt          cnt,bs;
9210971522cSBarry Smith 
9220971522cSBarry Smith   PetscFunctionBegin;
92379416396SBarry Smith   if (jac->type == PC_COMPOSITE_ADDITIVE) {
9241b9fc7fcSBarry Smith     if (jac->defaultsplit) {
925939b8a20SBarry Smith       ierr = VecGetBlockSize(x,&bs);CHKERRQ(ierr);
926ce94432eSBarry 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);
927939b8a20SBarry Smith       ierr = VecGetBlockSize(y,&bs);CHKERRQ(ierr);
928ce94432eSBarry 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);
9290971522cSBarry Smith       ierr = VecStrideGatherAll(x,jac->x,INSERT_VALUES);CHKERRQ(ierr);
9305a9f2f41SSatish Balay       while (ilink) {
9315a9f2f41SSatish Balay         ierr  = KSPSolve(ilink->ksp,ilink->x,ilink->y);CHKERRQ(ierr);
9325a9f2f41SSatish Balay         ilink = ilink->next;
9330971522cSBarry Smith       }
9340971522cSBarry Smith       ierr = VecStrideScatterAll(jac->y,y,INSERT_VALUES);CHKERRQ(ierr);
9351b9fc7fcSBarry Smith     } else {
936efb30889SBarry Smith       ierr = VecSet(y,0.0);CHKERRQ(ierr);
9375a9f2f41SSatish Balay       while (ilink) {
9385a9f2f41SSatish Balay         ierr  = FieldSplitSplitSolveAdd(ilink,x,y);CHKERRQ(ierr);
9395a9f2f41SSatish Balay         ilink = ilink->next;
9401b9fc7fcSBarry Smith       }
9411b9fc7fcSBarry Smith     }
942e52d2c62SBarry Smith   } else if (jac->type == PC_COMPOSITE_MULTIPLICATIVE && jac->nsplits == 2) {
943e52d2c62SBarry Smith     ierr = VecSet(y,0.0);CHKERRQ(ierr);
944e52d2c62SBarry Smith     /* solve on first block for first block variables */
945e52d2c62SBarry Smith     ierr = VecScatterBegin(ilink->sctx,x,ilink->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
946e52d2c62SBarry Smith     ierr = VecScatterEnd(ilink->sctx,x,ilink->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
947e52d2c62SBarry Smith     ierr = KSPSolve(ilink->ksp,ilink->x,ilink->y);CHKERRQ(ierr);
948e52d2c62SBarry Smith     ierr = VecScatterBegin(ilink->sctx,ilink->y,y,ADD_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
949e52d2c62SBarry Smith     ierr = VecScatterEnd(ilink->sctx,ilink->y,y,ADD_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
950e52d2c62SBarry Smith 
951e52d2c62SBarry Smith     /* compute the residual only onto second block variables using first block variables */
952e52d2c62SBarry Smith     ierr = MatMult(jac->Afield[1],ilink->y,ilink->next->x);CHKERRQ(ierr);
953e52d2c62SBarry Smith     ilink = ilink->next;
954e52d2c62SBarry Smith     ierr = VecScale(ilink->x,-1.0);CHKERRQ(ierr);
955e52d2c62SBarry Smith     ierr = VecScatterBegin(ilink->sctx,x,ilink->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
956e52d2c62SBarry Smith     ierr = VecScatterEnd(ilink->sctx,x,ilink->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
957e52d2c62SBarry Smith 
958e52d2c62SBarry Smith     /* solve on second block variables */
959e52d2c62SBarry Smith     ierr = KSPSolve(ilink->ksp,ilink->x,ilink->y);CHKERRQ(ierr);
960e52d2c62SBarry Smith     ierr = VecScatterBegin(ilink->sctx,ilink->y,y,ADD_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
961e52d2c62SBarry Smith     ierr = VecScatterEnd(ilink->sctx,ilink->y,y,ADD_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
96216913363SBarry Smith   } else if (jac->type == PC_COMPOSITE_MULTIPLICATIVE || jac->type == PC_COMPOSITE_SYMMETRIC_MULTIPLICATIVE) {
96379416396SBarry Smith     if (!jac->w1) {
96479416396SBarry Smith       ierr = VecDuplicate(x,&jac->w1);CHKERRQ(ierr);
96579416396SBarry Smith       ierr = VecDuplicate(x,&jac->w2);CHKERRQ(ierr);
96679416396SBarry Smith     }
967efb30889SBarry Smith     ierr = VecSet(y,0.0);CHKERRQ(ierr);
9685a9f2f41SSatish Balay     ierr = FieldSplitSplitSolveAdd(ilink,x,y);CHKERRQ(ierr);
9693e197d65SBarry Smith     cnt  = 1;
9705a9f2f41SSatish Balay     while (ilink->next) {
9715a9f2f41SSatish Balay       ilink = ilink->next;
9723e197d65SBarry Smith       /* compute the residual only over the part of the vector needed */
9733e197d65SBarry Smith       ierr = MatMult(jac->Afield[cnt++],y,ilink->x);CHKERRQ(ierr);
9743e197d65SBarry Smith       ierr = VecScale(ilink->x,-1.0);CHKERRQ(ierr);
9753e197d65SBarry Smith       ierr = VecScatterBegin(ilink->sctx,x,ilink->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
9763e197d65SBarry Smith       ierr = VecScatterEnd(ilink->sctx,x,ilink->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
9773e197d65SBarry Smith       ierr = KSPSolve(ilink->ksp,ilink->x,ilink->y);CHKERRQ(ierr);
9783e197d65SBarry Smith       ierr = VecScatterBegin(ilink->sctx,ilink->y,y,ADD_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
9793e197d65SBarry Smith       ierr = VecScatterEnd(ilink->sctx,ilink->y,y,ADD_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
9803e197d65SBarry Smith     }
98151f519a2SBarry Smith     if (jac->type == PC_COMPOSITE_SYMMETRIC_MULTIPLICATIVE) {
98211755939SBarry Smith       cnt -= 2;
98351f519a2SBarry Smith       while (ilink->previous) {
98451f519a2SBarry Smith         ilink = ilink->previous;
98511755939SBarry Smith         /* compute the residual only over the part of the vector needed */
98611755939SBarry Smith         ierr = MatMult(jac->Afield[cnt--],y,ilink->x);CHKERRQ(ierr);
98711755939SBarry Smith         ierr = VecScale(ilink->x,-1.0);CHKERRQ(ierr);
98811755939SBarry Smith         ierr = VecScatterBegin(ilink->sctx,x,ilink->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
98911755939SBarry Smith         ierr = VecScatterEnd(ilink->sctx,x,ilink->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
99011755939SBarry Smith         ierr = KSPSolve(ilink->ksp,ilink->x,ilink->y);CHKERRQ(ierr);
99111755939SBarry Smith         ierr = VecScatterBegin(ilink->sctx,ilink->y,y,ADD_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
99211755939SBarry Smith         ierr = VecScatterEnd(ilink->sctx,ilink->y,y,ADD_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
99351f519a2SBarry Smith       }
99411755939SBarry Smith     }
995ce94432eSBarry Smith   } else SETERRQ1(PetscObjectComm((PetscObject)pc),PETSC_ERR_SUP,"Unsupported or unknown composition",(int) jac->type);
9960971522cSBarry Smith   PetscFunctionReturn(0);
9970971522cSBarry Smith }
9980971522cSBarry Smith 
999421e10b8SBarry Smith #define FieldSplitSplitSolveAddTranspose(ilink,xx,yy) \
1000ca9f406cSSatish Balay   (VecScatterBegin(ilink->sctx,xx,ilink->y,INSERT_VALUES,SCATTER_FORWARD) || \
1001ca9f406cSSatish Balay    VecScatterEnd(ilink->sctx,xx,ilink->y,INSERT_VALUES,SCATTER_FORWARD) || \
1002421e10b8SBarry Smith    KSPSolveTranspose(ilink->ksp,ilink->y,ilink->x) || \
1003ca9f406cSSatish Balay    VecScatterBegin(ilink->sctx,ilink->x,yy,ADD_VALUES,SCATTER_REVERSE) || \
1004ca9f406cSSatish Balay    VecScatterEnd(ilink->sctx,ilink->x,yy,ADD_VALUES,SCATTER_REVERSE))
1005421e10b8SBarry Smith 
1006421e10b8SBarry Smith #undef __FUNCT__
10078c03b21aSDmitry Karpeev #define __FUNCT__ "PCApplyTranspose_FieldSplit"
1008421e10b8SBarry Smith static PetscErrorCode PCApplyTranspose_FieldSplit(PC pc,Vec x,Vec y)
1009421e10b8SBarry Smith {
1010421e10b8SBarry Smith   PC_FieldSplit     *jac = (PC_FieldSplit*)pc->data;
1011421e10b8SBarry Smith   PetscErrorCode    ierr;
1012421e10b8SBarry Smith   PC_FieldSplitLink ilink = jac->head;
1013939b8a20SBarry Smith   PetscInt          bs;
1014421e10b8SBarry Smith 
1015421e10b8SBarry Smith   PetscFunctionBegin;
1016421e10b8SBarry Smith   if (jac->type == PC_COMPOSITE_ADDITIVE) {
1017421e10b8SBarry Smith     if (jac->defaultsplit) {
1018939b8a20SBarry Smith       ierr = VecGetBlockSize(x,&bs);CHKERRQ(ierr);
1019ce94432eSBarry 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);
1020939b8a20SBarry Smith       ierr = VecGetBlockSize(y,&bs);CHKERRQ(ierr);
1021ce94432eSBarry 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);
1022421e10b8SBarry Smith       ierr = VecStrideGatherAll(x,jac->x,INSERT_VALUES);CHKERRQ(ierr);
1023421e10b8SBarry Smith       while (ilink) {
1024421e10b8SBarry Smith         ierr  = KSPSolveTranspose(ilink->ksp,ilink->x,ilink->y);CHKERRQ(ierr);
1025421e10b8SBarry Smith         ilink = ilink->next;
1026421e10b8SBarry Smith       }
1027421e10b8SBarry Smith       ierr = VecStrideScatterAll(jac->y,y,INSERT_VALUES);CHKERRQ(ierr);
1028421e10b8SBarry Smith     } else {
1029421e10b8SBarry Smith       ierr = VecSet(y,0.0);CHKERRQ(ierr);
1030421e10b8SBarry Smith       while (ilink) {
1031421e10b8SBarry Smith         ierr  = FieldSplitSplitSolveAddTranspose(ilink,x,y);CHKERRQ(ierr);
1032421e10b8SBarry Smith         ilink = ilink->next;
1033421e10b8SBarry Smith       }
1034421e10b8SBarry Smith     }
1035421e10b8SBarry Smith   } else {
1036421e10b8SBarry Smith     if (!jac->w1) {
1037421e10b8SBarry Smith       ierr = VecDuplicate(x,&jac->w1);CHKERRQ(ierr);
1038421e10b8SBarry Smith       ierr = VecDuplicate(x,&jac->w2);CHKERRQ(ierr);
1039421e10b8SBarry Smith     }
1040421e10b8SBarry Smith     ierr = VecSet(y,0.0);CHKERRQ(ierr);
1041421e10b8SBarry Smith     if (jac->type == PC_COMPOSITE_SYMMETRIC_MULTIPLICATIVE) {
1042421e10b8SBarry Smith       ierr = FieldSplitSplitSolveAddTranspose(ilink,x,y);CHKERRQ(ierr);
1043421e10b8SBarry Smith       while (ilink->next) {
1044421e10b8SBarry Smith         ilink = ilink->next;
10459989ab13SBarry Smith         ierr  = MatMultTranspose(pc->mat,y,jac->w1);CHKERRQ(ierr);
1046421e10b8SBarry Smith         ierr  = VecWAXPY(jac->w2,-1.0,jac->w1,x);CHKERRQ(ierr);
1047421e10b8SBarry Smith         ierr  = FieldSplitSplitSolveAddTranspose(ilink,jac->w2,y);CHKERRQ(ierr);
1048421e10b8SBarry Smith       }
1049421e10b8SBarry Smith       while (ilink->previous) {
1050421e10b8SBarry Smith         ilink = ilink->previous;
10519989ab13SBarry Smith         ierr  = MatMultTranspose(pc->mat,y,jac->w1);CHKERRQ(ierr);
1052421e10b8SBarry Smith         ierr  = VecWAXPY(jac->w2,-1.0,jac->w1,x);CHKERRQ(ierr);
1053421e10b8SBarry Smith         ierr  = FieldSplitSplitSolveAddTranspose(ilink,jac->w2,y);CHKERRQ(ierr);
1054421e10b8SBarry Smith       }
1055421e10b8SBarry Smith     } else {
1056421e10b8SBarry Smith       while (ilink->next) {   /* get to last entry in linked list */
1057421e10b8SBarry Smith         ilink = ilink->next;
1058421e10b8SBarry Smith       }
1059421e10b8SBarry Smith       ierr = FieldSplitSplitSolveAddTranspose(ilink,x,y);CHKERRQ(ierr);
1060421e10b8SBarry Smith       while (ilink->previous) {
1061421e10b8SBarry Smith         ilink = ilink->previous;
10629989ab13SBarry Smith         ierr  = MatMultTranspose(pc->mat,y,jac->w1);CHKERRQ(ierr);
1063421e10b8SBarry Smith         ierr  = VecWAXPY(jac->w2,-1.0,jac->w1,x);CHKERRQ(ierr);
1064421e10b8SBarry Smith         ierr  = FieldSplitSplitSolveAddTranspose(ilink,jac->w2,y);CHKERRQ(ierr);
1065421e10b8SBarry Smith       }
1066421e10b8SBarry Smith     }
1067421e10b8SBarry Smith   }
1068421e10b8SBarry Smith   PetscFunctionReturn(0);
1069421e10b8SBarry Smith }
1070421e10b8SBarry Smith 
10710971522cSBarry Smith #undef __FUNCT__
1072574deadeSBarry Smith #define __FUNCT__ "PCReset_FieldSplit"
1073574deadeSBarry Smith static PetscErrorCode PCReset_FieldSplit(PC pc)
10740971522cSBarry Smith {
10750971522cSBarry Smith   PC_FieldSplit     *jac = (PC_FieldSplit*)pc->data;
10760971522cSBarry Smith   PetscErrorCode    ierr;
10775a9f2f41SSatish Balay   PC_FieldSplitLink ilink = jac->head,next;
10780971522cSBarry Smith 
10790971522cSBarry Smith   PetscFunctionBegin;
10805a9f2f41SSatish Balay   while (ilink) {
1081574deadeSBarry Smith     ierr  = KSPReset(ilink->ksp);CHKERRQ(ierr);
1082fcfd50ebSBarry Smith     ierr  = VecDestroy(&ilink->x);CHKERRQ(ierr);
1083fcfd50ebSBarry Smith     ierr  = VecDestroy(&ilink->y);CHKERRQ(ierr);
1084443836d0SMatthew G Knepley     ierr  = VecDestroy(&ilink->z);CHKERRQ(ierr);
1085fcfd50ebSBarry Smith     ierr  = VecScatterDestroy(&ilink->sctx);CHKERRQ(ierr);
1086fcfd50ebSBarry Smith     ierr  = ISDestroy(&ilink->is);CHKERRQ(ierr);
1087b5787286SJed Brown     ierr  = ISDestroy(&ilink->is_col);CHKERRQ(ierr);
10885a9f2f41SSatish Balay     next  = ilink->next;
10895a9f2f41SSatish Balay     ilink = next;
10900971522cSBarry Smith   }
109105b42c5fSBarry Smith   ierr = PetscFree2(jac->x,jac->y);CHKERRQ(ierr);
1092574deadeSBarry Smith   if (jac->mat && jac->mat != jac->pmat) {
1093574deadeSBarry Smith     ierr = MatDestroyMatrices(jac->nsplits,&jac->mat);CHKERRQ(ierr);
1094574deadeSBarry Smith   } else if (jac->mat) {
10950298fd71SBarry Smith     jac->mat = NULL;
1096574deadeSBarry Smith   }
109797bbdb24SBarry Smith   if (jac->pmat) {ierr = MatDestroyMatrices(jac->nsplits,&jac->pmat);CHKERRQ(ierr);}
109868dd23aaSBarry Smith   if (jac->Afield) {ierr = MatDestroyMatrices(jac->nsplits,&jac->Afield);CHKERRQ(ierr);}
10996bf464f9SBarry Smith   ierr       = VecDestroy(&jac->w1);CHKERRQ(ierr);
11006bf464f9SBarry Smith   ierr       = VecDestroy(&jac->w2);CHKERRQ(ierr);
11016bf464f9SBarry Smith   ierr       = MatDestroy(&jac->schur);CHKERRQ(ierr);
1102a7476a74SDmitry Karpeev   ierr       = MatDestroy(&jac->schurp);CHKERRQ(ierr);
11036bf464f9SBarry Smith   ierr       = MatDestroy(&jac->schur_user);CHKERRQ(ierr);
11046bf464f9SBarry Smith   ierr       = KSPDestroy(&jac->kspschur);CHKERRQ(ierr);
1105d78dad28SBarry Smith   ierr       = KSPDestroy(&jac->kspupper);CHKERRQ(ierr);
11066bf464f9SBarry Smith   ierr       = MatDestroy(&jac->B);CHKERRQ(ierr);
11076bf464f9SBarry Smith   ierr       = MatDestroy(&jac->C);CHKERRQ(ierr);
110863ec74ffSBarry Smith   jac->reset = PETSC_TRUE;
1109574deadeSBarry Smith   PetscFunctionReturn(0);
1110574deadeSBarry Smith }
1111574deadeSBarry Smith 
1112574deadeSBarry Smith #undef __FUNCT__
1113574deadeSBarry Smith #define __FUNCT__ "PCDestroy_FieldSplit"
1114574deadeSBarry Smith static PetscErrorCode PCDestroy_FieldSplit(PC pc)
1115574deadeSBarry Smith {
1116574deadeSBarry Smith   PC_FieldSplit     *jac = (PC_FieldSplit*)pc->data;
1117574deadeSBarry Smith   PetscErrorCode    ierr;
1118574deadeSBarry Smith   PC_FieldSplitLink ilink = jac->head,next;
1119574deadeSBarry Smith 
1120574deadeSBarry Smith   PetscFunctionBegin;
1121574deadeSBarry Smith   ierr = PCReset_FieldSplit(pc);CHKERRQ(ierr);
1122574deadeSBarry Smith   while (ilink) {
11236bf464f9SBarry Smith     ierr  = KSPDestroy(&ilink->ksp);CHKERRQ(ierr);
1124574deadeSBarry Smith     next  = ilink->next;
1125574deadeSBarry Smith     ierr  = PetscFree(ilink->splitname);CHKERRQ(ierr);
1126574deadeSBarry Smith     ierr  = PetscFree(ilink->fields);CHKERRQ(ierr);
11275d4c12cdSJungho Lee     ierr  = PetscFree(ilink->fields_col);CHKERRQ(ierr);
1128574deadeSBarry Smith     ierr  = PetscFree(ilink);CHKERRQ(ierr);
1129574deadeSBarry Smith     ilink = next;
1130574deadeSBarry Smith   }
1131574deadeSBarry Smith   ierr = PetscFree2(jac->x,jac->y);CHKERRQ(ierr);
1132c31cb41cSBarry Smith   ierr = PetscFree(pc->data);CHKERRQ(ierr);
1133bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitGetSubKSP_C",NULL);CHKERRQ(ierr);
1134bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetFields_C",NULL);CHKERRQ(ierr);
1135bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetIS_C",NULL);CHKERRQ(ierr);
1136bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetType_C",NULL);CHKERRQ(ierr);
1137bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetBlockSize_C",NULL);CHKERRQ(ierr);
113829f8a81cSJed Brown   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetSchurPre_C",NULL);CHKERRQ(ierr);
113937a82bf0SJed Brown   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitGetSchurPre_C",NULL);CHKERRQ(ierr);
1140bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetSchurFactType_C",NULL);CHKERRQ(ierr);
11410971522cSBarry Smith   PetscFunctionReturn(0);
11420971522cSBarry Smith }
11430971522cSBarry Smith 
11440971522cSBarry Smith #undef __FUNCT__
11450971522cSBarry Smith #define __FUNCT__ "PCSetFromOptions_FieldSplit"
11468c34d3f5SBarry Smith static PetscErrorCode PCSetFromOptions_FieldSplit(PetscOptions *PetscOptionsObject,PC pc)
11470971522cSBarry Smith {
11481b9fc7fcSBarry Smith   PetscErrorCode  ierr;
11496c924f48SJed Brown   PetscInt        bs;
1150bc59fbc5SBarry Smith   PetscBool       flg,stokes = PETSC_FALSE;
11519dcbbd2bSBarry Smith   PC_FieldSplit   *jac = (PC_FieldSplit*)pc->data;
11523b224e63SBarry Smith   PCCompositeType ctype;
11531b9fc7fcSBarry Smith 
11540971522cSBarry Smith   PetscFunctionBegin;
1155e55864a3SBarry Smith   ierr = PetscOptionsHead(PetscOptionsObject,"FieldSplit options");CHKERRQ(ierr);
11564ab8060aSDmitry Karpeev   ierr = PetscOptionsBool("-pc_fieldsplit_dm_splits","Whether to use DMCreateFieldDecomposition() for splits","PCFieldSplitSetDMSplits",jac->dm_splits,&jac->dm_splits,NULL);CHKERRQ(ierr);
115751f519a2SBarry Smith   ierr = PetscOptionsInt("-pc_fieldsplit_block_size","Blocksize that defines number of fields","PCFieldSplitSetBlockSize",jac->bs,&bs,&flg);CHKERRQ(ierr);
115851f519a2SBarry Smith   if (flg) {
115951f519a2SBarry Smith     ierr = PCFieldSplitSetBlockSize(pc,bs);CHKERRQ(ierr);
116051f519a2SBarry Smith   }
11612686e3e9SMatthew G. Knepley   jac->diag_use_amat = pc->useAmat;
11622686e3e9SMatthew 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);
11632686e3e9SMatthew G. Knepley   jac->offdiag_use_amat = pc->useAmat;
11642686e3e9SMatthew 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);
116500216929SDmitry Karpeev   /* FIXME: No programmatic equivalent to the following. */
11660298fd71SBarry Smith   ierr = PetscOptionsGetBool(((PetscObject)pc)->prefix,"-pc_fieldsplit_detect_saddle_point",&stokes,NULL);CHKERRQ(ierr);
1167c0adfefeSBarry Smith   if (stokes) {
1168c0adfefeSBarry Smith     ierr          = PCFieldSplitSetType(pc,PC_COMPOSITE_SCHUR);CHKERRQ(ierr);
1169c0adfefeSBarry Smith     jac->schurpre = PC_FIELDSPLIT_SCHUR_PRE_SELF;
1170c0adfefeSBarry Smith   }
1171c0adfefeSBarry Smith 
11723b224e63SBarry Smith   ierr = PetscOptionsEnum("-pc_fieldsplit_type","Type of composition","PCFieldSplitSetType",PCCompositeTypes,(PetscEnum)jac->type,(PetscEnum*)&ctype,&flg);CHKERRQ(ierr);
11733b224e63SBarry Smith   if (flg) {
11743b224e63SBarry Smith     ierr = PCFieldSplitSetType(pc,ctype);CHKERRQ(ierr);
11753b224e63SBarry Smith   }
1176c30613efSMatthew Knepley   /* Only setup fields once */
1177c30613efSMatthew Knepley   if ((jac->bs > 0) && (jac->nsplits == 0)) {
1178d32f9abdSBarry Smith     /* only allow user to set fields from command line if bs is already known.
1179d32f9abdSBarry Smith        otherwise user can set them in PCFieldSplitSetDefaults() */
11806c924f48SJed Brown     ierr = PCFieldSplitSetRuntimeSplits_Private(pc);CHKERRQ(ierr);
11816c924f48SJed Brown     if (jac->splitdefined) {ierr = PetscInfo(pc,"Splits defined using the options database\n");CHKERRQ(ierr);}
1182d32f9abdSBarry Smith   }
1183c5d2311dSJed Brown   if (jac->type == PC_COMPOSITE_SCHUR) {
1184c9c6ffaaSJed Brown     ierr = PetscOptionsGetEnum(((PetscObject)pc)->prefix,"-pc_fieldsplit_schur_factorization_type",PCFieldSplitSchurFactTypes,(PetscEnum*)&jac->schurfactorization,&flg);CHKERRQ(ierr);
1185c9c6ffaaSJed Brown     if (flg) {ierr = PetscInfo(pc,"Deprecated use of -pc_fieldsplit_schur_factorization_type\n");CHKERRQ(ierr);}
11860298fd71SBarry 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);
118729f8a81cSJed 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);
1188c5d2311dSJed Brown   }
11891b9fc7fcSBarry Smith   ierr = PetscOptionsTail();CHKERRQ(ierr);
11900971522cSBarry Smith   PetscFunctionReturn(0);
11910971522cSBarry Smith }
11920971522cSBarry Smith 
11930971522cSBarry Smith /*------------------------------------------------------------------------------------*/
11940971522cSBarry Smith 
11950971522cSBarry Smith #undef __FUNCT__
11960971522cSBarry Smith #define __FUNCT__ "PCFieldSplitSetFields_FieldSplit"
11971e6b0712SBarry Smith static PetscErrorCode  PCFieldSplitSetFields_FieldSplit(PC pc,const char splitname[],PetscInt n,const PetscInt *fields,const PetscInt *fields_col)
11980971522cSBarry Smith {
119997bbdb24SBarry Smith   PC_FieldSplit     *jac = (PC_FieldSplit*)pc->data;
12000971522cSBarry Smith   PetscErrorCode    ierr;
12015a9f2f41SSatish Balay   PC_FieldSplitLink ilink,next = jac->head;
120269a612a9SBarry Smith   char              prefix[128];
12035d4c12cdSJungho Lee   PetscInt          i;
12040971522cSBarry Smith 
12050971522cSBarry Smith   PetscFunctionBegin;
12066c924f48SJed Brown   if (jac->splitdefined) {
12076c924f48SJed Brown     ierr = PetscInfo1(pc,"Ignoring new split \"%s\" because the splits have already been defined\n",splitname);CHKERRQ(ierr);
12086c924f48SJed Brown     PetscFunctionReturn(0);
12096c924f48SJed Brown   }
121051f519a2SBarry Smith   for (i=0; i<n; i++) {
1211e32f2f54SBarry 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);
1212e32f2f54SBarry Smith     if (fields[i] < 0) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Negative field %D requested",fields[i]);
121351f519a2SBarry Smith   }
1214b00a9115SJed Brown   ierr = PetscNew(&ilink);CHKERRQ(ierr);
1215a04f6461SBarry Smith   if (splitname) {
1216db4c96c1SJed Brown     ierr = PetscStrallocpy(splitname,&ilink->splitname);CHKERRQ(ierr);
1217a04f6461SBarry Smith   } else {
1218785e854fSJed Brown     ierr = PetscMalloc1(3,&ilink->splitname);CHKERRQ(ierr);
1219a04f6461SBarry Smith     ierr = PetscSNPrintf(ilink->splitname,2,"%s",jac->nsplits);CHKERRQ(ierr);
1220a04f6461SBarry Smith   }
1221785e854fSJed Brown   ierr = PetscMalloc1(n,&ilink->fields);CHKERRQ(ierr);
12225a9f2f41SSatish Balay   ierr = PetscMemcpy(ilink->fields,fields,n*sizeof(PetscInt));CHKERRQ(ierr);
1223785e854fSJed Brown   ierr = PetscMalloc1(n,&ilink->fields_col);CHKERRQ(ierr);
12245d4c12cdSJungho Lee   ierr = PetscMemcpy(ilink->fields_col,fields_col,n*sizeof(PetscInt));CHKERRQ(ierr);
12252fa5cd67SKarl Rupp 
12265a9f2f41SSatish Balay   ilink->nfields = n;
12270298fd71SBarry Smith   ilink->next    = NULL;
1228ce94432eSBarry Smith   ierr           = KSPCreate(PetscObjectComm((PetscObject)pc),&ilink->ksp);CHKERRQ(ierr);
122920252d06SBarry Smith   ierr           = PetscObjectIncrementTabLevel((PetscObject)ilink->ksp,(PetscObject)pc,1);CHKERRQ(ierr);
12305a9f2f41SSatish Balay   ierr           = KSPSetType(ilink->ksp,KSPPREONLY);CHKERRQ(ierr);
12319005cf84SBarry Smith   ierr           = PetscLogObjectParent((PetscObject)pc,(PetscObject)ilink->ksp);CHKERRQ(ierr);
123269a612a9SBarry Smith 
12338caf3d72SBarry Smith   ierr = PetscSNPrintf(prefix,sizeof(prefix),"%sfieldsplit_%s_",((PetscObject)pc)->prefix ? ((PetscObject)pc)->prefix : "",ilink->splitname);CHKERRQ(ierr);
12345a9f2f41SSatish Balay   ierr = KSPSetOptionsPrefix(ilink->ksp,prefix);CHKERRQ(ierr);
12350971522cSBarry Smith 
12360971522cSBarry Smith   if (!next) {
12375a9f2f41SSatish Balay     jac->head       = ilink;
12380298fd71SBarry Smith     ilink->previous = NULL;
12390971522cSBarry Smith   } else {
12400971522cSBarry Smith     while (next->next) {
12410971522cSBarry Smith       next = next->next;
12420971522cSBarry Smith     }
12435a9f2f41SSatish Balay     next->next      = ilink;
124451f519a2SBarry Smith     ilink->previous = next;
12450971522cSBarry Smith   }
12460971522cSBarry Smith   jac->nsplits++;
12470971522cSBarry Smith   PetscFunctionReturn(0);
12480971522cSBarry Smith }
12490971522cSBarry Smith 
1250e69d4d44SBarry Smith #undef __FUNCT__
1251e69d4d44SBarry Smith #define __FUNCT__ "PCFieldSplitGetSubKSP_FieldSplit_Schur"
12521e6b0712SBarry Smith static PetscErrorCode  PCFieldSplitGetSubKSP_FieldSplit_Schur(PC pc,PetscInt *n,KSP **subksp)
1253e69d4d44SBarry Smith {
1254e69d4d44SBarry Smith   PC_FieldSplit  *jac = (PC_FieldSplit*)pc->data;
1255e69d4d44SBarry Smith   PetscErrorCode ierr;
1256e69d4d44SBarry Smith 
1257e69d4d44SBarry Smith   PetscFunctionBegin;
1258785e854fSJed Brown   ierr = PetscMalloc1(jac->nsplits,subksp);CHKERRQ(ierr);
1259e69d4d44SBarry Smith   ierr = MatSchurComplementGetKSP(jac->schur,*subksp);CHKERRQ(ierr);
12602fa5cd67SKarl Rupp 
1261e69d4d44SBarry Smith   (*subksp)[1] = jac->kspschur;
126213e0d083SBarry Smith   if (n) *n = jac->nsplits;
1263e69d4d44SBarry Smith   PetscFunctionReturn(0);
1264e69d4d44SBarry Smith }
12650971522cSBarry Smith 
12660971522cSBarry Smith #undef __FUNCT__
126769a612a9SBarry Smith #define __FUNCT__ "PCFieldSplitGetSubKSP_FieldSplit"
12681e6b0712SBarry Smith static PetscErrorCode  PCFieldSplitGetSubKSP_FieldSplit(PC pc,PetscInt *n,KSP **subksp)
12690971522cSBarry Smith {
12700971522cSBarry Smith   PC_FieldSplit     *jac = (PC_FieldSplit*)pc->data;
12710971522cSBarry Smith   PetscErrorCode    ierr;
12720971522cSBarry Smith   PetscInt          cnt   = 0;
12735a9f2f41SSatish Balay   PC_FieldSplitLink ilink = jac->head;
12740971522cSBarry Smith 
12750971522cSBarry Smith   PetscFunctionBegin;
1276785e854fSJed Brown   ierr = PetscMalloc1(jac->nsplits,subksp);CHKERRQ(ierr);
12775a9f2f41SSatish Balay   while (ilink) {
12785a9f2f41SSatish Balay     (*subksp)[cnt++] = ilink->ksp;
12795a9f2f41SSatish Balay     ilink            = ilink->next;
12800971522cSBarry Smith   }
12815d480477SMatthew 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);
128213e0d083SBarry Smith   if (n) *n = jac->nsplits;
12830971522cSBarry Smith   PetscFunctionReturn(0);
12840971522cSBarry Smith }
12850971522cSBarry Smith 
1286704ba839SBarry Smith #undef __FUNCT__
1287704ba839SBarry Smith #define __FUNCT__ "PCFieldSplitSetIS_FieldSplit"
12881e6b0712SBarry Smith static PetscErrorCode  PCFieldSplitSetIS_FieldSplit(PC pc,const char splitname[],IS is)
1289704ba839SBarry Smith {
1290704ba839SBarry Smith   PC_FieldSplit     *jac = (PC_FieldSplit*)pc->data;
1291704ba839SBarry Smith   PetscErrorCode    ierr;
1292704ba839SBarry Smith   PC_FieldSplitLink ilink, next = jac->head;
1293704ba839SBarry Smith   char              prefix[128];
1294704ba839SBarry Smith 
1295704ba839SBarry Smith   PetscFunctionBegin;
12966c924f48SJed Brown   if (jac->splitdefined) {
12976c924f48SJed Brown     ierr = PetscInfo1(pc,"Ignoring new split \"%s\" because the splits have already been defined\n",splitname);CHKERRQ(ierr);
12986c924f48SJed Brown     PetscFunctionReturn(0);
12996c924f48SJed Brown   }
1300b00a9115SJed Brown   ierr = PetscNew(&ilink);CHKERRQ(ierr);
1301a04f6461SBarry Smith   if (splitname) {
1302db4c96c1SJed Brown     ierr = PetscStrallocpy(splitname,&ilink->splitname);CHKERRQ(ierr);
1303a04f6461SBarry Smith   } else {
1304785e854fSJed Brown     ierr = PetscMalloc1(8,&ilink->splitname);CHKERRQ(ierr);
1305b5787286SJed Brown     ierr = PetscSNPrintf(ilink->splitname,7,"%D",jac->nsplits);CHKERRQ(ierr);
1306a04f6461SBarry Smith   }
13071ab39975SBarry Smith   ierr          = PetscObjectReference((PetscObject)is);CHKERRQ(ierr);
1308b5787286SJed Brown   ierr          = ISDestroy(&ilink->is);CHKERRQ(ierr);
1309b5787286SJed Brown   ilink->is     = is;
1310b5787286SJed Brown   ierr          = PetscObjectReference((PetscObject)is);CHKERRQ(ierr);
1311b5787286SJed Brown   ierr          = ISDestroy(&ilink->is_col);CHKERRQ(ierr);
1312b5787286SJed Brown   ilink->is_col = is;
13130298fd71SBarry Smith   ilink->next   = NULL;
1314ce94432eSBarry Smith   ierr          = KSPCreate(PetscObjectComm((PetscObject)pc),&ilink->ksp);CHKERRQ(ierr);
131520252d06SBarry Smith   ierr          = PetscObjectIncrementTabLevel((PetscObject)ilink->ksp,(PetscObject)pc,1);CHKERRQ(ierr);
1316704ba839SBarry Smith   ierr          = KSPSetType(ilink->ksp,KSPPREONLY);CHKERRQ(ierr);
13179005cf84SBarry Smith   ierr          = PetscLogObjectParent((PetscObject)pc,(PetscObject)ilink->ksp);CHKERRQ(ierr);
1318704ba839SBarry Smith 
13198caf3d72SBarry Smith   ierr = PetscSNPrintf(prefix,sizeof(prefix),"%sfieldsplit_%s_",((PetscObject)pc)->prefix ? ((PetscObject)pc)->prefix : "",ilink->splitname);CHKERRQ(ierr);
1320704ba839SBarry Smith   ierr = KSPSetOptionsPrefix(ilink->ksp,prefix);CHKERRQ(ierr);
1321704ba839SBarry Smith 
1322704ba839SBarry Smith   if (!next) {
1323704ba839SBarry Smith     jac->head       = ilink;
13240298fd71SBarry Smith     ilink->previous = NULL;
1325704ba839SBarry Smith   } else {
1326704ba839SBarry Smith     while (next->next) {
1327704ba839SBarry Smith       next = next->next;
1328704ba839SBarry Smith     }
1329704ba839SBarry Smith     next->next      = ilink;
1330704ba839SBarry Smith     ilink->previous = next;
1331704ba839SBarry Smith   }
1332704ba839SBarry Smith   jac->nsplits++;
1333704ba839SBarry Smith   PetscFunctionReturn(0);
1334704ba839SBarry Smith }
1335704ba839SBarry Smith 
13360971522cSBarry Smith #undef __FUNCT__
13370971522cSBarry Smith #define __FUNCT__ "PCFieldSplitSetFields"
13380971522cSBarry Smith /*@
13390971522cSBarry Smith     PCFieldSplitSetFields - Sets the fields for one particular split in the field split preconditioner
13400971522cSBarry Smith 
1341ad4df100SBarry Smith     Logically Collective on PC
13420971522cSBarry Smith 
13430971522cSBarry Smith     Input Parameters:
13440971522cSBarry Smith +   pc  - the preconditioner context
13450298fd71SBarry Smith .   splitname - name of this split, if NULL the number of the split is used
13460971522cSBarry Smith .   n - the number of fields in this split
1347db4c96c1SJed Brown -   fields - the fields in this split
13480971522cSBarry Smith 
13490971522cSBarry Smith     Level: intermediate
13500971522cSBarry Smith 
1351d32f9abdSBarry Smith     Notes: Use PCFieldSplitSetIS() to set a completely general set of indices as a field.
1352d32f9abdSBarry Smith 
13537287d2a3SDmitry Karpeev      The PCFieldSplitSetFields() is for defining fields as strided blocks. For example, if the block
1354d32f9abdSBarry 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
1355d32f9abdSBarry Smith      0xx3xx6xx9xx12 ... x1xx4xx7xx ... xx2xx5xx8xx.. 01x34x67x... 0x1x3x5x7.. x12x45x78x....
1356d32f9abdSBarry Smith      where the numbered entries indicate what is in the field.
1357d32f9abdSBarry Smith 
1358db4c96c1SJed Brown      This function is called once per split (it creates a new split each time).  Solve options
1359db4c96c1SJed Brown      for this split will be available under the prefix -fieldsplit_SPLITNAME_.
1360db4c96c1SJed Brown 
13615d4c12cdSJungho Lee      Developer Note: This routine does not actually create the IS representing the split, that is delayed
13625d4c12cdSJungho Lee      until PCSetUp_FieldSplit(), because information about the vector/matrix layouts may not be
13635d4c12cdSJungho Lee      available when this routine is called.
13645d4c12cdSJungho Lee 
1365d32f9abdSBarry Smith .seealso: PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitSetBlockSize(), PCFieldSplitSetIS()
13660971522cSBarry Smith 
13670971522cSBarry Smith @*/
13685d4c12cdSJungho Lee PetscErrorCode  PCFieldSplitSetFields(PC pc,const char splitname[],PetscInt n,const PetscInt *fields,const PetscInt *fields_col)
13690971522cSBarry Smith {
13704ac538c5SBarry Smith   PetscErrorCode ierr;
13710971522cSBarry Smith 
13720971522cSBarry Smith   PetscFunctionBegin;
13730700a824SBarry Smith   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
1374db4c96c1SJed Brown   PetscValidCharPointer(splitname,2);
1375ce94432eSBarry Smith   if (n < 1) SETERRQ2(PetscObjectComm((PetscObject)pc),PETSC_ERR_ARG_OUTOFRANGE,"Provided number of fields %D in split \"%s\" not positive",n,splitname);
1376db4c96c1SJed Brown   PetscValidIntPointer(fields,3);
13775d4c12cdSJungho Lee   ierr = PetscTryMethod(pc,"PCFieldSplitSetFields_C",(PC,const char[],PetscInt,const PetscInt*,const PetscInt*),(pc,splitname,n,fields,fields_col));CHKERRQ(ierr);
13780971522cSBarry Smith   PetscFunctionReturn(0);
13790971522cSBarry Smith }
13800971522cSBarry Smith 
13810971522cSBarry Smith #undef __FUNCT__
1382c84da90fSDmitry Karpeev #define __FUNCT__ "PCFieldSplitSetDiagUseAmat"
1383c84da90fSDmitry Karpeev /*@
1384c84da90fSDmitry Karpeev     PCFieldSplitSetDiagUseAmat - set flag indicating whether to extract diagonal blocks from Amat (rather than Pmat)
1385c84da90fSDmitry Karpeev 
1386c84da90fSDmitry Karpeev     Logically Collective on PC
1387c84da90fSDmitry Karpeev 
1388c84da90fSDmitry Karpeev     Input Parameters:
1389c84da90fSDmitry Karpeev +   pc  - the preconditioner object
1390c84da90fSDmitry Karpeev -   flg - boolean flag indicating whether or not to use Amat to extract the diagonal blocks from
1391c84da90fSDmitry Karpeev 
13929506b623SDmitry Karpeev     Options Database:
13939506b623SDmitry Karpeev .     -pc_fieldsplit_diag_use_amat
1394c84da90fSDmitry Karpeev 
1395c84da90fSDmitry Karpeev     Level: intermediate
1396c84da90fSDmitry Karpeev 
1397c84da90fSDmitry Karpeev .seealso: PCFieldSplitGetDiagUseAmat(), PCFieldSplitSetOffDiagUseAmat(), PCFIELDSPLIT
1398c84da90fSDmitry Karpeev 
1399c84da90fSDmitry Karpeev @*/
1400c84da90fSDmitry Karpeev PetscErrorCode  PCFieldSplitSetDiagUseAmat(PC pc,PetscBool flg)
1401c84da90fSDmitry Karpeev {
1402c84da90fSDmitry Karpeev   PC_FieldSplit  *jac = (PC_FieldSplit*)pc->data;
1403c84da90fSDmitry Karpeev   PetscBool      isfs;
1404c84da90fSDmitry Karpeev   PetscErrorCode ierr;
1405c84da90fSDmitry Karpeev 
1406c84da90fSDmitry Karpeev   PetscFunctionBegin;
1407c84da90fSDmitry Karpeev   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
1408c84da90fSDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)pc,PCFIELDSPLIT,&isfs);CHKERRQ(ierr);
1409c84da90fSDmitry Karpeev   if (!isfs) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"PC not of type %s",PCFIELDSPLIT);
1410c84da90fSDmitry Karpeev   jac->diag_use_amat = flg;
1411c84da90fSDmitry Karpeev   PetscFunctionReturn(0);
1412c84da90fSDmitry Karpeev }
1413c84da90fSDmitry Karpeev 
1414c84da90fSDmitry Karpeev #undef __FUNCT__
1415c84da90fSDmitry Karpeev #define __FUNCT__ "PCFieldSplitGetDiagUseAmat"
1416c84da90fSDmitry Karpeev /*@
1417c84da90fSDmitry Karpeev     PCFieldSplitGetDiagUseAmat - get the flag indicating whether to extract diagonal blocks from Amat (rather than Pmat)
1418c84da90fSDmitry Karpeev 
1419c84da90fSDmitry Karpeev     Logically Collective on PC
1420c84da90fSDmitry Karpeev 
1421c84da90fSDmitry Karpeev     Input Parameters:
1422c84da90fSDmitry Karpeev .   pc  - the preconditioner object
1423c84da90fSDmitry Karpeev 
1424c84da90fSDmitry Karpeev     Output Parameters:
1425c84da90fSDmitry Karpeev .   flg - boolean flag indicating whether or not to use Amat to extract the diagonal blocks from
1426c84da90fSDmitry Karpeev 
1427c84da90fSDmitry Karpeev 
1428c84da90fSDmitry Karpeev     Level: intermediate
1429c84da90fSDmitry Karpeev 
1430c84da90fSDmitry Karpeev .seealso: PCFieldSplitSetDiagUseAmat(), PCFieldSplitGetOffDiagUseAmat(), PCFIELDSPLIT
1431c84da90fSDmitry Karpeev 
1432c84da90fSDmitry Karpeev @*/
1433c84da90fSDmitry Karpeev PetscErrorCode  PCFieldSplitGetDiagUseAmat(PC pc,PetscBool *flg)
1434c84da90fSDmitry Karpeev {
1435c84da90fSDmitry Karpeev   PC_FieldSplit  *jac = (PC_FieldSplit*)pc->data;
1436c84da90fSDmitry Karpeev   PetscBool      isfs;
1437c84da90fSDmitry Karpeev   PetscErrorCode ierr;
1438c84da90fSDmitry Karpeev 
1439c84da90fSDmitry Karpeev   PetscFunctionBegin;
1440c84da90fSDmitry Karpeev   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
1441c84da90fSDmitry Karpeev   PetscValidPointer(flg,2);
1442c84da90fSDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)pc,PCFIELDSPLIT,&isfs);CHKERRQ(ierr);
1443c84da90fSDmitry Karpeev   if (!isfs) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"PC not of type %s",PCFIELDSPLIT);
1444c84da90fSDmitry Karpeev   *flg = jac->diag_use_amat;
1445c84da90fSDmitry Karpeev   PetscFunctionReturn(0);
1446c84da90fSDmitry Karpeev }
1447c84da90fSDmitry Karpeev 
1448c84da90fSDmitry Karpeev #undef __FUNCT__
1449c84da90fSDmitry Karpeev #define __FUNCT__ "PCFieldSplitSetOffDiagUseAmat"
1450c84da90fSDmitry Karpeev /*@
1451c84da90fSDmitry Karpeev     PCFieldSplitSetOffDiagUseAmat - set flag indicating whether to extract off-diagonal blocks from Amat (rather than Pmat)
1452c84da90fSDmitry Karpeev 
1453c84da90fSDmitry Karpeev     Logically Collective on PC
1454c84da90fSDmitry Karpeev 
1455c84da90fSDmitry Karpeev     Input Parameters:
1456c84da90fSDmitry Karpeev +   pc  - the preconditioner object
1457c84da90fSDmitry Karpeev -   flg - boolean flag indicating whether or not to use Amat to extract the off-diagonal blocks from
1458c84da90fSDmitry Karpeev 
14599506b623SDmitry Karpeev     Options Database:
14609506b623SDmitry Karpeev .     -pc_fieldsplit_off_diag_use_amat
1461c84da90fSDmitry Karpeev 
1462c84da90fSDmitry Karpeev     Level: intermediate
1463c84da90fSDmitry Karpeev 
1464c84da90fSDmitry Karpeev .seealso: PCFieldSplitGetOffDiagUseAmat(), PCFieldSplitSetDiagUseAmat(), PCFIELDSPLIT
1465c84da90fSDmitry Karpeev 
1466c84da90fSDmitry Karpeev @*/
1467c84da90fSDmitry Karpeev PetscErrorCode  PCFieldSplitSetOffDiagUseAmat(PC pc,PetscBool flg)
1468c84da90fSDmitry Karpeev {
1469c84da90fSDmitry Karpeev   PC_FieldSplit *jac = (PC_FieldSplit*)pc->data;
1470c84da90fSDmitry Karpeev   PetscBool      isfs;
1471c84da90fSDmitry Karpeev   PetscErrorCode ierr;
1472c84da90fSDmitry Karpeev 
1473c84da90fSDmitry Karpeev   PetscFunctionBegin;
1474c84da90fSDmitry Karpeev   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
1475c84da90fSDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)pc,PCFIELDSPLIT,&isfs);CHKERRQ(ierr);
1476c84da90fSDmitry Karpeev   if (!isfs) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"PC not of type %s",PCFIELDSPLIT);
1477c84da90fSDmitry Karpeev   jac->offdiag_use_amat = flg;
1478c84da90fSDmitry Karpeev   PetscFunctionReturn(0);
1479c84da90fSDmitry Karpeev }
1480c84da90fSDmitry Karpeev 
1481c84da90fSDmitry Karpeev #undef __FUNCT__
1482c84da90fSDmitry Karpeev #define __FUNCT__ "PCFieldSplitGetOffDiagUseAmat"
1483c84da90fSDmitry Karpeev /*@
1484c84da90fSDmitry Karpeev     PCFieldSplitGetOffDiagUseAmat - get the flag indicating whether to extract off-diagonal blocks from Amat (rather than Pmat)
1485c84da90fSDmitry Karpeev 
1486c84da90fSDmitry Karpeev     Logically Collective on PC
1487c84da90fSDmitry Karpeev 
1488c84da90fSDmitry Karpeev     Input Parameters:
1489c84da90fSDmitry Karpeev .   pc  - the preconditioner object
1490c84da90fSDmitry Karpeev 
1491c84da90fSDmitry Karpeev     Output Parameters:
1492c84da90fSDmitry Karpeev .   flg - boolean flag indicating whether or not to use Amat to extract the off-diagonal blocks from
1493c84da90fSDmitry Karpeev 
1494c84da90fSDmitry Karpeev 
1495c84da90fSDmitry Karpeev     Level: intermediate
1496c84da90fSDmitry Karpeev 
1497c84da90fSDmitry Karpeev .seealso: PCFieldSplitSetOffDiagUseAmat(), PCFieldSplitGetDiagUseAmat(), PCFIELDSPLIT
1498c84da90fSDmitry Karpeev 
1499c84da90fSDmitry Karpeev @*/
1500c84da90fSDmitry Karpeev PetscErrorCode  PCFieldSplitGetOffDiagUseAmat(PC pc,PetscBool *flg)
1501c84da90fSDmitry Karpeev {
1502c84da90fSDmitry Karpeev   PC_FieldSplit  *jac = (PC_FieldSplit*)pc->data;
1503c84da90fSDmitry Karpeev   PetscBool      isfs;
1504c84da90fSDmitry Karpeev   PetscErrorCode ierr;
1505c84da90fSDmitry Karpeev 
1506c84da90fSDmitry Karpeev   PetscFunctionBegin;
1507c84da90fSDmitry Karpeev   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
1508c84da90fSDmitry Karpeev   PetscValidPointer(flg,2);
1509c84da90fSDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)pc,PCFIELDSPLIT,&isfs);CHKERRQ(ierr);
1510c84da90fSDmitry Karpeev   if (!isfs) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"PC not of type %s",PCFIELDSPLIT);
1511c84da90fSDmitry Karpeev   *flg = jac->offdiag_use_amat;
1512c84da90fSDmitry Karpeev   PetscFunctionReturn(0);
1513c84da90fSDmitry Karpeev }
1514c84da90fSDmitry Karpeev 
1515c84da90fSDmitry Karpeev 
1516c84da90fSDmitry Karpeev 
1517c84da90fSDmitry Karpeev #undef __FUNCT__
1518704ba839SBarry Smith #define __FUNCT__ "PCFieldSplitSetIS"
1519*218d4943SBarry Smith /*@C
1520704ba839SBarry Smith     PCFieldSplitSetIS - Sets the exact elements for field
1521704ba839SBarry Smith 
1522ad4df100SBarry Smith     Logically Collective on PC
1523704ba839SBarry Smith 
1524704ba839SBarry Smith     Input Parameters:
1525704ba839SBarry Smith +   pc  - the preconditioner context
15260298fd71SBarry Smith .   splitname - name of this split, if NULL the number of the split is used
1527db4c96c1SJed Brown -   is - the index set that defines the vector elements in this field
1528704ba839SBarry Smith 
1529d32f9abdSBarry Smith 
1530a6ffb8dbSJed Brown     Notes:
1531a6ffb8dbSJed Brown     Use PCFieldSplitSetFields(), for fields defined by strided types.
1532a6ffb8dbSJed Brown 
1533db4c96c1SJed Brown     This function is called once per split (it creates a new split each time).  Solve options
1534db4c96c1SJed Brown     for this split will be available under the prefix -fieldsplit_SPLITNAME_.
1535d32f9abdSBarry Smith 
1536704ba839SBarry Smith     Level: intermediate
1537704ba839SBarry Smith 
1538704ba839SBarry Smith .seealso: PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitSetBlockSize()
1539704ba839SBarry Smith 
1540704ba839SBarry Smith @*/
15417087cfbeSBarry Smith PetscErrorCode  PCFieldSplitSetIS(PC pc,const char splitname[],IS is)
1542704ba839SBarry Smith {
15434ac538c5SBarry Smith   PetscErrorCode ierr;
1544704ba839SBarry Smith 
1545704ba839SBarry Smith   PetscFunctionBegin;
15460700a824SBarry Smith   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
15477b62db95SJungho Lee   if (splitname) PetscValidCharPointer(splitname,2);
1548db4c96c1SJed Brown   PetscValidHeaderSpecific(is,IS_CLASSID,3);
15494ac538c5SBarry Smith   ierr = PetscTryMethod(pc,"PCFieldSplitSetIS_C",(PC,const char[],IS),(pc,splitname,is));CHKERRQ(ierr);
1550704ba839SBarry Smith   PetscFunctionReturn(0);
1551704ba839SBarry Smith }
1552704ba839SBarry Smith 
1553704ba839SBarry Smith #undef __FUNCT__
155457a9adfeSMatthew G Knepley #define __FUNCT__ "PCFieldSplitGetIS"
155557a9adfeSMatthew G Knepley /*@
155657a9adfeSMatthew G Knepley     PCFieldSplitGetIS - Retrieves the elements for a field as an IS
155757a9adfeSMatthew G Knepley 
155857a9adfeSMatthew G Knepley     Logically Collective on PC
155957a9adfeSMatthew G Knepley 
156057a9adfeSMatthew G Knepley     Input Parameters:
156157a9adfeSMatthew G Knepley +   pc  - the preconditioner context
156257a9adfeSMatthew G Knepley -   splitname - name of this split
156357a9adfeSMatthew G Knepley 
156457a9adfeSMatthew G Knepley     Output Parameter:
15650298fd71SBarry Smith -   is - the index set that defines the vector elements in this field, or NULL if the field is not found
156657a9adfeSMatthew G Knepley 
156757a9adfeSMatthew G Knepley     Level: intermediate
156857a9adfeSMatthew G Knepley 
156957a9adfeSMatthew G Knepley .seealso: PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitSetIS()
157057a9adfeSMatthew G Knepley 
157157a9adfeSMatthew G Knepley @*/
157257a9adfeSMatthew G Knepley PetscErrorCode PCFieldSplitGetIS(PC pc,const char splitname[],IS *is)
157357a9adfeSMatthew G Knepley {
157457a9adfeSMatthew G Knepley   PetscErrorCode ierr;
157557a9adfeSMatthew G Knepley 
157657a9adfeSMatthew G Knepley   PetscFunctionBegin;
157757a9adfeSMatthew G Knepley   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
157857a9adfeSMatthew G Knepley   PetscValidCharPointer(splitname,2);
157957a9adfeSMatthew G Knepley   PetscValidPointer(is,3);
158057a9adfeSMatthew G Knepley   {
158157a9adfeSMatthew G Knepley     PC_FieldSplit     *jac  = (PC_FieldSplit*) pc->data;
158257a9adfeSMatthew G Knepley     PC_FieldSplitLink ilink = jac->head;
158357a9adfeSMatthew G Knepley     PetscBool         found;
158457a9adfeSMatthew G Knepley 
15850298fd71SBarry Smith     *is = NULL;
158657a9adfeSMatthew G Knepley     while (ilink) {
158757a9adfeSMatthew G Knepley       ierr = PetscStrcmp(ilink->splitname, splitname, &found);CHKERRQ(ierr);
158857a9adfeSMatthew G Knepley       if (found) {
158957a9adfeSMatthew G Knepley         *is = ilink->is;
159057a9adfeSMatthew G Knepley         break;
159157a9adfeSMatthew G Knepley       }
159257a9adfeSMatthew G Knepley       ilink = ilink->next;
159357a9adfeSMatthew G Knepley     }
159457a9adfeSMatthew G Knepley   }
159557a9adfeSMatthew G Knepley   PetscFunctionReturn(0);
159657a9adfeSMatthew G Knepley }
159757a9adfeSMatthew G Knepley 
159857a9adfeSMatthew G Knepley #undef __FUNCT__
159951f519a2SBarry Smith #define __FUNCT__ "PCFieldSplitSetBlockSize"
160051f519a2SBarry Smith /*@
160151f519a2SBarry Smith     PCFieldSplitSetBlockSize - Sets the block size for defining where fields start in the
160251f519a2SBarry Smith       fieldsplit preconditioner. If not set the matrix block size is used.
160351f519a2SBarry Smith 
1604ad4df100SBarry Smith     Logically Collective on PC
160551f519a2SBarry Smith 
160651f519a2SBarry Smith     Input Parameters:
160751f519a2SBarry Smith +   pc  - the preconditioner context
160851f519a2SBarry Smith -   bs - the block size
160951f519a2SBarry Smith 
161051f519a2SBarry Smith     Level: intermediate
161151f519a2SBarry Smith 
161251f519a2SBarry Smith .seealso: PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitSetFields()
161351f519a2SBarry Smith 
161451f519a2SBarry Smith @*/
16157087cfbeSBarry Smith PetscErrorCode  PCFieldSplitSetBlockSize(PC pc,PetscInt bs)
161651f519a2SBarry Smith {
16174ac538c5SBarry Smith   PetscErrorCode ierr;
161851f519a2SBarry Smith 
161951f519a2SBarry Smith   PetscFunctionBegin;
16200700a824SBarry Smith   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
1621c5eb9154SBarry Smith   PetscValidLogicalCollectiveInt(pc,bs,2);
16224ac538c5SBarry Smith   ierr = PetscTryMethod(pc,"PCFieldSplitSetBlockSize_C",(PC,PetscInt),(pc,bs));CHKERRQ(ierr);
162351f519a2SBarry Smith   PetscFunctionReturn(0);
162451f519a2SBarry Smith }
162551f519a2SBarry Smith 
162651f519a2SBarry Smith #undef __FUNCT__
162769a612a9SBarry Smith #define __FUNCT__ "PCFieldSplitGetSubKSP"
16280971522cSBarry Smith /*@C
162969a612a9SBarry Smith    PCFieldSplitGetSubKSP - Gets the KSP contexts for all splits
16300971522cSBarry Smith 
163169a612a9SBarry Smith    Collective on KSP
16320971522cSBarry Smith 
16330971522cSBarry Smith    Input Parameter:
16340971522cSBarry Smith .  pc - the preconditioner context
16350971522cSBarry Smith 
16360971522cSBarry Smith    Output Parameters:
163713e0d083SBarry Smith +  n - the number of splits
163869a612a9SBarry Smith -  pc - the array of KSP contexts
16390971522cSBarry Smith 
16400971522cSBarry Smith    Note:
1641d32f9abdSBarry Smith    After PCFieldSplitGetSubKSP() the array of KSPs IS to be freed by the user
1642d32f9abdSBarry Smith    (not the KSP just the array that contains them).
16430971522cSBarry Smith 
164469a612a9SBarry Smith    You must call KSPSetUp() before calling PCFieldSplitGetSubKSP().
16450971522cSBarry Smith 
1646196cc216SBarry Smith    Fortran Usage: You must pass in a KSP array that is large enough to contain all the local KSPs.
16470298fd71SBarry Smith       You can call PCFieldSplitGetSubKSP(pc,n,NULL_OBJECT,ierr) to determine how large the
1648196cc216SBarry Smith       KSP array must be.
1649196cc216SBarry Smith 
1650196cc216SBarry Smith 
16510971522cSBarry Smith    Level: advanced
16520971522cSBarry Smith 
16530971522cSBarry Smith .seealso: PCFIELDSPLIT
16540971522cSBarry Smith @*/
16557087cfbeSBarry Smith PetscErrorCode  PCFieldSplitGetSubKSP(PC pc,PetscInt *n,KSP *subksp[])
16560971522cSBarry Smith {
16574ac538c5SBarry Smith   PetscErrorCode ierr;
16580971522cSBarry Smith 
16590971522cSBarry Smith   PetscFunctionBegin;
16600700a824SBarry Smith   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
166113e0d083SBarry Smith   if (n) PetscValidIntPointer(n,2);
16624ac538c5SBarry Smith   ierr = PetscUseMethod(pc,"PCFieldSplitGetSubKSP_C",(PC,PetscInt*,KSP **),(pc,n,subksp));CHKERRQ(ierr);
16630971522cSBarry Smith   PetscFunctionReturn(0);
16640971522cSBarry Smith }
16650971522cSBarry Smith 
1666e69d4d44SBarry Smith #undef __FUNCT__
166729f8a81cSJed Brown #define __FUNCT__ "PCFieldSplitSetSchurPre"
1668e69d4d44SBarry Smith /*@
166929f8a81cSJed Brown     PCFieldSplitSetSchurPre -  Indicates if the Schur complement is preconditioned by a preconditioner constructed by the
1670a04f6461SBarry Smith       A11 matrix. Otherwise no preconditioner is used.
1671e69d4d44SBarry Smith 
1672e69d4d44SBarry Smith     Collective on PC
1673e69d4d44SBarry Smith 
1674e69d4d44SBarry Smith     Input Parameters:
1675e69d4d44SBarry Smith +   pc      - the preconditioner context
1676a7476a74SDmitry Karpeev .   ptype   - which matrix to use for preconditioning the Schur complement: PC_FIELDSPLIT_SCHUR_PRE_A11 (default), PC_FIELDSPLIT_SCHUR_PRE_SELF, PC_FIELDSPLIT_PRE_USER
16770298fd71SBarry Smith -   userpre - matrix to use for preconditioning, or NULL
1678084e4875SJed Brown 
1679e69d4d44SBarry Smith     Options Database:
16802e71c61dSMatthew G. Knepley .     -pc_fieldsplit_schur_precondition <self,selfp,user,a11,full> default is a11
1681e69d4d44SBarry Smith 
1682fd1303e9SJungho Lee     Notes:
1683fd1303e9SJungho Lee $    If ptype is
1684fd1303e9SJungho Lee $        user then the preconditioner for the Schur complement is generated by the provided matrix (pre argument
1685fd1303e9SJungho Lee $             to this function).
1686585af1b9SMatthew G. Knepley $        a11 then the preconditioner for the Schur complement is generated by the block diagonal part of the preconditioner
1687585af1b9SMatthew G. Knepley $             matrix associated with the Schur complement (i.e. A11), not he Schur complement matrix
1688e74569cdSMatthew G. Knepley $        full then the preconditioner uses the exact Schur complement (this is expensive)
1689fd1303e9SJungho Lee $        self the preconditioner for the Schur complement is generated from the Schur complement matrix itself:
1690fd1303e9SJungho Lee $             The only preconditioner that currently works directly with the Schur complement matrix object is the PCLSC
1691fd1303e9SJungho Lee $             preconditioner
1692a7476a74SDmitry Karpeev $        selfp then the preconditioning matrix is an explicitly-assembled approximation Sp = A11 - A10 inv(diag(A00)) A01
1693a7476a74SDmitry Karpeev $             This is only a good preconditioner when diag(A00) is a good preconditioner for A00.
1694fd1303e9SJungho Lee 
1695e87fab1bSBarry Smith      When solving a saddle point problem, where the A11 block is identically zero, using a11 as the ptype only makes sense
1696fd1303e9SJungho Lee     with the additional option -fieldsplit_1_pc_type none. Usually for saddle point problems one would use a ptype of self and
1697a7476a74SDmitry Karpeev     -fieldsplit_1_pc_type lsc which uses the least squares commutator to compute a preconditioner for the Schur complement.
1698fd1303e9SJungho Lee 
1699e69d4d44SBarry Smith     Level: intermediate
1700e69d4d44SBarry Smith 
170137a82bf0SJed Brown .seealso: PCFieldSplitGetSchurPre(), PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitSetFields(), PCFieldSplitSchurPreType, PCLSC
1702e69d4d44SBarry Smith 
1703e69d4d44SBarry Smith @*/
170429f8a81cSJed Brown PetscErrorCode PCFieldSplitSetSchurPre(PC pc,PCFieldSplitSchurPreType ptype,Mat pre)
1705e69d4d44SBarry Smith {
17064ac538c5SBarry Smith   PetscErrorCode ierr;
1707e69d4d44SBarry Smith 
1708e69d4d44SBarry Smith   PetscFunctionBegin;
17090700a824SBarry Smith   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
171029f8a81cSJed Brown   ierr = PetscTryMethod(pc,"PCFieldSplitSetSchurPre_C",(PC,PCFieldSplitSchurPreType,Mat),(pc,ptype,pre));CHKERRQ(ierr);
1711e69d4d44SBarry Smith   PetscFunctionReturn(0);
1712e69d4d44SBarry Smith }
171329f8a81cSJed Brown PetscErrorCode PCFieldSplitSchurPrecondition(PC pc,PCFieldSplitSchurPreType ptype,Mat pre) {return PCFieldSplitSetSchurPre(pc,ptype,pre);} /* Deprecated name */
1714e69d4d44SBarry Smith 
1715e69d4d44SBarry Smith #undef __FUNCT__
171637a82bf0SJed Brown #define __FUNCT__ "PCFieldSplitGetSchurPre"
171737a82bf0SJed Brown /*@
171837a82bf0SJed Brown     PCFieldSplitGetSchurPre - For Schur complement fieldsplit, determine how the Schur complement will be
171929f8a81cSJed Brown     preconditioned.  See PCFieldSplitSetSchurPre() for details.
172037a82bf0SJed Brown 
172137a82bf0SJed Brown     Logically Collective on PC
172237a82bf0SJed Brown 
172337a82bf0SJed Brown     Input Parameters:
172437a82bf0SJed Brown .   pc      - the preconditioner context
172537a82bf0SJed Brown 
172637a82bf0SJed Brown     Output Parameters:
172737a82bf0SJed 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
172837a82bf0SJed Brown -   userpre - matrix to use for preconditioning (with PC_FIELDSPLIT_PRE_USER), or NULL
172937a82bf0SJed Brown 
173037a82bf0SJed Brown     Level: intermediate
173137a82bf0SJed Brown 
173229f8a81cSJed Brown .seealso: PCFieldSplitSetSchurPre(), PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitSetFields(), PCFieldSplitSchurPreType, PCLSC
173337a82bf0SJed Brown 
173437a82bf0SJed Brown @*/
173537a82bf0SJed Brown PetscErrorCode PCFieldSplitGetSchurPre(PC pc,PCFieldSplitSchurPreType *ptype,Mat *pre)
173637a82bf0SJed Brown {
173737a82bf0SJed Brown   PetscErrorCode ierr;
173837a82bf0SJed Brown 
173937a82bf0SJed Brown   PetscFunctionBegin;
174037a82bf0SJed Brown   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
174137a82bf0SJed Brown   ierr = PetscUseMethod(pc,"PCFieldSplitGetSchurPre_C",(PC,PCFieldSplitSchurPreType*,Mat*),(pc,ptype,pre));CHKERRQ(ierr);
1742e69d4d44SBarry Smith   PetscFunctionReturn(0);
1743e69d4d44SBarry Smith }
1744e69d4d44SBarry Smith 
1745e69d4d44SBarry Smith #undef __FUNCT__
1746470b340bSDmitry Karpeev #define __FUNCT__ "PCFieldSplitSchurGetS"
174745e7fc46SDmitry Karpeev /*@
1748470b340bSDmitry Karpeev     PCFieldSplitSchurGetS -  extract the MatSchurComplement object used by this PC in case it needs to be configured separately
174945e7fc46SDmitry Karpeev 
175045e7fc46SDmitry Karpeev     Not collective
175145e7fc46SDmitry Karpeev 
175245e7fc46SDmitry Karpeev     Input Parameter:
175345e7fc46SDmitry Karpeev .   pc      - the preconditioner context
175445e7fc46SDmitry Karpeev 
175545e7fc46SDmitry Karpeev     Output Parameter:
1756470b340bSDmitry Karpeev .   S       - the Schur complement matrix
175745e7fc46SDmitry Karpeev 
1758470b340bSDmitry Karpeev     Notes:
1759470b340bSDmitry Karpeev     This matrix should not be destroyed using MatDestroy(); rather, use PCFieldSplitSchurRestoreS().
176045e7fc46SDmitry Karpeev 
176145e7fc46SDmitry Karpeev     Level: advanced
176245e7fc46SDmitry Karpeev 
176329f8a81cSJed Brown .seealso: PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitSchurPreType, PCFieldSplitSetSchurPre(), MatSchurComplement, PCFieldSplitSchurRestoreS()
176445e7fc46SDmitry Karpeev 
176545e7fc46SDmitry Karpeev @*/
1766470b340bSDmitry Karpeev PetscErrorCode  PCFieldSplitSchurGetS(PC pc,Mat *S)
176745e7fc46SDmitry Karpeev {
176845e7fc46SDmitry Karpeev   PetscErrorCode ierr;
176945e7fc46SDmitry Karpeev   const char*    t;
177045e7fc46SDmitry Karpeev   PetscBool      isfs;
177145e7fc46SDmitry Karpeev   PC_FieldSplit  *jac;
177245e7fc46SDmitry Karpeev 
177345e7fc46SDmitry Karpeev   PetscFunctionBegin;
177445e7fc46SDmitry Karpeev   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
177545e7fc46SDmitry Karpeev   ierr = PetscObjectGetType((PetscObject)pc,&t);CHKERRQ(ierr);
177645e7fc46SDmitry Karpeev   ierr = PetscStrcmp(t,PCFIELDSPLIT,&isfs);CHKERRQ(ierr);
177745e7fc46SDmitry Karpeev   if (!isfs) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Expected PC of type PCFIELDSPLIT, got %s instead",t);
177845e7fc46SDmitry Karpeev   jac = (PC_FieldSplit*)pc->data;
1779470b340bSDmitry 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);
1780470b340bSDmitry Karpeev   if (S) *S = jac->schur;
178145e7fc46SDmitry Karpeev   PetscFunctionReturn(0);
178245e7fc46SDmitry Karpeev }
178345e7fc46SDmitry Karpeev 
178445e7fc46SDmitry Karpeev #undef __FUNCT__
1785470b340bSDmitry Karpeev #define __FUNCT__ "PCFieldSplitSchurRestoreS"
1786470b340bSDmitry Karpeev /*@
1787470b340bSDmitry Karpeev     PCFieldSplitSchurRestoreS -  restores the MatSchurComplement object used by this PC
1788470b340bSDmitry Karpeev 
1789470b340bSDmitry Karpeev     Not collective
1790470b340bSDmitry Karpeev 
1791470b340bSDmitry Karpeev     Input Parameters:
1792470b340bSDmitry Karpeev +   pc      - the preconditioner context
1793470b340bSDmitry Karpeev .   S       - the Schur complement matrix
1794470b340bSDmitry Karpeev 
1795470b340bSDmitry Karpeev     Level: advanced
1796470b340bSDmitry Karpeev 
179729f8a81cSJed Brown .seealso: PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitSchurPreType, PCFieldSplitSetSchurPre(), MatSchurComplement, PCFieldSplitSchurGetS()
1798470b340bSDmitry Karpeev 
1799470b340bSDmitry Karpeev @*/
1800bca69d2bSDmitry Karpeev PetscErrorCode  PCFieldSplitSchurRestoreS(PC pc,Mat *S)
1801470b340bSDmitry Karpeev {
1802470b340bSDmitry Karpeev   PetscErrorCode ierr;
1803470b340bSDmitry Karpeev   const char*    t;
1804470b340bSDmitry Karpeev   PetscBool      isfs;
1805470b340bSDmitry Karpeev   PC_FieldSplit  *jac;
1806470b340bSDmitry Karpeev 
1807470b340bSDmitry Karpeev   PetscFunctionBegin;
1808470b340bSDmitry Karpeev   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
1809470b340bSDmitry Karpeev   ierr = PetscObjectGetType((PetscObject)pc,&t);CHKERRQ(ierr);
1810470b340bSDmitry Karpeev   ierr = PetscStrcmp(t,PCFIELDSPLIT,&isfs);CHKERRQ(ierr);
1811470b340bSDmitry Karpeev   if (!isfs) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Expected PC of type PCFIELDSPLIT, got %s instead",t);
1812470b340bSDmitry Karpeev   jac = (PC_FieldSplit*)pc->data;
1813470b340bSDmitry 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);
1814bca69d2bSDmitry Karpeev   if (!S || *S != jac->schur) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"MatSchurComplement restored is not the same as gotten");
1815470b340bSDmitry Karpeev   PetscFunctionReturn(0);
1816470b340bSDmitry Karpeev }
1817470b340bSDmitry Karpeev 
1818470b340bSDmitry Karpeev 
1819470b340bSDmitry Karpeev #undef __FUNCT__
182029f8a81cSJed Brown #define __FUNCT__ "PCFieldSplitSetSchurPre_FieldSplit"
182129f8a81cSJed Brown static PetscErrorCode  PCFieldSplitSetSchurPre_FieldSplit(PC pc,PCFieldSplitSchurPreType ptype,Mat pre)
1822e69d4d44SBarry Smith {
1823e69d4d44SBarry Smith   PC_FieldSplit  *jac = (PC_FieldSplit*)pc->data;
1824084e4875SJed Brown   PetscErrorCode ierr;
1825e69d4d44SBarry Smith 
1826e69d4d44SBarry Smith   PetscFunctionBegin;
1827084e4875SJed Brown   jac->schurpre = ptype;
1828a7476a74SDmitry Karpeev   if (ptype == PC_FIELDSPLIT_SCHUR_PRE_USER && pre) {
18296bf464f9SBarry Smith     ierr            = MatDestroy(&jac->schur_user);CHKERRQ(ierr);
1830084e4875SJed Brown     jac->schur_user = pre;
1831084e4875SJed Brown     ierr            = PetscObjectReference((PetscObject)jac->schur_user);CHKERRQ(ierr);
1832084e4875SJed Brown   }
1833e69d4d44SBarry Smith   PetscFunctionReturn(0);
1834e69d4d44SBarry Smith }
1835e69d4d44SBarry Smith 
183630ad9308SMatthew Knepley #undef __FUNCT__
183737a82bf0SJed Brown #define __FUNCT__ "PCFieldSplitGetSchurPre_FieldSplit"
183837a82bf0SJed Brown static PetscErrorCode  PCFieldSplitGetSchurPre_FieldSplit(PC pc,PCFieldSplitSchurPreType *ptype,Mat *pre)
183937a82bf0SJed Brown {
184037a82bf0SJed Brown   PC_FieldSplit  *jac = (PC_FieldSplit*)pc->data;
184137a82bf0SJed Brown 
184237a82bf0SJed Brown   PetscFunctionBegin;
184337a82bf0SJed Brown   *ptype = jac->schurpre;
184437a82bf0SJed Brown   *pre   = jac->schur_user;
184537a82bf0SJed Brown   PetscFunctionReturn(0);
184637a82bf0SJed Brown }
184737a82bf0SJed Brown 
184837a82bf0SJed Brown #undef __FUNCT__
1849c9c6ffaaSJed Brown #define __FUNCT__ "PCFieldSplitSetSchurFactType"
1850ab1df9f5SJed Brown /*@
1851c9c6ffaaSJed Brown     PCFieldSplitSetSchurFactType -  sets which blocks of the approximate block factorization to retain
1852ab1df9f5SJed Brown 
1853ab1df9f5SJed Brown     Collective on PC
1854ab1df9f5SJed Brown 
1855ab1df9f5SJed Brown     Input Parameters:
1856ab1df9f5SJed Brown +   pc  - the preconditioner context
1857c9c6ffaaSJed Brown -   ftype - which blocks of factorization to retain, PC_FIELDSPLIT_SCHUR_FACT_FULL is default
1858ab1df9f5SJed Brown 
1859ab1df9f5SJed Brown     Options Database:
1860c9c6ffaaSJed Brown .     -pc_fieldsplit_schur_fact_type <diag,lower,upper,full> default is full
1861ab1df9f5SJed Brown 
1862ab1df9f5SJed Brown 
1863ab1df9f5SJed Brown     Level: intermediate
1864ab1df9f5SJed Brown 
1865ab1df9f5SJed Brown     Notes:
1866ab1df9f5SJed Brown     The FULL factorization is
1867ab1df9f5SJed Brown 
1868ab1df9f5SJed Brown $   (A   B)  = (1       0) (A   0) (1  Ainv*B)
1869ab1df9f5SJed Brown $   (C   D)    (C*Ainv  1) (0   S) (0     1  )
1870ab1df9f5SJed Brown 
18716be4592eSBarry 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,
18726be4592eSBarry 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).
1873ab1df9f5SJed Brown 
18746be4592eSBarry 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
18756be4592eSBarry 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
18766be4592eSBarry 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,
18776be4592eSBarry 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.
1878ab1df9f5SJed Brown 
18796be4592eSBarry 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
18806be4592eSBarry 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).
1881ab1df9f5SJed Brown 
1882ab1df9f5SJed Brown     References:
1883ab1df9f5SJed Brown     Murphy, Golub, and Wathen, A note on preconditioning indefinite linear systems, SIAM J. Sci. Comput., 21 (2000) pp. 1969-1972.
1884ab1df9f5SJed Brown 
1885ab1df9f5SJed Brown     Ipsen, A note on preconditioning nonsymmetric matrices, SIAM J. Sci. Comput., 23 (2001), pp. 1050-1051.
1886ab1df9f5SJed Brown 
1887ab1df9f5SJed Brown .seealso: PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitSetFields(), PCFieldSplitSchurPreType
1888ab1df9f5SJed Brown @*/
1889c9c6ffaaSJed Brown PetscErrorCode  PCFieldSplitSetSchurFactType(PC pc,PCFieldSplitSchurFactType ftype)
1890ab1df9f5SJed Brown {
1891ab1df9f5SJed Brown   PetscErrorCode ierr;
1892ab1df9f5SJed Brown 
1893ab1df9f5SJed Brown   PetscFunctionBegin;
1894ab1df9f5SJed Brown   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
1895c9c6ffaaSJed Brown   ierr = PetscTryMethod(pc,"PCFieldSplitSetSchurFactType_C",(PC,PCFieldSplitSchurFactType),(pc,ftype));CHKERRQ(ierr);
1896ab1df9f5SJed Brown   PetscFunctionReturn(0);
1897ab1df9f5SJed Brown }
1898ab1df9f5SJed Brown 
1899ab1df9f5SJed Brown #undef __FUNCT__
1900c9c6ffaaSJed Brown #define __FUNCT__ "PCFieldSplitSetSchurFactType_FieldSplit"
19011e6b0712SBarry Smith static PetscErrorCode PCFieldSplitSetSchurFactType_FieldSplit(PC pc,PCFieldSplitSchurFactType ftype)
1902ab1df9f5SJed Brown {
1903ab1df9f5SJed Brown   PC_FieldSplit *jac = (PC_FieldSplit*)pc->data;
1904ab1df9f5SJed Brown 
1905ab1df9f5SJed Brown   PetscFunctionBegin;
1906ab1df9f5SJed Brown   jac->schurfactorization = ftype;
1907ab1df9f5SJed Brown   PetscFunctionReturn(0);
1908ab1df9f5SJed Brown }
1909ab1df9f5SJed Brown 
1910ab1df9f5SJed Brown #undef __FUNCT__
191130ad9308SMatthew Knepley #define __FUNCT__ "PCFieldSplitGetSchurBlocks"
191230ad9308SMatthew Knepley /*@C
19138c03b21aSDmitry Karpeev    PCFieldSplitGetSchurBlocks - Gets all matrix blocks for the Schur complement
191430ad9308SMatthew Knepley 
191530ad9308SMatthew Knepley    Collective on KSP
191630ad9308SMatthew Knepley 
191730ad9308SMatthew Knepley    Input Parameter:
191830ad9308SMatthew Knepley .  pc - the preconditioner context
191930ad9308SMatthew Knepley 
192030ad9308SMatthew Knepley    Output Parameters:
1921a04f6461SBarry Smith +  A00 - the (0,0) block
1922a04f6461SBarry Smith .  A01 - the (0,1) block
1923a04f6461SBarry Smith .  A10 - the (1,0) block
1924a04f6461SBarry Smith -  A11 - the (1,1) block
192530ad9308SMatthew Knepley 
192630ad9308SMatthew Knepley    Level: advanced
192730ad9308SMatthew Knepley 
192830ad9308SMatthew Knepley .seealso: PCFIELDSPLIT
192930ad9308SMatthew Knepley @*/
1930a04f6461SBarry Smith PetscErrorCode  PCFieldSplitGetSchurBlocks(PC pc,Mat *A00,Mat *A01,Mat *A10, Mat *A11)
193130ad9308SMatthew Knepley {
193230ad9308SMatthew Knepley   PC_FieldSplit *jac = (PC_FieldSplit*) pc->data;
193330ad9308SMatthew Knepley 
193430ad9308SMatthew Knepley   PetscFunctionBegin;
19350700a824SBarry Smith   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
1936ce94432eSBarry Smith   if (jac->type != PC_COMPOSITE_SCHUR) SETERRQ(PetscObjectComm((PetscObject)pc),PETSC_ERR_ARG_WRONG, "FieldSplit is not using a Schur complement approach.");
1937a04f6461SBarry Smith   if (A00) *A00 = jac->pmat[0];
1938a04f6461SBarry Smith   if (A01) *A01 = jac->B;
1939a04f6461SBarry Smith   if (A10) *A10 = jac->C;
1940a04f6461SBarry Smith   if (A11) *A11 = jac->pmat[1];
194130ad9308SMatthew Knepley   PetscFunctionReturn(0);
194230ad9308SMatthew Knepley }
194330ad9308SMatthew Knepley 
194479416396SBarry Smith #undef __FUNCT__
194579416396SBarry Smith #define __FUNCT__ "PCFieldSplitSetType_FieldSplit"
19461e6b0712SBarry Smith static PetscErrorCode  PCFieldSplitSetType_FieldSplit(PC pc,PCCompositeType type)
194779416396SBarry Smith {
194879416396SBarry Smith   PC_FieldSplit  *jac = (PC_FieldSplit*)pc->data;
1949e69d4d44SBarry Smith   PetscErrorCode ierr;
195079416396SBarry Smith 
195179416396SBarry Smith   PetscFunctionBegin;
195279416396SBarry Smith   jac->type = type;
19533b224e63SBarry Smith   if (type == PC_COMPOSITE_SCHUR) {
19543b224e63SBarry Smith     pc->ops->apply = PCApply_FieldSplit_Schur;
19553b224e63SBarry Smith     pc->ops->view  = PCView_FieldSplit_Schur;
19562fa5cd67SKarl Rupp 
1957bdf89e91SBarry Smith     ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitGetSubKSP_C",PCFieldSplitGetSubKSP_FieldSplit_Schur);CHKERRQ(ierr);
195829f8a81cSJed Brown     ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetSchurPre_C",PCFieldSplitSetSchurPre_FieldSplit);CHKERRQ(ierr);
195937a82bf0SJed Brown     ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitGetSchurPre_C",PCFieldSplitGetSchurPre_FieldSplit);CHKERRQ(ierr);
1960bdf89e91SBarry Smith     ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetSchurFactType_C",PCFieldSplitSetSchurFactType_FieldSplit);CHKERRQ(ierr);
1961e69d4d44SBarry Smith 
19623b224e63SBarry Smith   } else {
19633b224e63SBarry Smith     pc->ops->apply = PCApply_FieldSplit;
19643b224e63SBarry Smith     pc->ops->view  = PCView_FieldSplit;
19652fa5cd67SKarl Rupp 
1966bdf89e91SBarry Smith     ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitGetSubKSP_C",PCFieldSplitGetSubKSP_FieldSplit);CHKERRQ(ierr);
196729f8a81cSJed Brown     ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetSchurPre_C",0);CHKERRQ(ierr);
196837a82bf0SJed Brown     ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitGetSchurPre_C",0);CHKERRQ(ierr);
1969bdf89e91SBarry Smith     ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetSchurFactType_C",0);CHKERRQ(ierr);
19703b224e63SBarry Smith   }
197179416396SBarry Smith   PetscFunctionReturn(0);
197279416396SBarry Smith }
197379416396SBarry Smith 
197451f519a2SBarry Smith #undef __FUNCT__
197551f519a2SBarry Smith #define __FUNCT__ "PCFieldSplitSetBlockSize_FieldSplit"
19761e6b0712SBarry Smith static PetscErrorCode  PCFieldSplitSetBlockSize_FieldSplit(PC pc,PetscInt bs)
197751f519a2SBarry Smith {
197851f519a2SBarry Smith   PC_FieldSplit *jac = (PC_FieldSplit*)pc->data;
197951f519a2SBarry Smith 
198051f519a2SBarry Smith   PetscFunctionBegin;
1981ce94432eSBarry Smith   if (bs < 1) SETERRQ1(PetscObjectComm((PetscObject)pc),PETSC_ERR_ARG_OUTOFRANGE,"Blocksize must be positive, you gave %D",bs);
1982ce94432eSBarry 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);
198351f519a2SBarry Smith   jac->bs = bs;
198451f519a2SBarry Smith   PetscFunctionReturn(0);
198551f519a2SBarry Smith }
198651f519a2SBarry Smith 
198779416396SBarry Smith #undef __FUNCT__
198879416396SBarry Smith #define __FUNCT__ "PCFieldSplitSetType"
1989bc08b0f1SBarry Smith /*@
199079416396SBarry Smith    PCFieldSplitSetType - Sets the type of fieldsplit preconditioner.
199179416396SBarry Smith 
199279416396SBarry Smith    Collective on PC
199379416396SBarry Smith 
199479416396SBarry Smith    Input Parameter:
199579416396SBarry Smith .  pc - the preconditioner context
199681540f2fSBarry Smith .  type - PC_COMPOSITE_ADDITIVE, PC_COMPOSITE_MULTIPLICATIVE (default), PC_COMPOSITE_SYMMETRIC_MULTIPLICATIVE, PC_COMPOSITE_SPECIAL, PC_COMPOSITE_SCHUR
199779416396SBarry Smith 
199879416396SBarry Smith    Options Database Key:
1999a4efd8eaSMatthew Knepley .  -pc_fieldsplit_type <type: one of multiplicative, additive, symmetric_multiplicative, special, schur> - Sets fieldsplit preconditioner type
200079416396SBarry Smith 
2001b02e2d75SMatthew G Knepley    Level: Intermediate
200279416396SBarry Smith 
200379416396SBarry Smith .keywords: PC, set, type, composite preconditioner, additive, multiplicative
200479416396SBarry Smith 
200579416396SBarry Smith .seealso: PCCompositeSetType()
200679416396SBarry Smith 
200779416396SBarry Smith @*/
20087087cfbeSBarry Smith PetscErrorCode  PCFieldSplitSetType(PC pc,PCCompositeType type)
200979416396SBarry Smith {
20104ac538c5SBarry Smith   PetscErrorCode ierr;
201179416396SBarry Smith 
201279416396SBarry Smith   PetscFunctionBegin;
20130700a824SBarry Smith   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
20144ac538c5SBarry Smith   ierr = PetscTryMethod(pc,"PCFieldSplitSetType_C",(PC,PCCompositeType),(pc,type));CHKERRQ(ierr);
201579416396SBarry Smith   PetscFunctionReturn(0);
201679416396SBarry Smith }
201779416396SBarry Smith 
2018b02e2d75SMatthew G Knepley #undef __FUNCT__
2019b02e2d75SMatthew G Knepley #define __FUNCT__ "PCFieldSplitGetType"
2020b02e2d75SMatthew G Knepley /*@
2021b02e2d75SMatthew G Knepley   PCFieldSplitGetType - Gets the type of fieldsplit preconditioner.
2022b02e2d75SMatthew G Knepley 
2023b02e2d75SMatthew G Knepley   Not collective
2024b02e2d75SMatthew G Knepley 
2025b02e2d75SMatthew G Knepley   Input Parameter:
2026b02e2d75SMatthew G Knepley . pc - the preconditioner context
2027b02e2d75SMatthew G Knepley 
2028b02e2d75SMatthew G Knepley   Output Parameter:
2029b02e2d75SMatthew G Knepley . type - PC_COMPOSITE_ADDITIVE, PC_COMPOSITE_MULTIPLICATIVE (default), PC_COMPOSITE_SYMMETRIC_MULTIPLICATIVE, PC_COMPOSITE_SPECIAL, PC_COMPOSITE_SCHUR
2030b02e2d75SMatthew G Knepley 
2031b02e2d75SMatthew G Knepley   Level: Intermediate
2032b02e2d75SMatthew G Knepley 
2033b02e2d75SMatthew G Knepley .keywords: PC, set, type, composite preconditioner, additive, multiplicative
2034b02e2d75SMatthew G Knepley .seealso: PCCompositeSetType()
2035b02e2d75SMatthew G Knepley @*/
2036b02e2d75SMatthew G Knepley PetscErrorCode PCFieldSplitGetType(PC pc, PCCompositeType *type)
2037b02e2d75SMatthew G Knepley {
2038b02e2d75SMatthew G Knepley   PC_FieldSplit *jac = (PC_FieldSplit*) pc->data;
2039b02e2d75SMatthew G Knepley 
2040b02e2d75SMatthew G Knepley   PetscFunctionBegin;
2041b02e2d75SMatthew G Knepley   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
2042b02e2d75SMatthew G Knepley   PetscValidIntPointer(type,2);
2043b02e2d75SMatthew G Knepley   *type = jac->type;
2044b02e2d75SMatthew G Knepley   PetscFunctionReturn(0);
2045b02e2d75SMatthew G Knepley }
2046b02e2d75SMatthew G Knepley 
20474ab8060aSDmitry Karpeev #undef __FUNCT__
20484ab8060aSDmitry Karpeev #define __FUNCT__ "PCFieldSplitSetDMSplits"
20494ab8060aSDmitry Karpeev /*@
20504ab8060aSDmitry Karpeev    PCFieldSplitSetDMSplits - Flags whether DMCreateFieldDecomposition() should be used to define the splits, whenever possible.
20514ab8060aSDmitry Karpeev 
20524ab8060aSDmitry Karpeev    Logically Collective
20534ab8060aSDmitry Karpeev 
20544ab8060aSDmitry Karpeev    Input Parameters:
20554ab8060aSDmitry Karpeev +  pc   - the preconditioner context
20564ab8060aSDmitry Karpeev -  flg  - boolean indicating whether to use field splits defined by the DM
20574ab8060aSDmitry Karpeev 
20584ab8060aSDmitry Karpeev    Options Database Key:
20594ab8060aSDmitry Karpeev .  -pc_fieldsplit_dm_splits
20604ab8060aSDmitry Karpeev 
20614ab8060aSDmitry Karpeev    Level: Intermediate
20624ab8060aSDmitry Karpeev 
20634ab8060aSDmitry Karpeev .keywords: PC, DM, composite preconditioner, additive, multiplicative
20644ab8060aSDmitry Karpeev 
20654ab8060aSDmitry Karpeev .seealso: PCFieldSplitGetDMSplits()
20664ab8060aSDmitry Karpeev 
20674ab8060aSDmitry Karpeev @*/
20684ab8060aSDmitry Karpeev PetscErrorCode  PCFieldSplitSetDMSplits(PC pc,PetscBool flg)
20694ab8060aSDmitry Karpeev {
20704ab8060aSDmitry Karpeev   PC_FieldSplit  *jac = (PC_FieldSplit*)pc->data;
20714ab8060aSDmitry Karpeev   PetscBool      isfs;
20724ab8060aSDmitry Karpeev   PetscErrorCode ierr;
20734ab8060aSDmitry Karpeev 
20744ab8060aSDmitry Karpeev   PetscFunctionBegin;
20754ab8060aSDmitry Karpeev   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
20764ab8060aSDmitry Karpeev   PetscValidLogicalCollectiveBool(pc,flg,2);
20774ab8060aSDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)pc,PCFIELDSPLIT,&isfs);CHKERRQ(ierr);
20784ab8060aSDmitry Karpeev   if (isfs) {
20794ab8060aSDmitry Karpeev     jac->dm_splits = flg;
20804ab8060aSDmitry Karpeev   }
20814ab8060aSDmitry Karpeev   PetscFunctionReturn(0);
20824ab8060aSDmitry Karpeev }
20834ab8060aSDmitry Karpeev 
20844ab8060aSDmitry Karpeev 
20854ab8060aSDmitry Karpeev #undef __FUNCT__
20864ab8060aSDmitry Karpeev #define __FUNCT__ "PCFieldSplitGetDMSplits"
20874ab8060aSDmitry Karpeev /*@
20884ab8060aSDmitry Karpeev    PCFieldSplitGetDMSplits - Returns flag indicating whether DMCreateFieldDecomposition() should be used to define the splits, whenever possible.
20894ab8060aSDmitry Karpeev 
20904ab8060aSDmitry Karpeev    Logically Collective
20914ab8060aSDmitry Karpeev 
20924ab8060aSDmitry Karpeev    Input Parameter:
20934ab8060aSDmitry Karpeev .  pc   - the preconditioner context
20944ab8060aSDmitry Karpeev 
20954ab8060aSDmitry Karpeev    Output Parameter:
20964ab8060aSDmitry Karpeev .  flg  - boolean indicating whether to use field splits defined by the DM
20974ab8060aSDmitry Karpeev 
20984ab8060aSDmitry Karpeev    Level: Intermediate
20994ab8060aSDmitry Karpeev 
21004ab8060aSDmitry Karpeev .keywords: PC, DM, composite preconditioner, additive, multiplicative
21014ab8060aSDmitry Karpeev 
21024ab8060aSDmitry Karpeev .seealso: PCFieldSplitSetDMSplits()
21034ab8060aSDmitry Karpeev 
21044ab8060aSDmitry Karpeev @*/
21054ab8060aSDmitry Karpeev PetscErrorCode  PCFieldSplitGetDMSplits(PC pc,PetscBool* flg)
21064ab8060aSDmitry Karpeev {
21074ab8060aSDmitry Karpeev   PC_FieldSplit  *jac = (PC_FieldSplit*)pc->data;
21084ab8060aSDmitry Karpeev   PetscBool      isfs;
21094ab8060aSDmitry Karpeev   PetscErrorCode ierr;
21104ab8060aSDmitry Karpeev 
21114ab8060aSDmitry Karpeev   PetscFunctionBegin;
21124ab8060aSDmitry Karpeev   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
21134ab8060aSDmitry Karpeev   PetscValidPointer(flg,2);
21144ab8060aSDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)pc,PCFIELDSPLIT,&isfs);CHKERRQ(ierr);
21154ab8060aSDmitry Karpeev   if (isfs) {
21164ab8060aSDmitry Karpeev     if(flg) *flg = jac->dm_splits;
21174ab8060aSDmitry Karpeev   }
21184ab8060aSDmitry Karpeev   PetscFunctionReturn(0);
21194ab8060aSDmitry Karpeev }
21204ab8060aSDmitry Karpeev 
21210971522cSBarry Smith /* -------------------------------------------------------------------------------------*/
21220971522cSBarry Smith /*MC
2123a8c7a070SBarry Smith    PCFIELDSPLIT - Preconditioner created by combining separate preconditioners for individual
2124a04f6461SBarry Smith                   fields or groups of fields. See the users manual section "Solving Block Matrices" for more details.
21250971522cSBarry Smith 
2126edf189efSBarry Smith      To set options on the solvers for each block append -fieldsplit_ to all the PC
2127edf189efSBarry Smith         options database keys. For example, -fieldsplit_pc_type ilu -fieldsplit_pc_factor_levels 1
21280971522cSBarry Smith 
2129a8c7a070SBarry Smith      To set the options on the solvers separate for each block call PCFieldSplitGetSubKSP()
213069a612a9SBarry Smith          and set the options directly on the resulting KSP object
21310971522cSBarry Smith 
21320971522cSBarry Smith    Level: intermediate
21330971522cSBarry Smith 
213479416396SBarry Smith    Options Database Keys:
213581540f2fSBarry Smith +   -pc_fieldsplit_%d_fields <a,b,..> - indicates the fields to be used in the %d'th split
213681540f2fSBarry Smith .   -pc_fieldsplit_default - automatically add any fields to additional splits that have not
213781540f2fSBarry Smith                               been supplied explicitly by -pc_fieldsplit_%d_fields
213881540f2fSBarry Smith .   -pc_fieldsplit_block_size <bs> - size of block that defines fields (i.e. there are bs fields)
21390f188ba9SJed Brown .   -pc_fieldsplit_type <additive,multiplicative,symmetric_multiplicative,schur> - type of relaxation or factorization splitting
21402e71c61dSMatthew G. Knepley .   -pc_fieldsplit_schur_precondition <self,selfp,user,a11,full> - default is a11
2141435f959eSBarry Smith .   -pc_fieldsplit_detect_saddle_point - automatically finds rows with zero or negative diagonal and uses Schur complement with no preconditioner as the solver
214279416396SBarry Smith 
21435d4c12cdSJungho Lee -    Options prefix for inner solvers when using Schur complement preconditioner are -fieldsplit_0_ and -fieldsplit_1_
21445d4c12cdSJungho Lee      for all other solvers they are -fieldsplit_%d_ for the dth field, use -fieldsplit_ for all fields
21455d4c12cdSJungho Lee 
2146c8a0d604SMatthew G Knepley    Notes:
2147c8a0d604SMatthew G Knepley     Use PCFieldSplitSetFields() to set fields defined by "strided" entries and PCFieldSplitSetIS()
2148d32f9abdSBarry Smith      to define a field by an arbitrary collection of entries.
2149d32f9abdSBarry Smith 
2150d32f9abdSBarry Smith       If no fields are set the default is used. The fields are defined by entries strided by bs,
2151d32f9abdSBarry Smith       beginning at 0 then 1, etc to bs-1. The block size can be set with PCFieldSplitSetBlockSize(),
2152d32f9abdSBarry Smith       if this is not called the block size defaults to the blocksize of the second matrix passed
2153d32f9abdSBarry Smith       to KSPSetOperators()/PCSetOperators().
2154d32f9abdSBarry Smith 
2155c8a0d604SMatthew G Knepley $     For the Schur complement preconditioner if J = ( A00 A01 )
2156c8a0d604SMatthew G Knepley $                                                    ( A10 A11 )
2157c8a0d604SMatthew G Knepley $     the preconditioner using full factorization is
215813b05affSJed Brown $              ( I   -ksp(A00) A01 ) ( inv(A00)     0  ) (     I          0  )
2159c8a0d604SMatthew G Knepley $              ( 0         I       ) (   0      ksp(S) ) ( -A10 ksp(A00)  I  )
216013b05affSJed Brown      where the action of inv(A00) is applied using the KSP solver with prefix -fieldsplit_0_.  S is the Schur complement
216113b05affSJed Brown $              S = A11 - A10 ksp(A00) A01
216213b05affSJed 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
2163c8a0d604SMatthew G Knepley      in providing the SECOND split or 1 if not give). For PCFieldSplitGetKSP() when field number is 0,
2164c8a0d604SMatthew G Knepley      it returns the KSP associated with -fieldsplit_0_ while field number 1 gives -fieldsplit_1_ KSP. By default
216529f8a81cSJed Brown      A11 is used to construct a preconditioner for S, use PCFieldSplitSetSchurPre() to turn on or off this
2166a7476a74SDmitry Karpeev      option. You can use the preconditioner PCLSC to precondition the Schur complement with -fieldsplit_1_pc_type lsc.
2167a7476a74SDmitry Karpeev      When option -fieldsplit_schur_precondition selfp is given, an approximation to S is assembled --
2168a7476a74SDmitry Karpeev      Sp = A11 - A10 inv(diag(A00)) A01, which has type AIJ and can be used with a variety of preconditioners
2169a7476a74SDmitry Karpeev      (e.g., -fieldsplit_1_pc_type asm).
2170a7476a74SDmitry Karpeev      The factorization type is set using -pc_fieldsplit_schur_fact_type <diag, lower, upper, full>. The full is shown above,
21715668aaf4SBarry Smith      diag gives
2172c8a0d604SMatthew G Knepley $              ( inv(A00)     0   )
2173c8a0d604SMatthew G Knepley $              (   0      -ksp(S) )
21745668aaf4SBarry 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
2175c8a0d604SMatthew G Knepley $              (  A00   0 )
2176c8a0d604SMatthew G Knepley $              (  A10   S )
2177c8a0d604SMatthew G Knepley      where the inverses of A00 and S are applied using KSPs. The upper factorization is the inverse of
2178c8a0d604SMatthew G Knepley $              ( A00 A01 )
2179c8a0d604SMatthew G Knepley $              (  0   S  )
2180c8a0d604SMatthew G Knepley      where again the inverses of A00 and S are applied using KSPs.
2181e69d4d44SBarry Smith 
2182edf189efSBarry Smith      If only one set of indices (one IS) is provided with PCFieldSplitSetIS() then the complement of that IS
2183edf189efSBarry Smith      is used automatically for a second block.
2184edf189efSBarry Smith 
2185ff218e97SBarry Smith      The fieldsplit preconditioner cannot currently be used with the BAIJ or SBAIJ data formats if the blocksize is larger than 1.
2186ff218e97SBarry Smith      Generally it should be used with the AIJ format.
2187ff218e97SBarry Smith 
2188ff218e97SBarry Smith      The forms of these preconditioners are closely related if not identical to forms derived as "Distributive Iterations", see,
2189ff218e97SBarry Smith      for example, page 294 in "Principles of Computational Fluid Dynamics" by Pieter Wesseling. Note that one can also use PCFIELDSPLIT
2190ff218e97SBarry Smith      inside a smoother resulting in "Distributive Smoothers".
21910716a85fSBarry Smith 
2192a541d17aSBarry Smith    Concepts: physics based preconditioners, block preconditioners
21930971522cSBarry Smith 
21943bc631e0SBarry Smith    There is a nice discussion of block preconditioners in
21953bc631e0SBarry Smith 
21963bc631e0SBarry Smith [El08] A taxonomy and comparison of parallel block multi-level preconditioners for the incompressible Navier-Stokes equations
21973bc631e0SBarry Smith        Howard Elman, V.E. Howle, John Shadid, Robert Shuttleworth, Ray Tuminaro, Journal of Computational Physics 227 (2008) 1790--1808
21983bc631e0SBarry Smith        http://chess.cs.umd.edu/~elman/papers/tax.pdf
21993bc631e0SBarry Smith 
22007e8cb189SBarry Smith .seealso:  PCCreate(), PCSetType(), PCType (for list of available types), PC, Block_Preconditioners, PCLSC,
220129f8a81cSJed Brown            PCFieldSplitGetSubKSP(), PCFieldSplitSetFields(), PCFieldSplitSetType(), PCFieldSplitSetIS(), PCFieldSplitSetSchurPre()
22020971522cSBarry Smith M*/
22030971522cSBarry Smith 
22040971522cSBarry Smith #undef __FUNCT__
22050971522cSBarry Smith #define __FUNCT__ "PCCreate_FieldSplit"
22068cc058d9SJed Brown PETSC_EXTERN PetscErrorCode PCCreate_FieldSplit(PC pc)
22070971522cSBarry Smith {
22080971522cSBarry Smith   PetscErrorCode ierr;
22090971522cSBarry Smith   PC_FieldSplit  *jac;
22100971522cSBarry Smith 
22110971522cSBarry Smith   PetscFunctionBegin;
2212b00a9115SJed Brown   ierr = PetscNewLog(pc,&jac);CHKERRQ(ierr);
22132fa5cd67SKarl Rupp 
22140971522cSBarry Smith   jac->bs                 = -1;
22150971522cSBarry Smith   jac->nsplits            = 0;
22163e197d65SBarry Smith   jac->type               = PC_COMPOSITE_MULTIPLICATIVE;
2217e6cab6aaSJed Brown   jac->schurpre           = PC_FIELDSPLIT_SCHUR_PRE_USER; /* Try user preconditioner first, fall back on diagonal */
2218c9c6ffaaSJed Brown   jac->schurfactorization = PC_FIELDSPLIT_SCHUR_FACT_FULL;
2219fbe7908bSJed Brown   jac->dm_splits          = PETSC_TRUE;
222051f519a2SBarry Smith 
22210971522cSBarry Smith   pc->data = (void*)jac;
22220971522cSBarry Smith 
22230971522cSBarry Smith   pc->ops->apply           = PCApply_FieldSplit;
2224421e10b8SBarry Smith   pc->ops->applytranspose  = PCApplyTranspose_FieldSplit;
22250971522cSBarry Smith   pc->ops->setup           = PCSetUp_FieldSplit;
2226574deadeSBarry Smith   pc->ops->reset           = PCReset_FieldSplit;
22270971522cSBarry Smith   pc->ops->destroy         = PCDestroy_FieldSplit;
22280971522cSBarry Smith   pc->ops->setfromoptions  = PCSetFromOptions_FieldSplit;
22290971522cSBarry Smith   pc->ops->view            = PCView_FieldSplit;
22300971522cSBarry Smith   pc->ops->applyrichardson = 0;
22310971522cSBarry Smith 
2232bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitGetSubKSP_C",PCFieldSplitGetSubKSP_FieldSplit);CHKERRQ(ierr);
2233bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetFields_C",PCFieldSplitSetFields_FieldSplit);CHKERRQ(ierr);
2234bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetIS_C",PCFieldSplitSetIS_FieldSplit);CHKERRQ(ierr);
2235bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetType_C",PCFieldSplitSetType_FieldSplit);CHKERRQ(ierr);
2236bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetBlockSize_C",PCFieldSplitSetBlockSize_FieldSplit);CHKERRQ(ierr);
22370971522cSBarry Smith   PetscFunctionReturn(0);
22380971522cSBarry Smith }
22390971522cSBarry Smith 
22400971522cSBarry Smith 
2241a541d17aSBarry Smith 
2242