1af0996ceSBarry Smith #include <petsc/private/pcimpl.h> /*I "petscpc.h" I*/ 2a80b646eSBarry Smith #include <petsc/private/kspimpl.h> /* This is needed to provide the appropriate PETSC_EXTERN for KSP_Solve_FS ....*/ 31e25c274SJed Brown #include <petscdm.h> 40971522cSBarry Smith 50a545947SLisandro Dalcin const char *const PCFieldSplitSchurPreTypes[] = {"SELF", "SELFP", "A11", "USER", "FULL", "PCFieldSplitSchurPreType", "PC_FIELDSPLIT_SCHUR_PRE_", NULL}; 60a545947SLisandro Dalcin const char *const PCFieldSplitSchurFactTypes[] = {"DIAG", "LOWER", "UPPER", "FULL", "PCFieldSplitSchurFactType", "PC_FIELDSPLIT_SCHUR_FACT_", NULL}; 7c5d2311dSJed Brown 89df09d43SBarry 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; 99df09d43SBarry Smith 100971522cSBarry Smith typedef struct _PC_FieldSplitLink *PC_FieldSplitLink; 110971522cSBarry Smith struct _PC_FieldSplitLink { 1269a612a9SBarry Smith KSP ksp; 13443836d0SMatthew G Knepley Vec x, y, z; 14db4c96c1SJed Brown char *splitname; 150971522cSBarry Smith PetscInt nfields; 165d4c12cdSJungho Lee PetscInt *fields, *fields_col; 171b9fc7fcSBarry Smith VecScatter sctx; 18f5f0d762SBarry Smith IS is, is_col; 1951f519a2SBarry Smith PC_FieldSplitLink next, previous; 209df09d43SBarry Smith PetscLogEvent event; 215ddf11f8SNicolas Barnafi 225ddf11f8SNicolas Barnafi /* Used only when setting coordinates with PCSetCoordinates */ 235ddf11f8SNicolas Barnafi PetscInt dim; 245ddf11f8SNicolas Barnafi PetscInt ndofs; 255ddf11f8SNicolas Barnafi PetscReal *coords; 260971522cSBarry Smith }; 270971522cSBarry Smith 280971522cSBarry Smith typedef struct { 2968dd23aaSBarry Smith PCCompositeType type; 30ace3abfcSBarry Smith PetscBool defaultsplit; /* Flag for a system with a set of 'k' scalar fields with the same layout (and bs = k) */ 31ace3abfcSBarry Smith PetscBool splitdefined; /* Flag is set after the splits have been defined, to prevent more splits from being added */ 3230ad9308SMatthew Knepley PetscInt bs; /* Block size for IS and Mat structures */ 3330ad9308SMatthew Knepley PetscInt nsplits; /* Number of field divisions defined */ 3479416396SBarry Smith Vec *x, *y, w1, w2; 35519d70e2SJed Brown Mat *mat; /* The diagonal block for each split */ 36519d70e2SJed Brown Mat *pmat; /* The preconditioning diagonal block for each split */ 3730ad9308SMatthew Knepley Mat *Afield; /* The rows of the matrix associated with each split */ 38ace3abfcSBarry Smith PetscBool issetup; 392fa5cd67SKarl Rupp 4030ad9308SMatthew Knepley /* Only used when Schur complement preconditioning is used */ 4130ad9308SMatthew Knepley Mat B; /* The (0,1) block */ 4230ad9308SMatthew Knepley Mat C; /* The (1,0) block */ 43443836d0SMatthew G Knepley Mat schur; /* The Schur complement S = A11 - A10 A00^{-1} A01, the KSP here, kspinner, is H_1 in [El08] */ 44a7476a74SDmitry Karpeev Mat schurp; /* Assembled approximation to S built by MatSchurComplement to be used as a preconditioning matrix when solving with S */ 45084e4875SJed Brown Mat schur_user; /* User-provided preconditioning matrix for the Schur complement */ 46084e4875SJed Brown PCFieldSplitSchurPreType schurpre; /* Determines which preconditioning matrix is used for the Schur complement */ 47c9c6ffaaSJed Brown PCFieldSplitSchurFactType schurfactorization; 4830ad9308SMatthew Knepley KSP kspschur; /* The solver for S */ 49443836d0SMatthew G Knepley KSP kspupper; /* The solver for A in the upper diagonal part of the factorization (H_2 in [El08]) */ 50c096484dSStefano Zampini PetscScalar schurscale; /* Scaling factor for the Schur complement solution with DIAG factorization */ 51c096484dSStefano Zampini 52a51937d4SCarola Kruse /* Only used when Golub-Kahan bidiagonalization preconditioning is used */ 53a51937d4SCarola Kruse Mat H; /* The modified matrix H = A00 + nu*A01*A01' */ 54a51937d4SCarola Kruse PetscReal gkbtol; /* Stopping tolerance for lower bound estimate */ 55a51937d4SCarola Kruse PetscInt gkbdelay; /* The delay window for the stopping criterion */ 56a51937d4SCarola Kruse PetscReal gkbnu; /* Parameter for augmented Lagrangian H = A + nu*A01*A01' */ 57a51937d4SCarola Kruse PetscInt gkbmaxit; /* Maximum number of iterations for outer loop */ 58de482cd7SCarola Kruse PetscBool gkbmonitor; /* Monitor for gkb iterations and the lower bound error */ 59de482cd7SCarola Kruse PetscViewer gkbviewer; /* Viewer context for gkbmonitor */ 60e071a0a4SCarola Kruse Vec u, v, d, Hu; /* Work vectors for the GKB algorithm */ 61e071a0a4SCarola Kruse PetscScalar *vecz; /* Contains intermediate values, eg for lower bound */ 62a51937d4SCarola Kruse 6397bbdb24SBarry Smith PC_FieldSplitLink head; 646dbb499eSCian Wilson PetscBool isrestrict; /* indicates PCFieldSplitRestrictIS() has been last called on this object, hack */ 65c1570756SJed Brown PetscBool suboptionsset; /* Indicates that the KSPSetFromOptions() has been called on the sub-KSPs */ 664ab8060aSDmitry Karpeev PetscBool dm_splits; /* Whether to use DMCreateFieldDecomposition() whenever possible */ 67c84da90fSDmitry Karpeev PetscBool diag_use_amat; /* Whether to extract diagonal matrix blocks from Amat, rather than Pmat (weaker than -pc_use_amat) */ 68c84da90fSDmitry Karpeev PetscBool offdiag_use_amat; /* Whether to extract off-diagonal matrix blocks from Amat, rather than Pmat (weaker than -pc_use_amat) */ 697b752e3dSPatrick Sanan PetscBool detect; /* Whether to form 2-way split by finding zero diagonal entries */ 705ddf11f8SNicolas Barnafi PetscBool coordinates_set; /* Whether PCSetCoordinates has been called */ 710971522cSBarry Smith } PC_FieldSplit; 720971522cSBarry Smith 7316913363SBarry Smith /* 74f1580f4eSBarry Smith Note: 7595452b02SPatrick Sanan there is no particular reason that pmat, x, and y are stored as arrays in PC_FieldSplit instead of 7616913363SBarry Smith inside PC_FieldSplitLink, just historical. If you want to be able to add new fields after already using the 7716913363SBarry Smith PC you could change this. 7816913363SBarry Smith */ 79084e4875SJed Brown 80e6cab6aaSJed Brown /* This helper is so that setting a user-provided preconditioning matrix is orthogonal to choosing to use it. This way the 81084e4875SJed Brown * application-provided FormJacobian can provide this matrix without interfering with the user's (command-line) choices. */ 82d71ae5a4SJacob Faibussowitsch static Mat FieldSplitSchurPre(PC_FieldSplit *jac) 83d71ae5a4SJacob Faibussowitsch { 84084e4875SJed Brown switch (jac->schurpre) { 85d71ae5a4SJacob Faibussowitsch case PC_FIELDSPLIT_SCHUR_PRE_SELF: 86d71ae5a4SJacob Faibussowitsch return jac->schur; 87d71ae5a4SJacob Faibussowitsch case PC_FIELDSPLIT_SCHUR_PRE_SELFP: 88d71ae5a4SJacob Faibussowitsch return jac->schurp; 89d71ae5a4SJacob Faibussowitsch case PC_FIELDSPLIT_SCHUR_PRE_A11: 90d71ae5a4SJacob Faibussowitsch return jac->pmat[1]; 91e74569cdSMatthew G. Knepley case PC_FIELDSPLIT_SCHUR_PRE_FULL: /* We calculate this and store it in schur_user */ 92084e4875SJed Brown case PC_FIELDSPLIT_SCHUR_PRE_USER: /* Use a user-provided matrix if it is given, otherwise diagonal block */ 93d71ae5a4SJacob Faibussowitsch default: 94d71ae5a4SJacob Faibussowitsch return jac->schur_user ? jac->schur_user : jac->pmat[1]; 95084e4875SJed Brown } 96084e4875SJed Brown } 97084e4875SJed Brown 989804daf3SBarry Smith #include <petscdraw.h> 99d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCView_FieldSplit(PC pc, PetscViewer viewer) 100d71ae5a4SJacob Faibussowitsch { 1010971522cSBarry Smith PC_FieldSplit *jac = (PC_FieldSplit *)pc->data; 102d9884438SBarry Smith PetscBool iascii, isdraw; 1030971522cSBarry Smith PetscInt i, j; 1045a9f2f41SSatish Balay PC_FieldSplitLink ilink = jac->head; 1050971522cSBarry Smith 1060971522cSBarry Smith PetscFunctionBegin; 1079566063dSJacob Faibussowitsch PetscCall(PetscObjectTypeCompare((PetscObject)viewer, PETSCVIEWERASCII, &iascii)); 1089566063dSJacob Faibussowitsch PetscCall(PetscObjectTypeCompare((PetscObject)viewer, PETSCVIEWERDRAW, &isdraw)); 1090971522cSBarry Smith if (iascii) { 1102c9966d7SBarry Smith if (jac->bs > 0) { 11163a3b9bcSJacob Faibussowitsch PetscCall(PetscViewerASCIIPrintf(viewer, " FieldSplit with %s composition: total splits = %" PetscInt_FMT ", blocksize = %" PetscInt_FMT "\n", PCCompositeTypes[jac->type], jac->nsplits, jac->bs)); 1122c9966d7SBarry Smith } else { 11363a3b9bcSJacob Faibussowitsch PetscCall(PetscViewerASCIIPrintf(viewer, " FieldSplit with %s composition: total splits = %" PetscInt_FMT "\n", PCCompositeTypes[jac->type], jac->nsplits)); 1142c9966d7SBarry Smith } 11548a46eb9SPierre Jolivet if (pc->useAmat) PetscCall(PetscViewerASCIIPrintf(viewer, " using Amat (not Pmat) as operator for blocks\n")); 11648a46eb9SPierre Jolivet if (jac->diag_use_amat) PetscCall(PetscViewerASCIIPrintf(viewer, " using Amat (not Pmat) as operator for diagonal blocks\n")); 11748a46eb9SPierre Jolivet if (jac->offdiag_use_amat) PetscCall(PetscViewerASCIIPrintf(viewer, " using Amat (not Pmat) as operator for off-diagonal blocks\n")); 1189566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIIPrintf(viewer, " Solver info for each split is in the following KSP objects:\n")); 1190971522cSBarry Smith for (i = 0; i < jac->nsplits; i++) { 1201ab39975SBarry Smith if (ilink->fields) { 12163a3b9bcSJacob Faibussowitsch PetscCall(PetscViewerASCIIPrintf(viewer, "Split number %" PetscInt_FMT " Fields ", i)); 1229566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIIUseTabs(viewer, PETSC_FALSE)); 1235a9f2f41SSatish Balay for (j = 0; j < ilink->nfields; j++) { 12448a46eb9SPierre Jolivet if (j > 0) PetscCall(PetscViewerASCIIPrintf(viewer, ",")); 12563a3b9bcSJacob Faibussowitsch PetscCall(PetscViewerASCIIPrintf(viewer, " %" PetscInt_FMT, ilink->fields[j])); 1260971522cSBarry Smith } 1279566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIIPrintf(viewer, "\n")); 1289566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIIUseTabs(viewer, PETSC_TRUE)); 1291ab39975SBarry Smith } else { 13063a3b9bcSJacob Faibussowitsch PetscCall(PetscViewerASCIIPrintf(viewer, "Split number %" PetscInt_FMT " Defined by IS\n", i)); 1311ab39975SBarry Smith } 1329566063dSJacob Faibussowitsch PetscCall(KSPView(ilink->ksp, viewer)); 1335a9f2f41SSatish Balay ilink = ilink->next; 1340971522cSBarry Smith } 1352fa5cd67SKarl Rupp } 1362fa5cd67SKarl Rupp 1372fa5cd67SKarl Rupp if (isdraw) { 138d9884438SBarry Smith PetscDraw draw; 139d9884438SBarry Smith PetscReal x, y, w, wd; 140d9884438SBarry Smith 1419566063dSJacob Faibussowitsch PetscCall(PetscViewerDrawGetDraw(viewer, 0, &draw)); 1429566063dSJacob Faibussowitsch PetscCall(PetscDrawGetCurrentPoint(draw, &x, &y)); 143d9884438SBarry Smith w = 2 * PetscMin(1.0 - x, x); 144d9884438SBarry Smith wd = w / (jac->nsplits + 1); 145d9884438SBarry Smith x = x - wd * (jac->nsplits - 1) / 2.0; 146d9884438SBarry Smith for (i = 0; i < jac->nsplits; i++) { 1479566063dSJacob Faibussowitsch PetscCall(PetscDrawPushCurrentPoint(draw, x, y)); 1489566063dSJacob Faibussowitsch PetscCall(KSPView(ilink->ksp, viewer)); 1499566063dSJacob Faibussowitsch PetscCall(PetscDrawPopCurrentPoint(draw)); 150d9884438SBarry Smith x += wd; 151d9884438SBarry Smith ilink = ilink->next; 152d9884438SBarry Smith } 1530971522cSBarry Smith } 1543ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 1550971522cSBarry Smith } 1560971522cSBarry Smith 157d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCView_FieldSplit_Schur(PC pc, PetscViewer viewer) 158d71ae5a4SJacob Faibussowitsch { 1593b224e63SBarry Smith PC_FieldSplit *jac = (PC_FieldSplit *)pc->data; 1604996c5bdSBarry Smith PetscBool iascii, isdraw; 1613b224e63SBarry Smith PetscInt i, j; 1623b224e63SBarry Smith PC_FieldSplitLink ilink = jac->head; 163a9908d51SBarry Smith MatSchurComplementAinvType atype; 1643b224e63SBarry Smith 1653b224e63SBarry Smith PetscFunctionBegin; 1669566063dSJacob Faibussowitsch PetscCall(PetscObjectTypeCompare((PetscObject)viewer, PETSCVIEWERASCII, &iascii)); 1679566063dSJacob Faibussowitsch PetscCall(PetscObjectTypeCompare((PetscObject)viewer, PETSCVIEWERDRAW, &isdraw)); 1683b224e63SBarry Smith if (iascii) { 1692c9966d7SBarry Smith if (jac->bs > 0) { 17063a3b9bcSJacob Faibussowitsch PetscCall(PetscViewerASCIIPrintf(viewer, " FieldSplit with Schur preconditioner, blocksize = %" PetscInt_FMT ", factorization %s\n", jac->bs, PCFieldSplitSchurFactTypes[jac->schurfactorization])); 1712c9966d7SBarry Smith } else { 1729566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIIPrintf(viewer, " FieldSplit with Schur preconditioner, factorization %s\n", PCFieldSplitSchurFactTypes[jac->schurfactorization])); 1732c9966d7SBarry Smith } 17448a46eb9SPierre Jolivet if (pc->useAmat) PetscCall(PetscViewerASCIIPrintf(viewer, " using Amat (not Pmat) as operator for blocks\n")); 1753e8b8b31SMatthew G Knepley switch (jac->schurpre) { 176d71ae5a4SJacob Faibussowitsch case PC_FIELDSPLIT_SCHUR_PRE_SELF: 177d71ae5a4SJacob Faibussowitsch PetscCall(PetscViewerASCIIPrintf(viewer, " Preconditioner for the Schur complement formed from S itself\n")); 178d71ae5a4SJacob Faibussowitsch break; 179a7476a74SDmitry Karpeev case PC_FIELDSPLIT_SCHUR_PRE_SELFP: 1807cf5f706SPierre Jolivet if (jac->schur) { 1819566063dSJacob Faibussowitsch PetscCall(MatSchurComplementGetAinvType(jac->schur, &atype)); 1829371c9d4SSatish Balay PetscCall(PetscViewerASCIIPrintf(viewer, " Preconditioner for the Schur complement formed from Sp, an assembled approximation to S, which uses A00's %sinverse\n", atype == MAT_SCHUR_COMPLEMENT_AINV_DIAG ? "diagonal's " : (atype == MAT_SCHUR_COMPLEMENT_AINV_BLOCK_DIAG ? "block diagonal's " : (atype == MAT_SCHUR_COMPLEMENT_AINV_FULL ? "full " : "lumped diagonal's ")))); 1837cf5f706SPierre Jolivet } 184a9908d51SBarry Smith break; 185d71ae5a4SJacob Faibussowitsch case PC_FIELDSPLIT_SCHUR_PRE_A11: 186d71ae5a4SJacob Faibussowitsch PetscCall(PetscViewerASCIIPrintf(viewer, " Preconditioner for the Schur complement formed from A11\n")); 187d71ae5a4SJacob Faibussowitsch break; 188d71ae5a4SJacob Faibussowitsch case PC_FIELDSPLIT_SCHUR_PRE_FULL: 189d71ae5a4SJacob Faibussowitsch PetscCall(PetscViewerASCIIPrintf(viewer, " Preconditioner for the Schur complement formed from the exact Schur complement\n")); 190d71ae5a4SJacob Faibussowitsch break; 1913e8b8b31SMatthew G Knepley case PC_FIELDSPLIT_SCHUR_PRE_USER: 1923e8b8b31SMatthew G Knepley if (jac->schur_user) { 1939566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIIPrintf(viewer, " Preconditioner for the Schur complement formed from user provided matrix\n")); 1943e8b8b31SMatthew G Knepley } else { 1959566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIIPrintf(viewer, " Preconditioner for the Schur complement formed from A11\n")); 1963e8b8b31SMatthew G Knepley } 1973e8b8b31SMatthew G Knepley break; 198d71ae5a4SJacob Faibussowitsch default: 199d71ae5a4SJacob Faibussowitsch SETERRQ(PetscObjectComm((PetscObject)pc), PETSC_ERR_ARG_OUTOFRANGE, "Invalid Schur preconditioning type: %d", jac->schurpre); 2003e8b8b31SMatthew G Knepley } 2019566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIIPrintf(viewer, " Split info:\n")); 2029566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIIPushTab(viewer)); 2033b224e63SBarry Smith for (i = 0; i < jac->nsplits; i++) { 2043b224e63SBarry Smith if (ilink->fields) { 20563a3b9bcSJacob Faibussowitsch PetscCall(PetscViewerASCIIPrintf(viewer, "Split number %" PetscInt_FMT " Fields ", i)); 2069566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIIUseTabs(viewer, PETSC_FALSE)); 2073b224e63SBarry Smith for (j = 0; j < ilink->nfields; j++) { 20848a46eb9SPierre Jolivet if (j > 0) PetscCall(PetscViewerASCIIPrintf(viewer, ",")); 20963a3b9bcSJacob Faibussowitsch PetscCall(PetscViewerASCIIPrintf(viewer, " %" PetscInt_FMT, ilink->fields[j])); 2103b224e63SBarry Smith } 2119566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIIPrintf(viewer, "\n")); 2129566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIIUseTabs(viewer, PETSC_TRUE)); 2133b224e63SBarry Smith } else { 21463a3b9bcSJacob Faibussowitsch PetscCall(PetscViewerASCIIPrintf(viewer, "Split number %" PetscInt_FMT " Defined by IS\n", i)); 2153b224e63SBarry Smith } 2163b224e63SBarry Smith ilink = ilink->next; 2173b224e63SBarry Smith } 2189566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIIPrintf(viewer, "KSP solver for A00 block\n")); 2199566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIIPushTab(viewer)); 22006de4afeSJed Brown if (jac->head) { 2219566063dSJacob Faibussowitsch PetscCall(KSPView(jac->head->ksp, viewer)); 2229566063dSJacob Faibussowitsch } else PetscCall(PetscViewerASCIIPrintf(viewer, " not yet available\n")); 2239566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIIPopTab(viewer)); 22406de4afeSJed Brown if (jac->head && jac->kspupper != jac->head->ksp) { 2259566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIIPrintf(viewer, "KSP solver for upper A00 in upper triangular factor \n")); 2269566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIIPushTab(viewer)); 2279566063dSJacob Faibussowitsch if (jac->kspupper) PetscCall(KSPView(jac->kspupper, viewer)); 2289566063dSJacob Faibussowitsch else PetscCall(PetscViewerASCIIPrintf(viewer, " not yet available\n")); 2299566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIIPopTab(viewer)); 230443836d0SMatthew G Knepley } 2319566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIIPrintf(viewer, "KSP solver for S = A11 - A10 inv(A00) A01 \n")); 2329566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIIPushTab(viewer)); 23312cae6f2SJed Brown if (jac->kspschur) { 2349566063dSJacob Faibussowitsch PetscCall(KSPView(jac->kspschur, viewer)); 23512cae6f2SJed Brown } else { 2369566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIIPrintf(viewer, " not yet available\n")); 23712cae6f2SJed Brown } 2389566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIIPopTab(viewer)); 2399566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIIPopTab(viewer)); 24006de4afeSJed Brown } else if (isdraw && jac->head) { 2414996c5bdSBarry Smith PetscDraw draw; 2424996c5bdSBarry Smith PetscReal x, y, w, wd, h; 2434996c5bdSBarry Smith PetscInt cnt = 2; 2444996c5bdSBarry Smith char str[32]; 2454996c5bdSBarry Smith 2469566063dSJacob Faibussowitsch PetscCall(PetscViewerDrawGetDraw(viewer, 0, &draw)); 2479566063dSJacob Faibussowitsch PetscCall(PetscDrawGetCurrentPoint(draw, &x, &y)); 248c74581afSBarry Smith if (jac->kspupper != jac->head->ksp) cnt++; 249c74581afSBarry Smith w = 2 * PetscMin(1.0 - x, x); 250c74581afSBarry Smith wd = w / (cnt + 1); 251c74581afSBarry Smith 2529566063dSJacob Faibussowitsch PetscCall(PetscSNPrintf(str, 32, "Schur fact. %s", PCFieldSplitSchurFactTypes[jac->schurfactorization])); 2539566063dSJacob Faibussowitsch PetscCall(PetscDrawStringBoxed(draw, x, y, PETSC_DRAW_RED, PETSC_DRAW_BLACK, str, NULL, &h)); 2544996c5bdSBarry Smith y -= h; 2554996c5bdSBarry Smith if (jac->schurpre == PC_FIELDSPLIT_SCHUR_PRE_USER && !jac->schur_user) { 2569566063dSJacob Faibussowitsch PetscCall(PetscSNPrintf(str, 32, "Prec. for Schur from %s", PCFieldSplitSchurPreTypes[PC_FIELDSPLIT_SCHUR_PRE_A11])); 2573b224e63SBarry Smith } else { 2589566063dSJacob Faibussowitsch PetscCall(PetscSNPrintf(str, 32, "Prec. for Schur from %s", PCFieldSplitSchurPreTypes[jac->schurpre])); 2594996c5bdSBarry Smith } 2609566063dSJacob Faibussowitsch PetscCall(PetscDrawStringBoxed(draw, x + wd * (cnt - 1) / 2.0, y, PETSC_DRAW_RED, PETSC_DRAW_BLACK, str, NULL, &h)); 2614996c5bdSBarry Smith y -= h; 2624996c5bdSBarry Smith x = x - wd * (cnt - 1) / 2.0; 2634996c5bdSBarry Smith 2649566063dSJacob Faibussowitsch PetscCall(PetscDrawPushCurrentPoint(draw, x, y)); 2659566063dSJacob Faibussowitsch PetscCall(KSPView(jac->head->ksp, viewer)); 2669566063dSJacob Faibussowitsch PetscCall(PetscDrawPopCurrentPoint(draw)); 2674996c5bdSBarry Smith if (jac->kspupper != jac->head->ksp) { 2684996c5bdSBarry Smith x += wd; 2699566063dSJacob Faibussowitsch PetscCall(PetscDrawPushCurrentPoint(draw, x, y)); 2709566063dSJacob Faibussowitsch PetscCall(KSPView(jac->kspupper, viewer)); 2719566063dSJacob Faibussowitsch PetscCall(PetscDrawPopCurrentPoint(draw)); 2724996c5bdSBarry Smith } 2734996c5bdSBarry Smith x += wd; 2749566063dSJacob Faibussowitsch PetscCall(PetscDrawPushCurrentPoint(draw, x, y)); 2759566063dSJacob Faibussowitsch PetscCall(KSPView(jac->kspschur, viewer)); 2769566063dSJacob Faibussowitsch PetscCall(PetscDrawPopCurrentPoint(draw)); 2773b224e63SBarry Smith } 2783ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 2793b224e63SBarry Smith } 2803b224e63SBarry Smith 281d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCView_FieldSplit_GKB(PC pc, PetscViewer viewer) 282d71ae5a4SJacob Faibussowitsch { 283a51937d4SCarola Kruse PC_FieldSplit *jac = (PC_FieldSplit *)pc->data; 284a51937d4SCarola Kruse PetscBool iascii, isdraw; 285a51937d4SCarola Kruse PetscInt i, j; 286a51937d4SCarola Kruse PC_FieldSplitLink ilink = jac->head; 287a51937d4SCarola Kruse 288a51937d4SCarola Kruse PetscFunctionBegin; 2899566063dSJacob Faibussowitsch PetscCall(PetscObjectTypeCompare((PetscObject)viewer, PETSCVIEWERASCII, &iascii)); 2909566063dSJacob Faibussowitsch PetscCall(PetscObjectTypeCompare((PetscObject)viewer, PETSCVIEWERDRAW, &isdraw)); 291a51937d4SCarola Kruse if (iascii) { 292a51937d4SCarola Kruse if (jac->bs > 0) { 29363a3b9bcSJacob Faibussowitsch PetscCall(PetscViewerASCIIPrintf(viewer, " FieldSplit with %s composition: total splits = %" PetscInt_FMT ", blocksize = %" PetscInt_FMT "\n", PCCompositeTypes[jac->type], jac->nsplits, jac->bs)); 294a51937d4SCarola Kruse } else { 29563a3b9bcSJacob Faibussowitsch PetscCall(PetscViewerASCIIPrintf(viewer, " FieldSplit with %s composition: total splits = %" PetscInt_FMT "\n", PCCompositeTypes[jac->type], jac->nsplits)); 296a51937d4SCarola Kruse } 29748a46eb9SPierre Jolivet if (pc->useAmat) PetscCall(PetscViewerASCIIPrintf(viewer, " using Amat (not Pmat) as operator for blocks\n")); 29848a46eb9SPierre Jolivet if (jac->diag_use_amat) PetscCall(PetscViewerASCIIPrintf(viewer, " using Amat (not Pmat) as operator for diagonal blocks\n")); 29948a46eb9SPierre Jolivet if (jac->offdiag_use_amat) PetscCall(PetscViewerASCIIPrintf(viewer, " using Amat (not Pmat) as operator for off-diagonal blocks\n")); 300a51937d4SCarola Kruse 30163a3b9bcSJacob Faibussowitsch PetscCall(PetscViewerASCIIPrintf(viewer, " Stopping tolerance=%.1e, delay in error estimate=%" PetscInt_FMT ", maximum iterations=%" PetscInt_FMT "\n", (double)jac->gkbtol, jac->gkbdelay, jac->gkbmaxit)); 3029566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIIPrintf(viewer, " Solver info for H = A00 + nu*A01*A01' matrix:\n")); 3039566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIIPushTab(viewer)); 304a51937d4SCarola Kruse 305a51937d4SCarola Kruse if (ilink->fields) { 30663a3b9bcSJacob Faibussowitsch PetscCall(PetscViewerASCIIPrintf(viewer, "Split number 0 Fields ")); 3079566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIIUseTabs(viewer, PETSC_FALSE)); 308a51937d4SCarola Kruse for (j = 0; j < ilink->nfields; j++) { 30948a46eb9SPierre Jolivet if (j > 0) PetscCall(PetscViewerASCIIPrintf(viewer, ",")); 31063a3b9bcSJacob Faibussowitsch PetscCall(PetscViewerASCIIPrintf(viewer, " %" PetscInt_FMT, ilink->fields[j])); 311a51937d4SCarola Kruse } 3129566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIIPrintf(viewer, "\n")); 3139566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIIUseTabs(viewer, PETSC_TRUE)); 314a51937d4SCarola Kruse } else { 31563a3b9bcSJacob Faibussowitsch PetscCall(PetscViewerASCIIPrintf(viewer, "Split number 0 Defined by IS\n")); 316a51937d4SCarola Kruse } 3179566063dSJacob Faibussowitsch PetscCall(KSPView(ilink->ksp, viewer)); 318a51937d4SCarola Kruse 3199566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIIPopTab(viewer)); 320a51937d4SCarola Kruse } 321a51937d4SCarola Kruse 322a51937d4SCarola Kruse if (isdraw) { 323a51937d4SCarola Kruse PetscDraw draw; 324a51937d4SCarola Kruse PetscReal x, y, w, wd; 325a51937d4SCarola Kruse 3269566063dSJacob Faibussowitsch PetscCall(PetscViewerDrawGetDraw(viewer, 0, &draw)); 3279566063dSJacob Faibussowitsch PetscCall(PetscDrawGetCurrentPoint(draw, &x, &y)); 328a51937d4SCarola Kruse w = 2 * PetscMin(1.0 - x, x); 329a51937d4SCarola Kruse wd = w / (jac->nsplits + 1); 330a51937d4SCarola Kruse x = x - wd * (jac->nsplits - 1) / 2.0; 331a51937d4SCarola Kruse for (i = 0; i < jac->nsplits; i++) { 3329566063dSJacob Faibussowitsch PetscCall(PetscDrawPushCurrentPoint(draw, x, y)); 3339566063dSJacob Faibussowitsch PetscCall(KSPView(ilink->ksp, viewer)); 3349566063dSJacob Faibussowitsch PetscCall(PetscDrawPopCurrentPoint(draw)); 335a51937d4SCarola Kruse x += wd; 336a51937d4SCarola Kruse ilink = ilink->next; 337a51937d4SCarola Kruse } 338a51937d4SCarola Kruse } 3393ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 340a51937d4SCarola Kruse } 341a51937d4SCarola Kruse 3426c924f48SJed Brown /* Precondition: jac->bs is set to a meaningful value */ 343d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCFieldSplitSetRuntimeSplits_Private(PC pc) 344d71ae5a4SJacob Faibussowitsch { 3456c924f48SJed Brown PC_FieldSplit *jac = (PC_FieldSplit *)pc->data; 3465d4c12cdSJungho Lee PetscInt i, nfields, *ifields, nfields_col, *ifields_col; 3475d4c12cdSJungho Lee PetscBool flg, flg_col; 3485d4c12cdSJungho Lee char optionname[128], splitname[8], optionname_col[128]; 3496c924f48SJed Brown 3506c924f48SJed Brown PetscFunctionBegin; 3519566063dSJacob Faibussowitsch PetscCall(PetscMalloc1(jac->bs, &ifields)); 3529566063dSJacob Faibussowitsch PetscCall(PetscMalloc1(jac->bs, &ifields_col)); 3536c924f48SJed Brown for (i = 0, flg = PETSC_TRUE;; i++) { 35463a3b9bcSJacob Faibussowitsch PetscCall(PetscSNPrintf(splitname, sizeof(splitname), "%" PetscInt_FMT, i)); 35563a3b9bcSJacob Faibussowitsch PetscCall(PetscSNPrintf(optionname, sizeof(optionname), "-pc_fieldsplit_%" PetscInt_FMT "_fields", i)); 35663a3b9bcSJacob Faibussowitsch PetscCall(PetscSNPrintf(optionname_col, sizeof(optionname_col), "-pc_fieldsplit_%" PetscInt_FMT "_fields_col", i)); 3576c924f48SJed Brown nfields = jac->bs; 35829499fbbSJungho Lee nfields_col = jac->bs; 3599566063dSJacob Faibussowitsch PetscCall(PetscOptionsGetIntArray(((PetscObject)pc)->options, ((PetscObject)pc)->prefix, optionname, ifields, &nfields, &flg)); 3609566063dSJacob Faibussowitsch PetscCall(PetscOptionsGetIntArray(((PetscObject)pc)->options, ((PetscObject)pc)->prefix, optionname_col, ifields_col, &nfields_col, &flg_col)); 3616c924f48SJed Brown if (!flg) break; 3625d4c12cdSJungho Lee else if (flg && !flg_col) { 36328b400f6SJacob Faibussowitsch PetscCheck(nfields, PETSC_COMM_SELF, PETSC_ERR_USER, "Cannot list zero fields"); 3649566063dSJacob Faibussowitsch PetscCall(PCFieldSplitSetFields(pc, splitname, nfields, ifields, ifields)); 3652fa5cd67SKarl Rupp } else { 3667827d75bSBarry Smith PetscCheck(nfields && nfields_col, PETSC_COMM_SELF, PETSC_ERR_USER, "Cannot list zero fields"); 36708401ef6SPierre Jolivet PetscCheck(nfields == nfields_col, PETSC_COMM_SELF, PETSC_ERR_USER, "Number of row and column fields must match"); 3689566063dSJacob Faibussowitsch PetscCall(PCFieldSplitSetFields(pc, splitname, nfields, ifields, ifields_col)); 3695d4c12cdSJungho Lee } 3706c924f48SJed Brown } 3716c924f48SJed Brown if (i > 0) { 3726c924f48SJed Brown /* Makes command-line setting of splits take precedence over setting them in code. 3736c924f48SJed Brown Otherwise subsequent calls to PCFieldSplitSetIS() or PCFieldSplitSetFields() would 3746c924f48SJed Brown create new splits, which would probably not be what the user wanted. */ 3756c924f48SJed Brown jac->splitdefined = PETSC_TRUE; 3766c924f48SJed Brown } 3779566063dSJacob Faibussowitsch PetscCall(PetscFree(ifields)); 3789566063dSJacob Faibussowitsch PetscCall(PetscFree(ifields_col)); 3793ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 3806c924f48SJed Brown } 3816c924f48SJed Brown 382d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCFieldSplitSetDefaults(PC pc) 383d71ae5a4SJacob Faibussowitsch { 3840971522cSBarry Smith PC_FieldSplit *jac = (PC_FieldSplit *)pc->data; 3855a9f2f41SSatish Balay PC_FieldSplitLink ilink = jac->head; 3867b752e3dSPatrick Sanan PetscBool fieldsplit_default = PETSC_FALSE, coupling = PETSC_FALSE; 3876c924f48SJed Brown PetscInt i; 3880971522cSBarry Smith 3890971522cSBarry Smith PetscFunctionBegin; 3907287d2a3SDmitry Karpeev /* 391f5f0d762SBarry Smith Kinda messy, but at least this now uses DMCreateFieldDecomposition(). 3927287d2a3SDmitry Karpeev Should probably be rewritten. 3937287d2a3SDmitry Karpeev */ 394f5f0d762SBarry Smith if (!ilink) { 3959566063dSJacob Faibussowitsch PetscCall(PetscOptionsGetBool(((PetscObject)pc)->options, ((PetscObject)pc)->prefix, "-pc_fieldsplit_detect_coupling", &coupling, NULL)); 3967b752e3dSPatrick Sanan if (pc->dm && jac->dm_splits && !jac->detect && !coupling) { 397bafc1b83SMatthew G Knepley PetscInt numFields, f, i, j; 3980784a22cSJed Brown char **fieldNames; 3997b62db95SJungho Lee IS *fields; 400e7c4fc90SDmitry Karpeev DM *dms; 401bafc1b83SMatthew G Knepley DM subdm[128]; 402bafc1b83SMatthew G Knepley PetscBool flg; 403bafc1b83SMatthew G Knepley 4049566063dSJacob Faibussowitsch PetscCall(DMCreateFieldDecomposition(pc->dm, &numFields, &fieldNames, &fields, &dms)); 405bafc1b83SMatthew G Knepley /* Allow the user to prescribe the splits */ 406bafc1b83SMatthew G Knepley for (i = 0, flg = PETSC_TRUE;; i++) { 407bafc1b83SMatthew G Knepley PetscInt ifields[128]; 408bafc1b83SMatthew G Knepley IS compField; 409bafc1b83SMatthew G Knepley char optionname[128], splitname[8]; 410bafc1b83SMatthew G Knepley PetscInt nfields = numFields; 411bafc1b83SMatthew G Knepley 41263a3b9bcSJacob Faibussowitsch PetscCall(PetscSNPrintf(optionname, sizeof(optionname), "-pc_fieldsplit_%" PetscInt_FMT "_fields", i)); 4139566063dSJacob Faibussowitsch PetscCall(PetscOptionsGetIntArray(((PetscObject)pc)->options, ((PetscObject)pc)->prefix, optionname, ifields, &nfields, &flg)); 414bafc1b83SMatthew G Knepley if (!flg) break; 41563a3b9bcSJacob Faibussowitsch PetscCheck(numFields <= 128, PetscObjectComm((PetscObject)pc), PETSC_ERR_SUP, "Cannot currently support %" PetscInt_FMT " > 128 fields", numFields); 4169566063dSJacob Faibussowitsch PetscCall(DMCreateSubDM(pc->dm, nfields, ifields, &compField, &subdm[i])); 417bafc1b83SMatthew G Knepley if (nfields == 1) { 4189566063dSJacob Faibussowitsch PetscCall(PCFieldSplitSetIS(pc, fieldNames[ifields[0]], compField)); 419bafc1b83SMatthew G Knepley } else { 42063a3b9bcSJacob Faibussowitsch PetscCall(PetscSNPrintf(splitname, sizeof(splitname), "%" PetscInt_FMT, i)); 4219566063dSJacob Faibussowitsch PetscCall(PCFieldSplitSetIS(pc, splitname, compField)); 4227287d2a3SDmitry Karpeev } 4239566063dSJacob Faibussowitsch PetscCall(ISDestroy(&compField)); 424bafc1b83SMatthew G Knepley for (j = 0; j < nfields; ++j) { 425bafc1b83SMatthew G Knepley f = ifields[j]; 4269566063dSJacob Faibussowitsch PetscCall(PetscFree(fieldNames[f])); 4279566063dSJacob Faibussowitsch PetscCall(ISDestroy(&fields[f])); 4287b62db95SJungho Lee } 429bafc1b83SMatthew G Knepley } 430bafc1b83SMatthew G Knepley if (i == 0) { 431bafc1b83SMatthew G Knepley for (f = 0; f < numFields; ++f) { 4329566063dSJacob Faibussowitsch PetscCall(PCFieldSplitSetIS(pc, fieldNames[f], fields[f])); 4339566063dSJacob Faibussowitsch PetscCall(PetscFree(fieldNames[f])); 4349566063dSJacob Faibussowitsch PetscCall(ISDestroy(&fields[f])); 435bafc1b83SMatthew G Knepley } 436bafc1b83SMatthew G Knepley } else { 43748a46eb9SPierre Jolivet for (j = 0; j < numFields; j++) PetscCall(DMDestroy(dms + j)); 4389566063dSJacob Faibussowitsch PetscCall(PetscFree(dms)); 4399566063dSJacob Faibussowitsch PetscCall(PetscMalloc1(i, &dms)); 4402fa5cd67SKarl Rupp for (j = 0; j < i; ++j) dms[j] = subdm[j]; 441bafc1b83SMatthew G Knepley } 4429566063dSJacob Faibussowitsch PetscCall(PetscFree(fieldNames)); 4439566063dSJacob Faibussowitsch PetscCall(PetscFree(fields)); 444e7c4fc90SDmitry Karpeev if (dms) { 4459566063dSJacob Faibussowitsch PetscCall(PetscInfo(pc, "Setting up physics based fieldsplit preconditioner using the embedded DM\n")); 446bafc1b83SMatthew G Knepley for (ilink = jac->head, i = 0; ilink; ilink = ilink->next, ++i) { 4477287d2a3SDmitry Karpeev const char *prefix; 4489566063dSJacob Faibussowitsch PetscCall(PetscObjectGetOptionsPrefix((PetscObject)(ilink->ksp), &prefix)); 4499566063dSJacob Faibussowitsch PetscCall(PetscObjectSetOptionsPrefix((PetscObject)(dms[i]), prefix)); 4509566063dSJacob Faibussowitsch PetscCall(KSPSetDM(ilink->ksp, dms[i])); 4519566063dSJacob Faibussowitsch PetscCall(KSPSetDMActive(ilink->ksp, PETSC_FALSE)); 45295dbaa6fSMatthew G. Knepley { 45395dbaa6fSMatthew G. Knepley PetscErrorCode (*func)(KSP, Mat, Mat, void *); 45495dbaa6fSMatthew G. Knepley void *ctx; 45595dbaa6fSMatthew G. Knepley 4569566063dSJacob Faibussowitsch PetscCall(DMKSPGetComputeOperators(pc->dm, &func, &ctx)); 4579566063dSJacob Faibussowitsch PetscCall(DMKSPSetComputeOperators(dms[i], func, ctx)); 45895dbaa6fSMatthew G. Knepley } 4599566063dSJacob Faibussowitsch PetscCall(PetscObjectIncrementTabLevel((PetscObject)dms[i], (PetscObject)ilink->ksp, 0)); 4609566063dSJacob Faibussowitsch PetscCall(DMDestroy(&dms[i])); 4612fa5ba8aSJed Brown } 4629566063dSJacob Faibussowitsch PetscCall(PetscFree(dms)); 4638b8307b2SJed Brown } 46466ffff09SJed Brown } else { 465521d7252SBarry Smith if (jac->bs <= 0) { 466704ba839SBarry Smith if (pc->pmat) { 4679566063dSJacob Faibussowitsch PetscCall(MatGetBlockSize(pc->pmat, &jac->bs)); 4682fa5cd67SKarl Rupp } else jac->bs = 1; 469521d7252SBarry Smith } 470d32f9abdSBarry Smith 4717b752e3dSPatrick Sanan if (jac->detect) { 4726ce1633cSBarry Smith IS zerodiags, rest; 4736ce1633cSBarry Smith PetscInt nmin, nmax; 4746ce1633cSBarry Smith 4759566063dSJacob Faibussowitsch PetscCall(MatGetOwnershipRange(pc->mat, &nmin, &nmax)); 4767199da05SBarry Smith if (jac->diag_use_amat) { 4779566063dSJacob Faibussowitsch PetscCall(MatFindZeroDiagonals(pc->mat, &zerodiags)); 4787199da05SBarry Smith } else { 4799566063dSJacob Faibussowitsch PetscCall(MatFindZeroDiagonals(pc->pmat, &zerodiags)); 4807199da05SBarry Smith } 4819566063dSJacob Faibussowitsch PetscCall(ISComplement(zerodiags, nmin, nmax, &rest)); 4829566063dSJacob Faibussowitsch PetscCall(PCFieldSplitSetIS(pc, "0", rest)); 4839566063dSJacob Faibussowitsch PetscCall(PCFieldSplitSetIS(pc, "1", zerodiags)); 4849566063dSJacob Faibussowitsch PetscCall(ISDestroy(&zerodiags)); 4859566063dSJacob Faibussowitsch PetscCall(ISDestroy(&rest)); 4863a062f41SBarry Smith } else if (coupling) { 4873a062f41SBarry Smith IS coupling, rest; 4883a062f41SBarry Smith PetscInt nmin, nmax; 4893a062f41SBarry Smith 4909566063dSJacob Faibussowitsch PetscCall(MatGetOwnershipRange(pc->mat, &nmin, &nmax)); 4917199da05SBarry Smith if (jac->offdiag_use_amat) { 4929566063dSJacob Faibussowitsch PetscCall(MatFindOffBlockDiagonalEntries(pc->mat, &coupling)); 4937199da05SBarry Smith } else { 4949566063dSJacob Faibussowitsch PetscCall(MatFindOffBlockDiagonalEntries(pc->pmat, &coupling)); 4957199da05SBarry Smith } 4969566063dSJacob Faibussowitsch PetscCall(ISCreateStride(PetscObjectComm((PetscObject)pc->mat), nmax - nmin, nmin, 1, &rest)); 4979566063dSJacob Faibussowitsch PetscCall(ISSetIdentity(rest)); 4989566063dSJacob Faibussowitsch PetscCall(PCFieldSplitSetIS(pc, "0", rest)); 4999566063dSJacob Faibussowitsch PetscCall(PCFieldSplitSetIS(pc, "1", coupling)); 5009566063dSJacob Faibussowitsch PetscCall(ISDestroy(&coupling)); 5019566063dSJacob Faibussowitsch PetscCall(ISDestroy(&rest)); 5026ce1633cSBarry Smith } else { 5039566063dSJacob Faibussowitsch PetscCall(PetscOptionsGetBool(((PetscObject)pc)->options, ((PetscObject)pc)->prefix, "-pc_fieldsplit_default", &fieldsplit_default, NULL)); 5047287d2a3SDmitry Karpeev if (!fieldsplit_default) { 505d32f9abdSBarry Smith /* Allow user to set fields from command line, if bs was known at the time of PCSetFromOptions_FieldSplit() 506d32f9abdSBarry Smith then it is set there. This is not ideal because we should only have options set in XXSetFromOptions(). */ 5079566063dSJacob Faibussowitsch PetscCall(PCFieldSplitSetRuntimeSplits_Private(pc)); 5089566063dSJacob Faibussowitsch if (jac->splitdefined) PetscCall(PetscInfo(pc, "Splits defined using the options database\n")); 509d32f9abdSBarry Smith } 5106dbb499eSCian Wilson if ((fieldsplit_default || !jac->splitdefined) && !jac->isrestrict) { 5119f001fe8SStefano Zampini Mat M = pc->pmat; 512f3b928b9SStefano Zampini PetscBool isnest; 513f3b928b9SStefano Zampini 5149566063dSJacob Faibussowitsch PetscCall(PetscInfo(pc, "Using default splitting of fields\n")); 5159566063dSJacob Faibussowitsch PetscCall(PetscObjectTypeCompare((PetscObject)pc->pmat, MATNEST, &isnest)); 516f3b928b9SStefano Zampini if (!isnest) { 5179f001fe8SStefano Zampini M = pc->mat; 5189566063dSJacob Faibussowitsch PetscCall(PetscObjectTypeCompare((PetscObject)pc->mat, MATNEST, &isnest)); 519f3b928b9SStefano Zampini } 520f3b928b9SStefano Zampini if (isnest) { 521f3b928b9SStefano Zampini IS *fields; 522f3b928b9SStefano Zampini PetscInt nf; 523f3b928b9SStefano Zampini 5249566063dSJacob Faibussowitsch PetscCall(MatNestGetSize(M, &nf, NULL)); 5259566063dSJacob Faibussowitsch PetscCall(PetscMalloc1(nf, &fields)); 5269566063dSJacob Faibussowitsch PetscCall(MatNestGetISs(M, fields, NULL)); 52748a46eb9SPierre Jolivet for (i = 0; i < nf; i++) PetscCall(PCFieldSplitSetIS(pc, NULL, fields[i])); 5289566063dSJacob Faibussowitsch PetscCall(PetscFree(fields)); 529f3b928b9SStefano Zampini } else { 530db4c96c1SJed Brown for (i = 0; i < jac->bs; i++) { 5316c924f48SJed Brown char splitname[8]; 53263a3b9bcSJacob Faibussowitsch PetscCall(PetscSNPrintf(splitname, sizeof(splitname), "%" PetscInt_FMT, i)); 5339566063dSJacob Faibussowitsch PetscCall(PCFieldSplitSetFields(pc, splitname, 1, &i, &i)); 53479416396SBarry Smith } 5355d4c12cdSJungho Lee jac->defaultsplit = PETSC_TRUE; 536521d7252SBarry Smith } 53766ffff09SJed Brown } 5386ce1633cSBarry Smith } 539f3b928b9SStefano Zampini } 540edf189efSBarry Smith } else if (jac->nsplits == 1) { 541edf189efSBarry Smith IS is2; 542edf189efSBarry Smith PetscInt nmin, nmax; 543edf189efSBarry Smith 5440fdf79fbSJacob Faibussowitsch PetscCheck(ilink->is, PetscObjectComm((PetscObject)pc), PETSC_ERR_SUP, "Must provide at least two sets of fields to PCFieldSplit()"); 5459566063dSJacob Faibussowitsch PetscCall(MatGetOwnershipRange(pc->mat, &nmin, &nmax)); 5469566063dSJacob Faibussowitsch PetscCall(ISComplement(ilink->is, nmin, nmax, &is2)); 5479566063dSJacob Faibussowitsch PetscCall(PCFieldSplitSetIS(pc, "1", is2)); 5489566063dSJacob Faibussowitsch PetscCall(ISDestroy(&is2)); 549edf189efSBarry Smith } 550d0af7cd3SBarry Smith 55163a3b9bcSJacob Faibussowitsch PetscCheck(jac->nsplits >= 2, PetscObjectComm((PetscObject)pc), PETSC_ERR_PLIB, "Unhandled case, must have at least two fields, not %" PetscInt_FMT, jac->nsplits); 5523ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 55369a612a9SBarry Smith } 55469a612a9SBarry Smith 555d71ae5a4SJacob Faibussowitsch static PetscErrorCode MatGolubKahanComputeExplicitOperator(Mat A, Mat B, Mat C, Mat *H, PetscReal gkbnu) 556d71ae5a4SJacob Faibussowitsch { 557a51937d4SCarola Kruse Mat BT, T; 558de482cd7SCarola Kruse PetscReal nrmT, nrmB; 559a51937d4SCarola Kruse 560a51937d4SCarola Kruse PetscFunctionBegin; 5619566063dSJacob Faibussowitsch PetscCall(MatHermitianTranspose(C, MAT_INITIAL_MATRIX, &T)); /* Test if augmented matrix is symmetric */ 5629566063dSJacob Faibussowitsch PetscCall(MatAXPY(T, -1.0, B, DIFFERENT_NONZERO_PATTERN)); 5639566063dSJacob Faibussowitsch PetscCall(MatNorm(T, NORM_1, &nrmT)); 5649566063dSJacob Faibussowitsch PetscCall(MatNorm(B, NORM_1, &nrmB)); 565049d1499SBarry Smith PetscCheck(nrmB <= 0 || nrmT / nrmB < PETSC_SMALL, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "Matrix is not symmetric/hermitian, GKB is not applicable."); 566049d1499SBarry Smith 567a51937d4SCarola Kruse /* Compute augmented Lagrangian matrix H = A00 + nu*A01*A01'. This corresponds to */ 568a51937d4SCarola Kruse /* setting N := 1/nu*I in [Ar13]. */ 5699566063dSJacob Faibussowitsch PetscCall(MatHermitianTranspose(B, MAT_INITIAL_MATRIX, &BT)); 5709566063dSJacob Faibussowitsch PetscCall(MatMatMult(B, BT, MAT_INITIAL_MATRIX, PETSC_DEFAULT, H)); /* H = A01*A01' */ 5719566063dSJacob Faibussowitsch PetscCall(MatAYPX(*H, gkbnu, A, DIFFERENT_NONZERO_PATTERN)); /* H = A00 + nu*A01*A01' */ 572a51937d4SCarola Kruse 5739566063dSJacob Faibussowitsch PetscCall(MatDestroy(&BT)); 5749566063dSJacob Faibussowitsch PetscCall(MatDestroy(&T)); 5753ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 576a51937d4SCarola Kruse } 577a51937d4SCarola Kruse 5782d747510SLisandro Dalcin PETSC_EXTERN PetscErrorCode PetscOptionsFindPairPrefix_Private(PetscOptions, const char pre[], const char name[], const char *value[], PetscBool *flg); 579514bf10dSMatthew G Knepley 580d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCSetUp_FieldSplit(PC pc) 581d71ae5a4SJacob Faibussowitsch { 58269a612a9SBarry Smith PC_FieldSplit *jac = (PC_FieldSplit *)pc->data; 5835a9f2f41SSatish Balay PC_FieldSplitLink ilink; 5842c9966d7SBarry Smith PetscInt i, nsplit; 5855f4ab4e1SJungho Lee PetscBool sorted, sorted_col; 58669a612a9SBarry Smith 58769a612a9SBarry Smith PetscFunctionBegin; 5885da88fe4STristan Konolige pc->failedreason = PC_NOERROR; 5899566063dSJacob Faibussowitsch PetscCall(PCFieldSplitSetDefaults(pc)); 59097bbdb24SBarry Smith nsplit = jac->nsplits; 5915a9f2f41SSatish Balay ilink = jac->head; 59297bbdb24SBarry Smith 59397bbdb24SBarry Smith /* get the matrices for each split */ 594704ba839SBarry Smith if (!jac->issetup) { 5951b9fc7fcSBarry Smith PetscInt rstart, rend, nslots, bs; 59697bbdb24SBarry Smith 597704ba839SBarry Smith jac->issetup = PETSC_TRUE; 598704ba839SBarry Smith 5995d4c12cdSJungho Lee /* This is done here instead of in PCFieldSplitSetFields() because may not have matrix at that point */ 6002c9966d7SBarry Smith if (jac->defaultsplit || !ilink->is) { 6012c9966d7SBarry Smith if (jac->bs <= 0) jac->bs = nsplit; 6022c9966d7SBarry Smith } 6034db63379SBarry Smith 6044db63379SBarry Smith /* MatCreateSubMatrix() for [S]BAIJ matrices can only work if the indices include entire blocks of the matrix */ 6054db63379SBarry Smith PetscCall(MatGetBlockSize(pc->pmat, &bs)); 6064db63379SBarry Smith if (bs > 1 && (jac->bs <= bs || jac->bs % bs)) { 6074db63379SBarry Smith PetscBool blk; 6084db63379SBarry Smith 6094db63379SBarry Smith PetscCall(PetscObjectTypeCompareAny((PetscObject)pc->pmat, &blk, MATBAIJ, MATSBAIJ, MATSEQBAIJ, MATSEQSBAIJ, MATMPIBAIJ, MATMPISBAIJ, NULL)); 6104db63379SBarry Smith PetscCheck(!blk, PetscObjectComm((PetscObject)pc), PETSC_ERR_ARG_WRONG, "Cannot use MATBAIJ with PCFIELDSPLIT and currently set matrix and PC blocksizes"); 6114db63379SBarry Smith } 6124db63379SBarry Smith 61351f519a2SBarry Smith bs = jac->bs; 6149566063dSJacob Faibussowitsch PetscCall(MatGetOwnershipRange(pc->pmat, &rstart, &rend)); 6151b9fc7fcSBarry Smith nslots = (rend - rstart) / bs; 6161b9fc7fcSBarry Smith for (i = 0; i < nsplit; i++) { 6171b9fc7fcSBarry Smith if (jac->defaultsplit) { 6189566063dSJacob Faibussowitsch PetscCall(ISCreateStride(PetscObjectComm((PetscObject)pc), nslots, rstart + i, nsplit, &ilink->is)); 6199566063dSJacob Faibussowitsch PetscCall(ISDuplicate(ilink->is, &ilink->is_col)); 620704ba839SBarry Smith } else if (!ilink->is) { 621ccb205f8SBarry Smith if (ilink->nfields > 1) { 6225f4ab4e1SJungho Lee PetscInt *ii, *jj, j, k, nfields = ilink->nfields, *fields = ilink->fields, *fields_col = ilink->fields_col; 6239566063dSJacob Faibussowitsch PetscCall(PetscMalloc1(ilink->nfields * nslots, &ii)); 6249566063dSJacob Faibussowitsch PetscCall(PetscMalloc1(ilink->nfields * nslots, &jj)); 6251b9fc7fcSBarry Smith for (j = 0; j < nslots; j++) { 6261b9fc7fcSBarry Smith for (k = 0; k < nfields; k++) { 6271b9fc7fcSBarry Smith ii[nfields * j + k] = rstart + bs * j + fields[k]; 6285f4ab4e1SJungho Lee jj[nfields * j + k] = rstart + bs * j + fields_col[k]; 62997bbdb24SBarry Smith } 63097bbdb24SBarry Smith } 6319566063dSJacob Faibussowitsch PetscCall(ISCreateGeneral(PetscObjectComm((PetscObject)pc), nslots * nfields, ii, PETSC_OWN_POINTER, &ilink->is)); 6329566063dSJacob Faibussowitsch PetscCall(ISCreateGeneral(PetscObjectComm((PetscObject)pc), nslots * nfields, jj, PETSC_OWN_POINTER, &ilink->is_col)); 6339566063dSJacob Faibussowitsch PetscCall(ISSetBlockSize(ilink->is, nfields)); 6349566063dSJacob Faibussowitsch PetscCall(ISSetBlockSize(ilink->is_col, nfields)); 635ccb205f8SBarry Smith } else { 6369566063dSJacob Faibussowitsch PetscCall(ISCreateStride(PetscObjectComm((PetscObject)pc), nslots, rstart + ilink->fields[0], bs, &ilink->is)); 6379566063dSJacob Faibussowitsch PetscCall(ISCreateStride(PetscObjectComm((PetscObject)pc), nslots, rstart + ilink->fields_col[0], bs, &ilink->is_col)); 638ccb205f8SBarry Smith } 6393e197d65SBarry Smith } 6409566063dSJacob Faibussowitsch PetscCall(ISSorted(ilink->is, &sorted)); 6419566063dSJacob Faibussowitsch if (ilink->is_col) PetscCall(ISSorted(ilink->is_col, &sorted_col)); 6427827d75bSBarry Smith PetscCheck(sorted && sorted_col, PETSC_COMM_SELF, PETSC_ERR_USER, "Fields must be sorted when creating split"); 643704ba839SBarry Smith ilink = ilink->next; 6441b9fc7fcSBarry Smith } 6451b9fc7fcSBarry Smith } 6461b9fc7fcSBarry Smith 647704ba839SBarry Smith ilink = jac->head; 64897bbdb24SBarry Smith if (!jac->pmat) { 649bdddcaaaSMatthew G Knepley Vec xtmp; 650bdddcaaaSMatthew G Knepley 6519566063dSJacob Faibussowitsch PetscCall(MatCreateVecs(pc->pmat, &xtmp, NULL)); 6529566063dSJacob Faibussowitsch PetscCall(PetscMalloc1(nsplit, &jac->pmat)); 6539566063dSJacob Faibussowitsch PetscCall(PetscMalloc2(nsplit, &jac->x, nsplit, &jac->y)); 654cf502942SBarry Smith for (i = 0; i < nsplit; i++) { 655bdddcaaaSMatthew G Knepley MatNullSpace sp; 656bdddcaaaSMatthew G Knepley 657a3df900dSMatthew G Knepley /* Check for preconditioning matrix attached to IS */ 6589566063dSJacob Faibussowitsch PetscCall(PetscObjectQuery((PetscObject)ilink->is, "pmat", (PetscObject *)&jac->pmat[i])); 659a3df900dSMatthew G Knepley if (jac->pmat[i]) { 6609566063dSJacob Faibussowitsch PetscCall(PetscObjectReference((PetscObject)jac->pmat[i])); 661a3df900dSMatthew G Knepley if (jac->type == PC_COMPOSITE_SCHUR) { 662a3df900dSMatthew G Knepley jac->schur_user = jac->pmat[i]; 6632fa5cd67SKarl Rupp 6649566063dSJacob Faibussowitsch PetscCall(PetscObjectReference((PetscObject)jac->schur_user)); 665a3df900dSMatthew G Knepley } 666a3df900dSMatthew G Knepley } else { 6673a062f41SBarry Smith const char *prefix; 6689566063dSJacob Faibussowitsch PetscCall(MatCreateSubMatrix(pc->pmat, ilink->is, ilink->is_col, MAT_INITIAL_MATRIX, &jac->pmat[i])); 6699566063dSJacob Faibussowitsch PetscCall(KSPGetOptionsPrefix(ilink->ksp, &prefix)); 6709566063dSJacob Faibussowitsch PetscCall(MatSetOptionsPrefix(jac->pmat[i], prefix)); 6719566063dSJacob Faibussowitsch PetscCall(MatViewFromOptions(jac->pmat[i], NULL, "-mat_view")); 672a3df900dSMatthew G Knepley } 673bdddcaaaSMatthew G Knepley /* create work vectors for each split */ 6749566063dSJacob Faibussowitsch PetscCall(MatCreateVecs(jac->pmat[i], &jac->x[i], &jac->y[i])); 6759371c9d4SSatish Balay ilink->x = jac->x[i]; 6769371c9d4SSatish Balay ilink->y = jac->y[i]; 6779371c9d4SSatish Balay ilink->z = NULL; 678bdddcaaaSMatthew G Knepley /* compute scatter contexts needed by multiplicative versions and non-default splits */ 6799566063dSJacob Faibussowitsch PetscCall(VecScatterCreate(xtmp, ilink->is, jac->x[i], NULL, &ilink->sctx)); 6809566063dSJacob Faibussowitsch PetscCall(PetscObjectQuery((PetscObject)ilink->is, "nearnullspace", (PetscObject *)&sp)); 68148a46eb9SPierre Jolivet if (sp) PetscCall(MatSetNearNullSpace(jac->pmat[i], sp)); 682704ba839SBarry Smith ilink = ilink->next; 683cf502942SBarry Smith } 6849566063dSJacob Faibussowitsch PetscCall(VecDestroy(&xtmp)); 68597bbdb24SBarry Smith } else { 686ef7efd37SHong Zhang MatReuse scall; 687ef7efd37SHong Zhang if (pc->flag == DIFFERENT_NONZERO_PATTERN) { 68848a46eb9SPierre Jolivet for (i = 0; i < nsplit; i++) PetscCall(MatDestroy(&jac->pmat[i])); 689ef7efd37SHong Zhang scall = MAT_INITIAL_MATRIX; 690ef7efd37SHong Zhang } else scall = MAT_REUSE_MATRIX; 691ef7efd37SHong Zhang 692cf502942SBarry Smith for (i = 0; i < nsplit; i++) { 693a3df900dSMatthew G Knepley Mat pmat; 694a3df900dSMatthew G Knepley 695a3df900dSMatthew G Knepley /* Check for preconditioning matrix attached to IS */ 6969566063dSJacob Faibussowitsch PetscCall(PetscObjectQuery((PetscObject)ilink->is, "pmat", (PetscObject *)&pmat)); 69748a46eb9SPierre Jolivet if (!pmat) PetscCall(MatCreateSubMatrix(pc->pmat, ilink->is, ilink->is_col, scall, &jac->pmat[i])); 698704ba839SBarry Smith ilink = ilink->next; 699cf502942SBarry Smith } 70097bbdb24SBarry Smith } 7014e39094bSDmitry Karpeev if (jac->diag_use_amat) { 702519d70e2SJed Brown ilink = jac->head; 703519d70e2SJed Brown if (!jac->mat) { 7049566063dSJacob Faibussowitsch PetscCall(PetscMalloc1(nsplit, &jac->mat)); 705519d70e2SJed Brown for (i = 0; i < nsplit; i++) { 7069566063dSJacob Faibussowitsch PetscCall(MatCreateSubMatrix(pc->mat, ilink->is, ilink->is_col, MAT_INITIAL_MATRIX, &jac->mat[i])); 707519d70e2SJed Brown ilink = ilink->next; 708519d70e2SJed Brown } 709519d70e2SJed Brown } else { 710ef7efd37SHong Zhang MatReuse scall; 711ef7efd37SHong Zhang if (pc->flag == DIFFERENT_NONZERO_PATTERN) { 71248a46eb9SPierre Jolivet for (i = 0; i < nsplit; i++) PetscCall(MatDestroy(&jac->mat[i])); 713ef7efd37SHong Zhang scall = MAT_INITIAL_MATRIX; 714ef7efd37SHong Zhang } else scall = MAT_REUSE_MATRIX; 715ef7efd37SHong Zhang 716ef7efd37SHong Zhang for (i = 0; i < nsplit; i++) { 7179566063dSJacob Faibussowitsch PetscCall(MatCreateSubMatrix(pc->mat, ilink->is, ilink->is_col, scall, &jac->mat[i])); 718519d70e2SJed Brown ilink = ilink->next; 719519d70e2SJed Brown } 720519d70e2SJed Brown } 721519d70e2SJed Brown } else { 722519d70e2SJed Brown jac->mat = jac->pmat; 723519d70e2SJed Brown } 72497bbdb24SBarry Smith 72553935eafSBarry Smith /* Check for null space attached to IS */ 72653935eafSBarry Smith ilink = jac->head; 72753935eafSBarry Smith for (i = 0; i < nsplit; i++) { 72853935eafSBarry Smith MatNullSpace sp; 72953935eafSBarry Smith 7309566063dSJacob Faibussowitsch PetscCall(PetscObjectQuery((PetscObject)ilink->is, "nullspace", (PetscObject *)&sp)); 73148a46eb9SPierre Jolivet if (sp) PetscCall(MatSetNullSpace(jac->mat[i], sp)); 73253935eafSBarry Smith ilink = ilink->next; 73353935eafSBarry Smith } 73453935eafSBarry Smith 735a51937d4SCarola Kruse if (jac->type != PC_COMPOSITE_ADDITIVE && jac->type != PC_COMPOSITE_SCHUR && jac->type != PC_COMPOSITE_GKB) { 73668dd23aaSBarry Smith /* extract the rows of the matrix associated with each field: used for efficient computation of residual inside algorithm */ 7374e39094bSDmitry Karpeev /* FIXME: Can/should we reuse jac->mat whenever (jac->diag_use_amat) is true? */ 73868dd23aaSBarry Smith ilink = jac->head; 739e52d2c62SBarry Smith if (nsplit == 2 && jac->type == PC_COMPOSITE_MULTIPLICATIVE) { 740e52d2c62SBarry 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 */ 741e52d2c62SBarry Smith if (!jac->Afield) { 7429566063dSJacob Faibussowitsch PetscCall(PetscCalloc1(nsplit, &jac->Afield)); 74380c96bb1SFande Kong if (jac->offdiag_use_amat) { 7449566063dSJacob Faibussowitsch PetscCall(MatCreateSubMatrix(pc->mat, ilink->next->is, ilink->is, MAT_INITIAL_MATRIX, &jac->Afield[1])); 745e52d2c62SBarry Smith } else { 7469566063dSJacob Faibussowitsch PetscCall(MatCreateSubMatrix(pc->pmat, ilink->next->is, ilink->is, MAT_INITIAL_MATRIX, &jac->Afield[1])); 74780c96bb1SFande Kong } 74880c96bb1SFande Kong } else { 749ef7efd37SHong Zhang MatReuse scall; 750e9422dd5SStefano Zampini 751ef7efd37SHong Zhang if (pc->flag == DIFFERENT_NONZERO_PATTERN) { 7529566063dSJacob Faibussowitsch PetscCall(MatDestroy(&jac->Afield[1])); 753ef7efd37SHong Zhang scall = MAT_INITIAL_MATRIX; 754ef7efd37SHong Zhang } else scall = MAT_REUSE_MATRIX; 755ef7efd37SHong Zhang 75680c96bb1SFande Kong if (jac->offdiag_use_amat) { 7579566063dSJacob Faibussowitsch PetscCall(MatCreateSubMatrix(pc->mat, ilink->next->is, ilink->is, scall, &jac->Afield[1])); 75880c96bb1SFande Kong } else { 7599566063dSJacob Faibussowitsch PetscCall(MatCreateSubMatrix(pc->pmat, ilink->next->is, ilink->is, scall, &jac->Afield[1])); 76080c96bb1SFande Kong } 761e52d2c62SBarry Smith } 762e52d2c62SBarry Smith } else { 76368dd23aaSBarry Smith if (!jac->Afield) { 7649566063dSJacob Faibussowitsch PetscCall(PetscMalloc1(nsplit, &jac->Afield)); 76568dd23aaSBarry Smith for (i = 0; i < nsplit; i++) { 76680c96bb1SFande Kong if (jac->offdiag_use_amat) { 7679566063dSJacob Faibussowitsch PetscCall(MatCreateSubMatrix(pc->mat, ilink->is, NULL, MAT_INITIAL_MATRIX, &jac->Afield[i])); 76880c96bb1SFande Kong } else { 7699566063dSJacob Faibussowitsch PetscCall(MatCreateSubMatrix(pc->pmat, ilink->is, NULL, MAT_INITIAL_MATRIX, &jac->Afield[i])); 77080c96bb1SFande Kong } 77168dd23aaSBarry Smith ilink = ilink->next; 77268dd23aaSBarry Smith } 77368dd23aaSBarry Smith } else { 774ef7efd37SHong Zhang MatReuse scall; 775ef7efd37SHong Zhang if (pc->flag == DIFFERENT_NONZERO_PATTERN) { 77648a46eb9SPierre Jolivet for (i = 0; i < nsplit; i++) PetscCall(MatDestroy(&jac->Afield[i])); 777ef7efd37SHong Zhang scall = MAT_INITIAL_MATRIX; 778ef7efd37SHong Zhang } else scall = MAT_REUSE_MATRIX; 779ef7efd37SHong Zhang 78068dd23aaSBarry Smith for (i = 0; i < nsplit; i++) { 78180c96bb1SFande Kong if (jac->offdiag_use_amat) { 7829566063dSJacob Faibussowitsch PetscCall(MatCreateSubMatrix(pc->mat, ilink->is, NULL, scall, &jac->Afield[i])); 78380c96bb1SFande Kong } else { 7849566063dSJacob Faibussowitsch PetscCall(MatCreateSubMatrix(pc->pmat, ilink->is, NULL, scall, &jac->Afield[i])); 78580c96bb1SFande Kong } 78668dd23aaSBarry Smith ilink = ilink->next; 78768dd23aaSBarry Smith } 78868dd23aaSBarry Smith } 78968dd23aaSBarry Smith } 790e52d2c62SBarry Smith } 79168dd23aaSBarry Smith 7923b224e63SBarry Smith if (jac->type == PC_COMPOSITE_SCHUR) { 7933b224e63SBarry Smith IS ccis; 794b94d7dedSBarry Smith PetscBool isset, isspd; 7954aa3045dSJed Brown PetscInt rstart, rend; 796093c86ffSJed Brown char lscname[256]; 797093c86ffSJed Brown PetscObject LSC_L; 798ce94432eSBarry Smith 79908401ef6SPierre Jolivet PetscCheck(nsplit == 2, PetscObjectComm((PetscObject)pc), PETSC_ERR_ARG_INCOMP, "To use Schur complement preconditioner you must have exactly 2 fields"); 80068dd23aaSBarry Smith 801c096484dSStefano Zampini /* If pc->mat is SPD, don't scale by -1 the Schur complement */ 802c096484dSStefano Zampini if (jac->schurscale == (PetscScalar)-1.0) { 803b94d7dedSBarry Smith PetscCall(MatIsSPDKnown(pc->pmat, &isset, &isspd)); 804b94d7dedSBarry Smith jac->schurscale = (isset && isspd) ? 1.0 : -1.0; 805c096484dSStefano Zampini } 806c096484dSStefano Zampini 807e6cab6aaSJed Brown /* When extracting off-diagonal submatrices, we take complements from this range */ 8089566063dSJacob Faibussowitsch PetscCall(MatGetOwnershipRangeColumn(pc->mat, &rstart, &rend)); 809e6cab6aaSJed Brown 8103b224e63SBarry Smith if (jac->schur) { 8110298fd71SBarry Smith KSP kspA = jac->head->ksp, kspInner = NULL, kspUpper = jac->kspupper; 812e9422dd5SStefano Zampini MatReuse scall; 813e9422dd5SStefano Zampini 814e9422dd5SStefano Zampini if (pc->flag == DIFFERENT_NONZERO_PATTERN) { 815e9422dd5SStefano Zampini scall = MAT_INITIAL_MATRIX; 8169566063dSJacob Faibussowitsch PetscCall(MatDestroy(&jac->B)); 8179566063dSJacob Faibussowitsch PetscCall(MatDestroy(&jac->C)); 818e9422dd5SStefano Zampini } else scall = MAT_REUSE_MATRIX; 819443836d0SMatthew G Knepley 8209566063dSJacob Faibussowitsch PetscCall(MatSchurComplementGetKSP(jac->schur, &kspInner)); 8213b224e63SBarry Smith ilink = jac->head; 8229566063dSJacob Faibussowitsch PetscCall(ISComplement(ilink->is_col, rstart, rend, &ccis)); 8234e39094bSDmitry Karpeev if (jac->offdiag_use_amat) { 8249566063dSJacob Faibussowitsch PetscCall(MatCreateSubMatrix(pc->mat, ilink->is, ccis, scall, &jac->B)); 825c84da90fSDmitry Karpeev } else { 8269566063dSJacob Faibussowitsch PetscCall(MatCreateSubMatrix(pc->pmat, ilink->is, ccis, scall, &jac->B)); 827c84da90fSDmitry Karpeev } 8289566063dSJacob Faibussowitsch PetscCall(ISDestroy(&ccis)); 8293b224e63SBarry Smith ilink = ilink->next; 8309566063dSJacob Faibussowitsch PetscCall(ISComplement(ilink->is_col, rstart, rend, &ccis)); 8314e39094bSDmitry Karpeev if (jac->offdiag_use_amat) { 8329566063dSJacob Faibussowitsch PetscCall(MatCreateSubMatrix(pc->mat, ilink->is, ccis, scall, &jac->C)); 833c84da90fSDmitry Karpeev } else { 8349566063dSJacob Faibussowitsch PetscCall(MatCreateSubMatrix(pc->pmat, ilink->is, ccis, scall, &jac->C)); 835c84da90fSDmitry Karpeev } 8369566063dSJacob Faibussowitsch PetscCall(ISDestroy(&ccis)); 8379566063dSJacob Faibussowitsch PetscCall(MatSchurComplementUpdateSubMatrices(jac->schur, jac->mat[0], jac->pmat[0], jac->B, jac->C, jac->mat[1])); 838a7476a74SDmitry Karpeev if (jac->schurpre == PC_FIELDSPLIT_SCHUR_PRE_SELFP) { 8399566063dSJacob Faibussowitsch PetscCall(MatDestroy(&jac->schurp)); 8409566063dSJacob Faibussowitsch PetscCall(MatSchurComplementGetPmat(jac->schur, MAT_INITIAL_MATRIX, &jac->schurp)); 841a7476a74SDmitry Karpeev } 84248a46eb9SPierre Jolivet if (kspA != kspInner) PetscCall(KSPSetOperators(kspA, jac->mat[0], jac->pmat[0])); 84348a46eb9SPierre Jolivet if (kspUpper != kspA) PetscCall(KSPSetOperators(kspUpper, jac->mat[0], jac->pmat[0])); 8449566063dSJacob Faibussowitsch PetscCall(KSPSetOperators(jac->kspschur, jac->schur, FieldSplitSchurPre(jac))); 8453b224e63SBarry Smith } else { 846bafc1b83SMatthew G Knepley const char *Dprefix; 847470b340bSDmitry Karpeev char schurprefix[256], schurmatprefix[256]; 848514bf10dSMatthew G Knepley char schurtestoption[256]; 849bdddcaaaSMatthew G Knepley MatNullSpace sp; 850514bf10dSMatthew G Knepley PetscBool flg; 851686bed4dSStefano Zampini KSP kspt; 8523b224e63SBarry Smith 853a04f6461SBarry Smith /* extract the A01 and A10 matrices */ 8543b224e63SBarry Smith ilink = jac->head; 8559566063dSJacob Faibussowitsch PetscCall(ISComplement(ilink->is_col, rstart, rend, &ccis)); 8564e39094bSDmitry Karpeev if (jac->offdiag_use_amat) { 8579566063dSJacob Faibussowitsch PetscCall(MatCreateSubMatrix(pc->mat, ilink->is, ccis, MAT_INITIAL_MATRIX, &jac->B)); 858c84da90fSDmitry Karpeev } else { 8599566063dSJacob Faibussowitsch PetscCall(MatCreateSubMatrix(pc->pmat, ilink->is, ccis, MAT_INITIAL_MATRIX, &jac->B)); 860c84da90fSDmitry Karpeev } 8619566063dSJacob Faibussowitsch PetscCall(ISDestroy(&ccis)); 8623b224e63SBarry Smith ilink = ilink->next; 8639566063dSJacob Faibussowitsch PetscCall(ISComplement(ilink->is_col, rstart, rend, &ccis)); 8644e39094bSDmitry Karpeev if (jac->offdiag_use_amat) { 8659566063dSJacob Faibussowitsch PetscCall(MatCreateSubMatrix(pc->mat, ilink->is, ccis, MAT_INITIAL_MATRIX, &jac->C)); 866c84da90fSDmitry Karpeev } else { 8679566063dSJacob Faibussowitsch PetscCall(MatCreateSubMatrix(pc->pmat, ilink->is, ccis, MAT_INITIAL_MATRIX, &jac->C)); 868c84da90fSDmitry Karpeev } 8699566063dSJacob Faibussowitsch PetscCall(ISDestroy(&ccis)); 87020252d06SBarry Smith 871f5236f50SJed Brown /* Use mat[0] (diagonal block of Amat) preconditioned by pmat[0] to define Schur complement */ 8729566063dSJacob Faibussowitsch PetscCall(MatCreate(((PetscObject)jac->mat[0])->comm, &jac->schur)); 8739566063dSJacob Faibussowitsch PetscCall(MatSetType(jac->schur, MATSCHURCOMPLEMENT)); 8749566063dSJacob Faibussowitsch PetscCall(MatSchurComplementSetSubMatrices(jac->schur, jac->mat[0], jac->pmat[0], jac->B, jac->C, jac->mat[1])); 8759566063dSJacob Faibussowitsch PetscCall(PetscSNPrintf(schurmatprefix, sizeof(schurmatprefix), "%sfieldsplit_%s_", ((PetscObject)pc)->prefix ? ((PetscObject)pc)->prefix : "", ilink->splitname)); 8769566063dSJacob Faibussowitsch PetscCall(MatSetOptionsPrefix(jac->schur, schurmatprefix)); 8779566063dSJacob Faibussowitsch PetscCall(MatSchurComplementGetKSP(jac->schur, &kspt)); 8789566063dSJacob Faibussowitsch PetscCall(KSPSetOptionsPrefix(kspt, schurmatprefix)); 879686bed4dSStefano Zampini 880686bed4dSStefano Zampini /* Note: this is not true in general */ 8819566063dSJacob Faibussowitsch PetscCall(MatGetNullSpace(jac->mat[1], &sp)); 8821baa6e33SBarry Smith if (sp) PetscCall(MatSetNullSpace(jac->schur, sp)); 88320252d06SBarry Smith 8849566063dSJacob Faibussowitsch PetscCall(PetscSNPrintf(schurtestoption, sizeof(schurtestoption), "-fieldsplit_%s_inner_", ilink->splitname)); 8859566063dSJacob Faibussowitsch PetscCall(PetscOptionsFindPairPrefix_Private(((PetscObject)pc)->options, ((PetscObject)pc)->prefix, schurtestoption, NULL, &flg)); 886514bf10dSMatthew G Knepley if (flg) { 887514bf10dSMatthew G Knepley DM dmInner; 88821635b76SJed Brown KSP kspInner; 889686bed4dSStefano Zampini PC pcInner; 89021635b76SJed Brown 8919566063dSJacob Faibussowitsch PetscCall(MatSchurComplementGetKSP(jac->schur, &kspInner)); 8929566063dSJacob Faibussowitsch PetscCall(KSPReset(kspInner)); 8939566063dSJacob Faibussowitsch PetscCall(KSPSetOperators(kspInner, jac->mat[0], jac->pmat[0])); 8949566063dSJacob Faibussowitsch PetscCall(PetscSNPrintf(schurprefix, sizeof(schurprefix), "%sfieldsplit_%s_inner_", ((PetscObject)pc)->prefix ? ((PetscObject)pc)->prefix : "", ilink->splitname)); 89521635b76SJed Brown /* Indent this deeper to emphasize the "inner" nature of this solver. */ 8969566063dSJacob Faibussowitsch PetscCall(PetscObjectIncrementTabLevel((PetscObject)kspInner, (PetscObject)pc, 2)); 8979566063dSJacob Faibussowitsch PetscCall(PetscObjectIncrementTabLevel((PetscObject)kspInner->pc, (PetscObject)pc, 2)); 8989566063dSJacob Faibussowitsch PetscCall(KSPSetOptionsPrefix(kspInner, schurprefix)); 899514bf10dSMatthew G Knepley 900514bf10dSMatthew G Knepley /* Set DM for new solver */ 9019566063dSJacob Faibussowitsch PetscCall(KSPGetDM(jac->head->ksp, &dmInner)); 9029566063dSJacob Faibussowitsch PetscCall(KSPSetDM(kspInner, dmInner)); 9039566063dSJacob Faibussowitsch PetscCall(KSPSetDMActive(kspInner, PETSC_FALSE)); 904686bed4dSStefano Zampini 905686bed4dSStefano Zampini /* Defaults to PCKSP as preconditioner */ 9069566063dSJacob Faibussowitsch PetscCall(KSPGetPC(kspInner, &pcInner)); 9079566063dSJacob Faibussowitsch PetscCall(PCSetType(pcInner, PCKSP)); 9089566063dSJacob Faibussowitsch PetscCall(PCKSPSetKSP(pcInner, jac->head->ksp)); 909514bf10dSMatthew G Knepley } else { 91021635b76SJed Brown /* Use the outer solver for the inner solve, but revert the KSPPREONLY from PCFieldSplitSetFields_FieldSplit or 91121635b76SJed Brown * PCFieldSplitSetIS_FieldSplit. We don't want KSPPREONLY because it makes the Schur complement inexact, 91221635b76SJed Brown * preventing Schur complement reduction to be an accurate solve. Usually when an iterative solver is used for 91321635b76SJed 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 91421635b76SJed Brown * GMRES the default. Note that it is also common to use PREONLY for S, in which case S may not be used 91521635b76SJed Brown * directly, and the user is responsible for setting an inexact method for fieldsplit's A^{-1}. */ 9169566063dSJacob Faibussowitsch PetscCall(KSPSetType(jac->head->ksp, KSPGMRES)); 9179566063dSJacob Faibussowitsch PetscCall(MatSchurComplementSetKSP(jac->schur, jac->head->ksp)); 918bafc1b83SMatthew G Knepley } 9199566063dSJacob Faibussowitsch PetscCall(KSPSetOperators(jac->head->ksp, jac->mat[0], jac->pmat[0])); 9209566063dSJacob Faibussowitsch PetscCall(KSPSetFromOptions(jac->head->ksp)); 9219566063dSJacob Faibussowitsch PetscCall(MatSetFromOptions(jac->schur)); 9223b224e63SBarry Smith 9239566063dSJacob Faibussowitsch PetscCall(PetscObjectTypeCompare((PetscObject)jac->schur, MATSCHURCOMPLEMENT, &flg)); 924686bed4dSStefano Zampini if (flg) { /* Need to do this otherwise PCSetUp_KSP will overwrite the amat of jac->head->ksp */ 925686bed4dSStefano Zampini KSP kspInner; 926686bed4dSStefano Zampini PC pcInner; 927686bed4dSStefano Zampini 9289566063dSJacob Faibussowitsch PetscCall(MatSchurComplementGetKSP(jac->schur, &kspInner)); 9299566063dSJacob Faibussowitsch PetscCall(KSPGetPC(kspInner, &pcInner)); 9309566063dSJacob Faibussowitsch PetscCall(PetscObjectTypeCompare((PetscObject)pcInner, PCKSP, &flg)); 931686bed4dSStefano Zampini if (flg) { 932686bed4dSStefano Zampini KSP ksp; 933686bed4dSStefano Zampini 9349566063dSJacob Faibussowitsch PetscCall(PCKSPGetKSP(pcInner, &ksp)); 93548a46eb9SPierre Jolivet if (ksp == jac->head->ksp) PetscCall(PCSetUseAmat(pcInner, PETSC_TRUE)); 936686bed4dSStefano Zampini } 937686bed4dSStefano Zampini } 9389566063dSJacob Faibussowitsch PetscCall(PetscSNPrintf(schurtestoption, sizeof(schurtestoption), "-fieldsplit_%s_upper_", ilink->splitname)); 9399566063dSJacob Faibussowitsch PetscCall(PetscOptionsFindPairPrefix_Private(((PetscObject)pc)->options, ((PetscObject)pc)->prefix, schurtestoption, NULL, &flg)); 940443836d0SMatthew G Knepley if (flg) { 941443836d0SMatthew G Knepley DM dmInner; 942443836d0SMatthew G Knepley 9439566063dSJacob Faibussowitsch PetscCall(PetscSNPrintf(schurprefix, sizeof(schurprefix), "%sfieldsplit_%s_upper_", ((PetscObject)pc)->prefix ? ((PetscObject)pc)->prefix : "", ilink->splitname)); 9449566063dSJacob Faibussowitsch PetscCall(KSPCreate(PetscObjectComm((PetscObject)pc), &jac->kspupper)); 945*3821be0aSBarry Smith PetscCall(KSPSetNestLevel(jac->kspupper, pc->kspnestlevel)); 9469566063dSJacob Faibussowitsch PetscCall(KSPSetErrorIfNotConverged(jac->kspupper, pc->erroriffailure)); 9479566063dSJacob Faibussowitsch PetscCall(KSPSetOptionsPrefix(jac->kspupper, schurprefix)); 9489566063dSJacob Faibussowitsch PetscCall(PetscObjectIncrementTabLevel((PetscObject)jac->kspupper, (PetscObject)pc, 1)); 9499566063dSJacob Faibussowitsch PetscCall(PetscObjectIncrementTabLevel((PetscObject)jac->kspupper->pc, (PetscObject)pc, 1)); 9509566063dSJacob Faibussowitsch PetscCall(KSPGetDM(jac->head->ksp, &dmInner)); 9519566063dSJacob Faibussowitsch PetscCall(KSPSetDM(jac->kspupper, dmInner)); 9529566063dSJacob Faibussowitsch PetscCall(KSPSetDMActive(jac->kspupper, PETSC_FALSE)); 9539566063dSJacob Faibussowitsch PetscCall(KSPSetFromOptions(jac->kspupper)); 9549566063dSJacob Faibussowitsch PetscCall(KSPSetOperators(jac->kspupper, jac->mat[0], jac->pmat[0])); 9559566063dSJacob Faibussowitsch PetscCall(VecDuplicate(jac->head->x, &jac->head->z)); 956443836d0SMatthew G Knepley } else { 957443836d0SMatthew G Knepley jac->kspupper = jac->head->ksp; 9589566063dSJacob Faibussowitsch PetscCall(PetscObjectReference((PetscObject)jac->head->ksp)); 959443836d0SMatthew G Knepley } 960443836d0SMatthew G Knepley 96148a46eb9SPierre Jolivet if (jac->schurpre == PC_FIELDSPLIT_SCHUR_PRE_SELFP) PetscCall(MatSchurComplementGetPmat(jac->schur, MAT_INITIAL_MATRIX, &jac->schurp)); 9629566063dSJacob Faibussowitsch PetscCall(KSPCreate(PetscObjectComm((PetscObject)pc), &jac->kspschur)); 963*3821be0aSBarry Smith PetscCall(KSPSetNestLevel(jac->kspschur, pc->kspnestlevel)); 9649566063dSJacob Faibussowitsch PetscCall(KSPSetErrorIfNotConverged(jac->kspschur, pc->erroriffailure)); 9659566063dSJacob Faibussowitsch PetscCall(PetscObjectIncrementTabLevel((PetscObject)jac->kspschur, (PetscObject)pc, 1)); 966084e4875SJed Brown if (jac->schurpre == PC_FIELDSPLIT_SCHUR_PRE_SELF) { 9677233a360SDmitry Karpeev PC pcschur; 9689566063dSJacob Faibussowitsch PetscCall(KSPGetPC(jac->kspschur, &pcschur)); 9699566063dSJacob Faibussowitsch PetscCall(PCSetType(pcschur, PCNONE)); 970084e4875SJed Brown /* Note: This is bad if there exist preconditioners for MATSCHURCOMPLEMENT */ 971e74569cdSMatthew G. Knepley } else if (jac->schurpre == PC_FIELDSPLIT_SCHUR_PRE_FULL) { 9729566063dSJacob Faibussowitsch PetscCall(MatSchurComplementComputeExplicitOperator(jac->schur, &jac->schur_user)); 973e69d4d44SBarry Smith } 9749566063dSJacob Faibussowitsch PetscCall(KSPSetOperators(jac->kspschur, jac->schur, FieldSplitSchurPre(jac))); 9759566063dSJacob Faibussowitsch PetscCall(KSPGetOptionsPrefix(jac->head->next->ksp, &Dprefix)); 9769566063dSJacob Faibussowitsch PetscCall(KSPSetOptionsPrefix(jac->kspschur, Dprefix)); 977c096484dSStefano Zampini /* propagate DM */ 978b20b4189SMatthew G. Knepley { 979b20b4189SMatthew G. Knepley DM sdm; 9809566063dSJacob Faibussowitsch PetscCall(KSPGetDM(jac->head->next->ksp, &sdm)); 981b20b4189SMatthew G. Knepley if (sdm) { 9829566063dSJacob Faibussowitsch PetscCall(KSPSetDM(jac->kspschur, sdm)); 9839566063dSJacob Faibussowitsch PetscCall(KSPSetDMActive(jac->kspschur, PETSC_FALSE)); 984b20b4189SMatthew G. Knepley } 985b20b4189SMatthew G. Knepley } 9863b224e63SBarry Smith /* really want setfromoptions called in PCSetFromOptions_FieldSplit(), but it is not ready yet */ 98720b26d62SBarry Smith /* need to call this every time, since the jac->kspschur is freshly created, otherwise its options never get set */ 9889566063dSJacob Faibussowitsch PetscCall(KSPSetFromOptions(jac->kspschur)); 9893b224e63SBarry Smith } 9909566063dSJacob Faibussowitsch PetscCall(MatAssemblyBegin(jac->schur, MAT_FINAL_ASSEMBLY)); 9919566063dSJacob Faibussowitsch PetscCall(MatAssemblyEnd(jac->schur, MAT_FINAL_ASSEMBLY)); 992093c86ffSJed Brown 993093c86ffSJed Brown /* HACK: special support to forward L and Lp matrices that might be used by PCLSC */ 9949566063dSJacob Faibussowitsch PetscCall(PetscSNPrintf(lscname, sizeof(lscname), "%s_LSC_L", ilink->splitname)); 9959566063dSJacob Faibussowitsch PetscCall(PetscObjectQuery((PetscObject)pc->mat, lscname, (PetscObject *)&LSC_L)); 9969566063dSJacob Faibussowitsch if (!LSC_L) PetscCall(PetscObjectQuery((PetscObject)pc->pmat, lscname, (PetscObject *)&LSC_L)); 9979566063dSJacob Faibussowitsch if (LSC_L) PetscCall(PetscObjectCompose((PetscObject)jac->schur, "LSC_L", (PetscObject)LSC_L)); 9989566063dSJacob Faibussowitsch PetscCall(PetscSNPrintf(lscname, sizeof(lscname), "%s_LSC_Lp", ilink->splitname)); 9999566063dSJacob Faibussowitsch PetscCall(PetscObjectQuery((PetscObject)pc->pmat, lscname, (PetscObject *)&LSC_L)); 10009566063dSJacob Faibussowitsch if (!LSC_L) PetscCall(PetscObjectQuery((PetscObject)pc->mat, lscname, (PetscObject *)&LSC_L)); 10019566063dSJacob Faibussowitsch if (LSC_L) PetscCall(PetscObjectCompose((PetscObject)jac->schur, "LSC_Lp", (PetscObject)LSC_L)); 1002a51937d4SCarola Kruse } else if (jac->type == PC_COMPOSITE_GKB) { 1003a51937d4SCarola Kruse IS ccis; 1004a51937d4SCarola Kruse PetscInt rstart, rend; 1005a51937d4SCarola Kruse 100608401ef6SPierre Jolivet PetscCheck(nsplit == 2, PetscObjectComm((PetscObject)pc), PETSC_ERR_ARG_INCOMP, "To use GKB preconditioner you must have exactly 2 fields"); 1007a51937d4SCarola Kruse 1008a51937d4SCarola Kruse ilink = jac->head; 1009a51937d4SCarola Kruse 1010a51937d4SCarola Kruse /* When extracting off-diagonal submatrices, we take complements from this range */ 10119566063dSJacob Faibussowitsch PetscCall(MatGetOwnershipRangeColumn(pc->mat, &rstart, &rend)); 1012a51937d4SCarola Kruse 10139566063dSJacob Faibussowitsch PetscCall(ISComplement(ilink->is_col, rstart, rend, &ccis)); 1014a51937d4SCarola Kruse if (jac->offdiag_use_amat) { 10159566063dSJacob Faibussowitsch PetscCall(MatCreateSubMatrix(pc->mat, ilink->is, ccis, MAT_INITIAL_MATRIX, &jac->B)); 1016a51937d4SCarola Kruse } else { 10179566063dSJacob Faibussowitsch PetscCall(MatCreateSubMatrix(pc->pmat, ilink->is, ccis, MAT_INITIAL_MATRIX, &jac->B)); 1018a51937d4SCarola Kruse } 10199566063dSJacob Faibussowitsch PetscCall(ISDestroy(&ccis)); 1020e071a0a4SCarola Kruse /* Create work vectors for GKB algorithm */ 10219566063dSJacob Faibussowitsch PetscCall(VecDuplicate(ilink->x, &jac->u)); 10229566063dSJacob Faibussowitsch PetscCall(VecDuplicate(ilink->x, &jac->Hu)); 10239566063dSJacob Faibussowitsch PetscCall(VecDuplicate(ilink->x, &jac->w2)); 1024a51937d4SCarola Kruse ilink = ilink->next; 10259566063dSJacob Faibussowitsch PetscCall(ISComplement(ilink->is_col, rstart, rend, &ccis)); 1026a51937d4SCarola Kruse if (jac->offdiag_use_amat) { 10279566063dSJacob Faibussowitsch PetscCall(MatCreateSubMatrix(pc->mat, ilink->is, ccis, MAT_INITIAL_MATRIX, &jac->C)); 1028a51937d4SCarola Kruse } else { 10299566063dSJacob Faibussowitsch PetscCall(MatCreateSubMatrix(pc->pmat, ilink->is, ccis, MAT_INITIAL_MATRIX, &jac->C)); 1030a51937d4SCarola Kruse } 10319566063dSJacob Faibussowitsch PetscCall(ISDestroy(&ccis)); 1032e071a0a4SCarola Kruse /* Create work vectors for GKB algorithm */ 10339566063dSJacob Faibussowitsch PetscCall(VecDuplicate(ilink->x, &jac->v)); 10349566063dSJacob Faibussowitsch PetscCall(VecDuplicate(ilink->x, &jac->d)); 10359566063dSJacob Faibussowitsch PetscCall(VecDuplicate(ilink->x, &jac->w1)); 10369566063dSJacob Faibussowitsch PetscCall(MatGolubKahanComputeExplicitOperator(jac->mat[0], jac->B, jac->C, &jac->H, jac->gkbnu)); 10379566063dSJacob Faibussowitsch PetscCall(PetscCalloc1(jac->gkbdelay, &jac->vecz)); 1038e071a0a4SCarola Kruse 1039a51937d4SCarola Kruse ilink = jac->head; 10409566063dSJacob Faibussowitsch PetscCall(KSPSetOperators(ilink->ksp, jac->H, jac->H)); 10419566063dSJacob Faibussowitsch if (!jac->suboptionsset) PetscCall(KSPSetFromOptions(ilink->ksp)); 1042e071a0a4SCarola Kruse /* Create gkb_monitor context */ 1043de482cd7SCarola Kruse if (jac->gkbmonitor) { 1044de482cd7SCarola Kruse PetscInt tablevel; 10459566063dSJacob Faibussowitsch PetscCall(PetscViewerCreate(PETSC_COMM_WORLD, &jac->gkbviewer)); 10469566063dSJacob Faibussowitsch PetscCall(PetscViewerSetType(jac->gkbviewer, PETSCVIEWERASCII)); 10479566063dSJacob Faibussowitsch PetscCall(PetscObjectGetTabLevel((PetscObject)ilink->ksp, &tablevel)); 10489566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIISetTab(jac->gkbviewer, tablevel)); 10499566063dSJacob Faibussowitsch PetscCall(PetscObjectIncrementTabLevel((PetscObject)ilink->ksp, (PetscObject)ilink->ksp, 1)); 1050de482cd7SCarola Kruse } 10513b224e63SBarry Smith } else { 105268bd789dSDmitry Karpeev /* set up the individual splits' PCs */ 105397bbdb24SBarry Smith i = 0; 10545a9f2f41SSatish Balay ilink = jac->head; 10555a9f2f41SSatish Balay while (ilink) { 10569566063dSJacob Faibussowitsch PetscCall(KSPSetOperators(ilink->ksp, jac->mat[i], jac->pmat[i])); 10573b224e63SBarry Smith /* really want setfromoptions called in PCSetFromOptions_FieldSplit(), but it is not ready yet */ 10589566063dSJacob Faibussowitsch if (!jac->suboptionsset) PetscCall(KSPSetFromOptions(ilink->ksp)); 105997bbdb24SBarry Smith i++; 10605a9f2f41SSatish Balay ilink = ilink->next; 10610971522cSBarry Smith } 10623b224e63SBarry Smith } 10633b224e63SBarry Smith 10645ddf11f8SNicolas Barnafi /* Set coordinates to the sub PC objects whenever these are set */ 10655ddf11f8SNicolas Barnafi if (jac->coordinates_set) { 10665ddf11f8SNicolas Barnafi PC pc_coords; 10675ddf11f8SNicolas Barnafi if (jac->type == PC_COMPOSITE_SCHUR) { 10685ddf11f8SNicolas Barnafi // Head is first block. 10699566063dSJacob Faibussowitsch PetscCall(KSPGetPC(jac->head->ksp, &pc_coords)); 10709566063dSJacob Faibussowitsch PetscCall(PCSetCoordinates(pc_coords, jac->head->dim, jac->head->ndofs, jac->head->coords)); 10715ddf11f8SNicolas Barnafi // Second one is Schur block, but its KSP object is in kspschur. 10729566063dSJacob Faibussowitsch PetscCall(KSPGetPC(jac->kspschur, &pc_coords)); 10739566063dSJacob Faibussowitsch PetscCall(PCSetCoordinates(pc_coords, jac->head->next->dim, jac->head->next->ndofs, jac->head->next->coords)); 10745ddf11f8SNicolas Barnafi } else if (jac->type == PC_COMPOSITE_GKB) { 10759566063dSJacob Faibussowitsch PetscCall(PetscInfo(pc, "Warning: Setting coordinates does nothing for the GKB Fieldpslit preconditioner")); 10765ddf11f8SNicolas Barnafi } else { 10775ddf11f8SNicolas Barnafi ilink = jac->head; 10785ddf11f8SNicolas Barnafi while (ilink) { 10799566063dSJacob Faibussowitsch PetscCall(KSPGetPC(ilink->ksp, &pc_coords)); 10809566063dSJacob Faibussowitsch PetscCall(PCSetCoordinates(pc_coords, ilink->dim, ilink->ndofs, ilink->coords)); 10815ddf11f8SNicolas Barnafi ilink = ilink->next; 10825ddf11f8SNicolas Barnafi } 10835ddf11f8SNicolas Barnafi } 10845ddf11f8SNicolas Barnafi } 10855ddf11f8SNicolas Barnafi 1086c1570756SJed Brown jac->suboptionsset = PETSC_TRUE; 10873ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 10880971522cSBarry Smith } 10890971522cSBarry Smith 10905a9f2f41SSatish Balay #define FieldSplitSplitSolveAdd(ilink, xx, yy) \ 10913ba16761SJacob Faibussowitsch ((PetscErrorCode)(VecScatterBegin(ilink->sctx, xx, ilink->x, INSERT_VALUES, SCATTER_FORWARD) || VecScatterEnd(ilink->sctx, xx, ilink->x, INSERT_VALUES, SCATTER_FORWARD) || PetscLogEventBegin(ilink->event, ilink->ksp, ilink->x, ilink->y, NULL) || \ 10929371c9d4SSatish Balay KSPSolve(ilink->ksp, ilink->x, ilink->y) || KSPCheckSolve(ilink->ksp, pc, ilink->y) || PetscLogEventEnd(ilink->event, ilink->ksp, ilink->x, ilink->y, NULL) || VecScatterBegin(ilink->sctx, ilink->y, yy, ADD_VALUES, SCATTER_REVERSE) || \ 10933ba16761SJacob Faibussowitsch VecScatterEnd(ilink->sctx, ilink->y, yy, ADD_VALUES, SCATTER_REVERSE))) 109479416396SBarry Smith 1095d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCApply_FieldSplit_Schur(PC pc, Vec x, Vec y) 1096d71ae5a4SJacob Faibussowitsch { 10973b224e63SBarry Smith PC_FieldSplit *jac = (PC_FieldSplit *)pc->data; 10983b224e63SBarry Smith PC_FieldSplitLink ilinkA = jac->head, ilinkD = ilinkA->next; 1099443836d0SMatthew G Knepley KSP kspA = ilinkA->ksp, kspLower = kspA, kspUpper = jac->kspupper; 11003b224e63SBarry Smith 11013b224e63SBarry Smith PetscFunctionBegin; 1102c5d2311dSJed Brown switch (jac->schurfactorization) { 1103c9c6ffaaSJed Brown case PC_FIELDSPLIT_SCHUR_FACT_DIAG: 1104a04f6461SBarry Smith /* [A00 0; 0 -S], positive definite, suitable for MINRES */ 11059566063dSJacob Faibussowitsch PetscCall(VecScatterBegin(ilinkA->sctx, x, ilinkA->x, INSERT_VALUES, SCATTER_FORWARD)); 11069566063dSJacob Faibussowitsch PetscCall(VecScatterBegin(ilinkD->sctx, x, ilinkD->x, INSERT_VALUES, SCATTER_FORWARD)); 11079566063dSJacob Faibussowitsch PetscCall(VecScatterEnd(ilinkA->sctx, x, ilinkA->x, INSERT_VALUES, SCATTER_FORWARD)); 11089566063dSJacob Faibussowitsch PetscCall(PetscLogEventBegin(ilinkA->event, kspA, ilinkA->x, ilinkA->y, NULL)); 11099566063dSJacob Faibussowitsch PetscCall(KSPSolve(kspA, ilinkA->x, ilinkA->y)); 11109566063dSJacob Faibussowitsch PetscCall(KSPCheckSolve(kspA, pc, ilinkA->y)); 11119566063dSJacob Faibussowitsch PetscCall(PetscLogEventEnd(ilinkA->event, kspA, ilinkA->x, ilinkA->y, NULL)); 11129566063dSJacob Faibussowitsch PetscCall(VecScatterBegin(ilinkA->sctx, ilinkA->y, y, INSERT_VALUES, SCATTER_REVERSE)); 11139566063dSJacob Faibussowitsch PetscCall(VecScatterEnd(ilinkD->sctx, x, ilinkD->x, INSERT_VALUES, SCATTER_FORWARD)); 11149566063dSJacob Faibussowitsch PetscCall(PetscLogEventBegin(KSP_Solve_FS_S, jac->kspschur, ilinkD->x, ilinkD->y, NULL)); 11159566063dSJacob Faibussowitsch PetscCall(KSPSolve(jac->kspschur, ilinkD->x, ilinkD->y)); 11169566063dSJacob Faibussowitsch PetscCall(KSPCheckSolve(jac->kspschur, pc, ilinkD->y)); 11179566063dSJacob Faibussowitsch PetscCall(PetscLogEventEnd(KSP_Solve_FS_S, jac->kspschur, ilinkD->x, ilinkD->y, NULL)); 11189566063dSJacob Faibussowitsch PetscCall(VecScale(ilinkD->y, jac->schurscale)); 11199566063dSJacob Faibussowitsch PetscCall(VecScatterEnd(ilinkA->sctx, ilinkA->y, y, INSERT_VALUES, SCATTER_REVERSE)); 11209566063dSJacob Faibussowitsch PetscCall(VecScatterBegin(ilinkD->sctx, ilinkD->y, y, INSERT_VALUES, SCATTER_REVERSE)); 11219566063dSJacob Faibussowitsch PetscCall(VecScatterEnd(ilinkD->sctx, ilinkD->y, y, INSERT_VALUES, SCATTER_REVERSE)); 1122c5d2311dSJed Brown break; 1123c9c6ffaaSJed Brown case PC_FIELDSPLIT_SCHUR_FACT_LOWER: 1124a04f6461SBarry Smith /* [A00 0; A10 S], suitable for left preconditioning */ 11259566063dSJacob Faibussowitsch PetscCall(VecScatterBegin(ilinkA->sctx, x, ilinkA->x, INSERT_VALUES, SCATTER_FORWARD)); 11269566063dSJacob Faibussowitsch PetscCall(VecScatterEnd(ilinkA->sctx, x, ilinkA->x, INSERT_VALUES, SCATTER_FORWARD)); 11279566063dSJacob Faibussowitsch PetscCall(PetscLogEventBegin(ilinkA->event, kspA, ilinkA->x, ilinkA->y, NULL)); 11289566063dSJacob Faibussowitsch PetscCall(KSPSolve(kspA, ilinkA->x, ilinkA->y)); 11299566063dSJacob Faibussowitsch PetscCall(KSPCheckSolve(kspA, pc, ilinkA->y)); 11309566063dSJacob Faibussowitsch PetscCall(PetscLogEventEnd(ilinkA->event, kspA, ilinkA->x, ilinkA->y, NULL)); 11319566063dSJacob Faibussowitsch PetscCall(MatMult(jac->C, ilinkA->y, ilinkD->x)); 11329566063dSJacob Faibussowitsch PetscCall(VecScale(ilinkD->x, -1.)); 11339566063dSJacob Faibussowitsch PetscCall(VecScatterBegin(ilinkD->sctx, x, ilinkD->x, ADD_VALUES, SCATTER_FORWARD)); 11349566063dSJacob Faibussowitsch PetscCall(VecScatterBegin(ilinkA->sctx, ilinkA->y, y, INSERT_VALUES, SCATTER_REVERSE)); 11359566063dSJacob Faibussowitsch PetscCall(VecScatterEnd(ilinkD->sctx, x, ilinkD->x, ADD_VALUES, SCATTER_FORWARD)); 11369566063dSJacob Faibussowitsch PetscCall(PetscLogEventBegin(KSP_Solve_FS_S, jac->kspschur, ilinkD->x, ilinkD->y, NULL)); 11379566063dSJacob Faibussowitsch PetscCall(KSPSolve(jac->kspschur, ilinkD->x, ilinkD->y)); 11389566063dSJacob Faibussowitsch PetscCall(KSPCheckSolve(jac->kspschur, pc, ilinkD->y)); 11399566063dSJacob Faibussowitsch PetscCall(PetscLogEventEnd(KSP_Solve_FS_S, jac->kspschur, ilinkD->x, ilinkD->y, NULL)); 11409566063dSJacob Faibussowitsch PetscCall(VecScatterEnd(ilinkA->sctx, ilinkA->y, y, INSERT_VALUES, SCATTER_REVERSE)); 11419566063dSJacob Faibussowitsch PetscCall(VecScatterBegin(ilinkD->sctx, ilinkD->y, y, INSERT_VALUES, SCATTER_REVERSE)); 11429566063dSJacob Faibussowitsch PetscCall(VecScatterEnd(ilinkD->sctx, ilinkD->y, y, INSERT_VALUES, SCATTER_REVERSE)); 1143c5d2311dSJed Brown break; 1144c9c6ffaaSJed Brown case PC_FIELDSPLIT_SCHUR_FACT_UPPER: 1145a04f6461SBarry Smith /* [A00 A01; 0 S], suitable for right preconditioning */ 11469566063dSJacob Faibussowitsch PetscCall(VecScatterBegin(ilinkD->sctx, x, ilinkD->x, INSERT_VALUES, SCATTER_FORWARD)); 11479566063dSJacob Faibussowitsch PetscCall(VecScatterEnd(ilinkD->sctx, x, ilinkD->x, INSERT_VALUES, SCATTER_FORWARD)); 11489566063dSJacob Faibussowitsch PetscCall(PetscLogEventBegin(KSP_Solve_FS_S, jac->kspschur, ilinkD->x, ilinkD->y, NULL)); 11499566063dSJacob Faibussowitsch PetscCall(KSPSolve(jac->kspschur, ilinkD->x, ilinkD->y)); 11509566063dSJacob Faibussowitsch PetscCall(KSPCheckSolve(jac->kspschur, pc, ilinkD->y)); 11519371c9d4SSatish Balay PetscCall(PetscLogEventEnd(KSP_Solve_FS_S, jac->kspschur, ilinkD->x, ilinkD->y, NULL)); 11529371c9d4SSatish Balay PetscCall(MatMult(jac->B, ilinkD->y, ilinkA->x)); 11539566063dSJacob Faibussowitsch PetscCall(VecScale(ilinkA->x, -1.)); 11549566063dSJacob Faibussowitsch PetscCall(VecScatterBegin(ilinkA->sctx, x, ilinkA->x, ADD_VALUES, SCATTER_FORWARD)); 11559566063dSJacob Faibussowitsch PetscCall(VecScatterBegin(ilinkD->sctx, ilinkD->y, y, INSERT_VALUES, SCATTER_REVERSE)); 11569566063dSJacob Faibussowitsch PetscCall(VecScatterEnd(ilinkA->sctx, x, ilinkA->x, ADD_VALUES, SCATTER_FORWARD)); 11579566063dSJacob Faibussowitsch PetscCall(PetscLogEventBegin(ilinkA->event, kspA, ilinkA->x, ilinkA->y, NULL)); 11589566063dSJacob Faibussowitsch PetscCall(KSPSolve(kspA, ilinkA->x, ilinkA->y)); 11599566063dSJacob Faibussowitsch PetscCall(KSPCheckSolve(kspA, pc, ilinkA->y)); 11609566063dSJacob Faibussowitsch PetscCall(PetscLogEventEnd(ilinkA->event, kspA, ilinkA->x, ilinkA->y, NULL)); 11619566063dSJacob Faibussowitsch PetscCall(VecScatterEnd(ilinkD->sctx, ilinkD->y, y, INSERT_VALUES, SCATTER_REVERSE)); 11629566063dSJacob Faibussowitsch PetscCall(VecScatterBegin(ilinkA->sctx, ilinkA->y, y, INSERT_VALUES, SCATTER_REVERSE)); 11639566063dSJacob Faibussowitsch PetscCall(VecScatterEnd(ilinkA->sctx, ilinkA->y, y, INSERT_VALUES, SCATTER_REVERSE)); 1164c5d2311dSJed Brown break; 1165c9c6ffaaSJed Brown case PC_FIELDSPLIT_SCHUR_FACT_FULL: 1166c238f8cdSStefano Zampini /* [1 0; A10 A00^{-1} 1] [A00 0; 0 S] [1 A00^{-1}A01; 0 1] */ 11679566063dSJacob Faibussowitsch PetscCall(VecScatterBegin(ilinkA->sctx, x, ilinkA->x, INSERT_VALUES, SCATTER_FORWARD)); 11689566063dSJacob Faibussowitsch PetscCall(VecScatterEnd(ilinkA->sctx, x, ilinkA->x, INSERT_VALUES, SCATTER_FORWARD)); 11699566063dSJacob Faibussowitsch PetscCall(PetscLogEventBegin(KSP_Solve_FS_L, kspLower, ilinkA->x, ilinkA->y, NULL)); 11709566063dSJacob Faibussowitsch PetscCall(KSPSolve(kspLower, ilinkA->x, ilinkA->y)); 11719566063dSJacob Faibussowitsch PetscCall(KSPCheckSolve(kspLower, pc, ilinkA->y)); 11729566063dSJacob Faibussowitsch PetscCall(PetscLogEventEnd(KSP_Solve_FS_L, kspLower, ilinkA->x, ilinkA->y, NULL)); 11739566063dSJacob Faibussowitsch PetscCall(MatMult(jac->C, ilinkA->y, ilinkD->x)); 11749566063dSJacob Faibussowitsch PetscCall(VecScale(ilinkD->x, -1.0)); 11759566063dSJacob Faibussowitsch PetscCall(VecScatterBegin(ilinkD->sctx, x, ilinkD->x, ADD_VALUES, SCATTER_FORWARD)); 11769566063dSJacob Faibussowitsch PetscCall(VecScatterEnd(ilinkD->sctx, x, ilinkD->x, ADD_VALUES, SCATTER_FORWARD)); 11773b224e63SBarry Smith 11789566063dSJacob Faibussowitsch PetscCall(PetscLogEventBegin(KSP_Solve_FS_S, jac->kspschur, ilinkD->x, ilinkD->y, NULL)); 11799566063dSJacob Faibussowitsch PetscCall(KSPSolve(jac->kspschur, ilinkD->x, ilinkD->y)); 11809566063dSJacob Faibussowitsch PetscCall(KSPCheckSolve(jac->kspschur, pc, ilinkD->y)); 11819566063dSJacob Faibussowitsch PetscCall(PetscLogEventEnd(KSP_Solve_FS_S, jac->kspschur, ilinkD->x, ilinkD->y, NULL)); 11829566063dSJacob Faibussowitsch PetscCall(VecScatterBegin(ilinkD->sctx, ilinkD->y, y, INSERT_VALUES, SCATTER_REVERSE)); 11833b224e63SBarry Smith 1184443836d0SMatthew G Knepley if (kspUpper == kspA) { 11859566063dSJacob Faibussowitsch PetscCall(MatMult(jac->B, ilinkD->y, ilinkA->y)); 11869566063dSJacob Faibussowitsch PetscCall(VecAXPY(ilinkA->x, -1.0, ilinkA->y)); 11879566063dSJacob Faibussowitsch PetscCall(PetscLogEventBegin(ilinkA->event, kspA, ilinkA->x, ilinkA->y, NULL)); 11889566063dSJacob Faibussowitsch PetscCall(KSPSolve(kspA, ilinkA->x, ilinkA->y)); 11899566063dSJacob Faibussowitsch PetscCall(KSPCheckSolve(kspA, pc, ilinkA->y)); 11909566063dSJacob Faibussowitsch PetscCall(PetscLogEventEnd(ilinkA->event, kspA, ilinkA->x, ilinkA->y, NULL)); 1191443836d0SMatthew G Knepley } else { 11929566063dSJacob Faibussowitsch PetscCall(PetscLogEventBegin(ilinkA->event, kspA, ilinkA->x, ilinkA->y, NULL)); 11939566063dSJacob Faibussowitsch PetscCall(KSPSolve(kspA, ilinkA->x, ilinkA->y)); 11949566063dSJacob Faibussowitsch PetscCall(KSPCheckSolve(kspA, pc, ilinkA->y)); 11959566063dSJacob Faibussowitsch PetscCall(MatMult(jac->B, ilinkD->y, ilinkA->x)); 11969566063dSJacob Faibussowitsch PetscCall(PetscLogEventBegin(KSP_Solve_FS_U, kspUpper, ilinkA->x, ilinkA->z, NULL)); 11979566063dSJacob Faibussowitsch PetscCall(KSPSolve(kspUpper, ilinkA->x, ilinkA->z)); 11989566063dSJacob Faibussowitsch PetscCall(KSPCheckSolve(kspUpper, pc, ilinkA->z)); 11999566063dSJacob Faibussowitsch PetscCall(PetscLogEventEnd(KSP_Solve_FS_U, kspUpper, ilinkA->x, ilinkA->z, NULL)); 12009566063dSJacob Faibussowitsch PetscCall(VecAXPY(ilinkA->y, -1.0, ilinkA->z)); 1201443836d0SMatthew G Knepley } 12029566063dSJacob Faibussowitsch PetscCall(VecScatterEnd(ilinkD->sctx, ilinkD->y, y, INSERT_VALUES, SCATTER_REVERSE)); 12039566063dSJacob Faibussowitsch PetscCall(VecScatterBegin(ilinkA->sctx, ilinkA->y, y, INSERT_VALUES, SCATTER_REVERSE)); 12049566063dSJacob Faibussowitsch PetscCall(VecScatterEnd(ilinkA->sctx, ilinkA->y, y, INSERT_VALUES, SCATTER_REVERSE)); 1205c5d2311dSJed Brown } 12063ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 12073b224e63SBarry Smith } 12083b224e63SBarry Smith 12097b665727SPierre Jolivet static PetscErrorCode PCApplyTranspose_FieldSplit_Schur(PC pc, Vec x, Vec y) 12107b665727SPierre Jolivet { 12117b665727SPierre Jolivet PC_FieldSplit *jac = (PC_FieldSplit *)pc->data; 12127b665727SPierre Jolivet PC_FieldSplitLink ilinkA = jac->head, ilinkD = ilinkA->next; 12137b665727SPierre Jolivet KSP kspA = ilinkA->ksp, kspLower = kspA, kspUpper = jac->kspupper; 12147b665727SPierre Jolivet 12157b665727SPierre Jolivet PetscFunctionBegin; 12167b665727SPierre Jolivet switch (jac->schurfactorization) { 12177b665727SPierre Jolivet case PC_FIELDSPLIT_SCHUR_FACT_DIAG: 12187b665727SPierre Jolivet /* [A00 0; 0 -S], positive definite, suitable for MINRES */ 12197b665727SPierre Jolivet PetscCall(VecScatterBegin(ilinkA->sctx, x, ilinkA->x, INSERT_VALUES, SCATTER_FORWARD)); 12207b665727SPierre Jolivet PetscCall(VecScatterBegin(ilinkD->sctx, x, ilinkD->x, INSERT_VALUES, SCATTER_FORWARD)); 12217b665727SPierre Jolivet PetscCall(VecScatterEnd(ilinkA->sctx, x, ilinkA->x, INSERT_VALUES, SCATTER_FORWARD)); 12227b665727SPierre Jolivet PetscCall(PetscLogEventBegin(ilinkA->event, kspA, ilinkA->x, ilinkA->y, NULL)); 12237b665727SPierre Jolivet PetscCall(KSPSolveTranspose(kspA, ilinkA->x, ilinkA->y)); 12247b665727SPierre Jolivet PetscCall(KSPCheckSolve(kspA, pc, ilinkA->y)); 12257b665727SPierre Jolivet PetscCall(PetscLogEventEnd(ilinkA->event, kspA, ilinkA->x, ilinkA->y, NULL)); 12267b665727SPierre Jolivet PetscCall(VecScatterBegin(ilinkA->sctx, ilinkA->y, y, INSERT_VALUES, SCATTER_REVERSE)); 12277b665727SPierre Jolivet PetscCall(VecScatterEnd(ilinkD->sctx, x, ilinkD->x, INSERT_VALUES, SCATTER_FORWARD)); 12287b665727SPierre Jolivet PetscCall(PetscLogEventBegin(KSP_Solve_FS_S, jac->kspschur, ilinkD->x, ilinkD->y, NULL)); 12297b665727SPierre Jolivet PetscCall(KSPSolveTranspose(jac->kspschur, ilinkD->x, ilinkD->y)); 12307b665727SPierre Jolivet PetscCall(KSPCheckSolve(jac->kspschur, pc, ilinkD->y)); 12317b665727SPierre Jolivet PetscCall(PetscLogEventEnd(KSP_Solve_FS_S, jac->kspschur, ilinkD->x, ilinkD->y, NULL)); 12327b665727SPierre Jolivet PetscCall(VecScale(ilinkD->y, jac->schurscale)); 12337b665727SPierre Jolivet PetscCall(VecScatterEnd(ilinkA->sctx, ilinkA->y, y, INSERT_VALUES, SCATTER_REVERSE)); 12347b665727SPierre Jolivet PetscCall(VecScatterBegin(ilinkD->sctx, ilinkD->y, y, INSERT_VALUES, SCATTER_REVERSE)); 12357b665727SPierre Jolivet PetscCall(VecScatterEnd(ilinkD->sctx, ilinkD->y, y, INSERT_VALUES, SCATTER_REVERSE)); 12367b665727SPierre Jolivet break; 12377b665727SPierre Jolivet case PC_FIELDSPLIT_SCHUR_FACT_UPPER: 12387b665727SPierre Jolivet PetscCall(VecScatterBegin(ilinkA->sctx, x, ilinkA->x, INSERT_VALUES, SCATTER_FORWARD)); 12397b665727SPierre Jolivet PetscCall(VecScatterEnd(ilinkA->sctx, x, ilinkA->x, INSERT_VALUES, SCATTER_FORWARD)); 12407b665727SPierre Jolivet PetscCall(PetscLogEventBegin(ilinkA->event, kspA, ilinkA->x, ilinkA->y, NULL)); 12417b665727SPierre Jolivet PetscCall(KSPSolveTranspose(kspA, ilinkA->x, ilinkA->y)); 12427b665727SPierre Jolivet PetscCall(KSPCheckSolve(kspA, pc, ilinkA->y)); 12437b665727SPierre Jolivet PetscCall(PetscLogEventEnd(ilinkA->event, kspA, ilinkA->x, ilinkA->y, NULL)); 12447b665727SPierre Jolivet PetscCall(MatMultTranspose(jac->B, ilinkA->y, ilinkD->x)); 12457b665727SPierre Jolivet PetscCall(VecScale(ilinkD->x, -1.)); 12467b665727SPierre Jolivet PetscCall(VecScatterBegin(ilinkD->sctx, x, ilinkD->x, ADD_VALUES, SCATTER_FORWARD)); 12477b665727SPierre Jolivet PetscCall(VecScatterBegin(ilinkA->sctx, ilinkA->y, y, INSERT_VALUES, SCATTER_REVERSE)); 12487b665727SPierre Jolivet PetscCall(VecScatterEnd(ilinkD->sctx, x, ilinkD->x, ADD_VALUES, SCATTER_FORWARD)); 12497b665727SPierre Jolivet PetscCall(PetscLogEventBegin(KSP_Solve_FS_S, jac->kspschur, ilinkD->x, ilinkD->y, NULL)); 12507b665727SPierre Jolivet PetscCall(KSPSolveTranspose(jac->kspschur, ilinkD->x, ilinkD->y)); 12517b665727SPierre Jolivet PetscCall(KSPCheckSolve(jac->kspschur, pc, ilinkD->y)); 12527b665727SPierre Jolivet PetscCall(PetscLogEventEnd(KSP_Solve_FS_S, jac->kspschur, ilinkD->x, ilinkD->y, NULL)); 12537b665727SPierre Jolivet PetscCall(VecScatterEnd(ilinkA->sctx, ilinkA->y, y, INSERT_VALUES, SCATTER_REVERSE)); 12547b665727SPierre Jolivet PetscCall(VecScatterBegin(ilinkD->sctx, ilinkD->y, y, INSERT_VALUES, SCATTER_REVERSE)); 12557b665727SPierre Jolivet PetscCall(VecScatterEnd(ilinkD->sctx, ilinkD->y, y, INSERT_VALUES, SCATTER_REVERSE)); 12567b665727SPierre Jolivet break; 12577b665727SPierre Jolivet case PC_FIELDSPLIT_SCHUR_FACT_LOWER: 12587b665727SPierre Jolivet PetscCall(VecScatterBegin(ilinkD->sctx, x, ilinkD->x, INSERT_VALUES, SCATTER_FORWARD)); 12597b665727SPierre Jolivet PetscCall(VecScatterEnd(ilinkD->sctx, x, ilinkD->x, INSERT_VALUES, SCATTER_FORWARD)); 12607b665727SPierre Jolivet PetscCall(PetscLogEventBegin(KSP_Solve_FS_S, jac->kspschur, ilinkD->x, ilinkD->y, NULL)); 12617b665727SPierre Jolivet PetscCall(KSPSolveTranspose(jac->kspschur, ilinkD->x, ilinkD->y)); 12627b665727SPierre Jolivet PetscCall(KSPCheckSolve(jac->kspschur, pc, ilinkD->y)); 12637b665727SPierre Jolivet PetscCall(PetscLogEventEnd(KSP_Solve_FS_S, jac->kspschur, ilinkD->x, ilinkD->y, NULL)); 12647b665727SPierre Jolivet PetscCall(MatMultTranspose(jac->C, ilinkD->y, ilinkA->x)); 12657b665727SPierre Jolivet PetscCall(VecScale(ilinkA->x, -1.)); 12667b665727SPierre Jolivet PetscCall(VecScatterBegin(ilinkA->sctx, x, ilinkA->x, ADD_VALUES, SCATTER_FORWARD)); 12677b665727SPierre Jolivet PetscCall(VecScatterBegin(ilinkD->sctx, ilinkD->y, y, INSERT_VALUES, SCATTER_REVERSE)); 12687b665727SPierre Jolivet PetscCall(VecScatterEnd(ilinkA->sctx, x, ilinkA->x, ADD_VALUES, SCATTER_FORWARD)); 12697b665727SPierre Jolivet PetscCall(PetscLogEventBegin(ilinkA->event, kspA, ilinkA->x, ilinkA->y, NULL)); 12707b665727SPierre Jolivet PetscCall(KSPSolveTranspose(kspA, ilinkA->x, ilinkA->y)); 12717b665727SPierre Jolivet PetscCall(KSPCheckSolve(kspA, pc, ilinkA->y)); 12727b665727SPierre Jolivet PetscCall(PetscLogEventEnd(ilinkA->event, kspA, ilinkA->x, ilinkA->y, NULL)); 12737b665727SPierre Jolivet PetscCall(VecScatterEnd(ilinkD->sctx, ilinkD->y, y, INSERT_VALUES, SCATTER_REVERSE)); 12747b665727SPierre Jolivet PetscCall(VecScatterBegin(ilinkA->sctx, ilinkA->y, y, INSERT_VALUES, SCATTER_REVERSE)); 12757b665727SPierre Jolivet PetscCall(VecScatterEnd(ilinkA->sctx, ilinkA->y, y, INSERT_VALUES, SCATTER_REVERSE)); 12767b665727SPierre Jolivet break; 12777b665727SPierre Jolivet case PC_FIELDSPLIT_SCHUR_FACT_FULL: 12787b665727SPierre Jolivet PetscCall(VecScatterBegin(ilinkA->sctx, x, ilinkA->x, INSERT_VALUES, SCATTER_FORWARD)); 12797b665727SPierre Jolivet PetscCall(VecScatterEnd(ilinkA->sctx, x, ilinkA->x, INSERT_VALUES, SCATTER_FORWARD)); 12807b665727SPierre Jolivet PetscCall(PetscLogEventBegin(KSP_Solve_FS_U, kspUpper, ilinkA->x, ilinkA->y, NULL)); 12817b665727SPierre Jolivet PetscCall(KSPSolveTranspose(kspUpper, ilinkA->x, ilinkA->y)); 12827b665727SPierre Jolivet PetscCall(KSPCheckSolve(kspUpper, pc, ilinkA->y)); 12837b665727SPierre Jolivet PetscCall(PetscLogEventEnd(KSP_Solve_FS_U, kspUpper, ilinkA->x, ilinkA->y, NULL)); 12847b665727SPierre Jolivet PetscCall(MatMultTranspose(jac->B, ilinkA->y, ilinkD->x)); 12857b665727SPierre Jolivet PetscCall(VecScale(ilinkD->x, -1.0)); 12867b665727SPierre Jolivet PetscCall(VecScatterBegin(ilinkD->sctx, x, ilinkD->x, ADD_VALUES, SCATTER_FORWARD)); 12877b665727SPierre Jolivet PetscCall(VecScatterEnd(ilinkD->sctx, x, ilinkD->x, ADD_VALUES, SCATTER_FORWARD)); 12887b665727SPierre Jolivet 12897b665727SPierre Jolivet PetscCall(PetscLogEventBegin(KSP_Solve_FS_S, jac->kspschur, ilinkD->x, ilinkD->y, NULL)); 12907b665727SPierre Jolivet PetscCall(KSPSolveTranspose(jac->kspschur, ilinkD->x, ilinkD->y)); 12917b665727SPierre Jolivet PetscCall(KSPCheckSolve(jac->kspschur, pc, ilinkD->y)); 12927b665727SPierre Jolivet PetscCall(PetscLogEventEnd(KSP_Solve_FS_S, jac->kspschur, ilinkD->x, ilinkD->y, NULL)); 12937b665727SPierre Jolivet PetscCall(VecScatterBegin(ilinkD->sctx, ilinkD->y, y, INSERT_VALUES, SCATTER_REVERSE)); 12947b665727SPierre Jolivet 12957b665727SPierre Jolivet if (kspLower == kspA) { 12967b665727SPierre Jolivet PetscCall(MatMultTranspose(jac->C, ilinkD->y, ilinkA->y)); 12977b665727SPierre Jolivet PetscCall(VecAXPY(ilinkA->x, -1.0, ilinkA->y)); 12987b665727SPierre Jolivet PetscCall(PetscLogEventBegin(ilinkA->event, kspA, ilinkA->x, ilinkA->y, NULL)); 12997b665727SPierre Jolivet PetscCall(KSPSolveTranspose(kspA, ilinkA->x, ilinkA->y)); 13007b665727SPierre Jolivet PetscCall(KSPCheckSolve(kspA, pc, ilinkA->y)); 13017b665727SPierre Jolivet PetscCall(PetscLogEventEnd(ilinkA->event, kspA, ilinkA->x, ilinkA->y, NULL)); 13027b665727SPierre Jolivet } else { 13037b665727SPierre Jolivet PetscCall(PetscLogEventBegin(ilinkA->event, kspA, ilinkA->x, ilinkA->y, NULL)); 13047b665727SPierre Jolivet PetscCall(KSPSolveTranspose(kspA, ilinkA->x, ilinkA->y)); 13057b665727SPierre Jolivet PetscCall(KSPCheckSolve(kspA, pc, ilinkA->y)); 13067b665727SPierre Jolivet PetscCall(MatMultTranspose(jac->C, ilinkD->y, ilinkA->x)); 13077b665727SPierre Jolivet PetscCall(PetscLogEventBegin(KSP_Solve_FS_L, kspLower, ilinkA->x, ilinkA->z, NULL)); 13087b665727SPierre Jolivet PetscCall(KSPSolveTranspose(kspLower, ilinkA->x, ilinkA->z)); 13097b665727SPierre Jolivet PetscCall(KSPCheckSolve(kspLower, pc, ilinkA->z)); 13107b665727SPierre Jolivet PetscCall(PetscLogEventEnd(KSP_Solve_FS_L, kspLower, ilinkA->x, ilinkA->z, NULL)); 13117b665727SPierre Jolivet PetscCall(VecAXPY(ilinkA->y, -1.0, ilinkA->z)); 13127b665727SPierre Jolivet } 13137b665727SPierre Jolivet PetscCall(VecScatterEnd(ilinkD->sctx, ilinkD->y, y, INSERT_VALUES, SCATTER_REVERSE)); 13147b665727SPierre Jolivet PetscCall(VecScatterBegin(ilinkA->sctx, ilinkA->y, y, INSERT_VALUES, SCATTER_REVERSE)); 13157b665727SPierre Jolivet PetscCall(VecScatterEnd(ilinkA->sctx, ilinkA->y, y, INSERT_VALUES, SCATTER_REVERSE)); 13167b665727SPierre Jolivet } 13177b665727SPierre Jolivet PetscFunctionReturn(PETSC_SUCCESS); 13187b665727SPierre Jolivet } 13197b665727SPierre Jolivet 1320d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCApply_FieldSplit(PC pc, Vec x, Vec y) 1321d71ae5a4SJacob Faibussowitsch { 13220971522cSBarry Smith PC_FieldSplit *jac = (PC_FieldSplit *)pc->data; 13235a9f2f41SSatish Balay PC_FieldSplitLink ilink = jac->head; 1324939b8a20SBarry Smith PetscInt cnt, bs; 13250971522cSBarry Smith 13260971522cSBarry Smith PetscFunctionBegin; 132779416396SBarry Smith if (jac->type == PC_COMPOSITE_ADDITIVE) { 13281b9fc7fcSBarry Smith if (jac->defaultsplit) { 13299566063dSJacob Faibussowitsch PetscCall(VecGetBlockSize(x, &bs)); 13302472a847SBarry Smith PetscCheck(jac->bs <= 0 || bs == jac->bs, PetscObjectComm((PetscObject)pc), PETSC_ERR_ARG_WRONGSTATE, "Blocksize of x vector %" PetscInt_FMT " does not match fieldsplit blocksize %" PetscInt_FMT, bs, jac->bs); 13319566063dSJacob Faibussowitsch PetscCall(VecGetBlockSize(y, &bs)); 13322472a847SBarry Smith PetscCheck(jac->bs <= 0 || bs == jac->bs, PetscObjectComm((PetscObject)pc), PETSC_ERR_ARG_WRONGSTATE, "Blocksize of y vector %" PetscInt_FMT " does not match fieldsplit blocksize %" PetscInt_FMT, bs, jac->bs); 13339566063dSJacob Faibussowitsch PetscCall(VecStrideGatherAll(x, jac->x, INSERT_VALUES)); 13345a9f2f41SSatish Balay while (ilink) { 13359566063dSJacob Faibussowitsch PetscCall(PetscLogEventBegin(ilink->event, ilink->ksp, ilink->x, ilink->y, NULL)); 13369566063dSJacob Faibussowitsch PetscCall(KSPSolve(ilink->ksp, ilink->x, ilink->y)); 13379566063dSJacob Faibussowitsch PetscCall(KSPCheckSolve(ilink->ksp, pc, ilink->y)); 13389566063dSJacob Faibussowitsch PetscCall(PetscLogEventEnd(ilink->event, ilink->ksp, ilink->x, ilink->y, NULL)); 13395a9f2f41SSatish Balay ilink = ilink->next; 13400971522cSBarry Smith } 13419566063dSJacob Faibussowitsch PetscCall(VecStrideScatterAll(jac->y, y, INSERT_VALUES)); 13421b9fc7fcSBarry Smith } else { 13439566063dSJacob Faibussowitsch PetscCall(VecSet(y, 0.0)); 13445a9f2f41SSatish Balay while (ilink) { 13459566063dSJacob Faibussowitsch PetscCall(FieldSplitSplitSolveAdd(ilink, x, y)); 13465a9f2f41SSatish Balay ilink = ilink->next; 13471b9fc7fcSBarry Smith } 13481b9fc7fcSBarry Smith } 1349e52d2c62SBarry Smith } else if (jac->type == PC_COMPOSITE_MULTIPLICATIVE && jac->nsplits == 2) { 13509566063dSJacob Faibussowitsch PetscCall(VecSet(y, 0.0)); 1351e52d2c62SBarry Smith /* solve on first block for first block variables */ 13529566063dSJacob Faibussowitsch PetscCall(VecScatterBegin(ilink->sctx, x, ilink->x, INSERT_VALUES, SCATTER_FORWARD)); 13539566063dSJacob Faibussowitsch PetscCall(VecScatterEnd(ilink->sctx, x, ilink->x, INSERT_VALUES, SCATTER_FORWARD)); 13549566063dSJacob Faibussowitsch PetscCall(PetscLogEventBegin(ilink->event, ilink->ksp, ilink->x, ilink->y, NULL)); 13559566063dSJacob Faibussowitsch PetscCall(KSPSolve(ilink->ksp, ilink->x, ilink->y)); 13569566063dSJacob Faibussowitsch PetscCall(KSPCheckSolve(ilink->ksp, pc, ilink->y)); 13579566063dSJacob Faibussowitsch PetscCall(PetscLogEventEnd(ilink->event, ilink->ksp, ilink->x, ilink->y, NULL)); 13589566063dSJacob Faibussowitsch PetscCall(VecScatterBegin(ilink->sctx, ilink->y, y, ADD_VALUES, SCATTER_REVERSE)); 13599566063dSJacob Faibussowitsch PetscCall(VecScatterEnd(ilink->sctx, ilink->y, y, ADD_VALUES, SCATTER_REVERSE)); 1360e52d2c62SBarry Smith 1361e52d2c62SBarry Smith /* compute the residual only onto second block variables using first block variables */ 13629566063dSJacob Faibussowitsch PetscCall(MatMult(jac->Afield[1], ilink->y, ilink->next->x)); 1363e52d2c62SBarry Smith ilink = ilink->next; 13649566063dSJacob Faibussowitsch PetscCall(VecScale(ilink->x, -1.0)); 13659566063dSJacob Faibussowitsch PetscCall(VecScatterBegin(ilink->sctx, x, ilink->x, ADD_VALUES, SCATTER_FORWARD)); 13669566063dSJacob Faibussowitsch PetscCall(VecScatterEnd(ilink->sctx, x, ilink->x, ADD_VALUES, SCATTER_FORWARD)); 1367e52d2c62SBarry Smith 1368e52d2c62SBarry Smith /* solve on second block variables */ 13699566063dSJacob Faibussowitsch PetscCall(PetscLogEventBegin(ilink->event, ilink->ksp, ilink->x, ilink->y, NULL)); 13709566063dSJacob Faibussowitsch PetscCall(KSPSolve(ilink->ksp, ilink->x, ilink->y)); 13719566063dSJacob Faibussowitsch PetscCall(KSPCheckSolve(ilink->ksp, pc, ilink->y)); 13729566063dSJacob Faibussowitsch PetscCall(PetscLogEventEnd(ilink->event, ilink->ksp, ilink->x, ilink->y, NULL)); 13739566063dSJacob Faibussowitsch PetscCall(VecScatterBegin(ilink->sctx, ilink->y, y, ADD_VALUES, SCATTER_REVERSE)); 13749566063dSJacob Faibussowitsch PetscCall(VecScatterEnd(ilink->sctx, ilink->y, y, ADD_VALUES, SCATTER_REVERSE)); 137516913363SBarry Smith } else if (jac->type == PC_COMPOSITE_MULTIPLICATIVE || jac->type == PC_COMPOSITE_SYMMETRIC_MULTIPLICATIVE) { 137679416396SBarry Smith if (!jac->w1) { 13779566063dSJacob Faibussowitsch PetscCall(VecDuplicate(x, &jac->w1)); 13789566063dSJacob Faibussowitsch PetscCall(VecDuplicate(x, &jac->w2)); 137979416396SBarry Smith } 13809566063dSJacob Faibussowitsch PetscCall(VecSet(y, 0.0)); 13819566063dSJacob Faibussowitsch PetscCall(FieldSplitSplitSolveAdd(ilink, x, y)); 13823e197d65SBarry Smith cnt = 1; 13835a9f2f41SSatish Balay while (ilink->next) { 13845a9f2f41SSatish Balay ilink = ilink->next; 13853e197d65SBarry Smith /* compute the residual only over the part of the vector needed */ 13869566063dSJacob Faibussowitsch PetscCall(MatMult(jac->Afield[cnt++], y, ilink->x)); 13879566063dSJacob Faibussowitsch PetscCall(VecScale(ilink->x, -1.0)); 13889566063dSJacob Faibussowitsch PetscCall(VecScatterBegin(ilink->sctx, x, ilink->x, ADD_VALUES, SCATTER_FORWARD)); 13899566063dSJacob Faibussowitsch PetscCall(VecScatterEnd(ilink->sctx, x, ilink->x, ADD_VALUES, SCATTER_FORWARD)); 13909566063dSJacob Faibussowitsch PetscCall(PetscLogEventBegin(ilink->event, ilink->ksp, ilink->x, ilink->y, NULL)); 13919566063dSJacob Faibussowitsch PetscCall(KSPSolve(ilink->ksp, ilink->x, ilink->y)); 13929566063dSJacob Faibussowitsch PetscCall(KSPCheckSolve(ilink->ksp, pc, ilink->y)); 13939566063dSJacob Faibussowitsch PetscCall(PetscLogEventEnd(ilink->event, ilink->ksp, ilink->x, ilink->y, NULL)); 13949566063dSJacob Faibussowitsch PetscCall(VecScatterBegin(ilink->sctx, ilink->y, y, ADD_VALUES, SCATTER_REVERSE)); 13959566063dSJacob Faibussowitsch PetscCall(VecScatterEnd(ilink->sctx, ilink->y, y, ADD_VALUES, SCATTER_REVERSE)); 13963e197d65SBarry Smith } 139751f519a2SBarry Smith if (jac->type == PC_COMPOSITE_SYMMETRIC_MULTIPLICATIVE) { 139811755939SBarry Smith cnt -= 2; 139951f519a2SBarry Smith while (ilink->previous) { 140051f519a2SBarry Smith ilink = ilink->previous; 140111755939SBarry Smith /* compute the residual only over the part of the vector needed */ 14029566063dSJacob Faibussowitsch PetscCall(MatMult(jac->Afield[cnt--], y, ilink->x)); 14039566063dSJacob Faibussowitsch PetscCall(VecScale(ilink->x, -1.0)); 14049566063dSJacob Faibussowitsch PetscCall(VecScatterBegin(ilink->sctx, x, ilink->x, ADD_VALUES, SCATTER_FORWARD)); 14059566063dSJacob Faibussowitsch PetscCall(VecScatterEnd(ilink->sctx, x, ilink->x, ADD_VALUES, SCATTER_FORWARD)); 14069566063dSJacob Faibussowitsch PetscCall(PetscLogEventBegin(ilink->event, ilink->ksp, ilink->x, ilink->y, NULL)); 14079566063dSJacob Faibussowitsch PetscCall(KSPSolve(ilink->ksp, ilink->x, ilink->y)); 14089566063dSJacob Faibussowitsch PetscCall(KSPCheckSolve(ilink->ksp, pc, ilink->y)); 14099566063dSJacob Faibussowitsch PetscCall(PetscLogEventEnd(ilink->event, ilink->ksp, ilink->x, ilink->y, NULL)); 14109566063dSJacob Faibussowitsch PetscCall(VecScatterBegin(ilink->sctx, ilink->y, y, ADD_VALUES, SCATTER_REVERSE)); 14119566063dSJacob Faibussowitsch PetscCall(VecScatterEnd(ilink->sctx, ilink->y, y, ADD_VALUES, SCATTER_REVERSE)); 141251f519a2SBarry Smith } 141311755939SBarry Smith } 141463a3b9bcSJacob Faibussowitsch } else SETERRQ(PetscObjectComm((PetscObject)pc), PETSC_ERR_SUP, "Unsupported or unknown composition %d", (int)jac->type); 14153ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 14160971522cSBarry Smith } 14170971522cSBarry Smith 1418d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCApply_FieldSplit_GKB(PC pc, Vec x, Vec y) 1419d71ae5a4SJacob Faibussowitsch { 1420a51937d4SCarola Kruse PC_FieldSplit *jac = (PC_FieldSplit *)pc->data; 1421a51937d4SCarola Kruse PC_FieldSplitLink ilinkA = jac->head, ilinkD = ilinkA->next; 1422a51937d4SCarola Kruse KSP ksp = ilinkA->ksp; 1423de482cd7SCarola Kruse Vec u, v, Hu, d, work1, work2; 1424e071a0a4SCarola Kruse PetscScalar alpha, z, nrmz2, *vecz; 1425e071a0a4SCarola Kruse PetscReal lowbnd, nu, beta; 1426a51937d4SCarola Kruse PetscInt j, iterGKB; 1427a51937d4SCarola Kruse 1428a51937d4SCarola Kruse PetscFunctionBegin; 14299566063dSJacob Faibussowitsch PetscCall(VecScatterBegin(ilinkA->sctx, x, ilinkA->x, INSERT_VALUES, SCATTER_FORWARD)); 14309566063dSJacob Faibussowitsch PetscCall(VecScatterBegin(ilinkD->sctx, x, ilinkD->x, INSERT_VALUES, SCATTER_FORWARD)); 14319566063dSJacob Faibussowitsch PetscCall(VecScatterEnd(ilinkA->sctx, x, ilinkA->x, INSERT_VALUES, SCATTER_FORWARD)); 14329566063dSJacob Faibussowitsch PetscCall(VecScatterEnd(ilinkD->sctx, x, ilinkD->x, INSERT_VALUES, SCATTER_FORWARD)); 1433e071a0a4SCarola Kruse 1434e071a0a4SCarola Kruse u = jac->u; 1435e071a0a4SCarola Kruse v = jac->v; 1436e071a0a4SCarola Kruse Hu = jac->Hu; 1437e071a0a4SCarola Kruse d = jac->d; 1438e071a0a4SCarola Kruse work1 = jac->w1; 1439e071a0a4SCarola Kruse work2 = jac->w2; 1440e071a0a4SCarola Kruse vecz = jac->vecz; 1441a51937d4SCarola Kruse 1442a51937d4SCarola Kruse /* Change RHS to comply with matrix regularization H = A + nu*B*B' */ 1443a51937d4SCarola Kruse /* Add q = q + nu*B*b */ 1444a51937d4SCarola Kruse if (jac->gkbnu) { 1445a51937d4SCarola Kruse nu = jac->gkbnu; 14469566063dSJacob Faibussowitsch PetscCall(VecScale(ilinkD->x, jac->gkbnu)); 14479566063dSJacob Faibussowitsch PetscCall(MatMultAdd(jac->B, ilinkD->x, ilinkA->x, ilinkA->x)); /* q = q + nu*B*b */ 1448a51937d4SCarola Kruse } else { 1449a51937d4SCarola Kruse /* Situation when no augmented Lagrangian is used. Then we set inner */ 1450a51937d4SCarola Kruse /* matrix N = I in [Ar13], and thus nu = 1. */ 1451a51937d4SCarola Kruse nu = 1; 1452a51937d4SCarola Kruse } 1453a51937d4SCarola Kruse 1454a51937d4SCarola Kruse /* Transform rhs from [q,tilde{b}] to [0,b] */ 14559566063dSJacob Faibussowitsch PetscCall(PetscLogEventBegin(ilinkA->event, ksp, ilinkA->x, ilinkA->y, NULL)); 14569566063dSJacob Faibussowitsch PetscCall(KSPSolve(ksp, ilinkA->x, ilinkA->y)); 14579566063dSJacob Faibussowitsch PetscCall(KSPCheckSolve(ksp, pc, ilinkA->y)); 14589566063dSJacob Faibussowitsch PetscCall(PetscLogEventEnd(ilinkA->event, ksp, ilinkA->x, ilinkA->y, NULL)); 14599566063dSJacob Faibussowitsch PetscCall(MatMultHermitianTranspose(jac->B, ilinkA->y, work1)); 14609566063dSJacob Faibussowitsch PetscCall(VecAXPBY(work1, 1.0 / nu, -1.0, ilinkD->x)); /* c = b - B'*x */ 1461a51937d4SCarola Kruse 1462a51937d4SCarola Kruse /* First step of algorithm */ 14639566063dSJacob Faibussowitsch PetscCall(VecNorm(work1, NORM_2, &beta)); /* beta = sqrt(nu*c'*c)*/ 1464e071a0a4SCarola Kruse KSPCheckDot(ksp, beta); 1465addd1e01SJunchao Zhang beta = PetscSqrtReal(nu) * beta; 14669566063dSJacob Faibussowitsch PetscCall(VecAXPBY(v, nu / beta, 0.0, work1)); /* v = nu/beta *c */ 14679566063dSJacob Faibussowitsch PetscCall(MatMult(jac->B, v, work2)); /* u = H^{-1}*B*v */ 14689566063dSJacob Faibussowitsch PetscCall(PetscLogEventBegin(ilinkA->event, ksp, work2, u, NULL)); 14699566063dSJacob Faibussowitsch PetscCall(KSPSolve(ksp, work2, u)); 14709566063dSJacob Faibussowitsch PetscCall(KSPCheckSolve(ksp, pc, u)); 14719566063dSJacob Faibussowitsch PetscCall(PetscLogEventEnd(ilinkA->event, ksp, work2, u, NULL)); 14729566063dSJacob Faibussowitsch PetscCall(MatMult(jac->H, u, Hu)); /* alpha = u'*H*u */ 14739566063dSJacob Faibussowitsch PetscCall(VecDot(Hu, u, &alpha)); 1474e071a0a4SCarola Kruse KSPCheckDot(ksp, alpha); 147508401ef6SPierre Jolivet PetscCheck(PetscRealPart(alpha) > 0.0, PETSC_COMM_SELF, PETSC_ERR_NOT_CONVERGED, "GKB preconditioner diverged, H is not positive definite"); 1476addd1e01SJunchao Zhang alpha = PetscSqrtReal(PetscAbsScalar(alpha)); 14779566063dSJacob Faibussowitsch PetscCall(VecScale(u, 1.0 / alpha)); 14789566063dSJacob Faibussowitsch PetscCall(VecAXPBY(d, 1.0 / alpha, 0.0, v)); /* v = nu/beta *c */ 1479de482cd7SCarola Kruse 1480a51937d4SCarola Kruse z = beta / alpha; 1481a51937d4SCarola Kruse vecz[1] = z; 1482a51937d4SCarola Kruse 1483de482cd7SCarola Kruse /* Computation of first iterate x(1) and p(1) */ 14849566063dSJacob Faibussowitsch PetscCall(VecAXPY(ilinkA->y, z, u)); 14859566063dSJacob Faibussowitsch PetscCall(VecCopy(d, ilinkD->y)); 14869566063dSJacob Faibussowitsch PetscCall(VecScale(ilinkD->y, -z)); 1487a51937d4SCarola Kruse 14889371c9d4SSatish Balay iterGKB = 1; 14899371c9d4SSatish Balay lowbnd = 2 * jac->gkbtol; 149048a46eb9SPierre Jolivet if (jac->gkbmonitor) PetscCall(PetscViewerASCIIPrintf(jac->gkbviewer, "%3" PetscInt_FMT " GKB Lower bound estimate %14.12e\n", iterGKB, (double)lowbnd)); 1491de482cd7SCarola Kruse 1492a51937d4SCarola Kruse while (iterGKB < jac->gkbmaxit && lowbnd > jac->gkbtol) { 1493a51937d4SCarola Kruse iterGKB += 1; 14949566063dSJacob Faibussowitsch PetscCall(MatMultHermitianTranspose(jac->B, u, work1)); /* v <- nu*(B'*u-alpha/nu*v) */ 14959566063dSJacob Faibussowitsch PetscCall(VecAXPBY(v, nu, -alpha, work1)); 14969566063dSJacob Faibussowitsch PetscCall(VecNorm(v, NORM_2, &beta)); /* beta = sqrt(nu)*v'*v */ 1497addd1e01SJunchao Zhang beta = beta / PetscSqrtReal(nu); 14989566063dSJacob Faibussowitsch PetscCall(VecScale(v, 1.0 / beta)); 14999566063dSJacob Faibussowitsch PetscCall(MatMult(jac->B, v, work2)); /* u <- H^{-1}*(B*v-beta*H*u) */ 15009566063dSJacob Faibussowitsch PetscCall(MatMult(jac->H, u, Hu)); 15019566063dSJacob Faibussowitsch PetscCall(VecAXPY(work2, -beta, Hu)); 15029566063dSJacob Faibussowitsch PetscCall(PetscLogEventBegin(ilinkA->event, ksp, work2, u, NULL)); 15039566063dSJacob Faibussowitsch PetscCall(KSPSolve(ksp, work2, u)); 15049566063dSJacob Faibussowitsch PetscCall(KSPCheckSolve(ksp, pc, u)); 15059566063dSJacob Faibussowitsch PetscCall(PetscLogEventEnd(ilinkA->event, ksp, work2, u, NULL)); 15069566063dSJacob Faibussowitsch PetscCall(MatMult(jac->H, u, Hu)); /* alpha = u'*H*u */ 15079566063dSJacob Faibussowitsch PetscCall(VecDot(Hu, u, &alpha)); 1508e071a0a4SCarola Kruse KSPCheckDot(ksp, alpha); 150908401ef6SPierre Jolivet PetscCheck(PetscRealPart(alpha) > 0.0, PETSC_COMM_SELF, PETSC_ERR_NOT_CONVERGED, "GKB preconditioner diverged, H is not positive definite"); 1510addd1e01SJunchao Zhang alpha = PetscSqrtReal(PetscAbsScalar(alpha)); 15119566063dSJacob Faibussowitsch PetscCall(VecScale(u, 1.0 / alpha)); 1512a51937d4SCarola Kruse 1513e071a0a4SCarola Kruse z = -beta / alpha * z; /* z <- beta/alpha*z */ 1514a51937d4SCarola Kruse vecz[0] = z; 1515a51937d4SCarola Kruse 1516a51937d4SCarola Kruse /* Computation of new iterate x(i+1) and p(i+1) */ 15179566063dSJacob Faibussowitsch PetscCall(VecAXPBY(d, 1.0 / alpha, -beta / alpha, v)); /* d = (v-beta*d)/alpha */ 15189566063dSJacob Faibussowitsch PetscCall(VecAXPY(ilinkA->y, z, u)); /* r = r + z*u */ 15199566063dSJacob Faibussowitsch PetscCall(VecAXPY(ilinkD->y, -z, d)); /* p = p - z*d */ 15209566063dSJacob Faibussowitsch PetscCall(MatMult(jac->H, ilinkA->y, Hu)); /* ||u||_H = u'*H*u */ 15219566063dSJacob Faibussowitsch PetscCall(VecDot(Hu, ilinkA->y, &nrmz2)); 1522a51937d4SCarola Kruse 1523a51937d4SCarola Kruse /* Compute Lower Bound estimate */ 1524a51937d4SCarola Kruse if (iterGKB > jac->gkbdelay) { 1525a51937d4SCarola Kruse lowbnd = 0.0; 1526ad540459SPierre Jolivet for (j = 0; j < jac->gkbdelay; j++) lowbnd += PetscAbsScalar(vecz[j] * vecz[j]); 1527addd1e01SJunchao Zhang lowbnd = PetscSqrtReal(lowbnd / PetscAbsScalar(nrmz2)); 1528a51937d4SCarola Kruse } 1529a51937d4SCarola Kruse 1530ad540459SPierre Jolivet for (j = 0; j < jac->gkbdelay - 1; j++) vecz[jac->gkbdelay - j - 1] = vecz[jac->gkbdelay - j - 2]; 153148a46eb9SPierre Jolivet if (jac->gkbmonitor) PetscCall(PetscViewerASCIIPrintf(jac->gkbviewer, "%3" PetscInt_FMT " GKB Lower bound estimate %14.12e\n", iterGKB, (double)lowbnd)); 1532a51937d4SCarola Kruse } 1533a51937d4SCarola Kruse 15349566063dSJacob Faibussowitsch PetscCall(VecScatterBegin(ilinkA->sctx, ilinkA->y, y, INSERT_VALUES, SCATTER_REVERSE)); 15359566063dSJacob Faibussowitsch PetscCall(VecScatterEnd(ilinkA->sctx, ilinkA->y, y, INSERT_VALUES, SCATTER_REVERSE)); 15369566063dSJacob Faibussowitsch PetscCall(VecScatterBegin(ilinkD->sctx, ilinkD->y, y, INSERT_VALUES, SCATTER_REVERSE)); 15379566063dSJacob Faibussowitsch PetscCall(VecScatterEnd(ilinkD->sctx, ilinkD->y, y, INSERT_VALUES, SCATTER_REVERSE)); 1538a51937d4SCarola Kruse 15393ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 1540a51937d4SCarola Kruse } 1541a51937d4SCarola Kruse 1542421e10b8SBarry Smith #define FieldSplitSplitSolveAddTranspose(ilink, xx, yy) \ 15433ba16761SJacob Faibussowitsch ((PetscErrorCode)(VecScatterBegin(ilink->sctx, xx, ilink->y, INSERT_VALUES, SCATTER_FORWARD) || VecScatterEnd(ilink->sctx, xx, ilink->y, INSERT_VALUES, SCATTER_FORWARD) || PetscLogEventBegin(ilink->event, ilink->ksp, ilink->y, ilink->x, NULL) || \ 15449371c9d4SSatish Balay KSPSolveTranspose(ilink->ksp, ilink->y, ilink->x) || KSPCheckSolve(ilink->ksp, pc, ilink->x) || PetscLogEventEnd(ilink->event, ilink->ksp, ilink->y, ilink->x, NULL) || VecScatterBegin(ilink->sctx, ilink->x, yy, ADD_VALUES, SCATTER_REVERSE) || \ 15453ba16761SJacob Faibussowitsch VecScatterEnd(ilink->sctx, ilink->x, yy, ADD_VALUES, SCATTER_REVERSE))) 1546421e10b8SBarry Smith 1547d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCApplyTranspose_FieldSplit(PC pc, Vec x, Vec y) 1548d71ae5a4SJacob Faibussowitsch { 1549421e10b8SBarry Smith PC_FieldSplit *jac = (PC_FieldSplit *)pc->data; 1550421e10b8SBarry Smith PC_FieldSplitLink ilink = jac->head; 1551939b8a20SBarry Smith PetscInt bs; 1552421e10b8SBarry Smith 1553421e10b8SBarry Smith PetscFunctionBegin; 1554421e10b8SBarry Smith if (jac->type == PC_COMPOSITE_ADDITIVE) { 1555421e10b8SBarry Smith if (jac->defaultsplit) { 15569566063dSJacob Faibussowitsch PetscCall(VecGetBlockSize(x, &bs)); 15572472a847SBarry Smith PetscCheck(jac->bs <= 0 || bs == jac->bs, PetscObjectComm((PetscObject)pc), PETSC_ERR_ARG_WRONGSTATE, "Blocksize of x vector %" PetscInt_FMT " does not match fieldsplit blocksize %" PetscInt_FMT, bs, jac->bs); 15589566063dSJacob Faibussowitsch PetscCall(VecGetBlockSize(y, &bs)); 15592472a847SBarry Smith PetscCheck(jac->bs <= 0 || bs == jac->bs, PetscObjectComm((PetscObject)pc), PETSC_ERR_ARG_WRONGSTATE, "Blocksize of y vector %" PetscInt_FMT " does not match fieldsplit blocksize %" PetscInt_FMT, bs, jac->bs); 15609566063dSJacob Faibussowitsch PetscCall(VecStrideGatherAll(x, jac->x, INSERT_VALUES)); 1561421e10b8SBarry Smith while (ilink) { 15629566063dSJacob Faibussowitsch PetscCall(PetscLogEventBegin(ilink->event, ilink->ksp, ilink->x, ilink->y, NULL)); 15639566063dSJacob Faibussowitsch PetscCall(KSPSolveTranspose(ilink->ksp, ilink->x, ilink->y)); 15649566063dSJacob Faibussowitsch PetscCall(KSPCheckSolve(ilink->ksp, pc, ilink->y)); 15659566063dSJacob Faibussowitsch PetscCall(PetscLogEventEnd(ilink->event, ilink->ksp, ilink->x, ilink->y, NULL)); 1566421e10b8SBarry Smith ilink = ilink->next; 1567421e10b8SBarry Smith } 15689566063dSJacob Faibussowitsch PetscCall(VecStrideScatterAll(jac->y, y, INSERT_VALUES)); 1569421e10b8SBarry Smith } else { 15709566063dSJacob Faibussowitsch PetscCall(VecSet(y, 0.0)); 1571421e10b8SBarry Smith while (ilink) { 15729566063dSJacob Faibussowitsch PetscCall(FieldSplitSplitSolveAddTranspose(ilink, x, y)); 1573421e10b8SBarry Smith ilink = ilink->next; 1574421e10b8SBarry Smith } 1575421e10b8SBarry Smith } 1576421e10b8SBarry Smith } else { 1577421e10b8SBarry Smith if (!jac->w1) { 15789566063dSJacob Faibussowitsch PetscCall(VecDuplicate(x, &jac->w1)); 15799566063dSJacob Faibussowitsch PetscCall(VecDuplicate(x, &jac->w2)); 1580421e10b8SBarry Smith } 15819566063dSJacob Faibussowitsch PetscCall(VecSet(y, 0.0)); 1582421e10b8SBarry Smith if (jac->type == PC_COMPOSITE_SYMMETRIC_MULTIPLICATIVE) { 15839566063dSJacob Faibussowitsch PetscCall(FieldSplitSplitSolveAddTranspose(ilink, x, y)); 1584421e10b8SBarry Smith while (ilink->next) { 1585421e10b8SBarry Smith ilink = ilink->next; 15869566063dSJacob Faibussowitsch PetscCall(MatMultTranspose(pc->mat, y, jac->w1)); 15879566063dSJacob Faibussowitsch PetscCall(VecWAXPY(jac->w2, -1.0, jac->w1, x)); 15889566063dSJacob Faibussowitsch PetscCall(FieldSplitSplitSolveAddTranspose(ilink, jac->w2, y)); 1589421e10b8SBarry Smith } 1590421e10b8SBarry Smith while (ilink->previous) { 1591421e10b8SBarry Smith ilink = ilink->previous; 15929566063dSJacob Faibussowitsch PetscCall(MatMultTranspose(pc->mat, y, jac->w1)); 15939566063dSJacob Faibussowitsch PetscCall(VecWAXPY(jac->w2, -1.0, jac->w1, x)); 15949566063dSJacob Faibussowitsch PetscCall(FieldSplitSplitSolveAddTranspose(ilink, jac->w2, y)); 1595421e10b8SBarry Smith } 1596421e10b8SBarry Smith } else { 1597421e10b8SBarry Smith while (ilink->next) { /* get to last entry in linked list */ 1598421e10b8SBarry Smith ilink = ilink->next; 1599421e10b8SBarry Smith } 16009566063dSJacob Faibussowitsch PetscCall(FieldSplitSplitSolveAddTranspose(ilink, x, y)); 1601421e10b8SBarry Smith while (ilink->previous) { 1602421e10b8SBarry Smith ilink = ilink->previous; 16039566063dSJacob Faibussowitsch PetscCall(MatMultTranspose(pc->mat, y, jac->w1)); 16049566063dSJacob Faibussowitsch PetscCall(VecWAXPY(jac->w2, -1.0, jac->w1, x)); 16059566063dSJacob Faibussowitsch PetscCall(FieldSplitSplitSolveAddTranspose(ilink, jac->w2, y)); 1606421e10b8SBarry Smith } 1607421e10b8SBarry Smith } 1608421e10b8SBarry Smith } 16093ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 1610421e10b8SBarry Smith } 1611421e10b8SBarry Smith 1612d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCReset_FieldSplit(PC pc) 1613d71ae5a4SJacob Faibussowitsch { 16140971522cSBarry Smith PC_FieldSplit *jac = (PC_FieldSplit *)pc->data; 16155a9f2f41SSatish Balay PC_FieldSplitLink ilink = jac->head, next; 16160971522cSBarry Smith 16170971522cSBarry Smith PetscFunctionBegin; 16185a9f2f41SSatish Balay while (ilink) { 16199566063dSJacob Faibussowitsch PetscCall(KSPDestroy(&ilink->ksp)); 16209566063dSJacob Faibussowitsch PetscCall(VecDestroy(&ilink->x)); 16219566063dSJacob Faibussowitsch PetscCall(VecDestroy(&ilink->y)); 16229566063dSJacob Faibussowitsch PetscCall(VecDestroy(&ilink->z)); 16239566063dSJacob Faibussowitsch PetscCall(VecScatterDestroy(&ilink->sctx)); 16249566063dSJacob Faibussowitsch PetscCall(ISDestroy(&ilink->is)); 16259566063dSJacob Faibussowitsch PetscCall(ISDestroy(&ilink->is_col)); 16269566063dSJacob Faibussowitsch PetscCall(PetscFree(ilink->splitname)); 16279566063dSJacob Faibussowitsch PetscCall(PetscFree(ilink->fields)); 16289566063dSJacob Faibussowitsch PetscCall(PetscFree(ilink->fields_col)); 16295a9f2f41SSatish Balay next = ilink->next; 16309566063dSJacob Faibussowitsch PetscCall(PetscFree(ilink)); 16315a9f2f41SSatish Balay ilink = next; 16320971522cSBarry Smith } 1633f5f0d762SBarry Smith jac->head = NULL; 16349566063dSJacob Faibussowitsch PetscCall(PetscFree2(jac->x, jac->y)); 1635574deadeSBarry Smith if (jac->mat && jac->mat != jac->pmat) { 16369566063dSJacob Faibussowitsch PetscCall(MatDestroyMatrices(jac->nsplits, &jac->mat)); 1637574deadeSBarry Smith } else if (jac->mat) { 16380298fd71SBarry Smith jac->mat = NULL; 1639574deadeSBarry Smith } 16409566063dSJacob Faibussowitsch if (jac->pmat) PetscCall(MatDestroyMatrices(jac->nsplits, &jac->pmat)); 16419566063dSJacob Faibussowitsch if (jac->Afield) PetscCall(MatDestroyMatrices(jac->nsplits, &jac->Afield)); 1642f5f0d762SBarry Smith jac->nsplits = 0; 16439566063dSJacob Faibussowitsch PetscCall(VecDestroy(&jac->w1)); 16449566063dSJacob Faibussowitsch PetscCall(VecDestroy(&jac->w2)); 16459566063dSJacob Faibussowitsch PetscCall(MatDestroy(&jac->schur)); 16469566063dSJacob Faibussowitsch PetscCall(MatDestroy(&jac->schurp)); 16479566063dSJacob Faibussowitsch PetscCall(MatDestroy(&jac->schur_user)); 16489566063dSJacob Faibussowitsch PetscCall(KSPDestroy(&jac->kspschur)); 16499566063dSJacob Faibussowitsch PetscCall(KSPDestroy(&jac->kspupper)); 16509566063dSJacob Faibussowitsch PetscCall(MatDestroy(&jac->B)); 16519566063dSJacob Faibussowitsch PetscCall(MatDestroy(&jac->C)); 16529566063dSJacob Faibussowitsch PetscCall(MatDestroy(&jac->H)); 16539566063dSJacob Faibussowitsch PetscCall(VecDestroy(&jac->u)); 16549566063dSJacob Faibussowitsch PetscCall(VecDestroy(&jac->v)); 16559566063dSJacob Faibussowitsch PetscCall(VecDestroy(&jac->Hu)); 16569566063dSJacob Faibussowitsch PetscCall(VecDestroy(&jac->d)); 16579566063dSJacob Faibussowitsch PetscCall(PetscFree(jac->vecz)); 16589566063dSJacob Faibussowitsch PetscCall(PetscViewerDestroy(&jac->gkbviewer)); 16596dbb499eSCian Wilson jac->isrestrict = PETSC_FALSE; 16603ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 1661574deadeSBarry Smith } 1662574deadeSBarry Smith 1663d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCDestroy_FieldSplit(PC pc) 1664d71ae5a4SJacob Faibussowitsch { 1665574deadeSBarry Smith PetscFunctionBegin; 16669566063dSJacob Faibussowitsch PetscCall(PCReset_FieldSplit(pc)); 16679566063dSJacob Faibussowitsch PetscCall(PetscFree(pc->data)); 16682e956fe4SStefano Zampini PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCSetCoordinates_C", NULL)); 16699566063dSJacob Faibussowitsch PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetFields_C", NULL)); 16709566063dSJacob Faibussowitsch PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetIS_C", NULL)); 16719566063dSJacob Faibussowitsch PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetType_C", NULL)); 16729566063dSJacob Faibussowitsch PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetBlockSize_C", NULL)); 16732e956fe4SStefano Zampini PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitRestrictIS_C", NULL)); 16742e956fe4SStefano Zampini PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSchurGetSubKSP_C", NULL)); 16752e956fe4SStefano Zampini PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitGetSubKSP_C", NULL)); 16762e956fe4SStefano Zampini 16772e956fe4SStefano Zampini PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetGKBTol_C", NULL)); 16782e956fe4SStefano Zampini PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetGKBMaxit_C", NULL)); 16792e956fe4SStefano Zampini PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetGKBNu_C", NULL)); 16802e956fe4SStefano Zampini PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetGKBDelay_C", NULL)); 16812e956fe4SStefano Zampini PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitGetSubKSP_C", NULL)); 16829566063dSJacob Faibussowitsch PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetSchurPre_C", NULL)); 16839566063dSJacob Faibussowitsch PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitGetSchurPre_C", NULL)); 16849566063dSJacob Faibussowitsch PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetSchurFactType_C", NULL)); 16852e956fe4SStefano Zampini PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetSchurScale_C", NULL)); 16863ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 16870971522cSBarry Smith } 16880971522cSBarry Smith 1689d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCSetFromOptions_FieldSplit(PC pc, PetscOptionItems *PetscOptionsObject) 1690d71ae5a4SJacob Faibussowitsch { 16916c924f48SJed Brown PetscInt bs; 16927b752e3dSPatrick Sanan PetscBool flg; 16939dcbbd2bSBarry Smith PC_FieldSplit *jac = (PC_FieldSplit *)pc->data; 16943b224e63SBarry Smith PCCompositeType ctype; 16951b9fc7fcSBarry Smith 16960971522cSBarry Smith PetscFunctionBegin; 1697d0609cedSBarry Smith PetscOptionsHeadBegin(PetscOptionsObject, "FieldSplit options"); 16989566063dSJacob Faibussowitsch PetscCall(PetscOptionsBool("-pc_fieldsplit_dm_splits", "Whether to use DMCreateFieldDecomposition() for splits", "PCFieldSplitSetDMSplits", jac->dm_splits, &jac->dm_splits, NULL)); 16999566063dSJacob Faibussowitsch PetscCall(PetscOptionsInt("-pc_fieldsplit_block_size", "Blocksize that defines number of fields", "PCFieldSplitSetBlockSize", jac->bs, &bs, &flg)); 17001baa6e33SBarry Smith if (flg) PetscCall(PCFieldSplitSetBlockSize(pc, bs)); 17012686e3e9SMatthew G. Knepley jac->diag_use_amat = pc->useAmat; 17029566063dSJacob Faibussowitsch PetscCall(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)); 17032686e3e9SMatthew G. Knepley jac->offdiag_use_amat = pc->useAmat; 17049566063dSJacob Faibussowitsch PetscCall(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)); 17059566063dSJacob Faibussowitsch PetscCall(PetscOptionsBool("-pc_fieldsplit_detect_saddle_point", "Form 2-way split by detecting zero diagonal entries", "PCFieldSplitSetDetectSaddlePoint", jac->detect, &jac->detect, NULL)); 17069566063dSJacob Faibussowitsch PetscCall(PCFieldSplitSetDetectSaddlePoint(pc, jac->detect)); /* Sets split type and Schur PC type */ 17079566063dSJacob Faibussowitsch PetscCall(PetscOptionsEnum("-pc_fieldsplit_type", "Type of composition", "PCFieldSplitSetType", PCCompositeTypes, (PetscEnum)jac->type, (PetscEnum *)&ctype, &flg)); 17081baa6e33SBarry Smith if (flg) PetscCall(PCFieldSplitSetType(pc, ctype)); 1709c30613efSMatthew Knepley /* Only setup fields once */ 1710c30613efSMatthew Knepley if ((jac->bs > 0) && (jac->nsplits == 0)) { 1711d32f9abdSBarry Smith /* only allow user to set fields from command line if bs is already known. 1712d32f9abdSBarry Smith otherwise user can set them in PCFieldSplitSetDefaults() */ 17139566063dSJacob Faibussowitsch PetscCall(PCFieldSplitSetRuntimeSplits_Private(pc)); 17149566063dSJacob Faibussowitsch if (jac->splitdefined) PetscCall(PetscInfo(pc, "Splits defined using the options database\n")); 1715d32f9abdSBarry Smith } 1716c5d2311dSJed Brown if (jac->type == PC_COMPOSITE_SCHUR) { 17179566063dSJacob Faibussowitsch PetscCall(PetscOptionsGetEnum(((PetscObject)pc)->options, ((PetscObject)pc)->prefix, "-pc_fieldsplit_schur_factorization_type", PCFieldSplitSchurFactTypes, (PetscEnum *)&jac->schurfactorization, &flg)); 17189566063dSJacob Faibussowitsch if (flg) PetscCall(PetscInfo(pc, "Deprecated use of -pc_fieldsplit_schur_factorization_type\n")); 17199566063dSJacob Faibussowitsch PetscCall(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)); 17209566063dSJacob Faibussowitsch PetscCall(PetscOptionsEnum("-pc_fieldsplit_schur_precondition", "How to build preconditioner for Schur complement", "PCFieldSplitSetSchurPre", PCFieldSplitSchurPreTypes, (PetscEnum)jac->schurpre, (PetscEnum *)&jac->schurpre, NULL)); 17219566063dSJacob Faibussowitsch PetscCall(PetscOptionsScalar("-pc_fieldsplit_schur_scale", "Scale Schur complement", "PCFieldSplitSetSchurScale", jac->schurscale, &jac->schurscale, NULL)); 1722a51937d4SCarola Kruse } else if (jac->type == PC_COMPOSITE_GKB) { 17239566063dSJacob Faibussowitsch PetscCall(PetscOptionsReal("-pc_fieldsplit_gkb_tol", "The tolerance for the lower bound stopping criterion", "PCFieldSplitGKBTol", jac->gkbtol, &jac->gkbtol, NULL)); 17249566063dSJacob Faibussowitsch PetscCall(PetscOptionsInt("-pc_fieldsplit_gkb_delay", "The delay value for lower bound criterion", "PCFieldSplitGKBDelay", jac->gkbdelay, &jac->gkbdelay, NULL)); 17259566063dSJacob Faibussowitsch PetscCall(PetscOptionsReal("-pc_fieldsplit_gkb_nu", "Parameter in augmented Lagrangian approach", "PCFieldSplitGKBNu", jac->gkbnu, &jac->gkbnu, NULL)); 172663a3b9bcSJacob Faibussowitsch PetscCheck(jac->gkbnu >= 0, PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "nu cannot be less than 0: value %g", (double)jac->gkbnu); 17279566063dSJacob Faibussowitsch PetscCall(PetscOptionsInt("-pc_fieldsplit_gkb_maxit", "Maximum allowed number of iterations", "PCFieldSplitGKBMaxit", jac->gkbmaxit, &jac->gkbmaxit, NULL)); 17289566063dSJacob Faibussowitsch PetscCall(PetscOptionsBool("-pc_fieldsplit_gkb_monitor", "Prints number of GKB iterations and error", "PCFieldSplitGKB", jac->gkbmonitor, &jac->gkbmonitor, NULL)); 1729c5d2311dSJed Brown } 173034603f55SBarry Smith /* 173134603f55SBarry Smith In the initial call to this routine the sub-solver data structures do not exist so we cannot call KSPSetFromOptions() on them yet. 173234603f55SBarry Smith But after the initial setup of ALL the layers of sub-solvers is completed we do want to call KSPSetFromOptions() on the sub-solvers every time it 173334603f55SBarry Smith is called on the outer solver in case changes were made in the options database 173434603f55SBarry Smith 173534603f55SBarry Smith But even after PCSetUp_FieldSplit() is called all the options inside the inner levels of sub-solvers may still not have been set thus we only call the KSPSetFromOptions() 173634603f55SBarry Smith if we know that the entire stack of sub-solvers below this have been complete instantiated, we check this by seeing if any solver iterations are complete. 173734603f55SBarry Smith Without this extra check test p2p1fetidp_olof_full and others fail with incorrect matrix types. 173834603f55SBarry Smith 173934603f55SBarry Smith There could be a negative side effect of calling the KSPSetFromOptions() below. 174034603f55SBarry Smith 174134603f55SBarry Smith If one captured the PetscObjectState of the options database one could skip these calls if the database has not changed from the previous call 174234603f55SBarry Smith */ 174334603f55SBarry Smith if (jac->issetup) { 174434603f55SBarry Smith PC_FieldSplitLink ilink = jac->head; 174534603f55SBarry Smith if (jac->type == PC_COMPOSITE_SCHUR) { 174634603f55SBarry Smith if (jac->kspupper && jac->kspupper->totalits > 0) PetscCall(KSPSetFromOptions(jac->kspupper)); 174734603f55SBarry Smith if (jac->kspschur && jac->kspschur->totalits > 0) PetscCall(KSPSetFromOptions(jac->kspschur)); 174834603f55SBarry Smith } 174934603f55SBarry Smith while (ilink) { 175034603f55SBarry Smith if (ilink->ksp->totalits > 0) PetscCall(KSPSetFromOptions(ilink->ksp)); 175134603f55SBarry Smith ilink = ilink->next; 175234603f55SBarry Smith } 175334603f55SBarry Smith } 1754d0609cedSBarry Smith PetscOptionsHeadEnd(); 17553ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 17560971522cSBarry Smith } 17570971522cSBarry Smith 1758d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCFieldSplitSetFields_FieldSplit(PC pc, const char splitname[], PetscInt n, const PetscInt *fields, const PetscInt *fields_col) 1759d71ae5a4SJacob Faibussowitsch { 176097bbdb24SBarry Smith PC_FieldSplit *jac = (PC_FieldSplit *)pc->data; 17615a9f2f41SSatish Balay PC_FieldSplitLink ilink, next = jac->head; 176269a612a9SBarry Smith char prefix[128]; 17635d4c12cdSJungho Lee PetscInt i; 17640971522cSBarry Smith 17650971522cSBarry Smith PetscFunctionBegin; 17666c924f48SJed Brown if (jac->splitdefined) { 17679566063dSJacob Faibussowitsch PetscCall(PetscInfo(pc, "Ignoring new split \"%s\" because the splits have already been defined\n", splitname)); 17683ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 17696c924f48SJed Brown } 177051f519a2SBarry Smith for (i = 0; i < n; i++) { 177163a3b9bcSJacob Faibussowitsch PetscCheck(fields[i] < jac->bs, PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field %" PetscInt_FMT " requested but only %" PetscInt_FMT " exist", fields[i], jac->bs); 177263a3b9bcSJacob Faibussowitsch PetscCheck(fields[i] >= 0, PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Negative field %" PetscInt_FMT " requested", fields[i]); 177351f519a2SBarry Smith } 17749566063dSJacob Faibussowitsch PetscCall(PetscNew(&ilink)); 1775a04f6461SBarry Smith if (splitname) { 17769566063dSJacob Faibussowitsch PetscCall(PetscStrallocpy(splitname, &ilink->splitname)); 1777a04f6461SBarry Smith } else { 17789566063dSJacob Faibussowitsch PetscCall(PetscMalloc1(3, &ilink->splitname)); 177963a3b9bcSJacob Faibussowitsch PetscCall(PetscSNPrintf(ilink->splitname, 2, "%" PetscInt_FMT, jac->nsplits)); 1780a04f6461SBarry Smith } 17819df09d43SBarry 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 */ 17829566063dSJacob Faibussowitsch PetscCall(PetscMalloc1(n, &ilink->fields)); 17839566063dSJacob Faibussowitsch PetscCall(PetscArraycpy(ilink->fields, fields, n)); 17849566063dSJacob Faibussowitsch PetscCall(PetscMalloc1(n, &ilink->fields_col)); 17859566063dSJacob Faibussowitsch PetscCall(PetscArraycpy(ilink->fields_col, fields_col, n)); 17862fa5cd67SKarl Rupp 17875a9f2f41SSatish Balay ilink->nfields = n; 17880298fd71SBarry Smith ilink->next = NULL; 17899566063dSJacob Faibussowitsch PetscCall(KSPCreate(PetscObjectComm((PetscObject)pc), &ilink->ksp)); 1790*3821be0aSBarry Smith PetscCall(KSPSetNestLevel(ilink->ksp, pc->kspnestlevel)); 17919566063dSJacob Faibussowitsch PetscCall(KSPSetErrorIfNotConverged(ilink->ksp, pc->erroriffailure)); 17929566063dSJacob Faibussowitsch PetscCall(PetscObjectIncrementTabLevel((PetscObject)ilink->ksp, (PetscObject)pc, 1)); 17939566063dSJacob Faibussowitsch PetscCall(KSPSetType(ilink->ksp, KSPPREONLY)); 179469a612a9SBarry Smith 17959566063dSJacob Faibussowitsch PetscCall(PetscSNPrintf(prefix, sizeof(prefix), "%sfieldsplit_%s_", ((PetscObject)pc)->prefix ? ((PetscObject)pc)->prefix : "", ilink->splitname)); 17969566063dSJacob Faibussowitsch PetscCall(KSPSetOptionsPrefix(ilink->ksp, prefix)); 17970971522cSBarry Smith 17980971522cSBarry Smith if (!next) { 17995a9f2f41SSatish Balay jac->head = ilink; 18000298fd71SBarry Smith ilink->previous = NULL; 18010971522cSBarry Smith } else { 1802ad540459SPierre Jolivet while (next->next) next = next->next; 18035a9f2f41SSatish Balay next->next = ilink; 180451f519a2SBarry Smith ilink->previous = next; 18050971522cSBarry Smith } 18060971522cSBarry Smith jac->nsplits++; 18073ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 18080971522cSBarry Smith } 18090971522cSBarry Smith 1810d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCFieldSplitSchurGetSubKSP_FieldSplit(PC pc, PetscInt *n, KSP **subksp) 1811d71ae5a4SJacob Faibussowitsch { 1812285fb4e2SStefano Zampini PC_FieldSplit *jac = (PC_FieldSplit *)pc->data; 1813285fb4e2SStefano Zampini 1814285fb4e2SStefano Zampini PetscFunctionBegin; 1815285fb4e2SStefano Zampini *subksp = NULL; 1816285fb4e2SStefano Zampini if (n) *n = 0; 1817285fb4e2SStefano Zampini if (jac->type == PC_COMPOSITE_SCHUR) { 1818285fb4e2SStefano Zampini PetscInt nn; 1819285fb4e2SStefano Zampini 182028b400f6SJacob Faibussowitsch PetscCheck(jac->schur, PetscObjectComm((PetscObject)pc), PETSC_ERR_ARG_WRONGSTATE, "Must call KSPSetUp() or PCSetUp() before calling PCFieldSplitSchurGetSubKSP()"); 182163a3b9bcSJacob Faibussowitsch PetscCheck(jac->nsplits == 2, PetscObjectComm((PetscObject)pc), PETSC_ERR_PLIB, "Unexpected number of splits %" PetscInt_FMT " != 2", jac->nsplits); 1822285fb4e2SStefano Zampini nn = jac->nsplits + (jac->kspupper != jac->head->ksp ? 1 : 0); 18239566063dSJacob Faibussowitsch PetscCall(PetscMalloc1(nn, subksp)); 1824285fb4e2SStefano Zampini (*subksp)[0] = jac->head->ksp; 1825285fb4e2SStefano Zampini (*subksp)[1] = jac->kspschur; 1826285fb4e2SStefano Zampini if (jac->kspupper != jac->head->ksp) (*subksp)[2] = jac->kspupper; 1827285fb4e2SStefano Zampini if (n) *n = nn; 1828285fb4e2SStefano Zampini } 18293ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 1830285fb4e2SStefano Zampini } 1831285fb4e2SStefano Zampini 1832d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCFieldSplitGetSubKSP_FieldSplit_Schur(PC pc, PetscInt *n, KSP **subksp) 1833d71ae5a4SJacob Faibussowitsch { 1834e69d4d44SBarry Smith PC_FieldSplit *jac = (PC_FieldSplit *)pc->data; 1835e69d4d44SBarry Smith 1836e69d4d44SBarry Smith PetscFunctionBegin; 183728b400f6SJacob Faibussowitsch PetscCheck(jac->schur, PetscObjectComm((PetscObject)pc), PETSC_ERR_ARG_WRONGSTATE, "Must call KSPSetUp() or PCSetUp() before calling PCFieldSplitGetSubKSP()"); 18389566063dSJacob Faibussowitsch PetscCall(PetscMalloc1(jac->nsplits, subksp)); 18399566063dSJacob Faibussowitsch PetscCall(MatSchurComplementGetKSP(jac->schur, *subksp)); 18402fa5cd67SKarl Rupp 1841e69d4d44SBarry Smith (*subksp)[1] = jac->kspschur; 184213e0d083SBarry Smith if (n) *n = jac->nsplits; 18433ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 1844e69d4d44SBarry Smith } 18450971522cSBarry Smith 1846d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCFieldSplitGetSubKSP_FieldSplit(PC pc, PetscInt *n, KSP **subksp) 1847d71ae5a4SJacob Faibussowitsch { 18480971522cSBarry Smith PC_FieldSplit *jac = (PC_FieldSplit *)pc->data; 18490971522cSBarry Smith PetscInt cnt = 0; 18505a9f2f41SSatish Balay PC_FieldSplitLink ilink = jac->head; 18510971522cSBarry Smith 18520971522cSBarry Smith PetscFunctionBegin; 18539566063dSJacob Faibussowitsch PetscCall(PetscMalloc1(jac->nsplits, subksp)); 18545a9f2f41SSatish Balay while (ilink) { 18555a9f2f41SSatish Balay (*subksp)[cnt++] = ilink->ksp; 18565a9f2f41SSatish Balay ilink = ilink->next; 18570971522cSBarry Smith } 185863a3b9bcSJacob Faibussowitsch PetscCheck(cnt == jac->nsplits, PETSC_COMM_SELF, PETSC_ERR_PLIB, "Corrupt PCFIELDSPLIT object: number of splits in linked list %" PetscInt_FMT " does not match number in object %" PetscInt_FMT, cnt, jac->nsplits); 185913e0d083SBarry Smith if (n) *n = jac->nsplits; 18603ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 18610971522cSBarry Smith } 18620971522cSBarry Smith 18636dbb499eSCian Wilson /*@C 1864f1580f4eSBarry Smith PCFieldSplitRestrictIS - Restricts the fieldsplit `IS`s to be within a given `IS`. 18656dbb499eSCian Wilson 18666dbb499eSCian Wilson Input Parameters: 18676dbb499eSCian Wilson + pc - the preconditioner context 1868feefa0e1SJacob Faibussowitsch - isy - the index set that defines the indices to which the fieldsplit is to be restricted 18696dbb499eSCian Wilson 18706dbb499eSCian Wilson Level: advanced 18716dbb499eSCian Wilson 1872feefa0e1SJacob Faibussowitsch Developer Notes: 1873f1580f4eSBarry Smith It seems the resulting `IS`s will not cover the entire space, so 1874f1580f4eSBarry Smith how can they define a convergent preconditioner? Needs explaining. 1875f1580f4eSBarry Smith 187660f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PCFIELDSPLIT`, `PCFieldSplitSetFields()`, `PCFieldSplitSetIS()` 18776dbb499eSCian Wilson @*/ 1878d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitRestrictIS(PC pc, IS isy) 1879d71ae5a4SJacob Faibussowitsch { 18806dbb499eSCian Wilson PetscFunctionBegin; 18816dbb499eSCian Wilson PetscValidHeaderSpecific(pc, PC_CLASSID, 1); 18826dbb499eSCian Wilson PetscValidHeaderSpecific(isy, IS_CLASSID, 2); 1883cac4c232SBarry Smith PetscTryMethod(pc, "PCFieldSplitRestrictIS_C", (PC, IS), (pc, isy)); 18843ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 18856dbb499eSCian Wilson } 18866dbb499eSCian Wilson 1887d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCFieldSplitRestrictIS_FieldSplit(PC pc, IS isy) 1888d71ae5a4SJacob Faibussowitsch { 18896dbb499eSCian Wilson PC_FieldSplit *jac = (PC_FieldSplit *)pc->data; 18906dbb499eSCian Wilson PC_FieldSplitLink ilink = jac->head, next; 18916dbb499eSCian Wilson PetscInt localsize, size, sizez, i; 18926dbb499eSCian Wilson const PetscInt *ind, *indz; 18936dbb499eSCian Wilson PetscInt *indc, *indcz; 18946dbb499eSCian Wilson PetscBool flg; 18956dbb499eSCian Wilson 18966dbb499eSCian Wilson PetscFunctionBegin; 18979566063dSJacob Faibussowitsch PetscCall(ISGetLocalSize(isy, &localsize)); 18989566063dSJacob Faibussowitsch PetscCallMPI(MPI_Scan(&localsize, &size, 1, MPIU_INT, MPI_SUM, PetscObjectComm((PetscObject)isy))); 18996dbb499eSCian Wilson size -= localsize; 19006dbb499eSCian Wilson while (ilink) { 19016dbb499eSCian Wilson IS isrl, isr; 19021c7cfba8SBarry Smith PC subpc; 19039566063dSJacob Faibussowitsch PetscCall(ISEmbed(ilink->is, isy, PETSC_TRUE, &isrl)); 19049566063dSJacob Faibussowitsch PetscCall(ISGetLocalSize(isrl, &localsize)); 19059566063dSJacob Faibussowitsch PetscCall(PetscMalloc1(localsize, &indc)); 19069566063dSJacob Faibussowitsch PetscCall(ISGetIndices(isrl, &ind)); 19079566063dSJacob Faibussowitsch PetscCall(PetscArraycpy(indc, ind, localsize)); 19089566063dSJacob Faibussowitsch PetscCall(ISRestoreIndices(isrl, &ind)); 19099566063dSJacob Faibussowitsch PetscCall(ISDestroy(&isrl)); 19106dbb499eSCian Wilson for (i = 0; i < localsize; i++) *(indc + i) += size; 19119566063dSJacob Faibussowitsch PetscCall(ISCreateGeneral(PetscObjectComm((PetscObject)isy), localsize, indc, PETSC_OWN_POINTER, &isr)); 19129566063dSJacob Faibussowitsch PetscCall(PetscObjectReference((PetscObject)isr)); 19139566063dSJacob Faibussowitsch PetscCall(ISDestroy(&ilink->is)); 19146dbb499eSCian Wilson ilink->is = isr; 19159566063dSJacob Faibussowitsch PetscCall(PetscObjectReference((PetscObject)isr)); 19169566063dSJacob Faibussowitsch PetscCall(ISDestroy(&ilink->is_col)); 19176dbb499eSCian Wilson ilink->is_col = isr; 19189566063dSJacob Faibussowitsch PetscCall(ISDestroy(&isr)); 19199566063dSJacob Faibussowitsch PetscCall(KSPGetPC(ilink->ksp, &subpc)); 19209566063dSJacob Faibussowitsch PetscCall(PetscObjectTypeCompare((PetscObject)subpc, PCFIELDSPLIT, &flg)); 19216dbb499eSCian Wilson if (flg) { 19226dbb499eSCian Wilson IS iszl, isz; 19236dbb499eSCian Wilson MPI_Comm comm; 19249566063dSJacob Faibussowitsch PetscCall(ISGetLocalSize(ilink->is, &localsize)); 19256dbb499eSCian Wilson comm = PetscObjectComm((PetscObject)ilink->is); 19269566063dSJacob Faibussowitsch PetscCall(ISEmbed(isy, ilink->is, PETSC_TRUE, &iszl)); 19279566063dSJacob Faibussowitsch PetscCallMPI(MPI_Scan(&localsize, &sizez, 1, MPIU_INT, MPI_SUM, comm)); 19286dbb499eSCian Wilson sizez -= localsize; 19299566063dSJacob Faibussowitsch PetscCall(ISGetLocalSize(iszl, &localsize)); 19309566063dSJacob Faibussowitsch PetscCall(PetscMalloc1(localsize, &indcz)); 19319566063dSJacob Faibussowitsch PetscCall(ISGetIndices(iszl, &indz)); 19329566063dSJacob Faibussowitsch PetscCall(PetscArraycpy(indcz, indz, localsize)); 19339566063dSJacob Faibussowitsch PetscCall(ISRestoreIndices(iszl, &indz)); 19349566063dSJacob Faibussowitsch PetscCall(ISDestroy(&iszl)); 19356dbb499eSCian Wilson for (i = 0; i < localsize; i++) *(indcz + i) += sizez; 19369566063dSJacob Faibussowitsch PetscCall(ISCreateGeneral(comm, localsize, indcz, PETSC_OWN_POINTER, &isz)); 19379566063dSJacob Faibussowitsch PetscCall(PCFieldSplitRestrictIS(subpc, isz)); 19389566063dSJacob Faibussowitsch PetscCall(ISDestroy(&isz)); 19396dbb499eSCian Wilson } 19406dbb499eSCian Wilson next = ilink->next; 19416dbb499eSCian Wilson ilink = next; 19426dbb499eSCian Wilson } 19436dbb499eSCian Wilson jac->isrestrict = PETSC_TRUE; 19443ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 19456dbb499eSCian Wilson } 19466dbb499eSCian Wilson 1947d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCFieldSplitSetIS_FieldSplit(PC pc, const char splitname[], IS is) 1948d71ae5a4SJacob Faibussowitsch { 1949704ba839SBarry Smith PC_FieldSplit *jac = (PC_FieldSplit *)pc->data; 1950704ba839SBarry Smith PC_FieldSplitLink ilink, next = jac->head; 1951704ba839SBarry Smith char prefix[128]; 1952704ba839SBarry Smith 1953704ba839SBarry Smith PetscFunctionBegin; 19546c924f48SJed Brown if (jac->splitdefined) { 19559566063dSJacob Faibussowitsch PetscCall(PetscInfo(pc, "Ignoring new split \"%s\" because the splits have already been defined\n", splitname)); 19563ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 19576c924f48SJed Brown } 19589566063dSJacob Faibussowitsch PetscCall(PetscNew(&ilink)); 1959a04f6461SBarry Smith if (splitname) { 19609566063dSJacob Faibussowitsch PetscCall(PetscStrallocpy(splitname, &ilink->splitname)); 1961a04f6461SBarry Smith } else { 19629566063dSJacob Faibussowitsch PetscCall(PetscMalloc1(8, &ilink->splitname)); 196363a3b9bcSJacob Faibussowitsch PetscCall(PetscSNPrintf(ilink->splitname, 7, "%" PetscInt_FMT, jac->nsplits)); 1964a04f6461SBarry Smith } 19659df09d43SBarry 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 */ 19669566063dSJacob Faibussowitsch PetscCall(PetscObjectReference((PetscObject)is)); 19679566063dSJacob Faibussowitsch PetscCall(ISDestroy(&ilink->is)); 1968b5787286SJed Brown ilink->is = is; 19699566063dSJacob Faibussowitsch PetscCall(PetscObjectReference((PetscObject)is)); 19709566063dSJacob Faibussowitsch PetscCall(ISDestroy(&ilink->is_col)); 1971b5787286SJed Brown ilink->is_col = is; 19720298fd71SBarry Smith ilink->next = NULL; 19739566063dSJacob Faibussowitsch PetscCall(KSPCreate(PetscObjectComm((PetscObject)pc), &ilink->ksp)); 1974*3821be0aSBarry Smith PetscCall(KSPSetNestLevel(ilink->ksp, pc->kspnestlevel)); 19759566063dSJacob Faibussowitsch PetscCall(KSPSetErrorIfNotConverged(ilink->ksp, pc->erroriffailure)); 19769566063dSJacob Faibussowitsch PetscCall(PetscObjectIncrementTabLevel((PetscObject)ilink->ksp, (PetscObject)pc, 1)); 19779566063dSJacob Faibussowitsch PetscCall(KSPSetType(ilink->ksp, KSPPREONLY)); 1978704ba839SBarry Smith 19799566063dSJacob Faibussowitsch PetscCall(PetscSNPrintf(prefix, sizeof(prefix), "%sfieldsplit_%s_", ((PetscObject)pc)->prefix ? ((PetscObject)pc)->prefix : "", ilink->splitname)); 19809566063dSJacob Faibussowitsch PetscCall(KSPSetOptionsPrefix(ilink->ksp, prefix)); 1981704ba839SBarry Smith 1982704ba839SBarry Smith if (!next) { 1983704ba839SBarry Smith jac->head = ilink; 19840298fd71SBarry Smith ilink->previous = NULL; 1985704ba839SBarry Smith } else { 1986ad540459SPierre Jolivet while (next->next) next = next->next; 1987704ba839SBarry Smith next->next = ilink; 1988704ba839SBarry Smith ilink->previous = next; 1989704ba839SBarry Smith } 1990704ba839SBarry Smith jac->nsplits++; 19913ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 1992704ba839SBarry Smith } 1993704ba839SBarry Smith 199494ef8ddeSSatish Balay /*@C 199560f59c3bSBarry Smith PCFieldSplitSetFields - Sets the fields that define one particular split in `PCFIELDSPLIT` 19960971522cSBarry Smith 1997c3339decSBarry Smith Logically Collective 19980971522cSBarry Smith 19990971522cSBarry Smith Input Parameters: 20000971522cSBarry Smith + pc - the preconditioner context 200160f59c3bSBarry Smith . splitname - name of this split, if `NULL` the number of the split is used 20020971522cSBarry Smith . n - the number of fields in this split 20033b374dbdSBarry Smith . fields - the fields in this split 20043b374dbdSBarry Smith - fields_col - generally the same as fields, if it does not match fields then the matrix block that is solved for this set of fields comes from an off-diagonal block 20053b374dbdSBarry Smith of the matrix and fields_col provides the column indices for that block 20060971522cSBarry Smith 20070971522cSBarry Smith Level: intermediate 20080971522cSBarry Smith 200995452b02SPatrick Sanan Notes: 2010f1580f4eSBarry Smith Use `PCFieldSplitSetIS()` to set a general set of indices as a split. 2011d32f9abdSBarry Smith 2012f1580f4eSBarry Smith `PCFieldSplitSetFields()` is for defining fields as strided blocks. For example, if the block 2013f1580f4eSBarry Smith size is three then one can define a split as 0, or 1 or 2 or 0,1 or 0,2 or 1,2 which mean 2014d32f9abdSBarry Smith 0xx3xx6xx9xx12 ... x1xx4xx7xx ... xx2xx5xx8xx.. 01x34x67x... 0x1x3x5x7.. x12x45x78x.... 2015f1580f4eSBarry Smith where the numbered entries indicate what is in the split. 2016d32f9abdSBarry Smith 2017db4c96c1SJed Brown This function is called once per split (it creates a new split each time). Solve options 201860f59c3bSBarry Smith for this split will be available under the prefix `-fieldsplit_SPLITNAME_`. 2019db4c96c1SJed Brown 20203b374dbdSBarry Smith `PCFieldSplitSetIS()` does not support having a fields_col different from fields 20213b374dbdSBarry Smith 2022feefa0e1SJacob Faibussowitsch Developer Notes: 2023f1580f4eSBarry Smith This routine does not actually create the `IS` representing the split, that is delayed 2024f1580f4eSBarry Smith until `PCSetUp_FieldSplit()`, because information about the vector/matrix layouts may not be 20255d4c12cdSJungho Lee available when this routine is called. 20265d4c12cdSJungho Lee 202760f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCFieldSplitGetSubKSP()`, `PCFIELDSPLIT`, `PCFieldSplitSetBlockSize()`, `PCFieldSplitSetIS()`, `PCFieldSplitRestrictIS()` 20280971522cSBarry Smith @*/ 2029d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitSetFields(PC pc, const char splitname[], PetscInt n, const PetscInt *fields, const PetscInt *fields_col) 2030d71ae5a4SJacob Faibussowitsch { 20310971522cSBarry Smith PetscFunctionBegin; 20320700a824SBarry Smith PetscValidHeaderSpecific(pc, PC_CLASSID, 1); 20334f572ea9SToby Isaac PetscAssertPointer(splitname, 2); 203463a3b9bcSJacob Faibussowitsch PetscCheck(n >= 1, PetscObjectComm((PetscObject)pc), PETSC_ERR_ARG_OUTOFRANGE, "Provided number of fields %" PetscInt_FMT " in split \"%s\" not positive", n, splitname); 20354f572ea9SToby Isaac PetscAssertPointer(fields, 4); 2036cac4c232SBarry Smith PetscTryMethod(pc, "PCFieldSplitSetFields_C", (PC, const char[], PetscInt, const PetscInt *, const PetscInt *), (pc, splitname, n, fields, fields_col)); 20373ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 20380971522cSBarry Smith } 20390971522cSBarry Smith 2040c84da90fSDmitry Karpeev /*@ 2041f1580f4eSBarry Smith PCFieldSplitSetDiagUseAmat - set flag indicating whether to extract diagonal blocks from Amat (rather than Pmat) to build 2042f1580f4eSBarry Smith the sub-matrices associated with each split. Where `KSPSetOperators`(ksp,Amat,Pmat)) was used to supply the operators. 2043c84da90fSDmitry Karpeev 2044c3339decSBarry Smith Logically Collective 2045c84da90fSDmitry Karpeev 2046c84da90fSDmitry Karpeev Input Parameters: 2047c84da90fSDmitry Karpeev + pc - the preconditioner object 2048c84da90fSDmitry Karpeev - flg - boolean flag indicating whether or not to use Amat to extract the diagonal blocks from 2049c84da90fSDmitry Karpeev 205020f4b53cSBarry Smith Options Database Key: 2051147403d9SBarry Smith . -pc_fieldsplit_diag_use_amat - use the Amat to provide the diagonal blocks 2052c84da90fSDmitry Karpeev 2053c84da90fSDmitry Karpeev Level: intermediate 2054c84da90fSDmitry Karpeev 205560f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCSetOperators()`, `KSPSetOperators()`, `PCFieldSplitGetDiagUseAmat()`, `PCFieldSplitSetOffDiagUseAmat()`, `PCFIELDSPLIT` 2056c84da90fSDmitry Karpeev @*/ 2057d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitSetDiagUseAmat(PC pc, PetscBool flg) 2058d71ae5a4SJacob Faibussowitsch { 2059c84da90fSDmitry Karpeev PC_FieldSplit *jac = (PC_FieldSplit *)pc->data; 2060c84da90fSDmitry Karpeev PetscBool isfs; 2061c84da90fSDmitry Karpeev 2062c84da90fSDmitry Karpeev PetscFunctionBegin; 2063c84da90fSDmitry Karpeev PetscValidHeaderSpecific(pc, PC_CLASSID, 1); 20649566063dSJacob Faibussowitsch PetscCall(PetscObjectTypeCompare((PetscObject)pc, PCFIELDSPLIT, &isfs)); 206528b400f6SJacob Faibussowitsch PetscCheck(isfs, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "PC not of type %s", PCFIELDSPLIT); 2066c84da90fSDmitry Karpeev jac->diag_use_amat = flg; 20673ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 2068c84da90fSDmitry Karpeev } 2069c84da90fSDmitry Karpeev 2070c84da90fSDmitry Karpeev /*@ 2071f1580f4eSBarry Smith PCFieldSplitGetDiagUseAmat - get the flag indicating whether to extract diagonal blocks from Amat (rather than Pmat) to build 2072f1580f4eSBarry Smith the sub-matrices associated with each split. Where `KSPSetOperators`(ksp,Amat,Pmat)) was used to supply the operators. 2073c84da90fSDmitry Karpeev 2074c3339decSBarry Smith Logically Collective 2075c84da90fSDmitry Karpeev 207620f4b53cSBarry Smith Input Parameter: 2077c84da90fSDmitry Karpeev . pc - the preconditioner object 2078c84da90fSDmitry Karpeev 207920f4b53cSBarry Smith Output Parameter: 2080c84da90fSDmitry Karpeev . flg - boolean flag indicating whether or not to use Amat to extract the diagonal blocks from 2081c84da90fSDmitry Karpeev 2082c84da90fSDmitry Karpeev Level: intermediate 2083c84da90fSDmitry Karpeev 208460f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCSetOperators()`, `KSPSetOperators()`, `PCFieldSplitSetDiagUseAmat()`, `PCFieldSplitGetOffDiagUseAmat()`, `PCFIELDSPLIT` 2085c84da90fSDmitry Karpeev @*/ 2086d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitGetDiagUseAmat(PC pc, PetscBool *flg) 2087d71ae5a4SJacob Faibussowitsch { 2088c84da90fSDmitry Karpeev PC_FieldSplit *jac = (PC_FieldSplit *)pc->data; 2089c84da90fSDmitry Karpeev PetscBool isfs; 2090c84da90fSDmitry Karpeev 2091c84da90fSDmitry Karpeev PetscFunctionBegin; 2092c84da90fSDmitry Karpeev PetscValidHeaderSpecific(pc, PC_CLASSID, 1); 20934f572ea9SToby Isaac PetscAssertPointer(flg, 2); 20949566063dSJacob Faibussowitsch PetscCall(PetscObjectTypeCompare((PetscObject)pc, PCFIELDSPLIT, &isfs)); 209528b400f6SJacob Faibussowitsch PetscCheck(isfs, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "PC not of type %s", PCFIELDSPLIT); 2096c84da90fSDmitry Karpeev *flg = jac->diag_use_amat; 20973ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 2098c84da90fSDmitry Karpeev } 2099c84da90fSDmitry Karpeev 2100c84da90fSDmitry Karpeev /*@ 2101f1580f4eSBarry Smith PCFieldSplitSetOffDiagUseAmat - set flag indicating whether to extract off-diagonal blocks from Amat (rather than Pmat) to build 2102f1580f4eSBarry Smith the sub-matrices associated with each split. Where `KSPSetOperators`(ksp,Amat,Pmat)) was used to supply the operators. 2103c84da90fSDmitry Karpeev 2104c3339decSBarry Smith Logically Collective 2105c84da90fSDmitry Karpeev 2106c84da90fSDmitry Karpeev Input Parameters: 2107c84da90fSDmitry Karpeev + pc - the preconditioner object 2108c84da90fSDmitry Karpeev - flg - boolean flag indicating whether or not to use Amat to extract the off-diagonal blocks from 2109c84da90fSDmitry Karpeev 211020f4b53cSBarry Smith Options Database Key: 2111147403d9SBarry Smith . -pc_fieldsplit_off_diag_use_amat <bool> - use the Amat to extract the off-diagonal blocks 2112c84da90fSDmitry Karpeev 2113c84da90fSDmitry Karpeev Level: intermediate 2114c84da90fSDmitry Karpeev 211560f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCSetOperators()`, `KSPSetOperators()`, `PCFieldSplitGetOffDiagUseAmat()`, `PCFieldSplitSetDiagUseAmat()`, `PCFIELDSPLIT` 2116c84da90fSDmitry Karpeev @*/ 2117d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitSetOffDiagUseAmat(PC pc, PetscBool flg) 2118d71ae5a4SJacob Faibussowitsch { 2119c84da90fSDmitry Karpeev PC_FieldSplit *jac = (PC_FieldSplit *)pc->data; 2120c84da90fSDmitry Karpeev PetscBool isfs; 2121c84da90fSDmitry Karpeev 2122c84da90fSDmitry Karpeev PetscFunctionBegin; 2123c84da90fSDmitry Karpeev PetscValidHeaderSpecific(pc, PC_CLASSID, 1); 21249566063dSJacob Faibussowitsch PetscCall(PetscObjectTypeCompare((PetscObject)pc, PCFIELDSPLIT, &isfs)); 212528b400f6SJacob Faibussowitsch PetscCheck(isfs, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "PC not of type %s", PCFIELDSPLIT); 2126c84da90fSDmitry Karpeev jac->offdiag_use_amat = flg; 21273ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 2128c84da90fSDmitry Karpeev } 2129c84da90fSDmitry Karpeev 2130c84da90fSDmitry Karpeev /*@ 2131f1580f4eSBarry Smith PCFieldSplitGetOffDiagUseAmat - get the flag indicating whether to extract off-diagonal blocks from Amat (rather than Pmat) to build 2132f1580f4eSBarry Smith the sub-matrices associated with each split. Where `KSPSetOperators`(ksp,Amat,Pmat)) was used to supply the operators. 2133c84da90fSDmitry Karpeev 2134c3339decSBarry Smith Logically Collective 2135c84da90fSDmitry Karpeev 213620f4b53cSBarry Smith Input Parameter: 2137c84da90fSDmitry Karpeev . pc - the preconditioner object 2138c84da90fSDmitry Karpeev 213920f4b53cSBarry Smith Output Parameter: 2140c84da90fSDmitry Karpeev . flg - boolean flag indicating whether or not to use Amat to extract the off-diagonal blocks from 2141c84da90fSDmitry Karpeev 2142c84da90fSDmitry Karpeev Level: intermediate 2143c84da90fSDmitry Karpeev 214460f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCSetOperators()`, `KSPSetOperators()`, `PCFieldSplitSetOffDiagUseAmat()`, `PCFieldSplitGetDiagUseAmat()`, `PCFIELDSPLIT` 2145c84da90fSDmitry Karpeev @*/ 2146d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitGetOffDiagUseAmat(PC pc, PetscBool *flg) 2147d71ae5a4SJacob Faibussowitsch { 2148c84da90fSDmitry Karpeev PC_FieldSplit *jac = (PC_FieldSplit *)pc->data; 2149c84da90fSDmitry Karpeev PetscBool isfs; 2150c84da90fSDmitry Karpeev 2151c84da90fSDmitry Karpeev PetscFunctionBegin; 2152c84da90fSDmitry Karpeev PetscValidHeaderSpecific(pc, PC_CLASSID, 1); 21534f572ea9SToby Isaac PetscAssertPointer(flg, 2); 21549566063dSJacob Faibussowitsch PetscCall(PetscObjectTypeCompare((PetscObject)pc, PCFIELDSPLIT, &isfs)); 215528b400f6SJacob Faibussowitsch PetscCheck(isfs, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "PC not of type %s", PCFIELDSPLIT); 2156c84da90fSDmitry Karpeev *flg = jac->offdiag_use_amat; 21573ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 2158c84da90fSDmitry Karpeev } 2159c84da90fSDmitry Karpeev 2160218d4943SBarry Smith /*@C 2161f1580f4eSBarry Smith PCFieldSplitSetIS - Sets the exact elements for a split in a `PCFIELDSPLIT` 2162704ba839SBarry Smith 2163c3339decSBarry Smith Logically Collective 2164704ba839SBarry Smith 2165704ba839SBarry Smith Input Parameters: 2166704ba839SBarry Smith + pc - the preconditioner context 216760f59c3bSBarry Smith . splitname - name of this split, if `NULL` the number of the split is used 2168f1580f4eSBarry Smith - is - the index set that defines the elements in this split 2169704ba839SBarry Smith 217060f59c3bSBarry Smith Level: intermediate 217160f59c3bSBarry Smith 2172a6ffb8dbSJed Brown Notes: 2173f1580f4eSBarry Smith Use `PCFieldSplitSetFields()`, for splits defined by strided types. 2174a6ffb8dbSJed Brown 2175db4c96c1SJed Brown This function is called once per split (it creates a new split each time). Solve options 2176db4c96c1SJed Brown for this split will be available under the prefix -fieldsplit_SPLITNAME_. 2177d32f9abdSBarry Smith 217860f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCFieldSplitGetSubKSP()`, `PCFIELDSPLIT`, `PCFieldSplitSetBlockSize()` 2179704ba839SBarry Smith @*/ 2180d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitSetIS(PC pc, const char splitname[], IS is) 2181d71ae5a4SJacob Faibussowitsch { 2182704ba839SBarry Smith PetscFunctionBegin; 21830700a824SBarry Smith PetscValidHeaderSpecific(pc, PC_CLASSID, 1); 21844f572ea9SToby Isaac if (splitname) PetscAssertPointer(splitname, 2); 2185db4c96c1SJed Brown PetscValidHeaderSpecific(is, IS_CLASSID, 3); 2186cac4c232SBarry Smith PetscTryMethod(pc, "PCFieldSplitSetIS_C", (PC, const char[], IS), (pc, splitname, is)); 21873ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 2188704ba839SBarry Smith } 2189704ba839SBarry Smith 219094ef8ddeSSatish Balay /*@C 2191f1580f4eSBarry Smith PCFieldSplitGetIS - Retrieves the elements for a split as an `IS` 219257a9adfeSMatthew G Knepley 2193c3339decSBarry Smith Logically Collective 219457a9adfeSMatthew G Knepley 219557a9adfeSMatthew G Knepley Input Parameters: 219657a9adfeSMatthew G Knepley + pc - the preconditioner context 219757a9adfeSMatthew G Knepley - splitname - name of this split 219857a9adfeSMatthew G Knepley 219957a9adfeSMatthew G Knepley Output Parameter: 2200feefa0e1SJacob Faibussowitsch . is - the index set that defines the elements in this split, or `NULL` if the split is not found 220157a9adfeSMatthew G Knepley 220257a9adfeSMatthew G Knepley Level: intermediate 220357a9adfeSMatthew G Knepley 220460f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCFieldSplitGetSubKSP()`, `PCFIELDSPLIT`, `PCFieldSplitSetIS()` 220557a9adfeSMatthew G Knepley @*/ 2206d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitGetIS(PC pc, const char splitname[], IS *is) 2207d71ae5a4SJacob Faibussowitsch { 220857a9adfeSMatthew G Knepley PetscFunctionBegin; 220957a9adfeSMatthew G Knepley PetscValidHeaderSpecific(pc, PC_CLASSID, 1); 22104f572ea9SToby Isaac PetscAssertPointer(splitname, 2); 22114f572ea9SToby Isaac PetscAssertPointer(is, 3); 221257a9adfeSMatthew G Knepley { 221357a9adfeSMatthew G Knepley PC_FieldSplit *jac = (PC_FieldSplit *)pc->data; 221457a9adfeSMatthew G Knepley PC_FieldSplitLink ilink = jac->head; 221557a9adfeSMatthew G Knepley PetscBool found; 221657a9adfeSMatthew G Knepley 22170298fd71SBarry Smith *is = NULL; 221857a9adfeSMatthew G Knepley while (ilink) { 22199566063dSJacob Faibussowitsch PetscCall(PetscStrcmp(ilink->splitname, splitname, &found)); 222057a9adfeSMatthew G Knepley if (found) { 222157a9adfeSMatthew G Knepley *is = ilink->is; 222257a9adfeSMatthew G Knepley break; 222357a9adfeSMatthew G Knepley } 222457a9adfeSMatthew G Knepley ilink = ilink->next; 222557a9adfeSMatthew G Knepley } 222657a9adfeSMatthew G Knepley } 22273ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 222857a9adfeSMatthew G Knepley } 222957a9adfeSMatthew G Knepley 2230998f007dSPierre Jolivet /*@C 2231f1580f4eSBarry Smith PCFieldSplitGetISByIndex - Retrieves the elements for a given split as an `IS` 2232998f007dSPierre Jolivet 2233c3339decSBarry Smith Logically Collective 2234998f007dSPierre Jolivet 2235998f007dSPierre Jolivet Input Parameters: 2236998f007dSPierre Jolivet + pc - the preconditioner context 2237998f007dSPierre Jolivet - index - index of this split 2238998f007dSPierre Jolivet 2239998f007dSPierre Jolivet Output Parameter: 2240feefa0e1SJacob Faibussowitsch . is - the index set that defines the elements in this split 2241998f007dSPierre Jolivet 2242998f007dSPierre Jolivet Level: intermediate 2243998f007dSPierre Jolivet 224460f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCFieldSplitGetSubKSP()`, `PCFIELDSPLIT`, `PCFieldSplitGetIS()`, `PCFieldSplitSetIS()` 2245998f007dSPierre Jolivet @*/ 2246d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitGetISByIndex(PC pc, PetscInt index, IS *is) 2247d71ae5a4SJacob Faibussowitsch { 2248998f007dSPierre Jolivet PetscFunctionBegin; 224963a3b9bcSJacob Faibussowitsch PetscCheck(index >= 0, PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Negative field %" PetscInt_FMT " requested", index); 2250998f007dSPierre Jolivet PetscValidHeaderSpecific(pc, PC_CLASSID, 1); 22514f572ea9SToby Isaac PetscAssertPointer(is, 3); 2252998f007dSPierre Jolivet { 2253998f007dSPierre Jolivet PC_FieldSplit *jac = (PC_FieldSplit *)pc->data; 2254998f007dSPierre Jolivet PC_FieldSplitLink ilink = jac->head; 2255998f007dSPierre Jolivet PetscInt i = 0; 225663a3b9bcSJacob Faibussowitsch PetscCheck(index < jac->nsplits, PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field %" PetscInt_FMT " requested but only %" PetscInt_FMT " exist", index, jac->nsplits); 2257998f007dSPierre Jolivet 2258998f007dSPierre Jolivet while (i < index) { 2259998f007dSPierre Jolivet ilink = ilink->next; 2260998f007dSPierre Jolivet ++i; 2261998f007dSPierre Jolivet } 22629566063dSJacob Faibussowitsch PetscCall(PCFieldSplitGetIS(pc, ilink->splitname, is)); 2263998f007dSPierre Jolivet } 22643ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 2265998f007dSPierre Jolivet } 2266998f007dSPierre Jolivet 226751f519a2SBarry Smith /*@ 226851f519a2SBarry Smith PCFieldSplitSetBlockSize - Sets the block size for defining where fields start in the 2269f1580f4eSBarry Smith fieldsplit preconditioner when calling `PCFieldSplitSetIS()`. If not set the matrix block size is used. 227051f519a2SBarry Smith 2271c3339decSBarry Smith Logically Collective 227251f519a2SBarry Smith 227351f519a2SBarry Smith Input Parameters: 227451f519a2SBarry Smith + pc - the preconditioner context 227551f519a2SBarry Smith - bs - the block size 227651f519a2SBarry Smith 227751f519a2SBarry Smith Level: intermediate 227851f519a2SBarry Smith 227960f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCFieldSplitGetSubKSP()`, `PCFIELDSPLIT`, `PCFieldSplitSetFields()`, `PCFieldSplitSetIS()` 228051f519a2SBarry Smith @*/ 2281d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitSetBlockSize(PC pc, PetscInt bs) 2282d71ae5a4SJacob Faibussowitsch { 228351f519a2SBarry Smith PetscFunctionBegin; 22840700a824SBarry Smith PetscValidHeaderSpecific(pc, PC_CLASSID, 1); 2285c5eb9154SBarry Smith PetscValidLogicalCollectiveInt(pc, bs, 2); 2286cac4c232SBarry Smith PetscTryMethod(pc, "PCFieldSplitSetBlockSize_C", (PC, PetscInt), (pc, bs)); 22873ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 228851f519a2SBarry Smith } 228951f519a2SBarry Smith 22900971522cSBarry Smith /*@C 2291f1580f4eSBarry Smith PCFieldSplitGetSubKSP - Gets the `KSP` contexts for all splits 22920971522cSBarry Smith 2293c3339decSBarry Smith Collective 22940971522cSBarry Smith 22950971522cSBarry Smith Input Parameter: 22960971522cSBarry Smith . pc - the preconditioner context 22970971522cSBarry Smith 22980971522cSBarry Smith Output Parameters: 229913e0d083SBarry Smith + n - the number of splits 2300f1580f4eSBarry Smith - subksp - the array of `KSP` contexts 2301196cc216SBarry Smith 23020971522cSBarry Smith Level: advanced 23030971522cSBarry Smith 2304f1580f4eSBarry Smith Notes: 2305f1580f4eSBarry Smith After `PCFieldSplitGetSubKSP()` the array of `KSP`s is to be freed by the user with `PetscFree()` 2306f1580f4eSBarry Smith (not the `KSP`, just the array that contains them). 2307f1580f4eSBarry Smith 2308f1580f4eSBarry Smith You must call `PCSetUp()` before calling `PCFieldSplitGetSubKSP()`. 2309f1580f4eSBarry Smith 2310f1580f4eSBarry Smith If the fieldsplit is of type `PC_COMPOSITE_SCHUR`, it returns the `KSP` object used inside the 2311f1580f4eSBarry Smith Schur complement and the `KSP` object used to iterate over the Schur complement. 2312f1580f4eSBarry Smith To access all the `KSP` objects used in `PC_COMPOSITE_SCHUR`, use `PCFieldSplitSchurGetSubKSP()`. 2313f1580f4eSBarry Smith 2314f1580f4eSBarry Smith If the fieldsplit is of type `PC_COMPOSITE_GKB`, it returns the `KSP` object used to solve the 2315f1580f4eSBarry Smith inner linear system defined by the matrix H in each loop. 2316f1580f4eSBarry Smith 2317feefa0e1SJacob Faibussowitsch Fortran Notes: 2318f1580f4eSBarry Smith You must pass in a `KSP` array that is large enough to contain all the `KSP`s. 2319f1580f4eSBarry Smith You can call `PCFieldSplitGetSubKSP`(pc,n,`PETSC_NULL_KSP`,ierr) to determine how large the 2320f1580f4eSBarry Smith `KSP` array must be. 2321f1580f4eSBarry Smith 2322feefa0e1SJacob Faibussowitsch Developer Notes: 2323f1580f4eSBarry Smith There should be a `PCFieldSplitRestoreSubKSP()` instead of requiring the user to call `PetscFree()` 2324f1580f4eSBarry Smith 2325f1580f4eSBarry Smith The Fortran interface should be modernized to return directly the array of values. 2326f1580f4eSBarry Smith 232760f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCFIELDSPLIT`, `PCFieldSplitSetFields()`, `PCFieldSplitSetIS()`, `PCFieldSplitSchurGetSubKSP()` 23280971522cSBarry Smith @*/ 2329d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitGetSubKSP(PC pc, PetscInt *n, KSP *subksp[]) 2330d71ae5a4SJacob Faibussowitsch { 23310971522cSBarry Smith PetscFunctionBegin; 23320700a824SBarry Smith PetscValidHeaderSpecific(pc, PC_CLASSID, 1); 23334f572ea9SToby Isaac if (n) PetscAssertPointer(n, 2); 2334cac4c232SBarry Smith PetscUseMethod(pc, "PCFieldSplitGetSubKSP_C", (PC, PetscInt *, KSP **), (pc, n, subksp)); 23353ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 23360971522cSBarry Smith } 23370971522cSBarry Smith 2338285fb4e2SStefano Zampini /*@C 2339f1580f4eSBarry Smith PCFieldSplitSchurGetSubKSP - Gets the `KSP` contexts used inside the Schur complement based `PCFIELDSPLIT` 2340285fb4e2SStefano Zampini 234160f59c3bSBarry Smith Collective 2342285fb4e2SStefano Zampini 2343285fb4e2SStefano Zampini Input Parameter: 2344285fb4e2SStefano Zampini . pc - the preconditioner context 2345285fb4e2SStefano Zampini 2346285fb4e2SStefano Zampini Output Parameters: 2347285fb4e2SStefano Zampini + n - the number of splits 2348f1580f4eSBarry Smith - subksp - the array of `KSP` contexts 2349285fb4e2SStefano Zampini 2350285fb4e2SStefano Zampini Level: advanced 2351285fb4e2SStefano Zampini 2352f1580f4eSBarry Smith Notes: 2353f1580f4eSBarry Smith After `PCFieldSplitSchurGetSubKSP()` the array of `KSP`s is to be freed by the user with `PetscFree()` 2354f1580f4eSBarry Smith (not the `KSP` just the array that contains them). 2355f1580f4eSBarry Smith 2356f1580f4eSBarry Smith You must call `PCSetUp()` before calling `PCFieldSplitSchurGetSubKSP()`. 2357f1580f4eSBarry Smith 2358f1580f4eSBarry Smith If the fieldsplit type is of type `PC_COMPOSITE_SCHUR`, it returns (in order) 2359f1580f4eSBarry Smith + 1 - the `KSP` used for the (1,1) block 2360f1580f4eSBarry Smith . 2 - the `KSP` used for the Schur complement (not the one used for the interior Schur solver) 2361f1580f4eSBarry Smith - 3 - the `KSP` used for the (1,1) block in the upper triangular factor (if different from that of the (1,1) block). 2362f1580f4eSBarry Smith 2363f1580f4eSBarry Smith It returns a null array if the fieldsplit is not of type `PC_COMPOSITE_SCHUR`; in this case, you should use `PCFieldSplitGetSubKSP()`. 2364f1580f4eSBarry Smith 2365feefa0e1SJacob Faibussowitsch Fortran Notes: 2366f1580f4eSBarry Smith You must pass in a `KSP` array that is large enough to contain all the local `KSP`s. 2367f1580f4eSBarry Smith You can call `PCFieldSplitSchurGetSubKSP`(pc,n,`PETSC_NULL_KSP`,ierr) to determine how large the 2368f1580f4eSBarry Smith `KSP` array must be. 2369f1580f4eSBarry Smith 2370f1580f4eSBarry Smith Developer Notes: 2371f1580f4eSBarry Smith There should be a `PCFieldSplitRestoreSubKSP()` instead of requiring the user to call `PetscFree()` 2372f1580f4eSBarry Smith 2373f1580f4eSBarry Smith Should the functionality of `PCFieldSplitSchurGetSubKSP()` and `PCFieldSplitGetSubKSP()` be merged? 2374f1580f4eSBarry Smith 2375f1580f4eSBarry Smith The Fortran interface should be modernized to return directly the array of values. 2376f1580f4eSBarry Smith 237760f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCFIELDSPLIT`, `PCFieldSplitSetFields()`, `PCFieldSplitSetIS()`, `PCFieldSplitGetSubKSP()` 2378285fb4e2SStefano Zampini @*/ 2379d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitSchurGetSubKSP(PC pc, PetscInt *n, KSP *subksp[]) 2380d71ae5a4SJacob Faibussowitsch { 2381285fb4e2SStefano Zampini PetscFunctionBegin; 2382285fb4e2SStefano Zampini PetscValidHeaderSpecific(pc, PC_CLASSID, 1); 23834f572ea9SToby Isaac if (n) PetscAssertPointer(n, 2); 2384cac4c232SBarry Smith PetscUseMethod(pc, "PCFieldSplitSchurGetSubKSP_C", (PC, PetscInt *, KSP **), (pc, n, subksp)); 23853ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 2386285fb4e2SStefano Zampini } 2387285fb4e2SStefano Zampini 2388e69d4d44SBarry Smith /*@ 2389a1e3cbf9SBarry Smith PCFieldSplitSetSchurPre - Indicates from what operator the preconditioner is constructucted for the Schur complement. 2390a1e3cbf9SBarry Smith The default is the A11 matrix. 2391e69d4d44SBarry Smith 2392c3339decSBarry Smith Collective 2393e69d4d44SBarry Smith 2394e69d4d44SBarry Smith Input Parameters: 2395e69d4d44SBarry Smith + pc - the preconditioner context 2396f1580f4eSBarry Smith . ptype - which matrix to use for preconditioning the Schur complement: `PC_FIELDSPLIT_SCHUR_PRE_A11` (default), 2397f1580f4eSBarry Smith `PC_FIELDSPLIT_SCHUR_PRE_SELF`, `PC_FIELDSPLIT_SCHUR_PRE_USER`, 2398f1580f4eSBarry Smith `PC_FIELDSPLIT_SCHUR_PRE_SELFP`, and `PC_FIELDSPLIT_SCHUR_PRE_FULL` 239960f59c3bSBarry Smith - pre - matrix to use for preconditioning, or `NULL` 2400084e4875SJed Brown 2401f1580f4eSBarry Smith Options Database Keys: 2402a1e3cbf9SBarry Smith + -pc_fieldsplit_schur_precondition <self,selfp,user,a11,full> - default is a11. See notes for meaning of various arguments 2403a1e3cbf9SBarry Smith - -fieldsplit_1_pc_type <pctype> - the preconditioner algorithm that is used to construct the preconditioner from the operator 2404e69d4d44SBarry Smith 240560f59c3bSBarry Smith Level: intermediate 240660f59c3bSBarry Smith 2407fd1303e9SJungho Lee Notes: 2408f1580f4eSBarry Smith If ptype is 2409f1580f4eSBarry Smith + a11 - the preconditioner for the Schur complement is generated from the block diagonal part of the preconditioner 2410f1580f4eSBarry Smith matrix associated with the Schur complement (i.e. A11), not the Schur complement matrix 2411f1580f4eSBarry Smith . self - the preconditioner for the Schur complement is generated from the symbolic representation of the Schur complement matrix: 2412da81f932SPierre Jolivet The only preconditioner that currently works with this symbolic representation matrix object is the `PCLSC` 2413f1580f4eSBarry Smith preconditioner 2414f1580f4eSBarry Smith . user - the preconditioner for the Schur complement is generated from the user provided matrix (pre argument 2415f1580f4eSBarry Smith to this function). 2416f1580f4eSBarry Smith . selfp - the preconditioning for the Schur complement is generated from an explicitly-assembled approximation Sp = A11 - A10 inv(diag(A00)) A01 2417f1580f4eSBarry Smith This is only a good preconditioner when diag(A00) is a good preconditioner for A00. Optionally, A00 can be 2418f1580f4eSBarry Smith lumped before extracting the diagonal using the additional option -fieldsplit_1_mat_schur_complement_ainv_type lump 2419f1580f4eSBarry Smith - full - the preconditioner for the Schur complement is generated from the exact Schur complement matrix representation 2420f1580f4eSBarry Smith computed internally by `PCFIELDSPLIT` (this is expensive) 2421f1580f4eSBarry Smith useful mostly as a test that the Schur complement approach can work for your problem 2422fd1303e9SJungho Lee 2423e87fab1bSBarry Smith When solving a saddle point problem, where the A11 block is identically zero, using a11 as the ptype only makes sense 2424fd1303e9SJungho Lee with the additional option -fieldsplit_1_pc_type none. Usually for saddle point problems one would use a ptype of self and 2425a7476a74SDmitry Karpeev -fieldsplit_1_pc_type lsc which uses the least squares commutator to compute a preconditioner for the Schur complement. 2426fd1303e9SJungho Lee 242760f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCFieldSplitGetSchurPre()`, `PCFieldSplitGetSubKSP()`, `PCFIELDSPLIT`, `PCFieldSplitSetFields()`, `PCFieldSplitSchurPreType`, 2428f1580f4eSBarry Smith `MatSchurComplementSetAinvType()`, `PCLSC`, 2429feefa0e1SJacob Faibussowitsch 2430e69d4d44SBarry Smith @*/ 2431d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitSetSchurPre(PC pc, PCFieldSplitSchurPreType ptype, Mat pre) 2432d71ae5a4SJacob Faibussowitsch { 2433e69d4d44SBarry Smith PetscFunctionBegin; 24340700a824SBarry Smith PetscValidHeaderSpecific(pc, PC_CLASSID, 1); 2435cac4c232SBarry Smith PetscTryMethod(pc, "PCFieldSplitSetSchurPre_C", (PC, PCFieldSplitSchurPreType, Mat), (pc, ptype, pre)); 24363ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 2437e69d4d44SBarry Smith } 2438686bed4dSStefano Zampini 2439d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitSchurPrecondition(PC pc, PCFieldSplitSchurPreType ptype, Mat pre) 2440d71ae5a4SJacob Faibussowitsch { 24419371c9d4SSatish Balay return PCFieldSplitSetSchurPre(pc, ptype, pre); 24429371c9d4SSatish Balay } /* Deprecated name */ 2443e69d4d44SBarry Smith 244437a82bf0SJed Brown /*@ 244537a82bf0SJed Brown PCFieldSplitGetSchurPre - For Schur complement fieldsplit, determine how the Schur complement will be 2446f1580f4eSBarry Smith preconditioned. See `PCFieldSplitSetSchurPre()` for details. 244737a82bf0SJed Brown 2448c3339decSBarry Smith Logically Collective 244937a82bf0SJed Brown 2450f899ff85SJose E. Roman Input Parameter: 245137a82bf0SJed Brown . pc - the preconditioner context 245237a82bf0SJed Brown 245337a82bf0SJed Brown Output Parameters: 2454f1580f4eSBarry Smith + ptype - which matrix to use for preconditioning the Schur complement: `PC_FIELDSPLIT_SCHUR_PRE_A11`, `PC_FIELDSPLIT_SCHUR_PRE_SELF`, `PC_FIELDSPLIT_PRE_USER` 2455f408ff4eSRichard Tran Mills - pre - matrix to use for preconditioning (with `PC_FIELDSPLIT_PRE_USER`), or NULL 245637a82bf0SJed Brown 245737a82bf0SJed Brown Level: intermediate 245837a82bf0SJed Brown 245960f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCFieldSplitSetSchurPre()`, `PCFieldSplitGetSubKSP()`, `PCFIELDSPLIT`, `PCFieldSplitSetFields()`, `PCFieldSplitSchurPreType`, `PCLSC`, 2460feefa0e1SJacob Faibussowitsch 246137a82bf0SJed Brown @*/ 2462d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitGetSchurPre(PC pc, PCFieldSplitSchurPreType *ptype, Mat *pre) 2463d71ae5a4SJacob Faibussowitsch { 246437a82bf0SJed Brown PetscFunctionBegin; 246537a82bf0SJed Brown PetscValidHeaderSpecific(pc, PC_CLASSID, 1); 2466cac4c232SBarry Smith PetscUseMethod(pc, "PCFieldSplitGetSchurPre_C", (PC, PCFieldSplitSchurPreType *, Mat *), (pc, ptype, pre)); 24673ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 2468e69d4d44SBarry Smith } 2469e69d4d44SBarry Smith 247045e7fc46SDmitry Karpeev /*@ 2471f1580f4eSBarry Smith PCFieldSplitSchurGetS - extract the `MATSCHURCOMPLEMENT` object used by this `PCFIELDSPLIT` in case it needs to be configured separately 247245e7fc46SDmitry Karpeev 247320f4b53cSBarry Smith Not Collective 247445e7fc46SDmitry Karpeev 247545e7fc46SDmitry Karpeev Input Parameter: 247645e7fc46SDmitry Karpeev . pc - the preconditioner context 247745e7fc46SDmitry Karpeev 247845e7fc46SDmitry Karpeev Output Parameter: 2479470b340bSDmitry Karpeev . S - the Schur complement matrix 248045e7fc46SDmitry Karpeev 248160f59c3bSBarry Smith Level: advanced 248260f59c3bSBarry Smith 2483f1580f4eSBarry Smith Note: 2484f1580f4eSBarry Smith This matrix should not be destroyed using `MatDestroy()`; rather, use `PCFieldSplitSchurRestoreS()`. 248545e7fc46SDmitry Karpeev 248660f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCFieldSplitGetSubKSP()`, `PCFIELDSPLIT`, `PCFieldSplitSchurPreType`, `PCFieldSplitSetSchurPre()`, `MATSCHURCOMPLEMENT`, `PCFieldSplitSchurRestoreS()`, 2487f1580f4eSBarry Smith `MatCreateSchurComplement()`, `MatSchurComplementGetKSP()`, `MatSchurComplementComputeExplicitOperator()`, `MatGetSchurComplement()` 248845e7fc46SDmitry Karpeev @*/ 2489d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitSchurGetS(PC pc, Mat *S) 2490d71ae5a4SJacob Faibussowitsch { 249145e7fc46SDmitry Karpeev const char *t; 249245e7fc46SDmitry Karpeev PetscBool isfs; 249345e7fc46SDmitry Karpeev PC_FieldSplit *jac; 249445e7fc46SDmitry Karpeev 249545e7fc46SDmitry Karpeev PetscFunctionBegin; 249645e7fc46SDmitry Karpeev PetscValidHeaderSpecific(pc, PC_CLASSID, 1); 24979566063dSJacob Faibussowitsch PetscCall(PetscObjectGetType((PetscObject)pc, &t)); 24989566063dSJacob Faibussowitsch PetscCall(PetscStrcmp(t, PCFIELDSPLIT, &isfs)); 249928b400f6SJacob Faibussowitsch PetscCheck(isfs, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "Expected PC of type PCFIELDSPLIT, got %s instead", t); 250045e7fc46SDmitry Karpeev jac = (PC_FieldSplit *)pc->data; 250163a3b9bcSJacob Faibussowitsch PetscCheck(jac->type == PC_COMPOSITE_SCHUR, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "Expected PCFIELDSPLIT of type SCHUR, got %d instead", jac->type); 2502470b340bSDmitry Karpeev if (S) *S = jac->schur; 25033ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 250445e7fc46SDmitry Karpeev } 250545e7fc46SDmitry Karpeev 2506470b340bSDmitry Karpeev /*@ 2507f1580f4eSBarry Smith PCFieldSplitSchurRestoreS - returns the `MATSCHURCOMPLEMENT` matrix used by this `PC` 2508470b340bSDmitry Karpeev 250920f4b53cSBarry Smith Not Collective 2510470b340bSDmitry Karpeev 2511470b340bSDmitry Karpeev Input Parameters: 2512470b340bSDmitry Karpeev + pc - the preconditioner context 2513a2b725a8SWilliam Gropp - S - the Schur complement matrix 2514470b340bSDmitry Karpeev 2515470b340bSDmitry Karpeev Level: advanced 2516470b340bSDmitry Karpeev 251760f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCFieldSplitGetSubKSP()`, `PCFIELDSPLIT`, `PCFieldSplitSchurPreType`, `PCFieldSplitSetSchurPre()`, `MatSchurComplement`, `PCFieldSplitSchurGetS()` 2518470b340bSDmitry Karpeev @*/ 2519d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitSchurRestoreS(PC pc, Mat *S) 2520d71ae5a4SJacob Faibussowitsch { 2521470b340bSDmitry Karpeev const char *t; 2522470b340bSDmitry Karpeev PetscBool isfs; 2523470b340bSDmitry Karpeev PC_FieldSplit *jac; 2524470b340bSDmitry Karpeev 2525470b340bSDmitry Karpeev PetscFunctionBegin; 2526470b340bSDmitry Karpeev PetscValidHeaderSpecific(pc, PC_CLASSID, 1); 25279566063dSJacob Faibussowitsch PetscCall(PetscObjectGetType((PetscObject)pc, &t)); 25289566063dSJacob Faibussowitsch PetscCall(PetscStrcmp(t, PCFIELDSPLIT, &isfs)); 252928b400f6SJacob Faibussowitsch PetscCheck(isfs, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "Expected PC of type PCFIELDSPLIT, got %s instead", t); 2530470b340bSDmitry Karpeev jac = (PC_FieldSplit *)pc->data; 253163a3b9bcSJacob Faibussowitsch PetscCheck(jac->type == PC_COMPOSITE_SCHUR, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "Expected PCFIELDSPLIT of type SCHUR, got %d instead", jac->type); 25327827d75bSBarry Smith PetscCheck(S && (*S == jac->schur), PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "MatSchurComplement restored is not the same as gotten"); 25333ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 2534470b340bSDmitry Karpeev } 2535470b340bSDmitry Karpeev 2536d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCFieldSplitSetSchurPre_FieldSplit(PC pc, PCFieldSplitSchurPreType ptype, Mat pre) 2537d71ae5a4SJacob Faibussowitsch { 2538e69d4d44SBarry Smith PC_FieldSplit *jac = (PC_FieldSplit *)pc->data; 2539e69d4d44SBarry Smith 2540e69d4d44SBarry Smith PetscFunctionBegin; 2541084e4875SJed Brown jac->schurpre = ptype; 2542a7476a74SDmitry Karpeev if (ptype == PC_FIELDSPLIT_SCHUR_PRE_USER && pre) { 25439566063dSJacob Faibussowitsch PetscCall(MatDestroy(&jac->schur_user)); 2544084e4875SJed Brown jac->schur_user = pre; 25459566063dSJacob Faibussowitsch PetscCall(PetscObjectReference((PetscObject)jac->schur_user)); 2546084e4875SJed Brown } 25473ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 2548e69d4d44SBarry Smith } 2549e69d4d44SBarry Smith 2550d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCFieldSplitGetSchurPre_FieldSplit(PC pc, PCFieldSplitSchurPreType *ptype, Mat *pre) 2551d71ae5a4SJacob Faibussowitsch { 255237a82bf0SJed Brown PC_FieldSplit *jac = (PC_FieldSplit *)pc->data; 255337a82bf0SJed Brown 255437a82bf0SJed Brown PetscFunctionBegin; 255537a82bf0SJed Brown *ptype = jac->schurpre; 255637a82bf0SJed Brown *pre = jac->schur_user; 25573ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 255837a82bf0SJed Brown } 255937a82bf0SJed Brown 2560ab1df9f5SJed Brown /*@ 25610ffb0e17SBarry Smith PCFieldSplitSetSchurFactType - sets which blocks of the approximate block factorization to retain in the preconditioner 2562ab1df9f5SJed Brown 2563c3339decSBarry Smith Collective 2564ab1df9f5SJed Brown 2565ab1df9f5SJed Brown Input Parameters: 2566ab1df9f5SJed Brown + pc - the preconditioner context 2567f1580f4eSBarry Smith - ftype - which blocks of factorization to retain, `PC_FIELDSPLIT_SCHUR_FACT_FULL` is default 2568ab1df9f5SJed Brown 2569f1580f4eSBarry Smith Options Database Key: 2570147403d9SBarry Smith . -pc_fieldsplit_schur_fact_type <diag,lower,upper,full> - default is full 2571ab1df9f5SJed Brown 2572ab1df9f5SJed Brown Level: intermediate 2573ab1df9f5SJed Brown 2574ab1df9f5SJed Brown Notes: 2575ab1df9f5SJed Brown The FULL factorization is 2576ab1df9f5SJed Brown 2577147403d9SBarry Smith .vb 2578147403d9SBarry Smith (A B) = (1 0) (A 0) (1 Ainv*B) = L D U 2579147403d9SBarry Smith (C E) (C*Ainv 1) (0 S) (0 1) 2580147403d9SBarry Smith .vb 25810ffb0e17SBarry 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, 258216a05f60SBarry Smith and DIAG is the diagonal part with the sign of S flipped (because this makes the preconditioner positive definite for many formulations, thus allowing the use of `KSPMINRES)`. 258316a05f60SBarry Smith Sign flipping of S can be turned off with `PCFieldSplitSetSchurScale()`. 2584ab1df9f5SJed Brown 2585147403d9SBarry Smith If A and S are solved exactly 2586147403d9SBarry Smith .vb 2587147403d9SBarry Smith *) FULL factorization is a direct solver. 2588f1580f4eSBarry 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. 2589f1580f4eSBarry 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. 2590147403d9SBarry Smith .ve 2591ab1df9f5SJed Brown 2592f1580f4eSBarry Smith If the iteration count is very low, consider using `KSPFGMRES` or `KSPGCR` which can use one less preconditioner 25930ffb0e17SBarry 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. 25940ffb0e17SBarry Smith 2595f1580f4eSBarry Smith For symmetric problems in which A is positive definite and S is negative definite, DIAG can be used with `KSPMINRES`. 25960ffb0e17SBarry Smith 2597f1580f4eSBarry Smith 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). 2598ab1df9f5SJed Brown 2599ab1df9f5SJed Brown References: 2600606c0280SSatish Balay + * - Murphy, Golub, and Wathen, A note on preconditioning indefinite linear systems, SIAM J. Sci. Comput., 21 (2000). 2601606c0280SSatish Balay - * - Ipsen, A note on preconditioning nonsymmetric matrices, SIAM J. Sci. Comput., 23 (2001). 2602ab1df9f5SJed Brown 260360f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCFieldSplitGetSubKSP()`, `PCFIELDSPLIT`, `PCFieldSplitSetFields()`, `PCFieldSplitSchurPreType`, `PCFieldSplitSetSchurScale()` 2604ab1df9f5SJed Brown @*/ 2605d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitSetSchurFactType(PC pc, PCFieldSplitSchurFactType ftype) 2606d71ae5a4SJacob Faibussowitsch { 2607ab1df9f5SJed Brown PetscFunctionBegin; 2608ab1df9f5SJed Brown PetscValidHeaderSpecific(pc, PC_CLASSID, 1); 2609cac4c232SBarry Smith PetscTryMethod(pc, "PCFieldSplitSetSchurFactType_C", (PC, PCFieldSplitSchurFactType), (pc, ftype)); 26103ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 2611ab1df9f5SJed Brown } 2612ab1df9f5SJed Brown 2613d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCFieldSplitSetSchurFactType_FieldSplit(PC pc, PCFieldSplitSchurFactType ftype) 2614d71ae5a4SJacob Faibussowitsch { 2615ab1df9f5SJed Brown PC_FieldSplit *jac = (PC_FieldSplit *)pc->data; 2616ab1df9f5SJed Brown 2617ab1df9f5SJed Brown PetscFunctionBegin; 2618ab1df9f5SJed Brown jac->schurfactorization = ftype; 26193ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 2620ab1df9f5SJed Brown } 2621ab1df9f5SJed Brown 2622c096484dSStefano Zampini /*@ 2623f1580f4eSBarry Smith PCFieldSplitSetSchurScale - Controls the sign flip of S for `PC_FIELDSPLIT_SCHUR_FACT_DIAG`. 2624c096484dSStefano Zampini 2625c3339decSBarry Smith Collective 2626c096484dSStefano Zampini 2627c096484dSStefano Zampini Input Parameters: 2628c096484dSStefano Zampini + pc - the preconditioner context 2629c096484dSStefano Zampini - scale - scaling factor for the Schur complement 2630c096484dSStefano Zampini 2631f1580f4eSBarry Smith Options Database Key: 2632c096484dSStefano Zampini . -pc_fieldsplit_schur_scale - default is -1.0 2633c096484dSStefano Zampini 2634c096484dSStefano Zampini Level: intermediate 2635c096484dSStefano Zampini 263642747ad1SJacob Faibussowitsch .seealso: [](sec_block_matrices), `PC`, `PCFIELDSPLIT`, `PCFieldSplitSetFields()`, `PCFieldSplitSchurFactType`, `PCFieldSplitSetSchurFactType()` 2637c096484dSStefano Zampini @*/ 2638d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitSetSchurScale(PC pc, PetscScalar scale) 2639d71ae5a4SJacob Faibussowitsch { 2640c096484dSStefano Zampini PetscFunctionBegin; 2641c096484dSStefano Zampini PetscValidHeaderSpecific(pc, PC_CLASSID, 1); 2642c096484dSStefano Zampini PetscValidLogicalCollectiveScalar(pc, scale, 2); 2643cac4c232SBarry Smith PetscTryMethod(pc, "PCFieldSplitSetSchurScale_C", (PC, PetscScalar), (pc, scale)); 26443ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 2645c096484dSStefano Zampini } 2646c096484dSStefano Zampini 2647d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCFieldSplitSetSchurScale_FieldSplit(PC pc, PetscScalar scale) 2648d71ae5a4SJacob Faibussowitsch { 2649c096484dSStefano Zampini PC_FieldSplit *jac = (PC_FieldSplit *)pc->data; 2650c096484dSStefano Zampini 2651c096484dSStefano Zampini PetscFunctionBegin; 2652c096484dSStefano Zampini jac->schurscale = scale; 26533ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 2654c096484dSStefano Zampini } 2655c096484dSStefano Zampini 265630ad9308SMatthew Knepley /*@C 26578c03b21aSDmitry Karpeev PCFieldSplitGetSchurBlocks - Gets all matrix blocks for the Schur complement 265830ad9308SMatthew Knepley 2659c3339decSBarry Smith Collective 266030ad9308SMatthew Knepley 266130ad9308SMatthew Knepley Input Parameter: 266230ad9308SMatthew Knepley . pc - the preconditioner context 266330ad9308SMatthew Knepley 266430ad9308SMatthew Knepley Output Parameters: 2665a04f6461SBarry Smith + A00 - the (0,0) block 2666a04f6461SBarry Smith . A01 - the (0,1) block 2667a04f6461SBarry Smith . A10 - the (1,0) block 2668a04f6461SBarry Smith - A11 - the (1,1) block 266930ad9308SMatthew Knepley 267030ad9308SMatthew Knepley Level: advanced 267130ad9308SMatthew Knepley 267260f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCFIELDSPLIT`, `MatSchurComplementGetSubMatrices()`, `MatSchurComplementSetSubMatrices()` 267330ad9308SMatthew Knepley @*/ 2674d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitGetSchurBlocks(PC pc, Mat *A00, Mat *A01, Mat *A10, Mat *A11) 2675d71ae5a4SJacob Faibussowitsch { 267630ad9308SMatthew Knepley PC_FieldSplit *jac = (PC_FieldSplit *)pc->data; 267730ad9308SMatthew Knepley 267830ad9308SMatthew Knepley PetscFunctionBegin; 26790700a824SBarry Smith PetscValidHeaderSpecific(pc, PC_CLASSID, 1); 268008401ef6SPierre Jolivet PetscCheck(jac->type == PC_COMPOSITE_SCHUR, PetscObjectComm((PetscObject)pc), PETSC_ERR_ARG_WRONG, "FieldSplit is not using a Schur complement approach."); 2681a04f6461SBarry Smith if (A00) *A00 = jac->pmat[0]; 2682a04f6461SBarry Smith if (A01) *A01 = jac->B; 2683a04f6461SBarry Smith if (A10) *A10 = jac->C; 2684a04f6461SBarry Smith if (A11) *A11 = jac->pmat[1]; 26853ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 268630ad9308SMatthew Knepley } 268730ad9308SMatthew Knepley 2688b09e027eSCarola Kruse /*@ 2689f1580f4eSBarry Smith PCFieldSplitSetGKBTol - Sets the solver tolerance for the generalized Golub-Kahan bidiagonalization preconditioner in `PCFIELDSPLIT` 2690b09e027eSCarola Kruse 2691c3339decSBarry Smith Collective 2692e071a0a4SCarola Kruse 2693b09e027eSCarola Kruse Input Parameters: 2694b09e027eSCarola Kruse + pc - the preconditioner context 2695b09e027eSCarola Kruse - tolerance - the solver tolerance 2696b09e027eSCarola Kruse 2697f1580f4eSBarry Smith Options Database Key: 2698b09e027eSCarola Kruse . -pc_fieldsplit_gkb_tol - default is 1e-5 2699b09e027eSCarola Kruse 2700b09e027eSCarola Kruse Level: intermediate 2701b09e027eSCarola Kruse 2702f1580f4eSBarry Smith Note: 2703f1580f4eSBarry Smith The generalized GKB algorithm uses a lower bound estimate of the error in energy norm as stopping criterion. 2704f1580f4eSBarry Smith It stops once the lower bound estimate undershoots the required solver tolerance. Although the actual error might be bigger than 2705f1580f4eSBarry Smith this estimate, the stopping criterion is satisfactory in practical cases [A13]. 2706f1580f4eSBarry Smith 270760f59c3bSBarry Smith References: 2708f1580f4eSBarry Smith [Ar13] Generalized Golub-Kahan bidiagonalization and stopping criteria, SIAM J. Matrix Anal. Appl., Vol. 34, No. 2, pp. 571-592, 2013. 2709f1580f4eSBarry Smith 271060f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCFIELDSPLIT`, `PCFieldSplitSetGKBDelay()`, `PCFieldSplitSetGKBNu()`, `PCFieldSplitSetGKBMaxit()` 2711b09e027eSCarola Kruse @*/ 2712d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitSetGKBTol(PC pc, PetscReal tolerance) 2713d71ae5a4SJacob Faibussowitsch { 2714b09e027eSCarola Kruse PetscFunctionBegin; 2715b09e027eSCarola Kruse PetscValidHeaderSpecific(pc, PC_CLASSID, 1); 2716de482cd7SCarola Kruse PetscValidLogicalCollectiveReal(pc, tolerance, 2); 2717cac4c232SBarry Smith PetscTryMethod(pc, "PCFieldSplitSetGKBTol_C", (PC, PetscReal), (pc, tolerance)); 27183ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 2719b09e027eSCarola Kruse } 2720b09e027eSCarola Kruse 2721d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCFieldSplitSetGKBTol_FieldSplit(PC pc, PetscReal tolerance) 2722d71ae5a4SJacob Faibussowitsch { 2723b09e027eSCarola Kruse PC_FieldSplit *jac = (PC_FieldSplit *)pc->data; 2724b09e027eSCarola Kruse 2725b09e027eSCarola Kruse PetscFunctionBegin; 2726b09e027eSCarola Kruse jac->gkbtol = tolerance; 27273ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 2728b09e027eSCarola Kruse } 2729b09e027eSCarola Kruse 2730b09e027eSCarola Kruse /*@ 2731f1580f4eSBarry Smith PCFieldSplitSetGKBMaxit - Sets the maximum number of iterations for the generalized Golub-Kahan bidiagonalization preconditioner in `PCFIELDSPLIT` 2732b09e027eSCarola Kruse 2733c3339decSBarry Smith Collective 2734b09e027eSCarola Kruse 2735b09e027eSCarola Kruse Input Parameters: 2736b09e027eSCarola Kruse + pc - the preconditioner context 2737b09e027eSCarola Kruse - maxit - the maximum number of iterations 2738b09e027eSCarola Kruse 2739f1580f4eSBarry Smith Options Database Key: 2740b09e027eSCarola Kruse . -pc_fieldsplit_gkb_maxit - default is 100 2741b09e027eSCarola Kruse 2742b09e027eSCarola Kruse Level: intermediate 2743b09e027eSCarola Kruse 274460f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCFIELDSPLIT`, `PCFieldSplitSetGKBDelay()`, `PCFieldSplitSetGKBTol()`, `PCFieldSplitSetGKBNu()` 2745b09e027eSCarola Kruse @*/ 2746d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitSetGKBMaxit(PC pc, PetscInt maxit) 2747d71ae5a4SJacob Faibussowitsch { 2748b09e027eSCarola Kruse PetscFunctionBegin; 2749b09e027eSCarola Kruse PetscValidHeaderSpecific(pc, PC_CLASSID, 1); 2750de482cd7SCarola Kruse PetscValidLogicalCollectiveInt(pc, maxit, 2); 2751cac4c232SBarry Smith PetscTryMethod(pc, "PCFieldSplitSetGKBMaxit_C", (PC, PetscInt), (pc, maxit)); 27523ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 2753b09e027eSCarola Kruse } 2754b09e027eSCarola Kruse 2755d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCFieldSplitSetGKBMaxit_FieldSplit(PC pc, PetscInt maxit) 2756d71ae5a4SJacob Faibussowitsch { 2757b09e027eSCarola Kruse PC_FieldSplit *jac = (PC_FieldSplit *)pc->data; 2758b09e027eSCarola Kruse 2759b09e027eSCarola Kruse PetscFunctionBegin; 2760b09e027eSCarola Kruse jac->gkbmaxit = maxit; 27613ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 2762b09e027eSCarola Kruse } 2763b09e027eSCarola Kruse 2764b09e027eSCarola Kruse /*@ 2765f1580f4eSBarry Smith PCFieldSplitSetGKBDelay - Sets the delay in the lower bound error estimate in the generalized Golub-Kahan bidiagonalization in `PCFIELDSPLIT` 2766e071a0a4SCarola Kruse preconditioner. 2767b09e027eSCarola Kruse 2768c3339decSBarry Smith Collective 2769b09e027eSCarola Kruse 2770b09e027eSCarola Kruse Input Parameters: 2771b09e027eSCarola Kruse + pc - the preconditioner context 2772b09e027eSCarola Kruse - delay - the delay window in the lower bound estimate 2773b09e027eSCarola Kruse 2774f1580f4eSBarry Smith Options Database Key: 2775b09e027eSCarola Kruse . -pc_fieldsplit_gkb_delay - default is 5 2776b09e027eSCarola Kruse 2777b09e027eSCarola Kruse Level: intermediate 2778b09e027eSCarola Kruse 2779f1580f4eSBarry Smith Note: 2780f1580f4eSBarry Smith The algorithm uses a lower bound estimate of the error in energy norm as stopping criterion. The lower bound of the error ||u-u^k||_H 2781f1580f4eSBarry Smith is expressed as a truncated sum. The error at iteration k can only be measured at iteration (k + delay), and thus the algorithm needs 2782f1580f4eSBarry Smith at least (delay + 1) iterations to stop. For more details on the generalized Golub-Kahan bidiagonalization method and its lower bound stopping criterion, please refer to 2783f1580f4eSBarry Smith 278460f59c3bSBarry Smith References: 2785f1580f4eSBarry Smith [Ar13] Generalized Golub-Kahan bidiagonalization and stopping criteria, SIAM J. Matrix Anal. Appl., Vol. 34, No. 2, pp. 571-592, 2013. 2786f1580f4eSBarry Smith 278760f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCFIELDSPLIT`, `PCFieldSplitSetGKBNu()`, `PCFieldSplitSetGKBTol()`, `PCFieldSplitSetGKBMaxit()` 2788b09e027eSCarola Kruse @*/ 2789d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitSetGKBDelay(PC pc, PetscInt delay) 2790d71ae5a4SJacob Faibussowitsch { 2791b09e027eSCarola Kruse PetscFunctionBegin; 2792b09e027eSCarola Kruse PetscValidHeaderSpecific(pc, PC_CLASSID, 1); 2793b09e027eSCarola Kruse PetscValidLogicalCollectiveInt(pc, delay, 2); 2794cac4c232SBarry Smith PetscTryMethod(pc, "PCFieldSplitSetGKBDelay_C", (PC, PetscInt), (pc, delay)); 27953ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 2796b09e027eSCarola Kruse } 2797b09e027eSCarola Kruse 2798d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCFieldSplitSetGKBDelay_FieldSplit(PC pc, PetscInt delay) 2799d71ae5a4SJacob Faibussowitsch { 2800b09e027eSCarola Kruse PC_FieldSplit *jac = (PC_FieldSplit *)pc->data; 2801b09e027eSCarola Kruse 2802b09e027eSCarola Kruse PetscFunctionBegin; 2803b09e027eSCarola Kruse jac->gkbdelay = delay; 28043ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 2805b09e027eSCarola Kruse } 2806b09e027eSCarola Kruse 2807b09e027eSCarola Kruse /*@ 2808f1580f4eSBarry Smith PCFieldSplitSetGKBNu - Sets the scalar value nu >= 0 in the transformation H = A00 + nu*A01*A01' of the (1,1) block in the Golub-Kahan bidiagonalization preconditioner 2809f1580f4eSBarry Smith in `PCFIELDSPLIT` 2810b09e027eSCarola Kruse 2811c3339decSBarry Smith Collective 2812f1580f4eSBarry Smith 2813f1580f4eSBarry Smith Input Parameters: 2814f1580f4eSBarry Smith + pc - the preconditioner context 2815f1580f4eSBarry Smith - nu - the shift parameter 2816f1580f4eSBarry Smith 281720f4b53cSBarry Smith Options Database Key: 2818f1580f4eSBarry Smith . -pc_fieldsplit_gkb_nu - default is 1 2819f1580f4eSBarry Smith 2820f1580f4eSBarry Smith Level: intermediate 2821b09e027eSCarola Kruse 2822b09e027eSCarola Kruse Notes: 2823da81f932SPierre Jolivet This shift is in general done to obtain better convergence properties for the outer loop of the algorithm. This is often achieved by choosing nu sufficiently big. However, 2824da81f932SPierre Jolivet if nu is chosen too big, the matrix H might be badly conditioned and the solution of the linear system Hx = b in the inner loop becomes difficult. It is therefore 2825b09e027eSCarola Kruse necessary to find a good balance in between the convergence of the inner and outer loop. 2826b09e027eSCarola Kruse 2827b09e027eSCarola Kruse For nu = 0, no shift is done. In this case A00 has to be positive definite. The matrix N in [Ar13] is then chosen as identity. 2828b09e027eSCarola Kruse 282960f59c3bSBarry Smith References: 2830b09e027eSCarola Kruse [Ar13] Generalized Golub-Kahan bidiagonalization and stopping criteria, SIAM J. Matrix Anal. Appl., Vol. 34, No. 2, pp. 571-592, 2013. 2831b09e027eSCarola Kruse 283260f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCFIELDSPLIT`, `PCFieldSplitSetGKBDelay()`, `PCFieldSplitSetGKBTol()`, `PCFieldSplitSetGKBMaxit()` 2833b09e027eSCarola Kruse @*/ 2834d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitSetGKBNu(PC pc, PetscReal nu) 2835d71ae5a4SJacob Faibussowitsch { 2836b09e027eSCarola Kruse PetscFunctionBegin; 2837b09e027eSCarola Kruse PetscValidHeaderSpecific(pc, PC_CLASSID, 1); 2838de482cd7SCarola Kruse PetscValidLogicalCollectiveReal(pc, nu, 2); 2839cac4c232SBarry Smith PetscTryMethod(pc, "PCFieldSplitSetGKBNu_C", (PC, PetscReal), (pc, nu)); 28403ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 2841b09e027eSCarola Kruse } 2842b09e027eSCarola Kruse 2843d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCFieldSplitSetGKBNu_FieldSplit(PC pc, PetscReal nu) 2844d71ae5a4SJacob Faibussowitsch { 2845b09e027eSCarola Kruse PC_FieldSplit *jac = (PC_FieldSplit *)pc->data; 2846b09e027eSCarola Kruse 2847b09e027eSCarola Kruse PetscFunctionBegin; 2848b09e027eSCarola Kruse jac->gkbnu = nu; 28493ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 2850b09e027eSCarola Kruse } 2851b09e027eSCarola Kruse 2852d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCFieldSplitSetType_FieldSplit(PC pc, PCCompositeType type) 2853d71ae5a4SJacob Faibussowitsch { 285479416396SBarry Smith PC_FieldSplit *jac = (PC_FieldSplit *)pc->data; 285579416396SBarry Smith 285679416396SBarry Smith PetscFunctionBegin; 285779416396SBarry Smith jac->type = type; 28582e956fe4SStefano Zampini PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitGetSubKSP_C", NULL)); 28592e956fe4SStefano Zampini PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetSchurPre_C", NULL)); 28602e956fe4SStefano Zampini PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitGetSchurPre_C", NULL)); 28612e956fe4SStefano Zampini PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetSchurFactType_C", NULL)); 28622e956fe4SStefano Zampini PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetSchurScale_C", NULL)); 28632e956fe4SStefano Zampini PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetGKBTol_C", NULL)); 28642e956fe4SStefano Zampini PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetGKBMaxit_C", NULL)); 28652e956fe4SStefano Zampini PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetGKBNu_C", NULL)); 28662e956fe4SStefano Zampini PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetGKBDelay_C", NULL)); 2867e071a0a4SCarola Kruse 28683b224e63SBarry Smith if (type == PC_COMPOSITE_SCHUR) { 28693b224e63SBarry Smith pc->ops->apply = PCApply_FieldSplit_Schur; 28707b665727SPierre Jolivet pc->ops->applytranspose = PCApplyTranspose_FieldSplit_Schur; 28713b224e63SBarry Smith pc->ops->view = PCView_FieldSplit_Schur; 28722fa5cd67SKarl Rupp 28739566063dSJacob Faibussowitsch PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitGetSubKSP_C", PCFieldSplitGetSubKSP_FieldSplit_Schur)); 28749566063dSJacob Faibussowitsch PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetSchurPre_C", PCFieldSplitSetSchurPre_FieldSplit)); 28759566063dSJacob Faibussowitsch PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitGetSchurPre_C", PCFieldSplitGetSchurPre_FieldSplit)); 28769566063dSJacob Faibussowitsch PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetSchurFactType_C", PCFieldSplitSetSchurFactType_FieldSplit)); 28779566063dSJacob Faibussowitsch PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetSchurScale_C", PCFieldSplitSetSchurScale_FieldSplit)); 2878a51937d4SCarola Kruse } else if (type == PC_COMPOSITE_GKB) { 2879a51937d4SCarola Kruse pc->ops->apply = PCApply_FieldSplit_GKB; 2880a51937d4SCarola Kruse pc->ops->view = PCView_FieldSplit_GKB; 2881e69d4d44SBarry Smith 28829566063dSJacob Faibussowitsch PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitGetSubKSP_C", PCFieldSplitGetSubKSP_FieldSplit)); 28839566063dSJacob Faibussowitsch PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetGKBTol_C", PCFieldSplitSetGKBTol_FieldSplit)); 28849566063dSJacob Faibussowitsch PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetGKBMaxit_C", PCFieldSplitSetGKBMaxit_FieldSplit)); 28859566063dSJacob Faibussowitsch PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetGKBNu_C", PCFieldSplitSetGKBNu_FieldSplit)); 28869566063dSJacob Faibussowitsch PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetGKBDelay_C", PCFieldSplitSetGKBDelay_FieldSplit)); 28873b224e63SBarry Smith } else { 28883b224e63SBarry Smith pc->ops->apply = PCApply_FieldSplit; 28893b224e63SBarry Smith pc->ops->view = PCView_FieldSplit; 28902fa5cd67SKarl Rupp 28919566063dSJacob Faibussowitsch PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitGetSubKSP_C", PCFieldSplitGetSubKSP_FieldSplit)); 28923b224e63SBarry Smith } 28933ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 289479416396SBarry Smith } 289579416396SBarry Smith 2896d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCFieldSplitSetBlockSize_FieldSplit(PC pc, PetscInt bs) 2897d71ae5a4SJacob Faibussowitsch { 289851f519a2SBarry Smith PC_FieldSplit *jac = (PC_FieldSplit *)pc->data; 289951f519a2SBarry Smith 290051f519a2SBarry Smith PetscFunctionBegin; 290163a3b9bcSJacob Faibussowitsch PetscCheck(bs >= 1, PetscObjectComm((PetscObject)pc), PETSC_ERR_ARG_OUTOFRANGE, "Blocksize must be positive, you gave %" PetscInt_FMT, bs); 29022472a847SBarry Smith PetscCheck(jac->bs <= 0 || jac->bs == bs, PetscObjectComm((PetscObject)pc), PETSC_ERR_ARG_WRONGSTATE, "Cannot change fieldsplit blocksize from %" PetscInt_FMT " to %" PetscInt_FMT " after it has been set", jac->bs, bs); 290351f519a2SBarry Smith jac->bs = bs; 29043ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 290551f519a2SBarry Smith } 290651f519a2SBarry Smith 2907d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCSetCoordinates_FieldSplit(PC pc, PetscInt dim, PetscInt nloc, PetscReal coords[]) 2908d71ae5a4SJacob Faibussowitsch { 29095ddf11f8SNicolas Barnafi PC_FieldSplit *jac = (PC_FieldSplit *)pc->data; 29105ddf11f8SNicolas Barnafi PC_FieldSplitLink ilink_current = jac->head; 29115ddf11f8SNicolas Barnafi IS is_owned; 29125ddf11f8SNicolas Barnafi 29135ddf11f8SNicolas Barnafi PetscFunctionBegin; 29145ddf11f8SNicolas Barnafi jac->coordinates_set = PETSC_TRUE; // Internal flag 2915f3fa974cSJacob Faibussowitsch PetscCall(MatGetOwnershipIS(pc->mat, &is_owned, NULL)); 29165ddf11f8SNicolas Barnafi 29175ddf11f8SNicolas Barnafi while (ilink_current) { 29185ddf11f8SNicolas Barnafi // For each IS, embed it to get local coords indces 29195ddf11f8SNicolas Barnafi IS is_coords; 29205ddf11f8SNicolas Barnafi PetscInt ndofs_block; 29215ddf11f8SNicolas Barnafi const PetscInt *block_dofs_enumeration; // Numbering of the dofs relevant to the current block 29225ddf11f8SNicolas Barnafi 29235ddf11f8SNicolas Barnafi // Setting drop to true for safety. It should make no difference. 29249566063dSJacob Faibussowitsch PetscCall(ISEmbed(ilink_current->is, is_owned, PETSC_TRUE, &is_coords)); 29259566063dSJacob Faibussowitsch PetscCall(ISGetLocalSize(is_coords, &ndofs_block)); 29269566063dSJacob Faibussowitsch PetscCall(ISGetIndices(is_coords, &block_dofs_enumeration)); 29275ddf11f8SNicolas Barnafi 29285ddf11f8SNicolas Barnafi // Allocate coordinates vector and set it directly 29299566063dSJacob Faibussowitsch PetscCall(PetscMalloc1(ndofs_block * dim, &(ilink_current->coords))); 29305ddf11f8SNicolas Barnafi for (PetscInt dof = 0; dof < ndofs_block; ++dof) { 2931ad540459SPierre Jolivet for (PetscInt d = 0; d < dim; ++d) (ilink_current->coords)[dim * dof + d] = coords[dim * block_dofs_enumeration[dof] + d]; 29325ddf11f8SNicolas Barnafi } 29335ddf11f8SNicolas Barnafi ilink_current->dim = dim; 29345ddf11f8SNicolas Barnafi ilink_current->ndofs = ndofs_block; 29359566063dSJacob Faibussowitsch PetscCall(ISRestoreIndices(is_coords, &block_dofs_enumeration)); 29369566063dSJacob Faibussowitsch PetscCall(ISDestroy(&is_coords)); 29375ddf11f8SNicolas Barnafi ilink_current = ilink_current->next; 29385ddf11f8SNicolas Barnafi } 29399566063dSJacob Faibussowitsch PetscCall(ISDestroy(&is_owned)); 29403ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 29415ddf11f8SNicolas Barnafi } 29425ddf11f8SNicolas Barnafi 2943bc08b0f1SBarry Smith /*@ 2944f1580f4eSBarry Smith PCFieldSplitSetType - Sets the type, `PCCompositeType`, of a `PCFIELDSPLIT` 294579416396SBarry Smith 2946c3339decSBarry Smith Collective 294779416396SBarry Smith 2948d8d19677SJose E. Roman Input Parameters: 2949a2b725a8SWilliam Gropp + pc - the preconditioner context 2950f1580f4eSBarry Smith - type - `PC_COMPOSITE_ADDITIVE`, `PC_COMPOSITE_MULTIPLICATIVE` (default), `PC_COMPOSITE_SYMMETRIC_MULTIPLICATIVE`, `PC_COMPOSITE_SPECIAL`, `PC_COMPOSITE_SCHUR` 295179416396SBarry Smith 295279416396SBarry Smith Options Database Key: 2953a4efd8eaSMatthew Knepley . -pc_fieldsplit_type <type: one of multiplicative, additive, symmetric_multiplicative, special, schur> - Sets fieldsplit preconditioner type 295479416396SBarry Smith 2955feefa0e1SJacob Faibussowitsch Level: intermediate 295679416396SBarry Smith 295760f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCFIELDSPLIT`, `PCCompositeType`, `PCCompositeGetType()`, `PC_COMPOSITE_ADDITIVE`, `PC_COMPOSITE_MULTIPLICATIVE`, 2958f1580f4eSBarry Smith `PC_COMPOSITE_SYMMETRIC_MULTIPLICATIVE`, `PC_COMPOSITE_SPECIAL`, `PC_COMPOSITE_SCHUR` 295979416396SBarry Smith @*/ 2960d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitSetType(PC pc, PCCompositeType type) 2961d71ae5a4SJacob Faibussowitsch { 296279416396SBarry Smith PetscFunctionBegin; 29630700a824SBarry Smith PetscValidHeaderSpecific(pc, PC_CLASSID, 1); 2964cac4c232SBarry Smith PetscTryMethod(pc, "PCFieldSplitSetType_C", (PC, PCCompositeType), (pc, type)); 29653ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 296679416396SBarry Smith } 296779416396SBarry Smith 2968b02e2d75SMatthew G Knepley /*@ 2969f1580f4eSBarry Smith PCFieldSplitGetType - Gets the type, `PCCompositeType`, of a `PCFIELDSPLIT` 2970b02e2d75SMatthew G Knepley 2971b02e2d75SMatthew G Knepley Not collective 2972b02e2d75SMatthew G Knepley 2973b02e2d75SMatthew G Knepley Input Parameter: 2974b02e2d75SMatthew G Knepley . pc - the preconditioner context 2975b02e2d75SMatthew G Knepley 2976b02e2d75SMatthew G Knepley Output Parameter: 2977f1580f4eSBarry Smith . type - `PC_COMPOSITE_ADDITIVE`, `PC_COMPOSITE_MULTIPLICATIVE` (default), `PC_COMPOSITE_SYMMETRIC_MULTIPLICATIVE`, `PC_COMPOSITE_SPECIAL`, `PC_COMPOSITE_SCHUR` 2978b02e2d75SMatthew G Knepley 2979feefa0e1SJacob Faibussowitsch Level: intermediate 2980b02e2d75SMatthew G Knepley 298160f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCCompositeSetType()`, `PCFIELDSPLIT`, `PCCompositeType`, `PC_COMPOSITE_ADDITIVE`, `PC_COMPOSITE_MULTIPLICATIVE`, 2982f1580f4eSBarry Smith `PC_COMPOSITE_SYMMETRIC_MULTIPLICATIVE`, `PC_COMPOSITE_SPECIAL`, `PC_COMPOSITE_SCHUR` 2983b02e2d75SMatthew G Knepley @*/ 2984d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitGetType(PC pc, PCCompositeType *type) 2985d71ae5a4SJacob Faibussowitsch { 2986b02e2d75SMatthew G Knepley PC_FieldSplit *jac = (PC_FieldSplit *)pc->data; 2987b02e2d75SMatthew G Knepley 2988b02e2d75SMatthew G Knepley PetscFunctionBegin; 2989b02e2d75SMatthew G Knepley PetscValidHeaderSpecific(pc, PC_CLASSID, 1); 29904f572ea9SToby Isaac PetscAssertPointer(type, 2); 2991b02e2d75SMatthew G Knepley *type = jac->type; 29923ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 2993b02e2d75SMatthew G Knepley } 2994b02e2d75SMatthew G Knepley 29954ab8060aSDmitry Karpeev /*@ 2996f1580f4eSBarry Smith PCFieldSplitSetDMSplits - Flags whether `DMCreateFieldDecomposition()` should be used to define the splits in a `PCFIELDSPLIT`, whenever possible. 29974ab8060aSDmitry Karpeev 2998c3339decSBarry Smith Logically Collective 29994ab8060aSDmitry Karpeev 30004ab8060aSDmitry Karpeev Input Parameters: 30014ab8060aSDmitry Karpeev + pc - the preconditioner context 3002f1580f4eSBarry Smith - flg - boolean indicating whether to use field splits defined by the `DM` 30034ab8060aSDmitry Karpeev 30044ab8060aSDmitry Karpeev Options Database Key: 3005f1580f4eSBarry Smith . -pc_fieldsplit_dm_splits <bool> - use the field splits defined by the `DM` 30064ab8060aSDmitry Karpeev 3007feefa0e1SJacob Faibussowitsch Level: intermediate 30084ab8060aSDmitry Karpeev 300960f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCFIELDSPLIT`, `PCFieldSplitGetDMSplits()`, `PCFieldSplitSetFields()`, `PCFieldsplitSetIS()` 30104ab8060aSDmitry Karpeev @*/ 3011d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitSetDMSplits(PC pc, PetscBool flg) 3012d71ae5a4SJacob Faibussowitsch { 30134ab8060aSDmitry Karpeev PC_FieldSplit *jac = (PC_FieldSplit *)pc->data; 30144ab8060aSDmitry Karpeev PetscBool isfs; 30154ab8060aSDmitry Karpeev 30164ab8060aSDmitry Karpeev PetscFunctionBegin; 30174ab8060aSDmitry Karpeev PetscValidHeaderSpecific(pc, PC_CLASSID, 1); 30184ab8060aSDmitry Karpeev PetscValidLogicalCollectiveBool(pc, flg, 2); 30199566063dSJacob Faibussowitsch PetscCall(PetscObjectTypeCompare((PetscObject)pc, PCFIELDSPLIT, &isfs)); 3020ad540459SPierre Jolivet if (isfs) jac->dm_splits = flg; 30213ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 30224ab8060aSDmitry Karpeev } 30234ab8060aSDmitry Karpeev 30244ab8060aSDmitry Karpeev /*@ 3025f1580f4eSBarry Smith PCFieldSplitGetDMSplits - Returns flag indicating whether `DMCreateFieldDecomposition()` should be used to define the splits in a `PCFIELDSPLIT`, whenever possible. 30264ab8060aSDmitry Karpeev 30274ab8060aSDmitry Karpeev Logically Collective 30284ab8060aSDmitry Karpeev 30294ab8060aSDmitry Karpeev Input Parameter: 30304ab8060aSDmitry Karpeev . pc - the preconditioner context 30314ab8060aSDmitry Karpeev 30324ab8060aSDmitry Karpeev Output Parameter: 3033f1580f4eSBarry Smith . flg - boolean indicating whether to use field splits defined by the `DM` 30344ab8060aSDmitry Karpeev 3035feefa0e1SJacob Faibussowitsch Level: intermediate 30364ab8060aSDmitry Karpeev 303760f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCFIELDSPLIT`, `PCFieldSplitSetDMSplits()`, `PCFieldSplitSetFields()`, `PCFieldsplitSetIS()` 30384ab8060aSDmitry Karpeev @*/ 3039d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitGetDMSplits(PC pc, PetscBool *flg) 3040d71ae5a4SJacob Faibussowitsch { 30414ab8060aSDmitry Karpeev PC_FieldSplit *jac = (PC_FieldSplit *)pc->data; 30424ab8060aSDmitry Karpeev PetscBool isfs; 30434ab8060aSDmitry Karpeev 30444ab8060aSDmitry Karpeev PetscFunctionBegin; 30454ab8060aSDmitry Karpeev PetscValidHeaderSpecific(pc, PC_CLASSID, 1); 30464f572ea9SToby Isaac PetscAssertPointer(flg, 2); 30479566063dSJacob Faibussowitsch PetscCall(PetscObjectTypeCompare((PetscObject)pc, PCFIELDSPLIT, &isfs)); 30484ab8060aSDmitry Karpeev if (isfs) { 30494ab8060aSDmitry Karpeev if (flg) *flg = jac->dm_splits; 30504ab8060aSDmitry Karpeev } 30513ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 30524ab8060aSDmitry Karpeev } 30534ab8060aSDmitry Karpeev 30547b752e3dSPatrick Sanan /*@ 3055f1580f4eSBarry Smith PCFieldSplitGetDetectSaddlePoint - Returns flag indicating whether `PCFIELDSPLIT` will attempt to automatically determine fields based on zero diagonal entries. 30567b752e3dSPatrick Sanan 30577b752e3dSPatrick Sanan Logically Collective 30587b752e3dSPatrick Sanan 30597b752e3dSPatrick Sanan Input Parameter: 30607b752e3dSPatrick Sanan . pc - the preconditioner context 30617b752e3dSPatrick Sanan 30627b752e3dSPatrick Sanan Output Parameter: 30637b752e3dSPatrick Sanan . flg - boolean indicating whether to detect fields or not 30647b752e3dSPatrick Sanan 3065feefa0e1SJacob Faibussowitsch Level: intermediate 30667b752e3dSPatrick Sanan 306760f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCFIELDSPLIT`, `PCFieldSplitSetDetectSaddlePoint()` 30687b752e3dSPatrick Sanan @*/ 3069d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitGetDetectSaddlePoint(PC pc, PetscBool *flg) 3070d71ae5a4SJacob Faibussowitsch { 30717b752e3dSPatrick Sanan PC_FieldSplit *jac = (PC_FieldSplit *)pc->data; 30727b752e3dSPatrick Sanan 30737b752e3dSPatrick Sanan PetscFunctionBegin; 30747b752e3dSPatrick Sanan *flg = jac->detect; 30753ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 30767b752e3dSPatrick Sanan } 30777b752e3dSPatrick Sanan 30787b752e3dSPatrick Sanan /*@ 3079f1580f4eSBarry Smith PCFieldSplitSetDetectSaddlePoint - Sets flag indicating whether `PCFIELDSPLIT` will attempt to automatically determine fields based on zero diagonal entries. 30807b752e3dSPatrick Sanan 30817b752e3dSPatrick Sanan Logically Collective 30827b752e3dSPatrick Sanan 30837b752e3dSPatrick Sanan Input Parameter: 30847b752e3dSPatrick Sanan . pc - the preconditioner context 30857b752e3dSPatrick Sanan 30867b752e3dSPatrick Sanan Output Parameter: 30877b752e3dSPatrick Sanan . flg - boolean indicating whether to detect fields or not 30887b752e3dSPatrick Sanan 30897b752e3dSPatrick Sanan Options Database Key: 3090147403d9SBarry Smith . -pc_fieldsplit_detect_saddle_point <bool> - detect and use the saddle point 3091147403d9SBarry Smith 3092feefa0e1SJacob Faibussowitsch Level: intermediate 309360f59c3bSBarry Smith 3094f1580f4eSBarry Smith Note: 3095f1580f4eSBarry Smith Also sets the split type to `PC_COMPOSITE_SCHUR` (see `PCFieldSplitSetType()`) and the Schur preconditioner type to `PC_FIELDSPLIT_SCHUR_PRE_SELF` (see `PCFieldSplitSetSchurPre()`). 30967b752e3dSPatrick Sanan 309760f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCFIELDSPLIT`, `PCFieldSplitGetDetectSaddlePoint()`, `PCFieldSplitSetType()`, `PCFieldSplitSetSchurPre()`, `PC_FIELDSPLIT_SCHUR_PRE_SELF` 30987b752e3dSPatrick Sanan @*/ 3099d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitSetDetectSaddlePoint(PC pc, PetscBool flg) 3100d71ae5a4SJacob Faibussowitsch { 31017b752e3dSPatrick Sanan PC_FieldSplit *jac = (PC_FieldSplit *)pc->data; 31027b752e3dSPatrick Sanan 31037b752e3dSPatrick Sanan PetscFunctionBegin; 31047b752e3dSPatrick Sanan jac->detect = flg; 31057b752e3dSPatrick Sanan if (jac->detect) { 31069566063dSJacob Faibussowitsch PetscCall(PCFieldSplitSetType(pc, PC_COMPOSITE_SCHUR)); 31079566063dSJacob Faibussowitsch PetscCall(PCFieldSplitSetSchurPre(pc, PC_FIELDSPLIT_SCHUR_PRE_SELF, NULL)); 31087b752e3dSPatrick Sanan } 31093ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 31107b752e3dSPatrick Sanan } 31117b752e3dSPatrick Sanan 31120971522cSBarry Smith /*MC 3113a8c7a070SBarry Smith PCFIELDSPLIT - Preconditioner created by combining separate preconditioners for individual 3114f1580f4eSBarry Smith collections of variables (that may overlap) called splits. See [the users manual section on "Solving Block Matrices"](sec_block_matrices) for more details. 31150971522cSBarry Smith 311679416396SBarry Smith Options Database Keys: 3117de37d9f1SPatrick Sanan + -pc_fieldsplit_%d_fields <a,b,..> - indicates the fields to be used in the `%d`'th split 311881540f2fSBarry Smith . -pc_fieldsplit_default - automatically add any fields to additional splits that have not 3119de37d9f1SPatrick Sanan been supplied explicitly by `-pc_fieldsplit_%d_fields` 312081540f2fSBarry Smith . -pc_fieldsplit_block_size <bs> - size of block that defines fields (i.e. there are bs fields) 3121a51937d4SCarola Kruse . -pc_fieldsplit_type <additive,multiplicative,symmetric_multiplicative,schur,gkb> - type of relaxation or factorization splitting 3122de37d9f1SPatrick Sanan . -pc_fieldsplit_schur_precondition <self,selfp,user,a11,full> - default is a11; see `PCFieldSplitSetSchurPre()` 3123de37d9f1SPatrick Sanan . -pc_fieldsplit_schur_fact_type <diag,lower,upper,full> - set factorization type when using `-pc_fieldsplit_type schur`; see `PCFieldSplitSetSchurFactType()` 3124fb6809a2SPatrick Sanan - -pc_fieldsplit_detect_saddle_point - automatically finds rows with zero diagonal and uses Schur complement with no preconditioner as the solver 312579416396SBarry Smith 3126de37d9f1SPatrick Sanan Options prefixes for inner solvers when using the Schur complement preconditioner are `-fieldsplit_0_` and `-fieldsplit_1_` . 3127de37d9f1SPatrick Sanan The options prefix for the inner solver when using the Golub-Kahan biadiagonalization preconditioner is `-fieldsplit_0_` 312860f59c3bSBarry Smith For all other solvers they are `-fieldsplit_%d_` for the `%d`'th field; use `-fieldsplit_` for all fields. 312960f59c3bSBarry Smith 313060f59c3bSBarry Smith To set options on the solvers for each block append `-fieldsplit_` to all the `PC` 313160f59c3bSBarry Smith options database keys. For example, `-fieldsplit_pc_type ilu` `-fieldsplit_pc_factor_levels 1` 313260f59c3bSBarry Smith 313360f59c3bSBarry Smith To set the options on the solvers separate for each block call `PCFieldSplitGetSubKSP()` 313460f59c3bSBarry Smith and set the options directly on the resulting `KSP` object 313560f59c3bSBarry Smith 313660f59c3bSBarry Smith Level: intermediate 31375d4c12cdSJungho Lee 3138c8a0d604SMatthew G Knepley Notes: 3139f1580f4eSBarry Smith Use `PCFieldSplitSetFields()` to set splits defined by "strided" entries and `PCFieldSplitSetIS()` 3140f1580f4eSBarry Smith to define a split by an arbitrary collection of entries. 3141d32f9abdSBarry Smith 3142f1580f4eSBarry Smith If no splits are set the default is used. The splits are defined by entries strided by bs, 3143de37d9f1SPatrick Sanan beginning at 0 then 1, etc to bs-1. The block size can be set with `PCFieldSplitSetBlockSize()`, 3144d32f9abdSBarry Smith if this is not called the block size defaults to the blocksize of the second matrix passed 3145de37d9f1SPatrick Sanan to `KSPSetOperators()`/`PCSetOperators()`. 3146d32f9abdSBarry Smith 3147de37d9f1SPatrick Sanan For the Schur complement preconditioner if 31481d71051fSDmitry Karpeev 3149de37d9f1SPatrick Sanan ```{math} 3150de37d9f1SPatrick Sanan J = \left[\begin{array}{cc} A_{00} & A_{01} \\ A_{10} & A_{11} \end{array}\right] 3151de37d9f1SPatrick Sanan ``` 3152e69d4d44SBarry Smith 3153de37d9f1SPatrick Sanan the preconditioner using `full` factorization is logically 3154de37d9f1SPatrick Sanan ```{math} 3155de37d9f1SPatrick Sanan \left[\begin{array}{cc} I & -\text{ksp}(A_{00}) \\ 0 & I \end{array}\right] \left[\begin{array}{cc} \text{inv}(A_{00}) & 0 \\ 0 & \text{ksp}(S) \end{array}\right] \left[\begin{array}{cc} I & 0 \\ -A_{10} \text{ksp}(A_{00}) & I \end{array}\right] 3156de37d9f1SPatrick Sanan ``` 3157de37d9f1SPatrick Sanan where the action of $\text{inv}(A_{00})$ is applied using the KSP solver with prefix `-fieldsplit_0_`. $S$ is the Schur complement 3158de37d9f1SPatrick Sanan ```{math} 3159223e5b4fSPatrick Sanan S = A_{11} - A_{10} \text{ksp}(A_{00}) A_{01} 3160de37d9f1SPatrick Sanan ``` 3161de37d9f1SPatrick Sanan which is usually dense and not stored explicitly. The action of $\text{ksp}(S)$ is computed using the KSP solver with prefix `-fieldsplit_splitname_` (where `splitname` was given 316260f59c3bSBarry Smith in providing the SECOND split or 1 if not given). For `PCFieldSplitGetSubKSP()` when field number is 0, 3163de37d9f1SPatrick Sanan it returns the KSP associated with `-fieldsplit_0_` while field number 1 gives `-fieldsplit_1_` KSP. By default 3164de37d9f1SPatrick Sanan $A_{11}$ is used to construct a preconditioner for $S$, use `PCFieldSplitSetSchurPre()` for all the possible ways to construct the preconditioner for $S$. 3165de37d9f1SPatrick Sanan 3166de37d9f1SPatrick Sanan The factorization type is set using `-pc_fieldsplit_schur_fact_type <diag, lower, upper, full>`. `full` is shown above, 3167de37d9f1SPatrick Sanan `diag` gives 3168de37d9f1SPatrick Sanan ```{math} 3169de37d9f1SPatrick Sanan \left[\begin{array}{cc} \text{inv}(A_{00}) & 0 \\ 0 & -\text{ksp}(S) \end{array}\right] 3170de37d9f1SPatrick Sanan ``` 3171de37d9f1SPatrick Sanan Note that, slightly counter intuitively, there is a negative in front of the $\text{ksp}(S)$ so that the preconditioner is positive definite. For SPD matrices $J$, the sign flip 3172de37d9f1SPatrick Sanan can be turned off with `PCFieldSplitSetSchurScale()` or by command line `-pc_fieldsplit_schur_scale 1.0`. The `lower` factorization is the inverse of 3173de37d9f1SPatrick Sanan ```{math} 3174de37d9f1SPatrick Sanan \left[\begin{array}{cc} A_{00} & 0 \\ A_{10} & S \end{array}\right] 3175de37d9f1SPatrick Sanan ``` 3176de37d9f1SPatrick Sanan where the inverses of A_{00} and S are applied using KSPs. The upper factorization is the inverse of 3177de37d9f1SPatrick Sanan ```{math} 3178de37d9f1SPatrick Sanan \left[\begin{array}{cc} A_{00} & A_{01} \\ 0 & S \end{array}\right] 3179de37d9f1SPatrick Sanan ``` 3180de37d9f1SPatrick Sanan where again the inverses of $A_{00}$ and $S$ are applied using `KSP`s. 3181de37d9f1SPatrick Sanan 3182de37d9f1SPatrick Sanan If only one set of indices (one `IS`) is provided with `PCFieldSplitSetIS()` then the complement of that `IS` 3183edf189efSBarry Smith is used automatically for a second block. 3184edf189efSBarry Smith 3185f1580f4eSBarry Smith The fieldsplit preconditioner cannot currently be used with the `MATBAIJ` or `MATSBAIJ` data formats if the blocksize is larger than 1. 3186f1580f4eSBarry Smith Generally it should be used with the `MATAIJ` format. 3187ff218e97SBarry Smith 3188ff218e97SBarry Smith The forms of these preconditioners are closely related if not identical to forms derived as "Distributive Iterations", see, 3189f1580f4eSBarry Smith for example, page 294 in "Principles of Computational Fluid Dynamics" by Pieter Wesseling {cite}`Wesseling2009`. 3190f1580f4eSBarry Smith One can also use `PCFIELDSPLIT` 3191ff218e97SBarry Smith inside a smoother resulting in "Distributive Smoothers". 31920716a85fSBarry Smith 3193de37d9f1SPatrick Sanan See "A taxonomy and comparison of parallel block multi-level preconditioners for the incompressible Navier-Stokes equations" {cite}`elman2008tcp`. 3194a6a584a2SBarry Smith 3195de37d9f1SPatrick Sanan The Constrained Pressure Preconditioner (CPR) can be implemented using `PCCOMPOSITE` with `PCGALERKIN`. CPR first solves an $R A P$ subsystem, updates the 3196de37d9f1SPatrick Sanan residual on all variables (`PCCompositeSetType(pc,PC_COMPOSITE_MULTIPLICATIVE)`), and then applies a simple ILU like preconditioner on all the variables. 3197a51937d4SCarola Kruse 3198de37d9f1SPatrick Sanan The generalized Golub-Kahan bidiagonalization preconditioner (GKB) can be applied to symmetric $2 \times 2$ block matrices of the shape 3199de37d9f1SPatrick Sanan ```{math} 3200de37d9f1SPatrick Sanan \left[\begin{array}{cc} A_{00} & A_{01} \\ A_{01}' & 0 \end{array}\right] 3201de37d9f1SPatrick Sanan ``` 3202de37d9f1SPatrick Sanan with $A_{00}$ positive semi-definite. The implementation follows {cite}`Arioli2013`. Therein, we choose $N := 1/\nu * I$ and the $(1,1)$-block of the matrix is modified to $H = _{A00} + \nu*A_{01}*A_{01}'$. 3203de37d9f1SPatrick Sanan A linear system $Hx = b$ has to be solved in each iteration of the GKB algorithm. This solver is chosen with the option prefix `-fieldsplit_0_`. 3204a51937d4SCarola Kruse 320560f59c3bSBarry Smith Developer Note: 320660f59c3bSBarry Smith The Schur complement functionality of `PCFIELDSPLIT` should likely be factored into its own `PC` thus simplifying the implementation of the preconditioners and their 320760f59c3bSBarry Smith user API. 3208f1580f4eSBarry Smith 320960f59c3bSBarry Smith References: 3210de37d9f1SPatrick Sanan ```{bibliography} 3211de37d9f1SPatrick Sanan :filter: docname in docnames 3212de37d9f1SPatrick Sanan ``` 3213de37d9f1SPatrick Sanan 321460f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCCreate()`, `PCSetType()`, `PCType`, `PC`, `PCLSC`, 3215db781477SPatrick Sanan `PCFieldSplitGetSubKSP()`, `PCFieldSplitSchurGetSubKSP()`, `PCFieldSplitSetFields()`, 3216db781477SPatrick Sanan `PCFieldSplitSetType()`, `PCFieldSplitSetIS()`, `PCFieldSplitSetSchurPre()`, `PCFieldSplitSetSchurFactType()`, 3217db781477SPatrick Sanan `MatSchurComplementSetAinvType()`, `PCFieldSplitSetSchurScale()`, `PCFieldSplitSetDetectSaddlePoint()` 32180971522cSBarry Smith M*/ 32190971522cSBarry Smith 3220d71ae5a4SJacob Faibussowitsch PETSC_EXTERN PetscErrorCode PCCreate_FieldSplit(PC pc) 3221d71ae5a4SJacob Faibussowitsch { 32220971522cSBarry Smith PC_FieldSplit *jac; 32230971522cSBarry Smith 32240971522cSBarry Smith PetscFunctionBegin; 32254dfa11a4SJacob Faibussowitsch PetscCall(PetscNew(&jac)); 32262fa5cd67SKarl Rupp 32270971522cSBarry Smith jac->bs = -1; 32280971522cSBarry Smith jac->nsplits = 0; 32293e197d65SBarry Smith jac->type = PC_COMPOSITE_MULTIPLICATIVE; 3230e6cab6aaSJed Brown jac->schurpre = PC_FIELDSPLIT_SCHUR_PRE_USER; /* Try user preconditioner first, fall back on diagonal */ 3231c9c6ffaaSJed Brown jac->schurfactorization = PC_FIELDSPLIT_SCHUR_FACT_FULL; 3232c096484dSStefano Zampini jac->schurscale = -1.0; 3233fbe7908bSJed Brown jac->dm_splits = PETSC_TRUE; 32347b752e3dSPatrick Sanan jac->detect = PETSC_FALSE; 3235a51937d4SCarola Kruse jac->gkbtol = 1e-5; 3236a51937d4SCarola Kruse jac->gkbdelay = 5; 3237a51937d4SCarola Kruse jac->gkbnu = 1; 3238a51937d4SCarola Kruse jac->gkbmaxit = 100; 3239de482cd7SCarola Kruse jac->gkbmonitor = PETSC_FALSE; 32405ddf11f8SNicolas Barnafi jac->coordinates_set = PETSC_FALSE; 324151f519a2SBarry Smith 32420971522cSBarry Smith pc->data = (void *)jac; 32430971522cSBarry Smith 32440971522cSBarry Smith pc->ops->apply = PCApply_FieldSplit; 3245421e10b8SBarry Smith pc->ops->applytranspose = PCApplyTranspose_FieldSplit; 32460971522cSBarry Smith pc->ops->setup = PCSetUp_FieldSplit; 3247574deadeSBarry Smith pc->ops->reset = PCReset_FieldSplit; 32480971522cSBarry Smith pc->ops->destroy = PCDestroy_FieldSplit; 32490971522cSBarry Smith pc->ops->setfromoptions = PCSetFromOptions_FieldSplit; 32500971522cSBarry Smith pc->ops->view = PCView_FieldSplit; 32510a545947SLisandro Dalcin pc->ops->applyrichardson = NULL; 32520971522cSBarry Smith 32539566063dSJacob Faibussowitsch PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSchurGetSubKSP_C", PCFieldSplitSchurGetSubKSP_FieldSplit)); 32549566063dSJacob Faibussowitsch PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitGetSubKSP_C", PCFieldSplitGetSubKSP_FieldSplit)); 32559566063dSJacob Faibussowitsch PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetFields_C", PCFieldSplitSetFields_FieldSplit)); 32569566063dSJacob Faibussowitsch PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetIS_C", PCFieldSplitSetIS_FieldSplit)); 32579566063dSJacob Faibussowitsch PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetType_C", PCFieldSplitSetType_FieldSplit)); 32589566063dSJacob Faibussowitsch PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetBlockSize_C", PCFieldSplitSetBlockSize_FieldSplit)); 32599566063dSJacob Faibussowitsch PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitRestrictIS_C", PCFieldSplitRestrictIS_FieldSplit)); 32609566063dSJacob Faibussowitsch PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCSetCoordinates_C", PCSetCoordinates_FieldSplit)); 32613ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 32620971522cSBarry Smith } 3263