1dba47a55SKris Buschelman 2b45d2f2cSJed Brown #include <petsc-private/pcimpl.h> /*I "petscpc.h" I*/ 307475bc1SBarry Smith #include <petscdmcomposite.h> 40971522cSBarry Smith 5443836d0SMatthew G Knepley /* 6443836d0SMatthew G Knepley There is a nice discussion of block preconditioners in 7443836d0SMatthew G Knepley 8443836d0SMatthew G Knepley [El08] A taxonomy and comparison of parallel block multi-level preconditioners for the incompressible Navier–Stokes equations 9443836d0SMatthew G Knepley Howard Elman, V.E. Howle, John Shadid, Robert Shuttleworth, Ray Tuminaro, Journal of Computational Physics 227 (2008) 1790--1808 101b8e4c5fSJed Brown http://chess.cs.umd.edu/~elman/papers/tax.pdf 11443836d0SMatthew G Knepley */ 12443836d0SMatthew G Knepley 13e87fab1bSBarry Smith const char *const PCFieldSplitSchurPreTypes[] = {"SELF","A11","USER","PCFieldSplitSchurPreType","PC_FIELDSPLIT_SCHUR_PRE_",0}; 14c9c6ffaaSJed Brown const char *const PCFieldSplitSchurFactTypes[] = {"DIAG","LOWER","UPPER","FULL","PCFieldSplitSchurFactType","PC_FIELDSPLIT_SCHUR_FACT_",0}; 15c5d2311dSJed Brown 160971522cSBarry Smith typedef struct _PC_FieldSplitLink *PC_FieldSplitLink; 170971522cSBarry Smith struct _PC_FieldSplitLink { 1869a612a9SBarry Smith KSP ksp; 19443836d0SMatthew G Knepley Vec x,y,z; 20db4c96c1SJed Brown char *splitname; 210971522cSBarry Smith PetscInt nfields; 225d4c12cdSJungho Lee PetscInt *fields,*fields_col; 231b9fc7fcSBarry Smith VecScatter sctx; 245d4c12cdSJungho Lee IS is,is_col; 2551f519a2SBarry Smith PC_FieldSplitLink next,previous; 260971522cSBarry Smith }; 270971522cSBarry Smith 280971522cSBarry Smith typedef struct { 2968dd23aaSBarry Smith PCCompositeType type; 30ace3abfcSBarry Smith PetscBool defaultsplit; /* Flag for a system with a set of 'k' scalar fields with the same layout (and bs = k) */ 31ace3abfcSBarry Smith PetscBool splitdefined; /* Flag is set after the splits have been defined, to prevent more splits from being added */ 32ace3abfcSBarry Smith PetscBool realdiagonal; /* Flag to use the diagonal blocks of mat preconditioned by pmat, instead of just pmat */ 3330ad9308SMatthew Knepley PetscInt bs; /* Block size for IS and Mat structures */ 3430ad9308SMatthew Knepley PetscInt nsplits; /* Number of field divisions defined */ 3579416396SBarry Smith Vec *x,*y,w1,w2; 36519d70e2SJed Brown Mat *mat; /* The diagonal block for each split */ 37519d70e2SJed Brown Mat *pmat; /* The preconditioning diagonal block for each split */ 3830ad9308SMatthew Knepley Mat *Afield; /* The rows of the matrix associated with each split */ 39ace3abfcSBarry Smith PetscBool issetup; 402fa5cd67SKarl Rupp 4130ad9308SMatthew Knepley /* Only used when Schur complement preconditioning is used */ 4230ad9308SMatthew Knepley Mat B; /* The (0,1) block */ 4330ad9308SMatthew Knepley Mat C; /* The (1,0) block */ 44443836d0SMatthew G Knepley Mat schur; /* The Schur complement S = A11 - A10 A00^{-1} A01, the KSP here, kspinner, is H_1 in [El08] */ 45084e4875SJed Brown Mat schur_user; /* User-provided preconditioning matrix for the Schur complement */ 46084e4875SJed Brown PCFieldSplitSchurPreType schurpre; /* Determines which preconditioning matrix is used for the Schur complement */ 47c9c6ffaaSJed Brown PCFieldSplitSchurFactType schurfactorization; 4830ad9308SMatthew Knepley KSP kspschur; /* The solver for S */ 49443836d0SMatthew G Knepley KSP kspupper; /* The solver for A in the upper diagonal part of the factorization (H_2 in [El08]) */ 5097bbdb24SBarry Smith PC_FieldSplitLink head; 5163ec74ffSBarry Smith PetscBool reset; /* indicates PCReset() has been last called on this object, hack */ 52c1570756SJed Brown PetscBool suboptionsset; /* Indicates that the KSPSetFromOptions() has been called on the sub-KSPs */ 53*4ab8060aSDmitry Karpeev PetscBool dm_splits; /* Whether to use DMCreateFieldDecomposition() whenever possible */ 540971522cSBarry Smith } PC_FieldSplit; 550971522cSBarry Smith 5616913363SBarry Smith /* 5716913363SBarry Smith Notes: there is no particular reason that pmat, x, and y are stored as arrays in PC_FieldSplit instead of 5816913363SBarry Smith inside PC_FieldSplitLink, just historical. If you want to be able to add new fields after already using the 5916913363SBarry Smith PC you could change this. 6016913363SBarry Smith */ 61084e4875SJed Brown 62e6cab6aaSJed Brown /* This helper is so that setting a user-provided preconditioning matrix is orthogonal to choosing to use it. This way the 63084e4875SJed Brown * application-provided FormJacobian can provide this matrix without interfering with the user's (command-line) choices. */ 64084e4875SJed Brown static Mat FieldSplitSchurPre(PC_FieldSplit *jac) 65084e4875SJed Brown { 66084e4875SJed Brown switch (jac->schurpre) { 67084e4875SJed Brown case PC_FIELDSPLIT_SCHUR_PRE_SELF: return jac->schur; 68e87fab1bSBarry Smith case PC_FIELDSPLIT_SCHUR_PRE_A11: return jac->pmat[1]; 69084e4875SJed Brown case PC_FIELDSPLIT_SCHUR_PRE_USER: /* Use a user-provided matrix if it is given, otherwise diagonal block */ 70084e4875SJed Brown default: 71084e4875SJed Brown return jac->schur_user ? jac->schur_user : jac->pmat[1]; 72084e4875SJed Brown } 73084e4875SJed Brown } 74084e4875SJed Brown 75084e4875SJed Brown 760971522cSBarry Smith #undef __FUNCT__ 770971522cSBarry Smith #define __FUNCT__ "PCView_FieldSplit" 780971522cSBarry Smith static PetscErrorCode PCView_FieldSplit(PC pc,PetscViewer viewer) 790971522cSBarry Smith { 800971522cSBarry Smith PC_FieldSplit *jac = (PC_FieldSplit*)pc->data; 810971522cSBarry Smith PetscErrorCode ierr; 82d9884438SBarry Smith PetscBool iascii,isdraw; 830971522cSBarry Smith PetscInt i,j; 845a9f2f41SSatish Balay PC_FieldSplitLink ilink = jac->head; 850971522cSBarry Smith 860971522cSBarry Smith PetscFunctionBegin; 87251f4c67SDmitry Karpeev ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&iascii);CHKERRQ(ierr); 88d9884438SBarry Smith ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERDRAW,&isdraw);CHKERRQ(ierr); 890971522cSBarry Smith if (iascii) { 902c9966d7SBarry Smith if (jac->bs > 0) { 9151f519a2SBarry Smith ierr = PetscViewerASCIIPrintf(viewer," FieldSplit with %s composition: total splits = %D, blocksize = %D\n",PCCompositeTypes[jac->type],jac->nsplits,jac->bs);CHKERRQ(ierr); 922c9966d7SBarry Smith } else { 932c9966d7SBarry Smith ierr = PetscViewerASCIIPrintf(viewer," FieldSplit with %s composition: total splits = %D\n",PCCompositeTypes[jac->type],jac->nsplits);CHKERRQ(ierr); 942c9966d7SBarry Smith } 95a3df900dSMatthew G Knepley if (jac->realdiagonal) { 96a3df900dSMatthew G Knepley ierr = PetscViewerASCIIPrintf(viewer," using actual matrix for blocks rather than preconditioner matrix\n");CHKERRQ(ierr); 97a3df900dSMatthew G Knepley } 9869a612a9SBarry Smith ierr = PetscViewerASCIIPrintf(viewer," Solver info for each split is in the following KSP objects:\n");CHKERRQ(ierr); 990971522cSBarry Smith ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr); 1000971522cSBarry Smith for (i=0; i<jac->nsplits; i++) { 1011ab39975SBarry Smith if (ilink->fields) { 1020971522cSBarry Smith ierr = PetscViewerASCIIPrintf(viewer,"Split number %D Fields ",i);CHKERRQ(ierr); 10379416396SBarry Smith ierr = PetscViewerASCIIUseTabs(viewer,PETSC_FALSE);CHKERRQ(ierr); 1045a9f2f41SSatish Balay for (j=0; j<ilink->nfields; j++) { 10579416396SBarry Smith if (j > 0) { 10679416396SBarry Smith ierr = PetscViewerASCIIPrintf(viewer,",");CHKERRQ(ierr); 10779416396SBarry Smith } 1085a9f2f41SSatish Balay ierr = PetscViewerASCIIPrintf(viewer," %D",ilink->fields[j]);CHKERRQ(ierr); 1090971522cSBarry Smith } 1100971522cSBarry Smith ierr = PetscViewerASCIIPrintf(viewer,"\n");CHKERRQ(ierr); 11179416396SBarry Smith ierr = PetscViewerASCIIUseTabs(viewer,PETSC_TRUE);CHKERRQ(ierr); 1121ab39975SBarry Smith } else { 1131ab39975SBarry Smith ierr = PetscViewerASCIIPrintf(viewer,"Split number %D Defined by IS\n",i);CHKERRQ(ierr); 1141ab39975SBarry Smith } 1155a9f2f41SSatish Balay ierr = KSPView(ilink->ksp,viewer);CHKERRQ(ierr); 1165a9f2f41SSatish Balay ilink = ilink->next; 1170971522cSBarry Smith } 1180971522cSBarry Smith ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr); 1192fa5cd67SKarl Rupp } 1202fa5cd67SKarl Rupp 1212fa5cd67SKarl Rupp if (isdraw) { 122d9884438SBarry Smith PetscDraw draw; 123d9884438SBarry Smith PetscReal x,y,w,wd; 124d9884438SBarry Smith 125d9884438SBarry Smith ierr = PetscViewerDrawGetDraw(viewer,0,&draw);CHKERRQ(ierr); 126d9884438SBarry Smith ierr = PetscDrawGetCurrentPoint(draw,&x,&y);CHKERRQ(ierr); 127d9884438SBarry Smith w = 2*PetscMin(1.0 - x,x); 128d9884438SBarry Smith wd = w/(jac->nsplits + 1); 129d9884438SBarry Smith x = x - wd*(jac->nsplits-1)/2.0; 130d9884438SBarry Smith for (i=0; i<jac->nsplits; i++) { 131d9884438SBarry Smith ierr = PetscDrawPushCurrentPoint(draw,x,y);CHKERRQ(ierr); 132d9884438SBarry Smith ierr = KSPView(ilink->ksp,viewer);CHKERRQ(ierr); 133d9884438SBarry Smith ierr = PetscDrawPopCurrentPoint(draw);CHKERRQ(ierr); 134d9884438SBarry Smith x += wd; 135d9884438SBarry Smith ilink = ilink->next; 136d9884438SBarry Smith } 1370971522cSBarry Smith } 1380971522cSBarry Smith PetscFunctionReturn(0); 1390971522cSBarry Smith } 1400971522cSBarry Smith 1410971522cSBarry Smith #undef __FUNCT__ 1423b224e63SBarry Smith #define __FUNCT__ "PCView_FieldSplit_Schur" 1433b224e63SBarry Smith static PetscErrorCode PCView_FieldSplit_Schur(PC pc,PetscViewer viewer) 1443b224e63SBarry Smith { 1453b224e63SBarry Smith PC_FieldSplit *jac = (PC_FieldSplit*)pc->data; 1463b224e63SBarry Smith PetscErrorCode ierr; 1474996c5bdSBarry Smith PetscBool iascii,isdraw; 1483b224e63SBarry Smith PetscInt i,j; 1493b224e63SBarry Smith PC_FieldSplitLink ilink = jac->head; 1503b224e63SBarry Smith 1513b224e63SBarry Smith PetscFunctionBegin; 152251f4c67SDmitry Karpeev ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&iascii);CHKERRQ(ierr); 1534996c5bdSBarry Smith ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERDRAW,&isdraw);CHKERRQ(ierr); 1543b224e63SBarry Smith if (iascii) { 1552c9966d7SBarry Smith if (jac->bs > 0) { 156c9c6ffaaSJed Brown ierr = PetscViewerASCIIPrintf(viewer," FieldSplit with Schur preconditioner, blocksize = %D, factorization %s\n",jac->bs,PCFieldSplitSchurFactTypes[jac->schurfactorization]);CHKERRQ(ierr); 1572c9966d7SBarry Smith } else { 1582c9966d7SBarry Smith ierr = PetscViewerASCIIPrintf(viewer," FieldSplit with Schur preconditioner, factorization %s\n",PCFieldSplitSchurFactTypes[jac->schurfactorization]);CHKERRQ(ierr); 1592c9966d7SBarry Smith } 160a3df900dSMatthew G Knepley if (jac->realdiagonal) { 161a3df900dSMatthew G Knepley ierr = PetscViewerASCIIPrintf(viewer," using actual matrix for blocks rather than preconditioner matrix\n");CHKERRQ(ierr); 162a3df900dSMatthew G Knepley } 1633e8b8b31SMatthew G Knepley switch (jac->schurpre) { 1643e8b8b31SMatthew G Knepley case PC_FIELDSPLIT_SCHUR_PRE_SELF: 1653e8b8b31SMatthew G Knepley ierr = PetscViewerASCIIPrintf(viewer," Preconditioner for the Schur complement formed from S itself\n");CHKERRQ(ierr);break; 166e87fab1bSBarry Smith case PC_FIELDSPLIT_SCHUR_PRE_A11: 167e87fab1bSBarry Smith ierr = PetscViewerASCIIPrintf(viewer," Preconditioner for the Schur complement formed from A11\n");CHKERRQ(ierr);break; 1683e8b8b31SMatthew G Knepley case PC_FIELDSPLIT_SCHUR_PRE_USER: 1693e8b8b31SMatthew G Knepley if (jac->schur_user) { 1703e8b8b31SMatthew G Knepley ierr = PetscViewerASCIIPrintf(viewer," Preconditioner for the Schur complement formed from user provided matrix\n");CHKERRQ(ierr); 1713e8b8b31SMatthew G Knepley } else { 172e87fab1bSBarry Smith ierr = PetscViewerASCIIPrintf(viewer," Preconditioner for the Schur complement formed from A11\n");CHKERRQ(ierr); 1733e8b8b31SMatthew G Knepley } 1743e8b8b31SMatthew G Knepley break; 1753e8b8b31SMatthew G Knepley default: 1763e8b8b31SMatthew G Knepley SETERRQ1(((PetscObject) pc)->comm, PETSC_ERR_ARG_OUTOFRANGE, "Invalid Schur preconditioning type: %d", jac->schurpre); 1773e8b8b31SMatthew G Knepley } 1783b224e63SBarry Smith ierr = PetscViewerASCIIPrintf(viewer," Split info:\n");CHKERRQ(ierr); 1793b224e63SBarry Smith ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr); 1803b224e63SBarry Smith for (i=0; i<jac->nsplits; i++) { 1813b224e63SBarry Smith if (ilink->fields) { 1823b224e63SBarry Smith ierr = PetscViewerASCIIPrintf(viewer,"Split number %D Fields ",i);CHKERRQ(ierr); 1833b224e63SBarry Smith ierr = PetscViewerASCIIUseTabs(viewer,PETSC_FALSE);CHKERRQ(ierr); 1843b224e63SBarry Smith for (j=0; j<ilink->nfields; j++) { 1853b224e63SBarry Smith if (j > 0) { 1863b224e63SBarry Smith ierr = PetscViewerASCIIPrintf(viewer,",");CHKERRQ(ierr); 1873b224e63SBarry Smith } 1883b224e63SBarry Smith ierr = PetscViewerASCIIPrintf(viewer," %D",ilink->fields[j]);CHKERRQ(ierr); 1893b224e63SBarry Smith } 1903b224e63SBarry Smith ierr = PetscViewerASCIIPrintf(viewer,"\n");CHKERRQ(ierr); 1913b224e63SBarry Smith ierr = PetscViewerASCIIUseTabs(viewer,PETSC_TRUE);CHKERRQ(ierr); 1923b224e63SBarry Smith } else { 1933b224e63SBarry Smith ierr = PetscViewerASCIIPrintf(viewer,"Split number %D Defined by IS\n",i);CHKERRQ(ierr); 1943b224e63SBarry Smith } 1953b224e63SBarry Smith ilink = ilink->next; 1963b224e63SBarry Smith } 197435f959eSBarry Smith ierr = PetscViewerASCIIPrintf(viewer,"KSP solver for A00 block \n");CHKERRQ(ierr); 1983b224e63SBarry Smith ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr); 199443836d0SMatthew G Knepley ierr = KSPView(jac->head->ksp,viewer);CHKERRQ(ierr); 2003b224e63SBarry Smith ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr); 201443836d0SMatthew G Knepley if (jac->kspupper != jac->head->ksp) { 202443836d0SMatthew G Knepley ierr = PetscViewerASCIIPrintf(viewer,"KSP solver for upper A00 in upper triangular factor \n");CHKERRQ(ierr); 203443836d0SMatthew G Knepley ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr); 204443836d0SMatthew G Knepley ierr = KSPView(jac->kspupper,viewer);CHKERRQ(ierr); 205443836d0SMatthew G Knepley ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr); 206443836d0SMatthew G Knepley } 207435f959eSBarry Smith ierr = PetscViewerASCIIPrintf(viewer,"KSP solver for S = A11 - A10 inv(A00) A01 \n");CHKERRQ(ierr); 2083b224e63SBarry Smith ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr); 20912cae6f2SJed Brown if (jac->kspschur) { 2103b224e63SBarry Smith ierr = KSPView(jac->kspschur,viewer);CHKERRQ(ierr); 21112cae6f2SJed Brown } else { 21212cae6f2SJed Brown ierr = PetscViewerASCIIPrintf(viewer," not yet available\n");CHKERRQ(ierr); 21312cae6f2SJed Brown } 2143b224e63SBarry Smith ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr); 2153b224e63SBarry Smith ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr); 2164996c5bdSBarry Smith } else if (isdraw) { 2174996c5bdSBarry Smith PetscDraw draw; 2184996c5bdSBarry Smith PetscReal x,y,w,wd,h; 2194996c5bdSBarry Smith PetscInt cnt = 2; 2204996c5bdSBarry Smith char str[32]; 2214996c5bdSBarry Smith 2224996c5bdSBarry Smith ierr = PetscViewerDrawGetDraw(viewer,0,&draw);CHKERRQ(ierr); 2234996c5bdSBarry Smith ierr = PetscDrawGetCurrentPoint(draw,&x,&y);CHKERRQ(ierr); 224c74581afSBarry Smith if (jac->kspupper != jac->head->ksp) cnt++; 225c74581afSBarry Smith w = 2*PetscMin(1.0 - x,x); 226c74581afSBarry Smith wd = w/(cnt + 1); 227c74581afSBarry Smith 2284996c5bdSBarry Smith ierr = PetscSNPrintf(str,32,"Schur fact. %s",PCFieldSplitSchurFactTypes[jac->schurfactorization]);CHKERRQ(ierr); 2290298fd71SBarry Smith ierr = PetscDrawBoxedString(draw,x,y,PETSC_DRAW_RED,PETSC_DRAW_BLACK,str,NULL,&h);CHKERRQ(ierr); 2304996c5bdSBarry Smith y -= h; 2314996c5bdSBarry Smith if (jac->schurpre == PC_FIELDSPLIT_SCHUR_PRE_USER && !jac->schur_user) { 232e87fab1bSBarry Smith ierr = PetscSNPrintf(str,32,"Prec. for Schur from %s",PCFieldSplitSchurPreTypes[PC_FIELDSPLIT_SCHUR_PRE_A11]);CHKERRQ(ierr); 2333b224e63SBarry Smith } else { 2344996c5bdSBarry Smith ierr = PetscSNPrintf(str,32,"Prec. for Schur from %s",PCFieldSplitSchurPreTypes[jac->schurpre]);CHKERRQ(ierr); 2354996c5bdSBarry Smith } 2360298fd71SBarry Smith ierr = PetscDrawBoxedString(draw,x+wd*(cnt-1)/2.0,y,PETSC_DRAW_RED,PETSC_DRAW_BLACK,str,NULL,&h);CHKERRQ(ierr); 2374996c5bdSBarry Smith y -= h; 2384996c5bdSBarry Smith x = x - wd*(cnt-1)/2.0; 2394996c5bdSBarry Smith 2404996c5bdSBarry Smith ierr = PetscDrawPushCurrentPoint(draw,x,y);CHKERRQ(ierr); 2414996c5bdSBarry Smith ierr = KSPView(jac->head->ksp,viewer);CHKERRQ(ierr); 2424996c5bdSBarry Smith ierr = PetscDrawPopCurrentPoint(draw);CHKERRQ(ierr); 2434996c5bdSBarry Smith if (jac->kspupper != jac->head->ksp) { 2444996c5bdSBarry Smith x += wd; 2454996c5bdSBarry Smith ierr = PetscDrawPushCurrentPoint(draw,x,y);CHKERRQ(ierr); 2464996c5bdSBarry Smith ierr = KSPView(jac->kspupper,viewer);CHKERRQ(ierr); 2474996c5bdSBarry Smith ierr = PetscDrawPopCurrentPoint(draw);CHKERRQ(ierr); 2484996c5bdSBarry Smith } 2494996c5bdSBarry Smith x += wd; 2504996c5bdSBarry Smith ierr = PetscDrawPushCurrentPoint(draw,x,y);CHKERRQ(ierr); 2514996c5bdSBarry Smith ierr = KSPView(jac->kspschur,viewer);CHKERRQ(ierr); 2524996c5bdSBarry Smith ierr = PetscDrawPopCurrentPoint(draw);CHKERRQ(ierr); 2533b224e63SBarry Smith } 2543b224e63SBarry Smith PetscFunctionReturn(0); 2553b224e63SBarry Smith } 2563b224e63SBarry Smith 2573b224e63SBarry Smith #undef __FUNCT__ 2586c924f48SJed Brown #define __FUNCT__ "PCFieldSplitSetRuntimeSplits_Private" 2596c924f48SJed Brown /* Precondition: jac->bs is set to a meaningful value */ 2606c924f48SJed Brown static PetscErrorCode PCFieldSplitSetRuntimeSplits_Private(PC pc) 2616c924f48SJed Brown { 2626c924f48SJed Brown PetscErrorCode ierr; 2636c924f48SJed Brown PC_FieldSplit *jac = (PC_FieldSplit*)pc->data; 2645d4c12cdSJungho Lee PetscInt i,nfields,*ifields,nfields_col,*ifields_col; 2655d4c12cdSJungho Lee PetscBool flg,flg_col; 2665d4c12cdSJungho Lee char optionname[128],splitname[8],optionname_col[128]; 2676c924f48SJed Brown 2686c924f48SJed Brown PetscFunctionBegin; 2696c924f48SJed Brown ierr = PetscMalloc(jac->bs*sizeof(PetscInt),&ifields);CHKERRQ(ierr); 2705d4c12cdSJungho Lee ierr = PetscMalloc(jac->bs*sizeof(PetscInt),&ifields_col);CHKERRQ(ierr); 2716c924f48SJed Brown for (i=0,flg=PETSC_TRUE;; i++) { 2728caf3d72SBarry Smith ierr = PetscSNPrintf(splitname,sizeof(splitname),"%D",i);CHKERRQ(ierr); 2738caf3d72SBarry Smith ierr = PetscSNPrintf(optionname,sizeof(optionname),"-pc_fieldsplit_%D_fields",i);CHKERRQ(ierr); 2748caf3d72SBarry Smith ierr = PetscSNPrintf(optionname_col,sizeof(optionname_col),"-pc_fieldsplit_%D_fields_col",i);CHKERRQ(ierr); 2756c924f48SJed Brown nfields = jac->bs; 27629499fbbSJungho Lee nfields_col = jac->bs; 2776c924f48SJed Brown ierr = PetscOptionsGetIntArray(((PetscObject)pc)->prefix,optionname,ifields,&nfields,&flg);CHKERRQ(ierr); 2785d4c12cdSJungho Lee ierr = PetscOptionsGetIntArray(((PetscObject)pc)->prefix,optionname_col,ifields_col,&nfields_col,&flg_col);CHKERRQ(ierr); 2796c924f48SJed Brown if (!flg) break; 2805d4c12cdSJungho Lee else if (flg && !flg_col) { 2815d4c12cdSJungho Lee if (!nfields) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_USER,"Cannot list zero fields"); 2825d4c12cdSJungho Lee ierr = PCFieldSplitSetFields(pc,splitname,nfields,ifields,ifields);CHKERRQ(ierr); 2832fa5cd67SKarl Rupp } else { 2845d4c12cdSJungho Lee if (!nfields || !nfields_col) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_USER,"Cannot list zero fields"); 2855d4c12cdSJungho Lee if (nfields != nfields_col) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_USER,"Number of row and column fields must match"); 2865d4c12cdSJungho Lee ierr = PCFieldSplitSetFields(pc,splitname,nfields,ifields,ifields_col);CHKERRQ(ierr); 2875d4c12cdSJungho Lee } 2886c924f48SJed Brown } 2896c924f48SJed Brown if (i > 0) { 2906c924f48SJed Brown /* Makes command-line setting of splits take precedence over setting them in code. 2916c924f48SJed Brown Otherwise subsequent calls to PCFieldSplitSetIS() or PCFieldSplitSetFields() would 2926c924f48SJed Brown create new splits, which would probably not be what the user wanted. */ 2936c924f48SJed Brown jac->splitdefined = PETSC_TRUE; 2946c924f48SJed Brown } 2956c924f48SJed Brown ierr = PetscFree(ifields);CHKERRQ(ierr); 2965d4c12cdSJungho Lee ierr = PetscFree(ifields_col);CHKERRQ(ierr); 2976c924f48SJed Brown PetscFunctionReturn(0); 2986c924f48SJed Brown } 2996c924f48SJed Brown 3006c924f48SJed Brown #undef __FUNCT__ 30169a612a9SBarry Smith #define __FUNCT__ "PCFieldSplitSetDefaults" 30269a612a9SBarry Smith static PetscErrorCode PCFieldSplitSetDefaults(PC pc) 3030971522cSBarry Smith { 3040971522cSBarry Smith PC_FieldSplit *jac = (PC_FieldSplit*)pc->data; 3050971522cSBarry Smith PetscErrorCode ierr; 3065a9f2f41SSatish Balay PC_FieldSplitLink ilink = jac->head; 3077287d2a3SDmitry Karpeev PetscBool fieldsplit_default = PETSC_FALSE,stokes = PETSC_FALSE; 3086c924f48SJed Brown PetscInt i; 3090971522cSBarry Smith 3100971522cSBarry Smith PetscFunctionBegin; 3117287d2a3SDmitry Karpeev /* 3127287d2a3SDmitry Karpeev Kinda messy, but at least this now uses DMCreateFieldDecomposition() even with jac->reset. 3137287d2a3SDmitry Karpeev Should probably be rewritten. 3147287d2a3SDmitry Karpeev */ 3157287d2a3SDmitry Karpeev if (!ilink || jac->reset) { 3160298fd71SBarry Smith ierr = PetscOptionsGetBool(((PetscObject)pc)->prefix,"-pc_fieldsplit_detect_saddle_point",&stokes,NULL);CHKERRQ(ierr); 317*4ab8060aSDmitry Karpeev if (pc->dm && jac->dm_splits && !stokes) { 318bafc1b83SMatthew G Knepley PetscInt numFields, f, i, j; 3190784a22cSJed Brown char **fieldNames; 3207b62db95SJungho Lee IS *fields; 321e7c4fc90SDmitry Karpeev DM *dms; 322bafc1b83SMatthew G Knepley DM subdm[128]; 323bafc1b83SMatthew G Knepley PetscBool flg; 324bafc1b83SMatthew G Knepley 32516621825SDmitry Karpeev ierr = DMCreateFieldDecomposition(pc->dm, &numFields, &fieldNames, &fields, &dms);CHKERRQ(ierr); 326bafc1b83SMatthew G Knepley /* Allow the user to prescribe the splits */ 327bafc1b83SMatthew G Knepley for (i = 0, flg = PETSC_TRUE;; i++) { 328bafc1b83SMatthew G Knepley PetscInt ifields[128]; 329bafc1b83SMatthew G Knepley IS compField; 330bafc1b83SMatthew G Knepley char optionname[128], splitname[8]; 331bafc1b83SMatthew G Knepley PetscInt nfields = numFields; 332bafc1b83SMatthew G Knepley 3338caf3d72SBarry Smith ierr = PetscSNPrintf(optionname, sizeof(optionname), "-pc_fieldsplit_%D_fields", i);CHKERRQ(ierr); 334bafc1b83SMatthew G Knepley ierr = PetscOptionsGetIntArray(((PetscObject) pc)->prefix, optionname, ifields, &nfields, &flg);CHKERRQ(ierr); 335bafc1b83SMatthew G Knepley if (!flg) break; 336bafc1b83SMatthew G Knepley if (numFields > 128) SETERRQ1(((PetscObject) pc)->comm,PETSC_ERR_SUP,"Cannot currently support %d > 128 fields", numFields); 337bafc1b83SMatthew G Knepley ierr = DMCreateSubDM(pc->dm, nfields, ifields, &compField, &subdm[i]);CHKERRQ(ierr); 338bafc1b83SMatthew G Knepley if (nfields == 1) { 339bafc1b83SMatthew G Knepley ierr = PCFieldSplitSetIS(pc, fieldNames[ifields[0]], compField);CHKERRQ(ierr); 3404d2389d7SMatthew G Knepley /* ierr = PetscPrintf(((PetscObject) pc)->comm, "%s Field Indices:", fieldNames[ifields[0]]);CHKERRQ(ierr); 3410298fd71SBarry Smith ierr = ISView(compField, NULL);CHKERRQ(ierr); */ 342bafc1b83SMatthew G Knepley } else { 3438caf3d72SBarry Smith ierr = PetscSNPrintf(splitname, sizeof(splitname), "%D", i);CHKERRQ(ierr); 344bafc1b83SMatthew G Knepley ierr = PCFieldSplitSetIS(pc, splitname, compField);CHKERRQ(ierr); 3454d2389d7SMatthew G Knepley /* ierr = PetscPrintf(((PetscObject) pc)->comm, "%s Field Indices:", splitname);CHKERRQ(ierr); 3460298fd71SBarry Smith ierr = ISView(compField, NULL);CHKERRQ(ierr); */ 3477287d2a3SDmitry Karpeev } 348bafc1b83SMatthew G Knepley ierr = ISDestroy(&compField);CHKERRQ(ierr); 349bafc1b83SMatthew G Knepley for (j = 0; j < nfields; ++j) { 350bafc1b83SMatthew G Knepley f = ifields[j]; 3517b62db95SJungho Lee ierr = PetscFree(fieldNames[f]);CHKERRQ(ierr); 3527b62db95SJungho Lee ierr = ISDestroy(&fields[f]);CHKERRQ(ierr); 3537b62db95SJungho Lee } 354bafc1b83SMatthew G Knepley } 355bafc1b83SMatthew G Knepley if (i == 0) { 356bafc1b83SMatthew G Knepley for (f = 0; f < numFields; ++f) { 357bafc1b83SMatthew G Knepley ierr = PCFieldSplitSetIS(pc, fieldNames[f], fields[f]);CHKERRQ(ierr); 358bafc1b83SMatthew G Knepley ierr = PetscFree(fieldNames[f]);CHKERRQ(ierr); 359bafc1b83SMatthew G Knepley ierr = ISDestroy(&fields[f]);CHKERRQ(ierr); 360bafc1b83SMatthew G Knepley } 361bafc1b83SMatthew G Knepley } else { 362d724dfffSBarry Smith for (j=0; j<numFields; j++) { 363d724dfffSBarry Smith ierr = DMDestroy(dms+j);CHKERRQ(ierr); 364d724dfffSBarry Smith } 365d724dfffSBarry Smith ierr = PetscFree(dms);CHKERRQ(ierr); 366bafc1b83SMatthew G Knepley ierr = PetscMalloc(i * sizeof(DM), &dms);CHKERRQ(ierr); 3672fa5cd67SKarl Rupp for (j = 0; j < i; ++j) dms[j] = subdm[j]; 368bafc1b83SMatthew G Knepley } 3697b62db95SJungho Lee ierr = PetscFree(fieldNames);CHKERRQ(ierr); 3707b62db95SJungho Lee ierr = PetscFree(fields);CHKERRQ(ierr); 371e7c4fc90SDmitry Karpeev if (dms) { 3728b8307b2SJed Brown ierr = PetscInfo(pc, "Setting up physics based fieldsplit preconditioner using the embedded DM\n");CHKERRQ(ierr); 373bafc1b83SMatthew G Knepley for (ilink = jac->head, i = 0; ilink; ilink = ilink->next, ++i) { 3747287d2a3SDmitry Karpeev const char *prefix; 3757287d2a3SDmitry Karpeev ierr = PetscObjectGetOptionsPrefix((PetscObject)(ilink->ksp),&prefix);CHKERRQ(ierr); 3767287d2a3SDmitry Karpeev ierr = PetscObjectSetOptionsPrefix((PetscObject)(dms[i]), prefix);CHKERRQ(ierr); 3777b62db95SJungho Lee ierr = KSPSetDM(ilink->ksp, dms[i]);CHKERRQ(ierr); 3787b62db95SJungho Lee ierr = KSPSetDMActive(ilink->ksp, PETSC_FALSE);CHKERRQ(ierr); 3797287d2a3SDmitry Karpeev ierr = PetscObjectIncrementTabLevel((PetscObject)dms[i],(PetscObject)ilink->ksp,0);CHKERRQ(ierr); 380e7c4fc90SDmitry Karpeev ierr = DMDestroy(&dms[i]);CHKERRQ(ierr); 3812fa5ba8aSJed Brown } 3827b62db95SJungho Lee ierr = PetscFree(dms);CHKERRQ(ierr); 3838b8307b2SJed Brown } 38466ffff09SJed Brown } else { 385521d7252SBarry Smith if (jac->bs <= 0) { 386704ba839SBarry Smith if (pc->pmat) { 387521d7252SBarry Smith ierr = MatGetBlockSize(pc->pmat,&jac->bs);CHKERRQ(ierr); 3882fa5cd67SKarl Rupp } else jac->bs = 1; 389521d7252SBarry Smith } 390d32f9abdSBarry Smith 3910298fd71SBarry Smith ierr = PetscOptionsGetBool(((PetscObject)pc)->prefix,"-pc_fieldsplit_default",&fieldsplit_default,NULL);CHKERRQ(ierr); 3926ce1633cSBarry Smith if (stokes) { 3936ce1633cSBarry Smith IS zerodiags,rest; 3946ce1633cSBarry Smith PetscInt nmin,nmax; 3956ce1633cSBarry Smith 3966ce1633cSBarry Smith ierr = MatGetOwnershipRange(pc->mat,&nmin,&nmax);CHKERRQ(ierr); 3976ce1633cSBarry Smith ierr = MatFindZeroDiagonals(pc->mat,&zerodiags);CHKERRQ(ierr); 3986ce1633cSBarry Smith ierr = ISComplement(zerodiags,nmin,nmax,&rest);CHKERRQ(ierr); 3997287d2a3SDmitry Karpeev if (jac->reset) { 4007287d2a3SDmitry Karpeev jac->head->is = rest; 4017287d2a3SDmitry Karpeev jac->head->next->is = zerodiags; 4022fa5cd67SKarl Rupp } else { 4036ce1633cSBarry Smith ierr = PCFieldSplitSetIS(pc,"0",rest);CHKERRQ(ierr); 4046ce1633cSBarry Smith ierr = PCFieldSplitSetIS(pc,"1",zerodiags);CHKERRQ(ierr); 4057287d2a3SDmitry Karpeev } 406fcfd50ebSBarry Smith ierr = ISDestroy(&zerodiags);CHKERRQ(ierr); 407fcfd50ebSBarry Smith ierr = ISDestroy(&rest);CHKERRQ(ierr); 4086ce1633cSBarry Smith } else { 409ce94432eSBarry Smith if (jac->reset) SETERRQ(PetscObjectComm((PetscObject)pc),PETSC_ERR_SUP,"Cases not yet handled when PCReset() was used"); 4107287d2a3SDmitry Karpeev if (!fieldsplit_default) { 411d32f9abdSBarry Smith /* Allow user to set fields from command line, if bs was known at the time of PCSetFromOptions_FieldSplit() 412d32f9abdSBarry Smith then it is set there. This is not ideal because we should only have options set in XXSetFromOptions(). */ 4136c924f48SJed Brown ierr = PCFieldSplitSetRuntimeSplits_Private(pc);CHKERRQ(ierr); 4146c924f48SJed Brown if (jac->splitdefined) {ierr = PetscInfo(pc,"Splits defined using the options database\n");CHKERRQ(ierr);} 415d32f9abdSBarry Smith } 4167287d2a3SDmitry Karpeev if (fieldsplit_default || !jac->splitdefined) { 417d32f9abdSBarry Smith ierr = PetscInfo(pc,"Using default splitting of fields\n");CHKERRQ(ierr); 418db4c96c1SJed Brown for (i=0; i<jac->bs; i++) { 4196c924f48SJed Brown char splitname[8]; 4208caf3d72SBarry Smith ierr = PetscSNPrintf(splitname,sizeof(splitname),"%D",i);CHKERRQ(ierr); 4215d4c12cdSJungho Lee ierr = PCFieldSplitSetFields(pc,splitname,1,&i,&i);CHKERRQ(ierr); 42279416396SBarry Smith } 4235d4c12cdSJungho Lee jac->defaultsplit = PETSC_TRUE; 424521d7252SBarry Smith } 42566ffff09SJed Brown } 4266ce1633cSBarry Smith } 427edf189efSBarry Smith } else if (jac->nsplits == 1) { 428edf189efSBarry Smith if (ilink->is) { 429edf189efSBarry Smith IS is2; 430edf189efSBarry Smith PetscInt nmin,nmax; 431edf189efSBarry Smith 432edf189efSBarry Smith ierr = MatGetOwnershipRange(pc->mat,&nmin,&nmax);CHKERRQ(ierr); 433edf189efSBarry Smith ierr = ISComplement(ilink->is,nmin,nmax,&is2);CHKERRQ(ierr); 434db4c96c1SJed Brown ierr = PCFieldSplitSetIS(pc,"1",is2);CHKERRQ(ierr); 435fcfd50ebSBarry Smith ierr = ISDestroy(&is2);CHKERRQ(ierr); 4367b62db95SJungho Lee } else SETERRQ(((PetscObject) pc)->comm,PETSC_ERR_SUP,"Must provide at least two sets of fields to PCFieldSplit()"); 437edf189efSBarry Smith } 438d0af7cd3SBarry Smith 439d0af7cd3SBarry Smith 4407b62db95SJungho Lee if (jac->nsplits < 2) SETERRQ1(((PetscObject) pc)->comm,PETSC_ERR_PLIB,"Unhandled case, must have at least two fields, not %d", jac->nsplits); 44169a612a9SBarry Smith PetscFunctionReturn(0); 44269a612a9SBarry Smith } 44369a612a9SBarry Smith 444514bf10dSMatthew G Knepley PetscErrorCode PetscOptionsFindPairPrefix_Private(const char pre[], const char name[], char *value[], PetscBool *flg); 445514bf10dSMatthew G Knepley 44669a612a9SBarry Smith #undef __FUNCT__ 44769a612a9SBarry Smith #define __FUNCT__ "PCSetUp_FieldSplit" 44869a612a9SBarry Smith static PetscErrorCode PCSetUp_FieldSplit(PC pc) 44969a612a9SBarry Smith { 45069a612a9SBarry Smith PC_FieldSplit *jac = (PC_FieldSplit*)pc->data; 45169a612a9SBarry Smith PetscErrorCode ierr; 4525a9f2f41SSatish Balay PC_FieldSplitLink ilink; 4532c9966d7SBarry Smith PetscInt i,nsplit; 45469a612a9SBarry Smith MatStructure flag = pc->flag; 4555f4ab4e1SJungho Lee PetscBool sorted, sorted_col; 45669a612a9SBarry Smith 45769a612a9SBarry Smith PetscFunctionBegin; 45869a612a9SBarry Smith ierr = PCFieldSplitSetDefaults(pc);CHKERRQ(ierr); 45997bbdb24SBarry Smith nsplit = jac->nsplits; 4605a9f2f41SSatish Balay ilink = jac->head; 46197bbdb24SBarry Smith 46297bbdb24SBarry Smith /* get the matrices for each split */ 463704ba839SBarry Smith if (!jac->issetup) { 4641b9fc7fcSBarry Smith PetscInt rstart,rend,nslots,bs; 46597bbdb24SBarry Smith 466704ba839SBarry Smith jac->issetup = PETSC_TRUE; 467704ba839SBarry Smith 4685d4c12cdSJungho Lee /* This is done here instead of in PCFieldSplitSetFields() because may not have matrix at that point */ 4692c9966d7SBarry Smith if (jac->defaultsplit || !ilink->is) { 4702c9966d7SBarry Smith if (jac->bs <= 0) jac->bs = nsplit; 4712c9966d7SBarry Smith } 47251f519a2SBarry Smith bs = jac->bs; 47397bbdb24SBarry Smith ierr = MatGetOwnershipRange(pc->pmat,&rstart,&rend);CHKERRQ(ierr); 4741b9fc7fcSBarry Smith nslots = (rend - rstart)/bs; 4751b9fc7fcSBarry Smith for (i=0; i<nsplit; i++) { 4761b9fc7fcSBarry Smith if (jac->defaultsplit) { 477ce94432eSBarry Smith ierr = ISCreateStride(PetscObjectComm((PetscObject)pc),nslots,rstart+i,nsplit,&ilink->is);CHKERRQ(ierr); 4785f4ab4e1SJungho Lee ierr = ISDuplicate(ilink->is,&ilink->is_col);CHKERRQ(ierr); 479704ba839SBarry Smith } else if (!ilink->is) { 480ccb205f8SBarry Smith if (ilink->nfields > 1) { 4815f4ab4e1SJungho Lee PetscInt *ii,*jj,j,k,nfields = ilink->nfields,*fields = ilink->fields,*fields_col = ilink->fields_col; 4825a9f2f41SSatish Balay ierr = PetscMalloc(ilink->nfields*nslots*sizeof(PetscInt),&ii);CHKERRQ(ierr); 4835f4ab4e1SJungho Lee ierr = PetscMalloc(ilink->nfields*nslots*sizeof(PetscInt),&jj);CHKERRQ(ierr); 4841b9fc7fcSBarry Smith for (j=0; j<nslots; j++) { 4851b9fc7fcSBarry Smith for (k=0; k<nfields; k++) { 4861b9fc7fcSBarry Smith ii[nfields*j + k] = rstart + bs*j + fields[k]; 4875f4ab4e1SJungho Lee jj[nfields*j + k] = rstart + bs*j + fields_col[k]; 48897bbdb24SBarry Smith } 48997bbdb24SBarry Smith } 490ce94432eSBarry Smith ierr = ISCreateGeneral(PetscObjectComm((PetscObject)pc),nslots*nfields,ii,PETSC_OWN_POINTER,&ilink->is);CHKERRQ(ierr); 491ce94432eSBarry Smith ierr = ISCreateGeneral(PetscObjectComm((PetscObject)pc),nslots*nfields,jj,PETSC_OWN_POINTER,&ilink->is_col);CHKERRQ(ierr); 492ccb205f8SBarry Smith } else { 493ce94432eSBarry Smith ierr = ISCreateStride(PetscObjectComm((PetscObject)pc),nslots,rstart+ilink->fields[0],bs,&ilink->is);CHKERRQ(ierr); 494ce94432eSBarry Smith ierr = ISCreateStride(PetscObjectComm((PetscObject)pc),nslots,rstart+ilink->fields_col[0],bs,&ilink->is_col);CHKERRQ(ierr); 495ccb205f8SBarry Smith } 4963e197d65SBarry Smith } 497704ba839SBarry Smith ierr = ISSorted(ilink->is,&sorted);CHKERRQ(ierr); 4985f4ab4e1SJungho Lee if (ilink->is_col) { ierr = ISSorted(ilink->is_col,&sorted_col);CHKERRQ(ierr); } 4995f4ab4e1SJungho Lee if (!sorted || !sorted_col) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_USER,"Fields must be sorted when creating split"); 500704ba839SBarry Smith ilink = ilink->next; 5011b9fc7fcSBarry Smith } 5021b9fc7fcSBarry Smith } 5031b9fc7fcSBarry Smith 504704ba839SBarry Smith ilink = jac->head; 50597bbdb24SBarry Smith if (!jac->pmat) { 506bdddcaaaSMatthew G Knepley Vec xtmp; 507bdddcaaaSMatthew G Knepley 5080298fd71SBarry Smith ierr = MatGetVecs(pc->pmat,&xtmp,NULL);CHKERRQ(ierr); 509cf502942SBarry Smith ierr = PetscMalloc(nsplit*sizeof(Mat),&jac->pmat);CHKERRQ(ierr); 510bdddcaaaSMatthew G Knepley ierr = PetscMalloc2(nsplit,Vec,&jac->x,nsplit,Vec,&jac->y);CHKERRQ(ierr); 511cf502942SBarry Smith for (i=0; i<nsplit; i++) { 512bdddcaaaSMatthew G Knepley MatNullSpace sp; 513bdddcaaaSMatthew G Knepley 514a3df900dSMatthew G Knepley /* Check for preconditioning matrix attached to IS */ 515a3df900dSMatthew G Knepley ierr = PetscObjectQuery((PetscObject) ilink->is, "pmat", (PetscObject*) &jac->pmat[i]);CHKERRQ(ierr); 516a3df900dSMatthew G Knepley if (jac->pmat[i]) { 517a3df900dSMatthew G Knepley ierr = PetscObjectReference((PetscObject) jac->pmat[i]);CHKERRQ(ierr); 518a3df900dSMatthew G Knepley if (jac->type == PC_COMPOSITE_SCHUR) { 519a3df900dSMatthew G Knepley jac->schur_user = jac->pmat[i]; 5202fa5cd67SKarl Rupp 521a3df900dSMatthew G Knepley ierr = PetscObjectReference((PetscObject) jac->schur_user);CHKERRQ(ierr); 522a3df900dSMatthew G Knepley } 523a3df900dSMatthew G Knepley } else { 5245f4ab4e1SJungho Lee ierr = MatGetSubMatrix(pc->pmat,ilink->is,ilink->is_col,MAT_INITIAL_MATRIX,&jac->pmat[i]);CHKERRQ(ierr); 525a3df900dSMatthew G Knepley } 526bdddcaaaSMatthew G Knepley /* create work vectors for each split */ 527bdddcaaaSMatthew G Knepley ierr = MatGetVecs(jac->pmat[i],&jac->x[i],&jac->y[i]);CHKERRQ(ierr); 5280298fd71SBarry Smith ilink->x = jac->x[i]; ilink->y = jac->y[i]; ilink->z = NULL; 529bdddcaaaSMatthew G Knepley /* compute scatter contexts needed by multiplicative versions and non-default splits */ 5300298fd71SBarry Smith ierr = VecScatterCreate(xtmp,ilink->is,jac->x[i],NULL,&ilink->sctx);CHKERRQ(ierr); 531ed1f0337SMatthew G Knepley /* Check for null space attached to IS */ 532bafc1b83SMatthew G Knepley ierr = PetscObjectQuery((PetscObject) ilink->is, "nullspace", (PetscObject*) &sp);CHKERRQ(ierr); 533bafc1b83SMatthew G Knepley if (sp) { 534bafc1b83SMatthew G Knepley ierr = MatSetNullSpace(jac->pmat[i], sp);CHKERRQ(ierr); 535bafc1b83SMatthew G Knepley } 536ed1f0337SMatthew G Knepley ierr = PetscObjectQuery((PetscObject) ilink->is, "nearnullspace", (PetscObject*) &sp);CHKERRQ(ierr); 537ed1f0337SMatthew G Knepley if (sp) { 538ed1f0337SMatthew G Knepley ierr = MatSetNearNullSpace(jac->pmat[i], sp);CHKERRQ(ierr); 539ed1f0337SMatthew G Knepley } 540704ba839SBarry Smith ilink = ilink->next; 541cf502942SBarry Smith } 542bdddcaaaSMatthew G Knepley ierr = VecDestroy(&xtmp);CHKERRQ(ierr); 54397bbdb24SBarry Smith } else { 544cf502942SBarry Smith for (i=0; i<nsplit; i++) { 545a3df900dSMatthew G Knepley Mat pmat; 546a3df900dSMatthew G Knepley 547a3df900dSMatthew G Knepley /* Check for preconditioning matrix attached to IS */ 548a3df900dSMatthew G Knepley ierr = PetscObjectQuery((PetscObject) ilink->is, "pmat", (PetscObject*) &pmat);CHKERRQ(ierr); 549a3df900dSMatthew G Knepley if (!pmat) { 5505f4ab4e1SJungho Lee ierr = MatGetSubMatrix(pc->pmat,ilink->is,ilink->is_col,MAT_REUSE_MATRIX,&jac->pmat[i]);CHKERRQ(ierr); 551a3df900dSMatthew G Knepley } 552704ba839SBarry Smith ilink = ilink->next; 553cf502942SBarry Smith } 55497bbdb24SBarry Smith } 555519d70e2SJed Brown if (jac->realdiagonal) { 556519d70e2SJed Brown ilink = jac->head; 557519d70e2SJed Brown if (!jac->mat) { 558519d70e2SJed Brown ierr = PetscMalloc(nsplit*sizeof(Mat),&jac->mat);CHKERRQ(ierr); 559519d70e2SJed Brown for (i=0; i<nsplit; i++) { 5605f4ab4e1SJungho Lee ierr = MatGetSubMatrix(pc->mat,ilink->is,ilink->is_col,MAT_INITIAL_MATRIX,&jac->mat[i]);CHKERRQ(ierr); 561519d70e2SJed Brown ilink = ilink->next; 562519d70e2SJed Brown } 563519d70e2SJed Brown } else { 564519d70e2SJed Brown for (i=0; i<nsplit; i++) { 5655f4ab4e1SJungho Lee if (jac->mat[i]) {ierr = MatGetSubMatrix(pc->mat,ilink->is,ilink->is_col,MAT_REUSE_MATRIX,&jac->mat[i]);CHKERRQ(ierr);} 566519d70e2SJed Brown ilink = ilink->next; 567519d70e2SJed Brown } 568519d70e2SJed Brown } 569519d70e2SJed Brown } else { 570519d70e2SJed Brown jac->mat = jac->pmat; 571519d70e2SJed Brown } 57297bbdb24SBarry Smith 5736c8605c2SJed Brown if (jac->type != PC_COMPOSITE_ADDITIVE && jac->type != PC_COMPOSITE_SCHUR) { 57468dd23aaSBarry Smith /* extract the rows of the matrix associated with each field: used for efficient computation of residual inside algorithm */ 57568dd23aaSBarry Smith ilink = jac->head; 57668dd23aaSBarry Smith if (!jac->Afield) { 57768dd23aaSBarry Smith ierr = PetscMalloc(nsplit*sizeof(Mat),&jac->Afield);CHKERRQ(ierr); 57868dd23aaSBarry Smith for (i=0; i<nsplit; i++) { 5790298fd71SBarry Smith ierr = MatGetSubMatrix(pc->mat,ilink->is,NULL,MAT_INITIAL_MATRIX,&jac->Afield[i]);CHKERRQ(ierr); 58068dd23aaSBarry Smith ilink = ilink->next; 58168dd23aaSBarry Smith } 58268dd23aaSBarry Smith } else { 58368dd23aaSBarry Smith for (i=0; i<nsplit; i++) { 5840298fd71SBarry Smith ierr = MatGetSubMatrix(pc->mat,ilink->is,NULL,MAT_REUSE_MATRIX,&jac->Afield[i]);CHKERRQ(ierr); 58568dd23aaSBarry Smith ilink = ilink->next; 58668dd23aaSBarry Smith } 58768dd23aaSBarry Smith } 58868dd23aaSBarry Smith } 58968dd23aaSBarry Smith 5903b224e63SBarry Smith if (jac->type == PC_COMPOSITE_SCHUR) { 5913b224e63SBarry Smith IS ccis; 5924aa3045dSJed Brown PetscInt rstart,rend; 593093c86ffSJed Brown char lscname[256]; 594093c86ffSJed Brown PetscObject LSC_L; 595ce94432eSBarry Smith 596ce94432eSBarry Smith if (nsplit != 2) SETERRQ(PetscObjectComm((PetscObject)pc),PETSC_ERR_ARG_INCOMP,"To use Schur complement preconditioner you must have exactly 2 fields"); 59768dd23aaSBarry Smith 598e6cab6aaSJed Brown /* When extracting off-diagonal submatrices, we take complements from this range */ 599e6cab6aaSJed Brown ierr = MatGetOwnershipRangeColumn(pc->mat,&rstart,&rend);CHKERRQ(ierr); 600e6cab6aaSJed Brown 6013b224e63SBarry Smith /* need to handle case when one is resetting up the preconditioner */ 6023b224e63SBarry Smith if (jac->schur) { 6030298fd71SBarry Smith KSP kspA = jac->head->ksp, kspInner = NULL, kspUpper = jac->kspupper; 604443836d0SMatthew G Knepley 605fb3147dbSMatthew G Knepley ierr = MatSchurComplementGetKSP(jac->schur, &kspInner);CHKERRQ(ierr); 6063b224e63SBarry Smith ilink = jac->head; 60749bb4cd7SJungho Lee ierr = ISComplement(ilink->is_col,rstart,rend,&ccis);CHKERRQ(ierr); 6084aa3045dSJed Brown ierr = MatGetSubMatrix(pc->mat,ilink->is,ccis,MAT_REUSE_MATRIX,&jac->B);CHKERRQ(ierr); 609fcfd50ebSBarry Smith ierr = ISDestroy(&ccis);CHKERRQ(ierr); 6103b224e63SBarry Smith ilink = ilink->next; 61149bb4cd7SJungho Lee ierr = ISComplement(ilink->is_col,rstart,rend,&ccis);CHKERRQ(ierr); 6124aa3045dSJed Brown ierr = MatGetSubMatrix(pc->mat,ilink->is,ccis,MAT_REUSE_MATRIX,&jac->C);CHKERRQ(ierr); 613fcfd50ebSBarry Smith ierr = ISDestroy(&ccis);CHKERRQ(ierr); 614a3df900dSMatthew G Knepley ierr = MatSchurComplementUpdate(jac->schur,jac->mat[0],jac->pmat[0],jac->B,jac->C,jac->mat[1],pc->flag);CHKERRQ(ierr); 615443836d0SMatthew G Knepley if (kspA != kspInner) { 616443836d0SMatthew G Knepley ierr = KSPSetOperators(kspA,jac->mat[0],jac->pmat[0],pc->flag);CHKERRQ(ierr); 617443836d0SMatthew G Knepley } 618443836d0SMatthew G Knepley if (kspUpper != kspA) { 619443836d0SMatthew G Knepley ierr = KSPSetOperators(kspUpper,jac->mat[0],jac->pmat[0],pc->flag);CHKERRQ(ierr); 620443836d0SMatthew G Knepley } 621084e4875SJed Brown ierr = KSPSetOperators(jac->kspschur,jac->schur,FieldSplitSchurPre(jac),pc->flag);CHKERRQ(ierr); 6223b224e63SBarry Smith } else { 6231cee3971SBarry Smith KSP ksp; 624bafc1b83SMatthew G Knepley const char *Dprefix; 625bafc1b83SMatthew G Knepley char schurprefix[256]; 626514bf10dSMatthew G Knepley char schurtestoption[256]; 627bdddcaaaSMatthew G Knepley MatNullSpace sp; 628514bf10dSMatthew G Knepley PetscBool flg; 6293b224e63SBarry Smith 630a04f6461SBarry Smith /* extract the A01 and A10 matrices */ 6313b224e63SBarry Smith ilink = jac->head; 63249bb4cd7SJungho Lee ierr = ISComplement(ilink->is_col,rstart,rend,&ccis);CHKERRQ(ierr); 6334aa3045dSJed Brown ierr = MatGetSubMatrix(pc->mat,ilink->is,ccis,MAT_INITIAL_MATRIX,&jac->B);CHKERRQ(ierr); 634fcfd50ebSBarry Smith ierr = ISDestroy(&ccis);CHKERRQ(ierr); 6353b224e63SBarry Smith ilink = ilink->next; 63649bb4cd7SJungho Lee ierr = ISComplement(ilink->is_col,rstart,rend,&ccis);CHKERRQ(ierr); 6374aa3045dSJed Brown ierr = MatGetSubMatrix(pc->mat,ilink->is,ccis,MAT_INITIAL_MATRIX,&jac->C);CHKERRQ(ierr); 638fcfd50ebSBarry Smith ierr = ISDestroy(&ccis);CHKERRQ(ierr); 63920252d06SBarry Smith 64020252d06SBarry Smith /* Use mat[0] (diagonal block of the real matrix) preconditioned by pmat[0] to define Schur complement */ 64120252d06SBarry Smith ierr = MatCreate(((PetscObject)jac->mat[0])->comm,&jac->schur);CHKERRQ(ierr); 64220252d06SBarry Smith ierr = MatSetType(jac->schur,MATSCHURCOMPLEMENT);CHKERRQ(ierr); 64320252d06SBarry Smith ierr = MatSchurComplementGetKSP(jac->schur, &ksp);CHKERRQ(ierr); 64420252d06SBarry Smith ierr = PetscSNPrintf(schurprefix, sizeof(schurprefix), "%sfieldsplit_%s_inner_", ((PetscObject)pc)->prefix ? ((PetscObject)pc)->prefix : "", ilink->splitname);CHKERRQ(ierr); 64520252d06SBarry Smith /* Indent this deeper to emphasize the "inner" nature of this solver. */ 64620252d06SBarry Smith ierr = PetscObjectIncrementTabLevel((PetscObject)ksp, (PetscObject) pc, 2);CHKERRQ(ierr); 64720252d06SBarry Smith ierr = KSPSetOptionsPrefix(ksp, schurprefix);CHKERRQ(ierr); 64820252d06SBarry Smith ierr = MatSchurComplementSet(jac->schur,jac->mat[0],jac->pmat[0],jac->B,jac->C,jac->mat[1]);CHKERRQ(ierr); 64920252d06SBarry Smith 650bdddcaaaSMatthew G Knepley ierr = MatGetNullSpace(jac->pmat[1], &sp);CHKERRQ(ierr); 65120252d06SBarry Smith if (sp) { 65220252d06SBarry Smith ierr = MatSetNullSpace(jac->schur, sp);CHKERRQ(ierr); 65320252d06SBarry Smith } 65420252d06SBarry Smith 65520252d06SBarry Smith ierr = PetscSNPrintf(schurtestoption, sizeof(schurtestoption), "-fieldsplit_%s_inner_", ilink->splitname);CHKERRQ(ierr); 6560298fd71SBarry Smith ierr = PetscOptionsFindPairPrefix_Private(((PetscObject)pc)->prefix, schurtestoption, NULL, &flg);CHKERRQ(ierr); 657514bf10dSMatthew G Knepley if (flg) { 658514bf10dSMatthew G Knepley DM dmInner; 659514bf10dSMatthew G Knepley 660514bf10dSMatthew G Knepley /* Set DM for new solver */ 661bafc1b83SMatthew G Knepley ierr = KSPGetDM(jac->head->ksp, &dmInner);CHKERRQ(ierr); 662bafc1b83SMatthew G Knepley ierr = KSPSetDM(ksp, dmInner);CHKERRQ(ierr); 6637287d2a3SDmitry Karpeev ierr = KSPSetDMActive(ksp, PETSC_FALSE);CHKERRQ(ierr); 664443836d0SMatthew G Knepley ierr = KSPSetOperators(jac->head->ksp,jac->mat[0],jac->pmat[0],flag);CHKERRQ(ierr); 665443836d0SMatthew G Knepley ierr = KSPSetFromOptions(jac->head->ksp);CHKERRQ(ierr); 666514bf10dSMatthew G Knepley } else { 667514bf10dSMatthew G Knepley ierr = MatSchurComplementSetKSP(jac->schur, jac->head->ksp);CHKERRQ(ierr); 668514bf10dSMatthew G Knepley ierr = PetscObjectReference((PetscObject) jac->head->ksp);CHKERRQ(ierr); 669bafc1b83SMatthew G Knepley } 67020b26d62SBarry Smith ierr = MatSetFromOptions(jac->schur);CHKERRQ(ierr); 6713b224e63SBarry Smith 672443836d0SMatthew G Knepley ierr = PetscSNPrintf(schurtestoption, sizeof(schurtestoption), "-fieldsplit_%s_upper_", ilink->splitname);CHKERRQ(ierr); 6730298fd71SBarry Smith ierr = PetscOptionsFindPairPrefix_Private(((PetscObject)pc)->prefix, schurtestoption, NULL, &flg);CHKERRQ(ierr); 674443836d0SMatthew G Knepley if (flg) { 675443836d0SMatthew G Knepley DM dmInner; 676443836d0SMatthew G Knepley 677443836d0SMatthew G Knepley ierr = PetscSNPrintf(schurprefix, sizeof(schurprefix), "%sfieldsplit_%s_upper_", ((PetscObject)pc)->prefix ? ((PetscObject)pc)->prefix : "", ilink->splitname);CHKERRQ(ierr); 678443836d0SMatthew G Knepley ierr = KSPCreate(((PetscObject) pc)->comm, &jac->kspupper);CHKERRQ(ierr); 679443836d0SMatthew G Knepley ierr = KSPSetOptionsPrefix(jac->kspupper, schurprefix);CHKERRQ(ierr); 680443836d0SMatthew G Knepley ierr = KSPGetDM(jac->head->ksp, &dmInner);CHKERRQ(ierr); 681443836d0SMatthew G Knepley ierr = KSPSetDM(jac->kspupper, dmInner);CHKERRQ(ierr); 682443836d0SMatthew G Knepley ierr = KSPSetDMActive(jac->kspupper, PETSC_FALSE);CHKERRQ(ierr); 683443836d0SMatthew G Knepley ierr = KSPSetFromOptions(jac->kspupper);CHKERRQ(ierr); 684443836d0SMatthew G Knepley ierr = KSPSetOperators(jac->kspupper,jac->mat[0],jac->pmat[0],flag);CHKERRQ(ierr); 685443836d0SMatthew G Knepley ierr = VecDuplicate(jac->head->x, &jac->head->z);CHKERRQ(ierr); 686443836d0SMatthew G Knepley } else { 687443836d0SMatthew G Knepley jac->kspupper = jac->head->ksp; 688443836d0SMatthew G Knepley ierr = PetscObjectReference((PetscObject) jac->head->ksp);CHKERRQ(ierr); 689443836d0SMatthew G Knepley } 690443836d0SMatthew G Knepley 691ce94432eSBarry Smith ierr = KSPCreate(PetscObjectComm((PetscObject)pc),&jac->kspschur);CHKERRQ(ierr); 6929005cf84SBarry Smith ierr = PetscLogObjectParent((PetscObject)pc,(PetscObject)jac->kspschur);CHKERRQ(ierr); 69320252d06SBarry Smith ierr = PetscObjectIncrementTabLevel((PetscObject)jac->kspschur,(PetscObject)pc,1);CHKERRQ(ierr); 694084e4875SJed Brown ierr = KSPSetOperators(jac->kspschur,jac->schur,FieldSplitSchurPre(jac),DIFFERENT_NONZERO_PATTERN);CHKERRQ(ierr); 695084e4875SJed Brown if (jac->schurpre == PC_FIELDSPLIT_SCHUR_PRE_SELF) { 6967233a360SDmitry Karpeev PC pcschur; 6977233a360SDmitry Karpeev ierr = KSPGetPC(jac->kspschur,&pcschur);CHKERRQ(ierr); 6987233a360SDmitry Karpeev ierr = PCSetType(pcschur,PCNONE);CHKERRQ(ierr); 699084e4875SJed Brown /* Note: This is bad if there exist preconditioners for MATSCHURCOMPLEMENT */ 700e69d4d44SBarry Smith } 7017287d2a3SDmitry Karpeev ierr = KSPGetOptionsPrefix(jac->head->next->ksp, &Dprefix);CHKERRQ(ierr); 7027287d2a3SDmitry Karpeev ierr = KSPSetOptionsPrefix(jac->kspschur, Dprefix);CHKERRQ(ierr); 7033b224e63SBarry Smith /* really want setfromoptions called in PCSetFromOptions_FieldSplit(), but it is not ready yet */ 70420b26d62SBarry Smith /* need to call this every time, since the jac->kspschur is freshly created, otherwise its options never get set */ 70520b26d62SBarry Smith ierr = KSPSetFromOptions(jac->kspschur);CHKERRQ(ierr); 7063b224e63SBarry Smith } 707093c86ffSJed Brown 708093c86ffSJed Brown /* HACK: special support to forward L and Lp matrices that might be used by PCLSC */ 7098caf3d72SBarry Smith ierr = PetscSNPrintf(lscname,sizeof(lscname),"%s_LSC_L",ilink->splitname);CHKERRQ(ierr); 710093c86ffSJed Brown ierr = PetscObjectQuery((PetscObject)pc->mat,lscname,(PetscObject*)&LSC_L);CHKERRQ(ierr); 711093c86ffSJed Brown if (!LSC_L) {ierr = PetscObjectQuery((PetscObject)pc->pmat,lscname,(PetscObject*)&LSC_L);CHKERRQ(ierr);} 712093c86ffSJed Brown if (LSC_L) {ierr = PetscObjectCompose((PetscObject)jac->schur,"LSC_L",(PetscObject)LSC_L);CHKERRQ(ierr);} 7138caf3d72SBarry Smith ierr = PetscSNPrintf(lscname,sizeof(lscname),"%s_LSC_Lp",ilink->splitname);CHKERRQ(ierr); 714093c86ffSJed Brown ierr = PetscObjectQuery((PetscObject)pc->pmat,lscname,(PetscObject*)&LSC_L);CHKERRQ(ierr); 715093c86ffSJed Brown if (!LSC_L) {ierr = PetscObjectQuery((PetscObject)pc->mat,lscname,(PetscObject*)&LSC_L);CHKERRQ(ierr);} 716093c86ffSJed Brown if (LSC_L) {ierr = PetscObjectCompose((PetscObject)jac->schur,"LSC_Lp",(PetscObject)LSC_L);CHKERRQ(ierr);} 7173b224e63SBarry Smith } else { 71868bd789dSDmitry Karpeev /* set up the individual splits' PCs */ 71997bbdb24SBarry Smith i = 0; 7205a9f2f41SSatish Balay ilink = jac->head; 7215a9f2f41SSatish Balay while (ilink) { 722519d70e2SJed Brown ierr = KSPSetOperators(ilink->ksp,jac->mat[i],jac->pmat[i],flag);CHKERRQ(ierr); 7233b224e63SBarry Smith /* really want setfromoptions called in PCSetFromOptions_FieldSplit(), but it is not ready yet */ 724c1570756SJed Brown if (!jac->suboptionsset) {ierr = KSPSetFromOptions(ilink->ksp);CHKERRQ(ierr);} 72597bbdb24SBarry Smith i++; 7265a9f2f41SSatish Balay ilink = ilink->next; 7270971522cSBarry Smith } 7283b224e63SBarry Smith } 7293b224e63SBarry Smith 730c1570756SJed Brown jac->suboptionsset = PETSC_TRUE; 7310971522cSBarry Smith PetscFunctionReturn(0); 7320971522cSBarry Smith } 7330971522cSBarry Smith 7345a9f2f41SSatish Balay #define FieldSplitSplitSolveAdd(ilink,xx,yy) \ 735ca9f406cSSatish Balay (VecScatterBegin(ilink->sctx,xx,ilink->x,INSERT_VALUES,SCATTER_FORWARD) || \ 736ca9f406cSSatish Balay VecScatterEnd(ilink->sctx,xx,ilink->x,INSERT_VALUES,SCATTER_FORWARD) || \ 7375a9f2f41SSatish Balay KSPSolve(ilink->ksp,ilink->x,ilink->y) || \ 738ca9f406cSSatish Balay VecScatterBegin(ilink->sctx,ilink->y,yy,ADD_VALUES,SCATTER_REVERSE) || \ 739ca9f406cSSatish Balay VecScatterEnd(ilink->sctx,ilink->y,yy,ADD_VALUES,SCATTER_REVERSE)) 74079416396SBarry Smith 7410971522cSBarry Smith #undef __FUNCT__ 7423b224e63SBarry Smith #define __FUNCT__ "PCApply_FieldSplit_Schur" 7433b224e63SBarry Smith static PetscErrorCode PCApply_FieldSplit_Schur(PC pc,Vec x,Vec y) 7443b224e63SBarry Smith { 7453b224e63SBarry Smith PC_FieldSplit *jac = (PC_FieldSplit*)pc->data; 7463b224e63SBarry Smith PetscErrorCode ierr; 7473b224e63SBarry Smith PC_FieldSplitLink ilinkA = jac->head, ilinkD = ilinkA->next; 748443836d0SMatthew G Knepley KSP kspA = ilinkA->ksp, kspLower = kspA, kspUpper = jac->kspupper; 7493b224e63SBarry Smith 7503b224e63SBarry Smith PetscFunctionBegin; 751c5d2311dSJed Brown switch (jac->schurfactorization) { 752c9c6ffaaSJed Brown case PC_FIELDSPLIT_SCHUR_FACT_DIAG: 753a04f6461SBarry Smith /* [A00 0; 0 -S], positive definite, suitable for MINRES */ 754c5d2311dSJed Brown ierr = VecScatterBegin(ilinkA->sctx,x,ilinkA->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr); 755c5d2311dSJed Brown ierr = VecScatterBegin(ilinkD->sctx,x,ilinkD->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr); 756c5d2311dSJed Brown ierr = VecScatterEnd(ilinkA->sctx,x,ilinkA->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr); 757443836d0SMatthew G Knepley ierr = KSPSolve(kspA,ilinkA->x,ilinkA->y);CHKERRQ(ierr); 758c5d2311dSJed Brown ierr = VecScatterBegin(ilinkA->sctx,ilinkA->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr); 759c5d2311dSJed Brown ierr = VecScatterEnd(ilinkD->sctx,x,ilinkD->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr); 760c5d2311dSJed Brown ierr = KSPSolve(jac->kspschur,ilinkD->x,ilinkD->y);CHKERRQ(ierr); 761c5d2311dSJed Brown ierr = VecScale(ilinkD->y,-1.);CHKERRQ(ierr); 762c5d2311dSJed Brown ierr = VecScatterBegin(ilinkD->sctx,ilinkD->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr); 763c5d2311dSJed Brown ierr = VecScatterEnd(ilinkA->sctx,ilinkA->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr); 764c5d2311dSJed Brown ierr = VecScatterEnd(ilinkD->sctx,ilinkD->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr); 765c5d2311dSJed Brown break; 766c9c6ffaaSJed Brown case PC_FIELDSPLIT_SCHUR_FACT_LOWER: 767a04f6461SBarry Smith /* [A00 0; A10 S], suitable for left preconditioning */ 768c5d2311dSJed Brown ierr = VecScatterBegin(ilinkA->sctx,x,ilinkA->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr); 769c5d2311dSJed Brown ierr = VecScatterEnd(ilinkA->sctx,x,ilinkA->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr); 770443836d0SMatthew G Knepley ierr = KSPSolve(kspA,ilinkA->x,ilinkA->y);CHKERRQ(ierr); 771c5d2311dSJed Brown ierr = MatMult(jac->C,ilinkA->y,ilinkD->x);CHKERRQ(ierr); 772c5d2311dSJed Brown ierr = VecScale(ilinkD->x,-1.);CHKERRQ(ierr); 773c5d2311dSJed Brown ierr = VecScatterBegin(ilinkD->sctx,x,ilinkD->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr); 774c5d2311dSJed Brown ierr = VecScatterBegin(ilinkA->sctx,ilinkA->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr); 775c5d2311dSJed Brown ierr = VecScatterEnd(ilinkD->sctx,x,ilinkD->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr); 776c5d2311dSJed Brown ierr = KSPSolve(jac->kspschur,ilinkD->x,ilinkD->y);CHKERRQ(ierr); 777c5d2311dSJed Brown ierr = VecScatterBegin(ilinkD->sctx,ilinkD->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr); 778c5d2311dSJed Brown ierr = VecScatterEnd(ilinkA->sctx,ilinkA->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr); 779c5d2311dSJed Brown ierr = VecScatterEnd(ilinkD->sctx,ilinkD->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr); 780c5d2311dSJed Brown break; 781c9c6ffaaSJed Brown case PC_FIELDSPLIT_SCHUR_FACT_UPPER: 782a04f6461SBarry Smith /* [A00 A01; 0 S], suitable for right preconditioning */ 783c5d2311dSJed Brown ierr = VecScatterBegin(ilinkD->sctx,x,ilinkD->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr); 784c5d2311dSJed Brown ierr = VecScatterEnd(ilinkD->sctx,x,ilinkD->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr); 785c5d2311dSJed Brown ierr = KSPSolve(jac->kspschur,ilinkD->x,ilinkD->y);CHKERRQ(ierr); 786c5d2311dSJed Brown ierr = MatMult(jac->B,ilinkD->y,ilinkA->x);CHKERRQ(ierr); 787c5d2311dSJed Brown ierr = VecScale(ilinkA->x,-1.);CHKERRQ(ierr); 788c5d2311dSJed Brown ierr = VecScatterBegin(ilinkA->sctx,x,ilinkA->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr); 789c5d2311dSJed Brown ierr = VecScatterBegin(ilinkD->sctx,ilinkD->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr); 790c5d2311dSJed Brown ierr = VecScatterEnd(ilinkA->sctx,x,ilinkA->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr); 791443836d0SMatthew G Knepley ierr = KSPSolve(kspA,ilinkA->x,ilinkA->y);CHKERRQ(ierr); 792c5d2311dSJed Brown ierr = VecScatterBegin(ilinkA->sctx,ilinkA->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr); 793c5d2311dSJed Brown ierr = VecScatterEnd(ilinkD->sctx,ilinkD->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr); 794c5d2311dSJed Brown ierr = VecScatterEnd(ilinkA->sctx,ilinkA->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr); 795c5d2311dSJed Brown break; 796c9c6ffaaSJed Brown case PC_FIELDSPLIT_SCHUR_FACT_FULL: 797a04f6461SBarry 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 */ 7983b224e63SBarry Smith ierr = VecScatterBegin(ilinkA->sctx,x,ilinkA->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr); 7993b224e63SBarry Smith ierr = VecScatterEnd(ilinkA->sctx,x,ilinkA->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr); 800443836d0SMatthew G Knepley ierr = KSPSolve(kspLower,ilinkA->x,ilinkA->y);CHKERRQ(ierr); 8013b224e63SBarry Smith ierr = MatMult(jac->C,ilinkA->y,ilinkD->x);CHKERRQ(ierr); 8023b224e63SBarry Smith ierr = VecScale(ilinkD->x,-1.0);CHKERRQ(ierr); 8033b224e63SBarry Smith ierr = VecScatterBegin(ilinkD->sctx,x,ilinkD->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr); 8043b224e63SBarry Smith ierr = VecScatterEnd(ilinkD->sctx,x,ilinkD->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr); 8053b224e63SBarry Smith 8063b224e63SBarry Smith ierr = KSPSolve(jac->kspschur,ilinkD->x,ilinkD->y);CHKERRQ(ierr); 8073b224e63SBarry Smith ierr = VecScatterBegin(ilinkD->sctx,ilinkD->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr); 8083b224e63SBarry Smith ierr = VecScatterEnd(ilinkD->sctx,ilinkD->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr); 8093b224e63SBarry Smith 810443836d0SMatthew G Knepley if (kspUpper == kspA) { 8113b224e63SBarry Smith ierr = MatMult(jac->B,ilinkD->y,ilinkA->y);CHKERRQ(ierr); 8123b224e63SBarry Smith ierr = VecAXPY(ilinkA->x,-1.0,ilinkA->y);CHKERRQ(ierr); 813443836d0SMatthew G Knepley ierr = KSPSolve(kspA,ilinkA->x,ilinkA->y);CHKERRQ(ierr); 814443836d0SMatthew G Knepley } else { 815443836d0SMatthew G Knepley ierr = KSPSolve(kspA,ilinkA->x,ilinkA->y);CHKERRQ(ierr); 816443836d0SMatthew G Knepley ierr = MatMult(jac->B,ilinkD->y,ilinkA->x);CHKERRQ(ierr); 817443836d0SMatthew G Knepley ierr = KSPSolve(kspUpper,ilinkA->x,ilinkA->z);CHKERRQ(ierr); 818443836d0SMatthew G Knepley ierr = VecAXPY(ilinkA->y,-1.0,ilinkA->z);CHKERRQ(ierr); 819443836d0SMatthew G Knepley } 8203b224e63SBarry Smith ierr = VecScatterBegin(ilinkA->sctx,ilinkA->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr); 8213b224e63SBarry Smith ierr = VecScatterEnd(ilinkA->sctx,ilinkA->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr); 822c5d2311dSJed Brown } 8233b224e63SBarry Smith PetscFunctionReturn(0); 8243b224e63SBarry Smith } 8253b224e63SBarry Smith 8263b224e63SBarry Smith #undef __FUNCT__ 8270971522cSBarry Smith #define __FUNCT__ "PCApply_FieldSplit" 8280971522cSBarry Smith static PetscErrorCode PCApply_FieldSplit(PC pc,Vec x,Vec y) 8290971522cSBarry Smith { 8300971522cSBarry Smith PC_FieldSplit *jac = (PC_FieldSplit*)pc->data; 8310971522cSBarry Smith PetscErrorCode ierr; 8325a9f2f41SSatish Balay PC_FieldSplitLink ilink = jac->head; 833939b8a20SBarry Smith PetscInt cnt,bs; 8340971522cSBarry Smith 8350971522cSBarry Smith PetscFunctionBegin; 8365847835fSJed Brown if (jac->bs > 0) { 837077aedafSJed Brown ierr = VecSetBlockSize(x,jac->bs);CHKERRQ(ierr); 838077aedafSJed Brown ierr = VecSetBlockSize(y,jac->bs);CHKERRQ(ierr); 8395847835fSJed Brown } 84051f519a2SBarry Smith CHKMEMQ; 84179416396SBarry Smith if (jac->type == PC_COMPOSITE_ADDITIVE) { 8421b9fc7fcSBarry Smith if (jac->defaultsplit) { 843939b8a20SBarry Smith ierr = VecGetBlockSize(x,&bs);CHKERRQ(ierr); 844ce94432eSBarry Smith if (jac->bs > 0 && bs != jac->bs) SETERRQ2(PetscObjectComm((PetscObject)pc),PETSC_ERR_ARG_WRONGSTATE,"Blocksize of x vector %D does not match fieldsplit blocksize %D",bs,jac->bs); 845939b8a20SBarry Smith ierr = VecGetBlockSize(y,&bs);CHKERRQ(ierr); 846ce94432eSBarry Smith if (jac->bs > 0 && bs != jac->bs) SETERRQ2(PetscObjectComm((PetscObject)pc),PETSC_ERR_ARG_WRONGSTATE,"Blocksize of y vector %D does not match fieldsplit blocksize %D",bs,jac->bs); 8470971522cSBarry Smith ierr = VecStrideGatherAll(x,jac->x,INSERT_VALUES);CHKERRQ(ierr); 8485a9f2f41SSatish Balay while (ilink) { 8495a9f2f41SSatish Balay ierr = KSPSolve(ilink->ksp,ilink->x,ilink->y);CHKERRQ(ierr); 8505a9f2f41SSatish Balay ilink = ilink->next; 8510971522cSBarry Smith } 8520971522cSBarry Smith ierr = VecStrideScatterAll(jac->y,y,INSERT_VALUES);CHKERRQ(ierr); 8531b9fc7fcSBarry Smith } else { 854efb30889SBarry Smith ierr = VecSet(y,0.0);CHKERRQ(ierr); 8555a9f2f41SSatish Balay while (ilink) { 8565a9f2f41SSatish Balay ierr = FieldSplitSplitSolveAdd(ilink,x,y);CHKERRQ(ierr); 8575a9f2f41SSatish Balay ilink = ilink->next; 8581b9fc7fcSBarry Smith } 8591b9fc7fcSBarry Smith } 86016913363SBarry Smith } else if (jac->type == PC_COMPOSITE_MULTIPLICATIVE || jac->type == PC_COMPOSITE_SYMMETRIC_MULTIPLICATIVE) { 86179416396SBarry Smith if (!jac->w1) { 86279416396SBarry Smith ierr = VecDuplicate(x,&jac->w1);CHKERRQ(ierr); 86379416396SBarry Smith ierr = VecDuplicate(x,&jac->w2);CHKERRQ(ierr); 86479416396SBarry Smith } 865efb30889SBarry Smith ierr = VecSet(y,0.0);CHKERRQ(ierr); 8665a9f2f41SSatish Balay ierr = FieldSplitSplitSolveAdd(ilink,x,y);CHKERRQ(ierr); 8673e197d65SBarry Smith cnt = 1; 8685a9f2f41SSatish Balay while (ilink->next) { 8695a9f2f41SSatish Balay ilink = ilink->next; 8703e197d65SBarry Smith /* compute the residual only over the part of the vector needed */ 8713e197d65SBarry Smith ierr = MatMult(jac->Afield[cnt++],y,ilink->x);CHKERRQ(ierr); 8723e197d65SBarry Smith ierr = VecScale(ilink->x,-1.0);CHKERRQ(ierr); 8733e197d65SBarry Smith ierr = VecScatterBegin(ilink->sctx,x,ilink->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr); 8743e197d65SBarry Smith ierr = VecScatterEnd(ilink->sctx,x,ilink->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr); 8753e197d65SBarry Smith ierr = KSPSolve(ilink->ksp,ilink->x,ilink->y);CHKERRQ(ierr); 8763e197d65SBarry Smith ierr = VecScatterBegin(ilink->sctx,ilink->y,y,ADD_VALUES,SCATTER_REVERSE);CHKERRQ(ierr); 8773e197d65SBarry Smith ierr = VecScatterEnd(ilink->sctx,ilink->y,y,ADD_VALUES,SCATTER_REVERSE);CHKERRQ(ierr); 8783e197d65SBarry Smith } 87951f519a2SBarry Smith if (jac->type == PC_COMPOSITE_SYMMETRIC_MULTIPLICATIVE) { 88011755939SBarry Smith cnt -= 2; 88151f519a2SBarry Smith while (ilink->previous) { 88251f519a2SBarry Smith ilink = ilink->previous; 88311755939SBarry Smith /* compute the residual only over the part of the vector needed */ 88411755939SBarry Smith ierr = MatMult(jac->Afield[cnt--],y,ilink->x);CHKERRQ(ierr); 88511755939SBarry Smith ierr = VecScale(ilink->x,-1.0);CHKERRQ(ierr); 88611755939SBarry Smith ierr = VecScatterBegin(ilink->sctx,x,ilink->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr); 88711755939SBarry Smith ierr = VecScatterEnd(ilink->sctx,x,ilink->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr); 88811755939SBarry Smith ierr = KSPSolve(ilink->ksp,ilink->x,ilink->y);CHKERRQ(ierr); 88911755939SBarry Smith ierr = VecScatterBegin(ilink->sctx,ilink->y,y,ADD_VALUES,SCATTER_REVERSE);CHKERRQ(ierr); 89011755939SBarry Smith ierr = VecScatterEnd(ilink->sctx,ilink->y,y,ADD_VALUES,SCATTER_REVERSE);CHKERRQ(ierr); 89151f519a2SBarry Smith } 89211755939SBarry Smith } 893ce94432eSBarry Smith } else SETERRQ1(PetscObjectComm((PetscObject)pc),PETSC_ERR_SUP,"Unsupported or unknown composition",(int) jac->type); 89451f519a2SBarry Smith CHKMEMQ; 8950971522cSBarry Smith PetscFunctionReturn(0); 8960971522cSBarry Smith } 8970971522cSBarry Smith 898421e10b8SBarry Smith #define FieldSplitSplitSolveAddTranspose(ilink,xx,yy) \ 899ca9f406cSSatish Balay (VecScatterBegin(ilink->sctx,xx,ilink->y,INSERT_VALUES,SCATTER_FORWARD) || \ 900ca9f406cSSatish Balay VecScatterEnd(ilink->sctx,xx,ilink->y,INSERT_VALUES,SCATTER_FORWARD) || \ 901421e10b8SBarry Smith KSPSolveTranspose(ilink->ksp,ilink->y,ilink->x) || \ 902ca9f406cSSatish Balay VecScatterBegin(ilink->sctx,ilink->x,yy,ADD_VALUES,SCATTER_REVERSE) || \ 903ca9f406cSSatish Balay VecScatterEnd(ilink->sctx,ilink->x,yy,ADD_VALUES,SCATTER_REVERSE)) 904421e10b8SBarry Smith 905421e10b8SBarry Smith #undef __FUNCT__ 9068c03b21aSDmitry Karpeev #define __FUNCT__ "PCApplyTranspose_FieldSplit" 907421e10b8SBarry Smith static PetscErrorCode PCApplyTranspose_FieldSplit(PC pc,Vec x,Vec y) 908421e10b8SBarry Smith { 909421e10b8SBarry Smith PC_FieldSplit *jac = (PC_FieldSplit*)pc->data; 910421e10b8SBarry Smith PetscErrorCode ierr; 911421e10b8SBarry Smith PC_FieldSplitLink ilink = jac->head; 912939b8a20SBarry Smith PetscInt bs; 913421e10b8SBarry Smith 914421e10b8SBarry Smith PetscFunctionBegin; 915421e10b8SBarry Smith CHKMEMQ; 916421e10b8SBarry Smith if (jac->type == PC_COMPOSITE_ADDITIVE) { 917421e10b8SBarry Smith if (jac->defaultsplit) { 918939b8a20SBarry Smith ierr = VecGetBlockSize(x,&bs);CHKERRQ(ierr); 919ce94432eSBarry Smith if (jac->bs > 0 && bs != jac->bs) SETERRQ2(PetscObjectComm((PetscObject)pc),PETSC_ERR_ARG_WRONGSTATE,"Blocksize of x vector %D does not match fieldsplit blocksize %D",bs,jac->bs); 920939b8a20SBarry Smith ierr = VecGetBlockSize(y,&bs);CHKERRQ(ierr); 921ce94432eSBarry Smith if (jac->bs > 0 && bs != jac->bs) SETERRQ2(PetscObjectComm((PetscObject)pc),PETSC_ERR_ARG_WRONGSTATE,"Blocksize of y vector %D does not match fieldsplit blocksize %D",bs,jac->bs); 922421e10b8SBarry Smith ierr = VecStrideGatherAll(x,jac->x,INSERT_VALUES);CHKERRQ(ierr); 923421e10b8SBarry Smith while (ilink) { 924421e10b8SBarry Smith ierr = KSPSolveTranspose(ilink->ksp,ilink->x,ilink->y);CHKERRQ(ierr); 925421e10b8SBarry Smith ilink = ilink->next; 926421e10b8SBarry Smith } 927421e10b8SBarry Smith ierr = VecStrideScatterAll(jac->y,y,INSERT_VALUES);CHKERRQ(ierr); 928421e10b8SBarry Smith } else { 929421e10b8SBarry Smith ierr = VecSet(y,0.0);CHKERRQ(ierr); 930421e10b8SBarry Smith while (ilink) { 931421e10b8SBarry Smith ierr = FieldSplitSplitSolveAddTranspose(ilink,x,y);CHKERRQ(ierr); 932421e10b8SBarry Smith ilink = ilink->next; 933421e10b8SBarry Smith } 934421e10b8SBarry Smith } 935421e10b8SBarry Smith } else { 936421e10b8SBarry Smith if (!jac->w1) { 937421e10b8SBarry Smith ierr = VecDuplicate(x,&jac->w1);CHKERRQ(ierr); 938421e10b8SBarry Smith ierr = VecDuplicate(x,&jac->w2);CHKERRQ(ierr); 939421e10b8SBarry Smith } 940421e10b8SBarry Smith ierr = VecSet(y,0.0);CHKERRQ(ierr); 941421e10b8SBarry Smith if (jac->type == PC_COMPOSITE_SYMMETRIC_MULTIPLICATIVE) { 942421e10b8SBarry Smith ierr = FieldSplitSplitSolveAddTranspose(ilink,x,y);CHKERRQ(ierr); 943421e10b8SBarry Smith while (ilink->next) { 944421e10b8SBarry Smith ilink = ilink->next; 9459989ab13SBarry Smith ierr = MatMultTranspose(pc->mat,y,jac->w1);CHKERRQ(ierr); 946421e10b8SBarry Smith ierr = VecWAXPY(jac->w2,-1.0,jac->w1,x);CHKERRQ(ierr); 947421e10b8SBarry Smith ierr = FieldSplitSplitSolveAddTranspose(ilink,jac->w2,y);CHKERRQ(ierr); 948421e10b8SBarry Smith } 949421e10b8SBarry Smith while (ilink->previous) { 950421e10b8SBarry Smith ilink = ilink->previous; 9519989ab13SBarry Smith ierr = MatMultTranspose(pc->mat,y,jac->w1);CHKERRQ(ierr); 952421e10b8SBarry Smith ierr = VecWAXPY(jac->w2,-1.0,jac->w1,x);CHKERRQ(ierr); 953421e10b8SBarry Smith ierr = FieldSplitSplitSolveAddTranspose(ilink,jac->w2,y);CHKERRQ(ierr); 954421e10b8SBarry Smith } 955421e10b8SBarry Smith } else { 956421e10b8SBarry Smith while (ilink->next) { /* get to last entry in linked list */ 957421e10b8SBarry Smith ilink = ilink->next; 958421e10b8SBarry Smith } 959421e10b8SBarry Smith ierr = FieldSplitSplitSolveAddTranspose(ilink,x,y);CHKERRQ(ierr); 960421e10b8SBarry Smith while (ilink->previous) { 961421e10b8SBarry Smith ilink = ilink->previous; 9629989ab13SBarry Smith ierr = MatMultTranspose(pc->mat,y,jac->w1);CHKERRQ(ierr); 963421e10b8SBarry Smith ierr = VecWAXPY(jac->w2,-1.0,jac->w1,x);CHKERRQ(ierr); 964421e10b8SBarry Smith ierr = FieldSplitSplitSolveAddTranspose(ilink,jac->w2,y);CHKERRQ(ierr); 965421e10b8SBarry Smith } 966421e10b8SBarry Smith } 967421e10b8SBarry Smith } 968421e10b8SBarry Smith CHKMEMQ; 969421e10b8SBarry Smith PetscFunctionReturn(0); 970421e10b8SBarry Smith } 971421e10b8SBarry Smith 9720971522cSBarry Smith #undef __FUNCT__ 973574deadeSBarry Smith #define __FUNCT__ "PCReset_FieldSplit" 974574deadeSBarry Smith static PetscErrorCode PCReset_FieldSplit(PC pc) 9750971522cSBarry Smith { 9760971522cSBarry Smith PC_FieldSplit *jac = (PC_FieldSplit*)pc->data; 9770971522cSBarry Smith PetscErrorCode ierr; 9785a9f2f41SSatish Balay PC_FieldSplitLink ilink = jac->head,next; 9790971522cSBarry Smith 9800971522cSBarry Smith PetscFunctionBegin; 9815a9f2f41SSatish Balay while (ilink) { 982574deadeSBarry Smith ierr = KSPReset(ilink->ksp);CHKERRQ(ierr); 983fcfd50ebSBarry Smith ierr = VecDestroy(&ilink->x);CHKERRQ(ierr); 984fcfd50ebSBarry Smith ierr = VecDestroy(&ilink->y);CHKERRQ(ierr); 985443836d0SMatthew G Knepley ierr = VecDestroy(&ilink->z);CHKERRQ(ierr); 986fcfd50ebSBarry Smith ierr = VecScatterDestroy(&ilink->sctx);CHKERRQ(ierr); 987fcfd50ebSBarry Smith ierr = ISDestroy(&ilink->is);CHKERRQ(ierr); 988b5787286SJed Brown ierr = ISDestroy(&ilink->is_col);CHKERRQ(ierr); 9895a9f2f41SSatish Balay next = ilink->next; 9905a9f2f41SSatish Balay ilink = next; 9910971522cSBarry Smith } 99205b42c5fSBarry Smith ierr = PetscFree2(jac->x,jac->y);CHKERRQ(ierr); 993574deadeSBarry Smith if (jac->mat && jac->mat != jac->pmat) { 994574deadeSBarry Smith ierr = MatDestroyMatrices(jac->nsplits,&jac->mat);CHKERRQ(ierr); 995574deadeSBarry Smith } else if (jac->mat) { 9960298fd71SBarry Smith jac->mat = NULL; 997574deadeSBarry Smith } 99897bbdb24SBarry Smith if (jac->pmat) {ierr = MatDestroyMatrices(jac->nsplits,&jac->pmat);CHKERRQ(ierr);} 99968dd23aaSBarry Smith if (jac->Afield) {ierr = MatDestroyMatrices(jac->nsplits,&jac->Afield);CHKERRQ(ierr);} 10006bf464f9SBarry Smith ierr = VecDestroy(&jac->w1);CHKERRQ(ierr); 10016bf464f9SBarry Smith ierr = VecDestroy(&jac->w2);CHKERRQ(ierr); 10026bf464f9SBarry Smith ierr = MatDestroy(&jac->schur);CHKERRQ(ierr); 10036bf464f9SBarry Smith ierr = MatDestroy(&jac->schur_user);CHKERRQ(ierr); 10046bf464f9SBarry Smith ierr = KSPDestroy(&jac->kspschur);CHKERRQ(ierr); 1005d78dad28SBarry Smith ierr = KSPDestroy(&jac->kspupper);CHKERRQ(ierr); 10066bf464f9SBarry Smith ierr = MatDestroy(&jac->B);CHKERRQ(ierr); 10076bf464f9SBarry Smith ierr = MatDestroy(&jac->C);CHKERRQ(ierr); 100863ec74ffSBarry Smith jac->reset = PETSC_TRUE; 1009574deadeSBarry Smith PetscFunctionReturn(0); 1010574deadeSBarry Smith } 1011574deadeSBarry Smith 1012574deadeSBarry Smith #undef __FUNCT__ 1013574deadeSBarry Smith #define __FUNCT__ "PCDestroy_FieldSplit" 1014574deadeSBarry Smith static PetscErrorCode PCDestroy_FieldSplit(PC pc) 1015574deadeSBarry Smith { 1016574deadeSBarry Smith PC_FieldSplit *jac = (PC_FieldSplit*)pc->data; 1017574deadeSBarry Smith PetscErrorCode ierr; 1018574deadeSBarry Smith PC_FieldSplitLink ilink = jac->head,next; 1019574deadeSBarry Smith 1020574deadeSBarry Smith PetscFunctionBegin; 1021574deadeSBarry Smith ierr = PCReset_FieldSplit(pc);CHKERRQ(ierr); 1022574deadeSBarry Smith while (ilink) { 10236bf464f9SBarry Smith ierr = KSPDestroy(&ilink->ksp);CHKERRQ(ierr); 1024574deadeSBarry Smith next = ilink->next; 1025574deadeSBarry Smith ierr = PetscFree(ilink->splitname);CHKERRQ(ierr); 1026574deadeSBarry Smith ierr = PetscFree(ilink->fields);CHKERRQ(ierr); 10275d4c12cdSJungho Lee ierr = PetscFree(ilink->fields_col);CHKERRQ(ierr); 1028574deadeSBarry Smith ierr = PetscFree(ilink);CHKERRQ(ierr); 1029574deadeSBarry Smith ilink = next; 1030574deadeSBarry Smith } 1031574deadeSBarry Smith ierr = PetscFree2(jac->x,jac->y);CHKERRQ(ierr); 1032c31cb41cSBarry Smith ierr = PetscFree(pc->data);CHKERRQ(ierr); 10330298fd71SBarry Smith ierr = PetscObjectComposeFunctionDynamic((PetscObject)pc,"PCFieldSplitGetSubKSP_C","",NULL);CHKERRQ(ierr); 10340298fd71SBarry Smith ierr = PetscObjectComposeFunctionDynamic((PetscObject)pc,"PCFieldSplitSetFields_C","",NULL);CHKERRQ(ierr); 10350298fd71SBarry Smith ierr = PetscObjectComposeFunctionDynamic((PetscObject)pc,"PCFieldSplitSetIS_C","",NULL);CHKERRQ(ierr); 10360298fd71SBarry Smith ierr = PetscObjectComposeFunctionDynamic((PetscObject)pc,"PCFieldSplitSetType_C","",NULL);CHKERRQ(ierr); 10370298fd71SBarry Smith ierr = PetscObjectComposeFunctionDynamic((PetscObject)pc,"PCFieldSplitSetBlockSize_C","",NULL);CHKERRQ(ierr); 10380298fd71SBarry Smith ierr = PetscObjectComposeFunctionDynamic((PetscObject)pc,"PCFieldSplitSchurPrecondition_C","",NULL);CHKERRQ(ierr); 10390298fd71SBarry Smith ierr = PetscObjectComposeFunctionDynamic((PetscObject)pc,"PCFieldSplitSetSchurFactType_C","",NULL);CHKERRQ(ierr); 10400971522cSBarry Smith PetscFunctionReturn(0); 10410971522cSBarry Smith } 10420971522cSBarry Smith 10430971522cSBarry Smith #undef __FUNCT__ 10440971522cSBarry Smith #define __FUNCT__ "PCSetFromOptions_FieldSplit" 10450971522cSBarry Smith static PetscErrorCode PCSetFromOptions_FieldSplit(PC pc) 10460971522cSBarry Smith { 10471b9fc7fcSBarry Smith PetscErrorCode ierr; 10486c924f48SJed Brown PetscInt bs; 1049bc59fbc5SBarry Smith PetscBool flg,stokes = PETSC_FALSE; 10509dcbbd2bSBarry Smith PC_FieldSplit *jac = (PC_FieldSplit*)pc->data; 10513b224e63SBarry Smith PCCompositeType ctype; 10521b9fc7fcSBarry Smith 10530971522cSBarry Smith PetscFunctionBegin; 10541b9fc7fcSBarry Smith ierr = PetscOptionsHead("FieldSplit options");CHKERRQ(ierr); 10550298fd71SBarry Smith ierr = PetscOptionsBool("-pc_fieldsplit_real_diagonal","Use diagonal blocks of the operator","PCFieldSplitSetRealDiagonal",jac->realdiagonal,&jac->realdiagonal,NULL);CHKERRQ(ierr); 1056*4ab8060aSDmitry Karpeev ierr = PetscOptionsBool("-pc_fieldsplit_dm_splits","Whether to use DMCreateFieldDecomposition() for splits","PCFieldSplitSetDMSplits",jac->dm_splits,&jac->dm_splits,NULL);CHKERRQ(ierr); 105751f519a2SBarry Smith ierr = PetscOptionsInt("-pc_fieldsplit_block_size","Blocksize that defines number of fields","PCFieldSplitSetBlockSize",jac->bs,&bs,&flg);CHKERRQ(ierr); 105851f519a2SBarry Smith if (flg) { 105951f519a2SBarry Smith ierr = PCFieldSplitSetBlockSize(pc,bs);CHKERRQ(ierr); 106051f519a2SBarry Smith } 1061704ba839SBarry Smith 10620298fd71SBarry Smith ierr = PetscOptionsGetBool(((PetscObject)pc)->prefix,"-pc_fieldsplit_detect_saddle_point",&stokes,NULL);CHKERRQ(ierr); 1063c0adfefeSBarry Smith if (stokes) { 1064c0adfefeSBarry Smith ierr = PCFieldSplitSetType(pc,PC_COMPOSITE_SCHUR);CHKERRQ(ierr); 1065c0adfefeSBarry Smith jac->schurpre = PC_FIELDSPLIT_SCHUR_PRE_SELF; 1066c0adfefeSBarry Smith } 1067c0adfefeSBarry Smith 10683b224e63SBarry Smith ierr = PetscOptionsEnum("-pc_fieldsplit_type","Type of composition","PCFieldSplitSetType",PCCompositeTypes,(PetscEnum)jac->type,(PetscEnum*)&ctype,&flg);CHKERRQ(ierr); 10693b224e63SBarry Smith if (flg) { 10703b224e63SBarry Smith ierr = PCFieldSplitSetType(pc,ctype);CHKERRQ(ierr); 10713b224e63SBarry Smith } 1072c30613efSMatthew Knepley /* Only setup fields once */ 1073c30613efSMatthew Knepley if ((jac->bs > 0) && (jac->nsplits == 0)) { 1074d32f9abdSBarry Smith /* only allow user to set fields from command line if bs is already known. 1075d32f9abdSBarry Smith otherwise user can set them in PCFieldSplitSetDefaults() */ 10766c924f48SJed Brown ierr = PCFieldSplitSetRuntimeSplits_Private(pc);CHKERRQ(ierr); 10776c924f48SJed Brown if (jac->splitdefined) {ierr = PetscInfo(pc,"Splits defined using the options database\n");CHKERRQ(ierr);} 1078d32f9abdSBarry Smith } 1079c5d2311dSJed Brown if (jac->type == PC_COMPOSITE_SCHUR) { 1080c9c6ffaaSJed Brown ierr = PetscOptionsGetEnum(((PetscObject)pc)->prefix,"-pc_fieldsplit_schur_factorization_type",PCFieldSplitSchurFactTypes,(PetscEnum*)&jac->schurfactorization,&flg);CHKERRQ(ierr); 1081c9c6ffaaSJed Brown if (flg) {ierr = PetscInfo(pc,"Deprecated use of -pc_fieldsplit_schur_factorization_type\n");CHKERRQ(ierr);} 10820298fd71SBarry Smith 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,NULL);CHKERRQ(ierr); 10830298fd71SBarry Smith ierr = PetscOptionsEnum("-pc_fieldsplit_schur_precondition","How to build preconditioner for Schur complement","PCFieldSplitSchurPrecondition",PCFieldSplitSchurPreTypes,(PetscEnum)jac->schurpre,(PetscEnum*)&jac->schurpre,NULL);CHKERRQ(ierr); 1084c5d2311dSJed Brown } 10851b9fc7fcSBarry Smith ierr = PetscOptionsTail();CHKERRQ(ierr); 10860971522cSBarry Smith PetscFunctionReturn(0); 10870971522cSBarry Smith } 10880971522cSBarry Smith 10890971522cSBarry Smith /*------------------------------------------------------------------------------------*/ 10900971522cSBarry Smith 10910971522cSBarry Smith EXTERN_C_BEGIN 10920971522cSBarry Smith #undef __FUNCT__ 10930971522cSBarry Smith #define __FUNCT__ "PCFieldSplitSetFields_FieldSplit" 10945d4c12cdSJungho Lee PetscErrorCode PCFieldSplitSetFields_FieldSplit(PC pc,const char splitname[],PetscInt n,const PetscInt *fields,const PetscInt *fields_col) 10950971522cSBarry Smith { 109697bbdb24SBarry Smith PC_FieldSplit *jac = (PC_FieldSplit*)pc->data; 10970971522cSBarry Smith PetscErrorCode ierr; 10985a9f2f41SSatish Balay PC_FieldSplitLink ilink,next = jac->head; 109969a612a9SBarry Smith char prefix[128]; 11005d4c12cdSJungho Lee PetscInt i; 11010971522cSBarry Smith 11020971522cSBarry Smith PetscFunctionBegin; 11036c924f48SJed Brown if (jac->splitdefined) { 11046c924f48SJed Brown ierr = PetscInfo1(pc,"Ignoring new split \"%s\" because the splits have already been defined\n",splitname);CHKERRQ(ierr); 11056c924f48SJed Brown PetscFunctionReturn(0); 11066c924f48SJed Brown } 110751f519a2SBarry Smith for (i=0; i<n; i++) { 1108e32f2f54SBarry 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); 1109e32f2f54SBarry Smith if (fields[i] < 0) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Negative field %D requested",fields[i]); 111051f519a2SBarry Smith } 1111704ba839SBarry Smith ierr = PetscNew(struct _PC_FieldSplitLink,&ilink);CHKERRQ(ierr); 1112a04f6461SBarry Smith if (splitname) { 1113db4c96c1SJed Brown ierr = PetscStrallocpy(splitname,&ilink->splitname);CHKERRQ(ierr); 1114a04f6461SBarry Smith } else { 1115a04f6461SBarry Smith ierr = PetscMalloc(3*sizeof(char),&ilink->splitname);CHKERRQ(ierr); 1116a04f6461SBarry Smith ierr = PetscSNPrintf(ilink->splitname,2,"%s",jac->nsplits);CHKERRQ(ierr); 1117a04f6461SBarry Smith } 1118704ba839SBarry Smith ierr = PetscMalloc(n*sizeof(PetscInt),&ilink->fields);CHKERRQ(ierr); 11195a9f2f41SSatish Balay ierr = PetscMemcpy(ilink->fields,fields,n*sizeof(PetscInt));CHKERRQ(ierr); 11205d4c12cdSJungho Lee ierr = PetscMalloc(n*sizeof(PetscInt),&ilink->fields_col);CHKERRQ(ierr); 11215d4c12cdSJungho Lee ierr = PetscMemcpy(ilink->fields_col,fields_col,n*sizeof(PetscInt));CHKERRQ(ierr); 11222fa5cd67SKarl Rupp 11235a9f2f41SSatish Balay ilink->nfields = n; 11240298fd71SBarry Smith ilink->next = NULL; 1125ce94432eSBarry Smith ierr = KSPCreate(PetscObjectComm((PetscObject)pc),&ilink->ksp);CHKERRQ(ierr); 112620252d06SBarry Smith ierr = PetscObjectIncrementTabLevel((PetscObject)ilink->ksp,(PetscObject)pc,1);CHKERRQ(ierr); 11275a9f2f41SSatish Balay ierr = KSPSetType(ilink->ksp,KSPPREONLY);CHKERRQ(ierr); 11289005cf84SBarry Smith ierr = PetscLogObjectParent((PetscObject)pc,(PetscObject)ilink->ksp);CHKERRQ(ierr); 112969a612a9SBarry Smith 11308caf3d72SBarry Smith ierr = PetscSNPrintf(prefix,sizeof(prefix),"%sfieldsplit_%s_",((PetscObject)pc)->prefix ? ((PetscObject)pc)->prefix : "",ilink->splitname);CHKERRQ(ierr); 11315a9f2f41SSatish Balay ierr = KSPSetOptionsPrefix(ilink->ksp,prefix);CHKERRQ(ierr); 11320971522cSBarry Smith 11330971522cSBarry Smith if (!next) { 11345a9f2f41SSatish Balay jac->head = ilink; 11350298fd71SBarry Smith ilink->previous = NULL; 11360971522cSBarry Smith } else { 11370971522cSBarry Smith while (next->next) { 11380971522cSBarry Smith next = next->next; 11390971522cSBarry Smith } 11405a9f2f41SSatish Balay next->next = ilink; 114151f519a2SBarry Smith ilink->previous = next; 11420971522cSBarry Smith } 11430971522cSBarry Smith jac->nsplits++; 11440971522cSBarry Smith PetscFunctionReturn(0); 11450971522cSBarry Smith } 11460971522cSBarry Smith EXTERN_C_END 11470971522cSBarry Smith 1148e69d4d44SBarry Smith EXTERN_C_BEGIN 1149e69d4d44SBarry Smith #undef __FUNCT__ 1150e69d4d44SBarry Smith #define __FUNCT__ "PCFieldSplitGetSubKSP_FieldSplit_Schur" 11517087cfbeSBarry Smith PetscErrorCode PCFieldSplitGetSubKSP_FieldSplit_Schur(PC pc,PetscInt *n,KSP **subksp) 1152e69d4d44SBarry Smith { 1153e69d4d44SBarry Smith PC_FieldSplit *jac = (PC_FieldSplit*)pc->data; 1154e69d4d44SBarry Smith PetscErrorCode ierr; 1155e69d4d44SBarry Smith 1156e69d4d44SBarry Smith PetscFunctionBegin; 1157519d70e2SJed Brown ierr = PetscMalloc(jac->nsplits*sizeof(KSP),subksp);CHKERRQ(ierr); 1158e69d4d44SBarry Smith ierr = MatSchurComplementGetKSP(jac->schur,*subksp);CHKERRQ(ierr); 11592fa5cd67SKarl Rupp 1160e69d4d44SBarry Smith (*subksp)[1] = jac->kspschur; 116113e0d083SBarry Smith if (n) *n = jac->nsplits; 1162e69d4d44SBarry Smith PetscFunctionReturn(0); 1163e69d4d44SBarry Smith } 1164e69d4d44SBarry Smith EXTERN_C_END 11650971522cSBarry Smith 11660971522cSBarry Smith EXTERN_C_BEGIN 11670971522cSBarry Smith #undef __FUNCT__ 116869a612a9SBarry Smith #define __FUNCT__ "PCFieldSplitGetSubKSP_FieldSplit" 11697087cfbeSBarry Smith PetscErrorCode PCFieldSplitGetSubKSP_FieldSplit(PC pc,PetscInt *n,KSP **subksp) 11700971522cSBarry Smith { 11710971522cSBarry Smith PC_FieldSplit *jac = (PC_FieldSplit*)pc->data; 11720971522cSBarry Smith PetscErrorCode ierr; 11730971522cSBarry Smith PetscInt cnt = 0; 11745a9f2f41SSatish Balay PC_FieldSplitLink ilink = jac->head; 11750971522cSBarry Smith 11760971522cSBarry Smith PetscFunctionBegin; 11775d480477SMatthew G Knepley ierr = PetscMalloc(jac->nsplits*sizeof(KSP),subksp);CHKERRQ(ierr); 11785a9f2f41SSatish Balay while (ilink) { 11795a9f2f41SSatish Balay (*subksp)[cnt++] = ilink->ksp; 11805a9f2f41SSatish Balay ilink = ilink->next; 11810971522cSBarry Smith } 11825d480477SMatthew 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); 118313e0d083SBarry Smith if (n) *n = jac->nsplits; 11840971522cSBarry Smith PetscFunctionReturn(0); 11850971522cSBarry Smith } 11860971522cSBarry Smith EXTERN_C_END 11870971522cSBarry Smith 1188704ba839SBarry Smith EXTERN_C_BEGIN 1189704ba839SBarry Smith #undef __FUNCT__ 1190704ba839SBarry Smith #define __FUNCT__ "PCFieldSplitSetIS_FieldSplit" 11917087cfbeSBarry Smith PetscErrorCode PCFieldSplitSetIS_FieldSplit(PC pc,const char splitname[],IS is) 1192704ba839SBarry Smith { 1193704ba839SBarry Smith PC_FieldSplit *jac = (PC_FieldSplit*)pc->data; 1194704ba839SBarry Smith PetscErrorCode ierr; 1195704ba839SBarry Smith PC_FieldSplitLink ilink, next = jac->head; 1196704ba839SBarry Smith char prefix[128]; 1197704ba839SBarry Smith 1198704ba839SBarry Smith PetscFunctionBegin; 11996c924f48SJed Brown if (jac->splitdefined) { 12006c924f48SJed Brown ierr = PetscInfo1(pc,"Ignoring new split \"%s\" because the splits have already been defined\n",splitname);CHKERRQ(ierr); 12016c924f48SJed Brown PetscFunctionReturn(0); 12026c924f48SJed Brown } 120316913363SBarry Smith ierr = PetscNew(struct _PC_FieldSplitLink,&ilink);CHKERRQ(ierr); 1204a04f6461SBarry Smith if (splitname) { 1205db4c96c1SJed Brown ierr = PetscStrallocpy(splitname,&ilink->splitname);CHKERRQ(ierr); 1206a04f6461SBarry Smith } else { 1207b5787286SJed Brown ierr = PetscMalloc(8*sizeof(char),&ilink->splitname);CHKERRQ(ierr); 1208b5787286SJed Brown ierr = PetscSNPrintf(ilink->splitname,7,"%D",jac->nsplits);CHKERRQ(ierr); 1209a04f6461SBarry Smith } 12101ab39975SBarry Smith ierr = PetscObjectReference((PetscObject)is);CHKERRQ(ierr); 1211b5787286SJed Brown ierr = ISDestroy(&ilink->is);CHKERRQ(ierr); 1212b5787286SJed Brown ilink->is = is; 1213b5787286SJed Brown ierr = PetscObjectReference((PetscObject)is);CHKERRQ(ierr); 1214b5787286SJed Brown ierr = ISDestroy(&ilink->is_col);CHKERRQ(ierr); 1215b5787286SJed Brown ilink->is_col = is; 12160298fd71SBarry Smith ilink->next = NULL; 1217ce94432eSBarry Smith ierr = KSPCreate(PetscObjectComm((PetscObject)pc),&ilink->ksp);CHKERRQ(ierr); 121820252d06SBarry Smith ierr = PetscObjectIncrementTabLevel((PetscObject)ilink->ksp,(PetscObject)pc,1);CHKERRQ(ierr); 1219704ba839SBarry Smith ierr = KSPSetType(ilink->ksp,KSPPREONLY);CHKERRQ(ierr); 12209005cf84SBarry Smith ierr = PetscLogObjectParent((PetscObject)pc,(PetscObject)ilink->ksp);CHKERRQ(ierr); 1221704ba839SBarry Smith 12228caf3d72SBarry Smith ierr = PetscSNPrintf(prefix,sizeof(prefix),"%sfieldsplit_%s_",((PetscObject)pc)->prefix ? ((PetscObject)pc)->prefix : "",ilink->splitname);CHKERRQ(ierr); 1223704ba839SBarry Smith ierr = KSPSetOptionsPrefix(ilink->ksp,prefix);CHKERRQ(ierr); 1224704ba839SBarry Smith 1225704ba839SBarry Smith if (!next) { 1226704ba839SBarry Smith jac->head = ilink; 12270298fd71SBarry Smith ilink->previous = NULL; 1228704ba839SBarry Smith } else { 1229704ba839SBarry Smith while (next->next) { 1230704ba839SBarry Smith next = next->next; 1231704ba839SBarry Smith } 1232704ba839SBarry Smith next->next = ilink; 1233704ba839SBarry Smith ilink->previous = next; 1234704ba839SBarry Smith } 1235704ba839SBarry Smith jac->nsplits++; 1236704ba839SBarry Smith PetscFunctionReturn(0); 1237704ba839SBarry Smith } 1238704ba839SBarry Smith EXTERN_C_END 1239704ba839SBarry Smith 12400971522cSBarry Smith #undef __FUNCT__ 12410971522cSBarry Smith #define __FUNCT__ "PCFieldSplitSetFields" 12420971522cSBarry Smith /*@ 12430971522cSBarry Smith PCFieldSplitSetFields - Sets the fields for one particular split in the field split preconditioner 12440971522cSBarry Smith 1245ad4df100SBarry Smith Logically Collective on PC 12460971522cSBarry Smith 12470971522cSBarry Smith Input Parameters: 12480971522cSBarry Smith + pc - the preconditioner context 12490298fd71SBarry Smith . splitname - name of this split, if NULL the number of the split is used 12500971522cSBarry Smith . n - the number of fields in this split 1251db4c96c1SJed Brown - fields - the fields in this split 12520971522cSBarry Smith 12530971522cSBarry Smith Level: intermediate 12540971522cSBarry Smith 1255d32f9abdSBarry Smith Notes: Use PCFieldSplitSetIS() to set a completely general set of indices as a field. 1256d32f9abdSBarry Smith 12577287d2a3SDmitry Karpeev The PCFieldSplitSetFields() is for defining fields as strided blocks. For example, if the block 1258d32f9abdSBarry 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 1259d32f9abdSBarry Smith 0xx3xx6xx9xx12 ... x1xx4xx7xx ... xx2xx5xx8xx.. 01x34x67x... 0x1x3x5x7.. x12x45x78x.... 1260d32f9abdSBarry Smith where the numbered entries indicate what is in the field. 1261d32f9abdSBarry Smith 1262db4c96c1SJed Brown This function is called once per split (it creates a new split each time). Solve options 1263db4c96c1SJed Brown for this split will be available under the prefix -fieldsplit_SPLITNAME_. 1264db4c96c1SJed Brown 12655d4c12cdSJungho Lee Developer Note: This routine does not actually create the IS representing the split, that is delayed 12665d4c12cdSJungho Lee until PCSetUp_FieldSplit(), because information about the vector/matrix layouts may not be 12675d4c12cdSJungho Lee available when this routine is called. 12685d4c12cdSJungho Lee 1269d32f9abdSBarry Smith .seealso: PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitSetBlockSize(), PCFieldSplitSetIS() 12700971522cSBarry Smith 12710971522cSBarry Smith @*/ 12725d4c12cdSJungho Lee PetscErrorCode PCFieldSplitSetFields(PC pc,const char splitname[],PetscInt n,const PetscInt *fields,const PetscInt *fields_col) 12730971522cSBarry Smith { 12744ac538c5SBarry Smith PetscErrorCode ierr; 12750971522cSBarry Smith 12760971522cSBarry Smith PetscFunctionBegin; 12770700a824SBarry Smith PetscValidHeaderSpecific(pc,PC_CLASSID,1); 1278db4c96c1SJed Brown PetscValidCharPointer(splitname,2); 1279ce94432eSBarry Smith if (n < 1) SETERRQ2(PetscObjectComm((PetscObject)pc),PETSC_ERR_ARG_OUTOFRANGE,"Provided number of fields %D in split \"%s\" not positive",n,splitname); 1280db4c96c1SJed Brown PetscValidIntPointer(fields,3); 12815d4c12cdSJungho Lee ierr = PetscTryMethod(pc,"PCFieldSplitSetFields_C",(PC,const char[],PetscInt,const PetscInt*,const PetscInt*),(pc,splitname,n,fields,fields_col));CHKERRQ(ierr); 12820971522cSBarry Smith PetscFunctionReturn(0); 12830971522cSBarry Smith } 12840971522cSBarry Smith 12850971522cSBarry Smith #undef __FUNCT__ 1286704ba839SBarry Smith #define __FUNCT__ "PCFieldSplitSetIS" 1287704ba839SBarry Smith /*@ 1288704ba839SBarry Smith PCFieldSplitSetIS - Sets the exact elements for field 1289704ba839SBarry Smith 1290ad4df100SBarry Smith Logically Collective on PC 1291704ba839SBarry Smith 1292704ba839SBarry Smith Input Parameters: 1293704ba839SBarry Smith + pc - the preconditioner context 12940298fd71SBarry Smith . splitname - name of this split, if NULL the number of the split is used 1295db4c96c1SJed Brown - is - the index set that defines the vector elements in this field 1296704ba839SBarry Smith 1297d32f9abdSBarry Smith 1298a6ffb8dbSJed Brown Notes: 1299a6ffb8dbSJed Brown Use PCFieldSplitSetFields(), for fields defined by strided types. 1300a6ffb8dbSJed Brown 1301db4c96c1SJed Brown This function is called once per split (it creates a new split each time). Solve options 1302db4c96c1SJed Brown for this split will be available under the prefix -fieldsplit_SPLITNAME_. 1303d32f9abdSBarry Smith 1304704ba839SBarry Smith Level: intermediate 1305704ba839SBarry Smith 1306704ba839SBarry Smith .seealso: PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitSetBlockSize() 1307704ba839SBarry Smith 1308704ba839SBarry Smith @*/ 13097087cfbeSBarry Smith PetscErrorCode PCFieldSplitSetIS(PC pc,const char splitname[],IS is) 1310704ba839SBarry Smith { 13114ac538c5SBarry Smith PetscErrorCode ierr; 1312704ba839SBarry Smith 1313704ba839SBarry Smith PetscFunctionBegin; 13140700a824SBarry Smith PetscValidHeaderSpecific(pc,PC_CLASSID,1); 13157b62db95SJungho Lee if (splitname) PetscValidCharPointer(splitname,2); 1316db4c96c1SJed Brown PetscValidHeaderSpecific(is,IS_CLASSID,3); 13174ac538c5SBarry Smith ierr = PetscTryMethod(pc,"PCFieldSplitSetIS_C",(PC,const char[],IS),(pc,splitname,is));CHKERRQ(ierr); 1318704ba839SBarry Smith PetscFunctionReturn(0); 1319704ba839SBarry Smith } 1320704ba839SBarry Smith 1321704ba839SBarry Smith #undef __FUNCT__ 132257a9adfeSMatthew G Knepley #define __FUNCT__ "PCFieldSplitGetIS" 132357a9adfeSMatthew G Knepley /*@ 132457a9adfeSMatthew G Knepley PCFieldSplitGetIS - Retrieves the elements for a field as an IS 132557a9adfeSMatthew G Knepley 132657a9adfeSMatthew G Knepley Logically Collective on PC 132757a9adfeSMatthew G Knepley 132857a9adfeSMatthew G Knepley Input Parameters: 132957a9adfeSMatthew G Knepley + pc - the preconditioner context 133057a9adfeSMatthew G Knepley - splitname - name of this split 133157a9adfeSMatthew G Knepley 133257a9adfeSMatthew G Knepley Output Parameter: 13330298fd71SBarry Smith - is - the index set that defines the vector elements in this field, or NULL if the field is not found 133457a9adfeSMatthew G Knepley 133557a9adfeSMatthew G Knepley Level: intermediate 133657a9adfeSMatthew G Knepley 133757a9adfeSMatthew G Knepley .seealso: PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitSetIS() 133857a9adfeSMatthew G Knepley 133957a9adfeSMatthew G Knepley @*/ 134057a9adfeSMatthew G Knepley PetscErrorCode PCFieldSplitGetIS(PC pc,const char splitname[],IS *is) 134157a9adfeSMatthew G Knepley { 134257a9adfeSMatthew G Knepley PetscErrorCode ierr; 134357a9adfeSMatthew G Knepley 134457a9adfeSMatthew G Knepley PetscFunctionBegin; 134557a9adfeSMatthew G Knepley PetscValidHeaderSpecific(pc,PC_CLASSID,1); 134657a9adfeSMatthew G Knepley PetscValidCharPointer(splitname,2); 134757a9adfeSMatthew G Knepley PetscValidPointer(is,3); 134857a9adfeSMatthew G Knepley { 134957a9adfeSMatthew G Knepley PC_FieldSplit *jac = (PC_FieldSplit*) pc->data; 135057a9adfeSMatthew G Knepley PC_FieldSplitLink ilink = jac->head; 135157a9adfeSMatthew G Knepley PetscBool found; 135257a9adfeSMatthew G Knepley 13530298fd71SBarry Smith *is = NULL; 135457a9adfeSMatthew G Knepley while (ilink) { 135557a9adfeSMatthew G Knepley ierr = PetscStrcmp(ilink->splitname, splitname, &found);CHKERRQ(ierr); 135657a9adfeSMatthew G Knepley if (found) { 135757a9adfeSMatthew G Knepley *is = ilink->is; 135857a9adfeSMatthew G Knepley break; 135957a9adfeSMatthew G Knepley } 136057a9adfeSMatthew G Knepley ilink = ilink->next; 136157a9adfeSMatthew G Knepley } 136257a9adfeSMatthew G Knepley } 136357a9adfeSMatthew G Knepley PetscFunctionReturn(0); 136457a9adfeSMatthew G Knepley } 136557a9adfeSMatthew G Knepley 136657a9adfeSMatthew G Knepley #undef __FUNCT__ 136751f519a2SBarry Smith #define __FUNCT__ "PCFieldSplitSetBlockSize" 136851f519a2SBarry Smith /*@ 136951f519a2SBarry Smith PCFieldSplitSetBlockSize - Sets the block size for defining where fields start in the 137051f519a2SBarry Smith fieldsplit preconditioner. If not set the matrix block size is used. 137151f519a2SBarry Smith 1372ad4df100SBarry Smith Logically Collective on PC 137351f519a2SBarry Smith 137451f519a2SBarry Smith Input Parameters: 137551f519a2SBarry Smith + pc - the preconditioner context 137651f519a2SBarry Smith - bs - the block size 137751f519a2SBarry Smith 137851f519a2SBarry Smith Level: intermediate 137951f519a2SBarry Smith 138051f519a2SBarry Smith .seealso: PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitSetFields() 138151f519a2SBarry Smith 138251f519a2SBarry Smith @*/ 13837087cfbeSBarry Smith PetscErrorCode PCFieldSplitSetBlockSize(PC pc,PetscInt bs) 138451f519a2SBarry Smith { 13854ac538c5SBarry Smith PetscErrorCode ierr; 138651f519a2SBarry Smith 138751f519a2SBarry Smith PetscFunctionBegin; 13880700a824SBarry Smith PetscValidHeaderSpecific(pc,PC_CLASSID,1); 1389c5eb9154SBarry Smith PetscValidLogicalCollectiveInt(pc,bs,2); 13904ac538c5SBarry Smith ierr = PetscTryMethod(pc,"PCFieldSplitSetBlockSize_C",(PC,PetscInt),(pc,bs));CHKERRQ(ierr); 139151f519a2SBarry Smith PetscFunctionReturn(0); 139251f519a2SBarry Smith } 139351f519a2SBarry Smith 139451f519a2SBarry Smith #undef __FUNCT__ 139569a612a9SBarry Smith #define __FUNCT__ "PCFieldSplitGetSubKSP" 13960971522cSBarry Smith /*@C 139769a612a9SBarry Smith PCFieldSplitGetSubKSP - Gets the KSP contexts for all splits 13980971522cSBarry Smith 139969a612a9SBarry Smith Collective on KSP 14000971522cSBarry Smith 14010971522cSBarry Smith Input Parameter: 14020971522cSBarry Smith . pc - the preconditioner context 14030971522cSBarry Smith 14040971522cSBarry Smith Output Parameters: 140513e0d083SBarry Smith + n - the number of splits 140669a612a9SBarry Smith - pc - the array of KSP contexts 14070971522cSBarry Smith 14080971522cSBarry Smith Note: 1409d32f9abdSBarry Smith After PCFieldSplitGetSubKSP() the array of KSPs IS to be freed by the user 1410d32f9abdSBarry Smith (not the KSP just the array that contains them). 14110971522cSBarry Smith 141269a612a9SBarry Smith You must call KSPSetUp() before calling PCFieldSplitGetSubKSP(). 14130971522cSBarry Smith 1414196cc216SBarry Smith Fortran Usage: You must pass in a KSP array that is large enough to contain all the local KSPs. 14150298fd71SBarry Smith You can call PCFieldSplitGetSubKSP(pc,n,NULL_OBJECT,ierr) to determine how large the 1416196cc216SBarry Smith KSP array must be. 1417196cc216SBarry Smith 1418196cc216SBarry Smith 14190971522cSBarry Smith Level: advanced 14200971522cSBarry Smith 14210971522cSBarry Smith .seealso: PCFIELDSPLIT 14220971522cSBarry Smith @*/ 14237087cfbeSBarry Smith PetscErrorCode PCFieldSplitGetSubKSP(PC pc,PetscInt *n,KSP *subksp[]) 14240971522cSBarry Smith { 14254ac538c5SBarry Smith PetscErrorCode ierr; 14260971522cSBarry Smith 14270971522cSBarry Smith PetscFunctionBegin; 14280700a824SBarry Smith PetscValidHeaderSpecific(pc,PC_CLASSID,1); 142913e0d083SBarry Smith if (n) PetscValidIntPointer(n,2); 14304ac538c5SBarry Smith ierr = PetscUseMethod(pc,"PCFieldSplitGetSubKSP_C",(PC,PetscInt*,KSP **),(pc,n,subksp));CHKERRQ(ierr); 14310971522cSBarry Smith PetscFunctionReturn(0); 14320971522cSBarry Smith } 14330971522cSBarry Smith 1434e69d4d44SBarry Smith #undef __FUNCT__ 1435e69d4d44SBarry Smith #define __FUNCT__ "PCFieldSplitSchurPrecondition" 1436e69d4d44SBarry Smith /*@ 1437e69d4d44SBarry Smith PCFieldSplitSchurPrecondition - Indicates if the Schur complement is preconditioned by a preconditioner constructed by the 1438a04f6461SBarry Smith A11 matrix. Otherwise no preconditioner is used. 1439e69d4d44SBarry Smith 1440e69d4d44SBarry Smith Collective on PC 1441e69d4d44SBarry Smith 1442e69d4d44SBarry Smith Input Parameters: 1443e69d4d44SBarry Smith + pc - the preconditioner context 1444e87fab1bSBarry Smith . ptype - which matrix to use for preconditioning the Schur complement, PC_FIELDSPLIT_SCHUR_PRE_A11 (diag) is default 14450298fd71SBarry Smith - userpre - matrix to use for preconditioning, or NULL 1446084e4875SJed Brown 1447e69d4d44SBarry Smith Options Database: 1448e87fab1bSBarry Smith . -pc_fieldsplit_schur_precondition <self,user,a11> default is a11 1449e69d4d44SBarry Smith 1450fd1303e9SJungho Lee Notes: 1451fd1303e9SJungho Lee $ If ptype is 1452fd1303e9SJungho Lee $ user then the preconditioner for the Schur complement is generated by the provided matrix (pre argument 1453fd1303e9SJungho Lee $ to this function). 1454e87fab1bSBarry Smith $ a11 then the preconditioner for the Schur complement is generated by the block diagonal part of the original 1455fd1303e9SJungho Lee $ matrix associated with the Schur complement (i.e. A11) 1456fd1303e9SJungho Lee $ self the preconditioner for the Schur complement is generated from the Schur complement matrix itself: 1457fd1303e9SJungho Lee $ The only preconditioner that currently works directly with the Schur complement matrix object is the PCLSC 1458fd1303e9SJungho Lee $ preconditioner 1459fd1303e9SJungho Lee 1460e87fab1bSBarry Smith When solving a saddle point problem, where the A11 block is identically zero, using a11 as the ptype only makes sense 1461fd1303e9SJungho Lee with the additional option -fieldsplit_1_pc_type none. Usually for saddle point problems one would use a ptype of self and 1462fd1303e9SJungho Lee -fieldsplit_1_pc_type lsc which uses the least squares commutator compute a preconditioner for the Schur complement. 1463fd1303e9SJungho Lee 1464fd1303e9SJungho Lee Developer Notes: This is a terrible name, gives no good indication of what the function does and should also have Set in 1465fd1303e9SJungho Lee the name since it sets a proceedure to use. 1466fd1303e9SJungho Lee 1467e69d4d44SBarry Smith Level: intermediate 1468e69d4d44SBarry Smith 1469fd1303e9SJungho Lee .seealso: PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitSetFields(), PCFieldSplitSchurPreType, PCLSC 1470e69d4d44SBarry Smith 1471e69d4d44SBarry Smith @*/ 14727087cfbeSBarry Smith PetscErrorCode PCFieldSplitSchurPrecondition(PC pc,PCFieldSplitSchurPreType ptype,Mat pre) 1473e69d4d44SBarry Smith { 14744ac538c5SBarry Smith PetscErrorCode ierr; 1475e69d4d44SBarry Smith 1476e69d4d44SBarry Smith PetscFunctionBegin; 14770700a824SBarry Smith PetscValidHeaderSpecific(pc,PC_CLASSID,1); 14784ac538c5SBarry Smith ierr = PetscTryMethod(pc,"PCFieldSplitSchurPrecondition_C",(PC,PCFieldSplitSchurPreType,Mat),(pc,ptype,pre));CHKERRQ(ierr); 1479e69d4d44SBarry Smith PetscFunctionReturn(0); 1480e69d4d44SBarry Smith } 1481e69d4d44SBarry Smith 1482e69d4d44SBarry Smith EXTERN_C_BEGIN 1483e69d4d44SBarry Smith #undef __FUNCT__ 1484e69d4d44SBarry Smith #define __FUNCT__ "PCFieldSplitSchurPrecondition_FieldSplit" 14857087cfbeSBarry Smith PetscErrorCode PCFieldSplitSchurPrecondition_FieldSplit(PC pc,PCFieldSplitSchurPreType ptype,Mat pre) 1486e69d4d44SBarry Smith { 1487e69d4d44SBarry Smith PC_FieldSplit *jac = (PC_FieldSplit*)pc->data; 1488084e4875SJed Brown PetscErrorCode ierr; 1489e69d4d44SBarry Smith 1490e69d4d44SBarry Smith PetscFunctionBegin; 1491084e4875SJed Brown jac->schurpre = ptype; 1492084e4875SJed Brown if (pre) { 14936bf464f9SBarry Smith ierr = MatDestroy(&jac->schur_user);CHKERRQ(ierr); 1494084e4875SJed Brown jac->schur_user = pre; 1495084e4875SJed Brown ierr = PetscObjectReference((PetscObject)jac->schur_user);CHKERRQ(ierr); 1496084e4875SJed Brown } 1497e69d4d44SBarry Smith PetscFunctionReturn(0); 1498e69d4d44SBarry Smith } 1499e69d4d44SBarry Smith EXTERN_C_END 1500e69d4d44SBarry Smith 150130ad9308SMatthew Knepley #undef __FUNCT__ 1502c9c6ffaaSJed Brown #define __FUNCT__ "PCFieldSplitSetSchurFactType" 1503ab1df9f5SJed Brown /*@ 1504c9c6ffaaSJed Brown PCFieldSplitSetSchurFactType - sets which blocks of the approximate block factorization to retain 1505ab1df9f5SJed Brown 1506ab1df9f5SJed Brown Collective on PC 1507ab1df9f5SJed Brown 1508ab1df9f5SJed Brown Input Parameters: 1509ab1df9f5SJed Brown + pc - the preconditioner context 1510c9c6ffaaSJed Brown - ftype - which blocks of factorization to retain, PC_FIELDSPLIT_SCHUR_FACT_FULL is default 1511ab1df9f5SJed Brown 1512ab1df9f5SJed Brown Options Database: 1513c9c6ffaaSJed Brown . -pc_fieldsplit_schur_fact_type <diag,lower,upper,full> default is full 1514ab1df9f5SJed Brown 1515ab1df9f5SJed Brown 1516ab1df9f5SJed Brown Level: intermediate 1517ab1df9f5SJed Brown 1518ab1df9f5SJed Brown Notes: 1519ab1df9f5SJed Brown The FULL factorization is 1520ab1df9f5SJed Brown 1521ab1df9f5SJed Brown $ (A B) = (1 0) (A 0) (1 Ainv*B) 1522ab1df9f5SJed Brown $ (C D) (C*Ainv 1) (0 S) (0 1 ) 1523ab1df9f5SJed Brown 15246be4592eSBarry 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, 15256be4592eSBarry 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). 1526ab1df9f5SJed Brown 15276be4592eSBarry 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 15286be4592eSBarry 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 15296be4592eSBarry 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, 15306be4592eSBarry 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. 1531ab1df9f5SJed Brown 15326be4592eSBarry 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 15336be4592eSBarry 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). 1534ab1df9f5SJed Brown 1535ab1df9f5SJed Brown References: 1536ab1df9f5SJed Brown Murphy, Golub, and Wathen, A note on preconditioning indefinite linear systems, SIAM J. Sci. Comput., 21 (2000) pp. 1969-1972. 1537ab1df9f5SJed Brown 1538ab1df9f5SJed Brown Ipsen, A note on preconditioning nonsymmetric matrices, SIAM J. Sci. Comput., 23 (2001), pp. 1050-1051. 1539ab1df9f5SJed Brown 1540ab1df9f5SJed Brown .seealso: PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitSetFields(), PCFieldSplitSchurPreType 1541ab1df9f5SJed Brown @*/ 1542c9c6ffaaSJed Brown PetscErrorCode PCFieldSplitSetSchurFactType(PC pc,PCFieldSplitSchurFactType ftype) 1543ab1df9f5SJed Brown { 1544ab1df9f5SJed Brown PetscErrorCode ierr; 1545ab1df9f5SJed Brown 1546ab1df9f5SJed Brown PetscFunctionBegin; 1547ab1df9f5SJed Brown PetscValidHeaderSpecific(pc,PC_CLASSID,1); 1548c9c6ffaaSJed Brown ierr = PetscTryMethod(pc,"PCFieldSplitSetSchurFactType_C",(PC,PCFieldSplitSchurFactType),(pc,ftype));CHKERRQ(ierr); 1549ab1df9f5SJed Brown PetscFunctionReturn(0); 1550ab1df9f5SJed Brown } 1551ab1df9f5SJed Brown 1552ab1df9f5SJed Brown #undef __FUNCT__ 1553c9c6ffaaSJed Brown #define __FUNCT__ "PCFieldSplitSetSchurFactType_FieldSplit" 1554c9c6ffaaSJed Brown PETSC_EXTERN_C PetscErrorCode PCFieldSplitSetSchurFactType_FieldSplit(PC pc,PCFieldSplitSchurFactType ftype) 1555ab1df9f5SJed Brown { 1556ab1df9f5SJed Brown PC_FieldSplit *jac = (PC_FieldSplit*)pc->data; 1557ab1df9f5SJed Brown 1558ab1df9f5SJed Brown PetscFunctionBegin; 1559ab1df9f5SJed Brown jac->schurfactorization = ftype; 1560ab1df9f5SJed Brown PetscFunctionReturn(0); 1561ab1df9f5SJed Brown } 1562ab1df9f5SJed Brown 1563ab1df9f5SJed Brown #undef __FUNCT__ 156430ad9308SMatthew Knepley #define __FUNCT__ "PCFieldSplitGetSchurBlocks" 156530ad9308SMatthew Knepley /*@C 15668c03b21aSDmitry Karpeev PCFieldSplitGetSchurBlocks - Gets all matrix blocks for the Schur complement 156730ad9308SMatthew Knepley 156830ad9308SMatthew Knepley Collective on KSP 156930ad9308SMatthew Knepley 157030ad9308SMatthew Knepley Input Parameter: 157130ad9308SMatthew Knepley . pc - the preconditioner context 157230ad9308SMatthew Knepley 157330ad9308SMatthew Knepley Output Parameters: 1574a04f6461SBarry Smith + A00 - the (0,0) block 1575a04f6461SBarry Smith . A01 - the (0,1) block 1576a04f6461SBarry Smith . A10 - the (1,0) block 1577a04f6461SBarry Smith - A11 - the (1,1) block 157830ad9308SMatthew Knepley 157930ad9308SMatthew Knepley Level: advanced 158030ad9308SMatthew Knepley 158130ad9308SMatthew Knepley .seealso: PCFIELDSPLIT 158230ad9308SMatthew Knepley @*/ 1583a04f6461SBarry Smith PetscErrorCode PCFieldSplitGetSchurBlocks(PC pc,Mat *A00,Mat *A01,Mat *A10, Mat *A11) 158430ad9308SMatthew Knepley { 158530ad9308SMatthew Knepley PC_FieldSplit *jac = (PC_FieldSplit*) pc->data; 158630ad9308SMatthew Knepley 158730ad9308SMatthew Knepley PetscFunctionBegin; 15880700a824SBarry Smith PetscValidHeaderSpecific(pc,PC_CLASSID,1); 1589ce94432eSBarry Smith if (jac->type != PC_COMPOSITE_SCHUR) SETERRQ(PetscObjectComm((PetscObject)pc),PETSC_ERR_ARG_WRONG, "FieldSplit is not using a Schur complement approach."); 1590a04f6461SBarry Smith if (A00) *A00 = jac->pmat[0]; 1591a04f6461SBarry Smith if (A01) *A01 = jac->B; 1592a04f6461SBarry Smith if (A10) *A10 = jac->C; 1593a04f6461SBarry Smith if (A11) *A11 = jac->pmat[1]; 159430ad9308SMatthew Knepley PetscFunctionReturn(0); 159530ad9308SMatthew Knepley } 159630ad9308SMatthew Knepley 159779416396SBarry Smith EXTERN_C_BEGIN 159879416396SBarry Smith #undef __FUNCT__ 159979416396SBarry Smith #define __FUNCT__ "PCFieldSplitSetType_FieldSplit" 16007087cfbeSBarry Smith PetscErrorCode PCFieldSplitSetType_FieldSplit(PC pc,PCCompositeType type) 160179416396SBarry Smith { 160279416396SBarry Smith PC_FieldSplit *jac = (PC_FieldSplit*)pc->data; 1603e69d4d44SBarry Smith PetscErrorCode ierr; 160479416396SBarry Smith 160579416396SBarry Smith PetscFunctionBegin; 160679416396SBarry Smith jac->type = type; 16073b224e63SBarry Smith if (type == PC_COMPOSITE_SCHUR) { 16083b224e63SBarry Smith pc->ops->apply = PCApply_FieldSplit_Schur; 16093b224e63SBarry Smith pc->ops->view = PCView_FieldSplit_Schur; 16102fa5cd67SKarl Rupp 1611e69d4d44SBarry Smith ierr = PetscObjectComposeFunctionDynamic((PetscObject)pc,"PCFieldSplitGetSubKSP_C","PCFieldSplitGetSubKSP_FieldSplit_Schur",PCFieldSplitGetSubKSP_FieldSplit_Schur);CHKERRQ(ierr); 1612e69d4d44SBarry Smith ierr = PetscObjectComposeFunctionDynamic((PetscObject)pc,"PCFieldSplitSchurPrecondition_C","PCFieldSplitSchurPrecondition_FieldSplit",PCFieldSplitSchurPrecondition_FieldSplit);CHKERRQ(ierr); 1613c9c6ffaaSJed Brown ierr = PetscObjectComposeFunctionDynamic((PetscObject)pc,"PCFieldSplitSetSchurFactType_C","PCFieldSplitSetSchurFactType_FieldSplit",PCFieldSplitSetSchurFactType_FieldSplit);CHKERRQ(ierr); 1614e69d4d44SBarry Smith 16153b224e63SBarry Smith } else { 16163b224e63SBarry Smith pc->ops->apply = PCApply_FieldSplit; 16173b224e63SBarry Smith pc->ops->view = PCView_FieldSplit; 16182fa5cd67SKarl Rupp 1619e69d4d44SBarry Smith ierr = PetscObjectComposeFunctionDynamic((PetscObject)pc,"PCFieldSplitGetSubKSP_C","PCFieldSplitGetSubKSP_FieldSplit",PCFieldSplitGetSubKSP_FieldSplit);CHKERRQ(ierr); 16209e7d6b0aSBarry Smith ierr = PetscObjectComposeFunctionDynamic((PetscObject)pc,"PCFieldSplitSchurPrecondition_C","",0);CHKERRQ(ierr); 1621c9c6ffaaSJed Brown ierr = PetscObjectComposeFunctionDynamic((PetscObject)pc,"PCFieldSplitSetSchurFactType_C","",0);CHKERRQ(ierr); 16223b224e63SBarry Smith } 162379416396SBarry Smith PetscFunctionReturn(0); 162479416396SBarry Smith } 162579416396SBarry Smith EXTERN_C_END 162679416396SBarry Smith 162751f519a2SBarry Smith EXTERN_C_BEGIN 162851f519a2SBarry Smith #undef __FUNCT__ 162951f519a2SBarry Smith #define __FUNCT__ "PCFieldSplitSetBlockSize_FieldSplit" 16307087cfbeSBarry Smith PetscErrorCode PCFieldSplitSetBlockSize_FieldSplit(PC pc,PetscInt bs) 163151f519a2SBarry Smith { 163251f519a2SBarry Smith PC_FieldSplit *jac = (PC_FieldSplit*)pc->data; 163351f519a2SBarry Smith 163451f519a2SBarry Smith PetscFunctionBegin; 1635ce94432eSBarry Smith if (bs < 1) SETERRQ1(PetscObjectComm((PetscObject)pc),PETSC_ERR_ARG_OUTOFRANGE,"Blocksize must be positive, you gave %D",bs); 1636ce94432eSBarry Smith if (jac->bs > 0 && jac->bs != bs) SETERRQ2(PetscObjectComm((PetscObject)pc),PETSC_ERR_ARG_WRONGSTATE,"Cannot change fieldsplit blocksize from %D to %D after it has been set",jac->bs,bs); 163751f519a2SBarry Smith jac->bs = bs; 163851f519a2SBarry Smith PetscFunctionReturn(0); 163951f519a2SBarry Smith } 164051f519a2SBarry Smith EXTERN_C_END 164151f519a2SBarry Smith 164279416396SBarry Smith #undef __FUNCT__ 164379416396SBarry Smith #define __FUNCT__ "PCFieldSplitSetType" 1644bc08b0f1SBarry Smith /*@ 164579416396SBarry Smith PCFieldSplitSetType - Sets the type of fieldsplit preconditioner. 164679416396SBarry Smith 164779416396SBarry Smith Collective on PC 164879416396SBarry Smith 164979416396SBarry Smith Input Parameter: 165079416396SBarry Smith . pc - the preconditioner context 165181540f2fSBarry Smith . type - PC_COMPOSITE_ADDITIVE, PC_COMPOSITE_MULTIPLICATIVE (default), PC_COMPOSITE_SYMMETRIC_MULTIPLICATIVE, PC_COMPOSITE_SPECIAL, PC_COMPOSITE_SCHUR 165279416396SBarry Smith 165379416396SBarry Smith Options Database Key: 1654a4efd8eaSMatthew Knepley . -pc_fieldsplit_type <type: one of multiplicative, additive, symmetric_multiplicative, special, schur> - Sets fieldsplit preconditioner type 165579416396SBarry Smith 1656b02e2d75SMatthew G Knepley Level: Intermediate 165779416396SBarry Smith 165879416396SBarry Smith .keywords: PC, set, type, composite preconditioner, additive, multiplicative 165979416396SBarry Smith 166079416396SBarry Smith .seealso: PCCompositeSetType() 166179416396SBarry Smith 166279416396SBarry Smith @*/ 16637087cfbeSBarry Smith PetscErrorCode PCFieldSplitSetType(PC pc,PCCompositeType type) 166479416396SBarry Smith { 16654ac538c5SBarry Smith PetscErrorCode ierr; 166679416396SBarry Smith 166779416396SBarry Smith PetscFunctionBegin; 16680700a824SBarry Smith PetscValidHeaderSpecific(pc,PC_CLASSID,1); 16694ac538c5SBarry Smith ierr = PetscTryMethod(pc,"PCFieldSplitSetType_C",(PC,PCCompositeType),(pc,type));CHKERRQ(ierr); 167079416396SBarry Smith PetscFunctionReturn(0); 167179416396SBarry Smith } 167279416396SBarry Smith 1673b02e2d75SMatthew G Knepley #undef __FUNCT__ 1674b02e2d75SMatthew G Knepley #define __FUNCT__ "PCFieldSplitGetType" 1675b02e2d75SMatthew G Knepley /*@ 1676b02e2d75SMatthew G Knepley PCFieldSplitGetType - Gets the type of fieldsplit preconditioner. 1677b02e2d75SMatthew G Knepley 1678b02e2d75SMatthew G Knepley Not collective 1679b02e2d75SMatthew G Knepley 1680b02e2d75SMatthew G Knepley Input Parameter: 1681b02e2d75SMatthew G Knepley . pc - the preconditioner context 1682b02e2d75SMatthew G Knepley 1683b02e2d75SMatthew G Knepley Output Parameter: 1684b02e2d75SMatthew G Knepley . type - PC_COMPOSITE_ADDITIVE, PC_COMPOSITE_MULTIPLICATIVE (default), PC_COMPOSITE_SYMMETRIC_MULTIPLICATIVE, PC_COMPOSITE_SPECIAL, PC_COMPOSITE_SCHUR 1685b02e2d75SMatthew G Knepley 1686b02e2d75SMatthew G Knepley Level: Intermediate 1687b02e2d75SMatthew G Knepley 1688b02e2d75SMatthew G Knepley .keywords: PC, set, type, composite preconditioner, additive, multiplicative 1689b02e2d75SMatthew G Knepley .seealso: PCCompositeSetType() 1690b02e2d75SMatthew G Knepley @*/ 1691b02e2d75SMatthew G Knepley PetscErrorCode PCFieldSplitGetType(PC pc, PCCompositeType *type) 1692b02e2d75SMatthew G Knepley { 1693b02e2d75SMatthew G Knepley PC_FieldSplit *jac = (PC_FieldSplit*) pc->data; 1694b02e2d75SMatthew G Knepley 1695b02e2d75SMatthew G Knepley PetscFunctionBegin; 1696b02e2d75SMatthew G Knepley PetscValidHeaderSpecific(pc,PC_CLASSID,1); 1697b02e2d75SMatthew G Knepley PetscValidIntPointer(type,2); 1698b02e2d75SMatthew G Knepley *type = jac->type; 1699b02e2d75SMatthew G Knepley PetscFunctionReturn(0); 1700b02e2d75SMatthew G Knepley } 1701b02e2d75SMatthew G Knepley 1702*4ab8060aSDmitry Karpeev #undef __FUNCT__ 1703*4ab8060aSDmitry Karpeev #define __FUNCT__ "PCFieldSplitSetDMSplits" 1704*4ab8060aSDmitry Karpeev /*@ 1705*4ab8060aSDmitry Karpeev PCFieldSplitSetDMSplits - Flags whether DMCreateFieldDecomposition() should be used to define the splits, whenever possible. 1706*4ab8060aSDmitry Karpeev 1707*4ab8060aSDmitry Karpeev Logically Collective 1708*4ab8060aSDmitry Karpeev 1709*4ab8060aSDmitry Karpeev Input Parameters: 1710*4ab8060aSDmitry Karpeev + pc - the preconditioner context 1711*4ab8060aSDmitry Karpeev - flg - boolean indicating whether to use field splits defined by the DM 1712*4ab8060aSDmitry Karpeev 1713*4ab8060aSDmitry Karpeev Options Database Key: 1714*4ab8060aSDmitry Karpeev . -pc_fieldsplit_dm_splits 1715*4ab8060aSDmitry Karpeev 1716*4ab8060aSDmitry Karpeev Level: Intermediate 1717*4ab8060aSDmitry Karpeev 1718*4ab8060aSDmitry Karpeev .keywords: PC, DM, composite preconditioner, additive, multiplicative 1719*4ab8060aSDmitry Karpeev 1720*4ab8060aSDmitry Karpeev .seealso: PCFieldSplitGetDMSplits() 1721*4ab8060aSDmitry Karpeev 1722*4ab8060aSDmitry Karpeev @*/ 1723*4ab8060aSDmitry Karpeev PetscErrorCode PCFieldSplitSetDMSplits(PC pc,PetscBool flg) 1724*4ab8060aSDmitry Karpeev { 1725*4ab8060aSDmitry Karpeev PC_FieldSplit *jac = (PC_FieldSplit*)pc->data; 1726*4ab8060aSDmitry Karpeev PetscBool isfs; 1727*4ab8060aSDmitry Karpeev PetscErrorCode ierr; 1728*4ab8060aSDmitry Karpeev 1729*4ab8060aSDmitry Karpeev PetscFunctionBegin; 1730*4ab8060aSDmitry Karpeev PetscValidHeaderSpecific(pc,PC_CLASSID,1); 1731*4ab8060aSDmitry Karpeev PetscValidLogicalCollectiveBool(pc,flg,2); 1732*4ab8060aSDmitry Karpeev ierr = PetscObjectTypeCompare((PetscObject)pc,PCFIELDSPLIT,&isfs);CHKERRQ(ierr); 1733*4ab8060aSDmitry Karpeev if (isfs) { 1734*4ab8060aSDmitry Karpeev jac->dm_splits = flg; 1735*4ab8060aSDmitry Karpeev } 1736*4ab8060aSDmitry Karpeev PetscFunctionReturn(0); 1737*4ab8060aSDmitry Karpeev } 1738*4ab8060aSDmitry Karpeev 1739*4ab8060aSDmitry Karpeev 1740*4ab8060aSDmitry Karpeev #undef __FUNCT__ 1741*4ab8060aSDmitry Karpeev #define __FUNCT__ "PCFieldSplitGetDMSplits" 1742*4ab8060aSDmitry Karpeev /*@ 1743*4ab8060aSDmitry Karpeev PCFieldSplitGetDMSplits - Returns flag indicating whether DMCreateFieldDecomposition() should be used to define the splits, whenever possible. 1744*4ab8060aSDmitry Karpeev 1745*4ab8060aSDmitry Karpeev Logically Collective 1746*4ab8060aSDmitry Karpeev 1747*4ab8060aSDmitry Karpeev Input Parameter: 1748*4ab8060aSDmitry Karpeev . pc - the preconditioner context 1749*4ab8060aSDmitry Karpeev 1750*4ab8060aSDmitry Karpeev Output Parameter: 1751*4ab8060aSDmitry Karpeev . flg - boolean indicating whether to use field splits defined by the DM 1752*4ab8060aSDmitry Karpeev 1753*4ab8060aSDmitry Karpeev Level: Intermediate 1754*4ab8060aSDmitry Karpeev 1755*4ab8060aSDmitry Karpeev .keywords: PC, DM, composite preconditioner, additive, multiplicative 1756*4ab8060aSDmitry Karpeev 1757*4ab8060aSDmitry Karpeev .seealso: PCFieldSplitSetDMSplits() 1758*4ab8060aSDmitry Karpeev 1759*4ab8060aSDmitry Karpeev @*/ 1760*4ab8060aSDmitry Karpeev PetscErrorCode PCFieldSplitGetDMSplits(PC pc,PetscBool* flg) 1761*4ab8060aSDmitry Karpeev { 1762*4ab8060aSDmitry Karpeev PC_FieldSplit *jac = (PC_FieldSplit*)pc->data; 1763*4ab8060aSDmitry Karpeev PetscBool isfs; 1764*4ab8060aSDmitry Karpeev PetscErrorCode ierr; 1765*4ab8060aSDmitry Karpeev 1766*4ab8060aSDmitry Karpeev PetscFunctionBegin; 1767*4ab8060aSDmitry Karpeev PetscValidHeaderSpecific(pc,PC_CLASSID,1); 1768*4ab8060aSDmitry Karpeev PetscValidPointer(flg,2); 1769*4ab8060aSDmitry Karpeev ierr = PetscObjectTypeCompare((PetscObject)pc,PCFIELDSPLIT,&isfs);CHKERRQ(ierr); 1770*4ab8060aSDmitry Karpeev if (isfs) { 1771*4ab8060aSDmitry Karpeev if(flg) *flg = jac->dm_splits; 1772*4ab8060aSDmitry Karpeev } 1773*4ab8060aSDmitry Karpeev PetscFunctionReturn(0); 1774*4ab8060aSDmitry Karpeev } 1775*4ab8060aSDmitry Karpeev 17760971522cSBarry Smith /* -------------------------------------------------------------------------------------*/ 17770971522cSBarry Smith /*MC 1778a8c7a070SBarry Smith PCFIELDSPLIT - Preconditioner created by combining separate preconditioners for individual 1779a04f6461SBarry Smith fields or groups of fields. See the users manual section "Solving Block Matrices" for more details. 17800971522cSBarry Smith 1781edf189efSBarry Smith To set options on the solvers for each block append -fieldsplit_ to all the PC 1782edf189efSBarry Smith options database keys. For example, -fieldsplit_pc_type ilu -fieldsplit_pc_factor_levels 1 17830971522cSBarry Smith 1784a8c7a070SBarry Smith To set the options on the solvers separate for each block call PCFieldSplitGetSubKSP() 178569a612a9SBarry Smith and set the options directly on the resulting KSP object 17860971522cSBarry Smith 17870971522cSBarry Smith Level: intermediate 17880971522cSBarry Smith 178979416396SBarry Smith Options Database Keys: 179081540f2fSBarry Smith + -pc_fieldsplit_%d_fields <a,b,..> - indicates the fields to be used in the %d'th split 179181540f2fSBarry Smith . -pc_fieldsplit_default - automatically add any fields to additional splits that have not 179281540f2fSBarry Smith been supplied explicitly by -pc_fieldsplit_%d_fields 179381540f2fSBarry Smith . -pc_fieldsplit_block_size <bs> - size of block that defines fields (i.e. there are bs fields) 17940f188ba9SJed Brown . -pc_fieldsplit_type <additive,multiplicative,symmetric_multiplicative,schur> - type of relaxation or factorization splitting 1795e87fab1bSBarry Smith . -pc_fieldsplit_schur_precondition <self,user,a11> - default is a11 1796435f959eSBarry Smith . -pc_fieldsplit_detect_saddle_point - automatically finds rows with zero or negative diagonal and uses Schur complement with no preconditioner as the solver 179779416396SBarry Smith 17985d4c12cdSJungho Lee - Options prefix for inner solvers when using Schur complement preconditioner are -fieldsplit_0_ and -fieldsplit_1_ 17995d4c12cdSJungho Lee for all other solvers they are -fieldsplit_%d_ for the dth field, use -fieldsplit_ for all fields 18005d4c12cdSJungho Lee 1801c8a0d604SMatthew G Knepley Notes: 1802c8a0d604SMatthew G Knepley Use PCFieldSplitSetFields() to set fields defined by "strided" entries and PCFieldSplitSetIS() 1803d32f9abdSBarry Smith to define a field by an arbitrary collection of entries. 1804d32f9abdSBarry Smith 1805d32f9abdSBarry Smith If no fields are set the default is used. The fields are defined by entries strided by bs, 1806d32f9abdSBarry Smith beginning at 0 then 1, etc to bs-1. The block size can be set with PCFieldSplitSetBlockSize(), 1807d32f9abdSBarry Smith if this is not called the block size defaults to the blocksize of the second matrix passed 1808d32f9abdSBarry Smith to KSPSetOperators()/PCSetOperators(). 1809d32f9abdSBarry Smith 1810c8a0d604SMatthew G Knepley $ For the Schur complement preconditioner if J = ( A00 A01 ) 1811c8a0d604SMatthew G Knepley $ ( A10 A11 ) 1812c8a0d604SMatthew G Knepley $ the preconditioner using full factorization is 1813c8a0d604SMatthew G Knepley $ ( I -A10 ksp(A00) ) ( inv(A00) 0 ) ( I 0 ) 1814c8a0d604SMatthew G Knepley $ ( 0 I ) ( 0 ksp(S) ) ( -A10 ksp(A00) I ) 1815a04f6461SBarry Smith where the action of inv(A00) is applied using the KSP solver with prefix -fieldsplit_0_. The action of 1816c8a0d604SMatthew G Knepley ksp(S) is computed using the KSP solver with prefix -fieldsplit_splitname_ (where splitname was given 1817c8a0d604SMatthew G Knepley in providing the SECOND split or 1 if not give). For PCFieldSplitGetKSP() when field number is 0, 1818c8a0d604SMatthew G Knepley it returns the KSP associated with -fieldsplit_0_ while field number 1 gives -fieldsplit_1_ KSP. By default 1819a04f6461SBarry Smith A11 is used to construct a preconditioner for S, use PCFieldSplitSchurPrecondition() to turn on or off this 1820c8a0d604SMatthew G Knepley option. You can use the preconditioner PCLSC to precondition the Schur complement with -fieldsplit_1_pc_type lsc. The 1821c9c6ffaaSJed Brown factorization type is set using -pc_fieldsplit_schur_fact_type <diag, lower, upper, full>. The full is shown above, 18225668aaf4SBarry Smith diag gives 1823c8a0d604SMatthew G Knepley $ ( inv(A00) 0 ) 1824c8a0d604SMatthew G Knepley $ ( 0 -ksp(S) ) 18255668aaf4SBarry 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 1826c8a0d604SMatthew G Knepley $ ( A00 0 ) 1827c8a0d604SMatthew G Knepley $ ( A10 S ) 1828c8a0d604SMatthew G Knepley where the inverses of A00 and S are applied using KSPs. The upper factorization is the inverse of 1829c8a0d604SMatthew G Knepley $ ( A00 A01 ) 1830c8a0d604SMatthew G Knepley $ ( 0 S ) 1831c8a0d604SMatthew G Knepley where again the inverses of A00 and S are applied using KSPs. 1832e69d4d44SBarry Smith 1833edf189efSBarry Smith If only one set of indices (one IS) is provided with PCFieldSplitSetIS() then the complement of that IS 1834edf189efSBarry Smith is used automatically for a second block. 1835edf189efSBarry Smith 1836ff218e97SBarry Smith The fieldsplit preconditioner cannot currently be used with the BAIJ or SBAIJ data formats if the blocksize is larger than 1. 1837ff218e97SBarry Smith Generally it should be used with the AIJ format. 1838ff218e97SBarry Smith 1839ff218e97SBarry Smith The forms of these preconditioners are closely related if not identical to forms derived as "Distributive Iterations", see, 1840ff218e97SBarry Smith for example, page 294 in "Principles of Computational Fluid Dynamics" by Pieter Wesseling. Note that one can also use PCFIELDSPLIT 1841ff218e97SBarry Smith inside a smoother resulting in "Distributive Smoothers". 18420716a85fSBarry Smith 1843a541d17aSBarry Smith Concepts: physics based preconditioners, block preconditioners 18440971522cSBarry Smith 18457e8cb189SBarry Smith .seealso: PCCreate(), PCSetType(), PCType (for list of available types), PC, Block_Preconditioners, PCLSC, 1846e69d4d44SBarry Smith PCFieldSplitGetSubKSP(), PCFieldSplitSetFields(), PCFieldSplitSetType(), PCFieldSplitSetIS(), PCFieldSplitSchurPrecondition() 18470971522cSBarry Smith M*/ 18480971522cSBarry Smith 18490971522cSBarry Smith EXTERN_C_BEGIN 18500971522cSBarry Smith #undef __FUNCT__ 18510971522cSBarry Smith #define __FUNCT__ "PCCreate_FieldSplit" 18527087cfbeSBarry Smith PetscErrorCode PCCreate_FieldSplit(PC pc) 18530971522cSBarry Smith { 18540971522cSBarry Smith PetscErrorCode ierr; 18550971522cSBarry Smith PC_FieldSplit *jac; 18560971522cSBarry Smith 18570971522cSBarry Smith PetscFunctionBegin; 185838f2d2fdSLisandro Dalcin ierr = PetscNewLog(pc,PC_FieldSplit,&jac);CHKERRQ(ierr); 18592fa5cd67SKarl Rupp 18600971522cSBarry Smith jac->bs = -1; 18610971522cSBarry Smith jac->nsplits = 0; 18623e197d65SBarry Smith jac->type = PC_COMPOSITE_MULTIPLICATIVE; 1863e6cab6aaSJed Brown jac->schurpre = PC_FIELDSPLIT_SCHUR_PRE_USER; /* Try user preconditioner first, fall back on diagonal */ 1864c9c6ffaaSJed Brown jac->schurfactorization = PC_FIELDSPLIT_SCHUR_FACT_FULL; 1865*4ab8060aSDmitry Karpeev jac->dm_splits = PETSC_FALSE; 186651f519a2SBarry Smith 18670971522cSBarry Smith pc->data = (void*)jac; 18680971522cSBarry Smith 18690971522cSBarry Smith pc->ops->apply = PCApply_FieldSplit; 1870421e10b8SBarry Smith pc->ops->applytranspose = PCApplyTranspose_FieldSplit; 18710971522cSBarry Smith pc->ops->setup = PCSetUp_FieldSplit; 1872574deadeSBarry Smith pc->ops->reset = PCReset_FieldSplit; 18730971522cSBarry Smith pc->ops->destroy = PCDestroy_FieldSplit; 18740971522cSBarry Smith pc->ops->setfromoptions = PCSetFromOptions_FieldSplit; 18750971522cSBarry Smith pc->ops->view = PCView_FieldSplit; 18760971522cSBarry Smith pc->ops->applyrichardson = 0; 18770971522cSBarry Smith 187869a612a9SBarry Smith ierr = PetscObjectComposeFunctionDynamic((PetscObject)pc,"PCFieldSplitGetSubKSP_C","PCFieldSplitGetSubKSP_FieldSplit", 187969a612a9SBarry Smith PCFieldSplitGetSubKSP_FieldSplit);CHKERRQ(ierr); 18800971522cSBarry Smith ierr = PetscObjectComposeFunctionDynamic((PetscObject)pc,"PCFieldSplitSetFields_C","PCFieldSplitSetFields_FieldSplit", 18810971522cSBarry Smith PCFieldSplitSetFields_FieldSplit);CHKERRQ(ierr); 1882704ba839SBarry Smith ierr = PetscObjectComposeFunctionDynamic((PetscObject)pc,"PCFieldSplitSetIS_C","PCFieldSplitSetIS_FieldSplit", 1883704ba839SBarry Smith PCFieldSplitSetIS_FieldSplit);CHKERRQ(ierr); 188479416396SBarry Smith ierr = PetscObjectComposeFunctionDynamic((PetscObject)pc,"PCFieldSplitSetType_C","PCFieldSplitSetType_FieldSplit", 188579416396SBarry Smith PCFieldSplitSetType_FieldSplit);CHKERRQ(ierr); 188651f519a2SBarry Smith ierr = PetscObjectComposeFunctionDynamic((PetscObject)pc,"PCFieldSplitSetBlockSize_C","PCFieldSplitSetBlockSize_FieldSplit", 188751f519a2SBarry Smith PCFieldSplitSetBlockSize_FieldSplit);CHKERRQ(ierr); 18880971522cSBarry Smith PetscFunctionReturn(0); 18890971522cSBarry Smith } 18900971522cSBarry Smith EXTERN_C_END 18910971522cSBarry Smith 18920971522cSBarry Smith 1893a541d17aSBarry Smith 1894