1dba47a55SKris Buschelman 24b9ad928SBarry Smith /* 34b9ad928SBarry Smith Defines a preconditioner that can consist of a collection of PCs 44b9ad928SBarry Smith */ 5af0996ceSBarry Smith #include <petsc/private/pcimpl.h> 6c6db04a5SJed Brown #include <petscksp.h> /*I "petscksp.h" I*/ 74b9ad928SBarry Smith 84b9ad928SBarry Smith typedef struct _PC_CompositeLink *PC_CompositeLink; 94b9ad928SBarry Smith struct _PC_CompositeLink { 104b9ad928SBarry Smith PC pc; 114b9ad928SBarry Smith PC_CompositeLink next; 12421e10b8SBarry Smith PC_CompositeLink previous; 134b9ad928SBarry Smith }; 144b9ad928SBarry Smith 154b9ad928SBarry Smith typedef struct { 164b9ad928SBarry Smith PC_CompositeLink head; 174b9ad928SBarry Smith PCCompositeType type; 184b9ad928SBarry Smith Vec work1; 194b9ad928SBarry Smith Vec work2; 204b9ad928SBarry Smith PetscScalar alpha; 214b9ad928SBarry Smith } PC_Composite; 224b9ad928SBarry Smith 234b9ad928SBarry Smith #undef __FUNCT__ 244b9ad928SBarry Smith #define __FUNCT__ "PCApply_Composite_Multiplicative" 256849ba73SBarry Smith static PetscErrorCode PCApply_Composite_Multiplicative(PC pc,Vec x,Vec y) 264b9ad928SBarry Smith { 27dfbe8321SBarry Smith PetscErrorCode ierr; 284b9ad928SBarry Smith PC_Composite *jac = (PC_Composite*)pc->data; 294b9ad928SBarry Smith PC_CompositeLink next = jac->head; 304b9ad928SBarry Smith Mat mat = pc->pmat; 314b9ad928SBarry Smith 324b9ad928SBarry Smith PetscFunctionBegin; 33ce94432eSBarry Smith if (!next) SETERRQ(PetscObjectComm((PetscObject)pc),PETSC_ERR_ARG_WRONGSTATE,"No composite preconditioners supplied via PCCompositeAddPC() or -pc_composite_pcs"); 344b9ad928SBarry Smith if (next->next && !jac->work2) { /* allocate second work vector */ 354b9ad928SBarry Smith ierr = VecDuplicate(jac->work1,&jac->work2);CHKERRQ(ierr); 364b9ad928SBarry Smith } 3749517cdeSBarry Smith if (pc->useAmat) mat = pc->mat; 3809b21952SJed Brown ierr = PCApply(next->pc,x,y);CHKERRQ(ierr); /* y <- B x */ 394b9ad928SBarry Smith while (next->next) { 404b9ad928SBarry Smith next = next->next; 4109b21952SJed Brown ierr = MatMult(mat,y,jac->work1);CHKERRQ(ierr); /* work1 <- A y */ 4209b21952SJed Brown ierr = VecWAXPY(jac->work2,-1.0,jac->work1,x);CHKERRQ(ierr); /* work2 <- x - work1 */ 4351f519a2SBarry Smith ierr = VecSet(jac->work1,0.0);CHKERRQ(ierr); /* zero since some PC's may not set all entries in the result */ 4409b21952SJed Brown ierr = PCApply(next->pc,jac->work2,jac->work1);CHKERRQ(ierr); /* work1 <- C work2 */ 4509b21952SJed Brown ierr = VecAXPY(y,1.0,jac->work1);CHKERRQ(ierr); /* y <- y + work1 = B x + C (x - A B x) = (B + C (1 - A B)) x */ 464b9ad928SBarry Smith } 47421e10b8SBarry Smith if (jac->type == PC_COMPOSITE_SYMMETRIC_MULTIPLICATIVE) { 48421e10b8SBarry Smith while (next->previous) { 49421e10b8SBarry Smith next = next->previous; 50421e10b8SBarry Smith ierr = MatMult(mat,y,jac->work1);CHKERRQ(ierr); 51421e10b8SBarry Smith ierr = VecWAXPY(jac->work2,-1.0,jac->work1,x);CHKERRQ(ierr); 52421e10b8SBarry Smith ierr = VecSet(jac->work1,0.0);CHKERRQ(ierr); /* zero since some PC's may not set all entries in the result */ 53421e10b8SBarry Smith ierr = PCApply(next->pc,jac->work2,jac->work1);CHKERRQ(ierr); 54421e10b8SBarry Smith ierr = VecAXPY(y,1.0,jac->work1);CHKERRQ(ierr); 55421e10b8SBarry Smith } 56421e10b8SBarry Smith } 574b9ad928SBarry Smith PetscFunctionReturn(0); 584b9ad928SBarry Smith } 594b9ad928SBarry Smith 602533e041SBarry Smith #undef __FUNCT__ 612533e041SBarry Smith #define __FUNCT__ "PCApplyTranspose_Composite_Multiplicative" 622533e041SBarry Smith static PetscErrorCode PCApplyTranspose_Composite_Multiplicative(PC pc,Vec x,Vec y) 632533e041SBarry Smith { 642533e041SBarry Smith PetscErrorCode ierr; 652533e041SBarry Smith PC_Composite *jac = (PC_Composite*)pc->data; 662533e041SBarry Smith PC_CompositeLink next = jac->head; 672533e041SBarry Smith Mat mat = pc->pmat; 682533e041SBarry Smith 692533e041SBarry Smith PetscFunctionBegin; 70ce94432eSBarry Smith if (!next) SETERRQ(PetscObjectComm((PetscObject)pc),PETSC_ERR_ARG_WRONGSTATE,"No composite preconditioners supplied via PCCompositeAddPC() or -pc_composite_pcs"); 712533e041SBarry Smith if (next->next && !jac->work2) { /* allocate second work vector */ 722533e041SBarry Smith ierr = VecDuplicate(jac->work1,&jac->work2);CHKERRQ(ierr); 732533e041SBarry Smith } 7449517cdeSBarry Smith if (pc->useAmat) mat = pc->mat; 752533e041SBarry Smith /* locate last PC */ 762533e041SBarry Smith while (next->next) { 772533e041SBarry Smith next = next->next; 782533e041SBarry Smith } 792533e041SBarry Smith ierr = PCApplyTranspose(next->pc,x,y);CHKERRQ(ierr); 802533e041SBarry Smith while (next->previous) { 812533e041SBarry Smith next = next->previous; 822533e041SBarry Smith ierr = MatMultTranspose(mat,y,jac->work1);CHKERRQ(ierr); 832533e041SBarry Smith ierr = VecWAXPY(jac->work2,-1.0,jac->work1,x);CHKERRQ(ierr); 842533e041SBarry Smith ierr = VecSet(jac->work1,0.0);CHKERRQ(ierr); /* zero since some PC's may not set all entries in the result */ 852533e041SBarry Smith ierr = PCApplyTranspose(next->pc,jac->work2,jac->work1);CHKERRQ(ierr); 862533e041SBarry Smith ierr = VecAXPY(y,1.0,jac->work1);CHKERRQ(ierr); 872533e041SBarry Smith } 882533e041SBarry Smith if (jac->type == PC_COMPOSITE_SYMMETRIC_MULTIPLICATIVE) { 892533e041SBarry Smith next = jac->head; 902533e041SBarry Smith while (next->next) { 912533e041SBarry Smith next = next->next; 922533e041SBarry Smith ierr = MatMultTranspose(mat,y,jac->work1);CHKERRQ(ierr); 932533e041SBarry Smith ierr = VecWAXPY(jac->work2,-1.0,jac->work1,x);CHKERRQ(ierr); 942533e041SBarry Smith ierr = VecSet(jac->work1,0.0);CHKERRQ(ierr); /* zero since some PC's may not set all entries in the result */ 952533e041SBarry Smith ierr = PCApplyTranspose(next->pc,jac->work2,jac->work1);CHKERRQ(ierr); 962533e041SBarry Smith ierr = VecAXPY(y,1.0,jac->work1);CHKERRQ(ierr); 972533e041SBarry Smith } 982533e041SBarry Smith } 992533e041SBarry Smith PetscFunctionReturn(0); 1002533e041SBarry Smith } 1012533e041SBarry Smith 1024b9ad928SBarry Smith /* 1034b9ad928SBarry Smith This is very special for a matrix of the form alpha I + R + S 1044b9ad928SBarry Smith where first preconditioner is built from alpha I + S and second from 1054b9ad928SBarry Smith alpha I + R 1064b9ad928SBarry Smith */ 1074b9ad928SBarry Smith #undef __FUNCT__ 1084b9ad928SBarry Smith #define __FUNCT__ "PCApply_Composite_Special" 1096849ba73SBarry Smith static PetscErrorCode PCApply_Composite_Special(PC pc,Vec x,Vec y) 1104b9ad928SBarry Smith { 111dfbe8321SBarry Smith PetscErrorCode ierr; 1124b9ad928SBarry Smith PC_Composite *jac = (PC_Composite*)pc->data; 1134b9ad928SBarry Smith PC_CompositeLink next = jac->head; 1144b9ad928SBarry Smith 1154b9ad928SBarry Smith PetscFunctionBegin; 116ce94432eSBarry Smith if (!next) SETERRQ(PetscObjectComm((PetscObject)pc),PETSC_ERR_ARG_WRONGSTATE,"No composite preconditioners supplied via PCCompositeAddPC() or -pc_composite_pcs"); 117ce94432eSBarry Smith if (!next->next || next->next->next) SETERRQ(PetscObjectComm((PetscObject)pc),PETSC_ERR_ARG_WRONGSTATE,"Special composite preconditioners requires exactly two PCs"); 1184b9ad928SBarry Smith 119d8fd42c4SBarry Smith ierr = PCApply(next->pc,x,jac->work1);CHKERRQ(ierr); 120d8fd42c4SBarry Smith ierr = PCApply(next->next->pc,jac->work1,y);CHKERRQ(ierr); 1214b9ad928SBarry Smith PetscFunctionReturn(0); 1224b9ad928SBarry Smith } 1234b9ad928SBarry Smith 1244b9ad928SBarry Smith #undef __FUNCT__ 1254b9ad928SBarry Smith #define __FUNCT__ "PCApply_Composite_Additive" 1266849ba73SBarry Smith static PetscErrorCode PCApply_Composite_Additive(PC pc,Vec x,Vec y) 1274b9ad928SBarry Smith { 128dfbe8321SBarry Smith PetscErrorCode ierr; 1294b9ad928SBarry Smith PC_Composite *jac = (PC_Composite*)pc->data; 1304b9ad928SBarry Smith PC_CompositeLink next = jac->head; 1314b9ad928SBarry Smith 1324b9ad928SBarry Smith PetscFunctionBegin; 133ce94432eSBarry Smith if (!next) SETERRQ(PetscObjectComm((PetscObject)pc),PETSC_ERR_ARG_WRONGSTATE,"No composite preconditioners supplied via PCCompositeAddPC() or -pc_composite_pcs"); 134d8fd42c4SBarry Smith ierr = PCApply(next->pc,x,y);CHKERRQ(ierr); 1354b9ad928SBarry Smith while (next->next) { 1364b9ad928SBarry Smith next = next->next; 13751f519a2SBarry Smith ierr = VecSet(jac->work1,0.0);CHKERRQ(ierr); /* zero since some PC's may not set all entries in the result */ 138d8fd42c4SBarry Smith ierr = PCApply(next->pc,x,jac->work1);CHKERRQ(ierr); 139efb30889SBarry Smith ierr = VecAXPY(y,1.0,jac->work1);CHKERRQ(ierr); 1404b9ad928SBarry Smith } 1414b9ad928SBarry Smith PetscFunctionReturn(0); 1424b9ad928SBarry Smith } 1434b9ad928SBarry Smith 1444b9ad928SBarry Smith #undef __FUNCT__ 1452533e041SBarry Smith #define __FUNCT__ "PCApplyTranspose_Composite_Additive" 1462533e041SBarry Smith static PetscErrorCode PCApplyTranspose_Composite_Additive(PC pc,Vec x,Vec y) 1472533e041SBarry Smith { 1482533e041SBarry Smith PetscErrorCode ierr; 1492533e041SBarry Smith PC_Composite *jac = (PC_Composite*)pc->data; 1502533e041SBarry Smith PC_CompositeLink next = jac->head; 1512533e041SBarry Smith 1522533e041SBarry Smith PetscFunctionBegin; 153ce94432eSBarry Smith if (!next) SETERRQ(PetscObjectComm((PetscObject)pc),PETSC_ERR_ARG_WRONGSTATE,"No composite preconditioners supplied via PCCompositeAddPC() or -pc_composite_pcs"); 1542533e041SBarry Smith ierr = PCApplyTranspose(next->pc,x,y);CHKERRQ(ierr); 1552533e041SBarry Smith while (next->next) { 1562533e041SBarry Smith next = next->next; 1572533e041SBarry Smith ierr = VecSet(jac->work1,0.0);CHKERRQ(ierr); /* zero since some PC's may not set all entries in the result */ 1582533e041SBarry Smith ierr = PCApplyTranspose(next->pc,x,jac->work1);CHKERRQ(ierr); 1592533e041SBarry Smith ierr = VecAXPY(y,1.0,jac->work1);CHKERRQ(ierr); 1602533e041SBarry Smith } 1612533e041SBarry Smith PetscFunctionReturn(0); 1622533e041SBarry Smith } 1632533e041SBarry Smith 1642533e041SBarry Smith #undef __FUNCT__ 1654b9ad928SBarry Smith #define __FUNCT__ "PCSetUp_Composite" 1666849ba73SBarry Smith static PetscErrorCode PCSetUp_Composite(PC pc) 1674b9ad928SBarry Smith { 168dfbe8321SBarry Smith PetscErrorCode ierr; 1694b9ad928SBarry Smith PC_Composite *jac = (PC_Composite*)pc->data; 1704b9ad928SBarry Smith PC_CompositeLink next = jac->head; 171*5a78d018SMatthew G. Knepley DM dm; 1724b9ad928SBarry Smith 1734b9ad928SBarry Smith PetscFunctionBegin; 1744b9ad928SBarry Smith if (!jac->work1) { 1752a7a6963SBarry Smith ierr = MatCreateVecs(pc->pmat,&jac->work1,0);CHKERRQ(ierr); 1764b9ad928SBarry Smith } 177*5a78d018SMatthew G. Knepley ierr = PCGetDM(pc,&dm);CHKERRQ(ierr); 1784b9ad928SBarry Smith while (next) { 179*5a78d018SMatthew G. Knepley ierr = PCSetDM(next->pc,dm);CHKERRQ(ierr); 18023ee1639SBarry Smith ierr = PCSetOperators(next->pc,pc->mat,pc->pmat);CHKERRQ(ierr); 1814b9ad928SBarry Smith next = next->next; 1824b9ad928SBarry Smith } 1834b9ad928SBarry Smith PetscFunctionReturn(0); 1844b9ad928SBarry Smith } 1854b9ad928SBarry Smith 1864b9ad928SBarry Smith #undef __FUNCT__ 18769d2c0f9SBarry Smith #define __FUNCT__ "PCReset_Composite" 18869d2c0f9SBarry Smith static PetscErrorCode PCReset_Composite(PC pc) 18969d2c0f9SBarry Smith { 19069d2c0f9SBarry Smith PC_Composite *jac = (PC_Composite*)pc->data; 19169d2c0f9SBarry Smith PetscErrorCode ierr; 1925f48b12bSBarry Smith PC_CompositeLink next = jac->head; 19369d2c0f9SBarry Smith 19469d2c0f9SBarry Smith PetscFunctionBegin; 19569d2c0f9SBarry Smith while (next) { 19669d2c0f9SBarry Smith ierr = PCReset(next->pc);CHKERRQ(ierr); 19769d2c0f9SBarry Smith next = next->next; 19869d2c0f9SBarry Smith } 1996bf464f9SBarry Smith ierr = VecDestroy(&jac->work1);CHKERRQ(ierr); 2006bf464f9SBarry Smith ierr = VecDestroy(&jac->work2);CHKERRQ(ierr); 20169d2c0f9SBarry Smith PetscFunctionReturn(0); 20269d2c0f9SBarry Smith } 20369d2c0f9SBarry Smith 20469d2c0f9SBarry Smith #undef __FUNCT__ 2054b9ad928SBarry Smith #define __FUNCT__ "PCDestroy_Composite" 2066849ba73SBarry Smith static PetscErrorCode PCDestroy_Composite(PC pc) 2074b9ad928SBarry Smith { 2084b9ad928SBarry Smith PC_Composite *jac = (PC_Composite*)pc->data; 209dfbe8321SBarry Smith PetscErrorCode ierr; 210724c2c99SHong Zhang PC_CompositeLink next = jac->head,next_tmp; 2114b9ad928SBarry Smith 2124b9ad928SBarry Smith PetscFunctionBegin; 21369d2c0f9SBarry Smith ierr = PCReset_Composite(pc);CHKERRQ(ierr); 2144b9ad928SBarry Smith while (next) { 2156bf464f9SBarry Smith ierr = PCDestroy(&next->pc);CHKERRQ(ierr); 216724c2c99SHong Zhang next_tmp = next; 2174b9ad928SBarry Smith next = next->next; 218724c2c99SHong Zhang ierr = PetscFree(next_tmp);CHKERRQ(ierr); 2194b9ad928SBarry Smith } 220c31cb41cSBarry Smith ierr = PetscFree(pc->data);CHKERRQ(ierr); 2214b9ad928SBarry Smith PetscFunctionReturn(0); 2224b9ad928SBarry Smith } 2234b9ad928SBarry Smith 2244b9ad928SBarry Smith #undef __FUNCT__ 2254b9ad928SBarry Smith #define __FUNCT__ "PCSetFromOptions_Composite" 2268c34d3f5SBarry Smith static PetscErrorCode PCSetFromOptions_Composite(PetscOptions *PetscOptionsObject,PC pc) 2274b9ad928SBarry Smith { 2284b9ad928SBarry Smith PC_Composite *jac = (PC_Composite*)pc->data; 229dfbe8321SBarry Smith PetscErrorCode ierr; 2309dcbbd2bSBarry Smith PetscInt nmax = 8,i; 2314b9ad928SBarry Smith PC_CompositeLink next; 232e5999256SBarry Smith char *pcs[8]; 233ace3abfcSBarry Smith PetscBool flg; 2344b9ad928SBarry Smith 2354b9ad928SBarry Smith PetscFunctionBegin; 236e55864a3SBarry Smith ierr = PetscOptionsHead(PetscOptionsObject,"Composite preconditioner options");CHKERRQ(ierr); 2379dcbbd2bSBarry Smith ierr = PetscOptionsEnum("-pc_composite_type","Type of composition","PCCompositeSetType",PCCompositeTypes,(PetscEnum)jac->type,(PetscEnum*)&jac->type,&flg);CHKERRQ(ierr); 23851f519a2SBarry Smith if (flg) { 23951f519a2SBarry Smith ierr = PCCompositeSetType(pc,jac->type);CHKERRQ(ierr); 24051f519a2SBarry Smith } 2414b9ad928SBarry Smith ierr = PetscOptionsStringArray("-pc_composite_pcs","List of composite solvers","PCCompositeAddPC",pcs,&nmax,&flg);CHKERRQ(ierr); 2424b9ad928SBarry Smith if (flg) { 2434b9ad928SBarry Smith for (i=0; i<nmax; i++) { 2444b9ad928SBarry Smith ierr = PCCompositeAddPC(pc,pcs[i]);CHKERRQ(ierr); 245724c2c99SHong Zhang ierr = PetscFree(pcs[i]);CHKERRQ(ierr); /* deallocate string pcs[i], which is allocated in PetscOptionsStringArray() */ 2464b9ad928SBarry Smith } 2474b9ad928SBarry Smith } 2484b9ad928SBarry Smith ierr = PetscOptionsTail();CHKERRQ(ierr); 2494b9ad928SBarry Smith 2504b9ad928SBarry Smith next = jac->head; 2514b9ad928SBarry Smith while (next) { 2524b9ad928SBarry Smith ierr = PCSetFromOptions(next->pc);CHKERRQ(ierr); 2534b9ad928SBarry Smith next = next->next; 2544b9ad928SBarry Smith } 2554b9ad928SBarry Smith PetscFunctionReturn(0); 2564b9ad928SBarry Smith } 2574b9ad928SBarry Smith 2584b9ad928SBarry Smith #undef __FUNCT__ 2594b9ad928SBarry Smith #define __FUNCT__ "PCView_Composite" 2606849ba73SBarry Smith static PetscErrorCode PCView_Composite(PC pc,PetscViewer viewer) 2614b9ad928SBarry Smith { 2624b9ad928SBarry Smith PC_Composite *jac = (PC_Composite*)pc->data; 263dfbe8321SBarry Smith PetscErrorCode ierr; 2644b9ad928SBarry Smith PC_CompositeLink next = jac->head; 265ace3abfcSBarry Smith PetscBool iascii; 2664b9ad928SBarry Smith 2674b9ad928SBarry Smith PetscFunctionBegin; 268251f4c67SDmitry Karpeev ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&iascii);CHKERRQ(ierr); 26932077d6dSBarry Smith if (iascii) { 2709dcbbd2bSBarry Smith ierr = PetscViewerASCIIPrintf(viewer,"Composite PC type - %s\n",PCCompositeTypes[jac->type]);CHKERRQ(ierr); 2714b9ad928SBarry Smith ierr = PetscViewerASCIIPrintf(viewer,"PCs on composite preconditioner follow\n");CHKERRQ(ierr); 2724b9ad928SBarry Smith ierr = PetscViewerASCIIPrintf(viewer,"---------------------------------\n");CHKERRQ(ierr); 2734b9ad928SBarry Smith } 27432077d6dSBarry Smith if (iascii) { 2754b9ad928SBarry Smith ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr); 2764b9ad928SBarry Smith } 2774b9ad928SBarry Smith while (next) { 2784b9ad928SBarry Smith ierr = PCView(next->pc,viewer);CHKERRQ(ierr); 2794b9ad928SBarry Smith next = next->next; 2804b9ad928SBarry Smith } 28132077d6dSBarry Smith if (iascii) { 2824b9ad928SBarry Smith ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr); 2834b9ad928SBarry Smith ierr = PetscViewerASCIIPrintf(viewer,"---------------------------------\n");CHKERRQ(ierr); 2844b9ad928SBarry Smith } 2854b9ad928SBarry Smith PetscFunctionReturn(0); 2864b9ad928SBarry Smith } 2874b9ad928SBarry Smith 2884b9ad928SBarry Smith /* ------------------------------------------------------------------------------*/ 2894b9ad928SBarry Smith 2904b9ad928SBarry Smith #undef __FUNCT__ 2914b9ad928SBarry Smith #define __FUNCT__ "PCCompositeSpecialSetAlpha_Composite" 2921e6b0712SBarry Smith static PetscErrorCode PCCompositeSpecialSetAlpha_Composite(PC pc,PetscScalar alpha) 2934b9ad928SBarry Smith { 2944b9ad928SBarry Smith PC_Composite *jac = (PC_Composite*)pc->data; 2955fd66863SKarl Rupp 2964b9ad928SBarry Smith PetscFunctionBegin; 2974b9ad928SBarry Smith jac->alpha = alpha; 2984b9ad928SBarry Smith PetscFunctionReturn(0); 2994b9ad928SBarry Smith } 3004b9ad928SBarry Smith 3014b9ad928SBarry Smith #undef __FUNCT__ 3024b9ad928SBarry Smith #define __FUNCT__ "PCCompositeSetType_Composite" 3031e6b0712SBarry Smith static PetscErrorCode PCCompositeSetType_Composite(PC pc,PCCompositeType type) 3044b9ad928SBarry Smith { 305fad69fbaSJed Brown PC_Composite *jac = (PC_Composite*)pc->data; 306fad69fbaSJed Brown 3074b9ad928SBarry Smith PetscFunctionBegin; 3084b9ad928SBarry Smith if (type == PC_COMPOSITE_ADDITIVE) { 3094b9ad928SBarry Smith pc->ops->apply = PCApply_Composite_Additive; 3102533e041SBarry Smith pc->ops->applytranspose = PCApplyTranspose_Composite_Additive; 311421e10b8SBarry Smith } else if (type == PC_COMPOSITE_MULTIPLICATIVE || type == PC_COMPOSITE_SYMMETRIC_MULTIPLICATIVE) { 3124b9ad928SBarry Smith pc->ops->apply = PCApply_Composite_Multiplicative; 3132533e041SBarry Smith pc->ops->applytranspose = PCApplyTranspose_Composite_Multiplicative; 3144b9ad928SBarry Smith } else if (type == PC_COMPOSITE_SPECIAL) { 3154b9ad928SBarry Smith pc->ops->apply = PCApply_Composite_Special; 3160298fd71SBarry Smith pc->ops->applytranspose = NULL; 317ce94432eSBarry Smith } else SETERRQ(PetscObjectComm((PetscObject)pc),PETSC_ERR_ARG_WRONG,"Unkown composite preconditioner type"); 318fad69fbaSJed Brown jac->type = type; 3194b9ad928SBarry Smith PetscFunctionReturn(0); 3204b9ad928SBarry Smith } 3214b9ad928SBarry Smith 3224b9ad928SBarry Smith #undef __FUNCT__ 323c60c7ad4SBarry Smith #define __FUNCT__ "PCCompositeGetType_Composite" 324c60c7ad4SBarry Smith static PetscErrorCode PCCompositeGetType_Composite(PC pc,PCCompositeType *type) 325c60c7ad4SBarry Smith { 326c60c7ad4SBarry Smith PC_Composite *jac = (PC_Composite*)pc->data; 327c60c7ad4SBarry Smith 328c60c7ad4SBarry Smith PetscFunctionBegin; 329c60c7ad4SBarry Smith *type = jac->type; 330c60c7ad4SBarry Smith PetscFunctionReturn(0); 331c60c7ad4SBarry Smith } 332c60c7ad4SBarry Smith 333c60c7ad4SBarry Smith #undef __FUNCT__ 3344b9ad928SBarry Smith #define __FUNCT__ "PCCompositeAddPC_Composite" 3351e6b0712SBarry Smith static PetscErrorCode PCCompositeAddPC_Composite(PC pc,PCType type) 3364b9ad928SBarry Smith { 3374b9ad928SBarry Smith PC_Composite *jac; 3385a9f2f41SSatish Balay PC_CompositeLink next,ilink; 339dfbe8321SBarry Smith PetscErrorCode ierr; 34079416396SBarry Smith PetscInt cnt = 0; 3412dcb1b2aSMatthew Knepley const char *prefix; 3422dcb1b2aSMatthew Knepley char newprefix[8]; 3434b9ad928SBarry Smith 3444b9ad928SBarry Smith PetscFunctionBegin; 345b00a9115SJed Brown ierr = PetscNewLog(pc,&ilink);CHKERRQ(ierr); 3465a9f2f41SSatish Balay ilink->next = 0; 347ce94432eSBarry Smith ierr = PCCreate(PetscObjectComm((PetscObject)pc),&ilink->pc);CHKERRQ(ierr); 348ace3abfcSBarry Smith ierr = PetscLogObjectParent((PetscObject)pc,(PetscObject)ilink->pc);CHKERRQ(ierr); 3494b9ad928SBarry Smith 3504b9ad928SBarry Smith jac = (PC_Composite*)pc->data; 3514b9ad928SBarry Smith next = jac->head; 3524b9ad928SBarry Smith if (!next) { 3535a9f2f41SSatish Balay jac->head = ilink; 3540298fd71SBarry Smith ilink->previous = NULL; 3554b9ad928SBarry Smith } else { 3564b9ad928SBarry Smith cnt++; 3574b9ad928SBarry Smith while (next->next) { 3584b9ad928SBarry Smith next = next->next; 3594b9ad928SBarry Smith cnt++; 3604b9ad928SBarry Smith } 3615a9f2f41SSatish Balay next->next = ilink; 362421e10b8SBarry Smith ilink->previous = next; 3634b9ad928SBarry Smith } 3644b9ad928SBarry Smith ierr = PCGetOptionsPrefix(pc,&prefix);CHKERRQ(ierr); 3655a9f2f41SSatish Balay ierr = PCSetOptionsPrefix(ilink->pc,prefix);CHKERRQ(ierr); 36613f74950SBarry Smith sprintf(newprefix,"sub_%d_",(int)cnt); 3675a9f2f41SSatish Balay ierr = PCAppendOptionsPrefix(ilink->pc,newprefix);CHKERRQ(ierr); 3684b9ad928SBarry Smith /* type is set after prefix, because some methods may modify prefix, e.g. pcksp */ 3695a9f2f41SSatish Balay ierr = PCSetType(ilink->pc,type);CHKERRQ(ierr); 3704b9ad928SBarry Smith PetscFunctionReturn(0); 3714b9ad928SBarry Smith } 3724b9ad928SBarry Smith 3734b9ad928SBarry Smith #undef __FUNCT__ 3744b9ad928SBarry Smith #define __FUNCT__ "PCCompositeGetPC_Composite" 3751e6b0712SBarry Smith static PetscErrorCode PCCompositeGetPC_Composite(PC pc,PetscInt n,PC *subpc) 3764b9ad928SBarry Smith { 3774b9ad928SBarry Smith PC_Composite *jac; 3784b9ad928SBarry Smith PC_CompositeLink next; 37979416396SBarry Smith PetscInt i; 3804b9ad928SBarry Smith 3814b9ad928SBarry Smith PetscFunctionBegin; 3824b9ad928SBarry Smith jac = (PC_Composite*)pc->data; 3834b9ad928SBarry Smith next = jac->head; 3844b9ad928SBarry Smith for (i=0; i<n; i++) { 385ce94432eSBarry Smith if (!next->next) SETERRQ(PetscObjectComm((PetscObject)pc),PETSC_ERR_ARG_INCOMP,"Not enough PCs in composite preconditioner"); 3864b9ad928SBarry Smith next = next->next; 3874b9ad928SBarry Smith } 3884b9ad928SBarry Smith *subpc = next->pc; 3894b9ad928SBarry Smith PetscFunctionReturn(0); 3904b9ad928SBarry Smith } 3914b9ad928SBarry Smith 3924b9ad928SBarry Smith /* -------------------------------------------------------------------------------- */ 3934b9ad928SBarry Smith #undef __FUNCT__ 3944b9ad928SBarry Smith #define __FUNCT__ "PCCompositeSetType" 395f39d8e23SSatish Balay /*@ 3964b9ad928SBarry Smith PCCompositeSetType - Sets the type of composite preconditioner. 3974b9ad928SBarry Smith 398ad4df100SBarry Smith Logically Collective on PC 3994b9ad928SBarry Smith 400c60c7ad4SBarry Smith Input Parameters: 4012a6744ebSBarry Smith + pc - the preconditioner context 4022a6744ebSBarry Smith - type - PC_COMPOSITE_ADDITIVE (default), PC_COMPOSITE_MULTIPLICATIVE, PC_COMPOSITE_SPECIAL 4034b9ad928SBarry Smith 4044b9ad928SBarry Smith Options Database Key: 4054b9ad928SBarry Smith . -pc_composite_type <type: one of multiplicative, additive, special> - Sets composite preconditioner type 4064b9ad928SBarry Smith 4074b9ad928SBarry Smith Level: Developer 4084b9ad928SBarry Smith 4094b9ad928SBarry Smith .keywords: PC, set, type, composite preconditioner, additive, multiplicative 4104b9ad928SBarry Smith @*/ 4117087cfbeSBarry Smith PetscErrorCode PCCompositeSetType(PC pc,PCCompositeType type) 4124b9ad928SBarry Smith { 4137bb14e67SBarry Smith PetscErrorCode ierr; 4144b9ad928SBarry Smith 4154b9ad928SBarry Smith PetscFunctionBegin; 4160700a824SBarry Smith PetscValidHeaderSpecific(pc,PC_CLASSID,1); 417c5eb9154SBarry Smith PetscValidLogicalCollectiveEnum(pc,type,2); 4187bb14e67SBarry Smith ierr = PetscTryMethod(pc,"PCCompositeSetType_C",(PC,PCCompositeType),(pc,type));CHKERRQ(ierr); 4194b9ad928SBarry Smith PetscFunctionReturn(0); 4204b9ad928SBarry Smith } 4214b9ad928SBarry Smith 4224b9ad928SBarry Smith #undef __FUNCT__ 423c60c7ad4SBarry Smith #define __FUNCT__ "PCCompositeGetType" 424c60c7ad4SBarry Smith /*@ 425721f67b5SBarry Smith PCCompositeGetType - Gets the type of composite preconditioner. 426c60c7ad4SBarry Smith 427c60c7ad4SBarry Smith Logically Collective on PC 428c60c7ad4SBarry Smith 429c60c7ad4SBarry Smith Input Parameter: 430c60c7ad4SBarry Smith . pc - the preconditioner context 431c60c7ad4SBarry Smith 432c60c7ad4SBarry Smith Output Parameter: 433c60c7ad4SBarry Smith . type - PC_COMPOSITE_ADDITIVE (default), PC_COMPOSITE_MULTIPLICATIVE, PC_COMPOSITE_SPECIAL 434c60c7ad4SBarry Smith 435c60c7ad4SBarry Smith Options Database Key: 436c60c7ad4SBarry Smith . -pc_composite_type <type: one of multiplicative, additive, special> - Sets composite preconditioner type 437c60c7ad4SBarry Smith 438c60c7ad4SBarry Smith Level: Developer 439c60c7ad4SBarry Smith 440c60c7ad4SBarry Smith .keywords: PC, set, type, composite preconditioner, additive, multiplicative 441c60c7ad4SBarry Smith @*/ 442c60c7ad4SBarry Smith PetscErrorCode PCCompositeGetType(PC pc,PCCompositeType *type) 443c60c7ad4SBarry Smith { 444c60c7ad4SBarry Smith PetscErrorCode ierr; 445c60c7ad4SBarry Smith 446c60c7ad4SBarry Smith PetscFunctionBegin; 447c60c7ad4SBarry Smith PetscValidHeaderSpecific(pc,PC_CLASSID,1); 448c60c7ad4SBarry Smith ierr = PetscUseMethod(pc,"PCCompositeGetType_C",(PC,PCCompositeType*),(pc,type));CHKERRQ(ierr); 449c60c7ad4SBarry Smith PetscFunctionReturn(0); 450c60c7ad4SBarry Smith } 451c60c7ad4SBarry Smith 452c60c7ad4SBarry Smith #undef __FUNCT__ 4534b9ad928SBarry Smith #define __FUNCT__ "PCCompositeSpecialSetAlpha" 454f39d8e23SSatish Balay /*@ 4554b9ad928SBarry Smith PCCompositeSpecialSetAlpha - Sets alpha for the special composite preconditioner 4564b9ad928SBarry Smith for alphaI + R + S 4574b9ad928SBarry Smith 458ad4df100SBarry Smith Logically Collective on PC 4594b9ad928SBarry Smith 4604b9ad928SBarry Smith Input Parameter: 4614b9ad928SBarry Smith + pc - the preconditioner context 4624b9ad928SBarry Smith - alpha - scale on identity 4634b9ad928SBarry Smith 4644b9ad928SBarry Smith Level: Developer 4654b9ad928SBarry Smith 4664b9ad928SBarry Smith .keywords: PC, set, type, composite preconditioner, additive, multiplicative 4674b9ad928SBarry Smith @*/ 4687087cfbeSBarry Smith PetscErrorCode PCCompositeSpecialSetAlpha(PC pc,PetscScalar alpha) 4694b9ad928SBarry Smith { 4704ac538c5SBarry Smith PetscErrorCode ierr; 4714b9ad928SBarry Smith 4724b9ad928SBarry Smith PetscFunctionBegin; 4730700a824SBarry Smith PetscValidHeaderSpecific(pc,PC_CLASSID,1); 474c5eb9154SBarry Smith PetscValidLogicalCollectiveScalar(pc,alpha,2); 4754ac538c5SBarry Smith ierr = PetscTryMethod(pc,"PCCompositeSpecialSetAlpha_C",(PC,PetscScalar),(pc,alpha));CHKERRQ(ierr); 4764b9ad928SBarry Smith PetscFunctionReturn(0); 4774b9ad928SBarry Smith } 4784b9ad928SBarry Smith 4794b9ad928SBarry Smith #undef __FUNCT__ 4804b9ad928SBarry Smith #define __FUNCT__ "PCCompositeAddPC" 4814b9ad928SBarry Smith /*@C 4824b9ad928SBarry Smith PCCompositeAddPC - Adds another PC to the composite PC. 4834b9ad928SBarry Smith 4844b9ad928SBarry Smith Collective on PC 4854b9ad928SBarry Smith 4864b9ad928SBarry Smith Input Parameters: 4872a6744ebSBarry Smith + pc - the preconditioner context 4882a6744ebSBarry Smith - type - the type of the new preconditioner 4894b9ad928SBarry Smith 4904b9ad928SBarry Smith Level: Developer 4914b9ad928SBarry Smith 4924b9ad928SBarry Smith .keywords: PC, composite preconditioner, add 4934b9ad928SBarry Smith @*/ 49419fd82e9SBarry Smith PetscErrorCode PCCompositeAddPC(PC pc,PCType type) 4954b9ad928SBarry Smith { 4964ac538c5SBarry Smith PetscErrorCode ierr; 4974b9ad928SBarry Smith 4984b9ad928SBarry Smith PetscFunctionBegin; 4990700a824SBarry Smith PetscValidHeaderSpecific(pc,PC_CLASSID,1); 50019fd82e9SBarry Smith ierr = PetscTryMethod(pc,"PCCompositeAddPC_C",(PC,PCType),(pc,type));CHKERRQ(ierr); 5014b9ad928SBarry Smith PetscFunctionReturn(0); 5024b9ad928SBarry Smith } 5034b9ad928SBarry Smith 5044b9ad928SBarry Smith #undef __FUNCT__ 5054b9ad928SBarry Smith #define __FUNCT__ "PCCompositeGetPC" 506f39d8e23SSatish Balay /*@ 5074b9ad928SBarry Smith PCCompositeGetPC - Gets one of the PC objects in the composite PC. 5084b9ad928SBarry Smith 5094b9ad928SBarry Smith Not Collective 5104b9ad928SBarry Smith 5114b9ad928SBarry Smith Input Parameter: 5122a6744ebSBarry Smith + pc - the preconditioner context 5132a6744ebSBarry Smith - n - the number of the pc requested 5144b9ad928SBarry Smith 5154b9ad928SBarry Smith Output Parameters: 5164b9ad928SBarry Smith . subpc - the PC requested 5174b9ad928SBarry Smith 5184b9ad928SBarry Smith Level: Developer 5194b9ad928SBarry Smith 5204b9ad928SBarry Smith .keywords: PC, get, composite preconditioner, sub preconditioner 5214b9ad928SBarry Smith 5224b9ad928SBarry Smith .seealso: PCCompositeAddPC() 5234b9ad928SBarry Smith @*/ 5247087cfbeSBarry Smith PetscErrorCode PCCompositeGetPC(PC pc,PetscInt n,PC *subpc) 5254b9ad928SBarry Smith { 5264ac538c5SBarry Smith PetscErrorCode ierr; 5274b9ad928SBarry Smith 5284b9ad928SBarry Smith PetscFunctionBegin; 5290700a824SBarry Smith PetscValidHeaderSpecific(pc,PC_CLASSID,1); 5304482741eSBarry Smith PetscValidPointer(subpc,3); 5314ac538c5SBarry Smith ierr = PetscUseMethod(pc,"PCCompositeGetPC_C",(PC,PetscInt,PC*),(pc,n,subpc));CHKERRQ(ierr); 5324b9ad928SBarry Smith PetscFunctionReturn(0); 5334b9ad928SBarry Smith } 5344b9ad928SBarry Smith 5354b9ad928SBarry Smith /* -------------------------------------------------------------------------------------------*/ 5364b9ad928SBarry Smith 5374b9ad928SBarry Smith /*MC 5384b9ad928SBarry Smith PCCOMPOSITE - Build a preconditioner by composing together several preconditioners 5394b9ad928SBarry Smith 5404b9ad928SBarry Smith Options Database Keys: 5412eab2d5bSJungho Lee + -pc_composite_type <type: one of multiplicative, additive, symmetric_multiplicative, special> - Sets composite preconditioner type 54249517cdeSBarry Smith . -pc_use_amat - Activates PCSetUseAmat() 54351f519a2SBarry Smith - -pc_composite_pcs - <pc0,pc1,...> list of PCs to compose 5444b9ad928SBarry Smith 5454b9ad928SBarry Smith Level: intermediate 5464b9ad928SBarry Smith 5474b9ad928SBarry Smith Concepts: composing solvers 5484b9ad928SBarry Smith 5494b9ad928SBarry Smith Notes: To use a Krylov method inside the composite preconditioner, set the PCType of one or more 5504b9ad928SBarry Smith inner PCs to be PCKSP. 5514b9ad928SBarry Smith Using a Krylov method inside another Krylov method can be dangerous (you get divergence or 552b3ef52cdSBarry Smith the incorrect answer) unless you use KSPFGMRES as the outer Krylov method 5534b9ad928SBarry Smith 5544b9ad928SBarry Smith 5554b9ad928SBarry Smith .seealso: PCCreate(), PCSetType(), PCType (for list of available types), PC, 5564b9ad928SBarry Smith PCSHELL, PCKSP, PCCompositeSetType(), PCCompositeSpecialSetAlpha(), PCCompositeAddPC(), 55749517cdeSBarry Smith PCCompositeGetPC(), PCSetUseAmat() 5584b9ad928SBarry Smith 5594b9ad928SBarry Smith M*/ 5604b9ad928SBarry Smith 5614b9ad928SBarry Smith #undef __FUNCT__ 5624b9ad928SBarry Smith #define __FUNCT__ "PCCreate_Composite" 5638cc058d9SJed Brown PETSC_EXTERN PetscErrorCode PCCreate_Composite(PC pc) 5644b9ad928SBarry Smith { 565dfbe8321SBarry Smith PetscErrorCode ierr; 5664b9ad928SBarry Smith PC_Composite *jac; 5674b9ad928SBarry Smith 5684b9ad928SBarry Smith PetscFunctionBegin; 569b00a9115SJed Brown ierr = PetscNewLog(pc,&jac);CHKERRQ(ierr); 5702fa5cd67SKarl Rupp 5714b9ad928SBarry Smith pc->ops->apply = PCApply_Composite_Additive; 5722533e041SBarry Smith pc->ops->applytranspose = PCApplyTranspose_Composite_Additive; 5734b9ad928SBarry Smith pc->ops->setup = PCSetUp_Composite; 57469d2c0f9SBarry Smith pc->ops->reset = PCReset_Composite; 5754b9ad928SBarry Smith pc->ops->destroy = PCDestroy_Composite; 5764b9ad928SBarry Smith pc->ops->setfromoptions = PCSetFromOptions_Composite; 5774b9ad928SBarry Smith pc->ops->view = PCView_Composite; 5784b9ad928SBarry Smith pc->ops->applyrichardson = 0; 5794b9ad928SBarry Smith 5804b9ad928SBarry Smith pc->data = (void*)jac; 5814b9ad928SBarry Smith jac->type = PC_COMPOSITE_ADDITIVE; 5824b9ad928SBarry Smith jac->work1 = 0; 5834b9ad928SBarry Smith jac->work2 = 0; 5844b9ad928SBarry Smith jac->head = 0; 5854b9ad928SBarry Smith 586bdf89e91SBarry Smith ierr = PetscObjectComposeFunction((PetscObject)pc,"PCCompositeSetType_C",PCCompositeSetType_Composite);CHKERRQ(ierr); 587c60c7ad4SBarry Smith ierr = PetscObjectComposeFunction((PetscObject)pc,"PCCompositeGetType_C",PCCompositeGetType_Composite);CHKERRQ(ierr); 588bdf89e91SBarry Smith ierr = PetscObjectComposeFunction((PetscObject)pc,"PCCompositeAddPC_C",PCCompositeAddPC_Composite);CHKERRQ(ierr); 589bdf89e91SBarry Smith ierr = PetscObjectComposeFunction((PetscObject)pc,"PCCompositeGetPC_C",PCCompositeGetPC_Composite);CHKERRQ(ierr); 590bdf89e91SBarry Smith ierr = PetscObjectComposeFunction((PetscObject)pc,"PCCompositeSpecialSetAlpha_C",PCCompositeSpecialSetAlpha_Composite);CHKERRQ(ierr); 5914b9ad928SBarry Smith PetscFunctionReturn(0); 5924b9ad928SBarry Smith } 5934b9ad928SBarry Smith 594