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 ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr); 1100971522cSBarry Smith for (i=0; i<jac->nsplits; i++) { 1111ab39975SBarry Smith if (ilink->fields) { 1120971522cSBarry Smith ierr = PetscViewerASCIIPrintf(viewer,"Split number %D Fields ",i);CHKERRQ(ierr); 11379416396SBarry Smith ierr = PetscViewerASCIIUseTabs(viewer,PETSC_FALSE);CHKERRQ(ierr); 1145a9f2f41SSatish Balay for (j=0; j<ilink->nfields; j++) { 11579416396SBarry Smith if (j > 0) { 11679416396SBarry Smith ierr = PetscViewerASCIIPrintf(viewer,",");CHKERRQ(ierr); 11779416396SBarry Smith } 1185a9f2f41SSatish Balay ierr = PetscViewerASCIIPrintf(viewer," %D",ilink->fields[j]);CHKERRQ(ierr); 1190971522cSBarry Smith } 1200971522cSBarry Smith ierr = PetscViewerASCIIPrintf(viewer,"\n");CHKERRQ(ierr); 12179416396SBarry Smith ierr = PetscViewerASCIIUseTabs(viewer,PETSC_TRUE);CHKERRQ(ierr); 1221ab39975SBarry Smith } else { 1231ab39975SBarry Smith ierr = PetscViewerASCIIPrintf(viewer,"Split number %D Defined by IS\n",i);CHKERRQ(ierr); 1241ab39975SBarry Smith } 1255a9f2f41SSatish Balay ierr = KSPView(ilink->ksp,viewer);CHKERRQ(ierr); 1265a9f2f41SSatish Balay ilink = ilink->next; 1270971522cSBarry Smith } 1280971522cSBarry Smith ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr); 1292fa5cd67SKarl Rupp } 1302fa5cd67SKarl Rupp 1312fa5cd67SKarl Rupp if (isdraw) { 132d9884438SBarry Smith PetscDraw draw; 133d9884438SBarry Smith PetscReal x,y,w,wd; 134d9884438SBarry Smith 135d9884438SBarry Smith ierr = PetscViewerDrawGetDraw(viewer,0,&draw);CHKERRQ(ierr); 136d9884438SBarry Smith ierr = PetscDrawGetCurrentPoint(draw,&x,&y);CHKERRQ(ierr); 137d9884438SBarry Smith w = 2*PetscMin(1.0 - x,x); 138d9884438SBarry Smith wd = w/(jac->nsplits + 1); 139d9884438SBarry Smith x = x - wd*(jac->nsplits-1)/2.0; 140d9884438SBarry Smith for (i=0; i<jac->nsplits; i++) { 141d9884438SBarry Smith ierr = PetscDrawPushCurrentPoint(draw,x,y);CHKERRQ(ierr); 142d9884438SBarry Smith ierr = KSPView(ilink->ksp,viewer);CHKERRQ(ierr); 143d9884438SBarry Smith ierr = PetscDrawPopCurrentPoint(draw);CHKERRQ(ierr); 144d9884438SBarry Smith x += wd; 145d9884438SBarry Smith ilink = ilink->next; 146d9884438SBarry Smith } 1470971522cSBarry Smith } 1480971522cSBarry Smith PetscFunctionReturn(0); 1490971522cSBarry Smith } 1500971522cSBarry Smith 1513b224e63SBarry Smith static PetscErrorCode PCView_FieldSplit_Schur(PC pc,PetscViewer viewer) 1523b224e63SBarry Smith { 1533b224e63SBarry Smith PC_FieldSplit *jac = (PC_FieldSplit*)pc->data; 1543b224e63SBarry Smith PetscErrorCode ierr; 1554996c5bdSBarry Smith PetscBool iascii,isdraw; 1563b224e63SBarry Smith PetscInt i,j; 1573b224e63SBarry Smith PC_FieldSplitLink ilink = jac->head; 158a9908d51SBarry Smith MatSchurComplementAinvType atype; 1593b224e63SBarry Smith 1603b224e63SBarry Smith PetscFunctionBegin; 161251f4c67SDmitry Karpeev ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&iascii);CHKERRQ(ierr); 1624996c5bdSBarry Smith ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERDRAW,&isdraw);CHKERRQ(ierr); 1633b224e63SBarry Smith if (iascii) { 1642c9966d7SBarry Smith if (jac->bs > 0) { 165c9c6ffaaSJed Brown ierr = PetscViewerASCIIPrintf(viewer," FieldSplit with Schur preconditioner, blocksize = %D, factorization %s\n",jac->bs,PCFieldSplitSchurFactTypes[jac->schurfactorization]);CHKERRQ(ierr); 1662c9966d7SBarry Smith } else { 1672c9966d7SBarry Smith ierr = PetscViewerASCIIPrintf(viewer," FieldSplit with Schur preconditioner, factorization %s\n",PCFieldSplitSchurFactTypes[jac->schurfactorization]);CHKERRQ(ierr); 1682c9966d7SBarry Smith } 169f5236f50SJed Brown if (pc->useAmat) { 170f5236f50SJed Brown ierr = PetscViewerASCIIPrintf(viewer," using Amat (not Pmat) as operator for blocks\n");CHKERRQ(ierr); 171a3df900dSMatthew G Knepley } 1723e8b8b31SMatthew G Knepley switch (jac->schurpre) { 1733e8b8b31SMatthew G Knepley case PC_FIELDSPLIT_SCHUR_PRE_SELF: 174a9908d51SBarry Smith ierr = PetscViewerASCIIPrintf(viewer," Preconditioner for the Schur complement formed from S itself\n");CHKERRQ(ierr); 175a9908d51SBarry Smith break; 176a7476a74SDmitry Karpeev case PC_FIELDSPLIT_SCHUR_PRE_SELFP: 177a9908d51SBarry Smith ierr = MatSchurComplementGetAinvType(jac->schur,&atype);CHKERRQ(ierr); 178d0a9c1a2SBarry 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; 179e87fab1bSBarry Smith case PC_FIELDSPLIT_SCHUR_PRE_A11: 180a9908d51SBarry Smith ierr = PetscViewerASCIIPrintf(viewer," Preconditioner for the Schur complement formed from A11\n");CHKERRQ(ierr); 181a9908d51SBarry Smith break; 182e74569cdSMatthew G. Knepley case PC_FIELDSPLIT_SCHUR_PRE_FULL: 183a9908d51SBarry Smith ierr = PetscViewerASCIIPrintf(viewer," Preconditioner for the Schur complement formed from the exact Schur complement\n");CHKERRQ(ierr); 184a9908d51SBarry Smith break; 1853e8b8b31SMatthew G Knepley case PC_FIELDSPLIT_SCHUR_PRE_USER: 1863e8b8b31SMatthew G Knepley if (jac->schur_user) { 1873e8b8b31SMatthew G Knepley ierr = PetscViewerASCIIPrintf(viewer," Preconditioner for the Schur complement formed from user provided matrix\n");CHKERRQ(ierr); 1883e8b8b31SMatthew G Knepley } else { 189e87fab1bSBarry Smith ierr = PetscViewerASCIIPrintf(viewer," Preconditioner for the Schur complement formed from A11\n");CHKERRQ(ierr); 1903e8b8b31SMatthew G Knepley } 1913e8b8b31SMatthew G Knepley break; 1923e8b8b31SMatthew G Knepley default: 19382f516ccSBarry Smith SETERRQ1(PetscObjectComm((PetscObject)pc), PETSC_ERR_ARG_OUTOFRANGE, "Invalid Schur preconditioning type: %d", jac->schurpre); 1943e8b8b31SMatthew G Knepley } 1953b224e63SBarry Smith ierr = PetscViewerASCIIPrintf(viewer," Split info:\n");CHKERRQ(ierr); 1963b224e63SBarry Smith ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr); 1973b224e63SBarry Smith for (i=0; i<jac->nsplits; i++) { 1983b224e63SBarry Smith if (ilink->fields) { 1993b224e63SBarry Smith ierr = PetscViewerASCIIPrintf(viewer,"Split number %D Fields ",i);CHKERRQ(ierr); 2003b224e63SBarry Smith ierr = PetscViewerASCIIUseTabs(viewer,PETSC_FALSE);CHKERRQ(ierr); 2013b224e63SBarry Smith for (j=0; j<ilink->nfields; j++) { 2023b224e63SBarry Smith if (j > 0) { 2033b224e63SBarry Smith ierr = PetscViewerASCIIPrintf(viewer,",");CHKERRQ(ierr); 2043b224e63SBarry Smith } 2053b224e63SBarry Smith ierr = PetscViewerASCIIPrintf(viewer," %D",ilink->fields[j]);CHKERRQ(ierr); 2063b224e63SBarry Smith } 2073b224e63SBarry Smith ierr = PetscViewerASCIIPrintf(viewer,"\n");CHKERRQ(ierr); 2083b224e63SBarry Smith ierr = PetscViewerASCIIUseTabs(viewer,PETSC_TRUE);CHKERRQ(ierr); 2093b224e63SBarry Smith } else { 2103b224e63SBarry Smith ierr = PetscViewerASCIIPrintf(viewer,"Split number %D Defined by IS\n",i);CHKERRQ(ierr); 2113b224e63SBarry Smith } 2123b224e63SBarry Smith ilink = ilink->next; 2133b224e63SBarry Smith } 214435f959eSBarry Smith ierr = PetscViewerASCIIPrintf(viewer,"KSP solver for A00 block\n");CHKERRQ(ierr); 2153b224e63SBarry Smith ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr); 21606de4afeSJed Brown if (jac->head) { 217443836d0SMatthew G Knepley ierr = KSPView(jac->head->ksp,viewer);CHKERRQ(ierr); 21806de4afeSJed Brown } else {ierr = PetscViewerASCIIPrintf(viewer," not yet available\n");CHKERRQ(ierr);} 2193b224e63SBarry Smith ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr); 22006de4afeSJed Brown if (jac->head && jac->kspupper != jac->head->ksp) { 221443836d0SMatthew G Knepley ierr = PetscViewerASCIIPrintf(viewer,"KSP solver for upper A00 in upper triangular factor \n");CHKERRQ(ierr); 222443836d0SMatthew G Knepley ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr); 223b2750c55SJed Brown if (jac->kspupper) {ierr = KSPView(jac->kspupper,viewer);CHKERRQ(ierr);} 224b2750c55SJed Brown else {ierr = PetscViewerASCIIPrintf(viewer," not yet available\n");CHKERRQ(ierr);} 225443836d0SMatthew G Knepley ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr); 226443836d0SMatthew G Knepley } 227435f959eSBarry Smith ierr = PetscViewerASCIIPrintf(viewer,"KSP solver for S = A11 - A10 inv(A00) A01 \n");CHKERRQ(ierr); 2283b224e63SBarry Smith ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr); 22912cae6f2SJed Brown if (jac->kspschur) { 2303b224e63SBarry Smith ierr = KSPView(jac->kspschur,viewer);CHKERRQ(ierr); 23112cae6f2SJed Brown } else { 23212cae6f2SJed Brown ierr = PetscViewerASCIIPrintf(viewer," not yet available\n");CHKERRQ(ierr); 23312cae6f2SJed Brown } 2343b224e63SBarry Smith ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr); 2353b224e63SBarry Smith ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr); 23606de4afeSJed Brown } else if (isdraw && jac->head) { 2374996c5bdSBarry Smith PetscDraw draw; 2384996c5bdSBarry Smith PetscReal x,y,w,wd,h; 2394996c5bdSBarry Smith PetscInt cnt = 2; 2404996c5bdSBarry Smith char str[32]; 2414996c5bdSBarry Smith 2424996c5bdSBarry Smith ierr = PetscViewerDrawGetDraw(viewer,0,&draw);CHKERRQ(ierr); 2434996c5bdSBarry Smith ierr = PetscDrawGetCurrentPoint(draw,&x,&y);CHKERRQ(ierr); 244c74581afSBarry Smith if (jac->kspupper != jac->head->ksp) cnt++; 245c74581afSBarry Smith w = 2*PetscMin(1.0 - x,x); 246c74581afSBarry Smith wd = w/(cnt + 1); 247c74581afSBarry Smith 2484996c5bdSBarry Smith ierr = PetscSNPrintf(str,32,"Schur fact. %s",PCFieldSplitSchurFactTypes[jac->schurfactorization]);CHKERRQ(ierr); 24951fa3d41SBarry Smith ierr = PetscDrawStringBoxed(draw,x,y,PETSC_DRAW_RED,PETSC_DRAW_BLACK,str,NULL,&h);CHKERRQ(ierr); 2504996c5bdSBarry Smith y -= h; 2514996c5bdSBarry Smith if (jac->schurpre == PC_FIELDSPLIT_SCHUR_PRE_USER && !jac->schur_user) { 252e87fab1bSBarry Smith ierr = PetscSNPrintf(str,32,"Prec. for Schur from %s",PCFieldSplitSchurPreTypes[PC_FIELDSPLIT_SCHUR_PRE_A11]);CHKERRQ(ierr); 2533b224e63SBarry Smith } else { 2544996c5bdSBarry Smith ierr = PetscSNPrintf(str,32,"Prec. for Schur from %s",PCFieldSplitSchurPreTypes[jac->schurpre]);CHKERRQ(ierr); 2554996c5bdSBarry Smith } 25651fa3d41SBarry Smith ierr = PetscDrawStringBoxed(draw,x+wd*(cnt-1)/2.0,y,PETSC_DRAW_RED,PETSC_DRAW_BLACK,str,NULL,&h);CHKERRQ(ierr); 2574996c5bdSBarry Smith y -= h; 2584996c5bdSBarry Smith x = x - wd*(cnt-1)/2.0; 2594996c5bdSBarry Smith 2604996c5bdSBarry Smith ierr = PetscDrawPushCurrentPoint(draw,x,y);CHKERRQ(ierr); 2614996c5bdSBarry Smith ierr = KSPView(jac->head->ksp,viewer);CHKERRQ(ierr); 2624996c5bdSBarry Smith ierr = PetscDrawPopCurrentPoint(draw);CHKERRQ(ierr); 2634996c5bdSBarry Smith if (jac->kspupper != jac->head->ksp) { 2644996c5bdSBarry Smith x += wd; 2654996c5bdSBarry Smith ierr = PetscDrawPushCurrentPoint(draw,x,y);CHKERRQ(ierr); 2664996c5bdSBarry Smith ierr = KSPView(jac->kspupper,viewer);CHKERRQ(ierr); 2674996c5bdSBarry Smith ierr = PetscDrawPopCurrentPoint(draw);CHKERRQ(ierr); 2684996c5bdSBarry Smith } 2694996c5bdSBarry Smith x += wd; 2704996c5bdSBarry Smith ierr = PetscDrawPushCurrentPoint(draw,x,y);CHKERRQ(ierr); 2714996c5bdSBarry Smith ierr = KSPView(jac->kspschur,viewer);CHKERRQ(ierr); 2724996c5bdSBarry Smith ierr = PetscDrawPopCurrentPoint(draw);CHKERRQ(ierr); 2733b224e63SBarry Smith } 2743b224e63SBarry Smith PetscFunctionReturn(0); 2753b224e63SBarry Smith } 2763b224e63SBarry Smith 2776c924f48SJed Brown /* Precondition: jac->bs is set to a meaningful value */ 2786c924f48SJed Brown static PetscErrorCode PCFieldSplitSetRuntimeSplits_Private(PC pc) 2796c924f48SJed Brown { 2806c924f48SJed Brown PetscErrorCode ierr; 2816c924f48SJed Brown PC_FieldSplit *jac = (PC_FieldSplit*)pc->data; 2825d4c12cdSJungho Lee PetscInt i,nfields,*ifields,nfields_col,*ifields_col; 2835d4c12cdSJungho Lee PetscBool flg,flg_col; 2845d4c12cdSJungho Lee char optionname[128],splitname[8],optionname_col[128]; 2856c924f48SJed Brown 2866c924f48SJed Brown PetscFunctionBegin; 287785e854fSJed Brown ierr = PetscMalloc1(jac->bs,&ifields);CHKERRQ(ierr); 288785e854fSJed Brown ierr = PetscMalloc1(jac->bs,&ifields_col);CHKERRQ(ierr); 2896c924f48SJed Brown for (i=0,flg=PETSC_TRUE;; i++) { 2908caf3d72SBarry Smith ierr = PetscSNPrintf(splitname,sizeof(splitname),"%D",i);CHKERRQ(ierr); 2918caf3d72SBarry Smith ierr = PetscSNPrintf(optionname,sizeof(optionname),"-pc_fieldsplit_%D_fields",i);CHKERRQ(ierr); 2928caf3d72SBarry Smith ierr = PetscSNPrintf(optionname_col,sizeof(optionname_col),"-pc_fieldsplit_%D_fields_col",i);CHKERRQ(ierr); 2936c924f48SJed Brown nfields = jac->bs; 29429499fbbSJungho Lee nfields_col = jac->bs; 295c5929fdfSBarry Smith ierr = PetscOptionsGetIntArray(((PetscObject)pc)->options,((PetscObject)pc)->prefix,optionname,ifields,&nfields,&flg);CHKERRQ(ierr); 296c5929fdfSBarry Smith ierr = PetscOptionsGetIntArray(((PetscObject)pc)->options,((PetscObject)pc)->prefix,optionname_col,ifields_col,&nfields_col,&flg_col);CHKERRQ(ierr); 2976c924f48SJed Brown if (!flg) break; 2985d4c12cdSJungho Lee else if (flg && !flg_col) { 2995d4c12cdSJungho Lee if (!nfields) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_USER,"Cannot list zero fields"); 3005d4c12cdSJungho Lee ierr = PCFieldSplitSetFields(pc,splitname,nfields,ifields,ifields);CHKERRQ(ierr); 3012fa5cd67SKarl Rupp } else { 3025d4c12cdSJungho Lee if (!nfields || !nfields_col) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_USER,"Cannot list zero fields"); 3035d4c12cdSJungho Lee if (nfields != nfields_col) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_USER,"Number of row and column fields must match"); 3045d4c12cdSJungho Lee ierr = PCFieldSplitSetFields(pc,splitname,nfields,ifields,ifields_col);CHKERRQ(ierr); 3055d4c12cdSJungho Lee } 3066c924f48SJed Brown } 3076c924f48SJed Brown if (i > 0) { 3086c924f48SJed Brown /* Makes command-line setting of splits take precedence over setting them in code. 3096c924f48SJed Brown Otherwise subsequent calls to PCFieldSplitSetIS() or PCFieldSplitSetFields() would 3106c924f48SJed Brown create new splits, which would probably not be what the user wanted. */ 3116c924f48SJed Brown jac->splitdefined = PETSC_TRUE; 3126c924f48SJed Brown } 3136c924f48SJed Brown ierr = PetscFree(ifields);CHKERRQ(ierr); 3145d4c12cdSJungho Lee ierr = PetscFree(ifields_col);CHKERRQ(ierr); 3156c924f48SJed Brown PetscFunctionReturn(0); 3166c924f48SJed Brown } 3176c924f48SJed Brown 31869a612a9SBarry Smith static PetscErrorCode PCFieldSplitSetDefaults(PC pc) 3190971522cSBarry Smith { 3200971522cSBarry Smith PC_FieldSplit *jac = (PC_FieldSplit*)pc->data; 3210971522cSBarry Smith PetscErrorCode ierr; 3225a9f2f41SSatish Balay PC_FieldSplitLink ilink = jac->head; 3237b752e3dSPatrick Sanan PetscBool fieldsplit_default = PETSC_FALSE,coupling = PETSC_FALSE; 3246c924f48SJed Brown PetscInt i; 3250971522cSBarry Smith 3260971522cSBarry Smith PetscFunctionBegin; 3277287d2a3SDmitry Karpeev /* 328f5f0d762SBarry Smith Kinda messy, but at least this now uses DMCreateFieldDecomposition(). 3297287d2a3SDmitry Karpeev Should probably be rewritten. 3307287d2a3SDmitry Karpeev */ 331f5f0d762SBarry Smith if (!ilink) { 332c5929fdfSBarry Smith ierr = PetscOptionsGetBool(((PetscObject)pc)->options,((PetscObject)pc)->prefix,"-pc_fieldsplit_detect_coupling",&coupling,NULL);CHKERRQ(ierr); 3337b752e3dSPatrick Sanan if (pc->dm && jac->dm_splits && !jac->detect && !coupling) { 334bafc1b83SMatthew G Knepley PetscInt numFields, f, i, j; 3350784a22cSJed Brown char **fieldNames; 3367b62db95SJungho Lee IS *fields; 337e7c4fc90SDmitry Karpeev DM *dms; 338bafc1b83SMatthew G Knepley DM subdm[128]; 339bafc1b83SMatthew G Knepley PetscBool flg; 340bafc1b83SMatthew G Knepley 34116621825SDmitry Karpeev ierr = DMCreateFieldDecomposition(pc->dm, &numFields, &fieldNames, &fields, &dms);CHKERRQ(ierr); 342bafc1b83SMatthew G Knepley /* Allow the user to prescribe the splits */ 343bafc1b83SMatthew G Knepley for (i = 0, flg = PETSC_TRUE;; i++) { 344bafc1b83SMatthew G Knepley PetscInt ifields[128]; 345bafc1b83SMatthew G Knepley IS compField; 346bafc1b83SMatthew G Knepley char optionname[128], splitname[8]; 347bafc1b83SMatthew G Knepley PetscInt nfields = numFields; 348bafc1b83SMatthew G Knepley 3498caf3d72SBarry Smith ierr = PetscSNPrintf(optionname, sizeof(optionname), "-pc_fieldsplit_%D_fields", i);CHKERRQ(ierr); 350c5929fdfSBarry Smith ierr = PetscOptionsGetIntArray(((PetscObject)pc)->options,((PetscObject)pc)->prefix, optionname, ifields, &nfields, &flg);CHKERRQ(ierr); 351bafc1b83SMatthew G Knepley if (!flg) break; 35282f516ccSBarry Smith if (numFields > 128) SETERRQ1(PetscObjectComm((PetscObject)pc),PETSC_ERR_SUP,"Cannot currently support %d > 128 fields", numFields); 353bafc1b83SMatthew G Knepley ierr = DMCreateSubDM(pc->dm, nfields, ifields, &compField, &subdm[i]);CHKERRQ(ierr); 354bafc1b83SMatthew G Knepley if (nfields == 1) { 355bafc1b83SMatthew G Knepley ierr = PCFieldSplitSetIS(pc, fieldNames[ifields[0]], compField);CHKERRQ(ierr); 356bafc1b83SMatthew G Knepley } else { 3578caf3d72SBarry Smith ierr = PetscSNPrintf(splitname, sizeof(splitname), "%D", i);CHKERRQ(ierr); 358bafc1b83SMatthew G Knepley ierr = PCFieldSplitSetIS(pc, splitname, compField);CHKERRQ(ierr); 3597287d2a3SDmitry Karpeev } 360bafc1b83SMatthew G Knepley ierr = ISDestroy(&compField);CHKERRQ(ierr); 361bafc1b83SMatthew G Knepley for (j = 0; j < nfields; ++j) { 362bafc1b83SMatthew G Knepley f = ifields[j]; 3637b62db95SJungho Lee ierr = PetscFree(fieldNames[f]);CHKERRQ(ierr); 3647b62db95SJungho Lee ierr = ISDestroy(&fields[f]);CHKERRQ(ierr); 3657b62db95SJungho Lee } 366bafc1b83SMatthew G Knepley } 367bafc1b83SMatthew G Knepley if (i == 0) { 368bafc1b83SMatthew G Knepley for (f = 0; f < numFields; ++f) { 369bafc1b83SMatthew G Knepley ierr = PCFieldSplitSetIS(pc, fieldNames[f], fields[f]);CHKERRQ(ierr); 370bafc1b83SMatthew G Knepley ierr = PetscFree(fieldNames[f]);CHKERRQ(ierr); 371bafc1b83SMatthew G Knepley ierr = ISDestroy(&fields[f]);CHKERRQ(ierr); 372bafc1b83SMatthew G Knepley } 373bafc1b83SMatthew G Knepley } else { 374d724dfffSBarry Smith for (j=0; j<numFields; j++) { 375d724dfffSBarry Smith ierr = DMDestroy(dms+j);CHKERRQ(ierr); 376d724dfffSBarry Smith } 377d724dfffSBarry Smith ierr = PetscFree(dms);CHKERRQ(ierr); 378785e854fSJed Brown ierr = PetscMalloc1(i, &dms);CHKERRQ(ierr); 3792fa5cd67SKarl Rupp for (j = 0; j < i; ++j) dms[j] = subdm[j]; 380bafc1b83SMatthew G Knepley } 3817b62db95SJungho Lee ierr = PetscFree(fieldNames);CHKERRQ(ierr); 3827b62db95SJungho Lee ierr = PetscFree(fields);CHKERRQ(ierr); 383e7c4fc90SDmitry Karpeev if (dms) { 3848b8307b2SJed Brown ierr = PetscInfo(pc, "Setting up physics based fieldsplit preconditioner using the embedded DM\n");CHKERRQ(ierr); 385bafc1b83SMatthew G Knepley for (ilink = jac->head, i = 0; ilink; ilink = ilink->next, ++i) { 3867287d2a3SDmitry Karpeev const char *prefix; 3877287d2a3SDmitry Karpeev ierr = PetscObjectGetOptionsPrefix((PetscObject)(ilink->ksp),&prefix);CHKERRQ(ierr); 3887287d2a3SDmitry Karpeev ierr = PetscObjectSetOptionsPrefix((PetscObject)(dms[i]), prefix);CHKERRQ(ierr); 3897b62db95SJungho Lee ierr = KSPSetDM(ilink->ksp, dms[i]);CHKERRQ(ierr); 3907b62db95SJungho Lee ierr = KSPSetDMActive(ilink->ksp, PETSC_FALSE);CHKERRQ(ierr); 3917287d2a3SDmitry Karpeev ierr = PetscObjectIncrementTabLevel((PetscObject)dms[i],(PetscObject)ilink->ksp,0);CHKERRQ(ierr); 392e7c4fc90SDmitry Karpeev ierr = DMDestroy(&dms[i]);CHKERRQ(ierr); 3932fa5ba8aSJed Brown } 3947b62db95SJungho Lee ierr = PetscFree(dms);CHKERRQ(ierr); 3958b8307b2SJed Brown } 39666ffff09SJed Brown } else { 397521d7252SBarry Smith if (jac->bs <= 0) { 398704ba839SBarry Smith if (pc->pmat) { 399521d7252SBarry Smith ierr = MatGetBlockSize(pc->pmat,&jac->bs);CHKERRQ(ierr); 4002fa5cd67SKarl Rupp } else jac->bs = 1; 401521d7252SBarry Smith } 402d32f9abdSBarry Smith 4037b752e3dSPatrick Sanan if (jac->detect) { 4046ce1633cSBarry Smith IS zerodiags,rest; 4056ce1633cSBarry Smith PetscInt nmin,nmax; 4066ce1633cSBarry Smith 4076ce1633cSBarry Smith ierr = MatGetOwnershipRange(pc->mat,&nmin,&nmax);CHKERRQ(ierr); 4086ce1633cSBarry Smith ierr = MatFindZeroDiagonals(pc->mat,&zerodiags);CHKERRQ(ierr); 4096ce1633cSBarry Smith ierr = ISComplement(zerodiags,nmin,nmax,&rest);CHKERRQ(ierr); 4106ce1633cSBarry Smith ierr = PCFieldSplitSetIS(pc,"0",rest);CHKERRQ(ierr); 4116ce1633cSBarry Smith ierr = PCFieldSplitSetIS(pc,"1",zerodiags);CHKERRQ(ierr); 412fcfd50ebSBarry Smith ierr = ISDestroy(&zerodiags);CHKERRQ(ierr); 413fcfd50ebSBarry Smith ierr = ISDestroy(&rest);CHKERRQ(ierr); 4143a062f41SBarry Smith } else if (coupling) { 4153a062f41SBarry Smith IS coupling,rest; 4163a062f41SBarry Smith PetscInt nmin,nmax; 4173a062f41SBarry Smith 4183a062f41SBarry Smith ierr = MatGetOwnershipRange(pc->mat,&nmin,&nmax);CHKERRQ(ierr); 4193a062f41SBarry Smith ierr = MatFindOffBlockDiagonalEntries(pc->mat,&coupling);CHKERRQ(ierr); 4206bea0878SBarry Smith ierr = ISCreateStride(PetscObjectComm((PetscObject)pc->mat),nmax-nmin,nmin,1,&rest);CHKERRQ(ierr); 421e52d2c62SBarry Smith ierr = ISSetIdentity(rest);CHKERRQ(ierr); 422d020c841SBarry Smith ierr = PCFieldSplitSetIS(pc,"0",rest);CHKERRQ(ierr); 423d020c841SBarry Smith ierr = PCFieldSplitSetIS(pc,"1",coupling);CHKERRQ(ierr); 4243a062f41SBarry Smith ierr = ISDestroy(&coupling);CHKERRQ(ierr); 4253a062f41SBarry Smith ierr = ISDestroy(&rest);CHKERRQ(ierr); 4266ce1633cSBarry Smith } else { 427c5929fdfSBarry Smith ierr = PetscOptionsGetBool(((PetscObject)pc)->options,((PetscObject)pc)->prefix,"-pc_fieldsplit_default",&fieldsplit_default,NULL);CHKERRQ(ierr); 4287287d2a3SDmitry Karpeev if (!fieldsplit_default) { 429d32f9abdSBarry Smith /* Allow user to set fields from command line, if bs was known at the time of PCSetFromOptions_FieldSplit() 430d32f9abdSBarry Smith then it is set there. This is not ideal because we should only have options set in XXSetFromOptions(). */ 4316c924f48SJed Brown ierr = PCFieldSplitSetRuntimeSplits_Private(pc);CHKERRQ(ierr); 4326c924f48SJed Brown if (jac->splitdefined) {ierr = PetscInfo(pc,"Splits defined using the options database\n");CHKERRQ(ierr);} 433d32f9abdSBarry Smith } 4346dbb499eSCian Wilson if ((fieldsplit_default || !jac->splitdefined) && !jac->isrestrict) { 435d32f9abdSBarry Smith ierr = PetscInfo(pc,"Using default splitting of fields\n");CHKERRQ(ierr); 436db4c96c1SJed Brown for (i=0; i<jac->bs; i++) { 4376c924f48SJed Brown char splitname[8]; 4388caf3d72SBarry Smith ierr = PetscSNPrintf(splitname,sizeof(splitname),"%D",i);CHKERRQ(ierr); 4395d4c12cdSJungho Lee ierr = PCFieldSplitSetFields(pc,splitname,1,&i,&i);CHKERRQ(ierr); 44079416396SBarry Smith } 4415d4c12cdSJungho Lee jac->defaultsplit = PETSC_TRUE; 442521d7252SBarry Smith } 44366ffff09SJed Brown } 4446ce1633cSBarry Smith } 445edf189efSBarry Smith } else if (jac->nsplits == 1) { 446edf189efSBarry Smith if (ilink->is) { 447edf189efSBarry Smith IS is2; 448edf189efSBarry Smith PetscInt nmin,nmax; 449edf189efSBarry Smith 450edf189efSBarry Smith ierr = MatGetOwnershipRange(pc->mat,&nmin,&nmax);CHKERRQ(ierr); 451edf189efSBarry Smith ierr = ISComplement(ilink->is,nmin,nmax,&is2);CHKERRQ(ierr); 452db4c96c1SJed Brown ierr = PCFieldSplitSetIS(pc,"1",is2);CHKERRQ(ierr); 453fcfd50ebSBarry Smith ierr = ISDestroy(&is2);CHKERRQ(ierr); 45482f516ccSBarry Smith } else SETERRQ(PetscObjectComm((PetscObject)pc),PETSC_ERR_SUP,"Must provide at least two sets of fields to PCFieldSplit()"); 455edf189efSBarry Smith } 456d0af7cd3SBarry Smith 45782f516ccSBarry Smith if (jac->nsplits < 2) SETERRQ1(PetscObjectComm((PetscObject)pc),PETSC_ERR_PLIB,"Unhandled case, must have at least two fields, not %d", jac->nsplits); 45869a612a9SBarry Smith PetscFunctionReturn(0); 45969a612a9SBarry Smith } 46069a612a9SBarry Smith 461c5929fdfSBarry Smith PETSC_EXTERN PetscErrorCode PetscOptionsFindPairPrefix_Private(PetscOptions,const char pre[], const char name[], char *value[], PetscBool *flg); 462514bf10dSMatthew G Knepley 46369a612a9SBarry Smith static PetscErrorCode PCSetUp_FieldSplit(PC pc) 46469a612a9SBarry Smith { 46569a612a9SBarry Smith PC_FieldSplit *jac = (PC_FieldSplit*)pc->data; 46669a612a9SBarry Smith PetscErrorCode ierr; 4675a9f2f41SSatish Balay PC_FieldSplitLink ilink; 4682c9966d7SBarry Smith PetscInt i,nsplit; 4695f4ab4e1SJungho Lee PetscBool sorted, sorted_col; 47069a612a9SBarry Smith 47169a612a9SBarry Smith PetscFunctionBegin; 47269a612a9SBarry Smith ierr = PCFieldSplitSetDefaults(pc);CHKERRQ(ierr); 47397bbdb24SBarry Smith nsplit = jac->nsplits; 4745a9f2f41SSatish Balay ilink = jac->head; 47597bbdb24SBarry Smith 47697bbdb24SBarry Smith /* get the matrices for each split */ 477704ba839SBarry Smith if (!jac->issetup) { 4781b9fc7fcSBarry Smith PetscInt rstart,rend,nslots,bs; 47997bbdb24SBarry Smith 480704ba839SBarry Smith jac->issetup = PETSC_TRUE; 481704ba839SBarry Smith 4825d4c12cdSJungho Lee /* This is done here instead of in PCFieldSplitSetFields() because may not have matrix at that point */ 4832c9966d7SBarry Smith if (jac->defaultsplit || !ilink->is) { 4842c9966d7SBarry Smith if (jac->bs <= 0) jac->bs = nsplit; 4852c9966d7SBarry Smith } 48651f519a2SBarry Smith bs = jac->bs; 48797bbdb24SBarry Smith ierr = MatGetOwnershipRange(pc->pmat,&rstart,&rend);CHKERRQ(ierr); 4881b9fc7fcSBarry Smith nslots = (rend - rstart)/bs; 4891b9fc7fcSBarry Smith for (i=0; i<nsplit; i++) { 4901b9fc7fcSBarry Smith if (jac->defaultsplit) { 491ce94432eSBarry Smith ierr = ISCreateStride(PetscObjectComm((PetscObject)pc),nslots,rstart+i,nsplit,&ilink->is);CHKERRQ(ierr); 4925f4ab4e1SJungho Lee ierr = ISDuplicate(ilink->is,&ilink->is_col);CHKERRQ(ierr); 493704ba839SBarry Smith } else if (!ilink->is) { 494ccb205f8SBarry Smith if (ilink->nfields > 1) { 4955f4ab4e1SJungho Lee PetscInt *ii,*jj,j,k,nfields = ilink->nfields,*fields = ilink->fields,*fields_col = ilink->fields_col; 496785e854fSJed Brown ierr = PetscMalloc1(ilink->nfields*nslots,&ii);CHKERRQ(ierr); 497785e854fSJed Brown ierr = PetscMalloc1(ilink->nfields*nslots,&jj);CHKERRQ(ierr); 4981b9fc7fcSBarry Smith for (j=0; j<nslots; j++) { 4991b9fc7fcSBarry Smith for (k=0; k<nfields; k++) { 5001b9fc7fcSBarry Smith ii[nfields*j + k] = rstart + bs*j + fields[k]; 5015f4ab4e1SJungho Lee jj[nfields*j + k] = rstart + bs*j + fields_col[k]; 50297bbdb24SBarry Smith } 50397bbdb24SBarry Smith } 504ce94432eSBarry Smith ierr = ISCreateGeneral(PetscObjectComm((PetscObject)pc),nslots*nfields,ii,PETSC_OWN_POINTER,&ilink->is);CHKERRQ(ierr); 505ce94432eSBarry Smith ierr = ISCreateGeneral(PetscObjectComm((PetscObject)pc),nslots*nfields,jj,PETSC_OWN_POINTER,&ilink->is_col);CHKERRQ(ierr); 50690e68f20SPatrick Farrell ierr = ISSetBlockSize(ilink->is, nfields);CHKERRQ(ierr); 50790e68f20SPatrick Farrell ierr = ISSetBlockSize(ilink->is_col, nfields);CHKERRQ(ierr); 508ccb205f8SBarry Smith } else { 509ce94432eSBarry Smith ierr = ISCreateStride(PetscObjectComm((PetscObject)pc),nslots,rstart+ilink->fields[0],bs,&ilink->is);CHKERRQ(ierr); 510ce94432eSBarry Smith ierr = ISCreateStride(PetscObjectComm((PetscObject)pc),nslots,rstart+ilink->fields_col[0],bs,&ilink->is_col);CHKERRQ(ierr); 511ccb205f8SBarry Smith } 5123e197d65SBarry Smith } 513704ba839SBarry Smith ierr = ISSorted(ilink->is,&sorted);CHKERRQ(ierr); 5145f4ab4e1SJungho Lee if (ilink->is_col) { ierr = ISSorted(ilink->is_col,&sorted_col);CHKERRQ(ierr); } 5155f4ab4e1SJungho Lee if (!sorted || !sorted_col) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_USER,"Fields must be sorted when creating split"); 516704ba839SBarry Smith ilink = ilink->next; 5171b9fc7fcSBarry Smith } 5181b9fc7fcSBarry Smith } 5191b9fc7fcSBarry Smith 520704ba839SBarry Smith ilink = jac->head; 52197bbdb24SBarry Smith if (!jac->pmat) { 522bdddcaaaSMatthew G Knepley Vec xtmp; 523bdddcaaaSMatthew G Knepley 5242a7a6963SBarry Smith ierr = MatCreateVecs(pc->pmat,&xtmp,NULL);CHKERRQ(ierr); 525785e854fSJed Brown ierr = PetscMalloc1(nsplit,&jac->pmat);CHKERRQ(ierr); 526dcca6d9dSJed Brown ierr = PetscMalloc2(nsplit,&jac->x,nsplit,&jac->y);CHKERRQ(ierr); 527cf502942SBarry Smith for (i=0; i<nsplit; i++) { 528bdddcaaaSMatthew G Knepley MatNullSpace sp; 529bdddcaaaSMatthew G Knepley 530a3df900dSMatthew G Knepley /* Check for preconditioning matrix attached to IS */ 531a3df900dSMatthew G Knepley ierr = PetscObjectQuery((PetscObject) ilink->is, "pmat", (PetscObject*) &jac->pmat[i]);CHKERRQ(ierr); 532a3df900dSMatthew G Knepley if (jac->pmat[i]) { 533a3df900dSMatthew G Knepley ierr = PetscObjectReference((PetscObject) jac->pmat[i]);CHKERRQ(ierr); 534a3df900dSMatthew G Knepley if (jac->type == PC_COMPOSITE_SCHUR) { 535a3df900dSMatthew G Knepley jac->schur_user = jac->pmat[i]; 5362fa5cd67SKarl Rupp 537a3df900dSMatthew G Knepley ierr = PetscObjectReference((PetscObject) jac->schur_user);CHKERRQ(ierr); 538a3df900dSMatthew G Knepley } 539a3df900dSMatthew G Knepley } else { 5403a062f41SBarry Smith const char *prefix; 5417dae84e0SHong Zhang ierr = MatCreateSubMatrix(pc->pmat,ilink->is,ilink->is_col,MAT_INITIAL_MATRIX,&jac->pmat[i]);CHKERRQ(ierr); 5423a062f41SBarry Smith ierr = KSPGetOptionsPrefix(ilink->ksp,&prefix);CHKERRQ(ierr); 5433a062f41SBarry Smith ierr = MatSetOptionsPrefix(jac->pmat[i],prefix);CHKERRQ(ierr); 5443a062f41SBarry Smith ierr = MatViewFromOptions(jac->pmat[i],NULL,"-mat_view");CHKERRQ(ierr); 545a3df900dSMatthew G Knepley } 546bdddcaaaSMatthew G Knepley /* create work vectors for each split */ 5472a7a6963SBarry Smith ierr = MatCreateVecs(jac->pmat[i],&jac->x[i],&jac->y[i]);CHKERRQ(ierr); 5480298fd71SBarry Smith ilink->x = jac->x[i]; ilink->y = jac->y[i]; ilink->z = NULL; 549bdddcaaaSMatthew G Knepley /* compute scatter contexts needed by multiplicative versions and non-default splits */ 5500298fd71SBarry Smith ierr = VecScatterCreate(xtmp,ilink->is,jac->x[i],NULL,&ilink->sctx);CHKERRQ(ierr); 551ed1f0337SMatthew G Knepley ierr = PetscObjectQuery((PetscObject) ilink->is, "nearnullspace", (PetscObject*) &sp);CHKERRQ(ierr); 552ed1f0337SMatthew G Knepley if (sp) { 553ed1f0337SMatthew G Knepley ierr = MatSetNearNullSpace(jac->pmat[i], sp);CHKERRQ(ierr); 554ed1f0337SMatthew G Knepley } 555704ba839SBarry Smith ilink = ilink->next; 556cf502942SBarry Smith } 557bdddcaaaSMatthew G Knepley ierr = VecDestroy(&xtmp);CHKERRQ(ierr); 55897bbdb24SBarry Smith } else { 559ef7efd37SHong Zhang MatReuse scall; 560ef7efd37SHong Zhang if (pc->flag == DIFFERENT_NONZERO_PATTERN) { 561ef7efd37SHong Zhang for (i=0; i<nsplit; i++) { 562ef7efd37SHong Zhang ierr = MatDestroy(&jac->pmat[i]);CHKERRQ(ierr); 563ef7efd37SHong Zhang } 564ef7efd37SHong Zhang scall = MAT_INITIAL_MATRIX; 565ef7efd37SHong Zhang } else scall = MAT_REUSE_MATRIX; 566ef7efd37SHong Zhang 567cf502942SBarry Smith for (i=0; i<nsplit; i++) { 568a3df900dSMatthew G Knepley Mat pmat; 569a3df900dSMatthew G Knepley 570a3df900dSMatthew G Knepley /* Check for preconditioning matrix attached to IS */ 571a3df900dSMatthew G Knepley ierr = PetscObjectQuery((PetscObject) ilink->is, "pmat", (PetscObject*) &pmat);CHKERRQ(ierr); 572a3df900dSMatthew G Knepley if (!pmat) { 573ef7efd37SHong Zhang ierr = MatCreateSubMatrix(pc->pmat,ilink->is,ilink->is_col,scall,&jac->pmat[i]);CHKERRQ(ierr); 574a3df900dSMatthew G Knepley } 575704ba839SBarry Smith ilink = ilink->next; 576cf502942SBarry Smith } 57797bbdb24SBarry Smith } 5784e39094bSDmitry Karpeev if (jac->diag_use_amat) { 579519d70e2SJed Brown ilink = jac->head; 580519d70e2SJed Brown if (!jac->mat) { 581785e854fSJed Brown ierr = PetscMalloc1(nsplit,&jac->mat);CHKERRQ(ierr); 582519d70e2SJed Brown for (i=0; i<nsplit; i++) { 5837dae84e0SHong Zhang ierr = MatCreateSubMatrix(pc->mat,ilink->is,ilink->is_col,MAT_INITIAL_MATRIX,&jac->mat[i]);CHKERRQ(ierr); 584519d70e2SJed Brown ilink = ilink->next; 585519d70e2SJed Brown } 586519d70e2SJed Brown } else { 587ef7efd37SHong Zhang MatReuse scall; 588ef7efd37SHong Zhang if (pc->flag == DIFFERENT_NONZERO_PATTERN) { 589519d70e2SJed Brown for (i=0; i<nsplit; i++) { 590ef7efd37SHong Zhang ierr = MatDestroy(&jac->mat[i]);CHKERRQ(ierr); 591ef7efd37SHong Zhang } 592ef7efd37SHong Zhang scall = MAT_INITIAL_MATRIX; 593ef7efd37SHong Zhang } else scall = MAT_REUSE_MATRIX; 594ef7efd37SHong Zhang 595ef7efd37SHong Zhang for (i=0; i<nsplit; i++) { 596ef7efd37SHong Zhang if (jac->mat[i]) {ierr = MatCreateSubMatrix(pc->mat,ilink->is,ilink->is_col,scall,&jac->mat[i]);CHKERRQ(ierr);} 597519d70e2SJed Brown ilink = ilink->next; 598519d70e2SJed Brown } 599519d70e2SJed Brown } 600519d70e2SJed Brown } else { 601519d70e2SJed Brown jac->mat = jac->pmat; 602519d70e2SJed Brown } 60397bbdb24SBarry Smith 60453935eafSBarry Smith /* Check for null space attached to IS */ 60553935eafSBarry Smith ilink = jac->head; 60653935eafSBarry Smith for (i=0; i<nsplit; i++) { 60753935eafSBarry Smith MatNullSpace sp; 60853935eafSBarry Smith 60953935eafSBarry Smith ierr = PetscObjectQuery((PetscObject) ilink->is, "nullspace", (PetscObject*) &sp);CHKERRQ(ierr); 61053935eafSBarry Smith if (sp) { 61153935eafSBarry Smith ierr = MatSetNullSpace(jac->mat[i], sp);CHKERRQ(ierr); 61253935eafSBarry Smith } 61353935eafSBarry Smith ilink = ilink->next; 61453935eafSBarry Smith } 61553935eafSBarry Smith 6166c8605c2SJed Brown if (jac->type != PC_COMPOSITE_ADDITIVE && jac->type != PC_COMPOSITE_SCHUR) { 61768dd23aaSBarry Smith /* extract the rows of the matrix associated with each field: used for efficient computation of residual inside algorithm */ 6184e39094bSDmitry Karpeev /* FIXME: Can/should we reuse jac->mat whenever (jac->diag_use_amat) is true? */ 61968dd23aaSBarry Smith ilink = jac->head; 620e52d2c62SBarry Smith if (nsplit == 2 && jac->type == PC_COMPOSITE_MULTIPLICATIVE) { 621e52d2c62SBarry 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 */ 622e52d2c62SBarry Smith if (!jac->Afield) { 623e52d2c62SBarry Smith ierr = PetscCalloc1(nsplit,&jac->Afield);CHKERRQ(ierr); 62480c96bb1SFande Kong if (jac->offdiag_use_amat) { 6257dae84e0SHong Zhang ierr = MatCreateSubMatrix(pc->mat,ilink->next->is,ilink->is,MAT_INITIAL_MATRIX,&jac->Afield[1]);CHKERRQ(ierr); 626e52d2c62SBarry Smith } else { 6277dae84e0SHong Zhang ierr = MatCreateSubMatrix(pc->pmat,ilink->next->is,ilink->is,MAT_INITIAL_MATRIX,&jac->Afield[1]);CHKERRQ(ierr); 62880c96bb1SFande Kong } 62980c96bb1SFande Kong } else { 630ef7efd37SHong Zhang MatReuse scall; 631ef7efd37SHong Zhang if (pc->flag == DIFFERENT_NONZERO_PATTERN) { 632ef7efd37SHong Zhang for (i=0; i<nsplit; i++) { 633ef7efd37SHong Zhang ierr = MatDestroy(&jac->Afield[1]);CHKERRQ(ierr); 634ef7efd37SHong Zhang } 635ef7efd37SHong Zhang scall = MAT_INITIAL_MATRIX; 636ef7efd37SHong Zhang } else scall = MAT_REUSE_MATRIX; 637ef7efd37SHong Zhang 63880c96bb1SFande Kong if (jac->offdiag_use_amat) { 639ef7efd37SHong Zhang ierr = MatCreateSubMatrix(pc->mat,ilink->next->is,ilink->is,scall,&jac->Afield[1]);CHKERRQ(ierr); 64080c96bb1SFande Kong } else { 641ef7efd37SHong Zhang ierr = MatCreateSubMatrix(pc->pmat,ilink->next->is,ilink->is,scall,&jac->Afield[1]);CHKERRQ(ierr); 64280c96bb1SFande Kong } 643e52d2c62SBarry Smith } 644e52d2c62SBarry Smith } else { 64568dd23aaSBarry Smith if (!jac->Afield) { 646785e854fSJed Brown ierr = PetscMalloc1(nsplit,&jac->Afield);CHKERRQ(ierr); 64768dd23aaSBarry Smith for (i=0; i<nsplit; i++) { 64880c96bb1SFande Kong if (jac->offdiag_use_amat) { 6497dae84e0SHong Zhang ierr = MatCreateSubMatrix(pc->mat,ilink->is,NULL,MAT_INITIAL_MATRIX,&jac->Afield[i]);CHKERRQ(ierr); 65080c96bb1SFande Kong } else { 6517dae84e0SHong Zhang ierr = MatCreateSubMatrix(pc->pmat,ilink->is,NULL,MAT_INITIAL_MATRIX,&jac->Afield[i]);CHKERRQ(ierr); 65280c96bb1SFande Kong } 65368dd23aaSBarry Smith ilink = ilink->next; 65468dd23aaSBarry Smith } 65568dd23aaSBarry Smith } else { 656ef7efd37SHong Zhang MatReuse scall; 657ef7efd37SHong Zhang if (pc->flag == DIFFERENT_NONZERO_PATTERN) { 658ef7efd37SHong Zhang for (i=0; i<nsplit; i++) { 659ef7efd37SHong Zhang ierr = MatDestroy(&jac->Afield[i]);CHKERRQ(ierr); 660ef7efd37SHong Zhang } 661ef7efd37SHong Zhang scall = MAT_INITIAL_MATRIX; 662ef7efd37SHong Zhang } else scall = MAT_REUSE_MATRIX; 663ef7efd37SHong Zhang 66468dd23aaSBarry Smith for (i=0; i<nsplit; i++) { 66580c96bb1SFande Kong if (jac->offdiag_use_amat) { 666ef7efd37SHong Zhang ierr = MatCreateSubMatrix(pc->mat,ilink->is,NULL,scall,&jac->Afield[i]);CHKERRQ(ierr); 66780c96bb1SFande Kong } else { 668ef7efd37SHong Zhang ierr = MatCreateSubMatrix(pc->pmat,ilink->is,NULL,scall,&jac->Afield[i]);CHKERRQ(ierr); 66980c96bb1SFande Kong } 67068dd23aaSBarry Smith ilink = ilink->next; 67168dd23aaSBarry Smith } 67268dd23aaSBarry Smith } 67368dd23aaSBarry Smith } 674e52d2c62SBarry Smith } 67568dd23aaSBarry Smith 6763b224e63SBarry Smith if (jac->type == PC_COMPOSITE_SCHUR) { 6773b224e63SBarry Smith IS ccis; 678c096484dSStefano Zampini PetscBool isspd; 6794aa3045dSJed Brown PetscInt rstart,rend; 680093c86ffSJed Brown char lscname[256]; 681093c86ffSJed Brown PetscObject LSC_L; 682ce94432eSBarry Smith 683ce94432eSBarry Smith if (nsplit != 2) SETERRQ(PetscObjectComm((PetscObject)pc),PETSC_ERR_ARG_INCOMP,"To use Schur complement preconditioner you must have exactly 2 fields"); 68468dd23aaSBarry Smith 685c096484dSStefano Zampini /* If pc->mat is SPD, don't scale by -1 the Schur complement */ 686c096484dSStefano Zampini if (jac->schurscale == (PetscScalar)-1.0) { 687c096484dSStefano Zampini ierr = MatGetOption(pc->pmat,MAT_SPD,&isspd);CHKERRQ(ierr); 688c096484dSStefano Zampini jac->schurscale = (isspd == PETSC_TRUE) ? 1.0 : -1.0; 689c096484dSStefano Zampini } 690c096484dSStefano Zampini 691e6cab6aaSJed Brown /* When extracting off-diagonal submatrices, we take complements from this range */ 692e6cab6aaSJed Brown ierr = MatGetOwnershipRangeColumn(pc->mat,&rstart,&rend);CHKERRQ(ierr); 693e6cab6aaSJed Brown 6943b224e63SBarry Smith /* need to handle case when one is resetting up the preconditioner */ 6953b224e63SBarry Smith if (jac->schur) { 6960298fd71SBarry Smith KSP kspA = jac->head->ksp, kspInner = NULL, kspUpper = jac->kspupper; 697443836d0SMatthew G Knepley 698fb3147dbSMatthew G Knepley ierr = MatSchurComplementGetKSP(jac->schur, &kspInner);CHKERRQ(ierr); 6993b224e63SBarry Smith ilink = jac->head; 70049bb4cd7SJungho Lee ierr = ISComplement(ilink->is_col,rstart,rend,&ccis);CHKERRQ(ierr); 7014e39094bSDmitry Karpeev if (jac->offdiag_use_amat) { 7027dae84e0SHong Zhang ierr = MatCreateSubMatrix(pc->mat,ilink->is,ccis,MAT_REUSE_MATRIX,&jac->B);CHKERRQ(ierr); 703c84da90fSDmitry Karpeev } else { 7047dae84e0SHong Zhang ierr = MatCreateSubMatrix(pc->pmat,ilink->is,ccis,MAT_REUSE_MATRIX,&jac->B);CHKERRQ(ierr); 705c84da90fSDmitry Karpeev } 706fcfd50ebSBarry Smith ierr = ISDestroy(&ccis);CHKERRQ(ierr); 7073b224e63SBarry Smith ilink = ilink->next; 70849bb4cd7SJungho Lee ierr = ISComplement(ilink->is_col,rstart,rend,&ccis);CHKERRQ(ierr); 7094e39094bSDmitry Karpeev if (jac->offdiag_use_amat) { 7107dae84e0SHong Zhang ierr = MatCreateSubMatrix(pc->mat,ilink->is,ccis,MAT_REUSE_MATRIX,&jac->C);CHKERRQ(ierr); 711c84da90fSDmitry Karpeev } else { 7127dae84e0SHong Zhang ierr = MatCreateSubMatrix(pc->pmat,ilink->is,ccis,MAT_REUSE_MATRIX,&jac->C);CHKERRQ(ierr); 713c84da90fSDmitry Karpeev } 714fcfd50ebSBarry Smith ierr = ISDestroy(&ccis);CHKERRQ(ierr); 715aa6c7ce3SBarry Smith ierr = MatSchurComplementUpdateSubMatrices(jac->schur,jac->mat[0],jac->pmat[0],jac->B,jac->C,jac->mat[1]);CHKERRQ(ierr); 716a7476a74SDmitry Karpeev if (jac->schurpre == PC_FIELDSPLIT_SCHUR_PRE_SELFP) { 717a7476a74SDmitry Karpeev ierr = MatDestroy(&jac->schurp);CHKERRQ(ierr); 718a7476a74SDmitry Karpeev ierr = MatSchurComplementGetPmat(jac->schur,MAT_INITIAL_MATRIX,&jac->schurp);CHKERRQ(ierr); 719a7476a74SDmitry Karpeev } 720443836d0SMatthew G Knepley if (kspA != kspInner) { 72123ee1639SBarry Smith ierr = KSPSetOperators(kspA,jac->mat[0],jac->pmat[0]);CHKERRQ(ierr); 722443836d0SMatthew G Knepley } 723443836d0SMatthew G Knepley if (kspUpper != kspA) { 72423ee1639SBarry Smith ierr = KSPSetOperators(kspUpper,jac->mat[0],jac->pmat[0]);CHKERRQ(ierr); 725443836d0SMatthew G Knepley } 72623ee1639SBarry Smith ierr = KSPSetOperators(jac->kspschur,jac->schur,FieldSplitSchurPre(jac));CHKERRQ(ierr); 7273b224e63SBarry Smith } else { 728bafc1b83SMatthew G Knepley const char *Dprefix; 729470b340bSDmitry Karpeev char schurprefix[256], schurmatprefix[256]; 730514bf10dSMatthew G Knepley char schurtestoption[256]; 731bdddcaaaSMatthew G Knepley MatNullSpace sp; 732514bf10dSMatthew G Knepley PetscBool flg; 733686bed4dSStefano Zampini KSP kspt; 7343b224e63SBarry Smith 735a04f6461SBarry Smith /* extract the A01 and A10 matrices */ 7363b224e63SBarry Smith ilink = jac->head; 73749bb4cd7SJungho Lee ierr = ISComplement(ilink->is_col,rstart,rend,&ccis);CHKERRQ(ierr); 7384e39094bSDmitry Karpeev if (jac->offdiag_use_amat) { 7397dae84e0SHong Zhang ierr = MatCreateSubMatrix(pc->mat,ilink->is,ccis,MAT_INITIAL_MATRIX,&jac->B);CHKERRQ(ierr); 740c84da90fSDmitry Karpeev } else { 7417dae84e0SHong Zhang ierr = MatCreateSubMatrix(pc->pmat,ilink->is,ccis,MAT_INITIAL_MATRIX,&jac->B);CHKERRQ(ierr); 742c84da90fSDmitry Karpeev } 743fcfd50ebSBarry Smith ierr = ISDestroy(&ccis);CHKERRQ(ierr); 7443b224e63SBarry Smith ilink = ilink->next; 74549bb4cd7SJungho Lee ierr = ISComplement(ilink->is_col,rstart,rend,&ccis);CHKERRQ(ierr); 7464e39094bSDmitry Karpeev if (jac->offdiag_use_amat) { 7477dae84e0SHong Zhang ierr = MatCreateSubMatrix(pc->mat,ilink->is,ccis,MAT_INITIAL_MATRIX,&jac->C);CHKERRQ(ierr); 748c84da90fSDmitry Karpeev } else { 7497dae84e0SHong Zhang ierr = MatCreateSubMatrix(pc->pmat,ilink->is,ccis,MAT_INITIAL_MATRIX,&jac->C);CHKERRQ(ierr); 750c84da90fSDmitry Karpeev } 751fcfd50ebSBarry Smith ierr = ISDestroy(&ccis);CHKERRQ(ierr); 75220252d06SBarry Smith 753f5236f50SJed Brown /* Use mat[0] (diagonal block of Amat) preconditioned by pmat[0] to define Schur complement */ 75420252d06SBarry Smith ierr = MatCreate(((PetscObject)jac->mat[0])->comm,&jac->schur);CHKERRQ(ierr); 75520252d06SBarry Smith ierr = MatSetType(jac->schur,MATSCHURCOMPLEMENT);CHKERRQ(ierr); 756bee83525SDmitry Karpeev ierr = MatSchurComplementSetSubMatrices(jac->schur,jac->mat[0],jac->pmat[0],jac->B,jac->C,jac->mat[1]);CHKERRQ(ierr); 757470b340bSDmitry Karpeev ierr = PetscSNPrintf(schurmatprefix, sizeof(schurmatprefix), "%sfieldsplit_%s_", ((PetscObject)pc)->prefix ? ((PetscObject)pc)->prefix : "", ilink->splitname);CHKERRQ(ierr); 758470b340bSDmitry Karpeev ierr = MatSetOptionsPrefix(jac->schur,schurmatprefix);CHKERRQ(ierr); 759686bed4dSStefano Zampini ierr = MatSchurComplementGetKSP(jac->schur,&kspt);CHKERRQ(ierr); 760686bed4dSStefano Zampini ierr = KSPSetOptionsPrefix(kspt,schurmatprefix);CHKERRQ(ierr); 761686bed4dSStefano Zampini 762686bed4dSStefano Zampini /* Note: this is not true in general */ 763895c21f2SBarry Smith ierr = MatGetNullSpace(jac->mat[1], &sp);CHKERRQ(ierr); 76420252d06SBarry Smith if (sp) { 76520252d06SBarry Smith ierr = MatSetNullSpace(jac->schur, sp);CHKERRQ(ierr); 76620252d06SBarry Smith } 76720252d06SBarry Smith 76820252d06SBarry Smith ierr = PetscSNPrintf(schurtestoption, sizeof(schurtestoption), "-fieldsplit_%s_inner_", ilink->splitname);CHKERRQ(ierr); 769c5929fdfSBarry Smith ierr = PetscOptionsFindPairPrefix_Private(((PetscObject)pc)->options,((PetscObject)pc)->prefix, schurtestoption, NULL, &flg);CHKERRQ(ierr); 770514bf10dSMatthew G Knepley if (flg) { 771514bf10dSMatthew G Knepley DM dmInner; 77221635b76SJed Brown KSP kspInner; 773686bed4dSStefano Zampini PC pcInner; 77421635b76SJed Brown 77521635b76SJed Brown ierr = MatSchurComplementGetKSP(jac->schur, &kspInner);CHKERRQ(ierr); 77621635b76SJed Brown ierr = PetscSNPrintf(schurprefix, sizeof(schurprefix), "%sfieldsplit_%s_inner_", ((PetscObject)pc)->prefix ? ((PetscObject)pc)->prefix : "", ilink->splitname);CHKERRQ(ierr); 77721635b76SJed Brown /* Indent this deeper to emphasize the "inner" nature of this solver. */ 77821635b76SJed Brown ierr = PetscObjectIncrementTabLevel((PetscObject)kspInner, (PetscObject) pc, 2);CHKERRQ(ierr); 77921635b76SJed Brown ierr = KSPSetOptionsPrefix(kspInner, schurprefix);CHKERRQ(ierr); 780514bf10dSMatthew G Knepley 781514bf10dSMatthew G Knepley /* Set DM for new solver */ 782bafc1b83SMatthew G Knepley ierr = KSPGetDM(jac->head->ksp, &dmInner);CHKERRQ(ierr); 78321635b76SJed Brown ierr = KSPSetDM(kspInner, dmInner);CHKERRQ(ierr); 78421635b76SJed Brown ierr = KSPSetDMActive(kspInner, PETSC_FALSE);CHKERRQ(ierr); 785686bed4dSStefano Zampini 786686bed4dSStefano Zampini /* Defaults to PCKSP as preconditioner */ 787686bed4dSStefano Zampini ierr = KSPGetPC(kspInner, &pcInner);CHKERRQ(ierr); 788686bed4dSStefano Zampini ierr = PCSetType(pcInner, PCKSP);CHKERRQ(ierr); 789686bed4dSStefano Zampini ierr = PCKSPSetKSP(pcInner, jac->head->ksp);CHKERRQ(ierr); 790514bf10dSMatthew G Knepley } else { 79121635b76SJed Brown /* Use the outer solver for the inner solve, but revert the KSPPREONLY from PCFieldSplitSetFields_FieldSplit or 79221635b76SJed Brown * PCFieldSplitSetIS_FieldSplit. We don't want KSPPREONLY because it makes the Schur complement inexact, 79321635b76SJed Brown * preventing Schur complement reduction to be an accurate solve. Usually when an iterative solver is used for 79421635b76SJed 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 79521635b76SJed Brown * GMRES the default. Note that it is also common to use PREONLY for S, in which case S may not be used 79621635b76SJed Brown * directly, and the user is responsible for setting an inexact method for fieldsplit's A^{-1}. */ 79721635b76SJed Brown ierr = KSPSetType(jac->head->ksp,KSPGMRES);CHKERRQ(ierr); 798514bf10dSMatthew G Knepley ierr = MatSchurComplementSetKSP(jac->schur,jac->head->ksp);CHKERRQ(ierr); 799bafc1b83SMatthew G Knepley } 80023ee1639SBarry Smith ierr = KSPSetOperators(jac->head->ksp,jac->mat[0],jac->pmat[0]);CHKERRQ(ierr); 8015a9f2f41SSatish Balay ierr = KSPSetFromOptions(jac->head->ksp);CHKERRQ(ierr); 80297bbdb24SBarry Smith ierr = MatSetFromOptions(jac->schur);CHKERRQ(ierr); 80397bbdb24SBarry Smith 804686bed4dSStefano Zampini ierr = PetscObjectTypeCompare((PetscObject)jac->schur, MATSCHURCOMPLEMENT, &flg);CHKERRQ(ierr); 805686bed4dSStefano Zampini if (flg) { /* Need to do this otherwise PCSetUp_KSP will overwrite the amat of jac->head->ksp */ 806686bed4dSStefano Zampini KSP kspInner; 807686bed4dSStefano Zampini PC pcInner; 808686bed4dSStefano Zampini 809686bed4dSStefano Zampini ierr = MatSchurComplementGetKSP(jac->schur, &kspInner);CHKERRQ(ierr); 810686bed4dSStefano Zampini ierr = KSPGetPC(kspInner, &pcInner);CHKERRQ(ierr); 811686bed4dSStefano Zampini ierr = PetscObjectTypeCompare((PetscObject)pcInner, PCKSP, &flg);CHKERRQ(ierr); 812686bed4dSStefano Zampini if (flg) { 813686bed4dSStefano Zampini KSP ksp; 814686bed4dSStefano Zampini 815686bed4dSStefano Zampini ierr = PCKSPGetKSP(pcInner, &ksp);CHKERRQ(ierr); 816686bed4dSStefano Zampini if (ksp == jac->head->ksp) { 817686bed4dSStefano Zampini ierr = PCSetUseAmat(pcInner, PETSC_TRUE);CHKERRQ(ierr); 818686bed4dSStefano Zampini } 819686bed4dSStefano Zampini } 820686bed4dSStefano Zampini } 821443836d0SMatthew G Knepley ierr = PetscSNPrintf(schurtestoption, sizeof(schurtestoption), "-fieldsplit_%s_upper_", ilink->splitname);CHKERRQ(ierr); 822c5929fdfSBarry Smith ierr = PetscOptionsFindPairPrefix_Private(((PetscObject)pc)->options,((PetscObject)pc)->prefix, schurtestoption, NULL, &flg);CHKERRQ(ierr); 823443836d0SMatthew G Knepley if (flg) { 824443836d0SMatthew G Knepley DM dmInner; 825443836d0SMatthew G Knepley 826443836d0SMatthew G Knepley ierr = PetscSNPrintf(schurprefix, sizeof(schurprefix), "%sfieldsplit_%s_upper_", ((PetscObject)pc)->prefix ? ((PetscObject)pc)->prefix : "", ilink->splitname);CHKERRQ(ierr); 82782f516ccSBarry Smith ierr = KSPCreate(PetscObjectComm((PetscObject)pc), &jac->kspupper);CHKERRQ(ierr); 828422a814eSBarry Smith ierr = KSPSetErrorIfNotConverged(jac->kspupper,pc->erroriffailure);CHKERRQ(ierr); 829443836d0SMatthew G Knepley ierr = KSPSetOptionsPrefix(jac->kspupper, schurprefix);CHKERRQ(ierr); 830443836d0SMatthew G Knepley ierr = KSPGetDM(jac->head->ksp, &dmInner);CHKERRQ(ierr); 831443836d0SMatthew G Knepley ierr = KSPSetDM(jac->kspupper, dmInner);CHKERRQ(ierr); 832443836d0SMatthew G Knepley ierr = KSPSetDMActive(jac->kspupper, PETSC_FALSE);CHKERRQ(ierr); 833443836d0SMatthew G Knepley ierr = KSPSetFromOptions(jac->kspupper);CHKERRQ(ierr); 83423ee1639SBarry Smith ierr = KSPSetOperators(jac->kspupper,jac->mat[0],jac->pmat[0]);CHKERRQ(ierr); 835443836d0SMatthew G Knepley ierr = VecDuplicate(jac->head->x, &jac->head->z);CHKERRQ(ierr); 836443836d0SMatthew G Knepley } else { 837443836d0SMatthew G Knepley jac->kspupper = jac->head->ksp; 838443836d0SMatthew G Knepley ierr = PetscObjectReference((PetscObject) jac->head->ksp);CHKERRQ(ierr); 839443836d0SMatthew G Knepley } 840443836d0SMatthew G Knepley 841a7476a74SDmitry Karpeev if (jac->schurpre == PC_FIELDSPLIT_SCHUR_PRE_SELFP) { 842a7476a74SDmitry Karpeev ierr = MatSchurComplementGetPmat(jac->schur,MAT_INITIAL_MATRIX,&jac->schurp);CHKERRQ(ierr); 843a7476a74SDmitry Karpeev } 844ce94432eSBarry Smith ierr = KSPCreate(PetscObjectComm((PetscObject)pc),&jac->kspschur);CHKERRQ(ierr); 845422a814eSBarry Smith ierr = KSPSetErrorIfNotConverged(jac->kspschur,pc->erroriffailure);CHKERRQ(ierr); 84697bbdb24SBarry Smith ierr = PetscLogObjectParent((PetscObject)pc,(PetscObject)jac->kspschur);CHKERRQ(ierr); 84720252d06SBarry Smith ierr = PetscObjectIncrementTabLevel((PetscObject)jac->kspschur,(PetscObject)pc,1);CHKERRQ(ierr); 84897bbdb24SBarry Smith if (jac->schurpre == PC_FIELDSPLIT_SCHUR_PRE_SELF) { 8497233a360SDmitry Karpeev PC pcschur; 8507233a360SDmitry Karpeev ierr = KSPGetPC(jac->kspschur,&pcschur);CHKERRQ(ierr); 8517233a360SDmitry Karpeev ierr = PCSetType(pcschur,PCNONE);CHKERRQ(ierr); 85297bbdb24SBarry Smith /* Note: This is bad if there exist preconditioners for MATSCHURCOMPLEMENT */ 853e74569cdSMatthew G. Knepley } else if (jac->schurpre == PC_FIELDSPLIT_SCHUR_PRE_FULL) { 854e74569cdSMatthew G. Knepley ierr = MatSchurComplementComputeExplicitOperator(jac->schur, &jac->schur_user);CHKERRQ(ierr); 85597bbdb24SBarry Smith } 85623ee1639SBarry Smith ierr = KSPSetOperators(jac->kspschur,jac->schur,FieldSplitSchurPre(jac));CHKERRQ(ierr); 85797bbdb24SBarry Smith ierr = KSPGetOptionsPrefix(jac->head->next->ksp, &Dprefix);CHKERRQ(ierr); 85897bbdb24SBarry Smith ierr = KSPSetOptionsPrefix(jac->kspschur, Dprefix);CHKERRQ(ierr); 859c096484dSStefano Zampini /* propagate DM */ 860b20b4189SMatthew G. Knepley { 861b20b4189SMatthew G. Knepley DM sdm; 862b20b4189SMatthew G. Knepley ierr = KSPGetDM(jac->head->next->ksp, &sdm);CHKERRQ(ierr); 863b20b4189SMatthew G. Knepley if (sdm) { 864b20b4189SMatthew G. Knepley ierr = KSPSetDM(jac->kspschur, sdm);CHKERRQ(ierr); 865b20b4189SMatthew G. Knepley ierr = KSPSetDMActive(jac->kspschur, PETSC_FALSE);CHKERRQ(ierr); 866b20b4189SMatthew G. Knepley } 867b20b4189SMatthew G. Knepley } 86897bbdb24SBarry Smith /* really want setfromoptions called in PCSetFromOptions_FieldSplit(), but it is not ready yet */ 86997bbdb24SBarry Smith /* need to call this every time, since the jac->kspschur is freshly created, otherwise its options never get set */ 87097bbdb24SBarry Smith ierr = KSPSetFromOptions(jac->kspschur);CHKERRQ(ierr); 87197bbdb24SBarry Smith } 872686bed4dSStefano Zampini ierr = MatAssemblyBegin(jac->schur,MAT_FINAL_ASSEMBLY);CHKERRQ(ierr); 873686bed4dSStefano Zampini ierr = MatAssemblyEnd(jac->schur,MAT_FINAL_ASSEMBLY);CHKERRQ(ierr); 87497bbdb24SBarry Smith 8755a9f2f41SSatish Balay /* HACK: special support to forward L and Lp matrices that might be used by PCLSC */ 8768caf3d72SBarry Smith ierr = PetscSNPrintf(lscname,sizeof(lscname),"%s_LSC_L",ilink->splitname);CHKERRQ(ierr); 877519d70e2SJed Brown ierr = PetscObjectQuery((PetscObject)pc->mat,lscname,(PetscObject*)&LSC_L);CHKERRQ(ierr); 8783b224e63SBarry Smith if (!LSC_L) {ierr = PetscObjectQuery((PetscObject)pc->pmat,lscname,(PetscObject*)&LSC_L);CHKERRQ(ierr);} 879c1570756SJed Brown if (LSC_L) {ierr = PetscObjectCompose((PetscObject)jac->schur,"LSC_L",(PetscObject)LSC_L);CHKERRQ(ierr);} 8808caf3d72SBarry Smith ierr = PetscSNPrintf(lscname,sizeof(lscname),"%s_LSC_Lp",ilink->splitname);CHKERRQ(ierr); 88197bbdb24SBarry Smith ierr = PetscObjectQuery((PetscObject)pc->pmat,lscname,(PetscObject*)&LSC_L);CHKERRQ(ierr); 8825a9f2f41SSatish Balay if (!LSC_L) {ierr = PetscObjectQuery((PetscObject)pc->mat,lscname,(PetscObject*)&LSC_L);CHKERRQ(ierr);} 8830971522cSBarry Smith if (LSC_L) {ierr = PetscObjectCompose((PetscObject)jac->schur,"LSC_Lp",(PetscObject)LSC_L);CHKERRQ(ierr);} 88497bbdb24SBarry Smith } else { 88568bd789dSDmitry Karpeev /* set up the individual splits' PCs */ 8860971522cSBarry Smith i = 0; 8870971522cSBarry Smith ilink = jac->head; 8880971522cSBarry Smith while (ilink) { 88923ee1639SBarry Smith ierr = KSPSetOperators(ilink->ksp,jac->mat[i],jac->pmat[i]);CHKERRQ(ierr); 8900971522cSBarry Smith /* really want setfromoptions called in PCSetFromOptions_FieldSplit(), but it is not ready yet */ 8910971522cSBarry Smith if (!jac->suboptionsset) {ierr = KSPSetFromOptions(ilink->ksp);CHKERRQ(ierr);} 8920971522cSBarry Smith i++; 8930971522cSBarry Smith ilink = ilink->next; 8940971522cSBarry Smith } 8953b224e63SBarry Smith } 8963b224e63SBarry Smith 897c1570756SJed Brown jac->suboptionsset = PETSC_TRUE; 8980971522cSBarry Smith PetscFunctionReturn(0); 8990971522cSBarry Smith } 9000971522cSBarry Smith 9015a9f2f41SSatish Balay #define FieldSplitSplitSolveAdd(ilink,xx,yy) \ 902ca9f406cSSatish Balay (VecScatterBegin(ilink->sctx,xx,ilink->x,INSERT_VALUES,SCATTER_FORWARD) || \ 903ca9f406cSSatish Balay VecScatterEnd(ilink->sctx,xx,ilink->x,INSERT_VALUES,SCATTER_FORWARD) || \ 9049df09d43SBarry Smith PetscLogEventBegin(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL) ||\ 9055a9f2f41SSatish Balay KSPSolve(ilink->ksp,ilink->x,ilink->y) || \ 9069df09d43SBarry Smith PetscLogEventEnd(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL) ||\ 907ca9f406cSSatish Balay VecScatterBegin(ilink->sctx,ilink->y,yy,ADD_VALUES,SCATTER_REVERSE) || \ 908ca9f406cSSatish Balay VecScatterEnd(ilink->sctx,ilink->y,yy,ADD_VALUES,SCATTER_REVERSE)) 90979416396SBarry Smith 9103b224e63SBarry Smith static PetscErrorCode PCApply_FieldSplit_Schur(PC pc,Vec x,Vec y) 9113b224e63SBarry Smith { 9123b224e63SBarry Smith PC_FieldSplit *jac = (PC_FieldSplit*)pc->data; 9133b224e63SBarry Smith PetscErrorCode ierr; 9143b224e63SBarry Smith PC_FieldSplitLink ilinkA = jac->head, ilinkD = ilinkA->next; 915443836d0SMatthew G Knepley KSP kspA = ilinkA->ksp, kspLower = kspA, kspUpper = jac->kspupper; 9163b224e63SBarry Smith 9173b224e63SBarry Smith PetscFunctionBegin; 918c5d2311dSJed Brown switch (jac->schurfactorization) { 919c9c6ffaaSJed Brown case PC_FIELDSPLIT_SCHUR_FACT_DIAG: 920a04f6461SBarry Smith /* [A00 0; 0 -S], positive definite, suitable for MINRES */ 921c5d2311dSJed Brown ierr = VecScatterBegin(ilinkA->sctx,x,ilinkA->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr); 922c5d2311dSJed Brown ierr = VecScatterBegin(ilinkD->sctx,x,ilinkD->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr); 923c5d2311dSJed Brown ierr = VecScatterEnd(ilinkA->sctx,x,ilinkA->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr); 9249df09d43SBarry Smith ierr = PetscLogEventBegin(ilinkA->event,kspA,ilinkA->x,ilinkA->y,NULL);CHKERRQ(ierr); 925443836d0SMatthew G Knepley ierr = KSPSolve(kspA,ilinkA->x,ilinkA->y);CHKERRQ(ierr); 9269df09d43SBarry Smith ierr = PetscLogEventEnd(ilinkA->event,kspA,ilinkA->x,ilinkA->y,NULL);CHKERRQ(ierr); 927c5d2311dSJed Brown ierr = VecScatterBegin(ilinkA->sctx,ilinkA->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr); 928c5d2311dSJed Brown ierr = VecScatterEnd(ilinkD->sctx,x,ilinkD->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr); 9299df09d43SBarry Smith ierr = PetscLogEventBegin(KSP_Solve_FS_S,jac->kspschur,ilinkD->x,ilinkD->y,NULL);CHKERRQ(ierr); 930c5d2311dSJed Brown ierr = KSPSolve(jac->kspschur,ilinkD->x,ilinkD->y);CHKERRQ(ierr); 9319df09d43SBarry Smith ierr = PetscLogEventEnd(KSP_Solve_FS_S,jac->kspschur,ilinkD->x,ilinkD->y,NULL);CHKERRQ(ierr); 932c096484dSStefano Zampini ierr = VecScale(ilinkD->y,jac->schurscale);CHKERRQ(ierr); 933c5d2311dSJed Brown ierr = VecScatterBegin(ilinkD->sctx,ilinkD->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr); 934c5d2311dSJed Brown ierr = VecScatterEnd(ilinkA->sctx,ilinkA->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr); 935c5d2311dSJed Brown ierr = VecScatterEnd(ilinkD->sctx,ilinkD->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr); 936c5d2311dSJed Brown break; 937c9c6ffaaSJed Brown case PC_FIELDSPLIT_SCHUR_FACT_LOWER: 938a04f6461SBarry Smith /* [A00 0; A10 S], suitable for left preconditioning */ 939c5d2311dSJed Brown ierr = VecScatterBegin(ilinkA->sctx,x,ilinkA->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr); 940c5d2311dSJed Brown ierr = VecScatterEnd(ilinkA->sctx,x,ilinkA->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr); 9419df09d43SBarry Smith ierr = PetscLogEventBegin(ilinkA->event,kspA,ilinkA->x,ilinkA->y,NULL);CHKERRQ(ierr); 942443836d0SMatthew G Knepley ierr = KSPSolve(kspA,ilinkA->x,ilinkA->y);CHKERRQ(ierr); 9439df09d43SBarry Smith ierr = PetscLogEventEnd(ilinkA->event,kspA,ilinkA->x,ilinkA->y,NULL);CHKERRQ(ierr); 944c5d2311dSJed Brown ierr = MatMult(jac->C,ilinkA->y,ilinkD->x);CHKERRQ(ierr); 945c5d2311dSJed Brown ierr = VecScale(ilinkD->x,-1.);CHKERRQ(ierr); 946c5d2311dSJed Brown ierr = VecScatterBegin(ilinkD->sctx,x,ilinkD->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr); 947c5d2311dSJed Brown ierr = VecScatterBegin(ilinkA->sctx,ilinkA->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr); 948c5d2311dSJed Brown ierr = VecScatterEnd(ilinkD->sctx,x,ilinkD->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr); 9499df09d43SBarry Smith ierr = PetscLogEventBegin(KSP_Solve_FS_S,jac->kspschur,ilinkD->x,ilinkD->y,NULL);CHKERRQ(ierr); 950c5d2311dSJed Brown ierr = KSPSolve(jac->kspschur,ilinkD->x,ilinkD->y);CHKERRQ(ierr); 9519df09d43SBarry Smith ierr = PetscLogEventEnd(KSP_Solve_FS_S,jac->kspschur,ilinkD->x,ilinkD->y,NULL);CHKERRQ(ierr); 952c5d2311dSJed Brown ierr = VecScatterBegin(ilinkD->sctx,ilinkD->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr); 953c5d2311dSJed Brown ierr = VecScatterEnd(ilinkA->sctx,ilinkA->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr); 954c5d2311dSJed Brown ierr = VecScatterEnd(ilinkD->sctx,ilinkD->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr); 955c5d2311dSJed Brown break; 956c9c6ffaaSJed Brown case PC_FIELDSPLIT_SCHUR_FACT_UPPER: 957a04f6461SBarry Smith /* [A00 A01; 0 S], suitable for right preconditioning */ 958c5d2311dSJed Brown ierr = VecScatterBegin(ilinkD->sctx,x,ilinkD->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr); 959c5d2311dSJed Brown ierr = VecScatterEnd(ilinkD->sctx,x,ilinkD->x,INSERT_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); 9629df09d43SBarry 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); 963c5d2311dSJed Brown ierr = VecScale(ilinkA->x,-1.);CHKERRQ(ierr); 964c5d2311dSJed Brown ierr = VecScatterBegin(ilinkA->sctx,x,ilinkA->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr); 965c5d2311dSJed Brown ierr = VecScatterBegin(ilinkD->sctx,ilinkD->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr); 966c5d2311dSJed Brown ierr = VecScatterEnd(ilinkA->sctx,x,ilinkA->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr); 9679df09d43SBarry Smith ierr = PetscLogEventBegin(ilinkA->event,kspA,ilinkA->x,ilinkA->y,NULL);CHKERRQ(ierr); 968443836d0SMatthew G Knepley ierr = KSPSolve(kspA,ilinkA->x,ilinkA->y);CHKERRQ(ierr); 9699df09d43SBarry Smith ierr = PetscLogEventEnd(ilinkA->event,kspA,ilinkA->x,ilinkA->y,NULL);CHKERRQ(ierr); 970c5d2311dSJed Brown ierr = VecScatterBegin(ilinkA->sctx,ilinkA->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr); 971c5d2311dSJed Brown ierr = VecScatterEnd(ilinkD->sctx,ilinkD->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr); 972c5d2311dSJed Brown ierr = VecScatterEnd(ilinkA->sctx,ilinkA->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr); 973c5d2311dSJed Brown break; 974c9c6ffaaSJed Brown case PC_FIELDSPLIT_SCHUR_FACT_FULL: 975a04f6461SBarry 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 */ 9763b224e63SBarry Smith ierr = VecScatterBegin(ilinkA->sctx,x,ilinkA->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr); 9773b224e63SBarry Smith ierr = VecScatterEnd(ilinkA->sctx,x,ilinkA->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr); 9789df09d43SBarry Smith ierr = PetscLogEventBegin(KSP_Solve_FS_L,kspLower,ilinkA->x,ilinkA->y,NULL);CHKERRQ(ierr); 979443836d0SMatthew G Knepley ierr = KSPSolve(kspLower,ilinkA->x,ilinkA->y);CHKERRQ(ierr); 9809df09d43SBarry Smith ierr = PetscLogEventEnd(KSP_Solve_FS_L,kspLower,ilinkA->x,ilinkA->y,NULL);CHKERRQ(ierr); 9813b224e63SBarry Smith ierr = MatMult(jac->C,ilinkA->y,ilinkD->x);CHKERRQ(ierr); 9823b224e63SBarry Smith ierr = VecScale(ilinkD->x,-1.0);CHKERRQ(ierr); 9833b224e63SBarry Smith ierr = VecScatterBegin(ilinkD->sctx,x,ilinkD->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr); 9843b224e63SBarry Smith ierr = VecScatterEnd(ilinkD->sctx,x,ilinkD->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr); 9853b224e63SBarry Smith 9869df09d43SBarry Smith ierr = PetscLogEventBegin(KSP_Solve_FS_S,jac->kspschur,ilinkD->x,ilinkD->y,NULL);CHKERRQ(ierr); 9873b224e63SBarry Smith ierr = KSPSolve(jac->kspschur,ilinkD->x,ilinkD->y);CHKERRQ(ierr); 9889df09d43SBarry Smith ierr = PetscLogEventEnd(KSP_Solve_FS_S,jac->kspschur,ilinkD->x,ilinkD->y,NULL);CHKERRQ(ierr); 9893b224e63SBarry Smith ierr = VecScatterBegin(ilinkD->sctx,ilinkD->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr); 9903b224e63SBarry Smith ierr = VecScatterEnd(ilinkD->sctx,ilinkD->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr); 9913b224e63SBarry Smith 992443836d0SMatthew G Knepley if (kspUpper == kspA) { 9933b224e63SBarry Smith ierr = MatMult(jac->B,ilinkD->y,ilinkA->y);CHKERRQ(ierr); 9943b224e63SBarry Smith ierr = VecAXPY(ilinkA->x,-1.0,ilinkA->y);CHKERRQ(ierr); 9959df09d43SBarry Smith ierr = PetscLogEventBegin(ilinkA->event,kspA,ilinkA->x,ilinkA->y,NULL);CHKERRQ(ierr); 996443836d0SMatthew G Knepley ierr = KSPSolve(kspA,ilinkA->x,ilinkA->y);CHKERRQ(ierr); 9979df09d43SBarry Smith ierr = PetscLogEventEnd(ilinkA->event,kspA,ilinkA->x,ilinkA->y,NULL);CHKERRQ(ierr); 998443836d0SMatthew G Knepley } else { 9999df09d43SBarry Smith ierr = PetscLogEventBegin(ilinkA->event,kspA,ilinkA->x,ilinkA->y,NULL);CHKERRQ(ierr); 1000443836d0SMatthew G Knepley ierr = KSPSolve(kspA,ilinkA->x,ilinkA->y);CHKERRQ(ierr); 10019df09d43SBarry Smith ierr = PetscLogEventEnd(ilinkA->event,kspA,ilinkA->x,ilinkA->y,NULL);CHKERRQ(ierr); 1002443836d0SMatthew G Knepley ierr = MatMult(jac->B,ilinkD->y,ilinkA->x);CHKERRQ(ierr); 10039df09d43SBarry Smith ierr = PetscLogEventBegin(KSP_Solve_FS_U,kspUpper,ilinkA->x,ilinkA->z,NULL);CHKERRQ(ierr); 1004443836d0SMatthew G Knepley ierr = KSPSolve(kspUpper,ilinkA->x,ilinkA->z);CHKERRQ(ierr); 10059df09d43SBarry Smith ierr = PetscLogEventEnd(KSP_Solve_FS_U,kspUpper,ilinkA->x,ilinkA->z,NULL);CHKERRQ(ierr); 1006443836d0SMatthew G Knepley ierr = VecAXPY(ilinkA->y,-1.0,ilinkA->z);CHKERRQ(ierr); 1007443836d0SMatthew G Knepley } 10083b224e63SBarry Smith ierr = VecScatterBegin(ilinkA->sctx,ilinkA->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr); 10093b224e63SBarry Smith ierr = VecScatterEnd(ilinkA->sctx,ilinkA->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr); 1010c5d2311dSJed Brown } 10113b224e63SBarry Smith PetscFunctionReturn(0); 10123b224e63SBarry Smith } 10133b224e63SBarry Smith 10140971522cSBarry Smith static PetscErrorCode PCApply_FieldSplit(PC pc,Vec x,Vec y) 10150971522cSBarry Smith { 10160971522cSBarry Smith PC_FieldSplit *jac = (PC_FieldSplit*)pc->data; 10170971522cSBarry Smith PetscErrorCode ierr; 10185a9f2f41SSatish Balay PC_FieldSplitLink ilink = jac->head; 1019939b8a20SBarry Smith PetscInt cnt,bs; 1020568ed31eSHong Zhang KSPConvergedReason reason; 10210971522cSBarry Smith 10220971522cSBarry Smith PetscFunctionBegin; 102379416396SBarry Smith if (jac->type == PC_COMPOSITE_ADDITIVE) { 10241b9fc7fcSBarry Smith if (jac->defaultsplit) { 1025939b8a20SBarry Smith ierr = VecGetBlockSize(x,&bs);CHKERRQ(ierr); 1026ce94432eSBarry 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); 1027939b8a20SBarry Smith ierr = VecGetBlockSize(y,&bs);CHKERRQ(ierr); 1028ce94432eSBarry 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); 10290971522cSBarry Smith ierr = VecStrideGatherAll(x,jac->x,INSERT_VALUES);CHKERRQ(ierr); 10305a9f2f41SSatish Balay while (ilink) { 10319df09d43SBarry Smith ierr = PetscLogEventBegin(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL);CHKERRQ(ierr); 10325a9f2f41SSatish Balay ierr = KSPSolve(ilink->ksp,ilink->x,ilink->y);CHKERRQ(ierr); 10339df09d43SBarry Smith ierr = PetscLogEventEnd(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL);CHKERRQ(ierr); 1034568ed31eSHong Zhang ierr = KSPGetConvergedReason(ilink->ksp,&reason);CHKERRQ(ierr); 1035568ed31eSHong Zhang if (reason == KSP_DIVERGED_PCSETUP_FAILED) { 1036568ed31eSHong Zhang pc->failedreason = PC_SUBPC_ERROR; 1037568ed31eSHong Zhang } 10385a9f2f41SSatish Balay ilink = ilink->next; 10390971522cSBarry Smith } 10400971522cSBarry Smith ierr = VecStrideScatterAll(jac->y,y,INSERT_VALUES);CHKERRQ(ierr); 10411b9fc7fcSBarry Smith } else { 1042efb30889SBarry Smith ierr = VecSet(y,0.0);CHKERRQ(ierr); 10435a9f2f41SSatish Balay while (ilink) { 10445a9f2f41SSatish Balay ierr = FieldSplitSplitSolveAdd(ilink,x,y);CHKERRQ(ierr); 1045568ed31eSHong Zhang ierr = KSPGetConvergedReason(ilink->ksp,&reason);CHKERRQ(ierr); 1046568ed31eSHong Zhang if (reason == KSP_DIVERGED_PCSETUP_FAILED) { 1047568ed31eSHong Zhang pc->failedreason = PC_SUBPC_ERROR; 1048568ed31eSHong Zhang } 10495a9f2f41SSatish Balay ilink = ilink->next; 10501b9fc7fcSBarry Smith } 10511b9fc7fcSBarry Smith } 1052e52d2c62SBarry Smith } else if (jac->type == PC_COMPOSITE_MULTIPLICATIVE && jac->nsplits == 2) { 1053e52d2c62SBarry Smith ierr = VecSet(y,0.0);CHKERRQ(ierr); 1054e52d2c62SBarry Smith /* solve on first block for first block variables */ 1055e52d2c62SBarry Smith ierr = VecScatterBegin(ilink->sctx,x,ilink->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr); 1056e52d2c62SBarry Smith ierr = VecScatterEnd(ilink->sctx,x,ilink->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr); 10579df09d43SBarry Smith ierr = PetscLogEventBegin(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL);CHKERRQ(ierr); 1058e52d2c62SBarry Smith ierr = KSPSolve(ilink->ksp,ilink->x,ilink->y);CHKERRQ(ierr); 10599df09d43SBarry Smith ierr = PetscLogEventEnd(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL);CHKERRQ(ierr); 1060568ed31eSHong Zhang ierr = KSPGetConvergedReason(ilink->ksp,&reason);CHKERRQ(ierr); 1061568ed31eSHong Zhang if (reason == KSP_DIVERGED_PCSETUP_FAILED) { 1062568ed31eSHong Zhang pc->failedreason = PC_SUBPC_ERROR; 1063568ed31eSHong Zhang } 1064e52d2c62SBarry Smith ierr = VecScatterBegin(ilink->sctx,ilink->y,y,ADD_VALUES,SCATTER_REVERSE);CHKERRQ(ierr); 1065e52d2c62SBarry Smith ierr = VecScatterEnd(ilink->sctx,ilink->y,y,ADD_VALUES,SCATTER_REVERSE);CHKERRQ(ierr); 1066e52d2c62SBarry Smith 1067e52d2c62SBarry Smith /* compute the residual only onto second block variables using first block variables */ 1068e52d2c62SBarry Smith ierr = MatMult(jac->Afield[1],ilink->y,ilink->next->x);CHKERRQ(ierr); 1069e52d2c62SBarry Smith ilink = ilink->next; 1070e52d2c62SBarry Smith ierr = VecScale(ilink->x,-1.0);CHKERRQ(ierr); 1071e52d2c62SBarry Smith ierr = VecScatterBegin(ilink->sctx,x,ilink->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr); 1072e52d2c62SBarry Smith ierr = VecScatterEnd(ilink->sctx,x,ilink->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr); 1073e52d2c62SBarry Smith 1074e52d2c62SBarry Smith /* solve on second block variables */ 10759df09d43SBarry Smith ierr = PetscLogEventBegin(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL);CHKERRQ(ierr); 1076e52d2c62SBarry Smith ierr = KSPSolve(ilink->ksp,ilink->x,ilink->y);CHKERRQ(ierr); 10779df09d43SBarry Smith ierr = PetscLogEventEnd(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL);CHKERRQ(ierr); 1078568ed31eSHong Zhang ierr = KSPGetConvergedReason(ilink->ksp,&reason);CHKERRQ(ierr); 1079568ed31eSHong Zhang if (reason == KSP_DIVERGED_PCSETUP_FAILED) { 1080568ed31eSHong Zhang pc->failedreason = PC_SUBPC_ERROR; 1081568ed31eSHong Zhang } 1082e52d2c62SBarry Smith ierr = VecScatterBegin(ilink->sctx,ilink->y,y,ADD_VALUES,SCATTER_REVERSE);CHKERRQ(ierr); 1083e52d2c62SBarry Smith ierr = VecScatterEnd(ilink->sctx,ilink->y,y,ADD_VALUES,SCATTER_REVERSE);CHKERRQ(ierr); 108416913363SBarry Smith } else if (jac->type == PC_COMPOSITE_MULTIPLICATIVE || jac->type == PC_COMPOSITE_SYMMETRIC_MULTIPLICATIVE) { 108579416396SBarry Smith if (!jac->w1) { 108679416396SBarry Smith ierr = VecDuplicate(x,&jac->w1);CHKERRQ(ierr); 108779416396SBarry Smith ierr = VecDuplicate(x,&jac->w2);CHKERRQ(ierr); 108879416396SBarry Smith } 1089efb30889SBarry Smith ierr = VecSet(y,0.0);CHKERRQ(ierr); 10905a9f2f41SSatish Balay ierr = FieldSplitSplitSolveAdd(ilink,x,y);CHKERRQ(ierr); 1091568ed31eSHong Zhang ierr = KSPGetConvergedReason(ilink->ksp,&reason);CHKERRQ(ierr); 1092568ed31eSHong Zhang if (reason == KSP_DIVERGED_PCSETUP_FAILED) { 1093568ed31eSHong Zhang pc->failedreason = PC_SUBPC_ERROR; 1094568ed31eSHong Zhang } 10953e197d65SBarry Smith cnt = 1; 10965a9f2f41SSatish Balay while (ilink->next) { 10975a9f2f41SSatish Balay ilink = ilink->next; 10983e197d65SBarry Smith /* compute the residual only over the part of the vector needed */ 10993e197d65SBarry Smith ierr = MatMult(jac->Afield[cnt++],y,ilink->x);CHKERRQ(ierr); 11003e197d65SBarry Smith ierr = VecScale(ilink->x,-1.0);CHKERRQ(ierr); 11013e197d65SBarry Smith ierr = VecScatterBegin(ilink->sctx,x,ilink->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr); 11023e197d65SBarry Smith ierr = VecScatterEnd(ilink->sctx,x,ilink->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr); 11039df09d43SBarry Smith ierr = PetscLogEventBegin(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL);CHKERRQ(ierr); 11043e197d65SBarry Smith ierr = KSPSolve(ilink->ksp,ilink->x,ilink->y);CHKERRQ(ierr); 11059df09d43SBarry Smith ierr = PetscLogEventEnd(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL);CHKERRQ(ierr); 11062618eb8fSHong Zhang ierr = KSPGetConvergedReason(ilink->ksp,&reason);CHKERRQ(ierr); 11072618eb8fSHong Zhang if (reason == KSP_DIVERGED_PCSETUP_FAILED) { 11082618eb8fSHong Zhang pc->failedreason = PC_SUBPC_ERROR; 11092618eb8fSHong Zhang } 11103e197d65SBarry Smith ierr = VecScatterBegin(ilink->sctx,ilink->y,y,ADD_VALUES,SCATTER_REVERSE);CHKERRQ(ierr); 11113e197d65SBarry Smith ierr = VecScatterEnd(ilink->sctx,ilink->y,y,ADD_VALUES,SCATTER_REVERSE);CHKERRQ(ierr); 11123e197d65SBarry Smith } 111351f519a2SBarry Smith if (jac->type == PC_COMPOSITE_SYMMETRIC_MULTIPLICATIVE) { 111411755939SBarry Smith cnt -= 2; 111551f519a2SBarry Smith while (ilink->previous) { 111651f519a2SBarry Smith ilink = ilink->previous; 111711755939SBarry Smith /* compute the residual only over the part of the vector needed */ 111811755939SBarry Smith ierr = MatMult(jac->Afield[cnt--],y,ilink->x);CHKERRQ(ierr); 111911755939SBarry Smith ierr = VecScale(ilink->x,-1.0);CHKERRQ(ierr); 112011755939SBarry Smith ierr = VecScatterBegin(ilink->sctx,x,ilink->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr); 112111755939SBarry Smith ierr = VecScatterEnd(ilink->sctx,x,ilink->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr); 11229df09d43SBarry Smith ierr = PetscLogEventBegin(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL);CHKERRQ(ierr); 112311755939SBarry Smith ierr = KSPSolve(ilink->ksp,ilink->x,ilink->y);CHKERRQ(ierr); 11249df09d43SBarry Smith ierr = PetscLogEventEnd(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL);CHKERRQ(ierr); 1125568ed31eSHong Zhang ierr = KSPGetConvergedReason(ilink->ksp,&reason);CHKERRQ(ierr); 1126568ed31eSHong Zhang if (reason == KSP_DIVERGED_PCSETUP_FAILED) { 1127568ed31eSHong Zhang pc->failedreason = PC_SUBPC_ERROR; 1128568ed31eSHong Zhang } 112911755939SBarry Smith ierr = VecScatterBegin(ilink->sctx,ilink->y,y,ADD_VALUES,SCATTER_REVERSE);CHKERRQ(ierr); 113011755939SBarry Smith ierr = VecScatterEnd(ilink->sctx,ilink->y,y,ADD_VALUES,SCATTER_REVERSE);CHKERRQ(ierr); 113151f519a2SBarry Smith } 113211755939SBarry Smith } 1133ce94432eSBarry Smith } else SETERRQ1(PetscObjectComm((PetscObject)pc),PETSC_ERR_SUP,"Unsupported or unknown composition",(int) jac->type); 11340971522cSBarry Smith PetscFunctionReturn(0); 11350971522cSBarry Smith } 11360971522cSBarry Smith 1137421e10b8SBarry Smith #define FieldSplitSplitSolveAddTranspose(ilink,xx,yy) \ 1138ca9f406cSSatish Balay (VecScatterBegin(ilink->sctx,xx,ilink->y,INSERT_VALUES,SCATTER_FORWARD) || \ 1139ca9f406cSSatish Balay VecScatterEnd(ilink->sctx,xx,ilink->y,INSERT_VALUES,SCATTER_FORWARD) || \ 11409df09d43SBarry Smith PetscLogEventBegin(ilink->event,ilink->ksp,ilink->y,ilink->x,NULL) || \ 1141421e10b8SBarry Smith KSPSolveTranspose(ilink->ksp,ilink->y,ilink->x) || \ 11429df09d43SBarry Smith PetscLogEventBegin(ilink->event,ilink->ksp,ilink->y,ilink->x,NULL) || \ 1143ca9f406cSSatish Balay VecScatterBegin(ilink->sctx,ilink->x,yy,ADD_VALUES,SCATTER_REVERSE) || \ 1144ca9f406cSSatish Balay VecScatterEnd(ilink->sctx,ilink->x,yy,ADD_VALUES,SCATTER_REVERSE)) 1145421e10b8SBarry Smith 1146421e10b8SBarry Smith static PetscErrorCode PCApplyTranspose_FieldSplit(PC pc,Vec x,Vec y) 1147421e10b8SBarry Smith { 1148421e10b8SBarry Smith PC_FieldSplit *jac = (PC_FieldSplit*)pc->data; 1149421e10b8SBarry Smith PetscErrorCode ierr; 1150421e10b8SBarry Smith PC_FieldSplitLink ilink = jac->head; 1151939b8a20SBarry Smith PetscInt bs; 1152291dd214SHong Zhang KSPConvergedReason reason; 1153421e10b8SBarry Smith 1154421e10b8SBarry Smith PetscFunctionBegin; 1155421e10b8SBarry Smith if (jac->type == PC_COMPOSITE_ADDITIVE) { 1156421e10b8SBarry Smith if (jac->defaultsplit) { 1157939b8a20SBarry Smith ierr = VecGetBlockSize(x,&bs);CHKERRQ(ierr); 1158ce94432eSBarry 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); 1159939b8a20SBarry Smith ierr = VecGetBlockSize(y,&bs);CHKERRQ(ierr); 1160ce94432eSBarry 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); 1161421e10b8SBarry Smith ierr = VecStrideGatherAll(x,jac->x,INSERT_VALUES);CHKERRQ(ierr); 1162421e10b8SBarry Smith while (ilink) { 11639df09d43SBarry Smith ierr = PetscLogEventBegin(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL);CHKERRQ(ierr); 1164421e10b8SBarry Smith ierr = KSPSolveTranspose(ilink->ksp,ilink->x,ilink->y);CHKERRQ(ierr); 11659df09d43SBarry Smith ierr = PetscLogEventEnd(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL);CHKERRQ(ierr); 11662618eb8fSHong Zhang ierr = KSPGetConvergedReason(ilink->ksp,&reason);CHKERRQ(ierr); 11672618eb8fSHong Zhang if (reason == KSP_DIVERGED_PCSETUP_FAILED) { 11682618eb8fSHong Zhang pc->failedreason = PC_SUBPC_ERROR; 11692618eb8fSHong Zhang } 1170421e10b8SBarry Smith ilink = ilink->next; 1171421e10b8SBarry Smith } 1172421e10b8SBarry Smith ierr = VecStrideScatterAll(jac->y,y,INSERT_VALUES);CHKERRQ(ierr); 1173421e10b8SBarry Smith } else { 1174421e10b8SBarry Smith ierr = VecSet(y,0.0);CHKERRQ(ierr); 1175421e10b8SBarry Smith while (ilink) { 1176421e10b8SBarry Smith ierr = FieldSplitSplitSolveAddTranspose(ilink,x,y);CHKERRQ(ierr); 11772618eb8fSHong Zhang ierr = KSPGetConvergedReason(ilink->ksp,&reason);CHKERRQ(ierr); 11782618eb8fSHong Zhang if (reason == KSP_DIVERGED_PCSETUP_FAILED) { 11792618eb8fSHong Zhang pc->failedreason = PC_SUBPC_ERROR; 11802618eb8fSHong Zhang } 1181421e10b8SBarry Smith ilink = ilink->next; 1182421e10b8SBarry Smith } 1183421e10b8SBarry Smith } 1184421e10b8SBarry Smith } else { 1185421e10b8SBarry Smith if (!jac->w1) { 1186421e10b8SBarry Smith ierr = VecDuplicate(x,&jac->w1);CHKERRQ(ierr); 1187421e10b8SBarry Smith ierr = VecDuplicate(x,&jac->w2);CHKERRQ(ierr); 1188421e10b8SBarry Smith } 1189421e10b8SBarry Smith ierr = VecSet(y,0.0);CHKERRQ(ierr); 1190421e10b8SBarry Smith if (jac->type == PC_COMPOSITE_SYMMETRIC_MULTIPLICATIVE) { 1191421e10b8SBarry Smith ierr = FieldSplitSplitSolveAddTranspose(ilink,x,y);CHKERRQ(ierr); 11922618eb8fSHong Zhang ierr = KSPGetConvergedReason(ilink->ksp,&reason);CHKERRQ(ierr); 11932618eb8fSHong Zhang if (reason == KSP_DIVERGED_PCSETUP_FAILED) { 11942618eb8fSHong Zhang pc->failedreason = PC_SUBPC_ERROR; 11952618eb8fSHong Zhang } 1196421e10b8SBarry Smith while (ilink->next) { 1197421e10b8SBarry Smith ilink = ilink->next; 11989989ab13SBarry Smith ierr = MatMultTranspose(pc->mat,y,jac->w1);CHKERRQ(ierr); 1199421e10b8SBarry Smith ierr = VecWAXPY(jac->w2,-1.0,jac->w1,x);CHKERRQ(ierr); 1200421e10b8SBarry Smith ierr = FieldSplitSplitSolveAddTranspose(ilink,jac->w2,y);CHKERRQ(ierr); 1201421e10b8SBarry Smith } 1202421e10b8SBarry Smith while (ilink->previous) { 1203421e10b8SBarry Smith ilink = ilink->previous; 12049989ab13SBarry Smith ierr = MatMultTranspose(pc->mat,y,jac->w1);CHKERRQ(ierr); 1205421e10b8SBarry Smith ierr = VecWAXPY(jac->w2,-1.0,jac->w1,x);CHKERRQ(ierr); 1206421e10b8SBarry Smith ierr = FieldSplitSplitSolveAddTranspose(ilink,jac->w2,y);CHKERRQ(ierr); 1207421e10b8SBarry Smith } 1208421e10b8SBarry Smith } else { 1209421e10b8SBarry Smith while (ilink->next) { /* get to last entry in linked list */ 1210421e10b8SBarry Smith ilink = ilink->next; 1211421e10b8SBarry Smith } 1212421e10b8SBarry Smith ierr = FieldSplitSplitSolveAddTranspose(ilink,x,y);CHKERRQ(ierr); 12132618eb8fSHong Zhang ierr = KSPGetConvergedReason(ilink->ksp,&reason);CHKERRQ(ierr); 12142618eb8fSHong Zhang if (reason == KSP_DIVERGED_PCSETUP_FAILED) { 12152618eb8fSHong Zhang pc->failedreason = PC_SUBPC_ERROR; 12162618eb8fSHong Zhang } 1217421e10b8SBarry Smith while (ilink->previous) { 1218421e10b8SBarry Smith ilink = ilink->previous; 12199989ab13SBarry Smith ierr = MatMultTranspose(pc->mat,y,jac->w1);CHKERRQ(ierr); 1220421e10b8SBarry Smith ierr = VecWAXPY(jac->w2,-1.0,jac->w1,x);CHKERRQ(ierr); 1221421e10b8SBarry Smith ierr = FieldSplitSplitSolveAddTranspose(ilink,jac->w2,y);CHKERRQ(ierr); 1222421e10b8SBarry Smith } 1223421e10b8SBarry Smith } 1224421e10b8SBarry Smith } 1225421e10b8SBarry Smith PetscFunctionReturn(0); 1226421e10b8SBarry Smith } 1227421e10b8SBarry Smith 1228574deadeSBarry Smith static PetscErrorCode PCReset_FieldSplit(PC pc) 12290971522cSBarry Smith { 12300971522cSBarry Smith PC_FieldSplit *jac = (PC_FieldSplit*)pc->data; 12310971522cSBarry Smith PetscErrorCode ierr; 12325a9f2f41SSatish Balay PC_FieldSplitLink ilink = jac->head,next; 12330971522cSBarry Smith 12340971522cSBarry Smith PetscFunctionBegin; 12355a9f2f41SSatish Balay while (ilink) { 1236f5f0d762SBarry Smith ierr = KSPDestroy(&ilink->ksp);CHKERRQ(ierr); 1237fcfd50ebSBarry Smith ierr = VecDestroy(&ilink->x);CHKERRQ(ierr); 1238fcfd50ebSBarry Smith ierr = VecDestroy(&ilink->y);CHKERRQ(ierr); 1239443836d0SMatthew G Knepley ierr = VecDestroy(&ilink->z);CHKERRQ(ierr); 1240fcfd50ebSBarry Smith ierr = VecScatterDestroy(&ilink->sctx);CHKERRQ(ierr); 1241fcfd50ebSBarry Smith ierr = ISDestroy(&ilink->is);CHKERRQ(ierr); 1242b5787286SJed Brown ierr = ISDestroy(&ilink->is_col);CHKERRQ(ierr); 1243f5f0d762SBarry Smith ierr = PetscFree(ilink->splitname);CHKERRQ(ierr); 1244f5f0d762SBarry Smith ierr = PetscFree(ilink->fields);CHKERRQ(ierr); 1245f5f0d762SBarry Smith ierr = PetscFree(ilink->fields_col);CHKERRQ(ierr); 12465a9f2f41SSatish Balay next = ilink->next; 1247f5f0d762SBarry Smith ierr = PetscFree(ilink);CHKERRQ(ierr); 12485a9f2f41SSatish Balay ilink = next; 12490971522cSBarry Smith } 1250f5f0d762SBarry Smith jac->head = NULL; 125105b42c5fSBarry Smith ierr = PetscFree2(jac->x,jac->y);CHKERRQ(ierr); 1252574deadeSBarry Smith if (jac->mat && jac->mat != jac->pmat) { 1253574deadeSBarry Smith ierr = MatDestroyMatrices(jac->nsplits,&jac->mat);CHKERRQ(ierr); 1254574deadeSBarry Smith } else if (jac->mat) { 12550298fd71SBarry Smith jac->mat = NULL; 1256574deadeSBarry Smith } 125797bbdb24SBarry Smith if (jac->pmat) {ierr = MatDestroyMatrices(jac->nsplits,&jac->pmat);CHKERRQ(ierr);} 125868dd23aaSBarry Smith if (jac->Afield) {ierr = MatDestroyMatrices(jac->nsplits,&jac->Afield);CHKERRQ(ierr);} 1259f5f0d762SBarry Smith jac->nsplits = 0; 12606bf464f9SBarry Smith ierr = VecDestroy(&jac->w1);CHKERRQ(ierr); 12616bf464f9SBarry Smith ierr = VecDestroy(&jac->w2);CHKERRQ(ierr); 12626bf464f9SBarry Smith ierr = MatDestroy(&jac->schur);CHKERRQ(ierr); 1263a7476a74SDmitry Karpeev ierr = MatDestroy(&jac->schurp);CHKERRQ(ierr); 12646bf464f9SBarry Smith ierr = MatDestroy(&jac->schur_user);CHKERRQ(ierr); 12656bf464f9SBarry Smith ierr = KSPDestroy(&jac->kspschur);CHKERRQ(ierr); 1266d78dad28SBarry Smith ierr = KSPDestroy(&jac->kspupper);CHKERRQ(ierr); 12676bf464f9SBarry Smith ierr = MatDestroy(&jac->B);CHKERRQ(ierr); 12686bf464f9SBarry Smith ierr = MatDestroy(&jac->C);CHKERRQ(ierr); 12696dbb499eSCian Wilson jac->isrestrict = PETSC_FALSE; 1270574deadeSBarry Smith PetscFunctionReturn(0); 1271574deadeSBarry Smith } 1272574deadeSBarry Smith 1273574deadeSBarry Smith static PetscErrorCode PCDestroy_FieldSplit(PC pc) 1274574deadeSBarry Smith { 1275574deadeSBarry Smith PetscErrorCode ierr; 1276574deadeSBarry Smith 1277574deadeSBarry Smith PetscFunctionBegin; 1278574deadeSBarry Smith ierr = PCReset_FieldSplit(pc);CHKERRQ(ierr); 1279c31cb41cSBarry Smith ierr = PetscFree(pc->data);CHKERRQ(ierr); 1280*285fb4e2SStefano Zampini ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSchurGetSubKSP_C",NULL);CHKERRQ(ierr); 1281bdf89e91SBarry Smith ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitGetSubKSP_C",NULL);CHKERRQ(ierr); 1282bdf89e91SBarry Smith ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetFields_C",NULL);CHKERRQ(ierr); 1283bdf89e91SBarry Smith ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetIS_C",NULL);CHKERRQ(ierr); 1284bdf89e91SBarry Smith ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetType_C",NULL);CHKERRQ(ierr); 1285bdf89e91SBarry Smith ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetBlockSize_C",NULL);CHKERRQ(ierr); 128629f8a81cSJed Brown ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetSchurPre_C",NULL);CHKERRQ(ierr); 128737a82bf0SJed Brown ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitGetSchurPre_C",NULL);CHKERRQ(ierr); 1288bdf89e91SBarry Smith ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetSchurFactType_C",NULL);CHKERRQ(ierr); 12896dbb499eSCian Wilson ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitRestrictIS_C",NULL);CHKERRQ(ierr); 12900971522cSBarry Smith PetscFunctionReturn(0); 12910971522cSBarry Smith } 12920971522cSBarry Smith 12934416b707SBarry Smith static PetscErrorCode PCSetFromOptions_FieldSplit(PetscOptionItems *PetscOptionsObject,PC pc) 12940971522cSBarry Smith { 12951b9fc7fcSBarry Smith PetscErrorCode ierr; 12966c924f48SJed Brown PetscInt bs; 12977b752e3dSPatrick Sanan PetscBool flg; 12989dcbbd2bSBarry Smith PC_FieldSplit *jac = (PC_FieldSplit*)pc->data; 12993b224e63SBarry Smith PCCompositeType ctype; 13001b9fc7fcSBarry Smith 13010971522cSBarry Smith PetscFunctionBegin; 1302e55864a3SBarry Smith ierr = PetscOptionsHead(PetscOptionsObject,"FieldSplit options");CHKERRQ(ierr); 13034ab8060aSDmitry Karpeev ierr = PetscOptionsBool("-pc_fieldsplit_dm_splits","Whether to use DMCreateFieldDecomposition() for splits","PCFieldSplitSetDMSplits",jac->dm_splits,&jac->dm_splits,NULL);CHKERRQ(ierr); 130451f519a2SBarry Smith ierr = PetscOptionsInt("-pc_fieldsplit_block_size","Blocksize that defines number of fields","PCFieldSplitSetBlockSize",jac->bs,&bs,&flg);CHKERRQ(ierr); 130551f519a2SBarry Smith if (flg) { 130651f519a2SBarry Smith ierr = PCFieldSplitSetBlockSize(pc,bs);CHKERRQ(ierr); 130751f519a2SBarry Smith } 13082686e3e9SMatthew G. Knepley jac->diag_use_amat = pc->useAmat; 13092686e3e9SMatthew 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); 13102686e3e9SMatthew G. Knepley jac->offdiag_use_amat = pc->useAmat; 13112686e3e9SMatthew 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); 13127b752e3dSPatrick 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); 13137b752e3dSPatrick Sanan ierr = PCFieldSplitSetDetectSaddlePoint(pc,jac->detect);CHKERRQ(ierr); /* Sets split type and Schur PC type */ 13143b224e63SBarry Smith ierr = PetscOptionsEnum("-pc_fieldsplit_type","Type of composition","PCFieldSplitSetType",PCCompositeTypes,(PetscEnum)jac->type,(PetscEnum*)&ctype,&flg);CHKERRQ(ierr); 13153b224e63SBarry Smith if (flg) { 13163b224e63SBarry Smith ierr = PCFieldSplitSetType(pc,ctype);CHKERRQ(ierr); 13173b224e63SBarry Smith } 1318c30613efSMatthew Knepley /* Only setup fields once */ 1319c30613efSMatthew Knepley if ((jac->bs > 0) && (jac->nsplits == 0)) { 1320d32f9abdSBarry Smith /* only allow user to set fields from command line if bs is already known. 1321d32f9abdSBarry Smith otherwise user can set them in PCFieldSplitSetDefaults() */ 13226c924f48SJed Brown ierr = PCFieldSplitSetRuntimeSplits_Private(pc);CHKERRQ(ierr); 13236c924f48SJed Brown if (jac->splitdefined) {ierr = PetscInfo(pc,"Splits defined using the options database\n");CHKERRQ(ierr);} 1324d32f9abdSBarry Smith } 1325c5d2311dSJed Brown if (jac->type == PC_COMPOSITE_SCHUR) { 1326c5929fdfSBarry Smith ierr = PetscOptionsGetEnum(((PetscObject)pc)->options,((PetscObject)pc)->prefix,"-pc_fieldsplit_schur_factorization_type",PCFieldSplitSchurFactTypes,(PetscEnum*)&jac->schurfactorization,&flg);CHKERRQ(ierr); 1327c9c6ffaaSJed Brown if (flg) {ierr = PetscInfo(pc,"Deprecated use of -pc_fieldsplit_schur_factorization_type\n");CHKERRQ(ierr);} 13280298fd71SBarry 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); 132929f8a81cSJed 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); 1330c096484dSStefano Zampini ierr = PetscOptionsScalar("-pc_fieldsplit_schur_scale","Scale Schur complement","PCFieldSplitSetSchurScale",jac->schurscale,&jac->schurscale,NULL);CHKERRQ(ierr); 1331c5d2311dSJed Brown } 13321b9fc7fcSBarry Smith ierr = PetscOptionsTail();CHKERRQ(ierr); 13330971522cSBarry Smith PetscFunctionReturn(0); 13340971522cSBarry Smith } 13350971522cSBarry Smith 13360971522cSBarry Smith /*------------------------------------------------------------------------------------*/ 13370971522cSBarry Smith 13381e6b0712SBarry Smith static PetscErrorCode PCFieldSplitSetFields_FieldSplit(PC pc,const char splitname[],PetscInt n,const PetscInt *fields,const PetscInt *fields_col) 13390971522cSBarry Smith { 134097bbdb24SBarry Smith PC_FieldSplit *jac = (PC_FieldSplit*)pc->data; 13410971522cSBarry Smith PetscErrorCode ierr; 13425a9f2f41SSatish Balay PC_FieldSplitLink ilink,next = jac->head; 134369a612a9SBarry Smith char prefix[128]; 13445d4c12cdSJungho Lee PetscInt i; 13450971522cSBarry Smith 13460971522cSBarry Smith PetscFunctionBegin; 13476c924f48SJed Brown if (jac->splitdefined) { 13486c924f48SJed Brown ierr = PetscInfo1(pc,"Ignoring new split \"%s\" because the splits have already been defined\n",splitname);CHKERRQ(ierr); 13496c924f48SJed Brown PetscFunctionReturn(0); 13506c924f48SJed Brown } 135151f519a2SBarry Smith for (i=0; i<n; i++) { 1352e32f2f54SBarry 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); 1353e32f2f54SBarry Smith if (fields[i] < 0) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Negative field %D requested",fields[i]); 135451f519a2SBarry Smith } 1355b00a9115SJed Brown ierr = PetscNew(&ilink);CHKERRQ(ierr); 1356a04f6461SBarry Smith if (splitname) { 1357db4c96c1SJed Brown ierr = PetscStrallocpy(splitname,&ilink->splitname);CHKERRQ(ierr); 1358a04f6461SBarry Smith } else { 1359785e854fSJed Brown ierr = PetscMalloc1(3,&ilink->splitname);CHKERRQ(ierr); 1360a04f6461SBarry Smith ierr = PetscSNPrintf(ilink->splitname,2,"%s",jac->nsplits);CHKERRQ(ierr); 1361a04f6461SBarry Smith } 13629df09d43SBarry 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 */ 1363785e854fSJed Brown ierr = PetscMalloc1(n,&ilink->fields);CHKERRQ(ierr); 13645a9f2f41SSatish Balay ierr = PetscMemcpy(ilink->fields,fields,n*sizeof(PetscInt));CHKERRQ(ierr); 1365785e854fSJed Brown ierr = PetscMalloc1(n,&ilink->fields_col);CHKERRQ(ierr); 13665d4c12cdSJungho Lee ierr = PetscMemcpy(ilink->fields_col,fields_col,n*sizeof(PetscInt));CHKERRQ(ierr); 13672fa5cd67SKarl Rupp 13685a9f2f41SSatish Balay ilink->nfields = n; 13690298fd71SBarry Smith ilink->next = NULL; 1370ce94432eSBarry Smith ierr = KSPCreate(PetscObjectComm((PetscObject)pc),&ilink->ksp);CHKERRQ(ierr); 1371422a814eSBarry Smith ierr = KSPSetErrorIfNotConverged(ilink->ksp,pc->erroriffailure);CHKERRQ(ierr); 137220252d06SBarry Smith ierr = PetscObjectIncrementTabLevel((PetscObject)ilink->ksp,(PetscObject)pc,1);CHKERRQ(ierr); 13735a9f2f41SSatish Balay ierr = KSPSetType(ilink->ksp,KSPPREONLY);CHKERRQ(ierr); 13749005cf84SBarry Smith ierr = PetscLogObjectParent((PetscObject)pc,(PetscObject)ilink->ksp);CHKERRQ(ierr); 137569a612a9SBarry Smith 13768caf3d72SBarry Smith ierr = PetscSNPrintf(prefix,sizeof(prefix),"%sfieldsplit_%s_",((PetscObject)pc)->prefix ? ((PetscObject)pc)->prefix : "",ilink->splitname);CHKERRQ(ierr); 13775a9f2f41SSatish Balay ierr = KSPSetOptionsPrefix(ilink->ksp,prefix);CHKERRQ(ierr); 13780971522cSBarry Smith 13790971522cSBarry Smith if (!next) { 13805a9f2f41SSatish Balay jac->head = ilink; 13810298fd71SBarry Smith ilink->previous = NULL; 13820971522cSBarry Smith } else { 13830971522cSBarry Smith while (next->next) { 13840971522cSBarry Smith next = next->next; 13850971522cSBarry Smith } 13865a9f2f41SSatish Balay next->next = ilink; 138751f519a2SBarry Smith ilink->previous = next; 13880971522cSBarry Smith } 13890971522cSBarry Smith jac->nsplits++; 13900971522cSBarry Smith PetscFunctionReturn(0); 13910971522cSBarry Smith } 13920971522cSBarry Smith 1393*285fb4e2SStefano Zampini static PetscErrorCode PCFieldSplitSchurGetSubKSP_FieldSplit(PC pc,PetscInt *n,KSP **subksp) 1394*285fb4e2SStefano Zampini { 1395*285fb4e2SStefano Zampini PC_FieldSplit *jac = (PC_FieldSplit*)pc->data; 1396*285fb4e2SStefano Zampini PetscErrorCode ierr; 1397*285fb4e2SStefano Zampini 1398*285fb4e2SStefano Zampini PetscFunctionBegin; 1399*285fb4e2SStefano Zampini *subksp = NULL; 1400*285fb4e2SStefano Zampini if (n) *n = 0; 1401*285fb4e2SStefano Zampini if (jac->type == PC_COMPOSITE_SCHUR) { 1402*285fb4e2SStefano Zampini PetscInt nn; 1403*285fb4e2SStefano Zampini 1404*285fb4e2SStefano Zampini if (!jac->schur) SETERRQ(PetscObjectComm((PetscObject)pc),PETSC_ERR_ARG_WRONGSTATE,"Must call KSPSetUp() or PCSetUp() before calling PCFieldSplitSchurGetSubKSP()"); 1405*285fb4e2SStefano Zampini if (jac->nsplits != 2) SETERRQ1(PetscObjectComm((PetscObject)pc),PETSC_ERR_PLIB,"Unexpected number of splits %D != 2",jac->nsplits); 1406*285fb4e2SStefano Zampini nn = jac->nsplits + (jac->kspupper != jac->head->ksp ? 1 : 0); 1407*285fb4e2SStefano Zampini ierr = PetscMalloc1(nn,subksp);CHKERRQ(ierr); 1408*285fb4e2SStefano Zampini (*subksp)[0] = jac->head->ksp; 1409*285fb4e2SStefano Zampini (*subksp)[1] = jac->kspschur; 1410*285fb4e2SStefano Zampini if (jac->kspupper != jac->head->ksp) (*subksp)[2] = jac->kspupper; 1411*285fb4e2SStefano Zampini if (n) *n = nn; 1412*285fb4e2SStefano Zampini } 1413*285fb4e2SStefano Zampini PetscFunctionReturn(0); 1414*285fb4e2SStefano Zampini } 1415*285fb4e2SStefano Zampini 14161e6b0712SBarry Smith static PetscErrorCode PCFieldSplitGetSubKSP_FieldSplit_Schur(PC pc,PetscInt *n,KSP **subksp) 1417e69d4d44SBarry Smith { 1418e69d4d44SBarry Smith PC_FieldSplit *jac = (PC_FieldSplit*)pc->data; 1419e69d4d44SBarry Smith PetscErrorCode ierr; 1420e69d4d44SBarry Smith 1421e69d4d44SBarry Smith PetscFunctionBegin; 142234a3b412SBarry Smith if (!jac->schur) SETERRQ(PetscObjectComm((PetscObject)pc),PETSC_ERR_ARG_WRONGSTATE,"Must call KSPSetUp() or PCSetUp() before calling PCFieldSplitGetSubKSP()"); 1423785e854fSJed Brown ierr = PetscMalloc1(jac->nsplits,subksp);CHKERRQ(ierr); 1424e69d4d44SBarry Smith ierr = MatSchurComplementGetKSP(jac->schur,*subksp);CHKERRQ(ierr); 14252fa5cd67SKarl Rupp 1426e69d4d44SBarry Smith (*subksp)[1] = jac->kspschur; 142713e0d083SBarry Smith if (n) *n = jac->nsplits; 1428e69d4d44SBarry Smith PetscFunctionReturn(0); 1429e69d4d44SBarry Smith } 14300971522cSBarry Smith 14311e6b0712SBarry Smith static PetscErrorCode PCFieldSplitGetSubKSP_FieldSplit(PC pc,PetscInt *n,KSP **subksp) 14320971522cSBarry Smith { 14330971522cSBarry Smith PC_FieldSplit *jac = (PC_FieldSplit*)pc->data; 14340971522cSBarry Smith PetscErrorCode ierr; 14350971522cSBarry Smith PetscInt cnt = 0; 14365a9f2f41SSatish Balay PC_FieldSplitLink ilink = jac->head; 14370971522cSBarry Smith 14380971522cSBarry Smith PetscFunctionBegin; 1439785e854fSJed Brown ierr = PetscMalloc1(jac->nsplits,subksp);CHKERRQ(ierr); 14405a9f2f41SSatish Balay while (ilink) { 14415a9f2f41SSatish Balay (*subksp)[cnt++] = ilink->ksp; 14425a9f2f41SSatish Balay ilink = ilink->next; 14430971522cSBarry Smith } 14445d480477SMatthew 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); 144513e0d083SBarry Smith if (n) *n = jac->nsplits; 14460971522cSBarry Smith PetscFunctionReturn(0); 14470971522cSBarry Smith } 14480971522cSBarry Smith 14496dbb499eSCian Wilson /*@C 14506dbb499eSCian Wilson PCFieldSplitRestrictIS - Restricts the fieldsplit ISs to be within a given IS. 14516dbb499eSCian Wilson 14526dbb499eSCian Wilson Input Parameters: 14536dbb499eSCian Wilson + pc - the preconditioner context 14546dbb499eSCian Wilson + is - the index set that defines the indices to which the fieldsplit is to be restricted 14556dbb499eSCian Wilson 14566dbb499eSCian Wilson Level: advanced 14576dbb499eSCian Wilson 14586dbb499eSCian Wilson @*/ 14596dbb499eSCian Wilson PetscErrorCode PCFieldSplitRestrictIS(PC pc,IS isy) 14606dbb499eSCian Wilson { 14616dbb499eSCian Wilson PetscErrorCode ierr; 14626dbb499eSCian Wilson 14636dbb499eSCian Wilson PetscFunctionBegin; 14646dbb499eSCian Wilson PetscValidHeaderSpecific(pc,PC_CLASSID,1); 14656dbb499eSCian Wilson PetscValidHeaderSpecific(isy,IS_CLASSID,2); 14660246f55cSBarry Smith ierr = PetscTryMethod(pc,"PCFieldSplitRestrictIS_C",(PC,IS),(pc,isy));CHKERRQ(ierr); 14676dbb499eSCian Wilson PetscFunctionReturn(0); 14686dbb499eSCian Wilson } 14696dbb499eSCian Wilson 14706dbb499eSCian Wilson 14716dbb499eSCian Wilson static PetscErrorCode PCFieldSplitRestrictIS_FieldSplit(PC pc, IS isy) 14726dbb499eSCian Wilson { 14736dbb499eSCian Wilson PC_FieldSplit *jac = (PC_FieldSplit*)pc->data; 14746dbb499eSCian Wilson PetscErrorCode ierr; 14756dbb499eSCian Wilson PC_FieldSplitLink ilink = jac->head, next; 14766dbb499eSCian Wilson PetscInt localsize,size,sizez,i; 14776dbb499eSCian Wilson const PetscInt *ind, *indz; 14786dbb499eSCian Wilson PetscInt *indc, *indcz; 14796dbb499eSCian Wilson PetscBool flg; 14806dbb499eSCian Wilson 14816dbb499eSCian Wilson PetscFunctionBegin; 14826dbb499eSCian Wilson ierr = ISGetLocalSize(isy,&localsize);CHKERRQ(ierr); 14836dbb499eSCian Wilson ierr = MPI_Scan(&localsize,&size,1,MPIU_INT,MPI_SUM,PetscObjectComm((PetscObject)isy));CHKERRQ(ierr); 14846dbb499eSCian Wilson size -= localsize; 14856dbb499eSCian Wilson while(ilink) { 14866dbb499eSCian Wilson IS isrl,isr; 14871c7cfba8SBarry Smith PC subpc; 14886dbb499eSCian Wilson ierr = ISEmbed(ilink->is, isy, PETSC_TRUE, &isrl);CHKERRQ(ierr); 14896dbb499eSCian Wilson ierr = ISGetLocalSize(isrl,&localsize);CHKERRQ(ierr); 14906dbb499eSCian Wilson ierr = PetscMalloc1(localsize,&indc);CHKERRQ(ierr); 14916dbb499eSCian Wilson ierr = ISGetIndices(isrl,&ind);CHKERRQ(ierr); 14926dbb499eSCian Wilson ierr = PetscMemcpy(indc,ind,localsize*sizeof(PetscInt));CHKERRQ(ierr); 14936dbb499eSCian Wilson ierr = ISRestoreIndices(isrl,&ind);CHKERRQ(ierr); 14946dbb499eSCian Wilson ierr = ISDestroy(&isrl);CHKERRQ(ierr); 14956dbb499eSCian Wilson for (i=0; i<localsize; i++) *(indc+i) += size; 14966dbb499eSCian Wilson ierr = ISCreateGeneral(PetscObjectComm((PetscObject)isy),localsize,indc,PETSC_OWN_POINTER,&isr);CHKERRQ(ierr); 14976dbb499eSCian Wilson ierr = PetscObjectReference((PetscObject)isr);CHKERRQ(ierr); 14986dbb499eSCian Wilson ierr = ISDestroy(&ilink->is);CHKERRQ(ierr); 14996dbb499eSCian Wilson ilink->is = isr; 15006dbb499eSCian Wilson ierr = PetscObjectReference((PetscObject)isr);CHKERRQ(ierr); 15016dbb499eSCian Wilson ierr = ISDestroy(&ilink->is_col);CHKERRQ(ierr); 15026dbb499eSCian Wilson ilink->is_col = isr; 15036dbb499eSCian Wilson ierr = ISDestroy(&isr);CHKERRQ(ierr); 15046dbb499eSCian Wilson ierr = KSPGetPC(ilink->ksp, &subpc);CHKERRQ(ierr); 15056dbb499eSCian Wilson ierr = PetscObjectTypeCompare((PetscObject)subpc,PCFIELDSPLIT,&flg);CHKERRQ(ierr); 15066dbb499eSCian Wilson if(flg) { 15076dbb499eSCian Wilson IS iszl,isz; 15086dbb499eSCian Wilson MPI_Comm comm; 15096dbb499eSCian Wilson ierr = ISGetLocalSize(ilink->is,&localsize);CHKERRQ(ierr); 15106dbb499eSCian Wilson comm = PetscObjectComm((PetscObject)ilink->is); 15116dbb499eSCian Wilson ierr = ISEmbed(isy, ilink->is, PETSC_TRUE, &iszl);CHKERRQ(ierr); 15126dbb499eSCian Wilson ierr = MPI_Scan(&localsize,&sizez,1,MPIU_INT,MPI_SUM,comm);CHKERRQ(ierr); 15136dbb499eSCian Wilson sizez -= localsize; 15146dbb499eSCian Wilson ierr = ISGetLocalSize(iszl,&localsize);CHKERRQ(ierr); 15156dbb499eSCian Wilson ierr = PetscMalloc1(localsize,&indcz);CHKERRQ(ierr); 15166dbb499eSCian Wilson ierr = ISGetIndices(iszl,&indz);CHKERRQ(ierr); 15176dbb499eSCian Wilson ierr = PetscMemcpy(indcz,indz,localsize*sizeof(PetscInt));CHKERRQ(ierr); 15186dbb499eSCian Wilson ierr = ISRestoreIndices(iszl,&indz);CHKERRQ(ierr); 15196dbb499eSCian Wilson ierr = ISDestroy(&iszl);CHKERRQ(ierr); 15206dbb499eSCian Wilson for (i=0; i<localsize; i++) *(indcz+i) += sizez; 15216dbb499eSCian Wilson ierr = ISCreateGeneral(comm,localsize,indcz,PETSC_OWN_POINTER,&isz);CHKERRQ(ierr); 15226dbb499eSCian Wilson ierr = PCFieldSplitRestrictIS(subpc,isz);CHKERRQ(ierr); 15236dbb499eSCian Wilson ierr = ISDestroy(&isz);CHKERRQ(ierr); 15246dbb499eSCian Wilson } 15256dbb499eSCian Wilson next = ilink->next; 15266dbb499eSCian Wilson ilink = next; 15276dbb499eSCian Wilson } 15286dbb499eSCian Wilson jac->isrestrict = PETSC_TRUE; 15296dbb499eSCian Wilson PetscFunctionReturn(0); 15306dbb499eSCian Wilson } 15316dbb499eSCian Wilson 15321e6b0712SBarry Smith static PetscErrorCode PCFieldSplitSetIS_FieldSplit(PC pc,const char splitname[],IS is) 1533704ba839SBarry Smith { 1534704ba839SBarry Smith PC_FieldSplit *jac = (PC_FieldSplit*)pc->data; 1535704ba839SBarry Smith PetscErrorCode ierr; 1536704ba839SBarry Smith PC_FieldSplitLink ilink, next = jac->head; 1537704ba839SBarry Smith char prefix[128]; 1538704ba839SBarry Smith 1539704ba839SBarry Smith PetscFunctionBegin; 15406c924f48SJed Brown if (jac->splitdefined) { 15416c924f48SJed Brown ierr = PetscInfo1(pc,"Ignoring new split \"%s\" because the splits have already been defined\n",splitname);CHKERRQ(ierr); 15426c924f48SJed Brown PetscFunctionReturn(0); 15436c924f48SJed Brown } 1544b00a9115SJed Brown ierr = PetscNew(&ilink);CHKERRQ(ierr); 1545a04f6461SBarry Smith if (splitname) { 1546db4c96c1SJed Brown ierr = PetscStrallocpy(splitname,&ilink->splitname);CHKERRQ(ierr); 1547a04f6461SBarry Smith } else { 1548785e854fSJed Brown ierr = PetscMalloc1(8,&ilink->splitname);CHKERRQ(ierr); 1549b5787286SJed Brown ierr = PetscSNPrintf(ilink->splitname,7,"%D",jac->nsplits);CHKERRQ(ierr); 1550a04f6461SBarry Smith } 15519df09d43SBarry 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 */ 15521ab39975SBarry Smith ierr = PetscObjectReference((PetscObject)is);CHKERRQ(ierr); 1553b5787286SJed Brown ierr = ISDestroy(&ilink->is);CHKERRQ(ierr); 1554b5787286SJed Brown ilink->is = is; 1555b5787286SJed Brown ierr = PetscObjectReference((PetscObject)is);CHKERRQ(ierr); 1556b5787286SJed Brown ierr = ISDestroy(&ilink->is_col);CHKERRQ(ierr); 1557b5787286SJed Brown ilink->is_col = is; 15580298fd71SBarry Smith ilink->next = NULL; 1559ce94432eSBarry Smith ierr = KSPCreate(PetscObjectComm((PetscObject)pc),&ilink->ksp);CHKERRQ(ierr); 1560422a814eSBarry Smith ierr = KSPSetErrorIfNotConverged(ilink->ksp,pc->erroriffailure);CHKERRQ(ierr); 156120252d06SBarry Smith ierr = PetscObjectIncrementTabLevel((PetscObject)ilink->ksp,(PetscObject)pc,1);CHKERRQ(ierr); 1562704ba839SBarry Smith ierr = KSPSetType(ilink->ksp,KSPPREONLY);CHKERRQ(ierr); 15639005cf84SBarry Smith ierr = PetscLogObjectParent((PetscObject)pc,(PetscObject)ilink->ksp);CHKERRQ(ierr); 1564704ba839SBarry Smith 15658caf3d72SBarry Smith ierr = PetscSNPrintf(prefix,sizeof(prefix),"%sfieldsplit_%s_",((PetscObject)pc)->prefix ? ((PetscObject)pc)->prefix : "",ilink->splitname);CHKERRQ(ierr); 1566704ba839SBarry Smith ierr = KSPSetOptionsPrefix(ilink->ksp,prefix);CHKERRQ(ierr); 1567704ba839SBarry Smith 1568704ba839SBarry Smith if (!next) { 1569704ba839SBarry Smith jac->head = ilink; 15700298fd71SBarry Smith ilink->previous = NULL; 1571704ba839SBarry Smith } else { 1572704ba839SBarry Smith while (next->next) { 1573704ba839SBarry Smith next = next->next; 1574704ba839SBarry Smith } 1575704ba839SBarry Smith next->next = ilink; 1576704ba839SBarry Smith ilink->previous = next; 1577704ba839SBarry Smith } 1578704ba839SBarry Smith jac->nsplits++; 1579704ba839SBarry Smith PetscFunctionReturn(0); 1580704ba839SBarry Smith } 1581704ba839SBarry Smith 158294ef8ddeSSatish Balay /*@C 15830971522cSBarry Smith PCFieldSplitSetFields - Sets the fields for one particular split in the field split preconditioner 15840971522cSBarry Smith 1585ad4df100SBarry Smith Logically Collective on PC 15860971522cSBarry Smith 15870971522cSBarry Smith Input Parameters: 15880971522cSBarry Smith + pc - the preconditioner context 15890298fd71SBarry Smith . splitname - name of this split, if NULL the number of the split is used 15900971522cSBarry Smith . n - the number of fields in this split 1591db4c96c1SJed Brown - fields - the fields in this split 15920971522cSBarry Smith 15930971522cSBarry Smith Level: intermediate 15940971522cSBarry Smith 159595452b02SPatrick Sanan Notes: 159695452b02SPatrick Sanan Use PCFieldSplitSetIS() to set a completely general set of indices as a field. 1597d32f9abdSBarry Smith 15987287d2a3SDmitry Karpeev The PCFieldSplitSetFields() is for defining fields as strided blocks. For example, if the block 1599d32f9abdSBarry 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 1600d32f9abdSBarry Smith 0xx3xx6xx9xx12 ... x1xx4xx7xx ... xx2xx5xx8xx.. 01x34x67x... 0x1x3x5x7.. x12x45x78x.... 1601d32f9abdSBarry Smith where the numbered entries indicate what is in the field. 1602d32f9abdSBarry Smith 1603db4c96c1SJed Brown This function is called once per split (it creates a new split each time). Solve options 1604db4c96c1SJed Brown for this split will be available under the prefix -fieldsplit_SPLITNAME_. 1605db4c96c1SJed Brown 16065d4c12cdSJungho Lee Developer Note: This routine does not actually create the IS representing the split, that is delayed 16075d4c12cdSJungho Lee until PCSetUp_FieldSplit(), because information about the vector/matrix layouts may not be 16085d4c12cdSJungho Lee available when this routine is called. 16095d4c12cdSJungho Lee 1610d32f9abdSBarry Smith .seealso: PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitSetBlockSize(), PCFieldSplitSetIS() 16110971522cSBarry Smith 16120971522cSBarry Smith @*/ 16135d4c12cdSJungho Lee PetscErrorCode PCFieldSplitSetFields(PC pc,const char splitname[],PetscInt n,const PetscInt *fields,const PetscInt *fields_col) 16140971522cSBarry Smith { 16154ac538c5SBarry Smith PetscErrorCode ierr; 16160971522cSBarry Smith 16170971522cSBarry Smith PetscFunctionBegin; 16180700a824SBarry Smith PetscValidHeaderSpecific(pc,PC_CLASSID,1); 1619db4c96c1SJed Brown PetscValidCharPointer(splitname,2); 1620ce94432eSBarry Smith if (n < 1) SETERRQ2(PetscObjectComm((PetscObject)pc),PETSC_ERR_ARG_OUTOFRANGE,"Provided number of fields %D in split \"%s\" not positive",n,splitname); 1621db4c96c1SJed Brown PetscValidIntPointer(fields,3); 16220246f55cSBarry Smith ierr = PetscTryMethod(pc,"PCFieldSplitSetFields_C",(PC,const char[],PetscInt,const PetscInt*,const PetscInt*),(pc,splitname,n,fields,fields_col));CHKERRQ(ierr); 16230971522cSBarry Smith PetscFunctionReturn(0); 16240971522cSBarry Smith } 16250971522cSBarry Smith 1626c84da90fSDmitry Karpeev /*@ 1627c84da90fSDmitry Karpeev PCFieldSplitSetDiagUseAmat - set flag indicating whether to extract diagonal blocks from Amat (rather than Pmat) 1628c84da90fSDmitry Karpeev 1629c84da90fSDmitry Karpeev Logically Collective on PC 1630c84da90fSDmitry Karpeev 1631c84da90fSDmitry Karpeev Input Parameters: 1632c84da90fSDmitry Karpeev + pc - the preconditioner object 1633c84da90fSDmitry Karpeev - flg - boolean flag indicating whether or not to use Amat to extract the diagonal blocks from 1634c84da90fSDmitry Karpeev 16359506b623SDmitry Karpeev Options Database: 16369506b623SDmitry Karpeev . -pc_fieldsplit_diag_use_amat 1637c84da90fSDmitry Karpeev 1638c84da90fSDmitry Karpeev Level: intermediate 1639c84da90fSDmitry Karpeev 1640c84da90fSDmitry Karpeev .seealso: PCFieldSplitGetDiagUseAmat(), PCFieldSplitSetOffDiagUseAmat(), PCFIELDSPLIT 1641c84da90fSDmitry Karpeev 1642c84da90fSDmitry Karpeev @*/ 1643c84da90fSDmitry Karpeev PetscErrorCode PCFieldSplitSetDiagUseAmat(PC pc,PetscBool flg) 1644c84da90fSDmitry Karpeev { 1645c84da90fSDmitry Karpeev PC_FieldSplit *jac = (PC_FieldSplit*)pc->data; 1646c84da90fSDmitry Karpeev PetscBool isfs; 1647c84da90fSDmitry Karpeev PetscErrorCode ierr; 1648c84da90fSDmitry Karpeev 1649c84da90fSDmitry Karpeev PetscFunctionBegin; 1650c84da90fSDmitry Karpeev PetscValidHeaderSpecific(pc,PC_CLASSID,1); 1651c84da90fSDmitry Karpeev ierr = PetscObjectTypeCompare((PetscObject)pc,PCFIELDSPLIT,&isfs);CHKERRQ(ierr); 1652c84da90fSDmitry Karpeev if (!isfs) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"PC not of type %s",PCFIELDSPLIT); 1653c84da90fSDmitry Karpeev jac->diag_use_amat = flg; 1654c84da90fSDmitry Karpeev PetscFunctionReturn(0); 1655c84da90fSDmitry Karpeev } 1656c84da90fSDmitry Karpeev 1657c84da90fSDmitry Karpeev /*@ 1658c84da90fSDmitry Karpeev PCFieldSplitGetDiagUseAmat - get the flag indicating whether to extract diagonal blocks from Amat (rather than Pmat) 1659c84da90fSDmitry Karpeev 1660c84da90fSDmitry Karpeev Logically Collective on PC 1661c84da90fSDmitry Karpeev 1662c84da90fSDmitry Karpeev Input Parameters: 1663c84da90fSDmitry Karpeev . pc - the preconditioner object 1664c84da90fSDmitry Karpeev 1665c84da90fSDmitry Karpeev Output Parameters: 1666c84da90fSDmitry Karpeev . flg - boolean flag indicating whether or not to use Amat to extract the diagonal blocks from 1667c84da90fSDmitry Karpeev 1668c84da90fSDmitry Karpeev 1669c84da90fSDmitry Karpeev Level: intermediate 1670c84da90fSDmitry Karpeev 1671c84da90fSDmitry Karpeev .seealso: PCFieldSplitSetDiagUseAmat(), PCFieldSplitGetOffDiagUseAmat(), PCFIELDSPLIT 1672c84da90fSDmitry Karpeev 1673c84da90fSDmitry Karpeev @*/ 1674c84da90fSDmitry Karpeev PetscErrorCode PCFieldSplitGetDiagUseAmat(PC pc,PetscBool *flg) 1675c84da90fSDmitry Karpeev { 1676c84da90fSDmitry Karpeev PC_FieldSplit *jac = (PC_FieldSplit*)pc->data; 1677c84da90fSDmitry Karpeev PetscBool isfs; 1678c84da90fSDmitry Karpeev PetscErrorCode ierr; 1679c84da90fSDmitry Karpeev 1680c84da90fSDmitry Karpeev PetscFunctionBegin; 1681c84da90fSDmitry Karpeev PetscValidHeaderSpecific(pc,PC_CLASSID,1); 1682c84da90fSDmitry Karpeev PetscValidPointer(flg,2); 1683c84da90fSDmitry Karpeev ierr = PetscObjectTypeCompare((PetscObject)pc,PCFIELDSPLIT,&isfs);CHKERRQ(ierr); 1684c84da90fSDmitry Karpeev if (!isfs) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"PC not of type %s",PCFIELDSPLIT); 1685c84da90fSDmitry Karpeev *flg = jac->diag_use_amat; 1686c84da90fSDmitry Karpeev PetscFunctionReturn(0); 1687c84da90fSDmitry Karpeev } 1688c84da90fSDmitry Karpeev 1689c84da90fSDmitry Karpeev /*@ 1690c84da90fSDmitry Karpeev PCFieldSplitSetOffDiagUseAmat - set flag indicating whether to extract off-diagonal blocks from Amat (rather than Pmat) 1691c84da90fSDmitry Karpeev 1692c84da90fSDmitry Karpeev Logically Collective on PC 1693c84da90fSDmitry Karpeev 1694c84da90fSDmitry Karpeev Input Parameters: 1695c84da90fSDmitry Karpeev + pc - the preconditioner object 1696c84da90fSDmitry Karpeev - flg - boolean flag indicating whether or not to use Amat to extract the off-diagonal blocks from 1697c84da90fSDmitry Karpeev 16989506b623SDmitry Karpeev Options Database: 16999506b623SDmitry Karpeev . -pc_fieldsplit_off_diag_use_amat 1700c84da90fSDmitry Karpeev 1701c84da90fSDmitry Karpeev Level: intermediate 1702c84da90fSDmitry Karpeev 1703c84da90fSDmitry Karpeev .seealso: PCFieldSplitGetOffDiagUseAmat(), PCFieldSplitSetDiagUseAmat(), PCFIELDSPLIT 1704c84da90fSDmitry Karpeev 1705c84da90fSDmitry Karpeev @*/ 1706c84da90fSDmitry Karpeev PetscErrorCode PCFieldSplitSetOffDiagUseAmat(PC pc,PetscBool flg) 1707c84da90fSDmitry Karpeev { 1708c84da90fSDmitry Karpeev PC_FieldSplit *jac = (PC_FieldSplit*)pc->data; 1709c84da90fSDmitry Karpeev PetscBool isfs; 1710c84da90fSDmitry Karpeev PetscErrorCode ierr; 1711c84da90fSDmitry Karpeev 1712c84da90fSDmitry Karpeev PetscFunctionBegin; 1713c84da90fSDmitry Karpeev PetscValidHeaderSpecific(pc,PC_CLASSID,1); 1714c84da90fSDmitry Karpeev ierr = PetscObjectTypeCompare((PetscObject)pc,PCFIELDSPLIT,&isfs);CHKERRQ(ierr); 1715c84da90fSDmitry Karpeev if (!isfs) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"PC not of type %s",PCFIELDSPLIT); 1716c84da90fSDmitry Karpeev jac->offdiag_use_amat = flg; 1717c84da90fSDmitry Karpeev PetscFunctionReturn(0); 1718c84da90fSDmitry Karpeev } 1719c84da90fSDmitry Karpeev 1720c84da90fSDmitry Karpeev /*@ 1721c84da90fSDmitry Karpeev PCFieldSplitGetOffDiagUseAmat - get the flag indicating whether to extract off-diagonal blocks from Amat (rather than Pmat) 1722c84da90fSDmitry Karpeev 1723c84da90fSDmitry Karpeev Logically Collective on PC 1724c84da90fSDmitry Karpeev 1725c84da90fSDmitry Karpeev Input Parameters: 1726c84da90fSDmitry Karpeev . pc - the preconditioner object 1727c84da90fSDmitry Karpeev 1728c84da90fSDmitry Karpeev Output Parameters: 1729c84da90fSDmitry Karpeev . flg - boolean flag indicating whether or not to use Amat to extract the off-diagonal blocks from 1730c84da90fSDmitry Karpeev 1731c84da90fSDmitry Karpeev 1732c84da90fSDmitry Karpeev Level: intermediate 1733c84da90fSDmitry Karpeev 1734c84da90fSDmitry Karpeev .seealso: PCFieldSplitSetOffDiagUseAmat(), PCFieldSplitGetDiagUseAmat(), PCFIELDSPLIT 1735c84da90fSDmitry Karpeev 1736c84da90fSDmitry Karpeev @*/ 1737c84da90fSDmitry Karpeev PetscErrorCode PCFieldSplitGetOffDiagUseAmat(PC pc,PetscBool *flg) 1738c84da90fSDmitry Karpeev { 1739c84da90fSDmitry Karpeev PC_FieldSplit *jac = (PC_FieldSplit*)pc->data; 1740c84da90fSDmitry Karpeev PetscBool isfs; 1741c84da90fSDmitry Karpeev PetscErrorCode ierr; 1742c84da90fSDmitry Karpeev 1743c84da90fSDmitry Karpeev PetscFunctionBegin; 1744c84da90fSDmitry Karpeev PetscValidHeaderSpecific(pc,PC_CLASSID,1); 1745c84da90fSDmitry Karpeev PetscValidPointer(flg,2); 1746c84da90fSDmitry Karpeev ierr = PetscObjectTypeCompare((PetscObject)pc,PCFIELDSPLIT,&isfs);CHKERRQ(ierr); 1747c84da90fSDmitry Karpeev if (!isfs) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"PC not of type %s",PCFIELDSPLIT); 1748c84da90fSDmitry Karpeev *flg = jac->offdiag_use_amat; 1749c84da90fSDmitry Karpeev PetscFunctionReturn(0); 1750c84da90fSDmitry Karpeev } 1751c84da90fSDmitry Karpeev 1752c84da90fSDmitry Karpeev 1753c84da90fSDmitry Karpeev 1754218d4943SBarry Smith /*@C 1755704ba839SBarry Smith PCFieldSplitSetIS - Sets the exact elements for field 1756704ba839SBarry Smith 1757ad4df100SBarry Smith Logically Collective on PC 1758704ba839SBarry Smith 1759704ba839SBarry Smith Input Parameters: 1760704ba839SBarry Smith + pc - the preconditioner context 17610298fd71SBarry Smith . splitname - name of this split, if NULL the number of the split is used 1762db4c96c1SJed Brown - is - the index set that defines the vector elements in this field 1763704ba839SBarry Smith 1764d32f9abdSBarry Smith 1765a6ffb8dbSJed Brown Notes: 1766a6ffb8dbSJed Brown Use PCFieldSplitSetFields(), for fields defined by strided types. 1767a6ffb8dbSJed Brown 1768db4c96c1SJed Brown This function is called once per split (it creates a new split each time). Solve options 1769db4c96c1SJed Brown for this split will be available under the prefix -fieldsplit_SPLITNAME_. 1770d32f9abdSBarry Smith 1771704ba839SBarry Smith Level: intermediate 1772704ba839SBarry Smith 1773704ba839SBarry Smith .seealso: PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitSetBlockSize() 1774704ba839SBarry Smith 1775704ba839SBarry Smith @*/ 17767087cfbeSBarry Smith PetscErrorCode PCFieldSplitSetIS(PC pc,const char splitname[],IS is) 1777704ba839SBarry Smith { 17784ac538c5SBarry Smith PetscErrorCode ierr; 1779704ba839SBarry Smith 1780704ba839SBarry Smith PetscFunctionBegin; 17810700a824SBarry Smith PetscValidHeaderSpecific(pc,PC_CLASSID,1); 17827b62db95SJungho Lee if (splitname) PetscValidCharPointer(splitname,2); 1783db4c96c1SJed Brown PetscValidHeaderSpecific(is,IS_CLASSID,3); 1784ccc738f7SBarry Smith ierr = PetscTryMethod(pc,"PCFieldSplitSetIS_C",(PC,const char[],IS),(pc,splitname,is));CHKERRQ(ierr); 1785704ba839SBarry Smith PetscFunctionReturn(0); 1786704ba839SBarry Smith } 1787704ba839SBarry Smith 178894ef8ddeSSatish Balay /*@C 178957a9adfeSMatthew G Knepley PCFieldSplitGetIS - Retrieves the elements for a field as an IS 179057a9adfeSMatthew G Knepley 179157a9adfeSMatthew G Knepley Logically Collective on PC 179257a9adfeSMatthew G Knepley 179357a9adfeSMatthew G Knepley Input Parameters: 179457a9adfeSMatthew G Knepley + pc - the preconditioner context 179557a9adfeSMatthew G Knepley - splitname - name of this split 179657a9adfeSMatthew G Knepley 179757a9adfeSMatthew G Knepley Output Parameter: 17980298fd71SBarry Smith - is - the index set that defines the vector elements in this field, or NULL if the field is not found 179957a9adfeSMatthew G Knepley 180057a9adfeSMatthew G Knepley Level: intermediate 180157a9adfeSMatthew G Knepley 180257a9adfeSMatthew G Knepley .seealso: PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitSetIS() 180357a9adfeSMatthew G Knepley 180457a9adfeSMatthew G Knepley @*/ 180557a9adfeSMatthew G Knepley PetscErrorCode PCFieldSplitGetIS(PC pc,const char splitname[],IS *is) 180657a9adfeSMatthew G Knepley { 180757a9adfeSMatthew G Knepley PetscErrorCode ierr; 180857a9adfeSMatthew G Knepley 180957a9adfeSMatthew G Knepley PetscFunctionBegin; 181057a9adfeSMatthew G Knepley PetscValidHeaderSpecific(pc,PC_CLASSID,1); 181157a9adfeSMatthew G Knepley PetscValidCharPointer(splitname,2); 181257a9adfeSMatthew G Knepley PetscValidPointer(is,3); 181357a9adfeSMatthew G Knepley { 181457a9adfeSMatthew G Knepley PC_FieldSplit *jac = (PC_FieldSplit*) pc->data; 181557a9adfeSMatthew G Knepley PC_FieldSplitLink ilink = jac->head; 181657a9adfeSMatthew G Knepley PetscBool found; 181757a9adfeSMatthew G Knepley 18180298fd71SBarry Smith *is = NULL; 181957a9adfeSMatthew G Knepley while (ilink) { 182057a9adfeSMatthew G Knepley ierr = PetscStrcmp(ilink->splitname, splitname, &found);CHKERRQ(ierr); 182157a9adfeSMatthew G Knepley if (found) { 182257a9adfeSMatthew G Knepley *is = ilink->is; 182357a9adfeSMatthew G Knepley break; 182457a9adfeSMatthew G Knepley } 182557a9adfeSMatthew G Knepley ilink = ilink->next; 182657a9adfeSMatthew G Knepley } 182757a9adfeSMatthew G Knepley } 182857a9adfeSMatthew G Knepley PetscFunctionReturn(0); 182957a9adfeSMatthew G Knepley } 183057a9adfeSMatthew G Knepley 183151f519a2SBarry Smith /*@ 183251f519a2SBarry Smith PCFieldSplitSetBlockSize - Sets the block size for defining where fields start in the 183351f519a2SBarry Smith fieldsplit preconditioner. If not set the matrix block size is used. 183451f519a2SBarry Smith 1835ad4df100SBarry Smith Logically Collective on PC 183651f519a2SBarry Smith 183751f519a2SBarry Smith Input Parameters: 183851f519a2SBarry Smith + pc - the preconditioner context 183951f519a2SBarry Smith - bs - the block size 184051f519a2SBarry Smith 184151f519a2SBarry Smith Level: intermediate 184251f519a2SBarry Smith 184351f519a2SBarry Smith .seealso: PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitSetFields() 184451f519a2SBarry Smith 184551f519a2SBarry Smith @*/ 18467087cfbeSBarry Smith PetscErrorCode PCFieldSplitSetBlockSize(PC pc,PetscInt bs) 184751f519a2SBarry Smith { 18484ac538c5SBarry Smith PetscErrorCode ierr; 184951f519a2SBarry Smith 185051f519a2SBarry Smith PetscFunctionBegin; 18510700a824SBarry Smith PetscValidHeaderSpecific(pc,PC_CLASSID,1); 1852c5eb9154SBarry Smith PetscValidLogicalCollectiveInt(pc,bs,2); 18534ac538c5SBarry Smith ierr = PetscTryMethod(pc,"PCFieldSplitSetBlockSize_C",(PC,PetscInt),(pc,bs));CHKERRQ(ierr); 185451f519a2SBarry Smith PetscFunctionReturn(0); 185551f519a2SBarry Smith } 185651f519a2SBarry Smith 18570971522cSBarry Smith /*@C 185869a612a9SBarry Smith PCFieldSplitGetSubKSP - Gets the KSP contexts for all splits 18590971522cSBarry Smith 186069a612a9SBarry Smith Collective on KSP 18610971522cSBarry Smith 18620971522cSBarry Smith Input Parameter: 18630971522cSBarry Smith . pc - the preconditioner context 18640971522cSBarry Smith 18650971522cSBarry Smith Output Parameters: 186613e0d083SBarry Smith + n - the number of splits 18673111de3cSBarry Smith - subksp - the array of KSP contexts 18680971522cSBarry Smith 18690971522cSBarry Smith Note: 18709a4f7e47SBarry Smith After PCFieldSplitGetSubKSP() the array of KSPs is to be freed by the user with PetscFree() 1871d32f9abdSBarry Smith (not the KSP just the array that contains them). 18720971522cSBarry Smith 1873*285fb4e2SStefano Zampini You must call PCSetUp() before calling PCFieldSplitGetSubKSP(). 1874*285fb4e2SStefano Zampini 1875*285fb4e2SStefano Zampini If the fieldsplit is of type PC_COMPOSITE_SCHUR, it returns the KSP object used inside the 1876*285fb4e2SStefano Zampini Schur complement and the KSP object used to iterate over the Schur complement. 1877*285fb4e2SStefano Zampini To access all the KSP objects used in PC_COMPOSITE_SCHUR, use PCFieldSplitSchurGetSubKSP() 18780971522cSBarry Smith 1879196cc216SBarry Smith Fortran Usage: You must pass in a KSP array that is large enough to contain all the local KSPs. 18802bf68e3eSBarry Smith You can call PCFieldSplitGetSubKSP(pc,n,PETSC_NULL_KSP,ierr) to determine how large the 1881196cc216SBarry Smith KSP array must be. 1882196cc216SBarry Smith 1883196cc216SBarry Smith 18840971522cSBarry Smith Level: advanced 18850971522cSBarry Smith 18860971522cSBarry Smith .seealso: PCFIELDSPLIT 18870971522cSBarry Smith @*/ 18887087cfbeSBarry Smith PetscErrorCode PCFieldSplitGetSubKSP(PC pc,PetscInt *n,KSP *subksp[]) 18890971522cSBarry Smith { 18904ac538c5SBarry Smith PetscErrorCode ierr; 18910971522cSBarry Smith 18920971522cSBarry Smith PetscFunctionBegin; 18930700a824SBarry Smith PetscValidHeaderSpecific(pc,PC_CLASSID,1); 189413e0d083SBarry Smith if (n) PetscValidIntPointer(n,2); 18954ac538c5SBarry Smith ierr = PetscUseMethod(pc,"PCFieldSplitGetSubKSP_C",(PC,PetscInt*,KSP **),(pc,n,subksp));CHKERRQ(ierr); 18960971522cSBarry Smith PetscFunctionReturn(0); 18970971522cSBarry Smith } 18980971522cSBarry Smith 1899*285fb4e2SStefano Zampini /*@C 1900*285fb4e2SStefano Zampini PCFieldSplitSchurGetSubKSP - Gets the KSP contexts used inside the Schur complement based PCFIELDSPLIT 1901*285fb4e2SStefano Zampini 1902*285fb4e2SStefano Zampini Collective on KSP 1903*285fb4e2SStefano Zampini 1904*285fb4e2SStefano Zampini Input Parameter: 1905*285fb4e2SStefano Zampini . pc - the preconditioner context 1906*285fb4e2SStefano Zampini 1907*285fb4e2SStefano Zampini Output Parameters: 1908*285fb4e2SStefano Zampini + n - the number of splits 1909*285fb4e2SStefano Zampini - subksp - the array of KSP contexts 1910*285fb4e2SStefano Zampini 1911*285fb4e2SStefano Zampini Note: 1912*285fb4e2SStefano Zampini After PCFieldSplitSchurGetSubKSP() the array of KSPs is to be freed by the user with PetscFree() 1913*285fb4e2SStefano Zampini (not the KSP just the array that contains them). 1914*285fb4e2SStefano Zampini 1915*285fb4e2SStefano Zampini You must call PCSetUp() before calling PCFieldSplitSchurGetSubKSP(). 1916*285fb4e2SStefano Zampini 1917*285fb4e2SStefano Zampini If the fieldsplit type is of type PC_COMPOSITE_SCHUR, it returns (in order) 1918*285fb4e2SStefano Zampini - the KSP used for the (1,1) block 1919*285fb4e2SStefano Zampini - the KSP used for the Schur complement (not the one used for the interior Schur solver) 1920*285fb4e2SStefano Zampini - the KSP used for the (1,1) block in the upper triangular factor (if different from that of the (1,1) block). 1921*285fb4e2SStefano Zampini 1922*285fb4e2SStefano Zampini It returns a null array if the fieldsplit is not of type PC_COMPOSITE_SCHUR; in this case, you should use PCFieldSplitGetSubKSP(). 1923*285fb4e2SStefano Zampini 1924*285fb4e2SStefano Zampini Fortran Usage: You must pass in a KSP array that is large enough to contain all the local KSPs. 1925*285fb4e2SStefano Zampini You can call PCFieldSplitSchurGetSubKSP(pc,n,PETSC_NULL_KSP,ierr) to determine how large the 1926*285fb4e2SStefano Zampini KSP array must be. 1927*285fb4e2SStefano Zampini 1928*285fb4e2SStefano Zampini Level: advanced 1929*285fb4e2SStefano Zampini 1930*285fb4e2SStefano Zampini .seealso: PCFIELDSPLIT 1931*285fb4e2SStefano Zampini @*/ 1932*285fb4e2SStefano Zampini PetscErrorCode PCFieldSplitSchurGetSubKSP(PC pc,PetscInt *n,KSP *subksp[]) 1933*285fb4e2SStefano Zampini { 1934*285fb4e2SStefano Zampini PetscErrorCode ierr; 1935*285fb4e2SStefano Zampini 1936*285fb4e2SStefano Zampini PetscFunctionBegin; 1937*285fb4e2SStefano Zampini PetscValidHeaderSpecific(pc,PC_CLASSID,1); 1938*285fb4e2SStefano Zampini if (n) PetscValidIntPointer(n,2); 1939*285fb4e2SStefano Zampini ierr = PetscUseMethod(pc,"PCFieldSplitSchurGetSubKSP_C",(PC,PetscInt*,KSP **),(pc,n,subksp));CHKERRQ(ierr); 1940*285fb4e2SStefano Zampini PetscFunctionReturn(0); 1941*285fb4e2SStefano Zampini } 1942*285fb4e2SStefano Zampini 1943e69d4d44SBarry Smith /*@ 194453f2277eSBarry Smith PCFieldSplitSetSchurPre - Indicates what operator is used to construct the preconditioner for the Schur complement. 1945a04f6461SBarry Smith A11 matrix. Otherwise no preconditioner is used. 1946e69d4d44SBarry Smith 1947e69d4d44SBarry Smith Collective on PC 1948e69d4d44SBarry Smith 1949e69d4d44SBarry Smith Input Parameters: 1950e69d4d44SBarry Smith + pc - the preconditioner context 19516fdd48a9SBarry 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 19526fdd48a9SBarry Smith PC_FIELDSPLIT_SCHUR_PRE_SELFP, and PC_FIELDSPLIT_SCHUR_PRE_FULL 19530298fd71SBarry Smith - userpre - matrix to use for preconditioning, or NULL 1954084e4875SJed Brown 1955e69d4d44SBarry Smith Options Database: 19566fdd48a9SBarry Smith . -pc_fieldsplit_schur_precondition <self,selfp,user,a11,full> - default is a11. See notes for meaning of various arguments 1957e69d4d44SBarry Smith 1958fd1303e9SJungho Lee Notes: 1959fd1303e9SJungho Lee $ If ptype is 1960a6a584a2SBarry Smith $ a11 then the preconditioner for the Schur complement is generated from the block diagonal part of the preconditioner 196153f2277eSBarry Smith $ matrix associated with the Schur complement (i.e. A11), not the Schur complement matrix 1962a6a584a2SBarry Smith $ self the preconditioner for the Schur complement is generated from the symbolic representation of the Schur complement matrix: 1963a6a584a2SBarry Smith $ The only preconditioner that currently works with this symbolic respresentation matrix object is the PCLSC 1964fd1303e9SJungho Lee $ preconditioner 19656fdd48a9SBarry Smith $ user then the preconditioner for the Schur complement is generated from the user provided matrix (pre argument 19666fdd48a9SBarry Smith $ to this function). 1967a6a584a2SBarry Smith $ selfp then the preconditioning for the Schur complement is generated from an explicitly-assembled approximation Sp = A11 - A10 inv(diag(A00)) A01 19681d71051fSDmitry Karpeev $ This is only a good preconditioner when diag(A00) is a good preconditioner for A00. Optionally, A00 can be 19696fdd48a9SBarry Smith $ lumped before extracting the diagonal using the additional option -fieldsplit_1_mat_schur_complement_ainv_type lump 19706fdd48a9SBarry Smith $ full then the preconditioner for the Schur complement is generated from the exact Schur complement matrix representation computed internally by PFIELDSPLIT (this is expensive) 19716fdd48a9SBarry Smith $ useful mostly as a test that the Schur complement approach can work for your problem 1972fd1303e9SJungho Lee 1973e87fab1bSBarry Smith When solving a saddle point problem, where the A11 block is identically zero, using a11 as the ptype only makes sense 1974fd1303e9SJungho Lee with the additional option -fieldsplit_1_pc_type none. Usually for saddle point problems one would use a ptype of self and 1975a7476a74SDmitry Karpeev -fieldsplit_1_pc_type lsc which uses the least squares commutator to compute a preconditioner for the Schur complement. 1976fd1303e9SJungho Lee 1977e69d4d44SBarry Smith Level: intermediate 1978e69d4d44SBarry Smith 19791d71051fSDmitry Karpeev .seealso: PCFieldSplitGetSchurPre(), PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitSetFields(), PCFieldSplitSchurPreType, 19801d71051fSDmitry Karpeev MatSchurComplementSetAinvType(), PCLSC 1981e69d4d44SBarry Smith 1982e69d4d44SBarry Smith @*/ 198329f8a81cSJed Brown PetscErrorCode PCFieldSplitSetSchurPre(PC pc,PCFieldSplitSchurPreType ptype,Mat pre) 1984e69d4d44SBarry Smith { 19854ac538c5SBarry Smith PetscErrorCode ierr; 1986e69d4d44SBarry Smith 1987e69d4d44SBarry Smith PetscFunctionBegin; 19880700a824SBarry Smith PetscValidHeaderSpecific(pc,PC_CLASSID,1); 198929f8a81cSJed Brown ierr = PetscTryMethod(pc,"PCFieldSplitSetSchurPre_C",(PC,PCFieldSplitSchurPreType,Mat),(pc,ptype,pre));CHKERRQ(ierr); 1990e69d4d44SBarry Smith PetscFunctionReturn(0); 1991e69d4d44SBarry Smith } 1992686bed4dSStefano Zampini 199329f8a81cSJed Brown PetscErrorCode PCFieldSplitSchurPrecondition(PC pc,PCFieldSplitSchurPreType ptype,Mat pre) {return PCFieldSplitSetSchurPre(pc,ptype,pre);} /* Deprecated name */ 1994e69d4d44SBarry Smith 199537a82bf0SJed Brown /*@ 199637a82bf0SJed Brown PCFieldSplitGetSchurPre - For Schur complement fieldsplit, determine how the Schur complement will be 199729f8a81cSJed Brown preconditioned. See PCFieldSplitSetSchurPre() for details. 199837a82bf0SJed Brown 199937a82bf0SJed Brown Logically Collective on PC 200037a82bf0SJed Brown 200137a82bf0SJed Brown Input Parameters: 200237a82bf0SJed Brown . pc - the preconditioner context 200337a82bf0SJed Brown 200437a82bf0SJed Brown Output Parameters: 200537a82bf0SJed 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 200637a82bf0SJed Brown - userpre - matrix to use for preconditioning (with PC_FIELDSPLIT_PRE_USER), or NULL 200737a82bf0SJed Brown 200837a82bf0SJed Brown Level: intermediate 200937a82bf0SJed Brown 201029f8a81cSJed Brown .seealso: PCFieldSplitSetSchurPre(), PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitSetFields(), PCFieldSplitSchurPreType, PCLSC 201137a82bf0SJed Brown 201237a82bf0SJed Brown @*/ 201337a82bf0SJed Brown PetscErrorCode PCFieldSplitGetSchurPre(PC pc,PCFieldSplitSchurPreType *ptype,Mat *pre) 201437a82bf0SJed Brown { 201537a82bf0SJed Brown PetscErrorCode ierr; 201637a82bf0SJed Brown 201737a82bf0SJed Brown PetscFunctionBegin; 201837a82bf0SJed Brown PetscValidHeaderSpecific(pc,PC_CLASSID,1); 201937a82bf0SJed Brown ierr = PetscUseMethod(pc,"PCFieldSplitGetSchurPre_C",(PC,PCFieldSplitSchurPreType*,Mat*),(pc,ptype,pre));CHKERRQ(ierr); 2020e69d4d44SBarry Smith PetscFunctionReturn(0); 2021e69d4d44SBarry Smith } 2022e69d4d44SBarry Smith 202345e7fc46SDmitry Karpeev /*@ 2024470b340bSDmitry Karpeev PCFieldSplitSchurGetS - extract the MatSchurComplement object used by this PC in case it needs to be configured separately 202545e7fc46SDmitry Karpeev 202645e7fc46SDmitry Karpeev Not collective 202745e7fc46SDmitry Karpeev 202845e7fc46SDmitry Karpeev Input Parameter: 202945e7fc46SDmitry Karpeev . pc - the preconditioner context 203045e7fc46SDmitry Karpeev 203145e7fc46SDmitry Karpeev Output Parameter: 2032470b340bSDmitry Karpeev . S - the Schur complement matrix 203345e7fc46SDmitry Karpeev 2034470b340bSDmitry Karpeev Notes: 2035470b340bSDmitry Karpeev This matrix should not be destroyed using MatDestroy(); rather, use PCFieldSplitSchurRestoreS(). 203645e7fc46SDmitry Karpeev 203745e7fc46SDmitry Karpeev Level: advanced 203845e7fc46SDmitry Karpeev 203929f8a81cSJed Brown .seealso: PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitSchurPreType, PCFieldSplitSetSchurPre(), MatSchurComplement, PCFieldSplitSchurRestoreS() 204045e7fc46SDmitry Karpeev 204145e7fc46SDmitry Karpeev @*/ 2042470b340bSDmitry Karpeev PetscErrorCode PCFieldSplitSchurGetS(PC pc,Mat *S) 204345e7fc46SDmitry Karpeev { 204445e7fc46SDmitry Karpeev PetscErrorCode ierr; 204545e7fc46SDmitry Karpeev const char* t; 204645e7fc46SDmitry Karpeev PetscBool isfs; 204745e7fc46SDmitry Karpeev PC_FieldSplit *jac; 204845e7fc46SDmitry Karpeev 204945e7fc46SDmitry Karpeev PetscFunctionBegin; 205045e7fc46SDmitry Karpeev PetscValidHeaderSpecific(pc,PC_CLASSID,1); 205145e7fc46SDmitry Karpeev ierr = PetscObjectGetType((PetscObject)pc,&t);CHKERRQ(ierr); 205245e7fc46SDmitry Karpeev ierr = PetscStrcmp(t,PCFIELDSPLIT,&isfs);CHKERRQ(ierr); 205345e7fc46SDmitry Karpeev if (!isfs) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Expected PC of type PCFIELDSPLIT, got %s instead",t); 205445e7fc46SDmitry Karpeev jac = (PC_FieldSplit*)pc->data; 2055470b340bSDmitry 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); 2056470b340bSDmitry Karpeev if (S) *S = jac->schur; 205745e7fc46SDmitry Karpeev PetscFunctionReturn(0); 205845e7fc46SDmitry Karpeev } 205945e7fc46SDmitry Karpeev 2060470b340bSDmitry Karpeev /*@ 2061470b340bSDmitry Karpeev PCFieldSplitSchurRestoreS - restores the MatSchurComplement object used by this PC 2062470b340bSDmitry Karpeev 2063470b340bSDmitry Karpeev Not collective 2064470b340bSDmitry Karpeev 2065470b340bSDmitry Karpeev Input Parameters: 2066470b340bSDmitry Karpeev + pc - the preconditioner context 2067470b340bSDmitry Karpeev . S - the Schur complement matrix 2068470b340bSDmitry Karpeev 2069470b340bSDmitry Karpeev Level: advanced 2070470b340bSDmitry Karpeev 207129f8a81cSJed Brown .seealso: PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitSchurPreType, PCFieldSplitSetSchurPre(), MatSchurComplement, PCFieldSplitSchurGetS() 2072470b340bSDmitry Karpeev 2073470b340bSDmitry Karpeev @*/ 2074bca69d2bSDmitry Karpeev PetscErrorCode PCFieldSplitSchurRestoreS(PC pc,Mat *S) 2075470b340bSDmitry Karpeev { 2076470b340bSDmitry Karpeev PetscErrorCode ierr; 2077470b340bSDmitry Karpeev const char* t; 2078470b340bSDmitry Karpeev PetscBool isfs; 2079470b340bSDmitry Karpeev PC_FieldSplit *jac; 2080470b340bSDmitry Karpeev 2081470b340bSDmitry Karpeev PetscFunctionBegin; 2082470b340bSDmitry Karpeev PetscValidHeaderSpecific(pc,PC_CLASSID,1); 2083470b340bSDmitry Karpeev ierr = PetscObjectGetType((PetscObject)pc,&t);CHKERRQ(ierr); 2084470b340bSDmitry Karpeev ierr = PetscStrcmp(t,PCFIELDSPLIT,&isfs);CHKERRQ(ierr); 2085470b340bSDmitry Karpeev if (!isfs) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Expected PC of type PCFIELDSPLIT, got %s instead",t); 2086470b340bSDmitry Karpeev jac = (PC_FieldSplit*)pc->data; 2087470b340bSDmitry 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); 2088bca69d2bSDmitry Karpeev if (!S || *S != jac->schur) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"MatSchurComplement restored is not the same as gotten"); 2089470b340bSDmitry Karpeev PetscFunctionReturn(0); 2090470b340bSDmitry Karpeev } 2091470b340bSDmitry Karpeev 2092470b340bSDmitry Karpeev 209329f8a81cSJed Brown static PetscErrorCode PCFieldSplitSetSchurPre_FieldSplit(PC pc,PCFieldSplitSchurPreType ptype,Mat pre) 2094e69d4d44SBarry Smith { 2095e69d4d44SBarry Smith PC_FieldSplit *jac = (PC_FieldSplit*)pc->data; 2096084e4875SJed Brown PetscErrorCode ierr; 2097e69d4d44SBarry Smith 2098e69d4d44SBarry Smith PetscFunctionBegin; 2099084e4875SJed Brown jac->schurpre = ptype; 2100a7476a74SDmitry Karpeev if (ptype == PC_FIELDSPLIT_SCHUR_PRE_USER && pre) { 21016bf464f9SBarry Smith ierr = MatDestroy(&jac->schur_user);CHKERRQ(ierr); 2102084e4875SJed Brown jac->schur_user = pre; 2103084e4875SJed Brown ierr = PetscObjectReference((PetscObject)jac->schur_user);CHKERRQ(ierr); 2104084e4875SJed Brown } 2105e69d4d44SBarry Smith PetscFunctionReturn(0); 2106e69d4d44SBarry Smith } 2107e69d4d44SBarry Smith 210837a82bf0SJed Brown static PetscErrorCode PCFieldSplitGetSchurPre_FieldSplit(PC pc,PCFieldSplitSchurPreType *ptype,Mat *pre) 210937a82bf0SJed Brown { 211037a82bf0SJed Brown PC_FieldSplit *jac = (PC_FieldSplit*)pc->data; 211137a82bf0SJed Brown 211237a82bf0SJed Brown PetscFunctionBegin; 211337a82bf0SJed Brown *ptype = jac->schurpre; 211437a82bf0SJed Brown *pre = jac->schur_user; 211537a82bf0SJed Brown PetscFunctionReturn(0); 211637a82bf0SJed Brown } 211737a82bf0SJed Brown 2118ab1df9f5SJed Brown /*@ 21190ffb0e17SBarry Smith PCFieldSplitSetSchurFactType - sets which blocks of the approximate block factorization to retain in the preconditioner 2120ab1df9f5SJed Brown 2121ab1df9f5SJed Brown Collective on PC 2122ab1df9f5SJed Brown 2123ab1df9f5SJed Brown Input Parameters: 2124ab1df9f5SJed Brown + pc - the preconditioner context 2125c9c6ffaaSJed Brown - ftype - which blocks of factorization to retain, PC_FIELDSPLIT_SCHUR_FACT_FULL is default 2126ab1df9f5SJed Brown 2127ab1df9f5SJed Brown Options Database: 2128c9c6ffaaSJed Brown . -pc_fieldsplit_schur_fact_type <diag,lower,upper,full> default is full 2129ab1df9f5SJed Brown 2130ab1df9f5SJed Brown 2131ab1df9f5SJed Brown Level: intermediate 2132ab1df9f5SJed Brown 2133ab1df9f5SJed Brown Notes: 2134ab1df9f5SJed Brown The FULL factorization is 2135ab1df9f5SJed Brown 21360ffb0e17SBarry Smith $ (A B) = (1 0) (A 0) (1 Ainv*B) = L D U 21370ffb0e17SBarry Smith $ (C E) (C*Ainv 1) (0 S) (0 1 ) 2138ab1df9f5SJed Brown 21390ffb0e17SBarry 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, 2140c096484dSStefano 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(). 2141ab1df9f5SJed Brown 21420ffb0e17SBarry Smith $ If A and S are solved exactly 21430ffb0e17SBarry Smith $ *) FULL factorization is a direct solver. 21440ffb0e17SBarry 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. 21450ffb0e17SBarry 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. 2146ab1df9f5SJed Brown 21470ffb0e17SBarry Smith If the iteration count is very low, consider using KSPFGMRES or KSPGCR which can use one less preconditioner 21480ffb0e17SBarry 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. 21490ffb0e17SBarry Smith 21500ffb0e17SBarry Smith For symmetric problems in which A is positive definite and S is negative definite, DIAG can be used with KSPMINRES. 21510ffb0e17SBarry Smith 21520ffb0e17SBarry 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). 2153ab1df9f5SJed Brown 2154ab1df9f5SJed Brown References: 215596a0c994SBarry Smith + 1. - Murphy, Golub, and Wathen, A note on preconditioning indefinite linear systems, SIAM J. Sci. Comput., 21 (2000). 215696a0c994SBarry Smith - 2. - Ipsen, A note on preconditioning nonsymmetric matrices, SIAM J. Sci. Comput., 23 (2001). 2157ab1df9f5SJed Brown 2158c096484dSStefano Zampini .seealso: PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitSetFields(), PCFieldSplitSchurPreType, PCFieldSplitSetSchurScale() 2159ab1df9f5SJed Brown @*/ 2160c9c6ffaaSJed Brown PetscErrorCode PCFieldSplitSetSchurFactType(PC pc,PCFieldSplitSchurFactType ftype) 2161ab1df9f5SJed Brown { 2162ab1df9f5SJed Brown PetscErrorCode ierr; 2163ab1df9f5SJed Brown 2164ab1df9f5SJed Brown PetscFunctionBegin; 2165ab1df9f5SJed Brown PetscValidHeaderSpecific(pc,PC_CLASSID,1); 2166c9c6ffaaSJed Brown ierr = PetscTryMethod(pc,"PCFieldSplitSetSchurFactType_C",(PC,PCFieldSplitSchurFactType),(pc,ftype));CHKERRQ(ierr); 2167ab1df9f5SJed Brown PetscFunctionReturn(0); 2168ab1df9f5SJed Brown } 2169ab1df9f5SJed Brown 21701e6b0712SBarry Smith static PetscErrorCode PCFieldSplitSetSchurFactType_FieldSplit(PC pc,PCFieldSplitSchurFactType ftype) 2171ab1df9f5SJed Brown { 2172ab1df9f5SJed Brown PC_FieldSplit *jac = (PC_FieldSplit*)pc->data; 2173ab1df9f5SJed Brown 2174ab1df9f5SJed Brown PetscFunctionBegin; 2175ab1df9f5SJed Brown jac->schurfactorization = ftype; 2176ab1df9f5SJed Brown PetscFunctionReturn(0); 2177ab1df9f5SJed Brown } 2178ab1df9f5SJed Brown 2179c096484dSStefano Zampini /*@ 2180c096484dSStefano Zampini PCFieldSplitSetSchurScale - Controls the sign flip of S for PC_FIELDSPLIT_SCHUR_FACT_DIAG. 2181c096484dSStefano Zampini 2182c096484dSStefano Zampini Collective on PC 2183c096484dSStefano Zampini 2184c096484dSStefano Zampini Input Parameters: 2185c096484dSStefano Zampini + pc - the preconditioner context 2186c096484dSStefano Zampini - scale - scaling factor for the Schur complement 2187c096484dSStefano Zampini 2188c096484dSStefano Zampini Options Database: 2189c096484dSStefano Zampini . -pc_fieldsplit_schur_scale - default is -1.0 2190c096484dSStefano Zampini 2191c096484dSStefano Zampini Level: intermediate 2192c096484dSStefano Zampini 2193c096484dSStefano Zampini .seealso: PCFIELDSPLIT, PCFieldSplitSetFields(), PCFieldSplitSchurFactType, PCFieldSplitSetSchurScale() 2194c096484dSStefano Zampini @*/ 2195c096484dSStefano Zampini PetscErrorCode PCFieldSplitSetSchurScale(PC pc,PetscScalar scale) 2196c096484dSStefano Zampini { 2197c096484dSStefano Zampini PetscErrorCode ierr; 2198c096484dSStefano Zampini 2199c096484dSStefano Zampini PetscFunctionBegin; 2200c096484dSStefano Zampini PetscValidHeaderSpecific(pc,PC_CLASSID,1); 2201c096484dSStefano Zampini PetscValidLogicalCollectiveScalar(pc,scale,2); 2202c096484dSStefano Zampini ierr = PetscTryMethod(pc,"PCFieldSplitSetSchurScale_C",(PC,PetscScalar),(pc,scale));CHKERRQ(ierr); 2203c096484dSStefano Zampini PetscFunctionReturn(0); 2204c096484dSStefano Zampini } 2205c096484dSStefano Zampini 2206c096484dSStefano Zampini static PetscErrorCode PCFieldSplitSetSchurScale_FieldSplit(PC pc,PetscScalar scale) 2207c096484dSStefano Zampini { 2208c096484dSStefano Zampini PC_FieldSplit *jac = (PC_FieldSplit*)pc->data; 2209c096484dSStefano Zampini 2210c096484dSStefano Zampini PetscFunctionBegin; 2211c096484dSStefano Zampini jac->schurscale = scale; 2212c096484dSStefano Zampini PetscFunctionReturn(0); 2213c096484dSStefano Zampini } 2214c096484dSStefano Zampini 221530ad9308SMatthew Knepley /*@C 22168c03b21aSDmitry Karpeev PCFieldSplitGetSchurBlocks - Gets all matrix blocks for the Schur complement 221730ad9308SMatthew Knepley 221830ad9308SMatthew Knepley Collective on KSP 221930ad9308SMatthew Knepley 222030ad9308SMatthew Knepley Input Parameter: 222130ad9308SMatthew Knepley . pc - the preconditioner context 222230ad9308SMatthew Knepley 222330ad9308SMatthew Knepley Output Parameters: 2224a04f6461SBarry Smith + A00 - the (0,0) block 2225a04f6461SBarry Smith . A01 - the (0,1) block 2226a04f6461SBarry Smith . A10 - the (1,0) block 2227a04f6461SBarry Smith - A11 - the (1,1) block 222830ad9308SMatthew Knepley 222930ad9308SMatthew Knepley Level: advanced 223030ad9308SMatthew Knepley 223130ad9308SMatthew Knepley .seealso: PCFIELDSPLIT 223230ad9308SMatthew Knepley @*/ 2233a04f6461SBarry Smith PetscErrorCode PCFieldSplitGetSchurBlocks(PC pc,Mat *A00,Mat *A01,Mat *A10, Mat *A11) 223430ad9308SMatthew Knepley { 223530ad9308SMatthew Knepley PC_FieldSplit *jac = (PC_FieldSplit*) pc->data; 223630ad9308SMatthew Knepley 223730ad9308SMatthew Knepley PetscFunctionBegin; 22380700a824SBarry Smith PetscValidHeaderSpecific(pc,PC_CLASSID,1); 2239ce94432eSBarry Smith if (jac->type != PC_COMPOSITE_SCHUR) SETERRQ(PetscObjectComm((PetscObject)pc),PETSC_ERR_ARG_WRONG, "FieldSplit is not using a Schur complement approach."); 2240a04f6461SBarry Smith if (A00) *A00 = jac->pmat[0]; 2241a04f6461SBarry Smith if (A01) *A01 = jac->B; 2242a04f6461SBarry Smith if (A10) *A10 = jac->C; 2243a04f6461SBarry Smith if (A11) *A11 = jac->pmat[1]; 224430ad9308SMatthew Knepley PetscFunctionReturn(0); 224530ad9308SMatthew Knepley } 224630ad9308SMatthew Knepley 22471e6b0712SBarry Smith static PetscErrorCode PCFieldSplitSetType_FieldSplit(PC pc,PCCompositeType type) 224879416396SBarry Smith { 224979416396SBarry Smith PC_FieldSplit *jac = (PC_FieldSplit*)pc->data; 2250e69d4d44SBarry Smith PetscErrorCode ierr; 225179416396SBarry Smith 225279416396SBarry Smith PetscFunctionBegin; 225379416396SBarry Smith jac->type = type; 22543b224e63SBarry Smith if (type == PC_COMPOSITE_SCHUR) { 22553b224e63SBarry Smith pc->ops->apply = PCApply_FieldSplit_Schur; 22563b224e63SBarry Smith pc->ops->view = PCView_FieldSplit_Schur; 22572fa5cd67SKarl Rupp 2258bdf89e91SBarry Smith ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitGetSubKSP_C",PCFieldSplitGetSubKSP_FieldSplit_Schur);CHKERRQ(ierr); 225929f8a81cSJed Brown ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetSchurPre_C",PCFieldSplitSetSchurPre_FieldSplit);CHKERRQ(ierr); 226037a82bf0SJed Brown ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitGetSchurPre_C",PCFieldSplitGetSchurPre_FieldSplit);CHKERRQ(ierr); 2261bdf89e91SBarry Smith ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetSchurFactType_C",PCFieldSplitSetSchurFactType_FieldSplit);CHKERRQ(ierr); 2262c096484dSStefano Zampini ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetSchurScale_C",PCFieldSplitSetSchurScale_FieldSplit);CHKERRQ(ierr); 2263e69d4d44SBarry Smith 22643b224e63SBarry Smith } else { 22653b224e63SBarry Smith pc->ops->apply = PCApply_FieldSplit; 22663b224e63SBarry Smith pc->ops->view = PCView_FieldSplit; 22672fa5cd67SKarl Rupp 2268bdf89e91SBarry Smith ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitGetSubKSP_C",PCFieldSplitGetSubKSP_FieldSplit);CHKERRQ(ierr); 226929f8a81cSJed Brown ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetSchurPre_C",0);CHKERRQ(ierr); 227037a82bf0SJed Brown ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitGetSchurPre_C",0);CHKERRQ(ierr); 2271bdf89e91SBarry Smith ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetSchurFactType_C",0);CHKERRQ(ierr); 2272c096484dSStefano Zampini ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetSchurScale_C",0);CHKERRQ(ierr); 22733b224e63SBarry Smith } 227479416396SBarry Smith PetscFunctionReturn(0); 227579416396SBarry Smith } 227679416396SBarry Smith 22771e6b0712SBarry Smith static PetscErrorCode PCFieldSplitSetBlockSize_FieldSplit(PC pc,PetscInt bs) 227851f519a2SBarry Smith { 227951f519a2SBarry Smith PC_FieldSplit *jac = (PC_FieldSplit*)pc->data; 228051f519a2SBarry Smith 228151f519a2SBarry Smith PetscFunctionBegin; 2282ce94432eSBarry Smith if (bs < 1) SETERRQ1(PetscObjectComm((PetscObject)pc),PETSC_ERR_ARG_OUTOFRANGE,"Blocksize must be positive, you gave %D",bs); 2283ce94432eSBarry 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); 228451f519a2SBarry Smith jac->bs = bs; 228551f519a2SBarry Smith PetscFunctionReturn(0); 228651f519a2SBarry Smith } 228751f519a2SBarry Smith 2288bc08b0f1SBarry Smith /*@ 228979416396SBarry Smith PCFieldSplitSetType - Sets the type of fieldsplit preconditioner. 229079416396SBarry Smith 229179416396SBarry Smith Collective on PC 229279416396SBarry Smith 229379416396SBarry Smith Input Parameter: 229479416396SBarry Smith . pc - the preconditioner context 229581540f2fSBarry Smith . type - PC_COMPOSITE_ADDITIVE, PC_COMPOSITE_MULTIPLICATIVE (default), PC_COMPOSITE_SYMMETRIC_MULTIPLICATIVE, PC_COMPOSITE_SPECIAL, PC_COMPOSITE_SCHUR 229679416396SBarry Smith 229779416396SBarry Smith Options Database Key: 2298a4efd8eaSMatthew Knepley . -pc_fieldsplit_type <type: one of multiplicative, additive, symmetric_multiplicative, special, schur> - Sets fieldsplit preconditioner type 229979416396SBarry Smith 2300b02e2d75SMatthew G Knepley Level: Intermediate 230179416396SBarry Smith 230279416396SBarry Smith .keywords: PC, set, type, composite preconditioner, additive, multiplicative 230379416396SBarry Smith 230479416396SBarry Smith .seealso: PCCompositeSetType() 230579416396SBarry Smith 230679416396SBarry Smith @*/ 23077087cfbeSBarry Smith PetscErrorCode PCFieldSplitSetType(PC pc,PCCompositeType type) 230879416396SBarry Smith { 23094ac538c5SBarry Smith PetscErrorCode ierr; 231079416396SBarry Smith 231179416396SBarry Smith PetscFunctionBegin; 23120700a824SBarry Smith PetscValidHeaderSpecific(pc,PC_CLASSID,1); 23134ac538c5SBarry Smith ierr = PetscTryMethod(pc,"PCFieldSplitSetType_C",(PC,PCCompositeType),(pc,type));CHKERRQ(ierr); 231479416396SBarry Smith PetscFunctionReturn(0); 231579416396SBarry Smith } 231679416396SBarry Smith 2317b02e2d75SMatthew G Knepley /*@ 2318b02e2d75SMatthew G Knepley PCFieldSplitGetType - Gets the type of fieldsplit preconditioner. 2319b02e2d75SMatthew G Knepley 2320b02e2d75SMatthew G Knepley Not collective 2321b02e2d75SMatthew G Knepley 2322b02e2d75SMatthew G Knepley Input Parameter: 2323b02e2d75SMatthew G Knepley . pc - the preconditioner context 2324b02e2d75SMatthew G Knepley 2325b02e2d75SMatthew G Knepley Output Parameter: 2326b02e2d75SMatthew G Knepley . type - PC_COMPOSITE_ADDITIVE, PC_COMPOSITE_MULTIPLICATIVE (default), PC_COMPOSITE_SYMMETRIC_MULTIPLICATIVE, PC_COMPOSITE_SPECIAL, PC_COMPOSITE_SCHUR 2327b02e2d75SMatthew G Knepley 2328b02e2d75SMatthew G Knepley Level: Intermediate 2329b02e2d75SMatthew G Knepley 2330b02e2d75SMatthew G Knepley .keywords: PC, set, type, composite preconditioner, additive, multiplicative 2331b02e2d75SMatthew G Knepley .seealso: PCCompositeSetType() 2332b02e2d75SMatthew G Knepley @*/ 2333b02e2d75SMatthew G Knepley PetscErrorCode PCFieldSplitGetType(PC pc, PCCompositeType *type) 2334b02e2d75SMatthew G Knepley { 2335b02e2d75SMatthew G Knepley PC_FieldSplit *jac = (PC_FieldSplit*) pc->data; 2336b02e2d75SMatthew G Knepley 2337b02e2d75SMatthew G Knepley PetscFunctionBegin; 2338b02e2d75SMatthew G Knepley PetscValidHeaderSpecific(pc,PC_CLASSID,1); 2339b02e2d75SMatthew G Knepley PetscValidIntPointer(type,2); 2340b02e2d75SMatthew G Knepley *type = jac->type; 2341b02e2d75SMatthew G Knepley PetscFunctionReturn(0); 2342b02e2d75SMatthew G Knepley } 2343b02e2d75SMatthew G Knepley 23444ab8060aSDmitry Karpeev /*@ 23454ab8060aSDmitry Karpeev PCFieldSplitSetDMSplits - Flags whether DMCreateFieldDecomposition() should be used to define the splits, whenever possible. 23464ab8060aSDmitry Karpeev 23474ab8060aSDmitry Karpeev Logically Collective 23484ab8060aSDmitry Karpeev 23494ab8060aSDmitry Karpeev Input Parameters: 23504ab8060aSDmitry Karpeev + pc - the preconditioner context 23514ab8060aSDmitry Karpeev - flg - boolean indicating whether to use field splits defined by the DM 23524ab8060aSDmitry Karpeev 23534ab8060aSDmitry Karpeev Options Database Key: 23544ab8060aSDmitry Karpeev . -pc_fieldsplit_dm_splits 23554ab8060aSDmitry Karpeev 23564ab8060aSDmitry Karpeev Level: Intermediate 23574ab8060aSDmitry Karpeev 23584ab8060aSDmitry Karpeev .keywords: PC, DM, composite preconditioner, additive, multiplicative 23594ab8060aSDmitry Karpeev 23604ab8060aSDmitry Karpeev .seealso: PCFieldSplitGetDMSplits() 23614ab8060aSDmitry Karpeev 23624ab8060aSDmitry Karpeev @*/ 23634ab8060aSDmitry Karpeev PetscErrorCode PCFieldSplitSetDMSplits(PC pc,PetscBool flg) 23644ab8060aSDmitry Karpeev { 23654ab8060aSDmitry Karpeev PC_FieldSplit *jac = (PC_FieldSplit*)pc->data; 23664ab8060aSDmitry Karpeev PetscBool isfs; 23674ab8060aSDmitry Karpeev PetscErrorCode ierr; 23684ab8060aSDmitry Karpeev 23694ab8060aSDmitry Karpeev PetscFunctionBegin; 23704ab8060aSDmitry Karpeev PetscValidHeaderSpecific(pc,PC_CLASSID,1); 23714ab8060aSDmitry Karpeev PetscValidLogicalCollectiveBool(pc,flg,2); 23724ab8060aSDmitry Karpeev ierr = PetscObjectTypeCompare((PetscObject)pc,PCFIELDSPLIT,&isfs);CHKERRQ(ierr); 23734ab8060aSDmitry Karpeev if (isfs) { 23744ab8060aSDmitry Karpeev jac->dm_splits = flg; 23754ab8060aSDmitry Karpeev } 23764ab8060aSDmitry Karpeev PetscFunctionReturn(0); 23774ab8060aSDmitry Karpeev } 23784ab8060aSDmitry Karpeev 23794ab8060aSDmitry Karpeev 23804ab8060aSDmitry Karpeev /*@ 23814ab8060aSDmitry Karpeev PCFieldSplitGetDMSplits - Returns flag indicating whether DMCreateFieldDecomposition() should be used to define the splits, whenever possible. 23824ab8060aSDmitry Karpeev 23834ab8060aSDmitry Karpeev Logically Collective 23844ab8060aSDmitry Karpeev 23854ab8060aSDmitry Karpeev Input Parameter: 23864ab8060aSDmitry Karpeev . pc - the preconditioner context 23874ab8060aSDmitry Karpeev 23884ab8060aSDmitry Karpeev Output Parameter: 23894ab8060aSDmitry Karpeev . flg - boolean indicating whether to use field splits defined by the DM 23904ab8060aSDmitry Karpeev 23914ab8060aSDmitry Karpeev Level: Intermediate 23924ab8060aSDmitry Karpeev 23934ab8060aSDmitry Karpeev .keywords: PC, DM, composite preconditioner, additive, multiplicative 23944ab8060aSDmitry Karpeev 23954ab8060aSDmitry Karpeev .seealso: PCFieldSplitSetDMSplits() 23964ab8060aSDmitry Karpeev 23974ab8060aSDmitry Karpeev @*/ 23984ab8060aSDmitry Karpeev PetscErrorCode PCFieldSplitGetDMSplits(PC pc,PetscBool* flg) 23994ab8060aSDmitry Karpeev { 24004ab8060aSDmitry Karpeev PC_FieldSplit *jac = (PC_FieldSplit*)pc->data; 24014ab8060aSDmitry Karpeev PetscBool isfs; 24024ab8060aSDmitry Karpeev PetscErrorCode ierr; 24034ab8060aSDmitry Karpeev 24044ab8060aSDmitry Karpeev PetscFunctionBegin; 24054ab8060aSDmitry Karpeev PetscValidHeaderSpecific(pc,PC_CLASSID,1); 24064ab8060aSDmitry Karpeev PetscValidPointer(flg,2); 24074ab8060aSDmitry Karpeev ierr = PetscObjectTypeCompare((PetscObject)pc,PCFIELDSPLIT,&isfs);CHKERRQ(ierr); 24084ab8060aSDmitry Karpeev if (isfs) { 24094ab8060aSDmitry Karpeev if(flg) *flg = jac->dm_splits; 24104ab8060aSDmitry Karpeev } 24114ab8060aSDmitry Karpeev PetscFunctionReturn(0); 24124ab8060aSDmitry Karpeev } 24134ab8060aSDmitry Karpeev 24147b752e3dSPatrick Sanan /*@ 24157b752e3dSPatrick Sanan PCFieldSplitGetDetectSaddlePoint - Returns flag indicating whether PCFieldSplit will attempt to automatically determine fields based on zero diagonal entries. 24167b752e3dSPatrick Sanan 24177b752e3dSPatrick Sanan Logically Collective 24187b752e3dSPatrick Sanan 24197b752e3dSPatrick Sanan Input Parameter: 24207b752e3dSPatrick Sanan . pc - the preconditioner context 24217b752e3dSPatrick Sanan 24227b752e3dSPatrick Sanan Output Parameter: 24237b752e3dSPatrick Sanan . flg - boolean indicating whether to detect fields or not 24247b752e3dSPatrick Sanan 24257b752e3dSPatrick Sanan Level: Intermediate 24267b752e3dSPatrick Sanan 24277b752e3dSPatrick Sanan .seealso: PCFIELDSPLIT, PCFieldSplitSetDetectSaddlePoint() 24287b752e3dSPatrick Sanan 24297b752e3dSPatrick Sanan @*/ 24307b752e3dSPatrick Sanan PetscErrorCode PCFieldSplitGetDetectSaddlePoint(PC pc,PetscBool *flg) 24317b752e3dSPatrick Sanan { 24327b752e3dSPatrick Sanan PC_FieldSplit *jac = (PC_FieldSplit*)pc->data; 24337b752e3dSPatrick Sanan 24347b752e3dSPatrick Sanan PetscFunctionBegin; 24357b752e3dSPatrick Sanan *flg = jac->detect; 24367b752e3dSPatrick Sanan PetscFunctionReturn(0); 24377b752e3dSPatrick Sanan } 24387b752e3dSPatrick Sanan 24397b752e3dSPatrick Sanan /*@ 24407b752e3dSPatrick Sanan PCFieldSplitSetDetectSaddlePoint - Sets 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 Notes: 24457b752e3dSPatrick 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()). 24467b752e3dSPatrick Sanan 24477b752e3dSPatrick Sanan Input Parameter: 24487b752e3dSPatrick Sanan . pc - the preconditioner context 24497b752e3dSPatrick Sanan 24507b752e3dSPatrick Sanan Output Parameter: 24517b752e3dSPatrick Sanan . flg - boolean indicating whether to detect fields or not 24527b752e3dSPatrick Sanan 24537b752e3dSPatrick Sanan Options Database Key: 24547b752e3dSPatrick Sanan . -pc_fieldsplit_detect_saddle_point 24557b752e3dSPatrick Sanan 24567b752e3dSPatrick Sanan Level: Intermediate 24577b752e3dSPatrick Sanan 24587b752e3dSPatrick Sanan .seealso: PCFIELDSPLIT, PCFieldSplitSetDetectSaddlePoint(), PCFieldSplitSetType(), PCFieldSplitSetSchurPre() 24597b752e3dSPatrick Sanan 24607b752e3dSPatrick Sanan @*/ 24617b752e3dSPatrick Sanan PetscErrorCode PCFieldSplitSetDetectSaddlePoint(PC pc,PetscBool flg) 24627b752e3dSPatrick Sanan { 24637b752e3dSPatrick Sanan PC_FieldSplit *jac = (PC_FieldSplit*)pc->data; 24647b752e3dSPatrick Sanan PetscErrorCode ierr; 24657b752e3dSPatrick Sanan 24667b752e3dSPatrick Sanan PetscFunctionBegin; 24677b752e3dSPatrick Sanan jac->detect = flg; 24687b752e3dSPatrick Sanan if (jac->detect) { 24697b752e3dSPatrick Sanan ierr = PCFieldSplitSetType(pc,PC_COMPOSITE_SCHUR);CHKERRQ(ierr); 24707b752e3dSPatrick Sanan ierr = PCFieldSplitSetSchurPre(pc,PC_FIELDSPLIT_SCHUR_PRE_SELF,NULL);CHKERRQ(ierr); 24717b752e3dSPatrick Sanan } 24727b752e3dSPatrick Sanan PetscFunctionReturn(0); 24737b752e3dSPatrick Sanan } 24747b752e3dSPatrick Sanan 24750971522cSBarry Smith /* -------------------------------------------------------------------------------------*/ 24760971522cSBarry Smith /*MC 2477a8c7a070SBarry Smith PCFIELDSPLIT - Preconditioner created by combining separate preconditioners for individual 2478a04f6461SBarry Smith fields or groups of fields. See the users manual section "Solving Block Matrices" for more details. 24790971522cSBarry Smith 2480edf189efSBarry Smith To set options on the solvers for each block append -fieldsplit_ to all the PC 2481edf189efSBarry Smith options database keys. For example, -fieldsplit_pc_type ilu -fieldsplit_pc_factor_levels 1 24820971522cSBarry Smith 2483a8c7a070SBarry Smith To set the options on the solvers separate for each block call PCFieldSplitGetSubKSP() 248469a612a9SBarry Smith and set the options directly on the resulting KSP object 24850971522cSBarry Smith 24860971522cSBarry Smith Level: intermediate 24870971522cSBarry Smith 248879416396SBarry Smith Options Database Keys: 248981540f2fSBarry Smith + -pc_fieldsplit_%d_fields <a,b,..> - indicates the fields to be used in the %d'th split 249081540f2fSBarry Smith . -pc_fieldsplit_default - automatically add any fields to additional splits that have not 249181540f2fSBarry Smith been supplied explicitly by -pc_fieldsplit_%d_fields 249281540f2fSBarry Smith . -pc_fieldsplit_block_size <bs> - size of block that defines fields (i.e. there are bs fields) 24930f188ba9SJed Brown . -pc_fieldsplit_type <additive,multiplicative,symmetric_multiplicative,schur> - type of relaxation or factorization splitting 2494a6a584a2SBarry Smith . -pc_fieldsplit_schur_precondition <self,selfp,user,a11,full> - default is a11; see PCFieldSplitSetSchurPre() 24957b752e3dSPatrick Sanan . -pc_fieldsplit_detect_saddle_point - automatically finds rows with zero diagonal and uses Schur complement with no preconditioner as the solver 249679416396SBarry Smith 24975d4c12cdSJungho Lee - Options prefix for inner solvers when using Schur complement preconditioner are -fieldsplit_0_ and -fieldsplit_1_ 24985d4c12cdSJungho Lee for all other solvers they are -fieldsplit_%d_ for the dth field, use -fieldsplit_ for all fields 24995d4c12cdSJungho Lee 2500c8a0d604SMatthew G Knepley Notes: 2501c8a0d604SMatthew G Knepley Use PCFieldSplitSetFields() to set fields defined by "strided" entries and PCFieldSplitSetIS() 2502d32f9abdSBarry Smith to define a field by an arbitrary collection of entries. 2503d32f9abdSBarry Smith 2504d32f9abdSBarry Smith If no fields are set the default is used. The fields are defined by entries strided by bs, 2505d32f9abdSBarry Smith beginning at 0 then 1, etc to bs-1. The block size can be set with PCFieldSplitSetBlockSize(), 2506d32f9abdSBarry Smith if this is not called the block size defaults to the blocksize of the second matrix passed 2507d32f9abdSBarry Smith to KSPSetOperators()/PCSetOperators(). 2508d32f9abdSBarry Smith 2509c8a0d604SMatthew G Knepley $ For the Schur complement preconditioner if J = ( A00 A01 ) 2510c8a0d604SMatthew G Knepley $ ( A10 A11 ) 2511c8a0d604SMatthew G Knepley $ the preconditioner using full factorization is 251213b05affSJed Brown $ ( I -ksp(A00) A01 ) ( inv(A00) 0 ) ( I 0 ) 2513c8a0d604SMatthew G Knepley $ ( 0 I ) ( 0 ksp(S) ) ( -A10 ksp(A00) I ) 251413b05affSJed Brown where the action of inv(A00) is applied using the KSP solver with prefix -fieldsplit_0_. S is the Schur complement 251513b05affSJed Brown $ S = A11 - A10 ksp(A00) A01 251613b05affSJed 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 2517686bed4dSStefano Zampini in providing the SECOND split or 1 if not give). For PCFieldSplitGetSubKSP() when field number is 0, 2518c8a0d604SMatthew G Knepley it returns the KSP associated with -fieldsplit_0_ while field number 1 gives -fieldsplit_1_ KSP. By default 2519a6a584a2SBarry Smith A11 is used to construct a preconditioner for S, use PCFieldSplitSetSchurPre() for all the possible ways to construct the preconditioner for S. 25201d71051fSDmitry Karpeev 2521a7476a74SDmitry Karpeev The factorization type is set using -pc_fieldsplit_schur_fact_type <diag, lower, upper, full>. The full is shown above, 25225668aaf4SBarry Smith diag gives 2523c8a0d604SMatthew G Knepley $ ( inv(A00) 0 ) 2524c8a0d604SMatthew G Knepley $ ( 0 -ksp(S) ) 2525c096484dSStefano 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 2526c096484dSStefano Zampini can be turned off with PCFieldSplitSetSchurScale() or by command line -pc_fieldsplit_schur_scale 1.0. The lower factorization is the inverse of 2527c8a0d604SMatthew G Knepley $ ( A00 0 ) 2528c8a0d604SMatthew G Knepley $ ( A10 S ) 2529c8a0d604SMatthew G Knepley where the inverses of A00 and S are applied using KSPs. The upper factorization is the inverse of 2530c8a0d604SMatthew G Knepley $ ( A00 A01 ) 2531c8a0d604SMatthew G Knepley $ ( 0 S ) 2532c8a0d604SMatthew G Knepley where again the inverses of A00 and S are applied using KSPs. 2533e69d4d44SBarry Smith 2534edf189efSBarry Smith If only one set of indices (one IS) is provided with PCFieldSplitSetIS() then the complement of that IS 2535edf189efSBarry Smith is used automatically for a second block. 2536edf189efSBarry Smith 2537ff218e97SBarry Smith The fieldsplit preconditioner cannot currently be used with the BAIJ or SBAIJ data formats if the blocksize is larger than 1. 2538ff218e97SBarry Smith Generally it should be used with the AIJ format. 2539ff218e97SBarry Smith 2540ff218e97SBarry Smith The forms of these preconditioners are closely related if not identical to forms derived as "Distributive Iterations", see, 2541ff218e97SBarry Smith for example, page 294 in "Principles of Computational Fluid Dynamics" by Pieter Wesseling. Note that one can also use PCFIELDSPLIT 2542ff218e97SBarry Smith inside a smoother resulting in "Distributive Smoothers". 25430716a85fSBarry Smith 2544a541d17aSBarry Smith Concepts: physics based preconditioners, block preconditioners 25450971522cSBarry Smith 25463bc631e0SBarry Smith There is a nice discussion of block preconditioners in 25473bc631e0SBarry Smith 25483bc631e0SBarry Smith [El08] A taxonomy and comparison of parallel block multi-level preconditioners for the incompressible Navier-Stokes equations 25493bc631e0SBarry Smith Howard Elman, V.E. Howle, John Shadid, Robert Shuttleworth, Ray Tuminaro, Journal of Computational Physics 227 (2008) 1790--1808 25503bc631e0SBarry Smith http://chess.cs.umd.edu/~elman/papers/tax.pdf 25513bc631e0SBarry Smith 25524d308398SBarry Smith The Constrained Pressure Preconditioner (CPR) can be implemented using PCCOMPOSITE with PCGALERKIN. CPR first solves an R A P subsystem, updates the 25534d308398SBarry Smith residual on all variables (PCCompositeSetType(pc,PC_COMPOSITE_MULTIPLICATIVE)), and then applies a simple ILU like preconditioner on all the variables. 2554a6a584a2SBarry Smith 25557e8cb189SBarry Smith .seealso: PCCreate(), PCSetType(), PCType (for list of available types), PC, Block_Preconditioners, PCLSC, 2556*285fb4e2SStefano Zampini PCFieldSplitGetSubKSP(), PCFieldSplitSchurGetSubKSP(), PCFieldSplitSetFields(), PCFieldSplitSetType(), PCFieldSplitSetIS(), PCFieldSplitSetSchurPre(), 25577b752e3dSPatrick Sanan MatSchurComplementSetAinvType(), PCFieldSplitSetSchurScale(), 25587b752e3dSPatrick Sanan PCFieldSplitSetDetectSaddlePoint() 25590971522cSBarry Smith M*/ 25600971522cSBarry Smith 25618cc058d9SJed Brown PETSC_EXTERN PetscErrorCode PCCreate_FieldSplit(PC pc) 25620971522cSBarry Smith { 25630971522cSBarry Smith PetscErrorCode ierr; 25640971522cSBarry Smith PC_FieldSplit *jac; 25650971522cSBarry Smith 25660971522cSBarry Smith PetscFunctionBegin; 2567b00a9115SJed Brown ierr = PetscNewLog(pc,&jac);CHKERRQ(ierr); 25682fa5cd67SKarl Rupp 25690971522cSBarry Smith jac->bs = -1; 25700971522cSBarry Smith jac->nsplits = 0; 25713e197d65SBarry Smith jac->type = PC_COMPOSITE_MULTIPLICATIVE; 2572e6cab6aaSJed Brown jac->schurpre = PC_FIELDSPLIT_SCHUR_PRE_USER; /* Try user preconditioner first, fall back on diagonal */ 2573c9c6ffaaSJed Brown jac->schurfactorization = PC_FIELDSPLIT_SCHUR_FACT_FULL; 2574c096484dSStefano Zampini jac->schurscale = -1.0; 2575fbe7908bSJed Brown jac->dm_splits = PETSC_TRUE; 25767b752e3dSPatrick Sanan jac->detect = PETSC_FALSE; 257751f519a2SBarry Smith 25780971522cSBarry Smith pc->data = (void*)jac; 25790971522cSBarry Smith 25800971522cSBarry Smith pc->ops->apply = PCApply_FieldSplit; 2581421e10b8SBarry Smith pc->ops->applytranspose = PCApplyTranspose_FieldSplit; 25820971522cSBarry Smith pc->ops->setup = PCSetUp_FieldSplit; 2583574deadeSBarry Smith pc->ops->reset = PCReset_FieldSplit; 25840971522cSBarry Smith pc->ops->destroy = PCDestroy_FieldSplit; 25850971522cSBarry Smith pc->ops->setfromoptions = PCSetFromOptions_FieldSplit; 25860971522cSBarry Smith pc->ops->view = PCView_FieldSplit; 25870971522cSBarry Smith pc->ops->applyrichardson = 0; 25880971522cSBarry Smith 2589*285fb4e2SStefano Zampini ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSchurGetSubKSP_C",PCFieldSplitSchurGetSubKSP_FieldSplit);CHKERRQ(ierr); 2590bdf89e91SBarry Smith ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitGetSubKSP_C",PCFieldSplitGetSubKSP_FieldSplit);CHKERRQ(ierr); 2591bdf89e91SBarry Smith ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetFields_C",PCFieldSplitSetFields_FieldSplit);CHKERRQ(ierr); 2592bdf89e91SBarry Smith ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetIS_C",PCFieldSplitSetIS_FieldSplit);CHKERRQ(ierr); 2593bdf89e91SBarry Smith ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetType_C",PCFieldSplitSetType_FieldSplit);CHKERRQ(ierr); 2594bdf89e91SBarry Smith ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetBlockSize_C",PCFieldSplitSetBlockSize_FieldSplit);CHKERRQ(ierr); 25956dbb499eSCian Wilson ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitRestrictIS_C",PCFieldSplitRestrictIS_FieldSplit);CHKERRQ(ierr); 25960971522cSBarry Smith PetscFunctionReturn(0); 25970971522cSBarry Smith } 2598