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 } 1540971522cSBarry Smith PetscFunctionReturn(0); 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: 1809566063dSJacob Faibussowitsch PetscCall(MatSchurComplementGetAinvType(jac->schur, &atype)); 1819371c9d4SSatish 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 ")))); 182a9908d51SBarry Smith break; 183d71ae5a4SJacob Faibussowitsch case PC_FIELDSPLIT_SCHUR_PRE_A11: 184d71ae5a4SJacob Faibussowitsch PetscCall(PetscViewerASCIIPrintf(viewer, " Preconditioner for the Schur complement formed from A11\n")); 185d71ae5a4SJacob Faibussowitsch break; 186d71ae5a4SJacob Faibussowitsch case PC_FIELDSPLIT_SCHUR_PRE_FULL: 187d71ae5a4SJacob Faibussowitsch PetscCall(PetscViewerASCIIPrintf(viewer, " Preconditioner for the Schur complement formed from the exact Schur complement\n")); 188d71ae5a4SJacob Faibussowitsch break; 1893e8b8b31SMatthew G Knepley case PC_FIELDSPLIT_SCHUR_PRE_USER: 1903e8b8b31SMatthew G Knepley if (jac->schur_user) { 1919566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIIPrintf(viewer, " Preconditioner for the Schur complement formed from user provided matrix\n")); 1923e8b8b31SMatthew G Knepley } else { 1939566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIIPrintf(viewer, " Preconditioner for the Schur complement formed from A11\n")); 1943e8b8b31SMatthew G Knepley } 1953e8b8b31SMatthew G Knepley break; 196d71ae5a4SJacob Faibussowitsch default: 197d71ae5a4SJacob Faibussowitsch SETERRQ(PetscObjectComm((PetscObject)pc), PETSC_ERR_ARG_OUTOFRANGE, "Invalid Schur preconditioning type: %d", jac->schurpre); 1983e8b8b31SMatthew G Knepley } 1999566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIIPrintf(viewer, " Split info:\n")); 2009566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIIPushTab(viewer)); 2013b224e63SBarry Smith for (i = 0; i < jac->nsplits; i++) { 2023b224e63SBarry Smith if (ilink->fields) { 20363a3b9bcSJacob Faibussowitsch PetscCall(PetscViewerASCIIPrintf(viewer, "Split number %" PetscInt_FMT " Fields ", i)); 2049566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIIUseTabs(viewer, PETSC_FALSE)); 2053b224e63SBarry Smith for (j = 0; j < ilink->nfields; j++) { 20648a46eb9SPierre Jolivet if (j > 0) PetscCall(PetscViewerASCIIPrintf(viewer, ",")); 20763a3b9bcSJacob Faibussowitsch PetscCall(PetscViewerASCIIPrintf(viewer, " %" PetscInt_FMT, ilink->fields[j])); 2083b224e63SBarry Smith } 2099566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIIPrintf(viewer, "\n")); 2109566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIIUseTabs(viewer, PETSC_TRUE)); 2113b224e63SBarry Smith } else { 21263a3b9bcSJacob Faibussowitsch PetscCall(PetscViewerASCIIPrintf(viewer, "Split number %" PetscInt_FMT " Defined by IS\n", i)); 2133b224e63SBarry Smith } 2143b224e63SBarry Smith ilink = ilink->next; 2153b224e63SBarry Smith } 2169566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIIPrintf(viewer, "KSP solver for A00 block\n")); 2179566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIIPushTab(viewer)); 21806de4afeSJed Brown if (jac->head) { 2199566063dSJacob Faibussowitsch PetscCall(KSPView(jac->head->ksp, viewer)); 2209566063dSJacob Faibussowitsch } else PetscCall(PetscViewerASCIIPrintf(viewer, " not yet available\n")); 2219566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIIPopTab(viewer)); 22206de4afeSJed Brown if (jac->head && jac->kspupper != jac->head->ksp) { 2239566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIIPrintf(viewer, "KSP solver for upper A00 in upper triangular factor \n")); 2249566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIIPushTab(viewer)); 2259566063dSJacob Faibussowitsch if (jac->kspupper) PetscCall(KSPView(jac->kspupper, viewer)); 2269566063dSJacob Faibussowitsch else PetscCall(PetscViewerASCIIPrintf(viewer, " not yet available\n")); 2279566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIIPopTab(viewer)); 228443836d0SMatthew G Knepley } 2299566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIIPrintf(viewer, "KSP solver for S = A11 - A10 inv(A00) A01 \n")); 2309566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIIPushTab(viewer)); 23112cae6f2SJed Brown if (jac->kspschur) { 2329566063dSJacob Faibussowitsch PetscCall(KSPView(jac->kspschur, viewer)); 23312cae6f2SJed Brown } else { 2349566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIIPrintf(viewer, " not yet available\n")); 23512cae6f2SJed Brown } 2369566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIIPopTab(viewer)); 2379566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIIPopTab(viewer)); 23806de4afeSJed Brown } else if (isdraw && jac->head) { 2394996c5bdSBarry Smith PetscDraw draw; 2404996c5bdSBarry Smith PetscReal x, y, w, wd, h; 2414996c5bdSBarry Smith PetscInt cnt = 2; 2424996c5bdSBarry Smith char str[32]; 2434996c5bdSBarry Smith 2449566063dSJacob Faibussowitsch PetscCall(PetscViewerDrawGetDraw(viewer, 0, &draw)); 2459566063dSJacob Faibussowitsch PetscCall(PetscDrawGetCurrentPoint(draw, &x, &y)); 246c74581afSBarry Smith if (jac->kspupper != jac->head->ksp) cnt++; 247c74581afSBarry Smith w = 2 * PetscMin(1.0 - x, x); 248c74581afSBarry Smith wd = w / (cnt + 1); 249c74581afSBarry Smith 2509566063dSJacob Faibussowitsch PetscCall(PetscSNPrintf(str, 32, "Schur fact. %s", PCFieldSplitSchurFactTypes[jac->schurfactorization])); 2519566063dSJacob Faibussowitsch PetscCall(PetscDrawStringBoxed(draw, x, y, PETSC_DRAW_RED, PETSC_DRAW_BLACK, str, NULL, &h)); 2524996c5bdSBarry Smith y -= h; 2534996c5bdSBarry Smith if (jac->schurpre == PC_FIELDSPLIT_SCHUR_PRE_USER && !jac->schur_user) { 2549566063dSJacob Faibussowitsch PetscCall(PetscSNPrintf(str, 32, "Prec. for Schur from %s", PCFieldSplitSchurPreTypes[PC_FIELDSPLIT_SCHUR_PRE_A11])); 2553b224e63SBarry Smith } else { 2569566063dSJacob Faibussowitsch PetscCall(PetscSNPrintf(str, 32, "Prec. for Schur from %s", PCFieldSplitSchurPreTypes[jac->schurpre])); 2574996c5bdSBarry Smith } 2589566063dSJacob Faibussowitsch PetscCall(PetscDrawStringBoxed(draw, x + wd * (cnt - 1) / 2.0, y, PETSC_DRAW_RED, PETSC_DRAW_BLACK, str, NULL, &h)); 2594996c5bdSBarry Smith y -= h; 2604996c5bdSBarry Smith x = x - wd * (cnt - 1) / 2.0; 2614996c5bdSBarry Smith 2629566063dSJacob Faibussowitsch PetscCall(PetscDrawPushCurrentPoint(draw, x, y)); 2639566063dSJacob Faibussowitsch PetscCall(KSPView(jac->head->ksp, viewer)); 2649566063dSJacob Faibussowitsch PetscCall(PetscDrawPopCurrentPoint(draw)); 2654996c5bdSBarry Smith if (jac->kspupper != jac->head->ksp) { 2664996c5bdSBarry Smith x += wd; 2679566063dSJacob Faibussowitsch PetscCall(PetscDrawPushCurrentPoint(draw, x, y)); 2689566063dSJacob Faibussowitsch PetscCall(KSPView(jac->kspupper, viewer)); 2699566063dSJacob Faibussowitsch PetscCall(PetscDrawPopCurrentPoint(draw)); 2704996c5bdSBarry Smith } 2714996c5bdSBarry Smith x += wd; 2729566063dSJacob Faibussowitsch PetscCall(PetscDrawPushCurrentPoint(draw, x, y)); 2739566063dSJacob Faibussowitsch PetscCall(KSPView(jac->kspschur, viewer)); 2749566063dSJacob Faibussowitsch PetscCall(PetscDrawPopCurrentPoint(draw)); 2753b224e63SBarry Smith } 2763b224e63SBarry Smith PetscFunctionReturn(0); 2773b224e63SBarry Smith } 2783b224e63SBarry Smith 279d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCView_FieldSplit_GKB(PC pc, PetscViewer viewer) 280d71ae5a4SJacob Faibussowitsch { 281a51937d4SCarola Kruse PC_FieldSplit *jac = (PC_FieldSplit *)pc->data; 282a51937d4SCarola Kruse PetscBool iascii, isdraw; 283a51937d4SCarola Kruse PetscInt i, j; 284a51937d4SCarola Kruse PC_FieldSplitLink ilink = jac->head; 285a51937d4SCarola Kruse 286a51937d4SCarola Kruse PetscFunctionBegin; 2879566063dSJacob Faibussowitsch PetscCall(PetscObjectTypeCompare((PetscObject)viewer, PETSCVIEWERASCII, &iascii)); 2889566063dSJacob Faibussowitsch PetscCall(PetscObjectTypeCompare((PetscObject)viewer, PETSCVIEWERDRAW, &isdraw)); 289a51937d4SCarola Kruse if (iascii) { 290a51937d4SCarola Kruse if (jac->bs > 0) { 29163a3b9bcSJacob Faibussowitsch PetscCall(PetscViewerASCIIPrintf(viewer, " FieldSplit with %s composition: total splits = %" PetscInt_FMT ", blocksize = %" PetscInt_FMT "\n", PCCompositeTypes[jac->type], jac->nsplits, jac->bs)); 292a51937d4SCarola Kruse } else { 29363a3b9bcSJacob Faibussowitsch PetscCall(PetscViewerASCIIPrintf(viewer, " FieldSplit with %s composition: total splits = %" PetscInt_FMT "\n", PCCompositeTypes[jac->type], jac->nsplits)); 294a51937d4SCarola Kruse } 29548a46eb9SPierre Jolivet if (pc->useAmat) PetscCall(PetscViewerASCIIPrintf(viewer, " using Amat (not Pmat) as operator for blocks\n")); 29648a46eb9SPierre Jolivet if (jac->diag_use_amat) PetscCall(PetscViewerASCIIPrintf(viewer, " using Amat (not Pmat) as operator for diagonal blocks\n")); 29748a46eb9SPierre Jolivet if (jac->offdiag_use_amat) PetscCall(PetscViewerASCIIPrintf(viewer, " using Amat (not Pmat) as operator for off-diagonal blocks\n")); 298a51937d4SCarola Kruse 29963a3b9bcSJacob 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)); 3009566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIIPrintf(viewer, " Solver info for H = A00 + nu*A01*A01' matrix:\n")); 3019566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIIPushTab(viewer)); 302a51937d4SCarola Kruse 303a51937d4SCarola Kruse if (ilink->fields) { 30463a3b9bcSJacob Faibussowitsch PetscCall(PetscViewerASCIIPrintf(viewer, "Split number 0 Fields ")); 3059566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIIUseTabs(viewer, PETSC_FALSE)); 306a51937d4SCarola Kruse for (j = 0; j < ilink->nfields; j++) { 30748a46eb9SPierre Jolivet if (j > 0) PetscCall(PetscViewerASCIIPrintf(viewer, ",")); 30863a3b9bcSJacob Faibussowitsch PetscCall(PetscViewerASCIIPrintf(viewer, " %" PetscInt_FMT, ilink->fields[j])); 309a51937d4SCarola Kruse } 3109566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIIPrintf(viewer, "\n")); 3119566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIIUseTabs(viewer, PETSC_TRUE)); 312a51937d4SCarola Kruse } else { 31363a3b9bcSJacob Faibussowitsch PetscCall(PetscViewerASCIIPrintf(viewer, "Split number 0 Defined by IS\n")); 314a51937d4SCarola Kruse } 3159566063dSJacob Faibussowitsch PetscCall(KSPView(ilink->ksp, viewer)); 316a51937d4SCarola Kruse 3179566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIIPopTab(viewer)); 318a51937d4SCarola Kruse } 319a51937d4SCarola Kruse 320a51937d4SCarola Kruse if (isdraw) { 321a51937d4SCarola Kruse PetscDraw draw; 322a51937d4SCarola Kruse PetscReal x, y, w, wd; 323a51937d4SCarola Kruse 3249566063dSJacob Faibussowitsch PetscCall(PetscViewerDrawGetDraw(viewer, 0, &draw)); 3259566063dSJacob Faibussowitsch PetscCall(PetscDrawGetCurrentPoint(draw, &x, &y)); 326a51937d4SCarola Kruse w = 2 * PetscMin(1.0 - x, x); 327a51937d4SCarola Kruse wd = w / (jac->nsplits + 1); 328a51937d4SCarola Kruse x = x - wd * (jac->nsplits - 1) / 2.0; 329a51937d4SCarola Kruse for (i = 0; i < jac->nsplits; i++) { 3309566063dSJacob Faibussowitsch PetscCall(PetscDrawPushCurrentPoint(draw, x, y)); 3319566063dSJacob Faibussowitsch PetscCall(KSPView(ilink->ksp, viewer)); 3329566063dSJacob Faibussowitsch PetscCall(PetscDrawPopCurrentPoint(draw)); 333a51937d4SCarola Kruse x += wd; 334a51937d4SCarola Kruse ilink = ilink->next; 335a51937d4SCarola Kruse } 336a51937d4SCarola Kruse } 337a51937d4SCarola Kruse PetscFunctionReturn(0); 338a51937d4SCarola Kruse } 339a51937d4SCarola Kruse 3406c924f48SJed Brown /* Precondition: jac->bs is set to a meaningful value */ 341d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCFieldSplitSetRuntimeSplits_Private(PC pc) 342d71ae5a4SJacob Faibussowitsch { 3436c924f48SJed Brown PC_FieldSplit *jac = (PC_FieldSplit *)pc->data; 3445d4c12cdSJungho Lee PetscInt i, nfields, *ifields, nfields_col, *ifields_col; 3455d4c12cdSJungho Lee PetscBool flg, flg_col; 3465d4c12cdSJungho Lee char optionname[128], splitname[8], optionname_col[128]; 3476c924f48SJed Brown 3486c924f48SJed Brown PetscFunctionBegin; 3499566063dSJacob Faibussowitsch PetscCall(PetscMalloc1(jac->bs, &ifields)); 3509566063dSJacob Faibussowitsch PetscCall(PetscMalloc1(jac->bs, &ifields_col)); 3516c924f48SJed Brown for (i = 0, flg = PETSC_TRUE;; i++) { 35263a3b9bcSJacob Faibussowitsch PetscCall(PetscSNPrintf(splitname, sizeof(splitname), "%" PetscInt_FMT, i)); 35363a3b9bcSJacob Faibussowitsch PetscCall(PetscSNPrintf(optionname, sizeof(optionname), "-pc_fieldsplit_%" PetscInt_FMT "_fields", i)); 35463a3b9bcSJacob Faibussowitsch PetscCall(PetscSNPrintf(optionname_col, sizeof(optionname_col), "-pc_fieldsplit_%" PetscInt_FMT "_fields_col", i)); 3556c924f48SJed Brown nfields = jac->bs; 35629499fbbSJungho Lee nfields_col = jac->bs; 3579566063dSJacob Faibussowitsch PetscCall(PetscOptionsGetIntArray(((PetscObject)pc)->options, ((PetscObject)pc)->prefix, optionname, ifields, &nfields, &flg)); 3589566063dSJacob Faibussowitsch PetscCall(PetscOptionsGetIntArray(((PetscObject)pc)->options, ((PetscObject)pc)->prefix, optionname_col, ifields_col, &nfields_col, &flg_col)); 3596c924f48SJed Brown if (!flg) break; 3605d4c12cdSJungho Lee else if (flg && !flg_col) { 36128b400f6SJacob Faibussowitsch PetscCheck(nfields, PETSC_COMM_SELF, PETSC_ERR_USER, "Cannot list zero fields"); 3629566063dSJacob Faibussowitsch PetscCall(PCFieldSplitSetFields(pc, splitname, nfields, ifields, ifields)); 3632fa5cd67SKarl Rupp } else { 3647827d75bSBarry Smith PetscCheck(nfields && nfields_col, PETSC_COMM_SELF, PETSC_ERR_USER, "Cannot list zero fields"); 36508401ef6SPierre Jolivet PetscCheck(nfields == nfields_col, PETSC_COMM_SELF, PETSC_ERR_USER, "Number of row and column fields must match"); 3669566063dSJacob Faibussowitsch PetscCall(PCFieldSplitSetFields(pc, splitname, nfields, ifields, ifields_col)); 3675d4c12cdSJungho Lee } 3686c924f48SJed Brown } 3696c924f48SJed Brown if (i > 0) { 3706c924f48SJed Brown /* Makes command-line setting of splits take precedence over setting them in code. 3716c924f48SJed Brown Otherwise subsequent calls to PCFieldSplitSetIS() or PCFieldSplitSetFields() would 3726c924f48SJed Brown create new splits, which would probably not be what the user wanted. */ 3736c924f48SJed Brown jac->splitdefined = PETSC_TRUE; 3746c924f48SJed Brown } 3759566063dSJacob Faibussowitsch PetscCall(PetscFree(ifields)); 3769566063dSJacob Faibussowitsch PetscCall(PetscFree(ifields_col)); 3776c924f48SJed Brown PetscFunctionReturn(0); 3786c924f48SJed Brown } 3796c924f48SJed Brown 380d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCFieldSplitSetDefaults(PC pc) 381d71ae5a4SJacob Faibussowitsch { 3820971522cSBarry Smith PC_FieldSplit *jac = (PC_FieldSplit *)pc->data; 3835a9f2f41SSatish Balay PC_FieldSplitLink ilink = jac->head; 3847b752e3dSPatrick Sanan PetscBool fieldsplit_default = PETSC_FALSE, coupling = PETSC_FALSE; 3856c924f48SJed Brown PetscInt i; 3860971522cSBarry Smith 3870971522cSBarry Smith PetscFunctionBegin; 3887287d2a3SDmitry Karpeev /* 389f5f0d762SBarry Smith Kinda messy, but at least this now uses DMCreateFieldDecomposition(). 3907287d2a3SDmitry Karpeev Should probably be rewritten. 3917287d2a3SDmitry Karpeev */ 392f5f0d762SBarry Smith if (!ilink) { 3939566063dSJacob Faibussowitsch PetscCall(PetscOptionsGetBool(((PetscObject)pc)->options, ((PetscObject)pc)->prefix, "-pc_fieldsplit_detect_coupling", &coupling, NULL)); 3947b752e3dSPatrick Sanan if (pc->dm && jac->dm_splits && !jac->detect && !coupling) { 395bafc1b83SMatthew G Knepley PetscInt numFields, f, i, j; 3960784a22cSJed Brown char **fieldNames; 3977b62db95SJungho Lee IS *fields; 398e7c4fc90SDmitry Karpeev DM *dms; 399bafc1b83SMatthew G Knepley DM subdm[128]; 400bafc1b83SMatthew G Knepley PetscBool flg; 401bafc1b83SMatthew G Knepley 4029566063dSJacob Faibussowitsch PetscCall(DMCreateFieldDecomposition(pc->dm, &numFields, &fieldNames, &fields, &dms)); 403bafc1b83SMatthew G Knepley /* Allow the user to prescribe the splits */ 404bafc1b83SMatthew G Knepley for (i = 0, flg = PETSC_TRUE;; i++) { 405bafc1b83SMatthew G Knepley PetscInt ifields[128]; 406bafc1b83SMatthew G Knepley IS compField; 407bafc1b83SMatthew G Knepley char optionname[128], splitname[8]; 408bafc1b83SMatthew G Knepley PetscInt nfields = numFields; 409bafc1b83SMatthew G Knepley 41063a3b9bcSJacob Faibussowitsch PetscCall(PetscSNPrintf(optionname, sizeof(optionname), "-pc_fieldsplit_%" PetscInt_FMT "_fields", i)); 4119566063dSJacob Faibussowitsch PetscCall(PetscOptionsGetIntArray(((PetscObject)pc)->options, ((PetscObject)pc)->prefix, optionname, ifields, &nfields, &flg)); 412bafc1b83SMatthew G Knepley if (!flg) break; 41363a3b9bcSJacob Faibussowitsch PetscCheck(numFields <= 128, PetscObjectComm((PetscObject)pc), PETSC_ERR_SUP, "Cannot currently support %" PetscInt_FMT " > 128 fields", numFields); 4149566063dSJacob Faibussowitsch PetscCall(DMCreateSubDM(pc->dm, nfields, ifields, &compField, &subdm[i])); 415bafc1b83SMatthew G Knepley if (nfields == 1) { 4169566063dSJacob Faibussowitsch PetscCall(PCFieldSplitSetIS(pc, fieldNames[ifields[0]], compField)); 417bafc1b83SMatthew G Knepley } else { 41863a3b9bcSJacob Faibussowitsch PetscCall(PetscSNPrintf(splitname, sizeof(splitname), "%" PetscInt_FMT, i)); 4199566063dSJacob Faibussowitsch PetscCall(PCFieldSplitSetIS(pc, splitname, compField)); 4207287d2a3SDmitry Karpeev } 4219566063dSJacob Faibussowitsch PetscCall(ISDestroy(&compField)); 422bafc1b83SMatthew G Knepley for (j = 0; j < nfields; ++j) { 423bafc1b83SMatthew G Knepley f = ifields[j]; 4249566063dSJacob Faibussowitsch PetscCall(PetscFree(fieldNames[f])); 4259566063dSJacob Faibussowitsch PetscCall(ISDestroy(&fields[f])); 4267b62db95SJungho Lee } 427bafc1b83SMatthew G Knepley } 428bafc1b83SMatthew G Knepley if (i == 0) { 429bafc1b83SMatthew G Knepley for (f = 0; f < numFields; ++f) { 4309566063dSJacob Faibussowitsch PetscCall(PCFieldSplitSetIS(pc, fieldNames[f], fields[f])); 4319566063dSJacob Faibussowitsch PetscCall(PetscFree(fieldNames[f])); 4329566063dSJacob Faibussowitsch PetscCall(ISDestroy(&fields[f])); 433bafc1b83SMatthew G Knepley } 434bafc1b83SMatthew G Knepley } else { 43548a46eb9SPierre Jolivet for (j = 0; j < numFields; j++) PetscCall(DMDestroy(dms + j)); 4369566063dSJacob Faibussowitsch PetscCall(PetscFree(dms)); 4379566063dSJacob Faibussowitsch PetscCall(PetscMalloc1(i, &dms)); 4382fa5cd67SKarl Rupp for (j = 0; j < i; ++j) dms[j] = subdm[j]; 439bafc1b83SMatthew G Knepley } 4409566063dSJacob Faibussowitsch PetscCall(PetscFree(fieldNames)); 4419566063dSJacob Faibussowitsch PetscCall(PetscFree(fields)); 442e7c4fc90SDmitry Karpeev if (dms) { 4439566063dSJacob Faibussowitsch PetscCall(PetscInfo(pc, "Setting up physics based fieldsplit preconditioner using the embedded DM\n")); 444bafc1b83SMatthew G Knepley for (ilink = jac->head, i = 0; ilink; ilink = ilink->next, ++i) { 4457287d2a3SDmitry Karpeev const char *prefix; 4469566063dSJacob Faibussowitsch PetscCall(PetscObjectGetOptionsPrefix((PetscObject)(ilink->ksp), &prefix)); 4479566063dSJacob Faibussowitsch PetscCall(PetscObjectSetOptionsPrefix((PetscObject)(dms[i]), prefix)); 4489566063dSJacob Faibussowitsch PetscCall(KSPSetDM(ilink->ksp, dms[i])); 4499566063dSJacob Faibussowitsch PetscCall(KSPSetDMActive(ilink->ksp, PETSC_FALSE)); 45095dbaa6fSMatthew G. Knepley { 45195dbaa6fSMatthew G. Knepley PetscErrorCode (*func)(KSP, Mat, Mat, void *); 45295dbaa6fSMatthew G. Knepley void *ctx; 45395dbaa6fSMatthew G. Knepley 4549566063dSJacob Faibussowitsch PetscCall(DMKSPGetComputeOperators(pc->dm, &func, &ctx)); 4559566063dSJacob Faibussowitsch PetscCall(DMKSPSetComputeOperators(dms[i], func, ctx)); 45695dbaa6fSMatthew G. Knepley } 4579566063dSJacob Faibussowitsch PetscCall(PetscObjectIncrementTabLevel((PetscObject)dms[i], (PetscObject)ilink->ksp, 0)); 4589566063dSJacob Faibussowitsch PetscCall(DMDestroy(&dms[i])); 4592fa5ba8aSJed Brown } 4609566063dSJacob Faibussowitsch PetscCall(PetscFree(dms)); 4618b8307b2SJed Brown } 46266ffff09SJed Brown } else { 463521d7252SBarry Smith if (jac->bs <= 0) { 464704ba839SBarry Smith if (pc->pmat) { 4659566063dSJacob Faibussowitsch PetscCall(MatGetBlockSize(pc->pmat, &jac->bs)); 4662fa5cd67SKarl Rupp } else jac->bs = 1; 467521d7252SBarry Smith } 468d32f9abdSBarry Smith 4697b752e3dSPatrick Sanan if (jac->detect) { 4706ce1633cSBarry Smith IS zerodiags, rest; 4716ce1633cSBarry Smith PetscInt nmin, nmax; 4726ce1633cSBarry Smith 4739566063dSJacob Faibussowitsch PetscCall(MatGetOwnershipRange(pc->mat, &nmin, &nmax)); 4747199da05SBarry Smith if (jac->diag_use_amat) { 4759566063dSJacob Faibussowitsch PetscCall(MatFindZeroDiagonals(pc->mat, &zerodiags)); 4767199da05SBarry Smith } else { 4779566063dSJacob Faibussowitsch PetscCall(MatFindZeroDiagonals(pc->pmat, &zerodiags)); 4787199da05SBarry Smith } 4799566063dSJacob Faibussowitsch PetscCall(ISComplement(zerodiags, nmin, nmax, &rest)); 4809566063dSJacob Faibussowitsch PetscCall(PCFieldSplitSetIS(pc, "0", rest)); 4819566063dSJacob Faibussowitsch PetscCall(PCFieldSplitSetIS(pc, "1", zerodiags)); 4829566063dSJacob Faibussowitsch PetscCall(ISDestroy(&zerodiags)); 4839566063dSJacob Faibussowitsch PetscCall(ISDestroy(&rest)); 4843a062f41SBarry Smith } else if (coupling) { 4853a062f41SBarry Smith IS coupling, rest; 4863a062f41SBarry Smith PetscInt nmin, nmax; 4873a062f41SBarry Smith 4889566063dSJacob Faibussowitsch PetscCall(MatGetOwnershipRange(pc->mat, &nmin, &nmax)); 4897199da05SBarry Smith if (jac->offdiag_use_amat) { 4909566063dSJacob Faibussowitsch PetscCall(MatFindOffBlockDiagonalEntries(pc->mat, &coupling)); 4917199da05SBarry Smith } else { 4929566063dSJacob Faibussowitsch PetscCall(MatFindOffBlockDiagonalEntries(pc->pmat, &coupling)); 4937199da05SBarry Smith } 4949566063dSJacob Faibussowitsch PetscCall(ISCreateStride(PetscObjectComm((PetscObject)pc->mat), nmax - nmin, nmin, 1, &rest)); 4959566063dSJacob Faibussowitsch PetscCall(ISSetIdentity(rest)); 4969566063dSJacob Faibussowitsch PetscCall(PCFieldSplitSetIS(pc, "0", rest)); 4979566063dSJacob Faibussowitsch PetscCall(PCFieldSplitSetIS(pc, "1", coupling)); 4989566063dSJacob Faibussowitsch PetscCall(ISDestroy(&coupling)); 4999566063dSJacob Faibussowitsch PetscCall(ISDestroy(&rest)); 5006ce1633cSBarry Smith } else { 5019566063dSJacob Faibussowitsch PetscCall(PetscOptionsGetBool(((PetscObject)pc)->options, ((PetscObject)pc)->prefix, "-pc_fieldsplit_default", &fieldsplit_default, NULL)); 5027287d2a3SDmitry Karpeev if (!fieldsplit_default) { 503d32f9abdSBarry Smith /* Allow user to set fields from command line, if bs was known at the time of PCSetFromOptions_FieldSplit() 504d32f9abdSBarry Smith then it is set there. This is not ideal because we should only have options set in XXSetFromOptions(). */ 5059566063dSJacob Faibussowitsch PetscCall(PCFieldSplitSetRuntimeSplits_Private(pc)); 5069566063dSJacob Faibussowitsch if (jac->splitdefined) PetscCall(PetscInfo(pc, "Splits defined using the options database\n")); 507d32f9abdSBarry Smith } 5086dbb499eSCian Wilson if ((fieldsplit_default || !jac->splitdefined) && !jac->isrestrict) { 5099f001fe8SStefano Zampini Mat M = pc->pmat; 510f3b928b9SStefano Zampini PetscBool isnest; 511f3b928b9SStefano Zampini 5129566063dSJacob Faibussowitsch PetscCall(PetscInfo(pc, "Using default splitting of fields\n")); 5139566063dSJacob Faibussowitsch PetscCall(PetscObjectTypeCompare((PetscObject)pc->pmat, MATNEST, &isnest)); 514f3b928b9SStefano Zampini if (!isnest) { 5159f001fe8SStefano Zampini M = pc->mat; 5169566063dSJacob Faibussowitsch PetscCall(PetscObjectTypeCompare((PetscObject)pc->mat, MATNEST, &isnest)); 517f3b928b9SStefano Zampini } 518f3b928b9SStefano Zampini if (isnest) { 519f3b928b9SStefano Zampini IS *fields; 520f3b928b9SStefano Zampini PetscInt nf; 521f3b928b9SStefano Zampini 5229566063dSJacob Faibussowitsch PetscCall(MatNestGetSize(M, &nf, NULL)); 5239566063dSJacob Faibussowitsch PetscCall(PetscMalloc1(nf, &fields)); 5249566063dSJacob Faibussowitsch PetscCall(MatNestGetISs(M, fields, NULL)); 52548a46eb9SPierre Jolivet for (i = 0; i < nf; i++) PetscCall(PCFieldSplitSetIS(pc, NULL, fields[i])); 5269566063dSJacob Faibussowitsch PetscCall(PetscFree(fields)); 527f3b928b9SStefano Zampini } else { 528db4c96c1SJed Brown for (i = 0; i < jac->bs; i++) { 5296c924f48SJed Brown char splitname[8]; 53063a3b9bcSJacob Faibussowitsch PetscCall(PetscSNPrintf(splitname, sizeof(splitname), "%" PetscInt_FMT, i)); 5319566063dSJacob Faibussowitsch PetscCall(PCFieldSplitSetFields(pc, splitname, 1, &i, &i)); 53279416396SBarry Smith } 5335d4c12cdSJungho Lee jac->defaultsplit = PETSC_TRUE; 534521d7252SBarry Smith } 53566ffff09SJed Brown } 5366ce1633cSBarry Smith } 537f3b928b9SStefano Zampini } 538edf189efSBarry Smith } else if (jac->nsplits == 1) { 539edf189efSBarry Smith IS is2; 540edf189efSBarry Smith PetscInt nmin, nmax; 541edf189efSBarry Smith 542*0fdf79fbSJacob Faibussowitsch PetscCheck(ilink->is, PetscObjectComm((PetscObject)pc), PETSC_ERR_SUP, "Must provide at least two sets of fields to PCFieldSplit()"); 5439566063dSJacob Faibussowitsch PetscCall(MatGetOwnershipRange(pc->mat, &nmin, &nmax)); 5449566063dSJacob Faibussowitsch PetscCall(ISComplement(ilink->is, nmin, nmax, &is2)); 5459566063dSJacob Faibussowitsch PetscCall(PCFieldSplitSetIS(pc, "1", is2)); 5469566063dSJacob Faibussowitsch PetscCall(ISDestroy(&is2)); 547edf189efSBarry Smith } 548d0af7cd3SBarry Smith 54963a3b9bcSJacob Faibussowitsch PetscCheck(jac->nsplits >= 2, PetscObjectComm((PetscObject)pc), PETSC_ERR_PLIB, "Unhandled case, must have at least two fields, not %" PetscInt_FMT, jac->nsplits); 55069a612a9SBarry Smith PetscFunctionReturn(0); 55169a612a9SBarry Smith } 55269a612a9SBarry Smith 553d71ae5a4SJacob Faibussowitsch static PetscErrorCode MatGolubKahanComputeExplicitOperator(Mat A, Mat B, Mat C, Mat *H, PetscReal gkbnu) 554d71ae5a4SJacob Faibussowitsch { 555a51937d4SCarola Kruse Mat BT, T; 556de482cd7SCarola Kruse PetscReal nrmT, nrmB; 557a51937d4SCarola Kruse 558a51937d4SCarola Kruse PetscFunctionBegin; 5599566063dSJacob Faibussowitsch PetscCall(MatHermitianTranspose(C, MAT_INITIAL_MATRIX, &T)); /* Test if augmented matrix is symmetric */ 5609566063dSJacob Faibussowitsch PetscCall(MatAXPY(T, -1.0, B, DIFFERENT_NONZERO_PATTERN)); 5619566063dSJacob Faibussowitsch PetscCall(MatNorm(T, NORM_1, &nrmT)); 5629566063dSJacob Faibussowitsch PetscCall(MatNorm(B, NORM_1, &nrmB)); 563049d1499SBarry Smith PetscCheck(nrmB <= 0 || nrmT / nrmB < PETSC_SMALL, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "Matrix is not symmetric/hermitian, GKB is not applicable."); 564049d1499SBarry Smith 565a51937d4SCarola Kruse /* Compute augmented Lagrangian matrix H = A00 + nu*A01*A01'. This corresponds to */ 566a51937d4SCarola Kruse /* setting N := 1/nu*I in [Ar13]. */ 5679566063dSJacob Faibussowitsch PetscCall(MatHermitianTranspose(B, MAT_INITIAL_MATRIX, &BT)); 5689566063dSJacob Faibussowitsch PetscCall(MatMatMult(B, BT, MAT_INITIAL_MATRIX, PETSC_DEFAULT, H)); /* H = A01*A01' */ 5699566063dSJacob Faibussowitsch PetscCall(MatAYPX(*H, gkbnu, A, DIFFERENT_NONZERO_PATTERN)); /* H = A00 + nu*A01*A01' */ 570a51937d4SCarola Kruse 5719566063dSJacob Faibussowitsch PetscCall(MatDestroy(&BT)); 5729566063dSJacob Faibussowitsch PetscCall(MatDestroy(&T)); 573a51937d4SCarola Kruse PetscFunctionReturn(0); 574a51937d4SCarola Kruse } 575a51937d4SCarola Kruse 5762d747510SLisandro Dalcin PETSC_EXTERN PetscErrorCode PetscOptionsFindPairPrefix_Private(PetscOptions, const char pre[], const char name[], const char *value[], PetscBool *flg); 577514bf10dSMatthew G Knepley 578d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCSetUp_FieldSplit(PC pc) 579d71ae5a4SJacob Faibussowitsch { 58069a612a9SBarry Smith PC_FieldSplit *jac = (PC_FieldSplit *)pc->data; 5815a9f2f41SSatish Balay PC_FieldSplitLink ilink; 5822c9966d7SBarry Smith PetscInt i, nsplit; 5835f4ab4e1SJungho Lee PetscBool sorted, sorted_col; 58469a612a9SBarry Smith 58569a612a9SBarry Smith PetscFunctionBegin; 5865da88fe4STristan Konolige pc->failedreason = PC_NOERROR; 5879566063dSJacob Faibussowitsch PetscCall(PCFieldSplitSetDefaults(pc)); 58897bbdb24SBarry Smith nsplit = jac->nsplits; 5895a9f2f41SSatish Balay ilink = jac->head; 59097bbdb24SBarry Smith 59197bbdb24SBarry Smith /* get the matrices for each split */ 592704ba839SBarry Smith if (!jac->issetup) { 5931b9fc7fcSBarry Smith PetscInt rstart, rend, nslots, bs; 59497bbdb24SBarry Smith 595704ba839SBarry Smith jac->issetup = PETSC_TRUE; 596704ba839SBarry Smith 5975d4c12cdSJungho Lee /* This is done here instead of in PCFieldSplitSetFields() because may not have matrix at that point */ 5982c9966d7SBarry Smith if (jac->defaultsplit || !ilink->is) { 5992c9966d7SBarry Smith if (jac->bs <= 0) jac->bs = nsplit; 6002c9966d7SBarry Smith } 60151f519a2SBarry Smith bs = jac->bs; 6029566063dSJacob Faibussowitsch PetscCall(MatGetOwnershipRange(pc->pmat, &rstart, &rend)); 6031b9fc7fcSBarry Smith nslots = (rend - rstart) / bs; 6041b9fc7fcSBarry Smith for (i = 0; i < nsplit; i++) { 6051b9fc7fcSBarry Smith if (jac->defaultsplit) { 6069566063dSJacob Faibussowitsch PetscCall(ISCreateStride(PetscObjectComm((PetscObject)pc), nslots, rstart + i, nsplit, &ilink->is)); 6079566063dSJacob Faibussowitsch PetscCall(ISDuplicate(ilink->is, &ilink->is_col)); 608704ba839SBarry Smith } else if (!ilink->is) { 609ccb205f8SBarry Smith if (ilink->nfields > 1) { 6105f4ab4e1SJungho Lee PetscInt *ii, *jj, j, k, nfields = ilink->nfields, *fields = ilink->fields, *fields_col = ilink->fields_col; 6119566063dSJacob Faibussowitsch PetscCall(PetscMalloc1(ilink->nfields * nslots, &ii)); 6129566063dSJacob Faibussowitsch PetscCall(PetscMalloc1(ilink->nfields * nslots, &jj)); 6131b9fc7fcSBarry Smith for (j = 0; j < nslots; j++) { 6141b9fc7fcSBarry Smith for (k = 0; k < nfields; k++) { 6151b9fc7fcSBarry Smith ii[nfields * j + k] = rstart + bs * j + fields[k]; 6165f4ab4e1SJungho Lee jj[nfields * j + k] = rstart + bs * j + fields_col[k]; 61797bbdb24SBarry Smith } 61897bbdb24SBarry Smith } 6199566063dSJacob Faibussowitsch PetscCall(ISCreateGeneral(PetscObjectComm((PetscObject)pc), nslots * nfields, ii, PETSC_OWN_POINTER, &ilink->is)); 6209566063dSJacob Faibussowitsch PetscCall(ISCreateGeneral(PetscObjectComm((PetscObject)pc), nslots * nfields, jj, PETSC_OWN_POINTER, &ilink->is_col)); 6219566063dSJacob Faibussowitsch PetscCall(ISSetBlockSize(ilink->is, nfields)); 6229566063dSJacob Faibussowitsch PetscCall(ISSetBlockSize(ilink->is_col, nfields)); 623ccb205f8SBarry Smith } else { 6249566063dSJacob Faibussowitsch PetscCall(ISCreateStride(PetscObjectComm((PetscObject)pc), nslots, rstart + ilink->fields[0], bs, &ilink->is)); 6259566063dSJacob Faibussowitsch PetscCall(ISCreateStride(PetscObjectComm((PetscObject)pc), nslots, rstart + ilink->fields_col[0], bs, &ilink->is_col)); 626ccb205f8SBarry Smith } 6273e197d65SBarry Smith } 6289566063dSJacob Faibussowitsch PetscCall(ISSorted(ilink->is, &sorted)); 6299566063dSJacob Faibussowitsch if (ilink->is_col) PetscCall(ISSorted(ilink->is_col, &sorted_col)); 6307827d75bSBarry Smith PetscCheck(sorted && sorted_col, PETSC_COMM_SELF, PETSC_ERR_USER, "Fields must be sorted when creating split"); 631704ba839SBarry Smith ilink = ilink->next; 6321b9fc7fcSBarry Smith } 6331b9fc7fcSBarry Smith } 6341b9fc7fcSBarry Smith 635704ba839SBarry Smith ilink = jac->head; 63697bbdb24SBarry Smith if (!jac->pmat) { 637bdddcaaaSMatthew G Knepley Vec xtmp; 638bdddcaaaSMatthew G Knepley 6399566063dSJacob Faibussowitsch PetscCall(MatCreateVecs(pc->pmat, &xtmp, NULL)); 6409566063dSJacob Faibussowitsch PetscCall(PetscMalloc1(nsplit, &jac->pmat)); 6419566063dSJacob Faibussowitsch PetscCall(PetscMalloc2(nsplit, &jac->x, nsplit, &jac->y)); 642cf502942SBarry Smith for (i = 0; i < nsplit; i++) { 643bdddcaaaSMatthew G Knepley MatNullSpace sp; 644bdddcaaaSMatthew G Knepley 645a3df900dSMatthew G Knepley /* Check for preconditioning matrix attached to IS */ 6469566063dSJacob Faibussowitsch PetscCall(PetscObjectQuery((PetscObject)ilink->is, "pmat", (PetscObject *)&jac->pmat[i])); 647a3df900dSMatthew G Knepley if (jac->pmat[i]) { 6489566063dSJacob Faibussowitsch PetscCall(PetscObjectReference((PetscObject)jac->pmat[i])); 649a3df900dSMatthew G Knepley if (jac->type == PC_COMPOSITE_SCHUR) { 650a3df900dSMatthew G Knepley jac->schur_user = jac->pmat[i]; 6512fa5cd67SKarl Rupp 6529566063dSJacob Faibussowitsch PetscCall(PetscObjectReference((PetscObject)jac->schur_user)); 653a3df900dSMatthew G Knepley } 654a3df900dSMatthew G Knepley } else { 6553a062f41SBarry Smith const char *prefix; 6569566063dSJacob Faibussowitsch PetscCall(MatCreateSubMatrix(pc->pmat, ilink->is, ilink->is_col, MAT_INITIAL_MATRIX, &jac->pmat[i])); 6579566063dSJacob Faibussowitsch PetscCall(KSPGetOptionsPrefix(ilink->ksp, &prefix)); 6589566063dSJacob Faibussowitsch PetscCall(MatSetOptionsPrefix(jac->pmat[i], prefix)); 6599566063dSJacob Faibussowitsch PetscCall(MatViewFromOptions(jac->pmat[i], NULL, "-mat_view")); 660a3df900dSMatthew G Knepley } 661bdddcaaaSMatthew G Knepley /* create work vectors for each split */ 6629566063dSJacob Faibussowitsch PetscCall(MatCreateVecs(jac->pmat[i], &jac->x[i], &jac->y[i])); 6639371c9d4SSatish Balay ilink->x = jac->x[i]; 6649371c9d4SSatish Balay ilink->y = jac->y[i]; 6659371c9d4SSatish Balay ilink->z = NULL; 666bdddcaaaSMatthew G Knepley /* compute scatter contexts needed by multiplicative versions and non-default splits */ 6679566063dSJacob Faibussowitsch PetscCall(VecScatterCreate(xtmp, ilink->is, jac->x[i], NULL, &ilink->sctx)); 6689566063dSJacob Faibussowitsch PetscCall(PetscObjectQuery((PetscObject)ilink->is, "nearnullspace", (PetscObject *)&sp)); 66948a46eb9SPierre Jolivet if (sp) PetscCall(MatSetNearNullSpace(jac->pmat[i], sp)); 670704ba839SBarry Smith ilink = ilink->next; 671cf502942SBarry Smith } 6729566063dSJacob Faibussowitsch PetscCall(VecDestroy(&xtmp)); 67397bbdb24SBarry Smith } else { 674ef7efd37SHong Zhang MatReuse scall; 675ef7efd37SHong Zhang if (pc->flag == DIFFERENT_NONZERO_PATTERN) { 67648a46eb9SPierre Jolivet for (i = 0; i < nsplit; i++) PetscCall(MatDestroy(&jac->pmat[i])); 677ef7efd37SHong Zhang scall = MAT_INITIAL_MATRIX; 678ef7efd37SHong Zhang } else scall = MAT_REUSE_MATRIX; 679ef7efd37SHong Zhang 680cf502942SBarry Smith for (i = 0; i < nsplit; i++) { 681a3df900dSMatthew G Knepley Mat pmat; 682a3df900dSMatthew G Knepley 683a3df900dSMatthew G Knepley /* Check for preconditioning matrix attached to IS */ 6849566063dSJacob Faibussowitsch PetscCall(PetscObjectQuery((PetscObject)ilink->is, "pmat", (PetscObject *)&pmat)); 68548a46eb9SPierre Jolivet if (!pmat) PetscCall(MatCreateSubMatrix(pc->pmat, ilink->is, ilink->is_col, scall, &jac->pmat[i])); 686704ba839SBarry Smith ilink = ilink->next; 687cf502942SBarry Smith } 68897bbdb24SBarry Smith } 6894e39094bSDmitry Karpeev if (jac->diag_use_amat) { 690519d70e2SJed Brown ilink = jac->head; 691519d70e2SJed Brown if (!jac->mat) { 6929566063dSJacob Faibussowitsch PetscCall(PetscMalloc1(nsplit, &jac->mat)); 693519d70e2SJed Brown for (i = 0; i < nsplit; i++) { 6949566063dSJacob Faibussowitsch PetscCall(MatCreateSubMatrix(pc->mat, ilink->is, ilink->is_col, MAT_INITIAL_MATRIX, &jac->mat[i])); 695519d70e2SJed Brown ilink = ilink->next; 696519d70e2SJed Brown } 697519d70e2SJed Brown } else { 698ef7efd37SHong Zhang MatReuse scall; 699ef7efd37SHong Zhang if (pc->flag == DIFFERENT_NONZERO_PATTERN) { 70048a46eb9SPierre Jolivet for (i = 0; i < nsplit; i++) PetscCall(MatDestroy(&jac->mat[i])); 701ef7efd37SHong Zhang scall = MAT_INITIAL_MATRIX; 702ef7efd37SHong Zhang } else scall = MAT_REUSE_MATRIX; 703ef7efd37SHong Zhang 704ef7efd37SHong Zhang for (i = 0; i < nsplit; i++) { 7059566063dSJacob Faibussowitsch PetscCall(MatCreateSubMatrix(pc->mat, ilink->is, ilink->is_col, scall, &jac->mat[i])); 706519d70e2SJed Brown ilink = ilink->next; 707519d70e2SJed Brown } 708519d70e2SJed Brown } 709519d70e2SJed Brown } else { 710519d70e2SJed Brown jac->mat = jac->pmat; 711519d70e2SJed Brown } 71297bbdb24SBarry Smith 71353935eafSBarry Smith /* Check for null space attached to IS */ 71453935eafSBarry Smith ilink = jac->head; 71553935eafSBarry Smith for (i = 0; i < nsplit; i++) { 71653935eafSBarry Smith MatNullSpace sp; 71753935eafSBarry Smith 7189566063dSJacob Faibussowitsch PetscCall(PetscObjectQuery((PetscObject)ilink->is, "nullspace", (PetscObject *)&sp)); 71948a46eb9SPierre Jolivet if (sp) PetscCall(MatSetNullSpace(jac->mat[i], sp)); 72053935eafSBarry Smith ilink = ilink->next; 72153935eafSBarry Smith } 72253935eafSBarry Smith 723a51937d4SCarola Kruse if (jac->type != PC_COMPOSITE_ADDITIVE && jac->type != PC_COMPOSITE_SCHUR && jac->type != PC_COMPOSITE_GKB) { 72468dd23aaSBarry Smith /* extract the rows of the matrix associated with each field: used for efficient computation of residual inside algorithm */ 7254e39094bSDmitry Karpeev /* FIXME: Can/should we reuse jac->mat whenever (jac->diag_use_amat) is true? */ 72668dd23aaSBarry Smith ilink = jac->head; 727e52d2c62SBarry Smith if (nsplit == 2 && jac->type == PC_COMPOSITE_MULTIPLICATIVE) { 728e52d2c62SBarry 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 */ 729e52d2c62SBarry Smith if (!jac->Afield) { 7309566063dSJacob Faibussowitsch PetscCall(PetscCalloc1(nsplit, &jac->Afield)); 73180c96bb1SFande Kong if (jac->offdiag_use_amat) { 7329566063dSJacob Faibussowitsch PetscCall(MatCreateSubMatrix(pc->mat, ilink->next->is, ilink->is, MAT_INITIAL_MATRIX, &jac->Afield[1])); 733e52d2c62SBarry Smith } else { 7349566063dSJacob Faibussowitsch PetscCall(MatCreateSubMatrix(pc->pmat, ilink->next->is, ilink->is, MAT_INITIAL_MATRIX, &jac->Afield[1])); 73580c96bb1SFande Kong } 73680c96bb1SFande Kong } else { 737ef7efd37SHong Zhang MatReuse scall; 738e9422dd5SStefano Zampini 739ef7efd37SHong Zhang if (pc->flag == DIFFERENT_NONZERO_PATTERN) { 7409566063dSJacob Faibussowitsch PetscCall(MatDestroy(&jac->Afield[1])); 741ef7efd37SHong Zhang scall = MAT_INITIAL_MATRIX; 742ef7efd37SHong Zhang } else scall = MAT_REUSE_MATRIX; 743ef7efd37SHong Zhang 74480c96bb1SFande Kong if (jac->offdiag_use_amat) { 7459566063dSJacob Faibussowitsch PetscCall(MatCreateSubMatrix(pc->mat, ilink->next->is, ilink->is, scall, &jac->Afield[1])); 74680c96bb1SFande Kong } else { 7479566063dSJacob Faibussowitsch PetscCall(MatCreateSubMatrix(pc->pmat, ilink->next->is, ilink->is, scall, &jac->Afield[1])); 74880c96bb1SFande Kong } 749e52d2c62SBarry Smith } 750e52d2c62SBarry Smith } else { 75168dd23aaSBarry Smith if (!jac->Afield) { 7529566063dSJacob Faibussowitsch PetscCall(PetscMalloc1(nsplit, &jac->Afield)); 75368dd23aaSBarry Smith for (i = 0; i < nsplit; i++) { 75480c96bb1SFande Kong if (jac->offdiag_use_amat) { 7559566063dSJacob Faibussowitsch PetscCall(MatCreateSubMatrix(pc->mat, ilink->is, NULL, MAT_INITIAL_MATRIX, &jac->Afield[i])); 75680c96bb1SFande Kong } else { 7579566063dSJacob Faibussowitsch PetscCall(MatCreateSubMatrix(pc->pmat, ilink->is, NULL, MAT_INITIAL_MATRIX, &jac->Afield[i])); 75880c96bb1SFande Kong } 75968dd23aaSBarry Smith ilink = ilink->next; 76068dd23aaSBarry Smith } 76168dd23aaSBarry Smith } else { 762ef7efd37SHong Zhang MatReuse scall; 763ef7efd37SHong Zhang if (pc->flag == DIFFERENT_NONZERO_PATTERN) { 76448a46eb9SPierre Jolivet for (i = 0; i < nsplit; i++) PetscCall(MatDestroy(&jac->Afield[i])); 765ef7efd37SHong Zhang scall = MAT_INITIAL_MATRIX; 766ef7efd37SHong Zhang } else scall = MAT_REUSE_MATRIX; 767ef7efd37SHong Zhang 76868dd23aaSBarry Smith for (i = 0; i < nsplit; i++) { 76980c96bb1SFande Kong if (jac->offdiag_use_amat) { 7709566063dSJacob Faibussowitsch PetscCall(MatCreateSubMatrix(pc->mat, ilink->is, NULL, scall, &jac->Afield[i])); 77180c96bb1SFande Kong } else { 7729566063dSJacob Faibussowitsch PetscCall(MatCreateSubMatrix(pc->pmat, ilink->is, NULL, scall, &jac->Afield[i])); 77380c96bb1SFande Kong } 77468dd23aaSBarry Smith ilink = ilink->next; 77568dd23aaSBarry Smith } 77668dd23aaSBarry Smith } 77768dd23aaSBarry Smith } 778e52d2c62SBarry Smith } 77968dd23aaSBarry Smith 7803b224e63SBarry Smith if (jac->type == PC_COMPOSITE_SCHUR) { 7813b224e63SBarry Smith IS ccis; 782b94d7dedSBarry Smith PetscBool isset, isspd; 7834aa3045dSJed Brown PetscInt rstart, rend; 784093c86ffSJed Brown char lscname[256]; 785093c86ffSJed Brown PetscObject LSC_L; 786ce94432eSBarry Smith 78708401ef6SPierre Jolivet PetscCheck(nsplit == 2, PetscObjectComm((PetscObject)pc), PETSC_ERR_ARG_INCOMP, "To use Schur complement preconditioner you must have exactly 2 fields"); 78868dd23aaSBarry Smith 789c096484dSStefano Zampini /* If pc->mat is SPD, don't scale by -1 the Schur complement */ 790c096484dSStefano Zampini if (jac->schurscale == (PetscScalar)-1.0) { 791b94d7dedSBarry Smith PetscCall(MatIsSPDKnown(pc->pmat, &isset, &isspd)); 792b94d7dedSBarry Smith jac->schurscale = (isset && isspd) ? 1.0 : -1.0; 793c096484dSStefano Zampini } 794c096484dSStefano Zampini 795e6cab6aaSJed Brown /* When extracting off-diagonal submatrices, we take complements from this range */ 7969566063dSJacob Faibussowitsch PetscCall(MatGetOwnershipRangeColumn(pc->mat, &rstart, &rend)); 797e6cab6aaSJed Brown 7983b224e63SBarry Smith if (jac->schur) { 7990298fd71SBarry Smith KSP kspA = jac->head->ksp, kspInner = NULL, kspUpper = jac->kspupper; 800e9422dd5SStefano Zampini MatReuse scall; 801e9422dd5SStefano Zampini 802e9422dd5SStefano Zampini if (pc->flag == DIFFERENT_NONZERO_PATTERN) { 803e9422dd5SStefano Zampini scall = MAT_INITIAL_MATRIX; 8049566063dSJacob Faibussowitsch PetscCall(MatDestroy(&jac->B)); 8059566063dSJacob Faibussowitsch PetscCall(MatDestroy(&jac->C)); 806e9422dd5SStefano Zampini } else scall = MAT_REUSE_MATRIX; 807443836d0SMatthew G Knepley 8089566063dSJacob Faibussowitsch PetscCall(MatSchurComplementGetKSP(jac->schur, &kspInner)); 8093b224e63SBarry Smith ilink = jac->head; 8109566063dSJacob Faibussowitsch PetscCall(ISComplement(ilink->is_col, rstart, rend, &ccis)); 8114e39094bSDmitry Karpeev if (jac->offdiag_use_amat) { 8129566063dSJacob Faibussowitsch PetscCall(MatCreateSubMatrix(pc->mat, ilink->is, ccis, scall, &jac->B)); 813c84da90fSDmitry Karpeev } else { 8149566063dSJacob Faibussowitsch PetscCall(MatCreateSubMatrix(pc->pmat, ilink->is, ccis, scall, &jac->B)); 815c84da90fSDmitry Karpeev } 8169566063dSJacob Faibussowitsch PetscCall(ISDestroy(&ccis)); 8173b224e63SBarry Smith ilink = ilink->next; 8189566063dSJacob Faibussowitsch PetscCall(ISComplement(ilink->is_col, rstart, rend, &ccis)); 8194e39094bSDmitry Karpeev if (jac->offdiag_use_amat) { 8209566063dSJacob Faibussowitsch PetscCall(MatCreateSubMatrix(pc->mat, ilink->is, ccis, scall, &jac->C)); 821c84da90fSDmitry Karpeev } else { 8229566063dSJacob Faibussowitsch PetscCall(MatCreateSubMatrix(pc->pmat, ilink->is, ccis, scall, &jac->C)); 823c84da90fSDmitry Karpeev } 8249566063dSJacob Faibussowitsch PetscCall(ISDestroy(&ccis)); 8259566063dSJacob Faibussowitsch PetscCall(MatSchurComplementUpdateSubMatrices(jac->schur, jac->mat[0], jac->pmat[0], jac->B, jac->C, jac->mat[1])); 826a7476a74SDmitry Karpeev if (jac->schurpre == PC_FIELDSPLIT_SCHUR_PRE_SELFP) { 8279566063dSJacob Faibussowitsch PetscCall(MatDestroy(&jac->schurp)); 8289566063dSJacob Faibussowitsch PetscCall(MatSchurComplementGetPmat(jac->schur, MAT_INITIAL_MATRIX, &jac->schurp)); 829a7476a74SDmitry Karpeev } 83048a46eb9SPierre Jolivet if (kspA != kspInner) PetscCall(KSPSetOperators(kspA, jac->mat[0], jac->pmat[0])); 83148a46eb9SPierre Jolivet if (kspUpper != kspA) PetscCall(KSPSetOperators(kspUpper, jac->mat[0], jac->pmat[0])); 8329566063dSJacob Faibussowitsch PetscCall(KSPSetOperators(jac->kspschur, jac->schur, FieldSplitSchurPre(jac))); 8333b224e63SBarry Smith } else { 834bafc1b83SMatthew G Knepley const char *Dprefix; 835470b340bSDmitry Karpeev char schurprefix[256], schurmatprefix[256]; 836514bf10dSMatthew G Knepley char schurtestoption[256]; 837bdddcaaaSMatthew G Knepley MatNullSpace sp; 838514bf10dSMatthew G Knepley PetscBool flg; 839686bed4dSStefano Zampini KSP kspt; 8403b224e63SBarry Smith 841a04f6461SBarry Smith /* extract the A01 and A10 matrices */ 8423b224e63SBarry Smith ilink = jac->head; 8439566063dSJacob Faibussowitsch PetscCall(ISComplement(ilink->is_col, rstart, rend, &ccis)); 8444e39094bSDmitry Karpeev if (jac->offdiag_use_amat) { 8459566063dSJacob Faibussowitsch PetscCall(MatCreateSubMatrix(pc->mat, ilink->is, ccis, MAT_INITIAL_MATRIX, &jac->B)); 846c84da90fSDmitry Karpeev } else { 8479566063dSJacob Faibussowitsch PetscCall(MatCreateSubMatrix(pc->pmat, ilink->is, ccis, MAT_INITIAL_MATRIX, &jac->B)); 848c84da90fSDmitry Karpeev } 8499566063dSJacob Faibussowitsch PetscCall(ISDestroy(&ccis)); 8503b224e63SBarry Smith ilink = ilink->next; 8519566063dSJacob Faibussowitsch PetscCall(ISComplement(ilink->is_col, rstart, rend, &ccis)); 8524e39094bSDmitry Karpeev if (jac->offdiag_use_amat) { 8539566063dSJacob Faibussowitsch PetscCall(MatCreateSubMatrix(pc->mat, ilink->is, ccis, MAT_INITIAL_MATRIX, &jac->C)); 854c84da90fSDmitry Karpeev } else { 8559566063dSJacob Faibussowitsch PetscCall(MatCreateSubMatrix(pc->pmat, ilink->is, ccis, MAT_INITIAL_MATRIX, &jac->C)); 856c84da90fSDmitry Karpeev } 8579566063dSJacob Faibussowitsch PetscCall(ISDestroy(&ccis)); 85820252d06SBarry Smith 859f5236f50SJed Brown /* Use mat[0] (diagonal block of Amat) preconditioned by pmat[0] to define Schur complement */ 8609566063dSJacob Faibussowitsch PetscCall(MatCreate(((PetscObject)jac->mat[0])->comm, &jac->schur)); 8619566063dSJacob Faibussowitsch PetscCall(MatSetType(jac->schur, MATSCHURCOMPLEMENT)); 8629566063dSJacob Faibussowitsch PetscCall(MatSchurComplementSetSubMatrices(jac->schur, jac->mat[0], jac->pmat[0], jac->B, jac->C, jac->mat[1])); 8639566063dSJacob Faibussowitsch PetscCall(PetscSNPrintf(schurmatprefix, sizeof(schurmatprefix), "%sfieldsplit_%s_", ((PetscObject)pc)->prefix ? ((PetscObject)pc)->prefix : "", ilink->splitname)); 8649566063dSJacob Faibussowitsch PetscCall(MatSetOptionsPrefix(jac->schur, schurmatprefix)); 8659566063dSJacob Faibussowitsch PetscCall(MatSchurComplementGetKSP(jac->schur, &kspt)); 8669566063dSJacob Faibussowitsch PetscCall(KSPSetOptionsPrefix(kspt, schurmatprefix)); 867686bed4dSStefano Zampini 868686bed4dSStefano Zampini /* Note: this is not true in general */ 8699566063dSJacob Faibussowitsch PetscCall(MatGetNullSpace(jac->mat[1], &sp)); 8701baa6e33SBarry Smith if (sp) PetscCall(MatSetNullSpace(jac->schur, sp)); 87120252d06SBarry Smith 8729566063dSJacob Faibussowitsch PetscCall(PetscSNPrintf(schurtestoption, sizeof(schurtestoption), "-fieldsplit_%s_inner_", ilink->splitname)); 8739566063dSJacob Faibussowitsch PetscCall(PetscOptionsFindPairPrefix_Private(((PetscObject)pc)->options, ((PetscObject)pc)->prefix, schurtestoption, NULL, &flg)); 874514bf10dSMatthew G Knepley if (flg) { 875514bf10dSMatthew G Knepley DM dmInner; 87621635b76SJed Brown KSP kspInner; 877686bed4dSStefano Zampini PC pcInner; 87821635b76SJed Brown 8799566063dSJacob Faibussowitsch PetscCall(MatSchurComplementGetKSP(jac->schur, &kspInner)); 8809566063dSJacob Faibussowitsch PetscCall(KSPReset(kspInner)); 8819566063dSJacob Faibussowitsch PetscCall(KSPSetOperators(kspInner, jac->mat[0], jac->pmat[0])); 8829566063dSJacob Faibussowitsch PetscCall(PetscSNPrintf(schurprefix, sizeof(schurprefix), "%sfieldsplit_%s_inner_", ((PetscObject)pc)->prefix ? ((PetscObject)pc)->prefix : "", ilink->splitname)); 88321635b76SJed Brown /* Indent this deeper to emphasize the "inner" nature of this solver. */ 8849566063dSJacob Faibussowitsch PetscCall(PetscObjectIncrementTabLevel((PetscObject)kspInner, (PetscObject)pc, 2)); 8859566063dSJacob Faibussowitsch PetscCall(PetscObjectIncrementTabLevel((PetscObject)kspInner->pc, (PetscObject)pc, 2)); 8869566063dSJacob Faibussowitsch PetscCall(KSPSetOptionsPrefix(kspInner, schurprefix)); 887514bf10dSMatthew G Knepley 888514bf10dSMatthew G Knepley /* Set DM for new solver */ 8899566063dSJacob Faibussowitsch PetscCall(KSPGetDM(jac->head->ksp, &dmInner)); 8909566063dSJacob Faibussowitsch PetscCall(KSPSetDM(kspInner, dmInner)); 8919566063dSJacob Faibussowitsch PetscCall(KSPSetDMActive(kspInner, PETSC_FALSE)); 892686bed4dSStefano Zampini 893686bed4dSStefano Zampini /* Defaults to PCKSP as preconditioner */ 8949566063dSJacob Faibussowitsch PetscCall(KSPGetPC(kspInner, &pcInner)); 8959566063dSJacob Faibussowitsch PetscCall(PCSetType(pcInner, PCKSP)); 8969566063dSJacob Faibussowitsch PetscCall(PCKSPSetKSP(pcInner, jac->head->ksp)); 897514bf10dSMatthew G Knepley } else { 89821635b76SJed Brown /* Use the outer solver for the inner solve, but revert the KSPPREONLY from PCFieldSplitSetFields_FieldSplit or 89921635b76SJed Brown * PCFieldSplitSetIS_FieldSplit. We don't want KSPPREONLY because it makes the Schur complement inexact, 90021635b76SJed Brown * preventing Schur complement reduction to be an accurate solve. Usually when an iterative solver is used for 90121635b76SJed 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 90221635b76SJed Brown * GMRES the default. Note that it is also common to use PREONLY for S, in which case S may not be used 90321635b76SJed Brown * directly, and the user is responsible for setting an inexact method for fieldsplit's A^{-1}. */ 9049566063dSJacob Faibussowitsch PetscCall(KSPSetType(jac->head->ksp, KSPGMRES)); 9059566063dSJacob Faibussowitsch PetscCall(MatSchurComplementSetKSP(jac->schur, jac->head->ksp)); 906bafc1b83SMatthew G Knepley } 9079566063dSJacob Faibussowitsch PetscCall(KSPSetOperators(jac->head->ksp, jac->mat[0], jac->pmat[0])); 9089566063dSJacob Faibussowitsch PetscCall(KSPSetFromOptions(jac->head->ksp)); 9099566063dSJacob Faibussowitsch PetscCall(MatSetFromOptions(jac->schur)); 9103b224e63SBarry Smith 9119566063dSJacob Faibussowitsch PetscCall(PetscObjectTypeCompare((PetscObject)jac->schur, MATSCHURCOMPLEMENT, &flg)); 912686bed4dSStefano Zampini if (flg) { /* Need to do this otherwise PCSetUp_KSP will overwrite the amat of jac->head->ksp */ 913686bed4dSStefano Zampini KSP kspInner; 914686bed4dSStefano Zampini PC pcInner; 915686bed4dSStefano Zampini 9169566063dSJacob Faibussowitsch PetscCall(MatSchurComplementGetKSP(jac->schur, &kspInner)); 9179566063dSJacob Faibussowitsch PetscCall(KSPGetPC(kspInner, &pcInner)); 9189566063dSJacob Faibussowitsch PetscCall(PetscObjectTypeCompare((PetscObject)pcInner, PCKSP, &flg)); 919686bed4dSStefano Zampini if (flg) { 920686bed4dSStefano Zampini KSP ksp; 921686bed4dSStefano Zampini 9229566063dSJacob Faibussowitsch PetscCall(PCKSPGetKSP(pcInner, &ksp)); 92348a46eb9SPierre Jolivet if (ksp == jac->head->ksp) PetscCall(PCSetUseAmat(pcInner, PETSC_TRUE)); 924686bed4dSStefano Zampini } 925686bed4dSStefano Zampini } 9269566063dSJacob Faibussowitsch PetscCall(PetscSNPrintf(schurtestoption, sizeof(schurtestoption), "-fieldsplit_%s_upper_", ilink->splitname)); 9279566063dSJacob Faibussowitsch PetscCall(PetscOptionsFindPairPrefix_Private(((PetscObject)pc)->options, ((PetscObject)pc)->prefix, schurtestoption, NULL, &flg)); 928443836d0SMatthew G Knepley if (flg) { 929443836d0SMatthew G Knepley DM dmInner; 930443836d0SMatthew G Knepley 9319566063dSJacob Faibussowitsch PetscCall(PetscSNPrintf(schurprefix, sizeof(schurprefix), "%sfieldsplit_%s_upper_", ((PetscObject)pc)->prefix ? ((PetscObject)pc)->prefix : "", ilink->splitname)); 9329566063dSJacob Faibussowitsch PetscCall(KSPCreate(PetscObjectComm((PetscObject)pc), &jac->kspupper)); 9339566063dSJacob Faibussowitsch PetscCall(KSPSetErrorIfNotConverged(jac->kspupper, pc->erroriffailure)); 9349566063dSJacob Faibussowitsch PetscCall(KSPSetOptionsPrefix(jac->kspupper, schurprefix)); 9359566063dSJacob Faibussowitsch PetscCall(PetscObjectIncrementTabLevel((PetscObject)jac->kspupper, (PetscObject)pc, 1)); 9369566063dSJacob Faibussowitsch PetscCall(PetscObjectIncrementTabLevel((PetscObject)jac->kspupper->pc, (PetscObject)pc, 1)); 9379566063dSJacob Faibussowitsch PetscCall(KSPGetDM(jac->head->ksp, &dmInner)); 9389566063dSJacob Faibussowitsch PetscCall(KSPSetDM(jac->kspupper, dmInner)); 9399566063dSJacob Faibussowitsch PetscCall(KSPSetDMActive(jac->kspupper, PETSC_FALSE)); 9409566063dSJacob Faibussowitsch PetscCall(KSPSetFromOptions(jac->kspupper)); 9419566063dSJacob Faibussowitsch PetscCall(KSPSetOperators(jac->kspupper, jac->mat[0], jac->pmat[0])); 9429566063dSJacob Faibussowitsch PetscCall(VecDuplicate(jac->head->x, &jac->head->z)); 943443836d0SMatthew G Knepley } else { 944443836d0SMatthew G Knepley jac->kspupper = jac->head->ksp; 9459566063dSJacob Faibussowitsch PetscCall(PetscObjectReference((PetscObject)jac->head->ksp)); 946443836d0SMatthew G Knepley } 947443836d0SMatthew G Knepley 94848a46eb9SPierre Jolivet if (jac->schurpre == PC_FIELDSPLIT_SCHUR_PRE_SELFP) PetscCall(MatSchurComplementGetPmat(jac->schur, MAT_INITIAL_MATRIX, &jac->schurp)); 9499566063dSJacob Faibussowitsch PetscCall(KSPCreate(PetscObjectComm((PetscObject)pc), &jac->kspschur)); 9509566063dSJacob Faibussowitsch PetscCall(KSPSetErrorIfNotConverged(jac->kspschur, pc->erroriffailure)); 9519566063dSJacob Faibussowitsch PetscCall(PetscObjectIncrementTabLevel((PetscObject)jac->kspschur, (PetscObject)pc, 1)); 952084e4875SJed Brown if (jac->schurpre == PC_FIELDSPLIT_SCHUR_PRE_SELF) { 9537233a360SDmitry Karpeev PC pcschur; 9549566063dSJacob Faibussowitsch PetscCall(KSPGetPC(jac->kspschur, &pcschur)); 9559566063dSJacob Faibussowitsch PetscCall(PCSetType(pcschur, PCNONE)); 956084e4875SJed Brown /* Note: This is bad if there exist preconditioners for MATSCHURCOMPLEMENT */ 957e74569cdSMatthew G. Knepley } else if (jac->schurpre == PC_FIELDSPLIT_SCHUR_PRE_FULL) { 9589566063dSJacob Faibussowitsch PetscCall(MatSchurComplementComputeExplicitOperator(jac->schur, &jac->schur_user)); 959e69d4d44SBarry Smith } 9609566063dSJacob Faibussowitsch PetscCall(KSPSetOperators(jac->kspschur, jac->schur, FieldSplitSchurPre(jac))); 9619566063dSJacob Faibussowitsch PetscCall(KSPGetOptionsPrefix(jac->head->next->ksp, &Dprefix)); 9629566063dSJacob Faibussowitsch PetscCall(KSPSetOptionsPrefix(jac->kspschur, Dprefix)); 963c096484dSStefano Zampini /* propagate DM */ 964b20b4189SMatthew G. Knepley { 965b20b4189SMatthew G. Knepley DM sdm; 9669566063dSJacob Faibussowitsch PetscCall(KSPGetDM(jac->head->next->ksp, &sdm)); 967b20b4189SMatthew G. Knepley if (sdm) { 9689566063dSJacob Faibussowitsch PetscCall(KSPSetDM(jac->kspschur, sdm)); 9699566063dSJacob Faibussowitsch PetscCall(KSPSetDMActive(jac->kspschur, PETSC_FALSE)); 970b20b4189SMatthew G. Knepley } 971b20b4189SMatthew G. Knepley } 9723b224e63SBarry Smith /* really want setfromoptions called in PCSetFromOptions_FieldSplit(), but it is not ready yet */ 97320b26d62SBarry Smith /* need to call this every time, since the jac->kspschur is freshly created, otherwise its options never get set */ 9749566063dSJacob Faibussowitsch PetscCall(KSPSetFromOptions(jac->kspschur)); 9753b224e63SBarry Smith } 9769566063dSJacob Faibussowitsch PetscCall(MatAssemblyBegin(jac->schur, MAT_FINAL_ASSEMBLY)); 9779566063dSJacob Faibussowitsch PetscCall(MatAssemblyEnd(jac->schur, MAT_FINAL_ASSEMBLY)); 978093c86ffSJed Brown 979093c86ffSJed Brown /* HACK: special support to forward L and Lp matrices that might be used by PCLSC */ 9809566063dSJacob Faibussowitsch PetscCall(PetscSNPrintf(lscname, sizeof(lscname), "%s_LSC_L", ilink->splitname)); 9819566063dSJacob Faibussowitsch PetscCall(PetscObjectQuery((PetscObject)pc->mat, lscname, (PetscObject *)&LSC_L)); 9829566063dSJacob Faibussowitsch if (!LSC_L) PetscCall(PetscObjectQuery((PetscObject)pc->pmat, lscname, (PetscObject *)&LSC_L)); 9839566063dSJacob Faibussowitsch if (LSC_L) PetscCall(PetscObjectCompose((PetscObject)jac->schur, "LSC_L", (PetscObject)LSC_L)); 9849566063dSJacob Faibussowitsch PetscCall(PetscSNPrintf(lscname, sizeof(lscname), "%s_LSC_Lp", ilink->splitname)); 9859566063dSJacob Faibussowitsch PetscCall(PetscObjectQuery((PetscObject)pc->pmat, lscname, (PetscObject *)&LSC_L)); 9869566063dSJacob Faibussowitsch if (!LSC_L) PetscCall(PetscObjectQuery((PetscObject)pc->mat, lscname, (PetscObject *)&LSC_L)); 9879566063dSJacob Faibussowitsch if (LSC_L) PetscCall(PetscObjectCompose((PetscObject)jac->schur, "LSC_Lp", (PetscObject)LSC_L)); 988a51937d4SCarola Kruse } else if (jac->type == PC_COMPOSITE_GKB) { 989a51937d4SCarola Kruse IS ccis; 990a51937d4SCarola Kruse PetscInt rstart, rend; 991a51937d4SCarola Kruse 99208401ef6SPierre Jolivet PetscCheck(nsplit == 2, PetscObjectComm((PetscObject)pc), PETSC_ERR_ARG_INCOMP, "To use GKB preconditioner you must have exactly 2 fields"); 993a51937d4SCarola Kruse 994a51937d4SCarola Kruse ilink = jac->head; 995a51937d4SCarola Kruse 996a51937d4SCarola Kruse /* When extracting off-diagonal submatrices, we take complements from this range */ 9979566063dSJacob Faibussowitsch PetscCall(MatGetOwnershipRangeColumn(pc->mat, &rstart, &rend)); 998a51937d4SCarola Kruse 9999566063dSJacob Faibussowitsch PetscCall(ISComplement(ilink->is_col, rstart, rend, &ccis)); 1000a51937d4SCarola Kruse if (jac->offdiag_use_amat) { 10019566063dSJacob Faibussowitsch PetscCall(MatCreateSubMatrix(pc->mat, ilink->is, ccis, MAT_INITIAL_MATRIX, &jac->B)); 1002a51937d4SCarola Kruse } else { 10039566063dSJacob Faibussowitsch PetscCall(MatCreateSubMatrix(pc->pmat, ilink->is, ccis, MAT_INITIAL_MATRIX, &jac->B)); 1004a51937d4SCarola Kruse } 10059566063dSJacob Faibussowitsch PetscCall(ISDestroy(&ccis)); 1006e071a0a4SCarola Kruse /* Create work vectors for GKB algorithm */ 10079566063dSJacob Faibussowitsch PetscCall(VecDuplicate(ilink->x, &jac->u)); 10089566063dSJacob Faibussowitsch PetscCall(VecDuplicate(ilink->x, &jac->Hu)); 10099566063dSJacob Faibussowitsch PetscCall(VecDuplicate(ilink->x, &jac->w2)); 1010a51937d4SCarola Kruse ilink = ilink->next; 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->C)); 1014a51937d4SCarola Kruse } else { 10159566063dSJacob Faibussowitsch PetscCall(MatCreateSubMatrix(pc->pmat, ilink->is, ccis, MAT_INITIAL_MATRIX, &jac->C)); 1016a51937d4SCarola Kruse } 10179566063dSJacob Faibussowitsch PetscCall(ISDestroy(&ccis)); 1018e071a0a4SCarola Kruse /* Create work vectors for GKB algorithm */ 10199566063dSJacob Faibussowitsch PetscCall(VecDuplicate(ilink->x, &jac->v)); 10209566063dSJacob Faibussowitsch PetscCall(VecDuplicate(ilink->x, &jac->d)); 10219566063dSJacob Faibussowitsch PetscCall(VecDuplicate(ilink->x, &jac->w1)); 10229566063dSJacob Faibussowitsch PetscCall(MatGolubKahanComputeExplicitOperator(jac->mat[0], jac->B, jac->C, &jac->H, jac->gkbnu)); 10239566063dSJacob Faibussowitsch PetscCall(PetscCalloc1(jac->gkbdelay, &jac->vecz)); 1024e071a0a4SCarola Kruse 1025a51937d4SCarola Kruse ilink = jac->head; 10269566063dSJacob Faibussowitsch PetscCall(KSPSetOperators(ilink->ksp, jac->H, jac->H)); 10279566063dSJacob Faibussowitsch if (!jac->suboptionsset) PetscCall(KSPSetFromOptions(ilink->ksp)); 1028e071a0a4SCarola Kruse /* Create gkb_monitor context */ 1029de482cd7SCarola Kruse if (jac->gkbmonitor) { 1030de482cd7SCarola Kruse PetscInt tablevel; 10319566063dSJacob Faibussowitsch PetscCall(PetscViewerCreate(PETSC_COMM_WORLD, &jac->gkbviewer)); 10329566063dSJacob Faibussowitsch PetscCall(PetscViewerSetType(jac->gkbviewer, PETSCVIEWERASCII)); 10339566063dSJacob Faibussowitsch PetscCall(PetscObjectGetTabLevel((PetscObject)ilink->ksp, &tablevel)); 10349566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIISetTab(jac->gkbviewer, tablevel)); 10359566063dSJacob Faibussowitsch PetscCall(PetscObjectIncrementTabLevel((PetscObject)ilink->ksp, (PetscObject)ilink->ksp, 1)); 1036de482cd7SCarola Kruse } 10373b224e63SBarry Smith } else { 103868bd789dSDmitry Karpeev /* set up the individual splits' PCs */ 103997bbdb24SBarry Smith i = 0; 10405a9f2f41SSatish Balay ilink = jac->head; 10415a9f2f41SSatish Balay while (ilink) { 10429566063dSJacob Faibussowitsch PetscCall(KSPSetOperators(ilink->ksp, jac->mat[i], jac->pmat[i])); 10433b224e63SBarry Smith /* really want setfromoptions called in PCSetFromOptions_FieldSplit(), but it is not ready yet */ 10449566063dSJacob Faibussowitsch if (!jac->suboptionsset) PetscCall(KSPSetFromOptions(ilink->ksp)); 104597bbdb24SBarry Smith i++; 10465a9f2f41SSatish Balay ilink = ilink->next; 10470971522cSBarry Smith } 10483b224e63SBarry Smith } 10493b224e63SBarry Smith 10505ddf11f8SNicolas Barnafi /* Set coordinates to the sub PC objects whenever these are set */ 10515ddf11f8SNicolas Barnafi if (jac->coordinates_set) { 10525ddf11f8SNicolas Barnafi PC pc_coords; 10535ddf11f8SNicolas Barnafi if (jac->type == PC_COMPOSITE_SCHUR) { 10545ddf11f8SNicolas Barnafi // Head is first block. 10559566063dSJacob Faibussowitsch PetscCall(KSPGetPC(jac->head->ksp, &pc_coords)); 10569566063dSJacob Faibussowitsch PetscCall(PCSetCoordinates(pc_coords, jac->head->dim, jac->head->ndofs, jac->head->coords)); 10575ddf11f8SNicolas Barnafi // Second one is Schur block, but its KSP object is in kspschur. 10589566063dSJacob Faibussowitsch PetscCall(KSPGetPC(jac->kspschur, &pc_coords)); 10599566063dSJacob Faibussowitsch PetscCall(PCSetCoordinates(pc_coords, jac->head->next->dim, jac->head->next->ndofs, jac->head->next->coords)); 10605ddf11f8SNicolas Barnafi } else if (jac->type == PC_COMPOSITE_GKB) { 10619566063dSJacob Faibussowitsch PetscCall(PetscInfo(pc, "Warning: Setting coordinates does nothing for the GKB Fieldpslit preconditioner")); 10625ddf11f8SNicolas Barnafi } else { 10635ddf11f8SNicolas Barnafi ilink = jac->head; 10645ddf11f8SNicolas Barnafi while (ilink) { 10659566063dSJacob Faibussowitsch PetscCall(KSPGetPC(ilink->ksp, &pc_coords)); 10669566063dSJacob Faibussowitsch PetscCall(PCSetCoordinates(pc_coords, ilink->dim, ilink->ndofs, ilink->coords)); 10675ddf11f8SNicolas Barnafi ilink = ilink->next; 10685ddf11f8SNicolas Barnafi } 10695ddf11f8SNicolas Barnafi } 10705ddf11f8SNicolas Barnafi } 10715ddf11f8SNicolas Barnafi 1072c1570756SJed Brown jac->suboptionsset = PETSC_TRUE; 10730971522cSBarry Smith PetscFunctionReturn(0); 10740971522cSBarry Smith } 10750971522cSBarry Smith 10765a9f2f41SSatish Balay #define FieldSplitSplitSolveAdd(ilink, xx, yy) \ 10779371c9d4SSatish Balay (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) || \ 10789371c9d4SSatish 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) || \ 1079ca9f406cSSatish Balay VecScatterEnd(ilink->sctx, ilink->y, yy, ADD_VALUES, SCATTER_REVERSE)) 108079416396SBarry Smith 1081d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCApply_FieldSplit_Schur(PC pc, Vec x, Vec y) 1082d71ae5a4SJacob Faibussowitsch { 10833b224e63SBarry Smith PC_FieldSplit *jac = (PC_FieldSplit *)pc->data; 10843b224e63SBarry Smith PC_FieldSplitLink ilinkA = jac->head, ilinkD = ilinkA->next; 1085443836d0SMatthew G Knepley KSP kspA = ilinkA->ksp, kspLower = kspA, kspUpper = jac->kspupper; 10863b224e63SBarry Smith 10873b224e63SBarry Smith PetscFunctionBegin; 1088c5d2311dSJed Brown switch (jac->schurfactorization) { 1089c9c6ffaaSJed Brown case PC_FIELDSPLIT_SCHUR_FACT_DIAG: 1090a04f6461SBarry Smith /* [A00 0; 0 -S], positive definite, suitable for MINRES */ 10919566063dSJacob Faibussowitsch PetscCall(VecScatterBegin(ilinkA->sctx, x, ilinkA->x, INSERT_VALUES, SCATTER_FORWARD)); 10929566063dSJacob Faibussowitsch PetscCall(VecScatterBegin(ilinkD->sctx, x, ilinkD->x, INSERT_VALUES, SCATTER_FORWARD)); 10939566063dSJacob Faibussowitsch PetscCall(VecScatterEnd(ilinkA->sctx, x, ilinkA->x, INSERT_VALUES, SCATTER_FORWARD)); 10949566063dSJacob Faibussowitsch PetscCall(PetscLogEventBegin(ilinkA->event, kspA, ilinkA->x, ilinkA->y, NULL)); 10959566063dSJacob Faibussowitsch PetscCall(KSPSolve(kspA, ilinkA->x, ilinkA->y)); 10969566063dSJacob Faibussowitsch PetscCall(KSPCheckSolve(kspA, pc, ilinkA->y)); 10979566063dSJacob Faibussowitsch PetscCall(PetscLogEventEnd(ilinkA->event, kspA, ilinkA->x, ilinkA->y, NULL)); 10989566063dSJacob Faibussowitsch PetscCall(VecScatterBegin(ilinkA->sctx, ilinkA->y, y, INSERT_VALUES, SCATTER_REVERSE)); 10999566063dSJacob Faibussowitsch PetscCall(VecScatterEnd(ilinkD->sctx, x, ilinkD->x, INSERT_VALUES, SCATTER_FORWARD)); 11009566063dSJacob Faibussowitsch PetscCall(PetscLogEventBegin(KSP_Solve_FS_S, jac->kspschur, ilinkD->x, ilinkD->y, NULL)); 11019566063dSJacob Faibussowitsch PetscCall(KSPSolve(jac->kspschur, ilinkD->x, ilinkD->y)); 11029566063dSJacob Faibussowitsch PetscCall(KSPCheckSolve(jac->kspschur, pc, ilinkD->y)); 11039566063dSJacob Faibussowitsch PetscCall(PetscLogEventEnd(KSP_Solve_FS_S, jac->kspschur, ilinkD->x, ilinkD->y, NULL)); 11049566063dSJacob Faibussowitsch PetscCall(VecScale(ilinkD->y, jac->schurscale)); 11059566063dSJacob Faibussowitsch PetscCall(VecScatterEnd(ilinkA->sctx, ilinkA->y, y, INSERT_VALUES, SCATTER_REVERSE)); 11069566063dSJacob Faibussowitsch PetscCall(VecScatterBegin(ilinkD->sctx, ilinkD->y, y, INSERT_VALUES, SCATTER_REVERSE)); 11079566063dSJacob Faibussowitsch PetscCall(VecScatterEnd(ilinkD->sctx, ilinkD->y, y, INSERT_VALUES, SCATTER_REVERSE)); 1108c5d2311dSJed Brown break; 1109c9c6ffaaSJed Brown case PC_FIELDSPLIT_SCHUR_FACT_LOWER: 1110a04f6461SBarry Smith /* [A00 0; A10 S], suitable for left preconditioning */ 11119566063dSJacob Faibussowitsch PetscCall(VecScatterBegin(ilinkA->sctx, x, ilinkA->x, INSERT_VALUES, SCATTER_FORWARD)); 11129566063dSJacob Faibussowitsch PetscCall(VecScatterEnd(ilinkA->sctx, x, ilinkA->x, INSERT_VALUES, SCATTER_FORWARD)); 11139566063dSJacob Faibussowitsch PetscCall(PetscLogEventBegin(ilinkA->event, kspA, ilinkA->x, ilinkA->y, NULL)); 11149566063dSJacob Faibussowitsch PetscCall(KSPSolve(kspA, ilinkA->x, ilinkA->y)); 11159566063dSJacob Faibussowitsch PetscCall(KSPCheckSolve(kspA, pc, ilinkA->y)); 11169566063dSJacob Faibussowitsch PetscCall(PetscLogEventEnd(ilinkA->event, kspA, ilinkA->x, ilinkA->y, NULL)); 11179566063dSJacob Faibussowitsch PetscCall(MatMult(jac->C, ilinkA->y, ilinkD->x)); 11189566063dSJacob Faibussowitsch PetscCall(VecScale(ilinkD->x, -1.)); 11199566063dSJacob Faibussowitsch PetscCall(VecScatterBegin(ilinkD->sctx, x, ilinkD->x, ADD_VALUES, SCATTER_FORWARD)); 11209566063dSJacob Faibussowitsch PetscCall(VecScatterBegin(ilinkA->sctx, ilinkA->y, y, INSERT_VALUES, SCATTER_REVERSE)); 11219566063dSJacob Faibussowitsch PetscCall(VecScatterEnd(ilinkD->sctx, x, ilinkD->x, ADD_VALUES, SCATTER_FORWARD)); 11229566063dSJacob Faibussowitsch PetscCall(PetscLogEventBegin(KSP_Solve_FS_S, jac->kspschur, ilinkD->x, ilinkD->y, NULL)); 11239566063dSJacob Faibussowitsch PetscCall(KSPSolve(jac->kspschur, ilinkD->x, ilinkD->y)); 11249566063dSJacob Faibussowitsch PetscCall(KSPCheckSolve(jac->kspschur, pc, ilinkD->y)); 11259566063dSJacob Faibussowitsch PetscCall(PetscLogEventEnd(KSP_Solve_FS_S, jac->kspschur, ilinkD->x, ilinkD->y, NULL)); 11269566063dSJacob Faibussowitsch PetscCall(VecScatterEnd(ilinkA->sctx, ilinkA->y, y, INSERT_VALUES, SCATTER_REVERSE)); 11279566063dSJacob Faibussowitsch PetscCall(VecScatterBegin(ilinkD->sctx, ilinkD->y, y, INSERT_VALUES, SCATTER_REVERSE)); 11289566063dSJacob Faibussowitsch PetscCall(VecScatterEnd(ilinkD->sctx, ilinkD->y, y, INSERT_VALUES, SCATTER_REVERSE)); 1129c5d2311dSJed Brown break; 1130c9c6ffaaSJed Brown case PC_FIELDSPLIT_SCHUR_FACT_UPPER: 1131a04f6461SBarry Smith /* [A00 A01; 0 S], suitable for right preconditioning */ 11329566063dSJacob Faibussowitsch PetscCall(VecScatterBegin(ilinkD->sctx, x, ilinkD->x, INSERT_VALUES, SCATTER_FORWARD)); 11339566063dSJacob Faibussowitsch PetscCall(VecScatterEnd(ilinkD->sctx, x, ilinkD->x, INSERT_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)); 11379371c9d4SSatish Balay PetscCall(PetscLogEventEnd(KSP_Solve_FS_S, jac->kspschur, ilinkD->x, ilinkD->y, NULL)); 11389371c9d4SSatish Balay PetscCall(MatMult(jac->B, ilinkD->y, ilinkA->x)); 11399566063dSJacob Faibussowitsch PetscCall(VecScale(ilinkA->x, -1.)); 11409566063dSJacob Faibussowitsch PetscCall(VecScatterBegin(ilinkA->sctx, x, ilinkA->x, ADD_VALUES, SCATTER_FORWARD)); 11419566063dSJacob Faibussowitsch PetscCall(VecScatterBegin(ilinkD->sctx, ilinkD->y, y, INSERT_VALUES, SCATTER_REVERSE)); 11429566063dSJacob Faibussowitsch PetscCall(VecScatterEnd(ilinkA->sctx, x, ilinkA->x, ADD_VALUES, SCATTER_FORWARD)); 11439566063dSJacob Faibussowitsch PetscCall(PetscLogEventBegin(ilinkA->event, kspA, ilinkA->x, ilinkA->y, NULL)); 11449566063dSJacob Faibussowitsch PetscCall(KSPSolve(kspA, ilinkA->x, ilinkA->y)); 11459566063dSJacob Faibussowitsch PetscCall(KSPCheckSolve(kspA, pc, ilinkA->y)); 11469566063dSJacob Faibussowitsch PetscCall(PetscLogEventEnd(ilinkA->event, kspA, ilinkA->x, ilinkA->y, NULL)); 11479566063dSJacob Faibussowitsch PetscCall(VecScatterEnd(ilinkD->sctx, ilinkD->y, y, INSERT_VALUES, SCATTER_REVERSE)); 11489566063dSJacob Faibussowitsch PetscCall(VecScatterBegin(ilinkA->sctx, ilinkA->y, y, INSERT_VALUES, SCATTER_REVERSE)); 11499566063dSJacob Faibussowitsch PetscCall(VecScatterEnd(ilinkA->sctx, ilinkA->y, y, INSERT_VALUES, SCATTER_REVERSE)); 1150c5d2311dSJed Brown break; 1151c9c6ffaaSJed Brown case PC_FIELDSPLIT_SCHUR_FACT_FULL: 1152c238f8cdSStefano Zampini /* [1 0; A10 A00^{-1} 1] [A00 0; 0 S] [1 A00^{-1}A01; 0 1] */ 11539566063dSJacob Faibussowitsch PetscCall(VecScatterBegin(ilinkA->sctx, x, ilinkA->x, INSERT_VALUES, SCATTER_FORWARD)); 11549566063dSJacob Faibussowitsch PetscCall(VecScatterEnd(ilinkA->sctx, x, ilinkA->x, INSERT_VALUES, SCATTER_FORWARD)); 11559566063dSJacob Faibussowitsch PetscCall(PetscLogEventBegin(KSP_Solve_FS_L, kspLower, ilinkA->x, ilinkA->y, NULL)); 11569566063dSJacob Faibussowitsch PetscCall(KSPSolve(kspLower, ilinkA->x, ilinkA->y)); 11579566063dSJacob Faibussowitsch PetscCall(KSPCheckSolve(kspLower, pc, ilinkA->y)); 11589566063dSJacob Faibussowitsch PetscCall(PetscLogEventEnd(KSP_Solve_FS_L, kspLower, ilinkA->x, ilinkA->y, NULL)); 11599566063dSJacob Faibussowitsch PetscCall(MatMult(jac->C, ilinkA->y, ilinkD->x)); 11609566063dSJacob Faibussowitsch PetscCall(VecScale(ilinkD->x, -1.0)); 11619566063dSJacob Faibussowitsch PetscCall(VecScatterBegin(ilinkD->sctx, x, ilinkD->x, ADD_VALUES, SCATTER_FORWARD)); 11629566063dSJacob Faibussowitsch PetscCall(VecScatterEnd(ilinkD->sctx, x, ilinkD->x, ADD_VALUES, SCATTER_FORWARD)); 11633b224e63SBarry Smith 11649566063dSJacob Faibussowitsch PetscCall(PetscLogEventBegin(KSP_Solve_FS_S, jac->kspschur, ilinkD->x, ilinkD->y, NULL)); 11659566063dSJacob Faibussowitsch PetscCall(KSPSolve(jac->kspschur, ilinkD->x, ilinkD->y)); 11669566063dSJacob Faibussowitsch PetscCall(KSPCheckSolve(jac->kspschur, pc, ilinkD->y)); 11679566063dSJacob Faibussowitsch PetscCall(PetscLogEventEnd(KSP_Solve_FS_S, jac->kspschur, ilinkD->x, ilinkD->y, NULL)); 11689566063dSJacob Faibussowitsch PetscCall(VecScatterBegin(ilinkD->sctx, ilinkD->y, y, INSERT_VALUES, SCATTER_REVERSE)); 11693b224e63SBarry Smith 1170443836d0SMatthew G Knepley if (kspUpper == kspA) { 11719566063dSJacob Faibussowitsch PetscCall(MatMult(jac->B, ilinkD->y, ilinkA->y)); 11729566063dSJacob Faibussowitsch PetscCall(VecAXPY(ilinkA->x, -1.0, ilinkA->y)); 11739566063dSJacob Faibussowitsch PetscCall(PetscLogEventBegin(ilinkA->event, kspA, ilinkA->x, ilinkA->y, NULL)); 11749566063dSJacob Faibussowitsch PetscCall(KSPSolve(kspA, ilinkA->x, ilinkA->y)); 11759566063dSJacob Faibussowitsch PetscCall(KSPCheckSolve(kspA, pc, ilinkA->y)); 11769566063dSJacob Faibussowitsch PetscCall(PetscLogEventEnd(ilinkA->event, kspA, ilinkA->x, ilinkA->y, NULL)); 1177443836d0SMatthew G Knepley } else { 11789566063dSJacob Faibussowitsch PetscCall(PetscLogEventBegin(ilinkA->event, kspA, ilinkA->x, ilinkA->y, NULL)); 11799566063dSJacob Faibussowitsch PetscCall(KSPSolve(kspA, ilinkA->x, ilinkA->y)); 11809566063dSJacob Faibussowitsch PetscCall(KSPCheckSolve(kspA, pc, ilinkA->y)); 11819566063dSJacob Faibussowitsch PetscCall(MatMult(jac->B, ilinkD->y, ilinkA->x)); 11829566063dSJacob Faibussowitsch PetscCall(PetscLogEventBegin(KSP_Solve_FS_U, kspUpper, ilinkA->x, ilinkA->z, NULL)); 11839566063dSJacob Faibussowitsch PetscCall(KSPSolve(kspUpper, ilinkA->x, ilinkA->z)); 11849566063dSJacob Faibussowitsch PetscCall(KSPCheckSolve(kspUpper, pc, ilinkA->z)); 11859566063dSJacob Faibussowitsch PetscCall(PetscLogEventEnd(KSP_Solve_FS_U, kspUpper, ilinkA->x, ilinkA->z, NULL)); 11869566063dSJacob Faibussowitsch PetscCall(VecAXPY(ilinkA->y, -1.0, ilinkA->z)); 1187443836d0SMatthew G Knepley } 11889566063dSJacob Faibussowitsch PetscCall(VecScatterEnd(ilinkD->sctx, ilinkD->y, y, INSERT_VALUES, SCATTER_REVERSE)); 11899566063dSJacob Faibussowitsch PetscCall(VecScatterBegin(ilinkA->sctx, ilinkA->y, y, INSERT_VALUES, SCATTER_REVERSE)); 11909566063dSJacob Faibussowitsch PetscCall(VecScatterEnd(ilinkA->sctx, ilinkA->y, y, INSERT_VALUES, SCATTER_REVERSE)); 1191c5d2311dSJed Brown } 11923b224e63SBarry Smith PetscFunctionReturn(0); 11933b224e63SBarry Smith } 11943b224e63SBarry Smith 1195d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCApply_FieldSplit(PC pc, Vec x, Vec y) 1196d71ae5a4SJacob Faibussowitsch { 11970971522cSBarry Smith PC_FieldSplit *jac = (PC_FieldSplit *)pc->data; 11985a9f2f41SSatish Balay PC_FieldSplitLink ilink = jac->head; 1199939b8a20SBarry Smith PetscInt cnt, bs; 12000971522cSBarry Smith 12010971522cSBarry Smith PetscFunctionBegin; 120279416396SBarry Smith if (jac->type == PC_COMPOSITE_ADDITIVE) { 12031b9fc7fcSBarry Smith if (jac->defaultsplit) { 12049566063dSJacob Faibussowitsch PetscCall(VecGetBlockSize(x, &bs)); 12052472a847SBarry 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); 12069566063dSJacob Faibussowitsch PetscCall(VecGetBlockSize(y, &bs)); 12072472a847SBarry 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); 12089566063dSJacob Faibussowitsch PetscCall(VecStrideGatherAll(x, jac->x, INSERT_VALUES)); 12095a9f2f41SSatish Balay while (ilink) { 12109566063dSJacob Faibussowitsch PetscCall(PetscLogEventBegin(ilink->event, ilink->ksp, ilink->x, ilink->y, NULL)); 12119566063dSJacob Faibussowitsch PetscCall(KSPSolve(ilink->ksp, ilink->x, ilink->y)); 12129566063dSJacob Faibussowitsch PetscCall(KSPCheckSolve(ilink->ksp, pc, ilink->y)); 12139566063dSJacob Faibussowitsch PetscCall(PetscLogEventEnd(ilink->event, ilink->ksp, ilink->x, ilink->y, NULL)); 12145a9f2f41SSatish Balay ilink = ilink->next; 12150971522cSBarry Smith } 12169566063dSJacob Faibussowitsch PetscCall(VecStrideScatterAll(jac->y, y, INSERT_VALUES)); 12171b9fc7fcSBarry Smith } else { 12189566063dSJacob Faibussowitsch PetscCall(VecSet(y, 0.0)); 12195a9f2f41SSatish Balay while (ilink) { 12209566063dSJacob Faibussowitsch PetscCall(FieldSplitSplitSolveAdd(ilink, x, y)); 12215a9f2f41SSatish Balay ilink = ilink->next; 12221b9fc7fcSBarry Smith } 12231b9fc7fcSBarry Smith } 1224e52d2c62SBarry Smith } else if (jac->type == PC_COMPOSITE_MULTIPLICATIVE && jac->nsplits == 2) { 12259566063dSJacob Faibussowitsch PetscCall(VecSet(y, 0.0)); 1226e52d2c62SBarry Smith /* solve on first block for first block variables */ 12279566063dSJacob Faibussowitsch PetscCall(VecScatterBegin(ilink->sctx, x, ilink->x, INSERT_VALUES, SCATTER_FORWARD)); 12289566063dSJacob Faibussowitsch PetscCall(VecScatterEnd(ilink->sctx, x, ilink->x, INSERT_VALUES, SCATTER_FORWARD)); 12299566063dSJacob Faibussowitsch PetscCall(PetscLogEventBegin(ilink->event, ilink->ksp, ilink->x, ilink->y, NULL)); 12309566063dSJacob Faibussowitsch PetscCall(KSPSolve(ilink->ksp, ilink->x, ilink->y)); 12319566063dSJacob Faibussowitsch PetscCall(KSPCheckSolve(ilink->ksp, pc, ilink->y)); 12329566063dSJacob Faibussowitsch PetscCall(PetscLogEventEnd(ilink->event, ilink->ksp, ilink->x, ilink->y, NULL)); 12339566063dSJacob Faibussowitsch PetscCall(VecScatterBegin(ilink->sctx, ilink->y, y, ADD_VALUES, SCATTER_REVERSE)); 12349566063dSJacob Faibussowitsch PetscCall(VecScatterEnd(ilink->sctx, ilink->y, y, ADD_VALUES, SCATTER_REVERSE)); 1235e52d2c62SBarry Smith 1236e52d2c62SBarry Smith /* compute the residual only onto second block variables using first block variables */ 12379566063dSJacob Faibussowitsch PetscCall(MatMult(jac->Afield[1], ilink->y, ilink->next->x)); 1238e52d2c62SBarry Smith ilink = ilink->next; 12399566063dSJacob Faibussowitsch PetscCall(VecScale(ilink->x, -1.0)); 12409566063dSJacob Faibussowitsch PetscCall(VecScatterBegin(ilink->sctx, x, ilink->x, ADD_VALUES, SCATTER_FORWARD)); 12419566063dSJacob Faibussowitsch PetscCall(VecScatterEnd(ilink->sctx, x, ilink->x, ADD_VALUES, SCATTER_FORWARD)); 1242e52d2c62SBarry Smith 1243e52d2c62SBarry Smith /* solve on second block variables */ 12449566063dSJacob Faibussowitsch PetscCall(PetscLogEventBegin(ilink->event, ilink->ksp, ilink->x, ilink->y, NULL)); 12459566063dSJacob Faibussowitsch PetscCall(KSPSolve(ilink->ksp, ilink->x, ilink->y)); 12469566063dSJacob Faibussowitsch PetscCall(KSPCheckSolve(ilink->ksp, pc, ilink->y)); 12479566063dSJacob Faibussowitsch PetscCall(PetscLogEventEnd(ilink->event, ilink->ksp, ilink->x, ilink->y, NULL)); 12489566063dSJacob Faibussowitsch PetscCall(VecScatterBegin(ilink->sctx, ilink->y, y, ADD_VALUES, SCATTER_REVERSE)); 12499566063dSJacob Faibussowitsch PetscCall(VecScatterEnd(ilink->sctx, ilink->y, y, ADD_VALUES, SCATTER_REVERSE)); 125016913363SBarry Smith } else if (jac->type == PC_COMPOSITE_MULTIPLICATIVE || jac->type == PC_COMPOSITE_SYMMETRIC_MULTIPLICATIVE) { 125179416396SBarry Smith if (!jac->w1) { 12529566063dSJacob Faibussowitsch PetscCall(VecDuplicate(x, &jac->w1)); 12539566063dSJacob Faibussowitsch PetscCall(VecDuplicate(x, &jac->w2)); 125479416396SBarry Smith } 12559566063dSJacob Faibussowitsch PetscCall(VecSet(y, 0.0)); 12569566063dSJacob Faibussowitsch PetscCall(FieldSplitSplitSolveAdd(ilink, x, y)); 12573e197d65SBarry Smith cnt = 1; 12585a9f2f41SSatish Balay while (ilink->next) { 12595a9f2f41SSatish Balay ilink = ilink->next; 12603e197d65SBarry Smith /* compute the residual only over the part of the vector needed */ 12619566063dSJacob Faibussowitsch PetscCall(MatMult(jac->Afield[cnt++], y, ilink->x)); 12629566063dSJacob Faibussowitsch PetscCall(VecScale(ilink->x, -1.0)); 12639566063dSJacob Faibussowitsch PetscCall(VecScatterBegin(ilink->sctx, x, ilink->x, ADD_VALUES, SCATTER_FORWARD)); 12649566063dSJacob Faibussowitsch PetscCall(VecScatterEnd(ilink->sctx, x, ilink->x, ADD_VALUES, SCATTER_FORWARD)); 12659566063dSJacob Faibussowitsch PetscCall(PetscLogEventBegin(ilink->event, ilink->ksp, ilink->x, ilink->y, NULL)); 12669566063dSJacob Faibussowitsch PetscCall(KSPSolve(ilink->ksp, ilink->x, ilink->y)); 12679566063dSJacob Faibussowitsch PetscCall(KSPCheckSolve(ilink->ksp, pc, ilink->y)); 12689566063dSJacob Faibussowitsch PetscCall(PetscLogEventEnd(ilink->event, ilink->ksp, ilink->x, ilink->y, NULL)); 12699566063dSJacob Faibussowitsch PetscCall(VecScatterBegin(ilink->sctx, ilink->y, y, ADD_VALUES, SCATTER_REVERSE)); 12709566063dSJacob Faibussowitsch PetscCall(VecScatterEnd(ilink->sctx, ilink->y, y, ADD_VALUES, SCATTER_REVERSE)); 12713e197d65SBarry Smith } 127251f519a2SBarry Smith if (jac->type == PC_COMPOSITE_SYMMETRIC_MULTIPLICATIVE) { 127311755939SBarry Smith cnt -= 2; 127451f519a2SBarry Smith while (ilink->previous) { 127551f519a2SBarry Smith ilink = ilink->previous; 127611755939SBarry Smith /* compute the residual only over the part of the vector needed */ 12779566063dSJacob Faibussowitsch PetscCall(MatMult(jac->Afield[cnt--], y, ilink->x)); 12789566063dSJacob Faibussowitsch PetscCall(VecScale(ilink->x, -1.0)); 12799566063dSJacob Faibussowitsch PetscCall(VecScatterBegin(ilink->sctx, x, ilink->x, ADD_VALUES, SCATTER_FORWARD)); 12809566063dSJacob Faibussowitsch PetscCall(VecScatterEnd(ilink->sctx, x, ilink->x, ADD_VALUES, SCATTER_FORWARD)); 12819566063dSJacob Faibussowitsch PetscCall(PetscLogEventBegin(ilink->event, ilink->ksp, ilink->x, ilink->y, NULL)); 12829566063dSJacob Faibussowitsch PetscCall(KSPSolve(ilink->ksp, ilink->x, ilink->y)); 12839566063dSJacob Faibussowitsch PetscCall(KSPCheckSolve(ilink->ksp, pc, ilink->y)); 12849566063dSJacob Faibussowitsch PetscCall(PetscLogEventEnd(ilink->event, ilink->ksp, ilink->x, ilink->y, NULL)); 12859566063dSJacob Faibussowitsch PetscCall(VecScatterBegin(ilink->sctx, ilink->y, y, ADD_VALUES, SCATTER_REVERSE)); 12869566063dSJacob Faibussowitsch PetscCall(VecScatterEnd(ilink->sctx, ilink->y, y, ADD_VALUES, SCATTER_REVERSE)); 128751f519a2SBarry Smith } 128811755939SBarry Smith } 128963a3b9bcSJacob Faibussowitsch } else SETERRQ(PetscObjectComm((PetscObject)pc), PETSC_ERR_SUP, "Unsupported or unknown composition %d", (int)jac->type); 12900971522cSBarry Smith PetscFunctionReturn(0); 12910971522cSBarry Smith } 12920971522cSBarry Smith 1293d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCApply_FieldSplit_GKB(PC pc, Vec x, Vec y) 1294d71ae5a4SJacob Faibussowitsch { 1295a51937d4SCarola Kruse PC_FieldSplit *jac = (PC_FieldSplit *)pc->data; 1296a51937d4SCarola Kruse PC_FieldSplitLink ilinkA = jac->head, ilinkD = ilinkA->next; 1297a51937d4SCarola Kruse KSP ksp = ilinkA->ksp; 1298de482cd7SCarola Kruse Vec u, v, Hu, d, work1, work2; 1299e071a0a4SCarola Kruse PetscScalar alpha, z, nrmz2, *vecz; 1300e071a0a4SCarola Kruse PetscReal lowbnd, nu, beta; 1301a51937d4SCarola Kruse PetscInt j, iterGKB; 1302a51937d4SCarola Kruse 1303a51937d4SCarola Kruse PetscFunctionBegin; 13049566063dSJacob Faibussowitsch PetscCall(VecScatterBegin(ilinkA->sctx, x, ilinkA->x, INSERT_VALUES, SCATTER_FORWARD)); 13059566063dSJacob Faibussowitsch PetscCall(VecScatterBegin(ilinkD->sctx, x, ilinkD->x, INSERT_VALUES, SCATTER_FORWARD)); 13069566063dSJacob Faibussowitsch PetscCall(VecScatterEnd(ilinkA->sctx, x, ilinkA->x, INSERT_VALUES, SCATTER_FORWARD)); 13079566063dSJacob Faibussowitsch PetscCall(VecScatterEnd(ilinkD->sctx, x, ilinkD->x, INSERT_VALUES, SCATTER_FORWARD)); 1308e071a0a4SCarola Kruse 1309e071a0a4SCarola Kruse u = jac->u; 1310e071a0a4SCarola Kruse v = jac->v; 1311e071a0a4SCarola Kruse Hu = jac->Hu; 1312e071a0a4SCarola Kruse d = jac->d; 1313e071a0a4SCarola Kruse work1 = jac->w1; 1314e071a0a4SCarola Kruse work2 = jac->w2; 1315e071a0a4SCarola Kruse vecz = jac->vecz; 1316a51937d4SCarola Kruse 1317a51937d4SCarola Kruse /* Change RHS to comply with matrix regularization H = A + nu*B*B' */ 1318a51937d4SCarola Kruse /* Add q = q + nu*B*b */ 1319a51937d4SCarola Kruse if (jac->gkbnu) { 1320a51937d4SCarola Kruse nu = jac->gkbnu; 13219566063dSJacob Faibussowitsch PetscCall(VecScale(ilinkD->x, jac->gkbnu)); 13229566063dSJacob Faibussowitsch PetscCall(MatMultAdd(jac->B, ilinkD->x, ilinkA->x, ilinkA->x)); /* q = q + nu*B*b */ 1323a51937d4SCarola Kruse } else { 1324a51937d4SCarola Kruse /* Situation when no augmented Lagrangian is used. Then we set inner */ 1325a51937d4SCarola Kruse /* matrix N = I in [Ar13], and thus nu = 1. */ 1326a51937d4SCarola Kruse nu = 1; 1327a51937d4SCarola Kruse } 1328a51937d4SCarola Kruse 1329a51937d4SCarola Kruse /* Transform rhs from [q,tilde{b}] to [0,b] */ 13309566063dSJacob Faibussowitsch PetscCall(PetscLogEventBegin(ilinkA->event, ksp, ilinkA->x, ilinkA->y, NULL)); 13319566063dSJacob Faibussowitsch PetscCall(KSPSolve(ksp, ilinkA->x, ilinkA->y)); 13329566063dSJacob Faibussowitsch PetscCall(KSPCheckSolve(ksp, pc, ilinkA->y)); 13339566063dSJacob Faibussowitsch PetscCall(PetscLogEventEnd(ilinkA->event, ksp, ilinkA->x, ilinkA->y, NULL)); 13349566063dSJacob Faibussowitsch PetscCall(MatMultHermitianTranspose(jac->B, ilinkA->y, work1)); 13359566063dSJacob Faibussowitsch PetscCall(VecAXPBY(work1, 1.0 / nu, -1.0, ilinkD->x)); /* c = b - B'*x */ 1336a51937d4SCarola Kruse 1337a51937d4SCarola Kruse /* First step of algorithm */ 13389566063dSJacob Faibussowitsch PetscCall(VecNorm(work1, NORM_2, &beta)); /* beta = sqrt(nu*c'*c)*/ 1339e071a0a4SCarola Kruse KSPCheckDot(ksp, beta); 1340addd1e01SJunchao Zhang beta = PetscSqrtReal(nu) * beta; 13419566063dSJacob Faibussowitsch PetscCall(VecAXPBY(v, nu / beta, 0.0, work1)); /* v = nu/beta *c */ 13429566063dSJacob Faibussowitsch PetscCall(MatMult(jac->B, v, work2)); /* u = H^{-1}*B*v */ 13439566063dSJacob Faibussowitsch PetscCall(PetscLogEventBegin(ilinkA->event, ksp, work2, u, NULL)); 13449566063dSJacob Faibussowitsch PetscCall(KSPSolve(ksp, work2, u)); 13459566063dSJacob Faibussowitsch PetscCall(KSPCheckSolve(ksp, pc, u)); 13469566063dSJacob Faibussowitsch PetscCall(PetscLogEventEnd(ilinkA->event, ksp, work2, u, NULL)); 13479566063dSJacob Faibussowitsch PetscCall(MatMult(jac->H, u, Hu)); /* alpha = u'*H*u */ 13489566063dSJacob Faibussowitsch PetscCall(VecDot(Hu, u, &alpha)); 1349e071a0a4SCarola Kruse KSPCheckDot(ksp, alpha); 135008401ef6SPierre Jolivet PetscCheck(PetscRealPart(alpha) > 0.0, PETSC_COMM_SELF, PETSC_ERR_NOT_CONVERGED, "GKB preconditioner diverged, H is not positive definite"); 1351addd1e01SJunchao Zhang alpha = PetscSqrtReal(PetscAbsScalar(alpha)); 13529566063dSJacob Faibussowitsch PetscCall(VecScale(u, 1.0 / alpha)); 13539566063dSJacob Faibussowitsch PetscCall(VecAXPBY(d, 1.0 / alpha, 0.0, v)); /* v = nu/beta *c */ 1354de482cd7SCarola Kruse 1355a51937d4SCarola Kruse z = beta / alpha; 1356a51937d4SCarola Kruse vecz[1] = z; 1357a51937d4SCarola Kruse 1358de482cd7SCarola Kruse /* Computation of first iterate x(1) and p(1) */ 13599566063dSJacob Faibussowitsch PetscCall(VecAXPY(ilinkA->y, z, u)); 13609566063dSJacob Faibussowitsch PetscCall(VecCopy(d, ilinkD->y)); 13619566063dSJacob Faibussowitsch PetscCall(VecScale(ilinkD->y, -z)); 1362a51937d4SCarola Kruse 13639371c9d4SSatish Balay iterGKB = 1; 13649371c9d4SSatish Balay lowbnd = 2 * jac->gkbtol; 136548a46eb9SPierre Jolivet if (jac->gkbmonitor) PetscCall(PetscViewerASCIIPrintf(jac->gkbviewer, "%3" PetscInt_FMT " GKB Lower bound estimate %14.12e\n", iterGKB, (double)lowbnd)); 1366de482cd7SCarola Kruse 1367a51937d4SCarola Kruse while (iterGKB < jac->gkbmaxit && lowbnd > jac->gkbtol) { 1368a51937d4SCarola Kruse iterGKB += 1; 13699566063dSJacob Faibussowitsch PetscCall(MatMultHermitianTranspose(jac->B, u, work1)); /* v <- nu*(B'*u-alpha/nu*v) */ 13709566063dSJacob Faibussowitsch PetscCall(VecAXPBY(v, nu, -alpha, work1)); 13719566063dSJacob Faibussowitsch PetscCall(VecNorm(v, NORM_2, &beta)); /* beta = sqrt(nu)*v'*v */ 1372addd1e01SJunchao Zhang beta = beta / PetscSqrtReal(nu); 13739566063dSJacob Faibussowitsch PetscCall(VecScale(v, 1.0 / beta)); 13749566063dSJacob Faibussowitsch PetscCall(MatMult(jac->B, v, work2)); /* u <- H^{-1}*(B*v-beta*H*u) */ 13759566063dSJacob Faibussowitsch PetscCall(MatMult(jac->H, u, Hu)); 13769566063dSJacob Faibussowitsch PetscCall(VecAXPY(work2, -beta, Hu)); 13779566063dSJacob Faibussowitsch PetscCall(PetscLogEventBegin(ilinkA->event, ksp, work2, u, NULL)); 13789566063dSJacob Faibussowitsch PetscCall(KSPSolve(ksp, work2, u)); 13799566063dSJacob Faibussowitsch PetscCall(KSPCheckSolve(ksp, pc, u)); 13809566063dSJacob Faibussowitsch PetscCall(PetscLogEventEnd(ilinkA->event, ksp, work2, u, NULL)); 13819566063dSJacob Faibussowitsch PetscCall(MatMult(jac->H, u, Hu)); /* alpha = u'*H*u */ 13829566063dSJacob Faibussowitsch PetscCall(VecDot(Hu, u, &alpha)); 1383e071a0a4SCarola Kruse KSPCheckDot(ksp, alpha); 138408401ef6SPierre Jolivet PetscCheck(PetscRealPart(alpha) > 0.0, PETSC_COMM_SELF, PETSC_ERR_NOT_CONVERGED, "GKB preconditioner diverged, H is not positive definite"); 1385addd1e01SJunchao Zhang alpha = PetscSqrtReal(PetscAbsScalar(alpha)); 13869566063dSJacob Faibussowitsch PetscCall(VecScale(u, 1.0 / alpha)); 1387a51937d4SCarola Kruse 1388e071a0a4SCarola Kruse z = -beta / alpha * z; /* z <- beta/alpha*z */ 1389a51937d4SCarola Kruse vecz[0] = z; 1390a51937d4SCarola Kruse 1391a51937d4SCarola Kruse /* Computation of new iterate x(i+1) and p(i+1) */ 13929566063dSJacob Faibussowitsch PetscCall(VecAXPBY(d, 1.0 / alpha, -beta / alpha, v)); /* d = (v-beta*d)/alpha */ 13939566063dSJacob Faibussowitsch PetscCall(VecAXPY(ilinkA->y, z, u)); /* r = r + z*u */ 13949566063dSJacob Faibussowitsch PetscCall(VecAXPY(ilinkD->y, -z, d)); /* p = p - z*d */ 13959566063dSJacob Faibussowitsch PetscCall(MatMult(jac->H, ilinkA->y, Hu)); /* ||u||_H = u'*H*u */ 13969566063dSJacob Faibussowitsch PetscCall(VecDot(Hu, ilinkA->y, &nrmz2)); 1397a51937d4SCarola Kruse 1398a51937d4SCarola Kruse /* Compute Lower Bound estimate */ 1399a51937d4SCarola Kruse if (iterGKB > jac->gkbdelay) { 1400a51937d4SCarola Kruse lowbnd = 0.0; 1401ad540459SPierre Jolivet for (j = 0; j < jac->gkbdelay; j++) lowbnd += PetscAbsScalar(vecz[j] * vecz[j]); 1402addd1e01SJunchao Zhang lowbnd = PetscSqrtReal(lowbnd / PetscAbsScalar(nrmz2)); 1403a51937d4SCarola Kruse } 1404a51937d4SCarola Kruse 1405ad540459SPierre Jolivet for (j = 0; j < jac->gkbdelay - 1; j++) vecz[jac->gkbdelay - j - 1] = vecz[jac->gkbdelay - j - 2]; 140648a46eb9SPierre Jolivet if (jac->gkbmonitor) PetscCall(PetscViewerASCIIPrintf(jac->gkbviewer, "%3" PetscInt_FMT " GKB Lower bound estimate %14.12e\n", iterGKB, (double)lowbnd)); 1407a51937d4SCarola Kruse } 1408a51937d4SCarola Kruse 14099566063dSJacob Faibussowitsch PetscCall(VecScatterBegin(ilinkA->sctx, ilinkA->y, y, INSERT_VALUES, SCATTER_REVERSE)); 14109566063dSJacob Faibussowitsch PetscCall(VecScatterEnd(ilinkA->sctx, ilinkA->y, y, INSERT_VALUES, SCATTER_REVERSE)); 14119566063dSJacob Faibussowitsch PetscCall(VecScatterBegin(ilinkD->sctx, ilinkD->y, y, INSERT_VALUES, SCATTER_REVERSE)); 14129566063dSJacob Faibussowitsch PetscCall(VecScatterEnd(ilinkD->sctx, ilinkD->y, y, INSERT_VALUES, SCATTER_REVERSE)); 1413a51937d4SCarola Kruse 1414a51937d4SCarola Kruse PetscFunctionReturn(0); 1415a51937d4SCarola Kruse } 1416a51937d4SCarola Kruse 1417421e10b8SBarry Smith #define FieldSplitSplitSolveAddTranspose(ilink, xx, yy) \ 14189371c9d4SSatish Balay (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) || \ 14199371c9d4SSatish 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) || \ 1420ca9f406cSSatish Balay VecScatterEnd(ilink->sctx, ilink->x, yy, ADD_VALUES, SCATTER_REVERSE)) 1421421e10b8SBarry Smith 1422d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCApplyTranspose_FieldSplit(PC pc, Vec x, Vec y) 1423d71ae5a4SJacob Faibussowitsch { 1424421e10b8SBarry Smith PC_FieldSplit *jac = (PC_FieldSplit *)pc->data; 1425421e10b8SBarry Smith PC_FieldSplitLink ilink = jac->head; 1426939b8a20SBarry Smith PetscInt bs; 1427421e10b8SBarry Smith 1428421e10b8SBarry Smith PetscFunctionBegin; 1429421e10b8SBarry Smith if (jac->type == PC_COMPOSITE_ADDITIVE) { 1430421e10b8SBarry Smith if (jac->defaultsplit) { 14319566063dSJacob Faibussowitsch PetscCall(VecGetBlockSize(x, &bs)); 14322472a847SBarry 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); 14339566063dSJacob Faibussowitsch PetscCall(VecGetBlockSize(y, &bs)); 14342472a847SBarry 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); 14359566063dSJacob Faibussowitsch PetscCall(VecStrideGatherAll(x, jac->x, INSERT_VALUES)); 1436421e10b8SBarry Smith while (ilink) { 14379566063dSJacob Faibussowitsch PetscCall(PetscLogEventBegin(ilink->event, ilink->ksp, ilink->x, ilink->y, NULL)); 14389566063dSJacob Faibussowitsch PetscCall(KSPSolveTranspose(ilink->ksp, ilink->x, ilink->y)); 14399566063dSJacob Faibussowitsch PetscCall(KSPCheckSolve(ilink->ksp, pc, ilink->y)); 14409566063dSJacob Faibussowitsch PetscCall(PetscLogEventEnd(ilink->event, ilink->ksp, ilink->x, ilink->y, NULL)); 1441421e10b8SBarry Smith ilink = ilink->next; 1442421e10b8SBarry Smith } 14439566063dSJacob Faibussowitsch PetscCall(VecStrideScatterAll(jac->y, y, INSERT_VALUES)); 1444421e10b8SBarry Smith } else { 14459566063dSJacob Faibussowitsch PetscCall(VecSet(y, 0.0)); 1446421e10b8SBarry Smith while (ilink) { 14479566063dSJacob Faibussowitsch PetscCall(FieldSplitSplitSolveAddTranspose(ilink, x, y)); 1448421e10b8SBarry Smith ilink = ilink->next; 1449421e10b8SBarry Smith } 1450421e10b8SBarry Smith } 1451421e10b8SBarry Smith } else { 1452421e10b8SBarry Smith if (!jac->w1) { 14539566063dSJacob Faibussowitsch PetscCall(VecDuplicate(x, &jac->w1)); 14549566063dSJacob Faibussowitsch PetscCall(VecDuplicate(x, &jac->w2)); 1455421e10b8SBarry Smith } 14569566063dSJacob Faibussowitsch PetscCall(VecSet(y, 0.0)); 1457421e10b8SBarry Smith if (jac->type == PC_COMPOSITE_SYMMETRIC_MULTIPLICATIVE) { 14589566063dSJacob Faibussowitsch PetscCall(FieldSplitSplitSolveAddTranspose(ilink, x, y)); 1459421e10b8SBarry Smith while (ilink->next) { 1460421e10b8SBarry Smith ilink = ilink->next; 14619566063dSJacob Faibussowitsch PetscCall(MatMultTranspose(pc->mat, y, jac->w1)); 14629566063dSJacob Faibussowitsch PetscCall(VecWAXPY(jac->w2, -1.0, jac->w1, x)); 14639566063dSJacob Faibussowitsch PetscCall(FieldSplitSplitSolveAddTranspose(ilink, jac->w2, y)); 1464421e10b8SBarry Smith } 1465421e10b8SBarry Smith while (ilink->previous) { 1466421e10b8SBarry Smith ilink = ilink->previous; 14679566063dSJacob Faibussowitsch PetscCall(MatMultTranspose(pc->mat, y, jac->w1)); 14689566063dSJacob Faibussowitsch PetscCall(VecWAXPY(jac->w2, -1.0, jac->w1, x)); 14699566063dSJacob Faibussowitsch PetscCall(FieldSplitSplitSolveAddTranspose(ilink, jac->w2, y)); 1470421e10b8SBarry Smith } 1471421e10b8SBarry Smith } else { 1472421e10b8SBarry Smith while (ilink->next) { /* get to last entry in linked list */ 1473421e10b8SBarry Smith ilink = ilink->next; 1474421e10b8SBarry Smith } 14759566063dSJacob Faibussowitsch PetscCall(FieldSplitSplitSolveAddTranspose(ilink, x, y)); 1476421e10b8SBarry Smith while (ilink->previous) { 1477421e10b8SBarry Smith ilink = ilink->previous; 14789566063dSJacob Faibussowitsch PetscCall(MatMultTranspose(pc->mat, y, jac->w1)); 14799566063dSJacob Faibussowitsch PetscCall(VecWAXPY(jac->w2, -1.0, jac->w1, x)); 14809566063dSJacob Faibussowitsch PetscCall(FieldSplitSplitSolveAddTranspose(ilink, jac->w2, y)); 1481421e10b8SBarry Smith } 1482421e10b8SBarry Smith } 1483421e10b8SBarry Smith } 1484421e10b8SBarry Smith PetscFunctionReturn(0); 1485421e10b8SBarry Smith } 1486421e10b8SBarry Smith 1487d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCReset_FieldSplit(PC pc) 1488d71ae5a4SJacob Faibussowitsch { 14890971522cSBarry Smith PC_FieldSplit *jac = (PC_FieldSplit *)pc->data; 14905a9f2f41SSatish Balay PC_FieldSplitLink ilink = jac->head, next; 14910971522cSBarry Smith 14920971522cSBarry Smith PetscFunctionBegin; 14935a9f2f41SSatish Balay while (ilink) { 14949566063dSJacob Faibussowitsch PetscCall(KSPDestroy(&ilink->ksp)); 14959566063dSJacob Faibussowitsch PetscCall(VecDestroy(&ilink->x)); 14969566063dSJacob Faibussowitsch PetscCall(VecDestroy(&ilink->y)); 14979566063dSJacob Faibussowitsch PetscCall(VecDestroy(&ilink->z)); 14989566063dSJacob Faibussowitsch PetscCall(VecScatterDestroy(&ilink->sctx)); 14999566063dSJacob Faibussowitsch PetscCall(ISDestroy(&ilink->is)); 15009566063dSJacob Faibussowitsch PetscCall(ISDestroy(&ilink->is_col)); 15019566063dSJacob Faibussowitsch PetscCall(PetscFree(ilink->splitname)); 15029566063dSJacob Faibussowitsch PetscCall(PetscFree(ilink->fields)); 15039566063dSJacob Faibussowitsch PetscCall(PetscFree(ilink->fields_col)); 15045a9f2f41SSatish Balay next = ilink->next; 15059566063dSJacob Faibussowitsch PetscCall(PetscFree(ilink)); 15065a9f2f41SSatish Balay ilink = next; 15070971522cSBarry Smith } 1508f5f0d762SBarry Smith jac->head = NULL; 15099566063dSJacob Faibussowitsch PetscCall(PetscFree2(jac->x, jac->y)); 1510574deadeSBarry Smith if (jac->mat && jac->mat != jac->pmat) { 15119566063dSJacob Faibussowitsch PetscCall(MatDestroyMatrices(jac->nsplits, &jac->mat)); 1512574deadeSBarry Smith } else if (jac->mat) { 15130298fd71SBarry Smith jac->mat = NULL; 1514574deadeSBarry Smith } 15159566063dSJacob Faibussowitsch if (jac->pmat) PetscCall(MatDestroyMatrices(jac->nsplits, &jac->pmat)); 15169566063dSJacob Faibussowitsch if (jac->Afield) PetscCall(MatDestroyMatrices(jac->nsplits, &jac->Afield)); 1517f5f0d762SBarry Smith jac->nsplits = 0; 15189566063dSJacob Faibussowitsch PetscCall(VecDestroy(&jac->w1)); 15199566063dSJacob Faibussowitsch PetscCall(VecDestroy(&jac->w2)); 15209566063dSJacob Faibussowitsch PetscCall(MatDestroy(&jac->schur)); 15219566063dSJacob Faibussowitsch PetscCall(MatDestroy(&jac->schurp)); 15229566063dSJacob Faibussowitsch PetscCall(MatDestroy(&jac->schur_user)); 15239566063dSJacob Faibussowitsch PetscCall(KSPDestroy(&jac->kspschur)); 15249566063dSJacob Faibussowitsch PetscCall(KSPDestroy(&jac->kspupper)); 15259566063dSJacob Faibussowitsch PetscCall(MatDestroy(&jac->B)); 15269566063dSJacob Faibussowitsch PetscCall(MatDestroy(&jac->C)); 15279566063dSJacob Faibussowitsch PetscCall(MatDestroy(&jac->H)); 15289566063dSJacob Faibussowitsch PetscCall(VecDestroy(&jac->u)); 15299566063dSJacob Faibussowitsch PetscCall(VecDestroy(&jac->v)); 15309566063dSJacob Faibussowitsch PetscCall(VecDestroy(&jac->Hu)); 15319566063dSJacob Faibussowitsch PetscCall(VecDestroy(&jac->d)); 15329566063dSJacob Faibussowitsch PetscCall(PetscFree(jac->vecz)); 15339566063dSJacob Faibussowitsch PetscCall(PetscViewerDestroy(&jac->gkbviewer)); 15346dbb499eSCian Wilson jac->isrestrict = PETSC_FALSE; 1535574deadeSBarry Smith PetscFunctionReturn(0); 1536574deadeSBarry Smith } 1537574deadeSBarry Smith 1538d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCDestroy_FieldSplit(PC pc) 1539d71ae5a4SJacob Faibussowitsch { 1540574deadeSBarry Smith PetscFunctionBegin; 15419566063dSJacob Faibussowitsch PetscCall(PCReset_FieldSplit(pc)); 15429566063dSJacob Faibussowitsch PetscCall(PetscFree(pc->data)); 15432e956fe4SStefano Zampini PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCSetCoordinates_C", NULL)); 15449566063dSJacob Faibussowitsch PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetFields_C", NULL)); 15459566063dSJacob Faibussowitsch PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetIS_C", NULL)); 15469566063dSJacob Faibussowitsch PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetType_C", NULL)); 15479566063dSJacob Faibussowitsch PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetBlockSize_C", NULL)); 15482e956fe4SStefano Zampini PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitRestrictIS_C", NULL)); 15492e956fe4SStefano Zampini PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSchurGetSubKSP_C", NULL)); 15502e956fe4SStefano Zampini PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitGetSubKSP_C", NULL)); 15512e956fe4SStefano Zampini 15522e956fe4SStefano Zampini PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetGKBTol_C", NULL)); 15532e956fe4SStefano Zampini PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetGKBMaxit_C", NULL)); 15542e956fe4SStefano Zampini PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetGKBNu_C", NULL)); 15552e956fe4SStefano Zampini PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetGKBDelay_C", NULL)); 15562e956fe4SStefano Zampini PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitGetSubKSP_C", NULL)); 15579566063dSJacob Faibussowitsch PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetSchurPre_C", NULL)); 15589566063dSJacob Faibussowitsch PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitGetSchurPre_C", NULL)); 15599566063dSJacob Faibussowitsch PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetSchurFactType_C", NULL)); 15602e956fe4SStefano Zampini PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetSchurScale_C", NULL)); 15610971522cSBarry Smith PetscFunctionReturn(0); 15620971522cSBarry Smith } 15630971522cSBarry Smith 1564d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCSetFromOptions_FieldSplit(PC pc, PetscOptionItems *PetscOptionsObject) 1565d71ae5a4SJacob Faibussowitsch { 15666c924f48SJed Brown PetscInt bs; 15677b752e3dSPatrick Sanan PetscBool flg; 15689dcbbd2bSBarry Smith PC_FieldSplit *jac = (PC_FieldSplit *)pc->data; 15693b224e63SBarry Smith PCCompositeType ctype; 15701b9fc7fcSBarry Smith 15710971522cSBarry Smith PetscFunctionBegin; 1572d0609cedSBarry Smith PetscOptionsHeadBegin(PetscOptionsObject, "FieldSplit options"); 15739566063dSJacob Faibussowitsch PetscCall(PetscOptionsBool("-pc_fieldsplit_dm_splits", "Whether to use DMCreateFieldDecomposition() for splits", "PCFieldSplitSetDMSplits", jac->dm_splits, &jac->dm_splits, NULL)); 15749566063dSJacob Faibussowitsch PetscCall(PetscOptionsInt("-pc_fieldsplit_block_size", "Blocksize that defines number of fields", "PCFieldSplitSetBlockSize", jac->bs, &bs, &flg)); 15751baa6e33SBarry Smith if (flg) PetscCall(PCFieldSplitSetBlockSize(pc, bs)); 15762686e3e9SMatthew G. Knepley jac->diag_use_amat = pc->useAmat; 15779566063dSJacob 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)); 15782686e3e9SMatthew G. Knepley jac->offdiag_use_amat = pc->useAmat; 15799566063dSJacob 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)); 15809566063dSJacob Faibussowitsch PetscCall(PetscOptionsBool("-pc_fieldsplit_detect_saddle_point", "Form 2-way split by detecting zero diagonal entries", "PCFieldSplitSetDetectSaddlePoint", jac->detect, &jac->detect, NULL)); 15819566063dSJacob Faibussowitsch PetscCall(PCFieldSplitSetDetectSaddlePoint(pc, jac->detect)); /* Sets split type and Schur PC type */ 15829566063dSJacob Faibussowitsch PetscCall(PetscOptionsEnum("-pc_fieldsplit_type", "Type of composition", "PCFieldSplitSetType", PCCompositeTypes, (PetscEnum)jac->type, (PetscEnum *)&ctype, &flg)); 15831baa6e33SBarry Smith if (flg) PetscCall(PCFieldSplitSetType(pc, ctype)); 1584c30613efSMatthew Knepley /* Only setup fields once */ 1585c30613efSMatthew Knepley if ((jac->bs > 0) && (jac->nsplits == 0)) { 1586d32f9abdSBarry Smith /* only allow user to set fields from command line if bs is already known. 1587d32f9abdSBarry Smith otherwise user can set them in PCFieldSplitSetDefaults() */ 15889566063dSJacob Faibussowitsch PetscCall(PCFieldSplitSetRuntimeSplits_Private(pc)); 15899566063dSJacob Faibussowitsch if (jac->splitdefined) PetscCall(PetscInfo(pc, "Splits defined using the options database\n")); 1590d32f9abdSBarry Smith } 1591c5d2311dSJed Brown if (jac->type == PC_COMPOSITE_SCHUR) { 15929566063dSJacob Faibussowitsch PetscCall(PetscOptionsGetEnum(((PetscObject)pc)->options, ((PetscObject)pc)->prefix, "-pc_fieldsplit_schur_factorization_type", PCFieldSplitSchurFactTypes, (PetscEnum *)&jac->schurfactorization, &flg)); 15939566063dSJacob Faibussowitsch if (flg) PetscCall(PetscInfo(pc, "Deprecated use of -pc_fieldsplit_schur_factorization_type\n")); 15949566063dSJacob 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)); 15959566063dSJacob Faibussowitsch PetscCall(PetscOptionsEnum("-pc_fieldsplit_schur_precondition", "How to build preconditioner for Schur complement", "PCFieldSplitSetSchurPre", PCFieldSplitSchurPreTypes, (PetscEnum)jac->schurpre, (PetscEnum *)&jac->schurpre, NULL)); 15969566063dSJacob Faibussowitsch PetscCall(PetscOptionsScalar("-pc_fieldsplit_schur_scale", "Scale Schur complement", "PCFieldSplitSetSchurScale", jac->schurscale, &jac->schurscale, NULL)); 1597a51937d4SCarola Kruse } else if (jac->type == PC_COMPOSITE_GKB) { 15989566063dSJacob Faibussowitsch PetscCall(PetscOptionsReal("-pc_fieldsplit_gkb_tol", "The tolerance for the lower bound stopping criterion", "PCFieldSplitGKBTol", jac->gkbtol, &jac->gkbtol, NULL)); 15999566063dSJacob Faibussowitsch PetscCall(PetscOptionsInt("-pc_fieldsplit_gkb_delay", "The delay value for lower bound criterion", "PCFieldSplitGKBDelay", jac->gkbdelay, &jac->gkbdelay, NULL)); 16009566063dSJacob Faibussowitsch PetscCall(PetscOptionsReal("-pc_fieldsplit_gkb_nu", "Parameter in augmented Lagrangian approach", "PCFieldSplitGKBNu", jac->gkbnu, &jac->gkbnu, NULL)); 160163a3b9bcSJacob Faibussowitsch PetscCheck(jac->gkbnu >= 0, PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "nu cannot be less than 0: value %g", (double)jac->gkbnu); 16029566063dSJacob Faibussowitsch PetscCall(PetscOptionsInt("-pc_fieldsplit_gkb_maxit", "Maximum allowed number of iterations", "PCFieldSplitGKBMaxit", jac->gkbmaxit, &jac->gkbmaxit, NULL)); 16039566063dSJacob Faibussowitsch PetscCall(PetscOptionsBool("-pc_fieldsplit_gkb_monitor", "Prints number of GKB iterations and error", "PCFieldSplitGKB", jac->gkbmonitor, &jac->gkbmonitor, NULL)); 1604c5d2311dSJed Brown } 160534603f55SBarry Smith /* 160634603f55SBarry Smith In the initial call to this routine the sub-solver data structures do not exist so we cannot call KSPSetFromOptions() on them yet. 160734603f55SBarry 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 160834603f55SBarry Smith is called on the outer solver in case changes were made in the options database 160934603f55SBarry Smith 161034603f55SBarry 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() 161134603f55SBarry 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. 161234603f55SBarry Smith Without this extra check test p2p1fetidp_olof_full and others fail with incorrect matrix types. 161334603f55SBarry Smith 161434603f55SBarry Smith There could be a negative side effect of calling the KSPSetFromOptions() below. 161534603f55SBarry Smith 161634603f55SBarry 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 161734603f55SBarry Smith */ 161834603f55SBarry Smith if (jac->issetup) { 161934603f55SBarry Smith PC_FieldSplitLink ilink = jac->head; 162034603f55SBarry Smith if (jac->type == PC_COMPOSITE_SCHUR) { 162134603f55SBarry Smith if (jac->kspupper && jac->kspupper->totalits > 0) PetscCall(KSPSetFromOptions(jac->kspupper)); 162234603f55SBarry Smith if (jac->kspschur && jac->kspschur->totalits > 0) PetscCall(KSPSetFromOptions(jac->kspschur)); 162334603f55SBarry Smith } 162434603f55SBarry Smith while (ilink) { 162534603f55SBarry Smith if (ilink->ksp->totalits > 0) PetscCall(KSPSetFromOptions(ilink->ksp)); 162634603f55SBarry Smith ilink = ilink->next; 162734603f55SBarry Smith } 162834603f55SBarry Smith } 1629d0609cedSBarry Smith PetscOptionsHeadEnd(); 16300971522cSBarry Smith PetscFunctionReturn(0); 16310971522cSBarry Smith } 16320971522cSBarry Smith 1633d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCFieldSplitSetFields_FieldSplit(PC pc, const char splitname[], PetscInt n, const PetscInt *fields, const PetscInt *fields_col) 1634d71ae5a4SJacob Faibussowitsch { 163597bbdb24SBarry Smith PC_FieldSplit *jac = (PC_FieldSplit *)pc->data; 16365a9f2f41SSatish Balay PC_FieldSplitLink ilink, next = jac->head; 163769a612a9SBarry Smith char prefix[128]; 16385d4c12cdSJungho Lee PetscInt i; 16390971522cSBarry Smith 16400971522cSBarry Smith PetscFunctionBegin; 16416c924f48SJed Brown if (jac->splitdefined) { 16429566063dSJacob Faibussowitsch PetscCall(PetscInfo(pc, "Ignoring new split \"%s\" because the splits have already been defined\n", splitname)); 16436c924f48SJed Brown PetscFunctionReturn(0); 16446c924f48SJed Brown } 164551f519a2SBarry Smith for (i = 0; i < n; i++) { 164663a3b9bcSJacob 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); 164763a3b9bcSJacob Faibussowitsch PetscCheck(fields[i] >= 0, PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Negative field %" PetscInt_FMT " requested", fields[i]); 164851f519a2SBarry Smith } 16499566063dSJacob Faibussowitsch PetscCall(PetscNew(&ilink)); 1650a04f6461SBarry Smith if (splitname) { 16519566063dSJacob Faibussowitsch PetscCall(PetscStrallocpy(splitname, &ilink->splitname)); 1652a04f6461SBarry Smith } else { 16539566063dSJacob Faibussowitsch PetscCall(PetscMalloc1(3, &ilink->splitname)); 165463a3b9bcSJacob Faibussowitsch PetscCall(PetscSNPrintf(ilink->splitname, 2, "%" PetscInt_FMT, jac->nsplits)); 1655a04f6461SBarry Smith } 16569df09d43SBarry 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 */ 16579566063dSJacob Faibussowitsch PetscCall(PetscMalloc1(n, &ilink->fields)); 16589566063dSJacob Faibussowitsch PetscCall(PetscArraycpy(ilink->fields, fields, n)); 16599566063dSJacob Faibussowitsch PetscCall(PetscMalloc1(n, &ilink->fields_col)); 16609566063dSJacob Faibussowitsch PetscCall(PetscArraycpy(ilink->fields_col, fields_col, n)); 16612fa5cd67SKarl Rupp 16625a9f2f41SSatish Balay ilink->nfields = n; 16630298fd71SBarry Smith ilink->next = NULL; 16649566063dSJacob Faibussowitsch PetscCall(KSPCreate(PetscObjectComm((PetscObject)pc), &ilink->ksp)); 16659566063dSJacob Faibussowitsch PetscCall(KSPSetErrorIfNotConverged(ilink->ksp, pc->erroriffailure)); 16669566063dSJacob Faibussowitsch PetscCall(PetscObjectIncrementTabLevel((PetscObject)ilink->ksp, (PetscObject)pc, 1)); 16679566063dSJacob Faibussowitsch PetscCall(KSPSetType(ilink->ksp, KSPPREONLY)); 166869a612a9SBarry Smith 16699566063dSJacob Faibussowitsch PetscCall(PetscSNPrintf(prefix, sizeof(prefix), "%sfieldsplit_%s_", ((PetscObject)pc)->prefix ? ((PetscObject)pc)->prefix : "", ilink->splitname)); 16709566063dSJacob Faibussowitsch PetscCall(KSPSetOptionsPrefix(ilink->ksp, prefix)); 16710971522cSBarry Smith 16720971522cSBarry Smith if (!next) { 16735a9f2f41SSatish Balay jac->head = ilink; 16740298fd71SBarry Smith ilink->previous = NULL; 16750971522cSBarry Smith } else { 1676ad540459SPierre Jolivet while (next->next) next = next->next; 16775a9f2f41SSatish Balay next->next = ilink; 167851f519a2SBarry Smith ilink->previous = next; 16790971522cSBarry Smith } 16800971522cSBarry Smith jac->nsplits++; 16810971522cSBarry Smith PetscFunctionReturn(0); 16820971522cSBarry Smith } 16830971522cSBarry Smith 1684d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCFieldSplitSchurGetSubKSP_FieldSplit(PC pc, PetscInt *n, KSP **subksp) 1685d71ae5a4SJacob Faibussowitsch { 1686285fb4e2SStefano Zampini PC_FieldSplit *jac = (PC_FieldSplit *)pc->data; 1687285fb4e2SStefano Zampini 1688285fb4e2SStefano Zampini PetscFunctionBegin; 1689285fb4e2SStefano Zampini *subksp = NULL; 1690285fb4e2SStefano Zampini if (n) *n = 0; 1691285fb4e2SStefano Zampini if (jac->type == PC_COMPOSITE_SCHUR) { 1692285fb4e2SStefano Zampini PetscInt nn; 1693285fb4e2SStefano Zampini 169428b400f6SJacob Faibussowitsch PetscCheck(jac->schur, PetscObjectComm((PetscObject)pc), PETSC_ERR_ARG_WRONGSTATE, "Must call KSPSetUp() or PCSetUp() before calling PCFieldSplitSchurGetSubKSP()"); 169563a3b9bcSJacob Faibussowitsch PetscCheck(jac->nsplits == 2, PetscObjectComm((PetscObject)pc), PETSC_ERR_PLIB, "Unexpected number of splits %" PetscInt_FMT " != 2", jac->nsplits); 1696285fb4e2SStefano Zampini nn = jac->nsplits + (jac->kspupper != jac->head->ksp ? 1 : 0); 16979566063dSJacob Faibussowitsch PetscCall(PetscMalloc1(nn, subksp)); 1698285fb4e2SStefano Zampini (*subksp)[0] = jac->head->ksp; 1699285fb4e2SStefano Zampini (*subksp)[1] = jac->kspschur; 1700285fb4e2SStefano Zampini if (jac->kspupper != jac->head->ksp) (*subksp)[2] = jac->kspupper; 1701285fb4e2SStefano Zampini if (n) *n = nn; 1702285fb4e2SStefano Zampini } 1703285fb4e2SStefano Zampini PetscFunctionReturn(0); 1704285fb4e2SStefano Zampini } 1705285fb4e2SStefano Zampini 1706d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCFieldSplitGetSubKSP_FieldSplit_Schur(PC pc, PetscInt *n, KSP **subksp) 1707d71ae5a4SJacob Faibussowitsch { 1708e69d4d44SBarry Smith PC_FieldSplit *jac = (PC_FieldSplit *)pc->data; 1709e69d4d44SBarry Smith 1710e69d4d44SBarry Smith PetscFunctionBegin; 171128b400f6SJacob Faibussowitsch PetscCheck(jac->schur, PetscObjectComm((PetscObject)pc), PETSC_ERR_ARG_WRONGSTATE, "Must call KSPSetUp() or PCSetUp() before calling PCFieldSplitGetSubKSP()"); 17129566063dSJacob Faibussowitsch PetscCall(PetscMalloc1(jac->nsplits, subksp)); 17139566063dSJacob Faibussowitsch PetscCall(MatSchurComplementGetKSP(jac->schur, *subksp)); 17142fa5cd67SKarl Rupp 1715e69d4d44SBarry Smith (*subksp)[1] = jac->kspschur; 171613e0d083SBarry Smith if (n) *n = jac->nsplits; 1717e69d4d44SBarry Smith PetscFunctionReturn(0); 1718e69d4d44SBarry Smith } 17190971522cSBarry Smith 1720d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCFieldSplitGetSubKSP_FieldSplit(PC pc, PetscInt *n, KSP **subksp) 1721d71ae5a4SJacob Faibussowitsch { 17220971522cSBarry Smith PC_FieldSplit *jac = (PC_FieldSplit *)pc->data; 17230971522cSBarry Smith PetscInt cnt = 0; 17245a9f2f41SSatish Balay PC_FieldSplitLink ilink = jac->head; 17250971522cSBarry Smith 17260971522cSBarry Smith PetscFunctionBegin; 17279566063dSJacob Faibussowitsch PetscCall(PetscMalloc1(jac->nsplits, subksp)); 17285a9f2f41SSatish Balay while (ilink) { 17295a9f2f41SSatish Balay (*subksp)[cnt++] = ilink->ksp; 17305a9f2f41SSatish Balay ilink = ilink->next; 17310971522cSBarry Smith } 173263a3b9bcSJacob 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); 173313e0d083SBarry Smith if (n) *n = jac->nsplits; 17340971522cSBarry Smith PetscFunctionReturn(0); 17350971522cSBarry Smith } 17360971522cSBarry Smith 17376dbb499eSCian Wilson /*@C 1738f1580f4eSBarry Smith PCFieldSplitRestrictIS - Restricts the fieldsplit `IS`s to be within a given `IS`. 17396dbb499eSCian Wilson 17406dbb499eSCian Wilson Input Parameters: 17416dbb499eSCian Wilson + pc - the preconditioner context 1742a2b725a8SWilliam Gropp - is - the index set that defines the indices to which the fieldsplit is to be restricted 17436dbb499eSCian Wilson 17446dbb499eSCian Wilson Level: advanced 17456dbb499eSCian Wilson 1746f1580f4eSBarry Smith Developer Note: 1747f1580f4eSBarry Smith It seems the resulting `IS`s will not cover the entire space, so 1748f1580f4eSBarry Smith how can they define a convergent preconditioner? Needs explaining. 1749f1580f4eSBarry Smith 1750f1580f4eSBarry Smith .seealso: `PCFIELDSPLIT`, `PCFieldSplitSetFields()`, `PCFieldSplitSetIS()` 17516dbb499eSCian Wilson @*/ 1752d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitRestrictIS(PC pc, IS isy) 1753d71ae5a4SJacob Faibussowitsch { 17546dbb499eSCian Wilson PetscFunctionBegin; 17556dbb499eSCian Wilson PetscValidHeaderSpecific(pc, PC_CLASSID, 1); 17566dbb499eSCian Wilson PetscValidHeaderSpecific(isy, IS_CLASSID, 2); 1757cac4c232SBarry Smith PetscTryMethod(pc, "PCFieldSplitRestrictIS_C", (PC, IS), (pc, isy)); 17586dbb499eSCian Wilson PetscFunctionReturn(0); 17596dbb499eSCian Wilson } 17606dbb499eSCian Wilson 1761d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCFieldSplitRestrictIS_FieldSplit(PC pc, IS isy) 1762d71ae5a4SJacob Faibussowitsch { 17636dbb499eSCian Wilson PC_FieldSplit *jac = (PC_FieldSplit *)pc->data; 17646dbb499eSCian Wilson PC_FieldSplitLink ilink = jac->head, next; 17656dbb499eSCian Wilson PetscInt localsize, size, sizez, i; 17666dbb499eSCian Wilson const PetscInt *ind, *indz; 17676dbb499eSCian Wilson PetscInt *indc, *indcz; 17686dbb499eSCian Wilson PetscBool flg; 17696dbb499eSCian Wilson 17706dbb499eSCian Wilson PetscFunctionBegin; 17719566063dSJacob Faibussowitsch PetscCall(ISGetLocalSize(isy, &localsize)); 17729566063dSJacob Faibussowitsch PetscCallMPI(MPI_Scan(&localsize, &size, 1, MPIU_INT, MPI_SUM, PetscObjectComm((PetscObject)isy))); 17736dbb499eSCian Wilson size -= localsize; 17746dbb499eSCian Wilson while (ilink) { 17756dbb499eSCian Wilson IS isrl, isr; 17761c7cfba8SBarry Smith PC subpc; 17779566063dSJacob Faibussowitsch PetscCall(ISEmbed(ilink->is, isy, PETSC_TRUE, &isrl)); 17789566063dSJacob Faibussowitsch PetscCall(ISGetLocalSize(isrl, &localsize)); 17799566063dSJacob Faibussowitsch PetscCall(PetscMalloc1(localsize, &indc)); 17809566063dSJacob Faibussowitsch PetscCall(ISGetIndices(isrl, &ind)); 17819566063dSJacob Faibussowitsch PetscCall(PetscArraycpy(indc, ind, localsize)); 17829566063dSJacob Faibussowitsch PetscCall(ISRestoreIndices(isrl, &ind)); 17839566063dSJacob Faibussowitsch PetscCall(ISDestroy(&isrl)); 17846dbb499eSCian Wilson for (i = 0; i < localsize; i++) *(indc + i) += size; 17859566063dSJacob Faibussowitsch PetscCall(ISCreateGeneral(PetscObjectComm((PetscObject)isy), localsize, indc, PETSC_OWN_POINTER, &isr)); 17869566063dSJacob Faibussowitsch PetscCall(PetscObjectReference((PetscObject)isr)); 17879566063dSJacob Faibussowitsch PetscCall(ISDestroy(&ilink->is)); 17886dbb499eSCian Wilson ilink->is = isr; 17899566063dSJacob Faibussowitsch PetscCall(PetscObjectReference((PetscObject)isr)); 17909566063dSJacob Faibussowitsch PetscCall(ISDestroy(&ilink->is_col)); 17916dbb499eSCian Wilson ilink->is_col = isr; 17929566063dSJacob Faibussowitsch PetscCall(ISDestroy(&isr)); 17939566063dSJacob Faibussowitsch PetscCall(KSPGetPC(ilink->ksp, &subpc)); 17949566063dSJacob Faibussowitsch PetscCall(PetscObjectTypeCompare((PetscObject)subpc, PCFIELDSPLIT, &flg)); 17956dbb499eSCian Wilson if (flg) { 17966dbb499eSCian Wilson IS iszl, isz; 17976dbb499eSCian Wilson MPI_Comm comm; 17989566063dSJacob Faibussowitsch PetscCall(ISGetLocalSize(ilink->is, &localsize)); 17996dbb499eSCian Wilson comm = PetscObjectComm((PetscObject)ilink->is); 18009566063dSJacob Faibussowitsch PetscCall(ISEmbed(isy, ilink->is, PETSC_TRUE, &iszl)); 18019566063dSJacob Faibussowitsch PetscCallMPI(MPI_Scan(&localsize, &sizez, 1, MPIU_INT, MPI_SUM, comm)); 18026dbb499eSCian Wilson sizez -= localsize; 18039566063dSJacob Faibussowitsch PetscCall(ISGetLocalSize(iszl, &localsize)); 18049566063dSJacob Faibussowitsch PetscCall(PetscMalloc1(localsize, &indcz)); 18059566063dSJacob Faibussowitsch PetscCall(ISGetIndices(iszl, &indz)); 18069566063dSJacob Faibussowitsch PetscCall(PetscArraycpy(indcz, indz, localsize)); 18079566063dSJacob Faibussowitsch PetscCall(ISRestoreIndices(iszl, &indz)); 18089566063dSJacob Faibussowitsch PetscCall(ISDestroy(&iszl)); 18096dbb499eSCian Wilson for (i = 0; i < localsize; i++) *(indcz + i) += sizez; 18109566063dSJacob Faibussowitsch PetscCall(ISCreateGeneral(comm, localsize, indcz, PETSC_OWN_POINTER, &isz)); 18119566063dSJacob Faibussowitsch PetscCall(PCFieldSplitRestrictIS(subpc, isz)); 18129566063dSJacob Faibussowitsch PetscCall(ISDestroy(&isz)); 18136dbb499eSCian Wilson } 18146dbb499eSCian Wilson next = ilink->next; 18156dbb499eSCian Wilson ilink = next; 18166dbb499eSCian Wilson } 18176dbb499eSCian Wilson jac->isrestrict = PETSC_TRUE; 18186dbb499eSCian Wilson PetscFunctionReturn(0); 18196dbb499eSCian Wilson } 18206dbb499eSCian Wilson 1821d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCFieldSplitSetIS_FieldSplit(PC pc, const char splitname[], IS is) 1822d71ae5a4SJacob Faibussowitsch { 1823704ba839SBarry Smith PC_FieldSplit *jac = (PC_FieldSplit *)pc->data; 1824704ba839SBarry Smith PC_FieldSplitLink ilink, next = jac->head; 1825704ba839SBarry Smith char prefix[128]; 1826704ba839SBarry Smith 1827704ba839SBarry Smith PetscFunctionBegin; 18286c924f48SJed Brown if (jac->splitdefined) { 18299566063dSJacob Faibussowitsch PetscCall(PetscInfo(pc, "Ignoring new split \"%s\" because the splits have already been defined\n", splitname)); 18306c924f48SJed Brown PetscFunctionReturn(0); 18316c924f48SJed Brown } 18329566063dSJacob Faibussowitsch PetscCall(PetscNew(&ilink)); 1833a04f6461SBarry Smith if (splitname) { 18349566063dSJacob Faibussowitsch PetscCall(PetscStrallocpy(splitname, &ilink->splitname)); 1835a04f6461SBarry Smith } else { 18369566063dSJacob Faibussowitsch PetscCall(PetscMalloc1(8, &ilink->splitname)); 183763a3b9bcSJacob Faibussowitsch PetscCall(PetscSNPrintf(ilink->splitname, 7, "%" PetscInt_FMT, jac->nsplits)); 1838a04f6461SBarry Smith } 18399df09d43SBarry 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 */ 18409566063dSJacob Faibussowitsch PetscCall(PetscObjectReference((PetscObject)is)); 18419566063dSJacob Faibussowitsch PetscCall(ISDestroy(&ilink->is)); 1842b5787286SJed Brown ilink->is = is; 18439566063dSJacob Faibussowitsch PetscCall(PetscObjectReference((PetscObject)is)); 18449566063dSJacob Faibussowitsch PetscCall(ISDestroy(&ilink->is_col)); 1845b5787286SJed Brown ilink->is_col = is; 18460298fd71SBarry Smith ilink->next = NULL; 18479566063dSJacob Faibussowitsch PetscCall(KSPCreate(PetscObjectComm((PetscObject)pc), &ilink->ksp)); 18489566063dSJacob Faibussowitsch PetscCall(KSPSetErrorIfNotConverged(ilink->ksp, pc->erroriffailure)); 18499566063dSJacob Faibussowitsch PetscCall(PetscObjectIncrementTabLevel((PetscObject)ilink->ksp, (PetscObject)pc, 1)); 18509566063dSJacob Faibussowitsch PetscCall(KSPSetType(ilink->ksp, KSPPREONLY)); 1851704ba839SBarry Smith 18529566063dSJacob Faibussowitsch PetscCall(PetscSNPrintf(prefix, sizeof(prefix), "%sfieldsplit_%s_", ((PetscObject)pc)->prefix ? ((PetscObject)pc)->prefix : "", ilink->splitname)); 18539566063dSJacob Faibussowitsch PetscCall(KSPSetOptionsPrefix(ilink->ksp, prefix)); 1854704ba839SBarry Smith 1855704ba839SBarry Smith if (!next) { 1856704ba839SBarry Smith jac->head = ilink; 18570298fd71SBarry Smith ilink->previous = NULL; 1858704ba839SBarry Smith } else { 1859ad540459SPierre Jolivet while (next->next) next = next->next; 1860704ba839SBarry Smith next->next = ilink; 1861704ba839SBarry Smith ilink->previous = next; 1862704ba839SBarry Smith } 1863704ba839SBarry Smith jac->nsplits++; 1864704ba839SBarry Smith PetscFunctionReturn(0); 1865704ba839SBarry Smith } 1866704ba839SBarry Smith 186794ef8ddeSSatish Balay /*@C 1868f1580f4eSBarry Smith PCFieldSplitSetFields - Sets the fields that define one particular split in the field split preconditioner 18690971522cSBarry Smith 1870f1580f4eSBarry Smith Logically Collective on pc 18710971522cSBarry Smith 18720971522cSBarry Smith Input Parameters: 18730971522cSBarry Smith + pc - the preconditioner context 18740298fd71SBarry Smith . splitname - name of this split, if NULL the number of the split is used 18750971522cSBarry Smith . n - the number of fields in this split 1876db4c96c1SJed Brown - fields - the fields in this split 18770971522cSBarry Smith 18780971522cSBarry Smith Level: intermediate 18790971522cSBarry Smith 188095452b02SPatrick Sanan Notes: 1881f1580f4eSBarry Smith Use `PCFieldSplitSetIS()` to set a general set of indices as a split. 1882d32f9abdSBarry Smith 1883f1580f4eSBarry Smith `PCFieldSplitSetFields()` is for defining fields as strided blocks. For example, if the block 1884f1580f4eSBarry 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 1885d32f9abdSBarry Smith 0xx3xx6xx9xx12 ... x1xx4xx7xx ... xx2xx5xx8xx.. 01x34x67x... 0x1x3x5x7.. x12x45x78x.... 1886f1580f4eSBarry Smith where the numbered entries indicate what is in the split. 1887d32f9abdSBarry Smith 1888db4c96c1SJed Brown This function is called once per split (it creates a new split each time). Solve options 1889db4c96c1SJed Brown for this split will be available under the prefix -fieldsplit_SPLITNAME_. 1890db4c96c1SJed Brown 1891f1580f4eSBarry Smith Developer Note: 1892f1580f4eSBarry Smith This routine does not actually create the `IS` representing the split, that is delayed 1893f1580f4eSBarry Smith until `PCSetUp_FieldSplit()`, because information about the vector/matrix layouts may not be 18945d4c12cdSJungho Lee available when this routine is called. 18955d4c12cdSJungho Lee 1896f1580f4eSBarry Smith .seealso: `PCFieldSplitGetSubKSP()`, `PCFIELDSPLIT`, `PCFieldSplitSetBlockSize()`, `PCFieldSplitSetIS()`, `PCFieldSplitRestrictIS()` 18970971522cSBarry Smith @*/ 1898d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitSetFields(PC pc, const char splitname[], PetscInt n, const PetscInt *fields, const PetscInt *fields_col) 1899d71ae5a4SJacob Faibussowitsch { 19000971522cSBarry Smith PetscFunctionBegin; 19010700a824SBarry Smith PetscValidHeaderSpecific(pc, PC_CLASSID, 1); 1902db4c96c1SJed Brown PetscValidCharPointer(splitname, 2); 190363a3b9bcSJacob Faibussowitsch PetscCheck(n >= 1, PetscObjectComm((PetscObject)pc), PETSC_ERR_ARG_OUTOFRANGE, "Provided number of fields %" PetscInt_FMT " in split \"%s\" not positive", n, splitname); 1904064a246eSJacob Faibussowitsch PetscValidIntPointer(fields, 4); 1905cac4c232SBarry Smith PetscTryMethod(pc, "PCFieldSplitSetFields_C", (PC, const char[], PetscInt, const PetscInt *, const PetscInt *), (pc, splitname, n, fields, fields_col)); 19060971522cSBarry Smith PetscFunctionReturn(0); 19070971522cSBarry Smith } 19080971522cSBarry Smith 1909c84da90fSDmitry Karpeev /*@ 1910f1580f4eSBarry Smith PCFieldSplitSetDiagUseAmat - set flag indicating whether to extract diagonal blocks from Amat (rather than Pmat) to build 1911f1580f4eSBarry Smith the sub-matrices associated with each split. Where `KSPSetOperators`(ksp,Amat,Pmat)) was used to supply the operators. 1912c84da90fSDmitry Karpeev 1913f1580f4eSBarry Smith Logically Collective on pc 1914c84da90fSDmitry Karpeev 1915c84da90fSDmitry Karpeev Input Parameters: 1916c84da90fSDmitry Karpeev + pc - the preconditioner object 1917c84da90fSDmitry Karpeev - flg - boolean flag indicating whether or not to use Amat to extract the diagonal blocks from 1918c84da90fSDmitry Karpeev 1919f1580f4eSBarry Smith Options Database Keys: 1920147403d9SBarry Smith . -pc_fieldsplit_diag_use_amat - use the Amat to provide the diagonal blocks 1921c84da90fSDmitry Karpeev 1922c84da90fSDmitry Karpeev Level: intermediate 1923c84da90fSDmitry Karpeev 1924f1580f4eSBarry Smith .seealso: `PCSetOperators()`, `KSPSetOperators()`, `PCFieldSplitGetDiagUseAmat()`, `PCFieldSplitSetOffDiagUseAmat()`, `PCFIELDSPLIT` 1925c84da90fSDmitry Karpeev @*/ 1926d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitSetDiagUseAmat(PC pc, PetscBool flg) 1927d71ae5a4SJacob Faibussowitsch { 1928c84da90fSDmitry Karpeev PC_FieldSplit *jac = (PC_FieldSplit *)pc->data; 1929c84da90fSDmitry Karpeev PetscBool isfs; 1930c84da90fSDmitry Karpeev 1931c84da90fSDmitry Karpeev PetscFunctionBegin; 1932c84da90fSDmitry Karpeev PetscValidHeaderSpecific(pc, PC_CLASSID, 1); 19339566063dSJacob Faibussowitsch PetscCall(PetscObjectTypeCompare((PetscObject)pc, PCFIELDSPLIT, &isfs)); 193428b400f6SJacob Faibussowitsch PetscCheck(isfs, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "PC not of type %s", PCFIELDSPLIT); 1935c84da90fSDmitry Karpeev jac->diag_use_amat = flg; 1936c84da90fSDmitry Karpeev PetscFunctionReturn(0); 1937c84da90fSDmitry Karpeev } 1938c84da90fSDmitry Karpeev 1939c84da90fSDmitry Karpeev /*@ 1940f1580f4eSBarry Smith PCFieldSplitGetDiagUseAmat - get the flag indicating whether to extract diagonal blocks from Amat (rather than Pmat) to build 1941f1580f4eSBarry Smith the sub-matrices associated with each split. Where `KSPSetOperators`(ksp,Amat,Pmat)) was used to supply the operators. 1942c84da90fSDmitry Karpeev 1943f1580f4eSBarry Smith Logically Collective on pc 1944c84da90fSDmitry Karpeev 1945c84da90fSDmitry Karpeev Input Parameters: 1946c84da90fSDmitry Karpeev . pc - the preconditioner object 1947c84da90fSDmitry Karpeev 1948c84da90fSDmitry Karpeev Output Parameters: 1949c84da90fSDmitry Karpeev . flg - boolean flag indicating whether or not to use Amat to extract the diagonal blocks from 1950c84da90fSDmitry Karpeev 1951c84da90fSDmitry Karpeev Level: intermediate 1952c84da90fSDmitry Karpeev 1953f1580f4eSBarry Smith .seealso: `PCSetOperators()`, `KSPSetOperators()`, `PCFieldSplitSetDiagUseAmat()`, `PCFieldSplitGetOffDiagUseAmat()`, `PCFIELDSPLIT` 1954c84da90fSDmitry Karpeev @*/ 1955d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitGetDiagUseAmat(PC pc, PetscBool *flg) 1956d71ae5a4SJacob Faibussowitsch { 1957c84da90fSDmitry Karpeev PC_FieldSplit *jac = (PC_FieldSplit *)pc->data; 1958c84da90fSDmitry Karpeev PetscBool isfs; 1959c84da90fSDmitry Karpeev 1960c84da90fSDmitry Karpeev PetscFunctionBegin; 1961c84da90fSDmitry Karpeev PetscValidHeaderSpecific(pc, PC_CLASSID, 1); 1962534a8f05SLisandro Dalcin PetscValidBoolPointer(flg, 2); 19639566063dSJacob Faibussowitsch PetscCall(PetscObjectTypeCompare((PetscObject)pc, PCFIELDSPLIT, &isfs)); 196428b400f6SJacob Faibussowitsch PetscCheck(isfs, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "PC not of type %s", PCFIELDSPLIT); 1965c84da90fSDmitry Karpeev *flg = jac->diag_use_amat; 1966c84da90fSDmitry Karpeev PetscFunctionReturn(0); 1967c84da90fSDmitry Karpeev } 1968c84da90fSDmitry Karpeev 1969c84da90fSDmitry Karpeev /*@ 1970f1580f4eSBarry Smith PCFieldSplitSetOffDiagUseAmat - set flag indicating whether to extract off-diagonal blocks from Amat (rather than Pmat) to build 1971f1580f4eSBarry Smith the sub-matrices associated with each split. Where `KSPSetOperators`(ksp,Amat,Pmat)) was used to supply the operators. 1972c84da90fSDmitry Karpeev 1973f1580f4eSBarry Smith Logically Collective on pc 1974c84da90fSDmitry Karpeev 1975c84da90fSDmitry Karpeev Input Parameters: 1976c84da90fSDmitry Karpeev + pc - the preconditioner object 1977c84da90fSDmitry Karpeev - flg - boolean flag indicating whether or not to use Amat to extract the off-diagonal blocks from 1978c84da90fSDmitry Karpeev 1979f1580f4eSBarry Smith Options Database Keys: 1980147403d9SBarry Smith . -pc_fieldsplit_off_diag_use_amat <bool> - use the Amat to extract the off-diagonal blocks 1981c84da90fSDmitry Karpeev 1982c84da90fSDmitry Karpeev Level: intermediate 1983c84da90fSDmitry Karpeev 1984f1580f4eSBarry Smith .seealso: `PCSetOperators()`, `KSPSetOperators()`, `PCFieldSplitGetOffDiagUseAmat()`, `PCFieldSplitSetDiagUseAmat()`, `PCFIELDSPLIT` 1985c84da90fSDmitry Karpeev @*/ 1986d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitSetOffDiagUseAmat(PC pc, PetscBool flg) 1987d71ae5a4SJacob Faibussowitsch { 1988c84da90fSDmitry Karpeev PC_FieldSplit *jac = (PC_FieldSplit *)pc->data; 1989c84da90fSDmitry Karpeev PetscBool isfs; 1990c84da90fSDmitry Karpeev 1991c84da90fSDmitry Karpeev PetscFunctionBegin; 1992c84da90fSDmitry Karpeev PetscValidHeaderSpecific(pc, PC_CLASSID, 1); 19939566063dSJacob Faibussowitsch PetscCall(PetscObjectTypeCompare((PetscObject)pc, PCFIELDSPLIT, &isfs)); 199428b400f6SJacob Faibussowitsch PetscCheck(isfs, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "PC not of type %s", PCFIELDSPLIT); 1995c84da90fSDmitry Karpeev jac->offdiag_use_amat = flg; 1996c84da90fSDmitry Karpeev PetscFunctionReturn(0); 1997c84da90fSDmitry Karpeev } 1998c84da90fSDmitry Karpeev 1999c84da90fSDmitry Karpeev /*@ 2000f1580f4eSBarry Smith PCFieldSplitGetOffDiagUseAmat - get the flag indicating whether to extract off-diagonal blocks from Amat (rather than Pmat) to build 2001f1580f4eSBarry Smith the sub-matrices associated with each split. Where `KSPSetOperators`(ksp,Amat,Pmat)) was used to supply the operators. 2002c84da90fSDmitry Karpeev 2003f1580f4eSBarry Smith Logically Collective on pc 2004c84da90fSDmitry Karpeev 2005c84da90fSDmitry Karpeev Input Parameters: 2006c84da90fSDmitry Karpeev . pc - the preconditioner object 2007c84da90fSDmitry Karpeev 2008c84da90fSDmitry Karpeev Output Parameters: 2009c84da90fSDmitry Karpeev . flg - boolean flag indicating whether or not to use Amat to extract the off-diagonal blocks from 2010c84da90fSDmitry Karpeev 2011c84da90fSDmitry Karpeev Level: intermediate 2012c84da90fSDmitry Karpeev 2013f1580f4eSBarry Smith .seealso: `PCSetOperators()`, `KSPSetOperators()`, `PCFieldSplitSetOffDiagUseAmat()`, `PCFieldSplitGetDiagUseAmat()`, `PCFIELDSPLIT` 2014c84da90fSDmitry Karpeev @*/ 2015d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitGetOffDiagUseAmat(PC pc, PetscBool *flg) 2016d71ae5a4SJacob Faibussowitsch { 2017c84da90fSDmitry Karpeev PC_FieldSplit *jac = (PC_FieldSplit *)pc->data; 2018c84da90fSDmitry Karpeev PetscBool isfs; 2019c84da90fSDmitry Karpeev 2020c84da90fSDmitry Karpeev PetscFunctionBegin; 2021c84da90fSDmitry Karpeev PetscValidHeaderSpecific(pc, PC_CLASSID, 1); 2022534a8f05SLisandro Dalcin PetscValidBoolPointer(flg, 2); 20239566063dSJacob Faibussowitsch PetscCall(PetscObjectTypeCompare((PetscObject)pc, PCFIELDSPLIT, &isfs)); 202428b400f6SJacob Faibussowitsch PetscCheck(isfs, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "PC not of type %s", PCFIELDSPLIT); 2025c84da90fSDmitry Karpeev *flg = jac->offdiag_use_amat; 2026c84da90fSDmitry Karpeev PetscFunctionReturn(0); 2027c84da90fSDmitry Karpeev } 2028c84da90fSDmitry Karpeev 2029218d4943SBarry Smith /*@C 2030f1580f4eSBarry Smith PCFieldSplitSetIS - Sets the exact elements for a split in a `PCFIELDSPLIT` 2031704ba839SBarry Smith 2032f1580f4eSBarry Smith Logically Collective on pc 2033704ba839SBarry Smith 2034704ba839SBarry Smith Input Parameters: 2035704ba839SBarry Smith + pc - the preconditioner context 20360298fd71SBarry Smith . splitname - name of this split, if NULL the number of the split is used 2037f1580f4eSBarry Smith - is - the index set that defines the elements in this split 2038704ba839SBarry Smith 2039a6ffb8dbSJed Brown Notes: 2040f1580f4eSBarry Smith Use `PCFieldSplitSetFields()`, for splits defined by strided types. 2041a6ffb8dbSJed Brown 2042db4c96c1SJed Brown This function is called once per split (it creates a new split each time). Solve options 2043db4c96c1SJed Brown for this split will be available under the prefix -fieldsplit_SPLITNAME_. 2044d32f9abdSBarry Smith 2045704ba839SBarry Smith Level: intermediate 2046704ba839SBarry Smith 2047db781477SPatrick Sanan .seealso: `PCFieldSplitGetSubKSP()`, `PCFIELDSPLIT`, `PCFieldSplitSetBlockSize()` 2048704ba839SBarry Smith @*/ 2049d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitSetIS(PC pc, const char splitname[], IS is) 2050d71ae5a4SJacob Faibussowitsch { 2051704ba839SBarry Smith PetscFunctionBegin; 20520700a824SBarry Smith PetscValidHeaderSpecific(pc, PC_CLASSID, 1); 20537b62db95SJungho Lee if (splitname) PetscValidCharPointer(splitname, 2); 2054db4c96c1SJed Brown PetscValidHeaderSpecific(is, IS_CLASSID, 3); 2055cac4c232SBarry Smith PetscTryMethod(pc, "PCFieldSplitSetIS_C", (PC, const char[], IS), (pc, splitname, is)); 2056704ba839SBarry Smith PetscFunctionReturn(0); 2057704ba839SBarry Smith } 2058704ba839SBarry Smith 205994ef8ddeSSatish Balay /*@C 2060f1580f4eSBarry Smith PCFieldSplitGetIS - Retrieves the elements for a split as an `IS` 206157a9adfeSMatthew G Knepley 2062f1580f4eSBarry Smith Logically Collective on pc 206357a9adfeSMatthew G Knepley 206457a9adfeSMatthew G Knepley Input Parameters: 206557a9adfeSMatthew G Knepley + pc - the preconditioner context 206657a9adfeSMatthew G Knepley - splitname - name of this split 206757a9adfeSMatthew G Knepley 206857a9adfeSMatthew G Knepley Output Parameter: 2069f1580f4eSBarry Smith - is - the index set that defines the elements in this split, or NULL if the split is not found 207057a9adfeSMatthew G Knepley 207157a9adfeSMatthew G Knepley Level: intermediate 207257a9adfeSMatthew G Knepley 2073db781477SPatrick Sanan .seealso: `PCFieldSplitGetSubKSP()`, `PCFIELDSPLIT`, `PCFieldSplitSetIS()` 207457a9adfeSMatthew G Knepley @*/ 2075d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitGetIS(PC pc, const char splitname[], IS *is) 2076d71ae5a4SJacob Faibussowitsch { 207757a9adfeSMatthew G Knepley PetscFunctionBegin; 207857a9adfeSMatthew G Knepley PetscValidHeaderSpecific(pc, PC_CLASSID, 1); 207957a9adfeSMatthew G Knepley PetscValidCharPointer(splitname, 2); 208057a9adfeSMatthew G Knepley PetscValidPointer(is, 3); 208157a9adfeSMatthew G Knepley { 208257a9adfeSMatthew G Knepley PC_FieldSplit *jac = (PC_FieldSplit *)pc->data; 208357a9adfeSMatthew G Knepley PC_FieldSplitLink ilink = jac->head; 208457a9adfeSMatthew G Knepley PetscBool found; 208557a9adfeSMatthew G Knepley 20860298fd71SBarry Smith *is = NULL; 208757a9adfeSMatthew G Knepley while (ilink) { 20889566063dSJacob Faibussowitsch PetscCall(PetscStrcmp(ilink->splitname, splitname, &found)); 208957a9adfeSMatthew G Knepley if (found) { 209057a9adfeSMatthew G Knepley *is = ilink->is; 209157a9adfeSMatthew G Knepley break; 209257a9adfeSMatthew G Knepley } 209357a9adfeSMatthew G Knepley ilink = ilink->next; 209457a9adfeSMatthew G Knepley } 209557a9adfeSMatthew G Knepley } 209657a9adfeSMatthew G Knepley PetscFunctionReturn(0); 209757a9adfeSMatthew G Knepley } 209857a9adfeSMatthew G Knepley 2099998f007dSPierre Jolivet /*@C 2100f1580f4eSBarry Smith PCFieldSplitGetISByIndex - Retrieves the elements for a given split as an `IS` 2101998f007dSPierre Jolivet 2102f1580f4eSBarry Smith Logically Collective on pc 2103998f007dSPierre Jolivet 2104998f007dSPierre Jolivet Input Parameters: 2105998f007dSPierre Jolivet + pc - the preconditioner context 2106998f007dSPierre Jolivet - index - index of this split 2107998f007dSPierre Jolivet 2108998f007dSPierre Jolivet Output Parameter: 2109f1580f4eSBarry Smith - is - the index set that defines the elements in this split 2110998f007dSPierre Jolivet 2111998f007dSPierre Jolivet Level: intermediate 2112998f007dSPierre Jolivet 2113db781477SPatrick Sanan .seealso: `PCFieldSplitGetSubKSP()`, `PCFIELDSPLIT`, `PCFieldSplitGetIS()`, `PCFieldSplitSetIS()` 2114998f007dSPierre Jolivet @*/ 2115d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitGetISByIndex(PC pc, PetscInt index, IS *is) 2116d71ae5a4SJacob Faibussowitsch { 2117998f007dSPierre Jolivet PetscFunctionBegin; 211863a3b9bcSJacob Faibussowitsch PetscCheck(index >= 0, PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Negative field %" PetscInt_FMT " requested", index); 2119998f007dSPierre Jolivet PetscValidHeaderSpecific(pc, PC_CLASSID, 1); 2120998f007dSPierre Jolivet PetscValidPointer(is, 3); 2121998f007dSPierre Jolivet { 2122998f007dSPierre Jolivet PC_FieldSplit *jac = (PC_FieldSplit *)pc->data; 2123998f007dSPierre Jolivet PC_FieldSplitLink ilink = jac->head; 2124998f007dSPierre Jolivet PetscInt i = 0; 212563a3b9bcSJacob Faibussowitsch PetscCheck(index < jac->nsplits, PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field %" PetscInt_FMT " requested but only %" PetscInt_FMT " exist", index, jac->nsplits); 2126998f007dSPierre Jolivet 2127998f007dSPierre Jolivet while (i < index) { 2128998f007dSPierre Jolivet ilink = ilink->next; 2129998f007dSPierre Jolivet ++i; 2130998f007dSPierre Jolivet } 21319566063dSJacob Faibussowitsch PetscCall(PCFieldSplitGetIS(pc, ilink->splitname, is)); 2132998f007dSPierre Jolivet } 2133998f007dSPierre Jolivet PetscFunctionReturn(0); 2134998f007dSPierre Jolivet } 2135998f007dSPierre Jolivet 213651f519a2SBarry Smith /*@ 213751f519a2SBarry Smith PCFieldSplitSetBlockSize - Sets the block size for defining where fields start in the 2138f1580f4eSBarry Smith fieldsplit preconditioner when calling `PCFieldSplitSetIS()`. If not set the matrix block size is used. 213951f519a2SBarry Smith 2140f1580f4eSBarry Smith Logically Collective on pc 214151f519a2SBarry Smith 214251f519a2SBarry Smith Input Parameters: 214351f519a2SBarry Smith + pc - the preconditioner context 214451f519a2SBarry Smith - bs - the block size 214551f519a2SBarry Smith 214651f519a2SBarry Smith Level: intermediate 214751f519a2SBarry Smith 2148f1580f4eSBarry Smith .seealso: `PCFieldSplitGetSubKSP()`, `PCFIELDSPLIT`, `PCFieldSplitSetFields()`, `PCFieldSplitSetIS()` 214951f519a2SBarry Smith @*/ 2150d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitSetBlockSize(PC pc, PetscInt bs) 2151d71ae5a4SJacob Faibussowitsch { 215251f519a2SBarry Smith PetscFunctionBegin; 21530700a824SBarry Smith PetscValidHeaderSpecific(pc, PC_CLASSID, 1); 2154c5eb9154SBarry Smith PetscValidLogicalCollectiveInt(pc, bs, 2); 2155cac4c232SBarry Smith PetscTryMethod(pc, "PCFieldSplitSetBlockSize_C", (PC, PetscInt), (pc, bs)); 215651f519a2SBarry Smith PetscFunctionReturn(0); 215751f519a2SBarry Smith } 215851f519a2SBarry Smith 21590971522cSBarry Smith /*@C 2160f1580f4eSBarry Smith PCFieldSplitGetSubKSP - Gets the `KSP` contexts for all splits 21610971522cSBarry Smith 2162f1580f4eSBarry Smith Collective on pc 21630971522cSBarry Smith 21640971522cSBarry Smith Input Parameter: 21650971522cSBarry Smith . pc - the preconditioner context 21660971522cSBarry Smith 21670971522cSBarry Smith Output Parameters: 216813e0d083SBarry Smith + n - the number of splits 2169f1580f4eSBarry Smith - subksp - the array of `KSP` contexts 2170196cc216SBarry Smith 21710971522cSBarry Smith Level: advanced 21720971522cSBarry Smith 2173f1580f4eSBarry Smith Notes: 2174f1580f4eSBarry Smith After `PCFieldSplitGetSubKSP()` the array of `KSP`s is to be freed by the user with `PetscFree()` 2175f1580f4eSBarry Smith (not the `KSP`, just the array that contains them). 2176f1580f4eSBarry Smith 2177f1580f4eSBarry Smith You must call `PCSetUp()` before calling `PCFieldSplitGetSubKSP()`. 2178f1580f4eSBarry Smith 2179f1580f4eSBarry Smith If the fieldsplit is of type `PC_COMPOSITE_SCHUR`, it returns the `KSP` object used inside the 2180f1580f4eSBarry Smith Schur complement and the `KSP` object used to iterate over the Schur complement. 2181f1580f4eSBarry Smith To access all the `KSP` objects used in `PC_COMPOSITE_SCHUR`, use `PCFieldSplitSchurGetSubKSP()`. 2182f1580f4eSBarry Smith 2183f1580f4eSBarry Smith If the fieldsplit is of type `PC_COMPOSITE_GKB`, it returns the `KSP` object used to solve the 2184f1580f4eSBarry Smith inner linear system defined by the matrix H in each loop. 2185f1580f4eSBarry Smith 2186f1580f4eSBarry Smith Fortran Usage: 2187f1580f4eSBarry Smith You must pass in a `KSP` array that is large enough to contain all the `KSP`s. 2188f1580f4eSBarry Smith You can call `PCFieldSplitGetSubKSP`(pc,n,`PETSC_NULL_KSP`,ierr) to determine how large the 2189f1580f4eSBarry Smith `KSP` array must be. 2190f1580f4eSBarry Smith 2191f1580f4eSBarry Smith Developer Note: 2192f1580f4eSBarry Smith There should be a `PCFieldSplitRestoreSubKSP()` instead of requiring the user to call `PetscFree()` 2193f1580f4eSBarry Smith 2194f1580f4eSBarry Smith The Fortran interface should be modernized to return directly the array of values. 2195f1580f4eSBarry Smith 2196f1580f4eSBarry Smith .seealso: `PCFIELDSPLIT`, `PCFieldSplitSetFields()`, `PCFieldSplitSetIS()`, `PCFieldSplitSchurGetSubKSP()` 21970971522cSBarry Smith @*/ 2198d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitGetSubKSP(PC pc, PetscInt *n, KSP *subksp[]) 2199d71ae5a4SJacob Faibussowitsch { 22000971522cSBarry Smith PetscFunctionBegin; 22010700a824SBarry Smith PetscValidHeaderSpecific(pc, PC_CLASSID, 1); 220213e0d083SBarry Smith if (n) PetscValidIntPointer(n, 2); 2203cac4c232SBarry Smith PetscUseMethod(pc, "PCFieldSplitGetSubKSP_C", (PC, PetscInt *, KSP **), (pc, n, subksp)); 22040971522cSBarry Smith PetscFunctionReturn(0); 22050971522cSBarry Smith } 22060971522cSBarry Smith 2207285fb4e2SStefano Zampini /*@C 2208f1580f4eSBarry Smith PCFieldSplitSchurGetSubKSP - Gets the `KSP` contexts used inside the Schur complement based `PCFIELDSPLIT` 2209285fb4e2SStefano Zampini 2210f1580f4eSBarry Smith Collective on `KSP` 2211285fb4e2SStefano Zampini 2212285fb4e2SStefano Zampini Input Parameter: 2213285fb4e2SStefano Zampini . pc - the preconditioner context 2214285fb4e2SStefano Zampini 2215285fb4e2SStefano Zampini Output Parameters: 2216285fb4e2SStefano Zampini + n - the number of splits 2217f1580f4eSBarry Smith - subksp - the array of `KSP` contexts 2218285fb4e2SStefano Zampini 2219285fb4e2SStefano Zampini Level: advanced 2220285fb4e2SStefano Zampini 2221f1580f4eSBarry Smith Notes: 2222f1580f4eSBarry Smith After `PCFieldSplitSchurGetSubKSP()` the array of `KSP`s is to be freed by the user with `PetscFree()` 2223f1580f4eSBarry Smith (not the `KSP` just the array that contains them). 2224f1580f4eSBarry Smith 2225f1580f4eSBarry Smith You must call `PCSetUp()` before calling `PCFieldSplitSchurGetSubKSP()`. 2226f1580f4eSBarry Smith 2227f1580f4eSBarry Smith If the fieldsplit type is of type `PC_COMPOSITE_SCHUR`, it returns (in order) 2228f1580f4eSBarry Smith + 1 - the `KSP` used for the (1,1) block 2229f1580f4eSBarry Smith . 2 - the `KSP` used for the Schur complement (not the one used for the interior Schur solver) 2230f1580f4eSBarry Smith - 3 - the `KSP` used for the (1,1) block in the upper triangular factor (if different from that of the (1,1) block). 2231f1580f4eSBarry Smith 2232f1580f4eSBarry Smith It returns a null array if the fieldsplit is not of type `PC_COMPOSITE_SCHUR`; in this case, you should use `PCFieldSplitGetSubKSP()`. 2233f1580f4eSBarry Smith 2234f1580f4eSBarry Smith Fortran Note: 2235f1580f4eSBarry Smith You must pass in a `KSP` array that is large enough to contain all the local `KSP`s. 2236f1580f4eSBarry Smith You can call `PCFieldSplitSchurGetSubKSP`(pc,n,`PETSC_NULL_KSP`,ierr) to determine how large the 2237f1580f4eSBarry Smith `KSP` array must be. 2238f1580f4eSBarry Smith 2239f1580f4eSBarry Smith Developer Notes: 2240f1580f4eSBarry Smith There should be a `PCFieldSplitRestoreSubKSP()` instead of requiring the user to call `PetscFree()` 2241f1580f4eSBarry Smith 2242f1580f4eSBarry Smith Should the functionality of `PCFieldSplitSchurGetSubKSP()` and `PCFieldSplitGetSubKSP()` be merged? 2243f1580f4eSBarry Smith 2244f1580f4eSBarry Smith The Fortran interface should be modernized to return directly the array of values. 2245f1580f4eSBarry Smith 2246f1580f4eSBarry Smith .seealso: `PCFIELDSPLIT`, `PCFieldSplitSetFields()`, `PCFieldSplitSetIS()`, `PCFieldSplitGetSubKSP()` 2247285fb4e2SStefano Zampini @*/ 2248d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitSchurGetSubKSP(PC pc, PetscInt *n, KSP *subksp[]) 2249d71ae5a4SJacob Faibussowitsch { 2250285fb4e2SStefano Zampini PetscFunctionBegin; 2251285fb4e2SStefano Zampini PetscValidHeaderSpecific(pc, PC_CLASSID, 1); 2252285fb4e2SStefano Zampini if (n) PetscValidIntPointer(n, 2); 2253cac4c232SBarry Smith PetscUseMethod(pc, "PCFieldSplitSchurGetSubKSP_C", (PC, PetscInt *, KSP **), (pc, n, subksp)); 2254285fb4e2SStefano Zampini PetscFunctionReturn(0); 2255285fb4e2SStefano Zampini } 2256285fb4e2SStefano Zampini 2257e69d4d44SBarry Smith /*@ 2258a1e3cbf9SBarry Smith PCFieldSplitSetSchurPre - Indicates from what operator the preconditioner is constructucted for the Schur complement. 2259a1e3cbf9SBarry Smith The default is the A11 matrix. 2260e69d4d44SBarry Smith 2261f1580f4eSBarry Smith Collective on pc 2262e69d4d44SBarry Smith 2263e69d4d44SBarry Smith Input Parameters: 2264e69d4d44SBarry Smith + pc - the preconditioner context 2265f1580f4eSBarry Smith . ptype - which matrix to use for preconditioning the Schur complement: `PC_FIELDSPLIT_SCHUR_PRE_A11` (default), 2266f1580f4eSBarry Smith `PC_FIELDSPLIT_SCHUR_PRE_SELF`, `PC_FIELDSPLIT_SCHUR_PRE_USER`, 2267f1580f4eSBarry Smith `PC_FIELDSPLIT_SCHUR_PRE_SELFP`, and `PC_FIELDSPLIT_SCHUR_PRE_FULL` 2268e920b4e0SRichard Tran Mills - pre - matrix to use for preconditioning, or NULL 2269084e4875SJed Brown 2270f1580f4eSBarry Smith Options Database Keys: 2271a1e3cbf9SBarry Smith + -pc_fieldsplit_schur_precondition <self,selfp,user,a11,full> - default is a11. See notes for meaning of various arguments 2272a1e3cbf9SBarry Smith - -fieldsplit_1_pc_type <pctype> - the preconditioner algorithm that is used to construct the preconditioner from the operator 2273e69d4d44SBarry Smith 2274fd1303e9SJungho Lee Notes: 2275f1580f4eSBarry Smith If ptype is 2276f1580f4eSBarry Smith + a11 - the preconditioner for the Schur complement is generated from the block diagonal part of the preconditioner 2277f1580f4eSBarry Smith matrix associated with the Schur complement (i.e. A11), not the Schur complement matrix 2278f1580f4eSBarry Smith . self - the preconditioner for the Schur complement is generated from the symbolic representation of the Schur complement matrix: 2279f1580f4eSBarry Smith The only preconditioner that currently works with this symbolic respresentation matrix object is the PCLSC 2280f1580f4eSBarry Smith preconditioner 2281f1580f4eSBarry Smith . user - the preconditioner for the Schur complement is generated from the user provided matrix (pre argument 2282f1580f4eSBarry Smith to this function). 2283f1580f4eSBarry Smith . selfp - the preconditioning for the Schur complement is generated from an explicitly-assembled approximation Sp = A11 - A10 inv(diag(A00)) A01 2284f1580f4eSBarry Smith This is only a good preconditioner when diag(A00) is a good preconditioner for A00. Optionally, A00 can be 2285f1580f4eSBarry Smith lumped before extracting the diagonal using the additional option -fieldsplit_1_mat_schur_complement_ainv_type lump 2286f1580f4eSBarry Smith - full - the preconditioner for the Schur complement is generated from the exact Schur complement matrix representation 2287f1580f4eSBarry Smith computed internally by `PCFIELDSPLIT` (this is expensive) 2288f1580f4eSBarry Smith useful mostly as a test that the Schur complement approach can work for your problem 2289fd1303e9SJungho Lee 2290e87fab1bSBarry Smith When solving a saddle point problem, where the A11 block is identically zero, using a11 as the ptype only makes sense 2291fd1303e9SJungho Lee with the additional option -fieldsplit_1_pc_type none. Usually for saddle point problems one would use a ptype of self and 2292a7476a74SDmitry Karpeev -fieldsplit_1_pc_type lsc which uses the least squares commutator to compute a preconditioner for the Schur complement. 2293fd1303e9SJungho Lee 2294e69d4d44SBarry Smith Level: intermediate 2295e69d4d44SBarry Smith 2296db781477SPatrick Sanan .seealso: `PCFieldSplitGetSchurPre()`, `PCFieldSplitGetSubKSP()`, `PCFIELDSPLIT`, `PCFieldSplitSetFields()`, `PCFieldSplitSchurPreType`, 2297f1580f4eSBarry Smith `MatSchurComplementSetAinvType()`, `PCLSC`, 2298f1580f4eSBarry Smith `PCFieldSplitSchurPreType` 2299e69d4d44SBarry Smith @*/ 2300d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitSetSchurPre(PC pc, PCFieldSplitSchurPreType ptype, Mat pre) 2301d71ae5a4SJacob Faibussowitsch { 2302e69d4d44SBarry Smith PetscFunctionBegin; 23030700a824SBarry Smith PetscValidHeaderSpecific(pc, PC_CLASSID, 1); 2304cac4c232SBarry Smith PetscTryMethod(pc, "PCFieldSplitSetSchurPre_C", (PC, PCFieldSplitSchurPreType, Mat), (pc, ptype, pre)); 2305e69d4d44SBarry Smith PetscFunctionReturn(0); 2306e69d4d44SBarry Smith } 2307686bed4dSStefano Zampini 2308d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitSchurPrecondition(PC pc, PCFieldSplitSchurPreType ptype, Mat pre) 2309d71ae5a4SJacob Faibussowitsch { 23109371c9d4SSatish Balay return PCFieldSplitSetSchurPre(pc, ptype, pre); 23119371c9d4SSatish Balay } /* Deprecated name */ 2312e69d4d44SBarry Smith 231337a82bf0SJed Brown /*@ 231437a82bf0SJed Brown PCFieldSplitGetSchurPre - For Schur complement fieldsplit, determine how the Schur complement will be 2315f1580f4eSBarry Smith preconditioned. See `PCFieldSplitSetSchurPre()` for details. 231637a82bf0SJed Brown 2317f1580f4eSBarry Smith Logically Collective on pc 231837a82bf0SJed Brown 2319f899ff85SJose E. Roman Input Parameter: 232037a82bf0SJed Brown . pc - the preconditioner context 232137a82bf0SJed Brown 232237a82bf0SJed Brown Output Parameters: 2323f1580f4eSBarry 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` 2324f408ff4eSRichard Tran Mills - pre - matrix to use for preconditioning (with `PC_FIELDSPLIT_PRE_USER`), or NULL 232537a82bf0SJed Brown 232637a82bf0SJed Brown Level: intermediate 232737a82bf0SJed Brown 2328f1580f4eSBarry Smith .seealso: `PCFieldSplitSetSchurPre()`, `PCFieldSplitGetSubKSP()`, `PCFIELDSPLIT`, `PCFieldSplitSetFields()`, `PCFieldSplitSchurPreType`, `PCLSC`, 2329f1580f4eSBarry Smith `PCFieldSplitSchurPreType` 233037a82bf0SJed Brown @*/ 2331d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitGetSchurPre(PC pc, PCFieldSplitSchurPreType *ptype, Mat *pre) 2332d71ae5a4SJacob Faibussowitsch { 233337a82bf0SJed Brown PetscFunctionBegin; 233437a82bf0SJed Brown PetscValidHeaderSpecific(pc, PC_CLASSID, 1); 2335cac4c232SBarry Smith PetscUseMethod(pc, "PCFieldSplitGetSchurPre_C", (PC, PCFieldSplitSchurPreType *, Mat *), (pc, ptype, pre)); 2336e69d4d44SBarry Smith PetscFunctionReturn(0); 2337e69d4d44SBarry Smith } 2338e69d4d44SBarry Smith 233945e7fc46SDmitry Karpeev /*@ 2340f1580f4eSBarry Smith PCFieldSplitSchurGetS - extract the `MATSCHURCOMPLEMENT` object used by this `PCFIELDSPLIT` in case it needs to be configured separately 234145e7fc46SDmitry Karpeev 234245e7fc46SDmitry Karpeev Not collective 234345e7fc46SDmitry Karpeev 234445e7fc46SDmitry Karpeev Input Parameter: 234545e7fc46SDmitry Karpeev . pc - the preconditioner context 234645e7fc46SDmitry Karpeev 234745e7fc46SDmitry Karpeev Output Parameter: 2348470b340bSDmitry Karpeev . S - the Schur complement matrix 234945e7fc46SDmitry Karpeev 2350f1580f4eSBarry Smith Note: 2351f1580f4eSBarry Smith This matrix should not be destroyed using `MatDestroy()`; rather, use `PCFieldSplitSchurRestoreS()`. 235245e7fc46SDmitry Karpeev 235345e7fc46SDmitry Karpeev Level: advanced 235445e7fc46SDmitry Karpeev 2355f1580f4eSBarry Smith .seealso: `PCFieldSplitGetSubKSP()`, `PCFIELDSPLIT`, `PCFieldSplitSchurPreType`, `PCFieldSplitSetSchurPre()`, `MATSCHURCOMPLEMENT`, `PCFieldSplitSchurRestoreS()`, 2356f1580f4eSBarry Smith `MatCreateSchurComplement()`, `MatSchurComplementGetKSP()`, `MatSchurComplementComputeExplicitOperator()`, `MatGetSchurComplement()` 235745e7fc46SDmitry Karpeev @*/ 2358d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitSchurGetS(PC pc, Mat *S) 2359d71ae5a4SJacob Faibussowitsch { 236045e7fc46SDmitry Karpeev const char *t; 236145e7fc46SDmitry Karpeev PetscBool isfs; 236245e7fc46SDmitry Karpeev PC_FieldSplit *jac; 236345e7fc46SDmitry Karpeev 236445e7fc46SDmitry Karpeev PetscFunctionBegin; 236545e7fc46SDmitry Karpeev PetscValidHeaderSpecific(pc, PC_CLASSID, 1); 23669566063dSJacob Faibussowitsch PetscCall(PetscObjectGetType((PetscObject)pc, &t)); 23679566063dSJacob Faibussowitsch PetscCall(PetscStrcmp(t, PCFIELDSPLIT, &isfs)); 236828b400f6SJacob Faibussowitsch PetscCheck(isfs, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "Expected PC of type PCFIELDSPLIT, got %s instead", t); 236945e7fc46SDmitry Karpeev jac = (PC_FieldSplit *)pc->data; 237063a3b9bcSJacob Faibussowitsch PetscCheck(jac->type == PC_COMPOSITE_SCHUR, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "Expected PCFIELDSPLIT of type SCHUR, got %d instead", jac->type); 2371470b340bSDmitry Karpeev if (S) *S = jac->schur; 237245e7fc46SDmitry Karpeev PetscFunctionReturn(0); 237345e7fc46SDmitry Karpeev } 237445e7fc46SDmitry Karpeev 2375470b340bSDmitry Karpeev /*@ 2376f1580f4eSBarry Smith PCFieldSplitSchurRestoreS - returns the `MATSCHURCOMPLEMENT` matrix used by this `PC` 2377470b340bSDmitry Karpeev 2378470b340bSDmitry Karpeev Not collective 2379470b340bSDmitry Karpeev 2380470b340bSDmitry Karpeev Input Parameters: 2381470b340bSDmitry Karpeev + pc - the preconditioner context 2382a2b725a8SWilliam Gropp - S - the Schur complement matrix 2383470b340bSDmitry Karpeev 2384470b340bSDmitry Karpeev Level: advanced 2385470b340bSDmitry Karpeev 2386db781477SPatrick Sanan .seealso: `PCFieldSplitGetSubKSP()`, `PCFIELDSPLIT`, `PCFieldSplitSchurPreType`, `PCFieldSplitSetSchurPre()`, `MatSchurComplement`, `PCFieldSplitSchurGetS()` 2387470b340bSDmitry Karpeev @*/ 2388d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitSchurRestoreS(PC pc, Mat *S) 2389d71ae5a4SJacob Faibussowitsch { 2390470b340bSDmitry Karpeev const char *t; 2391470b340bSDmitry Karpeev PetscBool isfs; 2392470b340bSDmitry Karpeev PC_FieldSplit *jac; 2393470b340bSDmitry Karpeev 2394470b340bSDmitry Karpeev PetscFunctionBegin; 2395470b340bSDmitry Karpeev PetscValidHeaderSpecific(pc, PC_CLASSID, 1); 23969566063dSJacob Faibussowitsch PetscCall(PetscObjectGetType((PetscObject)pc, &t)); 23979566063dSJacob Faibussowitsch PetscCall(PetscStrcmp(t, PCFIELDSPLIT, &isfs)); 239828b400f6SJacob Faibussowitsch PetscCheck(isfs, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "Expected PC of type PCFIELDSPLIT, got %s instead", t); 2399470b340bSDmitry Karpeev jac = (PC_FieldSplit *)pc->data; 240063a3b9bcSJacob Faibussowitsch PetscCheck(jac->type == PC_COMPOSITE_SCHUR, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "Expected PCFIELDSPLIT of type SCHUR, got %d instead", jac->type); 24017827d75bSBarry Smith PetscCheck(S && (*S == jac->schur), PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "MatSchurComplement restored is not the same as gotten"); 2402470b340bSDmitry Karpeev PetscFunctionReturn(0); 2403470b340bSDmitry Karpeev } 2404470b340bSDmitry Karpeev 2405d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCFieldSplitSetSchurPre_FieldSplit(PC pc, PCFieldSplitSchurPreType ptype, Mat pre) 2406d71ae5a4SJacob Faibussowitsch { 2407e69d4d44SBarry Smith PC_FieldSplit *jac = (PC_FieldSplit *)pc->data; 2408e69d4d44SBarry Smith 2409e69d4d44SBarry Smith PetscFunctionBegin; 2410084e4875SJed Brown jac->schurpre = ptype; 2411a7476a74SDmitry Karpeev if (ptype == PC_FIELDSPLIT_SCHUR_PRE_USER && pre) { 24129566063dSJacob Faibussowitsch PetscCall(MatDestroy(&jac->schur_user)); 2413084e4875SJed Brown jac->schur_user = pre; 24149566063dSJacob Faibussowitsch PetscCall(PetscObjectReference((PetscObject)jac->schur_user)); 2415084e4875SJed Brown } 2416e69d4d44SBarry Smith PetscFunctionReturn(0); 2417e69d4d44SBarry Smith } 2418e69d4d44SBarry Smith 2419d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCFieldSplitGetSchurPre_FieldSplit(PC pc, PCFieldSplitSchurPreType *ptype, Mat *pre) 2420d71ae5a4SJacob Faibussowitsch { 242137a82bf0SJed Brown PC_FieldSplit *jac = (PC_FieldSplit *)pc->data; 242237a82bf0SJed Brown 242337a82bf0SJed Brown PetscFunctionBegin; 242437a82bf0SJed Brown *ptype = jac->schurpre; 242537a82bf0SJed Brown *pre = jac->schur_user; 242637a82bf0SJed Brown PetscFunctionReturn(0); 242737a82bf0SJed Brown } 242837a82bf0SJed Brown 2429ab1df9f5SJed Brown /*@ 24300ffb0e17SBarry Smith PCFieldSplitSetSchurFactType - sets which blocks of the approximate block factorization to retain in the preconditioner 2431ab1df9f5SJed Brown 2432f1580f4eSBarry Smith Collective on pc 2433ab1df9f5SJed Brown 2434ab1df9f5SJed Brown Input Parameters: 2435ab1df9f5SJed Brown + pc - the preconditioner context 2436f1580f4eSBarry Smith - ftype - which blocks of factorization to retain, `PC_FIELDSPLIT_SCHUR_FACT_FULL` is default 2437ab1df9f5SJed Brown 2438f1580f4eSBarry Smith Options Database Key: 2439147403d9SBarry Smith . -pc_fieldsplit_schur_fact_type <diag,lower,upper,full> - default is full 2440ab1df9f5SJed Brown 2441ab1df9f5SJed Brown Level: intermediate 2442ab1df9f5SJed Brown 2443ab1df9f5SJed Brown Notes: 2444ab1df9f5SJed Brown The FULL factorization is 2445ab1df9f5SJed Brown 2446147403d9SBarry Smith .vb 2447147403d9SBarry Smith (A B) = (1 0) (A 0) (1 Ainv*B) = L D U 2448147403d9SBarry Smith (C E) (C*Ainv 1) (0 S) (0 1) 2449147403d9SBarry Smith .vb 24500ffb0e17SBarry 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, 2451c096484dSStefano Zampini and DIAG is the diagonal part with the sign of S flipped (because this makes the preconditioner positive definite for many formulations, thus allowing the use of KSPMINRES). Sign flipping of S can be turned off with PCFieldSplitSetSchurScale(). 2452ab1df9f5SJed Brown 2453147403d9SBarry Smith If A and S are solved exactly 2454147403d9SBarry Smith .vb 2455147403d9SBarry Smith *) FULL factorization is a direct solver. 2456f1580f4eSBarry 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. 2457f1580f4eSBarry 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. 2458147403d9SBarry Smith .ve 2459ab1df9f5SJed Brown 2460f1580f4eSBarry Smith If the iteration count is very low, consider using `KSPFGMRES` or `KSPGCR` which can use one less preconditioner 24610ffb0e17SBarry 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. 24620ffb0e17SBarry Smith 2463f1580f4eSBarry Smith For symmetric problems in which A is positive definite and S is negative definite, DIAG can be used with `KSPMINRES`. 24640ffb0e17SBarry Smith 2465f1580f4eSBarry 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). 2466ab1df9f5SJed Brown 2467ab1df9f5SJed Brown References: 2468606c0280SSatish Balay + * - Murphy, Golub, and Wathen, A note on preconditioning indefinite linear systems, SIAM J. Sci. Comput., 21 (2000). 2469606c0280SSatish Balay - * - Ipsen, A note on preconditioning nonsymmetric matrices, SIAM J. Sci. Comput., 23 (2001). 2470ab1df9f5SJed Brown 2471db781477SPatrick Sanan .seealso: `PCFieldSplitGetSubKSP()`, `PCFIELDSPLIT`, `PCFieldSplitSetFields()`, `PCFieldSplitSchurPreType`, `PCFieldSplitSetSchurScale()` 2472ab1df9f5SJed Brown @*/ 2473d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitSetSchurFactType(PC pc, PCFieldSplitSchurFactType ftype) 2474d71ae5a4SJacob Faibussowitsch { 2475ab1df9f5SJed Brown PetscFunctionBegin; 2476ab1df9f5SJed Brown PetscValidHeaderSpecific(pc, PC_CLASSID, 1); 2477cac4c232SBarry Smith PetscTryMethod(pc, "PCFieldSplitSetSchurFactType_C", (PC, PCFieldSplitSchurFactType), (pc, ftype)); 2478ab1df9f5SJed Brown PetscFunctionReturn(0); 2479ab1df9f5SJed Brown } 2480ab1df9f5SJed Brown 2481d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCFieldSplitSetSchurFactType_FieldSplit(PC pc, PCFieldSplitSchurFactType ftype) 2482d71ae5a4SJacob Faibussowitsch { 2483ab1df9f5SJed Brown PC_FieldSplit *jac = (PC_FieldSplit *)pc->data; 2484ab1df9f5SJed Brown 2485ab1df9f5SJed Brown PetscFunctionBegin; 2486ab1df9f5SJed Brown jac->schurfactorization = ftype; 2487ab1df9f5SJed Brown PetscFunctionReturn(0); 2488ab1df9f5SJed Brown } 2489ab1df9f5SJed Brown 2490c096484dSStefano Zampini /*@ 2491f1580f4eSBarry Smith PCFieldSplitSetSchurScale - Controls the sign flip of S for `PC_FIELDSPLIT_SCHUR_FACT_DIAG`. 2492c096484dSStefano Zampini 2493f1580f4eSBarry Smith Collective on pc 2494c096484dSStefano Zampini 2495c096484dSStefano Zampini Input Parameters: 2496c096484dSStefano Zampini + pc - the preconditioner context 2497c096484dSStefano Zampini - scale - scaling factor for the Schur complement 2498c096484dSStefano Zampini 2499f1580f4eSBarry Smith Options Database Key: 2500c096484dSStefano Zampini . -pc_fieldsplit_schur_scale - default is -1.0 2501c096484dSStefano Zampini 2502c096484dSStefano Zampini Level: intermediate 2503c096484dSStefano Zampini 2504f1580f4eSBarry Smith .seealso: `PCFIELDSPLIT`, `PCFieldSplitSetFields()`, `PCFieldSplitSchurFactType`, `PCFieldSplitSetSchurScale()`, `PCFieldSplitSetSchurFactType()` 2505c096484dSStefano Zampini @*/ 2506d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitSetSchurScale(PC pc, PetscScalar scale) 2507d71ae5a4SJacob Faibussowitsch { 2508c096484dSStefano Zampini PetscFunctionBegin; 2509c096484dSStefano Zampini PetscValidHeaderSpecific(pc, PC_CLASSID, 1); 2510c096484dSStefano Zampini PetscValidLogicalCollectiveScalar(pc, scale, 2); 2511cac4c232SBarry Smith PetscTryMethod(pc, "PCFieldSplitSetSchurScale_C", (PC, PetscScalar), (pc, scale)); 2512c096484dSStefano Zampini PetscFunctionReturn(0); 2513c096484dSStefano Zampini } 2514c096484dSStefano Zampini 2515d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCFieldSplitSetSchurScale_FieldSplit(PC pc, PetscScalar scale) 2516d71ae5a4SJacob Faibussowitsch { 2517c096484dSStefano Zampini PC_FieldSplit *jac = (PC_FieldSplit *)pc->data; 2518c096484dSStefano Zampini 2519c096484dSStefano Zampini PetscFunctionBegin; 2520c096484dSStefano Zampini jac->schurscale = scale; 2521c096484dSStefano Zampini PetscFunctionReturn(0); 2522c096484dSStefano Zampini } 2523c096484dSStefano Zampini 252430ad9308SMatthew Knepley /*@C 25258c03b21aSDmitry Karpeev PCFieldSplitGetSchurBlocks - Gets all matrix blocks for the Schur complement 252630ad9308SMatthew Knepley 2527f1580f4eSBarry Smith Collective on pc 252830ad9308SMatthew Knepley 252930ad9308SMatthew Knepley Input Parameter: 253030ad9308SMatthew Knepley . pc - the preconditioner context 253130ad9308SMatthew Knepley 253230ad9308SMatthew Knepley Output Parameters: 2533a04f6461SBarry Smith + A00 - the (0,0) block 2534a04f6461SBarry Smith . A01 - the (0,1) block 2535a04f6461SBarry Smith . A10 - the (1,0) block 2536a04f6461SBarry Smith - A11 - the (1,1) block 253730ad9308SMatthew Knepley 253830ad9308SMatthew Knepley Level: advanced 253930ad9308SMatthew Knepley 2540f1580f4eSBarry Smith .seealso: `PCFIELDSPLIT`, `MatSchurComplementGetSubMatrices()`, `MatSchurComplementSetSubMatrices()` 254130ad9308SMatthew Knepley @*/ 2542d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitGetSchurBlocks(PC pc, Mat *A00, Mat *A01, Mat *A10, Mat *A11) 2543d71ae5a4SJacob Faibussowitsch { 254430ad9308SMatthew Knepley PC_FieldSplit *jac = (PC_FieldSplit *)pc->data; 254530ad9308SMatthew Knepley 254630ad9308SMatthew Knepley PetscFunctionBegin; 25470700a824SBarry Smith PetscValidHeaderSpecific(pc, PC_CLASSID, 1); 254808401ef6SPierre Jolivet PetscCheck(jac->type == PC_COMPOSITE_SCHUR, PetscObjectComm((PetscObject)pc), PETSC_ERR_ARG_WRONG, "FieldSplit is not using a Schur complement approach."); 2549a04f6461SBarry Smith if (A00) *A00 = jac->pmat[0]; 2550a04f6461SBarry Smith if (A01) *A01 = jac->B; 2551a04f6461SBarry Smith if (A10) *A10 = jac->C; 2552a04f6461SBarry Smith if (A11) *A11 = jac->pmat[1]; 255330ad9308SMatthew Knepley PetscFunctionReturn(0); 255430ad9308SMatthew Knepley } 255530ad9308SMatthew Knepley 2556b09e027eSCarola Kruse /*@ 2557f1580f4eSBarry Smith PCFieldSplitSetGKBTol - Sets the solver tolerance for the generalized Golub-Kahan bidiagonalization preconditioner in `PCFIELDSPLIT` 2558b09e027eSCarola Kruse 2559f1580f4eSBarry Smith Collective on pc 2560e071a0a4SCarola Kruse 2561b09e027eSCarola Kruse Input Parameters: 2562b09e027eSCarola Kruse + pc - the preconditioner context 2563b09e027eSCarola Kruse - tolerance - the solver tolerance 2564b09e027eSCarola Kruse 2565f1580f4eSBarry Smith Options Database Key: 2566b09e027eSCarola Kruse . -pc_fieldsplit_gkb_tol - default is 1e-5 2567b09e027eSCarola Kruse 2568b09e027eSCarola Kruse Level: intermediate 2569b09e027eSCarola Kruse 2570f1580f4eSBarry Smith Note: 2571f1580f4eSBarry Smith The generalized GKB algorithm uses a lower bound estimate of the error in energy norm as stopping criterion. 2572f1580f4eSBarry Smith It stops once the lower bound estimate undershoots the required solver tolerance. Although the actual error might be bigger than 2573f1580f4eSBarry Smith this estimate, the stopping criterion is satisfactory in practical cases [A13]. 2574f1580f4eSBarry Smith 2575f1580f4eSBarry Smith [Ar13] Generalized Golub-Kahan bidiagonalization and stopping criteria, SIAM J. Matrix Anal. Appl., Vol. 34, No. 2, pp. 571-592, 2013. 2576f1580f4eSBarry Smith 2577db781477SPatrick Sanan .seealso: `PCFIELDSPLIT`, `PCFieldSplitSetGKBDelay()`, `PCFieldSplitSetGKBNu()`, `PCFieldSplitSetGKBMaxit()` 2578b09e027eSCarola Kruse @*/ 2579d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitSetGKBTol(PC pc, PetscReal tolerance) 2580d71ae5a4SJacob Faibussowitsch { 2581b09e027eSCarola Kruse PetscFunctionBegin; 2582b09e027eSCarola Kruse PetscValidHeaderSpecific(pc, PC_CLASSID, 1); 2583de482cd7SCarola Kruse PetscValidLogicalCollectiveReal(pc, tolerance, 2); 2584cac4c232SBarry Smith PetscTryMethod(pc, "PCFieldSplitSetGKBTol_C", (PC, PetscReal), (pc, tolerance)); 2585b09e027eSCarola Kruse PetscFunctionReturn(0); 2586b09e027eSCarola Kruse } 2587b09e027eSCarola Kruse 2588d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCFieldSplitSetGKBTol_FieldSplit(PC pc, PetscReal tolerance) 2589d71ae5a4SJacob Faibussowitsch { 2590b09e027eSCarola Kruse PC_FieldSplit *jac = (PC_FieldSplit *)pc->data; 2591b09e027eSCarola Kruse 2592b09e027eSCarola Kruse PetscFunctionBegin; 2593b09e027eSCarola Kruse jac->gkbtol = tolerance; 2594b09e027eSCarola Kruse PetscFunctionReturn(0); 2595b09e027eSCarola Kruse } 2596b09e027eSCarola Kruse 2597b09e027eSCarola Kruse /*@ 2598f1580f4eSBarry Smith PCFieldSplitSetGKBMaxit - Sets the maximum number of iterations for the generalized Golub-Kahan bidiagonalization preconditioner in `PCFIELDSPLIT` 2599b09e027eSCarola Kruse 2600f1580f4eSBarry Smith Collective on pc 2601b09e027eSCarola Kruse 2602b09e027eSCarola Kruse Input Parameters: 2603b09e027eSCarola Kruse + pc - the preconditioner context 2604b09e027eSCarola Kruse - maxit - the maximum number of iterations 2605b09e027eSCarola Kruse 2606f1580f4eSBarry Smith Options Database Key: 2607b09e027eSCarola Kruse . -pc_fieldsplit_gkb_maxit - default is 100 2608b09e027eSCarola Kruse 2609b09e027eSCarola Kruse Level: intermediate 2610b09e027eSCarola Kruse 2611db781477SPatrick Sanan .seealso: `PCFIELDSPLIT`, `PCFieldSplitSetGKBDelay()`, `PCFieldSplitSetGKBTol()`, `PCFieldSplitSetGKBNu()` 2612b09e027eSCarola Kruse @*/ 2613d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitSetGKBMaxit(PC pc, PetscInt maxit) 2614d71ae5a4SJacob Faibussowitsch { 2615b09e027eSCarola Kruse PetscFunctionBegin; 2616b09e027eSCarola Kruse PetscValidHeaderSpecific(pc, PC_CLASSID, 1); 2617de482cd7SCarola Kruse PetscValidLogicalCollectiveInt(pc, maxit, 2); 2618cac4c232SBarry Smith PetscTryMethod(pc, "PCFieldSplitSetGKBMaxit_C", (PC, PetscInt), (pc, maxit)); 2619b09e027eSCarola Kruse PetscFunctionReturn(0); 2620b09e027eSCarola Kruse } 2621b09e027eSCarola Kruse 2622d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCFieldSplitSetGKBMaxit_FieldSplit(PC pc, PetscInt maxit) 2623d71ae5a4SJacob Faibussowitsch { 2624b09e027eSCarola Kruse PC_FieldSplit *jac = (PC_FieldSplit *)pc->data; 2625b09e027eSCarola Kruse 2626b09e027eSCarola Kruse PetscFunctionBegin; 2627b09e027eSCarola Kruse jac->gkbmaxit = maxit; 2628b09e027eSCarola Kruse PetscFunctionReturn(0); 2629b09e027eSCarola Kruse } 2630b09e027eSCarola Kruse 2631b09e027eSCarola Kruse /*@ 2632f1580f4eSBarry Smith PCFieldSplitSetGKBDelay - Sets the delay in the lower bound error estimate in the generalized Golub-Kahan bidiagonalization in `PCFIELDSPLIT` 2633e071a0a4SCarola Kruse preconditioner. 2634b09e027eSCarola Kruse 2635f1580f4eSBarry Smith Collective on pc 2636b09e027eSCarola Kruse 2637b09e027eSCarola Kruse Input Parameters: 2638b09e027eSCarola Kruse + pc - the preconditioner context 2639b09e027eSCarola Kruse - delay - the delay window in the lower bound estimate 2640b09e027eSCarola Kruse 2641f1580f4eSBarry Smith Options Database Key: 2642b09e027eSCarola Kruse . -pc_fieldsplit_gkb_delay - default is 5 2643b09e027eSCarola Kruse 2644b09e027eSCarola Kruse Level: intermediate 2645b09e027eSCarola Kruse 2646f1580f4eSBarry Smith Note: 2647f1580f4eSBarry 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 2648f1580f4eSBarry 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 2649f1580f4eSBarry 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 2650f1580f4eSBarry Smith 2651f1580f4eSBarry Smith [Ar13] Generalized Golub-Kahan bidiagonalization and stopping criteria, SIAM J. Matrix Anal. Appl., Vol. 34, No. 2, pp. 571-592, 2013. 2652f1580f4eSBarry Smith 2653db781477SPatrick Sanan .seealso: `PCFIELDSPLIT`, `PCFieldSplitSetGKBNu()`, `PCFieldSplitSetGKBTol()`, `PCFieldSplitSetGKBMaxit()` 2654b09e027eSCarola Kruse @*/ 2655d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitSetGKBDelay(PC pc, PetscInt delay) 2656d71ae5a4SJacob Faibussowitsch { 2657b09e027eSCarola Kruse PetscFunctionBegin; 2658b09e027eSCarola Kruse PetscValidHeaderSpecific(pc, PC_CLASSID, 1); 2659b09e027eSCarola Kruse PetscValidLogicalCollectiveInt(pc, delay, 2); 2660cac4c232SBarry Smith PetscTryMethod(pc, "PCFieldSplitSetGKBDelay_C", (PC, PetscInt), (pc, delay)); 2661b09e027eSCarola Kruse PetscFunctionReturn(0); 2662b09e027eSCarola Kruse } 2663b09e027eSCarola Kruse 2664d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCFieldSplitSetGKBDelay_FieldSplit(PC pc, PetscInt delay) 2665d71ae5a4SJacob Faibussowitsch { 2666b09e027eSCarola Kruse PC_FieldSplit *jac = (PC_FieldSplit *)pc->data; 2667b09e027eSCarola Kruse 2668b09e027eSCarola Kruse PetscFunctionBegin; 2669b09e027eSCarola Kruse jac->gkbdelay = delay; 2670b09e027eSCarola Kruse PetscFunctionReturn(0); 2671b09e027eSCarola Kruse } 2672b09e027eSCarola Kruse 2673b09e027eSCarola Kruse /*@ 2674f1580f4eSBarry 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 2675f1580f4eSBarry Smith in `PCFIELDSPLIT` 2676b09e027eSCarola Kruse 2677f1580f4eSBarry Smith Collective on pc 2678f1580f4eSBarry Smith 2679f1580f4eSBarry Smith Input Parameters: 2680f1580f4eSBarry Smith + pc - the preconditioner context 2681f1580f4eSBarry Smith - nu - the shift parameter 2682f1580f4eSBarry Smith 2683f1580f4eSBarry Smith Options Database Keys: 2684f1580f4eSBarry Smith . -pc_fieldsplit_gkb_nu - default is 1 2685f1580f4eSBarry Smith 2686f1580f4eSBarry Smith Level: intermediate 2687b09e027eSCarola Kruse 2688b09e027eSCarola Kruse Notes: 2689e071a0a4SCarola Kruse This shift is in general done to obtain better convergence properties for the outer loop of the algorithm. This is often achieved by chosing nu sufficiently big. However, 2690b09e027eSCarola Kruse if nu is chosen too big, the matrix H might be badly conditioned and the solution of the linear system Hx = b in the inner loop gets difficult. It is therefore 2691b09e027eSCarola Kruse necessary to find a good balance in between the convergence of the inner and outer loop. 2692b09e027eSCarola Kruse 2693b09e027eSCarola 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. 2694b09e027eSCarola Kruse 2695b09e027eSCarola Kruse [Ar13] Generalized Golub-Kahan bidiagonalization and stopping criteria, SIAM J. Matrix Anal. Appl., Vol. 34, No. 2, pp. 571-592, 2013. 2696b09e027eSCarola Kruse 2697db781477SPatrick Sanan .seealso: `PCFIELDSPLIT`, `PCFieldSplitSetGKBDelay()`, `PCFieldSplitSetGKBTol()`, `PCFieldSplitSetGKBMaxit()` 2698b09e027eSCarola Kruse @*/ 2699d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitSetGKBNu(PC pc, PetscReal nu) 2700d71ae5a4SJacob Faibussowitsch { 2701b09e027eSCarola Kruse PetscFunctionBegin; 2702b09e027eSCarola Kruse PetscValidHeaderSpecific(pc, PC_CLASSID, 1); 2703de482cd7SCarola Kruse PetscValidLogicalCollectiveReal(pc, nu, 2); 2704cac4c232SBarry Smith PetscTryMethod(pc, "PCFieldSplitSetGKBNu_C", (PC, PetscReal), (pc, nu)); 2705b09e027eSCarola Kruse PetscFunctionReturn(0); 2706b09e027eSCarola Kruse } 2707b09e027eSCarola Kruse 2708d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCFieldSplitSetGKBNu_FieldSplit(PC pc, PetscReal nu) 2709d71ae5a4SJacob Faibussowitsch { 2710b09e027eSCarola Kruse PC_FieldSplit *jac = (PC_FieldSplit *)pc->data; 2711b09e027eSCarola Kruse 2712b09e027eSCarola Kruse PetscFunctionBegin; 2713b09e027eSCarola Kruse jac->gkbnu = nu; 2714b09e027eSCarola Kruse PetscFunctionReturn(0); 2715b09e027eSCarola Kruse } 2716b09e027eSCarola Kruse 2717d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCFieldSplitSetType_FieldSplit(PC pc, PCCompositeType type) 2718d71ae5a4SJacob Faibussowitsch { 271979416396SBarry Smith PC_FieldSplit *jac = (PC_FieldSplit *)pc->data; 272079416396SBarry Smith 272179416396SBarry Smith PetscFunctionBegin; 272279416396SBarry Smith jac->type = type; 27232e956fe4SStefano Zampini PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitGetSubKSP_C", NULL)); 27242e956fe4SStefano Zampini PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetSchurPre_C", NULL)); 27252e956fe4SStefano Zampini PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitGetSchurPre_C", NULL)); 27262e956fe4SStefano Zampini PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetSchurFactType_C", NULL)); 27272e956fe4SStefano Zampini PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetSchurScale_C", NULL)); 27282e956fe4SStefano Zampini PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetGKBTol_C", NULL)); 27292e956fe4SStefano Zampini PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetGKBMaxit_C", NULL)); 27302e956fe4SStefano Zampini PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetGKBNu_C", NULL)); 27312e956fe4SStefano Zampini PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetGKBDelay_C", NULL)); 2732e071a0a4SCarola Kruse 27333b224e63SBarry Smith if (type == PC_COMPOSITE_SCHUR) { 27343b224e63SBarry Smith pc->ops->apply = PCApply_FieldSplit_Schur; 27353b224e63SBarry Smith pc->ops->view = PCView_FieldSplit_Schur; 27362fa5cd67SKarl Rupp 27379566063dSJacob Faibussowitsch PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitGetSubKSP_C", PCFieldSplitGetSubKSP_FieldSplit_Schur)); 27389566063dSJacob Faibussowitsch PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetSchurPre_C", PCFieldSplitSetSchurPre_FieldSplit)); 27399566063dSJacob Faibussowitsch PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitGetSchurPre_C", PCFieldSplitGetSchurPre_FieldSplit)); 27409566063dSJacob Faibussowitsch PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetSchurFactType_C", PCFieldSplitSetSchurFactType_FieldSplit)); 27419566063dSJacob Faibussowitsch PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetSchurScale_C", PCFieldSplitSetSchurScale_FieldSplit)); 2742a51937d4SCarola Kruse } else if (type == PC_COMPOSITE_GKB) { 2743a51937d4SCarola Kruse pc->ops->apply = PCApply_FieldSplit_GKB; 2744a51937d4SCarola Kruse pc->ops->view = PCView_FieldSplit_GKB; 2745e69d4d44SBarry Smith 27469566063dSJacob Faibussowitsch PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitGetSubKSP_C", PCFieldSplitGetSubKSP_FieldSplit)); 27479566063dSJacob Faibussowitsch PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetGKBTol_C", PCFieldSplitSetGKBTol_FieldSplit)); 27489566063dSJacob Faibussowitsch PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetGKBMaxit_C", PCFieldSplitSetGKBMaxit_FieldSplit)); 27499566063dSJacob Faibussowitsch PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetGKBNu_C", PCFieldSplitSetGKBNu_FieldSplit)); 27509566063dSJacob Faibussowitsch PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetGKBDelay_C", PCFieldSplitSetGKBDelay_FieldSplit)); 27513b224e63SBarry Smith } else { 27523b224e63SBarry Smith pc->ops->apply = PCApply_FieldSplit; 27533b224e63SBarry Smith pc->ops->view = PCView_FieldSplit; 27542fa5cd67SKarl Rupp 27559566063dSJacob Faibussowitsch PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitGetSubKSP_C", PCFieldSplitGetSubKSP_FieldSplit)); 27563b224e63SBarry Smith } 275779416396SBarry Smith PetscFunctionReturn(0); 275879416396SBarry Smith } 275979416396SBarry Smith 2760d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCFieldSplitSetBlockSize_FieldSplit(PC pc, PetscInt bs) 2761d71ae5a4SJacob Faibussowitsch { 276251f519a2SBarry Smith PC_FieldSplit *jac = (PC_FieldSplit *)pc->data; 276351f519a2SBarry Smith 276451f519a2SBarry Smith PetscFunctionBegin; 276563a3b9bcSJacob Faibussowitsch PetscCheck(bs >= 1, PetscObjectComm((PetscObject)pc), PETSC_ERR_ARG_OUTOFRANGE, "Blocksize must be positive, you gave %" PetscInt_FMT, bs); 27662472a847SBarry 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); 276751f519a2SBarry Smith jac->bs = bs; 276851f519a2SBarry Smith PetscFunctionReturn(0); 276951f519a2SBarry Smith } 277051f519a2SBarry Smith 2771d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCSetCoordinates_FieldSplit(PC pc, PetscInt dim, PetscInt nloc, PetscReal coords[]) 2772d71ae5a4SJacob Faibussowitsch { 27735ddf11f8SNicolas Barnafi PC_FieldSplit *jac = (PC_FieldSplit *)pc->data; 27745ddf11f8SNicolas Barnafi PC_FieldSplitLink ilink_current = jac->head; 27755ddf11f8SNicolas Barnafi IS is_owned; 27765ddf11f8SNicolas Barnafi 27775ddf11f8SNicolas Barnafi PetscFunctionBegin; 27785ddf11f8SNicolas Barnafi jac->coordinates_set = PETSC_TRUE; // Internal flag 27799566063dSJacob Faibussowitsch PetscCall(MatGetOwnershipIS(pc->mat, &is_owned, PETSC_NULL)); 27805ddf11f8SNicolas Barnafi 27815ddf11f8SNicolas Barnafi while (ilink_current) { 27825ddf11f8SNicolas Barnafi // For each IS, embed it to get local coords indces 27835ddf11f8SNicolas Barnafi IS is_coords; 27845ddf11f8SNicolas Barnafi PetscInt ndofs_block; 27855ddf11f8SNicolas Barnafi const PetscInt *block_dofs_enumeration; // Numbering of the dofs relevant to the current block 27865ddf11f8SNicolas Barnafi 27875ddf11f8SNicolas Barnafi // Setting drop to true for safety. It should make no difference. 27889566063dSJacob Faibussowitsch PetscCall(ISEmbed(ilink_current->is, is_owned, PETSC_TRUE, &is_coords)); 27899566063dSJacob Faibussowitsch PetscCall(ISGetLocalSize(is_coords, &ndofs_block)); 27909566063dSJacob Faibussowitsch PetscCall(ISGetIndices(is_coords, &block_dofs_enumeration)); 27915ddf11f8SNicolas Barnafi 27925ddf11f8SNicolas Barnafi // Allocate coordinates vector and set it directly 27939566063dSJacob Faibussowitsch PetscCall(PetscMalloc1(ndofs_block * dim, &(ilink_current->coords))); 27945ddf11f8SNicolas Barnafi for (PetscInt dof = 0; dof < ndofs_block; ++dof) { 2795ad540459SPierre Jolivet for (PetscInt d = 0; d < dim; ++d) (ilink_current->coords)[dim * dof + d] = coords[dim * block_dofs_enumeration[dof] + d]; 27965ddf11f8SNicolas Barnafi } 27975ddf11f8SNicolas Barnafi ilink_current->dim = dim; 27985ddf11f8SNicolas Barnafi ilink_current->ndofs = ndofs_block; 27999566063dSJacob Faibussowitsch PetscCall(ISRestoreIndices(is_coords, &block_dofs_enumeration)); 28009566063dSJacob Faibussowitsch PetscCall(ISDestroy(&is_coords)); 28015ddf11f8SNicolas Barnafi ilink_current = ilink_current->next; 28025ddf11f8SNicolas Barnafi } 28039566063dSJacob Faibussowitsch PetscCall(ISDestroy(&is_owned)); 28045ddf11f8SNicolas Barnafi PetscFunctionReturn(0); 28055ddf11f8SNicolas Barnafi } 28065ddf11f8SNicolas Barnafi 2807bc08b0f1SBarry Smith /*@ 2808f1580f4eSBarry Smith PCFieldSplitSetType - Sets the type, `PCCompositeType`, of a `PCFIELDSPLIT` 280979416396SBarry Smith 2810f1580f4eSBarry Smith Collective on pc 281179416396SBarry Smith 2812d8d19677SJose E. Roman Input Parameters: 2813a2b725a8SWilliam Gropp + pc - the preconditioner context 2814f1580f4eSBarry Smith - type - `PC_COMPOSITE_ADDITIVE`, `PC_COMPOSITE_MULTIPLICATIVE` (default), `PC_COMPOSITE_SYMMETRIC_MULTIPLICATIVE`, `PC_COMPOSITE_SPECIAL`, `PC_COMPOSITE_SCHUR` 281579416396SBarry Smith 281679416396SBarry Smith Options Database Key: 2817a4efd8eaSMatthew Knepley . -pc_fieldsplit_type <type: one of multiplicative, additive, symmetric_multiplicative, special, schur> - Sets fieldsplit preconditioner type 281879416396SBarry Smith 2819b02e2d75SMatthew G Knepley Level: Intermediate 282079416396SBarry Smith 2821f1580f4eSBarry Smith .seealso: `PCFIELDSPLIT`, `PCCompositeType`, `PCCompositeGetType()`, `PC_COMPOSITE_ADDITIVE`, `PC_COMPOSITE_MULTIPLICATIVE`, 2822f1580f4eSBarry Smith `PC_COMPOSITE_SYMMETRIC_MULTIPLICATIVE`, `PC_COMPOSITE_SPECIAL`, `PC_COMPOSITE_SCHUR` 282379416396SBarry Smith @*/ 2824d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitSetType(PC pc, PCCompositeType type) 2825d71ae5a4SJacob Faibussowitsch { 282679416396SBarry Smith PetscFunctionBegin; 28270700a824SBarry Smith PetscValidHeaderSpecific(pc, PC_CLASSID, 1); 2828cac4c232SBarry Smith PetscTryMethod(pc, "PCFieldSplitSetType_C", (PC, PCCompositeType), (pc, type)); 282979416396SBarry Smith PetscFunctionReturn(0); 283079416396SBarry Smith } 283179416396SBarry Smith 2832b02e2d75SMatthew G Knepley /*@ 2833f1580f4eSBarry Smith PCFieldSplitGetType - Gets the type, `PCCompositeType`, of a `PCFIELDSPLIT` 2834b02e2d75SMatthew G Knepley 2835b02e2d75SMatthew G Knepley Not collective 2836b02e2d75SMatthew G Knepley 2837b02e2d75SMatthew G Knepley Input Parameter: 2838b02e2d75SMatthew G Knepley . pc - the preconditioner context 2839b02e2d75SMatthew G Knepley 2840b02e2d75SMatthew G Knepley Output Parameter: 2841f1580f4eSBarry Smith . type - `PC_COMPOSITE_ADDITIVE`, `PC_COMPOSITE_MULTIPLICATIVE` (default), `PC_COMPOSITE_SYMMETRIC_MULTIPLICATIVE`, `PC_COMPOSITE_SPECIAL`, `PC_COMPOSITE_SCHUR` 2842b02e2d75SMatthew G Knepley 2843b02e2d75SMatthew G Knepley Level: Intermediate 2844b02e2d75SMatthew G Knepley 2845f1580f4eSBarry Smith .seealso: `PCCompositeSetType()`, `PCFIELDSPLIT`, `PCCompositeType`, `PC_COMPOSITE_ADDITIVE`, `PC_COMPOSITE_MULTIPLICATIVE`, 2846f1580f4eSBarry Smith `PC_COMPOSITE_SYMMETRIC_MULTIPLICATIVE`, `PC_COMPOSITE_SPECIAL`, `PC_COMPOSITE_SCHUR` 2847b02e2d75SMatthew G Knepley @*/ 2848d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitGetType(PC pc, PCCompositeType *type) 2849d71ae5a4SJacob Faibussowitsch { 2850b02e2d75SMatthew G Knepley PC_FieldSplit *jac = (PC_FieldSplit *)pc->data; 2851b02e2d75SMatthew G Knepley 2852b02e2d75SMatthew G Knepley PetscFunctionBegin; 2853b02e2d75SMatthew G Knepley PetscValidHeaderSpecific(pc, PC_CLASSID, 1); 2854b02e2d75SMatthew G Knepley PetscValidIntPointer(type, 2); 2855b02e2d75SMatthew G Knepley *type = jac->type; 2856b02e2d75SMatthew G Knepley PetscFunctionReturn(0); 2857b02e2d75SMatthew G Knepley } 2858b02e2d75SMatthew G Knepley 28594ab8060aSDmitry Karpeev /*@ 2860f1580f4eSBarry Smith PCFieldSplitSetDMSplits - Flags whether `DMCreateFieldDecomposition()` should be used to define the splits in a `PCFIELDSPLIT`, whenever possible. 28614ab8060aSDmitry Karpeev 2862f1580f4eSBarry Smith Logically Collective on pc 28634ab8060aSDmitry Karpeev 28644ab8060aSDmitry Karpeev Input Parameters: 28654ab8060aSDmitry Karpeev + pc - the preconditioner context 2866f1580f4eSBarry Smith - flg - boolean indicating whether to use field splits defined by the `DM` 28674ab8060aSDmitry Karpeev 28684ab8060aSDmitry Karpeev Options Database Key: 2869f1580f4eSBarry Smith . -pc_fieldsplit_dm_splits <bool> - use the field splits defined by the `DM` 28704ab8060aSDmitry Karpeev 28714ab8060aSDmitry Karpeev Level: Intermediate 28724ab8060aSDmitry Karpeev 2873f1580f4eSBarry Smith .seealso: `PCFIELDSPLIT`, `PCFieldSplitGetDMSplits()`, `PCFieldSplitSetFields()`, `PCFieldsplitSetIS()` 28744ab8060aSDmitry Karpeev @*/ 2875d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitSetDMSplits(PC pc, PetscBool flg) 2876d71ae5a4SJacob Faibussowitsch { 28774ab8060aSDmitry Karpeev PC_FieldSplit *jac = (PC_FieldSplit *)pc->data; 28784ab8060aSDmitry Karpeev PetscBool isfs; 28794ab8060aSDmitry Karpeev 28804ab8060aSDmitry Karpeev PetscFunctionBegin; 28814ab8060aSDmitry Karpeev PetscValidHeaderSpecific(pc, PC_CLASSID, 1); 28824ab8060aSDmitry Karpeev PetscValidLogicalCollectiveBool(pc, flg, 2); 28839566063dSJacob Faibussowitsch PetscCall(PetscObjectTypeCompare((PetscObject)pc, PCFIELDSPLIT, &isfs)); 2884ad540459SPierre Jolivet if (isfs) jac->dm_splits = flg; 28854ab8060aSDmitry Karpeev PetscFunctionReturn(0); 28864ab8060aSDmitry Karpeev } 28874ab8060aSDmitry Karpeev 28884ab8060aSDmitry Karpeev /*@ 2889f1580f4eSBarry Smith PCFieldSplitGetDMSplits - Returns flag indicating whether `DMCreateFieldDecomposition()` should be used to define the splits in a `PCFIELDSPLIT`, whenever possible. 28904ab8060aSDmitry Karpeev 28914ab8060aSDmitry Karpeev Logically Collective 28924ab8060aSDmitry Karpeev 28934ab8060aSDmitry Karpeev Input Parameter: 28944ab8060aSDmitry Karpeev . pc - the preconditioner context 28954ab8060aSDmitry Karpeev 28964ab8060aSDmitry Karpeev Output Parameter: 2897f1580f4eSBarry Smith . flg - boolean indicating whether to use field splits defined by the `DM` 28984ab8060aSDmitry Karpeev 28994ab8060aSDmitry Karpeev Level: Intermediate 29004ab8060aSDmitry Karpeev 2901f1580f4eSBarry Smith .seealso: `PCFIELDSPLIT`, `PCFieldSplitSetDMSplits()`, `PCFieldSplitSetFields()`, `PCFieldsplitSetIS()` 29024ab8060aSDmitry Karpeev @*/ 2903d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitGetDMSplits(PC pc, PetscBool *flg) 2904d71ae5a4SJacob Faibussowitsch { 29054ab8060aSDmitry Karpeev PC_FieldSplit *jac = (PC_FieldSplit *)pc->data; 29064ab8060aSDmitry Karpeev PetscBool isfs; 29074ab8060aSDmitry Karpeev 29084ab8060aSDmitry Karpeev PetscFunctionBegin; 29094ab8060aSDmitry Karpeev PetscValidHeaderSpecific(pc, PC_CLASSID, 1); 2910534a8f05SLisandro Dalcin PetscValidBoolPointer(flg, 2); 29119566063dSJacob Faibussowitsch PetscCall(PetscObjectTypeCompare((PetscObject)pc, PCFIELDSPLIT, &isfs)); 29124ab8060aSDmitry Karpeev if (isfs) { 29134ab8060aSDmitry Karpeev if (flg) *flg = jac->dm_splits; 29144ab8060aSDmitry Karpeev } 29154ab8060aSDmitry Karpeev PetscFunctionReturn(0); 29164ab8060aSDmitry Karpeev } 29174ab8060aSDmitry Karpeev 29187b752e3dSPatrick Sanan /*@ 2919f1580f4eSBarry Smith PCFieldSplitGetDetectSaddlePoint - Returns flag indicating whether `PCFIELDSPLIT` will attempt to automatically determine fields based on zero diagonal entries. 29207b752e3dSPatrick Sanan 29217b752e3dSPatrick Sanan Logically Collective 29227b752e3dSPatrick Sanan 29237b752e3dSPatrick Sanan Input Parameter: 29247b752e3dSPatrick Sanan . pc - the preconditioner context 29257b752e3dSPatrick Sanan 29267b752e3dSPatrick Sanan Output Parameter: 29277b752e3dSPatrick Sanan . flg - boolean indicating whether to detect fields or not 29287b752e3dSPatrick Sanan 29297b752e3dSPatrick Sanan Level: Intermediate 29307b752e3dSPatrick Sanan 2931db781477SPatrick Sanan .seealso: `PCFIELDSPLIT`, `PCFieldSplitSetDetectSaddlePoint()` 29327b752e3dSPatrick Sanan @*/ 2933d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitGetDetectSaddlePoint(PC pc, PetscBool *flg) 2934d71ae5a4SJacob Faibussowitsch { 29357b752e3dSPatrick Sanan PC_FieldSplit *jac = (PC_FieldSplit *)pc->data; 29367b752e3dSPatrick Sanan 29377b752e3dSPatrick Sanan PetscFunctionBegin; 29387b752e3dSPatrick Sanan *flg = jac->detect; 29397b752e3dSPatrick Sanan PetscFunctionReturn(0); 29407b752e3dSPatrick Sanan } 29417b752e3dSPatrick Sanan 29427b752e3dSPatrick Sanan /*@ 2943f1580f4eSBarry Smith PCFieldSplitSetDetectSaddlePoint - Sets flag indicating whether `PCFIELDSPLIT` will attempt to automatically determine fields based on zero diagonal entries. 29447b752e3dSPatrick Sanan 29457b752e3dSPatrick Sanan Logically Collective 29467b752e3dSPatrick Sanan 29477b752e3dSPatrick Sanan Input Parameter: 29487b752e3dSPatrick Sanan . pc - the preconditioner context 29497b752e3dSPatrick Sanan 29507b752e3dSPatrick Sanan Output Parameter: 29517b752e3dSPatrick Sanan . flg - boolean indicating whether to detect fields or not 29527b752e3dSPatrick Sanan 29537b752e3dSPatrick Sanan Options Database Key: 2954147403d9SBarry Smith . -pc_fieldsplit_detect_saddle_point <bool> - detect and use the saddle point 2955147403d9SBarry Smith 2956f1580f4eSBarry Smith Note: 2957f1580f4eSBarry 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()`). 29587b752e3dSPatrick Sanan 29597b752e3dSPatrick Sanan Level: Intermediate 29607b752e3dSPatrick Sanan 2961f1580f4eSBarry Smith .seealso: `PCFIELDSPLIT`, `PCFieldSplitGetDetectSaddlePoint()`, `PCFieldSplitSetType()`, `PCFieldSplitSetSchurPre()`, `PC_FIELDSPLIT_SCHUR_PRE_SELF` 29627b752e3dSPatrick Sanan @*/ 2963d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitSetDetectSaddlePoint(PC pc, PetscBool flg) 2964d71ae5a4SJacob Faibussowitsch { 29657b752e3dSPatrick Sanan PC_FieldSplit *jac = (PC_FieldSplit *)pc->data; 29667b752e3dSPatrick Sanan 29677b752e3dSPatrick Sanan PetscFunctionBegin; 29687b752e3dSPatrick Sanan jac->detect = flg; 29697b752e3dSPatrick Sanan if (jac->detect) { 29709566063dSJacob Faibussowitsch PetscCall(PCFieldSplitSetType(pc, PC_COMPOSITE_SCHUR)); 29719566063dSJacob Faibussowitsch PetscCall(PCFieldSplitSetSchurPre(pc, PC_FIELDSPLIT_SCHUR_PRE_SELF, NULL)); 29727b752e3dSPatrick Sanan } 29737b752e3dSPatrick Sanan PetscFunctionReturn(0); 29747b752e3dSPatrick Sanan } 29757b752e3dSPatrick Sanan 29760971522cSBarry Smith /*MC 2977a8c7a070SBarry Smith PCFIELDSPLIT - Preconditioner created by combining separate preconditioners for individual 2978f1580f4eSBarry Smith collections of variables (that may overlap) called splits. See [the users manual section on "Solving Block Matrices"](sec_block_matrices) for more details. 29790971522cSBarry Smith 2980f1580f4eSBarry Smith To set options on the solvers for each block append `-fieldsplit_` to all the `PC` 2981de37d9f1SPatrick Sanan options database keys. For example, `-fieldsplit_pc_type ilu -fieldsplit_pc_factor_levels 1` 29820971522cSBarry Smith 2983de37d9f1SPatrick Sanan To set the options on the solvers separate for each block call `PCFieldSplitGetSubKSP()` 2984de37d9f1SPatrick Sanan and set the options directly on the resulting `KSP` object 29850971522cSBarry Smith 29860971522cSBarry Smith Level: intermediate 29870971522cSBarry Smith 298879416396SBarry Smith Options Database Keys: 2989de37d9f1SPatrick Sanan + -pc_fieldsplit_%d_fields <a,b,..> - indicates the fields to be used in the `%d`'th split 299081540f2fSBarry Smith . -pc_fieldsplit_default - automatically add any fields to additional splits that have not 2991de37d9f1SPatrick Sanan been supplied explicitly by `-pc_fieldsplit_%d_fields` 299281540f2fSBarry Smith . -pc_fieldsplit_block_size <bs> - size of block that defines fields (i.e. there are bs fields) 2993a51937d4SCarola Kruse . -pc_fieldsplit_type <additive,multiplicative,symmetric_multiplicative,schur,gkb> - type of relaxation or factorization splitting 2994de37d9f1SPatrick Sanan . -pc_fieldsplit_schur_precondition <self,selfp,user,a11,full> - default is a11; see `PCFieldSplitSetSchurPre()` 2995de37d9f1SPatrick Sanan . -pc_fieldsplit_schur_fact_type <diag,lower,upper,full> - set factorization type when using `-pc_fieldsplit_type schur`; see `PCFieldSplitSetSchurFactType()` 2996fb6809a2SPatrick Sanan - -pc_fieldsplit_detect_saddle_point - automatically finds rows with zero diagonal and uses Schur complement with no preconditioner as the solver 299779416396SBarry Smith 2998de37d9f1SPatrick Sanan Options prefixes for inner solvers when using the Schur complement preconditioner are `-fieldsplit_0_` and `-fieldsplit_1_` . 2999de37d9f1SPatrick Sanan For all other solvers they are `-fieldsplit_%d_` for the `d`th field; use `-fieldsplit_` for all fields. 3000de37d9f1SPatrick Sanan The options prefix for the inner solver when using the Golub-Kahan biadiagonalization preconditioner is `-fieldsplit_0_` 30015d4c12cdSJungho Lee 3002c8a0d604SMatthew G Knepley Notes: 3003f1580f4eSBarry Smith Use `PCFieldSplitSetFields()` to set splits defined by "strided" entries and `PCFieldSplitSetIS()` 3004f1580f4eSBarry Smith to define a split by an arbitrary collection of entries. 3005d32f9abdSBarry Smith 3006f1580f4eSBarry Smith If no splits are set the default is used. The splits are defined by entries strided by bs, 3007de37d9f1SPatrick Sanan beginning at 0 then 1, etc to bs-1. The block size can be set with `PCFieldSplitSetBlockSize()`, 3008d32f9abdSBarry Smith if this is not called the block size defaults to the blocksize of the second matrix passed 3009de37d9f1SPatrick Sanan to `KSPSetOperators()`/`PCSetOperators()`. 3010d32f9abdSBarry Smith 3011de37d9f1SPatrick Sanan For the Schur complement preconditioner if 30121d71051fSDmitry Karpeev 3013de37d9f1SPatrick Sanan ```{math} 3014de37d9f1SPatrick Sanan J = \left[\begin{array}{cc} A_{00} & A_{01} \\ A_{10} & A_{11} \end{array}\right] 3015de37d9f1SPatrick Sanan ``` 3016e69d4d44SBarry Smith 3017de37d9f1SPatrick Sanan the preconditioner using `full` factorization is logically 3018de37d9f1SPatrick Sanan ```{math} 3019de37d9f1SPatrick 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] 3020de37d9f1SPatrick Sanan ``` 3021de37d9f1SPatrick Sanan where the action of $\text{inv}(A_{00})$ is applied using the KSP solver with prefix `-fieldsplit_0_`. $S$ is the Schur complement 3022de37d9f1SPatrick Sanan ```{math} 3023223e5b4fSPatrick Sanan S = A_{11} - A_{10} \text{ksp}(A_{00}) A_{01} 3024de37d9f1SPatrick Sanan ``` 3025de37d9f1SPatrick 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 3026de37d9f1SPatrick Sanan in providing the SECOND split or 1 if not given). For `PCFieldSplitGetSub\text{ksp}()` when field number is 0, 3027de37d9f1SPatrick Sanan it returns the KSP associated with `-fieldsplit_0_` while field number 1 gives `-fieldsplit_1_` KSP. By default 3028de37d9f1SPatrick Sanan $A_{11}$ is used to construct a preconditioner for $S$, use `PCFieldSplitSetSchurPre()` for all the possible ways to construct the preconditioner for $S$. 3029de37d9f1SPatrick Sanan 3030de37d9f1SPatrick Sanan The factorization type is set using `-pc_fieldsplit_schur_fact_type <diag, lower, upper, full>`. `full` is shown above, 3031de37d9f1SPatrick Sanan `diag` gives 3032de37d9f1SPatrick Sanan ```{math} 3033de37d9f1SPatrick Sanan \left[\begin{array}{cc} \text{inv}(A_{00}) & 0 \\ 0 & -\text{ksp}(S) \end{array}\right] 3034de37d9f1SPatrick Sanan ``` 3035de37d9f1SPatrick 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 3036de37d9f1SPatrick Sanan can be turned off with `PCFieldSplitSetSchurScale()` or by command line `-pc_fieldsplit_schur_scale 1.0`. The `lower` factorization is the inverse of 3037de37d9f1SPatrick Sanan ```{math} 3038de37d9f1SPatrick Sanan \left[\begin{array}{cc} A_{00} & 0 \\ A_{10} & S \end{array}\right] 3039de37d9f1SPatrick Sanan ``` 3040de37d9f1SPatrick Sanan where the inverses of A_{00} and S are applied using KSPs. The upper factorization is the inverse of 3041de37d9f1SPatrick Sanan ```{math} 3042de37d9f1SPatrick Sanan \left[\begin{array}{cc} A_{00} & A_{01} \\ 0 & S \end{array}\right] 3043de37d9f1SPatrick Sanan ``` 3044de37d9f1SPatrick Sanan where again the inverses of $A_{00}$ and $S$ are applied using `KSP`s. 3045de37d9f1SPatrick Sanan 3046de37d9f1SPatrick Sanan If only one set of indices (one `IS`) is provided with `PCFieldSplitSetIS()` then the complement of that `IS` 3047edf189efSBarry Smith is used automatically for a second block. 3048edf189efSBarry Smith 3049f1580f4eSBarry Smith The fieldsplit preconditioner cannot currently be used with the `MATBAIJ` or `MATSBAIJ` data formats if the blocksize is larger than 1. 3050f1580f4eSBarry Smith Generally it should be used with the `MATAIJ` format. 3051ff218e97SBarry Smith 3052ff218e97SBarry Smith The forms of these preconditioners are closely related if not identical to forms derived as "Distributive Iterations", see, 3053f1580f4eSBarry Smith for example, page 294 in "Principles of Computational Fluid Dynamics" by Pieter Wesseling {cite}`Wesseling2009`. 3054f1580f4eSBarry Smith One can also use `PCFIELDSPLIT` 3055ff218e97SBarry Smith inside a smoother resulting in "Distributive Smoothers". 30560716a85fSBarry Smith 3057de37d9f1SPatrick Sanan See "A taxonomy and comparison of parallel block multi-level preconditioners for the incompressible Navier-Stokes equations" {cite}`elman2008tcp`. 3058a6a584a2SBarry Smith 3059de37d9f1SPatrick Sanan The Constrained Pressure Preconditioner (CPR) can be implemented using `PCCOMPOSITE` with `PCGALERKIN`. CPR first solves an $R A P$ subsystem, updates the 3060de37d9f1SPatrick Sanan residual on all variables (`PCCompositeSetType(pc,PC_COMPOSITE_MULTIPLICATIVE)`), and then applies a simple ILU like preconditioner on all the variables. 3061a51937d4SCarola Kruse 3062de37d9f1SPatrick Sanan The generalized Golub-Kahan bidiagonalization preconditioner (GKB) can be applied to symmetric $2 \times 2$ block matrices of the shape 3063de37d9f1SPatrick Sanan ```{math} 3064de37d9f1SPatrick Sanan \left[\begin{array}{cc} A_{00} & A_{01} \\ A_{01}' & 0 \end{array}\right] 3065de37d9f1SPatrick Sanan ``` 3066de37d9f1SPatrick 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}'$. 3067de37d9f1SPatrick 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_`. 3068a51937d4SCarola Kruse 3069f1580f4eSBarry Smith References: 3070f1580f4eSBarry Smith 3071de37d9f1SPatrick Sanan ```{bibliography} 3072de37d9f1SPatrick Sanan :filter: docname in docnames 3073de37d9f1SPatrick Sanan ``` 3074de37d9f1SPatrick Sanan 3075f1580f4eSBarry Smith Developer Note: 3076f1580f4eSBarry Smith The Schur complement functionality of `PCFIELDSPLIT` should likely be factored into its own `PC` thus simplify the implementation of the preconditioners and their 3077f1580f4eSBarry Smith user API. 3078f1580f4eSBarry Smith 3079db781477SPatrick Sanan .seealso: `PCCreate()`, `PCSetType()`, `PCType`, `PC`, `PCLSC`, 3080db781477SPatrick Sanan `PCFieldSplitGetSubKSP()`, `PCFieldSplitSchurGetSubKSP()`, `PCFieldSplitSetFields()`, 3081db781477SPatrick Sanan `PCFieldSplitSetType()`, `PCFieldSplitSetIS()`, `PCFieldSplitSetSchurPre()`, `PCFieldSplitSetSchurFactType()`, 3082db781477SPatrick Sanan `MatSchurComplementSetAinvType()`, `PCFieldSplitSetSchurScale()`, `PCFieldSplitSetDetectSaddlePoint()` 30830971522cSBarry Smith M*/ 30840971522cSBarry Smith 3085d71ae5a4SJacob Faibussowitsch PETSC_EXTERN PetscErrorCode PCCreate_FieldSplit(PC pc) 3086d71ae5a4SJacob Faibussowitsch { 30870971522cSBarry Smith PC_FieldSplit *jac; 30880971522cSBarry Smith 30890971522cSBarry Smith PetscFunctionBegin; 30904dfa11a4SJacob Faibussowitsch PetscCall(PetscNew(&jac)); 30912fa5cd67SKarl Rupp 30920971522cSBarry Smith jac->bs = -1; 30930971522cSBarry Smith jac->nsplits = 0; 30943e197d65SBarry Smith jac->type = PC_COMPOSITE_MULTIPLICATIVE; 3095e6cab6aaSJed Brown jac->schurpre = PC_FIELDSPLIT_SCHUR_PRE_USER; /* Try user preconditioner first, fall back on diagonal */ 3096c9c6ffaaSJed Brown jac->schurfactorization = PC_FIELDSPLIT_SCHUR_FACT_FULL; 3097c096484dSStefano Zampini jac->schurscale = -1.0; 3098fbe7908bSJed Brown jac->dm_splits = PETSC_TRUE; 30997b752e3dSPatrick Sanan jac->detect = PETSC_FALSE; 3100a51937d4SCarola Kruse jac->gkbtol = 1e-5; 3101a51937d4SCarola Kruse jac->gkbdelay = 5; 3102a51937d4SCarola Kruse jac->gkbnu = 1; 3103a51937d4SCarola Kruse jac->gkbmaxit = 100; 3104de482cd7SCarola Kruse jac->gkbmonitor = PETSC_FALSE; 31055ddf11f8SNicolas Barnafi jac->coordinates_set = PETSC_FALSE; 310651f519a2SBarry Smith 31070971522cSBarry Smith pc->data = (void *)jac; 31080971522cSBarry Smith 31090971522cSBarry Smith pc->ops->apply = PCApply_FieldSplit; 3110421e10b8SBarry Smith pc->ops->applytranspose = PCApplyTranspose_FieldSplit; 31110971522cSBarry Smith pc->ops->setup = PCSetUp_FieldSplit; 3112574deadeSBarry Smith pc->ops->reset = PCReset_FieldSplit; 31130971522cSBarry Smith pc->ops->destroy = PCDestroy_FieldSplit; 31140971522cSBarry Smith pc->ops->setfromoptions = PCSetFromOptions_FieldSplit; 31150971522cSBarry Smith pc->ops->view = PCView_FieldSplit; 31160a545947SLisandro Dalcin pc->ops->applyrichardson = NULL; 31170971522cSBarry Smith 31189566063dSJacob Faibussowitsch PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSchurGetSubKSP_C", PCFieldSplitSchurGetSubKSP_FieldSplit)); 31199566063dSJacob Faibussowitsch PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitGetSubKSP_C", PCFieldSplitGetSubKSP_FieldSplit)); 31209566063dSJacob Faibussowitsch PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetFields_C", PCFieldSplitSetFields_FieldSplit)); 31219566063dSJacob Faibussowitsch PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetIS_C", PCFieldSplitSetIS_FieldSplit)); 31229566063dSJacob Faibussowitsch PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetType_C", PCFieldSplitSetType_FieldSplit)); 31239566063dSJacob Faibussowitsch PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetBlockSize_C", PCFieldSplitSetBlockSize_FieldSplit)); 31249566063dSJacob Faibussowitsch PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitRestrictIS_C", PCFieldSplitRestrictIS_FieldSplit)); 31259566063dSJacob Faibussowitsch PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCSetCoordinates_C", PCSetCoordinates_FieldSplit)); 31260971522cSBarry Smith PetscFunctionReturn(0); 31270971522cSBarry Smith } 3128