1dba47a55SKris Buschelman 2f5f0d762SBarry Smith 3af0996ceSBarry Smith #include <petsc/private/pcimpl.h> /*I "petscpc.h" I*/ 4a80b646eSBarry Smith #include <petsc/private/kspimpl.h> /* This is needed to provide the appropriate PETSC_EXTERN for KSP_Solve_FS ....*/ 51e25c274SJed Brown #include <petscdm.h> 60971522cSBarry Smith 72e71c61dSMatthew G. Knepley const char *const PCFieldSplitSchurPreTypes[] = {"SELF","SELFP","A11","USER","FULL","PCFieldSplitSchurPreType","PC_FIELDSPLIT_SCHUR_PRE_",0}; 8c9c6ffaaSJed Brown const char *const PCFieldSplitSchurFactTypes[] = {"DIAG","LOWER","UPPER","FULL","PCFieldSplitSchurFactType","PC_FIELDSPLIT_SCHUR_FACT_",0}; 9c5d2311dSJed Brown 109df09d43SBarry Smith PetscLogEvent KSP_Solve_FS_0,KSP_Solve_FS_1,KSP_Solve_FS_S,KSP_Solve_FS_U,KSP_Solve_FS_L,KSP_Solve_FS_2,KSP_Solve_FS_3,KSP_Solve_FS_4; 119df09d43SBarry Smith 120971522cSBarry Smith typedef struct _PC_FieldSplitLink *PC_FieldSplitLink; 130971522cSBarry Smith struct _PC_FieldSplitLink { 1469a612a9SBarry Smith KSP ksp; 15443836d0SMatthew G Knepley Vec x,y,z; 16db4c96c1SJed Brown char *splitname; 170971522cSBarry Smith PetscInt nfields; 185d4c12cdSJungho Lee PetscInt *fields,*fields_col; 191b9fc7fcSBarry Smith VecScatter sctx; 20f5f0d762SBarry Smith IS is,is_col; 2151f519a2SBarry Smith PC_FieldSplitLink next,previous; 229df09d43SBarry Smith PetscLogEvent event; 230971522cSBarry Smith }; 240971522cSBarry Smith 250971522cSBarry Smith typedef struct { 2668dd23aaSBarry Smith PCCompositeType type; 27ace3abfcSBarry Smith PetscBool defaultsplit; /* Flag for a system with a set of 'k' scalar fields with the same layout (and bs = k) */ 28ace3abfcSBarry Smith PetscBool splitdefined; /* Flag is set after the splits have been defined, to prevent more splits from being added */ 2930ad9308SMatthew Knepley PetscInt bs; /* Block size for IS and Mat structures */ 3030ad9308SMatthew Knepley PetscInt nsplits; /* Number of field divisions defined */ 3179416396SBarry Smith Vec *x,*y,w1,w2; 32519d70e2SJed Brown Mat *mat; /* The diagonal block for each split */ 33519d70e2SJed Brown Mat *pmat; /* The preconditioning diagonal block for each split */ 3430ad9308SMatthew Knepley Mat *Afield; /* The rows of the matrix associated with each split */ 35ace3abfcSBarry Smith PetscBool issetup; 362fa5cd67SKarl Rupp 3730ad9308SMatthew Knepley /* Only used when Schur complement preconditioning is used */ 3830ad9308SMatthew Knepley Mat B; /* The (0,1) block */ 3930ad9308SMatthew Knepley Mat C; /* The (1,0) block */ 40443836d0SMatthew G Knepley Mat schur; /* The Schur complement S = A11 - A10 A00^{-1} A01, the KSP here, kspinner, is H_1 in [El08] */ 41a7476a74SDmitry Karpeev Mat schurp; /* Assembled approximation to S built by MatSchurComplement to be used as a preconditioning matrix when solving with S */ 42084e4875SJed Brown Mat schur_user; /* User-provided preconditioning matrix for the Schur complement */ 43084e4875SJed Brown PCFieldSplitSchurPreType schurpre; /* Determines which preconditioning matrix is used for the Schur complement */ 44c9c6ffaaSJed Brown PCFieldSplitSchurFactType schurfactorization; 4530ad9308SMatthew Knepley KSP kspschur; /* The solver for S */ 46443836d0SMatthew G Knepley KSP kspupper; /* The solver for A in the upper diagonal part of the factorization (H_2 in [El08]) */ 47c096484dSStefano Zampini PetscScalar schurscale; /* Scaling factor for the Schur complement solution with DIAG factorization */ 48c096484dSStefano Zampini 49a51937d4SCarola Kruse /* Only used when Golub-Kahan bidiagonalization preconditioning is used */ 50a51937d4SCarola Kruse Mat H; /* The modified matrix H = A00 + nu*A01*A01' */ 51a51937d4SCarola Kruse PetscReal gkbtol; /* Stopping tolerance for lower bound estimate */ 52a51937d4SCarola Kruse PetscInt gkbdelay; /* The delay window for the stopping criterion */ 53a51937d4SCarola Kruse PetscReal gkbnu; /* Parameter for augmented Lagrangian H = A + nu*A01*A01' */ 54a51937d4SCarola Kruse PetscInt gkbmaxit; /* Maximum number of iterations for outer loop */ 55de482cd7SCarola Kruse PetscBool gkbmonitor; /* Monitor for gkb iterations and the lower bound error */ 56de482cd7SCarola Kruse PetscViewer gkbviewer; /* Viewer context for gkbmonitor */ 57e071a0a4SCarola Kruse Vec u,v,d,Hu; /* Work vectors for the GKB algorithm */ 58e071a0a4SCarola Kruse PetscScalar *vecz; /* Contains intermediate values, eg for lower bound */ 59a51937d4SCarola Kruse 6097bbdb24SBarry Smith PC_FieldSplitLink head; 616dbb499eSCian Wilson PetscBool isrestrict; /* indicates PCFieldSplitRestrictIS() has been last called on this object, hack */ 62c1570756SJed Brown PetscBool suboptionsset; /* Indicates that the KSPSetFromOptions() has been called on the sub-KSPs */ 634ab8060aSDmitry Karpeev PetscBool dm_splits; /* Whether to use DMCreateFieldDecomposition() whenever possible */ 64c84da90fSDmitry Karpeev PetscBool diag_use_amat; /* Whether to extract diagonal matrix blocks from Amat, rather than Pmat (weaker than -pc_use_amat) */ 65c84da90fSDmitry Karpeev PetscBool offdiag_use_amat; /* Whether to extract off-diagonal matrix blocks from Amat, rather than Pmat (weaker than -pc_use_amat) */ 667b752e3dSPatrick Sanan PetscBool detect; /* Whether to form 2-way split by finding zero diagonal entries */ 670971522cSBarry Smith } PC_FieldSplit; 680971522cSBarry Smith 6916913363SBarry Smith /* 7095452b02SPatrick Sanan Notes: 7195452b02SPatrick Sanan there is no particular reason that pmat, x, and y are stored as arrays in PC_FieldSplit instead of 7216913363SBarry Smith inside PC_FieldSplitLink, just historical. If you want to be able to add new fields after already using the 7316913363SBarry Smith PC you could change this. 7416913363SBarry Smith */ 75084e4875SJed Brown 76e6cab6aaSJed Brown /* This helper is so that setting a user-provided preconditioning matrix is orthogonal to choosing to use it. This way the 77084e4875SJed Brown * application-provided FormJacobian can provide this matrix without interfering with the user's (command-line) choices. */ 78084e4875SJed Brown static Mat FieldSplitSchurPre(PC_FieldSplit *jac) 79084e4875SJed Brown { 80084e4875SJed Brown switch (jac->schurpre) { 81084e4875SJed Brown case PC_FIELDSPLIT_SCHUR_PRE_SELF: return jac->schur; 82a7476a74SDmitry Karpeev case PC_FIELDSPLIT_SCHUR_PRE_SELFP: return jac->schurp; 83e87fab1bSBarry Smith case PC_FIELDSPLIT_SCHUR_PRE_A11: return jac->pmat[1]; 84e74569cdSMatthew G. Knepley case PC_FIELDSPLIT_SCHUR_PRE_FULL: /* We calculate this and store it in schur_user */ 85084e4875SJed Brown case PC_FIELDSPLIT_SCHUR_PRE_USER: /* Use a user-provided matrix if it is given, otherwise diagonal block */ 86084e4875SJed Brown default: 87084e4875SJed Brown return jac->schur_user ? jac->schur_user : jac->pmat[1]; 88084e4875SJed Brown } 89084e4875SJed Brown } 90084e4875SJed Brown 91084e4875SJed Brown 929804daf3SBarry Smith #include <petscdraw.h> 930971522cSBarry Smith static PetscErrorCode PCView_FieldSplit(PC pc,PetscViewer viewer) 940971522cSBarry Smith { 950971522cSBarry Smith PC_FieldSplit *jac = (PC_FieldSplit*)pc->data; 960971522cSBarry Smith PetscErrorCode ierr; 97d9884438SBarry Smith PetscBool iascii,isdraw; 980971522cSBarry Smith PetscInt i,j; 995a9f2f41SSatish Balay PC_FieldSplitLink ilink = jac->head; 1000971522cSBarry Smith 1010971522cSBarry Smith PetscFunctionBegin; 102251f4c67SDmitry Karpeev ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&iascii);CHKERRQ(ierr); 103d9884438SBarry Smith ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERDRAW,&isdraw);CHKERRQ(ierr); 1040971522cSBarry Smith if (iascii) { 1052c9966d7SBarry Smith if (jac->bs > 0) { 10651f519a2SBarry Smith ierr = PetscViewerASCIIPrintf(viewer," FieldSplit with %s composition: total splits = %D, blocksize = %D\n",PCCompositeTypes[jac->type],jac->nsplits,jac->bs);CHKERRQ(ierr); 1072c9966d7SBarry Smith } else { 1082c9966d7SBarry Smith ierr = PetscViewerASCIIPrintf(viewer," FieldSplit with %s composition: total splits = %D\n",PCCompositeTypes[jac->type],jac->nsplits);CHKERRQ(ierr); 1092c9966d7SBarry Smith } 110f5236f50SJed Brown if (pc->useAmat) { 111f5236f50SJed Brown ierr = PetscViewerASCIIPrintf(viewer," using Amat (not Pmat) as operator for blocks\n");CHKERRQ(ierr); 112a3df900dSMatthew G Knepley } 113c84da90fSDmitry Karpeev if (jac->diag_use_amat) { 114c84da90fSDmitry Karpeev ierr = PetscViewerASCIIPrintf(viewer," using Amat (not Pmat) as operator for diagonal blocks\n");CHKERRQ(ierr); 115c84da90fSDmitry Karpeev } 116c84da90fSDmitry Karpeev if (jac->offdiag_use_amat) { 117c84da90fSDmitry Karpeev ierr = PetscViewerASCIIPrintf(viewer," using Amat (not Pmat) as operator for off-diagonal blocks\n");CHKERRQ(ierr); 118c84da90fSDmitry Karpeev } 11969a612a9SBarry Smith ierr = PetscViewerASCIIPrintf(viewer," Solver info for each split is in the following KSP objects:\n");CHKERRQ(ierr); 1200971522cSBarry Smith for (i=0; i<jac->nsplits; i++) { 1211ab39975SBarry Smith if (ilink->fields) { 1220971522cSBarry Smith ierr = PetscViewerASCIIPrintf(viewer,"Split number %D Fields ",i);CHKERRQ(ierr); 12379416396SBarry Smith ierr = PetscViewerASCIIUseTabs(viewer,PETSC_FALSE);CHKERRQ(ierr); 1245a9f2f41SSatish Balay for (j=0; j<ilink->nfields; j++) { 12579416396SBarry Smith if (j > 0) { 12679416396SBarry Smith ierr = PetscViewerASCIIPrintf(viewer,",");CHKERRQ(ierr); 12779416396SBarry Smith } 1285a9f2f41SSatish Balay ierr = PetscViewerASCIIPrintf(viewer," %D",ilink->fields[j]);CHKERRQ(ierr); 1290971522cSBarry Smith } 1300971522cSBarry Smith ierr = PetscViewerASCIIPrintf(viewer,"\n");CHKERRQ(ierr); 13179416396SBarry Smith ierr = PetscViewerASCIIUseTabs(viewer,PETSC_TRUE);CHKERRQ(ierr); 1321ab39975SBarry Smith } else { 1331ab39975SBarry Smith ierr = PetscViewerASCIIPrintf(viewer,"Split number %D Defined by IS\n",i);CHKERRQ(ierr); 1341ab39975SBarry Smith } 1355a9f2f41SSatish Balay ierr = KSPView(ilink->ksp,viewer);CHKERRQ(ierr); 1365a9f2f41SSatish Balay ilink = ilink->next; 1370971522cSBarry Smith } 1382fa5cd67SKarl Rupp } 1392fa5cd67SKarl Rupp 1402fa5cd67SKarl Rupp if (isdraw) { 141d9884438SBarry Smith PetscDraw draw; 142d9884438SBarry Smith PetscReal x,y,w,wd; 143d9884438SBarry Smith 144d9884438SBarry Smith ierr = PetscViewerDrawGetDraw(viewer,0,&draw);CHKERRQ(ierr); 145d9884438SBarry Smith ierr = PetscDrawGetCurrentPoint(draw,&x,&y);CHKERRQ(ierr); 146d9884438SBarry Smith w = 2*PetscMin(1.0 - x,x); 147d9884438SBarry Smith wd = w/(jac->nsplits + 1); 148d9884438SBarry Smith x = x - wd*(jac->nsplits-1)/2.0; 149d9884438SBarry Smith for (i=0; i<jac->nsplits; i++) { 150d9884438SBarry Smith ierr = PetscDrawPushCurrentPoint(draw,x,y);CHKERRQ(ierr); 151d9884438SBarry Smith ierr = KSPView(ilink->ksp,viewer);CHKERRQ(ierr); 152d9884438SBarry Smith ierr = PetscDrawPopCurrentPoint(draw);CHKERRQ(ierr); 153d9884438SBarry Smith x += wd; 154d9884438SBarry Smith ilink = ilink->next; 155d9884438SBarry Smith } 1560971522cSBarry Smith } 1570971522cSBarry Smith PetscFunctionReturn(0); 1580971522cSBarry Smith } 1590971522cSBarry Smith 1603b224e63SBarry Smith static PetscErrorCode PCView_FieldSplit_Schur(PC pc,PetscViewer viewer) 1613b224e63SBarry Smith { 1623b224e63SBarry Smith PC_FieldSplit *jac = (PC_FieldSplit*)pc->data; 1633b224e63SBarry Smith PetscErrorCode ierr; 1644996c5bdSBarry Smith PetscBool iascii,isdraw; 1653b224e63SBarry Smith PetscInt i,j; 1663b224e63SBarry Smith PC_FieldSplitLink ilink = jac->head; 167a9908d51SBarry Smith MatSchurComplementAinvType atype; 1683b224e63SBarry Smith 1693b224e63SBarry Smith PetscFunctionBegin; 170251f4c67SDmitry Karpeev ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&iascii);CHKERRQ(ierr); 1714996c5bdSBarry Smith ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERDRAW,&isdraw);CHKERRQ(ierr); 1723b224e63SBarry Smith if (iascii) { 1732c9966d7SBarry Smith if (jac->bs > 0) { 174c9c6ffaaSJed Brown ierr = PetscViewerASCIIPrintf(viewer," FieldSplit with Schur preconditioner, blocksize = %D, factorization %s\n",jac->bs,PCFieldSplitSchurFactTypes[jac->schurfactorization]);CHKERRQ(ierr); 1752c9966d7SBarry Smith } else { 1762c9966d7SBarry Smith ierr = PetscViewerASCIIPrintf(viewer," FieldSplit with Schur preconditioner, factorization %s\n",PCFieldSplitSchurFactTypes[jac->schurfactorization]);CHKERRQ(ierr); 1772c9966d7SBarry Smith } 178f5236f50SJed Brown if (pc->useAmat) { 179f5236f50SJed Brown ierr = PetscViewerASCIIPrintf(viewer," using Amat (not Pmat) as operator for blocks\n");CHKERRQ(ierr); 180a3df900dSMatthew G Knepley } 1813e8b8b31SMatthew G Knepley switch (jac->schurpre) { 1823e8b8b31SMatthew G Knepley case PC_FIELDSPLIT_SCHUR_PRE_SELF: 183a9908d51SBarry Smith ierr = PetscViewerASCIIPrintf(viewer," Preconditioner for the Schur complement formed from S itself\n");CHKERRQ(ierr); 184a9908d51SBarry Smith break; 185a7476a74SDmitry Karpeev case PC_FIELDSPLIT_SCHUR_PRE_SELFP: 186a9908d51SBarry Smith ierr = MatSchurComplementGetAinvType(jac->schur,&atype);CHKERRQ(ierr); 187d0a9c1a2SBarry Smith ierr = PetscViewerASCIIPrintf(viewer," Preconditioner for the Schur complement formed from Sp, an assembled approximation to S, which uses A00's %sdiagonal's inverse\n",atype == MAT_SCHUR_COMPLEMENT_AINV_DIAG ? "" : (atype == MAT_SCHUR_COMPLEMENT_AINV_BLOCK_DIAG ? "block " : "lumped "));CHKERRQ(ierr);break; 188e87fab1bSBarry Smith case PC_FIELDSPLIT_SCHUR_PRE_A11: 189a9908d51SBarry Smith ierr = PetscViewerASCIIPrintf(viewer," Preconditioner for the Schur complement formed from A11\n");CHKERRQ(ierr); 190a9908d51SBarry Smith break; 191e74569cdSMatthew G. Knepley case PC_FIELDSPLIT_SCHUR_PRE_FULL: 192a9908d51SBarry Smith ierr = PetscViewerASCIIPrintf(viewer," Preconditioner for the Schur complement formed from the exact Schur complement\n");CHKERRQ(ierr); 193a9908d51SBarry Smith break; 1943e8b8b31SMatthew G Knepley case PC_FIELDSPLIT_SCHUR_PRE_USER: 1953e8b8b31SMatthew G Knepley if (jac->schur_user) { 1963e8b8b31SMatthew G Knepley ierr = PetscViewerASCIIPrintf(viewer," Preconditioner for the Schur complement formed from user provided matrix\n");CHKERRQ(ierr); 1973e8b8b31SMatthew G Knepley } else { 198e87fab1bSBarry Smith ierr = PetscViewerASCIIPrintf(viewer," Preconditioner for the Schur complement formed from A11\n");CHKERRQ(ierr); 1993e8b8b31SMatthew G Knepley } 2003e8b8b31SMatthew G Knepley break; 2013e8b8b31SMatthew G Knepley default: 20282f516ccSBarry Smith SETERRQ1(PetscObjectComm((PetscObject)pc), PETSC_ERR_ARG_OUTOFRANGE, "Invalid Schur preconditioning type: %d", jac->schurpre); 2033e8b8b31SMatthew G Knepley } 2043b224e63SBarry Smith ierr = PetscViewerASCIIPrintf(viewer," Split info:\n");CHKERRQ(ierr); 2053b224e63SBarry Smith ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr); 2063b224e63SBarry Smith for (i=0; i<jac->nsplits; i++) { 2073b224e63SBarry Smith if (ilink->fields) { 2083b224e63SBarry Smith ierr = PetscViewerASCIIPrintf(viewer,"Split number %D Fields ",i);CHKERRQ(ierr); 2093b224e63SBarry Smith ierr = PetscViewerASCIIUseTabs(viewer,PETSC_FALSE);CHKERRQ(ierr); 2103b224e63SBarry Smith for (j=0; j<ilink->nfields; j++) { 2113b224e63SBarry Smith if (j > 0) { 2123b224e63SBarry Smith ierr = PetscViewerASCIIPrintf(viewer,",");CHKERRQ(ierr); 2133b224e63SBarry Smith } 2143b224e63SBarry Smith ierr = PetscViewerASCIIPrintf(viewer," %D",ilink->fields[j]);CHKERRQ(ierr); 2153b224e63SBarry Smith } 2163b224e63SBarry Smith ierr = PetscViewerASCIIPrintf(viewer,"\n");CHKERRQ(ierr); 2173b224e63SBarry Smith ierr = PetscViewerASCIIUseTabs(viewer,PETSC_TRUE);CHKERRQ(ierr); 2183b224e63SBarry Smith } else { 2193b224e63SBarry Smith ierr = PetscViewerASCIIPrintf(viewer,"Split number %D Defined by IS\n",i);CHKERRQ(ierr); 2203b224e63SBarry Smith } 2213b224e63SBarry Smith ilink = ilink->next; 2223b224e63SBarry Smith } 223435f959eSBarry Smith ierr = PetscViewerASCIIPrintf(viewer,"KSP solver for A00 block\n");CHKERRQ(ierr); 2243b224e63SBarry Smith ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr); 22506de4afeSJed Brown if (jac->head) { 226443836d0SMatthew G Knepley ierr = KSPView(jac->head->ksp,viewer);CHKERRQ(ierr); 22706de4afeSJed Brown } else {ierr = PetscViewerASCIIPrintf(viewer," not yet available\n");CHKERRQ(ierr);} 2283b224e63SBarry Smith ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr); 22906de4afeSJed Brown if (jac->head && jac->kspupper != jac->head->ksp) { 230443836d0SMatthew G Knepley ierr = PetscViewerASCIIPrintf(viewer,"KSP solver for upper A00 in upper triangular factor \n");CHKERRQ(ierr); 231443836d0SMatthew G Knepley ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr); 232b2750c55SJed Brown if (jac->kspupper) {ierr = KSPView(jac->kspupper,viewer);CHKERRQ(ierr);} 233b2750c55SJed Brown else {ierr = PetscViewerASCIIPrintf(viewer," not yet available\n");CHKERRQ(ierr);} 234443836d0SMatthew G Knepley ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr); 235443836d0SMatthew G Knepley } 236435f959eSBarry Smith ierr = PetscViewerASCIIPrintf(viewer,"KSP solver for S = A11 - A10 inv(A00) A01 \n");CHKERRQ(ierr); 2373b224e63SBarry Smith ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr); 23812cae6f2SJed Brown if (jac->kspschur) { 2393b224e63SBarry Smith ierr = KSPView(jac->kspschur,viewer);CHKERRQ(ierr); 24012cae6f2SJed Brown } else { 24112cae6f2SJed Brown ierr = PetscViewerASCIIPrintf(viewer," not yet available\n");CHKERRQ(ierr); 24212cae6f2SJed Brown } 2433b224e63SBarry Smith ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr); 2443b224e63SBarry Smith ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr); 24506de4afeSJed Brown } else if (isdraw && jac->head) { 2464996c5bdSBarry Smith PetscDraw draw; 2474996c5bdSBarry Smith PetscReal x,y,w,wd,h; 2484996c5bdSBarry Smith PetscInt cnt = 2; 2494996c5bdSBarry Smith char str[32]; 2504996c5bdSBarry Smith 2514996c5bdSBarry Smith ierr = PetscViewerDrawGetDraw(viewer,0,&draw);CHKERRQ(ierr); 2524996c5bdSBarry Smith ierr = PetscDrawGetCurrentPoint(draw,&x,&y);CHKERRQ(ierr); 253c74581afSBarry Smith if (jac->kspupper != jac->head->ksp) cnt++; 254c74581afSBarry Smith w = 2*PetscMin(1.0 - x,x); 255c74581afSBarry Smith wd = w/(cnt + 1); 256c74581afSBarry Smith 2574996c5bdSBarry Smith ierr = PetscSNPrintf(str,32,"Schur fact. %s",PCFieldSplitSchurFactTypes[jac->schurfactorization]);CHKERRQ(ierr); 25851fa3d41SBarry Smith ierr = PetscDrawStringBoxed(draw,x,y,PETSC_DRAW_RED,PETSC_DRAW_BLACK,str,NULL,&h);CHKERRQ(ierr); 2594996c5bdSBarry Smith y -= h; 2604996c5bdSBarry Smith if (jac->schurpre == PC_FIELDSPLIT_SCHUR_PRE_USER && !jac->schur_user) { 261e87fab1bSBarry Smith ierr = PetscSNPrintf(str,32,"Prec. for Schur from %s",PCFieldSplitSchurPreTypes[PC_FIELDSPLIT_SCHUR_PRE_A11]);CHKERRQ(ierr); 2623b224e63SBarry Smith } else { 2634996c5bdSBarry Smith ierr = PetscSNPrintf(str,32,"Prec. for Schur from %s",PCFieldSplitSchurPreTypes[jac->schurpre]);CHKERRQ(ierr); 2644996c5bdSBarry Smith } 26551fa3d41SBarry Smith ierr = PetscDrawStringBoxed(draw,x+wd*(cnt-1)/2.0,y,PETSC_DRAW_RED,PETSC_DRAW_BLACK,str,NULL,&h);CHKERRQ(ierr); 2664996c5bdSBarry Smith y -= h; 2674996c5bdSBarry Smith x = x - wd*(cnt-1)/2.0; 2684996c5bdSBarry Smith 2694996c5bdSBarry Smith ierr = PetscDrawPushCurrentPoint(draw,x,y);CHKERRQ(ierr); 2704996c5bdSBarry Smith ierr = KSPView(jac->head->ksp,viewer);CHKERRQ(ierr); 2714996c5bdSBarry Smith ierr = PetscDrawPopCurrentPoint(draw);CHKERRQ(ierr); 2724996c5bdSBarry Smith if (jac->kspupper != jac->head->ksp) { 2734996c5bdSBarry Smith x += wd; 2744996c5bdSBarry Smith ierr = PetscDrawPushCurrentPoint(draw,x,y);CHKERRQ(ierr); 2754996c5bdSBarry Smith ierr = KSPView(jac->kspupper,viewer);CHKERRQ(ierr); 2764996c5bdSBarry Smith ierr = PetscDrawPopCurrentPoint(draw);CHKERRQ(ierr); 2774996c5bdSBarry Smith } 2784996c5bdSBarry Smith x += wd; 2794996c5bdSBarry Smith ierr = PetscDrawPushCurrentPoint(draw,x,y);CHKERRQ(ierr); 2804996c5bdSBarry Smith ierr = KSPView(jac->kspschur,viewer);CHKERRQ(ierr); 2814996c5bdSBarry Smith ierr = PetscDrawPopCurrentPoint(draw);CHKERRQ(ierr); 2823b224e63SBarry Smith } 2833b224e63SBarry Smith PetscFunctionReturn(0); 2843b224e63SBarry Smith } 2853b224e63SBarry Smith 286a51937d4SCarola Kruse static PetscErrorCode PCView_FieldSplit_GKB(PC pc,PetscViewer viewer) 287a51937d4SCarola Kruse { 288a51937d4SCarola Kruse PC_FieldSplit *jac = (PC_FieldSplit*)pc->data; 289a51937d4SCarola Kruse PetscErrorCode ierr; 290a51937d4SCarola Kruse PetscBool iascii,isdraw; 291a51937d4SCarola Kruse PetscInt i,j; 292a51937d4SCarola Kruse PC_FieldSplitLink ilink = jac->head; 293a51937d4SCarola Kruse 294a51937d4SCarola Kruse PetscFunctionBegin; 295a51937d4SCarola Kruse ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&iascii);CHKERRQ(ierr); 296a51937d4SCarola Kruse ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERDRAW,&isdraw);CHKERRQ(ierr); 297a51937d4SCarola Kruse if (iascii) { 298a51937d4SCarola Kruse if (jac->bs > 0) { 299a51937d4SCarola Kruse ierr = PetscViewerASCIIPrintf(viewer," FieldSplit with %s composition: total splits = %D, blocksize = %D\n",PCCompositeTypes[jac->type],jac->nsplits,jac->bs);CHKERRQ(ierr); 300a51937d4SCarola Kruse } else { 301a51937d4SCarola Kruse ierr = PetscViewerASCIIPrintf(viewer," FieldSplit with %s composition: total splits = %D\n",PCCompositeTypes[jac->type],jac->nsplits);CHKERRQ(ierr); 302a51937d4SCarola Kruse } 303a51937d4SCarola Kruse if (pc->useAmat) { 304a51937d4SCarola Kruse ierr = PetscViewerASCIIPrintf(viewer," using Amat (not Pmat) as operator for blocks\n");CHKERRQ(ierr); 305a51937d4SCarola Kruse } 306a51937d4SCarola Kruse if (jac->diag_use_amat) { 307a51937d4SCarola Kruse ierr = PetscViewerASCIIPrintf(viewer," using Amat (not Pmat) as operator for diagonal blocks\n");CHKERRQ(ierr); 308a51937d4SCarola Kruse } 309a51937d4SCarola Kruse if (jac->offdiag_use_amat) { 310a51937d4SCarola Kruse ierr = PetscViewerASCIIPrintf(viewer," using Amat (not Pmat) as operator for off-diagonal blocks\n");CHKERRQ(ierr); 311a51937d4SCarola Kruse } 312a51937d4SCarola Kruse 313a51937d4SCarola Kruse ierr = PetscViewerASCIIPrintf(viewer," Stopping tolerance=%.1e, delay in error estimate=%D, maximum iterations=%D\n",jac->gkbtol,jac->gkbdelay,jac->gkbmaxit);CHKERRQ(ierr); 314a51937d4SCarola Kruse ierr = PetscViewerASCIIPrintf(viewer," Solver info for H = A00 + nu*A01*A01' matrix:\n");CHKERRQ(ierr); 315a51937d4SCarola Kruse ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr); 316a51937d4SCarola Kruse 317a51937d4SCarola Kruse if (ilink->fields) { 318a51937d4SCarola Kruse ierr = PetscViewerASCIIPrintf(viewer,"Split number %D Fields ",0);CHKERRQ(ierr); 319a51937d4SCarola Kruse ierr = PetscViewerASCIIUseTabs(viewer,PETSC_FALSE);CHKERRQ(ierr); 320a51937d4SCarola Kruse for (j=0; j<ilink->nfields; j++) { 321a51937d4SCarola Kruse if (j > 0) { 322a51937d4SCarola Kruse ierr = PetscViewerASCIIPrintf(viewer,",");CHKERRQ(ierr); 323a51937d4SCarola Kruse } 324a51937d4SCarola Kruse ierr = PetscViewerASCIIPrintf(viewer," %D",ilink->fields[j]);CHKERRQ(ierr); 325a51937d4SCarola Kruse } 326a51937d4SCarola Kruse ierr = PetscViewerASCIIPrintf(viewer,"\n");CHKERRQ(ierr); 327a51937d4SCarola Kruse ierr = PetscViewerASCIIUseTabs(viewer,PETSC_TRUE);CHKERRQ(ierr); 328a51937d4SCarola Kruse } else { 329a51937d4SCarola Kruse ierr = PetscViewerASCIIPrintf(viewer,"Split number %D Defined by IS\n",0);CHKERRQ(ierr); 330a51937d4SCarola Kruse } 331a51937d4SCarola Kruse ierr = KSPView(ilink->ksp,viewer);CHKERRQ(ierr); 332a51937d4SCarola Kruse 333a51937d4SCarola Kruse ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr); 334a51937d4SCarola Kruse } 335a51937d4SCarola Kruse 336a51937d4SCarola Kruse if (isdraw) { 337a51937d4SCarola Kruse PetscDraw draw; 338a51937d4SCarola Kruse PetscReal x,y,w,wd; 339a51937d4SCarola Kruse 340a51937d4SCarola Kruse ierr = PetscViewerDrawGetDraw(viewer,0,&draw);CHKERRQ(ierr); 341a51937d4SCarola Kruse ierr = PetscDrawGetCurrentPoint(draw,&x,&y);CHKERRQ(ierr); 342a51937d4SCarola Kruse w = 2*PetscMin(1.0 - x,x); 343a51937d4SCarola Kruse wd = w/(jac->nsplits + 1); 344a51937d4SCarola Kruse x = x - wd*(jac->nsplits-1)/2.0; 345a51937d4SCarola Kruse for (i=0; i<jac->nsplits; i++) { 346a51937d4SCarola Kruse ierr = PetscDrawPushCurrentPoint(draw,x,y);CHKERRQ(ierr); 347a51937d4SCarola Kruse ierr = KSPView(ilink->ksp,viewer);CHKERRQ(ierr); 348a51937d4SCarola Kruse ierr = PetscDrawPopCurrentPoint(draw);CHKERRQ(ierr); 349a51937d4SCarola Kruse x += wd; 350a51937d4SCarola Kruse ilink = ilink->next; 351a51937d4SCarola Kruse } 352a51937d4SCarola Kruse } 353a51937d4SCarola Kruse PetscFunctionReturn(0); 354a51937d4SCarola Kruse } 355a51937d4SCarola Kruse 356a51937d4SCarola Kruse 3576c924f48SJed Brown /* Precondition: jac->bs is set to a meaningful value */ 3586c924f48SJed Brown static PetscErrorCode PCFieldSplitSetRuntimeSplits_Private(PC pc) 3596c924f48SJed Brown { 3606c924f48SJed Brown PetscErrorCode ierr; 3616c924f48SJed Brown PC_FieldSplit *jac = (PC_FieldSplit*)pc->data; 3625d4c12cdSJungho Lee PetscInt i,nfields,*ifields,nfields_col,*ifields_col; 3635d4c12cdSJungho Lee PetscBool flg,flg_col; 3645d4c12cdSJungho Lee char optionname[128],splitname[8],optionname_col[128]; 3656c924f48SJed Brown 3666c924f48SJed Brown PetscFunctionBegin; 367785e854fSJed Brown ierr = PetscMalloc1(jac->bs,&ifields);CHKERRQ(ierr); 368785e854fSJed Brown ierr = PetscMalloc1(jac->bs,&ifields_col);CHKERRQ(ierr); 3696c924f48SJed Brown for (i=0,flg=PETSC_TRUE;; i++) { 3708caf3d72SBarry Smith ierr = PetscSNPrintf(splitname,sizeof(splitname),"%D",i);CHKERRQ(ierr); 3718caf3d72SBarry Smith ierr = PetscSNPrintf(optionname,sizeof(optionname),"-pc_fieldsplit_%D_fields",i);CHKERRQ(ierr); 3728caf3d72SBarry Smith ierr = PetscSNPrintf(optionname_col,sizeof(optionname_col),"-pc_fieldsplit_%D_fields_col",i);CHKERRQ(ierr); 3736c924f48SJed Brown nfields = jac->bs; 37429499fbbSJungho Lee nfields_col = jac->bs; 375c5929fdfSBarry Smith ierr = PetscOptionsGetIntArray(((PetscObject)pc)->options,((PetscObject)pc)->prefix,optionname,ifields,&nfields,&flg);CHKERRQ(ierr); 376c5929fdfSBarry Smith ierr = PetscOptionsGetIntArray(((PetscObject)pc)->options,((PetscObject)pc)->prefix,optionname_col,ifields_col,&nfields_col,&flg_col);CHKERRQ(ierr); 3776c924f48SJed Brown if (!flg) break; 3785d4c12cdSJungho Lee else if (flg && !flg_col) { 3795d4c12cdSJungho Lee if (!nfields) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_USER,"Cannot list zero fields"); 3805d4c12cdSJungho Lee ierr = PCFieldSplitSetFields(pc,splitname,nfields,ifields,ifields);CHKERRQ(ierr); 3812fa5cd67SKarl Rupp } else { 3825d4c12cdSJungho Lee if (!nfields || !nfields_col) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_USER,"Cannot list zero fields"); 3835d4c12cdSJungho Lee if (nfields != nfields_col) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_USER,"Number of row and column fields must match"); 3845d4c12cdSJungho Lee ierr = PCFieldSplitSetFields(pc,splitname,nfields,ifields,ifields_col);CHKERRQ(ierr); 3855d4c12cdSJungho Lee } 3866c924f48SJed Brown } 3876c924f48SJed Brown if (i > 0) { 3886c924f48SJed Brown /* Makes command-line setting of splits take precedence over setting them in code. 3896c924f48SJed Brown Otherwise subsequent calls to PCFieldSplitSetIS() or PCFieldSplitSetFields() would 3906c924f48SJed Brown create new splits, which would probably not be what the user wanted. */ 3916c924f48SJed Brown jac->splitdefined = PETSC_TRUE; 3926c924f48SJed Brown } 3936c924f48SJed Brown ierr = PetscFree(ifields);CHKERRQ(ierr); 3945d4c12cdSJungho Lee ierr = PetscFree(ifields_col);CHKERRQ(ierr); 3956c924f48SJed Brown PetscFunctionReturn(0); 3966c924f48SJed Brown } 3976c924f48SJed Brown 39869a612a9SBarry Smith static PetscErrorCode PCFieldSplitSetDefaults(PC pc) 3990971522cSBarry Smith { 4000971522cSBarry Smith PC_FieldSplit *jac = (PC_FieldSplit*)pc->data; 4010971522cSBarry Smith PetscErrorCode ierr; 4025a9f2f41SSatish Balay PC_FieldSplitLink ilink = jac->head; 4037b752e3dSPatrick Sanan PetscBool fieldsplit_default = PETSC_FALSE,coupling = PETSC_FALSE; 4046c924f48SJed Brown PetscInt i; 4050971522cSBarry Smith 4060971522cSBarry Smith PetscFunctionBegin; 4077287d2a3SDmitry Karpeev /* 408f5f0d762SBarry Smith Kinda messy, but at least this now uses DMCreateFieldDecomposition(). 4097287d2a3SDmitry Karpeev Should probably be rewritten. 4107287d2a3SDmitry Karpeev */ 411f5f0d762SBarry Smith if (!ilink) { 412c5929fdfSBarry Smith ierr = PetscOptionsGetBool(((PetscObject)pc)->options,((PetscObject)pc)->prefix,"-pc_fieldsplit_detect_coupling",&coupling,NULL);CHKERRQ(ierr); 4137b752e3dSPatrick Sanan if (pc->dm && jac->dm_splits && !jac->detect && !coupling) { 414bafc1b83SMatthew G Knepley PetscInt numFields, f, i, j; 4150784a22cSJed Brown char **fieldNames; 4167b62db95SJungho Lee IS *fields; 417e7c4fc90SDmitry Karpeev DM *dms; 418bafc1b83SMatthew G Knepley DM subdm[128]; 419bafc1b83SMatthew G Knepley PetscBool flg; 420bafc1b83SMatthew G Knepley 42116621825SDmitry Karpeev ierr = DMCreateFieldDecomposition(pc->dm, &numFields, &fieldNames, &fields, &dms);CHKERRQ(ierr); 422bafc1b83SMatthew G Knepley /* Allow the user to prescribe the splits */ 423bafc1b83SMatthew G Knepley for (i = 0, flg = PETSC_TRUE;; i++) { 424bafc1b83SMatthew G Knepley PetscInt ifields[128]; 425bafc1b83SMatthew G Knepley IS compField; 426bafc1b83SMatthew G Knepley char optionname[128], splitname[8]; 427bafc1b83SMatthew G Knepley PetscInt nfields = numFields; 428bafc1b83SMatthew G Knepley 4298caf3d72SBarry Smith ierr = PetscSNPrintf(optionname, sizeof(optionname), "-pc_fieldsplit_%D_fields", i);CHKERRQ(ierr); 430c5929fdfSBarry Smith ierr = PetscOptionsGetIntArray(((PetscObject)pc)->options,((PetscObject)pc)->prefix, optionname, ifields, &nfields, &flg);CHKERRQ(ierr); 431bafc1b83SMatthew G Knepley if (!flg) break; 43282f516ccSBarry Smith if (numFields > 128) SETERRQ1(PetscObjectComm((PetscObject)pc),PETSC_ERR_SUP,"Cannot currently support %d > 128 fields", numFields); 433bafc1b83SMatthew G Knepley ierr = DMCreateSubDM(pc->dm, nfields, ifields, &compField, &subdm[i]);CHKERRQ(ierr); 434bafc1b83SMatthew G Knepley if (nfields == 1) { 435bafc1b83SMatthew G Knepley ierr = PCFieldSplitSetIS(pc, fieldNames[ifields[0]], compField);CHKERRQ(ierr); 436bafc1b83SMatthew G Knepley } else { 4378caf3d72SBarry Smith ierr = PetscSNPrintf(splitname, sizeof(splitname), "%D", i);CHKERRQ(ierr); 438bafc1b83SMatthew G Knepley ierr = PCFieldSplitSetIS(pc, splitname, compField);CHKERRQ(ierr); 4397287d2a3SDmitry Karpeev } 440bafc1b83SMatthew G Knepley ierr = ISDestroy(&compField);CHKERRQ(ierr); 441bafc1b83SMatthew G Knepley for (j = 0; j < nfields; ++j) { 442bafc1b83SMatthew G Knepley f = ifields[j]; 4437b62db95SJungho Lee ierr = PetscFree(fieldNames[f]);CHKERRQ(ierr); 4447b62db95SJungho Lee ierr = ISDestroy(&fields[f]);CHKERRQ(ierr); 4457b62db95SJungho Lee } 446bafc1b83SMatthew G Knepley } 447bafc1b83SMatthew G Knepley if (i == 0) { 448bafc1b83SMatthew G Knepley for (f = 0; f < numFields; ++f) { 449bafc1b83SMatthew G Knepley ierr = PCFieldSplitSetIS(pc, fieldNames[f], fields[f]);CHKERRQ(ierr); 450bafc1b83SMatthew G Knepley ierr = PetscFree(fieldNames[f]);CHKERRQ(ierr); 451bafc1b83SMatthew G Knepley ierr = ISDestroy(&fields[f]);CHKERRQ(ierr); 452bafc1b83SMatthew G Knepley } 453bafc1b83SMatthew G Knepley } else { 454d724dfffSBarry Smith for (j=0; j<numFields; j++) { 455d724dfffSBarry Smith ierr = DMDestroy(dms+j);CHKERRQ(ierr); 456d724dfffSBarry Smith } 457d724dfffSBarry Smith ierr = PetscFree(dms);CHKERRQ(ierr); 458785e854fSJed Brown ierr = PetscMalloc1(i, &dms);CHKERRQ(ierr); 4592fa5cd67SKarl Rupp for (j = 0; j < i; ++j) dms[j] = subdm[j]; 460bafc1b83SMatthew G Knepley } 4617b62db95SJungho Lee ierr = PetscFree(fieldNames);CHKERRQ(ierr); 4627b62db95SJungho Lee ierr = PetscFree(fields);CHKERRQ(ierr); 463e7c4fc90SDmitry Karpeev if (dms) { 4648b8307b2SJed Brown ierr = PetscInfo(pc, "Setting up physics based fieldsplit preconditioner using the embedded DM\n");CHKERRQ(ierr); 465bafc1b83SMatthew G Knepley for (ilink = jac->head, i = 0; ilink; ilink = ilink->next, ++i) { 4667287d2a3SDmitry Karpeev const char *prefix; 4677287d2a3SDmitry Karpeev ierr = PetscObjectGetOptionsPrefix((PetscObject)(ilink->ksp),&prefix);CHKERRQ(ierr); 4687287d2a3SDmitry Karpeev ierr = PetscObjectSetOptionsPrefix((PetscObject)(dms[i]), prefix);CHKERRQ(ierr); 4697b62db95SJungho Lee ierr = KSPSetDM(ilink->ksp, dms[i]);CHKERRQ(ierr); 4707b62db95SJungho Lee ierr = KSPSetDMActive(ilink->ksp, PETSC_FALSE);CHKERRQ(ierr); 4717287d2a3SDmitry Karpeev ierr = PetscObjectIncrementTabLevel((PetscObject)dms[i],(PetscObject)ilink->ksp,0);CHKERRQ(ierr); 472e7c4fc90SDmitry Karpeev ierr = DMDestroy(&dms[i]);CHKERRQ(ierr); 4732fa5ba8aSJed Brown } 4747b62db95SJungho Lee ierr = PetscFree(dms);CHKERRQ(ierr); 4758b8307b2SJed Brown } 47666ffff09SJed Brown } else { 477521d7252SBarry Smith if (jac->bs <= 0) { 478704ba839SBarry Smith if (pc->pmat) { 479521d7252SBarry Smith ierr = MatGetBlockSize(pc->pmat,&jac->bs);CHKERRQ(ierr); 4802fa5cd67SKarl Rupp } else jac->bs = 1; 481521d7252SBarry Smith } 482d32f9abdSBarry Smith 4837b752e3dSPatrick Sanan if (jac->detect) { 4846ce1633cSBarry Smith IS zerodiags,rest; 4856ce1633cSBarry Smith PetscInt nmin,nmax; 4866ce1633cSBarry Smith 4876ce1633cSBarry Smith ierr = MatGetOwnershipRange(pc->mat,&nmin,&nmax);CHKERRQ(ierr); 4886ce1633cSBarry Smith ierr = MatFindZeroDiagonals(pc->mat,&zerodiags);CHKERRQ(ierr); 4896ce1633cSBarry Smith ierr = ISComplement(zerodiags,nmin,nmax,&rest);CHKERRQ(ierr); 4906ce1633cSBarry Smith ierr = PCFieldSplitSetIS(pc,"0",rest);CHKERRQ(ierr); 4916ce1633cSBarry Smith ierr = PCFieldSplitSetIS(pc,"1",zerodiags);CHKERRQ(ierr); 492fcfd50ebSBarry Smith ierr = ISDestroy(&zerodiags);CHKERRQ(ierr); 493fcfd50ebSBarry Smith ierr = ISDestroy(&rest);CHKERRQ(ierr); 4943a062f41SBarry Smith } else if (coupling) { 4953a062f41SBarry Smith IS coupling,rest; 4963a062f41SBarry Smith PetscInt nmin,nmax; 4973a062f41SBarry Smith 4983a062f41SBarry Smith ierr = MatGetOwnershipRange(pc->mat,&nmin,&nmax);CHKERRQ(ierr); 4993a062f41SBarry Smith ierr = MatFindOffBlockDiagonalEntries(pc->mat,&coupling);CHKERRQ(ierr); 5006bea0878SBarry Smith ierr = ISCreateStride(PetscObjectComm((PetscObject)pc->mat),nmax-nmin,nmin,1,&rest);CHKERRQ(ierr); 501e52d2c62SBarry Smith ierr = ISSetIdentity(rest);CHKERRQ(ierr); 502d020c841SBarry Smith ierr = PCFieldSplitSetIS(pc,"0",rest);CHKERRQ(ierr); 503d020c841SBarry Smith ierr = PCFieldSplitSetIS(pc,"1",coupling);CHKERRQ(ierr); 5043a062f41SBarry Smith ierr = ISDestroy(&coupling);CHKERRQ(ierr); 5053a062f41SBarry Smith ierr = ISDestroy(&rest);CHKERRQ(ierr); 5066ce1633cSBarry Smith } else { 507c5929fdfSBarry Smith ierr = PetscOptionsGetBool(((PetscObject)pc)->options,((PetscObject)pc)->prefix,"-pc_fieldsplit_default",&fieldsplit_default,NULL);CHKERRQ(ierr); 5087287d2a3SDmitry Karpeev if (!fieldsplit_default) { 509d32f9abdSBarry Smith /* Allow user to set fields from command line, if bs was known at the time of PCSetFromOptions_FieldSplit() 510d32f9abdSBarry Smith then it is set there. This is not ideal because we should only have options set in XXSetFromOptions(). */ 5116c924f48SJed Brown ierr = PCFieldSplitSetRuntimeSplits_Private(pc);CHKERRQ(ierr); 5126c924f48SJed Brown if (jac->splitdefined) {ierr = PetscInfo(pc,"Splits defined using the options database\n");CHKERRQ(ierr);} 513d32f9abdSBarry Smith } 5146dbb499eSCian Wilson if ((fieldsplit_default || !jac->splitdefined) && !jac->isrestrict) { 515d32f9abdSBarry Smith ierr = PetscInfo(pc,"Using default splitting of fields\n");CHKERRQ(ierr); 516db4c96c1SJed Brown for (i=0; i<jac->bs; i++) { 5176c924f48SJed Brown char splitname[8]; 5188caf3d72SBarry Smith ierr = PetscSNPrintf(splitname,sizeof(splitname),"%D",i);CHKERRQ(ierr); 5195d4c12cdSJungho Lee ierr = PCFieldSplitSetFields(pc,splitname,1,&i,&i);CHKERRQ(ierr); 52079416396SBarry Smith } 5215d4c12cdSJungho Lee jac->defaultsplit = PETSC_TRUE; 522521d7252SBarry Smith } 52366ffff09SJed Brown } 5246ce1633cSBarry Smith } 525edf189efSBarry Smith } else if (jac->nsplits == 1) { 526edf189efSBarry Smith if (ilink->is) { 527edf189efSBarry Smith IS is2; 528edf189efSBarry Smith PetscInt nmin,nmax; 529edf189efSBarry Smith 530edf189efSBarry Smith ierr = MatGetOwnershipRange(pc->mat,&nmin,&nmax);CHKERRQ(ierr); 531edf189efSBarry Smith ierr = ISComplement(ilink->is,nmin,nmax,&is2);CHKERRQ(ierr); 532db4c96c1SJed Brown ierr = PCFieldSplitSetIS(pc,"1",is2);CHKERRQ(ierr); 533fcfd50ebSBarry Smith ierr = ISDestroy(&is2);CHKERRQ(ierr); 53482f516ccSBarry Smith } else SETERRQ(PetscObjectComm((PetscObject)pc),PETSC_ERR_SUP,"Must provide at least two sets of fields to PCFieldSplit()"); 535edf189efSBarry Smith } 536d0af7cd3SBarry Smith 53782f516ccSBarry Smith if (jac->nsplits < 2) SETERRQ1(PetscObjectComm((PetscObject)pc),PETSC_ERR_PLIB,"Unhandled case, must have at least two fields, not %d", jac->nsplits); 53869a612a9SBarry Smith PetscFunctionReturn(0); 53969a612a9SBarry Smith } 54069a612a9SBarry Smith 541a51937d4SCarola Kruse static PetscErrorCode MatGolubKahanComputeExplicitOperator(Mat A,Mat B,Mat C,Mat *H,PetscReal gkbnu) 542a51937d4SCarola Kruse { 543a51937d4SCarola Kruse PetscErrorCode ierr; 544a51937d4SCarola Kruse Mat BT,T; 545de482cd7SCarola Kruse PetscReal nrmT,nrmB; 546a51937d4SCarola Kruse 547a51937d4SCarola Kruse PetscFunctionBegin; 548a51937d4SCarola Kruse ierr = MatHermitianTranspose(C,MAT_INITIAL_MATRIX,&T);CHKERRQ(ierr); /* Test if augmented matrix is symmetric */ 549a51937d4SCarola Kruse ierr = MatAXPY(T,-1.0,B,DIFFERENT_NONZERO_PATTERN);CHKERRQ(ierr); 550de482cd7SCarola Kruse ierr = MatNorm(T,NORM_1,&nrmT);CHKERRQ(ierr); 551de482cd7SCarola Kruse ierr = MatNorm(B,NORM_1,&nrmB);CHKERRQ(ierr); 552de482cd7SCarola Kruse if (nrmB > 0) { 553de482cd7SCarola Kruse if (nrmT/nrmB >= PETSC_SMALL) { 554de482cd7SCarola Kruse SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Matrix is not symmetric/hermitian, GKB is not applicable."); 555de482cd7SCarola Kruse } 556a51937d4SCarola Kruse } 557a51937d4SCarola Kruse /* Compute augmented Lagrangian matrix H = A00 + nu*A01*A01'. This corresponds to */ 558a51937d4SCarola Kruse /* setting N := 1/nu*I in [Ar13]. */ 559a51937d4SCarola Kruse ierr = MatHermitianTranspose(B,MAT_INITIAL_MATRIX,&BT);CHKERRQ(ierr); 560a51937d4SCarola Kruse ierr = MatMatMult(B,BT,MAT_INITIAL_MATRIX,PETSC_DEFAULT,H);CHKERRQ(ierr); /* H = A01*A01' */ 561a51937d4SCarola Kruse ierr = MatAYPX(*H,gkbnu,A,DIFFERENT_NONZERO_PATTERN);CHKERRQ(ierr); /* H = A00 + nu*A01*A01' */ 562a51937d4SCarola Kruse 563a51937d4SCarola Kruse ierr = MatDestroy(&BT);CHKERRQ(ierr); 564a51937d4SCarola Kruse ierr = MatDestroy(&T);CHKERRQ(ierr); 565a51937d4SCarola Kruse PetscFunctionReturn(0); 566a51937d4SCarola Kruse } 567a51937d4SCarola Kruse 5682d747510SLisandro Dalcin PETSC_EXTERN PetscErrorCode PetscOptionsFindPairPrefix_Private(PetscOptions,const char pre[], const char name[],const char *value[],PetscBool *flg); 569514bf10dSMatthew G Knepley 57069a612a9SBarry Smith static PetscErrorCode PCSetUp_FieldSplit(PC pc) 57169a612a9SBarry Smith { 57269a612a9SBarry Smith PC_FieldSplit *jac = (PC_FieldSplit*)pc->data; 57369a612a9SBarry Smith PetscErrorCode ierr; 5745a9f2f41SSatish Balay PC_FieldSplitLink ilink; 5752c9966d7SBarry Smith PetscInt i,nsplit; 5765f4ab4e1SJungho Lee PetscBool sorted, sorted_col; 57769a612a9SBarry Smith 57869a612a9SBarry Smith PetscFunctionBegin; 57969a612a9SBarry Smith ierr = PCFieldSplitSetDefaults(pc);CHKERRQ(ierr); 58097bbdb24SBarry Smith nsplit = jac->nsplits; 5815a9f2f41SSatish Balay ilink = jac->head; 58297bbdb24SBarry Smith 58397bbdb24SBarry Smith /* get the matrices for each split */ 584704ba839SBarry Smith if (!jac->issetup) { 5851b9fc7fcSBarry Smith PetscInt rstart,rend,nslots,bs; 58697bbdb24SBarry Smith 587704ba839SBarry Smith jac->issetup = PETSC_TRUE; 588704ba839SBarry Smith 5895d4c12cdSJungho Lee /* This is done here instead of in PCFieldSplitSetFields() because may not have matrix at that point */ 5902c9966d7SBarry Smith if (jac->defaultsplit || !ilink->is) { 5912c9966d7SBarry Smith if (jac->bs <= 0) jac->bs = nsplit; 5922c9966d7SBarry Smith } 59351f519a2SBarry Smith bs = jac->bs; 59497bbdb24SBarry Smith ierr = MatGetOwnershipRange(pc->pmat,&rstart,&rend);CHKERRQ(ierr); 5951b9fc7fcSBarry Smith nslots = (rend - rstart)/bs; 5961b9fc7fcSBarry Smith for (i=0; i<nsplit; i++) { 5971b9fc7fcSBarry Smith if (jac->defaultsplit) { 598ce94432eSBarry Smith ierr = ISCreateStride(PetscObjectComm((PetscObject)pc),nslots,rstart+i,nsplit,&ilink->is);CHKERRQ(ierr); 5995f4ab4e1SJungho Lee ierr = ISDuplicate(ilink->is,&ilink->is_col);CHKERRQ(ierr); 600704ba839SBarry Smith } else if (!ilink->is) { 601ccb205f8SBarry Smith if (ilink->nfields > 1) { 6025f4ab4e1SJungho Lee PetscInt *ii,*jj,j,k,nfields = ilink->nfields,*fields = ilink->fields,*fields_col = ilink->fields_col; 603785e854fSJed Brown ierr = PetscMalloc1(ilink->nfields*nslots,&ii);CHKERRQ(ierr); 604785e854fSJed Brown ierr = PetscMalloc1(ilink->nfields*nslots,&jj);CHKERRQ(ierr); 6051b9fc7fcSBarry Smith for (j=0; j<nslots; j++) { 6061b9fc7fcSBarry Smith for (k=0; k<nfields; k++) { 6071b9fc7fcSBarry Smith ii[nfields*j + k] = rstart + bs*j + fields[k]; 6085f4ab4e1SJungho Lee jj[nfields*j + k] = rstart + bs*j + fields_col[k]; 60997bbdb24SBarry Smith } 61097bbdb24SBarry Smith } 611ce94432eSBarry Smith ierr = ISCreateGeneral(PetscObjectComm((PetscObject)pc),nslots*nfields,ii,PETSC_OWN_POINTER,&ilink->is);CHKERRQ(ierr); 612ce94432eSBarry Smith ierr = ISCreateGeneral(PetscObjectComm((PetscObject)pc),nslots*nfields,jj,PETSC_OWN_POINTER,&ilink->is_col);CHKERRQ(ierr); 61390e68f20SPatrick Farrell ierr = ISSetBlockSize(ilink->is, nfields);CHKERRQ(ierr); 61490e68f20SPatrick Farrell ierr = ISSetBlockSize(ilink->is_col, nfields);CHKERRQ(ierr); 615ccb205f8SBarry Smith } else { 616ce94432eSBarry Smith ierr = ISCreateStride(PetscObjectComm((PetscObject)pc),nslots,rstart+ilink->fields[0],bs,&ilink->is);CHKERRQ(ierr); 617ce94432eSBarry Smith ierr = ISCreateStride(PetscObjectComm((PetscObject)pc),nslots,rstart+ilink->fields_col[0],bs,&ilink->is_col);CHKERRQ(ierr); 618ccb205f8SBarry Smith } 6193e197d65SBarry Smith } 620704ba839SBarry Smith ierr = ISSorted(ilink->is,&sorted);CHKERRQ(ierr); 6215f4ab4e1SJungho Lee if (ilink->is_col) { ierr = ISSorted(ilink->is_col,&sorted_col);CHKERRQ(ierr); } 6225f4ab4e1SJungho Lee if (!sorted || !sorted_col) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_USER,"Fields must be sorted when creating split"); 623704ba839SBarry Smith ilink = ilink->next; 6241b9fc7fcSBarry Smith } 6251b9fc7fcSBarry Smith } 6261b9fc7fcSBarry Smith 627704ba839SBarry Smith ilink = jac->head; 62897bbdb24SBarry Smith if (!jac->pmat) { 629bdddcaaaSMatthew G Knepley Vec xtmp; 630bdddcaaaSMatthew G Knepley 6312a7a6963SBarry Smith ierr = MatCreateVecs(pc->pmat,&xtmp,NULL);CHKERRQ(ierr); 632785e854fSJed Brown ierr = PetscMalloc1(nsplit,&jac->pmat);CHKERRQ(ierr); 633dcca6d9dSJed Brown ierr = PetscMalloc2(nsplit,&jac->x,nsplit,&jac->y);CHKERRQ(ierr); 634cf502942SBarry Smith for (i=0; i<nsplit; i++) { 635bdddcaaaSMatthew G Knepley MatNullSpace sp; 636bdddcaaaSMatthew G Knepley 637a3df900dSMatthew G Knepley /* Check for preconditioning matrix attached to IS */ 638a3df900dSMatthew G Knepley ierr = PetscObjectQuery((PetscObject) ilink->is, "pmat", (PetscObject*) &jac->pmat[i]);CHKERRQ(ierr); 639a3df900dSMatthew G Knepley if (jac->pmat[i]) { 640a3df900dSMatthew G Knepley ierr = PetscObjectReference((PetscObject) jac->pmat[i]);CHKERRQ(ierr); 641a3df900dSMatthew G Knepley if (jac->type == PC_COMPOSITE_SCHUR) { 642a3df900dSMatthew G Knepley jac->schur_user = jac->pmat[i]; 6432fa5cd67SKarl Rupp 644a3df900dSMatthew G Knepley ierr = PetscObjectReference((PetscObject) jac->schur_user);CHKERRQ(ierr); 645a3df900dSMatthew G Knepley } 646a3df900dSMatthew G Knepley } else { 6473a062f41SBarry Smith const char *prefix; 6487dae84e0SHong Zhang ierr = MatCreateSubMatrix(pc->pmat,ilink->is,ilink->is_col,MAT_INITIAL_MATRIX,&jac->pmat[i]);CHKERRQ(ierr); 6493a062f41SBarry Smith ierr = KSPGetOptionsPrefix(ilink->ksp,&prefix);CHKERRQ(ierr); 6503a062f41SBarry Smith ierr = MatSetOptionsPrefix(jac->pmat[i],prefix);CHKERRQ(ierr); 6513a062f41SBarry Smith ierr = MatViewFromOptions(jac->pmat[i],NULL,"-mat_view");CHKERRQ(ierr); 652a3df900dSMatthew G Knepley } 653bdddcaaaSMatthew G Knepley /* create work vectors for each split */ 6542a7a6963SBarry Smith ierr = MatCreateVecs(jac->pmat[i],&jac->x[i],&jac->y[i]);CHKERRQ(ierr); 6550298fd71SBarry Smith ilink->x = jac->x[i]; ilink->y = jac->y[i]; ilink->z = NULL; 656bdddcaaaSMatthew G Knepley /* compute scatter contexts needed by multiplicative versions and non-default splits */ 65735928de7SBarry Smith ierr = VecScatterCreateWithData(xtmp,ilink->is,jac->x[i],NULL,&ilink->sctx);CHKERRQ(ierr); 658ed1f0337SMatthew G Knepley ierr = PetscObjectQuery((PetscObject) ilink->is, "nearnullspace", (PetscObject*) &sp);CHKERRQ(ierr); 659ed1f0337SMatthew G Knepley if (sp) { 660ed1f0337SMatthew G Knepley ierr = MatSetNearNullSpace(jac->pmat[i], sp);CHKERRQ(ierr); 661ed1f0337SMatthew G Knepley } 662704ba839SBarry Smith ilink = ilink->next; 663cf502942SBarry Smith } 664bdddcaaaSMatthew G Knepley ierr = VecDestroy(&xtmp);CHKERRQ(ierr); 66597bbdb24SBarry Smith } else { 666ef7efd37SHong Zhang MatReuse scall; 667ef7efd37SHong Zhang if (pc->flag == DIFFERENT_NONZERO_PATTERN) { 668ef7efd37SHong Zhang for (i=0; i<nsplit; i++) { 669ef7efd37SHong Zhang ierr = MatDestroy(&jac->pmat[i]);CHKERRQ(ierr); 670ef7efd37SHong Zhang } 671ef7efd37SHong Zhang scall = MAT_INITIAL_MATRIX; 672ef7efd37SHong Zhang } else scall = MAT_REUSE_MATRIX; 673ef7efd37SHong Zhang 674cf502942SBarry Smith for (i=0; i<nsplit; i++) { 675a3df900dSMatthew G Knepley Mat pmat; 676a3df900dSMatthew G Knepley 677a3df900dSMatthew G Knepley /* Check for preconditioning matrix attached to IS */ 678a3df900dSMatthew G Knepley ierr = PetscObjectQuery((PetscObject) ilink->is, "pmat", (PetscObject*) &pmat);CHKERRQ(ierr); 679a3df900dSMatthew G Knepley if (!pmat) { 680ef7efd37SHong Zhang ierr = MatCreateSubMatrix(pc->pmat,ilink->is,ilink->is_col,scall,&jac->pmat[i]);CHKERRQ(ierr); 681a3df900dSMatthew G Knepley } 682704ba839SBarry Smith ilink = ilink->next; 683cf502942SBarry Smith } 68497bbdb24SBarry Smith } 6854e39094bSDmitry Karpeev if (jac->diag_use_amat) { 686519d70e2SJed Brown ilink = jac->head; 687519d70e2SJed Brown if (!jac->mat) { 688785e854fSJed Brown ierr = PetscMalloc1(nsplit,&jac->mat);CHKERRQ(ierr); 689519d70e2SJed Brown for (i=0; i<nsplit; i++) { 6907dae84e0SHong Zhang ierr = MatCreateSubMatrix(pc->mat,ilink->is,ilink->is_col,MAT_INITIAL_MATRIX,&jac->mat[i]);CHKERRQ(ierr); 691519d70e2SJed Brown ilink = ilink->next; 692519d70e2SJed Brown } 693519d70e2SJed Brown } else { 694ef7efd37SHong Zhang MatReuse scall; 695ef7efd37SHong Zhang if (pc->flag == DIFFERENT_NONZERO_PATTERN) { 696519d70e2SJed Brown for (i=0; i<nsplit; i++) { 697ef7efd37SHong Zhang ierr = MatDestroy(&jac->mat[i]);CHKERRQ(ierr); 698ef7efd37SHong Zhang } 699ef7efd37SHong Zhang scall = MAT_INITIAL_MATRIX; 700ef7efd37SHong Zhang } else scall = MAT_REUSE_MATRIX; 701ef7efd37SHong Zhang 702ef7efd37SHong Zhang for (i=0; i<nsplit; i++) { 703ef7efd37SHong Zhang if (jac->mat[i]) {ierr = MatCreateSubMatrix(pc->mat,ilink->is,ilink->is_col,scall,&jac->mat[i]);CHKERRQ(ierr);} 704519d70e2SJed Brown ilink = ilink->next; 705519d70e2SJed Brown } 706519d70e2SJed Brown } 707519d70e2SJed Brown } else { 708519d70e2SJed Brown jac->mat = jac->pmat; 709519d70e2SJed Brown } 71097bbdb24SBarry Smith 71153935eafSBarry Smith /* Check for null space attached to IS */ 71253935eafSBarry Smith ilink = jac->head; 71353935eafSBarry Smith for (i=0; i<nsplit; i++) { 71453935eafSBarry Smith MatNullSpace sp; 71553935eafSBarry Smith 71653935eafSBarry Smith ierr = PetscObjectQuery((PetscObject) ilink->is, "nullspace", (PetscObject*) &sp);CHKERRQ(ierr); 71753935eafSBarry Smith if (sp) { 71853935eafSBarry Smith ierr = MatSetNullSpace(jac->mat[i], sp);CHKERRQ(ierr); 71953935eafSBarry Smith } 72053935eafSBarry Smith ilink = ilink->next; 72153935eafSBarry Smith } 72253935eafSBarry Smith 723a51937d4SCarola Kruse if (jac->type != PC_COMPOSITE_ADDITIVE && jac->type != PC_COMPOSITE_SCHUR && jac->type != PC_COMPOSITE_GKB) { 72468dd23aaSBarry Smith /* extract the rows of the matrix associated with each field: used for efficient computation of residual inside algorithm */ 7254e39094bSDmitry Karpeev /* FIXME: Can/should we reuse jac->mat whenever (jac->diag_use_amat) is true? */ 72668dd23aaSBarry Smith ilink = jac->head; 727e52d2c62SBarry Smith if (nsplit == 2 && jac->type == PC_COMPOSITE_MULTIPLICATIVE) { 728e52d2c62SBarry Smith /* special case need where Afield[0] is not needed and only certain columns of Afield[1] are needed since update is only on those rows of the solution */ 729e52d2c62SBarry Smith if (!jac->Afield) { 730e52d2c62SBarry Smith ierr = PetscCalloc1(nsplit,&jac->Afield);CHKERRQ(ierr); 73180c96bb1SFande Kong if (jac->offdiag_use_amat) { 7327dae84e0SHong Zhang ierr = MatCreateSubMatrix(pc->mat,ilink->next->is,ilink->is,MAT_INITIAL_MATRIX,&jac->Afield[1]);CHKERRQ(ierr); 733e52d2c62SBarry Smith } else { 7347dae84e0SHong Zhang ierr = MatCreateSubMatrix(pc->pmat,ilink->next->is,ilink->is,MAT_INITIAL_MATRIX,&jac->Afield[1]);CHKERRQ(ierr); 73580c96bb1SFande Kong } 73680c96bb1SFande Kong } else { 737ef7efd37SHong Zhang MatReuse scall; 738ef7efd37SHong Zhang if (pc->flag == DIFFERENT_NONZERO_PATTERN) { 739ef7efd37SHong Zhang for (i=0; i<nsplit; i++) { 740ef7efd37SHong Zhang ierr = MatDestroy(&jac->Afield[1]);CHKERRQ(ierr); 741ef7efd37SHong Zhang } 742ef7efd37SHong Zhang scall = MAT_INITIAL_MATRIX; 743ef7efd37SHong Zhang } else scall = MAT_REUSE_MATRIX; 744ef7efd37SHong Zhang 74580c96bb1SFande Kong if (jac->offdiag_use_amat) { 746ef7efd37SHong Zhang ierr = MatCreateSubMatrix(pc->mat,ilink->next->is,ilink->is,scall,&jac->Afield[1]);CHKERRQ(ierr); 74780c96bb1SFande Kong } else { 748ef7efd37SHong Zhang ierr = MatCreateSubMatrix(pc->pmat,ilink->next->is,ilink->is,scall,&jac->Afield[1]);CHKERRQ(ierr); 74980c96bb1SFande Kong } 750e52d2c62SBarry Smith } 751e52d2c62SBarry Smith } else { 75268dd23aaSBarry Smith if (!jac->Afield) { 753785e854fSJed Brown ierr = PetscMalloc1(nsplit,&jac->Afield);CHKERRQ(ierr); 75468dd23aaSBarry Smith for (i=0; i<nsplit; i++) { 75580c96bb1SFande Kong if (jac->offdiag_use_amat) { 7567dae84e0SHong Zhang ierr = MatCreateSubMatrix(pc->mat,ilink->is,NULL,MAT_INITIAL_MATRIX,&jac->Afield[i]);CHKERRQ(ierr); 75780c96bb1SFande Kong } else { 7587dae84e0SHong Zhang ierr = MatCreateSubMatrix(pc->pmat,ilink->is,NULL,MAT_INITIAL_MATRIX,&jac->Afield[i]);CHKERRQ(ierr); 75980c96bb1SFande Kong } 76068dd23aaSBarry Smith ilink = ilink->next; 76168dd23aaSBarry Smith } 76268dd23aaSBarry Smith } else { 763ef7efd37SHong Zhang MatReuse scall; 764ef7efd37SHong Zhang if (pc->flag == DIFFERENT_NONZERO_PATTERN) { 765ef7efd37SHong Zhang for (i=0; i<nsplit; i++) { 766ef7efd37SHong Zhang ierr = MatDestroy(&jac->Afield[i]);CHKERRQ(ierr); 767ef7efd37SHong Zhang } 768ef7efd37SHong Zhang scall = MAT_INITIAL_MATRIX; 769ef7efd37SHong Zhang } else scall = MAT_REUSE_MATRIX; 770ef7efd37SHong Zhang 77168dd23aaSBarry Smith for (i=0; i<nsplit; i++) { 77280c96bb1SFande Kong if (jac->offdiag_use_amat) { 773ef7efd37SHong Zhang ierr = MatCreateSubMatrix(pc->mat,ilink->is,NULL,scall,&jac->Afield[i]);CHKERRQ(ierr); 77480c96bb1SFande Kong } else { 775ef7efd37SHong Zhang ierr = MatCreateSubMatrix(pc->pmat,ilink->is,NULL,scall,&jac->Afield[i]);CHKERRQ(ierr); 77680c96bb1SFande Kong } 77768dd23aaSBarry Smith ilink = ilink->next; 77868dd23aaSBarry Smith } 77968dd23aaSBarry Smith } 78068dd23aaSBarry Smith } 781e52d2c62SBarry Smith } 78268dd23aaSBarry Smith 7833b224e63SBarry Smith if (jac->type == PC_COMPOSITE_SCHUR) { 7843b224e63SBarry Smith IS ccis; 785c096484dSStefano Zampini PetscBool isspd; 7864aa3045dSJed Brown PetscInt rstart,rend; 787093c86ffSJed Brown char lscname[256]; 788093c86ffSJed Brown PetscObject LSC_L; 789ce94432eSBarry Smith 790ce94432eSBarry Smith if (nsplit != 2) SETERRQ(PetscObjectComm((PetscObject)pc),PETSC_ERR_ARG_INCOMP,"To use Schur complement preconditioner you must have exactly 2 fields"); 79168dd23aaSBarry Smith 792c096484dSStefano Zampini /* If pc->mat is SPD, don't scale by -1 the Schur complement */ 793c096484dSStefano Zampini if (jac->schurscale == (PetscScalar)-1.0) { 794c096484dSStefano Zampini ierr = MatGetOption(pc->pmat,MAT_SPD,&isspd);CHKERRQ(ierr); 795c096484dSStefano Zampini jac->schurscale = (isspd == PETSC_TRUE) ? 1.0 : -1.0; 796c096484dSStefano Zampini } 797c096484dSStefano Zampini 798e6cab6aaSJed Brown /* When extracting off-diagonal submatrices, we take complements from this range */ 799e6cab6aaSJed Brown ierr = MatGetOwnershipRangeColumn(pc->mat,&rstart,&rend);CHKERRQ(ierr); 800e6cab6aaSJed Brown 8013b224e63SBarry Smith /* need to handle case when one is resetting up the preconditioner */ 8023b224e63SBarry Smith if (jac->schur) { 8030298fd71SBarry Smith KSP kspA = jac->head->ksp, kspInner = NULL, kspUpper = jac->kspupper; 804443836d0SMatthew G Knepley 805fb3147dbSMatthew G Knepley ierr = MatSchurComplementGetKSP(jac->schur, &kspInner);CHKERRQ(ierr); 8063b224e63SBarry Smith ilink = jac->head; 80749bb4cd7SJungho Lee ierr = ISComplement(ilink->is_col,rstart,rend,&ccis);CHKERRQ(ierr); 8084e39094bSDmitry Karpeev if (jac->offdiag_use_amat) { 8097dae84e0SHong Zhang ierr = MatCreateSubMatrix(pc->mat,ilink->is,ccis,MAT_REUSE_MATRIX,&jac->B);CHKERRQ(ierr); 810c84da90fSDmitry Karpeev } else { 8117dae84e0SHong Zhang ierr = MatCreateSubMatrix(pc->pmat,ilink->is,ccis,MAT_REUSE_MATRIX,&jac->B);CHKERRQ(ierr); 812c84da90fSDmitry Karpeev } 813fcfd50ebSBarry Smith ierr = ISDestroy(&ccis);CHKERRQ(ierr); 8143b224e63SBarry Smith ilink = ilink->next; 81549bb4cd7SJungho Lee ierr = ISComplement(ilink->is_col,rstart,rend,&ccis);CHKERRQ(ierr); 8164e39094bSDmitry Karpeev if (jac->offdiag_use_amat) { 8177dae84e0SHong Zhang ierr = MatCreateSubMatrix(pc->mat,ilink->is,ccis,MAT_REUSE_MATRIX,&jac->C);CHKERRQ(ierr); 818c84da90fSDmitry Karpeev } else { 8197dae84e0SHong Zhang ierr = MatCreateSubMatrix(pc->pmat,ilink->is,ccis,MAT_REUSE_MATRIX,&jac->C);CHKERRQ(ierr); 820c84da90fSDmitry Karpeev } 821fcfd50ebSBarry Smith ierr = ISDestroy(&ccis);CHKERRQ(ierr); 822aa6c7ce3SBarry Smith ierr = MatSchurComplementUpdateSubMatrices(jac->schur,jac->mat[0],jac->pmat[0],jac->B,jac->C,jac->mat[1]);CHKERRQ(ierr); 823a7476a74SDmitry Karpeev if (jac->schurpre == PC_FIELDSPLIT_SCHUR_PRE_SELFP) { 824a7476a74SDmitry Karpeev ierr = MatDestroy(&jac->schurp);CHKERRQ(ierr); 825a7476a74SDmitry Karpeev ierr = MatSchurComplementGetPmat(jac->schur,MAT_INITIAL_MATRIX,&jac->schurp);CHKERRQ(ierr); 826a7476a74SDmitry Karpeev } 827443836d0SMatthew G Knepley if (kspA != kspInner) { 82823ee1639SBarry Smith ierr = KSPSetOperators(kspA,jac->mat[0],jac->pmat[0]);CHKERRQ(ierr); 829443836d0SMatthew G Knepley } 830443836d0SMatthew G Knepley if (kspUpper != kspA) { 83123ee1639SBarry Smith ierr = KSPSetOperators(kspUpper,jac->mat[0],jac->pmat[0]);CHKERRQ(ierr); 832443836d0SMatthew G Knepley } 83323ee1639SBarry Smith ierr = KSPSetOperators(jac->kspschur,jac->schur,FieldSplitSchurPre(jac));CHKERRQ(ierr); 8343b224e63SBarry Smith } else { 835bafc1b83SMatthew G Knepley const char *Dprefix; 836470b340bSDmitry Karpeev char schurprefix[256], schurmatprefix[256]; 837514bf10dSMatthew G Knepley char schurtestoption[256]; 838bdddcaaaSMatthew G Knepley MatNullSpace sp; 839514bf10dSMatthew G Knepley PetscBool flg; 840686bed4dSStefano Zampini KSP kspt; 8413b224e63SBarry Smith 842a04f6461SBarry Smith /* extract the A01 and A10 matrices */ 8433b224e63SBarry Smith ilink = jac->head; 84449bb4cd7SJungho Lee ierr = ISComplement(ilink->is_col,rstart,rend,&ccis);CHKERRQ(ierr); 8454e39094bSDmitry Karpeev if (jac->offdiag_use_amat) { 8467dae84e0SHong Zhang ierr = MatCreateSubMatrix(pc->mat,ilink->is,ccis,MAT_INITIAL_MATRIX,&jac->B);CHKERRQ(ierr); 847c84da90fSDmitry Karpeev } else { 8487dae84e0SHong Zhang ierr = MatCreateSubMatrix(pc->pmat,ilink->is,ccis,MAT_INITIAL_MATRIX,&jac->B);CHKERRQ(ierr); 849c84da90fSDmitry Karpeev } 850fcfd50ebSBarry Smith ierr = ISDestroy(&ccis);CHKERRQ(ierr); 8513b224e63SBarry Smith ilink = ilink->next; 85249bb4cd7SJungho Lee ierr = ISComplement(ilink->is_col,rstart,rend,&ccis);CHKERRQ(ierr); 8534e39094bSDmitry Karpeev if (jac->offdiag_use_amat) { 8547dae84e0SHong Zhang ierr = MatCreateSubMatrix(pc->mat,ilink->is,ccis,MAT_INITIAL_MATRIX,&jac->C);CHKERRQ(ierr); 855c84da90fSDmitry Karpeev } else { 8567dae84e0SHong Zhang ierr = MatCreateSubMatrix(pc->pmat,ilink->is,ccis,MAT_INITIAL_MATRIX,&jac->C);CHKERRQ(ierr); 857c84da90fSDmitry Karpeev } 858fcfd50ebSBarry Smith ierr = ISDestroy(&ccis);CHKERRQ(ierr); 85920252d06SBarry Smith 860f5236f50SJed Brown /* Use mat[0] (diagonal block of Amat) preconditioned by pmat[0] to define Schur complement */ 86120252d06SBarry Smith ierr = MatCreate(((PetscObject)jac->mat[0])->comm,&jac->schur);CHKERRQ(ierr); 86220252d06SBarry Smith ierr = MatSetType(jac->schur,MATSCHURCOMPLEMENT);CHKERRQ(ierr); 863bee83525SDmitry Karpeev ierr = MatSchurComplementSetSubMatrices(jac->schur,jac->mat[0],jac->pmat[0],jac->B,jac->C,jac->mat[1]);CHKERRQ(ierr); 864470b340bSDmitry Karpeev ierr = PetscSNPrintf(schurmatprefix, sizeof(schurmatprefix), "%sfieldsplit_%s_", ((PetscObject)pc)->prefix ? ((PetscObject)pc)->prefix : "", ilink->splitname);CHKERRQ(ierr); 865470b340bSDmitry Karpeev ierr = MatSetOptionsPrefix(jac->schur,schurmatprefix);CHKERRQ(ierr); 866686bed4dSStefano Zampini ierr = MatSchurComplementGetKSP(jac->schur,&kspt);CHKERRQ(ierr); 867686bed4dSStefano Zampini ierr = KSPSetOptionsPrefix(kspt,schurmatprefix);CHKERRQ(ierr); 868686bed4dSStefano Zampini 869686bed4dSStefano Zampini /* Note: this is not true in general */ 870895c21f2SBarry Smith ierr = MatGetNullSpace(jac->mat[1], &sp);CHKERRQ(ierr); 87120252d06SBarry Smith if (sp) { 87220252d06SBarry Smith ierr = MatSetNullSpace(jac->schur, sp);CHKERRQ(ierr); 87320252d06SBarry Smith } 87420252d06SBarry Smith 87520252d06SBarry Smith ierr = PetscSNPrintf(schurtestoption, sizeof(schurtestoption), "-fieldsplit_%s_inner_", ilink->splitname);CHKERRQ(ierr); 876c5929fdfSBarry Smith ierr = PetscOptionsFindPairPrefix_Private(((PetscObject)pc)->options,((PetscObject)pc)->prefix, schurtestoption, NULL, &flg);CHKERRQ(ierr); 877514bf10dSMatthew G Knepley if (flg) { 878514bf10dSMatthew G Knepley DM dmInner; 87921635b76SJed Brown KSP kspInner; 880686bed4dSStefano Zampini PC pcInner; 88121635b76SJed Brown 88221635b76SJed Brown ierr = MatSchurComplementGetKSP(jac->schur, &kspInner);CHKERRQ(ierr); 8832cc093acSMatthew G. Knepley ierr = KSPReset(kspInner);CHKERRQ(ierr); 8842cc093acSMatthew G. Knepley ierr = KSPSetOperators(kspInner,jac->mat[0],jac->pmat[0]);CHKERRQ(ierr); 88521635b76SJed Brown ierr = PetscSNPrintf(schurprefix, sizeof(schurprefix), "%sfieldsplit_%s_inner_", ((PetscObject)pc)->prefix ? ((PetscObject)pc)->prefix : "", ilink->splitname);CHKERRQ(ierr); 88621635b76SJed Brown /* Indent this deeper to emphasize the "inner" nature of this solver. */ 88721635b76SJed Brown ierr = PetscObjectIncrementTabLevel((PetscObject)kspInner, (PetscObject) pc, 2);CHKERRQ(ierr); 8882cc093acSMatthew G. Knepley ierr = PetscObjectIncrementTabLevel((PetscObject)kspInner->pc, (PetscObject) pc, 2);CHKERRQ(ierr); 88921635b76SJed Brown ierr = KSPSetOptionsPrefix(kspInner, schurprefix);CHKERRQ(ierr); 890514bf10dSMatthew G Knepley 891514bf10dSMatthew G Knepley /* Set DM for new solver */ 892bafc1b83SMatthew G Knepley ierr = KSPGetDM(jac->head->ksp, &dmInner);CHKERRQ(ierr); 89321635b76SJed Brown ierr = KSPSetDM(kspInner, dmInner);CHKERRQ(ierr); 89421635b76SJed Brown ierr = KSPSetDMActive(kspInner, PETSC_FALSE);CHKERRQ(ierr); 895686bed4dSStefano Zampini 896686bed4dSStefano Zampini /* Defaults to PCKSP as preconditioner */ 897686bed4dSStefano Zampini ierr = KSPGetPC(kspInner, &pcInner);CHKERRQ(ierr); 898686bed4dSStefano Zampini ierr = PCSetType(pcInner, PCKSP);CHKERRQ(ierr); 899686bed4dSStefano Zampini ierr = PCKSPSetKSP(pcInner, jac->head->ksp);CHKERRQ(ierr); 900514bf10dSMatthew G Knepley } else { 90121635b76SJed Brown /* Use the outer solver for the inner solve, but revert the KSPPREONLY from PCFieldSplitSetFields_FieldSplit or 90221635b76SJed Brown * PCFieldSplitSetIS_FieldSplit. We don't want KSPPREONLY because it makes the Schur complement inexact, 90321635b76SJed Brown * preventing Schur complement reduction to be an accurate solve. Usually when an iterative solver is used for 90421635b76SJed Brown * S = D - C A_inner^{-1} B, we expect S to be defined using an accurate definition of A_inner^{-1}, so we make 90521635b76SJed Brown * GMRES the default. Note that it is also common to use PREONLY for S, in which case S may not be used 90621635b76SJed Brown * directly, and the user is responsible for setting an inexact method for fieldsplit's A^{-1}. */ 90721635b76SJed Brown ierr = KSPSetType(jac->head->ksp,KSPGMRES);CHKERRQ(ierr); 908514bf10dSMatthew G Knepley ierr = MatSchurComplementSetKSP(jac->schur,jac->head->ksp);CHKERRQ(ierr); 909bafc1b83SMatthew G Knepley } 91023ee1639SBarry Smith ierr = KSPSetOperators(jac->head->ksp,jac->mat[0],jac->pmat[0]);CHKERRQ(ierr); 9115a9f2f41SSatish Balay ierr = KSPSetFromOptions(jac->head->ksp);CHKERRQ(ierr); 91297bbdb24SBarry Smith ierr = MatSetFromOptions(jac->schur);CHKERRQ(ierr); 91397bbdb24SBarry Smith 914686bed4dSStefano Zampini ierr = PetscObjectTypeCompare((PetscObject)jac->schur, MATSCHURCOMPLEMENT, &flg);CHKERRQ(ierr); 915686bed4dSStefano Zampini if (flg) { /* Need to do this otherwise PCSetUp_KSP will overwrite the amat of jac->head->ksp */ 916686bed4dSStefano Zampini KSP kspInner; 917686bed4dSStefano Zampini PC pcInner; 918686bed4dSStefano Zampini 919686bed4dSStefano Zampini ierr = MatSchurComplementGetKSP(jac->schur, &kspInner);CHKERRQ(ierr); 920686bed4dSStefano Zampini ierr = KSPGetPC(kspInner, &pcInner);CHKERRQ(ierr); 921686bed4dSStefano Zampini ierr = PetscObjectTypeCompare((PetscObject)pcInner, PCKSP, &flg);CHKERRQ(ierr); 922686bed4dSStefano Zampini if (flg) { 923686bed4dSStefano Zampini KSP ksp; 924686bed4dSStefano Zampini 925686bed4dSStefano Zampini ierr = PCKSPGetKSP(pcInner, &ksp);CHKERRQ(ierr); 926686bed4dSStefano Zampini if (ksp == jac->head->ksp) { 927686bed4dSStefano Zampini ierr = PCSetUseAmat(pcInner, PETSC_TRUE);CHKERRQ(ierr); 928686bed4dSStefano Zampini } 929686bed4dSStefano Zampini } 930686bed4dSStefano Zampini } 931443836d0SMatthew G Knepley ierr = PetscSNPrintf(schurtestoption, sizeof(schurtestoption), "-fieldsplit_%s_upper_", ilink->splitname);CHKERRQ(ierr); 932c5929fdfSBarry Smith ierr = PetscOptionsFindPairPrefix_Private(((PetscObject)pc)->options,((PetscObject)pc)->prefix, schurtestoption, NULL, &flg);CHKERRQ(ierr); 933443836d0SMatthew G Knepley if (flg) { 934443836d0SMatthew G Knepley DM dmInner; 935443836d0SMatthew G Knepley 936443836d0SMatthew G Knepley ierr = PetscSNPrintf(schurprefix, sizeof(schurprefix), "%sfieldsplit_%s_upper_", ((PetscObject)pc)->prefix ? ((PetscObject)pc)->prefix : "", ilink->splitname);CHKERRQ(ierr); 93782f516ccSBarry Smith ierr = KSPCreate(PetscObjectComm((PetscObject)pc), &jac->kspupper);CHKERRQ(ierr); 938422a814eSBarry Smith ierr = KSPSetErrorIfNotConverged(jac->kspupper,pc->erroriffailure);CHKERRQ(ierr); 939443836d0SMatthew G Knepley ierr = KSPSetOptionsPrefix(jac->kspupper, schurprefix);CHKERRQ(ierr); 9402cc093acSMatthew G. Knepley ierr = PetscObjectIncrementTabLevel((PetscObject)jac->kspupper, (PetscObject) pc, 1);CHKERRQ(ierr); 9412cc093acSMatthew G. Knepley ierr = PetscObjectIncrementTabLevel((PetscObject)jac->kspupper->pc, (PetscObject) pc, 1);CHKERRQ(ierr); 942443836d0SMatthew G Knepley ierr = KSPGetDM(jac->head->ksp, &dmInner);CHKERRQ(ierr); 943443836d0SMatthew G Knepley ierr = KSPSetDM(jac->kspupper, dmInner);CHKERRQ(ierr); 944443836d0SMatthew G Knepley ierr = KSPSetDMActive(jac->kspupper, PETSC_FALSE);CHKERRQ(ierr); 945443836d0SMatthew G Knepley ierr = KSPSetFromOptions(jac->kspupper);CHKERRQ(ierr); 94623ee1639SBarry Smith ierr = KSPSetOperators(jac->kspupper,jac->mat[0],jac->pmat[0]);CHKERRQ(ierr); 947443836d0SMatthew G Knepley ierr = VecDuplicate(jac->head->x, &jac->head->z);CHKERRQ(ierr); 948443836d0SMatthew G Knepley } else { 949443836d0SMatthew G Knepley jac->kspupper = jac->head->ksp; 950443836d0SMatthew G Knepley ierr = PetscObjectReference((PetscObject) jac->head->ksp);CHKERRQ(ierr); 951443836d0SMatthew G Knepley } 952443836d0SMatthew G Knepley 953a7476a74SDmitry Karpeev if (jac->schurpre == PC_FIELDSPLIT_SCHUR_PRE_SELFP) { 954a7476a74SDmitry Karpeev ierr = MatSchurComplementGetPmat(jac->schur,MAT_INITIAL_MATRIX,&jac->schurp);CHKERRQ(ierr); 955a7476a74SDmitry Karpeev } 956ce94432eSBarry Smith ierr = KSPCreate(PetscObjectComm((PetscObject)pc),&jac->kspschur);CHKERRQ(ierr); 957422a814eSBarry Smith ierr = KSPSetErrorIfNotConverged(jac->kspschur,pc->erroriffailure);CHKERRQ(ierr); 95897bbdb24SBarry Smith ierr = PetscLogObjectParent((PetscObject)pc,(PetscObject)jac->kspschur);CHKERRQ(ierr); 95920252d06SBarry Smith ierr = PetscObjectIncrementTabLevel((PetscObject)jac->kspschur,(PetscObject)pc,1);CHKERRQ(ierr); 96097bbdb24SBarry Smith if (jac->schurpre == PC_FIELDSPLIT_SCHUR_PRE_SELF) { 9617233a360SDmitry Karpeev PC pcschur; 9627233a360SDmitry Karpeev ierr = KSPGetPC(jac->kspschur,&pcschur);CHKERRQ(ierr); 9637233a360SDmitry Karpeev ierr = PCSetType(pcschur,PCNONE);CHKERRQ(ierr); 96497bbdb24SBarry Smith /* Note: This is bad if there exist preconditioners for MATSCHURCOMPLEMENT */ 965e74569cdSMatthew G. Knepley } else if (jac->schurpre == PC_FIELDSPLIT_SCHUR_PRE_FULL) { 966e74569cdSMatthew G. Knepley ierr = MatSchurComplementComputeExplicitOperator(jac->schur, &jac->schur_user);CHKERRQ(ierr); 96797bbdb24SBarry Smith } 96823ee1639SBarry Smith ierr = KSPSetOperators(jac->kspschur,jac->schur,FieldSplitSchurPre(jac));CHKERRQ(ierr); 96997bbdb24SBarry Smith ierr = KSPGetOptionsPrefix(jac->head->next->ksp, &Dprefix);CHKERRQ(ierr); 97097bbdb24SBarry Smith ierr = KSPSetOptionsPrefix(jac->kspschur, Dprefix);CHKERRQ(ierr); 971c096484dSStefano Zampini /* propagate DM */ 972b20b4189SMatthew G. Knepley { 973b20b4189SMatthew G. Knepley DM sdm; 974b20b4189SMatthew G. Knepley ierr = KSPGetDM(jac->head->next->ksp, &sdm);CHKERRQ(ierr); 975b20b4189SMatthew G. Knepley if (sdm) { 976b20b4189SMatthew G. Knepley ierr = KSPSetDM(jac->kspschur, sdm);CHKERRQ(ierr); 977b20b4189SMatthew G. Knepley ierr = KSPSetDMActive(jac->kspschur, PETSC_FALSE);CHKERRQ(ierr); 978b20b4189SMatthew G. Knepley } 979b20b4189SMatthew G. Knepley } 98097bbdb24SBarry Smith /* really want setfromoptions called in PCSetFromOptions_FieldSplit(), but it is not ready yet */ 98197bbdb24SBarry Smith /* need to call this every time, since the jac->kspschur is freshly created, otherwise its options never get set */ 98297bbdb24SBarry Smith ierr = KSPSetFromOptions(jac->kspschur);CHKERRQ(ierr); 98397bbdb24SBarry Smith } 984686bed4dSStefano Zampini ierr = MatAssemblyBegin(jac->schur,MAT_FINAL_ASSEMBLY);CHKERRQ(ierr); 985686bed4dSStefano Zampini ierr = MatAssemblyEnd(jac->schur,MAT_FINAL_ASSEMBLY);CHKERRQ(ierr); 98697bbdb24SBarry Smith 9875a9f2f41SSatish Balay /* HACK: special support to forward L and Lp matrices that might be used by PCLSC */ 9888caf3d72SBarry Smith ierr = PetscSNPrintf(lscname,sizeof(lscname),"%s_LSC_L",ilink->splitname);CHKERRQ(ierr); 989519d70e2SJed Brown ierr = PetscObjectQuery((PetscObject)pc->mat,lscname,(PetscObject*)&LSC_L);CHKERRQ(ierr); 9903b224e63SBarry Smith if (!LSC_L) {ierr = PetscObjectQuery((PetscObject)pc->pmat,lscname,(PetscObject*)&LSC_L);CHKERRQ(ierr);} 991c1570756SJed Brown if (LSC_L) {ierr = PetscObjectCompose((PetscObject)jac->schur,"LSC_L",(PetscObject)LSC_L);CHKERRQ(ierr);} 9928caf3d72SBarry Smith ierr = PetscSNPrintf(lscname,sizeof(lscname),"%s_LSC_Lp",ilink->splitname);CHKERRQ(ierr); 99397bbdb24SBarry Smith ierr = PetscObjectQuery((PetscObject)pc->pmat,lscname,(PetscObject*)&LSC_L);CHKERRQ(ierr); 9945a9f2f41SSatish Balay if (!LSC_L) {ierr = PetscObjectQuery((PetscObject)pc->mat,lscname,(PetscObject*)&LSC_L);CHKERRQ(ierr);} 9950971522cSBarry Smith if (LSC_L) {ierr = PetscObjectCompose((PetscObject)jac->schur,"LSC_Lp",(PetscObject)LSC_L);CHKERRQ(ierr);} 996a51937d4SCarola Kruse } else if (jac->type == PC_COMPOSITE_GKB) { 997a51937d4SCarola Kruse IS ccis; 998a51937d4SCarola Kruse PetscInt rstart,rend; 999a51937d4SCarola Kruse 1000a51937d4SCarola Kruse if (nsplit != 2) SETERRQ(PetscObjectComm((PetscObject)pc),PETSC_ERR_ARG_INCOMP,"To use GKB preconditioner you must have exactly 2 fields"); 1001a51937d4SCarola Kruse 1002a51937d4SCarola Kruse ilink = jac->head; 1003a51937d4SCarola Kruse 1004a51937d4SCarola Kruse /* When extracting off-diagonal submatrices, we take complements from this range */ 1005a51937d4SCarola Kruse ierr = MatGetOwnershipRangeColumn(pc->mat,&rstart,&rend);CHKERRQ(ierr); 1006a51937d4SCarola Kruse 1007a51937d4SCarola Kruse ierr = ISComplement(ilink->is_col,rstart,rend,&ccis);CHKERRQ(ierr); 1008a51937d4SCarola Kruse if (jac->offdiag_use_amat) { 1009a51937d4SCarola Kruse ierr = MatCreateSubMatrix(pc->mat,ilink->is,ccis,MAT_INITIAL_MATRIX,&jac->B);CHKERRQ(ierr); 1010a51937d4SCarola Kruse } else { 1011a51937d4SCarola Kruse ierr = MatCreateSubMatrix(pc->pmat,ilink->is,ccis,MAT_INITIAL_MATRIX,&jac->B);CHKERRQ(ierr); 1012a51937d4SCarola Kruse } 1013a51937d4SCarola Kruse ierr = ISDestroy(&ccis);CHKERRQ(ierr); 1014e071a0a4SCarola Kruse /* Create work vectors for GKB algorithm */ 1015e071a0a4SCarola Kruse ierr = VecDuplicate(ilink->x,&jac->u);CHKERRQ(ierr); 1016e071a0a4SCarola Kruse ierr = VecDuplicate(ilink->x,&jac->Hu);CHKERRQ(ierr); 1017e071a0a4SCarola Kruse ierr = VecDuplicate(ilink->x,&jac->w2);CHKERRQ(ierr); 1018a51937d4SCarola Kruse ilink = ilink->next; 1019a51937d4SCarola Kruse ierr = ISComplement(ilink->is_col,rstart,rend,&ccis);CHKERRQ(ierr); 1020a51937d4SCarola Kruse if (jac->offdiag_use_amat) { 1021a51937d4SCarola Kruse ierr = MatCreateSubMatrix(pc->mat,ilink->is,ccis,MAT_INITIAL_MATRIX,&jac->C);CHKERRQ(ierr); 1022a51937d4SCarola Kruse } else { 1023a51937d4SCarola Kruse ierr = MatCreateSubMatrix(pc->pmat,ilink->is,ccis,MAT_INITIAL_MATRIX,&jac->C);CHKERRQ(ierr); 1024a51937d4SCarola Kruse } 1025a51937d4SCarola Kruse ierr = ISDestroy(&ccis);CHKERRQ(ierr); 1026e071a0a4SCarola Kruse /* Create work vectors for GKB algorithm */ 1027e071a0a4SCarola Kruse ierr = VecDuplicate(ilink->x,&jac->v);CHKERRQ(ierr); 1028e071a0a4SCarola Kruse ierr = VecDuplicate(ilink->x,&jac->d);CHKERRQ(ierr); 1029e071a0a4SCarola Kruse ierr = VecDuplicate(ilink->x,&jac->w1);CHKERRQ(ierr); 1030a51937d4SCarola Kruse ierr = MatGolubKahanComputeExplicitOperator(jac->mat[0],jac->B,jac->C,&jac->H,jac->gkbnu);CHKERRQ(ierr); 1031e071a0a4SCarola Kruse ierr = PetscCalloc1(jac->gkbdelay,&jac->vecz);CHKERRQ(ierr); 1032e071a0a4SCarola Kruse 1033a51937d4SCarola Kruse ilink = jac->head; 1034a51937d4SCarola Kruse ierr = KSPSetOperators(ilink->ksp,jac->H,jac->H);CHKERRQ(ierr); 1035a51937d4SCarola Kruse if (!jac->suboptionsset) {ierr = KSPSetFromOptions(ilink->ksp);CHKERRQ(ierr);} 1036e071a0a4SCarola Kruse /* Create gkb_monitor context */ 1037de482cd7SCarola Kruse if (jac->gkbmonitor) { 1038de482cd7SCarola Kruse PetscInt tablevel; 1039de482cd7SCarola Kruse ierr = PetscViewerCreate(PETSC_COMM_WORLD,&jac->gkbviewer);CHKERRQ(ierr); 1040de482cd7SCarola Kruse ierr = PetscViewerSetType(jac->gkbviewer,PETSCVIEWERASCII);CHKERRQ(ierr); 1041de482cd7SCarola Kruse ierr = PetscObjectGetTabLevel((PetscObject)ilink->ksp,&tablevel);CHKERRQ(ierr); 1042e071a0a4SCarola Kruse ierr = PetscViewerASCIISetTab(jac->gkbviewer,tablevel);CHKERRQ(ierr); 1043de482cd7SCarola Kruse ierr = PetscObjectIncrementTabLevel((PetscObject)ilink->ksp,(PetscObject)ilink->ksp,1);CHKERRQ(ierr); 1044de482cd7SCarola Kruse } 10450971522cSBarry Smith } else { 104668bd789dSDmitry Karpeev /* set up the individual splits' PCs */ 10470971522cSBarry Smith i = 0; 10480971522cSBarry Smith ilink = jac->head; 10490971522cSBarry Smith while (ilink) { 105023ee1639SBarry Smith ierr = KSPSetOperators(ilink->ksp,jac->mat[i],jac->pmat[i]);CHKERRQ(ierr); 10510971522cSBarry Smith /* really want setfromoptions called in PCSetFromOptions_FieldSplit(), but it is not ready yet */ 10520971522cSBarry Smith if (!jac->suboptionsset) {ierr = KSPSetFromOptions(ilink->ksp);CHKERRQ(ierr);} 10530971522cSBarry Smith i++; 10540971522cSBarry Smith ilink = ilink->next; 10550971522cSBarry Smith } 10563b224e63SBarry Smith } 10573b224e63SBarry Smith 1058c1570756SJed Brown jac->suboptionsset = PETSC_TRUE; 10590971522cSBarry Smith PetscFunctionReturn(0); 10600971522cSBarry Smith } 10610971522cSBarry Smith 10625a9f2f41SSatish Balay #define FieldSplitSplitSolveAdd(ilink,xx,yy) \ 1063ca9f406cSSatish Balay (VecScatterBegin(ilink->sctx,xx,ilink->x,INSERT_VALUES,SCATTER_FORWARD) || \ 1064ca9f406cSSatish Balay VecScatterEnd(ilink->sctx,xx,ilink->x,INSERT_VALUES,SCATTER_FORWARD) || \ 10659df09d43SBarry Smith PetscLogEventBegin(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL) ||\ 10665a9f2f41SSatish Balay KSPSolve(ilink->ksp,ilink->x,ilink->y) || \ 10679df09d43SBarry Smith PetscLogEventEnd(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL) ||\ 1068ca9f406cSSatish Balay VecScatterBegin(ilink->sctx,ilink->y,yy,ADD_VALUES,SCATTER_REVERSE) || \ 1069ca9f406cSSatish Balay VecScatterEnd(ilink->sctx,ilink->y,yy,ADD_VALUES,SCATTER_REVERSE)) 107079416396SBarry Smith 10713b224e63SBarry Smith static PetscErrorCode PCApply_FieldSplit_Schur(PC pc,Vec x,Vec y) 10723b224e63SBarry Smith { 10733b224e63SBarry Smith PC_FieldSplit *jac = (PC_FieldSplit*)pc->data; 10743b224e63SBarry Smith PetscErrorCode ierr; 10753b224e63SBarry Smith PC_FieldSplitLink ilinkA = jac->head, ilinkD = ilinkA->next; 1076443836d0SMatthew G Knepley KSP kspA = ilinkA->ksp, kspLower = kspA, kspUpper = jac->kspupper; 10773b224e63SBarry Smith 10783b224e63SBarry Smith PetscFunctionBegin; 1079c5d2311dSJed Brown switch (jac->schurfactorization) { 1080c9c6ffaaSJed Brown case PC_FIELDSPLIT_SCHUR_FACT_DIAG: 1081a04f6461SBarry Smith /* [A00 0; 0 -S], positive definite, suitable for MINRES */ 1082c5d2311dSJed Brown ierr = VecScatterBegin(ilinkA->sctx,x,ilinkA->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr); 1083c5d2311dSJed Brown ierr = VecScatterBegin(ilinkD->sctx,x,ilinkD->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr); 1084c5d2311dSJed Brown ierr = VecScatterEnd(ilinkA->sctx,x,ilinkA->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr); 10859df09d43SBarry Smith ierr = PetscLogEventBegin(ilinkA->event,kspA,ilinkA->x,ilinkA->y,NULL);CHKERRQ(ierr); 1086443836d0SMatthew G Knepley ierr = KSPSolve(kspA,ilinkA->x,ilinkA->y);CHKERRQ(ierr); 10879df09d43SBarry Smith ierr = PetscLogEventEnd(ilinkA->event,kspA,ilinkA->x,ilinkA->y,NULL);CHKERRQ(ierr); 1088c5d2311dSJed Brown ierr = VecScatterBegin(ilinkA->sctx,ilinkA->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr); 1089c5d2311dSJed Brown ierr = VecScatterEnd(ilinkD->sctx,x,ilinkD->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr); 10909df09d43SBarry Smith ierr = PetscLogEventBegin(KSP_Solve_FS_S,jac->kspschur,ilinkD->x,ilinkD->y,NULL);CHKERRQ(ierr); 1091c5d2311dSJed Brown ierr = KSPSolve(jac->kspschur,ilinkD->x,ilinkD->y);CHKERRQ(ierr); 10929df09d43SBarry Smith ierr = PetscLogEventEnd(KSP_Solve_FS_S,jac->kspschur,ilinkD->x,ilinkD->y,NULL);CHKERRQ(ierr); 1093c096484dSStefano Zampini ierr = VecScale(ilinkD->y,jac->schurscale);CHKERRQ(ierr); 1094c5d2311dSJed Brown ierr = VecScatterBegin(ilinkD->sctx,ilinkD->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr); 1095c5d2311dSJed Brown ierr = VecScatterEnd(ilinkA->sctx,ilinkA->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr); 1096c5d2311dSJed Brown ierr = VecScatterEnd(ilinkD->sctx,ilinkD->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr); 1097c5d2311dSJed Brown break; 1098c9c6ffaaSJed Brown case PC_FIELDSPLIT_SCHUR_FACT_LOWER: 1099a04f6461SBarry Smith /* [A00 0; A10 S], suitable for left preconditioning */ 1100c5d2311dSJed Brown ierr = VecScatterBegin(ilinkA->sctx,x,ilinkA->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr); 1101c5d2311dSJed Brown ierr = VecScatterEnd(ilinkA->sctx,x,ilinkA->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr); 11029df09d43SBarry Smith ierr = PetscLogEventBegin(ilinkA->event,kspA,ilinkA->x,ilinkA->y,NULL);CHKERRQ(ierr); 1103443836d0SMatthew G Knepley ierr = KSPSolve(kspA,ilinkA->x,ilinkA->y);CHKERRQ(ierr); 11049df09d43SBarry Smith ierr = PetscLogEventEnd(ilinkA->event,kspA,ilinkA->x,ilinkA->y,NULL);CHKERRQ(ierr); 1105c5d2311dSJed Brown ierr = MatMult(jac->C,ilinkA->y,ilinkD->x);CHKERRQ(ierr); 1106c5d2311dSJed Brown ierr = VecScale(ilinkD->x,-1.);CHKERRQ(ierr); 1107c5d2311dSJed Brown ierr = VecScatterBegin(ilinkD->sctx,x,ilinkD->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr); 1108c5d2311dSJed Brown ierr = VecScatterBegin(ilinkA->sctx,ilinkA->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr); 1109c5d2311dSJed Brown ierr = VecScatterEnd(ilinkD->sctx,x,ilinkD->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr); 11109df09d43SBarry Smith ierr = PetscLogEventBegin(KSP_Solve_FS_S,jac->kspschur,ilinkD->x,ilinkD->y,NULL);CHKERRQ(ierr); 1111c5d2311dSJed Brown ierr = KSPSolve(jac->kspschur,ilinkD->x,ilinkD->y);CHKERRQ(ierr); 11129df09d43SBarry Smith ierr = PetscLogEventEnd(KSP_Solve_FS_S,jac->kspschur,ilinkD->x,ilinkD->y,NULL);CHKERRQ(ierr); 1113c5d2311dSJed Brown ierr = VecScatterBegin(ilinkD->sctx,ilinkD->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr); 1114c5d2311dSJed Brown ierr = VecScatterEnd(ilinkA->sctx,ilinkA->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr); 1115c5d2311dSJed Brown ierr = VecScatterEnd(ilinkD->sctx,ilinkD->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr); 1116c5d2311dSJed Brown break; 1117c9c6ffaaSJed Brown case PC_FIELDSPLIT_SCHUR_FACT_UPPER: 1118a04f6461SBarry Smith /* [A00 A01; 0 S], suitable for right preconditioning */ 1119c5d2311dSJed Brown ierr = VecScatterBegin(ilinkD->sctx,x,ilinkD->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr); 1120c5d2311dSJed Brown ierr = VecScatterEnd(ilinkD->sctx,x,ilinkD->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr); 11219df09d43SBarry Smith ierr = PetscLogEventBegin(KSP_Solve_FS_S,jac->kspschur,ilinkD->x,ilinkD->y,NULL);CHKERRQ(ierr); 1122c5d2311dSJed Brown ierr = KSPSolve(jac->kspschur,ilinkD->x,ilinkD->y);CHKERRQ(ierr); 11239df09d43SBarry Smith ierr = PetscLogEventEnd(KSP_Solve_FS_S,jac->kspschur,ilinkD->x,ilinkD->y,NULL);CHKERRQ(ierr); ierr = MatMult(jac->B,ilinkD->y,ilinkA->x);CHKERRQ(ierr); 1124c5d2311dSJed Brown ierr = VecScale(ilinkA->x,-1.);CHKERRQ(ierr); 1125c5d2311dSJed Brown ierr = VecScatterBegin(ilinkA->sctx,x,ilinkA->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr); 1126c5d2311dSJed Brown ierr = VecScatterBegin(ilinkD->sctx,ilinkD->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr); 1127c5d2311dSJed Brown ierr = VecScatterEnd(ilinkA->sctx,x,ilinkA->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr); 11289df09d43SBarry Smith ierr = PetscLogEventBegin(ilinkA->event,kspA,ilinkA->x,ilinkA->y,NULL);CHKERRQ(ierr); 1129443836d0SMatthew G Knepley ierr = KSPSolve(kspA,ilinkA->x,ilinkA->y);CHKERRQ(ierr); 11309df09d43SBarry Smith ierr = PetscLogEventEnd(ilinkA->event,kspA,ilinkA->x,ilinkA->y,NULL);CHKERRQ(ierr); 1131c5d2311dSJed Brown ierr = VecScatterBegin(ilinkA->sctx,ilinkA->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr); 1132c5d2311dSJed Brown ierr = VecScatterEnd(ilinkD->sctx,ilinkD->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr); 1133c5d2311dSJed Brown ierr = VecScatterEnd(ilinkA->sctx,ilinkA->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr); 1134c5d2311dSJed Brown break; 1135c9c6ffaaSJed Brown case PC_FIELDSPLIT_SCHUR_FACT_FULL: 1136c238f8cdSStefano Zampini /* [1 0; A10 A00^{-1} 1] [A00 0; 0 S] [1 A00^{-1}A01; 0 1] */ 11373b224e63SBarry Smith ierr = VecScatterBegin(ilinkA->sctx,x,ilinkA->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr); 11383b224e63SBarry Smith ierr = VecScatterEnd(ilinkA->sctx,x,ilinkA->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr); 11399df09d43SBarry Smith ierr = PetscLogEventBegin(KSP_Solve_FS_L,kspLower,ilinkA->x,ilinkA->y,NULL);CHKERRQ(ierr); 1140443836d0SMatthew G Knepley ierr = KSPSolve(kspLower,ilinkA->x,ilinkA->y);CHKERRQ(ierr); 11419df09d43SBarry Smith ierr = PetscLogEventEnd(KSP_Solve_FS_L,kspLower,ilinkA->x,ilinkA->y,NULL);CHKERRQ(ierr); 11423b224e63SBarry Smith ierr = MatMult(jac->C,ilinkA->y,ilinkD->x);CHKERRQ(ierr); 11433b224e63SBarry Smith ierr = VecScale(ilinkD->x,-1.0);CHKERRQ(ierr); 11443b224e63SBarry Smith ierr = VecScatterBegin(ilinkD->sctx,x,ilinkD->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr); 11453b224e63SBarry Smith ierr = VecScatterEnd(ilinkD->sctx,x,ilinkD->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr); 11463b224e63SBarry Smith 11479df09d43SBarry Smith ierr = PetscLogEventBegin(KSP_Solve_FS_S,jac->kspschur,ilinkD->x,ilinkD->y,NULL);CHKERRQ(ierr); 11483b224e63SBarry Smith ierr = KSPSolve(jac->kspschur,ilinkD->x,ilinkD->y);CHKERRQ(ierr); 11499df09d43SBarry Smith ierr = PetscLogEventEnd(KSP_Solve_FS_S,jac->kspschur,ilinkD->x,ilinkD->y,NULL);CHKERRQ(ierr); 11503b224e63SBarry Smith ierr = VecScatterBegin(ilinkD->sctx,ilinkD->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr); 11513b224e63SBarry Smith 1152443836d0SMatthew G Knepley if (kspUpper == kspA) { 11533b224e63SBarry Smith ierr = MatMult(jac->B,ilinkD->y,ilinkA->y);CHKERRQ(ierr); 11543b224e63SBarry Smith ierr = VecAXPY(ilinkA->x,-1.0,ilinkA->y);CHKERRQ(ierr); 11559df09d43SBarry Smith ierr = PetscLogEventBegin(ilinkA->event,kspA,ilinkA->x,ilinkA->y,NULL);CHKERRQ(ierr); 1156443836d0SMatthew G Knepley ierr = KSPSolve(kspA,ilinkA->x,ilinkA->y);CHKERRQ(ierr); 11579df09d43SBarry Smith ierr = PetscLogEventEnd(ilinkA->event,kspA,ilinkA->x,ilinkA->y,NULL);CHKERRQ(ierr); 1158443836d0SMatthew G Knepley } else { 11599df09d43SBarry Smith ierr = PetscLogEventBegin(ilinkA->event,kspA,ilinkA->x,ilinkA->y,NULL);CHKERRQ(ierr); 1160443836d0SMatthew G Knepley ierr = KSPSolve(kspA,ilinkA->x,ilinkA->y);CHKERRQ(ierr); 11619df09d43SBarry Smith ierr = PetscLogEventEnd(ilinkA->event,kspA,ilinkA->x,ilinkA->y,NULL);CHKERRQ(ierr); 1162443836d0SMatthew G Knepley ierr = MatMult(jac->B,ilinkD->y,ilinkA->x);CHKERRQ(ierr); 11639df09d43SBarry Smith ierr = PetscLogEventBegin(KSP_Solve_FS_U,kspUpper,ilinkA->x,ilinkA->z,NULL);CHKERRQ(ierr); 1164443836d0SMatthew G Knepley ierr = KSPSolve(kspUpper,ilinkA->x,ilinkA->z);CHKERRQ(ierr); 11659df09d43SBarry Smith ierr = PetscLogEventEnd(KSP_Solve_FS_U,kspUpper,ilinkA->x,ilinkA->z,NULL);CHKERRQ(ierr); 1166443836d0SMatthew G Knepley ierr = VecAXPY(ilinkA->y,-1.0,ilinkA->z);CHKERRQ(ierr); 1167443836d0SMatthew G Knepley } 1168c238f8cdSStefano Zampini ierr = VecScatterEnd(ilinkD->sctx,ilinkD->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr); 11693b224e63SBarry Smith ierr = VecScatterBegin(ilinkA->sctx,ilinkA->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr); 11703b224e63SBarry Smith ierr = VecScatterEnd(ilinkA->sctx,ilinkA->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr); 1171c5d2311dSJed Brown } 11723b224e63SBarry Smith PetscFunctionReturn(0); 11733b224e63SBarry Smith } 11743b224e63SBarry Smith 11750971522cSBarry Smith static PetscErrorCode PCApply_FieldSplit(PC pc,Vec x,Vec y) 11760971522cSBarry Smith { 11770971522cSBarry Smith PC_FieldSplit *jac = (PC_FieldSplit*)pc->data; 11780971522cSBarry Smith PetscErrorCode ierr; 11795a9f2f41SSatish Balay PC_FieldSplitLink ilink = jac->head; 1180939b8a20SBarry Smith PetscInt cnt,bs; 1181568ed31eSHong Zhang KSPConvergedReason reason; 11820971522cSBarry Smith 11830971522cSBarry Smith PetscFunctionBegin; 118479416396SBarry Smith if (jac->type == PC_COMPOSITE_ADDITIVE) { 11851b9fc7fcSBarry Smith if (jac->defaultsplit) { 1186939b8a20SBarry Smith ierr = VecGetBlockSize(x,&bs);CHKERRQ(ierr); 1187ce94432eSBarry Smith if (jac->bs > 0 && bs != jac->bs) SETERRQ2(PetscObjectComm((PetscObject)pc),PETSC_ERR_ARG_WRONGSTATE,"Blocksize of x vector %D does not match fieldsplit blocksize %D",bs,jac->bs); 1188939b8a20SBarry Smith ierr = VecGetBlockSize(y,&bs);CHKERRQ(ierr); 1189ce94432eSBarry Smith if (jac->bs > 0 && bs != jac->bs) SETERRQ2(PetscObjectComm((PetscObject)pc),PETSC_ERR_ARG_WRONGSTATE,"Blocksize of y vector %D does not match fieldsplit blocksize %D",bs,jac->bs); 11900971522cSBarry Smith ierr = VecStrideGatherAll(x,jac->x,INSERT_VALUES);CHKERRQ(ierr); 11915a9f2f41SSatish Balay while (ilink) { 11929df09d43SBarry Smith ierr = PetscLogEventBegin(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL);CHKERRQ(ierr); 11935a9f2f41SSatish Balay ierr = KSPSolve(ilink->ksp,ilink->x,ilink->y);CHKERRQ(ierr); 11949df09d43SBarry Smith ierr = PetscLogEventEnd(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL);CHKERRQ(ierr); 1195568ed31eSHong Zhang ierr = KSPGetConvergedReason(ilink->ksp,&reason);CHKERRQ(ierr); 1196568ed31eSHong Zhang if (reason == KSP_DIVERGED_PCSETUP_FAILED) { 1197568ed31eSHong Zhang pc->failedreason = PC_SUBPC_ERROR; 1198568ed31eSHong Zhang } 11995a9f2f41SSatish Balay ilink = ilink->next; 12000971522cSBarry Smith } 12010971522cSBarry Smith ierr = VecStrideScatterAll(jac->y,y,INSERT_VALUES);CHKERRQ(ierr); 12021b9fc7fcSBarry Smith } else { 1203efb30889SBarry Smith ierr = VecSet(y,0.0);CHKERRQ(ierr); 12045a9f2f41SSatish Balay while (ilink) { 12055a9f2f41SSatish Balay ierr = FieldSplitSplitSolveAdd(ilink,x,y);CHKERRQ(ierr); 1206568ed31eSHong Zhang ierr = KSPGetConvergedReason(ilink->ksp,&reason);CHKERRQ(ierr); 1207568ed31eSHong Zhang if (reason == KSP_DIVERGED_PCSETUP_FAILED) { 1208568ed31eSHong Zhang pc->failedreason = PC_SUBPC_ERROR; 1209568ed31eSHong Zhang } 12105a9f2f41SSatish Balay ilink = ilink->next; 12111b9fc7fcSBarry Smith } 12121b9fc7fcSBarry Smith } 1213e52d2c62SBarry Smith } else if (jac->type == PC_COMPOSITE_MULTIPLICATIVE && jac->nsplits == 2) { 1214e52d2c62SBarry Smith ierr = VecSet(y,0.0);CHKERRQ(ierr); 1215e52d2c62SBarry Smith /* solve on first block for first block variables */ 1216e52d2c62SBarry Smith ierr = VecScatterBegin(ilink->sctx,x,ilink->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr); 1217e52d2c62SBarry Smith ierr = VecScatterEnd(ilink->sctx,x,ilink->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr); 12189df09d43SBarry Smith ierr = PetscLogEventBegin(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL);CHKERRQ(ierr); 1219e52d2c62SBarry Smith ierr = KSPSolve(ilink->ksp,ilink->x,ilink->y);CHKERRQ(ierr); 12209df09d43SBarry Smith ierr = PetscLogEventEnd(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL);CHKERRQ(ierr); 1221568ed31eSHong Zhang ierr = KSPGetConvergedReason(ilink->ksp,&reason);CHKERRQ(ierr); 1222568ed31eSHong Zhang if (reason == KSP_DIVERGED_PCSETUP_FAILED) { 1223568ed31eSHong Zhang pc->failedreason = PC_SUBPC_ERROR; 1224568ed31eSHong Zhang } 1225e52d2c62SBarry Smith ierr = VecScatterBegin(ilink->sctx,ilink->y,y,ADD_VALUES,SCATTER_REVERSE);CHKERRQ(ierr); 1226e52d2c62SBarry Smith ierr = VecScatterEnd(ilink->sctx,ilink->y,y,ADD_VALUES,SCATTER_REVERSE);CHKERRQ(ierr); 1227e52d2c62SBarry Smith 1228e52d2c62SBarry Smith /* compute the residual only onto second block variables using first block variables */ 1229e52d2c62SBarry Smith ierr = MatMult(jac->Afield[1],ilink->y,ilink->next->x);CHKERRQ(ierr); 1230e52d2c62SBarry Smith ilink = ilink->next; 1231e52d2c62SBarry Smith ierr = VecScale(ilink->x,-1.0);CHKERRQ(ierr); 1232e52d2c62SBarry Smith ierr = VecScatterBegin(ilink->sctx,x,ilink->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr); 1233e52d2c62SBarry Smith ierr = VecScatterEnd(ilink->sctx,x,ilink->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr); 1234e52d2c62SBarry Smith 1235e52d2c62SBarry Smith /* solve on second block variables */ 12369df09d43SBarry Smith ierr = PetscLogEventBegin(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL);CHKERRQ(ierr); 1237e52d2c62SBarry Smith ierr = KSPSolve(ilink->ksp,ilink->x,ilink->y);CHKERRQ(ierr); 12389df09d43SBarry Smith ierr = PetscLogEventEnd(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL);CHKERRQ(ierr); 1239568ed31eSHong Zhang ierr = KSPGetConvergedReason(ilink->ksp,&reason);CHKERRQ(ierr); 1240568ed31eSHong Zhang if (reason == KSP_DIVERGED_PCSETUP_FAILED) { 1241568ed31eSHong Zhang pc->failedreason = PC_SUBPC_ERROR; 1242568ed31eSHong Zhang } 1243e52d2c62SBarry Smith ierr = VecScatterBegin(ilink->sctx,ilink->y,y,ADD_VALUES,SCATTER_REVERSE);CHKERRQ(ierr); 1244e52d2c62SBarry Smith ierr = VecScatterEnd(ilink->sctx,ilink->y,y,ADD_VALUES,SCATTER_REVERSE);CHKERRQ(ierr); 124516913363SBarry Smith } else if (jac->type == PC_COMPOSITE_MULTIPLICATIVE || jac->type == PC_COMPOSITE_SYMMETRIC_MULTIPLICATIVE) { 124679416396SBarry Smith if (!jac->w1) { 124779416396SBarry Smith ierr = VecDuplicate(x,&jac->w1);CHKERRQ(ierr); 124879416396SBarry Smith ierr = VecDuplicate(x,&jac->w2);CHKERRQ(ierr); 124979416396SBarry Smith } 1250efb30889SBarry Smith ierr = VecSet(y,0.0);CHKERRQ(ierr); 12515a9f2f41SSatish Balay ierr = FieldSplitSplitSolveAdd(ilink,x,y);CHKERRQ(ierr); 1252568ed31eSHong Zhang ierr = KSPGetConvergedReason(ilink->ksp,&reason);CHKERRQ(ierr); 1253568ed31eSHong Zhang if (reason == KSP_DIVERGED_PCSETUP_FAILED) { 1254568ed31eSHong Zhang pc->failedreason = PC_SUBPC_ERROR; 1255568ed31eSHong Zhang } 12563e197d65SBarry Smith cnt = 1; 12575a9f2f41SSatish Balay while (ilink->next) { 12585a9f2f41SSatish Balay ilink = ilink->next; 12593e197d65SBarry Smith /* compute the residual only over the part of the vector needed */ 12603e197d65SBarry Smith ierr = MatMult(jac->Afield[cnt++],y,ilink->x);CHKERRQ(ierr); 12613e197d65SBarry Smith ierr = VecScale(ilink->x,-1.0);CHKERRQ(ierr); 12623e197d65SBarry Smith ierr = VecScatterBegin(ilink->sctx,x,ilink->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr); 12633e197d65SBarry Smith ierr = VecScatterEnd(ilink->sctx,x,ilink->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr); 12649df09d43SBarry Smith ierr = PetscLogEventBegin(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL);CHKERRQ(ierr); 12653e197d65SBarry Smith ierr = KSPSolve(ilink->ksp,ilink->x,ilink->y);CHKERRQ(ierr); 12669df09d43SBarry Smith ierr = PetscLogEventEnd(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL);CHKERRQ(ierr); 12672618eb8fSHong Zhang ierr = KSPGetConvergedReason(ilink->ksp,&reason);CHKERRQ(ierr); 12682618eb8fSHong Zhang if (reason == KSP_DIVERGED_PCSETUP_FAILED) { 12692618eb8fSHong Zhang pc->failedreason = PC_SUBPC_ERROR; 12702618eb8fSHong Zhang } 12713e197d65SBarry Smith ierr = VecScatterBegin(ilink->sctx,ilink->y,y,ADD_VALUES,SCATTER_REVERSE);CHKERRQ(ierr); 12723e197d65SBarry Smith ierr = VecScatterEnd(ilink->sctx,ilink->y,y,ADD_VALUES,SCATTER_REVERSE);CHKERRQ(ierr); 12733e197d65SBarry Smith } 127451f519a2SBarry Smith if (jac->type == PC_COMPOSITE_SYMMETRIC_MULTIPLICATIVE) { 127511755939SBarry Smith cnt -= 2; 127651f519a2SBarry Smith while (ilink->previous) { 127751f519a2SBarry Smith ilink = ilink->previous; 127811755939SBarry Smith /* compute the residual only over the part of the vector needed */ 127911755939SBarry Smith ierr = MatMult(jac->Afield[cnt--],y,ilink->x);CHKERRQ(ierr); 128011755939SBarry Smith ierr = VecScale(ilink->x,-1.0);CHKERRQ(ierr); 128111755939SBarry Smith ierr = VecScatterBegin(ilink->sctx,x,ilink->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr); 128211755939SBarry Smith ierr = VecScatterEnd(ilink->sctx,x,ilink->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr); 12839df09d43SBarry Smith ierr = PetscLogEventBegin(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL);CHKERRQ(ierr); 128411755939SBarry Smith ierr = KSPSolve(ilink->ksp,ilink->x,ilink->y);CHKERRQ(ierr); 12859df09d43SBarry Smith ierr = PetscLogEventEnd(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL);CHKERRQ(ierr); 1286568ed31eSHong Zhang ierr = KSPGetConvergedReason(ilink->ksp,&reason);CHKERRQ(ierr); 1287568ed31eSHong Zhang if (reason == KSP_DIVERGED_PCSETUP_FAILED) { 1288568ed31eSHong Zhang pc->failedreason = PC_SUBPC_ERROR; 1289568ed31eSHong Zhang } 129011755939SBarry Smith ierr = VecScatterBegin(ilink->sctx,ilink->y,y,ADD_VALUES,SCATTER_REVERSE);CHKERRQ(ierr); 129111755939SBarry Smith ierr = VecScatterEnd(ilink->sctx,ilink->y,y,ADD_VALUES,SCATTER_REVERSE);CHKERRQ(ierr); 129251f519a2SBarry Smith } 129311755939SBarry Smith } 1294ce94432eSBarry Smith } else SETERRQ1(PetscObjectComm((PetscObject)pc),PETSC_ERR_SUP,"Unsupported or unknown composition",(int) jac->type); 12950971522cSBarry Smith PetscFunctionReturn(0); 12960971522cSBarry Smith } 12970971522cSBarry Smith 1298a51937d4SCarola Kruse 1299a51937d4SCarola Kruse static PetscErrorCode PCApply_FieldSplit_GKB(PC pc,Vec x,Vec y) 1300a51937d4SCarola Kruse { 1301a51937d4SCarola Kruse PC_FieldSplit *jac = (PC_FieldSplit*)pc->data; 1302a51937d4SCarola Kruse PetscErrorCode ierr; 1303a51937d4SCarola Kruse PC_FieldSplitLink ilinkA = jac->head,ilinkD = ilinkA->next; 1304a51937d4SCarola Kruse KSP ksp = ilinkA->ksp; 1305de482cd7SCarola Kruse Vec u,v,Hu,d,work1,work2; 1306e071a0a4SCarola Kruse PetscScalar alpha,z,nrmz2,*vecz; 1307e071a0a4SCarola Kruse PetscReal lowbnd,nu,beta; 1308a51937d4SCarola Kruse PetscInt j,iterGKB; 1309a51937d4SCarola Kruse 1310a51937d4SCarola Kruse PetscFunctionBegin; 1311a51937d4SCarola Kruse ierr = VecScatterBegin(ilinkA->sctx,x,ilinkA->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr); 1312a51937d4SCarola Kruse ierr = VecScatterBegin(ilinkD->sctx,x,ilinkD->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr); 1313de482cd7SCarola Kruse ierr = VecScatterEnd(ilinkA->sctx,x,ilinkA->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr); 1314a51937d4SCarola Kruse ierr = VecScatterEnd(ilinkD->sctx,x,ilinkD->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr); 1315e071a0a4SCarola Kruse 1316e071a0a4SCarola Kruse u = jac->u; 1317e071a0a4SCarola Kruse v = jac->v; 1318e071a0a4SCarola Kruse Hu = jac->Hu; 1319e071a0a4SCarola Kruse d = jac->d; 1320e071a0a4SCarola Kruse work1 = jac->w1; 1321e071a0a4SCarola Kruse work2 = jac->w2; 1322e071a0a4SCarola Kruse vecz = jac->vecz; 1323a51937d4SCarola Kruse 1324a51937d4SCarola Kruse /* Change RHS to comply with matrix regularization H = A + nu*B*B' */ 1325a51937d4SCarola Kruse /* Add q = q + nu*B*b */ 1326a51937d4SCarola Kruse if (jac->gkbnu) { 1327a51937d4SCarola Kruse nu = jac->gkbnu; 1328de482cd7SCarola Kruse ierr = VecScale(ilinkD->x,jac->gkbnu);CHKERRQ(ierr); 1329de482cd7SCarola Kruse ierr = MatMultAdd(jac->B,ilinkD->x,ilinkA->x,ilinkA->x);CHKERRQ(ierr); /* q = q + nu*B*b */ 1330a51937d4SCarola Kruse } else { 1331a51937d4SCarola Kruse /* Situation when no augmented Lagrangian is used. Then we set inner */ 1332a51937d4SCarola Kruse /* matrix N = I in [Ar13], and thus nu = 1. */ 1333a51937d4SCarola Kruse nu = 1; 1334a51937d4SCarola Kruse } 1335a51937d4SCarola Kruse 1336a51937d4SCarola Kruse /* Transform rhs from [q,tilde{b}] to [0,b] */ 1337de482cd7SCarola Kruse ierr = PetscLogEventBegin(ilinkA->event,ksp,ilinkA->x,ilinkA->y,NULL);CHKERRQ(ierr); 1338de482cd7SCarola Kruse ierr = KSPSolve(ksp,ilinkA->x,ilinkA->y);CHKERRQ(ierr); 1339de482cd7SCarola Kruse ierr = PetscLogEventEnd(ilinkA->event,ksp,ilinkA->x,ilinkA->y,NULL);CHKERRQ(ierr); 1340a51937d4SCarola Kruse ierr = MatMultHermitianTranspose(jac->B,ilinkA->y,work1);CHKERRQ(ierr); 1341*92c1e38eSCarola Kruse ierr = VecAXPBY(work1,1.0/nu,-1.0,ilinkD->x);CHKERRQ(ierr); /* c = b - B'*x */ 1342a51937d4SCarola Kruse 1343a51937d4SCarola Kruse /* First step of algorithm */ 1344de482cd7SCarola Kruse ierr = VecNorm(work1,NORM_2,&beta);CHKERRQ(ierr); /* beta = sqrt(nu*c'*c)*/ 1345e071a0a4SCarola Kruse KSPCheckDot(ksp,beta); 1346de482cd7SCarola Kruse beta = PetscSqrtScalar(nu)*beta; 1347*92c1e38eSCarola Kruse ierr = VecAXPBY(v,nu/beta,0.0,work1);CHKERRQ(ierr); /* v = nu/beta *c */ 1348a51937d4SCarola Kruse ierr = MatMult(jac->B,v,work2);CHKERRQ(ierr); /* u = H^{-1}*B*v */ 1349a51937d4SCarola Kruse ierr = PetscLogEventBegin(ilinkA->event,ksp,work2,u,NULL);CHKERRQ(ierr); 1350a51937d4SCarola Kruse ierr = KSPSolve(ksp,work2,u);CHKERRQ(ierr); 1351a51937d4SCarola Kruse ierr = PetscLogEventEnd(ilinkA->event,ksp,work2,u,NULL);CHKERRQ(ierr); 1352a51937d4SCarola Kruse ierr = MatMult(jac->H,u,Hu);CHKERRQ(ierr); /* alpha = u'*H*u */ 1353a51937d4SCarola Kruse ierr = VecDot(Hu,u,&alpha);CHKERRQ(ierr); 1354e071a0a4SCarola Kruse KSPCheckDot(ksp,alpha); 1355e071a0a4SCarola Kruse if (PetscRealPart(alpha) <= 0.0) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_NOT_CONVERGED,"GKB preconditioner diverged, H is not positive definite"); 1356de482cd7SCarola Kruse alpha = PetscSqrtScalar(PetscAbsScalar(alpha)); 1357*92c1e38eSCarola Kruse ierr = VecScale(u,1.0/alpha);CHKERRQ(ierr); 1358*92c1e38eSCarola Kruse ierr = VecAXPBY(d,1.0/alpha,0.0,v);CHKERRQ(ierr); /* v = nu/beta *c */ 1359de482cd7SCarola Kruse 1360a51937d4SCarola Kruse z = beta/alpha; 1361a51937d4SCarola Kruse vecz[1] = z; 1362a51937d4SCarola Kruse 1363de482cd7SCarola Kruse /* Computation of first iterate x(1) and p(1) */ 1364a51937d4SCarola Kruse ierr = VecAXPY(ilinkA->y,z,u);CHKERRQ(ierr); 1365a51937d4SCarola Kruse ierr = VecCopy(d,ilinkD->y);CHKERRQ(ierr); 1366a51937d4SCarola Kruse ierr = VecScale(ilinkD->y,-z);CHKERRQ(ierr); 1367a51937d4SCarola Kruse 1368a51937d4SCarola Kruse iterGKB = 1; lowbnd = 2*jac->gkbtol; 1369de482cd7SCarola Kruse if (jac->gkbmonitor) { 1370de482cd7SCarola Kruse ierr = PetscViewerASCIIPrintf(jac->gkbviewer,"%3D GKB Lower bound estimate %14.12e\n",iterGKB,lowbnd);CHKERRQ(ierr); 1371de482cd7SCarola Kruse } 1372de482cd7SCarola Kruse 1373a51937d4SCarola Kruse while (iterGKB < jac->gkbmaxit && lowbnd > jac->gkbtol) { 1374a51937d4SCarola Kruse iterGKB += 1; 1375e071a0a4SCarola Kruse ierr = MatMultHermitianTranspose(jac->B,u,work1);CHKERRQ(ierr); /* v <- nu*(B'*u-alpha/nu*v) */ 1376e071a0a4SCarola Kruse ierr = VecAXPBY(v,nu,-alpha,work1);CHKERRQ(ierr); 1377e071a0a4SCarola Kruse ierr = VecNorm(v,NORM_2,&beta);CHKERRQ(ierr); /* beta = sqrt(nu)*v'*v */ 1378de482cd7SCarola Kruse beta = beta/PetscSqrtScalar(nu); 1379*92c1e38eSCarola Kruse ierr = VecScale(v,1.0/beta);CHKERRQ(ierr); 1380e071a0a4SCarola Kruse ierr = MatMult(jac->B,v,work2);CHKERRQ(ierr); /* u <- H^{-1}*(B*v-beta*H*u) */ 1381a51937d4SCarola Kruse ierr = MatMult(jac->H,u,Hu);CHKERRQ(ierr); 1382a51937d4SCarola Kruse ierr = VecAXPY(work2,-beta,Hu);CHKERRQ(ierr); 1383a51937d4SCarola Kruse ierr = PetscLogEventBegin(ilinkA->event,ksp,work2,u,NULL);CHKERRQ(ierr); 1384a51937d4SCarola Kruse ierr = KSPSolve(ksp,work2,u);CHKERRQ(ierr); 1385a51937d4SCarola Kruse ierr = PetscLogEventEnd(ilinkA->event,ksp,work2,u,NULL);CHKERRQ(ierr); 1386a51937d4SCarola Kruse ierr = MatMult(jac->H,u,Hu);CHKERRQ(ierr); /* alpha = u'*H*u */ 1387a51937d4SCarola Kruse ierr = VecDot(Hu,u,&alpha);CHKERRQ(ierr); 1388e071a0a4SCarola Kruse KSPCheckDot(ksp,alpha); 1389e071a0a4SCarola Kruse if (PetscRealPart(alpha) <= 0.0) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_NOT_CONVERGED,"GKB preconditioner diverged, H is not positive definite"); 1390de482cd7SCarola Kruse alpha = PetscSqrtScalar(PetscAbsScalar(alpha)); 1391*92c1e38eSCarola Kruse ierr = VecScale(u,1.0/alpha);CHKERRQ(ierr); 1392a51937d4SCarola Kruse 1393e071a0a4SCarola Kruse z = -beta/alpha*z; /* z <- beta/alpha*z */ 1394a51937d4SCarola Kruse vecz[0] = z; 1395a51937d4SCarola Kruse 1396a51937d4SCarola Kruse /* Computation of new iterate x(i+1) and p(i+1) */ 1397*92c1e38eSCarola Kruse ierr = VecAXPBY(d,1.0/alpha,-beta/alpha,v);CHKERRQ(ierr); /* d = (v-beta*d)/alpha */ 1398a51937d4SCarola Kruse ierr = VecAXPY(ilinkA->y,z,u);CHKERRQ(ierr); /* r = r + z*u */ 1399a51937d4SCarola Kruse ierr = VecAXPY(ilinkD->y,-z,d);CHKERRQ(ierr); /* p = p - z*d */ 1400de482cd7SCarola Kruse ierr = MatMult(jac->H,ilinkA->y,Hu);CHKERRQ(ierr); /* ||u||_H = u'*H*u */ 1401a51937d4SCarola Kruse ierr = VecDot(Hu,ilinkA->y,&nrmz2);CHKERRQ(ierr); 1402a51937d4SCarola Kruse 1403a51937d4SCarola Kruse /* Compute Lower Bound estimate */ 1404a51937d4SCarola Kruse if (iterGKB > jac->gkbdelay) { 1405a51937d4SCarola Kruse lowbnd = 0.0; 1406a51937d4SCarola Kruse for (j=0; j<jac->gkbdelay; j++) { 1407a51937d4SCarola Kruse lowbnd += PetscAbsScalar(vecz[j]*vecz[j]); 1408a51937d4SCarola Kruse } 1409a51937d4SCarola Kruse lowbnd = PetscSqrtScalar(lowbnd/PetscAbsScalar(nrmz2)); 1410a51937d4SCarola Kruse } 1411a51937d4SCarola Kruse 1412a51937d4SCarola Kruse for (j=0; j<jac->gkbdelay-1; j++) { 1413a51937d4SCarola Kruse vecz[jac->gkbdelay-j-1] = vecz[jac->gkbdelay-j-2]; 1414a51937d4SCarola Kruse } 1415de482cd7SCarola Kruse if (jac->gkbmonitor) { 1416de482cd7SCarola Kruse ierr = PetscViewerASCIIPrintf(jac->gkbviewer,"%3D GKB Lower bound estimate %14.12e\n",iterGKB,lowbnd);CHKERRQ(ierr); 1417de482cd7SCarola Kruse } 1418a51937d4SCarola Kruse } 1419a51937d4SCarola Kruse 1420a51937d4SCarola Kruse ierr = VecScatterBegin(ilinkA->sctx,ilinkA->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr); 1421a51937d4SCarola Kruse ierr = VecScatterBegin(ilinkD->sctx,ilinkD->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr); 1422de482cd7SCarola Kruse ierr = VecScatterEnd(ilinkA->sctx,ilinkA->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr); 1423a51937d4SCarola Kruse ierr = VecScatterEnd(ilinkD->sctx,ilinkD->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr); 1424a51937d4SCarola Kruse 1425a51937d4SCarola Kruse PetscFunctionReturn(0); 1426a51937d4SCarola Kruse } 1427a51937d4SCarola Kruse 1428a51937d4SCarola Kruse 1429421e10b8SBarry Smith #define FieldSplitSplitSolveAddTranspose(ilink,xx,yy) \ 1430ca9f406cSSatish Balay (VecScatterBegin(ilink->sctx,xx,ilink->y,INSERT_VALUES,SCATTER_FORWARD) || \ 1431ca9f406cSSatish Balay VecScatterEnd(ilink->sctx,xx,ilink->y,INSERT_VALUES,SCATTER_FORWARD) || \ 14329df09d43SBarry Smith PetscLogEventBegin(ilink->event,ilink->ksp,ilink->y,ilink->x,NULL) || \ 1433421e10b8SBarry Smith KSPSolveTranspose(ilink->ksp,ilink->y,ilink->x) || \ 14349df09d43SBarry Smith PetscLogEventBegin(ilink->event,ilink->ksp,ilink->y,ilink->x,NULL) || \ 1435ca9f406cSSatish Balay VecScatterBegin(ilink->sctx,ilink->x,yy,ADD_VALUES,SCATTER_REVERSE) || \ 1436ca9f406cSSatish Balay VecScatterEnd(ilink->sctx,ilink->x,yy,ADD_VALUES,SCATTER_REVERSE)) 1437421e10b8SBarry Smith 1438421e10b8SBarry Smith static PetscErrorCode PCApplyTranspose_FieldSplit(PC pc,Vec x,Vec y) 1439421e10b8SBarry Smith { 1440421e10b8SBarry Smith PC_FieldSplit *jac = (PC_FieldSplit*)pc->data; 1441421e10b8SBarry Smith PetscErrorCode ierr; 1442421e10b8SBarry Smith PC_FieldSplitLink ilink = jac->head; 1443939b8a20SBarry Smith PetscInt bs; 1444291dd214SHong Zhang KSPConvergedReason reason; 1445421e10b8SBarry Smith 1446421e10b8SBarry Smith PetscFunctionBegin; 1447421e10b8SBarry Smith if (jac->type == PC_COMPOSITE_ADDITIVE) { 1448421e10b8SBarry Smith if (jac->defaultsplit) { 1449939b8a20SBarry Smith ierr = VecGetBlockSize(x,&bs);CHKERRQ(ierr); 1450ce94432eSBarry Smith if (jac->bs > 0 && bs != jac->bs) SETERRQ2(PetscObjectComm((PetscObject)pc),PETSC_ERR_ARG_WRONGSTATE,"Blocksize of x vector %D does not match fieldsplit blocksize %D",bs,jac->bs); 1451939b8a20SBarry Smith ierr = VecGetBlockSize(y,&bs);CHKERRQ(ierr); 1452ce94432eSBarry Smith if (jac->bs > 0 && bs != jac->bs) SETERRQ2(PetscObjectComm((PetscObject)pc),PETSC_ERR_ARG_WRONGSTATE,"Blocksize of y vector %D does not match fieldsplit blocksize %D",bs,jac->bs); 1453421e10b8SBarry Smith ierr = VecStrideGatherAll(x,jac->x,INSERT_VALUES);CHKERRQ(ierr); 1454421e10b8SBarry Smith while (ilink) { 14559df09d43SBarry Smith ierr = PetscLogEventBegin(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL);CHKERRQ(ierr); 1456421e10b8SBarry Smith ierr = KSPSolveTranspose(ilink->ksp,ilink->x,ilink->y);CHKERRQ(ierr); 14579df09d43SBarry Smith ierr = PetscLogEventEnd(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL);CHKERRQ(ierr); 14582618eb8fSHong Zhang ierr = KSPGetConvergedReason(ilink->ksp,&reason);CHKERRQ(ierr); 14592618eb8fSHong Zhang if (reason == KSP_DIVERGED_PCSETUP_FAILED) { 14602618eb8fSHong Zhang pc->failedreason = PC_SUBPC_ERROR; 14612618eb8fSHong Zhang } 1462421e10b8SBarry Smith ilink = ilink->next; 1463421e10b8SBarry Smith } 1464421e10b8SBarry Smith ierr = VecStrideScatterAll(jac->y,y,INSERT_VALUES);CHKERRQ(ierr); 1465421e10b8SBarry Smith } else { 1466421e10b8SBarry Smith ierr = VecSet(y,0.0);CHKERRQ(ierr); 1467421e10b8SBarry Smith while (ilink) { 1468421e10b8SBarry Smith ierr = FieldSplitSplitSolveAddTranspose(ilink,x,y);CHKERRQ(ierr); 14692618eb8fSHong Zhang ierr = KSPGetConvergedReason(ilink->ksp,&reason);CHKERRQ(ierr); 14702618eb8fSHong Zhang if (reason == KSP_DIVERGED_PCSETUP_FAILED) { 14712618eb8fSHong Zhang pc->failedreason = PC_SUBPC_ERROR; 14722618eb8fSHong Zhang } 1473421e10b8SBarry Smith ilink = ilink->next; 1474421e10b8SBarry Smith } 1475421e10b8SBarry Smith } 1476421e10b8SBarry Smith } else { 1477421e10b8SBarry Smith if (!jac->w1) { 1478421e10b8SBarry Smith ierr = VecDuplicate(x,&jac->w1);CHKERRQ(ierr); 1479421e10b8SBarry Smith ierr = VecDuplicate(x,&jac->w2);CHKERRQ(ierr); 1480421e10b8SBarry Smith } 1481421e10b8SBarry Smith ierr = VecSet(y,0.0);CHKERRQ(ierr); 1482421e10b8SBarry Smith if (jac->type == PC_COMPOSITE_SYMMETRIC_MULTIPLICATIVE) { 1483421e10b8SBarry Smith ierr = FieldSplitSplitSolveAddTranspose(ilink,x,y);CHKERRQ(ierr); 14842618eb8fSHong Zhang ierr = KSPGetConvergedReason(ilink->ksp,&reason);CHKERRQ(ierr); 14852618eb8fSHong Zhang if (reason == KSP_DIVERGED_PCSETUP_FAILED) { 14862618eb8fSHong Zhang pc->failedreason = PC_SUBPC_ERROR; 14872618eb8fSHong Zhang } 1488421e10b8SBarry Smith while (ilink->next) { 1489421e10b8SBarry Smith ilink = ilink->next; 14909989ab13SBarry Smith ierr = MatMultTranspose(pc->mat,y,jac->w1);CHKERRQ(ierr); 1491421e10b8SBarry Smith ierr = VecWAXPY(jac->w2,-1.0,jac->w1,x);CHKERRQ(ierr); 1492421e10b8SBarry Smith ierr = FieldSplitSplitSolveAddTranspose(ilink,jac->w2,y);CHKERRQ(ierr); 1493421e10b8SBarry Smith } 1494421e10b8SBarry Smith while (ilink->previous) { 1495421e10b8SBarry Smith ilink = ilink->previous; 14969989ab13SBarry Smith ierr = MatMultTranspose(pc->mat,y,jac->w1);CHKERRQ(ierr); 1497421e10b8SBarry Smith ierr = VecWAXPY(jac->w2,-1.0,jac->w1,x);CHKERRQ(ierr); 1498421e10b8SBarry Smith ierr = FieldSplitSplitSolveAddTranspose(ilink,jac->w2,y);CHKERRQ(ierr); 1499421e10b8SBarry Smith } 1500421e10b8SBarry Smith } else { 1501421e10b8SBarry Smith while (ilink->next) { /* get to last entry in linked list */ 1502421e10b8SBarry Smith ilink = ilink->next; 1503421e10b8SBarry Smith } 1504421e10b8SBarry Smith ierr = FieldSplitSplitSolveAddTranspose(ilink,x,y);CHKERRQ(ierr); 15052618eb8fSHong Zhang ierr = KSPGetConvergedReason(ilink->ksp,&reason);CHKERRQ(ierr); 15062618eb8fSHong Zhang if (reason == KSP_DIVERGED_PCSETUP_FAILED) { 15072618eb8fSHong Zhang pc->failedreason = PC_SUBPC_ERROR; 15082618eb8fSHong Zhang } 1509421e10b8SBarry Smith while (ilink->previous) { 1510421e10b8SBarry Smith ilink = ilink->previous; 15119989ab13SBarry Smith ierr = MatMultTranspose(pc->mat,y,jac->w1);CHKERRQ(ierr); 1512421e10b8SBarry Smith ierr = VecWAXPY(jac->w2,-1.0,jac->w1,x);CHKERRQ(ierr); 1513421e10b8SBarry Smith ierr = FieldSplitSplitSolveAddTranspose(ilink,jac->w2,y);CHKERRQ(ierr); 1514421e10b8SBarry Smith } 1515421e10b8SBarry Smith } 1516421e10b8SBarry Smith } 1517421e10b8SBarry Smith PetscFunctionReturn(0); 1518421e10b8SBarry Smith } 1519421e10b8SBarry Smith 1520574deadeSBarry Smith static PetscErrorCode PCReset_FieldSplit(PC pc) 15210971522cSBarry Smith { 15220971522cSBarry Smith PC_FieldSplit *jac = (PC_FieldSplit*)pc->data; 15230971522cSBarry Smith PetscErrorCode ierr; 15245a9f2f41SSatish Balay PC_FieldSplitLink ilink = jac->head,next; 15250971522cSBarry Smith 15260971522cSBarry Smith PetscFunctionBegin; 15275a9f2f41SSatish Balay while (ilink) { 1528f5f0d762SBarry Smith ierr = KSPDestroy(&ilink->ksp);CHKERRQ(ierr); 1529fcfd50ebSBarry Smith ierr = VecDestroy(&ilink->x);CHKERRQ(ierr); 1530fcfd50ebSBarry Smith ierr = VecDestroy(&ilink->y);CHKERRQ(ierr); 1531443836d0SMatthew G Knepley ierr = VecDestroy(&ilink->z);CHKERRQ(ierr); 1532fcfd50ebSBarry Smith ierr = VecScatterDestroy(&ilink->sctx);CHKERRQ(ierr); 1533fcfd50ebSBarry Smith ierr = ISDestroy(&ilink->is);CHKERRQ(ierr); 1534b5787286SJed Brown ierr = ISDestroy(&ilink->is_col);CHKERRQ(ierr); 1535f5f0d762SBarry Smith ierr = PetscFree(ilink->splitname);CHKERRQ(ierr); 1536f5f0d762SBarry Smith ierr = PetscFree(ilink->fields);CHKERRQ(ierr); 1537f5f0d762SBarry Smith ierr = PetscFree(ilink->fields_col);CHKERRQ(ierr); 15385a9f2f41SSatish Balay next = ilink->next; 1539f5f0d762SBarry Smith ierr = PetscFree(ilink);CHKERRQ(ierr); 15405a9f2f41SSatish Balay ilink = next; 15410971522cSBarry Smith } 1542f5f0d762SBarry Smith jac->head = NULL; 154305b42c5fSBarry Smith ierr = PetscFree2(jac->x,jac->y);CHKERRQ(ierr); 1544574deadeSBarry Smith if (jac->mat && jac->mat != jac->pmat) { 1545574deadeSBarry Smith ierr = MatDestroyMatrices(jac->nsplits,&jac->mat);CHKERRQ(ierr); 1546574deadeSBarry Smith } else if (jac->mat) { 15470298fd71SBarry Smith jac->mat = NULL; 1548574deadeSBarry Smith } 154997bbdb24SBarry Smith if (jac->pmat) {ierr = MatDestroyMatrices(jac->nsplits,&jac->pmat);CHKERRQ(ierr);} 155068dd23aaSBarry Smith if (jac->Afield) {ierr = MatDestroyMatrices(jac->nsplits,&jac->Afield);CHKERRQ(ierr);} 1551f5f0d762SBarry Smith jac->nsplits = 0; 15526bf464f9SBarry Smith ierr = VecDestroy(&jac->w1);CHKERRQ(ierr); 15536bf464f9SBarry Smith ierr = VecDestroy(&jac->w2);CHKERRQ(ierr); 15546bf464f9SBarry Smith ierr = MatDestroy(&jac->schur);CHKERRQ(ierr); 1555a7476a74SDmitry Karpeev ierr = MatDestroy(&jac->schurp);CHKERRQ(ierr); 15566bf464f9SBarry Smith ierr = MatDestroy(&jac->schur_user);CHKERRQ(ierr); 15576bf464f9SBarry Smith ierr = KSPDestroy(&jac->kspschur);CHKERRQ(ierr); 1558d78dad28SBarry Smith ierr = KSPDestroy(&jac->kspupper);CHKERRQ(ierr); 15596bf464f9SBarry Smith ierr = MatDestroy(&jac->B);CHKERRQ(ierr); 15606bf464f9SBarry Smith ierr = MatDestroy(&jac->C);CHKERRQ(ierr); 1561a51937d4SCarola Kruse ierr = MatDestroy(&jac->H);CHKERRQ(ierr); 1562e071a0a4SCarola Kruse ierr = VecDestroy(&jac->u);CHKERRQ(ierr); 1563e071a0a4SCarola Kruse ierr = VecDestroy(&jac->v);CHKERRQ(ierr); 1564e071a0a4SCarola Kruse ierr = VecDestroy(&jac->Hu);CHKERRQ(ierr); 1565e071a0a4SCarola Kruse ierr = VecDestroy(&jac->d);CHKERRQ(ierr); 1566e071a0a4SCarola Kruse ierr = PetscFree(jac->vecz);CHKERRQ(ierr); 1567de482cd7SCarola Kruse ierr = PetscViewerDestroy(&jac->gkbviewer);CHKERRQ(ierr); 15686dbb499eSCian Wilson jac->isrestrict = PETSC_FALSE; 1569574deadeSBarry Smith PetscFunctionReturn(0); 1570574deadeSBarry Smith } 1571574deadeSBarry Smith 1572574deadeSBarry Smith static PetscErrorCode PCDestroy_FieldSplit(PC pc) 1573574deadeSBarry Smith { 1574574deadeSBarry Smith PetscErrorCode ierr; 1575574deadeSBarry Smith 1576574deadeSBarry Smith PetscFunctionBegin; 1577574deadeSBarry Smith ierr = PCReset_FieldSplit(pc);CHKERRQ(ierr); 1578c31cb41cSBarry Smith ierr = PetscFree(pc->data);CHKERRQ(ierr); 1579285fb4e2SStefano Zampini ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSchurGetSubKSP_C",NULL);CHKERRQ(ierr); 1580bdf89e91SBarry Smith ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitGetSubKSP_C",NULL);CHKERRQ(ierr); 1581bdf89e91SBarry Smith ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetFields_C",NULL);CHKERRQ(ierr); 1582bdf89e91SBarry Smith ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetIS_C",NULL);CHKERRQ(ierr); 1583bdf89e91SBarry Smith ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetType_C",NULL);CHKERRQ(ierr); 1584bdf89e91SBarry Smith ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetBlockSize_C",NULL);CHKERRQ(ierr); 158529f8a81cSJed Brown ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetSchurPre_C",NULL);CHKERRQ(ierr); 158637a82bf0SJed Brown ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitGetSchurPre_C",NULL);CHKERRQ(ierr); 1587bdf89e91SBarry Smith ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetSchurFactType_C",NULL);CHKERRQ(ierr); 15886dbb499eSCian Wilson ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitRestrictIS_C",NULL);CHKERRQ(ierr); 15890971522cSBarry Smith PetscFunctionReturn(0); 15900971522cSBarry Smith } 15910971522cSBarry Smith 15924416b707SBarry Smith static PetscErrorCode PCSetFromOptions_FieldSplit(PetscOptionItems *PetscOptionsObject,PC pc) 15930971522cSBarry Smith { 15941b9fc7fcSBarry Smith PetscErrorCode ierr; 15956c924f48SJed Brown PetscInt bs; 15967b752e3dSPatrick Sanan PetscBool flg; 15979dcbbd2bSBarry Smith PC_FieldSplit *jac = (PC_FieldSplit*)pc->data; 15983b224e63SBarry Smith PCCompositeType ctype; 15991b9fc7fcSBarry Smith 16000971522cSBarry Smith PetscFunctionBegin; 1601e55864a3SBarry Smith ierr = PetscOptionsHead(PetscOptionsObject,"FieldSplit options");CHKERRQ(ierr); 16024ab8060aSDmitry Karpeev ierr = PetscOptionsBool("-pc_fieldsplit_dm_splits","Whether to use DMCreateFieldDecomposition() for splits","PCFieldSplitSetDMSplits",jac->dm_splits,&jac->dm_splits,NULL);CHKERRQ(ierr); 160351f519a2SBarry Smith ierr = PetscOptionsInt("-pc_fieldsplit_block_size","Blocksize that defines number of fields","PCFieldSplitSetBlockSize",jac->bs,&bs,&flg);CHKERRQ(ierr); 160451f519a2SBarry Smith if (flg) { 160551f519a2SBarry Smith ierr = PCFieldSplitSetBlockSize(pc,bs);CHKERRQ(ierr); 160651f519a2SBarry Smith } 16072686e3e9SMatthew G. Knepley jac->diag_use_amat = pc->useAmat; 16082686e3e9SMatthew G. Knepley ierr = PetscOptionsBool("-pc_fieldsplit_diag_use_amat","Use Amat (not Pmat) to extract diagonal fieldsplit blocks", "PCFieldSplitSetDiagUseAmat",jac->diag_use_amat,&jac->diag_use_amat,NULL);CHKERRQ(ierr); 16092686e3e9SMatthew G. Knepley jac->offdiag_use_amat = pc->useAmat; 16102686e3e9SMatthew G. Knepley ierr = PetscOptionsBool("-pc_fieldsplit_off_diag_use_amat","Use Amat (not Pmat) to extract off-diagonal fieldsplit blocks", "PCFieldSplitSetOffDiagUseAmat",jac->offdiag_use_amat,&jac->offdiag_use_amat,NULL);CHKERRQ(ierr); 16117b752e3dSPatrick Sanan ierr = PetscOptionsBool("-pc_fieldsplit_detect_saddle_point","Form 2-way split by detecting zero diagonal entries", "PCFieldSplitSetDetectSaddlePoint",jac->detect,&jac->detect,NULL);CHKERRQ(ierr); 16127b752e3dSPatrick Sanan ierr = PCFieldSplitSetDetectSaddlePoint(pc,jac->detect);CHKERRQ(ierr); /* Sets split type and Schur PC type */ 16133b224e63SBarry Smith ierr = PetscOptionsEnum("-pc_fieldsplit_type","Type of composition","PCFieldSplitSetType",PCCompositeTypes,(PetscEnum)jac->type,(PetscEnum*)&ctype,&flg);CHKERRQ(ierr); 16143b224e63SBarry Smith if (flg) { 16153b224e63SBarry Smith ierr = PCFieldSplitSetType(pc,ctype);CHKERRQ(ierr); 16163b224e63SBarry Smith } 1617c30613efSMatthew Knepley /* Only setup fields once */ 1618c30613efSMatthew Knepley if ((jac->bs > 0) && (jac->nsplits == 0)) { 1619d32f9abdSBarry Smith /* only allow user to set fields from command line if bs is already known. 1620d32f9abdSBarry Smith otherwise user can set them in PCFieldSplitSetDefaults() */ 16216c924f48SJed Brown ierr = PCFieldSplitSetRuntimeSplits_Private(pc);CHKERRQ(ierr); 16226c924f48SJed Brown if (jac->splitdefined) {ierr = PetscInfo(pc,"Splits defined using the options database\n");CHKERRQ(ierr);} 1623d32f9abdSBarry Smith } 1624c5d2311dSJed Brown if (jac->type == PC_COMPOSITE_SCHUR) { 1625c5929fdfSBarry Smith ierr = PetscOptionsGetEnum(((PetscObject)pc)->options,((PetscObject)pc)->prefix,"-pc_fieldsplit_schur_factorization_type",PCFieldSplitSchurFactTypes,(PetscEnum*)&jac->schurfactorization,&flg);CHKERRQ(ierr); 1626c9c6ffaaSJed Brown if (flg) {ierr = PetscInfo(pc,"Deprecated use of -pc_fieldsplit_schur_factorization_type\n");CHKERRQ(ierr);} 16270298fd71SBarry Smith ierr = PetscOptionsEnum("-pc_fieldsplit_schur_fact_type","Which off-diagonal parts of the block factorization to use","PCFieldSplitSetSchurFactType",PCFieldSplitSchurFactTypes,(PetscEnum)jac->schurfactorization,(PetscEnum*)&jac->schurfactorization,NULL);CHKERRQ(ierr); 162829f8a81cSJed Brown ierr = PetscOptionsEnum("-pc_fieldsplit_schur_precondition","How to build preconditioner for Schur complement","PCFieldSplitSetSchurPre",PCFieldSplitSchurPreTypes,(PetscEnum)jac->schurpre,(PetscEnum*)&jac->schurpre,NULL);CHKERRQ(ierr); 1629c096484dSStefano Zampini ierr = PetscOptionsScalar("-pc_fieldsplit_schur_scale","Scale Schur complement","PCFieldSplitSetSchurScale",jac->schurscale,&jac->schurscale,NULL);CHKERRQ(ierr); 1630a51937d4SCarola Kruse } else if (jac->type == PC_COMPOSITE_GKB) { 1631a51937d4SCarola Kruse ierr = PetscOptionsReal("-pc_fieldsplit_gkb_tol","The tolerance for the lower bound stopping criterion","PCFieldSplitGKBTol",jac->gkbtol,&jac->gkbtol,NULL);CHKERRQ(ierr); 1632a51937d4SCarola Kruse ierr = PetscOptionsInt("-pc_fieldsplit_gkb_delay","The delay value for lower bound criterion","PCFieldSplitGKBDelay",jac->gkbdelay,&jac->gkbdelay,NULL);CHKERRQ(ierr); 1633a51937d4SCarola Kruse ierr = PetscOptionsReal("-pc_fieldsplit_gkb_nu","Parameter in augmented Lagrangian approach","PCFieldSplitGKBNu",jac->gkbnu,&jac->gkbnu,NULL);CHKERRQ(ierr); 1634e071a0a4SCarola Kruse if (jac->gkbnu < 0) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"nu cannot be less than 0: value %f",jac->gkbnu); 1635a51937d4SCarola Kruse ierr = PetscOptionsInt("-pc_fieldsplit_gkb_maxit","Maximum allowed number of iterations","PCFieldSplitGKBMaxit",jac->gkbmaxit,&jac->gkbmaxit,NULL);CHKERRQ(ierr); 1636de482cd7SCarola Kruse ierr = PetscOptionsBool("-pc_fieldsplit_gkb_monitor","Prints number of GKB iterations and error","PCFieldSplitGKB",jac->gkbmonitor,&jac->gkbmonitor,NULL);CHKERRQ(ierr); 1637c5d2311dSJed Brown } 16381b9fc7fcSBarry Smith ierr = PetscOptionsTail();CHKERRQ(ierr); 16390971522cSBarry Smith PetscFunctionReturn(0); 16400971522cSBarry Smith } 16410971522cSBarry Smith 16420971522cSBarry Smith /*------------------------------------------------------------------------------------*/ 16430971522cSBarry Smith 16441e6b0712SBarry Smith static PetscErrorCode PCFieldSplitSetFields_FieldSplit(PC pc,const char splitname[],PetscInt n,const PetscInt *fields,const PetscInt *fields_col) 16450971522cSBarry Smith { 164697bbdb24SBarry Smith PC_FieldSplit *jac = (PC_FieldSplit*)pc->data; 16470971522cSBarry Smith PetscErrorCode ierr; 16485a9f2f41SSatish Balay PC_FieldSplitLink ilink,next = jac->head; 164969a612a9SBarry Smith char prefix[128]; 16505d4c12cdSJungho Lee PetscInt i; 16510971522cSBarry Smith 16520971522cSBarry Smith PetscFunctionBegin; 16536c924f48SJed Brown if (jac->splitdefined) { 16546c924f48SJed Brown ierr = PetscInfo1(pc,"Ignoring new split \"%s\" because the splits have already been defined\n",splitname);CHKERRQ(ierr); 16556c924f48SJed Brown PetscFunctionReturn(0); 16566c924f48SJed Brown } 165751f519a2SBarry Smith for (i=0; i<n; i++) { 1658e32f2f54SBarry 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); 1659e32f2f54SBarry Smith if (fields[i] < 0) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Negative field %D requested",fields[i]); 166051f519a2SBarry Smith } 1661b00a9115SJed Brown ierr = PetscNew(&ilink);CHKERRQ(ierr); 1662a04f6461SBarry Smith if (splitname) { 1663db4c96c1SJed Brown ierr = PetscStrallocpy(splitname,&ilink->splitname);CHKERRQ(ierr); 1664a04f6461SBarry Smith } else { 1665785e854fSJed Brown ierr = PetscMalloc1(3,&ilink->splitname);CHKERRQ(ierr); 1666a04f6461SBarry Smith ierr = PetscSNPrintf(ilink->splitname,2,"%s",jac->nsplits);CHKERRQ(ierr); 1667a04f6461SBarry Smith } 16689df09d43SBarry Smith ilink->event = jac->nsplits < 5 ? KSP_Solve_FS_0 + jac->nsplits : KSP_Solve_FS_0 + 4; /* Any split great than 4 gets logged in the 4th split */ 1669785e854fSJed Brown ierr = PetscMalloc1(n,&ilink->fields);CHKERRQ(ierr); 16705a9f2f41SSatish Balay ierr = PetscMemcpy(ilink->fields,fields,n*sizeof(PetscInt));CHKERRQ(ierr); 1671785e854fSJed Brown ierr = PetscMalloc1(n,&ilink->fields_col);CHKERRQ(ierr); 16725d4c12cdSJungho Lee ierr = PetscMemcpy(ilink->fields_col,fields_col,n*sizeof(PetscInt));CHKERRQ(ierr); 16732fa5cd67SKarl Rupp 16745a9f2f41SSatish Balay ilink->nfields = n; 16750298fd71SBarry Smith ilink->next = NULL; 1676ce94432eSBarry Smith ierr = KSPCreate(PetscObjectComm((PetscObject)pc),&ilink->ksp);CHKERRQ(ierr); 1677422a814eSBarry Smith ierr = KSPSetErrorIfNotConverged(ilink->ksp,pc->erroriffailure);CHKERRQ(ierr); 167820252d06SBarry Smith ierr = PetscObjectIncrementTabLevel((PetscObject)ilink->ksp,(PetscObject)pc,1);CHKERRQ(ierr); 16795a9f2f41SSatish Balay ierr = KSPSetType(ilink->ksp,KSPPREONLY);CHKERRQ(ierr); 16809005cf84SBarry Smith ierr = PetscLogObjectParent((PetscObject)pc,(PetscObject)ilink->ksp);CHKERRQ(ierr); 168169a612a9SBarry Smith 16828caf3d72SBarry Smith ierr = PetscSNPrintf(prefix,sizeof(prefix),"%sfieldsplit_%s_",((PetscObject)pc)->prefix ? ((PetscObject)pc)->prefix : "",ilink->splitname);CHKERRQ(ierr); 16835a9f2f41SSatish Balay ierr = KSPSetOptionsPrefix(ilink->ksp,prefix);CHKERRQ(ierr); 16840971522cSBarry Smith 16850971522cSBarry Smith if (!next) { 16865a9f2f41SSatish Balay jac->head = ilink; 16870298fd71SBarry Smith ilink->previous = NULL; 16880971522cSBarry Smith } else { 16890971522cSBarry Smith while (next->next) { 16900971522cSBarry Smith next = next->next; 16910971522cSBarry Smith } 16925a9f2f41SSatish Balay next->next = ilink; 169351f519a2SBarry Smith ilink->previous = next; 16940971522cSBarry Smith } 16950971522cSBarry Smith jac->nsplits++; 16960971522cSBarry Smith PetscFunctionReturn(0); 16970971522cSBarry Smith } 16980971522cSBarry Smith 1699285fb4e2SStefano Zampini static PetscErrorCode PCFieldSplitSchurGetSubKSP_FieldSplit(PC pc,PetscInt *n,KSP **subksp) 1700285fb4e2SStefano Zampini { 1701285fb4e2SStefano Zampini PC_FieldSplit *jac = (PC_FieldSplit*)pc->data; 1702285fb4e2SStefano Zampini PetscErrorCode ierr; 1703285fb4e2SStefano Zampini 1704285fb4e2SStefano Zampini PetscFunctionBegin; 1705285fb4e2SStefano Zampini *subksp = NULL; 1706285fb4e2SStefano Zampini if (n) *n = 0; 1707285fb4e2SStefano Zampini if (jac->type == PC_COMPOSITE_SCHUR) { 1708285fb4e2SStefano Zampini PetscInt nn; 1709285fb4e2SStefano Zampini 1710285fb4e2SStefano Zampini if (!jac->schur) SETERRQ(PetscObjectComm((PetscObject)pc),PETSC_ERR_ARG_WRONGSTATE,"Must call KSPSetUp() or PCSetUp() before calling PCFieldSplitSchurGetSubKSP()"); 1711285fb4e2SStefano Zampini if (jac->nsplits != 2) SETERRQ1(PetscObjectComm((PetscObject)pc),PETSC_ERR_PLIB,"Unexpected number of splits %D != 2",jac->nsplits); 1712285fb4e2SStefano Zampini nn = jac->nsplits + (jac->kspupper != jac->head->ksp ? 1 : 0); 1713285fb4e2SStefano Zampini ierr = PetscMalloc1(nn,subksp);CHKERRQ(ierr); 1714285fb4e2SStefano Zampini (*subksp)[0] = jac->head->ksp; 1715285fb4e2SStefano Zampini (*subksp)[1] = jac->kspschur; 1716285fb4e2SStefano Zampini if (jac->kspupper != jac->head->ksp) (*subksp)[2] = jac->kspupper; 1717285fb4e2SStefano Zampini if (n) *n = nn; 1718285fb4e2SStefano Zampini } 1719285fb4e2SStefano Zampini PetscFunctionReturn(0); 1720285fb4e2SStefano Zampini } 1721285fb4e2SStefano Zampini 17221e6b0712SBarry Smith static PetscErrorCode PCFieldSplitGetSubKSP_FieldSplit_Schur(PC pc,PetscInt *n,KSP **subksp) 1723e69d4d44SBarry Smith { 1724e69d4d44SBarry Smith PC_FieldSplit *jac = (PC_FieldSplit*)pc->data; 1725e69d4d44SBarry Smith PetscErrorCode ierr; 1726e69d4d44SBarry Smith 1727e69d4d44SBarry Smith PetscFunctionBegin; 172834a3b412SBarry Smith if (!jac->schur) SETERRQ(PetscObjectComm((PetscObject)pc),PETSC_ERR_ARG_WRONGSTATE,"Must call KSPSetUp() or PCSetUp() before calling PCFieldSplitGetSubKSP()"); 1729785e854fSJed Brown ierr = PetscMalloc1(jac->nsplits,subksp);CHKERRQ(ierr); 1730e69d4d44SBarry Smith ierr = MatSchurComplementGetKSP(jac->schur,*subksp);CHKERRQ(ierr); 17312fa5cd67SKarl Rupp 1732e69d4d44SBarry Smith (*subksp)[1] = jac->kspschur; 173313e0d083SBarry Smith if (n) *n = jac->nsplits; 1734e69d4d44SBarry Smith PetscFunctionReturn(0); 1735e69d4d44SBarry Smith } 17360971522cSBarry Smith 17371e6b0712SBarry Smith static PetscErrorCode PCFieldSplitGetSubKSP_FieldSplit(PC pc,PetscInt *n,KSP **subksp) 17380971522cSBarry Smith { 17390971522cSBarry Smith PC_FieldSplit *jac = (PC_FieldSplit*)pc->data; 17400971522cSBarry Smith PetscErrorCode ierr; 17410971522cSBarry Smith PetscInt cnt = 0; 17425a9f2f41SSatish Balay PC_FieldSplitLink ilink = jac->head; 17430971522cSBarry Smith 17440971522cSBarry Smith PetscFunctionBegin; 1745785e854fSJed Brown ierr = PetscMalloc1(jac->nsplits,subksp);CHKERRQ(ierr); 17465a9f2f41SSatish Balay while (ilink) { 17475a9f2f41SSatish Balay (*subksp)[cnt++] = ilink->ksp; 17485a9f2f41SSatish Balay ilink = ilink->next; 17490971522cSBarry Smith } 17505d480477SMatthew 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); 175113e0d083SBarry Smith if (n) *n = jac->nsplits; 17520971522cSBarry Smith PetscFunctionReturn(0); 17530971522cSBarry Smith } 17540971522cSBarry Smith 17556dbb499eSCian Wilson /*@C 17566dbb499eSCian Wilson PCFieldSplitRestrictIS - Restricts the fieldsplit ISs to be within a given IS. 17576dbb499eSCian Wilson 17586dbb499eSCian Wilson Input Parameters: 17596dbb499eSCian Wilson + pc - the preconditioner context 17606dbb499eSCian Wilson + is - the index set that defines the indices to which the fieldsplit is to be restricted 17616dbb499eSCian Wilson 17626dbb499eSCian Wilson Level: advanced 17636dbb499eSCian Wilson 17646dbb499eSCian Wilson @*/ 17656dbb499eSCian Wilson PetscErrorCode PCFieldSplitRestrictIS(PC pc,IS isy) 17666dbb499eSCian Wilson { 17676dbb499eSCian Wilson PetscErrorCode ierr; 17686dbb499eSCian Wilson 17696dbb499eSCian Wilson PetscFunctionBegin; 17706dbb499eSCian Wilson PetscValidHeaderSpecific(pc,PC_CLASSID,1); 17716dbb499eSCian Wilson PetscValidHeaderSpecific(isy,IS_CLASSID,2); 17720246f55cSBarry Smith ierr = PetscTryMethod(pc,"PCFieldSplitRestrictIS_C",(PC,IS),(pc,isy));CHKERRQ(ierr); 17736dbb499eSCian Wilson PetscFunctionReturn(0); 17746dbb499eSCian Wilson } 17756dbb499eSCian Wilson 17766dbb499eSCian Wilson 17776dbb499eSCian Wilson static PetscErrorCode PCFieldSplitRestrictIS_FieldSplit(PC pc, IS isy) 17786dbb499eSCian Wilson { 17796dbb499eSCian Wilson PC_FieldSplit *jac = (PC_FieldSplit*)pc->data; 17806dbb499eSCian Wilson PetscErrorCode ierr; 17816dbb499eSCian Wilson PC_FieldSplitLink ilink = jac->head, next; 17826dbb499eSCian Wilson PetscInt localsize,size,sizez,i; 17836dbb499eSCian Wilson const PetscInt *ind, *indz; 17846dbb499eSCian Wilson PetscInt *indc, *indcz; 17856dbb499eSCian Wilson PetscBool flg; 17866dbb499eSCian Wilson 17876dbb499eSCian Wilson PetscFunctionBegin; 17886dbb499eSCian Wilson ierr = ISGetLocalSize(isy,&localsize);CHKERRQ(ierr); 17896dbb499eSCian Wilson ierr = MPI_Scan(&localsize,&size,1,MPIU_INT,MPI_SUM,PetscObjectComm((PetscObject)isy));CHKERRQ(ierr); 17906dbb499eSCian Wilson size -= localsize; 17916dbb499eSCian Wilson while(ilink) { 17926dbb499eSCian Wilson IS isrl,isr; 17931c7cfba8SBarry Smith PC subpc; 17946dbb499eSCian Wilson ierr = ISEmbed(ilink->is, isy, PETSC_TRUE, &isrl);CHKERRQ(ierr); 17956dbb499eSCian Wilson ierr = ISGetLocalSize(isrl,&localsize);CHKERRQ(ierr); 17966dbb499eSCian Wilson ierr = PetscMalloc1(localsize,&indc);CHKERRQ(ierr); 17976dbb499eSCian Wilson ierr = ISGetIndices(isrl,&ind);CHKERRQ(ierr); 17986dbb499eSCian Wilson ierr = PetscMemcpy(indc,ind,localsize*sizeof(PetscInt));CHKERRQ(ierr); 17996dbb499eSCian Wilson ierr = ISRestoreIndices(isrl,&ind);CHKERRQ(ierr); 18006dbb499eSCian Wilson ierr = ISDestroy(&isrl);CHKERRQ(ierr); 18016dbb499eSCian Wilson for (i=0; i<localsize; i++) *(indc+i) += size; 18026dbb499eSCian Wilson ierr = ISCreateGeneral(PetscObjectComm((PetscObject)isy),localsize,indc,PETSC_OWN_POINTER,&isr);CHKERRQ(ierr); 18036dbb499eSCian Wilson ierr = PetscObjectReference((PetscObject)isr);CHKERRQ(ierr); 18046dbb499eSCian Wilson ierr = ISDestroy(&ilink->is);CHKERRQ(ierr); 18056dbb499eSCian Wilson ilink->is = isr; 18066dbb499eSCian Wilson ierr = PetscObjectReference((PetscObject)isr);CHKERRQ(ierr); 18076dbb499eSCian Wilson ierr = ISDestroy(&ilink->is_col);CHKERRQ(ierr); 18086dbb499eSCian Wilson ilink->is_col = isr; 18096dbb499eSCian Wilson ierr = ISDestroy(&isr);CHKERRQ(ierr); 18106dbb499eSCian Wilson ierr = KSPGetPC(ilink->ksp, &subpc);CHKERRQ(ierr); 18116dbb499eSCian Wilson ierr = PetscObjectTypeCompare((PetscObject)subpc,PCFIELDSPLIT,&flg);CHKERRQ(ierr); 18126dbb499eSCian Wilson if(flg) { 18136dbb499eSCian Wilson IS iszl,isz; 18146dbb499eSCian Wilson MPI_Comm comm; 18156dbb499eSCian Wilson ierr = ISGetLocalSize(ilink->is,&localsize);CHKERRQ(ierr); 18166dbb499eSCian Wilson comm = PetscObjectComm((PetscObject)ilink->is); 18176dbb499eSCian Wilson ierr = ISEmbed(isy, ilink->is, PETSC_TRUE, &iszl);CHKERRQ(ierr); 18186dbb499eSCian Wilson ierr = MPI_Scan(&localsize,&sizez,1,MPIU_INT,MPI_SUM,comm);CHKERRQ(ierr); 18196dbb499eSCian Wilson sizez -= localsize; 18206dbb499eSCian Wilson ierr = ISGetLocalSize(iszl,&localsize);CHKERRQ(ierr); 18216dbb499eSCian Wilson ierr = PetscMalloc1(localsize,&indcz);CHKERRQ(ierr); 18226dbb499eSCian Wilson ierr = ISGetIndices(iszl,&indz);CHKERRQ(ierr); 18236dbb499eSCian Wilson ierr = PetscMemcpy(indcz,indz,localsize*sizeof(PetscInt));CHKERRQ(ierr); 18246dbb499eSCian Wilson ierr = ISRestoreIndices(iszl,&indz);CHKERRQ(ierr); 18256dbb499eSCian Wilson ierr = ISDestroy(&iszl);CHKERRQ(ierr); 18266dbb499eSCian Wilson for (i=0; i<localsize; i++) *(indcz+i) += sizez; 18276dbb499eSCian Wilson ierr = ISCreateGeneral(comm,localsize,indcz,PETSC_OWN_POINTER,&isz);CHKERRQ(ierr); 18286dbb499eSCian Wilson ierr = PCFieldSplitRestrictIS(subpc,isz);CHKERRQ(ierr); 18296dbb499eSCian Wilson ierr = ISDestroy(&isz);CHKERRQ(ierr); 18306dbb499eSCian Wilson } 18316dbb499eSCian Wilson next = ilink->next; 18326dbb499eSCian Wilson ilink = next; 18336dbb499eSCian Wilson } 18346dbb499eSCian Wilson jac->isrestrict = PETSC_TRUE; 18356dbb499eSCian Wilson PetscFunctionReturn(0); 18366dbb499eSCian Wilson } 18376dbb499eSCian Wilson 18381e6b0712SBarry Smith static PetscErrorCode PCFieldSplitSetIS_FieldSplit(PC pc,const char splitname[],IS is) 1839704ba839SBarry Smith { 1840704ba839SBarry Smith PC_FieldSplit *jac = (PC_FieldSplit*)pc->data; 1841704ba839SBarry Smith PetscErrorCode ierr; 1842704ba839SBarry Smith PC_FieldSplitLink ilink, next = jac->head; 1843704ba839SBarry Smith char prefix[128]; 1844704ba839SBarry Smith 1845704ba839SBarry Smith PetscFunctionBegin; 18466c924f48SJed Brown if (jac->splitdefined) { 18476c924f48SJed Brown ierr = PetscInfo1(pc,"Ignoring new split \"%s\" because the splits have already been defined\n",splitname);CHKERRQ(ierr); 18486c924f48SJed Brown PetscFunctionReturn(0); 18496c924f48SJed Brown } 1850b00a9115SJed Brown ierr = PetscNew(&ilink);CHKERRQ(ierr); 1851a04f6461SBarry Smith if (splitname) { 1852db4c96c1SJed Brown ierr = PetscStrallocpy(splitname,&ilink->splitname);CHKERRQ(ierr); 1853a04f6461SBarry Smith } else { 1854785e854fSJed Brown ierr = PetscMalloc1(8,&ilink->splitname);CHKERRQ(ierr); 1855b5787286SJed Brown ierr = PetscSNPrintf(ilink->splitname,7,"%D",jac->nsplits);CHKERRQ(ierr); 1856a04f6461SBarry Smith } 18579df09d43SBarry Smith ilink->event = jac->nsplits < 5 ? KSP_Solve_FS_0 + jac->nsplits : KSP_Solve_FS_0 + 4; /* Any split great than 4 gets logged in the 4th split */ 18581ab39975SBarry Smith ierr = PetscObjectReference((PetscObject)is);CHKERRQ(ierr); 1859b5787286SJed Brown ierr = ISDestroy(&ilink->is);CHKERRQ(ierr); 1860b5787286SJed Brown ilink->is = is; 1861b5787286SJed Brown ierr = PetscObjectReference((PetscObject)is);CHKERRQ(ierr); 1862b5787286SJed Brown ierr = ISDestroy(&ilink->is_col);CHKERRQ(ierr); 1863b5787286SJed Brown ilink->is_col = is; 18640298fd71SBarry Smith ilink->next = NULL; 1865ce94432eSBarry Smith ierr = KSPCreate(PetscObjectComm((PetscObject)pc),&ilink->ksp);CHKERRQ(ierr); 1866422a814eSBarry Smith ierr = KSPSetErrorIfNotConverged(ilink->ksp,pc->erroriffailure);CHKERRQ(ierr); 186720252d06SBarry Smith ierr = PetscObjectIncrementTabLevel((PetscObject)ilink->ksp,(PetscObject)pc,1);CHKERRQ(ierr); 1868704ba839SBarry Smith ierr = KSPSetType(ilink->ksp,KSPPREONLY);CHKERRQ(ierr); 18699005cf84SBarry Smith ierr = PetscLogObjectParent((PetscObject)pc,(PetscObject)ilink->ksp);CHKERRQ(ierr); 1870704ba839SBarry Smith 18718caf3d72SBarry Smith ierr = PetscSNPrintf(prefix,sizeof(prefix),"%sfieldsplit_%s_",((PetscObject)pc)->prefix ? ((PetscObject)pc)->prefix : "",ilink->splitname);CHKERRQ(ierr); 1872704ba839SBarry Smith ierr = KSPSetOptionsPrefix(ilink->ksp,prefix);CHKERRQ(ierr); 1873704ba839SBarry Smith 1874704ba839SBarry Smith if (!next) { 1875704ba839SBarry Smith jac->head = ilink; 18760298fd71SBarry Smith ilink->previous = NULL; 1877704ba839SBarry Smith } else { 1878704ba839SBarry Smith while (next->next) { 1879704ba839SBarry Smith next = next->next; 1880704ba839SBarry Smith } 1881704ba839SBarry Smith next->next = ilink; 1882704ba839SBarry Smith ilink->previous = next; 1883704ba839SBarry Smith } 1884704ba839SBarry Smith jac->nsplits++; 1885704ba839SBarry Smith PetscFunctionReturn(0); 1886704ba839SBarry Smith } 1887704ba839SBarry Smith 188894ef8ddeSSatish Balay /*@C 18890971522cSBarry Smith PCFieldSplitSetFields - Sets the fields for one particular split in the field split preconditioner 18900971522cSBarry Smith 1891ad4df100SBarry Smith Logically Collective on PC 18920971522cSBarry Smith 18930971522cSBarry Smith Input Parameters: 18940971522cSBarry Smith + pc - the preconditioner context 18950298fd71SBarry Smith . splitname - name of this split, if NULL the number of the split is used 18960971522cSBarry Smith . n - the number of fields in this split 1897db4c96c1SJed Brown - fields - the fields in this split 18980971522cSBarry Smith 18990971522cSBarry Smith Level: intermediate 19000971522cSBarry Smith 190195452b02SPatrick Sanan Notes: 190295452b02SPatrick Sanan Use PCFieldSplitSetIS() to set a completely general set of indices as a field. 1903d32f9abdSBarry Smith 19047287d2a3SDmitry Karpeev The PCFieldSplitSetFields() is for defining fields as strided blocks. For example, if the block 1905d32f9abdSBarry 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 1906d32f9abdSBarry Smith 0xx3xx6xx9xx12 ... x1xx4xx7xx ... xx2xx5xx8xx.. 01x34x67x... 0x1x3x5x7.. x12x45x78x.... 1907d32f9abdSBarry Smith where the numbered entries indicate what is in the field. 1908d32f9abdSBarry Smith 1909db4c96c1SJed Brown This function is called once per split (it creates a new split each time). Solve options 1910db4c96c1SJed Brown for this split will be available under the prefix -fieldsplit_SPLITNAME_. 1911db4c96c1SJed Brown 19125d4c12cdSJungho Lee Developer Note: This routine does not actually create the IS representing the split, that is delayed 19135d4c12cdSJungho Lee until PCSetUp_FieldSplit(), because information about the vector/matrix layouts may not be 19145d4c12cdSJungho Lee available when this routine is called. 19155d4c12cdSJungho Lee 1916d32f9abdSBarry Smith .seealso: PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitSetBlockSize(), PCFieldSplitSetIS() 19170971522cSBarry Smith 19180971522cSBarry Smith @*/ 19195d4c12cdSJungho Lee PetscErrorCode PCFieldSplitSetFields(PC pc,const char splitname[],PetscInt n,const PetscInt *fields,const PetscInt *fields_col) 19200971522cSBarry Smith { 19214ac538c5SBarry Smith PetscErrorCode ierr; 19220971522cSBarry Smith 19230971522cSBarry Smith PetscFunctionBegin; 19240700a824SBarry Smith PetscValidHeaderSpecific(pc,PC_CLASSID,1); 1925db4c96c1SJed Brown PetscValidCharPointer(splitname,2); 1926ce94432eSBarry Smith if (n < 1) SETERRQ2(PetscObjectComm((PetscObject)pc),PETSC_ERR_ARG_OUTOFRANGE,"Provided number of fields %D in split \"%s\" not positive",n,splitname); 1927db4c96c1SJed Brown PetscValidIntPointer(fields,3); 19280246f55cSBarry Smith ierr = PetscTryMethod(pc,"PCFieldSplitSetFields_C",(PC,const char[],PetscInt,const PetscInt*,const PetscInt*),(pc,splitname,n,fields,fields_col));CHKERRQ(ierr); 19290971522cSBarry Smith PetscFunctionReturn(0); 19300971522cSBarry Smith } 19310971522cSBarry Smith 1932c84da90fSDmitry Karpeev /*@ 1933c84da90fSDmitry Karpeev PCFieldSplitSetDiagUseAmat - set flag indicating whether to extract diagonal blocks from Amat (rather than Pmat) 1934c84da90fSDmitry Karpeev 1935c84da90fSDmitry Karpeev Logically Collective on PC 1936c84da90fSDmitry Karpeev 1937c84da90fSDmitry Karpeev Input Parameters: 1938c84da90fSDmitry Karpeev + pc - the preconditioner object 1939c84da90fSDmitry Karpeev - flg - boolean flag indicating whether or not to use Amat to extract the diagonal blocks from 1940c84da90fSDmitry Karpeev 19419506b623SDmitry Karpeev Options Database: 19429506b623SDmitry Karpeev . -pc_fieldsplit_diag_use_amat 1943c84da90fSDmitry Karpeev 1944c84da90fSDmitry Karpeev Level: intermediate 1945c84da90fSDmitry Karpeev 1946c84da90fSDmitry Karpeev .seealso: PCFieldSplitGetDiagUseAmat(), PCFieldSplitSetOffDiagUseAmat(), PCFIELDSPLIT 1947c84da90fSDmitry Karpeev 1948c84da90fSDmitry Karpeev @*/ 1949c84da90fSDmitry Karpeev PetscErrorCode PCFieldSplitSetDiagUseAmat(PC pc,PetscBool flg) 1950c84da90fSDmitry Karpeev { 1951c84da90fSDmitry Karpeev PC_FieldSplit *jac = (PC_FieldSplit*)pc->data; 1952c84da90fSDmitry Karpeev PetscBool isfs; 1953c84da90fSDmitry Karpeev PetscErrorCode ierr; 1954c84da90fSDmitry Karpeev 1955c84da90fSDmitry Karpeev PetscFunctionBegin; 1956c84da90fSDmitry Karpeev PetscValidHeaderSpecific(pc,PC_CLASSID,1); 1957c84da90fSDmitry Karpeev ierr = PetscObjectTypeCompare((PetscObject)pc,PCFIELDSPLIT,&isfs);CHKERRQ(ierr); 1958c84da90fSDmitry Karpeev if (!isfs) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"PC not of type %s",PCFIELDSPLIT); 1959c84da90fSDmitry Karpeev jac->diag_use_amat = flg; 1960c84da90fSDmitry Karpeev PetscFunctionReturn(0); 1961c84da90fSDmitry Karpeev } 1962c84da90fSDmitry Karpeev 1963c84da90fSDmitry Karpeev /*@ 1964c84da90fSDmitry Karpeev PCFieldSplitGetDiagUseAmat - get the flag indicating whether to extract diagonal blocks from Amat (rather than Pmat) 1965c84da90fSDmitry Karpeev 1966c84da90fSDmitry Karpeev Logically Collective on PC 1967c84da90fSDmitry Karpeev 1968c84da90fSDmitry Karpeev Input Parameters: 1969c84da90fSDmitry Karpeev . pc - the preconditioner object 1970c84da90fSDmitry Karpeev 1971c84da90fSDmitry Karpeev Output Parameters: 1972c84da90fSDmitry Karpeev . flg - boolean flag indicating whether or not to use Amat to extract the diagonal blocks from 1973c84da90fSDmitry Karpeev 1974c84da90fSDmitry Karpeev 1975c84da90fSDmitry Karpeev Level: intermediate 1976c84da90fSDmitry Karpeev 1977c84da90fSDmitry Karpeev .seealso: PCFieldSplitSetDiagUseAmat(), PCFieldSplitGetOffDiagUseAmat(), PCFIELDSPLIT 1978c84da90fSDmitry Karpeev 1979c84da90fSDmitry Karpeev @*/ 1980c84da90fSDmitry Karpeev PetscErrorCode PCFieldSplitGetDiagUseAmat(PC pc,PetscBool *flg) 1981c84da90fSDmitry Karpeev { 1982c84da90fSDmitry Karpeev PC_FieldSplit *jac = (PC_FieldSplit*)pc->data; 1983c84da90fSDmitry Karpeev PetscBool isfs; 1984c84da90fSDmitry Karpeev PetscErrorCode ierr; 1985c84da90fSDmitry Karpeev 1986c84da90fSDmitry Karpeev PetscFunctionBegin; 1987c84da90fSDmitry Karpeev PetscValidHeaderSpecific(pc,PC_CLASSID,1); 1988c84da90fSDmitry Karpeev PetscValidPointer(flg,2); 1989c84da90fSDmitry Karpeev ierr = PetscObjectTypeCompare((PetscObject)pc,PCFIELDSPLIT,&isfs);CHKERRQ(ierr); 1990c84da90fSDmitry Karpeev if (!isfs) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"PC not of type %s",PCFIELDSPLIT); 1991c84da90fSDmitry Karpeev *flg = jac->diag_use_amat; 1992c84da90fSDmitry Karpeev PetscFunctionReturn(0); 1993c84da90fSDmitry Karpeev } 1994c84da90fSDmitry Karpeev 1995c84da90fSDmitry Karpeev /*@ 1996c84da90fSDmitry Karpeev PCFieldSplitSetOffDiagUseAmat - set flag indicating whether to extract off-diagonal blocks from Amat (rather than Pmat) 1997c84da90fSDmitry Karpeev 1998c84da90fSDmitry Karpeev Logically Collective on PC 1999c84da90fSDmitry Karpeev 2000c84da90fSDmitry Karpeev Input Parameters: 2001c84da90fSDmitry Karpeev + pc - the preconditioner object 2002c84da90fSDmitry Karpeev - flg - boolean flag indicating whether or not to use Amat to extract the off-diagonal blocks from 2003c84da90fSDmitry Karpeev 20049506b623SDmitry Karpeev Options Database: 20059506b623SDmitry Karpeev . -pc_fieldsplit_off_diag_use_amat 2006c84da90fSDmitry Karpeev 2007c84da90fSDmitry Karpeev Level: intermediate 2008c84da90fSDmitry Karpeev 2009c84da90fSDmitry Karpeev .seealso: PCFieldSplitGetOffDiagUseAmat(), PCFieldSplitSetDiagUseAmat(), PCFIELDSPLIT 2010c84da90fSDmitry Karpeev 2011c84da90fSDmitry Karpeev @*/ 2012c84da90fSDmitry Karpeev PetscErrorCode PCFieldSplitSetOffDiagUseAmat(PC pc,PetscBool flg) 2013c84da90fSDmitry Karpeev { 2014c84da90fSDmitry Karpeev PC_FieldSplit *jac = (PC_FieldSplit*)pc->data; 2015c84da90fSDmitry Karpeev PetscBool isfs; 2016c84da90fSDmitry Karpeev PetscErrorCode ierr; 2017c84da90fSDmitry Karpeev 2018c84da90fSDmitry Karpeev PetscFunctionBegin; 2019c84da90fSDmitry Karpeev PetscValidHeaderSpecific(pc,PC_CLASSID,1); 2020c84da90fSDmitry Karpeev ierr = PetscObjectTypeCompare((PetscObject)pc,PCFIELDSPLIT,&isfs);CHKERRQ(ierr); 2021c84da90fSDmitry Karpeev if (!isfs) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"PC not of type %s",PCFIELDSPLIT); 2022c84da90fSDmitry Karpeev jac->offdiag_use_amat = flg; 2023c84da90fSDmitry Karpeev PetscFunctionReturn(0); 2024c84da90fSDmitry Karpeev } 2025c84da90fSDmitry Karpeev 2026c84da90fSDmitry Karpeev /*@ 2027c84da90fSDmitry Karpeev PCFieldSplitGetOffDiagUseAmat - get the flag indicating whether to extract off-diagonal blocks from Amat (rather than Pmat) 2028c84da90fSDmitry Karpeev 2029c84da90fSDmitry Karpeev Logically Collective on PC 2030c84da90fSDmitry Karpeev 2031c84da90fSDmitry Karpeev Input Parameters: 2032c84da90fSDmitry Karpeev . pc - the preconditioner object 2033c84da90fSDmitry Karpeev 2034c84da90fSDmitry Karpeev Output Parameters: 2035c84da90fSDmitry Karpeev . flg - boolean flag indicating whether or not to use Amat to extract the off-diagonal blocks from 2036c84da90fSDmitry Karpeev 2037c84da90fSDmitry Karpeev 2038c84da90fSDmitry Karpeev Level: intermediate 2039c84da90fSDmitry Karpeev 2040c84da90fSDmitry Karpeev .seealso: PCFieldSplitSetOffDiagUseAmat(), PCFieldSplitGetDiagUseAmat(), PCFIELDSPLIT 2041c84da90fSDmitry Karpeev 2042c84da90fSDmitry Karpeev @*/ 2043c84da90fSDmitry Karpeev PetscErrorCode PCFieldSplitGetOffDiagUseAmat(PC pc,PetscBool *flg) 2044c84da90fSDmitry Karpeev { 2045c84da90fSDmitry Karpeev PC_FieldSplit *jac = (PC_FieldSplit*)pc->data; 2046c84da90fSDmitry Karpeev PetscBool isfs; 2047c84da90fSDmitry Karpeev PetscErrorCode ierr; 2048c84da90fSDmitry Karpeev 2049c84da90fSDmitry Karpeev PetscFunctionBegin; 2050c84da90fSDmitry Karpeev PetscValidHeaderSpecific(pc,PC_CLASSID,1); 2051c84da90fSDmitry Karpeev PetscValidPointer(flg,2); 2052c84da90fSDmitry Karpeev ierr = PetscObjectTypeCompare((PetscObject)pc,PCFIELDSPLIT,&isfs);CHKERRQ(ierr); 2053c84da90fSDmitry Karpeev if (!isfs) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"PC not of type %s",PCFIELDSPLIT); 2054c84da90fSDmitry Karpeev *flg = jac->offdiag_use_amat; 2055c84da90fSDmitry Karpeev PetscFunctionReturn(0); 2056c84da90fSDmitry Karpeev } 2057c84da90fSDmitry Karpeev 2058c84da90fSDmitry Karpeev 2059c84da90fSDmitry Karpeev 2060218d4943SBarry Smith /*@C 2061704ba839SBarry Smith PCFieldSplitSetIS - Sets the exact elements for field 2062704ba839SBarry Smith 2063ad4df100SBarry Smith Logically Collective on PC 2064704ba839SBarry Smith 2065704ba839SBarry Smith Input Parameters: 2066704ba839SBarry Smith + pc - the preconditioner context 20670298fd71SBarry Smith . splitname - name of this split, if NULL the number of the split is used 2068db4c96c1SJed Brown - is - the index set that defines the vector elements in this field 2069704ba839SBarry Smith 2070d32f9abdSBarry Smith 2071a6ffb8dbSJed Brown Notes: 2072a6ffb8dbSJed Brown Use PCFieldSplitSetFields(), for fields defined by strided types. 2073a6ffb8dbSJed Brown 2074db4c96c1SJed Brown This function is called once per split (it creates a new split each time). Solve options 2075db4c96c1SJed Brown for this split will be available under the prefix -fieldsplit_SPLITNAME_. 2076d32f9abdSBarry Smith 2077704ba839SBarry Smith Level: intermediate 2078704ba839SBarry Smith 2079704ba839SBarry Smith .seealso: PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitSetBlockSize() 2080704ba839SBarry Smith 2081704ba839SBarry Smith @*/ 20827087cfbeSBarry Smith PetscErrorCode PCFieldSplitSetIS(PC pc,const char splitname[],IS is) 2083704ba839SBarry Smith { 20844ac538c5SBarry Smith PetscErrorCode ierr; 2085704ba839SBarry Smith 2086704ba839SBarry Smith PetscFunctionBegin; 20870700a824SBarry Smith PetscValidHeaderSpecific(pc,PC_CLASSID,1); 20887b62db95SJungho Lee if (splitname) PetscValidCharPointer(splitname,2); 2089db4c96c1SJed Brown PetscValidHeaderSpecific(is,IS_CLASSID,3); 2090ccc738f7SBarry Smith ierr = PetscTryMethod(pc,"PCFieldSplitSetIS_C",(PC,const char[],IS),(pc,splitname,is));CHKERRQ(ierr); 2091704ba839SBarry Smith PetscFunctionReturn(0); 2092704ba839SBarry Smith } 2093704ba839SBarry Smith 209494ef8ddeSSatish Balay /*@C 209557a9adfeSMatthew G Knepley PCFieldSplitGetIS - Retrieves the elements for a field as an IS 209657a9adfeSMatthew G Knepley 209757a9adfeSMatthew G Knepley Logically Collective on PC 209857a9adfeSMatthew G Knepley 209957a9adfeSMatthew G Knepley Input Parameters: 210057a9adfeSMatthew G Knepley + pc - the preconditioner context 210157a9adfeSMatthew G Knepley - splitname - name of this split 210257a9adfeSMatthew G Knepley 210357a9adfeSMatthew G Knepley Output Parameter: 21040298fd71SBarry Smith - is - the index set that defines the vector elements in this field, or NULL if the field is not found 210557a9adfeSMatthew G Knepley 210657a9adfeSMatthew G Knepley Level: intermediate 210757a9adfeSMatthew G Knepley 210857a9adfeSMatthew G Knepley .seealso: PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitSetIS() 210957a9adfeSMatthew G Knepley 211057a9adfeSMatthew G Knepley @*/ 211157a9adfeSMatthew G Knepley PetscErrorCode PCFieldSplitGetIS(PC pc,const char splitname[],IS *is) 211257a9adfeSMatthew G Knepley { 211357a9adfeSMatthew G Knepley PetscErrorCode ierr; 211457a9adfeSMatthew G Knepley 211557a9adfeSMatthew G Knepley PetscFunctionBegin; 211657a9adfeSMatthew G Knepley PetscValidHeaderSpecific(pc,PC_CLASSID,1); 211757a9adfeSMatthew G Knepley PetscValidCharPointer(splitname,2); 211857a9adfeSMatthew G Knepley PetscValidPointer(is,3); 211957a9adfeSMatthew G Knepley { 212057a9adfeSMatthew G Knepley PC_FieldSplit *jac = (PC_FieldSplit*) pc->data; 212157a9adfeSMatthew G Knepley PC_FieldSplitLink ilink = jac->head; 212257a9adfeSMatthew G Knepley PetscBool found; 212357a9adfeSMatthew G Knepley 21240298fd71SBarry Smith *is = NULL; 212557a9adfeSMatthew G Knepley while (ilink) { 212657a9adfeSMatthew G Knepley ierr = PetscStrcmp(ilink->splitname, splitname, &found);CHKERRQ(ierr); 212757a9adfeSMatthew G Knepley if (found) { 212857a9adfeSMatthew G Knepley *is = ilink->is; 212957a9adfeSMatthew G Knepley break; 213057a9adfeSMatthew G Knepley } 213157a9adfeSMatthew G Knepley ilink = ilink->next; 213257a9adfeSMatthew G Knepley } 213357a9adfeSMatthew G Knepley } 213457a9adfeSMatthew G Knepley PetscFunctionReturn(0); 213557a9adfeSMatthew G Knepley } 213657a9adfeSMatthew G Knepley 213751f519a2SBarry Smith /*@ 213851f519a2SBarry Smith PCFieldSplitSetBlockSize - Sets the block size for defining where fields start in the 213951f519a2SBarry Smith fieldsplit preconditioner. If not set the matrix block size is used. 214051f519a2SBarry Smith 2141ad4df100SBarry Smith Logically Collective on PC 214251f519a2SBarry Smith 214351f519a2SBarry Smith Input Parameters: 214451f519a2SBarry Smith + pc - the preconditioner context 214551f519a2SBarry Smith - bs - the block size 214651f519a2SBarry Smith 214751f519a2SBarry Smith Level: intermediate 214851f519a2SBarry Smith 214951f519a2SBarry Smith .seealso: PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitSetFields() 215051f519a2SBarry Smith 215151f519a2SBarry Smith @*/ 21527087cfbeSBarry Smith PetscErrorCode PCFieldSplitSetBlockSize(PC pc,PetscInt bs) 215351f519a2SBarry Smith { 21544ac538c5SBarry Smith PetscErrorCode ierr; 215551f519a2SBarry Smith 215651f519a2SBarry Smith PetscFunctionBegin; 21570700a824SBarry Smith PetscValidHeaderSpecific(pc,PC_CLASSID,1); 2158c5eb9154SBarry Smith PetscValidLogicalCollectiveInt(pc,bs,2); 21594ac538c5SBarry Smith ierr = PetscTryMethod(pc,"PCFieldSplitSetBlockSize_C",(PC,PetscInt),(pc,bs));CHKERRQ(ierr); 216051f519a2SBarry Smith PetscFunctionReturn(0); 216151f519a2SBarry Smith } 216251f519a2SBarry Smith 21630971522cSBarry Smith /*@C 216469a612a9SBarry Smith PCFieldSplitGetSubKSP - Gets the KSP contexts for all splits 21650971522cSBarry Smith 216669a612a9SBarry Smith Collective on KSP 21670971522cSBarry Smith 21680971522cSBarry Smith Input Parameter: 21690971522cSBarry Smith . pc - the preconditioner context 21700971522cSBarry Smith 21710971522cSBarry Smith Output Parameters: 217213e0d083SBarry Smith + n - the number of splits 21733111de3cSBarry Smith - subksp - the array of KSP contexts 21740971522cSBarry Smith 21750971522cSBarry Smith Note: 21769a4f7e47SBarry Smith After PCFieldSplitGetSubKSP() the array of KSPs is to be freed by the user with PetscFree() 2177d32f9abdSBarry Smith (not the KSP just the array that contains them). 21780971522cSBarry Smith 2179285fb4e2SStefano Zampini You must call PCSetUp() before calling PCFieldSplitGetSubKSP(). 2180285fb4e2SStefano Zampini 2181285fb4e2SStefano Zampini If the fieldsplit is of type PC_COMPOSITE_SCHUR, it returns the KSP object used inside the 2182285fb4e2SStefano Zampini Schur complement and the KSP object used to iterate over the Schur complement. 2183a51937d4SCarola Kruse To access all the KSP objects used in PC_COMPOSITE_SCHUR, use PCFieldSplitSchurGetSubKSP(). 2184a51937d4SCarola Kruse 2185a51937d4SCarola Kruse If the fieldsplit is of type PC_COMPOSITE_GKB, it returns the KSP object used to solve the 2186a51937d4SCarola Kruse inner linear system defined by the matrix H in each loop. 21870971522cSBarry Smith 2188196cc216SBarry Smith Fortran Usage: You must pass in a KSP array that is large enough to contain all the local KSPs. 21892bf68e3eSBarry Smith You can call PCFieldSplitGetSubKSP(pc,n,PETSC_NULL_KSP,ierr) to determine how large the 2190196cc216SBarry Smith KSP array must be. 2191196cc216SBarry Smith 2192196cc216SBarry Smith 21930971522cSBarry Smith Level: advanced 21940971522cSBarry Smith 21950971522cSBarry Smith .seealso: PCFIELDSPLIT 21960971522cSBarry Smith @*/ 21977087cfbeSBarry Smith PetscErrorCode PCFieldSplitGetSubKSP(PC pc,PetscInt *n,KSP *subksp[]) 21980971522cSBarry Smith { 21994ac538c5SBarry Smith PetscErrorCode ierr; 22000971522cSBarry Smith 22010971522cSBarry Smith PetscFunctionBegin; 22020700a824SBarry Smith PetscValidHeaderSpecific(pc,PC_CLASSID,1); 220313e0d083SBarry Smith if (n) PetscValidIntPointer(n,2); 22044ac538c5SBarry Smith ierr = PetscUseMethod(pc,"PCFieldSplitGetSubKSP_C",(PC,PetscInt*,KSP **),(pc,n,subksp));CHKERRQ(ierr); 22050971522cSBarry Smith PetscFunctionReturn(0); 22060971522cSBarry Smith } 22070971522cSBarry Smith 2208285fb4e2SStefano Zampini /*@C 2209285fb4e2SStefano Zampini PCFieldSplitSchurGetSubKSP - Gets the KSP contexts used inside the Schur complement based PCFIELDSPLIT 2210285fb4e2SStefano Zampini 2211285fb4e2SStefano Zampini Collective on KSP 2212285fb4e2SStefano Zampini 2213285fb4e2SStefano Zampini Input Parameter: 2214285fb4e2SStefano Zampini . pc - the preconditioner context 2215285fb4e2SStefano Zampini 2216285fb4e2SStefano Zampini Output Parameters: 2217285fb4e2SStefano Zampini + n - the number of splits 2218285fb4e2SStefano Zampini - subksp - the array of KSP contexts 2219285fb4e2SStefano Zampini 2220285fb4e2SStefano Zampini Note: 2221285fb4e2SStefano Zampini After PCFieldSplitSchurGetSubKSP() the array of KSPs is to be freed by the user with PetscFree() 2222285fb4e2SStefano Zampini (not the KSP just the array that contains them). 2223285fb4e2SStefano Zampini 2224285fb4e2SStefano Zampini You must call PCSetUp() before calling PCFieldSplitSchurGetSubKSP(). 2225285fb4e2SStefano Zampini 2226285fb4e2SStefano Zampini If the fieldsplit type is of type PC_COMPOSITE_SCHUR, it returns (in order) 2227285fb4e2SStefano Zampini - the KSP used for the (1,1) block 2228285fb4e2SStefano Zampini - the KSP used for the Schur complement (not the one used for the interior Schur solver) 2229285fb4e2SStefano Zampini - the KSP used for the (1,1) block in the upper triangular factor (if different from that of the (1,1) block). 2230285fb4e2SStefano Zampini 2231285fb4e2SStefano Zampini It returns a null array if the fieldsplit is not of type PC_COMPOSITE_SCHUR; in this case, you should use PCFieldSplitGetSubKSP(). 2232285fb4e2SStefano Zampini 2233285fb4e2SStefano Zampini Fortran Usage: You must pass in a KSP array that is large enough to contain all the local KSPs. 2234285fb4e2SStefano Zampini You can call PCFieldSplitSchurGetSubKSP(pc,n,PETSC_NULL_KSP,ierr) to determine how large the 2235285fb4e2SStefano Zampini KSP array must be. 2236285fb4e2SStefano Zampini 2237285fb4e2SStefano Zampini Level: advanced 2238285fb4e2SStefano Zampini 2239285fb4e2SStefano Zampini .seealso: PCFIELDSPLIT 2240285fb4e2SStefano Zampini @*/ 2241285fb4e2SStefano Zampini PetscErrorCode PCFieldSplitSchurGetSubKSP(PC pc,PetscInt *n,KSP *subksp[]) 2242285fb4e2SStefano Zampini { 2243285fb4e2SStefano Zampini PetscErrorCode ierr; 2244285fb4e2SStefano Zampini 2245285fb4e2SStefano Zampini PetscFunctionBegin; 2246285fb4e2SStefano Zampini PetscValidHeaderSpecific(pc,PC_CLASSID,1); 2247285fb4e2SStefano Zampini if (n) PetscValidIntPointer(n,2); 2248285fb4e2SStefano Zampini ierr = PetscUseMethod(pc,"PCFieldSplitSchurGetSubKSP_C",(PC,PetscInt*,KSP **),(pc,n,subksp));CHKERRQ(ierr); 2249285fb4e2SStefano Zampini PetscFunctionReturn(0); 2250285fb4e2SStefano Zampini } 2251285fb4e2SStefano Zampini 2252e69d4d44SBarry Smith /*@ 225353f2277eSBarry Smith PCFieldSplitSetSchurPre - Indicates what operator is used to construct the preconditioner for the Schur complement. 2254a04f6461SBarry Smith A11 matrix. Otherwise no preconditioner is used. 2255e69d4d44SBarry Smith 2256e69d4d44SBarry Smith Collective on PC 2257e69d4d44SBarry Smith 2258e69d4d44SBarry Smith Input Parameters: 2259e69d4d44SBarry Smith + pc - the preconditioner context 22606fdd48a9SBarry Smith . ptype - which matrix to use for preconditioning the Schur complement: PC_FIELDSPLIT_SCHUR_PRE_A11 (default), PC_FIELDSPLIT_SCHUR_PRE_SELF, PC_FIELDSPLIT_SCHUR_PRE_USER 22616fdd48a9SBarry Smith PC_FIELDSPLIT_SCHUR_PRE_SELFP, and PC_FIELDSPLIT_SCHUR_PRE_FULL 22620298fd71SBarry Smith - userpre - matrix to use for preconditioning, or NULL 2263084e4875SJed Brown 2264e69d4d44SBarry Smith Options Database: 22656fdd48a9SBarry Smith . -pc_fieldsplit_schur_precondition <self,selfp,user,a11,full> - default is a11. See notes for meaning of various arguments 2266e69d4d44SBarry Smith 2267fd1303e9SJungho Lee Notes: 2268fd1303e9SJungho Lee $ If ptype is 2269a6a584a2SBarry Smith $ a11 then the preconditioner for the Schur complement is generated from the block diagonal part of the preconditioner 227053f2277eSBarry Smith $ matrix associated with the Schur complement (i.e. A11), not the Schur complement matrix 2271a6a584a2SBarry Smith $ self the preconditioner for the Schur complement is generated from the symbolic representation of the Schur complement matrix: 2272a6a584a2SBarry Smith $ The only preconditioner that currently works with this symbolic respresentation matrix object is the PCLSC 2273fd1303e9SJungho Lee $ preconditioner 22746fdd48a9SBarry Smith $ user then the preconditioner for the Schur complement is generated from the user provided matrix (pre argument 22756fdd48a9SBarry Smith $ to this function). 2276a6a584a2SBarry Smith $ selfp then the preconditioning for the Schur complement is generated from an explicitly-assembled approximation Sp = A11 - A10 inv(diag(A00)) A01 22771d71051fSDmitry Karpeev $ This is only a good preconditioner when diag(A00) is a good preconditioner for A00. Optionally, A00 can be 22786fdd48a9SBarry Smith $ lumped before extracting the diagonal using the additional option -fieldsplit_1_mat_schur_complement_ainv_type lump 227994350679SMatthew Knepley $ full then the preconditioner for the Schur complement is generated from the exact Schur complement matrix representation computed internally by PCFIELDSPLIT (this is expensive) 22806fdd48a9SBarry Smith $ useful mostly as a test that the Schur complement approach can work for your problem 2281fd1303e9SJungho Lee 2282e87fab1bSBarry Smith When solving a saddle point problem, where the A11 block is identically zero, using a11 as the ptype only makes sense 2283fd1303e9SJungho Lee with the additional option -fieldsplit_1_pc_type none. Usually for saddle point problems one would use a ptype of self and 2284a7476a74SDmitry Karpeev -fieldsplit_1_pc_type lsc which uses the least squares commutator to compute a preconditioner for the Schur complement. 2285fd1303e9SJungho Lee 2286e69d4d44SBarry Smith Level: intermediate 2287e69d4d44SBarry Smith 22881d71051fSDmitry Karpeev .seealso: PCFieldSplitGetSchurPre(), PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitSetFields(), PCFieldSplitSchurPreType, 22891d71051fSDmitry Karpeev MatSchurComplementSetAinvType(), PCLSC 2290e69d4d44SBarry Smith 2291e69d4d44SBarry Smith @*/ 229229f8a81cSJed Brown PetscErrorCode PCFieldSplitSetSchurPre(PC pc,PCFieldSplitSchurPreType ptype,Mat pre) 2293e69d4d44SBarry Smith { 22944ac538c5SBarry Smith PetscErrorCode ierr; 2295e69d4d44SBarry Smith 2296e69d4d44SBarry Smith PetscFunctionBegin; 22970700a824SBarry Smith PetscValidHeaderSpecific(pc,PC_CLASSID,1); 229829f8a81cSJed Brown ierr = PetscTryMethod(pc,"PCFieldSplitSetSchurPre_C",(PC,PCFieldSplitSchurPreType,Mat),(pc,ptype,pre));CHKERRQ(ierr); 2299e69d4d44SBarry Smith PetscFunctionReturn(0); 2300e69d4d44SBarry Smith } 2301686bed4dSStefano Zampini 230229f8a81cSJed Brown PetscErrorCode PCFieldSplitSchurPrecondition(PC pc,PCFieldSplitSchurPreType ptype,Mat pre) {return PCFieldSplitSetSchurPre(pc,ptype,pre);} /* Deprecated name */ 2303e69d4d44SBarry Smith 230437a82bf0SJed Brown /*@ 230537a82bf0SJed Brown PCFieldSplitGetSchurPre - For Schur complement fieldsplit, determine how the Schur complement will be 230629f8a81cSJed Brown preconditioned. See PCFieldSplitSetSchurPre() for details. 230737a82bf0SJed Brown 230837a82bf0SJed Brown Logically Collective on PC 230937a82bf0SJed Brown 231037a82bf0SJed Brown Input Parameters: 231137a82bf0SJed Brown . pc - the preconditioner context 231237a82bf0SJed Brown 231337a82bf0SJed Brown Output Parameters: 231437a82bf0SJed Brown + ptype - which matrix to use for preconditioning the Schur complement: PC_FIELDSPLIT_SCHUR_PRE_A11, PC_FIELDSPLIT_SCHUR_PRE_SELF, PC_FIELDSPLIT_PRE_USER 231537a82bf0SJed Brown - userpre - matrix to use for preconditioning (with PC_FIELDSPLIT_PRE_USER), or NULL 231637a82bf0SJed Brown 231737a82bf0SJed Brown Level: intermediate 231837a82bf0SJed Brown 231929f8a81cSJed Brown .seealso: PCFieldSplitSetSchurPre(), PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitSetFields(), PCFieldSplitSchurPreType, PCLSC 232037a82bf0SJed Brown 232137a82bf0SJed Brown @*/ 232237a82bf0SJed Brown PetscErrorCode PCFieldSplitGetSchurPre(PC pc,PCFieldSplitSchurPreType *ptype,Mat *pre) 232337a82bf0SJed Brown { 232437a82bf0SJed Brown PetscErrorCode ierr; 232537a82bf0SJed Brown 232637a82bf0SJed Brown PetscFunctionBegin; 232737a82bf0SJed Brown PetscValidHeaderSpecific(pc,PC_CLASSID,1); 232837a82bf0SJed Brown ierr = PetscUseMethod(pc,"PCFieldSplitGetSchurPre_C",(PC,PCFieldSplitSchurPreType*,Mat*),(pc,ptype,pre));CHKERRQ(ierr); 2329e69d4d44SBarry Smith PetscFunctionReturn(0); 2330e69d4d44SBarry Smith } 2331e69d4d44SBarry Smith 233245e7fc46SDmitry Karpeev /*@ 2333470b340bSDmitry Karpeev PCFieldSplitSchurGetS - extract the MatSchurComplement object used by this PC in case it needs to be configured separately 233445e7fc46SDmitry Karpeev 233545e7fc46SDmitry Karpeev Not collective 233645e7fc46SDmitry Karpeev 233745e7fc46SDmitry Karpeev Input Parameter: 233845e7fc46SDmitry Karpeev . pc - the preconditioner context 233945e7fc46SDmitry Karpeev 234045e7fc46SDmitry Karpeev Output Parameter: 2341470b340bSDmitry Karpeev . S - the Schur complement matrix 234245e7fc46SDmitry Karpeev 2343470b340bSDmitry Karpeev Notes: 2344470b340bSDmitry Karpeev This matrix should not be destroyed using MatDestroy(); rather, use PCFieldSplitSchurRestoreS(). 234545e7fc46SDmitry Karpeev 234645e7fc46SDmitry Karpeev Level: advanced 234745e7fc46SDmitry Karpeev 234829f8a81cSJed Brown .seealso: PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitSchurPreType, PCFieldSplitSetSchurPre(), MatSchurComplement, PCFieldSplitSchurRestoreS() 234945e7fc46SDmitry Karpeev 235045e7fc46SDmitry Karpeev @*/ 2351470b340bSDmitry Karpeev PetscErrorCode PCFieldSplitSchurGetS(PC pc,Mat *S) 235245e7fc46SDmitry Karpeev { 235345e7fc46SDmitry Karpeev PetscErrorCode ierr; 235445e7fc46SDmitry Karpeev const char* t; 235545e7fc46SDmitry Karpeev PetscBool isfs; 235645e7fc46SDmitry Karpeev PC_FieldSplit *jac; 235745e7fc46SDmitry Karpeev 235845e7fc46SDmitry Karpeev PetscFunctionBegin; 235945e7fc46SDmitry Karpeev PetscValidHeaderSpecific(pc,PC_CLASSID,1); 236045e7fc46SDmitry Karpeev ierr = PetscObjectGetType((PetscObject)pc,&t);CHKERRQ(ierr); 236145e7fc46SDmitry Karpeev ierr = PetscStrcmp(t,PCFIELDSPLIT,&isfs);CHKERRQ(ierr); 236245e7fc46SDmitry Karpeev if (!isfs) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Expected PC of type PCFIELDSPLIT, got %s instead",t); 236345e7fc46SDmitry Karpeev jac = (PC_FieldSplit*)pc->data; 2364470b340bSDmitry Karpeev if (jac->type != PC_COMPOSITE_SCHUR) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Expected PCFIELDSPLIT of type SCHUR, got %D instead",jac->type); 2365470b340bSDmitry Karpeev if (S) *S = jac->schur; 236645e7fc46SDmitry Karpeev PetscFunctionReturn(0); 236745e7fc46SDmitry Karpeev } 236845e7fc46SDmitry Karpeev 2369470b340bSDmitry Karpeev /*@ 2370470b340bSDmitry Karpeev PCFieldSplitSchurRestoreS - restores the MatSchurComplement object used by this PC 2371470b340bSDmitry Karpeev 2372470b340bSDmitry Karpeev Not collective 2373470b340bSDmitry Karpeev 2374470b340bSDmitry Karpeev Input Parameters: 2375470b340bSDmitry Karpeev + pc - the preconditioner context 2376470b340bSDmitry Karpeev . S - the Schur complement matrix 2377470b340bSDmitry Karpeev 2378470b340bSDmitry Karpeev Level: advanced 2379470b340bSDmitry Karpeev 238029f8a81cSJed Brown .seealso: PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitSchurPreType, PCFieldSplitSetSchurPre(), MatSchurComplement, PCFieldSplitSchurGetS() 2381470b340bSDmitry Karpeev 2382470b340bSDmitry Karpeev @*/ 2383bca69d2bSDmitry Karpeev PetscErrorCode PCFieldSplitSchurRestoreS(PC pc,Mat *S) 2384470b340bSDmitry Karpeev { 2385470b340bSDmitry Karpeev PetscErrorCode ierr; 2386470b340bSDmitry Karpeev const char* t; 2387470b340bSDmitry Karpeev PetscBool isfs; 2388470b340bSDmitry Karpeev PC_FieldSplit *jac; 2389470b340bSDmitry Karpeev 2390470b340bSDmitry Karpeev PetscFunctionBegin; 2391470b340bSDmitry Karpeev PetscValidHeaderSpecific(pc,PC_CLASSID,1); 2392470b340bSDmitry Karpeev ierr = PetscObjectGetType((PetscObject)pc,&t);CHKERRQ(ierr); 2393470b340bSDmitry Karpeev ierr = PetscStrcmp(t,PCFIELDSPLIT,&isfs);CHKERRQ(ierr); 2394470b340bSDmitry Karpeev if (!isfs) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Expected PC of type PCFIELDSPLIT, got %s instead",t); 2395470b340bSDmitry Karpeev jac = (PC_FieldSplit*)pc->data; 2396470b340bSDmitry Karpeev if (jac->type != PC_COMPOSITE_SCHUR) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Expected PCFIELDSPLIT of type SCHUR, got %D instead",jac->type); 2397bca69d2bSDmitry Karpeev if (!S || *S != jac->schur) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"MatSchurComplement restored is not the same as gotten"); 2398470b340bSDmitry Karpeev PetscFunctionReturn(0); 2399470b340bSDmitry Karpeev } 2400470b340bSDmitry Karpeev 2401470b340bSDmitry Karpeev 240229f8a81cSJed Brown static PetscErrorCode PCFieldSplitSetSchurPre_FieldSplit(PC pc,PCFieldSplitSchurPreType ptype,Mat pre) 2403e69d4d44SBarry Smith { 2404e69d4d44SBarry Smith PC_FieldSplit *jac = (PC_FieldSplit*)pc->data; 2405084e4875SJed Brown PetscErrorCode ierr; 2406e69d4d44SBarry Smith 2407e69d4d44SBarry Smith PetscFunctionBegin; 2408084e4875SJed Brown jac->schurpre = ptype; 2409a7476a74SDmitry Karpeev if (ptype == PC_FIELDSPLIT_SCHUR_PRE_USER && pre) { 24106bf464f9SBarry Smith ierr = MatDestroy(&jac->schur_user);CHKERRQ(ierr); 2411084e4875SJed Brown jac->schur_user = pre; 2412084e4875SJed Brown ierr = PetscObjectReference((PetscObject)jac->schur_user);CHKERRQ(ierr); 2413084e4875SJed Brown } 2414e69d4d44SBarry Smith PetscFunctionReturn(0); 2415e69d4d44SBarry Smith } 2416e69d4d44SBarry Smith 241737a82bf0SJed Brown static PetscErrorCode PCFieldSplitGetSchurPre_FieldSplit(PC pc,PCFieldSplitSchurPreType *ptype,Mat *pre) 241837a82bf0SJed Brown { 241937a82bf0SJed Brown PC_FieldSplit *jac = (PC_FieldSplit*)pc->data; 242037a82bf0SJed Brown 242137a82bf0SJed Brown PetscFunctionBegin; 242237a82bf0SJed Brown *ptype = jac->schurpre; 242337a82bf0SJed Brown *pre = jac->schur_user; 242437a82bf0SJed Brown PetscFunctionReturn(0); 242537a82bf0SJed Brown } 242637a82bf0SJed Brown 2427ab1df9f5SJed Brown /*@ 24280ffb0e17SBarry Smith PCFieldSplitSetSchurFactType - sets which blocks of the approximate block factorization to retain in the preconditioner 2429ab1df9f5SJed Brown 2430ab1df9f5SJed Brown Collective on PC 2431ab1df9f5SJed Brown 2432ab1df9f5SJed Brown Input Parameters: 2433ab1df9f5SJed Brown + pc - the preconditioner context 2434c9c6ffaaSJed Brown - ftype - which blocks of factorization to retain, PC_FIELDSPLIT_SCHUR_FACT_FULL is default 2435ab1df9f5SJed Brown 2436ab1df9f5SJed Brown Options Database: 2437c9c6ffaaSJed Brown . -pc_fieldsplit_schur_fact_type <diag,lower,upper,full> default is full 2438ab1df9f5SJed Brown 2439ab1df9f5SJed Brown 2440ab1df9f5SJed Brown Level: intermediate 2441ab1df9f5SJed Brown 2442ab1df9f5SJed Brown Notes: 2443ab1df9f5SJed Brown The FULL factorization is 2444ab1df9f5SJed Brown 24450ffb0e17SBarry Smith $ (A B) = (1 0) (A 0) (1 Ainv*B) = L D U 24460ffb0e17SBarry Smith $ (C E) (C*Ainv 1) (0 S) (0 1 ) 2447ab1df9f5SJed Brown 24480ffb0e17SBarry Smith where S = E - C*Ainv*B. In practice, the full factorization is applied via block triangular solves with the grouping L*(D*U). UPPER uses D*U, LOWER uses L*D, 2449c096484dSStefano Zampini and DIAG is the diagonal part with the sign of S flipped (because this makes the preconditioner positive definite for many formulations, thus allowing the use of KSPMINRES). Sign flipping of S can be turned off with PCFieldSplitSetSchurScale(). 2450ab1df9f5SJed Brown 24510ffb0e17SBarry Smith $ If A and S are solved exactly 24520ffb0e17SBarry Smith $ *) FULL factorization is a direct solver. 24530ffb0e17SBarry Smith $ *) The preconditioned operator with LOWER or UPPER has all eigenvalues equal to 1 and minimal polynomial of degree 2, so KSPGMRES converges in 2 iterations. 24540ffb0e17SBarry Smith $ *) With DIAG, the preconditioned operator has three distinct nonzero eigenvalues and minimal polynomial of degree at most 4, so KSPGMRES converges in at most 4 iterations. 2455ab1df9f5SJed Brown 24560ffb0e17SBarry Smith If the iteration count is very low, consider using KSPFGMRES or KSPGCR which can use one less preconditioner 24570ffb0e17SBarry 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. 24580ffb0e17SBarry Smith 24590ffb0e17SBarry Smith For symmetric problems in which A is positive definite and S is negative definite, DIAG can be used with KSPMINRES. 24600ffb0e17SBarry Smith 24610ffb0e17SBarry Smith Note that a flexible method like KSPFGMRES or KSPGCR must be used if the fieldsplit preconditioner is nonlinear (e.g. a few iterations of a Krylov method is used to solve with A or S). 2462ab1df9f5SJed Brown 2463ab1df9f5SJed Brown References: 246496a0c994SBarry Smith + 1. - Murphy, Golub, and Wathen, A note on preconditioning indefinite linear systems, SIAM J. Sci. Comput., 21 (2000). 246596a0c994SBarry Smith - 2. - Ipsen, A note on preconditioning nonsymmetric matrices, SIAM J. Sci. Comput., 23 (2001). 2466ab1df9f5SJed Brown 2467c096484dSStefano Zampini .seealso: PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitSetFields(), PCFieldSplitSchurPreType, PCFieldSplitSetSchurScale() 2468ab1df9f5SJed Brown @*/ 2469c9c6ffaaSJed Brown PetscErrorCode PCFieldSplitSetSchurFactType(PC pc,PCFieldSplitSchurFactType ftype) 2470ab1df9f5SJed Brown { 2471ab1df9f5SJed Brown PetscErrorCode ierr; 2472ab1df9f5SJed Brown 2473ab1df9f5SJed Brown PetscFunctionBegin; 2474ab1df9f5SJed Brown PetscValidHeaderSpecific(pc,PC_CLASSID,1); 2475c9c6ffaaSJed Brown ierr = PetscTryMethod(pc,"PCFieldSplitSetSchurFactType_C",(PC,PCFieldSplitSchurFactType),(pc,ftype));CHKERRQ(ierr); 2476ab1df9f5SJed Brown PetscFunctionReturn(0); 2477ab1df9f5SJed Brown } 2478ab1df9f5SJed Brown 24791e6b0712SBarry Smith static PetscErrorCode PCFieldSplitSetSchurFactType_FieldSplit(PC pc,PCFieldSplitSchurFactType ftype) 2480ab1df9f5SJed Brown { 2481ab1df9f5SJed Brown PC_FieldSplit *jac = (PC_FieldSplit*)pc->data; 2482ab1df9f5SJed Brown 2483ab1df9f5SJed Brown PetscFunctionBegin; 2484ab1df9f5SJed Brown jac->schurfactorization = ftype; 2485ab1df9f5SJed Brown PetscFunctionReturn(0); 2486ab1df9f5SJed Brown } 2487ab1df9f5SJed Brown 2488c096484dSStefano Zampini /*@ 2489c096484dSStefano Zampini PCFieldSplitSetSchurScale - Controls the sign flip of S for PC_FIELDSPLIT_SCHUR_FACT_DIAG. 2490c096484dSStefano Zampini 2491c096484dSStefano Zampini Collective on PC 2492c096484dSStefano Zampini 2493c096484dSStefano Zampini Input Parameters: 2494c096484dSStefano Zampini + pc - the preconditioner context 2495c096484dSStefano Zampini - scale - scaling factor for the Schur complement 2496c096484dSStefano Zampini 2497c096484dSStefano Zampini Options Database: 2498c096484dSStefano Zampini . -pc_fieldsplit_schur_scale - default is -1.0 2499c096484dSStefano Zampini 2500c096484dSStefano Zampini Level: intermediate 2501c096484dSStefano Zampini 2502c096484dSStefano Zampini .seealso: PCFIELDSPLIT, PCFieldSplitSetFields(), PCFieldSplitSchurFactType, PCFieldSplitSetSchurScale() 2503c096484dSStefano Zampini @*/ 2504c096484dSStefano Zampini PetscErrorCode PCFieldSplitSetSchurScale(PC pc,PetscScalar scale) 2505c096484dSStefano Zampini { 2506c096484dSStefano Zampini PetscErrorCode ierr; 2507c096484dSStefano Zampini 2508c096484dSStefano Zampini PetscFunctionBegin; 2509c096484dSStefano Zampini PetscValidHeaderSpecific(pc,PC_CLASSID,1); 2510c096484dSStefano Zampini PetscValidLogicalCollectiveScalar(pc,scale,2); 2511c096484dSStefano Zampini ierr = PetscTryMethod(pc,"PCFieldSplitSetSchurScale_C",(PC,PetscScalar),(pc,scale));CHKERRQ(ierr); 2512c096484dSStefano Zampini PetscFunctionReturn(0); 2513c096484dSStefano Zampini } 2514c096484dSStefano Zampini 2515c096484dSStefano Zampini static PetscErrorCode PCFieldSplitSetSchurScale_FieldSplit(PC pc,PetscScalar scale) 2516c096484dSStefano Zampini { 2517c096484dSStefano Zampini PC_FieldSplit *jac = (PC_FieldSplit*)pc->data; 2518c096484dSStefano Zampini 2519c096484dSStefano Zampini PetscFunctionBegin; 2520c096484dSStefano Zampini jac->schurscale = scale; 2521c096484dSStefano Zampini PetscFunctionReturn(0); 2522c096484dSStefano Zampini } 2523c096484dSStefano Zampini 252430ad9308SMatthew Knepley /*@C 25258c03b21aSDmitry Karpeev PCFieldSplitGetSchurBlocks - Gets all matrix blocks for the Schur complement 252630ad9308SMatthew Knepley 252730ad9308SMatthew Knepley Collective on KSP 252830ad9308SMatthew Knepley 252930ad9308SMatthew Knepley Input Parameter: 253030ad9308SMatthew Knepley . pc - the preconditioner context 253130ad9308SMatthew Knepley 253230ad9308SMatthew Knepley Output Parameters: 2533a04f6461SBarry Smith + A00 - the (0,0) block 2534a04f6461SBarry Smith . A01 - the (0,1) block 2535a04f6461SBarry Smith . A10 - the (1,0) block 2536a04f6461SBarry Smith - A11 - the (1,1) block 253730ad9308SMatthew Knepley 253830ad9308SMatthew Knepley Level: advanced 253930ad9308SMatthew Knepley 254030ad9308SMatthew Knepley .seealso: PCFIELDSPLIT 254130ad9308SMatthew Knepley @*/ 2542a04f6461SBarry Smith PetscErrorCode PCFieldSplitGetSchurBlocks(PC pc,Mat *A00,Mat *A01,Mat *A10, Mat *A11) 254330ad9308SMatthew Knepley { 254430ad9308SMatthew Knepley PC_FieldSplit *jac = (PC_FieldSplit*) pc->data; 254530ad9308SMatthew Knepley 254630ad9308SMatthew Knepley PetscFunctionBegin; 25470700a824SBarry Smith PetscValidHeaderSpecific(pc,PC_CLASSID,1); 2548ce94432eSBarry Smith if (jac->type != PC_COMPOSITE_SCHUR) SETERRQ(PetscObjectComm((PetscObject)pc),PETSC_ERR_ARG_WRONG, "FieldSplit is not using a Schur complement approach."); 2549a04f6461SBarry Smith if (A00) *A00 = jac->pmat[0]; 2550a04f6461SBarry Smith if (A01) *A01 = jac->B; 2551a04f6461SBarry Smith if (A10) *A10 = jac->C; 2552a04f6461SBarry Smith if (A11) *A11 = jac->pmat[1]; 255330ad9308SMatthew Knepley PetscFunctionReturn(0); 255430ad9308SMatthew Knepley } 255530ad9308SMatthew Knepley 2556b09e027eSCarola Kruse /*@ 2557e071a0a4SCarola Kruse PCFieldSplitSetGKBTol - Sets the solver tolerance for the generalized Golub-Kahan bidiagonalization preconditioner. 2558b09e027eSCarola Kruse 2559b09e027eSCarola Kruse Collective on PC 2560b09e027eSCarola Kruse 2561e071a0a4SCarola Kruse Notes: 2562e071a0a4SCarola Kruse The generalized GKB algorithm uses a lower bound estimate of the error in energy norm as stopping criterion. 2563e071a0a4SCarola Kruse It stops once the lower bound estimate undershoots the required solver tolerance. Although the actual error might be bigger than 2564e071a0a4SCarola Kruse this estimate, the stopping criterion is satisfactory in practical cases [A13]. 2565e071a0a4SCarola Kruse 2566e071a0a4SCarola Kruse [Ar13] Generalized Golub-Kahan bidiagonalization and stopping criteria, SIAM J. Matrix Anal. Appl., Vol. 34, No. 2, pp. 571-592, 2013. 2567e071a0a4SCarola Kruse 2568b09e027eSCarola Kruse Input Parameters: 2569b09e027eSCarola Kruse + pc - the preconditioner context 2570b09e027eSCarola Kruse - tolerance - the solver tolerance 2571b09e027eSCarola Kruse 2572b09e027eSCarola Kruse Options Database: 2573b09e027eSCarola Kruse . -pc_fieldsplit_gkb_tol - default is 1e-5 2574b09e027eSCarola Kruse 2575b09e027eSCarola Kruse Level: intermediate 2576b09e027eSCarola Kruse 2577b09e027eSCarola Kruse .seealso: PCFIELDSPLIT, PCFieldSplitSetGKBDelay(), PCFieldSplitSetGKBNu(), PCFieldSplitSetGKBMaxit() 2578b09e027eSCarola Kruse @*/ 2579b09e027eSCarola Kruse PetscErrorCode PCFieldSplitSetGKBTol(PC pc,PetscReal tolerance) 2580b09e027eSCarola Kruse { 2581b09e027eSCarola Kruse PetscErrorCode ierr; 2582b09e027eSCarola Kruse 2583b09e027eSCarola Kruse PetscFunctionBegin; 2584b09e027eSCarola Kruse PetscValidHeaderSpecific(pc,PC_CLASSID,1); 2585de482cd7SCarola Kruse PetscValidLogicalCollectiveReal(pc,tolerance,2); 2586b09e027eSCarola Kruse ierr = PetscTryMethod(pc,"PCFieldSplitSetGKBTol_C",(PC,PetscReal),(pc,tolerance));CHKERRQ(ierr); 2587b09e027eSCarola Kruse PetscFunctionReturn(0); 2588b09e027eSCarola Kruse } 2589b09e027eSCarola Kruse 2590b09e027eSCarola Kruse static PetscErrorCode PCFieldSplitSetGKBTol_FieldSplit(PC pc,PetscReal tolerance) 2591b09e027eSCarola Kruse { 2592b09e027eSCarola Kruse PC_FieldSplit *jac = (PC_FieldSplit*)pc->data; 2593b09e027eSCarola Kruse 2594b09e027eSCarola Kruse PetscFunctionBegin; 2595b09e027eSCarola Kruse jac->gkbtol = tolerance; 2596b09e027eSCarola Kruse PetscFunctionReturn(0); 2597b09e027eSCarola Kruse } 2598b09e027eSCarola Kruse 2599b09e027eSCarola Kruse 2600b09e027eSCarola Kruse /*@ 2601e071a0a4SCarola Kruse PCFieldSplitSetGKBMaxit - Sets the maximum number of iterations for the generalized Golub-Kahan bidiagonalization 2602e071a0a4SCarola Kruse preconditioner. 2603b09e027eSCarola Kruse 2604b09e027eSCarola Kruse Collective on PC 2605b09e027eSCarola Kruse 2606b09e027eSCarola Kruse Input Parameters: 2607b09e027eSCarola Kruse + pc - the preconditioner context 2608b09e027eSCarola Kruse - maxit - the maximum number of iterations 2609b09e027eSCarola Kruse 2610b09e027eSCarola Kruse Options Database: 2611b09e027eSCarola Kruse . -pc_fieldsplit_gkb_maxit - default is 100 2612b09e027eSCarola Kruse 2613b09e027eSCarola Kruse Level: intermediate 2614b09e027eSCarola Kruse 2615b09e027eSCarola Kruse .seealso: PCFIELDSPLIT, PCFieldSplitSetGKBDelay(), PCFieldSplitSetGKBTol(), PCFieldSplitSetGKBNu() 2616b09e027eSCarola Kruse @*/ 2617b09e027eSCarola Kruse PetscErrorCode PCFieldSplitSetGKBMaxit(PC pc,PetscInt maxit) 2618b09e027eSCarola Kruse { 2619b09e027eSCarola Kruse PetscErrorCode ierr; 2620b09e027eSCarola Kruse 2621b09e027eSCarola Kruse PetscFunctionBegin; 2622b09e027eSCarola Kruse PetscValidHeaderSpecific(pc,PC_CLASSID,1); 2623de482cd7SCarola Kruse PetscValidLogicalCollectiveInt(pc,maxit,2); 2624b09e027eSCarola Kruse ierr = PetscTryMethod(pc,"PCFieldSplitSetGKBMaxit_C",(PC,PetscInt),(pc,maxit));CHKERRQ(ierr); 2625b09e027eSCarola Kruse PetscFunctionReturn(0); 2626b09e027eSCarola Kruse } 2627b09e027eSCarola Kruse 2628b09e027eSCarola Kruse static PetscErrorCode PCFieldSplitSetGKBMaxit_FieldSplit(PC pc,PetscInt maxit) 2629b09e027eSCarola Kruse { 2630b09e027eSCarola Kruse PC_FieldSplit *jac = (PC_FieldSplit*)pc->data; 2631b09e027eSCarola Kruse 2632b09e027eSCarola Kruse PetscFunctionBegin; 2633b09e027eSCarola Kruse jac->gkbmaxit = maxit; 2634b09e027eSCarola Kruse PetscFunctionReturn(0); 2635b09e027eSCarola Kruse } 2636b09e027eSCarola Kruse 2637b09e027eSCarola Kruse /*@ 2638e071a0a4SCarola Kruse PCFieldSplitSetGKBDelay - Sets the delay in the lower bound error estimate in the generalized Golub-Kahan bidiagonalization 2639e071a0a4SCarola Kruse preconditioner. 2640b09e027eSCarola Kruse 2641b09e027eSCarola Kruse Collective on PC 2642b09e027eSCarola Kruse 2643b09e027eSCarola Kruse Notes: 2644e071a0a4SCarola Kruse The algorithm uses a lower bound estimate of the error in energy norm as stopping criterion. The lower bound of the error ||u-u^k||_H 2645e071a0a4SCarola Kruse is expressed as a truncated sum. The error at iteration k can only be measured at iteration (k + delay), and thus the algorithm needs 2646e071a0a4SCarola Kruse at least (delay + 1) iterations to stop. For more details on the generalized Golub-Kahan bidiagonalization method and its lower bound stopping criterion, please refer to 2647b09e027eSCarola Kruse 2648b09e027eSCarola Kruse [Ar13] Generalized Golub-Kahan bidiagonalization and stopping criteria, SIAM J. Matrix Anal. Appl., Vol. 34, No. 2, pp. 571-592, 2013. 2649b09e027eSCarola Kruse 2650b09e027eSCarola Kruse Input Parameters: 2651b09e027eSCarola Kruse + pc - the preconditioner context 2652b09e027eSCarola Kruse - delay - the delay window in the lower bound estimate 2653b09e027eSCarola Kruse 2654b09e027eSCarola Kruse Options Database: 2655b09e027eSCarola Kruse . -pc_fieldsplit_gkb_delay - default is 5 2656b09e027eSCarola Kruse 2657b09e027eSCarola Kruse Level: intermediate 2658b09e027eSCarola Kruse 2659b09e027eSCarola Kruse .seealso: PCFIELDSPLIT, PCFieldSplitSetGKBNu(), PCFieldSplitSetGKBTol(), PCFieldSplitSetGKBMaxit() 2660b09e027eSCarola Kruse @*/ 2661b09e027eSCarola Kruse PetscErrorCode PCFieldSplitSetGKBDelay(PC pc,PetscInt delay) 2662b09e027eSCarola Kruse { 2663b09e027eSCarola Kruse PetscErrorCode ierr; 2664b09e027eSCarola Kruse 2665b09e027eSCarola Kruse PetscFunctionBegin; 2666b09e027eSCarola Kruse PetscValidHeaderSpecific(pc,PC_CLASSID,1); 2667b09e027eSCarola Kruse PetscValidLogicalCollectiveInt(pc,delay,2); 2668b09e027eSCarola Kruse ierr = PetscTryMethod(pc,"PCFieldSplitSetGKBDelay_C",(PC,PetscInt),(pc,delay));CHKERRQ(ierr); 2669b09e027eSCarola Kruse PetscFunctionReturn(0); 2670b09e027eSCarola Kruse } 2671b09e027eSCarola Kruse 2672b09e027eSCarola Kruse static PetscErrorCode PCFieldSplitSetGKBDelay_FieldSplit(PC pc,PetscInt delay) 2673b09e027eSCarola Kruse { 2674b09e027eSCarola Kruse PC_FieldSplit *jac = (PC_FieldSplit*)pc->data; 2675b09e027eSCarola Kruse 2676b09e027eSCarola Kruse PetscFunctionBegin; 2677b09e027eSCarola Kruse jac->gkbdelay = delay; 2678b09e027eSCarola Kruse PetscFunctionReturn(0); 2679b09e027eSCarola Kruse } 2680b09e027eSCarola Kruse 2681b09e027eSCarola Kruse /*@ 2682b09e027eSCarola Kruse PCFieldSplitSetGKBNu - Sets the scalar value nu >= 0 in the transformation H = A00 + nu*A01*A01' of the (1,1) block in the Golub-Kahan bidiagonalization preconditioner. 2683b09e027eSCarola Kruse 2684b09e027eSCarola Kruse Collective on PC 2685b09e027eSCarola Kruse 2686b09e027eSCarola Kruse Notes: 2687e071a0a4SCarola Kruse This shift is in general done to obtain better convergence properties for the outer loop of the algorithm. This is often achieved by chosing nu sufficiently big. However, 2688b09e027eSCarola Kruse if nu is chosen too big, the matrix H might be badly conditioned and the solution of the linear system Hx = b in the inner loop gets difficult. It is therefore 2689b09e027eSCarola Kruse necessary to find a good balance in between the convergence of the inner and outer loop. 2690b09e027eSCarola Kruse 2691b09e027eSCarola Kruse For nu = 0, no shift is done. In this case A00 has to be positive definite. The matrix N in [Ar13] is then chosen as identity. 2692b09e027eSCarola Kruse 2693b09e027eSCarola Kruse [Ar13] Generalized Golub-Kahan bidiagonalization and stopping criteria, SIAM J. Matrix Anal. Appl., Vol. 34, No. 2, pp. 571-592, 2013. 2694b09e027eSCarola Kruse 2695b09e027eSCarola Kruse Input Parameters: 2696b09e027eSCarola Kruse + pc - the preconditioner context 2697b09e027eSCarola Kruse - nu - the shift parameter 2698b09e027eSCarola Kruse 2699b09e027eSCarola Kruse Options Database: 2700b09e027eSCarola Kruse . -pc_fieldsplit_gkb_nu - default is 1 2701b09e027eSCarola Kruse 2702b09e027eSCarola Kruse Level: intermediate 2703b09e027eSCarola Kruse 2704b09e027eSCarola Kruse .seealso: PCFIELDSPLIT, PCFieldSplitSetGKBDelay(), PCFieldSplitSetGKBTol(), PCFieldSplitSetGKBMaxit() 2705b09e027eSCarola Kruse @*/ 2706b09e027eSCarola Kruse PetscErrorCode PCFieldSplitSetGKBNu(PC pc,PetscReal nu) 2707b09e027eSCarola Kruse { 2708b09e027eSCarola Kruse PetscErrorCode ierr; 2709b09e027eSCarola Kruse 2710b09e027eSCarola Kruse PetscFunctionBegin; 2711b09e027eSCarola Kruse PetscValidHeaderSpecific(pc,PC_CLASSID,1); 2712de482cd7SCarola Kruse PetscValidLogicalCollectiveReal(pc,nu,2); 2713b09e027eSCarola Kruse ierr = PetscTryMethod(pc,"PCFieldSplitSetGKBNu_C",(PC,PetscReal),(pc,nu));CHKERRQ(ierr); 2714b09e027eSCarola Kruse PetscFunctionReturn(0); 2715b09e027eSCarola Kruse } 2716b09e027eSCarola Kruse 2717b09e027eSCarola Kruse static PetscErrorCode PCFieldSplitSetGKBNu_FieldSplit(PC pc,PetscReal nu) 2718b09e027eSCarola Kruse { 2719b09e027eSCarola Kruse PC_FieldSplit *jac = (PC_FieldSplit*)pc->data; 2720b09e027eSCarola Kruse 2721b09e027eSCarola Kruse PetscFunctionBegin; 2722b09e027eSCarola Kruse jac->gkbnu = nu; 2723b09e027eSCarola Kruse PetscFunctionReturn(0); 2724b09e027eSCarola Kruse } 2725b09e027eSCarola Kruse 2726b09e027eSCarola Kruse 27271e6b0712SBarry Smith static PetscErrorCode PCFieldSplitSetType_FieldSplit(PC pc,PCCompositeType type) 272879416396SBarry Smith { 272979416396SBarry Smith PC_FieldSplit *jac = (PC_FieldSplit*)pc->data; 2730e69d4d44SBarry Smith PetscErrorCode ierr; 273179416396SBarry Smith 273279416396SBarry Smith PetscFunctionBegin; 273379416396SBarry Smith jac->type = type; 2734e071a0a4SCarola Kruse 2735e071a0a4SCarola Kruse ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitGetSubKSP_C",0);CHKERRQ(ierr); 2736e071a0a4SCarola Kruse ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetSchurPre_C",0);CHKERRQ(ierr); 2737e071a0a4SCarola Kruse ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitGetSchurPre_C",0);CHKERRQ(ierr); 2738e071a0a4SCarola Kruse ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetSchurFactType_C",0);CHKERRQ(ierr); 2739e071a0a4SCarola Kruse ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetSchurScale_C",0);CHKERRQ(ierr); 2740e071a0a4SCarola Kruse ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetGKBTol_C",0);CHKERRQ(ierr); 2741e071a0a4SCarola Kruse ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetGKBMaxit_C",0);CHKERRQ(ierr); 2742e071a0a4SCarola Kruse ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetGKBNu_C",0);CHKERRQ(ierr); 2743e071a0a4SCarola Kruse ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetGKBDelay_C",0);CHKERRQ(ierr); 2744e071a0a4SCarola Kruse 27453b224e63SBarry Smith if (type == PC_COMPOSITE_SCHUR) { 27463b224e63SBarry Smith pc->ops->apply = PCApply_FieldSplit_Schur; 27473b224e63SBarry Smith pc->ops->view = PCView_FieldSplit_Schur; 27482fa5cd67SKarl Rupp 2749bdf89e91SBarry Smith ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitGetSubKSP_C",PCFieldSplitGetSubKSP_FieldSplit_Schur);CHKERRQ(ierr); 275029f8a81cSJed Brown ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetSchurPre_C",PCFieldSplitSetSchurPre_FieldSplit);CHKERRQ(ierr); 275137a82bf0SJed Brown ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitGetSchurPre_C",PCFieldSplitGetSchurPre_FieldSplit);CHKERRQ(ierr); 2752bdf89e91SBarry Smith ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetSchurFactType_C",PCFieldSplitSetSchurFactType_FieldSplit);CHKERRQ(ierr); 2753c096484dSStefano Zampini ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetSchurScale_C",PCFieldSplitSetSchurScale_FieldSplit);CHKERRQ(ierr); 2754a51937d4SCarola Kruse } else if (type == PC_COMPOSITE_GKB){ 2755a51937d4SCarola Kruse pc->ops->apply = PCApply_FieldSplit_GKB; 2756a51937d4SCarola Kruse pc->ops->view = PCView_FieldSplit_GKB; 2757e69d4d44SBarry Smith 2758a51937d4SCarola Kruse ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitGetSubKSP_C",PCFieldSplitGetSubKSP_FieldSplit);CHKERRQ(ierr); 2759b09e027eSCarola Kruse ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetGKBTol_C",PCFieldSplitSetGKBTol_FieldSplit);CHKERRQ(ierr); 2760b09e027eSCarola Kruse ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetGKBMaxit_C",PCFieldSplitSetGKBMaxit_FieldSplit);CHKERRQ(ierr); 2761b09e027eSCarola Kruse ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetGKBNu_C",PCFieldSplitSetGKBNu_FieldSplit);CHKERRQ(ierr); 2762b09e027eSCarola Kruse ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetGKBDelay_C",PCFieldSplitSetGKBDelay_FieldSplit);CHKERRQ(ierr); 27633b224e63SBarry Smith } else { 27643b224e63SBarry Smith pc->ops->apply = PCApply_FieldSplit; 27653b224e63SBarry Smith pc->ops->view = PCView_FieldSplit; 27662fa5cd67SKarl Rupp 2767bdf89e91SBarry Smith ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitGetSubKSP_C",PCFieldSplitGetSubKSP_FieldSplit);CHKERRQ(ierr); 27683b224e63SBarry Smith } 276979416396SBarry Smith PetscFunctionReturn(0); 277079416396SBarry Smith } 277179416396SBarry Smith 27721e6b0712SBarry Smith static PetscErrorCode PCFieldSplitSetBlockSize_FieldSplit(PC pc,PetscInt bs) 277351f519a2SBarry Smith { 277451f519a2SBarry Smith PC_FieldSplit *jac = (PC_FieldSplit*)pc->data; 277551f519a2SBarry Smith 277651f519a2SBarry Smith PetscFunctionBegin; 2777ce94432eSBarry Smith if (bs < 1) SETERRQ1(PetscObjectComm((PetscObject)pc),PETSC_ERR_ARG_OUTOFRANGE,"Blocksize must be positive, you gave %D",bs); 2778ce94432eSBarry Smith if (jac->bs > 0 && jac->bs != bs) SETERRQ2(PetscObjectComm((PetscObject)pc),PETSC_ERR_ARG_WRONGSTATE,"Cannot change fieldsplit blocksize from %D to %D after it has been set",jac->bs,bs); 277951f519a2SBarry Smith jac->bs = bs; 278051f519a2SBarry Smith PetscFunctionReturn(0); 278151f519a2SBarry Smith } 278251f519a2SBarry Smith 2783bc08b0f1SBarry Smith /*@ 278479416396SBarry Smith PCFieldSplitSetType - Sets the type of fieldsplit preconditioner. 278579416396SBarry Smith 278679416396SBarry Smith Collective on PC 278779416396SBarry Smith 278879416396SBarry Smith Input Parameter: 278979416396SBarry Smith . pc - the preconditioner context 279081540f2fSBarry Smith . type - PC_COMPOSITE_ADDITIVE, PC_COMPOSITE_MULTIPLICATIVE (default), PC_COMPOSITE_SYMMETRIC_MULTIPLICATIVE, PC_COMPOSITE_SPECIAL, PC_COMPOSITE_SCHUR 279179416396SBarry Smith 279279416396SBarry Smith Options Database Key: 2793a4efd8eaSMatthew Knepley . -pc_fieldsplit_type <type: one of multiplicative, additive, symmetric_multiplicative, special, schur> - Sets fieldsplit preconditioner type 279479416396SBarry Smith 2795b02e2d75SMatthew G Knepley Level: Intermediate 279679416396SBarry Smith 279779416396SBarry Smith .keywords: PC, set, type, composite preconditioner, additive, multiplicative 279879416396SBarry Smith 279979416396SBarry Smith .seealso: PCCompositeSetType() 280079416396SBarry Smith 280179416396SBarry Smith @*/ 28027087cfbeSBarry Smith PetscErrorCode PCFieldSplitSetType(PC pc,PCCompositeType type) 280379416396SBarry Smith { 28044ac538c5SBarry Smith PetscErrorCode ierr; 280579416396SBarry Smith 280679416396SBarry Smith PetscFunctionBegin; 28070700a824SBarry Smith PetscValidHeaderSpecific(pc,PC_CLASSID,1); 28084ac538c5SBarry Smith ierr = PetscTryMethod(pc,"PCFieldSplitSetType_C",(PC,PCCompositeType),(pc,type));CHKERRQ(ierr); 280979416396SBarry Smith PetscFunctionReturn(0); 281079416396SBarry Smith } 281179416396SBarry Smith 2812b02e2d75SMatthew G Knepley /*@ 2813b02e2d75SMatthew G Knepley PCFieldSplitGetType - Gets the type of fieldsplit preconditioner. 2814b02e2d75SMatthew G Knepley 2815b02e2d75SMatthew G Knepley Not collective 2816b02e2d75SMatthew G Knepley 2817b02e2d75SMatthew G Knepley Input Parameter: 2818b02e2d75SMatthew G Knepley . pc - the preconditioner context 2819b02e2d75SMatthew G Knepley 2820b02e2d75SMatthew G Knepley Output Parameter: 2821b02e2d75SMatthew G Knepley . type - PC_COMPOSITE_ADDITIVE, PC_COMPOSITE_MULTIPLICATIVE (default), PC_COMPOSITE_SYMMETRIC_MULTIPLICATIVE, PC_COMPOSITE_SPECIAL, PC_COMPOSITE_SCHUR 2822b02e2d75SMatthew G Knepley 2823b02e2d75SMatthew G Knepley Level: Intermediate 2824b02e2d75SMatthew G Knepley 2825b02e2d75SMatthew G Knepley .keywords: PC, set, type, composite preconditioner, additive, multiplicative 2826b02e2d75SMatthew G Knepley .seealso: PCCompositeSetType() 2827b02e2d75SMatthew G Knepley @*/ 2828b02e2d75SMatthew G Knepley PetscErrorCode PCFieldSplitGetType(PC pc, PCCompositeType *type) 2829b02e2d75SMatthew G Knepley { 2830b02e2d75SMatthew G Knepley PC_FieldSplit *jac = (PC_FieldSplit*) pc->data; 2831b02e2d75SMatthew G Knepley 2832b02e2d75SMatthew G Knepley PetscFunctionBegin; 2833b02e2d75SMatthew G Knepley PetscValidHeaderSpecific(pc,PC_CLASSID,1); 2834b02e2d75SMatthew G Knepley PetscValidIntPointer(type,2); 2835b02e2d75SMatthew G Knepley *type = jac->type; 2836b02e2d75SMatthew G Knepley PetscFunctionReturn(0); 2837b02e2d75SMatthew G Knepley } 2838b02e2d75SMatthew G Knepley 28394ab8060aSDmitry Karpeev /*@ 28404ab8060aSDmitry Karpeev PCFieldSplitSetDMSplits - Flags whether DMCreateFieldDecomposition() should be used to define the splits, whenever possible. 28414ab8060aSDmitry Karpeev 28424ab8060aSDmitry Karpeev Logically Collective 28434ab8060aSDmitry Karpeev 28444ab8060aSDmitry Karpeev Input Parameters: 28454ab8060aSDmitry Karpeev + pc - the preconditioner context 28464ab8060aSDmitry Karpeev - flg - boolean indicating whether to use field splits defined by the DM 28474ab8060aSDmitry Karpeev 28484ab8060aSDmitry Karpeev Options Database Key: 28494ab8060aSDmitry Karpeev . -pc_fieldsplit_dm_splits 28504ab8060aSDmitry Karpeev 28514ab8060aSDmitry Karpeev Level: Intermediate 28524ab8060aSDmitry Karpeev 28534ab8060aSDmitry Karpeev .keywords: PC, DM, composite preconditioner, additive, multiplicative 28544ab8060aSDmitry Karpeev 28554ab8060aSDmitry Karpeev .seealso: PCFieldSplitGetDMSplits() 28564ab8060aSDmitry Karpeev 28574ab8060aSDmitry Karpeev @*/ 28584ab8060aSDmitry Karpeev PetscErrorCode PCFieldSplitSetDMSplits(PC pc,PetscBool flg) 28594ab8060aSDmitry Karpeev { 28604ab8060aSDmitry Karpeev PC_FieldSplit *jac = (PC_FieldSplit*)pc->data; 28614ab8060aSDmitry Karpeev PetscBool isfs; 28624ab8060aSDmitry Karpeev PetscErrorCode ierr; 28634ab8060aSDmitry Karpeev 28644ab8060aSDmitry Karpeev PetscFunctionBegin; 28654ab8060aSDmitry Karpeev PetscValidHeaderSpecific(pc,PC_CLASSID,1); 28664ab8060aSDmitry Karpeev PetscValidLogicalCollectiveBool(pc,flg,2); 28674ab8060aSDmitry Karpeev ierr = PetscObjectTypeCompare((PetscObject)pc,PCFIELDSPLIT,&isfs);CHKERRQ(ierr); 28684ab8060aSDmitry Karpeev if (isfs) { 28694ab8060aSDmitry Karpeev jac->dm_splits = flg; 28704ab8060aSDmitry Karpeev } 28714ab8060aSDmitry Karpeev PetscFunctionReturn(0); 28724ab8060aSDmitry Karpeev } 28734ab8060aSDmitry Karpeev 28744ab8060aSDmitry Karpeev 28754ab8060aSDmitry Karpeev /*@ 28764ab8060aSDmitry Karpeev PCFieldSplitGetDMSplits - Returns flag indicating whether DMCreateFieldDecomposition() should be used to define the splits, whenever possible. 28774ab8060aSDmitry Karpeev 28784ab8060aSDmitry Karpeev Logically Collective 28794ab8060aSDmitry Karpeev 28804ab8060aSDmitry Karpeev Input Parameter: 28814ab8060aSDmitry Karpeev . pc - the preconditioner context 28824ab8060aSDmitry Karpeev 28834ab8060aSDmitry Karpeev Output Parameter: 28844ab8060aSDmitry Karpeev . flg - boolean indicating whether to use field splits defined by the DM 28854ab8060aSDmitry Karpeev 28864ab8060aSDmitry Karpeev Level: Intermediate 28874ab8060aSDmitry Karpeev 28884ab8060aSDmitry Karpeev .keywords: PC, DM, composite preconditioner, additive, multiplicative 28894ab8060aSDmitry Karpeev 28904ab8060aSDmitry Karpeev .seealso: PCFieldSplitSetDMSplits() 28914ab8060aSDmitry Karpeev 28924ab8060aSDmitry Karpeev @*/ 28934ab8060aSDmitry Karpeev PetscErrorCode PCFieldSplitGetDMSplits(PC pc,PetscBool* flg) 28944ab8060aSDmitry Karpeev { 28954ab8060aSDmitry Karpeev PC_FieldSplit *jac = (PC_FieldSplit*)pc->data; 28964ab8060aSDmitry Karpeev PetscBool isfs; 28974ab8060aSDmitry Karpeev PetscErrorCode ierr; 28984ab8060aSDmitry Karpeev 28994ab8060aSDmitry Karpeev PetscFunctionBegin; 29004ab8060aSDmitry Karpeev PetscValidHeaderSpecific(pc,PC_CLASSID,1); 29014ab8060aSDmitry Karpeev PetscValidPointer(flg,2); 29024ab8060aSDmitry Karpeev ierr = PetscObjectTypeCompare((PetscObject)pc,PCFIELDSPLIT,&isfs);CHKERRQ(ierr); 29034ab8060aSDmitry Karpeev if (isfs) { 29044ab8060aSDmitry Karpeev if(flg) *flg = jac->dm_splits; 29054ab8060aSDmitry Karpeev } 29064ab8060aSDmitry Karpeev PetscFunctionReturn(0); 29074ab8060aSDmitry Karpeev } 29084ab8060aSDmitry Karpeev 29097b752e3dSPatrick Sanan /*@ 29107b752e3dSPatrick Sanan PCFieldSplitGetDetectSaddlePoint - Returns flag indicating whether PCFieldSplit will attempt to automatically determine fields based on zero diagonal entries. 29117b752e3dSPatrick Sanan 29127b752e3dSPatrick Sanan Logically Collective 29137b752e3dSPatrick Sanan 29147b752e3dSPatrick Sanan Input Parameter: 29157b752e3dSPatrick Sanan . pc - the preconditioner context 29167b752e3dSPatrick Sanan 29177b752e3dSPatrick Sanan Output Parameter: 29187b752e3dSPatrick Sanan . flg - boolean indicating whether to detect fields or not 29197b752e3dSPatrick Sanan 29207b752e3dSPatrick Sanan Level: Intermediate 29217b752e3dSPatrick Sanan 29227b752e3dSPatrick Sanan .seealso: PCFIELDSPLIT, PCFieldSplitSetDetectSaddlePoint() 29237b752e3dSPatrick Sanan 29247b752e3dSPatrick Sanan @*/ 29257b752e3dSPatrick Sanan PetscErrorCode PCFieldSplitGetDetectSaddlePoint(PC pc,PetscBool *flg) 29267b752e3dSPatrick Sanan { 29277b752e3dSPatrick Sanan PC_FieldSplit *jac = (PC_FieldSplit*)pc->data; 29287b752e3dSPatrick Sanan 29297b752e3dSPatrick Sanan PetscFunctionBegin; 29307b752e3dSPatrick Sanan *flg = jac->detect; 29317b752e3dSPatrick Sanan PetscFunctionReturn(0); 29327b752e3dSPatrick Sanan } 29337b752e3dSPatrick Sanan 29347b752e3dSPatrick Sanan /*@ 29357b752e3dSPatrick Sanan PCFieldSplitSetDetectSaddlePoint - Sets flag indicating whether PCFieldSplit will attempt to automatically determine fields based on zero diagonal entries. 29367b752e3dSPatrick Sanan 29377b752e3dSPatrick Sanan Logically Collective 29387b752e3dSPatrick Sanan 29397b752e3dSPatrick Sanan Notes: 29407b752e3dSPatrick Sanan Also sets the split type to PC_COMPOSITE_SCHUR (see PCFieldSplitSetType()) and the Schur preconditioner type to PC_FIELDSPLIT_SCHUR_PRE_SELF (see PCFieldSplitSetSchurPre()). 29417b752e3dSPatrick Sanan 29427b752e3dSPatrick Sanan Input Parameter: 29437b752e3dSPatrick Sanan . pc - the preconditioner context 29447b752e3dSPatrick Sanan 29457b752e3dSPatrick Sanan Output Parameter: 29467b752e3dSPatrick Sanan . flg - boolean indicating whether to detect fields or not 29477b752e3dSPatrick Sanan 29487b752e3dSPatrick Sanan Options Database Key: 29497b752e3dSPatrick Sanan . -pc_fieldsplit_detect_saddle_point 29507b752e3dSPatrick Sanan 29517b752e3dSPatrick Sanan Level: Intermediate 29527b752e3dSPatrick Sanan 29537b752e3dSPatrick Sanan .seealso: PCFIELDSPLIT, PCFieldSplitSetDetectSaddlePoint(), PCFieldSplitSetType(), PCFieldSplitSetSchurPre() 29547b752e3dSPatrick Sanan 29557b752e3dSPatrick Sanan @*/ 29567b752e3dSPatrick Sanan PetscErrorCode PCFieldSplitSetDetectSaddlePoint(PC pc,PetscBool flg) 29577b752e3dSPatrick Sanan { 29587b752e3dSPatrick Sanan PC_FieldSplit *jac = (PC_FieldSplit*)pc->data; 29597b752e3dSPatrick Sanan PetscErrorCode ierr; 29607b752e3dSPatrick Sanan 29617b752e3dSPatrick Sanan PetscFunctionBegin; 29627b752e3dSPatrick Sanan jac->detect = flg; 29637b752e3dSPatrick Sanan if (jac->detect) { 29647b752e3dSPatrick Sanan ierr = PCFieldSplitSetType(pc,PC_COMPOSITE_SCHUR);CHKERRQ(ierr); 29657b752e3dSPatrick Sanan ierr = PCFieldSplitSetSchurPre(pc,PC_FIELDSPLIT_SCHUR_PRE_SELF,NULL);CHKERRQ(ierr); 29667b752e3dSPatrick Sanan } 29677b752e3dSPatrick Sanan PetscFunctionReturn(0); 29687b752e3dSPatrick Sanan } 29697b752e3dSPatrick Sanan 29700971522cSBarry Smith /* -------------------------------------------------------------------------------------*/ 29710971522cSBarry Smith /*MC 2972a8c7a070SBarry Smith PCFIELDSPLIT - Preconditioner created by combining separate preconditioners for individual 2973a04f6461SBarry Smith fields or groups of fields. See the users manual section "Solving Block Matrices" for more details. 29740971522cSBarry Smith 2975edf189efSBarry Smith To set options on the solvers for each block append -fieldsplit_ to all the PC 2976edf189efSBarry Smith options database keys. For example, -fieldsplit_pc_type ilu -fieldsplit_pc_factor_levels 1 29770971522cSBarry Smith 2978a8c7a070SBarry Smith To set the options on the solvers separate for each block call PCFieldSplitGetSubKSP() 297969a612a9SBarry Smith and set the options directly on the resulting KSP object 29800971522cSBarry Smith 29810971522cSBarry Smith Level: intermediate 29820971522cSBarry Smith 298379416396SBarry Smith Options Database Keys: 298481540f2fSBarry Smith + -pc_fieldsplit_%d_fields <a,b,..> - indicates the fields to be used in the %d'th split 298581540f2fSBarry Smith . -pc_fieldsplit_default - automatically add any fields to additional splits that have not 298681540f2fSBarry Smith been supplied explicitly by -pc_fieldsplit_%d_fields 298781540f2fSBarry Smith . -pc_fieldsplit_block_size <bs> - size of block that defines fields (i.e. there are bs fields) 2988a51937d4SCarola Kruse . -pc_fieldsplit_type <additive,multiplicative,symmetric_multiplicative,schur,gkb> - type of relaxation or factorization splitting 2989a6a584a2SBarry Smith . -pc_fieldsplit_schur_precondition <self,selfp,user,a11,full> - default is a11; see PCFieldSplitSetSchurPre() 29907b752e3dSPatrick Sanan . -pc_fieldsplit_detect_saddle_point - automatically finds rows with zero diagonal and uses Schur complement with no preconditioner as the solver 299179416396SBarry Smith 2992a51937d4SCarola Kruse . Options prefix for inner solvers when using Schur complement preconditioner are -fieldsplit_0_ and -fieldsplit_1_ 29935d4c12cdSJungho Lee for all other solvers they are -fieldsplit_%d_ for the dth field, use -fieldsplit_ for all fields 2994a51937d4SCarola Kruse - Options prefix for inner solver when using Golub Kahan biadiagonalization preconditioner is -fieldsplit_0_ 29955d4c12cdSJungho Lee 2996c8a0d604SMatthew G Knepley Notes: 2997c8a0d604SMatthew G Knepley Use PCFieldSplitSetFields() to set fields defined by "strided" entries and PCFieldSplitSetIS() 2998d32f9abdSBarry Smith to define a field by an arbitrary collection of entries. 2999d32f9abdSBarry Smith 3000d32f9abdSBarry Smith If no fields are set the default is used. The fields are defined by entries strided by bs, 3001d32f9abdSBarry Smith beginning at 0 then 1, etc to bs-1. The block size can be set with PCFieldSplitSetBlockSize(), 3002d32f9abdSBarry Smith if this is not called the block size defaults to the blocksize of the second matrix passed 3003d32f9abdSBarry Smith to KSPSetOperators()/PCSetOperators(). 3004d32f9abdSBarry Smith 3005c8a0d604SMatthew G Knepley $ For the Schur complement preconditioner if J = ( A00 A01 ) 3006c8a0d604SMatthew G Knepley $ ( A10 A11 ) 3007c8a0d604SMatthew G Knepley $ the preconditioner using full factorization is 300813b05affSJed Brown $ ( I -ksp(A00) A01 ) ( inv(A00) 0 ) ( I 0 ) 3009c8a0d604SMatthew G Knepley $ ( 0 I ) ( 0 ksp(S) ) ( -A10 ksp(A00) I ) 301013b05affSJed Brown where the action of inv(A00) is applied using the KSP solver with prefix -fieldsplit_0_. S is the Schur complement 301113b05affSJed Brown $ S = A11 - A10 ksp(A00) A01 301213b05affSJed Brown which is usually dense and not stored explicitly. The action of ksp(S) is computed using the KSP solver with prefix -fieldsplit_splitname_ (where splitname was given 3013686bed4dSStefano Zampini in providing the SECOND split or 1 if not give). For PCFieldSplitGetSubKSP() when field number is 0, 3014c8a0d604SMatthew G Knepley it returns the KSP associated with -fieldsplit_0_ while field number 1 gives -fieldsplit_1_ KSP. By default 3015a6a584a2SBarry Smith A11 is used to construct a preconditioner for S, use PCFieldSplitSetSchurPre() for all the possible ways to construct the preconditioner for S. 30161d71051fSDmitry Karpeev 3017a7476a74SDmitry Karpeev The factorization type is set using -pc_fieldsplit_schur_fact_type <diag, lower, upper, full>. The full is shown above, 30185668aaf4SBarry Smith diag gives 3019c8a0d604SMatthew G Knepley $ ( inv(A00) 0 ) 3020c8a0d604SMatthew G Knepley $ ( 0 -ksp(S) ) 3021c096484dSStefano Zampini note that slightly counter intuitively there is a negative in front of the ksp(S) so that the preconditioner is positive definite. For SPD matrices J, the sign flip 3022c096484dSStefano Zampini can be turned off with PCFieldSplitSetSchurScale() or by command line -pc_fieldsplit_schur_scale 1.0. The lower factorization is the inverse of 3023c8a0d604SMatthew G Knepley $ ( A00 0 ) 3024c8a0d604SMatthew G Knepley $ ( A10 S ) 3025c8a0d604SMatthew G Knepley where the inverses of A00 and S are applied using KSPs. The upper factorization is the inverse of 3026c8a0d604SMatthew G Knepley $ ( A00 A01 ) 3027c8a0d604SMatthew G Knepley $ ( 0 S ) 3028c8a0d604SMatthew G Knepley where again the inverses of A00 and S are applied using KSPs. 3029e69d4d44SBarry Smith 3030edf189efSBarry Smith If only one set of indices (one IS) is provided with PCFieldSplitSetIS() then the complement of that IS 3031edf189efSBarry Smith is used automatically for a second block. 3032edf189efSBarry Smith 3033ff218e97SBarry Smith The fieldsplit preconditioner cannot currently be used with the BAIJ or SBAIJ data formats if the blocksize is larger than 1. 3034ff218e97SBarry Smith Generally it should be used with the AIJ format. 3035ff218e97SBarry Smith 3036ff218e97SBarry Smith The forms of these preconditioners are closely related if not identical to forms derived as "Distributive Iterations", see, 3037ff218e97SBarry Smith for example, page 294 in "Principles of Computational Fluid Dynamics" by Pieter Wesseling. Note that one can also use PCFIELDSPLIT 3038ff218e97SBarry Smith inside a smoother resulting in "Distributive Smoothers". 30390716a85fSBarry Smith 3040a541d17aSBarry Smith Concepts: physics based preconditioners, block preconditioners 30410971522cSBarry Smith 30423bc631e0SBarry Smith There is a nice discussion of block preconditioners in 30433bc631e0SBarry Smith 30443bc631e0SBarry Smith [El08] A taxonomy and comparison of parallel block multi-level preconditioners for the incompressible Navier-Stokes equations 30453bc631e0SBarry Smith Howard Elman, V.E. Howle, John Shadid, Robert Shuttleworth, Ray Tuminaro, Journal of Computational Physics 227 (2008) 1790--1808 30463bc631e0SBarry Smith http://chess.cs.umd.edu/~elman/papers/tax.pdf 30473bc631e0SBarry Smith 30484d308398SBarry Smith The Constrained Pressure Preconditioner (CPR) can be implemented using PCCOMPOSITE with PCGALERKIN. CPR first solves an R A P subsystem, updates the 30494d308398SBarry Smith residual on all variables (PCCompositeSetType(pc,PC_COMPOSITE_MULTIPLICATIVE)), and then applies a simple ILU like preconditioner on all the variables. 3050a6a584a2SBarry Smith 3051e071a0a4SCarola Kruse The generalized Golub-Kahan bidiagonalization preconditioner (gkb) can be applied to symmetric 2x2 block matrices of the shape 3052a51937d4SCarola Kruse $ ( A00 A01 ) 3053a51937d4SCarola Kruse $ ( A01' 0 ) 3054a51937d4SCarola Kruse with A00 positive semi-definite. The implementation follows [Ar13]. Therein, we choose N := 1/nu * I and the (1,1)-block of the matrix is modified to H = A00 + nu*A01*A01'. 3055e071a0a4SCarola Kruse A linear system Hx = b has to be solved in each iteration of the GKB algorithm. This solver is chosen with the option prefix -fieldsplit_0_. 3056a51937d4SCarola Kruse 3057a51937d4SCarola Kruse [Ar13] Generalized Golub-Kahan bidiagonalization and stopping criteria, SIAM J. Matrix Anal. Appl., Vol. 34, No. 2, pp. 571-592, 2013. 3058a51937d4SCarola Kruse 30597e8cb189SBarry Smith .seealso: PCCreate(), PCSetType(), PCType (for list of available types), PC, Block_Preconditioners, PCLSC, 3060285fb4e2SStefano Zampini PCFieldSplitGetSubKSP(), PCFieldSplitSchurGetSubKSP(), PCFieldSplitSetFields(), PCFieldSplitSetType(), PCFieldSplitSetIS(), PCFieldSplitSetSchurPre(), 30617b752e3dSPatrick Sanan MatSchurComplementSetAinvType(), PCFieldSplitSetSchurScale(), 30627b752e3dSPatrick Sanan PCFieldSplitSetDetectSaddlePoint() 30630971522cSBarry Smith M*/ 30640971522cSBarry Smith 30658cc058d9SJed Brown PETSC_EXTERN PetscErrorCode PCCreate_FieldSplit(PC pc) 30660971522cSBarry Smith { 30670971522cSBarry Smith PetscErrorCode ierr; 30680971522cSBarry Smith PC_FieldSplit *jac; 30690971522cSBarry Smith 30700971522cSBarry Smith PetscFunctionBegin; 3071b00a9115SJed Brown ierr = PetscNewLog(pc,&jac);CHKERRQ(ierr); 30722fa5cd67SKarl Rupp 30730971522cSBarry Smith jac->bs = -1; 30740971522cSBarry Smith jac->nsplits = 0; 30753e197d65SBarry Smith jac->type = PC_COMPOSITE_MULTIPLICATIVE; 3076e6cab6aaSJed Brown jac->schurpre = PC_FIELDSPLIT_SCHUR_PRE_USER; /* Try user preconditioner first, fall back on diagonal */ 3077c9c6ffaaSJed Brown jac->schurfactorization = PC_FIELDSPLIT_SCHUR_FACT_FULL; 3078c096484dSStefano Zampini jac->schurscale = -1.0; 3079fbe7908bSJed Brown jac->dm_splits = PETSC_TRUE; 30807b752e3dSPatrick Sanan jac->detect = PETSC_FALSE; 3081a51937d4SCarola Kruse jac->gkbtol = 1e-5; 3082a51937d4SCarola Kruse jac->gkbdelay = 5; 3083a51937d4SCarola Kruse jac->gkbnu = 1; 3084a51937d4SCarola Kruse jac->gkbmaxit = 100; 3085de482cd7SCarola Kruse jac->gkbmonitor = PETSC_FALSE; 308651f519a2SBarry Smith 30870971522cSBarry Smith pc->data = (void*)jac; 30880971522cSBarry Smith 30890971522cSBarry Smith pc->ops->apply = PCApply_FieldSplit; 3090421e10b8SBarry Smith pc->ops->applytranspose = PCApplyTranspose_FieldSplit; 30910971522cSBarry Smith pc->ops->setup = PCSetUp_FieldSplit; 3092574deadeSBarry Smith pc->ops->reset = PCReset_FieldSplit; 30930971522cSBarry Smith pc->ops->destroy = PCDestroy_FieldSplit; 30940971522cSBarry Smith pc->ops->setfromoptions = PCSetFromOptions_FieldSplit; 30950971522cSBarry Smith pc->ops->view = PCView_FieldSplit; 30960971522cSBarry Smith pc->ops->applyrichardson = 0; 30970971522cSBarry Smith 3098285fb4e2SStefano Zampini ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSchurGetSubKSP_C",PCFieldSplitSchurGetSubKSP_FieldSplit);CHKERRQ(ierr); 3099bdf89e91SBarry Smith ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitGetSubKSP_C",PCFieldSplitGetSubKSP_FieldSplit);CHKERRQ(ierr); 3100bdf89e91SBarry Smith ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetFields_C",PCFieldSplitSetFields_FieldSplit);CHKERRQ(ierr); 3101bdf89e91SBarry Smith ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetIS_C",PCFieldSplitSetIS_FieldSplit);CHKERRQ(ierr); 3102bdf89e91SBarry Smith ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetType_C",PCFieldSplitSetType_FieldSplit);CHKERRQ(ierr); 3103bdf89e91SBarry Smith ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetBlockSize_C",PCFieldSplitSetBlockSize_FieldSplit);CHKERRQ(ierr); 31046dbb499eSCian Wilson ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitRestrictIS_C",PCFieldSplitRestrictIS_FieldSplit);CHKERRQ(ierr); 31050971522cSBarry Smith PetscFunctionReturn(0); 31060971522cSBarry Smith } 3107