xref: /petsc/src/ksp/pc/impls/fieldsplit/fieldsplit.c (revision 443836d0654b40846fccabc3a79cd82bae4da55d)
1dba47a55SKris Buschelman 
2b45d2f2cSJed Brown #include <petsc-private/pcimpl.h>     /*I "petscpc.h" I*/
33c48a1e8SJed Brown #include <petscdmcomposite.h>   /*I "petscdmcomposite.h" I*/
40971522cSBarry Smith 
5*443836d0SMatthew G Knepley /*
6*443836d0SMatthew G Knepley   There is a nice discussion of block preconditioners in
7*443836d0SMatthew G Knepley 
8*443836d0SMatthew G Knepley [El08] A taxonomy and comparison of parallel block multi-level preconditioners for the incompressible Navier–Stokes equations
9*443836d0SMatthew G Knepley        Howard Elman, V.E. Howle, John Shadid, Robert Shuttleworth, Ray Tuminaro, Journal of Computational Physics 227 (2008) 1790--1808
10*443836d0SMatthew G Knepley        http://59a2.org/na/ElmanAO-TaxonomyParallelBlockMultiLevelPreconditionersIncompressibleNavierStokes-2008.pdf
11*443836d0SMatthew G Knepley */
12*443836d0SMatthew G Knepley 
13f7c28744SJed Brown const char *const PCFieldSplitSchurPreTypes[] = {"SELF","DIAG","USER","PCFieldSplitSchurPreType","PC_FIELDSPLIT_SCHUR_PRE_",0};
14c9c6ffaaSJed Brown const char *const PCFieldSplitSchurFactTypes[] = {"DIAG","LOWER","UPPER","FULL","PCFieldSplitSchurFactType","PC_FIELDSPLIT_SCHUR_FACT_",0};
15c5d2311dSJed Brown 
160971522cSBarry Smith typedef struct _PC_FieldSplitLink *PC_FieldSplitLink;
170971522cSBarry Smith struct _PC_FieldSplitLink {
1869a612a9SBarry Smith   KSP               ksp;
19*443836d0SMatthew G Knepley   Vec               x,y,z;
20db4c96c1SJed Brown   char              *splitname;
210971522cSBarry Smith   PetscInt          nfields;
225d4c12cdSJungho Lee   PetscInt          *fields,*fields_col;
231b9fc7fcSBarry Smith   VecScatter        sctx;
245d4c12cdSJungho Lee   IS                is,is_col;
2551f519a2SBarry Smith   PC_FieldSplitLink next,previous;
260971522cSBarry Smith };
270971522cSBarry Smith 
280971522cSBarry Smith typedef struct {
2968dd23aaSBarry Smith   PCCompositeType                    type;
30ace3abfcSBarry Smith   PetscBool                          defaultsplit; /* Flag for a system with a set of 'k' scalar fields with the same layout (and bs = k) */
31ace3abfcSBarry Smith   PetscBool                          splitdefined; /* Flag is set after the splits have been defined, to prevent more splits from being added */
32ace3abfcSBarry Smith   PetscBool                          realdiagonal; /* Flag to use the diagonal blocks of mat preconditioned by pmat, instead of just pmat */
3330ad9308SMatthew Knepley   PetscInt                           bs;           /* Block size for IS and Mat structures */
3430ad9308SMatthew Knepley   PetscInt                           nsplits;      /* Number of field divisions defined */
3579416396SBarry Smith   Vec                                *x,*y,w1,w2;
36519d70e2SJed Brown   Mat                                *mat;         /* The diagonal block for each split */
37519d70e2SJed Brown   Mat                                *pmat;        /* The preconditioning diagonal block for each split */
3830ad9308SMatthew Knepley   Mat                                *Afield;      /* The rows of the matrix associated with each split */
39ace3abfcSBarry Smith   PetscBool                          issetup;
4030ad9308SMatthew Knepley   /* Only used when Schur complement preconditioning is used */
4130ad9308SMatthew Knepley   Mat                                B;            /* The (0,1) block */
4230ad9308SMatthew Knepley   Mat                                C;            /* The (1,0) block */
43*443836d0SMatthew G Knepley   Mat                                schur;        /* The Schur complement S = A11 - A10 A00^{-1} A01, the KSP here, kspinner, is H_1 in [El08] */
44084e4875SJed Brown   Mat                                schur_user;   /* User-provided preconditioning matrix for the Schur complement */
45084e4875SJed Brown   PCFieldSplitSchurPreType           schurpre; /* Determines which preconditioning matrix is used for the Schur complement */
46c9c6ffaaSJed Brown   PCFieldSplitSchurFactType schurfactorization;
4730ad9308SMatthew Knepley   KSP                                kspschur;     /* The solver for S */
48*443836d0SMatthew G Knepley   KSP                                kspupper;     /* The solver for A in the upper diagonal part of the factorization (H_2 in [El08]) */
4997bbdb24SBarry Smith   PC_FieldSplitLink                  head;
5063ec74ffSBarry Smith   PetscBool                          reset;         /* indicates PCReset() has been last called on this object, hack */
51c1570756SJed Brown   PetscBool                          suboptionsset; /* Indicates that the KSPSetFromOptions() has been called on the sub-KSPs */
520971522cSBarry Smith } PC_FieldSplit;
530971522cSBarry Smith 
5416913363SBarry Smith /*
5516913363SBarry Smith     Notes: there is no particular reason that pmat, x, and y are stored as arrays in PC_FieldSplit instead of
5616913363SBarry Smith    inside PC_FieldSplitLink, just historical. If you want to be able to add new fields after already using the
5716913363SBarry Smith    PC you could change this.
5816913363SBarry Smith */
59084e4875SJed Brown 
60e6cab6aaSJed Brown /* This helper is so that setting a user-provided preconditioning matrix is orthogonal to choosing to use it.  This way the
61084e4875SJed Brown * application-provided FormJacobian can provide this matrix without interfering with the user's (command-line) choices. */
62084e4875SJed Brown static Mat FieldSplitSchurPre(PC_FieldSplit *jac)
63084e4875SJed Brown {
64084e4875SJed Brown   switch (jac->schurpre) {
65084e4875SJed Brown     case PC_FIELDSPLIT_SCHUR_PRE_SELF: return jac->schur;
66084e4875SJed Brown     case PC_FIELDSPLIT_SCHUR_PRE_DIAG: return jac->pmat[1];
67084e4875SJed Brown     case PC_FIELDSPLIT_SCHUR_PRE_USER: /* Use a user-provided matrix if it is given, otherwise diagonal block */
68084e4875SJed Brown     default:
69084e4875SJed Brown       return jac->schur_user ? jac->schur_user : jac->pmat[1];
70084e4875SJed Brown   }
71084e4875SJed Brown }
72084e4875SJed Brown 
73084e4875SJed Brown 
740971522cSBarry Smith #undef __FUNCT__
750971522cSBarry Smith #define __FUNCT__ "PCView_FieldSplit"
760971522cSBarry Smith static PetscErrorCode PCView_FieldSplit(PC pc,PetscViewer viewer)
770971522cSBarry Smith {
780971522cSBarry Smith   PC_FieldSplit     *jac = (PC_FieldSplit*)pc->data;
790971522cSBarry Smith   PetscErrorCode    ierr;
80ace3abfcSBarry Smith   PetscBool         iascii;
810971522cSBarry Smith   PetscInt          i,j;
825a9f2f41SSatish Balay   PC_FieldSplitLink ilink = jac->head;
830971522cSBarry Smith 
840971522cSBarry Smith   PetscFunctionBegin;
85251f4c67SDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&iascii);CHKERRQ(ierr);
860971522cSBarry Smith   if (iascii) {
872c9966d7SBarry Smith     if (jac->bs > 0) {
8851f519a2SBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"  FieldSplit with %s composition: total splits = %D, blocksize = %D\n",PCCompositeTypes[jac->type],jac->nsplits,jac->bs);CHKERRQ(ierr);
892c9966d7SBarry Smith     } else {
902c9966d7SBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"  FieldSplit with %s composition: total splits = %D\n",PCCompositeTypes[jac->type],jac->nsplits);CHKERRQ(ierr);
912c9966d7SBarry Smith     }
92a3df900dSMatthew G Knepley     if (jac->realdiagonal) {
93a3df900dSMatthew G Knepley       ierr = PetscViewerASCIIPrintf(viewer,"  using actual matrix for blocks rather than preconditioner matrix\n");CHKERRQ(ierr);
94a3df900dSMatthew G Knepley     }
9569a612a9SBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"  Solver info for each split is in the following KSP objects:\n");CHKERRQ(ierr);
960971522cSBarry Smith     ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
970971522cSBarry Smith     for (i=0; i<jac->nsplits; i++) {
981ab39975SBarry Smith       if (ilink->fields) {
990971522cSBarry Smith 	ierr = PetscViewerASCIIPrintf(viewer,"Split number %D Fields ",i);CHKERRQ(ierr);
10079416396SBarry Smith 	ierr = PetscViewerASCIIUseTabs(viewer,PETSC_FALSE);CHKERRQ(ierr);
1015a9f2f41SSatish Balay 	for (j=0; j<ilink->nfields; j++) {
10279416396SBarry Smith 	  if (j > 0) {
10379416396SBarry Smith 	    ierr = PetscViewerASCIIPrintf(viewer,",");CHKERRQ(ierr);
10479416396SBarry Smith 	  }
1055a9f2f41SSatish Balay 	  ierr = PetscViewerASCIIPrintf(viewer," %D",ilink->fields[j]);CHKERRQ(ierr);
1060971522cSBarry Smith 	}
1070971522cSBarry Smith 	ierr = PetscViewerASCIIPrintf(viewer,"\n");CHKERRQ(ierr);
10879416396SBarry Smith         ierr = PetscViewerASCIIUseTabs(viewer,PETSC_TRUE);CHKERRQ(ierr);
1091ab39975SBarry Smith       } else {
1101ab39975SBarry Smith 	ierr = PetscViewerASCIIPrintf(viewer,"Split number %D Defined by IS\n",i);CHKERRQ(ierr);
1111ab39975SBarry Smith       }
1125a9f2f41SSatish Balay       ierr = KSPView(ilink->ksp,viewer);CHKERRQ(ierr);
1135a9f2f41SSatish Balay       ilink = ilink->next;
1140971522cSBarry Smith     }
1150971522cSBarry Smith     ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
1160971522cSBarry Smith   } else {
11765e19b50SBarry Smith     SETERRQ1(((PetscObject)pc)->comm,PETSC_ERR_SUP,"Viewer type %s not supported for PCFieldSplit",((PetscObject)viewer)->type_name);
1180971522cSBarry Smith   }
1190971522cSBarry Smith   PetscFunctionReturn(0);
1200971522cSBarry Smith }
1210971522cSBarry Smith 
1220971522cSBarry Smith #undef __FUNCT__
1233b224e63SBarry Smith #define __FUNCT__ "PCView_FieldSplit_Schur"
1243b224e63SBarry Smith static PetscErrorCode PCView_FieldSplit_Schur(PC pc,PetscViewer viewer)
1253b224e63SBarry Smith {
1263b224e63SBarry Smith   PC_FieldSplit     *jac = (PC_FieldSplit*)pc->data;
1273b224e63SBarry Smith   PetscErrorCode    ierr;
128ace3abfcSBarry Smith   PetscBool         iascii;
1293b224e63SBarry Smith   PetscInt          i,j;
1303b224e63SBarry Smith   PC_FieldSplitLink ilink = jac->head;
1313b224e63SBarry Smith   KSP               ksp;
1323b224e63SBarry Smith 
1333b224e63SBarry Smith   PetscFunctionBegin;
134251f4c67SDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&iascii);CHKERRQ(ierr);
1353b224e63SBarry Smith   if (iascii) {
1362c9966d7SBarry Smith     if (jac->bs > 0) {
137c9c6ffaaSJed Brown       ierr = PetscViewerASCIIPrintf(viewer,"  FieldSplit with Schur preconditioner, blocksize = %D, factorization %s\n",jac->bs,PCFieldSplitSchurFactTypes[jac->schurfactorization]);CHKERRQ(ierr);
1382c9966d7SBarry Smith     } else {
1392c9966d7SBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"  FieldSplit with Schur preconditioner, factorization %s\n",PCFieldSplitSchurFactTypes[jac->schurfactorization]);CHKERRQ(ierr);
1402c9966d7SBarry Smith     }
141a3df900dSMatthew G Knepley     if (jac->realdiagonal) {
142a3df900dSMatthew G Knepley       ierr = PetscViewerASCIIPrintf(viewer,"  using actual matrix for blocks rather than preconditioner matrix\n");CHKERRQ(ierr);
143a3df900dSMatthew G Knepley     }
1443e8b8b31SMatthew G Knepley     switch(jac->schurpre) {
1453e8b8b31SMatthew G Knepley     case PC_FIELDSPLIT_SCHUR_PRE_SELF:
1463e8b8b31SMatthew G Knepley       ierr = PetscViewerASCIIPrintf(viewer,"  Preconditioner for the Schur complement formed from S itself\n");CHKERRQ(ierr);break;
147b02e2d75SMatthew G Knepley     case PC_FIELDSPLIT_SCHUR_PRE_DIAG:
1483e8b8b31SMatthew G Knepley       ierr = PetscViewerASCIIPrintf(viewer,"  Preconditioner for the Schur complement formed from the block diagonal part of A11\n");CHKERRQ(ierr);break;
1493e8b8b31SMatthew G Knepley     case PC_FIELDSPLIT_SCHUR_PRE_USER:
1503e8b8b31SMatthew G Knepley       if (jac->schur_user) {
1513e8b8b31SMatthew G Knepley         ierr = PetscViewerASCIIPrintf(viewer,"  Preconditioner for the Schur complement formed from user provided matrix\n");CHKERRQ(ierr);
1523e8b8b31SMatthew G Knepley       } else {
1533e8b8b31SMatthew G Knepley       ierr = PetscViewerASCIIPrintf(viewer,"  Preconditioner for the Schur complement formed from the block diagonal part of A11\n");CHKERRQ(ierr);
1543e8b8b31SMatthew G Knepley       }
1553e8b8b31SMatthew G Knepley       break;
1563e8b8b31SMatthew G Knepley     default:
1573e8b8b31SMatthew G Knepley       SETERRQ1(((PetscObject) pc)->comm, PETSC_ERR_ARG_OUTOFRANGE, "Invalid Schur preconditioning type: %d", jac->schurpre);
1583e8b8b31SMatthew G Knepley     }
1593b224e63SBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"  Split info:\n");CHKERRQ(ierr);
1603b224e63SBarry Smith     ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
1613b224e63SBarry Smith     for (i=0; i<jac->nsplits; i++) {
1623b224e63SBarry Smith       if (ilink->fields) {
1633b224e63SBarry Smith 	ierr = PetscViewerASCIIPrintf(viewer,"Split number %D Fields ",i);CHKERRQ(ierr);
1643b224e63SBarry Smith 	ierr = PetscViewerASCIIUseTabs(viewer,PETSC_FALSE);CHKERRQ(ierr);
1653b224e63SBarry Smith 	for (j=0; j<ilink->nfields; j++) {
1663b224e63SBarry Smith 	  if (j > 0) {
1673b224e63SBarry Smith 	    ierr = PetscViewerASCIIPrintf(viewer,",");CHKERRQ(ierr);
1683b224e63SBarry Smith 	  }
1693b224e63SBarry Smith 	  ierr = PetscViewerASCIIPrintf(viewer," %D",ilink->fields[j]);CHKERRQ(ierr);
1703b224e63SBarry Smith 	}
1713b224e63SBarry Smith 	ierr = PetscViewerASCIIPrintf(viewer,"\n");CHKERRQ(ierr);
1723b224e63SBarry Smith         ierr = PetscViewerASCIIUseTabs(viewer,PETSC_TRUE);CHKERRQ(ierr);
1733b224e63SBarry Smith       } else {
1743b224e63SBarry Smith 	ierr = PetscViewerASCIIPrintf(viewer,"Split number %D Defined by IS\n",i);CHKERRQ(ierr);
1753b224e63SBarry Smith       }
1763b224e63SBarry Smith       ilink = ilink->next;
1773b224e63SBarry Smith     }
178435f959eSBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"KSP solver for A00 block \n");CHKERRQ(ierr);
1793b224e63SBarry Smith     ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
180*443836d0SMatthew G Knepley     ierr = KSPView(jac->head->ksp,viewer);CHKERRQ(ierr);
1813b224e63SBarry Smith     ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
182*443836d0SMatthew G Knepley     if (jac->kspupper != jac->head->ksp) {
183*443836d0SMatthew G Knepley       ierr = PetscViewerASCIIPrintf(viewer,"KSP solver for upper A00 in upper triangular factor \n");CHKERRQ(ierr);
184*443836d0SMatthew G Knepley       ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
185*443836d0SMatthew G Knepley       ierr = KSPView(jac->kspupper,viewer);CHKERRQ(ierr);
186*443836d0SMatthew G Knepley       ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
187*443836d0SMatthew G Knepley     }
188435f959eSBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"KSP solver for S = A11 - A10 inv(A00) A01 \n");CHKERRQ(ierr);
1893b224e63SBarry Smith     ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
19012cae6f2SJed Brown     if (jac->kspschur) {
1913b224e63SBarry Smith       ierr = KSPView(jac->kspschur,viewer);CHKERRQ(ierr);
19212cae6f2SJed Brown     } else {
19312cae6f2SJed Brown       ierr = PetscViewerASCIIPrintf(viewer,"  not yet available\n");CHKERRQ(ierr);
19412cae6f2SJed Brown     }
1953b224e63SBarry Smith     ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
1963b224e63SBarry Smith     ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
1973b224e63SBarry Smith   } else {
19865e19b50SBarry Smith     SETERRQ1(((PetscObject)pc)->comm,PETSC_ERR_SUP,"Viewer type %s not supported for PCFieldSplit",((PetscObject)viewer)->type_name);
1993b224e63SBarry Smith   }
2003b224e63SBarry Smith   PetscFunctionReturn(0);
2013b224e63SBarry Smith }
2023b224e63SBarry Smith 
2033b224e63SBarry Smith #undef __FUNCT__
2046c924f48SJed Brown #define __FUNCT__ "PCFieldSplitSetRuntimeSplits_Private"
2056c924f48SJed Brown /* Precondition: jac->bs is set to a meaningful value */
2066c924f48SJed Brown static PetscErrorCode PCFieldSplitSetRuntimeSplits_Private(PC pc)
2076c924f48SJed Brown {
2086c924f48SJed Brown   PetscErrorCode ierr;
2096c924f48SJed Brown   PC_FieldSplit  *jac = (PC_FieldSplit*)pc->data;
2105d4c12cdSJungho Lee   PetscInt       i,nfields,*ifields,nfields_col,*ifields_col;
2115d4c12cdSJungho Lee   PetscBool      flg,flg_col;
2125d4c12cdSJungho Lee   char           optionname[128],splitname[8],optionname_col[128];
2136c924f48SJed Brown 
2146c924f48SJed Brown   PetscFunctionBegin;
2156c924f48SJed Brown   ierr = PetscMalloc(jac->bs*sizeof(PetscInt),&ifields);CHKERRQ(ierr);
2165d4c12cdSJungho Lee   ierr = PetscMalloc(jac->bs*sizeof(PetscInt),&ifields_col);CHKERRQ(ierr);
2176c924f48SJed Brown   for (i=0,flg=PETSC_TRUE; ; i++) {
2188caf3d72SBarry Smith     ierr = PetscSNPrintf(splitname,sizeof(splitname),"%D",i);CHKERRQ(ierr);
2198caf3d72SBarry Smith     ierr = PetscSNPrintf(optionname,sizeof(optionname),"-pc_fieldsplit_%D_fields",i);CHKERRQ(ierr);
2208caf3d72SBarry Smith     ierr = PetscSNPrintf(optionname_col,sizeof(optionname_col),"-pc_fieldsplit_%D_fields_col",i);CHKERRQ(ierr);
2216c924f48SJed Brown     nfields = jac->bs;
22229499fbbSJungho Lee     nfields_col = jac->bs;
2236c924f48SJed Brown     ierr    = PetscOptionsGetIntArray(((PetscObject)pc)->prefix,optionname,ifields,&nfields,&flg);CHKERRQ(ierr);
2245d4c12cdSJungho Lee     ierr    = PetscOptionsGetIntArray(((PetscObject)pc)->prefix,optionname_col,ifields_col,&nfields_col,&flg_col);CHKERRQ(ierr);
2256c924f48SJed Brown     if (!flg) break;
2265d4c12cdSJungho Lee     else if (flg && !flg_col) {
2275d4c12cdSJungho Lee       if (!nfields) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_USER,"Cannot list zero fields");
2285d4c12cdSJungho Lee       ierr = PCFieldSplitSetFields(pc,splitname,nfields,ifields,ifields);CHKERRQ(ierr);
2295d4c12cdSJungho Lee     }
2305d4c12cdSJungho Lee     else {
2315d4c12cdSJungho Lee       if (!nfields || !nfields_col) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_USER,"Cannot list zero fields");
2325d4c12cdSJungho Lee       if (nfields != nfields_col) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_USER,"Number of row and column fields must match");
2335d4c12cdSJungho Lee       ierr = PCFieldSplitSetFields(pc,splitname,nfields,ifields,ifields_col);CHKERRQ(ierr);
2345d4c12cdSJungho Lee     }
2356c924f48SJed Brown   }
2366c924f48SJed Brown   if (i > 0) {
2376c924f48SJed Brown     /* Makes command-line setting of splits take precedence over setting them in code.
2386c924f48SJed Brown        Otherwise subsequent calls to PCFieldSplitSetIS() or PCFieldSplitSetFields() would
2396c924f48SJed Brown        create new splits, which would probably not be what the user wanted. */
2406c924f48SJed Brown     jac->splitdefined = PETSC_TRUE;
2416c924f48SJed Brown   }
2426c924f48SJed Brown   ierr = PetscFree(ifields);CHKERRQ(ierr);
2435d4c12cdSJungho Lee   ierr = PetscFree(ifields_col);CHKERRQ(ierr);
2446c924f48SJed Brown   PetscFunctionReturn(0);
2456c924f48SJed Brown }
2466c924f48SJed Brown 
2476c924f48SJed Brown #undef __FUNCT__
24869a612a9SBarry Smith #define __FUNCT__ "PCFieldSplitSetDefaults"
24969a612a9SBarry Smith static PetscErrorCode PCFieldSplitSetDefaults(PC pc)
2500971522cSBarry Smith {
2510971522cSBarry Smith   PC_FieldSplit     *jac  = (PC_FieldSplit*)pc->data;
2520971522cSBarry Smith   PetscErrorCode    ierr;
2535a9f2f41SSatish Balay   PC_FieldSplitLink ilink = jac->head;
2547287d2a3SDmitry Karpeev   PetscBool         fieldsplit_default = PETSC_FALSE,stokes = PETSC_FALSE;
2556c924f48SJed Brown   PetscInt          i;
2560971522cSBarry Smith 
2570971522cSBarry Smith   PetscFunctionBegin;
2587287d2a3SDmitry Karpeev   /*
2597287d2a3SDmitry Karpeev    Kinda messy, but at least this now uses DMCreateFieldDecomposition() even with jac->reset.
2607287d2a3SDmitry Karpeev    Should probably be rewritten.
2617287d2a3SDmitry Karpeev    */
2627287d2a3SDmitry Karpeev   if (!ilink || jac->reset) {
263d0af7cd3SBarry Smith     ierr = PetscOptionsGetBool(((PetscObject)pc)->prefix,"-pc_fieldsplit_detect_saddle_point",&stokes,PETSC_NULL);CHKERRQ(ierr);
264d0af7cd3SBarry Smith     if (pc->dm && !stokes) {
265bafc1b83SMatthew G Knepley       PetscInt     numFields, f, i, j;
2660784a22cSJed Brown       char       **fieldNames;
2677b62db95SJungho Lee       IS          *fields;
268e7c4fc90SDmitry Karpeev       DM          *dms;
269bafc1b83SMatthew G Knepley       DM           subdm[128];
270bafc1b83SMatthew G Knepley       PetscBool    flg;
271bafc1b83SMatthew G Knepley 
27216621825SDmitry Karpeev       ierr = DMCreateFieldDecomposition(pc->dm, &numFields, &fieldNames, &fields, &dms);CHKERRQ(ierr);
273bafc1b83SMatthew G Knepley       /* Allow the user to prescribe the splits */
274bafc1b83SMatthew G Knepley       for (i = 0, flg = PETSC_TRUE; ; i++) {
275bafc1b83SMatthew G Knepley         PetscInt ifields[128];
276bafc1b83SMatthew G Knepley         IS       compField;
277bafc1b83SMatthew G Knepley         char     optionname[128], splitname[8];
278bafc1b83SMatthew G Knepley         PetscInt nfields = numFields;
279bafc1b83SMatthew G Knepley 
2808caf3d72SBarry Smith         ierr = PetscSNPrintf(optionname, sizeof(optionname), "-pc_fieldsplit_%D_fields", i);CHKERRQ(ierr);
281bafc1b83SMatthew G Knepley         ierr = PetscOptionsGetIntArray(((PetscObject) pc)->prefix, optionname, ifields, &nfields, &flg);CHKERRQ(ierr);
282bafc1b83SMatthew G Knepley         if (!flg) break;
283bafc1b83SMatthew G Knepley         if (numFields > 128) SETERRQ1(((PetscObject) pc)->comm,PETSC_ERR_SUP,"Cannot currently support %d > 128 fields", numFields);
284bafc1b83SMatthew G Knepley         ierr = DMCreateSubDM(pc->dm, nfields, ifields, &compField, &subdm[i]);CHKERRQ(ierr);
285bafc1b83SMatthew G Knepley         if (nfields == 1) {
286bafc1b83SMatthew G Knepley           ierr = PCFieldSplitSetIS(pc, fieldNames[ifields[0]], compField);CHKERRQ(ierr);
2874d2389d7SMatthew G Knepley           /* ierr = PetscPrintf(((PetscObject) pc)->comm, "%s Field Indices:", fieldNames[ifields[0]]);CHKERRQ(ierr);
2884d2389d7SMatthew G Knepley              ierr = ISView(compField, PETSC_NULL);CHKERRQ(ierr); */
289bafc1b83SMatthew G Knepley         } else {
2908caf3d72SBarry Smith           ierr = PetscSNPrintf(splitname, sizeof(splitname), "%D", i);CHKERRQ(ierr);
291bafc1b83SMatthew G Knepley           ierr = PCFieldSplitSetIS(pc, splitname, compField);CHKERRQ(ierr);
2924d2389d7SMatthew G Knepley           /* ierr = PetscPrintf(((PetscObject) pc)->comm, "%s Field Indices:", splitname);CHKERRQ(ierr);
2934d2389d7SMatthew G Knepley              ierr = ISView(compField, PETSC_NULL);CHKERRQ(ierr); */
2947287d2a3SDmitry Karpeev         }
295bafc1b83SMatthew G Knepley         ierr = ISDestroy(&compField);CHKERRQ(ierr);
296bafc1b83SMatthew G Knepley         for (j = 0; j < nfields; ++j) {
297bafc1b83SMatthew G Knepley           f = ifields[j];
2987b62db95SJungho Lee           ierr = PetscFree(fieldNames[f]);CHKERRQ(ierr);
2997b62db95SJungho Lee           ierr = ISDestroy(&fields[f]);CHKERRQ(ierr);
3007b62db95SJungho Lee         }
301bafc1b83SMatthew G Knepley       }
302bafc1b83SMatthew G Knepley       if (i == 0) {
303bafc1b83SMatthew G Knepley         for (f = 0; f < numFields; ++f) {
304bafc1b83SMatthew G Knepley           ierr = PCFieldSplitSetIS(pc, fieldNames[f], fields[f]);CHKERRQ(ierr);
305bafc1b83SMatthew G Knepley           ierr = PetscFree(fieldNames[f]);CHKERRQ(ierr);
306bafc1b83SMatthew G Knepley           ierr = ISDestroy(&fields[f]);CHKERRQ(ierr);
307bafc1b83SMatthew G Knepley         }
308bafc1b83SMatthew G Knepley       } else {
309bafc1b83SMatthew G Knepley         ierr = PetscMalloc(i * sizeof(DM), &dms);CHKERRQ(ierr);
310bafc1b83SMatthew G Knepley         for (j = 0; j < i; ++j) {
311bafc1b83SMatthew G Knepley           dms[j] = subdm[j];
312bafc1b83SMatthew G Knepley         }
313bafc1b83SMatthew G Knepley       }
3147b62db95SJungho Lee       ierr = PetscFree(fieldNames);CHKERRQ(ierr);
3157b62db95SJungho Lee       ierr = PetscFree(fields);CHKERRQ(ierr);
316e7c4fc90SDmitry Karpeev       if (dms) {
3178b8307b2SJed Brown         ierr = PetscInfo(pc, "Setting up physics based fieldsplit preconditioner using the embedded DM\n");CHKERRQ(ierr);
318bafc1b83SMatthew G Knepley         for (ilink = jac->head, i = 0; ilink; ilink = ilink->next, ++i) {
3197287d2a3SDmitry Karpeev           const char *prefix;
3207287d2a3SDmitry Karpeev           ierr = PetscObjectGetOptionsPrefix((PetscObject)(ilink->ksp),&prefix); CHKERRQ(ierr);
3217287d2a3SDmitry Karpeev           ierr = PetscObjectSetOptionsPrefix((PetscObject)(dms[i]), prefix);     CHKERRQ(ierr);
3227b62db95SJungho Lee           ierr = KSPSetDM(ilink->ksp, dms[i]);CHKERRQ(ierr);
3237b62db95SJungho Lee           ierr = KSPSetDMActive(ilink->ksp, PETSC_FALSE);CHKERRQ(ierr);
3247287d2a3SDmitry Karpeev           ierr = PetscObjectIncrementTabLevel((PetscObject)dms[i],(PetscObject)ilink->ksp,0); CHKERRQ(ierr);
325e7c4fc90SDmitry Karpeev           ierr = DMDestroy(&dms[i]); CHKERRQ(ierr);
3262fa5ba8aSJed Brown         }
3277b62db95SJungho Lee         ierr = PetscFree(dms);CHKERRQ(ierr);
3288b8307b2SJed Brown       }
32966ffff09SJed Brown     } else {
330521d7252SBarry Smith       if (jac->bs <= 0) {
331704ba839SBarry Smith         if (pc->pmat) {
332521d7252SBarry Smith           ierr   = MatGetBlockSize(pc->pmat,&jac->bs);CHKERRQ(ierr);
333704ba839SBarry Smith         } else {
334704ba839SBarry Smith           jac->bs = 1;
335704ba839SBarry Smith         }
336521d7252SBarry Smith       }
337d32f9abdSBarry Smith 
3387287d2a3SDmitry Karpeev       ierr = PetscOptionsGetBool(((PetscObject)pc)->prefix,"-pc_fieldsplit_default",&fieldsplit_default,PETSC_NULL);CHKERRQ(ierr);
3396ce1633cSBarry Smith       if (stokes) {
3406ce1633cSBarry Smith         IS       zerodiags,rest;
3416ce1633cSBarry Smith         PetscInt nmin,nmax;
3426ce1633cSBarry Smith 
3436ce1633cSBarry Smith         ierr = MatGetOwnershipRange(pc->mat,&nmin,&nmax);CHKERRQ(ierr);
3446ce1633cSBarry Smith         ierr = MatFindZeroDiagonals(pc->mat,&zerodiags);CHKERRQ(ierr);
3456ce1633cSBarry Smith         ierr = ISComplement(zerodiags,nmin,nmax,&rest);CHKERRQ(ierr);
3467287d2a3SDmitry Karpeev         if (jac->reset) {
3477287d2a3SDmitry Karpeev           jac->head->is       = rest;
3487287d2a3SDmitry Karpeev           jac->head->next->is = zerodiags;
3497287d2a3SDmitry Karpeev         }
3507287d2a3SDmitry Karpeev         else {
3516ce1633cSBarry Smith           ierr = PCFieldSplitSetIS(pc,"0",rest);CHKERRQ(ierr);
3526ce1633cSBarry Smith           ierr = PCFieldSplitSetIS(pc,"1",zerodiags);CHKERRQ(ierr);
3537287d2a3SDmitry Karpeev         }
354fcfd50ebSBarry Smith         ierr = ISDestroy(&zerodiags);CHKERRQ(ierr);
355fcfd50ebSBarry Smith         ierr = ISDestroy(&rest);CHKERRQ(ierr);
3566ce1633cSBarry Smith       } else {
3577287d2a3SDmitry Karpeev         if (jac->reset)
3587287d2a3SDmitry Karpeev           SETERRQ(((PetscObject)pc)->comm,PETSC_ERR_SUP,"Cases not yet handled when PCReset() was used");
3597287d2a3SDmitry Karpeev         if (!fieldsplit_default) {
360d32f9abdSBarry Smith           /* Allow user to set fields from command line,  if bs was known at the time of PCSetFromOptions_FieldSplit()
361d32f9abdSBarry Smith            then it is set there. This is not ideal because we should only have options set in XXSetFromOptions(). */
3626c924f48SJed Brown           ierr = PCFieldSplitSetRuntimeSplits_Private(pc);CHKERRQ(ierr);
3636c924f48SJed Brown           if (jac->splitdefined) {ierr = PetscInfo(pc,"Splits defined using the options database\n");CHKERRQ(ierr);}
364d32f9abdSBarry Smith         }
3657287d2a3SDmitry Karpeev         if (fieldsplit_default || !jac->splitdefined) {
366d32f9abdSBarry Smith           ierr = PetscInfo(pc,"Using default splitting of fields\n");CHKERRQ(ierr);
367db4c96c1SJed Brown           for (i=0; i<jac->bs; i++) {
3686c924f48SJed Brown             char splitname[8];
3698caf3d72SBarry Smith             ierr = PetscSNPrintf(splitname,sizeof(splitname),"%D",i);CHKERRQ(ierr);
3705d4c12cdSJungho Lee             ierr = PCFieldSplitSetFields(pc,splitname,1,&i,&i);CHKERRQ(ierr);
37179416396SBarry Smith           }
3725d4c12cdSJungho Lee           jac->defaultsplit = PETSC_TRUE;
373521d7252SBarry Smith         }
37466ffff09SJed Brown       }
3756ce1633cSBarry Smith     }
376edf189efSBarry Smith   } else if (jac->nsplits == 1) {
377edf189efSBarry Smith     if (ilink->is) {
378edf189efSBarry Smith       IS       is2;
379edf189efSBarry Smith       PetscInt nmin,nmax;
380edf189efSBarry Smith 
381edf189efSBarry Smith       ierr = MatGetOwnershipRange(pc->mat,&nmin,&nmax);CHKERRQ(ierr);
382edf189efSBarry Smith       ierr = ISComplement(ilink->is,nmin,nmax,&is2);CHKERRQ(ierr);
383db4c96c1SJed Brown       ierr = PCFieldSplitSetIS(pc,"1",is2);CHKERRQ(ierr);
384fcfd50ebSBarry Smith       ierr = ISDestroy(&is2);CHKERRQ(ierr);
3857b62db95SJungho Lee     } else SETERRQ(((PetscObject) pc)->comm,PETSC_ERR_SUP,"Must provide at least two sets of fields to PCFieldSplit()");
386edf189efSBarry Smith   }
387d0af7cd3SBarry Smith 
388d0af7cd3SBarry Smith 
3897b62db95SJungho Lee   if (jac->nsplits < 2) SETERRQ1(((PetscObject) pc)->comm,PETSC_ERR_PLIB,"Unhandled case, must have at least two fields, not %d", jac->nsplits);
39069a612a9SBarry Smith   PetscFunctionReturn(0);
39169a612a9SBarry Smith }
39269a612a9SBarry Smith 
393514bf10dSMatthew G Knepley PetscErrorCode PetscOptionsFindPairPrefix_Private(const char pre[], const char name[], char *value[], PetscBool *flg);
394514bf10dSMatthew G Knepley 
39569a612a9SBarry Smith #undef __FUNCT__
39669a612a9SBarry Smith #define __FUNCT__ "PCSetUp_FieldSplit"
39769a612a9SBarry Smith static PetscErrorCode PCSetUp_FieldSplit(PC pc)
39869a612a9SBarry Smith {
39969a612a9SBarry Smith   PC_FieldSplit     *jac = (PC_FieldSplit*)pc->data;
40069a612a9SBarry Smith   PetscErrorCode    ierr;
4015a9f2f41SSatish Balay   PC_FieldSplitLink ilink;
4022c9966d7SBarry Smith   PetscInt          i,nsplit;
40369a612a9SBarry Smith   MatStructure      flag = pc->flag;
4045f4ab4e1SJungho Lee   PetscBool         sorted, sorted_col;
40569a612a9SBarry Smith 
40669a612a9SBarry Smith   PetscFunctionBegin;
40769a612a9SBarry Smith   ierr   = PCFieldSplitSetDefaults(pc);CHKERRQ(ierr);
40897bbdb24SBarry Smith   nsplit = jac->nsplits;
4095a9f2f41SSatish Balay   ilink  = jac->head;
41097bbdb24SBarry Smith 
41197bbdb24SBarry Smith   /* get the matrices for each split */
412704ba839SBarry Smith   if (!jac->issetup) {
4131b9fc7fcSBarry Smith     PetscInt rstart,rend,nslots,bs;
41497bbdb24SBarry Smith 
415704ba839SBarry Smith     jac->issetup = PETSC_TRUE;
416704ba839SBarry Smith 
4175d4c12cdSJungho Lee     /* This is done here instead of in PCFieldSplitSetFields() because may not have matrix at that point */
4182c9966d7SBarry Smith     if (jac->defaultsplit || !ilink->is) {
4192c9966d7SBarry Smith       if (jac->bs <= 0) jac->bs = nsplit;
4202c9966d7SBarry Smith     }
42151f519a2SBarry Smith     bs     = jac->bs;
42297bbdb24SBarry Smith     ierr   = MatGetOwnershipRange(pc->pmat,&rstart,&rend);CHKERRQ(ierr);
4231b9fc7fcSBarry Smith     nslots = (rend - rstart)/bs;
4241b9fc7fcSBarry Smith     for (i=0; i<nsplit; i++) {
4251b9fc7fcSBarry Smith       if (jac->defaultsplit) {
426704ba839SBarry Smith         ierr = ISCreateStride(((PetscObject)pc)->comm,nslots,rstart+i,nsplit,&ilink->is);CHKERRQ(ierr);
4275f4ab4e1SJungho Lee         ierr = ISDuplicate(ilink->is,&ilink->is_col);CHKERRQ(ierr);
428704ba839SBarry Smith       } else if (!ilink->is) {
429ccb205f8SBarry Smith         if (ilink->nfields > 1) {
4305f4ab4e1SJungho Lee           PetscInt   *ii,*jj,j,k,nfields = ilink->nfields,*fields = ilink->fields,*fields_col = ilink->fields_col;
4315a9f2f41SSatish Balay           ierr = PetscMalloc(ilink->nfields*nslots*sizeof(PetscInt),&ii);CHKERRQ(ierr);
4325f4ab4e1SJungho Lee           ierr = PetscMalloc(ilink->nfields*nslots*sizeof(PetscInt),&jj);CHKERRQ(ierr);
4331b9fc7fcSBarry Smith           for (j=0; j<nslots; j++) {
4341b9fc7fcSBarry Smith             for (k=0; k<nfields; k++) {
4351b9fc7fcSBarry Smith               ii[nfields*j + k] = rstart + bs*j + fields[k];
4365f4ab4e1SJungho Lee               jj[nfields*j + k] = rstart + bs*j + fields_col[k];
43797bbdb24SBarry Smith             }
43897bbdb24SBarry Smith           }
439d67e408aSBarry Smith           ierr = ISCreateGeneral(((PetscObject)pc)->comm,nslots*nfields,ii,PETSC_OWN_POINTER,&ilink->is);CHKERRQ(ierr);
4405f4ab4e1SJungho Lee           ierr = ISCreateGeneral(((PetscObject)pc)->comm,nslots*nfields,jj,PETSC_OWN_POINTER,&ilink->is_col);CHKERRQ(ierr);
441ccb205f8SBarry Smith         } else {
442704ba839SBarry Smith           ierr = ISCreateStride(((PetscObject)pc)->comm,nslots,rstart+ilink->fields[0],bs,&ilink->is);CHKERRQ(ierr);
4435f4ab4e1SJungho Lee           ierr = ISCreateStride(((PetscObject)pc)->comm,nslots,rstart+ilink->fields_col[0],bs,&ilink->is_col);CHKERRQ(ierr);
444ccb205f8SBarry Smith        }
4453e197d65SBarry Smith       }
446704ba839SBarry Smith       ierr = ISSorted(ilink->is,&sorted);CHKERRQ(ierr);
4475f4ab4e1SJungho Lee       if (ilink->is_col) { ierr = ISSorted(ilink->is_col,&sorted_col);CHKERRQ(ierr); }
4485f4ab4e1SJungho Lee       if (!sorted || !sorted_col) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_USER,"Fields must be sorted when creating split");
449704ba839SBarry Smith       ilink = ilink->next;
4501b9fc7fcSBarry Smith     }
4511b9fc7fcSBarry Smith   }
4521b9fc7fcSBarry Smith 
453704ba839SBarry Smith   ilink  = jac->head;
45497bbdb24SBarry Smith   if (!jac->pmat) {
455bdddcaaaSMatthew G Knepley     Vec xtmp;
456bdddcaaaSMatthew G Knepley 
457bdddcaaaSMatthew G Knepley     ierr = MatGetVecs(pc->pmat,&xtmp,PETSC_NULL);CHKERRQ(ierr);
458cf502942SBarry Smith     ierr = PetscMalloc(nsplit*sizeof(Mat),&jac->pmat);CHKERRQ(ierr);
459bdddcaaaSMatthew G Knepley     ierr = PetscMalloc2(nsplit,Vec,&jac->x,nsplit,Vec,&jac->y);CHKERRQ(ierr);
460cf502942SBarry Smith     for (i=0; i<nsplit; i++) {
461bdddcaaaSMatthew G Knepley       MatNullSpace sp;
462bdddcaaaSMatthew G Knepley 
463a3df900dSMatthew G Knepley       /* Check for preconditioning matrix attached to IS */
464a3df900dSMatthew G Knepley       ierr = PetscObjectQuery((PetscObject) ilink->is, "pmat", (PetscObject *) &jac->pmat[i]);CHKERRQ(ierr);
465a3df900dSMatthew G Knepley       if (jac->pmat[i]) {
466a3df900dSMatthew G Knepley         ierr = PetscObjectReference((PetscObject) jac->pmat[i]);CHKERRQ(ierr);
467a3df900dSMatthew G Knepley         if (jac->type == PC_COMPOSITE_SCHUR) {
468a3df900dSMatthew G Knepley           jac->schur_user = jac->pmat[i];
469a3df900dSMatthew G Knepley           ierr = PetscObjectReference((PetscObject) jac->schur_user);CHKERRQ(ierr);
470a3df900dSMatthew G Knepley         }
471a3df900dSMatthew G Knepley       } else {
4725f4ab4e1SJungho Lee         ierr = MatGetSubMatrix(pc->pmat,ilink->is,ilink->is_col,MAT_INITIAL_MATRIX,&jac->pmat[i]);CHKERRQ(ierr);
473a3df900dSMatthew G Knepley       }
474bdddcaaaSMatthew G Knepley       /* create work vectors for each split */
475bdddcaaaSMatthew G Knepley       ierr = MatGetVecs(jac->pmat[i],&jac->x[i],&jac->y[i]);CHKERRQ(ierr);
476*443836d0SMatthew G Knepley       ilink->x = jac->x[i]; ilink->y = jac->y[i]; ilink->z = PETSC_NULL;
477bdddcaaaSMatthew G Knepley       /* compute scatter contexts needed by multiplicative versions and non-default splits */
478bdddcaaaSMatthew G Knepley       ierr = VecScatterCreate(xtmp,ilink->is,jac->x[i],PETSC_NULL,&ilink->sctx);CHKERRQ(ierr);
479ed1f0337SMatthew G Knepley       /* Check for null space attached to IS */
480bafc1b83SMatthew G Knepley       ierr = PetscObjectQuery((PetscObject) ilink->is, "nullspace", (PetscObject *) &sp);CHKERRQ(ierr);
481bafc1b83SMatthew G Knepley       if (sp) {
482bafc1b83SMatthew G Knepley         ierr  = MatSetNullSpace(jac->pmat[i], sp);CHKERRQ(ierr);
483bafc1b83SMatthew G Knepley       }
484ed1f0337SMatthew G Knepley       ierr = PetscObjectQuery((PetscObject) ilink->is, "nearnullspace", (PetscObject *) &sp);CHKERRQ(ierr);
485ed1f0337SMatthew G Knepley       if (sp) {
486ed1f0337SMatthew G Knepley         ierr  = MatSetNearNullSpace(jac->pmat[i], sp);CHKERRQ(ierr);
487ed1f0337SMatthew G Knepley       }
488704ba839SBarry Smith       ilink = ilink->next;
489cf502942SBarry Smith     }
490bdddcaaaSMatthew G Knepley     ierr = VecDestroy(&xtmp);CHKERRQ(ierr);
49197bbdb24SBarry Smith   } else {
492cf502942SBarry Smith     for (i=0; i<nsplit; i++) {
493a3df900dSMatthew G Knepley       Mat pmat;
494a3df900dSMatthew G Knepley 
495a3df900dSMatthew G Knepley       /* Check for preconditioning matrix attached to IS */
496a3df900dSMatthew G Knepley       ierr = PetscObjectQuery((PetscObject) ilink->is, "pmat", (PetscObject *) &pmat);CHKERRQ(ierr);
497a3df900dSMatthew G Knepley       if (!pmat) {
4985f4ab4e1SJungho Lee         ierr = MatGetSubMatrix(pc->pmat,ilink->is,ilink->is_col,MAT_REUSE_MATRIX,&jac->pmat[i]);CHKERRQ(ierr);
499a3df900dSMatthew G Knepley       }
500704ba839SBarry Smith       ilink = ilink->next;
501cf502942SBarry Smith     }
50297bbdb24SBarry Smith   }
503519d70e2SJed Brown   if (jac->realdiagonal) {
504519d70e2SJed Brown     ilink = jac->head;
505519d70e2SJed Brown     if (!jac->mat) {
506519d70e2SJed Brown       ierr = PetscMalloc(nsplit*sizeof(Mat),&jac->mat);CHKERRQ(ierr);
507519d70e2SJed Brown       for (i=0; i<nsplit; i++) {
5085f4ab4e1SJungho Lee         ierr = MatGetSubMatrix(pc->mat,ilink->is,ilink->is_col,MAT_INITIAL_MATRIX,&jac->mat[i]);CHKERRQ(ierr);
509519d70e2SJed Brown         ilink = ilink->next;
510519d70e2SJed Brown       }
511519d70e2SJed Brown     } else {
512519d70e2SJed Brown       for (i=0; i<nsplit; i++) {
5135f4ab4e1SJungho Lee         if (jac->mat[i]) {ierr = MatGetSubMatrix(pc->mat,ilink->is,ilink->is_col,MAT_REUSE_MATRIX,&jac->mat[i]);CHKERRQ(ierr);}
514519d70e2SJed Brown         ilink = ilink->next;
515519d70e2SJed Brown       }
516519d70e2SJed Brown     }
517519d70e2SJed Brown   } else {
518519d70e2SJed Brown     jac->mat = jac->pmat;
519519d70e2SJed Brown   }
52097bbdb24SBarry Smith 
5216c8605c2SJed Brown   if (jac->type != PC_COMPOSITE_ADDITIVE  && jac->type != PC_COMPOSITE_SCHUR) {
52268dd23aaSBarry Smith     /* extract the rows of the matrix associated with each field: used for efficient computation of residual inside algorithm */
52368dd23aaSBarry Smith     ilink  = jac->head;
52468dd23aaSBarry Smith     if (!jac->Afield) {
52568dd23aaSBarry Smith       ierr = PetscMalloc(nsplit*sizeof(Mat),&jac->Afield);CHKERRQ(ierr);
52668dd23aaSBarry Smith       for (i=0; i<nsplit; i++) {
5274aa3045dSJed Brown         ierr = MatGetSubMatrix(pc->mat,ilink->is,PETSC_NULL,MAT_INITIAL_MATRIX,&jac->Afield[i]);CHKERRQ(ierr);
52868dd23aaSBarry Smith         ilink = ilink->next;
52968dd23aaSBarry Smith       }
53068dd23aaSBarry Smith     } else {
53168dd23aaSBarry Smith       for (i=0; i<nsplit; i++) {
5324aa3045dSJed Brown         ierr = MatGetSubMatrix(pc->mat,ilink->is,PETSC_NULL,MAT_REUSE_MATRIX,&jac->Afield[i]);CHKERRQ(ierr);
53368dd23aaSBarry Smith         ilink = ilink->next;
53468dd23aaSBarry Smith       }
53568dd23aaSBarry Smith     }
53668dd23aaSBarry Smith   }
53768dd23aaSBarry Smith 
5383b224e63SBarry Smith   if (jac->type == PC_COMPOSITE_SCHUR) {
5393b224e63SBarry Smith     IS       ccis;
5404aa3045dSJed Brown     PetscInt rstart,rend;
541093c86ffSJed Brown     char     lscname[256];
542093c86ffSJed Brown     PetscObject LSC_L;
543e7e72b3dSBarry Smith     if (nsplit != 2) SETERRQ(((PetscObject)pc)->comm,PETSC_ERR_ARG_INCOMP,"To use Schur complement preconditioner you must have exactly 2 fields");
54468dd23aaSBarry Smith 
545e6cab6aaSJed Brown     /* When extracting off-diagonal submatrices, we take complements from this range */
546e6cab6aaSJed Brown     ierr  = MatGetOwnershipRangeColumn(pc->mat,&rstart,&rend);CHKERRQ(ierr);
547e6cab6aaSJed Brown 
5483b224e63SBarry Smith     /* need to handle case when one is resetting up the preconditioner */
5493b224e63SBarry Smith     if (jac->schur) {
550*443836d0SMatthew G Knepley       KSP kspA, kspInner, kspUpper;
551*443836d0SMatthew G Knepley 
552*443836d0SMatthew G Knepley       ierr = MatSchurComplementGetKSP(jac->schur, kspInner);CHKERRQ(ierr);
5533b224e63SBarry Smith       ilink = jac->head;
55449bb4cd7SJungho Lee       ierr  = ISComplement(ilink->is_col,rstart,rend,&ccis);CHKERRQ(ierr);
5554aa3045dSJed Brown       ierr  = MatGetSubMatrix(pc->mat,ilink->is,ccis,MAT_REUSE_MATRIX,&jac->B);CHKERRQ(ierr);
556fcfd50ebSBarry Smith       ierr  = ISDestroy(&ccis);CHKERRQ(ierr);
5573b224e63SBarry Smith       ilink = ilink->next;
55849bb4cd7SJungho Lee       ierr  = ISComplement(ilink->is_col,rstart,rend,&ccis);CHKERRQ(ierr);
5594aa3045dSJed Brown       ierr  = MatGetSubMatrix(pc->mat,ilink->is,ccis,MAT_REUSE_MATRIX,&jac->C);CHKERRQ(ierr);
560fcfd50ebSBarry Smith       ierr  = ISDestroy(&ccis);CHKERRQ(ierr);
561a3df900dSMatthew G Knepley       ierr  = MatSchurComplementUpdate(jac->schur,jac->mat[0],jac->pmat[0],jac->B,jac->C,jac->mat[1],pc->flag);CHKERRQ(ierr);
562*443836d0SMatthew G Knepley       if (kspA != kspInner) {
563*443836d0SMatthew G Knepley         ierr = KSPSetOperators(kspA,jac->mat[0],jac->pmat[0],pc->flag);CHKERRQ(ierr);
564*443836d0SMatthew G Knepley       }
565*443836d0SMatthew G Knepley       if (kspUpper != kspA) {
566*443836d0SMatthew G Knepley         ierr = KSPSetOperators(kspUpper,jac->mat[0],jac->pmat[0],pc->flag);CHKERRQ(ierr);
567*443836d0SMatthew G Knepley       }
568084e4875SJed Brown       ierr  = KSPSetOperators(jac->kspschur,jac->schur,FieldSplitSchurPre(jac),pc->flag);CHKERRQ(ierr);
5693b224e63SBarry Smith      } else {
5701cee3971SBarry Smith       KSP ksp;
571bafc1b83SMatthew G Knepley       const char  *Dprefix;
572bafc1b83SMatthew G Knepley       char schurprefix[256];
573514bf10dSMatthew G Knepley       char schurtestoption[256];
574bdddcaaaSMatthew G Knepley       MatNullSpace sp;
575514bf10dSMatthew G Knepley       PetscBool    flg;
5763b224e63SBarry Smith 
577a04f6461SBarry Smith       /* extract the A01 and A10 matrices */
5783b224e63SBarry Smith       ilink = jac->head;
57949bb4cd7SJungho Lee       ierr  = ISComplement(ilink->is_col,rstart,rend,&ccis);CHKERRQ(ierr);
5804aa3045dSJed Brown       ierr  = MatGetSubMatrix(pc->mat,ilink->is,ccis,MAT_INITIAL_MATRIX,&jac->B);CHKERRQ(ierr);
581fcfd50ebSBarry Smith       ierr  = ISDestroy(&ccis);CHKERRQ(ierr);
5823b224e63SBarry Smith       ilink = ilink->next;
58349bb4cd7SJungho Lee       ierr = ISComplement(ilink->is_col,rstart,rend,&ccis);CHKERRQ(ierr);
5844aa3045dSJed Brown       ierr = MatGetSubMatrix(pc->mat,ilink->is,ccis,MAT_INITIAL_MATRIX,&jac->C);CHKERRQ(ierr);
585fcfd50ebSBarry Smith       ierr = ISDestroy(&ccis);CHKERRQ(ierr);
58620252d06SBarry Smith 
58720252d06SBarry Smith       /* Use mat[0] (diagonal block of the real matrix) preconditioned by pmat[0] to define Schur complement */
58820252d06SBarry Smith       ierr = MatCreate(((PetscObject)jac->mat[0])->comm,&jac->schur);CHKERRQ(ierr);
58920252d06SBarry Smith       ierr = MatSetType(jac->schur,MATSCHURCOMPLEMENT);CHKERRQ(ierr);
59020252d06SBarry Smith       ierr = MatSchurComplementGetKSP(jac->schur, &ksp);CHKERRQ(ierr);
59120252d06SBarry Smith       ierr = PetscSNPrintf(schurprefix, sizeof(schurprefix), "%sfieldsplit_%s_inner_", ((PetscObject)pc)->prefix ? ((PetscObject)pc)->prefix : "", ilink->splitname);CHKERRQ(ierr);
59220252d06SBarry Smith       /* Indent this deeper to emphasize the "inner" nature of this solver. */
59320252d06SBarry Smith       ierr = PetscObjectIncrementTabLevel((PetscObject)ksp, (PetscObject) pc, 2);CHKERRQ(ierr);
59420252d06SBarry Smith       ierr = KSPSetOptionsPrefix(ksp, schurprefix);CHKERRQ(ierr);
59520252d06SBarry Smith       ierr = MatSchurComplementSet(jac->schur,jac->mat[0],jac->pmat[0],jac->B,jac->C,jac->mat[1]);CHKERRQ(ierr);
59620252d06SBarry Smith 
597bdddcaaaSMatthew G Knepley       ierr = MatGetNullSpace(jac->pmat[1], &sp);CHKERRQ(ierr);
59820252d06SBarry Smith       if (sp) {
59920252d06SBarry Smith         ierr  = MatSetNullSpace(jac->schur, sp);CHKERRQ(ierr);
60020252d06SBarry Smith       }
60120252d06SBarry Smith 
60220252d06SBarry Smith       ierr = PetscSNPrintf(schurtestoption, sizeof(schurtestoption), "-fieldsplit_%s_inner_", ilink->splitname);CHKERRQ(ierr);
603514bf10dSMatthew G Knepley       ierr = PetscOptionsFindPairPrefix_Private(((PetscObject)pc)->prefix, schurtestoption, PETSC_NULL, &flg);CHKERRQ(ierr);
604514bf10dSMatthew G Knepley       if (flg) {
605514bf10dSMatthew G Knepley         DM dmInner;
606514bf10dSMatthew G Knepley 
607514bf10dSMatthew G Knepley         /* Set DM for new solver */
608bafc1b83SMatthew G Knepley         ierr = KSPGetDM(jac->head->ksp, &dmInner);CHKERRQ(ierr);
609bafc1b83SMatthew G Knepley         ierr = KSPSetDM(ksp, dmInner);CHKERRQ(ierr);
6107287d2a3SDmitry Karpeev         ierr = KSPSetDMActive(ksp, PETSC_FALSE);CHKERRQ(ierr);
611*443836d0SMatthew G Knepley         ierr = KSPSetOperators(jac->head->ksp,jac->mat[0],jac->pmat[0],flag);CHKERRQ(ierr);
612*443836d0SMatthew G Knepley         ierr = KSPSetFromOptions(jac->head->ksp);CHKERRQ(ierr);
613514bf10dSMatthew G Knepley       } else {
614514bf10dSMatthew G Knepley         ierr = MatSchurComplementSetKSP(jac->schur, jac->head->ksp);CHKERRQ(ierr);
615514bf10dSMatthew G Knepley         ierr = PetscObjectReference((PetscObject) jac->head->ksp);CHKERRQ(ierr);
616bafc1b83SMatthew G Knepley       }
61720b26d62SBarry Smith       ierr  = MatSetFromOptions(jac->schur);CHKERRQ(ierr);
6183b224e63SBarry Smith 
619*443836d0SMatthew G Knepley       ierr = PetscSNPrintf(schurtestoption, sizeof(schurtestoption), "-fieldsplit_%s_upper_", ilink->splitname);CHKERRQ(ierr);
620*443836d0SMatthew G Knepley       ierr = PetscOptionsFindPairPrefix_Private(((PetscObject)pc)->prefix, schurtestoption, PETSC_NULL, &flg);CHKERRQ(ierr);
621*443836d0SMatthew G Knepley       if (flg) {
622*443836d0SMatthew G Knepley         DM dmInner;
623*443836d0SMatthew G Knepley 
624*443836d0SMatthew G Knepley         ierr = PetscSNPrintf(schurprefix, sizeof(schurprefix), "%sfieldsplit_%s_upper_", ((PetscObject)pc)->prefix ? ((PetscObject)pc)->prefix : "", ilink->splitname);CHKERRQ(ierr);
625*443836d0SMatthew G Knepley         ierr = KSPCreate(((PetscObject) pc)->comm, &jac->kspupper);CHKERRQ(ierr);
626*443836d0SMatthew G Knepley         ierr = KSPSetOptionsPrefix(jac->kspupper, schurprefix);CHKERRQ(ierr);
627*443836d0SMatthew G Knepley         ierr = KSPGetDM(jac->head->ksp, &dmInner);CHKERRQ(ierr);
628*443836d0SMatthew G Knepley         ierr = KSPSetDM(jac->kspupper, dmInner);CHKERRQ(ierr);
629*443836d0SMatthew G Knepley         ierr = KSPSetDMActive(jac->kspupper, PETSC_FALSE);CHKERRQ(ierr);
630*443836d0SMatthew G Knepley         ierr = KSPSetFromOptions(jac->kspupper);CHKERRQ(ierr);
631*443836d0SMatthew G Knepley         ierr = KSPSetOperators(jac->kspupper,jac->mat[0],jac->pmat[0],flag);CHKERRQ(ierr);
632*443836d0SMatthew G Knepley         ierr = VecDuplicate(jac->head->x, &jac->head->z);CHKERRQ(ierr);
633*443836d0SMatthew G Knepley       } else {
634*443836d0SMatthew G Knepley         jac->kspupper = jac->head->ksp;
635*443836d0SMatthew G Knepley         ierr = PetscObjectReference((PetscObject) jac->head->ksp);CHKERRQ(ierr);
636*443836d0SMatthew G Knepley       }
637*443836d0SMatthew G Knepley 
6383b224e63SBarry Smith       ierr  = KSPCreate(((PetscObject)pc)->comm,&jac->kspschur);               CHKERRQ(ierr);
6399005cf84SBarry Smith       ierr  = PetscLogObjectParent((PetscObject)pc,(PetscObject)jac->kspschur);CHKERRQ(ierr);
64020252d06SBarry Smith       ierr  = PetscObjectIncrementTabLevel((PetscObject)jac->kspschur,(PetscObject)pc,1);           CHKERRQ(ierr);
641084e4875SJed Brown       ierr  = KSPSetOperators(jac->kspschur,jac->schur,FieldSplitSchurPre(jac),DIFFERENT_NONZERO_PATTERN);CHKERRQ(ierr);
642084e4875SJed Brown       if (jac->schurpre == PC_FIELDSPLIT_SCHUR_PRE_SELF) {
6437233a360SDmitry Karpeev         PC pcschur;
6447233a360SDmitry Karpeev         ierr = KSPGetPC(jac->kspschur,&pcschur);CHKERRQ(ierr);
6457233a360SDmitry Karpeev         ierr = PCSetType(pcschur,PCNONE);CHKERRQ(ierr);
646084e4875SJed Brown         /* Note: This is bad if there exist preconditioners for MATSCHURCOMPLEMENT */
647e69d4d44SBarry Smith       }
6487287d2a3SDmitry Karpeev       ierr  = KSPGetOptionsPrefix(jac->head->next->ksp, &Dprefix); CHKERRQ(ierr);
6497287d2a3SDmitry Karpeev       ierr  = KSPSetOptionsPrefix(jac->kspschur,         Dprefix); CHKERRQ(ierr);
6503b224e63SBarry Smith       /* really want setfromoptions called in PCSetFromOptions_FieldSplit(), but it is not ready yet */
65120b26d62SBarry Smith       /* need to call this every time, since the jac->kspschur is freshly created, otherwise its options never get set */
65220b26d62SBarry Smith       ierr = KSPSetFromOptions(jac->kspschur);CHKERRQ(ierr);
6533b224e63SBarry Smith     }
654093c86ffSJed Brown 
655093c86ffSJed Brown     /* HACK: special support to forward L and Lp matrices that might be used by PCLSC */
6568caf3d72SBarry Smith     ierr = PetscSNPrintf(lscname,sizeof(lscname),"%s_LSC_L",ilink->splitname);CHKERRQ(ierr);
657093c86ffSJed Brown     ierr = PetscObjectQuery((PetscObject)pc->mat,lscname,(PetscObject*)&LSC_L);CHKERRQ(ierr);
658093c86ffSJed Brown     if (!LSC_L) {ierr = PetscObjectQuery((PetscObject)pc->pmat,lscname,(PetscObject*)&LSC_L);CHKERRQ(ierr);}
659093c86ffSJed Brown     if (LSC_L) {ierr = PetscObjectCompose((PetscObject)jac->schur,"LSC_L",(PetscObject)LSC_L);CHKERRQ(ierr);}
6608caf3d72SBarry Smith     ierr = PetscSNPrintf(lscname,sizeof(lscname),"%s_LSC_Lp",ilink->splitname);CHKERRQ(ierr);
661093c86ffSJed Brown     ierr = PetscObjectQuery((PetscObject)pc->pmat,lscname,(PetscObject*)&LSC_L);CHKERRQ(ierr);
662093c86ffSJed Brown     if (!LSC_L) {ierr = PetscObjectQuery((PetscObject)pc->mat,lscname,(PetscObject*)&LSC_L);CHKERRQ(ierr);}
663093c86ffSJed Brown     if (LSC_L) {ierr = PetscObjectCompose((PetscObject)jac->schur,"LSC_Lp",(PetscObject)LSC_L);CHKERRQ(ierr);}
6643b224e63SBarry Smith   } else {
66568bd789dSDmitry Karpeev     /* set up the individual splits' PCs */
66697bbdb24SBarry Smith     i    = 0;
6675a9f2f41SSatish Balay     ilink = jac->head;
6685a9f2f41SSatish Balay     while (ilink) {
669519d70e2SJed Brown       ierr = KSPSetOperators(ilink->ksp,jac->mat[i],jac->pmat[i],flag);CHKERRQ(ierr);
6703b224e63SBarry Smith       /* really want setfromoptions called in PCSetFromOptions_FieldSplit(), but it is not ready yet */
671c1570756SJed Brown       if (!jac->suboptionsset) {ierr = KSPSetFromOptions(ilink->ksp);CHKERRQ(ierr);}
67297bbdb24SBarry Smith       i++;
6735a9f2f41SSatish Balay       ilink = ilink->next;
6740971522cSBarry Smith     }
6753b224e63SBarry Smith   }
6763b224e63SBarry Smith 
677c1570756SJed Brown   jac->suboptionsset = PETSC_TRUE;
6780971522cSBarry Smith   PetscFunctionReturn(0);
6790971522cSBarry Smith }
6800971522cSBarry Smith 
6815a9f2f41SSatish Balay #define FieldSplitSplitSolveAdd(ilink,xx,yy) \
682ca9f406cSSatish Balay     (VecScatterBegin(ilink->sctx,xx,ilink->x,INSERT_VALUES,SCATTER_FORWARD) || \
683ca9f406cSSatish Balay      VecScatterEnd(ilink->sctx,xx,ilink->x,INSERT_VALUES,SCATTER_FORWARD) || \
6845a9f2f41SSatish Balay      KSPSolve(ilink->ksp,ilink->x,ilink->y) || \
685ca9f406cSSatish Balay      VecScatterBegin(ilink->sctx,ilink->y,yy,ADD_VALUES,SCATTER_REVERSE) || \
686ca9f406cSSatish Balay      VecScatterEnd(ilink->sctx,ilink->y,yy,ADD_VALUES,SCATTER_REVERSE))
68779416396SBarry Smith 
6880971522cSBarry Smith #undef __FUNCT__
6893b224e63SBarry Smith #define __FUNCT__ "PCApply_FieldSplit_Schur"
6903b224e63SBarry Smith static PetscErrorCode PCApply_FieldSplit_Schur(PC pc,Vec x,Vec y)
6913b224e63SBarry Smith {
6923b224e63SBarry Smith   PC_FieldSplit     *jac = (PC_FieldSplit*)pc->data;
6933b224e63SBarry Smith   PetscErrorCode    ierr;
6943b224e63SBarry Smith   PC_FieldSplitLink ilinkA = jac->head, ilinkD = ilinkA->next;
695*443836d0SMatthew G Knepley   KSP               kspA = ilinkA->ksp, kspLower = kspA, kspUpper = jac->kspupper;
6963b224e63SBarry Smith 
6973b224e63SBarry Smith   PetscFunctionBegin;
698c5d2311dSJed Brown   switch (jac->schurfactorization) {
699c9c6ffaaSJed Brown     case PC_FIELDSPLIT_SCHUR_FACT_DIAG:
700a04f6461SBarry Smith       /* [A00 0; 0 -S], positive definite, suitable for MINRES */
701c5d2311dSJed Brown       ierr = VecScatterBegin(ilinkA->sctx,x,ilinkA->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
702c5d2311dSJed Brown       ierr = VecScatterBegin(ilinkD->sctx,x,ilinkD->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
703c5d2311dSJed Brown       ierr = VecScatterEnd(ilinkA->sctx,x,ilinkA->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
704*443836d0SMatthew G Knepley       ierr = KSPSolve(kspA,ilinkA->x,ilinkA->y);CHKERRQ(ierr);
705c5d2311dSJed Brown       ierr = VecScatterBegin(ilinkA->sctx,ilinkA->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
706c5d2311dSJed Brown       ierr = VecScatterEnd(ilinkD->sctx,x,ilinkD->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
707c5d2311dSJed Brown       ierr = KSPSolve(jac->kspschur,ilinkD->x,ilinkD->y);CHKERRQ(ierr);
708c5d2311dSJed Brown       ierr = VecScale(ilinkD->y,-1.);CHKERRQ(ierr);
709c5d2311dSJed Brown       ierr = VecScatterBegin(ilinkD->sctx,ilinkD->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
710c5d2311dSJed Brown       ierr = VecScatterEnd(ilinkA->sctx,ilinkA->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
711c5d2311dSJed Brown       ierr = VecScatterEnd(ilinkD->sctx,ilinkD->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
712c5d2311dSJed Brown       break;
713c9c6ffaaSJed Brown     case PC_FIELDSPLIT_SCHUR_FACT_LOWER:
714a04f6461SBarry Smith       /* [A00 0; A10 S], suitable for left preconditioning */
715c5d2311dSJed Brown       ierr = VecScatterBegin(ilinkA->sctx,x,ilinkA->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
716c5d2311dSJed Brown       ierr = VecScatterEnd(ilinkA->sctx,x,ilinkA->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
717*443836d0SMatthew G Knepley       ierr = KSPSolve(kspA,ilinkA->x,ilinkA->y);CHKERRQ(ierr);
718c5d2311dSJed Brown       ierr = MatMult(jac->C,ilinkA->y,ilinkD->x);CHKERRQ(ierr);
719c5d2311dSJed Brown       ierr = VecScale(ilinkD->x,-1.);CHKERRQ(ierr);
720c5d2311dSJed Brown       ierr = VecScatterBegin(ilinkD->sctx,x,ilinkD->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
721c5d2311dSJed Brown       ierr = VecScatterBegin(ilinkA->sctx,ilinkA->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
722c5d2311dSJed Brown       ierr = VecScatterEnd(ilinkD->sctx,x,ilinkD->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
723c5d2311dSJed Brown       ierr = KSPSolve(jac->kspschur,ilinkD->x,ilinkD->y);CHKERRQ(ierr);
724c5d2311dSJed Brown       ierr = VecScatterBegin(ilinkD->sctx,ilinkD->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
725c5d2311dSJed Brown       ierr = VecScatterEnd(ilinkA->sctx,ilinkA->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
726c5d2311dSJed Brown       ierr = VecScatterEnd(ilinkD->sctx,ilinkD->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
727c5d2311dSJed Brown       break;
728c9c6ffaaSJed Brown     case PC_FIELDSPLIT_SCHUR_FACT_UPPER:
729a04f6461SBarry Smith       /* [A00 A01; 0 S], suitable for right preconditioning */
730c5d2311dSJed Brown       ierr = VecScatterBegin(ilinkD->sctx,x,ilinkD->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
731c5d2311dSJed Brown       ierr = VecScatterEnd(ilinkD->sctx,x,ilinkD->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
732c5d2311dSJed Brown       ierr = KSPSolve(jac->kspschur,ilinkD->x,ilinkD->y);CHKERRQ(ierr);
733c5d2311dSJed Brown       ierr = MatMult(jac->B,ilinkD->y,ilinkA->x);CHKERRQ(ierr);
734c5d2311dSJed Brown       ierr = VecScale(ilinkA->x,-1.);CHKERRQ(ierr);
735c5d2311dSJed Brown       ierr = VecScatterBegin(ilinkA->sctx,x,ilinkA->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
736c5d2311dSJed Brown       ierr = VecScatterBegin(ilinkD->sctx,ilinkD->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
737c5d2311dSJed Brown       ierr = VecScatterEnd(ilinkA->sctx,x,ilinkA->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
738*443836d0SMatthew G Knepley       ierr = KSPSolve(kspA,ilinkA->x,ilinkA->y);CHKERRQ(ierr);
739c5d2311dSJed Brown       ierr = VecScatterBegin(ilinkA->sctx,ilinkA->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
740c5d2311dSJed Brown       ierr = VecScatterEnd(ilinkD->sctx,ilinkD->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
741c5d2311dSJed Brown       ierr = VecScatterEnd(ilinkA->sctx,ilinkA->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
742c5d2311dSJed Brown       break;
743c9c6ffaaSJed Brown     case PC_FIELDSPLIT_SCHUR_FACT_FULL:
744a04f6461SBarry Smith       /* [1 0; A10 A00^{-1} 1] [A00 0; 0 S] [1 A00^{-1}A01; 0 1], an exact solve if applied exactly, needs one extra solve with A */
7453b224e63SBarry Smith       ierr = VecScatterBegin(ilinkA->sctx,x,ilinkA->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
7463b224e63SBarry Smith       ierr = VecScatterEnd(ilinkA->sctx,x,ilinkA->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
747*443836d0SMatthew G Knepley       ierr = KSPSolve(kspLower,ilinkA->x,ilinkA->y);CHKERRQ(ierr);
7483b224e63SBarry Smith       ierr = MatMult(jac->C,ilinkA->y,ilinkD->x);CHKERRQ(ierr);
7493b224e63SBarry Smith       ierr = VecScale(ilinkD->x,-1.0);CHKERRQ(ierr);
7503b224e63SBarry Smith       ierr = VecScatterBegin(ilinkD->sctx,x,ilinkD->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
7513b224e63SBarry Smith       ierr = VecScatterEnd(ilinkD->sctx,x,ilinkD->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
7523b224e63SBarry Smith 
7533b224e63SBarry Smith       ierr = KSPSolve(jac->kspschur,ilinkD->x,ilinkD->y);CHKERRQ(ierr);
7543b224e63SBarry Smith       ierr = VecScatterBegin(ilinkD->sctx,ilinkD->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
7553b224e63SBarry Smith       ierr = VecScatterEnd(ilinkD->sctx,ilinkD->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
7563b224e63SBarry Smith 
757*443836d0SMatthew G Knepley       if (kspUpper == kspA) {
7583b224e63SBarry Smith         ierr = MatMult(jac->B,ilinkD->y,ilinkA->y);CHKERRQ(ierr);
7593b224e63SBarry Smith         ierr = VecAXPY(ilinkA->x,-1.0,ilinkA->y);CHKERRQ(ierr);
760*443836d0SMatthew G Knepley         ierr = KSPSolve(kspA,ilinkA->x,ilinkA->y);CHKERRQ(ierr);
761*443836d0SMatthew G Knepley       } else {
762*443836d0SMatthew G Knepley         ierr = KSPSolve(kspA,ilinkA->x,ilinkA->y);CHKERRQ(ierr);
763*443836d0SMatthew G Knepley         ierr = MatMult(jac->B,ilinkD->y,ilinkA->x);CHKERRQ(ierr);
764*443836d0SMatthew G Knepley         ierr = KSPSolve(kspUpper,ilinkA->x,ilinkA->z);CHKERRQ(ierr);
765*443836d0SMatthew G Knepley         ierr = VecAXPY(ilinkA->y,-1.0,ilinkA->z);CHKERRQ(ierr);
766*443836d0SMatthew G Knepley       }
7673b224e63SBarry Smith       ierr = VecScatterBegin(ilinkA->sctx,ilinkA->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
7683b224e63SBarry Smith       ierr = VecScatterEnd(ilinkA->sctx,ilinkA->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
769c5d2311dSJed Brown   }
7703b224e63SBarry Smith   PetscFunctionReturn(0);
7713b224e63SBarry Smith }
7723b224e63SBarry Smith 
7733b224e63SBarry Smith #undef __FUNCT__
7740971522cSBarry Smith #define __FUNCT__ "PCApply_FieldSplit"
7750971522cSBarry Smith static PetscErrorCode PCApply_FieldSplit(PC pc,Vec x,Vec y)
7760971522cSBarry Smith {
7770971522cSBarry Smith   PC_FieldSplit     *jac = (PC_FieldSplit*)pc->data;
7780971522cSBarry Smith   PetscErrorCode    ierr;
7795a9f2f41SSatish Balay   PC_FieldSplitLink ilink = jac->head;
780939b8a20SBarry Smith   PetscInt          cnt,bs;
7810971522cSBarry Smith 
7820971522cSBarry Smith   PetscFunctionBegin;
7834442daceSBarry Smith   x->map->bs = jac->bs;
7844442daceSBarry Smith   y->map->bs = jac->bs;
78551f519a2SBarry Smith   CHKMEMQ;
78679416396SBarry Smith   if (jac->type == PC_COMPOSITE_ADDITIVE) {
7871b9fc7fcSBarry Smith     if (jac->defaultsplit) {
788939b8a20SBarry Smith       ierr = VecGetBlockSize(x,&bs);CHKERRQ(ierr);
789939b8a20SBarry Smith       if (jac->bs > 0 && bs != jac->bs) SETERRQ2(((PetscObject)pc)->comm,PETSC_ERR_ARG_WRONGSTATE,"Blocksize of x vector %D does not match fieldsplit blocksize %D",bs,jac->bs);
790939b8a20SBarry Smith       ierr = VecGetBlockSize(y,&bs);CHKERRQ(ierr);
791939b8a20SBarry Smith       if (jac->bs > 0 && bs != jac->bs) SETERRQ2(((PetscObject)pc)->comm,PETSC_ERR_ARG_WRONGSTATE,"Blocksize of y vector %D does not match fieldsplit blocksize %D",bs,jac->bs);
7920971522cSBarry Smith       ierr = VecStrideGatherAll(x,jac->x,INSERT_VALUES);CHKERRQ(ierr);
7935a9f2f41SSatish Balay       while (ilink) {
7945a9f2f41SSatish Balay         ierr = KSPSolve(ilink->ksp,ilink->x,ilink->y);CHKERRQ(ierr);
7955a9f2f41SSatish Balay         ilink = ilink->next;
7960971522cSBarry Smith       }
7970971522cSBarry Smith       ierr = VecStrideScatterAll(jac->y,y,INSERT_VALUES);CHKERRQ(ierr);
7981b9fc7fcSBarry Smith     } else {
799efb30889SBarry Smith       ierr = VecSet(y,0.0);CHKERRQ(ierr);
8005a9f2f41SSatish Balay       while (ilink) {
8015a9f2f41SSatish Balay         ierr = FieldSplitSplitSolveAdd(ilink,x,y);CHKERRQ(ierr);
8025a9f2f41SSatish Balay         ilink = ilink->next;
8031b9fc7fcSBarry Smith       }
8041b9fc7fcSBarry Smith     }
80516913363SBarry Smith   } else if (jac->type == PC_COMPOSITE_MULTIPLICATIVE || jac->type == PC_COMPOSITE_SYMMETRIC_MULTIPLICATIVE) {
80679416396SBarry Smith     if (!jac->w1) {
80779416396SBarry Smith       ierr = VecDuplicate(x,&jac->w1);CHKERRQ(ierr);
80879416396SBarry Smith       ierr = VecDuplicate(x,&jac->w2);CHKERRQ(ierr);
80979416396SBarry Smith     }
810efb30889SBarry Smith     ierr = VecSet(y,0.0);CHKERRQ(ierr);
8115a9f2f41SSatish Balay     ierr = FieldSplitSplitSolveAdd(ilink,x,y);CHKERRQ(ierr);
8123e197d65SBarry Smith     cnt = 1;
8135a9f2f41SSatish Balay     while (ilink->next) {
8145a9f2f41SSatish Balay       ilink = ilink->next;
8153e197d65SBarry Smith       /* compute the residual only over the part of the vector needed */
8163e197d65SBarry Smith       ierr = MatMult(jac->Afield[cnt++],y,ilink->x);CHKERRQ(ierr);
8173e197d65SBarry Smith       ierr = VecScale(ilink->x,-1.0);CHKERRQ(ierr);
8183e197d65SBarry Smith       ierr = VecScatterBegin(ilink->sctx,x,ilink->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
8193e197d65SBarry Smith       ierr = VecScatterEnd(ilink->sctx,x,ilink->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
8203e197d65SBarry Smith       ierr = KSPSolve(ilink->ksp,ilink->x,ilink->y);CHKERRQ(ierr);
8213e197d65SBarry Smith       ierr = VecScatterBegin(ilink->sctx,ilink->y,y,ADD_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
8223e197d65SBarry Smith       ierr = VecScatterEnd(ilink->sctx,ilink->y,y,ADD_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
8233e197d65SBarry Smith     }
82451f519a2SBarry Smith     if (jac->type == PC_COMPOSITE_SYMMETRIC_MULTIPLICATIVE) {
82511755939SBarry Smith       cnt -= 2;
82651f519a2SBarry Smith       while (ilink->previous) {
82751f519a2SBarry Smith         ilink = ilink->previous;
82811755939SBarry Smith         /* compute the residual only over the part of the vector needed */
82911755939SBarry Smith         ierr = MatMult(jac->Afield[cnt--],y,ilink->x);CHKERRQ(ierr);
83011755939SBarry Smith         ierr = VecScale(ilink->x,-1.0);CHKERRQ(ierr);
83111755939SBarry Smith         ierr = VecScatterBegin(ilink->sctx,x,ilink->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
83211755939SBarry Smith         ierr = VecScatterEnd(ilink->sctx,x,ilink->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
83311755939SBarry Smith         ierr = KSPSolve(ilink->ksp,ilink->x,ilink->y);CHKERRQ(ierr);
83411755939SBarry Smith         ierr = VecScatterBegin(ilink->sctx,ilink->y,y,ADD_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
83511755939SBarry Smith         ierr = VecScatterEnd(ilink->sctx,ilink->y,y,ADD_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
83651f519a2SBarry Smith       }
83711755939SBarry Smith     }
83865e19b50SBarry Smith   } else SETERRQ1(((PetscObject)pc)->comm,PETSC_ERR_SUP,"Unsupported or unknown composition",(int) jac->type);
83951f519a2SBarry Smith   CHKMEMQ;
8400971522cSBarry Smith   PetscFunctionReturn(0);
8410971522cSBarry Smith }
8420971522cSBarry Smith 
843421e10b8SBarry Smith #define FieldSplitSplitSolveAddTranspose(ilink,xx,yy) \
844ca9f406cSSatish Balay     (VecScatterBegin(ilink->sctx,xx,ilink->y,INSERT_VALUES,SCATTER_FORWARD) || \
845ca9f406cSSatish Balay      VecScatterEnd(ilink->sctx,xx,ilink->y,INSERT_VALUES,SCATTER_FORWARD) || \
846421e10b8SBarry Smith      KSPSolveTranspose(ilink->ksp,ilink->y,ilink->x) || \
847ca9f406cSSatish Balay      VecScatterBegin(ilink->sctx,ilink->x,yy,ADD_VALUES,SCATTER_REVERSE) || \
848ca9f406cSSatish Balay      VecScatterEnd(ilink->sctx,ilink->x,yy,ADD_VALUES,SCATTER_REVERSE))
849421e10b8SBarry Smith 
850421e10b8SBarry Smith #undef __FUNCT__
8518c03b21aSDmitry Karpeev #define __FUNCT__ "PCApplyTranspose_FieldSplit"
852421e10b8SBarry Smith static PetscErrorCode PCApplyTranspose_FieldSplit(PC pc,Vec x,Vec y)
853421e10b8SBarry Smith {
854421e10b8SBarry Smith   PC_FieldSplit     *jac = (PC_FieldSplit*)pc->data;
855421e10b8SBarry Smith   PetscErrorCode    ierr;
856421e10b8SBarry Smith   PC_FieldSplitLink ilink = jac->head;
857939b8a20SBarry Smith   PetscInt          bs;
858421e10b8SBarry Smith 
859421e10b8SBarry Smith   PetscFunctionBegin;
860421e10b8SBarry Smith   CHKMEMQ;
861421e10b8SBarry Smith   if (jac->type == PC_COMPOSITE_ADDITIVE) {
862421e10b8SBarry Smith     if (jac->defaultsplit) {
863939b8a20SBarry Smith       ierr = VecGetBlockSize(x,&bs);CHKERRQ(ierr);
864939b8a20SBarry Smith       if (jac->bs > 0 && bs != jac->bs) SETERRQ2(((PetscObject)pc)->comm,PETSC_ERR_ARG_WRONGSTATE,"Blocksize of x vector %D does not match fieldsplit blocksize %D",bs,jac->bs);
865939b8a20SBarry Smith       ierr = VecGetBlockSize(y,&bs);CHKERRQ(ierr);
866939b8a20SBarry Smith       if (jac->bs > 0 && bs != jac->bs) SETERRQ2(((PetscObject)pc)->comm,PETSC_ERR_ARG_WRONGSTATE,"Blocksize of y vector %D does not match fieldsplit blocksize %D",bs,jac->bs);
867421e10b8SBarry Smith       ierr = VecStrideGatherAll(x,jac->x,INSERT_VALUES);CHKERRQ(ierr);
868421e10b8SBarry Smith       while (ilink) {
869421e10b8SBarry Smith 	ierr = KSPSolveTranspose(ilink->ksp,ilink->x,ilink->y);CHKERRQ(ierr);
870421e10b8SBarry Smith 	ilink = ilink->next;
871421e10b8SBarry Smith       }
872421e10b8SBarry Smith       ierr = VecStrideScatterAll(jac->y,y,INSERT_VALUES);CHKERRQ(ierr);
873421e10b8SBarry Smith     } else {
874421e10b8SBarry Smith       ierr = VecSet(y,0.0);CHKERRQ(ierr);
875421e10b8SBarry Smith       while (ilink) {
876421e10b8SBarry Smith         ierr = FieldSplitSplitSolveAddTranspose(ilink,x,y);CHKERRQ(ierr);
877421e10b8SBarry Smith 	ilink = ilink->next;
878421e10b8SBarry Smith       }
879421e10b8SBarry Smith     }
880421e10b8SBarry Smith   } else {
881421e10b8SBarry Smith     if (!jac->w1) {
882421e10b8SBarry Smith       ierr = VecDuplicate(x,&jac->w1);CHKERRQ(ierr);
883421e10b8SBarry Smith       ierr = VecDuplicate(x,&jac->w2);CHKERRQ(ierr);
884421e10b8SBarry Smith     }
885421e10b8SBarry Smith     ierr = VecSet(y,0.0);CHKERRQ(ierr);
886421e10b8SBarry Smith     if (jac->type == PC_COMPOSITE_SYMMETRIC_MULTIPLICATIVE) {
887421e10b8SBarry Smith       ierr = FieldSplitSplitSolveAddTranspose(ilink,x,y);CHKERRQ(ierr);
888421e10b8SBarry Smith       while (ilink->next) {
889421e10b8SBarry Smith         ilink = ilink->next;
8909989ab13SBarry Smith         ierr  = MatMultTranspose(pc->mat,y,jac->w1);CHKERRQ(ierr);
891421e10b8SBarry Smith         ierr  = VecWAXPY(jac->w2,-1.0,jac->w1,x);CHKERRQ(ierr);
892421e10b8SBarry Smith         ierr  = FieldSplitSplitSolveAddTranspose(ilink,jac->w2,y);CHKERRQ(ierr);
893421e10b8SBarry Smith       }
894421e10b8SBarry Smith       while (ilink->previous) {
895421e10b8SBarry Smith         ilink = ilink->previous;
8969989ab13SBarry Smith         ierr  = MatMultTranspose(pc->mat,y,jac->w1);CHKERRQ(ierr);
897421e10b8SBarry Smith         ierr  = VecWAXPY(jac->w2,-1.0,jac->w1,x);CHKERRQ(ierr);
898421e10b8SBarry Smith         ierr  = FieldSplitSplitSolveAddTranspose(ilink,jac->w2,y);CHKERRQ(ierr);
899421e10b8SBarry Smith       }
900421e10b8SBarry Smith     } else {
901421e10b8SBarry Smith       while (ilink->next) {   /* get to last entry in linked list */
902421e10b8SBarry Smith 	ilink = ilink->next;
903421e10b8SBarry Smith       }
904421e10b8SBarry Smith       ierr = FieldSplitSplitSolveAddTranspose(ilink,x,y);CHKERRQ(ierr);
905421e10b8SBarry Smith       while (ilink->previous) {
906421e10b8SBarry Smith 	ilink = ilink->previous;
9079989ab13SBarry Smith 	ierr  = MatMultTranspose(pc->mat,y,jac->w1);CHKERRQ(ierr);
908421e10b8SBarry Smith 	ierr  = VecWAXPY(jac->w2,-1.0,jac->w1,x);CHKERRQ(ierr);
909421e10b8SBarry Smith 	ierr  = FieldSplitSplitSolveAddTranspose(ilink,jac->w2,y);CHKERRQ(ierr);
910421e10b8SBarry Smith       }
911421e10b8SBarry Smith     }
912421e10b8SBarry Smith   }
913421e10b8SBarry Smith   CHKMEMQ;
914421e10b8SBarry Smith   PetscFunctionReturn(0);
915421e10b8SBarry Smith }
916421e10b8SBarry Smith 
9170971522cSBarry Smith #undef __FUNCT__
918574deadeSBarry Smith #define __FUNCT__ "PCReset_FieldSplit"
919574deadeSBarry Smith static PetscErrorCode PCReset_FieldSplit(PC pc)
9200971522cSBarry Smith {
9210971522cSBarry Smith   PC_FieldSplit     *jac = (PC_FieldSplit*)pc->data;
9220971522cSBarry Smith   PetscErrorCode    ierr;
9235a9f2f41SSatish Balay   PC_FieldSplitLink ilink = jac->head,next;
9240971522cSBarry Smith 
9250971522cSBarry Smith   PetscFunctionBegin;
9265a9f2f41SSatish Balay   while (ilink) {
927574deadeSBarry Smith     ierr = KSPReset(ilink->ksp);CHKERRQ(ierr);
928fcfd50ebSBarry Smith     ierr = VecDestroy(&ilink->x);CHKERRQ(ierr);
929fcfd50ebSBarry Smith     ierr = VecDestroy(&ilink->y);CHKERRQ(ierr);
930*443836d0SMatthew G Knepley     ierr = VecDestroy(&ilink->z);CHKERRQ(ierr);
931fcfd50ebSBarry Smith     ierr = VecScatterDestroy(&ilink->sctx);CHKERRQ(ierr);
932fcfd50ebSBarry Smith     ierr = ISDestroy(&ilink->is);CHKERRQ(ierr);
933b5787286SJed Brown     ierr = ISDestroy(&ilink->is_col);CHKERRQ(ierr);
9345a9f2f41SSatish Balay     next = ilink->next;
9355a9f2f41SSatish Balay     ilink = next;
9360971522cSBarry Smith   }
93705b42c5fSBarry Smith   ierr = PetscFree2(jac->x,jac->y);CHKERRQ(ierr);
938574deadeSBarry Smith   if (jac->mat && jac->mat != jac->pmat) {
939574deadeSBarry Smith     ierr = MatDestroyMatrices(jac->nsplits,&jac->mat);CHKERRQ(ierr);
940574deadeSBarry Smith   } else if (jac->mat) {
941574deadeSBarry Smith     jac->mat = PETSC_NULL;
942574deadeSBarry Smith   }
94397bbdb24SBarry Smith   if (jac->pmat) {ierr = MatDestroyMatrices(jac->nsplits,&jac->pmat);CHKERRQ(ierr);}
94468dd23aaSBarry Smith   if (jac->Afield) {ierr = MatDestroyMatrices(jac->nsplits,&jac->Afield);CHKERRQ(ierr);}
9456bf464f9SBarry Smith   ierr = VecDestroy(&jac->w1);CHKERRQ(ierr);
9466bf464f9SBarry Smith   ierr = VecDestroy(&jac->w2);CHKERRQ(ierr);
9476bf464f9SBarry Smith   ierr = MatDestroy(&jac->schur);CHKERRQ(ierr);
9486bf464f9SBarry Smith   ierr = MatDestroy(&jac->schur_user);CHKERRQ(ierr);
9496bf464f9SBarry Smith   ierr = KSPDestroy(&jac->kspschur);CHKERRQ(ierr);
9506bf464f9SBarry Smith   ierr = MatDestroy(&jac->B);CHKERRQ(ierr);
9516bf464f9SBarry Smith   ierr = MatDestroy(&jac->C);CHKERRQ(ierr);
95263ec74ffSBarry Smith   jac->reset = PETSC_TRUE;
953574deadeSBarry Smith   PetscFunctionReturn(0);
954574deadeSBarry Smith }
955574deadeSBarry Smith 
956574deadeSBarry Smith #undef __FUNCT__
957574deadeSBarry Smith #define __FUNCT__ "PCDestroy_FieldSplit"
958574deadeSBarry Smith static PetscErrorCode PCDestroy_FieldSplit(PC pc)
959574deadeSBarry Smith {
960574deadeSBarry Smith   PC_FieldSplit     *jac = (PC_FieldSplit*)pc->data;
961574deadeSBarry Smith   PetscErrorCode    ierr;
962574deadeSBarry Smith   PC_FieldSplitLink ilink = jac->head,next;
963574deadeSBarry Smith 
964574deadeSBarry Smith   PetscFunctionBegin;
965574deadeSBarry Smith   ierr = PCReset_FieldSplit(pc);CHKERRQ(ierr);
966574deadeSBarry Smith   while (ilink) {
9676bf464f9SBarry Smith     ierr = KSPDestroy(&ilink->ksp);CHKERRQ(ierr);
968574deadeSBarry Smith     next = ilink->next;
969574deadeSBarry Smith     ierr = PetscFree(ilink->splitname);CHKERRQ(ierr);
970574deadeSBarry Smith     ierr = PetscFree(ilink->fields);CHKERRQ(ierr);
9715d4c12cdSJungho Lee     ierr = PetscFree(ilink->fields_col);CHKERRQ(ierr);
972574deadeSBarry Smith     ierr = PetscFree(ilink);CHKERRQ(ierr);
973574deadeSBarry Smith     ilink = next;
974574deadeSBarry Smith   }
975574deadeSBarry Smith   ierr = PetscFree2(jac->x,jac->y);CHKERRQ(ierr);
976c31cb41cSBarry Smith   ierr = PetscFree(pc->data);CHKERRQ(ierr);
9777b62db95SJungho Lee   ierr = PetscObjectComposeFunctionDynamic((PetscObject)pc,"PCFieldSplitGetSubKSP_C","",PETSC_NULL);CHKERRQ(ierr);
9787b62db95SJungho Lee   ierr = PetscObjectComposeFunctionDynamic((PetscObject)pc,"PCFieldSplitSetFields_C","",PETSC_NULL);CHKERRQ(ierr);
9797b62db95SJungho Lee   ierr = PetscObjectComposeFunctionDynamic((PetscObject)pc,"PCFieldSplitSetIS_C","",PETSC_NULL);CHKERRQ(ierr);
9807b62db95SJungho Lee   ierr = PetscObjectComposeFunctionDynamic((PetscObject)pc,"PCFieldSplitSetType_C","",PETSC_NULL);CHKERRQ(ierr);
9817b62db95SJungho Lee   ierr = PetscObjectComposeFunctionDynamic((PetscObject)pc,"PCFieldSplitSetBlockSize_C","",PETSC_NULL);CHKERRQ(ierr);
982ab1df9f5SJed Brown   ierr = PetscObjectComposeFunctionDynamic((PetscObject)pc,"PCFieldSplitSchurPrecondition_C","",PETSC_NULL);CHKERRQ(ierr);
983c9c6ffaaSJed Brown   ierr = PetscObjectComposeFunctionDynamic((PetscObject)pc,"PCFieldSplitSetSchurFactType_C","",PETSC_NULL);CHKERRQ(ierr);
9840971522cSBarry Smith   PetscFunctionReturn(0);
9850971522cSBarry Smith }
9860971522cSBarry Smith 
9870971522cSBarry Smith #undef __FUNCT__
9880971522cSBarry Smith #define __FUNCT__ "PCSetFromOptions_FieldSplit"
9890971522cSBarry Smith static PetscErrorCode PCSetFromOptions_FieldSplit(PC pc)
9900971522cSBarry Smith {
9911b9fc7fcSBarry Smith   PetscErrorCode  ierr;
9926c924f48SJed Brown   PetscInt        bs;
993bc59fbc5SBarry Smith   PetscBool       flg,stokes = PETSC_FALSE;
9949dcbbd2bSBarry Smith   PC_FieldSplit   *jac = (PC_FieldSplit*)pc->data;
9953b224e63SBarry Smith   PCCompositeType ctype;
996e7c4fc90SDmitry Karpeev   DM              ddm;
997e7c4fc90SDmitry Karpeev   char            ddm_name[1025];
9981b9fc7fcSBarry Smith 
9990971522cSBarry Smith   PetscFunctionBegin;
10001b9fc7fcSBarry Smith   ierr = PetscOptionsHead("FieldSplit options");CHKERRQ(ierr);
1001e7c4fc90SDmitry Karpeev   if (pc->dm) {
1002e7c4fc90SDmitry Karpeev     /* Allow the user to request a decomposition DM by name */
1003e7c4fc90SDmitry Karpeev     ierr = PetscStrncpy(ddm_name, "", 1024); CHKERRQ(ierr);
1004731c8d9eSDmitry Karpeev     ierr = PetscOptionsString("-pc_fieldsplit_decomposition", "Name of the DM defining the composition", "PCSetDM", ddm_name, ddm_name,1024,&flg); CHKERRQ(ierr);
1005e7c4fc90SDmitry Karpeev     if (flg) {
100616621825SDmitry Karpeev       ierr = DMCreateFieldDecompositionDM(pc->dm, ddm_name, &ddm); CHKERRQ(ierr);
1007e7c4fc90SDmitry Karpeev       if (!ddm) {
100816621825SDmitry Karpeev         SETERRQ1(((PetscObject)pc)->comm, PETSC_ERR_ARG_WRONGSTATE, "Uknown field decomposition name %s", ddm_name);
1009e7c4fc90SDmitry Karpeev       }
101016621825SDmitry Karpeev       ierr = PetscInfo(pc,"Using field decomposition DM defined using options database\n");CHKERRQ(ierr);
1011e7c4fc90SDmitry Karpeev       ierr = PCSetDM(pc,ddm); CHKERRQ(ierr);
1012e7c4fc90SDmitry Karpeev     }
1013e7c4fc90SDmitry Karpeev   }
1014acfcf0e5SJed Brown   ierr = PetscOptionsBool("-pc_fieldsplit_real_diagonal","Use diagonal blocks of the operator","PCFieldSplitSetRealDiagonal",jac->realdiagonal,&jac->realdiagonal,PETSC_NULL);CHKERRQ(ierr);
101551f519a2SBarry Smith   ierr = PetscOptionsInt("-pc_fieldsplit_block_size","Blocksize that defines number of fields","PCFieldSplitSetBlockSize",jac->bs,&bs,&flg);CHKERRQ(ierr);
101651f519a2SBarry Smith   if (flg) {
101751f519a2SBarry Smith     ierr = PCFieldSplitSetBlockSize(pc,bs);CHKERRQ(ierr);
101851f519a2SBarry Smith   }
1019704ba839SBarry Smith 
1020435f959eSBarry Smith   ierr = PetscOptionsGetBool(((PetscObject)pc)->prefix,"-pc_fieldsplit_detect_saddle_point",&stokes,PETSC_NULL);CHKERRQ(ierr);
1021c0adfefeSBarry Smith   if (stokes) {
1022c0adfefeSBarry Smith     ierr = PCFieldSplitSetType(pc,PC_COMPOSITE_SCHUR);CHKERRQ(ierr);
1023c0adfefeSBarry Smith     jac->schurpre = PC_FIELDSPLIT_SCHUR_PRE_SELF;
1024c0adfefeSBarry Smith   }
1025c0adfefeSBarry Smith 
10263b224e63SBarry Smith   ierr = PetscOptionsEnum("-pc_fieldsplit_type","Type of composition","PCFieldSplitSetType",PCCompositeTypes,(PetscEnum)jac->type,(PetscEnum*)&ctype,&flg);CHKERRQ(ierr);
10273b224e63SBarry Smith   if (flg) {
10283b224e63SBarry Smith     ierr = PCFieldSplitSetType(pc,ctype);CHKERRQ(ierr);
10293b224e63SBarry Smith   }
1030c30613efSMatthew Knepley   /* Only setup fields once */
1031c30613efSMatthew Knepley   if ((jac->bs > 0) && (jac->nsplits == 0)) {
1032d32f9abdSBarry Smith     /* only allow user to set fields from command line if bs is already known.
1033d32f9abdSBarry Smith        otherwise user can set them in PCFieldSplitSetDefaults() */
10346c924f48SJed Brown     ierr = PCFieldSplitSetRuntimeSplits_Private(pc);CHKERRQ(ierr);
10356c924f48SJed Brown     if (jac->splitdefined) {ierr = PetscInfo(pc,"Splits defined using the options database\n");CHKERRQ(ierr);}
1036d32f9abdSBarry Smith   }
1037c5d2311dSJed Brown   if (jac->type == PC_COMPOSITE_SCHUR) {
1038c9c6ffaaSJed Brown     ierr = PetscOptionsGetEnum(((PetscObject)pc)->prefix,"-pc_fieldsplit_schur_factorization_type",PCFieldSplitSchurFactTypes,(PetscEnum*)&jac->schurfactorization,&flg);CHKERRQ(ierr);
1039c9c6ffaaSJed Brown     if (flg) {ierr = PetscInfo(pc,"Deprecated use of -pc_fieldsplit_schur_factorization_type\n");CHKERRQ(ierr);}
1040c9c6ffaaSJed Brown     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,PETSC_NULL);CHKERRQ(ierr);
1041084e4875SJed Brown     ierr = PetscOptionsEnum("-pc_fieldsplit_schur_precondition","How to build preconditioner for Schur complement","PCFieldSplitSchurPrecondition",PCFieldSplitSchurPreTypes,(PetscEnum)jac->schurpre,(PetscEnum*)&jac->schurpre,PETSC_NULL);CHKERRQ(ierr);
1042c5d2311dSJed Brown   }
10431b9fc7fcSBarry Smith   ierr = PetscOptionsTail();CHKERRQ(ierr);
10440971522cSBarry Smith   PetscFunctionReturn(0);
10450971522cSBarry Smith }
10460971522cSBarry Smith 
10470971522cSBarry Smith /*------------------------------------------------------------------------------------*/
10480971522cSBarry Smith 
10490971522cSBarry Smith EXTERN_C_BEGIN
10500971522cSBarry Smith #undef __FUNCT__
10510971522cSBarry Smith #define __FUNCT__ "PCFieldSplitSetFields_FieldSplit"
10525d4c12cdSJungho Lee PetscErrorCode  PCFieldSplitSetFields_FieldSplit(PC pc,const char splitname[],PetscInt n,const PetscInt *fields,const PetscInt *fields_col)
10530971522cSBarry Smith {
105497bbdb24SBarry Smith   PC_FieldSplit     *jac = (PC_FieldSplit*)pc->data;
10550971522cSBarry Smith   PetscErrorCode    ierr;
10565a9f2f41SSatish Balay   PC_FieldSplitLink ilink,next = jac->head;
105769a612a9SBarry Smith   char              prefix[128];
10585d4c12cdSJungho Lee   PetscInt          i;
10590971522cSBarry Smith 
10600971522cSBarry Smith   PetscFunctionBegin;
10616c924f48SJed Brown   if (jac->splitdefined) {
10626c924f48SJed Brown     ierr = PetscInfo1(pc,"Ignoring new split \"%s\" because the splits have already been defined\n",splitname);CHKERRQ(ierr);
10636c924f48SJed Brown     PetscFunctionReturn(0);
10646c924f48SJed Brown   }
106551f519a2SBarry Smith   for (i=0; i<n; i++) {
1066e32f2f54SBarry 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);
1067e32f2f54SBarry Smith     if (fields[i] < 0) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Negative field %D requested",fields[i]);
106851f519a2SBarry Smith   }
1069704ba839SBarry Smith   ierr = PetscNew(struct _PC_FieldSplitLink,&ilink);CHKERRQ(ierr);
1070a04f6461SBarry Smith   if (splitname) {
1071db4c96c1SJed Brown     ierr = PetscStrallocpy(splitname,&ilink->splitname);CHKERRQ(ierr);
1072a04f6461SBarry Smith   } else {
1073a04f6461SBarry Smith     ierr = PetscMalloc(3*sizeof(char),&ilink->splitname);CHKERRQ(ierr);
1074a04f6461SBarry Smith     ierr = PetscSNPrintf(ilink->splitname,2,"%s",jac->nsplits);CHKERRQ(ierr);
1075a04f6461SBarry Smith   }
1076704ba839SBarry Smith   ierr = PetscMalloc(n*sizeof(PetscInt),&ilink->fields);CHKERRQ(ierr);
10775a9f2f41SSatish Balay   ierr = PetscMemcpy(ilink->fields,fields,n*sizeof(PetscInt));CHKERRQ(ierr);
10785d4c12cdSJungho Lee   ierr = PetscMalloc(n*sizeof(PetscInt),&ilink->fields_col);CHKERRQ(ierr);
10795d4c12cdSJungho Lee   ierr = PetscMemcpy(ilink->fields_col,fields_col,n*sizeof(PetscInt));CHKERRQ(ierr);
10805a9f2f41SSatish Balay   ilink->nfields = n;
10815a9f2f41SSatish Balay   ilink->next    = PETSC_NULL;
10827adad957SLisandro Dalcin   ierr           = KSPCreate(((PetscObject)pc)->comm,&ilink->ksp);CHKERRQ(ierr);
108320252d06SBarry Smith   ierr           = PetscObjectIncrementTabLevel((PetscObject)ilink->ksp,(PetscObject)pc,1);CHKERRQ(ierr);
10845a9f2f41SSatish Balay   ierr           = KSPSetType(ilink->ksp,KSPPREONLY);CHKERRQ(ierr);
10859005cf84SBarry Smith   ierr           = PetscLogObjectParent((PetscObject)pc,(PetscObject)ilink->ksp);CHKERRQ(ierr);
108669a612a9SBarry Smith 
10878caf3d72SBarry Smith   ierr = PetscSNPrintf(prefix,sizeof(prefix),"%sfieldsplit_%s_",((PetscObject)pc)->prefix?((PetscObject)pc)->prefix:"",ilink->splitname);CHKERRQ(ierr);
10885a9f2f41SSatish Balay   ierr = KSPSetOptionsPrefix(ilink->ksp,prefix);CHKERRQ(ierr);
10890971522cSBarry Smith 
10900971522cSBarry Smith   if (!next) {
10915a9f2f41SSatish Balay     jac->head       = ilink;
109251f519a2SBarry Smith     ilink->previous = PETSC_NULL;
10930971522cSBarry Smith   } else {
10940971522cSBarry Smith     while (next->next) {
10950971522cSBarry Smith       next = next->next;
10960971522cSBarry Smith     }
10975a9f2f41SSatish Balay     next->next      = ilink;
109851f519a2SBarry Smith     ilink->previous = next;
10990971522cSBarry Smith   }
11000971522cSBarry Smith   jac->nsplits++;
11010971522cSBarry Smith   PetscFunctionReturn(0);
11020971522cSBarry Smith }
11030971522cSBarry Smith EXTERN_C_END
11040971522cSBarry Smith 
1105e69d4d44SBarry Smith EXTERN_C_BEGIN
1106e69d4d44SBarry Smith #undef __FUNCT__
1107e69d4d44SBarry Smith #define __FUNCT__ "PCFieldSplitGetSubKSP_FieldSplit_Schur"
11087087cfbeSBarry Smith PetscErrorCode  PCFieldSplitGetSubKSP_FieldSplit_Schur(PC pc,PetscInt *n,KSP **subksp)
1109e69d4d44SBarry Smith {
1110e69d4d44SBarry Smith   PC_FieldSplit *jac = (PC_FieldSplit*)pc->data;
1111e69d4d44SBarry Smith   PetscErrorCode ierr;
1112e69d4d44SBarry Smith 
1113e69d4d44SBarry Smith   PetscFunctionBegin;
1114519d70e2SJed Brown   ierr = PetscMalloc(jac->nsplits*sizeof(KSP),subksp);CHKERRQ(ierr);
1115e69d4d44SBarry Smith   ierr = MatSchurComplementGetKSP(jac->schur,*subksp);CHKERRQ(ierr);
1116e69d4d44SBarry Smith   (*subksp)[1] = jac->kspschur;
111713e0d083SBarry Smith   if (n) *n = jac->nsplits;
1118e69d4d44SBarry Smith   PetscFunctionReturn(0);
1119e69d4d44SBarry Smith }
1120e69d4d44SBarry Smith EXTERN_C_END
11210971522cSBarry Smith 
11220971522cSBarry Smith EXTERN_C_BEGIN
11230971522cSBarry Smith #undef __FUNCT__
112469a612a9SBarry Smith #define __FUNCT__ "PCFieldSplitGetSubKSP_FieldSplit"
11257087cfbeSBarry Smith PetscErrorCode  PCFieldSplitGetSubKSP_FieldSplit(PC pc,PetscInt *n,KSP **subksp)
11260971522cSBarry Smith {
11270971522cSBarry Smith   PC_FieldSplit     *jac = (PC_FieldSplit*)pc->data;
11280971522cSBarry Smith   PetscErrorCode    ierr;
11290971522cSBarry Smith   PetscInt          cnt = 0;
11305a9f2f41SSatish Balay   PC_FieldSplitLink ilink = jac->head;
11310971522cSBarry Smith 
11320971522cSBarry Smith   PetscFunctionBegin;
11335d480477SMatthew G Knepley   ierr = PetscMalloc(jac->nsplits*sizeof(KSP),subksp);CHKERRQ(ierr);
11345a9f2f41SSatish Balay   while (ilink) {
11355a9f2f41SSatish Balay     (*subksp)[cnt++] = ilink->ksp;
11365a9f2f41SSatish Balay     ilink = ilink->next;
11370971522cSBarry Smith   }
11385d480477SMatthew 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);
113913e0d083SBarry Smith   if (n) *n = jac->nsplits;
11400971522cSBarry Smith   PetscFunctionReturn(0);
11410971522cSBarry Smith }
11420971522cSBarry Smith EXTERN_C_END
11430971522cSBarry Smith 
1144704ba839SBarry Smith EXTERN_C_BEGIN
1145704ba839SBarry Smith #undef __FUNCT__
1146704ba839SBarry Smith #define __FUNCT__ "PCFieldSplitSetIS_FieldSplit"
11477087cfbeSBarry Smith PetscErrorCode  PCFieldSplitSetIS_FieldSplit(PC pc,const char splitname[],IS is)
1148704ba839SBarry Smith {
1149704ba839SBarry Smith   PC_FieldSplit     *jac = (PC_FieldSplit*)pc->data;
1150704ba839SBarry Smith   PetscErrorCode    ierr;
1151704ba839SBarry Smith   PC_FieldSplitLink ilink, next = jac->head;
1152704ba839SBarry Smith   char              prefix[128];
1153704ba839SBarry Smith 
1154704ba839SBarry Smith   PetscFunctionBegin;
11556c924f48SJed Brown   if (jac->splitdefined) {
11566c924f48SJed Brown     ierr = PetscInfo1(pc,"Ignoring new split \"%s\" because the splits have already been defined\n",splitname);CHKERRQ(ierr);
11576c924f48SJed Brown     PetscFunctionReturn(0);
11586c924f48SJed Brown   }
115916913363SBarry Smith   ierr = PetscNew(struct _PC_FieldSplitLink,&ilink);CHKERRQ(ierr);
1160a04f6461SBarry Smith   if (splitname) {
1161db4c96c1SJed Brown     ierr = PetscStrallocpy(splitname,&ilink->splitname);CHKERRQ(ierr);
1162a04f6461SBarry Smith   } else {
1163b5787286SJed Brown     ierr = PetscMalloc(8*sizeof(char),&ilink->splitname);CHKERRQ(ierr);
1164b5787286SJed Brown     ierr = PetscSNPrintf(ilink->splitname,7,"%D",jac->nsplits);CHKERRQ(ierr);
1165a04f6461SBarry Smith   }
11661ab39975SBarry Smith   ierr = PetscObjectReference((PetscObject)is);CHKERRQ(ierr);
1167b5787286SJed Brown   ierr = ISDestroy(&ilink->is);CHKERRQ(ierr);
1168b5787286SJed Brown   ilink->is      = is;
1169b5787286SJed Brown   ierr = PetscObjectReference((PetscObject)is);CHKERRQ(ierr);
1170b5787286SJed Brown   ierr = ISDestroy(&ilink->is_col);CHKERRQ(ierr);
1171b5787286SJed Brown   ilink->is_col  = is;
1172704ba839SBarry Smith   ilink->next    = PETSC_NULL;
1173704ba839SBarry Smith   ierr           = KSPCreate(((PetscObject)pc)->comm,&ilink->ksp);CHKERRQ(ierr);
117420252d06SBarry Smith   ierr           = PetscObjectIncrementTabLevel((PetscObject)ilink->ksp,(PetscObject)pc,1);CHKERRQ(ierr);
1175704ba839SBarry Smith   ierr           = KSPSetType(ilink->ksp,KSPPREONLY);CHKERRQ(ierr);
11769005cf84SBarry Smith   ierr           = PetscLogObjectParent((PetscObject)pc,(PetscObject)ilink->ksp);CHKERRQ(ierr);
1177704ba839SBarry Smith 
11788caf3d72SBarry Smith   ierr = PetscSNPrintf(prefix,sizeof(prefix),"%sfieldsplit_%s_",((PetscObject)pc)->prefix?((PetscObject)pc)->prefix:"",ilink->splitname);CHKERRQ(ierr);
1179704ba839SBarry Smith   ierr = KSPSetOptionsPrefix(ilink->ksp,prefix);CHKERRQ(ierr);
1180704ba839SBarry Smith 
1181704ba839SBarry Smith   if (!next) {
1182704ba839SBarry Smith     jac->head       = ilink;
1183704ba839SBarry Smith     ilink->previous = PETSC_NULL;
1184704ba839SBarry Smith   } else {
1185704ba839SBarry Smith     while (next->next) {
1186704ba839SBarry Smith       next = next->next;
1187704ba839SBarry Smith     }
1188704ba839SBarry Smith     next->next      = ilink;
1189704ba839SBarry Smith     ilink->previous = next;
1190704ba839SBarry Smith   }
1191704ba839SBarry Smith   jac->nsplits++;
1192704ba839SBarry Smith 
1193704ba839SBarry Smith   PetscFunctionReturn(0);
1194704ba839SBarry Smith }
1195704ba839SBarry Smith EXTERN_C_END
1196704ba839SBarry Smith 
11970971522cSBarry Smith #undef __FUNCT__
11980971522cSBarry Smith #define __FUNCT__ "PCFieldSplitSetFields"
11990971522cSBarry Smith /*@
12000971522cSBarry Smith     PCFieldSplitSetFields - Sets the fields for one particular split in the field split preconditioner
12010971522cSBarry Smith 
1202ad4df100SBarry Smith     Logically Collective on PC
12030971522cSBarry Smith 
12040971522cSBarry Smith     Input Parameters:
12050971522cSBarry Smith +   pc  - the preconditioner context
1206a04f6461SBarry Smith .   splitname - name of this split, if PETSC_NULL the number of the split is used
12070971522cSBarry Smith .   n - the number of fields in this split
1208db4c96c1SJed Brown -   fields - the fields in this split
12090971522cSBarry Smith 
12100971522cSBarry Smith     Level: intermediate
12110971522cSBarry Smith 
1212d32f9abdSBarry Smith     Notes: Use PCFieldSplitSetIS() to set a completely general set of indices as a field.
1213d32f9abdSBarry Smith 
12147287d2a3SDmitry Karpeev      The PCFieldSplitSetFields() is for defining fields as strided blocks. For example, if the block
1215d32f9abdSBarry 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
1216d32f9abdSBarry Smith      0xx3xx6xx9xx12 ... x1xx4xx7xx ... xx2xx5xx8xx.. 01x34x67x... 0x1x3x5x7.. x12x45x78x....
1217d32f9abdSBarry Smith      where the numbered entries indicate what is in the field.
1218d32f9abdSBarry Smith 
1219db4c96c1SJed Brown      This function is called once per split (it creates a new split each time).  Solve options
1220db4c96c1SJed Brown      for this split will be available under the prefix -fieldsplit_SPLITNAME_.
1221db4c96c1SJed Brown 
12225d4c12cdSJungho Lee      Developer Note: This routine does not actually create the IS representing the split, that is delayed
12235d4c12cdSJungho Lee      until PCSetUp_FieldSplit(), because information about the vector/matrix layouts may not be
12245d4c12cdSJungho Lee      available when this routine is called.
12255d4c12cdSJungho Lee 
1226d32f9abdSBarry Smith .seealso: PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitSetBlockSize(), PCFieldSplitSetIS()
12270971522cSBarry Smith 
12280971522cSBarry Smith @*/
12295d4c12cdSJungho Lee PetscErrorCode  PCFieldSplitSetFields(PC pc,const char splitname[],PetscInt n,const PetscInt *fields,const PetscInt *fields_col)
12300971522cSBarry Smith {
12314ac538c5SBarry Smith   PetscErrorCode ierr;
12320971522cSBarry Smith 
12330971522cSBarry Smith   PetscFunctionBegin;
12340700a824SBarry Smith   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
1235db4c96c1SJed Brown   PetscValidCharPointer(splitname,2);
1236db4c96c1SJed Brown   if (n < 1) SETERRQ2(((PetscObject)pc)->comm,PETSC_ERR_ARG_OUTOFRANGE,"Provided number of fields %D in split \"%s\" not positive",n,splitname);
1237db4c96c1SJed Brown   PetscValidIntPointer(fields,3);
12385d4c12cdSJungho Lee   ierr = PetscTryMethod(pc,"PCFieldSplitSetFields_C",(PC,const char[],PetscInt,const PetscInt *,const PetscInt *),(pc,splitname,n,fields,fields_col));CHKERRQ(ierr);
12390971522cSBarry Smith   PetscFunctionReturn(0);
12400971522cSBarry Smith }
12410971522cSBarry Smith 
12420971522cSBarry Smith #undef __FUNCT__
1243704ba839SBarry Smith #define __FUNCT__ "PCFieldSplitSetIS"
1244704ba839SBarry Smith /*@
1245704ba839SBarry Smith     PCFieldSplitSetIS - Sets the exact elements for field
1246704ba839SBarry Smith 
1247ad4df100SBarry Smith     Logically Collective on PC
1248704ba839SBarry Smith 
1249704ba839SBarry Smith     Input Parameters:
1250704ba839SBarry Smith +   pc  - the preconditioner context
1251a04f6461SBarry Smith .   splitname - name of this split, if PETSC_NULL the number of the split is used
1252db4c96c1SJed Brown -   is - the index set that defines the vector elements in this field
1253704ba839SBarry Smith 
1254d32f9abdSBarry Smith 
1255a6ffb8dbSJed Brown     Notes:
1256a6ffb8dbSJed Brown     Use PCFieldSplitSetFields(), for fields defined by strided types.
1257a6ffb8dbSJed Brown 
1258db4c96c1SJed Brown     This function is called once per split (it creates a new split each time).  Solve options
1259db4c96c1SJed Brown     for this split will be available under the prefix -fieldsplit_SPLITNAME_.
1260d32f9abdSBarry Smith 
1261704ba839SBarry Smith     Level: intermediate
1262704ba839SBarry Smith 
1263704ba839SBarry Smith .seealso: PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitSetBlockSize()
1264704ba839SBarry Smith 
1265704ba839SBarry Smith @*/
12667087cfbeSBarry Smith PetscErrorCode  PCFieldSplitSetIS(PC pc,const char splitname[],IS is)
1267704ba839SBarry Smith {
12684ac538c5SBarry Smith   PetscErrorCode ierr;
1269704ba839SBarry Smith 
1270704ba839SBarry Smith   PetscFunctionBegin;
12710700a824SBarry Smith   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
12727b62db95SJungho Lee   if (splitname) PetscValidCharPointer(splitname,2);
1273db4c96c1SJed Brown   PetscValidHeaderSpecific(is,IS_CLASSID,3);
12744ac538c5SBarry Smith   ierr = PetscTryMethod(pc,"PCFieldSplitSetIS_C",(PC,const char[],IS),(pc,splitname,is));CHKERRQ(ierr);
1275704ba839SBarry Smith   PetscFunctionReturn(0);
1276704ba839SBarry Smith }
1277704ba839SBarry Smith 
1278704ba839SBarry Smith #undef __FUNCT__
127957a9adfeSMatthew G Knepley #define __FUNCT__ "PCFieldSplitGetIS"
128057a9adfeSMatthew G Knepley /*@
128157a9adfeSMatthew G Knepley     PCFieldSplitGetIS - Retrieves the elements for a field as an IS
128257a9adfeSMatthew G Knepley 
128357a9adfeSMatthew G Knepley     Logically Collective on PC
128457a9adfeSMatthew G Knepley 
128557a9adfeSMatthew G Knepley     Input Parameters:
128657a9adfeSMatthew G Knepley +   pc  - the preconditioner context
128757a9adfeSMatthew G Knepley -   splitname - name of this split
128857a9adfeSMatthew G Knepley 
128957a9adfeSMatthew G Knepley     Output Parameter:
129057a9adfeSMatthew G Knepley -   is - the index set that defines the vector elements in this field, or PETSC_NULL if the field is not found
129157a9adfeSMatthew G Knepley 
129257a9adfeSMatthew G Knepley     Level: intermediate
129357a9adfeSMatthew G Knepley 
129457a9adfeSMatthew G Knepley .seealso: PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitSetIS()
129557a9adfeSMatthew G Knepley 
129657a9adfeSMatthew G Knepley @*/
129757a9adfeSMatthew G Knepley PetscErrorCode PCFieldSplitGetIS(PC pc,const char splitname[],IS *is)
129857a9adfeSMatthew G Knepley {
129957a9adfeSMatthew G Knepley   PetscErrorCode ierr;
130057a9adfeSMatthew G Knepley 
130157a9adfeSMatthew G Knepley   PetscFunctionBegin;
130257a9adfeSMatthew G Knepley   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
130357a9adfeSMatthew G Knepley   PetscValidCharPointer(splitname,2);
130457a9adfeSMatthew G Knepley   PetscValidPointer(is,3);
130557a9adfeSMatthew G Knepley   {
130657a9adfeSMatthew G Knepley     PC_FieldSplit    *jac   = (PC_FieldSplit *) pc->data;
130757a9adfeSMatthew G Knepley     PC_FieldSplitLink ilink = jac->head;
130857a9adfeSMatthew G Knepley     PetscBool         found;
130957a9adfeSMatthew G Knepley 
131057a9adfeSMatthew G Knepley     *is = PETSC_NULL;
131157a9adfeSMatthew G Knepley     while(ilink) {
131257a9adfeSMatthew G Knepley       ierr = PetscStrcmp(ilink->splitname, splitname, &found);CHKERRQ(ierr);
131357a9adfeSMatthew G Knepley       if (found) {
131457a9adfeSMatthew G Knepley         *is = ilink->is;
131557a9adfeSMatthew G Knepley         break;
131657a9adfeSMatthew G Knepley       }
131757a9adfeSMatthew G Knepley       ilink = ilink->next;
131857a9adfeSMatthew G Knepley     }
131957a9adfeSMatthew G Knepley   }
132057a9adfeSMatthew G Knepley   PetscFunctionReturn(0);
132157a9adfeSMatthew G Knepley }
132257a9adfeSMatthew G Knepley 
132357a9adfeSMatthew G Knepley #undef __FUNCT__
132451f519a2SBarry Smith #define __FUNCT__ "PCFieldSplitSetBlockSize"
132551f519a2SBarry Smith /*@
132651f519a2SBarry Smith     PCFieldSplitSetBlockSize - Sets the block size for defining where fields start in the
132751f519a2SBarry Smith       fieldsplit preconditioner. If not set the matrix block size is used.
132851f519a2SBarry Smith 
1329ad4df100SBarry Smith     Logically Collective on PC
133051f519a2SBarry Smith 
133151f519a2SBarry Smith     Input Parameters:
133251f519a2SBarry Smith +   pc  - the preconditioner context
133351f519a2SBarry Smith -   bs - the block size
133451f519a2SBarry Smith 
133551f519a2SBarry Smith     Level: intermediate
133651f519a2SBarry Smith 
133751f519a2SBarry Smith .seealso: PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitSetFields()
133851f519a2SBarry Smith 
133951f519a2SBarry Smith @*/
13407087cfbeSBarry Smith PetscErrorCode  PCFieldSplitSetBlockSize(PC pc,PetscInt bs)
134151f519a2SBarry Smith {
13424ac538c5SBarry Smith   PetscErrorCode ierr;
134351f519a2SBarry Smith 
134451f519a2SBarry Smith   PetscFunctionBegin;
13450700a824SBarry Smith   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
1346c5eb9154SBarry Smith   PetscValidLogicalCollectiveInt(pc,bs,2);
13474ac538c5SBarry Smith   ierr = PetscTryMethod(pc,"PCFieldSplitSetBlockSize_C",(PC,PetscInt),(pc,bs));CHKERRQ(ierr);
134851f519a2SBarry Smith   PetscFunctionReturn(0);
134951f519a2SBarry Smith }
135051f519a2SBarry Smith 
135151f519a2SBarry Smith #undef __FUNCT__
135269a612a9SBarry Smith #define __FUNCT__ "PCFieldSplitGetSubKSP"
13530971522cSBarry Smith /*@C
135469a612a9SBarry Smith    PCFieldSplitGetSubKSP - Gets the KSP contexts for all splits
13550971522cSBarry Smith 
135669a612a9SBarry Smith    Collective on KSP
13570971522cSBarry Smith 
13580971522cSBarry Smith    Input Parameter:
13590971522cSBarry Smith .  pc - the preconditioner context
13600971522cSBarry Smith 
13610971522cSBarry Smith    Output Parameters:
136213e0d083SBarry Smith +  n - the number of splits
136369a612a9SBarry Smith -  pc - the array of KSP contexts
13640971522cSBarry Smith 
13650971522cSBarry Smith    Note:
1366d32f9abdSBarry Smith    After PCFieldSplitGetSubKSP() the array of KSPs IS to be freed by the user
1367d32f9abdSBarry Smith    (not the KSP just the array that contains them).
13680971522cSBarry Smith 
136969a612a9SBarry Smith    You must call KSPSetUp() before calling PCFieldSplitGetSubKSP().
13700971522cSBarry Smith 
1371196cc216SBarry Smith    Fortran Usage: You must pass in a KSP array that is large enough to contain all the local KSPs.
1372196cc216SBarry Smith       You can call PCFieldSplitGetSubKSP(pc,n,PETSC_NULL_OBJECT,ierr) to determine how large the
1373196cc216SBarry Smith       KSP array must be.
1374196cc216SBarry Smith 
1375196cc216SBarry Smith 
13760971522cSBarry Smith    Level: advanced
13770971522cSBarry Smith 
13780971522cSBarry Smith .seealso: PCFIELDSPLIT
13790971522cSBarry Smith @*/
13807087cfbeSBarry Smith PetscErrorCode  PCFieldSplitGetSubKSP(PC pc,PetscInt *n,KSP *subksp[])
13810971522cSBarry Smith {
13824ac538c5SBarry Smith   PetscErrorCode ierr;
13830971522cSBarry Smith 
13840971522cSBarry Smith   PetscFunctionBegin;
13850700a824SBarry Smith   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
138613e0d083SBarry Smith   if (n) PetscValidIntPointer(n,2);
13874ac538c5SBarry Smith   ierr = PetscUseMethod(pc,"PCFieldSplitGetSubKSP_C",(PC,PetscInt*,KSP **),(pc,n,subksp));CHKERRQ(ierr);
13880971522cSBarry Smith   PetscFunctionReturn(0);
13890971522cSBarry Smith }
13900971522cSBarry Smith 
1391e69d4d44SBarry Smith #undef __FUNCT__
1392e69d4d44SBarry Smith #define __FUNCT__ "PCFieldSplitSchurPrecondition"
1393e69d4d44SBarry Smith /*@
1394e69d4d44SBarry Smith     PCFieldSplitSchurPrecondition -  Indicates if the Schur complement is preconditioned by a preconditioner constructed by the
1395a04f6461SBarry Smith       A11 matrix. Otherwise no preconditioner is used.
1396e69d4d44SBarry Smith 
1397e69d4d44SBarry Smith     Collective on PC
1398e69d4d44SBarry Smith 
1399e69d4d44SBarry Smith     Input Parameters:
1400e69d4d44SBarry Smith +   pc  - the preconditioner context
1401fd1303e9SJungho Lee .   ptype - which matrix to use for preconditioning the Schur complement, PC_FIELDSPLIT_SCHUR_PRE_DIAG (diag) is default
1402084e4875SJed Brown -   userpre - matrix to use for preconditioning, or PETSC_NULL
1403084e4875SJed Brown 
1404e69d4d44SBarry Smith     Options Database:
1405084e4875SJed Brown .     -pc_fieldsplit_schur_precondition <self,user,diag> default is diag
1406e69d4d44SBarry Smith 
1407fd1303e9SJungho Lee     Notes:
1408fd1303e9SJungho Lee $    If ptype is
1409fd1303e9SJungho Lee $        user then the preconditioner for the Schur complement is generated by the provided matrix (pre argument
1410fd1303e9SJungho Lee $             to this function).
1411fd1303e9SJungho Lee $        diag then the preconditioner for the Schur complement is generated by the block diagonal part of the original
1412fd1303e9SJungho Lee $             matrix associated with the Schur complement (i.e. A11)
1413fd1303e9SJungho Lee $        self the preconditioner for the Schur complement is generated from the Schur complement matrix itself:
1414fd1303e9SJungho Lee $             The only preconditioner that currently works directly with the Schur complement matrix object is the PCLSC
1415fd1303e9SJungho Lee $             preconditioner
1416fd1303e9SJungho Lee 
1417fd1303e9SJungho Lee      When solving a saddle point problem, where the A11 block is identically zero, using diag as the ptype only makes sense
1418fd1303e9SJungho Lee     with the additional option -fieldsplit_1_pc_type none. Usually for saddle point problems one would use a ptype of self and
1419fd1303e9SJungho Lee     -fieldsplit_1_pc_type lsc which uses the least squares commutator compute a preconditioner for the Schur complement.
1420fd1303e9SJungho Lee 
1421fd1303e9SJungho Lee     Developer Notes: This is a terrible name, gives no good indication of what the function does and should also have Set in
1422fd1303e9SJungho Lee      the name since it sets a proceedure to use.
1423fd1303e9SJungho Lee 
1424e69d4d44SBarry Smith     Level: intermediate
1425e69d4d44SBarry Smith 
1426fd1303e9SJungho Lee .seealso: PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitSetFields(), PCFieldSplitSchurPreType, PCLSC
1427e69d4d44SBarry Smith 
1428e69d4d44SBarry Smith @*/
14297087cfbeSBarry Smith PetscErrorCode  PCFieldSplitSchurPrecondition(PC pc,PCFieldSplitSchurPreType ptype,Mat pre)
1430e69d4d44SBarry Smith {
14314ac538c5SBarry Smith   PetscErrorCode ierr;
1432e69d4d44SBarry Smith 
1433e69d4d44SBarry Smith   PetscFunctionBegin;
14340700a824SBarry Smith   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
14354ac538c5SBarry Smith   ierr = PetscTryMethod(pc,"PCFieldSplitSchurPrecondition_C",(PC,PCFieldSplitSchurPreType,Mat),(pc,ptype,pre));CHKERRQ(ierr);
1436e69d4d44SBarry Smith   PetscFunctionReturn(0);
1437e69d4d44SBarry Smith }
1438e69d4d44SBarry Smith 
1439e69d4d44SBarry Smith EXTERN_C_BEGIN
1440e69d4d44SBarry Smith #undef __FUNCT__
1441e69d4d44SBarry Smith #define __FUNCT__ "PCFieldSplitSchurPrecondition_FieldSplit"
14427087cfbeSBarry Smith PetscErrorCode  PCFieldSplitSchurPrecondition_FieldSplit(PC pc,PCFieldSplitSchurPreType ptype,Mat pre)
1443e69d4d44SBarry Smith {
1444e69d4d44SBarry Smith   PC_FieldSplit  *jac = (PC_FieldSplit*)pc->data;
1445084e4875SJed Brown   PetscErrorCode  ierr;
1446e69d4d44SBarry Smith 
1447e69d4d44SBarry Smith   PetscFunctionBegin;
1448084e4875SJed Brown   jac->schurpre = ptype;
1449084e4875SJed Brown   if (pre) {
14506bf464f9SBarry Smith     ierr = MatDestroy(&jac->schur_user);CHKERRQ(ierr);
1451084e4875SJed Brown     jac->schur_user = pre;
1452084e4875SJed Brown     ierr = PetscObjectReference((PetscObject)jac->schur_user);CHKERRQ(ierr);
1453084e4875SJed Brown   }
1454e69d4d44SBarry Smith   PetscFunctionReturn(0);
1455e69d4d44SBarry Smith }
1456e69d4d44SBarry Smith EXTERN_C_END
1457e69d4d44SBarry Smith 
145830ad9308SMatthew Knepley #undef __FUNCT__
1459c9c6ffaaSJed Brown #define __FUNCT__ "PCFieldSplitSetSchurFactType"
1460ab1df9f5SJed Brown /*@
1461c9c6ffaaSJed Brown     PCFieldSplitSetSchurFactType -  sets which blocks of the approximate block factorization to retain
1462ab1df9f5SJed Brown 
1463ab1df9f5SJed Brown     Collective on PC
1464ab1df9f5SJed Brown 
1465ab1df9f5SJed Brown     Input Parameters:
1466ab1df9f5SJed Brown +   pc  - the preconditioner context
1467c9c6ffaaSJed Brown -   ftype - which blocks of factorization to retain, PC_FIELDSPLIT_SCHUR_FACT_FULL is default
1468ab1df9f5SJed Brown 
1469ab1df9f5SJed Brown     Options Database:
1470c9c6ffaaSJed Brown .     -pc_fieldsplit_schur_fact_type <diag,lower,upper,full> default is full
1471ab1df9f5SJed Brown 
1472ab1df9f5SJed Brown 
1473ab1df9f5SJed Brown     Level: intermediate
1474ab1df9f5SJed Brown 
1475ab1df9f5SJed Brown     Notes:
1476ab1df9f5SJed Brown     The FULL factorization is
1477ab1df9f5SJed Brown 
1478ab1df9f5SJed Brown $   (A   B)  = (1       0) (A   0) (1  Ainv*B)
1479ab1df9f5SJed Brown $   (C   D)    (C*Ainv  1) (0   S) (0     1  )
1480ab1df9f5SJed Brown 
14816be4592eSBarry Smith     where S = D - C*Ainv*B. In practice, the full factorization is applied via block triangular solves with the grouping L*(D*U). UPPER uses D*U, LOWER uses L*D,
14826be4592eSBarry Smith     and DIAG is the diagonal part with the sign of S flipped (because this makes the preconditioner positive definite for many formulations, thus allowing the use of KSPMINRES).
1483ab1df9f5SJed Brown 
14846be4592eSBarry Smith     If applied exactly, FULL factorization is a direct solver. The preconditioned operator with LOWER or UPPER has all eigenvalues equal to 1 and minimal polynomial
14856be4592eSBarry Smith     of degree 2, so KSPGMRES converges in 2 iterations. If the iteration count is very low, consider using KSPFGMRES or KSPGCR which can use one less preconditioner
14866be4592eSBarry Smith     application in this case. Note that the preconditioned operator may be highly non-normal, so such fast convergence may not be observed in practice. With DIAG,
14876be4592eSBarry Smith     the preconditioned operator has three distinct nonzero eigenvalues and minimal polynomial of degree at most 4, so KSPGMRES converges in at most 4 iterations.
1488ab1df9f5SJed Brown 
14896be4592eSBarry Smith     For symmetric problems in which A is positive definite and S is negative definite, DIAG can be used with KSPMINRES. Note that a flexible method like KSPFGMRES
14906be4592eSBarry Smith     or KSPGCR must be used if the fieldsplit preconditioner is nonlinear (e.g. a few iterations of a Krylov method is used inside a split).
1491ab1df9f5SJed Brown 
1492ab1df9f5SJed Brown     References:
1493ab1df9f5SJed Brown     Murphy, Golub, and Wathen, A note on preconditioning indefinite linear systems, SIAM J. Sci. Comput., 21 (2000) pp. 1969-1972.
1494ab1df9f5SJed Brown 
1495ab1df9f5SJed Brown     Ipsen, A note on preconditioning nonsymmetric matrices, SIAM J. Sci. Comput., 23 (2001), pp. 1050-1051.
1496ab1df9f5SJed Brown 
1497ab1df9f5SJed Brown .seealso: PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitSetFields(), PCFieldSplitSchurPreType
1498ab1df9f5SJed Brown @*/
1499c9c6ffaaSJed Brown PetscErrorCode  PCFieldSplitSetSchurFactType(PC pc,PCFieldSplitSchurFactType ftype)
1500ab1df9f5SJed Brown {
1501ab1df9f5SJed Brown   PetscErrorCode ierr;
1502ab1df9f5SJed Brown 
1503ab1df9f5SJed Brown   PetscFunctionBegin;
1504ab1df9f5SJed Brown   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
1505c9c6ffaaSJed Brown   ierr = PetscTryMethod(pc,"PCFieldSplitSetSchurFactType_C",(PC,PCFieldSplitSchurFactType),(pc,ftype));CHKERRQ(ierr);
1506ab1df9f5SJed Brown   PetscFunctionReturn(0);
1507ab1df9f5SJed Brown }
1508ab1df9f5SJed Brown 
1509ab1df9f5SJed Brown #undef __FUNCT__
1510c9c6ffaaSJed Brown #define __FUNCT__ "PCFieldSplitSetSchurFactType_FieldSplit"
1511c9c6ffaaSJed Brown PETSC_EXTERN_C PetscErrorCode PCFieldSplitSetSchurFactType_FieldSplit(PC pc,PCFieldSplitSchurFactType ftype)
1512ab1df9f5SJed Brown {
1513ab1df9f5SJed Brown   PC_FieldSplit  *jac = (PC_FieldSplit*)pc->data;
1514ab1df9f5SJed Brown 
1515ab1df9f5SJed Brown   PetscFunctionBegin;
1516ab1df9f5SJed Brown   jac->schurfactorization = ftype;
1517ab1df9f5SJed Brown   PetscFunctionReturn(0);
1518ab1df9f5SJed Brown }
1519ab1df9f5SJed Brown 
1520ab1df9f5SJed Brown #undef __FUNCT__
152130ad9308SMatthew Knepley #define __FUNCT__ "PCFieldSplitGetSchurBlocks"
152230ad9308SMatthew Knepley /*@C
15238c03b21aSDmitry Karpeev    PCFieldSplitGetSchurBlocks - Gets all matrix blocks for the Schur complement
152430ad9308SMatthew Knepley 
152530ad9308SMatthew Knepley    Collective on KSP
152630ad9308SMatthew Knepley 
152730ad9308SMatthew Knepley    Input Parameter:
152830ad9308SMatthew Knepley .  pc - the preconditioner context
152930ad9308SMatthew Knepley 
153030ad9308SMatthew Knepley    Output Parameters:
1531a04f6461SBarry Smith +  A00 - the (0,0) block
1532a04f6461SBarry Smith .  A01 - the (0,1) block
1533a04f6461SBarry Smith .  A10 - the (1,0) block
1534a04f6461SBarry Smith -  A11 - the (1,1) block
153530ad9308SMatthew Knepley 
153630ad9308SMatthew Knepley    Level: advanced
153730ad9308SMatthew Knepley 
153830ad9308SMatthew Knepley .seealso: PCFIELDSPLIT
153930ad9308SMatthew Knepley @*/
1540a04f6461SBarry Smith PetscErrorCode  PCFieldSplitGetSchurBlocks(PC pc,Mat *A00,Mat *A01,Mat *A10, Mat *A11)
154130ad9308SMatthew Knepley {
154230ad9308SMatthew Knepley   PC_FieldSplit *jac = (PC_FieldSplit *) pc->data;
154330ad9308SMatthew Knepley 
154430ad9308SMatthew Knepley   PetscFunctionBegin;
15450700a824SBarry Smith   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
1546c1235816SBarry Smith   if (jac->type != PC_COMPOSITE_SCHUR) SETERRQ(((PetscObject)pc)->comm,PETSC_ERR_ARG_WRONG, "FieldSplit is not using a Schur complement approach.");
1547a04f6461SBarry Smith   if (A00) *A00 = jac->pmat[0];
1548a04f6461SBarry Smith   if (A01) *A01 = jac->B;
1549a04f6461SBarry Smith   if (A10) *A10 = jac->C;
1550a04f6461SBarry Smith   if (A11) *A11 = jac->pmat[1];
155130ad9308SMatthew Knepley   PetscFunctionReturn(0);
155230ad9308SMatthew Knepley }
155330ad9308SMatthew Knepley 
155479416396SBarry Smith EXTERN_C_BEGIN
155579416396SBarry Smith #undef __FUNCT__
155679416396SBarry Smith #define __FUNCT__ "PCFieldSplitSetType_FieldSplit"
15577087cfbeSBarry Smith PetscErrorCode  PCFieldSplitSetType_FieldSplit(PC pc,PCCompositeType type)
155879416396SBarry Smith {
155979416396SBarry Smith   PC_FieldSplit  *jac = (PC_FieldSplit*)pc->data;
1560e69d4d44SBarry Smith   PetscErrorCode ierr;
156179416396SBarry Smith 
156279416396SBarry Smith   PetscFunctionBegin;
156379416396SBarry Smith   jac->type = type;
15643b224e63SBarry Smith   if (type == PC_COMPOSITE_SCHUR) {
15653b224e63SBarry Smith     pc->ops->apply = PCApply_FieldSplit_Schur;
15663b224e63SBarry Smith     pc->ops->view  = PCView_FieldSplit_Schur;
1567e69d4d44SBarry Smith     ierr = PetscObjectComposeFunctionDynamic((PetscObject)pc,"PCFieldSplitGetSubKSP_C","PCFieldSplitGetSubKSP_FieldSplit_Schur",PCFieldSplitGetSubKSP_FieldSplit_Schur);CHKERRQ(ierr);
1568e69d4d44SBarry Smith     ierr = PetscObjectComposeFunctionDynamic((PetscObject)pc,"PCFieldSplitSchurPrecondition_C","PCFieldSplitSchurPrecondition_FieldSplit",PCFieldSplitSchurPrecondition_FieldSplit);CHKERRQ(ierr);
1569c9c6ffaaSJed Brown     ierr = PetscObjectComposeFunctionDynamic((PetscObject)pc,"PCFieldSplitSetSchurFactType_C","PCFieldSplitSetSchurFactType_FieldSplit",PCFieldSplitSetSchurFactType_FieldSplit);CHKERRQ(ierr);
1570e69d4d44SBarry Smith 
15713b224e63SBarry Smith   } else {
15723b224e63SBarry Smith     pc->ops->apply = PCApply_FieldSplit;
15733b224e63SBarry Smith     pc->ops->view  = PCView_FieldSplit;
1574e69d4d44SBarry Smith     ierr = PetscObjectComposeFunctionDynamic((PetscObject)pc,"PCFieldSplitGetSubKSP_C","PCFieldSplitGetSubKSP_FieldSplit",PCFieldSplitGetSubKSP_FieldSplit);CHKERRQ(ierr);
15759e7d6b0aSBarry Smith     ierr = PetscObjectComposeFunctionDynamic((PetscObject)pc,"PCFieldSplitSchurPrecondition_C","",0);CHKERRQ(ierr);
1576c9c6ffaaSJed Brown     ierr = PetscObjectComposeFunctionDynamic((PetscObject)pc,"PCFieldSplitSetSchurFactType_C","",0);CHKERRQ(ierr);
15773b224e63SBarry Smith   }
157879416396SBarry Smith   PetscFunctionReturn(0);
157979416396SBarry Smith }
158079416396SBarry Smith EXTERN_C_END
158179416396SBarry Smith 
158251f519a2SBarry Smith EXTERN_C_BEGIN
158351f519a2SBarry Smith #undef __FUNCT__
158451f519a2SBarry Smith #define __FUNCT__ "PCFieldSplitSetBlockSize_FieldSplit"
15857087cfbeSBarry Smith PetscErrorCode  PCFieldSplitSetBlockSize_FieldSplit(PC pc,PetscInt bs)
158651f519a2SBarry Smith {
158751f519a2SBarry Smith   PC_FieldSplit  *jac = (PC_FieldSplit*)pc->data;
158851f519a2SBarry Smith 
158951f519a2SBarry Smith   PetscFunctionBegin;
159065e19b50SBarry Smith   if (bs < 1) SETERRQ1(((PetscObject)pc)->comm,PETSC_ERR_ARG_OUTOFRANGE,"Blocksize must be positive, you gave %D",bs);
159165e19b50SBarry Smith   if (jac->bs > 0 && jac->bs != bs) SETERRQ2(((PetscObject)pc)->comm,PETSC_ERR_ARG_WRONGSTATE,"Cannot change fieldsplit blocksize from %D to %D after it has been set",jac->bs,bs);
159251f519a2SBarry Smith   jac->bs = bs;
159351f519a2SBarry Smith   PetscFunctionReturn(0);
159451f519a2SBarry Smith }
159551f519a2SBarry Smith EXTERN_C_END
159651f519a2SBarry Smith 
159779416396SBarry Smith #undef __FUNCT__
159879416396SBarry Smith #define __FUNCT__ "PCFieldSplitSetType"
1599bc08b0f1SBarry Smith /*@
160079416396SBarry Smith    PCFieldSplitSetType - Sets the type of fieldsplit preconditioner.
160179416396SBarry Smith 
160279416396SBarry Smith    Collective on PC
160379416396SBarry Smith 
160479416396SBarry Smith    Input Parameter:
160579416396SBarry Smith .  pc - the preconditioner context
160681540f2fSBarry Smith .  type - PC_COMPOSITE_ADDITIVE, PC_COMPOSITE_MULTIPLICATIVE (default), PC_COMPOSITE_SYMMETRIC_MULTIPLICATIVE, PC_COMPOSITE_SPECIAL, PC_COMPOSITE_SCHUR
160779416396SBarry Smith 
160879416396SBarry Smith    Options Database Key:
1609a4efd8eaSMatthew Knepley .  -pc_fieldsplit_type <type: one of multiplicative, additive, symmetric_multiplicative, special, schur> - Sets fieldsplit preconditioner type
161079416396SBarry Smith 
1611b02e2d75SMatthew G Knepley    Level: Intermediate
161279416396SBarry Smith 
161379416396SBarry Smith .keywords: PC, set, type, composite preconditioner, additive, multiplicative
161479416396SBarry Smith 
161579416396SBarry Smith .seealso: PCCompositeSetType()
161679416396SBarry Smith 
161779416396SBarry Smith @*/
16187087cfbeSBarry Smith PetscErrorCode  PCFieldSplitSetType(PC pc,PCCompositeType type)
161979416396SBarry Smith {
16204ac538c5SBarry Smith   PetscErrorCode ierr;
162179416396SBarry Smith 
162279416396SBarry Smith   PetscFunctionBegin;
16230700a824SBarry Smith   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
16244ac538c5SBarry Smith   ierr = PetscTryMethod(pc,"PCFieldSplitSetType_C",(PC,PCCompositeType),(pc,type));CHKERRQ(ierr);
162579416396SBarry Smith   PetscFunctionReturn(0);
162679416396SBarry Smith }
162779416396SBarry Smith 
1628b02e2d75SMatthew G Knepley #undef __FUNCT__
1629b02e2d75SMatthew G Knepley #define __FUNCT__ "PCFieldSplitGetType"
1630b02e2d75SMatthew G Knepley /*@
1631b02e2d75SMatthew G Knepley   PCFieldSplitGetType - Gets the type of fieldsplit preconditioner.
1632b02e2d75SMatthew G Knepley 
1633b02e2d75SMatthew G Knepley   Not collective
1634b02e2d75SMatthew G Knepley 
1635b02e2d75SMatthew G Knepley   Input Parameter:
1636b02e2d75SMatthew G Knepley . pc - the preconditioner context
1637b02e2d75SMatthew G Knepley 
1638b02e2d75SMatthew G Knepley   Output Parameter:
1639b02e2d75SMatthew G Knepley . type - PC_COMPOSITE_ADDITIVE, PC_COMPOSITE_MULTIPLICATIVE (default), PC_COMPOSITE_SYMMETRIC_MULTIPLICATIVE, PC_COMPOSITE_SPECIAL, PC_COMPOSITE_SCHUR
1640b02e2d75SMatthew G Knepley 
1641b02e2d75SMatthew G Knepley   Level: Intermediate
1642b02e2d75SMatthew G Knepley 
1643b02e2d75SMatthew G Knepley .keywords: PC, set, type, composite preconditioner, additive, multiplicative
1644b02e2d75SMatthew G Knepley .seealso: PCCompositeSetType()
1645b02e2d75SMatthew G Knepley @*/
1646b02e2d75SMatthew G Knepley PetscErrorCode PCFieldSplitGetType(PC pc, PCCompositeType *type)
1647b02e2d75SMatthew G Knepley {
1648b02e2d75SMatthew G Knepley   PC_FieldSplit *jac = (PC_FieldSplit *) pc->data;
1649b02e2d75SMatthew G Knepley 
1650b02e2d75SMatthew G Knepley   PetscFunctionBegin;
1651b02e2d75SMatthew G Knepley   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
1652b02e2d75SMatthew G Knepley   PetscValidIntPointer(type,2);
1653b02e2d75SMatthew G Knepley   *type = jac->type;
1654b02e2d75SMatthew G Knepley   PetscFunctionReturn(0);
1655b02e2d75SMatthew G Knepley }
1656b02e2d75SMatthew G Knepley 
16570971522cSBarry Smith /* -------------------------------------------------------------------------------------*/
16580971522cSBarry Smith /*MC
1659a8c7a070SBarry Smith    PCFIELDSPLIT - Preconditioner created by combining separate preconditioners for individual
1660a04f6461SBarry Smith                   fields or groups of fields. See the users manual section "Solving Block Matrices" for more details.
16610971522cSBarry Smith 
1662edf189efSBarry Smith      To set options on the solvers for each block append -fieldsplit_ to all the PC
1663edf189efSBarry Smith         options database keys. For example, -fieldsplit_pc_type ilu -fieldsplit_pc_factor_levels 1
16640971522cSBarry Smith 
1665a8c7a070SBarry Smith      To set the options on the solvers separate for each block call PCFieldSplitGetSubKSP()
166669a612a9SBarry Smith          and set the options directly on the resulting KSP object
16670971522cSBarry Smith 
16680971522cSBarry Smith    Level: intermediate
16690971522cSBarry Smith 
167079416396SBarry Smith    Options Database Keys:
167181540f2fSBarry Smith +   -pc_fieldsplit_%d_fields <a,b,..> - indicates the fields to be used in the %d'th split
167281540f2fSBarry Smith .   -pc_fieldsplit_default - automatically add any fields to additional splits that have not
167381540f2fSBarry Smith                               been supplied explicitly by -pc_fieldsplit_%d_fields
167481540f2fSBarry Smith .   -pc_fieldsplit_block_size <bs> - size of block that defines fields (i.e. there are bs fields)
16750f188ba9SJed Brown .   -pc_fieldsplit_type <additive,multiplicative,symmetric_multiplicative,schur> - type of relaxation or factorization splitting
16760f188ba9SJed Brown .   -pc_fieldsplit_schur_precondition <self,user,diag> - default is diag
1677435f959eSBarry Smith .   -pc_fieldsplit_detect_saddle_point - automatically finds rows with zero or negative diagonal and uses Schur complement with no preconditioner as the solver
167879416396SBarry Smith 
16795d4c12cdSJungho Lee -    Options prefix for inner solvers when using Schur complement preconditioner are -fieldsplit_0_ and -fieldsplit_1_
16805d4c12cdSJungho Lee      for all other solvers they are -fieldsplit_%d_ for the dth field, use -fieldsplit_ for all fields
16815d4c12cdSJungho Lee 
1682c8a0d604SMatthew G Knepley    Notes:
1683c8a0d604SMatthew G Knepley     Use PCFieldSplitSetFields() to set fields defined by "strided" entries and PCFieldSplitSetIS()
1684d32f9abdSBarry Smith      to define a field by an arbitrary collection of entries.
1685d32f9abdSBarry Smith 
1686d32f9abdSBarry Smith       If no fields are set the default is used. The fields are defined by entries strided by bs,
1687d32f9abdSBarry Smith       beginning at 0 then 1, etc to bs-1. The block size can be set with PCFieldSplitSetBlockSize(),
1688d32f9abdSBarry Smith       if this is not called the block size defaults to the blocksize of the second matrix passed
1689d32f9abdSBarry Smith       to KSPSetOperators()/PCSetOperators().
1690d32f9abdSBarry Smith 
1691c8a0d604SMatthew G Knepley $     For the Schur complement preconditioner if J = ( A00 A01 )
1692c8a0d604SMatthew G Knepley $                                                    ( A10 A11 )
1693c8a0d604SMatthew G Knepley $     the preconditioner using full factorization is
1694c8a0d604SMatthew G Knepley $              ( I   -A10 ksp(A00) ) ( inv(A00)     0  ) (     I          0  )
1695c8a0d604SMatthew G Knepley $              ( 0         I       ) (   0      ksp(S) ) ( -A10 ksp(A00)  I  )
1696a04f6461SBarry Smith      where the action of inv(A00) is applied using the KSP solver with prefix -fieldsplit_0_. The action of
1697c8a0d604SMatthew G Knepley      ksp(S) is computed using the KSP solver with prefix -fieldsplit_splitname_ (where splitname was given
1698c8a0d604SMatthew G Knepley      in providing the SECOND split or 1 if not give). For PCFieldSplitGetKSP() when field number is 0,
1699c8a0d604SMatthew G Knepley      it returns the KSP associated with -fieldsplit_0_ while field number 1 gives -fieldsplit_1_ KSP. By default
1700a04f6461SBarry Smith      A11 is used to construct a preconditioner for S, use PCFieldSplitSchurPrecondition() to turn on or off this
1701c8a0d604SMatthew G Knepley      option. You can use the preconditioner PCLSC to precondition the Schur complement with -fieldsplit_1_pc_type lsc. The
1702c9c6ffaaSJed Brown      factorization type is set using -pc_fieldsplit_schur_fact_type <diag, lower, upper, full>. The full is shown above,
17035668aaf4SBarry Smith      diag gives
1704c8a0d604SMatthew G Knepley $              ( inv(A00)     0   )
1705c8a0d604SMatthew G Knepley $              (   0      -ksp(S) )
17065668aaf4SBarry Smith      note that slightly counter intuitively there is a negative in front of the ksp(S) so that the preconditioner is positive definite. The lower factorization is the inverse of
1707c8a0d604SMatthew G Knepley $              (  A00   0 )
1708c8a0d604SMatthew G Knepley $              (  A10   S )
1709c8a0d604SMatthew G Knepley      where the inverses of A00 and S are applied using KSPs. The upper factorization is the inverse of
1710c8a0d604SMatthew G Knepley $              ( A00 A01 )
1711c8a0d604SMatthew G Knepley $              (  0   S  )
1712c8a0d604SMatthew G Knepley      where again the inverses of A00 and S are applied using KSPs.
1713e69d4d44SBarry Smith 
1714edf189efSBarry Smith      If only one set of indices (one IS) is provided with PCFieldSplitSetIS() then the complement of that IS
1715edf189efSBarry Smith      is used automatically for a second block.
1716edf189efSBarry Smith 
1717ff218e97SBarry Smith      The fieldsplit preconditioner cannot currently be used with the BAIJ or SBAIJ data formats if the blocksize is larger than 1.
1718ff218e97SBarry Smith      Generally it should be used with the AIJ format.
1719ff218e97SBarry Smith 
1720ff218e97SBarry Smith      The forms of these preconditioners are closely related if not identical to forms derived as "Distributive Iterations", see,
1721ff218e97SBarry Smith      for example, page 294 in "Principles of Computational Fluid Dynamics" by Pieter Wesseling. Note that one can also use PCFIELDSPLIT
1722ff218e97SBarry Smith      inside a smoother resulting in "Distributive Smoothers".
17230716a85fSBarry Smith 
1724a541d17aSBarry Smith    Concepts: physics based preconditioners, block preconditioners
17250971522cSBarry Smith 
17267e8cb189SBarry Smith .seealso:  PCCreate(), PCSetType(), PCType (for list of available types), PC, Block_Preconditioners, PCLSC,
1727e69d4d44SBarry Smith            PCFieldSplitGetSubKSP(), PCFieldSplitSetFields(), PCFieldSplitSetType(), PCFieldSplitSetIS(), PCFieldSplitSchurPrecondition()
17280971522cSBarry Smith M*/
17290971522cSBarry Smith 
17300971522cSBarry Smith EXTERN_C_BEGIN
17310971522cSBarry Smith #undef __FUNCT__
17320971522cSBarry Smith #define __FUNCT__ "PCCreate_FieldSplit"
17337087cfbeSBarry Smith PetscErrorCode  PCCreate_FieldSplit(PC pc)
17340971522cSBarry Smith {
17350971522cSBarry Smith   PetscErrorCode ierr;
17360971522cSBarry Smith   PC_FieldSplit  *jac;
17370971522cSBarry Smith 
17380971522cSBarry Smith   PetscFunctionBegin;
173938f2d2fdSLisandro Dalcin   ierr = PetscNewLog(pc,PC_FieldSplit,&jac);CHKERRQ(ierr);
17400971522cSBarry Smith   jac->bs        = -1;
17410971522cSBarry Smith   jac->nsplits   = 0;
17423e197d65SBarry Smith   jac->type      = PC_COMPOSITE_MULTIPLICATIVE;
1743e6cab6aaSJed Brown   jac->schurpre  = PC_FIELDSPLIT_SCHUR_PRE_USER; /* Try user preconditioner first, fall back on diagonal */
1744c9c6ffaaSJed Brown   jac->schurfactorization = PC_FIELDSPLIT_SCHUR_FACT_FULL;
174551f519a2SBarry Smith 
17460971522cSBarry Smith   pc->data     = (void*)jac;
17470971522cSBarry Smith 
17480971522cSBarry Smith   pc->ops->apply             = PCApply_FieldSplit;
1749421e10b8SBarry Smith   pc->ops->applytranspose    = PCApplyTranspose_FieldSplit;
17500971522cSBarry Smith   pc->ops->setup             = PCSetUp_FieldSplit;
1751574deadeSBarry Smith   pc->ops->reset             = PCReset_FieldSplit;
17520971522cSBarry Smith   pc->ops->destroy           = PCDestroy_FieldSplit;
17530971522cSBarry Smith   pc->ops->setfromoptions    = PCSetFromOptions_FieldSplit;
17540971522cSBarry Smith   pc->ops->view              = PCView_FieldSplit;
17550971522cSBarry Smith   pc->ops->applyrichardson   = 0;
17560971522cSBarry Smith 
175769a612a9SBarry Smith   ierr = PetscObjectComposeFunctionDynamic((PetscObject)pc,"PCFieldSplitGetSubKSP_C","PCFieldSplitGetSubKSP_FieldSplit",
175869a612a9SBarry Smith                     PCFieldSplitGetSubKSP_FieldSplit);CHKERRQ(ierr);
17590971522cSBarry Smith   ierr = PetscObjectComposeFunctionDynamic((PetscObject)pc,"PCFieldSplitSetFields_C","PCFieldSplitSetFields_FieldSplit",
17600971522cSBarry Smith                     PCFieldSplitSetFields_FieldSplit);CHKERRQ(ierr);
1761704ba839SBarry Smith   ierr = PetscObjectComposeFunctionDynamic((PetscObject)pc,"PCFieldSplitSetIS_C","PCFieldSplitSetIS_FieldSplit",
1762704ba839SBarry Smith                     PCFieldSplitSetIS_FieldSplit);CHKERRQ(ierr);
176379416396SBarry Smith   ierr = PetscObjectComposeFunctionDynamic((PetscObject)pc,"PCFieldSplitSetType_C","PCFieldSplitSetType_FieldSplit",
176479416396SBarry Smith                     PCFieldSplitSetType_FieldSplit);CHKERRQ(ierr);
176551f519a2SBarry Smith   ierr = PetscObjectComposeFunctionDynamic((PetscObject)pc,"PCFieldSplitSetBlockSize_C","PCFieldSplitSetBlockSize_FieldSplit",
176651f519a2SBarry Smith                     PCFieldSplitSetBlockSize_FieldSplit);CHKERRQ(ierr);
17670971522cSBarry Smith   PetscFunctionReturn(0);
17680971522cSBarry Smith }
17690971522cSBarry Smith EXTERN_C_END
17700971522cSBarry Smith 
17710971522cSBarry Smith 
1772a541d17aSBarry Smith 
1773