xref: /petsc/src/ksp/pc/impls/redundant/redundant.c (revision 1b81debc80cf22f57c38fd56af35ad7f4a3017c2)
1dba47a55SKris Buschelman 
24b9ad928SBarry Smith /*
33f457be1SHong Zhang   This file defines a "solve the problem redundantly on each subgroup of processor" preconditioner.
44b9ad928SBarry Smith */
507475bc1SBarry Smith #include <petsc-private/pcimpl.h>
6c6db04a5SJed Brown #include <petscksp.h>           /*I "petscksp.h" I*/
74b9ad928SBarry Smith 
84b9ad928SBarry Smith typedef struct {
93e065800SHong Zhang   KSP          ksp;
104b9ad928SBarry Smith   PC           pc;                   /* actual preconditioner used on each processor */
11ce94432eSBarry Smith   Vec          xsub,ysub;            /* vectors of a subcommunicator to hold parallel vectors of PetscObjectComm((PetscObject)pc) */
123f457be1SHong Zhang   Vec          xdup,ydup;            /* parallel vector that congregates xsub or ysub facilitating vector scattering */
13b3804887SHong Zhang   Mat          pmats;                /* matrix and optional preconditioner matrix belong to a subcommunicator */
143f457be1SHong Zhang   VecScatter   scatterin,scatterout; /* scatter used to move all values to each processor group (subcommunicator) */
15ace3abfcSBarry Smith   PetscBool    useparallelmat;
16c540e29cSHong Zhang   PetscSubcomm psubcomm;
171fbd8f88SHong Zhang   PetscInt     nsubcomm;           /* num of data structure PetscSubcomm */
184b9ad928SBarry Smith } PC_Redundant;
194b9ad928SBarry Smith 
204b9ad928SBarry Smith #undef __FUNCT__
214b9ad928SBarry Smith #define __FUNCT__ "PCView_Redundant"
226849ba73SBarry Smith static PetscErrorCode PCView_Redundant(PC pc,PetscViewer viewer)
234b9ad928SBarry Smith {
244b9ad928SBarry Smith   PC_Redundant   *red = (PC_Redundant*)pc->data;
25dfbe8321SBarry Smith   PetscErrorCode ierr;
26ace3abfcSBarry Smith   PetscBool      iascii,isstring;
2703ccd0b4SBarry Smith   PetscViewer    subviewer;
284b9ad928SBarry Smith 
294b9ad928SBarry Smith   PetscFunctionBegin;
30251f4c67SDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&iascii);CHKERRQ(ierr);
31251f4c67SDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERSTRING,&isstring);CHKERRQ(ierr);
3232077d6dSBarry Smith   if (iascii) {
3303ccd0b4SBarry Smith     if (!red->psubcomm) {
3403ccd0b4SBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"  Redundant preconditioner: Not yet setup\n");CHKERRQ(ierr);
3503ccd0b4SBarry Smith     } else {
363e065800SHong Zhang       ierr = PetscViewerASCIIPrintf(viewer,"  Redundant preconditioner: First (color=0) of %D PCs follows\n",red->nsubcomm);CHKERRQ(ierr);
377adad957SLisandro Dalcin       ierr = PetscViewerGetSubcomm(viewer,((PetscObject)red->pc)->comm,&subviewer);CHKERRQ(ierr);
38f5dd71faSBarry Smith       if (!red->psubcomm->color) { /* only view first redundant pc */
394b9ad928SBarry Smith         ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
403e065800SHong Zhang         ierr = KSPView(red->ksp,subviewer);CHKERRQ(ierr);
414b9ad928SBarry Smith         ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
424b9ad928SBarry Smith       }
437adad957SLisandro Dalcin       ierr = PetscViewerRestoreSubcomm(viewer,((PetscObject)red->pc)->comm,&subviewer);CHKERRQ(ierr);
444b9ad928SBarry Smith     }
4503ccd0b4SBarry Smith   } else if (isstring) {
4603ccd0b4SBarry Smith     ierr = PetscViewerStringSPrintf(viewer," Redundant solver preconditioner");CHKERRQ(ierr);
474b9ad928SBarry Smith   }
484b9ad928SBarry Smith   PetscFunctionReturn(0);
494b9ad928SBarry Smith }
504b9ad928SBarry Smith 
51d3b23db5SHong Zhang extern PetscErrorCode MatGetRedundantMatrix_MPIAIJ_interlaced(Mat,PetscInt,PetscSubcomm,MatReuse,Mat*); /* rm later! */
52d3b23db5SHong Zhang 
534b9ad928SBarry Smith #undef __FUNCT__
544b9ad928SBarry Smith #define __FUNCT__ "PCSetUp_Redundant"
556849ba73SBarry Smith static PetscErrorCode PCSetUp_Redundant(PC pc)
564b9ad928SBarry Smith {
574b9ad928SBarry Smith   PC_Redundant   *red = (PC_Redundant*)pc->data;
58dfbe8321SBarry Smith   PetscErrorCode ierr;
59*1b81debcSHong Zhang   PetscInt       mstart,mend,mlocal,M;
6013f74950SBarry Smith   PetscMPIInt    size;
614b9ad928SBarry Smith   MatReuse       reuse = MAT_INITIAL_MATRIX;
624b9ad928SBarry Smith   MatStructure   str   = DIFFERENT_NONZERO_PATTERN;
63ce94432eSBarry Smith   MPI_Comm       comm,subcomm;
64ddc54837SHong Zhang   Vec            x;
651fbd8f88SHong Zhang   const char     *prefix;
663f457be1SHong Zhang 
674b9ad928SBarry Smith   PetscFunctionBegin;
68ce94432eSBarry Smith   ierr = PetscObjectGetComm((PetscObject)pc,&comm);CHKERRQ(ierr);
69ddc54837SHong Zhang 
70ddc54837SHong Zhang   /* if pmatrix set by user is sequential then we do not need to gather the parallel matrix */
71ddc54837SHong Zhang   ierr = MPI_Comm_size(comm,&size);CHKERRQ(ierr);
72ddc54837SHong Zhang   if (size == 1) red->useparallelmat = PETSC_FALSE;
731fbd8f88SHong Zhang 
744b9ad928SBarry Smith   if (!pc->setupcalled) {
75*1b81debcSHong Zhang     PetscInt mloc_sub;
765f06b7aaSBarry Smith     if (!red->psubcomm) {
77d8a68f86SHong Zhang       ierr = PetscSubcommCreate(comm,&red->psubcomm);CHKERRQ(ierr);
78d8a68f86SHong Zhang       ierr = PetscSubcommSetNumber(red->psubcomm,red->nsubcomm);CHKERRQ(ierr);
79d8a68f86SHong Zhang       ierr = PetscSubcommSetType(red->psubcomm,PETSC_SUBCOMM_INTERLACED);CHKERRQ(ierr);
801fbd8f88SHong Zhang       ierr = PetscLogObjectMemory(pc,sizeof(PetscSubcomm));CHKERRQ(ierr);
811fbd8f88SHong Zhang 
821fbd8f88SHong Zhang       /* create a new PC that processors in each subcomm have copy of */
830d7810c8SBarry Smith       subcomm = red->psubcomm->comm;
842fa5cd67SKarl Rupp 
855f06b7aaSBarry Smith       ierr = KSPCreate(subcomm,&red->ksp);CHKERRQ(ierr);
865f06b7aaSBarry Smith       ierr = PetscObjectIncrementTabLevel((PetscObject)red->ksp,(PetscObject)pc,1);CHKERRQ(ierr);
875f06b7aaSBarry Smith       ierr = PetscLogObjectParent(pc,red->ksp);CHKERRQ(ierr);
885f06b7aaSBarry Smith       ierr = KSPSetType(red->ksp,KSPPREONLY);CHKERRQ(ierr);
895f06b7aaSBarry Smith       ierr = KSPGetPC(red->ksp,&red->pc);CHKERRQ(ierr);
90cf52b8b1SHong Zhang       ierr = PCSetType(red->pc,PCLU);CHKERRQ(ierr);
91cf52b8b1SHong Zhang 
921fbd8f88SHong Zhang       ierr = PCGetOptionsPrefix(pc,&prefix);CHKERRQ(ierr);
935f06b7aaSBarry Smith       ierr = KSPSetOptionsPrefix(red->ksp,prefix);CHKERRQ(ierr);
945f06b7aaSBarry Smith       ierr = KSPAppendOptionsPrefix(red->ksp,"redundant_");CHKERRQ(ierr);
95*1b81debcSHong Zhang     } else {
96*1b81debcSHong Zhang       subcomm = red->psubcomm->comm;
97*1b81debcSHong Zhang     }
981fbd8f88SHong Zhang 
99*1b81debcSHong Zhang     if (red->useparallelmat) {
100*1b81debcSHong Zhang       /* grab the parallel matrix and put it into processors of a subcomminicator */
101*1b81debcSHong Zhang       ierr = MatGetRedundantMatrix_MPIAIJ_interlaced(pc->pmat,red->psubcomm->n,red->psubcomm,MAT_INITIAL_MATRIX,&red->pmats);CHKERRQ(ierr);
102*1b81debcSHong Zhang       ierr = KSPSetOperators(red->ksp,red->pmats,red->pmats,DIFFERENT_NONZERO_PATTERN);CHKERRQ(ierr);
1034b9ad928SBarry Smith 
104*1b81debcSHong Zhang       /* get working vectors xsub and ysub */
105*1b81debcSHong Zhang       ierr = MatGetVecs(red->pmats,&red->xsub,&red->ysub);CHKERRQ(ierr);
1062fa5cd67SKarl Rupp 
107*1b81debcSHong Zhang       /* create  working vectors xdup and ydup. ydup has empty local arrays because ysub's arrays will be place into it.
108ce94432eSBarry Smith        Note: we use communicator dupcomm, not PetscObjectComm((PetscObject)pc)! */
109*1b81debcSHong Zhang       ierr = MatGetLocalSize(red->pmats,&mloc_sub,NULL);CHKERRQ(ierr);
1101fbd8f88SHong Zhang       ierr = VecCreateMPI(red->psubcomm->dupparent,mloc_sub,PETSC_DECIDE,&red->xdup);CHKERRQ(ierr);
1110298fd71SBarry Smith       ierr = VecCreateMPIWithArray(red->psubcomm->dupparent,1,mloc_sub,PETSC_DECIDE,NULL,&red->ydup);CHKERRQ(ierr);
1123f457be1SHong Zhang 
1133f457be1SHong Zhang       /* create vecscatters */
1143f457be1SHong Zhang       if (!red->scatterin) {
1153f457be1SHong Zhang         IS       is1,is2;
1163f457be1SHong Zhang         PetscInt *idx1,*idx2,i,j,k;
11745fc02eaSBarry Smith 
118*1b81debcSHong Zhang         ierr = MatGetVecs(pc->pmat,&x,0);CHKERRQ(ierr);
119*1b81debcSHong Zhang         ierr = VecGetSize(x,&M);CHKERRQ(ierr);
1201d79065fSBarry Smith         ierr = PetscMalloc2(red->psubcomm->n*mlocal,PetscInt,&idx1,red->psubcomm->n*mlocal,PetscInt,&idx2);CHKERRQ(ierr);
121*1b81debcSHong Zhang         ierr = VecGetOwnershipRange(x,&mstart,&mend);CHKERRQ(ierr);
122*1b81debcSHong Zhang         mlocal = mend - mstart;
1233f457be1SHong Zhang         j    = 0;
1241fbd8f88SHong Zhang         for (k=0; k<red->psubcomm->n; k++) {
1253f457be1SHong Zhang           for (i=mstart; i<mend; i++) {
1263f457be1SHong Zhang             idx1[j]   = i;
127ddc54837SHong Zhang             idx2[j++] = i + M*k;
1283f457be1SHong Zhang           }
1293f457be1SHong Zhang         }
13070b3c8c7SBarry Smith         ierr = ISCreateGeneral(comm,red->psubcomm->n*mlocal,idx1,PETSC_COPY_VALUES,&is1);CHKERRQ(ierr);
13170b3c8c7SBarry Smith         ierr = ISCreateGeneral(comm,red->psubcomm->n*mlocal,idx2,PETSC_COPY_VALUES,&is2);CHKERRQ(ierr);
132ddc54837SHong Zhang         ierr = VecScatterCreate(x,is1,red->xdup,is2,&red->scatterin);CHKERRQ(ierr);
133fcfd50ebSBarry Smith         ierr = ISDestroy(&is1);CHKERRQ(ierr);
134fcfd50ebSBarry Smith         ierr = ISDestroy(&is2);CHKERRQ(ierr);
1353f457be1SHong Zhang 
136ddc54837SHong Zhang         ierr = ISCreateStride(comm,mlocal,mstart+ red->psubcomm->color*M,1,&is1);CHKERRQ(ierr);
1373f457be1SHong Zhang         ierr = ISCreateStride(comm,mlocal,mstart,1,&is2);CHKERRQ(ierr);
138ddc54837SHong Zhang         ierr = VecScatterCreate(red->xdup,is1,x,is2,&red->scatterout);CHKERRQ(ierr);
139fcfd50ebSBarry Smith         ierr = ISDestroy(&is1);CHKERRQ(ierr);
140fcfd50ebSBarry Smith         ierr = ISDestroy(&is2);CHKERRQ(ierr);
1411d79065fSBarry Smith         ierr = PetscFree2(idx1,idx2);CHKERRQ(ierr);
142ddc54837SHong Zhang         ierr = VecDestroy(&x);CHKERRQ(ierr);
143*1b81debcSHong Zhang       }
144*1b81debcSHong Zhang     }
145*1b81debcSHong Zhang   } /* endof (!pc->setupcalled) */
1464b9ad928SBarry Smith 
1474b9ad928SBarry Smith   if (red->useparallelmat) {
148*1b81debcSHong Zhang     /* grab the parallel matrix and put it into processors of a subcomminicator */
149*1b81debcSHong Zhang     /*--------------------------------------------------------------------------*/
1504b9ad928SBarry Smith     if (pc->setupcalled == 1 && pc->flag == DIFFERENT_NONZERO_PATTERN) {
1514b9ad928SBarry Smith       /* destroy old matrices */
1526bf464f9SBarry Smith       ierr = MatDestroy(&red->pmats);CHKERRQ(ierr);
1534b9ad928SBarry Smith     } else if (pc->setupcalled == 1) {
1544b9ad928SBarry Smith       reuse = MAT_REUSE_MATRIX;
1554b9ad928SBarry Smith       str   = SAME_NONZERO_PATTERN;
1564b9ad928SBarry Smith     }
157*1b81debcSHong Zhang     if (pc->setupcalled) {
158d3b23db5SHong Zhang       ierr = MatGetRedundantMatrix_MPIAIJ_interlaced(pc->pmat,red->psubcomm->n,red->psubcomm,reuse,&red->pmats);CHKERRQ(ierr);
15990f1c854SHong Zhang       ierr = KSPSetOperators(red->ksp,red->pmats,red->pmats,str);CHKERRQ(ierr);
160*1b81debcSHong Zhang     }
1614b9ad928SBarry Smith   } else {
16290f1c854SHong Zhang     ierr = KSPSetOperators(red->ksp,pc->mat,pc->pmat,pc->flag);CHKERRQ(ierr);
1634b9ad928SBarry Smith   }
164*1b81debcSHong Zhang 
1650c24e6a1SHong Zhang   if (pc->setfromoptionscalled) {
1663e065800SHong Zhang     ierr = KSPSetFromOptions(red->ksp);CHKERRQ(ierr);
1670c24e6a1SHong Zhang   }
1683e065800SHong Zhang   ierr = KSPSetUp(red->ksp);CHKERRQ(ierr);
1694b9ad928SBarry Smith   PetscFunctionReturn(0);
1704b9ad928SBarry Smith }
1714b9ad928SBarry Smith 
1724b9ad928SBarry Smith #undef __FUNCT__
1734b9ad928SBarry Smith #define __FUNCT__ "PCApply_Redundant"
1746849ba73SBarry Smith static PetscErrorCode PCApply_Redundant(PC pc,Vec x,Vec y)
1754b9ad928SBarry Smith {
1764b9ad928SBarry Smith   PC_Redundant   *red = (PC_Redundant*)pc->data;
177dfbe8321SBarry Smith   PetscErrorCode ierr;
1783f457be1SHong Zhang   PetscScalar    *array;
1794b9ad928SBarry Smith 
1804b9ad928SBarry Smith   PetscFunctionBegin;
181ddc54837SHong Zhang   if (!red->useparallelmat) {
182ddc54837SHong Zhang     ierr = KSPSolve(red->ksp,x,y);CHKERRQ(ierr);
183ddc54837SHong Zhang     PetscFunctionReturn(0);
184ddc54837SHong Zhang   }
185ddc54837SHong Zhang 
1863f457be1SHong Zhang   /* scatter x to xdup */
187ca9f406cSSatish Balay   ierr = VecScatterBegin(red->scatterin,x,red->xdup,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
188ca9f406cSSatish Balay   ierr = VecScatterEnd(red->scatterin,x,red->xdup,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
1893f457be1SHong Zhang 
1903f457be1SHong Zhang   /* place xdup's local array into xsub */
1913f457be1SHong Zhang   ierr = VecGetArray(red->xdup,&array);CHKERRQ(ierr);
1923f457be1SHong Zhang   ierr = VecPlaceArray(red->xsub,(const PetscScalar*)array);CHKERRQ(ierr);
1934b9ad928SBarry Smith 
1944b9ad928SBarry Smith   /* apply preconditioner on each processor */
19583ab6a24SBarry Smith   ierr = KSPSolve(red->ksp,red->xsub,red->ysub);CHKERRQ(ierr);
1963f457be1SHong Zhang   ierr = VecResetArray(red->xsub);CHKERRQ(ierr);
1973f457be1SHong Zhang   ierr = VecRestoreArray(red->xdup,&array);CHKERRQ(ierr);
1984b9ad928SBarry Smith 
1993f457be1SHong Zhang   /* place ysub's local array into ydup */
2003f457be1SHong Zhang   ierr = VecGetArray(red->ysub,&array);CHKERRQ(ierr);
2013f457be1SHong Zhang   ierr = VecPlaceArray(red->ydup,(const PetscScalar*)array);CHKERRQ(ierr);
2023f457be1SHong Zhang 
2033f457be1SHong Zhang   /* scatter ydup to y */
204ca9f406cSSatish Balay   ierr = VecScatterBegin(red->scatterout,red->ydup,y,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
205ca9f406cSSatish Balay   ierr = VecScatterEnd(red->scatterout,red->ydup,y,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
2063f457be1SHong Zhang   ierr = VecResetArray(red->ydup);CHKERRQ(ierr);
2073f457be1SHong Zhang   ierr = VecRestoreArray(red->ysub,&array);CHKERRQ(ierr);
2084b9ad928SBarry Smith   PetscFunctionReturn(0);
2094b9ad928SBarry Smith }
2104b9ad928SBarry Smith 
2114b9ad928SBarry Smith #undef __FUNCT__
2121ea5a559SBarry Smith #define __FUNCT__ "PCReset_Redundant"
2131ea5a559SBarry Smith static PetscErrorCode PCReset_Redundant(PC pc)
2144b9ad928SBarry Smith {
2154b9ad928SBarry Smith   PC_Redundant   *red = (PC_Redundant*)pc->data;
216dfbe8321SBarry Smith   PetscErrorCode ierr;
2174b9ad928SBarry Smith 
2184b9ad928SBarry Smith   PetscFunctionBegin;
219*1b81debcSHong Zhang   if (red->useparallelmat) {
2206bf464f9SBarry Smith     ierr = VecScatterDestroy(&red->scatterin);CHKERRQ(ierr);
2216bf464f9SBarry Smith     ierr = VecScatterDestroy(&red->scatterout);CHKERRQ(ierr);
2226bf464f9SBarry Smith     ierr = VecDestroy(&red->ysub);CHKERRQ(ierr);
2236bf464f9SBarry Smith     ierr = VecDestroy(&red->xsub);CHKERRQ(ierr);
2246bf464f9SBarry Smith     ierr = VecDestroy(&red->xdup);CHKERRQ(ierr);
2256bf464f9SBarry Smith     ierr = VecDestroy(&red->ydup);CHKERRQ(ierr);
226*1b81debcSHong Zhang   }
2276bf464f9SBarry Smith   ierr = MatDestroy(&red->pmats);CHKERRQ(ierr);
228*1b81debcSHong Zhang   ierr = KSPReset(red->ksp);CHKERRQ(ierr);
2291ea5a559SBarry Smith   PetscFunctionReturn(0);
2301ea5a559SBarry Smith }
2311ea5a559SBarry Smith 
2321ea5a559SBarry Smith #undef __FUNCT__
2331ea5a559SBarry Smith #define __FUNCT__ "PCDestroy_Redundant"
2341ea5a559SBarry Smith static PetscErrorCode PCDestroy_Redundant(PC pc)
2351ea5a559SBarry Smith {
2361ea5a559SBarry Smith   PC_Redundant   *red = (PC_Redundant*)pc->data;
2371ea5a559SBarry Smith   PetscErrorCode ierr;
2381ea5a559SBarry Smith 
2391ea5a559SBarry Smith   PetscFunctionBegin;
2401ea5a559SBarry Smith   ierr = PCReset_Redundant(pc);CHKERRQ(ierr);
2416bf464f9SBarry Smith   ierr = KSPDestroy(&red->ksp);CHKERRQ(ierr);
2426bf464f9SBarry Smith   ierr = PetscSubcommDestroy(&red->psubcomm);CHKERRQ(ierr);
243c31cb41cSBarry Smith   ierr = PetscFree(pc->data);CHKERRQ(ierr);
2444b9ad928SBarry Smith   PetscFunctionReturn(0);
2454b9ad928SBarry Smith }
2464b9ad928SBarry Smith 
2474b9ad928SBarry Smith #undef __FUNCT__
2484b9ad928SBarry Smith #define __FUNCT__ "PCSetFromOptions_Redundant"
2496849ba73SBarry Smith static PetscErrorCode PCSetFromOptions_Redundant(PC pc)
2504b9ad928SBarry Smith {
251a98ce0f4SHong Zhang   PetscErrorCode ierr;
252a98ce0f4SHong Zhang   PC_Redundant   *red = (PC_Redundant*)pc->data;
253a98ce0f4SHong Zhang 
2544b9ad928SBarry Smith   PetscFunctionBegin;
255a98ce0f4SHong Zhang   ierr = PetscOptionsHead("Redundant options");CHKERRQ(ierr);
25609a6bc64SHong Zhang   ierr = PetscOptionsInt("-pc_redundant_number","Number of redundant pc","PCRedundantSetNumber",red->nsubcomm,&red->nsubcomm,0);CHKERRQ(ierr);
257a98ce0f4SHong Zhang   ierr = PetscOptionsTail();CHKERRQ(ierr);
2584b9ad928SBarry Smith   PetscFunctionReturn(0);
2594b9ad928SBarry Smith }
2604b9ad928SBarry Smith 
2614b9ad928SBarry Smith #undef __FUNCT__
26209a6bc64SHong Zhang #define __FUNCT__ "PCRedundantSetNumber_Redundant"
263f7a08781SBarry Smith static PetscErrorCode  PCRedundantSetNumber_Redundant(PC pc,PetscInt nreds)
26409a6bc64SHong Zhang {
26509a6bc64SHong Zhang   PC_Redundant *red = (PC_Redundant*)pc->data;
26609a6bc64SHong Zhang 
26709a6bc64SHong Zhang   PetscFunctionBegin;
26809a6bc64SHong Zhang   red->nsubcomm = nreds;
26909a6bc64SHong Zhang   PetscFunctionReturn(0);
27009a6bc64SHong Zhang }
27109a6bc64SHong Zhang 
27209a6bc64SHong Zhang #undef __FUNCT__
27309a6bc64SHong Zhang #define __FUNCT__ "PCRedundantSetNumber"
27409a6bc64SHong Zhang /*@
27509a6bc64SHong Zhang    PCRedundantSetNumber - Sets the number of redundant preconditioner contexts.
27609a6bc64SHong Zhang 
2773f9fe445SBarry Smith    Logically Collective on PC
27809a6bc64SHong Zhang 
27909a6bc64SHong Zhang    Input Parameters:
28009a6bc64SHong Zhang +  pc - the preconditioner context
2819b21d695SBarry Smith -  nredundant - number of redundant preconditioner contexts; for example if you are using 64 MPI processes and
2829b21d695SBarry Smith                               use an nredundant of 4 there will be 4 parallel solves each on 16 = 64/4 processes.
28309a6bc64SHong Zhang 
28409a6bc64SHong Zhang    Level: advanced
28509a6bc64SHong Zhang 
28609a6bc64SHong Zhang .keywords: PC, redundant solve
28709a6bc64SHong Zhang @*/
2887087cfbeSBarry Smith PetscErrorCode  PCRedundantSetNumber(PC pc,PetscInt nredundant)
28909a6bc64SHong Zhang {
2904ac538c5SBarry Smith   PetscErrorCode ierr;
29109a6bc64SHong Zhang 
29209a6bc64SHong Zhang   PetscFunctionBegin;
2930700a824SBarry Smith   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
294ce94432eSBarry Smith   if (nredundant <= 0) SETERRQ1(PetscObjectComm((PetscObject)pc),PETSC_ERR_ARG_WRONG, "num of redundant pc %D must be positive",nredundant);
2954ac538c5SBarry Smith   ierr = PetscTryMethod(pc,"PCRedundantSetNumber_C",(PC,PetscInt),(pc,nredundant));CHKERRQ(ierr);
29609a6bc64SHong Zhang   PetscFunctionReturn(0);
29709a6bc64SHong Zhang }
29809a6bc64SHong Zhang 
29909a6bc64SHong Zhang #undef __FUNCT__
3004b9ad928SBarry Smith #define __FUNCT__ "PCRedundantSetScatter_Redundant"
301f7a08781SBarry Smith static PetscErrorCode  PCRedundantSetScatter_Redundant(PC pc,VecScatter in,VecScatter out)
3024b9ad928SBarry Smith {
3034b9ad928SBarry Smith   PC_Redundant   *red = (PC_Redundant*)pc->data;
304dfbe8321SBarry Smith   PetscErrorCode ierr;
3054b9ad928SBarry Smith 
3064b9ad928SBarry Smith   PetscFunctionBegin;
3074b9ad928SBarry Smith   ierr = PetscObjectReference((PetscObject)in);CHKERRQ(ierr);
3086bf464f9SBarry Smith   ierr = VecScatterDestroy(&red->scatterin);CHKERRQ(ierr);
3092fa5cd67SKarl Rupp 
310c3122656SLisandro Dalcin   red->scatterin  = in;
3112fa5cd67SKarl Rupp 
3124b9ad928SBarry Smith   ierr = PetscObjectReference((PetscObject)out);CHKERRQ(ierr);
3136bf464f9SBarry Smith   ierr = VecScatterDestroy(&red->scatterout);CHKERRQ(ierr);
314c3122656SLisandro Dalcin   red->scatterout = out;
3154b9ad928SBarry Smith   PetscFunctionReturn(0);
3164b9ad928SBarry Smith }
3174b9ad928SBarry Smith 
3184b9ad928SBarry Smith #undef __FUNCT__
3194b9ad928SBarry Smith #define __FUNCT__ "PCRedundantSetScatter"
3204b9ad928SBarry Smith /*@
3214b9ad928SBarry Smith    PCRedundantSetScatter - Sets the scatter used to copy values into the
3224b9ad928SBarry Smith      redundant local solve and the scatter to move them back into the global
3234b9ad928SBarry Smith      vector.
3244b9ad928SBarry Smith 
3253f9fe445SBarry Smith    Logically Collective on PC
3264b9ad928SBarry Smith 
3274b9ad928SBarry Smith    Input Parameters:
3284b9ad928SBarry Smith +  pc - the preconditioner context
3294b9ad928SBarry Smith .  in - the scatter to move the values in
3304b9ad928SBarry Smith -  out - the scatter to move them out
3314b9ad928SBarry Smith 
3324b9ad928SBarry Smith    Level: advanced
3334b9ad928SBarry Smith 
3344b9ad928SBarry Smith .keywords: PC, redundant solve
3354b9ad928SBarry Smith @*/
3367087cfbeSBarry Smith PetscErrorCode  PCRedundantSetScatter(PC pc,VecScatter in,VecScatter out)
3374b9ad928SBarry Smith {
3384ac538c5SBarry Smith   PetscErrorCode ierr;
3394b9ad928SBarry Smith 
3404b9ad928SBarry Smith   PetscFunctionBegin;
3410700a824SBarry Smith   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
3420700a824SBarry Smith   PetscValidHeaderSpecific(in,VEC_SCATTER_CLASSID,2);
3430700a824SBarry Smith   PetscValidHeaderSpecific(out,VEC_SCATTER_CLASSID,3);
3444ac538c5SBarry Smith   ierr = PetscTryMethod(pc,"PCRedundantSetScatter_C",(PC,VecScatter,VecScatter),(pc,in,out));CHKERRQ(ierr);
3454b9ad928SBarry Smith   PetscFunctionReturn(0);
3464b9ad928SBarry Smith }
3474b9ad928SBarry Smith 
3484b9ad928SBarry Smith #undef __FUNCT__
34983ab6a24SBarry Smith #define __FUNCT__ "PCRedundantGetKSP_Redundant"
350f7a08781SBarry Smith static PetscErrorCode  PCRedundantGetKSP_Redundant(PC pc,KSP *innerksp)
3514b9ad928SBarry Smith {
3525f06b7aaSBarry Smith   PetscErrorCode ierr;
3534b9ad928SBarry Smith   PC_Redundant   *red = (PC_Redundant*)pc->data;
3545f06b7aaSBarry Smith   MPI_Comm       comm,subcomm;
3555f06b7aaSBarry Smith   const char     *prefix;
3564b9ad928SBarry Smith 
3574b9ad928SBarry Smith   PetscFunctionBegin;
3585f06b7aaSBarry Smith   if (!red->psubcomm) {
3595f06b7aaSBarry Smith     ierr = PetscObjectGetComm((PetscObject)pc,&comm);CHKERRQ(ierr);
360d8a68f86SHong Zhang     ierr = PetscSubcommCreate(comm,&red->psubcomm);CHKERRQ(ierr);
361d8a68f86SHong Zhang     ierr = PetscSubcommSetNumber(red->psubcomm,red->nsubcomm);CHKERRQ(ierr);
362d8a68f86SHong Zhang     ierr = PetscSubcommSetType(red->psubcomm,PETSC_SUBCOMM_INTERLACED);CHKERRQ(ierr);
3635f06b7aaSBarry Smith     ierr = PetscLogObjectMemory(pc,sizeof(PetscSubcomm));CHKERRQ(ierr);
3645f06b7aaSBarry Smith 
3655f06b7aaSBarry Smith     /* create a new PC that processors in each subcomm have copy of */
3665f06b7aaSBarry Smith     subcomm = red->psubcomm->comm;
3672fa5cd67SKarl Rupp 
3685f06b7aaSBarry Smith     ierr = KSPCreate(subcomm,&red->ksp);CHKERRQ(ierr);
3695f06b7aaSBarry Smith     ierr = PetscObjectIncrementTabLevel((PetscObject)red->ksp,(PetscObject)pc,1);CHKERRQ(ierr);
3705f06b7aaSBarry Smith     ierr = PetscLogObjectParent(pc,red->ksp);CHKERRQ(ierr);
3715f06b7aaSBarry Smith     ierr = KSPSetType(red->ksp,KSPPREONLY);CHKERRQ(ierr);
3725f06b7aaSBarry Smith     ierr = KSPGetPC(red->ksp,&red->pc);CHKERRQ(ierr);
3735f06b7aaSBarry Smith     ierr = PCSetType(red->pc,PCLU);CHKERRQ(ierr);
3745f06b7aaSBarry Smith 
3755f06b7aaSBarry Smith     ierr = PCGetOptionsPrefix(pc,&prefix);CHKERRQ(ierr);
3765f06b7aaSBarry Smith     ierr = KSPSetOptionsPrefix(red->ksp,prefix);CHKERRQ(ierr);
3775f06b7aaSBarry Smith     ierr = KSPAppendOptionsPrefix(red->ksp,"redundant_");CHKERRQ(ierr);
3785f06b7aaSBarry Smith   }
37983ab6a24SBarry Smith   *innerksp = red->ksp;
3804b9ad928SBarry Smith   PetscFunctionReturn(0);
3814b9ad928SBarry Smith }
3824b9ad928SBarry Smith 
3834b9ad928SBarry Smith #undef __FUNCT__
38483ab6a24SBarry Smith #define __FUNCT__ "PCRedundantGetKSP"
3854b9ad928SBarry Smith /*@
38683ab6a24SBarry Smith    PCRedundantGetKSP - Gets the less parallel KSP created by the redundant PC.
3874b9ad928SBarry Smith 
3884b9ad928SBarry Smith    Not Collective
3894b9ad928SBarry Smith 
3904b9ad928SBarry Smith    Input Parameter:
3914b9ad928SBarry Smith .  pc - the preconditioner context
3924b9ad928SBarry Smith 
3934b9ad928SBarry Smith    Output Parameter:
39483ab6a24SBarry Smith .  innerksp - the KSP on the smaller set of processes
3954b9ad928SBarry Smith 
3964b9ad928SBarry Smith    Level: advanced
3974b9ad928SBarry Smith 
3984b9ad928SBarry Smith .keywords: PC, redundant solve
3994b9ad928SBarry Smith @*/
40083ab6a24SBarry Smith PetscErrorCode  PCRedundantGetKSP(PC pc,KSP *innerksp)
4014b9ad928SBarry Smith {
4024ac538c5SBarry Smith   PetscErrorCode ierr;
4034b9ad928SBarry Smith 
4044b9ad928SBarry Smith   PetscFunctionBegin;
4050700a824SBarry Smith   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
40683ab6a24SBarry Smith   PetscValidPointer(innerksp,2);
40783ab6a24SBarry Smith   ierr = PetscTryMethod(pc,"PCRedundantGetKSP_C",(PC,KSP*),(pc,innerksp));CHKERRQ(ierr);
4084b9ad928SBarry Smith   PetscFunctionReturn(0);
4094b9ad928SBarry Smith }
4104b9ad928SBarry Smith 
4114b9ad928SBarry Smith #undef __FUNCT__
4124b9ad928SBarry Smith #define __FUNCT__ "PCRedundantGetOperators_Redundant"
413f7a08781SBarry Smith static PetscErrorCode  PCRedundantGetOperators_Redundant(PC pc,Mat *mat,Mat *pmat)
4144b9ad928SBarry Smith {
4154b9ad928SBarry Smith   PC_Redundant *red = (PC_Redundant*)pc->data;
4164b9ad928SBarry Smith 
4174b9ad928SBarry Smith   PetscFunctionBegin;
418b3804887SHong Zhang   if (mat)  *mat  = red->pmats;
419b3804887SHong Zhang   if (pmat) *pmat = red->pmats;
4204b9ad928SBarry Smith   PetscFunctionReturn(0);
4214b9ad928SBarry Smith }
4224b9ad928SBarry Smith 
4234b9ad928SBarry Smith #undef __FUNCT__
4244b9ad928SBarry Smith #define __FUNCT__ "PCRedundantGetOperators"
4254b9ad928SBarry Smith /*@
4264b9ad928SBarry Smith    PCRedundantGetOperators - gets the sequential matrix and preconditioner matrix
4274b9ad928SBarry Smith 
4284b9ad928SBarry Smith    Not Collective
4294b9ad928SBarry Smith 
4304b9ad928SBarry Smith    Input Parameter:
4314b9ad928SBarry Smith .  pc - the preconditioner context
4324b9ad928SBarry Smith 
4334b9ad928SBarry Smith    Output Parameters:
4344b9ad928SBarry Smith +  mat - the matrix
4354b9ad928SBarry Smith -  pmat - the (possibly different) preconditioner matrix
4364b9ad928SBarry Smith 
4374b9ad928SBarry Smith    Level: advanced
4384b9ad928SBarry Smith 
4394b9ad928SBarry Smith .keywords: PC, redundant solve
4404b9ad928SBarry Smith @*/
4417087cfbeSBarry Smith PetscErrorCode  PCRedundantGetOperators(PC pc,Mat *mat,Mat *pmat)
4424b9ad928SBarry Smith {
4434ac538c5SBarry Smith   PetscErrorCode ierr;
4444b9ad928SBarry Smith 
4454b9ad928SBarry Smith   PetscFunctionBegin;
4460700a824SBarry Smith   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
4474482741eSBarry Smith   if (mat)  PetscValidPointer(mat,2);
4484482741eSBarry Smith   if (pmat) PetscValidPointer(pmat,3);
4494ac538c5SBarry Smith   ierr = PetscTryMethod(pc,"PCRedundantGetOperators_C",(PC,Mat*,Mat*),(pc,mat,pmat));CHKERRQ(ierr);
4504b9ad928SBarry Smith   PetscFunctionReturn(0);
4514b9ad928SBarry Smith }
4524b9ad928SBarry Smith 
4534b9ad928SBarry Smith /* -------------------------------------------------------------------------------------*/
45437a17b4dSBarry Smith /*MC
45583ab6a24SBarry Smith      PCREDUNDANT - Runs a KSP solver with preconditioner for the entire problem on subgroups of processors
45637a17b4dSBarry Smith 
45783ab6a24SBarry Smith      Options for the redundant preconditioners can be set with -redundant_pc_xxx for the redundant KSP with -redundant_ksp_xxx
45837a17b4dSBarry Smith 
45909391456SBarry Smith   Options Database:
4609b21d695SBarry Smith .  -pc_redundant_number <n> - number of redundant solves, for example if you are using 64 MPI processes and
4619b21d695SBarry Smith                               use an n of 4 there will be 4 parallel solves each on 16 = 64/4 processes.
46209391456SBarry Smith 
46337a17b4dSBarry Smith    Level: intermediate
46437a17b4dSBarry Smith 
46583ab6a24SBarry Smith    Notes: The default KSP is preonly and the default PC is LU.
46683ab6a24SBarry Smith 
46783ab6a24SBarry Smith    Developer Notes: Note that PCSetInitialGuessNonzero()  is not used by this class but likely should be.
4689cfaa89bSBarry Smith 
46937a17b4dSBarry Smith .seealso:  PCCreate(), PCSetType(), PCType (for list of available types), PCRedundantSetScatter(),
47083ab6a24SBarry Smith            PCRedundantGetKSP(), PCRedundantGetOperators(), PCRedundantSetNumber()
47137a17b4dSBarry Smith M*/
47237a17b4dSBarry Smith 
4734b9ad928SBarry Smith #undef __FUNCT__
4744b9ad928SBarry Smith #define __FUNCT__ "PCCreate_Redundant"
4758cc058d9SJed Brown PETSC_EXTERN PetscErrorCode PCCreate_Redundant(PC pc)
4764b9ad928SBarry Smith {
477dfbe8321SBarry Smith   PetscErrorCode ierr;
4784b9ad928SBarry Smith   PC_Redundant   *red;
47969db28dcSHong Zhang   PetscMPIInt    size;
4803f457be1SHong Zhang 
4814b9ad928SBarry Smith   PetscFunctionBegin;
48238f2d2fdSLisandro Dalcin   ierr = PetscNewLog(pc,PC_Redundant,&red);CHKERRQ(ierr);
483ce94432eSBarry Smith   ierr = MPI_Comm_size(PetscObjectComm((PetscObject)pc),&size);CHKERRQ(ierr);
4842fa5cd67SKarl Rupp 
48569db28dcSHong Zhang   red->nsubcomm       = size;
4864b9ad928SBarry Smith   red->useparallelmat = PETSC_TRUE;
4871fbd8f88SHong Zhang   pc->data            = (void*)red;
4884b9ad928SBarry Smith 
4894b9ad928SBarry Smith   pc->ops->apply          = PCApply_Redundant;
4904b9ad928SBarry Smith   pc->ops->applytranspose = 0;
4914b9ad928SBarry Smith   pc->ops->setup          = PCSetUp_Redundant;
4924b9ad928SBarry Smith   pc->ops->destroy        = PCDestroy_Redundant;
4931ea5a559SBarry Smith   pc->ops->reset          = PCReset_Redundant;
4944b9ad928SBarry Smith   pc->ops->setfromoptions = PCSetFromOptions_Redundant;
4954b9ad928SBarry Smith   pc->ops->view           = PCView_Redundant;
4962fa5cd67SKarl Rupp 
497bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCRedundantSetScatter_C",PCRedundantSetScatter_Redundant);CHKERRQ(ierr);
498bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCRedundantSetNumber_C",PCRedundantSetNumber_Redundant);CHKERRQ(ierr);
499bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCRedundantGetKSP_C",PCRedundantGetKSP_Redundant);CHKERRQ(ierr);
500bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCRedundantGetOperators_C",PCRedundantGetOperators_Redundant);CHKERRQ(ierr);
5014b9ad928SBarry Smith   PetscFunctionReturn(0);
5024b9ad928SBarry Smith }
503b2573a8aSBarry Smith 
504