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> 4*f7cbcdf3SPierre Jolivet #include <petscdevice.h> 5*f7cbcdf3SPierre Jolivet #if PetscDefined(HAVE_CUDA) 6*f7cbcdf3SPierre Jolivet #include <petscdevice_cuda.h> 7*f7cbcdf3SPierre Jolivet #endif 8*f7cbcdf3SPierre Jolivet #if PetscDefined(HAVE_HIP) 9*f7cbcdf3SPierre Jolivet #include <petscdevice_hip.h> 10*f7cbcdf3SPierre Jolivet #endif 110971522cSBarry Smith 120a545947SLisandro Dalcin const char *const PCFieldSplitSchurPreTypes[] = {"SELF", "SELFP", "A11", "USER", "FULL", "PCFieldSplitSchurPreType", "PC_FIELDSPLIT_SCHUR_PRE_", NULL}; 130a545947SLisandro Dalcin const char *const PCFieldSplitSchurFactTypes[] = {"DIAG", "LOWER", "UPPER", "FULL", "PCFieldSplitSchurFactType", "PC_FIELDSPLIT_SCHUR_FACT_", NULL}; 14c5d2311dSJed Brown 159df09d43SBarry 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; 169df09d43SBarry Smith 170971522cSBarry Smith typedef struct _PC_FieldSplitLink *PC_FieldSplitLink; 180971522cSBarry Smith struct _PC_FieldSplitLink { 1969a612a9SBarry Smith KSP ksp; 20443836d0SMatthew G Knepley Vec x, y, z; 21db4c96c1SJed Brown char *splitname; 220971522cSBarry Smith PetscInt nfields; 235d4c12cdSJungho Lee PetscInt *fields, *fields_col; 241b9fc7fcSBarry Smith VecScatter sctx; 25f5f0d762SBarry Smith IS is, is_col; 2651f519a2SBarry Smith PC_FieldSplitLink next, previous; 279df09d43SBarry Smith PetscLogEvent event; 285ddf11f8SNicolas Barnafi 295ddf11f8SNicolas Barnafi /* Used only when setting coordinates with PCSetCoordinates */ 305ddf11f8SNicolas Barnafi PetscInt dim; 315ddf11f8SNicolas Barnafi PetscInt ndofs; 325ddf11f8SNicolas Barnafi PetscReal *coords; 330971522cSBarry Smith }; 340971522cSBarry Smith 350971522cSBarry Smith typedef struct { 3668dd23aaSBarry Smith PCCompositeType type; 37ace3abfcSBarry Smith PetscBool defaultsplit; /* Flag for a system with a set of 'k' scalar fields with the same layout (and bs = k) */ 38ace3abfcSBarry Smith PetscBool splitdefined; /* Flag is set after the splits have been defined, to prevent more splits from being added */ 3930ad9308SMatthew Knepley PetscInt bs; /* Block size for IS and Mat structures */ 4030ad9308SMatthew Knepley PetscInt nsplits; /* Number of field divisions defined */ 4179416396SBarry Smith Vec *x, *y, w1, w2; 42519d70e2SJed Brown Mat *mat; /* The diagonal block for each split */ 43519d70e2SJed Brown Mat *pmat; /* The preconditioning diagonal block for each split */ 4430ad9308SMatthew Knepley Mat *Afield; /* The rows of the matrix associated with each split */ 45ace3abfcSBarry Smith PetscBool issetup; 462fa5cd67SKarl Rupp 4730ad9308SMatthew Knepley /* Only used when Schur complement preconditioning is used */ 4830ad9308SMatthew Knepley Mat B; /* The (0,1) block */ 4930ad9308SMatthew Knepley Mat C; /* The (1,0) block */ 50443836d0SMatthew G Knepley Mat schur; /* The Schur complement S = A11 - A10 A00^{-1} A01, the KSP here, kspinner, is H_1 in [El08] */ 51a7476a74SDmitry Karpeev Mat schurp; /* Assembled approximation to S built by MatSchurComplement to be used as a preconditioning matrix when solving with S */ 52084e4875SJed Brown Mat schur_user; /* User-provided preconditioning matrix for the Schur complement */ 53084e4875SJed Brown PCFieldSplitSchurPreType schurpre; /* Determines which preconditioning matrix is used for the Schur complement */ 54c9c6ffaaSJed Brown PCFieldSplitSchurFactType schurfactorization; 5530ad9308SMatthew Knepley KSP kspschur; /* The solver for S */ 56443836d0SMatthew G Knepley KSP kspupper; /* The solver for A in the upper diagonal part of the factorization (H_2 in [El08]) */ 57c096484dSStefano Zampini PetscScalar schurscale; /* Scaling factor for the Schur complement solution with DIAG factorization */ 58c096484dSStefano Zampini 59a51937d4SCarola Kruse /* Only used when Golub-Kahan bidiagonalization preconditioning is used */ 60a51937d4SCarola Kruse Mat H; /* The modified matrix H = A00 + nu*A01*A01' */ 61a51937d4SCarola Kruse PetscReal gkbtol; /* Stopping tolerance for lower bound estimate */ 62a51937d4SCarola Kruse PetscInt gkbdelay; /* The delay window for the stopping criterion */ 63a51937d4SCarola Kruse PetscReal gkbnu; /* Parameter for augmented Lagrangian H = A + nu*A01*A01' */ 64a51937d4SCarola Kruse PetscInt gkbmaxit; /* Maximum number of iterations for outer loop */ 65de482cd7SCarola Kruse PetscBool gkbmonitor; /* Monitor for gkb iterations and the lower bound error */ 66de482cd7SCarola Kruse PetscViewer gkbviewer; /* Viewer context for gkbmonitor */ 67e071a0a4SCarola Kruse Vec u, v, d, Hu; /* Work vectors for the GKB algorithm */ 68e071a0a4SCarola Kruse PetscScalar *vecz; /* Contains intermediate values, eg for lower bound */ 69a51937d4SCarola Kruse 7097bbdb24SBarry Smith PC_FieldSplitLink head; 716dbb499eSCian Wilson PetscBool isrestrict; /* indicates PCFieldSplitRestrictIS() has been last called on this object, hack */ 72c1570756SJed Brown PetscBool suboptionsset; /* Indicates that the KSPSetFromOptions() has been called on the sub-KSPs */ 734ab8060aSDmitry Karpeev PetscBool dm_splits; /* Whether to use DMCreateFieldDecomposition() whenever possible */ 74c84da90fSDmitry Karpeev PetscBool diag_use_amat; /* Whether to extract diagonal matrix blocks from Amat, rather than Pmat (weaker than -pc_use_amat) */ 75c84da90fSDmitry Karpeev PetscBool offdiag_use_amat; /* Whether to extract off-diagonal matrix blocks from Amat, rather than Pmat (weaker than -pc_use_amat) */ 767b752e3dSPatrick Sanan PetscBool detect; /* Whether to form 2-way split by finding zero diagonal entries */ 775ddf11f8SNicolas Barnafi PetscBool coordinates_set; /* Whether PCSetCoordinates has been called */ 780971522cSBarry Smith } PC_FieldSplit; 790971522cSBarry Smith 8016913363SBarry Smith /* 81f1580f4eSBarry Smith Note: 8295452b02SPatrick Sanan there is no particular reason that pmat, x, and y are stored as arrays in PC_FieldSplit instead of 8316913363SBarry Smith inside PC_FieldSplitLink, just historical. If you want to be able to add new fields after already using the 8416913363SBarry Smith PC you could change this. 8516913363SBarry Smith */ 86084e4875SJed Brown 87e6cab6aaSJed Brown /* This helper is so that setting a user-provided preconditioning matrix is orthogonal to choosing to use it. This way the 88084e4875SJed Brown * application-provided FormJacobian can provide this matrix without interfering with the user's (command-line) choices. */ 89d71ae5a4SJacob Faibussowitsch static Mat FieldSplitSchurPre(PC_FieldSplit *jac) 90d71ae5a4SJacob Faibussowitsch { 91084e4875SJed Brown switch (jac->schurpre) { 92d71ae5a4SJacob Faibussowitsch case PC_FIELDSPLIT_SCHUR_PRE_SELF: 93d71ae5a4SJacob Faibussowitsch return jac->schur; 94d71ae5a4SJacob Faibussowitsch case PC_FIELDSPLIT_SCHUR_PRE_SELFP: 95d71ae5a4SJacob Faibussowitsch return jac->schurp; 96d71ae5a4SJacob Faibussowitsch case PC_FIELDSPLIT_SCHUR_PRE_A11: 97d71ae5a4SJacob Faibussowitsch return jac->pmat[1]; 98e74569cdSMatthew G. Knepley case PC_FIELDSPLIT_SCHUR_PRE_FULL: /* We calculate this and store it in schur_user */ 99084e4875SJed Brown case PC_FIELDSPLIT_SCHUR_PRE_USER: /* Use a user-provided matrix if it is given, otherwise diagonal block */ 100d71ae5a4SJacob Faibussowitsch default: 101d71ae5a4SJacob Faibussowitsch return jac->schur_user ? jac->schur_user : jac->pmat[1]; 102084e4875SJed Brown } 103084e4875SJed Brown } 104084e4875SJed Brown 1059804daf3SBarry Smith #include <petscdraw.h> 106d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCView_FieldSplit(PC pc, PetscViewer viewer) 107d71ae5a4SJacob Faibussowitsch { 1080971522cSBarry Smith PC_FieldSplit *jac = (PC_FieldSplit *)pc->data; 109d9884438SBarry Smith PetscBool iascii, isdraw; 1100971522cSBarry Smith PetscInt i, j; 1115a9f2f41SSatish Balay PC_FieldSplitLink ilink = jac->head; 1120971522cSBarry Smith 1130971522cSBarry Smith PetscFunctionBegin; 1149566063dSJacob Faibussowitsch PetscCall(PetscObjectTypeCompare((PetscObject)viewer, PETSCVIEWERASCII, &iascii)); 1159566063dSJacob Faibussowitsch PetscCall(PetscObjectTypeCompare((PetscObject)viewer, PETSCVIEWERDRAW, &isdraw)); 1160971522cSBarry Smith if (iascii) { 1172c9966d7SBarry Smith if (jac->bs > 0) { 11863a3b9bcSJacob Faibussowitsch PetscCall(PetscViewerASCIIPrintf(viewer, " FieldSplit with %s composition: total splits = %" PetscInt_FMT ", blocksize = %" PetscInt_FMT "\n", PCCompositeTypes[jac->type], jac->nsplits, jac->bs)); 1192c9966d7SBarry Smith } else { 12063a3b9bcSJacob Faibussowitsch PetscCall(PetscViewerASCIIPrintf(viewer, " FieldSplit with %s composition: total splits = %" PetscInt_FMT "\n", PCCompositeTypes[jac->type], jac->nsplits)); 1212c9966d7SBarry Smith } 12248a46eb9SPierre Jolivet if (pc->useAmat) PetscCall(PetscViewerASCIIPrintf(viewer, " using Amat (not Pmat) as operator for blocks\n")); 12348a46eb9SPierre Jolivet if (jac->diag_use_amat) PetscCall(PetscViewerASCIIPrintf(viewer, " using Amat (not Pmat) as operator for diagonal blocks\n")); 12448a46eb9SPierre Jolivet if (jac->offdiag_use_amat) PetscCall(PetscViewerASCIIPrintf(viewer, " using Amat (not Pmat) as operator for off-diagonal blocks\n")); 1259566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIIPrintf(viewer, " Solver info for each split is in the following KSP objects:\n")); 1260971522cSBarry Smith for (i = 0; i < jac->nsplits; i++) { 1271ab39975SBarry Smith if (ilink->fields) { 12863a3b9bcSJacob Faibussowitsch PetscCall(PetscViewerASCIIPrintf(viewer, "Split number %" PetscInt_FMT " Fields ", i)); 1299566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIIUseTabs(viewer, PETSC_FALSE)); 1305a9f2f41SSatish Balay for (j = 0; j < ilink->nfields; j++) { 13148a46eb9SPierre Jolivet if (j > 0) PetscCall(PetscViewerASCIIPrintf(viewer, ",")); 13263a3b9bcSJacob Faibussowitsch PetscCall(PetscViewerASCIIPrintf(viewer, " %" PetscInt_FMT, ilink->fields[j])); 1330971522cSBarry Smith } 1349566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIIPrintf(viewer, "\n")); 1359566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIIUseTabs(viewer, PETSC_TRUE)); 1361ab39975SBarry Smith } else { 13763a3b9bcSJacob Faibussowitsch PetscCall(PetscViewerASCIIPrintf(viewer, "Split number %" PetscInt_FMT " Defined by IS\n", i)); 1381ab39975SBarry Smith } 1399566063dSJacob Faibussowitsch PetscCall(KSPView(ilink->ksp, viewer)); 1405a9f2f41SSatish Balay ilink = ilink->next; 1410971522cSBarry Smith } 1422fa5cd67SKarl Rupp } 1432fa5cd67SKarl Rupp 1442fa5cd67SKarl Rupp if (isdraw) { 145d9884438SBarry Smith PetscDraw draw; 146d9884438SBarry Smith PetscReal x, y, w, wd; 147d9884438SBarry Smith 1489566063dSJacob Faibussowitsch PetscCall(PetscViewerDrawGetDraw(viewer, 0, &draw)); 1499566063dSJacob Faibussowitsch PetscCall(PetscDrawGetCurrentPoint(draw, &x, &y)); 150d9884438SBarry Smith w = 2 * PetscMin(1.0 - x, x); 151d9884438SBarry Smith wd = w / (jac->nsplits + 1); 152d9884438SBarry Smith x = x - wd * (jac->nsplits - 1) / 2.0; 153d9884438SBarry Smith for (i = 0; i < jac->nsplits; i++) { 1549566063dSJacob Faibussowitsch PetscCall(PetscDrawPushCurrentPoint(draw, x, y)); 1559566063dSJacob Faibussowitsch PetscCall(KSPView(ilink->ksp, viewer)); 1569566063dSJacob Faibussowitsch PetscCall(PetscDrawPopCurrentPoint(draw)); 157d9884438SBarry Smith x += wd; 158d9884438SBarry Smith ilink = ilink->next; 159d9884438SBarry Smith } 1600971522cSBarry Smith } 1613ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 1620971522cSBarry Smith } 1630971522cSBarry Smith 164d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCView_FieldSplit_Schur(PC pc, PetscViewer viewer) 165d71ae5a4SJacob Faibussowitsch { 1663b224e63SBarry Smith PC_FieldSplit *jac = (PC_FieldSplit *)pc->data; 1674996c5bdSBarry Smith PetscBool iascii, isdraw; 1683b224e63SBarry Smith PetscInt i, j; 1693b224e63SBarry Smith PC_FieldSplitLink ilink = jac->head; 170a9908d51SBarry Smith MatSchurComplementAinvType atype; 1713b224e63SBarry Smith 1723b224e63SBarry Smith PetscFunctionBegin; 1739566063dSJacob Faibussowitsch PetscCall(PetscObjectTypeCompare((PetscObject)viewer, PETSCVIEWERASCII, &iascii)); 1749566063dSJacob Faibussowitsch PetscCall(PetscObjectTypeCompare((PetscObject)viewer, PETSCVIEWERDRAW, &isdraw)); 1753b224e63SBarry Smith if (iascii) { 1762c9966d7SBarry Smith if (jac->bs > 0) { 17763a3b9bcSJacob Faibussowitsch PetscCall(PetscViewerASCIIPrintf(viewer, " FieldSplit with Schur preconditioner, blocksize = %" PetscInt_FMT ", factorization %s\n", jac->bs, PCFieldSplitSchurFactTypes[jac->schurfactorization])); 1782c9966d7SBarry Smith } else { 1799566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIIPrintf(viewer, " FieldSplit with Schur preconditioner, factorization %s\n", PCFieldSplitSchurFactTypes[jac->schurfactorization])); 1802c9966d7SBarry Smith } 18148a46eb9SPierre Jolivet if (pc->useAmat) PetscCall(PetscViewerASCIIPrintf(viewer, " using Amat (not Pmat) as operator for blocks\n")); 1823e8b8b31SMatthew G Knepley switch (jac->schurpre) { 183d71ae5a4SJacob Faibussowitsch case PC_FIELDSPLIT_SCHUR_PRE_SELF: 184d71ae5a4SJacob Faibussowitsch PetscCall(PetscViewerASCIIPrintf(viewer, " Preconditioner for the Schur complement formed from S itself\n")); 185d71ae5a4SJacob Faibussowitsch break; 186a7476a74SDmitry Karpeev case PC_FIELDSPLIT_SCHUR_PRE_SELFP: 1877cf5f706SPierre Jolivet if (jac->schur) { 1889566063dSJacob Faibussowitsch PetscCall(MatSchurComplementGetAinvType(jac->schur, &atype)); 1899371c9d4SSatish 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 ")))); 1907cf5f706SPierre Jolivet } 191a9908d51SBarry Smith break; 192d71ae5a4SJacob Faibussowitsch case PC_FIELDSPLIT_SCHUR_PRE_A11: 193d71ae5a4SJacob Faibussowitsch PetscCall(PetscViewerASCIIPrintf(viewer, " Preconditioner for the Schur complement formed from A11\n")); 194d71ae5a4SJacob Faibussowitsch break; 195d71ae5a4SJacob Faibussowitsch case PC_FIELDSPLIT_SCHUR_PRE_FULL: 196d71ae5a4SJacob Faibussowitsch PetscCall(PetscViewerASCIIPrintf(viewer, " Preconditioner for the Schur complement formed from the exact Schur complement\n")); 197d71ae5a4SJacob Faibussowitsch break; 1983e8b8b31SMatthew G Knepley case PC_FIELDSPLIT_SCHUR_PRE_USER: 1993e8b8b31SMatthew G Knepley if (jac->schur_user) { 2009566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIIPrintf(viewer, " Preconditioner for the Schur complement formed from user provided matrix\n")); 2013e8b8b31SMatthew G Knepley } else { 2029566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIIPrintf(viewer, " Preconditioner for the Schur complement formed from A11\n")); 2033e8b8b31SMatthew G Knepley } 2043e8b8b31SMatthew G Knepley break; 205d71ae5a4SJacob Faibussowitsch default: 206d71ae5a4SJacob Faibussowitsch SETERRQ(PetscObjectComm((PetscObject)pc), PETSC_ERR_ARG_OUTOFRANGE, "Invalid Schur preconditioning type: %d", jac->schurpre); 2073e8b8b31SMatthew G Knepley } 2089566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIIPrintf(viewer, " Split info:\n")); 2099566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIIPushTab(viewer)); 2103b224e63SBarry Smith for (i = 0; i < jac->nsplits; i++) { 2113b224e63SBarry Smith if (ilink->fields) { 21263a3b9bcSJacob Faibussowitsch PetscCall(PetscViewerASCIIPrintf(viewer, "Split number %" PetscInt_FMT " Fields ", i)); 2139566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIIUseTabs(viewer, PETSC_FALSE)); 2143b224e63SBarry Smith for (j = 0; j < ilink->nfields; j++) { 21548a46eb9SPierre Jolivet if (j > 0) PetscCall(PetscViewerASCIIPrintf(viewer, ",")); 21663a3b9bcSJacob Faibussowitsch PetscCall(PetscViewerASCIIPrintf(viewer, " %" PetscInt_FMT, ilink->fields[j])); 2173b224e63SBarry Smith } 2189566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIIPrintf(viewer, "\n")); 2199566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIIUseTabs(viewer, PETSC_TRUE)); 2203b224e63SBarry Smith } else { 22163a3b9bcSJacob Faibussowitsch PetscCall(PetscViewerASCIIPrintf(viewer, "Split number %" PetscInt_FMT " Defined by IS\n", i)); 2223b224e63SBarry Smith } 2233b224e63SBarry Smith ilink = ilink->next; 2243b224e63SBarry Smith } 2259566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIIPrintf(viewer, "KSP solver for A00 block\n")); 2269566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIIPushTab(viewer)); 22706de4afeSJed Brown if (jac->head) { 2289566063dSJacob Faibussowitsch PetscCall(KSPView(jac->head->ksp, viewer)); 2299566063dSJacob Faibussowitsch } else PetscCall(PetscViewerASCIIPrintf(viewer, " not yet available\n")); 2309566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIIPopTab(viewer)); 23106de4afeSJed Brown if (jac->head && jac->kspupper != jac->head->ksp) { 2329566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIIPrintf(viewer, "KSP solver for upper A00 in upper triangular factor\n")); 2339566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIIPushTab(viewer)); 2349566063dSJacob Faibussowitsch if (jac->kspupper) PetscCall(KSPView(jac->kspupper, viewer)); 2359566063dSJacob Faibussowitsch else PetscCall(PetscViewerASCIIPrintf(viewer, " not yet available\n")); 2369566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIIPopTab(viewer)); 237443836d0SMatthew G Knepley } 2389566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIIPrintf(viewer, "KSP solver for S = A11 - A10 inv(A00) A01\n")); 2399566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIIPushTab(viewer)); 24012cae6f2SJed Brown if (jac->kspschur) { 2419566063dSJacob Faibussowitsch PetscCall(KSPView(jac->kspschur, viewer)); 24212cae6f2SJed Brown } else { 2439566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIIPrintf(viewer, " not yet available\n")); 24412cae6f2SJed Brown } 2459566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIIPopTab(viewer)); 2469566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIIPopTab(viewer)); 24706de4afeSJed Brown } else if (isdraw && jac->head) { 2484996c5bdSBarry Smith PetscDraw draw; 2494996c5bdSBarry Smith PetscReal x, y, w, wd, h; 2504996c5bdSBarry Smith PetscInt cnt = 2; 2514996c5bdSBarry Smith char str[32]; 2524996c5bdSBarry Smith 2539566063dSJacob Faibussowitsch PetscCall(PetscViewerDrawGetDraw(viewer, 0, &draw)); 2549566063dSJacob Faibussowitsch PetscCall(PetscDrawGetCurrentPoint(draw, &x, &y)); 255c74581afSBarry Smith if (jac->kspupper != jac->head->ksp) cnt++; 256c74581afSBarry Smith w = 2 * PetscMin(1.0 - x, x); 257c74581afSBarry Smith wd = w / (cnt + 1); 258c74581afSBarry Smith 2599566063dSJacob Faibussowitsch PetscCall(PetscSNPrintf(str, 32, "Schur fact. %s", PCFieldSplitSchurFactTypes[jac->schurfactorization])); 2609566063dSJacob Faibussowitsch PetscCall(PetscDrawStringBoxed(draw, x, y, PETSC_DRAW_RED, PETSC_DRAW_BLACK, str, NULL, &h)); 2614996c5bdSBarry Smith y -= h; 2624996c5bdSBarry Smith if (jac->schurpre == PC_FIELDSPLIT_SCHUR_PRE_USER && !jac->schur_user) { 2639566063dSJacob Faibussowitsch PetscCall(PetscSNPrintf(str, 32, "Prec. for Schur from %s", PCFieldSplitSchurPreTypes[PC_FIELDSPLIT_SCHUR_PRE_A11])); 2643b224e63SBarry Smith } else { 2659566063dSJacob Faibussowitsch PetscCall(PetscSNPrintf(str, 32, "Prec. for Schur from %s", PCFieldSplitSchurPreTypes[jac->schurpre])); 2664996c5bdSBarry Smith } 2679566063dSJacob Faibussowitsch PetscCall(PetscDrawStringBoxed(draw, x + wd * (cnt - 1) / 2.0, y, PETSC_DRAW_RED, PETSC_DRAW_BLACK, str, NULL, &h)); 2684996c5bdSBarry Smith y -= h; 2694996c5bdSBarry Smith x = x - wd * (cnt - 1) / 2.0; 2704996c5bdSBarry Smith 2719566063dSJacob Faibussowitsch PetscCall(PetscDrawPushCurrentPoint(draw, x, y)); 2729566063dSJacob Faibussowitsch PetscCall(KSPView(jac->head->ksp, viewer)); 2739566063dSJacob Faibussowitsch PetscCall(PetscDrawPopCurrentPoint(draw)); 2744996c5bdSBarry Smith if (jac->kspupper != jac->head->ksp) { 2754996c5bdSBarry Smith x += wd; 2769566063dSJacob Faibussowitsch PetscCall(PetscDrawPushCurrentPoint(draw, x, y)); 2779566063dSJacob Faibussowitsch PetscCall(KSPView(jac->kspupper, viewer)); 2789566063dSJacob Faibussowitsch PetscCall(PetscDrawPopCurrentPoint(draw)); 2794996c5bdSBarry Smith } 2804996c5bdSBarry Smith x += wd; 2819566063dSJacob Faibussowitsch PetscCall(PetscDrawPushCurrentPoint(draw, x, y)); 2829566063dSJacob Faibussowitsch PetscCall(KSPView(jac->kspschur, viewer)); 2839566063dSJacob Faibussowitsch PetscCall(PetscDrawPopCurrentPoint(draw)); 2843b224e63SBarry Smith } 2853ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 2863b224e63SBarry Smith } 2873b224e63SBarry Smith 288d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCView_FieldSplit_GKB(PC pc, PetscViewer viewer) 289d71ae5a4SJacob Faibussowitsch { 290a51937d4SCarola Kruse PC_FieldSplit *jac = (PC_FieldSplit *)pc->data; 291a51937d4SCarola Kruse PetscBool iascii, isdraw; 292a51937d4SCarola Kruse PetscInt i, j; 293a51937d4SCarola Kruse PC_FieldSplitLink ilink = jac->head; 294a51937d4SCarola Kruse 295a51937d4SCarola Kruse PetscFunctionBegin; 2969566063dSJacob Faibussowitsch PetscCall(PetscObjectTypeCompare((PetscObject)viewer, PETSCVIEWERASCII, &iascii)); 2979566063dSJacob Faibussowitsch PetscCall(PetscObjectTypeCompare((PetscObject)viewer, PETSCVIEWERDRAW, &isdraw)); 298a51937d4SCarola Kruse if (iascii) { 299a51937d4SCarola Kruse if (jac->bs > 0) { 30063a3b9bcSJacob Faibussowitsch PetscCall(PetscViewerASCIIPrintf(viewer, " FieldSplit with %s composition: total splits = %" PetscInt_FMT ", blocksize = %" PetscInt_FMT "\n", PCCompositeTypes[jac->type], jac->nsplits, jac->bs)); 301a51937d4SCarola Kruse } else { 30263a3b9bcSJacob Faibussowitsch PetscCall(PetscViewerASCIIPrintf(viewer, " FieldSplit with %s composition: total splits = %" PetscInt_FMT "\n", PCCompositeTypes[jac->type], jac->nsplits)); 303a51937d4SCarola Kruse } 30448a46eb9SPierre Jolivet if (pc->useAmat) PetscCall(PetscViewerASCIIPrintf(viewer, " using Amat (not Pmat) as operator for blocks\n")); 30548a46eb9SPierre Jolivet if (jac->diag_use_amat) PetscCall(PetscViewerASCIIPrintf(viewer, " using Amat (not Pmat) as operator for diagonal blocks\n")); 30648a46eb9SPierre Jolivet if (jac->offdiag_use_amat) PetscCall(PetscViewerASCIIPrintf(viewer, " using Amat (not Pmat) as operator for off-diagonal blocks\n")); 307a51937d4SCarola Kruse 30863a3b9bcSJacob 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)); 3099566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIIPrintf(viewer, " Solver info for H = A00 + nu*A01*A01' matrix:\n")); 3109566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIIPushTab(viewer)); 311a51937d4SCarola Kruse 312a51937d4SCarola Kruse if (ilink->fields) { 31363a3b9bcSJacob Faibussowitsch PetscCall(PetscViewerASCIIPrintf(viewer, "Split number 0 Fields ")); 3149566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIIUseTabs(viewer, PETSC_FALSE)); 315a51937d4SCarola Kruse for (j = 0; j < ilink->nfields; j++) { 31648a46eb9SPierre Jolivet if (j > 0) PetscCall(PetscViewerASCIIPrintf(viewer, ",")); 31763a3b9bcSJacob Faibussowitsch PetscCall(PetscViewerASCIIPrintf(viewer, " %" PetscInt_FMT, ilink->fields[j])); 318a51937d4SCarola Kruse } 3199566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIIPrintf(viewer, "\n")); 3209566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIIUseTabs(viewer, PETSC_TRUE)); 321a51937d4SCarola Kruse } else { 32263a3b9bcSJacob Faibussowitsch PetscCall(PetscViewerASCIIPrintf(viewer, "Split number 0 Defined by IS\n")); 323a51937d4SCarola Kruse } 3249566063dSJacob Faibussowitsch PetscCall(KSPView(ilink->ksp, viewer)); 325a51937d4SCarola Kruse 3269566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIIPopTab(viewer)); 327a51937d4SCarola Kruse } 328a51937d4SCarola Kruse 329a51937d4SCarola Kruse if (isdraw) { 330a51937d4SCarola Kruse PetscDraw draw; 331a51937d4SCarola Kruse PetscReal x, y, w, wd; 332a51937d4SCarola Kruse 3339566063dSJacob Faibussowitsch PetscCall(PetscViewerDrawGetDraw(viewer, 0, &draw)); 3349566063dSJacob Faibussowitsch PetscCall(PetscDrawGetCurrentPoint(draw, &x, &y)); 335a51937d4SCarola Kruse w = 2 * PetscMin(1.0 - x, x); 336a51937d4SCarola Kruse wd = w / (jac->nsplits + 1); 337a51937d4SCarola Kruse x = x - wd * (jac->nsplits - 1) / 2.0; 338a51937d4SCarola Kruse for (i = 0; i < jac->nsplits; i++) { 3399566063dSJacob Faibussowitsch PetscCall(PetscDrawPushCurrentPoint(draw, x, y)); 3409566063dSJacob Faibussowitsch PetscCall(KSPView(ilink->ksp, viewer)); 3419566063dSJacob Faibussowitsch PetscCall(PetscDrawPopCurrentPoint(draw)); 342a51937d4SCarola Kruse x += wd; 343a51937d4SCarola Kruse ilink = ilink->next; 344a51937d4SCarola Kruse } 345a51937d4SCarola Kruse } 3463ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 347a51937d4SCarola Kruse } 348a51937d4SCarola Kruse 34980670ca5SBarry Smith /* Precondition: jac->bs is set to a meaningful value or MATNEST */ 350d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCFieldSplitSetRuntimeSplits_Private(PC pc) 351d71ae5a4SJacob Faibussowitsch { 3526c924f48SJed Brown PC_FieldSplit *jac = (PC_FieldSplit *)pc->data; 35380670ca5SBarry Smith PetscInt bs, i, nfields, *ifields, nfields_col, *ifields_col; 35480670ca5SBarry Smith PetscBool flg, flg_col, mnest; 3555d4c12cdSJungho Lee char optionname[128], splitname[8], optionname_col[128]; 3566c924f48SJed Brown 3576c924f48SJed Brown PetscFunctionBegin; 35880670ca5SBarry Smith PetscCall(PetscObjectTypeCompare((PetscObject)pc->mat, MATNEST, &mnest)); 35980670ca5SBarry Smith if (mnest) { 36080670ca5SBarry Smith PetscCall(MatNestGetSize(pc->pmat, &bs, NULL)); 36180670ca5SBarry Smith } else { 36280670ca5SBarry Smith bs = jac->bs; 36380670ca5SBarry Smith } 36480670ca5SBarry Smith PetscCall(PetscMalloc2(bs, &ifields, bs, &ifields_col)); 3656c924f48SJed Brown for (i = 0, flg = PETSC_TRUE;; i++) { 36663a3b9bcSJacob Faibussowitsch PetscCall(PetscSNPrintf(splitname, sizeof(splitname), "%" PetscInt_FMT, i)); 36763a3b9bcSJacob Faibussowitsch PetscCall(PetscSNPrintf(optionname, sizeof(optionname), "-pc_fieldsplit_%" PetscInt_FMT "_fields", i)); 36863a3b9bcSJacob Faibussowitsch PetscCall(PetscSNPrintf(optionname_col, sizeof(optionname_col), "-pc_fieldsplit_%" PetscInt_FMT "_fields_col", i)); 36980670ca5SBarry Smith nfields = bs; 37080670ca5SBarry Smith nfields_col = bs; 3719566063dSJacob Faibussowitsch PetscCall(PetscOptionsGetIntArray(((PetscObject)pc)->options, ((PetscObject)pc)->prefix, optionname, ifields, &nfields, &flg)); 3729566063dSJacob Faibussowitsch PetscCall(PetscOptionsGetIntArray(((PetscObject)pc)->options, ((PetscObject)pc)->prefix, optionname_col, ifields_col, &nfields_col, &flg_col)); 3736c924f48SJed Brown if (!flg) break; 3745d4c12cdSJungho Lee else if (flg && !flg_col) { 37528b400f6SJacob Faibussowitsch PetscCheck(nfields, PETSC_COMM_SELF, PETSC_ERR_USER, "Cannot list zero fields"); 3769566063dSJacob Faibussowitsch PetscCall(PCFieldSplitSetFields(pc, splitname, nfields, ifields, ifields)); 3772fa5cd67SKarl Rupp } else { 3787827d75bSBarry Smith PetscCheck(nfields && nfields_col, PETSC_COMM_SELF, PETSC_ERR_USER, "Cannot list zero fields"); 37908401ef6SPierre Jolivet PetscCheck(nfields == nfields_col, PETSC_COMM_SELF, PETSC_ERR_USER, "Number of row and column fields must match"); 3809566063dSJacob Faibussowitsch PetscCall(PCFieldSplitSetFields(pc, splitname, nfields, ifields, ifields_col)); 3815d4c12cdSJungho Lee } 3826c924f48SJed Brown } 3836c924f48SJed Brown if (i > 0) { 3846c924f48SJed Brown /* Makes command-line setting of splits take precedence over setting them in code. 3856c924f48SJed Brown Otherwise subsequent calls to PCFieldSplitSetIS() or PCFieldSplitSetFields() would 3866c924f48SJed Brown create new splits, which would probably not be what the user wanted. */ 3876c924f48SJed Brown jac->splitdefined = PETSC_TRUE; 3886c924f48SJed Brown } 38980670ca5SBarry Smith PetscCall(PetscFree2(ifields, ifields_col)); 3903ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 3916c924f48SJed Brown } 3926c924f48SJed Brown 393d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCFieldSplitSetDefaults(PC pc) 394d71ae5a4SJacob Faibussowitsch { 3950971522cSBarry Smith PC_FieldSplit *jac = (PC_FieldSplit *)pc->data; 3965a9f2f41SSatish Balay PC_FieldSplitLink ilink = jac->head; 3977b752e3dSPatrick Sanan PetscBool fieldsplit_default = PETSC_FALSE, coupling = PETSC_FALSE; 3986c924f48SJed Brown PetscInt i; 3990971522cSBarry Smith 4000971522cSBarry Smith PetscFunctionBegin; 4017287d2a3SDmitry Karpeev /* 402f5f0d762SBarry Smith Kinda messy, but at least this now uses DMCreateFieldDecomposition(). 4037287d2a3SDmitry Karpeev Should probably be rewritten. 4047287d2a3SDmitry Karpeev */ 405f5f0d762SBarry Smith if (!ilink) { 4069566063dSJacob Faibussowitsch PetscCall(PetscOptionsGetBool(((PetscObject)pc)->options, ((PetscObject)pc)->prefix, "-pc_fieldsplit_detect_coupling", &coupling, NULL)); 4077b752e3dSPatrick Sanan if (pc->dm && jac->dm_splits && !jac->detect && !coupling) { 408bafc1b83SMatthew G Knepley PetscInt numFields, f, i, j; 4090784a22cSJed Brown char **fieldNames; 4107b62db95SJungho Lee IS *fields; 411e7c4fc90SDmitry Karpeev DM *dms; 412bafc1b83SMatthew G Knepley DM subdm[128]; 413bafc1b83SMatthew G Knepley PetscBool flg; 414bafc1b83SMatthew G Knepley 4159566063dSJacob Faibussowitsch PetscCall(DMCreateFieldDecomposition(pc->dm, &numFields, &fieldNames, &fields, &dms)); 416bafc1b83SMatthew G Knepley /* Allow the user to prescribe the splits */ 417bafc1b83SMatthew G Knepley for (i = 0, flg = PETSC_TRUE;; i++) { 418bafc1b83SMatthew G Knepley PetscInt ifields[128]; 419bafc1b83SMatthew G Knepley IS compField; 420bafc1b83SMatthew G Knepley char optionname[128], splitname[8]; 421bafc1b83SMatthew G Knepley PetscInt nfields = numFields; 422bafc1b83SMatthew G Knepley 42363a3b9bcSJacob Faibussowitsch PetscCall(PetscSNPrintf(optionname, sizeof(optionname), "-pc_fieldsplit_%" PetscInt_FMT "_fields", i)); 4249566063dSJacob Faibussowitsch PetscCall(PetscOptionsGetIntArray(((PetscObject)pc)->options, ((PetscObject)pc)->prefix, optionname, ifields, &nfields, &flg)); 425bafc1b83SMatthew G Knepley if (!flg) break; 42663a3b9bcSJacob Faibussowitsch PetscCheck(numFields <= 128, PetscObjectComm((PetscObject)pc), PETSC_ERR_SUP, "Cannot currently support %" PetscInt_FMT " > 128 fields", numFields); 4279566063dSJacob Faibussowitsch PetscCall(DMCreateSubDM(pc->dm, nfields, ifields, &compField, &subdm[i])); 428bafc1b83SMatthew G Knepley if (nfields == 1) { 4299566063dSJacob Faibussowitsch PetscCall(PCFieldSplitSetIS(pc, fieldNames[ifields[0]], compField)); 430bafc1b83SMatthew G Knepley } else { 43163a3b9bcSJacob Faibussowitsch PetscCall(PetscSNPrintf(splitname, sizeof(splitname), "%" PetscInt_FMT, i)); 4329566063dSJacob Faibussowitsch PetscCall(PCFieldSplitSetIS(pc, splitname, compField)); 4337287d2a3SDmitry Karpeev } 4349566063dSJacob Faibussowitsch PetscCall(ISDestroy(&compField)); 435bafc1b83SMatthew G Knepley for (j = 0; j < nfields; ++j) { 436bafc1b83SMatthew G Knepley f = ifields[j]; 4379566063dSJacob Faibussowitsch PetscCall(PetscFree(fieldNames[f])); 4389566063dSJacob Faibussowitsch PetscCall(ISDestroy(&fields[f])); 4397b62db95SJungho Lee } 440bafc1b83SMatthew G Knepley } 441bafc1b83SMatthew G Knepley if (i == 0) { 442bafc1b83SMatthew G Knepley for (f = 0; f < numFields; ++f) { 4439566063dSJacob Faibussowitsch PetscCall(PCFieldSplitSetIS(pc, fieldNames[f], fields[f])); 4449566063dSJacob Faibussowitsch PetscCall(PetscFree(fieldNames[f])); 4459566063dSJacob Faibussowitsch PetscCall(ISDestroy(&fields[f])); 446bafc1b83SMatthew G Knepley } 447bafc1b83SMatthew G Knepley } else { 44848a46eb9SPierre Jolivet for (j = 0; j < numFields; j++) PetscCall(DMDestroy(dms + j)); 4499566063dSJacob Faibussowitsch PetscCall(PetscFree(dms)); 4509566063dSJacob Faibussowitsch PetscCall(PetscMalloc1(i, &dms)); 4512fa5cd67SKarl Rupp for (j = 0; j < i; ++j) dms[j] = subdm[j]; 452bafc1b83SMatthew G Knepley } 4539566063dSJacob Faibussowitsch PetscCall(PetscFree(fieldNames)); 4549566063dSJacob Faibussowitsch PetscCall(PetscFree(fields)); 455e7c4fc90SDmitry Karpeev if (dms) { 4569566063dSJacob Faibussowitsch PetscCall(PetscInfo(pc, "Setting up physics based fieldsplit preconditioner using the embedded DM\n")); 457bafc1b83SMatthew G Knepley for (ilink = jac->head, i = 0; ilink; ilink = ilink->next, ++i) { 4587287d2a3SDmitry Karpeev const char *prefix; 459f4f49eeaSPierre Jolivet PetscCall(PetscObjectGetOptionsPrefix((PetscObject)ilink->ksp, &prefix)); 460f4f49eeaSPierre Jolivet PetscCall(PetscObjectSetOptionsPrefix((PetscObject)dms[i], prefix)); 4619566063dSJacob Faibussowitsch PetscCall(KSPSetDM(ilink->ksp, dms[i])); 4629566063dSJacob Faibussowitsch PetscCall(KSPSetDMActive(ilink->ksp, PETSC_FALSE)); 4639566063dSJacob Faibussowitsch PetscCall(PetscObjectIncrementTabLevel((PetscObject)dms[i], (PetscObject)ilink->ksp, 0)); 4649566063dSJacob Faibussowitsch PetscCall(DMDestroy(&dms[i])); 4652fa5ba8aSJed Brown } 4669566063dSJacob Faibussowitsch PetscCall(PetscFree(dms)); 4678b8307b2SJed Brown } 46866ffff09SJed Brown } else { 469521d7252SBarry Smith if (jac->bs <= 0) { 470704ba839SBarry Smith if (pc->pmat) { 4719566063dSJacob Faibussowitsch PetscCall(MatGetBlockSize(pc->pmat, &jac->bs)); 4722fa5cd67SKarl Rupp } else jac->bs = 1; 473521d7252SBarry Smith } 474d32f9abdSBarry Smith 4757b752e3dSPatrick Sanan if (jac->detect) { 4766ce1633cSBarry Smith IS zerodiags, rest; 4776ce1633cSBarry Smith PetscInt nmin, nmax; 4786ce1633cSBarry Smith 4799566063dSJacob Faibussowitsch PetscCall(MatGetOwnershipRange(pc->mat, &nmin, &nmax)); 4807199da05SBarry Smith if (jac->diag_use_amat) { 4819566063dSJacob Faibussowitsch PetscCall(MatFindZeroDiagonals(pc->mat, &zerodiags)); 4827199da05SBarry Smith } else { 4839566063dSJacob Faibussowitsch PetscCall(MatFindZeroDiagonals(pc->pmat, &zerodiags)); 4847199da05SBarry Smith } 4859566063dSJacob Faibussowitsch PetscCall(ISComplement(zerodiags, nmin, nmax, &rest)); 4869566063dSJacob Faibussowitsch PetscCall(PCFieldSplitSetIS(pc, "0", rest)); 4879566063dSJacob Faibussowitsch PetscCall(PCFieldSplitSetIS(pc, "1", zerodiags)); 4889566063dSJacob Faibussowitsch PetscCall(ISDestroy(&zerodiags)); 4899566063dSJacob Faibussowitsch PetscCall(ISDestroy(&rest)); 4903a062f41SBarry Smith } else if (coupling) { 4913a062f41SBarry Smith IS coupling, rest; 4923a062f41SBarry Smith PetscInt nmin, nmax; 4933a062f41SBarry Smith 4949566063dSJacob Faibussowitsch PetscCall(MatGetOwnershipRange(pc->mat, &nmin, &nmax)); 4957199da05SBarry Smith if (jac->offdiag_use_amat) { 4969566063dSJacob Faibussowitsch PetscCall(MatFindOffBlockDiagonalEntries(pc->mat, &coupling)); 4977199da05SBarry Smith } else { 4989566063dSJacob Faibussowitsch PetscCall(MatFindOffBlockDiagonalEntries(pc->pmat, &coupling)); 4997199da05SBarry Smith } 5009566063dSJacob Faibussowitsch PetscCall(ISCreateStride(PetscObjectComm((PetscObject)pc->mat), nmax - nmin, nmin, 1, &rest)); 5019566063dSJacob Faibussowitsch PetscCall(ISSetIdentity(rest)); 5029566063dSJacob Faibussowitsch PetscCall(PCFieldSplitSetIS(pc, "0", rest)); 5039566063dSJacob Faibussowitsch PetscCall(PCFieldSplitSetIS(pc, "1", coupling)); 5049566063dSJacob Faibussowitsch PetscCall(ISDestroy(&coupling)); 5059566063dSJacob Faibussowitsch PetscCall(ISDestroy(&rest)); 5066ce1633cSBarry Smith } else { 5079566063dSJacob Faibussowitsch PetscCall(PetscOptionsGetBool(((PetscObject)pc)->options, ((PetscObject)pc)->prefix, "-pc_fieldsplit_default", &fieldsplit_default, NULL)); 5087287d2a3SDmitry Karpeev if (!fieldsplit_default) { 509d32f9abdSBarry Smith /* Allow user to set fields from command line, if bs was known at the time of PCSetFromOptions_FieldSplit() 510d32f9abdSBarry Smith then it is set there. This is not ideal because we should only have options set in XXSetFromOptions(). */ 5119566063dSJacob Faibussowitsch PetscCall(PCFieldSplitSetRuntimeSplits_Private(pc)); 5129566063dSJacob Faibussowitsch if (jac->splitdefined) PetscCall(PetscInfo(pc, "Splits defined using the options database\n")); 513d32f9abdSBarry Smith } 5146dbb499eSCian Wilson if ((fieldsplit_default || !jac->splitdefined) && !jac->isrestrict) { 5159f001fe8SStefano Zampini Mat M = pc->pmat; 516f3b928b9SStefano Zampini PetscBool isnest; 51780670ca5SBarry Smith PetscInt nf; 518f3b928b9SStefano Zampini 5199566063dSJacob Faibussowitsch PetscCall(PetscInfo(pc, "Using default splitting of fields\n")); 5209566063dSJacob Faibussowitsch PetscCall(PetscObjectTypeCompare((PetscObject)pc->pmat, MATNEST, &isnest)); 521f3b928b9SStefano Zampini if (!isnest) { 5229f001fe8SStefano Zampini M = pc->mat; 5239566063dSJacob Faibussowitsch PetscCall(PetscObjectTypeCompare((PetscObject)pc->mat, MATNEST, &isnest)); 524f3b928b9SStefano Zampini } 52580670ca5SBarry Smith if (!isnest) nf = jac->bs; 52680670ca5SBarry Smith else PetscCall(MatNestGetSize(M, &nf, NULL)); 52780670ca5SBarry Smith for (i = 0; i < nf; i++) { 5286c924f48SJed Brown char splitname[8]; 52980670ca5SBarry Smith 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 } 537edf189efSBarry Smith } else if (jac->nsplits == 1) { 538edf189efSBarry Smith IS is2; 539edf189efSBarry Smith PetscInt nmin, nmax; 540edf189efSBarry Smith 5410fdf79fbSJacob Faibussowitsch PetscCheck(ilink->is, PetscObjectComm((PetscObject)pc), PETSC_ERR_SUP, "Must provide at least two sets of fields to PCFieldSplit()"); 5429566063dSJacob Faibussowitsch PetscCall(MatGetOwnershipRange(pc->mat, &nmin, &nmax)); 5439566063dSJacob Faibussowitsch PetscCall(ISComplement(ilink->is, nmin, nmax, &is2)); 5449566063dSJacob Faibussowitsch PetscCall(PCFieldSplitSetIS(pc, "1", is2)); 5459566063dSJacob Faibussowitsch PetscCall(ISDestroy(&is2)); 546edf189efSBarry Smith } 547d0af7cd3SBarry Smith 54863a3b9bcSJacob Faibussowitsch PetscCheck(jac->nsplits >= 2, PetscObjectComm((PetscObject)pc), PETSC_ERR_PLIB, "Unhandled case, must have at least two fields, not %" PetscInt_FMT, jac->nsplits); 5493ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 55069a612a9SBarry Smith } 55169a612a9SBarry Smith 552d71ae5a4SJacob Faibussowitsch static PetscErrorCode MatGolubKahanComputeExplicitOperator(Mat A, Mat B, Mat C, Mat *H, PetscReal gkbnu) 553d71ae5a4SJacob Faibussowitsch { 554a51937d4SCarola Kruse Mat BT, T; 555de482cd7SCarola Kruse PetscReal nrmT, nrmB; 556a51937d4SCarola Kruse 557a51937d4SCarola Kruse PetscFunctionBegin; 5589566063dSJacob Faibussowitsch PetscCall(MatHermitianTranspose(C, MAT_INITIAL_MATRIX, &T)); /* Test if augmented matrix is symmetric */ 5599566063dSJacob Faibussowitsch PetscCall(MatAXPY(T, -1.0, B, DIFFERENT_NONZERO_PATTERN)); 5609566063dSJacob Faibussowitsch PetscCall(MatNorm(T, NORM_1, &nrmT)); 5619566063dSJacob Faibussowitsch PetscCall(MatNorm(B, NORM_1, &nrmB)); 562049d1499SBarry Smith PetscCheck(nrmB <= 0 || nrmT / nrmB < PETSC_SMALL, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "Matrix is not symmetric/hermitian, GKB is not applicable."); 563049d1499SBarry Smith 564a51937d4SCarola Kruse /* Compute augmented Lagrangian matrix H = A00 + nu*A01*A01'. This corresponds to */ 565a51937d4SCarola Kruse /* setting N := 1/nu*I in [Ar13]. */ 5669566063dSJacob Faibussowitsch PetscCall(MatHermitianTranspose(B, MAT_INITIAL_MATRIX, &BT)); 567fb842aefSJose E. Roman PetscCall(MatMatMult(B, BT, MAT_INITIAL_MATRIX, PETSC_CURRENT, H)); /* H = A01*A01' */ 5689566063dSJacob Faibussowitsch PetscCall(MatAYPX(*H, gkbnu, A, DIFFERENT_NONZERO_PATTERN)); /* H = A00 + nu*A01*A01' */ 569a51937d4SCarola Kruse 5709566063dSJacob Faibussowitsch PetscCall(MatDestroy(&BT)); 5719566063dSJacob Faibussowitsch PetscCall(MatDestroy(&T)); 5723ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 573a51937d4SCarola Kruse } 574a51937d4SCarola Kruse 57554a546c1SMatthew G. Knepley PETSC_EXTERN PetscErrorCode PetscOptionsFindPairPrefix_Private(PetscOptions, const char pre[], const char name[], const char *option[], const char *value[], PetscBool *flg); 576514bf10dSMatthew G Knepley 577d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCSetUp_FieldSplit(PC pc) 578d71ae5a4SJacob Faibussowitsch { 57969a612a9SBarry Smith PC_FieldSplit *jac = (PC_FieldSplit *)pc->data; 5805a9f2f41SSatish Balay PC_FieldSplitLink ilink; 5812c9966d7SBarry Smith PetscInt i, nsplit; 58280670ca5SBarry Smith PetscBool sorted, sorted_col, matnest = PETSC_FALSE; 58369a612a9SBarry Smith 58469a612a9SBarry Smith PetscFunctionBegin; 5855da88fe4STristan Konolige pc->failedreason = PC_NOERROR; 5869566063dSJacob Faibussowitsch PetscCall(PCFieldSplitSetDefaults(pc)); 58797bbdb24SBarry Smith nsplit = jac->nsplits; 5885a9f2f41SSatish Balay ilink = jac->head; 58980670ca5SBarry Smith if (pc->pmat) PetscCall(PetscObjectTypeCompare((PetscObject)pc->pmat, MATNEST, &matnest)); 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 } 6014db63379SBarry Smith 6024db63379SBarry Smith /* MatCreateSubMatrix() for [S]BAIJ matrices can only work if the indices include entire blocks of the matrix */ 6034db63379SBarry Smith PetscCall(MatGetBlockSize(pc->pmat, &bs)); 6044db63379SBarry Smith if (bs > 1 && (jac->bs <= bs || jac->bs % bs)) { 6054db63379SBarry Smith PetscBool blk; 6064db63379SBarry Smith 6074db63379SBarry Smith PetscCall(PetscObjectTypeCompareAny((PetscObject)pc->pmat, &blk, MATBAIJ, MATSBAIJ, MATSEQBAIJ, MATSEQSBAIJ, MATMPIBAIJ, MATMPISBAIJ, NULL)); 6084db63379SBarry Smith PetscCheck(!blk, PetscObjectComm((PetscObject)pc), PETSC_ERR_ARG_WRONG, "Cannot use MATBAIJ with PCFIELDSPLIT and currently set matrix and PC blocksizes"); 6094db63379SBarry Smith } 6104db63379SBarry Smith 61180670ca5SBarry Smith if (!matnest) { /* use the matrix blocksize and stride IS to determine the index sets that define the submatrices */ 61251f519a2SBarry Smith bs = jac->bs; 6139566063dSJacob Faibussowitsch PetscCall(MatGetOwnershipRange(pc->pmat, &rstart, &rend)); 6141b9fc7fcSBarry Smith nslots = (rend - rstart) / bs; 6151b9fc7fcSBarry Smith for (i = 0; i < nsplit; i++) { 6161b9fc7fcSBarry Smith if (jac->defaultsplit) { 6179566063dSJacob Faibussowitsch PetscCall(ISCreateStride(PetscObjectComm((PetscObject)pc), nslots, rstart + i, nsplit, &ilink->is)); 6189566063dSJacob Faibussowitsch PetscCall(ISDuplicate(ilink->is, &ilink->is_col)); 619704ba839SBarry Smith } else if (!ilink->is) { 620ccb205f8SBarry Smith if (ilink->nfields > 1) { 6215f4ab4e1SJungho Lee PetscInt *ii, *jj, j, k, nfields = ilink->nfields, *fields = ilink->fields, *fields_col = ilink->fields_col; 62280670ca5SBarry Smith 6239566063dSJacob Faibussowitsch PetscCall(PetscMalloc1(ilink->nfields * nslots, &ii)); 6249566063dSJacob Faibussowitsch PetscCall(PetscMalloc1(ilink->nfields * nslots, &jj)); 6251b9fc7fcSBarry Smith for (j = 0; j < nslots; j++) { 6261b9fc7fcSBarry Smith for (k = 0; k < nfields; k++) { 6271b9fc7fcSBarry Smith ii[nfields * j + k] = rstart + bs * j + fields[k]; 6285f4ab4e1SJungho Lee jj[nfields * j + k] = rstart + bs * j + fields_col[k]; 62997bbdb24SBarry Smith } 63097bbdb24SBarry Smith } 6319566063dSJacob Faibussowitsch PetscCall(ISCreateGeneral(PetscObjectComm((PetscObject)pc), nslots * nfields, ii, PETSC_OWN_POINTER, &ilink->is)); 6329566063dSJacob Faibussowitsch PetscCall(ISCreateGeneral(PetscObjectComm((PetscObject)pc), nslots * nfields, jj, PETSC_OWN_POINTER, &ilink->is_col)); 6339566063dSJacob Faibussowitsch PetscCall(ISSetBlockSize(ilink->is, nfields)); 6349566063dSJacob Faibussowitsch PetscCall(ISSetBlockSize(ilink->is_col, nfields)); 635ccb205f8SBarry Smith } else { 6369566063dSJacob Faibussowitsch PetscCall(ISCreateStride(PetscObjectComm((PetscObject)pc), nslots, rstart + ilink->fields[0], bs, &ilink->is)); 6379566063dSJacob Faibussowitsch PetscCall(ISCreateStride(PetscObjectComm((PetscObject)pc), nslots, rstart + ilink->fields_col[0], bs, &ilink->is_col)); 638ccb205f8SBarry Smith } 6393e197d65SBarry Smith } 6409566063dSJacob Faibussowitsch PetscCall(ISSorted(ilink->is, &sorted)); 6419566063dSJacob Faibussowitsch if (ilink->is_col) PetscCall(ISSorted(ilink->is_col, &sorted_col)); 6427827d75bSBarry Smith PetscCheck(sorted && sorted_col, PETSC_COMM_SELF, PETSC_ERR_USER, "Fields must be sorted when creating split"); 643704ba839SBarry Smith ilink = ilink->next; 6441b9fc7fcSBarry Smith } 64580670ca5SBarry Smith } else { /* use the IS that define the MATNEST to determine the index sets that define the submatrices */ 64680670ca5SBarry Smith IS *rowis, *colis, *ises = NULL; 64780670ca5SBarry Smith PetscInt mis, nis; 64880670ca5SBarry Smith 64980670ca5SBarry Smith PetscCall(MatNestGetSize(pc->pmat, &mis, &nis)); 65080670ca5SBarry Smith PetscCall(PetscMalloc2(mis, &rowis, nis, &colis)); 65180670ca5SBarry Smith PetscCall(MatNestGetISs(pc->pmat, rowis, colis)); 65280670ca5SBarry Smith if (!jac->defaultsplit) PetscCall(PetscMalloc1(mis, &ises)); 65380670ca5SBarry Smith 65480670ca5SBarry Smith for (i = 0; i < nsplit; i++) { 65580670ca5SBarry Smith if (jac->defaultsplit) { 65680670ca5SBarry Smith PetscCall(ISDuplicate(rowis[i], &ilink->is)); 65780670ca5SBarry Smith PetscCall(ISDuplicate(ilink->is, &ilink->is_col)); 65880670ca5SBarry Smith } else if (!ilink->is) { 65980670ca5SBarry Smith if (ilink->nfields > 1) { 66080670ca5SBarry Smith for (PetscInt j = 0; j < ilink->nfields; j++) ises[j] = rowis[ilink->fields[j]]; 66180670ca5SBarry Smith PetscCall(ISConcatenate(PetscObjectComm((PetscObject)pc), ilink->nfields, ises, &ilink->is)); 66280670ca5SBarry Smith } else { 66380670ca5SBarry Smith PetscCall(ISDuplicate(rowis[ilink->fields[0]], &ilink->is)); 66480670ca5SBarry Smith } 66580670ca5SBarry Smith PetscCall(ISDuplicate(ilink->is, &ilink->is_col)); 66680670ca5SBarry Smith } 66780670ca5SBarry Smith ilink = ilink->next; 66880670ca5SBarry Smith } 66980670ca5SBarry Smith PetscCall(PetscFree2(rowis, colis)); 67080670ca5SBarry Smith PetscCall(PetscFree(ises)); 67180670ca5SBarry Smith } 6721b9fc7fcSBarry Smith } 6731b9fc7fcSBarry Smith 674704ba839SBarry Smith ilink = jac->head; 67597bbdb24SBarry Smith if (!jac->pmat) { 676bdddcaaaSMatthew G Knepley Vec xtmp; 677bdddcaaaSMatthew G Knepley 6789566063dSJacob Faibussowitsch PetscCall(MatCreateVecs(pc->pmat, &xtmp, NULL)); 6799566063dSJacob Faibussowitsch PetscCall(PetscMalloc1(nsplit, &jac->pmat)); 6809566063dSJacob Faibussowitsch PetscCall(PetscMalloc2(nsplit, &jac->x, nsplit, &jac->y)); 681cf502942SBarry Smith for (i = 0; i < nsplit; i++) { 682bdddcaaaSMatthew G Knepley MatNullSpace sp; 683bdddcaaaSMatthew G Knepley 684a3df900dSMatthew G Knepley /* Check for preconditioning matrix attached to IS */ 6859566063dSJacob Faibussowitsch PetscCall(PetscObjectQuery((PetscObject)ilink->is, "pmat", (PetscObject *)&jac->pmat[i])); 686a3df900dSMatthew G Knepley if (jac->pmat[i]) { 6879566063dSJacob Faibussowitsch PetscCall(PetscObjectReference((PetscObject)jac->pmat[i])); 688a3df900dSMatthew G Knepley if (jac->type == PC_COMPOSITE_SCHUR) { 689a3df900dSMatthew G Knepley jac->schur_user = jac->pmat[i]; 6902fa5cd67SKarl Rupp 6919566063dSJacob Faibussowitsch PetscCall(PetscObjectReference((PetscObject)jac->schur_user)); 692a3df900dSMatthew G Knepley } 693a3df900dSMatthew G Knepley } else { 6943a062f41SBarry Smith const char *prefix; 6959566063dSJacob Faibussowitsch PetscCall(MatCreateSubMatrix(pc->pmat, ilink->is, ilink->is_col, MAT_INITIAL_MATRIX, &jac->pmat[i])); 6962f427464SPierre Jolivet PetscCall(MatGetOptionsPrefix(jac->pmat[i], &prefix)); 6972f427464SPierre Jolivet if (!prefix) { 6989566063dSJacob Faibussowitsch PetscCall(KSPGetOptionsPrefix(ilink->ksp, &prefix)); 6999566063dSJacob Faibussowitsch PetscCall(MatSetOptionsPrefix(jac->pmat[i], prefix)); 7002f427464SPierre Jolivet } 70145881c45SPierre Jolivet PetscCall(MatSetFromOptions(jac->pmat[i])); 7029566063dSJacob Faibussowitsch PetscCall(MatViewFromOptions(jac->pmat[i], NULL, "-mat_view")); 703a3df900dSMatthew G Knepley } 704bdddcaaaSMatthew G Knepley /* create work vectors for each split */ 7059566063dSJacob Faibussowitsch PetscCall(MatCreateVecs(jac->pmat[i], &jac->x[i], &jac->y[i])); 7069371c9d4SSatish Balay ilink->x = jac->x[i]; 7079371c9d4SSatish Balay ilink->y = jac->y[i]; 7089371c9d4SSatish Balay ilink->z = NULL; 709bdddcaaaSMatthew G Knepley /* compute scatter contexts needed by multiplicative versions and non-default splits */ 7109566063dSJacob Faibussowitsch PetscCall(VecScatterCreate(xtmp, ilink->is, jac->x[i], NULL, &ilink->sctx)); 7119566063dSJacob Faibussowitsch PetscCall(PetscObjectQuery((PetscObject)ilink->is, "nearnullspace", (PetscObject *)&sp)); 71248a46eb9SPierre Jolivet if (sp) PetscCall(MatSetNearNullSpace(jac->pmat[i], sp)); 713704ba839SBarry Smith ilink = ilink->next; 714cf502942SBarry Smith } 7159566063dSJacob Faibussowitsch PetscCall(VecDestroy(&xtmp)); 71697bbdb24SBarry Smith } else { 717ef7efd37SHong Zhang MatReuse scall; 7184849c82aSBarry Smith MatNullSpace *nullsp = NULL; 7194849c82aSBarry Smith 720ef7efd37SHong Zhang if (pc->flag == DIFFERENT_NONZERO_PATTERN) { 7214849c82aSBarry Smith PetscCall(MatGetNullSpaces(nsplit, jac->pmat, &nullsp)); 72248a46eb9SPierre Jolivet for (i = 0; i < nsplit; i++) PetscCall(MatDestroy(&jac->pmat[i])); 723ef7efd37SHong Zhang scall = MAT_INITIAL_MATRIX; 724ef7efd37SHong Zhang } else scall = MAT_REUSE_MATRIX; 725ef7efd37SHong Zhang 726cf502942SBarry Smith for (i = 0; i < nsplit; i++) { 727a3df900dSMatthew G Knepley Mat pmat; 728a3df900dSMatthew G Knepley 729a3df900dSMatthew G Knepley /* Check for preconditioning matrix attached to IS */ 7309566063dSJacob Faibussowitsch PetscCall(PetscObjectQuery((PetscObject)ilink->is, "pmat", (PetscObject *)&pmat)); 73148a46eb9SPierre Jolivet if (!pmat) PetscCall(MatCreateSubMatrix(pc->pmat, ilink->is, ilink->is_col, scall, &jac->pmat[i])); 732704ba839SBarry Smith ilink = ilink->next; 733cf502942SBarry Smith } 7344849c82aSBarry Smith if (nullsp) PetscCall(MatRestoreNullSpaces(nsplit, jac->pmat, &nullsp)); 73597bbdb24SBarry Smith } 7364e39094bSDmitry Karpeev if (jac->diag_use_amat) { 737519d70e2SJed Brown ilink = jac->head; 738519d70e2SJed Brown if (!jac->mat) { 7399566063dSJacob Faibussowitsch PetscCall(PetscMalloc1(nsplit, &jac->mat)); 740519d70e2SJed Brown for (i = 0; i < nsplit; i++) { 7419566063dSJacob Faibussowitsch PetscCall(MatCreateSubMatrix(pc->mat, ilink->is, ilink->is_col, MAT_INITIAL_MATRIX, &jac->mat[i])); 742519d70e2SJed Brown ilink = ilink->next; 743519d70e2SJed Brown } 744519d70e2SJed Brown } else { 745ef7efd37SHong Zhang MatReuse scall; 7464849c82aSBarry Smith MatNullSpace *nullsp = NULL; 7474849c82aSBarry Smith 748ef7efd37SHong Zhang if (pc->flag == DIFFERENT_NONZERO_PATTERN) { 7494849c82aSBarry Smith PetscCall(MatGetNullSpaces(nsplit, jac->mat, &nullsp)); 75048a46eb9SPierre Jolivet for (i = 0; i < nsplit; i++) PetscCall(MatDestroy(&jac->mat[i])); 751ef7efd37SHong Zhang scall = MAT_INITIAL_MATRIX; 752ef7efd37SHong Zhang } else scall = MAT_REUSE_MATRIX; 753ef7efd37SHong Zhang 754ef7efd37SHong Zhang for (i = 0; i < nsplit; i++) { 7559566063dSJacob Faibussowitsch PetscCall(MatCreateSubMatrix(pc->mat, ilink->is, ilink->is_col, scall, &jac->mat[i])); 756519d70e2SJed Brown ilink = ilink->next; 757519d70e2SJed Brown } 7584849c82aSBarry Smith if (nullsp) PetscCall(MatRestoreNullSpaces(nsplit, jac->mat, &nullsp)); 759519d70e2SJed Brown } 760519d70e2SJed Brown } else { 761519d70e2SJed Brown jac->mat = jac->pmat; 762519d70e2SJed Brown } 76397bbdb24SBarry Smith 76453935eafSBarry Smith /* Check for null space attached to IS */ 76553935eafSBarry Smith ilink = jac->head; 76653935eafSBarry Smith for (i = 0; i < nsplit; i++) { 76753935eafSBarry Smith MatNullSpace sp; 76853935eafSBarry Smith 7699566063dSJacob Faibussowitsch PetscCall(PetscObjectQuery((PetscObject)ilink->is, "nullspace", (PetscObject *)&sp)); 77048a46eb9SPierre Jolivet if (sp) PetscCall(MatSetNullSpace(jac->mat[i], sp)); 77153935eafSBarry Smith ilink = ilink->next; 77253935eafSBarry Smith } 77353935eafSBarry Smith 774a51937d4SCarola Kruse if (jac->type != PC_COMPOSITE_ADDITIVE && jac->type != PC_COMPOSITE_SCHUR && jac->type != PC_COMPOSITE_GKB) { 77568dd23aaSBarry Smith /* extract the rows of the matrix associated with each field: used for efficient computation of residual inside algorithm */ 7764e39094bSDmitry Karpeev /* FIXME: Can/should we reuse jac->mat whenever (jac->diag_use_amat) is true? */ 77768dd23aaSBarry Smith ilink = jac->head; 778e52d2c62SBarry Smith if (nsplit == 2 && jac->type == PC_COMPOSITE_MULTIPLICATIVE) { 779e52d2c62SBarry 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 */ 780e52d2c62SBarry Smith if (!jac->Afield) { 7819566063dSJacob Faibussowitsch PetscCall(PetscCalloc1(nsplit, &jac->Afield)); 78280c96bb1SFande Kong if (jac->offdiag_use_amat) { 7839566063dSJacob Faibussowitsch PetscCall(MatCreateSubMatrix(pc->mat, ilink->next->is, ilink->is, MAT_INITIAL_MATRIX, &jac->Afield[1])); 784e52d2c62SBarry Smith } else { 7859566063dSJacob Faibussowitsch PetscCall(MatCreateSubMatrix(pc->pmat, ilink->next->is, ilink->is, MAT_INITIAL_MATRIX, &jac->Afield[1])); 78680c96bb1SFande Kong } 78780c96bb1SFande Kong } else { 788ef7efd37SHong Zhang MatReuse scall; 789e9422dd5SStefano Zampini 790ef7efd37SHong Zhang if (pc->flag == DIFFERENT_NONZERO_PATTERN) { 7919566063dSJacob Faibussowitsch PetscCall(MatDestroy(&jac->Afield[1])); 792ef7efd37SHong Zhang scall = MAT_INITIAL_MATRIX; 793ef7efd37SHong Zhang } else scall = MAT_REUSE_MATRIX; 794ef7efd37SHong Zhang 79580c96bb1SFande Kong if (jac->offdiag_use_amat) { 7969566063dSJacob Faibussowitsch PetscCall(MatCreateSubMatrix(pc->mat, ilink->next->is, ilink->is, scall, &jac->Afield[1])); 79780c96bb1SFande Kong } else { 7989566063dSJacob Faibussowitsch PetscCall(MatCreateSubMatrix(pc->pmat, ilink->next->is, ilink->is, scall, &jac->Afield[1])); 79980c96bb1SFande Kong } 800e52d2c62SBarry Smith } 801e52d2c62SBarry Smith } else { 80268dd23aaSBarry Smith if (!jac->Afield) { 8039566063dSJacob Faibussowitsch PetscCall(PetscMalloc1(nsplit, &jac->Afield)); 80468dd23aaSBarry Smith for (i = 0; i < nsplit; i++) { 80580c96bb1SFande Kong if (jac->offdiag_use_amat) { 8069566063dSJacob Faibussowitsch PetscCall(MatCreateSubMatrix(pc->mat, ilink->is, NULL, MAT_INITIAL_MATRIX, &jac->Afield[i])); 80780c96bb1SFande Kong } else { 8089566063dSJacob Faibussowitsch PetscCall(MatCreateSubMatrix(pc->pmat, ilink->is, NULL, MAT_INITIAL_MATRIX, &jac->Afield[i])); 80980c96bb1SFande Kong } 81068dd23aaSBarry Smith ilink = ilink->next; 81168dd23aaSBarry Smith } 81268dd23aaSBarry Smith } else { 813ef7efd37SHong Zhang MatReuse scall; 814ef7efd37SHong Zhang if (pc->flag == DIFFERENT_NONZERO_PATTERN) { 81548a46eb9SPierre Jolivet for (i = 0; i < nsplit; i++) PetscCall(MatDestroy(&jac->Afield[i])); 816ef7efd37SHong Zhang scall = MAT_INITIAL_MATRIX; 817ef7efd37SHong Zhang } else scall = MAT_REUSE_MATRIX; 818ef7efd37SHong Zhang 81968dd23aaSBarry Smith for (i = 0; i < nsplit; i++) { 82080c96bb1SFande Kong if (jac->offdiag_use_amat) { 8219566063dSJacob Faibussowitsch PetscCall(MatCreateSubMatrix(pc->mat, ilink->is, NULL, scall, &jac->Afield[i])); 82280c96bb1SFande Kong } else { 8239566063dSJacob Faibussowitsch PetscCall(MatCreateSubMatrix(pc->pmat, ilink->is, NULL, scall, &jac->Afield[i])); 82480c96bb1SFande Kong } 82568dd23aaSBarry Smith ilink = ilink->next; 82668dd23aaSBarry Smith } 82768dd23aaSBarry Smith } 82868dd23aaSBarry Smith } 829e52d2c62SBarry Smith } 83068dd23aaSBarry Smith 8313b224e63SBarry Smith if (jac->type == PC_COMPOSITE_SCHUR) { 8323b224e63SBarry Smith IS ccis; 833b94d7dedSBarry Smith PetscBool isset, isspd; 8344aa3045dSJed Brown PetscInt rstart, rend; 835093c86ffSJed Brown char lscname[256]; 836093c86ffSJed Brown PetscObject LSC_L; 837558f3fe8SPierre Jolivet PetscBool set, flg; 838ce94432eSBarry Smith 83908401ef6SPierre Jolivet PetscCheck(nsplit == 2, PetscObjectComm((PetscObject)pc), PETSC_ERR_ARG_INCOMP, "To use Schur complement preconditioner you must have exactly 2 fields"); 84068dd23aaSBarry Smith 841c096484dSStefano Zampini /* If pc->mat is SPD, don't scale by -1 the Schur complement */ 842c096484dSStefano Zampini if (jac->schurscale == (PetscScalar)-1.0) { 843b94d7dedSBarry Smith PetscCall(MatIsSPDKnown(pc->pmat, &isset, &isspd)); 844b94d7dedSBarry Smith jac->schurscale = (isset && isspd) ? 1.0 : -1.0; 845c096484dSStefano Zampini } 846c096484dSStefano Zampini 847e6cab6aaSJed Brown /* When extracting off-diagonal submatrices, we take complements from this range */ 8489566063dSJacob Faibussowitsch PetscCall(MatGetOwnershipRangeColumn(pc->mat, &rstart, &rend)); 849558f3fe8SPierre Jolivet PetscCall(PetscObjectTypeCompareAny(jac->offdiag_use_amat ? (PetscObject)pc->mat : (PetscObject)pc->pmat, &flg, MATSEQSBAIJ, MATMPISBAIJ, "")); 850e6cab6aaSJed Brown 8513b224e63SBarry Smith if (jac->schur) { 8520298fd71SBarry Smith KSP kspA = jac->head->ksp, kspInner = NULL, kspUpper = jac->kspupper; 853e9422dd5SStefano Zampini MatReuse scall; 854e9422dd5SStefano Zampini 855e9422dd5SStefano Zampini if (pc->flag == DIFFERENT_NONZERO_PATTERN) { 856e9422dd5SStefano Zampini scall = MAT_INITIAL_MATRIX; 8579566063dSJacob Faibussowitsch PetscCall(MatDestroy(&jac->B)); 8589566063dSJacob Faibussowitsch PetscCall(MatDestroy(&jac->C)); 859e9422dd5SStefano Zampini } else scall = MAT_REUSE_MATRIX; 860443836d0SMatthew G Knepley 8619566063dSJacob Faibussowitsch PetscCall(MatSchurComplementGetKSP(jac->schur, &kspInner)); 8623b224e63SBarry Smith ilink = jac->head; 8639566063dSJacob Faibussowitsch PetscCall(ISComplement(ilink->is_col, rstart, rend, &ccis)); 8644e39094bSDmitry Karpeev if (jac->offdiag_use_amat) { 8659566063dSJacob Faibussowitsch PetscCall(MatCreateSubMatrix(pc->mat, ilink->is, ccis, scall, &jac->B)); 866c84da90fSDmitry Karpeev } else { 8679566063dSJacob Faibussowitsch PetscCall(MatCreateSubMatrix(pc->pmat, ilink->is, ccis, scall, &jac->B)); 868c84da90fSDmitry Karpeev } 8699566063dSJacob Faibussowitsch PetscCall(ISDestroy(&ccis)); 870558f3fe8SPierre Jolivet if (!flg) { 8713b224e63SBarry Smith ilink = ilink->next; 8729566063dSJacob Faibussowitsch PetscCall(ISComplement(ilink->is_col, rstart, rend, &ccis)); 8734e39094bSDmitry Karpeev if (jac->offdiag_use_amat) { 8749566063dSJacob Faibussowitsch PetscCall(MatCreateSubMatrix(pc->mat, ilink->is, ccis, scall, &jac->C)); 875c84da90fSDmitry Karpeev } else { 8769566063dSJacob Faibussowitsch PetscCall(MatCreateSubMatrix(pc->pmat, ilink->is, ccis, scall, &jac->C)); 877c84da90fSDmitry Karpeev } 8789566063dSJacob Faibussowitsch PetscCall(ISDestroy(&ccis)); 879558f3fe8SPierre Jolivet } else { 880558f3fe8SPierre Jolivet PetscCall(MatIsHermitianKnown(jac->offdiag_use_amat ? pc->mat : pc->pmat, &set, &flg)); 881558f3fe8SPierre Jolivet if (set && flg) PetscCall(MatCreateHermitianTranspose(jac->B, &jac->C)); 882558f3fe8SPierre Jolivet else PetscCall(MatCreateTranspose(jac->B, &jac->C)); 883558f3fe8SPierre Jolivet } 8849566063dSJacob Faibussowitsch PetscCall(MatSchurComplementUpdateSubMatrices(jac->schur, jac->mat[0], jac->pmat[0], jac->B, jac->C, jac->mat[1])); 885a7476a74SDmitry Karpeev if (jac->schurpre == PC_FIELDSPLIT_SCHUR_PRE_SELFP) { 8869566063dSJacob Faibussowitsch PetscCall(MatDestroy(&jac->schurp)); 8879566063dSJacob Faibussowitsch PetscCall(MatSchurComplementGetPmat(jac->schur, MAT_INITIAL_MATRIX, &jac->schurp)); 888d9eadc85SPierre Jolivet } else if (jac->schurpre == PC_FIELDSPLIT_SCHUR_PRE_FULL) { 889d9eadc85SPierre Jolivet PetscCall(MatDestroy(&jac->schur_user)); 890d9eadc85SPierre Jolivet if (jac->kspupper == jac->head->ksp) { 891d9eadc85SPierre Jolivet Mat AinvB; 892d9eadc85SPierre Jolivet 893d9eadc85SPierre Jolivet PetscCall(PetscObjectQuery((PetscObject)jac->schur, "AinvB", (PetscObject *)&AinvB)); 894d9eadc85SPierre Jolivet PetscCall(MatDestroy(&AinvB)); 895d9eadc85SPierre Jolivet PetscCall(MatCreate(PetscObjectComm((PetscObject)jac->schur), &AinvB)); 896d9eadc85SPierre Jolivet PetscCall(PetscObjectCompose((PetscObject)jac->schur, "AinvB", (PetscObject)AinvB)); 897d9eadc85SPierre Jolivet } 898d9eadc85SPierre Jolivet PetscCall(MatSchurComplementComputeExplicitOperator(jac->schur, &jac->schur_user)); 899a7476a74SDmitry Karpeev } 90048a46eb9SPierre Jolivet if (kspA != kspInner) PetscCall(KSPSetOperators(kspA, jac->mat[0], jac->pmat[0])); 90148a46eb9SPierre Jolivet if (kspUpper != kspA) PetscCall(KSPSetOperators(kspUpper, jac->mat[0], jac->pmat[0])); 9029566063dSJacob Faibussowitsch PetscCall(KSPSetOperators(jac->kspschur, jac->schur, FieldSplitSchurPre(jac))); 9033b224e63SBarry Smith } else { 904bafc1b83SMatthew G Knepley const char *Dprefix; 905470b340bSDmitry Karpeev char schurprefix[256], schurmatprefix[256]; 906514bf10dSMatthew G Knepley char schurtestoption[256]; 907bdddcaaaSMatthew G Knepley MatNullSpace sp; 908686bed4dSStefano Zampini KSP kspt; 9093b224e63SBarry Smith 910a04f6461SBarry Smith /* extract the A01 and A10 matrices */ 9113b224e63SBarry Smith ilink = jac->head; 9129566063dSJacob Faibussowitsch PetscCall(ISComplement(ilink->is_col, rstart, rend, &ccis)); 9134e39094bSDmitry Karpeev if (jac->offdiag_use_amat) { 9149566063dSJacob Faibussowitsch PetscCall(MatCreateSubMatrix(pc->mat, ilink->is, ccis, MAT_INITIAL_MATRIX, &jac->B)); 915c84da90fSDmitry Karpeev } else { 9169566063dSJacob Faibussowitsch PetscCall(MatCreateSubMatrix(pc->pmat, ilink->is, ccis, MAT_INITIAL_MATRIX, &jac->B)); 917c84da90fSDmitry Karpeev } 9189566063dSJacob Faibussowitsch PetscCall(ISDestroy(&ccis)); 9193b224e63SBarry Smith ilink = ilink->next; 920558f3fe8SPierre Jolivet if (!flg) { 9219566063dSJacob Faibussowitsch PetscCall(ISComplement(ilink->is_col, rstart, rend, &ccis)); 9224e39094bSDmitry Karpeev if (jac->offdiag_use_amat) { 9239566063dSJacob Faibussowitsch PetscCall(MatCreateSubMatrix(pc->mat, ilink->is, ccis, MAT_INITIAL_MATRIX, &jac->C)); 924c84da90fSDmitry Karpeev } else { 9259566063dSJacob Faibussowitsch PetscCall(MatCreateSubMatrix(pc->pmat, ilink->is, ccis, MAT_INITIAL_MATRIX, &jac->C)); 926c84da90fSDmitry Karpeev } 9279566063dSJacob Faibussowitsch PetscCall(ISDestroy(&ccis)); 928558f3fe8SPierre Jolivet } else { 929558f3fe8SPierre Jolivet PetscCall(MatIsHermitianKnown(jac->offdiag_use_amat ? pc->mat : pc->pmat, &set, &flg)); 930558f3fe8SPierre Jolivet if (set && flg) PetscCall(MatCreateHermitianTranspose(jac->B, &jac->C)); 931558f3fe8SPierre Jolivet else PetscCall(MatCreateTranspose(jac->B, &jac->C)); 932558f3fe8SPierre Jolivet } 933f5236f50SJed Brown /* Use mat[0] (diagonal block of Amat) preconditioned by pmat[0] to define Schur complement */ 9349566063dSJacob Faibussowitsch PetscCall(MatCreate(((PetscObject)jac->mat[0])->comm, &jac->schur)); 9359566063dSJacob Faibussowitsch PetscCall(MatSetType(jac->schur, MATSCHURCOMPLEMENT)); 9369566063dSJacob Faibussowitsch PetscCall(MatSchurComplementSetSubMatrices(jac->schur, jac->mat[0], jac->pmat[0], jac->B, jac->C, jac->mat[1])); 9379566063dSJacob Faibussowitsch PetscCall(PetscSNPrintf(schurmatprefix, sizeof(schurmatprefix), "%sfieldsplit_%s_", ((PetscObject)pc)->prefix ? ((PetscObject)pc)->prefix : "", ilink->splitname)); 9389566063dSJacob Faibussowitsch PetscCall(MatSetOptionsPrefix(jac->schur, schurmatprefix)); 9399566063dSJacob Faibussowitsch PetscCall(MatSchurComplementGetKSP(jac->schur, &kspt)); 9409566063dSJacob Faibussowitsch PetscCall(KSPSetOptionsPrefix(kspt, schurmatprefix)); 941686bed4dSStefano Zampini 942686bed4dSStefano Zampini /* Note: this is not true in general */ 9439566063dSJacob Faibussowitsch PetscCall(MatGetNullSpace(jac->mat[1], &sp)); 9441baa6e33SBarry Smith if (sp) PetscCall(MatSetNullSpace(jac->schur, sp)); 94520252d06SBarry Smith 9469566063dSJacob Faibussowitsch PetscCall(PetscSNPrintf(schurtestoption, sizeof(schurtestoption), "-fieldsplit_%s_inner_", ilink->splitname)); 94754a546c1SMatthew G. Knepley PetscCall(PetscOptionsFindPairPrefix_Private(((PetscObject)pc)->options, ((PetscObject)pc)->prefix, schurtestoption, NULL, NULL, &flg)); 948514bf10dSMatthew G Knepley if (flg) { 949514bf10dSMatthew G Knepley DM dmInner; 95021635b76SJed Brown KSP kspInner; 951686bed4dSStefano Zampini PC pcInner; 95221635b76SJed Brown 9539566063dSJacob Faibussowitsch PetscCall(MatSchurComplementGetKSP(jac->schur, &kspInner)); 9549566063dSJacob Faibussowitsch PetscCall(KSPReset(kspInner)); 9559566063dSJacob Faibussowitsch PetscCall(KSPSetOperators(kspInner, jac->mat[0], jac->pmat[0])); 9569566063dSJacob Faibussowitsch PetscCall(PetscSNPrintf(schurprefix, sizeof(schurprefix), "%sfieldsplit_%s_inner_", ((PetscObject)pc)->prefix ? ((PetscObject)pc)->prefix : "", ilink->splitname)); 95721635b76SJed Brown /* Indent this deeper to emphasize the "inner" nature of this solver. */ 9589566063dSJacob Faibussowitsch PetscCall(PetscObjectIncrementTabLevel((PetscObject)kspInner, (PetscObject)pc, 2)); 9599566063dSJacob Faibussowitsch PetscCall(PetscObjectIncrementTabLevel((PetscObject)kspInner->pc, (PetscObject)pc, 2)); 9609566063dSJacob Faibussowitsch PetscCall(KSPSetOptionsPrefix(kspInner, schurprefix)); 961514bf10dSMatthew G Knepley 962514bf10dSMatthew G Knepley /* Set DM for new solver */ 9639566063dSJacob Faibussowitsch PetscCall(KSPGetDM(jac->head->ksp, &dmInner)); 9649566063dSJacob Faibussowitsch PetscCall(KSPSetDM(kspInner, dmInner)); 9659566063dSJacob Faibussowitsch PetscCall(KSPSetDMActive(kspInner, PETSC_FALSE)); 966686bed4dSStefano Zampini 967686bed4dSStefano Zampini /* Defaults to PCKSP as preconditioner */ 9689566063dSJacob Faibussowitsch PetscCall(KSPGetPC(kspInner, &pcInner)); 9699566063dSJacob Faibussowitsch PetscCall(PCSetType(pcInner, PCKSP)); 9709566063dSJacob Faibussowitsch PetscCall(PCKSPSetKSP(pcInner, jac->head->ksp)); 971514bf10dSMatthew G Knepley } else { 97221635b76SJed Brown /* Use the outer solver for the inner solve, but revert the KSPPREONLY from PCFieldSplitSetFields_FieldSplit or 97321635b76SJed Brown * PCFieldSplitSetIS_FieldSplit. We don't want KSPPREONLY because it makes the Schur complement inexact, 97421635b76SJed Brown * preventing Schur complement reduction to be an accurate solve. Usually when an iterative solver is used for 97521635b76SJed 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 97621635b76SJed Brown * GMRES the default. Note that it is also common to use PREONLY for S, in which case S may not be used 97721635b76SJed Brown * directly, and the user is responsible for setting an inexact method for fieldsplit's A^{-1}. */ 9789566063dSJacob Faibussowitsch PetscCall(KSPSetType(jac->head->ksp, KSPGMRES)); 9799566063dSJacob Faibussowitsch PetscCall(MatSchurComplementSetKSP(jac->schur, jac->head->ksp)); 980bafc1b83SMatthew G Knepley } 9819566063dSJacob Faibussowitsch PetscCall(KSPSetOperators(jac->head->ksp, jac->mat[0], jac->pmat[0])); 9829566063dSJacob Faibussowitsch PetscCall(KSPSetFromOptions(jac->head->ksp)); 9839566063dSJacob Faibussowitsch PetscCall(MatSetFromOptions(jac->schur)); 9843b224e63SBarry Smith 9859566063dSJacob Faibussowitsch PetscCall(PetscObjectTypeCompare((PetscObject)jac->schur, MATSCHURCOMPLEMENT, &flg)); 986686bed4dSStefano Zampini if (flg) { /* Need to do this otherwise PCSetUp_KSP will overwrite the amat of jac->head->ksp */ 987686bed4dSStefano Zampini KSP kspInner; 988686bed4dSStefano Zampini PC pcInner; 989686bed4dSStefano Zampini 9909566063dSJacob Faibussowitsch PetscCall(MatSchurComplementGetKSP(jac->schur, &kspInner)); 9919566063dSJacob Faibussowitsch PetscCall(KSPGetPC(kspInner, &pcInner)); 9929566063dSJacob Faibussowitsch PetscCall(PetscObjectTypeCompare((PetscObject)pcInner, PCKSP, &flg)); 993686bed4dSStefano Zampini if (flg) { 994686bed4dSStefano Zampini KSP ksp; 995686bed4dSStefano Zampini 9969566063dSJacob Faibussowitsch PetscCall(PCKSPGetKSP(pcInner, &ksp)); 99748a46eb9SPierre Jolivet if (ksp == jac->head->ksp) PetscCall(PCSetUseAmat(pcInner, PETSC_TRUE)); 998686bed4dSStefano Zampini } 999686bed4dSStefano Zampini } 10009566063dSJacob Faibussowitsch PetscCall(PetscSNPrintf(schurtestoption, sizeof(schurtestoption), "-fieldsplit_%s_upper_", ilink->splitname)); 100154a546c1SMatthew G. Knepley PetscCall(PetscOptionsFindPairPrefix_Private(((PetscObject)pc)->options, ((PetscObject)pc)->prefix, schurtestoption, NULL, NULL, &flg)); 1002443836d0SMatthew G Knepley if (flg) { 1003443836d0SMatthew G Knepley DM dmInner; 1004443836d0SMatthew G Knepley 10059566063dSJacob Faibussowitsch PetscCall(PetscSNPrintf(schurprefix, sizeof(schurprefix), "%sfieldsplit_%s_upper_", ((PetscObject)pc)->prefix ? ((PetscObject)pc)->prefix : "", ilink->splitname)); 10069566063dSJacob Faibussowitsch PetscCall(KSPCreate(PetscObjectComm((PetscObject)pc), &jac->kspupper)); 10073821be0aSBarry Smith PetscCall(KSPSetNestLevel(jac->kspupper, pc->kspnestlevel)); 10089566063dSJacob Faibussowitsch PetscCall(KSPSetErrorIfNotConverged(jac->kspupper, pc->erroriffailure)); 10099566063dSJacob Faibussowitsch PetscCall(KSPSetOptionsPrefix(jac->kspupper, schurprefix)); 10109566063dSJacob Faibussowitsch PetscCall(PetscObjectIncrementTabLevel((PetscObject)jac->kspupper, (PetscObject)pc, 1)); 10119566063dSJacob Faibussowitsch PetscCall(PetscObjectIncrementTabLevel((PetscObject)jac->kspupper->pc, (PetscObject)pc, 1)); 10129566063dSJacob Faibussowitsch PetscCall(KSPGetDM(jac->head->ksp, &dmInner)); 10139566063dSJacob Faibussowitsch PetscCall(KSPSetDM(jac->kspupper, dmInner)); 10149566063dSJacob Faibussowitsch PetscCall(KSPSetDMActive(jac->kspupper, PETSC_FALSE)); 10159566063dSJacob Faibussowitsch PetscCall(KSPSetFromOptions(jac->kspupper)); 10169566063dSJacob Faibussowitsch PetscCall(KSPSetOperators(jac->kspupper, jac->mat[0], jac->pmat[0])); 10179566063dSJacob Faibussowitsch PetscCall(VecDuplicate(jac->head->x, &jac->head->z)); 1018443836d0SMatthew G Knepley } else { 1019443836d0SMatthew G Knepley jac->kspupper = jac->head->ksp; 10209566063dSJacob Faibussowitsch PetscCall(PetscObjectReference((PetscObject)jac->head->ksp)); 1021443836d0SMatthew G Knepley } 1022443836d0SMatthew G Knepley 102348a46eb9SPierre Jolivet if (jac->schurpre == PC_FIELDSPLIT_SCHUR_PRE_SELFP) PetscCall(MatSchurComplementGetPmat(jac->schur, MAT_INITIAL_MATRIX, &jac->schurp)); 10249566063dSJacob Faibussowitsch PetscCall(KSPCreate(PetscObjectComm((PetscObject)pc), &jac->kspschur)); 10253821be0aSBarry Smith PetscCall(KSPSetNestLevel(jac->kspschur, pc->kspnestlevel)); 10269566063dSJacob Faibussowitsch PetscCall(KSPSetErrorIfNotConverged(jac->kspschur, pc->erroriffailure)); 10279566063dSJacob Faibussowitsch PetscCall(PetscObjectIncrementTabLevel((PetscObject)jac->kspschur, (PetscObject)pc, 1)); 1028084e4875SJed Brown if (jac->schurpre == PC_FIELDSPLIT_SCHUR_PRE_SELF) { 10297233a360SDmitry Karpeev PC pcschur; 10309566063dSJacob Faibussowitsch PetscCall(KSPGetPC(jac->kspschur, &pcschur)); 10319566063dSJacob Faibussowitsch PetscCall(PCSetType(pcschur, PCNONE)); 1032084e4875SJed Brown /* Note: This is bad if there exist preconditioners for MATSCHURCOMPLEMENT */ 1033e74569cdSMatthew G. Knepley } else if (jac->schurpre == PC_FIELDSPLIT_SCHUR_PRE_FULL) { 1034d9eadc85SPierre Jolivet if (jac->schurfactorization == PC_FIELDSPLIT_SCHUR_FACT_FULL && jac->kspupper == jac->head->ksp) { 1035d9eadc85SPierre Jolivet Mat AinvB; 1036d9eadc85SPierre Jolivet 1037d9eadc85SPierre Jolivet PetscCall(MatCreate(PetscObjectComm((PetscObject)jac->schur), &AinvB)); 1038d9eadc85SPierre Jolivet PetscCall(PetscObjectCompose((PetscObject)jac->schur, "AinvB", (PetscObject)AinvB)); 1039d9eadc85SPierre Jolivet } 10409566063dSJacob Faibussowitsch PetscCall(MatSchurComplementComputeExplicitOperator(jac->schur, &jac->schur_user)); 1041e69d4d44SBarry Smith } 10429566063dSJacob Faibussowitsch PetscCall(KSPSetOperators(jac->kspschur, jac->schur, FieldSplitSchurPre(jac))); 10439566063dSJacob Faibussowitsch PetscCall(KSPGetOptionsPrefix(jac->head->next->ksp, &Dprefix)); 10449566063dSJacob Faibussowitsch PetscCall(KSPSetOptionsPrefix(jac->kspschur, Dprefix)); 1045c096484dSStefano Zampini /* propagate DM */ 1046b20b4189SMatthew G. Knepley { 1047b20b4189SMatthew G. Knepley DM sdm; 10489566063dSJacob Faibussowitsch PetscCall(KSPGetDM(jac->head->next->ksp, &sdm)); 1049b20b4189SMatthew G. Knepley if (sdm) { 10509566063dSJacob Faibussowitsch PetscCall(KSPSetDM(jac->kspschur, sdm)); 10519566063dSJacob Faibussowitsch PetscCall(KSPSetDMActive(jac->kspschur, PETSC_FALSE)); 1052b20b4189SMatthew G. Knepley } 1053b20b4189SMatthew G. Knepley } 10543b224e63SBarry Smith /* really want setfromoptions called in PCSetFromOptions_FieldSplit(), but it is not ready yet */ 105520b26d62SBarry Smith /* need to call this every time, since the jac->kspschur is freshly created, otherwise its options never get set */ 10569566063dSJacob Faibussowitsch PetscCall(KSPSetFromOptions(jac->kspschur)); 10573b224e63SBarry Smith } 10589566063dSJacob Faibussowitsch PetscCall(MatAssemblyBegin(jac->schur, MAT_FINAL_ASSEMBLY)); 10599566063dSJacob Faibussowitsch PetscCall(MatAssemblyEnd(jac->schur, MAT_FINAL_ASSEMBLY)); 1060093c86ffSJed Brown 1061093c86ffSJed Brown /* HACK: special support to forward L and Lp matrices that might be used by PCLSC */ 10629566063dSJacob Faibussowitsch PetscCall(PetscSNPrintf(lscname, sizeof(lscname), "%s_LSC_L", ilink->splitname)); 10639566063dSJacob Faibussowitsch PetscCall(PetscObjectQuery((PetscObject)pc->mat, lscname, (PetscObject *)&LSC_L)); 10649566063dSJacob Faibussowitsch if (!LSC_L) PetscCall(PetscObjectQuery((PetscObject)pc->pmat, lscname, (PetscObject *)&LSC_L)); 10659566063dSJacob Faibussowitsch if (LSC_L) PetscCall(PetscObjectCompose((PetscObject)jac->schur, "LSC_L", (PetscObject)LSC_L)); 10669566063dSJacob Faibussowitsch PetscCall(PetscSNPrintf(lscname, sizeof(lscname), "%s_LSC_Lp", ilink->splitname)); 10679566063dSJacob Faibussowitsch PetscCall(PetscObjectQuery((PetscObject)pc->pmat, lscname, (PetscObject *)&LSC_L)); 10689566063dSJacob Faibussowitsch if (!LSC_L) PetscCall(PetscObjectQuery((PetscObject)pc->mat, lscname, (PetscObject *)&LSC_L)); 10699566063dSJacob Faibussowitsch if (LSC_L) PetscCall(PetscObjectCompose((PetscObject)jac->schur, "LSC_Lp", (PetscObject)LSC_L)); 1070a51937d4SCarola Kruse } else if (jac->type == PC_COMPOSITE_GKB) { 1071a51937d4SCarola Kruse IS ccis; 1072a51937d4SCarola Kruse PetscInt rstart, rend; 1073a51937d4SCarola Kruse 107408401ef6SPierre Jolivet PetscCheck(nsplit == 2, PetscObjectComm((PetscObject)pc), PETSC_ERR_ARG_INCOMP, "To use GKB preconditioner you must have exactly 2 fields"); 1075a51937d4SCarola Kruse 1076a51937d4SCarola Kruse ilink = jac->head; 1077a51937d4SCarola Kruse 1078a51937d4SCarola Kruse /* When extracting off-diagonal submatrices, we take complements from this range */ 10799566063dSJacob Faibussowitsch PetscCall(MatGetOwnershipRangeColumn(pc->mat, &rstart, &rend)); 1080a51937d4SCarola Kruse 10819566063dSJacob Faibussowitsch PetscCall(ISComplement(ilink->is_col, rstart, rend, &ccis)); 1082a51937d4SCarola Kruse if (jac->offdiag_use_amat) { 10839566063dSJacob Faibussowitsch PetscCall(MatCreateSubMatrix(pc->mat, ilink->is, ccis, MAT_INITIAL_MATRIX, &jac->B)); 1084a51937d4SCarola Kruse } else { 10859566063dSJacob Faibussowitsch PetscCall(MatCreateSubMatrix(pc->pmat, ilink->is, ccis, MAT_INITIAL_MATRIX, &jac->B)); 1086a51937d4SCarola Kruse } 10879566063dSJacob Faibussowitsch PetscCall(ISDestroy(&ccis)); 1088e071a0a4SCarola Kruse /* Create work vectors for GKB algorithm */ 10899566063dSJacob Faibussowitsch PetscCall(VecDuplicate(ilink->x, &jac->u)); 10909566063dSJacob Faibussowitsch PetscCall(VecDuplicate(ilink->x, &jac->Hu)); 10919566063dSJacob Faibussowitsch PetscCall(VecDuplicate(ilink->x, &jac->w2)); 1092a51937d4SCarola Kruse ilink = ilink->next; 10939566063dSJacob Faibussowitsch PetscCall(ISComplement(ilink->is_col, rstart, rend, &ccis)); 1094a51937d4SCarola Kruse if (jac->offdiag_use_amat) { 10959566063dSJacob Faibussowitsch PetscCall(MatCreateSubMatrix(pc->mat, ilink->is, ccis, MAT_INITIAL_MATRIX, &jac->C)); 1096a51937d4SCarola Kruse } else { 10979566063dSJacob Faibussowitsch PetscCall(MatCreateSubMatrix(pc->pmat, ilink->is, ccis, MAT_INITIAL_MATRIX, &jac->C)); 1098a51937d4SCarola Kruse } 10999566063dSJacob Faibussowitsch PetscCall(ISDestroy(&ccis)); 1100e071a0a4SCarola Kruse /* Create work vectors for GKB algorithm */ 11019566063dSJacob Faibussowitsch PetscCall(VecDuplicate(ilink->x, &jac->v)); 11029566063dSJacob Faibussowitsch PetscCall(VecDuplicate(ilink->x, &jac->d)); 11039566063dSJacob Faibussowitsch PetscCall(VecDuplicate(ilink->x, &jac->w1)); 11049566063dSJacob Faibussowitsch PetscCall(MatGolubKahanComputeExplicitOperator(jac->mat[0], jac->B, jac->C, &jac->H, jac->gkbnu)); 11059566063dSJacob Faibussowitsch PetscCall(PetscCalloc1(jac->gkbdelay, &jac->vecz)); 1106e071a0a4SCarola Kruse 1107a51937d4SCarola Kruse ilink = jac->head; 11089566063dSJacob Faibussowitsch PetscCall(KSPSetOperators(ilink->ksp, jac->H, jac->H)); 11099566063dSJacob Faibussowitsch if (!jac->suboptionsset) PetscCall(KSPSetFromOptions(ilink->ksp)); 1110e071a0a4SCarola Kruse /* Create gkb_monitor context */ 1111de482cd7SCarola Kruse if (jac->gkbmonitor) { 1112de482cd7SCarola Kruse PetscInt tablevel; 11139566063dSJacob Faibussowitsch PetscCall(PetscViewerCreate(PETSC_COMM_WORLD, &jac->gkbviewer)); 11149566063dSJacob Faibussowitsch PetscCall(PetscViewerSetType(jac->gkbviewer, PETSCVIEWERASCII)); 11159566063dSJacob Faibussowitsch PetscCall(PetscObjectGetTabLevel((PetscObject)ilink->ksp, &tablevel)); 11169566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIISetTab(jac->gkbviewer, tablevel)); 11179566063dSJacob Faibussowitsch PetscCall(PetscObjectIncrementTabLevel((PetscObject)ilink->ksp, (PetscObject)ilink->ksp, 1)); 1118de482cd7SCarola Kruse } 11193b224e63SBarry Smith } else { 112068bd789dSDmitry Karpeev /* set up the individual splits' PCs */ 112197bbdb24SBarry Smith i = 0; 11225a9f2f41SSatish Balay ilink = jac->head; 11235a9f2f41SSatish Balay while (ilink) { 11249566063dSJacob Faibussowitsch PetscCall(KSPSetOperators(ilink->ksp, jac->mat[i], jac->pmat[i])); 11253b224e63SBarry Smith /* really want setfromoptions called in PCSetFromOptions_FieldSplit(), but it is not ready yet */ 11269566063dSJacob Faibussowitsch if (!jac->suboptionsset) PetscCall(KSPSetFromOptions(ilink->ksp)); 112797bbdb24SBarry Smith i++; 11285a9f2f41SSatish Balay ilink = ilink->next; 11290971522cSBarry Smith } 11303b224e63SBarry Smith } 11313b224e63SBarry Smith 11325ddf11f8SNicolas Barnafi /* Set coordinates to the sub PC objects whenever these are set */ 11335ddf11f8SNicolas Barnafi if (jac->coordinates_set) { 11345ddf11f8SNicolas Barnafi PC pc_coords; 11355ddf11f8SNicolas Barnafi if (jac->type == PC_COMPOSITE_SCHUR) { 11365ddf11f8SNicolas Barnafi // Head is first block. 11379566063dSJacob Faibussowitsch PetscCall(KSPGetPC(jac->head->ksp, &pc_coords)); 11389566063dSJacob Faibussowitsch PetscCall(PCSetCoordinates(pc_coords, jac->head->dim, jac->head->ndofs, jac->head->coords)); 11395ddf11f8SNicolas Barnafi // Second one is Schur block, but its KSP object is in kspschur. 11409566063dSJacob Faibussowitsch PetscCall(KSPGetPC(jac->kspschur, &pc_coords)); 11419566063dSJacob Faibussowitsch PetscCall(PCSetCoordinates(pc_coords, jac->head->next->dim, jac->head->next->ndofs, jac->head->next->coords)); 11425ddf11f8SNicolas Barnafi } else if (jac->type == PC_COMPOSITE_GKB) { 11439d3446b2SPierre Jolivet PetscCall(PetscInfo(pc, "Warning: Setting coordinates does nothing for the GKB Fieldpslit preconditioner\n")); 11445ddf11f8SNicolas Barnafi } else { 11455ddf11f8SNicolas Barnafi ilink = jac->head; 11465ddf11f8SNicolas Barnafi while (ilink) { 11479566063dSJacob Faibussowitsch PetscCall(KSPGetPC(ilink->ksp, &pc_coords)); 11489566063dSJacob Faibussowitsch PetscCall(PCSetCoordinates(pc_coords, ilink->dim, ilink->ndofs, ilink->coords)); 11495ddf11f8SNicolas Barnafi ilink = ilink->next; 11505ddf11f8SNicolas Barnafi } 11515ddf11f8SNicolas Barnafi } 11525ddf11f8SNicolas Barnafi } 11535ddf11f8SNicolas Barnafi 1154c1570756SJed Brown jac->suboptionsset = PETSC_TRUE; 11553ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 11560971522cSBarry Smith } 11570971522cSBarry Smith 11585a9f2f41SSatish Balay #define FieldSplitSplitSolveAdd(ilink, xx, yy) \ 11593ba16761SJacob Faibussowitsch ((PetscErrorCode)(VecScatterBegin(ilink->sctx, xx, ilink->x, INSERT_VALUES, SCATTER_FORWARD) || VecScatterEnd(ilink->sctx, xx, ilink->x, INSERT_VALUES, SCATTER_FORWARD) || PetscLogEventBegin(ilink->event, ilink->ksp, ilink->x, ilink->y, NULL) || \ 11609371c9d4SSatish 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) || \ 11613ba16761SJacob Faibussowitsch VecScatterEnd(ilink->sctx, ilink->y, yy, ADD_VALUES, SCATTER_REVERSE))) 116279416396SBarry Smith 1163d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCApply_FieldSplit_Schur(PC pc, Vec x, Vec y) 1164d71ae5a4SJacob Faibussowitsch { 11653b224e63SBarry Smith PC_FieldSplit *jac = (PC_FieldSplit *)pc->data; 11663b224e63SBarry Smith PC_FieldSplitLink ilinkA = jac->head, ilinkD = ilinkA->next; 1167443836d0SMatthew G Knepley KSP kspA = ilinkA->ksp, kspLower = kspA, kspUpper = jac->kspupper; 1168d9eadc85SPierre Jolivet Mat AinvB = NULL; 1169d9eadc85SPierre Jolivet PetscInt N = -1; 11703b224e63SBarry Smith 11713b224e63SBarry Smith PetscFunctionBegin; 1172c5d2311dSJed Brown switch (jac->schurfactorization) { 1173c9c6ffaaSJed Brown case PC_FIELDSPLIT_SCHUR_FACT_DIAG: 1174a04f6461SBarry Smith /* [A00 0; 0 -S], positive definite, suitable for MINRES */ 11759566063dSJacob Faibussowitsch PetscCall(VecScatterBegin(ilinkA->sctx, x, ilinkA->x, INSERT_VALUES, SCATTER_FORWARD)); 11769566063dSJacob Faibussowitsch PetscCall(VecScatterBegin(ilinkD->sctx, x, ilinkD->x, INSERT_VALUES, SCATTER_FORWARD)); 11779566063dSJacob Faibussowitsch PetscCall(VecScatterEnd(ilinkA->sctx, x, ilinkA->x, INSERT_VALUES, SCATTER_FORWARD)); 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(PetscLogEventEnd(ilinkA->event, kspA, ilinkA->x, ilinkA->y, NULL)); 11829566063dSJacob Faibussowitsch PetscCall(VecScatterBegin(ilinkA->sctx, ilinkA->y, y, INSERT_VALUES, SCATTER_REVERSE)); 11839566063dSJacob Faibussowitsch PetscCall(VecScatterEnd(ilinkD->sctx, x, ilinkD->x, INSERT_VALUES, SCATTER_FORWARD)); 11849566063dSJacob Faibussowitsch PetscCall(PetscLogEventBegin(KSP_Solve_FS_S, jac->kspschur, ilinkD->x, ilinkD->y, NULL)); 1185e0b7e82fSBarry Smith PetscCall(PetscObjectIncrementTabLevel((PetscObject)kspA, (PetscObject)kspA, 1)); 11869566063dSJacob Faibussowitsch PetscCall(KSPSolve(jac->kspschur, ilinkD->x, ilinkD->y)); 11879566063dSJacob Faibussowitsch PetscCall(KSPCheckSolve(jac->kspschur, pc, ilinkD->y)); 1188e0b7e82fSBarry Smith PetscCall(PetscObjectIncrementTabLevel((PetscObject)kspA, (PetscObject)kspA, -1)); 11899566063dSJacob Faibussowitsch PetscCall(PetscLogEventEnd(KSP_Solve_FS_S, jac->kspschur, ilinkD->x, ilinkD->y, NULL)); 11909566063dSJacob Faibussowitsch PetscCall(VecScale(ilinkD->y, jac->schurscale)); 11919566063dSJacob Faibussowitsch PetscCall(VecScatterEnd(ilinkA->sctx, ilinkA->y, y, INSERT_VALUES, SCATTER_REVERSE)); 11929566063dSJacob Faibussowitsch PetscCall(VecScatterBegin(ilinkD->sctx, ilinkD->y, y, INSERT_VALUES, SCATTER_REVERSE)); 11939566063dSJacob Faibussowitsch PetscCall(VecScatterEnd(ilinkD->sctx, ilinkD->y, y, INSERT_VALUES, SCATTER_REVERSE)); 1194c5d2311dSJed Brown break; 1195c9c6ffaaSJed Brown case PC_FIELDSPLIT_SCHUR_FACT_LOWER: 1196a04f6461SBarry Smith /* [A00 0; A10 S], suitable for left preconditioning */ 11979566063dSJacob Faibussowitsch PetscCall(VecScatterBegin(ilinkA->sctx, x, ilinkA->x, INSERT_VALUES, SCATTER_FORWARD)); 11989566063dSJacob Faibussowitsch PetscCall(VecScatterEnd(ilinkA->sctx, x, ilinkA->x, INSERT_VALUES, SCATTER_FORWARD)); 11999566063dSJacob Faibussowitsch PetscCall(PetscLogEventBegin(ilinkA->event, kspA, ilinkA->x, ilinkA->y, NULL)); 12009566063dSJacob Faibussowitsch PetscCall(KSPSolve(kspA, ilinkA->x, ilinkA->y)); 12019566063dSJacob Faibussowitsch PetscCall(KSPCheckSolve(kspA, pc, ilinkA->y)); 12029566063dSJacob Faibussowitsch PetscCall(PetscLogEventEnd(ilinkA->event, kspA, ilinkA->x, ilinkA->y, NULL)); 12039566063dSJacob Faibussowitsch PetscCall(MatMult(jac->C, ilinkA->y, ilinkD->x)); 12049566063dSJacob Faibussowitsch PetscCall(VecScale(ilinkD->x, -1.)); 12059566063dSJacob Faibussowitsch PetscCall(VecScatterBegin(ilinkD->sctx, x, ilinkD->x, ADD_VALUES, SCATTER_FORWARD)); 12069566063dSJacob Faibussowitsch PetscCall(VecScatterBegin(ilinkA->sctx, ilinkA->y, y, INSERT_VALUES, SCATTER_REVERSE)); 12079566063dSJacob Faibussowitsch PetscCall(VecScatterEnd(ilinkD->sctx, x, ilinkD->x, ADD_VALUES, SCATTER_FORWARD)); 12089566063dSJacob Faibussowitsch PetscCall(PetscLogEventBegin(KSP_Solve_FS_S, jac->kspschur, ilinkD->x, ilinkD->y, NULL)); 1209e0b7e82fSBarry Smith PetscCall(PetscObjectIncrementTabLevel((PetscObject)kspA, (PetscObject)kspA, 1)); 12109566063dSJacob Faibussowitsch PetscCall(KSPSolve(jac->kspschur, ilinkD->x, ilinkD->y)); 1211e0b7e82fSBarry Smith PetscCall(PetscObjectIncrementTabLevel((PetscObject)kspA, (PetscObject)kspA, -1)); 12129566063dSJacob Faibussowitsch PetscCall(KSPCheckSolve(jac->kspschur, pc, ilinkD->y)); 12139566063dSJacob Faibussowitsch PetscCall(PetscLogEventEnd(KSP_Solve_FS_S, jac->kspschur, ilinkD->x, ilinkD->y, NULL)); 12149566063dSJacob Faibussowitsch PetscCall(VecScatterEnd(ilinkA->sctx, ilinkA->y, y, INSERT_VALUES, SCATTER_REVERSE)); 12159566063dSJacob Faibussowitsch PetscCall(VecScatterBegin(ilinkD->sctx, ilinkD->y, y, INSERT_VALUES, SCATTER_REVERSE)); 12169566063dSJacob Faibussowitsch PetscCall(VecScatterEnd(ilinkD->sctx, ilinkD->y, y, INSERT_VALUES, SCATTER_REVERSE)); 1217c5d2311dSJed Brown break; 1218c9c6ffaaSJed Brown case PC_FIELDSPLIT_SCHUR_FACT_UPPER: 1219a04f6461SBarry Smith /* [A00 A01; 0 S], suitable for right preconditioning */ 12209566063dSJacob Faibussowitsch PetscCall(VecScatterBegin(ilinkD->sctx, x, ilinkD->x, INSERT_VALUES, SCATTER_FORWARD)); 12219566063dSJacob Faibussowitsch PetscCall(VecScatterEnd(ilinkD->sctx, x, ilinkD->x, INSERT_VALUES, SCATTER_FORWARD)); 12229566063dSJacob Faibussowitsch PetscCall(PetscLogEventBegin(KSP_Solve_FS_S, jac->kspschur, ilinkD->x, ilinkD->y, NULL)); 1223e0b7e82fSBarry Smith PetscCall(PetscObjectIncrementTabLevel((PetscObject)kspA, (PetscObject)kspA, 1)); 12249566063dSJacob Faibussowitsch PetscCall(KSPSolve(jac->kspschur, ilinkD->x, ilinkD->y)); 1225e0b7e82fSBarry Smith PetscCall(PetscObjectIncrementTabLevel((PetscObject)kspA, (PetscObject)kspA, -1)); 12269566063dSJacob Faibussowitsch PetscCall(KSPCheckSolve(jac->kspschur, pc, ilinkD->y)); 12279371c9d4SSatish Balay PetscCall(PetscLogEventEnd(KSP_Solve_FS_S, jac->kspschur, ilinkD->x, ilinkD->y, NULL)); 12289371c9d4SSatish Balay PetscCall(MatMult(jac->B, ilinkD->y, ilinkA->x)); 12299566063dSJacob Faibussowitsch PetscCall(VecScale(ilinkA->x, -1.)); 12309566063dSJacob Faibussowitsch PetscCall(VecScatterBegin(ilinkA->sctx, x, ilinkA->x, ADD_VALUES, SCATTER_FORWARD)); 12319566063dSJacob Faibussowitsch PetscCall(VecScatterBegin(ilinkD->sctx, ilinkD->y, y, INSERT_VALUES, SCATTER_REVERSE)); 12329566063dSJacob Faibussowitsch PetscCall(VecScatterEnd(ilinkA->sctx, x, ilinkA->x, ADD_VALUES, SCATTER_FORWARD)); 12339566063dSJacob Faibussowitsch PetscCall(PetscLogEventBegin(ilinkA->event, kspA, ilinkA->x, ilinkA->y, NULL)); 12349566063dSJacob Faibussowitsch PetscCall(KSPSolve(kspA, ilinkA->x, ilinkA->y)); 12359566063dSJacob Faibussowitsch PetscCall(KSPCheckSolve(kspA, pc, ilinkA->y)); 12369566063dSJacob Faibussowitsch PetscCall(PetscLogEventEnd(ilinkA->event, kspA, ilinkA->x, ilinkA->y, NULL)); 12379566063dSJacob Faibussowitsch PetscCall(VecScatterEnd(ilinkD->sctx, ilinkD->y, y, INSERT_VALUES, SCATTER_REVERSE)); 12389566063dSJacob Faibussowitsch PetscCall(VecScatterBegin(ilinkA->sctx, ilinkA->y, y, INSERT_VALUES, SCATTER_REVERSE)); 12399566063dSJacob Faibussowitsch PetscCall(VecScatterEnd(ilinkA->sctx, ilinkA->y, y, INSERT_VALUES, SCATTER_REVERSE)); 1240c5d2311dSJed Brown break; 1241c9c6ffaaSJed Brown case PC_FIELDSPLIT_SCHUR_FACT_FULL: 1242c238f8cdSStefano Zampini /* [1 0; A10 A00^{-1} 1] [A00 0; 0 S] [1 A00^{-1}A01; 0 1] */ 12439566063dSJacob Faibussowitsch PetscCall(VecScatterBegin(ilinkA->sctx, x, ilinkA->x, INSERT_VALUES, SCATTER_FORWARD)); 12449566063dSJacob Faibussowitsch PetscCall(VecScatterEnd(ilinkA->sctx, x, ilinkA->x, INSERT_VALUES, SCATTER_FORWARD)); 12459566063dSJacob Faibussowitsch PetscCall(PetscLogEventBegin(KSP_Solve_FS_L, kspLower, ilinkA->x, ilinkA->y, NULL)); 1246d9eadc85SPierre Jolivet if (kspUpper == kspA) { 1247d9eadc85SPierre Jolivet PetscCall(PetscObjectQuery((PetscObject)jac->schur, "AinvB", (PetscObject *)&AinvB)); 1248d9eadc85SPierre Jolivet if (AinvB) { 1249d9eadc85SPierre Jolivet PetscCall(MatGetSize(AinvB, NULL, &N)); 1250d9eadc85SPierre Jolivet if (N == -1) { // first time PCApply_FieldSplit_Schur() is called 1251d9eadc85SPierre Jolivet Mat A; 1252*f7cbcdf3SPierre Jolivet VecType vtype; 1253*f7cbcdf3SPierre Jolivet PetscMemType mtype; 1254*f7cbcdf3SPierre Jolivet Vec column, c; 1255d9eadc85SPierre Jolivet const PetscScalar *read; 1256*f7cbcdf3SPierre Jolivet PetscScalar *array; 1257*f7cbcdf3SPierre Jolivet PetscInt m, M, N; 1258d9eadc85SPierre Jolivet 1259d9eadc85SPierre Jolivet PetscCall(MatGetSize(jac->B, &M, &N)); 1260d9eadc85SPierre Jolivet PetscCall(MatGetLocalSize(jac->B, &m, NULL)); 1261*f7cbcdf3SPierre Jolivet PetscCall(MatGetVecType(jac->B, &vtype)); 1262*f7cbcdf3SPierre Jolivet PetscCall(VecGetArrayReadAndMemType(ilinkA->x, &read, &mtype)); 1263*f7cbcdf3SPierre Jolivet if (PetscMemTypeHost(mtype) || (!PetscDefined(HAVE_CUDA) && !PetscDefined(HAVE_HIP))) { 1264*f7cbcdf3SPierre Jolivet PetscCall(PetscMalloc1(m * (N + 1), &array)); 1265*f7cbcdf3SPierre Jolivet PetscCall(VecCreateMPIWithArray(PetscObjectComm((PetscObject)jac->schur), 1, m, M, array + m * N, &c)); 1266*f7cbcdf3SPierre Jolivet } 1267*f7cbcdf3SPierre Jolivet #if PetscDefined(HAVE_CUDA) 1268*f7cbcdf3SPierre Jolivet else if (PetscMemTypeCUDA(mtype)) { 1269*f7cbcdf3SPierre Jolivet PetscCallCUDA(cudaMalloc((void **)&array, sizeof(PetscScalar) * m * (N + 1))); 1270*f7cbcdf3SPierre Jolivet PetscCall(VecCreateMPICUDAWithArray(PetscObjectComm((PetscObject)jac->schur), 1, m, M, array + m * N, &c)); 1271*f7cbcdf3SPierre Jolivet } 1272*f7cbcdf3SPierre Jolivet #endif 1273*f7cbcdf3SPierre Jolivet #if PetscDefined(HAVE_HIP) 1274*f7cbcdf3SPierre Jolivet else if (PetscMemTypeHIP(mtype)) { 1275*f7cbcdf3SPierre Jolivet PetscCallHIP(hipMalloc((void **)&array, sizeof(PetscScalar) * m * (N + 1))); 1276*f7cbcdf3SPierre Jolivet PetscCall(VecCreateMPIHIPWithArray(PetscObjectComm((PetscObject)jac->schur), 1, m, M, array + m * N, &c)); 1277*f7cbcdf3SPierre Jolivet } 1278*f7cbcdf3SPierre Jolivet #endif 1279*f7cbcdf3SPierre Jolivet PetscCall(VecRestoreArrayReadAndMemType(ilinkA->x, &read)); 1280*f7cbcdf3SPierre Jolivet PetscCall(MatCreateDenseFromVecType(PetscObjectComm((PetscObject)jac->schur), vtype, m, PETSC_DECIDE, M, N + 1, -1, array, &A)); // number of columns of the Schur complement plus one 1281*f7cbcdf3SPierre Jolivet PetscCall(MatDenseGetColumnVecWrite(A, N, &column)); 1282*f7cbcdf3SPierre Jolivet PetscCall(VecCopy(ilinkA->x, column)); 1283*f7cbcdf3SPierre Jolivet PetscCall(MatDenseRestoreColumnVecWrite(A, N, &column)); 1284d9eadc85SPierre Jolivet PetscCall(MatHeaderReplace(AinvB, &A)); 1285d9eadc85SPierre Jolivet PetscCall(MatSchurComplementComputeExplicitOperator(jac->schur, &jac->schur_user)); 1286d9eadc85SPierre Jolivet PetscCall(KSPSetOperators(jac->kspschur, jac->schur, jac->schur_user)); 1287*f7cbcdf3SPierre Jolivet PetscCall(VecCopy(c, ilinkA->y)); // retrieve the solution as the last column of the composed Mat 1288*f7cbcdf3SPierre Jolivet PetscCall(VecDestroy(&c)); 1289d9eadc85SPierre Jolivet } 1290d9eadc85SPierre Jolivet } 1291d9eadc85SPierre Jolivet } 1292d9eadc85SPierre Jolivet if (!AinvB || N != -1) PetscCall(KSPSolve(kspLower, ilinkA->x, ilinkA->y)); 12939566063dSJacob Faibussowitsch PetscCall(KSPCheckSolve(kspLower, pc, ilinkA->y)); 12949566063dSJacob Faibussowitsch PetscCall(PetscLogEventEnd(KSP_Solve_FS_L, kspLower, ilinkA->x, ilinkA->y, NULL)); 12959566063dSJacob Faibussowitsch PetscCall(MatMult(jac->C, ilinkA->y, ilinkD->x)); 12969566063dSJacob Faibussowitsch PetscCall(VecScale(ilinkD->x, -1.0)); 12979566063dSJacob Faibussowitsch PetscCall(VecScatterBegin(ilinkD->sctx, x, ilinkD->x, ADD_VALUES, SCATTER_FORWARD)); 12989566063dSJacob Faibussowitsch PetscCall(VecScatterEnd(ilinkD->sctx, x, ilinkD->x, ADD_VALUES, SCATTER_FORWARD)); 12993b224e63SBarry Smith 13009566063dSJacob Faibussowitsch PetscCall(PetscLogEventBegin(KSP_Solve_FS_S, jac->kspschur, ilinkD->x, ilinkD->y, NULL)); 1301e0b7e82fSBarry Smith PetscCall(PetscObjectIncrementTabLevel((PetscObject)kspA, (PetscObject)kspA, 1)); 13029566063dSJacob Faibussowitsch PetscCall(KSPSolve(jac->kspschur, ilinkD->x, ilinkD->y)); 1303e0b7e82fSBarry Smith PetscCall(PetscObjectIncrementTabLevel((PetscObject)kspA, (PetscObject)kspA, -1)); 13049566063dSJacob Faibussowitsch PetscCall(KSPCheckSolve(jac->kspschur, pc, ilinkD->y)); 13059566063dSJacob Faibussowitsch PetscCall(PetscLogEventEnd(KSP_Solve_FS_S, jac->kspschur, ilinkD->x, ilinkD->y, NULL)); 13069566063dSJacob Faibussowitsch PetscCall(VecScatterBegin(ilinkD->sctx, ilinkD->y, y, INSERT_VALUES, SCATTER_REVERSE)); 13073b224e63SBarry Smith 1308443836d0SMatthew G Knepley if (kspUpper == kspA) { 1309d9eadc85SPierre Jolivet if (!AinvB) { 13109566063dSJacob Faibussowitsch PetscCall(MatMult(jac->B, ilinkD->y, ilinkA->y)); 13119566063dSJacob Faibussowitsch PetscCall(VecAXPY(ilinkA->x, -1.0, ilinkA->y)); 13129566063dSJacob Faibussowitsch PetscCall(PetscLogEventBegin(ilinkA->event, kspA, ilinkA->x, ilinkA->y, NULL)); 13139566063dSJacob Faibussowitsch PetscCall(KSPSolve(kspA, ilinkA->x, ilinkA->y)); 13149566063dSJacob Faibussowitsch PetscCall(KSPCheckSolve(kspA, pc, ilinkA->y)); 13159566063dSJacob Faibussowitsch PetscCall(PetscLogEventEnd(ilinkA->event, kspA, ilinkA->x, ilinkA->y, NULL)); 1316d9eadc85SPierre Jolivet } else PetscCall(MatMultAdd(AinvB, ilinkD->y, ilinkA->y, ilinkA->y)); 1317443836d0SMatthew G Knepley } else { 13189566063dSJacob Faibussowitsch PetscCall(PetscLogEventBegin(ilinkA->event, kspA, ilinkA->x, ilinkA->y, NULL)); 13199566063dSJacob Faibussowitsch PetscCall(KSPSolve(kspA, ilinkA->x, ilinkA->y)); 13209566063dSJacob Faibussowitsch PetscCall(KSPCheckSolve(kspA, pc, ilinkA->y)); 13219566063dSJacob Faibussowitsch PetscCall(MatMult(jac->B, ilinkD->y, ilinkA->x)); 13229566063dSJacob Faibussowitsch PetscCall(PetscLogEventBegin(KSP_Solve_FS_U, kspUpper, ilinkA->x, ilinkA->z, NULL)); 13239566063dSJacob Faibussowitsch PetscCall(KSPSolve(kspUpper, ilinkA->x, ilinkA->z)); 13249566063dSJacob Faibussowitsch PetscCall(KSPCheckSolve(kspUpper, pc, ilinkA->z)); 13259566063dSJacob Faibussowitsch PetscCall(PetscLogEventEnd(KSP_Solve_FS_U, kspUpper, ilinkA->x, ilinkA->z, NULL)); 13269566063dSJacob Faibussowitsch PetscCall(VecAXPY(ilinkA->y, -1.0, ilinkA->z)); 1327443836d0SMatthew G Knepley } 13289566063dSJacob Faibussowitsch PetscCall(VecScatterEnd(ilinkD->sctx, ilinkD->y, y, INSERT_VALUES, SCATTER_REVERSE)); 13299566063dSJacob Faibussowitsch PetscCall(VecScatterBegin(ilinkA->sctx, ilinkA->y, y, INSERT_VALUES, SCATTER_REVERSE)); 13309566063dSJacob Faibussowitsch PetscCall(VecScatterEnd(ilinkA->sctx, ilinkA->y, y, INSERT_VALUES, SCATTER_REVERSE)); 1331c5d2311dSJed Brown } 13323ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 13333b224e63SBarry Smith } 13343b224e63SBarry Smith 13357b665727SPierre Jolivet static PetscErrorCode PCApplyTranspose_FieldSplit_Schur(PC pc, Vec x, Vec y) 13367b665727SPierre Jolivet { 13377b665727SPierre Jolivet PC_FieldSplit *jac = (PC_FieldSplit *)pc->data; 13387b665727SPierre Jolivet PC_FieldSplitLink ilinkA = jac->head, ilinkD = ilinkA->next; 13397b665727SPierre Jolivet KSP kspA = ilinkA->ksp, kspLower = kspA, kspUpper = jac->kspupper; 13407b665727SPierre Jolivet 13417b665727SPierre Jolivet PetscFunctionBegin; 13427b665727SPierre Jolivet switch (jac->schurfactorization) { 13437b665727SPierre Jolivet case PC_FIELDSPLIT_SCHUR_FACT_DIAG: 13447b665727SPierre Jolivet /* [A00 0; 0 -S], positive definite, suitable for MINRES */ 13457b665727SPierre Jolivet PetscCall(VecScatterBegin(ilinkA->sctx, x, ilinkA->x, INSERT_VALUES, SCATTER_FORWARD)); 13467b665727SPierre Jolivet PetscCall(VecScatterBegin(ilinkD->sctx, x, ilinkD->x, INSERT_VALUES, SCATTER_FORWARD)); 13477b665727SPierre Jolivet PetscCall(VecScatterEnd(ilinkA->sctx, x, ilinkA->x, INSERT_VALUES, SCATTER_FORWARD)); 13487b665727SPierre Jolivet PetscCall(PetscLogEventBegin(ilinkA->event, kspA, ilinkA->x, ilinkA->y, NULL)); 13497b665727SPierre Jolivet PetscCall(KSPSolveTranspose(kspA, ilinkA->x, ilinkA->y)); 13507b665727SPierre Jolivet PetscCall(KSPCheckSolve(kspA, pc, ilinkA->y)); 13517b665727SPierre Jolivet PetscCall(PetscLogEventEnd(ilinkA->event, kspA, ilinkA->x, ilinkA->y, NULL)); 13527b665727SPierre Jolivet PetscCall(VecScatterBegin(ilinkA->sctx, ilinkA->y, y, INSERT_VALUES, SCATTER_REVERSE)); 13537b665727SPierre Jolivet PetscCall(VecScatterEnd(ilinkD->sctx, x, ilinkD->x, INSERT_VALUES, SCATTER_FORWARD)); 13547b665727SPierre Jolivet PetscCall(PetscLogEventBegin(KSP_Solve_FS_S, jac->kspschur, ilinkD->x, ilinkD->y, NULL)); 1355e0b7e82fSBarry Smith PetscCall(PetscObjectIncrementTabLevel((PetscObject)kspA, (PetscObject)kspA, 1)); 13567b665727SPierre Jolivet PetscCall(KSPSolveTranspose(jac->kspschur, ilinkD->x, ilinkD->y)); 1357e0b7e82fSBarry Smith PetscCall(PetscObjectIncrementTabLevel((PetscObject)kspA, (PetscObject)kspA, -1)); 13587b665727SPierre Jolivet PetscCall(KSPCheckSolve(jac->kspschur, pc, ilinkD->y)); 13597b665727SPierre Jolivet PetscCall(PetscLogEventEnd(KSP_Solve_FS_S, jac->kspschur, ilinkD->x, ilinkD->y, NULL)); 13607b665727SPierre Jolivet PetscCall(VecScale(ilinkD->y, jac->schurscale)); 13617b665727SPierre Jolivet PetscCall(VecScatterEnd(ilinkA->sctx, ilinkA->y, y, INSERT_VALUES, SCATTER_REVERSE)); 13627b665727SPierre Jolivet PetscCall(VecScatterBegin(ilinkD->sctx, ilinkD->y, y, INSERT_VALUES, SCATTER_REVERSE)); 13637b665727SPierre Jolivet PetscCall(VecScatterEnd(ilinkD->sctx, ilinkD->y, y, INSERT_VALUES, SCATTER_REVERSE)); 13647b665727SPierre Jolivet break; 13657b665727SPierre Jolivet case PC_FIELDSPLIT_SCHUR_FACT_UPPER: 13667b665727SPierre Jolivet PetscCall(VecScatterBegin(ilinkA->sctx, x, ilinkA->x, INSERT_VALUES, SCATTER_FORWARD)); 13677b665727SPierre Jolivet PetscCall(VecScatterEnd(ilinkA->sctx, x, ilinkA->x, INSERT_VALUES, SCATTER_FORWARD)); 13687b665727SPierre Jolivet PetscCall(PetscLogEventBegin(ilinkA->event, kspA, ilinkA->x, ilinkA->y, NULL)); 13697b665727SPierre Jolivet PetscCall(KSPSolveTranspose(kspA, ilinkA->x, ilinkA->y)); 13707b665727SPierre Jolivet PetscCall(KSPCheckSolve(kspA, pc, ilinkA->y)); 13717b665727SPierre Jolivet PetscCall(PetscLogEventEnd(ilinkA->event, kspA, ilinkA->x, ilinkA->y, NULL)); 13727b665727SPierre Jolivet PetscCall(MatMultTranspose(jac->B, ilinkA->y, ilinkD->x)); 13737b665727SPierre Jolivet PetscCall(VecScale(ilinkD->x, -1.)); 13747b665727SPierre Jolivet PetscCall(VecScatterBegin(ilinkD->sctx, x, ilinkD->x, ADD_VALUES, SCATTER_FORWARD)); 13757b665727SPierre Jolivet PetscCall(VecScatterBegin(ilinkA->sctx, ilinkA->y, y, INSERT_VALUES, SCATTER_REVERSE)); 13767b665727SPierre Jolivet PetscCall(VecScatterEnd(ilinkD->sctx, x, ilinkD->x, ADD_VALUES, SCATTER_FORWARD)); 13777b665727SPierre Jolivet PetscCall(PetscLogEventBegin(KSP_Solve_FS_S, jac->kspschur, ilinkD->x, ilinkD->y, NULL)); 1378e0b7e82fSBarry Smith PetscCall(PetscObjectIncrementTabLevel((PetscObject)kspA, (PetscObject)kspA, 1)); 13797b665727SPierre Jolivet PetscCall(KSPSolveTranspose(jac->kspschur, ilinkD->x, ilinkD->y)); 1380e0b7e82fSBarry Smith PetscCall(PetscObjectIncrementTabLevel((PetscObject)kspA, (PetscObject)kspA, -1)); 13817b665727SPierre Jolivet PetscCall(KSPCheckSolve(jac->kspschur, pc, ilinkD->y)); 13827b665727SPierre Jolivet PetscCall(PetscLogEventEnd(KSP_Solve_FS_S, jac->kspschur, ilinkD->x, ilinkD->y, NULL)); 13837b665727SPierre Jolivet PetscCall(VecScatterEnd(ilinkA->sctx, ilinkA->y, y, INSERT_VALUES, SCATTER_REVERSE)); 13847b665727SPierre Jolivet PetscCall(VecScatterBegin(ilinkD->sctx, ilinkD->y, y, INSERT_VALUES, SCATTER_REVERSE)); 13857b665727SPierre Jolivet PetscCall(VecScatterEnd(ilinkD->sctx, ilinkD->y, y, INSERT_VALUES, SCATTER_REVERSE)); 13867b665727SPierre Jolivet break; 13877b665727SPierre Jolivet case PC_FIELDSPLIT_SCHUR_FACT_LOWER: 13887b665727SPierre Jolivet PetscCall(VecScatterBegin(ilinkD->sctx, x, ilinkD->x, INSERT_VALUES, SCATTER_FORWARD)); 13897b665727SPierre Jolivet PetscCall(VecScatterEnd(ilinkD->sctx, x, ilinkD->x, INSERT_VALUES, SCATTER_FORWARD)); 13907b665727SPierre Jolivet PetscCall(PetscLogEventBegin(KSP_Solve_FS_S, jac->kspschur, ilinkD->x, ilinkD->y, NULL)); 1391e0b7e82fSBarry Smith PetscCall(PetscObjectIncrementTabLevel((PetscObject)kspA, (PetscObject)kspA, 1)); 13927b665727SPierre Jolivet PetscCall(KSPSolveTranspose(jac->kspschur, ilinkD->x, ilinkD->y)); 1393e0b7e82fSBarry Smith PetscCall(PetscObjectIncrementTabLevel((PetscObject)kspA, (PetscObject)kspA, -1)); 13947b665727SPierre Jolivet PetscCall(KSPCheckSolve(jac->kspschur, pc, ilinkD->y)); 13957b665727SPierre Jolivet PetscCall(PetscLogEventEnd(KSP_Solve_FS_S, jac->kspschur, ilinkD->x, ilinkD->y, NULL)); 13967b665727SPierre Jolivet PetscCall(MatMultTranspose(jac->C, ilinkD->y, ilinkA->x)); 13977b665727SPierre Jolivet PetscCall(VecScale(ilinkA->x, -1.)); 13987b665727SPierre Jolivet PetscCall(VecScatterBegin(ilinkA->sctx, x, ilinkA->x, ADD_VALUES, SCATTER_FORWARD)); 13997b665727SPierre Jolivet PetscCall(VecScatterBegin(ilinkD->sctx, ilinkD->y, y, INSERT_VALUES, SCATTER_REVERSE)); 14007b665727SPierre Jolivet PetscCall(VecScatterEnd(ilinkA->sctx, x, ilinkA->x, ADD_VALUES, SCATTER_FORWARD)); 14017b665727SPierre Jolivet PetscCall(PetscLogEventBegin(ilinkA->event, kspA, ilinkA->x, ilinkA->y, NULL)); 14027b665727SPierre Jolivet PetscCall(KSPSolveTranspose(kspA, ilinkA->x, ilinkA->y)); 14037b665727SPierre Jolivet PetscCall(KSPCheckSolve(kspA, pc, ilinkA->y)); 14047b665727SPierre Jolivet PetscCall(PetscLogEventEnd(ilinkA->event, kspA, ilinkA->x, ilinkA->y, NULL)); 14057b665727SPierre Jolivet PetscCall(VecScatterEnd(ilinkD->sctx, ilinkD->y, y, INSERT_VALUES, SCATTER_REVERSE)); 14067b665727SPierre Jolivet PetscCall(VecScatterBegin(ilinkA->sctx, ilinkA->y, y, INSERT_VALUES, SCATTER_REVERSE)); 14077b665727SPierre Jolivet PetscCall(VecScatterEnd(ilinkA->sctx, ilinkA->y, y, INSERT_VALUES, SCATTER_REVERSE)); 14087b665727SPierre Jolivet break; 14097b665727SPierre Jolivet case PC_FIELDSPLIT_SCHUR_FACT_FULL: 14107b665727SPierre Jolivet PetscCall(VecScatterBegin(ilinkA->sctx, x, ilinkA->x, INSERT_VALUES, SCATTER_FORWARD)); 14117b665727SPierre Jolivet PetscCall(VecScatterEnd(ilinkA->sctx, x, ilinkA->x, INSERT_VALUES, SCATTER_FORWARD)); 14127b665727SPierre Jolivet PetscCall(PetscLogEventBegin(KSP_Solve_FS_U, kspUpper, ilinkA->x, ilinkA->y, NULL)); 14137b665727SPierre Jolivet PetscCall(KSPSolveTranspose(kspUpper, ilinkA->x, ilinkA->y)); 14147b665727SPierre Jolivet PetscCall(KSPCheckSolve(kspUpper, pc, ilinkA->y)); 14157b665727SPierre Jolivet PetscCall(PetscLogEventEnd(KSP_Solve_FS_U, kspUpper, ilinkA->x, ilinkA->y, NULL)); 14167b665727SPierre Jolivet PetscCall(MatMultTranspose(jac->B, ilinkA->y, ilinkD->x)); 14177b665727SPierre Jolivet PetscCall(VecScale(ilinkD->x, -1.0)); 14187b665727SPierre Jolivet PetscCall(VecScatterBegin(ilinkD->sctx, x, ilinkD->x, ADD_VALUES, SCATTER_FORWARD)); 14197b665727SPierre Jolivet PetscCall(VecScatterEnd(ilinkD->sctx, x, ilinkD->x, ADD_VALUES, SCATTER_FORWARD)); 14207b665727SPierre Jolivet 14217b665727SPierre Jolivet PetscCall(PetscLogEventBegin(KSP_Solve_FS_S, jac->kspschur, ilinkD->x, ilinkD->y, NULL)); 1422e0b7e82fSBarry Smith PetscCall(PetscObjectIncrementTabLevel((PetscObject)kspA, (PetscObject)kspA, 1)); 14237b665727SPierre Jolivet PetscCall(KSPSolveTranspose(jac->kspschur, ilinkD->x, ilinkD->y)); 1424e0b7e82fSBarry Smith PetscCall(PetscObjectIncrementTabLevel((PetscObject)kspA, (PetscObject)kspA, -1)); 14257b665727SPierre Jolivet PetscCall(KSPCheckSolve(jac->kspschur, pc, ilinkD->y)); 14267b665727SPierre Jolivet PetscCall(PetscLogEventEnd(KSP_Solve_FS_S, jac->kspschur, ilinkD->x, ilinkD->y, NULL)); 14277b665727SPierre Jolivet PetscCall(VecScatterBegin(ilinkD->sctx, ilinkD->y, y, INSERT_VALUES, SCATTER_REVERSE)); 14287b665727SPierre Jolivet 14297b665727SPierre Jolivet if (kspLower == kspA) { 14307b665727SPierre Jolivet PetscCall(MatMultTranspose(jac->C, ilinkD->y, ilinkA->y)); 14317b665727SPierre Jolivet PetscCall(VecAXPY(ilinkA->x, -1.0, ilinkA->y)); 14327b665727SPierre Jolivet PetscCall(PetscLogEventBegin(ilinkA->event, kspA, ilinkA->x, ilinkA->y, NULL)); 14337b665727SPierre Jolivet PetscCall(KSPSolveTranspose(kspA, ilinkA->x, ilinkA->y)); 14347b665727SPierre Jolivet PetscCall(KSPCheckSolve(kspA, pc, ilinkA->y)); 14357b665727SPierre Jolivet PetscCall(PetscLogEventEnd(ilinkA->event, kspA, ilinkA->x, ilinkA->y, NULL)); 14367b665727SPierre Jolivet } else { 14377b665727SPierre Jolivet PetscCall(PetscLogEventBegin(ilinkA->event, kspA, ilinkA->x, ilinkA->y, NULL)); 14387b665727SPierre Jolivet PetscCall(KSPSolveTranspose(kspA, ilinkA->x, ilinkA->y)); 14397b665727SPierre Jolivet PetscCall(KSPCheckSolve(kspA, pc, ilinkA->y)); 14407b665727SPierre Jolivet PetscCall(MatMultTranspose(jac->C, ilinkD->y, ilinkA->x)); 14417b665727SPierre Jolivet PetscCall(PetscLogEventBegin(KSP_Solve_FS_L, kspLower, ilinkA->x, ilinkA->z, NULL)); 14427b665727SPierre Jolivet PetscCall(KSPSolveTranspose(kspLower, ilinkA->x, ilinkA->z)); 14437b665727SPierre Jolivet PetscCall(KSPCheckSolve(kspLower, pc, ilinkA->z)); 14447b665727SPierre Jolivet PetscCall(PetscLogEventEnd(KSP_Solve_FS_L, kspLower, ilinkA->x, ilinkA->z, NULL)); 14457b665727SPierre Jolivet PetscCall(VecAXPY(ilinkA->y, -1.0, ilinkA->z)); 14467b665727SPierre Jolivet } 14477b665727SPierre Jolivet PetscCall(VecScatterEnd(ilinkD->sctx, ilinkD->y, y, INSERT_VALUES, SCATTER_REVERSE)); 14487b665727SPierre Jolivet PetscCall(VecScatterBegin(ilinkA->sctx, ilinkA->y, y, INSERT_VALUES, SCATTER_REVERSE)); 14497b665727SPierre Jolivet PetscCall(VecScatterEnd(ilinkA->sctx, ilinkA->y, y, INSERT_VALUES, SCATTER_REVERSE)); 14507b665727SPierre Jolivet } 14517b665727SPierre Jolivet PetscFunctionReturn(PETSC_SUCCESS); 14527b665727SPierre Jolivet } 14537b665727SPierre Jolivet 1454d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCApply_FieldSplit(PC pc, Vec x, Vec y) 1455d71ae5a4SJacob Faibussowitsch { 14560971522cSBarry Smith PC_FieldSplit *jac = (PC_FieldSplit *)pc->data; 14575a9f2f41SSatish Balay PC_FieldSplitLink ilink = jac->head; 1458939b8a20SBarry Smith PetscInt cnt, bs; 14590971522cSBarry Smith 14600971522cSBarry Smith PetscFunctionBegin; 146179416396SBarry Smith if (jac->type == PC_COMPOSITE_ADDITIVE) { 146280670ca5SBarry Smith PetscBool matnest; 146380670ca5SBarry Smith 146480670ca5SBarry Smith PetscCall(PetscObjectTypeCompare((PetscObject)pc->pmat, MATNEST, &matnest)); 146580670ca5SBarry Smith if (jac->defaultsplit && !matnest) { 14669566063dSJacob Faibussowitsch PetscCall(VecGetBlockSize(x, &bs)); 14672472a847SBarry 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); 14689566063dSJacob Faibussowitsch PetscCall(VecGetBlockSize(y, &bs)); 14692472a847SBarry 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); 14709566063dSJacob Faibussowitsch PetscCall(VecStrideGatherAll(x, jac->x, INSERT_VALUES)); 14715a9f2f41SSatish Balay while (ilink) { 14729566063dSJacob Faibussowitsch PetscCall(PetscLogEventBegin(ilink->event, ilink->ksp, ilink->x, ilink->y, NULL)); 14739566063dSJacob Faibussowitsch PetscCall(KSPSolve(ilink->ksp, ilink->x, ilink->y)); 14749566063dSJacob Faibussowitsch PetscCall(KSPCheckSolve(ilink->ksp, pc, ilink->y)); 14759566063dSJacob Faibussowitsch PetscCall(PetscLogEventEnd(ilink->event, ilink->ksp, ilink->x, ilink->y, NULL)); 14765a9f2f41SSatish Balay ilink = ilink->next; 14770971522cSBarry Smith } 14789566063dSJacob Faibussowitsch PetscCall(VecStrideScatterAll(jac->y, y, INSERT_VALUES)); 14791b9fc7fcSBarry Smith } else { 14809566063dSJacob Faibussowitsch PetscCall(VecSet(y, 0.0)); 14815a9f2f41SSatish Balay while (ilink) { 14829566063dSJacob Faibussowitsch PetscCall(FieldSplitSplitSolveAdd(ilink, x, y)); 14835a9f2f41SSatish Balay ilink = ilink->next; 14841b9fc7fcSBarry Smith } 14851b9fc7fcSBarry Smith } 1486e52d2c62SBarry Smith } else if (jac->type == PC_COMPOSITE_MULTIPLICATIVE && jac->nsplits == 2) { 14879566063dSJacob Faibussowitsch PetscCall(VecSet(y, 0.0)); 1488e52d2c62SBarry Smith /* solve on first block for first block variables */ 14899566063dSJacob Faibussowitsch PetscCall(VecScatterBegin(ilink->sctx, x, ilink->x, INSERT_VALUES, SCATTER_FORWARD)); 14909566063dSJacob Faibussowitsch PetscCall(VecScatterEnd(ilink->sctx, x, ilink->x, INSERT_VALUES, SCATTER_FORWARD)); 14919566063dSJacob Faibussowitsch PetscCall(PetscLogEventBegin(ilink->event, ilink->ksp, ilink->x, ilink->y, NULL)); 14929566063dSJacob Faibussowitsch PetscCall(KSPSolve(ilink->ksp, ilink->x, ilink->y)); 14939566063dSJacob Faibussowitsch PetscCall(KSPCheckSolve(ilink->ksp, pc, ilink->y)); 14949566063dSJacob Faibussowitsch PetscCall(PetscLogEventEnd(ilink->event, ilink->ksp, ilink->x, ilink->y, NULL)); 14959566063dSJacob Faibussowitsch PetscCall(VecScatterBegin(ilink->sctx, ilink->y, y, ADD_VALUES, SCATTER_REVERSE)); 14969566063dSJacob Faibussowitsch PetscCall(VecScatterEnd(ilink->sctx, ilink->y, y, ADD_VALUES, SCATTER_REVERSE)); 1497e52d2c62SBarry Smith 1498e52d2c62SBarry Smith /* compute the residual only onto second block variables using first block variables */ 14999566063dSJacob Faibussowitsch PetscCall(MatMult(jac->Afield[1], ilink->y, ilink->next->x)); 1500e52d2c62SBarry Smith ilink = ilink->next; 15019566063dSJacob Faibussowitsch PetscCall(VecScale(ilink->x, -1.0)); 15029566063dSJacob Faibussowitsch PetscCall(VecScatterBegin(ilink->sctx, x, ilink->x, ADD_VALUES, SCATTER_FORWARD)); 15039566063dSJacob Faibussowitsch PetscCall(VecScatterEnd(ilink->sctx, x, ilink->x, ADD_VALUES, SCATTER_FORWARD)); 1504e52d2c62SBarry Smith 1505e52d2c62SBarry Smith /* solve on second block variables */ 15069566063dSJacob Faibussowitsch PetscCall(PetscLogEventBegin(ilink->event, ilink->ksp, ilink->x, ilink->y, NULL)); 15079566063dSJacob Faibussowitsch PetscCall(KSPSolve(ilink->ksp, ilink->x, ilink->y)); 15089566063dSJacob Faibussowitsch PetscCall(KSPCheckSolve(ilink->ksp, pc, ilink->y)); 15099566063dSJacob Faibussowitsch PetscCall(PetscLogEventEnd(ilink->event, ilink->ksp, ilink->x, ilink->y, NULL)); 15109566063dSJacob Faibussowitsch PetscCall(VecScatterBegin(ilink->sctx, ilink->y, y, ADD_VALUES, SCATTER_REVERSE)); 15119566063dSJacob Faibussowitsch PetscCall(VecScatterEnd(ilink->sctx, ilink->y, y, ADD_VALUES, SCATTER_REVERSE)); 151216913363SBarry Smith } else if (jac->type == PC_COMPOSITE_MULTIPLICATIVE || jac->type == PC_COMPOSITE_SYMMETRIC_MULTIPLICATIVE) { 151379416396SBarry Smith if (!jac->w1) { 15149566063dSJacob Faibussowitsch PetscCall(VecDuplicate(x, &jac->w1)); 15159566063dSJacob Faibussowitsch PetscCall(VecDuplicate(x, &jac->w2)); 151679416396SBarry Smith } 15179566063dSJacob Faibussowitsch PetscCall(VecSet(y, 0.0)); 15189566063dSJacob Faibussowitsch PetscCall(FieldSplitSplitSolveAdd(ilink, x, y)); 15193e197d65SBarry Smith cnt = 1; 15205a9f2f41SSatish Balay while (ilink->next) { 15215a9f2f41SSatish Balay ilink = ilink->next; 15223e197d65SBarry Smith /* compute the residual only over the part of the vector needed */ 15239566063dSJacob Faibussowitsch PetscCall(MatMult(jac->Afield[cnt++], y, ilink->x)); 15249566063dSJacob Faibussowitsch PetscCall(VecScale(ilink->x, -1.0)); 15259566063dSJacob Faibussowitsch PetscCall(VecScatterBegin(ilink->sctx, x, ilink->x, ADD_VALUES, SCATTER_FORWARD)); 15269566063dSJacob Faibussowitsch PetscCall(VecScatterEnd(ilink->sctx, x, ilink->x, ADD_VALUES, SCATTER_FORWARD)); 15279566063dSJacob Faibussowitsch PetscCall(PetscLogEventBegin(ilink->event, ilink->ksp, ilink->x, ilink->y, NULL)); 15289566063dSJacob Faibussowitsch PetscCall(KSPSolve(ilink->ksp, ilink->x, ilink->y)); 15299566063dSJacob Faibussowitsch PetscCall(KSPCheckSolve(ilink->ksp, pc, ilink->y)); 15309566063dSJacob Faibussowitsch PetscCall(PetscLogEventEnd(ilink->event, ilink->ksp, ilink->x, ilink->y, NULL)); 15319566063dSJacob Faibussowitsch PetscCall(VecScatterBegin(ilink->sctx, ilink->y, y, ADD_VALUES, SCATTER_REVERSE)); 15329566063dSJacob Faibussowitsch PetscCall(VecScatterEnd(ilink->sctx, ilink->y, y, ADD_VALUES, SCATTER_REVERSE)); 15333e197d65SBarry Smith } 153451f519a2SBarry Smith if (jac->type == PC_COMPOSITE_SYMMETRIC_MULTIPLICATIVE) { 153511755939SBarry Smith cnt -= 2; 153651f519a2SBarry Smith while (ilink->previous) { 153751f519a2SBarry Smith ilink = ilink->previous; 153811755939SBarry Smith /* compute the residual only over the part of the vector needed */ 15399566063dSJacob Faibussowitsch PetscCall(MatMult(jac->Afield[cnt--], y, ilink->x)); 15409566063dSJacob Faibussowitsch PetscCall(VecScale(ilink->x, -1.0)); 15419566063dSJacob Faibussowitsch PetscCall(VecScatterBegin(ilink->sctx, x, ilink->x, ADD_VALUES, SCATTER_FORWARD)); 15429566063dSJacob Faibussowitsch PetscCall(VecScatterEnd(ilink->sctx, x, ilink->x, ADD_VALUES, SCATTER_FORWARD)); 15439566063dSJacob Faibussowitsch PetscCall(PetscLogEventBegin(ilink->event, ilink->ksp, ilink->x, ilink->y, NULL)); 15449566063dSJacob Faibussowitsch PetscCall(KSPSolve(ilink->ksp, ilink->x, ilink->y)); 15459566063dSJacob Faibussowitsch PetscCall(KSPCheckSolve(ilink->ksp, pc, ilink->y)); 15469566063dSJacob Faibussowitsch PetscCall(PetscLogEventEnd(ilink->event, ilink->ksp, ilink->x, ilink->y, NULL)); 15479566063dSJacob Faibussowitsch PetscCall(VecScatterBegin(ilink->sctx, ilink->y, y, ADD_VALUES, SCATTER_REVERSE)); 15489566063dSJacob Faibussowitsch PetscCall(VecScatterEnd(ilink->sctx, ilink->y, y, ADD_VALUES, SCATTER_REVERSE)); 154951f519a2SBarry Smith } 155011755939SBarry Smith } 155163a3b9bcSJacob Faibussowitsch } else SETERRQ(PetscObjectComm((PetscObject)pc), PETSC_ERR_SUP, "Unsupported or unknown composition %d", (int)jac->type); 15523ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 15530971522cSBarry Smith } 15540971522cSBarry Smith 1555d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCApply_FieldSplit_GKB(PC pc, Vec x, Vec y) 1556d71ae5a4SJacob Faibussowitsch { 1557a51937d4SCarola Kruse PC_FieldSplit *jac = (PC_FieldSplit *)pc->data; 1558a51937d4SCarola Kruse PC_FieldSplitLink ilinkA = jac->head, ilinkD = ilinkA->next; 1559a51937d4SCarola Kruse KSP ksp = ilinkA->ksp; 1560de482cd7SCarola Kruse Vec u, v, Hu, d, work1, work2; 1561e071a0a4SCarola Kruse PetscScalar alpha, z, nrmz2, *vecz; 1562e071a0a4SCarola Kruse PetscReal lowbnd, nu, beta; 1563a51937d4SCarola Kruse PetscInt j, iterGKB; 1564a51937d4SCarola Kruse 1565a51937d4SCarola Kruse PetscFunctionBegin; 15669566063dSJacob Faibussowitsch PetscCall(VecScatterBegin(ilinkA->sctx, x, ilinkA->x, INSERT_VALUES, SCATTER_FORWARD)); 15679566063dSJacob Faibussowitsch PetscCall(VecScatterBegin(ilinkD->sctx, x, ilinkD->x, INSERT_VALUES, SCATTER_FORWARD)); 15689566063dSJacob Faibussowitsch PetscCall(VecScatterEnd(ilinkA->sctx, x, ilinkA->x, INSERT_VALUES, SCATTER_FORWARD)); 15699566063dSJacob Faibussowitsch PetscCall(VecScatterEnd(ilinkD->sctx, x, ilinkD->x, INSERT_VALUES, SCATTER_FORWARD)); 1570e071a0a4SCarola Kruse 1571e071a0a4SCarola Kruse u = jac->u; 1572e071a0a4SCarola Kruse v = jac->v; 1573e071a0a4SCarola Kruse Hu = jac->Hu; 1574e071a0a4SCarola Kruse d = jac->d; 1575e071a0a4SCarola Kruse work1 = jac->w1; 1576e071a0a4SCarola Kruse work2 = jac->w2; 1577e071a0a4SCarola Kruse vecz = jac->vecz; 1578a51937d4SCarola Kruse 1579a51937d4SCarola Kruse /* Change RHS to comply with matrix regularization H = A + nu*B*B' */ 1580a51937d4SCarola Kruse /* Add q = q + nu*B*b */ 1581a51937d4SCarola Kruse if (jac->gkbnu) { 1582a51937d4SCarola Kruse nu = jac->gkbnu; 15839566063dSJacob Faibussowitsch PetscCall(VecScale(ilinkD->x, jac->gkbnu)); 15849566063dSJacob Faibussowitsch PetscCall(MatMultAdd(jac->B, ilinkD->x, ilinkA->x, ilinkA->x)); /* q = q + nu*B*b */ 1585a51937d4SCarola Kruse } else { 1586a51937d4SCarola Kruse /* Situation when no augmented Lagrangian is used. Then we set inner */ 1587a51937d4SCarola Kruse /* matrix N = I in [Ar13], and thus nu = 1. */ 1588a51937d4SCarola Kruse nu = 1; 1589a51937d4SCarola Kruse } 1590a51937d4SCarola Kruse 1591a51937d4SCarola Kruse /* Transform rhs from [q,tilde{b}] to [0,b] */ 15929566063dSJacob Faibussowitsch PetscCall(PetscLogEventBegin(ilinkA->event, ksp, ilinkA->x, ilinkA->y, NULL)); 15939566063dSJacob Faibussowitsch PetscCall(KSPSolve(ksp, ilinkA->x, ilinkA->y)); 15949566063dSJacob Faibussowitsch PetscCall(KSPCheckSolve(ksp, pc, ilinkA->y)); 15959566063dSJacob Faibussowitsch PetscCall(PetscLogEventEnd(ilinkA->event, ksp, ilinkA->x, ilinkA->y, NULL)); 15969566063dSJacob Faibussowitsch PetscCall(MatMultHermitianTranspose(jac->B, ilinkA->y, work1)); 15979566063dSJacob Faibussowitsch PetscCall(VecAXPBY(work1, 1.0 / nu, -1.0, ilinkD->x)); /* c = b - B'*x */ 1598a51937d4SCarola Kruse 1599a51937d4SCarola Kruse /* First step of algorithm */ 16009566063dSJacob Faibussowitsch PetscCall(VecNorm(work1, NORM_2, &beta)); /* beta = sqrt(nu*c'*c)*/ 1601e071a0a4SCarola Kruse KSPCheckDot(ksp, beta); 1602addd1e01SJunchao Zhang beta = PetscSqrtReal(nu) * beta; 16039566063dSJacob Faibussowitsch PetscCall(VecAXPBY(v, nu / beta, 0.0, work1)); /* v = nu/beta *c */ 16049566063dSJacob Faibussowitsch PetscCall(MatMult(jac->B, v, work2)); /* u = H^{-1}*B*v */ 16059566063dSJacob Faibussowitsch PetscCall(PetscLogEventBegin(ilinkA->event, ksp, work2, u, NULL)); 16069566063dSJacob Faibussowitsch PetscCall(KSPSolve(ksp, work2, u)); 16079566063dSJacob Faibussowitsch PetscCall(KSPCheckSolve(ksp, pc, u)); 16089566063dSJacob Faibussowitsch PetscCall(PetscLogEventEnd(ilinkA->event, ksp, work2, u, NULL)); 16099566063dSJacob Faibussowitsch PetscCall(MatMult(jac->H, u, Hu)); /* alpha = u'*H*u */ 16109566063dSJacob Faibussowitsch PetscCall(VecDot(Hu, u, &alpha)); 1611e071a0a4SCarola Kruse KSPCheckDot(ksp, alpha); 161208401ef6SPierre Jolivet PetscCheck(PetscRealPart(alpha) > 0.0, PETSC_COMM_SELF, PETSC_ERR_NOT_CONVERGED, "GKB preconditioner diverged, H is not positive definite"); 1613addd1e01SJunchao Zhang alpha = PetscSqrtReal(PetscAbsScalar(alpha)); 16149566063dSJacob Faibussowitsch PetscCall(VecScale(u, 1.0 / alpha)); 16159566063dSJacob Faibussowitsch PetscCall(VecAXPBY(d, 1.0 / alpha, 0.0, v)); /* v = nu/beta *c */ 1616de482cd7SCarola Kruse 1617a51937d4SCarola Kruse z = beta / alpha; 1618a51937d4SCarola Kruse vecz[1] = z; 1619a51937d4SCarola Kruse 1620de482cd7SCarola Kruse /* Computation of first iterate x(1) and p(1) */ 16219566063dSJacob Faibussowitsch PetscCall(VecAXPY(ilinkA->y, z, u)); 16229566063dSJacob Faibussowitsch PetscCall(VecCopy(d, ilinkD->y)); 16239566063dSJacob Faibussowitsch PetscCall(VecScale(ilinkD->y, -z)); 1624a51937d4SCarola Kruse 16259371c9d4SSatish Balay iterGKB = 1; 16269371c9d4SSatish Balay lowbnd = 2 * jac->gkbtol; 162748a46eb9SPierre Jolivet if (jac->gkbmonitor) PetscCall(PetscViewerASCIIPrintf(jac->gkbviewer, "%3" PetscInt_FMT " GKB Lower bound estimate %14.12e\n", iterGKB, (double)lowbnd)); 1628de482cd7SCarola Kruse 1629a51937d4SCarola Kruse while (iterGKB < jac->gkbmaxit && lowbnd > jac->gkbtol) { 1630a51937d4SCarola Kruse iterGKB += 1; 16319566063dSJacob Faibussowitsch PetscCall(MatMultHermitianTranspose(jac->B, u, work1)); /* v <- nu*(B'*u-alpha/nu*v) */ 16329566063dSJacob Faibussowitsch PetscCall(VecAXPBY(v, nu, -alpha, work1)); 16339566063dSJacob Faibussowitsch PetscCall(VecNorm(v, NORM_2, &beta)); /* beta = sqrt(nu)*v'*v */ 1634addd1e01SJunchao Zhang beta = beta / PetscSqrtReal(nu); 16359566063dSJacob Faibussowitsch PetscCall(VecScale(v, 1.0 / beta)); 16369566063dSJacob Faibussowitsch PetscCall(MatMult(jac->B, v, work2)); /* u <- H^{-1}*(B*v-beta*H*u) */ 16379566063dSJacob Faibussowitsch PetscCall(MatMult(jac->H, u, Hu)); 16389566063dSJacob Faibussowitsch PetscCall(VecAXPY(work2, -beta, Hu)); 16399566063dSJacob Faibussowitsch PetscCall(PetscLogEventBegin(ilinkA->event, ksp, work2, u, NULL)); 16409566063dSJacob Faibussowitsch PetscCall(KSPSolve(ksp, work2, u)); 16419566063dSJacob Faibussowitsch PetscCall(KSPCheckSolve(ksp, pc, u)); 16429566063dSJacob Faibussowitsch PetscCall(PetscLogEventEnd(ilinkA->event, ksp, work2, u, NULL)); 16439566063dSJacob Faibussowitsch PetscCall(MatMult(jac->H, u, Hu)); /* alpha = u'*H*u */ 16449566063dSJacob Faibussowitsch PetscCall(VecDot(Hu, u, &alpha)); 1645e071a0a4SCarola Kruse KSPCheckDot(ksp, alpha); 164608401ef6SPierre Jolivet PetscCheck(PetscRealPart(alpha) > 0.0, PETSC_COMM_SELF, PETSC_ERR_NOT_CONVERGED, "GKB preconditioner diverged, H is not positive definite"); 1647addd1e01SJunchao Zhang alpha = PetscSqrtReal(PetscAbsScalar(alpha)); 16489566063dSJacob Faibussowitsch PetscCall(VecScale(u, 1.0 / alpha)); 1649a51937d4SCarola Kruse 1650e071a0a4SCarola Kruse z = -beta / alpha * z; /* z <- beta/alpha*z */ 1651a51937d4SCarola Kruse vecz[0] = z; 1652a51937d4SCarola Kruse 1653a51937d4SCarola Kruse /* Computation of new iterate x(i+1) and p(i+1) */ 16549566063dSJacob Faibussowitsch PetscCall(VecAXPBY(d, 1.0 / alpha, -beta / alpha, v)); /* d = (v-beta*d)/alpha */ 16559566063dSJacob Faibussowitsch PetscCall(VecAXPY(ilinkA->y, z, u)); /* r = r + z*u */ 16569566063dSJacob Faibussowitsch PetscCall(VecAXPY(ilinkD->y, -z, d)); /* p = p - z*d */ 16579566063dSJacob Faibussowitsch PetscCall(MatMult(jac->H, ilinkA->y, Hu)); /* ||u||_H = u'*H*u */ 16589566063dSJacob Faibussowitsch PetscCall(VecDot(Hu, ilinkA->y, &nrmz2)); 1659a51937d4SCarola Kruse 1660a51937d4SCarola Kruse /* Compute Lower Bound estimate */ 1661a51937d4SCarola Kruse if (iterGKB > jac->gkbdelay) { 1662a51937d4SCarola Kruse lowbnd = 0.0; 1663ad540459SPierre Jolivet for (j = 0; j < jac->gkbdelay; j++) lowbnd += PetscAbsScalar(vecz[j] * vecz[j]); 1664addd1e01SJunchao Zhang lowbnd = PetscSqrtReal(lowbnd / PetscAbsScalar(nrmz2)); 1665a51937d4SCarola Kruse } 1666a51937d4SCarola Kruse 1667ad540459SPierre Jolivet for (j = 0; j < jac->gkbdelay - 1; j++) vecz[jac->gkbdelay - j - 1] = vecz[jac->gkbdelay - j - 2]; 166848a46eb9SPierre Jolivet if (jac->gkbmonitor) PetscCall(PetscViewerASCIIPrintf(jac->gkbviewer, "%3" PetscInt_FMT " GKB Lower bound estimate %14.12e\n", iterGKB, (double)lowbnd)); 1669a51937d4SCarola Kruse } 1670a51937d4SCarola Kruse 16719566063dSJacob Faibussowitsch PetscCall(VecScatterBegin(ilinkA->sctx, ilinkA->y, y, INSERT_VALUES, SCATTER_REVERSE)); 16729566063dSJacob Faibussowitsch PetscCall(VecScatterEnd(ilinkA->sctx, ilinkA->y, y, INSERT_VALUES, SCATTER_REVERSE)); 16739566063dSJacob Faibussowitsch PetscCall(VecScatterBegin(ilinkD->sctx, ilinkD->y, y, INSERT_VALUES, SCATTER_REVERSE)); 16749566063dSJacob Faibussowitsch PetscCall(VecScatterEnd(ilinkD->sctx, ilinkD->y, y, INSERT_VALUES, SCATTER_REVERSE)); 16753ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 1676a51937d4SCarola Kruse } 1677a51937d4SCarola Kruse 1678421e10b8SBarry Smith #define FieldSplitSplitSolveAddTranspose(ilink, xx, yy) \ 16793ba16761SJacob Faibussowitsch ((PetscErrorCode)(VecScatterBegin(ilink->sctx, xx, ilink->y, INSERT_VALUES, SCATTER_FORWARD) || VecScatterEnd(ilink->sctx, xx, ilink->y, INSERT_VALUES, SCATTER_FORWARD) || PetscLogEventBegin(ilink->event, ilink->ksp, ilink->y, ilink->x, NULL) || \ 16809371c9d4SSatish 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) || \ 16813ba16761SJacob Faibussowitsch VecScatterEnd(ilink->sctx, ilink->x, yy, ADD_VALUES, SCATTER_REVERSE))) 1682421e10b8SBarry Smith 1683d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCApplyTranspose_FieldSplit(PC pc, Vec x, Vec y) 1684d71ae5a4SJacob Faibussowitsch { 1685421e10b8SBarry Smith PC_FieldSplit *jac = (PC_FieldSplit *)pc->data; 1686421e10b8SBarry Smith PC_FieldSplitLink ilink = jac->head; 1687939b8a20SBarry Smith PetscInt bs; 1688421e10b8SBarry Smith 1689421e10b8SBarry Smith PetscFunctionBegin; 1690421e10b8SBarry Smith if (jac->type == PC_COMPOSITE_ADDITIVE) { 169180670ca5SBarry Smith PetscBool matnest; 169280670ca5SBarry Smith 169380670ca5SBarry Smith PetscCall(PetscObjectTypeCompare((PetscObject)pc->pmat, MATNEST, &matnest)); 169480670ca5SBarry Smith if (jac->defaultsplit && !matnest) { 16959566063dSJacob Faibussowitsch PetscCall(VecGetBlockSize(x, &bs)); 16962472a847SBarry 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); 16979566063dSJacob Faibussowitsch PetscCall(VecGetBlockSize(y, &bs)); 16982472a847SBarry 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); 16999566063dSJacob Faibussowitsch PetscCall(VecStrideGatherAll(x, jac->x, INSERT_VALUES)); 1700421e10b8SBarry Smith while (ilink) { 17019566063dSJacob Faibussowitsch PetscCall(PetscLogEventBegin(ilink->event, ilink->ksp, ilink->x, ilink->y, NULL)); 17029566063dSJacob Faibussowitsch PetscCall(KSPSolveTranspose(ilink->ksp, ilink->x, ilink->y)); 17039566063dSJacob Faibussowitsch PetscCall(KSPCheckSolve(ilink->ksp, pc, ilink->y)); 17049566063dSJacob Faibussowitsch PetscCall(PetscLogEventEnd(ilink->event, ilink->ksp, ilink->x, ilink->y, NULL)); 1705421e10b8SBarry Smith ilink = ilink->next; 1706421e10b8SBarry Smith } 17079566063dSJacob Faibussowitsch PetscCall(VecStrideScatterAll(jac->y, y, INSERT_VALUES)); 1708421e10b8SBarry Smith } else { 17099566063dSJacob Faibussowitsch PetscCall(VecSet(y, 0.0)); 1710421e10b8SBarry Smith while (ilink) { 17119566063dSJacob Faibussowitsch PetscCall(FieldSplitSplitSolveAddTranspose(ilink, x, y)); 1712421e10b8SBarry Smith ilink = ilink->next; 1713421e10b8SBarry Smith } 1714421e10b8SBarry Smith } 1715421e10b8SBarry Smith } else { 1716421e10b8SBarry Smith if (!jac->w1) { 17179566063dSJacob Faibussowitsch PetscCall(VecDuplicate(x, &jac->w1)); 17189566063dSJacob Faibussowitsch PetscCall(VecDuplicate(x, &jac->w2)); 1719421e10b8SBarry Smith } 17209566063dSJacob Faibussowitsch PetscCall(VecSet(y, 0.0)); 1721421e10b8SBarry Smith if (jac->type == PC_COMPOSITE_SYMMETRIC_MULTIPLICATIVE) { 17229566063dSJacob Faibussowitsch PetscCall(FieldSplitSplitSolveAddTranspose(ilink, x, y)); 1723421e10b8SBarry Smith while (ilink->next) { 1724421e10b8SBarry Smith ilink = ilink->next; 17259566063dSJacob Faibussowitsch PetscCall(MatMultTranspose(pc->mat, y, jac->w1)); 17269566063dSJacob Faibussowitsch PetscCall(VecWAXPY(jac->w2, -1.0, jac->w1, x)); 17279566063dSJacob Faibussowitsch PetscCall(FieldSplitSplitSolveAddTranspose(ilink, jac->w2, y)); 1728421e10b8SBarry Smith } 1729421e10b8SBarry Smith while (ilink->previous) { 1730421e10b8SBarry Smith ilink = ilink->previous; 17319566063dSJacob Faibussowitsch PetscCall(MatMultTranspose(pc->mat, y, jac->w1)); 17329566063dSJacob Faibussowitsch PetscCall(VecWAXPY(jac->w2, -1.0, jac->w1, x)); 17339566063dSJacob Faibussowitsch PetscCall(FieldSplitSplitSolveAddTranspose(ilink, jac->w2, y)); 1734421e10b8SBarry Smith } 1735421e10b8SBarry Smith } else { 1736421e10b8SBarry Smith while (ilink->next) { /* get to last entry in linked list */ 1737421e10b8SBarry Smith ilink = ilink->next; 1738421e10b8SBarry Smith } 17399566063dSJacob Faibussowitsch PetscCall(FieldSplitSplitSolveAddTranspose(ilink, x, y)); 1740421e10b8SBarry Smith while (ilink->previous) { 1741421e10b8SBarry Smith ilink = ilink->previous; 17429566063dSJacob Faibussowitsch PetscCall(MatMultTranspose(pc->mat, y, jac->w1)); 17439566063dSJacob Faibussowitsch PetscCall(VecWAXPY(jac->w2, -1.0, jac->w1, x)); 17449566063dSJacob Faibussowitsch PetscCall(FieldSplitSplitSolveAddTranspose(ilink, jac->w2, y)); 1745421e10b8SBarry Smith } 1746421e10b8SBarry Smith } 1747421e10b8SBarry Smith } 17483ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 1749421e10b8SBarry Smith } 1750421e10b8SBarry Smith 1751d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCReset_FieldSplit(PC pc) 1752d71ae5a4SJacob Faibussowitsch { 17530971522cSBarry Smith PC_FieldSplit *jac = (PC_FieldSplit *)pc->data; 17545a9f2f41SSatish Balay PC_FieldSplitLink ilink = jac->head, next; 1755d9eadc85SPierre Jolivet Mat AinvB; 17560971522cSBarry Smith 17570971522cSBarry Smith PetscFunctionBegin; 17585a9f2f41SSatish Balay while (ilink) { 17599566063dSJacob Faibussowitsch PetscCall(KSPDestroy(&ilink->ksp)); 17609566063dSJacob Faibussowitsch PetscCall(VecDestroy(&ilink->x)); 17619566063dSJacob Faibussowitsch PetscCall(VecDestroy(&ilink->y)); 17629566063dSJacob Faibussowitsch PetscCall(VecDestroy(&ilink->z)); 17639566063dSJacob Faibussowitsch PetscCall(VecScatterDestroy(&ilink->sctx)); 17649566063dSJacob Faibussowitsch PetscCall(ISDestroy(&ilink->is)); 17659566063dSJacob Faibussowitsch PetscCall(ISDestroy(&ilink->is_col)); 17669566063dSJacob Faibussowitsch PetscCall(PetscFree(ilink->splitname)); 17679566063dSJacob Faibussowitsch PetscCall(PetscFree(ilink->fields)); 17689566063dSJacob Faibussowitsch PetscCall(PetscFree(ilink->fields_col)); 17695a9f2f41SSatish Balay next = ilink->next; 17709566063dSJacob Faibussowitsch PetscCall(PetscFree(ilink)); 17715a9f2f41SSatish Balay ilink = next; 17720971522cSBarry Smith } 1773f5f0d762SBarry Smith jac->head = NULL; 17749566063dSJacob Faibussowitsch PetscCall(PetscFree2(jac->x, jac->y)); 1775574deadeSBarry Smith if (jac->mat && jac->mat != jac->pmat) { 17769566063dSJacob Faibussowitsch PetscCall(MatDestroyMatrices(jac->nsplits, &jac->mat)); 1777574deadeSBarry Smith } else if (jac->mat) { 17780298fd71SBarry Smith jac->mat = NULL; 1779574deadeSBarry Smith } 17809566063dSJacob Faibussowitsch if (jac->pmat) PetscCall(MatDestroyMatrices(jac->nsplits, &jac->pmat)); 17819566063dSJacob Faibussowitsch if (jac->Afield) PetscCall(MatDestroyMatrices(jac->nsplits, &jac->Afield)); 1782f5f0d762SBarry Smith jac->nsplits = 0; 17839566063dSJacob Faibussowitsch PetscCall(VecDestroy(&jac->w1)); 17849566063dSJacob Faibussowitsch PetscCall(VecDestroy(&jac->w2)); 1785d9eadc85SPierre Jolivet if (jac->schur) { 1786d9eadc85SPierre Jolivet PetscCall(PetscObjectQuery((PetscObject)jac->schur, "AinvB", (PetscObject *)&AinvB)); 1787d9eadc85SPierre Jolivet PetscCall(MatDestroy(&AinvB)); 1788d9eadc85SPierre Jolivet PetscCall(PetscObjectCompose((PetscObject)jac->schur, "AinvB", NULL)); 1789d9eadc85SPierre Jolivet } 17909566063dSJacob Faibussowitsch PetscCall(MatDestroy(&jac->schur)); 17919566063dSJacob Faibussowitsch PetscCall(MatDestroy(&jac->schurp)); 17929566063dSJacob Faibussowitsch PetscCall(MatDestroy(&jac->schur_user)); 17939566063dSJacob Faibussowitsch PetscCall(KSPDestroy(&jac->kspschur)); 17949566063dSJacob Faibussowitsch PetscCall(KSPDestroy(&jac->kspupper)); 17959566063dSJacob Faibussowitsch PetscCall(MatDestroy(&jac->B)); 17969566063dSJacob Faibussowitsch PetscCall(MatDestroy(&jac->C)); 17979566063dSJacob Faibussowitsch PetscCall(MatDestroy(&jac->H)); 17989566063dSJacob Faibussowitsch PetscCall(VecDestroy(&jac->u)); 17999566063dSJacob Faibussowitsch PetscCall(VecDestroy(&jac->v)); 18009566063dSJacob Faibussowitsch PetscCall(VecDestroy(&jac->Hu)); 18019566063dSJacob Faibussowitsch PetscCall(VecDestroy(&jac->d)); 18029566063dSJacob Faibussowitsch PetscCall(PetscFree(jac->vecz)); 18039566063dSJacob Faibussowitsch PetscCall(PetscViewerDestroy(&jac->gkbviewer)); 18046dbb499eSCian Wilson jac->isrestrict = PETSC_FALSE; 18053ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 1806574deadeSBarry Smith } 1807574deadeSBarry Smith 1808d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCDestroy_FieldSplit(PC pc) 1809d71ae5a4SJacob Faibussowitsch { 1810574deadeSBarry Smith PetscFunctionBegin; 18119566063dSJacob Faibussowitsch PetscCall(PCReset_FieldSplit(pc)); 18129566063dSJacob Faibussowitsch PetscCall(PetscFree(pc->data)); 18132e956fe4SStefano Zampini PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCSetCoordinates_C", NULL)); 18149566063dSJacob Faibussowitsch PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetFields_C", NULL)); 18159566063dSJacob Faibussowitsch PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetIS_C", NULL)); 18169566063dSJacob Faibussowitsch PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetType_C", NULL)); 18179566063dSJacob Faibussowitsch PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetBlockSize_C", NULL)); 18182e956fe4SStefano Zampini PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitRestrictIS_C", NULL)); 18192e956fe4SStefano Zampini PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSchurGetSubKSP_C", NULL)); 18202e956fe4SStefano Zampini PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitGetSubKSP_C", NULL)); 18212e956fe4SStefano Zampini 18222e956fe4SStefano Zampini PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetGKBTol_C", NULL)); 18232e956fe4SStefano Zampini PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetGKBMaxit_C", NULL)); 18242e956fe4SStefano Zampini PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetGKBNu_C", NULL)); 18252e956fe4SStefano Zampini PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetGKBDelay_C", NULL)); 18262e956fe4SStefano Zampini PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitGetSubKSP_C", NULL)); 18279566063dSJacob Faibussowitsch PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetSchurPre_C", NULL)); 18289566063dSJacob Faibussowitsch PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitGetSchurPre_C", NULL)); 18299566063dSJacob Faibussowitsch PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetSchurFactType_C", NULL)); 18302e956fe4SStefano Zampini PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetSchurScale_C", NULL)); 18313ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 18320971522cSBarry Smith } 18330971522cSBarry Smith 1834d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCSetFromOptions_FieldSplit(PC pc, PetscOptionItems *PetscOptionsObject) 1835d71ae5a4SJacob Faibussowitsch { 18366c924f48SJed Brown PetscInt bs; 18377b752e3dSPatrick Sanan PetscBool flg; 18389dcbbd2bSBarry Smith PC_FieldSplit *jac = (PC_FieldSplit *)pc->data; 18393b224e63SBarry Smith PCCompositeType ctype; 18401b9fc7fcSBarry Smith 18410971522cSBarry Smith PetscFunctionBegin; 1842d0609cedSBarry Smith PetscOptionsHeadBegin(PetscOptionsObject, "FieldSplit options"); 18439566063dSJacob Faibussowitsch PetscCall(PetscOptionsBool("-pc_fieldsplit_dm_splits", "Whether to use DMCreateFieldDecomposition() for splits", "PCFieldSplitSetDMSplits", jac->dm_splits, &jac->dm_splits, NULL)); 18449566063dSJacob Faibussowitsch PetscCall(PetscOptionsInt("-pc_fieldsplit_block_size", "Blocksize that defines number of fields", "PCFieldSplitSetBlockSize", jac->bs, &bs, &flg)); 18451baa6e33SBarry Smith if (flg) PetscCall(PCFieldSplitSetBlockSize(pc, bs)); 18462686e3e9SMatthew G. Knepley jac->diag_use_amat = pc->useAmat; 18479566063dSJacob 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)); 18482686e3e9SMatthew G. Knepley jac->offdiag_use_amat = pc->useAmat; 18499566063dSJacob 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)); 18509566063dSJacob Faibussowitsch PetscCall(PetscOptionsBool("-pc_fieldsplit_detect_saddle_point", "Form 2-way split by detecting zero diagonal entries", "PCFieldSplitSetDetectSaddlePoint", jac->detect, &jac->detect, NULL)); 18519566063dSJacob Faibussowitsch PetscCall(PCFieldSplitSetDetectSaddlePoint(pc, jac->detect)); /* Sets split type and Schur PC type */ 18529566063dSJacob Faibussowitsch PetscCall(PetscOptionsEnum("-pc_fieldsplit_type", "Type of composition", "PCFieldSplitSetType", PCCompositeTypes, (PetscEnum)jac->type, (PetscEnum *)&ctype, &flg)); 18531baa6e33SBarry Smith if (flg) PetscCall(PCFieldSplitSetType(pc, ctype)); 1854c30613efSMatthew Knepley /* Only setup fields once */ 1855c30613efSMatthew Knepley if ((jac->bs > 0) && (jac->nsplits == 0)) { 185680670ca5SBarry Smith /* only allow user to set fields from command line. 1857d32f9abdSBarry Smith otherwise user can set them in PCFieldSplitSetDefaults() */ 18589566063dSJacob Faibussowitsch PetscCall(PCFieldSplitSetRuntimeSplits_Private(pc)); 18599566063dSJacob Faibussowitsch if (jac->splitdefined) PetscCall(PetscInfo(pc, "Splits defined using the options database\n")); 1860d32f9abdSBarry Smith } 1861c5d2311dSJed Brown if (jac->type == PC_COMPOSITE_SCHUR) { 18629566063dSJacob Faibussowitsch PetscCall(PetscOptionsGetEnum(((PetscObject)pc)->options, ((PetscObject)pc)->prefix, "-pc_fieldsplit_schur_factorization_type", PCFieldSplitSchurFactTypes, (PetscEnum *)&jac->schurfactorization, &flg)); 18639566063dSJacob Faibussowitsch if (flg) PetscCall(PetscInfo(pc, "Deprecated use of -pc_fieldsplit_schur_factorization_type\n")); 18649566063dSJacob 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)); 18659566063dSJacob Faibussowitsch PetscCall(PetscOptionsEnum("-pc_fieldsplit_schur_precondition", "How to build preconditioner for Schur complement", "PCFieldSplitSetSchurPre", PCFieldSplitSchurPreTypes, (PetscEnum)jac->schurpre, (PetscEnum *)&jac->schurpre, NULL)); 18669566063dSJacob Faibussowitsch PetscCall(PetscOptionsScalar("-pc_fieldsplit_schur_scale", "Scale Schur complement", "PCFieldSplitSetSchurScale", jac->schurscale, &jac->schurscale, NULL)); 1867a51937d4SCarola Kruse } else if (jac->type == PC_COMPOSITE_GKB) { 1868a077d33dSBarry Smith PetscCall(PetscOptionsReal("-pc_fieldsplit_gkb_tol", "The tolerance for the lower bound stopping criterion", "PCFieldSplitSetGKBTol", jac->gkbtol, &jac->gkbtol, NULL)); 1869a077d33dSBarry Smith PetscCall(PetscOptionsInt("-pc_fieldsplit_gkb_delay", "The delay value for lower bound criterion", "PCFieldSplitSetGKBDelay", jac->gkbdelay, &jac->gkbdelay, NULL)); 1870a077d33dSBarry Smith PetscCall(PetscOptionsBoundedReal("-pc_fieldsplit_gkb_nu", "Parameter in augmented Lagrangian approach", "PCFieldSplitSetGKBNu", jac->gkbnu, &jac->gkbnu, NULL, 0.0)); 1871a077d33dSBarry Smith PetscCall(PetscOptionsInt("-pc_fieldsplit_gkb_maxit", "Maximum allowed number of iterations", "PCFieldSplitSetGKBMaxit", jac->gkbmaxit, &jac->gkbmaxit, NULL)); 18729566063dSJacob Faibussowitsch PetscCall(PetscOptionsBool("-pc_fieldsplit_gkb_monitor", "Prints number of GKB iterations and error", "PCFieldSplitGKB", jac->gkbmonitor, &jac->gkbmonitor, NULL)); 1873c5d2311dSJed Brown } 187434603f55SBarry Smith /* 187534603f55SBarry Smith In the initial call to this routine the sub-solver data structures do not exist so we cannot call KSPSetFromOptions() on them yet. 187634603f55SBarry 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 187734603f55SBarry Smith is called on the outer solver in case changes were made in the options database 187834603f55SBarry Smith 187934603f55SBarry 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() 188034603f55SBarry 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. 188134603f55SBarry Smith Without this extra check test p2p1fetidp_olof_full and others fail with incorrect matrix types. 188234603f55SBarry Smith 188334603f55SBarry Smith There could be a negative side effect of calling the KSPSetFromOptions() below. 188434603f55SBarry Smith 188534603f55SBarry 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 188634603f55SBarry Smith */ 188734603f55SBarry Smith if (jac->issetup) { 188834603f55SBarry Smith PC_FieldSplitLink ilink = jac->head; 188934603f55SBarry Smith if (jac->type == PC_COMPOSITE_SCHUR) { 189034603f55SBarry Smith if (jac->kspupper && jac->kspupper->totalits > 0) PetscCall(KSPSetFromOptions(jac->kspupper)); 189134603f55SBarry Smith if (jac->kspschur && jac->kspschur->totalits > 0) PetscCall(KSPSetFromOptions(jac->kspschur)); 189234603f55SBarry Smith } 189334603f55SBarry Smith while (ilink) { 189434603f55SBarry Smith if (ilink->ksp->totalits > 0) PetscCall(KSPSetFromOptions(ilink->ksp)); 189534603f55SBarry Smith ilink = ilink->next; 189634603f55SBarry Smith } 189734603f55SBarry Smith } 1898d0609cedSBarry Smith PetscOptionsHeadEnd(); 18993ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 19000971522cSBarry Smith } 19010971522cSBarry Smith 1902d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCFieldSplitSetFields_FieldSplit(PC pc, const char splitname[], PetscInt n, const PetscInt *fields, const PetscInt *fields_col) 1903d71ae5a4SJacob Faibussowitsch { 190497bbdb24SBarry Smith PC_FieldSplit *jac = (PC_FieldSplit *)pc->data; 19055a9f2f41SSatish Balay PC_FieldSplitLink ilink, next = jac->head; 190669a612a9SBarry Smith char prefix[128]; 19075d4c12cdSJungho Lee PetscInt i; 19080971522cSBarry Smith 19090971522cSBarry Smith PetscFunctionBegin; 19106c924f48SJed Brown if (jac->splitdefined) { 19119566063dSJacob Faibussowitsch PetscCall(PetscInfo(pc, "Ignoring new split \"%s\" because the splits have already been defined\n", splitname)); 19123ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 19136c924f48SJed Brown } 191480670ca5SBarry Smith for (i = 0; i < n; i++) { PetscCheck(fields[i] >= 0, PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Negative field %" PetscInt_FMT " requested", fields[i]); } 19159566063dSJacob Faibussowitsch PetscCall(PetscNew(&ilink)); 1916a04f6461SBarry Smith if (splitname) { 19179566063dSJacob Faibussowitsch PetscCall(PetscStrallocpy(splitname, &ilink->splitname)); 1918a04f6461SBarry Smith } else { 19199566063dSJacob Faibussowitsch PetscCall(PetscMalloc1(3, &ilink->splitname)); 192063a3b9bcSJacob Faibussowitsch PetscCall(PetscSNPrintf(ilink->splitname, 2, "%" PetscInt_FMT, jac->nsplits)); 1921a04f6461SBarry Smith } 19229df09d43SBarry 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 */ 19239566063dSJacob Faibussowitsch PetscCall(PetscMalloc1(n, &ilink->fields)); 19249566063dSJacob Faibussowitsch PetscCall(PetscArraycpy(ilink->fields, fields, n)); 19259566063dSJacob Faibussowitsch PetscCall(PetscMalloc1(n, &ilink->fields_col)); 19269566063dSJacob Faibussowitsch PetscCall(PetscArraycpy(ilink->fields_col, fields_col, n)); 19272fa5cd67SKarl Rupp 19285a9f2f41SSatish Balay ilink->nfields = n; 19290298fd71SBarry Smith ilink->next = NULL; 19309566063dSJacob Faibussowitsch PetscCall(KSPCreate(PetscObjectComm((PetscObject)pc), &ilink->ksp)); 19313821be0aSBarry Smith PetscCall(KSPSetNestLevel(ilink->ksp, pc->kspnestlevel)); 19329566063dSJacob Faibussowitsch PetscCall(KSPSetErrorIfNotConverged(ilink->ksp, pc->erroriffailure)); 19339566063dSJacob Faibussowitsch PetscCall(PetscObjectIncrementTabLevel((PetscObject)ilink->ksp, (PetscObject)pc, 1)); 19349566063dSJacob Faibussowitsch PetscCall(KSPSetType(ilink->ksp, KSPPREONLY)); 193569a612a9SBarry Smith 19369566063dSJacob Faibussowitsch PetscCall(PetscSNPrintf(prefix, sizeof(prefix), "%sfieldsplit_%s_", ((PetscObject)pc)->prefix ? ((PetscObject)pc)->prefix : "", ilink->splitname)); 19379566063dSJacob Faibussowitsch PetscCall(KSPSetOptionsPrefix(ilink->ksp, prefix)); 19380971522cSBarry Smith 19390971522cSBarry Smith if (!next) { 19405a9f2f41SSatish Balay jac->head = ilink; 19410298fd71SBarry Smith ilink->previous = NULL; 19420971522cSBarry Smith } else { 1943ad540459SPierre Jolivet while (next->next) next = next->next; 19445a9f2f41SSatish Balay next->next = ilink; 194551f519a2SBarry Smith ilink->previous = next; 19460971522cSBarry Smith } 19470971522cSBarry Smith jac->nsplits++; 19483ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 19490971522cSBarry Smith } 19500971522cSBarry Smith 1951d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCFieldSplitSchurGetSubKSP_FieldSplit(PC pc, PetscInt *n, KSP **subksp) 1952d71ae5a4SJacob Faibussowitsch { 1953285fb4e2SStefano Zampini PC_FieldSplit *jac = (PC_FieldSplit *)pc->data; 1954285fb4e2SStefano Zampini 1955285fb4e2SStefano Zampini PetscFunctionBegin; 1956285fb4e2SStefano Zampini *subksp = NULL; 1957285fb4e2SStefano Zampini if (n) *n = 0; 1958285fb4e2SStefano Zampini if (jac->type == PC_COMPOSITE_SCHUR) { 1959285fb4e2SStefano Zampini PetscInt nn; 1960285fb4e2SStefano Zampini 196128b400f6SJacob Faibussowitsch PetscCheck(jac->schur, PetscObjectComm((PetscObject)pc), PETSC_ERR_ARG_WRONGSTATE, "Must call KSPSetUp() or PCSetUp() before calling PCFieldSplitSchurGetSubKSP()"); 196263a3b9bcSJacob Faibussowitsch PetscCheck(jac->nsplits == 2, PetscObjectComm((PetscObject)pc), PETSC_ERR_PLIB, "Unexpected number of splits %" PetscInt_FMT " != 2", jac->nsplits); 1963285fb4e2SStefano Zampini nn = jac->nsplits + (jac->kspupper != jac->head->ksp ? 1 : 0); 19649566063dSJacob Faibussowitsch PetscCall(PetscMalloc1(nn, subksp)); 1965285fb4e2SStefano Zampini (*subksp)[0] = jac->head->ksp; 1966285fb4e2SStefano Zampini (*subksp)[1] = jac->kspschur; 1967285fb4e2SStefano Zampini if (jac->kspupper != jac->head->ksp) (*subksp)[2] = jac->kspupper; 1968285fb4e2SStefano Zampini if (n) *n = nn; 1969285fb4e2SStefano Zampini } 19703ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 1971285fb4e2SStefano Zampini } 1972285fb4e2SStefano Zampini 1973d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCFieldSplitGetSubKSP_FieldSplit_Schur(PC pc, PetscInt *n, KSP **subksp) 1974d71ae5a4SJacob Faibussowitsch { 1975e69d4d44SBarry Smith PC_FieldSplit *jac = (PC_FieldSplit *)pc->data; 1976e69d4d44SBarry Smith 1977e69d4d44SBarry Smith PetscFunctionBegin; 197828b400f6SJacob Faibussowitsch PetscCheck(jac->schur, PetscObjectComm((PetscObject)pc), PETSC_ERR_ARG_WRONGSTATE, "Must call KSPSetUp() or PCSetUp() before calling PCFieldSplitGetSubKSP()"); 19799566063dSJacob Faibussowitsch PetscCall(PetscMalloc1(jac->nsplits, subksp)); 19809566063dSJacob Faibussowitsch PetscCall(MatSchurComplementGetKSP(jac->schur, *subksp)); 19812fa5cd67SKarl Rupp 1982e69d4d44SBarry Smith (*subksp)[1] = jac->kspschur; 198313e0d083SBarry Smith if (n) *n = jac->nsplits; 19843ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 1985e69d4d44SBarry Smith } 19860971522cSBarry Smith 1987d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCFieldSplitGetSubKSP_FieldSplit(PC pc, PetscInt *n, KSP **subksp) 1988d71ae5a4SJacob Faibussowitsch { 19890971522cSBarry Smith PC_FieldSplit *jac = (PC_FieldSplit *)pc->data; 19900971522cSBarry Smith PetscInt cnt = 0; 19915a9f2f41SSatish Balay PC_FieldSplitLink ilink = jac->head; 19920971522cSBarry Smith 19930971522cSBarry Smith PetscFunctionBegin; 19949566063dSJacob Faibussowitsch PetscCall(PetscMalloc1(jac->nsplits, subksp)); 19955a9f2f41SSatish Balay while (ilink) { 19965a9f2f41SSatish Balay (*subksp)[cnt++] = ilink->ksp; 19975a9f2f41SSatish Balay ilink = ilink->next; 19980971522cSBarry Smith } 199963a3b9bcSJacob 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); 200013e0d083SBarry Smith if (n) *n = jac->nsplits; 20013ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 20020971522cSBarry Smith } 20030971522cSBarry Smith 2004cc4c1da9SBarry Smith /*@ 2005f1580f4eSBarry Smith PCFieldSplitRestrictIS - Restricts the fieldsplit `IS`s to be within a given `IS`. 20066dbb499eSCian Wilson 20076dbb499eSCian Wilson Input Parameters: 20086dbb499eSCian Wilson + pc - the preconditioner context 2009feefa0e1SJacob Faibussowitsch - isy - the index set that defines the indices to which the fieldsplit is to be restricted 20106dbb499eSCian Wilson 20116dbb499eSCian Wilson Level: advanced 20126dbb499eSCian Wilson 2013feefa0e1SJacob Faibussowitsch Developer Notes: 2014f1580f4eSBarry Smith It seems the resulting `IS`s will not cover the entire space, so 2015f1580f4eSBarry Smith how can they define a convergent preconditioner? Needs explaining. 2016f1580f4eSBarry Smith 201760f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PCFIELDSPLIT`, `PCFieldSplitSetFields()`, `PCFieldSplitSetIS()` 20186dbb499eSCian Wilson @*/ 2019d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitRestrictIS(PC pc, IS isy) 2020d71ae5a4SJacob Faibussowitsch { 20216dbb499eSCian Wilson PetscFunctionBegin; 20226dbb499eSCian Wilson PetscValidHeaderSpecific(pc, PC_CLASSID, 1); 20236dbb499eSCian Wilson PetscValidHeaderSpecific(isy, IS_CLASSID, 2); 2024cac4c232SBarry Smith PetscTryMethod(pc, "PCFieldSplitRestrictIS_C", (PC, IS), (pc, isy)); 20253ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 20266dbb499eSCian Wilson } 20276dbb499eSCian Wilson 2028d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCFieldSplitRestrictIS_FieldSplit(PC pc, IS isy) 2029d71ae5a4SJacob Faibussowitsch { 20306dbb499eSCian Wilson PC_FieldSplit *jac = (PC_FieldSplit *)pc->data; 20316dbb499eSCian Wilson PC_FieldSplitLink ilink = jac->head, next; 20326dbb499eSCian Wilson PetscInt localsize, size, sizez, i; 20336dbb499eSCian Wilson const PetscInt *ind, *indz; 20346dbb499eSCian Wilson PetscInt *indc, *indcz; 20356dbb499eSCian Wilson PetscBool flg; 20366dbb499eSCian Wilson 20376dbb499eSCian Wilson PetscFunctionBegin; 20389566063dSJacob Faibussowitsch PetscCall(ISGetLocalSize(isy, &localsize)); 20399566063dSJacob Faibussowitsch PetscCallMPI(MPI_Scan(&localsize, &size, 1, MPIU_INT, MPI_SUM, PetscObjectComm((PetscObject)isy))); 20406dbb499eSCian Wilson size -= localsize; 20416dbb499eSCian Wilson while (ilink) { 20426dbb499eSCian Wilson IS isrl, isr; 20431c7cfba8SBarry Smith PC subpc; 20449566063dSJacob Faibussowitsch PetscCall(ISEmbed(ilink->is, isy, PETSC_TRUE, &isrl)); 20459566063dSJacob Faibussowitsch PetscCall(ISGetLocalSize(isrl, &localsize)); 20469566063dSJacob Faibussowitsch PetscCall(PetscMalloc1(localsize, &indc)); 20479566063dSJacob Faibussowitsch PetscCall(ISGetIndices(isrl, &ind)); 20489566063dSJacob Faibussowitsch PetscCall(PetscArraycpy(indc, ind, localsize)); 20499566063dSJacob Faibussowitsch PetscCall(ISRestoreIndices(isrl, &ind)); 20509566063dSJacob Faibussowitsch PetscCall(ISDestroy(&isrl)); 20516dbb499eSCian Wilson for (i = 0; i < localsize; i++) *(indc + i) += size; 20529566063dSJacob Faibussowitsch PetscCall(ISCreateGeneral(PetscObjectComm((PetscObject)isy), localsize, indc, PETSC_OWN_POINTER, &isr)); 20539566063dSJacob Faibussowitsch PetscCall(PetscObjectReference((PetscObject)isr)); 20549566063dSJacob Faibussowitsch PetscCall(ISDestroy(&ilink->is)); 20556dbb499eSCian Wilson ilink->is = isr; 20569566063dSJacob Faibussowitsch PetscCall(PetscObjectReference((PetscObject)isr)); 20579566063dSJacob Faibussowitsch PetscCall(ISDestroy(&ilink->is_col)); 20586dbb499eSCian Wilson ilink->is_col = isr; 20599566063dSJacob Faibussowitsch PetscCall(ISDestroy(&isr)); 20609566063dSJacob Faibussowitsch PetscCall(KSPGetPC(ilink->ksp, &subpc)); 20619566063dSJacob Faibussowitsch PetscCall(PetscObjectTypeCompare((PetscObject)subpc, PCFIELDSPLIT, &flg)); 20626dbb499eSCian Wilson if (flg) { 20636dbb499eSCian Wilson IS iszl, isz; 20646dbb499eSCian Wilson MPI_Comm comm; 20659566063dSJacob Faibussowitsch PetscCall(ISGetLocalSize(ilink->is, &localsize)); 20666dbb499eSCian Wilson comm = PetscObjectComm((PetscObject)ilink->is); 20679566063dSJacob Faibussowitsch PetscCall(ISEmbed(isy, ilink->is, PETSC_TRUE, &iszl)); 20689566063dSJacob Faibussowitsch PetscCallMPI(MPI_Scan(&localsize, &sizez, 1, MPIU_INT, MPI_SUM, comm)); 20696dbb499eSCian Wilson sizez -= localsize; 20709566063dSJacob Faibussowitsch PetscCall(ISGetLocalSize(iszl, &localsize)); 20719566063dSJacob Faibussowitsch PetscCall(PetscMalloc1(localsize, &indcz)); 20729566063dSJacob Faibussowitsch PetscCall(ISGetIndices(iszl, &indz)); 20739566063dSJacob Faibussowitsch PetscCall(PetscArraycpy(indcz, indz, localsize)); 20749566063dSJacob Faibussowitsch PetscCall(ISRestoreIndices(iszl, &indz)); 20759566063dSJacob Faibussowitsch PetscCall(ISDestroy(&iszl)); 20766dbb499eSCian Wilson for (i = 0; i < localsize; i++) *(indcz + i) += sizez; 20779566063dSJacob Faibussowitsch PetscCall(ISCreateGeneral(comm, localsize, indcz, PETSC_OWN_POINTER, &isz)); 20789566063dSJacob Faibussowitsch PetscCall(PCFieldSplitRestrictIS(subpc, isz)); 20799566063dSJacob Faibussowitsch PetscCall(ISDestroy(&isz)); 20806dbb499eSCian Wilson } 20816dbb499eSCian Wilson next = ilink->next; 20826dbb499eSCian Wilson ilink = next; 20836dbb499eSCian Wilson } 20846dbb499eSCian Wilson jac->isrestrict = PETSC_TRUE; 20853ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 20866dbb499eSCian Wilson } 20876dbb499eSCian Wilson 2088d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCFieldSplitSetIS_FieldSplit(PC pc, const char splitname[], IS is) 2089d71ae5a4SJacob Faibussowitsch { 2090704ba839SBarry Smith PC_FieldSplit *jac = (PC_FieldSplit *)pc->data; 2091704ba839SBarry Smith PC_FieldSplitLink ilink, next = jac->head; 2092704ba839SBarry Smith char prefix[128]; 2093704ba839SBarry Smith 2094704ba839SBarry Smith PetscFunctionBegin; 20956c924f48SJed Brown if (jac->splitdefined) { 20969566063dSJacob Faibussowitsch PetscCall(PetscInfo(pc, "Ignoring new split \"%s\" because the splits have already been defined\n", splitname)); 20973ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 20986c924f48SJed Brown } 20999566063dSJacob Faibussowitsch PetscCall(PetscNew(&ilink)); 2100a04f6461SBarry Smith if (splitname) { 21019566063dSJacob Faibussowitsch PetscCall(PetscStrallocpy(splitname, &ilink->splitname)); 2102a04f6461SBarry Smith } else { 21039566063dSJacob Faibussowitsch PetscCall(PetscMalloc1(8, &ilink->splitname)); 210463a3b9bcSJacob Faibussowitsch PetscCall(PetscSNPrintf(ilink->splitname, 7, "%" PetscInt_FMT, jac->nsplits)); 2105a04f6461SBarry Smith } 21069df09d43SBarry 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 */ 21079566063dSJacob Faibussowitsch PetscCall(PetscObjectReference((PetscObject)is)); 21089566063dSJacob Faibussowitsch PetscCall(ISDestroy(&ilink->is)); 2109b5787286SJed Brown ilink->is = is; 21109566063dSJacob Faibussowitsch PetscCall(PetscObjectReference((PetscObject)is)); 21119566063dSJacob Faibussowitsch PetscCall(ISDestroy(&ilink->is_col)); 2112b5787286SJed Brown ilink->is_col = is; 21130298fd71SBarry Smith ilink->next = NULL; 21149566063dSJacob Faibussowitsch PetscCall(KSPCreate(PetscObjectComm((PetscObject)pc), &ilink->ksp)); 21153821be0aSBarry Smith PetscCall(KSPSetNestLevel(ilink->ksp, pc->kspnestlevel)); 21169566063dSJacob Faibussowitsch PetscCall(KSPSetErrorIfNotConverged(ilink->ksp, pc->erroriffailure)); 21179566063dSJacob Faibussowitsch PetscCall(PetscObjectIncrementTabLevel((PetscObject)ilink->ksp, (PetscObject)pc, 1)); 21189566063dSJacob Faibussowitsch PetscCall(KSPSetType(ilink->ksp, KSPPREONLY)); 2119704ba839SBarry Smith 21209566063dSJacob Faibussowitsch PetscCall(PetscSNPrintf(prefix, sizeof(prefix), "%sfieldsplit_%s_", ((PetscObject)pc)->prefix ? ((PetscObject)pc)->prefix : "", ilink->splitname)); 21219566063dSJacob Faibussowitsch PetscCall(KSPSetOptionsPrefix(ilink->ksp, prefix)); 2122704ba839SBarry Smith 2123704ba839SBarry Smith if (!next) { 2124704ba839SBarry Smith jac->head = ilink; 21250298fd71SBarry Smith ilink->previous = NULL; 2126704ba839SBarry Smith } else { 2127ad540459SPierre Jolivet while (next->next) next = next->next; 2128704ba839SBarry Smith next->next = ilink; 2129704ba839SBarry Smith ilink->previous = next; 2130704ba839SBarry Smith } 2131704ba839SBarry Smith jac->nsplits++; 21323ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 2133704ba839SBarry Smith } 2134704ba839SBarry Smith 21355d83a8b1SBarry Smith /*@ 213660f59c3bSBarry Smith PCFieldSplitSetFields - Sets the fields that define one particular split in `PCFIELDSPLIT` 21370971522cSBarry Smith 2138c3339decSBarry Smith Logically Collective 21390971522cSBarry Smith 21400971522cSBarry Smith Input Parameters: 21410971522cSBarry Smith + pc - the preconditioner context 214260f59c3bSBarry Smith . splitname - name of this split, if `NULL` the number of the split is used 21430971522cSBarry Smith . n - the number of fields in this split 21443b374dbdSBarry Smith . fields - the fields in this split 214580670ca5SBarry Smith - fields_col - generally the same as `fields`, if it does not match `fields` then the submatrix that is solved for this set of fields comes from an off-diagonal block 214680670ca5SBarry Smith of the matrix and `fields_col` provides the column indices for that block 214780670ca5SBarry Smith 214880670ca5SBarry Smith Options Database Key: 214980670ca5SBarry Smith . -pc_fieldsplit_%d_fields <a,b,..> - indicates the fields to be used in the `%d`'th split 21500971522cSBarry Smith 21510971522cSBarry Smith Level: intermediate 21520971522cSBarry Smith 215395452b02SPatrick Sanan Notes: 2154f1580f4eSBarry Smith Use `PCFieldSplitSetIS()` to set a general set of indices as a split. 2155d32f9abdSBarry Smith 215680670ca5SBarry Smith If the matrix used to construct the preconditioner is `MATNEST` then field i refers to the `is_row[i]` `IS` passed to `MatCreateNest()`. 215780670ca5SBarry Smith 215880670ca5SBarry Smith If the matrix used to construct the preconditioner is not `MATNEST` then 215980670ca5SBarry Smith `PCFieldSplitSetFields()` is for defining fields as strided blocks (based on the block size provided to the matrix with `MatSetBlocksize()` or 216080670ca5SBarry Smith to the `PC` with `PCFieldSplitSetBlockSize()`). For example, if the block 2161f1580f4eSBarry 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 2162d32f9abdSBarry Smith 0xx3xx6xx9xx12 ... x1xx4xx7xx ... xx2xx5xx8xx.. 01x34x67x... 0x1x3x5x7.. x12x45x78x.... 2163f1580f4eSBarry Smith where the numbered entries indicate what is in the split. 2164d32f9abdSBarry Smith 2165db4c96c1SJed Brown This function is called once per split (it creates a new split each time). Solve options 216660f59c3bSBarry Smith for this split will be available under the prefix `-fieldsplit_SPLITNAME_`. 2167db4c96c1SJed Brown 216880670ca5SBarry Smith `PCFieldSplitSetIS()` does not support having a `fields_col` different from `fields` 21693b374dbdSBarry Smith 2170feefa0e1SJacob Faibussowitsch Developer Notes: 2171f1580f4eSBarry Smith This routine does not actually create the `IS` representing the split, that is delayed 2172f1580f4eSBarry Smith until `PCSetUp_FieldSplit()`, because information about the vector/matrix layouts may not be 21735d4c12cdSJungho Lee available when this routine is called. 21745d4c12cdSJungho Lee 217580670ca5SBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCFieldSplitGetSubKSP()`, `PCFIELDSPLIT`, `PCFieldSplitSetBlockSize()`, `PCFieldSplitSetIS()`, `PCFieldSplitRestrictIS()`, 217680670ca5SBarry Smith `MatSetBlocksize()`, `MatCreateNest()` 21770971522cSBarry Smith @*/ 2178cc4c1da9SBarry Smith PetscErrorCode PCFieldSplitSetFields(PC pc, const char splitname[], PetscInt n, const PetscInt fields[], const PetscInt fields_col[]) 2179d71ae5a4SJacob Faibussowitsch { 21800971522cSBarry Smith PetscFunctionBegin; 21810700a824SBarry Smith PetscValidHeaderSpecific(pc, PC_CLASSID, 1); 21824f572ea9SToby Isaac PetscAssertPointer(splitname, 2); 218363a3b9bcSJacob Faibussowitsch PetscCheck(n >= 1, PetscObjectComm((PetscObject)pc), PETSC_ERR_ARG_OUTOFRANGE, "Provided number of fields %" PetscInt_FMT " in split \"%s\" not positive", n, splitname); 21844f572ea9SToby Isaac PetscAssertPointer(fields, 4); 2185cac4c232SBarry Smith PetscTryMethod(pc, "PCFieldSplitSetFields_C", (PC, const char[], PetscInt, const PetscInt *, const PetscInt *), (pc, splitname, n, fields, fields_col)); 21863ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 21870971522cSBarry Smith } 21880971522cSBarry Smith 2189c84da90fSDmitry Karpeev /*@ 2190f1580f4eSBarry Smith PCFieldSplitSetDiagUseAmat - set flag indicating whether to extract diagonal blocks from Amat (rather than Pmat) to build 2191c14e9f00SDavid Andrs the sub-matrices associated with each split. Where `KSPSetOperators`(ksp,Amat,Pmat) was used to supply the operators. 2192c84da90fSDmitry Karpeev 2193c3339decSBarry Smith Logically Collective 2194c84da90fSDmitry Karpeev 2195c84da90fSDmitry Karpeev Input Parameters: 2196c84da90fSDmitry Karpeev + pc - the preconditioner object 2197c84da90fSDmitry Karpeev - flg - boolean flag indicating whether or not to use Amat to extract the diagonal blocks from 2198c84da90fSDmitry Karpeev 219920f4b53cSBarry Smith Options Database Key: 2200147403d9SBarry Smith . -pc_fieldsplit_diag_use_amat - use the Amat to provide the diagonal blocks 2201c84da90fSDmitry Karpeev 2202c84da90fSDmitry Karpeev Level: intermediate 2203c84da90fSDmitry Karpeev 220460f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCSetOperators()`, `KSPSetOperators()`, `PCFieldSplitGetDiagUseAmat()`, `PCFieldSplitSetOffDiagUseAmat()`, `PCFIELDSPLIT` 2205c84da90fSDmitry Karpeev @*/ 2206d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitSetDiagUseAmat(PC pc, PetscBool flg) 2207d71ae5a4SJacob Faibussowitsch { 2208c84da90fSDmitry Karpeev PC_FieldSplit *jac = (PC_FieldSplit *)pc->data; 2209c84da90fSDmitry Karpeev PetscBool isfs; 2210c84da90fSDmitry Karpeev 2211c84da90fSDmitry Karpeev PetscFunctionBegin; 2212c84da90fSDmitry Karpeev PetscValidHeaderSpecific(pc, PC_CLASSID, 1); 22139566063dSJacob Faibussowitsch PetscCall(PetscObjectTypeCompare((PetscObject)pc, PCFIELDSPLIT, &isfs)); 221428b400f6SJacob Faibussowitsch PetscCheck(isfs, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "PC not of type %s", PCFIELDSPLIT); 2215c84da90fSDmitry Karpeev jac->diag_use_amat = flg; 22163ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 2217c84da90fSDmitry Karpeev } 2218c84da90fSDmitry Karpeev 2219c84da90fSDmitry Karpeev /*@ 2220f1580f4eSBarry Smith PCFieldSplitGetDiagUseAmat - get the flag indicating whether to extract diagonal blocks from Amat (rather than Pmat) to build 2221c14e9f00SDavid Andrs the sub-matrices associated with each split. Where `KSPSetOperators`(ksp,Amat,Pmat) was used to supply the operators. 2222c84da90fSDmitry Karpeev 2223c3339decSBarry Smith Logically Collective 2224c84da90fSDmitry Karpeev 222520f4b53cSBarry Smith Input Parameter: 2226c84da90fSDmitry Karpeev . pc - the preconditioner object 2227c84da90fSDmitry Karpeev 222820f4b53cSBarry Smith Output Parameter: 2229c84da90fSDmitry Karpeev . flg - boolean flag indicating whether or not to use Amat to extract the diagonal blocks from 2230c84da90fSDmitry Karpeev 2231c84da90fSDmitry Karpeev Level: intermediate 2232c84da90fSDmitry Karpeev 223360f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCSetOperators()`, `KSPSetOperators()`, `PCFieldSplitSetDiagUseAmat()`, `PCFieldSplitGetOffDiagUseAmat()`, `PCFIELDSPLIT` 2234c84da90fSDmitry Karpeev @*/ 2235d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitGetDiagUseAmat(PC pc, PetscBool *flg) 2236d71ae5a4SJacob Faibussowitsch { 2237c84da90fSDmitry Karpeev PC_FieldSplit *jac = (PC_FieldSplit *)pc->data; 2238c84da90fSDmitry Karpeev PetscBool isfs; 2239c84da90fSDmitry Karpeev 2240c84da90fSDmitry Karpeev PetscFunctionBegin; 2241c84da90fSDmitry Karpeev PetscValidHeaderSpecific(pc, PC_CLASSID, 1); 22424f572ea9SToby Isaac PetscAssertPointer(flg, 2); 22439566063dSJacob Faibussowitsch PetscCall(PetscObjectTypeCompare((PetscObject)pc, PCFIELDSPLIT, &isfs)); 224428b400f6SJacob Faibussowitsch PetscCheck(isfs, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "PC not of type %s", PCFIELDSPLIT); 2245c84da90fSDmitry Karpeev *flg = jac->diag_use_amat; 22463ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 2247c84da90fSDmitry Karpeev } 2248c84da90fSDmitry Karpeev 2249c84da90fSDmitry Karpeev /*@ 2250f1580f4eSBarry Smith PCFieldSplitSetOffDiagUseAmat - set flag indicating whether to extract off-diagonal blocks from Amat (rather than Pmat) to build 2251c14e9f00SDavid Andrs the sub-matrices associated with each split. Where `KSPSetOperators`(ksp,Amat,Pmat) was used to supply the operators. 2252c84da90fSDmitry Karpeev 2253c3339decSBarry Smith Logically Collective 2254c84da90fSDmitry Karpeev 2255c84da90fSDmitry Karpeev Input Parameters: 2256c84da90fSDmitry Karpeev + pc - the preconditioner object 2257c84da90fSDmitry Karpeev - flg - boolean flag indicating whether or not to use Amat to extract the off-diagonal blocks from 2258c84da90fSDmitry Karpeev 225920f4b53cSBarry Smith Options Database Key: 2260147403d9SBarry Smith . -pc_fieldsplit_off_diag_use_amat <bool> - use the Amat to extract the off-diagonal blocks 2261c84da90fSDmitry Karpeev 2262c84da90fSDmitry Karpeev Level: intermediate 2263c84da90fSDmitry Karpeev 226460f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCSetOperators()`, `KSPSetOperators()`, `PCFieldSplitGetOffDiagUseAmat()`, `PCFieldSplitSetDiagUseAmat()`, `PCFIELDSPLIT` 2265c84da90fSDmitry Karpeev @*/ 2266d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitSetOffDiagUseAmat(PC pc, PetscBool flg) 2267d71ae5a4SJacob Faibussowitsch { 2268c84da90fSDmitry Karpeev PC_FieldSplit *jac = (PC_FieldSplit *)pc->data; 2269c84da90fSDmitry Karpeev PetscBool isfs; 2270c84da90fSDmitry Karpeev 2271c84da90fSDmitry Karpeev PetscFunctionBegin; 2272c84da90fSDmitry Karpeev PetscValidHeaderSpecific(pc, PC_CLASSID, 1); 22739566063dSJacob Faibussowitsch PetscCall(PetscObjectTypeCompare((PetscObject)pc, PCFIELDSPLIT, &isfs)); 227428b400f6SJacob Faibussowitsch PetscCheck(isfs, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "PC not of type %s", PCFIELDSPLIT); 2275c84da90fSDmitry Karpeev jac->offdiag_use_amat = flg; 22763ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 2277c84da90fSDmitry Karpeev } 2278c84da90fSDmitry Karpeev 2279c84da90fSDmitry Karpeev /*@ 2280f1580f4eSBarry Smith PCFieldSplitGetOffDiagUseAmat - get the flag indicating whether to extract off-diagonal blocks from Amat (rather than Pmat) to build 2281c14e9f00SDavid Andrs the sub-matrices associated with each split. Where `KSPSetOperators`(ksp,Amat,Pmat) was used to supply the operators. 2282c84da90fSDmitry Karpeev 2283c3339decSBarry Smith Logically Collective 2284c84da90fSDmitry Karpeev 228520f4b53cSBarry Smith Input Parameter: 2286c84da90fSDmitry Karpeev . pc - the preconditioner object 2287c84da90fSDmitry Karpeev 228820f4b53cSBarry Smith Output Parameter: 2289c84da90fSDmitry Karpeev . flg - boolean flag indicating whether or not to use Amat to extract the off-diagonal blocks from 2290c84da90fSDmitry Karpeev 2291c84da90fSDmitry Karpeev Level: intermediate 2292c84da90fSDmitry Karpeev 229360f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCSetOperators()`, `KSPSetOperators()`, `PCFieldSplitSetOffDiagUseAmat()`, `PCFieldSplitGetDiagUseAmat()`, `PCFIELDSPLIT` 2294c84da90fSDmitry Karpeev @*/ 2295d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitGetOffDiagUseAmat(PC pc, PetscBool *flg) 2296d71ae5a4SJacob Faibussowitsch { 2297c84da90fSDmitry Karpeev PC_FieldSplit *jac = (PC_FieldSplit *)pc->data; 2298c84da90fSDmitry Karpeev PetscBool isfs; 2299c84da90fSDmitry Karpeev 2300c84da90fSDmitry Karpeev PetscFunctionBegin; 2301c84da90fSDmitry Karpeev PetscValidHeaderSpecific(pc, PC_CLASSID, 1); 23024f572ea9SToby Isaac PetscAssertPointer(flg, 2); 23039566063dSJacob Faibussowitsch PetscCall(PetscObjectTypeCompare((PetscObject)pc, PCFIELDSPLIT, &isfs)); 230428b400f6SJacob Faibussowitsch PetscCheck(isfs, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "PC not of type %s", PCFIELDSPLIT); 2305c84da90fSDmitry Karpeev *flg = jac->offdiag_use_amat; 23063ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 2307c84da90fSDmitry Karpeev } 2308c84da90fSDmitry Karpeev 2309cc4c1da9SBarry Smith /*@ 2310f1580f4eSBarry Smith PCFieldSplitSetIS - Sets the exact elements for a split in a `PCFIELDSPLIT` 2311704ba839SBarry Smith 2312c3339decSBarry Smith Logically Collective 2313704ba839SBarry Smith 2314704ba839SBarry Smith Input Parameters: 2315704ba839SBarry Smith + pc - the preconditioner context 231660f59c3bSBarry Smith . splitname - name of this split, if `NULL` the number of the split is used 2317f1580f4eSBarry Smith - is - the index set that defines the elements in this split 2318704ba839SBarry Smith 231960f59c3bSBarry Smith Level: intermediate 232060f59c3bSBarry Smith 2321a6ffb8dbSJed Brown Notes: 232280670ca5SBarry Smith Use `PCFieldSplitSetFields()`, for splits defined by strided `IS` based on the matrix block size or the `is_rows[]` passed into `MATNEST` 2323a6ffb8dbSJed Brown 2324db4c96c1SJed Brown This function is called once per split (it creates a new split each time). Solve options 2325db4c96c1SJed Brown for this split will be available under the prefix -fieldsplit_SPLITNAME_. 2326d32f9abdSBarry Smith 232780670ca5SBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCFieldSplitGetSubKSP()`, `PCFIELDSPLIT`, `PCFieldSplitSetBlockSize()`, `PCFieldSplitSetFields()` 2328704ba839SBarry Smith @*/ 2329d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitSetIS(PC pc, const char splitname[], IS is) 2330d71ae5a4SJacob Faibussowitsch { 2331704ba839SBarry Smith PetscFunctionBegin; 23320700a824SBarry Smith PetscValidHeaderSpecific(pc, PC_CLASSID, 1); 23334f572ea9SToby Isaac if (splitname) PetscAssertPointer(splitname, 2); 2334db4c96c1SJed Brown PetscValidHeaderSpecific(is, IS_CLASSID, 3); 2335cac4c232SBarry Smith PetscTryMethod(pc, "PCFieldSplitSetIS_C", (PC, const char[], IS), (pc, splitname, is)); 23363ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 2337704ba839SBarry Smith } 2338704ba839SBarry Smith 2339cc4c1da9SBarry Smith /*@ 2340f1580f4eSBarry Smith PCFieldSplitGetIS - Retrieves the elements for a split as an `IS` 234157a9adfeSMatthew G Knepley 2342c3339decSBarry Smith Logically Collective 234357a9adfeSMatthew G Knepley 234457a9adfeSMatthew G Knepley Input Parameters: 234557a9adfeSMatthew G Knepley + pc - the preconditioner context 234657a9adfeSMatthew G Knepley - splitname - name of this split 234757a9adfeSMatthew G Knepley 234857a9adfeSMatthew G Knepley Output Parameter: 2349feefa0e1SJacob Faibussowitsch . is - the index set that defines the elements in this split, or `NULL` if the split is not found 235057a9adfeSMatthew G Knepley 235157a9adfeSMatthew G Knepley Level: intermediate 235257a9adfeSMatthew G Knepley 235380670ca5SBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCFieldSplitGetSubKSP()`, `PCFIELDSPLIT`, `PCFieldSplitSetIS()`, `PCFieldSplitGetISByIndex()` 235457a9adfeSMatthew G Knepley @*/ 2355d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitGetIS(PC pc, const char splitname[], IS *is) 2356d71ae5a4SJacob Faibussowitsch { 235757a9adfeSMatthew G Knepley PetscFunctionBegin; 235857a9adfeSMatthew G Knepley PetscValidHeaderSpecific(pc, PC_CLASSID, 1); 23594f572ea9SToby Isaac PetscAssertPointer(splitname, 2); 23604f572ea9SToby Isaac PetscAssertPointer(is, 3); 236157a9adfeSMatthew G Knepley { 236257a9adfeSMatthew G Knepley PC_FieldSplit *jac = (PC_FieldSplit *)pc->data; 236357a9adfeSMatthew G Knepley PC_FieldSplitLink ilink = jac->head; 236457a9adfeSMatthew G Knepley PetscBool found; 236557a9adfeSMatthew G Knepley 23660298fd71SBarry Smith *is = NULL; 236757a9adfeSMatthew G Knepley while (ilink) { 23689566063dSJacob Faibussowitsch PetscCall(PetscStrcmp(ilink->splitname, splitname, &found)); 236957a9adfeSMatthew G Knepley if (found) { 237057a9adfeSMatthew G Knepley *is = ilink->is; 237157a9adfeSMatthew G Knepley break; 237257a9adfeSMatthew G Knepley } 237357a9adfeSMatthew G Knepley ilink = ilink->next; 237457a9adfeSMatthew G Knepley } 237557a9adfeSMatthew G Knepley } 23763ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 237757a9adfeSMatthew G Knepley } 237857a9adfeSMatthew G Knepley 2379cc4c1da9SBarry Smith /*@ 2380f1580f4eSBarry Smith PCFieldSplitGetISByIndex - Retrieves the elements for a given split as an `IS` 2381998f007dSPierre Jolivet 2382c3339decSBarry Smith Logically Collective 2383998f007dSPierre Jolivet 2384998f007dSPierre Jolivet Input Parameters: 2385998f007dSPierre Jolivet + pc - the preconditioner context 2386998f007dSPierre Jolivet - index - index of this split 2387998f007dSPierre Jolivet 2388998f007dSPierre Jolivet Output Parameter: 2389feefa0e1SJacob Faibussowitsch . is - the index set that defines the elements in this split 2390998f007dSPierre Jolivet 2391998f007dSPierre Jolivet Level: intermediate 2392998f007dSPierre Jolivet 239380670ca5SBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCFieldSplitGetSubKSP()`, `PCFIELDSPLIT`, `PCFieldSplitGetIS()`, `PCFieldSplitSetIS()`, 239480670ca5SBarry Smith 2395998f007dSPierre Jolivet @*/ 2396d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitGetISByIndex(PC pc, PetscInt index, IS *is) 2397d71ae5a4SJacob Faibussowitsch { 2398998f007dSPierre Jolivet PetscFunctionBegin; 239963a3b9bcSJacob Faibussowitsch PetscCheck(index >= 0, PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Negative field %" PetscInt_FMT " requested", index); 2400998f007dSPierre Jolivet PetscValidHeaderSpecific(pc, PC_CLASSID, 1); 24014f572ea9SToby Isaac PetscAssertPointer(is, 3); 2402998f007dSPierre Jolivet { 2403998f007dSPierre Jolivet PC_FieldSplit *jac = (PC_FieldSplit *)pc->data; 2404998f007dSPierre Jolivet PC_FieldSplitLink ilink = jac->head; 2405998f007dSPierre Jolivet PetscInt i = 0; 240663a3b9bcSJacob Faibussowitsch PetscCheck(index < jac->nsplits, PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field %" PetscInt_FMT " requested but only %" PetscInt_FMT " exist", index, jac->nsplits); 2407998f007dSPierre Jolivet 2408998f007dSPierre Jolivet while (i < index) { 2409998f007dSPierre Jolivet ilink = ilink->next; 2410998f007dSPierre Jolivet ++i; 2411998f007dSPierre Jolivet } 24129566063dSJacob Faibussowitsch PetscCall(PCFieldSplitGetIS(pc, ilink->splitname, is)); 2413998f007dSPierre Jolivet } 24143ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 2415998f007dSPierre Jolivet } 2416998f007dSPierre Jolivet 241751f519a2SBarry Smith /*@ 241851f519a2SBarry Smith PCFieldSplitSetBlockSize - Sets the block size for defining where fields start in the 241980670ca5SBarry Smith fieldsplit preconditioner when calling `PCFieldSplitSetFields()`. If not set the matrix block size is used. 242051f519a2SBarry Smith 2421c3339decSBarry Smith Logically Collective 242251f519a2SBarry Smith 242351f519a2SBarry Smith Input Parameters: 242451f519a2SBarry Smith + pc - the preconditioner context 242551f519a2SBarry Smith - bs - the block size 242651f519a2SBarry Smith 242751f519a2SBarry Smith Level: intermediate 242851f519a2SBarry Smith 242980670ca5SBarry Smith Note: 243080670ca5SBarry Smith If the matrix is a `MATNEST` then the `is_rows[]` passed to `MatCreateNest()` determines the fields. 243180670ca5SBarry Smith 243260f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCFieldSplitGetSubKSP()`, `PCFIELDSPLIT`, `PCFieldSplitSetFields()`, `PCFieldSplitSetIS()` 243351f519a2SBarry Smith @*/ 2434d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitSetBlockSize(PC pc, PetscInt bs) 2435d71ae5a4SJacob Faibussowitsch { 243651f519a2SBarry Smith PetscFunctionBegin; 24370700a824SBarry Smith PetscValidHeaderSpecific(pc, PC_CLASSID, 1); 2438c5eb9154SBarry Smith PetscValidLogicalCollectiveInt(pc, bs, 2); 2439cac4c232SBarry Smith PetscTryMethod(pc, "PCFieldSplitSetBlockSize_C", (PC, PetscInt), (pc, bs)); 24403ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 244151f519a2SBarry Smith } 244251f519a2SBarry Smith 24430971522cSBarry Smith /*@C 2444f1580f4eSBarry Smith PCFieldSplitGetSubKSP - Gets the `KSP` contexts for all splits 24450971522cSBarry Smith 2446c3339decSBarry Smith Collective 24470971522cSBarry Smith 24480971522cSBarry Smith Input Parameter: 24490971522cSBarry Smith . pc - the preconditioner context 24500971522cSBarry Smith 24510971522cSBarry Smith Output Parameters: 245213e0d083SBarry Smith + n - the number of splits 2453f1580f4eSBarry Smith - subksp - the array of `KSP` contexts 2454196cc216SBarry Smith 24550971522cSBarry Smith Level: advanced 24560971522cSBarry Smith 2457f1580f4eSBarry Smith Notes: 2458f1580f4eSBarry Smith After `PCFieldSplitGetSubKSP()` the array of `KSP`s is to be freed by the user with `PetscFree()` 2459f1580f4eSBarry Smith (not the `KSP`, just the array that contains them). 2460f1580f4eSBarry Smith 2461f1580f4eSBarry Smith You must call `PCSetUp()` before calling `PCFieldSplitGetSubKSP()`. 2462f1580f4eSBarry Smith 2463f1580f4eSBarry Smith If the fieldsplit is of type `PC_COMPOSITE_SCHUR`, it returns the `KSP` object used inside the 2464f1580f4eSBarry Smith Schur complement and the `KSP` object used to iterate over the Schur complement. 2465f1580f4eSBarry Smith To access all the `KSP` objects used in `PC_COMPOSITE_SCHUR`, use `PCFieldSplitSchurGetSubKSP()`. 2466f1580f4eSBarry Smith 2467f1580f4eSBarry Smith If the fieldsplit is of type `PC_COMPOSITE_GKB`, it returns the `KSP` object used to solve the 2468f1580f4eSBarry Smith inner linear system defined by the matrix H in each loop. 2469f1580f4eSBarry Smith 2470feefa0e1SJacob Faibussowitsch Fortran Notes: 2471f1580f4eSBarry Smith You must pass in a `KSP` array that is large enough to contain all the `KSP`s. 2472f1580f4eSBarry Smith You can call `PCFieldSplitGetSubKSP`(pc,n,`PETSC_NULL_KSP`,ierr) to determine how large the 2473f1580f4eSBarry Smith `KSP` array must be. 2474f1580f4eSBarry Smith 2475feefa0e1SJacob Faibussowitsch Developer Notes: 2476f1580f4eSBarry Smith There should be a `PCFieldSplitRestoreSubKSP()` instead of requiring the user to call `PetscFree()` 2477f1580f4eSBarry Smith 24785d83a8b1SBarry Smith The Fortran interface could be modernized to return directly the array of values. 2479f1580f4eSBarry Smith 248060f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCFIELDSPLIT`, `PCFieldSplitSetFields()`, `PCFieldSplitSetIS()`, `PCFieldSplitSchurGetSubKSP()` 24810971522cSBarry Smith @*/ 2482d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitGetSubKSP(PC pc, PetscInt *n, KSP *subksp[]) 2483d71ae5a4SJacob Faibussowitsch { 24840971522cSBarry Smith PetscFunctionBegin; 24850700a824SBarry Smith PetscValidHeaderSpecific(pc, PC_CLASSID, 1); 24864f572ea9SToby Isaac if (n) PetscAssertPointer(n, 2); 2487cac4c232SBarry Smith PetscUseMethod(pc, "PCFieldSplitGetSubKSP_C", (PC, PetscInt *, KSP **), (pc, n, subksp)); 24883ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 24890971522cSBarry Smith } 24900971522cSBarry Smith 2491285fb4e2SStefano Zampini /*@C 2492f1580f4eSBarry Smith PCFieldSplitSchurGetSubKSP - Gets the `KSP` contexts used inside the Schur complement based `PCFIELDSPLIT` 2493285fb4e2SStefano Zampini 249460f59c3bSBarry Smith Collective 2495285fb4e2SStefano Zampini 2496285fb4e2SStefano Zampini Input Parameter: 2497285fb4e2SStefano Zampini . pc - the preconditioner context 2498285fb4e2SStefano Zampini 2499285fb4e2SStefano Zampini Output Parameters: 2500285fb4e2SStefano Zampini + n - the number of splits 2501f1580f4eSBarry Smith - subksp - the array of `KSP` contexts 2502285fb4e2SStefano Zampini 2503285fb4e2SStefano Zampini Level: advanced 2504285fb4e2SStefano Zampini 2505f1580f4eSBarry Smith Notes: 2506f1580f4eSBarry Smith After `PCFieldSplitSchurGetSubKSP()` the array of `KSP`s is to be freed by the user with `PetscFree()` 2507f1580f4eSBarry Smith (not the `KSP` just the array that contains them). 2508f1580f4eSBarry Smith 2509f1580f4eSBarry Smith You must call `PCSetUp()` before calling `PCFieldSplitSchurGetSubKSP()`. 2510f1580f4eSBarry Smith 2511f1580f4eSBarry Smith If the fieldsplit type is of type `PC_COMPOSITE_SCHUR`, it returns (in order) 2512f1580f4eSBarry Smith + 1 - the `KSP` used for the (1,1) block 2513f1580f4eSBarry Smith . 2 - the `KSP` used for the Schur complement (not the one used for the interior Schur solver) 2514f1580f4eSBarry Smith - 3 - the `KSP` used for the (1,1) block in the upper triangular factor (if different from that of the (1,1) block). 2515f1580f4eSBarry Smith 2516f1580f4eSBarry Smith It returns a null array if the fieldsplit is not of type `PC_COMPOSITE_SCHUR`; in this case, you should use `PCFieldSplitGetSubKSP()`. 2517f1580f4eSBarry Smith 2518feefa0e1SJacob Faibussowitsch Fortran Notes: 2519f1580f4eSBarry Smith You must pass in a `KSP` array that is large enough to contain all the local `KSP`s. 2520f1580f4eSBarry Smith You can call `PCFieldSplitSchurGetSubKSP`(pc,n,`PETSC_NULL_KSP`,ierr) to determine how large the 2521f1580f4eSBarry Smith `KSP` array must be. 2522f1580f4eSBarry Smith 2523f1580f4eSBarry Smith Developer Notes: 2524f1580f4eSBarry Smith There should be a `PCFieldSplitRestoreSubKSP()` instead of requiring the user to call `PetscFree()` 2525f1580f4eSBarry Smith 2526f1580f4eSBarry Smith Should the functionality of `PCFieldSplitSchurGetSubKSP()` and `PCFieldSplitGetSubKSP()` be merged? 2527f1580f4eSBarry Smith 2528f1580f4eSBarry Smith The Fortran interface should be modernized to return directly the array of values. 2529f1580f4eSBarry Smith 253060f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCFIELDSPLIT`, `PCFieldSplitSetFields()`, `PCFieldSplitSetIS()`, `PCFieldSplitGetSubKSP()` 2531285fb4e2SStefano Zampini @*/ 2532d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitSchurGetSubKSP(PC pc, PetscInt *n, KSP *subksp[]) 2533d71ae5a4SJacob Faibussowitsch { 2534285fb4e2SStefano Zampini PetscFunctionBegin; 2535285fb4e2SStefano Zampini PetscValidHeaderSpecific(pc, PC_CLASSID, 1); 25364f572ea9SToby Isaac if (n) PetscAssertPointer(n, 2); 2537cac4c232SBarry Smith PetscUseMethod(pc, "PCFieldSplitSchurGetSubKSP_C", (PC, PetscInt *, KSP **), (pc, n, subksp)); 25383ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 2539285fb4e2SStefano Zampini } 2540285fb4e2SStefano Zampini 2541e69d4d44SBarry Smith /*@ 2542c14e9f00SDavid Andrs PCFieldSplitSetSchurPre - Indicates from what operator the preconditioner is constructed for the Schur complement. 2543a1e3cbf9SBarry Smith The default is the A11 matrix. 2544e69d4d44SBarry Smith 2545c3339decSBarry Smith Collective 2546e69d4d44SBarry Smith 2547e69d4d44SBarry Smith Input Parameters: 2548e69d4d44SBarry Smith + pc - the preconditioner context 2549f1580f4eSBarry Smith . ptype - which matrix to use for preconditioning the Schur complement: `PC_FIELDSPLIT_SCHUR_PRE_A11` (default), 2550f1580f4eSBarry Smith `PC_FIELDSPLIT_SCHUR_PRE_SELF`, `PC_FIELDSPLIT_SCHUR_PRE_USER`, 2551f1580f4eSBarry Smith `PC_FIELDSPLIT_SCHUR_PRE_SELFP`, and `PC_FIELDSPLIT_SCHUR_PRE_FULL` 255260f59c3bSBarry Smith - pre - matrix to use for preconditioning, or `NULL` 2553084e4875SJed Brown 2554f1580f4eSBarry Smith Options Database Keys: 2555d59693daSPierre Jolivet + -pc_fieldsplit_schur_precondition <self,selfp,user,a11,full> - default is `a11`. See notes for meaning of various arguments 2556a1e3cbf9SBarry Smith - -fieldsplit_1_pc_type <pctype> - the preconditioner algorithm that is used to construct the preconditioner from the operator 2557e69d4d44SBarry Smith 255860f59c3bSBarry Smith Level: intermediate 255960f59c3bSBarry Smith 2560fd1303e9SJungho Lee Notes: 2561f1580f4eSBarry Smith If ptype is 2562f1580f4eSBarry Smith + a11 - the preconditioner for the Schur complement is generated from the block diagonal part of the preconditioner 2563f1580f4eSBarry Smith matrix associated with the Schur complement (i.e. A11), not the Schur complement matrix 2564f1580f4eSBarry Smith . self - the preconditioner for the Schur complement is generated from the symbolic representation of the Schur complement matrix: 2565e7593814SPierre Jolivet The only preconditioners that currently work with this symbolic representation matrix object are `PCLSC` and `PCHPDDM` 2566f1580f4eSBarry Smith . user - the preconditioner for the Schur complement is generated from the user provided matrix (pre argument 2567f1580f4eSBarry Smith to this function). 2568a077d33dSBarry Smith . selfp - the preconditioning for the Schur complement is generated from an explicitly-assembled approximation $ Sp = A11 - A10 inv(diag(A00)) A01 $ 2569f1580f4eSBarry Smith This is only a good preconditioner when diag(A00) is a good preconditioner for A00. Optionally, A00 can be 2570d59693daSPierre Jolivet lumped before extracting the diagonal using the additional option `-fieldsplit_1_mat_schur_complement_ainv_type lump` 2571f1580f4eSBarry Smith - full - the preconditioner for the Schur complement is generated from the exact Schur complement matrix representation 2572f1580f4eSBarry Smith computed internally by `PCFIELDSPLIT` (this is expensive) 2573f1580f4eSBarry Smith useful mostly as a test that the Schur complement approach can work for your problem 2574fd1303e9SJungho Lee 2575d59693daSPierre Jolivet When solving a saddle point problem, where the A11 block is identically zero, using `a11` as the ptype only makes sense 2576a077d33dSBarry Smith with the additional option `-fieldsplit_1_pc_type none`. Usually for saddle point problems one would use a `ptype` of `self` and 2577d59693daSPierre Jolivet `-fieldsplit_1_pc_type lsc` which uses the least squares commutator to compute a preconditioner for the Schur complement. 2578fd1303e9SJungho Lee 2579a077d33dSBarry Smith Developer Note: 2580a077d33dSBarry Smith The name of this function and the option `-pc_fieldsplit_schur_precondition` are inconsistent; precondition should be used everywhere. 2581feefa0e1SJacob Faibussowitsch 2582a077d33dSBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCFieldSplitGetSchurPre()`, `PCFieldSplitGetSubKSP()`, `PCFIELDSPLIT`, `PCFieldSplitSetFields()`, `PCFieldSplitSchurPreType`, 2583a077d33dSBarry Smith `MatSchurComplementSetAinvType()`, `PCLSC`, `PCFieldSplitSetSchurFactType()` 2584e69d4d44SBarry Smith @*/ 2585d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitSetSchurPre(PC pc, PCFieldSplitSchurPreType ptype, Mat pre) 2586d71ae5a4SJacob Faibussowitsch { 2587e69d4d44SBarry Smith PetscFunctionBegin; 25880700a824SBarry Smith PetscValidHeaderSpecific(pc, PC_CLASSID, 1); 2589cac4c232SBarry Smith PetscTryMethod(pc, "PCFieldSplitSetSchurPre_C", (PC, PCFieldSplitSchurPreType, Mat), (pc, ptype, pre)); 25903ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 2591e69d4d44SBarry Smith } 2592686bed4dSStefano Zampini 2593d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitSchurPrecondition(PC pc, PCFieldSplitSchurPreType ptype, Mat pre) 2594d71ae5a4SJacob Faibussowitsch { 25959371c9d4SSatish Balay return PCFieldSplitSetSchurPre(pc, ptype, pre); 25969371c9d4SSatish Balay } /* Deprecated name */ 2597e69d4d44SBarry Smith 259837a82bf0SJed Brown /*@ 259937a82bf0SJed Brown PCFieldSplitGetSchurPre - For Schur complement fieldsplit, determine how the Schur complement will be 2600f1580f4eSBarry Smith preconditioned. See `PCFieldSplitSetSchurPre()` for details. 260137a82bf0SJed Brown 2602c3339decSBarry Smith Logically Collective 260337a82bf0SJed Brown 2604f899ff85SJose E. Roman Input Parameter: 260537a82bf0SJed Brown . pc - the preconditioner context 260637a82bf0SJed Brown 260737a82bf0SJed Brown Output Parameters: 2608d59693daSPierre Jolivet + ptype - which matrix to use for preconditioning the Schur complement: `PC_FIELDSPLIT_SCHUR_PRE_A11`, `PC_FIELDSPLIT_SCHUR_PRE_SELF`, `PC_FIELDSPLIT_SCHUR_PRE_USER` 2609d59693daSPierre Jolivet - pre - matrix to use for preconditioning (with `PC_FIELDSPLIT_SCHUR_PRE_USER`), or `NULL` 261037a82bf0SJed Brown 261137a82bf0SJed Brown Level: intermediate 261237a82bf0SJed Brown 2613d59693daSPierre Jolivet .seealso: [](sec_block_matrices), `PC`, `PCFieldSplitSetSchurPre()`, `PCFieldSplitGetSubKSP()`, `PCFIELDSPLIT`, `PCFieldSplitSetFields()`, `PCFieldSplitSchurPreType`, `PCLSC` 261437a82bf0SJed Brown @*/ 2615d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitGetSchurPre(PC pc, PCFieldSplitSchurPreType *ptype, Mat *pre) 2616d71ae5a4SJacob Faibussowitsch { 261737a82bf0SJed Brown PetscFunctionBegin; 261837a82bf0SJed Brown PetscValidHeaderSpecific(pc, PC_CLASSID, 1); 2619cac4c232SBarry Smith PetscUseMethod(pc, "PCFieldSplitGetSchurPre_C", (PC, PCFieldSplitSchurPreType *, Mat *), (pc, ptype, pre)); 26203ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 2621e69d4d44SBarry Smith } 2622e69d4d44SBarry Smith 262345e7fc46SDmitry Karpeev /*@ 2624f1580f4eSBarry Smith PCFieldSplitSchurGetS - extract the `MATSCHURCOMPLEMENT` object used by this `PCFIELDSPLIT` in case it needs to be configured separately 262545e7fc46SDmitry Karpeev 262620f4b53cSBarry Smith Not Collective 262745e7fc46SDmitry Karpeev 262845e7fc46SDmitry Karpeev Input Parameter: 262945e7fc46SDmitry Karpeev . pc - the preconditioner context 263045e7fc46SDmitry Karpeev 263145e7fc46SDmitry Karpeev Output Parameter: 2632470b340bSDmitry Karpeev . S - the Schur complement matrix 263345e7fc46SDmitry Karpeev 263460f59c3bSBarry Smith Level: advanced 263560f59c3bSBarry Smith 2636f1580f4eSBarry Smith Note: 2637f1580f4eSBarry Smith This matrix should not be destroyed using `MatDestroy()`; rather, use `PCFieldSplitSchurRestoreS()`. 263845e7fc46SDmitry Karpeev 263960f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCFieldSplitGetSubKSP()`, `PCFIELDSPLIT`, `PCFieldSplitSchurPreType`, `PCFieldSplitSetSchurPre()`, `MATSCHURCOMPLEMENT`, `PCFieldSplitSchurRestoreS()`, 2640f1580f4eSBarry Smith `MatCreateSchurComplement()`, `MatSchurComplementGetKSP()`, `MatSchurComplementComputeExplicitOperator()`, `MatGetSchurComplement()` 264145e7fc46SDmitry Karpeev @*/ 2642d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitSchurGetS(PC pc, Mat *S) 2643d71ae5a4SJacob Faibussowitsch { 264445e7fc46SDmitry Karpeev const char *t; 264545e7fc46SDmitry Karpeev PetscBool isfs; 264645e7fc46SDmitry Karpeev PC_FieldSplit *jac; 264745e7fc46SDmitry Karpeev 264845e7fc46SDmitry Karpeev PetscFunctionBegin; 264945e7fc46SDmitry Karpeev PetscValidHeaderSpecific(pc, PC_CLASSID, 1); 26509566063dSJacob Faibussowitsch PetscCall(PetscObjectGetType((PetscObject)pc, &t)); 26519566063dSJacob Faibussowitsch PetscCall(PetscStrcmp(t, PCFIELDSPLIT, &isfs)); 265228b400f6SJacob Faibussowitsch PetscCheck(isfs, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "Expected PC of type PCFIELDSPLIT, got %s instead", t); 265345e7fc46SDmitry Karpeev jac = (PC_FieldSplit *)pc->data; 265463a3b9bcSJacob Faibussowitsch PetscCheck(jac->type == PC_COMPOSITE_SCHUR, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "Expected PCFIELDSPLIT of type SCHUR, got %d instead", jac->type); 2655470b340bSDmitry Karpeev if (S) *S = jac->schur; 26563ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 265745e7fc46SDmitry Karpeev } 265845e7fc46SDmitry Karpeev 2659470b340bSDmitry Karpeev /*@ 2660f1580f4eSBarry Smith PCFieldSplitSchurRestoreS - returns the `MATSCHURCOMPLEMENT` matrix used by this `PC` 2661470b340bSDmitry Karpeev 266220f4b53cSBarry Smith Not Collective 2663470b340bSDmitry Karpeev 2664470b340bSDmitry Karpeev Input Parameters: 2665470b340bSDmitry Karpeev + pc - the preconditioner context 2666a2b725a8SWilliam Gropp - S - the Schur complement matrix 2667470b340bSDmitry Karpeev 2668470b340bSDmitry Karpeev Level: advanced 2669470b340bSDmitry Karpeev 267060f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCFieldSplitGetSubKSP()`, `PCFIELDSPLIT`, `PCFieldSplitSchurPreType`, `PCFieldSplitSetSchurPre()`, `MatSchurComplement`, `PCFieldSplitSchurGetS()` 2671470b340bSDmitry Karpeev @*/ 2672d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitSchurRestoreS(PC pc, Mat *S) 2673d71ae5a4SJacob Faibussowitsch { 2674470b340bSDmitry Karpeev const char *t; 2675470b340bSDmitry Karpeev PetscBool isfs; 2676470b340bSDmitry Karpeev PC_FieldSplit *jac; 2677470b340bSDmitry Karpeev 2678470b340bSDmitry Karpeev PetscFunctionBegin; 2679470b340bSDmitry Karpeev PetscValidHeaderSpecific(pc, PC_CLASSID, 1); 26809566063dSJacob Faibussowitsch PetscCall(PetscObjectGetType((PetscObject)pc, &t)); 26819566063dSJacob Faibussowitsch PetscCall(PetscStrcmp(t, PCFIELDSPLIT, &isfs)); 268228b400f6SJacob Faibussowitsch PetscCheck(isfs, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "Expected PC of type PCFIELDSPLIT, got %s instead", t); 2683470b340bSDmitry Karpeev jac = (PC_FieldSplit *)pc->data; 268463a3b9bcSJacob Faibussowitsch PetscCheck(jac->type == PC_COMPOSITE_SCHUR, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "Expected PCFIELDSPLIT of type SCHUR, got %d instead", jac->type); 26857827d75bSBarry Smith PetscCheck(S && (*S == jac->schur), PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "MatSchurComplement restored is not the same as gotten"); 26863ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 2687470b340bSDmitry Karpeev } 2688470b340bSDmitry Karpeev 2689d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCFieldSplitSetSchurPre_FieldSplit(PC pc, PCFieldSplitSchurPreType ptype, Mat pre) 2690d71ae5a4SJacob Faibussowitsch { 2691e69d4d44SBarry Smith PC_FieldSplit *jac = (PC_FieldSplit *)pc->data; 2692e69d4d44SBarry Smith 2693e69d4d44SBarry Smith PetscFunctionBegin; 2694084e4875SJed Brown jac->schurpre = ptype; 2695a7476a74SDmitry Karpeev if (ptype == PC_FIELDSPLIT_SCHUR_PRE_USER && pre) { 26969566063dSJacob Faibussowitsch PetscCall(MatDestroy(&jac->schur_user)); 2697084e4875SJed Brown jac->schur_user = pre; 26989566063dSJacob Faibussowitsch PetscCall(PetscObjectReference((PetscObject)jac->schur_user)); 2699084e4875SJed Brown } 27003ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 2701e69d4d44SBarry Smith } 2702e69d4d44SBarry Smith 2703d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCFieldSplitGetSchurPre_FieldSplit(PC pc, PCFieldSplitSchurPreType *ptype, Mat *pre) 2704d71ae5a4SJacob Faibussowitsch { 270537a82bf0SJed Brown PC_FieldSplit *jac = (PC_FieldSplit *)pc->data; 270637a82bf0SJed Brown 270737a82bf0SJed Brown PetscFunctionBegin; 27086056e507SPierre Jolivet if (ptype) *ptype = jac->schurpre; 27096056e507SPierre Jolivet if (pre) *pre = jac->schur_user; 27103ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 271137a82bf0SJed Brown } 271237a82bf0SJed Brown 2713ab1df9f5SJed Brown /*@ 27141d27aa22SBarry Smith PCFieldSplitSetSchurFactType - sets which blocks of the approximate block factorization to retain in the preconditioner {cite}`murphy2000note` and {cite}`ipsen2001note` 2715ab1df9f5SJed Brown 2716c3339decSBarry Smith Collective 2717ab1df9f5SJed Brown 2718ab1df9f5SJed Brown Input Parameters: 2719ab1df9f5SJed Brown + pc - the preconditioner context 2720f1580f4eSBarry Smith - ftype - which blocks of factorization to retain, `PC_FIELDSPLIT_SCHUR_FACT_FULL` is default 2721ab1df9f5SJed Brown 2722f1580f4eSBarry Smith Options Database Key: 2723d59693daSPierre Jolivet . -pc_fieldsplit_schur_fact_type <diag,lower,upper,full> - default is `full` 2724ab1df9f5SJed Brown 2725ab1df9f5SJed Brown Level: intermediate 2726ab1df9f5SJed Brown 2727ab1df9f5SJed Brown Notes: 2728ab1df9f5SJed Brown The FULL factorization is 2729ab1df9f5SJed Brown 2730a077d33dSBarry Smith ```{math} 2731a077d33dSBarry Smith \left(\begin{array}{cc} A & B \\ 2732a077d33dSBarry Smith C & E \\ 2733a077d33dSBarry Smith \end{array}\right) = 2734a077d33dSBarry Smith \left(\begin{array}{cc} 1 & 0 \\ 2735a077d33dSBarry Smith C*A^{-1} & I \\ 2736a077d33dSBarry Smith \end{array}\right) 2737a077d33dSBarry Smith \left(\begin{array}{cc} A & 0 \\ 2738a077d33dSBarry Smith 0 & S \\ 2739a077d33dSBarry Smith \end{array}\right) 2740a077d33dSBarry Smith \left(\begin{array}{cc} I & A^{-1}B \\ 2741a077d33dSBarry Smith 0 & I \\ 2742a077d33dSBarry Smith \end{array}\right) = L D U. 2743a077d33dSBarry Smith ``` 2744a077d33dSBarry Smith 2745a077d33dSBarry Smith where $ S = E - C*A^{-1}*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$, 2746a077d33dSBarry Smith and DIAG is the diagonal part with the sign of $ S $ flipped (because this makes the preconditioner positive definite for many formulations, 2747a077d33dSBarry Smith thus allowing the use of `KSPMINRES)`. Sign flipping of $ S $ can be turned off with `PCFieldSplitSetSchurScale()`. 2748a077d33dSBarry Smith 2749a077d33dSBarry Smith If $A$ and $S$ are solved exactly 2750a077d33dSBarry Smith + 1 - FULL factorization is a direct solver. 2751a077d33dSBarry Smith . 2 - 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. 2752a077d33dSBarry Smith - 3 - 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. 2753ab1df9f5SJed Brown 2754f1580f4eSBarry Smith If the iteration count is very low, consider using `KSPFGMRES` or `KSPGCR` which can use one less preconditioner 27550ffb0e17SBarry 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. 27560ffb0e17SBarry Smith 2757a077d33dSBarry Smith For symmetric problems in which $A$ is positive definite and $S$ is negative definite, DIAG can be used with `KSPMINRES`. 27580ffb0e17SBarry Smith 27591d27aa22SBarry Smith A flexible method like `KSPFGMRES` or `KSPGCR`, [](sec_flexibleksp), 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). 2760ab1df9f5SJed Brown 27611d27aa22SBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCFieldSplitGetSubKSP()`, `PCFIELDSPLIT`, `PCFieldSplitSetFields()`, `PCFieldSplitSchurPreType`, `PCFieldSplitSetSchurScale()`, 2762a077d33dSBarry Smith [](sec_flexibleksp), `PCFieldSplitSetSchurPre()` 2763ab1df9f5SJed Brown @*/ 2764d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitSetSchurFactType(PC pc, PCFieldSplitSchurFactType ftype) 2765d71ae5a4SJacob Faibussowitsch { 2766ab1df9f5SJed Brown PetscFunctionBegin; 2767ab1df9f5SJed Brown PetscValidHeaderSpecific(pc, PC_CLASSID, 1); 2768cac4c232SBarry Smith PetscTryMethod(pc, "PCFieldSplitSetSchurFactType_C", (PC, PCFieldSplitSchurFactType), (pc, ftype)); 27693ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 2770ab1df9f5SJed Brown } 2771ab1df9f5SJed Brown 2772d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCFieldSplitSetSchurFactType_FieldSplit(PC pc, PCFieldSplitSchurFactType ftype) 2773d71ae5a4SJacob Faibussowitsch { 2774ab1df9f5SJed Brown PC_FieldSplit *jac = (PC_FieldSplit *)pc->data; 2775ab1df9f5SJed Brown 2776ab1df9f5SJed Brown PetscFunctionBegin; 2777ab1df9f5SJed Brown jac->schurfactorization = ftype; 27783ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 2779ab1df9f5SJed Brown } 2780ab1df9f5SJed Brown 2781c096484dSStefano Zampini /*@ 2782f1580f4eSBarry Smith PCFieldSplitSetSchurScale - Controls the sign flip of S for `PC_FIELDSPLIT_SCHUR_FACT_DIAG`. 2783c096484dSStefano Zampini 2784c3339decSBarry Smith Collective 2785c096484dSStefano Zampini 2786c096484dSStefano Zampini Input Parameters: 2787c096484dSStefano Zampini + pc - the preconditioner context 2788c096484dSStefano Zampini - scale - scaling factor for the Schur complement 2789c096484dSStefano Zampini 2790f1580f4eSBarry Smith Options Database Key: 27911d27aa22SBarry Smith . -pc_fieldsplit_schur_scale <scale> - default is -1.0 2792c096484dSStefano Zampini 2793c096484dSStefano Zampini Level: intermediate 2794c096484dSStefano Zampini 279542747ad1SJacob Faibussowitsch .seealso: [](sec_block_matrices), `PC`, `PCFIELDSPLIT`, `PCFieldSplitSetFields()`, `PCFieldSplitSchurFactType`, `PCFieldSplitSetSchurFactType()` 2796c096484dSStefano Zampini @*/ 2797d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitSetSchurScale(PC pc, PetscScalar scale) 2798d71ae5a4SJacob Faibussowitsch { 2799c096484dSStefano Zampini PetscFunctionBegin; 2800c096484dSStefano Zampini PetscValidHeaderSpecific(pc, PC_CLASSID, 1); 2801c096484dSStefano Zampini PetscValidLogicalCollectiveScalar(pc, scale, 2); 2802cac4c232SBarry Smith PetscTryMethod(pc, "PCFieldSplitSetSchurScale_C", (PC, PetscScalar), (pc, scale)); 28033ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 2804c096484dSStefano Zampini } 2805c096484dSStefano Zampini 2806d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCFieldSplitSetSchurScale_FieldSplit(PC pc, PetscScalar scale) 2807d71ae5a4SJacob Faibussowitsch { 2808c096484dSStefano Zampini PC_FieldSplit *jac = (PC_FieldSplit *)pc->data; 2809c096484dSStefano Zampini 2810c096484dSStefano Zampini PetscFunctionBegin; 2811c096484dSStefano Zampini jac->schurscale = scale; 28123ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 2813c096484dSStefano Zampini } 2814c096484dSStefano Zampini 281530ad9308SMatthew Knepley /*@C 28168c03b21aSDmitry Karpeev PCFieldSplitGetSchurBlocks - Gets all matrix blocks for the Schur complement 281730ad9308SMatthew Knepley 2818c3339decSBarry Smith Collective 281930ad9308SMatthew Knepley 282030ad9308SMatthew Knepley Input Parameter: 282130ad9308SMatthew Knepley . pc - the preconditioner context 282230ad9308SMatthew Knepley 282330ad9308SMatthew Knepley Output Parameters: 2824a04f6461SBarry Smith + A00 - the (0,0) block 2825a04f6461SBarry Smith . A01 - the (0,1) block 2826a04f6461SBarry Smith . A10 - the (1,0) block 2827a04f6461SBarry Smith - A11 - the (1,1) block 282830ad9308SMatthew Knepley 282930ad9308SMatthew Knepley Level: advanced 283030ad9308SMatthew Knepley 28315d83a8b1SBarry Smith Note: 28325d83a8b1SBarry Smith Use `NULL` for any unneeded output arguments 28335d83a8b1SBarry Smith 283460f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCFIELDSPLIT`, `MatSchurComplementGetSubMatrices()`, `MatSchurComplementSetSubMatrices()` 283530ad9308SMatthew Knepley @*/ 2836d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitGetSchurBlocks(PC pc, Mat *A00, Mat *A01, Mat *A10, Mat *A11) 2837d71ae5a4SJacob Faibussowitsch { 283830ad9308SMatthew Knepley PC_FieldSplit *jac = (PC_FieldSplit *)pc->data; 283930ad9308SMatthew Knepley 284030ad9308SMatthew Knepley PetscFunctionBegin; 28410700a824SBarry Smith PetscValidHeaderSpecific(pc, PC_CLASSID, 1); 284208401ef6SPierre Jolivet PetscCheck(jac->type == PC_COMPOSITE_SCHUR, PetscObjectComm((PetscObject)pc), PETSC_ERR_ARG_WRONG, "FieldSplit is not using a Schur complement approach."); 2843a04f6461SBarry Smith if (A00) *A00 = jac->pmat[0]; 2844a04f6461SBarry Smith if (A01) *A01 = jac->B; 2845a04f6461SBarry Smith if (A10) *A10 = jac->C; 2846a04f6461SBarry Smith if (A11) *A11 = jac->pmat[1]; 28473ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 284830ad9308SMatthew Knepley } 284930ad9308SMatthew Knepley 2850b09e027eSCarola Kruse /*@ 28511d27aa22SBarry Smith PCFieldSplitSetGKBTol - Sets the solver tolerance for the generalized Golub-Kahan bidiagonalization preconditioner {cite}`arioli2013` in `PCFIELDSPLIT` 2852b09e027eSCarola Kruse 2853c3339decSBarry Smith Collective 2854e071a0a4SCarola Kruse 2855b09e027eSCarola Kruse Input Parameters: 2856b09e027eSCarola Kruse + pc - the preconditioner context 2857b09e027eSCarola Kruse - tolerance - the solver tolerance 2858b09e027eSCarola Kruse 2859f1580f4eSBarry Smith Options Database Key: 28601d27aa22SBarry Smith . -pc_fieldsplit_gkb_tol <tolerance> - default is 1e-5 2861b09e027eSCarola Kruse 2862b09e027eSCarola Kruse Level: intermediate 2863b09e027eSCarola Kruse 2864f1580f4eSBarry Smith Note: 28651d27aa22SBarry Smith The generalized GKB algorithm {cite}`arioli2013` uses a lower bound estimate of the error in energy norm as stopping criterion. 2866f1580f4eSBarry Smith It stops once the lower bound estimate undershoots the required solver tolerance. Although the actual error might be bigger than 28671d27aa22SBarry Smith this estimate, the stopping criterion is satisfactory in practical cases. 2868f1580f4eSBarry Smith 286960f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCFIELDSPLIT`, `PCFieldSplitSetGKBDelay()`, `PCFieldSplitSetGKBNu()`, `PCFieldSplitSetGKBMaxit()` 2870b09e027eSCarola Kruse @*/ 2871d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitSetGKBTol(PC pc, PetscReal tolerance) 2872d71ae5a4SJacob Faibussowitsch { 2873b09e027eSCarola Kruse PetscFunctionBegin; 2874b09e027eSCarola Kruse PetscValidHeaderSpecific(pc, PC_CLASSID, 1); 2875de482cd7SCarola Kruse PetscValidLogicalCollectiveReal(pc, tolerance, 2); 2876cac4c232SBarry Smith PetscTryMethod(pc, "PCFieldSplitSetGKBTol_C", (PC, PetscReal), (pc, tolerance)); 28773ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 2878b09e027eSCarola Kruse } 2879b09e027eSCarola Kruse 2880d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCFieldSplitSetGKBTol_FieldSplit(PC pc, PetscReal tolerance) 2881d71ae5a4SJacob Faibussowitsch { 2882b09e027eSCarola Kruse PC_FieldSplit *jac = (PC_FieldSplit *)pc->data; 2883b09e027eSCarola Kruse 2884b09e027eSCarola Kruse PetscFunctionBegin; 2885b09e027eSCarola Kruse jac->gkbtol = tolerance; 28863ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 2887b09e027eSCarola Kruse } 2888b09e027eSCarola Kruse 2889b09e027eSCarola Kruse /*@ 289080670ca5SBarry Smith PCFieldSplitSetGKBMaxit - Sets the maximum number of iterations for the generalized Golub-Kahan bidiagonalization preconditioner {cite}`arioli2013` in `PCFIELDSPLIT` 2891b09e027eSCarola Kruse 2892c3339decSBarry Smith Collective 2893b09e027eSCarola Kruse 2894b09e027eSCarola Kruse Input Parameters: 2895b09e027eSCarola Kruse + pc - the preconditioner context 2896b09e027eSCarola Kruse - maxit - the maximum number of iterations 2897b09e027eSCarola Kruse 2898f1580f4eSBarry Smith Options Database Key: 28991d27aa22SBarry Smith . -pc_fieldsplit_gkb_maxit <maxit> - default is 100 2900b09e027eSCarola Kruse 2901b09e027eSCarola Kruse Level: intermediate 2902b09e027eSCarola Kruse 290360f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCFIELDSPLIT`, `PCFieldSplitSetGKBDelay()`, `PCFieldSplitSetGKBTol()`, `PCFieldSplitSetGKBNu()` 2904b09e027eSCarola Kruse @*/ 2905d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitSetGKBMaxit(PC pc, PetscInt maxit) 2906d71ae5a4SJacob Faibussowitsch { 2907b09e027eSCarola Kruse PetscFunctionBegin; 2908b09e027eSCarola Kruse PetscValidHeaderSpecific(pc, PC_CLASSID, 1); 2909de482cd7SCarola Kruse PetscValidLogicalCollectiveInt(pc, maxit, 2); 2910cac4c232SBarry Smith PetscTryMethod(pc, "PCFieldSplitSetGKBMaxit_C", (PC, PetscInt), (pc, maxit)); 29113ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 2912b09e027eSCarola Kruse } 2913b09e027eSCarola Kruse 2914d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCFieldSplitSetGKBMaxit_FieldSplit(PC pc, PetscInt maxit) 2915d71ae5a4SJacob Faibussowitsch { 2916b09e027eSCarola Kruse PC_FieldSplit *jac = (PC_FieldSplit *)pc->data; 2917b09e027eSCarola Kruse 2918b09e027eSCarola Kruse PetscFunctionBegin; 2919b09e027eSCarola Kruse jac->gkbmaxit = maxit; 29203ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 2921b09e027eSCarola Kruse } 2922b09e027eSCarola Kruse 2923b09e027eSCarola Kruse /*@ 29241d27aa22SBarry Smith PCFieldSplitSetGKBDelay - Sets the delay in the lower bound error estimate in the generalized Golub-Kahan bidiagonalization {cite}`arioli2013` in `PCFIELDSPLIT` 2925e071a0a4SCarola Kruse preconditioner. 2926b09e027eSCarola Kruse 2927c3339decSBarry Smith Collective 2928b09e027eSCarola Kruse 2929b09e027eSCarola Kruse Input Parameters: 2930b09e027eSCarola Kruse + pc - the preconditioner context 2931b09e027eSCarola Kruse - delay - the delay window in the lower bound estimate 2932b09e027eSCarola Kruse 2933f1580f4eSBarry Smith Options Database Key: 29341d27aa22SBarry Smith . -pc_fieldsplit_gkb_delay <delay> - default is 5 2935b09e027eSCarola Kruse 2936b09e027eSCarola Kruse Level: intermediate 2937b09e027eSCarola Kruse 29381d27aa22SBarry Smith Notes: 29391d27aa22SBarry 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 $ 29401d27aa22SBarry 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 29411d27aa22SBarry Smith at least (`delay` + 1) iterations to stop. 2942f1580f4eSBarry Smith 29431d27aa22SBarry Smith For more details on the generalized Golub-Kahan bidiagonalization method and its lower bound stopping criterion, please refer to {cite}`arioli2013` 2944f1580f4eSBarry Smith 294560f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCFIELDSPLIT`, `PCFieldSplitSetGKBNu()`, `PCFieldSplitSetGKBTol()`, `PCFieldSplitSetGKBMaxit()` 2946b09e027eSCarola Kruse @*/ 2947d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitSetGKBDelay(PC pc, PetscInt delay) 2948d71ae5a4SJacob Faibussowitsch { 2949b09e027eSCarola Kruse PetscFunctionBegin; 2950b09e027eSCarola Kruse PetscValidHeaderSpecific(pc, PC_CLASSID, 1); 2951b09e027eSCarola Kruse PetscValidLogicalCollectiveInt(pc, delay, 2); 2952cac4c232SBarry Smith PetscTryMethod(pc, "PCFieldSplitSetGKBDelay_C", (PC, PetscInt), (pc, delay)); 29533ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 2954b09e027eSCarola Kruse } 2955b09e027eSCarola Kruse 2956d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCFieldSplitSetGKBDelay_FieldSplit(PC pc, PetscInt delay) 2957d71ae5a4SJacob Faibussowitsch { 2958b09e027eSCarola Kruse PC_FieldSplit *jac = (PC_FieldSplit *)pc->data; 2959b09e027eSCarola Kruse 2960b09e027eSCarola Kruse PetscFunctionBegin; 2961b09e027eSCarola Kruse jac->gkbdelay = delay; 29623ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 2963b09e027eSCarola Kruse } 2964b09e027eSCarola Kruse 2965b09e027eSCarola Kruse /*@ 29661d27aa22SBarry Smith PCFieldSplitSetGKBNu - Sets the scalar value nu >= 0 in the transformation H = A00 + nu*A01*A01' of the (1,1) block in the 29671d27aa22SBarry Smith Golub-Kahan bidiagonalization preconditioner {cite}`arioli2013` in `PCFIELDSPLIT` 2968b09e027eSCarola Kruse 2969c3339decSBarry Smith Collective 2970f1580f4eSBarry Smith 2971f1580f4eSBarry Smith Input Parameters: 2972f1580f4eSBarry Smith + pc - the preconditioner context 2973f1580f4eSBarry Smith - nu - the shift parameter 2974f1580f4eSBarry Smith 297520f4b53cSBarry Smith Options Database Key: 29761d27aa22SBarry Smith . -pc_fieldsplit_gkb_nu <nu> - default is 1 2977f1580f4eSBarry Smith 2978f1580f4eSBarry Smith Level: intermediate 2979b09e027eSCarola Kruse 2980b09e027eSCarola Kruse Notes: 29811d27aa22SBarry Smith This shift is in general done to obtain better convergence properties for the outer loop of the algorithm. This is often achieved by choosing `nu` sufficiently large. However, 29821d27aa22SBarry Smith if `nu` is chosen too large, the matrix H might be badly conditioned and the solution of the linear system $Hx = b$ in the inner loop becomes difficult. It is therefore 2983b09e027eSCarola Kruse necessary to find a good balance in between the convergence of the inner and outer loop. 2984b09e027eSCarola Kruse 29851d27aa22SBarry Smith For `nu` = 0, no shift is done. In this case A00 has to be positive definite. The matrix N in {cite}`arioli2013` is then chosen as identity. 2986b09e027eSCarola Kruse 298760f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCFIELDSPLIT`, `PCFieldSplitSetGKBDelay()`, `PCFieldSplitSetGKBTol()`, `PCFieldSplitSetGKBMaxit()` 2988b09e027eSCarola Kruse @*/ 2989d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitSetGKBNu(PC pc, PetscReal nu) 2990d71ae5a4SJacob Faibussowitsch { 2991b09e027eSCarola Kruse PetscFunctionBegin; 2992b09e027eSCarola Kruse PetscValidHeaderSpecific(pc, PC_CLASSID, 1); 2993de482cd7SCarola Kruse PetscValidLogicalCollectiveReal(pc, nu, 2); 2994cac4c232SBarry Smith PetscTryMethod(pc, "PCFieldSplitSetGKBNu_C", (PC, PetscReal), (pc, nu)); 29953ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 2996b09e027eSCarola Kruse } 2997b09e027eSCarola Kruse 2998d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCFieldSplitSetGKBNu_FieldSplit(PC pc, PetscReal nu) 2999d71ae5a4SJacob Faibussowitsch { 3000b09e027eSCarola Kruse PC_FieldSplit *jac = (PC_FieldSplit *)pc->data; 3001b09e027eSCarola Kruse 3002b09e027eSCarola Kruse PetscFunctionBegin; 3003b09e027eSCarola Kruse jac->gkbnu = nu; 30043ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 3005b09e027eSCarola Kruse } 3006b09e027eSCarola Kruse 3007d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCFieldSplitSetType_FieldSplit(PC pc, PCCompositeType type) 3008d71ae5a4SJacob Faibussowitsch { 300979416396SBarry Smith PC_FieldSplit *jac = (PC_FieldSplit *)pc->data; 301079416396SBarry Smith 301179416396SBarry Smith PetscFunctionBegin; 301279416396SBarry Smith jac->type = type; 30132e956fe4SStefano Zampini PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitGetSubKSP_C", NULL)); 30142e956fe4SStefano Zampini PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetSchurPre_C", NULL)); 30152e956fe4SStefano Zampini PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitGetSchurPre_C", NULL)); 30162e956fe4SStefano Zampini PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetSchurFactType_C", NULL)); 30172e956fe4SStefano Zampini PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetSchurScale_C", NULL)); 30182e956fe4SStefano Zampini PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetGKBTol_C", NULL)); 30192e956fe4SStefano Zampini PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetGKBMaxit_C", NULL)); 30202e956fe4SStefano Zampini PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetGKBNu_C", NULL)); 30212e956fe4SStefano Zampini PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetGKBDelay_C", NULL)); 3022e071a0a4SCarola Kruse 30233b224e63SBarry Smith if (type == PC_COMPOSITE_SCHUR) { 30243b224e63SBarry Smith pc->ops->apply = PCApply_FieldSplit_Schur; 30257b665727SPierre Jolivet pc->ops->applytranspose = PCApplyTranspose_FieldSplit_Schur; 30263b224e63SBarry Smith pc->ops->view = PCView_FieldSplit_Schur; 30272fa5cd67SKarl Rupp 30289566063dSJacob Faibussowitsch PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitGetSubKSP_C", PCFieldSplitGetSubKSP_FieldSplit_Schur)); 30299566063dSJacob Faibussowitsch PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetSchurPre_C", PCFieldSplitSetSchurPre_FieldSplit)); 30309566063dSJacob Faibussowitsch PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitGetSchurPre_C", PCFieldSplitGetSchurPre_FieldSplit)); 30319566063dSJacob Faibussowitsch PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetSchurFactType_C", PCFieldSplitSetSchurFactType_FieldSplit)); 30329566063dSJacob Faibussowitsch PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetSchurScale_C", PCFieldSplitSetSchurScale_FieldSplit)); 3033a51937d4SCarola Kruse } else if (type == PC_COMPOSITE_GKB) { 3034a51937d4SCarola Kruse pc->ops->apply = PCApply_FieldSplit_GKB; 3035a51937d4SCarola Kruse pc->ops->view = PCView_FieldSplit_GKB; 3036e69d4d44SBarry Smith 30379566063dSJacob Faibussowitsch PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitGetSubKSP_C", PCFieldSplitGetSubKSP_FieldSplit)); 30389566063dSJacob Faibussowitsch PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetGKBTol_C", PCFieldSplitSetGKBTol_FieldSplit)); 30399566063dSJacob Faibussowitsch PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetGKBMaxit_C", PCFieldSplitSetGKBMaxit_FieldSplit)); 30409566063dSJacob Faibussowitsch PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetGKBNu_C", PCFieldSplitSetGKBNu_FieldSplit)); 30419566063dSJacob Faibussowitsch PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetGKBDelay_C", PCFieldSplitSetGKBDelay_FieldSplit)); 30423b224e63SBarry Smith } else { 30433b224e63SBarry Smith pc->ops->apply = PCApply_FieldSplit; 30443b224e63SBarry Smith pc->ops->view = PCView_FieldSplit; 30452fa5cd67SKarl Rupp 30469566063dSJacob Faibussowitsch PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitGetSubKSP_C", PCFieldSplitGetSubKSP_FieldSplit)); 30473b224e63SBarry Smith } 30483ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 304979416396SBarry Smith } 305079416396SBarry Smith 3051d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCFieldSplitSetBlockSize_FieldSplit(PC pc, PetscInt bs) 3052d71ae5a4SJacob Faibussowitsch { 305351f519a2SBarry Smith PC_FieldSplit *jac = (PC_FieldSplit *)pc->data; 305451f519a2SBarry Smith 305551f519a2SBarry Smith PetscFunctionBegin; 305663a3b9bcSJacob Faibussowitsch PetscCheck(bs >= 1, PetscObjectComm((PetscObject)pc), PETSC_ERR_ARG_OUTOFRANGE, "Blocksize must be positive, you gave %" PetscInt_FMT, bs); 30572472a847SBarry 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); 305851f519a2SBarry Smith jac->bs = bs; 30593ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 306051f519a2SBarry Smith } 306151f519a2SBarry Smith 3062d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCSetCoordinates_FieldSplit(PC pc, PetscInt dim, PetscInt nloc, PetscReal coords[]) 3063d71ae5a4SJacob Faibussowitsch { 30645ddf11f8SNicolas Barnafi PC_FieldSplit *jac = (PC_FieldSplit *)pc->data; 30655ddf11f8SNicolas Barnafi PC_FieldSplitLink ilink_current = jac->head; 30665ddf11f8SNicolas Barnafi IS is_owned; 30675ddf11f8SNicolas Barnafi 30685ddf11f8SNicolas Barnafi PetscFunctionBegin; 30695ddf11f8SNicolas Barnafi jac->coordinates_set = PETSC_TRUE; // Internal flag 3070f3fa974cSJacob Faibussowitsch PetscCall(MatGetOwnershipIS(pc->mat, &is_owned, NULL)); 30715ddf11f8SNicolas Barnafi 30725ddf11f8SNicolas Barnafi while (ilink_current) { 30735ddf11f8SNicolas Barnafi // For each IS, embed it to get local coords indces 30745ddf11f8SNicolas Barnafi IS is_coords; 30755ddf11f8SNicolas Barnafi PetscInt ndofs_block; 30765ddf11f8SNicolas Barnafi const PetscInt *block_dofs_enumeration; // Numbering of the dofs relevant to the current block 30775ddf11f8SNicolas Barnafi 30785ddf11f8SNicolas Barnafi // Setting drop to true for safety. It should make no difference. 30799566063dSJacob Faibussowitsch PetscCall(ISEmbed(ilink_current->is, is_owned, PETSC_TRUE, &is_coords)); 30809566063dSJacob Faibussowitsch PetscCall(ISGetLocalSize(is_coords, &ndofs_block)); 30819566063dSJacob Faibussowitsch PetscCall(ISGetIndices(is_coords, &block_dofs_enumeration)); 30825ddf11f8SNicolas Barnafi 30835ddf11f8SNicolas Barnafi // Allocate coordinates vector and set it directly 3084f4f49eeaSPierre Jolivet PetscCall(PetscMalloc1(ndofs_block * dim, &ilink_current->coords)); 30855ddf11f8SNicolas Barnafi for (PetscInt dof = 0; dof < ndofs_block; ++dof) { 3086ad540459SPierre Jolivet for (PetscInt d = 0; d < dim; ++d) (ilink_current->coords)[dim * dof + d] = coords[dim * block_dofs_enumeration[dof] + d]; 30875ddf11f8SNicolas Barnafi } 30885ddf11f8SNicolas Barnafi ilink_current->dim = dim; 30895ddf11f8SNicolas Barnafi ilink_current->ndofs = ndofs_block; 30909566063dSJacob Faibussowitsch PetscCall(ISRestoreIndices(is_coords, &block_dofs_enumeration)); 30919566063dSJacob Faibussowitsch PetscCall(ISDestroy(&is_coords)); 30925ddf11f8SNicolas Barnafi ilink_current = ilink_current->next; 30935ddf11f8SNicolas Barnafi } 30949566063dSJacob Faibussowitsch PetscCall(ISDestroy(&is_owned)); 30953ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 30965ddf11f8SNicolas Barnafi } 30975ddf11f8SNicolas Barnafi 3098bc08b0f1SBarry Smith /*@ 3099f1580f4eSBarry Smith PCFieldSplitSetType - Sets the type, `PCCompositeType`, of a `PCFIELDSPLIT` 310079416396SBarry Smith 3101c3339decSBarry Smith Collective 310279416396SBarry Smith 3103d8d19677SJose E. Roman Input Parameters: 3104a2b725a8SWilliam Gropp + pc - the preconditioner context 3105a077d33dSBarry Smith - type - `PC_COMPOSITE_ADDITIVE`, `PC_COMPOSITE_MULTIPLICATIVE` (default), `PC_COMPOSITE_SYMMETRIC_MULTIPLICATIVE`, `PC_COMPOSITE_SPECIAL`, `PC_COMPOSITE_SCHUR`, 3106a077d33dSBarry Smith `PC_COMPOSITE_GKB` 310779416396SBarry Smith 310879416396SBarry Smith Options Database Key: 31091d27aa22SBarry Smith . -pc_fieldsplit_type <one of multiplicative, additive, symmetric_multiplicative, special, schur> - Sets fieldsplit preconditioner type 311079416396SBarry Smith 3111feefa0e1SJacob Faibussowitsch Level: intermediate 311279416396SBarry Smith 311360f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCFIELDSPLIT`, `PCCompositeType`, `PCCompositeGetType()`, `PC_COMPOSITE_ADDITIVE`, `PC_COMPOSITE_MULTIPLICATIVE`, 3114a077d33dSBarry Smith `PC_COMPOSITE_SYMMETRIC_MULTIPLICATIVE`, `PC_COMPOSITE_SPECIAL`, `PC_COMPOSITE_SCHUR`, `PCFieldSplitSetSchurFactType()` 311579416396SBarry Smith @*/ 3116d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitSetType(PC pc, PCCompositeType type) 3117d71ae5a4SJacob Faibussowitsch { 311879416396SBarry Smith PetscFunctionBegin; 31190700a824SBarry Smith PetscValidHeaderSpecific(pc, PC_CLASSID, 1); 3120cac4c232SBarry Smith PetscTryMethod(pc, "PCFieldSplitSetType_C", (PC, PCCompositeType), (pc, type)); 31213ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 312279416396SBarry Smith } 312379416396SBarry Smith 3124b02e2d75SMatthew G Knepley /*@ 3125f1580f4eSBarry Smith PCFieldSplitGetType - Gets the type, `PCCompositeType`, of a `PCFIELDSPLIT` 3126b02e2d75SMatthew G Knepley 3127b02e2d75SMatthew G Knepley Not collective 3128b02e2d75SMatthew G Knepley 3129b02e2d75SMatthew G Knepley Input Parameter: 3130b02e2d75SMatthew G Knepley . pc - the preconditioner context 3131b02e2d75SMatthew G Knepley 3132b02e2d75SMatthew G Knepley Output Parameter: 3133f1580f4eSBarry Smith . type - `PC_COMPOSITE_ADDITIVE`, `PC_COMPOSITE_MULTIPLICATIVE` (default), `PC_COMPOSITE_SYMMETRIC_MULTIPLICATIVE`, `PC_COMPOSITE_SPECIAL`, `PC_COMPOSITE_SCHUR` 3134b02e2d75SMatthew G Knepley 3135feefa0e1SJacob Faibussowitsch Level: intermediate 3136b02e2d75SMatthew G Knepley 313760f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCCompositeSetType()`, `PCFIELDSPLIT`, `PCCompositeType`, `PC_COMPOSITE_ADDITIVE`, `PC_COMPOSITE_MULTIPLICATIVE`, 3138f1580f4eSBarry Smith `PC_COMPOSITE_SYMMETRIC_MULTIPLICATIVE`, `PC_COMPOSITE_SPECIAL`, `PC_COMPOSITE_SCHUR` 3139b02e2d75SMatthew G Knepley @*/ 3140d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitGetType(PC pc, PCCompositeType *type) 3141d71ae5a4SJacob Faibussowitsch { 3142b02e2d75SMatthew G Knepley PC_FieldSplit *jac = (PC_FieldSplit *)pc->data; 3143b02e2d75SMatthew G Knepley 3144b02e2d75SMatthew G Knepley PetscFunctionBegin; 3145b02e2d75SMatthew G Knepley PetscValidHeaderSpecific(pc, PC_CLASSID, 1); 31464f572ea9SToby Isaac PetscAssertPointer(type, 2); 3147b02e2d75SMatthew G Knepley *type = jac->type; 31483ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 3149b02e2d75SMatthew G Knepley } 3150b02e2d75SMatthew G Knepley 31514ab8060aSDmitry Karpeev /*@ 3152f1580f4eSBarry Smith PCFieldSplitSetDMSplits - Flags whether `DMCreateFieldDecomposition()` should be used to define the splits in a `PCFIELDSPLIT`, whenever possible. 31534ab8060aSDmitry Karpeev 3154c3339decSBarry Smith Logically Collective 31554ab8060aSDmitry Karpeev 31564ab8060aSDmitry Karpeev Input Parameters: 31574ab8060aSDmitry Karpeev + pc - the preconditioner context 3158f1580f4eSBarry Smith - flg - boolean indicating whether to use field splits defined by the `DM` 31594ab8060aSDmitry Karpeev 31604ab8060aSDmitry Karpeev Options Database Key: 3161f1580f4eSBarry Smith . -pc_fieldsplit_dm_splits <bool> - use the field splits defined by the `DM` 31624ab8060aSDmitry Karpeev 3163feefa0e1SJacob Faibussowitsch Level: intermediate 31644ab8060aSDmitry Karpeev 316573ff1848SBarry Smith Developer Note: 316673ff1848SBarry Smith The name should be `PCFieldSplitSetUseDMSplits()`, similar change to options database 316773ff1848SBarry Smith 316873ff1848SBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCFIELDSPLIT`, `PCFieldSplitGetDMSplits()`, `DMCreateFieldDecomposition()`, `PCFieldSplitSetFields()`, `PCFieldsplitSetIS()` 31694ab8060aSDmitry Karpeev @*/ 3170d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitSetDMSplits(PC pc, PetscBool flg) 3171d71ae5a4SJacob Faibussowitsch { 31724ab8060aSDmitry Karpeev PC_FieldSplit *jac = (PC_FieldSplit *)pc->data; 31734ab8060aSDmitry Karpeev PetscBool isfs; 31744ab8060aSDmitry Karpeev 31754ab8060aSDmitry Karpeev PetscFunctionBegin; 31764ab8060aSDmitry Karpeev PetscValidHeaderSpecific(pc, PC_CLASSID, 1); 31774ab8060aSDmitry Karpeev PetscValidLogicalCollectiveBool(pc, flg, 2); 31789566063dSJacob Faibussowitsch PetscCall(PetscObjectTypeCompare((PetscObject)pc, PCFIELDSPLIT, &isfs)); 3179ad540459SPierre Jolivet if (isfs) jac->dm_splits = flg; 31803ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 31814ab8060aSDmitry Karpeev } 31824ab8060aSDmitry Karpeev 31834ab8060aSDmitry Karpeev /*@ 3184f1580f4eSBarry Smith PCFieldSplitGetDMSplits - Returns flag indicating whether `DMCreateFieldDecomposition()` should be used to define the splits in a `PCFIELDSPLIT`, whenever possible. 31854ab8060aSDmitry Karpeev 31864ab8060aSDmitry Karpeev Logically Collective 31874ab8060aSDmitry Karpeev 31884ab8060aSDmitry Karpeev Input Parameter: 31894ab8060aSDmitry Karpeev . pc - the preconditioner context 31904ab8060aSDmitry Karpeev 31914ab8060aSDmitry Karpeev Output Parameter: 3192f1580f4eSBarry Smith . flg - boolean indicating whether to use field splits defined by the `DM` 31934ab8060aSDmitry Karpeev 3194feefa0e1SJacob Faibussowitsch Level: intermediate 31954ab8060aSDmitry Karpeev 319673ff1848SBarry Smith Developer Note: 319773ff1848SBarry Smith The name should be `PCFieldSplitGetUseDMSplits()` 319873ff1848SBarry Smith 319973ff1848SBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCFIELDSPLIT`, `PCFieldSplitSetDMSplits()`, `DMCreateFieldDecomposition()`, `PCFieldSplitSetFields()`, `PCFieldsplitSetIS()` 32004ab8060aSDmitry Karpeev @*/ 3201d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitGetDMSplits(PC pc, PetscBool *flg) 3202d71ae5a4SJacob Faibussowitsch { 32034ab8060aSDmitry Karpeev PC_FieldSplit *jac = (PC_FieldSplit *)pc->data; 32044ab8060aSDmitry Karpeev PetscBool isfs; 32054ab8060aSDmitry Karpeev 32064ab8060aSDmitry Karpeev PetscFunctionBegin; 32074ab8060aSDmitry Karpeev PetscValidHeaderSpecific(pc, PC_CLASSID, 1); 32084f572ea9SToby Isaac PetscAssertPointer(flg, 2); 32099566063dSJacob Faibussowitsch PetscCall(PetscObjectTypeCompare((PetscObject)pc, PCFIELDSPLIT, &isfs)); 32104ab8060aSDmitry Karpeev if (isfs) { 32114ab8060aSDmitry Karpeev if (flg) *flg = jac->dm_splits; 32124ab8060aSDmitry Karpeev } 32133ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 32144ab8060aSDmitry Karpeev } 32154ab8060aSDmitry Karpeev 32167b752e3dSPatrick Sanan /*@ 3217f1580f4eSBarry Smith PCFieldSplitGetDetectSaddlePoint - Returns flag indicating whether `PCFIELDSPLIT` will attempt to automatically determine fields based on zero diagonal entries. 32187b752e3dSPatrick Sanan 32197b752e3dSPatrick Sanan Logically Collective 32207b752e3dSPatrick Sanan 32217b752e3dSPatrick Sanan Input Parameter: 32227b752e3dSPatrick Sanan . pc - the preconditioner context 32237b752e3dSPatrick Sanan 32247b752e3dSPatrick Sanan Output Parameter: 32257b752e3dSPatrick Sanan . flg - boolean indicating whether to detect fields or not 32267b752e3dSPatrick Sanan 3227feefa0e1SJacob Faibussowitsch Level: intermediate 32287b752e3dSPatrick Sanan 322960f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCFIELDSPLIT`, `PCFieldSplitSetDetectSaddlePoint()` 32307b752e3dSPatrick Sanan @*/ 3231d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitGetDetectSaddlePoint(PC pc, PetscBool *flg) 3232d71ae5a4SJacob Faibussowitsch { 32337b752e3dSPatrick Sanan PC_FieldSplit *jac = (PC_FieldSplit *)pc->data; 32347b752e3dSPatrick Sanan 32357b752e3dSPatrick Sanan PetscFunctionBegin; 32367b752e3dSPatrick Sanan *flg = jac->detect; 32373ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 32387b752e3dSPatrick Sanan } 32397b752e3dSPatrick Sanan 32407b752e3dSPatrick Sanan /*@ 3241f1580f4eSBarry Smith PCFieldSplitSetDetectSaddlePoint - Sets flag indicating whether `PCFIELDSPLIT` will attempt to automatically determine fields based on zero diagonal entries. 32427b752e3dSPatrick Sanan 32437b752e3dSPatrick Sanan Logically Collective 32447b752e3dSPatrick Sanan 32457b752e3dSPatrick Sanan Input Parameter: 32467b752e3dSPatrick Sanan . pc - the preconditioner context 32477b752e3dSPatrick Sanan 32487b752e3dSPatrick Sanan Output Parameter: 32497b752e3dSPatrick Sanan . flg - boolean indicating whether to detect fields or not 32507b752e3dSPatrick Sanan 32517b752e3dSPatrick Sanan Options Database Key: 3252147403d9SBarry Smith . -pc_fieldsplit_detect_saddle_point <bool> - detect and use the saddle point 3253147403d9SBarry Smith 3254feefa0e1SJacob Faibussowitsch Level: intermediate 325560f59c3bSBarry Smith 3256f1580f4eSBarry Smith Note: 3257f1580f4eSBarry 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()`). 32587b752e3dSPatrick Sanan 325960f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCFIELDSPLIT`, `PCFieldSplitGetDetectSaddlePoint()`, `PCFieldSplitSetType()`, `PCFieldSplitSetSchurPre()`, `PC_FIELDSPLIT_SCHUR_PRE_SELF` 32607b752e3dSPatrick Sanan @*/ 3261d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitSetDetectSaddlePoint(PC pc, PetscBool flg) 3262d71ae5a4SJacob Faibussowitsch { 32637b752e3dSPatrick Sanan PC_FieldSplit *jac = (PC_FieldSplit *)pc->data; 32647b752e3dSPatrick Sanan 32657b752e3dSPatrick Sanan PetscFunctionBegin; 32667b752e3dSPatrick Sanan jac->detect = flg; 32677b752e3dSPatrick Sanan if (jac->detect) { 32689566063dSJacob Faibussowitsch PetscCall(PCFieldSplitSetType(pc, PC_COMPOSITE_SCHUR)); 32699566063dSJacob Faibussowitsch PetscCall(PCFieldSplitSetSchurPre(pc, PC_FIELDSPLIT_SCHUR_PRE_SELF, NULL)); 32707b752e3dSPatrick Sanan } 32713ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 32727b752e3dSPatrick Sanan } 32737b752e3dSPatrick Sanan 32740971522cSBarry Smith /*MC 3275a8c7a070SBarry Smith PCFIELDSPLIT - Preconditioner created by combining separate preconditioners for individual 3276f1580f4eSBarry Smith collections of variables (that may overlap) called splits. See [the users manual section on "Solving Block Matrices"](sec_block_matrices) for more details. 32770971522cSBarry Smith 327879416396SBarry Smith Options Database Keys: 3279de37d9f1SPatrick Sanan + -pc_fieldsplit_%d_fields <a,b,..> - indicates the fields to be used in the `%d`'th split 328081540f2fSBarry Smith . -pc_fieldsplit_default - automatically add any fields to additional splits that have not 3281de37d9f1SPatrick Sanan been supplied explicitly by `-pc_fieldsplit_%d_fields` 328281540f2fSBarry Smith . -pc_fieldsplit_block_size <bs> - size of block that defines fields (i.e. there are bs fields) 328380670ca5SBarry Smith when the matrix is not of `MatType` `MATNEST` 3284a51937d4SCarola Kruse . -pc_fieldsplit_type <additive,multiplicative,symmetric_multiplicative,schur,gkb> - type of relaxation or factorization splitting 3285d59693daSPierre Jolivet . -pc_fieldsplit_schur_precondition <self,selfp,user,a11,full> - default is `a11`; see `PCFieldSplitSetSchurPre()` 32861d27aa22SBarry Smith . -pc_fieldsplit_schur_fact_type <diag,lower,upper,full> - set factorization type when using `-pc_fieldsplit_type schur`; 32871d27aa22SBarry Smith see `PCFieldSplitSetSchurFactType()` 328873ff1848SBarry Smith . -pc_fieldsplit_dm_splits <true,false> (default is true) - Whether to use `DMCreateFieldDecomposition()` for splits 3289fb6809a2SPatrick Sanan - -pc_fieldsplit_detect_saddle_point - automatically finds rows with zero diagonal and uses Schur complement with no preconditioner as the solver 329079416396SBarry Smith 3291de37d9f1SPatrick Sanan Options prefixes for inner solvers when using the Schur complement preconditioner are `-fieldsplit_0_` and `-fieldsplit_1_` . 3292de37d9f1SPatrick Sanan The options prefix for the inner solver when using the Golub-Kahan biadiagonalization preconditioner is `-fieldsplit_0_` 329360f59c3bSBarry Smith For all other solvers they are `-fieldsplit_%d_` for the `%d`'th field; use `-fieldsplit_` for all fields. 329460f59c3bSBarry Smith 329560f59c3bSBarry Smith To set options on the solvers for each block append `-fieldsplit_` to all the `PC` 329660f59c3bSBarry Smith options database keys. For example, `-fieldsplit_pc_type ilu` `-fieldsplit_pc_factor_levels 1` 329760f59c3bSBarry Smith 329860f59c3bSBarry Smith To set the options on the solvers separate for each block call `PCFieldSplitGetSubKSP()` 329960f59c3bSBarry Smith and set the options directly on the resulting `KSP` object 330060f59c3bSBarry Smith 330160f59c3bSBarry Smith Level: intermediate 33025d4c12cdSJungho Lee 3303c8a0d604SMatthew G Knepley Notes: 330480670ca5SBarry Smith Use `PCFieldSplitSetFields()` to set splits defined by "strided" entries or with a `MATNEST` and `PCFieldSplitSetIS()` 3305f1580f4eSBarry Smith to define a split by an arbitrary collection of entries. 3306d32f9abdSBarry Smith 330773ff1848SBarry Smith If no splits are set, the default is used. If a `DM` is associated with the `PC` and it supports 330880670ca5SBarry Smith `DMCreateFieldDecomposition()`, then that is used for the default. Otherwise if the matrix is not `MATNEST`, the splits are defined by entries strided by bs, 3309de37d9f1SPatrick Sanan beginning at 0 then 1, etc to bs-1. The block size can be set with `PCFieldSplitSetBlockSize()`, 3310d32f9abdSBarry Smith if this is not called the block size defaults to the blocksize of the second matrix passed 3311de37d9f1SPatrick Sanan to `KSPSetOperators()`/`PCSetOperators()`. 3312d32f9abdSBarry Smith 3313de37d9f1SPatrick Sanan For the Schur complement preconditioner if 3314de37d9f1SPatrick Sanan ```{math} 3315de37d9f1SPatrick Sanan J = \left[\begin{array}{cc} A_{00} & A_{01} \\ A_{10} & A_{11} \end{array}\right] 3316de37d9f1SPatrick Sanan ``` 3317e69d4d44SBarry Smith 3318de37d9f1SPatrick Sanan the preconditioner using `full` factorization is logically 3319de37d9f1SPatrick Sanan ```{math} 3320ecaa082aSMatthew Knepley \left[\begin{array}{cc} I & -\text{ksp}(A_{00}) A_{01} \\ 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] 3321de37d9f1SPatrick Sanan ``` 3322de37d9f1SPatrick Sanan where the action of $\text{inv}(A_{00})$ is applied using the KSP solver with prefix `-fieldsplit_0_`. $S$ is the Schur complement 3323de37d9f1SPatrick Sanan ```{math} 3324223e5b4fSPatrick Sanan S = A_{11} - A_{10} \text{ksp}(A_{00}) A_{01} 3325de37d9f1SPatrick Sanan ``` 3326de37d9f1SPatrick 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 332760f59c3bSBarry Smith in providing the SECOND split or 1 if not given). For `PCFieldSplitGetSubKSP()` when field number is 0, 332880670ca5SBarry Smith it returns the `KSP` associated with `-fieldsplit_0_` while field number 1 gives `-fieldsplit_1_` KSP. By default 3329de37d9f1SPatrick Sanan $A_{11}$ is used to construct a preconditioner for $S$, use `PCFieldSplitSetSchurPre()` for all the possible ways to construct the preconditioner for $S$. 3330de37d9f1SPatrick Sanan 3331de37d9f1SPatrick Sanan The factorization type is set using `-pc_fieldsplit_schur_fact_type <diag, lower, upper, full>`. `full` is shown above, 3332de37d9f1SPatrick Sanan `diag` gives 3333de37d9f1SPatrick Sanan ```{math} 3334de37d9f1SPatrick Sanan \left[\begin{array}{cc} \text{inv}(A_{00}) & 0 \\ 0 & -\text{ksp}(S) \end{array}\right] 3335de37d9f1SPatrick Sanan ``` 3336de37d9f1SPatrick 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 3337de37d9f1SPatrick Sanan can be turned off with `PCFieldSplitSetSchurScale()` or by command line `-pc_fieldsplit_schur_scale 1.0`. The `lower` factorization is the inverse of 3338de37d9f1SPatrick Sanan ```{math} 3339de37d9f1SPatrick Sanan \left[\begin{array}{cc} A_{00} & 0 \\ A_{10} & S \end{array}\right] 3340de37d9f1SPatrick Sanan ``` 3341de37d9f1SPatrick Sanan where the inverses of A_{00} and S are applied using KSPs. The upper factorization is the inverse of 3342de37d9f1SPatrick Sanan ```{math} 3343de37d9f1SPatrick Sanan \left[\begin{array}{cc} A_{00} & A_{01} \\ 0 & S \end{array}\right] 3344de37d9f1SPatrick Sanan ``` 3345de37d9f1SPatrick Sanan where again the inverses of $A_{00}$ and $S$ are applied using `KSP`s. 3346de37d9f1SPatrick Sanan 3347de37d9f1SPatrick Sanan If only one set of indices (one `IS`) is provided with `PCFieldSplitSetIS()` then the complement of that `IS` 334880670ca5SBarry Smith is used automatically for a second submatrix. 3349edf189efSBarry Smith 3350f1580f4eSBarry Smith The fieldsplit preconditioner cannot currently be used with the `MATBAIJ` or `MATSBAIJ` data formats if the blocksize is larger than 1. 335180670ca5SBarry Smith Generally it should be used with the `MATAIJ` or `MATNEST` `MatType` 3352ff218e97SBarry Smith 335380670ca5SBarry Smith The forms of these preconditioners are closely related, if not identical, to forms derived as "Distributive Iterations", see, 33541d569b8fSBarry Smith for example, page 294 in "Principles of Computational Fluid Dynamics" by Pieter Wesseling {cite}`wesseling2009`. 335580670ca5SBarry Smith One can also use `PCFIELDSPLIT` inside a smoother resulting in "Distributive Smoothers". 33560716a85fSBarry Smith 3357de37d9f1SPatrick Sanan See "A taxonomy and comparison of parallel block multi-level preconditioners for the incompressible Navier-Stokes equations" {cite}`elman2008tcp`. 3358a6a584a2SBarry Smith 3359de37d9f1SPatrick Sanan The Constrained Pressure Preconditioner (CPR) can be implemented using `PCCOMPOSITE` with `PCGALERKIN`. CPR first solves an $R A P$ subsystem, updates the 3360de37d9f1SPatrick Sanan residual on all variables (`PCCompositeSetType(pc,PC_COMPOSITE_MULTIPLICATIVE)`), and then applies a simple ILU like preconditioner on all the variables. 3361a51937d4SCarola Kruse 3362de37d9f1SPatrick Sanan The generalized Golub-Kahan bidiagonalization preconditioner (GKB) can be applied to symmetric $2 \times 2$ block matrices of the shape 3363de37d9f1SPatrick Sanan ```{math} 3364de37d9f1SPatrick Sanan \left[\begin{array}{cc} A_{00} & A_{01} \\ A_{01}' & 0 \end{array}\right] 3365de37d9f1SPatrick Sanan ``` 33661d569b8fSBarry Smith 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}'$. 3367de37d9f1SPatrick 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_`. 3368a51937d4SCarola Kruse 336960f59c3bSBarry Smith Developer Note: 337060f59c3bSBarry Smith The Schur complement functionality of `PCFIELDSPLIT` should likely be factored into its own `PC` thus simplifying the implementation of the preconditioners and their 337160f59c3bSBarry Smith user API. 3372f1580f4eSBarry Smith 337360f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCCreate()`, `PCSetType()`, `PCType`, `PC`, `PCLSC`, 3374db781477SPatrick Sanan `PCFieldSplitGetSubKSP()`, `PCFieldSplitSchurGetSubKSP()`, `PCFieldSplitSetFields()`, 3375db781477SPatrick Sanan `PCFieldSplitSetType()`, `PCFieldSplitSetIS()`, `PCFieldSplitSetSchurPre()`, `PCFieldSplitSetSchurFactType()`, 3376db781477SPatrick Sanan `MatSchurComplementSetAinvType()`, `PCFieldSplitSetSchurScale()`, `PCFieldSplitSetDetectSaddlePoint()` 33770971522cSBarry Smith M*/ 33780971522cSBarry Smith 3379d71ae5a4SJacob Faibussowitsch PETSC_EXTERN PetscErrorCode PCCreate_FieldSplit(PC pc) 3380d71ae5a4SJacob Faibussowitsch { 33810971522cSBarry Smith PC_FieldSplit *jac; 33820971522cSBarry Smith 33830971522cSBarry Smith PetscFunctionBegin; 33844dfa11a4SJacob Faibussowitsch PetscCall(PetscNew(&jac)); 33852fa5cd67SKarl Rupp 33860971522cSBarry Smith jac->bs = -1; 33870971522cSBarry Smith jac->nsplits = 0; 33883e197d65SBarry Smith jac->type = PC_COMPOSITE_MULTIPLICATIVE; 3389e6cab6aaSJed Brown jac->schurpre = PC_FIELDSPLIT_SCHUR_PRE_USER; /* Try user preconditioner first, fall back on diagonal */ 3390c9c6ffaaSJed Brown jac->schurfactorization = PC_FIELDSPLIT_SCHUR_FACT_FULL; 3391c096484dSStefano Zampini jac->schurscale = -1.0; 3392fbe7908bSJed Brown jac->dm_splits = PETSC_TRUE; 33937b752e3dSPatrick Sanan jac->detect = PETSC_FALSE; 3394a51937d4SCarola Kruse jac->gkbtol = 1e-5; 3395a51937d4SCarola Kruse jac->gkbdelay = 5; 3396a51937d4SCarola Kruse jac->gkbnu = 1; 3397a51937d4SCarola Kruse jac->gkbmaxit = 100; 3398de482cd7SCarola Kruse jac->gkbmonitor = PETSC_FALSE; 33995ddf11f8SNicolas Barnafi jac->coordinates_set = PETSC_FALSE; 340051f519a2SBarry Smith 34010971522cSBarry Smith pc->data = (void *)jac; 34020971522cSBarry Smith 34030971522cSBarry Smith pc->ops->apply = PCApply_FieldSplit; 3404421e10b8SBarry Smith pc->ops->applytranspose = PCApplyTranspose_FieldSplit; 34050971522cSBarry Smith pc->ops->setup = PCSetUp_FieldSplit; 3406574deadeSBarry Smith pc->ops->reset = PCReset_FieldSplit; 34070971522cSBarry Smith pc->ops->destroy = PCDestroy_FieldSplit; 34080971522cSBarry Smith pc->ops->setfromoptions = PCSetFromOptions_FieldSplit; 34090971522cSBarry Smith pc->ops->view = PCView_FieldSplit; 34100a545947SLisandro Dalcin pc->ops->applyrichardson = NULL; 34110971522cSBarry Smith 34129566063dSJacob Faibussowitsch PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSchurGetSubKSP_C", PCFieldSplitSchurGetSubKSP_FieldSplit)); 34139566063dSJacob Faibussowitsch PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitGetSubKSP_C", PCFieldSplitGetSubKSP_FieldSplit)); 34149566063dSJacob Faibussowitsch PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetFields_C", PCFieldSplitSetFields_FieldSplit)); 34159566063dSJacob Faibussowitsch PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetIS_C", PCFieldSplitSetIS_FieldSplit)); 34169566063dSJacob Faibussowitsch PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetType_C", PCFieldSplitSetType_FieldSplit)); 34179566063dSJacob Faibussowitsch PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetBlockSize_C", PCFieldSplitSetBlockSize_FieldSplit)); 34189566063dSJacob Faibussowitsch PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitRestrictIS_C", PCFieldSplitRestrictIS_FieldSplit)); 34199566063dSJacob Faibussowitsch PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCSetCoordinates_C", PCSetCoordinates_FieldSplit)); 34203ba16761SJacob Faibussowitsch PetscFunctionReturn(PETSC_SUCCESS); 34210971522cSBarry Smith } 3422