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 */ 55a51937d4SCarola Kruse 5697bbdb24SBarry Smith PC_FieldSplitLink head; 576dbb499eSCian Wilson PetscBool isrestrict; /* indicates PCFieldSplitRestrictIS() has been last called on this object, hack */ 58c1570756SJed Brown PetscBool suboptionsset; /* Indicates that the KSPSetFromOptions() has been called on the sub-KSPs */ 594ab8060aSDmitry Karpeev PetscBool dm_splits; /* Whether to use DMCreateFieldDecomposition() whenever possible */ 60c84da90fSDmitry Karpeev PetscBool diag_use_amat; /* Whether to extract diagonal matrix blocks from Amat, rather than Pmat (weaker than -pc_use_amat) */ 61c84da90fSDmitry Karpeev PetscBool offdiag_use_amat; /* Whether to extract off-diagonal matrix blocks from Amat, rather than Pmat (weaker than -pc_use_amat) */ 627b752e3dSPatrick Sanan PetscBool detect; /* Whether to form 2-way split by finding zero diagonal entries */ 630971522cSBarry Smith } PC_FieldSplit; 640971522cSBarry Smith 6516913363SBarry Smith /* 6695452b02SPatrick Sanan Notes: 6795452b02SPatrick Sanan there is no particular reason that pmat, x, and y are stored as arrays in PC_FieldSplit instead of 6816913363SBarry Smith inside PC_FieldSplitLink, just historical. If you want to be able to add new fields after already using the 6916913363SBarry Smith PC you could change this. 7016913363SBarry Smith */ 71084e4875SJed Brown 72e6cab6aaSJed Brown /* This helper is so that setting a user-provided preconditioning matrix is orthogonal to choosing to use it. This way the 73084e4875SJed Brown * application-provided FormJacobian can provide this matrix without interfering with the user's (command-line) choices. */ 74084e4875SJed Brown static Mat FieldSplitSchurPre(PC_FieldSplit *jac) 75084e4875SJed Brown { 76084e4875SJed Brown switch (jac->schurpre) { 77084e4875SJed Brown case PC_FIELDSPLIT_SCHUR_PRE_SELF: return jac->schur; 78a7476a74SDmitry Karpeev case PC_FIELDSPLIT_SCHUR_PRE_SELFP: return jac->schurp; 79e87fab1bSBarry Smith case PC_FIELDSPLIT_SCHUR_PRE_A11: return jac->pmat[1]; 80e74569cdSMatthew G. Knepley case PC_FIELDSPLIT_SCHUR_PRE_FULL: /* We calculate this and store it in schur_user */ 81084e4875SJed Brown case PC_FIELDSPLIT_SCHUR_PRE_USER: /* Use a user-provided matrix if it is given, otherwise diagonal block */ 82084e4875SJed Brown default: 83084e4875SJed Brown return jac->schur_user ? jac->schur_user : jac->pmat[1]; 84084e4875SJed Brown } 85084e4875SJed Brown } 86084e4875SJed Brown 87084e4875SJed Brown 889804daf3SBarry Smith #include <petscdraw.h> 890971522cSBarry Smith static PetscErrorCode PCView_FieldSplit(PC pc,PetscViewer viewer) 900971522cSBarry Smith { 910971522cSBarry Smith PC_FieldSplit *jac = (PC_FieldSplit*)pc->data; 920971522cSBarry Smith PetscErrorCode ierr; 93d9884438SBarry Smith PetscBool iascii,isdraw; 940971522cSBarry Smith PetscInt i,j; 955a9f2f41SSatish Balay PC_FieldSplitLink ilink = jac->head; 960971522cSBarry Smith 970971522cSBarry Smith PetscFunctionBegin; 98251f4c67SDmitry Karpeev ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&iascii);CHKERRQ(ierr); 99d9884438SBarry Smith ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERDRAW,&isdraw);CHKERRQ(ierr); 1000971522cSBarry Smith if (iascii) { 1012c9966d7SBarry Smith if (jac->bs > 0) { 10251f519a2SBarry Smith ierr = PetscViewerASCIIPrintf(viewer," FieldSplit with %s composition: total splits = %D, blocksize = %D\n",PCCompositeTypes[jac->type],jac->nsplits,jac->bs);CHKERRQ(ierr); 1032c9966d7SBarry Smith } else { 1042c9966d7SBarry Smith ierr = PetscViewerASCIIPrintf(viewer," FieldSplit with %s composition: total splits = %D\n",PCCompositeTypes[jac->type],jac->nsplits);CHKERRQ(ierr); 1052c9966d7SBarry Smith } 106f5236f50SJed Brown if (pc->useAmat) { 107f5236f50SJed Brown ierr = PetscViewerASCIIPrintf(viewer," using Amat (not Pmat) as operator for blocks\n");CHKERRQ(ierr); 108a3df900dSMatthew G Knepley } 109c84da90fSDmitry Karpeev if (jac->diag_use_amat) { 110c84da90fSDmitry Karpeev ierr = PetscViewerASCIIPrintf(viewer," using Amat (not Pmat) as operator for diagonal blocks\n");CHKERRQ(ierr); 111c84da90fSDmitry Karpeev } 112c84da90fSDmitry Karpeev if (jac->offdiag_use_amat) { 113c84da90fSDmitry Karpeev ierr = PetscViewerASCIIPrintf(viewer," using Amat (not Pmat) as operator for off-diagonal blocks\n");CHKERRQ(ierr); 114c84da90fSDmitry Karpeev } 11569a612a9SBarry Smith ierr = PetscViewerASCIIPrintf(viewer," Solver info for each split is in the following KSP objects:\n");CHKERRQ(ierr); 1160971522cSBarry Smith for (i=0; i<jac->nsplits; i++) { 1171ab39975SBarry Smith if (ilink->fields) { 1180971522cSBarry Smith ierr = PetscViewerASCIIPrintf(viewer,"Split number %D Fields ",i);CHKERRQ(ierr); 11979416396SBarry Smith ierr = PetscViewerASCIIUseTabs(viewer,PETSC_FALSE);CHKERRQ(ierr); 1205a9f2f41SSatish Balay for (j=0; j<ilink->nfields; j++) { 12179416396SBarry Smith if (j > 0) { 12279416396SBarry Smith ierr = PetscViewerASCIIPrintf(viewer,",");CHKERRQ(ierr); 12379416396SBarry Smith } 1245a9f2f41SSatish Balay ierr = PetscViewerASCIIPrintf(viewer," %D",ilink->fields[j]);CHKERRQ(ierr); 1250971522cSBarry Smith } 1260971522cSBarry Smith ierr = PetscViewerASCIIPrintf(viewer,"\n");CHKERRQ(ierr); 12779416396SBarry Smith ierr = PetscViewerASCIIUseTabs(viewer,PETSC_TRUE);CHKERRQ(ierr); 1281ab39975SBarry Smith } else { 1291ab39975SBarry Smith ierr = PetscViewerASCIIPrintf(viewer,"Split number %D Defined by IS\n",i);CHKERRQ(ierr); 1301ab39975SBarry Smith } 1315a9f2f41SSatish Balay ierr = KSPView(ilink->ksp,viewer);CHKERRQ(ierr); 1325a9f2f41SSatish Balay ilink = ilink->next; 1330971522cSBarry Smith } 1342fa5cd67SKarl Rupp } 1352fa5cd67SKarl Rupp 1362fa5cd67SKarl Rupp if (isdraw) { 137d9884438SBarry Smith PetscDraw draw; 138d9884438SBarry Smith PetscReal x,y,w,wd; 139d9884438SBarry Smith 140d9884438SBarry Smith ierr = PetscViewerDrawGetDraw(viewer,0,&draw);CHKERRQ(ierr); 141d9884438SBarry Smith ierr = PetscDrawGetCurrentPoint(draw,&x,&y);CHKERRQ(ierr); 142d9884438SBarry Smith w = 2*PetscMin(1.0 - x,x); 143d9884438SBarry Smith wd = w/(jac->nsplits + 1); 144d9884438SBarry Smith x = x - wd*(jac->nsplits-1)/2.0; 145d9884438SBarry Smith for (i=0; i<jac->nsplits; i++) { 146d9884438SBarry Smith ierr = PetscDrawPushCurrentPoint(draw,x,y);CHKERRQ(ierr); 147d9884438SBarry Smith ierr = KSPView(ilink->ksp,viewer);CHKERRQ(ierr); 148d9884438SBarry Smith ierr = PetscDrawPopCurrentPoint(draw);CHKERRQ(ierr); 149d9884438SBarry Smith x += wd; 150d9884438SBarry Smith ilink = ilink->next; 151d9884438SBarry Smith } 1520971522cSBarry Smith } 1530971522cSBarry Smith PetscFunctionReturn(0); 1540971522cSBarry Smith } 1550971522cSBarry Smith 1563b224e63SBarry Smith static PetscErrorCode PCView_FieldSplit_Schur(PC pc,PetscViewer viewer) 1573b224e63SBarry Smith { 1583b224e63SBarry Smith PC_FieldSplit *jac = (PC_FieldSplit*)pc->data; 1593b224e63SBarry Smith PetscErrorCode ierr; 1604996c5bdSBarry Smith PetscBool iascii,isdraw; 1613b224e63SBarry Smith PetscInt i,j; 1623b224e63SBarry Smith PC_FieldSplitLink ilink = jac->head; 163a9908d51SBarry Smith MatSchurComplementAinvType atype; 1643b224e63SBarry Smith 1653b224e63SBarry Smith PetscFunctionBegin; 166251f4c67SDmitry Karpeev ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&iascii);CHKERRQ(ierr); 1674996c5bdSBarry Smith ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERDRAW,&isdraw);CHKERRQ(ierr); 1683b224e63SBarry Smith if (iascii) { 1692c9966d7SBarry Smith if (jac->bs > 0) { 170c9c6ffaaSJed Brown ierr = PetscViewerASCIIPrintf(viewer," FieldSplit with Schur preconditioner, blocksize = %D, factorization %s\n",jac->bs,PCFieldSplitSchurFactTypes[jac->schurfactorization]);CHKERRQ(ierr); 1712c9966d7SBarry Smith } else { 1722c9966d7SBarry Smith ierr = PetscViewerASCIIPrintf(viewer," FieldSplit with Schur preconditioner, factorization %s\n",PCFieldSplitSchurFactTypes[jac->schurfactorization]);CHKERRQ(ierr); 1732c9966d7SBarry Smith } 174f5236f50SJed Brown if (pc->useAmat) { 175f5236f50SJed Brown ierr = PetscViewerASCIIPrintf(viewer," using Amat (not Pmat) as operator for blocks\n");CHKERRQ(ierr); 176a3df900dSMatthew G Knepley } 1773e8b8b31SMatthew G Knepley switch (jac->schurpre) { 1783e8b8b31SMatthew G Knepley case PC_FIELDSPLIT_SCHUR_PRE_SELF: 179a9908d51SBarry Smith ierr = PetscViewerASCIIPrintf(viewer," Preconditioner for the Schur complement formed from S itself\n");CHKERRQ(ierr); 180a9908d51SBarry Smith break; 181a7476a74SDmitry Karpeev case PC_FIELDSPLIT_SCHUR_PRE_SELFP: 182a9908d51SBarry Smith ierr = MatSchurComplementGetAinvType(jac->schur,&atype);CHKERRQ(ierr); 183d0a9c1a2SBarry 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; 184e87fab1bSBarry Smith case PC_FIELDSPLIT_SCHUR_PRE_A11: 185a9908d51SBarry Smith ierr = PetscViewerASCIIPrintf(viewer," Preconditioner for the Schur complement formed from A11\n");CHKERRQ(ierr); 186a9908d51SBarry Smith break; 187e74569cdSMatthew G. Knepley case PC_FIELDSPLIT_SCHUR_PRE_FULL: 188a9908d51SBarry Smith ierr = PetscViewerASCIIPrintf(viewer," Preconditioner for the Schur complement formed from the exact Schur complement\n");CHKERRQ(ierr); 189a9908d51SBarry Smith break; 1903e8b8b31SMatthew G Knepley case PC_FIELDSPLIT_SCHUR_PRE_USER: 1913e8b8b31SMatthew G Knepley if (jac->schur_user) { 1923e8b8b31SMatthew G Knepley ierr = PetscViewerASCIIPrintf(viewer," Preconditioner for the Schur complement formed from user provided matrix\n");CHKERRQ(ierr); 1933e8b8b31SMatthew G Knepley } else { 194e87fab1bSBarry Smith ierr = PetscViewerASCIIPrintf(viewer," Preconditioner for the Schur complement formed from A11\n");CHKERRQ(ierr); 1953e8b8b31SMatthew G Knepley } 1963e8b8b31SMatthew G Knepley break; 1973e8b8b31SMatthew G Knepley default: 19882f516ccSBarry Smith SETERRQ1(PetscObjectComm((PetscObject)pc), PETSC_ERR_ARG_OUTOFRANGE, "Invalid Schur preconditioning type: %d", jac->schurpre); 1993e8b8b31SMatthew G Knepley } 2003b224e63SBarry Smith ierr = PetscViewerASCIIPrintf(viewer," Split info:\n");CHKERRQ(ierr); 2013b224e63SBarry Smith ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr); 2023b224e63SBarry Smith for (i=0; i<jac->nsplits; i++) { 2033b224e63SBarry Smith if (ilink->fields) { 2043b224e63SBarry Smith ierr = PetscViewerASCIIPrintf(viewer,"Split number %D Fields ",i);CHKERRQ(ierr); 2053b224e63SBarry Smith ierr = PetscViewerASCIIUseTabs(viewer,PETSC_FALSE);CHKERRQ(ierr); 2063b224e63SBarry Smith for (j=0; j<ilink->nfields; j++) { 2073b224e63SBarry Smith if (j > 0) { 2083b224e63SBarry Smith ierr = PetscViewerASCIIPrintf(viewer,",");CHKERRQ(ierr); 2093b224e63SBarry Smith } 2103b224e63SBarry Smith ierr = PetscViewerASCIIPrintf(viewer," %D",ilink->fields[j]);CHKERRQ(ierr); 2113b224e63SBarry Smith } 2123b224e63SBarry Smith ierr = PetscViewerASCIIPrintf(viewer,"\n");CHKERRQ(ierr); 2133b224e63SBarry Smith ierr = PetscViewerASCIIUseTabs(viewer,PETSC_TRUE);CHKERRQ(ierr); 2143b224e63SBarry Smith } else { 2153b224e63SBarry Smith ierr = PetscViewerASCIIPrintf(viewer,"Split number %D Defined by IS\n",i);CHKERRQ(ierr); 2163b224e63SBarry Smith } 2173b224e63SBarry Smith ilink = ilink->next; 2183b224e63SBarry Smith } 219435f959eSBarry Smith ierr = PetscViewerASCIIPrintf(viewer,"KSP solver for A00 block\n");CHKERRQ(ierr); 2203b224e63SBarry Smith ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr); 22106de4afeSJed Brown if (jac->head) { 222443836d0SMatthew G Knepley ierr = KSPView(jac->head->ksp,viewer);CHKERRQ(ierr); 22306de4afeSJed Brown } else {ierr = PetscViewerASCIIPrintf(viewer," not yet available\n");CHKERRQ(ierr);} 2243b224e63SBarry Smith ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr); 22506de4afeSJed Brown if (jac->head && jac->kspupper != jac->head->ksp) { 226443836d0SMatthew G Knepley ierr = PetscViewerASCIIPrintf(viewer,"KSP solver for upper A00 in upper triangular factor \n");CHKERRQ(ierr); 227443836d0SMatthew G Knepley ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr); 228b2750c55SJed Brown if (jac->kspupper) {ierr = KSPView(jac->kspupper,viewer);CHKERRQ(ierr);} 229b2750c55SJed Brown else {ierr = PetscViewerASCIIPrintf(viewer," not yet available\n");CHKERRQ(ierr);} 230443836d0SMatthew G Knepley ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr); 231443836d0SMatthew G Knepley } 232435f959eSBarry Smith ierr = PetscViewerASCIIPrintf(viewer,"KSP solver for S = A11 - A10 inv(A00) A01 \n");CHKERRQ(ierr); 2333b224e63SBarry Smith ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr); 23412cae6f2SJed Brown if (jac->kspschur) { 2353b224e63SBarry Smith ierr = KSPView(jac->kspschur,viewer);CHKERRQ(ierr); 23612cae6f2SJed Brown } else { 23712cae6f2SJed Brown ierr = PetscViewerASCIIPrintf(viewer," not yet available\n");CHKERRQ(ierr); 23812cae6f2SJed Brown } 2393b224e63SBarry Smith ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr); 2403b224e63SBarry Smith ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr); 24106de4afeSJed Brown } else if (isdraw && jac->head) { 2424996c5bdSBarry Smith PetscDraw draw; 2434996c5bdSBarry Smith PetscReal x,y,w,wd,h; 2444996c5bdSBarry Smith PetscInt cnt = 2; 2454996c5bdSBarry Smith char str[32]; 2464996c5bdSBarry Smith 2474996c5bdSBarry Smith ierr = PetscViewerDrawGetDraw(viewer,0,&draw);CHKERRQ(ierr); 2484996c5bdSBarry Smith ierr = PetscDrawGetCurrentPoint(draw,&x,&y);CHKERRQ(ierr); 249c74581afSBarry Smith if (jac->kspupper != jac->head->ksp) cnt++; 250c74581afSBarry Smith w = 2*PetscMin(1.0 - x,x); 251c74581afSBarry Smith wd = w/(cnt + 1); 252c74581afSBarry Smith 2534996c5bdSBarry Smith ierr = PetscSNPrintf(str,32,"Schur fact. %s",PCFieldSplitSchurFactTypes[jac->schurfactorization]);CHKERRQ(ierr); 25451fa3d41SBarry Smith ierr = PetscDrawStringBoxed(draw,x,y,PETSC_DRAW_RED,PETSC_DRAW_BLACK,str,NULL,&h);CHKERRQ(ierr); 2554996c5bdSBarry Smith y -= h; 2564996c5bdSBarry Smith if (jac->schurpre == PC_FIELDSPLIT_SCHUR_PRE_USER && !jac->schur_user) { 257e87fab1bSBarry Smith ierr = PetscSNPrintf(str,32,"Prec. for Schur from %s",PCFieldSplitSchurPreTypes[PC_FIELDSPLIT_SCHUR_PRE_A11]);CHKERRQ(ierr); 2583b224e63SBarry Smith } else { 2594996c5bdSBarry Smith ierr = PetscSNPrintf(str,32,"Prec. for Schur from %s",PCFieldSplitSchurPreTypes[jac->schurpre]);CHKERRQ(ierr); 2604996c5bdSBarry Smith } 26151fa3d41SBarry Smith ierr = PetscDrawStringBoxed(draw,x+wd*(cnt-1)/2.0,y,PETSC_DRAW_RED,PETSC_DRAW_BLACK,str,NULL,&h);CHKERRQ(ierr); 2624996c5bdSBarry Smith y -= h; 2634996c5bdSBarry Smith x = x - wd*(cnt-1)/2.0; 2644996c5bdSBarry Smith 2654996c5bdSBarry Smith ierr = PetscDrawPushCurrentPoint(draw,x,y);CHKERRQ(ierr); 2664996c5bdSBarry Smith ierr = KSPView(jac->head->ksp,viewer);CHKERRQ(ierr); 2674996c5bdSBarry Smith ierr = PetscDrawPopCurrentPoint(draw);CHKERRQ(ierr); 2684996c5bdSBarry Smith if (jac->kspupper != jac->head->ksp) { 2694996c5bdSBarry Smith x += wd; 2704996c5bdSBarry Smith ierr = PetscDrawPushCurrentPoint(draw,x,y);CHKERRQ(ierr); 2714996c5bdSBarry Smith ierr = KSPView(jac->kspupper,viewer);CHKERRQ(ierr); 2724996c5bdSBarry Smith ierr = PetscDrawPopCurrentPoint(draw);CHKERRQ(ierr); 2734996c5bdSBarry Smith } 2744996c5bdSBarry Smith x += wd; 2754996c5bdSBarry Smith ierr = PetscDrawPushCurrentPoint(draw,x,y);CHKERRQ(ierr); 2764996c5bdSBarry Smith ierr = KSPView(jac->kspschur,viewer);CHKERRQ(ierr); 2774996c5bdSBarry Smith ierr = PetscDrawPopCurrentPoint(draw);CHKERRQ(ierr); 2783b224e63SBarry Smith } 2793b224e63SBarry Smith PetscFunctionReturn(0); 2803b224e63SBarry Smith } 2813b224e63SBarry Smith 282a51937d4SCarola Kruse static PetscErrorCode PCView_FieldSplit_GKB(PC pc,PetscViewer viewer) 283a51937d4SCarola Kruse { 284a51937d4SCarola Kruse PC_FieldSplit *jac = (PC_FieldSplit*)pc->data; 285a51937d4SCarola Kruse PetscErrorCode ierr; 286a51937d4SCarola Kruse PetscBool iascii,isdraw; 287a51937d4SCarola Kruse PetscInt i,j; 288a51937d4SCarola Kruse PC_FieldSplitLink ilink = jac->head; 289a51937d4SCarola Kruse 290a51937d4SCarola Kruse PetscFunctionBegin; 291a51937d4SCarola Kruse ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&iascii);CHKERRQ(ierr); 292a51937d4SCarola Kruse ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERDRAW,&isdraw);CHKERRQ(ierr); 293a51937d4SCarola Kruse if (iascii) { 294a51937d4SCarola Kruse if (jac->bs > 0) { 295a51937d4SCarola Kruse ierr = PetscViewerASCIIPrintf(viewer," FieldSplit with %s composition: total splits = %D, blocksize = %D\n",PCCompositeTypes[jac->type],jac->nsplits,jac->bs);CHKERRQ(ierr); 296a51937d4SCarola Kruse } else { 297a51937d4SCarola Kruse ierr = PetscViewerASCIIPrintf(viewer," FieldSplit with %s composition: total splits = %D\n",PCCompositeTypes[jac->type],jac->nsplits);CHKERRQ(ierr); 298a51937d4SCarola Kruse } 299a51937d4SCarola Kruse if (pc->useAmat) { 300a51937d4SCarola Kruse ierr = PetscViewerASCIIPrintf(viewer," using Amat (not Pmat) as operator for blocks\n");CHKERRQ(ierr); 301a51937d4SCarola Kruse } 302a51937d4SCarola Kruse if (jac->diag_use_amat) { 303a51937d4SCarola Kruse ierr = PetscViewerASCIIPrintf(viewer," using Amat (not Pmat) as operator for diagonal blocks\n");CHKERRQ(ierr); 304a51937d4SCarola Kruse } 305a51937d4SCarola Kruse if (jac->offdiag_use_amat) { 306a51937d4SCarola Kruse ierr = PetscViewerASCIIPrintf(viewer," using Amat (not Pmat) as operator for off-diagonal blocks\n");CHKERRQ(ierr); 307a51937d4SCarola Kruse } 308a51937d4SCarola Kruse 309a51937d4SCarola Kruse ierr = PetscViewerASCIIPrintf(viewer," Stopping tolerance=%.1e, delay in error estimate=%D, maximum iterations=%D\n",jac->gkbtol,jac->gkbdelay,jac->gkbmaxit);CHKERRQ(ierr); 310a51937d4SCarola Kruse ierr = PetscViewerASCIIPrintf(viewer," Solver info for H = A00 + nu*A01*A01' matrix:\n");CHKERRQ(ierr); 311a51937d4SCarola Kruse ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr); 312a51937d4SCarola Kruse 313a51937d4SCarola Kruse if (ilink->fields) { 314a51937d4SCarola Kruse ierr = PetscViewerASCIIPrintf(viewer,"Split number %D Fields ",0);CHKERRQ(ierr); 315a51937d4SCarola Kruse ierr = PetscViewerASCIIUseTabs(viewer,PETSC_FALSE);CHKERRQ(ierr); 316a51937d4SCarola Kruse for (j=0; j<ilink->nfields; j++) { 317a51937d4SCarola Kruse if (j > 0) { 318a51937d4SCarola Kruse ierr = PetscViewerASCIIPrintf(viewer,",");CHKERRQ(ierr); 319a51937d4SCarola Kruse } 320a51937d4SCarola Kruse ierr = PetscViewerASCIIPrintf(viewer," %D",ilink->fields[j]);CHKERRQ(ierr); 321a51937d4SCarola Kruse } 322a51937d4SCarola Kruse ierr = PetscViewerASCIIPrintf(viewer,"\n");CHKERRQ(ierr); 323a51937d4SCarola Kruse ierr = PetscViewerASCIIUseTabs(viewer,PETSC_TRUE);CHKERRQ(ierr); 324a51937d4SCarola Kruse } else { 325a51937d4SCarola Kruse ierr = PetscViewerASCIIPrintf(viewer,"Split number %D Defined by IS\n",0);CHKERRQ(ierr); 326a51937d4SCarola Kruse } 327a51937d4SCarola Kruse ierr = KSPView(ilink->ksp,viewer);CHKERRQ(ierr); 328a51937d4SCarola Kruse 329a51937d4SCarola Kruse ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr); 330a51937d4SCarola Kruse } 331a51937d4SCarola Kruse 332a51937d4SCarola Kruse if (isdraw) { 333a51937d4SCarola Kruse PetscDraw draw; 334a51937d4SCarola Kruse PetscReal x,y,w,wd; 335a51937d4SCarola Kruse 336a51937d4SCarola Kruse ierr = PetscViewerDrawGetDraw(viewer,0,&draw);CHKERRQ(ierr); 337a51937d4SCarola Kruse ierr = PetscDrawGetCurrentPoint(draw,&x,&y);CHKERRQ(ierr); 338a51937d4SCarola Kruse w = 2*PetscMin(1.0 - x,x); 339a51937d4SCarola Kruse wd = w/(jac->nsplits + 1); 340a51937d4SCarola Kruse x = x - wd*(jac->nsplits-1)/2.0; 341a51937d4SCarola Kruse for (i=0; i<jac->nsplits; i++) { 342a51937d4SCarola Kruse ierr = PetscDrawPushCurrentPoint(draw,x,y);CHKERRQ(ierr); 343a51937d4SCarola Kruse ierr = KSPView(ilink->ksp,viewer);CHKERRQ(ierr); 344a51937d4SCarola Kruse ierr = PetscDrawPopCurrentPoint(draw);CHKERRQ(ierr); 345a51937d4SCarola Kruse x += wd; 346a51937d4SCarola Kruse ilink = ilink->next; 347a51937d4SCarola Kruse } 348a51937d4SCarola Kruse } 349a51937d4SCarola Kruse PetscFunctionReturn(0); 350a51937d4SCarola Kruse } 351a51937d4SCarola Kruse 352a51937d4SCarola Kruse 3536c924f48SJed Brown /* Precondition: jac->bs is set to a meaningful value */ 3546c924f48SJed Brown static PetscErrorCode PCFieldSplitSetRuntimeSplits_Private(PC pc) 3556c924f48SJed Brown { 3566c924f48SJed Brown PetscErrorCode ierr; 3576c924f48SJed Brown PC_FieldSplit *jac = (PC_FieldSplit*)pc->data; 3585d4c12cdSJungho Lee PetscInt i,nfields,*ifields,nfields_col,*ifields_col; 3595d4c12cdSJungho Lee PetscBool flg,flg_col; 3605d4c12cdSJungho Lee char optionname[128],splitname[8],optionname_col[128]; 3616c924f48SJed Brown 3626c924f48SJed Brown PetscFunctionBegin; 363785e854fSJed Brown ierr = PetscMalloc1(jac->bs,&ifields);CHKERRQ(ierr); 364785e854fSJed Brown ierr = PetscMalloc1(jac->bs,&ifields_col);CHKERRQ(ierr); 3656c924f48SJed Brown for (i=0,flg=PETSC_TRUE;; i++) { 3668caf3d72SBarry Smith ierr = PetscSNPrintf(splitname,sizeof(splitname),"%D",i);CHKERRQ(ierr); 3678caf3d72SBarry Smith ierr = PetscSNPrintf(optionname,sizeof(optionname),"-pc_fieldsplit_%D_fields",i);CHKERRQ(ierr); 3688caf3d72SBarry Smith ierr = PetscSNPrintf(optionname_col,sizeof(optionname_col),"-pc_fieldsplit_%D_fields_col",i);CHKERRQ(ierr); 3696c924f48SJed Brown nfields = jac->bs; 37029499fbbSJungho Lee nfields_col = jac->bs; 371c5929fdfSBarry Smith ierr = PetscOptionsGetIntArray(((PetscObject)pc)->options,((PetscObject)pc)->prefix,optionname,ifields,&nfields,&flg);CHKERRQ(ierr); 372c5929fdfSBarry Smith ierr = PetscOptionsGetIntArray(((PetscObject)pc)->options,((PetscObject)pc)->prefix,optionname_col,ifields_col,&nfields_col,&flg_col);CHKERRQ(ierr); 3736c924f48SJed Brown if (!flg) break; 3745d4c12cdSJungho Lee else if (flg && !flg_col) { 3755d4c12cdSJungho Lee if (!nfields) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_USER,"Cannot list zero fields"); 3765d4c12cdSJungho Lee ierr = PCFieldSplitSetFields(pc,splitname,nfields,ifields,ifields);CHKERRQ(ierr); 3772fa5cd67SKarl Rupp } else { 3785d4c12cdSJungho Lee if (!nfields || !nfields_col) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_USER,"Cannot list zero fields"); 3795d4c12cdSJungho Lee if (nfields != nfields_col) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_USER,"Number of row and column fields must match"); 3805d4c12cdSJungho Lee ierr = PCFieldSplitSetFields(pc,splitname,nfields,ifields,ifields_col);CHKERRQ(ierr); 3815d4c12cdSJungho Lee } 3826c924f48SJed Brown } 3836c924f48SJed Brown if (i > 0) { 3846c924f48SJed Brown /* Makes command-line setting of splits take precedence over setting them in code. 3856c924f48SJed Brown Otherwise subsequent calls to PCFieldSplitSetIS() or PCFieldSplitSetFields() would 3866c924f48SJed Brown create new splits, which would probably not be what the user wanted. */ 3876c924f48SJed Brown jac->splitdefined = PETSC_TRUE; 3886c924f48SJed Brown } 3896c924f48SJed Brown ierr = PetscFree(ifields);CHKERRQ(ierr); 3905d4c12cdSJungho Lee ierr = PetscFree(ifields_col);CHKERRQ(ierr); 3916c924f48SJed Brown PetscFunctionReturn(0); 3926c924f48SJed Brown } 3936c924f48SJed Brown 39469a612a9SBarry Smith static PetscErrorCode PCFieldSplitSetDefaults(PC pc) 3950971522cSBarry Smith { 3960971522cSBarry Smith PC_FieldSplit *jac = (PC_FieldSplit*)pc->data; 3970971522cSBarry Smith PetscErrorCode ierr; 3985a9f2f41SSatish Balay PC_FieldSplitLink ilink = jac->head; 3997b752e3dSPatrick Sanan PetscBool fieldsplit_default = PETSC_FALSE,coupling = PETSC_FALSE; 4006c924f48SJed Brown PetscInt i; 4010971522cSBarry Smith 4020971522cSBarry Smith PetscFunctionBegin; 4037287d2a3SDmitry Karpeev /* 404f5f0d762SBarry Smith Kinda messy, but at least this now uses DMCreateFieldDecomposition(). 4057287d2a3SDmitry Karpeev Should probably be rewritten. 4067287d2a3SDmitry Karpeev */ 407f5f0d762SBarry Smith if (!ilink) { 408c5929fdfSBarry Smith ierr = PetscOptionsGetBool(((PetscObject)pc)->options,((PetscObject)pc)->prefix,"-pc_fieldsplit_detect_coupling",&coupling,NULL);CHKERRQ(ierr); 4097b752e3dSPatrick Sanan if (pc->dm && jac->dm_splits && !jac->detect && !coupling) { 410bafc1b83SMatthew G Knepley PetscInt numFields, f, i, j; 4110784a22cSJed Brown char **fieldNames; 4127b62db95SJungho Lee IS *fields; 413e7c4fc90SDmitry Karpeev DM *dms; 414bafc1b83SMatthew G Knepley DM subdm[128]; 415bafc1b83SMatthew G Knepley PetscBool flg; 416bafc1b83SMatthew G Knepley 41716621825SDmitry Karpeev ierr = DMCreateFieldDecomposition(pc->dm, &numFields, &fieldNames, &fields, &dms);CHKERRQ(ierr); 418bafc1b83SMatthew G Knepley /* Allow the user to prescribe the splits */ 419bafc1b83SMatthew G Knepley for (i = 0, flg = PETSC_TRUE;; i++) { 420bafc1b83SMatthew G Knepley PetscInt ifields[128]; 421bafc1b83SMatthew G Knepley IS compField; 422bafc1b83SMatthew G Knepley char optionname[128], splitname[8]; 423bafc1b83SMatthew G Knepley PetscInt nfields = numFields; 424bafc1b83SMatthew G Knepley 4258caf3d72SBarry Smith ierr = PetscSNPrintf(optionname, sizeof(optionname), "-pc_fieldsplit_%D_fields", i);CHKERRQ(ierr); 426c5929fdfSBarry Smith ierr = PetscOptionsGetIntArray(((PetscObject)pc)->options,((PetscObject)pc)->prefix, optionname, ifields, &nfields, &flg);CHKERRQ(ierr); 427bafc1b83SMatthew G Knepley if (!flg) break; 42882f516ccSBarry Smith if (numFields > 128) SETERRQ1(PetscObjectComm((PetscObject)pc),PETSC_ERR_SUP,"Cannot currently support %d > 128 fields", numFields); 429bafc1b83SMatthew G Knepley ierr = DMCreateSubDM(pc->dm, nfields, ifields, &compField, &subdm[i]);CHKERRQ(ierr); 430bafc1b83SMatthew G Knepley if (nfields == 1) { 431bafc1b83SMatthew G Knepley ierr = PCFieldSplitSetIS(pc, fieldNames[ifields[0]], compField);CHKERRQ(ierr); 432bafc1b83SMatthew G Knepley } else { 4338caf3d72SBarry Smith ierr = PetscSNPrintf(splitname, sizeof(splitname), "%D", i);CHKERRQ(ierr); 434bafc1b83SMatthew G Knepley ierr = PCFieldSplitSetIS(pc, splitname, compField);CHKERRQ(ierr); 4357287d2a3SDmitry Karpeev } 436bafc1b83SMatthew G Knepley ierr = ISDestroy(&compField);CHKERRQ(ierr); 437bafc1b83SMatthew G Knepley for (j = 0; j < nfields; ++j) { 438bafc1b83SMatthew G Knepley f = ifields[j]; 4397b62db95SJungho Lee ierr = PetscFree(fieldNames[f]);CHKERRQ(ierr); 4407b62db95SJungho Lee ierr = ISDestroy(&fields[f]);CHKERRQ(ierr); 4417b62db95SJungho Lee } 442bafc1b83SMatthew G Knepley } 443bafc1b83SMatthew G Knepley if (i == 0) { 444bafc1b83SMatthew G Knepley for (f = 0; f < numFields; ++f) { 445bafc1b83SMatthew G Knepley ierr = PCFieldSplitSetIS(pc, fieldNames[f], fields[f]);CHKERRQ(ierr); 446bafc1b83SMatthew G Knepley ierr = PetscFree(fieldNames[f]);CHKERRQ(ierr); 447bafc1b83SMatthew G Knepley ierr = ISDestroy(&fields[f]);CHKERRQ(ierr); 448bafc1b83SMatthew G Knepley } 449bafc1b83SMatthew G Knepley } else { 450d724dfffSBarry Smith for (j=0; j<numFields; j++) { 451d724dfffSBarry Smith ierr = DMDestroy(dms+j);CHKERRQ(ierr); 452d724dfffSBarry Smith } 453d724dfffSBarry Smith ierr = PetscFree(dms);CHKERRQ(ierr); 454785e854fSJed Brown ierr = PetscMalloc1(i, &dms);CHKERRQ(ierr); 4552fa5cd67SKarl Rupp for (j = 0; j < i; ++j) dms[j] = subdm[j]; 456bafc1b83SMatthew G Knepley } 4577b62db95SJungho Lee ierr = PetscFree(fieldNames);CHKERRQ(ierr); 4587b62db95SJungho Lee ierr = PetscFree(fields);CHKERRQ(ierr); 459e7c4fc90SDmitry Karpeev if (dms) { 4608b8307b2SJed Brown ierr = PetscInfo(pc, "Setting up physics based fieldsplit preconditioner using the embedded DM\n");CHKERRQ(ierr); 461bafc1b83SMatthew G Knepley for (ilink = jac->head, i = 0; ilink; ilink = ilink->next, ++i) { 4627287d2a3SDmitry Karpeev const char *prefix; 4637287d2a3SDmitry Karpeev ierr = PetscObjectGetOptionsPrefix((PetscObject)(ilink->ksp),&prefix);CHKERRQ(ierr); 4647287d2a3SDmitry Karpeev ierr = PetscObjectSetOptionsPrefix((PetscObject)(dms[i]), prefix);CHKERRQ(ierr); 4657b62db95SJungho Lee ierr = KSPSetDM(ilink->ksp, dms[i]);CHKERRQ(ierr); 4667b62db95SJungho Lee ierr = KSPSetDMActive(ilink->ksp, PETSC_FALSE);CHKERRQ(ierr); 4677287d2a3SDmitry Karpeev ierr = PetscObjectIncrementTabLevel((PetscObject)dms[i],(PetscObject)ilink->ksp,0);CHKERRQ(ierr); 468e7c4fc90SDmitry Karpeev ierr = DMDestroy(&dms[i]);CHKERRQ(ierr); 4692fa5ba8aSJed Brown } 4707b62db95SJungho Lee ierr = PetscFree(dms);CHKERRQ(ierr); 4718b8307b2SJed Brown } 47266ffff09SJed Brown } else { 473521d7252SBarry Smith if (jac->bs <= 0) { 474704ba839SBarry Smith if (pc->pmat) { 475521d7252SBarry Smith ierr = MatGetBlockSize(pc->pmat,&jac->bs);CHKERRQ(ierr); 4762fa5cd67SKarl Rupp } else jac->bs = 1; 477521d7252SBarry Smith } 478d32f9abdSBarry Smith 4797b752e3dSPatrick Sanan if (jac->detect) { 4806ce1633cSBarry Smith IS zerodiags,rest; 4816ce1633cSBarry Smith PetscInt nmin,nmax; 4826ce1633cSBarry Smith 4836ce1633cSBarry Smith ierr = MatGetOwnershipRange(pc->mat,&nmin,&nmax);CHKERRQ(ierr); 4846ce1633cSBarry Smith ierr = MatFindZeroDiagonals(pc->mat,&zerodiags);CHKERRQ(ierr); 4856ce1633cSBarry Smith ierr = ISComplement(zerodiags,nmin,nmax,&rest);CHKERRQ(ierr); 4866ce1633cSBarry Smith ierr = PCFieldSplitSetIS(pc,"0",rest);CHKERRQ(ierr); 4876ce1633cSBarry Smith ierr = PCFieldSplitSetIS(pc,"1",zerodiags);CHKERRQ(ierr); 488fcfd50ebSBarry Smith ierr = ISDestroy(&zerodiags);CHKERRQ(ierr); 489fcfd50ebSBarry Smith ierr = ISDestroy(&rest);CHKERRQ(ierr); 4903a062f41SBarry Smith } else if (coupling) { 4913a062f41SBarry Smith IS coupling,rest; 4923a062f41SBarry Smith PetscInt nmin,nmax; 4933a062f41SBarry Smith 4943a062f41SBarry Smith ierr = MatGetOwnershipRange(pc->mat,&nmin,&nmax);CHKERRQ(ierr); 4953a062f41SBarry Smith ierr = MatFindOffBlockDiagonalEntries(pc->mat,&coupling);CHKERRQ(ierr); 4966bea0878SBarry Smith ierr = ISCreateStride(PetscObjectComm((PetscObject)pc->mat),nmax-nmin,nmin,1,&rest);CHKERRQ(ierr); 497e52d2c62SBarry Smith ierr = ISSetIdentity(rest);CHKERRQ(ierr); 498d020c841SBarry Smith ierr = PCFieldSplitSetIS(pc,"0",rest);CHKERRQ(ierr); 499d020c841SBarry Smith ierr = PCFieldSplitSetIS(pc,"1",coupling);CHKERRQ(ierr); 5003a062f41SBarry Smith ierr = ISDestroy(&coupling);CHKERRQ(ierr); 5013a062f41SBarry Smith ierr = ISDestroy(&rest);CHKERRQ(ierr); 5026ce1633cSBarry Smith } else { 503c5929fdfSBarry Smith ierr = PetscOptionsGetBool(((PetscObject)pc)->options,((PetscObject)pc)->prefix,"-pc_fieldsplit_default",&fieldsplit_default,NULL);CHKERRQ(ierr); 5047287d2a3SDmitry Karpeev if (!fieldsplit_default) { 505d32f9abdSBarry Smith /* Allow user to set fields from command line, if bs was known at the time of PCSetFromOptions_FieldSplit() 506d32f9abdSBarry Smith then it is set there. This is not ideal because we should only have options set in XXSetFromOptions(). */ 5076c924f48SJed Brown ierr = PCFieldSplitSetRuntimeSplits_Private(pc);CHKERRQ(ierr); 5086c924f48SJed Brown if (jac->splitdefined) {ierr = PetscInfo(pc,"Splits defined using the options database\n");CHKERRQ(ierr);} 509d32f9abdSBarry Smith } 5106dbb499eSCian Wilson if ((fieldsplit_default || !jac->splitdefined) && !jac->isrestrict) { 511d32f9abdSBarry Smith ierr = PetscInfo(pc,"Using default splitting of fields\n");CHKERRQ(ierr); 512db4c96c1SJed Brown for (i=0; i<jac->bs; i++) { 5136c924f48SJed Brown char splitname[8]; 5148caf3d72SBarry Smith ierr = PetscSNPrintf(splitname,sizeof(splitname),"%D",i);CHKERRQ(ierr); 5155d4c12cdSJungho Lee ierr = PCFieldSplitSetFields(pc,splitname,1,&i,&i);CHKERRQ(ierr); 51679416396SBarry Smith } 5175d4c12cdSJungho Lee jac->defaultsplit = PETSC_TRUE; 518521d7252SBarry Smith } 51966ffff09SJed Brown } 5206ce1633cSBarry Smith } 521edf189efSBarry Smith } else if (jac->nsplits == 1) { 522edf189efSBarry Smith if (ilink->is) { 523edf189efSBarry Smith IS is2; 524edf189efSBarry Smith PetscInt nmin,nmax; 525edf189efSBarry Smith 526edf189efSBarry Smith ierr = MatGetOwnershipRange(pc->mat,&nmin,&nmax);CHKERRQ(ierr); 527edf189efSBarry Smith ierr = ISComplement(ilink->is,nmin,nmax,&is2);CHKERRQ(ierr); 528db4c96c1SJed Brown ierr = PCFieldSplitSetIS(pc,"1",is2);CHKERRQ(ierr); 529fcfd50ebSBarry Smith ierr = ISDestroy(&is2);CHKERRQ(ierr); 53082f516ccSBarry Smith } else SETERRQ(PetscObjectComm((PetscObject)pc),PETSC_ERR_SUP,"Must provide at least two sets of fields to PCFieldSplit()"); 531edf189efSBarry Smith } 532d0af7cd3SBarry Smith 53382f516ccSBarry Smith if (jac->nsplits < 2) SETERRQ1(PetscObjectComm((PetscObject)pc),PETSC_ERR_PLIB,"Unhandled case, must have at least two fields, not %d", jac->nsplits); 53469a612a9SBarry Smith PetscFunctionReturn(0); 53569a612a9SBarry Smith } 53669a612a9SBarry Smith 537a51937d4SCarola Kruse static PetscErrorCode MatGolubKahanComputeExplicitOperator(Mat A,Mat B,Mat C,Mat *H,PetscReal gkbnu) 538a51937d4SCarola Kruse { 539a51937d4SCarola Kruse PetscErrorCode ierr; 540a51937d4SCarola Kruse Mat BT,T; 541a51937d4SCarola Kruse PetscReal nrm; 542a51937d4SCarola Kruse 543a51937d4SCarola Kruse PetscFunctionBegin; 544a51937d4SCarola Kruse ierr = MatHermitianTranspose(C,MAT_INITIAL_MATRIX,&T);CHKERRQ(ierr); /* Test if augmented matrix is symmetric */ 545a51937d4SCarola Kruse ierr = MatAXPY(T,-1.0,B,DIFFERENT_NONZERO_PATTERN);CHKERRQ(ierr); 546a51937d4SCarola Kruse ierr = MatNorm(T,NORM_1,&nrm);CHKERRQ(ierr); 547a51937d4SCarola Kruse if (nrm >= 1e-12) { 548a51937d4SCarola Kruse ierr = PetscPrintf(PETSC_COMM_WORLD,"Warning: Matrix is not symmetric/hermitian, GKB is not applicable. For an approximation continue with A21 := A12'. \n"); 549a51937d4SCarola Kruse } 550a51937d4SCarola Kruse /* Compute augmented Lagrangian matrix H = A00 + nu*A01*A01'. This corresponds to */ 551a51937d4SCarola Kruse /* setting N := 1/nu*I in [Ar13]. */ 552a51937d4SCarola Kruse ierr = MatHermitianTranspose(B,MAT_INITIAL_MATRIX,&BT);CHKERRQ(ierr); 553a51937d4SCarola Kruse ierr = MatMatMult(B,BT,MAT_INITIAL_MATRIX,PETSC_DEFAULT,H);CHKERRQ(ierr); /* H = A01*A01' */ 554a51937d4SCarola Kruse ierr = MatAYPX(*H,gkbnu,A,DIFFERENT_NONZERO_PATTERN);CHKERRQ(ierr); /* H = A00 + nu*A01*A01' */ 555a51937d4SCarola Kruse 556a51937d4SCarola Kruse ierr = MatDestroy(&BT);CHKERRQ(ierr); 557a51937d4SCarola Kruse ierr = MatDestroy(&T);CHKERRQ(ierr); 558a51937d4SCarola Kruse PetscFunctionReturn(0); 559a51937d4SCarola Kruse } 560a51937d4SCarola Kruse 5612d747510SLisandro Dalcin PETSC_EXTERN PetscErrorCode PetscOptionsFindPairPrefix_Private(PetscOptions,const char pre[], const char name[],const char *value[],PetscBool *flg); 562514bf10dSMatthew G Knepley 56369a612a9SBarry Smith static PetscErrorCode PCSetUp_FieldSplit(PC pc) 56469a612a9SBarry Smith { 56569a612a9SBarry Smith PC_FieldSplit *jac = (PC_FieldSplit*)pc->data; 56669a612a9SBarry Smith PetscErrorCode ierr; 5675a9f2f41SSatish Balay PC_FieldSplitLink ilink; 5682c9966d7SBarry Smith PetscInt i,nsplit; 5695f4ab4e1SJungho Lee PetscBool sorted, sorted_col; 57069a612a9SBarry Smith 57169a612a9SBarry Smith PetscFunctionBegin; 57269a612a9SBarry Smith ierr = PCFieldSplitSetDefaults(pc);CHKERRQ(ierr); 57397bbdb24SBarry Smith nsplit = jac->nsplits; 5745a9f2f41SSatish Balay ilink = jac->head; 57597bbdb24SBarry Smith 57697bbdb24SBarry Smith /* get the matrices for each split */ 577704ba839SBarry Smith if (!jac->issetup) { 5781b9fc7fcSBarry Smith PetscInt rstart,rend,nslots,bs; 57997bbdb24SBarry Smith 580704ba839SBarry Smith jac->issetup = PETSC_TRUE; 581704ba839SBarry Smith 5825d4c12cdSJungho Lee /* This is done here instead of in PCFieldSplitSetFields() because may not have matrix at that point */ 5832c9966d7SBarry Smith if (jac->defaultsplit || !ilink->is) { 5842c9966d7SBarry Smith if (jac->bs <= 0) jac->bs = nsplit; 5852c9966d7SBarry Smith } 58651f519a2SBarry Smith bs = jac->bs; 58797bbdb24SBarry Smith ierr = MatGetOwnershipRange(pc->pmat,&rstart,&rend);CHKERRQ(ierr); 5881b9fc7fcSBarry Smith nslots = (rend - rstart)/bs; 5891b9fc7fcSBarry Smith for (i=0; i<nsplit; i++) { 5901b9fc7fcSBarry Smith if (jac->defaultsplit) { 591ce94432eSBarry Smith ierr = ISCreateStride(PetscObjectComm((PetscObject)pc),nslots,rstart+i,nsplit,&ilink->is);CHKERRQ(ierr); 5925f4ab4e1SJungho Lee ierr = ISDuplicate(ilink->is,&ilink->is_col);CHKERRQ(ierr); 593704ba839SBarry Smith } else if (!ilink->is) { 594ccb205f8SBarry Smith if (ilink->nfields > 1) { 5955f4ab4e1SJungho Lee PetscInt *ii,*jj,j,k,nfields = ilink->nfields,*fields = ilink->fields,*fields_col = ilink->fields_col; 596785e854fSJed Brown ierr = PetscMalloc1(ilink->nfields*nslots,&ii);CHKERRQ(ierr); 597785e854fSJed Brown ierr = PetscMalloc1(ilink->nfields*nslots,&jj);CHKERRQ(ierr); 5981b9fc7fcSBarry Smith for (j=0; j<nslots; j++) { 5991b9fc7fcSBarry Smith for (k=0; k<nfields; k++) { 6001b9fc7fcSBarry Smith ii[nfields*j + k] = rstart + bs*j + fields[k]; 6015f4ab4e1SJungho Lee jj[nfields*j + k] = rstart + bs*j + fields_col[k]; 60297bbdb24SBarry Smith } 60397bbdb24SBarry Smith } 604ce94432eSBarry Smith ierr = ISCreateGeneral(PetscObjectComm((PetscObject)pc),nslots*nfields,ii,PETSC_OWN_POINTER,&ilink->is);CHKERRQ(ierr); 605ce94432eSBarry Smith ierr = ISCreateGeneral(PetscObjectComm((PetscObject)pc),nslots*nfields,jj,PETSC_OWN_POINTER,&ilink->is_col);CHKERRQ(ierr); 60690e68f20SPatrick Farrell ierr = ISSetBlockSize(ilink->is, nfields);CHKERRQ(ierr); 60790e68f20SPatrick Farrell ierr = ISSetBlockSize(ilink->is_col, nfields);CHKERRQ(ierr); 608ccb205f8SBarry Smith } else { 609ce94432eSBarry Smith ierr = ISCreateStride(PetscObjectComm((PetscObject)pc),nslots,rstart+ilink->fields[0],bs,&ilink->is);CHKERRQ(ierr); 610ce94432eSBarry Smith ierr = ISCreateStride(PetscObjectComm((PetscObject)pc),nslots,rstart+ilink->fields_col[0],bs,&ilink->is_col);CHKERRQ(ierr); 611ccb205f8SBarry Smith } 6123e197d65SBarry Smith } 613704ba839SBarry Smith ierr = ISSorted(ilink->is,&sorted);CHKERRQ(ierr); 6145f4ab4e1SJungho Lee if (ilink->is_col) { ierr = ISSorted(ilink->is_col,&sorted_col);CHKERRQ(ierr); } 6155f4ab4e1SJungho Lee if (!sorted || !sorted_col) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_USER,"Fields must be sorted when creating split"); 616704ba839SBarry Smith ilink = ilink->next; 6171b9fc7fcSBarry Smith } 6181b9fc7fcSBarry Smith } 6191b9fc7fcSBarry Smith 620704ba839SBarry Smith ilink = jac->head; 62197bbdb24SBarry Smith if (!jac->pmat) { 622bdddcaaaSMatthew G Knepley Vec xtmp; 623bdddcaaaSMatthew G Knepley 6242a7a6963SBarry Smith ierr = MatCreateVecs(pc->pmat,&xtmp,NULL);CHKERRQ(ierr); 625785e854fSJed Brown ierr = PetscMalloc1(nsplit,&jac->pmat);CHKERRQ(ierr); 626dcca6d9dSJed Brown ierr = PetscMalloc2(nsplit,&jac->x,nsplit,&jac->y);CHKERRQ(ierr); 627cf502942SBarry Smith for (i=0; i<nsplit; i++) { 628bdddcaaaSMatthew G Knepley MatNullSpace sp; 629bdddcaaaSMatthew G Knepley 630a3df900dSMatthew G Knepley /* Check for preconditioning matrix attached to IS */ 631a3df900dSMatthew G Knepley ierr = PetscObjectQuery((PetscObject) ilink->is, "pmat", (PetscObject*) &jac->pmat[i]);CHKERRQ(ierr); 632a3df900dSMatthew G Knepley if (jac->pmat[i]) { 633a3df900dSMatthew G Knepley ierr = PetscObjectReference((PetscObject) jac->pmat[i]);CHKERRQ(ierr); 634a3df900dSMatthew G Knepley if (jac->type == PC_COMPOSITE_SCHUR) { 635a3df900dSMatthew G Knepley jac->schur_user = jac->pmat[i]; 6362fa5cd67SKarl Rupp 637a3df900dSMatthew G Knepley ierr = PetscObjectReference((PetscObject) jac->schur_user);CHKERRQ(ierr); 638a3df900dSMatthew G Knepley } 639a3df900dSMatthew G Knepley } else { 6403a062f41SBarry Smith const char *prefix; 6417dae84e0SHong Zhang ierr = MatCreateSubMatrix(pc->pmat,ilink->is,ilink->is_col,MAT_INITIAL_MATRIX,&jac->pmat[i]);CHKERRQ(ierr); 6423a062f41SBarry Smith ierr = KSPGetOptionsPrefix(ilink->ksp,&prefix);CHKERRQ(ierr); 6433a062f41SBarry Smith ierr = MatSetOptionsPrefix(jac->pmat[i],prefix);CHKERRQ(ierr); 6443a062f41SBarry Smith ierr = MatViewFromOptions(jac->pmat[i],NULL,"-mat_view");CHKERRQ(ierr); 645a3df900dSMatthew G Knepley } 646bdddcaaaSMatthew G Knepley /* create work vectors for each split */ 6472a7a6963SBarry Smith ierr = MatCreateVecs(jac->pmat[i],&jac->x[i],&jac->y[i]);CHKERRQ(ierr); 6480298fd71SBarry Smith ilink->x = jac->x[i]; ilink->y = jac->y[i]; ilink->z = NULL; 649bdddcaaaSMatthew G Knepley /* compute scatter contexts needed by multiplicative versions and non-default splits */ 65035928de7SBarry Smith ierr = VecScatterCreateWithData(xtmp,ilink->is,jac->x[i],NULL,&ilink->sctx);CHKERRQ(ierr); 651ed1f0337SMatthew G Knepley ierr = PetscObjectQuery((PetscObject) ilink->is, "nearnullspace", (PetscObject*) &sp);CHKERRQ(ierr); 652ed1f0337SMatthew G Knepley if (sp) { 653ed1f0337SMatthew G Knepley ierr = MatSetNearNullSpace(jac->pmat[i], sp);CHKERRQ(ierr); 654ed1f0337SMatthew G Knepley } 655704ba839SBarry Smith ilink = ilink->next; 656cf502942SBarry Smith } 657bdddcaaaSMatthew G Knepley ierr = VecDestroy(&xtmp);CHKERRQ(ierr); 65897bbdb24SBarry Smith } else { 659ef7efd37SHong Zhang MatReuse scall; 660ef7efd37SHong Zhang if (pc->flag == DIFFERENT_NONZERO_PATTERN) { 661ef7efd37SHong Zhang for (i=0; i<nsplit; i++) { 662ef7efd37SHong Zhang ierr = MatDestroy(&jac->pmat[i]);CHKERRQ(ierr); 663ef7efd37SHong Zhang } 664ef7efd37SHong Zhang scall = MAT_INITIAL_MATRIX; 665ef7efd37SHong Zhang } else scall = MAT_REUSE_MATRIX; 666ef7efd37SHong Zhang 667cf502942SBarry Smith for (i=0; i<nsplit; i++) { 668a3df900dSMatthew G Knepley Mat pmat; 669a3df900dSMatthew G Knepley 670a3df900dSMatthew G Knepley /* Check for preconditioning matrix attached to IS */ 671a3df900dSMatthew G Knepley ierr = PetscObjectQuery((PetscObject) ilink->is, "pmat", (PetscObject*) &pmat);CHKERRQ(ierr); 672a3df900dSMatthew G Knepley if (!pmat) { 673ef7efd37SHong Zhang ierr = MatCreateSubMatrix(pc->pmat,ilink->is,ilink->is_col,scall,&jac->pmat[i]);CHKERRQ(ierr); 674a3df900dSMatthew G Knepley } 675704ba839SBarry Smith ilink = ilink->next; 676cf502942SBarry Smith } 67797bbdb24SBarry Smith } 6784e39094bSDmitry Karpeev if (jac->diag_use_amat) { 679519d70e2SJed Brown ilink = jac->head; 680519d70e2SJed Brown if (!jac->mat) { 681785e854fSJed Brown ierr = PetscMalloc1(nsplit,&jac->mat);CHKERRQ(ierr); 682519d70e2SJed Brown for (i=0; i<nsplit; i++) { 6837dae84e0SHong Zhang ierr = MatCreateSubMatrix(pc->mat,ilink->is,ilink->is_col,MAT_INITIAL_MATRIX,&jac->mat[i]);CHKERRQ(ierr); 684519d70e2SJed Brown ilink = ilink->next; 685519d70e2SJed Brown } 686519d70e2SJed Brown } else { 687ef7efd37SHong Zhang MatReuse scall; 688ef7efd37SHong Zhang if (pc->flag == DIFFERENT_NONZERO_PATTERN) { 689519d70e2SJed Brown for (i=0; i<nsplit; i++) { 690ef7efd37SHong Zhang ierr = MatDestroy(&jac->mat[i]);CHKERRQ(ierr); 691ef7efd37SHong Zhang } 692ef7efd37SHong Zhang scall = MAT_INITIAL_MATRIX; 693ef7efd37SHong Zhang } else scall = MAT_REUSE_MATRIX; 694ef7efd37SHong Zhang 695ef7efd37SHong Zhang for (i=0; i<nsplit; i++) { 696ef7efd37SHong Zhang if (jac->mat[i]) {ierr = MatCreateSubMatrix(pc->mat,ilink->is,ilink->is_col,scall,&jac->mat[i]);CHKERRQ(ierr);} 697519d70e2SJed Brown ilink = ilink->next; 698519d70e2SJed Brown } 699519d70e2SJed Brown } 700519d70e2SJed Brown } else { 701519d70e2SJed Brown jac->mat = jac->pmat; 702519d70e2SJed Brown } 70397bbdb24SBarry Smith 70453935eafSBarry Smith /* Check for null space attached to IS */ 70553935eafSBarry Smith ilink = jac->head; 70653935eafSBarry Smith for (i=0; i<nsplit; i++) { 70753935eafSBarry Smith MatNullSpace sp; 70853935eafSBarry Smith 70953935eafSBarry Smith ierr = PetscObjectQuery((PetscObject) ilink->is, "nullspace", (PetscObject*) &sp);CHKERRQ(ierr); 71053935eafSBarry Smith if (sp) { 71153935eafSBarry Smith ierr = MatSetNullSpace(jac->mat[i], sp);CHKERRQ(ierr); 71253935eafSBarry Smith } 71353935eafSBarry Smith ilink = ilink->next; 71453935eafSBarry Smith } 71553935eafSBarry Smith 716a51937d4SCarola Kruse if (jac->type != PC_COMPOSITE_ADDITIVE && jac->type != PC_COMPOSITE_SCHUR && jac->type != PC_COMPOSITE_GKB) { 71768dd23aaSBarry Smith /* extract the rows of the matrix associated with each field: used for efficient computation of residual inside algorithm */ 7184e39094bSDmitry Karpeev /* FIXME: Can/should we reuse jac->mat whenever (jac->diag_use_amat) is true? */ 71968dd23aaSBarry Smith ilink = jac->head; 720e52d2c62SBarry Smith if (nsplit == 2 && jac->type == PC_COMPOSITE_MULTIPLICATIVE) { 721e52d2c62SBarry 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 */ 722e52d2c62SBarry Smith if (!jac->Afield) { 723e52d2c62SBarry Smith ierr = PetscCalloc1(nsplit,&jac->Afield);CHKERRQ(ierr); 72480c96bb1SFande Kong if (jac->offdiag_use_amat) { 7257dae84e0SHong Zhang ierr = MatCreateSubMatrix(pc->mat,ilink->next->is,ilink->is,MAT_INITIAL_MATRIX,&jac->Afield[1]);CHKERRQ(ierr); 726e52d2c62SBarry Smith } else { 7277dae84e0SHong Zhang ierr = MatCreateSubMatrix(pc->pmat,ilink->next->is,ilink->is,MAT_INITIAL_MATRIX,&jac->Afield[1]);CHKERRQ(ierr); 72880c96bb1SFande Kong } 72980c96bb1SFande Kong } else { 730ef7efd37SHong Zhang MatReuse scall; 731ef7efd37SHong Zhang if (pc->flag == DIFFERENT_NONZERO_PATTERN) { 732ef7efd37SHong Zhang for (i=0; i<nsplit; i++) { 733ef7efd37SHong Zhang ierr = MatDestroy(&jac->Afield[1]);CHKERRQ(ierr); 734ef7efd37SHong Zhang } 735ef7efd37SHong Zhang scall = MAT_INITIAL_MATRIX; 736ef7efd37SHong Zhang } else scall = MAT_REUSE_MATRIX; 737ef7efd37SHong Zhang 73880c96bb1SFande Kong if (jac->offdiag_use_amat) { 739ef7efd37SHong Zhang ierr = MatCreateSubMatrix(pc->mat,ilink->next->is,ilink->is,scall,&jac->Afield[1]);CHKERRQ(ierr); 74080c96bb1SFande Kong } else { 741ef7efd37SHong Zhang ierr = MatCreateSubMatrix(pc->pmat,ilink->next->is,ilink->is,scall,&jac->Afield[1]);CHKERRQ(ierr); 74280c96bb1SFande Kong } 743e52d2c62SBarry Smith } 744e52d2c62SBarry Smith } else { 74568dd23aaSBarry Smith if (!jac->Afield) { 746785e854fSJed Brown ierr = PetscMalloc1(nsplit,&jac->Afield);CHKERRQ(ierr); 74768dd23aaSBarry Smith for (i=0; i<nsplit; i++) { 74880c96bb1SFande Kong if (jac->offdiag_use_amat) { 7497dae84e0SHong Zhang ierr = MatCreateSubMatrix(pc->mat,ilink->is,NULL,MAT_INITIAL_MATRIX,&jac->Afield[i]);CHKERRQ(ierr); 75080c96bb1SFande Kong } else { 7517dae84e0SHong Zhang ierr = MatCreateSubMatrix(pc->pmat,ilink->is,NULL,MAT_INITIAL_MATRIX,&jac->Afield[i]);CHKERRQ(ierr); 75280c96bb1SFande Kong } 75368dd23aaSBarry Smith ilink = ilink->next; 75468dd23aaSBarry Smith } 75568dd23aaSBarry Smith } else { 756ef7efd37SHong Zhang MatReuse scall; 757ef7efd37SHong Zhang if (pc->flag == DIFFERENT_NONZERO_PATTERN) { 758ef7efd37SHong Zhang for (i=0; i<nsplit; i++) { 759ef7efd37SHong Zhang ierr = MatDestroy(&jac->Afield[i]);CHKERRQ(ierr); 760ef7efd37SHong Zhang } 761ef7efd37SHong Zhang scall = MAT_INITIAL_MATRIX; 762ef7efd37SHong Zhang } else scall = MAT_REUSE_MATRIX; 763ef7efd37SHong Zhang 76468dd23aaSBarry Smith for (i=0; i<nsplit; i++) { 76580c96bb1SFande Kong if (jac->offdiag_use_amat) { 766ef7efd37SHong Zhang ierr = MatCreateSubMatrix(pc->mat,ilink->is,NULL,scall,&jac->Afield[i]);CHKERRQ(ierr); 76780c96bb1SFande Kong } else { 768ef7efd37SHong Zhang ierr = MatCreateSubMatrix(pc->pmat,ilink->is,NULL,scall,&jac->Afield[i]);CHKERRQ(ierr); 76980c96bb1SFande Kong } 77068dd23aaSBarry Smith ilink = ilink->next; 77168dd23aaSBarry Smith } 77268dd23aaSBarry Smith } 77368dd23aaSBarry Smith } 774e52d2c62SBarry Smith } 77568dd23aaSBarry Smith 7763b224e63SBarry Smith if (jac->type == PC_COMPOSITE_SCHUR) { 7773b224e63SBarry Smith IS ccis; 778c096484dSStefano Zampini PetscBool isspd; 7794aa3045dSJed Brown PetscInt rstart,rend; 780093c86ffSJed Brown char lscname[256]; 781093c86ffSJed Brown PetscObject LSC_L; 782ce94432eSBarry Smith 783ce94432eSBarry Smith if (nsplit != 2) SETERRQ(PetscObjectComm((PetscObject)pc),PETSC_ERR_ARG_INCOMP,"To use Schur complement preconditioner you must have exactly 2 fields"); 78468dd23aaSBarry Smith 785c096484dSStefano Zampini /* If pc->mat is SPD, don't scale by -1 the Schur complement */ 786c096484dSStefano Zampini if (jac->schurscale == (PetscScalar)-1.0) { 787c096484dSStefano Zampini ierr = MatGetOption(pc->pmat,MAT_SPD,&isspd);CHKERRQ(ierr); 788c096484dSStefano Zampini jac->schurscale = (isspd == PETSC_TRUE) ? 1.0 : -1.0; 789c096484dSStefano Zampini } 790c096484dSStefano Zampini 791e6cab6aaSJed Brown /* When extracting off-diagonal submatrices, we take complements from this range */ 792e6cab6aaSJed Brown ierr = MatGetOwnershipRangeColumn(pc->mat,&rstart,&rend);CHKERRQ(ierr); 793e6cab6aaSJed Brown 7943b224e63SBarry Smith /* need to handle case when one is resetting up the preconditioner */ 7953b224e63SBarry Smith if (jac->schur) { 7960298fd71SBarry Smith KSP kspA = jac->head->ksp, kspInner = NULL, kspUpper = jac->kspupper; 797443836d0SMatthew G Knepley 798fb3147dbSMatthew G Knepley ierr = MatSchurComplementGetKSP(jac->schur, &kspInner);CHKERRQ(ierr); 7993b224e63SBarry Smith ilink = jac->head; 80049bb4cd7SJungho Lee ierr = ISComplement(ilink->is_col,rstart,rend,&ccis);CHKERRQ(ierr); 8014e39094bSDmitry Karpeev if (jac->offdiag_use_amat) { 8027dae84e0SHong Zhang ierr = MatCreateSubMatrix(pc->mat,ilink->is,ccis,MAT_REUSE_MATRIX,&jac->B);CHKERRQ(ierr); 803c84da90fSDmitry Karpeev } else { 8047dae84e0SHong Zhang ierr = MatCreateSubMatrix(pc->pmat,ilink->is,ccis,MAT_REUSE_MATRIX,&jac->B);CHKERRQ(ierr); 805c84da90fSDmitry Karpeev } 806fcfd50ebSBarry Smith ierr = ISDestroy(&ccis);CHKERRQ(ierr); 8073b224e63SBarry Smith ilink = ilink->next; 80849bb4cd7SJungho Lee ierr = ISComplement(ilink->is_col,rstart,rend,&ccis);CHKERRQ(ierr); 8094e39094bSDmitry Karpeev if (jac->offdiag_use_amat) { 8107dae84e0SHong Zhang ierr = MatCreateSubMatrix(pc->mat,ilink->is,ccis,MAT_REUSE_MATRIX,&jac->C);CHKERRQ(ierr); 811c84da90fSDmitry Karpeev } else { 8127dae84e0SHong Zhang ierr = MatCreateSubMatrix(pc->pmat,ilink->is,ccis,MAT_REUSE_MATRIX,&jac->C);CHKERRQ(ierr); 813c84da90fSDmitry Karpeev } 814fcfd50ebSBarry Smith ierr = ISDestroy(&ccis);CHKERRQ(ierr); 815aa6c7ce3SBarry Smith ierr = MatSchurComplementUpdateSubMatrices(jac->schur,jac->mat[0],jac->pmat[0],jac->B,jac->C,jac->mat[1]);CHKERRQ(ierr); 816a7476a74SDmitry Karpeev if (jac->schurpre == PC_FIELDSPLIT_SCHUR_PRE_SELFP) { 817a7476a74SDmitry Karpeev ierr = MatDestroy(&jac->schurp);CHKERRQ(ierr); 818a7476a74SDmitry Karpeev ierr = MatSchurComplementGetPmat(jac->schur,MAT_INITIAL_MATRIX,&jac->schurp);CHKERRQ(ierr); 819a7476a74SDmitry Karpeev } 820443836d0SMatthew G Knepley if (kspA != kspInner) { 82123ee1639SBarry Smith ierr = KSPSetOperators(kspA,jac->mat[0],jac->pmat[0]);CHKERRQ(ierr); 822443836d0SMatthew G Knepley } 823443836d0SMatthew G Knepley if (kspUpper != kspA) { 82423ee1639SBarry Smith ierr = KSPSetOperators(kspUpper,jac->mat[0],jac->pmat[0]);CHKERRQ(ierr); 825443836d0SMatthew G Knepley } 82623ee1639SBarry Smith ierr = KSPSetOperators(jac->kspschur,jac->schur,FieldSplitSchurPre(jac));CHKERRQ(ierr); 8273b224e63SBarry Smith } else { 828bafc1b83SMatthew G Knepley const char *Dprefix; 829470b340bSDmitry Karpeev char schurprefix[256], schurmatprefix[256]; 830514bf10dSMatthew G Knepley char schurtestoption[256]; 831bdddcaaaSMatthew G Knepley MatNullSpace sp; 832514bf10dSMatthew G Knepley PetscBool flg; 833686bed4dSStefano Zampini KSP kspt; 8343b224e63SBarry Smith 835a04f6461SBarry Smith /* extract the A01 and A10 matrices */ 8363b224e63SBarry Smith ilink = jac->head; 83749bb4cd7SJungho Lee ierr = ISComplement(ilink->is_col,rstart,rend,&ccis);CHKERRQ(ierr); 8384e39094bSDmitry Karpeev if (jac->offdiag_use_amat) { 8397dae84e0SHong Zhang ierr = MatCreateSubMatrix(pc->mat,ilink->is,ccis,MAT_INITIAL_MATRIX,&jac->B);CHKERRQ(ierr); 840c84da90fSDmitry Karpeev } else { 8417dae84e0SHong Zhang ierr = MatCreateSubMatrix(pc->pmat,ilink->is,ccis,MAT_INITIAL_MATRIX,&jac->B);CHKERRQ(ierr); 842c84da90fSDmitry Karpeev } 843fcfd50ebSBarry Smith ierr = ISDestroy(&ccis);CHKERRQ(ierr); 8443b224e63SBarry Smith ilink = ilink->next; 84549bb4cd7SJungho Lee ierr = ISComplement(ilink->is_col,rstart,rend,&ccis);CHKERRQ(ierr); 8464e39094bSDmitry Karpeev if (jac->offdiag_use_amat) { 8477dae84e0SHong Zhang ierr = MatCreateSubMatrix(pc->mat,ilink->is,ccis,MAT_INITIAL_MATRIX,&jac->C);CHKERRQ(ierr); 848c84da90fSDmitry Karpeev } else { 8497dae84e0SHong Zhang ierr = MatCreateSubMatrix(pc->pmat,ilink->is,ccis,MAT_INITIAL_MATRIX,&jac->C);CHKERRQ(ierr); 850c84da90fSDmitry Karpeev } 851fcfd50ebSBarry Smith ierr = ISDestroy(&ccis);CHKERRQ(ierr); 85220252d06SBarry Smith 853f5236f50SJed Brown /* Use mat[0] (diagonal block of Amat) preconditioned by pmat[0] to define Schur complement */ 85420252d06SBarry Smith ierr = MatCreate(((PetscObject)jac->mat[0])->comm,&jac->schur);CHKERRQ(ierr); 85520252d06SBarry Smith ierr = MatSetType(jac->schur,MATSCHURCOMPLEMENT);CHKERRQ(ierr); 856bee83525SDmitry Karpeev ierr = MatSchurComplementSetSubMatrices(jac->schur,jac->mat[0],jac->pmat[0],jac->B,jac->C,jac->mat[1]);CHKERRQ(ierr); 857470b340bSDmitry Karpeev ierr = PetscSNPrintf(schurmatprefix, sizeof(schurmatprefix), "%sfieldsplit_%s_", ((PetscObject)pc)->prefix ? ((PetscObject)pc)->prefix : "", ilink->splitname);CHKERRQ(ierr); 858470b340bSDmitry Karpeev ierr = MatSetOptionsPrefix(jac->schur,schurmatprefix);CHKERRQ(ierr); 859686bed4dSStefano Zampini ierr = MatSchurComplementGetKSP(jac->schur,&kspt);CHKERRQ(ierr); 860686bed4dSStefano Zampini ierr = KSPSetOptionsPrefix(kspt,schurmatprefix);CHKERRQ(ierr); 861686bed4dSStefano Zampini 862686bed4dSStefano Zampini /* Note: this is not true in general */ 863895c21f2SBarry Smith ierr = MatGetNullSpace(jac->mat[1], &sp);CHKERRQ(ierr); 86420252d06SBarry Smith if (sp) { 86520252d06SBarry Smith ierr = MatSetNullSpace(jac->schur, sp);CHKERRQ(ierr); 86620252d06SBarry Smith } 86720252d06SBarry Smith 86820252d06SBarry Smith ierr = PetscSNPrintf(schurtestoption, sizeof(schurtestoption), "-fieldsplit_%s_inner_", ilink->splitname);CHKERRQ(ierr); 869c5929fdfSBarry Smith ierr = PetscOptionsFindPairPrefix_Private(((PetscObject)pc)->options,((PetscObject)pc)->prefix, schurtestoption, NULL, &flg);CHKERRQ(ierr); 870514bf10dSMatthew G Knepley if (flg) { 871514bf10dSMatthew G Knepley DM dmInner; 87221635b76SJed Brown KSP kspInner; 873686bed4dSStefano Zampini PC pcInner; 87421635b76SJed Brown 87521635b76SJed Brown ierr = MatSchurComplementGetKSP(jac->schur, &kspInner);CHKERRQ(ierr); 8762cc093acSMatthew G. Knepley ierr = KSPReset(kspInner);CHKERRQ(ierr); 8772cc093acSMatthew G. Knepley ierr = KSPSetOperators(kspInner,jac->mat[0],jac->pmat[0]);CHKERRQ(ierr); 87821635b76SJed Brown ierr = PetscSNPrintf(schurprefix, sizeof(schurprefix), "%sfieldsplit_%s_inner_", ((PetscObject)pc)->prefix ? ((PetscObject)pc)->prefix : "", ilink->splitname);CHKERRQ(ierr); 87921635b76SJed Brown /* Indent this deeper to emphasize the "inner" nature of this solver. */ 88021635b76SJed Brown ierr = PetscObjectIncrementTabLevel((PetscObject)kspInner, (PetscObject) pc, 2);CHKERRQ(ierr); 8812cc093acSMatthew G. Knepley ierr = PetscObjectIncrementTabLevel((PetscObject)kspInner->pc, (PetscObject) pc, 2);CHKERRQ(ierr); 88221635b76SJed Brown ierr = KSPSetOptionsPrefix(kspInner, schurprefix);CHKERRQ(ierr); 883514bf10dSMatthew G Knepley 884514bf10dSMatthew G Knepley /* Set DM for new solver */ 885bafc1b83SMatthew G Knepley ierr = KSPGetDM(jac->head->ksp, &dmInner);CHKERRQ(ierr); 88621635b76SJed Brown ierr = KSPSetDM(kspInner, dmInner);CHKERRQ(ierr); 88721635b76SJed Brown ierr = KSPSetDMActive(kspInner, PETSC_FALSE);CHKERRQ(ierr); 888686bed4dSStefano Zampini 889686bed4dSStefano Zampini /* Defaults to PCKSP as preconditioner */ 890686bed4dSStefano Zampini ierr = KSPGetPC(kspInner, &pcInner);CHKERRQ(ierr); 891686bed4dSStefano Zampini ierr = PCSetType(pcInner, PCKSP);CHKERRQ(ierr); 892686bed4dSStefano Zampini ierr = PCKSPSetKSP(pcInner, jac->head->ksp);CHKERRQ(ierr); 893514bf10dSMatthew G Knepley } else { 89421635b76SJed Brown /* Use the outer solver for the inner solve, but revert the KSPPREONLY from PCFieldSplitSetFields_FieldSplit or 89521635b76SJed Brown * PCFieldSplitSetIS_FieldSplit. We don't want KSPPREONLY because it makes the Schur complement inexact, 89621635b76SJed Brown * preventing Schur complement reduction to be an accurate solve. Usually when an iterative solver is used for 89721635b76SJed 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 89821635b76SJed Brown * GMRES the default. Note that it is also common to use PREONLY for S, in which case S may not be used 89921635b76SJed Brown * directly, and the user is responsible for setting an inexact method for fieldsplit's A^{-1}. */ 90021635b76SJed Brown ierr = KSPSetType(jac->head->ksp,KSPGMRES);CHKERRQ(ierr); 901514bf10dSMatthew G Knepley ierr = MatSchurComplementSetKSP(jac->schur,jac->head->ksp);CHKERRQ(ierr); 902bafc1b83SMatthew G Knepley } 90323ee1639SBarry Smith ierr = KSPSetOperators(jac->head->ksp,jac->mat[0],jac->pmat[0]);CHKERRQ(ierr); 9045a9f2f41SSatish Balay ierr = KSPSetFromOptions(jac->head->ksp);CHKERRQ(ierr); 90597bbdb24SBarry Smith ierr = MatSetFromOptions(jac->schur);CHKERRQ(ierr); 90697bbdb24SBarry Smith 907686bed4dSStefano Zampini ierr = PetscObjectTypeCompare((PetscObject)jac->schur, MATSCHURCOMPLEMENT, &flg);CHKERRQ(ierr); 908686bed4dSStefano Zampini if (flg) { /* Need to do this otherwise PCSetUp_KSP will overwrite the amat of jac->head->ksp */ 909686bed4dSStefano Zampini KSP kspInner; 910686bed4dSStefano Zampini PC pcInner; 911686bed4dSStefano Zampini 912686bed4dSStefano Zampini ierr = MatSchurComplementGetKSP(jac->schur, &kspInner);CHKERRQ(ierr); 913686bed4dSStefano Zampini ierr = KSPGetPC(kspInner, &pcInner);CHKERRQ(ierr); 914686bed4dSStefano Zampini ierr = PetscObjectTypeCompare((PetscObject)pcInner, PCKSP, &flg);CHKERRQ(ierr); 915686bed4dSStefano Zampini if (flg) { 916686bed4dSStefano Zampini KSP ksp; 917686bed4dSStefano Zampini 918686bed4dSStefano Zampini ierr = PCKSPGetKSP(pcInner, &ksp);CHKERRQ(ierr); 919686bed4dSStefano Zampini if (ksp == jac->head->ksp) { 920686bed4dSStefano Zampini ierr = PCSetUseAmat(pcInner, PETSC_TRUE);CHKERRQ(ierr); 921686bed4dSStefano Zampini } 922686bed4dSStefano Zampini } 923686bed4dSStefano Zampini } 924443836d0SMatthew G Knepley ierr = PetscSNPrintf(schurtestoption, sizeof(schurtestoption), "-fieldsplit_%s_upper_", ilink->splitname);CHKERRQ(ierr); 925c5929fdfSBarry Smith ierr = PetscOptionsFindPairPrefix_Private(((PetscObject)pc)->options,((PetscObject)pc)->prefix, schurtestoption, NULL, &flg);CHKERRQ(ierr); 926443836d0SMatthew G Knepley if (flg) { 927443836d0SMatthew G Knepley DM dmInner; 928443836d0SMatthew G Knepley 929443836d0SMatthew G Knepley ierr = PetscSNPrintf(schurprefix, sizeof(schurprefix), "%sfieldsplit_%s_upper_", ((PetscObject)pc)->prefix ? ((PetscObject)pc)->prefix : "", ilink->splitname);CHKERRQ(ierr); 93082f516ccSBarry Smith ierr = KSPCreate(PetscObjectComm((PetscObject)pc), &jac->kspupper);CHKERRQ(ierr); 931422a814eSBarry Smith ierr = KSPSetErrorIfNotConverged(jac->kspupper,pc->erroriffailure);CHKERRQ(ierr); 932443836d0SMatthew G Knepley ierr = KSPSetOptionsPrefix(jac->kspupper, schurprefix);CHKERRQ(ierr); 9332cc093acSMatthew G. Knepley ierr = PetscObjectIncrementTabLevel((PetscObject)jac->kspupper, (PetscObject) pc, 1);CHKERRQ(ierr); 9342cc093acSMatthew G. Knepley ierr = PetscObjectIncrementTabLevel((PetscObject)jac->kspupper->pc, (PetscObject) pc, 1);CHKERRQ(ierr); 935443836d0SMatthew G Knepley ierr = KSPGetDM(jac->head->ksp, &dmInner);CHKERRQ(ierr); 936443836d0SMatthew G Knepley ierr = KSPSetDM(jac->kspupper, dmInner);CHKERRQ(ierr); 937443836d0SMatthew G Knepley ierr = KSPSetDMActive(jac->kspupper, PETSC_FALSE);CHKERRQ(ierr); 938443836d0SMatthew G Knepley ierr = KSPSetFromOptions(jac->kspupper);CHKERRQ(ierr); 93923ee1639SBarry Smith ierr = KSPSetOperators(jac->kspupper,jac->mat[0],jac->pmat[0]);CHKERRQ(ierr); 940443836d0SMatthew G Knepley ierr = VecDuplicate(jac->head->x, &jac->head->z);CHKERRQ(ierr); 941443836d0SMatthew G Knepley } else { 942443836d0SMatthew G Knepley jac->kspupper = jac->head->ksp; 943443836d0SMatthew G Knepley ierr = PetscObjectReference((PetscObject) jac->head->ksp);CHKERRQ(ierr); 944443836d0SMatthew G Knepley } 945443836d0SMatthew G Knepley 946a7476a74SDmitry Karpeev if (jac->schurpre == PC_FIELDSPLIT_SCHUR_PRE_SELFP) { 947a7476a74SDmitry Karpeev ierr = MatSchurComplementGetPmat(jac->schur,MAT_INITIAL_MATRIX,&jac->schurp);CHKERRQ(ierr); 948a7476a74SDmitry Karpeev } 949ce94432eSBarry Smith ierr = KSPCreate(PetscObjectComm((PetscObject)pc),&jac->kspschur);CHKERRQ(ierr); 950422a814eSBarry Smith ierr = KSPSetErrorIfNotConverged(jac->kspschur,pc->erroriffailure);CHKERRQ(ierr); 95197bbdb24SBarry Smith ierr = PetscLogObjectParent((PetscObject)pc,(PetscObject)jac->kspschur);CHKERRQ(ierr); 95220252d06SBarry Smith ierr = PetscObjectIncrementTabLevel((PetscObject)jac->kspschur,(PetscObject)pc,1);CHKERRQ(ierr); 95397bbdb24SBarry Smith if (jac->schurpre == PC_FIELDSPLIT_SCHUR_PRE_SELF) { 9547233a360SDmitry Karpeev PC pcschur; 9557233a360SDmitry Karpeev ierr = KSPGetPC(jac->kspschur,&pcschur);CHKERRQ(ierr); 9567233a360SDmitry Karpeev ierr = PCSetType(pcschur,PCNONE);CHKERRQ(ierr); 95797bbdb24SBarry Smith /* Note: This is bad if there exist preconditioners for MATSCHURCOMPLEMENT */ 958e74569cdSMatthew G. Knepley } else if (jac->schurpre == PC_FIELDSPLIT_SCHUR_PRE_FULL) { 959e74569cdSMatthew G. Knepley ierr = MatSchurComplementComputeExplicitOperator(jac->schur, &jac->schur_user);CHKERRQ(ierr); 96097bbdb24SBarry Smith } 96123ee1639SBarry Smith ierr = KSPSetOperators(jac->kspschur,jac->schur,FieldSplitSchurPre(jac));CHKERRQ(ierr); 96297bbdb24SBarry Smith ierr = KSPGetOptionsPrefix(jac->head->next->ksp, &Dprefix);CHKERRQ(ierr); 96397bbdb24SBarry Smith ierr = KSPSetOptionsPrefix(jac->kspschur, Dprefix);CHKERRQ(ierr); 964c096484dSStefano Zampini /* propagate DM */ 965b20b4189SMatthew G. Knepley { 966b20b4189SMatthew G. Knepley DM sdm; 967b20b4189SMatthew G. Knepley ierr = KSPGetDM(jac->head->next->ksp, &sdm);CHKERRQ(ierr); 968b20b4189SMatthew G. Knepley if (sdm) { 969b20b4189SMatthew G. Knepley ierr = KSPSetDM(jac->kspschur, sdm);CHKERRQ(ierr); 970b20b4189SMatthew G. Knepley ierr = KSPSetDMActive(jac->kspschur, PETSC_FALSE);CHKERRQ(ierr); 971b20b4189SMatthew G. Knepley } 972b20b4189SMatthew G. Knepley } 97397bbdb24SBarry Smith /* really want setfromoptions called in PCSetFromOptions_FieldSplit(), but it is not ready yet */ 97497bbdb24SBarry Smith /* need to call this every time, since the jac->kspschur is freshly created, otherwise its options never get set */ 97597bbdb24SBarry Smith ierr = KSPSetFromOptions(jac->kspschur);CHKERRQ(ierr); 97697bbdb24SBarry Smith } 977686bed4dSStefano Zampini ierr = MatAssemblyBegin(jac->schur,MAT_FINAL_ASSEMBLY);CHKERRQ(ierr); 978686bed4dSStefano Zampini ierr = MatAssemblyEnd(jac->schur,MAT_FINAL_ASSEMBLY);CHKERRQ(ierr); 97997bbdb24SBarry Smith 9805a9f2f41SSatish Balay /* HACK: special support to forward L and Lp matrices that might be used by PCLSC */ 9818caf3d72SBarry Smith ierr = PetscSNPrintf(lscname,sizeof(lscname),"%s_LSC_L",ilink->splitname);CHKERRQ(ierr); 982519d70e2SJed Brown ierr = PetscObjectQuery((PetscObject)pc->mat,lscname,(PetscObject*)&LSC_L);CHKERRQ(ierr); 9833b224e63SBarry Smith if (!LSC_L) {ierr = PetscObjectQuery((PetscObject)pc->pmat,lscname,(PetscObject*)&LSC_L);CHKERRQ(ierr);} 984c1570756SJed Brown if (LSC_L) {ierr = PetscObjectCompose((PetscObject)jac->schur,"LSC_L",(PetscObject)LSC_L);CHKERRQ(ierr);} 9858caf3d72SBarry Smith ierr = PetscSNPrintf(lscname,sizeof(lscname),"%s_LSC_Lp",ilink->splitname);CHKERRQ(ierr); 98697bbdb24SBarry Smith ierr = PetscObjectQuery((PetscObject)pc->pmat,lscname,(PetscObject*)&LSC_L);CHKERRQ(ierr); 9875a9f2f41SSatish Balay if (!LSC_L) {ierr = PetscObjectQuery((PetscObject)pc->mat,lscname,(PetscObject*)&LSC_L);CHKERRQ(ierr);} 9880971522cSBarry Smith if (LSC_L) {ierr = PetscObjectCompose((PetscObject)jac->schur,"LSC_Lp",(PetscObject)LSC_L);CHKERRQ(ierr);} 989a51937d4SCarola Kruse } else if (jac->type == PC_COMPOSITE_GKB) { 990a51937d4SCarola Kruse IS ccis; 991a51937d4SCarola Kruse PetscInt rstart,rend; 992a51937d4SCarola Kruse 993a51937d4SCarola Kruse if (nsplit != 2) SETERRQ(PetscObjectComm((PetscObject)pc),PETSC_ERR_ARG_INCOMP,"To use GKB preconditioner you must have exactly 2 fields"); 994a51937d4SCarola Kruse 995a51937d4SCarola Kruse ilink = jac->head; 996a51937d4SCarola Kruse 997a51937d4SCarola Kruse /* When extracting off-diagonal submatrices, we take complements from this range */ 998a51937d4SCarola Kruse ierr = MatGetOwnershipRangeColumn(pc->mat,&rstart,&rend);CHKERRQ(ierr); 999a51937d4SCarola Kruse 1000a51937d4SCarola Kruse ierr = ISComplement(ilink->is_col,rstart,rend,&ccis);CHKERRQ(ierr); 1001a51937d4SCarola Kruse if (jac->offdiag_use_amat) { 1002a51937d4SCarola Kruse ierr = MatCreateSubMatrix(pc->mat,ilink->is,ccis,MAT_INITIAL_MATRIX,&jac->B);CHKERRQ(ierr); 1003a51937d4SCarola Kruse } else { 1004a51937d4SCarola Kruse ierr = MatCreateSubMatrix(pc->pmat,ilink->is,ccis,MAT_INITIAL_MATRIX,&jac->B);CHKERRQ(ierr); 1005a51937d4SCarola Kruse } 1006a51937d4SCarola Kruse ierr = ISDestroy(&ccis);CHKERRQ(ierr); 1007a51937d4SCarola Kruse ilink = ilink->next; 1008a51937d4SCarola Kruse ierr = ISComplement(ilink->is_col,rstart,rend,&ccis);CHKERRQ(ierr); 1009a51937d4SCarola Kruse if (jac->offdiag_use_amat) { 1010a51937d4SCarola Kruse ierr = MatCreateSubMatrix(pc->mat,ilink->is,ccis,MAT_INITIAL_MATRIX,&jac->C);CHKERRQ(ierr); 1011a51937d4SCarola Kruse } else { 1012a51937d4SCarola Kruse ierr = MatCreateSubMatrix(pc->pmat,ilink->is,ccis,MAT_INITIAL_MATRIX,&jac->C);CHKERRQ(ierr); 1013a51937d4SCarola Kruse } 1014a51937d4SCarola Kruse ierr = ISDestroy(&ccis);CHKERRQ(ierr); 1015a51937d4SCarola Kruse ierr = MatGolubKahanComputeExplicitOperator(jac->mat[0],jac->B,jac->C,&jac->H,jac->gkbnu);CHKERRQ(ierr); 1016a51937d4SCarola Kruse ilink = jac->head; 1017a51937d4SCarola Kruse ierr = KSPSetOperators(ilink->ksp,jac->H,jac->H);CHKERRQ(ierr); 1018a51937d4SCarola Kruse if (!jac->suboptionsset) {ierr = KSPSetFromOptions(ilink->ksp);CHKERRQ(ierr);} 10190971522cSBarry Smith } else { 102068bd789dSDmitry Karpeev /* set up the individual splits' PCs */ 10210971522cSBarry Smith i = 0; 10220971522cSBarry Smith ilink = jac->head; 10230971522cSBarry Smith while (ilink) { 102423ee1639SBarry Smith ierr = KSPSetOperators(ilink->ksp,jac->mat[i],jac->pmat[i]);CHKERRQ(ierr); 10250971522cSBarry Smith /* really want setfromoptions called in PCSetFromOptions_FieldSplit(), but it is not ready yet */ 10260971522cSBarry Smith if (!jac->suboptionsset) {ierr = KSPSetFromOptions(ilink->ksp);CHKERRQ(ierr);} 10270971522cSBarry Smith i++; 10280971522cSBarry Smith ilink = ilink->next; 10290971522cSBarry Smith } 10303b224e63SBarry Smith } 10313b224e63SBarry Smith 1032c1570756SJed Brown jac->suboptionsset = PETSC_TRUE; 10330971522cSBarry Smith PetscFunctionReturn(0); 10340971522cSBarry Smith } 10350971522cSBarry Smith 10365a9f2f41SSatish Balay #define FieldSplitSplitSolveAdd(ilink,xx,yy) \ 1037ca9f406cSSatish Balay (VecScatterBegin(ilink->sctx,xx,ilink->x,INSERT_VALUES,SCATTER_FORWARD) || \ 1038ca9f406cSSatish Balay VecScatterEnd(ilink->sctx,xx,ilink->x,INSERT_VALUES,SCATTER_FORWARD) || \ 10399df09d43SBarry Smith PetscLogEventBegin(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL) ||\ 10405a9f2f41SSatish Balay KSPSolve(ilink->ksp,ilink->x,ilink->y) || \ 10419df09d43SBarry Smith PetscLogEventEnd(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL) ||\ 1042ca9f406cSSatish Balay VecScatterBegin(ilink->sctx,ilink->y,yy,ADD_VALUES,SCATTER_REVERSE) || \ 1043ca9f406cSSatish Balay VecScatterEnd(ilink->sctx,ilink->y,yy,ADD_VALUES,SCATTER_REVERSE)) 104479416396SBarry Smith 10453b224e63SBarry Smith static PetscErrorCode PCApply_FieldSplit_Schur(PC pc,Vec x,Vec y) 10463b224e63SBarry Smith { 10473b224e63SBarry Smith PC_FieldSplit *jac = (PC_FieldSplit*)pc->data; 10483b224e63SBarry Smith PetscErrorCode ierr; 10493b224e63SBarry Smith PC_FieldSplitLink ilinkA = jac->head, ilinkD = ilinkA->next; 1050443836d0SMatthew G Knepley KSP kspA = ilinkA->ksp, kspLower = kspA, kspUpper = jac->kspupper; 10513b224e63SBarry Smith 10523b224e63SBarry Smith PetscFunctionBegin; 1053c5d2311dSJed Brown switch (jac->schurfactorization) { 1054c9c6ffaaSJed Brown case PC_FIELDSPLIT_SCHUR_FACT_DIAG: 1055a04f6461SBarry Smith /* [A00 0; 0 -S], positive definite, suitable for MINRES */ 1056c5d2311dSJed Brown ierr = VecScatterBegin(ilinkA->sctx,x,ilinkA->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr); 1057c5d2311dSJed Brown ierr = VecScatterBegin(ilinkD->sctx,x,ilinkD->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr); 1058c5d2311dSJed Brown ierr = VecScatterEnd(ilinkA->sctx,x,ilinkA->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr); 10599df09d43SBarry Smith ierr = PetscLogEventBegin(ilinkA->event,kspA,ilinkA->x,ilinkA->y,NULL);CHKERRQ(ierr); 1060443836d0SMatthew G Knepley ierr = KSPSolve(kspA,ilinkA->x,ilinkA->y);CHKERRQ(ierr); 10619df09d43SBarry Smith ierr = PetscLogEventEnd(ilinkA->event,kspA,ilinkA->x,ilinkA->y,NULL);CHKERRQ(ierr); 1062c5d2311dSJed Brown ierr = VecScatterBegin(ilinkA->sctx,ilinkA->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr); 1063c5d2311dSJed Brown ierr = VecScatterEnd(ilinkD->sctx,x,ilinkD->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr); 10649df09d43SBarry Smith ierr = PetscLogEventBegin(KSP_Solve_FS_S,jac->kspschur,ilinkD->x,ilinkD->y,NULL);CHKERRQ(ierr); 1065c5d2311dSJed Brown ierr = KSPSolve(jac->kspschur,ilinkD->x,ilinkD->y);CHKERRQ(ierr); 10669df09d43SBarry Smith ierr = PetscLogEventEnd(KSP_Solve_FS_S,jac->kspschur,ilinkD->x,ilinkD->y,NULL);CHKERRQ(ierr); 1067c096484dSStefano Zampini ierr = VecScale(ilinkD->y,jac->schurscale);CHKERRQ(ierr); 1068c5d2311dSJed Brown ierr = VecScatterBegin(ilinkD->sctx,ilinkD->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr); 1069c5d2311dSJed Brown ierr = VecScatterEnd(ilinkA->sctx,ilinkA->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr); 1070c5d2311dSJed Brown ierr = VecScatterEnd(ilinkD->sctx,ilinkD->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr); 1071c5d2311dSJed Brown break; 1072c9c6ffaaSJed Brown case PC_FIELDSPLIT_SCHUR_FACT_LOWER: 1073a04f6461SBarry Smith /* [A00 0; A10 S], suitable for left preconditioning */ 1074c5d2311dSJed Brown ierr = VecScatterBegin(ilinkA->sctx,x,ilinkA->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr); 1075c5d2311dSJed Brown ierr = VecScatterEnd(ilinkA->sctx,x,ilinkA->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr); 10769df09d43SBarry Smith ierr = PetscLogEventBegin(ilinkA->event,kspA,ilinkA->x,ilinkA->y,NULL);CHKERRQ(ierr); 1077443836d0SMatthew G Knepley ierr = KSPSolve(kspA,ilinkA->x,ilinkA->y);CHKERRQ(ierr); 10789df09d43SBarry Smith ierr = PetscLogEventEnd(ilinkA->event,kspA,ilinkA->x,ilinkA->y,NULL);CHKERRQ(ierr); 1079c5d2311dSJed Brown ierr = MatMult(jac->C,ilinkA->y,ilinkD->x);CHKERRQ(ierr); 1080c5d2311dSJed Brown ierr = VecScale(ilinkD->x,-1.);CHKERRQ(ierr); 1081c5d2311dSJed Brown ierr = VecScatterBegin(ilinkD->sctx,x,ilinkD->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr); 1082c5d2311dSJed Brown ierr = VecScatterBegin(ilinkA->sctx,ilinkA->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr); 1083c5d2311dSJed Brown ierr = VecScatterEnd(ilinkD->sctx,x,ilinkD->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr); 10849df09d43SBarry Smith ierr = PetscLogEventBegin(KSP_Solve_FS_S,jac->kspschur,ilinkD->x,ilinkD->y,NULL);CHKERRQ(ierr); 1085c5d2311dSJed Brown ierr = KSPSolve(jac->kspschur,ilinkD->x,ilinkD->y);CHKERRQ(ierr); 10869df09d43SBarry Smith ierr = PetscLogEventEnd(KSP_Solve_FS_S,jac->kspschur,ilinkD->x,ilinkD->y,NULL);CHKERRQ(ierr); 1087c5d2311dSJed Brown ierr = VecScatterBegin(ilinkD->sctx,ilinkD->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr); 1088c5d2311dSJed Brown ierr = VecScatterEnd(ilinkA->sctx,ilinkA->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr); 1089c5d2311dSJed Brown ierr = VecScatterEnd(ilinkD->sctx,ilinkD->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr); 1090c5d2311dSJed Brown break; 1091c9c6ffaaSJed Brown case PC_FIELDSPLIT_SCHUR_FACT_UPPER: 1092a04f6461SBarry Smith /* [A00 A01; 0 S], suitable for right preconditioning */ 1093c5d2311dSJed Brown ierr = VecScatterBegin(ilinkD->sctx,x,ilinkD->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr); 1094c5d2311dSJed Brown ierr = VecScatterEnd(ilinkD->sctx,x,ilinkD->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr); 10959df09d43SBarry Smith ierr = PetscLogEventBegin(KSP_Solve_FS_S,jac->kspschur,ilinkD->x,ilinkD->y,NULL);CHKERRQ(ierr); 1096c5d2311dSJed Brown ierr = KSPSolve(jac->kspschur,ilinkD->x,ilinkD->y);CHKERRQ(ierr); 10979df09d43SBarry 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); 1098c5d2311dSJed Brown ierr = VecScale(ilinkA->x,-1.);CHKERRQ(ierr); 1099c5d2311dSJed Brown ierr = VecScatterBegin(ilinkA->sctx,x,ilinkA->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr); 1100c5d2311dSJed Brown ierr = VecScatterBegin(ilinkD->sctx,ilinkD->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr); 1101c5d2311dSJed Brown ierr = VecScatterEnd(ilinkA->sctx,x,ilinkA->x,ADD_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 = VecScatterBegin(ilinkA->sctx,ilinkA->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr); 1106c5d2311dSJed Brown ierr = VecScatterEnd(ilinkD->sctx,ilinkD->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr); 1107c5d2311dSJed Brown ierr = VecScatterEnd(ilinkA->sctx,ilinkA->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr); 1108c5d2311dSJed Brown break; 1109c9c6ffaaSJed Brown case PC_FIELDSPLIT_SCHUR_FACT_FULL: 1110c238f8cdSStefano Zampini /* [1 0; A10 A00^{-1} 1] [A00 0; 0 S] [1 A00^{-1}A01; 0 1] */ 11113b224e63SBarry Smith ierr = VecScatterBegin(ilinkA->sctx,x,ilinkA->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr); 11123b224e63SBarry Smith ierr = VecScatterEnd(ilinkA->sctx,x,ilinkA->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr); 11139df09d43SBarry Smith ierr = PetscLogEventBegin(KSP_Solve_FS_L,kspLower,ilinkA->x,ilinkA->y,NULL);CHKERRQ(ierr); 1114443836d0SMatthew G Knepley ierr = KSPSolve(kspLower,ilinkA->x,ilinkA->y);CHKERRQ(ierr); 11159df09d43SBarry Smith ierr = PetscLogEventEnd(KSP_Solve_FS_L,kspLower,ilinkA->x,ilinkA->y,NULL);CHKERRQ(ierr); 11163b224e63SBarry Smith ierr = MatMult(jac->C,ilinkA->y,ilinkD->x);CHKERRQ(ierr); 11173b224e63SBarry Smith ierr = VecScale(ilinkD->x,-1.0);CHKERRQ(ierr); 11183b224e63SBarry Smith ierr = VecScatterBegin(ilinkD->sctx,x,ilinkD->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr); 11193b224e63SBarry Smith ierr = VecScatterEnd(ilinkD->sctx,x,ilinkD->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr); 11203b224e63SBarry Smith 11219df09d43SBarry Smith ierr = PetscLogEventBegin(KSP_Solve_FS_S,jac->kspschur,ilinkD->x,ilinkD->y,NULL);CHKERRQ(ierr); 11223b224e63SBarry Smith 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); 11243b224e63SBarry Smith ierr = VecScatterBegin(ilinkD->sctx,ilinkD->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr); 11253b224e63SBarry Smith 1126443836d0SMatthew G Knepley if (kspUpper == kspA) { 11273b224e63SBarry Smith ierr = MatMult(jac->B,ilinkD->y,ilinkA->y);CHKERRQ(ierr); 11283b224e63SBarry Smith ierr = VecAXPY(ilinkA->x,-1.0,ilinkA->y);CHKERRQ(ierr); 11299df09d43SBarry Smith ierr = PetscLogEventBegin(ilinkA->event,kspA,ilinkA->x,ilinkA->y,NULL);CHKERRQ(ierr); 1130443836d0SMatthew G Knepley ierr = KSPSolve(kspA,ilinkA->x,ilinkA->y);CHKERRQ(ierr); 11319df09d43SBarry Smith ierr = PetscLogEventEnd(ilinkA->event,kspA,ilinkA->x,ilinkA->y,NULL);CHKERRQ(ierr); 1132443836d0SMatthew G Knepley } else { 11339df09d43SBarry Smith ierr = PetscLogEventBegin(ilinkA->event,kspA,ilinkA->x,ilinkA->y,NULL);CHKERRQ(ierr); 1134443836d0SMatthew G Knepley ierr = KSPSolve(kspA,ilinkA->x,ilinkA->y);CHKERRQ(ierr); 11359df09d43SBarry Smith ierr = PetscLogEventEnd(ilinkA->event,kspA,ilinkA->x,ilinkA->y,NULL);CHKERRQ(ierr); 1136443836d0SMatthew G Knepley ierr = MatMult(jac->B,ilinkD->y,ilinkA->x);CHKERRQ(ierr); 11379df09d43SBarry Smith ierr = PetscLogEventBegin(KSP_Solve_FS_U,kspUpper,ilinkA->x,ilinkA->z,NULL);CHKERRQ(ierr); 1138443836d0SMatthew G Knepley ierr = KSPSolve(kspUpper,ilinkA->x,ilinkA->z);CHKERRQ(ierr); 11399df09d43SBarry Smith ierr = PetscLogEventEnd(KSP_Solve_FS_U,kspUpper,ilinkA->x,ilinkA->z,NULL);CHKERRQ(ierr); 1140443836d0SMatthew G Knepley ierr = VecAXPY(ilinkA->y,-1.0,ilinkA->z);CHKERRQ(ierr); 1141443836d0SMatthew G Knepley } 1142c238f8cdSStefano Zampini ierr = VecScatterEnd(ilinkD->sctx,ilinkD->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr); 11433b224e63SBarry Smith ierr = VecScatterBegin(ilinkA->sctx,ilinkA->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr); 11443b224e63SBarry Smith ierr = VecScatterEnd(ilinkA->sctx,ilinkA->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr); 1145c5d2311dSJed Brown } 11463b224e63SBarry Smith PetscFunctionReturn(0); 11473b224e63SBarry Smith } 11483b224e63SBarry Smith 11490971522cSBarry Smith static PetscErrorCode PCApply_FieldSplit(PC pc,Vec x,Vec y) 11500971522cSBarry Smith { 11510971522cSBarry Smith PC_FieldSplit *jac = (PC_FieldSplit*)pc->data; 11520971522cSBarry Smith PetscErrorCode ierr; 11535a9f2f41SSatish Balay PC_FieldSplitLink ilink = jac->head; 1154939b8a20SBarry Smith PetscInt cnt,bs; 1155568ed31eSHong Zhang KSPConvergedReason reason; 11560971522cSBarry Smith 11570971522cSBarry Smith PetscFunctionBegin; 115879416396SBarry Smith if (jac->type == PC_COMPOSITE_ADDITIVE) { 11591b9fc7fcSBarry Smith if (jac->defaultsplit) { 1160939b8a20SBarry Smith ierr = VecGetBlockSize(x,&bs);CHKERRQ(ierr); 1161ce94432eSBarry 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); 1162939b8a20SBarry Smith ierr = VecGetBlockSize(y,&bs);CHKERRQ(ierr); 1163ce94432eSBarry 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); 11640971522cSBarry Smith ierr = VecStrideGatherAll(x,jac->x,INSERT_VALUES);CHKERRQ(ierr); 11655a9f2f41SSatish Balay while (ilink) { 11669df09d43SBarry Smith ierr = PetscLogEventBegin(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL);CHKERRQ(ierr); 11675a9f2f41SSatish Balay ierr = KSPSolve(ilink->ksp,ilink->x,ilink->y);CHKERRQ(ierr); 11689df09d43SBarry Smith ierr = PetscLogEventEnd(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL);CHKERRQ(ierr); 1169568ed31eSHong Zhang ierr = KSPGetConvergedReason(ilink->ksp,&reason);CHKERRQ(ierr); 1170568ed31eSHong Zhang if (reason == KSP_DIVERGED_PCSETUP_FAILED) { 1171568ed31eSHong Zhang pc->failedreason = PC_SUBPC_ERROR; 1172568ed31eSHong Zhang } 11735a9f2f41SSatish Balay ilink = ilink->next; 11740971522cSBarry Smith } 11750971522cSBarry Smith ierr = VecStrideScatterAll(jac->y,y,INSERT_VALUES);CHKERRQ(ierr); 11761b9fc7fcSBarry Smith } else { 1177efb30889SBarry Smith ierr = VecSet(y,0.0);CHKERRQ(ierr); 11785a9f2f41SSatish Balay while (ilink) { 11795a9f2f41SSatish Balay ierr = FieldSplitSplitSolveAdd(ilink,x,y);CHKERRQ(ierr); 1180568ed31eSHong Zhang ierr = KSPGetConvergedReason(ilink->ksp,&reason);CHKERRQ(ierr); 1181568ed31eSHong Zhang if (reason == KSP_DIVERGED_PCSETUP_FAILED) { 1182568ed31eSHong Zhang pc->failedreason = PC_SUBPC_ERROR; 1183568ed31eSHong Zhang } 11845a9f2f41SSatish Balay ilink = ilink->next; 11851b9fc7fcSBarry Smith } 11861b9fc7fcSBarry Smith } 1187e52d2c62SBarry Smith } else if (jac->type == PC_COMPOSITE_MULTIPLICATIVE && jac->nsplits == 2) { 1188e52d2c62SBarry Smith ierr = VecSet(y,0.0);CHKERRQ(ierr); 1189e52d2c62SBarry Smith /* solve on first block for first block variables */ 1190e52d2c62SBarry Smith ierr = VecScatterBegin(ilink->sctx,x,ilink->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr); 1191e52d2c62SBarry Smith ierr = VecScatterEnd(ilink->sctx,x,ilink->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr); 11929df09d43SBarry Smith ierr = PetscLogEventBegin(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL);CHKERRQ(ierr); 1193e52d2c62SBarry Smith 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 } 1199e52d2c62SBarry Smith ierr = VecScatterBegin(ilink->sctx,ilink->y,y,ADD_VALUES,SCATTER_REVERSE);CHKERRQ(ierr); 1200e52d2c62SBarry Smith ierr = VecScatterEnd(ilink->sctx,ilink->y,y,ADD_VALUES,SCATTER_REVERSE);CHKERRQ(ierr); 1201e52d2c62SBarry Smith 1202e52d2c62SBarry Smith /* compute the residual only onto second block variables using first block variables */ 1203e52d2c62SBarry Smith ierr = MatMult(jac->Afield[1],ilink->y,ilink->next->x);CHKERRQ(ierr); 1204e52d2c62SBarry Smith ilink = ilink->next; 1205e52d2c62SBarry Smith ierr = VecScale(ilink->x,-1.0);CHKERRQ(ierr); 1206e52d2c62SBarry Smith ierr = VecScatterBegin(ilink->sctx,x,ilink->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr); 1207e52d2c62SBarry Smith ierr = VecScatterEnd(ilink->sctx,x,ilink->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr); 1208e52d2c62SBarry Smith 1209e52d2c62SBarry Smith /* solve on second block variables */ 12109df09d43SBarry Smith ierr = PetscLogEventBegin(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL);CHKERRQ(ierr); 1211e52d2c62SBarry Smith ierr = KSPSolve(ilink->ksp,ilink->x,ilink->y);CHKERRQ(ierr); 12129df09d43SBarry Smith ierr = PetscLogEventEnd(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL);CHKERRQ(ierr); 1213568ed31eSHong Zhang ierr = KSPGetConvergedReason(ilink->ksp,&reason);CHKERRQ(ierr); 1214568ed31eSHong Zhang if (reason == KSP_DIVERGED_PCSETUP_FAILED) { 1215568ed31eSHong Zhang pc->failedreason = PC_SUBPC_ERROR; 1216568ed31eSHong Zhang } 1217e52d2c62SBarry Smith ierr = VecScatterBegin(ilink->sctx,ilink->y,y,ADD_VALUES,SCATTER_REVERSE);CHKERRQ(ierr); 1218e52d2c62SBarry Smith ierr = VecScatterEnd(ilink->sctx,ilink->y,y,ADD_VALUES,SCATTER_REVERSE);CHKERRQ(ierr); 121916913363SBarry Smith } else if (jac->type == PC_COMPOSITE_MULTIPLICATIVE || jac->type == PC_COMPOSITE_SYMMETRIC_MULTIPLICATIVE) { 122079416396SBarry Smith if (!jac->w1) { 122179416396SBarry Smith ierr = VecDuplicate(x,&jac->w1);CHKERRQ(ierr); 122279416396SBarry Smith ierr = VecDuplicate(x,&jac->w2);CHKERRQ(ierr); 122379416396SBarry Smith } 1224efb30889SBarry Smith ierr = VecSet(y,0.0);CHKERRQ(ierr); 12255a9f2f41SSatish Balay ierr = FieldSplitSplitSolveAdd(ilink,x,y);CHKERRQ(ierr); 1226568ed31eSHong Zhang ierr = KSPGetConvergedReason(ilink->ksp,&reason);CHKERRQ(ierr); 1227568ed31eSHong Zhang if (reason == KSP_DIVERGED_PCSETUP_FAILED) { 1228568ed31eSHong Zhang pc->failedreason = PC_SUBPC_ERROR; 1229568ed31eSHong Zhang } 12303e197d65SBarry Smith cnt = 1; 12315a9f2f41SSatish Balay while (ilink->next) { 12325a9f2f41SSatish Balay ilink = ilink->next; 12333e197d65SBarry Smith /* compute the residual only over the part of the vector needed */ 12343e197d65SBarry Smith ierr = MatMult(jac->Afield[cnt++],y,ilink->x);CHKERRQ(ierr); 12353e197d65SBarry Smith ierr = VecScale(ilink->x,-1.0);CHKERRQ(ierr); 12363e197d65SBarry Smith ierr = VecScatterBegin(ilink->sctx,x,ilink->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr); 12373e197d65SBarry Smith ierr = VecScatterEnd(ilink->sctx,x,ilink->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr); 12389df09d43SBarry Smith ierr = PetscLogEventBegin(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL);CHKERRQ(ierr); 12393e197d65SBarry Smith ierr = KSPSolve(ilink->ksp,ilink->x,ilink->y);CHKERRQ(ierr); 12409df09d43SBarry Smith ierr = PetscLogEventEnd(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL);CHKERRQ(ierr); 12412618eb8fSHong Zhang ierr = KSPGetConvergedReason(ilink->ksp,&reason);CHKERRQ(ierr); 12422618eb8fSHong Zhang if (reason == KSP_DIVERGED_PCSETUP_FAILED) { 12432618eb8fSHong Zhang pc->failedreason = PC_SUBPC_ERROR; 12442618eb8fSHong Zhang } 12453e197d65SBarry Smith ierr = VecScatterBegin(ilink->sctx,ilink->y,y,ADD_VALUES,SCATTER_REVERSE);CHKERRQ(ierr); 12463e197d65SBarry Smith ierr = VecScatterEnd(ilink->sctx,ilink->y,y,ADD_VALUES,SCATTER_REVERSE);CHKERRQ(ierr); 12473e197d65SBarry Smith } 124851f519a2SBarry Smith if (jac->type == PC_COMPOSITE_SYMMETRIC_MULTIPLICATIVE) { 124911755939SBarry Smith cnt -= 2; 125051f519a2SBarry Smith while (ilink->previous) { 125151f519a2SBarry Smith ilink = ilink->previous; 125211755939SBarry Smith /* compute the residual only over the part of the vector needed */ 125311755939SBarry Smith ierr = MatMult(jac->Afield[cnt--],y,ilink->x);CHKERRQ(ierr); 125411755939SBarry Smith ierr = VecScale(ilink->x,-1.0);CHKERRQ(ierr); 125511755939SBarry Smith ierr = VecScatterBegin(ilink->sctx,x,ilink->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr); 125611755939SBarry Smith ierr = VecScatterEnd(ilink->sctx,x,ilink->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr); 12579df09d43SBarry Smith ierr = PetscLogEventBegin(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL);CHKERRQ(ierr); 125811755939SBarry Smith ierr = KSPSolve(ilink->ksp,ilink->x,ilink->y);CHKERRQ(ierr); 12599df09d43SBarry Smith ierr = PetscLogEventEnd(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL);CHKERRQ(ierr); 1260568ed31eSHong Zhang ierr = KSPGetConvergedReason(ilink->ksp,&reason);CHKERRQ(ierr); 1261568ed31eSHong Zhang if (reason == KSP_DIVERGED_PCSETUP_FAILED) { 1262568ed31eSHong Zhang pc->failedreason = PC_SUBPC_ERROR; 1263568ed31eSHong Zhang } 126411755939SBarry Smith ierr = VecScatterBegin(ilink->sctx,ilink->y,y,ADD_VALUES,SCATTER_REVERSE);CHKERRQ(ierr); 126511755939SBarry Smith ierr = VecScatterEnd(ilink->sctx,ilink->y,y,ADD_VALUES,SCATTER_REVERSE);CHKERRQ(ierr); 126651f519a2SBarry Smith } 126711755939SBarry Smith } 1268ce94432eSBarry Smith } else SETERRQ1(PetscObjectComm((PetscObject)pc),PETSC_ERR_SUP,"Unsupported or unknown composition",(int) jac->type); 12690971522cSBarry Smith PetscFunctionReturn(0); 12700971522cSBarry Smith } 12710971522cSBarry Smith 1272a51937d4SCarola Kruse 1273a51937d4SCarola Kruse static PetscErrorCode PCApply_FieldSplit_GKB(PC pc,Vec x,Vec y) 1274a51937d4SCarola Kruse { 1275a51937d4SCarola Kruse PC_FieldSplit *jac = (PC_FieldSplit*)pc->data; 1276a51937d4SCarola Kruse PetscErrorCode ierr; 1277a51937d4SCarola Kruse PC_FieldSplitLink ilinkA = jac->head,ilinkD = ilinkA->next; 1278a51937d4SCarola Kruse KSP ksp = ilinkA->ksp; 1279a51937d4SCarola Kruse Vec u,v,c,Hu,d,b,q,work1,work2; 1280a51937d4SCarola Kruse PetscScalar alpha,z,beta,nrmz2,*vecz; 1281a51937d4SCarola Kruse PetscReal lowbnd,nu; 1282a51937d4SCarola Kruse PetscInt j,iterGKB; 1283a51937d4SCarola Kruse 1284a51937d4SCarola Kruse PetscFunctionBegin; 1285a51937d4SCarola Kruse ierr = VecScatterBegin(ilinkA->sctx,x,ilinkA->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr); 1286a51937d4SCarola Kruse ierr = VecScatterEnd(ilinkA->sctx,x,ilinkA->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr); 1287a51937d4SCarola Kruse ierr = VecScatterBegin(ilinkD->sctx,x,ilinkD->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr); 1288a51937d4SCarola Kruse ierr = VecScatterEnd(ilinkD->sctx,x,ilinkD->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr); 1289a51937d4SCarola Kruse ierr = VecDuplicate(ilinkD->x,&work1);CHKERRQ(ierr); 1290a51937d4SCarola Kruse ierr = VecDuplicate(ilinkA->x,&work2);CHKERRQ(ierr); 1291a51937d4SCarola Kruse ierr = VecDuplicate(ilinkD->x,&b);CHKERRQ(ierr); 1292a51937d4SCarola Kruse ierr = VecDuplicate(ilinkD->x,&c);CHKERRQ(ierr); 1293a51937d4SCarola Kruse ierr = VecDuplicate(ilinkD->x,&v);CHKERRQ(ierr); 1294a51937d4SCarola Kruse ierr = VecDuplicate(ilinkD->x,&d);CHKERRQ(ierr); 1295a51937d4SCarola Kruse ierr = VecDuplicate(ilinkA->x,&u);CHKERRQ(ierr); 1296a51937d4SCarola Kruse ierr = VecDuplicate(ilinkA->x,&q);CHKERRQ(ierr); 1297a51937d4SCarola Kruse ierr = VecDuplicate(ilinkA->x,&Hu);CHKERRQ(ierr); 1298a51937d4SCarola Kruse ierr = PetscCalloc1(jac->gkbdelay,&vecz);CHKERRQ(ierr); 1299a51937d4SCarola Kruse 1300a51937d4SCarola Kruse /* Initialize Right hand side */ 1301a51937d4SCarola Kruse ierr = VecCopy(ilinkA->x,q);CHKERRQ(ierr); 1302a51937d4SCarola Kruse ierr = VecCopy(ilinkD->x,b);CHKERRQ(ierr); 1303a51937d4SCarola Kruse 1304a51937d4SCarola Kruse /* Change RHS to comply with matrix regularization H = A + nu*B*B' */ 1305a51937d4SCarola Kruse /* Add q = q + nu*B*b */ 1306a51937d4SCarola Kruse if (jac->gkbnu) { 1307a51937d4SCarola Kruse nu = jac->gkbnu; 1308a51937d4SCarola Kruse ierr = VecCopy(b,work1);CHKERRQ(ierr); /* b = nu * b */ 1309a51937d4SCarola Kruse ierr = VecScale(work1,jac->gkbnu);CHKERRQ(ierr); 1310a51937d4SCarola Kruse ierr = MatMultAdd(jac->B,work1,q,q);CHKERRQ(ierr); /* q = q + nu*B*b */ 1311a51937d4SCarola Kruse } else { 1312a51937d4SCarola Kruse /* Situation when no augmented Lagrangian is used. Then we set inner */ 1313a51937d4SCarola Kruse /* matrix N = I in [Ar13], and thus nu = 1. */ 1314a51937d4SCarola Kruse nu = 1; 1315a51937d4SCarola Kruse } 1316a51937d4SCarola Kruse 1317a51937d4SCarola Kruse /* Transform rhs from [q , tilde{b}] to [0, b] */ 1318a51937d4SCarola Kruse ierr = PetscLogEventBegin(ilinkA->event,ksp,q,ilinkA->y,NULL);CHKERRQ(ierr); 1319a51937d4SCarola Kruse ierr = KSPSolve(ksp,q,ilinkA->y);CHKERRQ(ierr); 1320a51937d4SCarola Kruse ierr = PetscLogEventEnd(ilinkA->event,ksp,q,ilinkA->y,NULL);CHKERRQ(ierr); 1321a51937d4SCarola Kruse ierr = MatMultHermitianTranspose(jac->B,ilinkA->y,work1);CHKERRQ(ierr); 1322a51937d4SCarola Kruse ierr = VecWAXPY(c,-1,work1,b);CHKERRQ(ierr); /* c = b - B'*x */ 1323a51937d4SCarola Kruse 1324a51937d4SCarola Kruse /* First step of algorithm */ 1325a51937d4SCarola Kruse ierr = VecCopy(c,v); /* v = nu*c */ 1326a51937d4SCarola Kruse ierr = VecScale(v,nu);CHKERRQ(ierr); 1327a51937d4SCarola Kruse ierr = VecDot(c,v,&beta);CHKERRQ(ierr); /* beta = sqrt(nu*v'*v) */ 1328a51937d4SCarola Kruse beta = PetscSqrtScalar(beta); 1329a51937d4SCarola Kruse ierr = VecScale(v,1/beta);CHKERRQ(ierr); /* v = v/beta */ 1330a51937d4SCarola Kruse ierr = MatMult(jac->B,v,work2);CHKERRQ(ierr); /* u = H^{-1}*B*v */ 1331a51937d4SCarola Kruse ierr = PetscLogEventBegin(ilinkA->event,ksp,work2,u,NULL);CHKERRQ(ierr); 1332a51937d4SCarola Kruse ierr = KSPSolve(ksp,work2,u);CHKERRQ(ierr); 1333a51937d4SCarola Kruse ierr = PetscLogEventEnd(ilinkA->event,ksp,work2,u,NULL);CHKERRQ(ierr); 1334a51937d4SCarola Kruse ierr = MatMult(jac->H,u,Hu);CHKERRQ(ierr); /* alpha = u'*H*u */ 1335a51937d4SCarola Kruse ierr = VecDot(Hu,u,&alpha);CHKERRQ(ierr); 1336a51937d4SCarola Kruse alpha = PetscSqrtScalar(alpha); 1337a51937d4SCarola Kruse ierr = VecScale(u,1/alpha);CHKERRQ(ierr); 1338a51937d4SCarola Kruse ierr = VecCopy(v,d);CHKERRQ(ierr); /* d = v/alpha */ 1339a51937d4SCarola Kruse ierr = VecScale(d,1/alpha);CHKERRQ(ierr); 1340a51937d4SCarola Kruse z = beta/alpha; 1341a51937d4SCarola Kruse vecz[1] = z; 1342a51937d4SCarola Kruse 1343a51937d4SCarola Kruse /* Computation of new iterate x(i+1) and p(i+1) */ 1344a51937d4SCarola Kruse ierr = VecAXPY(ilinkA->y,z,u);CHKERRQ(ierr); 1345a51937d4SCarola Kruse ierr = VecCopy(d,ilinkD->y);CHKERRQ(ierr); 1346a51937d4SCarola Kruse ierr = VecScale(ilinkD->y,-z);CHKERRQ(ierr); 1347a51937d4SCarola Kruse 1348a51937d4SCarola Kruse iterGKB = 1; lowbnd = 2*jac->gkbtol; 1349a51937d4SCarola Kruse while (iterGKB < jac->gkbmaxit && lowbnd > jac->gkbtol) { 1350a51937d4SCarola Kruse iterGKB += 1; 1351a51937d4SCarola Kruse ierr = MatMultHermitianTranspose(jac->B,u,work1);CHKERRQ(ierr); /* nu*(B'*u-alpha/nu*v) */ 1352a51937d4SCarola Kruse ierr = VecScale(work1,nu); 1353a51937d4SCarola Kruse ierr = VecAYPX(v,-alpha,work1);CHKERRQ(ierr); 1354a51937d4SCarola Kruse ierr = VecDot(v,v,&beta);CHKERRQ(ierr); 1355a51937d4SCarola Kruse beta = PetscSqrtScalar(beta/nu); 1356a51937d4SCarola Kruse ierr = VecScale(v,1/beta);CHKERRQ(ierr); 1357a51937d4SCarola Kruse ierr = MatMult(jac->B,v,work2);CHKERRQ(ierr); /* u = H^{-1}*B*v */ 1358a51937d4SCarola Kruse ierr = MatMult(jac->H,u,Hu);CHKERRQ(ierr); 1359a51937d4SCarola Kruse ierr = VecAXPY(work2,-beta,Hu);CHKERRQ(ierr); 1360a51937d4SCarola Kruse ierr = PetscLogEventBegin(ilinkA->event,ksp,work2,u,NULL);CHKERRQ(ierr); 1361a51937d4SCarola Kruse ierr = KSPSolve(ksp,work2,u);CHKERRQ(ierr); 1362a51937d4SCarola Kruse ierr = PetscLogEventEnd(ilinkA->event,ksp,work2,u,NULL);CHKERRQ(ierr); 1363a51937d4SCarola Kruse ierr = MatMult(jac->H,u,Hu);CHKERRQ(ierr); /* alpha = u'*H*u */ 1364a51937d4SCarola Kruse ierr = VecDot(Hu,u,&alpha);CHKERRQ(ierr); 1365a51937d4SCarola Kruse alpha = PetscSqrtScalar(alpha); 1366a51937d4SCarola Kruse ierr = VecScale(u,1/alpha);CHKERRQ(ierr); 1367a51937d4SCarola Kruse 1368a51937d4SCarola Kruse z = -beta/alpha*z; /* z = beta/alpha */ 1369a51937d4SCarola Kruse vecz[0] = z; 1370a51937d4SCarola Kruse 1371a51937d4SCarola Kruse /* Computation of new iterate x(i+1) and p(i+1) */ 1372a51937d4SCarola Kruse ierr = VecAXPBY(d,1/alpha,-beta/alpha,v);CHKERRQ(ierr); /* d = 1/alpha*(v-beta*d)*/ 1373a51937d4SCarola Kruse ierr = VecAXPY(ilinkA->y,z,u);CHKERRQ(ierr); /* r = r + z*u */ 1374a51937d4SCarola Kruse ierr = VecAXPY(ilinkD->y,-z,d);CHKERRQ(ierr); /* p = p - z*d */ 1375a51937d4SCarola Kruse ierr = MatMult(jac->H,ilinkA->y,Hu);CHKERRQ(ierr); /* alpha = u'*H*u */ 1376a51937d4SCarola Kruse ierr = VecDot(Hu,ilinkA->y,&nrmz2);CHKERRQ(ierr); 1377a51937d4SCarola Kruse 1378a51937d4SCarola Kruse /* Compute Lower Bound estimate */ 1379a51937d4SCarola Kruse if (iterGKB > jac->gkbdelay) { 1380a51937d4SCarola Kruse lowbnd = 0.0; 1381a51937d4SCarola Kruse for (j=0; j<jac->gkbdelay; j++) { 1382a51937d4SCarola Kruse lowbnd += PetscAbsScalar(vecz[j]*vecz[j]); 1383a51937d4SCarola Kruse } 1384a51937d4SCarola Kruse lowbnd = PetscSqrtScalar(lowbnd/PetscAbsScalar(nrmz2)); 1385a51937d4SCarola Kruse } 1386a51937d4SCarola Kruse 1387a51937d4SCarola Kruse for (j=0; j<jac->gkbdelay-1; j++) { 1388a51937d4SCarola Kruse vecz[jac->gkbdelay-j-1] = vecz[jac->gkbdelay-j-2]; 1389a51937d4SCarola Kruse } 1390a51937d4SCarola Kruse } 1391a51937d4SCarola Kruse 1392a51937d4SCarola Kruse /* It would be good to have something like a gkb_monitor variable to print out the number of */ 1393a51937d4SCarola Kruse /* iterations iterGKB and the final error estimate lowbnd. Since there is no ksp context associated */ 1394a51937d4SCarola Kruse /* for this intermediate iteration, how can we do it? */ 1395a51937d4SCarola Kruse 1396a51937d4SCarola Kruse ierr = VecScatterBegin(ilinkA->sctx,ilinkA->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr); 1397a51937d4SCarola Kruse ierr = VecScatterEnd(ilinkA->sctx,ilinkA->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr); 1398a51937d4SCarola Kruse ierr = VecScatterBegin(ilinkD->sctx,ilinkD->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr); 1399a51937d4SCarola Kruse ierr = VecScatterEnd(ilinkD->sctx,ilinkD->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr); 1400a51937d4SCarola Kruse 1401a51937d4SCarola Kruse ierr = VecDestroy(&u);CHKERRQ(ierr); 1402a51937d4SCarola Kruse ierr = VecDestroy(&q);CHKERRQ(ierr); 1403a51937d4SCarola Kruse ierr = VecDestroy(&v);CHKERRQ(ierr); 1404a51937d4SCarola Kruse ierr = VecDestroy(&Hu);CHKERRQ(ierr); 1405a51937d4SCarola Kruse ierr = VecDestroy(&d);CHKERRQ(ierr); 1406a51937d4SCarola Kruse ierr = VecDestroy(&b);CHKERRQ(ierr); 1407a51937d4SCarola Kruse ierr = VecDestroy(&c);CHKERRQ(ierr); 1408a51937d4SCarola Kruse ierr = VecDestroy(&work1);CHKERRQ(ierr); 1409a51937d4SCarola Kruse ierr = VecDestroy(&work2);CHKERRQ(ierr); 1410a51937d4SCarola Kruse ierr = PetscFree(vecz);CHKERRQ(ierr); 1411a51937d4SCarola Kruse 1412a51937d4SCarola Kruse PetscFunctionReturn(0); 1413a51937d4SCarola Kruse } 1414a51937d4SCarola Kruse 1415a51937d4SCarola Kruse 1416421e10b8SBarry Smith #define FieldSplitSplitSolveAddTranspose(ilink,xx,yy) \ 1417ca9f406cSSatish Balay (VecScatterBegin(ilink->sctx,xx,ilink->y,INSERT_VALUES,SCATTER_FORWARD) || \ 1418ca9f406cSSatish Balay VecScatterEnd(ilink->sctx,xx,ilink->y,INSERT_VALUES,SCATTER_FORWARD) || \ 14199df09d43SBarry Smith PetscLogEventBegin(ilink->event,ilink->ksp,ilink->y,ilink->x,NULL) || \ 1420421e10b8SBarry Smith KSPSolveTranspose(ilink->ksp,ilink->y,ilink->x) || \ 14219df09d43SBarry Smith PetscLogEventBegin(ilink->event,ilink->ksp,ilink->y,ilink->x,NULL) || \ 1422ca9f406cSSatish Balay VecScatterBegin(ilink->sctx,ilink->x,yy,ADD_VALUES,SCATTER_REVERSE) || \ 1423ca9f406cSSatish Balay VecScatterEnd(ilink->sctx,ilink->x,yy,ADD_VALUES,SCATTER_REVERSE)) 1424421e10b8SBarry Smith 1425421e10b8SBarry Smith static PetscErrorCode PCApplyTranspose_FieldSplit(PC pc,Vec x,Vec y) 1426421e10b8SBarry Smith { 1427421e10b8SBarry Smith PC_FieldSplit *jac = (PC_FieldSplit*)pc->data; 1428421e10b8SBarry Smith PetscErrorCode ierr; 1429421e10b8SBarry Smith PC_FieldSplitLink ilink = jac->head; 1430939b8a20SBarry Smith PetscInt bs; 1431291dd214SHong Zhang KSPConvergedReason reason; 1432421e10b8SBarry Smith 1433421e10b8SBarry Smith PetscFunctionBegin; 1434421e10b8SBarry Smith if (jac->type == PC_COMPOSITE_ADDITIVE) { 1435421e10b8SBarry Smith if (jac->defaultsplit) { 1436939b8a20SBarry Smith ierr = VecGetBlockSize(x,&bs);CHKERRQ(ierr); 1437ce94432eSBarry 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); 1438939b8a20SBarry Smith ierr = VecGetBlockSize(y,&bs);CHKERRQ(ierr); 1439ce94432eSBarry 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); 1440421e10b8SBarry Smith ierr = VecStrideGatherAll(x,jac->x,INSERT_VALUES);CHKERRQ(ierr); 1441421e10b8SBarry Smith while (ilink) { 14429df09d43SBarry Smith ierr = PetscLogEventBegin(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL);CHKERRQ(ierr); 1443421e10b8SBarry Smith ierr = KSPSolveTranspose(ilink->ksp,ilink->x,ilink->y);CHKERRQ(ierr); 14449df09d43SBarry Smith ierr = PetscLogEventEnd(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL);CHKERRQ(ierr); 14452618eb8fSHong Zhang ierr = KSPGetConvergedReason(ilink->ksp,&reason);CHKERRQ(ierr); 14462618eb8fSHong Zhang if (reason == KSP_DIVERGED_PCSETUP_FAILED) { 14472618eb8fSHong Zhang pc->failedreason = PC_SUBPC_ERROR; 14482618eb8fSHong Zhang } 1449421e10b8SBarry Smith ilink = ilink->next; 1450421e10b8SBarry Smith } 1451421e10b8SBarry Smith ierr = VecStrideScatterAll(jac->y,y,INSERT_VALUES);CHKERRQ(ierr); 1452421e10b8SBarry Smith } else { 1453421e10b8SBarry Smith ierr = VecSet(y,0.0);CHKERRQ(ierr); 1454421e10b8SBarry Smith while (ilink) { 1455421e10b8SBarry Smith ierr = FieldSplitSplitSolveAddTranspose(ilink,x,y);CHKERRQ(ierr); 14562618eb8fSHong Zhang ierr = KSPGetConvergedReason(ilink->ksp,&reason);CHKERRQ(ierr); 14572618eb8fSHong Zhang if (reason == KSP_DIVERGED_PCSETUP_FAILED) { 14582618eb8fSHong Zhang pc->failedreason = PC_SUBPC_ERROR; 14592618eb8fSHong Zhang } 1460421e10b8SBarry Smith ilink = ilink->next; 1461421e10b8SBarry Smith } 1462421e10b8SBarry Smith } 1463421e10b8SBarry Smith } else { 1464421e10b8SBarry Smith if (!jac->w1) { 1465421e10b8SBarry Smith ierr = VecDuplicate(x,&jac->w1);CHKERRQ(ierr); 1466421e10b8SBarry Smith ierr = VecDuplicate(x,&jac->w2);CHKERRQ(ierr); 1467421e10b8SBarry Smith } 1468421e10b8SBarry Smith ierr = VecSet(y,0.0);CHKERRQ(ierr); 1469421e10b8SBarry Smith if (jac->type == PC_COMPOSITE_SYMMETRIC_MULTIPLICATIVE) { 1470421e10b8SBarry Smith ierr = FieldSplitSplitSolveAddTranspose(ilink,x,y);CHKERRQ(ierr); 14712618eb8fSHong Zhang ierr = KSPGetConvergedReason(ilink->ksp,&reason);CHKERRQ(ierr); 14722618eb8fSHong Zhang if (reason == KSP_DIVERGED_PCSETUP_FAILED) { 14732618eb8fSHong Zhang pc->failedreason = PC_SUBPC_ERROR; 14742618eb8fSHong Zhang } 1475421e10b8SBarry Smith while (ilink->next) { 1476421e10b8SBarry Smith ilink = ilink->next; 14779989ab13SBarry Smith ierr = MatMultTranspose(pc->mat,y,jac->w1);CHKERRQ(ierr); 1478421e10b8SBarry Smith ierr = VecWAXPY(jac->w2,-1.0,jac->w1,x);CHKERRQ(ierr); 1479421e10b8SBarry Smith ierr = FieldSplitSplitSolveAddTranspose(ilink,jac->w2,y);CHKERRQ(ierr); 1480421e10b8SBarry Smith } 1481421e10b8SBarry Smith while (ilink->previous) { 1482421e10b8SBarry Smith ilink = ilink->previous; 14839989ab13SBarry Smith ierr = MatMultTranspose(pc->mat,y,jac->w1);CHKERRQ(ierr); 1484421e10b8SBarry Smith ierr = VecWAXPY(jac->w2,-1.0,jac->w1,x);CHKERRQ(ierr); 1485421e10b8SBarry Smith ierr = FieldSplitSplitSolveAddTranspose(ilink,jac->w2,y);CHKERRQ(ierr); 1486421e10b8SBarry Smith } 1487421e10b8SBarry Smith } else { 1488421e10b8SBarry Smith while (ilink->next) { /* get to last entry in linked list */ 1489421e10b8SBarry Smith ilink = ilink->next; 1490421e10b8SBarry Smith } 1491421e10b8SBarry Smith ierr = FieldSplitSplitSolveAddTranspose(ilink,x,y);CHKERRQ(ierr); 14922618eb8fSHong Zhang ierr = KSPGetConvergedReason(ilink->ksp,&reason);CHKERRQ(ierr); 14932618eb8fSHong Zhang if (reason == KSP_DIVERGED_PCSETUP_FAILED) { 14942618eb8fSHong Zhang pc->failedreason = PC_SUBPC_ERROR; 14952618eb8fSHong Zhang } 1496421e10b8SBarry Smith while (ilink->previous) { 1497421e10b8SBarry Smith ilink = ilink->previous; 14989989ab13SBarry Smith ierr = MatMultTranspose(pc->mat,y,jac->w1);CHKERRQ(ierr); 1499421e10b8SBarry Smith ierr = VecWAXPY(jac->w2,-1.0,jac->w1,x);CHKERRQ(ierr); 1500421e10b8SBarry Smith ierr = FieldSplitSplitSolveAddTranspose(ilink,jac->w2,y);CHKERRQ(ierr); 1501421e10b8SBarry Smith } 1502421e10b8SBarry Smith } 1503421e10b8SBarry Smith } 1504421e10b8SBarry Smith PetscFunctionReturn(0); 1505421e10b8SBarry Smith } 1506421e10b8SBarry Smith 1507574deadeSBarry Smith static PetscErrorCode PCReset_FieldSplit(PC pc) 15080971522cSBarry Smith { 15090971522cSBarry Smith PC_FieldSplit *jac = (PC_FieldSplit*)pc->data; 15100971522cSBarry Smith PetscErrorCode ierr; 15115a9f2f41SSatish Balay PC_FieldSplitLink ilink = jac->head,next; 15120971522cSBarry Smith 15130971522cSBarry Smith PetscFunctionBegin; 15145a9f2f41SSatish Balay while (ilink) { 1515f5f0d762SBarry Smith ierr = KSPDestroy(&ilink->ksp);CHKERRQ(ierr); 1516fcfd50ebSBarry Smith ierr = VecDestroy(&ilink->x);CHKERRQ(ierr); 1517fcfd50ebSBarry Smith ierr = VecDestroy(&ilink->y);CHKERRQ(ierr); 1518443836d0SMatthew G Knepley ierr = VecDestroy(&ilink->z);CHKERRQ(ierr); 1519fcfd50ebSBarry Smith ierr = VecScatterDestroy(&ilink->sctx);CHKERRQ(ierr); 1520fcfd50ebSBarry Smith ierr = ISDestroy(&ilink->is);CHKERRQ(ierr); 1521b5787286SJed Brown ierr = ISDestroy(&ilink->is_col);CHKERRQ(ierr); 1522f5f0d762SBarry Smith ierr = PetscFree(ilink->splitname);CHKERRQ(ierr); 1523f5f0d762SBarry Smith ierr = PetscFree(ilink->fields);CHKERRQ(ierr); 1524f5f0d762SBarry Smith ierr = PetscFree(ilink->fields_col);CHKERRQ(ierr); 15255a9f2f41SSatish Balay next = ilink->next; 1526f5f0d762SBarry Smith ierr = PetscFree(ilink);CHKERRQ(ierr); 15275a9f2f41SSatish Balay ilink = next; 15280971522cSBarry Smith } 1529f5f0d762SBarry Smith jac->head = NULL; 153005b42c5fSBarry Smith ierr = PetscFree2(jac->x,jac->y);CHKERRQ(ierr); 1531574deadeSBarry Smith if (jac->mat && jac->mat != jac->pmat) { 1532574deadeSBarry Smith ierr = MatDestroyMatrices(jac->nsplits,&jac->mat);CHKERRQ(ierr); 1533574deadeSBarry Smith } else if (jac->mat) { 15340298fd71SBarry Smith jac->mat = NULL; 1535574deadeSBarry Smith } 153697bbdb24SBarry Smith if (jac->pmat) {ierr = MatDestroyMatrices(jac->nsplits,&jac->pmat);CHKERRQ(ierr);} 153768dd23aaSBarry Smith if (jac->Afield) {ierr = MatDestroyMatrices(jac->nsplits,&jac->Afield);CHKERRQ(ierr);} 1538f5f0d762SBarry Smith jac->nsplits = 0; 15396bf464f9SBarry Smith ierr = VecDestroy(&jac->w1);CHKERRQ(ierr); 15406bf464f9SBarry Smith ierr = VecDestroy(&jac->w2);CHKERRQ(ierr); 15416bf464f9SBarry Smith ierr = MatDestroy(&jac->schur);CHKERRQ(ierr); 1542a7476a74SDmitry Karpeev ierr = MatDestroy(&jac->schurp);CHKERRQ(ierr); 15436bf464f9SBarry Smith ierr = MatDestroy(&jac->schur_user);CHKERRQ(ierr); 15446bf464f9SBarry Smith ierr = KSPDestroy(&jac->kspschur);CHKERRQ(ierr); 1545d78dad28SBarry Smith ierr = KSPDestroy(&jac->kspupper);CHKERRQ(ierr); 15466bf464f9SBarry Smith ierr = MatDestroy(&jac->B);CHKERRQ(ierr); 15476bf464f9SBarry Smith ierr = MatDestroy(&jac->C);CHKERRQ(ierr); 1548a51937d4SCarola Kruse ierr = MatDestroy(&jac->H);CHKERRQ(ierr); 15496dbb499eSCian Wilson jac->isrestrict = PETSC_FALSE; 1550574deadeSBarry Smith PetscFunctionReturn(0); 1551574deadeSBarry Smith } 1552574deadeSBarry Smith 1553574deadeSBarry Smith static PetscErrorCode PCDestroy_FieldSplit(PC pc) 1554574deadeSBarry Smith { 1555574deadeSBarry Smith PetscErrorCode ierr; 1556574deadeSBarry Smith 1557574deadeSBarry Smith PetscFunctionBegin; 1558574deadeSBarry Smith ierr = PCReset_FieldSplit(pc);CHKERRQ(ierr); 1559c31cb41cSBarry Smith ierr = PetscFree(pc->data);CHKERRQ(ierr); 1560285fb4e2SStefano Zampini ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSchurGetSubKSP_C",NULL);CHKERRQ(ierr); 1561bdf89e91SBarry Smith ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitGetSubKSP_C",NULL);CHKERRQ(ierr); 1562bdf89e91SBarry Smith ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetFields_C",NULL);CHKERRQ(ierr); 1563bdf89e91SBarry Smith ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetIS_C",NULL);CHKERRQ(ierr); 1564bdf89e91SBarry Smith ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetType_C",NULL);CHKERRQ(ierr); 1565bdf89e91SBarry Smith ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetBlockSize_C",NULL);CHKERRQ(ierr); 156629f8a81cSJed Brown ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetSchurPre_C",NULL);CHKERRQ(ierr); 156737a82bf0SJed Brown ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitGetSchurPre_C",NULL);CHKERRQ(ierr); 1568bdf89e91SBarry Smith ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetSchurFactType_C",NULL);CHKERRQ(ierr); 15696dbb499eSCian Wilson ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitRestrictIS_C",NULL);CHKERRQ(ierr); 15700971522cSBarry Smith PetscFunctionReturn(0); 15710971522cSBarry Smith } 15720971522cSBarry Smith 15734416b707SBarry Smith static PetscErrorCode PCSetFromOptions_FieldSplit(PetscOptionItems *PetscOptionsObject,PC pc) 15740971522cSBarry Smith { 15751b9fc7fcSBarry Smith PetscErrorCode ierr; 15766c924f48SJed Brown PetscInt bs; 15777b752e3dSPatrick Sanan PetscBool flg; 15789dcbbd2bSBarry Smith PC_FieldSplit *jac = (PC_FieldSplit*)pc->data; 15793b224e63SBarry Smith PCCompositeType ctype; 15801b9fc7fcSBarry Smith 15810971522cSBarry Smith PetscFunctionBegin; 1582e55864a3SBarry Smith ierr = PetscOptionsHead(PetscOptionsObject,"FieldSplit options");CHKERRQ(ierr); 15834ab8060aSDmitry Karpeev ierr = PetscOptionsBool("-pc_fieldsplit_dm_splits","Whether to use DMCreateFieldDecomposition() for splits","PCFieldSplitSetDMSplits",jac->dm_splits,&jac->dm_splits,NULL);CHKERRQ(ierr); 158451f519a2SBarry Smith ierr = PetscOptionsInt("-pc_fieldsplit_block_size","Blocksize that defines number of fields","PCFieldSplitSetBlockSize",jac->bs,&bs,&flg);CHKERRQ(ierr); 158551f519a2SBarry Smith if (flg) { 158651f519a2SBarry Smith ierr = PCFieldSplitSetBlockSize(pc,bs);CHKERRQ(ierr); 158751f519a2SBarry Smith } 15882686e3e9SMatthew G. Knepley jac->diag_use_amat = pc->useAmat; 15892686e3e9SMatthew 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); 15902686e3e9SMatthew G. Knepley jac->offdiag_use_amat = pc->useAmat; 15912686e3e9SMatthew 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); 15927b752e3dSPatrick 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); 15937b752e3dSPatrick Sanan ierr = PCFieldSplitSetDetectSaddlePoint(pc,jac->detect);CHKERRQ(ierr); /* Sets split type and Schur PC type */ 15943b224e63SBarry Smith ierr = PetscOptionsEnum("-pc_fieldsplit_type","Type of composition","PCFieldSplitSetType",PCCompositeTypes,(PetscEnum)jac->type,(PetscEnum*)&ctype,&flg);CHKERRQ(ierr); 15953b224e63SBarry Smith if (flg) { 15963b224e63SBarry Smith ierr = PCFieldSplitSetType(pc,ctype);CHKERRQ(ierr); 15973b224e63SBarry Smith } 1598c30613efSMatthew Knepley /* Only setup fields once */ 1599c30613efSMatthew Knepley if ((jac->bs > 0) && (jac->nsplits == 0)) { 1600d32f9abdSBarry Smith /* only allow user to set fields from command line if bs is already known. 1601d32f9abdSBarry Smith otherwise user can set them in PCFieldSplitSetDefaults() */ 16026c924f48SJed Brown ierr = PCFieldSplitSetRuntimeSplits_Private(pc);CHKERRQ(ierr); 16036c924f48SJed Brown if (jac->splitdefined) {ierr = PetscInfo(pc,"Splits defined using the options database\n");CHKERRQ(ierr);} 1604d32f9abdSBarry Smith } 1605c5d2311dSJed Brown if (jac->type == PC_COMPOSITE_SCHUR) { 1606c5929fdfSBarry Smith ierr = PetscOptionsGetEnum(((PetscObject)pc)->options,((PetscObject)pc)->prefix,"-pc_fieldsplit_schur_factorization_type",PCFieldSplitSchurFactTypes,(PetscEnum*)&jac->schurfactorization,&flg);CHKERRQ(ierr); 1607c9c6ffaaSJed Brown if (flg) {ierr = PetscInfo(pc,"Deprecated use of -pc_fieldsplit_schur_factorization_type\n");CHKERRQ(ierr);} 16080298fd71SBarry 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); 160929f8a81cSJed 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); 1610c096484dSStefano Zampini ierr = PetscOptionsScalar("-pc_fieldsplit_schur_scale","Scale Schur complement","PCFieldSplitSetSchurScale",jac->schurscale,&jac->schurscale,NULL);CHKERRQ(ierr); 1611a51937d4SCarola Kruse } else if (jac->type == PC_COMPOSITE_GKB) { 1612a51937d4SCarola Kruse ierr = PetscOptionsReal("-pc_fieldsplit_gkb_tol","The tolerance for the lower bound stopping criterion","PCFieldSplitGKBTol",jac->gkbtol,&jac->gkbtol,NULL);CHKERRQ(ierr); 1613a51937d4SCarola Kruse ierr = PetscOptionsInt("-pc_fieldsplit_gkb_delay","The delay value for lower bound criterion","PCFieldSplitGKBDelay",jac->gkbdelay,&jac->gkbdelay,NULL);CHKERRQ(ierr); 1614a51937d4SCarola Kruse ierr = PetscOptionsReal("-pc_fieldsplit_gkb_nu","Parameter in augmented Lagrangian approach","PCFieldSplitGKBNu",jac->gkbnu,&jac->gkbnu,NULL);CHKERRQ(ierr); 1615a51937d4SCarola Kruse ierr = PetscOptionsInt("-pc_fieldsplit_gkb_maxit","Maximum allowed number of iterations","PCFieldSplitGKBMaxit",jac->gkbmaxit,&jac->gkbmaxit,NULL);CHKERRQ(ierr); 1616c5d2311dSJed Brown } 16171b9fc7fcSBarry Smith ierr = PetscOptionsTail();CHKERRQ(ierr); 16180971522cSBarry Smith PetscFunctionReturn(0); 16190971522cSBarry Smith } 16200971522cSBarry Smith 16210971522cSBarry Smith /*------------------------------------------------------------------------------------*/ 16220971522cSBarry Smith 16231e6b0712SBarry Smith static PetscErrorCode PCFieldSplitSetFields_FieldSplit(PC pc,const char splitname[],PetscInt n,const PetscInt *fields,const PetscInt *fields_col) 16240971522cSBarry Smith { 162597bbdb24SBarry Smith PC_FieldSplit *jac = (PC_FieldSplit*)pc->data; 16260971522cSBarry Smith PetscErrorCode ierr; 16275a9f2f41SSatish Balay PC_FieldSplitLink ilink,next = jac->head; 162869a612a9SBarry Smith char prefix[128]; 16295d4c12cdSJungho Lee PetscInt i; 16300971522cSBarry Smith 16310971522cSBarry Smith PetscFunctionBegin; 16326c924f48SJed Brown if (jac->splitdefined) { 16336c924f48SJed Brown ierr = PetscInfo1(pc,"Ignoring new split \"%s\" because the splits have already been defined\n",splitname);CHKERRQ(ierr); 16346c924f48SJed Brown PetscFunctionReturn(0); 16356c924f48SJed Brown } 163651f519a2SBarry Smith for (i=0; i<n; i++) { 1637e32f2f54SBarry 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); 1638e32f2f54SBarry Smith if (fields[i] < 0) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Negative field %D requested",fields[i]); 163951f519a2SBarry Smith } 1640b00a9115SJed Brown ierr = PetscNew(&ilink);CHKERRQ(ierr); 1641a04f6461SBarry Smith if (splitname) { 1642db4c96c1SJed Brown ierr = PetscStrallocpy(splitname,&ilink->splitname);CHKERRQ(ierr); 1643a04f6461SBarry Smith } else { 1644785e854fSJed Brown ierr = PetscMalloc1(3,&ilink->splitname);CHKERRQ(ierr); 1645a04f6461SBarry Smith ierr = PetscSNPrintf(ilink->splitname,2,"%s",jac->nsplits);CHKERRQ(ierr); 1646a04f6461SBarry Smith } 16479df09d43SBarry 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 */ 1648785e854fSJed Brown ierr = PetscMalloc1(n,&ilink->fields);CHKERRQ(ierr); 16495a9f2f41SSatish Balay ierr = PetscMemcpy(ilink->fields,fields,n*sizeof(PetscInt));CHKERRQ(ierr); 1650785e854fSJed Brown ierr = PetscMalloc1(n,&ilink->fields_col);CHKERRQ(ierr); 16515d4c12cdSJungho Lee ierr = PetscMemcpy(ilink->fields_col,fields_col,n*sizeof(PetscInt));CHKERRQ(ierr); 16522fa5cd67SKarl Rupp 16535a9f2f41SSatish Balay ilink->nfields = n; 16540298fd71SBarry Smith ilink->next = NULL; 1655ce94432eSBarry Smith ierr = KSPCreate(PetscObjectComm((PetscObject)pc),&ilink->ksp);CHKERRQ(ierr); 1656422a814eSBarry Smith ierr = KSPSetErrorIfNotConverged(ilink->ksp,pc->erroriffailure);CHKERRQ(ierr); 165720252d06SBarry Smith ierr = PetscObjectIncrementTabLevel((PetscObject)ilink->ksp,(PetscObject)pc,1);CHKERRQ(ierr); 16585a9f2f41SSatish Balay ierr = KSPSetType(ilink->ksp,KSPPREONLY);CHKERRQ(ierr); 16599005cf84SBarry Smith ierr = PetscLogObjectParent((PetscObject)pc,(PetscObject)ilink->ksp);CHKERRQ(ierr); 166069a612a9SBarry Smith 16618caf3d72SBarry Smith ierr = PetscSNPrintf(prefix,sizeof(prefix),"%sfieldsplit_%s_",((PetscObject)pc)->prefix ? ((PetscObject)pc)->prefix : "",ilink->splitname);CHKERRQ(ierr); 16625a9f2f41SSatish Balay ierr = KSPSetOptionsPrefix(ilink->ksp,prefix);CHKERRQ(ierr); 16630971522cSBarry Smith 16640971522cSBarry Smith if (!next) { 16655a9f2f41SSatish Balay jac->head = ilink; 16660298fd71SBarry Smith ilink->previous = NULL; 16670971522cSBarry Smith } else { 16680971522cSBarry Smith while (next->next) { 16690971522cSBarry Smith next = next->next; 16700971522cSBarry Smith } 16715a9f2f41SSatish Balay next->next = ilink; 167251f519a2SBarry Smith ilink->previous = next; 16730971522cSBarry Smith } 16740971522cSBarry Smith jac->nsplits++; 16750971522cSBarry Smith PetscFunctionReturn(0); 16760971522cSBarry Smith } 16770971522cSBarry Smith 1678285fb4e2SStefano Zampini static PetscErrorCode PCFieldSplitSchurGetSubKSP_FieldSplit(PC pc,PetscInt *n,KSP **subksp) 1679285fb4e2SStefano Zampini { 1680285fb4e2SStefano Zampini PC_FieldSplit *jac = (PC_FieldSplit*)pc->data; 1681285fb4e2SStefano Zampini PetscErrorCode ierr; 1682285fb4e2SStefano Zampini 1683285fb4e2SStefano Zampini PetscFunctionBegin; 1684285fb4e2SStefano Zampini *subksp = NULL; 1685285fb4e2SStefano Zampini if (n) *n = 0; 1686285fb4e2SStefano Zampini if (jac->type == PC_COMPOSITE_SCHUR) { 1687285fb4e2SStefano Zampini PetscInt nn; 1688285fb4e2SStefano Zampini 1689285fb4e2SStefano Zampini if (!jac->schur) SETERRQ(PetscObjectComm((PetscObject)pc),PETSC_ERR_ARG_WRONGSTATE,"Must call KSPSetUp() or PCSetUp() before calling PCFieldSplitSchurGetSubKSP()"); 1690285fb4e2SStefano Zampini if (jac->nsplits != 2) SETERRQ1(PetscObjectComm((PetscObject)pc),PETSC_ERR_PLIB,"Unexpected number of splits %D != 2",jac->nsplits); 1691285fb4e2SStefano Zampini nn = jac->nsplits + (jac->kspupper != jac->head->ksp ? 1 : 0); 1692285fb4e2SStefano Zampini ierr = PetscMalloc1(nn,subksp);CHKERRQ(ierr); 1693285fb4e2SStefano Zampini (*subksp)[0] = jac->head->ksp; 1694285fb4e2SStefano Zampini (*subksp)[1] = jac->kspschur; 1695285fb4e2SStefano Zampini if (jac->kspupper != jac->head->ksp) (*subksp)[2] = jac->kspupper; 1696285fb4e2SStefano Zampini if (n) *n = nn; 1697285fb4e2SStefano Zampini } 1698285fb4e2SStefano Zampini PetscFunctionReturn(0); 1699285fb4e2SStefano Zampini } 1700285fb4e2SStefano Zampini 17011e6b0712SBarry Smith static PetscErrorCode PCFieldSplitGetSubKSP_FieldSplit_Schur(PC pc,PetscInt *n,KSP **subksp) 1702e69d4d44SBarry Smith { 1703e69d4d44SBarry Smith PC_FieldSplit *jac = (PC_FieldSplit*)pc->data; 1704e69d4d44SBarry Smith PetscErrorCode ierr; 1705e69d4d44SBarry Smith 1706e69d4d44SBarry Smith PetscFunctionBegin; 170734a3b412SBarry Smith if (!jac->schur) SETERRQ(PetscObjectComm((PetscObject)pc),PETSC_ERR_ARG_WRONGSTATE,"Must call KSPSetUp() or PCSetUp() before calling PCFieldSplitGetSubKSP()"); 1708785e854fSJed Brown ierr = PetscMalloc1(jac->nsplits,subksp);CHKERRQ(ierr); 1709e69d4d44SBarry Smith ierr = MatSchurComplementGetKSP(jac->schur,*subksp);CHKERRQ(ierr); 17102fa5cd67SKarl Rupp 1711e69d4d44SBarry Smith (*subksp)[1] = jac->kspschur; 171213e0d083SBarry Smith if (n) *n = jac->nsplits; 1713e69d4d44SBarry Smith PetscFunctionReturn(0); 1714e69d4d44SBarry Smith } 17150971522cSBarry Smith 17161e6b0712SBarry Smith static PetscErrorCode PCFieldSplitGetSubKSP_FieldSplit(PC pc,PetscInt *n,KSP **subksp) 17170971522cSBarry Smith { 17180971522cSBarry Smith PC_FieldSplit *jac = (PC_FieldSplit*)pc->data; 17190971522cSBarry Smith PetscErrorCode ierr; 17200971522cSBarry Smith PetscInt cnt = 0; 17215a9f2f41SSatish Balay PC_FieldSplitLink ilink = jac->head; 17220971522cSBarry Smith 17230971522cSBarry Smith PetscFunctionBegin; 1724785e854fSJed Brown ierr = PetscMalloc1(jac->nsplits,subksp);CHKERRQ(ierr); 17255a9f2f41SSatish Balay while (ilink) { 17265a9f2f41SSatish Balay (*subksp)[cnt++] = ilink->ksp; 17275a9f2f41SSatish Balay ilink = ilink->next; 17280971522cSBarry Smith } 17295d480477SMatthew 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); 173013e0d083SBarry Smith if (n) *n = jac->nsplits; 17310971522cSBarry Smith PetscFunctionReturn(0); 17320971522cSBarry Smith } 17330971522cSBarry Smith 17346dbb499eSCian Wilson /*@C 17356dbb499eSCian Wilson PCFieldSplitRestrictIS - Restricts the fieldsplit ISs to be within a given IS. 17366dbb499eSCian Wilson 17376dbb499eSCian Wilson Input Parameters: 17386dbb499eSCian Wilson + pc - the preconditioner context 17396dbb499eSCian Wilson + is - the index set that defines the indices to which the fieldsplit is to be restricted 17406dbb499eSCian Wilson 17416dbb499eSCian Wilson Level: advanced 17426dbb499eSCian Wilson 17436dbb499eSCian Wilson @*/ 17446dbb499eSCian Wilson PetscErrorCode PCFieldSplitRestrictIS(PC pc,IS isy) 17456dbb499eSCian Wilson { 17466dbb499eSCian Wilson PetscErrorCode ierr; 17476dbb499eSCian Wilson 17486dbb499eSCian Wilson PetscFunctionBegin; 17496dbb499eSCian Wilson PetscValidHeaderSpecific(pc,PC_CLASSID,1); 17506dbb499eSCian Wilson PetscValidHeaderSpecific(isy,IS_CLASSID,2); 17510246f55cSBarry Smith ierr = PetscTryMethod(pc,"PCFieldSplitRestrictIS_C",(PC,IS),(pc,isy));CHKERRQ(ierr); 17526dbb499eSCian Wilson PetscFunctionReturn(0); 17536dbb499eSCian Wilson } 17546dbb499eSCian Wilson 17556dbb499eSCian Wilson 17566dbb499eSCian Wilson static PetscErrorCode PCFieldSplitRestrictIS_FieldSplit(PC pc, IS isy) 17576dbb499eSCian Wilson { 17586dbb499eSCian Wilson PC_FieldSplit *jac = (PC_FieldSplit*)pc->data; 17596dbb499eSCian Wilson PetscErrorCode ierr; 17606dbb499eSCian Wilson PC_FieldSplitLink ilink = jac->head, next; 17616dbb499eSCian Wilson PetscInt localsize,size,sizez,i; 17626dbb499eSCian Wilson const PetscInt *ind, *indz; 17636dbb499eSCian Wilson PetscInt *indc, *indcz; 17646dbb499eSCian Wilson PetscBool flg; 17656dbb499eSCian Wilson 17666dbb499eSCian Wilson PetscFunctionBegin; 17676dbb499eSCian Wilson ierr = ISGetLocalSize(isy,&localsize);CHKERRQ(ierr); 17686dbb499eSCian Wilson ierr = MPI_Scan(&localsize,&size,1,MPIU_INT,MPI_SUM,PetscObjectComm((PetscObject)isy));CHKERRQ(ierr); 17696dbb499eSCian Wilson size -= localsize; 17706dbb499eSCian Wilson while(ilink) { 17716dbb499eSCian Wilson IS isrl,isr; 17721c7cfba8SBarry Smith PC subpc; 17736dbb499eSCian Wilson ierr = ISEmbed(ilink->is, isy, PETSC_TRUE, &isrl);CHKERRQ(ierr); 17746dbb499eSCian Wilson ierr = ISGetLocalSize(isrl,&localsize);CHKERRQ(ierr); 17756dbb499eSCian Wilson ierr = PetscMalloc1(localsize,&indc);CHKERRQ(ierr); 17766dbb499eSCian Wilson ierr = ISGetIndices(isrl,&ind);CHKERRQ(ierr); 17776dbb499eSCian Wilson ierr = PetscMemcpy(indc,ind,localsize*sizeof(PetscInt));CHKERRQ(ierr); 17786dbb499eSCian Wilson ierr = ISRestoreIndices(isrl,&ind);CHKERRQ(ierr); 17796dbb499eSCian Wilson ierr = ISDestroy(&isrl);CHKERRQ(ierr); 17806dbb499eSCian Wilson for (i=0; i<localsize; i++) *(indc+i) += size; 17816dbb499eSCian Wilson ierr = ISCreateGeneral(PetscObjectComm((PetscObject)isy),localsize,indc,PETSC_OWN_POINTER,&isr);CHKERRQ(ierr); 17826dbb499eSCian Wilson ierr = PetscObjectReference((PetscObject)isr);CHKERRQ(ierr); 17836dbb499eSCian Wilson ierr = ISDestroy(&ilink->is);CHKERRQ(ierr); 17846dbb499eSCian Wilson ilink->is = isr; 17856dbb499eSCian Wilson ierr = PetscObjectReference((PetscObject)isr);CHKERRQ(ierr); 17866dbb499eSCian Wilson ierr = ISDestroy(&ilink->is_col);CHKERRQ(ierr); 17876dbb499eSCian Wilson ilink->is_col = isr; 17886dbb499eSCian Wilson ierr = ISDestroy(&isr);CHKERRQ(ierr); 17896dbb499eSCian Wilson ierr = KSPGetPC(ilink->ksp, &subpc);CHKERRQ(ierr); 17906dbb499eSCian Wilson ierr = PetscObjectTypeCompare((PetscObject)subpc,PCFIELDSPLIT,&flg);CHKERRQ(ierr); 17916dbb499eSCian Wilson if(flg) { 17926dbb499eSCian Wilson IS iszl,isz; 17936dbb499eSCian Wilson MPI_Comm comm; 17946dbb499eSCian Wilson ierr = ISGetLocalSize(ilink->is,&localsize);CHKERRQ(ierr); 17956dbb499eSCian Wilson comm = PetscObjectComm((PetscObject)ilink->is); 17966dbb499eSCian Wilson ierr = ISEmbed(isy, ilink->is, PETSC_TRUE, &iszl);CHKERRQ(ierr); 17976dbb499eSCian Wilson ierr = MPI_Scan(&localsize,&sizez,1,MPIU_INT,MPI_SUM,comm);CHKERRQ(ierr); 17986dbb499eSCian Wilson sizez -= localsize; 17996dbb499eSCian Wilson ierr = ISGetLocalSize(iszl,&localsize);CHKERRQ(ierr); 18006dbb499eSCian Wilson ierr = PetscMalloc1(localsize,&indcz);CHKERRQ(ierr); 18016dbb499eSCian Wilson ierr = ISGetIndices(iszl,&indz);CHKERRQ(ierr); 18026dbb499eSCian Wilson ierr = PetscMemcpy(indcz,indz,localsize*sizeof(PetscInt));CHKERRQ(ierr); 18036dbb499eSCian Wilson ierr = ISRestoreIndices(iszl,&indz);CHKERRQ(ierr); 18046dbb499eSCian Wilson ierr = ISDestroy(&iszl);CHKERRQ(ierr); 18056dbb499eSCian Wilson for (i=0; i<localsize; i++) *(indcz+i) += sizez; 18066dbb499eSCian Wilson ierr = ISCreateGeneral(comm,localsize,indcz,PETSC_OWN_POINTER,&isz);CHKERRQ(ierr); 18076dbb499eSCian Wilson ierr = PCFieldSplitRestrictIS(subpc,isz);CHKERRQ(ierr); 18086dbb499eSCian Wilson ierr = ISDestroy(&isz);CHKERRQ(ierr); 18096dbb499eSCian Wilson } 18106dbb499eSCian Wilson next = ilink->next; 18116dbb499eSCian Wilson ilink = next; 18126dbb499eSCian Wilson } 18136dbb499eSCian Wilson jac->isrestrict = PETSC_TRUE; 18146dbb499eSCian Wilson PetscFunctionReturn(0); 18156dbb499eSCian Wilson } 18166dbb499eSCian Wilson 18171e6b0712SBarry Smith static PetscErrorCode PCFieldSplitSetIS_FieldSplit(PC pc,const char splitname[],IS is) 1818704ba839SBarry Smith { 1819704ba839SBarry Smith PC_FieldSplit *jac = (PC_FieldSplit*)pc->data; 1820704ba839SBarry Smith PetscErrorCode ierr; 1821704ba839SBarry Smith PC_FieldSplitLink ilink, next = jac->head; 1822704ba839SBarry Smith char prefix[128]; 1823704ba839SBarry Smith 1824704ba839SBarry Smith PetscFunctionBegin; 18256c924f48SJed Brown if (jac->splitdefined) { 18266c924f48SJed Brown ierr = PetscInfo1(pc,"Ignoring new split \"%s\" because the splits have already been defined\n",splitname);CHKERRQ(ierr); 18276c924f48SJed Brown PetscFunctionReturn(0); 18286c924f48SJed Brown } 1829b00a9115SJed Brown ierr = PetscNew(&ilink);CHKERRQ(ierr); 1830a04f6461SBarry Smith if (splitname) { 1831db4c96c1SJed Brown ierr = PetscStrallocpy(splitname,&ilink->splitname);CHKERRQ(ierr); 1832a04f6461SBarry Smith } else { 1833785e854fSJed Brown ierr = PetscMalloc1(8,&ilink->splitname);CHKERRQ(ierr); 1834b5787286SJed Brown ierr = PetscSNPrintf(ilink->splitname,7,"%D",jac->nsplits);CHKERRQ(ierr); 1835a04f6461SBarry Smith } 18369df09d43SBarry 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 */ 18371ab39975SBarry Smith ierr = PetscObjectReference((PetscObject)is);CHKERRQ(ierr); 1838b5787286SJed Brown ierr = ISDestroy(&ilink->is);CHKERRQ(ierr); 1839b5787286SJed Brown ilink->is = is; 1840b5787286SJed Brown ierr = PetscObjectReference((PetscObject)is);CHKERRQ(ierr); 1841b5787286SJed Brown ierr = ISDestroy(&ilink->is_col);CHKERRQ(ierr); 1842b5787286SJed Brown ilink->is_col = is; 18430298fd71SBarry Smith ilink->next = NULL; 1844ce94432eSBarry Smith ierr = KSPCreate(PetscObjectComm((PetscObject)pc),&ilink->ksp);CHKERRQ(ierr); 1845422a814eSBarry Smith ierr = KSPSetErrorIfNotConverged(ilink->ksp,pc->erroriffailure);CHKERRQ(ierr); 184620252d06SBarry Smith ierr = PetscObjectIncrementTabLevel((PetscObject)ilink->ksp,(PetscObject)pc,1);CHKERRQ(ierr); 1847704ba839SBarry Smith ierr = KSPSetType(ilink->ksp,KSPPREONLY);CHKERRQ(ierr); 18489005cf84SBarry Smith ierr = PetscLogObjectParent((PetscObject)pc,(PetscObject)ilink->ksp);CHKERRQ(ierr); 1849704ba839SBarry Smith 18508caf3d72SBarry Smith ierr = PetscSNPrintf(prefix,sizeof(prefix),"%sfieldsplit_%s_",((PetscObject)pc)->prefix ? ((PetscObject)pc)->prefix : "",ilink->splitname);CHKERRQ(ierr); 1851704ba839SBarry Smith ierr = KSPSetOptionsPrefix(ilink->ksp,prefix);CHKERRQ(ierr); 1852704ba839SBarry Smith 1853704ba839SBarry Smith if (!next) { 1854704ba839SBarry Smith jac->head = ilink; 18550298fd71SBarry Smith ilink->previous = NULL; 1856704ba839SBarry Smith } else { 1857704ba839SBarry Smith while (next->next) { 1858704ba839SBarry Smith next = next->next; 1859704ba839SBarry Smith } 1860704ba839SBarry Smith next->next = ilink; 1861704ba839SBarry Smith ilink->previous = next; 1862704ba839SBarry Smith } 1863704ba839SBarry Smith jac->nsplits++; 1864704ba839SBarry Smith PetscFunctionReturn(0); 1865704ba839SBarry Smith } 1866704ba839SBarry Smith 186794ef8ddeSSatish Balay /*@C 18680971522cSBarry Smith PCFieldSplitSetFields - Sets the fields for one particular split in the field split preconditioner 18690971522cSBarry Smith 1870ad4df100SBarry Smith Logically Collective on PC 18710971522cSBarry Smith 18720971522cSBarry Smith Input Parameters: 18730971522cSBarry Smith + pc - the preconditioner context 18740298fd71SBarry Smith . splitname - name of this split, if NULL the number of the split is used 18750971522cSBarry Smith . n - the number of fields in this split 1876db4c96c1SJed Brown - fields - the fields in this split 18770971522cSBarry Smith 18780971522cSBarry Smith Level: intermediate 18790971522cSBarry Smith 188095452b02SPatrick Sanan Notes: 188195452b02SPatrick Sanan Use PCFieldSplitSetIS() to set a completely general set of indices as a field. 1882d32f9abdSBarry Smith 18837287d2a3SDmitry Karpeev The PCFieldSplitSetFields() is for defining fields as strided blocks. For example, if the block 1884d32f9abdSBarry 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 1885d32f9abdSBarry Smith 0xx3xx6xx9xx12 ... x1xx4xx7xx ... xx2xx5xx8xx.. 01x34x67x... 0x1x3x5x7.. x12x45x78x.... 1886d32f9abdSBarry Smith where the numbered entries indicate what is in the field. 1887d32f9abdSBarry Smith 1888db4c96c1SJed Brown This function is called once per split (it creates a new split each time). Solve options 1889db4c96c1SJed Brown for this split will be available under the prefix -fieldsplit_SPLITNAME_. 1890db4c96c1SJed Brown 18915d4c12cdSJungho Lee Developer Note: This routine does not actually create the IS representing the split, that is delayed 18925d4c12cdSJungho Lee until PCSetUp_FieldSplit(), because information about the vector/matrix layouts may not be 18935d4c12cdSJungho Lee available when this routine is called. 18945d4c12cdSJungho Lee 1895d32f9abdSBarry Smith .seealso: PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitSetBlockSize(), PCFieldSplitSetIS() 18960971522cSBarry Smith 18970971522cSBarry Smith @*/ 18985d4c12cdSJungho Lee PetscErrorCode PCFieldSplitSetFields(PC pc,const char splitname[],PetscInt n,const PetscInt *fields,const PetscInt *fields_col) 18990971522cSBarry Smith { 19004ac538c5SBarry Smith PetscErrorCode ierr; 19010971522cSBarry Smith 19020971522cSBarry Smith PetscFunctionBegin; 19030700a824SBarry Smith PetscValidHeaderSpecific(pc,PC_CLASSID,1); 1904db4c96c1SJed Brown PetscValidCharPointer(splitname,2); 1905ce94432eSBarry Smith if (n < 1) SETERRQ2(PetscObjectComm((PetscObject)pc),PETSC_ERR_ARG_OUTOFRANGE,"Provided number of fields %D in split \"%s\" not positive",n,splitname); 1906db4c96c1SJed Brown PetscValidIntPointer(fields,3); 19070246f55cSBarry Smith ierr = PetscTryMethod(pc,"PCFieldSplitSetFields_C",(PC,const char[],PetscInt,const PetscInt*,const PetscInt*),(pc,splitname,n,fields,fields_col));CHKERRQ(ierr); 19080971522cSBarry Smith PetscFunctionReturn(0); 19090971522cSBarry Smith } 19100971522cSBarry Smith 1911c84da90fSDmitry Karpeev /*@ 1912c84da90fSDmitry Karpeev PCFieldSplitSetDiagUseAmat - set flag indicating whether to extract diagonal blocks from Amat (rather than Pmat) 1913c84da90fSDmitry Karpeev 1914c84da90fSDmitry Karpeev Logically Collective on PC 1915c84da90fSDmitry Karpeev 1916c84da90fSDmitry Karpeev Input Parameters: 1917c84da90fSDmitry Karpeev + pc - the preconditioner object 1918c84da90fSDmitry Karpeev - flg - boolean flag indicating whether or not to use Amat to extract the diagonal blocks from 1919c84da90fSDmitry Karpeev 19209506b623SDmitry Karpeev Options Database: 19219506b623SDmitry Karpeev . -pc_fieldsplit_diag_use_amat 1922c84da90fSDmitry Karpeev 1923c84da90fSDmitry Karpeev Level: intermediate 1924c84da90fSDmitry Karpeev 1925c84da90fSDmitry Karpeev .seealso: PCFieldSplitGetDiagUseAmat(), PCFieldSplitSetOffDiagUseAmat(), PCFIELDSPLIT 1926c84da90fSDmitry Karpeev 1927c84da90fSDmitry Karpeev @*/ 1928c84da90fSDmitry Karpeev PetscErrorCode PCFieldSplitSetDiagUseAmat(PC pc,PetscBool flg) 1929c84da90fSDmitry Karpeev { 1930c84da90fSDmitry Karpeev PC_FieldSplit *jac = (PC_FieldSplit*)pc->data; 1931c84da90fSDmitry Karpeev PetscBool isfs; 1932c84da90fSDmitry Karpeev PetscErrorCode ierr; 1933c84da90fSDmitry Karpeev 1934c84da90fSDmitry Karpeev PetscFunctionBegin; 1935c84da90fSDmitry Karpeev PetscValidHeaderSpecific(pc,PC_CLASSID,1); 1936c84da90fSDmitry Karpeev ierr = PetscObjectTypeCompare((PetscObject)pc,PCFIELDSPLIT,&isfs);CHKERRQ(ierr); 1937c84da90fSDmitry Karpeev if (!isfs) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"PC not of type %s",PCFIELDSPLIT); 1938c84da90fSDmitry Karpeev jac->diag_use_amat = flg; 1939c84da90fSDmitry Karpeev PetscFunctionReturn(0); 1940c84da90fSDmitry Karpeev } 1941c84da90fSDmitry Karpeev 1942c84da90fSDmitry Karpeev /*@ 1943c84da90fSDmitry Karpeev PCFieldSplitGetDiagUseAmat - get the flag indicating whether to extract diagonal blocks from Amat (rather than Pmat) 1944c84da90fSDmitry Karpeev 1945c84da90fSDmitry Karpeev Logically Collective on PC 1946c84da90fSDmitry Karpeev 1947c84da90fSDmitry Karpeev Input Parameters: 1948c84da90fSDmitry Karpeev . pc - the preconditioner object 1949c84da90fSDmitry Karpeev 1950c84da90fSDmitry Karpeev Output Parameters: 1951c84da90fSDmitry Karpeev . flg - boolean flag indicating whether or not to use Amat to extract the diagonal blocks from 1952c84da90fSDmitry Karpeev 1953c84da90fSDmitry Karpeev 1954c84da90fSDmitry Karpeev Level: intermediate 1955c84da90fSDmitry Karpeev 1956c84da90fSDmitry Karpeev .seealso: PCFieldSplitSetDiagUseAmat(), PCFieldSplitGetOffDiagUseAmat(), PCFIELDSPLIT 1957c84da90fSDmitry Karpeev 1958c84da90fSDmitry Karpeev @*/ 1959c84da90fSDmitry Karpeev PetscErrorCode PCFieldSplitGetDiagUseAmat(PC pc,PetscBool *flg) 1960c84da90fSDmitry Karpeev { 1961c84da90fSDmitry Karpeev PC_FieldSplit *jac = (PC_FieldSplit*)pc->data; 1962c84da90fSDmitry Karpeev PetscBool isfs; 1963c84da90fSDmitry Karpeev PetscErrorCode ierr; 1964c84da90fSDmitry Karpeev 1965c84da90fSDmitry Karpeev PetscFunctionBegin; 1966c84da90fSDmitry Karpeev PetscValidHeaderSpecific(pc,PC_CLASSID,1); 1967c84da90fSDmitry Karpeev PetscValidPointer(flg,2); 1968c84da90fSDmitry Karpeev ierr = PetscObjectTypeCompare((PetscObject)pc,PCFIELDSPLIT,&isfs);CHKERRQ(ierr); 1969c84da90fSDmitry Karpeev if (!isfs) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"PC not of type %s",PCFIELDSPLIT); 1970c84da90fSDmitry Karpeev *flg = jac->diag_use_amat; 1971c84da90fSDmitry Karpeev PetscFunctionReturn(0); 1972c84da90fSDmitry Karpeev } 1973c84da90fSDmitry Karpeev 1974c84da90fSDmitry Karpeev /*@ 1975c84da90fSDmitry Karpeev PCFieldSplitSetOffDiagUseAmat - set flag indicating whether to extract off-diagonal blocks from Amat (rather than Pmat) 1976c84da90fSDmitry Karpeev 1977c84da90fSDmitry Karpeev Logically Collective on PC 1978c84da90fSDmitry Karpeev 1979c84da90fSDmitry Karpeev Input Parameters: 1980c84da90fSDmitry Karpeev + pc - the preconditioner object 1981c84da90fSDmitry Karpeev - flg - boolean flag indicating whether or not to use Amat to extract the off-diagonal blocks from 1982c84da90fSDmitry Karpeev 19839506b623SDmitry Karpeev Options Database: 19849506b623SDmitry Karpeev . -pc_fieldsplit_off_diag_use_amat 1985c84da90fSDmitry Karpeev 1986c84da90fSDmitry Karpeev Level: intermediate 1987c84da90fSDmitry Karpeev 1988c84da90fSDmitry Karpeev .seealso: PCFieldSplitGetOffDiagUseAmat(), PCFieldSplitSetDiagUseAmat(), PCFIELDSPLIT 1989c84da90fSDmitry Karpeev 1990c84da90fSDmitry Karpeev @*/ 1991c84da90fSDmitry Karpeev PetscErrorCode PCFieldSplitSetOffDiagUseAmat(PC pc,PetscBool flg) 1992c84da90fSDmitry Karpeev { 1993c84da90fSDmitry Karpeev PC_FieldSplit *jac = (PC_FieldSplit*)pc->data; 1994c84da90fSDmitry Karpeev PetscBool isfs; 1995c84da90fSDmitry Karpeev PetscErrorCode ierr; 1996c84da90fSDmitry Karpeev 1997c84da90fSDmitry Karpeev PetscFunctionBegin; 1998c84da90fSDmitry Karpeev PetscValidHeaderSpecific(pc,PC_CLASSID,1); 1999c84da90fSDmitry Karpeev ierr = PetscObjectTypeCompare((PetscObject)pc,PCFIELDSPLIT,&isfs);CHKERRQ(ierr); 2000c84da90fSDmitry Karpeev if (!isfs) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"PC not of type %s",PCFIELDSPLIT); 2001c84da90fSDmitry Karpeev jac->offdiag_use_amat = flg; 2002c84da90fSDmitry Karpeev PetscFunctionReturn(0); 2003c84da90fSDmitry Karpeev } 2004c84da90fSDmitry Karpeev 2005c84da90fSDmitry Karpeev /*@ 2006c84da90fSDmitry Karpeev PCFieldSplitGetOffDiagUseAmat - get the flag indicating whether to extract off-diagonal blocks from Amat (rather than Pmat) 2007c84da90fSDmitry Karpeev 2008c84da90fSDmitry Karpeev Logically Collective on PC 2009c84da90fSDmitry Karpeev 2010c84da90fSDmitry Karpeev Input Parameters: 2011c84da90fSDmitry Karpeev . pc - the preconditioner object 2012c84da90fSDmitry Karpeev 2013c84da90fSDmitry Karpeev Output Parameters: 2014c84da90fSDmitry Karpeev . flg - boolean flag indicating whether or not to use Amat to extract the off-diagonal blocks from 2015c84da90fSDmitry Karpeev 2016c84da90fSDmitry Karpeev 2017c84da90fSDmitry Karpeev Level: intermediate 2018c84da90fSDmitry Karpeev 2019c84da90fSDmitry Karpeev .seealso: PCFieldSplitSetOffDiagUseAmat(), PCFieldSplitGetDiagUseAmat(), PCFIELDSPLIT 2020c84da90fSDmitry Karpeev 2021c84da90fSDmitry Karpeev @*/ 2022c84da90fSDmitry Karpeev PetscErrorCode PCFieldSplitGetOffDiagUseAmat(PC pc,PetscBool *flg) 2023c84da90fSDmitry Karpeev { 2024c84da90fSDmitry Karpeev PC_FieldSplit *jac = (PC_FieldSplit*)pc->data; 2025c84da90fSDmitry Karpeev PetscBool isfs; 2026c84da90fSDmitry Karpeev PetscErrorCode ierr; 2027c84da90fSDmitry Karpeev 2028c84da90fSDmitry Karpeev PetscFunctionBegin; 2029c84da90fSDmitry Karpeev PetscValidHeaderSpecific(pc,PC_CLASSID,1); 2030c84da90fSDmitry Karpeev PetscValidPointer(flg,2); 2031c84da90fSDmitry Karpeev ierr = PetscObjectTypeCompare((PetscObject)pc,PCFIELDSPLIT,&isfs);CHKERRQ(ierr); 2032c84da90fSDmitry Karpeev if (!isfs) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"PC not of type %s",PCFIELDSPLIT); 2033c84da90fSDmitry Karpeev *flg = jac->offdiag_use_amat; 2034c84da90fSDmitry Karpeev PetscFunctionReturn(0); 2035c84da90fSDmitry Karpeev } 2036c84da90fSDmitry Karpeev 2037c84da90fSDmitry Karpeev 2038c84da90fSDmitry Karpeev 2039218d4943SBarry Smith /*@C 2040704ba839SBarry Smith PCFieldSplitSetIS - Sets the exact elements for field 2041704ba839SBarry Smith 2042ad4df100SBarry Smith Logically Collective on PC 2043704ba839SBarry Smith 2044704ba839SBarry Smith Input Parameters: 2045704ba839SBarry Smith + pc - the preconditioner context 20460298fd71SBarry Smith . splitname - name of this split, if NULL the number of the split is used 2047db4c96c1SJed Brown - is - the index set that defines the vector elements in this field 2048704ba839SBarry Smith 2049d32f9abdSBarry Smith 2050a6ffb8dbSJed Brown Notes: 2051a6ffb8dbSJed Brown Use PCFieldSplitSetFields(), for fields defined by strided types. 2052a6ffb8dbSJed Brown 2053db4c96c1SJed Brown This function is called once per split (it creates a new split each time). Solve options 2054db4c96c1SJed Brown for this split will be available under the prefix -fieldsplit_SPLITNAME_. 2055d32f9abdSBarry Smith 2056704ba839SBarry Smith Level: intermediate 2057704ba839SBarry Smith 2058704ba839SBarry Smith .seealso: PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitSetBlockSize() 2059704ba839SBarry Smith 2060704ba839SBarry Smith @*/ 20617087cfbeSBarry Smith PetscErrorCode PCFieldSplitSetIS(PC pc,const char splitname[],IS is) 2062704ba839SBarry Smith { 20634ac538c5SBarry Smith PetscErrorCode ierr; 2064704ba839SBarry Smith 2065704ba839SBarry Smith PetscFunctionBegin; 20660700a824SBarry Smith PetscValidHeaderSpecific(pc,PC_CLASSID,1); 20677b62db95SJungho Lee if (splitname) PetscValidCharPointer(splitname,2); 2068db4c96c1SJed Brown PetscValidHeaderSpecific(is,IS_CLASSID,3); 2069ccc738f7SBarry Smith ierr = PetscTryMethod(pc,"PCFieldSplitSetIS_C",(PC,const char[],IS),(pc,splitname,is));CHKERRQ(ierr); 2070704ba839SBarry Smith PetscFunctionReturn(0); 2071704ba839SBarry Smith } 2072704ba839SBarry Smith 207394ef8ddeSSatish Balay /*@C 207457a9adfeSMatthew G Knepley PCFieldSplitGetIS - Retrieves the elements for a field as an IS 207557a9adfeSMatthew G Knepley 207657a9adfeSMatthew G Knepley Logically Collective on PC 207757a9adfeSMatthew G Knepley 207857a9adfeSMatthew G Knepley Input Parameters: 207957a9adfeSMatthew G Knepley + pc - the preconditioner context 208057a9adfeSMatthew G Knepley - splitname - name of this split 208157a9adfeSMatthew G Knepley 208257a9adfeSMatthew G Knepley Output Parameter: 20830298fd71SBarry Smith - is - the index set that defines the vector elements in this field, or NULL if the field is not found 208457a9adfeSMatthew G Knepley 208557a9adfeSMatthew G Knepley Level: intermediate 208657a9adfeSMatthew G Knepley 208757a9adfeSMatthew G Knepley .seealso: PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitSetIS() 208857a9adfeSMatthew G Knepley 208957a9adfeSMatthew G Knepley @*/ 209057a9adfeSMatthew G Knepley PetscErrorCode PCFieldSplitGetIS(PC pc,const char splitname[],IS *is) 209157a9adfeSMatthew G Knepley { 209257a9adfeSMatthew G Knepley PetscErrorCode ierr; 209357a9adfeSMatthew G Knepley 209457a9adfeSMatthew G Knepley PetscFunctionBegin; 209557a9adfeSMatthew G Knepley PetscValidHeaderSpecific(pc,PC_CLASSID,1); 209657a9adfeSMatthew G Knepley PetscValidCharPointer(splitname,2); 209757a9adfeSMatthew G Knepley PetscValidPointer(is,3); 209857a9adfeSMatthew G Knepley { 209957a9adfeSMatthew G Knepley PC_FieldSplit *jac = (PC_FieldSplit*) pc->data; 210057a9adfeSMatthew G Knepley PC_FieldSplitLink ilink = jac->head; 210157a9adfeSMatthew G Knepley PetscBool found; 210257a9adfeSMatthew G Knepley 21030298fd71SBarry Smith *is = NULL; 210457a9adfeSMatthew G Knepley while (ilink) { 210557a9adfeSMatthew G Knepley ierr = PetscStrcmp(ilink->splitname, splitname, &found);CHKERRQ(ierr); 210657a9adfeSMatthew G Knepley if (found) { 210757a9adfeSMatthew G Knepley *is = ilink->is; 210857a9adfeSMatthew G Knepley break; 210957a9adfeSMatthew G Knepley } 211057a9adfeSMatthew G Knepley ilink = ilink->next; 211157a9adfeSMatthew G Knepley } 211257a9adfeSMatthew G Knepley } 211357a9adfeSMatthew G Knepley PetscFunctionReturn(0); 211457a9adfeSMatthew G Knepley } 211557a9adfeSMatthew G Knepley 211651f519a2SBarry Smith /*@ 211751f519a2SBarry Smith PCFieldSplitSetBlockSize - Sets the block size for defining where fields start in the 211851f519a2SBarry Smith fieldsplit preconditioner. If not set the matrix block size is used. 211951f519a2SBarry Smith 2120ad4df100SBarry Smith Logically Collective on PC 212151f519a2SBarry Smith 212251f519a2SBarry Smith Input Parameters: 212351f519a2SBarry Smith + pc - the preconditioner context 212451f519a2SBarry Smith - bs - the block size 212551f519a2SBarry Smith 212651f519a2SBarry Smith Level: intermediate 212751f519a2SBarry Smith 212851f519a2SBarry Smith .seealso: PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitSetFields() 212951f519a2SBarry Smith 213051f519a2SBarry Smith @*/ 21317087cfbeSBarry Smith PetscErrorCode PCFieldSplitSetBlockSize(PC pc,PetscInt bs) 213251f519a2SBarry Smith { 21334ac538c5SBarry Smith PetscErrorCode ierr; 213451f519a2SBarry Smith 213551f519a2SBarry Smith PetscFunctionBegin; 21360700a824SBarry Smith PetscValidHeaderSpecific(pc,PC_CLASSID,1); 2137c5eb9154SBarry Smith PetscValidLogicalCollectiveInt(pc,bs,2); 21384ac538c5SBarry Smith ierr = PetscTryMethod(pc,"PCFieldSplitSetBlockSize_C",(PC,PetscInt),(pc,bs));CHKERRQ(ierr); 213951f519a2SBarry Smith PetscFunctionReturn(0); 214051f519a2SBarry Smith } 214151f519a2SBarry Smith 21420971522cSBarry Smith /*@C 214369a612a9SBarry Smith PCFieldSplitGetSubKSP - Gets the KSP contexts for all splits 21440971522cSBarry Smith 214569a612a9SBarry Smith Collective on KSP 21460971522cSBarry Smith 21470971522cSBarry Smith Input Parameter: 21480971522cSBarry Smith . pc - the preconditioner context 21490971522cSBarry Smith 21500971522cSBarry Smith Output Parameters: 215113e0d083SBarry Smith + n - the number of splits 21523111de3cSBarry Smith - subksp - the array of KSP contexts 21530971522cSBarry Smith 21540971522cSBarry Smith Note: 21559a4f7e47SBarry Smith After PCFieldSplitGetSubKSP() the array of KSPs is to be freed by the user with PetscFree() 2156d32f9abdSBarry Smith (not the KSP just the array that contains them). 21570971522cSBarry Smith 2158285fb4e2SStefano Zampini You must call PCSetUp() before calling PCFieldSplitGetSubKSP(). 2159285fb4e2SStefano Zampini 2160285fb4e2SStefano Zampini If the fieldsplit is of type PC_COMPOSITE_SCHUR, it returns the KSP object used inside the 2161285fb4e2SStefano Zampini Schur complement and the KSP object used to iterate over the Schur complement. 2162a51937d4SCarola Kruse To access all the KSP objects used in PC_COMPOSITE_SCHUR, use PCFieldSplitSchurGetSubKSP(). 2163a51937d4SCarola Kruse 2164a51937d4SCarola Kruse If the fieldsplit is of type PC_COMPOSITE_GKB, it returns the KSP object used to solve the 2165a51937d4SCarola Kruse inner linear system defined by the matrix H in each loop. 21660971522cSBarry Smith 2167196cc216SBarry Smith Fortran Usage: You must pass in a KSP array that is large enough to contain all the local KSPs. 21682bf68e3eSBarry Smith You can call PCFieldSplitGetSubKSP(pc,n,PETSC_NULL_KSP,ierr) to determine how large the 2169196cc216SBarry Smith KSP array must be. 2170196cc216SBarry Smith 2171196cc216SBarry Smith 21720971522cSBarry Smith Level: advanced 21730971522cSBarry Smith 21740971522cSBarry Smith .seealso: PCFIELDSPLIT 21750971522cSBarry Smith @*/ 21767087cfbeSBarry Smith PetscErrorCode PCFieldSplitGetSubKSP(PC pc,PetscInt *n,KSP *subksp[]) 21770971522cSBarry Smith { 21784ac538c5SBarry Smith PetscErrorCode ierr; 21790971522cSBarry Smith 21800971522cSBarry Smith PetscFunctionBegin; 21810700a824SBarry Smith PetscValidHeaderSpecific(pc,PC_CLASSID,1); 218213e0d083SBarry Smith if (n) PetscValidIntPointer(n,2); 21834ac538c5SBarry Smith ierr = PetscUseMethod(pc,"PCFieldSplitGetSubKSP_C",(PC,PetscInt*,KSP **),(pc,n,subksp));CHKERRQ(ierr); 21840971522cSBarry Smith PetscFunctionReturn(0); 21850971522cSBarry Smith } 21860971522cSBarry Smith 2187285fb4e2SStefano Zampini /*@C 2188285fb4e2SStefano Zampini PCFieldSplitSchurGetSubKSP - Gets the KSP contexts used inside the Schur complement based PCFIELDSPLIT 2189285fb4e2SStefano Zampini 2190285fb4e2SStefano Zampini Collective on KSP 2191285fb4e2SStefano Zampini 2192285fb4e2SStefano Zampini Input Parameter: 2193285fb4e2SStefano Zampini . pc - the preconditioner context 2194285fb4e2SStefano Zampini 2195285fb4e2SStefano Zampini Output Parameters: 2196285fb4e2SStefano Zampini + n - the number of splits 2197285fb4e2SStefano Zampini - subksp - the array of KSP contexts 2198285fb4e2SStefano Zampini 2199285fb4e2SStefano Zampini Note: 2200285fb4e2SStefano Zampini After PCFieldSplitSchurGetSubKSP() the array of KSPs is to be freed by the user with PetscFree() 2201285fb4e2SStefano Zampini (not the KSP just the array that contains them). 2202285fb4e2SStefano Zampini 2203285fb4e2SStefano Zampini You must call PCSetUp() before calling PCFieldSplitSchurGetSubKSP(). 2204285fb4e2SStefano Zampini 2205285fb4e2SStefano Zampini If the fieldsplit type is of type PC_COMPOSITE_SCHUR, it returns (in order) 2206285fb4e2SStefano Zampini - the KSP used for the (1,1) block 2207285fb4e2SStefano Zampini - the KSP used for the Schur complement (not the one used for the interior Schur solver) 2208285fb4e2SStefano Zampini - the KSP used for the (1,1) block in the upper triangular factor (if different from that of the (1,1) block). 2209285fb4e2SStefano Zampini 2210285fb4e2SStefano Zampini It returns a null array if the fieldsplit is not of type PC_COMPOSITE_SCHUR; in this case, you should use PCFieldSplitGetSubKSP(). 2211285fb4e2SStefano Zampini 2212285fb4e2SStefano Zampini Fortran Usage: You must pass in a KSP array that is large enough to contain all the local KSPs. 2213285fb4e2SStefano Zampini You can call PCFieldSplitSchurGetSubKSP(pc,n,PETSC_NULL_KSP,ierr) to determine how large the 2214285fb4e2SStefano Zampini KSP array must be. 2215285fb4e2SStefano Zampini 2216285fb4e2SStefano Zampini Level: advanced 2217285fb4e2SStefano Zampini 2218285fb4e2SStefano Zampini .seealso: PCFIELDSPLIT 2219285fb4e2SStefano Zampini @*/ 2220285fb4e2SStefano Zampini PetscErrorCode PCFieldSplitSchurGetSubKSP(PC pc,PetscInt *n,KSP *subksp[]) 2221285fb4e2SStefano Zampini { 2222285fb4e2SStefano Zampini PetscErrorCode ierr; 2223285fb4e2SStefano Zampini 2224285fb4e2SStefano Zampini PetscFunctionBegin; 2225285fb4e2SStefano Zampini PetscValidHeaderSpecific(pc,PC_CLASSID,1); 2226285fb4e2SStefano Zampini if (n) PetscValidIntPointer(n,2); 2227285fb4e2SStefano Zampini ierr = PetscUseMethod(pc,"PCFieldSplitSchurGetSubKSP_C",(PC,PetscInt*,KSP **),(pc,n,subksp));CHKERRQ(ierr); 2228285fb4e2SStefano Zampini PetscFunctionReturn(0); 2229285fb4e2SStefano Zampini } 2230285fb4e2SStefano Zampini 2231e69d4d44SBarry Smith /*@ 223253f2277eSBarry Smith PCFieldSplitSetSchurPre - Indicates what operator is used to construct the preconditioner for the Schur complement. 2233a04f6461SBarry Smith A11 matrix. Otherwise no preconditioner is used. 2234e69d4d44SBarry Smith 2235e69d4d44SBarry Smith Collective on PC 2236e69d4d44SBarry Smith 2237e69d4d44SBarry Smith Input Parameters: 2238e69d4d44SBarry Smith + pc - the preconditioner context 22396fdd48a9SBarry 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 22406fdd48a9SBarry Smith PC_FIELDSPLIT_SCHUR_PRE_SELFP, and PC_FIELDSPLIT_SCHUR_PRE_FULL 22410298fd71SBarry Smith - userpre - matrix to use for preconditioning, or NULL 2242084e4875SJed Brown 2243e69d4d44SBarry Smith Options Database: 22446fdd48a9SBarry Smith . -pc_fieldsplit_schur_precondition <self,selfp,user,a11,full> - default is a11. See notes for meaning of various arguments 2245e69d4d44SBarry Smith 2246fd1303e9SJungho Lee Notes: 2247fd1303e9SJungho Lee $ If ptype is 2248a6a584a2SBarry Smith $ a11 then the preconditioner for the Schur complement is generated from the block diagonal part of the preconditioner 224953f2277eSBarry Smith $ matrix associated with the Schur complement (i.e. A11), not the Schur complement matrix 2250a6a584a2SBarry Smith $ self the preconditioner for the Schur complement is generated from the symbolic representation of the Schur complement matrix: 2251a6a584a2SBarry Smith $ The only preconditioner that currently works with this symbolic respresentation matrix object is the PCLSC 2252fd1303e9SJungho Lee $ preconditioner 22536fdd48a9SBarry Smith $ user then the preconditioner for the Schur complement is generated from the user provided matrix (pre argument 22546fdd48a9SBarry Smith $ to this function). 2255a6a584a2SBarry Smith $ selfp then the preconditioning for the Schur complement is generated from an explicitly-assembled approximation Sp = A11 - A10 inv(diag(A00)) A01 22561d71051fSDmitry Karpeev $ This is only a good preconditioner when diag(A00) is a good preconditioner for A00. Optionally, A00 can be 22576fdd48a9SBarry Smith $ lumped before extracting the diagonal using the additional option -fieldsplit_1_mat_schur_complement_ainv_type lump 225894350679SMatthew 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) 22596fdd48a9SBarry Smith $ useful mostly as a test that the Schur complement approach can work for your problem 2260fd1303e9SJungho Lee 2261e87fab1bSBarry Smith When solving a saddle point problem, where the A11 block is identically zero, using a11 as the ptype only makes sense 2262fd1303e9SJungho Lee with the additional option -fieldsplit_1_pc_type none. Usually for saddle point problems one would use a ptype of self and 2263a7476a74SDmitry Karpeev -fieldsplit_1_pc_type lsc which uses the least squares commutator to compute a preconditioner for the Schur complement. 2264fd1303e9SJungho Lee 2265e69d4d44SBarry Smith Level: intermediate 2266e69d4d44SBarry Smith 22671d71051fSDmitry Karpeev .seealso: PCFieldSplitGetSchurPre(), PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitSetFields(), PCFieldSplitSchurPreType, 22681d71051fSDmitry Karpeev MatSchurComplementSetAinvType(), PCLSC 2269e69d4d44SBarry Smith 2270e69d4d44SBarry Smith @*/ 227129f8a81cSJed Brown PetscErrorCode PCFieldSplitSetSchurPre(PC pc,PCFieldSplitSchurPreType ptype,Mat pre) 2272e69d4d44SBarry Smith { 22734ac538c5SBarry Smith PetscErrorCode ierr; 2274e69d4d44SBarry Smith 2275e69d4d44SBarry Smith PetscFunctionBegin; 22760700a824SBarry Smith PetscValidHeaderSpecific(pc,PC_CLASSID,1); 227729f8a81cSJed Brown ierr = PetscTryMethod(pc,"PCFieldSplitSetSchurPre_C",(PC,PCFieldSplitSchurPreType,Mat),(pc,ptype,pre));CHKERRQ(ierr); 2278e69d4d44SBarry Smith PetscFunctionReturn(0); 2279e69d4d44SBarry Smith } 2280686bed4dSStefano Zampini 228129f8a81cSJed Brown PetscErrorCode PCFieldSplitSchurPrecondition(PC pc,PCFieldSplitSchurPreType ptype,Mat pre) {return PCFieldSplitSetSchurPre(pc,ptype,pre);} /* Deprecated name */ 2282e69d4d44SBarry Smith 228337a82bf0SJed Brown /*@ 228437a82bf0SJed Brown PCFieldSplitGetSchurPre - For Schur complement fieldsplit, determine how the Schur complement will be 228529f8a81cSJed Brown preconditioned. See PCFieldSplitSetSchurPre() for details. 228637a82bf0SJed Brown 228737a82bf0SJed Brown Logically Collective on PC 228837a82bf0SJed Brown 228937a82bf0SJed Brown Input Parameters: 229037a82bf0SJed Brown . pc - the preconditioner context 229137a82bf0SJed Brown 229237a82bf0SJed Brown Output Parameters: 229337a82bf0SJed 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 229437a82bf0SJed Brown - userpre - matrix to use for preconditioning (with PC_FIELDSPLIT_PRE_USER), or NULL 229537a82bf0SJed Brown 229637a82bf0SJed Brown Level: intermediate 229737a82bf0SJed Brown 229829f8a81cSJed Brown .seealso: PCFieldSplitSetSchurPre(), PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitSetFields(), PCFieldSplitSchurPreType, PCLSC 229937a82bf0SJed Brown 230037a82bf0SJed Brown @*/ 230137a82bf0SJed Brown PetscErrorCode PCFieldSplitGetSchurPre(PC pc,PCFieldSplitSchurPreType *ptype,Mat *pre) 230237a82bf0SJed Brown { 230337a82bf0SJed Brown PetscErrorCode ierr; 230437a82bf0SJed Brown 230537a82bf0SJed Brown PetscFunctionBegin; 230637a82bf0SJed Brown PetscValidHeaderSpecific(pc,PC_CLASSID,1); 230737a82bf0SJed Brown ierr = PetscUseMethod(pc,"PCFieldSplitGetSchurPre_C",(PC,PCFieldSplitSchurPreType*,Mat*),(pc,ptype,pre));CHKERRQ(ierr); 2308e69d4d44SBarry Smith PetscFunctionReturn(0); 2309e69d4d44SBarry Smith } 2310e69d4d44SBarry Smith 231145e7fc46SDmitry Karpeev /*@ 2312470b340bSDmitry Karpeev PCFieldSplitSchurGetS - extract the MatSchurComplement object used by this PC in case it needs to be configured separately 231345e7fc46SDmitry Karpeev 231445e7fc46SDmitry Karpeev Not collective 231545e7fc46SDmitry Karpeev 231645e7fc46SDmitry Karpeev Input Parameter: 231745e7fc46SDmitry Karpeev . pc - the preconditioner context 231845e7fc46SDmitry Karpeev 231945e7fc46SDmitry Karpeev Output Parameter: 2320470b340bSDmitry Karpeev . S - the Schur complement matrix 232145e7fc46SDmitry Karpeev 2322470b340bSDmitry Karpeev Notes: 2323470b340bSDmitry Karpeev This matrix should not be destroyed using MatDestroy(); rather, use PCFieldSplitSchurRestoreS(). 232445e7fc46SDmitry Karpeev 232545e7fc46SDmitry Karpeev Level: advanced 232645e7fc46SDmitry Karpeev 232729f8a81cSJed Brown .seealso: PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitSchurPreType, PCFieldSplitSetSchurPre(), MatSchurComplement, PCFieldSplitSchurRestoreS() 232845e7fc46SDmitry Karpeev 232945e7fc46SDmitry Karpeev @*/ 2330470b340bSDmitry Karpeev PetscErrorCode PCFieldSplitSchurGetS(PC pc,Mat *S) 233145e7fc46SDmitry Karpeev { 233245e7fc46SDmitry Karpeev PetscErrorCode ierr; 233345e7fc46SDmitry Karpeev const char* t; 233445e7fc46SDmitry Karpeev PetscBool isfs; 233545e7fc46SDmitry Karpeev PC_FieldSplit *jac; 233645e7fc46SDmitry Karpeev 233745e7fc46SDmitry Karpeev PetscFunctionBegin; 233845e7fc46SDmitry Karpeev PetscValidHeaderSpecific(pc,PC_CLASSID,1); 233945e7fc46SDmitry Karpeev ierr = PetscObjectGetType((PetscObject)pc,&t);CHKERRQ(ierr); 234045e7fc46SDmitry Karpeev ierr = PetscStrcmp(t,PCFIELDSPLIT,&isfs);CHKERRQ(ierr); 234145e7fc46SDmitry Karpeev if (!isfs) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Expected PC of type PCFIELDSPLIT, got %s instead",t); 234245e7fc46SDmitry Karpeev jac = (PC_FieldSplit*)pc->data; 2343470b340bSDmitry 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); 2344470b340bSDmitry Karpeev if (S) *S = jac->schur; 234545e7fc46SDmitry Karpeev PetscFunctionReturn(0); 234645e7fc46SDmitry Karpeev } 234745e7fc46SDmitry Karpeev 2348470b340bSDmitry Karpeev /*@ 2349470b340bSDmitry Karpeev PCFieldSplitSchurRestoreS - restores the MatSchurComplement object used by this PC 2350470b340bSDmitry Karpeev 2351470b340bSDmitry Karpeev Not collective 2352470b340bSDmitry Karpeev 2353470b340bSDmitry Karpeev Input Parameters: 2354470b340bSDmitry Karpeev + pc - the preconditioner context 2355470b340bSDmitry Karpeev . S - the Schur complement matrix 2356470b340bSDmitry Karpeev 2357470b340bSDmitry Karpeev Level: advanced 2358470b340bSDmitry Karpeev 235929f8a81cSJed Brown .seealso: PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitSchurPreType, PCFieldSplitSetSchurPre(), MatSchurComplement, PCFieldSplitSchurGetS() 2360470b340bSDmitry Karpeev 2361470b340bSDmitry Karpeev @*/ 2362bca69d2bSDmitry Karpeev PetscErrorCode PCFieldSplitSchurRestoreS(PC pc,Mat *S) 2363470b340bSDmitry Karpeev { 2364470b340bSDmitry Karpeev PetscErrorCode ierr; 2365470b340bSDmitry Karpeev const char* t; 2366470b340bSDmitry Karpeev PetscBool isfs; 2367470b340bSDmitry Karpeev PC_FieldSplit *jac; 2368470b340bSDmitry Karpeev 2369470b340bSDmitry Karpeev PetscFunctionBegin; 2370470b340bSDmitry Karpeev PetscValidHeaderSpecific(pc,PC_CLASSID,1); 2371470b340bSDmitry Karpeev ierr = PetscObjectGetType((PetscObject)pc,&t);CHKERRQ(ierr); 2372470b340bSDmitry Karpeev ierr = PetscStrcmp(t,PCFIELDSPLIT,&isfs);CHKERRQ(ierr); 2373470b340bSDmitry Karpeev if (!isfs) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Expected PC of type PCFIELDSPLIT, got %s instead",t); 2374470b340bSDmitry Karpeev jac = (PC_FieldSplit*)pc->data; 2375470b340bSDmitry 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); 2376bca69d2bSDmitry Karpeev if (!S || *S != jac->schur) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"MatSchurComplement restored is not the same as gotten"); 2377470b340bSDmitry Karpeev PetscFunctionReturn(0); 2378470b340bSDmitry Karpeev } 2379470b340bSDmitry Karpeev 2380470b340bSDmitry Karpeev 238129f8a81cSJed Brown static PetscErrorCode PCFieldSplitSetSchurPre_FieldSplit(PC pc,PCFieldSplitSchurPreType ptype,Mat pre) 2382e69d4d44SBarry Smith { 2383e69d4d44SBarry Smith PC_FieldSplit *jac = (PC_FieldSplit*)pc->data; 2384084e4875SJed Brown PetscErrorCode ierr; 2385e69d4d44SBarry Smith 2386e69d4d44SBarry Smith PetscFunctionBegin; 2387084e4875SJed Brown jac->schurpre = ptype; 2388a7476a74SDmitry Karpeev if (ptype == PC_FIELDSPLIT_SCHUR_PRE_USER && pre) { 23896bf464f9SBarry Smith ierr = MatDestroy(&jac->schur_user);CHKERRQ(ierr); 2390084e4875SJed Brown jac->schur_user = pre; 2391084e4875SJed Brown ierr = PetscObjectReference((PetscObject)jac->schur_user);CHKERRQ(ierr); 2392084e4875SJed Brown } 2393e69d4d44SBarry Smith PetscFunctionReturn(0); 2394e69d4d44SBarry Smith } 2395e69d4d44SBarry Smith 239637a82bf0SJed Brown static PetscErrorCode PCFieldSplitGetSchurPre_FieldSplit(PC pc,PCFieldSplitSchurPreType *ptype,Mat *pre) 239737a82bf0SJed Brown { 239837a82bf0SJed Brown PC_FieldSplit *jac = (PC_FieldSplit*)pc->data; 239937a82bf0SJed Brown 240037a82bf0SJed Brown PetscFunctionBegin; 240137a82bf0SJed Brown *ptype = jac->schurpre; 240237a82bf0SJed Brown *pre = jac->schur_user; 240337a82bf0SJed Brown PetscFunctionReturn(0); 240437a82bf0SJed Brown } 240537a82bf0SJed Brown 2406ab1df9f5SJed Brown /*@ 24070ffb0e17SBarry Smith PCFieldSplitSetSchurFactType - sets which blocks of the approximate block factorization to retain in the preconditioner 2408ab1df9f5SJed Brown 2409ab1df9f5SJed Brown Collective on PC 2410ab1df9f5SJed Brown 2411ab1df9f5SJed Brown Input Parameters: 2412ab1df9f5SJed Brown + pc - the preconditioner context 2413c9c6ffaaSJed Brown - ftype - which blocks of factorization to retain, PC_FIELDSPLIT_SCHUR_FACT_FULL is default 2414ab1df9f5SJed Brown 2415ab1df9f5SJed Brown Options Database: 2416c9c6ffaaSJed Brown . -pc_fieldsplit_schur_fact_type <diag,lower,upper,full> default is full 2417ab1df9f5SJed Brown 2418ab1df9f5SJed Brown 2419ab1df9f5SJed Brown Level: intermediate 2420ab1df9f5SJed Brown 2421ab1df9f5SJed Brown Notes: 2422ab1df9f5SJed Brown The FULL factorization is 2423ab1df9f5SJed Brown 24240ffb0e17SBarry Smith $ (A B) = (1 0) (A 0) (1 Ainv*B) = L D U 24250ffb0e17SBarry Smith $ (C E) (C*Ainv 1) (0 S) (0 1 ) 2426ab1df9f5SJed Brown 24270ffb0e17SBarry 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, 2428c096484dSStefano 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(). 2429ab1df9f5SJed Brown 24300ffb0e17SBarry Smith $ If A and S are solved exactly 24310ffb0e17SBarry Smith $ *) FULL factorization is a direct solver. 24320ffb0e17SBarry 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. 24330ffb0e17SBarry 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. 2434ab1df9f5SJed Brown 24350ffb0e17SBarry Smith If the iteration count is very low, consider using KSPFGMRES or KSPGCR which can use one less preconditioner 24360ffb0e17SBarry 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. 24370ffb0e17SBarry Smith 24380ffb0e17SBarry Smith For symmetric problems in which A is positive definite and S is negative definite, DIAG can be used with KSPMINRES. 24390ffb0e17SBarry Smith 24400ffb0e17SBarry 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). 2441ab1df9f5SJed Brown 2442ab1df9f5SJed Brown References: 244396a0c994SBarry Smith + 1. - Murphy, Golub, and Wathen, A note on preconditioning indefinite linear systems, SIAM J. Sci. Comput., 21 (2000). 244496a0c994SBarry Smith - 2. - Ipsen, A note on preconditioning nonsymmetric matrices, SIAM J. Sci. Comput., 23 (2001). 2445ab1df9f5SJed Brown 2446c096484dSStefano Zampini .seealso: PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitSetFields(), PCFieldSplitSchurPreType, PCFieldSplitSetSchurScale() 2447ab1df9f5SJed Brown @*/ 2448c9c6ffaaSJed Brown PetscErrorCode PCFieldSplitSetSchurFactType(PC pc,PCFieldSplitSchurFactType ftype) 2449ab1df9f5SJed Brown { 2450ab1df9f5SJed Brown PetscErrorCode ierr; 2451ab1df9f5SJed Brown 2452ab1df9f5SJed Brown PetscFunctionBegin; 2453ab1df9f5SJed Brown PetscValidHeaderSpecific(pc,PC_CLASSID,1); 2454c9c6ffaaSJed Brown ierr = PetscTryMethod(pc,"PCFieldSplitSetSchurFactType_C",(PC,PCFieldSplitSchurFactType),(pc,ftype));CHKERRQ(ierr); 2455ab1df9f5SJed Brown PetscFunctionReturn(0); 2456ab1df9f5SJed Brown } 2457ab1df9f5SJed Brown 24581e6b0712SBarry Smith static PetscErrorCode PCFieldSplitSetSchurFactType_FieldSplit(PC pc,PCFieldSplitSchurFactType ftype) 2459ab1df9f5SJed Brown { 2460ab1df9f5SJed Brown PC_FieldSplit *jac = (PC_FieldSplit*)pc->data; 2461ab1df9f5SJed Brown 2462ab1df9f5SJed Brown PetscFunctionBegin; 2463ab1df9f5SJed Brown jac->schurfactorization = ftype; 2464ab1df9f5SJed Brown PetscFunctionReturn(0); 2465ab1df9f5SJed Brown } 2466ab1df9f5SJed Brown 2467c096484dSStefano Zampini /*@ 2468c096484dSStefano Zampini PCFieldSplitSetSchurScale - Controls the sign flip of S for PC_FIELDSPLIT_SCHUR_FACT_DIAG. 2469c096484dSStefano Zampini 2470c096484dSStefano Zampini Collective on PC 2471c096484dSStefano Zampini 2472c096484dSStefano Zampini Input Parameters: 2473c096484dSStefano Zampini + pc - the preconditioner context 2474c096484dSStefano Zampini - scale - scaling factor for the Schur complement 2475c096484dSStefano Zampini 2476c096484dSStefano Zampini Options Database: 2477c096484dSStefano Zampini . -pc_fieldsplit_schur_scale - default is -1.0 2478c096484dSStefano Zampini 2479c096484dSStefano Zampini Level: intermediate 2480c096484dSStefano Zampini 2481c096484dSStefano Zampini .seealso: PCFIELDSPLIT, PCFieldSplitSetFields(), PCFieldSplitSchurFactType, PCFieldSplitSetSchurScale() 2482c096484dSStefano Zampini @*/ 2483c096484dSStefano Zampini PetscErrorCode PCFieldSplitSetSchurScale(PC pc,PetscScalar scale) 2484c096484dSStefano Zampini { 2485c096484dSStefano Zampini PetscErrorCode ierr; 2486c096484dSStefano Zampini 2487c096484dSStefano Zampini PetscFunctionBegin; 2488c096484dSStefano Zampini PetscValidHeaderSpecific(pc,PC_CLASSID,1); 2489c096484dSStefano Zampini PetscValidLogicalCollectiveScalar(pc,scale,2); 2490c096484dSStefano Zampini ierr = PetscTryMethod(pc,"PCFieldSplitSetSchurScale_C",(PC,PetscScalar),(pc,scale));CHKERRQ(ierr); 2491c096484dSStefano Zampini PetscFunctionReturn(0); 2492c096484dSStefano Zampini } 2493c096484dSStefano Zampini 2494c096484dSStefano Zampini static PetscErrorCode PCFieldSplitSetSchurScale_FieldSplit(PC pc,PetscScalar scale) 2495c096484dSStefano Zampini { 2496c096484dSStefano Zampini PC_FieldSplit *jac = (PC_FieldSplit*)pc->data; 2497c096484dSStefano Zampini 2498c096484dSStefano Zampini PetscFunctionBegin; 2499c096484dSStefano Zampini jac->schurscale = scale; 2500c096484dSStefano Zampini PetscFunctionReturn(0); 2501c096484dSStefano Zampini } 2502c096484dSStefano Zampini 250330ad9308SMatthew Knepley /*@C 25048c03b21aSDmitry Karpeev PCFieldSplitGetSchurBlocks - Gets all matrix blocks for the Schur complement 250530ad9308SMatthew Knepley 250630ad9308SMatthew Knepley Collective on KSP 250730ad9308SMatthew Knepley 250830ad9308SMatthew Knepley Input Parameter: 250930ad9308SMatthew Knepley . pc - the preconditioner context 251030ad9308SMatthew Knepley 251130ad9308SMatthew Knepley Output Parameters: 2512a04f6461SBarry Smith + A00 - the (0,0) block 2513a04f6461SBarry Smith . A01 - the (0,1) block 2514a04f6461SBarry Smith . A10 - the (1,0) block 2515a04f6461SBarry Smith - A11 - the (1,1) block 251630ad9308SMatthew Knepley 251730ad9308SMatthew Knepley Level: advanced 251830ad9308SMatthew Knepley 251930ad9308SMatthew Knepley .seealso: PCFIELDSPLIT 252030ad9308SMatthew Knepley @*/ 2521a04f6461SBarry Smith PetscErrorCode PCFieldSplitGetSchurBlocks(PC pc,Mat *A00,Mat *A01,Mat *A10, Mat *A11) 252230ad9308SMatthew Knepley { 252330ad9308SMatthew Knepley PC_FieldSplit *jac = (PC_FieldSplit*) pc->data; 252430ad9308SMatthew Knepley 252530ad9308SMatthew Knepley PetscFunctionBegin; 25260700a824SBarry Smith PetscValidHeaderSpecific(pc,PC_CLASSID,1); 2527ce94432eSBarry Smith if (jac->type != PC_COMPOSITE_SCHUR) SETERRQ(PetscObjectComm((PetscObject)pc),PETSC_ERR_ARG_WRONG, "FieldSplit is not using a Schur complement approach."); 2528a04f6461SBarry Smith if (A00) *A00 = jac->pmat[0]; 2529a04f6461SBarry Smith if (A01) *A01 = jac->B; 2530a04f6461SBarry Smith if (A10) *A10 = jac->C; 2531a04f6461SBarry Smith if (A11) *A11 = jac->pmat[1]; 253230ad9308SMatthew Knepley PetscFunctionReturn(0); 253330ad9308SMatthew Knepley } 253430ad9308SMatthew Knepley 2535*b09e027eSCarola Kruse /*@ 2536*b09e027eSCarola Kruse PCFieldSplitSetGKBTol - Sets the solver tolerance for the Golub-Kahan bidiagonalization preconditioner. 2537*b09e027eSCarola Kruse 2538*b09e027eSCarola Kruse Collective on PC 2539*b09e027eSCarola Kruse 2540*b09e027eSCarola Kruse Input Parameters: 2541*b09e027eSCarola Kruse + pc - the preconditioner context 2542*b09e027eSCarola Kruse - tolerance - the solver tolerance 2543*b09e027eSCarola Kruse 2544*b09e027eSCarola Kruse Options Database: 2545*b09e027eSCarola Kruse . -pc_fieldsplit_gkb_tol - default is 1e-5 2546*b09e027eSCarola Kruse 2547*b09e027eSCarola Kruse Level: intermediate 2548*b09e027eSCarola Kruse 2549*b09e027eSCarola Kruse .seealso: PCFIELDSPLIT, PCFieldSplitSetGKBDelay(), PCFieldSplitSetGKBNu(), PCFieldSplitSetGKBMaxit() 2550*b09e027eSCarola Kruse @*/ 2551*b09e027eSCarola Kruse PetscErrorCode PCFieldSplitSetGKBTol(PC pc,PetscReal tolerance) 2552*b09e027eSCarola Kruse { 2553*b09e027eSCarola Kruse PetscErrorCode ierr; 2554*b09e027eSCarola Kruse 2555*b09e027eSCarola Kruse PetscFunctionBegin; 2556*b09e027eSCarola Kruse PetscValidHeaderSpecific(pc,PC_CLASSID,1); 2557*b09e027eSCarola Kruse PetscValidLogicalCollectiveScalar(pc,tolerance,2); 2558*b09e027eSCarola Kruse ierr = PetscTryMethod(pc,"PCFieldSplitSetGKBTol_C",(PC,PetscReal),(pc,tolerance));CHKERRQ(ierr); 2559*b09e027eSCarola Kruse PetscFunctionReturn(0); 2560*b09e027eSCarola Kruse } 2561*b09e027eSCarola Kruse 2562*b09e027eSCarola Kruse static PetscErrorCode PCFieldSplitSetGKBTol_FieldSplit(PC pc,PetscReal tolerance) 2563*b09e027eSCarola Kruse { 2564*b09e027eSCarola Kruse PC_FieldSplit *jac = (PC_FieldSplit*)pc->data; 2565*b09e027eSCarola Kruse 2566*b09e027eSCarola Kruse PetscFunctionBegin; 2567*b09e027eSCarola Kruse jac->gkbtol = tolerance; 2568*b09e027eSCarola Kruse PetscFunctionReturn(0); 2569*b09e027eSCarola Kruse } 2570*b09e027eSCarola Kruse 2571*b09e027eSCarola Kruse 2572*b09e027eSCarola Kruse /*@ 2573*b09e027eSCarola Kruse PCFieldSplitSetGKBMaxit - Sets the maximum number of iterations for the Golub-Kahan bidiagonalization preconditioner. 2574*b09e027eSCarola Kruse 2575*b09e027eSCarola Kruse Collective on PC 2576*b09e027eSCarola Kruse 2577*b09e027eSCarola Kruse Input Parameters: 2578*b09e027eSCarola Kruse + pc - the preconditioner context 2579*b09e027eSCarola Kruse - maxit - the maximum number of iterations 2580*b09e027eSCarola Kruse 2581*b09e027eSCarola Kruse Options Database: 2582*b09e027eSCarola Kruse . -pc_fieldsplit_gkb_maxit - default is 100 2583*b09e027eSCarola Kruse 2584*b09e027eSCarola Kruse Level: intermediate 2585*b09e027eSCarola Kruse 2586*b09e027eSCarola Kruse .seealso: PCFIELDSPLIT, PCFieldSplitSetGKBDelay(), PCFieldSplitSetGKBTol(), PCFieldSplitSetGKBNu() 2587*b09e027eSCarola Kruse @*/ 2588*b09e027eSCarola Kruse PetscErrorCode PCFieldSplitSetGKBMaxit(PC pc,PetscInt maxit) 2589*b09e027eSCarola Kruse { 2590*b09e027eSCarola Kruse PetscErrorCode ierr; 2591*b09e027eSCarola Kruse 2592*b09e027eSCarola Kruse PetscFunctionBegin; 2593*b09e027eSCarola Kruse PetscValidHeaderSpecific(pc,PC_CLASSID,1); 2594*b09e027eSCarola Kruse PetscValidLogicalCollectiveScalar(pc,maxit,2); 2595*b09e027eSCarola Kruse ierr = PetscTryMethod(pc,"PCFieldSplitSetGKBMaxit_C",(PC,PetscInt),(pc,maxit));CHKERRQ(ierr); 2596*b09e027eSCarola Kruse PetscFunctionReturn(0); 2597*b09e027eSCarola Kruse } 2598*b09e027eSCarola Kruse 2599*b09e027eSCarola Kruse static PetscErrorCode PCFieldSplitSetGKBMaxit_FieldSplit(PC pc,PetscInt maxit) 2600*b09e027eSCarola Kruse { 2601*b09e027eSCarola Kruse PC_FieldSplit *jac = (PC_FieldSplit*)pc->data; 2602*b09e027eSCarola Kruse 2603*b09e027eSCarola Kruse PetscFunctionBegin; 2604*b09e027eSCarola Kruse jac->gkbmaxit = maxit; 2605*b09e027eSCarola Kruse PetscFunctionReturn(0); 2606*b09e027eSCarola Kruse } 2607*b09e027eSCarola Kruse 2608*b09e027eSCarola Kruse /*@ 2609*b09e027eSCarola Kruse PCFieldSplitSetGKBDelay - Sets the delay in the lower bound error estimate in the Golub-Kahan bidiagonalization preconditioner. 2610*b09e027eSCarola Kruse 2611*b09e027eSCarola Kruse Collective on PC 2612*b09e027eSCarola Kruse 2613*b09e027eSCarola Kruse Notes: 2614*b09e027eSCarola Kruse The algorithm uses a lower bound estimate of the error in energy norm as stopping criterion. For more details on the 2615*b09e027eSCarola Kruse Golub-Kahan bidiagonalization method and its lower bound stopping criterion, please refer to 2616*b09e027eSCarola Kruse 2617*b09e027eSCarola Kruse [Ar13] Generalized Golub-Kahan bidiagonalization and stopping criteria, SIAM J. Matrix Anal. Appl., Vol. 34, No. 2, pp. 571-592, 2013. 2618*b09e027eSCarola Kruse 2619*b09e027eSCarola Kruse Input Parameters: 2620*b09e027eSCarola Kruse + pc - the preconditioner context 2621*b09e027eSCarola Kruse - delay - the delay window in the lower bound estimate 2622*b09e027eSCarola Kruse 2623*b09e027eSCarola Kruse Options Database: 2624*b09e027eSCarola Kruse . -pc_fieldsplit_gkb_delay - default is 5 2625*b09e027eSCarola Kruse 2626*b09e027eSCarola Kruse Level: intermediate 2627*b09e027eSCarola Kruse 2628*b09e027eSCarola Kruse .seealso: PCFIELDSPLIT, PCFieldSplitSetGKBNu(), PCFieldSplitSetGKBTol(), PCFieldSplitSetGKBMaxit() 2629*b09e027eSCarola Kruse @*/ 2630*b09e027eSCarola Kruse PetscErrorCode PCFieldSplitSetGKBDelay(PC pc,PetscInt delay) 2631*b09e027eSCarola Kruse { 2632*b09e027eSCarola Kruse PetscErrorCode ierr; 2633*b09e027eSCarola Kruse 2634*b09e027eSCarola Kruse PetscFunctionBegin; 2635*b09e027eSCarola Kruse PetscValidHeaderSpecific(pc,PC_CLASSID,1); 2636*b09e027eSCarola Kruse PetscValidLogicalCollectiveInt(pc,delay,2); 2637*b09e027eSCarola Kruse ierr = PetscTryMethod(pc,"PCFieldSplitSetGKBDelay_C",(PC,PetscInt),(pc,delay));CHKERRQ(ierr); 2638*b09e027eSCarola Kruse PetscFunctionReturn(0); 2639*b09e027eSCarola Kruse } 2640*b09e027eSCarola Kruse 2641*b09e027eSCarola Kruse static PetscErrorCode PCFieldSplitSetGKBDelay_FieldSplit(PC pc,PetscInt delay) 2642*b09e027eSCarola Kruse { 2643*b09e027eSCarola Kruse PC_FieldSplit *jac = (PC_FieldSplit*)pc->data; 2644*b09e027eSCarola Kruse 2645*b09e027eSCarola Kruse PetscFunctionBegin; 2646*b09e027eSCarola Kruse jac->gkbdelay = delay; 2647*b09e027eSCarola Kruse PetscFunctionReturn(0); 2648*b09e027eSCarola Kruse } 2649*b09e027eSCarola Kruse 2650*b09e027eSCarola Kruse /*@ 2651*b09e027eSCarola 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. 2652*b09e027eSCarola Kruse 2653*b09e027eSCarola Kruse Collective on PC 2654*b09e027eSCarola Kruse 2655*b09e027eSCarola Kruse Notes: 2656*b09e027eSCarola Kruse This shift is in general done to obtain better convergence properties for the outer loop in the algorithm. This is often achieved by chosing nu sufficiently large. However, 2657*b09e027eSCarola 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 2658*b09e027eSCarola Kruse necessary to find a good balance in between the convergence of the inner and outer loop. 2659*b09e027eSCarola Kruse 2660*b09e027eSCarola 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. 2661*b09e027eSCarola Kruse 2662*b09e027eSCarola Kruse [Ar13] Generalized Golub-Kahan bidiagonalization and stopping criteria, SIAM J. Matrix Anal. Appl., Vol. 34, No. 2, pp. 571-592, 2013. 2663*b09e027eSCarola Kruse 2664*b09e027eSCarola Kruse Input Parameters: 2665*b09e027eSCarola Kruse + pc - the preconditioner context 2666*b09e027eSCarola Kruse - nu - the shift parameter 2667*b09e027eSCarola Kruse 2668*b09e027eSCarola Kruse Options Database: 2669*b09e027eSCarola Kruse . -pc_fieldsplit_gkb_nu - default is 1 2670*b09e027eSCarola Kruse 2671*b09e027eSCarola Kruse Level: intermediate 2672*b09e027eSCarola Kruse 2673*b09e027eSCarola Kruse .seealso: PCFIELDSPLIT, PCFieldSplitSetGKBDelay(), PCFieldSplitSetGKBTol(), PCFieldSplitSetGKBMaxit() 2674*b09e027eSCarola Kruse @*/ 2675*b09e027eSCarola Kruse PetscErrorCode PCFieldSplitSetGKBNu(PC pc,PetscReal nu) 2676*b09e027eSCarola Kruse { 2677*b09e027eSCarola Kruse PetscErrorCode ierr; 2678*b09e027eSCarola Kruse 2679*b09e027eSCarola Kruse PetscFunctionBegin; 2680*b09e027eSCarola Kruse PetscValidHeaderSpecific(pc,PC_CLASSID,1); 2681*b09e027eSCarola Kruse PetscValidLogicalCollectiveScalar(pc,nu,2); 2682*b09e027eSCarola Kruse ierr = PetscTryMethod(pc,"PCFieldSplitSetGKBNu_C",(PC,PetscReal),(pc,nu));CHKERRQ(ierr); 2683*b09e027eSCarola Kruse PetscFunctionReturn(0); 2684*b09e027eSCarola Kruse } 2685*b09e027eSCarola Kruse 2686*b09e027eSCarola Kruse static PetscErrorCode PCFieldSplitSetGKBNu_FieldSplit(PC pc,PetscReal nu) 2687*b09e027eSCarola Kruse { 2688*b09e027eSCarola Kruse PC_FieldSplit *jac = (PC_FieldSplit*)pc->data; 2689*b09e027eSCarola Kruse 2690*b09e027eSCarola Kruse PetscFunctionBegin; 2691*b09e027eSCarola Kruse jac->gkbnu = nu; 2692*b09e027eSCarola Kruse PetscFunctionReturn(0); 2693*b09e027eSCarola Kruse } 2694*b09e027eSCarola Kruse 2695*b09e027eSCarola Kruse 26961e6b0712SBarry Smith static PetscErrorCode PCFieldSplitSetType_FieldSplit(PC pc,PCCompositeType type) 269779416396SBarry Smith { 269879416396SBarry Smith PC_FieldSplit *jac = (PC_FieldSplit*)pc->data; 2699e69d4d44SBarry Smith PetscErrorCode ierr; 270079416396SBarry Smith 270179416396SBarry Smith PetscFunctionBegin; 270279416396SBarry Smith jac->type = type; 27033b224e63SBarry Smith if (type == PC_COMPOSITE_SCHUR) { 27043b224e63SBarry Smith pc->ops->apply = PCApply_FieldSplit_Schur; 27053b224e63SBarry Smith pc->ops->view = PCView_FieldSplit_Schur; 27062fa5cd67SKarl Rupp 2707bdf89e91SBarry Smith ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitGetSubKSP_C",PCFieldSplitGetSubKSP_FieldSplit_Schur);CHKERRQ(ierr); 270829f8a81cSJed Brown ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetSchurPre_C",PCFieldSplitSetSchurPre_FieldSplit);CHKERRQ(ierr); 270937a82bf0SJed Brown ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitGetSchurPre_C",PCFieldSplitGetSchurPre_FieldSplit);CHKERRQ(ierr); 2710bdf89e91SBarry Smith ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetSchurFactType_C",PCFieldSplitSetSchurFactType_FieldSplit);CHKERRQ(ierr); 2711c096484dSStefano Zampini ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetSchurScale_C",PCFieldSplitSetSchurScale_FieldSplit);CHKERRQ(ierr); 2712*b09e027eSCarola Kruse ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetGKBTol_C",0);CHKERRQ(ierr); 2713*b09e027eSCarola Kruse ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetGKBMaxit_C",0);CHKERRQ(ierr); 2714*b09e027eSCarola Kruse ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetGKBNu_C",0);CHKERRQ(ierr); 2715*b09e027eSCarola Kruse ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetGKBDelay_C",0);CHKERRQ(ierr); 2716a51937d4SCarola Kruse } else if (type == PC_COMPOSITE_GKB){ 2717a51937d4SCarola Kruse pc->ops->apply = PCApply_FieldSplit_GKB; 2718a51937d4SCarola Kruse pc->ops->view = PCView_FieldSplit_GKB; 2719e69d4d44SBarry Smith 2720a51937d4SCarola Kruse ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitGetSubKSP_C",PCFieldSplitGetSubKSP_FieldSplit);CHKERRQ(ierr); 2721a51937d4SCarola Kruse ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetSchurPre_C",0);CHKERRQ(ierr); 2722a51937d4SCarola Kruse ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitGetSchurPre_C",0);CHKERRQ(ierr); 2723a51937d4SCarola Kruse ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetSchurFactType_C",0);CHKERRQ(ierr); 2724a51937d4SCarola Kruse ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetSchurScale_C",0);CHKERRQ(ierr); 2725*b09e027eSCarola Kruse ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetGKBTol_C",PCFieldSplitSetGKBTol_FieldSplit);CHKERRQ(ierr); 2726*b09e027eSCarola Kruse ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetGKBMaxit_C",PCFieldSplitSetGKBMaxit_FieldSplit);CHKERRQ(ierr); 2727*b09e027eSCarola Kruse ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetGKBNu_C",PCFieldSplitSetGKBNu_FieldSplit);CHKERRQ(ierr); 2728*b09e027eSCarola Kruse ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetGKBDelay_C",PCFieldSplitSetGKBDelay_FieldSplit);CHKERRQ(ierr); 27293b224e63SBarry Smith } else { 27303b224e63SBarry Smith pc->ops->apply = PCApply_FieldSplit; 27313b224e63SBarry Smith pc->ops->view = PCView_FieldSplit; 27322fa5cd67SKarl Rupp 2733bdf89e91SBarry Smith ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitGetSubKSP_C",PCFieldSplitGetSubKSP_FieldSplit);CHKERRQ(ierr); 273429f8a81cSJed Brown ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetSchurPre_C",0);CHKERRQ(ierr); 273537a82bf0SJed Brown ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitGetSchurPre_C",0);CHKERRQ(ierr); 2736bdf89e91SBarry Smith ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetSchurFactType_C",0);CHKERRQ(ierr); 2737c096484dSStefano Zampini ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetSchurScale_C",0);CHKERRQ(ierr); 2738*b09e027eSCarola Kruse ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetGKBTol_C",0);CHKERRQ(ierr); 2739*b09e027eSCarola Kruse ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetGKBMaxit_C",0);CHKERRQ(ierr); 2740*b09e027eSCarola Kruse ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetGKBNu_C",0);CHKERRQ(ierr); 2741*b09e027eSCarola Kruse ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetGKBDelay_C",0);CHKERRQ(ierr); 27423b224e63SBarry Smith } 274379416396SBarry Smith PetscFunctionReturn(0); 274479416396SBarry Smith } 274579416396SBarry Smith 27461e6b0712SBarry Smith static PetscErrorCode PCFieldSplitSetBlockSize_FieldSplit(PC pc,PetscInt bs) 274751f519a2SBarry Smith { 274851f519a2SBarry Smith PC_FieldSplit *jac = (PC_FieldSplit*)pc->data; 274951f519a2SBarry Smith 275051f519a2SBarry Smith PetscFunctionBegin; 2751ce94432eSBarry Smith if (bs < 1) SETERRQ1(PetscObjectComm((PetscObject)pc),PETSC_ERR_ARG_OUTOFRANGE,"Blocksize must be positive, you gave %D",bs); 2752ce94432eSBarry 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); 275351f519a2SBarry Smith jac->bs = bs; 275451f519a2SBarry Smith PetscFunctionReturn(0); 275551f519a2SBarry Smith } 275651f519a2SBarry Smith 2757bc08b0f1SBarry Smith /*@ 275879416396SBarry Smith PCFieldSplitSetType - Sets the type of fieldsplit preconditioner. 275979416396SBarry Smith 276079416396SBarry Smith Collective on PC 276179416396SBarry Smith 276279416396SBarry Smith Input Parameter: 276379416396SBarry Smith . pc - the preconditioner context 276481540f2fSBarry Smith . type - PC_COMPOSITE_ADDITIVE, PC_COMPOSITE_MULTIPLICATIVE (default), PC_COMPOSITE_SYMMETRIC_MULTIPLICATIVE, PC_COMPOSITE_SPECIAL, PC_COMPOSITE_SCHUR 276579416396SBarry Smith 276679416396SBarry Smith Options Database Key: 2767a4efd8eaSMatthew Knepley . -pc_fieldsplit_type <type: one of multiplicative, additive, symmetric_multiplicative, special, schur> - Sets fieldsplit preconditioner type 276879416396SBarry Smith 2769b02e2d75SMatthew G Knepley Level: Intermediate 277079416396SBarry Smith 277179416396SBarry Smith .keywords: PC, set, type, composite preconditioner, additive, multiplicative 277279416396SBarry Smith 277379416396SBarry Smith .seealso: PCCompositeSetType() 277479416396SBarry Smith 277579416396SBarry Smith @*/ 27767087cfbeSBarry Smith PetscErrorCode PCFieldSplitSetType(PC pc,PCCompositeType type) 277779416396SBarry Smith { 27784ac538c5SBarry Smith PetscErrorCode ierr; 277979416396SBarry Smith 278079416396SBarry Smith PetscFunctionBegin; 27810700a824SBarry Smith PetscValidHeaderSpecific(pc,PC_CLASSID,1); 27824ac538c5SBarry Smith ierr = PetscTryMethod(pc,"PCFieldSplitSetType_C",(PC,PCCompositeType),(pc,type));CHKERRQ(ierr); 278379416396SBarry Smith PetscFunctionReturn(0); 278479416396SBarry Smith } 278579416396SBarry Smith 2786b02e2d75SMatthew G Knepley /*@ 2787b02e2d75SMatthew G Knepley PCFieldSplitGetType - Gets the type of fieldsplit preconditioner. 2788b02e2d75SMatthew G Knepley 2789b02e2d75SMatthew G Knepley Not collective 2790b02e2d75SMatthew G Knepley 2791b02e2d75SMatthew G Knepley Input Parameter: 2792b02e2d75SMatthew G Knepley . pc - the preconditioner context 2793b02e2d75SMatthew G Knepley 2794b02e2d75SMatthew G Knepley Output Parameter: 2795b02e2d75SMatthew G Knepley . type - PC_COMPOSITE_ADDITIVE, PC_COMPOSITE_MULTIPLICATIVE (default), PC_COMPOSITE_SYMMETRIC_MULTIPLICATIVE, PC_COMPOSITE_SPECIAL, PC_COMPOSITE_SCHUR 2796b02e2d75SMatthew G Knepley 2797b02e2d75SMatthew G Knepley Level: Intermediate 2798b02e2d75SMatthew G Knepley 2799b02e2d75SMatthew G Knepley .keywords: PC, set, type, composite preconditioner, additive, multiplicative 2800b02e2d75SMatthew G Knepley .seealso: PCCompositeSetType() 2801b02e2d75SMatthew G Knepley @*/ 2802b02e2d75SMatthew G Knepley PetscErrorCode PCFieldSplitGetType(PC pc, PCCompositeType *type) 2803b02e2d75SMatthew G Knepley { 2804b02e2d75SMatthew G Knepley PC_FieldSplit *jac = (PC_FieldSplit*) pc->data; 2805b02e2d75SMatthew G Knepley 2806b02e2d75SMatthew G Knepley PetscFunctionBegin; 2807b02e2d75SMatthew G Knepley PetscValidHeaderSpecific(pc,PC_CLASSID,1); 2808b02e2d75SMatthew G Knepley PetscValidIntPointer(type,2); 2809b02e2d75SMatthew G Knepley *type = jac->type; 2810b02e2d75SMatthew G Knepley PetscFunctionReturn(0); 2811b02e2d75SMatthew G Knepley } 2812b02e2d75SMatthew G Knepley 28134ab8060aSDmitry Karpeev /*@ 28144ab8060aSDmitry Karpeev PCFieldSplitSetDMSplits - Flags whether DMCreateFieldDecomposition() should be used to define the splits, whenever possible. 28154ab8060aSDmitry Karpeev 28164ab8060aSDmitry Karpeev Logically Collective 28174ab8060aSDmitry Karpeev 28184ab8060aSDmitry Karpeev Input Parameters: 28194ab8060aSDmitry Karpeev + pc - the preconditioner context 28204ab8060aSDmitry Karpeev - flg - boolean indicating whether to use field splits defined by the DM 28214ab8060aSDmitry Karpeev 28224ab8060aSDmitry Karpeev Options Database Key: 28234ab8060aSDmitry Karpeev . -pc_fieldsplit_dm_splits 28244ab8060aSDmitry Karpeev 28254ab8060aSDmitry Karpeev Level: Intermediate 28264ab8060aSDmitry Karpeev 28274ab8060aSDmitry Karpeev .keywords: PC, DM, composite preconditioner, additive, multiplicative 28284ab8060aSDmitry Karpeev 28294ab8060aSDmitry Karpeev .seealso: PCFieldSplitGetDMSplits() 28304ab8060aSDmitry Karpeev 28314ab8060aSDmitry Karpeev @*/ 28324ab8060aSDmitry Karpeev PetscErrorCode PCFieldSplitSetDMSplits(PC pc,PetscBool flg) 28334ab8060aSDmitry Karpeev { 28344ab8060aSDmitry Karpeev PC_FieldSplit *jac = (PC_FieldSplit*)pc->data; 28354ab8060aSDmitry Karpeev PetscBool isfs; 28364ab8060aSDmitry Karpeev PetscErrorCode ierr; 28374ab8060aSDmitry Karpeev 28384ab8060aSDmitry Karpeev PetscFunctionBegin; 28394ab8060aSDmitry Karpeev PetscValidHeaderSpecific(pc,PC_CLASSID,1); 28404ab8060aSDmitry Karpeev PetscValidLogicalCollectiveBool(pc,flg,2); 28414ab8060aSDmitry Karpeev ierr = PetscObjectTypeCompare((PetscObject)pc,PCFIELDSPLIT,&isfs);CHKERRQ(ierr); 28424ab8060aSDmitry Karpeev if (isfs) { 28434ab8060aSDmitry Karpeev jac->dm_splits = flg; 28444ab8060aSDmitry Karpeev } 28454ab8060aSDmitry Karpeev PetscFunctionReturn(0); 28464ab8060aSDmitry Karpeev } 28474ab8060aSDmitry Karpeev 28484ab8060aSDmitry Karpeev 28494ab8060aSDmitry Karpeev /*@ 28504ab8060aSDmitry Karpeev PCFieldSplitGetDMSplits - Returns flag indicating whether DMCreateFieldDecomposition() should be used to define the splits, whenever possible. 28514ab8060aSDmitry Karpeev 28524ab8060aSDmitry Karpeev Logically Collective 28534ab8060aSDmitry Karpeev 28544ab8060aSDmitry Karpeev Input Parameter: 28554ab8060aSDmitry Karpeev . pc - the preconditioner context 28564ab8060aSDmitry Karpeev 28574ab8060aSDmitry Karpeev Output Parameter: 28584ab8060aSDmitry Karpeev . flg - boolean indicating whether to use field splits defined by the DM 28594ab8060aSDmitry Karpeev 28604ab8060aSDmitry Karpeev Level: Intermediate 28614ab8060aSDmitry Karpeev 28624ab8060aSDmitry Karpeev .keywords: PC, DM, composite preconditioner, additive, multiplicative 28634ab8060aSDmitry Karpeev 28644ab8060aSDmitry Karpeev .seealso: PCFieldSplitSetDMSplits() 28654ab8060aSDmitry Karpeev 28664ab8060aSDmitry Karpeev @*/ 28674ab8060aSDmitry Karpeev PetscErrorCode PCFieldSplitGetDMSplits(PC pc,PetscBool* flg) 28684ab8060aSDmitry Karpeev { 28694ab8060aSDmitry Karpeev PC_FieldSplit *jac = (PC_FieldSplit*)pc->data; 28704ab8060aSDmitry Karpeev PetscBool isfs; 28714ab8060aSDmitry Karpeev PetscErrorCode ierr; 28724ab8060aSDmitry Karpeev 28734ab8060aSDmitry Karpeev PetscFunctionBegin; 28744ab8060aSDmitry Karpeev PetscValidHeaderSpecific(pc,PC_CLASSID,1); 28754ab8060aSDmitry Karpeev PetscValidPointer(flg,2); 28764ab8060aSDmitry Karpeev ierr = PetscObjectTypeCompare((PetscObject)pc,PCFIELDSPLIT,&isfs);CHKERRQ(ierr); 28774ab8060aSDmitry Karpeev if (isfs) { 28784ab8060aSDmitry Karpeev if(flg) *flg = jac->dm_splits; 28794ab8060aSDmitry Karpeev } 28804ab8060aSDmitry Karpeev PetscFunctionReturn(0); 28814ab8060aSDmitry Karpeev } 28824ab8060aSDmitry Karpeev 28837b752e3dSPatrick Sanan /*@ 28847b752e3dSPatrick Sanan PCFieldSplitGetDetectSaddlePoint - Returns flag indicating whether PCFieldSplit will attempt to automatically determine fields based on zero diagonal entries. 28857b752e3dSPatrick Sanan 28867b752e3dSPatrick Sanan Logically Collective 28877b752e3dSPatrick Sanan 28887b752e3dSPatrick Sanan Input Parameter: 28897b752e3dSPatrick Sanan . pc - the preconditioner context 28907b752e3dSPatrick Sanan 28917b752e3dSPatrick Sanan Output Parameter: 28927b752e3dSPatrick Sanan . flg - boolean indicating whether to detect fields or not 28937b752e3dSPatrick Sanan 28947b752e3dSPatrick Sanan Level: Intermediate 28957b752e3dSPatrick Sanan 28967b752e3dSPatrick Sanan .seealso: PCFIELDSPLIT, PCFieldSplitSetDetectSaddlePoint() 28977b752e3dSPatrick Sanan 28987b752e3dSPatrick Sanan @*/ 28997b752e3dSPatrick Sanan PetscErrorCode PCFieldSplitGetDetectSaddlePoint(PC pc,PetscBool *flg) 29007b752e3dSPatrick Sanan { 29017b752e3dSPatrick Sanan PC_FieldSplit *jac = (PC_FieldSplit*)pc->data; 29027b752e3dSPatrick Sanan 29037b752e3dSPatrick Sanan PetscFunctionBegin; 29047b752e3dSPatrick Sanan *flg = jac->detect; 29057b752e3dSPatrick Sanan PetscFunctionReturn(0); 29067b752e3dSPatrick Sanan } 29077b752e3dSPatrick Sanan 29087b752e3dSPatrick Sanan /*@ 29097b752e3dSPatrick Sanan PCFieldSplitSetDetectSaddlePoint - Sets flag indicating whether PCFieldSplit will attempt to automatically determine fields based on zero diagonal entries. 29107b752e3dSPatrick Sanan 29117b752e3dSPatrick Sanan Logically Collective 29127b752e3dSPatrick Sanan 29137b752e3dSPatrick Sanan Notes: 29147b752e3dSPatrick 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()). 29157b752e3dSPatrick Sanan 29167b752e3dSPatrick Sanan Input Parameter: 29177b752e3dSPatrick Sanan . pc - the preconditioner context 29187b752e3dSPatrick Sanan 29197b752e3dSPatrick Sanan Output Parameter: 29207b752e3dSPatrick Sanan . flg - boolean indicating whether to detect fields or not 29217b752e3dSPatrick Sanan 29227b752e3dSPatrick Sanan Options Database Key: 29237b752e3dSPatrick Sanan . -pc_fieldsplit_detect_saddle_point 29247b752e3dSPatrick Sanan 29257b752e3dSPatrick Sanan Level: Intermediate 29267b752e3dSPatrick Sanan 29277b752e3dSPatrick Sanan .seealso: PCFIELDSPLIT, PCFieldSplitSetDetectSaddlePoint(), PCFieldSplitSetType(), PCFieldSplitSetSchurPre() 29287b752e3dSPatrick Sanan 29297b752e3dSPatrick Sanan @*/ 29307b752e3dSPatrick Sanan PetscErrorCode PCFieldSplitSetDetectSaddlePoint(PC pc,PetscBool flg) 29317b752e3dSPatrick Sanan { 29327b752e3dSPatrick Sanan PC_FieldSplit *jac = (PC_FieldSplit*)pc->data; 29337b752e3dSPatrick Sanan PetscErrorCode ierr; 29347b752e3dSPatrick Sanan 29357b752e3dSPatrick Sanan PetscFunctionBegin; 29367b752e3dSPatrick Sanan jac->detect = flg; 29377b752e3dSPatrick Sanan if (jac->detect) { 29387b752e3dSPatrick Sanan ierr = PCFieldSplitSetType(pc,PC_COMPOSITE_SCHUR);CHKERRQ(ierr); 29397b752e3dSPatrick Sanan ierr = PCFieldSplitSetSchurPre(pc,PC_FIELDSPLIT_SCHUR_PRE_SELF,NULL);CHKERRQ(ierr); 29407b752e3dSPatrick Sanan } 29417b752e3dSPatrick Sanan PetscFunctionReturn(0); 29427b752e3dSPatrick Sanan } 29437b752e3dSPatrick Sanan 29440971522cSBarry Smith /* -------------------------------------------------------------------------------------*/ 29450971522cSBarry Smith /*MC 2946a8c7a070SBarry Smith PCFIELDSPLIT - Preconditioner created by combining separate preconditioners for individual 2947a04f6461SBarry Smith fields or groups of fields. See the users manual section "Solving Block Matrices" for more details. 29480971522cSBarry Smith 2949edf189efSBarry Smith To set options on the solvers for each block append -fieldsplit_ to all the PC 2950edf189efSBarry Smith options database keys. For example, -fieldsplit_pc_type ilu -fieldsplit_pc_factor_levels 1 29510971522cSBarry Smith 2952a8c7a070SBarry Smith To set the options on the solvers separate for each block call PCFieldSplitGetSubKSP() 295369a612a9SBarry Smith and set the options directly on the resulting KSP object 29540971522cSBarry Smith 29550971522cSBarry Smith Level: intermediate 29560971522cSBarry Smith 295779416396SBarry Smith Options Database Keys: 295881540f2fSBarry Smith + -pc_fieldsplit_%d_fields <a,b,..> - indicates the fields to be used in the %d'th split 295981540f2fSBarry Smith . -pc_fieldsplit_default - automatically add any fields to additional splits that have not 296081540f2fSBarry Smith been supplied explicitly by -pc_fieldsplit_%d_fields 296181540f2fSBarry Smith . -pc_fieldsplit_block_size <bs> - size of block that defines fields (i.e. there are bs fields) 2962a51937d4SCarola Kruse . -pc_fieldsplit_type <additive,multiplicative,symmetric_multiplicative,schur,gkb> - type of relaxation or factorization splitting 2963a6a584a2SBarry Smith . -pc_fieldsplit_schur_precondition <self,selfp,user,a11,full> - default is a11; see PCFieldSplitSetSchurPre() 29647b752e3dSPatrick Sanan . -pc_fieldsplit_detect_saddle_point - automatically finds rows with zero diagonal and uses Schur complement with no preconditioner as the solver 296579416396SBarry Smith 2966a51937d4SCarola Kruse . Options prefix for inner solvers when using Schur complement preconditioner are -fieldsplit_0_ and -fieldsplit_1_ 29675d4c12cdSJungho Lee for all other solvers they are -fieldsplit_%d_ for the dth field, use -fieldsplit_ for all fields 2968a51937d4SCarola Kruse - Options prefix for inner solver when using Golub Kahan biadiagonalization preconditioner is -fieldsplit_0_ 29695d4c12cdSJungho Lee 2970c8a0d604SMatthew G Knepley Notes: 2971c8a0d604SMatthew G Knepley Use PCFieldSplitSetFields() to set fields defined by "strided" entries and PCFieldSplitSetIS() 2972d32f9abdSBarry Smith to define a field by an arbitrary collection of entries. 2973d32f9abdSBarry Smith 2974d32f9abdSBarry Smith If no fields are set the default is used. The fields are defined by entries strided by bs, 2975d32f9abdSBarry Smith beginning at 0 then 1, etc to bs-1. The block size can be set with PCFieldSplitSetBlockSize(), 2976d32f9abdSBarry Smith if this is not called the block size defaults to the blocksize of the second matrix passed 2977d32f9abdSBarry Smith to KSPSetOperators()/PCSetOperators(). 2978d32f9abdSBarry Smith 2979c8a0d604SMatthew G Knepley $ For the Schur complement preconditioner if J = ( A00 A01 ) 2980c8a0d604SMatthew G Knepley $ ( A10 A11 ) 2981c8a0d604SMatthew G Knepley $ the preconditioner using full factorization is 298213b05affSJed Brown $ ( I -ksp(A00) A01 ) ( inv(A00) 0 ) ( I 0 ) 2983c8a0d604SMatthew G Knepley $ ( 0 I ) ( 0 ksp(S) ) ( -A10 ksp(A00) I ) 298413b05affSJed Brown where the action of inv(A00) is applied using the KSP solver with prefix -fieldsplit_0_. S is the Schur complement 298513b05affSJed Brown $ S = A11 - A10 ksp(A00) A01 298613b05affSJed 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 2987686bed4dSStefano Zampini in providing the SECOND split or 1 if not give). For PCFieldSplitGetSubKSP() when field number is 0, 2988c8a0d604SMatthew G Knepley it returns the KSP associated with -fieldsplit_0_ while field number 1 gives -fieldsplit_1_ KSP. By default 2989a6a584a2SBarry Smith A11 is used to construct a preconditioner for S, use PCFieldSplitSetSchurPre() for all the possible ways to construct the preconditioner for S. 29901d71051fSDmitry Karpeev 2991a7476a74SDmitry Karpeev The factorization type is set using -pc_fieldsplit_schur_fact_type <diag, lower, upper, full>. The full is shown above, 29925668aaf4SBarry Smith diag gives 2993c8a0d604SMatthew G Knepley $ ( inv(A00) 0 ) 2994c8a0d604SMatthew G Knepley $ ( 0 -ksp(S) ) 2995c096484dSStefano 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 2996c096484dSStefano Zampini can be turned off with PCFieldSplitSetSchurScale() or by command line -pc_fieldsplit_schur_scale 1.0. The lower factorization is the inverse of 2997c8a0d604SMatthew G Knepley $ ( A00 0 ) 2998c8a0d604SMatthew G Knepley $ ( A10 S ) 2999c8a0d604SMatthew G Knepley where the inverses of A00 and S are applied using KSPs. The upper factorization is the inverse of 3000c8a0d604SMatthew G Knepley $ ( A00 A01 ) 3001c8a0d604SMatthew G Knepley $ ( 0 S ) 3002c8a0d604SMatthew G Knepley where again the inverses of A00 and S are applied using KSPs. 3003e69d4d44SBarry Smith 3004edf189efSBarry Smith If only one set of indices (one IS) is provided with PCFieldSplitSetIS() then the complement of that IS 3005edf189efSBarry Smith is used automatically for a second block. 3006edf189efSBarry Smith 3007ff218e97SBarry Smith The fieldsplit preconditioner cannot currently be used with the BAIJ or SBAIJ data formats if the blocksize is larger than 1. 3008ff218e97SBarry Smith Generally it should be used with the AIJ format. 3009ff218e97SBarry Smith 3010ff218e97SBarry Smith The forms of these preconditioners are closely related if not identical to forms derived as "Distributive Iterations", see, 3011ff218e97SBarry Smith for example, page 294 in "Principles of Computational Fluid Dynamics" by Pieter Wesseling. Note that one can also use PCFIELDSPLIT 3012ff218e97SBarry Smith inside a smoother resulting in "Distributive Smoothers". 30130716a85fSBarry Smith 3014a541d17aSBarry Smith Concepts: physics based preconditioners, block preconditioners 30150971522cSBarry Smith 30163bc631e0SBarry Smith There is a nice discussion of block preconditioners in 30173bc631e0SBarry Smith 30183bc631e0SBarry Smith [El08] A taxonomy and comparison of parallel block multi-level preconditioners for the incompressible Navier-Stokes equations 30193bc631e0SBarry Smith Howard Elman, V.E. Howle, John Shadid, Robert Shuttleworth, Ray Tuminaro, Journal of Computational Physics 227 (2008) 1790--1808 30203bc631e0SBarry Smith http://chess.cs.umd.edu/~elman/papers/tax.pdf 30213bc631e0SBarry Smith 30224d308398SBarry Smith The Constrained Pressure Preconditioner (CPR) can be implemented using PCCOMPOSITE with PCGALERKIN. CPR first solves an R A P subsystem, updates the 30234d308398SBarry Smith residual on all variables (PCCompositeSetType(pc,PC_COMPOSITE_MULTIPLICATIVE)), and then applies a simple ILU like preconditioner on all the variables. 3024a6a584a2SBarry Smith 3025a51937d4SCarola Kruse The Golub-Kahan bidiagonalization preconditioner (gkb) can be applied to symmetric 2x2 block matrices of the shape 3026a51937d4SCarola Kruse $ ( A00 A01 ) 3027a51937d4SCarola Kruse $ ( A01' 0 ) 3028a51937d4SCarola 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'. 3029a51937d4SCarola Kruse A linear system Hx = b has to be solved in each iteration of the GKB algorithm. The solver is chosen with the option prefix -fieldsplit_0_. 3030a51937d4SCarola Kruse 3031a51937d4SCarola Kruse [Ar13] Generalized Golub-Kahan bidiagonalization and stopping criteria, SIAM J. Matrix Anal. Appl., Vol. 34, No. 2, pp. 571-592, 2013. 3032a51937d4SCarola Kruse 30337e8cb189SBarry Smith .seealso: PCCreate(), PCSetType(), PCType (for list of available types), PC, Block_Preconditioners, PCLSC, 3034285fb4e2SStefano Zampini PCFieldSplitGetSubKSP(), PCFieldSplitSchurGetSubKSP(), PCFieldSplitSetFields(), PCFieldSplitSetType(), PCFieldSplitSetIS(), PCFieldSplitSetSchurPre(), 30357b752e3dSPatrick Sanan MatSchurComplementSetAinvType(), PCFieldSplitSetSchurScale(), 30367b752e3dSPatrick Sanan PCFieldSplitSetDetectSaddlePoint() 30370971522cSBarry Smith M*/ 30380971522cSBarry Smith 30398cc058d9SJed Brown PETSC_EXTERN PetscErrorCode PCCreate_FieldSplit(PC pc) 30400971522cSBarry Smith { 30410971522cSBarry Smith PetscErrorCode ierr; 30420971522cSBarry Smith PC_FieldSplit *jac; 30430971522cSBarry Smith 30440971522cSBarry Smith PetscFunctionBegin; 3045b00a9115SJed Brown ierr = PetscNewLog(pc,&jac);CHKERRQ(ierr); 30462fa5cd67SKarl Rupp 30470971522cSBarry Smith jac->bs = -1; 30480971522cSBarry Smith jac->nsplits = 0; 30493e197d65SBarry Smith jac->type = PC_COMPOSITE_MULTIPLICATIVE; 3050e6cab6aaSJed Brown jac->schurpre = PC_FIELDSPLIT_SCHUR_PRE_USER; /* Try user preconditioner first, fall back on diagonal */ 3051c9c6ffaaSJed Brown jac->schurfactorization = PC_FIELDSPLIT_SCHUR_FACT_FULL; 3052c096484dSStefano Zampini jac->schurscale = -1.0; 3053fbe7908bSJed Brown jac->dm_splits = PETSC_TRUE; 30547b752e3dSPatrick Sanan jac->detect = PETSC_FALSE; 3055a51937d4SCarola Kruse jac->gkbtol = 1e-5; 3056a51937d4SCarola Kruse jac->gkbdelay = 5; 3057a51937d4SCarola Kruse jac->gkbnu = 1; 3058a51937d4SCarola Kruse jac->gkbmaxit = 100; 305951f519a2SBarry Smith 30600971522cSBarry Smith pc->data = (void*)jac; 30610971522cSBarry Smith 30620971522cSBarry Smith pc->ops->apply = PCApply_FieldSplit; 3063421e10b8SBarry Smith pc->ops->applytranspose = PCApplyTranspose_FieldSplit; 30640971522cSBarry Smith pc->ops->setup = PCSetUp_FieldSplit; 3065574deadeSBarry Smith pc->ops->reset = PCReset_FieldSplit; 30660971522cSBarry Smith pc->ops->destroy = PCDestroy_FieldSplit; 30670971522cSBarry Smith pc->ops->setfromoptions = PCSetFromOptions_FieldSplit; 30680971522cSBarry Smith pc->ops->view = PCView_FieldSplit; 30690971522cSBarry Smith pc->ops->applyrichardson = 0; 30700971522cSBarry Smith 3071285fb4e2SStefano Zampini ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSchurGetSubKSP_C",PCFieldSplitSchurGetSubKSP_FieldSplit);CHKERRQ(ierr); 3072bdf89e91SBarry Smith ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitGetSubKSP_C",PCFieldSplitGetSubKSP_FieldSplit);CHKERRQ(ierr); 3073bdf89e91SBarry Smith ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetFields_C",PCFieldSplitSetFields_FieldSplit);CHKERRQ(ierr); 3074bdf89e91SBarry Smith ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetIS_C",PCFieldSplitSetIS_FieldSplit);CHKERRQ(ierr); 3075bdf89e91SBarry Smith ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetType_C",PCFieldSplitSetType_FieldSplit);CHKERRQ(ierr); 3076bdf89e91SBarry Smith ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetBlockSize_C",PCFieldSplitSetBlockSize_FieldSplit);CHKERRQ(ierr); 30776dbb499eSCian Wilson ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitRestrictIS_C",PCFieldSplitRestrictIS_FieldSplit);CHKERRQ(ierr); 30780971522cSBarry Smith PetscFunctionReturn(0); 30790971522cSBarry Smith } 3080