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)); 9459566063dSJacob Faibussowitsch PetscCall(KSPSetErrorIfNotConverged(jac->kspupper, pc->erroriffailure)); 9469566063dSJacob Faibussowitsch PetscCall(KSPSetOptionsPrefix(jac->kspupper, schurprefix)); 9479566063dSJacob Faibussowitsch PetscCall(PetscObjectIncrementTabLevel((PetscObject)jac->kspupper, (PetscObject)pc, 1)); 9489566063dSJacob Faibussowitsch PetscCall(PetscObjectIncrementTabLevel((PetscObject)jac->kspupper->pc, (PetscObject)pc, 1)); 9499566063dSJacob Faibussowitsch PetscCall(KSPGetDM(jac->head->ksp, &dmInner)); 9509566063dSJacob Faibussowitsch PetscCall(KSPSetDM(jac->kspupper, dmInner)); 9519566063dSJacob Faibussowitsch PetscCall(KSPSetDMActive(jac->kspupper, PETSC_FALSE)); 9529566063dSJacob Faibussowitsch PetscCall(KSPSetFromOptions(jac->kspupper)); 9539566063dSJacob Faibussowitsch PetscCall(KSPSetOperators(jac->kspupper, jac->mat[0], jac->pmat[0])); 9549566063dSJacob Faibussowitsch PetscCall(VecDuplicate(jac->head->x, &jac->head->z)); 955443836d0SMatthew G Knepley } else { 956443836d0SMatthew G Knepley jac->kspupper = jac->head->ksp; 9579566063dSJacob Faibussowitsch PetscCall(PetscObjectReference((PetscObject)jac->head->ksp)); 958443836d0SMatthew G Knepley } 959443836d0SMatthew G Knepley 96048a46eb9SPierre Jolivet if (jac->schurpre == PC_FIELDSPLIT_SCHUR_PRE_SELFP) PetscCall(MatSchurComplementGetPmat(jac->schur, MAT_INITIAL_MATRIX, &jac->schurp)); 9619566063dSJacob Faibussowitsch PetscCall(KSPCreate(PetscObjectComm((PetscObject)pc), &jac->kspschur)); 9629566063dSJacob Faibussowitsch PetscCall(KSPSetErrorIfNotConverged(jac->kspschur, pc->erroriffailure)); 9639566063dSJacob Faibussowitsch PetscCall(PetscObjectIncrementTabLevel((PetscObject)jac->kspschur, (PetscObject)pc, 1)); 964084e4875SJed Brown if (jac->schurpre == PC_FIELDSPLIT_SCHUR_PRE_SELF) { 9657233a360SDmitry Karpeev PC pcschur; 9669566063dSJacob Faibussowitsch PetscCall(KSPGetPC(jac->kspschur, &pcschur)); 9679566063dSJacob Faibussowitsch PetscCall(PCSetType(pcschur, PCNONE)); 968084e4875SJed Brown /* Note: This is bad if there exist preconditioners for MATSCHURCOMPLEMENT */ 969e74569cdSMatthew G. Knepley } else if (jac->schurpre == PC_FIELDSPLIT_SCHUR_PRE_FULL) { 9709566063dSJacob Faibussowitsch PetscCall(MatSchurComplementComputeExplicitOperator(jac->schur, &jac->schur_user)); 971e69d4d44SBarry Smith } 9729566063dSJacob Faibussowitsch PetscCall(KSPSetOperators(jac->kspschur, jac->schur, FieldSplitSchurPre(jac))); 9739566063dSJacob Faibussowitsch PetscCall(KSPGetOptionsPrefix(jac->head->next->ksp, &Dprefix)); 9749566063dSJacob Faibussowitsch PetscCall(KSPSetOptionsPrefix(jac->kspschur, Dprefix)); 975c096484dSStefano Zampini /* propagate DM */ 976b20b4189SMatthew G. Knepley { 977b20b4189SMatthew G. Knepley DM sdm; 9789566063dSJacob Faibussowitsch PetscCall(KSPGetDM(jac->head->next->ksp, &sdm)); 979b20b4189SMatthew G. Knepley if (sdm) { 9809566063dSJacob Faibussowitsch PetscCall(KSPSetDM(jac->kspschur, sdm)); 9819566063dSJacob Faibussowitsch PetscCall(KSPSetDMActive(jac->kspschur, PETSC_FALSE)); 982b20b4189SMatthew G. Knepley } 983b20b4189SMatthew G. Knepley } 9843b224e63SBarry Smith /* really want setfromoptions called in PCSetFromOptions_FieldSplit(), but it is not ready yet */ 98520b26d62SBarry Smith /* need to call this every time, since the jac->kspschur is freshly created, otherwise its options never get set */ 9869566063dSJacob Faibussowitsch PetscCall(KSPSetFromOptions(jac->kspschur)); 9873b224e63SBarry Smith } 9889566063dSJacob Faibussowitsch PetscCall(MatAssemblyBegin(jac->schur, MAT_FINAL_ASSEMBLY)); 9899566063dSJacob Faibussowitsch PetscCall(MatAssemblyEnd(jac->schur, MAT_FINAL_ASSEMBLY)); 990093c86ffSJed Brown 991093c86ffSJed Brown /* HACK: special support to forward L and Lp matrices that might be used by PCLSC */ 9929566063dSJacob Faibussowitsch PetscCall(PetscSNPrintf(lscname, sizeof(lscname), "%s_LSC_L", ilink->splitname)); 9939566063dSJacob Faibussowitsch PetscCall(PetscObjectQuery((PetscObject)pc->mat, lscname, (PetscObject *)&LSC_L)); 9949566063dSJacob Faibussowitsch if (!LSC_L) PetscCall(PetscObjectQuery((PetscObject)pc->pmat, lscname, (PetscObject *)&LSC_L)); 9959566063dSJacob Faibussowitsch if (LSC_L) PetscCall(PetscObjectCompose((PetscObject)jac->schur, "LSC_L", (PetscObject)LSC_L)); 9969566063dSJacob Faibussowitsch PetscCall(PetscSNPrintf(lscname, sizeof(lscname), "%s_LSC_Lp", ilink->splitname)); 9979566063dSJacob Faibussowitsch PetscCall(PetscObjectQuery((PetscObject)pc->pmat, lscname, (PetscObject *)&LSC_L)); 9989566063dSJacob Faibussowitsch if (!LSC_L) PetscCall(PetscObjectQuery((PetscObject)pc->mat, lscname, (PetscObject *)&LSC_L)); 9999566063dSJacob Faibussowitsch if (LSC_L) PetscCall(PetscObjectCompose((PetscObject)jac->schur, "LSC_Lp", (PetscObject)LSC_L)); 1000a51937d4SCarola Kruse } else if (jac->type == PC_COMPOSITE_GKB) { 1001a51937d4SCarola Kruse IS ccis; 1002a51937d4SCarola Kruse PetscInt rstart, rend; 1003a51937d4SCarola Kruse 100408401ef6SPierre Jolivet PetscCheck(nsplit == 2, PetscObjectComm((PetscObject)pc), PETSC_ERR_ARG_INCOMP, "To use GKB preconditioner you must have exactly 2 fields"); 1005a51937d4SCarola Kruse 1006a51937d4SCarola Kruse ilink = jac->head; 1007a51937d4SCarola Kruse 1008a51937d4SCarola Kruse /* When extracting off-diagonal submatrices, we take complements from this range */ 10099566063dSJacob Faibussowitsch PetscCall(MatGetOwnershipRangeColumn(pc->mat, &rstart, &rend)); 1010a51937d4SCarola Kruse 10119566063dSJacob Faibussowitsch PetscCall(ISComplement(ilink->is_col, rstart, rend, &ccis)); 1012a51937d4SCarola Kruse if (jac->offdiag_use_amat) { 10139566063dSJacob Faibussowitsch PetscCall(MatCreateSubMatrix(pc->mat, ilink->is, ccis, MAT_INITIAL_MATRIX, &jac->B)); 1014a51937d4SCarola Kruse } else { 10159566063dSJacob Faibussowitsch PetscCall(MatCreateSubMatrix(pc->pmat, ilink->is, ccis, MAT_INITIAL_MATRIX, &jac->B)); 1016a51937d4SCarola Kruse } 10179566063dSJacob Faibussowitsch PetscCall(ISDestroy(&ccis)); 1018e071a0a4SCarola Kruse /* Create work vectors for GKB algorithm */ 10199566063dSJacob Faibussowitsch PetscCall(VecDuplicate(ilink->x, &jac->u)); 10209566063dSJacob Faibussowitsch PetscCall(VecDuplicate(ilink->x, &jac->Hu)); 10219566063dSJacob Faibussowitsch PetscCall(VecDuplicate(ilink->x, &jac->w2)); 1022a51937d4SCarola Kruse ilink = ilink->next; 10239566063dSJacob Faibussowitsch PetscCall(ISComplement(ilink->is_col, rstart, rend, &ccis)); 1024a51937d4SCarola Kruse if (jac->offdiag_use_amat) { 10259566063dSJacob Faibussowitsch PetscCall(MatCreateSubMatrix(pc->mat, ilink->is, ccis, MAT_INITIAL_MATRIX, &jac->C)); 1026a51937d4SCarola Kruse } else { 10279566063dSJacob Faibussowitsch PetscCall(MatCreateSubMatrix(pc->pmat, ilink->is, ccis, MAT_INITIAL_MATRIX, &jac->C)); 1028a51937d4SCarola Kruse } 10299566063dSJacob Faibussowitsch PetscCall(ISDestroy(&ccis)); 1030e071a0a4SCarola Kruse /* Create work vectors for GKB algorithm */ 10319566063dSJacob Faibussowitsch PetscCall(VecDuplicate(ilink->x, &jac->v)); 10329566063dSJacob Faibussowitsch PetscCall(VecDuplicate(ilink->x, &jac->d)); 10339566063dSJacob Faibussowitsch PetscCall(VecDuplicate(ilink->x, &jac->w1)); 10349566063dSJacob Faibussowitsch PetscCall(MatGolubKahanComputeExplicitOperator(jac->mat[0], jac->B, jac->C, &jac->H, jac->gkbnu)); 10359566063dSJacob Faibussowitsch PetscCall(PetscCalloc1(jac->gkbdelay, &jac->vecz)); 1036e071a0a4SCarola Kruse 1037a51937d4SCarola Kruse ilink = jac->head; 10389566063dSJacob Faibussowitsch PetscCall(KSPSetOperators(ilink->ksp, jac->H, jac->H)); 10399566063dSJacob Faibussowitsch if (!jac->suboptionsset) PetscCall(KSPSetFromOptions(ilink->ksp)); 1040e071a0a4SCarola Kruse /* Create gkb_monitor context */ 1041de482cd7SCarola Kruse if (jac->gkbmonitor) { 1042de482cd7SCarola Kruse PetscInt tablevel; 10439566063dSJacob Faibussowitsch PetscCall(PetscViewerCreate(PETSC_COMM_WORLD, &jac->gkbviewer)); 10449566063dSJacob Faibussowitsch PetscCall(PetscViewerSetType(jac->gkbviewer, PETSCVIEWERASCII)); 10459566063dSJacob Faibussowitsch PetscCall(PetscObjectGetTabLevel((PetscObject)ilink->ksp, &tablevel)); 10469566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIISetTab(jac->gkbviewer, tablevel)); 10479566063dSJacob Faibussowitsch PetscCall(PetscObjectIncrementTabLevel((PetscObject)ilink->ksp, (PetscObject)ilink->ksp, 1)); 1048de482cd7SCarola Kruse } 10493b224e63SBarry Smith } else { 105068bd789dSDmitry Karpeev /* set up the individual splits' PCs */ 105197bbdb24SBarry Smith i = 0; 10525a9f2f41SSatish Balay ilink = jac->head; 10535a9f2f41SSatish Balay while (ilink) { 10549566063dSJacob Faibussowitsch PetscCall(KSPSetOperators(ilink->ksp, jac->mat[i], jac->pmat[i])); 10553b224e63SBarry Smith /* really want setfromoptions called in PCSetFromOptions_FieldSplit(), but it is not ready yet */ 10569566063dSJacob Faibussowitsch if (!jac->suboptionsset) PetscCall(KSPSetFromOptions(ilink->ksp)); 105797bbdb24SBarry Smith i++; 10585a9f2f41SSatish Balay ilink = ilink->next; 10590971522cSBarry Smith } 10603b224e63SBarry Smith } 10613b224e63SBarry Smith 10625ddf11f8SNicolas Barnafi /* Set coordinates to the sub PC objects whenever these are set */ 10635ddf11f8SNicolas Barnafi if (jac->coordinates_set) { 10645ddf11f8SNicolas Barnafi PC pc_coords; 10655ddf11f8SNicolas Barnafi if (jac->type == PC_COMPOSITE_SCHUR) { 10665ddf11f8SNicolas Barnafi // Head is first block. 10679566063dSJacob Faibussowitsch PetscCall(KSPGetPC(jac->head->ksp, &pc_coords)); 10689566063dSJacob Faibussowitsch PetscCall(PCSetCoordinates(pc_coords, jac->head->dim, jac->head->ndofs, jac->head->coords)); 10695ddf11f8SNicolas Barnafi // Second one is Schur block, but its KSP object is in kspschur. 10709566063dSJacob Faibussowitsch PetscCall(KSPGetPC(jac->kspschur, &pc_coords)); 10719566063dSJacob Faibussowitsch PetscCall(PCSetCoordinates(pc_coords, jac->head->next->dim, jac->head->next->ndofs, jac->head->next->coords)); 10725ddf11f8SNicolas Barnafi } else if (jac->type == PC_COMPOSITE_GKB) { 10739566063dSJacob Faibussowitsch PetscCall(PetscInfo(pc, "Warning: Setting coordinates does nothing for the GKB Fieldpslit preconditioner")); 10745ddf11f8SNicolas Barnafi } else { 10755ddf11f8SNicolas Barnafi ilink = jac->head; 10765ddf11f8SNicolas Barnafi while (ilink) { 10779566063dSJacob Faibussowitsch PetscCall(KSPGetPC(ilink->ksp, &pc_coords)); 10789566063dSJacob Faibussowitsch PetscCall(PCSetCoordinates(pc_coords, ilink->dim, ilink->ndofs, ilink->coords)); 10795ddf11f8SNicolas Barnafi ilink = ilink->next; 10805ddf11f8SNicolas Barnafi } 10815ddf11f8SNicolas Barnafi } 10825ddf11f8SNicolas Barnafi } 10835ddf11f8SNicolas Barnafi 1084c1570756SJed Brown jac->suboptionsset = PETSC_TRUE; 10853ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 10860971522cSBarry Smith } 10870971522cSBarry Smith 10885a9f2f41SSatish Balay #define FieldSplitSplitSolveAdd(ilink, xx, yy) \ 10893ba16761SJacob 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) || \ 10909371c9d4SSatish 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) || \ 10913ba16761SJacob Faibussowitsch VecScatterEnd(ilink->sctx, ilink->y, yy, ADD_VALUES, SCATTER_REVERSE))) 109279416396SBarry Smith 1093d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCApply_FieldSplit_Schur(PC pc, Vec x, Vec y) 1094d71ae5a4SJacob Faibussowitsch { 10953b224e63SBarry Smith PC_FieldSplit *jac = (PC_FieldSplit *)pc->data; 10963b224e63SBarry Smith PC_FieldSplitLink ilinkA = jac->head, ilinkD = ilinkA->next; 1097443836d0SMatthew G Knepley KSP kspA = ilinkA->ksp, kspLower = kspA, kspUpper = jac->kspupper; 10983b224e63SBarry Smith 10993b224e63SBarry Smith PetscFunctionBegin; 1100c5d2311dSJed Brown switch (jac->schurfactorization) { 1101c9c6ffaaSJed Brown case PC_FIELDSPLIT_SCHUR_FACT_DIAG: 1102a04f6461SBarry Smith /* [A00 0; 0 -S], positive definite, suitable for MINRES */ 11039566063dSJacob Faibussowitsch PetscCall(VecScatterBegin(ilinkA->sctx, x, ilinkA->x, INSERT_VALUES, SCATTER_FORWARD)); 11049566063dSJacob Faibussowitsch PetscCall(VecScatterBegin(ilinkD->sctx, x, ilinkD->x, INSERT_VALUES, SCATTER_FORWARD)); 11059566063dSJacob Faibussowitsch PetscCall(VecScatterEnd(ilinkA->sctx, x, ilinkA->x, INSERT_VALUES, SCATTER_FORWARD)); 11069566063dSJacob Faibussowitsch PetscCall(PetscLogEventBegin(ilinkA->event, kspA, ilinkA->x, ilinkA->y, NULL)); 11079566063dSJacob Faibussowitsch PetscCall(KSPSolve(kspA, ilinkA->x, ilinkA->y)); 11089566063dSJacob Faibussowitsch PetscCall(KSPCheckSolve(kspA, pc, ilinkA->y)); 11099566063dSJacob Faibussowitsch PetscCall(PetscLogEventEnd(ilinkA->event, kspA, ilinkA->x, ilinkA->y, NULL)); 11109566063dSJacob Faibussowitsch PetscCall(VecScatterBegin(ilinkA->sctx, ilinkA->y, y, INSERT_VALUES, SCATTER_REVERSE)); 11119566063dSJacob Faibussowitsch PetscCall(VecScatterEnd(ilinkD->sctx, x, ilinkD->x, INSERT_VALUES, SCATTER_FORWARD)); 11129566063dSJacob Faibussowitsch PetscCall(PetscLogEventBegin(KSP_Solve_FS_S, jac->kspschur, ilinkD->x, ilinkD->y, NULL)); 11139566063dSJacob Faibussowitsch PetscCall(KSPSolve(jac->kspschur, ilinkD->x, ilinkD->y)); 11149566063dSJacob Faibussowitsch PetscCall(KSPCheckSolve(jac->kspschur, pc, ilinkD->y)); 11159566063dSJacob Faibussowitsch PetscCall(PetscLogEventEnd(KSP_Solve_FS_S, jac->kspschur, ilinkD->x, ilinkD->y, NULL)); 11169566063dSJacob Faibussowitsch PetscCall(VecScale(ilinkD->y, jac->schurscale)); 11179566063dSJacob Faibussowitsch PetscCall(VecScatterEnd(ilinkA->sctx, ilinkA->y, y, INSERT_VALUES, SCATTER_REVERSE)); 11189566063dSJacob Faibussowitsch PetscCall(VecScatterBegin(ilinkD->sctx, ilinkD->y, y, INSERT_VALUES, SCATTER_REVERSE)); 11199566063dSJacob Faibussowitsch PetscCall(VecScatterEnd(ilinkD->sctx, ilinkD->y, y, INSERT_VALUES, SCATTER_REVERSE)); 1120c5d2311dSJed Brown break; 1121c9c6ffaaSJed Brown case PC_FIELDSPLIT_SCHUR_FACT_LOWER: 1122a04f6461SBarry Smith /* [A00 0; A10 S], suitable for left preconditioning */ 11239566063dSJacob Faibussowitsch PetscCall(VecScatterBegin(ilinkA->sctx, x, ilinkA->x, INSERT_VALUES, SCATTER_FORWARD)); 11249566063dSJacob Faibussowitsch PetscCall(VecScatterEnd(ilinkA->sctx, x, ilinkA->x, INSERT_VALUES, SCATTER_FORWARD)); 11259566063dSJacob Faibussowitsch PetscCall(PetscLogEventBegin(ilinkA->event, kspA, ilinkA->x, ilinkA->y, NULL)); 11269566063dSJacob Faibussowitsch PetscCall(KSPSolve(kspA, ilinkA->x, ilinkA->y)); 11279566063dSJacob Faibussowitsch PetscCall(KSPCheckSolve(kspA, pc, ilinkA->y)); 11289566063dSJacob Faibussowitsch PetscCall(PetscLogEventEnd(ilinkA->event, kspA, ilinkA->x, ilinkA->y, NULL)); 11299566063dSJacob Faibussowitsch PetscCall(MatMult(jac->C, ilinkA->y, ilinkD->x)); 11309566063dSJacob Faibussowitsch PetscCall(VecScale(ilinkD->x, -1.)); 11319566063dSJacob Faibussowitsch PetscCall(VecScatterBegin(ilinkD->sctx, x, ilinkD->x, ADD_VALUES, SCATTER_FORWARD)); 11329566063dSJacob Faibussowitsch PetscCall(VecScatterBegin(ilinkA->sctx, ilinkA->y, y, INSERT_VALUES, SCATTER_REVERSE)); 11339566063dSJacob Faibussowitsch PetscCall(VecScatterEnd(ilinkD->sctx, x, ilinkD->x, ADD_VALUES, SCATTER_FORWARD)); 11349566063dSJacob Faibussowitsch PetscCall(PetscLogEventBegin(KSP_Solve_FS_S, jac->kspschur, ilinkD->x, ilinkD->y, NULL)); 11359566063dSJacob Faibussowitsch PetscCall(KSPSolve(jac->kspschur, ilinkD->x, ilinkD->y)); 11369566063dSJacob Faibussowitsch PetscCall(KSPCheckSolve(jac->kspschur, pc, ilinkD->y)); 11379566063dSJacob Faibussowitsch PetscCall(PetscLogEventEnd(KSP_Solve_FS_S, jac->kspschur, ilinkD->x, ilinkD->y, NULL)); 11389566063dSJacob Faibussowitsch PetscCall(VecScatterEnd(ilinkA->sctx, ilinkA->y, y, INSERT_VALUES, SCATTER_REVERSE)); 11399566063dSJacob Faibussowitsch PetscCall(VecScatterBegin(ilinkD->sctx, ilinkD->y, y, INSERT_VALUES, SCATTER_REVERSE)); 11409566063dSJacob Faibussowitsch PetscCall(VecScatterEnd(ilinkD->sctx, ilinkD->y, y, INSERT_VALUES, SCATTER_REVERSE)); 1141c5d2311dSJed Brown break; 1142c9c6ffaaSJed Brown case PC_FIELDSPLIT_SCHUR_FACT_UPPER: 1143a04f6461SBarry Smith /* [A00 A01; 0 S], suitable for right preconditioning */ 11449566063dSJacob Faibussowitsch PetscCall(VecScatterBegin(ilinkD->sctx, x, ilinkD->x, INSERT_VALUES, SCATTER_FORWARD)); 11459566063dSJacob Faibussowitsch PetscCall(VecScatterEnd(ilinkD->sctx, x, ilinkD->x, INSERT_VALUES, SCATTER_FORWARD)); 11469566063dSJacob Faibussowitsch PetscCall(PetscLogEventBegin(KSP_Solve_FS_S, jac->kspschur, ilinkD->x, ilinkD->y, NULL)); 11479566063dSJacob Faibussowitsch PetscCall(KSPSolve(jac->kspschur, ilinkD->x, ilinkD->y)); 11489566063dSJacob Faibussowitsch PetscCall(KSPCheckSolve(jac->kspschur, pc, ilinkD->y)); 11499371c9d4SSatish Balay PetscCall(PetscLogEventEnd(KSP_Solve_FS_S, jac->kspschur, ilinkD->x, ilinkD->y, NULL)); 11509371c9d4SSatish Balay PetscCall(MatMult(jac->B, ilinkD->y, ilinkA->x)); 11519566063dSJacob Faibussowitsch PetscCall(VecScale(ilinkA->x, -1.)); 11529566063dSJacob Faibussowitsch PetscCall(VecScatterBegin(ilinkA->sctx, x, ilinkA->x, ADD_VALUES, SCATTER_FORWARD)); 11539566063dSJacob Faibussowitsch PetscCall(VecScatterBegin(ilinkD->sctx, ilinkD->y, y, INSERT_VALUES, SCATTER_REVERSE)); 11549566063dSJacob Faibussowitsch PetscCall(VecScatterEnd(ilinkA->sctx, x, ilinkA->x, ADD_VALUES, SCATTER_FORWARD)); 11559566063dSJacob Faibussowitsch PetscCall(PetscLogEventBegin(ilinkA->event, kspA, ilinkA->x, ilinkA->y, NULL)); 11569566063dSJacob Faibussowitsch PetscCall(KSPSolve(kspA, ilinkA->x, ilinkA->y)); 11579566063dSJacob Faibussowitsch PetscCall(KSPCheckSolve(kspA, pc, ilinkA->y)); 11589566063dSJacob Faibussowitsch PetscCall(PetscLogEventEnd(ilinkA->event, kspA, ilinkA->x, ilinkA->y, NULL)); 11599566063dSJacob Faibussowitsch PetscCall(VecScatterEnd(ilinkD->sctx, ilinkD->y, y, INSERT_VALUES, SCATTER_REVERSE)); 11609566063dSJacob Faibussowitsch PetscCall(VecScatterBegin(ilinkA->sctx, ilinkA->y, y, INSERT_VALUES, SCATTER_REVERSE)); 11619566063dSJacob Faibussowitsch PetscCall(VecScatterEnd(ilinkA->sctx, ilinkA->y, y, INSERT_VALUES, SCATTER_REVERSE)); 1162c5d2311dSJed Brown break; 1163c9c6ffaaSJed Brown case PC_FIELDSPLIT_SCHUR_FACT_FULL: 1164c238f8cdSStefano Zampini /* [1 0; A10 A00^{-1} 1] [A00 0; 0 S] [1 A00^{-1}A01; 0 1] */ 11659566063dSJacob Faibussowitsch PetscCall(VecScatterBegin(ilinkA->sctx, x, ilinkA->x, INSERT_VALUES, SCATTER_FORWARD)); 11669566063dSJacob Faibussowitsch PetscCall(VecScatterEnd(ilinkA->sctx, x, ilinkA->x, INSERT_VALUES, SCATTER_FORWARD)); 11679566063dSJacob Faibussowitsch PetscCall(PetscLogEventBegin(KSP_Solve_FS_L, kspLower, ilinkA->x, ilinkA->y, NULL)); 11689566063dSJacob Faibussowitsch PetscCall(KSPSolve(kspLower, ilinkA->x, ilinkA->y)); 11699566063dSJacob Faibussowitsch PetscCall(KSPCheckSolve(kspLower, pc, ilinkA->y)); 11709566063dSJacob Faibussowitsch PetscCall(PetscLogEventEnd(KSP_Solve_FS_L, kspLower, ilinkA->x, ilinkA->y, NULL)); 11719566063dSJacob Faibussowitsch PetscCall(MatMult(jac->C, ilinkA->y, ilinkD->x)); 11729566063dSJacob Faibussowitsch PetscCall(VecScale(ilinkD->x, -1.0)); 11739566063dSJacob Faibussowitsch PetscCall(VecScatterBegin(ilinkD->sctx, x, ilinkD->x, ADD_VALUES, SCATTER_FORWARD)); 11749566063dSJacob Faibussowitsch PetscCall(VecScatterEnd(ilinkD->sctx, x, ilinkD->x, ADD_VALUES, SCATTER_FORWARD)); 11753b224e63SBarry Smith 11769566063dSJacob Faibussowitsch PetscCall(PetscLogEventBegin(KSP_Solve_FS_S, jac->kspschur, ilinkD->x, ilinkD->y, NULL)); 11779566063dSJacob Faibussowitsch PetscCall(KSPSolve(jac->kspschur, ilinkD->x, ilinkD->y)); 11789566063dSJacob Faibussowitsch PetscCall(KSPCheckSolve(jac->kspschur, pc, ilinkD->y)); 11799566063dSJacob Faibussowitsch PetscCall(PetscLogEventEnd(KSP_Solve_FS_S, jac->kspschur, ilinkD->x, ilinkD->y, NULL)); 11809566063dSJacob Faibussowitsch PetscCall(VecScatterBegin(ilinkD->sctx, ilinkD->y, y, INSERT_VALUES, SCATTER_REVERSE)); 11813b224e63SBarry Smith 1182443836d0SMatthew G Knepley if (kspUpper == kspA) { 11839566063dSJacob Faibussowitsch PetscCall(MatMult(jac->B, ilinkD->y, ilinkA->y)); 11849566063dSJacob Faibussowitsch PetscCall(VecAXPY(ilinkA->x, -1.0, ilinkA->y)); 11859566063dSJacob Faibussowitsch PetscCall(PetscLogEventBegin(ilinkA->event, kspA, ilinkA->x, ilinkA->y, NULL)); 11869566063dSJacob Faibussowitsch PetscCall(KSPSolve(kspA, ilinkA->x, ilinkA->y)); 11879566063dSJacob Faibussowitsch PetscCall(KSPCheckSolve(kspA, pc, ilinkA->y)); 11889566063dSJacob Faibussowitsch PetscCall(PetscLogEventEnd(ilinkA->event, kspA, ilinkA->x, ilinkA->y, NULL)); 1189443836d0SMatthew G Knepley } else { 11909566063dSJacob Faibussowitsch PetscCall(PetscLogEventBegin(ilinkA->event, kspA, ilinkA->x, ilinkA->y, NULL)); 11919566063dSJacob Faibussowitsch PetscCall(KSPSolve(kspA, ilinkA->x, ilinkA->y)); 11929566063dSJacob Faibussowitsch PetscCall(KSPCheckSolve(kspA, pc, ilinkA->y)); 11939566063dSJacob Faibussowitsch PetscCall(MatMult(jac->B, ilinkD->y, ilinkA->x)); 11949566063dSJacob Faibussowitsch PetscCall(PetscLogEventBegin(KSP_Solve_FS_U, kspUpper, ilinkA->x, ilinkA->z, NULL)); 11959566063dSJacob Faibussowitsch PetscCall(KSPSolve(kspUpper, ilinkA->x, ilinkA->z)); 11969566063dSJacob Faibussowitsch PetscCall(KSPCheckSolve(kspUpper, pc, ilinkA->z)); 11979566063dSJacob Faibussowitsch PetscCall(PetscLogEventEnd(KSP_Solve_FS_U, kspUpper, ilinkA->x, ilinkA->z, NULL)); 11989566063dSJacob Faibussowitsch PetscCall(VecAXPY(ilinkA->y, -1.0, ilinkA->z)); 1199443836d0SMatthew G Knepley } 12009566063dSJacob Faibussowitsch PetscCall(VecScatterEnd(ilinkD->sctx, ilinkD->y, y, INSERT_VALUES, SCATTER_REVERSE)); 12019566063dSJacob Faibussowitsch PetscCall(VecScatterBegin(ilinkA->sctx, ilinkA->y, y, INSERT_VALUES, SCATTER_REVERSE)); 12029566063dSJacob Faibussowitsch PetscCall(VecScatterEnd(ilinkA->sctx, ilinkA->y, y, INSERT_VALUES, SCATTER_REVERSE)); 1203c5d2311dSJed Brown } 12043ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 12053b224e63SBarry Smith } 12063b224e63SBarry Smith 1207*7b665727SPierre Jolivet static PetscErrorCode PCApplyTranspose_FieldSplit_Schur(PC pc, Vec x, Vec y) 1208*7b665727SPierre Jolivet { 1209*7b665727SPierre Jolivet PC_FieldSplit *jac = (PC_FieldSplit *)pc->data; 1210*7b665727SPierre Jolivet PC_FieldSplitLink ilinkA = jac->head, ilinkD = ilinkA->next; 1211*7b665727SPierre Jolivet KSP kspA = ilinkA->ksp, kspLower = kspA, kspUpper = jac->kspupper; 1212*7b665727SPierre Jolivet 1213*7b665727SPierre Jolivet PetscFunctionBegin; 1214*7b665727SPierre Jolivet switch (jac->schurfactorization) { 1215*7b665727SPierre Jolivet case PC_FIELDSPLIT_SCHUR_FACT_DIAG: 1216*7b665727SPierre Jolivet /* [A00 0; 0 -S], positive definite, suitable for MINRES */ 1217*7b665727SPierre Jolivet PetscCall(VecScatterBegin(ilinkA->sctx, x, ilinkA->x, INSERT_VALUES, SCATTER_FORWARD)); 1218*7b665727SPierre Jolivet PetscCall(VecScatterBegin(ilinkD->sctx, x, ilinkD->x, INSERT_VALUES, SCATTER_FORWARD)); 1219*7b665727SPierre Jolivet PetscCall(VecScatterEnd(ilinkA->sctx, x, ilinkA->x, INSERT_VALUES, SCATTER_FORWARD)); 1220*7b665727SPierre Jolivet PetscCall(PetscLogEventBegin(ilinkA->event, kspA, ilinkA->x, ilinkA->y, NULL)); 1221*7b665727SPierre Jolivet PetscCall(KSPSolveTranspose(kspA, ilinkA->x, ilinkA->y)); 1222*7b665727SPierre Jolivet PetscCall(KSPCheckSolve(kspA, pc, ilinkA->y)); 1223*7b665727SPierre Jolivet PetscCall(PetscLogEventEnd(ilinkA->event, kspA, ilinkA->x, ilinkA->y, NULL)); 1224*7b665727SPierre Jolivet PetscCall(VecScatterBegin(ilinkA->sctx, ilinkA->y, y, INSERT_VALUES, SCATTER_REVERSE)); 1225*7b665727SPierre Jolivet PetscCall(VecScatterEnd(ilinkD->sctx, x, ilinkD->x, INSERT_VALUES, SCATTER_FORWARD)); 1226*7b665727SPierre Jolivet PetscCall(PetscLogEventBegin(KSP_Solve_FS_S, jac->kspschur, ilinkD->x, ilinkD->y, NULL)); 1227*7b665727SPierre Jolivet PetscCall(KSPSolveTranspose(jac->kspschur, ilinkD->x, ilinkD->y)); 1228*7b665727SPierre Jolivet PetscCall(KSPCheckSolve(jac->kspschur, pc, ilinkD->y)); 1229*7b665727SPierre Jolivet PetscCall(PetscLogEventEnd(KSP_Solve_FS_S, jac->kspschur, ilinkD->x, ilinkD->y, NULL)); 1230*7b665727SPierre Jolivet PetscCall(VecScale(ilinkD->y, jac->schurscale)); 1231*7b665727SPierre Jolivet PetscCall(VecScatterEnd(ilinkA->sctx, ilinkA->y, y, INSERT_VALUES, SCATTER_REVERSE)); 1232*7b665727SPierre Jolivet PetscCall(VecScatterBegin(ilinkD->sctx, ilinkD->y, y, INSERT_VALUES, SCATTER_REVERSE)); 1233*7b665727SPierre Jolivet PetscCall(VecScatterEnd(ilinkD->sctx, ilinkD->y, y, INSERT_VALUES, SCATTER_REVERSE)); 1234*7b665727SPierre Jolivet break; 1235*7b665727SPierre Jolivet case PC_FIELDSPLIT_SCHUR_FACT_UPPER: 1236*7b665727SPierre Jolivet PetscCall(VecScatterBegin(ilinkA->sctx, x, ilinkA->x, INSERT_VALUES, SCATTER_FORWARD)); 1237*7b665727SPierre Jolivet PetscCall(VecScatterEnd(ilinkA->sctx, x, ilinkA->x, INSERT_VALUES, SCATTER_FORWARD)); 1238*7b665727SPierre Jolivet PetscCall(PetscLogEventBegin(ilinkA->event, kspA, ilinkA->x, ilinkA->y, NULL)); 1239*7b665727SPierre Jolivet PetscCall(KSPSolveTranspose(kspA, ilinkA->x, ilinkA->y)); 1240*7b665727SPierre Jolivet PetscCall(KSPCheckSolve(kspA, pc, ilinkA->y)); 1241*7b665727SPierre Jolivet PetscCall(PetscLogEventEnd(ilinkA->event, kspA, ilinkA->x, ilinkA->y, NULL)); 1242*7b665727SPierre Jolivet PetscCall(MatMultTranspose(jac->B, ilinkA->y, ilinkD->x)); 1243*7b665727SPierre Jolivet PetscCall(VecScale(ilinkD->x, -1.)); 1244*7b665727SPierre Jolivet PetscCall(VecScatterBegin(ilinkD->sctx, x, ilinkD->x, ADD_VALUES, SCATTER_FORWARD)); 1245*7b665727SPierre Jolivet PetscCall(VecScatterBegin(ilinkA->sctx, ilinkA->y, y, INSERT_VALUES, SCATTER_REVERSE)); 1246*7b665727SPierre Jolivet PetscCall(VecScatterEnd(ilinkD->sctx, x, ilinkD->x, ADD_VALUES, SCATTER_FORWARD)); 1247*7b665727SPierre Jolivet PetscCall(PetscLogEventBegin(KSP_Solve_FS_S, jac->kspschur, ilinkD->x, ilinkD->y, NULL)); 1248*7b665727SPierre Jolivet PetscCall(KSPSolveTranspose(jac->kspschur, ilinkD->x, ilinkD->y)); 1249*7b665727SPierre Jolivet PetscCall(KSPCheckSolve(jac->kspschur, pc, ilinkD->y)); 1250*7b665727SPierre Jolivet PetscCall(PetscLogEventEnd(KSP_Solve_FS_S, jac->kspschur, ilinkD->x, ilinkD->y, NULL)); 1251*7b665727SPierre Jolivet PetscCall(VecScatterEnd(ilinkA->sctx, ilinkA->y, y, INSERT_VALUES, SCATTER_REVERSE)); 1252*7b665727SPierre Jolivet PetscCall(VecScatterBegin(ilinkD->sctx, ilinkD->y, y, INSERT_VALUES, SCATTER_REVERSE)); 1253*7b665727SPierre Jolivet PetscCall(VecScatterEnd(ilinkD->sctx, ilinkD->y, y, INSERT_VALUES, SCATTER_REVERSE)); 1254*7b665727SPierre Jolivet break; 1255*7b665727SPierre Jolivet case PC_FIELDSPLIT_SCHUR_FACT_LOWER: 1256*7b665727SPierre Jolivet PetscCall(VecScatterBegin(ilinkD->sctx, x, ilinkD->x, INSERT_VALUES, SCATTER_FORWARD)); 1257*7b665727SPierre Jolivet PetscCall(VecScatterEnd(ilinkD->sctx, x, ilinkD->x, INSERT_VALUES, SCATTER_FORWARD)); 1258*7b665727SPierre Jolivet PetscCall(PetscLogEventBegin(KSP_Solve_FS_S, jac->kspschur, ilinkD->x, ilinkD->y, NULL)); 1259*7b665727SPierre Jolivet PetscCall(KSPSolveTranspose(jac->kspschur, ilinkD->x, ilinkD->y)); 1260*7b665727SPierre Jolivet PetscCall(KSPCheckSolve(jac->kspschur, pc, ilinkD->y)); 1261*7b665727SPierre Jolivet PetscCall(PetscLogEventEnd(KSP_Solve_FS_S, jac->kspschur, ilinkD->x, ilinkD->y, NULL)); 1262*7b665727SPierre Jolivet PetscCall(MatMultTranspose(jac->C, ilinkD->y, ilinkA->x)); 1263*7b665727SPierre Jolivet PetscCall(VecScale(ilinkA->x, -1.)); 1264*7b665727SPierre Jolivet PetscCall(VecScatterBegin(ilinkA->sctx, x, ilinkA->x, ADD_VALUES, SCATTER_FORWARD)); 1265*7b665727SPierre Jolivet PetscCall(VecScatterBegin(ilinkD->sctx, ilinkD->y, y, INSERT_VALUES, SCATTER_REVERSE)); 1266*7b665727SPierre Jolivet PetscCall(VecScatterEnd(ilinkA->sctx, x, ilinkA->x, ADD_VALUES, SCATTER_FORWARD)); 1267*7b665727SPierre Jolivet PetscCall(PetscLogEventBegin(ilinkA->event, kspA, ilinkA->x, ilinkA->y, NULL)); 1268*7b665727SPierre Jolivet PetscCall(KSPSolveTranspose(kspA, ilinkA->x, ilinkA->y)); 1269*7b665727SPierre Jolivet PetscCall(KSPCheckSolve(kspA, pc, ilinkA->y)); 1270*7b665727SPierre Jolivet PetscCall(PetscLogEventEnd(ilinkA->event, kspA, ilinkA->x, ilinkA->y, NULL)); 1271*7b665727SPierre Jolivet PetscCall(VecScatterEnd(ilinkD->sctx, ilinkD->y, y, INSERT_VALUES, SCATTER_REVERSE)); 1272*7b665727SPierre Jolivet PetscCall(VecScatterBegin(ilinkA->sctx, ilinkA->y, y, INSERT_VALUES, SCATTER_REVERSE)); 1273*7b665727SPierre Jolivet PetscCall(VecScatterEnd(ilinkA->sctx, ilinkA->y, y, INSERT_VALUES, SCATTER_REVERSE)); 1274*7b665727SPierre Jolivet break; 1275*7b665727SPierre Jolivet case PC_FIELDSPLIT_SCHUR_FACT_FULL: 1276*7b665727SPierre Jolivet PetscCall(VecScatterBegin(ilinkA->sctx, x, ilinkA->x, INSERT_VALUES, SCATTER_FORWARD)); 1277*7b665727SPierre Jolivet PetscCall(VecScatterEnd(ilinkA->sctx, x, ilinkA->x, INSERT_VALUES, SCATTER_FORWARD)); 1278*7b665727SPierre Jolivet PetscCall(PetscLogEventBegin(KSP_Solve_FS_U, kspUpper, ilinkA->x, ilinkA->y, NULL)); 1279*7b665727SPierre Jolivet PetscCall(KSPSolveTranspose(kspUpper, ilinkA->x, ilinkA->y)); 1280*7b665727SPierre Jolivet PetscCall(KSPCheckSolve(kspUpper, pc, ilinkA->y)); 1281*7b665727SPierre Jolivet PetscCall(PetscLogEventEnd(KSP_Solve_FS_U, kspUpper, ilinkA->x, ilinkA->y, NULL)); 1282*7b665727SPierre Jolivet PetscCall(MatMultTranspose(jac->B, ilinkA->y, ilinkD->x)); 1283*7b665727SPierre Jolivet PetscCall(VecScale(ilinkD->x, -1.0)); 1284*7b665727SPierre Jolivet PetscCall(VecScatterBegin(ilinkD->sctx, x, ilinkD->x, ADD_VALUES, SCATTER_FORWARD)); 1285*7b665727SPierre Jolivet PetscCall(VecScatterEnd(ilinkD->sctx, x, ilinkD->x, ADD_VALUES, SCATTER_FORWARD)); 1286*7b665727SPierre Jolivet 1287*7b665727SPierre Jolivet PetscCall(PetscLogEventBegin(KSP_Solve_FS_S, jac->kspschur, ilinkD->x, ilinkD->y, NULL)); 1288*7b665727SPierre Jolivet PetscCall(KSPSolveTranspose(jac->kspschur, ilinkD->x, ilinkD->y)); 1289*7b665727SPierre Jolivet PetscCall(KSPCheckSolve(jac->kspschur, pc, ilinkD->y)); 1290*7b665727SPierre Jolivet PetscCall(PetscLogEventEnd(KSP_Solve_FS_S, jac->kspschur, ilinkD->x, ilinkD->y, NULL)); 1291*7b665727SPierre Jolivet PetscCall(VecScatterBegin(ilinkD->sctx, ilinkD->y, y, INSERT_VALUES, SCATTER_REVERSE)); 1292*7b665727SPierre Jolivet 1293*7b665727SPierre Jolivet if (kspLower == kspA) { 1294*7b665727SPierre Jolivet PetscCall(MatMultTranspose(jac->C, ilinkD->y, ilinkA->y)); 1295*7b665727SPierre Jolivet PetscCall(VecAXPY(ilinkA->x, -1.0, ilinkA->y)); 1296*7b665727SPierre Jolivet PetscCall(PetscLogEventBegin(ilinkA->event, kspA, ilinkA->x, ilinkA->y, NULL)); 1297*7b665727SPierre Jolivet PetscCall(KSPSolveTranspose(kspA, ilinkA->x, ilinkA->y)); 1298*7b665727SPierre Jolivet PetscCall(KSPCheckSolve(kspA, pc, ilinkA->y)); 1299*7b665727SPierre Jolivet PetscCall(PetscLogEventEnd(ilinkA->event, kspA, ilinkA->x, ilinkA->y, NULL)); 1300*7b665727SPierre Jolivet } else { 1301*7b665727SPierre Jolivet PetscCall(PetscLogEventBegin(ilinkA->event, kspA, ilinkA->x, ilinkA->y, NULL)); 1302*7b665727SPierre Jolivet PetscCall(KSPSolveTranspose(kspA, ilinkA->x, ilinkA->y)); 1303*7b665727SPierre Jolivet PetscCall(KSPCheckSolve(kspA, pc, ilinkA->y)); 1304*7b665727SPierre Jolivet PetscCall(MatMultTranspose(jac->C, ilinkD->y, ilinkA->x)); 1305*7b665727SPierre Jolivet PetscCall(PetscLogEventBegin(KSP_Solve_FS_L, kspLower, ilinkA->x, ilinkA->z, NULL)); 1306*7b665727SPierre Jolivet PetscCall(KSPSolveTranspose(kspLower, ilinkA->x, ilinkA->z)); 1307*7b665727SPierre Jolivet PetscCall(KSPCheckSolve(kspLower, pc, ilinkA->z)); 1308*7b665727SPierre Jolivet PetscCall(PetscLogEventEnd(KSP_Solve_FS_L, kspLower, ilinkA->x, ilinkA->z, NULL)); 1309*7b665727SPierre Jolivet PetscCall(VecAXPY(ilinkA->y, -1.0, ilinkA->z)); 1310*7b665727SPierre Jolivet } 1311*7b665727SPierre Jolivet PetscCall(VecScatterEnd(ilinkD->sctx, ilinkD->y, y, INSERT_VALUES, SCATTER_REVERSE)); 1312*7b665727SPierre Jolivet PetscCall(VecScatterBegin(ilinkA->sctx, ilinkA->y, y, INSERT_VALUES, SCATTER_REVERSE)); 1313*7b665727SPierre Jolivet PetscCall(VecScatterEnd(ilinkA->sctx, ilinkA->y, y, INSERT_VALUES, SCATTER_REVERSE)); 1314*7b665727SPierre Jolivet } 1315*7b665727SPierre Jolivet PetscFunctionReturn(PETSC_SUCCESS); 1316*7b665727SPierre Jolivet } 1317*7b665727SPierre Jolivet 1318d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCApply_FieldSplit(PC pc, Vec x, Vec y) 1319d71ae5a4SJacob Faibussowitsch { 13200971522cSBarry Smith PC_FieldSplit *jac = (PC_FieldSplit *)pc->data; 13215a9f2f41SSatish Balay PC_FieldSplitLink ilink = jac->head; 1322939b8a20SBarry Smith PetscInt cnt, bs; 13230971522cSBarry Smith 13240971522cSBarry Smith PetscFunctionBegin; 132579416396SBarry Smith if (jac->type == PC_COMPOSITE_ADDITIVE) { 13261b9fc7fcSBarry Smith if (jac->defaultsplit) { 13279566063dSJacob Faibussowitsch PetscCall(VecGetBlockSize(x, &bs)); 13282472a847SBarry 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); 13299566063dSJacob Faibussowitsch PetscCall(VecGetBlockSize(y, &bs)); 13302472a847SBarry 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); 13319566063dSJacob Faibussowitsch PetscCall(VecStrideGatherAll(x, jac->x, INSERT_VALUES)); 13325a9f2f41SSatish Balay while (ilink) { 13339566063dSJacob Faibussowitsch PetscCall(PetscLogEventBegin(ilink->event, ilink->ksp, ilink->x, ilink->y, NULL)); 13349566063dSJacob Faibussowitsch PetscCall(KSPSolve(ilink->ksp, ilink->x, ilink->y)); 13359566063dSJacob Faibussowitsch PetscCall(KSPCheckSolve(ilink->ksp, pc, ilink->y)); 13369566063dSJacob Faibussowitsch PetscCall(PetscLogEventEnd(ilink->event, ilink->ksp, ilink->x, ilink->y, NULL)); 13375a9f2f41SSatish Balay ilink = ilink->next; 13380971522cSBarry Smith } 13399566063dSJacob Faibussowitsch PetscCall(VecStrideScatterAll(jac->y, y, INSERT_VALUES)); 13401b9fc7fcSBarry Smith } else { 13419566063dSJacob Faibussowitsch PetscCall(VecSet(y, 0.0)); 13425a9f2f41SSatish Balay while (ilink) { 13439566063dSJacob Faibussowitsch PetscCall(FieldSplitSplitSolveAdd(ilink, x, y)); 13445a9f2f41SSatish Balay ilink = ilink->next; 13451b9fc7fcSBarry Smith } 13461b9fc7fcSBarry Smith } 1347e52d2c62SBarry Smith } else if (jac->type == PC_COMPOSITE_MULTIPLICATIVE && jac->nsplits == 2) { 13489566063dSJacob Faibussowitsch PetscCall(VecSet(y, 0.0)); 1349e52d2c62SBarry Smith /* solve on first block for first block variables */ 13509566063dSJacob Faibussowitsch PetscCall(VecScatterBegin(ilink->sctx, x, ilink->x, INSERT_VALUES, SCATTER_FORWARD)); 13519566063dSJacob Faibussowitsch PetscCall(VecScatterEnd(ilink->sctx, x, ilink->x, INSERT_VALUES, SCATTER_FORWARD)); 13529566063dSJacob Faibussowitsch PetscCall(PetscLogEventBegin(ilink->event, ilink->ksp, ilink->x, ilink->y, NULL)); 13539566063dSJacob Faibussowitsch PetscCall(KSPSolve(ilink->ksp, ilink->x, ilink->y)); 13549566063dSJacob Faibussowitsch PetscCall(KSPCheckSolve(ilink->ksp, pc, ilink->y)); 13559566063dSJacob Faibussowitsch PetscCall(PetscLogEventEnd(ilink->event, ilink->ksp, ilink->x, ilink->y, NULL)); 13569566063dSJacob Faibussowitsch PetscCall(VecScatterBegin(ilink->sctx, ilink->y, y, ADD_VALUES, SCATTER_REVERSE)); 13579566063dSJacob Faibussowitsch PetscCall(VecScatterEnd(ilink->sctx, ilink->y, y, ADD_VALUES, SCATTER_REVERSE)); 1358e52d2c62SBarry Smith 1359e52d2c62SBarry Smith /* compute the residual only onto second block variables using first block variables */ 13609566063dSJacob Faibussowitsch PetscCall(MatMult(jac->Afield[1], ilink->y, ilink->next->x)); 1361e52d2c62SBarry Smith ilink = ilink->next; 13629566063dSJacob Faibussowitsch PetscCall(VecScale(ilink->x, -1.0)); 13639566063dSJacob Faibussowitsch PetscCall(VecScatterBegin(ilink->sctx, x, ilink->x, ADD_VALUES, SCATTER_FORWARD)); 13649566063dSJacob Faibussowitsch PetscCall(VecScatterEnd(ilink->sctx, x, ilink->x, ADD_VALUES, SCATTER_FORWARD)); 1365e52d2c62SBarry Smith 1366e52d2c62SBarry Smith /* solve on second block variables */ 13679566063dSJacob Faibussowitsch PetscCall(PetscLogEventBegin(ilink->event, ilink->ksp, ilink->x, ilink->y, NULL)); 13689566063dSJacob Faibussowitsch PetscCall(KSPSolve(ilink->ksp, ilink->x, ilink->y)); 13699566063dSJacob Faibussowitsch PetscCall(KSPCheckSolve(ilink->ksp, pc, ilink->y)); 13709566063dSJacob Faibussowitsch PetscCall(PetscLogEventEnd(ilink->event, ilink->ksp, ilink->x, ilink->y, NULL)); 13719566063dSJacob Faibussowitsch PetscCall(VecScatterBegin(ilink->sctx, ilink->y, y, ADD_VALUES, SCATTER_REVERSE)); 13729566063dSJacob Faibussowitsch PetscCall(VecScatterEnd(ilink->sctx, ilink->y, y, ADD_VALUES, SCATTER_REVERSE)); 137316913363SBarry Smith } else if (jac->type == PC_COMPOSITE_MULTIPLICATIVE || jac->type == PC_COMPOSITE_SYMMETRIC_MULTIPLICATIVE) { 137479416396SBarry Smith if (!jac->w1) { 13759566063dSJacob Faibussowitsch PetscCall(VecDuplicate(x, &jac->w1)); 13769566063dSJacob Faibussowitsch PetscCall(VecDuplicate(x, &jac->w2)); 137779416396SBarry Smith } 13789566063dSJacob Faibussowitsch PetscCall(VecSet(y, 0.0)); 13799566063dSJacob Faibussowitsch PetscCall(FieldSplitSplitSolveAdd(ilink, x, y)); 13803e197d65SBarry Smith cnt = 1; 13815a9f2f41SSatish Balay while (ilink->next) { 13825a9f2f41SSatish Balay ilink = ilink->next; 13833e197d65SBarry Smith /* compute the residual only over the part of the vector needed */ 13849566063dSJacob Faibussowitsch PetscCall(MatMult(jac->Afield[cnt++], y, ilink->x)); 13859566063dSJacob Faibussowitsch PetscCall(VecScale(ilink->x, -1.0)); 13869566063dSJacob Faibussowitsch PetscCall(VecScatterBegin(ilink->sctx, x, ilink->x, ADD_VALUES, SCATTER_FORWARD)); 13879566063dSJacob Faibussowitsch PetscCall(VecScatterEnd(ilink->sctx, x, ilink->x, ADD_VALUES, SCATTER_FORWARD)); 13889566063dSJacob Faibussowitsch PetscCall(PetscLogEventBegin(ilink->event, ilink->ksp, ilink->x, ilink->y, NULL)); 13899566063dSJacob Faibussowitsch PetscCall(KSPSolve(ilink->ksp, ilink->x, ilink->y)); 13909566063dSJacob Faibussowitsch PetscCall(KSPCheckSolve(ilink->ksp, pc, ilink->y)); 13919566063dSJacob Faibussowitsch PetscCall(PetscLogEventEnd(ilink->event, ilink->ksp, ilink->x, ilink->y, NULL)); 13929566063dSJacob Faibussowitsch PetscCall(VecScatterBegin(ilink->sctx, ilink->y, y, ADD_VALUES, SCATTER_REVERSE)); 13939566063dSJacob Faibussowitsch PetscCall(VecScatterEnd(ilink->sctx, ilink->y, y, ADD_VALUES, SCATTER_REVERSE)); 13943e197d65SBarry Smith } 139551f519a2SBarry Smith if (jac->type == PC_COMPOSITE_SYMMETRIC_MULTIPLICATIVE) { 139611755939SBarry Smith cnt -= 2; 139751f519a2SBarry Smith while (ilink->previous) { 139851f519a2SBarry Smith ilink = ilink->previous; 139911755939SBarry Smith /* compute the residual only over the part of the vector needed */ 14009566063dSJacob Faibussowitsch PetscCall(MatMult(jac->Afield[cnt--], y, ilink->x)); 14019566063dSJacob Faibussowitsch PetscCall(VecScale(ilink->x, -1.0)); 14029566063dSJacob Faibussowitsch PetscCall(VecScatterBegin(ilink->sctx, x, ilink->x, ADD_VALUES, SCATTER_FORWARD)); 14039566063dSJacob Faibussowitsch PetscCall(VecScatterEnd(ilink->sctx, x, ilink->x, ADD_VALUES, SCATTER_FORWARD)); 14049566063dSJacob Faibussowitsch PetscCall(PetscLogEventBegin(ilink->event, ilink->ksp, ilink->x, ilink->y, NULL)); 14059566063dSJacob Faibussowitsch PetscCall(KSPSolve(ilink->ksp, ilink->x, ilink->y)); 14069566063dSJacob Faibussowitsch PetscCall(KSPCheckSolve(ilink->ksp, pc, ilink->y)); 14079566063dSJacob Faibussowitsch PetscCall(PetscLogEventEnd(ilink->event, ilink->ksp, ilink->x, ilink->y, NULL)); 14089566063dSJacob Faibussowitsch PetscCall(VecScatterBegin(ilink->sctx, ilink->y, y, ADD_VALUES, SCATTER_REVERSE)); 14099566063dSJacob Faibussowitsch PetscCall(VecScatterEnd(ilink->sctx, ilink->y, y, ADD_VALUES, SCATTER_REVERSE)); 141051f519a2SBarry Smith } 141111755939SBarry Smith } 141263a3b9bcSJacob Faibussowitsch } else SETERRQ(PetscObjectComm((PetscObject)pc), PETSC_ERR_SUP, "Unsupported or unknown composition %d", (int)jac->type); 14133ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 14140971522cSBarry Smith } 14150971522cSBarry Smith 1416d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCApply_FieldSplit_GKB(PC pc, Vec x, Vec y) 1417d71ae5a4SJacob Faibussowitsch { 1418a51937d4SCarola Kruse PC_FieldSplit *jac = (PC_FieldSplit *)pc->data; 1419a51937d4SCarola Kruse PC_FieldSplitLink ilinkA = jac->head, ilinkD = ilinkA->next; 1420a51937d4SCarola Kruse KSP ksp = ilinkA->ksp; 1421de482cd7SCarola Kruse Vec u, v, Hu, d, work1, work2; 1422e071a0a4SCarola Kruse PetscScalar alpha, z, nrmz2, *vecz; 1423e071a0a4SCarola Kruse PetscReal lowbnd, nu, beta; 1424a51937d4SCarola Kruse PetscInt j, iterGKB; 1425a51937d4SCarola Kruse 1426a51937d4SCarola Kruse PetscFunctionBegin; 14279566063dSJacob Faibussowitsch PetscCall(VecScatterBegin(ilinkA->sctx, x, ilinkA->x, INSERT_VALUES, SCATTER_FORWARD)); 14289566063dSJacob Faibussowitsch PetscCall(VecScatterBegin(ilinkD->sctx, x, ilinkD->x, INSERT_VALUES, SCATTER_FORWARD)); 14299566063dSJacob Faibussowitsch PetscCall(VecScatterEnd(ilinkA->sctx, x, ilinkA->x, INSERT_VALUES, SCATTER_FORWARD)); 14309566063dSJacob Faibussowitsch PetscCall(VecScatterEnd(ilinkD->sctx, x, ilinkD->x, INSERT_VALUES, SCATTER_FORWARD)); 1431e071a0a4SCarola Kruse 1432e071a0a4SCarola Kruse u = jac->u; 1433e071a0a4SCarola Kruse v = jac->v; 1434e071a0a4SCarola Kruse Hu = jac->Hu; 1435e071a0a4SCarola Kruse d = jac->d; 1436e071a0a4SCarola Kruse work1 = jac->w1; 1437e071a0a4SCarola Kruse work2 = jac->w2; 1438e071a0a4SCarola Kruse vecz = jac->vecz; 1439a51937d4SCarola Kruse 1440a51937d4SCarola Kruse /* Change RHS to comply with matrix regularization H = A + nu*B*B' */ 1441a51937d4SCarola Kruse /* Add q = q + nu*B*b */ 1442a51937d4SCarola Kruse if (jac->gkbnu) { 1443a51937d4SCarola Kruse nu = jac->gkbnu; 14449566063dSJacob Faibussowitsch PetscCall(VecScale(ilinkD->x, jac->gkbnu)); 14459566063dSJacob Faibussowitsch PetscCall(MatMultAdd(jac->B, ilinkD->x, ilinkA->x, ilinkA->x)); /* q = q + nu*B*b */ 1446a51937d4SCarola Kruse } else { 1447a51937d4SCarola Kruse /* Situation when no augmented Lagrangian is used. Then we set inner */ 1448a51937d4SCarola Kruse /* matrix N = I in [Ar13], and thus nu = 1. */ 1449a51937d4SCarola Kruse nu = 1; 1450a51937d4SCarola Kruse } 1451a51937d4SCarola Kruse 1452a51937d4SCarola Kruse /* Transform rhs from [q,tilde{b}] to [0,b] */ 14539566063dSJacob Faibussowitsch PetscCall(PetscLogEventBegin(ilinkA->event, ksp, ilinkA->x, ilinkA->y, NULL)); 14549566063dSJacob Faibussowitsch PetscCall(KSPSolve(ksp, ilinkA->x, ilinkA->y)); 14559566063dSJacob Faibussowitsch PetscCall(KSPCheckSolve(ksp, pc, ilinkA->y)); 14569566063dSJacob Faibussowitsch PetscCall(PetscLogEventEnd(ilinkA->event, ksp, ilinkA->x, ilinkA->y, NULL)); 14579566063dSJacob Faibussowitsch PetscCall(MatMultHermitianTranspose(jac->B, ilinkA->y, work1)); 14589566063dSJacob Faibussowitsch PetscCall(VecAXPBY(work1, 1.0 / nu, -1.0, ilinkD->x)); /* c = b - B'*x */ 1459a51937d4SCarola Kruse 1460a51937d4SCarola Kruse /* First step of algorithm */ 14619566063dSJacob Faibussowitsch PetscCall(VecNorm(work1, NORM_2, &beta)); /* beta = sqrt(nu*c'*c)*/ 1462e071a0a4SCarola Kruse KSPCheckDot(ksp, beta); 1463addd1e01SJunchao Zhang beta = PetscSqrtReal(nu) * beta; 14649566063dSJacob Faibussowitsch PetscCall(VecAXPBY(v, nu / beta, 0.0, work1)); /* v = nu/beta *c */ 14659566063dSJacob Faibussowitsch PetscCall(MatMult(jac->B, v, work2)); /* u = H^{-1}*B*v */ 14669566063dSJacob Faibussowitsch PetscCall(PetscLogEventBegin(ilinkA->event, ksp, work2, u, NULL)); 14679566063dSJacob Faibussowitsch PetscCall(KSPSolve(ksp, work2, u)); 14689566063dSJacob Faibussowitsch PetscCall(KSPCheckSolve(ksp, pc, u)); 14699566063dSJacob Faibussowitsch PetscCall(PetscLogEventEnd(ilinkA->event, ksp, work2, u, NULL)); 14709566063dSJacob Faibussowitsch PetscCall(MatMult(jac->H, u, Hu)); /* alpha = u'*H*u */ 14719566063dSJacob Faibussowitsch PetscCall(VecDot(Hu, u, &alpha)); 1472e071a0a4SCarola Kruse KSPCheckDot(ksp, alpha); 147308401ef6SPierre Jolivet PetscCheck(PetscRealPart(alpha) > 0.0, PETSC_COMM_SELF, PETSC_ERR_NOT_CONVERGED, "GKB preconditioner diverged, H is not positive definite"); 1474addd1e01SJunchao Zhang alpha = PetscSqrtReal(PetscAbsScalar(alpha)); 14759566063dSJacob Faibussowitsch PetscCall(VecScale(u, 1.0 / alpha)); 14769566063dSJacob Faibussowitsch PetscCall(VecAXPBY(d, 1.0 / alpha, 0.0, v)); /* v = nu/beta *c */ 1477de482cd7SCarola Kruse 1478a51937d4SCarola Kruse z = beta / alpha; 1479a51937d4SCarola Kruse vecz[1] = z; 1480a51937d4SCarola Kruse 1481de482cd7SCarola Kruse /* Computation of first iterate x(1) and p(1) */ 14829566063dSJacob Faibussowitsch PetscCall(VecAXPY(ilinkA->y, z, u)); 14839566063dSJacob Faibussowitsch PetscCall(VecCopy(d, ilinkD->y)); 14849566063dSJacob Faibussowitsch PetscCall(VecScale(ilinkD->y, -z)); 1485a51937d4SCarola Kruse 14869371c9d4SSatish Balay iterGKB = 1; 14879371c9d4SSatish Balay lowbnd = 2 * jac->gkbtol; 148848a46eb9SPierre Jolivet if (jac->gkbmonitor) PetscCall(PetscViewerASCIIPrintf(jac->gkbviewer, "%3" PetscInt_FMT " GKB Lower bound estimate %14.12e\n", iterGKB, (double)lowbnd)); 1489de482cd7SCarola Kruse 1490a51937d4SCarola Kruse while (iterGKB < jac->gkbmaxit && lowbnd > jac->gkbtol) { 1491a51937d4SCarola Kruse iterGKB += 1; 14929566063dSJacob Faibussowitsch PetscCall(MatMultHermitianTranspose(jac->B, u, work1)); /* v <- nu*(B'*u-alpha/nu*v) */ 14939566063dSJacob Faibussowitsch PetscCall(VecAXPBY(v, nu, -alpha, work1)); 14949566063dSJacob Faibussowitsch PetscCall(VecNorm(v, NORM_2, &beta)); /* beta = sqrt(nu)*v'*v */ 1495addd1e01SJunchao Zhang beta = beta / PetscSqrtReal(nu); 14969566063dSJacob Faibussowitsch PetscCall(VecScale(v, 1.0 / beta)); 14979566063dSJacob Faibussowitsch PetscCall(MatMult(jac->B, v, work2)); /* u <- H^{-1}*(B*v-beta*H*u) */ 14989566063dSJacob Faibussowitsch PetscCall(MatMult(jac->H, u, Hu)); 14999566063dSJacob Faibussowitsch PetscCall(VecAXPY(work2, -beta, Hu)); 15009566063dSJacob Faibussowitsch PetscCall(PetscLogEventBegin(ilinkA->event, ksp, work2, u, NULL)); 15019566063dSJacob Faibussowitsch PetscCall(KSPSolve(ksp, work2, u)); 15029566063dSJacob Faibussowitsch PetscCall(KSPCheckSolve(ksp, pc, u)); 15039566063dSJacob Faibussowitsch PetscCall(PetscLogEventEnd(ilinkA->event, ksp, work2, u, NULL)); 15049566063dSJacob Faibussowitsch PetscCall(MatMult(jac->H, u, Hu)); /* alpha = u'*H*u */ 15059566063dSJacob Faibussowitsch PetscCall(VecDot(Hu, u, &alpha)); 1506e071a0a4SCarola Kruse KSPCheckDot(ksp, alpha); 150708401ef6SPierre Jolivet PetscCheck(PetscRealPart(alpha) > 0.0, PETSC_COMM_SELF, PETSC_ERR_NOT_CONVERGED, "GKB preconditioner diverged, H is not positive definite"); 1508addd1e01SJunchao Zhang alpha = PetscSqrtReal(PetscAbsScalar(alpha)); 15099566063dSJacob Faibussowitsch PetscCall(VecScale(u, 1.0 / alpha)); 1510a51937d4SCarola Kruse 1511e071a0a4SCarola Kruse z = -beta / alpha * z; /* z <- beta/alpha*z */ 1512a51937d4SCarola Kruse vecz[0] = z; 1513a51937d4SCarola Kruse 1514a51937d4SCarola Kruse /* Computation of new iterate x(i+1) and p(i+1) */ 15159566063dSJacob Faibussowitsch PetscCall(VecAXPBY(d, 1.0 / alpha, -beta / alpha, v)); /* d = (v-beta*d)/alpha */ 15169566063dSJacob Faibussowitsch PetscCall(VecAXPY(ilinkA->y, z, u)); /* r = r + z*u */ 15179566063dSJacob Faibussowitsch PetscCall(VecAXPY(ilinkD->y, -z, d)); /* p = p - z*d */ 15189566063dSJacob Faibussowitsch PetscCall(MatMult(jac->H, ilinkA->y, Hu)); /* ||u||_H = u'*H*u */ 15199566063dSJacob Faibussowitsch PetscCall(VecDot(Hu, ilinkA->y, &nrmz2)); 1520a51937d4SCarola Kruse 1521a51937d4SCarola Kruse /* Compute Lower Bound estimate */ 1522a51937d4SCarola Kruse if (iterGKB > jac->gkbdelay) { 1523a51937d4SCarola Kruse lowbnd = 0.0; 1524ad540459SPierre Jolivet for (j = 0; j < jac->gkbdelay; j++) lowbnd += PetscAbsScalar(vecz[j] * vecz[j]); 1525addd1e01SJunchao Zhang lowbnd = PetscSqrtReal(lowbnd / PetscAbsScalar(nrmz2)); 1526a51937d4SCarola Kruse } 1527a51937d4SCarola Kruse 1528ad540459SPierre Jolivet for (j = 0; j < jac->gkbdelay - 1; j++) vecz[jac->gkbdelay - j - 1] = vecz[jac->gkbdelay - j - 2]; 152948a46eb9SPierre Jolivet if (jac->gkbmonitor) PetscCall(PetscViewerASCIIPrintf(jac->gkbviewer, "%3" PetscInt_FMT " GKB Lower bound estimate %14.12e\n", iterGKB, (double)lowbnd)); 1530a51937d4SCarola Kruse } 1531a51937d4SCarola Kruse 15329566063dSJacob Faibussowitsch PetscCall(VecScatterBegin(ilinkA->sctx, ilinkA->y, y, INSERT_VALUES, SCATTER_REVERSE)); 15339566063dSJacob Faibussowitsch PetscCall(VecScatterEnd(ilinkA->sctx, ilinkA->y, y, INSERT_VALUES, SCATTER_REVERSE)); 15349566063dSJacob Faibussowitsch PetscCall(VecScatterBegin(ilinkD->sctx, ilinkD->y, y, INSERT_VALUES, SCATTER_REVERSE)); 15359566063dSJacob Faibussowitsch PetscCall(VecScatterEnd(ilinkD->sctx, ilinkD->y, y, INSERT_VALUES, SCATTER_REVERSE)); 1536a51937d4SCarola Kruse 15373ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 1538a51937d4SCarola Kruse } 1539a51937d4SCarola Kruse 1540421e10b8SBarry Smith #define FieldSplitSplitSolveAddTranspose(ilink, xx, yy) \ 15413ba16761SJacob 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) || \ 15429371c9d4SSatish 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) || \ 15433ba16761SJacob Faibussowitsch VecScatterEnd(ilink->sctx, ilink->x, yy, ADD_VALUES, SCATTER_REVERSE))) 1544421e10b8SBarry Smith 1545d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCApplyTranspose_FieldSplit(PC pc, Vec x, Vec y) 1546d71ae5a4SJacob Faibussowitsch { 1547421e10b8SBarry Smith PC_FieldSplit *jac = (PC_FieldSplit *)pc->data; 1548421e10b8SBarry Smith PC_FieldSplitLink ilink = jac->head; 1549939b8a20SBarry Smith PetscInt bs; 1550421e10b8SBarry Smith 1551421e10b8SBarry Smith PetscFunctionBegin; 1552421e10b8SBarry Smith if (jac->type == PC_COMPOSITE_ADDITIVE) { 1553421e10b8SBarry Smith if (jac->defaultsplit) { 15549566063dSJacob Faibussowitsch PetscCall(VecGetBlockSize(x, &bs)); 15552472a847SBarry 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); 15569566063dSJacob Faibussowitsch PetscCall(VecGetBlockSize(y, &bs)); 15572472a847SBarry 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); 15589566063dSJacob Faibussowitsch PetscCall(VecStrideGatherAll(x, jac->x, INSERT_VALUES)); 1559421e10b8SBarry Smith while (ilink) { 15609566063dSJacob Faibussowitsch PetscCall(PetscLogEventBegin(ilink->event, ilink->ksp, ilink->x, ilink->y, NULL)); 15619566063dSJacob Faibussowitsch PetscCall(KSPSolveTranspose(ilink->ksp, ilink->x, ilink->y)); 15629566063dSJacob Faibussowitsch PetscCall(KSPCheckSolve(ilink->ksp, pc, ilink->y)); 15639566063dSJacob Faibussowitsch PetscCall(PetscLogEventEnd(ilink->event, ilink->ksp, ilink->x, ilink->y, NULL)); 1564421e10b8SBarry Smith ilink = ilink->next; 1565421e10b8SBarry Smith } 15669566063dSJacob Faibussowitsch PetscCall(VecStrideScatterAll(jac->y, y, INSERT_VALUES)); 1567421e10b8SBarry Smith } else { 15689566063dSJacob Faibussowitsch PetscCall(VecSet(y, 0.0)); 1569421e10b8SBarry Smith while (ilink) { 15709566063dSJacob Faibussowitsch PetscCall(FieldSplitSplitSolveAddTranspose(ilink, x, y)); 1571421e10b8SBarry Smith ilink = ilink->next; 1572421e10b8SBarry Smith } 1573421e10b8SBarry Smith } 1574421e10b8SBarry Smith } else { 1575421e10b8SBarry Smith if (!jac->w1) { 15769566063dSJacob Faibussowitsch PetscCall(VecDuplicate(x, &jac->w1)); 15779566063dSJacob Faibussowitsch PetscCall(VecDuplicate(x, &jac->w2)); 1578421e10b8SBarry Smith } 15799566063dSJacob Faibussowitsch PetscCall(VecSet(y, 0.0)); 1580421e10b8SBarry Smith if (jac->type == PC_COMPOSITE_SYMMETRIC_MULTIPLICATIVE) { 15819566063dSJacob Faibussowitsch PetscCall(FieldSplitSplitSolveAddTranspose(ilink, x, y)); 1582421e10b8SBarry Smith while (ilink->next) { 1583421e10b8SBarry Smith ilink = ilink->next; 15849566063dSJacob Faibussowitsch PetscCall(MatMultTranspose(pc->mat, y, jac->w1)); 15859566063dSJacob Faibussowitsch PetscCall(VecWAXPY(jac->w2, -1.0, jac->w1, x)); 15869566063dSJacob Faibussowitsch PetscCall(FieldSplitSplitSolveAddTranspose(ilink, jac->w2, y)); 1587421e10b8SBarry Smith } 1588421e10b8SBarry Smith while (ilink->previous) { 1589421e10b8SBarry Smith ilink = ilink->previous; 15909566063dSJacob Faibussowitsch PetscCall(MatMultTranspose(pc->mat, y, jac->w1)); 15919566063dSJacob Faibussowitsch PetscCall(VecWAXPY(jac->w2, -1.0, jac->w1, x)); 15929566063dSJacob Faibussowitsch PetscCall(FieldSplitSplitSolveAddTranspose(ilink, jac->w2, y)); 1593421e10b8SBarry Smith } 1594421e10b8SBarry Smith } else { 1595421e10b8SBarry Smith while (ilink->next) { /* get to last entry in linked list */ 1596421e10b8SBarry Smith ilink = ilink->next; 1597421e10b8SBarry Smith } 15989566063dSJacob Faibussowitsch PetscCall(FieldSplitSplitSolveAddTranspose(ilink, x, y)); 1599421e10b8SBarry Smith while (ilink->previous) { 1600421e10b8SBarry Smith ilink = ilink->previous; 16019566063dSJacob Faibussowitsch PetscCall(MatMultTranspose(pc->mat, y, jac->w1)); 16029566063dSJacob Faibussowitsch PetscCall(VecWAXPY(jac->w2, -1.0, jac->w1, x)); 16039566063dSJacob Faibussowitsch PetscCall(FieldSplitSplitSolveAddTranspose(ilink, jac->w2, y)); 1604421e10b8SBarry Smith } 1605421e10b8SBarry Smith } 1606421e10b8SBarry Smith } 16073ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 1608421e10b8SBarry Smith } 1609421e10b8SBarry Smith 1610d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCReset_FieldSplit(PC pc) 1611d71ae5a4SJacob Faibussowitsch { 16120971522cSBarry Smith PC_FieldSplit *jac = (PC_FieldSplit *)pc->data; 16135a9f2f41SSatish Balay PC_FieldSplitLink ilink = jac->head, next; 16140971522cSBarry Smith 16150971522cSBarry Smith PetscFunctionBegin; 16165a9f2f41SSatish Balay while (ilink) { 16179566063dSJacob Faibussowitsch PetscCall(KSPDestroy(&ilink->ksp)); 16189566063dSJacob Faibussowitsch PetscCall(VecDestroy(&ilink->x)); 16199566063dSJacob Faibussowitsch PetscCall(VecDestroy(&ilink->y)); 16209566063dSJacob Faibussowitsch PetscCall(VecDestroy(&ilink->z)); 16219566063dSJacob Faibussowitsch PetscCall(VecScatterDestroy(&ilink->sctx)); 16229566063dSJacob Faibussowitsch PetscCall(ISDestroy(&ilink->is)); 16239566063dSJacob Faibussowitsch PetscCall(ISDestroy(&ilink->is_col)); 16249566063dSJacob Faibussowitsch PetscCall(PetscFree(ilink->splitname)); 16259566063dSJacob Faibussowitsch PetscCall(PetscFree(ilink->fields)); 16269566063dSJacob Faibussowitsch PetscCall(PetscFree(ilink->fields_col)); 16275a9f2f41SSatish Balay next = ilink->next; 16289566063dSJacob Faibussowitsch PetscCall(PetscFree(ilink)); 16295a9f2f41SSatish Balay ilink = next; 16300971522cSBarry Smith } 1631f5f0d762SBarry Smith jac->head = NULL; 16329566063dSJacob Faibussowitsch PetscCall(PetscFree2(jac->x, jac->y)); 1633574deadeSBarry Smith if (jac->mat && jac->mat != jac->pmat) { 16349566063dSJacob Faibussowitsch PetscCall(MatDestroyMatrices(jac->nsplits, &jac->mat)); 1635574deadeSBarry Smith } else if (jac->mat) { 16360298fd71SBarry Smith jac->mat = NULL; 1637574deadeSBarry Smith } 16389566063dSJacob Faibussowitsch if (jac->pmat) PetscCall(MatDestroyMatrices(jac->nsplits, &jac->pmat)); 16399566063dSJacob Faibussowitsch if (jac->Afield) PetscCall(MatDestroyMatrices(jac->nsplits, &jac->Afield)); 1640f5f0d762SBarry Smith jac->nsplits = 0; 16419566063dSJacob Faibussowitsch PetscCall(VecDestroy(&jac->w1)); 16429566063dSJacob Faibussowitsch PetscCall(VecDestroy(&jac->w2)); 16439566063dSJacob Faibussowitsch PetscCall(MatDestroy(&jac->schur)); 16449566063dSJacob Faibussowitsch PetscCall(MatDestroy(&jac->schurp)); 16459566063dSJacob Faibussowitsch PetscCall(MatDestroy(&jac->schur_user)); 16469566063dSJacob Faibussowitsch PetscCall(KSPDestroy(&jac->kspschur)); 16479566063dSJacob Faibussowitsch PetscCall(KSPDestroy(&jac->kspupper)); 16489566063dSJacob Faibussowitsch PetscCall(MatDestroy(&jac->B)); 16499566063dSJacob Faibussowitsch PetscCall(MatDestroy(&jac->C)); 16509566063dSJacob Faibussowitsch PetscCall(MatDestroy(&jac->H)); 16519566063dSJacob Faibussowitsch PetscCall(VecDestroy(&jac->u)); 16529566063dSJacob Faibussowitsch PetscCall(VecDestroy(&jac->v)); 16539566063dSJacob Faibussowitsch PetscCall(VecDestroy(&jac->Hu)); 16549566063dSJacob Faibussowitsch PetscCall(VecDestroy(&jac->d)); 16559566063dSJacob Faibussowitsch PetscCall(PetscFree(jac->vecz)); 16569566063dSJacob Faibussowitsch PetscCall(PetscViewerDestroy(&jac->gkbviewer)); 16576dbb499eSCian Wilson jac->isrestrict = PETSC_FALSE; 16583ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 1659574deadeSBarry Smith } 1660574deadeSBarry Smith 1661d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCDestroy_FieldSplit(PC pc) 1662d71ae5a4SJacob Faibussowitsch { 1663574deadeSBarry Smith PetscFunctionBegin; 16649566063dSJacob Faibussowitsch PetscCall(PCReset_FieldSplit(pc)); 16659566063dSJacob Faibussowitsch PetscCall(PetscFree(pc->data)); 16662e956fe4SStefano Zampini PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCSetCoordinates_C", NULL)); 16679566063dSJacob Faibussowitsch PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetFields_C", NULL)); 16689566063dSJacob Faibussowitsch PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetIS_C", NULL)); 16699566063dSJacob Faibussowitsch PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetType_C", NULL)); 16709566063dSJacob Faibussowitsch PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetBlockSize_C", NULL)); 16712e956fe4SStefano Zampini PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitRestrictIS_C", NULL)); 16722e956fe4SStefano Zampini PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSchurGetSubKSP_C", NULL)); 16732e956fe4SStefano Zampini PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitGetSubKSP_C", NULL)); 16742e956fe4SStefano Zampini 16752e956fe4SStefano Zampini PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetGKBTol_C", NULL)); 16762e956fe4SStefano Zampini PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetGKBMaxit_C", NULL)); 16772e956fe4SStefano Zampini PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetGKBNu_C", NULL)); 16782e956fe4SStefano Zampini PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetGKBDelay_C", NULL)); 16792e956fe4SStefano Zampini PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitGetSubKSP_C", NULL)); 16809566063dSJacob Faibussowitsch PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetSchurPre_C", NULL)); 16819566063dSJacob Faibussowitsch PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitGetSchurPre_C", NULL)); 16829566063dSJacob Faibussowitsch PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetSchurFactType_C", NULL)); 16832e956fe4SStefano Zampini PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetSchurScale_C", NULL)); 16843ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 16850971522cSBarry Smith } 16860971522cSBarry Smith 1687d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCSetFromOptions_FieldSplit(PC pc, PetscOptionItems *PetscOptionsObject) 1688d71ae5a4SJacob Faibussowitsch { 16896c924f48SJed Brown PetscInt bs; 16907b752e3dSPatrick Sanan PetscBool flg; 16919dcbbd2bSBarry Smith PC_FieldSplit *jac = (PC_FieldSplit *)pc->data; 16923b224e63SBarry Smith PCCompositeType ctype; 16931b9fc7fcSBarry Smith 16940971522cSBarry Smith PetscFunctionBegin; 1695d0609cedSBarry Smith PetscOptionsHeadBegin(PetscOptionsObject, "FieldSplit options"); 16969566063dSJacob Faibussowitsch PetscCall(PetscOptionsBool("-pc_fieldsplit_dm_splits", "Whether to use DMCreateFieldDecomposition() for splits", "PCFieldSplitSetDMSplits", jac->dm_splits, &jac->dm_splits, NULL)); 16979566063dSJacob Faibussowitsch PetscCall(PetscOptionsInt("-pc_fieldsplit_block_size", "Blocksize that defines number of fields", "PCFieldSplitSetBlockSize", jac->bs, &bs, &flg)); 16981baa6e33SBarry Smith if (flg) PetscCall(PCFieldSplitSetBlockSize(pc, bs)); 16992686e3e9SMatthew G. Knepley jac->diag_use_amat = pc->useAmat; 17009566063dSJacob 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)); 17012686e3e9SMatthew G. Knepley jac->offdiag_use_amat = pc->useAmat; 17029566063dSJacob 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)); 17039566063dSJacob Faibussowitsch PetscCall(PetscOptionsBool("-pc_fieldsplit_detect_saddle_point", "Form 2-way split by detecting zero diagonal entries", "PCFieldSplitSetDetectSaddlePoint", jac->detect, &jac->detect, NULL)); 17049566063dSJacob Faibussowitsch PetscCall(PCFieldSplitSetDetectSaddlePoint(pc, jac->detect)); /* Sets split type and Schur PC type */ 17059566063dSJacob Faibussowitsch PetscCall(PetscOptionsEnum("-pc_fieldsplit_type", "Type of composition", "PCFieldSplitSetType", PCCompositeTypes, (PetscEnum)jac->type, (PetscEnum *)&ctype, &flg)); 17061baa6e33SBarry Smith if (flg) PetscCall(PCFieldSplitSetType(pc, ctype)); 1707c30613efSMatthew Knepley /* Only setup fields once */ 1708c30613efSMatthew Knepley if ((jac->bs > 0) && (jac->nsplits == 0)) { 1709d32f9abdSBarry Smith /* only allow user to set fields from command line if bs is already known. 1710d32f9abdSBarry Smith otherwise user can set them in PCFieldSplitSetDefaults() */ 17119566063dSJacob Faibussowitsch PetscCall(PCFieldSplitSetRuntimeSplits_Private(pc)); 17129566063dSJacob Faibussowitsch if (jac->splitdefined) PetscCall(PetscInfo(pc, "Splits defined using the options database\n")); 1713d32f9abdSBarry Smith } 1714c5d2311dSJed Brown if (jac->type == PC_COMPOSITE_SCHUR) { 17159566063dSJacob Faibussowitsch PetscCall(PetscOptionsGetEnum(((PetscObject)pc)->options, ((PetscObject)pc)->prefix, "-pc_fieldsplit_schur_factorization_type", PCFieldSplitSchurFactTypes, (PetscEnum *)&jac->schurfactorization, &flg)); 17169566063dSJacob Faibussowitsch if (flg) PetscCall(PetscInfo(pc, "Deprecated use of -pc_fieldsplit_schur_factorization_type\n")); 17179566063dSJacob 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)); 17189566063dSJacob Faibussowitsch PetscCall(PetscOptionsEnum("-pc_fieldsplit_schur_precondition", "How to build preconditioner for Schur complement", "PCFieldSplitSetSchurPre", PCFieldSplitSchurPreTypes, (PetscEnum)jac->schurpre, (PetscEnum *)&jac->schurpre, NULL)); 17199566063dSJacob Faibussowitsch PetscCall(PetscOptionsScalar("-pc_fieldsplit_schur_scale", "Scale Schur complement", "PCFieldSplitSetSchurScale", jac->schurscale, &jac->schurscale, NULL)); 1720a51937d4SCarola Kruse } else if (jac->type == PC_COMPOSITE_GKB) { 17219566063dSJacob Faibussowitsch PetscCall(PetscOptionsReal("-pc_fieldsplit_gkb_tol", "The tolerance for the lower bound stopping criterion", "PCFieldSplitGKBTol", jac->gkbtol, &jac->gkbtol, NULL)); 17229566063dSJacob Faibussowitsch PetscCall(PetscOptionsInt("-pc_fieldsplit_gkb_delay", "The delay value for lower bound criterion", "PCFieldSplitGKBDelay", jac->gkbdelay, &jac->gkbdelay, NULL)); 17239566063dSJacob Faibussowitsch PetscCall(PetscOptionsReal("-pc_fieldsplit_gkb_nu", "Parameter in augmented Lagrangian approach", "PCFieldSplitGKBNu", jac->gkbnu, &jac->gkbnu, NULL)); 172463a3b9bcSJacob Faibussowitsch PetscCheck(jac->gkbnu >= 0, PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "nu cannot be less than 0: value %g", (double)jac->gkbnu); 17259566063dSJacob Faibussowitsch PetscCall(PetscOptionsInt("-pc_fieldsplit_gkb_maxit", "Maximum allowed number of iterations", "PCFieldSplitGKBMaxit", jac->gkbmaxit, &jac->gkbmaxit, NULL)); 17269566063dSJacob Faibussowitsch PetscCall(PetscOptionsBool("-pc_fieldsplit_gkb_monitor", "Prints number of GKB iterations and error", "PCFieldSplitGKB", jac->gkbmonitor, &jac->gkbmonitor, NULL)); 1727c5d2311dSJed Brown } 172834603f55SBarry Smith /* 172934603f55SBarry Smith In the initial call to this routine the sub-solver data structures do not exist so we cannot call KSPSetFromOptions() on them yet. 173034603f55SBarry 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 173134603f55SBarry Smith is called on the outer solver in case changes were made in the options database 173234603f55SBarry Smith 173334603f55SBarry 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() 173434603f55SBarry 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. 173534603f55SBarry Smith Without this extra check test p2p1fetidp_olof_full and others fail with incorrect matrix types. 173634603f55SBarry Smith 173734603f55SBarry Smith There could be a negative side effect of calling the KSPSetFromOptions() below. 173834603f55SBarry Smith 173934603f55SBarry 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 174034603f55SBarry Smith */ 174134603f55SBarry Smith if (jac->issetup) { 174234603f55SBarry Smith PC_FieldSplitLink ilink = jac->head; 174334603f55SBarry Smith if (jac->type == PC_COMPOSITE_SCHUR) { 174434603f55SBarry Smith if (jac->kspupper && jac->kspupper->totalits > 0) PetscCall(KSPSetFromOptions(jac->kspupper)); 174534603f55SBarry Smith if (jac->kspschur && jac->kspschur->totalits > 0) PetscCall(KSPSetFromOptions(jac->kspschur)); 174634603f55SBarry Smith } 174734603f55SBarry Smith while (ilink) { 174834603f55SBarry Smith if (ilink->ksp->totalits > 0) PetscCall(KSPSetFromOptions(ilink->ksp)); 174934603f55SBarry Smith ilink = ilink->next; 175034603f55SBarry Smith } 175134603f55SBarry Smith } 1752d0609cedSBarry Smith PetscOptionsHeadEnd(); 17533ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 17540971522cSBarry Smith } 17550971522cSBarry Smith 1756d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCFieldSplitSetFields_FieldSplit(PC pc, const char splitname[], PetscInt n, const PetscInt *fields, const PetscInt *fields_col) 1757d71ae5a4SJacob Faibussowitsch { 175897bbdb24SBarry Smith PC_FieldSplit *jac = (PC_FieldSplit *)pc->data; 17595a9f2f41SSatish Balay PC_FieldSplitLink ilink, next = jac->head; 176069a612a9SBarry Smith char prefix[128]; 17615d4c12cdSJungho Lee PetscInt i; 17620971522cSBarry Smith 17630971522cSBarry Smith PetscFunctionBegin; 17646c924f48SJed Brown if (jac->splitdefined) { 17659566063dSJacob Faibussowitsch PetscCall(PetscInfo(pc, "Ignoring new split \"%s\" because the splits have already been defined\n", splitname)); 17663ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 17676c924f48SJed Brown } 176851f519a2SBarry Smith for (i = 0; i < n; i++) { 176963a3b9bcSJacob 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); 177063a3b9bcSJacob Faibussowitsch PetscCheck(fields[i] >= 0, PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Negative field %" PetscInt_FMT " requested", fields[i]); 177151f519a2SBarry Smith } 17729566063dSJacob Faibussowitsch PetscCall(PetscNew(&ilink)); 1773a04f6461SBarry Smith if (splitname) { 17749566063dSJacob Faibussowitsch PetscCall(PetscStrallocpy(splitname, &ilink->splitname)); 1775a04f6461SBarry Smith } else { 17769566063dSJacob Faibussowitsch PetscCall(PetscMalloc1(3, &ilink->splitname)); 177763a3b9bcSJacob Faibussowitsch PetscCall(PetscSNPrintf(ilink->splitname, 2, "%" PetscInt_FMT, jac->nsplits)); 1778a04f6461SBarry Smith } 17799df09d43SBarry 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 */ 17809566063dSJacob Faibussowitsch PetscCall(PetscMalloc1(n, &ilink->fields)); 17819566063dSJacob Faibussowitsch PetscCall(PetscArraycpy(ilink->fields, fields, n)); 17829566063dSJacob Faibussowitsch PetscCall(PetscMalloc1(n, &ilink->fields_col)); 17839566063dSJacob Faibussowitsch PetscCall(PetscArraycpy(ilink->fields_col, fields_col, n)); 17842fa5cd67SKarl Rupp 17855a9f2f41SSatish Balay ilink->nfields = n; 17860298fd71SBarry Smith ilink->next = NULL; 17879566063dSJacob Faibussowitsch PetscCall(KSPCreate(PetscObjectComm((PetscObject)pc), &ilink->ksp)); 17889566063dSJacob Faibussowitsch PetscCall(KSPSetErrorIfNotConverged(ilink->ksp, pc->erroriffailure)); 17899566063dSJacob Faibussowitsch PetscCall(PetscObjectIncrementTabLevel((PetscObject)ilink->ksp, (PetscObject)pc, 1)); 17909566063dSJacob Faibussowitsch PetscCall(KSPSetType(ilink->ksp, KSPPREONLY)); 179169a612a9SBarry Smith 17929566063dSJacob Faibussowitsch PetscCall(PetscSNPrintf(prefix, sizeof(prefix), "%sfieldsplit_%s_", ((PetscObject)pc)->prefix ? ((PetscObject)pc)->prefix : "", ilink->splitname)); 17939566063dSJacob Faibussowitsch PetscCall(KSPSetOptionsPrefix(ilink->ksp, prefix)); 17940971522cSBarry Smith 17950971522cSBarry Smith if (!next) { 17965a9f2f41SSatish Balay jac->head = ilink; 17970298fd71SBarry Smith ilink->previous = NULL; 17980971522cSBarry Smith } else { 1799ad540459SPierre Jolivet while (next->next) next = next->next; 18005a9f2f41SSatish Balay next->next = ilink; 180151f519a2SBarry Smith ilink->previous = next; 18020971522cSBarry Smith } 18030971522cSBarry Smith jac->nsplits++; 18043ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 18050971522cSBarry Smith } 18060971522cSBarry Smith 1807d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCFieldSplitSchurGetSubKSP_FieldSplit(PC pc, PetscInt *n, KSP **subksp) 1808d71ae5a4SJacob Faibussowitsch { 1809285fb4e2SStefano Zampini PC_FieldSplit *jac = (PC_FieldSplit *)pc->data; 1810285fb4e2SStefano Zampini 1811285fb4e2SStefano Zampini PetscFunctionBegin; 1812285fb4e2SStefano Zampini *subksp = NULL; 1813285fb4e2SStefano Zampini if (n) *n = 0; 1814285fb4e2SStefano Zampini if (jac->type == PC_COMPOSITE_SCHUR) { 1815285fb4e2SStefano Zampini PetscInt nn; 1816285fb4e2SStefano Zampini 181728b400f6SJacob Faibussowitsch PetscCheck(jac->schur, PetscObjectComm((PetscObject)pc), PETSC_ERR_ARG_WRONGSTATE, "Must call KSPSetUp() or PCSetUp() before calling PCFieldSplitSchurGetSubKSP()"); 181863a3b9bcSJacob Faibussowitsch PetscCheck(jac->nsplits == 2, PetscObjectComm((PetscObject)pc), PETSC_ERR_PLIB, "Unexpected number of splits %" PetscInt_FMT " != 2", jac->nsplits); 1819285fb4e2SStefano Zampini nn = jac->nsplits + (jac->kspupper != jac->head->ksp ? 1 : 0); 18209566063dSJacob Faibussowitsch PetscCall(PetscMalloc1(nn, subksp)); 1821285fb4e2SStefano Zampini (*subksp)[0] = jac->head->ksp; 1822285fb4e2SStefano Zampini (*subksp)[1] = jac->kspschur; 1823285fb4e2SStefano Zampini if (jac->kspupper != jac->head->ksp) (*subksp)[2] = jac->kspupper; 1824285fb4e2SStefano Zampini if (n) *n = nn; 1825285fb4e2SStefano Zampini } 18263ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 1827285fb4e2SStefano Zampini } 1828285fb4e2SStefano Zampini 1829d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCFieldSplitGetSubKSP_FieldSplit_Schur(PC pc, PetscInt *n, KSP **subksp) 1830d71ae5a4SJacob Faibussowitsch { 1831e69d4d44SBarry Smith PC_FieldSplit *jac = (PC_FieldSplit *)pc->data; 1832e69d4d44SBarry Smith 1833e69d4d44SBarry Smith PetscFunctionBegin; 183428b400f6SJacob Faibussowitsch PetscCheck(jac->schur, PetscObjectComm((PetscObject)pc), PETSC_ERR_ARG_WRONGSTATE, "Must call KSPSetUp() or PCSetUp() before calling PCFieldSplitGetSubKSP()"); 18359566063dSJacob Faibussowitsch PetscCall(PetscMalloc1(jac->nsplits, subksp)); 18369566063dSJacob Faibussowitsch PetscCall(MatSchurComplementGetKSP(jac->schur, *subksp)); 18372fa5cd67SKarl Rupp 1838e69d4d44SBarry Smith (*subksp)[1] = jac->kspschur; 183913e0d083SBarry Smith if (n) *n = jac->nsplits; 18403ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 1841e69d4d44SBarry Smith } 18420971522cSBarry Smith 1843d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCFieldSplitGetSubKSP_FieldSplit(PC pc, PetscInt *n, KSP **subksp) 1844d71ae5a4SJacob Faibussowitsch { 18450971522cSBarry Smith PC_FieldSplit *jac = (PC_FieldSplit *)pc->data; 18460971522cSBarry Smith PetscInt cnt = 0; 18475a9f2f41SSatish Balay PC_FieldSplitLink ilink = jac->head; 18480971522cSBarry Smith 18490971522cSBarry Smith PetscFunctionBegin; 18509566063dSJacob Faibussowitsch PetscCall(PetscMalloc1(jac->nsplits, subksp)); 18515a9f2f41SSatish Balay while (ilink) { 18525a9f2f41SSatish Balay (*subksp)[cnt++] = ilink->ksp; 18535a9f2f41SSatish Balay ilink = ilink->next; 18540971522cSBarry Smith } 185563a3b9bcSJacob 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); 185613e0d083SBarry Smith if (n) *n = jac->nsplits; 18573ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 18580971522cSBarry Smith } 18590971522cSBarry Smith 18606dbb499eSCian Wilson /*@C 1861f1580f4eSBarry Smith PCFieldSplitRestrictIS - Restricts the fieldsplit `IS`s to be within a given `IS`. 18626dbb499eSCian Wilson 18636dbb499eSCian Wilson Input Parameters: 18646dbb499eSCian Wilson + pc - the preconditioner context 1865feefa0e1SJacob Faibussowitsch - isy - the index set that defines the indices to which the fieldsplit is to be restricted 18666dbb499eSCian Wilson 18676dbb499eSCian Wilson Level: advanced 18686dbb499eSCian Wilson 1869feefa0e1SJacob Faibussowitsch Developer Notes: 1870f1580f4eSBarry Smith It seems the resulting `IS`s will not cover the entire space, so 1871f1580f4eSBarry Smith how can they define a convergent preconditioner? Needs explaining. 1872f1580f4eSBarry Smith 187360f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PCFIELDSPLIT`, `PCFieldSplitSetFields()`, `PCFieldSplitSetIS()` 18746dbb499eSCian Wilson @*/ 1875d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitRestrictIS(PC pc, IS isy) 1876d71ae5a4SJacob Faibussowitsch { 18776dbb499eSCian Wilson PetscFunctionBegin; 18786dbb499eSCian Wilson PetscValidHeaderSpecific(pc, PC_CLASSID, 1); 18796dbb499eSCian Wilson PetscValidHeaderSpecific(isy, IS_CLASSID, 2); 1880cac4c232SBarry Smith PetscTryMethod(pc, "PCFieldSplitRestrictIS_C", (PC, IS), (pc, isy)); 18813ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 18826dbb499eSCian Wilson } 18836dbb499eSCian Wilson 1884d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCFieldSplitRestrictIS_FieldSplit(PC pc, IS isy) 1885d71ae5a4SJacob Faibussowitsch { 18866dbb499eSCian Wilson PC_FieldSplit *jac = (PC_FieldSplit *)pc->data; 18876dbb499eSCian Wilson PC_FieldSplitLink ilink = jac->head, next; 18886dbb499eSCian Wilson PetscInt localsize, size, sizez, i; 18896dbb499eSCian Wilson const PetscInt *ind, *indz; 18906dbb499eSCian Wilson PetscInt *indc, *indcz; 18916dbb499eSCian Wilson PetscBool flg; 18926dbb499eSCian Wilson 18936dbb499eSCian Wilson PetscFunctionBegin; 18949566063dSJacob Faibussowitsch PetscCall(ISGetLocalSize(isy, &localsize)); 18959566063dSJacob Faibussowitsch PetscCallMPI(MPI_Scan(&localsize, &size, 1, MPIU_INT, MPI_SUM, PetscObjectComm((PetscObject)isy))); 18966dbb499eSCian Wilson size -= localsize; 18976dbb499eSCian Wilson while (ilink) { 18986dbb499eSCian Wilson IS isrl, isr; 18991c7cfba8SBarry Smith PC subpc; 19009566063dSJacob Faibussowitsch PetscCall(ISEmbed(ilink->is, isy, PETSC_TRUE, &isrl)); 19019566063dSJacob Faibussowitsch PetscCall(ISGetLocalSize(isrl, &localsize)); 19029566063dSJacob Faibussowitsch PetscCall(PetscMalloc1(localsize, &indc)); 19039566063dSJacob Faibussowitsch PetscCall(ISGetIndices(isrl, &ind)); 19049566063dSJacob Faibussowitsch PetscCall(PetscArraycpy(indc, ind, localsize)); 19059566063dSJacob Faibussowitsch PetscCall(ISRestoreIndices(isrl, &ind)); 19069566063dSJacob Faibussowitsch PetscCall(ISDestroy(&isrl)); 19076dbb499eSCian Wilson for (i = 0; i < localsize; i++) *(indc + i) += size; 19089566063dSJacob Faibussowitsch PetscCall(ISCreateGeneral(PetscObjectComm((PetscObject)isy), localsize, indc, PETSC_OWN_POINTER, &isr)); 19099566063dSJacob Faibussowitsch PetscCall(PetscObjectReference((PetscObject)isr)); 19109566063dSJacob Faibussowitsch PetscCall(ISDestroy(&ilink->is)); 19116dbb499eSCian Wilson ilink->is = isr; 19129566063dSJacob Faibussowitsch PetscCall(PetscObjectReference((PetscObject)isr)); 19139566063dSJacob Faibussowitsch PetscCall(ISDestroy(&ilink->is_col)); 19146dbb499eSCian Wilson ilink->is_col = isr; 19159566063dSJacob Faibussowitsch PetscCall(ISDestroy(&isr)); 19169566063dSJacob Faibussowitsch PetscCall(KSPGetPC(ilink->ksp, &subpc)); 19179566063dSJacob Faibussowitsch PetscCall(PetscObjectTypeCompare((PetscObject)subpc, PCFIELDSPLIT, &flg)); 19186dbb499eSCian Wilson if (flg) { 19196dbb499eSCian Wilson IS iszl, isz; 19206dbb499eSCian Wilson MPI_Comm comm; 19219566063dSJacob Faibussowitsch PetscCall(ISGetLocalSize(ilink->is, &localsize)); 19226dbb499eSCian Wilson comm = PetscObjectComm((PetscObject)ilink->is); 19239566063dSJacob Faibussowitsch PetscCall(ISEmbed(isy, ilink->is, PETSC_TRUE, &iszl)); 19249566063dSJacob Faibussowitsch PetscCallMPI(MPI_Scan(&localsize, &sizez, 1, MPIU_INT, MPI_SUM, comm)); 19256dbb499eSCian Wilson sizez -= localsize; 19269566063dSJacob Faibussowitsch PetscCall(ISGetLocalSize(iszl, &localsize)); 19279566063dSJacob Faibussowitsch PetscCall(PetscMalloc1(localsize, &indcz)); 19289566063dSJacob Faibussowitsch PetscCall(ISGetIndices(iszl, &indz)); 19299566063dSJacob Faibussowitsch PetscCall(PetscArraycpy(indcz, indz, localsize)); 19309566063dSJacob Faibussowitsch PetscCall(ISRestoreIndices(iszl, &indz)); 19319566063dSJacob Faibussowitsch PetscCall(ISDestroy(&iszl)); 19326dbb499eSCian Wilson for (i = 0; i < localsize; i++) *(indcz + i) += sizez; 19339566063dSJacob Faibussowitsch PetscCall(ISCreateGeneral(comm, localsize, indcz, PETSC_OWN_POINTER, &isz)); 19349566063dSJacob Faibussowitsch PetscCall(PCFieldSplitRestrictIS(subpc, isz)); 19359566063dSJacob Faibussowitsch PetscCall(ISDestroy(&isz)); 19366dbb499eSCian Wilson } 19376dbb499eSCian Wilson next = ilink->next; 19386dbb499eSCian Wilson ilink = next; 19396dbb499eSCian Wilson } 19406dbb499eSCian Wilson jac->isrestrict = PETSC_TRUE; 19413ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 19426dbb499eSCian Wilson } 19436dbb499eSCian Wilson 1944d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCFieldSplitSetIS_FieldSplit(PC pc, const char splitname[], IS is) 1945d71ae5a4SJacob Faibussowitsch { 1946704ba839SBarry Smith PC_FieldSplit *jac = (PC_FieldSplit *)pc->data; 1947704ba839SBarry Smith PC_FieldSplitLink ilink, next = jac->head; 1948704ba839SBarry Smith char prefix[128]; 1949704ba839SBarry Smith 1950704ba839SBarry Smith PetscFunctionBegin; 19516c924f48SJed Brown if (jac->splitdefined) { 19529566063dSJacob Faibussowitsch PetscCall(PetscInfo(pc, "Ignoring new split \"%s\" because the splits have already been defined\n", splitname)); 19533ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 19546c924f48SJed Brown } 19559566063dSJacob Faibussowitsch PetscCall(PetscNew(&ilink)); 1956a04f6461SBarry Smith if (splitname) { 19579566063dSJacob Faibussowitsch PetscCall(PetscStrallocpy(splitname, &ilink->splitname)); 1958a04f6461SBarry Smith } else { 19599566063dSJacob Faibussowitsch PetscCall(PetscMalloc1(8, &ilink->splitname)); 196063a3b9bcSJacob Faibussowitsch PetscCall(PetscSNPrintf(ilink->splitname, 7, "%" PetscInt_FMT, jac->nsplits)); 1961a04f6461SBarry Smith } 19629df09d43SBarry 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 */ 19639566063dSJacob Faibussowitsch PetscCall(PetscObjectReference((PetscObject)is)); 19649566063dSJacob Faibussowitsch PetscCall(ISDestroy(&ilink->is)); 1965b5787286SJed Brown ilink->is = is; 19669566063dSJacob Faibussowitsch PetscCall(PetscObjectReference((PetscObject)is)); 19679566063dSJacob Faibussowitsch PetscCall(ISDestroy(&ilink->is_col)); 1968b5787286SJed Brown ilink->is_col = is; 19690298fd71SBarry Smith ilink->next = NULL; 19709566063dSJacob Faibussowitsch PetscCall(KSPCreate(PetscObjectComm((PetscObject)pc), &ilink->ksp)); 19719566063dSJacob Faibussowitsch PetscCall(KSPSetErrorIfNotConverged(ilink->ksp, pc->erroriffailure)); 19729566063dSJacob Faibussowitsch PetscCall(PetscObjectIncrementTabLevel((PetscObject)ilink->ksp, (PetscObject)pc, 1)); 19739566063dSJacob Faibussowitsch PetscCall(KSPSetType(ilink->ksp, KSPPREONLY)); 1974704ba839SBarry Smith 19759566063dSJacob Faibussowitsch PetscCall(PetscSNPrintf(prefix, sizeof(prefix), "%sfieldsplit_%s_", ((PetscObject)pc)->prefix ? ((PetscObject)pc)->prefix : "", ilink->splitname)); 19769566063dSJacob Faibussowitsch PetscCall(KSPSetOptionsPrefix(ilink->ksp, prefix)); 1977704ba839SBarry Smith 1978704ba839SBarry Smith if (!next) { 1979704ba839SBarry Smith jac->head = ilink; 19800298fd71SBarry Smith ilink->previous = NULL; 1981704ba839SBarry Smith } else { 1982ad540459SPierre Jolivet while (next->next) next = next->next; 1983704ba839SBarry Smith next->next = ilink; 1984704ba839SBarry Smith ilink->previous = next; 1985704ba839SBarry Smith } 1986704ba839SBarry Smith jac->nsplits++; 19873ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 1988704ba839SBarry Smith } 1989704ba839SBarry Smith 199094ef8ddeSSatish Balay /*@C 199160f59c3bSBarry Smith PCFieldSplitSetFields - Sets the fields that define one particular split in `PCFIELDSPLIT` 19920971522cSBarry Smith 1993c3339decSBarry Smith Logically Collective 19940971522cSBarry Smith 19950971522cSBarry Smith Input Parameters: 19960971522cSBarry Smith + pc - the preconditioner context 199760f59c3bSBarry Smith . splitname - name of this split, if `NULL` the number of the split is used 19980971522cSBarry Smith . n - the number of fields in this split 19993b374dbdSBarry Smith . fields - the fields in this split 20003b374dbdSBarry 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 20013b374dbdSBarry Smith of the matrix and fields_col provides the column indices for that block 20020971522cSBarry Smith 20030971522cSBarry Smith Level: intermediate 20040971522cSBarry Smith 200595452b02SPatrick Sanan Notes: 2006f1580f4eSBarry Smith Use `PCFieldSplitSetIS()` to set a general set of indices as a split. 2007d32f9abdSBarry Smith 2008f1580f4eSBarry Smith `PCFieldSplitSetFields()` is for defining fields as strided blocks. For example, if the block 2009f1580f4eSBarry 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 2010d32f9abdSBarry Smith 0xx3xx6xx9xx12 ... x1xx4xx7xx ... xx2xx5xx8xx.. 01x34x67x... 0x1x3x5x7.. x12x45x78x.... 2011f1580f4eSBarry Smith where the numbered entries indicate what is in the split. 2012d32f9abdSBarry Smith 2013db4c96c1SJed Brown This function is called once per split (it creates a new split each time). Solve options 201460f59c3bSBarry Smith for this split will be available under the prefix `-fieldsplit_SPLITNAME_`. 2015db4c96c1SJed Brown 20163b374dbdSBarry Smith `PCFieldSplitSetIS()` does not support having a fields_col different from fields 20173b374dbdSBarry Smith 2018feefa0e1SJacob Faibussowitsch Developer Notes: 2019f1580f4eSBarry Smith This routine does not actually create the `IS` representing the split, that is delayed 2020f1580f4eSBarry Smith until `PCSetUp_FieldSplit()`, because information about the vector/matrix layouts may not be 20215d4c12cdSJungho Lee available when this routine is called. 20225d4c12cdSJungho Lee 202360f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCFieldSplitGetSubKSP()`, `PCFIELDSPLIT`, `PCFieldSplitSetBlockSize()`, `PCFieldSplitSetIS()`, `PCFieldSplitRestrictIS()` 20240971522cSBarry Smith @*/ 2025d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitSetFields(PC pc, const char splitname[], PetscInt n, const PetscInt *fields, const PetscInt *fields_col) 2026d71ae5a4SJacob Faibussowitsch { 20270971522cSBarry Smith PetscFunctionBegin; 20280700a824SBarry Smith PetscValidHeaderSpecific(pc, PC_CLASSID, 1); 2029db4c96c1SJed Brown PetscValidCharPointer(splitname, 2); 203063a3b9bcSJacob Faibussowitsch PetscCheck(n >= 1, PetscObjectComm((PetscObject)pc), PETSC_ERR_ARG_OUTOFRANGE, "Provided number of fields %" PetscInt_FMT " in split \"%s\" not positive", n, splitname); 2031064a246eSJacob Faibussowitsch PetscValidIntPointer(fields, 4); 2032cac4c232SBarry Smith PetscTryMethod(pc, "PCFieldSplitSetFields_C", (PC, const char[], PetscInt, const PetscInt *, const PetscInt *), (pc, splitname, n, fields, fields_col)); 20333ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 20340971522cSBarry Smith } 20350971522cSBarry Smith 2036c84da90fSDmitry Karpeev /*@ 2037f1580f4eSBarry Smith PCFieldSplitSetDiagUseAmat - set flag indicating whether to extract diagonal blocks from Amat (rather than Pmat) to build 2038f1580f4eSBarry Smith the sub-matrices associated with each split. Where `KSPSetOperators`(ksp,Amat,Pmat)) was used to supply the operators. 2039c84da90fSDmitry Karpeev 2040c3339decSBarry Smith Logically Collective 2041c84da90fSDmitry Karpeev 2042c84da90fSDmitry Karpeev Input Parameters: 2043c84da90fSDmitry Karpeev + pc - the preconditioner object 2044c84da90fSDmitry Karpeev - flg - boolean flag indicating whether or not to use Amat to extract the diagonal blocks from 2045c84da90fSDmitry Karpeev 204620f4b53cSBarry Smith Options Database Key: 2047147403d9SBarry Smith . -pc_fieldsplit_diag_use_amat - use the Amat to provide the diagonal blocks 2048c84da90fSDmitry Karpeev 2049c84da90fSDmitry Karpeev Level: intermediate 2050c84da90fSDmitry Karpeev 205160f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCSetOperators()`, `KSPSetOperators()`, `PCFieldSplitGetDiagUseAmat()`, `PCFieldSplitSetOffDiagUseAmat()`, `PCFIELDSPLIT` 2052c84da90fSDmitry Karpeev @*/ 2053d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitSetDiagUseAmat(PC pc, PetscBool flg) 2054d71ae5a4SJacob Faibussowitsch { 2055c84da90fSDmitry Karpeev PC_FieldSplit *jac = (PC_FieldSplit *)pc->data; 2056c84da90fSDmitry Karpeev PetscBool isfs; 2057c84da90fSDmitry Karpeev 2058c84da90fSDmitry Karpeev PetscFunctionBegin; 2059c84da90fSDmitry Karpeev PetscValidHeaderSpecific(pc, PC_CLASSID, 1); 20609566063dSJacob Faibussowitsch PetscCall(PetscObjectTypeCompare((PetscObject)pc, PCFIELDSPLIT, &isfs)); 206128b400f6SJacob Faibussowitsch PetscCheck(isfs, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "PC not of type %s", PCFIELDSPLIT); 2062c84da90fSDmitry Karpeev jac->diag_use_amat = flg; 20633ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 2064c84da90fSDmitry Karpeev } 2065c84da90fSDmitry Karpeev 2066c84da90fSDmitry Karpeev /*@ 2067f1580f4eSBarry Smith PCFieldSplitGetDiagUseAmat - get the flag indicating whether to extract diagonal blocks from Amat (rather than Pmat) to build 2068f1580f4eSBarry Smith the sub-matrices associated with each split. Where `KSPSetOperators`(ksp,Amat,Pmat)) was used to supply the operators. 2069c84da90fSDmitry Karpeev 2070c3339decSBarry Smith Logically Collective 2071c84da90fSDmitry Karpeev 207220f4b53cSBarry Smith Input Parameter: 2073c84da90fSDmitry Karpeev . pc - the preconditioner object 2074c84da90fSDmitry Karpeev 207520f4b53cSBarry Smith Output Parameter: 2076c84da90fSDmitry Karpeev . flg - boolean flag indicating whether or not to use Amat to extract the diagonal blocks from 2077c84da90fSDmitry Karpeev 2078c84da90fSDmitry Karpeev Level: intermediate 2079c84da90fSDmitry Karpeev 208060f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCSetOperators()`, `KSPSetOperators()`, `PCFieldSplitSetDiagUseAmat()`, `PCFieldSplitGetOffDiagUseAmat()`, `PCFIELDSPLIT` 2081c84da90fSDmitry Karpeev @*/ 2082d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitGetDiagUseAmat(PC pc, PetscBool *flg) 2083d71ae5a4SJacob Faibussowitsch { 2084c84da90fSDmitry Karpeev PC_FieldSplit *jac = (PC_FieldSplit *)pc->data; 2085c84da90fSDmitry Karpeev PetscBool isfs; 2086c84da90fSDmitry Karpeev 2087c84da90fSDmitry Karpeev PetscFunctionBegin; 2088c84da90fSDmitry Karpeev PetscValidHeaderSpecific(pc, PC_CLASSID, 1); 2089534a8f05SLisandro Dalcin PetscValidBoolPointer(flg, 2); 20909566063dSJacob Faibussowitsch PetscCall(PetscObjectTypeCompare((PetscObject)pc, PCFIELDSPLIT, &isfs)); 209128b400f6SJacob Faibussowitsch PetscCheck(isfs, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "PC not of type %s", PCFIELDSPLIT); 2092c84da90fSDmitry Karpeev *flg = jac->diag_use_amat; 20933ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 2094c84da90fSDmitry Karpeev } 2095c84da90fSDmitry Karpeev 2096c84da90fSDmitry Karpeev /*@ 2097f1580f4eSBarry Smith PCFieldSplitSetOffDiagUseAmat - set flag indicating whether to extract off-diagonal blocks from Amat (rather than Pmat) to build 2098f1580f4eSBarry Smith the sub-matrices associated with each split. Where `KSPSetOperators`(ksp,Amat,Pmat)) was used to supply the operators. 2099c84da90fSDmitry Karpeev 2100c3339decSBarry Smith Logically Collective 2101c84da90fSDmitry Karpeev 2102c84da90fSDmitry Karpeev Input Parameters: 2103c84da90fSDmitry Karpeev + pc - the preconditioner object 2104c84da90fSDmitry Karpeev - flg - boolean flag indicating whether or not to use Amat to extract the off-diagonal blocks from 2105c84da90fSDmitry Karpeev 210620f4b53cSBarry Smith Options Database Key: 2107147403d9SBarry Smith . -pc_fieldsplit_off_diag_use_amat <bool> - use the Amat to extract the off-diagonal blocks 2108c84da90fSDmitry Karpeev 2109c84da90fSDmitry Karpeev Level: intermediate 2110c84da90fSDmitry Karpeev 211160f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCSetOperators()`, `KSPSetOperators()`, `PCFieldSplitGetOffDiagUseAmat()`, `PCFieldSplitSetDiagUseAmat()`, `PCFIELDSPLIT` 2112c84da90fSDmitry Karpeev @*/ 2113d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitSetOffDiagUseAmat(PC pc, PetscBool flg) 2114d71ae5a4SJacob Faibussowitsch { 2115c84da90fSDmitry Karpeev PC_FieldSplit *jac = (PC_FieldSplit *)pc->data; 2116c84da90fSDmitry Karpeev PetscBool isfs; 2117c84da90fSDmitry Karpeev 2118c84da90fSDmitry Karpeev PetscFunctionBegin; 2119c84da90fSDmitry Karpeev PetscValidHeaderSpecific(pc, PC_CLASSID, 1); 21209566063dSJacob Faibussowitsch PetscCall(PetscObjectTypeCompare((PetscObject)pc, PCFIELDSPLIT, &isfs)); 212128b400f6SJacob Faibussowitsch PetscCheck(isfs, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "PC not of type %s", PCFIELDSPLIT); 2122c84da90fSDmitry Karpeev jac->offdiag_use_amat = flg; 21233ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 2124c84da90fSDmitry Karpeev } 2125c84da90fSDmitry Karpeev 2126c84da90fSDmitry Karpeev /*@ 2127f1580f4eSBarry Smith PCFieldSplitGetOffDiagUseAmat - get the flag indicating whether to extract off-diagonal blocks from Amat (rather than Pmat) to build 2128f1580f4eSBarry Smith the sub-matrices associated with each split. Where `KSPSetOperators`(ksp,Amat,Pmat)) was used to supply the operators. 2129c84da90fSDmitry Karpeev 2130c3339decSBarry Smith Logically Collective 2131c84da90fSDmitry Karpeev 213220f4b53cSBarry Smith Input Parameter: 2133c84da90fSDmitry Karpeev . pc - the preconditioner object 2134c84da90fSDmitry Karpeev 213520f4b53cSBarry Smith Output Parameter: 2136c84da90fSDmitry Karpeev . flg - boolean flag indicating whether or not to use Amat to extract the off-diagonal blocks from 2137c84da90fSDmitry Karpeev 2138c84da90fSDmitry Karpeev Level: intermediate 2139c84da90fSDmitry Karpeev 214060f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCSetOperators()`, `KSPSetOperators()`, `PCFieldSplitSetOffDiagUseAmat()`, `PCFieldSplitGetDiagUseAmat()`, `PCFIELDSPLIT` 2141c84da90fSDmitry Karpeev @*/ 2142d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitGetOffDiagUseAmat(PC pc, PetscBool *flg) 2143d71ae5a4SJacob Faibussowitsch { 2144c84da90fSDmitry Karpeev PC_FieldSplit *jac = (PC_FieldSplit *)pc->data; 2145c84da90fSDmitry Karpeev PetscBool isfs; 2146c84da90fSDmitry Karpeev 2147c84da90fSDmitry Karpeev PetscFunctionBegin; 2148c84da90fSDmitry Karpeev PetscValidHeaderSpecific(pc, PC_CLASSID, 1); 2149534a8f05SLisandro Dalcin PetscValidBoolPointer(flg, 2); 21509566063dSJacob Faibussowitsch PetscCall(PetscObjectTypeCompare((PetscObject)pc, PCFIELDSPLIT, &isfs)); 215128b400f6SJacob Faibussowitsch PetscCheck(isfs, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "PC not of type %s", PCFIELDSPLIT); 2152c84da90fSDmitry Karpeev *flg = jac->offdiag_use_amat; 21533ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 2154c84da90fSDmitry Karpeev } 2155c84da90fSDmitry Karpeev 2156218d4943SBarry Smith /*@C 2157f1580f4eSBarry Smith PCFieldSplitSetIS - Sets the exact elements for a split in a `PCFIELDSPLIT` 2158704ba839SBarry Smith 2159c3339decSBarry Smith Logically Collective 2160704ba839SBarry Smith 2161704ba839SBarry Smith Input Parameters: 2162704ba839SBarry Smith + pc - the preconditioner context 216360f59c3bSBarry Smith . splitname - name of this split, if `NULL` the number of the split is used 2164f1580f4eSBarry Smith - is - the index set that defines the elements in this split 2165704ba839SBarry Smith 216660f59c3bSBarry Smith Level: intermediate 216760f59c3bSBarry Smith 2168a6ffb8dbSJed Brown Notes: 2169f1580f4eSBarry Smith Use `PCFieldSplitSetFields()`, for splits defined by strided types. 2170a6ffb8dbSJed Brown 2171db4c96c1SJed Brown This function is called once per split (it creates a new split each time). Solve options 2172db4c96c1SJed Brown for this split will be available under the prefix -fieldsplit_SPLITNAME_. 2173d32f9abdSBarry Smith 217460f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCFieldSplitGetSubKSP()`, `PCFIELDSPLIT`, `PCFieldSplitSetBlockSize()` 2175704ba839SBarry Smith @*/ 2176d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitSetIS(PC pc, const char splitname[], IS is) 2177d71ae5a4SJacob Faibussowitsch { 2178704ba839SBarry Smith PetscFunctionBegin; 21790700a824SBarry Smith PetscValidHeaderSpecific(pc, PC_CLASSID, 1); 21807b62db95SJungho Lee if (splitname) PetscValidCharPointer(splitname, 2); 2181db4c96c1SJed Brown PetscValidHeaderSpecific(is, IS_CLASSID, 3); 2182cac4c232SBarry Smith PetscTryMethod(pc, "PCFieldSplitSetIS_C", (PC, const char[], IS), (pc, splitname, is)); 21833ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 2184704ba839SBarry Smith } 2185704ba839SBarry Smith 218694ef8ddeSSatish Balay /*@C 2187f1580f4eSBarry Smith PCFieldSplitGetIS - Retrieves the elements for a split as an `IS` 218857a9adfeSMatthew G Knepley 2189c3339decSBarry Smith Logically Collective 219057a9adfeSMatthew G Knepley 219157a9adfeSMatthew G Knepley Input Parameters: 219257a9adfeSMatthew G Knepley + pc - the preconditioner context 219357a9adfeSMatthew G Knepley - splitname - name of this split 219457a9adfeSMatthew G Knepley 219557a9adfeSMatthew G Knepley Output Parameter: 2196feefa0e1SJacob Faibussowitsch . is - the index set that defines the elements in this split, or `NULL` if the split is not found 219757a9adfeSMatthew G Knepley 219857a9adfeSMatthew G Knepley Level: intermediate 219957a9adfeSMatthew G Knepley 220060f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCFieldSplitGetSubKSP()`, `PCFIELDSPLIT`, `PCFieldSplitSetIS()` 220157a9adfeSMatthew G Knepley @*/ 2202d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitGetIS(PC pc, const char splitname[], IS *is) 2203d71ae5a4SJacob Faibussowitsch { 220457a9adfeSMatthew G Knepley PetscFunctionBegin; 220557a9adfeSMatthew G Knepley PetscValidHeaderSpecific(pc, PC_CLASSID, 1); 220657a9adfeSMatthew G Knepley PetscValidCharPointer(splitname, 2); 220757a9adfeSMatthew G Knepley PetscValidPointer(is, 3); 220857a9adfeSMatthew G Knepley { 220957a9adfeSMatthew G Knepley PC_FieldSplit *jac = (PC_FieldSplit *)pc->data; 221057a9adfeSMatthew G Knepley PC_FieldSplitLink ilink = jac->head; 221157a9adfeSMatthew G Knepley PetscBool found; 221257a9adfeSMatthew G Knepley 22130298fd71SBarry Smith *is = NULL; 221457a9adfeSMatthew G Knepley while (ilink) { 22159566063dSJacob Faibussowitsch PetscCall(PetscStrcmp(ilink->splitname, splitname, &found)); 221657a9adfeSMatthew G Knepley if (found) { 221757a9adfeSMatthew G Knepley *is = ilink->is; 221857a9adfeSMatthew G Knepley break; 221957a9adfeSMatthew G Knepley } 222057a9adfeSMatthew G Knepley ilink = ilink->next; 222157a9adfeSMatthew G Knepley } 222257a9adfeSMatthew G Knepley } 22233ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 222457a9adfeSMatthew G Knepley } 222557a9adfeSMatthew G Knepley 2226998f007dSPierre Jolivet /*@C 2227f1580f4eSBarry Smith PCFieldSplitGetISByIndex - Retrieves the elements for a given split as an `IS` 2228998f007dSPierre Jolivet 2229c3339decSBarry Smith Logically Collective 2230998f007dSPierre Jolivet 2231998f007dSPierre Jolivet Input Parameters: 2232998f007dSPierre Jolivet + pc - the preconditioner context 2233998f007dSPierre Jolivet - index - index of this split 2234998f007dSPierre Jolivet 2235998f007dSPierre Jolivet Output Parameter: 2236feefa0e1SJacob Faibussowitsch . is - the index set that defines the elements in this split 2237998f007dSPierre Jolivet 2238998f007dSPierre Jolivet Level: intermediate 2239998f007dSPierre Jolivet 224060f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCFieldSplitGetSubKSP()`, `PCFIELDSPLIT`, `PCFieldSplitGetIS()`, `PCFieldSplitSetIS()` 2241998f007dSPierre Jolivet @*/ 2242d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitGetISByIndex(PC pc, PetscInt index, IS *is) 2243d71ae5a4SJacob Faibussowitsch { 2244998f007dSPierre Jolivet PetscFunctionBegin; 224563a3b9bcSJacob Faibussowitsch PetscCheck(index >= 0, PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Negative field %" PetscInt_FMT " requested", index); 2246998f007dSPierre Jolivet PetscValidHeaderSpecific(pc, PC_CLASSID, 1); 2247998f007dSPierre Jolivet PetscValidPointer(is, 3); 2248998f007dSPierre Jolivet { 2249998f007dSPierre Jolivet PC_FieldSplit *jac = (PC_FieldSplit *)pc->data; 2250998f007dSPierre Jolivet PC_FieldSplitLink ilink = jac->head; 2251998f007dSPierre Jolivet PetscInt i = 0; 225263a3b9bcSJacob Faibussowitsch PetscCheck(index < jac->nsplits, PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field %" PetscInt_FMT " requested but only %" PetscInt_FMT " exist", index, jac->nsplits); 2253998f007dSPierre Jolivet 2254998f007dSPierre Jolivet while (i < index) { 2255998f007dSPierre Jolivet ilink = ilink->next; 2256998f007dSPierre Jolivet ++i; 2257998f007dSPierre Jolivet } 22589566063dSJacob Faibussowitsch PetscCall(PCFieldSplitGetIS(pc, ilink->splitname, is)); 2259998f007dSPierre Jolivet } 22603ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 2261998f007dSPierre Jolivet } 2262998f007dSPierre Jolivet 226351f519a2SBarry Smith /*@ 226451f519a2SBarry Smith PCFieldSplitSetBlockSize - Sets the block size for defining where fields start in the 2265f1580f4eSBarry Smith fieldsplit preconditioner when calling `PCFieldSplitSetIS()`. If not set the matrix block size is used. 226651f519a2SBarry Smith 2267c3339decSBarry Smith Logically Collective 226851f519a2SBarry Smith 226951f519a2SBarry Smith Input Parameters: 227051f519a2SBarry Smith + pc - the preconditioner context 227151f519a2SBarry Smith - bs - the block size 227251f519a2SBarry Smith 227351f519a2SBarry Smith Level: intermediate 227451f519a2SBarry Smith 227560f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCFieldSplitGetSubKSP()`, `PCFIELDSPLIT`, `PCFieldSplitSetFields()`, `PCFieldSplitSetIS()` 227651f519a2SBarry Smith @*/ 2277d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitSetBlockSize(PC pc, PetscInt bs) 2278d71ae5a4SJacob Faibussowitsch { 227951f519a2SBarry Smith PetscFunctionBegin; 22800700a824SBarry Smith PetscValidHeaderSpecific(pc, PC_CLASSID, 1); 2281c5eb9154SBarry Smith PetscValidLogicalCollectiveInt(pc, bs, 2); 2282cac4c232SBarry Smith PetscTryMethod(pc, "PCFieldSplitSetBlockSize_C", (PC, PetscInt), (pc, bs)); 22833ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 228451f519a2SBarry Smith } 228551f519a2SBarry Smith 22860971522cSBarry Smith /*@C 2287f1580f4eSBarry Smith PCFieldSplitGetSubKSP - Gets the `KSP` contexts for all splits 22880971522cSBarry Smith 2289c3339decSBarry Smith Collective 22900971522cSBarry Smith 22910971522cSBarry Smith Input Parameter: 22920971522cSBarry Smith . pc - the preconditioner context 22930971522cSBarry Smith 22940971522cSBarry Smith Output Parameters: 229513e0d083SBarry Smith + n - the number of splits 2296f1580f4eSBarry Smith - subksp - the array of `KSP` contexts 2297196cc216SBarry Smith 22980971522cSBarry Smith Level: advanced 22990971522cSBarry Smith 2300f1580f4eSBarry Smith Notes: 2301f1580f4eSBarry Smith After `PCFieldSplitGetSubKSP()` the array of `KSP`s is to be freed by the user with `PetscFree()` 2302f1580f4eSBarry Smith (not the `KSP`, just the array that contains them). 2303f1580f4eSBarry Smith 2304f1580f4eSBarry Smith You must call `PCSetUp()` before calling `PCFieldSplitGetSubKSP()`. 2305f1580f4eSBarry Smith 2306f1580f4eSBarry Smith If the fieldsplit is of type `PC_COMPOSITE_SCHUR`, it returns the `KSP` object used inside the 2307f1580f4eSBarry Smith Schur complement and the `KSP` object used to iterate over the Schur complement. 2308f1580f4eSBarry Smith To access all the `KSP` objects used in `PC_COMPOSITE_SCHUR`, use `PCFieldSplitSchurGetSubKSP()`. 2309f1580f4eSBarry Smith 2310f1580f4eSBarry Smith If the fieldsplit is of type `PC_COMPOSITE_GKB`, it returns the `KSP` object used to solve the 2311f1580f4eSBarry Smith inner linear system defined by the matrix H in each loop. 2312f1580f4eSBarry Smith 2313feefa0e1SJacob Faibussowitsch Fortran Notes: 2314f1580f4eSBarry Smith You must pass in a `KSP` array that is large enough to contain all the `KSP`s. 2315f1580f4eSBarry Smith You can call `PCFieldSplitGetSubKSP`(pc,n,`PETSC_NULL_KSP`,ierr) to determine how large the 2316f1580f4eSBarry Smith `KSP` array must be. 2317f1580f4eSBarry Smith 2318feefa0e1SJacob Faibussowitsch Developer Notes: 2319f1580f4eSBarry Smith There should be a `PCFieldSplitRestoreSubKSP()` instead of requiring the user to call `PetscFree()` 2320f1580f4eSBarry Smith 2321f1580f4eSBarry Smith The Fortran interface should be modernized to return directly the array of values. 2322f1580f4eSBarry Smith 232360f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCFIELDSPLIT`, `PCFieldSplitSetFields()`, `PCFieldSplitSetIS()`, `PCFieldSplitSchurGetSubKSP()` 23240971522cSBarry Smith @*/ 2325d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitGetSubKSP(PC pc, PetscInt *n, KSP *subksp[]) 2326d71ae5a4SJacob Faibussowitsch { 23270971522cSBarry Smith PetscFunctionBegin; 23280700a824SBarry Smith PetscValidHeaderSpecific(pc, PC_CLASSID, 1); 232913e0d083SBarry Smith if (n) PetscValidIntPointer(n, 2); 2330cac4c232SBarry Smith PetscUseMethod(pc, "PCFieldSplitGetSubKSP_C", (PC, PetscInt *, KSP **), (pc, n, subksp)); 23313ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 23320971522cSBarry Smith } 23330971522cSBarry Smith 2334285fb4e2SStefano Zampini /*@C 2335f1580f4eSBarry Smith PCFieldSplitSchurGetSubKSP - Gets the `KSP` contexts used inside the Schur complement based `PCFIELDSPLIT` 2336285fb4e2SStefano Zampini 233760f59c3bSBarry Smith Collective 2338285fb4e2SStefano Zampini 2339285fb4e2SStefano Zampini Input Parameter: 2340285fb4e2SStefano Zampini . pc - the preconditioner context 2341285fb4e2SStefano Zampini 2342285fb4e2SStefano Zampini Output Parameters: 2343285fb4e2SStefano Zampini + n - the number of splits 2344f1580f4eSBarry Smith - subksp - the array of `KSP` contexts 2345285fb4e2SStefano Zampini 2346285fb4e2SStefano Zampini Level: advanced 2347285fb4e2SStefano Zampini 2348f1580f4eSBarry Smith Notes: 2349f1580f4eSBarry Smith After `PCFieldSplitSchurGetSubKSP()` the array of `KSP`s is to be freed by the user with `PetscFree()` 2350f1580f4eSBarry Smith (not the `KSP` just the array that contains them). 2351f1580f4eSBarry Smith 2352f1580f4eSBarry Smith You must call `PCSetUp()` before calling `PCFieldSplitSchurGetSubKSP()`. 2353f1580f4eSBarry Smith 2354f1580f4eSBarry Smith If the fieldsplit type is of type `PC_COMPOSITE_SCHUR`, it returns (in order) 2355f1580f4eSBarry Smith + 1 - the `KSP` used for the (1,1) block 2356f1580f4eSBarry Smith . 2 - the `KSP` used for the Schur complement (not the one used for the interior Schur solver) 2357f1580f4eSBarry Smith - 3 - the `KSP` used for the (1,1) block in the upper triangular factor (if different from that of the (1,1) block). 2358f1580f4eSBarry Smith 2359f1580f4eSBarry Smith It returns a null array if the fieldsplit is not of type `PC_COMPOSITE_SCHUR`; in this case, you should use `PCFieldSplitGetSubKSP()`. 2360f1580f4eSBarry Smith 2361feefa0e1SJacob Faibussowitsch Fortran Notes: 2362f1580f4eSBarry Smith You must pass in a `KSP` array that is large enough to contain all the local `KSP`s. 2363f1580f4eSBarry Smith You can call `PCFieldSplitSchurGetSubKSP`(pc,n,`PETSC_NULL_KSP`,ierr) to determine how large the 2364f1580f4eSBarry Smith `KSP` array must be. 2365f1580f4eSBarry Smith 2366f1580f4eSBarry Smith Developer Notes: 2367f1580f4eSBarry Smith There should be a `PCFieldSplitRestoreSubKSP()` instead of requiring the user to call `PetscFree()` 2368f1580f4eSBarry Smith 2369f1580f4eSBarry Smith Should the functionality of `PCFieldSplitSchurGetSubKSP()` and `PCFieldSplitGetSubKSP()` be merged? 2370f1580f4eSBarry Smith 2371f1580f4eSBarry Smith The Fortran interface should be modernized to return directly the array of values. 2372f1580f4eSBarry Smith 237360f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCFIELDSPLIT`, `PCFieldSplitSetFields()`, `PCFieldSplitSetIS()`, `PCFieldSplitGetSubKSP()` 2374285fb4e2SStefano Zampini @*/ 2375d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitSchurGetSubKSP(PC pc, PetscInt *n, KSP *subksp[]) 2376d71ae5a4SJacob Faibussowitsch { 2377285fb4e2SStefano Zampini PetscFunctionBegin; 2378285fb4e2SStefano Zampini PetscValidHeaderSpecific(pc, PC_CLASSID, 1); 2379285fb4e2SStefano Zampini if (n) PetscValidIntPointer(n, 2); 2380cac4c232SBarry Smith PetscUseMethod(pc, "PCFieldSplitSchurGetSubKSP_C", (PC, PetscInt *, KSP **), (pc, n, subksp)); 23813ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 2382285fb4e2SStefano Zampini } 2383285fb4e2SStefano Zampini 2384e69d4d44SBarry Smith /*@ 2385a1e3cbf9SBarry Smith PCFieldSplitSetSchurPre - Indicates from what operator the preconditioner is constructucted for the Schur complement. 2386a1e3cbf9SBarry Smith The default is the A11 matrix. 2387e69d4d44SBarry Smith 2388c3339decSBarry Smith Collective 2389e69d4d44SBarry Smith 2390e69d4d44SBarry Smith Input Parameters: 2391e69d4d44SBarry Smith + pc - the preconditioner context 2392f1580f4eSBarry Smith . ptype - which matrix to use for preconditioning the Schur complement: `PC_FIELDSPLIT_SCHUR_PRE_A11` (default), 2393f1580f4eSBarry Smith `PC_FIELDSPLIT_SCHUR_PRE_SELF`, `PC_FIELDSPLIT_SCHUR_PRE_USER`, 2394f1580f4eSBarry Smith `PC_FIELDSPLIT_SCHUR_PRE_SELFP`, and `PC_FIELDSPLIT_SCHUR_PRE_FULL` 239560f59c3bSBarry Smith - pre - matrix to use for preconditioning, or `NULL` 2396084e4875SJed Brown 2397f1580f4eSBarry Smith Options Database Keys: 2398a1e3cbf9SBarry Smith + -pc_fieldsplit_schur_precondition <self,selfp,user,a11,full> - default is a11. See notes for meaning of various arguments 2399a1e3cbf9SBarry Smith - -fieldsplit_1_pc_type <pctype> - the preconditioner algorithm that is used to construct the preconditioner from the operator 2400e69d4d44SBarry Smith 240160f59c3bSBarry Smith Level: intermediate 240260f59c3bSBarry Smith 2403fd1303e9SJungho Lee Notes: 2404f1580f4eSBarry Smith If ptype is 2405f1580f4eSBarry Smith + a11 - the preconditioner for the Schur complement is generated from the block diagonal part of the preconditioner 2406f1580f4eSBarry Smith matrix associated with the Schur complement (i.e. A11), not the Schur complement matrix 2407f1580f4eSBarry Smith . self - the preconditioner for the Schur complement is generated from the symbolic representation of the Schur complement matrix: 2408da81f932SPierre Jolivet The only preconditioner that currently works with this symbolic representation matrix object is the `PCLSC` 2409f1580f4eSBarry Smith preconditioner 2410f1580f4eSBarry Smith . user - the preconditioner for the Schur complement is generated from the user provided matrix (pre argument 2411f1580f4eSBarry Smith to this function). 2412f1580f4eSBarry Smith . selfp - the preconditioning for the Schur complement is generated from an explicitly-assembled approximation Sp = A11 - A10 inv(diag(A00)) A01 2413f1580f4eSBarry Smith This is only a good preconditioner when diag(A00) is a good preconditioner for A00. Optionally, A00 can be 2414f1580f4eSBarry Smith lumped before extracting the diagonal using the additional option -fieldsplit_1_mat_schur_complement_ainv_type lump 2415f1580f4eSBarry Smith - full - the preconditioner for the Schur complement is generated from the exact Schur complement matrix representation 2416f1580f4eSBarry Smith computed internally by `PCFIELDSPLIT` (this is expensive) 2417f1580f4eSBarry Smith useful mostly as a test that the Schur complement approach can work for your problem 2418fd1303e9SJungho Lee 2419e87fab1bSBarry Smith When solving a saddle point problem, where the A11 block is identically zero, using a11 as the ptype only makes sense 2420fd1303e9SJungho Lee with the additional option -fieldsplit_1_pc_type none. Usually for saddle point problems one would use a ptype of self and 2421a7476a74SDmitry Karpeev -fieldsplit_1_pc_type lsc which uses the least squares commutator to compute a preconditioner for the Schur complement. 2422fd1303e9SJungho Lee 242360f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCFieldSplitGetSchurPre()`, `PCFieldSplitGetSubKSP()`, `PCFIELDSPLIT`, `PCFieldSplitSetFields()`, `PCFieldSplitSchurPreType`, 2424f1580f4eSBarry Smith `MatSchurComplementSetAinvType()`, `PCLSC`, 2425feefa0e1SJacob Faibussowitsch 2426e69d4d44SBarry Smith @*/ 2427d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitSetSchurPre(PC pc, PCFieldSplitSchurPreType ptype, Mat pre) 2428d71ae5a4SJacob Faibussowitsch { 2429e69d4d44SBarry Smith PetscFunctionBegin; 24300700a824SBarry Smith PetscValidHeaderSpecific(pc, PC_CLASSID, 1); 2431cac4c232SBarry Smith PetscTryMethod(pc, "PCFieldSplitSetSchurPre_C", (PC, PCFieldSplitSchurPreType, Mat), (pc, ptype, pre)); 24323ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 2433e69d4d44SBarry Smith } 2434686bed4dSStefano Zampini 2435d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitSchurPrecondition(PC pc, PCFieldSplitSchurPreType ptype, Mat pre) 2436d71ae5a4SJacob Faibussowitsch { 24379371c9d4SSatish Balay return PCFieldSplitSetSchurPre(pc, ptype, pre); 24389371c9d4SSatish Balay } /* Deprecated name */ 2439e69d4d44SBarry Smith 244037a82bf0SJed Brown /*@ 244137a82bf0SJed Brown PCFieldSplitGetSchurPre - For Schur complement fieldsplit, determine how the Schur complement will be 2442f1580f4eSBarry Smith preconditioned. See `PCFieldSplitSetSchurPre()` for details. 244337a82bf0SJed Brown 2444c3339decSBarry Smith Logically Collective 244537a82bf0SJed Brown 2446f899ff85SJose E. Roman Input Parameter: 244737a82bf0SJed Brown . pc - the preconditioner context 244837a82bf0SJed Brown 244937a82bf0SJed Brown Output Parameters: 2450f1580f4eSBarry 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` 2451f408ff4eSRichard Tran Mills - pre - matrix to use for preconditioning (with `PC_FIELDSPLIT_PRE_USER`), or NULL 245237a82bf0SJed Brown 245337a82bf0SJed Brown Level: intermediate 245437a82bf0SJed Brown 245560f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCFieldSplitSetSchurPre()`, `PCFieldSplitGetSubKSP()`, `PCFIELDSPLIT`, `PCFieldSplitSetFields()`, `PCFieldSplitSchurPreType`, `PCLSC`, 2456feefa0e1SJacob Faibussowitsch 245737a82bf0SJed Brown @*/ 2458d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitGetSchurPre(PC pc, PCFieldSplitSchurPreType *ptype, Mat *pre) 2459d71ae5a4SJacob Faibussowitsch { 246037a82bf0SJed Brown PetscFunctionBegin; 246137a82bf0SJed Brown PetscValidHeaderSpecific(pc, PC_CLASSID, 1); 2462cac4c232SBarry Smith PetscUseMethod(pc, "PCFieldSplitGetSchurPre_C", (PC, PCFieldSplitSchurPreType *, Mat *), (pc, ptype, pre)); 24633ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 2464e69d4d44SBarry Smith } 2465e69d4d44SBarry Smith 246645e7fc46SDmitry Karpeev /*@ 2467f1580f4eSBarry Smith PCFieldSplitSchurGetS - extract the `MATSCHURCOMPLEMENT` object used by this `PCFIELDSPLIT` in case it needs to be configured separately 246845e7fc46SDmitry Karpeev 246920f4b53cSBarry Smith Not Collective 247045e7fc46SDmitry Karpeev 247145e7fc46SDmitry Karpeev Input Parameter: 247245e7fc46SDmitry Karpeev . pc - the preconditioner context 247345e7fc46SDmitry Karpeev 247445e7fc46SDmitry Karpeev Output Parameter: 2475470b340bSDmitry Karpeev . S - the Schur complement matrix 247645e7fc46SDmitry Karpeev 247760f59c3bSBarry Smith Level: advanced 247860f59c3bSBarry Smith 2479f1580f4eSBarry Smith Note: 2480f1580f4eSBarry Smith This matrix should not be destroyed using `MatDestroy()`; rather, use `PCFieldSplitSchurRestoreS()`. 248145e7fc46SDmitry Karpeev 248260f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCFieldSplitGetSubKSP()`, `PCFIELDSPLIT`, `PCFieldSplitSchurPreType`, `PCFieldSplitSetSchurPre()`, `MATSCHURCOMPLEMENT`, `PCFieldSplitSchurRestoreS()`, 2483f1580f4eSBarry Smith `MatCreateSchurComplement()`, `MatSchurComplementGetKSP()`, `MatSchurComplementComputeExplicitOperator()`, `MatGetSchurComplement()` 248445e7fc46SDmitry Karpeev @*/ 2485d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitSchurGetS(PC pc, Mat *S) 2486d71ae5a4SJacob Faibussowitsch { 248745e7fc46SDmitry Karpeev const char *t; 248845e7fc46SDmitry Karpeev PetscBool isfs; 248945e7fc46SDmitry Karpeev PC_FieldSplit *jac; 249045e7fc46SDmitry Karpeev 249145e7fc46SDmitry Karpeev PetscFunctionBegin; 249245e7fc46SDmitry Karpeev PetscValidHeaderSpecific(pc, PC_CLASSID, 1); 24939566063dSJacob Faibussowitsch PetscCall(PetscObjectGetType((PetscObject)pc, &t)); 24949566063dSJacob Faibussowitsch PetscCall(PetscStrcmp(t, PCFIELDSPLIT, &isfs)); 249528b400f6SJacob Faibussowitsch PetscCheck(isfs, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "Expected PC of type PCFIELDSPLIT, got %s instead", t); 249645e7fc46SDmitry Karpeev jac = (PC_FieldSplit *)pc->data; 249763a3b9bcSJacob Faibussowitsch PetscCheck(jac->type == PC_COMPOSITE_SCHUR, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "Expected PCFIELDSPLIT of type SCHUR, got %d instead", jac->type); 2498470b340bSDmitry Karpeev if (S) *S = jac->schur; 24993ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 250045e7fc46SDmitry Karpeev } 250145e7fc46SDmitry Karpeev 2502470b340bSDmitry Karpeev /*@ 2503f1580f4eSBarry Smith PCFieldSplitSchurRestoreS - returns the `MATSCHURCOMPLEMENT` matrix used by this `PC` 2504470b340bSDmitry Karpeev 250520f4b53cSBarry Smith Not Collective 2506470b340bSDmitry Karpeev 2507470b340bSDmitry Karpeev Input Parameters: 2508470b340bSDmitry Karpeev + pc - the preconditioner context 2509a2b725a8SWilliam Gropp - S - the Schur complement matrix 2510470b340bSDmitry Karpeev 2511470b340bSDmitry Karpeev Level: advanced 2512470b340bSDmitry Karpeev 251360f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCFieldSplitGetSubKSP()`, `PCFIELDSPLIT`, `PCFieldSplitSchurPreType`, `PCFieldSplitSetSchurPre()`, `MatSchurComplement`, `PCFieldSplitSchurGetS()` 2514470b340bSDmitry Karpeev @*/ 2515d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitSchurRestoreS(PC pc, Mat *S) 2516d71ae5a4SJacob Faibussowitsch { 2517470b340bSDmitry Karpeev const char *t; 2518470b340bSDmitry Karpeev PetscBool isfs; 2519470b340bSDmitry Karpeev PC_FieldSplit *jac; 2520470b340bSDmitry Karpeev 2521470b340bSDmitry Karpeev PetscFunctionBegin; 2522470b340bSDmitry Karpeev PetscValidHeaderSpecific(pc, PC_CLASSID, 1); 25239566063dSJacob Faibussowitsch PetscCall(PetscObjectGetType((PetscObject)pc, &t)); 25249566063dSJacob Faibussowitsch PetscCall(PetscStrcmp(t, PCFIELDSPLIT, &isfs)); 252528b400f6SJacob Faibussowitsch PetscCheck(isfs, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "Expected PC of type PCFIELDSPLIT, got %s instead", t); 2526470b340bSDmitry Karpeev jac = (PC_FieldSplit *)pc->data; 252763a3b9bcSJacob Faibussowitsch PetscCheck(jac->type == PC_COMPOSITE_SCHUR, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "Expected PCFIELDSPLIT of type SCHUR, got %d instead", jac->type); 25287827d75bSBarry Smith PetscCheck(S && (*S == jac->schur), PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "MatSchurComplement restored is not the same as gotten"); 25293ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 2530470b340bSDmitry Karpeev } 2531470b340bSDmitry Karpeev 2532d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCFieldSplitSetSchurPre_FieldSplit(PC pc, PCFieldSplitSchurPreType ptype, Mat pre) 2533d71ae5a4SJacob Faibussowitsch { 2534e69d4d44SBarry Smith PC_FieldSplit *jac = (PC_FieldSplit *)pc->data; 2535e69d4d44SBarry Smith 2536e69d4d44SBarry Smith PetscFunctionBegin; 2537084e4875SJed Brown jac->schurpre = ptype; 2538a7476a74SDmitry Karpeev if (ptype == PC_FIELDSPLIT_SCHUR_PRE_USER && pre) { 25399566063dSJacob Faibussowitsch PetscCall(MatDestroy(&jac->schur_user)); 2540084e4875SJed Brown jac->schur_user = pre; 25419566063dSJacob Faibussowitsch PetscCall(PetscObjectReference((PetscObject)jac->schur_user)); 2542084e4875SJed Brown } 25433ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 2544e69d4d44SBarry Smith } 2545e69d4d44SBarry Smith 2546d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCFieldSplitGetSchurPre_FieldSplit(PC pc, PCFieldSplitSchurPreType *ptype, Mat *pre) 2547d71ae5a4SJacob Faibussowitsch { 254837a82bf0SJed Brown PC_FieldSplit *jac = (PC_FieldSplit *)pc->data; 254937a82bf0SJed Brown 255037a82bf0SJed Brown PetscFunctionBegin; 255137a82bf0SJed Brown *ptype = jac->schurpre; 255237a82bf0SJed Brown *pre = jac->schur_user; 25533ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 255437a82bf0SJed Brown } 255537a82bf0SJed Brown 2556ab1df9f5SJed Brown /*@ 25570ffb0e17SBarry Smith PCFieldSplitSetSchurFactType - sets which blocks of the approximate block factorization to retain in the preconditioner 2558ab1df9f5SJed Brown 2559c3339decSBarry Smith Collective 2560ab1df9f5SJed Brown 2561ab1df9f5SJed Brown Input Parameters: 2562ab1df9f5SJed Brown + pc - the preconditioner context 2563f1580f4eSBarry Smith - ftype - which blocks of factorization to retain, `PC_FIELDSPLIT_SCHUR_FACT_FULL` is default 2564ab1df9f5SJed Brown 2565f1580f4eSBarry Smith Options Database Key: 2566147403d9SBarry Smith . -pc_fieldsplit_schur_fact_type <diag,lower,upper,full> - default is full 2567ab1df9f5SJed Brown 2568ab1df9f5SJed Brown Level: intermediate 2569ab1df9f5SJed Brown 2570ab1df9f5SJed Brown Notes: 2571ab1df9f5SJed Brown The FULL factorization is 2572ab1df9f5SJed Brown 2573147403d9SBarry Smith .vb 2574147403d9SBarry Smith (A B) = (1 0) (A 0) (1 Ainv*B) = L D U 2575147403d9SBarry Smith (C E) (C*Ainv 1) (0 S) (0 1) 2576147403d9SBarry Smith .vb 25770ffb0e17SBarry 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, 257816a05f60SBarry 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)`. 257916a05f60SBarry Smith Sign flipping of S can be turned off with `PCFieldSplitSetSchurScale()`. 2580ab1df9f5SJed Brown 2581147403d9SBarry Smith If A and S are solved exactly 2582147403d9SBarry Smith .vb 2583147403d9SBarry Smith *) FULL factorization is a direct solver. 2584f1580f4eSBarry 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. 2585f1580f4eSBarry 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. 2586147403d9SBarry Smith .ve 2587ab1df9f5SJed Brown 2588f1580f4eSBarry Smith If the iteration count is very low, consider using `KSPFGMRES` or `KSPGCR` which can use one less preconditioner 25890ffb0e17SBarry 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. 25900ffb0e17SBarry Smith 2591f1580f4eSBarry Smith For symmetric problems in which A is positive definite and S is negative definite, DIAG can be used with `KSPMINRES`. 25920ffb0e17SBarry Smith 2593f1580f4eSBarry 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). 2594ab1df9f5SJed Brown 2595ab1df9f5SJed Brown References: 2596606c0280SSatish Balay + * - Murphy, Golub, and Wathen, A note on preconditioning indefinite linear systems, SIAM J. Sci. Comput., 21 (2000). 2597606c0280SSatish Balay - * - Ipsen, A note on preconditioning nonsymmetric matrices, SIAM J. Sci. Comput., 23 (2001). 2598ab1df9f5SJed Brown 259960f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCFieldSplitGetSubKSP()`, `PCFIELDSPLIT`, `PCFieldSplitSetFields()`, `PCFieldSplitSchurPreType`, `PCFieldSplitSetSchurScale()` 2600ab1df9f5SJed Brown @*/ 2601d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitSetSchurFactType(PC pc, PCFieldSplitSchurFactType ftype) 2602d71ae5a4SJacob Faibussowitsch { 2603ab1df9f5SJed Brown PetscFunctionBegin; 2604ab1df9f5SJed Brown PetscValidHeaderSpecific(pc, PC_CLASSID, 1); 2605cac4c232SBarry Smith PetscTryMethod(pc, "PCFieldSplitSetSchurFactType_C", (PC, PCFieldSplitSchurFactType), (pc, ftype)); 26063ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 2607ab1df9f5SJed Brown } 2608ab1df9f5SJed Brown 2609d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCFieldSplitSetSchurFactType_FieldSplit(PC pc, PCFieldSplitSchurFactType ftype) 2610d71ae5a4SJacob Faibussowitsch { 2611ab1df9f5SJed Brown PC_FieldSplit *jac = (PC_FieldSplit *)pc->data; 2612ab1df9f5SJed Brown 2613ab1df9f5SJed Brown PetscFunctionBegin; 2614ab1df9f5SJed Brown jac->schurfactorization = ftype; 26153ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 2616ab1df9f5SJed Brown } 2617ab1df9f5SJed Brown 2618c096484dSStefano Zampini /*@ 2619f1580f4eSBarry Smith PCFieldSplitSetSchurScale - Controls the sign flip of S for `PC_FIELDSPLIT_SCHUR_FACT_DIAG`. 2620c096484dSStefano Zampini 2621c3339decSBarry Smith Collective 2622c096484dSStefano Zampini 2623c096484dSStefano Zampini Input Parameters: 2624c096484dSStefano Zampini + pc - the preconditioner context 2625c096484dSStefano Zampini - scale - scaling factor for the Schur complement 2626c096484dSStefano Zampini 2627f1580f4eSBarry Smith Options Database Key: 2628c096484dSStefano Zampini . -pc_fieldsplit_schur_scale - default is -1.0 2629c096484dSStefano Zampini 2630c096484dSStefano Zampini Level: intermediate 2631c096484dSStefano Zampini 263260f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCFIELDSPLIT`, `PCFieldSplitSetFields()`, `PCFieldSplitSchurFactType`, `PCFieldSplitSetSchurScale()`, `PCFieldSplitSetSchurFactType()` 2633c096484dSStefano Zampini @*/ 2634d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitSetSchurScale(PC pc, PetscScalar scale) 2635d71ae5a4SJacob Faibussowitsch { 2636c096484dSStefano Zampini PetscFunctionBegin; 2637c096484dSStefano Zampini PetscValidHeaderSpecific(pc, PC_CLASSID, 1); 2638c096484dSStefano Zampini PetscValidLogicalCollectiveScalar(pc, scale, 2); 2639cac4c232SBarry Smith PetscTryMethod(pc, "PCFieldSplitSetSchurScale_C", (PC, PetscScalar), (pc, scale)); 26403ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 2641c096484dSStefano Zampini } 2642c096484dSStefano Zampini 2643d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCFieldSplitSetSchurScale_FieldSplit(PC pc, PetscScalar scale) 2644d71ae5a4SJacob Faibussowitsch { 2645c096484dSStefano Zampini PC_FieldSplit *jac = (PC_FieldSplit *)pc->data; 2646c096484dSStefano Zampini 2647c096484dSStefano Zampini PetscFunctionBegin; 2648c096484dSStefano Zampini jac->schurscale = scale; 26493ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 2650c096484dSStefano Zampini } 2651c096484dSStefano Zampini 265230ad9308SMatthew Knepley /*@C 26538c03b21aSDmitry Karpeev PCFieldSplitGetSchurBlocks - Gets all matrix blocks for the Schur complement 265430ad9308SMatthew Knepley 2655c3339decSBarry Smith Collective 265630ad9308SMatthew Knepley 265730ad9308SMatthew Knepley Input Parameter: 265830ad9308SMatthew Knepley . pc - the preconditioner context 265930ad9308SMatthew Knepley 266030ad9308SMatthew Knepley Output Parameters: 2661a04f6461SBarry Smith + A00 - the (0,0) block 2662a04f6461SBarry Smith . A01 - the (0,1) block 2663a04f6461SBarry Smith . A10 - the (1,0) block 2664a04f6461SBarry Smith - A11 - the (1,1) block 266530ad9308SMatthew Knepley 266630ad9308SMatthew Knepley Level: advanced 266730ad9308SMatthew Knepley 266860f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCFIELDSPLIT`, `MatSchurComplementGetSubMatrices()`, `MatSchurComplementSetSubMatrices()` 266930ad9308SMatthew Knepley @*/ 2670d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitGetSchurBlocks(PC pc, Mat *A00, Mat *A01, Mat *A10, Mat *A11) 2671d71ae5a4SJacob Faibussowitsch { 267230ad9308SMatthew Knepley PC_FieldSplit *jac = (PC_FieldSplit *)pc->data; 267330ad9308SMatthew Knepley 267430ad9308SMatthew Knepley PetscFunctionBegin; 26750700a824SBarry Smith PetscValidHeaderSpecific(pc, PC_CLASSID, 1); 267608401ef6SPierre Jolivet PetscCheck(jac->type == PC_COMPOSITE_SCHUR, PetscObjectComm((PetscObject)pc), PETSC_ERR_ARG_WRONG, "FieldSplit is not using a Schur complement approach."); 2677a04f6461SBarry Smith if (A00) *A00 = jac->pmat[0]; 2678a04f6461SBarry Smith if (A01) *A01 = jac->B; 2679a04f6461SBarry Smith if (A10) *A10 = jac->C; 2680a04f6461SBarry Smith if (A11) *A11 = jac->pmat[1]; 26813ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 268230ad9308SMatthew Knepley } 268330ad9308SMatthew Knepley 2684b09e027eSCarola Kruse /*@ 2685f1580f4eSBarry Smith PCFieldSplitSetGKBTol - Sets the solver tolerance for the generalized Golub-Kahan bidiagonalization preconditioner in `PCFIELDSPLIT` 2686b09e027eSCarola Kruse 2687c3339decSBarry Smith Collective 2688e071a0a4SCarola Kruse 2689b09e027eSCarola Kruse Input Parameters: 2690b09e027eSCarola Kruse + pc - the preconditioner context 2691b09e027eSCarola Kruse - tolerance - the solver tolerance 2692b09e027eSCarola Kruse 2693f1580f4eSBarry Smith Options Database Key: 2694b09e027eSCarola Kruse . -pc_fieldsplit_gkb_tol - default is 1e-5 2695b09e027eSCarola Kruse 2696b09e027eSCarola Kruse Level: intermediate 2697b09e027eSCarola Kruse 2698f1580f4eSBarry Smith Note: 2699f1580f4eSBarry Smith The generalized GKB algorithm uses a lower bound estimate of the error in energy norm as stopping criterion. 2700f1580f4eSBarry Smith It stops once the lower bound estimate undershoots the required solver tolerance. Although the actual error might be bigger than 2701f1580f4eSBarry Smith this estimate, the stopping criterion is satisfactory in practical cases [A13]. 2702f1580f4eSBarry Smith 270360f59c3bSBarry Smith References: 2704f1580f4eSBarry Smith [Ar13] Generalized Golub-Kahan bidiagonalization and stopping criteria, SIAM J. Matrix Anal. Appl., Vol. 34, No. 2, pp. 571-592, 2013. 2705f1580f4eSBarry Smith 270660f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCFIELDSPLIT`, `PCFieldSplitSetGKBDelay()`, `PCFieldSplitSetGKBNu()`, `PCFieldSplitSetGKBMaxit()` 2707b09e027eSCarola Kruse @*/ 2708d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitSetGKBTol(PC pc, PetscReal tolerance) 2709d71ae5a4SJacob Faibussowitsch { 2710b09e027eSCarola Kruse PetscFunctionBegin; 2711b09e027eSCarola Kruse PetscValidHeaderSpecific(pc, PC_CLASSID, 1); 2712de482cd7SCarola Kruse PetscValidLogicalCollectiveReal(pc, tolerance, 2); 2713cac4c232SBarry Smith PetscTryMethod(pc, "PCFieldSplitSetGKBTol_C", (PC, PetscReal), (pc, tolerance)); 27143ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 2715b09e027eSCarola Kruse } 2716b09e027eSCarola Kruse 2717d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCFieldSplitSetGKBTol_FieldSplit(PC pc, PetscReal tolerance) 2718d71ae5a4SJacob Faibussowitsch { 2719b09e027eSCarola Kruse PC_FieldSplit *jac = (PC_FieldSplit *)pc->data; 2720b09e027eSCarola Kruse 2721b09e027eSCarola Kruse PetscFunctionBegin; 2722b09e027eSCarola Kruse jac->gkbtol = tolerance; 27233ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 2724b09e027eSCarola Kruse } 2725b09e027eSCarola Kruse 2726b09e027eSCarola Kruse /*@ 2727f1580f4eSBarry Smith PCFieldSplitSetGKBMaxit - Sets the maximum number of iterations for the generalized Golub-Kahan bidiagonalization preconditioner in `PCFIELDSPLIT` 2728b09e027eSCarola Kruse 2729c3339decSBarry Smith Collective 2730b09e027eSCarola Kruse 2731b09e027eSCarola Kruse Input Parameters: 2732b09e027eSCarola Kruse + pc - the preconditioner context 2733b09e027eSCarola Kruse - maxit - the maximum number of iterations 2734b09e027eSCarola Kruse 2735f1580f4eSBarry Smith Options Database Key: 2736b09e027eSCarola Kruse . -pc_fieldsplit_gkb_maxit - default is 100 2737b09e027eSCarola Kruse 2738b09e027eSCarola Kruse Level: intermediate 2739b09e027eSCarola Kruse 274060f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCFIELDSPLIT`, `PCFieldSplitSetGKBDelay()`, `PCFieldSplitSetGKBTol()`, `PCFieldSplitSetGKBNu()` 2741b09e027eSCarola Kruse @*/ 2742d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitSetGKBMaxit(PC pc, PetscInt maxit) 2743d71ae5a4SJacob Faibussowitsch { 2744b09e027eSCarola Kruse PetscFunctionBegin; 2745b09e027eSCarola Kruse PetscValidHeaderSpecific(pc, PC_CLASSID, 1); 2746de482cd7SCarola Kruse PetscValidLogicalCollectiveInt(pc, maxit, 2); 2747cac4c232SBarry Smith PetscTryMethod(pc, "PCFieldSplitSetGKBMaxit_C", (PC, PetscInt), (pc, maxit)); 27483ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 2749b09e027eSCarola Kruse } 2750b09e027eSCarola Kruse 2751d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCFieldSplitSetGKBMaxit_FieldSplit(PC pc, PetscInt maxit) 2752d71ae5a4SJacob Faibussowitsch { 2753b09e027eSCarola Kruse PC_FieldSplit *jac = (PC_FieldSplit *)pc->data; 2754b09e027eSCarola Kruse 2755b09e027eSCarola Kruse PetscFunctionBegin; 2756b09e027eSCarola Kruse jac->gkbmaxit = maxit; 27573ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 2758b09e027eSCarola Kruse } 2759b09e027eSCarola Kruse 2760b09e027eSCarola Kruse /*@ 2761f1580f4eSBarry Smith PCFieldSplitSetGKBDelay - Sets the delay in the lower bound error estimate in the generalized Golub-Kahan bidiagonalization in `PCFIELDSPLIT` 2762e071a0a4SCarola Kruse preconditioner. 2763b09e027eSCarola Kruse 2764c3339decSBarry Smith Collective 2765b09e027eSCarola Kruse 2766b09e027eSCarola Kruse Input Parameters: 2767b09e027eSCarola Kruse + pc - the preconditioner context 2768b09e027eSCarola Kruse - delay - the delay window in the lower bound estimate 2769b09e027eSCarola Kruse 2770f1580f4eSBarry Smith Options Database Key: 2771b09e027eSCarola Kruse . -pc_fieldsplit_gkb_delay - default is 5 2772b09e027eSCarola Kruse 2773b09e027eSCarola Kruse Level: intermediate 2774b09e027eSCarola Kruse 2775f1580f4eSBarry Smith Note: 2776f1580f4eSBarry 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 2777f1580f4eSBarry 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 2778f1580f4eSBarry 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 2779f1580f4eSBarry Smith 278060f59c3bSBarry Smith References: 2781f1580f4eSBarry Smith [Ar13] Generalized Golub-Kahan bidiagonalization and stopping criteria, SIAM J. Matrix Anal. Appl., Vol. 34, No. 2, pp. 571-592, 2013. 2782f1580f4eSBarry Smith 278360f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCFIELDSPLIT`, `PCFieldSplitSetGKBNu()`, `PCFieldSplitSetGKBTol()`, `PCFieldSplitSetGKBMaxit()` 2784b09e027eSCarola Kruse @*/ 2785d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitSetGKBDelay(PC pc, PetscInt delay) 2786d71ae5a4SJacob Faibussowitsch { 2787b09e027eSCarola Kruse PetscFunctionBegin; 2788b09e027eSCarola Kruse PetscValidHeaderSpecific(pc, PC_CLASSID, 1); 2789b09e027eSCarola Kruse PetscValidLogicalCollectiveInt(pc, delay, 2); 2790cac4c232SBarry Smith PetscTryMethod(pc, "PCFieldSplitSetGKBDelay_C", (PC, PetscInt), (pc, delay)); 27913ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 2792b09e027eSCarola Kruse } 2793b09e027eSCarola Kruse 2794d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCFieldSplitSetGKBDelay_FieldSplit(PC pc, PetscInt delay) 2795d71ae5a4SJacob Faibussowitsch { 2796b09e027eSCarola Kruse PC_FieldSplit *jac = (PC_FieldSplit *)pc->data; 2797b09e027eSCarola Kruse 2798b09e027eSCarola Kruse PetscFunctionBegin; 2799b09e027eSCarola Kruse jac->gkbdelay = delay; 28003ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 2801b09e027eSCarola Kruse } 2802b09e027eSCarola Kruse 2803b09e027eSCarola Kruse /*@ 2804f1580f4eSBarry 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 2805f1580f4eSBarry Smith in `PCFIELDSPLIT` 2806b09e027eSCarola Kruse 2807c3339decSBarry Smith Collective 2808f1580f4eSBarry Smith 2809f1580f4eSBarry Smith Input Parameters: 2810f1580f4eSBarry Smith + pc - the preconditioner context 2811f1580f4eSBarry Smith - nu - the shift parameter 2812f1580f4eSBarry Smith 281320f4b53cSBarry Smith Options Database Key: 2814f1580f4eSBarry Smith . -pc_fieldsplit_gkb_nu - default is 1 2815f1580f4eSBarry Smith 2816f1580f4eSBarry Smith Level: intermediate 2817b09e027eSCarola Kruse 2818b09e027eSCarola Kruse Notes: 2819da81f932SPierre 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, 2820da81f932SPierre 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 2821b09e027eSCarola Kruse necessary to find a good balance in between the convergence of the inner and outer loop. 2822b09e027eSCarola Kruse 2823b09e027eSCarola 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. 2824b09e027eSCarola Kruse 282560f59c3bSBarry Smith References: 2826b09e027eSCarola Kruse [Ar13] Generalized Golub-Kahan bidiagonalization and stopping criteria, SIAM J. Matrix Anal. Appl., Vol. 34, No. 2, pp. 571-592, 2013. 2827b09e027eSCarola Kruse 282860f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCFIELDSPLIT`, `PCFieldSplitSetGKBDelay()`, `PCFieldSplitSetGKBTol()`, `PCFieldSplitSetGKBMaxit()` 2829b09e027eSCarola Kruse @*/ 2830d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitSetGKBNu(PC pc, PetscReal nu) 2831d71ae5a4SJacob Faibussowitsch { 2832b09e027eSCarola Kruse PetscFunctionBegin; 2833b09e027eSCarola Kruse PetscValidHeaderSpecific(pc, PC_CLASSID, 1); 2834de482cd7SCarola Kruse PetscValidLogicalCollectiveReal(pc, nu, 2); 2835cac4c232SBarry Smith PetscTryMethod(pc, "PCFieldSplitSetGKBNu_C", (PC, PetscReal), (pc, nu)); 28363ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 2837b09e027eSCarola Kruse } 2838b09e027eSCarola Kruse 2839d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCFieldSplitSetGKBNu_FieldSplit(PC pc, PetscReal nu) 2840d71ae5a4SJacob Faibussowitsch { 2841b09e027eSCarola Kruse PC_FieldSplit *jac = (PC_FieldSplit *)pc->data; 2842b09e027eSCarola Kruse 2843b09e027eSCarola Kruse PetscFunctionBegin; 2844b09e027eSCarola Kruse jac->gkbnu = nu; 28453ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 2846b09e027eSCarola Kruse } 2847b09e027eSCarola Kruse 2848d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCFieldSplitSetType_FieldSplit(PC pc, PCCompositeType type) 2849d71ae5a4SJacob Faibussowitsch { 285079416396SBarry Smith PC_FieldSplit *jac = (PC_FieldSplit *)pc->data; 285179416396SBarry Smith 285279416396SBarry Smith PetscFunctionBegin; 285379416396SBarry Smith jac->type = type; 28542e956fe4SStefano Zampini PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitGetSubKSP_C", NULL)); 28552e956fe4SStefano Zampini PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetSchurPre_C", NULL)); 28562e956fe4SStefano Zampini PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitGetSchurPre_C", NULL)); 28572e956fe4SStefano Zampini PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetSchurFactType_C", NULL)); 28582e956fe4SStefano Zampini PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetSchurScale_C", NULL)); 28592e956fe4SStefano Zampini PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetGKBTol_C", NULL)); 28602e956fe4SStefano Zampini PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetGKBMaxit_C", NULL)); 28612e956fe4SStefano Zampini PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetGKBNu_C", NULL)); 28622e956fe4SStefano Zampini PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetGKBDelay_C", NULL)); 2863e071a0a4SCarola Kruse 28643b224e63SBarry Smith if (type == PC_COMPOSITE_SCHUR) { 28653b224e63SBarry Smith pc->ops->apply = PCApply_FieldSplit_Schur; 2866*7b665727SPierre Jolivet pc->ops->applytranspose = PCApplyTranspose_FieldSplit_Schur; 28673b224e63SBarry Smith pc->ops->view = PCView_FieldSplit_Schur; 28682fa5cd67SKarl Rupp 28699566063dSJacob Faibussowitsch PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitGetSubKSP_C", PCFieldSplitGetSubKSP_FieldSplit_Schur)); 28709566063dSJacob Faibussowitsch PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetSchurPre_C", PCFieldSplitSetSchurPre_FieldSplit)); 28719566063dSJacob Faibussowitsch PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitGetSchurPre_C", PCFieldSplitGetSchurPre_FieldSplit)); 28729566063dSJacob Faibussowitsch PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetSchurFactType_C", PCFieldSplitSetSchurFactType_FieldSplit)); 28739566063dSJacob Faibussowitsch PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetSchurScale_C", PCFieldSplitSetSchurScale_FieldSplit)); 2874a51937d4SCarola Kruse } else if (type == PC_COMPOSITE_GKB) { 2875a51937d4SCarola Kruse pc->ops->apply = PCApply_FieldSplit_GKB; 2876a51937d4SCarola Kruse pc->ops->view = PCView_FieldSplit_GKB; 2877e69d4d44SBarry Smith 28789566063dSJacob Faibussowitsch PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitGetSubKSP_C", PCFieldSplitGetSubKSP_FieldSplit)); 28799566063dSJacob Faibussowitsch PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetGKBTol_C", PCFieldSplitSetGKBTol_FieldSplit)); 28809566063dSJacob Faibussowitsch PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetGKBMaxit_C", PCFieldSplitSetGKBMaxit_FieldSplit)); 28819566063dSJacob Faibussowitsch PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetGKBNu_C", PCFieldSplitSetGKBNu_FieldSplit)); 28829566063dSJacob Faibussowitsch PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetGKBDelay_C", PCFieldSplitSetGKBDelay_FieldSplit)); 28833b224e63SBarry Smith } else { 28843b224e63SBarry Smith pc->ops->apply = PCApply_FieldSplit; 28853b224e63SBarry Smith pc->ops->view = PCView_FieldSplit; 28862fa5cd67SKarl Rupp 28879566063dSJacob Faibussowitsch PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitGetSubKSP_C", PCFieldSplitGetSubKSP_FieldSplit)); 28883b224e63SBarry Smith } 28893ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 289079416396SBarry Smith } 289179416396SBarry Smith 2892d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCFieldSplitSetBlockSize_FieldSplit(PC pc, PetscInt bs) 2893d71ae5a4SJacob Faibussowitsch { 289451f519a2SBarry Smith PC_FieldSplit *jac = (PC_FieldSplit *)pc->data; 289551f519a2SBarry Smith 289651f519a2SBarry Smith PetscFunctionBegin; 289763a3b9bcSJacob Faibussowitsch PetscCheck(bs >= 1, PetscObjectComm((PetscObject)pc), PETSC_ERR_ARG_OUTOFRANGE, "Blocksize must be positive, you gave %" PetscInt_FMT, bs); 28982472a847SBarry 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); 289951f519a2SBarry Smith jac->bs = bs; 29003ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 290151f519a2SBarry Smith } 290251f519a2SBarry Smith 2903d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCSetCoordinates_FieldSplit(PC pc, PetscInt dim, PetscInt nloc, PetscReal coords[]) 2904d71ae5a4SJacob Faibussowitsch { 29055ddf11f8SNicolas Barnafi PC_FieldSplit *jac = (PC_FieldSplit *)pc->data; 29065ddf11f8SNicolas Barnafi PC_FieldSplitLink ilink_current = jac->head; 29075ddf11f8SNicolas Barnafi IS is_owned; 29085ddf11f8SNicolas Barnafi 29095ddf11f8SNicolas Barnafi PetscFunctionBegin; 29105ddf11f8SNicolas Barnafi jac->coordinates_set = PETSC_TRUE; // Internal flag 2911f3fa974cSJacob Faibussowitsch PetscCall(MatGetOwnershipIS(pc->mat, &is_owned, NULL)); 29125ddf11f8SNicolas Barnafi 29135ddf11f8SNicolas Barnafi while (ilink_current) { 29145ddf11f8SNicolas Barnafi // For each IS, embed it to get local coords indces 29155ddf11f8SNicolas Barnafi IS is_coords; 29165ddf11f8SNicolas Barnafi PetscInt ndofs_block; 29175ddf11f8SNicolas Barnafi const PetscInt *block_dofs_enumeration; // Numbering of the dofs relevant to the current block 29185ddf11f8SNicolas Barnafi 29195ddf11f8SNicolas Barnafi // Setting drop to true for safety. It should make no difference. 29209566063dSJacob Faibussowitsch PetscCall(ISEmbed(ilink_current->is, is_owned, PETSC_TRUE, &is_coords)); 29219566063dSJacob Faibussowitsch PetscCall(ISGetLocalSize(is_coords, &ndofs_block)); 29229566063dSJacob Faibussowitsch PetscCall(ISGetIndices(is_coords, &block_dofs_enumeration)); 29235ddf11f8SNicolas Barnafi 29245ddf11f8SNicolas Barnafi // Allocate coordinates vector and set it directly 29259566063dSJacob Faibussowitsch PetscCall(PetscMalloc1(ndofs_block * dim, &(ilink_current->coords))); 29265ddf11f8SNicolas Barnafi for (PetscInt dof = 0; dof < ndofs_block; ++dof) { 2927ad540459SPierre Jolivet for (PetscInt d = 0; d < dim; ++d) (ilink_current->coords)[dim * dof + d] = coords[dim * block_dofs_enumeration[dof] + d]; 29285ddf11f8SNicolas Barnafi } 29295ddf11f8SNicolas Barnafi ilink_current->dim = dim; 29305ddf11f8SNicolas Barnafi ilink_current->ndofs = ndofs_block; 29319566063dSJacob Faibussowitsch PetscCall(ISRestoreIndices(is_coords, &block_dofs_enumeration)); 29329566063dSJacob Faibussowitsch PetscCall(ISDestroy(&is_coords)); 29335ddf11f8SNicolas Barnafi ilink_current = ilink_current->next; 29345ddf11f8SNicolas Barnafi } 29359566063dSJacob Faibussowitsch PetscCall(ISDestroy(&is_owned)); 29363ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 29375ddf11f8SNicolas Barnafi } 29385ddf11f8SNicolas Barnafi 2939bc08b0f1SBarry Smith /*@ 2940f1580f4eSBarry Smith PCFieldSplitSetType - Sets the type, `PCCompositeType`, of a `PCFIELDSPLIT` 294179416396SBarry Smith 2942c3339decSBarry Smith Collective 294379416396SBarry Smith 2944d8d19677SJose E. Roman Input Parameters: 2945a2b725a8SWilliam Gropp + pc - the preconditioner context 2946f1580f4eSBarry Smith - type - `PC_COMPOSITE_ADDITIVE`, `PC_COMPOSITE_MULTIPLICATIVE` (default), `PC_COMPOSITE_SYMMETRIC_MULTIPLICATIVE`, `PC_COMPOSITE_SPECIAL`, `PC_COMPOSITE_SCHUR` 294779416396SBarry Smith 294879416396SBarry Smith Options Database Key: 2949a4efd8eaSMatthew Knepley . -pc_fieldsplit_type <type: one of multiplicative, additive, symmetric_multiplicative, special, schur> - Sets fieldsplit preconditioner type 295079416396SBarry Smith 2951feefa0e1SJacob Faibussowitsch Level: intermediate 295279416396SBarry Smith 295360f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCFIELDSPLIT`, `PCCompositeType`, `PCCompositeGetType()`, `PC_COMPOSITE_ADDITIVE`, `PC_COMPOSITE_MULTIPLICATIVE`, 2954f1580f4eSBarry Smith `PC_COMPOSITE_SYMMETRIC_MULTIPLICATIVE`, `PC_COMPOSITE_SPECIAL`, `PC_COMPOSITE_SCHUR` 295579416396SBarry Smith @*/ 2956d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitSetType(PC pc, PCCompositeType type) 2957d71ae5a4SJacob Faibussowitsch { 295879416396SBarry Smith PetscFunctionBegin; 29590700a824SBarry Smith PetscValidHeaderSpecific(pc, PC_CLASSID, 1); 2960cac4c232SBarry Smith PetscTryMethod(pc, "PCFieldSplitSetType_C", (PC, PCCompositeType), (pc, type)); 29613ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 296279416396SBarry Smith } 296379416396SBarry Smith 2964b02e2d75SMatthew G Knepley /*@ 2965f1580f4eSBarry Smith PCFieldSplitGetType - Gets the type, `PCCompositeType`, of a `PCFIELDSPLIT` 2966b02e2d75SMatthew G Knepley 2967b02e2d75SMatthew G Knepley Not collective 2968b02e2d75SMatthew G Knepley 2969b02e2d75SMatthew G Knepley Input Parameter: 2970b02e2d75SMatthew G Knepley . pc - the preconditioner context 2971b02e2d75SMatthew G Knepley 2972b02e2d75SMatthew G Knepley Output Parameter: 2973f1580f4eSBarry Smith . type - `PC_COMPOSITE_ADDITIVE`, `PC_COMPOSITE_MULTIPLICATIVE` (default), `PC_COMPOSITE_SYMMETRIC_MULTIPLICATIVE`, `PC_COMPOSITE_SPECIAL`, `PC_COMPOSITE_SCHUR` 2974b02e2d75SMatthew G Knepley 2975feefa0e1SJacob Faibussowitsch Level: intermediate 2976b02e2d75SMatthew G Knepley 297760f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCCompositeSetType()`, `PCFIELDSPLIT`, `PCCompositeType`, `PC_COMPOSITE_ADDITIVE`, `PC_COMPOSITE_MULTIPLICATIVE`, 2978f1580f4eSBarry Smith `PC_COMPOSITE_SYMMETRIC_MULTIPLICATIVE`, `PC_COMPOSITE_SPECIAL`, `PC_COMPOSITE_SCHUR` 2979b02e2d75SMatthew G Knepley @*/ 2980d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitGetType(PC pc, PCCompositeType *type) 2981d71ae5a4SJacob Faibussowitsch { 2982b02e2d75SMatthew G Knepley PC_FieldSplit *jac = (PC_FieldSplit *)pc->data; 2983b02e2d75SMatthew G Knepley 2984b02e2d75SMatthew G Knepley PetscFunctionBegin; 2985b02e2d75SMatthew G Knepley PetscValidHeaderSpecific(pc, PC_CLASSID, 1); 2986b02e2d75SMatthew G Knepley PetscValidIntPointer(type, 2); 2987b02e2d75SMatthew G Knepley *type = jac->type; 29883ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 2989b02e2d75SMatthew G Knepley } 2990b02e2d75SMatthew G Knepley 29914ab8060aSDmitry Karpeev /*@ 2992f1580f4eSBarry Smith PCFieldSplitSetDMSplits - Flags whether `DMCreateFieldDecomposition()` should be used to define the splits in a `PCFIELDSPLIT`, whenever possible. 29934ab8060aSDmitry Karpeev 2994c3339decSBarry Smith Logically Collective 29954ab8060aSDmitry Karpeev 29964ab8060aSDmitry Karpeev Input Parameters: 29974ab8060aSDmitry Karpeev + pc - the preconditioner context 2998f1580f4eSBarry Smith - flg - boolean indicating whether to use field splits defined by the `DM` 29994ab8060aSDmitry Karpeev 30004ab8060aSDmitry Karpeev Options Database Key: 3001f1580f4eSBarry Smith . -pc_fieldsplit_dm_splits <bool> - use the field splits defined by the `DM` 30024ab8060aSDmitry Karpeev 3003feefa0e1SJacob Faibussowitsch Level: intermediate 30044ab8060aSDmitry Karpeev 300560f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCFIELDSPLIT`, `PCFieldSplitGetDMSplits()`, `PCFieldSplitSetFields()`, `PCFieldsplitSetIS()` 30064ab8060aSDmitry Karpeev @*/ 3007d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitSetDMSplits(PC pc, PetscBool flg) 3008d71ae5a4SJacob Faibussowitsch { 30094ab8060aSDmitry Karpeev PC_FieldSplit *jac = (PC_FieldSplit *)pc->data; 30104ab8060aSDmitry Karpeev PetscBool isfs; 30114ab8060aSDmitry Karpeev 30124ab8060aSDmitry Karpeev PetscFunctionBegin; 30134ab8060aSDmitry Karpeev PetscValidHeaderSpecific(pc, PC_CLASSID, 1); 30144ab8060aSDmitry Karpeev PetscValidLogicalCollectiveBool(pc, flg, 2); 30159566063dSJacob Faibussowitsch PetscCall(PetscObjectTypeCompare((PetscObject)pc, PCFIELDSPLIT, &isfs)); 3016ad540459SPierre Jolivet if (isfs) jac->dm_splits = flg; 30173ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 30184ab8060aSDmitry Karpeev } 30194ab8060aSDmitry Karpeev 30204ab8060aSDmitry Karpeev /*@ 3021f1580f4eSBarry Smith PCFieldSplitGetDMSplits - Returns flag indicating whether `DMCreateFieldDecomposition()` should be used to define the splits in a `PCFIELDSPLIT`, whenever possible. 30224ab8060aSDmitry Karpeev 30234ab8060aSDmitry Karpeev Logically Collective 30244ab8060aSDmitry Karpeev 30254ab8060aSDmitry Karpeev Input Parameter: 30264ab8060aSDmitry Karpeev . pc - the preconditioner context 30274ab8060aSDmitry Karpeev 30284ab8060aSDmitry Karpeev Output Parameter: 3029f1580f4eSBarry Smith . flg - boolean indicating whether to use field splits defined by the `DM` 30304ab8060aSDmitry Karpeev 3031feefa0e1SJacob Faibussowitsch Level: intermediate 30324ab8060aSDmitry Karpeev 303360f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCFIELDSPLIT`, `PCFieldSplitSetDMSplits()`, `PCFieldSplitSetFields()`, `PCFieldsplitSetIS()` 30344ab8060aSDmitry Karpeev @*/ 3035d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitGetDMSplits(PC pc, PetscBool *flg) 3036d71ae5a4SJacob Faibussowitsch { 30374ab8060aSDmitry Karpeev PC_FieldSplit *jac = (PC_FieldSplit *)pc->data; 30384ab8060aSDmitry Karpeev PetscBool isfs; 30394ab8060aSDmitry Karpeev 30404ab8060aSDmitry Karpeev PetscFunctionBegin; 30414ab8060aSDmitry Karpeev PetscValidHeaderSpecific(pc, PC_CLASSID, 1); 3042534a8f05SLisandro Dalcin PetscValidBoolPointer(flg, 2); 30439566063dSJacob Faibussowitsch PetscCall(PetscObjectTypeCompare((PetscObject)pc, PCFIELDSPLIT, &isfs)); 30444ab8060aSDmitry Karpeev if (isfs) { 30454ab8060aSDmitry Karpeev if (flg) *flg = jac->dm_splits; 30464ab8060aSDmitry Karpeev } 30473ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 30484ab8060aSDmitry Karpeev } 30494ab8060aSDmitry Karpeev 30507b752e3dSPatrick Sanan /*@ 3051f1580f4eSBarry Smith PCFieldSplitGetDetectSaddlePoint - Returns flag indicating whether `PCFIELDSPLIT` will attempt to automatically determine fields based on zero diagonal entries. 30527b752e3dSPatrick Sanan 30537b752e3dSPatrick Sanan Logically Collective 30547b752e3dSPatrick Sanan 30557b752e3dSPatrick Sanan Input Parameter: 30567b752e3dSPatrick Sanan . pc - the preconditioner context 30577b752e3dSPatrick Sanan 30587b752e3dSPatrick Sanan Output Parameter: 30597b752e3dSPatrick Sanan . flg - boolean indicating whether to detect fields or not 30607b752e3dSPatrick Sanan 3061feefa0e1SJacob Faibussowitsch Level: intermediate 30627b752e3dSPatrick Sanan 306360f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCFIELDSPLIT`, `PCFieldSplitSetDetectSaddlePoint()` 30647b752e3dSPatrick Sanan @*/ 3065d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitGetDetectSaddlePoint(PC pc, PetscBool *flg) 3066d71ae5a4SJacob Faibussowitsch { 30677b752e3dSPatrick Sanan PC_FieldSplit *jac = (PC_FieldSplit *)pc->data; 30687b752e3dSPatrick Sanan 30697b752e3dSPatrick Sanan PetscFunctionBegin; 30707b752e3dSPatrick Sanan *flg = jac->detect; 30713ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 30727b752e3dSPatrick Sanan } 30737b752e3dSPatrick Sanan 30747b752e3dSPatrick Sanan /*@ 3075f1580f4eSBarry Smith PCFieldSplitSetDetectSaddlePoint - Sets flag indicating whether `PCFIELDSPLIT` will attempt to automatically determine fields based on zero diagonal entries. 30767b752e3dSPatrick Sanan 30777b752e3dSPatrick Sanan Logically Collective 30787b752e3dSPatrick Sanan 30797b752e3dSPatrick Sanan Input Parameter: 30807b752e3dSPatrick Sanan . pc - the preconditioner context 30817b752e3dSPatrick Sanan 30827b752e3dSPatrick Sanan Output Parameter: 30837b752e3dSPatrick Sanan . flg - boolean indicating whether to detect fields or not 30847b752e3dSPatrick Sanan 30857b752e3dSPatrick Sanan Options Database Key: 3086147403d9SBarry Smith . -pc_fieldsplit_detect_saddle_point <bool> - detect and use the saddle point 3087147403d9SBarry Smith 3088feefa0e1SJacob Faibussowitsch Level: intermediate 308960f59c3bSBarry Smith 3090f1580f4eSBarry Smith Note: 3091f1580f4eSBarry 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()`). 30927b752e3dSPatrick Sanan 309360f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCFIELDSPLIT`, `PCFieldSplitGetDetectSaddlePoint()`, `PCFieldSplitSetType()`, `PCFieldSplitSetSchurPre()`, `PC_FIELDSPLIT_SCHUR_PRE_SELF` 30947b752e3dSPatrick Sanan @*/ 3095d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitSetDetectSaddlePoint(PC pc, PetscBool flg) 3096d71ae5a4SJacob Faibussowitsch { 30977b752e3dSPatrick Sanan PC_FieldSplit *jac = (PC_FieldSplit *)pc->data; 30987b752e3dSPatrick Sanan 30997b752e3dSPatrick Sanan PetscFunctionBegin; 31007b752e3dSPatrick Sanan jac->detect = flg; 31017b752e3dSPatrick Sanan if (jac->detect) { 31029566063dSJacob Faibussowitsch PetscCall(PCFieldSplitSetType(pc, PC_COMPOSITE_SCHUR)); 31039566063dSJacob Faibussowitsch PetscCall(PCFieldSplitSetSchurPre(pc, PC_FIELDSPLIT_SCHUR_PRE_SELF, NULL)); 31047b752e3dSPatrick Sanan } 31053ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 31067b752e3dSPatrick Sanan } 31077b752e3dSPatrick Sanan 31080971522cSBarry Smith /*MC 3109a8c7a070SBarry Smith PCFIELDSPLIT - Preconditioner created by combining separate preconditioners for individual 3110f1580f4eSBarry Smith collections of variables (that may overlap) called splits. See [the users manual section on "Solving Block Matrices"](sec_block_matrices) for more details. 31110971522cSBarry Smith 311279416396SBarry Smith Options Database Keys: 3113de37d9f1SPatrick Sanan + -pc_fieldsplit_%d_fields <a,b,..> - indicates the fields to be used in the `%d`'th split 311481540f2fSBarry Smith . -pc_fieldsplit_default - automatically add any fields to additional splits that have not 3115de37d9f1SPatrick Sanan been supplied explicitly by `-pc_fieldsplit_%d_fields` 311681540f2fSBarry Smith . -pc_fieldsplit_block_size <bs> - size of block that defines fields (i.e. there are bs fields) 3117a51937d4SCarola Kruse . -pc_fieldsplit_type <additive,multiplicative,symmetric_multiplicative,schur,gkb> - type of relaxation or factorization splitting 3118de37d9f1SPatrick Sanan . -pc_fieldsplit_schur_precondition <self,selfp,user,a11,full> - default is a11; see `PCFieldSplitSetSchurPre()` 3119de37d9f1SPatrick Sanan . -pc_fieldsplit_schur_fact_type <diag,lower,upper,full> - set factorization type when using `-pc_fieldsplit_type schur`; see `PCFieldSplitSetSchurFactType()` 3120fb6809a2SPatrick Sanan - -pc_fieldsplit_detect_saddle_point - automatically finds rows with zero diagonal and uses Schur complement with no preconditioner as the solver 312179416396SBarry Smith 3122de37d9f1SPatrick Sanan Options prefixes for inner solvers when using the Schur complement preconditioner are `-fieldsplit_0_` and `-fieldsplit_1_` . 3123de37d9f1SPatrick Sanan The options prefix for the inner solver when using the Golub-Kahan biadiagonalization preconditioner is `-fieldsplit_0_` 312460f59c3bSBarry Smith For all other solvers they are `-fieldsplit_%d_` for the `%d`'th field; use `-fieldsplit_` for all fields. 312560f59c3bSBarry Smith 312660f59c3bSBarry Smith To set options on the solvers for each block append `-fieldsplit_` to all the `PC` 312760f59c3bSBarry Smith options database keys. For example, `-fieldsplit_pc_type ilu` `-fieldsplit_pc_factor_levels 1` 312860f59c3bSBarry Smith 312960f59c3bSBarry Smith To set the options on the solvers separate for each block call `PCFieldSplitGetSubKSP()` 313060f59c3bSBarry Smith and set the options directly on the resulting `KSP` object 313160f59c3bSBarry Smith 313260f59c3bSBarry Smith Level: intermediate 31335d4c12cdSJungho Lee 3134c8a0d604SMatthew G Knepley Notes: 3135f1580f4eSBarry Smith Use `PCFieldSplitSetFields()` to set splits defined by "strided" entries and `PCFieldSplitSetIS()` 3136f1580f4eSBarry Smith to define a split by an arbitrary collection of entries. 3137d32f9abdSBarry Smith 3138f1580f4eSBarry Smith If no splits are set the default is used. The splits are defined by entries strided by bs, 3139de37d9f1SPatrick Sanan beginning at 0 then 1, etc to bs-1. The block size can be set with `PCFieldSplitSetBlockSize()`, 3140d32f9abdSBarry Smith if this is not called the block size defaults to the blocksize of the second matrix passed 3141de37d9f1SPatrick Sanan to `KSPSetOperators()`/`PCSetOperators()`. 3142d32f9abdSBarry Smith 3143de37d9f1SPatrick Sanan For the Schur complement preconditioner if 31441d71051fSDmitry Karpeev 3145de37d9f1SPatrick Sanan ```{math} 3146de37d9f1SPatrick Sanan J = \left[\begin{array}{cc} A_{00} & A_{01} \\ A_{10} & A_{11} \end{array}\right] 3147de37d9f1SPatrick Sanan ``` 3148e69d4d44SBarry Smith 3149de37d9f1SPatrick Sanan the preconditioner using `full` factorization is logically 3150de37d9f1SPatrick Sanan ```{math} 3151de37d9f1SPatrick 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] 3152de37d9f1SPatrick Sanan ``` 3153de37d9f1SPatrick Sanan where the action of $\text{inv}(A_{00})$ is applied using the KSP solver with prefix `-fieldsplit_0_`. $S$ is the Schur complement 3154de37d9f1SPatrick Sanan ```{math} 3155223e5b4fSPatrick Sanan S = A_{11} - A_{10} \text{ksp}(A_{00}) A_{01} 3156de37d9f1SPatrick Sanan ``` 3157de37d9f1SPatrick 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 315860f59c3bSBarry Smith in providing the SECOND split or 1 if not given). For `PCFieldSplitGetSubKSP()` when field number is 0, 3159de37d9f1SPatrick Sanan it returns the KSP associated with `-fieldsplit_0_` while field number 1 gives `-fieldsplit_1_` KSP. By default 3160de37d9f1SPatrick Sanan $A_{11}$ is used to construct a preconditioner for $S$, use `PCFieldSplitSetSchurPre()` for all the possible ways to construct the preconditioner for $S$. 3161de37d9f1SPatrick Sanan 3162de37d9f1SPatrick Sanan The factorization type is set using `-pc_fieldsplit_schur_fact_type <diag, lower, upper, full>`. `full` is shown above, 3163de37d9f1SPatrick Sanan `diag` gives 3164de37d9f1SPatrick Sanan ```{math} 3165de37d9f1SPatrick Sanan \left[\begin{array}{cc} \text{inv}(A_{00}) & 0 \\ 0 & -\text{ksp}(S) \end{array}\right] 3166de37d9f1SPatrick Sanan ``` 3167de37d9f1SPatrick 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 3168de37d9f1SPatrick Sanan can be turned off with `PCFieldSplitSetSchurScale()` or by command line `-pc_fieldsplit_schur_scale 1.0`. The `lower` factorization is the inverse of 3169de37d9f1SPatrick Sanan ```{math} 3170de37d9f1SPatrick Sanan \left[\begin{array}{cc} A_{00} & 0 \\ A_{10} & S \end{array}\right] 3171de37d9f1SPatrick Sanan ``` 3172de37d9f1SPatrick Sanan where the inverses of A_{00} and S are applied using KSPs. The upper factorization is the inverse of 3173de37d9f1SPatrick Sanan ```{math} 3174de37d9f1SPatrick Sanan \left[\begin{array}{cc} A_{00} & A_{01} \\ 0 & S \end{array}\right] 3175de37d9f1SPatrick Sanan ``` 3176de37d9f1SPatrick Sanan where again the inverses of $A_{00}$ and $S$ are applied using `KSP`s. 3177de37d9f1SPatrick Sanan 3178de37d9f1SPatrick Sanan If only one set of indices (one `IS`) is provided with `PCFieldSplitSetIS()` then the complement of that `IS` 3179edf189efSBarry Smith is used automatically for a second block. 3180edf189efSBarry Smith 3181f1580f4eSBarry Smith The fieldsplit preconditioner cannot currently be used with the `MATBAIJ` or `MATSBAIJ` data formats if the blocksize is larger than 1. 3182f1580f4eSBarry Smith Generally it should be used with the `MATAIJ` format. 3183ff218e97SBarry Smith 3184ff218e97SBarry Smith The forms of these preconditioners are closely related if not identical to forms derived as "Distributive Iterations", see, 3185f1580f4eSBarry Smith for example, page 294 in "Principles of Computational Fluid Dynamics" by Pieter Wesseling {cite}`Wesseling2009`. 3186f1580f4eSBarry Smith One can also use `PCFIELDSPLIT` 3187ff218e97SBarry Smith inside a smoother resulting in "Distributive Smoothers". 31880716a85fSBarry Smith 3189de37d9f1SPatrick Sanan See "A taxonomy and comparison of parallel block multi-level preconditioners for the incompressible Navier-Stokes equations" {cite}`elman2008tcp`. 3190a6a584a2SBarry Smith 3191de37d9f1SPatrick Sanan The Constrained Pressure Preconditioner (CPR) can be implemented using `PCCOMPOSITE` with `PCGALERKIN`. CPR first solves an $R A P$ subsystem, updates the 3192de37d9f1SPatrick Sanan residual on all variables (`PCCompositeSetType(pc,PC_COMPOSITE_MULTIPLICATIVE)`), and then applies a simple ILU like preconditioner on all the variables. 3193a51937d4SCarola Kruse 3194de37d9f1SPatrick Sanan The generalized Golub-Kahan bidiagonalization preconditioner (GKB) can be applied to symmetric $2 \times 2$ block matrices of the shape 3195de37d9f1SPatrick Sanan ```{math} 3196de37d9f1SPatrick Sanan \left[\begin{array}{cc} A_{00} & A_{01} \\ A_{01}' & 0 \end{array}\right] 3197de37d9f1SPatrick Sanan ``` 3198de37d9f1SPatrick 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}'$. 3199de37d9f1SPatrick 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_`. 3200a51937d4SCarola Kruse 320160f59c3bSBarry Smith Developer Note: 320260f59c3bSBarry Smith The Schur complement functionality of `PCFIELDSPLIT` should likely be factored into its own `PC` thus simplifying the implementation of the preconditioners and their 320360f59c3bSBarry Smith user API. 3204f1580f4eSBarry Smith 320560f59c3bSBarry Smith References: 3206de37d9f1SPatrick Sanan ```{bibliography} 3207de37d9f1SPatrick Sanan :filter: docname in docnames 3208de37d9f1SPatrick Sanan ``` 3209de37d9f1SPatrick Sanan 321060f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCCreate()`, `PCSetType()`, `PCType`, `PC`, `PCLSC`, 3211db781477SPatrick Sanan `PCFieldSplitGetSubKSP()`, `PCFieldSplitSchurGetSubKSP()`, `PCFieldSplitSetFields()`, 3212db781477SPatrick Sanan `PCFieldSplitSetType()`, `PCFieldSplitSetIS()`, `PCFieldSplitSetSchurPre()`, `PCFieldSplitSetSchurFactType()`, 3213db781477SPatrick Sanan `MatSchurComplementSetAinvType()`, `PCFieldSplitSetSchurScale()`, `PCFieldSplitSetDetectSaddlePoint()` 32140971522cSBarry Smith M*/ 32150971522cSBarry Smith 3216d71ae5a4SJacob Faibussowitsch PETSC_EXTERN PetscErrorCode PCCreate_FieldSplit(PC pc) 3217d71ae5a4SJacob Faibussowitsch { 32180971522cSBarry Smith PC_FieldSplit *jac; 32190971522cSBarry Smith 32200971522cSBarry Smith PetscFunctionBegin; 32214dfa11a4SJacob Faibussowitsch PetscCall(PetscNew(&jac)); 32222fa5cd67SKarl Rupp 32230971522cSBarry Smith jac->bs = -1; 32240971522cSBarry Smith jac->nsplits = 0; 32253e197d65SBarry Smith jac->type = PC_COMPOSITE_MULTIPLICATIVE; 3226e6cab6aaSJed Brown jac->schurpre = PC_FIELDSPLIT_SCHUR_PRE_USER; /* Try user preconditioner first, fall back on diagonal */ 3227c9c6ffaaSJed Brown jac->schurfactorization = PC_FIELDSPLIT_SCHUR_FACT_FULL; 3228c096484dSStefano Zampini jac->schurscale = -1.0; 3229fbe7908bSJed Brown jac->dm_splits = PETSC_TRUE; 32307b752e3dSPatrick Sanan jac->detect = PETSC_FALSE; 3231a51937d4SCarola Kruse jac->gkbtol = 1e-5; 3232a51937d4SCarola Kruse jac->gkbdelay = 5; 3233a51937d4SCarola Kruse jac->gkbnu = 1; 3234a51937d4SCarola Kruse jac->gkbmaxit = 100; 3235de482cd7SCarola Kruse jac->gkbmonitor = PETSC_FALSE; 32365ddf11f8SNicolas Barnafi jac->coordinates_set = PETSC_FALSE; 323751f519a2SBarry Smith 32380971522cSBarry Smith pc->data = (void *)jac; 32390971522cSBarry Smith 32400971522cSBarry Smith pc->ops->apply = PCApply_FieldSplit; 3241421e10b8SBarry Smith pc->ops->applytranspose = PCApplyTranspose_FieldSplit; 32420971522cSBarry Smith pc->ops->setup = PCSetUp_FieldSplit; 3243574deadeSBarry Smith pc->ops->reset = PCReset_FieldSplit; 32440971522cSBarry Smith pc->ops->destroy = PCDestroy_FieldSplit; 32450971522cSBarry Smith pc->ops->setfromoptions = PCSetFromOptions_FieldSplit; 32460971522cSBarry Smith pc->ops->view = PCView_FieldSplit; 32470a545947SLisandro Dalcin pc->ops->applyrichardson = NULL; 32480971522cSBarry Smith 32499566063dSJacob Faibussowitsch PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSchurGetSubKSP_C", PCFieldSplitSchurGetSubKSP_FieldSplit)); 32509566063dSJacob Faibussowitsch PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitGetSubKSP_C", PCFieldSplitGetSubKSP_FieldSplit)); 32519566063dSJacob Faibussowitsch PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetFields_C", PCFieldSplitSetFields_FieldSplit)); 32529566063dSJacob Faibussowitsch PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetIS_C", PCFieldSplitSetIS_FieldSplit)); 32539566063dSJacob Faibussowitsch PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetType_C", PCFieldSplitSetType_FieldSplit)); 32549566063dSJacob Faibussowitsch PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetBlockSize_C", PCFieldSplitSetBlockSize_FieldSplit)); 32559566063dSJacob Faibussowitsch PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitRestrictIS_C", PCFieldSplitRestrictIS_FieldSplit)); 32569566063dSJacob Faibussowitsch PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCSetCoordinates_C", PCSetCoordinates_FieldSplit)); 32573ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 32580971522cSBarry Smith } 3259