xref: /petsc/src/ksp/pc/impls/fieldsplit/fieldsplit.c (revision d8d19677bbccf95218448bee62e6b87f4513e133)
1af0996ceSBarry Smith #include <petsc/private/pcimpl.h>     /*I "petscpc.h" I*/
2a80b646eSBarry Smith #include <petsc/private/kspimpl.h>    /*  This is needed to provide the appropriate PETSC_EXTERN for KSP_Solve_FS ....*/
31e25c274SJed Brown #include <petscdm.h>
40971522cSBarry Smith 
50a545947SLisandro Dalcin const char *const PCFieldSplitSchurPreTypes[] = {"SELF","SELFP","A11","USER","FULL","PCFieldSplitSchurPreType","PC_FIELDSPLIT_SCHUR_PRE_",NULL};
60a545947SLisandro Dalcin const char *const PCFieldSplitSchurFactTypes[] = {"DIAG","LOWER","UPPER","FULL","PCFieldSplitSchurFactType","PC_FIELDSPLIT_SCHUR_FACT_",NULL};
7c5d2311dSJed Brown 
89df09d43SBarry Smith PetscLogEvent KSP_Solve_FS_0,KSP_Solve_FS_1,KSP_Solve_FS_S,KSP_Solve_FS_U,KSP_Solve_FS_L,KSP_Solve_FS_2,KSP_Solve_FS_3,KSP_Solve_FS_4;
99df09d43SBarry Smith 
100971522cSBarry Smith typedef struct _PC_FieldSplitLink *PC_FieldSplitLink;
110971522cSBarry Smith struct _PC_FieldSplitLink {
1269a612a9SBarry Smith   KSP               ksp;
13443836d0SMatthew G Knepley   Vec               x,y,z;
14db4c96c1SJed Brown   char              *splitname;
150971522cSBarry Smith   PetscInt          nfields;
165d4c12cdSJungho Lee   PetscInt          *fields,*fields_col;
171b9fc7fcSBarry Smith   VecScatter        sctx;
18f5f0d762SBarry Smith   IS                is,is_col;
1951f519a2SBarry Smith   PC_FieldSplitLink next,previous;
209df09d43SBarry Smith   PetscLogEvent     event;
210971522cSBarry Smith };
220971522cSBarry Smith 
230971522cSBarry Smith typedef struct {
2468dd23aaSBarry Smith   PCCompositeType type;
25ace3abfcSBarry Smith   PetscBool       defaultsplit;                    /* Flag for a system with a set of 'k' scalar fields with the same layout (and bs = k) */
26ace3abfcSBarry Smith   PetscBool       splitdefined;                    /* Flag is set after the splits have been defined, to prevent more splits from being added */
2730ad9308SMatthew Knepley   PetscInt        bs;                              /* Block size for IS and Mat structures */
2830ad9308SMatthew Knepley   PetscInt        nsplits;                         /* Number of field divisions defined */
2979416396SBarry Smith   Vec             *x,*y,w1,w2;
30519d70e2SJed Brown   Mat             *mat;                            /* The diagonal block for each split */
31519d70e2SJed Brown   Mat             *pmat;                           /* The preconditioning diagonal block for each split */
3230ad9308SMatthew Knepley   Mat             *Afield;                         /* The rows of the matrix associated with each split */
33ace3abfcSBarry Smith   PetscBool       issetup;
342fa5cd67SKarl Rupp 
3530ad9308SMatthew Knepley   /* Only used when Schur complement preconditioning is used */
3630ad9308SMatthew Knepley   Mat                       B;                     /* The (0,1) block */
3730ad9308SMatthew Knepley   Mat                       C;                     /* The (1,0) block */
38443836d0SMatthew G Knepley   Mat                       schur;                 /* The Schur complement S = A11 - A10 A00^{-1} A01, the KSP here, kspinner, is H_1 in [El08] */
39a7476a74SDmitry Karpeev   Mat                       schurp;                /* Assembled approximation to S built by MatSchurComplement to be used as a preconditioning matrix when solving with S */
40084e4875SJed Brown   Mat                       schur_user;            /* User-provided preconditioning matrix for the Schur complement */
41084e4875SJed Brown   PCFieldSplitSchurPreType  schurpre;              /* Determines which preconditioning matrix is used for the Schur complement */
42c9c6ffaaSJed Brown   PCFieldSplitSchurFactType schurfactorization;
4330ad9308SMatthew Knepley   KSP                       kspschur;              /* The solver for S */
44443836d0SMatthew G Knepley   KSP                       kspupper;              /* The solver for A in the upper diagonal part of the factorization (H_2 in [El08]) */
45c096484dSStefano Zampini   PetscScalar               schurscale;            /* Scaling factor for the Schur complement solution with DIAG factorization */
46c096484dSStefano Zampini 
47a51937d4SCarola Kruse   /* Only used when Golub-Kahan bidiagonalization preconditioning is used */
48a51937d4SCarola Kruse   Mat                       H;                     /* The modified matrix H = A00 + nu*A01*A01'              */
49a51937d4SCarola Kruse   PetscReal                 gkbtol;                /* Stopping tolerance for lower bound estimate            */
50a51937d4SCarola Kruse   PetscInt                  gkbdelay;              /* The delay window for the stopping criterion            */
51a51937d4SCarola Kruse   PetscReal                 gkbnu;                 /* Parameter for augmented Lagrangian H = A + nu*A01*A01' */
52a51937d4SCarola Kruse   PetscInt                  gkbmaxit;              /* Maximum number of iterations for outer loop            */
53de482cd7SCarola Kruse   PetscBool                 gkbmonitor;            /* Monitor for gkb iterations and the lower bound error   */
54de482cd7SCarola Kruse   PetscViewer               gkbviewer;             /* Viewer context for gkbmonitor                          */
55e071a0a4SCarola Kruse   Vec                       u,v,d,Hu;              /* Work vectors for the GKB algorithm                     */
56e071a0a4SCarola Kruse   PetscScalar               *vecz;                 /* Contains intermediate values, eg for lower bound       */
57a51937d4SCarola Kruse 
5897bbdb24SBarry Smith   PC_FieldSplitLink         head;
596dbb499eSCian Wilson   PetscBool                 isrestrict;             /* indicates PCFieldSplitRestrictIS() has been last called on this object, hack */
60c1570756SJed Brown   PetscBool                 suboptionsset;          /* Indicates that the KSPSetFromOptions() has been called on the sub-KSPs */
614ab8060aSDmitry Karpeev   PetscBool                 dm_splits;              /* Whether to use DMCreateFieldDecomposition() whenever possible */
62c84da90fSDmitry Karpeev   PetscBool                 diag_use_amat;          /* Whether to extract diagonal matrix blocks from Amat, rather than Pmat (weaker than -pc_use_amat) */
63c84da90fSDmitry Karpeev   PetscBool                 offdiag_use_amat;       /* Whether to extract off-diagonal matrix blocks from Amat, rather than Pmat (weaker than -pc_use_amat) */
647b752e3dSPatrick Sanan   PetscBool                 detect;                 /* Whether to form 2-way split by finding zero diagonal entries */
650971522cSBarry Smith } PC_FieldSplit;
660971522cSBarry Smith 
6716913363SBarry Smith /*
6895452b02SPatrick Sanan     Notes:
6995452b02SPatrick Sanan     there is no particular reason that pmat, x, and y are stored as arrays in PC_FieldSplit instead of
7016913363SBarry Smith    inside PC_FieldSplitLink, just historical. If you want to be able to add new fields after already using the
7116913363SBarry Smith    PC you could change this.
7216913363SBarry Smith */
73084e4875SJed Brown 
74e6cab6aaSJed Brown /* This helper is so that setting a user-provided preconditioning matrix is orthogonal to choosing to use it.  This way the
75084e4875SJed Brown * application-provided FormJacobian can provide this matrix without interfering with the user's (command-line) choices. */
76084e4875SJed Brown static Mat FieldSplitSchurPre(PC_FieldSplit *jac)
77084e4875SJed Brown {
78084e4875SJed Brown   switch (jac->schurpre) {
79084e4875SJed Brown   case PC_FIELDSPLIT_SCHUR_PRE_SELF: return jac->schur;
80a7476a74SDmitry Karpeev   case PC_FIELDSPLIT_SCHUR_PRE_SELFP: return jac->schurp;
81e87fab1bSBarry Smith   case PC_FIELDSPLIT_SCHUR_PRE_A11: return jac->pmat[1];
82e74569cdSMatthew G. Knepley   case PC_FIELDSPLIT_SCHUR_PRE_FULL: /* We calculate this and store it in schur_user */
83084e4875SJed Brown   case PC_FIELDSPLIT_SCHUR_PRE_USER: /* Use a user-provided matrix if it is given, otherwise diagonal block */
84084e4875SJed Brown   default:
85084e4875SJed Brown     return jac->schur_user ? jac->schur_user : jac->pmat[1];
86084e4875SJed Brown   }
87084e4875SJed Brown }
88084e4875SJed Brown 
899804daf3SBarry Smith #include <petscdraw.h>
900971522cSBarry Smith static PetscErrorCode PCView_FieldSplit(PC pc,PetscViewer viewer)
910971522cSBarry Smith {
920971522cSBarry Smith   PC_FieldSplit     *jac = (PC_FieldSplit*)pc->data;
930971522cSBarry Smith   PetscErrorCode    ierr;
94d9884438SBarry Smith   PetscBool         iascii,isdraw;
950971522cSBarry Smith   PetscInt          i,j;
965a9f2f41SSatish Balay   PC_FieldSplitLink ilink = jac->head;
970971522cSBarry Smith 
980971522cSBarry Smith   PetscFunctionBegin;
99251f4c67SDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&iascii);CHKERRQ(ierr);
100d9884438SBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERDRAW,&isdraw);CHKERRQ(ierr);
1010971522cSBarry Smith   if (iascii) {
1022c9966d7SBarry Smith     if (jac->bs > 0) {
10351f519a2SBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"  FieldSplit with %s composition: total splits = %D, blocksize = %D\n",PCCompositeTypes[jac->type],jac->nsplits,jac->bs);CHKERRQ(ierr);
1042c9966d7SBarry Smith     } else {
1052c9966d7SBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"  FieldSplit with %s composition: total splits = %D\n",PCCompositeTypes[jac->type],jac->nsplits);CHKERRQ(ierr);
1062c9966d7SBarry Smith     }
107f5236f50SJed Brown     if (pc->useAmat) {
108f5236f50SJed Brown       ierr = PetscViewerASCIIPrintf(viewer,"  using Amat (not Pmat) as operator for blocks\n");CHKERRQ(ierr);
109a3df900dSMatthew G Knepley     }
110c84da90fSDmitry Karpeev     if (jac->diag_use_amat) {
111c84da90fSDmitry Karpeev       ierr = PetscViewerASCIIPrintf(viewer,"  using Amat (not Pmat) as operator for diagonal blocks\n");CHKERRQ(ierr);
112c84da90fSDmitry Karpeev     }
113c84da90fSDmitry Karpeev     if (jac->offdiag_use_amat) {
114c84da90fSDmitry Karpeev       ierr = PetscViewerASCIIPrintf(viewer,"  using Amat (not Pmat) as operator for off-diagonal blocks\n");CHKERRQ(ierr);
115c84da90fSDmitry Karpeev     }
11669a612a9SBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"  Solver info for each split is in the following KSP objects:\n");CHKERRQ(ierr);
1170971522cSBarry Smith     for (i=0; i<jac->nsplits; i++) {
1181ab39975SBarry Smith       if (ilink->fields) {
1190971522cSBarry Smith         ierr = PetscViewerASCIIPrintf(viewer,"Split number %D Fields ",i);CHKERRQ(ierr);
12079416396SBarry Smith         ierr = PetscViewerASCIIUseTabs(viewer,PETSC_FALSE);CHKERRQ(ierr);
1215a9f2f41SSatish Balay         for (j=0; j<ilink->nfields; j++) {
12279416396SBarry Smith           if (j > 0) {
12379416396SBarry Smith             ierr = PetscViewerASCIIPrintf(viewer,",");CHKERRQ(ierr);
12479416396SBarry Smith           }
1255a9f2f41SSatish Balay           ierr = PetscViewerASCIIPrintf(viewer," %D",ilink->fields[j]);CHKERRQ(ierr);
1260971522cSBarry Smith         }
1270971522cSBarry Smith         ierr = PetscViewerASCIIPrintf(viewer,"\n");CHKERRQ(ierr);
12879416396SBarry Smith         ierr = PetscViewerASCIIUseTabs(viewer,PETSC_TRUE);CHKERRQ(ierr);
1291ab39975SBarry Smith       } else {
1301ab39975SBarry Smith         ierr = PetscViewerASCIIPrintf(viewer,"Split number %D Defined by IS\n",i);CHKERRQ(ierr);
1311ab39975SBarry Smith       }
1325a9f2f41SSatish Balay       ierr  = KSPView(ilink->ksp,viewer);CHKERRQ(ierr);
1335a9f2f41SSatish Balay       ilink = ilink->next;
1340971522cSBarry Smith     }
1352fa5cd67SKarl Rupp   }
1362fa5cd67SKarl Rupp 
1372fa5cd67SKarl Rupp  if (isdraw) {
138d9884438SBarry Smith     PetscDraw draw;
139d9884438SBarry Smith     PetscReal x,y,w,wd;
140d9884438SBarry Smith 
141d9884438SBarry Smith     ierr = PetscViewerDrawGetDraw(viewer,0,&draw);CHKERRQ(ierr);
142d9884438SBarry Smith     ierr = PetscDrawGetCurrentPoint(draw,&x,&y);CHKERRQ(ierr);
143d9884438SBarry Smith     w    = 2*PetscMin(1.0 - x,x);
144d9884438SBarry Smith     wd   = w/(jac->nsplits + 1);
145d9884438SBarry Smith     x    = x - wd*(jac->nsplits-1)/2.0;
146d9884438SBarry Smith     for (i=0; i<jac->nsplits; i++) {
147d9884438SBarry Smith       ierr  = PetscDrawPushCurrentPoint(draw,x,y);CHKERRQ(ierr);
148d9884438SBarry Smith       ierr  = KSPView(ilink->ksp,viewer);CHKERRQ(ierr);
149d9884438SBarry Smith       ierr  = PetscDrawPopCurrentPoint(draw);CHKERRQ(ierr);
150d9884438SBarry Smith       x    += wd;
151d9884438SBarry Smith       ilink = ilink->next;
152d9884438SBarry Smith     }
1530971522cSBarry Smith   }
1540971522cSBarry Smith   PetscFunctionReturn(0);
1550971522cSBarry Smith }
1560971522cSBarry Smith 
1573b224e63SBarry Smith static PetscErrorCode PCView_FieldSplit_Schur(PC pc,PetscViewer viewer)
1583b224e63SBarry Smith {
1593b224e63SBarry Smith   PC_FieldSplit              *jac = (PC_FieldSplit*)pc->data;
1603b224e63SBarry Smith   PetscErrorCode             ierr;
1614996c5bdSBarry Smith   PetscBool                  iascii,isdraw;
1623b224e63SBarry Smith   PetscInt                   i,j;
1633b224e63SBarry Smith   PC_FieldSplitLink          ilink = jac->head;
164a9908d51SBarry Smith   MatSchurComplementAinvType atype;
1653b224e63SBarry Smith 
1663b224e63SBarry Smith   PetscFunctionBegin;
167251f4c67SDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&iascii);CHKERRQ(ierr);
1684996c5bdSBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERDRAW,&isdraw);CHKERRQ(ierr);
1693b224e63SBarry Smith   if (iascii) {
1702c9966d7SBarry Smith     if (jac->bs > 0) {
171c9c6ffaaSJed Brown       ierr = PetscViewerASCIIPrintf(viewer,"  FieldSplit with Schur preconditioner, blocksize = %D, factorization %s\n",jac->bs,PCFieldSplitSchurFactTypes[jac->schurfactorization]);CHKERRQ(ierr);
1722c9966d7SBarry Smith     } else {
1732c9966d7SBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"  FieldSplit with Schur preconditioner, factorization %s\n",PCFieldSplitSchurFactTypes[jac->schurfactorization]);CHKERRQ(ierr);
1742c9966d7SBarry Smith     }
175f5236f50SJed Brown     if (pc->useAmat) {
176f5236f50SJed Brown       ierr = PetscViewerASCIIPrintf(viewer,"  using Amat (not Pmat) as operator for blocks\n");CHKERRQ(ierr);
177a3df900dSMatthew G Knepley     }
1783e8b8b31SMatthew G Knepley     switch (jac->schurpre) {
1793e8b8b31SMatthew G Knepley     case PC_FIELDSPLIT_SCHUR_PRE_SELF:
180a9908d51SBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"  Preconditioner for the Schur complement formed from S itself\n");CHKERRQ(ierr);
181a9908d51SBarry Smith       break;
182a7476a74SDmitry Karpeev     case PC_FIELDSPLIT_SCHUR_PRE_SELFP:
183a9908d51SBarry Smith       ierr = MatSchurComplementGetAinvType(jac->schur,&atype);CHKERRQ(ierr);
184d0a9c1a2SBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"  Preconditioner for the Schur complement formed from Sp, an assembled approximation to S, which uses A00's %sdiagonal's inverse\n",atype == MAT_SCHUR_COMPLEMENT_AINV_DIAG ? "" : (atype == MAT_SCHUR_COMPLEMENT_AINV_BLOCK_DIAG ? "block " : "lumped "));CHKERRQ(ierr);break;
185e87fab1bSBarry Smith     case PC_FIELDSPLIT_SCHUR_PRE_A11:
186a9908d51SBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"  Preconditioner for the Schur complement formed from A11\n");CHKERRQ(ierr);
187a9908d51SBarry Smith       break;
188e74569cdSMatthew G. Knepley     case PC_FIELDSPLIT_SCHUR_PRE_FULL:
189a9908d51SBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"  Preconditioner for the Schur complement formed from the exact Schur complement\n");CHKERRQ(ierr);
190a9908d51SBarry Smith       break;
1913e8b8b31SMatthew G Knepley     case PC_FIELDSPLIT_SCHUR_PRE_USER:
1923e8b8b31SMatthew G Knepley       if (jac->schur_user) {
1933e8b8b31SMatthew G Knepley         ierr = PetscViewerASCIIPrintf(viewer,"  Preconditioner for the Schur complement formed from user provided matrix\n");CHKERRQ(ierr);
1943e8b8b31SMatthew G Knepley       } else {
195e87fab1bSBarry Smith         ierr = PetscViewerASCIIPrintf(viewer,"  Preconditioner for the Schur complement formed from A11\n");CHKERRQ(ierr);
1963e8b8b31SMatthew G Knepley       }
1973e8b8b31SMatthew G Knepley       break;
1983e8b8b31SMatthew G Knepley     default:
19982f516ccSBarry Smith       SETERRQ1(PetscObjectComm((PetscObject)pc), PETSC_ERR_ARG_OUTOFRANGE, "Invalid Schur preconditioning type: %d", jac->schurpre);
2003e8b8b31SMatthew G Knepley     }
2013b224e63SBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"  Split info:\n");CHKERRQ(ierr);
2023b224e63SBarry Smith     ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
2033b224e63SBarry Smith     for (i=0; i<jac->nsplits; i++) {
2043b224e63SBarry Smith       if (ilink->fields) {
2053b224e63SBarry Smith         ierr = PetscViewerASCIIPrintf(viewer,"Split number %D Fields ",i);CHKERRQ(ierr);
2063b224e63SBarry Smith         ierr = PetscViewerASCIIUseTabs(viewer,PETSC_FALSE);CHKERRQ(ierr);
2073b224e63SBarry Smith         for (j=0; j<ilink->nfields; j++) {
2083b224e63SBarry Smith           if (j > 0) {
2093b224e63SBarry Smith             ierr = PetscViewerASCIIPrintf(viewer,",");CHKERRQ(ierr);
2103b224e63SBarry Smith           }
2113b224e63SBarry Smith           ierr = PetscViewerASCIIPrintf(viewer," %D",ilink->fields[j]);CHKERRQ(ierr);
2123b224e63SBarry Smith         }
2133b224e63SBarry Smith         ierr = PetscViewerASCIIPrintf(viewer,"\n");CHKERRQ(ierr);
2143b224e63SBarry Smith         ierr = PetscViewerASCIIUseTabs(viewer,PETSC_TRUE);CHKERRQ(ierr);
2153b224e63SBarry Smith       } else {
2163b224e63SBarry Smith         ierr = PetscViewerASCIIPrintf(viewer,"Split number %D Defined by IS\n",i);CHKERRQ(ierr);
2173b224e63SBarry Smith       }
2183b224e63SBarry Smith       ilink = ilink->next;
2193b224e63SBarry Smith     }
220435f959eSBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"KSP solver for A00 block\n");CHKERRQ(ierr);
2213b224e63SBarry Smith     ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
22206de4afeSJed Brown     if (jac->head) {
223443836d0SMatthew G Knepley       ierr = KSPView(jac->head->ksp,viewer);CHKERRQ(ierr);
22406de4afeSJed Brown     } else  {ierr = PetscViewerASCIIPrintf(viewer,"  not yet available\n");CHKERRQ(ierr);}
2253b224e63SBarry Smith     ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
22606de4afeSJed Brown     if (jac->head && jac->kspupper != jac->head->ksp) {
227443836d0SMatthew G Knepley       ierr = PetscViewerASCIIPrintf(viewer,"KSP solver for upper A00 in upper triangular factor \n");CHKERRQ(ierr);
228443836d0SMatthew G Knepley       ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
229b2750c55SJed Brown       if (jac->kspupper) {ierr = KSPView(jac->kspupper,viewer);CHKERRQ(ierr);}
230b2750c55SJed Brown       else {ierr = PetscViewerASCIIPrintf(viewer,"  not yet available\n");CHKERRQ(ierr);}
231443836d0SMatthew G Knepley       ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
232443836d0SMatthew G Knepley     }
233435f959eSBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"KSP solver for S = A11 - A10 inv(A00) A01 \n");CHKERRQ(ierr);
2343b224e63SBarry Smith     ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
23512cae6f2SJed Brown     if (jac->kspschur) {
2363b224e63SBarry Smith       ierr = KSPView(jac->kspschur,viewer);CHKERRQ(ierr);
23712cae6f2SJed Brown     } else {
23812cae6f2SJed Brown       ierr = PetscViewerASCIIPrintf(viewer,"  not yet available\n");CHKERRQ(ierr);
23912cae6f2SJed Brown     }
2403b224e63SBarry Smith     ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
2413b224e63SBarry Smith     ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
24206de4afeSJed Brown   } else if (isdraw && jac->head) {
2434996c5bdSBarry Smith     PetscDraw draw;
2444996c5bdSBarry Smith     PetscReal x,y,w,wd,h;
2454996c5bdSBarry Smith     PetscInt  cnt = 2;
2464996c5bdSBarry Smith     char      str[32];
2474996c5bdSBarry Smith 
2484996c5bdSBarry Smith     ierr = PetscViewerDrawGetDraw(viewer,0,&draw);CHKERRQ(ierr);
2494996c5bdSBarry Smith     ierr = PetscDrawGetCurrentPoint(draw,&x,&y);CHKERRQ(ierr);
250c74581afSBarry Smith     if (jac->kspupper != jac->head->ksp) cnt++;
251c74581afSBarry Smith     w  = 2*PetscMin(1.0 - x,x);
252c74581afSBarry Smith     wd = w/(cnt + 1);
253c74581afSBarry Smith 
2544996c5bdSBarry Smith     ierr = PetscSNPrintf(str,32,"Schur fact. %s",PCFieldSplitSchurFactTypes[jac->schurfactorization]);CHKERRQ(ierr);
25551fa3d41SBarry Smith     ierr = PetscDrawStringBoxed(draw,x,y,PETSC_DRAW_RED,PETSC_DRAW_BLACK,str,NULL,&h);CHKERRQ(ierr);
2564996c5bdSBarry Smith     y   -= h;
2574996c5bdSBarry Smith     if (jac->schurpre == PC_FIELDSPLIT_SCHUR_PRE_USER &&  !jac->schur_user) {
258e87fab1bSBarry Smith       ierr = PetscSNPrintf(str,32,"Prec. for Schur from %s",PCFieldSplitSchurPreTypes[PC_FIELDSPLIT_SCHUR_PRE_A11]);CHKERRQ(ierr);
2593b224e63SBarry Smith     } else {
2604996c5bdSBarry Smith       ierr = PetscSNPrintf(str,32,"Prec. for Schur from %s",PCFieldSplitSchurPreTypes[jac->schurpre]);CHKERRQ(ierr);
2614996c5bdSBarry Smith     }
26251fa3d41SBarry Smith     ierr = PetscDrawStringBoxed(draw,x+wd*(cnt-1)/2.0,y,PETSC_DRAW_RED,PETSC_DRAW_BLACK,str,NULL,&h);CHKERRQ(ierr);
2634996c5bdSBarry Smith     y   -= h;
2644996c5bdSBarry Smith     x    = x - wd*(cnt-1)/2.0;
2654996c5bdSBarry Smith 
2664996c5bdSBarry Smith     ierr = PetscDrawPushCurrentPoint(draw,x,y);CHKERRQ(ierr);
2674996c5bdSBarry Smith     ierr = KSPView(jac->head->ksp,viewer);CHKERRQ(ierr);
2684996c5bdSBarry Smith     ierr = PetscDrawPopCurrentPoint(draw);CHKERRQ(ierr);
2694996c5bdSBarry Smith     if (jac->kspupper != jac->head->ksp) {
2704996c5bdSBarry Smith       x   += wd;
2714996c5bdSBarry Smith       ierr = PetscDrawPushCurrentPoint(draw,x,y);CHKERRQ(ierr);
2724996c5bdSBarry Smith       ierr = KSPView(jac->kspupper,viewer);CHKERRQ(ierr);
2734996c5bdSBarry Smith       ierr = PetscDrawPopCurrentPoint(draw);CHKERRQ(ierr);
2744996c5bdSBarry Smith     }
2754996c5bdSBarry Smith     x   += wd;
2764996c5bdSBarry Smith     ierr = PetscDrawPushCurrentPoint(draw,x,y);CHKERRQ(ierr);
2774996c5bdSBarry Smith     ierr = KSPView(jac->kspschur,viewer);CHKERRQ(ierr);
2784996c5bdSBarry Smith     ierr = PetscDrawPopCurrentPoint(draw);CHKERRQ(ierr);
2793b224e63SBarry Smith   }
2803b224e63SBarry Smith   PetscFunctionReturn(0);
2813b224e63SBarry Smith }
2823b224e63SBarry Smith 
283a51937d4SCarola Kruse static PetscErrorCode PCView_FieldSplit_GKB(PC pc,PetscViewer viewer)
284a51937d4SCarola Kruse {
285a51937d4SCarola Kruse   PC_FieldSplit     *jac = (PC_FieldSplit*)pc->data;
286a51937d4SCarola Kruse   PetscErrorCode    ierr;
287a51937d4SCarola Kruse   PetscBool         iascii,isdraw;
288a51937d4SCarola Kruse   PetscInt          i,j;
289a51937d4SCarola Kruse   PC_FieldSplitLink ilink = jac->head;
290a51937d4SCarola Kruse 
291a51937d4SCarola Kruse   PetscFunctionBegin;
292a51937d4SCarola Kruse   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&iascii);CHKERRQ(ierr);
293a51937d4SCarola Kruse   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERDRAW,&isdraw);CHKERRQ(ierr);
294a51937d4SCarola Kruse   if (iascii) {
295a51937d4SCarola Kruse     if (jac->bs > 0) {
296a51937d4SCarola Kruse       ierr = PetscViewerASCIIPrintf(viewer,"  FieldSplit with %s composition: total splits = %D, blocksize = %D\n",PCCompositeTypes[jac->type],jac->nsplits,jac->bs);CHKERRQ(ierr);
297a51937d4SCarola Kruse     } else {
298a51937d4SCarola Kruse       ierr = PetscViewerASCIIPrintf(viewer,"  FieldSplit with %s composition: total splits = %D\n",PCCompositeTypes[jac->type],jac->nsplits);CHKERRQ(ierr);
299a51937d4SCarola Kruse     }
300a51937d4SCarola Kruse     if (pc->useAmat) {
301a51937d4SCarola Kruse       ierr = PetscViewerASCIIPrintf(viewer,"  using Amat (not Pmat) as operator for blocks\n");CHKERRQ(ierr);
302a51937d4SCarola Kruse     }
303a51937d4SCarola Kruse     if (jac->diag_use_amat) {
304a51937d4SCarola Kruse       ierr = PetscViewerASCIIPrintf(viewer,"  using Amat (not Pmat) as operator for diagonal blocks\n");CHKERRQ(ierr);
305a51937d4SCarola Kruse     }
306a51937d4SCarola Kruse     if (jac->offdiag_use_amat) {
307a51937d4SCarola Kruse       ierr = PetscViewerASCIIPrintf(viewer,"  using Amat (not Pmat) as operator for off-diagonal blocks\n");CHKERRQ(ierr);
308a51937d4SCarola Kruse     }
309a51937d4SCarola Kruse 
310a51937d4SCarola Kruse     ierr = PetscViewerASCIIPrintf(viewer,"  Stopping tolerance=%.1e, delay in error estimate=%D, maximum iterations=%D\n",jac->gkbtol,jac->gkbdelay,jac->gkbmaxit);CHKERRQ(ierr);
311a51937d4SCarola Kruse     ierr = PetscViewerASCIIPrintf(viewer,"  Solver info for H = A00 + nu*A01*A01' matrix:\n");CHKERRQ(ierr);
312a51937d4SCarola Kruse     ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
313a51937d4SCarola Kruse 
314a51937d4SCarola Kruse     if (ilink->fields) {
315a51937d4SCarola Kruse       ierr = PetscViewerASCIIPrintf(viewer,"Split number %D Fields ",0);CHKERRQ(ierr);
316a51937d4SCarola Kruse       ierr = PetscViewerASCIIUseTabs(viewer,PETSC_FALSE);CHKERRQ(ierr);
317a51937d4SCarola Kruse       for (j=0; j<ilink->nfields; j++) {
318a51937d4SCarola Kruse         if (j > 0) {
319a51937d4SCarola Kruse           ierr = PetscViewerASCIIPrintf(viewer,",");CHKERRQ(ierr);
320a51937d4SCarola Kruse         }
321a51937d4SCarola Kruse         ierr = PetscViewerASCIIPrintf(viewer," %D",ilink->fields[j]);CHKERRQ(ierr);
322a51937d4SCarola Kruse       }
323a51937d4SCarola Kruse       ierr = PetscViewerASCIIPrintf(viewer,"\n");CHKERRQ(ierr);
324a51937d4SCarola Kruse       ierr = PetscViewerASCIIUseTabs(viewer,PETSC_TRUE);CHKERRQ(ierr);
325a51937d4SCarola Kruse     } else {
326a51937d4SCarola Kruse         ierr = PetscViewerASCIIPrintf(viewer,"Split number %D Defined by IS\n",0);CHKERRQ(ierr);
327a51937d4SCarola Kruse     }
328a51937d4SCarola Kruse     ierr  = KSPView(ilink->ksp,viewer);CHKERRQ(ierr);
329a51937d4SCarola Kruse 
330a51937d4SCarola Kruse     ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
331a51937d4SCarola Kruse   }
332a51937d4SCarola Kruse 
333a51937d4SCarola Kruse  if (isdraw) {
334a51937d4SCarola Kruse     PetscDraw draw;
335a51937d4SCarola Kruse     PetscReal x,y,w,wd;
336a51937d4SCarola Kruse 
337a51937d4SCarola Kruse     ierr = PetscViewerDrawGetDraw(viewer,0,&draw);CHKERRQ(ierr);
338a51937d4SCarola Kruse     ierr = PetscDrawGetCurrentPoint(draw,&x,&y);CHKERRQ(ierr);
339a51937d4SCarola Kruse     w    = 2*PetscMin(1.0 - x,x);
340a51937d4SCarola Kruse     wd   = w/(jac->nsplits + 1);
341a51937d4SCarola Kruse     x    = x - wd*(jac->nsplits-1)/2.0;
342a51937d4SCarola Kruse     for (i=0; i<jac->nsplits; i++) {
343a51937d4SCarola Kruse       ierr  = PetscDrawPushCurrentPoint(draw,x,y);CHKERRQ(ierr);
344a51937d4SCarola Kruse       ierr  = KSPView(ilink->ksp,viewer);CHKERRQ(ierr);
345a51937d4SCarola Kruse       ierr  = PetscDrawPopCurrentPoint(draw);CHKERRQ(ierr);
346a51937d4SCarola Kruse       x    += wd;
347a51937d4SCarola Kruse       ilink = ilink->next;
348a51937d4SCarola Kruse     }
349a51937d4SCarola Kruse   }
350a51937d4SCarola Kruse   PetscFunctionReturn(0);
351a51937d4SCarola Kruse }
352a51937d4SCarola Kruse 
3536c924f48SJed Brown /* Precondition: jac->bs is set to a meaningful value */
3546c924f48SJed Brown static PetscErrorCode PCFieldSplitSetRuntimeSplits_Private(PC pc)
3556c924f48SJed Brown {
3566c924f48SJed Brown   PetscErrorCode ierr;
3576c924f48SJed Brown   PC_FieldSplit  *jac = (PC_FieldSplit*)pc->data;
3585d4c12cdSJungho Lee   PetscInt       i,nfields,*ifields,nfields_col,*ifields_col;
3595d4c12cdSJungho Lee   PetscBool      flg,flg_col;
3605d4c12cdSJungho Lee   char           optionname[128],splitname[8],optionname_col[128];
3616c924f48SJed Brown 
3626c924f48SJed Brown   PetscFunctionBegin;
363785e854fSJed Brown   ierr = PetscMalloc1(jac->bs,&ifields);CHKERRQ(ierr);
364785e854fSJed Brown   ierr = PetscMalloc1(jac->bs,&ifields_col);CHKERRQ(ierr);
3656c924f48SJed Brown   for (i=0,flg=PETSC_TRUE;; i++) {
3668caf3d72SBarry Smith     ierr        = PetscSNPrintf(splitname,sizeof(splitname),"%D",i);CHKERRQ(ierr);
3678caf3d72SBarry Smith     ierr        = PetscSNPrintf(optionname,sizeof(optionname),"-pc_fieldsplit_%D_fields",i);CHKERRQ(ierr);
3688caf3d72SBarry Smith     ierr        = PetscSNPrintf(optionname_col,sizeof(optionname_col),"-pc_fieldsplit_%D_fields_col",i);CHKERRQ(ierr);
3696c924f48SJed Brown     nfields     = jac->bs;
37029499fbbSJungho Lee     nfields_col = jac->bs;
371c5929fdfSBarry Smith     ierr        = PetscOptionsGetIntArray(((PetscObject)pc)->options,((PetscObject)pc)->prefix,optionname,ifields,&nfields,&flg);CHKERRQ(ierr);
372c5929fdfSBarry Smith     ierr        = PetscOptionsGetIntArray(((PetscObject)pc)->options,((PetscObject)pc)->prefix,optionname_col,ifields_col,&nfields_col,&flg_col);CHKERRQ(ierr);
3736c924f48SJed Brown     if (!flg) break;
3745d4c12cdSJungho Lee     else if (flg && !flg_col) {
3755d4c12cdSJungho Lee       if (!nfields) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_USER,"Cannot list zero fields");
3765d4c12cdSJungho Lee       ierr = PCFieldSplitSetFields(pc,splitname,nfields,ifields,ifields);CHKERRQ(ierr);
3772fa5cd67SKarl Rupp     } else {
3785d4c12cdSJungho Lee       if (!nfields || !nfields_col) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_USER,"Cannot list zero fields");
3795d4c12cdSJungho Lee       if (nfields != nfields_col) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_USER,"Number of row and column fields must match");
3805d4c12cdSJungho Lee       ierr = PCFieldSplitSetFields(pc,splitname,nfields,ifields,ifields_col);CHKERRQ(ierr);
3815d4c12cdSJungho Lee     }
3826c924f48SJed Brown   }
3836c924f48SJed Brown   if (i > 0) {
3846c924f48SJed Brown     /* Makes command-line setting of splits take precedence over setting them in code.
3856c924f48SJed Brown        Otherwise subsequent calls to PCFieldSplitSetIS() or PCFieldSplitSetFields() would
3866c924f48SJed Brown        create new splits, which would probably not be what the user wanted. */
3876c924f48SJed Brown     jac->splitdefined = PETSC_TRUE;
3886c924f48SJed Brown   }
3896c924f48SJed Brown   ierr = PetscFree(ifields);CHKERRQ(ierr);
3905d4c12cdSJungho Lee   ierr = PetscFree(ifields_col);CHKERRQ(ierr);
3916c924f48SJed Brown   PetscFunctionReturn(0);
3926c924f48SJed Brown }
3936c924f48SJed Brown 
39469a612a9SBarry Smith static PetscErrorCode PCFieldSplitSetDefaults(PC pc)
3950971522cSBarry Smith {
3960971522cSBarry Smith   PC_FieldSplit     *jac = (PC_FieldSplit*)pc->data;
3970971522cSBarry Smith   PetscErrorCode    ierr;
3985a9f2f41SSatish Balay   PC_FieldSplitLink ilink = jac->head;
3997b752e3dSPatrick Sanan   PetscBool         fieldsplit_default = PETSC_FALSE,coupling = PETSC_FALSE;
4006c924f48SJed Brown   PetscInt          i;
4010971522cSBarry Smith 
4020971522cSBarry Smith   PetscFunctionBegin;
4037287d2a3SDmitry Karpeev   /*
404f5f0d762SBarry Smith    Kinda messy, but at least this now uses DMCreateFieldDecomposition().
4057287d2a3SDmitry Karpeev    Should probably be rewritten.
4067287d2a3SDmitry Karpeev    */
407f5f0d762SBarry Smith   if (!ilink) {
408c5929fdfSBarry Smith     ierr = PetscOptionsGetBool(((PetscObject)pc)->options,((PetscObject)pc)->prefix,"-pc_fieldsplit_detect_coupling",&coupling,NULL);CHKERRQ(ierr);
4097b752e3dSPatrick Sanan     if (pc->dm && jac->dm_splits && !jac->detect && !coupling) {
410bafc1b83SMatthew G Knepley       PetscInt  numFields, f, i, j;
4110784a22cSJed Brown       char      **fieldNames;
4127b62db95SJungho Lee       IS        *fields;
413e7c4fc90SDmitry Karpeev       DM        *dms;
414bafc1b83SMatthew G Knepley       DM        subdm[128];
415bafc1b83SMatthew G Knepley       PetscBool flg;
416bafc1b83SMatthew G Knepley 
41716621825SDmitry Karpeev       ierr = DMCreateFieldDecomposition(pc->dm, &numFields, &fieldNames, &fields, &dms);CHKERRQ(ierr);
418bafc1b83SMatthew G Knepley       /* Allow the user to prescribe the splits */
419bafc1b83SMatthew G Knepley       for (i = 0, flg = PETSC_TRUE;; i++) {
420bafc1b83SMatthew G Knepley         PetscInt ifields[128];
421bafc1b83SMatthew G Knepley         IS       compField;
422bafc1b83SMatthew G Knepley         char     optionname[128], splitname[8];
423bafc1b83SMatthew G Knepley         PetscInt nfields = numFields;
424bafc1b83SMatthew G Knepley 
4258caf3d72SBarry Smith         ierr = PetscSNPrintf(optionname, sizeof(optionname), "-pc_fieldsplit_%D_fields", i);CHKERRQ(ierr);
426c5929fdfSBarry Smith         ierr = PetscOptionsGetIntArray(((PetscObject)pc)->options,((PetscObject)pc)->prefix, optionname, ifields, &nfields, &flg);CHKERRQ(ierr);
427bafc1b83SMatthew G Knepley         if (!flg) break;
42882f516ccSBarry Smith         if (numFields > 128) SETERRQ1(PetscObjectComm((PetscObject)pc),PETSC_ERR_SUP,"Cannot currently support %d > 128 fields", numFields);
429bafc1b83SMatthew G Knepley         ierr = DMCreateSubDM(pc->dm, nfields, ifields, &compField, &subdm[i]);CHKERRQ(ierr);
430bafc1b83SMatthew G Knepley         if (nfields == 1) {
431bafc1b83SMatthew G Knepley           ierr = PCFieldSplitSetIS(pc, fieldNames[ifields[0]], compField);CHKERRQ(ierr);
432bafc1b83SMatthew G Knepley         } else {
4338caf3d72SBarry Smith           ierr = PetscSNPrintf(splitname, sizeof(splitname), "%D", i);CHKERRQ(ierr);
434bafc1b83SMatthew G Knepley           ierr = PCFieldSplitSetIS(pc, splitname, compField);CHKERRQ(ierr);
4357287d2a3SDmitry Karpeev         }
436bafc1b83SMatthew G Knepley         ierr = ISDestroy(&compField);CHKERRQ(ierr);
437bafc1b83SMatthew G Knepley         for (j = 0; j < nfields; ++j) {
438bafc1b83SMatthew G Knepley           f    = ifields[j];
4397b62db95SJungho Lee           ierr = PetscFree(fieldNames[f]);CHKERRQ(ierr);
4407b62db95SJungho Lee           ierr = ISDestroy(&fields[f]);CHKERRQ(ierr);
4417b62db95SJungho Lee         }
442bafc1b83SMatthew G Knepley       }
443bafc1b83SMatthew G Knepley       if (i == 0) {
444bafc1b83SMatthew G Knepley         for (f = 0; f < numFields; ++f) {
445bafc1b83SMatthew G Knepley           ierr = PCFieldSplitSetIS(pc, fieldNames[f], fields[f]);CHKERRQ(ierr);
446bafc1b83SMatthew G Knepley           ierr = PetscFree(fieldNames[f]);CHKERRQ(ierr);
447bafc1b83SMatthew G Knepley           ierr = ISDestroy(&fields[f]);CHKERRQ(ierr);
448bafc1b83SMatthew G Knepley         }
449bafc1b83SMatthew G Knepley       } else {
450d724dfffSBarry Smith         for (j=0; j<numFields; j++) {
451d724dfffSBarry Smith           ierr = DMDestroy(dms+j);CHKERRQ(ierr);
452d724dfffSBarry Smith         }
453d724dfffSBarry Smith         ierr = PetscFree(dms);CHKERRQ(ierr);
454785e854fSJed Brown         ierr = PetscMalloc1(i, &dms);CHKERRQ(ierr);
4552fa5cd67SKarl Rupp         for (j = 0; j < i; ++j) dms[j] = subdm[j];
456bafc1b83SMatthew G Knepley       }
4577b62db95SJungho Lee       ierr = PetscFree(fieldNames);CHKERRQ(ierr);
4587b62db95SJungho Lee       ierr = PetscFree(fields);CHKERRQ(ierr);
459e7c4fc90SDmitry Karpeev       if (dms) {
4608b8307b2SJed Brown         ierr = PetscInfo(pc, "Setting up physics based fieldsplit preconditioner using the embedded DM\n");CHKERRQ(ierr);
461bafc1b83SMatthew G Knepley         for (ilink = jac->head, i = 0; ilink; ilink = ilink->next, ++i) {
4627287d2a3SDmitry Karpeev           const char *prefix;
4637287d2a3SDmitry Karpeev           ierr = PetscObjectGetOptionsPrefix((PetscObject)(ilink->ksp),&prefix);CHKERRQ(ierr);
4647287d2a3SDmitry Karpeev           ierr = PetscObjectSetOptionsPrefix((PetscObject)(dms[i]), prefix);CHKERRQ(ierr);
4657b62db95SJungho Lee           ierr = KSPSetDM(ilink->ksp, dms[i]);CHKERRQ(ierr);
4667b62db95SJungho Lee           ierr = KSPSetDMActive(ilink->ksp, PETSC_FALSE);CHKERRQ(ierr);
46795dbaa6fSMatthew G. Knepley           {
46895dbaa6fSMatthew G. Knepley             PetscErrorCode (*func)(KSP,Mat,Mat,void*);
46995dbaa6fSMatthew G. Knepley             void            *ctx;
47095dbaa6fSMatthew G. Knepley 
47195dbaa6fSMatthew G. Knepley             ierr = DMKSPGetComputeOperators(pc->dm, &func, &ctx);CHKERRQ(ierr);
47295dbaa6fSMatthew G. Knepley             ierr = DMKSPSetComputeOperators(dms[i],  func,  ctx);CHKERRQ(ierr);
47395dbaa6fSMatthew G. Knepley           }
4747287d2a3SDmitry Karpeev           ierr = PetscObjectIncrementTabLevel((PetscObject)dms[i],(PetscObject)ilink->ksp,0);CHKERRQ(ierr);
475e7c4fc90SDmitry Karpeev           ierr = DMDestroy(&dms[i]);CHKERRQ(ierr);
4762fa5ba8aSJed Brown         }
4777b62db95SJungho Lee         ierr = PetscFree(dms);CHKERRQ(ierr);
4788b8307b2SJed Brown       }
47966ffff09SJed Brown     } else {
480521d7252SBarry Smith       if (jac->bs <= 0) {
481704ba839SBarry Smith         if (pc->pmat) {
482521d7252SBarry Smith           ierr = MatGetBlockSize(pc->pmat,&jac->bs);CHKERRQ(ierr);
4832fa5cd67SKarl Rupp         } else jac->bs = 1;
484521d7252SBarry Smith       }
485d32f9abdSBarry Smith 
4867b752e3dSPatrick Sanan       if (jac->detect) {
4876ce1633cSBarry Smith         IS       zerodiags,rest;
4886ce1633cSBarry Smith         PetscInt nmin,nmax;
4896ce1633cSBarry Smith 
4906ce1633cSBarry Smith         ierr = MatGetOwnershipRange(pc->mat,&nmin,&nmax);CHKERRQ(ierr);
4917199da05SBarry Smith         if (jac->diag_use_amat) {
4926ce1633cSBarry Smith           ierr = MatFindZeroDiagonals(pc->mat,&zerodiags);CHKERRQ(ierr);
4937199da05SBarry Smith         } else {
4947199da05SBarry Smith           ierr = MatFindZeroDiagonals(pc->pmat,&zerodiags);CHKERRQ(ierr);
4957199da05SBarry Smith         }
4966ce1633cSBarry Smith         ierr = ISComplement(zerodiags,nmin,nmax,&rest);CHKERRQ(ierr);
4976ce1633cSBarry Smith         ierr = PCFieldSplitSetIS(pc,"0",rest);CHKERRQ(ierr);
4986ce1633cSBarry Smith         ierr = PCFieldSplitSetIS(pc,"1",zerodiags);CHKERRQ(ierr);
499fcfd50ebSBarry Smith         ierr = ISDestroy(&zerodiags);CHKERRQ(ierr);
500fcfd50ebSBarry Smith         ierr = ISDestroy(&rest);CHKERRQ(ierr);
5013a062f41SBarry Smith       } else if (coupling) {
5023a062f41SBarry Smith         IS       coupling,rest;
5033a062f41SBarry Smith         PetscInt nmin,nmax;
5043a062f41SBarry Smith 
5053a062f41SBarry Smith         ierr = MatGetOwnershipRange(pc->mat,&nmin,&nmax);CHKERRQ(ierr);
5067199da05SBarry Smith         if (jac->offdiag_use_amat) {
5073a062f41SBarry Smith           ierr = MatFindOffBlockDiagonalEntries(pc->mat,&coupling);CHKERRQ(ierr);
5087199da05SBarry Smith         } else {
5097199da05SBarry Smith           ierr = MatFindOffBlockDiagonalEntries(pc->pmat,&coupling);CHKERRQ(ierr);
5107199da05SBarry Smith         }
5116bea0878SBarry Smith         ierr = ISCreateStride(PetscObjectComm((PetscObject)pc->mat),nmax-nmin,nmin,1,&rest);CHKERRQ(ierr);
512e52d2c62SBarry Smith         ierr = ISSetIdentity(rest);CHKERRQ(ierr);
513d020c841SBarry Smith         ierr = PCFieldSplitSetIS(pc,"0",rest);CHKERRQ(ierr);
514d020c841SBarry Smith         ierr = PCFieldSplitSetIS(pc,"1",coupling);CHKERRQ(ierr);
5153a062f41SBarry Smith         ierr = ISDestroy(&coupling);CHKERRQ(ierr);
5163a062f41SBarry Smith         ierr = ISDestroy(&rest);CHKERRQ(ierr);
5176ce1633cSBarry Smith       } else {
518c5929fdfSBarry Smith         ierr = PetscOptionsGetBool(((PetscObject)pc)->options,((PetscObject)pc)->prefix,"-pc_fieldsplit_default",&fieldsplit_default,NULL);CHKERRQ(ierr);
5197287d2a3SDmitry Karpeev         if (!fieldsplit_default) {
520d32f9abdSBarry Smith           /* Allow user to set fields from command line,  if bs was known at the time of PCSetFromOptions_FieldSplit()
521d32f9abdSBarry Smith            then it is set there. This is not ideal because we should only have options set in XXSetFromOptions(). */
5226c924f48SJed Brown           ierr = PCFieldSplitSetRuntimeSplits_Private(pc);CHKERRQ(ierr);
5236c924f48SJed Brown           if (jac->splitdefined) {ierr = PetscInfo(pc,"Splits defined using the options database\n");CHKERRQ(ierr);}
524d32f9abdSBarry Smith         }
5256dbb499eSCian Wilson         if ((fieldsplit_default || !jac->splitdefined) && !jac->isrestrict) {
5269f001fe8SStefano Zampini           Mat       M = pc->pmat;
527f3b928b9SStefano Zampini           PetscBool isnest;
528f3b928b9SStefano Zampini 
529d32f9abdSBarry Smith           ierr = PetscInfo(pc,"Using default splitting of fields\n");CHKERRQ(ierr);
530f3b928b9SStefano Zampini           ierr = PetscObjectTypeCompare((PetscObject)pc->pmat,MATNEST,&isnest);CHKERRQ(ierr);
531f3b928b9SStefano Zampini           if (!isnest) {
5329f001fe8SStefano Zampini             M    = pc->mat;
533f3b928b9SStefano Zampini             ierr = PetscObjectTypeCompare((PetscObject)pc->mat,MATNEST,&isnest);CHKERRQ(ierr);
534f3b928b9SStefano Zampini           }
535f3b928b9SStefano Zampini           if (isnest) {
536f3b928b9SStefano Zampini             IS       *fields;
537f3b928b9SStefano Zampini             PetscInt nf;
538f3b928b9SStefano Zampini 
5399f001fe8SStefano Zampini             ierr = MatNestGetSize(M,&nf,NULL);CHKERRQ(ierr);
540f3b928b9SStefano Zampini             ierr = PetscMalloc1(nf,&fields);CHKERRQ(ierr);
5419f001fe8SStefano Zampini             ierr = MatNestGetISs(M,fields,NULL);CHKERRQ(ierr);
542f3b928b9SStefano Zampini             for (i=0;i<nf;i++) {
543f3b928b9SStefano Zampini               ierr = PCFieldSplitSetIS(pc,NULL,fields[i]);CHKERRQ(ierr);
544f3b928b9SStefano Zampini             }
545f3b928b9SStefano Zampini             ierr = PetscFree(fields);CHKERRQ(ierr);
546f3b928b9SStefano Zampini           } else {
547db4c96c1SJed Brown             for (i=0; i<jac->bs; i++) {
5486c924f48SJed Brown               char splitname[8];
5498caf3d72SBarry Smith               ierr = PetscSNPrintf(splitname,sizeof(splitname),"%D",i);CHKERRQ(ierr);
5505d4c12cdSJungho Lee               ierr = PCFieldSplitSetFields(pc,splitname,1,&i,&i);CHKERRQ(ierr);
55179416396SBarry Smith             }
5525d4c12cdSJungho Lee             jac->defaultsplit = PETSC_TRUE;
553521d7252SBarry Smith           }
55466ffff09SJed Brown         }
5556ce1633cSBarry Smith       }
556f3b928b9SStefano Zampini     }
557edf189efSBarry Smith   } else if (jac->nsplits == 1) {
558edf189efSBarry Smith     if (ilink->is) {
559edf189efSBarry Smith       IS       is2;
560edf189efSBarry Smith       PetscInt nmin,nmax;
561edf189efSBarry Smith 
562edf189efSBarry Smith       ierr = MatGetOwnershipRange(pc->mat,&nmin,&nmax);CHKERRQ(ierr);
563edf189efSBarry Smith       ierr = ISComplement(ilink->is,nmin,nmax,&is2);CHKERRQ(ierr);
564db4c96c1SJed Brown       ierr = PCFieldSplitSetIS(pc,"1",is2);CHKERRQ(ierr);
565fcfd50ebSBarry Smith       ierr = ISDestroy(&is2);CHKERRQ(ierr);
56682f516ccSBarry Smith     } else SETERRQ(PetscObjectComm((PetscObject)pc),PETSC_ERR_SUP,"Must provide at least two sets of fields to PCFieldSplit()");
567edf189efSBarry Smith   }
568d0af7cd3SBarry Smith 
56982f516ccSBarry Smith   if (jac->nsplits < 2) SETERRQ1(PetscObjectComm((PetscObject)pc),PETSC_ERR_PLIB,"Unhandled case, must have at least two fields, not %d", jac->nsplits);
57069a612a9SBarry Smith   PetscFunctionReturn(0);
57169a612a9SBarry Smith }
57269a612a9SBarry Smith 
573a51937d4SCarola Kruse static PetscErrorCode MatGolubKahanComputeExplicitOperator(Mat A,Mat B,Mat C,Mat *H,PetscReal gkbnu)
574a51937d4SCarola Kruse {
575a51937d4SCarola Kruse   PetscErrorCode    ierr;
576a51937d4SCarola Kruse   Mat               BT,T;
577de482cd7SCarola Kruse   PetscReal         nrmT,nrmB;
578a51937d4SCarola Kruse 
579a51937d4SCarola Kruse   PetscFunctionBegin;
580a51937d4SCarola Kruse   ierr = MatHermitianTranspose(C,MAT_INITIAL_MATRIX,&T);CHKERRQ(ierr);            /* Test if augmented matrix is symmetric */
581a51937d4SCarola Kruse   ierr = MatAXPY(T,-1.0,B,DIFFERENT_NONZERO_PATTERN);CHKERRQ(ierr);
582de482cd7SCarola Kruse   ierr = MatNorm(T,NORM_1,&nrmT);CHKERRQ(ierr);
583de482cd7SCarola Kruse   ierr = MatNorm(B,NORM_1,&nrmB);CHKERRQ(ierr);
584de482cd7SCarola Kruse   if (nrmB > 0) {
585de482cd7SCarola Kruse     if (nrmT/nrmB >= PETSC_SMALL) {
586de482cd7SCarola Kruse       SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Matrix is not symmetric/hermitian, GKB is not applicable.");
587de482cd7SCarola Kruse     }
588a51937d4SCarola Kruse   }
589a51937d4SCarola Kruse   /* Compute augmented Lagrangian matrix H = A00 + nu*A01*A01'. This corresponds to */
590a51937d4SCarola Kruse   /* setting N := 1/nu*I in [Ar13].                                                 */
591a51937d4SCarola Kruse   ierr = MatHermitianTranspose(B,MAT_INITIAL_MATRIX,&BT);CHKERRQ(ierr);
592a51937d4SCarola Kruse   ierr = MatMatMult(B,BT,MAT_INITIAL_MATRIX,PETSC_DEFAULT,H);CHKERRQ(ierr);       /* H = A01*A01'          */
593a51937d4SCarola Kruse   ierr = MatAYPX(*H,gkbnu,A,DIFFERENT_NONZERO_PATTERN);CHKERRQ(ierr);             /* H = A00 + nu*A01*A01' */
594a51937d4SCarola Kruse 
595a51937d4SCarola Kruse   ierr = MatDestroy(&BT);CHKERRQ(ierr);
596a51937d4SCarola Kruse   ierr = MatDestroy(&T);CHKERRQ(ierr);
597a51937d4SCarola Kruse   PetscFunctionReturn(0);
598a51937d4SCarola Kruse }
599a51937d4SCarola Kruse 
6002d747510SLisandro Dalcin PETSC_EXTERN PetscErrorCode PetscOptionsFindPairPrefix_Private(PetscOptions,const char pre[], const char name[],const char *value[],PetscBool *flg);
601514bf10dSMatthew G Knepley 
60269a612a9SBarry Smith static PetscErrorCode PCSetUp_FieldSplit(PC pc)
60369a612a9SBarry Smith {
60469a612a9SBarry Smith   PC_FieldSplit     *jac = (PC_FieldSplit*)pc->data;
60569a612a9SBarry Smith   PetscErrorCode    ierr;
6065a9f2f41SSatish Balay   PC_FieldSplitLink ilink;
6072c9966d7SBarry Smith   PetscInt          i,nsplit;
6085f4ab4e1SJungho Lee   PetscBool         sorted, sorted_col;
60969a612a9SBarry Smith 
61069a612a9SBarry Smith   PetscFunctionBegin;
6115da88fe4STristan Konolige   pc->failedreason = PC_NOERROR;
61269a612a9SBarry Smith   ierr   = PCFieldSplitSetDefaults(pc);CHKERRQ(ierr);
61397bbdb24SBarry Smith   nsplit = jac->nsplits;
6145a9f2f41SSatish Balay   ilink  = jac->head;
61597bbdb24SBarry Smith 
61697bbdb24SBarry Smith   /* get the matrices for each split */
617704ba839SBarry Smith   if (!jac->issetup) {
6181b9fc7fcSBarry Smith     PetscInt rstart,rend,nslots,bs;
61997bbdb24SBarry Smith 
620704ba839SBarry Smith     jac->issetup = PETSC_TRUE;
621704ba839SBarry Smith 
6225d4c12cdSJungho Lee     /* This is done here instead of in PCFieldSplitSetFields() because may not have matrix at that point */
6232c9966d7SBarry Smith     if (jac->defaultsplit || !ilink->is) {
6242c9966d7SBarry Smith       if (jac->bs <= 0) jac->bs = nsplit;
6252c9966d7SBarry Smith     }
62651f519a2SBarry Smith     bs     = jac->bs;
62797bbdb24SBarry Smith     ierr   = MatGetOwnershipRange(pc->pmat,&rstart,&rend);CHKERRQ(ierr);
6281b9fc7fcSBarry Smith     nslots = (rend - rstart)/bs;
6291b9fc7fcSBarry Smith     for (i=0; i<nsplit; i++) {
6301b9fc7fcSBarry Smith       if (jac->defaultsplit) {
631ce94432eSBarry Smith         ierr = ISCreateStride(PetscObjectComm((PetscObject)pc),nslots,rstart+i,nsplit,&ilink->is);CHKERRQ(ierr);
6325f4ab4e1SJungho Lee         ierr = ISDuplicate(ilink->is,&ilink->is_col);CHKERRQ(ierr);
633704ba839SBarry Smith       } else if (!ilink->is) {
634ccb205f8SBarry Smith         if (ilink->nfields > 1) {
6355f4ab4e1SJungho Lee           PetscInt *ii,*jj,j,k,nfields = ilink->nfields,*fields = ilink->fields,*fields_col = ilink->fields_col;
636785e854fSJed Brown           ierr = PetscMalloc1(ilink->nfields*nslots,&ii);CHKERRQ(ierr);
637785e854fSJed Brown           ierr = PetscMalloc1(ilink->nfields*nslots,&jj);CHKERRQ(ierr);
6381b9fc7fcSBarry Smith           for (j=0; j<nslots; j++) {
6391b9fc7fcSBarry Smith             for (k=0; k<nfields; k++) {
6401b9fc7fcSBarry Smith               ii[nfields*j + k] = rstart + bs*j + fields[k];
6415f4ab4e1SJungho Lee               jj[nfields*j + k] = rstart + bs*j + fields_col[k];
64297bbdb24SBarry Smith             }
64397bbdb24SBarry Smith           }
644ce94432eSBarry Smith           ierr = ISCreateGeneral(PetscObjectComm((PetscObject)pc),nslots*nfields,ii,PETSC_OWN_POINTER,&ilink->is);CHKERRQ(ierr);
645ce94432eSBarry Smith           ierr = ISCreateGeneral(PetscObjectComm((PetscObject)pc),nslots*nfields,jj,PETSC_OWN_POINTER,&ilink->is_col);CHKERRQ(ierr);
64690e68f20SPatrick Farrell           ierr = ISSetBlockSize(ilink->is, nfields);CHKERRQ(ierr);
64790e68f20SPatrick Farrell           ierr = ISSetBlockSize(ilink->is_col, nfields);CHKERRQ(ierr);
648ccb205f8SBarry Smith         } else {
649ce94432eSBarry Smith           ierr = ISCreateStride(PetscObjectComm((PetscObject)pc),nslots,rstart+ilink->fields[0],bs,&ilink->is);CHKERRQ(ierr);
650ce94432eSBarry Smith           ierr = ISCreateStride(PetscObjectComm((PetscObject)pc),nslots,rstart+ilink->fields_col[0],bs,&ilink->is_col);CHKERRQ(ierr);
651ccb205f8SBarry Smith         }
6523e197d65SBarry Smith       }
653704ba839SBarry Smith       ierr = ISSorted(ilink->is,&sorted);CHKERRQ(ierr);
6545f4ab4e1SJungho Lee       if (ilink->is_col) { ierr = ISSorted(ilink->is_col,&sorted_col);CHKERRQ(ierr); }
6555f4ab4e1SJungho Lee       if (!sorted || !sorted_col) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_USER,"Fields must be sorted when creating split");
656704ba839SBarry Smith       ilink = ilink->next;
6571b9fc7fcSBarry Smith     }
6581b9fc7fcSBarry Smith   }
6591b9fc7fcSBarry Smith 
660704ba839SBarry Smith   ilink = jac->head;
66197bbdb24SBarry Smith   if (!jac->pmat) {
662bdddcaaaSMatthew G Knepley     Vec xtmp;
663bdddcaaaSMatthew G Knepley 
6642a7a6963SBarry Smith     ierr = MatCreateVecs(pc->pmat,&xtmp,NULL);CHKERRQ(ierr);
665785e854fSJed Brown     ierr = PetscMalloc1(nsplit,&jac->pmat);CHKERRQ(ierr);
666dcca6d9dSJed Brown     ierr = PetscMalloc2(nsplit,&jac->x,nsplit,&jac->y);CHKERRQ(ierr);
667cf502942SBarry Smith     for (i=0; i<nsplit; i++) {
668bdddcaaaSMatthew G Knepley       MatNullSpace sp;
669bdddcaaaSMatthew G Knepley 
670a3df900dSMatthew G Knepley       /* Check for preconditioning matrix attached to IS */
671a3df900dSMatthew G Knepley       ierr = PetscObjectQuery((PetscObject) ilink->is, "pmat", (PetscObject*) &jac->pmat[i]);CHKERRQ(ierr);
672a3df900dSMatthew G Knepley       if (jac->pmat[i]) {
673a3df900dSMatthew G Knepley         ierr = PetscObjectReference((PetscObject) jac->pmat[i]);CHKERRQ(ierr);
674a3df900dSMatthew G Knepley         if (jac->type == PC_COMPOSITE_SCHUR) {
675a3df900dSMatthew G Knepley           jac->schur_user = jac->pmat[i];
6762fa5cd67SKarl Rupp 
677a3df900dSMatthew G Knepley           ierr = PetscObjectReference((PetscObject) jac->schur_user);CHKERRQ(ierr);
678a3df900dSMatthew G Knepley         }
679a3df900dSMatthew G Knepley       } else {
6803a062f41SBarry Smith         const char *prefix;
6817dae84e0SHong Zhang         ierr = MatCreateSubMatrix(pc->pmat,ilink->is,ilink->is_col,MAT_INITIAL_MATRIX,&jac->pmat[i]);CHKERRQ(ierr);
6823a062f41SBarry Smith         ierr = KSPGetOptionsPrefix(ilink->ksp,&prefix);CHKERRQ(ierr);
6833a062f41SBarry Smith         ierr = MatSetOptionsPrefix(jac->pmat[i],prefix);CHKERRQ(ierr);
6843a062f41SBarry Smith         ierr = MatViewFromOptions(jac->pmat[i],NULL,"-mat_view");CHKERRQ(ierr);
685a3df900dSMatthew G Knepley       }
686bdddcaaaSMatthew G Knepley       /* create work vectors for each split */
6872a7a6963SBarry Smith       ierr     = MatCreateVecs(jac->pmat[i],&jac->x[i],&jac->y[i]);CHKERRQ(ierr);
6880298fd71SBarry Smith       ilink->x = jac->x[i]; ilink->y = jac->y[i]; ilink->z = NULL;
689bdddcaaaSMatthew G Knepley       /* compute scatter contexts needed by multiplicative versions and non-default splits */
6909448b7f1SJunchao Zhang       ierr = VecScatterCreate(xtmp,ilink->is,jac->x[i],NULL,&ilink->sctx);CHKERRQ(ierr);
691ed1f0337SMatthew G Knepley       ierr = PetscObjectQuery((PetscObject) ilink->is, "nearnullspace", (PetscObject*) &sp);CHKERRQ(ierr);
692ed1f0337SMatthew G Knepley       if (sp) {
693ed1f0337SMatthew G Knepley         ierr = MatSetNearNullSpace(jac->pmat[i], sp);CHKERRQ(ierr);
694ed1f0337SMatthew G Knepley       }
695704ba839SBarry Smith       ilink = ilink->next;
696cf502942SBarry Smith     }
697bdddcaaaSMatthew G Knepley     ierr = VecDestroy(&xtmp);CHKERRQ(ierr);
69897bbdb24SBarry Smith   } else {
699ef7efd37SHong Zhang     MatReuse scall;
700ef7efd37SHong Zhang     if (pc->flag == DIFFERENT_NONZERO_PATTERN) {
701ef7efd37SHong Zhang       for (i=0; i<nsplit; i++) {
702ef7efd37SHong Zhang         ierr = MatDestroy(&jac->pmat[i]);CHKERRQ(ierr);
703ef7efd37SHong Zhang       }
704ef7efd37SHong Zhang       scall = MAT_INITIAL_MATRIX;
705ef7efd37SHong Zhang     } else scall = MAT_REUSE_MATRIX;
706ef7efd37SHong Zhang 
707cf502942SBarry Smith     for (i=0; i<nsplit; i++) {
708a3df900dSMatthew G Knepley       Mat pmat;
709a3df900dSMatthew G Knepley 
710a3df900dSMatthew G Knepley       /* Check for preconditioning matrix attached to IS */
711a3df900dSMatthew G Knepley       ierr = PetscObjectQuery((PetscObject) ilink->is, "pmat", (PetscObject*) &pmat);CHKERRQ(ierr);
712a3df900dSMatthew G Knepley       if (!pmat) {
713ef7efd37SHong Zhang         ierr = MatCreateSubMatrix(pc->pmat,ilink->is,ilink->is_col,scall,&jac->pmat[i]);CHKERRQ(ierr);
714a3df900dSMatthew G Knepley       }
715704ba839SBarry Smith       ilink = ilink->next;
716cf502942SBarry Smith     }
71797bbdb24SBarry Smith   }
7184e39094bSDmitry Karpeev   if (jac->diag_use_amat) {
719519d70e2SJed Brown     ilink = jac->head;
720519d70e2SJed Brown     if (!jac->mat) {
721785e854fSJed Brown       ierr = PetscMalloc1(nsplit,&jac->mat);CHKERRQ(ierr);
722519d70e2SJed Brown       for (i=0; i<nsplit; i++) {
7237dae84e0SHong Zhang         ierr  = MatCreateSubMatrix(pc->mat,ilink->is,ilink->is_col,MAT_INITIAL_MATRIX,&jac->mat[i]);CHKERRQ(ierr);
724519d70e2SJed Brown         ilink = ilink->next;
725519d70e2SJed Brown       }
726519d70e2SJed Brown     } else {
727ef7efd37SHong Zhang       MatReuse scall;
728ef7efd37SHong Zhang       if (pc->flag == DIFFERENT_NONZERO_PATTERN) {
729519d70e2SJed Brown         for (i=0; i<nsplit; i++) {
730ef7efd37SHong Zhang           ierr = MatDestroy(&jac->mat[i]);CHKERRQ(ierr);
731ef7efd37SHong Zhang         }
732ef7efd37SHong Zhang         scall = MAT_INITIAL_MATRIX;
733ef7efd37SHong Zhang       } else scall = MAT_REUSE_MATRIX;
734ef7efd37SHong Zhang 
735ef7efd37SHong Zhang       for (i=0; i<nsplit; i++) {
736e9422dd5SStefano Zampini         ierr  = MatCreateSubMatrix(pc->mat,ilink->is,ilink->is_col,scall,&jac->mat[i]);CHKERRQ(ierr);
737519d70e2SJed Brown         ilink = ilink->next;
738519d70e2SJed Brown       }
739519d70e2SJed Brown     }
740519d70e2SJed Brown   } else {
741519d70e2SJed Brown     jac->mat = jac->pmat;
742519d70e2SJed Brown   }
74397bbdb24SBarry Smith 
74453935eafSBarry Smith   /* Check for null space attached to IS */
74553935eafSBarry Smith   ilink = jac->head;
74653935eafSBarry Smith   for (i=0; i<nsplit; i++) {
74753935eafSBarry Smith     MatNullSpace sp;
74853935eafSBarry Smith 
74953935eafSBarry Smith     ierr = PetscObjectQuery((PetscObject) ilink->is, "nullspace", (PetscObject*) &sp);CHKERRQ(ierr);
75053935eafSBarry Smith     if (sp) {
75153935eafSBarry Smith       ierr = MatSetNullSpace(jac->mat[i], sp);CHKERRQ(ierr);
75253935eafSBarry Smith     }
75353935eafSBarry Smith     ilink = ilink->next;
75453935eafSBarry Smith   }
75553935eafSBarry Smith 
756a51937d4SCarola Kruse   if (jac->type != PC_COMPOSITE_ADDITIVE  && jac->type != PC_COMPOSITE_SCHUR && jac->type != PC_COMPOSITE_GKB) {
75768dd23aaSBarry Smith     /* extract the rows of the matrix associated with each field: used for efficient computation of residual inside algorithm */
7584e39094bSDmitry Karpeev     /* FIXME: Can/should we reuse jac->mat whenever (jac->diag_use_amat) is true? */
75968dd23aaSBarry Smith     ilink = jac->head;
760e52d2c62SBarry Smith     if (nsplit == 2 && jac->type == PC_COMPOSITE_MULTIPLICATIVE) {
761e52d2c62SBarry 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 */
762e52d2c62SBarry Smith       if (!jac->Afield) {
763e52d2c62SBarry Smith         ierr = PetscCalloc1(nsplit,&jac->Afield);CHKERRQ(ierr);
76480c96bb1SFande Kong         if (jac->offdiag_use_amat) {
7657dae84e0SHong Zhang           ierr = MatCreateSubMatrix(pc->mat,ilink->next->is,ilink->is,MAT_INITIAL_MATRIX,&jac->Afield[1]);CHKERRQ(ierr);
766e52d2c62SBarry Smith         } else {
7677dae84e0SHong Zhang           ierr = MatCreateSubMatrix(pc->pmat,ilink->next->is,ilink->is,MAT_INITIAL_MATRIX,&jac->Afield[1]);CHKERRQ(ierr);
76880c96bb1SFande Kong         }
76980c96bb1SFande Kong       } else {
770ef7efd37SHong Zhang         MatReuse scall;
771e9422dd5SStefano Zampini 
772ef7efd37SHong Zhang         if (pc->flag == DIFFERENT_NONZERO_PATTERN) {
773ef7efd37SHong Zhang           ierr  = MatDestroy(&jac->Afield[1]);CHKERRQ(ierr);
774ef7efd37SHong Zhang           scall = MAT_INITIAL_MATRIX;
775ef7efd37SHong Zhang         } else scall = MAT_REUSE_MATRIX;
776ef7efd37SHong Zhang 
77780c96bb1SFande Kong         if (jac->offdiag_use_amat) {
778ef7efd37SHong Zhang           ierr = MatCreateSubMatrix(pc->mat,ilink->next->is,ilink->is,scall,&jac->Afield[1]);CHKERRQ(ierr);
77980c96bb1SFande Kong         } else {
780ef7efd37SHong Zhang           ierr = MatCreateSubMatrix(pc->pmat,ilink->next->is,ilink->is,scall,&jac->Afield[1]);CHKERRQ(ierr);
78180c96bb1SFande Kong         }
782e52d2c62SBarry Smith       }
783e52d2c62SBarry Smith     } else {
78468dd23aaSBarry Smith       if (!jac->Afield) {
785785e854fSJed Brown         ierr = PetscMalloc1(nsplit,&jac->Afield);CHKERRQ(ierr);
78668dd23aaSBarry Smith         for (i=0; i<nsplit; i++) {
78780c96bb1SFande Kong           if (jac->offdiag_use_amat) {
7887dae84e0SHong Zhang             ierr = MatCreateSubMatrix(pc->mat,ilink->is,NULL,MAT_INITIAL_MATRIX,&jac->Afield[i]);CHKERRQ(ierr);
78980c96bb1SFande Kong           } else {
7907dae84e0SHong Zhang             ierr = MatCreateSubMatrix(pc->pmat,ilink->is,NULL,MAT_INITIAL_MATRIX,&jac->Afield[i]);CHKERRQ(ierr);
79180c96bb1SFande Kong           }
79268dd23aaSBarry Smith           ilink = ilink->next;
79368dd23aaSBarry Smith         }
79468dd23aaSBarry Smith       } else {
795ef7efd37SHong Zhang         MatReuse scall;
796ef7efd37SHong Zhang         if (pc->flag == DIFFERENT_NONZERO_PATTERN) {
797ef7efd37SHong Zhang           for (i=0; i<nsplit; i++) {
798ef7efd37SHong Zhang             ierr = MatDestroy(&jac->Afield[i]);CHKERRQ(ierr);
799ef7efd37SHong Zhang           }
800ef7efd37SHong Zhang           scall = MAT_INITIAL_MATRIX;
801ef7efd37SHong Zhang         } else scall = MAT_REUSE_MATRIX;
802ef7efd37SHong Zhang 
80368dd23aaSBarry Smith         for (i=0; i<nsplit; i++) {
80480c96bb1SFande Kong           if (jac->offdiag_use_amat) {
805ef7efd37SHong Zhang             ierr = MatCreateSubMatrix(pc->mat,ilink->is,NULL,scall,&jac->Afield[i]);CHKERRQ(ierr);
80680c96bb1SFande Kong           } else {
807ef7efd37SHong Zhang             ierr = MatCreateSubMatrix(pc->pmat,ilink->is,NULL,scall,&jac->Afield[i]);CHKERRQ(ierr);
80880c96bb1SFande Kong           }
80968dd23aaSBarry Smith           ilink = ilink->next;
81068dd23aaSBarry Smith         }
81168dd23aaSBarry Smith       }
81268dd23aaSBarry Smith     }
813e52d2c62SBarry Smith   }
81468dd23aaSBarry Smith 
8153b224e63SBarry Smith   if (jac->type == PC_COMPOSITE_SCHUR) {
8163b224e63SBarry Smith     IS          ccis;
817c096484dSStefano Zampini     PetscBool   isspd;
8184aa3045dSJed Brown     PetscInt    rstart,rend;
819093c86ffSJed Brown     char        lscname[256];
820093c86ffSJed Brown     PetscObject LSC_L;
821ce94432eSBarry Smith 
822ce94432eSBarry Smith     if (nsplit != 2) SETERRQ(PetscObjectComm((PetscObject)pc),PETSC_ERR_ARG_INCOMP,"To use Schur complement preconditioner you must have exactly 2 fields");
82368dd23aaSBarry Smith 
824c096484dSStefano Zampini     /* If pc->mat is SPD, don't scale by -1 the Schur complement */
825c096484dSStefano Zampini     if (jac->schurscale == (PetscScalar)-1.0) {
826c096484dSStefano Zampini       ierr = MatGetOption(pc->pmat,MAT_SPD,&isspd);CHKERRQ(ierr);
827c096484dSStefano Zampini       jac->schurscale = (isspd == PETSC_TRUE) ? 1.0 : -1.0;
828c096484dSStefano Zampini     }
829c096484dSStefano Zampini 
830e6cab6aaSJed Brown     /* When extracting off-diagonal submatrices, we take complements from this range */
831e6cab6aaSJed Brown     ierr = MatGetOwnershipRangeColumn(pc->mat,&rstart,&rend);CHKERRQ(ierr);
832e6cab6aaSJed Brown 
8333b224e63SBarry Smith     if (jac->schur) {
8340298fd71SBarry Smith       KSP      kspA = jac->head->ksp, kspInner = NULL, kspUpper = jac->kspupper;
835e9422dd5SStefano Zampini       MatReuse scall;
836e9422dd5SStefano Zampini 
837e9422dd5SStefano Zampini       if (pc->flag == DIFFERENT_NONZERO_PATTERN) {
838e9422dd5SStefano Zampini         scall = MAT_INITIAL_MATRIX;
839e9422dd5SStefano Zampini         ierr  = MatDestroy(&jac->B);CHKERRQ(ierr);
840e9422dd5SStefano Zampini         ierr  = MatDestroy(&jac->C);CHKERRQ(ierr);
841e9422dd5SStefano Zampini       } else scall = MAT_REUSE_MATRIX;
842443836d0SMatthew G Knepley 
843fb3147dbSMatthew G Knepley       ierr  = MatSchurComplementGetKSP(jac->schur, &kspInner);CHKERRQ(ierr);
8443b224e63SBarry Smith       ilink = jac->head;
84549bb4cd7SJungho Lee       ierr  = ISComplement(ilink->is_col,rstart,rend,&ccis);CHKERRQ(ierr);
8464e39094bSDmitry Karpeev       if (jac->offdiag_use_amat) {
847e9422dd5SStefano Zampini         ierr = MatCreateSubMatrix(pc->mat,ilink->is,ccis,scall,&jac->B);CHKERRQ(ierr);
848c84da90fSDmitry Karpeev       } else {
849e9422dd5SStefano Zampini         ierr = MatCreateSubMatrix(pc->pmat,ilink->is,ccis,scall,&jac->B);CHKERRQ(ierr);
850c84da90fSDmitry Karpeev       }
851fcfd50ebSBarry Smith       ierr  = ISDestroy(&ccis);CHKERRQ(ierr);
8523b224e63SBarry Smith       ilink = ilink->next;
85349bb4cd7SJungho Lee       ierr  = ISComplement(ilink->is_col,rstart,rend,&ccis);CHKERRQ(ierr);
8544e39094bSDmitry Karpeev       if (jac->offdiag_use_amat) {
855e9422dd5SStefano Zampini         ierr = MatCreateSubMatrix(pc->mat,ilink->is,ccis,scall,&jac->C);CHKERRQ(ierr);
856c84da90fSDmitry Karpeev       } else {
857e9422dd5SStefano Zampini         ierr = MatCreateSubMatrix(pc->pmat,ilink->is,ccis,scall,&jac->C);CHKERRQ(ierr);
858c84da90fSDmitry Karpeev       }
859fcfd50ebSBarry Smith       ierr  = ISDestroy(&ccis);CHKERRQ(ierr);
860aa6c7ce3SBarry Smith       ierr  = MatSchurComplementUpdateSubMatrices(jac->schur,jac->mat[0],jac->pmat[0],jac->B,jac->C,jac->mat[1]);CHKERRQ(ierr);
861a7476a74SDmitry Karpeev       if (jac->schurpre == PC_FIELDSPLIT_SCHUR_PRE_SELFP) {
862a7476a74SDmitry Karpeev         ierr = MatDestroy(&jac->schurp);CHKERRQ(ierr);
863a7476a74SDmitry Karpeev         ierr = MatSchurComplementGetPmat(jac->schur,MAT_INITIAL_MATRIX,&jac->schurp);CHKERRQ(ierr);
864a7476a74SDmitry Karpeev       }
865443836d0SMatthew G Knepley       if (kspA != kspInner) {
86623ee1639SBarry Smith         ierr = KSPSetOperators(kspA,jac->mat[0],jac->pmat[0]);CHKERRQ(ierr);
867443836d0SMatthew G Knepley       }
868443836d0SMatthew G Knepley       if (kspUpper != kspA) {
86923ee1639SBarry Smith         ierr = KSPSetOperators(kspUpper,jac->mat[0],jac->pmat[0]);CHKERRQ(ierr);
870443836d0SMatthew G Knepley       }
87123ee1639SBarry Smith       ierr = KSPSetOperators(jac->kspschur,jac->schur,FieldSplitSchurPre(jac));CHKERRQ(ierr);
8723b224e63SBarry Smith     } else {
873bafc1b83SMatthew G Knepley       const char   *Dprefix;
874470b340bSDmitry Karpeev       char         schurprefix[256], schurmatprefix[256];
875514bf10dSMatthew G Knepley       char         schurtestoption[256];
876bdddcaaaSMatthew G Knepley       MatNullSpace sp;
877514bf10dSMatthew G Knepley       PetscBool    flg;
878686bed4dSStefano Zampini       KSP          kspt;
8793b224e63SBarry Smith 
880a04f6461SBarry Smith       /* extract the A01 and A10 matrices */
8813b224e63SBarry Smith       ilink = jac->head;
88249bb4cd7SJungho Lee       ierr  = ISComplement(ilink->is_col,rstart,rend,&ccis);CHKERRQ(ierr);
8834e39094bSDmitry Karpeev       if (jac->offdiag_use_amat) {
8847dae84e0SHong Zhang         ierr = MatCreateSubMatrix(pc->mat,ilink->is,ccis,MAT_INITIAL_MATRIX,&jac->B);CHKERRQ(ierr);
885c84da90fSDmitry Karpeev       } else {
8867dae84e0SHong Zhang         ierr = MatCreateSubMatrix(pc->pmat,ilink->is,ccis,MAT_INITIAL_MATRIX,&jac->B);CHKERRQ(ierr);
887c84da90fSDmitry Karpeev       }
888fcfd50ebSBarry Smith       ierr  = ISDestroy(&ccis);CHKERRQ(ierr);
8893b224e63SBarry Smith       ilink = ilink->next;
89049bb4cd7SJungho Lee       ierr  = ISComplement(ilink->is_col,rstart,rend,&ccis);CHKERRQ(ierr);
8914e39094bSDmitry Karpeev       if (jac->offdiag_use_amat) {
8927dae84e0SHong Zhang         ierr = MatCreateSubMatrix(pc->mat,ilink->is,ccis,MAT_INITIAL_MATRIX,&jac->C);CHKERRQ(ierr);
893c84da90fSDmitry Karpeev       } else {
8947dae84e0SHong Zhang         ierr = MatCreateSubMatrix(pc->pmat,ilink->is,ccis,MAT_INITIAL_MATRIX,&jac->C);CHKERRQ(ierr);
895c84da90fSDmitry Karpeev       }
896fcfd50ebSBarry Smith       ierr = ISDestroy(&ccis);CHKERRQ(ierr);
89720252d06SBarry Smith 
898f5236f50SJed Brown       /* Use mat[0] (diagonal block of Amat) preconditioned by pmat[0] to define Schur complement */
89920252d06SBarry Smith       ierr = MatCreate(((PetscObject)jac->mat[0])->comm,&jac->schur);CHKERRQ(ierr);
90020252d06SBarry Smith       ierr = MatSetType(jac->schur,MATSCHURCOMPLEMENT);CHKERRQ(ierr);
901bee83525SDmitry Karpeev       ierr = MatSchurComplementSetSubMatrices(jac->schur,jac->mat[0],jac->pmat[0],jac->B,jac->C,jac->mat[1]);CHKERRQ(ierr);
902470b340bSDmitry Karpeev       ierr = PetscSNPrintf(schurmatprefix, sizeof(schurmatprefix), "%sfieldsplit_%s_", ((PetscObject)pc)->prefix ? ((PetscObject)pc)->prefix : "", ilink->splitname);CHKERRQ(ierr);
903470b340bSDmitry Karpeev       ierr = MatSetOptionsPrefix(jac->schur,schurmatprefix);CHKERRQ(ierr);
904686bed4dSStefano Zampini       ierr = MatSchurComplementGetKSP(jac->schur,&kspt);CHKERRQ(ierr);
905686bed4dSStefano Zampini       ierr = KSPSetOptionsPrefix(kspt,schurmatprefix);CHKERRQ(ierr);
906686bed4dSStefano Zampini 
907686bed4dSStefano Zampini       /* Note: this is not true in general */
908895c21f2SBarry Smith       ierr = MatGetNullSpace(jac->mat[1], &sp);CHKERRQ(ierr);
90920252d06SBarry Smith       if (sp) {
91020252d06SBarry Smith         ierr = MatSetNullSpace(jac->schur, sp);CHKERRQ(ierr);
91120252d06SBarry Smith       }
91220252d06SBarry Smith 
91320252d06SBarry Smith       ierr = PetscSNPrintf(schurtestoption, sizeof(schurtestoption), "-fieldsplit_%s_inner_", ilink->splitname);CHKERRQ(ierr);
914c5929fdfSBarry Smith       ierr = PetscOptionsFindPairPrefix_Private(((PetscObject)pc)->options,((PetscObject)pc)->prefix, schurtestoption, NULL, &flg);CHKERRQ(ierr);
915514bf10dSMatthew G Knepley       if (flg) {
916514bf10dSMatthew G Knepley         DM  dmInner;
91721635b76SJed Brown         KSP kspInner;
918686bed4dSStefano Zampini         PC  pcInner;
91921635b76SJed Brown 
92021635b76SJed Brown         ierr = MatSchurComplementGetKSP(jac->schur, &kspInner);CHKERRQ(ierr);
9212cc093acSMatthew G. Knepley         ierr = KSPReset(kspInner);CHKERRQ(ierr);
9222cc093acSMatthew G. Knepley         ierr = KSPSetOperators(kspInner,jac->mat[0],jac->pmat[0]);CHKERRQ(ierr);
92321635b76SJed Brown         ierr = PetscSNPrintf(schurprefix, sizeof(schurprefix), "%sfieldsplit_%s_inner_", ((PetscObject)pc)->prefix ? ((PetscObject)pc)->prefix : "", ilink->splitname);CHKERRQ(ierr);
92421635b76SJed Brown         /* Indent this deeper to emphasize the "inner" nature of this solver. */
92521635b76SJed Brown         ierr = PetscObjectIncrementTabLevel((PetscObject)kspInner, (PetscObject) pc, 2);CHKERRQ(ierr);
9262cc093acSMatthew G. Knepley         ierr = PetscObjectIncrementTabLevel((PetscObject)kspInner->pc, (PetscObject) pc, 2);CHKERRQ(ierr);
92721635b76SJed Brown         ierr = KSPSetOptionsPrefix(kspInner, schurprefix);CHKERRQ(ierr);
928514bf10dSMatthew G Knepley 
929514bf10dSMatthew G Knepley         /* Set DM for new solver */
930bafc1b83SMatthew G Knepley         ierr = KSPGetDM(jac->head->ksp, &dmInner);CHKERRQ(ierr);
93121635b76SJed Brown         ierr = KSPSetDM(kspInner, dmInner);CHKERRQ(ierr);
93221635b76SJed Brown         ierr = KSPSetDMActive(kspInner, PETSC_FALSE);CHKERRQ(ierr);
933686bed4dSStefano Zampini 
934686bed4dSStefano Zampini         /* Defaults to PCKSP as preconditioner */
935686bed4dSStefano Zampini         ierr = KSPGetPC(kspInner, &pcInner);CHKERRQ(ierr);
936686bed4dSStefano Zampini         ierr = PCSetType(pcInner, PCKSP);CHKERRQ(ierr);
937686bed4dSStefano Zampini         ierr = PCKSPSetKSP(pcInner, jac->head->ksp);CHKERRQ(ierr);
938514bf10dSMatthew G Knepley       } else {
93921635b76SJed Brown          /* Use the outer solver for the inner solve, but revert the KSPPREONLY from PCFieldSplitSetFields_FieldSplit or
94021635b76SJed Brown           * PCFieldSplitSetIS_FieldSplit. We don't want KSPPREONLY because it makes the Schur complement inexact,
94121635b76SJed Brown           * preventing Schur complement reduction to be an accurate solve. Usually when an iterative solver is used for
94221635b76SJed 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
94321635b76SJed Brown           * GMRES the default. Note that it is also common to use PREONLY for S, in which case S may not be used
94421635b76SJed Brown           * directly, and the user is responsible for setting an inexact method for fieldsplit's A^{-1}. */
94521635b76SJed Brown         ierr = KSPSetType(jac->head->ksp,KSPGMRES);CHKERRQ(ierr);
946514bf10dSMatthew G Knepley         ierr = MatSchurComplementSetKSP(jac->schur,jac->head->ksp);CHKERRQ(ierr);
947bafc1b83SMatthew G Knepley       }
94823ee1639SBarry Smith       ierr = KSPSetOperators(jac->head->ksp,jac->mat[0],jac->pmat[0]);CHKERRQ(ierr);
9495a9f2f41SSatish Balay       ierr = KSPSetFromOptions(jac->head->ksp);CHKERRQ(ierr);
95097bbdb24SBarry Smith       ierr = MatSetFromOptions(jac->schur);CHKERRQ(ierr);
95197bbdb24SBarry Smith 
952686bed4dSStefano Zampini       ierr = PetscObjectTypeCompare((PetscObject)jac->schur, MATSCHURCOMPLEMENT, &flg);CHKERRQ(ierr);
953686bed4dSStefano Zampini       if (flg) { /* Need to do this otherwise PCSetUp_KSP will overwrite the amat of jac->head->ksp */
954686bed4dSStefano Zampini         KSP kspInner;
955686bed4dSStefano Zampini         PC  pcInner;
956686bed4dSStefano Zampini 
957686bed4dSStefano Zampini         ierr = MatSchurComplementGetKSP(jac->schur, &kspInner);CHKERRQ(ierr);
958686bed4dSStefano Zampini         ierr = KSPGetPC(kspInner, &pcInner);CHKERRQ(ierr);
959686bed4dSStefano Zampini         ierr = PetscObjectTypeCompare((PetscObject)pcInner, PCKSP, &flg);CHKERRQ(ierr);
960686bed4dSStefano Zampini         if (flg) {
961686bed4dSStefano Zampini           KSP ksp;
962686bed4dSStefano Zampini 
963686bed4dSStefano Zampini           ierr = PCKSPGetKSP(pcInner, &ksp);CHKERRQ(ierr);
964686bed4dSStefano Zampini           if (ksp == jac->head->ksp) {
965686bed4dSStefano Zampini             ierr = PCSetUseAmat(pcInner, PETSC_TRUE);CHKERRQ(ierr);
966686bed4dSStefano Zampini           }
967686bed4dSStefano Zampini         }
968686bed4dSStefano Zampini       }
969443836d0SMatthew G Knepley       ierr = PetscSNPrintf(schurtestoption, sizeof(schurtestoption), "-fieldsplit_%s_upper_", ilink->splitname);CHKERRQ(ierr);
970c5929fdfSBarry Smith       ierr = PetscOptionsFindPairPrefix_Private(((PetscObject)pc)->options,((PetscObject)pc)->prefix, schurtestoption, NULL, &flg);CHKERRQ(ierr);
971443836d0SMatthew G Knepley       if (flg) {
972443836d0SMatthew G Knepley         DM dmInner;
973443836d0SMatthew G Knepley 
974443836d0SMatthew G Knepley         ierr = PetscSNPrintf(schurprefix, sizeof(schurprefix), "%sfieldsplit_%s_upper_", ((PetscObject)pc)->prefix ? ((PetscObject)pc)->prefix : "", ilink->splitname);CHKERRQ(ierr);
97582f516ccSBarry Smith         ierr = KSPCreate(PetscObjectComm((PetscObject)pc), &jac->kspupper);CHKERRQ(ierr);
976422a814eSBarry Smith         ierr = KSPSetErrorIfNotConverged(jac->kspupper,pc->erroriffailure);CHKERRQ(ierr);
977443836d0SMatthew G Knepley         ierr = KSPSetOptionsPrefix(jac->kspupper, schurprefix);CHKERRQ(ierr);
9782cc093acSMatthew G. Knepley         ierr = PetscObjectIncrementTabLevel((PetscObject)jac->kspupper, (PetscObject) pc, 1);CHKERRQ(ierr);
9792cc093acSMatthew G. Knepley         ierr = PetscObjectIncrementTabLevel((PetscObject)jac->kspupper->pc, (PetscObject) pc, 1);CHKERRQ(ierr);
980443836d0SMatthew G Knepley         ierr = KSPGetDM(jac->head->ksp, &dmInner);CHKERRQ(ierr);
981443836d0SMatthew G Knepley         ierr = KSPSetDM(jac->kspupper, dmInner);CHKERRQ(ierr);
982443836d0SMatthew G Knepley         ierr = KSPSetDMActive(jac->kspupper, PETSC_FALSE);CHKERRQ(ierr);
983443836d0SMatthew G Knepley         ierr = KSPSetFromOptions(jac->kspupper);CHKERRQ(ierr);
98423ee1639SBarry Smith         ierr = KSPSetOperators(jac->kspupper,jac->mat[0],jac->pmat[0]);CHKERRQ(ierr);
985443836d0SMatthew G Knepley         ierr = VecDuplicate(jac->head->x, &jac->head->z);CHKERRQ(ierr);
986443836d0SMatthew G Knepley       } else {
987443836d0SMatthew G Knepley         jac->kspupper = jac->head->ksp;
988443836d0SMatthew G Knepley         ierr          = PetscObjectReference((PetscObject) jac->head->ksp);CHKERRQ(ierr);
989443836d0SMatthew G Knepley       }
990443836d0SMatthew G Knepley 
991a7476a74SDmitry Karpeev       if (jac->schurpre == PC_FIELDSPLIT_SCHUR_PRE_SELFP) {
992a7476a74SDmitry Karpeev         ierr = MatSchurComplementGetPmat(jac->schur,MAT_INITIAL_MATRIX,&jac->schurp);CHKERRQ(ierr);
993a7476a74SDmitry Karpeev       }
994ce94432eSBarry Smith       ierr = KSPCreate(PetscObjectComm((PetscObject)pc),&jac->kspschur);CHKERRQ(ierr);
995422a814eSBarry Smith       ierr = KSPSetErrorIfNotConverged(jac->kspschur,pc->erroriffailure);CHKERRQ(ierr);
99697bbdb24SBarry Smith       ierr = PetscLogObjectParent((PetscObject)pc,(PetscObject)jac->kspschur);CHKERRQ(ierr);
99720252d06SBarry Smith       ierr = PetscObjectIncrementTabLevel((PetscObject)jac->kspschur,(PetscObject)pc,1);CHKERRQ(ierr);
99897bbdb24SBarry Smith       if (jac->schurpre == PC_FIELDSPLIT_SCHUR_PRE_SELF) {
9997233a360SDmitry Karpeev         PC pcschur;
10007233a360SDmitry Karpeev         ierr = KSPGetPC(jac->kspschur,&pcschur);CHKERRQ(ierr);
10017233a360SDmitry Karpeev         ierr = PCSetType(pcschur,PCNONE);CHKERRQ(ierr);
100297bbdb24SBarry Smith         /* Note: This is bad if there exist preconditioners for MATSCHURCOMPLEMENT */
1003e74569cdSMatthew G. Knepley       } else if (jac->schurpre == PC_FIELDSPLIT_SCHUR_PRE_FULL) {
1004e74569cdSMatthew G. Knepley         ierr = MatSchurComplementComputeExplicitOperator(jac->schur, &jac->schur_user);CHKERRQ(ierr);
100597bbdb24SBarry Smith       }
100623ee1639SBarry Smith       ierr = KSPSetOperators(jac->kspschur,jac->schur,FieldSplitSchurPre(jac));CHKERRQ(ierr);
100797bbdb24SBarry Smith       ierr = KSPGetOptionsPrefix(jac->head->next->ksp, &Dprefix);CHKERRQ(ierr);
100897bbdb24SBarry Smith       ierr = KSPSetOptionsPrefix(jac->kspschur,         Dprefix);CHKERRQ(ierr);
1009c096484dSStefano Zampini       /* propagate DM */
1010b20b4189SMatthew G. Knepley       {
1011b20b4189SMatthew G. Knepley         DM sdm;
1012b20b4189SMatthew G. Knepley         ierr = KSPGetDM(jac->head->next->ksp, &sdm);CHKERRQ(ierr);
1013b20b4189SMatthew G. Knepley         if (sdm) {
1014b20b4189SMatthew G. Knepley           ierr = KSPSetDM(jac->kspschur, sdm);CHKERRQ(ierr);
1015b20b4189SMatthew G. Knepley           ierr = KSPSetDMActive(jac->kspschur, PETSC_FALSE);CHKERRQ(ierr);
1016b20b4189SMatthew G. Knepley         }
1017b20b4189SMatthew G. Knepley       }
101897bbdb24SBarry Smith       /* really want setfromoptions called in PCSetFromOptions_FieldSplit(), but it is not ready yet */
101997bbdb24SBarry Smith       /* need to call this every time, since the jac->kspschur is freshly created, otherwise its options never get set */
102097bbdb24SBarry Smith       ierr = KSPSetFromOptions(jac->kspschur);CHKERRQ(ierr);
102197bbdb24SBarry Smith     }
1022686bed4dSStefano Zampini     ierr = MatAssemblyBegin(jac->schur,MAT_FINAL_ASSEMBLY);CHKERRQ(ierr);
1023686bed4dSStefano Zampini     ierr = MatAssemblyEnd(jac->schur,MAT_FINAL_ASSEMBLY);CHKERRQ(ierr);
102497bbdb24SBarry Smith 
10255a9f2f41SSatish Balay     /* HACK: special support to forward L and Lp matrices that might be used by PCLSC */
10268caf3d72SBarry Smith     ierr = PetscSNPrintf(lscname,sizeof(lscname),"%s_LSC_L",ilink->splitname);CHKERRQ(ierr);
1027519d70e2SJed Brown     ierr = PetscObjectQuery((PetscObject)pc->mat,lscname,(PetscObject*)&LSC_L);CHKERRQ(ierr);
10283b224e63SBarry Smith     if (!LSC_L) {ierr = PetscObjectQuery((PetscObject)pc->pmat,lscname,(PetscObject*)&LSC_L);CHKERRQ(ierr);}
1029c1570756SJed Brown     if (LSC_L) {ierr = PetscObjectCompose((PetscObject)jac->schur,"LSC_L",(PetscObject)LSC_L);CHKERRQ(ierr);}
10308caf3d72SBarry Smith     ierr = PetscSNPrintf(lscname,sizeof(lscname),"%s_LSC_Lp",ilink->splitname);CHKERRQ(ierr);
103197bbdb24SBarry Smith     ierr = PetscObjectQuery((PetscObject)pc->pmat,lscname,(PetscObject*)&LSC_L);CHKERRQ(ierr);
10325a9f2f41SSatish Balay     if (!LSC_L) {ierr = PetscObjectQuery((PetscObject)pc->mat,lscname,(PetscObject*)&LSC_L);CHKERRQ(ierr);}
10330971522cSBarry Smith     if (LSC_L) {ierr = PetscObjectCompose((PetscObject)jac->schur,"LSC_Lp",(PetscObject)LSC_L);CHKERRQ(ierr);}
1034a51937d4SCarola Kruse   } else if (jac->type == PC_COMPOSITE_GKB) {
1035a51937d4SCarola Kruse     IS          ccis;
1036a51937d4SCarola Kruse     PetscInt    rstart,rend;
1037a51937d4SCarola Kruse 
1038a51937d4SCarola Kruse     if (nsplit != 2) SETERRQ(PetscObjectComm((PetscObject)pc),PETSC_ERR_ARG_INCOMP,"To use GKB preconditioner you must have exactly 2 fields");
1039a51937d4SCarola Kruse 
1040a51937d4SCarola Kruse     ilink = jac->head;
1041a51937d4SCarola Kruse 
1042a51937d4SCarola Kruse     /* When extracting off-diagonal submatrices, we take complements from this range */
1043a51937d4SCarola Kruse     ierr = MatGetOwnershipRangeColumn(pc->mat,&rstart,&rend);CHKERRQ(ierr);
1044a51937d4SCarola Kruse 
1045a51937d4SCarola Kruse     ierr = ISComplement(ilink->is_col,rstart,rend,&ccis);CHKERRQ(ierr);
1046a51937d4SCarola Kruse     if (jac->offdiag_use_amat) {
1047a51937d4SCarola Kruse       ierr = MatCreateSubMatrix(pc->mat,ilink->is,ccis,MAT_INITIAL_MATRIX,&jac->B);CHKERRQ(ierr);
1048a51937d4SCarola Kruse     } else {
1049a51937d4SCarola Kruse       ierr = MatCreateSubMatrix(pc->pmat,ilink->is,ccis,MAT_INITIAL_MATRIX,&jac->B);CHKERRQ(ierr);
1050a51937d4SCarola Kruse     }
1051a51937d4SCarola Kruse     ierr  = ISDestroy(&ccis);CHKERRQ(ierr);
1052e071a0a4SCarola Kruse     /* Create work vectors for GKB algorithm */
1053e071a0a4SCarola Kruse     ierr  = VecDuplicate(ilink->x,&jac->u);CHKERRQ(ierr);
1054e071a0a4SCarola Kruse     ierr  = VecDuplicate(ilink->x,&jac->Hu);CHKERRQ(ierr);
1055e071a0a4SCarola Kruse     ierr  = VecDuplicate(ilink->x,&jac->w2);CHKERRQ(ierr);
1056a51937d4SCarola Kruse     ilink = ilink->next;
1057a51937d4SCarola Kruse     ierr  = ISComplement(ilink->is_col,rstart,rend,&ccis);CHKERRQ(ierr);
1058a51937d4SCarola Kruse     if (jac->offdiag_use_amat) {
1059a51937d4SCarola Kruse       ierr = MatCreateSubMatrix(pc->mat,ilink->is,ccis,MAT_INITIAL_MATRIX,&jac->C);CHKERRQ(ierr);
1060a51937d4SCarola Kruse     } else {
1061a51937d4SCarola Kruse       ierr = MatCreateSubMatrix(pc->pmat,ilink->is,ccis,MAT_INITIAL_MATRIX,&jac->C);CHKERRQ(ierr);
1062a51937d4SCarola Kruse     }
1063a51937d4SCarola Kruse     ierr = ISDestroy(&ccis);CHKERRQ(ierr);
1064e071a0a4SCarola Kruse     /* Create work vectors for GKB algorithm */
1065e071a0a4SCarola Kruse     ierr = VecDuplicate(ilink->x,&jac->v);CHKERRQ(ierr);
1066e071a0a4SCarola Kruse     ierr = VecDuplicate(ilink->x,&jac->d);CHKERRQ(ierr);
1067e071a0a4SCarola Kruse     ierr = VecDuplicate(ilink->x,&jac->w1);CHKERRQ(ierr);
1068a51937d4SCarola Kruse     ierr = MatGolubKahanComputeExplicitOperator(jac->mat[0],jac->B,jac->C,&jac->H,jac->gkbnu);CHKERRQ(ierr);
1069e071a0a4SCarola Kruse     ierr = PetscCalloc1(jac->gkbdelay,&jac->vecz);CHKERRQ(ierr);
1070e071a0a4SCarola Kruse 
1071a51937d4SCarola Kruse     ilink = jac->head;
1072a51937d4SCarola Kruse     ierr  = KSPSetOperators(ilink->ksp,jac->H,jac->H);CHKERRQ(ierr);
1073a51937d4SCarola Kruse     if (!jac->suboptionsset) {ierr = KSPSetFromOptions(ilink->ksp);CHKERRQ(ierr);}
1074e071a0a4SCarola Kruse     /* Create gkb_monitor context */
1075de482cd7SCarola Kruse     if (jac->gkbmonitor) {
1076de482cd7SCarola Kruse       PetscInt  tablevel;
1077de482cd7SCarola Kruse       ierr = PetscViewerCreate(PETSC_COMM_WORLD,&jac->gkbviewer);CHKERRQ(ierr);
1078de482cd7SCarola Kruse       ierr = PetscViewerSetType(jac->gkbviewer,PETSCVIEWERASCII);CHKERRQ(ierr);
1079de482cd7SCarola Kruse       ierr = PetscObjectGetTabLevel((PetscObject)ilink->ksp,&tablevel);CHKERRQ(ierr);
1080e071a0a4SCarola Kruse       ierr = PetscViewerASCIISetTab(jac->gkbviewer,tablevel);CHKERRQ(ierr);
1081de482cd7SCarola Kruse       ierr = PetscObjectIncrementTabLevel((PetscObject)ilink->ksp,(PetscObject)ilink->ksp,1);CHKERRQ(ierr);
1082de482cd7SCarola Kruse     }
10830971522cSBarry Smith   } else {
108468bd789dSDmitry Karpeev     /* set up the individual splits' PCs */
10850971522cSBarry Smith     i     = 0;
10860971522cSBarry Smith     ilink = jac->head;
10870971522cSBarry Smith     while (ilink) {
108823ee1639SBarry Smith       ierr = KSPSetOperators(ilink->ksp,jac->mat[i],jac->pmat[i]);CHKERRQ(ierr);
10890971522cSBarry Smith       /* really want setfromoptions called in PCSetFromOptions_FieldSplit(), but it is not ready yet */
10900971522cSBarry Smith       if (!jac->suboptionsset) {ierr = KSPSetFromOptions(ilink->ksp);CHKERRQ(ierr);}
10910971522cSBarry Smith       i++;
10920971522cSBarry Smith       ilink = ilink->next;
10930971522cSBarry Smith     }
10943b224e63SBarry Smith   }
10953b224e63SBarry Smith 
1096c1570756SJed Brown   jac->suboptionsset = PETSC_TRUE;
10970971522cSBarry Smith   PetscFunctionReturn(0);
10980971522cSBarry Smith }
10990971522cSBarry Smith 
11005a9f2f41SSatish Balay #define FieldSplitSplitSolveAdd(ilink,xx,yy) \
1101ca9f406cSSatish Balay   (VecScatterBegin(ilink->sctx,xx,ilink->x,INSERT_VALUES,SCATTER_FORWARD) || \
1102ca9f406cSSatish Balay    VecScatterEnd(ilink->sctx,xx,ilink->x,INSERT_VALUES,SCATTER_FORWARD) || \
11039df09d43SBarry Smith    PetscLogEventBegin(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL) ||\
11045a9f2f41SSatish Balay    KSPSolve(ilink->ksp,ilink->x,ilink->y) ||                               \
1105c0decd05SBarry Smith    KSPCheckSolve(ilink->ksp,pc,ilink->y)  || \
11069df09d43SBarry Smith    PetscLogEventEnd(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL) ||\
1107ca9f406cSSatish Balay    VecScatterBegin(ilink->sctx,ilink->y,yy,ADD_VALUES,SCATTER_REVERSE) ||  \
1108ca9f406cSSatish Balay    VecScatterEnd(ilink->sctx,ilink->y,yy,ADD_VALUES,SCATTER_REVERSE))
110979416396SBarry Smith 
11103b224e63SBarry Smith static PetscErrorCode PCApply_FieldSplit_Schur(PC pc,Vec x,Vec y)
11113b224e63SBarry Smith {
11123b224e63SBarry Smith   PC_FieldSplit      *jac = (PC_FieldSplit*)pc->data;
11133b224e63SBarry Smith   PetscErrorCode     ierr;
11143b224e63SBarry Smith   PC_FieldSplitLink  ilinkA = jac->head, ilinkD = ilinkA->next;
1115443836d0SMatthew G Knepley   KSP                kspA   = ilinkA->ksp, kspLower = kspA, kspUpper = jac->kspupper;
11163b224e63SBarry Smith 
11173b224e63SBarry Smith   PetscFunctionBegin;
1118c5d2311dSJed Brown   switch (jac->schurfactorization) {
1119c9c6ffaaSJed Brown   case PC_FIELDSPLIT_SCHUR_FACT_DIAG:
1120a04f6461SBarry Smith     /* [A00 0; 0 -S], positive definite, suitable for MINRES */
1121c5d2311dSJed Brown     ierr = VecScatterBegin(ilinkA->sctx,x,ilinkA->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
1122c5d2311dSJed Brown     ierr = VecScatterBegin(ilinkD->sctx,x,ilinkD->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
1123c5d2311dSJed Brown     ierr = VecScatterEnd(ilinkA->sctx,x,ilinkA->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
11249df09d43SBarry Smith     ierr = PetscLogEventBegin(ilinkA->event,kspA,ilinkA->x,ilinkA->y,NULL);CHKERRQ(ierr);
1125443836d0SMatthew G Knepley     ierr = KSPSolve(kspA,ilinkA->x,ilinkA->y);CHKERRQ(ierr);
1126c0decd05SBarry Smith     ierr = KSPCheckSolve(kspA,pc,ilinkA->y);CHKERRQ(ierr);
11279df09d43SBarry Smith     ierr = PetscLogEventEnd(ilinkA->event,kspA,ilinkA->x,ilinkA->y,NULL);CHKERRQ(ierr);
1128c5d2311dSJed Brown     ierr = VecScatterBegin(ilinkA->sctx,ilinkA->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
1129c5d2311dSJed Brown     ierr = VecScatterEnd(ilinkD->sctx,x,ilinkD->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
11309df09d43SBarry Smith     ierr = PetscLogEventBegin(KSP_Solve_FS_S,jac->kspschur,ilinkD->x,ilinkD->y,NULL);CHKERRQ(ierr);
1131c5d2311dSJed Brown     ierr = KSPSolve(jac->kspschur,ilinkD->x,ilinkD->y);CHKERRQ(ierr);
1132c0decd05SBarry Smith     ierr = KSPCheckSolve(jac->kspschur,pc,ilinkD->y);CHKERRQ(ierr);
11339df09d43SBarry Smith     ierr = PetscLogEventEnd(KSP_Solve_FS_S,jac->kspschur,ilinkD->x,ilinkD->y,NULL);CHKERRQ(ierr);
1134c096484dSStefano Zampini     ierr = VecScale(ilinkD->y,jac->schurscale);CHKERRQ(ierr);
1135c5d2311dSJed Brown     ierr = VecScatterEnd(ilinkA->sctx,ilinkA->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
1136653b62c3SJunchao Zhang     ierr = VecScatterBegin(ilinkD->sctx,ilinkD->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
1137c5d2311dSJed Brown     ierr = VecScatterEnd(ilinkD->sctx,ilinkD->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
1138c5d2311dSJed Brown     break;
1139c9c6ffaaSJed Brown   case PC_FIELDSPLIT_SCHUR_FACT_LOWER:
1140a04f6461SBarry Smith     /* [A00 0; A10 S], suitable for left preconditioning */
1141c5d2311dSJed Brown     ierr = VecScatterBegin(ilinkA->sctx,x,ilinkA->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
1142c5d2311dSJed Brown     ierr = VecScatterEnd(ilinkA->sctx,x,ilinkA->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
11439df09d43SBarry Smith     ierr = PetscLogEventBegin(ilinkA->event,kspA,ilinkA->x,ilinkA->y,NULL);CHKERRQ(ierr);
1144443836d0SMatthew G Knepley     ierr = KSPSolve(kspA,ilinkA->x,ilinkA->y);CHKERRQ(ierr);
1145c0decd05SBarry Smith     ierr = KSPCheckSolve(kspA,pc,ilinkA->y);CHKERRQ(ierr);
11469df09d43SBarry Smith     ierr = PetscLogEventEnd(ilinkA->event,kspA,ilinkA->x,ilinkA->y,NULL);CHKERRQ(ierr);
1147c5d2311dSJed Brown     ierr = MatMult(jac->C,ilinkA->y,ilinkD->x);CHKERRQ(ierr);
1148c5d2311dSJed Brown     ierr = VecScale(ilinkD->x,-1.);CHKERRQ(ierr);
1149c5d2311dSJed Brown     ierr = VecScatterBegin(ilinkD->sctx,x,ilinkD->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
1150c5d2311dSJed Brown     ierr = VecScatterBegin(ilinkA->sctx,ilinkA->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
1151c5d2311dSJed Brown     ierr = VecScatterEnd(ilinkD->sctx,x,ilinkD->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
11529df09d43SBarry Smith     ierr = PetscLogEventBegin(KSP_Solve_FS_S,jac->kspschur,ilinkD->x,ilinkD->y,NULL);CHKERRQ(ierr);
1153c5d2311dSJed Brown     ierr = KSPSolve(jac->kspschur,ilinkD->x,ilinkD->y);CHKERRQ(ierr);
1154c0decd05SBarry Smith     ierr = KSPCheckSolve(jac->kspschur,pc,ilinkD->y);CHKERRQ(ierr);
11559df09d43SBarry Smith     ierr = PetscLogEventEnd(KSP_Solve_FS_S,jac->kspschur,ilinkD->x,ilinkD->y,NULL);CHKERRQ(ierr);
1156c5d2311dSJed Brown     ierr = VecScatterEnd(ilinkA->sctx,ilinkA->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
1157653b62c3SJunchao Zhang     ierr = VecScatterBegin(ilinkD->sctx,ilinkD->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
1158c5d2311dSJed Brown     ierr = VecScatterEnd(ilinkD->sctx,ilinkD->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
1159c5d2311dSJed Brown     break;
1160c9c6ffaaSJed Brown   case PC_FIELDSPLIT_SCHUR_FACT_UPPER:
1161a04f6461SBarry Smith     /* [A00 A01; 0 S], suitable for right preconditioning */
1162c5d2311dSJed Brown     ierr = VecScatterBegin(ilinkD->sctx,x,ilinkD->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
1163c5d2311dSJed Brown     ierr = VecScatterEnd(ilinkD->sctx,x,ilinkD->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
11649df09d43SBarry Smith     ierr = PetscLogEventBegin(KSP_Solve_FS_S,jac->kspschur,ilinkD->x,ilinkD->y,NULL);CHKERRQ(ierr);
1165c5d2311dSJed Brown     ierr = KSPSolve(jac->kspschur,ilinkD->x,ilinkD->y);CHKERRQ(ierr);
1166c0decd05SBarry Smith     ierr = KSPCheckSolve(jac->kspschur,pc,ilinkD->y);CHKERRQ(ierr);
11679df09d43SBarry Smith     ierr = PetscLogEventEnd(KSP_Solve_FS_S,jac->kspschur,ilinkD->x,ilinkD->y,NULL);CHKERRQ(ierr);    ierr = MatMult(jac->B,ilinkD->y,ilinkA->x);CHKERRQ(ierr);
1168c5d2311dSJed Brown     ierr = VecScale(ilinkA->x,-1.);CHKERRQ(ierr);
1169c5d2311dSJed Brown     ierr = VecScatterBegin(ilinkA->sctx,x,ilinkA->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
1170c5d2311dSJed Brown     ierr = VecScatterBegin(ilinkD->sctx,ilinkD->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
1171c5d2311dSJed Brown     ierr = VecScatterEnd(ilinkA->sctx,x,ilinkA->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
11729df09d43SBarry Smith     ierr = PetscLogEventBegin(ilinkA->event,kspA,ilinkA->x,ilinkA->y,NULL);CHKERRQ(ierr);
1173443836d0SMatthew G Knepley     ierr = KSPSolve(kspA,ilinkA->x,ilinkA->y);CHKERRQ(ierr);
1174c0decd05SBarry Smith     ierr = KSPCheckSolve(kspA,pc,ilinkA->y);CHKERRQ(ierr);
11759df09d43SBarry Smith     ierr = PetscLogEventEnd(ilinkA->event,kspA,ilinkA->x,ilinkA->y,NULL);CHKERRQ(ierr);
1176c5d2311dSJed Brown     ierr = VecScatterEnd(ilinkD->sctx,ilinkD->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
1177653b62c3SJunchao Zhang     ierr = VecScatterBegin(ilinkA->sctx,ilinkA->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
1178c5d2311dSJed Brown     ierr = VecScatterEnd(ilinkA->sctx,ilinkA->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
1179c5d2311dSJed Brown     break;
1180c9c6ffaaSJed Brown   case PC_FIELDSPLIT_SCHUR_FACT_FULL:
1181c238f8cdSStefano Zampini     /* [1 0; A10 A00^{-1} 1] [A00 0; 0 S] [1 A00^{-1}A01; 0 1] */
11823b224e63SBarry Smith     ierr = VecScatterBegin(ilinkA->sctx,x,ilinkA->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
11833b224e63SBarry Smith     ierr = VecScatterEnd(ilinkA->sctx,x,ilinkA->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
11849df09d43SBarry Smith     ierr = PetscLogEventBegin(KSP_Solve_FS_L,kspLower,ilinkA->x,ilinkA->y,NULL);CHKERRQ(ierr);
1185443836d0SMatthew G Knepley     ierr = KSPSolve(kspLower,ilinkA->x,ilinkA->y);CHKERRQ(ierr);
1186c0decd05SBarry Smith     ierr = KSPCheckSolve(kspLower,pc,ilinkA->y);CHKERRQ(ierr);
11879df09d43SBarry Smith     ierr = PetscLogEventEnd(KSP_Solve_FS_L,kspLower,ilinkA->x,ilinkA->y,NULL);CHKERRQ(ierr);
11883b224e63SBarry Smith     ierr = MatMult(jac->C,ilinkA->y,ilinkD->x);CHKERRQ(ierr);
11893b224e63SBarry Smith     ierr = VecScale(ilinkD->x,-1.0);CHKERRQ(ierr);
11903b224e63SBarry Smith     ierr = VecScatterBegin(ilinkD->sctx,x,ilinkD->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
11913b224e63SBarry Smith     ierr = VecScatterEnd(ilinkD->sctx,x,ilinkD->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
11923b224e63SBarry Smith 
11939df09d43SBarry Smith     ierr = PetscLogEventBegin(KSP_Solve_FS_S,jac->kspschur,ilinkD->x,ilinkD->y,NULL);CHKERRQ(ierr);
11943b224e63SBarry Smith     ierr = KSPSolve(jac->kspschur,ilinkD->x,ilinkD->y);CHKERRQ(ierr);
1195c0decd05SBarry Smith     ierr = KSPCheckSolve(jac->kspschur,pc,ilinkD->y);CHKERRQ(ierr);
11969df09d43SBarry Smith     ierr = PetscLogEventEnd(KSP_Solve_FS_S,jac->kspschur,ilinkD->x,ilinkD->y,NULL);CHKERRQ(ierr);
11973b224e63SBarry Smith     ierr = VecScatterBegin(ilinkD->sctx,ilinkD->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
11983b224e63SBarry Smith 
1199443836d0SMatthew G Knepley     if (kspUpper == kspA) {
12003b224e63SBarry Smith       ierr = MatMult(jac->B,ilinkD->y,ilinkA->y);CHKERRQ(ierr);
12013b224e63SBarry Smith       ierr = VecAXPY(ilinkA->x,-1.0,ilinkA->y);CHKERRQ(ierr);
12029df09d43SBarry Smith       ierr = PetscLogEventBegin(ilinkA->event,kspA,ilinkA->x,ilinkA->y,NULL);CHKERRQ(ierr);
1203443836d0SMatthew G Knepley       ierr = KSPSolve(kspA,ilinkA->x,ilinkA->y);CHKERRQ(ierr);
1204c0decd05SBarry Smith       ierr = KSPCheckSolve(kspA,pc,ilinkA->y);CHKERRQ(ierr);
12059df09d43SBarry Smith       ierr = PetscLogEventEnd(ilinkA->event,kspA,ilinkA->x,ilinkA->y,NULL);CHKERRQ(ierr);
1206443836d0SMatthew G Knepley     } else {
12079df09d43SBarry Smith       ierr = PetscLogEventBegin(ilinkA->event,kspA,ilinkA->x,ilinkA->y,NULL);CHKERRQ(ierr);
1208443836d0SMatthew G Knepley       ierr = KSPSolve(kspA,ilinkA->x,ilinkA->y);CHKERRQ(ierr);
1209c0decd05SBarry Smith       ierr = KSPCheckSolve(kspA,pc,ilinkA->y);CHKERRQ(ierr);
1210443836d0SMatthew G Knepley       ierr = MatMult(jac->B,ilinkD->y,ilinkA->x);CHKERRQ(ierr);
12119df09d43SBarry Smith       ierr = PetscLogEventBegin(KSP_Solve_FS_U,kspUpper,ilinkA->x,ilinkA->z,NULL);CHKERRQ(ierr);
1212443836d0SMatthew G Knepley       ierr = KSPSolve(kspUpper,ilinkA->x,ilinkA->z);CHKERRQ(ierr);
1213c0decd05SBarry Smith       ierr = KSPCheckSolve(kspUpper,pc,ilinkA->z);CHKERRQ(ierr);
12149df09d43SBarry Smith       ierr = PetscLogEventEnd(KSP_Solve_FS_U,kspUpper,ilinkA->x,ilinkA->z,NULL);CHKERRQ(ierr);
1215443836d0SMatthew G Knepley       ierr = VecAXPY(ilinkA->y,-1.0,ilinkA->z);CHKERRQ(ierr);
1216443836d0SMatthew G Knepley     }
1217c238f8cdSStefano Zampini     ierr = VecScatterEnd(ilinkD->sctx,ilinkD->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
12183b224e63SBarry Smith     ierr = VecScatterBegin(ilinkA->sctx,ilinkA->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
12193b224e63SBarry Smith     ierr = VecScatterEnd(ilinkA->sctx,ilinkA->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
1220c5d2311dSJed Brown   }
12213b224e63SBarry Smith   PetscFunctionReturn(0);
12223b224e63SBarry Smith }
12233b224e63SBarry Smith 
12240971522cSBarry Smith static PetscErrorCode PCApply_FieldSplit(PC pc,Vec x,Vec y)
12250971522cSBarry Smith {
12260971522cSBarry Smith   PC_FieldSplit      *jac = (PC_FieldSplit*)pc->data;
12270971522cSBarry Smith   PetscErrorCode     ierr;
12285a9f2f41SSatish Balay   PC_FieldSplitLink  ilink = jac->head;
1229939b8a20SBarry Smith   PetscInt           cnt,bs;
12300971522cSBarry Smith 
12310971522cSBarry Smith   PetscFunctionBegin;
123279416396SBarry Smith   if (jac->type == PC_COMPOSITE_ADDITIVE) {
12331b9fc7fcSBarry Smith     if (jac->defaultsplit) {
1234939b8a20SBarry Smith       ierr = VecGetBlockSize(x,&bs);CHKERRQ(ierr);
1235ce94432eSBarry 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);
1236939b8a20SBarry Smith       ierr = VecGetBlockSize(y,&bs);CHKERRQ(ierr);
1237ce94432eSBarry 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);
12380971522cSBarry Smith       ierr = VecStrideGatherAll(x,jac->x,INSERT_VALUES);CHKERRQ(ierr);
12395a9f2f41SSatish Balay       while (ilink) {
12409df09d43SBarry Smith         ierr = PetscLogEventBegin(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL);CHKERRQ(ierr);
12415a9f2f41SSatish Balay         ierr = KSPSolve(ilink->ksp,ilink->x,ilink->y);CHKERRQ(ierr);
1242c0decd05SBarry Smith         ierr = KSPCheckSolve(ilink->ksp,pc,ilink->y);CHKERRQ(ierr);
12439df09d43SBarry Smith         ierr = PetscLogEventEnd(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL);CHKERRQ(ierr);
12445a9f2f41SSatish Balay         ilink = ilink->next;
12450971522cSBarry Smith       }
12460971522cSBarry Smith       ierr = VecStrideScatterAll(jac->y,y,INSERT_VALUES);CHKERRQ(ierr);
12471b9fc7fcSBarry Smith     } else {
1248efb30889SBarry Smith       ierr = VecSet(y,0.0);CHKERRQ(ierr);
12495a9f2f41SSatish Balay       while (ilink) {
12505a9f2f41SSatish Balay         ierr = FieldSplitSplitSolveAdd(ilink,x,y);CHKERRQ(ierr);
12515a9f2f41SSatish Balay         ilink = ilink->next;
12521b9fc7fcSBarry Smith       }
12531b9fc7fcSBarry Smith     }
1254e52d2c62SBarry Smith   } else if (jac->type == PC_COMPOSITE_MULTIPLICATIVE && jac->nsplits == 2) {
1255e52d2c62SBarry Smith     ierr = VecSet(y,0.0);CHKERRQ(ierr);
1256e52d2c62SBarry Smith     /* solve on first block for first block variables */
1257e52d2c62SBarry Smith     ierr = VecScatterBegin(ilink->sctx,x,ilink->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
1258e52d2c62SBarry Smith     ierr = VecScatterEnd(ilink->sctx,x,ilink->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
12599df09d43SBarry Smith     ierr = PetscLogEventBegin(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL);CHKERRQ(ierr);
1260e52d2c62SBarry Smith     ierr = KSPSolve(ilink->ksp,ilink->x,ilink->y);CHKERRQ(ierr);
1261c0decd05SBarry Smith     ierr = KSPCheckSolve(ilink->ksp,pc,ilink->y);CHKERRQ(ierr);
12629df09d43SBarry Smith     ierr = PetscLogEventEnd(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL);CHKERRQ(ierr);
1263e52d2c62SBarry Smith     ierr = VecScatterBegin(ilink->sctx,ilink->y,y,ADD_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
1264e52d2c62SBarry Smith     ierr = VecScatterEnd(ilink->sctx,ilink->y,y,ADD_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
1265e52d2c62SBarry Smith 
1266e52d2c62SBarry Smith     /* compute the residual only onto second block variables using first block variables */
1267e52d2c62SBarry Smith     ierr = MatMult(jac->Afield[1],ilink->y,ilink->next->x);CHKERRQ(ierr);
1268e52d2c62SBarry Smith     ilink = ilink->next;
1269e52d2c62SBarry Smith     ierr = VecScale(ilink->x,-1.0);CHKERRQ(ierr);
1270e52d2c62SBarry Smith     ierr = VecScatterBegin(ilink->sctx,x,ilink->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
1271e52d2c62SBarry Smith     ierr = VecScatterEnd(ilink->sctx,x,ilink->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
1272e52d2c62SBarry Smith 
1273e52d2c62SBarry Smith     /* solve on second block variables */
12749df09d43SBarry Smith     ierr = PetscLogEventBegin(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL);CHKERRQ(ierr);
1275e52d2c62SBarry Smith     ierr = KSPSolve(ilink->ksp,ilink->x,ilink->y);CHKERRQ(ierr);
1276c0decd05SBarry Smith     ierr = KSPCheckSolve(ilink->ksp,pc,ilink->y);CHKERRQ(ierr);
12779df09d43SBarry Smith     ierr = PetscLogEventEnd(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL);CHKERRQ(ierr);
1278e52d2c62SBarry Smith     ierr = VecScatterBegin(ilink->sctx,ilink->y,y,ADD_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
1279e52d2c62SBarry Smith     ierr = VecScatterEnd(ilink->sctx,ilink->y,y,ADD_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
128016913363SBarry Smith   } else if (jac->type == PC_COMPOSITE_MULTIPLICATIVE || jac->type == PC_COMPOSITE_SYMMETRIC_MULTIPLICATIVE) {
128179416396SBarry Smith     if (!jac->w1) {
128279416396SBarry Smith       ierr = VecDuplicate(x,&jac->w1);CHKERRQ(ierr);
128379416396SBarry Smith       ierr = VecDuplicate(x,&jac->w2);CHKERRQ(ierr);
128479416396SBarry Smith     }
1285efb30889SBarry Smith     ierr = VecSet(y,0.0);CHKERRQ(ierr);
12865a9f2f41SSatish Balay     ierr = FieldSplitSplitSolveAdd(ilink,x,y);CHKERRQ(ierr);
12873e197d65SBarry Smith     cnt  = 1;
12885a9f2f41SSatish Balay     while (ilink->next) {
12895a9f2f41SSatish Balay       ilink = ilink->next;
12903e197d65SBarry Smith       /* compute the residual only over the part of the vector needed */
12913e197d65SBarry Smith       ierr = MatMult(jac->Afield[cnt++],y,ilink->x);CHKERRQ(ierr);
12923e197d65SBarry Smith       ierr = VecScale(ilink->x,-1.0);CHKERRQ(ierr);
12933e197d65SBarry Smith       ierr = VecScatterBegin(ilink->sctx,x,ilink->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
12943e197d65SBarry Smith       ierr = VecScatterEnd(ilink->sctx,x,ilink->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
12959df09d43SBarry Smith       ierr = PetscLogEventBegin(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL);CHKERRQ(ierr);
12963e197d65SBarry Smith       ierr = KSPSolve(ilink->ksp,ilink->x,ilink->y);CHKERRQ(ierr);
1297c0decd05SBarry Smith       ierr = KSPCheckSolve(ilink->ksp,pc,ilink->y);CHKERRQ(ierr);
12989df09d43SBarry Smith       ierr = PetscLogEventEnd(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL);CHKERRQ(ierr);
12993e197d65SBarry Smith       ierr = VecScatterBegin(ilink->sctx,ilink->y,y,ADD_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
13003e197d65SBarry Smith       ierr = VecScatterEnd(ilink->sctx,ilink->y,y,ADD_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
13013e197d65SBarry Smith     }
130251f519a2SBarry Smith     if (jac->type == PC_COMPOSITE_SYMMETRIC_MULTIPLICATIVE) {
130311755939SBarry Smith       cnt -= 2;
130451f519a2SBarry Smith       while (ilink->previous) {
130551f519a2SBarry Smith         ilink = ilink->previous;
130611755939SBarry Smith         /* compute the residual only over the part of the vector needed */
130711755939SBarry Smith         ierr = MatMult(jac->Afield[cnt--],y,ilink->x);CHKERRQ(ierr);
130811755939SBarry Smith         ierr = VecScale(ilink->x,-1.0);CHKERRQ(ierr);
130911755939SBarry Smith         ierr = VecScatterBegin(ilink->sctx,x,ilink->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
131011755939SBarry Smith         ierr = VecScatterEnd(ilink->sctx,x,ilink->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
13119df09d43SBarry Smith         ierr = PetscLogEventBegin(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL);CHKERRQ(ierr);
131211755939SBarry Smith         ierr = KSPSolve(ilink->ksp,ilink->x,ilink->y);CHKERRQ(ierr);
1313c0decd05SBarry Smith         ierr = KSPCheckSolve(ilink->ksp,pc,ilink->y);CHKERRQ(ierr);
13149df09d43SBarry Smith         ierr = PetscLogEventEnd(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL);CHKERRQ(ierr);
131511755939SBarry Smith         ierr = VecScatterBegin(ilink->sctx,ilink->y,y,ADD_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
131611755939SBarry Smith         ierr = VecScatterEnd(ilink->sctx,ilink->y,y,ADD_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
131751f519a2SBarry Smith       }
131811755939SBarry Smith     }
1319ce94432eSBarry Smith   } else SETERRQ1(PetscObjectComm((PetscObject)pc),PETSC_ERR_SUP,"Unsupported or unknown composition",(int) jac->type);
13200971522cSBarry Smith   PetscFunctionReturn(0);
13210971522cSBarry Smith }
13220971522cSBarry Smith 
1323a51937d4SCarola Kruse static PetscErrorCode PCApply_FieldSplit_GKB(PC pc,Vec x,Vec y)
1324a51937d4SCarola Kruse {
1325a51937d4SCarola Kruse   PC_FieldSplit      *jac = (PC_FieldSplit*)pc->data;
1326a51937d4SCarola Kruse   PetscErrorCode     ierr;
1327a51937d4SCarola Kruse   PC_FieldSplitLink  ilinkA = jac->head,ilinkD = ilinkA->next;
1328a51937d4SCarola Kruse   KSP                ksp = ilinkA->ksp;
1329de482cd7SCarola Kruse   Vec                u,v,Hu,d,work1,work2;
1330e071a0a4SCarola Kruse   PetscScalar        alpha,z,nrmz2,*vecz;
1331e071a0a4SCarola Kruse   PetscReal          lowbnd,nu,beta;
1332a51937d4SCarola Kruse   PetscInt           j,iterGKB;
1333a51937d4SCarola Kruse 
1334a51937d4SCarola Kruse   PetscFunctionBegin;
1335a51937d4SCarola Kruse   ierr = VecScatterBegin(ilinkA->sctx,x,ilinkA->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
1336a51937d4SCarola Kruse   ierr = VecScatterBegin(ilinkD->sctx,x,ilinkD->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
1337de482cd7SCarola Kruse   ierr = VecScatterEnd(ilinkA->sctx,x,ilinkA->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
1338a51937d4SCarola Kruse   ierr = VecScatterEnd(ilinkD->sctx,x,ilinkD->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
1339e071a0a4SCarola Kruse 
1340e071a0a4SCarola Kruse   u     = jac->u;
1341e071a0a4SCarola Kruse   v     = jac->v;
1342e071a0a4SCarola Kruse   Hu    = jac->Hu;
1343e071a0a4SCarola Kruse   d     = jac->d;
1344e071a0a4SCarola Kruse   work1 = jac->w1;
1345e071a0a4SCarola Kruse   work2 = jac->w2;
1346e071a0a4SCarola Kruse   vecz  = jac->vecz;
1347a51937d4SCarola Kruse 
1348a51937d4SCarola Kruse   /* Change RHS to comply with matrix regularization H = A + nu*B*B' */
1349a51937d4SCarola Kruse   /* Add q = q + nu*B*b */
1350a51937d4SCarola Kruse   if (jac->gkbnu) {
1351a51937d4SCarola Kruse     nu = jac->gkbnu;
1352de482cd7SCarola Kruse     ierr = VecScale(ilinkD->x,jac->gkbnu);CHKERRQ(ierr);
1353de482cd7SCarola Kruse     ierr = MatMultAdd(jac->B,ilinkD->x,ilinkA->x,ilinkA->x);CHKERRQ(ierr);            /* q = q + nu*B*b */
1354a51937d4SCarola Kruse   } else {
1355a51937d4SCarola Kruse     /* Situation when no augmented Lagrangian is used. Then we set inner  */
1356a51937d4SCarola Kruse     /* matrix N = I in [Ar13], and thus nu = 1.                           */
1357a51937d4SCarola Kruse     nu = 1;
1358a51937d4SCarola Kruse   }
1359a51937d4SCarola Kruse 
1360a51937d4SCarola Kruse   /* Transform rhs from [q,tilde{b}] to [0,b] */
1361de482cd7SCarola Kruse   ierr = PetscLogEventBegin(ilinkA->event,ksp,ilinkA->x,ilinkA->y,NULL);CHKERRQ(ierr);
1362de482cd7SCarola Kruse   ierr = KSPSolve(ksp,ilinkA->x,ilinkA->y);CHKERRQ(ierr);
1363c0decd05SBarry Smith   ierr = KSPCheckSolve(ksp,pc,ilinkA->y);CHKERRQ(ierr);
1364de482cd7SCarola Kruse   ierr = PetscLogEventEnd(ilinkA->event,ksp,ilinkA->x,ilinkA->y,NULL);CHKERRQ(ierr);
1365a51937d4SCarola Kruse   ierr = MatMultHermitianTranspose(jac->B,ilinkA->y,work1);CHKERRQ(ierr);
136692c1e38eSCarola Kruse   ierr = VecAXPBY(work1,1.0/nu,-1.0,ilinkD->x);CHKERRQ(ierr);            /* c = b - B'*x        */
1367a51937d4SCarola Kruse 
1368a51937d4SCarola Kruse   /* First step of algorithm */
1369de482cd7SCarola Kruse   ierr  = VecNorm(work1,NORM_2,&beta);CHKERRQ(ierr);                   /* beta = sqrt(nu*c'*c)*/
1370e071a0a4SCarola Kruse   KSPCheckDot(ksp,beta);
1371addd1e01SJunchao Zhang   beta  = PetscSqrtReal(nu)*beta;
137292c1e38eSCarola Kruse   ierr  = VecAXPBY(v,nu/beta,0.0,work1);CHKERRQ(ierr);                   /* v = nu/beta *c      */
1373a51937d4SCarola Kruse   ierr  = MatMult(jac->B,v,work2);CHKERRQ(ierr);                       /* u = H^{-1}*B*v      */
1374a51937d4SCarola Kruse   ierr  = PetscLogEventBegin(ilinkA->event,ksp,work2,u,NULL);CHKERRQ(ierr);
1375a51937d4SCarola Kruse   ierr  = KSPSolve(ksp,work2,u);CHKERRQ(ierr);
1376c0decd05SBarry Smith   ierr  = KSPCheckSolve(ksp,pc,u);CHKERRQ(ierr);
1377a51937d4SCarola Kruse   ierr  = PetscLogEventEnd(ilinkA->event,ksp,work2,u,NULL);CHKERRQ(ierr);
1378a51937d4SCarola Kruse   ierr  = MatMult(jac->H,u,Hu);CHKERRQ(ierr);                          /* alpha = u'*H*u      */
1379a51937d4SCarola Kruse   ierr  = VecDot(Hu,u,&alpha);CHKERRQ(ierr);
1380e071a0a4SCarola Kruse   KSPCheckDot(ksp,alpha);
1381e071a0a4SCarola Kruse   if (PetscRealPart(alpha) <= 0.0) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_NOT_CONVERGED,"GKB preconditioner diverged, H is not positive definite");
1382addd1e01SJunchao Zhang   alpha = PetscSqrtReal(PetscAbsScalar(alpha));
138392c1e38eSCarola Kruse   ierr  = VecScale(u,1.0/alpha);CHKERRQ(ierr);
138492c1e38eSCarola Kruse   ierr  = VecAXPBY(d,1.0/alpha,0.0,v);CHKERRQ(ierr);                       /* v = nu/beta *c      */
1385de482cd7SCarola Kruse 
1386a51937d4SCarola Kruse   z = beta/alpha;
1387a51937d4SCarola Kruse   vecz[1] = z;
1388a51937d4SCarola Kruse 
1389de482cd7SCarola Kruse   /* Computation of first iterate x(1) and p(1) */
1390a51937d4SCarola Kruse   ierr = VecAXPY(ilinkA->y,z,u);CHKERRQ(ierr);
1391a51937d4SCarola Kruse   ierr = VecCopy(d,ilinkD->y);CHKERRQ(ierr);
1392a51937d4SCarola Kruse   ierr = VecScale(ilinkD->y,-z);CHKERRQ(ierr);
1393a51937d4SCarola Kruse 
1394a51937d4SCarola Kruse   iterGKB = 1; lowbnd = 2*jac->gkbtol;
1395de482cd7SCarola Kruse   if (jac->gkbmonitor) {
1396de482cd7SCarola Kruse       ierr = PetscViewerASCIIPrintf(jac->gkbviewer,"%3D GKB Lower bound estimate %14.12e\n",iterGKB,lowbnd);CHKERRQ(ierr);
1397de482cd7SCarola Kruse   }
1398de482cd7SCarola Kruse 
1399a51937d4SCarola Kruse   while (iterGKB < jac->gkbmaxit && lowbnd > jac->gkbtol) {
1400a51937d4SCarola Kruse     iterGKB += 1;
1401e071a0a4SCarola Kruse     ierr  = MatMultHermitianTranspose(jac->B,u,work1);CHKERRQ(ierr); /* v <- nu*(B'*u-alpha/nu*v) */
1402e071a0a4SCarola Kruse     ierr  = VecAXPBY(v,nu,-alpha,work1);CHKERRQ(ierr);
1403e071a0a4SCarola Kruse     ierr  = VecNorm(v,NORM_2,&beta);CHKERRQ(ierr);                   /* beta = sqrt(nu)*v'*v      */
1404addd1e01SJunchao Zhang     beta  = beta/PetscSqrtReal(nu);
140592c1e38eSCarola Kruse     ierr  = VecScale(v,1.0/beta);CHKERRQ(ierr);
1406e071a0a4SCarola Kruse     ierr  = MatMult(jac->B,v,work2);CHKERRQ(ierr);                  /* u <- H^{-1}*(B*v-beta*H*u) */
1407a51937d4SCarola Kruse     ierr  = MatMult(jac->H,u,Hu);CHKERRQ(ierr);
1408a51937d4SCarola Kruse     ierr  = VecAXPY(work2,-beta,Hu);CHKERRQ(ierr);
1409a51937d4SCarola Kruse     ierr  = PetscLogEventBegin(ilinkA->event,ksp,work2,u,NULL);CHKERRQ(ierr);
1410a51937d4SCarola Kruse     ierr  = KSPSolve(ksp,work2,u);CHKERRQ(ierr);
1411c0decd05SBarry Smith     ierr  = KSPCheckSolve(ksp,pc,u);CHKERRQ(ierr);
1412a51937d4SCarola Kruse     ierr  = PetscLogEventEnd(ilinkA->event,ksp,work2,u,NULL);CHKERRQ(ierr);
1413a51937d4SCarola Kruse     ierr  = MatMult(jac->H,u,Hu);CHKERRQ(ierr);                      /* alpha = u'*H*u            */
1414a51937d4SCarola Kruse     ierr  = VecDot(Hu,u,&alpha);CHKERRQ(ierr);
1415e071a0a4SCarola Kruse     KSPCheckDot(ksp,alpha);
1416e071a0a4SCarola Kruse     if (PetscRealPart(alpha) <= 0.0) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_NOT_CONVERGED,"GKB preconditioner diverged, H is not positive definite");
1417addd1e01SJunchao Zhang     alpha = PetscSqrtReal(PetscAbsScalar(alpha));
141892c1e38eSCarola Kruse     ierr  = VecScale(u,1.0/alpha);CHKERRQ(ierr);
1419a51937d4SCarola Kruse 
1420e071a0a4SCarola Kruse     z = -beta/alpha*z;                                            /* z <- beta/alpha*z     */
1421a51937d4SCarola Kruse     vecz[0] = z;
1422a51937d4SCarola Kruse 
1423a51937d4SCarola Kruse     /* Computation of new iterate x(i+1) and p(i+1) */
142492c1e38eSCarola Kruse     ierr = VecAXPBY(d,1.0/alpha,-beta/alpha,v);CHKERRQ(ierr);       /* d = (v-beta*d)/alpha */
1425a51937d4SCarola Kruse     ierr = VecAXPY(ilinkA->y,z,u);CHKERRQ(ierr);                  /* r = r + z*u          */
1426a51937d4SCarola Kruse     ierr = VecAXPY(ilinkD->y,-z,d);CHKERRQ(ierr);                 /* p = p - z*d          */
1427de482cd7SCarola Kruse     ierr = MatMult(jac->H,ilinkA->y,Hu);CHKERRQ(ierr);            /* ||u||_H = u'*H*u     */
1428a51937d4SCarola Kruse     ierr = VecDot(Hu,ilinkA->y,&nrmz2);CHKERRQ(ierr);
1429a51937d4SCarola Kruse 
1430a51937d4SCarola Kruse     /* Compute Lower Bound estimate */
1431a51937d4SCarola Kruse     if (iterGKB > jac->gkbdelay) {
1432a51937d4SCarola Kruse       lowbnd = 0.0;
1433a51937d4SCarola Kruse       for (j=0; j<jac->gkbdelay; j++) {
1434a51937d4SCarola Kruse         lowbnd += PetscAbsScalar(vecz[j]*vecz[j]);
1435a51937d4SCarola Kruse       }
1436addd1e01SJunchao Zhang       lowbnd = PetscSqrtReal(lowbnd/PetscAbsScalar(nrmz2));
1437a51937d4SCarola Kruse     }
1438a51937d4SCarola Kruse 
1439a51937d4SCarola Kruse     for (j=0; j<jac->gkbdelay-1; j++) {
1440a51937d4SCarola Kruse       vecz[jac->gkbdelay-j-1] = vecz[jac->gkbdelay-j-2];
1441a51937d4SCarola Kruse     }
1442de482cd7SCarola Kruse     if (jac->gkbmonitor) {
1443de482cd7SCarola Kruse       ierr = PetscViewerASCIIPrintf(jac->gkbviewer,"%3D GKB Lower bound estimate %14.12e\n",iterGKB,lowbnd);CHKERRQ(ierr);
1444de482cd7SCarola Kruse     }
1445a51937d4SCarola Kruse   }
1446a51937d4SCarola Kruse 
1447a51937d4SCarola Kruse   ierr = VecScatterBegin(ilinkA->sctx,ilinkA->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
1448de482cd7SCarola Kruse   ierr = VecScatterEnd(ilinkA->sctx,ilinkA->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
1449a29b4eb7SJunchao Zhang   ierr = VecScatterBegin(ilinkD->sctx,ilinkD->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
1450a51937d4SCarola Kruse   ierr = VecScatterEnd(ilinkD->sctx,ilinkD->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
1451a51937d4SCarola Kruse 
1452a51937d4SCarola Kruse   PetscFunctionReturn(0);
1453a51937d4SCarola Kruse }
1454a51937d4SCarola Kruse 
1455421e10b8SBarry Smith #define FieldSplitSplitSolveAddTranspose(ilink,xx,yy) \
1456ca9f406cSSatish Balay   (VecScatterBegin(ilink->sctx,xx,ilink->y,INSERT_VALUES,SCATTER_FORWARD) || \
1457ca9f406cSSatish Balay    VecScatterEnd(ilink->sctx,xx,ilink->y,INSERT_VALUES,SCATTER_FORWARD) || \
14589df09d43SBarry Smith    PetscLogEventBegin(ilink->event,ilink->ksp,ilink->y,ilink->x,NULL) || \
1459421e10b8SBarry Smith    KSPSolveTranspose(ilink->ksp,ilink->y,ilink->x) ||                  \
1460c0decd05SBarry Smith    KSPCheckSolve(ilink->ksp,pc,ilink->x) || \
1461c0decd05SBarry Smith    PetscLogEventEnd(ilink->event,ilink->ksp,ilink->y,ilink->x,NULL) ||   \
1462ca9f406cSSatish Balay    VecScatterBegin(ilink->sctx,ilink->x,yy,ADD_VALUES,SCATTER_REVERSE) || \
1463ca9f406cSSatish Balay    VecScatterEnd(ilink->sctx,ilink->x,yy,ADD_VALUES,SCATTER_REVERSE))
1464421e10b8SBarry Smith 
1465421e10b8SBarry Smith static PetscErrorCode PCApplyTranspose_FieldSplit(PC pc,Vec x,Vec y)
1466421e10b8SBarry Smith {
1467421e10b8SBarry Smith   PC_FieldSplit      *jac = (PC_FieldSplit*)pc->data;
1468421e10b8SBarry Smith   PetscErrorCode     ierr;
1469421e10b8SBarry Smith   PC_FieldSplitLink  ilink = jac->head;
1470939b8a20SBarry Smith   PetscInt           bs;
1471421e10b8SBarry Smith 
1472421e10b8SBarry Smith   PetscFunctionBegin;
1473421e10b8SBarry Smith   if (jac->type == PC_COMPOSITE_ADDITIVE) {
1474421e10b8SBarry Smith     if (jac->defaultsplit) {
1475939b8a20SBarry Smith       ierr = VecGetBlockSize(x,&bs);CHKERRQ(ierr);
1476ce94432eSBarry 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);
1477939b8a20SBarry Smith       ierr = VecGetBlockSize(y,&bs);CHKERRQ(ierr);
1478ce94432eSBarry 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);
1479421e10b8SBarry Smith       ierr = VecStrideGatherAll(x,jac->x,INSERT_VALUES);CHKERRQ(ierr);
1480421e10b8SBarry Smith       while (ilink) {
14819df09d43SBarry Smith         ierr = PetscLogEventBegin(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL);CHKERRQ(ierr);
1482421e10b8SBarry Smith         ierr = KSPSolveTranspose(ilink->ksp,ilink->x,ilink->y);CHKERRQ(ierr);
1483c0decd05SBarry Smith         ierr = KSPCheckSolve(ilink->ksp,pc,ilink->y);CHKERRQ(ierr);
14849df09d43SBarry Smith         ierr = PetscLogEventEnd(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL);CHKERRQ(ierr);
1485421e10b8SBarry Smith         ilink = ilink->next;
1486421e10b8SBarry Smith       }
1487421e10b8SBarry Smith       ierr = VecStrideScatterAll(jac->y,y,INSERT_VALUES);CHKERRQ(ierr);
1488421e10b8SBarry Smith     } else {
1489421e10b8SBarry Smith       ierr = VecSet(y,0.0);CHKERRQ(ierr);
1490421e10b8SBarry Smith       while (ilink) {
1491421e10b8SBarry Smith         ierr = FieldSplitSplitSolveAddTranspose(ilink,x,y);CHKERRQ(ierr);
1492421e10b8SBarry Smith         ilink = ilink->next;
1493421e10b8SBarry Smith       }
1494421e10b8SBarry Smith     }
1495421e10b8SBarry Smith   } else {
1496421e10b8SBarry Smith     if (!jac->w1) {
1497421e10b8SBarry Smith       ierr = VecDuplicate(x,&jac->w1);CHKERRQ(ierr);
1498421e10b8SBarry Smith       ierr = VecDuplicate(x,&jac->w2);CHKERRQ(ierr);
1499421e10b8SBarry Smith     }
1500421e10b8SBarry Smith     ierr = VecSet(y,0.0);CHKERRQ(ierr);
1501421e10b8SBarry Smith     if (jac->type == PC_COMPOSITE_SYMMETRIC_MULTIPLICATIVE) {
1502421e10b8SBarry Smith       ierr = FieldSplitSplitSolveAddTranspose(ilink,x,y);CHKERRQ(ierr);
1503421e10b8SBarry Smith       while (ilink->next) {
1504421e10b8SBarry Smith         ilink = ilink->next;
15059989ab13SBarry Smith         ierr  = MatMultTranspose(pc->mat,y,jac->w1);CHKERRQ(ierr);
1506421e10b8SBarry Smith         ierr  = VecWAXPY(jac->w2,-1.0,jac->w1,x);CHKERRQ(ierr);
1507421e10b8SBarry Smith         ierr  = FieldSplitSplitSolveAddTranspose(ilink,jac->w2,y);CHKERRQ(ierr);
1508421e10b8SBarry Smith       }
1509421e10b8SBarry Smith       while (ilink->previous) {
1510421e10b8SBarry Smith         ilink = ilink->previous;
15119989ab13SBarry Smith         ierr  = MatMultTranspose(pc->mat,y,jac->w1);CHKERRQ(ierr);
1512421e10b8SBarry Smith         ierr  = VecWAXPY(jac->w2,-1.0,jac->w1,x);CHKERRQ(ierr);
1513421e10b8SBarry Smith         ierr  = FieldSplitSplitSolveAddTranspose(ilink,jac->w2,y);CHKERRQ(ierr);
1514421e10b8SBarry Smith       }
1515421e10b8SBarry Smith     } else {
1516421e10b8SBarry Smith       while (ilink->next) {   /* get to last entry in linked list */
1517421e10b8SBarry Smith         ilink = ilink->next;
1518421e10b8SBarry Smith       }
1519421e10b8SBarry Smith       ierr = FieldSplitSplitSolveAddTranspose(ilink,x,y);CHKERRQ(ierr);
1520421e10b8SBarry Smith       while (ilink->previous) {
1521421e10b8SBarry Smith         ilink = ilink->previous;
15229989ab13SBarry Smith         ierr  = MatMultTranspose(pc->mat,y,jac->w1);CHKERRQ(ierr);
1523421e10b8SBarry Smith         ierr  = VecWAXPY(jac->w2,-1.0,jac->w1,x);CHKERRQ(ierr);
1524421e10b8SBarry Smith         ierr  = FieldSplitSplitSolveAddTranspose(ilink,jac->w2,y);CHKERRQ(ierr);
1525421e10b8SBarry Smith       }
1526421e10b8SBarry Smith     }
1527421e10b8SBarry Smith   }
1528421e10b8SBarry Smith   PetscFunctionReturn(0);
1529421e10b8SBarry Smith }
1530421e10b8SBarry Smith 
1531574deadeSBarry Smith static PetscErrorCode PCReset_FieldSplit(PC pc)
15320971522cSBarry Smith {
15330971522cSBarry Smith   PC_FieldSplit     *jac = (PC_FieldSplit*)pc->data;
15340971522cSBarry Smith   PetscErrorCode    ierr;
15355a9f2f41SSatish Balay   PC_FieldSplitLink ilink = jac->head,next;
15360971522cSBarry Smith 
15370971522cSBarry Smith   PetscFunctionBegin;
15385a9f2f41SSatish Balay   while (ilink) {
1539f5f0d762SBarry Smith     ierr  = KSPDestroy(&ilink->ksp);CHKERRQ(ierr);
1540fcfd50ebSBarry Smith     ierr  = VecDestroy(&ilink->x);CHKERRQ(ierr);
1541fcfd50ebSBarry Smith     ierr  = VecDestroy(&ilink->y);CHKERRQ(ierr);
1542443836d0SMatthew G Knepley     ierr  = VecDestroy(&ilink->z);CHKERRQ(ierr);
1543fcfd50ebSBarry Smith     ierr  = VecScatterDestroy(&ilink->sctx);CHKERRQ(ierr);
1544fcfd50ebSBarry Smith     ierr  = ISDestroy(&ilink->is);CHKERRQ(ierr);
1545b5787286SJed Brown     ierr  = ISDestroy(&ilink->is_col);CHKERRQ(ierr);
1546f5f0d762SBarry Smith     ierr  = PetscFree(ilink->splitname);CHKERRQ(ierr);
1547f5f0d762SBarry Smith     ierr  = PetscFree(ilink->fields);CHKERRQ(ierr);
1548f5f0d762SBarry Smith     ierr  = PetscFree(ilink->fields_col);CHKERRQ(ierr);
15495a9f2f41SSatish Balay     next  = ilink->next;
1550f5f0d762SBarry Smith     ierr  = PetscFree(ilink);CHKERRQ(ierr);
15515a9f2f41SSatish Balay     ilink = next;
15520971522cSBarry Smith   }
1553f5f0d762SBarry Smith   jac->head = NULL;
155405b42c5fSBarry Smith   ierr = PetscFree2(jac->x,jac->y);CHKERRQ(ierr);
1555574deadeSBarry Smith   if (jac->mat && jac->mat != jac->pmat) {
1556574deadeSBarry Smith     ierr = MatDestroyMatrices(jac->nsplits,&jac->mat);CHKERRQ(ierr);
1557574deadeSBarry Smith   } else if (jac->mat) {
15580298fd71SBarry Smith     jac->mat = NULL;
1559574deadeSBarry Smith   }
156097bbdb24SBarry Smith   if (jac->pmat) {ierr = MatDestroyMatrices(jac->nsplits,&jac->pmat);CHKERRQ(ierr);}
156168dd23aaSBarry Smith   if (jac->Afield) {ierr = MatDestroyMatrices(jac->nsplits,&jac->Afield);CHKERRQ(ierr);}
1562f5f0d762SBarry Smith   jac->nsplits = 0;
15636bf464f9SBarry Smith   ierr = VecDestroy(&jac->w1);CHKERRQ(ierr);
15646bf464f9SBarry Smith   ierr = VecDestroy(&jac->w2);CHKERRQ(ierr);
15656bf464f9SBarry Smith   ierr = MatDestroy(&jac->schur);CHKERRQ(ierr);
1566a7476a74SDmitry Karpeev   ierr = MatDestroy(&jac->schurp);CHKERRQ(ierr);
15676bf464f9SBarry Smith   ierr = MatDestroy(&jac->schur_user);CHKERRQ(ierr);
15686bf464f9SBarry Smith   ierr = KSPDestroy(&jac->kspschur);CHKERRQ(ierr);
1569d78dad28SBarry Smith   ierr = KSPDestroy(&jac->kspupper);CHKERRQ(ierr);
15706bf464f9SBarry Smith   ierr = MatDestroy(&jac->B);CHKERRQ(ierr);
15716bf464f9SBarry Smith   ierr = MatDestroy(&jac->C);CHKERRQ(ierr);
1572a51937d4SCarola Kruse   ierr = MatDestroy(&jac->H);CHKERRQ(ierr);
1573e071a0a4SCarola Kruse   ierr = VecDestroy(&jac->u);CHKERRQ(ierr);
1574e071a0a4SCarola Kruse   ierr = VecDestroy(&jac->v);CHKERRQ(ierr);
1575e071a0a4SCarola Kruse   ierr = VecDestroy(&jac->Hu);CHKERRQ(ierr);
1576e071a0a4SCarola Kruse   ierr = VecDestroy(&jac->d);CHKERRQ(ierr);
1577e071a0a4SCarola Kruse   ierr = PetscFree(jac->vecz);CHKERRQ(ierr);
1578de482cd7SCarola Kruse   ierr = PetscViewerDestroy(&jac->gkbviewer);CHKERRQ(ierr);
15796dbb499eSCian Wilson   jac->isrestrict = PETSC_FALSE;
1580574deadeSBarry Smith   PetscFunctionReturn(0);
1581574deadeSBarry Smith }
1582574deadeSBarry Smith 
1583574deadeSBarry Smith static PetscErrorCode PCDestroy_FieldSplit(PC pc)
1584574deadeSBarry Smith {
1585574deadeSBarry Smith   PetscErrorCode    ierr;
1586574deadeSBarry Smith 
1587574deadeSBarry Smith   PetscFunctionBegin;
1588574deadeSBarry Smith   ierr = PCReset_FieldSplit(pc);CHKERRQ(ierr);
1589c31cb41cSBarry Smith   ierr = PetscFree(pc->data);CHKERRQ(ierr);
1590285fb4e2SStefano Zampini   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSchurGetSubKSP_C",NULL);CHKERRQ(ierr);
1591bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitGetSubKSP_C",NULL);CHKERRQ(ierr);
1592bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetFields_C",NULL);CHKERRQ(ierr);
1593bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetIS_C",NULL);CHKERRQ(ierr);
1594bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetType_C",NULL);CHKERRQ(ierr);
1595bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetBlockSize_C",NULL);CHKERRQ(ierr);
159629f8a81cSJed Brown   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetSchurPre_C",NULL);CHKERRQ(ierr);
159737a82bf0SJed Brown   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitGetSchurPre_C",NULL);CHKERRQ(ierr);
1598bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetSchurFactType_C",NULL);CHKERRQ(ierr);
15996dbb499eSCian Wilson   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitRestrictIS_C",NULL);CHKERRQ(ierr);
16000971522cSBarry Smith   PetscFunctionReturn(0);
16010971522cSBarry Smith }
16020971522cSBarry Smith 
16034416b707SBarry Smith static PetscErrorCode PCSetFromOptions_FieldSplit(PetscOptionItems *PetscOptionsObject,PC pc)
16040971522cSBarry Smith {
16051b9fc7fcSBarry Smith   PetscErrorCode  ierr;
16066c924f48SJed Brown   PetscInt        bs;
16077b752e3dSPatrick Sanan   PetscBool       flg;
16089dcbbd2bSBarry Smith   PC_FieldSplit   *jac = (PC_FieldSplit*)pc->data;
16093b224e63SBarry Smith   PCCompositeType ctype;
16101b9fc7fcSBarry Smith 
16110971522cSBarry Smith   PetscFunctionBegin;
1612e55864a3SBarry Smith   ierr = PetscOptionsHead(PetscOptionsObject,"FieldSplit options");CHKERRQ(ierr);
16134ab8060aSDmitry Karpeev   ierr = PetscOptionsBool("-pc_fieldsplit_dm_splits","Whether to use DMCreateFieldDecomposition() for splits","PCFieldSplitSetDMSplits",jac->dm_splits,&jac->dm_splits,NULL);CHKERRQ(ierr);
161451f519a2SBarry Smith   ierr = PetscOptionsInt("-pc_fieldsplit_block_size","Blocksize that defines number of fields","PCFieldSplitSetBlockSize",jac->bs,&bs,&flg);CHKERRQ(ierr);
161551f519a2SBarry Smith   if (flg) {
161651f519a2SBarry Smith     ierr = PCFieldSplitSetBlockSize(pc,bs);CHKERRQ(ierr);
161751f519a2SBarry Smith   }
16182686e3e9SMatthew G. Knepley   jac->diag_use_amat = pc->useAmat;
16192686e3e9SMatthew 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);
16202686e3e9SMatthew G. Knepley   jac->offdiag_use_amat = pc->useAmat;
16212686e3e9SMatthew 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);
16227b752e3dSPatrick Sanan   ierr = PetscOptionsBool("-pc_fieldsplit_detect_saddle_point","Form 2-way split by detecting zero diagonal entries", "PCFieldSplitSetDetectSaddlePoint",jac->detect,&jac->detect,NULL);CHKERRQ(ierr);
16237b752e3dSPatrick Sanan   ierr = PCFieldSplitSetDetectSaddlePoint(pc,jac->detect);CHKERRQ(ierr); /* Sets split type and Schur PC type */
16243b224e63SBarry Smith   ierr = PetscOptionsEnum("-pc_fieldsplit_type","Type of composition","PCFieldSplitSetType",PCCompositeTypes,(PetscEnum)jac->type,(PetscEnum*)&ctype,&flg);CHKERRQ(ierr);
16253b224e63SBarry Smith   if (flg) {
16263b224e63SBarry Smith     ierr = PCFieldSplitSetType(pc,ctype);CHKERRQ(ierr);
16273b224e63SBarry Smith   }
1628c30613efSMatthew Knepley   /* Only setup fields once */
1629c30613efSMatthew Knepley   if ((jac->bs > 0) && (jac->nsplits == 0)) {
1630d32f9abdSBarry Smith     /* only allow user to set fields from command line if bs is already known.
1631d32f9abdSBarry Smith        otherwise user can set them in PCFieldSplitSetDefaults() */
16326c924f48SJed Brown     ierr = PCFieldSplitSetRuntimeSplits_Private(pc);CHKERRQ(ierr);
16336c924f48SJed Brown     if (jac->splitdefined) {ierr = PetscInfo(pc,"Splits defined using the options database\n");CHKERRQ(ierr);}
1634d32f9abdSBarry Smith   }
1635c5d2311dSJed Brown   if (jac->type == PC_COMPOSITE_SCHUR) {
1636c5929fdfSBarry Smith     ierr = PetscOptionsGetEnum(((PetscObject)pc)->options,((PetscObject)pc)->prefix,"-pc_fieldsplit_schur_factorization_type",PCFieldSplitSchurFactTypes,(PetscEnum*)&jac->schurfactorization,&flg);CHKERRQ(ierr);
1637c9c6ffaaSJed Brown     if (flg) {ierr = PetscInfo(pc,"Deprecated use of -pc_fieldsplit_schur_factorization_type\n");CHKERRQ(ierr);}
16380298fd71SBarry 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);
163929f8a81cSJed 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);
1640c096484dSStefano Zampini     ierr = PetscOptionsScalar("-pc_fieldsplit_schur_scale","Scale Schur complement","PCFieldSplitSetSchurScale",jac->schurscale,&jac->schurscale,NULL);CHKERRQ(ierr);
1641a51937d4SCarola Kruse   } else if (jac->type == PC_COMPOSITE_GKB) {
1642a51937d4SCarola Kruse     ierr = PetscOptionsReal("-pc_fieldsplit_gkb_tol","The tolerance for the lower bound stopping criterion","PCFieldSplitGKBTol",jac->gkbtol,&jac->gkbtol,NULL);CHKERRQ(ierr);
1643a51937d4SCarola Kruse     ierr = PetscOptionsInt("-pc_fieldsplit_gkb_delay","The delay value for lower bound criterion","PCFieldSplitGKBDelay",jac->gkbdelay,&jac->gkbdelay,NULL);CHKERRQ(ierr);
1644a51937d4SCarola Kruse     ierr = PetscOptionsReal("-pc_fieldsplit_gkb_nu","Parameter in augmented Lagrangian approach","PCFieldSplitGKBNu",jac->gkbnu,&jac->gkbnu,NULL);CHKERRQ(ierr);
1645e071a0a4SCarola Kruse     if (jac->gkbnu < 0) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"nu cannot be less than 0: value %f",jac->gkbnu);
1646a51937d4SCarola Kruse     ierr = PetscOptionsInt("-pc_fieldsplit_gkb_maxit","Maximum allowed number of iterations","PCFieldSplitGKBMaxit",jac->gkbmaxit,&jac->gkbmaxit,NULL);CHKERRQ(ierr);
1647de482cd7SCarola Kruse     ierr = PetscOptionsBool("-pc_fieldsplit_gkb_monitor","Prints number of GKB iterations and error","PCFieldSplitGKB",jac->gkbmonitor,&jac->gkbmonitor,NULL);CHKERRQ(ierr);
1648c5d2311dSJed Brown   }
16491b9fc7fcSBarry Smith   ierr = PetscOptionsTail();CHKERRQ(ierr);
16500971522cSBarry Smith   PetscFunctionReturn(0);
16510971522cSBarry Smith }
16520971522cSBarry Smith 
16530971522cSBarry Smith /*------------------------------------------------------------------------------------*/
16540971522cSBarry Smith 
16551e6b0712SBarry Smith static PetscErrorCode  PCFieldSplitSetFields_FieldSplit(PC pc,const char splitname[],PetscInt n,const PetscInt *fields,const PetscInt *fields_col)
16560971522cSBarry Smith {
165797bbdb24SBarry Smith   PC_FieldSplit     *jac = (PC_FieldSplit*)pc->data;
16580971522cSBarry Smith   PetscErrorCode    ierr;
16595a9f2f41SSatish Balay   PC_FieldSplitLink ilink,next = jac->head;
166069a612a9SBarry Smith   char              prefix[128];
16615d4c12cdSJungho Lee   PetscInt          i;
16620971522cSBarry Smith 
16630971522cSBarry Smith   PetscFunctionBegin;
16646c924f48SJed Brown   if (jac->splitdefined) {
16656c924f48SJed Brown     ierr = PetscInfo1(pc,"Ignoring new split \"%s\" because the splits have already been defined\n",splitname);CHKERRQ(ierr);
16666c924f48SJed Brown     PetscFunctionReturn(0);
16676c924f48SJed Brown   }
166851f519a2SBarry Smith   for (i=0; i<n; i++) {
1669e32f2f54SBarry 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);
1670e32f2f54SBarry Smith     if (fields[i] < 0) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Negative field %D requested",fields[i]);
167151f519a2SBarry Smith   }
1672b00a9115SJed Brown   ierr = PetscNew(&ilink);CHKERRQ(ierr);
1673a04f6461SBarry Smith   if (splitname) {
1674db4c96c1SJed Brown     ierr = PetscStrallocpy(splitname,&ilink->splitname);CHKERRQ(ierr);
1675a04f6461SBarry Smith   } else {
1676785e854fSJed Brown     ierr = PetscMalloc1(3,&ilink->splitname);CHKERRQ(ierr);
1677a04f6461SBarry Smith     ierr = PetscSNPrintf(ilink->splitname,2,"%s",jac->nsplits);CHKERRQ(ierr);
1678a04f6461SBarry Smith   }
16799df09d43SBarry Smith   ilink->event = jac->nsplits < 5 ? KSP_Solve_FS_0 + jac->nsplits : KSP_Solve_FS_0 + 4; /* Any split great than 4 gets logged in the 4th split */
1680785e854fSJed Brown   ierr = PetscMalloc1(n,&ilink->fields);CHKERRQ(ierr);
1681580bdb30SBarry Smith   ierr = PetscArraycpy(ilink->fields,fields,n);CHKERRQ(ierr);
1682785e854fSJed Brown   ierr = PetscMalloc1(n,&ilink->fields_col);CHKERRQ(ierr);
1683580bdb30SBarry Smith   ierr = PetscArraycpy(ilink->fields_col,fields_col,n);CHKERRQ(ierr);
16842fa5cd67SKarl Rupp 
16855a9f2f41SSatish Balay   ilink->nfields = n;
16860298fd71SBarry Smith   ilink->next    = NULL;
1687ce94432eSBarry Smith   ierr           = KSPCreate(PetscObjectComm((PetscObject)pc),&ilink->ksp);CHKERRQ(ierr);
1688422a814eSBarry Smith   ierr           = KSPSetErrorIfNotConverged(ilink->ksp,pc->erroriffailure);CHKERRQ(ierr);
168920252d06SBarry Smith   ierr           = PetscObjectIncrementTabLevel((PetscObject)ilink->ksp,(PetscObject)pc,1);CHKERRQ(ierr);
16905a9f2f41SSatish Balay   ierr           = KSPSetType(ilink->ksp,KSPPREONLY);CHKERRQ(ierr);
16919005cf84SBarry Smith   ierr           = PetscLogObjectParent((PetscObject)pc,(PetscObject)ilink->ksp);CHKERRQ(ierr);
169269a612a9SBarry Smith 
16938caf3d72SBarry Smith   ierr = PetscSNPrintf(prefix,sizeof(prefix),"%sfieldsplit_%s_",((PetscObject)pc)->prefix ? ((PetscObject)pc)->prefix : "",ilink->splitname);CHKERRQ(ierr);
16945a9f2f41SSatish Balay   ierr = KSPSetOptionsPrefix(ilink->ksp,prefix);CHKERRQ(ierr);
16950971522cSBarry Smith 
16960971522cSBarry Smith   if (!next) {
16975a9f2f41SSatish Balay     jac->head       = ilink;
16980298fd71SBarry Smith     ilink->previous = NULL;
16990971522cSBarry Smith   } else {
17000971522cSBarry Smith     while (next->next) {
17010971522cSBarry Smith       next = next->next;
17020971522cSBarry Smith     }
17035a9f2f41SSatish Balay     next->next      = ilink;
170451f519a2SBarry Smith     ilink->previous = next;
17050971522cSBarry Smith   }
17060971522cSBarry Smith   jac->nsplits++;
17070971522cSBarry Smith   PetscFunctionReturn(0);
17080971522cSBarry Smith }
17090971522cSBarry Smith 
1710285fb4e2SStefano Zampini static PetscErrorCode  PCFieldSplitSchurGetSubKSP_FieldSplit(PC pc,PetscInt *n,KSP **subksp)
1711285fb4e2SStefano Zampini {
1712285fb4e2SStefano Zampini   PC_FieldSplit  *jac = (PC_FieldSplit*)pc->data;
1713285fb4e2SStefano Zampini   PetscErrorCode ierr;
1714285fb4e2SStefano Zampini 
1715285fb4e2SStefano Zampini   PetscFunctionBegin;
1716285fb4e2SStefano Zampini   *subksp = NULL;
1717285fb4e2SStefano Zampini   if (n) *n = 0;
1718285fb4e2SStefano Zampini   if (jac->type == PC_COMPOSITE_SCHUR) {
1719285fb4e2SStefano Zampini     PetscInt nn;
1720285fb4e2SStefano Zampini 
1721285fb4e2SStefano Zampini     if (!jac->schur) SETERRQ(PetscObjectComm((PetscObject)pc),PETSC_ERR_ARG_WRONGSTATE,"Must call KSPSetUp() or PCSetUp() before calling PCFieldSplitSchurGetSubKSP()");
1722285fb4e2SStefano Zampini     if (jac->nsplits != 2) SETERRQ1(PetscObjectComm((PetscObject)pc),PETSC_ERR_PLIB,"Unexpected number of splits %D != 2",jac->nsplits);
1723285fb4e2SStefano Zampini     nn   = jac->nsplits + (jac->kspupper != jac->head->ksp ? 1 : 0);
1724285fb4e2SStefano Zampini     ierr = PetscMalloc1(nn,subksp);CHKERRQ(ierr);
1725285fb4e2SStefano Zampini     (*subksp)[0] = jac->head->ksp;
1726285fb4e2SStefano Zampini     (*subksp)[1] = jac->kspschur;
1727285fb4e2SStefano Zampini     if (jac->kspupper != jac->head->ksp) (*subksp)[2] = jac->kspupper;
1728285fb4e2SStefano Zampini     if (n) *n = nn;
1729285fb4e2SStefano Zampini   }
1730285fb4e2SStefano Zampini   PetscFunctionReturn(0);
1731285fb4e2SStefano Zampini }
1732285fb4e2SStefano Zampini 
17331e6b0712SBarry Smith static PetscErrorCode  PCFieldSplitGetSubKSP_FieldSplit_Schur(PC pc,PetscInt *n,KSP **subksp)
1734e69d4d44SBarry Smith {
1735e69d4d44SBarry Smith   PC_FieldSplit  *jac = (PC_FieldSplit*)pc->data;
1736e69d4d44SBarry Smith   PetscErrorCode ierr;
1737e69d4d44SBarry Smith 
1738e69d4d44SBarry Smith   PetscFunctionBegin;
173934a3b412SBarry Smith   if (!jac->schur) SETERRQ(PetscObjectComm((PetscObject)pc),PETSC_ERR_ARG_WRONGSTATE,"Must call KSPSetUp() or PCSetUp() before calling PCFieldSplitGetSubKSP()");
1740785e854fSJed Brown   ierr = PetscMalloc1(jac->nsplits,subksp);CHKERRQ(ierr);
1741e69d4d44SBarry Smith   ierr = MatSchurComplementGetKSP(jac->schur,*subksp);CHKERRQ(ierr);
17422fa5cd67SKarl Rupp 
1743e69d4d44SBarry Smith   (*subksp)[1] = jac->kspschur;
174413e0d083SBarry Smith   if (n) *n = jac->nsplits;
1745e69d4d44SBarry Smith   PetscFunctionReturn(0);
1746e69d4d44SBarry Smith }
17470971522cSBarry Smith 
17481e6b0712SBarry Smith static PetscErrorCode  PCFieldSplitGetSubKSP_FieldSplit(PC pc,PetscInt *n,KSP **subksp)
17490971522cSBarry Smith {
17500971522cSBarry Smith   PC_FieldSplit     *jac = (PC_FieldSplit*)pc->data;
17510971522cSBarry Smith   PetscErrorCode    ierr;
17520971522cSBarry Smith   PetscInt          cnt   = 0;
17535a9f2f41SSatish Balay   PC_FieldSplitLink ilink = jac->head;
17540971522cSBarry Smith 
17550971522cSBarry Smith   PetscFunctionBegin;
1756785e854fSJed Brown   ierr = PetscMalloc1(jac->nsplits,subksp);CHKERRQ(ierr);
17575a9f2f41SSatish Balay   while (ilink) {
17585a9f2f41SSatish Balay     (*subksp)[cnt++] = ilink->ksp;
17595a9f2f41SSatish Balay     ilink            = ilink->next;
17600971522cSBarry Smith   }
17615d480477SMatthew 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);
176213e0d083SBarry Smith   if (n) *n = jac->nsplits;
17630971522cSBarry Smith   PetscFunctionReturn(0);
17640971522cSBarry Smith }
17650971522cSBarry Smith 
17666dbb499eSCian Wilson /*@C
17676dbb499eSCian Wilson     PCFieldSplitRestrictIS - Restricts the fieldsplit ISs to be within a given IS.
17686dbb499eSCian Wilson 
17696dbb499eSCian Wilson     Input Parameters:
17706dbb499eSCian Wilson +   pc  - the preconditioner context
1771a2b725a8SWilliam Gropp -   is - the index set that defines the indices to which the fieldsplit is to be restricted
17726dbb499eSCian Wilson 
17736dbb499eSCian Wilson     Level: advanced
17746dbb499eSCian Wilson 
17756dbb499eSCian Wilson @*/
17766dbb499eSCian Wilson PetscErrorCode  PCFieldSplitRestrictIS(PC pc,IS isy)
17776dbb499eSCian Wilson {
17786dbb499eSCian Wilson   PetscErrorCode ierr;
17796dbb499eSCian Wilson 
17806dbb499eSCian Wilson   PetscFunctionBegin;
17816dbb499eSCian Wilson   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
17826dbb499eSCian Wilson   PetscValidHeaderSpecific(isy,IS_CLASSID,2);
17830246f55cSBarry Smith   ierr = PetscTryMethod(pc,"PCFieldSplitRestrictIS_C",(PC,IS),(pc,isy));CHKERRQ(ierr);
17846dbb499eSCian Wilson   PetscFunctionReturn(0);
17856dbb499eSCian Wilson }
17866dbb499eSCian Wilson 
17876dbb499eSCian Wilson static PetscErrorCode  PCFieldSplitRestrictIS_FieldSplit(PC pc, IS isy)
17886dbb499eSCian Wilson {
17896dbb499eSCian Wilson   PC_FieldSplit     *jac = (PC_FieldSplit*)pc->data;
17906dbb499eSCian Wilson   PetscErrorCode    ierr;
17916dbb499eSCian Wilson   PC_FieldSplitLink ilink = jac->head, next;
17926dbb499eSCian Wilson   PetscInt          localsize,size,sizez,i;
17936dbb499eSCian Wilson   const PetscInt    *ind, *indz;
17946dbb499eSCian Wilson   PetscInt          *indc, *indcz;
17956dbb499eSCian Wilson   PetscBool         flg;
17966dbb499eSCian Wilson 
17976dbb499eSCian Wilson   PetscFunctionBegin;
17986dbb499eSCian Wilson   ierr = ISGetLocalSize(isy,&localsize);CHKERRQ(ierr);
1799ffc4695bSBarry Smith   ierr = MPI_Scan(&localsize,&size,1,MPIU_INT,MPI_SUM,PetscObjectComm((PetscObject)isy));CHKERRMPI(ierr);
18006dbb499eSCian Wilson   size -= localsize;
18016dbb499eSCian Wilson   while (ilink) {
18026dbb499eSCian Wilson     IS isrl,isr;
18031c7cfba8SBarry Smith     PC subpc;
18046dbb499eSCian Wilson     ierr          = ISEmbed(ilink->is, isy, PETSC_TRUE, &isrl);CHKERRQ(ierr);
18056dbb499eSCian Wilson     ierr          = ISGetLocalSize(isrl,&localsize);CHKERRQ(ierr);
18066dbb499eSCian Wilson     ierr          = PetscMalloc1(localsize,&indc);CHKERRQ(ierr);
18076dbb499eSCian Wilson     ierr          = ISGetIndices(isrl,&ind);CHKERRQ(ierr);
1808580bdb30SBarry Smith     ierr          = PetscArraycpy(indc,ind,localsize);CHKERRQ(ierr);
18096dbb499eSCian Wilson     ierr          = ISRestoreIndices(isrl,&ind);CHKERRQ(ierr);
18106dbb499eSCian Wilson     ierr          = ISDestroy(&isrl);CHKERRQ(ierr);
18116dbb499eSCian Wilson     for (i=0; i<localsize; i++) *(indc+i) += size;
18126dbb499eSCian Wilson     ierr          = ISCreateGeneral(PetscObjectComm((PetscObject)isy),localsize,indc,PETSC_OWN_POINTER,&isr);CHKERRQ(ierr);
18136dbb499eSCian Wilson     ierr          = PetscObjectReference((PetscObject)isr);CHKERRQ(ierr);
18146dbb499eSCian Wilson     ierr          = ISDestroy(&ilink->is);CHKERRQ(ierr);
18156dbb499eSCian Wilson     ilink->is     = isr;
18166dbb499eSCian Wilson     ierr          = PetscObjectReference((PetscObject)isr);CHKERRQ(ierr);
18176dbb499eSCian Wilson     ierr          = ISDestroy(&ilink->is_col);CHKERRQ(ierr);
18186dbb499eSCian Wilson     ilink->is_col = isr;
18196dbb499eSCian Wilson     ierr          = ISDestroy(&isr);CHKERRQ(ierr);
18206dbb499eSCian Wilson     ierr          = KSPGetPC(ilink->ksp, &subpc);CHKERRQ(ierr);
18216dbb499eSCian Wilson     ierr          = PetscObjectTypeCompare((PetscObject)subpc,PCFIELDSPLIT,&flg);CHKERRQ(ierr);
18226dbb499eSCian Wilson     if (flg) {
18236dbb499eSCian Wilson       IS iszl,isz;
18246dbb499eSCian Wilson       MPI_Comm comm;
18256dbb499eSCian Wilson       ierr   = ISGetLocalSize(ilink->is,&localsize);CHKERRQ(ierr);
18266dbb499eSCian Wilson       comm   = PetscObjectComm((PetscObject)ilink->is);
18276dbb499eSCian Wilson       ierr   = ISEmbed(isy, ilink->is, PETSC_TRUE, &iszl);CHKERRQ(ierr);
182855b25c41SPierre Jolivet       ierr   = MPI_Scan(&localsize,&sizez,1,MPIU_INT,MPI_SUM,comm);CHKERRMPI(ierr);
18296dbb499eSCian Wilson       sizez -= localsize;
18306dbb499eSCian Wilson       ierr   = ISGetLocalSize(iszl,&localsize);CHKERRQ(ierr);
18316dbb499eSCian Wilson       ierr   = PetscMalloc1(localsize,&indcz);CHKERRQ(ierr);
18326dbb499eSCian Wilson       ierr   = ISGetIndices(iszl,&indz);CHKERRQ(ierr);
1833580bdb30SBarry Smith       ierr   = PetscArraycpy(indcz,indz,localsize);CHKERRQ(ierr);
18346dbb499eSCian Wilson       ierr   = ISRestoreIndices(iszl,&indz);CHKERRQ(ierr);
18356dbb499eSCian Wilson       ierr   = ISDestroy(&iszl);CHKERRQ(ierr);
18366dbb499eSCian Wilson       for (i=0; i<localsize; i++) *(indcz+i) += sizez;
18376dbb499eSCian Wilson       ierr   = ISCreateGeneral(comm,localsize,indcz,PETSC_OWN_POINTER,&isz);CHKERRQ(ierr);
18386dbb499eSCian Wilson       ierr   = PCFieldSplitRestrictIS(subpc,isz);CHKERRQ(ierr);
18396dbb499eSCian Wilson       ierr   = ISDestroy(&isz);CHKERRQ(ierr);
18406dbb499eSCian Wilson     }
18416dbb499eSCian Wilson     next = ilink->next;
18426dbb499eSCian Wilson     ilink = next;
18436dbb499eSCian Wilson   }
18446dbb499eSCian Wilson   jac->isrestrict = PETSC_TRUE;
18456dbb499eSCian Wilson   PetscFunctionReturn(0);
18466dbb499eSCian Wilson }
18476dbb499eSCian Wilson 
18481e6b0712SBarry Smith static PetscErrorCode  PCFieldSplitSetIS_FieldSplit(PC pc,const char splitname[],IS is)
1849704ba839SBarry Smith {
1850704ba839SBarry Smith   PC_FieldSplit     *jac = (PC_FieldSplit*)pc->data;
1851704ba839SBarry Smith   PetscErrorCode    ierr;
1852704ba839SBarry Smith   PC_FieldSplitLink ilink, next = jac->head;
1853704ba839SBarry Smith   char              prefix[128];
1854704ba839SBarry Smith 
1855704ba839SBarry Smith   PetscFunctionBegin;
18566c924f48SJed Brown   if (jac->splitdefined) {
18576c924f48SJed Brown     ierr = PetscInfo1(pc,"Ignoring new split \"%s\" because the splits have already been defined\n",splitname);CHKERRQ(ierr);
18586c924f48SJed Brown     PetscFunctionReturn(0);
18596c924f48SJed Brown   }
1860b00a9115SJed Brown   ierr = PetscNew(&ilink);CHKERRQ(ierr);
1861a04f6461SBarry Smith   if (splitname) {
1862db4c96c1SJed Brown     ierr = PetscStrallocpy(splitname,&ilink->splitname);CHKERRQ(ierr);
1863a04f6461SBarry Smith   } else {
1864785e854fSJed Brown     ierr = PetscMalloc1(8,&ilink->splitname);CHKERRQ(ierr);
1865b5787286SJed Brown     ierr = PetscSNPrintf(ilink->splitname,7,"%D",jac->nsplits);CHKERRQ(ierr);
1866a04f6461SBarry Smith   }
18679df09d43SBarry Smith   ilink->event  = jac->nsplits < 5 ? KSP_Solve_FS_0 + jac->nsplits : KSP_Solve_FS_0 + 4; /* Any split great than 4 gets logged in the 4th split */
18681ab39975SBarry Smith   ierr          = PetscObjectReference((PetscObject)is);CHKERRQ(ierr);
1869b5787286SJed Brown   ierr          = ISDestroy(&ilink->is);CHKERRQ(ierr);
1870b5787286SJed Brown   ilink->is     = is;
1871b5787286SJed Brown   ierr          = PetscObjectReference((PetscObject)is);CHKERRQ(ierr);
1872b5787286SJed Brown   ierr          = ISDestroy(&ilink->is_col);CHKERRQ(ierr);
1873b5787286SJed Brown   ilink->is_col = is;
18740298fd71SBarry Smith   ilink->next   = NULL;
1875ce94432eSBarry Smith   ierr          = KSPCreate(PetscObjectComm((PetscObject)pc),&ilink->ksp);CHKERRQ(ierr);
1876422a814eSBarry Smith   ierr          = KSPSetErrorIfNotConverged(ilink->ksp,pc->erroriffailure);CHKERRQ(ierr);
187720252d06SBarry Smith   ierr          = PetscObjectIncrementTabLevel((PetscObject)ilink->ksp,(PetscObject)pc,1);CHKERRQ(ierr);
1878704ba839SBarry Smith   ierr          = KSPSetType(ilink->ksp,KSPPREONLY);CHKERRQ(ierr);
18799005cf84SBarry Smith   ierr          = PetscLogObjectParent((PetscObject)pc,(PetscObject)ilink->ksp);CHKERRQ(ierr);
1880704ba839SBarry Smith 
18818caf3d72SBarry Smith   ierr = PetscSNPrintf(prefix,sizeof(prefix),"%sfieldsplit_%s_",((PetscObject)pc)->prefix ? ((PetscObject)pc)->prefix : "",ilink->splitname);CHKERRQ(ierr);
1882704ba839SBarry Smith   ierr = KSPSetOptionsPrefix(ilink->ksp,prefix);CHKERRQ(ierr);
1883704ba839SBarry Smith 
1884704ba839SBarry Smith   if (!next) {
1885704ba839SBarry Smith     jac->head       = ilink;
18860298fd71SBarry Smith     ilink->previous = NULL;
1887704ba839SBarry Smith   } else {
1888704ba839SBarry Smith     while (next->next) {
1889704ba839SBarry Smith       next = next->next;
1890704ba839SBarry Smith     }
1891704ba839SBarry Smith     next->next      = ilink;
1892704ba839SBarry Smith     ilink->previous = next;
1893704ba839SBarry Smith   }
1894704ba839SBarry Smith   jac->nsplits++;
1895704ba839SBarry Smith   PetscFunctionReturn(0);
1896704ba839SBarry Smith }
1897704ba839SBarry Smith 
189894ef8ddeSSatish Balay /*@C
18990971522cSBarry Smith     PCFieldSplitSetFields - Sets the fields for one particular split in the field split preconditioner
19000971522cSBarry Smith 
1901ad4df100SBarry Smith     Logically Collective on PC
19020971522cSBarry Smith 
19030971522cSBarry Smith     Input Parameters:
19040971522cSBarry Smith +   pc  - the preconditioner context
19050298fd71SBarry Smith .   splitname - name of this split, if NULL the number of the split is used
19060971522cSBarry Smith .   n - the number of fields in this split
1907db4c96c1SJed Brown -   fields - the fields in this split
19080971522cSBarry Smith 
19090971522cSBarry Smith     Level: intermediate
19100971522cSBarry Smith 
191195452b02SPatrick Sanan     Notes:
191295452b02SPatrick Sanan     Use PCFieldSplitSetIS() to set a completely general set of indices as a field.
1913d32f9abdSBarry Smith 
19147287d2a3SDmitry Karpeev      The PCFieldSplitSetFields() is for defining fields as strided blocks. For example, if the block
1915d32f9abdSBarry 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
1916d32f9abdSBarry Smith      0xx3xx6xx9xx12 ... x1xx4xx7xx ... xx2xx5xx8xx.. 01x34x67x... 0x1x3x5x7.. x12x45x78x....
1917d32f9abdSBarry Smith      where the numbered entries indicate what is in the field.
1918d32f9abdSBarry Smith 
1919db4c96c1SJed Brown      This function is called once per split (it creates a new split each time).  Solve options
1920db4c96c1SJed Brown      for this split will be available under the prefix -fieldsplit_SPLITNAME_.
1921db4c96c1SJed Brown 
19225d4c12cdSJungho Lee      Developer Note: This routine does not actually create the IS representing the split, that is delayed
19235d4c12cdSJungho Lee      until PCSetUp_FieldSplit(), because information about the vector/matrix layouts may not be
19245d4c12cdSJungho Lee      available when this routine is called.
19255d4c12cdSJungho Lee 
1926d32f9abdSBarry Smith .seealso: PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitSetBlockSize(), PCFieldSplitSetIS()
19270971522cSBarry Smith 
19280971522cSBarry Smith @*/
19295d4c12cdSJungho Lee PetscErrorCode  PCFieldSplitSetFields(PC pc,const char splitname[],PetscInt n,const PetscInt *fields,const PetscInt *fields_col)
19300971522cSBarry Smith {
19314ac538c5SBarry Smith   PetscErrorCode ierr;
19320971522cSBarry Smith 
19330971522cSBarry Smith   PetscFunctionBegin;
19340700a824SBarry Smith   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
1935db4c96c1SJed Brown   PetscValidCharPointer(splitname,2);
1936ce94432eSBarry Smith   if (n < 1) SETERRQ2(PetscObjectComm((PetscObject)pc),PETSC_ERR_ARG_OUTOFRANGE,"Provided number of fields %D in split \"%s\" not positive",n,splitname);
1937064a246eSJacob Faibussowitsch   PetscValidIntPointer(fields,4);
19380246f55cSBarry Smith   ierr = PetscTryMethod(pc,"PCFieldSplitSetFields_C",(PC,const char[],PetscInt,const PetscInt*,const PetscInt*),(pc,splitname,n,fields,fields_col));CHKERRQ(ierr);
19390971522cSBarry Smith   PetscFunctionReturn(0);
19400971522cSBarry Smith }
19410971522cSBarry Smith 
1942c84da90fSDmitry Karpeev /*@
1943c84da90fSDmitry Karpeev     PCFieldSplitSetDiagUseAmat - set flag indicating whether to extract diagonal blocks from Amat (rather than Pmat)
1944c84da90fSDmitry Karpeev 
1945c84da90fSDmitry Karpeev     Logically Collective on PC
1946c84da90fSDmitry Karpeev 
1947c84da90fSDmitry Karpeev     Input Parameters:
1948c84da90fSDmitry Karpeev +   pc  - the preconditioner object
1949c84da90fSDmitry Karpeev -   flg - boolean flag indicating whether or not to use Amat to extract the diagonal blocks from
1950c84da90fSDmitry Karpeev 
19519506b623SDmitry Karpeev     Options Database:
19529506b623SDmitry Karpeev .     -pc_fieldsplit_diag_use_amat
1953c84da90fSDmitry Karpeev 
1954c84da90fSDmitry Karpeev     Level: intermediate
1955c84da90fSDmitry Karpeev 
1956c84da90fSDmitry Karpeev .seealso: PCFieldSplitGetDiagUseAmat(), PCFieldSplitSetOffDiagUseAmat(), PCFIELDSPLIT
1957c84da90fSDmitry Karpeev 
1958c84da90fSDmitry Karpeev @*/
1959c84da90fSDmitry Karpeev PetscErrorCode  PCFieldSplitSetDiagUseAmat(PC pc,PetscBool flg)
1960c84da90fSDmitry Karpeev {
1961c84da90fSDmitry Karpeev   PC_FieldSplit  *jac = (PC_FieldSplit*)pc->data;
1962c84da90fSDmitry Karpeev   PetscBool      isfs;
1963c84da90fSDmitry Karpeev   PetscErrorCode ierr;
1964c84da90fSDmitry Karpeev 
1965c84da90fSDmitry Karpeev   PetscFunctionBegin;
1966c84da90fSDmitry Karpeev   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
1967c84da90fSDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)pc,PCFIELDSPLIT,&isfs);CHKERRQ(ierr);
1968c84da90fSDmitry Karpeev   if (!isfs) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"PC not of type %s",PCFIELDSPLIT);
1969c84da90fSDmitry Karpeev   jac->diag_use_amat = flg;
1970c84da90fSDmitry Karpeev   PetscFunctionReturn(0);
1971c84da90fSDmitry Karpeev }
1972c84da90fSDmitry Karpeev 
1973c84da90fSDmitry Karpeev /*@
1974c84da90fSDmitry Karpeev     PCFieldSplitGetDiagUseAmat - get the flag indicating whether to extract diagonal blocks from Amat (rather than Pmat)
1975c84da90fSDmitry Karpeev 
1976c84da90fSDmitry Karpeev     Logically Collective on PC
1977c84da90fSDmitry Karpeev 
1978c84da90fSDmitry Karpeev     Input Parameters:
1979c84da90fSDmitry Karpeev .   pc  - the preconditioner object
1980c84da90fSDmitry Karpeev 
1981c84da90fSDmitry Karpeev     Output Parameters:
1982c84da90fSDmitry Karpeev .   flg - boolean flag indicating whether or not to use Amat to extract the diagonal blocks from
1983c84da90fSDmitry Karpeev 
1984c84da90fSDmitry Karpeev     Level: intermediate
1985c84da90fSDmitry Karpeev 
1986c84da90fSDmitry Karpeev .seealso: PCFieldSplitSetDiagUseAmat(), PCFieldSplitGetOffDiagUseAmat(), PCFIELDSPLIT
1987c84da90fSDmitry Karpeev 
1988c84da90fSDmitry Karpeev @*/
1989c84da90fSDmitry Karpeev PetscErrorCode  PCFieldSplitGetDiagUseAmat(PC pc,PetscBool *flg)
1990c84da90fSDmitry Karpeev {
1991c84da90fSDmitry Karpeev   PC_FieldSplit  *jac = (PC_FieldSplit*)pc->data;
1992c84da90fSDmitry Karpeev   PetscBool      isfs;
1993c84da90fSDmitry Karpeev   PetscErrorCode ierr;
1994c84da90fSDmitry Karpeev 
1995c84da90fSDmitry Karpeev   PetscFunctionBegin;
1996c84da90fSDmitry Karpeev   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
1997534a8f05SLisandro Dalcin   PetscValidBoolPointer(flg,2);
1998c84da90fSDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)pc,PCFIELDSPLIT,&isfs);CHKERRQ(ierr);
1999c84da90fSDmitry Karpeev   if (!isfs) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"PC not of type %s",PCFIELDSPLIT);
2000c84da90fSDmitry Karpeev   *flg = jac->diag_use_amat;
2001c84da90fSDmitry Karpeev   PetscFunctionReturn(0);
2002c84da90fSDmitry Karpeev }
2003c84da90fSDmitry Karpeev 
2004c84da90fSDmitry Karpeev /*@
2005c84da90fSDmitry Karpeev     PCFieldSplitSetOffDiagUseAmat - set flag indicating whether to extract off-diagonal blocks from Amat (rather than Pmat)
2006c84da90fSDmitry Karpeev 
2007c84da90fSDmitry Karpeev     Logically Collective on PC
2008c84da90fSDmitry Karpeev 
2009c84da90fSDmitry Karpeev     Input Parameters:
2010c84da90fSDmitry Karpeev +   pc  - the preconditioner object
2011c84da90fSDmitry Karpeev -   flg - boolean flag indicating whether or not to use Amat to extract the off-diagonal blocks from
2012c84da90fSDmitry Karpeev 
20139506b623SDmitry Karpeev     Options Database:
20149506b623SDmitry Karpeev .     -pc_fieldsplit_off_diag_use_amat
2015c84da90fSDmitry Karpeev 
2016c84da90fSDmitry Karpeev     Level: intermediate
2017c84da90fSDmitry Karpeev 
2018c84da90fSDmitry Karpeev .seealso: PCFieldSplitGetOffDiagUseAmat(), PCFieldSplitSetDiagUseAmat(), PCFIELDSPLIT
2019c84da90fSDmitry Karpeev 
2020c84da90fSDmitry Karpeev @*/
2021c84da90fSDmitry Karpeev PetscErrorCode  PCFieldSplitSetOffDiagUseAmat(PC pc,PetscBool flg)
2022c84da90fSDmitry Karpeev {
2023c84da90fSDmitry Karpeev   PC_FieldSplit *jac = (PC_FieldSplit*)pc->data;
2024c84da90fSDmitry Karpeev   PetscBool      isfs;
2025c84da90fSDmitry Karpeev   PetscErrorCode ierr;
2026c84da90fSDmitry Karpeev 
2027c84da90fSDmitry Karpeev   PetscFunctionBegin;
2028c84da90fSDmitry Karpeev   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
2029c84da90fSDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)pc,PCFIELDSPLIT,&isfs);CHKERRQ(ierr);
2030c84da90fSDmitry Karpeev   if (!isfs) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"PC not of type %s",PCFIELDSPLIT);
2031c84da90fSDmitry Karpeev   jac->offdiag_use_amat = flg;
2032c84da90fSDmitry Karpeev   PetscFunctionReturn(0);
2033c84da90fSDmitry Karpeev }
2034c84da90fSDmitry Karpeev 
2035c84da90fSDmitry Karpeev /*@
2036c84da90fSDmitry Karpeev     PCFieldSplitGetOffDiagUseAmat - get the flag indicating whether to extract off-diagonal blocks from Amat (rather than Pmat)
2037c84da90fSDmitry Karpeev 
2038c84da90fSDmitry Karpeev     Logically Collective on PC
2039c84da90fSDmitry Karpeev 
2040c84da90fSDmitry Karpeev     Input Parameters:
2041c84da90fSDmitry Karpeev .   pc  - the preconditioner object
2042c84da90fSDmitry Karpeev 
2043c84da90fSDmitry Karpeev     Output Parameters:
2044c84da90fSDmitry Karpeev .   flg - boolean flag indicating whether or not to use Amat to extract the off-diagonal blocks from
2045c84da90fSDmitry Karpeev 
2046c84da90fSDmitry Karpeev     Level: intermediate
2047c84da90fSDmitry Karpeev 
2048c84da90fSDmitry Karpeev .seealso: PCFieldSplitSetOffDiagUseAmat(), PCFieldSplitGetDiagUseAmat(), PCFIELDSPLIT
2049c84da90fSDmitry Karpeev 
2050c84da90fSDmitry Karpeev @*/
2051c84da90fSDmitry Karpeev PetscErrorCode  PCFieldSplitGetOffDiagUseAmat(PC pc,PetscBool *flg)
2052c84da90fSDmitry Karpeev {
2053c84da90fSDmitry Karpeev   PC_FieldSplit  *jac = (PC_FieldSplit*)pc->data;
2054c84da90fSDmitry Karpeev   PetscBool      isfs;
2055c84da90fSDmitry Karpeev   PetscErrorCode ierr;
2056c84da90fSDmitry Karpeev 
2057c84da90fSDmitry Karpeev   PetscFunctionBegin;
2058c84da90fSDmitry Karpeev   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
2059534a8f05SLisandro Dalcin   PetscValidBoolPointer(flg,2);
2060c84da90fSDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)pc,PCFIELDSPLIT,&isfs);CHKERRQ(ierr);
2061c84da90fSDmitry Karpeev   if (!isfs) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"PC not of type %s",PCFIELDSPLIT);
2062c84da90fSDmitry Karpeev   *flg = jac->offdiag_use_amat;
2063c84da90fSDmitry Karpeev   PetscFunctionReturn(0);
2064c84da90fSDmitry Karpeev }
2065c84da90fSDmitry Karpeev 
2066218d4943SBarry Smith /*@C
2067704ba839SBarry Smith     PCFieldSplitSetIS - Sets the exact elements for field
2068704ba839SBarry Smith 
2069ad4df100SBarry Smith     Logically Collective on PC
2070704ba839SBarry Smith 
2071704ba839SBarry Smith     Input Parameters:
2072704ba839SBarry Smith +   pc  - the preconditioner context
20730298fd71SBarry Smith .   splitname - name of this split, if NULL the number of the split is used
2074db4c96c1SJed Brown -   is - the index set that defines the vector elements in this field
2075704ba839SBarry Smith 
2076a6ffb8dbSJed Brown     Notes:
2077a6ffb8dbSJed Brown     Use PCFieldSplitSetFields(), for fields defined by strided types.
2078a6ffb8dbSJed Brown 
2079db4c96c1SJed Brown     This function is called once per split (it creates a new split each time).  Solve options
2080db4c96c1SJed Brown     for this split will be available under the prefix -fieldsplit_SPLITNAME_.
2081d32f9abdSBarry Smith 
2082704ba839SBarry Smith     Level: intermediate
2083704ba839SBarry Smith 
2084704ba839SBarry Smith .seealso: PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitSetBlockSize()
2085704ba839SBarry Smith 
2086704ba839SBarry Smith @*/
20877087cfbeSBarry Smith PetscErrorCode  PCFieldSplitSetIS(PC pc,const char splitname[],IS is)
2088704ba839SBarry Smith {
20894ac538c5SBarry Smith   PetscErrorCode ierr;
2090704ba839SBarry Smith 
2091704ba839SBarry Smith   PetscFunctionBegin;
20920700a824SBarry Smith   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
20937b62db95SJungho Lee   if (splitname) PetscValidCharPointer(splitname,2);
2094db4c96c1SJed Brown   PetscValidHeaderSpecific(is,IS_CLASSID,3);
2095ccc738f7SBarry Smith   ierr = PetscTryMethod(pc,"PCFieldSplitSetIS_C",(PC,const char[],IS),(pc,splitname,is));CHKERRQ(ierr);
2096704ba839SBarry Smith   PetscFunctionReturn(0);
2097704ba839SBarry Smith }
2098704ba839SBarry Smith 
209994ef8ddeSSatish Balay /*@C
210057a9adfeSMatthew G Knepley     PCFieldSplitGetIS - Retrieves the elements for a field as an IS
210157a9adfeSMatthew G Knepley 
210257a9adfeSMatthew G Knepley     Logically Collective on PC
210357a9adfeSMatthew G Knepley 
210457a9adfeSMatthew G Knepley     Input Parameters:
210557a9adfeSMatthew G Knepley +   pc  - the preconditioner context
210657a9adfeSMatthew G Knepley -   splitname - name of this split
210757a9adfeSMatthew G Knepley 
210857a9adfeSMatthew G Knepley     Output Parameter:
21090298fd71SBarry Smith -   is - the index set that defines the vector elements in this field, or NULL if the field is not found
211057a9adfeSMatthew G Knepley 
211157a9adfeSMatthew G Knepley     Level: intermediate
211257a9adfeSMatthew G Knepley 
211357a9adfeSMatthew G Knepley .seealso: PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitSetIS()
211457a9adfeSMatthew G Knepley 
211557a9adfeSMatthew G Knepley @*/
211657a9adfeSMatthew G Knepley PetscErrorCode PCFieldSplitGetIS(PC pc,const char splitname[],IS *is)
211757a9adfeSMatthew G Knepley {
211857a9adfeSMatthew G Knepley   PetscErrorCode ierr;
211957a9adfeSMatthew G Knepley 
212057a9adfeSMatthew G Knepley   PetscFunctionBegin;
212157a9adfeSMatthew G Knepley   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
212257a9adfeSMatthew G Knepley   PetscValidCharPointer(splitname,2);
212357a9adfeSMatthew G Knepley   PetscValidPointer(is,3);
212457a9adfeSMatthew G Knepley   {
212557a9adfeSMatthew G Knepley     PC_FieldSplit     *jac  = (PC_FieldSplit*) pc->data;
212657a9adfeSMatthew G Knepley     PC_FieldSplitLink ilink = jac->head;
212757a9adfeSMatthew G Knepley     PetscBool         found;
212857a9adfeSMatthew G Knepley 
21290298fd71SBarry Smith     *is = NULL;
213057a9adfeSMatthew G Knepley     while (ilink) {
213157a9adfeSMatthew G Knepley       ierr = PetscStrcmp(ilink->splitname, splitname, &found);CHKERRQ(ierr);
213257a9adfeSMatthew G Knepley       if (found) {
213357a9adfeSMatthew G Knepley         *is = ilink->is;
213457a9adfeSMatthew G Knepley         break;
213557a9adfeSMatthew G Knepley       }
213657a9adfeSMatthew G Knepley       ilink = ilink->next;
213757a9adfeSMatthew G Knepley     }
213857a9adfeSMatthew G Knepley   }
213957a9adfeSMatthew G Knepley   PetscFunctionReturn(0);
214057a9adfeSMatthew G Knepley }
214157a9adfeSMatthew G Knepley 
2142998f007dSPierre Jolivet /*@C
2143998f007dSPierre Jolivet     PCFieldSplitGetISByIndex - Retrieves the elements for a given index field as an IS
2144998f007dSPierre Jolivet 
2145998f007dSPierre Jolivet     Logically Collective on PC
2146998f007dSPierre Jolivet 
2147998f007dSPierre Jolivet     Input Parameters:
2148998f007dSPierre Jolivet +   pc  - the preconditioner context
2149998f007dSPierre Jolivet -   index - index of this split
2150998f007dSPierre Jolivet 
2151998f007dSPierre Jolivet     Output Parameter:
2152998f007dSPierre Jolivet -   is - the index set that defines the vector elements in this field
2153998f007dSPierre Jolivet 
2154998f007dSPierre Jolivet     Level: intermediate
2155998f007dSPierre Jolivet 
2156998f007dSPierre Jolivet .seealso: PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitGetIS(), PCFieldSplitSetIS()
2157998f007dSPierre Jolivet 
2158998f007dSPierre Jolivet @*/
2159998f007dSPierre Jolivet PetscErrorCode PCFieldSplitGetISByIndex(PC pc,PetscInt index,IS *is)
2160998f007dSPierre Jolivet {
2161998f007dSPierre Jolivet   PetscErrorCode ierr;
2162998f007dSPierre Jolivet 
2163998f007dSPierre Jolivet   PetscFunctionBegin;
2164998f007dSPierre Jolivet   if (index < 0) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Negative field %D requested",index);
2165998f007dSPierre Jolivet   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
2166998f007dSPierre Jolivet   PetscValidPointer(is,3);
2167998f007dSPierre Jolivet   {
2168998f007dSPierre Jolivet     PC_FieldSplit     *jac  = (PC_FieldSplit*) pc->data;
2169998f007dSPierre Jolivet     PC_FieldSplitLink ilink = jac->head;
2170998f007dSPierre Jolivet     PetscInt          i     = 0;
2171998f007dSPierre Jolivet     if (index >= jac->nsplits) SETERRQ2(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Field %D requested but only %D exist",index,jac->nsplits);
2172998f007dSPierre Jolivet 
2173998f007dSPierre Jolivet     while (i < index) {
2174998f007dSPierre Jolivet       ilink = ilink->next;
2175998f007dSPierre Jolivet       ++i;
2176998f007dSPierre Jolivet     }
2177998f007dSPierre Jolivet     ierr = PCFieldSplitGetIS(pc,ilink->splitname,is);CHKERRQ(ierr);
2178998f007dSPierre Jolivet   }
2179998f007dSPierre Jolivet   PetscFunctionReturn(0);
2180998f007dSPierre Jolivet }
2181998f007dSPierre Jolivet 
218251f519a2SBarry Smith /*@
218351f519a2SBarry Smith     PCFieldSplitSetBlockSize - Sets the block size for defining where fields start in the
218451f519a2SBarry Smith       fieldsplit preconditioner. If not set the matrix block size is used.
218551f519a2SBarry Smith 
2186ad4df100SBarry Smith     Logically Collective on PC
218751f519a2SBarry Smith 
218851f519a2SBarry Smith     Input Parameters:
218951f519a2SBarry Smith +   pc  - the preconditioner context
219051f519a2SBarry Smith -   bs - the block size
219151f519a2SBarry Smith 
219251f519a2SBarry Smith     Level: intermediate
219351f519a2SBarry Smith 
219451f519a2SBarry Smith .seealso: PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitSetFields()
219551f519a2SBarry Smith 
219651f519a2SBarry Smith @*/
21977087cfbeSBarry Smith PetscErrorCode  PCFieldSplitSetBlockSize(PC pc,PetscInt bs)
219851f519a2SBarry Smith {
21994ac538c5SBarry Smith   PetscErrorCode ierr;
220051f519a2SBarry Smith 
220151f519a2SBarry Smith   PetscFunctionBegin;
22020700a824SBarry Smith   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
2203c5eb9154SBarry Smith   PetscValidLogicalCollectiveInt(pc,bs,2);
22044ac538c5SBarry Smith   ierr = PetscTryMethod(pc,"PCFieldSplitSetBlockSize_C",(PC,PetscInt),(pc,bs));CHKERRQ(ierr);
220551f519a2SBarry Smith   PetscFunctionReturn(0);
220651f519a2SBarry Smith }
220751f519a2SBarry Smith 
22080971522cSBarry Smith /*@C
220969a612a9SBarry Smith    PCFieldSplitGetSubKSP - Gets the KSP contexts for all splits
22100971522cSBarry Smith 
221169a612a9SBarry Smith    Collective on KSP
22120971522cSBarry Smith 
22130971522cSBarry Smith    Input Parameter:
22140971522cSBarry Smith .  pc - the preconditioner context
22150971522cSBarry Smith 
22160971522cSBarry Smith    Output Parameters:
221713e0d083SBarry Smith +  n - the number of splits
22183111de3cSBarry Smith -  subksp - the array of KSP contexts
22190971522cSBarry Smith 
22200971522cSBarry Smith    Note:
22219a4f7e47SBarry Smith    After PCFieldSplitGetSubKSP() the array of KSPs is to be freed by the user with PetscFree()
2222d32f9abdSBarry Smith    (not the KSP just the array that contains them).
22230971522cSBarry Smith 
2224285fb4e2SStefano Zampini    You must call PCSetUp() before calling PCFieldSplitGetSubKSP().
2225285fb4e2SStefano Zampini 
2226285fb4e2SStefano Zampini    If the fieldsplit is of type PC_COMPOSITE_SCHUR, it returns the KSP object used inside the
2227285fb4e2SStefano Zampini    Schur complement and the KSP object used to iterate over the Schur complement.
2228a51937d4SCarola Kruse    To access all the KSP objects used in PC_COMPOSITE_SCHUR, use PCFieldSplitSchurGetSubKSP().
2229a51937d4SCarola Kruse 
2230a51937d4SCarola Kruse    If the fieldsplit is of type PC_COMPOSITE_GKB, it returns the KSP object used to solve the
2231a51937d4SCarola Kruse    inner linear system defined by the matrix H in each loop.
22320971522cSBarry Smith 
2233196cc216SBarry Smith    Fortran Usage: You must pass in a KSP array that is large enough to contain all the local KSPs.
22342bf68e3eSBarry Smith       You can call PCFieldSplitGetSubKSP(pc,n,PETSC_NULL_KSP,ierr) to determine how large the
2235196cc216SBarry Smith       KSP array must be.
2236196cc216SBarry Smith 
22370971522cSBarry Smith    Level: advanced
22380971522cSBarry Smith 
22390971522cSBarry Smith .seealso: PCFIELDSPLIT
22400971522cSBarry Smith @*/
22417087cfbeSBarry Smith PetscErrorCode  PCFieldSplitGetSubKSP(PC pc,PetscInt *n,KSP *subksp[])
22420971522cSBarry Smith {
22434ac538c5SBarry Smith   PetscErrorCode ierr;
22440971522cSBarry Smith 
22450971522cSBarry Smith   PetscFunctionBegin;
22460700a824SBarry Smith   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
224713e0d083SBarry Smith   if (n) PetscValidIntPointer(n,2);
22484ac538c5SBarry Smith   ierr = PetscUseMethod(pc,"PCFieldSplitGetSubKSP_C",(PC,PetscInt*,KSP **),(pc,n,subksp));CHKERRQ(ierr);
22490971522cSBarry Smith   PetscFunctionReturn(0);
22500971522cSBarry Smith }
22510971522cSBarry Smith 
2252285fb4e2SStefano Zampini /*@C
2253285fb4e2SStefano Zampini    PCFieldSplitSchurGetSubKSP - Gets the KSP contexts used inside the Schur complement based PCFIELDSPLIT
2254285fb4e2SStefano Zampini 
2255285fb4e2SStefano Zampini    Collective on KSP
2256285fb4e2SStefano Zampini 
2257285fb4e2SStefano Zampini    Input Parameter:
2258285fb4e2SStefano Zampini .  pc - the preconditioner context
2259285fb4e2SStefano Zampini 
2260285fb4e2SStefano Zampini    Output Parameters:
2261285fb4e2SStefano Zampini +  n - the number of splits
2262285fb4e2SStefano Zampini -  subksp - the array of KSP contexts
2263285fb4e2SStefano Zampini 
2264285fb4e2SStefano Zampini    Note:
2265285fb4e2SStefano Zampini    After PCFieldSplitSchurGetSubKSP() the array of KSPs is to be freed by the user with PetscFree()
2266285fb4e2SStefano Zampini    (not the KSP just the array that contains them).
2267285fb4e2SStefano Zampini 
2268285fb4e2SStefano Zampini    You must call PCSetUp() before calling PCFieldSplitSchurGetSubKSP().
2269285fb4e2SStefano Zampini 
2270285fb4e2SStefano Zampini    If the fieldsplit type is of type PC_COMPOSITE_SCHUR, it returns (in order)
2271285fb4e2SStefano Zampini    - the KSP used for the (1,1) block
2272285fb4e2SStefano Zampini    - the KSP used for the Schur complement (not the one used for the interior Schur solver)
2273285fb4e2SStefano Zampini    - the KSP used for the (1,1) block in the upper triangular factor (if different from that of the (1,1) block).
2274285fb4e2SStefano Zampini 
2275285fb4e2SStefano Zampini    It returns a null array if the fieldsplit is not of type PC_COMPOSITE_SCHUR; in this case, you should use PCFieldSplitGetSubKSP().
2276285fb4e2SStefano Zampini 
2277285fb4e2SStefano Zampini    Fortran Usage: You must pass in a KSP array that is large enough to contain all the local KSPs.
2278285fb4e2SStefano Zampini       You can call PCFieldSplitSchurGetSubKSP(pc,n,PETSC_NULL_KSP,ierr) to determine how large the
2279285fb4e2SStefano Zampini       KSP array must be.
2280285fb4e2SStefano Zampini 
2281285fb4e2SStefano Zampini    Level: advanced
2282285fb4e2SStefano Zampini 
2283285fb4e2SStefano Zampini .seealso: PCFIELDSPLIT
2284285fb4e2SStefano Zampini @*/
2285285fb4e2SStefano Zampini PetscErrorCode  PCFieldSplitSchurGetSubKSP(PC pc,PetscInt *n,KSP *subksp[])
2286285fb4e2SStefano Zampini {
2287285fb4e2SStefano Zampini   PetscErrorCode ierr;
2288285fb4e2SStefano Zampini 
2289285fb4e2SStefano Zampini   PetscFunctionBegin;
2290285fb4e2SStefano Zampini   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
2291285fb4e2SStefano Zampini   if (n) PetscValidIntPointer(n,2);
2292285fb4e2SStefano Zampini   ierr = PetscUseMethod(pc,"PCFieldSplitSchurGetSubKSP_C",(PC,PetscInt*,KSP **),(pc,n,subksp));CHKERRQ(ierr);
2293285fb4e2SStefano Zampini   PetscFunctionReturn(0);
2294285fb4e2SStefano Zampini }
2295285fb4e2SStefano Zampini 
2296e69d4d44SBarry Smith /*@
2297a1e3cbf9SBarry Smith     PCFieldSplitSetSchurPre -  Indicates from what operator the preconditioner is constructucted for the Schur complement.
2298a1e3cbf9SBarry Smith       The default is the A11 matrix.
2299e69d4d44SBarry Smith 
2300e69d4d44SBarry Smith     Collective on PC
2301e69d4d44SBarry Smith 
2302e69d4d44SBarry Smith     Input Parameters:
2303e69d4d44SBarry Smith +   pc      - the preconditioner context
23046fdd48a9SBarry Smith .   ptype   - which matrix to use for preconditioning the Schur complement: PC_FIELDSPLIT_SCHUR_PRE_A11 (default), PC_FIELDSPLIT_SCHUR_PRE_SELF, PC_FIELDSPLIT_SCHUR_PRE_USER
23056fdd48a9SBarry Smith               PC_FIELDSPLIT_SCHUR_PRE_SELFP, and PC_FIELDSPLIT_SCHUR_PRE_FULL
23060298fd71SBarry Smith -   userpre - matrix to use for preconditioning, or NULL
2307084e4875SJed Brown 
2308e69d4d44SBarry Smith     Options Database:
2309a1e3cbf9SBarry Smith +    -pc_fieldsplit_schur_precondition <self,selfp,user,a11,full> - default is a11. See notes for meaning of various arguments
2310a1e3cbf9SBarry Smith -    -fieldsplit_1_pc_type <pctype> - the preconditioner algorithm that is used to construct the preconditioner from the operator
2311e69d4d44SBarry Smith 
2312fd1303e9SJungho Lee     Notes:
2313fd1303e9SJungho Lee $    If ptype is
2314a1e3cbf9SBarry Smith $        a11 - the preconditioner for the Schur complement is generated from the block diagonal part of the preconditioner
231553f2277eSBarry Smith $        matrix associated with the Schur complement (i.e. A11), not the Schur complement matrix
2316a1e3cbf9SBarry Smith $        self - the preconditioner for the Schur complement is generated from the symbolic representation of the Schur complement matrix:
2317a6a584a2SBarry Smith $             The only preconditioner that currently works with this symbolic respresentation matrix object is the PCLSC
2318fd1303e9SJungho Lee $             preconditioner
2319a1e3cbf9SBarry Smith $        user - the preconditioner for the Schur complement is generated from the user provided matrix (pre argument
23206fdd48a9SBarry Smith $             to this function).
2321a1e3cbf9SBarry Smith $        selfp - the preconditioning for the Schur complement is generated from an explicitly-assembled approximation Sp = A11 - A10 inv(diag(A00)) A01
23221d71051fSDmitry Karpeev $             This is only a good preconditioner when diag(A00) is a good preconditioner for A00. Optionally, A00 can be
23236fdd48a9SBarry Smith $             lumped before extracting the diagonal using the additional option -fieldsplit_1_mat_schur_complement_ainv_type lump
2324a1e3cbf9SBarry Smith $        full - the preconditioner for the Schur complement is generated from the exact Schur complement matrix representation computed internally by PCFIELDSPLIT (this is expensive)
23256fdd48a9SBarry Smith $             useful mostly as a test that the Schur complement approach can work for your problem
2326fd1303e9SJungho Lee 
2327e87fab1bSBarry Smith      When solving a saddle point problem, where the A11 block is identically zero, using a11 as the ptype only makes sense
2328fd1303e9SJungho Lee     with the additional option -fieldsplit_1_pc_type none. Usually for saddle point problems one would use a ptype of self and
2329a7476a74SDmitry Karpeev     -fieldsplit_1_pc_type lsc which uses the least squares commutator to compute a preconditioner for the Schur complement.
2330fd1303e9SJungho Lee 
2331e69d4d44SBarry Smith     Level: intermediate
2332e69d4d44SBarry Smith 
23331d71051fSDmitry Karpeev .seealso: PCFieldSplitGetSchurPre(), PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitSetFields(), PCFieldSplitSchurPreType,
23341d71051fSDmitry Karpeev           MatSchurComplementSetAinvType(), PCLSC
2335e69d4d44SBarry Smith 
2336e69d4d44SBarry Smith @*/
233729f8a81cSJed Brown PetscErrorCode PCFieldSplitSetSchurPre(PC pc,PCFieldSplitSchurPreType ptype,Mat pre)
2338e69d4d44SBarry Smith {
23394ac538c5SBarry Smith   PetscErrorCode ierr;
2340e69d4d44SBarry Smith 
2341e69d4d44SBarry Smith   PetscFunctionBegin;
23420700a824SBarry Smith   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
234329f8a81cSJed Brown   ierr = PetscTryMethod(pc,"PCFieldSplitSetSchurPre_C",(PC,PCFieldSplitSchurPreType,Mat),(pc,ptype,pre));CHKERRQ(ierr);
2344e69d4d44SBarry Smith   PetscFunctionReturn(0);
2345e69d4d44SBarry Smith }
2346686bed4dSStefano Zampini 
234729f8a81cSJed Brown PetscErrorCode PCFieldSplitSchurPrecondition(PC pc,PCFieldSplitSchurPreType ptype,Mat pre) {return PCFieldSplitSetSchurPre(pc,ptype,pre);} /* Deprecated name */
2348e69d4d44SBarry Smith 
234937a82bf0SJed Brown /*@
235037a82bf0SJed Brown     PCFieldSplitGetSchurPre - For Schur complement fieldsplit, determine how the Schur complement will be
235129f8a81cSJed Brown     preconditioned.  See PCFieldSplitSetSchurPre() for details.
235237a82bf0SJed Brown 
235337a82bf0SJed Brown     Logically Collective on PC
235437a82bf0SJed Brown 
235537a82bf0SJed Brown     Input Parameters:
235637a82bf0SJed Brown .   pc      - the preconditioner context
235737a82bf0SJed Brown 
235837a82bf0SJed Brown     Output Parameters:
235937a82bf0SJed 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
236037a82bf0SJed Brown -   userpre - matrix to use for preconditioning (with PC_FIELDSPLIT_PRE_USER), or NULL
236137a82bf0SJed Brown 
236237a82bf0SJed Brown     Level: intermediate
236337a82bf0SJed Brown 
236429f8a81cSJed Brown .seealso: PCFieldSplitSetSchurPre(), PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitSetFields(), PCFieldSplitSchurPreType, PCLSC
236537a82bf0SJed Brown 
236637a82bf0SJed Brown @*/
236737a82bf0SJed Brown PetscErrorCode PCFieldSplitGetSchurPre(PC pc,PCFieldSplitSchurPreType *ptype,Mat *pre)
236837a82bf0SJed Brown {
236937a82bf0SJed Brown   PetscErrorCode ierr;
237037a82bf0SJed Brown 
237137a82bf0SJed Brown   PetscFunctionBegin;
237237a82bf0SJed Brown   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
237337a82bf0SJed Brown   ierr = PetscUseMethod(pc,"PCFieldSplitGetSchurPre_C",(PC,PCFieldSplitSchurPreType*,Mat*),(pc,ptype,pre));CHKERRQ(ierr);
2374e69d4d44SBarry Smith   PetscFunctionReturn(0);
2375e69d4d44SBarry Smith }
2376e69d4d44SBarry Smith 
237745e7fc46SDmitry Karpeev /*@
2378470b340bSDmitry Karpeev     PCFieldSplitSchurGetS -  extract the MatSchurComplement object used by this PC in case it needs to be configured separately
237945e7fc46SDmitry Karpeev 
238045e7fc46SDmitry Karpeev     Not collective
238145e7fc46SDmitry Karpeev 
238245e7fc46SDmitry Karpeev     Input Parameter:
238345e7fc46SDmitry Karpeev .   pc      - the preconditioner context
238445e7fc46SDmitry Karpeev 
238545e7fc46SDmitry Karpeev     Output Parameter:
2386470b340bSDmitry Karpeev .   S       - the Schur complement matrix
238745e7fc46SDmitry Karpeev 
2388470b340bSDmitry Karpeev     Notes:
2389470b340bSDmitry Karpeev     This matrix should not be destroyed using MatDestroy(); rather, use PCFieldSplitSchurRestoreS().
239045e7fc46SDmitry Karpeev 
239145e7fc46SDmitry Karpeev     Level: advanced
239245e7fc46SDmitry Karpeev 
239329f8a81cSJed Brown .seealso: PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitSchurPreType, PCFieldSplitSetSchurPre(), MatSchurComplement, PCFieldSplitSchurRestoreS()
239445e7fc46SDmitry Karpeev 
239545e7fc46SDmitry Karpeev @*/
2396470b340bSDmitry Karpeev PetscErrorCode  PCFieldSplitSchurGetS(PC pc,Mat *S)
239745e7fc46SDmitry Karpeev {
239845e7fc46SDmitry Karpeev   PetscErrorCode ierr;
239945e7fc46SDmitry Karpeev   const char*    t;
240045e7fc46SDmitry Karpeev   PetscBool      isfs;
240145e7fc46SDmitry Karpeev   PC_FieldSplit  *jac;
240245e7fc46SDmitry Karpeev 
240345e7fc46SDmitry Karpeev   PetscFunctionBegin;
240445e7fc46SDmitry Karpeev   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
240545e7fc46SDmitry Karpeev   ierr = PetscObjectGetType((PetscObject)pc,&t);CHKERRQ(ierr);
240645e7fc46SDmitry Karpeev   ierr = PetscStrcmp(t,PCFIELDSPLIT,&isfs);CHKERRQ(ierr);
240745e7fc46SDmitry Karpeev   if (!isfs) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Expected PC of type PCFIELDSPLIT, got %s instead",t);
240845e7fc46SDmitry Karpeev   jac = (PC_FieldSplit*)pc->data;
2409470b340bSDmitry 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);
2410470b340bSDmitry Karpeev   if (S) *S = jac->schur;
241145e7fc46SDmitry Karpeev   PetscFunctionReturn(0);
241245e7fc46SDmitry Karpeev }
241345e7fc46SDmitry Karpeev 
2414470b340bSDmitry Karpeev /*@
2415470b340bSDmitry Karpeev     PCFieldSplitSchurRestoreS -  restores the MatSchurComplement object used by this PC
2416470b340bSDmitry Karpeev 
2417470b340bSDmitry Karpeev     Not collective
2418470b340bSDmitry Karpeev 
2419470b340bSDmitry Karpeev     Input Parameters:
2420470b340bSDmitry Karpeev +   pc      - the preconditioner context
2421a2b725a8SWilliam Gropp -   S       - the Schur complement matrix
2422470b340bSDmitry Karpeev 
2423470b340bSDmitry Karpeev     Level: advanced
2424470b340bSDmitry Karpeev 
242529f8a81cSJed Brown .seealso: PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitSchurPreType, PCFieldSplitSetSchurPre(), MatSchurComplement, PCFieldSplitSchurGetS()
2426470b340bSDmitry Karpeev 
2427470b340bSDmitry Karpeev @*/
2428bca69d2bSDmitry Karpeev PetscErrorCode  PCFieldSplitSchurRestoreS(PC pc,Mat *S)
2429470b340bSDmitry Karpeev {
2430470b340bSDmitry Karpeev   PetscErrorCode ierr;
2431470b340bSDmitry Karpeev   const char*    t;
2432470b340bSDmitry Karpeev   PetscBool      isfs;
2433470b340bSDmitry Karpeev   PC_FieldSplit  *jac;
2434470b340bSDmitry Karpeev 
2435470b340bSDmitry Karpeev   PetscFunctionBegin;
2436470b340bSDmitry Karpeev   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
2437470b340bSDmitry Karpeev   ierr = PetscObjectGetType((PetscObject)pc,&t);CHKERRQ(ierr);
2438470b340bSDmitry Karpeev   ierr = PetscStrcmp(t,PCFIELDSPLIT,&isfs);CHKERRQ(ierr);
2439470b340bSDmitry Karpeev   if (!isfs) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Expected PC of type PCFIELDSPLIT, got %s instead",t);
2440470b340bSDmitry Karpeev   jac = (PC_FieldSplit*)pc->data;
2441470b340bSDmitry 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);
2442bca69d2bSDmitry Karpeev   if (!S || *S != jac->schur) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"MatSchurComplement restored is not the same as gotten");
2443470b340bSDmitry Karpeev   PetscFunctionReturn(0);
2444470b340bSDmitry Karpeev }
2445470b340bSDmitry Karpeev 
244629f8a81cSJed Brown static PetscErrorCode  PCFieldSplitSetSchurPre_FieldSplit(PC pc,PCFieldSplitSchurPreType ptype,Mat pre)
2447e69d4d44SBarry Smith {
2448e69d4d44SBarry Smith   PC_FieldSplit  *jac = (PC_FieldSplit*)pc->data;
2449084e4875SJed Brown   PetscErrorCode ierr;
2450e69d4d44SBarry Smith 
2451e69d4d44SBarry Smith   PetscFunctionBegin;
2452084e4875SJed Brown   jac->schurpre = ptype;
2453a7476a74SDmitry Karpeev   if (ptype == PC_FIELDSPLIT_SCHUR_PRE_USER && pre) {
24546bf464f9SBarry Smith     ierr            = MatDestroy(&jac->schur_user);CHKERRQ(ierr);
2455084e4875SJed Brown     jac->schur_user = pre;
2456084e4875SJed Brown     ierr            = PetscObjectReference((PetscObject)jac->schur_user);CHKERRQ(ierr);
2457084e4875SJed Brown   }
2458e69d4d44SBarry Smith   PetscFunctionReturn(0);
2459e69d4d44SBarry Smith }
2460e69d4d44SBarry Smith 
246137a82bf0SJed Brown static PetscErrorCode  PCFieldSplitGetSchurPre_FieldSplit(PC pc,PCFieldSplitSchurPreType *ptype,Mat *pre)
246237a82bf0SJed Brown {
246337a82bf0SJed Brown   PC_FieldSplit  *jac = (PC_FieldSplit*)pc->data;
246437a82bf0SJed Brown 
246537a82bf0SJed Brown   PetscFunctionBegin;
246637a82bf0SJed Brown   *ptype = jac->schurpre;
246737a82bf0SJed Brown   *pre   = jac->schur_user;
246837a82bf0SJed Brown   PetscFunctionReturn(0);
246937a82bf0SJed Brown }
247037a82bf0SJed Brown 
2471ab1df9f5SJed Brown /*@
24720ffb0e17SBarry Smith     PCFieldSplitSetSchurFactType -  sets which blocks of the approximate block factorization to retain in the preconditioner
2473ab1df9f5SJed Brown 
2474ab1df9f5SJed Brown     Collective on PC
2475ab1df9f5SJed Brown 
2476ab1df9f5SJed Brown     Input Parameters:
2477ab1df9f5SJed Brown +   pc  - the preconditioner context
2478c9c6ffaaSJed Brown -   ftype - which blocks of factorization to retain, PC_FIELDSPLIT_SCHUR_FACT_FULL is default
2479ab1df9f5SJed Brown 
2480ab1df9f5SJed Brown     Options Database:
2481c9c6ffaaSJed Brown .     -pc_fieldsplit_schur_fact_type <diag,lower,upper,full> default is full
2482ab1df9f5SJed Brown 
2483ab1df9f5SJed Brown     Level: intermediate
2484ab1df9f5SJed Brown 
2485ab1df9f5SJed Brown     Notes:
2486ab1df9f5SJed Brown     The FULL factorization is
2487ab1df9f5SJed Brown 
24880ffb0e17SBarry Smith $   (A   B)  = (1       0) (A   0) (1  Ainv*B)  = L D U
24890ffb0e17SBarry Smith $   (C   E)    (C*Ainv  1) (0   S) (0     1)
2490ab1df9f5SJed Brown 
24910ffb0e17SBarry Smith     where S = E - C*Ainv*B. In practice, the full factorization is applied via block triangular solves with the grouping L*(D*U). UPPER uses D*U, LOWER uses L*D,
2492c096484dSStefano Zampini     and DIAG is the diagonal part with the sign of S flipped (because this makes the preconditioner positive definite for many formulations, thus allowing the use of KSPMINRES). Sign flipping of S can be turned off with PCFieldSplitSetSchurScale().
2493ab1df9f5SJed Brown 
24940ffb0e17SBarry Smith $    If A and S are solved exactly
24950ffb0e17SBarry Smith $      *) FULL factorization is a direct solver.
24960ffb0e17SBarry Smith $      *) The preconditioned operator with LOWER or UPPER has all eigenvalues equal to 1 and minimal polynomial of degree 2, so KSPGMRES converges in 2 iterations.
24970ffb0e17SBarry Smith $      *) With DIAG, the preconditioned operator has three distinct nonzero eigenvalues and minimal polynomial of degree at most 4, so KSPGMRES converges in at most 4 iterations.
2498ab1df9f5SJed Brown 
24990ffb0e17SBarry Smith     If the iteration count is very low, consider using KSPFGMRES or KSPGCR which can use one less preconditioner
25000ffb0e17SBarry 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.
25010ffb0e17SBarry Smith 
25020ffb0e17SBarry Smith     For symmetric problems in which A is positive definite and S is negative definite, DIAG can be used with KSPMINRES.
25030ffb0e17SBarry Smith 
25040ffb0e17SBarry Smith     Note that a flexible method like KSPFGMRES or KSPGCR must be used if the fieldsplit preconditioner is nonlinear (e.g. a few iterations of a Krylov method is used to solve with A or S).
2505ab1df9f5SJed Brown 
2506ab1df9f5SJed Brown     References:
250796a0c994SBarry Smith +   1. - Murphy, Golub, and Wathen, A note on preconditioning indefinite linear systems, SIAM J. Sci. Comput., 21 (2000).
250896a0c994SBarry Smith -   2. - Ipsen, A note on preconditioning nonsymmetric matrices, SIAM J. Sci. Comput., 23 (2001).
2509ab1df9f5SJed Brown 
2510c096484dSStefano Zampini .seealso: PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitSetFields(), PCFieldSplitSchurPreType, PCFieldSplitSetSchurScale()
2511ab1df9f5SJed Brown @*/
2512c9c6ffaaSJed Brown PetscErrorCode  PCFieldSplitSetSchurFactType(PC pc,PCFieldSplitSchurFactType ftype)
2513ab1df9f5SJed Brown {
2514ab1df9f5SJed Brown   PetscErrorCode ierr;
2515ab1df9f5SJed Brown 
2516ab1df9f5SJed Brown   PetscFunctionBegin;
2517ab1df9f5SJed Brown   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
2518c9c6ffaaSJed Brown   ierr = PetscTryMethod(pc,"PCFieldSplitSetSchurFactType_C",(PC,PCFieldSplitSchurFactType),(pc,ftype));CHKERRQ(ierr);
2519ab1df9f5SJed Brown   PetscFunctionReturn(0);
2520ab1df9f5SJed Brown }
2521ab1df9f5SJed Brown 
25221e6b0712SBarry Smith static PetscErrorCode PCFieldSplitSetSchurFactType_FieldSplit(PC pc,PCFieldSplitSchurFactType ftype)
2523ab1df9f5SJed Brown {
2524ab1df9f5SJed Brown   PC_FieldSplit *jac = (PC_FieldSplit*)pc->data;
2525ab1df9f5SJed Brown 
2526ab1df9f5SJed Brown   PetscFunctionBegin;
2527ab1df9f5SJed Brown   jac->schurfactorization = ftype;
2528ab1df9f5SJed Brown   PetscFunctionReturn(0);
2529ab1df9f5SJed Brown }
2530ab1df9f5SJed Brown 
2531c096484dSStefano Zampini /*@
2532c096484dSStefano Zampini     PCFieldSplitSetSchurScale -  Controls the sign flip of S for PC_FIELDSPLIT_SCHUR_FACT_DIAG.
2533c096484dSStefano Zampini 
2534c096484dSStefano Zampini     Collective on PC
2535c096484dSStefano Zampini 
2536c096484dSStefano Zampini     Input Parameters:
2537c096484dSStefano Zampini +   pc    - the preconditioner context
2538c096484dSStefano Zampini -   scale - scaling factor for the Schur complement
2539c096484dSStefano Zampini 
2540c096484dSStefano Zampini     Options Database:
2541c096484dSStefano Zampini .     -pc_fieldsplit_schur_scale - default is -1.0
2542c096484dSStefano Zampini 
2543c096484dSStefano Zampini     Level: intermediate
2544c096484dSStefano Zampini 
2545c096484dSStefano Zampini .seealso: PCFIELDSPLIT, PCFieldSplitSetFields(), PCFieldSplitSchurFactType, PCFieldSplitSetSchurScale()
2546c096484dSStefano Zampini @*/
2547c096484dSStefano Zampini PetscErrorCode PCFieldSplitSetSchurScale(PC pc,PetscScalar scale)
2548c096484dSStefano Zampini {
2549c096484dSStefano Zampini   PetscErrorCode ierr;
2550c096484dSStefano Zampini 
2551c096484dSStefano Zampini   PetscFunctionBegin;
2552c096484dSStefano Zampini   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
2553c096484dSStefano Zampini   PetscValidLogicalCollectiveScalar(pc,scale,2);
2554c096484dSStefano Zampini   ierr = PetscTryMethod(pc,"PCFieldSplitSetSchurScale_C",(PC,PetscScalar),(pc,scale));CHKERRQ(ierr);
2555c096484dSStefano Zampini   PetscFunctionReturn(0);
2556c096484dSStefano Zampini }
2557c096484dSStefano Zampini 
2558c096484dSStefano Zampini static PetscErrorCode PCFieldSplitSetSchurScale_FieldSplit(PC pc,PetscScalar scale)
2559c096484dSStefano Zampini {
2560c096484dSStefano Zampini   PC_FieldSplit *jac = (PC_FieldSplit*)pc->data;
2561c096484dSStefano Zampini 
2562c096484dSStefano Zampini   PetscFunctionBegin;
2563c096484dSStefano Zampini   jac->schurscale = scale;
2564c096484dSStefano Zampini   PetscFunctionReturn(0);
2565c096484dSStefano Zampini }
2566c096484dSStefano Zampini 
256730ad9308SMatthew Knepley /*@C
25688c03b21aSDmitry Karpeev    PCFieldSplitGetSchurBlocks - Gets all matrix blocks for the Schur complement
256930ad9308SMatthew Knepley 
257030ad9308SMatthew Knepley    Collective on KSP
257130ad9308SMatthew Knepley 
257230ad9308SMatthew Knepley    Input Parameter:
257330ad9308SMatthew Knepley .  pc - the preconditioner context
257430ad9308SMatthew Knepley 
257530ad9308SMatthew Knepley    Output Parameters:
2576a04f6461SBarry Smith +  A00 - the (0,0) block
2577a04f6461SBarry Smith .  A01 - the (0,1) block
2578a04f6461SBarry Smith .  A10 - the (1,0) block
2579a04f6461SBarry Smith -  A11 - the (1,1) block
258030ad9308SMatthew Knepley 
258130ad9308SMatthew Knepley    Level: advanced
258230ad9308SMatthew Knepley 
258330ad9308SMatthew Knepley .seealso: PCFIELDSPLIT
258430ad9308SMatthew Knepley @*/
2585a04f6461SBarry Smith PetscErrorCode  PCFieldSplitGetSchurBlocks(PC pc,Mat *A00,Mat *A01,Mat *A10, Mat *A11)
258630ad9308SMatthew Knepley {
258730ad9308SMatthew Knepley   PC_FieldSplit *jac = (PC_FieldSplit*) pc->data;
258830ad9308SMatthew Knepley 
258930ad9308SMatthew Knepley   PetscFunctionBegin;
25900700a824SBarry Smith   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
2591ce94432eSBarry Smith   if (jac->type != PC_COMPOSITE_SCHUR) SETERRQ(PetscObjectComm((PetscObject)pc),PETSC_ERR_ARG_WRONG, "FieldSplit is not using a Schur complement approach.");
2592a04f6461SBarry Smith   if (A00) *A00 = jac->pmat[0];
2593a04f6461SBarry Smith   if (A01) *A01 = jac->B;
2594a04f6461SBarry Smith   if (A10) *A10 = jac->C;
2595a04f6461SBarry Smith   if (A11) *A11 = jac->pmat[1];
259630ad9308SMatthew Knepley   PetscFunctionReturn(0);
259730ad9308SMatthew Knepley }
259830ad9308SMatthew Knepley 
2599b09e027eSCarola Kruse /*@
2600e071a0a4SCarola Kruse     PCFieldSplitSetGKBTol -  Sets the solver tolerance for the generalized Golub-Kahan bidiagonalization preconditioner.
2601b09e027eSCarola Kruse 
2602b09e027eSCarola Kruse     Collective on PC
2603b09e027eSCarola Kruse 
2604e071a0a4SCarola Kruse     Notes:
2605e071a0a4SCarola Kruse     The generalized GKB algorithm uses a lower bound estimate of the error in energy norm as stopping criterion.
2606e071a0a4SCarola Kruse     It stops once the lower bound estimate undershoots the required solver tolerance. Although the actual error might be bigger than
2607e071a0a4SCarola Kruse     this estimate, the stopping criterion is satisfactory in practical cases [A13].
2608e071a0a4SCarola Kruse 
2609e071a0a4SCarola Kruse [Ar13] Generalized Golub-Kahan bidiagonalization and stopping criteria, SIAM J. Matrix Anal. Appl., Vol. 34, No. 2, pp. 571-592, 2013.
2610e071a0a4SCarola Kruse 
2611b09e027eSCarola Kruse     Input Parameters:
2612b09e027eSCarola Kruse +   pc        - the preconditioner context
2613b09e027eSCarola Kruse -   tolerance - the solver tolerance
2614b09e027eSCarola Kruse 
2615b09e027eSCarola Kruse     Options Database:
2616b09e027eSCarola Kruse .     -pc_fieldsplit_gkb_tol - default is 1e-5
2617b09e027eSCarola Kruse 
2618b09e027eSCarola Kruse     Level: intermediate
2619b09e027eSCarola Kruse 
2620b09e027eSCarola Kruse .seealso: PCFIELDSPLIT, PCFieldSplitSetGKBDelay(), PCFieldSplitSetGKBNu(), PCFieldSplitSetGKBMaxit()
2621b09e027eSCarola Kruse @*/
2622b09e027eSCarola Kruse PetscErrorCode PCFieldSplitSetGKBTol(PC pc,PetscReal tolerance)
2623b09e027eSCarola Kruse {
2624b09e027eSCarola Kruse   PetscErrorCode ierr;
2625b09e027eSCarola Kruse 
2626b09e027eSCarola Kruse   PetscFunctionBegin;
2627b09e027eSCarola Kruse   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
2628de482cd7SCarola Kruse   PetscValidLogicalCollectiveReal(pc,tolerance,2);
2629b09e027eSCarola Kruse   ierr = PetscTryMethod(pc,"PCFieldSplitSetGKBTol_C",(PC,PetscReal),(pc,tolerance));CHKERRQ(ierr);
2630b09e027eSCarola Kruse   PetscFunctionReturn(0);
2631b09e027eSCarola Kruse }
2632b09e027eSCarola Kruse 
2633b09e027eSCarola Kruse static PetscErrorCode PCFieldSplitSetGKBTol_FieldSplit(PC pc,PetscReal tolerance)
2634b09e027eSCarola Kruse {
2635b09e027eSCarola Kruse   PC_FieldSplit *jac = (PC_FieldSplit*)pc->data;
2636b09e027eSCarola Kruse 
2637b09e027eSCarola Kruse   PetscFunctionBegin;
2638b09e027eSCarola Kruse   jac->gkbtol = tolerance;
2639b09e027eSCarola Kruse   PetscFunctionReturn(0);
2640b09e027eSCarola Kruse }
2641b09e027eSCarola Kruse 
2642b09e027eSCarola Kruse /*@
2643e071a0a4SCarola Kruse     PCFieldSplitSetGKBMaxit -  Sets the maximum number of iterations for the generalized Golub-Kahan bidiagonalization
2644e071a0a4SCarola Kruse     preconditioner.
2645b09e027eSCarola Kruse 
2646b09e027eSCarola Kruse     Collective on PC
2647b09e027eSCarola Kruse 
2648b09e027eSCarola Kruse     Input Parameters:
2649b09e027eSCarola Kruse +   pc     - the preconditioner context
2650b09e027eSCarola Kruse -   maxit  - the maximum number of iterations
2651b09e027eSCarola Kruse 
2652b09e027eSCarola Kruse     Options Database:
2653b09e027eSCarola Kruse .     -pc_fieldsplit_gkb_maxit - default is 100
2654b09e027eSCarola Kruse 
2655b09e027eSCarola Kruse     Level: intermediate
2656b09e027eSCarola Kruse 
2657b09e027eSCarola Kruse .seealso: PCFIELDSPLIT, PCFieldSplitSetGKBDelay(), PCFieldSplitSetGKBTol(), PCFieldSplitSetGKBNu()
2658b09e027eSCarola Kruse @*/
2659b09e027eSCarola Kruse PetscErrorCode PCFieldSplitSetGKBMaxit(PC pc,PetscInt maxit)
2660b09e027eSCarola Kruse {
2661b09e027eSCarola Kruse   PetscErrorCode ierr;
2662b09e027eSCarola Kruse 
2663b09e027eSCarola Kruse   PetscFunctionBegin;
2664b09e027eSCarola Kruse   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
2665de482cd7SCarola Kruse   PetscValidLogicalCollectiveInt(pc,maxit,2);
2666b09e027eSCarola Kruse   ierr = PetscTryMethod(pc,"PCFieldSplitSetGKBMaxit_C",(PC,PetscInt),(pc,maxit));CHKERRQ(ierr);
2667b09e027eSCarola Kruse   PetscFunctionReturn(0);
2668b09e027eSCarola Kruse }
2669b09e027eSCarola Kruse 
2670b09e027eSCarola Kruse static PetscErrorCode PCFieldSplitSetGKBMaxit_FieldSplit(PC pc,PetscInt maxit)
2671b09e027eSCarola Kruse {
2672b09e027eSCarola Kruse   PC_FieldSplit *jac = (PC_FieldSplit*)pc->data;
2673b09e027eSCarola Kruse 
2674b09e027eSCarola Kruse   PetscFunctionBegin;
2675b09e027eSCarola Kruse   jac->gkbmaxit = maxit;
2676b09e027eSCarola Kruse   PetscFunctionReturn(0);
2677b09e027eSCarola Kruse }
2678b09e027eSCarola Kruse 
2679b09e027eSCarola Kruse /*@
2680e071a0a4SCarola Kruse     PCFieldSplitSetGKBDelay -  Sets the delay in the lower bound error estimate in the generalized Golub-Kahan bidiagonalization
2681e071a0a4SCarola Kruse     preconditioner.
2682b09e027eSCarola Kruse 
2683b09e027eSCarola Kruse     Collective on PC
2684b09e027eSCarola Kruse 
2685b09e027eSCarola Kruse     Notes:
2686e071a0a4SCarola Kruse     The algorithm uses a lower bound estimate of the error in energy norm as stopping criterion. The lower bound of the error ||u-u^k||_H
2687e071a0a4SCarola Kruse     is expressed as a truncated sum. The error at iteration k can only be measured at iteration (k + delay), and thus the algorithm needs
2688e071a0a4SCarola Kruse     at least (delay + 1) iterations to stop. For more details on the generalized Golub-Kahan bidiagonalization method and its lower bound stopping criterion, please refer to
2689b09e027eSCarola Kruse 
2690b09e027eSCarola Kruse [Ar13] Generalized Golub-Kahan bidiagonalization and stopping criteria, SIAM J. Matrix Anal. Appl., Vol. 34, No. 2, pp. 571-592, 2013.
2691b09e027eSCarola Kruse 
2692b09e027eSCarola Kruse     Input Parameters:
2693b09e027eSCarola Kruse +   pc     - the preconditioner context
2694b09e027eSCarola Kruse -   delay  - the delay window in the lower bound estimate
2695b09e027eSCarola Kruse 
2696b09e027eSCarola Kruse     Options Database:
2697b09e027eSCarola Kruse .     -pc_fieldsplit_gkb_delay - default is 5
2698b09e027eSCarola Kruse 
2699b09e027eSCarola Kruse     Level: intermediate
2700b09e027eSCarola Kruse 
2701b09e027eSCarola Kruse .seealso: PCFIELDSPLIT, PCFieldSplitSetGKBNu(), PCFieldSplitSetGKBTol(), PCFieldSplitSetGKBMaxit()
2702b09e027eSCarola Kruse @*/
2703b09e027eSCarola Kruse PetscErrorCode PCFieldSplitSetGKBDelay(PC pc,PetscInt delay)
2704b09e027eSCarola Kruse {
2705b09e027eSCarola Kruse   PetscErrorCode ierr;
2706b09e027eSCarola Kruse 
2707b09e027eSCarola Kruse   PetscFunctionBegin;
2708b09e027eSCarola Kruse   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
2709b09e027eSCarola Kruse   PetscValidLogicalCollectiveInt(pc,delay,2);
2710b09e027eSCarola Kruse   ierr = PetscTryMethod(pc,"PCFieldSplitSetGKBDelay_C",(PC,PetscInt),(pc,delay));CHKERRQ(ierr);
2711b09e027eSCarola Kruse   PetscFunctionReturn(0);
2712b09e027eSCarola Kruse }
2713b09e027eSCarola Kruse 
2714b09e027eSCarola Kruse static PetscErrorCode PCFieldSplitSetGKBDelay_FieldSplit(PC pc,PetscInt delay)
2715b09e027eSCarola Kruse {
2716b09e027eSCarola Kruse   PC_FieldSplit *jac = (PC_FieldSplit*)pc->data;
2717b09e027eSCarola Kruse 
2718b09e027eSCarola Kruse   PetscFunctionBegin;
2719b09e027eSCarola Kruse   jac->gkbdelay = delay;
2720b09e027eSCarola Kruse   PetscFunctionReturn(0);
2721b09e027eSCarola Kruse }
2722b09e027eSCarola Kruse 
2723b09e027eSCarola Kruse /*@
2724b09e027eSCarola Kruse     PCFieldSplitSetGKBNu -  Sets the scalar value nu >= 0 in the transformation H = A00 + nu*A01*A01' of the (1,1) block in the Golub-Kahan bidiagonalization preconditioner.
2725b09e027eSCarola Kruse 
2726b09e027eSCarola Kruse     Collective on PC
2727b09e027eSCarola Kruse 
2728b09e027eSCarola Kruse     Notes:
2729e071a0a4SCarola Kruse     This shift is in general done to obtain better convergence properties for the outer loop of the algorithm. This is often achieved by chosing nu sufficiently big. However,
2730b09e027eSCarola Kruse     if nu is chosen too big, the matrix H might be badly conditioned and the solution of the linear system Hx = b in the inner loop gets difficult. It is therefore
2731b09e027eSCarola Kruse     necessary to find a good balance in between the convergence of the inner and outer loop.
2732b09e027eSCarola Kruse 
2733b09e027eSCarola Kruse     For nu = 0, no shift is done. In this case A00 has to be positive definite. The matrix N in [Ar13] is then chosen as identity.
2734b09e027eSCarola Kruse 
2735b09e027eSCarola Kruse [Ar13] Generalized Golub-Kahan bidiagonalization and stopping criteria, SIAM J. Matrix Anal. Appl., Vol. 34, No. 2, pp. 571-592, 2013.
2736b09e027eSCarola Kruse 
2737b09e027eSCarola Kruse     Input Parameters:
2738b09e027eSCarola Kruse +   pc     - the preconditioner context
2739b09e027eSCarola Kruse -   nu     - the shift parameter
2740b09e027eSCarola Kruse 
2741b09e027eSCarola Kruse     Options Database:
2742b09e027eSCarola Kruse .     -pc_fieldsplit_gkb_nu - default is 1
2743b09e027eSCarola Kruse 
2744b09e027eSCarola Kruse     Level: intermediate
2745b09e027eSCarola Kruse 
2746b09e027eSCarola Kruse .seealso: PCFIELDSPLIT, PCFieldSplitSetGKBDelay(), PCFieldSplitSetGKBTol(), PCFieldSplitSetGKBMaxit()
2747b09e027eSCarola Kruse @*/
2748b09e027eSCarola Kruse PetscErrorCode PCFieldSplitSetGKBNu(PC pc,PetscReal nu)
2749b09e027eSCarola Kruse {
2750b09e027eSCarola Kruse   PetscErrorCode ierr;
2751b09e027eSCarola Kruse 
2752b09e027eSCarola Kruse   PetscFunctionBegin;
2753b09e027eSCarola Kruse   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
2754de482cd7SCarola Kruse   PetscValidLogicalCollectiveReal(pc,nu,2);
2755b09e027eSCarola Kruse   ierr = PetscTryMethod(pc,"PCFieldSplitSetGKBNu_C",(PC,PetscReal),(pc,nu));CHKERRQ(ierr);
2756b09e027eSCarola Kruse   PetscFunctionReturn(0);
2757b09e027eSCarola Kruse }
2758b09e027eSCarola Kruse 
2759b09e027eSCarola Kruse static PetscErrorCode PCFieldSplitSetGKBNu_FieldSplit(PC pc,PetscReal nu)
2760b09e027eSCarola Kruse {
2761b09e027eSCarola Kruse   PC_FieldSplit *jac = (PC_FieldSplit*)pc->data;
2762b09e027eSCarola Kruse 
2763b09e027eSCarola Kruse   PetscFunctionBegin;
2764b09e027eSCarola Kruse   jac->gkbnu = nu;
2765b09e027eSCarola Kruse   PetscFunctionReturn(0);
2766b09e027eSCarola Kruse }
2767b09e027eSCarola Kruse 
27681e6b0712SBarry Smith static PetscErrorCode  PCFieldSplitSetType_FieldSplit(PC pc,PCCompositeType type)
276979416396SBarry Smith {
277079416396SBarry Smith   PC_FieldSplit  *jac = (PC_FieldSplit*)pc->data;
2771e69d4d44SBarry Smith   PetscErrorCode ierr;
277279416396SBarry Smith 
277379416396SBarry Smith   PetscFunctionBegin;
277479416396SBarry Smith   jac->type = type;
2775e071a0a4SCarola Kruse 
2776e071a0a4SCarola Kruse   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitGetSubKSP_C",0);CHKERRQ(ierr);
2777e071a0a4SCarola Kruse   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetSchurPre_C",0);CHKERRQ(ierr);
2778e071a0a4SCarola Kruse   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitGetSchurPre_C",0);CHKERRQ(ierr);
2779e071a0a4SCarola Kruse   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetSchurFactType_C",0);CHKERRQ(ierr);
2780e071a0a4SCarola Kruse   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetSchurScale_C",0);CHKERRQ(ierr);
2781e071a0a4SCarola Kruse   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetGKBTol_C",0);CHKERRQ(ierr);
2782e071a0a4SCarola Kruse   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetGKBMaxit_C",0);CHKERRQ(ierr);
2783e071a0a4SCarola Kruse   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetGKBNu_C",0);CHKERRQ(ierr);
2784e071a0a4SCarola Kruse   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetGKBDelay_C",0);CHKERRQ(ierr);
2785e071a0a4SCarola Kruse 
27863b224e63SBarry Smith   if (type == PC_COMPOSITE_SCHUR) {
27873b224e63SBarry Smith     pc->ops->apply = PCApply_FieldSplit_Schur;
27883b224e63SBarry Smith     pc->ops->view  = PCView_FieldSplit_Schur;
27892fa5cd67SKarl Rupp 
2790bdf89e91SBarry Smith     ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitGetSubKSP_C",PCFieldSplitGetSubKSP_FieldSplit_Schur);CHKERRQ(ierr);
279129f8a81cSJed Brown     ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetSchurPre_C",PCFieldSplitSetSchurPre_FieldSplit);CHKERRQ(ierr);
279237a82bf0SJed Brown     ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitGetSchurPre_C",PCFieldSplitGetSchurPre_FieldSplit);CHKERRQ(ierr);
2793bdf89e91SBarry Smith     ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetSchurFactType_C",PCFieldSplitSetSchurFactType_FieldSplit);CHKERRQ(ierr);
2794c096484dSStefano Zampini     ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetSchurScale_C",PCFieldSplitSetSchurScale_FieldSplit);CHKERRQ(ierr);
2795a51937d4SCarola Kruse   } else if (type == PC_COMPOSITE_GKB) {
2796a51937d4SCarola Kruse     pc->ops->apply = PCApply_FieldSplit_GKB;
2797a51937d4SCarola Kruse     pc->ops->view  = PCView_FieldSplit_GKB;
2798e69d4d44SBarry Smith 
2799a51937d4SCarola Kruse     ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitGetSubKSP_C",PCFieldSplitGetSubKSP_FieldSplit);CHKERRQ(ierr);
2800b09e027eSCarola Kruse     ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetGKBTol_C",PCFieldSplitSetGKBTol_FieldSplit);CHKERRQ(ierr);
2801b09e027eSCarola Kruse     ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetGKBMaxit_C",PCFieldSplitSetGKBMaxit_FieldSplit);CHKERRQ(ierr);
2802b09e027eSCarola Kruse     ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetGKBNu_C",PCFieldSplitSetGKBNu_FieldSplit);CHKERRQ(ierr);
2803b09e027eSCarola Kruse     ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetGKBDelay_C",PCFieldSplitSetGKBDelay_FieldSplit);CHKERRQ(ierr);
28043b224e63SBarry Smith   } else {
28053b224e63SBarry Smith     pc->ops->apply = PCApply_FieldSplit;
28063b224e63SBarry Smith     pc->ops->view  = PCView_FieldSplit;
28072fa5cd67SKarl Rupp 
2808bdf89e91SBarry Smith     ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitGetSubKSP_C",PCFieldSplitGetSubKSP_FieldSplit);CHKERRQ(ierr);
28093b224e63SBarry Smith   }
281079416396SBarry Smith   PetscFunctionReturn(0);
281179416396SBarry Smith }
281279416396SBarry Smith 
28131e6b0712SBarry Smith static PetscErrorCode  PCFieldSplitSetBlockSize_FieldSplit(PC pc,PetscInt bs)
281451f519a2SBarry Smith {
281551f519a2SBarry Smith   PC_FieldSplit *jac = (PC_FieldSplit*)pc->data;
281651f519a2SBarry Smith 
281751f519a2SBarry Smith   PetscFunctionBegin;
2818ce94432eSBarry Smith   if (bs < 1) SETERRQ1(PetscObjectComm((PetscObject)pc),PETSC_ERR_ARG_OUTOFRANGE,"Blocksize must be positive, you gave %D",bs);
2819ce94432eSBarry 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);
282051f519a2SBarry Smith   jac->bs = bs;
282151f519a2SBarry Smith   PetscFunctionReturn(0);
282251f519a2SBarry Smith }
282351f519a2SBarry Smith 
2824bc08b0f1SBarry Smith /*@
282579416396SBarry Smith    PCFieldSplitSetType - Sets the type of fieldsplit preconditioner.
282679416396SBarry Smith 
282779416396SBarry Smith    Collective on PC
282879416396SBarry Smith 
2829*d8d19677SJose E. Roman    Input Parameters:
2830a2b725a8SWilliam Gropp +  pc - the preconditioner context
2831a2b725a8SWilliam Gropp -  type - PC_COMPOSITE_ADDITIVE, PC_COMPOSITE_MULTIPLICATIVE (default), PC_COMPOSITE_SYMMETRIC_MULTIPLICATIVE, PC_COMPOSITE_SPECIAL, PC_COMPOSITE_SCHUR
283279416396SBarry Smith 
283379416396SBarry Smith    Options Database Key:
2834a4efd8eaSMatthew Knepley .  -pc_fieldsplit_type <type: one of multiplicative, additive, symmetric_multiplicative, special, schur> - Sets fieldsplit preconditioner type
283579416396SBarry Smith 
2836b02e2d75SMatthew G Knepley    Level: Intermediate
283779416396SBarry Smith 
283879416396SBarry Smith .seealso: PCCompositeSetType()
283979416396SBarry Smith 
284079416396SBarry Smith @*/
28417087cfbeSBarry Smith PetscErrorCode  PCFieldSplitSetType(PC pc,PCCompositeType type)
284279416396SBarry Smith {
28434ac538c5SBarry Smith   PetscErrorCode ierr;
284479416396SBarry Smith 
284579416396SBarry Smith   PetscFunctionBegin;
28460700a824SBarry Smith   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
28474ac538c5SBarry Smith   ierr = PetscTryMethod(pc,"PCFieldSplitSetType_C",(PC,PCCompositeType),(pc,type));CHKERRQ(ierr);
284879416396SBarry Smith   PetscFunctionReturn(0);
284979416396SBarry Smith }
285079416396SBarry Smith 
2851b02e2d75SMatthew G Knepley /*@
2852b02e2d75SMatthew G Knepley   PCFieldSplitGetType - Gets the type of fieldsplit preconditioner.
2853b02e2d75SMatthew G Knepley 
2854b02e2d75SMatthew G Knepley   Not collective
2855b02e2d75SMatthew G Knepley 
2856b02e2d75SMatthew G Knepley   Input Parameter:
2857b02e2d75SMatthew G Knepley . pc - the preconditioner context
2858b02e2d75SMatthew G Knepley 
2859b02e2d75SMatthew G Knepley   Output Parameter:
2860b02e2d75SMatthew G Knepley . type - PC_COMPOSITE_ADDITIVE, PC_COMPOSITE_MULTIPLICATIVE (default), PC_COMPOSITE_SYMMETRIC_MULTIPLICATIVE, PC_COMPOSITE_SPECIAL, PC_COMPOSITE_SCHUR
2861b02e2d75SMatthew G Knepley 
2862b02e2d75SMatthew G Knepley   Level: Intermediate
2863b02e2d75SMatthew G Knepley 
2864b02e2d75SMatthew G Knepley .seealso: PCCompositeSetType()
2865b02e2d75SMatthew G Knepley @*/
2866b02e2d75SMatthew G Knepley PetscErrorCode PCFieldSplitGetType(PC pc, PCCompositeType *type)
2867b02e2d75SMatthew G Knepley {
2868b02e2d75SMatthew G Knepley   PC_FieldSplit *jac = (PC_FieldSplit*) pc->data;
2869b02e2d75SMatthew G Knepley 
2870b02e2d75SMatthew G Knepley   PetscFunctionBegin;
2871b02e2d75SMatthew G Knepley   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
2872b02e2d75SMatthew G Knepley   PetscValidIntPointer(type,2);
2873b02e2d75SMatthew G Knepley   *type = jac->type;
2874b02e2d75SMatthew G Knepley   PetscFunctionReturn(0);
2875b02e2d75SMatthew G Knepley }
2876b02e2d75SMatthew G Knepley 
28774ab8060aSDmitry Karpeev /*@
28784ab8060aSDmitry Karpeev    PCFieldSplitSetDMSplits - Flags whether DMCreateFieldDecomposition() should be used to define the splits, whenever possible.
28794ab8060aSDmitry Karpeev 
28804ab8060aSDmitry Karpeev    Logically Collective
28814ab8060aSDmitry Karpeev 
28824ab8060aSDmitry Karpeev    Input Parameters:
28834ab8060aSDmitry Karpeev +  pc   - the preconditioner context
28844ab8060aSDmitry Karpeev -  flg  - boolean indicating whether to use field splits defined by the DM
28854ab8060aSDmitry Karpeev 
28864ab8060aSDmitry Karpeev    Options Database Key:
28874ab8060aSDmitry Karpeev .  -pc_fieldsplit_dm_splits
28884ab8060aSDmitry Karpeev 
28894ab8060aSDmitry Karpeev    Level: Intermediate
28904ab8060aSDmitry Karpeev 
28914ab8060aSDmitry Karpeev .seealso: PCFieldSplitGetDMSplits()
28924ab8060aSDmitry Karpeev 
28934ab8060aSDmitry Karpeev @*/
28944ab8060aSDmitry Karpeev PetscErrorCode  PCFieldSplitSetDMSplits(PC pc,PetscBool flg)
28954ab8060aSDmitry Karpeev {
28964ab8060aSDmitry Karpeev   PC_FieldSplit  *jac = (PC_FieldSplit*)pc->data;
28974ab8060aSDmitry Karpeev   PetscBool      isfs;
28984ab8060aSDmitry Karpeev   PetscErrorCode ierr;
28994ab8060aSDmitry Karpeev 
29004ab8060aSDmitry Karpeev   PetscFunctionBegin;
29014ab8060aSDmitry Karpeev   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
29024ab8060aSDmitry Karpeev   PetscValidLogicalCollectiveBool(pc,flg,2);
29034ab8060aSDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)pc,PCFIELDSPLIT,&isfs);CHKERRQ(ierr);
29044ab8060aSDmitry Karpeev   if (isfs) {
29054ab8060aSDmitry Karpeev     jac->dm_splits = flg;
29064ab8060aSDmitry Karpeev   }
29074ab8060aSDmitry Karpeev   PetscFunctionReturn(0);
29084ab8060aSDmitry Karpeev }
29094ab8060aSDmitry Karpeev 
29104ab8060aSDmitry Karpeev /*@
29114ab8060aSDmitry Karpeev    PCFieldSplitGetDMSplits - Returns flag indicating whether DMCreateFieldDecomposition() should be used to define the splits, whenever possible.
29124ab8060aSDmitry Karpeev 
29134ab8060aSDmitry Karpeev    Logically Collective
29144ab8060aSDmitry Karpeev 
29154ab8060aSDmitry Karpeev    Input Parameter:
29164ab8060aSDmitry Karpeev .  pc   - the preconditioner context
29174ab8060aSDmitry Karpeev 
29184ab8060aSDmitry Karpeev    Output Parameter:
29194ab8060aSDmitry Karpeev .  flg  - boolean indicating whether to use field splits defined by the DM
29204ab8060aSDmitry Karpeev 
29214ab8060aSDmitry Karpeev    Level: Intermediate
29224ab8060aSDmitry Karpeev 
29234ab8060aSDmitry Karpeev .seealso: PCFieldSplitSetDMSplits()
29244ab8060aSDmitry Karpeev 
29254ab8060aSDmitry Karpeev @*/
29264ab8060aSDmitry Karpeev PetscErrorCode  PCFieldSplitGetDMSplits(PC pc,PetscBool* flg)
29274ab8060aSDmitry Karpeev {
29284ab8060aSDmitry Karpeev   PC_FieldSplit  *jac = (PC_FieldSplit*)pc->data;
29294ab8060aSDmitry Karpeev   PetscBool      isfs;
29304ab8060aSDmitry Karpeev   PetscErrorCode ierr;
29314ab8060aSDmitry Karpeev 
29324ab8060aSDmitry Karpeev   PetscFunctionBegin;
29334ab8060aSDmitry Karpeev   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
2934534a8f05SLisandro Dalcin   PetscValidBoolPointer(flg,2);
29354ab8060aSDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)pc,PCFIELDSPLIT,&isfs);CHKERRQ(ierr);
29364ab8060aSDmitry Karpeev   if (isfs) {
29374ab8060aSDmitry Karpeev     if (flg) *flg = jac->dm_splits;
29384ab8060aSDmitry Karpeev   }
29394ab8060aSDmitry Karpeev   PetscFunctionReturn(0);
29404ab8060aSDmitry Karpeev }
29414ab8060aSDmitry Karpeev 
29427b752e3dSPatrick Sanan /*@
29437b752e3dSPatrick Sanan    PCFieldSplitGetDetectSaddlePoint - Returns flag indicating whether PCFieldSplit will attempt to automatically determine fields based on zero diagonal entries.
29447b752e3dSPatrick Sanan 
29457b752e3dSPatrick Sanan    Logically Collective
29467b752e3dSPatrick Sanan 
29477b752e3dSPatrick Sanan    Input Parameter:
29487b752e3dSPatrick Sanan .  pc   - the preconditioner context
29497b752e3dSPatrick Sanan 
29507b752e3dSPatrick Sanan    Output Parameter:
29517b752e3dSPatrick Sanan .  flg  - boolean indicating whether to detect fields or not
29527b752e3dSPatrick Sanan 
29537b752e3dSPatrick Sanan    Level: Intermediate
29547b752e3dSPatrick Sanan 
29557b752e3dSPatrick Sanan .seealso: PCFIELDSPLIT, PCFieldSplitSetDetectSaddlePoint()
29567b752e3dSPatrick Sanan 
29577b752e3dSPatrick Sanan @*/
29587b752e3dSPatrick Sanan PetscErrorCode PCFieldSplitGetDetectSaddlePoint(PC pc,PetscBool *flg)
29597b752e3dSPatrick Sanan {
29607b752e3dSPatrick Sanan   PC_FieldSplit *jac = (PC_FieldSplit*)pc->data;
29617b752e3dSPatrick Sanan 
29627b752e3dSPatrick Sanan   PetscFunctionBegin;
29637b752e3dSPatrick Sanan   *flg = jac->detect;
29647b752e3dSPatrick Sanan   PetscFunctionReturn(0);
29657b752e3dSPatrick Sanan }
29667b752e3dSPatrick Sanan 
29677b752e3dSPatrick Sanan /*@
29687b752e3dSPatrick Sanan    PCFieldSplitSetDetectSaddlePoint - Sets flag indicating whether PCFieldSplit will attempt to automatically determine fields based on zero diagonal entries.
29697b752e3dSPatrick Sanan 
29707b752e3dSPatrick Sanan    Logically Collective
29717b752e3dSPatrick Sanan 
29727b752e3dSPatrick Sanan    Notes:
29737b752e3dSPatrick Sanan    Also sets the split type to PC_COMPOSITE_SCHUR (see PCFieldSplitSetType()) and the Schur preconditioner type to PC_FIELDSPLIT_SCHUR_PRE_SELF (see PCFieldSplitSetSchurPre()).
29747b752e3dSPatrick Sanan 
29757b752e3dSPatrick Sanan    Input Parameter:
29767b752e3dSPatrick Sanan .  pc   - the preconditioner context
29777b752e3dSPatrick Sanan 
29787b752e3dSPatrick Sanan    Output Parameter:
29797b752e3dSPatrick Sanan .  flg  - boolean indicating whether to detect fields or not
29807b752e3dSPatrick Sanan 
29817b752e3dSPatrick Sanan    Options Database Key:
29827b752e3dSPatrick Sanan .  -pc_fieldsplit_detect_saddle_point
29837b752e3dSPatrick Sanan 
29847b752e3dSPatrick Sanan    Level: Intermediate
29857b752e3dSPatrick Sanan 
29867b752e3dSPatrick Sanan .seealso: PCFIELDSPLIT, PCFieldSplitSetDetectSaddlePoint(), PCFieldSplitSetType(), PCFieldSplitSetSchurPre()
29877b752e3dSPatrick Sanan 
29887b752e3dSPatrick Sanan @*/
29897b752e3dSPatrick Sanan PetscErrorCode PCFieldSplitSetDetectSaddlePoint(PC pc,PetscBool flg)
29907b752e3dSPatrick Sanan {
29917b752e3dSPatrick Sanan   PC_FieldSplit  *jac = (PC_FieldSplit*)pc->data;
29927b752e3dSPatrick Sanan   PetscErrorCode ierr;
29937b752e3dSPatrick Sanan 
29947b752e3dSPatrick Sanan   PetscFunctionBegin;
29957b752e3dSPatrick Sanan   jac->detect = flg;
29967b752e3dSPatrick Sanan   if (jac->detect) {
29977b752e3dSPatrick Sanan     ierr = PCFieldSplitSetType(pc,PC_COMPOSITE_SCHUR);CHKERRQ(ierr);
29987b752e3dSPatrick Sanan     ierr = PCFieldSplitSetSchurPre(pc,PC_FIELDSPLIT_SCHUR_PRE_SELF,NULL);CHKERRQ(ierr);
29997b752e3dSPatrick Sanan   }
30007b752e3dSPatrick Sanan   PetscFunctionReturn(0);
30017b752e3dSPatrick Sanan }
30027b752e3dSPatrick Sanan 
30030971522cSBarry Smith /* -------------------------------------------------------------------------------------*/
30040971522cSBarry Smith /*MC
3005a8c7a070SBarry Smith    PCFIELDSPLIT - Preconditioner created by combining separate preconditioners for individual
3006a04f6461SBarry Smith                   fields or groups of fields. See the users manual section "Solving Block Matrices" for more details.
30070971522cSBarry Smith 
3008edf189efSBarry Smith      To set options on the solvers for each block append -fieldsplit_ to all the PC
3009edf189efSBarry Smith         options database keys. For example, -fieldsplit_pc_type ilu -fieldsplit_pc_factor_levels 1
30100971522cSBarry Smith 
3011a8c7a070SBarry Smith      To set the options on the solvers separate for each block call PCFieldSplitGetSubKSP()
301269a612a9SBarry Smith          and set the options directly on the resulting KSP object
30130971522cSBarry Smith 
30140971522cSBarry Smith    Level: intermediate
30150971522cSBarry Smith 
301679416396SBarry Smith    Options Database Keys:
301781540f2fSBarry Smith +   -pc_fieldsplit_%d_fields <a,b,..> - indicates the fields to be used in the %d'th split
301881540f2fSBarry Smith .   -pc_fieldsplit_default - automatically add any fields to additional splits that have not
301981540f2fSBarry Smith                               been supplied explicitly by -pc_fieldsplit_%d_fields
302081540f2fSBarry Smith .   -pc_fieldsplit_block_size <bs> - size of block that defines fields (i.e. there are bs fields)
3021a51937d4SCarola Kruse .   -pc_fieldsplit_type <additive,multiplicative,symmetric_multiplicative,schur,gkb> - type of relaxation or factorization splitting
3022a6a584a2SBarry Smith .   -pc_fieldsplit_schur_precondition <self,selfp,user,a11,full> - default is a11; see PCFieldSplitSetSchurPre()
3023412be6bfSPatrick Sanan .   -pc_fieldsplit_schur_fact_type <diag,lower,upper,full> - set factorization type when using -pc_fieldsplit_type schur; see PCFieldSplitSetSchurFactType()
3024fb6809a2SPatrick Sanan -   -pc_fieldsplit_detect_saddle_point - automatically finds rows with zero diagonal and uses Schur complement with no preconditioner as the solver
302579416396SBarry Smith 
3026fb6809a2SPatrick Sanan      Options prefixes for inner solvers when using the Schur complement preconditioner are -fieldsplit_0_ and -fieldsplit_1_ .
3027fb6809a2SPatrick Sanan      For all other solvers they are -fieldsplit_%d_ for the dth field; use -fieldsplit_ for all fields.
3028fb6809a2SPatrick Sanan      The options prefix for the inner solver when using the Golub-Kahan biadiagonalization preconditioner is -fieldsplit_0_
30295d4c12cdSJungho Lee 
3030c8a0d604SMatthew G Knepley    Notes:
3031c8a0d604SMatthew G Knepley     Use PCFieldSplitSetFields() to set fields defined by "strided" entries and PCFieldSplitSetIS()
3032d32f9abdSBarry Smith      to define a field by an arbitrary collection of entries.
3033d32f9abdSBarry Smith 
3034d32f9abdSBarry Smith       If no fields are set the default is used. The fields are defined by entries strided by bs,
3035d32f9abdSBarry Smith       beginning at 0 then 1, etc to bs-1. The block size can be set with PCFieldSplitSetBlockSize(),
3036d32f9abdSBarry Smith       if this is not called the block size defaults to the blocksize of the second matrix passed
3037d32f9abdSBarry Smith       to KSPSetOperators()/PCSetOperators().
3038d32f9abdSBarry Smith 
30392da392ccSBarry Smith $     For the Schur complement preconditioner if J = [ A00 A01]
30402da392ccSBarry Smith $                                                    [ A10 A11]
3041c8a0d604SMatthew G Knepley $     the preconditioner using full factorization is
30422da392ccSBarry Smith $              [ I   -ksp(A00) A01] [ inv(A00)    0  ] [     I          0]
30432da392ccSBarry Smith $              [ 0         I      ] [   0      ksp(S)] [ -A10 ksp(A00)  I]
304413b05affSJed Brown      where the action of inv(A00) is applied using the KSP solver with prefix -fieldsplit_0_.  S is the Schur complement
304513b05affSJed Brown $              S = A11 - A10 ksp(A00) A01
304613b05affSJed 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
3047686bed4dSStefano Zampini      in providing the SECOND split or 1 if not give). For PCFieldSplitGetSubKSP() when field number is 0,
3048c8a0d604SMatthew G Knepley      it returns the KSP associated with -fieldsplit_0_ while field number 1 gives -fieldsplit_1_ KSP. By default
3049a6a584a2SBarry Smith      A11 is used to construct a preconditioner for S, use PCFieldSplitSetSchurPre() for all the possible ways to construct the preconditioner for S.
30501d71051fSDmitry Karpeev 
3051a7476a74SDmitry Karpeev      The factorization type is set using -pc_fieldsplit_schur_fact_type <diag, lower, upper, full>. The full is shown above,
30525668aaf4SBarry Smith      diag gives
30532da392ccSBarry Smith $              [ inv(A00)     0 ]
30542da392ccSBarry Smith $              [   0      -ksp(S)]
3055c096484dSStefano Zampini      note that slightly counter intuitively there is a negative in front of the ksp(S) so that the preconditioner is positive definite. For SPD matrices J, the sign flip
3056c096484dSStefano Zampini      can be turned off with PCFieldSplitSetSchurScale() or by command line -pc_fieldsplit_schur_scale 1.0. The lower factorization is the inverse of
30572da392ccSBarry Smith $              [  A00   0]
30582da392ccSBarry Smith $              [  A10   S]
3059c8a0d604SMatthew G Knepley      where the inverses of A00 and S are applied using KSPs. The upper factorization is the inverse of
30602da392ccSBarry Smith $              [ A00 A01]
30612da392ccSBarry Smith $              [  0   S ]
3062c8a0d604SMatthew G Knepley      where again the inverses of A00 and S are applied using KSPs.
3063e69d4d44SBarry Smith 
3064edf189efSBarry Smith      If only one set of indices (one IS) is provided with PCFieldSplitSetIS() then the complement of that IS
3065edf189efSBarry Smith      is used automatically for a second block.
3066edf189efSBarry Smith 
3067ff218e97SBarry Smith      The fieldsplit preconditioner cannot currently be used with the BAIJ or SBAIJ data formats if the blocksize is larger than 1.
3068ff218e97SBarry Smith      Generally it should be used with the AIJ format.
3069ff218e97SBarry Smith 
3070ff218e97SBarry Smith      The forms of these preconditioners are closely related if not identical to forms derived as "Distributive Iterations", see,
3071ff218e97SBarry Smith      for example, page 294 in "Principles of Computational Fluid Dynamics" by Pieter Wesseling. Note that one can also use PCFIELDSPLIT
3072ff218e97SBarry Smith      inside a smoother resulting in "Distributive Smoothers".
30730716a85fSBarry Smith 
30742da392ccSBarry Smith      References:
30752da392ccSBarry Smith        A taxonomy and comparison of parallel block multi-level preconditioners for the incompressible Navier-Stokes equations
30763bc631e0SBarry Smith        Howard Elman, V.E. Howle, John Shadid, Robert Shuttleworth, Ray Tuminaro, Journal of Computational Physics 227 (2008) 1790--1808
30773bc631e0SBarry Smith        http://chess.cs.umd.edu/~elman/papers/tax.pdf
30783bc631e0SBarry Smith 
30794d308398SBarry Smith    The Constrained Pressure Preconditioner (CPR) can be implemented using PCCOMPOSITE with PCGALERKIN. CPR first solves an R A P subsystem, updates the
30804d308398SBarry Smith    residual on all variables (PCCompositeSetType(pc,PC_COMPOSITE_MULTIPLICATIVE)), and then applies a simple ILU like preconditioner on all the variables.
3081a6a584a2SBarry Smith 
3082e071a0a4SCarola Kruse    The generalized Golub-Kahan bidiagonalization preconditioner (gkb) can be applied to symmetric 2x2 block matrices of the shape
30832da392ccSBarry Smith $        [ A00  A01]
30842da392ccSBarry Smith $        [ A01' 0  ]
3085a51937d4SCarola Kruse    with A00 positive semi-definite. The implementation follows [Ar13]. Therein, we choose N := 1/nu * I and the (1,1)-block of the matrix is modified to H = A00 + nu*A01*A01'.
3086e071a0a4SCarola Kruse    A linear system Hx = b has to be solved in each iteration of the GKB algorithm. This solver is chosen with the option prefix -fieldsplit_0_.
3087a51937d4SCarola Kruse 
3088a51937d4SCarola Kruse [Ar13] Generalized Golub-Kahan bidiagonalization and stopping criteria, SIAM J. Matrix Anal. Appl., Vol. 34, No. 2, pp. 571-592, 2013.
3089a51937d4SCarola Kruse 
3090412be6bfSPatrick Sanan .seealso:  PCCreate(), PCSetType(), PCType (for list of available types), PC, PCLSC,
3091412be6bfSPatrick Sanan            PCFieldSplitGetSubKSP(), PCFieldSplitSchurGetSubKSP(), PCFieldSplitSetFields(),
3092412be6bfSPatrick Sanan            PCFieldSplitSetType(), PCFieldSplitSetIS(), PCFieldSplitSetSchurPre(), PCFieldSplitSetSchurFactType(),
3093412be6bfSPatrick Sanan            MatSchurComplementSetAinvType(), PCFieldSplitSetSchurScale(), PCFieldSplitSetDetectSaddlePoint()
30940971522cSBarry Smith M*/
30950971522cSBarry Smith 
30968cc058d9SJed Brown PETSC_EXTERN PetscErrorCode PCCreate_FieldSplit(PC pc)
30970971522cSBarry Smith {
30980971522cSBarry Smith   PetscErrorCode ierr;
30990971522cSBarry Smith   PC_FieldSplit  *jac;
31000971522cSBarry Smith 
31010971522cSBarry Smith   PetscFunctionBegin;
3102b00a9115SJed Brown   ierr = PetscNewLog(pc,&jac);CHKERRQ(ierr);
31032fa5cd67SKarl Rupp 
31040971522cSBarry Smith   jac->bs                 = -1;
31050971522cSBarry Smith   jac->nsplits            = 0;
31063e197d65SBarry Smith   jac->type               = PC_COMPOSITE_MULTIPLICATIVE;
3107e6cab6aaSJed Brown   jac->schurpre           = PC_FIELDSPLIT_SCHUR_PRE_USER; /* Try user preconditioner first, fall back on diagonal */
3108c9c6ffaaSJed Brown   jac->schurfactorization = PC_FIELDSPLIT_SCHUR_FACT_FULL;
3109c096484dSStefano Zampini   jac->schurscale         = -1.0;
3110fbe7908bSJed Brown   jac->dm_splits          = PETSC_TRUE;
31117b752e3dSPatrick Sanan   jac->detect             = PETSC_FALSE;
3112a51937d4SCarola Kruse   jac->gkbtol             = 1e-5;
3113a51937d4SCarola Kruse   jac->gkbdelay           = 5;
3114a51937d4SCarola Kruse   jac->gkbnu              = 1;
3115a51937d4SCarola Kruse   jac->gkbmaxit           = 100;
3116de482cd7SCarola Kruse   jac->gkbmonitor         = PETSC_FALSE;
311751f519a2SBarry Smith 
31180971522cSBarry Smith   pc->data = (void*)jac;
31190971522cSBarry Smith 
31200971522cSBarry Smith   pc->ops->apply           = PCApply_FieldSplit;
3121421e10b8SBarry Smith   pc->ops->applytranspose  = PCApplyTranspose_FieldSplit;
31220971522cSBarry Smith   pc->ops->setup           = PCSetUp_FieldSplit;
3123574deadeSBarry Smith   pc->ops->reset           = PCReset_FieldSplit;
31240971522cSBarry Smith   pc->ops->destroy         = PCDestroy_FieldSplit;
31250971522cSBarry Smith   pc->ops->setfromoptions  = PCSetFromOptions_FieldSplit;
31260971522cSBarry Smith   pc->ops->view            = PCView_FieldSplit;
31270a545947SLisandro Dalcin   pc->ops->applyrichardson = NULL;
31280971522cSBarry Smith 
3129285fb4e2SStefano Zampini   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSchurGetSubKSP_C",PCFieldSplitSchurGetSubKSP_FieldSplit);CHKERRQ(ierr);
3130bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitGetSubKSP_C",PCFieldSplitGetSubKSP_FieldSplit);CHKERRQ(ierr);
3131bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetFields_C",PCFieldSplitSetFields_FieldSplit);CHKERRQ(ierr);
3132bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetIS_C",PCFieldSplitSetIS_FieldSplit);CHKERRQ(ierr);
3133bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetType_C",PCFieldSplitSetType_FieldSplit);CHKERRQ(ierr);
3134bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetBlockSize_C",PCFieldSplitSetBlockSize_FieldSplit);CHKERRQ(ierr);
31356dbb499eSCian Wilson   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitRestrictIS_C",PCFieldSplitRestrictIS_FieldSplit);CHKERRQ(ierr);
31360971522cSBarry Smith   PetscFunctionReturn(0);
31370971522cSBarry Smith }
3138