1dba47a55SKris Buschelman 2b45d2f2cSJed Brown #include <petsc-private/pcimpl.h> /*I "petscpc.h" I*/ 33c48a1e8SJed Brown #include <petscdmcomposite.h> /*I "petscdmcomposite.h" I*/ 40971522cSBarry Smith 5f7c28744SJed Brown const char *const PCFieldSplitSchurPreTypes[] = {"SELF","DIAG","USER","PCFieldSplitSchurPreType","PC_FIELDSPLIT_SCHUR_PRE_",0}; 6c9c6ffaaSJed Brown const char *const PCFieldSplitSchurFactTypes[] = {"DIAG","LOWER","UPPER","FULL","PCFieldSplitSchurFactType","PC_FIELDSPLIT_SCHUR_FACT_",0}; 7c5d2311dSJed Brown 80971522cSBarry Smith typedef struct _PC_FieldSplitLink *PC_FieldSplitLink; 90971522cSBarry Smith struct _PC_FieldSplitLink { 1069a612a9SBarry Smith KSP ksp; 110971522cSBarry Smith Vec x,y; 12db4c96c1SJed Brown char *splitname; 130971522cSBarry Smith PetscInt nfields; 145d4c12cdSJungho Lee PetscInt *fields,*fields_col; 151b9fc7fcSBarry Smith VecScatter sctx; 165d4c12cdSJungho Lee IS is,is_col; 177233a360SDmitry Karpeev DM dm; 1851f519a2SBarry Smith PC_FieldSplitLink next,previous; 190971522cSBarry Smith }; 200971522cSBarry Smith 210971522cSBarry Smith typedef struct { 2268dd23aaSBarry Smith PCCompositeType type; 23ace3abfcSBarry Smith PetscBool defaultsplit; /* Flag for a system with a set of 'k' scalar fields with the same layout (and bs = k) */ 24ace3abfcSBarry Smith PetscBool splitdefined; /* Flag is set after the splits have been defined, to prevent more splits from being added */ 25ace3abfcSBarry Smith PetscBool realdiagonal; /* Flag to use the diagonal blocks of mat preconditioned by pmat, instead of just pmat */ 2630ad9308SMatthew Knepley PetscInt bs; /* Block size for IS and Mat structures */ 2730ad9308SMatthew Knepley PetscInt nsplits; /* Number of field divisions defined */ 2879416396SBarry Smith Vec *x,*y,w1,w2; 29519d70e2SJed Brown Mat *mat; /* The diagonal block for each split */ 30519d70e2SJed Brown Mat *pmat; /* The preconditioning diagonal block for each split */ 3130ad9308SMatthew Knepley Mat *Afield; /* The rows of the matrix associated with each split */ 32ace3abfcSBarry Smith PetscBool issetup; 3330ad9308SMatthew Knepley /* Only used when Schur complement preconditioning is used */ 3430ad9308SMatthew Knepley Mat B; /* The (0,1) block */ 3530ad9308SMatthew Knepley Mat C; /* The (1,0) block */ 36a04f6461SBarry Smith Mat schur; /* The Schur complement S = A11 - A10 A00^{-1} A01 */ 37084e4875SJed Brown Mat schur_user; /* User-provided preconditioning matrix for the Schur complement */ 38084e4875SJed Brown PCFieldSplitSchurPreType schurpre; /* Determines which preconditioning matrix is used for the Schur complement */ 39c9c6ffaaSJed Brown PCFieldSplitSchurFactType schurfactorization; 4030ad9308SMatthew Knepley KSP kspschur; /* The solver for S */ 4197bbdb24SBarry Smith PC_FieldSplitLink head; 4263ec74ffSBarry Smith PetscBool reset; /* indicates PCReset() has been last called on this object, hack */ 43c1570756SJed Brown PetscBool suboptionsset; /* Indicates that the KSPSetFromOptions() has been called on the sub-KSPs */ 440971522cSBarry Smith } PC_FieldSplit; 450971522cSBarry Smith 4616913363SBarry Smith /* 4716913363SBarry Smith Notes: there is no particular reason that pmat, x, and y are stored as arrays in PC_FieldSplit instead of 4816913363SBarry Smith inside PC_FieldSplitLink, just historical. If you want to be able to add new fields after already using the 4916913363SBarry Smith PC you could change this. 5016913363SBarry Smith */ 51084e4875SJed Brown 52e6cab6aaSJed Brown /* This helper is so that setting a user-provided preconditioning matrix is orthogonal to choosing to use it. This way the 53084e4875SJed Brown * application-provided FormJacobian can provide this matrix without interfering with the user's (command-line) choices. */ 54084e4875SJed Brown static Mat FieldSplitSchurPre(PC_FieldSplit *jac) 55084e4875SJed Brown { 56084e4875SJed Brown switch (jac->schurpre) { 57084e4875SJed Brown case PC_FIELDSPLIT_SCHUR_PRE_SELF: return jac->schur; 58084e4875SJed Brown case PC_FIELDSPLIT_SCHUR_PRE_DIAG: return jac->pmat[1]; 59084e4875SJed Brown case PC_FIELDSPLIT_SCHUR_PRE_USER: /* Use a user-provided matrix if it is given, otherwise diagonal block */ 60084e4875SJed Brown default: 61084e4875SJed Brown return jac->schur_user ? jac->schur_user : jac->pmat[1]; 62084e4875SJed Brown } 63084e4875SJed Brown } 64084e4875SJed Brown 65084e4875SJed Brown 660971522cSBarry Smith #undef __FUNCT__ 670971522cSBarry Smith #define __FUNCT__ "PCView_FieldSplit" 680971522cSBarry Smith static PetscErrorCode PCView_FieldSplit(PC pc,PetscViewer viewer) 690971522cSBarry Smith { 700971522cSBarry Smith PC_FieldSplit *jac = (PC_FieldSplit*)pc->data; 710971522cSBarry Smith PetscErrorCode ierr; 72ace3abfcSBarry Smith PetscBool iascii; 730971522cSBarry Smith PetscInt i,j; 745a9f2f41SSatish Balay PC_FieldSplitLink ilink = jac->head; 750971522cSBarry Smith 760971522cSBarry Smith PetscFunctionBegin; 77251f4c67SDmitry Karpeev ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&iascii);CHKERRQ(ierr); 780971522cSBarry Smith if (iascii) { 792c9966d7SBarry Smith if (jac->bs > 0) { 8051f519a2SBarry Smith ierr = PetscViewerASCIIPrintf(viewer," FieldSplit with %s composition: total splits = %D, blocksize = %D\n",PCCompositeTypes[jac->type],jac->nsplits,jac->bs);CHKERRQ(ierr); 812c9966d7SBarry Smith } else { 822c9966d7SBarry Smith ierr = PetscViewerASCIIPrintf(viewer," FieldSplit with %s composition: total splits = %D\n",PCCompositeTypes[jac->type],jac->nsplits);CHKERRQ(ierr); 832c9966d7SBarry Smith } 84a3df900dSMatthew G Knepley if (jac->realdiagonal) { 85a3df900dSMatthew G Knepley ierr = PetscViewerASCIIPrintf(viewer," using actual matrix for blocks rather than preconditioner matrix\n");CHKERRQ(ierr); 86a3df900dSMatthew G Knepley } 8769a612a9SBarry Smith ierr = PetscViewerASCIIPrintf(viewer," Solver info for each split is in the following KSP objects:\n");CHKERRQ(ierr); 880971522cSBarry Smith ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr); 890971522cSBarry Smith for (i=0; i<jac->nsplits; i++) { 901ab39975SBarry Smith if (ilink->fields) { 910971522cSBarry Smith ierr = PetscViewerASCIIPrintf(viewer,"Split number %D Fields ",i);CHKERRQ(ierr); 9279416396SBarry Smith ierr = PetscViewerASCIIUseTabs(viewer,PETSC_FALSE);CHKERRQ(ierr); 935a9f2f41SSatish Balay for (j=0; j<ilink->nfields; j++) { 9479416396SBarry Smith if (j > 0) { 9579416396SBarry Smith ierr = PetscViewerASCIIPrintf(viewer,",");CHKERRQ(ierr); 9679416396SBarry Smith } 975a9f2f41SSatish Balay ierr = PetscViewerASCIIPrintf(viewer," %D",ilink->fields[j]);CHKERRQ(ierr); 980971522cSBarry Smith } 990971522cSBarry Smith ierr = PetscViewerASCIIPrintf(viewer,"\n");CHKERRQ(ierr); 10079416396SBarry Smith ierr = PetscViewerASCIIUseTabs(viewer,PETSC_TRUE);CHKERRQ(ierr); 1011ab39975SBarry Smith } else { 1021ab39975SBarry Smith ierr = PetscViewerASCIIPrintf(viewer,"Split number %D Defined by IS\n",i);CHKERRQ(ierr); 1031ab39975SBarry Smith } 1045a9f2f41SSatish Balay ierr = KSPView(ilink->ksp,viewer);CHKERRQ(ierr); 1055a9f2f41SSatish Balay ilink = ilink->next; 1060971522cSBarry Smith } 1070971522cSBarry Smith ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr); 1080971522cSBarry Smith } else { 10965e19b50SBarry Smith SETERRQ1(((PetscObject)pc)->comm,PETSC_ERR_SUP,"Viewer type %s not supported for PCFieldSplit",((PetscObject)viewer)->type_name); 1100971522cSBarry Smith } 1110971522cSBarry Smith PetscFunctionReturn(0); 1120971522cSBarry Smith } 1130971522cSBarry Smith 1140971522cSBarry Smith #undef __FUNCT__ 1153b224e63SBarry Smith #define __FUNCT__ "PCView_FieldSplit_Schur" 1163b224e63SBarry Smith static PetscErrorCode PCView_FieldSplit_Schur(PC pc,PetscViewer viewer) 1173b224e63SBarry Smith { 1183b224e63SBarry Smith PC_FieldSplit *jac = (PC_FieldSplit*)pc->data; 1193b224e63SBarry Smith PetscErrorCode ierr; 120ace3abfcSBarry Smith PetscBool iascii; 1213b224e63SBarry Smith PetscInt i,j; 1223b224e63SBarry Smith PC_FieldSplitLink ilink = jac->head; 1233b224e63SBarry Smith KSP ksp; 1243b224e63SBarry Smith 1253b224e63SBarry Smith PetscFunctionBegin; 126251f4c67SDmitry Karpeev ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&iascii);CHKERRQ(ierr); 1273b224e63SBarry Smith if (iascii) { 1282c9966d7SBarry Smith if (jac->bs > 0) { 129c9c6ffaaSJed Brown ierr = PetscViewerASCIIPrintf(viewer," FieldSplit with Schur preconditioner, blocksize = %D, factorization %s\n",jac->bs,PCFieldSplitSchurFactTypes[jac->schurfactorization]);CHKERRQ(ierr); 1302c9966d7SBarry Smith } else { 1312c9966d7SBarry Smith ierr = PetscViewerASCIIPrintf(viewer," FieldSplit with Schur preconditioner, factorization %s\n",PCFieldSplitSchurFactTypes[jac->schurfactorization]);CHKERRQ(ierr); 1322c9966d7SBarry Smith } 133a3df900dSMatthew G Knepley if (jac->realdiagonal) { 134a3df900dSMatthew G Knepley ierr = PetscViewerASCIIPrintf(viewer," using actual matrix for blocks rather than preconditioner matrix\n");CHKERRQ(ierr); 135a3df900dSMatthew G Knepley } 1363e8b8b31SMatthew G Knepley switch(jac->schurpre) { 1373e8b8b31SMatthew G Knepley case PC_FIELDSPLIT_SCHUR_PRE_SELF: 1383e8b8b31SMatthew G Knepley ierr = PetscViewerASCIIPrintf(viewer," Preconditioner for the Schur complement formed from S itself\n");CHKERRQ(ierr);break; 139b02e2d75SMatthew G Knepley case PC_FIELDSPLIT_SCHUR_PRE_DIAG: 1403e8b8b31SMatthew G Knepley ierr = PetscViewerASCIIPrintf(viewer," Preconditioner for the Schur complement formed from the block diagonal part of A11\n");CHKERRQ(ierr);break; 1413e8b8b31SMatthew G Knepley case PC_FIELDSPLIT_SCHUR_PRE_USER: 1423e8b8b31SMatthew G Knepley if (jac->schur_user) { 1433e8b8b31SMatthew G Knepley ierr = PetscViewerASCIIPrintf(viewer," Preconditioner for the Schur complement formed from user provided matrix\n");CHKERRQ(ierr); 1443e8b8b31SMatthew G Knepley } else { 1453e8b8b31SMatthew G Knepley ierr = PetscViewerASCIIPrintf(viewer," Preconditioner for the Schur complement formed from the block diagonal part of A11\n");CHKERRQ(ierr); 1463e8b8b31SMatthew G Knepley } 1473e8b8b31SMatthew G Knepley break; 1483e8b8b31SMatthew G Knepley default: 1493e8b8b31SMatthew G Knepley SETERRQ1(((PetscObject) pc)->comm, PETSC_ERR_ARG_OUTOFRANGE, "Invalid Schur preconditioning type: %d", jac->schurpre); 1503e8b8b31SMatthew G Knepley } 1513b224e63SBarry Smith ierr = PetscViewerASCIIPrintf(viewer," Split info:\n");CHKERRQ(ierr); 1523b224e63SBarry Smith ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr); 1533b224e63SBarry Smith for (i=0; i<jac->nsplits; i++) { 1543b224e63SBarry Smith if (ilink->fields) { 1553b224e63SBarry Smith ierr = PetscViewerASCIIPrintf(viewer,"Split number %D Fields ",i);CHKERRQ(ierr); 1563b224e63SBarry Smith ierr = PetscViewerASCIIUseTabs(viewer,PETSC_FALSE);CHKERRQ(ierr); 1573b224e63SBarry Smith for (j=0; j<ilink->nfields; j++) { 1583b224e63SBarry Smith if (j > 0) { 1593b224e63SBarry Smith ierr = PetscViewerASCIIPrintf(viewer,",");CHKERRQ(ierr); 1603b224e63SBarry Smith } 1613b224e63SBarry Smith ierr = PetscViewerASCIIPrintf(viewer," %D",ilink->fields[j]);CHKERRQ(ierr); 1623b224e63SBarry Smith } 1633b224e63SBarry Smith ierr = PetscViewerASCIIPrintf(viewer,"\n");CHKERRQ(ierr); 1643b224e63SBarry Smith ierr = PetscViewerASCIIUseTabs(viewer,PETSC_TRUE);CHKERRQ(ierr); 1653b224e63SBarry Smith } else { 1663b224e63SBarry Smith ierr = PetscViewerASCIIPrintf(viewer,"Split number %D Defined by IS\n",i);CHKERRQ(ierr); 1673b224e63SBarry Smith } 1683b224e63SBarry Smith ilink = ilink->next; 1693b224e63SBarry Smith } 170435f959eSBarry Smith ierr = PetscViewerASCIIPrintf(viewer,"KSP solver for A00 block \n");CHKERRQ(ierr); 1713b224e63SBarry Smith ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr); 17212cae6f2SJed Brown if (jac->schur) { 17312cae6f2SJed Brown ierr = MatSchurComplementGetKSP(jac->schur,&ksp);CHKERRQ(ierr); 1743b224e63SBarry Smith ierr = KSPView(ksp,viewer);CHKERRQ(ierr); 17512cae6f2SJed Brown } else { 17612cae6f2SJed Brown ierr = PetscViewerASCIIPrintf(viewer," not yet available\n");CHKERRQ(ierr); 17712cae6f2SJed Brown } 1783b224e63SBarry Smith ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr); 179435f959eSBarry Smith ierr = PetscViewerASCIIPrintf(viewer,"KSP solver for S = A11 - A10 inv(A00) A01 \n");CHKERRQ(ierr); 1803b224e63SBarry Smith ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr); 18112cae6f2SJed Brown if (jac->kspschur) { 1823b224e63SBarry Smith ierr = KSPView(jac->kspschur,viewer);CHKERRQ(ierr); 18312cae6f2SJed Brown } else { 18412cae6f2SJed Brown ierr = PetscViewerASCIIPrintf(viewer," not yet available\n");CHKERRQ(ierr); 18512cae6f2SJed Brown } 1863b224e63SBarry Smith ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr); 1873b224e63SBarry Smith ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr); 1883b224e63SBarry Smith } else { 18965e19b50SBarry Smith SETERRQ1(((PetscObject)pc)->comm,PETSC_ERR_SUP,"Viewer type %s not supported for PCFieldSplit",((PetscObject)viewer)->type_name); 1903b224e63SBarry Smith } 1913b224e63SBarry Smith PetscFunctionReturn(0); 1923b224e63SBarry Smith } 1933b224e63SBarry Smith 1943b224e63SBarry Smith #undef __FUNCT__ 1956c924f48SJed Brown #define __FUNCT__ "PCFieldSplitSetRuntimeSplits_Private" 1966c924f48SJed Brown /* Precondition: jac->bs is set to a meaningful value */ 1976c924f48SJed Brown static PetscErrorCode PCFieldSplitSetRuntimeSplits_Private(PC pc) 1986c924f48SJed Brown { 1996c924f48SJed Brown PetscErrorCode ierr; 2006c924f48SJed Brown PC_FieldSplit *jac = (PC_FieldSplit*)pc->data; 2015d4c12cdSJungho Lee PetscInt i,nfields,*ifields,nfields_col,*ifields_col; 2025d4c12cdSJungho Lee PetscBool flg,flg_col; 2035d4c12cdSJungho Lee char optionname[128],splitname[8],optionname_col[128]; 2046c924f48SJed Brown 2056c924f48SJed Brown PetscFunctionBegin; 2066c924f48SJed Brown ierr = PetscMalloc(jac->bs*sizeof(PetscInt),&ifields);CHKERRQ(ierr); 2075d4c12cdSJungho Lee ierr = PetscMalloc(jac->bs*sizeof(PetscInt),&ifields_col);CHKERRQ(ierr); 2086c924f48SJed Brown for (i=0,flg=PETSC_TRUE; ; i++) { 2096c924f48SJed Brown ierr = PetscSNPrintf(splitname,sizeof splitname,"%D",i);CHKERRQ(ierr); 2106c924f48SJed Brown ierr = PetscSNPrintf(optionname,sizeof optionname,"-pc_fieldsplit_%D_fields",i);CHKERRQ(ierr); 2115d4c12cdSJungho Lee ierr = PetscSNPrintf(optionname_col,sizeof optionname_col,"-pc_fieldsplit_%D_fields_col",i);CHKERRQ(ierr); 2126c924f48SJed Brown nfields = jac->bs; 21329499fbbSJungho Lee nfields_col = jac->bs; 2146c924f48SJed Brown ierr = PetscOptionsGetIntArray(((PetscObject)pc)->prefix,optionname,ifields,&nfields,&flg);CHKERRQ(ierr); 2155d4c12cdSJungho Lee ierr = PetscOptionsGetIntArray(((PetscObject)pc)->prefix,optionname_col,ifields_col,&nfields_col,&flg_col);CHKERRQ(ierr); 2166c924f48SJed Brown if (!flg) break; 2175d4c12cdSJungho Lee else if (flg && !flg_col) { 2185d4c12cdSJungho Lee if (!nfields) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_USER,"Cannot list zero fields"); 2195d4c12cdSJungho Lee ierr = PCFieldSplitSetFields(pc,splitname,nfields,ifields,ifields);CHKERRQ(ierr); 2205d4c12cdSJungho Lee } 2215d4c12cdSJungho Lee else { 2225d4c12cdSJungho Lee if (!nfields || !nfields_col) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_USER,"Cannot list zero fields"); 2235d4c12cdSJungho Lee if (nfields != nfields_col) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_USER,"Number of row and column fields must match"); 2245d4c12cdSJungho Lee ierr = PCFieldSplitSetFields(pc,splitname,nfields,ifields,ifields_col);CHKERRQ(ierr); 2255d4c12cdSJungho Lee } 2266c924f48SJed Brown } 2276c924f48SJed Brown if (i > 0) { 2286c924f48SJed Brown /* Makes command-line setting of splits take precedence over setting them in code. 2296c924f48SJed Brown Otherwise subsequent calls to PCFieldSplitSetIS() or PCFieldSplitSetFields() would 2306c924f48SJed Brown create new splits, which would probably not be what the user wanted. */ 2316c924f48SJed Brown jac->splitdefined = PETSC_TRUE; 2326c924f48SJed Brown } 2336c924f48SJed Brown ierr = PetscFree(ifields);CHKERRQ(ierr); 2345d4c12cdSJungho Lee ierr = PetscFree(ifields_col);CHKERRQ(ierr); 2356c924f48SJed Brown PetscFunctionReturn(0); 2366c924f48SJed Brown } 2376c924f48SJed Brown 2386c924f48SJed Brown #undef __FUNCT__ 23969a612a9SBarry Smith #define __FUNCT__ "PCFieldSplitSetDefaults" 24069a612a9SBarry Smith static PetscErrorCode PCFieldSplitSetDefaults(PC pc) 2410971522cSBarry Smith { 2420971522cSBarry Smith PC_FieldSplit *jac = (PC_FieldSplit*)pc->data; 2430971522cSBarry Smith PetscErrorCode ierr; 2445a9f2f41SSatish Balay PC_FieldSplitLink ilink = jac->head; 2456ce1633cSBarry Smith PetscBool flg = PETSC_FALSE,stokes = PETSC_FALSE; 2466c924f48SJed Brown PetscInt i; 2470971522cSBarry Smith 2480971522cSBarry Smith PetscFunctionBegin; 249d32f9abdSBarry Smith if (!ilink) { 250d0af7cd3SBarry Smith ierr = PetscOptionsGetBool(((PetscObject)pc)->prefix,"-pc_fieldsplit_detect_saddle_point",&stokes,PETSC_NULL);CHKERRQ(ierr); 251d0af7cd3SBarry Smith if (pc->dm && !stokes) { 2527b62db95SJungho Lee PetscInt numFields, f; 2530784a22cSJed Brown char **fieldNames; 2547b62db95SJungho Lee IS *fields; 255e7c4fc90SDmitry Karpeev DM *dms; 25616621825SDmitry Karpeev ierr = DMCreateFieldDecomposition(pc->dm, &numFields, &fieldNames, &fields, &dms); CHKERRQ(ierr); 2577b62db95SJungho Lee for(f = 0; f < numFields; ++f) { 2587b62db95SJungho Lee ierr = PCFieldSplitSetIS(pc, fieldNames[f], fields[f]);CHKERRQ(ierr); 2597b62db95SJungho Lee ierr = PetscFree(fieldNames[f]);CHKERRQ(ierr); 2607b62db95SJungho Lee ierr = ISDestroy(&fields[f]);CHKERRQ(ierr); 2617b62db95SJungho Lee } 2627b62db95SJungho Lee ierr = PetscFree(fieldNames);CHKERRQ(ierr); 2637b62db95SJungho Lee ierr = PetscFree(fields);CHKERRQ(ierr); 264e7c4fc90SDmitry Karpeev if(dms) { 2658b8307b2SJed Brown ierr = PetscInfo(pc,"Setting up physics based fieldsplit preconditioner using the embedded DM\n");CHKERRQ(ierr); 2667b62db95SJungho Lee for (ilink=jac->head,i=0; ilink; ilink=ilink->next,i++) { 2677233a360SDmitry Karpeev /* 2687233a360SDmitry Karpeev HACK: 2697233a360SDmitry Karpeev keep a handle to DM here without increfing it: may need the DM to set up the Schur solvers; 2707233a360SDmitry Karpeev can't rely on KSPGetDM() since it will create a DMShell if none was set; 2717233a360SDmitry Karpeev can't use ilink->ksp->dm without creating a dependence on dmimpl.h. 2727233a360SDmitry Karpeev */ 2737233a360SDmitry Karpeev ilink->dm = dms[i]; 2747b62db95SJungho Lee ierr = KSPSetDM(ilink->ksp, dms[i]);CHKERRQ(ierr); 2757b62db95SJungho Lee ierr = KSPSetDMActive(ilink->ksp, PETSC_FALSE);CHKERRQ(ierr); 276e7c4fc90SDmitry Karpeev ierr = DMDestroy(&dms[i]); CHKERRQ(ierr); 2772fa5ba8aSJed Brown } 2787b62db95SJungho Lee ierr = PetscFree(dms);CHKERRQ(ierr); 2798b8307b2SJed Brown } 28066ffff09SJed Brown } else { 281521d7252SBarry Smith if (jac->bs <= 0) { 282704ba839SBarry Smith if (pc->pmat) { 283521d7252SBarry Smith ierr = MatGetBlockSize(pc->pmat,&jac->bs);CHKERRQ(ierr); 284704ba839SBarry Smith } else { 285704ba839SBarry Smith jac->bs = 1; 286704ba839SBarry Smith } 287521d7252SBarry Smith } 288d32f9abdSBarry Smith 289acfcf0e5SJed Brown ierr = PetscOptionsGetBool(((PetscObject)pc)->prefix,"-pc_fieldsplit_default",&flg,PETSC_NULL);CHKERRQ(ierr); 2906ce1633cSBarry Smith if (stokes) { 2916ce1633cSBarry Smith IS zerodiags,rest; 2926ce1633cSBarry Smith PetscInt nmin,nmax; 2936ce1633cSBarry Smith 2946ce1633cSBarry Smith ierr = MatGetOwnershipRange(pc->mat,&nmin,&nmax);CHKERRQ(ierr); 2956ce1633cSBarry Smith ierr = MatFindZeroDiagonals(pc->mat,&zerodiags);CHKERRQ(ierr); 2966ce1633cSBarry Smith ierr = ISComplement(zerodiags,nmin,nmax,&rest);CHKERRQ(ierr); 2976ce1633cSBarry Smith ierr = PCFieldSplitSetIS(pc,"0",rest);CHKERRQ(ierr); 2986ce1633cSBarry Smith ierr = PCFieldSplitSetIS(pc,"1",zerodiags);CHKERRQ(ierr); 299fcfd50ebSBarry Smith ierr = ISDestroy(&zerodiags);CHKERRQ(ierr); 300fcfd50ebSBarry Smith ierr = ISDestroy(&rest);CHKERRQ(ierr); 3016ce1633cSBarry Smith } else { 302d32f9abdSBarry Smith if (!flg) { 303d32f9abdSBarry Smith /* Allow user to set fields from command line, if bs was known at the time of PCSetFromOptions_FieldSplit() 304d32f9abdSBarry Smith then it is set there. This is not ideal because we should only have options set in XXSetFromOptions(). */ 3056c924f48SJed Brown ierr = PCFieldSplitSetRuntimeSplits_Private(pc);CHKERRQ(ierr); 3066c924f48SJed Brown if (jac->splitdefined) {ierr = PetscInfo(pc,"Splits defined using the options database\n");CHKERRQ(ierr);} 307d32f9abdSBarry Smith } 3086c924f48SJed Brown if (flg || !jac->splitdefined) { 309d32f9abdSBarry Smith ierr = PetscInfo(pc,"Using default splitting of fields\n");CHKERRQ(ierr); 310db4c96c1SJed Brown for (i=0; i<jac->bs; i++) { 3116c924f48SJed Brown char splitname[8]; 3126c924f48SJed Brown ierr = PetscSNPrintf(splitname,sizeof splitname,"%D",i);CHKERRQ(ierr); 3135d4c12cdSJungho Lee ierr = PCFieldSplitSetFields(pc,splitname,1,&i,&i);CHKERRQ(ierr); 31479416396SBarry Smith } 3155d4c12cdSJungho Lee jac->defaultsplit = PETSC_TRUE; 316521d7252SBarry Smith } 31766ffff09SJed Brown } 3186ce1633cSBarry Smith } 319edf189efSBarry Smith } else if (jac->nsplits == 1) { 320edf189efSBarry Smith if (ilink->is) { 321edf189efSBarry Smith IS is2; 322edf189efSBarry Smith PetscInt nmin,nmax; 323edf189efSBarry Smith 324edf189efSBarry Smith ierr = MatGetOwnershipRange(pc->mat,&nmin,&nmax);CHKERRQ(ierr); 325edf189efSBarry Smith ierr = ISComplement(ilink->is,nmin,nmax,&is2);CHKERRQ(ierr); 326db4c96c1SJed Brown ierr = PCFieldSplitSetIS(pc,"1",is2);CHKERRQ(ierr); 327fcfd50ebSBarry Smith ierr = ISDestroy(&is2);CHKERRQ(ierr); 3287b62db95SJungho Lee } else SETERRQ(((PetscObject) pc)->comm,PETSC_ERR_SUP,"Must provide at least two sets of fields to PCFieldSplit()"); 32963ec74ffSBarry Smith } else if (jac->reset) { 33063ec74ffSBarry Smith /* PCReset() has been called on this PC, ilink exists but all IS and Vec data structures in it must be rebuilt 331d0af7cd3SBarry Smith This is basically the !ilink portion of code above copied from above and the allocation of the ilinks removed 332d0af7cd3SBarry Smith since they already exist. This should be totally rewritten */ 333d0af7cd3SBarry Smith ierr = PetscOptionsGetBool(((PetscObject)pc)->prefix,"-pc_fieldsplit_detect_saddle_point",&stokes,PETSC_NULL);CHKERRQ(ierr); 334d0af7cd3SBarry Smith if (pc->dm && !stokes) { 335d0af7cd3SBarry Smith PetscBool dmcomposite; 336251f4c67SDmitry Karpeev ierr = PetscObjectTypeCompare((PetscObject)pc->dm,DMCOMPOSITE,&dmcomposite);CHKERRQ(ierr); 337d0af7cd3SBarry Smith if (dmcomposite) { 338d0af7cd3SBarry Smith PetscInt nDM; 339d0af7cd3SBarry Smith IS *fields; 3407b62db95SJungho Lee DM *dms; 341d0af7cd3SBarry Smith ierr = PetscInfo(pc,"Setting up physics based fieldsplit preconditioner using the embedded DM\n");CHKERRQ(ierr); 342d0af7cd3SBarry Smith ierr = DMCompositeGetNumberDM(pc->dm,&nDM);CHKERRQ(ierr); 343d0af7cd3SBarry Smith ierr = DMCompositeGetGlobalISs(pc->dm,&fields);CHKERRQ(ierr); 3447b62db95SJungho Lee ierr = PetscMalloc(nDM*sizeof(DM),&dms);CHKERRQ(ierr); 3457b62db95SJungho Lee ierr = DMCompositeGetEntriesArray(pc->dm,dms);CHKERRQ(ierr); 346d0af7cd3SBarry Smith for (i=0; i<nDM; i++) { 3477b62db95SJungho Lee ierr = KSPSetDM(ilink->ksp,dms[i]);CHKERRQ(ierr); 3487b62db95SJungho Lee ierr = KSPSetDMActive(ilink->ksp,PETSC_FALSE);CHKERRQ(ierr); 349d0af7cd3SBarry Smith ilink->is = fields[i]; 350d0af7cd3SBarry Smith ilink = ilink->next; 351edf189efSBarry Smith } 352d0af7cd3SBarry Smith ierr = PetscFree(fields);CHKERRQ(ierr); 3537b62db95SJungho Lee ierr = PetscFree(dms);CHKERRQ(ierr); 354d0af7cd3SBarry Smith } 355d0af7cd3SBarry Smith } else { 356d0af7cd3SBarry Smith ierr = PetscOptionsGetBool(((PetscObject)pc)->prefix,"-pc_fieldsplit_default",&flg,PETSC_NULL);CHKERRQ(ierr); 357d0af7cd3SBarry Smith if (stokes) { 358d0af7cd3SBarry Smith IS zerodiags,rest; 359d0af7cd3SBarry Smith PetscInt nmin,nmax; 360d0af7cd3SBarry Smith 361d0af7cd3SBarry Smith ierr = MatGetOwnershipRange(pc->mat,&nmin,&nmax);CHKERRQ(ierr); 362d0af7cd3SBarry Smith ierr = MatFindZeroDiagonals(pc->mat,&zerodiags);CHKERRQ(ierr); 363d0af7cd3SBarry Smith ierr = ISComplement(zerodiags,nmin,nmax,&rest);CHKERRQ(ierr); 36420b26d62SBarry Smith ierr = ISDestroy(&ilink->is);CHKERRQ(ierr); 36520b26d62SBarry Smith ierr = ISDestroy(&ilink->next->is);CHKERRQ(ierr); 366d0af7cd3SBarry Smith ilink->is = rest; 367d0af7cd3SBarry Smith ilink->next->is = zerodiags; 36820b26d62SBarry Smith } else SETERRQ(((PetscObject)pc)->comm,PETSC_ERR_SUP,"Cases not yet handled when PCReset() was used"); 369d0af7cd3SBarry Smith } 370d0af7cd3SBarry Smith } 371d0af7cd3SBarry Smith 3727b62db95SJungho Lee if (jac->nsplits < 2) SETERRQ1(((PetscObject) pc)->comm,PETSC_ERR_PLIB,"Unhandled case, must have at least two fields, not %d", jac->nsplits); 37369a612a9SBarry Smith PetscFunctionReturn(0); 37469a612a9SBarry Smith } 37569a612a9SBarry Smith 37669a612a9SBarry Smith #undef __FUNCT__ 37769a612a9SBarry Smith #define __FUNCT__ "PCSetUp_FieldSplit" 37869a612a9SBarry Smith static PetscErrorCode PCSetUp_FieldSplit(PC pc) 37969a612a9SBarry Smith { 38069a612a9SBarry Smith PC_FieldSplit *jac = (PC_FieldSplit*)pc->data; 38169a612a9SBarry Smith PetscErrorCode ierr; 3825a9f2f41SSatish Balay PC_FieldSplitLink ilink; 3832c9966d7SBarry Smith PetscInt i,nsplit; 38469a612a9SBarry Smith MatStructure flag = pc->flag; 3855f4ab4e1SJungho Lee PetscBool sorted, sorted_col; 38669a612a9SBarry Smith 38769a612a9SBarry Smith PetscFunctionBegin; 38869a612a9SBarry Smith ierr = PCFieldSplitSetDefaults(pc);CHKERRQ(ierr); 38997bbdb24SBarry Smith nsplit = jac->nsplits; 3905a9f2f41SSatish Balay ilink = jac->head; 39197bbdb24SBarry Smith 39297bbdb24SBarry Smith /* get the matrices for each split */ 393704ba839SBarry Smith if (!jac->issetup) { 3941b9fc7fcSBarry Smith PetscInt rstart,rend,nslots,bs; 39597bbdb24SBarry Smith 396704ba839SBarry Smith jac->issetup = PETSC_TRUE; 397704ba839SBarry Smith 3985d4c12cdSJungho Lee /* This is done here instead of in PCFieldSplitSetFields() because may not have matrix at that point */ 3992c9966d7SBarry Smith if (jac->defaultsplit || !ilink->is) { 4002c9966d7SBarry Smith if (jac->bs <= 0) jac->bs = nsplit; 4012c9966d7SBarry Smith } 40251f519a2SBarry Smith bs = jac->bs; 40397bbdb24SBarry Smith ierr = MatGetOwnershipRange(pc->pmat,&rstart,&rend);CHKERRQ(ierr); 4041b9fc7fcSBarry Smith nslots = (rend - rstart)/bs; 4051b9fc7fcSBarry Smith for (i=0; i<nsplit; i++) { 4061b9fc7fcSBarry Smith if (jac->defaultsplit) { 407704ba839SBarry Smith ierr = ISCreateStride(((PetscObject)pc)->comm,nslots,rstart+i,nsplit,&ilink->is);CHKERRQ(ierr); 4085f4ab4e1SJungho Lee ierr = ISDuplicate(ilink->is,&ilink->is_col);CHKERRQ(ierr); 409704ba839SBarry Smith } else if (!ilink->is) { 410ccb205f8SBarry Smith if (ilink->nfields > 1) { 4115f4ab4e1SJungho Lee PetscInt *ii,*jj,j,k,nfields = ilink->nfields,*fields = ilink->fields,*fields_col = ilink->fields_col; 4125a9f2f41SSatish Balay ierr = PetscMalloc(ilink->nfields*nslots*sizeof(PetscInt),&ii);CHKERRQ(ierr); 4135f4ab4e1SJungho Lee ierr = PetscMalloc(ilink->nfields*nslots*sizeof(PetscInt),&jj);CHKERRQ(ierr); 4141b9fc7fcSBarry Smith for (j=0; j<nslots; j++) { 4151b9fc7fcSBarry Smith for (k=0; k<nfields; k++) { 4161b9fc7fcSBarry Smith ii[nfields*j + k] = rstart + bs*j + fields[k]; 4175f4ab4e1SJungho Lee jj[nfields*j + k] = rstart + bs*j + fields_col[k]; 41897bbdb24SBarry Smith } 41997bbdb24SBarry Smith } 420d67e408aSBarry Smith ierr = ISCreateGeneral(((PetscObject)pc)->comm,nslots*nfields,ii,PETSC_OWN_POINTER,&ilink->is);CHKERRQ(ierr); 4215f4ab4e1SJungho Lee ierr = ISCreateGeneral(((PetscObject)pc)->comm,nslots*nfields,jj,PETSC_OWN_POINTER,&ilink->is_col);CHKERRQ(ierr); 422ccb205f8SBarry Smith } else { 423704ba839SBarry Smith ierr = ISCreateStride(((PetscObject)pc)->comm,nslots,rstart+ilink->fields[0],bs,&ilink->is);CHKERRQ(ierr); 4245f4ab4e1SJungho Lee ierr = ISCreateStride(((PetscObject)pc)->comm,nslots,rstart+ilink->fields_col[0],bs,&ilink->is_col);CHKERRQ(ierr); 425ccb205f8SBarry Smith } 4263e197d65SBarry Smith } 427704ba839SBarry Smith ierr = ISSorted(ilink->is,&sorted);CHKERRQ(ierr); 4285f4ab4e1SJungho Lee if (ilink->is_col) { ierr = ISSorted(ilink->is_col,&sorted_col);CHKERRQ(ierr); } 4295f4ab4e1SJungho Lee if (!sorted || !sorted_col) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_USER,"Fields must be sorted when creating split"); 430704ba839SBarry Smith ilink = ilink->next; 4311b9fc7fcSBarry Smith } 4321b9fc7fcSBarry Smith } 4331b9fc7fcSBarry Smith 434704ba839SBarry Smith ilink = jac->head; 43597bbdb24SBarry Smith if (!jac->pmat) { 436bdddcaaaSMatthew G Knepley Vec xtmp; 437bdddcaaaSMatthew G Knepley 438bdddcaaaSMatthew G Knepley ierr = MatGetVecs(pc->pmat,&xtmp,PETSC_NULL);CHKERRQ(ierr); 439cf502942SBarry Smith ierr = PetscMalloc(nsplit*sizeof(Mat),&jac->pmat);CHKERRQ(ierr); 440bdddcaaaSMatthew G Knepley ierr = PetscMalloc2(nsplit,Vec,&jac->x,nsplit,Vec,&jac->y);CHKERRQ(ierr); 441cf502942SBarry Smith for (i=0; i<nsplit; i++) { 442bdddcaaaSMatthew G Knepley MatNullSpace sp; 443bdddcaaaSMatthew G Knepley 444a3df900dSMatthew G Knepley /* Check for preconditioning matrix attached to IS */ 445a3df900dSMatthew G Knepley ierr = PetscObjectQuery((PetscObject) ilink->is, "pmat", (PetscObject *) &jac->pmat[i]);CHKERRQ(ierr); 446a3df900dSMatthew G Knepley if (jac->pmat[i]) { 447a3df900dSMatthew G Knepley ierr = PetscObjectReference((PetscObject) jac->pmat[i]);CHKERRQ(ierr); 448a3df900dSMatthew G Knepley if (jac->type == PC_COMPOSITE_SCHUR) { 449a3df900dSMatthew G Knepley jac->schur_user = jac->pmat[i]; 450a3df900dSMatthew G Knepley ierr = PetscObjectReference((PetscObject) jac->schur_user);CHKERRQ(ierr); 451a3df900dSMatthew G Knepley } 452a3df900dSMatthew G Knepley } else { 4535f4ab4e1SJungho Lee ierr = MatGetSubMatrix(pc->pmat,ilink->is,ilink->is_col,MAT_INITIAL_MATRIX,&jac->pmat[i]);CHKERRQ(ierr); 454a3df900dSMatthew G Knepley } 455bdddcaaaSMatthew G Knepley /* create work vectors for each split */ 456bdddcaaaSMatthew G Knepley ierr = MatGetVecs(jac->pmat[i],&jac->x[i],&jac->y[i]);CHKERRQ(ierr); 457bdddcaaaSMatthew G Knepley ilink->x = jac->x[i]; ilink->y = jac->y[i]; 458bdddcaaaSMatthew G Knepley /* compute scatter contexts needed by multiplicative versions and non-default splits */ 459bdddcaaaSMatthew G Knepley ierr = VecScatterCreate(xtmp,ilink->is,jac->x[i],PETSC_NULL,&ilink->sctx);CHKERRQ(ierr); 460bdddcaaaSMatthew G Knepley /* HACK: Check for the constant null space */ 461*f1dc53b5SDmitry Karpeev ierr = MatGetNullSpace(pc->pmat, &sp);CHKERRQ(ierr); 462bdddcaaaSMatthew G Knepley if (sp) { 463bdddcaaaSMatthew G Knepley MatNullSpace subsp; 464bdddcaaaSMatthew G Knepley Vec ftmp, gtmp; 4659583d628SBarry Smith PetscReal norm; 466bdddcaaaSMatthew G Knepley PetscInt N; 467*f1dc53b5SDmitry Karpeev 468*f1dc53b5SDmitry Karpeev ierr = MatGetVecs(pc->pmat, >mp, PETSC_NULL);CHKERRQ(ierr); 469*f1dc53b5SDmitry Karpeev ierr = MatGetVecs(jac->pmat[i], &ftmp, PETSC_NULL);CHKERRQ(ierr); 470bdddcaaaSMatthew G Knepley ierr = VecGetSize(ftmp, &N);CHKERRQ(ierr); 471bdddcaaaSMatthew G Knepley ierr = VecSet(ftmp, 1.0/N);CHKERRQ(ierr); 472*f1dc53b5SDmitry Karpeev ierr = VecScatterBegin(ilink->sctx, ftmp, gtmp, INSERT_VALUES, SCATTER_REVERSE);CHKERRQ(ierr); 473*f1dc53b5SDmitry Karpeev ierr = VecScatterEnd(ilink->sctx, ftmp, gtmp, INSERT_VALUES, SCATTER_REVERSE);CHKERRQ(ierr); 474*f1dc53b5SDmitry Karpeev ierr = MatNullSpaceRemove(sp, gtmp, PETSC_NULL);CHKERRQ(ierr); 475bdddcaaaSMatthew G Knepley ierr = VecNorm(gtmp, NORM_2, &norm);CHKERRQ(ierr); 476bdddcaaaSMatthew G Knepley if (norm < 1.0e-10) { 477bdddcaaaSMatthew G Knepley ierr = MatNullSpaceCreate(((PetscObject)pc)->comm, PETSC_TRUE, 0, PETSC_NULL, &subsp);CHKERRQ(ierr); 478bdddcaaaSMatthew G Knepley ierr = MatSetNullSpace(jac->pmat[i], subsp);CHKERRQ(ierr); 479bdddcaaaSMatthew G Knepley ierr = MatNullSpaceDestroy(&subsp);CHKERRQ(ierr); 480bdddcaaaSMatthew G Knepley } 481bdddcaaaSMatthew G Knepley ierr = VecDestroy(&ftmp);CHKERRQ(ierr); 482bdddcaaaSMatthew G Knepley ierr = VecDestroy(>mp);CHKERRQ(ierr); 483bdddcaaaSMatthew G Knepley } 484ed1f0337SMatthew G Knepley /* Check for null space attached to IS */ 485ed1f0337SMatthew G Knepley ierr = PetscObjectQuery((PetscObject) ilink->is, "nearnullspace", (PetscObject *) &sp);CHKERRQ(ierr); 486ed1f0337SMatthew G Knepley if (sp) { 487ed1f0337SMatthew G Knepley ierr = MatSetNearNullSpace(jac->pmat[i], sp);CHKERRQ(ierr); 488ed1f0337SMatthew G Knepley } 489704ba839SBarry Smith ilink = ilink->next; 490cf502942SBarry Smith } 491bdddcaaaSMatthew G Knepley ierr = VecDestroy(&xtmp);CHKERRQ(ierr); 49297bbdb24SBarry Smith } else { 493cf502942SBarry Smith for (i=0; i<nsplit; i++) { 494a3df900dSMatthew G Knepley Mat pmat; 495a3df900dSMatthew G Knepley 496a3df900dSMatthew G Knepley /* Check for preconditioning matrix attached to IS */ 497a3df900dSMatthew G Knepley ierr = PetscObjectQuery((PetscObject) ilink->is, "pmat", (PetscObject *) &pmat);CHKERRQ(ierr); 498a3df900dSMatthew G Knepley if (!pmat) { 4995f4ab4e1SJungho Lee ierr = MatGetSubMatrix(pc->pmat,ilink->is,ilink->is_col,MAT_REUSE_MATRIX,&jac->pmat[i]);CHKERRQ(ierr); 500a3df900dSMatthew G Knepley } 501704ba839SBarry Smith ilink = ilink->next; 502cf502942SBarry Smith } 50397bbdb24SBarry Smith } 504519d70e2SJed Brown if (jac->realdiagonal) { 505519d70e2SJed Brown ilink = jac->head; 506519d70e2SJed Brown if (!jac->mat) { 507519d70e2SJed Brown ierr = PetscMalloc(nsplit*sizeof(Mat),&jac->mat);CHKERRQ(ierr); 508519d70e2SJed Brown for (i=0; i<nsplit; i++) { 5095f4ab4e1SJungho Lee ierr = MatGetSubMatrix(pc->mat,ilink->is,ilink->is_col,MAT_INITIAL_MATRIX,&jac->mat[i]);CHKERRQ(ierr); 510519d70e2SJed Brown ilink = ilink->next; 511519d70e2SJed Brown } 512519d70e2SJed Brown } else { 513519d70e2SJed Brown for (i=0; i<nsplit; i++) { 5145f4ab4e1SJungho Lee if (jac->mat[i]) {ierr = MatGetSubMatrix(pc->mat,ilink->is,ilink->is_col,MAT_REUSE_MATRIX,&jac->mat[i]);CHKERRQ(ierr);} 515519d70e2SJed Brown ilink = ilink->next; 516519d70e2SJed Brown } 517519d70e2SJed Brown } 518519d70e2SJed Brown } else { 519519d70e2SJed Brown jac->mat = jac->pmat; 520519d70e2SJed Brown } 52197bbdb24SBarry Smith 5226c8605c2SJed Brown if (jac->type != PC_COMPOSITE_ADDITIVE && jac->type != PC_COMPOSITE_SCHUR) { 52368dd23aaSBarry Smith /* extract the rows of the matrix associated with each field: used for efficient computation of residual inside algorithm */ 52468dd23aaSBarry Smith ilink = jac->head; 52568dd23aaSBarry Smith if (!jac->Afield) { 52668dd23aaSBarry Smith ierr = PetscMalloc(nsplit*sizeof(Mat),&jac->Afield);CHKERRQ(ierr); 52768dd23aaSBarry Smith for (i=0; i<nsplit; i++) { 5284aa3045dSJed Brown ierr = MatGetSubMatrix(pc->mat,ilink->is,PETSC_NULL,MAT_INITIAL_MATRIX,&jac->Afield[i]);CHKERRQ(ierr); 52968dd23aaSBarry Smith ilink = ilink->next; 53068dd23aaSBarry Smith } 53168dd23aaSBarry Smith } else { 53268dd23aaSBarry Smith for (i=0; i<nsplit; i++) { 5334aa3045dSJed Brown ierr = MatGetSubMatrix(pc->mat,ilink->is,PETSC_NULL,MAT_REUSE_MATRIX,&jac->Afield[i]);CHKERRQ(ierr); 53468dd23aaSBarry Smith ilink = ilink->next; 53568dd23aaSBarry Smith } 53668dd23aaSBarry Smith } 53768dd23aaSBarry Smith } 53868dd23aaSBarry Smith 5393b224e63SBarry Smith if (jac->type == PC_COMPOSITE_SCHUR) { 5403b224e63SBarry Smith IS ccis; 5414aa3045dSJed Brown PetscInt rstart,rend; 542093c86ffSJed Brown char lscname[256]; 543093c86ffSJed Brown PetscObject LSC_L; 544e7e72b3dSBarry Smith if (nsplit != 2) SETERRQ(((PetscObject)pc)->comm,PETSC_ERR_ARG_INCOMP,"To use Schur complement preconditioner you must have exactly 2 fields"); 54568dd23aaSBarry Smith 546e6cab6aaSJed Brown /* When extracting off-diagonal submatrices, we take complements from this range */ 547e6cab6aaSJed Brown ierr = MatGetOwnershipRangeColumn(pc->mat,&rstart,&rend);CHKERRQ(ierr); 548e6cab6aaSJed Brown 5493b224e63SBarry Smith /* need to handle case when one is resetting up the preconditioner */ 5503b224e63SBarry Smith if (jac->schur) { 5513b224e63SBarry Smith ilink = jac->head; 55249bb4cd7SJungho Lee ierr = ISComplement(ilink->is_col,rstart,rend,&ccis);CHKERRQ(ierr); 5534aa3045dSJed Brown ierr = MatGetSubMatrix(pc->mat,ilink->is,ccis,MAT_REUSE_MATRIX,&jac->B);CHKERRQ(ierr); 554fcfd50ebSBarry Smith ierr = ISDestroy(&ccis);CHKERRQ(ierr); 5553b224e63SBarry Smith ilink = ilink->next; 55649bb4cd7SJungho Lee ierr = ISComplement(ilink->is_col,rstart,rend,&ccis);CHKERRQ(ierr); 5574aa3045dSJed Brown ierr = MatGetSubMatrix(pc->mat,ilink->is,ccis,MAT_REUSE_MATRIX,&jac->C);CHKERRQ(ierr); 558fcfd50ebSBarry Smith ierr = ISDestroy(&ccis);CHKERRQ(ierr); 559a3df900dSMatthew G Knepley ierr = MatSchurComplementUpdate(jac->schur,jac->mat[0],jac->pmat[0],jac->B,jac->C,jac->mat[1],pc->flag);CHKERRQ(ierr); 560084e4875SJed Brown ierr = KSPSetOperators(jac->kspschur,jac->schur,FieldSplitSchurPre(jac),pc->flag);CHKERRQ(ierr); 5613b224e63SBarry Smith 5623b224e63SBarry Smith } else { 5631cee3971SBarry Smith KSP ksp; 5646c924f48SJed Brown char schurprefix[256]; 565bdddcaaaSMatthew G Knepley MatNullSpace sp; 5663b224e63SBarry Smith 567a04f6461SBarry Smith /* extract the A01 and A10 matrices */ 5683b224e63SBarry Smith ilink = jac->head; 56949bb4cd7SJungho Lee ierr = ISComplement(ilink->is_col,rstart,rend,&ccis);CHKERRQ(ierr); 5704aa3045dSJed Brown ierr = MatGetSubMatrix(pc->mat,ilink->is,ccis,MAT_INITIAL_MATRIX,&jac->B);CHKERRQ(ierr); 571fcfd50ebSBarry Smith ierr = ISDestroy(&ccis);CHKERRQ(ierr); 5723b224e63SBarry Smith ilink = ilink->next; 57349bb4cd7SJungho Lee ierr = ISComplement(ilink->is_col,rstart,rend,&ccis);CHKERRQ(ierr); 5744aa3045dSJed Brown ierr = MatGetSubMatrix(pc->mat,ilink->is,ccis,MAT_INITIAL_MATRIX,&jac->C);CHKERRQ(ierr); 575fcfd50ebSBarry Smith ierr = ISDestroy(&ccis);CHKERRQ(ierr); 5767d50072eSJed Brown /* Use mat[0] (diagonal block of the real matrix) preconditioned by pmat[0] */ 577519d70e2SJed Brown ierr = MatCreateSchurComplement(jac->mat[0],jac->pmat[0],jac->B,jac->C,jac->mat[1],&jac->schur);CHKERRQ(ierr); 578bdddcaaaSMatthew G Knepley ierr = MatGetNullSpace(jac->pmat[1], &sp);CHKERRQ(ierr); 5791d33e650SDmitry Karpeev /* 5801d33e650SDmitry Karpeev Do we really want to attach the A11-block's nullspace to S? Note that this may generate 5811d33e650SDmitry Karpeev "false positives", when the A11's nullspace isn't S's: Stokes or A = [1, 1; 1, 0]. 5821d33e650SDmitry Karpeev Using a false nullspace may prevent KSP(S) from converging, since it might force an inconsistent rhs. 5831d33e650SDmitry Karpeev */ 5841d33e650SDmitry Karpeev /* if (sp) {ierr = MatSetNullSpace(jac->schur, sp);CHKERRQ(ierr);} */ 5851d33e650SDmitry Karpeev /* set tabbing, options prefix and DM of KSP inside the MatSchurComplement */ 5861cee3971SBarry Smith ierr = MatSchurComplementGetKSP(jac->schur,&ksp);CHKERRQ(ierr); 587e69d4d44SBarry Smith ierr = PetscObjectIncrementTabLevel((PetscObject)ksp,(PetscObject)pc,2);CHKERRQ(ierr); 5887233a360SDmitry Karpeev { 5897233a360SDmitry Karpeev PC pcinner; 5907233a360SDmitry Karpeev ierr = KSPGetPC(ksp, &pcinner); CHKERRQ(ierr); 5917233a360SDmitry Karpeev ierr = PetscObjectIncrementTabLevel((PetscObject)pcinner,(PetscObject)pc,2);CHKERRQ(ierr); 5927233a360SDmitry Karpeev } 593a04f6461SBarry Smith ierr = PetscSNPrintf(schurprefix,sizeof schurprefix,"%sfieldsplit_%s_",((PetscObject)pc)->prefix?((PetscObject)pc)->prefix:"",jac->head->splitname);CHKERRQ(ierr); 594a04f6461SBarry Smith ierr = KSPSetOptionsPrefix(ksp,schurprefix);CHKERRQ(ierr); 5957233a360SDmitry Karpeev /* Can't do KSPGetDM(jac->head->ksp,&dminner); KSPSetDM(ksp,dminner): KSPGetDM() will create DMShell, if the DM hasn't been set - not what we want. */ 5967233a360SDmitry Karpeev ierr = KSPSetDM(ksp,jac->head->dm); CHKERRQ(ierr); 5977233a360SDmitry Karpeev ierr = KSPSetDMActive(ksp, PETSC_FALSE); CHKERRQ(ierr); 5987233a360SDmitry Karpeev ierr = KSPSetFromOptions(ksp); CHKERRQ(ierr); 5997233a360SDmitry Karpeev ierr = KSPSetUp(ksp); CHKERRQ(ierr); 60020b26d62SBarry Smith /* Need to call this everytime because new matrix is being created */ 60120b26d62SBarry Smith ierr = MatSetFromOptions(jac->schur);CHKERRQ(ierr); 6027b62db95SJungho Lee ierr = MatSetUp(jac->schur);CHKERRQ(ierr); 6037233a360SDmitry Karpeev /* Create and set up the KSP for the Schur complement; forward the second split's DM and set up tabbing, including for the contained PC. */ 6043b224e63SBarry Smith ierr = KSPCreate(((PetscObject)pc)->comm,&jac->kspschur);CHKERRQ(ierr); 6059005cf84SBarry Smith ierr = PetscLogObjectParent((PetscObject)pc,(PetscObject)jac->kspschur);CHKERRQ(ierr); 6061cee3971SBarry Smith ierr = PetscObjectIncrementTabLevel((PetscObject)jac->kspschur,(PetscObject)pc,1);CHKERRQ(ierr); 6077233a360SDmitry Karpeev { 6087233a360SDmitry Karpeev PC pcschur; 6097233a360SDmitry Karpeev ierr = KSPGetPC(jac->kspschur, &pcschur); CHKERRQ(ierr); 6107233a360SDmitry Karpeev ierr = PetscObjectIncrementTabLevel((PetscObject)pcschur,(PetscObject)pc,1);CHKERRQ(ierr); 6117233a360SDmitry Karpeev } 6127233a360SDmitry Karpeev /* Can't do KSPGetDM(ilink->ksp,&dmschur); KSPSetDM(kspshur,dmschur): KSPGetDM() will create DMShell, if the DM hasn't been set - not what we want. */ 6137233a360SDmitry Karpeev ierr = KSPSetDM(jac->kspschur,ilink->dm); CHKERRQ(ierr); 6147233a360SDmitry Karpeev ierr = KSPSetDMActive(jac->kspschur, PETSC_FALSE); CHKERRQ(ierr); 6157233a360SDmitry Karpeev 616084e4875SJed Brown ierr = KSPSetOperators(jac->kspschur,jac->schur,FieldSplitSchurPre(jac),DIFFERENT_NONZERO_PATTERN);CHKERRQ(ierr); 617084e4875SJed Brown if (jac->schurpre == PC_FIELDSPLIT_SCHUR_PRE_SELF) { 6187233a360SDmitry Karpeev PC pcschur; 6197233a360SDmitry Karpeev ierr = KSPGetPC(jac->kspschur,&pcschur);CHKERRQ(ierr); 6207233a360SDmitry Karpeev ierr = PCSetType(pcschur,PCNONE);CHKERRQ(ierr); 621084e4875SJed Brown /* Note: This is bad if there exist preconditioners for MATSCHURCOMPLEMENT */ 622e69d4d44SBarry Smith } 6233b224e63SBarry Smith /* really want setfromoptions called in PCSetFromOptions_FieldSplit(), but it is not ready yet */ 62420b26d62SBarry Smith /* need to call this every time, since the jac->kspschur is freshly created, otherwise its options never get set */ 6257233a360SDmitry Karpeev ierr = PetscSNPrintf(schurprefix,sizeof schurprefix,"%sfieldsplit_%s_",((PetscObject)pc)->prefix?((PetscObject)pc)->prefix:"",ilink->splitname);CHKERRQ(ierr); 6267233a360SDmitry Karpeev ierr = KSPSetOptionsPrefix(jac->kspschur,schurprefix);CHKERRQ(ierr); 62720b26d62SBarry Smith ierr = KSPSetFromOptions(jac->kspschur); CHKERRQ(ierr); 6287233a360SDmitry Karpeev ierr = KSPSetUp(jac->kspschur); CHKERRQ(ierr); 6293b224e63SBarry Smith } 630093c86ffSJed Brown 631093c86ffSJed Brown /* HACK: special support to forward L and Lp matrices that might be used by PCLSC */ 632093c86ffSJed Brown ierr = PetscSNPrintf(lscname,sizeof lscname,"%s_LSC_L",ilink->splitname);CHKERRQ(ierr); 633093c86ffSJed Brown ierr = PetscObjectQuery((PetscObject)pc->mat,lscname,(PetscObject*)&LSC_L);CHKERRQ(ierr); 634093c86ffSJed Brown if (!LSC_L) {ierr = PetscObjectQuery((PetscObject)pc->pmat,lscname,(PetscObject*)&LSC_L);CHKERRQ(ierr);} 635093c86ffSJed Brown if (LSC_L) {ierr = PetscObjectCompose((PetscObject)jac->schur,"LSC_L",(PetscObject)LSC_L);CHKERRQ(ierr);} 636093c86ffSJed Brown ierr = PetscSNPrintf(lscname,sizeof lscname,"%s_LSC_Lp",ilink->splitname);CHKERRQ(ierr); 637093c86ffSJed Brown ierr = PetscObjectQuery((PetscObject)pc->pmat,lscname,(PetscObject*)&LSC_L);CHKERRQ(ierr); 638093c86ffSJed Brown if (!LSC_L) {ierr = PetscObjectQuery((PetscObject)pc->mat,lscname,(PetscObject*)&LSC_L);CHKERRQ(ierr);} 639093c86ffSJed Brown if (LSC_L) {ierr = PetscObjectCompose((PetscObject)jac->schur,"LSC_Lp",(PetscObject)LSC_L);CHKERRQ(ierr);} 6407233a360SDmitry Karpeev } 64197bbdb24SBarry Smith /* set up the individual PCs */ 64297bbdb24SBarry Smith i = 0; 6435a9f2f41SSatish Balay ilink = jac->head; 6445a9f2f41SSatish Balay while (ilink) { 645519d70e2SJed Brown ierr = KSPSetOperators(ilink->ksp,jac->mat[i],jac->pmat[i],flag); CHKERRQ(ierr); 6463b224e63SBarry Smith /* really want setfromoptions called in PCSetFromOptions_FieldSplit(), but it is not ready yet */ 647c1570756SJed Brown if (!jac->suboptionsset) {ierr = KSPSetFromOptions(ilink->ksp); CHKERRQ(ierr);} 6485a9f2f41SSatish Balay ierr = KSPSetUp(ilink->ksp);CHKERRQ(ierr); 64997bbdb24SBarry Smith i++; 6505a9f2f41SSatish Balay ilink = ilink->next; 6510971522cSBarry Smith } 6523b224e63SBarry Smith 653c1570756SJed Brown jac->suboptionsset = PETSC_TRUE; 6540971522cSBarry Smith PetscFunctionReturn(0); 6550971522cSBarry Smith } 6560971522cSBarry Smith 6575a9f2f41SSatish Balay #define FieldSplitSplitSolveAdd(ilink,xx,yy) \ 658ca9f406cSSatish Balay (VecScatterBegin(ilink->sctx,xx,ilink->x,INSERT_VALUES,SCATTER_FORWARD) || \ 659ca9f406cSSatish Balay VecScatterEnd(ilink->sctx,xx,ilink->x,INSERT_VALUES,SCATTER_FORWARD) || \ 6605a9f2f41SSatish Balay KSPSolve(ilink->ksp,ilink->x,ilink->y) || \ 661ca9f406cSSatish Balay VecScatterBegin(ilink->sctx,ilink->y,yy,ADD_VALUES,SCATTER_REVERSE) || \ 662ca9f406cSSatish Balay VecScatterEnd(ilink->sctx,ilink->y,yy,ADD_VALUES,SCATTER_REVERSE)) 66379416396SBarry Smith 6640971522cSBarry Smith #undef __FUNCT__ 6653b224e63SBarry Smith #define __FUNCT__ "PCApply_FieldSplit_Schur" 6663b224e63SBarry Smith static PetscErrorCode PCApply_FieldSplit_Schur(PC pc,Vec x,Vec y) 6673b224e63SBarry Smith { 6683b224e63SBarry Smith PC_FieldSplit *jac = (PC_FieldSplit*)pc->data; 6693b224e63SBarry Smith PetscErrorCode ierr; 6703b224e63SBarry Smith KSP ksp; 6713b224e63SBarry Smith PC_FieldSplitLink ilinkA = jac->head, ilinkD = ilinkA->next; 6723b224e63SBarry Smith 6733b224e63SBarry Smith PetscFunctionBegin; 6743b224e63SBarry Smith ierr = MatSchurComplementGetKSP(jac->schur,&ksp);CHKERRQ(ierr); 6753b224e63SBarry Smith 676c5d2311dSJed Brown switch (jac->schurfactorization) { 677c9c6ffaaSJed Brown case PC_FIELDSPLIT_SCHUR_FACT_DIAG: 678a04f6461SBarry Smith /* [A00 0; 0 -S], positive definite, suitable for MINRES */ 679c5d2311dSJed Brown ierr = VecScatterBegin(ilinkA->sctx,x,ilinkA->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr); 680c5d2311dSJed Brown ierr = VecScatterBegin(ilinkD->sctx,x,ilinkD->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr); 681c5d2311dSJed Brown ierr = VecScatterEnd(ilinkA->sctx,x,ilinkA->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr); 682c5d2311dSJed Brown ierr = KSPSolve(ksp,ilinkA->x,ilinkA->y);CHKERRQ(ierr); 683c5d2311dSJed Brown ierr = VecScatterBegin(ilinkA->sctx,ilinkA->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr); 684c5d2311dSJed Brown ierr = VecScatterEnd(ilinkD->sctx,x,ilinkD->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr); 685c5d2311dSJed Brown ierr = KSPSolve(jac->kspschur,ilinkD->x,ilinkD->y);CHKERRQ(ierr); 686c5d2311dSJed Brown ierr = VecScale(ilinkD->y,-1.);CHKERRQ(ierr); 687c5d2311dSJed Brown ierr = VecScatterBegin(ilinkD->sctx,ilinkD->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr); 688c5d2311dSJed Brown ierr = VecScatterEnd(ilinkA->sctx,ilinkA->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr); 689c5d2311dSJed Brown ierr = VecScatterEnd(ilinkD->sctx,ilinkD->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr); 690c5d2311dSJed Brown break; 691c9c6ffaaSJed Brown case PC_FIELDSPLIT_SCHUR_FACT_LOWER: 692a04f6461SBarry Smith /* [A00 0; A10 S], suitable for left preconditioning */ 693c5d2311dSJed Brown ierr = VecScatterBegin(ilinkA->sctx,x,ilinkA->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr); 694c5d2311dSJed Brown ierr = VecScatterEnd(ilinkA->sctx,x,ilinkA->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr); 695c5d2311dSJed Brown ierr = KSPSolve(ksp,ilinkA->x,ilinkA->y);CHKERRQ(ierr); 696c5d2311dSJed Brown ierr = MatMult(jac->C,ilinkA->y,ilinkD->x);CHKERRQ(ierr); 697c5d2311dSJed Brown ierr = VecScale(ilinkD->x,-1.);CHKERRQ(ierr); 698c5d2311dSJed Brown ierr = VecScatterBegin(ilinkD->sctx,x,ilinkD->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr); 699c5d2311dSJed Brown ierr = VecScatterBegin(ilinkA->sctx,ilinkA->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr); 700c5d2311dSJed Brown ierr = VecScatterEnd(ilinkD->sctx,x,ilinkD->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr); 701c5d2311dSJed Brown ierr = KSPSolve(jac->kspschur,ilinkD->x,ilinkD->y);CHKERRQ(ierr); 702c5d2311dSJed Brown ierr = VecScatterBegin(ilinkD->sctx,ilinkD->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr); 703c5d2311dSJed Brown ierr = VecScatterEnd(ilinkA->sctx,ilinkA->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr); 704c5d2311dSJed Brown ierr = VecScatterEnd(ilinkD->sctx,ilinkD->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr); 705c5d2311dSJed Brown break; 706c9c6ffaaSJed Brown case PC_FIELDSPLIT_SCHUR_FACT_UPPER: 707a04f6461SBarry Smith /* [A00 A01; 0 S], suitable for right preconditioning */ 708c5d2311dSJed Brown ierr = VecScatterBegin(ilinkD->sctx,x,ilinkD->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr); 709c5d2311dSJed Brown ierr = VecScatterEnd(ilinkD->sctx,x,ilinkD->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr); 710c5d2311dSJed Brown ierr = KSPSolve(jac->kspschur,ilinkD->x,ilinkD->y);CHKERRQ(ierr); 711c5d2311dSJed Brown ierr = MatMult(jac->B,ilinkD->y,ilinkA->x);CHKERRQ(ierr); 712c5d2311dSJed Brown ierr = VecScale(ilinkA->x,-1.);CHKERRQ(ierr); 713c5d2311dSJed Brown ierr = VecScatterBegin(ilinkA->sctx,x,ilinkA->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr); 714c5d2311dSJed Brown ierr = VecScatterBegin(ilinkD->sctx,ilinkD->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr); 715c5d2311dSJed Brown ierr = VecScatterEnd(ilinkA->sctx,x,ilinkA->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr); 716c5d2311dSJed Brown ierr = KSPSolve(ksp,ilinkA->x,ilinkA->y);CHKERRQ(ierr); 717c5d2311dSJed Brown ierr = VecScatterBegin(ilinkA->sctx,ilinkA->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr); 718c5d2311dSJed Brown ierr = VecScatterEnd(ilinkD->sctx,ilinkD->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr); 719c5d2311dSJed Brown ierr = VecScatterEnd(ilinkA->sctx,ilinkA->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr); 720c5d2311dSJed Brown break; 721c9c6ffaaSJed Brown case PC_FIELDSPLIT_SCHUR_FACT_FULL: 722a04f6461SBarry Smith /* [1 0; A10 A00^{-1} 1] [A00 0; 0 S] [1 A00^{-1}A01; 0 1], an exact solve if applied exactly, needs one extra solve with A */ 7233b224e63SBarry Smith ierr = VecScatterBegin(ilinkA->sctx,x,ilinkA->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr); 7243b224e63SBarry Smith ierr = VecScatterEnd(ilinkA->sctx,x,ilinkA->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr); 7253b224e63SBarry Smith ierr = KSPSolve(ksp,ilinkA->x,ilinkA->y);CHKERRQ(ierr); 7263b224e63SBarry Smith ierr = MatMult(jac->C,ilinkA->y,ilinkD->x);CHKERRQ(ierr); 7273b224e63SBarry Smith ierr = VecScale(ilinkD->x,-1.0);CHKERRQ(ierr); 7283b224e63SBarry Smith ierr = VecScatterBegin(ilinkD->sctx,x,ilinkD->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr); 7293b224e63SBarry Smith ierr = VecScatterEnd(ilinkD->sctx,x,ilinkD->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr); 7303b224e63SBarry Smith 7313b224e63SBarry Smith ierr = KSPSolve(jac->kspschur,ilinkD->x,ilinkD->y);CHKERRQ(ierr); 7323b224e63SBarry Smith ierr = VecScatterBegin(ilinkD->sctx,ilinkD->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr); 7333b224e63SBarry Smith ierr = VecScatterEnd(ilinkD->sctx,ilinkD->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr); 7343b224e63SBarry Smith 7353b224e63SBarry Smith ierr = MatMult(jac->B,ilinkD->y,ilinkA->y);CHKERRQ(ierr); 7363b224e63SBarry Smith ierr = VecAXPY(ilinkA->x,-1.0,ilinkA->y);CHKERRQ(ierr); 7373b224e63SBarry Smith ierr = KSPSolve(ksp,ilinkA->x,ilinkA->y);CHKERRQ(ierr); 7383b224e63SBarry Smith ierr = VecScatterBegin(ilinkA->sctx,ilinkA->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr); 7393b224e63SBarry Smith ierr = VecScatterEnd(ilinkA->sctx,ilinkA->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr); 740c5d2311dSJed Brown } 7413b224e63SBarry Smith PetscFunctionReturn(0); 7423b224e63SBarry Smith } 7433b224e63SBarry Smith 7443b224e63SBarry Smith #undef __FUNCT__ 7450971522cSBarry Smith #define __FUNCT__ "PCApply_FieldSplit" 7460971522cSBarry Smith static PetscErrorCode PCApply_FieldSplit(PC pc,Vec x,Vec y) 7470971522cSBarry Smith { 7480971522cSBarry Smith PC_FieldSplit *jac = (PC_FieldSplit*)pc->data; 7490971522cSBarry Smith PetscErrorCode ierr; 7505a9f2f41SSatish Balay PC_FieldSplitLink ilink = jac->head; 751939b8a20SBarry Smith PetscInt cnt,bs; 7520971522cSBarry Smith 7530971522cSBarry Smith PetscFunctionBegin; 75451f519a2SBarry Smith CHKMEMQ; 75579416396SBarry Smith if (jac->type == PC_COMPOSITE_ADDITIVE) { 7561b9fc7fcSBarry Smith if (jac->defaultsplit) { 757939b8a20SBarry Smith ierr = VecGetBlockSize(x,&bs);CHKERRQ(ierr); 758939b8a20SBarry Smith if (jac->bs > 0 && bs != jac->bs) SETERRQ2(((PetscObject)pc)->comm,PETSC_ERR_ARG_WRONGSTATE,"Blocksize of x vector %D does not match fieldsplit blocksize %D",bs,jac->bs); 759939b8a20SBarry Smith ierr = VecGetBlockSize(y,&bs);CHKERRQ(ierr); 760939b8a20SBarry Smith if (jac->bs > 0 && bs != jac->bs) SETERRQ2(((PetscObject)pc)->comm,PETSC_ERR_ARG_WRONGSTATE,"Blocksize of y vector %D does not match fieldsplit blocksize %D",bs,jac->bs); 7610971522cSBarry Smith ierr = VecStrideGatherAll(x,jac->x,INSERT_VALUES);CHKERRQ(ierr); 7625a9f2f41SSatish Balay while (ilink) { 7635a9f2f41SSatish Balay ierr = KSPSolve(ilink->ksp,ilink->x,ilink->y);CHKERRQ(ierr); 7645a9f2f41SSatish Balay ilink = ilink->next; 7650971522cSBarry Smith } 7660971522cSBarry Smith ierr = VecStrideScatterAll(jac->y,y,INSERT_VALUES);CHKERRQ(ierr); 7671b9fc7fcSBarry Smith } else { 768efb30889SBarry Smith ierr = VecSet(y,0.0);CHKERRQ(ierr); 7695a9f2f41SSatish Balay while (ilink) { 7705a9f2f41SSatish Balay ierr = FieldSplitSplitSolveAdd(ilink,x,y);CHKERRQ(ierr); 7715a9f2f41SSatish Balay ilink = ilink->next; 7721b9fc7fcSBarry Smith } 7731b9fc7fcSBarry Smith } 77416913363SBarry Smith } else if (jac->type == PC_COMPOSITE_MULTIPLICATIVE || jac->type == PC_COMPOSITE_SYMMETRIC_MULTIPLICATIVE) { 77579416396SBarry Smith if (!jac->w1) { 77679416396SBarry Smith ierr = VecDuplicate(x,&jac->w1);CHKERRQ(ierr); 77779416396SBarry Smith ierr = VecDuplicate(x,&jac->w2);CHKERRQ(ierr); 77879416396SBarry Smith } 779efb30889SBarry Smith ierr = VecSet(y,0.0);CHKERRQ(ierr); 7805a9f2f41SSatish Balay ierr = FieldSplitSplitSolveAdd(ilink,x,y);CHKERRQ(ierr); 7813e197d65SBarry Smith cnt = 1; 7825a9f2f41SSatish Balay while (ilink->next) { 7835a9f2f41SSatish Balay ilink = ilink->next; 7843e197d65SBarry Smith /* compute the residual only over the part of the vector needed */ 7853e197d65SBarry Smith ierr = MatMult(jac->Afield[cnt++],y,ilink->x);CHKERRQ(ierr); 7863e197d65SBarry Smith ierr = VecScale(ilink->x,-1.0);CHKERRQ(ierr); 7873e197d65SBarry Smith ierr = VecScatterBegin(ilink->sctx,x,ilink->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr); 7883e197d65SBarry Smith ierr = VecScatterEnd(ilink->sctx,x,ilink->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr); 7893e197d65SBarry Smith ierr = KSPSolve(ilink->ksp,ilink->x,ilink->y);CHKERRQ(ierr); 7903e197d65SBarry Smith ierr = VecScatterBegin(ilink->sctx,ilink->y,y,ADD_VALUES,SCATTER_REVERSE);CHKERRQ(ierr); 7913e197d65SBarry Smith ierr = VecScatterEnd(ilink->sctx,ilink->y,y,ADD_VALUES,SCATTER_REVERSE);CHKERRQ(ierr); 7923e197d65SBarry Smith } 79351f519a2SBarry Smith if (jac->type == PC_COMPOSITE_SYMMETRIC_MULTIPLICATIVE) { 79411755939SBarry Smith cnt -= 2; 79551f519a2SBarry Smith while (ilink->previous) { 79651f519a2SBarry Smith ilink = ilink->previous; 79711755939SBarry Smith /* compute the residual only over the part of the vector needed */ 79811755939SBarry Smith ierr = MatMult(jac->Afield[cnt--],y,ilink->x);CHKERRQ(ierr); 79911755939SBarry Smith ierr = VecScale(ilink->x,-1.0);CHKERRQ(ierr); 80011755939SBarry Smith ierr = VecScatterBegin(ilink->sctx,x,ilink->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr); 80111755939SBarry Smith ierr = VecScatterEnd(ilink->sctx,x,ilink->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr); 80211755939SBarry Smith ierr = KSPSolve(ilink->ksp,ilink->x,ilink->y);CHKERRQ(ierr); 80311755939SBarry Smith ierr = VecScatterBegin(ilink->sctx,ilink->y,y,ADD_VALUES,SCATTER_REVERSE);CHKERRQ(ierr); 80411755939SBarry Smith ierr = VecScatterEnd(ilink->sctx,ilink->y,y,ADD_VALUES,SCATTER_REVERSE);CHKERRQ(ierr); 80551f519a2SBarry Smith } 80611755939SBarry Smith } 80765e19b50SBarry Smith } else SETERRQ1(((PetscObject)pc)->comm,PETSC_ERR_SUP,"Unsupported or unknown composition",(int) jac->type); 80851f519a2SBarry Smith CHKMEMQ; 8090971522cSBarry Smith PetscFunctionReturn(0); 8100971522cSBarry Smith } 8110971522cSBarry Smith 812421e10b8SBarry Smith #define FieldSplitSplitSolveAddTranspose(ilink,xx,yy) \ 813ca9f406cSSatish Balay (VecScatterBegin(ilink->sctx,xx,ilink->y,INSERT_VALUES,SCATTER_FORWARD) || \ 814ca9f406cSSatish Balay VecScatterEnd(ilink->sctx,xx,ilink->y,INSERT_VALUES,SCATTER_FORWARD) || \ 815421e10b8SBarry Smith KSPSolveTranspose(ilink->ksp,ilink->y,ilink->x) || \ 816ca9f406cSSatish Balay VecScatterBegin(ilink->sctx,ilink->x,yy,ADD_VALUES,SCATTER_REVERSE) || \ 817ca9f406cSSatish Balay VecScatterEnd(ilink->sctx,ilink->x,yy,ADD_VALUES,SCATTER_REVERSE)) 818421e10b8SBarry Smith 819421e10b8SBarry Smith #undef __FUNCT__ 8208c03b21aSDmitry Karpeev #define __FUNCT__ "PCApplyTranspose_FieldSplit" 821421e10b8SBarry Smith static PetscErrorCode PCApplyTranspose_FieldSplit(PC pc,Vec x,Vec y) 822421e10b8SBarry Smith { 823421e10b8SBarry Smith PC_FieldSplit *jac = (PC_FieldSplit*)pc->data; 824421e10b8SBarry Smith PetscErrorCode ierr; 825421e10b8SBarry Smith PC_FieldSplitLink ilink = jac->head; 826939b8a20SBarry Smith PetscInt bs; 827421e10b8SBarry Smith 828421e10b8SBarry Smith PetscFunctionBegin; 829421e10b8SBarry Smith CHKMEMQ; 830421e10b8SBarry Smith if (jac->type == PC_COMPOSITE_ADDITIVE) { 831421e10b8SBarry Smith if (jac->defaultsplit) { 832939b8a20SBarry Smith ierr = VecGetBlockSize(x,&bs);CHKERRQ(ierr); 833939b8a20SBarry Smith if (jac->bs > 0 && bs != jac->bs) SETERRQ2(((PetscObject)pc)->comm,PETSC_ERR_ARG_WRONGSTATE,"Blocksize of x vector %D does not match fieldsplit blocksize %D",bs,jac->bs); 834939b8a20SBarry Smith ierr = VecGetBlockSize(y,&bs);CHKERRQ(ierr); 835939b8a20SBarry Smith if (jac->bs > 0 && bs != jac->bs) SETERRQ2(((PetscObject)pc)->comm,PETSC_ERR_ARG_WRONGSTATE,"Blocksize of y vector %D does not match fieldsplit blocksize %D",bs,jac->bs); 836421e10b8SBarry Smith ierr = VecStrideGatherAll(x,jac->x,INSERT_VALUES);CHKERRQ(ierr); 837421e10b8SBarry Smith while (ilink) { 838421e10b8SBarry Smith ierr = KSPSolveTranspose(ilink->ksp,ilink->x,ilink->y);CHKERRQ(ierr); 839421e10b8SBarry Smith ilink = ilink->next; 840421e10b8SBarry Smith } 841421e10b8SBarry Smith ierr = VecStrideScatterAll(jac->y,y,INSERT_VALUES);CHKERRQ(ierr); 842421e10b8SBarry Smith } else { 843421e10b8SBarry Smith ierr = VecSet(y,0.0);CHKERRQ(ierr); 844421e10b8SBarry Smith while (ilink) { 845421e10b8SBarry Smith ierr = FieldSplitSplitSolveAddTranspose(ilink,x,y);CHKERRQ(ierr); 846421e10b8SBarry Smith ilink = ilink->next; 847421e10b8SBarry Smith } 848421e10b8SBarry Smith } 849421e10b8SBarry Smith } else { 850421e10b8SBarry Smith if (!jac->w1) { 851421e10b8SBarry Smith ierr = VecDuplicate(x,&jac->w1);CHKERRQ(ierr); 852421e10b8SBarry Smith ierr = VecDuplicate(x,&jac->w2);CHKERRQ(ierr); 853421e10b8SBarry Smith } 854421e10b8SBarry Smith ierr = VecSet(y,0.0);CHKERRQ(ierr); 855421e10b8SBarry Smith if (jac->type == PC_COMPOSITE_SYMMETRIC_MULTIPLICATIVE) { 856421e10b8SBarry Smith ierr = FieldSplitSplitSolveAddTranspose(ilink,x,y);CHKERRQ(ierr); 857421e10b8SBarry Smith while (ilink->next) { 858421e10b8SBarry Smith ilink = ilink->next; 8599989ab13SBarry Smith ierr = MatMultTranspose(pc->mat,y,jac->w1);CHKERRQ(ierr); 860421e10b8SBarry Smith ierr = VecWAXPY(jac->w2,-1.0,jac->w1,x);CHKERRQ(ierr); 861421e10b8SBarry Smith ierr = FieldSplitSplitSolveAddTranspose(ilink,jac->w2,y);CHKERRQ(ierr); 862421e10b8SBarry Smith } 863421e10b8SBarry Smith while (ilink->previous) { 864421e10b8SBarry Smith ilink = ilink->previous; 8659989ab13SBarry Smith ierr = MatMultTranspose(pc->mat,y,jac->w1);CHKERRQ(ierr); 866421e10b8SBarry Smith ierr = VecWAXPY(jac->w2,-1.0,jac->w1,x);CHKERRQ(ierr); 867421e10b8SBarry Smith ierr = FieldSplitSplitSolveAddTranspose(ilink,jac->w2,y);CHKERRQ(ierr); 868421e10b8SBarry Smith } 869421e10b8SBarry Smith } else { 870421e10b8SBarry Smith while (ilink->next) { /* get to last entry in linked list */ 871421e10b8SBarry Smith ilink = ilink->next; 872421e10b8SBarry Smith } 873421e10b8SBarry Smith ierr = FieldSplitSplitSolveAddTranspose(ilink,x,y);CHKERRQ(ierr); 874421e10b8SBarry Smith while (ilink->previous) { 875421e10b8SBarry Smith ilink = ilink->previous; 8769989ab13SBarry Smith ierr = MatMultTranspose(pc->mat,y,jac->w1);CHKERRQ(ierr); 877421e10b8SBarry Smith ierr = VecWAXPY(jac->w2,-1.0,jac->w1,x);CHKERRQ(ierr); 878421e10b8SBarry Smith ierr = FieldSplitSplitSolveAddTranspose(ilink,jac->w2,y);CHKERRQ(ierr); 879421e10b8SBarry Smith } 880421e10b8SBarry Smith } 881421e10b8SBarry Smith } 882421e10b8SBarry Smith CHKMEMQ; 883421e10b8SBarry Smith PetscFunctionReturn(0); 884421e10b8SBarry Smith } 885421e10b8SBarry Smith 8860971522cSBarry Smith #undef __FUNCT__ 887574deadeSBarry Smith #define __FUNCT__ "PCReset_FieldSplit" 888574deadeSBarry Smith static PetscErrorCode PCReset_FieldSplit(PC pc) 8890971522cSBarry Smith { 8900971522cSBarry Smith PC_FieldSplit *jac = (PC_FieldSplit*)pc->data; 8910971522cSBarry Smith PetscErrorCode ierr; 8925a9f2f41SSatish Balay PC_FieldSplitLink ilink = jac->head,next; 8930971522cSBarry Smith 8940971522cSBarry Smith PetscFunctionBegin; 8955a9f2f41SSatish Balay while (ilink) { 896574deadeSBarry Smith ierr = KSPReset(ilink->ksp);CHKERRQ(ierr); 897fcfd50ebSBarry Smith ierr = VecDestroy(&ilink->x);CHKERRQ(ierr); 898fcfd50ebSBarry Smith ierr = VecDestroy(&ilink->y);CHKERRQ(ierr); 899fcfd50ebSBarry Smith ierr = VecScatterDestroy(&ilink->sctx);CHKERRQ(ierr); 900fcfd50ebSBarry Smith ierr = ISDestroy(&ilink->is);CHKERRQ(ierr); 901b5787286SJed Brown ierr = ISDestroy(&ilink->is_col);CHKERRQ(ierr); 9025a9f2f41SSatish Balay next = ilink->next; 9035a9f2f41SSatish Balay ilink = next; 9040971522cSBarry Smith } 90505b42c5fSBarry Smith ierr = PetscFree2(jac->x,jac->y);CHKERRQ(ierr); 906574deadeSBarry Smith if (jac->mat && jac->mat != jac->pmat) { 907574deadeSBarry Smith ierr = MatDestroyMatrices(jac->nsplits,&jac->mat);CHKERRQ(ierr); 908574deadeSBarry Smith } else if (jac->mat) { 909574deadeSBarry Smith jac->mat = PETSC_NULL; 910574deadeSBarry Smith } 91197bbdb24SBarry Smith if (jac->pmat) {ierr = MatDestroyMatrices(jac->nsplits,&jac->pmat);CHKERRQ(ierr);} 91268dd23aaSBarry Smith if (jac->Afield) {ierr = MatDestroyMatrices(jac->nsplits,&jac->Afield);CHKERRQ(ierr);} 9136bf464f9SBarry Smith ierr = VecDestroy(&jac->w1);CHKERRQ(ierr); 9146bf464f9SBarry Smith ierr = VecDestroy(&jac->w2);CHKERRQ(ierr); 9156bf464f9SBarry Smith ierr = MatDestroy(&jac->schur);CHKERRQ(ierr); 9166bf464f9SBarry Smith ierr = MatDestroy(&jac->schur_user);CHKERRQ(ierr); 9176bf464f9SBarry Smith ierr = KSPDestroy(&jac->kspschur);CHKERRQ(ierr); 9186bf464f9SBarry Smith ierr = MatDestroy(&jac->B);CHKERRQ(ierr); 9196bf464f9SBarry Smith ierr = MatDestroy(&jac->C);CHKERRQ(ierr); 92063ec74ffSBarry Smith jac->reset = PETSC_TRUE; 921574deadeSBarry Smith PetscFunctionReturn(0); 922574deadeSBarry Smith } 923574deadeSBarry Smith 924574deadeSBarry Smith #undef __FUNCT__ 925574deadeSBarry Smith #define __FUNCT__ "PCDestroy_FieldSplit" 926574deadeSBarry Smith static PetscErrorCode PCDestroy_FieldSplit(PC pc) 927574deadeSBarry Smith { 928574deadeSBarry Smith PC_FieldSplit *jac = (PC_FieldSplit*)pc->data; 929574deadeSBarry Smith PetscErrorCode ierr; 930574deadeSBarry Smith PC_FieldSplitLink ilink = jac->head,next; 931574deadeSBarry Smith 932574deadeSBarry Smith PetscFunctionBegin; 933574deadeSBarry Smith ierr = PCReset_FieldSplit(pc);CHKERRQ(ierr); 934574deadeSBarry Smith while (ilink) { 9356bf464f9SBarry Smith ierr = KSPDestroy(&ilink->ksp);CHKERRQ(ierr); 936574deadeSBarry Smith next = ilink->next; 937574deadeSBarry Smith ierr = PetscFree(ilink->splitname);CHKERRQ(ierr); 938574deadeSBarry Smith ierr = PetscFree(ilink->fields);CHKERRQ(ierr); 9395d4c12cdSJungho Lee ierr = PetscFree(ilink->fields_col);CHKERRQ(ierr); 940574deadeSBarry Smith ierr = PetscFree(ilink);CHKERRQ(ierr); 941574deadeSBarry Smith ilink = next; 942574deadeSBarry Smith } 943574deadeSBarry Smith ierr = PetscFree2(jac->x,jac->y);CHKERRQ(ierr); 944c31cb41cSBarry Smith ierr = PetscFree(pc->data);CHKERRQ(ierr); 9457b62db95SJungho Lee ierr = PetscObjectComposeFunctionDynamic((PetscObject)pc,"PCFieldSplitGetSubKSP_C","",PETSC_NULL);CHKERRQ(ierr); 9467b62db95SJungho Lee ierr = PetscObjectComposeFunctionDynamic((PetscObject)pc,"PCFieldSplitSetFields_C","",PETSC_NULL);CHKERRQ(ierr); 9477b62db95SJungho Lee ierr = PetscObjectComposeFunctionDynamic((PetscObject)pc,"PCFieldSplitSetIS_C","",PETSC_NULL);CHKERRQ(ierr); 9487b62db95SJungho Lee ierr = PetscObjectComposeFunctionDynamic((PetscObject)pc,"PCFieldSplitSetType_C","",PETSC_NULL);CHKERRQ(ierr); 9497b62db95SJungho Lee ierr = PetscObjectComposeFunctionDynamic((PetscObject)pc,"PCFieldSplitSetBlockSize_C","",PETSC_NULL);CHKERRQ(ierr); 950ab1df9f5SJed Brown ierr = PetscObjectComposeFunctionDynamic((PetscObject)pc,"PCFieldSplitSchurPrecondition_C","",PETSC_NULL);CHKERRQ(ierr); 951c9c6ffaaSJed Brown ierr = PetscObjectComposeFunctionDynamic((PetscObject)pc,"PCFieldSplitSetSchurFactType_C","",PETSC_NULL);CHKERRQ(ierr); 9520971522cSBarry Smith PetscFunctionReturn(0); 9530971522cSBarry Smith } 9540971522cSBarry Smith 9550971522cSBarry Smith #undef __FUNCT__ 9560971522cSBarry Smith #define __FUNCT__ "PCSetFromOptions_FieldSplit" 9570971522cSBarry Smith static PetscErrorCode PCSetFromOptions_FieldSplit(PC pc) 9580971522cSBarry Smith { 9591b9fc7fcSBarry Smith PetscErrorCode ierr; 9606c924f48SJed Brown PetscInt bs; 961bc59fbc5SBarry Smith PetscBool flg,stokes = PETSC_FALSE; 9629dcbbd2bSBarry Smith PC_FieldSplit *jac = (PC_FieldSplit*)pc->data; 9633b224e63SBarry Smith PCCompositeType ctype; 964e7c4fc90SDmitry Karpeev DM ddm; 965e7c4fc90SDmitry Karpeev char ddm_name[1025]; 9661b9fc7fcSBarry Smith 9670971522cSBarry Smith PetscFunctionBegin; 9681b9fc7fcSBarry Smith ierr = PetscOptionsHead("FieldSplit options");CHKERRQ(ierr); 969e7c4fc90SDmitry Karpeev if(pc->dm) { 970e7c4fc90SDmitry Karpeev /* Allow the user to request a decomposition DM by name */ 971e7c4fc90SDmitry Karpeev ierr = PetscStrncpy(ddm_name, "", 1024); CHKERRQ(ierr); 972731c8d9eSDmitry Karpeev ierr = PetscOptionsString("-pc_fieldsplit_decomposition", "Name of the DM defining the composition", "PCSetDM", ddm_name, ddm_name,1024,&flg); CHKERRQ(ierr); 973e7c4fc90SDmitry Karpeev if(flg) { 97416621825SDmitry Karpeev ierr = DMCreateFieldDecompositionDM(pc->dm, ddm_name, &ddm); CHKERRQ(ierr); 975e7c4fc90SDmitry Karpeev if(!ddm) { 97616621825SDmitry Karpeev SETERRQ1(((PetscObject)pc)->comm, PETSC_ERR_ARG_WRONGSTATE, "Uknown field decomposition name %s", ddm_name); 977e7c4fc90SDmitry Karpeev } 97816621825SDmitry Karpeev ierr = PetscInfo(pc,"Using field decomposition DM defined using options database\n");CHKERRQ(ierr); 979e7c4fc90SDmitry Karpeev ierr = PCSetDM(pc,ddm); CHKERRQ(ierr); 980e7c4fc90SDmitry Karpeev } 981e7c4fc90SDmitry Karpeev } 982acfcf0e5SJed Brown ierr = PetscOptionsBool("-pc_fieldsplit_real_diagonal","Use diagonal blocks of the operator","PCFieldSplitSetRealDiagonal",jac->realdiagonal,&jac->realdiagonal,PETSC_NULL);CHKERRQ(ierr); 98351f519a2SBarry Smith ierr = PetscOptionsInt("-pc_fieldsplit_block_size","Blocksize that defines number of fields","PCFieldSplitSetBlockSize",jac->bs,&bs,&flg);CHKERRQ(ierr); 98451f519a2SBarry Smith if (flg) { 98551f519a2SBarry Smith ierr = PCFieldSplitSetBlockSize(pc,bs);CHKERRQ(ierr); 98651f519a2SBarry Smith } 987704ba839SBarry Smith 988435f959eSBarry Smith ierr = PetscOptionsGetBool(((PetscObject)pc)->prefix,"-pc_fieldsplit_detect_saddle_point",&stokes,PETSC_NULL);CHKERRQ(ierr); 989c0adfefeSBarry Smith if (stokes) { 990c0adfefeSBarry Smith ierr = PCFieldSplitSetType(pc,PC_COMPOSITE_SCHUR);CHKERRQ(ierr); 991c0adfefeSBarry Smith jac->schurpre = PC_FIELDSPLIT_SCHUR_PRE_SELF; 992c0adfefeSBarry Smith } 993c0adfefeSBarry Smith 9943b224e63SBarry Smith ierr = PetscOptionsEnum("-pc_fieldsplit_type","Type of composition","PCFieldSplitSetType",PCCompositeTypes,(PetscEnum)jac->type,(PetscEnum*)&ctype,&flg);CHKERRQ(ierr); 9953b224e63SBarry Smith if (flg) { 9963b224e63SBarry Smith ierr = PCFieldSplitSetType(pc,ctype);CHKERRQ(ierr); 9973b224e63SBarry Smith } 998c30613efSMatthew Knepley /* Only setup fields once */ 999c30613efSMatthew Knepley if ((jac->bs > 0) && (jac->nsplits == 0)) { 1000d32f9abdSBarry Smith /* only allow user to set fields from command line if bs is already known. 1001d32f9abdSBarry Smith otherwise user can set them in PCFieldSplitSetDefaults() */ 10026c924f48SJed Brown ierr = PCFieldSplitSetRuntimeSplits_Private(pc);CHKERRQ(ierr); 10036c924f48SJed Brown if (jac->splitdefined) {ierr = PetscInfo(pc,"Splits defined using the options database\n");CHKERRQ(ierr);} 1004d32f9abdSBarry Smith } 1005c5d2311dSJed Brown if (jac->type == PC_COMPOSITE_SCHUR) { 1006c9c6ffaaSJed Brown ierr = PetscOptionsGetEnum(((PetscObject)pc)->prefix,"-pc_fieldsplit_schur_factorization_type",PCFieldSplitSchurFactTypes,(PetscEnum*)&jac->schurfactorization,&flg);CHKERRQ(ierr); 1007c9c6ffaaSJed Brown if (flg) {ierr = PetscInfo(pc,"Deprecated use of -pc_fieldsplit_schur_factorization_type\n");CHKERRQ(ierr);} 1008c9c6ffaaSJed Brown ierr = PetscOptionsEnum("-pc_fieldsplit_schur_fact_type","Which off-diagonal parts of the block factorization to use","PCFieldSplitSetSchurFactType",PCFieldSplitSchurFactTypes,(PetscEnum)jac->schurfactorization,(PetscEnum*)&jac->schurfactorization,PETSC_NULL);CHKERRQ(ierr); 1009084e4875SJed Brown ierr = PetscOptionsEnum("-pc_fieldsplit_schur_precondition","How to build preconditioner for Schur complement","PCFieldSplitSchurPrecondition",PCFieldSplitSchurPreTypes,(PetscEnum)jac->schurpre,(PetscEnum*)&jac->schurpre,PETSC_NULL);CHKERRQ(ierr); 1010c5d2311dSJed Brown } 10111b9fc7fcSBarry Smith ierr = PetscOptionsTail();CHKERRQ(ierr); 10120971522cSBarry Smith PetscFunctionReturn(0); 10130971522cSBarry Smith } 10140971522cSBarry Smith 10150971522cSBarry Smith /*------------------------------------------------------------------------------------*/ 10160971522cSBarry Smith 10170971522cSBarry Smith EXTERN_C_BEGIN 10180971522cSBarry Smith #undef __FUNCT__ 10190971522cSBarry Smith #define __FUNCT__ "PCFieldSplitSetFields_FieldSplit" 10205d4c12cdSJungho Lee PetscErrorCode PCFieldSplitSetFields_FieldSplit(PC pc,const char splitname[],PetscInt n,const PetscInt *fields,const PetscInt *fields_col) 10210971522cSBarry Smith { 102297bbdb24SBarry Smith PC_FieldSplit *jac = (PC_FieldSplit*)pc->data; 10230971522cSBarry Smith PetscErrorCode ierr; 10245a9f2f41SSatish Balay PC_FieldSplitLink ilink,next = jac->head; 102569a612a9SBarry Smith char prefix[128]; 10265d4c12cdSJungho Lee PetscInt i; 10270971522cSBarry Smith 10280971522cSBarry Smith PetscFunctionBegin; 10296c924f48SJed Brown if (jac->splitdefined) { 10306c924f48SJed Brown ierr = PetscInfo1(pc,"Ignoring new split \"%s\" because the splits have already been defined\n",splitname);CHKERRQ(ierr); 10316c924f48SJed Brown PetscFunctionReturn(0); 10326c924f48SJed Brown } 103351f519a2SBarry Smith for (i=0; i<n; i++) { 1034e32f2f54SBarry Smith if (fields[i] >= jac->bs) SETERRQ2(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Field %D requested but only %D exist",fields[i],jac->bs); 1035e32f2f54SBarry Smith if (fields[i] < 0) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Negative field %D requested",fields[i]); 103651f519a2SBarry Smith } 1037704ba839SBarry Smith ierr = PetscNew(struct _PC_FieldSplitLink,&ilink);CHKERRQ(ierr); 1038a04f6461SBarry Smith if (splitname) { 1039db4c96c1SJed Brown ierr = PetscStrallocpy(splitname,&ilink->splitname);CHKERRQ(ierr); 1040a04f6461SBarry Smith } else { 1041a04f6461SBarry Smith ierr = PetscMalloc(3*sizeof(char),&ilink->splitname);CHKERRQ(ierr); 1042a04f6461SBarry Smith ierr = PetscSNPrintf(ilink->splitname,2,"%s",jac->nsplits);CHKERRQ(ierr); 1043a04f6461SBarry Smith } 1044704ba839SBarry Smith ierr = PetscMalloc(n*sizeof(PetscInt),&ilink->fields);CHKERRQ(ierr); 10455a9f2f41SSatish Balay ierr = PetscMemcpy(ilink->fields,fields,n*sizeof(PetscInt));CHKERRQ(ierr); 10465d4c12cdSJungho Lee ierr = PetscMalloc(n*sizeof(PetscInt),&ilink->fields_col);CHKERRQ(ierr); 10475d4c12cdSJungho Lee ierr = PetscMemcpy(ilink->fields_col,fields_col,n*sizeof(PetscInt));CHKERRQ(ierr); 10485a9f2f41SSatish Balay ilink->nfields = n; 10495a9f2f41SSatish Balay ilink->next = PETSC_NULL; 10507adad957SLisandro Dalcin ierr = KSPCreate(((PetscObject)pc)->comm,&ilink->ksp);CHKERRQ(ierr); 10511cee3971SBarry Smith ierr = PetscObjectIncrementTabLevel((PetscObject)ilink->ksp,(PetscObject)pc,1);CHKERRQ(ierr); 10525a9f2f41SSatish Balay ierr = KSPSetType(ilink->ksp,KSPPREONLY);CHKERRQ(ierr); 10539005cf84SBarry Smith ierr = PetscLogObjectParent((PetscObject)pc,(PetscObject)ilink->ksp);CHKERRQ(ierr); 105469a612a9SBarry Smith 1055a04f6461SBarry Smith ierr = PetscSNPrintf(prefix,sizeof prefix,"%sfieldsplit_%s_",((PetscObject)pc)->prefix?((PetscObject)pc)->prefix:"",ilink->splitname);CHKERRQ(ierr); 10565a9f2f41SSatish Balay ierr = KSPSetOptionsPrefix(ilink->ksp,prefix);CHKERRQ(ierr); 10570971522cSBarry Smith 10580971522cSBarry Smith if (!next) { 10595a9f2f41SSatish Balay jac->head = ilink; 106051f519a2SBarry Smith ilink->previous = PETSC_NULL; 10610971522cSBarry Smith } else { 10620971522cSBarry Smith while (next->next) { 10630971522cSBarry Smith next = next->next; 10640971522cSBarry Smith } 10655a9f2f41SSatish Balay next->next = ilink; 106651f519a2SBarry Smith ilink->previous = next; 10670971522cSBarry Smith } 10680971522cSBarry Smith jac->nsplits++; 10690971522cSBarry Smith PetscFunctionReturn(0); 10700971522cSBarry Smith } 10710971522cSBarry Smith EXTERN_C_END 10720971522cSBarry Smith 1073e69d4d44SBarry Smith EXTERN_C_BEGIN 1074e69d4d44SBarry Smith #undef __FUNCT__ 1075e69d4d44SBarry Smith #define __FUNCT__ "PCFieldSplitGetSubKSP_FieldSplit_Schur" 10767087cfbeSBarry Smith PetscErrorCode PCFieldSplitGetSubKSP_FieldSplit_Schur(PC pc,PetscInt *n,KSP **subksp) 1077e69d4d44SBarry Smith { 1078e69d4d44SBarry Smith PC_FieldSplit *jac = (PC_FieldSplit*)pc->data; 1079e69d4d44SBarry Smith PetscErrorCode ierr; 1080e69d4d44SBarry Smith 1081e69d4d44SBarry Smith PetscFunctionBegin; 1082519d70e2SJed Brown ierr = PetscMalloc(jac->nsplits*sizeof(KSP),subksp);CHKERRQ(ierr); 1083e69d4d44SBarry Smith ierr = MatSchurComplementGetKSP(jac->schur,*subksp);CHKERRQ(ierr); 1084e69d4d44SBarry Smith (*subksp)[1] = jac->kspschur; 108513e0d083SBarry Smith if (n) *n = jac->nsplits; 1086e69d4d44SBarry Smith PetscFunctionReturn(0); 1087e69d4d44SBarry Smith } 1088e69d4d44SBarry Smith EXTERN_C_END 10890971522cSBarry Smith 10900971522cSBarry Smith EXTERN_C_BEGIN 10910971522cSBarry Smith #undef __FUNCT__ 109269a612a9SBarry Smith #define __FUNCT__ "PCFieldSplitGetSubKSP_FieldSplit" 10937087cfbeSBarry Smith PetscErrorCode PCFieldSplitGetSubKSP_FieldSplit(PC pc,PetscInt *n,KSP **subksp) 10940971522cSBarry Smith { 10950971522cSBarry Smith PC_FieldSplit *jac = (PC_FieldSplit*)pc->data; 10960971522cSBarry Smith PetscErrorCode ierr; 10970971522cSBarry Smith PetscInt cnt = 0; 10985a9f2f41SSatish Balay PC_FieldSplitLink ilink = jac->head; 10990971522cSBarry Smith 11000971522cSBarry Smith PetscFunctionBegin; 11015d480477SMatthew G Knepley ierr = PetscMalloc(jac->nsplits*sizeof(KSP),subksp);CHKERRQ(ierr); 11025a9f2f41SSatish Balay while (ilink) { 11035a9f2f41SSatish Balay (*subksp)[cnt++] = ilink->ksp; 11045a9f2f41SSatish Balay ilink = ilink->next; 11050971522cSBarry Smith } 11065d480477SMatthew G Knepley if (cnt != jac->nsplits) SETERRQ2(PETSC_COMM_SELF,PETSC_ERR_PLIB,"Corrupt PCFIELDSPLIT object: number of splits in linked list %D does not match number in object %D",cnt,jac->nsplits); 110713e0d083SBarry Smith if (n) *n = jac->nsplits; 11080971522cSBarry Smith PetscFunctionReturn(0); 11090971522cSBarry Smith } 11100971522cSBarry Smith EXTERN_C_END 11110971522cSBarry Smith 1112704ba839SBarry Smith EXTERN_C_BEGIN 1113704ba839SBarry Smith #undef __FUNCT__ 1114704ba839SBarry Smith #define __FUNCT__ "PCFieldSplitSetIS_FieldSplit" 11157087cfbeSBarry Smith PetscErrorCode PCFieldSplitSetIS_FieldSplit(PC pc,const char splitname[],IS is) 1116704ba839SBarry Smith { 1117704ba839SBarry Smith PC_FieldSplit *jac = (PC_FieldSplit*)pc->data; 1118704ba839SBarry Smith PetscErrorCode ierr; 1119704ba839SBarry Smith PC_FieldSplitLink ilink, next = jac->head; 1120704ba839SBarry Smith char prefix[128]; 1121704ba839SBarry Smith 1122704ba839SBarry Smith PetscFunctionBegin; 11236c924f48SJed Brown if (jac->splitdefined) { 11246c924f48SJed Brown ierr = PetscInfo1(pc,"Ignoring new split \"%s\" because the splits have already been defined\n",splitname);CHKERRQ(ierr); 11256c924f48SJed Brown PetscFunctionReturn(0); 11266c924f48SJed Brown } 112716913363SBarry Smith ierr = PetscNew(struct _PC_FieldSplitLink,&ilink);CHKERRQ(ierr); 1128a04f6461SBarry Smith if (splitname) { 1129db4c96c1SJed Brown ierr = PetscStrallocpy(splitname,&ilink->splitname);CHKERRQ(ierr); 1130a04f6461SBarry Smith } else { 1131b5787286SJed Brown ierr = PetscMalloc(8*sizeof(char),&ilink->splitname);CHKERRQ(ierr); 1132b5787286SJed Brown ierr = PetscSNPrintf(ilink->splitname,7,"%D",jac->nsplits);CHKERRQ(ierr); 1133a04f6461SBarry Smith } 11341ab39975SBarry Smith ierr = PetscObjectReference((PetscObject)is);CHKERRQ(ierr); 1135b5787286SJed Brown ierr = ISDestroy(&ilink->is);CHKERRQ(ierr); 1136b5787286SJed Brown ilink->is = is; 1137b5787286SJed Brown ierr = PetscObjectReference((PetscObject)is);CHKERRQ(ierr); 1138b5787286SJed Brown ierr = ISDestroy(&ilink->is_col);CHKERRQ(ierr); 1139b5787286SJed Brown ilink->is_col = is; 1140704ba839SBarry Smith ilink->next = PETSC_NULL; 1141704ba839SBarry Smith ierr = KSPCreate(((PetscObject)pc)->comm,&ilink->ksp);CHKERRQ(ierr); 11421cee3971SBarry Smith ierr = PetscObjectIncrementTabLevel((PetscObject)ilink->ksp,(PetscObject)pc,1);CHKERRQ(ierr); 11437233a360SDmitry Karpeev { 11447233a360SDmitry Karpeev PC ilinkpc; 11457233a360SDmitry Karpeev ierr = KSPGetPC(ilink->ksp, &ilinkpc); CHKERRQ(ierr); 11467233a360SDmitry Karpeev ierr = PetscObjectIncrementTabLevel((PetscObject)ilinkpc,(PetscObject)pc,1);CHKERRQ(ierr); 11477233a360SDmitry Karpeev } 1148704ba839SBarry Smith ierr = KSPSetType(ilink->ksp,KSPPREONLY);CHKERRQ(ierr); 11499005cf84SBarry Smith ierr = PetscLogObjectParent((PetscObject)pc,(PetscObject)ilink->ksp);CHKERRQ(ierr); 1150704ba839SBarry Smith 1151a04f6461SBarry Smith ierr = PetscSNPrintf(prefix,sizeof prefix,"%sfieldsplit_%s_",((PetscObject)pc)->prefix?((PetscObject)pc)->prefix:"",ilink->splitname);CHKERRQ(ierr); 1152704ba839SBarry Smith ierr = KSPSetOptionsPrefix(ilink->ksp,prefix);CHKERRQ(ierr); 1153704ba839SBarry Smith 1154704ba839SBarry Smith if (!next) { 1155704ba839SBarry Smith jac->head = ilink; 1156704ba839SBarry Smith ilink->previous = PETSC_NULL; 1157704ba839SBarry Smith } else { 1158704ba839SBarry Smith while (next->next) { 1159704ba839SBarry Smith next = next->next; 1160704ba839SBarry Smith } 1161704ba839SBarry Smith next->next = ilink; 1162704ba839SBarry Smith ilink->previous = next; 1163704ba839SBarry Smith } 1164704ba839SBarry Smith jac->nsplits++; 1165704ba839SBarry Smith 1166704ba839SBarry Smith PetscFunctionReturn(0); 1167704ba839SBarry Smith } 1168704ba839SBarry Smith EXTERN_C_END 1169704ba839SBarry Smith 11700971522cSBarry Smith #undef __FUNCT__ 11710971522cSBarry Smith #define __FUNCT__ "PCFieldSplitSetFields" 11720971522cSBarry Smith /*@ 11730971522cSBarry Smith PCFieldSplitSetFields - Sets the fields for one particular split in the field split preconditioner 11740971522cSBarry Smith 1175ad4df100SBarry Smith Logically Collective on PC 11760971522cSBarry Smith 11770971522cSBarry Smith Input Parameters: 11780971522cSBarry Smith + pc - the preconditioner context 1179a04f6461SBarry Smith . splitname - name of this split, if PETSC_NULL the number of the split is used 11800971522cSBarry Smith . n - the number of fields in this split 1181db4c96c1SJed Brown - fields - the fields in this split 11820971522cSBarry Smith 11830971522cSBarry Smith Level: intermediate 11840971522cSBarry Smith 1185d32f9abdSBarry Smith Notes: Use PCFieldSplitSetIS() to set a completely general set of indices as a field. 1186d32f9abdSBarry Smith 1187d32f9abdSBarry Smith The PCFieldSplitSetFields() is for defining fields as a strided blocks. For example, if the block 1188d32f9abdSBarry Smith size is three then one can define a field as 0, or 1 or 2 or 0,1 or 0,2 or 1,2 which mean 1189d32f9abdSBarry Smith 0xx3xx6xx9xx12 ... x1xx4xx7xx ... xx2xx5xx8xx.. 01x34x67x... 0x1x3x5x7.. x12x45x78x.... 1190d32f9abdSBarry Smith where the numbered entries indicate what is in the field. 1191d32f9abdSBarry Smith 1192db4c96c1SJed Brown This function is called once per split (it creates a new split each time). Solve options 1193db4c96c1SJed Brown for this split will be available under the prefix -fieldsplit_SPLITNAME_. 1194db4c96c1SJed Brown 11955d4c12cdSJungho Lee Developer Note: This routine does not actually create the IS representing the split, that is delayed 11965d4c12cdSJungho Lee until PCSetUp_FieldSplit(), because information about the vector/matrix layouts may not be 11975d4c12cdSJungho Lee available when this routine is called. 11985d4c12cdSJungho Lee 1199d32f9abdSBarry Smith .seealso: PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitSetBlockSize(), PCFieldSplitSetIS() 12000971522cSBarry Smith 12010971522cSBarry Smith @*/ 12025d4c12cdSJungho Lee PetscErrorCode PCFieldSplitSetFields(PC pc,const char splitname[],PetscInt n,const PetscInt *fields,const PetscInt *fields_col) 12030971522cSBarry Smith { 12044ac538c5SBarry Smith PetscErrorCode ierr; 12050971522cSBarry Smith 12060971522cSBarry Smith PetscFunctionBegin; 12070700a824SBarry Smith PetscValidHeaderSpecific(pc,PC_CLASSID,1); 1208db4c96c1SJed Brown PetscValidCharPointer(splitname,2); 1209db4c96c1SJed Brown if (n < 1) SETERRQ2(((PetscObject)pc)->comm,PETSC_ERR_ARG_OUTOFRANGE,"Provided number of fields %D in split \"%s\" not positive",n,splitname); 1210db4c96c1SJed Brown PetscValidIntPointer(fields,3); 12115d4c12cdSJungho Lee ierr = PetscTryMethod(pc,"PCFieldSplitSetFields_C",(PC,const char[],PetscInt,const PetscInt *,const PetscInt *),(pc,splitname,n,fields,fields_col));CHKERRQ(ierr); 12120971522cSBarry Smith PetscFunctionReturn(0); 12130971522cSBarry Smith } 12140971522cSBarry Smith 12150971522cSBarry Smith #undef __FUNCT__ 1216704ba839SBarry Smith #define __FUNCT__ "PCFieldSplitSetIS" 1217704ba839SBarry Smith /*@ 1218704ba839SBarry Smith PCFieldSplitSetIS - Sets the exact elements for field 1219704ba839SBarry Smith 1220ad4df100SBarry Smith Logically Collective on PC 1221704ba839SBarry Smith 1222704ba839SBarry Smith Input Parameters: 1223704ba839SBarry Smith + pc - the preconditioner context 1224a04f6461SBarry Smith . splitname - name of this split, if PETSC_NULL the number of the split is used 1225db4c96c1SJed Brown - is - the index set that defines the vector elements in this field 1226704ba839SBarry Smith 1227d32f9abdSBarry Smith 1228a6ffb8dbSJed Brown Notes: 1229a6ffb8dbSJed Brown Use PCFieldSplitSetFields(), for fields defined by strided types. 1230a6ffb8dbSJed Brown 1231db4c96c1SJed Brown This function is called once per split (it creates a new split each time). Solve options 1232db4c96c1SJed Brown for this split will be available under the prefix -fieldsplit_SPLITNAME_. 1233d32f9abdSBarry Smith 1234704ba839SBarry Smith Level: intermediate 1235704ba839SBarry Smith 1236704ba839SBarry Smith .seealso: PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitSetBlockSize() 1237704ba839SBarry Smith 1238704ba839SBarry Smith @*/ 12397087cfbeSBarry Smith PetscErrorCode PCFieldSplitSetIS(PC pc,const char splitname[],IS is) 1240704ba839SBarry Smith { 12414ac538c5SBarry Smith PetscErrorCode ierr; 1242704ba839SBarry Smith 1243704ba839SBarry Smith PetscFunctionBegin; 12440700a824SBarry Smith PetscValidHeaderSpecific(pc,PC_CLASSID,1); 12457b62db95SJungho Lee if (splitname) PetscValidCharPointer(splitname,2); 1246db4c96c1SJed Brown PetscValidHeaderSpecific(is,IS_CLASSID,3); 12474ac538c5SBarry Smith ierr = PetscTryMethod(pc,"PCFieldSplitSetIS_C",(PC,const char[],IS),(pc,splitname,is));CHKERRQ(ierr); 1248704ba839SBarry Smith PetscFunctionReturn(0); 1249704ba839SBarry Smith } 1250704ba839SBarry Smith 1251704ba839SBarry Smith #undef __FUNCT__ 125257a9adfeSMatthew G Knepley #define __FUNCT__ "PCFieldSplitGetIS" 125357a9adfeSMatthew G Knepley /*@ 125457a9adfeSMatthew G Knepley PCFieldSplitGetIS - Retrieves the elements for a field as an IS 125557a9adfeSMatthew G Knepley 125657a9adfeSMatthew G Knepley Logically Collective on PC 125757a9adfeSMatthew G Knepley 125857a9adfeSMatthew G Knepley Input Parameters: 125957a9adfeSMatthew G Knepley + pc - the preconditioner context 126057a9adfeSMatthew G Knepley - splitname - name of this split 126157a9adfeSMatthew G Knepley 126257a9adfeSMatthew G Knepley Output Parameter: 126357a9adfeSMatthew G Knepley - is - the index set that defines the vector elements in this field, or PETSC_NULL if the field is not found 126457a9adfeSMatthew G Knepley 126557a9adfeSMatthew G Knepley Level: intermediate 126657a9adfeSMatthew G Knepley 126757a9adfeSMatthew G Knepley .seealso: PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitSetIS() 126857a9adfeSMatthew G Knepley 126957a9adfeSMatthew G Knepley @*/ 127057a9adfeSMatthew G Knepley PetscErrorCode PCFieldSplitGetIS(PC pc,const char splitname[],IS *is) 127157a9adfeSMatthew G Knepley { 127257a9adfeSMatthew G Knepley PetscErrorCode ierr; 127357a9adfeSMatthew G Knepley 127457a9adfeSMatthew G Knepley PetscFunctionBegin; 127557a9adfeSMatthew G Knepley PetscValidHeaderSpecific(pc,PC_CLASSID,1); 127657a9adfeSMatthew G Knepley PetscValidCharPointer(splitname,2); 127757a9adfeSMatthew G Knepley PetscValidPointer(is,3); 127857a9adfeSMatthew G Knepley { 127957a9adfeSMatthew G Knepley PC_FieldSplit *jac = (PC_FieldSplit *) pc->data; 128057a9adfeSMatthew G Knepley PC_FieldSplitLink ilink = jac->head; 128157a9adfeSMatthew G Knepley PetscBool found; 128257a9adfeSMatthew G Knepley 128357a9adfeSMatthew G Knepley *is = PETSC_NULL; 128457a9adfeSMatthew G Knepley while(ilink) { 128557a9adfeSMatthew G Knepley ierr = PetscStrcmp(ilink->splitname, splitname, &found);CHKERRQ(ierr); 128657a9adfeSMatthew G Knepley if (found) { 128757a9adfeSMatthew G Knepley *is = ilink->is; 128857a9adfeSMatthew G Knepley break; 128957a9adfeSMatthew G Knepley } 129057a9adfeSMatthew G Knepley ilink = ilink->next; 129157a9adfeSMatthew G Knepley } 129257a9adfeSMatthew G Knepley } 129357a9adfeSMatthew G Knepley PetscFunctionReturn(0); 129457a9adfeSMatthew G Knepley } 129557a9adfeSMatthew G Knepley 129657a9adfeSMatthew G Knepley #undef __FUNCT__ 129751f519a2SBarry Smith #define __FUNCT__ "PCFieldSplitSetBlockSize" 129851f519a2SBarry Smith /*@ 129951f519a2SBarry Smith PCFieldSplitSetBlockSize - Sets the block size for defining where fields start in the 130051f519a2SBarry Smith fieldsplit preconditioner. If not set the matrix block size is used. 130151f519a2SBarry Smith 1302ad4df100SBarry Smith Logically Collective on PC 130351f519a2SBarry Smith 130451f519a2SBarry Smith Input Parameters: 130551f519a2SBarry Smith + pc - the preconditioner context 130651f519a2SBarry Smith - bs - the block size 130751f519a2SBarry Smith 130851f519a2SBarry Smith Level: intermediate 130951f519a2SBarry Smith 131051f519a2SBarry Smith .seealso: PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitSetFields() 131151f519a2SBarry Smith 131251f519a2SBarry Smith @*/ 13137087cfbeSBarry Smith PetscErrorCode PCFieldSplitSetBlockSize(PC pc,PetscInt bs) 131451f519a2SBarry Smith { 13154ac538c5SBarry Smith PetscErrorCode ierr; 131651f519a2SBarry Smith 131751f519a2SBarry Smith PetscFunctionBegin; 13180700a824SBarry Smith PetscValidHeaderSpecific(pc,PC_CLASSID,1); 1319c5eb9154SBarry Smith PetscValidLogicalCollectiveInt(pc,bs,2); 13204ac538c5SBarry Smith ierr = PetscTryMethod(pc,"PCFieldSplitSetBlockSize_C",(PC,PetscInt),(pc,bs));CHKERRQ(ierr); 132151f519a2SBarry Smith PetscFunctionReturn(0); 132251f519a2SBarry Smith } 132351f519a2SBarry Smith 132451f519a2SBarry Smith #undef __FUNCT__ 132569a612a9SBarry Smith #define __FUNCT__ "PCFieldSplitGetSubKSP" 13260971522cSBarry Smith /*@C 132769a612a9SBarry Smith PCFieldSplitGetSubKSP - Gets the KSP contexts for all splits 13280971522cSBarry Smith 132969a612a9SBarry Smith Collective on KSP 13300971522cSBarry Smith 13310971522cSBarry Smith Input Parameter: 13320971522cSBarry Smith . pc - the preconditioner context 13330971522cSBarry Smith 13340971522cSBarry Smith Output Parameters: 133513e0d083SBarry Smith + n - the number of splits 133669a612a9SBarry Smith - pc - the array of KSP contexts 13370971522cSBarry Smith 13380971522cSBarry Smith Note: 1339d32f9abdSBarry Smith After PCFieldSplitGetSubKSP() the array of KSPs IS to be freed by the user 1340d32f9abdSBarry Smith (not the KSP just the array that contains them). 13410971522cSBarry Smith 134269a612a9SBarry Smith You must call KSPSetUp() before calling PCFieldSplitGetSubKSP(). 13430971522cSBarry Smith 13440971522cSBarry Smith Level: advanced 13450971522cSBarry Smith 13460971522cSBarry Smith .seealso: PCFIELDSPLIT 13470971522cSBarry Smith @*/ 13487087cfbeSBarry Smith PetscErrorCode PCFieldSplitGetSubKSP(PC pc,PetscInt *n,KSP *subksp[]) 13490971522cSBarry Smith { 13504ac538c5SBarry Smith PetscErrorCode ierr; 13510971522cSBarry Smith 13520971522cSBarry Smith PetscFunctionBegin; 13530700a824SBarry Smith PetscValidHeaderSpecific(pc,PC_CLASSID,1); 135413e0d083SBarry Smith if (n) PetscValidIntPointer(n,2); 13554ac538c5SBarry Smith ierr = PetscUseMethod(pc,"PCFieldSplitGetSubKSP_C",(PC,PetscInt*,KSP **),(pc,n,subksp));CHKERRQ(ierr); 13560971522cSBarry Smith PetscFunctionReturn(0); 13570971522cSBarry Smith } 13580971522cSBarry Smith 1359e69d4d44SBarry Smith #undef __FUNCT__ 1360e69d4d44SBarry Smith #define __FUNCT__ "PCFieldSplitSchurPrecondition" 1361e69d4d44SBarry Smith /*@ 1362e69d4d44SBarry Smith PCFieldSplitSchurPrecondition - Indicates if the Schur complement is preconditioned by a preconditioner constructed by the 1363a04f6461SBarry Smith A11 matrix. Otherwise no preconditioner is used. 1364e69d4d44SBarry Smith 1365e69d4d44SBarry Smith Collective on PC 1366e69d4d44SBarry Smith 1367e69d4d44SBarry Smith Input Parameters: 1368e69d4d44SBarry Smith + pc - the preconditioner context 1369fd1303e9SJungho Lee . ptype - which matrix to use for preconditioning the Schur complement, PC_FIELDSPLIT_SCHUR_PRE_DIAG (diag) is default 1370084e4875SJed Brown - userpre - matrix to use for preconditioning, or PETSC_NULL 1371084e4875SJed Brown 1372e69d4d44SBarry Smith Options Database: 1373084e4875SJed Brown . -pc_fieldsplit_schur_precondition <self,user,diag> default is diag 1374e69d4d44SBarry Smith 1375fd1303e9SJungho Lee Notes: 1376fd1303e9SJungho Lee $ If ptype is 1377fd1303e9SJungho Lee $ user then the preconditioner for the Schur complement is generated by the provided matrix (pre argument 1378fd1303e9SJungho Lee $ to this function). 1379fd1303e9SJungho Lee $ diag then the preconditioner for the Schur complement is generated by the block diagonal part of the original 1380fd1303e9SJungho Lee $ matrix associated with the Schur complement (i.e. A11) 1381fd1303e9SJungho Lee $ self the preconditioner for the Schur complement is generated from the Schur complement matrix itself: 1382fd1303e9SJungho Lee $ The only preconditioner that currently works directly with the Schur complement matrix object is the PCLSC 1383fd1303e9SJungho Lee $ preconditioner 1384fd1303e9SJungho Lee 1385fd1303e9SJungho Lee When solving a saddle point problem, where the A11 block is identically zero, using diag as the ptype only makes sense 1386fd1303e9SJungho Lee with the additional option -fieldsplit_1_pc_type none. Usually for saddle point problems one would use a ptype of self and 1387fd1303e9SJungho Lee -fieldsplit_1_pc_type lsc which uses the least squares commutator compute a preconditioner for the Schur complement. 1388fd1303e9SJungho Lee 1389fd1303e9SJungho Lee Developer Notes: This is a terrible name, gives no good indication of what the function does and should also have Set in 1390fd1303e9SJungho Lee the name since it sets a proceedure to use. 1391fd1303e9SJungho Lee 1392e69d4d44SBarry Smith Level: intermediate 1393e69d4d44SBarry Smith 1394fd1303e9SJungho Lee .seealso: PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitSetFields(), PCFieldSplitSchurPreType, PCLSC 1395e69d4d44SBarry Smith 1396e69d4d44SBarry Smith @*/ 13977087cfbeSBarry Smith PetscErrorCode PCFieldSplitSchurPrecondition(PC pc,PCFieldSplitSchurPreType ptype,Mat pre) 1398e69d4d44SBarry Smith { 13994ac538c5SBarry Smith PetscErrorCode ierr; 1400e69d4d44SBarry Smith 1401e69d4d44SBarry Smith PetscFunctionBegin; 14020700a824SBarry Smith PetscValidHeaderSpecific(pc,PC_CLASSID,1); 14034ac538c5SBarry Smith ierr = PetscTryMethod(pc,"PCFieldSplitSchurPrecondition_C",(PC,PCFieldSplitSchurPreType,Mat),(pc,ptype,pre));CHKERRQ(ierr); 1404e69d4d44SBarry Smith PetscFunctionReturn(0); 1405e69d4d44SBarry Smith } 1406e69d4d44SBarry Smith 1407e69d4d44SBarry Smith EXTERN_C_BEGIN 1408e69d4d44SBarry Smith #undef __FUNCT__ 1409e69d4d44SBarry Smith #define __FUNCT__ "PCFieldSplitSchurPrecondition_FieldSplit" 14107087cfbeSBarry Smith PetscErrorCode PCFieldSplitSchurPrecondition_FieldSplit(PC pc,PCFieldSplitSchurPreType ptype,Mat pre) 1411e69d4d44SBarry Smith { 1412e69d4d44SBarry Smith PC_FieldSplit *jac = (PC_FieldSplit*)pc->data; 1413084e4875SJed Brown PetscErrorCode ierr; 1414e69d4d44SBarry Smith 1415e69d4d44SBarry Smith PetscFunctionBegin; 1416084e4875SJed Brown jac->schurpre = ptype; 1417084e4875SJed Brown if (pre) { 14186bf464f9SBarry Smith ierr = MatDestroy(&jac->schur_user);CHKERRQ(ierr); 1419084e4875SJed Brown jac->schur_user = pre; 1420084e4875SJed Brown ierr = PetscObjectReference((PetscObject)jac->schur_user);CHKERRQ(ierr); 1421084e4875SJed Brown } 1422e69d4d44SBarry Smith PetscFunctionReturn(0); 1423e69d4d44SBarry Smith } 1424e69d4d44SBarry Smith EXTERN_C_END 1425e69d4d44SBarry Smith 142630ad9308SMatthew Knepley #undef __FUNCT__ 1427c9c6ffaaSJed Brown #define __FUNCT__ "PCFieldSplitSetSchurFactType" 1428ab1df9f5SJed Brown /*@ 1429c9c6ffaaSJed Brown PCFieldSplitSetSchurFactType - sets which blocks of the approximate block factorization to retain 1430ab1df9f5SJed Brown 1431ab1df9f5SJed Brown Collective on PC 1432ab1df9f5SJed Brown 1433ab1df9f5SJed Brown Input Parameters: 1434ab1df9f5SJed Brown + pc - the preconditioner context 1435c9c6ffaaSJed Brown - ftype - which blocks of factorization to retain, PC_FIELDSPLIT_SCHUR_FACT_FULL is default 1436ab1df9f5SJed Brown 1437ab1df9f5SJed Brown Options Database: 1438c9c6ffaaSJed Brown . -pc_fieldsplit_schur_fact_type <diag,lower,upper,full> default is full 1439ab1df9f5SJed Brown 1440ab1df9f5SJed Brown 1441ab1df9f5SJed Brown Level: intermediate 1442ab1df9f5SJed Brown 1443ab1df9f5SJed Brown Notes: 1444ab1df9f5SJed Brown The FULL factorization is 1445ab1df9f5SJed Brown 1446ab1df9f5SJed Brown $ (A B) = (1 0) (A 0) (1 Ainv*B) 1447ab1df9f5SJed Brown $ (C D) (C*Ainv 1) (0 S) (0 1 ) 1448ab1df9f5SJed Brown 14496be4592eSBarry Smith where S = D - C*Ainv*B. In practice, the full factorization is applied via block triangular solves with the grouping L*(D*U). UPPER uses D*U, LOWER uses L*D, 14506be4592eSBarry Smith and DIAG is the diagonal part with the sign of S flipped (because this makes the preconditioner positive definite for many formulations, thus allowing the use of KSPMINRES). 1451ab1df9f5SJed Brown 14526be4592eSBarry Smith If applied exactly, FULL factorization is a direct solver. The preconditioned operator with LOWER or UPPER has all eigenvalues equal to 1 and minimal polynomial 14536be4592eSBarry Smith of degree 2, so KSPGMRES converges in 2 iterations. If the iteration count is very low, consider using KSPFGMRES or KSPGCR which can use one less preconditioner 14546be4592eSBarry 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. With DIAG, 14556be4592eSBarry Smith the preconditioned operator has three distinct nonzero eigenvalues and minimal polynomial of degree at most 4, so KSPGMRES converges in at most 4 iterations. 1456ab1df9f5SJed Brown 14576be4592eSBarry Smith For symmetric problems in which A is positive definite and S is negative definite, DIAG can be used with KSPMINRES. Note that a flexible method like KSPFGMRES 14586be4592eSBarry Smith or KSPGCR must be used if the fieldsplit preconditioner is nonlinear (e.g. a few iterations of a Krylov method is used inside a split). 1459ab1df9f5SJed Brown 1460ab1df9f5SJed Brown References: 1461ab1df9f5SJed Brown Murphy, Golub, and Wathen, A note on preconditioning indefinite linear systems, SIAM J. Sci. Comput., 21 (2000) pp. 1969-1972. 1462ab1df9f5SJed Brown 1463ab1df9f5SJed Brown Ipsen, A note on preconditioning nonsymmetric matrices, SIAM J. Sci. Comput., 23 (2001), pp. 1050-1051. 1464ab1df9f5SJed Brown 1465ab1df9f5SJed Brown .seealso: PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitSetFields(), PCFieldSplitSchurPreType 1466ab1df9f5SJed Brown @*/ 1467c9c6ffaaSJed Brown PetscErrorCode PCFieldSplitSetSchurFactType(PC pc,PCFieldSplitSchurFactType ftype) 1468ab1df9f5SJed Brown { 1469ab1df9f5SJed Brown PetscErrorCode ierr; 1470ab1df9f5SJed Brown 1471ab1df9f5SJed Brown PetscFunctionBegin; 1472ab1df9f5SJed Brown PetscValidHeaderSpecific(pc,PC_CLASSID,1); 1473c9c6ffaaSJed Brown ierr = PetscTryMethod(pc,"PCFieldSplitSetSchurFactType_C",(PC,PCFieldSplitSchurFactType),(pc,ftype));CHKERRQ(ierr); 1474ab1df9f5SJed Brown PetscFunctionReturn(0); 1475ab1df9f5SJed Brown } 1476ab1df9f5SJed Brown 1477ab1df9f5SJed Brown #undef __FUNCT__ 1478c9c6ffaaSJed Brown #define __FUNCT__ "PCFieldSplitSetSchurFactType_FieldSplit" 1479c9c6ffaaSJed Brown PETSC_EXTERN_C PetscErrorCode PCFieldSplitSetSchurFactType_FieldSplit(PC pc,PCFieldSplitSchurFactType ftype) 1480ab1df9f5SJed Brown { 1481ab1df9f5SJed Brown PC_FieldSplit *jac = (PC_FieldSplit*)pc->data; 1482ab1df9f5SJed Brown 1483ab1df9f5SJed Brown PetscFunctionBegin; 1484ab1df9f5SJed Brown jac->schurfactorization = ftype; 1485ab1df9f5SJed Brown PetscFunctionReturn(0); 1486ab1df9f5SJed Brown } 1487ab1df9f5SJed Brown 1488ab1df9f5SJed Brown #undef __FUNCT__ 148930ad9308SMatthew Knepley #define __FUNCT__ "PCFieldSplitGetSchurBlocks" 149030ad9308SMatthew Knepley /*@C 14918c03b21aSDmitry Karpeev PCFieldSplitGetSchurBlocks - Gets all matrix blocks for the Schur complement 149230ad9308SMatthew Knepley 149330ad9308SMatthew Knepley Collective on KSP 149430ad9308SMatthew Knepley 149530ad9308SMatthew Knepley Input Parameter: 149630ad9308SMatthew Knepley . pc - the preconditioner context 149730ad9308SMatthew Knepley 149830ad9308SMatthew Knepley Output Parameters: 1499a04f6461SBarry Smith + A00 - the (0,0) block 1500a04f6461SBarry Smith . A01 - the (0,1) block 1501a04f6461SBarry Smith . A10 - the (1,0) block 1502a04f6461SBarry Smith - A11 - the (1,1) block 150330ad9308SMatthew Knepley 150430ad9308SMatthew Knepley Level: advanced 150530ad9308SMatthew Knepley 150630ad9308SMatthew Knepley .seealso: PCFIELDSPLIT 150730ad9308SMatthew Knepley @*/ 1508a04f6461SBarry Smith PetscErrorCode PCFieldSplitGetSchurBlocks(PC pc,Mat *A00,Mat *A01,Mat *A10, Mat *A11) 150930ad9308SMatthew Knepley { 151030ad9308SMatthew Knepley PC_FieldSplit *jac = (PC_FieldSplit *) pc->data; 151130ad9308SMatthew Knepley 151230ad9308SMatthew Knepley PetscFunctionBegin; 15130700a824SBarry Smith PetscValidHeaderSpecific(pc,PC_CLASSID,1); 1514c1235816SBarry Smith if (jac->type != PC_COMPOSITE_SCHUR) SETERRQ(((PetscObject)pc)->comm,PETSC_ERR_ARG_WRONG, "FieldSplit is not using a Schur complement approach."); 1515a04f6461SBarry Smith if (A00) *A00 = jac->pmat[0]; 1516a04f6461SBarry Smith if (A01) *A01 = jac->B; 1517a04f6461SBarry Smith if (A10) *A10 = jac->C; 1518a04f6461SBarry Smith if (A11) *A11 = jac->pmat[1]; 151930ad9308SMatthew Knepley PetscFunctionReturn(0); 152030ad9308SMatthew Knepley } 152130ad9308SMatthew Knepley 152279416396SBarry Smith EXTERN_C_BEGIN 152379416396SBarry Smith #undef __FUNCT__ 152479416396SBarry Smith #define __FUNCT__ "PCFieldSplitSetType_FieldSplit" 15257087cfbeSBarry Smith PetscErrorCode PCFieldSplitSetType_FieldSplit(PC pc,PCCompositeType type) 152679416396SBarry Smith { 152779416396SBarry Smith PC_FieldSplit *jac = (PC_FieldSplit*)pc->data; 1528e69d4d44SBarry Smith PetscErrorCode ierr; 152979416396SBarry Smith 153079416396SBarry Smith PetscFunctionBegin; 153179416396SBarry Smith jac->type = type; 15323b224e63SBarry Smith if (type == PC_COMPOSITE_SCHUR) { 15333b224e63SBarry Smith pc->ops->apply = PCApply_FieldSplit_Schur; 15343b224e63SBarry Smith pc->ops->view = PCView_FieldSplit_Schur; 1535e69d4d44SBarry Smith ierr = PetscObjectComposeFunctionDynamic((PetscObject)pc,"PCFieldSplitGetSubKSP_C","PCFieldSplitGetSubKSP_FieldSplit_Schur",PCFieldSplitGetSubKSP_FieldSplit_Schur);CHKERRQ(ierr); 1536e69d4d44SBarry Smith ierr = PetscObjectComposeFunctionDynamic((PetscObject)pc,"PCFieldSplitSchurPrecondition_C","PCFieldSplitSchurPrecondition_FieldSplit",PCFieldSplitSchurPrecondition_FieldSplit);CHKERRQ(ierr); 1537c9c6ffaaSJed Brown ierr = PetscObjectComposeFunctionDynamic((PetscObject)pc,"PCFieldSplitSetSchurFactType_C","PCFieldSplitSetSchurFactType_FieldSplit",PCFieldSplitSetSchurFactType_FieldSplit);CHKERRQ(ierr); 1538e69d4d44SBarry Smith 15393b224e63SBarry Smith } else { 15403b224e63SBarry Smith pc->ops->apply = PCApply_FieldSplit; 15413b224e63SBarry Smith pc->ops->view = PCView_FieldSplit; 1542e69d4d44SBarry Smith ierr = PetscObjectComposeFunctionDynamic((PetscObject)pc,"PCFieldSplitGetSubKSP_C","PCFieldSplitGetSubKSP_FieldSplit",PCFieldSplitGetSubKSP_FieldSplit);CHKERRQ(ierr); 15439e7d6b0aSBarry Smith ierr = PetscObjectComposeFunctionDynamic((PetscObject)pc,"PCFieldSplitSchurPrecondition_C","",0);CHKERRQ(ierr); 1544c9c6ffaaSJed Brown ierr = PetscObjectComposeFunctionDynamic((PetscObject)pc,"PCFieldSplitSetSchurFactType_C","",0);CHKERRQ(ierr); 15453b224e63SBarry Smith } 154679416396SBarry Smith PetscFunctionReturn(0); 154779416396SBarry Smith } 154879416396SBarry Smith EXTERN_C_END 154979416396SBarry Smith 155051f519a2SBarry Smith EXTERN_C_BEGIN 155151f519a2SBarry Smith #undef __FUNCT__ 155251f519a2SBarry Smith #define __FUNCT__ "PCFieldSplitSetBlockSize_FieldSplit" 15537087cfbeSBarry Smith PetscErrorCode PCFieldSplitSetBlockSize_FieldSplit(PC pc,PetscInt bs) 155451f519a2SBarry Smith { 155551f519a2SBarry Smith PC_FieldSplit *jac = (PC_FieldSplit*)pc->data; 155651f519a2SBarry Smith 155751f519a2SBarry Smith PetscFunctionBegin; 155865e19b50SBarry Smith if (bs < 1) SETERRQ1(((PetscObject)pc)->comm,PETSC_ERR_ARG_OUTOFRANGE,"Blocksize must be positive, you gave %D",bs); 155965e19b50SBarry Smith if (jac->bs > 0 && jac->bs != bs) SETERRQ2(((PetscObject)pc)->comm,PETSC_ERR_ARG_WRONGSTATE,"Cannot change fieldsplit blocksize from %D to %D after it has been set",jac->bs,bs); 156051f519a2SBarry Smith jac->bs = bs; 156151f519a2SBarry Smith PetscFunctionReturn(0); 156251f519a2SBarry Smith } 156351f519a2SBarry Smith EXTERN_C_END 156451f519a2SBarry Smith 156579416396SBarry Smith #undef __FUNCT__ 156679416396SBarry Smith #define __FUNCT__ "PCFieldSplitSetType" 1567bc08b0f1SBarry Smith /*@ 156879416396SBarry Smith PCFieldSplitSetType - Sets the type of fieldsplit preconditioner. 156979416396SBarry Smith 157079416396SBarry Smith Collective on PC 157179416396SBarry Smith 157279416396SBarry Smith Input Parameter: 157379416396SBarry Smith . pc - the preconditioner context 157481540f2fSBarry Smith . type - PC_COMPOSITE_ADDITIVE, PC_COMPOSITE_MULTIPLICATIVE (default), PC_COMPOSITE_SYMMETRIC_MULTIPLICATIVE, PC_COMPOSITE_SPECIAL, PC_COMPOSITE_SCHUR 157579416396SBarry Smith 157679416396SBarry Smith Options Database Key: 1577a4efd8eaSMatthew Knepley . -pc_fieldsplit_type <type: one of multiplicative, additive, symmetric_multiplicative, special, schur> - Sets fieldsplit preconditioner type 157879416396SBarry Smith 1579b02e2d75SMatthew G Knepley Level: Intermediate 158079416396SBarry Smith 158179416396SBarry Smith .keywords: PC, set, type, composite preconditioner, additive, multiplicative 158279416396SBarry Smith 158379416396SBarry Smith .seealso: PCCompositeSetType() 158479416396SBarry Smith 158579416396SBarry Smith @*/ 15867087cfbeSBarry Smith PetscErrorCode PCFieldSplitSetType(PC pc,PCCompositeType type) 158779416396SBarry Smith { 15884ac538c5SBarry Smith PetscErrorCode ierr; 158979416396SBarry Smith 159079416396SBarry Smith PetscFunctionBegin; 15910700a824SBarry Smith PetscValidHeaderSpecific(pc,PC_CLASSID,1); 15924ac538c5SBarry Smith ierr = PetscTryMethod(pc,"PCFieldSplitSetType_C",(PC,PCCompositeType),(pc,type));CHKERRQ(ierr); 159379416396SBarry Smith PetscFunctionReturn(0); 159479416396SBarry Smith } 159579416396SBarry Smith 1596b02e2d75SMatthew G Knepley #undef __FUNCT__ 1597b02e2d75SMatthew G Knepley #define __FUNCT__ "PCFieldSplitGetType" 1598b02e2d75SMatthew G Knepley /*@ 1599b02e2d75SMatthew G Knepley PCFieldSplitGetType - Gets the type of fieldsplit preconditioner. 1600b02e2d75SMatthew G Knepley 1601b02e2d75SMatthew G Knepley Not collective 1602b02e2d75SMatthew G Knepley 1603b02e2d75SMatthew G Knepley Input Parameter: 1604b02e2d75SMatthew G Knepley . pc - the preconditioner context 1605b02e2d75SMatthew G Knepley 1606b02e2d75SMatthew G Knepley Output Parameter: 1607b02e2d75SMatthew G Knepley . type - PC_COMPOSITE_ADDITIVE, PC_COMPOSITE_MULTIPLICATIVE (default), PC_COMPOSITE_SYMMETRIC_MULTIPLICATIVE, PC_COMPOSITE_SPECIAL, PC_COMPOSITE_SCHUR 1608b02e2d75SMatthew G Knepley 1609b02e2d75SMatthew G Knepley Level: Intermediate 1610b02e2d75SMatthew G Knepley 1611b02e2d75SMatthew G Knepley .keywords: PC, set, type, composite preconditioner, additive, multiplicative 1612b02e2d75SMatthew G Knepley .seealso: PCCompositeSetType() 1613b02e2d75SMatthew G Knepley @*/ 1614b02e2d75SMatthew G Knepley PetscErrorCode PCFieldSplitGetType(PC pc, PCCompositeType *type) 1615b02e2d75SMatthew G Knepley { 1616b02e2d75SMatthew G Knepley PC_FieldSplit *jac = (PC_FieldSplit *) pc->data; 1617b02e2d75SMatthew G Knepley 1618b02e2d75SMatthew G Knepley PetscFunctionBegin; 1619b02e2d75SMatthew G Knepley PetscValidHeaderSpecific(pc,PC_CLASSID,1); 1620b02e2d75SMatthew G Knepley PetscValidIntPointer(type,2); 1621b02e2d75SMatthew G Knepley *type = jac->type; 1622b02e2d75SMatthew G Knepley PetscFunctionReturn(0); 1623b02e2d75SMatthew G Knepley } 1624b02e2d75SMatthew G Knepley 16250971522cSBarry Smith /* -------------------------------------------------------------------------------------*/ 16260971522cSBarry Smith /*MC 1627a8c7a070SBarry Smith PCFIELDSPLIT - Preconditioner created by combining separate preconditioners for individual 1628a04f6461SBarry Smith fields or groups of fields. See the users manual section "Solving Block Matrices" for more details. 16290971522cSBarry Smith 1630edf189efSBarry Smith To set options on the solvers for each block append -fieldsplit_ to all the PC 1631edf189efSBarry Smith options database keys. For example, -fieldsplit_pc_type ilu -fieldsplit_pc_factor_levels 1 16320971522cSBarry Smith 1633a8c7a070SBarry Smith To set the options on the solvers separate for each block call PCFieldSplitGetSubKSP() 163469a612a9SBarry Smith and set the options directly on the resulting KSP object 16350971522cSBarry Smith 16360971522cSBarry Smith Level: intermediate 16370971522cSBarry Smith 163879416396SBarry Smith Options Database Keys: 163981540f2fSBarry Smith + -pc_fieldsplit_%d_fields <a,b,..> - indicates the fields to be used in the %d'th split 164081540f2fSBarry Smith . -pc_fieldsplit_default - automatically add any fields to additional splits that have not 164181540f2fSBarry Smith been supplied explicitly by -pc_fieldsplit_%d_fields 164281540f2fSBarry Smith . -pc_fieldsplit_block_size <bs> - size of block that defines fields (i.e. there are bs fields) 16430f188ba9SJed Brown . -pc_fieldsplit_type <additive,multiplicative,symmetric_multiplicative,schur> - type of relaxation or factorization splitting 16440f188ba9SJed Brown . -pc_fieldsplit_schur_precondition <self,user,diag> - default is diag 1645435f959eSBarry Smith . -pc_fieldsplit_detect_saddle_point - automatically finds rows with zero or negative diagonal and uses Schur complement with no preconditioner as the solver 164679416396SBarry Smith 16475d4c12cdSJungho Lee - Options prefix for inner solvers when using Schur complement preconditioner are -fieldsplit_0_ and -fieldsplit_1_ 16485d4c12cdSJungho Lee for all other solvers they are -fieldsplit_%d_ for the dth field, use -fieldsplit_ for all fields 16495d4c12cdSJungho Lee 1650c8a0d604SMatthew G Knepley Notes: 1651c8a0d604SMatthew G Knepley Use PCFieldSplitSetFields() to set fields defined by "strided" entries and PCFieldSplitSetIS() 1652d32f9abdSBarry Smith to define a field by an arbitrary collection of entries. 1653d32f9abdSBarry Smith 1654d32f9abdSBarry Smith If no fields are set the default is used. The fields are defined by entries strided by bs, 1655d32f9abdSBarry Smith beginning at 0 then 1, etc to bs-1. The block size can be set with PCFieldSplitSetBlockSize(), 1656d32f9abdSBarry Smith if this is not called the block size defaults to the blocksize of the second matrix passed 1657d32f9abdSBarry Smith to KSPSetOperators()/PCSetOperators(). 1658d32f9abdSBarry Smith 1659c8a0d604SMatthew G Knepley $ For the Schur complement preconditioner if J = ( A00 A01 ) 1660c8a0d604SMatthew G Knepley $ ( A10 A11 ) 1661c8a0d604SMatthew G Knepley $ the preconditioner using full factorization is 1662c8a0d604SMatthew G Knepley $ ( I -A10 ksp(A00) ) ( inv(A00) 0 ) ( I 0 ) 1663c8a0d604SMatthew G Knepley $ ( 0 I ) ( 0 ksp(S) ) ( -A10 ksp(A00) I ) 1664a04f6461SBarry Smith where the action of inv(A00) is applied using the KSP solver with prefix -fieldsplit_0_. The action of 1665c8a0d604SMatthew G Knepley ksp(S) is computed using the KSP solver with prefix -fieldsplit_splitname_ (where splitname was given 1666c8a0d604SMatthew G Knepley in providing the SECOND split or 1 if not give). For PCFieldSplitGetKSP() when field number is 0, 1667c8a0d604SMatthew G Knepley it returns the KSP associated with -fieldsplit_0_ while field number 1 gives -fieldsplit_1_ KSP. By default 1668a04f6461SBarry Smith A11 is used to construct a preconditioner for S, use PCFieldSplitSchurPrecondition() to turn on or off this 1669c8a0d604SMatthew G Knepley option. You can use the preconditioner PCLSC to precondition the Schur complement with -fieldsplit_1_pc_type lsc. The 1670c9c6ffaaSJed Brown factorization type is set using -pc_fieldsplit_schur_fact_type <diag, lower, upper, full>. The full is shown above, 16715668aaf4SBarry Smith diag gives 1672c8a0d604SMatthew G Knepley $ ( inv(A00) 0 ) 1673c8a0d604SMatthew G Knepley $ ( 0 -ksp(S) ) 16745668aaf4SBarry Smith note that slightly counter intuitively there is a negative in front of the ksp(S) so that the preconditioner is positive definite. The lower factorization is the inverse of 1675c8a0d604SMatthew G Knepley $ ( A00 0 ) 1676c8a0d604SMatthew G Knepley $ ( A10 S ) 1677c8a0d604SMatthew G Knepley where the inverses of A00 and S are applied using KSPs. The upper factorization is the inverse of 1678c8a0d604SMatthew G Knepley $ ( A00 A01 ) 1679c8a0d604SMatthew G Knepley $ ( 0 S ) 1680c8a0d604SMatthew G Knepley where again the inverses of A00 and S are applied using KSPs. 1681e69d4d44SBarry Smith 1682edf189efSBarry Smith If only one set of indices (one IS) is provided with PCFieldSplitSetIS() then the complement of that IS 1683edf189efSBarry Smith is used automatically for a second block. 1684edf189efSBarry Smith 1685ff218e97SBarry Smith The fieldsplit preconditioner cannot currently be used with the BAIJ or SBAIJ data formats if the blocksize is larger than 1. 1686ff218e97SBarry Smith Generally it should be used with the AIJ format. 1687ff218e97SBarry Smith 1688ff218e97SBarry Smith The forms of these preconditioners are closely related if not identical to forms derived as "Distributive Iterations", see, 1689ff218e97SBarry Smith for example, page 294 in "Principles of Computational Fluid Dynamics" by Pieter Wesseling. Note that one can also use PCFIELDSPLIT 1690ff218e97SBarry Smith inside a smoother resulting in "Distributive Smoothers". 16910716a85fSBarry Smith 1692a541d17aSBarry Smith Concepts: physics based preconditioners, block preconditioners 16930971522cSBarry Smith 16947e8cb189SBarry Smith .seealso: PCCreate(), PCSetType(), PCType (for list of available types), PC, Block_Preconditioners, PCLSC, 1695e69d4d44SBarry Smith PCFieldSplitGetSubKSP(), PCFieldSplitSetFields(), PCFieldSplitSetType(), PCFieldSplitSetIS(), PCFieldSplitSchurPrecondition() 16960971522cSBarry Smith M*/ 16970971522cSBarry Smith 16980971522cSBarry Smith EXTERN_C_BEGIN 16990971522cSBarry Smith #undef __FUNCT__ 17000971522cSBarry Smith #define __FUNCT__ "PCCreate_FieldSplit" 17017087cfbeSBarry Smith PetscErrorCode PCCreate_FieldSplit(PC pc) 17020971522cSBarry Smith { 17030971522cSBarry Smith PetscErrorCode ierr; 17040971522cSBarry Smith PC_FieldSplit *jac; 17050971522cSBarry Smith 17060971522cSBarry Smith PetscFunctionBegin; 170738f2d2fdSLisandro Dalcin ierr = PetscNewLog(pc,PC_FieldSplit,&jac);CHKERRQ(ierr); 17080971522cSBarry Smith jac->bs = -1; 17090971522cSBarry Smith jac->nsplits = 0; 17103e197d65SBarry Smith jac->type = PC_COMPOSITE_MULTIPLICATIVE; 1711e6cab6aaSJed Brown jac->schurpre = PC_FIELDSPLIT_SCHUR_PRE_USER; /* Try user preconditioner first, fall back on diagonal */ 1712c9c6ffaaSJed Brown jac->schurfactorization = PC_FIELDSPLIT_SCHUR_FACT_FULL; 171351f519a2SBarry Smith 17140971522cSBarry Smith pc->data = (void*)jac; 17150971522cSBarry Smith 17160971522cSBarry Smith pc->ops->apply = PCApply_FieldSplit; 1717421e10b8SBarry Smith pc->ops->applytranspose = PCApplyTranspose_FieldSplit; 17180971522cSBarry Smith pc->ops->setup = PCSetUp_FieldSplit; 1719574deadeSBarry Smith pc->ops->reset = PCReset_FieldSplit; 17200971522cSBarry Smith pc->ops->destroy = PCDestroy_FieldSplit; 17210971522cSBarry Smith pc->ops->setfromoptions = PCSetFromOptions_FieldSplit; 17220971522cSBarry Smith pc->ops->view = PCView_FieldSplit; 17230971522cSBarry Smith pc->ops->applyrichardson = 0; 17240971522cSBarry Smith 172569a612a9SBarry Smith ierr = PetscObjectComposeFunctionDynamic((PetscObject)pc,"PCFieldSplitGetSubKSP_C","PCFieldSplitGetSubKSP_FieldSplit", 172669a612a9SBarry Smith PCFieldSplitGetSubKSP_FieldSplit);CHKERRQ(ierr); 17270971522cSBarry Smith ierr = PetscObjectComposeFunctionDynamic((PetscObject)pc,"PCFieldSplitSetFields_C","PCFieldSplitSetFields_FieldSplit", 17280971522cSBarry Smith PCFieldSplitSetFields_FieldSplit);CHKERRQ(ierr); 1729704ba839SBarry Smith ierr = PetscObjectComposeFunctionDynamic((PetscObject)pc,"PCFieldSplitSetIS_C","PCFieldSplitSetIS_FieldSplit", 1730704ba839SBarry Smith PCFieldSplitSetIS_FieldSplit);CHKERRQ(ierr); 173179416396SBarry Smith ierr = PetscObjectComposeFunctionDynamic((PetscObject)pc,"PCFieldSplitSetType_C","PCFieldSplitSetType_FieldSplit", 173279416396SBarry Smith PCFieldSplitSetType_FieldSplit);CHKERRQ(ierr); 173351f519a2SBarry Smith ierr = PetscObjectComposeFunctionDynamic((PetscObject)pc,"PCFieldSplitSetBlockSize_C","PCFieldSplitSetBlockSize_FieldSplit", 173451f519a2SBarry Smith PCFieldSplitSetBlockSize_FieldSplit);CHKERRQ(ierr); 17350971522cSBarry Smith PetscFunctionReturn(0); 17360971522cSBarry Smith } 17370971522cSBarry Smith EXTERN_C_END 17380971522cSBarry Smith 17390971522cSBarry Smith 1740a541d17aSBarry Smith 1741