xref: /petsc/src/ksp/pc/impls/ml/ml.c (revision 03bfa161b0c9169fdd44c9a6bf822bf80eba9ca4)
1ab718edeSHong Zhang 
25582bec1SHong Zhang /*
32dccc152SHong Zhang    Provides an interface to the ML smoothed Aggregation
47ffd031bSHong Zhang    Note: Something non-obvious breaks -pc_mg_type ADDITIVE for parallel runs
57ffd031bSHong Zhang                                     Jed Brown, see [PETSC #18321, #18449].
65582bec1SHong Zhang */
7c6db04a5SJed Brown #include <private/pcimpl.h>   /*I "petscpc.h" I*/
8c6db04a5SJed Brown #include <../src/ksp/pc/impls/mg/mgimpl.h>                    /*I "petscpcmg.h" I*/
9c6db04a5SJed Brown #include <../src/mat/impls/aij/seq/aij.h>
10c6db04a5SJed Brown #include <../src/mat/impls/aij/mpi/mpiaij.h>
11cb5d8e9eSHong Zhang 
125582bec1SHong Zhang #include <math.h>
132cf39c26SSatish Balay EXTERN_C_BEGIN
1468210224SSatish Balay /* HAVE_CONFIG_H flag is required by ML include files */
1568210224SSatish Balay #if !defined(HAVE_CONFIG_H)
1668210224SSatish Balay #define HAVE_CONFIG_H
1768210224SSatish Balay #endif
18c6db04a5SJed Brown #include <ml_include.h>
195582bec1SHong Zhang EXTERN_C_END
205582bec1SHong Zhang 
215582bec1SHong Zhang /* The context (data structure) at each grid level */
225582bec1SHong Zhang typedef struct {
235582bec1SHong Zhang   Vec        x,b,r;           /* global vectors */
245582bec1SHong Zhang   Mat        A,P,R;
255582bec1SHong Zhang   KSP        ksp;
265582bec1SHong Zhang } GridCtx;
275582bec1SHong Zhang 
285582bec1SHong Zhang /* The context used to input PETSc matrix into ML at fine grid */
295582bec1SHong Zhang typedef struct {
30573998d7SHong Zhang   Mat          A;      /* Petsc matrix in aij format */
31573998d7SHong Zhang   Mat          Aloc;   /* local portion of A to be used by ML */
3224a42b14SHong Zhang   Vec          x,y;
335582bec1SHong Zhang   ML_Operator  *mlmat;
345582bec1SHong Zhang   PetscScalar  *pwork; /* tmp array used by PetscML_comm() */
355582bec1SHong Zhang } FineGridCtx;
365582bec1SHong Zhang 
375582bec1SHong Zhang /* The context associates a ML matrix with a PETSc shell matrix */
385582bec1SHong Zhang typedef struct {
395582bec1SHong Zhang   Mat          A;       /* PETSc shell matrix associated with mlmat */
405582bec1SHong Zhang   ML_Operator  *mlmat;  /* ML matrix assorciated with A */
4167d6f150SMatthew G Knepley   Vec          y, work;
425582bec1SHong Zhang } Mat_MLShell;
435582bec1SHong Zhang 
445582bec1SHong Zhang /* Private context for the ML preconditioner */
455582bec1SHong Zhang typedef struct {
465582bec1SHong Zhang   ML             *ml_object;
475582bec1SHong Zhang   ML_Aggregate   *agg_object;
485582bec1SHong Zhang   GridCtx        *gridctx;
495582bec1SHong Zhang   FineGridCtx    *PetscMLdata;
50b5c8bdf8SJed Brown   PetscInt       Nlevels,MaxNlevels,MaxCoarseSize,CoarsenScheme,EnergyMinimization;
51b5c8bdf8SJed Brown   PetscReal      Threshold,DampingFactor,EnergyMinimizationDropTol;
52ace3abfcSBarry Smith   PetscBool      SpectralNormScheme_Anorm,BlockScaling,EnergyMinimizationCheap,Symmetrize,OldHierarchy,KeepAggInfo,Reusable;
53573998d7SHong Zhang   PetscMPIInt    size; /* size of communicator for pc->pmat */
545582bec1SHong Zhang } PC_ML;
5541ca0015SHong Zhang 
566562c4e1SBarry Smith #undef __FUNCT__
576562c4e1SBarry Smith #define __FUNCT__ "PetscML_getrow"
586562c4e1SBarry Smith static int PetscML_getrow(ML_Operator *ML_data, int N_requested_rows, int requested_rows[],int allocated_space, int columns[], double values[], int row_lengths[])
596562c4e1SBarry Smith {
606562c4e1SBarry Smith   PetscErrorCode ierr;
616562c4e1SBarry Smith   PetscInt       m,i,j,k=0,row,*aj;
626562c4e1SBarry Smith   PetscScalar    *aa;
636562c4e1SBarry Smith   FineGridCtx    *ml=(FineGridCtx*)ML_Get_MyGetrowData(ML_data);
646562c4e1SBarry Smith   Mat_SeqAIJ     *a = (Mat_SeqAIJ*)ml->Aloc->data;
655582bec1SHong Zhang 
666562c4e1SBarry Smith 
676562c4e1SBarry Smith   ierr = MatGetSize(ml->Aloc,&m,PETSC_NULL); if (ierr) return(0);
686562c4e1SBarry Smith   for (i = 0; i<N_requested_rows; i++) {
696562c4e1SBarry Smith     row   = requested_rows[i];
706562c4e1SBarry Smith     row_lengths[i] = a->ilen[row];
716562c4e1SBarry Smith     if (allocated_space < k+row_lengths[i]) return(0);
726562c4e1SBarry Smith     if ( (row >= 0) || (row <= (m-1)) ) {
736562c4e1SBarry Smith       aj = a->j + a->i[row];
746562c4e1SBarry Smith       aa = a->a + a->i[row];
756562c4e1SBarry Smith       for (j=0; j<row_lengths[i]; j++){
766562c4e1SBarry Smith         columns[k]  = aj[j];
776562c4e1SBarry Smith         values[k++] = aa[j];
786562c4e1SBarry Smith       }
796562c4e1SBarry Smith     }
806562c4e1SBarry Smith   }
816562c4e1SBarry Smith   return(1);
826562c4e1SBarry Smith }
836562c4e1SBarry Smith 
846562c4e1SBarry Smith #undef __FUNCT__
856562c4e1SBarry Smith #define __FUNCT__ "PetscML_comm"
866562c4e1SBarry Smith static PetscErrorCode PetscML_comm(double p[],void *ML_data)
876562c4e1SBarry Smith {
886562c4e1SBarry Smith   PetscErrorCode ierr;
896562c4e1SBarry Smith   FineGridCtx    *ml=(FineGridCtx*)ML_data;
906562c4e1SBarry Smith   Mat            A=ml->A;
916562c4e1SBarry Smith   Mat_MPIAIJ     *a = (Mat_MPIAIJ*)A->data;
926562c4e1SBarry Smith   PetscMPIInt    size;
936562c4e1SBarry Smith   PetscInt       i,in_length=A->rmap->n,out_length=ml->Aloc->cmap->n;
946562c4e1SBarry Smith   PetscScalar    *array;
956562c4e1SBarry Smith 
966562c4e1SBarry Smith   PetscFunctionBegin;
976562c4e1SBarry Smith   ierr = MPI_Comm_size(((PetscObject)A)->comm,&size);CHKERRQ(ierr);
986562c4e1SBarry Smith   if (size == 1) return 0;
996562c4e1SBarry Smith 
1006562c4e1SBarry Smith   ierr = VecPlaceArray(ml->y,p);CHKERRQ(ierr);
1016562c4e1SBarry Smith   ierr = VecScatterBegin(a->Mvctx,ml->y,a->lvec,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
1026562c4e1SBarry Smith   ierr = VecScatterEnd(a->Mvctx,ml->y,a->lvec,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
1036562c4e1SBarry Smith   ierr = VecResetArray(ml->y);CHKERRQ(ierr);
1046562c4e1SBarry Smith   ierr = VecGetArray(a->lvec,&array);CHKERRQ(ierr);
1056562c4e1SBarry Smith   for (i=in_length; i<out_length; i++){
1066562c4e1SBarry Smith     p[i] = array[i-in_length];
1076562c4e1SBarry Smith   }
1086562c4e1SBarry Smith   ierr = VecRestoreArray(a->lvec,&array);CHKERRQ(ierr);
1096562c4e1SBarry Smith   PetscFunctionReturn(0);
1106562c4e1SBarry Smith }
1116562c4e1SBarry Smith 
1126562c4e1SBarry Smith #undef __FUNCT__
1136562c4e1SBarry Smith #define __FUNCT__ "PetscML_matvec"
1146562c4e1SBarry Smith static int PetscML_matvec(ML_Operator *ML_data,int in_length,double p[],int out_length,double ap[])
1156562c4e1SBarry Smith {
1166562c4e1SBarry Smith   PetscErrorCode ierr;
1176562c4e1SBarry Smith   FineGridCtx    *ml=(FineGridCtx*)ML_Get_MyMatvecData(ML_data);
1186562c4e1SBarry Smith   Mat            A=ml->A, Aloc=ml->Aloc;
1196562c4e1SBarry Smith   PetscMPIInt    size;
1206562c4e1SBarry Smith   PetscScalar    *pwork=ml->pwork;
1216562c4e1SBarry Smith   PetscInt       i;
1226562c4e1SBarry Smith 
1236562c4e1SBarry Smith   PetscFunctionBegin;
1246562c4e1SBarry Smith   ierr = MPI_Comm_size(((PetscObject)A)->comm,&size);CHKERRQ(ierr);
1256562c4e1SBarry Smith   if (size == 1){
1266562c4e1SBarry Smith     ierr = VecPlaceArray(ml->x,p);CHKERRQ(ierr);
1276562c4e1SBarry Smith   } else {
1286562c4e1SBarry Smith     for (i=0; i<in_length; i++) pwork[i] = p[i];
1296562c4e1SBarry Smith     PetscML_comm(pwork,ml);
1306562c4e1SBarry Smith     ierr = VecPlaceArray(ml->x,pwork);CHKERRQ(ierr);
1316562c4e1SBarry Smith   }
1326562c4e1SBarry Smith   ierr = VecPlaceArray(ml->y,ap);CHKERRQ(ierr);
1336562c4e1SBarry Smith   ierr = MatMult(Aloc,ml->x,ml->y);CHKERRQ(ierr);
1346562c4e1SBarry Smith   ierr = VecResetArray(ml->x);CHKERRQ(ierr);
1356562c4e1SBarry Smith   ierr = VecResetArray(ml->y);CHKERRQ(ierr);
1366562c4e1SBarry Smith   PetscFunctionReturn(0);
1376562c4e1SBarry Smith }
1386562c4e1SBarry Smith 
1396562c4e1SBarry Smith #undef __FUNCT__
1406562c4e1SBarry Smith #define __FUNCT__ "MatMult_ML"
1416562c4e1SBarry Smith static PetscErrorCode MatMult_ML(Mat A,Vec x,Vec y)
1426562c4e1SBarry Smith {
1436562c4e1SBarry Smith   PetscErrorCode   ierr;
1446562c4e1SBarry Smith   Mat_MLShell      *shell;
1456562c4e1SBarry Smith   PetscScalar      *xarray,*yarray;
1466562c4e1SBarry Smith   PetscInt         x_length,y_length;
1476562c4e1SBarry Smith 
1486562c4e1SBarry Smith   PetscFunctionBegin;
1496562c4e1SBarry Smith   ierr = MatShellGetContext(A,(void **)&shell);CHKERRQ(ierr);
1506562c4e1SBarry Smith   ierr = VecGetArray(x,&xarray);CHKERRQ(ierr);
1516562c4e1SBarry Smith   ierr = VecGetArray(y,&yarray);CHKERRQ(ierr);
1526562c4e1SBarry Smith   x_length = shell->mlmat->invec_leng;
1536562c4e1SBarry Smith   y_length = shell->mlmat->outvec_leng;
1546562c4e1SBarry Smith   ML_Operator_Apply(shell->mlmat,x_length,xarray,y_length,yarray);
1556562c4e1SBarry Smith   ierr = VecRestoreArray(x,&xarray);CHKERRQ(ierr);
1566562c4e1SBarry Smith   ierr = VecRestoreArray(y,&yarray);CHKERRQ(ierr);
1576562c4e1SBarry Smith   PetscFunctionReturn(0);
1586562c4e1SBarry Smith }
1596562c4e1SBarry Smith 
1606562c4e1SBarry Smith #undef __FUNCT__
1616562c4e1SBarry Smith #define __FUNCT__ "MatMultAdd_ML"
16267d6f150SMatthew G Knepley /* Computes y = w + A * x
16367d6f150SMatthew G Knepley    It is possible that w == y, but not x == y
16467d6f150SMatthew G Knepley */
1656562c4e1SBarry Smith static PetscErrorCode MatMultAdd_ML(Mat A,Vec x,Vec w,Vec y)
1666562c4e1SBarry Smith {
1676562c4e1SBarry Smith   Mat_MLShell   *shell;
1686562c4e1SBarry Smith   PetscScalar   *xarray,*yarray;
1696562c4e1SBarry Smith   PetscInt       x_length,y_length;
17067d6f150SMatthew G Knepley   PetscErrorCode ierr;
1716562c4e1SBarry Smith 
1726562c4e1SBarry Smith   PetscFunctionBegin;
1736562c4e1SBarry Smith   ierr = MatShellGetContext(A, (void **) &shell);CHKERRQ(ierr);
17467d6f150SMatthew G Knepley   if (y == w) {
17567d6f150SMatthew G Knepley     if (!shell->work) {
17667d6f150SMatthew G Knepley       ierr = VecDuplicate(y, &shell->work);CHKERRQ(ierr);
17767d6f150SMatthew G Knepley     }
17867d6f150SMatthew G Knepley     ierr = VecGetArray(x,           &xarray);CHKERRQ(ierr);
17967d6f150SMatthew G Knepley     ierr = VecGetArray(shell->work, &yarray);CHKERRQ(ierr);
18067d6f150SMatthew G Knepley     x_length = shell->mlmat->invec_leng;
18167d6f150SMatthew G Knepley     y_length = shell->mlmat->outvec_leng;
18267d6f150SMatthew G Knepley     ML_Operator_Apply(shell->mlmat, x_length, xarray, y_length, yarray);
18367d6f150SMatthew G Knepley     ierr = VecRestoreArray(x,           &xarray);CHKERRQ(ierr);
18467d6f150SMatthew G Knepley     ierr = VecRestoreArray(shell->work, &yarray);CHKERRQ(ierr);
1853ba3408dSMatthew G Knepley     ierr = VecAXPY(y, 1.0, shell->work);CHKERRQ(ierr);
18667d6f150SMatthew G Knepley   } else {
1876562c4e1SBarry Smith     ierr = VecGetArray(x, &xarray);CHKERRQ(ierr);
1886562c4e1SBarry Smith     ierr = VecGetArray(y, &yarray);CHKERRQ(ierr);
1896562c4e1SBarry Smith     x_length = shell->mlmat->invec_leng;
1906562c4e1SBarry Smith     y_length = shell->mlmat->outvec_leng;
1916562c4e1SBarry Smith     ML_Operator_Apply(shell->mlmat, x_length, xarray, y_length, yarray);
1926562c4e1SBarry Smith     ierr = VecRestoreArray(x, &xarray);CHKERRQ(ierr);
1936562c4e1SBarry Smith     ierr = VecRestoreArray(y, &yarray);CHKERRQ(ierr);
1946562c4e1SBarry Smith     ierr = VecAXPY(y, 1.0, w);CHKERRQ(ierr);
19567d6f150SMatthew G Knepley   }
1966562c4e1SBarry Smith   PetscFunctionReturn(0);
1976562c4e1SBarry Smith }
1986562c4e1SBarry Smith 
1996562c4e1SBarry Smith /* newtype is ignored because "ml" is not listed under Petsc MatType */
2006562c4e1SBarry Smith #undef __FUNCT__
2016562c4e1SBarry Smith #define __FUNCT__ "MatConvert_MPIAIJ_ML"
2026562c4e1SBarry Smith static PetscErrorCode MatConvert_MPIAIJ_ML(Mat A,MatType newtype,MatReuse scall,Mat *Aloc)
2036562c4e1SBarry Smith {
2046562c4e1SBarry Smith   PetscErrorCode  ierr;
2056562c4e1SBarry Smith   Mat_MPIAIJ      *mpimat=(Mat_MPIAIJ*)A->data;
2066562c4e1SBarry Smith   Mat_SeqAIJ      *mat,*a=(Mat_SeqAIJ*)(mpimat->A)->data,*b=(Mat_SeqAIJ*)(mpimat->B)->data;
2076562c4e1SBarry Smith   PetscInt        *ai=a->i,*aj=a->j,*bi=b->i,*bj=b->j;
2086562c4e1SBarry Smith   PetscScalar     *aa=a->a,*ba=b->a,*ca;
2096562c4e1SBarry Smith   PetscInt        am=A->rmap->n,an=A->cmap->n,i,j,k;
2106562c4e1SBarry Smith   PetscInt        *ci,*cj,ncols;
2116562c4e1SBarry Smith 
2126562c4e1SBarry Smith   PetscFunctionBegin;
213e32f2f54SBarry Smith   if (am != an) SETERRQ2(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"A must have a square diagonal portion, am: %d != an: %d",am,an);
2146562c4e1SBarry Smith 
2156562c4e1SBarry Smith   if (scall == MAT_INITIAL_MATRIX){
2166562c4e1SBarry Smith     ierr = PetscMalloc((1+am)*sizeof(PetscInt),&ci);CHKERRQ(ierr);
2176562c4e1SBarry Smith     ci[0] = 0;
2186562c4e1SBarry Smith     for (i=0; i<am; i++){
2196562c4e1SBarry Smith       ci[i+1] = ci[i] + (ai[i+1] - ai[i]) + (bi[i+1] - bi[i]);
2206562c4e1SBarry Smith     }
2216562c4e1SBarry Smith     ierr = PetscMalloc((1+ci[am])*sizeof(PetscInt),&cj);CHKERRQ(ierr);
2226562c4e1SBarry Smith     ierr = PetscMalloc((1+ci[am])*sizeof(PetscScalar),&ca);CHKERRQ(ierr);
2236562c4e1SBarry Smith 
2246562c4e1SBarry Smith     k = 0;
2256562c4e1SBarry Smith     for (i=0; i<am; i++){
2266562c4e1SBarry Smith       /* diagonal portion of A */
2276562c4e1SBarry Smith       ncols = ai[i+1] - ai[i];
2286562c4e1SBarry Smith       for (j=0; j<ncols; j++) {
2296562c4e1SBarry Smith         cj[k]   = *aj++;
2306562c4e1SBarry Smith         ca[k++] = *aa++;
2316562c4e1SBarry Smith       }
2326562c4e1SBarry Smith       /* off-diagonal portion of A */
2336562c4e1SBarry Smith       ncols = bi[i+1] - bi[i];
2346562c4e1SBarry Smith       for (j=0; j<ncols; j++) {
2356562c4e1SBarry Smith         cj[k]   = an + (*bj); bj++;
2366562c4e1SBarry Smith         ca[k++] = *ba++;
2376562c4e1SBarry Smith       }
2386562c4e1SBarry Smith     }
239e32f2f54SBarry Smith     if (k != ci[am]) SETERRQ2(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"k: %d != ci[am]: %d",k,ci[am]);
2406562c4e1SBarry Smith 
2416562c4e1SBarry Smith     /* put together the new matrix */
2426562c4e1SBarry Smith     an = mpimat->A->cmap->n+mpimat->B->cmap->n;
2436562c4e1SBarry Smith     ierr = MatCreateSeqAIJWithArrays(PETSC_COMM_SELF,am,an,ci,cj,ca,Aloc);CHKERRQ(ierr);
2446562c4e1SBarry Smith 
2456562c4e1SBarry Smith     /* MatCreateSeqAIJWithArrays flags matrix so PETSc doesn't free the user's arrays. */
2466562c4e1SBarry Smith     /* Since these are PETSc arrays, change flags to free them as necessary. */
2476562c4e1SBarry Smith     mat = (Mat_SeqAIJ*)(*Aloc)->data;
2486562c4e1SBarry Smith     mat->free_a       = PETSC_TRUE;
2496562c4e1SBarry Smith     mat->free_ij      = PETSC_TRUE;
2506562c4e1SBarry Smith 
2516562c4e1SBarry Smith     mat->nonew    = 0;
2526562c4e1SBarry Smith   } else if (scall == MAT_REUSE_MATRIX){
2536562c4e1SBarry Smith     mat=(Mat_SeqAIJ*)(*Aloc)->data;
2546562c4e1SBarry Smith     ci = mat->i; cj = mat->j; ca = mat->a;
2556562c4e1SBarry Smith     for (i=0; i<am; i++) {
2566562c4e1SBarry Smith       /* diagonal portion of A */
2576562c4e1SBarry Smith       ncols = ai[i+1] - ai[i];
2586562c4e1SBarry Smith       for (j=0; j<ncols; j++) *ca++ = *aa++;
2596562c4e1SBarry Smith       /* off-diagonal portion of A */
2606562c4e1SBarry Smith       ncols = bi[i+1] - bi[i];
2616562c4e1SBarry Smith       for (j=0; j<ncols; j++) *ca++ = *ba++;
2626562c4e1SBarry Smith     }
2636562c4e1SBarry Smith   } else {
2640005702aSJed Brown     SETERRQ1(((PetscObject)A)->comm,PETSC_ERR_ARG_WRONG,"Invalid MatReuse %d",(int)scall);
2656562c4e1SBarry Smith   }
2666562c4e1SBarry Smith   PetscFunctionReturn(0);
2676562c4e1SBarry Smith }
2686562c4e1SBarry Smith 
2696562c4e1SBarry Smith extern PetscErrorCode MatDestroy_Shell(Mat);
2706562c4e1SBarry Smith #undef __FUNCT__
2716562c4e1SBarry Smith #define __FUNCT__ "MatDestroy_ML"
2726562c4e1SBarry Smith static PetscErrorCode MatDestroy_ML(Mat A)
2736562c4e1SBarry Smith {
2746562c4e1SBarry Smith   PetscErrorCode ierr;
2756562c4e1SBarry Smith   Mat_MLShell    *shell;
2766562c4e1SBarry Smith 
2776562c4e1SBarry Smith   PetscFunctionBegin;
2786562c4e1SBarry Smith   ierr = MatShellGetContext(A,(void **)&shell);CHKERRQ(ierr);
279601cad40SBrad Aagaard   ierr = VecDestroy(&shell->y);CHKERRQ(ierr);
280601cad40SBrad Aagaard   if (shell->work) {ierr = VecDestroy(&shell->work);CHKERRQ(ierr);}
2816562c4e1SBarry Smith   ierr = PetscFree(shell);CHKERRQ(ierr);
2826562c4e1SBarry Smith   ierr = MatDestroy_Shell(A);CHKERRQ(ierr);
2836562c4e1SBarry Smith   ierr = PetscObjectChangeTypeName((PetscObject)A,0);CHKERRQ(ierr);
2846562c4e1SBarry Smith   PetscFunctionReturn(0);
2856562c4e1SBarry Smith }
2866562c4e1SBarry Smith 
2876562c4e1SBarry Smith #undef __FUNCT__
2886562c4e1SBarry Smith #define __FUNCT__ "MatWrapML_SeqAIJ"
2896562c4e1SBarry Smith static PetscErrorCode MatWrapML_SeqAIJ(ML_Operator *mlmat,MatReuse reuse,Mat *newmat)
2906562c4e1SBarry Smith {
2916562c4e1SBarry Smith   struct ML_CSR_MSRdata *matdata = (struct ML_CSR_MSRdata *)mlmat->data;
2926562c4e1SBarry Smith   PetscErrorCode        ierr;
2936562c4e1SBarry Smith   PetscInt              m=mlmat->outvec_leng,n=mlmat->invec_leng,*nnz,nz_max;
2946562c4e1SBarry Smith   PetscInt              *ml_cols=matdata->columns,*ml_rowptr=matdata->rowptr,*aj,i,j,k;
2956562c4e1SBarry Smith   PetscScalar           *ml_vals=matdata->values,*aa;
2966562c4e1SBarry Smith 
2976562c4e1SBarry Smith   PetscFunctionBegin;
298e7e72b3dSBarry Smith   if (!mlmat->getrow) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_NULL,"mlmat->getrow = NULL");
2996562c4e1SBarry Smith   if (m != n){ /* ML Pmat and Rmat are in CSR format. Pass array pointers into SeqAIJ matrix */
3006562c4e1SBarry Smith     if (reuse){
3016562c4e1SBarry Smith       Mat_SeqAIJ  *aij= (Mat_SeqAIJ*)(*newmat)->data;
3026562c4e1SBarry Smith       aij->i = ml_rowptr;
3036562c4e1SBarry Smith       aij->j = ml_cols;
3046562c4e1SBarry Smith       aij->a = ml_vals;
3056562c4e1SBarry Smith     } else {
3066562c4e1SBarry Smith       /* sort ml_cols and ml_vals */
3076562c4e1SBarry Smith       ierr = PetscMalloc((m+1)*sizeof(PetscInt),&nnz);
3086562c4e1SBarry Smith       for (i=0; i<m; i++) {
3096562c4e1SBarry Smith         nnz[i] = ml_rowptr[i+1] - ml_rowptr[i];
3106562c4e1SBarry Smith       }
3116562c4e1SBarry Smith       aj = ml_cols; aa = ml_vals;
3126562c4e1SBarry Smith       for (i=0; i<m; i++){
3136562c4e1SBarry Smith         ierr = PetscSortIntWithScalarArray(nnz[i],aj,aa);CHKERRQ(ierr);
3146562c4e1SBarry Smith         aj += nnz[i]; aa += nnz[i];
3156562c4e1SBarry Smith       }
3166562c4e1SBarry Smith       ierr = MatCreateSeqAIJWithArrays(PETSC_COMM_SELF,m,n,ml_rowptr,ml_cols,ml_vals,newmat);CHKERRQ(ierr);
3176562c4e1SBarry Smith       ierr = PetscFree(nnz);CHKERRQ(ierr);
3186562c4e1SBarry Smith     }
3196562c4e1SBarry Smith     PetscFunctionReturn(0);
3206562c4e1SBarry Smith   }
3216562c4e1SBarry Smith 
3226562c4e1SBarry Smith   /* ML Amat is in MSR format. Copy its data into SeqAIJ matrix */
3236562c4e1SBarry Smith   ierr = MatCreate(PETSC_COMM_SELF,newmat);CHKERRQ(ierr);
3246562c4e1SBarry Smith   ierr = MatSetSizes(*newmat,m,n,PETSC_DECIDE,PETSC_DECIDE);CHKERRQ(ierr);
3256562c4e1SBarry Smith   ierr = MatSetType(*newmat,MATSEQAIJ);CHKERRQ(ierr);
3266562c4e1SBarry Smith 
3276562c4e1SBarry Smith   ierr = PetscMalloc((m+1)*sizeof(PetscInt),&nnz);
3286562c4e1SBarry Smith   nz_max = 1;
3296562c4e1SBarry Smith   for (i=0; i<m; i++) {
3306562c4e1SBarry Smith     nnz[i] = ml_cols[i+1] - ml_cols[i] + 1;
3316562c4e1SBarry Smith     if (nnz[i] > nz_max) nz_max += nnz[i];
3326562c4e1SBarry Smith   }
3336562c4e1SBarry Smith 
3346562c4e1SBarry Smith   ierr = MatSeqAIJSetPreallocation(*newmat,0,nnz);CHKERRQ(ierr);
3356562c4e1SBarry Smith   ierr = PetscMalloc2(nz_max,PetscScalar,&aa,nz_max,PetscInt,&aj);CHKERRQ(ierr);
3366562c4e1SBarry Smith   for (i=0; i<m; i++){
3376562c4e1SBarry Smith     k = 0;
3386562c4e1SBarry Smith     /* diagonal entry */
3396562c4e1SBarry Smith     aj[k] = i; aa[k++] = ml_vals[i];
3406562c4e1SBarry Smith     /* off diagonal entries */
3416562c4e1SBarry Smith     for (j=ml_cols[i]; j<ml_cols[i+1]; j++){
3426562c4e1SBarry Smith       aj[k] = ml_cols[j]; aa[k++] = ml_vals[j];
3436562c4e1SBarry Smith     }
3446562c4e1SBarry Smith     /* sort aj and aa */
3456562c4e1SBarry Smith     ierr = PetscSortIntWithScalarArray(nnz[i],aj,aa);CHKERRQ(ierr);
3466562c4e1SBarry Smith     ierr = MatSetValues(*newmat,1,&i,nnz[i],aj,aa,INSERT_VALUES);CHKERRQ(ierr);
3476562c4e1SBarry Smith   }
3486562c4e1SBarry Smith   ierr = MatAssemblyBegin(*newmat,MAT_FINAL_ASSEMBLY);CHKERRQ(ierr);
3496562c4e1SBarry Smith   ierr = MatAssemblyEnd(*newmat,MAT_FINAL_ASSEMBLY);CHKERRQ(ierr);
3506562c4e1SBarry Smith 
3516562c4e1SBarry Smith   ierr = PetscFree2(aa,aj);CHKERRQ(ierr);
3526562c4e1SBarry Smith   ierr = PetscFree(nnz);CHKERRQ(ierr);
3536562c4e1SBarry Smith   PetscFunctionReturn(0);
3546562c4e1SBarry Smith }
3556562c4e1SBarry Smith 
3566562c4e1SBarry Smith #undef __FUNCT__
3576562c4e1SBarry Smith #define __FUNCT__ "MatWrapML_SHELL"
3586562c4e1SBarry Smith static PetscErrorCode MatWrapML_SHELL(ML_Operator *mlmat,MatReuse reuse,Mat *newmat)
3596562c4e1SBarry Smith {
3606562c4e1SBarry Smith   PetscErrorCode ierr;
3616562c4e1SBarry Smith   PetscInt       m,n;
3626562c4e1SBarry Smith   ML_Comm        *MLcomm;
3636562c4e1SBarry Smith   Mat_MLShell    *shellctx;
3646562c4e1SBarry Smith 
3656562c4e1SBarry Smith   PetscFunctionBegin;
3666562c4e1SBarry Smith   m = mlmat->outvec_leng;
3676562c4e1SBarry Smith   n = mlmat->invec_leng;
3686562c4e1SBarry Smith   if (!m || !n){
3696562c4e1SBarry Smith     newmat = PETSC_NULL;
3706562c4e1SBarry Smith     PetscFunctionReturn(0);
3716562c4e1SBarry Smith   }
3726562c4e1SBarry Smith 
3736562c4e1SBarry Smith   if (reuse){
3746562c4e1SBarry Smith     ierr = MatShellGetContext(*newmat,(void **)&shellctx);CHKERRQ(ierr);
3756562c4e1SBarry Smith     shellctx->mlmat = mlmat;
3766562c4e1SBarry Smith     PetscFunctionReturn(0);
3776562c4e1SBarry Smith   }
3786562c4e1SBarry Smith 
3796562c4e1SBarry Smith   MLcomm = mlmat->comm;
3806562c4e1SBarry Smith   ierr = PetscNew(Mat_MLShell,&shellctx);CHKERRQ(ierr);
3816562c4e1SBarry Smith   ierr = MatCreateShell(MLcomm->USR_comm,m,n,PETSC_DETERMINE,PETSC_DETERMINE,shellctx,newmat);CHKERRQ(ierr);
3826562c4e1SBarry Smith   ierr = MatShellSetOperation(*newmat,MATOP_MULT,(void(*)(void))MatMult_ML);CHKERRQ(ierr);
3836562c4e1SBarry Smith   ierr = MatShellSetOperation(*newmat,MATOP_MULT_ADD,(void(*)(void))MatMultAdd_ML);CHKERRQ(ierr);
3846562c4e1SBarry Smith   shellctx->A         = *newmat;
3856562c4e1SBarry Smith   shellctx->mlmat     = mlmat;
38667d6f150SMatthew G Knepley   shellctx->work      = PETSC_NULL;
3876562c4e1SBarry Smith   ierr = VecCreate(PETSC_COMM_WORLD,&shellctx->y);CHKERRQ(ierr);
3886562c4e1SBarry Smith   ierr = VecSetSizes(shellctx->y,m,PETSC_DECIDE);CHKERRQ(ierr);
3896562c4e1SBarry Smith   ierr = VecSetFromOptions(shellctx->y);CHKERRQ(ierr);
3906562c4e1SBarry Smith   (*newmat)->ops->destroy = MatDestroy_ML;
3916562c4e1SBarry Smith   PetscFunctionReturn(0);
3926562c4e1SBarry Smith }
3936562c4e1SBarry Smith 
3946562c4e1SBarry Smith #undef __FUNCT__
3956562c4e1SBarry Smith #define __FUNCT__ "MatWrapML_MPIAIJ"
3966562c4e1SBarry Smith static PetscErrorCode MatWrapML_MPIAIJ(ML_Operator *mlmat,Mat *newmat)
3976562c4e1SBarry Smith {
3986562c4e1SBarry Smith   struct ML_CSR_MSRdata *matdata = (struct ML_CSR_MSRdata *)mlmat->data;
3996562c4e1SBarry Smith   PetscInt              *ml_cols=matdata->columns,*aj;
4006562c4e1SBarry Smith   PetscScalar           *ml_vals=matdata->values,*aa;
4016562c4e1SBarry Smith   PetscErrorCode        ierr;
4026562c4e1SBarry Smith   PetscInt              i,j,k,*gordering;
4036562c4e1SBarry Smith   PetscInt              m=mlmat->outvec_leng,n,*nnzA,*nnzB,*nnz,nz_max,row;
4046562c4e1SBarry Smith   Mat                   A;
4056562c4e1SBarry Smith 
4066562c4e1SBarry Smith   PetscFunctionBegin;
407e7e72b3dSBarry Smith   if (!mlmat->getrow) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_NULL,"mlmat->getrow = NULL");
4086562c4e1SBarry Smith   n = mlmat->invec_leng;
409e32f2f54SBarry Smith   if (m != n) SETERRQ2(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"m %d must equal to n %d",m,n);
4106562c4e1SBarry Smith 
4116562c4e1SBarry Smith   ierr = MatCreate(mlmat->comm->USR_comm,&A);CHKERRQ(ierr);
4126562c4e1SBarry Smith   ierr = MatSetSizes(A,m,n,PETSC_DECIDE,PETSC_DECIDE);CHKERRQ(ierr);
4136562c4e1SBarry Smith   ierr = MatSetType(A,MATMPIAIJ);CHKERRQ(ierr);
4146562c4e1SBarry Smith   ierr = PetscMalloc3(m,PetscInt,&nnzA,m,PetscInt,&nnzB,m,PetscInt,&nnz);CHKERRQ(ierr);
4156562c4e1SBarry Smith 
4166562c4e1SBarry Smith   nz_max = 0;
4176562c4e1SBarry Smith   for (i=0; i<m; i++){
4186562c4e1SBarry Smith     nnz[i] = ml_cols[i+1] - ml_cols[i] + 1;
4196562c4e1SBarry Smith     if (nz_max < nnz[i]) nz_max = nnz[i];
4206562c4e1SBarry Smith     nnzA[i] = 1; /* diag */
4216562c4e1SBarry Smith     for (j=ml_cols[i]; j<ml_cols[i+1]; j++){
4226562c4e1SBarry Smith       if (ml_cols[j] < m) nnzA[i]++;
4236562c4e1SBarry Smith     }
4246562c4e1SBarry Smith     nnzB[i] = nnz[i] - nnzA[i];
4256562c4e1SBarry Smith   }
4266562c4e1SBarry Smith   ierr = MatMPIAIJSetPreallocation(A,0,nnzA,0,nnzB);CHKERRQ(ierr);
4276562c4e1SBarry Smith 
4286562c4e1SBarry Smith   /* insert mat values -- remap row and column indices */
4296562c4e1SBarry Smith   nz_max++;
4306562c4e1SBarry Smith   ierr = PetscMalloc2(nz_max,PetscScalar,&aa,nz_max,PetscInt,&aj);CHKERRQ(ierr);
4316562c4e1SBarry Smith   /* create global row numbering for a ML_Operator */
4326562c4e1SBarry Smith   ML_build_global_numbering(mlmat,&gordering,"rows");
4336562c4e1SBarry Smith   for (i=0; i<m; i++){
4346562c4e1SBarry Smith     row = gordering[i];
4356562c4e1SBarry Smith     k = 0;
4366562c4e1SBarry Smith     /* diagonal entry */
4376562c4e1SBarry Smith     aj[k] = row; aa[k++] = ml_vals[i];
4386562c4e1SBarry Smith     /* off diagonal entries */
4396562c4e1SBarry Smith     for (j=ml_cols[i]; j<ml_cols[i+1]; j++){
4406562c4e1SBarry Smith       aj[k] = gordering[ml_cols[j]]; aa[k++] = ml_vals[j];
4416562c4e1SBarry Smith     }
4426562c4e1SBarry Smith     ierr = MatSetValues(A,1,&row,nnz[i],aj,aa,INSERT_VALUES);CHKERRQ(ierr);
4436562c4e1SBarry Smith   }
444eb4736aaSBarry Smith   ML_free(gordering);
4456562c4e1SBarry Smith   ierr = MatAssemblyBegin(A,MAT_FINAL_ASSEMBLY);CHKERRQ(ierr);
4466562c4e1SBarry Smith   ierr = MatAssemblyEnd(A,MAT_FINAL_ASSEMBLY);CHKERRQ(ierr);
4476562c4e1SBarry Smith   *newmat = A;
4486562c4e1SBarry Smith 
4496562c4e1SBarry Smith   ierr = PetscFree3(nnzA,nnzB,nnz);
4506562c4e1SBarry Smith   ierr = PetscFree2(aa,aj);CHKERRQ(ierr);
4516562c4e1SBarry Smith   PetscFunctionReturn(0);
4526562c4e1SBarry Smith }
4536562c4e1SBarry Smith 
4546562c4e1SBarry Smith /* -----------------------------------------------------------------------------*/
45501da6913SBarry Smith #undef __FUNCT__
456a06653b4SBarry Smith #define __FUNCT__ "PCReset_ML"
45716336fedSMatthew G Knepley PetscErrorCode PCReset_ML(PC pc)
45801da6913SBarry Smith {
45901da6913SBarry Smith   PetscErrorCode  ierr;
460e0262f48SMatthew G Knepley   PC_MG           *mg = (PC_MG*)pc->data;
461e0262f48SMatthew G Knepley   PC_ML           *pc_ml = (PC_ML*)mg->innerctx;
46201da6913SBarry Smith   PetscInt        level,fine_level=pc_ml->Nlevels-1;
46301da6913SBarry Smith 
46401da6913SBarry Smith   PetscFunctionBegin;
46501da6913SBarry Smith   ML_Aggregate_Destroy(&pc_ml->agg_object);
46601da6913SBarry Smith   ML_Destroy(&pc_ml->ml_object);
46701da6913SBarry Smith 
46801da6913SBarry Smith   if (pc_ml->PetscMLdata) {
46901da6913SBarry Smith     ierr = PetscFree(pc_ml->PetscMLdata->pwork);CHKERRQ(ierr);
470601cad40SBrad Aagaard     if (pc_ml->size > 1)      {ierr = MatDestroy(&pc_ml->PetscMLdata->Aloc);CHKERRQ(ierr);}
471601cad40SBrad Aagaard     if (pc_ml->PetscMLdata->x){ierr = VecDestroy(&pc_ml->PetscMLdata->x);CHKERRQ(ierr);}
472601cad40SBrad Aagaard     if (pc_ml->PetscMLdata->y){ierr = VecDestroy(&pc_ml->PetscMLdata->y);CHKERRQ(ierr);}
47301da6913SBarry Smith   }
47401da6913SBarry Smith   ierr = PetscFree(pc_ml->PetscMLdata);CHKERRQ(ierr);
47501da6913SBarry Smith 
476f5a5dd59SJed Brown   if (pc_ml->gridctx) {
47701da6913SBarry Smith     for (level=0; level<fine_level; level++){
478601cad40SBrad Aagaard       if (pc_ml->gridctx[level].A){ierr = MatDestroy(&pc_ml->gridctx[level].A);CHKERRQ(ierr);}
479601cad40SBrad Aagaard       if (pc_ml->gridctx[level].P){ierr = MatDestroy(&pc_ml->gridctx[level].P);CHKERRQ(ierr);}
480601cad40SBrad Aagaard       if (pc_ml->gridctx[level].R){ierr = MatDestroy(&pc_ml->gridctx[level].R);CHKERRQ(ierr);}
481601cad40SBrad Aagaard       if (pc_ml->gridctx[level].x){ierr = VecDestroy(&pc_ml->gridctx[level].x);CHKERRQ(ierr);}
482601cad40SBrad Aagaard       if (pc_ml->gridctx[level].b){ierr = VecDestroy(&pc_ml->gridctx[level].b);CHKERRQ(ierr);}
483601cad40SBrad Aagaard       if (pc_ml->gridctx[level+1].r){ierr = VecDestroy(&pc_ml->gridctx[level+1].r);CHKERRQ(ierr);}
48401da6913SBarry Smith     }
485f5a5dd59SJed Brown   }
48601da6913SBarry Smith   ierr = PetscFree(pc_ml->gridctx);CHKERRQ(ierr);
48701da6913SBarry Smith   PetscFunctionReturn(0);
48801da6913SBarry Smith }
4895582bec1SHong Zhang /* -------------------------------------------------------------------------- */
4905582bec1SHong Zhang /*
4915582bec1SHong Zhang    PCSetUp_ML - Prepares for the use of the ML preconditioner
4925582bec1SHong Zhang                     by setting data structures and options.
4935582bec1SHong Zhang 
4945582bec1SHong Zhang    Input Parameter:
4955582bec1SHong Zhang .  pc - the preconditioner context
4965582bec1SHong Zhang 
4975582bec1SHong Zhang    Application Interface Routine: PCSetUp()
4985582bec1SHong Zhang 
4995582bec1SHong Zhang    Notes:
5005582bec1SHong Zhang    The interface routine PCSetUp() is not usually called directly by
5015582bec1SHong Zhang    the user, but instead is called by PCApply() if necessary.
5025582bec1SHong Zhang */
5036ca4d86aSHong Zhang extern PetscErrorCode PCSetFromOptions_MG(PC);
504a06653b4SBarry Smith extern PetscErrorCode PCReset_MG(PC);
505c07bf074SBarry Smith 
5065582bec1SHong Zhang #undef __FUNCT__
5075582bec1SHong Zhang #define __FUNCT__ "PCSetUp_ML"
5086ca4d86aSHong Zhang PetscErrorCode PCSetUp_ML(PC pc)
5095582bec1SHong Zhang {
5105582bec1SHong Zhang   PetscErrorCode  ierr;
511eef31507SHong Zhang   PetscMPIInt     size;
5125582bec1SHong Zhang   FineGridCtx     *PetscMLdata;
5135582bec1SHong Zhang   ML              *ml_object;
5145582bec1SHong Zhang   ML_Aggregate    *agg_object;
5155582bec1SHong Zhang   ML_Operator     *mlmat;
5164f8eab3cSJed Brown   PetscInt        nlocal_allcols,Nlevels,mllevel,level,level1,m,fine_level,bs;
5175582bec1SHong Zhang   Mat             A,Aloc;
5185582bec1SHong Zhang   GridCtx         *gridctx;
51901da6913SBarry Smith   PC_MG           *mg = (PC_MG*)pc->data;
52001da6913SBarry Smith   PC_ML           *pc_ml = (PC_ML*)mg->innerctx;
521ace3abfcSBarry Smith   PetscBool       isSeq, isMPI;
522c07bf074SBarry Smith   KSP             smoother;
523c07bf074SBarry Smith   PC              subpc;
5245582bec1SHong Zhang 
5255582bec1SHong Zhang   PetscFunctionBegin;
526573998d7SHong Zhang   if (pc->setupcalled){
527c07bf074SBarry Smith     /* since ML can change the size of vectors/matrices at any level we must destroy everything */
52816336fedSMatthew G Knepley     ierr = PCReset_ML(pc);CHKERRQ(ierr);
529a06653b4SBarry Smith     ierr = PCReset_MG(pc);CHKERRQ(ierr);
530573998d7SHong Zhang   }
531573998d7SHong Zhang 
5325582bec1SHong Zhang   /* setup special features of PCML */
5335582bec1SHong Zhang   /*--------------------------------*/
5345582bec1SHong Zhang   /* covert A to Aloc to be used by ML at fine grid */
5355582bec1SHong Zhang   A = pc->pmat;
5367adad957SLisandro Dalcin   ierr = MPI_Comm_size(((PetscObject)A)->comm,&size);CHKERRQ(ierr);
5375582bec1SHong Zhang   pc_ml->size = size;
538864b637dSMatthew Knepley   ierr = PetscTypeCompare((PetscObject) A, MATSEQAIJ, &isSeq);CHKERRQ(ierr);
539864b637dSMatthew Knepley   ierr = PetscTypeCompare((PetscObject) A, MATMPIAIJ, &isMPI);CHKERRQ(ierr);
540864b637dSMatthew Knepley   if (isMPI){
541db571536SBarry Smith     ierr = MatConvert_MPIAIJ_ML(A,PETSC_NULL,MAT_INITIAL_MATRIX,&Aloc);CHKERRQ(ierr);
542864b637dSMatthew Knepley   } else if (isSeq) {
5435582bec1SHong Zhang     Aloc = A;
544c5b2ea42SJed Brown   } else SETERRQ1(((PetscObject)pc)->comm,PETSC_ERR_ARG_WRONG, "Matrix type '%s' cannot be used with ML. ML can only handle AIJ matrices.",((PetscObject)A)->type_name);
5455582bec1SHong Zhang 
5465582bec1SHong Zhang   /* create and initialize struct 'PetscMLdata' */
54738f2d2fdSLisandro Dalcin   ierr = PetscNewLog(pc,FineGridCtx,&PetscMLdata);CHKERRQ(ierr);
5485582bec1SHong Zhang   pc_ml->PetscMLdata = PetscMLdata;
549d0f46423SBarry Smith   ierr = PetscMalloc((Aloc->cmap->n+1)*sizeof(PetscScalar),&PetscMLdata->pwork);CHKERRQ(ierr);
5505582bec1SHong Zhang 
55124a42b14SHong Zhang   ierr = VecCreate(PETSC_COMM_SELF,&PetscMLdata->x);CHKERRQ(ierr);
552d0f46423SBarry Smith   ierr = VecSetSizes(PetscMLdata->x,Aloc->cmap->n,Aloc->cmap->n);CHKERRQ(ierr);
55324a42b14SHong Zhang   ierr = VecSetType(PetscMLdata->x,VECSEQ);CHKERRQ(ierr);
55424a42b14SHong Zhang 
55524a42b14SHong Zhang   ierr = VecCreate(PETSC_COMM_SELF,&PetscMLdata->y);CHKERRQ(ierr);
556d0f46423SBarry Smith   ierr = VecSetSizes(PetscMLdata->y,A->rmap->n,PETSC_DECIDE);CHKERRQ(ierr);
55724a42b14SHong Zhang   ierr = VecSetType(PetscMLdata->y,VECSEQ);CHKERRQ(ierr);
558573998d7SHong Zhang   PetscMLdata->A    = A;
559573998d7SHong Zhang   PetscMLdata->Aloc = Aloc;
56024a42b14SHong Zhang 
5615582bec1SHong Zhang   /* create ML discretization matrix at fine grid */
56245cf47abSHong Zhang   /* ML requires input of fine-grid matrix. It determines nlevels. */
5635582bec1SHong Zhang   ierr = MatGetSize(Aloc,&m,&nlocal_allcols);CHKERRQ(ierr);
5644f8eab3cSJed Brown   ierr = MatGetBlockSize(A,&bs);CHKERRQ(ierr);
5655582bec1SHong Zhang   ML_Create(&ml_object,pc_ml->MaxNlevels);
566ead7dcbeSHong Zhang   ML_Comm_Set_UsrComm(ml_object->comm,((PetscObject)A)->comm);
567573998d7SHong Zhang   pc_ml->ml_object = ml_object;
5685582bec1SHong Zhang   ML_Init_Amatrix(ml_object,0,m,m,PetscMLdata);
5695582bec1SHong Zhang   ML_Set_Amatrix_Getrow(ml_object,0,PetscML_getrow,PetscML_comm,nlocal_allcols);
5705582bec1SHong Zhang   ML_Set_Amatrix_Matvec(ml_object,0,PetscML_matvec);
5715582bec1SHong Zhang 
572b5c8bdf8SJed Brown   ML_Set_Symmetrize(ml_object,pc_ml->Symmetrize ? ML_YES : ML_NO);
573b5c8bdf8SJed Brown 
5745582bec1SHong Zhang   /* aggregation */
5755582bec1SHong Zhang   ML_Aggregate_Create(&agg_object);
576573998d7SHong Zhang   pc_ml->agg_object = agg_object;
577573998d7SHong Zhang 
5784f8eab3cSJed Brown   ML_Aggregate_Set_NullSpace(agg_object,bs,bs,0,0);CHKERRQ(ierr);
5795582bec1SHong Zhang   ML_Aggregate_Set_MaxCoarseSize(agg_object,pc_ml->MaxCoarseSize);
5805582bec1SHong Zhang   /* set options */
5815582bec1SHong Zhang   switch (pc_ml->CoarsenScheme) {
5825582bec1SHong Zhang   case 1:
5835582bec1SHong Zhang     ML_Aggregate_Set_CoarsenScheme_Coupled(agg_object);break;
5845582bec1SHong Zhang   case 2:
5855582bec1SHong Zhang     ML_Aggregate_Set_CoarsenScheme_MIS(agg_object);break;
5865582bec1SHong Zhang   case 3:
5875582bec1SHong Zhang     ML_Aggregate_Set_CoarsenScheme_METIS(agg_object);break;
5885582bec1SHong Zhang   }
5895582bec1SHong Zhang   ML_Aggregate_Set_Threshold(agg_object,pc_ml->Threshold);
5905582bec1SHong Zhang   ML_Aggregate_Set_DampingFactor(agg_object,pc_ml->DampingFactor);
5915582bec1SHong Zhang   if (pc_ml->SpectralNormScheme_Anorm){
5927ffd031bSHong Zhang     ML_Set_SpectralNormScheme_Anorm(ml_object);
5935582bec1SHong Zhang   }
594b5c8bdf8SJed Brown   agg_object->keep_agg_information      = (int)pc_ml->KeepAggInfo;
595b5c8bdf8SJed Brown   agg_object->keep_P_tentative          = (int)pc_ml->Reusable;
596b5c8bdf8SJed Brown   agg_object->block_scaled_SA           = (int)pc_ml->BlockScaling;
597b5c8bdf8SJed Brown   agg_object->minimizing_energy         = (int)pc_ml->EnergyMinimization;
598b5c8bdf8SJed Brown   agg_object->minimizing_energy_droptol = (double)pc_ml->EnergyMinimizationDropTol;
599b5c8bdf8SJed Brown   agg_object->cheap_minimizing_energy   = (int)pc_ml->EnergyMinimizationCheap;
6005582bec1SHong Zhang 
601b5c8bdf8SJed Brown   if (pc_ml->OldHierarchy) {
6025582bec1SHong Zhang     Nlevels = ML_Gen_MGHierarchy_UsingAggregation(ml_object,0,ML_INCREASING,agg_object);
603b5c8bdf8SJed Brown   } else {
604b5c8bdf8SJed Brown     Nlevels = ML_Gen_MultiLevelHierarchy_UsingAggregation(ml_object,0,ML_INCREASING,agg_object);
605b5c8bdf8SJed Brown   }
60665e19b50SBarry Smith   if (Nlevels<=0) SETERRQ1(((PetscObject)pc)->comm,PETSC_ERR_ARG_OUTOFRANGE,"Nlevels %d must > 0",Nlevels);
607573998d7SHong Zhang   pc_ml->Nlevels = Nlevels;
608aa85bbbfSHong Zhang   fine_level = Nlevels - 1;
609c07bf074SBarry Smith 
61097177400SBarry Smith   ierr = PCMGSetLevels(pc,Nlevels,PETSC_NULL);CHKERRQ(ierr);
611aa85bbbfSHong Zhang   /* set default smoothers */
612aa85bbbfSHong Zhang   for (level=1; level<=fine_level; level++){
613aa85bbbfSHong Zhang     if (size == 1){
614aa85bbbfSHong Zhang       ierr = PCMGGetSmoother(pc,level,&smoother);CHKERRQ(ierr);
615aa85bbbfSHong Zhang       ierr = KSPSetType(smoother,KSPRICHARDSON);CHKERRQ(ierr);
616aa85bbbfSHong Zhang       ierr = KSPGetPC(smoother,&subpc);CHKERRQ(ierr);
617aa85bbbfSHong Zhang       ierr = PCSetType(subpc,PCSOR);CHKERRQ(ierr);
618aa85bbbfSHong Zhang     } else {
619aa85bbbfSHong Zhang       ierr = PCMGGetSmoother(pc,level,&smoother);CHKERRQ(ierr);
620aa85bbbfSHong Zhang       ierr = KSPSetType(smoother,KSPRICHARDSON);CHKERRQ(ierr);
621aa85bbbfSHong Zhang       ierr = KSPGetPC(smoother,&subpc);CHKERRQ(ierr);
622aa85bbbfSHong Zhang       ierr = PCSetType(subpc,PCSOR);CHKERRQ(ierr);
623aa85bbbfSHong Zhang     }
624aa85bbbfSHong Zhang   }
62597177400SBarry Smith   ierr = PCSetFromOptions_MG(pc);CHKERRQ(ierr); /* should be called in PCSetFromOptions_ML(), but cannot be called prior to PCMGSetLevels() */
6265582bec1SHong Zhang 
6275582bec1SHong Zhang   ierr = PetscMalloc(Nlevels*sizeof(GridCtx),&gridctx);CHKERRQ(ierr);
6285582bec1SHong Zhang   pc_ml->gridctx = gridctx;
6295582bec1SHong Zhang 
6305582bec1SHong Zhang   /* wrap ML matrices by PETSc shell matrices at coarsened grids.
6315582bec1SHong Zhang      Level 0 is the finest grid for ML, but coarsest for PETSc! */
632e14861a4SHong Zhang   gridctx[fine_level].A = A;
633573998d7SHong Zhang 
634e14861a4SHong Zhang   level = fine_level - 1;
635ab718edeSHong Zhang   if (size == 1){ /* convert ML P, R and A into seqaij format */
6365582bec1SHong Zhang     for (mllevel=1; mllevel<Nlevels; mllevel++){
637e14861a4SHong Zhang       mlmat = &(ml_object->Pmat[mllevel]);
638db571536SBarry Smith       ierr  = MatWrapML_SeqAIJ(mlmat,MAT_INITIAL_MATRIX,&gridctx[level].P);CHKERRQ(ierr);
639e14861a4SHong Zhang       mlmat = &(ml_object->Rmat[mllevel-1]);
640db571536SBarry Smith       ierr  = MatWrapML_SeqAIJ(mlmat,MAT_INITIAL_MATRIX,&gridctx[level].R);CHKERRQ(ierr);
641573998d7SHong Zhang 
642573998d7SHong Zhang       mlmat = &(ml_object->Amat[mllevel]);
643573998d7SHong Zhang       ierr  = MatWrapML_SeqAIJ(mlmat,MAT_INITIAL_MATRIX,&gridctx[level].A);CHKERRQ(ierr);
6445582bec1SHong Zhang       level--;
6455582bec1SHong Zhang     }
646ab718edeSHong Zhang   } else { /* convert ML P and R into shell format, ML A into mpiaij format */
6475582bec1SHong Zhang     for (mllevel=1; mllevel<Nlevels; mllevel++){
6485582bec1SHong Zhang       mlmat  = &(ml_object->Pmat[mllevel]);
649db571536SBarry Smith       ierr = MatWrapML_SHELL(mlmat,MAT_INITIAL_MATRIX,&gridctx[level].P);CHKERRQ(ierr);
650ab718edeSHong Zhang       mlmat  = &(ml_object->Rmat[mllevel-1]);
651db571536SBarry Smith       ierr = MatWrapML_SHELL(mlmat,MAT_INITIAL_MATRIX,&gridctx[level].R);CHKERRQ(ierr);
652573998d7SHong Zhang 
6535582bec1SHong Zhang       mlmat  = &(ml_object->Amat[mllevel]);
654eef31507SHong Zhang       ierr = MatWrapML_MPIAIJ(mlmat,&gridctx[level].A);CHKERRQ(ierr);
6555582bec1SHong Zhang       level--;
6565582bec1SHong Zhang     }
6575582bec1SHong Zhang   }
6585582bec1SHong Zhang 
659573998d7SHong Zhang   /* create vectors and ksp at all levels */
660ac346b81SHong Zhang   for (level=0; level<fine_level; level++){
661573998d7SHong Zhang     level1 = level + 1;
662e64afeacSLisandro Dalcin     ierr = VecCreate(((PetscObject)gridctx[level].A)->comm,&gridctx[level].x);CHKERRQ(ierr);
663d0f46423SBarry Smith     ierr = VecSetSizes(gridctx[level].x,gridctx[level].A->cmap->n,PETSC_DECIDE);CHKERRQ(ierr);
6645582bec1SHong Zhang     ierr = VecSetType(gridctx[level].x,VECMPI);CHKERRQ(ierr);
66597177400SBarry Smith     ierr = PCMGSetX(pc,level,gridctx[level].x);CHKERRQ(ierr);
6665582bec1SHong Zhang 
667e64afeacSLisandro Dalcin     ierr = VecCreate(((PetscObject)gridctx[level].A)->comm,&gridctx[level].b);CHKERRQ(ierr);
668d0f46423SBarry Smith     ierr = VecSetSizes(gridctx[level].b,gridctx[level].A->rmap->n,PETSC_DECIDE);CHKERRQ(ierr);
6695582bec1SHong Zhang     ierr = VecSetType(gridctx[level].b,VECMPI);CHKERRQ(ierr);
67097177400SBarry Smith     ierr = PCMGSetRhs(pc,level,gridctx[level].b);CHKERRQ(ierr);
671ac346b81SHong Zhang 
672e64afeacSLisandro Dalcin     ierr = VecCreate(((PetscObject)gridctx[level1].A)->comm,&gridctx[level1].r);CHKERRQ(ierr);
673d0f46423SBarry Smith     ierr = VecSetSizes(gridctx[level1].r,gridctx[level1].A->rmap->n,PETSC_DECIDE);CHKERRQ(ierr);
674ac346b81SHong Zhang     ierr = VecSetType(gridctx[level1].r,VECMPI);CHKERRQ(ierr);
67597177400SBarry Smith     ierr = PCMGSetR(pc,level1,gridctx[level1].r);CHKERRQ(ierr);
676ac346b81SHong Zhang 
6775582bec1SHong Zhang     if (level == 0){
67897177400SBarry Smith       ierr = PCMGGetCoarseSolve(pc,&gridctx[level].ksp);CHKERRQ(ierr);
6795582bec1SHong Zhang     } else {
68097177400SBarry Smith       ierr = PCMGGetSmoother(pc,level,&gridctx[level].ksp);CHKERRQ(ierr);
681573998d7SHong Zhang     }
682573998d7SHong Zhang   }
683573998d7SHong Zhang   ierr = PCMGGetSmoother(pc,fine_level,&gridctx[fine_level].ksp);CHKERRQ(ierr);
684573998d7SHong Zhang 
685573998d7SHong Zhang   /* create coarse level and the interpolation between the levels */
686573998d7SHong Zhang   for (level=0; level<fine_level; level++){
687573998d7SHong Zhang     level1 = level + 1;
688aea2a34eSBarry Smith     ierr = PCMGSetInterpolation(pc,level1,gridctx[level].P);CHKERRQ(ierr);
689573998d7SHong Zhang     ierr = PCMGSetRestriction(pc,level1,gridctx[level].R);CHKERRQ(ierr);
690573998d7SHong Zhang     if (level > 0){
69197177400SBarry Smith       ierr = PCMGSetResidual(pc,level,PCMGDefaultResidual,gridctx[level].A);CHKERRQ(ierr);
6925582bec1SHong Zhang     }
6935582bec1SHong Zhang     ierr = KSPSetOperators(gridctx[level].ksp,gridctx[level].A,gridctx[level].A,DIFFERENT_NONZERO_PATTERN);CHKERRQ(ierr);
6945582bec1SHong Zhang   }
69597177400SBarry Smith   ierr = PCMGSetResidual(pc,fine_level,PCMGDefaultResidual,gridctx[fine_level].A);CHKERRQ(ierr);
696ac346b81SHong Zhang   ierr = KSPSetOperators(gridctx[fine_level].ksp,gridctx[level].A,gridctx[fine_level].A,DIFFERENT_NONZERO_PATTERN);CHKERRQ(ierr);
6975582bec1SHong Zhang 
698c07bf074SBarry Smith   /* setupcalled is set to 0 so that MG is setup from scratch */
699c07bf074SBarry Smith   pc->setupcalled = 0;
7003751b4bdSBarry Smith   ierr = PCSetUp_MG(pc);CHKERRQ(ierr);
7015582bec1SHong Zhang   PetscFunctionReturn(0);
7025582bec1SHong Zhang }
7035582bec1SHong Zhang 
7045582bec1SHong Zhang /* -------------------------------------------------------------------------- */
7055582bec1SHong Zhang /*
7065582bec1SHong Zhang    PCDestroy_ML - Destroys the private context for the ML preconditioner
7075582bec1SHong Zhang    that was created with PCCreate_ML().
7085582bec1SHong Zhang 
7095582bec1SHong Zhang    Input Parameter:
7105582bec1SHong Zhang .  pc - the preconditioner context
7115582bec1SHong Zhang 
7125582bec1SHong Zhang    Application Interface Routine: PCDestroy()
7135582bec1SHong Zhang */
7145582bec1SHong Zhang #undef __FUNCT__
7155582bec1SHong Zhang #define __FUNCT__ "PCDestroy_ML"
7166ca4d86aSHong Zhang PetscErrorCode PCDestroy_ML(PC pc)
7175582bec1SHong Zhang {
7185582bec1SHong Zhang   PetscErrorCode  ierr;
71901da6913SBarry Smith   PC_MG           *mg = (PC_MG*)pc->data;
72001da6913SBarry Smith   PC_ML           *pc_ml= (PC_ML*)mg->innerctx;
7215582bec1SHong Zhang 
7225582bec1SHong Zhang   PetscFunctionBegin;
72316336fedSMatthew G Knepley   ierr = PCReset_ML(pc);CHKERRQ(ierr);
72401da6913SBarry Smith   ierr = PetscFree(pc_ml);CHKERRQ(ierr);
72501da6913SBarry Smith   ierr = PCDestroy_MG(pc);CHKERRQ(ierr);
7265582bec1SHong Zhang   PetscFunctionReturn(0);
7275582bec1SHong Zhang }
7285582bec1SHong Zhang 
7295582bec1SHong Zhang #undef __FUNCT__
7305582bec1SHong Zhang #define __FUNCT__ "PCSetFromOptions_ML"
7316ca4d86aSHong Zhang PetscErrorCode PCSetFromOptions_ML(PC pc)
7325582bec1SHong Zhang {
7335582bec1SHong Zhang   PetscErrorCode  ierr;
7343751b4bdSBarry Smith   PetscInt        indx,PrintLevel;
7355582bec1SHong Zhang   const char      *scheme[] = {"Uncoupled","Coupled","MIS","METIS"};
73601da6913SBarry Smith   PC_MG           *mg = (PC_MG*)pc->data;
73701da6913SBarry Smith   PC_ML           *pc_ml = (PC_ML*)mg->innerctx;
738b5c8bdf8SJed Brown   PetscMPIInt     size;
73988ff4cc7SJed Brown   MPI_Comm        comm = ((PetscObject)pc)->comm;
7405582bec1SHong Zhang 
7415582bec1SHong Zhang   PetscFunctionBegin;
74288ff4cc7SJed Brown   ierr = MPI_Comm_size(comm,&size);CHKERRQ(ierr);
7435582bec1SHong Zhang   ierr = PetscOptionsHead("ML options");CHKERRQ(ierr);
7445582bec1SHong Zhang   PrintLevel    = 0;
7455582bec1SHong Zhang   indx          = 0;
7465582bec1SHong Zhang   ierr = PetscOptionsInt("-pc_ml_PrintLevel","Print level","ML_Set_PrintLevel",PrintLevel,&PrintLevel,PETSC_NULL);CHKERRQ(ierr);
7475582bec1SHong Zhang   ML_Set_PrintLevel(PrintLevel);
748573998d7SHong Zhang   ierr = PetscOptionsInt("-pc_ml_maxNlevels","Maximum number of levels","None",pc_ml->MaxNlevels,&pc_ml->MaxNlevels,PETSC_NULL);CHKERRQ(ierr);
749573998d7SHong Zhang   ierr = PetscOptionsInt("-pc_ml_maxCoarseSize","Maximum coarsest mesh size","ML_Aggregate_Set_MaxCoarseSize",pc_ml->MaxCoarseSize,&pc_ml->MaxCoarseSize,PETSC_NULL);CHKERRQ(ierr);
7503751b4bdSBarry Smith   ierr = PetscOptionsEList("-pc_ml_CoarsenScheme","Aggregate Coarsen Scheme","ML_Aggregate_Set_CoarsenScheme_*",scheme,4,scheme[0],&indx,PETSC_NULL);CHKERRQ(ierr);
7515582bec1SHong Zhang   pc_ml->CoarsenScheme = indx;
752573998d7SHong Zhang   ierr = PetscOptionsReal("-pc_ml_DampingFactor","P damping factor","ML_Aggregate_Set_DampingFactor",pc_ml->DampingFactor,&pc_ml->DampingFactor,PETSC_NULL);CHKERRQ(ierr);
753573998d7SHong Zhang   ierr = PetscOptionsReal("-pc_ml_Threshold","Smoother drop tol","ML_Aggregate_Set_Threshold",pc_ml->Threshold,&pc_ml->Threshold,PETSC_NULL);CHKERRQ(ierr);
754acfcf0e5SJed Brown   ierr = PetscOptionsBool("-pc_ml_SpectralNormScheme_Anorm","Method used for estimating spectral radius","ML_Set_SpectralNormScheme_Anorm",pc_ml->SpectralNormScheme_Anorm,&pc_ml->SpectralNormScheme_Anorm,PETSC_NULL);CHKERRQ(ierr);
755acfcf0e5SJed Brown   ierr = PetscOptionsBool("-pc_ml_Symmetrize","Symmetrize aggregation","ML_Set_Symmetrize",pc_ml->Symmetrize,&pc_ml->Symmetrize,PETSC_NULL);CHKERRQ(ierr);
756acfcf0e5SJed Brown   ierr = PetscOptionsBool("-pc_ml_BlockScaling","Scale all dofs at each node together","None",pc_ml->BlockScaling,&pc_ml->BlockScaling,PETSC_NULL);CHKERRQ(ierr);
757b5c8bdf8SJed Brown   ierr = PetscOptionsInt("-pc_ml_EnergyMinimization","Energy minimization norm type (0=no minimization; see ML manual for 1,2,3; -1 and 4 undocumented)","None",pc_ml->EnergyMinimization,&pc_ml->EnergyMinimization,PETSC_NULL);CHKERRQ(ierr);
758b5c8bdf8SJed Brown   /*
759b5c8bdf8SJed Brown     The following checks a number of conditions.  If we let this stuff slip by, then ML's error handling will take over.
760b5c8bdf8SJed Brown     This is suboptimal because it amounts to calling exit(1) so we check for the most common conditions.
761b5c8bdf8SJed Brown 
762b5c8bdf8SJed Brown     We also try to set some sane defaults when energy minimization is activated, otherwise it's hard to find a working
763b5c8bdf8SJed Brown     combination of options and ML's exit(1) explanations don't help matters.
764b5c8bdf8SJed Brown   */
76588ff4cc7SJed Brown   if (pc_ml->EnergyMinimization < -1 || pc_ml->EnergyMinimization > 4) SETERRQ(comm,PETSC_ERR_ARG_OUTOFRANGE,"EnergyMinimization must be in range -1..4");
76688ff4cc7SJed Brown   if (pc_ml->EnergyMinimization == 4 && size > 1) SETERRQ(comm,PETSC_ERR_SUP,"Energy minimization type 4 does not work in parallel");
767b5c8bdf8SJed Brown   if (pc_ml->EnergyMinimization == 4) {ierr = PetscInfo(pc,"Mandel's energy minimization scheme is experimental and broken in ML-6.2");CHKERRQ(ierr);}
768b5c8bdf8SJed Brown   if (pc_ml->EnergyMinimization) {
769b5c8bdf8SJed Brown     ierr = PetscOptionsReal("-pc_ml_EnergyMinimizationDropTol","Energy minimization drop tolerance","None",pc_ml->EnergyMinimizationDropTol,&pc_ml->EnergyMinimizationDropTol,PETSC_NULL);CHKERRQ(ierr);
770b5c8bdf8SJed Brown   }
771b5c8bdf8SJed Brown   if (pc_ml->EnergyMinimization == 2) {
772b5c8bdf8SJed Brown     /* According to ml_MultiLevelPreconditioner.cpp, this option is only meaningful for norm type (2) */
773acfcf0e5SJed Brown     ierr = PetscOptionsBool("-pc_ml_EnergyMinimizationCheap","Use cheaper variant of norm type 2","None",pc_ml->EnergyMinimizationCheap,&pc_ml->EnergyMinimizationCheap,PETSC_NULL);CHKERRQ(ierr);
774b5c8bdf8SJed Brown   }
775b5c8bdf8SJed Brown   /* energy minimization sometimes breaks if this is turned off, the more classical stuff should be okay without it */
776b5c8bdf8SJed Brown   if (pc_ml->EnergyMinimization) pc_ml->KeepAggInfo = PETSC_TRUE;
777acfcf0e5SJed Brown   ierr = PetscOptionsBool("-pc_ml_KeepAggInfo","Allows the preconditioner to be reused, or auxilliary matrices to be generated","None",pc_ml->KeepAggInfo,&pc_ml->KeepAggInfo,PETSC_NULL);CHKERRQ(ierr);
778b5c8bdf8SJed Brown   /* Option (-1) doesn't work at all (calls exit(1)) if the tentative restriction operator isn't stored. */
779b5c8bdf8SJed Brown   if (pc_ml->EnergyMinimization == -1) pc_ml->Reusable = PETSC_TRUE;
780acfcf0e5SJed Brown   ierr = PetscOptionsBool("-pc_ml_Reusable","Store intermedaiate data structures so that the multilevel hierarchy is reusable","None",pc_ml->Reusable,&pc_ml->Reusable,PETSC_NULL);CHKERRQ(ierr);
781b5c8bdf8SJed Brown   /*
782b5c8bdf8SJed Brown     ML's C API is severely underdocumented and lacks significant functionality.  The C++ API calls
783b5c8bdf8SJed Brown     ML_Gen_MultiLevelHierarchy_UsingAggregation() which is a modified copy (!?) of the documented function
784b5c8bdf8SJed Brown     ML_Gen_MGHierarchy_UsingAggregation().  This modification, however, does not provide a strict superset of the
785b5c8bdf8SJed Brown     functionality in the old function, so some users may still want to use it.  Note that many options are ignored in
786b5c8bdf8SJed Brown     this context, but ML doesn't provide a way to find out which ones.
787b5c8bdf8SJed Brown    */
788acfcf0e5SJed Brown   ierr = PetscOptionsBool("-pc_ml_OldHierarchy","Use old routine to generate hierarchy","None",pc_ml->OldHierarchy,&pc_ml->OldHierarchy,PETSC_NULL);CHKERRQ(ierr);
7895582bec1SHong Zhang   ierr = PetscOptionsTail();CHKERRQ(ierr);
7905582bec1SHong Zhang   PetscFunctionReturn(0);
7915582bec1SHong Zhang }
7925582bec1SHong Zhang 
7935582bec1SHong Zhang /* -------------------------------------------------------------------------- */
7945582bec1SHong Zhang /*
7955582bec1SHong Zhang    PCCreate_ML - Creates a ML preconditioner context, PC_ML,
7965582bec1SHong Zhang    and sets this as the private data within the generic preconditioning
7975582bec1SHong Zhang    context, PC, that was created within PCCreate().
7985582bec1SHong Zhang 
7995582bec1SHong Zhang    Input Parameter:
8005582bec1SHong Zhang .  pc - the preconditioner context
8015582bec1SHong Zhang 
8025582bec1SHong Zhang    Application Interface Routine: PCCreate()
8035582bec1SHong Zhang */
8045582bec1SHong Zhang 
8055582bec1SHong Zhang /*MC
8061e5ab15bSHong Zhang      PCML - Use algebraic multigrid preconditioning. This preconditioner requires you provide
8075582bec1SHong Zhang        fine grid discretization matrix. The coarser grid matrices and restriction/interpolation
8086ca4d86aSHong Zhang        operators are computed by ML, with the matrices coverted to PETSc matrices in aij format
8096ca4d86aSHong Zhang        and the restriction/interpolation operators wrapped as PETSc shell matrices.
8105582bec1SHong Zhang 
8116ca4d86aSHong Zhang    Options Database Key:
8126ca4d86aSHong Zhang    Multigrid options(inherited)
8136ca4d86aSHong Zhang +  -pc_mg_cycles <1>: 1 for V cycle, 2 for W-cycle (MGSetCycles)
8146ca4d86aSHong Zhang .  -pc_mg_smoothup <1>: Number of post-smoothing steps (MGSetNumberSmoothUp)
8156ca4d86aSHong Zhang .  -pc_mg_smoothdown <1>: Number of pre-smoothing steps (MGSetNumberSmoothDown)
816ccd75124SBarry Smith    -pc_mg_type <multiplicative>: (one of) additive multiplicative full cascade kascade
81751f519a2SBarry Smith    ML options:
818ccd75124SBarry Smith .  -pc_ml_PrintLevel <0>: Print level (ML_Set_PrintLevel)
8196ca4d86aSHong Zhang .  -pc_ml_maxNlevels <10>: Maximum number of levels (None)
8206ca4d86aSHong Zhang .  -pc_ml_maxCoarseSize <1>: Maximum coarsest mesh size (ML_Aggregate_Set_MaxCoarseSize)
821f41ab451SVictor Eijkhout .  -pc_ml_CoarsenScheme <Uncoupled>: (one of) Uncoupled Coupled MIS METIS
8226ca4d86aSHong Zhang .  -pc_ml_DampingFactor <1.33333>: P damping factor (ML_Aggregate_Set_DampingFactor)
8236ca4d86aSHong Zhang .  -pc_ml_Threshold <0>: Smoother drop tol (ML_Aggregate_Set_Threshold)
8247ffd031bSHong Zhang -  -pc_ml_SpectralNormScheme_Anorm <false>: Method used for estimating spectral radius (ML_Set_SpectralNormScheme_Anorm)
8255582bec1SHong Zhang 
8265582bec1SHong Zhang    Level: intermediate
8275582bec1SHong Zhang 
8285582bec1SHong Zhang   Concepts: multigrid
8295582bec1SHong Zhang 
8305582bec1SHong Zhang .seealso:  PCCreate(), PCSetType(), PCType (for list of available types), PC, PCMGType,
83197177400SBarry Smith            PCMGSetLevels(), PCMGGetLevels(), PCMGSetType(), MPSetCycles(), PCMGSetNumberSmoothDown(),
83297177400SBarry Smith            PCMGSetNumberSmoothUp(), PCMGGetCoarseSolve(), PCMGSetResidual(), PCMGSetInterpolation(),
83397177400SBarry Smith            PCMGSetRestriction(), PCMGGetSmoother(), PCMGGetSmootherUp(), PCMGGetSmootherDown(),
83497177400SBarry Smith            PCMGSetCyclesOnLevel(), PCMGSetRhs(), PCMGSetX(), PCMGSetR()
8355582bec1SHong Zhang M*/
8365582bec1SHong Zhang 
8375582bec1SHong Zhang EXTERN_C_BEGIN
8385582bec1SHong Zhang #undef __FUNCT__
8395582bec1SHong Zhang #define __FUNCT__ "PCCreate_ML"
8407087cfbeSBarry Smith PetscErrorCode  PCCreate_ML(PC pc)
8415582bec1SHong Zhang {
8425582bec1SHong Zhang   PetscErrorCode  ierr;
8435582bec1SHong Zhang   PC_ML           *pc_ml;
84401da6913SBarry Smith   PC_MG           *mg;
8455582bec1SHong Zhang 
8465582bec1SHong Zhang   PetscFunctionBegin;
847573998d7SHong Zhang   /* PCML is an inherited class of PCMG. Initialize pc as PCMG */
8485582bec1SHong Zhang   ierr = PCSetType(pc,PCMG);CHKERRQ(ierr); /* calls PCCreate_MG() and MGCreate_Private() */
849*03bfa161SLisandro Dalcin   ierr = PetscObjectChangeTypeName((PetscObject)pc,PCML);CHKERRQ(ierr);
8505582bec1SHong Zhang 
8515582bec1SHong Zhang   /* create a supporting struct and attach it to pc */
85238f2d2fdSLisandro Dalcin   ierr = PetscNewLog(pc,PC_ML,&pc_ml);CHKERRQ(ierr);
85301da6913SBarry Smith   mg = (PC_MG*)pc->data;
85401da6913SBarry Smith   mg->innerctx = pc_ml;
8555582bec1SHong Zhang 
856573998d7SHong Zhang   pc_ml->ml_object     = 0;
857573998d7SHong Zhang   pc_ml->agg_object    = 0;
858573998d7SHong Zhang   pc_ml->gridctx       = 0;
859573998d7SHong Zhang   pc_ml->PetscMLdata   = 0;
860573998d7SHong Zhang   pc_ml->Nlevels       = -1;
861573998d7SHong Zhang   pc_ml->MaxNlevels    = 10;
862573998d7SHong Zhang   pc_ml->MaxCoarseSize = 1;
8633751b4bdSBarry Smith   pc_ml->CoarsenScheme = 1;
864573998d7SHong Zhang   pc_ml->Threshold     = 0.0;
865573998d7SHong Zhang   pc_ml->DampingFactor = 4.0/3.0;
866573998d7SHong Zhang   pc_ml->SpectralNormScheme_Anorm = PETSC_FALSE;
867573998d7SHong Zhang   pc_ml->size          = 0;
868573998d7SHong Zhang 
8695582bec1SHong Zhang   /* overwrite the pointers of PCMG by the functions of PCML */
8705582bec1SHong Zhang   pc->ops->setfromoptions = PCSetFromOptions_ML;
8715582bec1SHong Zhang   pc->ops->setup          = PCSetUp_ML;
872a06653b4SBarry Smith   pc->ops->reset          = PCReset_ML;
8735582bec1SHong Zhang   pc->ops->destroy        = PCDestroy_ML;
8745582bec1SHong Zhang   PetscFunctionReturn(0);
8755582bec1SHong Zhang }
8765582bec1SHong Zhang EXTERN_C_END
877