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 4997bbdb24SBarry Smith PC_FieldSplitLink head; 506dbb499eSCian Wilson PetscBool isrestrict; /* indicates PCFieldSplitRestrictIS() has been last called on this object, hack */ 51c1570756SJed Brown PetscBool suboptionsset; /* Indicates that the KSPSetFromOptions() has been called on the sub-KSPs */ 524ab8060aSDmitry Karpeev PetscBool dm_splits; /* Whether to use DMCreateFieldDecomposition() whenever possible */ 53c84da90fSDmitry Karpeev PetscBool diag_use_amat; /* Whether to extract diagonal matrix blocks from Amat, rather than Pmat (weaker than -pc_use_amat) */ 54c84da90fSDmitry Karpeev PetscBool offdiag_use_amat; /* Whether to extract off-diagonal matrix blocks from Amat, rather than Pmat (weaker than -pc_use_amat) */ 557b752e3dSPatrick Sanan PetscBool detect; /* Whether to form 2-way split by finding zero diagonal entries */ 560971522cSBarry Smith } PC_FieldSplit; 570971522cSBarry Smith 5816913363SBarry Smith /* 5995452b02SPatrick Sanan Notes: 6095452b02SPatrick Sanan there is no particular reason that pmat, x, and y are stored as arrays in PC_FieldSplit instead of 6116913363SBarry Smith inside PC_FieldSplitLink, just historical. If you want to be able to add new fields after already using the 6216913363SBarry Smith PC you could change this. 6316913363SBarry Smith */ 64084e4875SJed Brown 65e6cab6aaSJed Brown /* This helper is so that setting a user-provided preconditioning matrix is orthogonal to choosing to use it. This way the 66084e4875SJed Brown * application-provided FormJacobian can provide this matrix without interfering with the user's (command-line) choices. */ 67084e4875SJed Brown static Mat FieldSplitSchurPre(PC_FieldSplit *jac) 68084e4875SJed Brown { 69084e4875SJed Brown switch (jac->schurpre) { 70084e4875SJed Brown case PC_FIELDSPLIT_SCHUR_PRE_SELF: return jac->schur; 71a7476a74SDmitry Karpeev case PC_FIELDSPLIT_SCHUR_PRE_SELFP: return jac->schurp; 72e87fab1bSBarry Smith case PC_FIELDSPLIT_SCHUR_PRE_A11: return jac->pmat[1]; 73e74569cdSMatthew G. Knepley case PC_FIELDSPLIT_SCHUR_PRE_FULL: /* We calculate this and store it in schur_user */ 74084e4875SJed Brown case PC_FIELDSPLIT_SCHUR_PRE_USER: /* Use a user-provided matrix if it is given, otherwise diagonal block */ 75084e4875SJed Brown default: 76084e4875SJed Brown return jac->schur_user ? jac->schur_user : jac->pmat[1]; 77084e4875SJed Brown } 78084e4875SJed Brown } 79084e4875SJed Brown 80084e4875SJed Brown 819804daf3SBarry Smith #include <petscdraw.h> 820971522cSBarry Smith static PetscErrorCode PCView_FieldSplit(PC pc,PetscViewer viewer) 830971522cSBarry Smith { 840971522cSBarry Smith PC_FieldSplit *jac = (PC_FieldSplit*)pc->data; 850971522cSBarry Smith PetscErrorCode ierr; 86d9884438SBarry Smith PetscBool iascii,isdraw; 870971522cSBarry Smith PetscInt i,j; 885a9f2f41SSatish Balay PC_FieldSplitLink ilink = jac->head; 890971522cSBarry Smith 900971522cSBarry Smith PetscFunctionBegin; 91251f4c67SDmitry Karpeev ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&iascii);CHKERRQ(ierr); 92d9884438SBarry Smith ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERDRAW,&isdraw);CHKERRQ(ierr); 930971522cSBarry Smith if (iascii) { 942c9966d7SBarry Smith if (jac->bs > 0) { 9551f519a2SBarry Smith ierr = PetscViewerASCIIPrintf(viewer," FieldSplit with %s composition: total splits = %D, blocksize = %D\n",PCCompositeTypes[jac->type],jac->nsplits,jac->bs);CHKERRQ(ierr); 962c9966d7SBarry Smith } else { 972c9966d7SBarry Smith ierr = PetscViewerASCIIPrintf(viewer," FieldSplit with %s composition: total splits = %D\n",PCCompositeTypes[jac->type],jac->nsplits);CHKERRQ(ierr); 982c9966d7SBarry Smith } 99f5236f50SJed Brown if (pc->useAmat) { 100f5236f50SJed Brown ierr = PetscViewerASCIIPrintf(viewer," using Amat (not Pmat) as operator for blocks\n");CHKERRQ(ierr); 101a3df900dSMatthew G Knepley } 102c84da90fSDmitry Karpeev if (jac->diag_use_amat) { 103c84da90fSDmitry Karpeev ierr = PetscViewerASCIIPrintf(viewer," using Amat (not Pmat) as operator for diagonal blocks\n");CHKERRQ(ierr); 104c84da90fSDmitry Karpeev } 105c84da90fSDmitry Karpeev if (jac->offdiag_use_amat) { 106c84da90fSDmitry Karpeev ierr = PetscViewerASCIIPrintf(viewer," using Amat (not Pmat) as operator for off-diagonal blocks\n");CHKERRQ(ierr); 107c84da90fSDmitry Karpeev } 10869a612a9SBarry Smith ierr = PetscViewerASCIIPrintf(viewer," Solver info for each split is in the following KSP objects:\n");CHKERRQ(ierr); 1090971522cSBarry Smith for (i=0; i<jac->nsplits; i++) { 1101ab39975SBarry Smith if (ilink->fields) { 1110971522cSBarry Smith ierr = PetscViewerASCIIPrintf(viewer,"Split number %D Fields ",i);CHKERRQ(ierr); 11279416396SBarry Smith ierr = PetscViewerASCIIUseTabs(viewer,PETSC_FALSE);CHKERRQ(ierr); 1135a9f2f41SSatish Balay for (j=0; j<ilink->nfields; j++) { 11479416396SBarry Smith if (j > 0) { 11579416396SBarry Smith ierr = PetscViewerASCIIPrintf(viewer,",");CHKERRQ(ierr); 11679416396SBarry Smith } 1175a9f2f41SSatish Balay ierr = PetscViewerASCIIPrintf(viewer," %D",ilink->fields[j]);CHKERRQ(ierr); 1180971522cSBarry Smith } 1190971522cSBarry Smith ierr = PetscViewerASCIIPrintf(viewer,"\n");CHKERRQ(ierr); 12079416396SBarry Smith ierr = PetscViewerASCIIUseTabs(viewer,PETSC_TRUE);CHKERRQ(ierr); 1211ab39975SBarry Smith } else { 1221ab39975SBarry Smith ierr = PetscViewerASCIIPrintf(viewer,"Split number %D Defined by IS\n",i);CHKERRQ(ierr); 1231ab39975SBarry Smith } 1245a9f2f41SSatish Balay ierr = KSPView(ilink->ksp,viewer);CHKERRQ(ierr); 1255a9f2f41SSatish Balay ilink = ilink->next; 1260971522cSBarry Smith } 1272fa5cd67SKarl Rupp } 1282fa5cd67SKarl Rupp 1292fa5cd67SKarl Rupp if (isdraw) { 130d9884438SBarry Smith PetscDraw draw; 131d9884438SBarry Smith PetscReal x,y,w,wd; 132d9884438SBarry Smith 133d9884438SBarry Smith ierr = PetscViewerDrawGetDraw(viewer,0,&draw);CHKERRQ(ierr); 134d9884438SBarry Smith ierr = PetscDrawGetCurrentPoint(draw,&x,&y);CHKERRQ(ierr); 135d9884438SBarry Smith w = 2*PetscMin(1.0 - x,x); 136d9884438SBarry Smith wd = w/(jac->nsplits + 1); 137d9884438SBarry Smith x = x - wd*(jac->nsplits-1)/2.0; 138d9884438SBarry Smith for (i=0; i<jac->nsplits; i++) { 139d9884438SBarry Smith ierr = PetscDrawPushCurrentPoint(draw,x,y);CHKERRQ(ierr); 140d9884438SBarry Smith ierr = KSPView(ilink->ksp,viewer);CHKERRQ(ierr); 141d9884438SBarry Smith ierr = PetscDrawPopCurrentPoint(draw);CHKERRQ(ierr); 142d9884438SBarry Smith x += wd; 143d9884438SBarry Smith ilink = ilink->next; 144d9884438SBarry Smith } 1450971522cSBarry Smith } 1460971522cSBarry Smith PetscFunctionReturn(0); 1470971522cSBarry Smith } 1480971522cSBarry Smith 1493b224e63SBarry Smith static PetscErrorCode PCView_FieldSplit_Schur(PC pc,PetscViewer viewer) 1503b224e63SBarry Smith { 1513b224e63SBarry Smith PC_FieldSplit *jac = (PC_FieldSplit*)pc->data; 1523b224e63SBarry Smith PetscErrorCode ierr; 1534996c5bdSBarry Smith PetscBool iascii,isdraw; 1543b224e63SBarry Smith PetscInt i,j; 1553b224e63SBarry Smith PC_FieldSplitLink ilink = jac->head; 156a9908d51SBarry Smith MatSchurComplementAinvType atype; 1573b224e63SBarry Smith 1583b224e63SBarry Smith PetscFunctionBegin; 159251f4c67SDmitry Karpeev ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&iascii);CHKERRQ(ierr); 1604996c5bdSBarry Smith ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERDRAW,&isdraw);CHKERRQ(ierr); 1613b224e63SBarry Smith if (iascii) { 1622c9966d7SBarry Smith if (jac->bs > 0) { 163c9c6ffaaSJed Brown ierr = PetscViewerASCIIPrintf(viewer," FieldSplit with Schur preconditioner, blocksize = %D, factorization %s\n",jac->bs,PCFieldSplitSchurFactTypes[jac->schurfactorization]);CHKERRQ(ierr); 1642c9966d7SBarry Smith } else { 1652c9966d7SBarry Smith ierr = PetscViewerASCIIPrintf(viewer," FieldSplit with Schur preconditioner, factorization %s\n",PCFieldSplitSchurFactTypes[jac->schurfactorization]);CHKERRQ(ierr); 1662c9966d7SBarry Smith } 167f5236f50SJed Brown if (pc->useAmat) { 168f5236f50SJed Brown ierr = PetscViewerASCIIPrintf(viewer," using Amat (not Pmat) as operator for blocks\n");CHKERRQ(ierr); 169a3df900dSMatthew G Knepley } 1703e8b8b31SMatthew G Knepley switch (jac->schurpre) { 1713e8b8b31SMatthew G Knepley case PC_FIELDSPLIT_SCHUR_PRE_SELF: 172a9908d51SBarry Smith ierr = PetscViewerASCIIPrintf(viewer," Preconditioner for the Schur complement formed from S itself\n");CHKERRQ(ierr); 173a9908d51SBarry Smith break; 174a7476a74SDmitry Karpeev case PC_FIELDSPLIT_SCHUR_PRE_SELFP: 175a9908d51SBarry Smith ierr = MatSchurComplementGetAinvType(jac->schur,&atype);CHKERRQ(ierr); 176d0a9c1a2SBarry 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; 177e87fab1bSBarry Smith case PC_FIELDSPLIT_SCHUR_PRE_A11: 178a9908d51SBarry Smith ierr = PetscViewerASCIIPrintf(viewer," Preconditioner for the Schur complement formed from A11\n");CHKERRQ(ierr); 179a9908d51SBarry Smith break; 180e74569cdSMatthew G. Knepley case PC_FIELDSPLIT_SCHUR_PRE_FULL: 181a9908d51SBarry Smith ierr = PetscViewerASCIIPrintf(viewer," Preconditioner for the Schur complement formed from the exact Schur complement\n");CHKERRQ(ierr); 182a9908d51SBarry Smith break; 1833e8b8b31SMatthew G Knepley case PC_FIELDSPLIT_SCHUR_PRE_USER: 1843e8b8b31SMatthew G Knepley if (jac->schur_user) { 1853e8b8b31SMatthew G Knepley ierr = PetscViewerASCIIPrintf(viewer," Preconditioner for the Schur complement formed from user provided matrix\n");CHKERRQ(ierr); 1863e8b8b31SMatthew G Knepley } else { 187e87fab1bSBarry Smith ierr = PetscViewerASCIIPrintf(viewer," Preconditioner for the Schur complement formed from A11\n");CHKERRQ(ierr); 1883e8b8b31SMatthew G Knepley } 1893e8b8b31SMatthew G Knepley break; 1903e8b8b31SMatthew G Knepley default: 19182f516ccSBarry Smith SETERRQ1(PetscObjectComm((PetscObject)pc), PETSC_ERR_ARG_OUTOFRANGE, "Invalid Schur preconditioning type: %d", jac->schurpre); 1923e8b8b31SMatthew G Knepley } 1933b224e63SBarry Smith ierr = PetscViewerASCIIPrintf(viewer," Split info:\n");CHKERRQ(ierr); 1943b224e63SBarry Smith ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr); 1953b224e63SBarry Smith for (i=0; i<jac->nsplits; i++) { 1963b224e63SBarry Smith if (ilink->fields) { 1973b224e63SBarry Smith ierr = PetscViewerASCIIPrintf(viewer,"Split number %D Fields ",i);CHKERRQ(ierr); 1983b224e63SBarry Smith ierr = PetscViewerASCIIUseTabs(viewer,PETSC_FALSE);CHKERRQ(ierr); 1993b224e63SBarry Smith for (j=0; j<ilink->nfields; j++) { 2003b224e63SBarry Smith if (j > 0) { 2013b224e63SBarry Smith ierr = PetscViewerASCIIPrintf(viewer,",");CHKERRQ(ierr); 2023b224e63SBarry Smith } 2033b224e63SBarry Smith ierr = PetscViewerASCIIPrintf(viewer," %D",ilink->fields[j]);CHKERRQ(ierr); 2043b224e63SBarry Smith } 2053b224e63SBarry Smith ierr = PetscViewerASCIIPrintf(viewer,"\n");CHKERRQ(ierr); 2063b224e63SBarry Smith ierr = PetscViewerASCIIUseTabs(viewer,PETSC_TRUE);CHKERRQ(ierr); 2073b224e63SBarry Smith } else { 2083b224e63SBarry Smith ierr = PetscViewerASCIIPrintf(viewer,"Split number %D Defined by IS\n",i);CHKERRQ(ierr); 2093b224e63SBarry Smith } 2103b224e63SBarry Smith ilink = ilink->next; 2113b224e63SBarry Smith } 212435f959eSBarry Smith ierr = PetscViewerASCIIPrintf(viewer,"KSP solver for A00 block\n");CHKERRQ(ierr); 2133b224e63SBarry Smith ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr); 21406de4afeSJed Brown if (jac->head) { 215443836d0SMatthew G Knepley ierr = KSPView(jac->head->ksp,viewer);CHKERRQ(ierr); 21606de4afeSJed Brown } else {ierr = PetscViewerASCIIPrintf(viewer," not yet available\n");CHKERRQ(ierr);} 2173b224e63SBarry Smith ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr); 21806de4afeSJed Brown if (jac->head && jac->kspupper != jac->head->ksp) { 219443836d0SMatthew G Knepley ierr = PetscViewerASCIIPrintf(viewer,"KSP solver for upper A00 in upper triangular factor \n");CHKERRQ(ierr); 220443836d0SMatthew G Knepley ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr); 221b2750c55SJed Brown if (jac->kspupper) {ierr = KSPView(jac->kspupper,viewer);CHKERRQ(ierr);} 222b2750c55SJed Brown else {ierr = PetscViewerASCIIPrintf(viewer," not yet available\n");CHKERRQ(ierr);} 223443836d0SMatthew G Knepley ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr); 224443836d0SMatthew G Knepley } 225435f959eSBarry Smith ierr = PetscViewerASCIIPrintf(viewer,"KSP solver for S = A11 - A10 inv(A00) A01 \n");CHKERRQ(ierr); 2263b224e63SBarry Smith ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr); 22712cae6f2SJed Brown if (jac->kspschur) { 2283b224e63SBarry Smith ierr = KSPView(jac->kspschur,viewer);CHKERRQ(ierr); 22912cae6f2SJed Brown } else { 23012cae6f2SJed Brown ierr = PetscViewerASCIIPrintf(viewer," not yet available\n");CHKERRQ(ierr); 23112cae6f2SJed Brown } 2323b224e63SBarry Smith ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr); 2333b224e63SBarry Smith ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr); 23406de4afeSJed Brown } else if (isdraw && jac->head) { 2354996c5bdSBarry Smith PetscDraw draw; 2364996c5bdSBarry Smith PetscReal x,y,w,wd,h; 2374996c5bdSBarry Smith PetscInt cnt = 2; 2384996c5bdSBarry Smith char str[32]; 2394996c5bdSBarry Smith 2404996c5bdSBarry Smith ierr = PetscViewerDrawGetDraw(viewer,0,&draw);CHKERRQ(ierr); 2414996c5bdSBarry Smith ierr = PetscDrawGetCurrentPoint(draw,&x,&y);CHKERRQ(ierr); 242c74581afSBarry Smith if (jac->kspupper != jac->head->ksp) cnt++; 243c74581afSBarry Smith w = 2*PetscMin(1.0 - x,x); 244c74581afSBarry Smith wd = w/(cnt + 1); 245c74581afSBarry Smith 2464996c5bdSBarry Smith ierr = PetscSNPrintf(str,32,"Schur fact. %s",PCFieldSplitSchurFactTypes[jac->schurfactorization]);CHKERRQ(ierr); 24751fa3d41SBarry Smith ierr = PetscDrawStringBoxed(draw,x,y,PETSC_DRAW_RED,PETSC_DRAW_BLACK,str,NULL,&h);CHKERRQ(ierr); 2484996c5bdSBarry Smith y -= h; 2494996c5bdSBarry Smith if (jac->schurpre == PC_FIELDSPLIT_SCHUR_PRE_USER && !jac->schur_user) { 250e87fab1bSBarry Smith ierr = PetscSNPrintf(str,32,"Prec. for Schur from %s",PCFieldSplitSchurPreTypes[PC_FIELDSPLIT_SCHUR_PRE_A11]);CHKERRQ(ierr); 2513b224e63SBarry Smith } else { 2524996c5bdSBarry Smith ierr = PetscSNPrintf(str,32,"Prec. for Schur from %s",PCFieldSplitSchurPreTypes[jac->schurpre]);CHKERRQ(ierr); 2534996c5bdSBarry Smith } 25451fa3d41SBarry Smith ierr = PetscDrawStringBoxed(draw,x+wd*(cnt-1)/2.0,y,PETSC_DRAW_RED,PETSC_DRAW_BLACK,str,NULL,&h);CHKERRQ(ierr); 2554996c5bdSBarry Smith y -= h; 2564996c5bdSBarry Smith x = x - wd*(cnt-1)/2.0; 2574996c5bdSBarry Smith 2584996c5bdSBarry Smith ierr = PetscDrawPushCurrentPoint(draw,x,y);CHKERRQ(ierr); 2594996c5bdSBarry Smith ierr = KSPView(jac->head->ksp,viewer);CHKERRQ(ierr); 2604996c5bdSBarry Smith ierr = PetscDrawPopCurrentPoint(draw);CHKERRQ(ierr); 2614996c5bdSBarry Smith if (jac->kspupper != jac->head->ksp) { 2624996c5bdSBarry Smith x += wd; 2634996c5bdSBarry Smith ierr = PetscDrawPushCurrentPoint(draw,x,y);CHKERRQ(ierr); 2644996c5bdSBarry Smith ierr = KSPView(jac->kspupper,viewer);CHKERRQ(ierr); 2654996c5bdSBarry Smith ierr = PetscDrawPopCurrentPoint(draw);CHKERRQ(ierr); 2664996c5bdSBarry Smith } 2674996c5bdSBarry Smith x += wd; 2684996c5bdSBarry Smith ierr = PetscDrawPushCurrentPoint(draw,x,y);CHKERRQ(ierr); 2694996c5bdSBarry Smith ierr = KSPView(jac->kspschur,viewer);CHKERRQ(ierr); 2704996c5bdSBarry Smith ierr = PetscDrawPopCurrentPoint(draw);CHKERRQ(ierr); 2713b224e63SBarry Smith } 2723b224e63SBarry Smith PetscFunctionReturn(0); 2733b224e63SBarry Smith } 2743b224e63SBarry Smith 2756c924f48SJed Brown /* Precondition: jac->bs is set to a meaningful value */ 2766c924f48SJed Brown static PetscErrorCode PCFieldSplitSetRuntimeSplits_Private(PC pc) 2776c924f48SJed Brown { 2786c924f48SJed Brown PetscErrorCode ierr; 2796c924f48SJed Brown PC_FieldSplit *jac = (PC_FieldSplit*)pc->data; 2805d4c12cdSJungho Lee PetscInt i,nfields,*ifields,nfields_col,*ifields_col; 2815d4c12cdSJungho Lee PetscBool flg,flg_col; 2825d4c12cdSJungho Lee char optionname[128],splitname[8],optionname_col[128]; 2836c924f48SJed Brown 2846c924f48SJed Brown PetscFunctionBegin; 285785e854fSJed Brown ierr = PetscMalloc1(jac->bs,&ifields);CHKERRQ(ierr); 286785e854fSJed Brown ierr = PetscMalloc1(jac->bs,&ifields_col);CHKERRQ(ierr); 2876c924f48SJed Brown for (i=0,flg=PETSC_TRUE;; i++) { 2888caf3d72SBarry Smith ierr = PetscSNPrintf(splitname,sizeof(splitname),"%D",i);CHKERRQ(ierr); 2898caf3d72SBarry Smith ierr = PetscSNPrintf(optionname,sizeof(optionname),"-pc_fieldsplit_%D_fields",i);CHKERRQ(ierr); 2908caf3d72SBarry Smith ierr = PetscSNPrintf(optionname_col,sizeof(optionname_col),"-pc_fieldsplit_%D_fields_col",i);CHKERRQ(ierr); 2916c924f48SJed Brown nfields = jac->bs; 29229499fbbSJungho Lee nfields_col = jac->bs; 293c5929fdfSBarry Smith ierr = PetscOptionsGetIntArray(((PetscObject)pc)->options,((PetscObject)pc)->prefix,optionname,ifields,&nfields,&flg);CHKERRQ(ierr); 294c5929fdfSBarry Smith ierr = PetscOptionsGetIntArray(((PetscObject)pc)->options,((PetscObject)pc)->prefix,optionname_col,ifields_col,&nfields_col,&flg_col);CHKERRQ(ierr); 2956c924f48SJed Brown if (!flg) break; 2965d4c12cdSJungho Lee else if (flg && !flg_col) { 2975d4c12cdSJungho Lee if (!nfields) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_USER,"Cannot list zero fields"); 2985d4c12cdSJungho Lee ierr = PCFieldSplitSetFields(pc,splitname,nfields,ifields,ifields);CHKERRQ(ierr); 2992fa5cd67SKarl Rupp } else { 3005d4c12cdSJungho Lee if (!nfields || !nfields_col) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_USER,"Cannot list zero fields"); 3015d4c12cdSJungho Lee if (nfields != nfields_col) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_USER,"Number of row and column fields must match"); 3025d4c12cdSJungho Lee ierr = PCFieldSplitSetFields(pc,splitname,nfields,ifields,ifields_col);CHKERRQ(ierr); 3035d4c12cdSJungho Lee } 3046c924f48SJed Brown } 3056c924f48SJed Brown if (i > 0) { 3066c924f48SJed Brown /* Makes command-line setting of splits take precedence over setting them in code. 3076c924f48SJed Brown Otherwise subsequent calls to PCFieldSplitSetIS() or PCFieldSplitSetFields() would 3086c924f48SJed Brown create new splits, which would probably not be what the user wanted. */ 3096c924f48SJed Brown jac->splitdefined = PETSC_TRUE; 3106c924f48SJed Brown } 3116c924f48SJed Brown ierr = PetscFree(ifields);CHKERRQ(ierr); 3125d4c12cdSJungho Lee ierr = PetscFree(ifields_col);CHKERRQ(ierr); 3136c924f48SJed Brown PetscFunctionReturn(0); 3146c924f48SJed Brown } 3156c924f48SJed Brown 31669a612a9SBarry Smith static PetscErrorCode PCFieldSplitSetDefaults(PC pc) 3170971522cSBarry Smith { 3180971522cSBarry Smith PC_FieldSplit *jac = (PC_FieldSplit*)pc->data; 3190971522cSBarry Smith PetscErrorCode ierr; 3205a9f2f41SSatish Balay PC_FieldSplitLink ilink = jac->head; 3217b752e3dSPatrick Sanan PetscBool fieldsplit_default = PETSC_FALSE,coupling = PETSC_FALSE; 3226c924f48SJed Brown PetscInt i; 3230971522cSBarry Smith 3240971522cSBarry Smith PetscFunctionBegin; 3257287d2a3SDmitry Karpeev /* 326f5f0d762SBarry Smith Kinda messy, but at least this now uses DMCreateFieldDecomposition(). 3277287d2a3SDmitry Karpeev Should probably be rewritten. 3287287d2a3SDmitry Karpeev */ 329f5f0d762SBarry Smith if (!ilink) { 330c5929fdfSBarry Smith ierr = PetscOptionsGetBool(((PetscObject)pc)->options,((PetscObject)pc)->prefix,"-pc_fieldsplit_detect_coupling",&coupling,NULL);CHKERRQ(ierr); 3317b752e3dSPatrick Sanan if (pc->dm && jac->dm_splits && !jac->detect && !coupling) { 332bafc1b83SMatthew G Knepley PetscInt numFields, f, i, j; 3330784a22cSJed Brown char **fieldNames; 3347b62db95SJungho Lee IS *fields; 335e7c4fc90SDmitry Karpeev DM *dms; 336bafc1b83SMatthew G Knepley DM subdm[128]; 337bafc1b83SMatthew G Knepley PetscBool flg; 338bafc1b83SMatthew G Knepley 33916621825SDmitry Karpeev ierr = DMCreateFieldDecomposition(pc->dm, &numFields, &fieldNames, &fields, &dms);CHKERRQ(ierr); 340bafc1b83SMatthew G Knepley /* Allow the user to prescribe the splits */ 341bafc1b83SMatthew G Knepley for (i = 0, flg = PETSC_TRUE;; i++) { 342bafc1b83SMatthew G Knepley PetscInt ifields[128]; 343bafc1b83SMatthew G Knepley IS compField; 344bafc1b83SMatthew G Knepley char optionname[128], splitname[8]; 345bafc1b83SMatthew G Knepley PetscInt nfields = numFields; 346bafc1b83SMatthew G Knepley 3478caf3d72SBarry Smith ierr = PetscSNPrintf(optionname, sizeof(optionname), "-pc_fieldsplit_%D_fields", i);CHKERRQ(ierr); 348c5929fdfSBarry Smith ierr = PetscOptionsGetIntArray(((PetscObject)pc)->options,((PetscObject)pc)->prefix, optionname, ifields, &nfields, &flg);CHKERRQ(ierr); 349bafc1b83SMatthew G Knepley if (!flg) break; 35082f516ccSBarry Smith if (numFields > 128) SETERRQ1(PetscObjectComm((PetscObject)pc),PETSC_ERR_SUP,"Cannot currently support %d > 128 fields", numFields); 351bafc1b83SMatthew G Knepley ierr = DMCreateSubDM(pc->dm, nfields, ifields, &compField, &subdm[i]);CHKERRQ(ierr); 352bafc1b83SMatthew G Knepley if (nfields == 1) { 353bafc1b83SMatthew G Knepley ierr = PCFieldSplitSetIS(pc, fieldNames[ifields[0]], compField);CHKERRQ(ierr); 354bafc1b83SMatthew G Knepley } else { 3558caf3d72SBarry Smith ierr = PetscSNPrintf(splitname, sizeof(splitname), "%D", i);CHKERRQ(ierr); 356bafc1b83SMatthew G Knepley ierr = PCFieldSplitSetIS(pc, splitname, compField);CHKERRQ(ierr); 3577287d2a3SDmitry Karpeev } 358bafc1b83SMatthew G Knepley ierr = ISDestroy(&compField);CHKERRQ(ierr); 359bafc1b83SMatthew G Knepley for (j = 0; j < nfields; ++j) { 360bafc1b83SMatthew G Knepley f = ifields[j]; 3617b62db95SJungho Lee ierr = PetscFree(fieldNames[f]);CHKERRQ(ierr); 3627b62db95SJungho Lee ierr = ISDestroy(&fields[f]);CHKERRQ(ierr); 3637b62db95SJungho Lee } 364bafc1b83SMatthew G Knepley } 365bafc1b83SMatthew G Knepley if (i == 0) { 366bafc1b83SMatthew G Knepley for (f = 0; f < numFields; ++f) { 367bafc1b83SMatthew G Knepley ierr = PCFieldSplitSetIS(pc, fieldNames[f], fields[f]);CHKERRQ(ierr); 368bafc1b83SMatthew G Knepley ierr = PetscFree(fieldNames[f]);CHKERRQ(ierr); 369bafc1b83SMatthew G Knepley ierr = ISDestroy(&fields[f]);CHKERRQ(ierr); 370bafc1b83SMatthew G Knepley } 371bafc1b83SMatthew G Knepley } else { 372d724dfffSBarry Smith for (j=0; j<numFields; j++) { 373d724dfffSBarry Smith ierr = DMDestroy(dms+j);CHKERRQ(ierr); 374d724dfffSBarry Smith } 375d724dfffSBarry Smith ierr = PetscFree(dms);CHKERRQ(ierr); 376785e854fSJed Brown ierr = PetscMalloc1(i, &dms);CHKERRQ(ierr); 3772fa5cd67SKarl Rupp for (j = 0; j < i; ++j) dms[j] = subdm[j]; 378bafc1b83SMatthew G Knepley } 3797b62db95SJungho Lee ierr = PetscFree(fieldNames);CHKERRQ(ierr); 3807b62db95SJungho Lee ierr = PetscFree(fields);CHKERRQ(ierr); 381e7c4fc90SDmitry Karpeev if (dms) { 3828b8307b2SJed Brown ierr = PetscInfo(pc, "Setting up physics based fieldsplit preconditioner using the embedded DM\n");CHKERRQ(ierr); 383bafc1b83SMatthew G Knepley for (ilink = jac->head, i = 0; ilink; ilink = ilink->next, ++i) { 3847287d2a3SDmitry Karpeev const char *prefix; 3857287d2a3SDmitry Karpeev ierr = PetscObjectGetOptionsPrefix((PetscObject)(ilink->ksp),&prefix);CHKERRQ(ierr); 3867287d2a3SDmitry Karpeev ierr = PetscObjectSetOptionsPrefix((PetscObject)(dms[i]), prefix);CHKERRQ(ierr); 3877b62db95SJungho Lee ierr = KSPSetDM(ilink->ksp, dms[i]);CHKERRQ(ierr); 3887b62db95SJungho Lee ierr = KSPSetDMActive(ilink->ksp, PETSC_FALSE);CHKERRQ(ierr); 3897287d2a3SDmitry Karpeev ierr = PetscObjectIncrementTabLevel((PetscObject)dms[i],(PetscObject)ilink->ksp,0);CHKERRQ(ierr); 390e7c4fc90SDmitry Karpeev ierr = DMDestroy(&dms[i]);CHKERRQ(ierr); 3912fa5ba8aSJed Brown } 3927b62db95SJungho Lee ierr = PetscFree(dms);CHKERRQ(ierr); 3938b8307b2SJed Brown } 39466ffff09SJed Brown } else { 395521d7252SBarry Smith if (jac->bs <= 0) { 396704ba839SBarry Smith if (pc->pmat) { 397521d7252SBarry Smith ierr = MatGetBlockSize(pc->pmat,&jac->bs);CHKERRQ(ierr); 3982fa5cd67SKarl Rupp } else jac->bs = 1; 399521d7252SBarry Smith } 400d32f9abdSBarry Smith 4017b752e3dSPatrick Sanan if (jac->detect) { 4026ce1633cSBarry Smith IS zerodiags,rest; 4036ce1633cSBarry Smith PetscInt nmin,nmax; 4046ce1633cSBarry Smith 4056ce1633cSBarry Smith ierr = MatGetOwnershipRange(pc->mat,&nmin,&nmax);CHKERRQ(ierr); 4066ce1633cSBarry Smith ierr = MatFindZeroDiagonals(pc->mat,&zerodiags);CHKERRQ(ierr); 4076ce1633cSBarry Smith ierr = ISComplement(zerodiags,nmin,nmax,&rest);CHKERRQ(ierr); 4086ce1633cSBarry Smith ierr = PCFieldSplitSetIS(pc,"0",rest);CHKERRQ(ierr); 4096ce1633cSBarry Smith ierr = PCFieldSplitSetIS(pc,"1",zerodiags);CHKERRQ(ierr); 410fcfd50ebSBarry Smith ierr = ISDestroy(&zerodiags);CHKERRQ(ierr); 411fcfd50ebSBarry Smith ierr = ISDestroy(&rest);CHKERRQ(ierr); 4123a062f41SBarry Smith } else if (coupling) { 4133a062f41SBarry Smith IS coupling,rest; 4143a062f41SBarry Smith PetscInt nmin,nmax; 4153a062f41SBarry Smith 4163a062f41SBarry Smith ierr = MatGetOwnershipRange(pc->mat,&nmin,&nmax);CHKERRQ(ierr); 4173a062f41SBarry Smith ierr = MatFindOffBlockDiagonalEntries(pc->mat,&coupling);CHKERRQ(ierr); 4186bea0878SBarry Smith ierr = ISCreateStride(PetscObjectComm((PetscObject)pc->mat),nmax-nmin,nmin,1,&rest);CHKERRQ(ierr); 419e52d2c62SBarry Smith ierr = ISSetIdentity(rest);CHKERRQ(ierr); 420d020c841SBarry Smith ierr = PCFieldSplitSetIS(pc,"0",rest);CHKERRQ(ierr); 421d020c841SBarry Smith ierr = PCFieldSplitSetIS(pc,"1",coupling);CHKERRQ(ierr); 4223a062f41SBarry Smith ierr = ISDestroy(&coupling);CHKERRQ(ierr); 4233a062f41SBarry Smith ierr = ISDestroy(&rest);CHKERRQ(ierr); 4246ce1633cSBarry Smith } else { 425c5929fdfSBarry Smith ierr = PetscOptionsGetBool(((PetscObject)pc)->options,((PetscObject)pc)->prefix,"-pc_fieldsplit_default",&fieldsplit_default,NULL);CHKERRQ(ierr); 4267287d2a3SDmitry Karpeev if (!fieldsplit_default) { 427d32f9abdSBarry Smith /* Allow user to set fields from command line, if bs was known at the time of PCSetFromOptions_FieldSplit() 428d32f9abdSBarry Smith then it is set there. This is not ideal because we should only have options set in XXSetFromOptions(). */ 4296c924f48SJed Brown ierr = PCFieldSplitSetRuntimeSplits_Private(pc);CHKERRQ(ierr); 4306c924f48SJed Brown if (jac->splitdefined) {ierr = PetscInfo(pc,"Splits defined using the options database\n");CHKERRQ(ierr);} 431d32f9abdSBarry Smith } 4326dbb499eSCian Wilson if ((fieldsplit_default || !jac->splitdefined) && !jac->isrestrict) { 433d32f9abdSBarry Smith ierr = PetscInfo(pc,"Using default splitting of fields\n");CHKERRQ(ierr); 434db4c96c1SJed Brown for (i=0; i<jac->bs; i++) { 4356c924f48SJed Brown char splitname[8]; 4368caf3d72SBarry Smith ierr = PetscSNPrintf(splitname,sizeof(splitname),"%D",i);CHKERRQ(ierr); 4375d4c12cdSJungho Lee ierr = PCFieldSplitSetFields(pc,splitname,1,&i,&i);CHKERRQ(ierr); 43879416396SBarry Smith } 4395d4c12cdSJungho Lee jac->defaultsplit = PETSC_TRUE; 440521d7252SBarry Smith } 44166ffff09SJed Brown } 4426ce1633cSBarry Smith } 443edf189efSBarry Smith } else if (jac->nsplits == 1) { 444edf189efSBarry Smith if (ilink->is) { 445edf189efSBarry Smith IS is2; 446edf189efSBarry Smith PetscInt nmin,nmax; 447edf189efSBarry Smith 448edf189efSBarry Smith ierr = MatGetOwnershipRange(pc->mat,&nmin,&nmax);CHKERRQ(ierr); 449edf189efSBarry Smith ierr = ISComplement(ilink->is,nmin,nmax,&is2);CHKERRQ(ierr); 450db4c96c1SJed Brown ierr = PCFieldSplitSetIS(pc,"1",is2);CHKERRQ(ierr); 451fcfd50ebSBarry Smith ierr = ISDestroy(&is2);CHKERRQ(ierr); 45282f516ccSBarry Smith } else SETERRQ(PetscObjectComm((PetscObject)pc),PETSC_ERR_SUP,"Must provide at least two sets of fields to PCFieldSplit()"); 453edf189efSBarry Smith } 454d0af7cd3SBarry Smith 45582f516ccSBarry Smith if (jac->nsplits < 2) SETERRQ1(PetscObjectComm((PetscObject)pc),PETSC_ERR_PLIB,"Unhandled case, must have at least two fields, not %d", jac->nsplits); 45669a612a9SBarry Smith PetscFunctionReturn(0); 45769a612a9SBarry Smith } 45869a612a9SBarry Smith 4592d747510SLisandro Dalcin PETSC_EXTERN PetscErrorCode PetscOptionsFindPairPrefix_Private(PetscOptions,const char pre[], const char name[],const char *value[],PetscBool *flg); 460514bf10dSMatthew G Knepley 46169a612a9SBarry Smith static PetscErrorCode PCSetUp_FieldSplit(PC pc) 46269a612a9SBarry Smith { 46369a612a9SBarry Smith PC_FieldSplit *jac = (PC_FieldSplit*)pc->data; 46469a612a9SBarry Smith PetscErrorCode ierr; 4655a9f2f41SSatish Balay PC_FieldSplitLink ilink; 4662c9966d7SBarry Smith PetscInt i,nsplit; 4675f4ab4e1SJungho Lee PetscBool sorted, sorted_col; 46869a612a9SBarry Smith 46969a612a9SBarry Smith PetscFunctionBegin; 470*5da88fe4STristan Konolige pc->failedreason = PC_NOERROR; 47169a612a9SBarry Smith ierr = PCFieldSplitSetDefaults(pc);CHKERRQ(ierr); 47297bbdb24SBarry Smith nsplit = jac->nsplits; 4735a9f2f41SSatish Balay ilink = jac->head; 47497bbdb24SBarry Smith 47597bbdb24SBarry Smith /* get the matrices for each split */ 476704ba839SBarry Smith if (!jac->issetup) { 4771b9fc7fcSBarry Smith PetscInt rstart,rend,nslots,bs; 47897bbdb24SBarry Smith 479704ba839SBarry Smith jac->issetup = PETSC_TRUE; 480704ba839SBarry Smith 4815d4c12cdSJungho Lee /* This is done here instead of in PCFieldSplitSetFields() because may not have matrix at that point */ 4822c9966d7SBarry Smith if (jac->defaultsplit || !ilink->is) { 4832c9966d7SBarry Smith if (jac->bs <= 0) jac->bs = nsplit; 4842c9966d7SBarry Smith } 48551f519a2SBarry Smith bs = jac->bs; 48697bbdb24SBarry Smith ierr = MatGetOwnershipRange(pc->pmat,&rstart,&rend);CHKERRQ(ierr); 4871b9fc7fcSBarry Smith nslots = (rend - rstart)/bs; 4881b9fc7fcSBarry Smith for (i=0; i<nsplit; i++) { 4891b9fc7fcSBarry Smith if (jac->defaultsplit) { 490ce94432eSBarry Smith ierr = ISCreateStride(PetscObjectComm((PetscObject)pc),nslots,rstart+i,nsplit,&ilink->is);CHKERRQ(ierr); 4915f4ab4e1SJungho Lee ierr = ISDuplicate(ilink->is,&ilink->is_col);CHKERRQ(ierr); 492704ba839SBarry Smith } else if (!ilink->is) { 493ccb205f8SBarry Smith if (ilink->nfields > 1) { 4945f4ab4e1SJungho Lee PetscInt *ii,*jj,j,k,nfields = ilink->nfields,*fields = ilink->fields,*fields_col = ilink->fields_col; 495785e854fSJed Brown ierr = PetscMalloc1(ilink->nfields*nslots,&ii);CHKERRQ(ierr); 496785e854fSJed Brown ierr = PetscMalloc1(ilink->nfields*nslots,&jj);CHKERRQ(ierr); 4971b9fc7fcSBarry Smith for (j=0; j<nslots; j++) { 4981b9fc7fcSBarry Smith for (k=0; k<nfields; k++) { 4991b9fc7fcSBarry Smith ii[nfields*j + k] = rstart + bs*j + fields[k]; 5005f4ab4e1SJungho Lee jj[nfields*j + k] = rstart + bs*j + fields_col[k]; 50197bbdb24SBarry Smith } 50297bbdb24SBarry Smith } 503ce94432eSBarry Smith ierr = ISCreateGeneral(PetscObjectComm((PetscObject)pc),nslots*nfields,ii,PETSC_OWN_POINTER,&ilink->is);CHKERRQ(ierr); 504ce94432eSBarry Smith ierr = ISCreateGeneral(PetscObjectComm((PetscObject)pc),nslots*nfields,jj,PETSC_OWN_POINTER,&ilink->is_col);CHKERRQ(ierr); 50590e68f20SPatrick Farrell ierr = ISSetBlockSize(ilink->is, nfields);CHKERRQ(ierr); 50690e68f20SPatrick Farrell ierr = ISSetBlockSize(ilink->is_col, nfields);CHKERRQ(ierr); 507ccb205f8SBarry Smith } else { 508ce94432eSBarry Smith ierr = ISCreateStride(PetscObjectComm((PetscObject)pc),nslots,rstart+ilink->fields[0],bs,&ilink->is);CHKERRQ(ierr); 509ce94432eSBarry Smith ierr = ISCreateStride(PetscObjectComm((PetscObject)pc),nslots,rstart+ilink->fields_col[0],bs,&ilink->is_col);CHKERRQ(ierr); 510ccb205f8SBarry Smith } 5113e197d65SBarry Smith } 512704ba839SBarry Smith ierr = ISSorted(ilink->is,&sorted);CHKERRQ(ierr); 5135f4ab4e1SJungho Lee if (ilink->is_col) { ierr = ISSorted(ilink->is_col,&sorted_col);CHKERRQ(ierr); } 5145f4ab4e1SJungho Lee if (!sorted || !sorted_col) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_USER,"Fields must be sorted when creating split"); 515704ba839SBarry Smith ilink = ilink->next; 5161b9fc7fcSBarry Smith } 5171b9fc7fcSBarry Smith } 5181b9fc7fcSBarry Smith 519704ba839SBarry Smith ilink = jac->head; 52097bbdb24SBarry Smith if (!jac->pmat) { 521bdddcaaaSMatthew G Knepley Vec xtmp; 522bdddcaaaSMatthew G Knepley 5232a7a6963SBarry Smith ierr = MatCreateVecs(pc->pmat,&xtmp,NULL);CHKERRQ(ierr); 524785e854fSJed Brown ierr = PetscMalloc1(nsplit,&jac->pmat);CHKERRQ(ierr); 525dcca6d9dSJed Brown ierr = PetscMalloc2(nsplit,&jac->x,nsplit,&jac->y);CHKERRQ(ierr); 526cf502942SBarry Smith for (i=0; i<nsplit; i++) { 527bdddcaaaSMatthew G Knepley MatNullSpace sp; 528bdddcaaaSMatthew G Knepley 529a3df900dSMatthew G Knepley /* Check for preconditioning matrix attached to IS */ 530a3df900dSMatthew G Knepley ierr = PetscObjectQuery((PetscObject) ilink->is, "pmat", (PetscObject*) &jac->pmat[i]);CHKERRQ(ierr); 531a3df900dSMatthew G Knepley if (jac->pmat[i]) { 532a3df900dSMatthew G Knepley ierr = PetscObjectReference((PetscObject) jac->pmat[i]);CHKERRQ(ierr); 533a3df900dSMatthew G Knepley if (jac->type == PC_COMPOSITE_SCHUR) { 534a3df900dSMatthew G Knepley jac->schur_user = jac->pmat[i]; 5352fa5cd67SKarl Rupp 536a3df900dSMatthew G Knepley ierr = PetscObjectReference((PetscObject) jac->schur_user);CHKERRQ(ierr); 537a3df900dSMatthew G Knepley } 538a3df900dSMatthew G Knepley } else { 5393a062f41SBarry Smith const char *prefix; 5407dae84e0SHong Zhang ierr = MatCreateSubMatrix(pc->pmat,ilink->is,ilink->is_col,MAT_INITIAL_MATRIX,&jac->pmat[i]);CHKERRQ(ierr); 5413a062f41SBarry Smith ierr = KSPGetOptionsPrefix(ilink->ksp,&prefix);CHKERRQ(ierr); 5423a062f41SBarry Smith ierr = MatSetOptionsPrefix(jac->pmat[i],prefix);CHKERRQ(ierr); 5433a062f41SBarry Smith ierr = MatViewFromOptions(jac->pmat[i],NULL,"-mat_view");CHKERRQ(ierr); 544a3df900dSMatthew G Knepley } 545bdddcaaaSMatthew G Knepley /* create work vectors for each split */ 5462a7a6963SBarry Smith ierr = MatCreateVecs(jac->pmat[i],&jac->x[i],&jac->y[i]);CHKERRQ(ierr); 5470298fd71SBarry Smith ilink->x = jac->x[i]; ilink->y = jac->y[i]; ilink->z = NULL; 548bdddcaaaSMatthew G Knepley /* compute scatter contexts needed by multiplicative versions and non-default splits */ 5490298fd71SBarry Smith ierr = VecScatterCreate(xtmp,ilink->is,jac->x[i],NULL,&ilink->sctx);CHKERRQ(ierr); 550ed1f0337SMatthew G Knepley ierr = PetscObjectQuery((PetscObject) ilink->is, "nearnullspace", (PetscObject*) &sp);CHKERRQ(ierr); 551ed1f0337SMatthew G Knepley if (sp) { 552ed1f0337SMatthew G Knepley ierr = MatSetNearNullSpace(jac->pmat[i], sp);CHKERRQ(ierr); 553ed1f0337SMatthew G Knepley } 554704ba839SBarry Smith ilink = ilink->next; 555cf502942SBarry Smith } 556bdddcaaaSMatthew G Knepley ierr = VecDestroy(&xtmp);CHKERRQ(ierr); 55797bbdb24SBarry Smith } else { 558ef7efd37SHong Zhang MatReuse scall; 559ef7efd37SHong Zhang if (pc->flag == DIFFERENT_NONZERO_PATTERN) { 560ef7efd37SHong Zhang for (i=0; i<nsplit; i++) { 561ef7efd37SHong Zhang ierr = MatDestroy(&jac->pmat[i]);CHKERRQ(ierr); 562ef7efd37SHong Zhang } 563ef7efd37SHong Zhang scall = MAT_INITIAL_MATRIX; 564ef7efd37SHong Zhang } else scall = MAT_REUSE_MATRIX; 565ef7efd37SHong Zhang 566cf502942SBarry Smith for (i=0; i<nsplit; i++) { 567a3df900dSMatthew G Knepley Mat pmat; 568a3df900dSMatthew G Knepley 569a3df900dSMatthew G Knepley /* Check for preconditioning matrix attached to IS */ 570a3df900dSMatthew G Knepley ierr = PetscObjectQuery((PetscObject) ilink->is, "pmat", (PetscObject*) &pmat);CHKERRQ(ierr); 571a3df900dSMatthew G Knepley if (!pmat) { 572ef7efd37SHong Zhang ierr = MatCreateSubMatrix(pc->pmat,ilink->is,ilink->is_col,scall,&jac->pmat[i]);CHKERRQ(ierr); 573a3df900dSMatthew G Knepley } 574704ba839SBarry Smith ilink = ilink->next; 575cf502942SBarry Smith } 57697bbdb24SBarry Smith } 5774e39094bSDmitry Karpeev if (jac->diag_use_amat) { 578519d70e2SJed Brown ilink = jac->head; 579519d70e2SJed Brown if (!jac->mat) { 580785e854fSJed Brown ierr = PetscMalloc1(nsplit,&jac->mat);CHKERRQ(ierr); 581519d70e2SJed Brown for (i=0; i<nsplit; i++) { 5827dae84e0SHong Zhang ierr = MatCreateSubMatrix(pc->mat,ilink->is,ilink->is_col,MAT_INITIAL_MATRIX,&jac->mat[i]);CHKERRQ(ierr); 583519d70e2SJed Brown ilink = ilink->next; 584519d70e2SJed Brown } 585519d70e2SJed Brown } else { 586ef7efd37SHong Zhang MatReuse scall; 587ef7efd37SHong Zhang if (pc->flag == DIFFERENT_NONZERO_PATTERN) { 588519d70e2SJed Brown for (i=0; i<nsplit; i++) { 589ef7efd37SHong Zhang ierr = MatDestroy(&jac->mat[i]);CHKERRQ(ierr); 590ef7efd37SHong Zhang } 591ef7efd37SHong Zhang scall = MAT_INITIAL_MATRIX; 592ef7efd37SHong Zhang } else scall = MAT_REUSE_MATRIX; 593ef7efd37SHong Zhang 594ef7efd37SHong Zhang for (i=0; i<nsplit; i++) { 595ef7efd37SHong Zhang if (jac->mat[i]) {ierr = MatCreateSubMatrix(pc->mat,ilink->is,ilink->is_col,scall,&jac->mat[i]);CHKERRQ(ierr);} 596519d70e2SJed Brown ilink = ilink->next; 597519d70e2SJed Brown } 598519d70e2SJed Brown } 599519d70e2SJed Brown } else { 600519d70e2SJed Brown jac->mat = jac->pmat; 601519d70e2SJed Brown } 60297bbdb24SBarry Smith 60353935eafSBarry Smith /* Check for null space attached to IS */ 60453935eafSBarry Smith ilink = jac->head; 60553935eafSBarry Smith for (i=0; i<nsplit; i++) { 60653935eafSBarry Smith MatNullSpace sp; 60753935eafSBarry Smith 60853935eafSBarry Smith ierr = PetscObjectQuery((PetscObject) ilink->is, "nullspace", (PetscObject*) &sp);CHKERRQ(ierr); 60953935eafSBarry Smith if (sp) { 61053935eafSBarry Smith ierr = MatSetNullSpace(jac->mat[i], sp);CHKERRQ(ierr); 61153935eafSBarry Smith } 61253935eafSBarry Smith ilink = ilink->next; 61353935eafSBarry Smith } 61453935eafSBarry Smith 6156c8605c2SJed Brown if (jac->type != PC_COMPOSITE_ADDITIVE && jac->type != PC_COMPOSITE_SCHUR) { 61668dd23aaSBarry Smith /* extract the rows of the matrix associated with each field: used for efficient computation of residual inside algorithm */ 6174e39094bSDmitry Karpeev /* FIXME: Can/should we reuse jac->mat whenever (jac->diag_use_amat) is true? */ 61868dd23aaSBarry Smith ilink = jac->head; 619e52d2c62SBarry Smith if (nsplit == 2 && jac->type == PC_COMPOSITE_MULTIPLICATIVE) { 620e52d2c62SBarry 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 */ 621e52d2c62SBarry Smith if (!jac->Afield) { 622e52d2c62SBarry Smith ierr = PetscCalloc1(nsplit,&jac->Afield);CHKERRQ(ierr); 62380c96bb1SFande Kong if (jac->offdiag_use_amat) { 6247dae84e0SHong Zhang ierr = MatCreateSubMatrix(pc->mat,ilink->next->is,ilink->is,MAT_INITIAL_MATRIX,&jac->Afield[1]);CHKERRQ(ierr); 625e52d2c62SBarry Smith } else { 6267dae84e0SHong Zhang ierr = MatCreateSubMatrix(pc->pmat,ilink->next->is,ilink->is,MAT_INITIAL_MATRIX,&jac->Afield[1]);CHKERRQ(ierr); 62780c96bb1SFande Kong } 62880c96bb1SFande Kong } else { 629ef7efd37SHong Zhang MatReuse scall; 630ef7efd37SHong Zhang if (pc->flag == DIFFERENT_NONZERO_PATTERN) { 631ef7efd37SHong Zhang for (i=0; i<nsplit; i++) { 632ef7efd37SHong Zhang ierr = MatDestroy(&jac->Afield[1]);CHKERRQ(ierr); 633ef7efd37SHong Zhang } 634ef7efd37SHong Zhang scall = MAT_INITIAL_MATRIX; 635ef7efd37SHong Zhang } else scall = MAT_REUSE_MATRIX; 636ef7efd37SHong Zhang 63780c96bb1SFande Kong if (jac->offdiag_use_amat) { 638ef7efd37SHong Zhang ierr = MatCreateSubMatrix(pc->mat,ilink->next->is,ilink->is,scall,&jac->Afield[1]);CHKERRQ(ierr); 63980c96bb1SFande Kong } else { 640ef7efd37SHong Zhang ierr = MatCreateSubMatrix(pc->pmat,ilink->next->is,ilink->is,scall,&jac->Afield[1]);CHKERRQ(ierr); 64180c96bb1SFande Kong } 642e52d2c62SBarry Smith } 643e52d2c62SBarry Smith } else { 64468dd23aaSBarry Smith if (!jac->Afield) { 645785e854fSJed Brown ierr = PetscMalloc1(nsplit,&jac->Afield);CHKERRQ(ierr); 64668dd23aaSBarry Smith for (i=0; i<nsplit; i++) { 64780c96bb1SFande Kong if (jac->offdiag_use_amat) { 6487dae84e0SHong Zhang ierr = MatCreateSubMatrix(pc->mat,ilink->is,NULL,MAT_INITIAL_MATRIX,&jac->Afield[i]);CHKERRQ(ierr); 64980c96bb1SFande Kong } else { 6507dae84e0SHong Zhang ierr = MatCreateSubMatrix(pc->pmat,ilink->is,NULL,MAT_INITIAL_MATRIX,&jac->Afield[i]);CHKERRQ(ierr); 65180c96bb1SFande Kong } 65268dd23aaSBarry Smith ilink = ilink->next; 65368dd23aaSBarry Smith } 65468dd23aaSBarry Smith } else { 655ef7efd37SHong Zhang MatReuse scall; 656ef7efd37SHong Zhang if (pc->flag == DIFFERENT_NONZERO_PATTERN) { 657ef7efd37SHong Zhang for (i=0; i<nsplit; i++) { 658ef7efd37SHong Zhang ierr = MatDestroy(&jac->Afield[i]);CHKERRQ(ierr); 659ef7efd37SHong Zhang } 660ef7efd37SHong Zhang scall = MAT_INITIAL_MATRIX; 661ef7efd37SHong Zhang } else scall = MAT_REUSE_MATRIX; 662ef7efd37SHong Zhang 66368dd23aaSBarry Smith for (i=0; i<nsplit; i++) { 66480c96bb1SFande Kong if (jac->offdiag_use_amat) { 665ef7efd37SHong Zhang ierr = MatCreateSubMatrix(pc->mat,ilink->is,NULL,scall,&jac->Afield[i]);CHKERRQ(ierr); 66680c96bb1SFande Kong } else { 667ef7efd37SHong Zhang ierr = MatCreateSubMatrix(pc->pmat,ilink->is,NULL,scall,&jac->Afield[i]);CHKERRQ(ierr); 66880c96bb1SFande Kong } 66968dd23aaSBarry Smith ilink = ilink->next; 67068dd23aaSBarry Smith } 67168dd23aaSBarry Smith } 67268dd23aaSBarry Smith } 673e52d2c62SBarry Smith } 67468dd23aaSBarry Smith 6753b224e63SBarry Smith if (jac->type == PC_COMPOSITE_SCHUR) { 6763b224e63SBarry Smith IS ccis; 677c096484dSStefano Zampini PetscBool isspd; 6784aa3045dSJed Brown PetscInt rstart,rend; 679093c86ffSJed Brown char lscname[256]; 680093c86ffSJed Brown PetscObject LSC_L; 681ce94432eSBarry Smith 682ce94432eSBarry Smith if (nsplit != 2) SETERRQ(PetscObjectComm((PetscObject)pc),PETSC_ERR_ARG_INCOMP,"To use Schur complement preconditioner you must have exactly 2 fields"); 68368dd23aaSBarry Smith 684c096484dSStefano Zampini /* If pc->mat is SPD, don't scale by -1 the Schur complement */ 685c096484dSStefano Zampini if (jac->schurscale == (PetscScalar)-1.0) { 686c096484dSStefano Zampini ierr = MatGetOption(pc->pmat,MAT_SPD,&isspd);CHKERRQ(ierr); 687c096484dSStefano Zampini jac->schurscale = (isspd == PETSC_TRUE) ? 1.0 : -1.0; 688c096484dSStefano Zampini } 689c096484dSStefano Zampini 690e6cab6aaSJed Brown /* When extracting off-diagonal submatrices, we take complements from this range */ 691e6cab6aaSJed Brown ierr = MatGetOwnershipRangeColumn(pc->mat,&rstart,&rend);CHKERRQ(ierr); 692e6cab6aaSJed Brown 6933b224e63SBarry Smith /* need to handle case when one is resetting up the preconditioner */ 6943b224e63SBarry Smith if (jac->schur) { 6950298fd71SBarry Smith KSP kspA = jac->head->ksp, kspInner = NULL, kspUpper = jac->kspupper; 696443836d0SMatthew G Knepley 697fb3147dbSMatthew G Knepley ierr = MatSchurComplementGetKSP(jac->schur, &kspInner);CHKERRQ(ierr); 6983b224e63SBarry Smith ilink = jac->head; 69949bb4cd7SJungho Lee ierr = ISComplement(ilink->is_col,rstart,rend,&ccis);CHKERRQ(ierr); 7004e39094bSDmitry Karpeev if (jac->offdiag_use_amat) { 7017dae84e0SHong Zhang ierr = MatCreateSubMatrix(pc->mat,ilink->is,ccis,MAT_REUSE_MATRIX,&jac->B);CHKERRQ(ierr); 702c84da90fSDmitry Karpeev } else { 7037dae84e0SHong Zhang ierr = MatCreateSubMatrix(pc->pmat,ilink->is,ccis,MAT_REUSE_MATRIX,&jac->B);CHKERRQ(ierr); 704c84da90fSDmitry Karpeev } 705fcfd50ebSBarry Smith ierr = ISDestroy(&ccis);CHKERRQ(ierr); 7063b224e63SBarry Smith ilink = ilink->next; 70749bb4cd7SJungho Lee ierr = ISComplement(ilink->is_col,rstart,rend,&ccis);CHKERRQ(ierr); 7084e39094bSDmitry Karpeev if (jac->offdiag_use_amat) { 7097dae84e0SHong Zhang ierr = MatCreateSubMatrix(pc->mat,ilink->is,ccis,MAT_REUSE_MATRIX,&jac->C);CHKERRQ(ierr); 710c84da90fSDmitry Karpeev } else { 7117dae84e0SHong Zhang ierr = MatCreateSubMatrix(pc->pmat,ilink->is,ccis,MAT_REUSE_MATRIX,&jac->C);CHKERRQ(ierr); 712c84da90fSDmitry Karpeev } 713fcfd50ebSBarry Smith ierr = ISDestroy(&ccis);CHKERRQ(ierr); 714aa6c7ce3SBarry Smith ierr = MatSchurComplementUpdateSubMatrices(jac->schur,jac->mat[0],jac->pmat[0],jac->B,jac->C,jac->mat[1]);CHKERRQ(ierr); 715a7476a74SDmitry Karpeev if (jac->schurpre == PC_FIELDSPLIT_SCHUR_PRE_SELFP) { 716a7476a74SDmitry Karpeev ierr = MatDestroy(&jac->schurp);CHKERRQ(ierr); 717a7476a74SDmitry Karpeev ierr = MatSchurComplementGetPmat(jac->schur,MAT_INITIAL_MATRIX,&jac->schurp);CHKERRQ(ierr); 718a7476a74SDmitry Karpeev } 719443836d0SMatthew G Knepley if (kspA != kspInner) { 72023ee1639SBarry Smith ierr = KSPSetOperators(kspA,jac->mat[0],jac->pmat[0]);CHKERRQ(ierr); 721443836d0SMatthew G Knepley } 722443836d0SMatthew G Knepley if (kspUpper != kspA) { 72323ee1639SBarry Smith ierr = KSPSetOperators(kspUpper,jac->mat[0],jac->pmat[0]);CHKERRQ(ierr); 724443836d0SMatthew G Knepley } 72523ee1639SBarry Smith ierr = KSPSetOperators(jac->kspschur,jac->schur,FieldSplitSchurPre(jac));CHKERRQ(ierr); 7263b224e63SBarry Smith } else { 727bafc1b83SMatthew G Knepley const char *Dprefix; 728470b340bSDmitry Karpeev char schurprefix[256], schurmatprefix[256]; 729514bf10dSMatthew G Knepley char schurtestoption[256]; 730bdddcaaaSMatthew G Knepley MatNullSpace sp; 731514bf10dSMatthew G Knepley PetscBool flg; 732686bed4dSStefano Zampini KSP kspt; 7333b224e63SBarry Smith 734a04f6461SBarry Smith /* extract the A01 and A10 matrices */ 7353b224e63SBarry Smith ilink = jac->head; 73649bb4cd7SJungho Lee ierr = ISComplement(ilink->is_col,rstart,rend,&ccis);CHKERRQ(ierr); 7374e39094bSDmitry Karpeev if (jac->offdiag_use_amat) { 7387dae84e0SHong Zhang ierr = MatCreateSubMatrix(pc->mat,ilink->is,ccis,MAT_INITIAL_MATRIX,&jac->B);CHKERRQ(ierr); 739c84da90fSDmitry Karpeev } else { 7407dae84e0SHong Zhang ierr = MatCreateSubMatrix(pc->pmat,ilink->is,ccis,MAT_INITIAL_MATRIX,&jac->B);CHKERRQ(ierr); 741c84da90fSDmitry Karpeev } 742fcfd50ebSBarry Smith ierr = ISDestroy(&ccis);CHKERRQ(ierr); 7433b224e63SBarry Smith ilink = ilink->next; 74449bb4cd7SJungho Lee ierr = ISComplement(ilink->is_col,rstart,rend,&ccis);CHKERRQ(ierr); 7454e39094bSDmitry Karpeev if (jac->offdiag_use_amat) { 7467dae84e0SHong Zhang ierr = MatCreateSubMatrix(pc->mat,ilink->is,ccis,MAT_INITIAL_MATRIX,&jac->C);CHKERRQ(ierr); 747c84da90fSDmitry Karpeev } else { 7487dae84e0SHong Zhang ierr = MatCreateSubMatrix(pc->pmat,ilink->is,ccis,MAT_INITIAL_MATRIX,&jac->C);CHKERRQ(ierr); 749c84da90fSDmitry Karpeev } 750fcfd50ebSBarry Smith ierr = ISDestroy(&ccis);CHKERRQ(ierr); 75120252d06SBarry Smith 752f5236f50SJed Brown /* Use mat[0] (diagonal block of Amat) preconditioned by pmat[0] to define Schur complement */ 75320252d06SBarry Smith ierr = MatCreate(((PetscObject)jac->mat[0])->comm,&jac->schur);CHKERRQ(ierr); 75420252d06SBarry Smith ierr = MatSetType(jac->schur,MATSCHURCOMPLEMENT);CHKERRQ(ierr); 755bee83525SDmitry Karpeev ierr = MatSchurComplementSetSubMatrices(jac->schur,jac->mat[0],jac->pmat[0],jac->B,jac->C,jac->mat[1]);CHKERRQ(ierr); 756470b340bSDmitry Karpeev ierr = PetscSNPrintf(schurmatprefix, sizeof(schurmatprefix), "%sfieldsplit_%s_", ((PetscObject)pc)->prefix ? ((PetscObject)pc)->prefix : "", ilink->splitname);CHKERRQ(ierr); 757470b340bSDmitry Karpeev ierr = MatSetOptionsPrefix(jac->schur,schurmatprefix);CHKERRQ(ierr); 758686bed4dSStefano Zampini ierr = MatSchurComplementGetKSP(jac->schur,&kspt);CHKERRQ(ierr); 759686bed4dSStefano Zampini ierr = KSPSetOptionsPrefix(kspt,schurmatprefix);CHKERRQ(ierr); 760686bed4dSStefano Zampini 761686bed4dSStefano Zampini /* Note: this is not true in general */ 762895c21f2SBarry Smith ierr = MatGetNullSpace(jac->mat[1], &sp);CHKERRQ(ierr); 76320252d06SBarry Smith if (sp) { 76420252d06SBarry Smith ierr = MatSetNullSpace(jac->schur, sp);CHKERRQ(ierr); 76520252d06SBarry Smith } 76620252d06SBarry Smith 76720252d06SBarry Smith ierr = PetscSNPrintf(schurtestoption, sizeof(schurtestoption), "-fieldsplit_%s_inner_", ilink->splitname);CHKERRQ(ierr); 768c5929fdfSBarry Smith ierr = PetscOptionsFindPairPrefix_Private(((PetscObject)pc)->options,((PetscObject)pc)->prefix, schurtestoption, NULL, &flg);CHKERRQ(ierr); 769514bf10dSMatthew G Knepley if (flg) { 770514bf10dSMatthew G Knepley DM dmInner; 77121635b76SJed Brown KSP kspInner; 772686bed4dSStefano Zampini PC pcInner; 77321635b76SJed Brown 77421635b76SJed Brown ierr = MatSchurComplementGetKSP(jac->schur, &kspInner);CHKERRQ(ierr); 7752cc093acSMatthew G. Knepley ierr = KSPReset(kspInner);CHKERRQ(ierr); 7762cc093acSMatthew G. Knepley ierr = KSPSetOperators(kspInner,jac->mat[0],jac->pmat[0]);CHKERRQ(ierr); 77721635b76SJed Brown ierr = PetscSNPrintf(schurprefix, sizeof(schurprefix), "%sfieldsplit_%s_inner_", ((PetscObject)pc)->prefix ? ((PetscObject)pc)->prefix : "", ilink->splitname);CHKERRQ(ierr); 77821635b76SJed Brown /* Indent this deeper to emphasize the "inner" nature of this solver. */ 77921635b76SJed Brown ierr = PetscObjectIncrementTabLevel((PetscObject)kspInner, (PetscObject) pc, 2);CHKERRQ(ierr); 7802cc093acSMatthew G. Knepley ierr = PetscObjectIncrementTabLevel((PetscObject)kspInner->pc, (PetscObject) pc, 2);CHKERRQ(ierr); 78121635b76SJed Brown ierr = KSPSetOptionsPrefix(kspInner, schurprefix);CHKERRQ(ierr); 782514bf10dSMatthew G Knepley 783514bf10dSMatthew G Knepley /* Set DM for new solver */ 784bafc1b83SMatthew G Knepley ierr = KSPGetDM(jac->head->ksp, &dmInner);CHKERRQ(ierr); 78521635b76SJed Brown ierr = KSPSetDM(kspInner, dmInner);CHKERRQ(ierr); 78621635b76SJed Brown ierr = KSPSetDMActive(kspInner, PETSC_FALSE);CHKERRQ(ierr); 787686bed4dSStefano Zampini 788686bed4dSStefano Zampini /* Defaults to PCKSP as preconditioner */ 789686bed4dSStefano Zampini ierr = KSPGetPC(kspInner, &pcInner);CHKERRQ(ierr); 790686bed4dSStefano Zampini ierr = PCSetType(pcInner, PCKSP);CHKERRQ(ierr); 791686bed4dSStefano Zampini ierr = PCKSPSetKSP(pcInner, jac->head->ksp);CHKERRQ(ierr); 792514bf10dSMatthew G Knepley } else { 79321635b76SJed Brown /* Use the outer solver for the inner solve, but revert the KSPPREONLY from PCFieldSplitSetFields_FieldSplit or 79421635b76SJed Brown * PCFieldSplitSetIS_FieldSplit. We don't want KSPPREONLY because it makes the Schur complement inexact, 79521635b76SJed Brown * preventing Schur complement reduction to be an accurate solve. Usually when an iterative solver is used for 79621635b76SJed 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 79721635b76SJed Brown * GMRES the default. Note that it is also common to use PREONLY for S, in which case S may not be used 79821635b76SJed Brown * directly, and the user is responsible for setting an inexact method for fieldsplit's A^{-1}. */ 79921635b76SJed Brown ierr = KSPSetType(jac->head->ksp,KSPGMRES);CHKERRQ(ierr); 800514bf10dSMatthew G Knepley ierr = MatSchurComplementSetKSP(jac->schur,jac->head->ksp);CHKERRQ(ierr); 801bafc1b83SMatthew G Knepley } 80223ee1639SBarry Smith ierr = KSPSetOperators(jac->head->ksp,jac->mat[0],jac->pmat[0]);CHKERRQ(ierr); 8035a9f2f41SSatish Balay ierr = KSPSetFromOptions(jac->head->ksp);CHKERRQ(ierr); 80497bbdb24SBarry Smith ierr = MatSetFromOptions(jac->schur);CHKERRQ(ierr); 80597bbdb24SBarry Smith 806686bed4dSStefano Zampini ierr = PetscObjectTypeCompare((PetscObject)jac->schur, MATSCHURCOMPLEMENT, &flg);CHKERRQ(ierr); 807686bed4dSStefano Zampini if (flg) { /* Need to do this otherwise PCSetUp_KSP will overwrite the amat of jac->head->ksp */ 808686bed4dSStefano Zampini KSP kspInner; 809686bed4dSStefano Zampini PC pcInner; 810686bed4dSStefano Zampini 811686bed4dSStefano Zampini ierr = MatSchurComplementGetKSP(jac->schur, &kspInner);CHKERRQ(ierr); 812686bed4dSStefano Zampini ierr = KSPGetPC(kspInner, &pcInner);CHKERRQ(ierr); 813686bed4dSStefano Zampini ierr = PetscObjectTypeCompare((PetscObject)pcInner, PCKSP, &flg);CHKERRQ(ierr); 814686bed4dSStefano Zampini if (flg) { 815686bed4dSStefano Zampini KSP ksp; 816686bed4dSStefano Zampini 817686bed4dSStefano Zampini ierr = PCKSPGetKSP(pcInner, &ksp);CHKERRQ(ierr); 818686bed4dSStefano Zampini if (ksp == jac->head->ksp) { 819686bed4dSStefano Zampini ierr = PCSetUseAmat(pcInner, PETSC_TRUE);CHKERRQ(ierr); 820686bed4dSStefano Zampini } 821686bed4dSStefano Zampini } 822686bed4dSStefano Zampini } 823443836d0SMatthew G Knepley ierr = PetscSNPrintf(schurtestoption, sizeof(schurtestoption), "-fieldsplit_%s_upper_", ilink->splitname);CHKERRQ(ierr); 824c5929fdfSBarry Smith ierr = PetscOptionsFindPairPrefix_Private(((PetscObject)pc)->options,((PetscObject)pc)->prefix, schurtestoption, NULL, &flg);CHKERRQ(ierr); 825443836d0SMatthew G Knepley if (flg) { 826443836d0SMatthew G Knepley DM dmInner; 827443836d0SMatthew G Knepley 828443836d0SMatthew G Knepley ierr = PetscSNPrintf(schurprefix, sizeof(schurprefix), "%sfieldsplit_%s_upper_", ((PetscObject)pc)->prefix ? ((PetscObject)pc)->prefix : "", ilink->splitname);CHKERRQ(ierr); 82982f516ccSBarry Smith ierr = KSPCreate(PetscObjectComm((PetscObject)pc), &jac->kspupper);CHKERRQ(ierr); 830422a814eSBarry Smith ierr = KSPSetErrorIfNotConverged(jac->kspupper,pc->erroriffailure);CHKERRQ(ierr); 831443836d0SMatthew G Knepley ierr = KSPSetOptionsPrefix(jac->kspupper, schurprefix);CHKERRQ(ierr); 8322cc093acSMatthew G. Knepley ierr = PetscObjectIncrementTabLevel((PetscObject)jac->kspupper, (PetscObject) pc, 1);CHKERRQ(ierr); 8332cc093acSMatthew G. Knepley ierr = PetscObjectIncrementTabLevel((PetscObject)jac->kspupper->pc, (PetscObject) pc, 1);CHKERRQ(ierr); 834443836d0SMatthew G Knepley ierr = KSPGetDM(jac->head->ksp, &dmInner);CHKERRQ(ierr); 835443836d0SMatthew G Knepley ierr = KSPSetDM(jac->kspupper, dmInner);CHKERRQ(ierr); 836443836d0SMatthew G Knepley ierr = KSPSetDMActive(jac->kspupper, PETSC_FALSE);CHKERRQ(ierr); 837443836d0SMatthew G Knepley ierr = KSPSetFromOptions(jac->kspupper);CHKERRQ(ierr); 83823ee1639SBarry Smith ierr = KSPSetOperators(jac->kspupper,jac->mat[0],jac->pmat[0]);CHKERRQ(ierr); 839443836d0SMatthew G Knepley ierr = VecDuplicate(jac->head->x, &jac->head->z);CHKERRQ(ierr); 840443836d0SMatthew G Knepley } else { 841443836d0SMatthew G Knepley jac->kspupper = jac->head->ksp; 842443836d0SMatthew G Knepley ierr = PetscObjectReference((PetscObject) jac->head->ksp);CHKERRQ(ierr); 843443836d0SMatthew G Knepley } 844443836d0SMatthew G Knepley 845a7476a74SDmitry Karpeev if (jac->schurpre == PC_FIELDSPLIT_SCHUR_PRE_SELFP) { 846a7476a74SDmitry Karpeev ierr = MatSchurComplementGetPmat(jac->schur,MAT_INITIAL_MATRIX,&jac->schurp);CHKERRQ(ierr); 847a7476a74SDmitry Karpeev } 848ce94432eSBarry Smith ierr = KSPCreate(PetscObjectComm((PetscObject)pc),&jac->kspschur);CHKERRQ(ierr); 849422a814eSBarry Smith ierr = KSPSetErrorIfNotConverged(jac->kspschur,pc->erroriffailure);CHKERRQ(ierr); 85097bbdb24SBarry Smith ierr = PetscLogObjectParent((PetscObject)pc,(PetscObject)jac->kspschur);CHKERRQ(ierr); 85120252d06SBarry Smith ierr = PetscObjectIncrementTabLevel((PetscObject)jac->kspschur,(PetscObject)pc,1);CHKERRQ(ierr); 85297bbdb24SBarry Smith if (jac->schurpre == PC_FIELDSPLIT_SCHUR_PRE_SELF) { 8537233a360SDmitry Karpeev PC pcschur; 8547233a360SDmitry Karpeev ierr = KSPGetPC(jac->kspschur,&pcschur);CHKERRQ(ierr); 8557233a360SDmitry Karpeev ierr = PCSetType(pcschur,PCNONE);CHKERRQ(ierr); 85697bbdb24SBarry Smith /* Note: This is bad if there exist preconditioners for MATSCHURCOMPLEMENT */ 857e74569cdSMatthew G. Knepley } else if (jac->schurpre == PC_FIELDSPLIT_SCHUR_PRE_FULL) { 858e74569cdSMatthew G. Knepley ierr = MatSchurComplementComputeExplicitOperator(jac->schur, &jac->schur_user);CHKERRQ(ierr); 85997bbdb24SBarry Smith } 86023ee1639SBarry Smith ierr = KSPSetOperators(jac->kspschur,jac->schur,FieldSplitSchurPre(jac));CHKERRQ(ierr); 86197bbdb24SBarry Smith ierr = KSPGetOptionsPrefix(jac->head->next->ksp, &Dprefix);CHKERRQ(ierr); 86297bbdb24SBarry Smith ierr = KSPSetOptionsPrefix(jac->kspschur, Dprefix);CHKERRQ(ierr); 863c096484dSStefano Zampini /* propagate DM */ 864b20b4189SMatthew G. Knepley { 865b20b4189SMatthew G. Knepley DM sdm; 866b20b4189SMatthew G. Knepley ierr = KSPGetDM(jac->head->next->ksp, &sdm);CHKERRQ(ierr); 867b20b4189SMatthew G. Knepley if (sdm) { 868b20b4189SMatthew G. Knepley ierr = KSPSetDM(jac->kspschur, sdm);CHKERRQ(ierr); 869b20b4189SMatthew G. Knepley ierr = KSPSetDMActive(jac->kspschur, PETSC_FALSE);CHKERRQ(ierr); 870b20b4189SMatthew G. Knepley } 871b20b4189SMatthew G. Knepley } 87297bbdb24SBarry Smith /* really want setfromoptions called in PCSetFromOptions_FieldSplit(), but it is not ready yet */ 87397bbdb24SBarry Smith /* need to call this every time, since the jac->kspschur is freshly created, otherwise its options never get set */ 87497bbdb24SBarry Smith ierr = KSPSetFromOptions(jac->kspschur);CHKERRQ(ierr); 87597bbdb24SBarry Smith } 876686bed4dSStefano Zampini ierr = MatAssemblyBegin(jac->schur,MAT_FINAL_ASSEMBLY);CHKERRQ(ierr); 877686bed4dSStefano Zampini ierr = MatAssemblyEnd(jac->schur,MAT_FINAL_ASSEMBLY);CHKERRQ(ierr); 87897bbdb24SBarry Smith 8795a9f2f41SSatish Balay /* HACK: special support to forward L and Lp matrices that might be used by PCLSC */ 8808caf3d72SBarry Smith ierr = PetscSNPrintf(lscname,sizeof(lscname),"%s_LSC_L",ilink->splitname);CHKERRQ(ierr); 881519d70e2SJed Brown ierr = PetscObjectQuery((PetscObject)pc->mat,lscname,(PetscObject*)&LSC_L);CHKERRQ(ierr); 8823b224e63SBarry Smith if (!LSC_L) {ierr = PetscObjectQuery((PetscObject)pc->pmat,lscname,(PetscObject*)&LSC_L);CHKERRQ(ierr);} 883c1570756SJed Brown if (LSC_L) {ierr = PetscObjectCompose((PetscObject)jac->schur,"LSC_L",(PetscObject)LSC_L);CHKERRQ(ierr);} 8848caf3d72SBarry Smith ierr = PetscSNPrintf(lscname,sizeof(lscname),"%s_LSC_Lp",ilink->splitname);CHKERRQ(ierr); 88597bbdb24SBarry Smith ierr = PetscObjectQuery((PetscObject)pc->pmat,lscname,(PetscObject*)&LSC_L);CHKERRQ(ierr); 8865a9f2f41SSatish Balay if (!LSC_L) {ierr = PetscObjectQuery((PetscObject)pc->mat,lscname,(PetscObject*)&LSC_L);CHKERRQ(ierr);} 8870971522cSBarry Smith if (LSC_L) {ierr = PetscObjectCompose((PetscObject)jac->schur,"LSC_Lp",(PetscObject)LSC_L);CHKERRQ(ierr);} 88897bbdb24SBarry Smith } else { 88968bd789dSDmitry Karpeev /* set up the individual splits' PCs */ 8900971522cSBarry Smith i = 0; 8910971522cSBarry Smith ilink = jac->head; 8920971522cSBarry Smith while (ilink) { 89323ee1639SBarry Smith ierr = KSPSetOperators(ilink->ksp,jac->mat[i],jac->pmat[i]);CHKERRQ(ierr); 8940971522cSBarry Smith /* really want setfromoptions called in PCSetFromOptions_FieldSplit(), but it is not ready yet */ 8950971522cSBarry Smith if (!jac->suboptionsset) {ierr = KSPSetFromOptions(ilink->ksp);CHKERRQ(ierr);} 8960971522cSBarry Smith i++; 8970971522cSBarry Smith ilink = ilink->next; 8980971522cSBarry Smith } 8993b224e63SBarry Smith } 9003b224e63SBarry Smith 901c1570756SJed Brown jac->suboptionsset = PETSC_TRUE; 9020971522cSBarry Smith PetscFunctionReturn(0); 9030971522cSBarry Smith } 9040971522cSBarry Smith 9055a9f2f41SSatish Balay #define FieldSplitSplitSolveAdd(ilink,xx,yy) \ 906ca9f406cSSatish Balay (VecScatterBegin(ilink->sctx,xx,ilink->x,INSERT_VALUES,SCATTER_FORWARD) || \ 907ca9f406cSSatish Balay VecScatterEnd(ilink->sctx,xx,ilink->x,INSERT_VALUES,SCATTER_FORWARD) || \ 9089df09d43SBarry Smith PetscLogEventBegin(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL) ||\ 9095a9f2f41SSatish Balay KSPSolve(ilink->ksp,ilink->x,ilink->y) || \ 9109df09d43SBarry Smith PetscLogEventEnd(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL) ||\ 911ca9f406cSSatish Balay VecScatterBegin(ilink->sctx,ilink->y,yy,ADD_VALUES,SCATTER_REVERSE) || \ 912ca9f406cSSatish Balay VecScatterEnd(ilink->sctx,ilink->y,yy,ADD_VALUES,SCATTER_REVERSE)) 91379416396SBarry Smith 9143b224e63SBarry Smith static PetscErrorCode PCApply_FieldSplit_Schur(PC pc,Vec x,Vec y) 9153b224e63SBarry Smith { 9163b224e63SBarry Smith PC_FieldSplit *jac = (PC_FieldSplit*)pc->data; 9173b224e63SBarry Smith PetscErrorCode ierr; 9183b224e63SBarry Smith PC_FieldSplitLink ilinkA = jac->head, ilinkD = ilinkA->next; 919443836d0SMatthew G Knepley KSP kspA = ilinkA->ksp, kspLower = kspA, kspUpper = jac->kspupper; 920*5da88fe4STristan Konolige KSPConvergedReason reason; 9213b224e63SBarry Smith 9223b224e63SBarry Smith PetscFunctionBegin; 923c5d2311dSJed Brown switch (jac->schurfactorization) { 924c9c6ffaaSJed Brown case PC_FIELDSPLIT_SCHUR_FACT_DIAG: 925a04f6461SBarry Smith /* [A00 0; 0 -S], positive definite, suitable for MINRES */ 926c5d2311dSJed Brown ierr = VecScatterBegin(ilinkA->sctx,x,ilinkA->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr); 927c5d2311dSJed Brown ierr = VecScatterBegin(ilinkD->sctx,x,ilinkD->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr); 928c5d2311dSJed Brown ierr = VecScatterEnd(ilinkA->sctx,x,ilinkA->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr); 9299df09d43SBarry Smith ierr = PetscLogEventBegin(ilinkA->event,kspA,ilinkA->x,ilinkA->y,NULL);CHKERRQ(ierr); 930443836d0SMatthew G Knepley ierr = KSPSolve(kspA,ilinkA->x,ilinkA->y);CHKERRQ(ierr); 931*5da88fe4STristan Konolige ierr = KSPGetConvergedReason(kspA,&reason);CHKERRQ(ierr); 932*5da88fe4STristan Konolige if(reason < 0) pc->failedreason = PC_SUBPC_ERROR; 9339df09d43SBarry Smith ierr = PetscLogEventEnd(ilinkA->event,kspA,ilinkA->x,ilinkA->y,NULL);CHKERRQ(ierr); 934c5d2311dSJed Brown ierr = VecScatterBegin(ilinkA->sctx,ilinkA->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr); 935c5d2311dSJed Brown ierr = VecScatterEnd(ilinkD->sctx,x,ilinkD->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr); 9369df09d43SBarry Smith ierr = PetscLogEventBegin(KSP_Solve_FS_S,jac->kspschur,ilinkD->x,ilinkD->y,NULL);CHKERRQ(ierr); 937c5d2311dSJed Brown ierr = KSPSolve(jac->kspschur,ilinkD->x,ilinkD->y);CHKERRQ(ierr); 938*5da88fe4STristan Konolige ierr = KSPGetConvergedReason(jac->kspschur,&reason);CHKERRQ(ierr); 939*5da88fe4STristan Konolige if(reason < 0) pc->failedreason = PC_SUBPC_ERROR; 9409df09d43SBarry Smith ierr = PetscLogEventEnd(KSP_Solve_FS_S,jac->kspschur,ilinkD->x,ilinkD->y,NULL);CHKERRQ(ierr); 941c096484dSStefano Zampini ierr = VecScale(ilinkD->y,jac->schurscale);CHKERRQ(ierr); 942c5d2311dSJed Brown ierr = VecScatterBegin(ilinkD->sctx,ilinkD->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr); 943c5d2311dSJed Brown ierr = VecScatterEnd(ilinkA->sctx,ilinkA->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr); 944c5d2311dSJed Brown ierr = VecScatterEnd(ilinkD->sctx,ilinkD->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr); 945c5d2311dSJed Brown break; 946c9c6ffaaSJed Brown case PC_FIELDSPLIT_SCHUR_FACT_LOWER: 947a04f6461SBarry Smith /* [A00 0; A10 S], suitable for left preconditioning */ 948c5d2311dSJed Brown ierr = VecScatterBegin(ilinkA->sctx,x,ilinkA->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr); 949c5d2311dSJed Brown ierr = VecScatterEnd(ilinkA->sctx,x,ilinkA->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr); 9509df09d43SBarry Smith ierr = PetscLogEventBegin(ilinkA->event,kspA,ilinkA->x,ilinkA->y,NULL);CHKERRQ(ierr); 951443836d0SMatthew G Knepley ierr = KSPSolve(kspA,ilinkA->x,ilinkA->y);CHKERRQ(ierr); 952*5da88fe4STristan Konolige ierr = KSPGetConvergedReason(kspA,&reason);CHKERRQ(ierr); 953*5da88fe4STristan Konolige if(reason < 0) pc->failedreason = PC_SUBPC_ERROR; 9549df09d43SBarry Smith ierr = PetscLogEventEnd(ilinkA->event,kspA,ilinkA->x,ilinkA->y,NULL);CHKERRQ(ierr); 955c5d2311dSJed Brown ierr = MatMult(jac->C,ilinkA->y,ilinkD->x);CHKERRQ(ierr); 956c5d2311dSJed Brown ierr = VecScale(ilinkD->x,-1.);CHKERRQ(ierr); 957c5d2311dSJed Brown ierr = VecScatterBegin(ilinkD->sctx,x,ilinkD->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr); 958c5d2311dSJed Brown ierr = VecScatterBegin(ilinkA->sctx,ilinkA->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr); 959c5d2311dSJed Brown ierr = VecScatterEnd(ilinkD->sctx,x,ilinkD->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr); 9609df09d43SBarry Smith ierr = PetscLogEventBegin(KSP_Solve_FS_S,jac->kspschur,ilinkD->x,ilinkD->y,NULL);CHKERRQ(ierr); 961c5d2311dSJed Brown ierr = KSPSolve(jac->kspschur,ilinkD->x,ilinkD->y);CHKERRQ(ierr); 962*5da88fe4STristan Konolige ierr = KSPGetConvergedReason(jac->kspschur,&reason);CHKERRQ(ierr); 963*5da88fe4STristan Konolige if(reason < 0) pc->failedreason = PC_SUBPC_ERROR; 9649df09d43SBarry Smith ierr = PetscLogEventEnd(KSP_Solve_FS_S,jac->kspschur,ilinkD->x,ilinkD->y,NULL);CHKERRQ(ierr); 965c5d2311dSJed Brown ierr = VecScatterBegin(ilinkD->sctx,ilinkD->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr); 966c5d2311dSJed Brown ierr = VecScatterEnd(ilinkA->sctx,ilinkA->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr); 967c5d2311dSJed Brown ierr = VecScatterEnd(ilinkD->sctx,ilinkD->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr); 968c5d2311dSJed Brown break; 969c9c6ffaaSJed Brown case PC_FIELDSPLIT_SCHUR_FACT_UPPER: 970a04f6461SBarry Smith /* [A00 A01; 0 S], suitable for right preconditioning */ 971c5d2311dSJed Brown ierr = VecScatterBegin(ilinkD->sctx,x,ilinkD->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr); 972c5d2311dSJed Brown ierr = VecScatterEnd(ilinkD->sctx,x,ilinkD->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr); 9739df09d43SBarry Smith ierr = PetscLogEventBegin(KSP_Solve_FS_S,jac->kspschur,ilinkD->x,ilinkD->y,NULL);CHKERRQ(ierr); 974c5d2311dSJed Brown ierr = KSPSolve(jac->kspschur,ilinkD->x,ilinkD->y);CHKERRQ(ierr); 975*5da88fe4STristan Konolige ierr = KSPGetConvergedReason(jac->kspschur,&reason);CHKERRQ(ierr); 976*5da88fe4STristan Konolige if(reason < 0) pc->failedreason = PC_SUBPC_ERROR; 9779df09d43SBarry 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); 978c5d2311dSJed Brown ierr = VecScale(ilinkA->x,-1.);CHKERRQ(ierr); 979c5d2311dSJed Brown ierr = VecScatterBegin(ilinkA->sctx,x,ilinkA->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr); 980c5d2311dSJed Brown ierr = VecScatterBegin(ilinkD->sctx,ilinkD->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr); 981c5d2311dSJed Brown ierr = VecScatterEnd(ilinkA->sctx,x,ilinkA->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr); 9829df09d43SBarry Smith ierr = PetscLogEventBegin(ilinkA->event,kspA,ilinkA->x,ilinkA->y,NULL);CHKERRQ(ierr); 983443836d0SMatthew G Knepley ierr = KSPSolve(kspA,ilinkA->x,ilinkA->y);CHKERRQ(ierr); 984*5da88fe4STristan Konolige ierr = KSPGetConvergedReason(kspA,&reason);CHKERRQ(ierr); 985*5da88fe4STristan Konolige if(reason < 0) pc->failedreason = PC_SUBPC_ERROR; 9869df09d43SBarry Smith ierr = PetscLogEventEnd(ilinkA->event,kspA,ilinkA->x,ilinkA->y,NULL);CHKERRQ(ierr); 987c5d2311dSJed Brown ierr = VecScatterBegin(ilinkA->sctx,ilinkA->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr); 988c5d2311dSJed Brown ierr = VecScatterEnd(ilinkD->sctx,ilinkD->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr); 989c5d2311dSJed Brown ierr = VecScatterEnd(ilinkA->sctx,ilinkA->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr); 990c5d2311dSJed Brown break; 991c9c6ffaaSJed Brown case PC_FIELDSPLIT_SCHUR_FACT_FULL: 992a04f6461SBarry Smith /* [1 0; A10 A00^{-1} 1] [A00 0; 0 S] [1 A00^{-1}A01; 0 1], an exact solve if applied exactly, needs one extra solve with A */ 9933b224e63SBarry Smith ierr = VecScatterBegin(ilinkA->sctx,x,ilinkA->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr); 9943b224e63SBarry Smith ierr = VecScatterEnd(ilinkA->sctx,x,ilinkA->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr); 9959df09d43SBarry Smith ierr = PetscLogEventBegin(KSP_Solve_FS_L,kspLower,ilinkA->x,ilinkA->y,NULL);CHKERRQ(ierr); 996443836d0SMatthew G Knepley ierr = KSPSolve(kspLower,ilinkA->x,ilinkA->y);CHKERRQ(ierr); 997*5da88fe4STristan Konolige ierr = KSPGetConvergedReason(kspLower,&reason);CHKERRQ(ierr); 998*5da88fe4STristan Konolige if(reason < 0) pc->failedreason = PC_SUBPC_ERROR; 9999df09d43SBarry Smith ierr = PetscLogEventEnd(KSP_Solve_FS_L,kspLower,ilinkA->x,ilinkA->y,NULL);CHKERRQ(ierr); 10003b224e63SBarry Smith ierr = MatMult(jac->C,ilinkA->y,ilinkD->x);CHKERRQ(ierr); 10013b224e63SBarry Smith ierr = VecScale(ilinkD->x,-1.0);CHKERRQ(ierr); 10023b224e63SBarry Smith ierr = VecScatterBegin(ilinkD->sctx,x,ilinkD->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr); 10033b224e63SBarry Smith ierr = VecScatterEnd(ilinkD->sctx,x,ilinkD->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr); 10043b224e63SBarry Smith 10059df09d43SBarry Smith ierr = PetscLogEventBegin(KSP_Solve_FS_S,jac->kspschur,ilinkD->x,ilinkD->y,NULL);CHKERRQ(ierr); 10063b224e63SBarry Smith ierr = KSPSolve(jac->kspschur,ilinkD->x,ilinkD->y);CHKERRQ(ierr); 1007*5da88fe4STristan Konolige ierr = KSPGetConvergedReason(jac->kspschur,&reason);CHKERRQ(ierr); 1008*5da88fe4STristan Konolige if(reason < 0) pc->failedreason = PC_SUBPC_ERROR; 10099df09d43SBarry Smith ierr = PetscLogEventEnd(KSP_Solve_FS_S,jac->kspschur,ilinkD->x,ilinkD->y,NULL);CHKERRQ(ierr); 10103b224e63SBarry Smith ierr = VecScatterBegin(ilinkD->sctx,ilinkD->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr); 10113b224e63SBarry Smith ierr = VecScatterEnd(ilinkD->sctx,ilinkD->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr); 10123b224e63SBarry Smith 1013443836d0SMatthew G Knepley if (kspUpper == kspA) { 10143b224e63SBarry Smith ierr = MatMult(jac->B,ilinkD->y,ilinkA->y);CHKERRQ(ierr); 10153b224e63SBarry Smith ierr = VecAXPY(ilinkA->x,-1.0,ilinkA->y);CHKERRQ(ierr); 10169df09d43SBarry Smith ierr = PetscLogEventBegin(ilinkA->event,kspA,ilinkA->x,ilinkA->y,NULL);CHKERRQ(ierr); 1017443836d0SMatthew G Knepley ierr = KSPSolve(kspA,ilinkA->x,ilinkA->y);CHKERRQ(ierr); 1018*5da88fe4STristan Konolige ierr = KSPGetConvergedReason(kspA,&reason);CHKERRQ(ierr); 1019*5da88fe4STristan Konolige if(reason < 0) pc->failedreason = PC_SUBPC_ERROR; 10209df09d43SBarry Smith ierr = PetscLogEventEnd(ilinkA->event,kspA,ilinkA->x,ilinkA->y,NULL);CHKERRQ(ierr); 1021443836d0SMatthew G Knepley } else { 10229df09d43SBarry Smith ierr = PetscLogEventBegin(ilinkA->event,kspA,ilinkA->x,ilinkA->y,NULL);CHKERRQ(ierr); 1023443836d0SMatthew G Knepley ierr = KSPSolve(kspA,ilinkA->x,ilinkA->y);CHKERRQ(ierr); 10249df09d43SBarry Smith ierr = PetscLogEventEnd(ilinkA->event,kspA,ilinkA->x,ilinkA->y,NULL);CHKERRQ(ierr); 1025443836d0SMatthew G Knepley ierr = MatMult(jac->B,ilinkD->y,ilinkA->x);CHKERRQ(ierr); 10269df09d43SBarry Smith ierr = PetscLogEventBegin(KSP_Solve_FS_U,kspUpper,ilinkA->x,ilinkA->z,NULL);CHKERRQ(ierr); 1027443836d0SMatthew G Knepley ierr = KSPSolve(kspUpper,ilinkA->x,ilinkA->z);CHKERRQ(ierr); 1028*5da88fe4STristan Konolige ierr = KSPGetConvergedReason(kspUpper,&reason);CHKERRQ(ierr); 1029*5da88fe4STristan Konolige if(reason < 0) pc->failedreason = PC_SUBPC_ERROR; 10309df09d43SBarry Smith ierr = PetscLogEventEnd(KSP_Solve_FS_U,kspUpper,ilinkA->x,ilinkA->z,NULL);CHKERRQ(ierr); 1031443836d0SMatthew G Knepley ierr = VecAXPY(ilinkA->y,-1.0,ilinkA->z);CHKERRQ(ierr); 1032443836d0SMatthew G Knepley } 10333b224e63SBarry Smith ierr = VecScatterBegin(ilinkA->sctx,ilinkA->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr); 10343b224e63SBarry Smith ierr = VecScatterEnd(ilinkA->sctx,ilinkA->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr); 1035c5d2311dSJed Brown } 10363b224e63SBarry Smith PetscFunctionReturn(0); 10373b224e63SBarry Smith } 10383b224e63SBarry Smith 10390971522cSBarry Smith static PetscErrorCode PCApply_FieldSplit(PC pc,Vec x,Vec y) 10400971522cSBarry Smith { 10410971522cSBarry Smith PC_FieldSplit *jac = (PC_FieldSplit*)pc->data; 10420971522cSBarry Smith PetscErrorCode ierr; 10435a9f2f41SSatish Balay PC_FieldSplitLink ilink = jac->head; 1044939b8a20SBarry Smith PetscInt cnt,bs; 1045568ed31eSHong Zhang KSPConvergedReason reason; 10460971522cSBarry Smith 10470971522cSBarry Smith PetscFunctionBegin; 104879416396SBarry Smith if (jac->type == PC_COMPOSITE_ADDITIVE) { 10491b9fc7fcSBarry Smith if (jac->defaultsplit) { 1050939b8a20SBarry Smith ierr = VecGetBlockSize(x,&bs);CHKERRQ(ierr); 1051ce94432eSBarry 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); 1052939b8a20SBarry Smith ierr = VecGetBlockSize(y,&bs);CHKERRQ(ierr); 1053ce94432eSBarry 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); 10540971522cSBarry Smith ierr = VecStrideGatherAll(x,jac->x,INSERT_VALUES);CHKERRQ(ierr); 10555a9f2f41SSatish Balay while (ilink) { 10569df09d43SBarry Smith ierr = PetscLogEventBegin(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL);CHKERRQ(ierr); 10575a9f2f41SSatish Balay ierr = KSPSolve(ilink->ksp,ilink->x,ilink->y);CHKERRQ(ierr); 10589df09d43SBarry Smith ierr = PetscLogEventEnd(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL);CHKERRQ(ierr); 1059568ed31eSHong Zhang ierr = KSPGetConvergedReason(ilink->ksp,&reason);CHKERRQ(ierr); 1060568ed31eSHong Zhang if (reason == KSP_DIVERGED_PCSETUP_FAILED) { 1061568ed31eSHong Zhang pc->failedreason = PC_SUBPC_ERROR; 1062568ed31eSHong Zhang } 10635a9f2f41SSatish Balay ilink = ilink->next; 10640971522cSBarry Smith } 10650971522cSBarry Smith ierr = VecStrideScatterAll(jac->y,y,INSERT_VALUES);CHKERRQ(ierr); 10661b9fc7fcSBarry Smith } else { 1067efb30889SBarry Smith ierr = VecSet(y,0.0);CHKERRQ(ierr); 10685a9f2f41SSatish Balay while (ilink) { 10695a9f2f41SSatish Balay ierr = FieldSplitSplitSolveAdd(ilink,x,y);CHKERRQ(ierr); 1070568ed31eSHong Zhang ierr = KSPGetConvergedReason(ilink->ksp,&reason);CHKERRQ(ierr); 1071568ed31eSHong Zhang if (reason == KSP_DIVERGED_PCSETUP_FAILED) { 1072568ed31eSHong Zhang pc->failedreason = PC_SUBPC_ERROR; 1073568ed31eSHong Zhang } 10745a9f2f41SSatish Balay ilink = ilink->next; 10751b9fc7fcSBarry Smith } 10761b9fc7fcSBarry Smith } 1077e52d2c62SBarry Smith } else if (jac->type == PC_COMPOSITE_MULTIPLICATIVE && jac->nsplits == 2) { 1078e52d2c62SBarry Smith ierr = VecSet(y,0.0);CHKERRQ(ierr); 1079e52d2c62SBarry Smith /* solve on first block for first block variables */ 1080e52d2c62SBarry Smith ierr = VecScatterBegin(ilink->sctx,x,ilink->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr); 1081e52d2c62SBarry Smith ierr = VecScatterEnd(ilink->sctx,x,ilink->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr); 10829df09d43SBarry Smith ierr = PetscLogEventBegin(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL);CHKERRQ(ierr); 1083e52d2c62SBarry Smith ierr = KSPSolve(ilink->ksp,ilink->x,ilink->y);CHKERRQ(ierr); 10849df09d43SBarry Smith ierr = PetscLogEventEnd(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL);CHKERRQ(ierr); 1085568ed31eSHong Zhang ierr = KSPGetConvergedReason(ilink->ksp,&reason);CHKERRQ(ierr); 1086568ed31eSHong Zhang if (reason == KSP_DIVERGED_PCSETUP_FAILED) { 1087568ed31eSHong Zhang pc->failedreason = PC_SUBPC_ERROR; 1088568ed31eSHong Zhang } 1089e52d2c62SBarry Smith ierr = VecScatterBegin(ilink->sctx,ilink->y,y,ADD_VALUES,SCATTER_REVERSE);CHKERRQ(ierr); 1090e52d2c62SBarry Smith ierr = VecScatterEnd(ilink->sctx,ilink->y,y,ADD_VALUES,SCATTER_REVERSE);CHKERRQ(ierr); 1091e52d2c62SBarry Smith 1092e52d2c62SBarry Smith /* compute the residual only onto second block variables using first block variables */ 1093e52d2c62SBarry Smith ierr = MatMult(jac->Afield[1],ilink->y,ilink->next->x);CHKERRQ(ierr); 1094e52d2c62SBarry Smith ilink = ilink->next; 1095e52d2c62SBarry Smith ierr = VecScale(ilink->x,-1.0);CHKERRQ(ierr); 1096e52d2c62SBarry Smith ierr = VecScatterBegin(ilink->sctx,x,ilink->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr); 1097e52d2c62SBarry Smith ierr = VecScatterEnd(ilink->sctx,x,ilink->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr); 1098e52d2c62SBarry Smith 1099e52d2c62SBarry Smith /* solve on second block variables */ 11009df09d43SBarry Smith ierr = PetscLogEventBegin(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL);CHKERRQ(ierr); 1101e52d2c62SBarry Smith ierr = KSPSolve(ilink->ksp,ilink->x,ilink->y);CHKERRQ(ierr); 11029df09d43SBarry Smith ierr = PetscLogEventEnd(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL);CHKERRQ(ierr); 1103568ed31eSHong Zhang ierr = KSPGetConvergedReason(ilink->ksp,&reason);CHKERRQ(ierr); 1104568ed31eSHong Zhang if (reason == KSP_DIVERGED_PCSETUP_FAILED) { 1105568ed31eSHong Zhang pc->failedreason = PC_SUBPC_ERROR; 1106568ed31eSHong Zhang } 1107e52d2c62SBarry Smith ierr = VecScatterBegin(ilink->sctx,ilink->y,y,ADD_VALUES,SCATTER_REVERSE);CHKERRQ(ierr); 1108e52d2c62SBarry Smith ierr = VecScatterEnd(ilink->sctx,ilink->y,y,ADD_VALUES,SCATTER_REVERSE);CHKERRQ(ierr); 110916913363SBarry Smith } else if (jac->type == PC_COMPOSITE_MULTIPLICATIVE || jac->type == PC_COMPOSITE_SYMMETRIC_MULTIPLICATIVE) { 111079416396SBarry Smith if (!jac->w1) { 111179416396SBarry Smith ierr = VecDuplicate(x,&jac->w1);CHKERRQ(ierr); 111279416396SBarry Smith ierr = VecDuplicate(x,&jac->w2);CHKERRQ(ierr); 111379416396SBarry Smith } 1114efb30889SBarry Smith ierr = VecSet(y,0.0);CHKERRQ(ierr); 11155a9f2f41SSatish Balay ierr = FieldSplitSplitSolveAdd(ilink,x,y);CHKERRQ(ierr); 1116568ed31eSHong Zhang ierr = KSPGetConvergedReason(ilink->ksp,&reason);CHKERRQ(ierr); 1117568ed31eSHong Zhang if (reason == KSP_DIVERGED_PCSETUP_FAILED) { 1118568ed31eSHong Zhang pc->failedreason = PC_SUBPC_ERROR; 1119568ed31eSHong Zhang } 11203e197d65SBarry Smith cnt = 1; 11215a9f2f41SSatish Balay while (ilink->next) { 11225a9f2f41SSatish Balay ilink = ilink->next; 11233e197d65SBarry Smith /* compute the residual only over the part of the vector needed */ 11243e197d65SBarry Smith ierr = MatMult(jac->Afield[cnt++],y,ilink->x);CHKERRQ(ierr); 11253e197d65SBarry Smith ierr = VecScale(ilink->x,-1.0);CHKERRQ(ierr); 11263e197d65SBarry Smith ierr = VecScatterBegin(ilink->sctx,x,ilink->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr); 11273e197d65SBarry Smith ierr = VecScatterEnd(ilink->sctx,x,ilink->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr); 11289df09d43SBarry Smith ierr = PetscLogEventBegin(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL);CHKERRQ(ierr); 11293e197d65SBarry Smith ierr = KSPSolve(ilink->ksp,ilink->x,ilink->y);CHKERRQ(ierr); 11309df09d43SBarry Smith ierr = PetscLogEventEnd(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL);CHKERRQ(ierr); 11312618eb8fSHong Zhang ierr = KSPGetConvergedReason(ilink->ksp,&reason);CHKERRQ(ierr); 11322618eb8fSHong Zhang if (reason == KSP_DIVERGED_PCSETUP_FAILED) { 11332618eb8fSHong Zhang pc->failedreason = PC_SUBPC_ERROR; 11342618eb8fSHong Zhang } 11353e197d65SBarry Smith ierr = VecScatterBegin(ilink->sctx,ilink->y,y,ADD_VALUES,SCATTER_REVERSE);CHKERRQ(ierr); 11363e197d65SBarry Smith ierr = VecScatterEnd(ilink->sctx,ilink->y,y,ADD_VALUES,SCATTER_REVERSE);CHKERRQ(ierr); 11373e197d65SBarry Smith } 113851f519a2SBarry Smith if (jac->type == PC_COMPOSITE_SYMMETRIC_MULTIPLICATIVE) { 113911755939SBarry Smith cnt -= 2; 114051f519a2SBarry Smith while (ilink->previous) { 114151f519a2SBarry Smith ilink = ilink->previous; 114211755939SBarry Smith /* compute the residual only over the part of the vector needed */ 114311755939SBarry Smith ierr = MatMult(jac->Afield[cnt--],y,ilink->x);CHKERRQ(ierr); 114411755939SBarry Smith ierr = VecScale(ilink->x,-1.0);CHKERRQ(ierr); 114511755939SBarry Smith ierr = VecScatterBegin(ilink->sctx,x,ilink->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr); 114611755939SBarry Smith ierr = VecScatterEnd(ilink->sctx,x,ilink->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr); 11479df09d43SBarry Smith ierr = PetscLogEventBegin(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL);CHKERRQ(ierr); 114811755939SBarry Smith ierr = KSPSolve(ilink->ksp,ilink->x,ilink->y);CHKERRQ(ierr); 11499df09d43SBarry Smith ierr = PetscLogEventEnd(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL);CHKERRQ(ierr); 1150568ed31eSHong Zhang ierr = KSPGetConvergedReason(ilink->ksp,&reason);CHKERRQ(ierr); 1151568ed31eSHong Zhang if (reason == KSP_DIVERGED_PCSETUP_FAILED) { 1152568ed31eSHong Zhang pc->failedreason = PC_SUBPC_ERROR; 1153568ed31eSHong Zhang } 115411755939SBarry Smith ierr = VecScatterBegin(ilink->sctx,ilink->y,y,ADD_VALUES,SCATTER_REVERSE);CHKERRQ(ierr); 115511755939SBarry Smith ierr = VecScatterEnd(ilink->sctx,ilink->y,y,ADD_VALUES,SCATTER_REVERSE);CHKERRQ(ierr); 115651f519a2SBarry Smith } 115711755939SBarry Smith } 1158ce94432eSBarry Smith } else SETERRQ1(PetscObjectComm((PetscObject)pc),PETSC_ERR_SUP,"Unsupported or unknown composition",(int) jac->type); 11590971522cSBarry Smith PetscFunctionReturn(0); 11600971522cSBarry Smith } 11610971522cSBarry Smith 1162421e10b8SBarry Smith #define FieldSplitSplitSolveAddTranspose(ilink,xx,yy) \ 1163ca9f406cSSatish Balay (VecScatterBegin(ilink->sctx,xx,ilink->y,INSERT_VALUES,SCATTER_FORWARD) || \ 1164ca9f406cSSatish Balay VecScatterEnd(ilink->sctx,xx,ilink->y,INSERT_VALUES,SCATTER_FORWARD) || \ 11659df09d43SBarry Smith PetscLogEventBegin(ilink->event,ilink->ksp,ilink->y,ilink->x,NULL) || \ 1166421e10b8SBarry Smith KSPSolveTranspose(ilink->ksp,ilink->y,ilink->x) || \ 11679df09d43SBarry Smith PetscLogEventBegin(ilink->event,ilink->ksp,ilink->y,ilink->x,NULL) || \ 1168ca9f406cSSatish Balay VecScatterBegin(ilink->sctx,ilink->x,yy,ADD_VALUES,SCATTER_REVERSE) || \ 1169ca9f406cSSatish Balay VecScatterEnd(ilink->sctx,ilink->x,yy,ADD_VALUES,SCATTER_REVERSE)) 1170421e10b8SBarry Smith 1171421e10b8SBarry Smith static PetscErrorCode PCApplyTranspose_FieldSplit(PC pc,Vec x,Vec y) 1172421e10b8SBarry Smith { 1173421e10b8SBarry Smith PC_FieldSplit *jac = (PC_FieldSplit*)pc->data; 1174421e10b8SBarry Smith PetscErrorCode ierr; 1175421e10b8SBarry Smith PC_FieldSplitLink ilink = jac->head; 1176939b8a20SBarry Smith PetscInt bs; 1177291dd214SHong Zhang KSPConvergedReason reason; 1178421e10b8SBarry Smith 1179421e10b8SBarry Smith PetscFunctionBegin; 1180421e10b8SBarry Smith if (jac->type == PC_COMPOSITE_ADDITIVE) { 1181421e10b8SBarry Smith if (jac->defaultsplit) { 1182939b8a20SBarry Smith ierr = VecGetBlockSize(x,&bs);CHKERRQ(ierr); 1183ce94432eSBarry 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); 1184939b8a20SBarry Smith ierr = VecGetBlockSize(y,&bs);CHKERRQ(ierr); 1185ce94432eSBarry 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); 1186421e10b8SBarry Smith ierr = VecStrideGatherAll(x,jac->x,INSERT_VALUES);CHKERRQ(ierr); 1187421e10b8SBarry Smith while (ilink) { 11889df09d43SBarry Smith ierr = PetscLogEventBegin(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL);CHKERRQ(ierr); 1189421e10b8SBarry Smith ierr = KSPSolveTranspose(ilink->ksp,ilink->x,ilink->y);CHKERRQ(ierr); 11909df09d43SBarry Smith ierr = PetscLogEventEnd(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL);CHKERRQ(ierr); 11912618eb8fSHong Zhang ierr = KSPGetConvergedReason(ilink->ksp,&reason);CHKERRQ(ierr); 11922618eb8fSHong Zhang if (reason == KSP_DIVERGED_PCSETUP_FAILED) { 11932618eb8fSHong Zhang pc->failedreason = PC_SUBPC_ERROR; 11942618eb8fSHong Zhang } 1195421e10b8SBarry Smith ilink = ilink->next; 1196421e10b8SBarry Smith } 1197421e10b8SBarry Smith ierr = VecStrideScatterAll(jac->y,y,INSERT_VALUES);CHKERRQ(ierr); 1198421e10b8SBarry Smith } else { 1199421e10b8SBarry Smith ierr = VecSet(y,0.0);CHKERRQ(ierr); 1200421e10b8SBarry Smith while (ilink) { 1201421e10b8SBarry Smith ierr = FieldSplitSplitSolveAddTranspose(ilink,x,y);CHKERRQ(ierr); 12022618eb8fSHong Zhang ierr = KSPGetConvergedReason(ilink->ksp,&reason);CHKERRQ(ierr); 12032618eb8fSHong Zhang if (reason == KSP_DIVERGED_PCSETUP_FAILED) { 12042618eb8fSHong Zhang pc->failedreason = PC_SUBPC_ERROR; 12052618eb8fSHong Zhang } 1206421e10b8SBarry Smith ilink = ilink->next; 1207421e10b8SBarry Smith } 1208421e10b8SBarry Smith } 1209421e10b8SBarry Smith } else { 1210421e10b8SBarry Smith if (!jac->w1) { 1211421e10b8SBarry Smith ierr = VecDuplicate(x,&jac->w1);CHKERRQ(ierr); 1212421e10b8SBarry Smith ierr = VecDuplicate(x,&jac->w2);CHKERRQ(ierr); 1213421e10b8SBarry Smith } 1214421e10b8SBarry Smith ierr = VecSet(y,0.0);CHKERRQ(ierr); 1215421e10b8SBarry Smith if (jac->type == PC_COMPOSITE_SYMMETRIC_MULTIPLICATIVE) { 1216421e10b8SBarry Smith ierr = FieldSplitSplitSolveAddTranspose(ilink,x,y);CHKERRQ(ierr); 12172618eb8fSHong Zhang ierr = KSPGetConvergedReason(ilink->ksp,&reason);CHKERRQ(ierr); 12182618eb8fSHong Zhang if (reason == KSP_DIVERGED_PCSETUP_FAILED) { 12192618eb8fSHong Zhang pc->failedreason = PC_SUBPC_ERROR; 12202618eb8fSHong Zhang } 1221421e10b8SBarry Smith while (ilink->next) { 1222421e10b8SBarry Smith ilink = ilink->next; 12239989ab13SBarry Smith ierr = MatMultTranspose(pc->mat,y,jac->w1);CHKERRQ(ierr); 1224421e10b8SBarry Smith ierr = VecWAXPY(jac->w2,-1.0,jac->w1,x);CHKERRQ(ierr); 1225421e10b8SBarry Smith ierr = FieldSplitSplitSolveAddTranspose(ilink,jac->w2,y);CHKERRQ(ierr); 1226421e10b8SBarry Smith } 1227421e10b8SBarry Smith while (ilink->previous) { 1228421e10b8SBarry Smith ilink = ilink->previous; 12299989ab13SBarry Smith ierr = MatMultTranspose(pc->mat,y,jac->w1);CHKERRQ(ierr); 1230421e10b8SBarry Smith ierr = VecWAXPY(jac->w2,-1.0,jac->w1,x);CHKERRQ(ierr); 1231421e10b8SBarry Smith ierr = FieldSplitSplitSolveAddTranspose(ilink,jac->w2,y);CHKERRQ(ierr); 1232421e10b8SBarry Smith } 1233421e10b8SBarry Smith } else { 1234421e10b8SBarry Smith while (ilink->next) { /* get to last entry in linked list */ 1235421e10b8SBarry Smith ilink = ilink->next; 1236421e10b8SBarry Smith } 1237421e10b8SBarry Smith ierr = FieldSplitSplitSolveAddTranspose(ilink,x,y);CHKERRQ(ierr); 12382618eb8fSHong Zhang ierr = KSPGetConvergedReason(ilink->ksp,&reason);CHKERRQ(ierr); 12392618eb8fSHong Zhang if (reason == KSP_DIVERGED_PCSETUP_FAILED) { 12402618eb8fSHong Zhang pc->failedreason = PC_SUBPC_ERROR; 12412618eb8fSHong Zhang } 1242421e10b8SBarry Smith while (ilink->previous) { 1243421e10b8SBarry Smith ilink = ilink->previous; 12449989ab13SBarry Smith ierr = MatMultTranspose(pc->mat,y,jac->w1);CHKERRQ(ierr); 1245421e10b8SBarry Smith ierr = VecWAXPY(jac->w2,-1.0,jac->w1,x);CHKERRQ(ierr); 1246421e10b8SBarry Smith ierr = FieldSplitSplitSolveAddTranspose(ilink,jac->w2,y);CHKERRQ(ierr); 1247421e10b8SBarry Smith } 1248421e10b8SBarry Smith } 1249421e10b8SBarry Smith } 1250421e10b8SBarry Smith PetscFunctionReturn(0); 1251421e10b8SBarry Smith } 1252421e10b8SBarry Smith 1253574deadeSBarry Smith static PetscErrorCode PCReset_FieldSplit(PC pc) 12540971522cSBarry Smith { 12550971522cSBarry Smith PC_FieldSplit *jac = (PC_FieldSplit*)pc->data; 12560971522cSBarry Smith PetscErrorCode ierr; 12575a9f2f41SSatish Balay PC_FieldSplitLink ilink = jac->head,next; 12580971522cSBarry Smith 12590971522cSBarry Smith PetscFunctionBegin; 12605a9f2f41SSatish Balay while (ilink) { 1261f5f0d762SBarry Smith ierr = KSPDestroy(&ilink->ksp);CHKERRQ(ierr); 1262fcfd50ebSBarry Smith ierr = VecDestroy(&ilink->x);CHKERRQ(ierr); 1263fcfd50ebSBarry Smith ierr = VecDestroy(&ilink->y);CHKERRQ(ierr); 1264443836d0SMatthew G Knepley ierr = VecDestroy(&ilink->z);CHKERRQ(ierr); 1265fcfd50ebSBarry Smith ierr = VecScatterDestroy(&ilink->sctx);CHKERRQ(ierr); 1266fcfd50ebSBarry Smith ierr = ISDestroy(&ilink->is);CHKERRQ(ierr); 1267b5787286SJed Brown ierr = ISDestroy(&ilink->is_col);CHKERRQ(ierr); 1268f5f0d762SBarry Smith ierr = PetscFree(ilink->splitname);CHKERRQ(ierr); 1269f5f0d762SBarry Smith ierr = PetscFree(ilink->fields);CHKERRQ(ierr); 1270f5f0d762SBarry Smith ierr = PetscFree(ilink->fields_col);CHKERRQ(ierr); 12715a9f2f41SSatish Balay next = ilink->next; 1272f5f0d762SBarry Smith ierr = PetscFree(ilink);CHKERRQ(ierr); 12735a9f2f41SSatish Balay ilink = next; 12740971522cSBarry Smith } 1275f5f0d762SBarry Smith jac->head = NULL; 127605b42c5fSBarry Smith ierr = PetscFree2(jac->x,jac->y);CHKERRQ(ierr); 1277574deadeSBarry Smith if (jac->mat && jac->mat != jac->pmat) { 1278574deadeSBarry Smith ierr = MatDestroyMatrices(jac->nsplits,&jac->mat);CHKERRQ(ierr); 1279574deadeSBarry Smith } else if (jac->mat) { 12800298fd71SBarry Smith jac->mat = NULL; 1281574deadeSBarry Smith } 128297bbdb24SBarry Smith if (jac->pmat) {ierr = MatDestroyMatrices(jac->nsplits,&jac->pmat);CHKERRQ(ierr);} 128368dd23aaSBarry Smith if (jac->Afield) {ierr = MatDestroyMatrices(jac->nsplits,&jac->Afield);CHKERRQ(ierr);} 1284f5f0d762SBarry Smith jac->nsplits = 0; 12856bf464f9SBarry Smith ierr = VecDestroy(&jac->w1);CHKERRQ(ierr); 12866bf464f9SBarry Smith ierr = VecDestroy(&jac->w2);CHKERRQ(ierr); 12876bf464f9SBarry Smith ierr = MatDestroy(&jac->schur);CHKERRQ(ierr); 1288a7476a74SDmitry Karpeev ierr = MatDestroy(&jac->schurp);CHKERRQ(ierr); 12896bf464f9SBarry Smith ierr = MatDestroy(&jac->schur_user);CHKERRQ(ierr); 12906bf464f9SBarry Smith ierr = KSPDestroy(&jac->kspschur);CHKERRQ(ierr); 1291d78dad28SBarry Smith ierr = KSPDestroy(&jac->kspupper);CHKERRQ(ierr); 12926bf464f9SBarry Smith ierr = MatDestroy(&jac->B);CHKERRQ(ierr); 12936bf464f9SBarry Smith ierr = MatDestroy(&jac->C);CHKERRQ(ierr); 12946dbb499eSCian Wilson jac->isrestrict = PETSC_FALSE; 1295574deadeSBarry Smith PetscFunctionReturn(0); 1296574deadeSBarry Smith } 1297574deadeSBarry Smith 1298574deadeSBarry Smith static PetscErrorCode PCDestroy_FieldSplit(PC pc) 1299574deadeSBarry Smith { 1300574deadeSBarry Smith PetscErrorCode ierr; 1301574deadeSBarry Smith 1302574deadeSBarry Smith PetscFunctionBegin; 1303574deadeSBarry Smith ierr = PCReset_FieldSplit(pc);CHKERRQ(ierr); 1304c31cb41cSBarry Smith ierr = PetscFree(pc->data);CHKERRQ(ierr); 1305285fb4e2SStefano Zampini ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSchurGetSubKSP_C",NULL);CHKERRQ(ierr); 1306bdf89e91SBarry Smith ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitGetSubKSP_C",NULL);CHKERRQ(ierr); 1307bdf89e91SBarry Smith ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetFields_C",NULL);CHKERRQ(ierr); 1308bdf89e91SBarry Smith ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetIS_C",NULL);CHKERRQ(ierr); 1309bdf89e91SBarry Smith ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetType_C",NULL);CHKERRQ(ierr); 1310bdf89e91SBarry Smith ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetBlockSize_C",NULL);CHKERRQ(ierr); 131129f8a81cSJed Brown ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetSchurPre_C",NULL);CHKERRQ(ierr); 131237a82bf0SJed Brown ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitGetSchurPre_C",NULL);CHKERRQ(ierr); 1313bdf89e91SBarry Smith ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetSchurFactType_C",NULL);CHKERRQ(ierr); 13146dbb499eSCian Wilson ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitRestrictIS_C",NULL);CHKERRQ(ierr); 13150971522cSBarry Smith PetscFunctionReturn(0); 13160971522cSBarry Smith } 13170971522cSBarry Smith 13184416b707SBarry Smith static PetscErrorCode PCSetFromOptions_FieldSplit(PetscOptionItems *PetscOptionsObject,PC pc) 13190971522cSBarry Smith { 13201b9fc7fcSBarry Smith PetscErrorCode ierr; 13216c924f48SJed Brown PetscInt bs; 13227b752e3dSPatrick Sanan PetscBool flg; 13239dcbbd2bSBarry Smith PC_FieldSplit *jac = (PC_FieldSplit*)pc->data; 13243b224e63SBarry Smith PCCompositeType ctype; 13251b9fc7fcSBarry Smith 13260971522cSBarry Smith PetscFunctionBegin; 1327e55864a3SBarry Smith ierr = PetscOptionsHead(PetscOptionsObject,"FieldSplit options");CHKERRQ(ierr); 13284ab8060aSDmitry Karpeev ierr = PetscOptionsBool("-pc_fieldsplit_dm_splits","Whether to use DMCreateFieldDecomposition() for splits","PCFieldSplitSetDMSplits",jac->dm_splits,&jac->dm_splits,NULL);CHKERRQ(ierr); 132951f519a2SBarry Smith ierr = PetscOptionsInt("-pc_fieldsplit_block_size","Blocksize that defines number of fields","PCFieldSplitSetBlockSize",jac->bs,&bs,&flg);CHKERRQ(ierr); 133051f519a2SBarry Smith if (flg) { 133151f519a2SBarry Smith ierr = PCFieldSplitSetBlockSize(pc,bs);CHKERRQ(ierr); 133251f519a2SBarry Smith } 13332686e3e9SMatthew G. Knepley jac->diag_use_amat = pc->useAmat; 13342686e3e9SMatthew 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); 13352686e3e9SMatthew G. Knepley jac->offdiag_use_amat = pc->useAmat; 13362686e3e9SMatthew 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); 13377b752e3dSPatrick 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); 13387b752e3dSPatrick Sanan ierr = PCFieldSplitSetDetectSaddlePoint(pc,jac->detect);CHKERRQ(ierr); /* Sets split type and Schur PC type */ 13393b224e63SBarry Smith ierr = PetscOptionsEnum("-pc_fieldsplit_type","Type of composition","PCFieldSplitSetType",PCCompositeTypes,(PetscEnum)jac->type,(PetscEnum*)&ctype,&flg);CHKERRQ(ierr); 13403b224e63SBarry Smith if (flg) { 13413b224e63SBarry Smith ierr = PCFieldSplitSetType(pc,ctype);CHKERRQ(ierr); 13423b224e63SBarry Smith } 1343c30613efSMatthew Knepley /* Only setup fields once */ 1344c30613efSMatthew Knepley if ((jac->bs > 0) && (jac->nsplits == 0)) { 1345d32f9abdSBarry Smith /* only allow user to set fields from command line if bs is already known. 1346d32f9abdSBarry Smith otherwise user can set them in PCFieldSplitSetDefaults() */ 13476c924f48SJed Brown ierr = PCFieldSplitSetRuntimeSplits_Private(pc);CHKERRQ(ierr); 13486c924f48SJed Brown if (jac->splitdefined) {ierr = PetscInfo(pc,"Splits defined using the options database\n");CHKERRQ(ierr);} 1349d32f9abdSBarry Smith } 1350c5d2311dSJed Brown if (jac->type == PC_COMPOSITE_SCHUR) { 1351c5929fdfSBarry Smith ierr = PetscOptionsGetEnum(((PetscObject)pc)->options,((PetscObject)pc)->prefix,"-pc_fieldsplit_schur_factorization_type",PCFieldSplitSchurFactTypes,(PetscEnum*)&jac->schurfactorization,&flg);CHKERRQ(ierr); 1352c9c6ffaaSJed Brown if (flg) {ierr = PetscInfo(pc,"Deprecated use of -pc_fieldsplit_schur_factorization_type\n");CHKERRQ(ierr);} 13530298fd71SBarry 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); 135429f8a81cSJed 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); 1355c096484dSStefano Zampini ierr = PetscOptionsScalar("-pc_fieldsplit_schur_scale","Scale Schur complement","PCFieldSplitSetSchurScale",jac->schurscale,&jac->schurscale,NULL);CHKERRQ(ierr); 1356c5d2311dSJed Brown } 13571b9fc7fcSBarry Smith ierr = PetscOptionsTail();CHKERRQ(ierr); 13580971522cSBarry Smith PetscFunctionReturn(0); 13590971522cSBarry Smith } 13600971522cSBarry Smith 13610971522cSBarry Smith /*------------------------------------------------------------------------------------*/ 13620971522cSBarry Smith 13631e6b0712SBarry Smith static PetscErrorCode PCFieldSplitSetFields_FieldSplit(PC pc,const char splitname[],PetscInt n,const PetscInt *fields,const PetscInt *fields_col) 13640971522cSBarry Smith { 136597bbdb24SBarry Smith PC_FieldSplit *jac = (PC_FieldSplit*)pc->data; 13660971522cSBarry Smith PetscErrorCode ierr; 13675a9f2f41SSatish Balay PC_FieldSplitLink ilink,next = jac->head; 136869a612a9SBarry Smith char prefix[128]; 13695d4c12cdSJungho Lee PetscInt i; 13700971522cSBarry Smith 13710971522cSBarry Smith PetscFunctionBegin; 13726c924f48SJed Brown if (jac->splitdefined) { 13736c924f48SJed Brown ierr = PetscInfo1(pc,"Ignoring new split \"%s\" because the splits have already been defined\n",splitname);CHKERRQ(ierr); 13746c924f48SJed Brown PetscFunctionReturn(0); 13756c924f48SJed Brown } 137651f519a2SBarry Smith for (i=0; i<n; i++) { 1377e32f2f54SBarry 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); 1378e32f2f54SBarry Smith if (fields[i] < 0) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Negative field %D requested",fields[i]); 137951f519a2SBarry Smith } 1380b00a9115SJed Brown ierr = PetscNew(&ilink);CHKERRQ(ierr); 1381a04f6461SBarry Smith if (splitname) { 1382db4c96c1SJed Brown ierr = PetscStrallocpy(splitname,&ilink->splitname);CHKERRQ(ierr); 1383a04f6461SBarry Smith } else { 1384785e854fSJed Brown ierr = PetscMalloc1(3,&ilink->splitname);CHKERRQ(ierr); 1385a04f6461SBarry Smith ierr = PetscSNPrintf(ilink->splitname,2,"%s",jac->nsplits);CHKERRQ(ierr); 1386a04f6461SBarry Smith } 13879df09d43SBarry 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 */ 1388785e854fSJed Brown ierr = PetscMalloc1(n,&ilink->fields);CHKERRQ(ierr); 13895a9f2f41SSatish Balay ierr = PetscMemcpy(ilink->fields,fields,n*sizeof(PetscInt));CHKERRQ(ierr); 1390785e854fSJed Brown ierr = PetscMalloc1(n,&ilink->fields_col);CHKERRQ(ierr); 13915d4c12cdSJungho Lee ierr = PetscMemcpy(ilink->fields_col,fields_col,n*sizeof(PetscInt));CHKERRQ(ierr); 13922fa5cd67SKarl Rupp 13935a9f2f41SSatish Balay ilink->nfields = n; 13940298fd71SBarry Smith ilink->next = NULL; 1395ce94432eSBarry Smith ierr = KSPCreate(PetscObjectComm((PetscObject)pc),&ilink->ksp);CHKERRQ(ierr); 1396422a814eSBarry Smith ierr = KSPSetErrorIfNotConverged(ilink->ksp,pc->erroriffailure);CHKERRQ(ierr); 139720252d06SBarry Smith ierr = PetscObjectIncrementTabLevel((PetscObject)ilink->ksp,(PetscObject)pc,1);CHKERRQ(ierr); 13985a9f2f41SSatish Balay ierr = KSPSetType(ilink->ksp,KSPPREONLY);CHKERRQ(ierr); 13999005cf84SBarry Smith ierr = PetscLogObjectParent((PetscObject)pc,(PetscObject)ilink->ksp);CHKERRQ(ierr); 140069a612a9SBarry Smith 14018caf3d72SBarry Smith ierr = PetscSNPrintf(prefix,sizeof(prefix),"%sfieldsplit_%s_",((PetscObject)pc)->prefix ? ((PetscObject)pc)->prefix : "",ilink->splitname);CHKERRQ(ierr); 14025a9f2f41SSatish Balay ierr = KSPSetOptionsPrefix(ilink->ksp,prefix);CHKERRQ(ierr); 14030971522cSBarry Smith 14040971522cSBarry Smith if (!next) { 14055a9f2f41SSatish Balay jac->head = ilink; 14060298fd71SBarry Smith ilink->previous = NULL; 14070971522cSBarry Smith } else { 14080971522cSBarry Smith while (next->next) { 14090971522cSBarry Smith next = next->next; 14100971522cSBarry Smith } 14115a9f2f41SSatish Balay next->next = ilink; 141251f519a2SBarry Smith ilink->previous = next; 14130971522cSBarry Smith } 14140971522cSBarry Smith jac->nsplits++; 14150971522cSBarry Smith PetscFunctionReturn(0); 14160971522cSBarry Smith } 14170971522cSBarry Smith 1418285fb4e2SStefano Zampini static PetscErrorCode PCFieldSplitSchurGetSubKSP_FieldSplit(PC pc,PetscInt *n,KSP **subksp) 1419285fb4e2SStefano Zampini { 1420285fb4e2SStefano Zampini PC_FieldSplit *jac = (PC_FieldSplit*)pc->data; 1421285fb4e2SStefano Zampini PetscErrorCode ierr; 1422285fb4e2SStefano Zampini 1423285fb4e2SStefano Zampini PetscFunctionBegin; 1424285fb4e2SStefano Zampini *subksp = NULL; 1425285fb4e2SStefano Zampini if (n) *n = 0; 1426285fb4e2SStefano Zampini if (jac->type == PC_COMPOSITE_SCHUR) { 1427285fb4e2SStefano Zampini PetscInt nn; 1428285fb4e2SStefano Zampini 1429285fb4e2SStefano Zampini if (!jac->schur) SETERRQ(PetscObjectComm((PetscObject)pc),PETSC_ERR_ARG_WRONGSTATE,"Must call KSPSetUp() or PCSetUp() before calling PCFieldSplitSchurGetSubKSP()"); 1430285fb4e2SStefano Zampini if (jac->nsplits != 2) SETERRQ1(PetscObjectComm((PetscObject)pc),PETSC_ERR_PLIB,"Unexpected number of splits %D != 2",jac->nsplits); 1431285fb4e2SStefano Zampini nn = jac->nsplits + (jac->kspupper != jac->head->ksp ? 1 : 0); 1432285fb4e2SStefano Zampini ierr = PetscMalloc1(nn,subksp);CHKERRQ(ierr); 1433285fb4e2SStefano Zampini (*subksp)[0] = jac->head->ksp; 1434285fb4e2SStefano Zampini (*subksp)[1] = jac->kspschur; 1435285fb4e2SStefano Zampini if (jac->kspupper != jac->head->ksp) (*subksp)[2] = jac->kspupper; 1436285fb4e2SStefano Zampini if (n) *n = nn; 1437285fb4e2SStefano Zampini } 1438285fb4e2SStefano Zampini PetscFunctionReturn(0); 1439285fb4e2SStefano Zampini } 1440285fb4e2SStefano Zampini 14411e6b0712SBarry Smith static PetscErrorCode PCFieldSplitGetSubKSP_FieldSplit_Schur(PC pc,PetscInt *n,KSP **subksp) 1442e69d4d44SBarry Smith { 1443e69d4d44SBarry Smith PC_FieldSplit *jac = (PC_FieldSplit*)pc->data; 1444e69d4d44SBarry Smith PetscErrorCode ierr; 1445e69d4d44SBarry Smith 1446e69d4d44SBarry Smith PetscFunctionBegin; 144734a3b412SBarry Smith if (!jac->schur) SETERRQ(PetscObjectComm((PetscObject)pc),PETSC_ERR_ARG_WRONGSTATE,"Must call KSPSetUp() or PCSetUp() before calling PCFieldSplitGetSubKSP()"); 1448785e854fSJed Brown ierr = PetscMalloc1(jac->nsplits,subksp);CHKERRQ(ierr); 1449e69d4d44SBarry Smith ierr = MatSchurComplementGetKSP(jac->schur,*subksp);CHKERRQ(ierr); 14502fa5cd67SKarl Rupp 1451e69d4d44SBarry Smith (*subksp)[1] = jac->kspschur; 145213e0d083SBarry Smith if (n) *n = jac->nsplits; 1453e69d4d44SBarry Smith PetscFunctionReturn(0); 1454e69d4d44SBarry Smith } 14550971522cSBarry Smith 14561e6b0712SBarry Smith static PetscErrorCode PCFieldSplitGetSubKSP_FieldSplit(PC pc,PetscInt *n,KSP **subksp) 14570971522cSBarry Smith { 14580971522cSBarry Smith PC_FieldSplit *jac = (PC_FieldSplit*)pc->data; 14590971522cSBarry Smith PetscErrorCode ierr; 14600971522cSBarry Smith PetscInt cnt = 0; 14615a9f2f41SSatish Balay PC_FieldSplitLink ilink = jac->head; 14620971522cSBarry Smith 14630971522cSBarry Smith PetscFunctionBegin; 1464785e854fSJed Brown ierr = PetscMalloc1(jac->nsplits,subksp);CHKERRQ(ierr); 14655a9f2f41SSatish Balay while (ilink) { 14665a9f2f41SSatish Balay (*subksp)[cnt++] = ilink->ksp; 14675a9f2f41SSatish Balay ilink = ilink->next; 14680971522cSBarry Smith } 14695d480477SMatthew 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); 147013e0d083SBarry Smith if (n) *n = jac->nsplits; 14710971522cSBarry Smith PetscFunctionReturn(0); 14720971522cSBarry Smith } 14730971522cSBarry Smith 14746dbb499eSCian Wilson /*@C 14756dbb499eSCian Wilson PCFieldSplitRestrictIS - Restricts the fieldsplit ISs to be within a given IS. 14766dbb499eSCian Wilson 14776dbb499eSCian Wilson Input Parameters: 14786dbb499eSCian Wilson + pc - the preconditioner context 14796dbb499eSCian Wilson + is - the index set that defines the indices to which the fieldsplit is to be restricted 14806dbb499eSCian Wilson 14816dbb499eSCian Wilson Level: advanced 14826dbb499eSCian Wilson 14836dbb499eSCian Wilson @*/ 14846dbb499eSCian Wilson PetscErrorCode PCFieldSplitRestrictIS(PC pc,IS isy) 14856dbb499eSCian Wilson { 14866dbb499eSCian Wilson PetscErrorCode ierr; 14876dbb499eSCian Wilson 14886dbb499eSCian Wilson PetscFunctionBegin; 14896dbb499eSCian Wilson PetscValidHeaderSpecific(pc,PC_CLASSID,1); 14906dbb499eSCian Wilson PetscValidHeaderSpecific(isy,IS_CLASSID,2); 14910246f55cSBarry Smith ierr = PetscTryMethod(pc,"PCFieldSplitRestrictIS_C",(PC,IS),(pc,isy));CHKERRQ(ierr); 14926dbb499eSCian Wilson PetscFunctionReturn(0); 14936dbb499eSCian Wilson } 14946dbb499eSCian Wilson 14956dbb499eSCian Wilson 14966dbb499eSCian Wilson static PetscErrorCode PCFieldSplitRestrictIS_FieldSplit(PC pc, IS isy) 14976dbb499eSCian Wilson { 14986dbb499eSCian Wilson PC_FieldSplit *jac = (PC_FieldSplit*)pc->data; 14996dbb499eSCian Wilson PetscErrorCode ierr; 15006dbb499eSCian Wilson PC_FieldSplitLink ilink = jac->head, next; 15016dbb499eSCian Wilson PetscInt localsize,size,sizez,i; 15026dbb499eSCian Wilson const PetscInt *ind, *indz; 15036dbb499eSCian Wilson PetscInt *indc, *indcz; 15046dbb499eSCian Wilson PetscBool flg; 15056dbb499eSCian Wilson 15066dbb499eSCian Wilson PetscFunctionBegin; 15076dbb499eSCian Wilson ierr = ISGetLocalSize(isy,&localsize);CHKERRQ(ierr); 15086dbb499eSCian Wilson ierr = MPI_Scan(&localsize,&size,1,MPIU_INT,MPI_SUM,PetscObjectComm((PetscObject)isy));CHKERRQ(ierr); 15096dbb499eSCian Wilson size -= localsize; 15106dbb499eSCian Wilson while(ilink) { 15116dbb499eSCian Wilson IS isrl,isr; 15121c7cfba8SBarry Smith PC subpc; 15136dbb499eSCian Wilson ierr = ISEmbed(ilink->is, isy, PETSC_TRUE, &isrl);CHKERRQ(ierr); 15146dbb499eSCian Wilson ierr = ISGetLocalSize(isrl,&localsize);CHKERRQ(ierr); 15156dbb499eSCian Wilson ierr = PetscMalloc1(localsize,&indc);CHKERRQ(ierr); 15166dbb499eSCian Wilson ierr = ISGetIndices(isrl,&ind);CHKERRQ(ierr); 15176dbb499eSCian Wilson ierr = PetscMemcpy(indc,ind,localsize*sizeof(PetscInt));CHKERRQ(ierr); 15186dbb499eSCian Wilson ierr = ISRestoreIndices(isrl,&ind);CHKERRQ(ierr); 15196dbb499eSCian Wilson ierr = ISDestroy(&isrl);CHKERRQ(ierr); 15206dbb499eSCian Wilson for (i=0; i<localsize; i++) *(indc+i) += size; 15216dbb499eSCian Wilson ierr = ISCreateGeneral(PetscObjectComm((PetscObject)isy),localsize,indc,PETSC_OWN_POINTER,&isr);CHKERRQ(ierr); 15226dbb499eSCian Wilson ierr = PetscObjectReference((PetscObject)isr);CHKERRQ(ierr); 15236dbb499eSCian Wilson ierr = ISDestroy(&ilink->is);CHKERRQ(ierr); 15246dbb499eSCian Wilson ilink->is = isr; 15256dbb499eSCian Wilson ierr = PetscObjectReference((PetscObject)isr);CHKERRQ(ierr); 15266dbb499eSCian Wilson ierr = ISDestroy(&ilink->is_col);CHKERRQ(ierr); 15276dbb499eSCian Wilson ilink->is_col = isr; 15286dbb499eSCian Wilson ierr = ISDestroy(&isr);CHKERRQ(ierr); 15296dbb499eSCian Wilson ierr = KSPGetPC(ilink->ksp, &subpc);CHKERRQ(ierr); 15306dbb499eSCian Wilson ierr = PetscObjectTypeCompare((PetscObject)subpc,PCFIELDSPLIT,&flg);CHKERRQ(ierr); 15316dbb499eSCian Wilson if(flg) { 15326dbb499eSCian Wilson IS iszl,isz; 15336dbb499eSCian Wilson MPI_Comm comm; 15346dbb499eSCian Wilson ierr = ISGetLocalSize(ilink->is,&localsize);CHKERRQ(ierr); 15356dbb499eSCian Wilson comm = PetscObjectComm((PetscObject)ilink->is); 15366dbb499eSCian Wilson ierr = ISEmbed(isy, ilink->is, PETSC_TRUE, &iszl);CHKERRQ(ierr); 15376dbb499eSCian Wilson ierr = MPI_Scan(&localsize,&sizez,1,MPIU_INT,MPI_SUM,comm);CHKERRQ(ierr); 15386dbb499eSCian Wilson sizez -= localsize; 15396dbb499eSCian Wilson ierr = ISGetLocalSize(iszl,&localsize);CHKERRQ(ierr); 15406dbb499eSCian Wilson ierr = PetscMalloc1(localsize,&indcz);CHKERRQ(ierr); 15416dbb499eSCian Wilson ierr = ISGetIndices(iszl,&indz);CHKERRQ(ierr); 15426dbb499eSCian Wilson ierr = PetscMemcpy(indcz,indz,localsize*sizeof(PetscInt));CHKERRQ(ierr); 15436dbb499eSCian Wilson ierr = ISRestoreIndices(iszl,&indz);CHKERRQ(ierr); 15446dbb499eSCian Wilson ierr = ISDestroy(&iszl);CHKERRQ(ierr); 15456dbb499eSCian Wilson for (i=0; i<localsize; i++) *(indcz+i) += sizez; 15466dbb499eSCian Wilson ierr = ISCreateGeneral(comm,localsize,indcz,PETSC_OWN_POINTER,&isz);CHKERRQ(ierr); 15476dbb499eSCian Wilson ierr = PCFieldSplitRestrictIS(subpc,isz);CHKERRQ(ierr); 15486dbb499eSCian Wilson ierr = ISDestroy(&isz);CHKERRQ(ierr); 15496dbb499eSCian Wilson } 15506dbb499eSCian Wilson next = ilink->next; 15516dbb499eSCian Wilson ilink = next; 15526dbb499eSCian Wilson } 15536dbb499eSCian Wilson jac->isrestrict = PETSC_TRUE; 15546dbb499eSCian Wilson PetscFunctionReturn(0); 15556dbb499eSCian Wilson } 15566dbb499eSCian Wilson 15571e6b0712SBarry Smith static PetscErrorCode PCFieldSplitSetIS_FieldSplit(PC pc,const char splitname[],IS is) 1558704ba839SBarry Smith { 1559704ba839SBarry Smith PC_FieldSplit *jac = (PC_FieldSplit*)pc->data; 1560704ba839SBarry Smith PetscErrorCode ierr; 1561704ba839SBarry Smith PC_FieldSplitLink ilink, next = jac->head; 1562704ba839SBarry Smith char prefix[128]; 1563704ba839SBarry Smith 1564704ba839SBarry Smith PetscFunctionBegin; 15656c924f48SJed Brown if (jac->splitdefined) { 15666c924f48SJed Brown ierr = PetscInfo1(pc,"Ignoring new split \"%s\" because the splits have already been defined\n",splitname);CHKERRQ(ierr); 15676c924f48SJed Brown PetscFunctionReturn(0); 15686c924f48SJed Brown } 1569b00a9115SJed Brown ierr = PetscNew(&ilink);CHKERRQ(ierr); 1570a04f6461SBarry Smith if (splitname) { 1571db4c96c1SJed Brown ierr = PetscStrallocpy(splitname,&ilink->splitname);CHKERRQ(ierr); 1572a04f6461SBarry Smith } else { 1573785e854fSJed Brown ierr = PetscMalloc1(8,&ilink->splitname);CHKERRQ(ierr); 1574b5787286SJed Brown ierr = PetscSNPrintf(ilink->splitname,7,"%D",jac->nsplits);CHKERRQ(ierr); 1575a04f6461SBarry Smith } 15769df09d43SBarry 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 */ 15771ab39975SBarry Smith ierr = PetscObjectReference((PetscObject)is);CHKERRQ(ierr); 1578b5787286SJed Brown ierr = ISDestroy(&ilink->is);CHKERRQ(ierr); 1579b5787286SJed Brown ilink->is = is; 1580b5787286SJed Brown ierr = PetscObjectReference((PetscObject)is);CHKERRQ(ierr); 1581b5787286SJed Brown ierr = ISDestroy(&ilink->is_col);CHKERRQ(ierr); 1582b5787286SJed Brown ilink->is_col = is; 15830298fd71SBarry Smith ilink->next = NULL; 1584ce94432eSBarry Smith ierr = KSPCreate(PetscObjectComm((PetscObject)pc),&ilink->ksp);CHKERRQ(ierr); 1585422a814eSBarry Smith ierr = KSPSetErrorIfNotConverged(ilink->ksp,pc->erroriffailure);CHKERRQ(ierr); 158620252d06SBarry Smith ierr = PetscObjectIncrementTabLevel((PetscObject)ilink->ksp,(PetscObject)pc,1);CHKERRQ(ierr); 1587704ba839SBarry Smith ierr = KSPSetType(ilink->ksp,KSPPREONLY);CHKERRQ(ierr); 15889005cf84SBarry Smith ierr = PetscLogObjectParent((PetscObject)pc,(PetscObject)ilink->ksp);CHKERRQ(ierr); 1589704ba839SBarry Smith 15908caf3d72SBarry Smith ierr = PetscSNPrintf(prefix,sizeof(prefix),"%sfieldsplit_%s_",((PetscObject)pc)->prefix ? ((PetscObject)pc)->prefix : "",ilink->splitname);CHKERRQ(ierr); 1591704ba839SBarry Smith ierr = KSPSetOptionsPrefix(ilink->ksp,prefix);CHKERRQ(ierr); 1592704ba839SBarry Smith 1593704ba839SBarry Smith if (!next) { 1594704ba839SBarry Smith jac->head = ilink; 15950298fd71SBarry Smith ilink->previous = NULL; 1596704ba839SBarry Smith } else { 1597704ba839SBarry Smith while (next->next) { 1598704ba839SBarry Smith next = next->next; 1599704ba839SBarry Smith } 1600704ba839SBarry Smith next->next = ilink; 1601704ba839SBarry Smith ilink->previous = next; 1602704ba839SBarry Smith } 1603704ba839SBarry Smith jac->nsplits++; 1604704ba839SBarry Smith PetscFunctionReturn(0); 1605704ba839SBarry Smith } 1606704ba839SBarry Smith 160794ef8ddeSSatish Balay /*@C 16080971522cSBarry Smith PCFieldSplitSetFields - Sets the fields for one particular split in the field split preconditioner 16090971522cSBarry Smith 1610ad4df100SBarry Smith Logically Collective on PC 16110971522cSBarry Smith 16120971522cSBarry Smith Input Parameters: 16130971522cSBarry Smith + pc - the preconditioner context 16140298fd71SBarry Smith . splitname - name of this split, if NULL the number of the split is used 16150971522cSBarry Smith . n - the number of fields in this split 1616db4c96c1SJed Brown - fields - the fields in this split 16170971522cSBarry Smith 16180971522cSBarry Smith Level: intermediate 16190971522cSBarry Smith 162095452b02SPatrick Sanan Notes: 162195452b02SPatrick Sanan Use PCFieldSplitSetIS() to set a completely general set of indices as a field. 1622d32f9abdSBarry Smith 16237287d2a3SDmitry Karpeev The PCFieldSplitSetFields() is for defining fields as strided blocks. For example, if the block 1624d32f9abdSBarry 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 1625d32f9abdSBarry Smith 0xx3xx6xx9xx12 ... x1xx4xx7xx ... xx2xx5xx8xx.. 01x34x67x... 0x1x3x5x7.. x12x45x78x.... 1626d32f9abdSBarry Smith where the numbered entries indicate what is in the field. 1627d32f9abdSBarry Smith 1628db4c96c1SJed Brown This function is called once per split (it creates a new split each time). Solve options 1629db4c96c1SJed Brown for this split will be available under the prefix -fieldsplit_SPLITNAME_. 1630db4c96c1SJed Brown 16315d4c12cdSJungho Lee Developer Note: This routine does not actually create the IS representing the split, that is delayed 16325d4c12cdSJungho Lee until PCSetUp_FieldSplit(), because information about the vector/matrix layouts may not be 16335d4c12cdSJungho Lee available when this routine is called. 16345d4c12cdSJungho Lee 1635d32f9abdSBarry Smith .seealso: PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitSetBlockSize(), PCFieldSplitSetIS() 16360971522cSBarry Smith 16370971522cSBarry Smith @*/ 16385d4c12cdSJungho Lee PetscErrorCode PCFieldSplitSetFields(PC pc,const char splitname[],PetscInt n,const PetscInt *fields,const PetscInt *fields_col) 16390971522cSBarry Smith { 16404ac538c5SBarry Smith PetscErrorCode ierr; 16410971522cSBarry Smith 16420971522cSBarry Smith PetscFunctionBegin; 16430700a824SBarry Smith PetscValidHeaderSpecific(pc,PC_CLASSID,1); 1644db4c96c1SJed Brown PetscValidCharPointer(splitname,2); 1645ce94432eSBarry Smith if (n < 1) SETERRQ2(PetscObjectComm((PetscObject)pc),PETSC_ERR_ARG_OUTOFRANGE,"Provided number of fields %D in split \"%s\" not positive",n,splitname); 1646db4c96c1SJed Brown PetscValidIntPointer(fields,3); 16470246f55cSBarry Smith ierr = PetscTryMethod(pc,"PCFieldSplitSetFields_C",(PC,const char[],PetscInt,const PetscInt*,const PetscInt*),(pc,splitname,n,fields,fields_col));CHKERRQ(ierr); 16480971522cSBarry Smith PetscFunctionReturn(0); 16490971522cSBarry Smith } 16500971522cSBarry Smith 1651c84da90fSDmitry Karpeev /*@ 1652c84da90fSDmitry Karpeev PCFieldSplitSetDiagUseAmat - set flag indicating whether to extract diagonal blocks from Amat (rather than Pmat) 1653c84da90fSDmitry Karpeev 1654c84da90fSDmitry Karpeev Logically Collective on PC 1655c84da90fSDmitry Karpeev 1656c84da90fSDmitry Karpeev Input Parameters: 1657c84da90fSDmitry Karpeev + pc - the preconditioner object 1658c84da90fSDmitry Karpeev - flg - boolean flag indicating whether or not to use Amat to extract the diagonal blocks from 1659c84da90fSDmitry Karpeev 16609506b623SDmitry Karpeev Options Database: 16619506b623SDmitry Karpeev . -pc_fieldsplit_diag_use_amat 1662c84da90fSDmitry Karpeev 1663c84da90fSDmitry Karpeev Level: intermediate 1664c84da90fSDmitry Karpeev 1665c84da90fSDmitry Karpeev .seealso: PCFieldSplitGetDiagUseAmat(), PCFieldSplitSetOffDiagUseAmat(), PCFIELDSPLIT 1666c84da90fSDmitry Karpeev 1667c84da90fSDmitry Karpeev @*/ 1668c84da90fSDmitry Karpeev PetscErrorCode PCFieldSplitSetDiagUseAmat(PC pc,PetscBool flg) 1669c84da90fSDmitry Karpeev { 1670c84da90fSDmitry Karpeev PC_FieldSplit *jac = (PC_FieldSplit*)pc->data; 1671c84da90fSDmitry Karpeev PetscBool isfs; 1672c84da90fSDmitry Karpeev PetscErrorCode ierr; 1673c84da90fSDmitry Karpeev 1674c84da90fSDmitry Karpeev PetscFunctionBegin; 1675c84da90fSDmitry Karpeev PetscValidHeaderSpecific(pc,PC_CLASSID,1); 1676c84da90fSDmitry Karpeev ierr = PetscObjectTypeCompare((PetscObject)pc,PCFIELDSPLIT,&isfs);CHKERRQ(ierr); 1677c84da90fSDmitry Karpeev if (!isfs) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"PC not of type %s",PCFIELDSPLIT); 1678c84da90fSDmitry Karpeev jac->diag_use_amat = flg; 1679c84da90fSDmitry Karpeev PetscFunctionReturn(0); 1680c84da90fSDmitry Karpeev } 1681c84da90fSDmitry Karpeev 1682c84da90fSDmitry Karpeev /*@ 1683c84da90fSDmitry Karpeev PCFieldSplitGetDiagUseAmat - get the flag indicating whether to extract diagonal blocks from Amat (rather than Pmat) 1684c84da90fSDmitry Karpeev 1685c84da90fSDmitry Karpeev Logically Collective on PC 1686c84da90fSDmitry Karpeev 1687c84da90fSDmitry Karpeev Input Parameters: 1688c84da90fSDmitry Karpeev . pc - the preconditioner object 1689c84da90fSDmitry Karpeev 1690c84da90fSDmitry Karpeev Output Parameters: 1691c84da90fSDmitry Karpeev . flg - boolean flag indicating whether or not to use Amat to extract the diagonal blocks from 1692c84da90fSDmitry Karpeev 1693c84da90fSDmitry Karpeev 1694c84da90fSDmitry Karpeev Level: intermediate 1695c84da90fSDmitry Karpeev 1696c84da90fSDmitry Karpeev .seealso: PCFieldSplitSetDiagUseAmat(), PCFieldSplitGetOffDiagUseAmat(), PCFIELDSPLIT 1697c84da90fSDmitry Karpeev 1698c84da90fSDmitry Karpeev @*/ 1699c84da90fSDmitry Karpeev PetscErrorCode PCFieldSplitGetDiagUseAmat(PC pc,PetscBool *flg) 1700c84da90fSDmitry Karpeev { 1701c84da90fSDmitry Karpeev PC_FieldSplit *jac = (PC_FieldSplit*)pc->data; 1702c84da90fSDmitry Karpeev PetscBool isfs; 1703c84da90fSDmitry Karpeev PetscErrorCode ierr; 1704c84da90fSDmitry Karpeev 1705c84da90fSDmitry Karpeev PetscFunctionBegin; 1706c84da90fSDmitry Karpeev PetscValidHeaderSpecific(pc,PC_CLASSID,1); 1707c84da90fSDmitry Karpeev PetscValidPointer(flg,2); 1708c84da90fSDmitry Karpeev ierr = PetscObjectTypeCompare((PetscObject)pc,PCFIELDSPLIT,&isfs);CHKERRQ(ierr); 1709c84da90fSDmitry Karpeev if (!isfs) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"PC not of type %s",PCFIELDSPLIT); 1710c84da90fSDmitry Karpeev *flg = jac->diag_use_amat; 1711c84da90fSDmitry Karpeev PetscFunctionReturn(0); 1712c84da90fSDmitry Karpeev } 1713c84da90fSDmitry Karpeev 1714c84da90fSDmitry Karpeev /*@ 1715c84da90fSDmitry Karpeev PCFieldSplitSetOffDiagUseAmat - set flag indicating whether to extract off-diagonal blocks from Amat (rather than Pmat) 1716c84da90fSDmitry Karpeev 1717c84da90fSDmitry Karpeev Logically Collective on PC 1718c84da90fSDmitry Karpeev 1719c84da90fSDmitry Karpeev Input Parameters: 1720c84da90fSDmitry Karpeev + pc - the preconditioner object 1721c84da90fSDmitry Karpeev - flg - boolean flag indicating whether or not to use Amat to extract the off-diagonal blocks from 1722c84da90fSDmitry Karpeev 17239506b623SDmitry Karpeev Options Database: 17249506b623SDmitry Karpeev . -pc_fieldsplit_off_diag_use_amat 1725c84da90fSDmitry Karpeev 1726c84da90fSDmitry Karpeev Level: intermediate 1727c84da90fSDmitry Karpeev 1728c84da90fSDmitry Karpeev .seealso: PCFieldSplitGetOffDiagUseAmat(), PCFieldSplitSetDiagUseAmat(), PCFIELDSPLIT 1729c84da90fSDmitry Karpeev 1730c84da90fSDmitry Karpeev @*/ 1731c84da90fSDmitry Karpeev PetscErrorCode PCFieldSplitSetOffDiagUseAmat(PC pc,PetscBool flg) 1732c84da90fSDmitry Karpeev { 1733c84da90fSDmitry Karpeev PC_FieldSplit *jac = (PC_FieldSplit*)pc->data; 1734c84da90fSDmitry Karpeev PetscBool isfs; 1735c84da90fSDmitry Karpeev PetscErrorCode ierr; 1736c84da90fSDmitry Karpeev 1737c84da90fSDmitry Karpeev PetscFunctionBegin; 1738c84da90fSDmitry Karpeev PetscValidHeaderSpecific(pc,PC_CLASSID,1); 1739c84da90fSDmitry Karpeev ierr = PetscObjectTypeCompare((PetscObject)pc,PCFIELDSPLIT,&isfs);CHKERRQ(ierr); 1740c84da90fSDmitry Karpeev if (!isfs) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"PC not of type %s",PCFIELDSPLIT); 1741c84da90fSDmitry Karpeev jac->offdiag_use_amat = flg; 1742c84da90fSDmitry Karpeev PetscFunctionReturn(0); 1743c84da90fSDmitry Karpeev } 1744c84da90fSDmitry Karpeev 1745c84da90fSDmitry Karpeev /*@ 1746c84da90fSDmitry Karpeev PCFieldSplitGetOffDiagUseAmat - get the flag indicating whether to extract off-diagonal blocks from Amat (rather than Pmat) 1747c84da90fSDmitry Karpeev 1748c84da90fSDmitry Karpeev Logically Collective on PC 1749c84da90fSDmitry Karpeev 1750c84da90fSDmitry Karpeev Input Parameters: 1751c84da90fSDmitry Karpeev . pc - the preconditioner object 1752c84da90fSDmitry Karpeev 1753c84da90fSDmitry Karpeev Output Parameters: 1754c84da90fSDmitry Karpeev . flg - boolean flag indicating whether or not to use Amat to extract the off-diagonal blocks from 1755c84da90fSDmitry Karpeev 1756c84da90fSDmitry Karpeev 1757c84da90fSDmitry Karpeev Level: intermediate 1758c84da90fSDmitry Karpeev 1759c84da90fSDmitry Karpeev .seealso: PCFieldSplitSetOffDiagUseAmat(), PCFieldSplitGetDiagUseAmat(), PCFIELDSPLIT 1760c84da90fSDmitry Karpeev 1761c84da90fSDmitry Karpeev @*/ 1762c84da90fSDmitry Karpeev PetscErrorCode PCFieldSplitGetOffDiagUseAmat(PC pc,PetscBool *flg) 1763c84da90fSDmitry Karpeev { 1764c84da90fSDmitry Karpeev PC_FieldSplit *jac = (PC_FieldSplit*)pc->data; 1765c84da90fSDmitry Karpeev PetscBool isfs; 1766c84da90fSDmitry Karpeev PetscErrorCode ierr; 1767c84da90fSDmitry Karpeev 1768c84da90fSDmitry Karpeev PetscFunctionBegin; 1769c84da90fSDmitry Karpeev PetscValidHeaderSpecific(pc,PC_CLASSID,1); 1770c84da90fSDmitry Karpeev PetscValidPointer(flg,2); 1771c84da90fSDmitry Karpeev ierr = PetscObjectTypeCompare((PetscObject)pc,PCFIELDSPLIT,&isfs);CHKERRQ(ierr); 1772c84da90fSDmitry Karpeev if (!isfs) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"PC not of type %s",PCFIELDSPLIT); 1773c84da90fSDmitry Karpeev *flg = jac->offdiag_use_amat; 1774c84da90fSDmitry Karpeev PetscFunctionReturn(0); 1775c84da90fSDmitry Karpeev } 1776c84da90fSDmitry Karpeev 1777c84da90fSDmitry Karpeev 1778c84da90fSDmitry Karpeev 1779218d4943SBarry Smith /*@C 1780704ba839SBarry Smith PCFieldSplitSetIS - Sets the exact elements for field 1781704ba839SBarry Smith 1782ad4df100SBarry Smith Logically Collective on PC 1783704ba839SBarry Smith 1784704ba839SBarry Smith Input Parameters: 1785704ba839SBarry Smith + pc - the preconditioner context 17860298fd71SBarry Smith . splitname - name of this split, if NULL the number of the split is used 1787db4c96c1SJed Brown - is - the index set that defines the vector elements in this field 1788704ba839SBarry Smith 1789d32f9abdSBarry Smith 1790a6ffb8dbSJed Brown Notes: 1791a6ffb8dbSJed Brown Use PCFieldSplitSetFields(), for fields defined by strided types. 1792a6ffb8dbSJed Brown 1793db4c96c1SJed Brown This function is called once per split (it creates a new split each time). Solve options 1794db4c96c1SJed Brown for this split will be available under the prefix -fieldsplit_SPLITNAME_. 1795d32f9abdSBarry Smith 1796704ba839SBarry Smith Level: intermediate 1797704ba839SBarry Smith 1798704ba839SBarry Smith .seealso: PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitSetBlockSize() 1799704ba839SBarry Smith 1800704ba839SBarry Smith @*/ 18017087cfbeSBarry Smith PetscErrorCode PCFieldSplitSetIS(PC pc,const char splitname[],IS is) 1802704ba839SBarry Smith { 18034ac538c5SBarry Smith PetscErrorCode ierr; 1804704ba839SBarry Smith 1805704ba839SBarry Smith PetscFunctionBegin; 18060700a824SBarry Smith PetscValidHeaderSpecific(pc,PC_CLASSID,1); 18077b62db95SJungho Lee if (splitname) PetscValidCharPointer(splitname,2); 1808db4c96c1SJed Brown PetscValidHeaderSpecific(is,IS_CLASSID,3); 1809ccc738f7SBarry Smith ierr = PetscTryMethod(pc,"PCFieldSplitSetIS_C",(PC,const char[],IS),(pc,splitname,is));CHKERRQ(ierr); 1810704ba839SBarry Smith PetscFunctionReturn(0); 1811704ba839SBarry Smith } 1812704ba839SBarry Smith 181394ef8ddeSSatish Balay /*@C 181457a9adfeSMatthew G Knepley PCFieldSplitGetIS - Retrieves the elements for a field as an IS 181557a9adfeSMatthew G Knepley 181657a9adfeSMatthew G Knepley Logically Collective on PC 181757a9adfeSMatthew G Knepley 181857a9adfeSMatthew G Knepley Input Parameters: 181957a9adfeSMatthew G Knepley + pc - the preconditioner context 182057a9adfeSMatthew G Knepley - splitname - name of this split 182157a9adfeSMatthew G Knepley 182257a9adfeSMatthew G Knepley Output Parameter: 18230298fd71SBarry Smith - is - the index set that defines the vector elements in this field, or NULL if the field is not found 182457a9adfeSMatthew G Knepley 182557a9adfeSMatthew G Knepley Level: intermediate 182657a9adfeSMatthew G Knepley 182757a9adfeSMatthew G Knepley .seealso: PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitSetIS() 182857a9adfeSMatthew G Knepley 182957a9adfeSMatthew G Knepley @*/ 183057a9adfeSMatthew G Knepley PetscErrorCode PCFieldSplitGetIS(PC pc,const char splitname[],IS *is) 183157a9adfeSMatthew G Knepley { 183257a9adfeSMatthew G Knepley PetscErrorCode ierr; 183357a9adfeSMatthew G Knepley 183457a9adfeSMatthew G Knepley PetscFunctionBegin; 183557a9adfeSMatthew G Knepley PetscValidHeaderSpecific(pc,PC_CLASSID,1); 183657a9adfeSMatthew G Knepley PetscValidCharPointer(splitname,2); 183757a9adfeSMatthew G Knepley PetscValidPointer(is,3); 183857a9adfeSMatthew G Knepley { 183957a9adfeSMatthew G Knepley PC_FieldSplit *jac = (PC_FieldSplit*) pc->data; 184057a9adfeSMatthew G Knepley PC_FieldSplitLink ilink = jac->head; 184157a9adfeSMatthew G Knepley PetscBool found; 184257a9adfeSMatthew G Knepley 18430298fd71SBarry Smith *is = NULL; 184457a9adfeSMatthew G Knepley while (ilink) { 184557a9adfeSMatthew G Knepley ierr = PetscStrcmp(ilink->splitname, splitname, &found);CHKERRQ(ierr); 184657a9adfeSMatthew G Knepley if (found) { 184757a9adfeSMatthew G Knepley *is = ilink->is; 184857a9adfeSMatthew G Knepley break; 184957a9adfeSMatthew G Knepley } 185057a9adfeSMatthew G Knepley ilink = ilink->next; 185157a9adfeSMatthew G Knepley } 185257a9adfeSMatthew G Knepley } 185357a9adfeSMatthew G Knepley PetscFunctionReturn(0); 185457a9adfeSMatthew G Knepley } 185557a9adfeSMatthew G Knepley 185651f519a2SBarry Smith /*@ 185751f519a2SBarry Smith PCFieldSplitSetBlockSize - Sets the block size for defining where fields start in the 185851f519a2SBarry Smith fieldsplit preconditioner. If not set the matrix block size is used. 185951f519a2SBarry Smith 1860ad4df100SBarry Smith Logically Collective on PC 186151f519a2SBarry Smith 186251f519a2SBarry Smith Input Parameters: 186351f519a2SBarry Smith + pc - the preconditioner context 186451f519a2SBarry Smith - bs - the block size 186551f519a2SBarry Smith 186651f519a2SBarry Smith Level: intermediate 186751f519a2SBarry Smith 186851f519a2SBarry Smith .seealso: PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitSetFields() 186951f519a2SBarry Smith 187051f519a2SBarry Smith @*/ 18717087cfbeSBarry Smith PetscErrorCode PCFieldSplitSetBlockSize(PC pc,PetscInt bs) 187251f519a2SBarry Smith { 18734ac538c5SBarry Smith PetscErrorCode ierr; 187451f519a2SBarry Smith 187551f519a2SBarry Smith PetscFunctionBegin; 18760700a824SBarry Smith PetscValidHeaderSpecific(pc,PC_CLASSID,1); 1877c5eb9154SBarry Smith PetscValidLogicalCollectiveInt(pc,bs,2); 18784ac538c5SBarry Smith ierr = PetscTryMethod(pc,"PCFieldSplitSetBlockSize_C",(PC,PetscInt),(pc,bs));CHKERRQ(ierr); 187951f519a2SBarry Smith PetscFunctionReturn(0); 188051f519a2SBarry Smith } 188151f519a2SBarry Smith 18820971522cSBarry Smith /*@C 188369a612a9SBarry Smith PCFieldSplitGetSubKSP - Gets the KSP contexts for all splits 18840971522cSBarry Smith 188569a612a9SBarry Smith Collective on KSP 18860971522cSBarry Smith 18870971522cSBarry Smith Input Parameter: 18880971522cSBarry Smith . pc - the preconditioner context 18890971522cSBarry Smith 18900971522cSBarry Smith Output Parameters: 189113e0d083SBarry Smith + n - the number of splits 18923111de3cSBarry Smith - subksp - the array of KSP contexts 18930971522cSBarry Smith 18940971522cSBarry Smith Note: 18959a4f7e47SBarry Smith After PCFieldSplitGetSubKSP() the array of KSPs is to be freed by the user with PetscFree() 1896d32f9abdSBarry Smith (not the KSP just the array that contains them). 18970971522cSBarry Smith 1898285fb4e2SStefano Zampini You must call PCSetUp() before calling PCFieldSplitGetSubKSP(). 1899285fb4e2SStefano Zampini 1900285fb4e2SStefano Zampini If the fieldsplit is of type PC_COMPOSITE_SCHUR, it returns the KSP object used inside the 1901285fb4e2SStefano Zampini Schur complement and the KSP object used to iterate over the Schur complement. 1902285fb4e2SStefano Zampini To access all the KSP objects used in PC_COMPOSITE_SCHUR, use PCFieldSplitSchurGetSubKSP() 19030971522cSBarry Smith 1904196cc216SBarry Smith Fortran Usage: You must pass in a KSP array that is large enough to contain all the local KSPs. 19052bf68e3eSBarry Smith You can call PCFieldSplitGetSubKSP(pc,n,PETSC_NULL_KSP,ierr) to determine how large the 1906196cc216SBarry Smith KSP array must be. 1907196cc216SBarry Smith 1908196cc216SBarry Smith 19090971522cSBarry Smith Level: advanced 19100971522cSBarry Smith 19110971522cSBarry Smith .seealso: PCFIELDSPLIT 19120971522cSBarry Smith @*/ 19137087cfbeSBarry Smith PetscErrorCode PCFieldSplitGetSubKSP(PC pc,PetscInt *n,KSP *subksp[]) 19140971522cSBarry Smith { 19154ac538c5SBarry Smith PetscErrorCode ierr; 19160971522cSBarry Smith 19170971522cSBarry Smith PetscFunctionBegin; 19180700a824SBarry Smith PetscValidHeaderSpecific(pc,PC_CLASSID,1); 191913e0d083SBarry Smith if (n) PetscValidIntPointer(n,2); 19204ac538c5SBarry Smith ierr = PetscUseMethod(pc,"PCFieldSplitGetSubKSP_C",(PC,PetscInt*,KSP **),(pc,n,subksp));CHKERRQ(ierr); 19210971522cSBarry Smith PetscFunctionReturn(0); 19220971522cSBarry Smith } 19230971522cSBarry Smith 1924285fb4e2SStefano Zampini /*@C 1925285fb4e2SStefano Zampini PCFieldSplitSchurGetSubKSP - Gets the KSP contexts used inside the Schur complement based PCFIELDSPLIT 1926285fb4e2SStefano Zampini 1927285fb4e2SStefano Zampini Collective on KSP 1928285fb4e2SStefano Zampini 1929285fb4e2SStefano Zampini Input Parameter: 1930285fb4e2SStefano Zampini . pc - the preconditioner context 1931285fb4e2SStefano Zampini 1932285fb4e2SStefano Zampini Output Parameters: 1933285fb4e2SStefano Zampini + n - the number of splits 1934285fb4e2SStefano Zampini - subksp - the array of KSP contexts 1935285fb4e2SStefano Zampini 1936285fb4e2SStefano Zampini Note: 1937285fb4e2SStefano Zampini After PCFieldSplitSchurGetSubKSP() the array of KSPs is to be freed by the user with PetscFree() 1938285fb4e2SStefano Zampini (not the KSP just the array that contains them). 1939285fb4e2SStefano Zampini 1940285fb4e2SStefano Zampini You must call PCSetUp() before calling PCFieldSplitSchurGetSubKSP(). 1941285fb4e2SStefano Zampini 1942285fb4e2SStefano Zampini If the fieldsplit type is of type PC_COMPOSITE_SCHUR, it returns (in order) 1943285fb4e2SStefano Zampini - the KSP used for the (1,1) block 1944285fb4e2SStefano Zampini - the KSP used for the Schur complement (not the one used for the interior Schur solver) 1945285fb4e2SStefano Zampini - the KSP used for the (1,1) block in the upper triangular factor (if different from that of the (1,1) block). 1946285fb4e2SStefano Zampini 1947285fb4e2SStefano Zampini It returns a null array if the fieldsplit is not of type PC_COMPOSITE_SCHUR; in this case, you should use PCFieldSplitGetSubKSP(). 1948285fb4e2SStefano Zampini 1949285fb4e2SStefano Zampini Fortran Usage: You must pass in a KSP array that is large enough to contain all the local KSPs. 1950285fb4e2SStefano Zampini You can call PCFieldSplitSchurGetSubKSP(pc,n,PETSC_NULL_KSP,ierr) to determine how large the 1951285fb4e2SStefano Zampini KSP array must be. 1952285fb4e2SStefano Zampini 1953285fb4e2SStefano Zampini Level: advanced 1954285fb4e2SStefano Zampini 1955285fb4e2SStefano Zampini .seealso: PCFIELDSPLIT 1956285fb4e2SStefano Zampini @*/ 1957285fb4e2SStefano Zampini PetscErrorCode PCFieldSplitSchurGetSubKSP(PC pc,PetscInt *n,KSP *subksp[]) 1958285fb4e2SStefano Zampini { 1959285fb4e2SStefano Zampini PetscErrorCode ierr; 1960285fb4e2SStefano Zampini 1961285fb4e2SStefano Zampini PetscFunctionBegin; 1962285fb4e2SStefano Zampini PetscValidHeaderSpecific(pc,PC_CLASSID,1); 1963285fb4e2SStefano Zampini if (n) PetscValidIntPointer(n,2); 1964285fb4e2SStefano Zampini ierr = PetscUseMethod(pc,"PCFieldSplitSchurGetSubKSP_C",(PC,PetscInt*,KSP **),(pc,n,subksp));CHKERRQ(ierr); 1965285fb4e2SStefano Zampini PetscFunctionReturn(0); 1966285fb4e2SStefano Zampini } 1967285fb4e2SStefano Zampini 1968e69d4d44SBarry Smith /*@ 196953f2277eSBarry Smith PCFieldSplitSetSchurPre - Indicates what operator is used to construct the preconditioner for the Schur complement. 1970a04f6461SBarry Smith A11 matrix. Otherwise no preconditioner is used. 1971e69d4d44SBarry Smith 1972e69d4d44SBarry Smith Collective on PC 1973e69d4d44SBarry Smith 1974e69d4d44SBarry Smith Input Parameters: 1975e69d4d44SBarry Smith + pc - the preconditioner context 19766fdd48a9SBarry 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 19776fdd48a9SBarry Smith PC_FIELDSPLIT_SCHUR_PRE_SELFP, and PC_FIELDSPLIT_SCHUR_PRE_FULL 19780298fd71SBarry Smith - userpre - matrix to use for preconditioning, or NULL 1979084e4875SJed Brown 1980e69d4d44SBarry Smith Options Database: 19816fdd48a9SBarry Smith . -pc_fieldsplit_schur_precondition <self,selfp,user,a11,full> - default is a11. See notes for meaning of various arguments 1982e69d4d44SBarry Smith 1983fd1303e9SJungho Lee Notes: 1984fd1303e9SJungho Lee $ If ptype is 1985a6a584a2SBarry Smith $ a11 then the preconditioner for the Schur complement is generated from the block diagonal part of the preconditioner 198653f2277eSBarry Smith $ matrix associated with the Schur complement (i.e. A11), not the Schur complement matrix 1987a6a584a2SBarry Smith $ self the preconditioner for the Schur complement is generated from the symbolic representation of the Schur complement matrix: 1988a6a584a2SBarry Smith $ The only preconditioner that currently works with this symbolic respresentation matrix object is the PCLSC 1989fd1303e9SJungho Lee $ preconditioner 19906fdd48a9SBarry Smith $ user then the preconditioner for the Schur complement is generated from the user provided matrix (pre argument 19916fdd48a9SBarry Smith $ to this function). 1992a6a584a2SBarry Smith $ selfp then the preconditioning for the Schur complement is generated from an explicitly-assembled approximation Sp = A11 - A10 inv(diag(A00)) A01 19931d71051fSDmitry Karpeev $ This is only a good preconditioner when diag(A00) is a good preconditioner for A00. Optionally, A00 can be 19946fdd48a9SBarry Smith $ lumped before extracting the diagonal using the additional option -fieldsplit_1_mat_schur_complement_ainv_type lump 199594350679SMatthew 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) 19966fdd48a9SBarry Smith $ useful mostly as a test that the Schur complement approach can work for your problem 1997fd1303e9SJungho Lee 1998e87fab1bSBarry Smith When solving a saddle point problem, where the A11 block is identically zero, using a11 as the ptype only makes sense 1999fd1303e9SJungho Lee with the additional option -fieldsplit_1_pc_type none. Usually for saddle point problems one would use a ptype of self and 2000a7476a74SDmitry Karpeev -fieldsplit_1_pc_type lsc which uses the least squares commutator to compute a preconditioner for the Schur complement. 2001fd1303e9SJungho Lee 2002e69d4d44SBarry Smith Level: intermediate 2003e69d4d44SBarry Smith 20041d71051fSDmitry Karpeev .seealso: PCFieldSplitGetSchurPre(), PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitSetFields(), PCFieldSplitSchurPreType, 20051d71051fSDmitry Karpeev MatSchurComplementSetAinvType(), PCLSC 2006e69d4d44SBarry Smith 2007e69d4d44SBarry Smith @*/ 200829f8a81cSJed Brown PetscErrorCode PCFieldSplitSetSchurPre(PC pc,PCFieldSplitSchurPreType ptype,Mat pre) 2009e69d4d44SBarry Smith { 20104ac538c5SBarry Smith PetscErrorCode ierr; 2011e69d4d44SBarry Smith 2012e69d4d44SBarry Smith PetscFunctionBegin; 20130700a824SBarry Smith PetscValidHeaderSpecific(pc,PC_CLASSID,1); 201429f8a81cSJed Brown ierr = PetscTryMethod(pc,"PCFieldSplitSetSchurPre_C",(PC,PCFieldSplitSchurPreType,Mat),(pc,ptype,pre));CHKERRQ(ierr); 2015e69d4d44SBarry Smith PetscFunctionReturn(0); 2016e69d4d44SBarry Smith } 2017686bed4dSStefano Zampini 201829f8a81cSJed Brown PetscErrorCode PCFieldSplitSchurPrecondition(PC pc,PCFieldSplitSchurPreType ptype,Mat pre) {return PCFieldSplitSetSchurPre(pc,ptype,pre);} /* Deprecated name */ 2019e69d4d44SBarry Smith 202037a82bf0SJed Brown /*@ 202137a82bf0SJed Brown PCFieldSplitGetSchurPre - For Schur complement fieldsplit, determine how the Schur complement will be 202229f8a81cSJed Brown preconditioned. See PCFieldSplitSetSchurPre() for details. 202337a82bf0SJed Brown 202437a82bf0SJed Brown Logically Collective on PC 202537a82bf0SJed Brown 202637a82bf0SJed Brown Input Parameters: 202737a82bf0SJed Brown . pc - the preconditioner context 202837a82bf0SJed Brown 202937a82bf0SJed Brown Output Parameters: 203037a82bf0SJed 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 203137a82bf0SJed Brown - userpre - matrix to use for preconditioning (with PC_FIELDSPLIT_PRE_USER), or NULL 203237a82bf0SJed Brown 203337a82bf0SJed Brown Level: intermediate 203437a82bf0SJed Brown 203529f8a81cSJed Brown .seealso: PCFieldSplitSetSchurPre(), PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitSetFields(), PCFieldSplitSchurPreType, PCLSC 203637a82bf0SJed Brown 203737a82bf0SJed Brown @*/ 203837a82bf0SJed Brown PetscErrorCode PCFieldSplitGetSchurPre(PC pc,PCFieldSplitSchurPreType *ptype,Mat *pre) 203937a82bf0SJed Brown { 204037a82bf0SJed Brown PetscErrorCode ierr; 204137a82bf0SJed Brown 204237a82bf0SJed Brown PetscFunctionBegin; 204337a82bf0SJed Brown PetscValidHeaderSpecific(pc,PC_CLASSID,1); 204437a82bf0SJed Brown ierr = PetscUseMethod(pc,"PCFieldSplitGetSchurPre_C",(PC,PCFieldSplitSchurPreType*,Mat*),(pc,ptype,pre));CHKERRQ(ierr); 2045e69d4d44SBarry Smith PetscFunctionReturn(0); 2046e69d4d44SBarry Smith } 2047e69d4d44SBarry Smith 204845e7fc46SDmitry Karpeev /*@ 2049470b340bSDmitry Karpeev PCFieldSplitSchurGetS - extract the MatSchurComplement object used by this PC in case it needs to be configured separately 205045e7fc46SDmitry Karpeev 205145e7fc46SDmitry Karpeev Not collective 205245e7fc46SDmitry Karpeev 205345e7fc46SDmitry Karpeev Input Parameter: 205445e7fc46SDmitry Karpeev . pc - the preconditioner context 205545e7fc46SDmitry Karpeev 205645e7fc46SDmitry Karpeev Output Parameter: 2057470b340bSDmitry Karpeev . S - the Schur complement matrix 205845e7fc46SDmitry Karpeev 2059470b340bSDmitry Karpeev Notes: 2060470b340bSDmitry Karpeev This matrix should not be destroyed using MatDestroy(); rather, use PCFieldSplitSchurRestoreS(). 206145e7fc46SDmitry Karpeev 206245e7fc46SDmitry Karpeev Level: advanced 206345e7fc46SDmitry Karpeev 206429f8a81cSJed Brown .seealso: PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitSchurPreType, PCFieldSplitSetSchurPre(), MatSchurComplement, PCFieldSplitSchurRestoreS() 206545e7fc46SDmitry Karpeev 206645e7fc46SDmitry Karpeev @*/ 2067470b340bSDmitry Karpeev PetscErrorCode PCFieldSplitSchurGetS(PC pc,Mat *S) 206845e7fc46SDmitry Karpeev { 206945e7fc46SDmitry Karpeev PetscErrorCode ierr; 207045e7fc46SDmitry Karpeev const char* t; 207145e7fc46SDmitry Karpeev PetscBool isfs; 207245e7fc46SDmitry Karpeev PC_FieldSplit *jac; 207345e7fc46SDmitry Karpeev 207445e7fc46SDmitry Karpeev PetscFunctionBegin; 207545e7fc46SDmitry Karpeev PetscValidHeaderSpecific(pc,PC_CLASSID,1); 207645e7fc46SDmitry Karpeev ierr = PetscObjectGetType((PetscObject)pc,&t);CHKERRQ(ierr); 207745e7fc46SDmitry Karpeev ierr = PetscStrcmp(t,PCFIELDSPLIT,&isfs);CHKERRQ(ierr); 207845e7fc46SDmitry Karpeev if (!isfs) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Expected PC of type PCFIELDSPLIT, got %s instead",t); 207945e7fc46SDmitry Karpeev jac = (PC_FieldSplit*)pc->data; 2080470b340bSDmitry 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); 2081470b340bSDmitry Karpeev if (S) *S = jac->schur; 208245e7fc46SDmitry Karpeev PetscFunctionReturn(0); 208345e7fc46SDmitry Karpeev } 208445e7fc46SDmitry Karpeev 2085470b340bSDmitry Karpeev /*@ 2086470b340bSDmitry Karpeev PCFieldSplitSchurRestoreS - restores the MatSchurComplement object used by this PC 2087470b340bSDmitry Karpeev 2088470b340bSDmitry Karpeev Not collective 2089470b340bSDmitry Karpeev 2090470b340bSDmitry Karpeev Input Parameters: 2091470b340bSDmitry Karpeev + pc - the preconditioner context 2092470b340bSDmitry Karpeev . S - the Schur complement matrix 2093470b340bSDmitry Karpeev 2094470b340bSDmitry Karpeev Level: advanced 2095470b340bSDmitry Karpeev 209629f8a81cSJed Brown .seealso: PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitSchurPreType, PCFieldSplitSetSchurPre(), MatSchurComplement, PCFieldSplitSchurGetS() 2097470b340bSDmitry Karpeev 2098470b340bSDmitry Karpeev @*/ 2099bca69d2bSDmitry Karpeev PetscErrorCode PCFieldSplitSchurRestoreS(PC pc,Mat *S) 2100470b340bSDmitry Karpeev { 2101470b340bSDmitry Karpeev PetscErrorCode ierr; 2102470b340bSDmitry Karpeev const char* t; 2103470b340bSDmitry Karpeev PetscBool isfs; 2104470b340bSDmitry Karpeev PC_FieldSplit *jac; 2105470b340bSDmitry Karpeev 2106470b340bSDmitry Karpeev PetscFunctionBegin; 2107470b340bSDmitry Karpeev PetscValidHeaderSpecific(pc,PC_CLASSID,1); 2108470b340bSDmitry Karpeev ierr = PetscObjectGetType((PetscObject)pc,&t);CHKERRQ(ierr); 2109470b340bSDmitry Karpeev ierr = PetscStrcmp(t,PCFIELDSPLIT,&isfs);CHKERRQ(ierr); 2110470b340bSDmitry Karpeev if (!isfs) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Expected PC of type PCFIELDSPLIT, got %s instead",t); 2111470b340bSDmitry Karpeev jac = (PC_FieldSplit*)pc->data; 2112470b340bSDmitry 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); 2113bca69d2bSDmitry Karpeev if (!S || *S != jac->schur) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"MatSchurComplement restored is not the same as gotten"); 2114470b340bSDmitry Karpeev PetscFunctionReturn(0); 2115470b340bSDmitry Karpeev } 2116470b340bSDmitry Karpeev 2117470b340bSDmitry Karpeev 211829f8a81cSJed Brown static PetscErrorCode PCFieldSplitSetSchurPre_FieldSplit(PC pc,PCFieldSplitSchurPreType ptype,Mat pre) 2119e69d4d44SBarry Smith { 2120e69d4d44SBarry Smith PC_FieldSplit *jac = (PC_FieldSplit*)pc->data; 2121084e4875SJed Brown PetscErrorCode ierr; 2122e69d4d44SBarry Smith 2123e69d4d44SBarry Smith PetscFunctionBegin; 2124084e4875SJed Brown jac->schurpre = ptype; 2125a7476a74SDmitry Karpeev if (ptype == PC_FIELDSPLIT_SCHUR_PRE_USER && pre) { 21266bf464f9SBarry Smith ierr = MatDestroy(&jac->schur_user);CHKERRQ(ierr); 2127084e4875SJed Brown jac->schur_user = pre; 2128084e4875SJed Brown ierr = PetscObjectReference((PetscObject)jac->schur_user);CHKERRQ(ierr); 2129084e4875SJed Brown } 2130e69d4d44SBarry Smith PetscFunctionReturn(0); 2131e69d4d44SBarry Smith } 2132e69d4d44SBarry Smith 213337a82bf0SJed Brown static PetscErrorCode PCFieldSplitGetSchurPre_FieldSplit(PC pc,PCFieldSplitSchurPreType *ptype,Mat *pre) 213437a82bf0SJed Brown { 213537a82bf0SJed Brown PC_FieldSplit *jac = (PC_FieldSplit*)pc->data; 213637a82bf0SJed Brown 213737a82bf0SJed Brown PetscFunctionBegin; 213837a82bf0SJed Brown *ptype = jac->schurpre; 213937a82bf0SJed Brown *pre = jac->schur_user; 214037a82bf0SJed Brown PetscFunctionReturn(0); 214137a82bf0SJed Brown } 214237a82bf0SJed Brown 2143ab1df9f5SJed Brown /*@ 21440ffb0e17SBarry Smith PCFieldSplitSetSchurFactType - sets which blocks of the approximate block factorization to retain in the preconditioner 2145ab1df9f5SJed Brown 2146ab1df9f5SJed Brown Collective on PC 2147ab1df9f5SJed Brown 2148ab1df9f5SJed Brown Input Parameters: 2149ab1df9f5SJed Brown + pc - the preconditioner context 2150c9c6ffaaSJed Brown - ftype - which blocks of factorization to retain, PC_FIELDSPLIT_SCHUR_FACT_FULL is default 2151ab1df9f5SJed Brown 2152ab1df9f5SJed Brown Options Database: 2153c9c6ffaaSJed Brown . -pc_fieldsplit_schur_fact_type <diag,lower,upper,full> default is full 2154ab1df9f5SJed Brown 2155ab1df9f5SJed Brown 2156ab1df9f5SJed Brown Level: intermediate 2157ab1df9f5SJed Brown 2158ab1df9f5SJed Brown Notes: 2159ab1df9f5SJed Brown The FULL factorization is 2160ab1df9f5SJed Brown 21610ffb0e17SBarry Smith $ (A B) = (1 0) (A 0) (1 Ainv*B) = L D U 21620ffb0e17SBarry Smith $ (C E) (C*Ainv 1) (0 S) (0 1 ) 2163ab1df9f5SJed Brown 21640ffb0e17SBarry 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, 2165c096484dSStefano 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(). 2166ab1df9f5SJed Brown 21670ffb0e17SBarry Smith $ If A and S are solved exactly 21680ffb0e17SBarry Smith $ *) FULL factorization is a direct solver. 21690ffb0e17SBarry 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. 21700ffb0e17SBarry 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. 2171ab1df9f5SJed Brown 21720ffb0e17SBarry Smith If the iteration count is very low, consider using KSPFGMRES or KSPGCR which can use one less preconditioner 21730ffb0e17SBarry 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. 21740ffb0e17SBarry Smith 21750ffb0e17SBarry Smith For symmetric problems in which A is positive definite and S is negative definite, DIAG can be used with KSPMINRES. 21760ffb0e17SBarry Smith 21770ffb0e17SBarry 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). 2178ab1df9f5SJed Brown 2179ab1df9f5SJed Brown References: 218096a0c994SBarry Smith + 1. - Murphy, Golub, and Wathen, A note on preconditioning indefinite linear systems, SIAM J. Sci. Comput., 21 (2000). 218196a0c994SBarry Smith - 2. - Ipsen, A note on preconditioning nonsymmetric matrices, SIAM J. Sci. Comput., 23 (2001). 2182ab1df9f5SJed Brown 2183c096484dSStefano Zampini .seealso: PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitSetFields(), PCFieldSplitSchurPreType, PCFieldSplitSetSchurScale() 2184ab1df9f5SJed Brown @*/ 2185c9c6ffaaSJed Brown PetscErrorCode PCFieldSplitSetSchurFactType(PC pc,PCFieldSplitSchurFactType ftype) 2186ab1df9f5SJed Brown { 2187ab1df9f5SJed Brown PetscErrorCode ierr; 2188ab1df9f5SJed Brown 2189ab1df9f5SJed Brown PetscFunctionBegin; 2190ab1df9f5SJed Brown PetscValidHeaderSpecific(pc,PC_CLASSID,1); 2191c9c6ffaaSJed Brown ierr = PetscTryMethod(pc,"PCFieldSplitSetSchurFactType_C",(PC,PCFieldSplitSchurFactType),(pc,ftype));CHKERRQ(ierr); 2192ab1df9f5SJed Brown PetscFunctionReturn(0); 2193ab1df9f5SJed Brown } 2194ab1df9f5SJed Brown 21951e6b0712SBarry Smith static PetscErrorCode PCFieldSplitSetSchurFactType_FieldSplit(PC pc,PCFieldSplitSchurFactType ftype) 2196ab1df9f5SJed Brown { 2197ab1df9f5SJed Brown PC_FieldSplit *jac = (PC_FieldSplit*)pc->data; 2198ab1df9f5SJed Brown 2199ab1df9f5SJed Brown PetscFunctionBegin; 2200ab1df9f5SJed Brown jac->schurfactorization = ftype; 2201ab1df9f5SJed Brown PetscFunctionReturn(0); 2202ab1df9f5SJed Brown } 2203ab1df9f5SJed Brown 2204c096484dSStefano Zampini /*@ 2205c096484dSStefano Zampini PCFieldSplitSetSchurScale - Controls the sign flip of S for PC_FIELDSPLIT_SCHUR_FACT_DIAG. 2206c096484dSStefano Zampini 2207c096484dSStefano Zampini Collective on PC 2208c096484dSStefano Zampini 2209c096484dSStefano Zampini Input Parameters: 2210c096484dSStefano Zampini + pc - the preconditioner context 2211c096484dSStefano Zampini - scale - scaling factor for the Schur complement 2212c096484dSStefano Zampini 2213c096484dSStefano Zampini Options Database: 2214c096484dSStefano Zampini . -pc_fieldsplit_schur_scale - default is -1.0 2215c096484dSStefano Zampini 2216c096484dSStefano Zampini Level: intermediate 2217c096484dSStefano Zampini 2218c096484dSStefano Zampini .seealso: PCFIELDSPLIT, PCFieldSplitSetFields(), PCFieldSplitSchurFactType, PCFieldSplitSetSchurScale() 2219c096484dSStefano Zampini @*/ 2220c096484dSStefano Zampini PetscErrorCode PCFieldSplitSetSchurScale(PC pc,PetscScalar scale) 2221c096484dSStefano Zampini { 2222c096484dSStefano Zampini PetscErrorCode ierr; 2223c096484dSStefano Zampini 2224c096484dSStefano Zampini PetscFunctionBegin; 2225c096484dSStefano Zampini PetscValidHeaderSpecific(pc,PC_CLASSID,1); 2226c096484dSStefano Zampini PetscValidLogicalCollectiveScalar(pc,scale,2); 2227c096484dSStefano Zampini ierr = PetscTryMethod(pc,"PCFieldSplitSetSchurScale_C",(PC,PetscScalar),(pc,scale));CHKERRQ(ierr); 2228c096484dSStefano Zampini PetscFunctionReturn(0); 2229c096484dSStefano Zampini } 2230c096484dSStefano Zampini 2231c096484dSStefano Zampini static PetscErrorCode PCFieldSplitSetSchurScale_FieldSplit(PC pc,PetscScalar scale) 2232c096484dSStefano Zampini { 2233c096484dSStefano Zampini PC_FieldSplit *jac = (PC_FieldSplit*)pc->data; 2234c096484dSStefano Zampini 2235c096484dSStefano Zampini PetscFunctionBegin; 2236c096484dSStefano Zampini jac->schurscale = scale; 2237c096484dSStefano Zampini PetscFunctionReturn(0); 2238c096484dSStefano Zampini } 2239c096484dSStefano Zampini 224030ad9308SMatthew Knepley /*@C 22418c03b21aSDmitry Karpeev PCFieldSplitGetSchurBlocks - Gets all matrix blocks for the Schur complement 224230ad9308SMatthew Knepley 224330ad9308SMatthew Knepley Collective on KSP 224430ad9308SMatthew Knepley 224530ad9308SMatthew Knepley Input Parameter: 224630ad9308SMatthew Knepley . pc - the preconditioner context 224730ad9308SMatthew Knepley 224830ad9308SMatthew Knepley Output Parameters: 2249a04f6461SBarry Smith + A00 - the (0,0) block 2250a04f6461SBarry Smith . A01 - the (0,1) block 2251a04f6461SBarry Smith . A10 - the (1,0) block 2252a04f6461SBarry Smith - A11 - the (1,1) block 225330ad9308SMatthew Knepley 225430ad9308SMatthew Knepley Level: advanced 225530ad9308SMatthew Knepley 225630ad9308SMatthew Knepley .seealso: PCFIELDSPLIT 225730ad9308SMatthew Knepley @*/ 2258a04f6461SBarry Smith PetscErrorCode PCFieldSplitGetSchurBlocks(PC pc,Mat *A00,Mat *A01,Mat *A10, Mat *A11) 225930ad9308SMatthew Knepley { 226030ad9308SMatthew Knepley PC_FieldSplit *jac = (PC_FieldSplit*) pc->data; 226130ad9308SMatthew Knepley 226230ad9308SMatthew Knepley PetscFunctionBegin; 22630700a824SBarry Smith PetscValidHeaderSpecific(pc,PC_CLASSID,1); 2264ce94432eSBarry Smith if (jac->type != PC_COMPOSITE_SCHUR) SETERRQ(PetscObjectComm((PetscObject)pc),PETSC_ERR_ARG_WRONG, "FieldSplit is not using a Schur complement approach."); 2265a04f6461SBarry Smith if (A00) *A00 = jac->pmat[0]; 2266a04f6461SBarry Smith if (A01) *A01 = jac->B; 2267a04f6461SBarry Smith if (A10) *A10 = jac->C; 2268a04f6461SBarry Smith if (A11) *A11 = jac->pmat[1]; 226930ad9308SMatthew Knepley PetscFunctionReturn(0); 227030ad9308SMatthew Knepley } 227130ad9308SMatthew Knepley 22721e6b0712SBarry Smith static PetscErrorCode PCFieldSplitSetType_FieldSplit(PC pc,PCCompositeType type) 227379416396SBarry Smith { 227479416396SBarry Smith PC_FieldSplit *jac = (PC_FieldSplit*)pc->data; 2275e69d4d44SBarry Smith PetscErrorCode ierr; 227679416396SBarry Smith 227779416396SBarry Smith PetscFunctionBegin; 227879416396SBarry Smith jac->type = type; 22793b224e63SBarry Smith if (type == PC_COMPOSITE_SCHUR) { 22803b224e63SBarry Smith pc->ops->apply = PCApply_FieldSplit_Schur; 22813b224e63SBarry Smith pc->ops->view = PCView_FieldSplit_Schur; 22822fa5cd67SKarl Rupp 2283bdf89e91SBarry Smith ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitGetSubKSP_C",PCFieldSplitGetSubKSP_FieldSplit_Schur);CHKERRQ(ierr); 228429f8a81cSJed Brown ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetSchurPre_C",PCFieldSplitSetSchurPre_FieldSplit);CHKERRQ(ierr); 228537a82bf0SJed Brown ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitGetSchurPre_C",PCFieldSplitGetSchurPre_FieldSplit);CHKERRQ(ierr); 2286bdf89e91SBarry Smith ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetSchurFactType_C",PCFieldSplitSetSchurFactType_FieldSplit);CHKERRQ(ierr); 2287c096484dSStefano Zampini ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetSchurScale_C",PCFieldSplitSetSchurScale_FieldSplit);CHKERRQ(ierr); 2288e69d4d44SBarry Smith 22893b224e63SBarry Smith } else { 22903b224e63SBarry Smith pc->ops->apply = PCApply_FieldSplit; 22913b224e63SBarry Smith pc->ops->view = PCView_FieldSplit; 22922fa5cd67SKarl Rupp 2293bdf89e91SBarry Smith ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitGetSubKSP_C",PCFieldSplitGetSubKSP_FieldSplit);CHKERRQ(ierr); 229429f8a81cSJed Brown ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetSchurPre_C",0);CHKERRQ(ierr); 229537a82bf0SJed Brown ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitGetSchurPre_C",0);CHKERRQ(ierr); 2296bdf89e91SBarry Smith ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetSchurFactType_C",0);CHKERRQ(ierr); 2297c096484dSStefano Zampini ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetSchurScale_C",0);CHKERRQ(ierr); 22983b224e63SBarry Smith } 229979416396SBarry Smith PetscFunctionReturn(0); 230079416396SBarry Smith } 230179416396SBarry Smith 23021e6b0712SBarry Smith static PetscErrorCode PCFieldSplitSetBlockSize_FieldSplit(PC pc,PetscInt bs) 230351f519a2SBarry Smith { 230451f519a2SBarry Smith PC_FieldSplit *jac = (PC_FieldSplit*)pc->data; 230551f519a2SBarry Smith 230651f519a2SBarry Smith PetscFunctionBegin; 2307ce94432eSBarry Smith if (bs < 1) SETERRQ1(PetscObjectComm((PetscObject)pc),PETSC_ERR_ARG_OUTOFRANGE,"Blocksize must be positive, you gave %D",bs); 2308ce94432eSBarry 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); 230951f519a2SBarry Smith jac->bs = bs; 231051f519a2SBarry Smith PetscFunctionReturn(0); 231151f519a2SBarry Smith } 231251f519a2SBarry Smith 2313bc08b0f1SBarry Smith /*@ 231479416396SBarry Smith PCFieldSplitSetType - Sets the type of fieldsplit preconditioner. 231579416396SBarry Smith 231679416396SBarry Smith Collective on PC 231779416396SBarry Smith 231879416396SBarry Smith Input Parameter: 231979416396SBarry Smith . pc - the preconditioner context 232081540f2fSBarry Smith . type - PC_COMPOSITE_ADDITIVE, PC_COMPOSITE_MULTIPLICATIVE (default), PC_COMPOSITE_SYMMETRIC_MULTIPLICATIVE, PC_COMPOSITE_SPECIAL, PC_COMPOSITE_SCHUR 232179416396SBarry Smith 232279416396SBarry Smith Options Database Key: 2323a4efd8eaSMatthew Knepley . -pc_fieldsplit_type <type: one of multiplicative, additive, symmetric_multiplicative, special, schur> - Sets fieldsplit preconditioner type 232479416396SBarry Smith 2325b02e2d75SMatthew G Knepley Level: Intermediate 232679416396SBarry Smith 232779416396SBarry Smith .keywords: PC, set, type, composite preconditioner, additive, multiplicative 232879416396SBarry Smith 232979416396SBarry Smith .seealso: PCCompositeSetType() 233079416396SBarry Smith 233179416396SBarry Smith @*/ 23327087cfbeSBarry Smith PetscErrorCode PCFieldSplitSetType(PC pc,PCCompositeType type) 233379416396SBarry Smith { 23344ac538c5SBarry Smith PetscErrorCode ierr; 233579416396SBarry Smith 233679416396SBarry Smith PetscFunctionBegin; 23370700a824SBarry Smith PetscValidHeaderSpecific(pc,PC_CLASSID,1); 23384ac538c5SBarry Smith ierr = PetscTryMethod(pc,"PCFieldSplitSetType_C",(PC,PCCompositeType),(pc,type));CHKERRQ(ierr); 233979416396SBarry Smith PetscFunctionReturn(0); 234079416396SBarry Smith } 234179416396SBarry Smith 2342b02e2d75SMatthew G Knepley /*@ 2343b02e2d75SMatthew G Knepley PCFieldSplitGetType - Gets the type of fieldsplit preconditioner. 2344b02e2d75SMatthew G Knepley 2345b02e2d75SMatthew G Knepley Not collective 2346b02e2d75SMatthew G Knepley 2347b02e2d75SMatthew G Knepley Input Parameter: 2348b02e2d75SMatthew G Knepley . pc - the preconditioner context 2349b02e2d75SMatthew G Knepley 2350b02e2d75SMatthew G Knepley Output Parameter: 2351b02e2d75SMatthew G Knepley . type - PC_COMPOSITE_ADDITIVE, PC_COMPOSITE_MULTIPLICATIVE (default), PC_COMPOSITE_SYMMETRIC_MULTIPLICATIVE, PC_COMPOSITE_SPECIAL, PC_COMPOSITE_SCHUR 2352b02e2d75SMatthew G Knepley 2353b02e2d75SMatthew G Knepley Level: Intermediate 2354b02e2d75SMatthew G Knepley 2355b02e2d75SMatthew G Knepley .keywords: PC, set, type, composite preconditioner, additive, multiplicative 2356b02e2d75SMatthew G Knepley .seealso: PCCompositeSetType() 2357b02e2d75SMatthew G Knepley @*/ 2358b02e2d75SMatthew G Knepley PetscErrorCode PCFieldSplitGetType(PC pc, PCCompositeType *type) 2359b02e2d75SMatthew G Knepley { 2360b02e2d75SMatthew G Knepley PC_FieldSplit *jac = (PC_FieldSplit*) pc->data; 2361b02e2d75SMatthew G Knepley 2362b02e2d75SMatthew G Knepley PetscFunctionBegin; 2363b02e2d75SMatthew G Knepley PetscValidHeaderSpecific(pc,PC_CLASSID,1); 2364b02e2d75SMatthew G Knepley PetscValidIntPointer(type,2); 2365b02e2d75SMatthew G Knepley *type = jac->type; 2366b02e2d75SMatthew G Knepley PetscFunctionReturn(0); 2367b02e2d75SMatthew G Knepley } 2368b02e2d75SMatthew G Knepley 23694ab8060aSDmitry Karpeev /*@ 23704ab8060aSDmitry Karpeev PCFieldSplitSetDMSplits - Flags whether DMCreateFieldDecomposition() should be used to define the splits, whenever possible. 23714ab8060aSDmitry Karpeev 23724ab8060aSDmitry Karpeev Logically Collective 23734ab8060aSDmitry Karpeev 23744ab8060aSDmitry Karpeev Input Parameters: 23754ab8060aSDmitry Karpeev + pc - the preconditioner context 23764ab8060aSDmitry Karpeev - flg - boolean indicating whether to use field splits defined by the DM 23774ab8060aSDmitry Karpeev 23784ab8060aSDmitry Karpeev Options Database Key: 23794ab8060aSDmitry Karpeev . -pc_fieldsplit_dm_splits 23804ab8060aSDmitry Karpeev 23814ab8060aSDmitry Karpeev Level: Intermediate 23824ab8060aSDmitry Karpeev 23834ab8060aSDmitry Karpeev .keywords: PC, DM, composite preconditioner, additive, multiplicative 23844ab8060aSDmitry Karpeev 23854ab8060aSDmitry Karpeev .seealso: PCFieldSplitGetDMSplits() 23864ab8060aSDmitry Karpeev 23874ab8060aSDmitry Karpeev @*/ 23884ab8060aSDmitry Karpeev PetscErrorCode PCFieldSplitSetDMSplits(PC pc,PetscBool flg) 23894ab8060aSDmitry Karpeev { 23904ab8060aSDmitry Karpeev PC_FieldSplit *jac = (PC_FieldSplit*)pc->data; 23914ab8060aSDmitry Karpeev PetscBool isfs; 23924ab8060aSDmitry Karpeev PetscErrorCode ierr; 23934ab8060aSDmitry Karpeev 23944ab8060aSDmitry Karpeev PetscFunctionBegin; 23954ab8060aSDmitry Karpeev PetscValidHeaderSpecific(pc,PC_CLASSID,1); 23964ab8060aSDmitry Karpeev PetscValidLogicalCollectiveBool(pc,flg,2); 23974ab8060aSDmitry Karpeev ierr = PetscObjectTypeCompare((PetscObject)pc,PCFIELDSPLIT,&isfs);CHKERRQ(ierr); 23984ab8060aSDmitry Karpeev if (isfs) { 23994ab8060aSDmitry Karpeev jac->dm_splits = flg; 24004ab8060aSDmitry Karpeev } 24014ab8060aSDmitry Karpeev PetscFunctionReturn(0); 24024ab8060aSDmitry Karpeev } 24034ab8060aSDmitry Karpeev 24044ab8060aSDmitry Karpeev 24054ab8060aSDmitry Karpeev /*@ 24064ab8060aSDmitry Karpeev PCFieldSplitGetDMSplits - Returns flag indicating whether DMCreateFieldDecomposition() should be used to define the splits, whenever possible. 24074ab8060aSDmitry Karpeev 24084ab8060aSDmitry Karpeev Logically Collective 24094ab8060aSDmitry Karpeev 24104ab8060aSDmitry Karpeev Input Parameter: 24114ab8060aSDmitry Karpeev . pc - the preconditioner context 24124ab8060aSDmitry Karpeev 24134ab8060aSDmitry Karpeev Output Parameter: 24144ab8060aSDmitry Karpeev . flg - boolean indicating whether to use field splits defined by the DM 24154ab8060aSDmitry Karpeev 24164ab8060aSDmitry Karpeev Level: Intermediate 24174ab8060aSDmitry Karpeev 24184ab8060aSDmitry Karpeev .keywords: PC, DM, composite preconditioner, additive, multiplicative 24194ab8060aSDmitry Karpeev 24204ab8060aSDmitry Karpeev .seealso: PCFieldSplitSetDMSplits() 24214ab8060aSDmitry Karpeev 24224ab8060aSDmitry Karpeev @*/ 24234ab8060aSDmitry Karpeev PetscErrorCode PCFieldSplitGetDMSplits(PC pc,PetscBool* flg) 24244ab8060aSDmitry Karpeev { 24254ab8060aSDmitry Karpeev PC_FieldSplit *jac = (PC_FieldSplit*)pc->data; 24264ab8060aSDmitry Karpeev PetscBool isfs; 24274ab8060aSDmitry Karpeev PetscErrorCode ierr; 24284ab8060aSDmitry Karpeev 24294ab8060aSDmitry Karpeev PetscFunctionBegin; 24304ab8060aSDmitry Karpeev PetscValidHeaderSpecific(pc,PC_CLASSID,1); 24314ab8060aSDmitry Karpeev PetscValidPointer(flg,2); 24324ab8060aSDmitry Karpeev ierr = PetscObjectTypeCompare((PetscObject)pc,PCFIELDSPLIT,&isfs);CHKERRQ(ierr); 24334ab8060aSDmitry Karpeev if (isfs) { 24344ab8060aSDmitry Karpeev if(flg) *flg = jac->dm_splits; 24354ab8060aSDmitry Karpeev } 24364ab8060aSDmitry Karpeev PetscFunctionReturn(0); 24374ab8060aSDmitry Karpeev } 24384ab8060aSDmitry Karpeev 24397b752e3dSPatrick Sanan /*@ 24407b752e3dSPatrick Sanan PCFieldSplitGetDetectSaddlePoint - Returns flag indicating whether PCFieldSplit will attempt to automatically determine fields based on zero diagonal entries. 24417b752e3dSPatrick Sanan 24427b752e3dSPatrick Sanan Logically Collective 24437b752e3dSPatrick Sanan 24447b752e3dSPatrick Sanan Input Parameter: 24457b752e3dSPatrick Sanan . pc - the preconditioner context 24467b752e3dSPatrick Sanan 24477b752e3dSPatrick Sanan Output Parameter: 24487b752e3dSPatrick Sanan . flg - boolean indicating whether to detect fields or not 24497b752e3dSPatrick Sanan 24507b752e3dSPatrick Sanan Level: Intermediate 24517b752e3dSPatrick Sanan 24527b752e3dSPatrick Sanan .seealso: PCFIELDSPLIT, PCFieldSplitSetDetectSaddlePoint() 24537b752e3dSPatrick Sanan 24547b752e3dSPatrick Sanan @*/ 24557b752e3dSPatrick Sanan PetscErrorCode PCFieldSplitGetDetectSaddlePoint(PC pc,PetscBool *flg) 24567b752e3dSPatrick Sanan { 24577b752e3dSPatrick Sanan PC_FieldSplit *jac = (PC_FieldSplit*)pc->data; 24587b752e3dSPatrick Sanan 24597b752e3dSPatrick Sanan PetscFunctionBegin; 24607b752e3dSPatrick Sanan *flg = jac->detect; 24617b752e3dSPatrick Sanan PetscFunctionReturn(0); 24627b752e3dSPatrick Sanan } 24637b752e3dSPatrick Sanan 24647b752e3dSPatrick Sanan /*@ 24657b752e3dSPatrick Sanan PCFieldSplitSetDetectSaddlePoint - Sets flag indicating whether PCFieldSplit will attempt to automatically determine fields based on zero diagonal entries. 24667b752e3dSPatrick Sanan 24677b752e3dSPatrick Sanan Logically Collective 24687b752e3dSPatrick Sanan 24697b752e3dSPatrick Sanan Notes: 24707b752e3dSPatrick 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()). 24717b752e3dSPatrick Sanan 24727b752e3dSPatrick Sanan Input Parameter: 24737b752e3dSPatrick Sanan . pc - the preconditioner context 24747b752e3dSPatrick Sanan 24757b752e3dSPatrick Sanan Output Parameter: 24767b752e3dSPatrick Sanan . flg - boolean indicating whether to detect fields or not 24777b752e3dSPatrick Sanan 24787b752e3dSPatrick Sanan Options Database Key: 24797b752e3dSPatrick Sanan . -pc_fieldsplit_detect_saddle_point 24807b752e3dSPatrick Sanan 24817b752e3dSPatrick Sanan Level: Intermediate 24827b752e3dSPatrick Sanan 24837b752e3dSPatrick Sanan .seealso: PCFIELDSPLIT, PCFieldSplitSetDetectSaddlePoint(), PCFieldSplitSetType(), PCFieldSplitSetSchurPre() 24847b752e3dSPatrick Sanan 24857b752e3dSPatrick Sanan @*/ 24867b752e3dSPatrick Sanan PetscErrorCode PCFieldSplitSetDetectSaddlePoint(PC pc,PetscBool flg) 24877b752e3dSPatrick Sanan { 24887b752e3dSPatrick Sanan PC_FieldSplit *jac = (PC_FieldSplit*)pc->data; 24897b752e3dSPatrick Sanan PetscErrorCode ierr; 24907b752e3dSPatrick Sanan 24917b752e3dSPatrick Sanan PetscFunctionBegin; 24927b752e3dSPatrick Sanan jac->detect = flg; 24937b752e3dSPatrick Sanan if (jac->detect) { 24947b752e3dSPatrick Sanan ierr = PCFieldSplitSetType(pc,PC_COMPOSITE_SCHUR);CHKERRQ(ierr); 24957b752e3dSPatrick Sanan ierr = PCFieldSplitSetSchurPre(pc,PC_FIELDSPLIT_SCHUR_PRE_SELF,NULL);CHKERRQ(ierr); 24967b752e3dSPatrick Sanan } 24977b752e3dSPatrick Sanan PetscFunctionReturn(0); 24987b752e3dSPatrick Sanan } 24997b752e3dSPatrick Sanan 25000971522cSBarry Smith /* -------------------------------------------------------------------------------------*/ 25010971522cSBarry Smith /*MC 2502a8c7a070SBarry Smith PCFIELDSPLIT - Preconditioner created by combining separate preconditioners for individual 2503a04f6461SBarry Smith fields or groups of fields. See the users manual section "Solving Block Matrices" for more details. 25040971522cSBarry Smith 2505edf189efSBarry Smith To set options on the solvers for each block append -fieldsplit_ to all the PC 2506edf189efSBarry Smith options database keys. For example, -fieldsplit_pc_type ilu -fieldsplit_pc_factor_levels 1 25070971522cSBarry Smith 2508a8c7a070SBarry Smith To set the options on the solvers separate for each block call PCFieldSplitGetSubKSP() 250969a612a9SBarry Smith and set the options directly on the resulting KSP object 25100971522cSBarry Smith 25110971522cSBarry Smith Level: intermediate 25120971522cSBarry Smith 251379416396SBarry Smith Options Database Keys: 251481540f2fSBarry Smith + -pc_fieldsplit_%d_fields <a,b,..> - indicates the fields to be used in the %d'th split 251581540f2fSBarry Smith . -pc_fieldsplit_default - automatically add any fields to additional splits that have not 251681540f2fSBarry Smith been supplied explicitly by -pc_fieldsplit_%d_fields 251781540f2fSBarry Smith . -pc_fieldsplit_block_size <bs> - size of block that defines fields (i.e. there are bs fields) 25180f188ba9SJed Brown . -pc_fieldsplit_type <additive,multiplicative,symmetric_multiplicative,schur> - type of relaxation or factorization splitting 2519a6a584a2SBarry Smith . -pc_fieldsplit_schur_precondition <self,selfp,user,a11,full> - default is a11; see PCFieldSplitSetSchurPre() 25207b752e3dSPatrick Sanan . -pc_fieldsplit_detect_saddle_point - automatically finds rows with zero diagonal and uses Schur complement with no preconditioner as the solver 252179416396SBarry Smith 25225d4c12cdSJungho Lee - Options prefix for inner solvers when using Schur complement preconditioner are -fieldsplit_0_ and -fieldsplit_1_ 25235d4c12cdSJungho Lee for all other solvers they are -fieldsplit_%d_ for the dth field, use -fieldsplit_ for all fields 25245d4c12cdSJungho Lee 2525c8a0d604SMatthew G Knepley Notes: 2526c8a0d604SMatthew G Knepley Use PCFieldSplitSetFields() to set fields defined by "strided" entries and PCFieldSplitSetIS() 2527d32f9abdSBarry Smith to define a field by an arbitrary collection of entries. 2528d32f9abdSBarry Smith 2529d32f9abdSBarry Smith If no fields are set the default is used. The fields are defined by entries strided by bs, 2530d32f9abdSBarry Smith beginning at 0 then 1, etc to bs-1. The block size can be set with PCFieldSplitSetBlockSize(), 2531d32f9abdSBarry Smith if this is not called the block size defaults to the blocksize of the second matrix passed 2532d32f9abdSBarry Smith to KSPSetOperators()/PCSetOperators(). 2533d32f9abdSBarry Smith 2534c8a0d604SMatthew G Knepley $ For the Schur complement preconditioner if J = ( A00 A01 ) 2535c8a0d604SMatthew G Knepley $ ( A10 A11 ) 2536c8a0d604SMatthew G Knepley $ the preconditioner using full factorization is 253713b05affSJed Brown $ ( I -ksp(A00) A01 ) ( inv(A00) 0 ) ( I 0 ) 2538c8a0d604SMatthew G Knepley $ ( 0 I ) ( 0 ksp(S) ) ( -A10 ksp(A00) I ) 253913b05affSJed Brown where the action of inv(A00) is applied using the KSP solver with prefix -fieldsplit_0_. S is the Schur complement 254013b05affSJed Brown $ S = A11 - A10 ksp(A00) A01 254113b05affSJed 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 2542686bed4dSStefano Zampini in providing the SECOND split or 1 if not give). For PCFieldSplitGetSubKSP() when field number is 0, 2543c8a0d604SMatthew G Knepley it returns the KSP associated with -fieldsplit_0_ while field number 1 gives -fieldsplit_1_ KSP. By default 2544a6a584a2SBarry Smith A11 is used to construct a preconditioner for S, use PCFieldSplitSetSchurPre() for all the possible ways to construct the preconditioner for S. 25451d71051fSDmitry Karpeev 2546a7476a74SDmitry Karpeev The factorization type is set using -pc_fieldsplit_schur_fact_type <diag, lower, upper, full>. The full is shown above, 25475668aaf4SBarry Smith diag gives 2548c8a0d604SMatthew G Knepley $ ( inv(A00) 0 ) 2549c8a0d604SMatthew G Knepley $ ( 0 -ksp(S) ) 2550c096484dSStefano 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 2551c096484dSStefano Zampini can be turned off with PCFieldSplitSetSchurScale() or by command line -pc_fieldsplit_schur_scale 1.0. The lower factorization is the inverse of 2552c8a0d604SMatthew G Knepley $ ( A00 0 ) 2553c8a0d604SMatthew G Knepley $ ( A10 S ) 2554c8a0d604SMatthew G Knepley where the inverses of A00 and S are applied using KSPs. The upper factorization is the inverse of 2555c8a0d604SMatthew G Knepley $ ( A00 A01 ) 2556c8a0d604SMatthew G Knepley $ ( 0 S ) 2557c8a0d604SMatthew G Knepley where again the inverses of A00 and S are applied using KSPs. 2558e69d4d44SBarry Smith 2559edf189efSBarry Smith If only one set of indices (one IS) is provided with PCFieldSplitSetIS() then the complement of that IS 2560edf189efSBarry Smith is used automatically for a second block. 2561edf189efSBarry Smith 2562ff218e97SBarry Smith The fieldsplit preconditioner cannot currently be used with the BAIJ or SBAIJ data formats if the blocksize is larger than 1. 2563ff218e97SBarry Smith Generally it should be used with the AIJ format. 2564ff218e97SBarry Smith 2565ff218e97SBarry Smith The forms of these preconditioners are closely related if not identical to forms derived as "Distributive Iterations", see, 2566ff218e97SBarry Smith for example, page 294 in "Principles of Computational Fluid Dynamics" by Pieter Wesseling. Note that one can also use PCFIELDSPLIT 2567ff218e97SBarry Smith inside a smoother resulting in "Distributive Smoothers". 25680716a85fSBarry Smith 2569a541d17aSBarry Smith Concepts: physics based preconditioners, block preconditioners 25700971522cSBarry Smith 25713bc631e0SBarry Smith There is a nice discussion of block preconditioners in 25723bc631e0SBarry Smith 25733bc631e0SBarry Smith [El08] A taxonomy and comparison of parallel block multi-level preconditioners for the incompressible Navier-Stokes equations 25743bc631e0SBarry Smith Howard Elman, V.E. Howle, John Shadid, Robert Shuttleworth, Ray Tuminaro, Journal of Computational Physics 227 (2008) 1790--1808 25753bc631e0SBarry Smith http://chess.cs.umd.edu/~elman/papers/tax.pdf 25763bc631e0SBarry Smith 25774d308398SBarry Smith The Constrained Pressure Preconditioner (CPR) can be implemented using PCCOMPOSITE with PCGALERKIN. CPR first solves an R A P subsystem, updates the 25784d308398SBarry Smith residual on all variables (PCCompositeSetType(pc,PC_COMPOSITE_MULTIPLICATIVE)), and then applies a simple ILU like preconditioner on all the variables. 2579a6a584a2SBarry Smith 25807e8cb189SBarry Smith .seealso: PCCreate(), PCSetType(), PCType (for list of available types), PC, Block_Preconditioners, PCLSC, 2581285fb4e2SStefano Zampini PCFieldSplitGetSubKSP(), PCFieldSplitSchurGetSubKSP(), PCFieldSplitSetFields(), PCFieldSplitSetType(), PCFieldSplitSetIS(), PCFieldSplitSetSchurPre(), 25827b752e3dSPatrick Sanan MatSchurComplementSetAinvType(), PCFieldSplitSetSchurScale(), 25837b752e3dSPatrick Sanan PCFieldSplitSetDetectSaddlePoint() 25840971522cSBarry Smith M*/ 25850971522cSBarry Smith 25868cc058d9SJed Brown PETSC_EXTERN PetscErrorCode PCCreate_FieldSplit(PC pc) 25870971522cSBarry Smith { 25880971522cSBarry Smith PetscErrorCode ierr; 25890971522cSBarry Smith PC_FieldSplit *jac; 25900971522cSBarry Smith 25910971522cSBarry Smith PetscFunctionBegin; 2592b00a9115SJed Brown ierr = PetscNewLog(pc,&jac);CHKERRQ(ierr); 25932fa5cd67SKarl Rupp 25940971522cSBarry Smith jac->bs = -1; 25950971522cSBarry Smith jac->nsplits = 0; 25963e197d65SBarry Smith jac->type = PC_COMPOSITE_MULTIPLICATIVE; 2597e6cab6aaSJed Brown jac->schurpre = PC_FIELDSPLIT_SCHUR_PRE_USER; /* Try user preconditioner first, fall back on diagonal */ 2598c9c6ffaaSJed Brown jac->schurfactorization = PC_FIELDSPLIT_SCHUR_FACT_FULL; 2599c096484dSStefano Zampini jac->schurscale = -1.0; 2600fbe7908bSJed Brown jac->dm_splits = PETSC_TRUE; 26017b752e3dSPatrick Sanan jac->detect = PETSC_FALSE; 260251f519a2SBarry Smith 26030971522cSBarry Smith pc->data = (void*)jac; 26040971522cSBarry Smith 26050971522cSBarry Smith pc->ops->apply = PCApply_FieldSplit; 2606421e10b8SBarry Smith pc->ops->applytranspose = PCApplyTranspose_FieldSplit; 26070971522cSBarry Smith pc->ops->setup = PCSetUp_FieldSplit; 2608574deadeSBarry Smith pc->ops->reset = PCReset_FieldSplit; 26090971522cSBarry Smith pc->ops->destroy = PCDestroy_FieldSplit; 26100971522cSBarry Smith pc->ops->setfromoptions = PCSetFromOptions_FieldSplit; 26110971522cSBarry Smith pc->ops->view = PCView_FieldSplit; 26120971522cSBarry Smith pc->ops->applyrichardson = 0; 26130971522cSBarry Smith 2614285fb4e2SStefano Zampini ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSchurGetSubKSP_C",PCFieldSplitSchurGetSubKSP_FieldSplit);CHKERRQ(ierr); 2615bdf89e91SBarry Smith ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitGetSubKSP_C",PCFieldSplitGetSubKSP_FieldSplit);CHKERRQ(ierr); 2616bdf89e91SBarry Smith ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetFields_C",PCFieldSplitSetFields_FieldSplit);CHKERRQ(ierr); 2617bdf89e91SBarry Smith ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetIS_C",PCFieldSplitSetIS_FieldSplit);CHKERRQ(ierr); 2618bdf89e91SBarry Smith ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetType_C",PCFieldSplitSetType_FieldSplit);CHKERRQ(ierr); 2619bdf89e91SBarry Smith ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetBlockSize_C",PCFieldSplitSetBlockSize_FieldSplit);CHKERRQ(ierr); 26206dbb499eSCian Wilson ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitRestrictIS_C",PCFieldSplitRestrictIS_FieldSplit);CHKERRQ(ierr); 26210971522cSBarry Smith PetscFunctionReturn(0); 26220971522cSBarry Smith } 2623