xref: /petsc/src/ksp/pc/impls/ml/ml.c (revision 92902e26b8d036ea0e019fbedad8dd2cf815760d)
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 */
7b45d2f2cSJed Brown #include <petsc-private/pcimpl.h>   /*I "petscpc.h" I*/
8b4876bcbSBarry Smith #include <../src/ksp/pc/impls/mg/mgimpl.h>                    /*I "petscksp.h" I*/
9c6db04a5SJed Brown #include <../src/mat/impls/aij/seq/aij.h>
10c6db04a5SJed Brown #include <../src/mat/impls/aij/mpi/mpiaij.h>
111e25c274SJed Brown #include <petscdm.h>            /* for DMDestroy(&pc->mg) hack */
12cb5d8e9eSHong Zhang 
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>
1939381ba2SJed Brown #include <ml_viz_stats.h>
205582bec1SHong Zhang EXTERN_C_END
215582bec1SHong Zhang 
22fb6a8e6dSJed Brown typedef enum {PCML_NULLSPACE_AUTO,PCML_NULLSPACE_USER,PCML_NULLSPACE_BLOCK,PCML_NULLSPACE_SCALAR} PCMLNullSpaceType;
23fb6a8e6dSJed Brown static const char *const PCMLNullSpaceTypes[] = {"AUTO","USER","BLOCK","SCALAR","PCMLNullSpaceType","PCML_NULLSPACE_",0};
24fb6a8e6dSJed Brown 
255582bec1SHong Zhang /* The context (data structure) at each grid level */
265582bec1SHong Zhang typedef struct {
275582bec1SHong Zhang   Vec x,b,r;                  /* global vectors */
285582bec1SHong Zhang   Mat A,P,R;
295582bec1SHong Zhang   KSP ksp;
3039381ba2SJed Brown   Vec coords;                 /* projected by ML, if PCSetCoordinates is called; values packed by node */
315582bec1SHong Zhang } GridCtx;
325582bec1SHong Zhang 
335582bec1SHong Zhang /* The context used to input PETSc matrix into ML at fine grid */
345582bec1SHong Zhang typedef struct {
35573998d7SHong Zhang   Mat         A;       /* Petsc matrix in aij format */
36573998d7SHong Zhang   Mat         Aloc;    /* local portion of A to be used by ML */
3724a42b14SHong Zhang   Vec         x,y;
385582bec1SHong Zhang   ML_Operator *mlmat;
395582bec1SHong Zhang   PetscScalar *pwork;  /* tmp array used by PetscML_comm() */
405582bec1SHong Zhang } FineGridCtx;
415582bec1SHong Zhang 
425582bec1SHong Zhang /* The context associates a ML matrix with a PETSc shell matrix */
435582bec1SHong Zhang typedef struct {
445582bec1SHong Zhang   Mat         A;        /* PETSc shell matrix associated with mlmat */
455582bec1SHong Zhang   ML_Operator *mlmat;   /* ML matrix assorciated with A */
4667d6f150SMatthew G Knepley   Vec         y, work;
475582bec1SHong Zhang } Mat_MLShell;
485582bec1SHong Zhang 
495582bec1SHong Zhang /* Private context for the ML preconditioner */
505582bec1SHong Zhang typedef struct {
515582bec1SHong Zhang   ML                *ml_object;
525582bec1SHong Zhang   ML_Aggregate      *agg_object;
535582bec1SHong Zhang   GridCtx           *gridctx;
545582bec1SHong Zhang   FineGridCtx       *PetscMLdata;
5539381ba2SJed Brown   PetscInt          Nlevels,MaxNlevels,MaxCoarseSize,CoarsenScheme,EnergyMinimization,MinPerProc,PutOnSingleProc,RepartitionType,ZoltanScheme;
5639381ba2SJed Brown   PetscReal         Threshold,DampingFactor,EnergyMinimizationDropTol,MaxMinRatio,AuxThreshold;
5739381ba2SJed Brown   PetscBool         SpectralNormScheme_Anorm,BlockScaling,EnergyMinimizationCheap,Symmetrize,OldHierarchy,KeepAggInfo,Reusable,Repartition,Aux;
5848268eb4SJed Brown   PetscBool         reuse_interpolation;
59fb6a8e6dSJed Brown   PCMLNullSpaceType nulltype;
60573998d7SHong Zhang   PetscMPIInt       size; /* size of communicator for pc->pmat */
6139381ba2SJed Brown   PetscInt          dim;  /* data from PCSetCoordinates(_ML) */
6239381ba2SJed Brown   PetscInt          nloc;
6339381ba2SJed Brown   PetscReal         *coords; /* ML has a grid object for each level: the finest grid will point into coords */
645582bec1SHong Zhang } PC_ML;
6541ca0015SHong Zhang 
666562c4e1SBarry Smith #undef __FUNCT__
676562c4e1SBarry Smith #define __FUNCT__ "PetscML_getrow"
686562c4e1SBarry 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[])
696562c4e1SBarry Smith {
706562c4e1SBarry Smith   PetscErrorCode ierr;
716562c4e1SBarry Smith   PetscInt       m,i,j,k=0,row,*aj;
726562c4e1SBarry Smith   PetscScalar    *aa;
736562c4e1SBarry Smith   FineGridCtx    *ml=(FineGridCtx*)ML_Get_MyGetrowData(ML_data);
746562c4e1SBarry Smith   Mat_SeqAIJ     *a = (Mat_SeqAIJ*)ml->Aloc->data;
755582bec1SHong Zhang 
760298fd71SBarry Smith   ierr = MatGetSize(ml->Aloc,&m,NULL); if (ierr) return(0);
776562c4e1SBarry Smith   for (i = 0; i<N_requested_rows; i++) {
786562c4e1SBarry Smith     row            = requested_rows[i];
796562c4e1SBarry Smith     row_lengths[i] = a->ilen[row];
806562c4e1SBarry Smith     if (allocated_space < k+row_lengths[i]) return(0);
816562c4e1SBarry Smith     if ((row >= 0) || (row <= (m-1))) {
826562c4e1SBarry Smith       aj = a->j + a->i[row];
836562c4e1SBarry Smith       aa = a->a + a->i[row];
846562c4e1SBarry Smith       for (j=0; j<row_lengths[i]; j++) {
856562c4e1SBarry Smith         columns[k]  = aj[j];
866562c4e1SBarry Smith         values[k++] = aa[j];
876562c4e1SBarry Smith       }
886562c4e1SBarry Smith     }
896562c4e1SBarry Smith   }
906562c4e1SBarry Smith   return(1);
916562c4e1SBarry Smith }
926562c4e1SBarry Smith 
936562c4e1SBarry Smith #undef __FUNCT__
946562c4e1SBarry Smith #define __FUNCT__ "PetscML_comm"
956562c4e1SBarry Smith static PetscErrorCode PetscML_comm(double p[],void *ML_data)
966562c4e1SBarry Smith {
976562c4e1SBarry Smith   PetscErrorCode ierr;
986562c4e1SBarry Smith   FineGridCtx    *ml = (FineGridCtx*)ML_data;
996562c4e1SBarry Smith   Mat            A   = ml->A;
1006562c4e1SBarry Smith   Mat_MPIAIJ     *a  = (Mat_MPIAIJ*)A->data;
1016562c4e1SBarry Smith   PetscMPIInt    size;
1026562c4e1SBarry Smith   PetscInt       i,in_length=A->rmap->n,out_length=ml->Aloc->cmap->n;
1036562c4e1SBarry Smith   PetscScalar    *array;
1046562c4e1SBarry Smith 
1056562c4e1SBarry Smith   PetscFunctionBegin;
106ce94432eSBarry Smith   ierr = MPI_Comm_size(PetscObjectComm((PetscObject)A),&size);CHKERRQ(ierr);
1076562c4e1SBarry Smith   if (size == 1) return 0;
1086562c4e1SBarry Smith 
1096562c4e1SBarry Smith   ierr = VecPlaceArray(ml->y,p);CHKERRQ(ierr);
1106562c4e1SBarry Smith   ierr = VecScatterBegin(a->Mvctx,ml->y,a->lvec,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
1116562c4e1SBarry Smith   ierr = VecScatterEnd(a->Mvctx,ml->y,a->lvec,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
1126562c4e1SBarry Smith   ierr = VecResetArray(ml->y);CHKERRQ(ierr);
1136562c4e1SBarry Smith   ierr = VecGetArray(a->lvec,&array);CHKERRQ(ierr);
1142fa5cd67SKarl Rupp   for (i=in_length; i<out_length; i++) p[i] = array[i-in_length];
1156562c4e1SBarry Smith   ierr = VecRestoreArray(a->lvec,&array);CHKERRQ(ierr);
1166562c4e1SBarry Smith   PetscFunctionReturn(0);
1176562c4e1SBarry Smith }
1186562c4e1SBarry Smith 
1196562c4e1SBarry Smith #undef __FUNCT__
1206562c4e1SBarry Smith #define __FUNCT__ "PetscML_matvec"
1216562c4e1SBarry Smith static int PetscML_matvec(ML_Operator *ML_data,int in_length,double p[],int out_length,double ap[])
1226562c4e1SBarry Smith {
1236562c4e1SBarry Smith   PetscErrorCode ierr;
1246562c4e1SBarry Smith   FineGridCtx    *ml = (FineGridCtx*)ML_Get_MyMatvecData(ML_data);
1256562c4e1SBarry Smith   Mat            A   = ml->A, Aloc=ml->Aloc;
1266562c4e1SBarry Smith   PetscMPIInt    size;
1276562c4e1SBarry Smith   PetscScalar    *pwork=ml->pwork;
1286562c4e1SBarry Smith   PetscInt       i;
1296562c4e1SBarry Smith 
1306562c4e1SBarry Smith   PetscFunctionBegin;
131ce94432eSBarry Smith   ierr = MPI_Comm_size(PetscObjectComm((PetscObject)A),&size);CHKERRQ(ierr);
1326562c4e1SBarry Smith   if (size == 1) {
1336562c4e1SBarry Smith     ierr = VecPlaceArray(ml->x,p);CHKERRQ(ierr);
1346562c4e1SBarry Smith   } else {
1356562c4e1SBarry Smith     for (i=0; i<in_length; i++) pwork[i] = p[i];
136b0250c70SBarry Smith     ierr = PetscML_comm(pwork,ml);CHKERRQ(ierr);
1376562c4e1SBarry Smith     ierr = VecPlaceArray(ml->x,pwork);CHKERRQ(ierr);
1386562c4e1SBarry Smith   }
1396562c4e1SBarry Smith   ierr = VecPlaceArray(ml->y,ap);CHKERRQ(ierr);
1406562c4e1SBarry Smith   ierr = MatMult(Aloc,ml->x,ml->y);CHKERRQ(ierr);
1416562c4e1SBarry Smith   ierr = VecResetArray(ml->x);CHKERRQ(ierr);
1426562c4e1SBarry Smith   ierr = VecResetArray(ml->y);CHKERRQ(ierr);
1436562c4e1SBarry Smith   PetscFunctionReturn(0);
1446562c4e1SBarry Smith }
1456562c4e1SBarry Smith 
1466562c4e1SBarry Smith #undef __FUNCT__
1476562c4e1SBarry Smith #define __FUNCT__ "MatMult_ML"
1486562c4e1SBarry Smith static PetscErrorCode MatMult_ML(Mat A,Vec x,Vec y)
1496562c4e1SBarry Smith {
1506562c4e1SBarry Smith   PetscErrorCode ierr;
1516562c4e1SBarry Smith   Mat_MLShell    *shell;
1526562c4e1SBarry Smith   PetscScalar    *xarray,*yarray;
1536562c4e1SBarry Smith   PetscInt       x_length,y_length;
1546562c4e1SBarry Smith 
1556562c4e1SBarry Smith   PetscFunctionBegin;
1566562c4e1SBarry Smith   ierr     = MatShellGetContext(A,(void**)&shell);CHKERRQ(ierr);
1576562c4e1SBarry Smith   ierr     = VecGetArray(x,&xarray);CHKERRQ(ierr);
1586562c4e1SBarry Smith   ierr     = VecGetArray(y,&yarray);CHKERRQ(ierr);
1596562c4e1SBarry Smith   x_length = shell->mlmat->invec_leng;
1606562c4e1SBarry Smith   y_length = shell->mlmat->outvec_leng;
161815d23e5SBarry Smith   PetscStackCall("ML_Operator_Apply",ML_Operator_Apply(shell->mlmat,x_length,xarray,y_length,yarray));
1626562c4e1SBarry Smith   ierr = VecRestoreArray(x,&xarray);CHKERRQ(ierr);
1636562c4e1SBarry Smith   ierr = VecRestoreArray(y,&yarray);CHKERRQ(ierr);
1646562c4e1SBarry Smith   PetscFunctionReturn(0);
1656562c4e1SBarry Smith }
1666562c4e1SBarry Smith 
1676562c4e1SBarry Smith #undef __FUNCT__
1686562c4e1SBarry Smith #define __FUNCT__ "MatMultAdd_ML"
16967d6f150SMatthew G Knepley /* Computes y = w + A * x
17067d6f150SMatthew G Knepley    It is possible that w == y, but not x == y
17167d6f150SMatthew G Knepley */
1726562c4e1SBarry Smith static PetscErrorCode MatMultAdd_ML(Mat A,Vec x,Vec w,Vec y)
1736562c4e1SBarry Smith {
1746562c4e1SBarry Smith   Mat_MLShell    *shell;
1756562c4e1SBarry Smith   PetscScalar    *xarray,*yarray;
1766562c4e1SBarry Smith   PetscInt       x_length,y_length;
17767d6f150SMatthew G Knepley   PetscErrorCode ierr;
1786562c4e1SBarry Smith 
1796562c4e1SBarry Smith   PetscFunctionBegin;
1806562c4e1SBarry Smith   ierr = MatShellGetContext(A, (void**) &shell);CHKERRQ(ierr);
18167d6f150SMatthew G Knepley   if (y == w) {
18267d6f150SMatthew G Knepley     if (!shell->work) {
18367d6f150SMatthew G Knepley       ierr = VecDuplicate(y, &shell->work);CHKERRQ(ierr);
18467d6f150SMatthew G Knepley     }
18567d6f150SMatthew G Knepley     ierr     = VecGetArray(x,           &xarray);CHKERRQ(ierr);
18667d6f150SMatthew G Knepley     ierr     = VecGetArray(shell->work, &yarray);CHKERRQ(ierr);
18767d6f150SMatthew G Knepley     x_length = shell->mlmat->invec_leng;
18867d6f150SMatthew G Knepley     y_length = shell->mlmat->outvec_leng;
189815d23e5SBarry Smith     PetscStackCall("ML_Operator_Apply",ML_Operator_Apply(shell->mlmat, x_length, xarray, y_length, yarray));
19067d6f150SMatthew G Knepley     ierr = VecRestoreArray(x,           &xarray);CHKERRQ(ierr);
19167d6f150SMatthew G Knepley     ierr = VecRestoreArray(shell->work, &yarray);CHKERRQ(ierr);
1923ba3408dSMatthew G Knepley     ierr = VecAXPY(y, 1.0, shell->work);CHKERRQ(ierr);
19367d6f150SMatthew G Knepley   } else {
1946562c4e1SBarry Smith     ierr     = VecGetArray(x, &xarray);CHKERRQ(ierr);
1956562c4e1SBarry Smith     ierr     = VecGetArray(y, &yarray);CHKERRQ(ierr);
1966562c4e1SBarry Smith     x_length = shell->mlmat->invec_leng;
1976562c4e1SBarry Smith     y_length = shell->mlmat->outvec_leng;
198815d23e5SBarry Smith     PetscStackCall("ML_Operator_Apply",ML_Operator_Apply(shell->mlmat, x_length, xarray, y_length, yarray));
1996562c4e1SBarry Smith     ierr = VecRestoreArray(x, &xarray);CHKERRQ(ierr);
2006562c4e1SBarry Smith     ierr = VecRestoreArray(y, &yarray);CHKERRQ(ierr);
2016562c4e1SBarry Smith     ierr = VecAXPY(y, 1.0, w);CHKERRQ(ierr);
20267d6f150SMatthew G Knepley   }
2036562c4e1SBarry Smith   PetscFunctionReturn(0);
2046562c4e1SBarry Smith }
2056562c4e1SBarry Smith 
20679d04de1SBarry Smith /* newtype is ignored since only handles one case */
2076562c4e1SBarry Smith #undef __FUNCT__
2086562c4e1SBarry Smith #define __FUNCT__ "MatConvert_MPIAIJ_ML"
2096562c4e1SBarry Smith static PetscErrorCode MatConvert_MPIAIJ_ML(Mat A,MatType newtype,MatReuse scall,Mat *Aloc)
2106562c4e1SBarry Smith {
2116562c4e1SBarry Smith   PetscErrorCode ierr;
2126562c4e1SBarry Smith   Mat_MPIAIJ     *mpimat=(Mat_MPIAIJ*)A->data;
2136562c4e1SBarry Smith   Mat_SeqAIJ     *mat,*a=(Mat_SeqAIJ*)(mpimat->A)->data,*b=(Mat_SeqAIJ*)(mpimat->B)->data;
2146562c4e1SBarry Smith   PetscInt       *ai=a->i,*aj=a->j,*bi=b->i,*bj=b->j;
2156562c4e1SBarry Smith   PetscScalar    *aa=a->a,*ba=b->a,*ca;
2166562c4e1SBarry Smith   PetscInt       am =A->rmap->n,an=A->cmap->n,i,j,k;
2176562c4e1SBarry Smith   PetscInt       *ci,*cj,ncols;
2186562c4e1SBarry Smith 
2196562c4e1SBarry Smith   PetscFunctionBegin;
220e32f2f54SBarry 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);
2216562c4e1SBarry Smith 
2226562c4e1SBarry Smith   if (scall == MAT_INITIAL_MATRIX) {
223785e854fSJed Brown     ierr  = PetscMalloc1((1+am),&ci);CHKERRQ(ierr);
2246562c4e1SBarry Smith     ci[0] = 0;
2252fa5cd67SKarl Rupp     for (i=0; i<am; i++) ci[i+1] = ci[i] + (ai[i+1] - ai[i]) + (bi[i+1] - bi[i]);
226785e854fSJed Brown     ierr = PetscMalloc1((1+ci[am]),&cj);CHKERRQ(ierr);
227785e854fSJed Brown     ierr = PetscMalloc1((1+ci[am]),&ca);CHKERRQ(ierr);
2286562c4e1SBarry Smith 
2296562c4e1SBarry Smith     k = 0;
2306562c4e1SBarry Smith     for (i=0; i<am; i++) {
2316562c4e1SBarry Smith       /* diagonal portion of A */
2326562c4e1SBarry Smith       ncols = ai[i+1] - ai[i];
2336562c4e1SBarry Smith       for (j=0; j<ncols; j++) {
2346562c4e1SBarry Smith         cj[k]   = *aj++;
2356562c4e1SBarry Smith         ca[k++] = *aa++;
2366562c4e1SBarry Smith       }
2376562c4e1SBarry Smith       /* off-diagonal portion of A */
2386562c4e1SBarry Smith       ncols = bi[i+1] - bi[i];
2396562c4e1SBarry Smith       for (j=0; j<ncols; j++) {
2406562c4e1SBarry Smith         cj[k]   = an + (*bj); bj++;
2416562c4e1SBarry Smith         ca[k++] = *ba++;
2426562c4e1SBarry Smith       }
2436562c4e1SBarry Smith     }
244e32f2f54SBarry Smith     if (k != ci[am]) SETERRQ2(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"k: %d != ci[am]: %d",k,ci[am]);
2456562c4e1SBarry Smith 
2466562c4e1SBarry Smith     /* put together the new matrix */
2476562c4e1SBarry Smith     an   = mpimat->A->cmap->n+mpimat->B->cmap->n;
2486562c4e1SBarry Smith     ierr = MatCreateSeqAIJWithArrays(PETSC_COMM_SELF,am,an,ci,cj,ca,Aloc);CHKERRQ(ierr);
2496562c4e1SBarry Smith 
2506562c4e1SBarry Smith     /* MatCreateSeqAIJWithArrays flags matrix so PETSc doesn't free the user's arrays. */
2516562c4e1SBarry Smith     /* Since these are PETSc arrays, change flags to free them as necessary. */
2526562c4e1SBarry Smith     mat          = (Mat_SeqAIJ*)(*Aloc)->data;
2536562c4e1SBarry Smith     mat->free_a  = PETSC_TRUE;
2546562c4e1SBarry Smith     mat->free_ij = PETSC_TRUE;
2556562c4e1SBarry Smith 
2566562c4e1SBarry Smith     mat->nonew = 0;
2576562c4e1SBarry Smith   } else if (scall == MAT_REUSE_MATRIX) {
2586562c4e1SBarry Smith     mat=(Mat_SeqAIJ*)(*Aloc)->data;
2596562c4e1SBarry Smith     ci = mat->i; cj = mat->j; ca = mat->a;
2606562c4e1SBarry Smith     for (i=0; i<am; i++) {
2616562c4e1SBarry Smith       /* diagonal portion of A */
2626562c4e1SBarry Smith       ncols = ai[i+1] - ai[i];
2636562c4e1SBarry Smith       for (j=0; j<ncols; j++) *ca++ = *aa++;
2646562c4e1SBarry Smith       /* off-diagonal portion of A */
2656562c4e1SBarry Smith       ncols = bi[i+1] - bi[i];
2666562c4e1SBarry Smith       for (j=0; j<ncols; j++) *ca++ = *ba++;
2676562c4e1SBarry Smith     }
268ce94432eSBarry Smith   } else SETERRQ1(PetscObjectComm((PetscObject)A),PETSC_ERR_ARG_WRONG,"Invalid MatReuse %d",(int)scall);
2696562c4e1SBarry Smith   PetscFunctionReturn(0);
2706562c4e1SBarry Smith }
2716562c4e1SBarry Smith 
2726562c4e1SBarry Smith extern PetscErrorCode MatDestroy_Shell(Mat);
2736562c4e1SBarry Smith #undef __FUNCT__
2746562c4e1SBarry Smith #define __FUNCT__ "MatDestroy_ML"
2756562c4e1SBarry Smith static PetscErrorCode MatDestroy_ML(Mat A)
2766562c4e1SBarry Smith {
2776562c4e1SBarry Smith   PetscErrorCode ierr;
2786562c4e1SBarry Smith   Mat_MLShell    *shell;
2796562c4e1SBarry Smith 
2806562c4e1SBarry Smith   PetscFunctionBegin;
2816562c4e1SBarry Smith   ierr = MatShellGetContext(A,(void**)&shell);CHKERRQ(ierr);
282601cad40SBrad Aagaard   ierr = VecDestroy(&shell->y);CHKERRQ(ierr);
283601cad40SBrad Aagaard   if (shell->work) {ierr = VecDestroy(&shell->work);CHKERRQ(ierr);}
2846562c4e1SBarry Smith   ierr = PetscFree(shell);CHKERRQ(ierr);
2856562c4e1SBarry Smith   ierr = MatDestroy_Shell(A);CHKERRQ(ierr);
2866562c4e1SBarry Smith   ierr = PetscObjectChangeTypeName((PetscObject)A,0);CHKERRQ(ierr);
2876562c4e1SBarry Smith   PetscFunctionReturn(0);
2886562c4e1SBarry Smith }
2896562c4e1SBarry Smith 
2906562c4e1SBarry Smith #undef __FUNCT__
2916562c4e1SBarry Smith #define __FUNCT__ "MatWrapML_SeqAIJ"
2926562c4e1SBarry Smith static PetscErrorCode MatWrapML_SeqAIJ(ML_Operator *mlmat,MatReuse reuse,Mat *newmat)
2936562c4e1SBarry Smith {
2946562c4e1SBarry Smith   struct ML_CSR_MSRdata *matdata = (struct ML_CSR_MSRdata*)mlmat->data;
2956562c4e1SBarry Smith   PetscErrorCode        ierr;
2960298fd71SBarry Smith   PetscInt              m       =mlmat->outvec_leng,n=mlmat->invec_leng,*nnz = NULL,nz_max;
29739381ba2SJed Brown   PetscInt              *ml_cols=matdata->columns,*ml_rowptr=matdata->rowptr,*aj,i;
2986562c4e1SBarry Smith   PetscScalar           *ml_vals=matdata->values,*aa;
2996562c4e1SBarry Smith 
3006562c4e1SBarry Smith   PetscFunctionBegin;
301e7e72b3dSBarry Smith   if (!mlmat->getrow) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_NULL,"mlmat->getrow = NULL");
3026562c4e1SBarry Smith   if (m != n) { /* ML Pmat and Rmat are in CSR format. Pass array pointers into SeqAIJ matrix */
3036562c4e1SBarry Smith     if (reuse) {
3046562c4e1SBarry Smith       Mat_SeqAIJ *aij= (Mat_SeqAIJ*)(*newmat)->data;
3056562c4e1SBarry Smith       aij->i = ml_rowptr;
3066562c4e1SBarry Smith       aij->j = ml_cols;
3076562c4e1SBarry Smith       aij->a = ml_vals;
3086562c4e1SBarry Smith     } else {
3096562c4e1SBarry Smith       /* sort ml_cols and ml_vals */
310785e854fSJed Brown       ierr = PetscMalloc1((m+1),&nnz);
3112fa5cd67SKarl Rupp       for (i=0; i<m; i++) nnz[i] = ml_rowptr[i+1] - ml_rowptr[i];
3126562c4e1SBarry Smith       aj = ml_cols; aa = ml_vals;
3136562c4e1SBarry Smith       for (i=0; i<m; i++) {
3146562c4e1SBarry Smith         ierr = PetscSortIntWithScalarArray(nnz[i],aj,aa);CHKERRQ(ierr);
3156562c4e1SBarry Smith         aj  += nnz[i]; aa += nnz[i];
3166562c4e1SBarry Smith       }
3176562c4e1SBarry Smith       ierr = MatCreateSeqAIJWithArrays(PETSC_COMM_SELF,m,n,ml_rowptr,ml_cols,ml_vals,newmat);CHKERRQ(ierr);
3186562c4e1SBarry Smith       ierr = PetscFree(nnz);CHKERRQ(ierr);
3196562c4e1SBarry Smith     }
3206562c4e1SBarry Smith     PetscFunctionReturn(0);
3216562c4e1SBarry Smith   }
3226562c4e1SBarry Smith 
32339381ba2SJed Brown   nz_max = PetscMax(1,mlmat->max_nz_per_row);
324dcca6d9dSJed Brown   ierr   = PetscMalloc2(nz_max,&aa,nz_max,&aj);CHKERRQ(ierr);
32539381ba2SJed Brown   if (!reuse) {
3266562c4e1SBarry Smith     ierr = MatCreate(PETSC_COMM_SELF,newmat);CHKERRQ(ierr);
3276562c4e1SBarry Smith     ierr = MatSetSizes(*newmat,m,n,PETSC_DECIDE,PETSC_DECIDE);CHKERRQ(ierr);
3286562c4e1SBarry Smith     ierr = MatSetType(*newmat,MATSEQAIJ);CHKERRQ(ierr);
32939381ba2SJed Brown     /* keep track of block size for A matrices */
33039381ba2SJed Brown     ierr = MatSetBlockSize (*newmat, mlmat->num_PDEs);CHKERRQ(ierr);
3316562c4e1SBarry Smith 
332785e854fSJed Brown     ierr = PetscMalloc1(m,&nnz);CHKERRQ(ierr);
3336562c4e1SBarry Smith     for (i=0; i<m; i++) {
334815d23e5SBarry Smith       PetscStackCall("ML_Operator_Getrow",ML_Operator_Getrow(mlmat,1,&i,nz_max,aj,aa,&nnz[i]));
3356562c4e1SBarry Smith     }
3366562c4e1SBarry Smith     ierr = MatSeqAIJSetPreallocation(*newmat,0,nnz);CHKERRQ(ierr);
337ae7fe62dSJed Brown   }
3386562c4e1SBarry Smith   for (i=0; i<m; i++) {
339ae7fe62dSJed Brown     PetscInt ncols;
34039381ba2SJed Brown 
341815d23e5SBarry Smith     PetscStackCall("ML_Operator_Getrow",ML_Operator_Getrow(mlmat,1,&i,nz_max,aj,aa,&ncols));
342ae7fe62dSJed Brown     ierr = MatSetValues(*newmat,1,&i,ncols,aj,aa,INSERT_VALUES);CHKERRQ(ierr);
3436562c4e1SBarry Smith   }
3446562c4e1SBarry Smith   ierr = MatAssemblyBegin(*newmat,MAT_FINAL_ASSEMBLY);CHKERRQ(ierr);
3456562c4e1SBarry Smith   ierr = MatAssemblyEnd(*newmat,MAT_FINAL_ASSEMBLY);CHKERRQ(ierr);
3466562c4e1SBarry Smith 
3476562c4e1SBarry Smith   ierr = PetscFree2(aa,aj);CHKERRQ(ierr);
3486562c4e1SBarry Smith   ierr = PetscFree(nnz);CHKERRQ(ierr);
3496562c4e1SBarry Smith   PetscFunctionReturn(0);
3506562c4e1SBarry Smith }
3516562c4e1SBarry Smith 
3526562c4e1SBarry Smith #undef __FUNCT__
3536562c4e1SBarry Smith #define __FUNCT__ "MatWrapML_SHELL"
3546562c4e1SBarry Smith static PetscErrorCode MatWrapML_SHELL(ML_Operator *mlmat,MatReuse reuse,Mat *newmat)
3556562c4e1SBarry Smith {
3566562c4e1SBarry Smith   PetscErrorCode ierr;
3576562c4e1SBarry Smith   PetscInt       m,n;
3586562c4e1SBarry Smith   ML_Comm        *MLcomm;
3596562c4e1SBarry Smith   Mat_MLShell    *shellctx;
3606562c4e1SBarry Smith 
3616562c4e1SBarry Smith   PetscFunctionBegin;
3626562c4e1SBarry Smith   m = mlmat->outvec_leng;
3636562c4e1SBarry Smith   n = mlmat->invec_leng;
3646562c4e1SBarry Smith 
3656562c4e1SBarry Smith   if (reuse) {
3666562c4e1SBarry Smith     ierr            = MatShellGetContext(*newmat,(void**)&shellctx);CHKERRQ(ierr);
3676562c4e1SBarry Smith     shellctx->mlmat = mlmat;
3686562c4e1SBarry Smith     PetscFunctionReturn(0);
3696562c4e1SBarry Smith   }
3706562c4e1SBarry Smith 
3716562c4e1SBarry Smith   MLcomm = mlmat->comm;
3722fa5cd67SKarl Rupp 
373b00a9115SJed Brown   ierr = PetscNew(&shellctx);CHKERRQ(ierr);
3746562c4e1SBarry Smith   ierr = MatCreateShell(MLcomm->USR_comm,m,n,PETSC_DETERMINE,PETSC_DETERMINE,shellctx,newmat);CHKERRQ(ierr);
3756562c4e1SBarry Smith   ierr = MatShellSetOperation(*newmat,MATOP_MULT,(void(*)(void))MatMult_ML);CHKERRQ(ierr);
3766562c4e1SBarry Smith   ierr = MatShellSetOperation(*newmat,MATOP_MULT_ADD,(void(*)(void))MatMultAdd_ML);CHKERRQ(ierr);
3772fa5cd67SKarl Rupp 
3786562c4e1SBarry Smith   shellctx->A         = *newmat;
3796562c4e1SBarry Smith   shellctx->mlmat     = mlmat;
3800298fd71SBarry Smith   shellctx->work      = NULL;
3812fa5cd67SKarl Rupp 
3829bb5392cSJed Brown   ierr = VecCreate(MLcomm->USR_comm,&shellctx->y);CHKERRQ(ierr);
3836562c4e1SBarry Smith   ierr = VecSetSizes(shellctx->y,m,PETSC_DECIDE);CHKERRQ(ierr);
384c0dedaeaSBarry Smith   ierr = VecSetType(shellctx->y,VECSTANDARD);CHKERRQ(ierr);
3852fa5cd67SKarl Rupp 
3866562c4e1SBarry Smith   (*newmat)->ops->destroy = MatDestroy_ML;
3876562c4e1SBarry Smith   PetscFunctionReturn(0);
3886562c4e1SBarry Smith }
3896562c4e1SBarry Smith 
3906562c4e1SBarry Smith #undef __FUNCT__
3916562c4e1SBarry Smith #define __FUNCT__ "MatWrapML_MPIAIJ"
392ae7fe62dSJed Brown static PetscErrorCode MatWrapML_MPIAIJ(ML_Operator *mlmat,MatReuse reuse,Mat *newmat)
3936562c4e1SBarry Smith {
39439381ba2SJed Brown   PetscInt       *aj;
39539381ba2SJed Brown   PetscScalar    *aa;
3966562c4e1SBarry Smith   PetscErrorCode ierr;
39739381ba2SJed Brown   PetscInt       i,j,*gordering;
398ae7fe62dSJed Brown   PetscInt       m=mlmat->outvec_leng,n,nz_max,row;
3996562c4e1SBarry Smith   Mat            A;
4006562c4e1SBarry Smith 
4016562c4e1SBarry Smith   PetscFunctionBegin;
402e7e72b3dSBarry Smith   if (!mlmat->getrow) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_NULL,"mlmat->getrow = NULL");
4036562c4e1SBarry Smith   n = mlmat->invec_leng;
404e32f2f54SBarry Smith   if (m != n) SETERRQ2(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"m %d must equal to n %d",m,n);
4056562c4e1SBarry Smith 
4067be6b909SBarry Smith   /* create global row numbering for a ML_Operator */
4077be6b909SBarry Smith   PetscStackCall("ML_build_global_numbering",ML_build_global_numbering(mlmat,&gordering,"rows"));
4087be6b909SBarry Smith 
4091d94bf15SBarry Smith   nz_max = PetscMax(1,mlmat->max_nz_per_row) + 1;
410dcca6d9dSJed Brown   ierr = PetscMalloc2(nz_max,&aa,nz_max,&aj);CHKERRQ(ierr);
4117be6b909SBarry Smith   if (reuse) {
4127be6b909SBarry Smith     A = *newmat;
4137be6b909SBarry Smith   } else {
414ae7fe62dSJed Brown     PetscInt *nnzA,*nnzB,*nnz;
4157be6b909SBarry Smith     PetscInt rstart;
4166562c4e1SBarry Smith     ierr = MatCreate(mlmat->comm->USR_comm,&A);CHKERRQ(ierr);
4176562c4e1SBarry Smith     ierr = MatSetSizes(A,m,n,PETSC_DECIDE,PETSC_DECIDE);CHKERRQ(ierr);
4186562c4e1SBarry Smith     ierr = MatSetType(A,MATMPIAIJ);CHKERRQ(ierr);
41939381ba2SJed Brown     /* keep track of block size for A matrices */
42039381ba2SJed Brown     ierr = MatSetBlockSize (A,mlmat->num_PDEs);CHKERRQ(ierr);
421dcca6d9dSJed Brown     ierr = PetscMalloc3(m,&nnzA,m,&nnzB,m,&nnz);CHKERRQ(ierr);
422*92902e26SBarry Smith     ierr = MPI_Scan(&m,&rstart,1,MPIU_INT,MPI_SUM,mlmat->comm->USR_comm);CHKERRQ(ierr);
4237be6b909SBarry Smith     rstart -= m;
4246562c4e1SBarry Smith 
4256562c4e1SBarry Smith     for (i=0; i<m; i++) {
4267be6b909SBarry Smith       row = gordering[i] - rstart;
427815d23e5SBarry Smith       PetscStackCall("ML_Operator_Getrow",ML_Operator_Getrow(mlmat,1,&i,nz_max,aj,aa,&nnz[i]));
4287be6b909SBarry Smith       nnzA[row] = 0;
42939381ba2SJed Brown       for (j=0; j<nnz[i]; j++) {
4307be6b909SBarry Smith         if (aj[j] < m) nnzA[row]++;
4316562c4e1SBarry Smith       }
4327be6b909SBarry Smith       nnzB[row] = nnz[i] - nnzA[row];
4336562c4e1SBarry Smith     }
4346562c4e1SBarry Smith     ierr = MatMPIAIJSetPreallocation(A,0,nnzA,0,nnzB);CHKERRQ(ierr);
435ae7fe62dSJed Brown     ierr = PetscFree3(nnzA,nnzB,nnz);
436ae7fe62dSJed Brown   }
4376562c4e1SBarry Smith   for (i=0; i<m; i++) {
438ae7fe62dSJed Brown     PetscInt ncols;
4396562c4e1SBarry Smith     row = gordering[i];
44039381ba2SJed Brown 
441815d23e5SBarry Smith     PetscStackCall(",ML_Operator_Getrow",ML_Operator_Getrow(mlmat,1,&i,nz_max,aj,aa,&ncols));
4422fa5cd67SKarl Rupp     for (j = 0; j < ncols; j++) aj[j] = gordering[aj[j]];
443ae7fe62dSJed Brown     ierr = MatSetValues(A,1,&row,ncols,aj,aa,INSERT_VALUES);CHKERRQ(ierr);
4446562c4e1SBarry Smith   }
4457be6b909SBarry Smith   PetscStackCall("ML_free",ML_free(gordering));
4466562c4e1SBarry Smith   ierr    = MatAssemblyBegin(A,MAT_FINAL_ASSEMBLY);CHKERRQ(ierr);
4476562c4e1SBarry Smith   ierr    = MatAssemblyEnd(A,MAT_FINAL_ASSEMBLY);CHKERRQ(ierr);
4486562c4e1SBarry Smith   *newmat = A;
4496562c4e1SBarry Smith 
4506562c4e1SBarry Smith   ierr = PetscFree2(aa,aj);CHKERRQ(ierr);
4516562c4e1SBarry Smith   PetscFunctionReturn(0);
4526562c4e1SBarry Smith }
4536562c4e1SBarry Smith 
45439381ba2SJed Brown /* -------------------------------------------------------------------------- */
45539381ba2SJed Brown /*
45639381ba2SJed Brown    PCSetCoordinates_ML
45739381ba2SJed Brown 
45839381ba2SJed Brown    Input Parameter:
45939381ba2SJed Brown    .  pc - the preconditioner context
46039381ba2SJed Brown */
46139381ba2SJed Brown #undef __FUNCT__
46239381ba2SJed Brown #define __FUNCT__ "PCSetCoordinates_ML"
463f7a08781SBarry Smith static PetscErrorCode PCSetCoordinates_ML(PC pc, PetscInt ndm, PetscInt a_nloc, PetscReal *coords)
46439381ba2SJed Brown {
46539381ba2SJed Brown   PC_MG          *mg    = (PC_MG*)pc->data;
46639381ba2SJed Brown   PC_ML          *pc_ml = (PC_ML*)mg->innerctx;
46739381ba2SJed Brown   PetscErrorCode ierr;
46839381ba2SJed Brown   PetscInt       arrsz,oldarrsz,bs,my0,kk,ii,nloc,Iend;
46939381ba2SJed Brown   Mat            Amat = pc->pmat;
47039381ba2SJed Brown 
47139381ba2SJed Brown   /* this function copied and modified from PCSetCoordinates_GEO -TGI */
47239381ba2SJed Brown   PetscFunctionBegin;
47339381ba2SJed Brown   PetscValidHeaderSpecific(Amat, MAT_CLASSID, 1);
47439381ba2SJed Brown   ierr = MatGetBlockSize(Amat, &bs);CHKERRQ(ierr);
47539381ba2SJed Brown 
47639381ba2SJed Brown   ierr = MatGetOwnershipRange(Amat, &my0, &Iend);CHKERRQ(ierr);
47739381ba2SJed Brown   nloc = (Iend-my0)/bs;
47839381ba2SJed Brown 
479ce94432eSBarry Smith   if (nloc!=a_nloc) SETERRQ2(PetscObjectComm((PetscObject)Amat),PETSC_ERR_ARG_WRONG, "Number of local blocks must locations = %d %d.",a_nloc,nloc);
480ce94432eSBarry Smith   if ((Iend-my0)%bs!=0) SETERRQ1(PetscObjectComm((PetscObject)Amat),PETSC_ERR_ARG_WRONG, "Bad local size %d.",nloc);
48139381ba2SJed Brown 
48239381ba2SJed Brown   oldarrsz    = pc_ml->dim * pc_ml->nloc;
48339381ba2SJed Brown   pc_ml->dim  = ndm;
48439381ba2SJed Brown   pc_ml->nloc = a_nloc;
48539381ba2SJed Brown   arrsz       = ndm * a_nloc;
48639381ba2SJed Brown 
48739381ba2SJed Brown   /* create data - syntactic sugar that should be refactored at some point */
48839381ba2SJed Brown   if (pc_ml->coords==0 || (oldarrsz != arrsz)) {
48939381ba2SJed Brown     ierr = PetscFree(pc_ml->coords);CHKERRQ(ierr);
490785e854fSJed Brown     ierr = PetscMalloc1((arrsz), &pc_ml->coords);CHKERRQ(ierr);
49139381ba2SJed Brown   }
49239381ba2SJed Brown   for (kk=0; kk<arrsz; kk++) pc_ml->coords[kk] = -999.;
49339381ba2SJed Brown   /* copy data in - column oriented */
49439381ba2SJed Brown   for (kk = 0; kk < nloc; kk++) {
49539381ba2SJed Brown     for (ii = 0; ii < ndm; ii++) {
49639381ba2SJed Brown       pc_ml->coords[ii*nloc + kk] =  coords[kk*ndm + ii];
49739381ba2SJed Brown     }
49839381ba2SJed Brown   }
49939381ba2SJed Brown   PetscFunctionReturn(0);
50039381ba2SJed Brown }
50139381ba2SJed Brown 
5026562c4e1SBarry Smith /* -----------------------------------------------------------------------------*/
503e45a0c82SBarry Smith extern PetscErrorCode PCReset_MG(PC);
50401da6913SBarry Smith #undef __FUNCT__
505a06653b4SBarry Smith #define __FUNCT__ "PCReset_ML"
50616336fedSMatthew G Knepley PetscErrorCode PCReset_ML(PC pc)
50701da6913SBarry Smith {
50801da6913SBarry Smith   PetscErrorCode ierr;
509e0262f48SMatthew G Knepley   PC_MG          *mg    = (PC_MG*)pc->data;
510e0262f48SMatthew G Knepley   PC_ML          *pc_ml = (PC_ML*)mg->innerctx;
51139381ba2SJed Brown   PetscInt       level,fine_level=pc_ml->Nlevels-1,dim=pc_ml->dim;
51201da6913SBarry Smith 
51301da6913SBarry Smith   PetscFunctionBegin;
51439381ba2SJed Brown   if (dim) {
51539381ba2SJed Brown     ML_Aggregate_Viz_Stats * grid_info = (ML_Aggregate_Viz_Stats*) pc_ml->ml_object->Grid[0].Grid;
51639381ba2SJed Brown 
51739381ba2SJed Brown     for (level=0; level<=fine_level; level++) {
51839381ba2SJed Brown       ierr = VecDestroy(&pc_ml->gridctx[level].coords);CHKERRQ(ierr);
51939381ba2SJed Brown     }
52039381ba2SJed Brown 
52139381ba2SJed Brown     grid_info->x = 0; /* do this so ML doesn't try to free coordinates */
52239381ba2SJed Brown     grid_info->y = 0;
52339381ba2SJed Brown     grid_info->z = 0;
52439381ba2SJed Brown 
525815d23e5SBarry Smith     PetscStackCall("ML_Operator_Getrow",ML_Aggregate_VizAndStats_Clean(pc_ml->ml_object));
52639381ba2SJed Brown   }
527815d23e5SBarry Smith   PetscStackCall("ML_Aggregate_Destroy",ML_Aggregate_Destroy(&pc_ml->agg_object));
528815d23e5SBarry Smith   PetscStackCall("ML_Aggregate_Destroy",ML_Destroy(&pc_ml->ml_object));
52901da6913SBarry Smith 
53001da6913SBarry Smith   if (pc_ml->PetscMLdata) {
53101da6913SBarry Smith     ierr = PetscFree(pc_ml->PetscMLdata->pwork);CHKERRQ(ierr);
532ae7fe62dSJed Brown     ierr = MatDestroy(&pc_ml->PetscMLdata->Aloc);CHKERRQ(ierr);
533ae7fe62dSJed Brown     ierr = VecDestroy(&pc_ml->PetscMLdata->x);CHKERRQ(ierr);
534ae7fe62dSJed Brown     ierr = VecDestroy(&pc_ml->PetscMLdata->y);CHKERRQ(ierr);
53501da6913SBarry Smith   }
53601da6913SBarry Smith   ierr = PetscFree(pc_ml->PetscMLdata);CHKERRQ(ierr);
53701da6913SBarry Smith 
538f5a5dd59SJed Brown   if (pc_ml->gridctx) {
53901da6913SBarry Smith     for (level=0; level<fine_level; level++) {
540601cad40SBrad Aagaard       if (pc_ml->gridctx[level].A) {ierr = MatDestroy(&pc_ml->gridctx[level].A);CHKERRQ(ierr);}
541601cad40SBrad Aagaard       if (pc_ml->gridctx[level].P) {ierr = MatDestroy(&pc_ml->gridctx[level].P);CHKERRQ(ierr);}
542601cad40SBrad Aagaard       if (pc_ml->gridctx[level].R) {ierr = MatDestroy(&pc_ml->gridctx[level].R);CHKERRQ(ierr);}
543601cad40SBrad Aagaard       if (pc_ml->gridctx[level].x) {ierr = VecDestroy(&pc_ml->gridctx[level].x);CHKERRQ(ierr);}
544601cad40SBrad Aagaard       if (pc_ml->gridctx[level].b) {ierr = VecDestroy(&pc_ml->gridctx[level].b);CHKERRQ(ierr);}
545601cad40SBrad Aagaard       if (pc_ml->gridctx[level+1].r) {ierr = VecDestroy(&pc_ml->gridctx[level+1].r);CHKERRQ(ierr);}
54601da6913SBarry Smith     }
547f5a5dd59SJed Brown   }
54801da6913SBarry Smith   ierr = PetscFree(pc_ml->gridctx);CHKERRQ(ierr);
54939381ba2SJed Brown   ierr = PetscFree(pc_ml->coords);CHKERRQ(ierr);
5502fa5cd67SKarl Rupp 
55139381ba2SJed Brown   pc_ml->dim  = 0;
55239381ba2SJed Brown   pc_ml->nloc = 0;
553e45a0c82SBarry Smith   ierr = PCReset_MG(pc);CHKERRQ(ierr);
55401da6913SBarry Smith   PetscFunctionReturn(0);
55501da6913SBarry Smith }
5565582bec1SHong Zhang /* -------------------------------------------------------------------------- */
5575582bec1SHong Zhang /*
5585582bec1SHong Zhang    PCSetUp_ML - Prepares for the use of the ML preconditioner
5595582bec1SHong Zhang                     by setting data structures and options.
5605582bec1SHong Zhang 
5615582bec1SHong Zhang    Input Parameter:
5625582bec1SHong Zhang .  pc - the preconditioner context
5635582bec1SHong Zhang 
5645582bec1SHong Zhang    Application Interface Routine: PCSetUp()
5655582bec1SHong Zhang 
5665582bec1SHong Zhang    Notes:
5675582bec1SHong Zhang    The interface routine PCSetUp() is not usually called directly by
5685582bec1SHong Zhang    the user, but instead is called by PCApply() if necessary.
5695582bec1SHong Zhang */
5706ca4d86aSHong Zhang extern PetscErrorCode PCSetFromOptions_MG(PC);
571a06653b4SBarry Smith extern PetscErrorCode PCReset_MG(PC);
572c07bf074SBarry Smith 
5735582bec1SHong Zhang #undef __FUNCT__
5745582bec1SHong Zhang #define __FUNCT__ "PCSetUp_ML"
5756ca4d86aSHong Zhang PetscErrorCode PCSetUp_ML(PC pc)
5765582bec1SHong Zhang {
5775582bec1SHong Zhang   PetscErrorCode   ierr;
578eef31507SHong Zhang   PetscMPIInt      size;
5795582bec1SHong Zhang   FineGridCtx      *PetscMLdata;
5805582bec1SHong Zhang   ML               *ml_object;
5815582bec1SHong Zhang   ML_Aggregate     *agg_object;
5825582bec1SHong Zhang   ML_Operator      *mlmat;
5834f8eab3cSJed Brown   PetscInt         nlocal_allcols,Nlevels,mllevel,level,level1,m,fine_level,bs;
5845582bec1SHong Zhang   Mat              A,Aloc;
5855582bec1SHong Zhang   GridCtx          *gridctx;
58601da6913SBarry Smith   PC_MG            *mg    = (PC_MG*)pc->data;
58701da6913SBarry Smith   PC_ML            *pc_ml = (PC_ML*)mg->innerctx;
588ace3abfcSBarry Smith   PetscBool        isSeq, isMPI;
589c07bf074SBarry Smith   KSP              smoother;
590c07bf074SBarry Smith   PC               subpc;
59148268eb4SJed Brown   PetscInt         mesh_level, old_mesh_level;
5928a62b701SToby Isaac   MatInfo          info;
5931f817a21SBarry Smith   static PetscBool cite = PETSC_FALSE;
59448268eb4SJed Brown 
5955582bec1SHong Zhang   PetscFunctionBegin;
5961f817a21SBarry Smith   ierr = PetscCitationsRegister("@TechReport{ml_users_guide,\n  author = {M. Sala and J.J. Hu and R.S. Tuminaro},\n  title = {{ML}3.1 {S}moothed {A}ggregation {U}ser's {G}uide},\n  institution =  {Sandia National Laboratories},\n  number = {SAND2004-4821},\n  year = 2004\n}\n",&cite);CHKERRQ(ierr);
59748268eb4SJed Brown   A    = pc->pmat;
598ce94432eSBarry Smith   ierr = MPI_Comm_size(PetscObjectComm((PetscObject)A),&size);CHKERRQ(ierr);
59948268eb4SJed Brown 
600573998d7SHong Zhang   if (pc->setupcalled) {
60148268eb4SJed Brown     if (pc->flag == SAME_NONZERO_PATTERN && pc_ml->reuse_interpolation) {
60248268eb4SJed Brown       /*
60348268eb4SJed Brown        Reuse interpolaton instead of recomputing aggregates and updating the whole hierarchy. This is less expensive for
60448268eb4SJed Brown        multiple solves in which the matrix is not changing too quickly.
60548268eb4SJed Brown        */
60648268eb4SJed Brown       ml_object             = pc_ml->ml_object;
60748268eb4SJed Brown       gridctx               = pc_ml->gridctx;
60848268eb4SJed Brown       Nlevels               = pc_ml->Nlevels;
60948268eb4SJed Brown       fine_level            = Nlevels - 1;
61048268eb4SJed Brown       gridctx[fine_level].A = A;
61148268eb4SJed Brown 
612251f4c67SDmitry Karpeev       ierr = PetscObjectTypeCompare((PetscObject) A, MATSEQAIJ, &isSeq);CHKERRQ(ierr);
613251f4c67SDmitry Karpeev       ierr = PetscObjectTypeCompare((PetscObject) A, MATMPIAIJ, &isMPI);CHKERRQ(ierr);
61448268eb4SJed Brown       if (isMPI) {
6150298fd71SBarry Smith         ierr = MatConvert_MPIAIJ_ML(A,NULL,MAT_INITIAL_MATRIX,&Aloc);CHKERRQ(ierr);
61648268eb4SJed Brown       } else if (isSeq) {
61748268eb4SJed Brown         Aloc = A;
618ae7fe62dSJed Brown         ierr = PetscObjectReference((PetscObject)Aloc);CHKERRQ(ierr);
619ce94432eSBarry Smith       } else SETERRQ1(PetscObjectComm((PetscObject)pc),PETSC_ERR_ARG_WRONG, "Matrix type '%s' cannot be used with ML. ML can only handle AIJ matrices.",((PetscObject)A)->type_name);
62048268eb4SJed Brown 
62148268eb4SJed Brown       ierr              = MatGetSize(Aloc,&m,&nlocal_allcols);CHKERRQ(ierr);
62248268eb4SJed Brown       PetscMLdata       = pc_ml->PetscMLdata;
623ae7fe62dSJed Brown       ierr              = MatDestroy(&PetscMLdata->Aloc);CHKERRQ(ierr);
62448268eb4SJed Brown       PetscMLdata->A    = A;
62548268eb4SJed Brown       PetscMLdata->Aloc = Aloc;
626815d23e5SBarry Smith       PetscStackCall("ML_Aggregate_Destroy",ML_Init_Amatrix(ml_object,0,m,m,PetscMLdata));
627815d23e5SBarry Smith       PetscStackCall("ML_Set_Amatrix_Matvec",ML_Set_Amatrix_Matvec(ml_object,0,PetscML_matvec));
62848268eb4SJed Brown 
62948268eb4SJed Brown       mesh_level = ml_object->ML_finest_level;
63048268eb4SJed Brown       while (ml_object->SingleLevel[mesh_level].Rmat->to) {
63148268eb4SJed Brown         old_mesh_level = mesh_level;
63248268eb4SJed Brown         mesh_level     = ml_object->SingleLevel[mesh_level].Rmat->to->levelnum;
63348268eb4SJed Brown 
63448268eb4SJed Brown         /* clean and regenerate A */
63548268eb4SJed Brown         mlmat = &(ml_object->Amat[mesh_level]);
636815d23e5SBarry Smith         PetscStackCall("ML_Operator_Clean",ML_Operator_Clean(mlmat));
637815d23e5SBarry Smith         PetscStackCall("ML_Operator_Init",ML_Operator_Init(mlmat,ml_object->comm));
638815d23e5SBarry Smith         PetscStackCall("ML_Gen_AmatrixRAP",ML_Gen_AmatrixRAP(ml_object, old_mesh_level, mesh_level));
63948268eb4SJed Brown       }
64048268eb4SJed Brown 
64148268eb4SJed Brown       level = fine_level - 1;
64248268eb4SJed Brown       if (size == 1) { /* convert ML P, R and A into seqaij format */
64348268eb4SJed Brown         for (mllevel=1; mllevel<Nlevels; mllevel++) {
64448268eb4SJed Brown           mlmat = &(ml_object->Amat[mllevel]);
645ae7fe62dSJed Brown           ierr = MatWrapML_SeqAIJ(mlmat,MAT_REUSE_MATRIX,&gridctx[level].A);CHKERRQ(ierr);
64648268eb4SJed Brown           level--;
64748268eb4SJed Brown         }
64848268eb4SJed Brown       } else { /* convert ML P and R into shell format, ML A into mpiaij format */
64948268eb4SJed Brown         for (mllevel=1; mllevel<Nlevels; mllevel++) {
65048268eb4SJed Brown           mlmat  = &(ml_object->Amat[mllevel]);
651ae7fe62dSJed Brown           ierr = MatWrapML_MPIAIJ(mlmat,MAT_REUSE_MATRIX,&gridctx[level].A);CHKERRQ(ierr);
65248268eb4SJed Brown           level--;
65348268eb4SJed Brown         }
65448268eb4SJed Brown       }
65548268eb4SJed Brown 
65648268eb4SJed Brown       for (level=0; level<fine_level; level++) {
65748268eb4SJed Brown         if (level > 0) {
65854b2cd4bSJed Brown           ierr = PCMGSetResidual(pc,level,PCMGResidualDefault,gridctx[level].A);CHKERRQ(ierr);
65948268eb4SJed Brown         }
66023ee1639SBarry Smith         ierr = KSPSetOperators(gridctx[level].ksp,gridctx[level].A,gridctx[level].A);CHKERRQ(ierr);
66148268eb4SJed Brown       }
66254b2cd4bSJed Brown       ierr = PCMGSetResidual(pc,fine_level,PCMGResidualDefault,gridctx[fine_level].A);CHKERRQ(ierr);
66323ee1639SBarry Smith       ierr = KSPSetOperators(gridctx[fine_level].ksp,gridctx[level].A,gridctx[fine_level].A);CHKERRQ(ierr);
66448268eb4SJed Brown 
66548268eb4SJed Brown       ierr = PCSetUp_MG(pc);CHKERRQ(ierr);
66648268eb4SJed Brown       PetscFunctionReturn(0);
66748268eb4SJed Brown     } else {
668c07bf074SBarry Smith       /* since ML can change the size of vectors/matrices at any level we must destroy everything */
66916336fedSMatthew G Knepley       ierr = PCReset_ML(pc);CHKERRQ(ierr);
670573998d7SHong Zhang     }
67148268eb4SJed Brown   }
672573998d7SHong Zhang 
6735582bec1SHong Zhang   /* setup special features of PCML */
6745582bec1SHong Zhang   /*--------------------------------*/
6755582bec1SHong Zhang   /* covert A to Aloc to be used by ML at fine grid */
6765582bec1SHong Zhang   pc_ml->size = size;
677251f4c67SDmitry Karpeev   ierr        = PetscObjectTypeCompare((PetscObject) A, MATSEQAIJ, &isSeq);CHKERRQ(ierr);
678251f4c67SDmitry Karpeev   ierr        = PetscObjectTypeCompare((PetscObject) A, MATMPIAIJ, &isMPI);CHKERRQ(ierr);
679864b637dSMatthew Knepley   if (isMPI) {
6800298fd71SBarry Smith     ierr = MatConvert_MPIAIJ_ML(A,NULL,MAT_INITIAL_MATRIX,&Aloc);CHKERRQ(ierr);
681864b637dSMatthew Knepley   } else if (isSeq) {
6825582bec1SHong Zhang     Aloc = A;
683ae7fe62dSJed Brown     ierr = PetscObjectReference((PetscObject)Aloc);CHKERRQ(ierr);
684ce94432eSBarry Smith   } else SETERRQ1(PetscObjectComm((PetscObject)pc),PETSC_ERR_ARG_WRONG, "Matrix type '%s' cannot be used with ML. ML can only handle AIJ matrices.",((PetscObject)A)->type_name);
6855582bec1SHong Zhang 
6865582bec1SHong Zhang   /* create and initialize struct 'PetscMLdata' */
687b00a9115SJed Brown   ierr               = PetscNewLog(pc,&PetscMLdata);CHKERRQ(ierr);
6885582bec1SHong Zhang   pc_ml->PetscMLdata = PetscMLdata;
689785e854fSJed Brown   ierr               = PetscMalloc1((Aloc->cmap->n+1),&PetscMLdata->pwork);CHKERRQ(ierr);
6905582bec1SHong Zhang 
69124a42b14SHong Zhang   ierr = VecCreate(PETSC_COMM_SELF,&PetscMLdata->x);CHKERRQ(ierr);
692d0f46423SBarry Smith   ierr = VecSetSizes(PetscMLdata->x,Aloc->cmap->n,Aloc->cmap->n);CHKERRQ(ierr);
69324a42b14SHong Zhang   ierr = VecSetType(PetscMLdata->x,VECSEQ);CHKERRQ(ierr);
69424a42b14SHong Zhang 
69524a42b14SHong Zhang   ierr              = VecCreate(PETSC_COMM_SELF,&PetscMLdata->y);CHKERRQ(ierr);
696d0f46423SBarry Smith   ierr              = VecSetSizes(PetscMLdata->y,A->rmap->n,PETSC_DECIDE);CHKERRQ(ierr);
69724a42b14SHong Zhang   ierr              = VecSetType(PetscMLdata->y,VECSEQ);CHKERRQ(ierr);
698573998d7SHong Zhang   PetscMLdata->A    = A;
699573998d7SHong Zhang   PetscMLdata->Aloc = Aloc;
70039381ba2SJed Brown   if (pc_ml->dim) { /* create vecs around the coordinate data given */
70139381ba2SJed Brown     PetscInt  i,j,dim=pc_ml->dim;
70239381ba2SJed Brown     PetscInt  nloc = pc_ml->nloc,nlocghost;
70339381ba2SJed Brown     PetscReal *ghostedcoords;
70439381ba2SJed Brown 
70539381ba2SJed Brown     ierr      = MatGetBlockSize(A,&bs);CHKERRQ(ierr);
70639381ba2SJed Brown     nlocghost = Aloc->cmap->n / bs;
707785e854fSJed Brown     ierr      = PetscMalloc1(dim*nlocghost,&ghostedcoords);CHKERRQ(ierr);
70839381ba2SJed Brown     for (i = 0; i < dim; i++) {
70939381ba2SJed Brown       /* copy coordinate values into first component of pwork */
71039381ba2SJed Brown       for (j = 0; j < nloc; j++) {
71139381ba2SJed Brown         PetscMLdata->pwork[bs * j] = pc_ml->coords[nloc * i + j];
71239381ba2SJed Brown       }
71339381ba2SJed Brown       /* get the ghost values */
71439381ba2SJed Brown       ierr = PetscML_comm(PetscMLdata->pwork,PetscMLdata);CHKERRQ(ierr);
71539381ba2SJed Brown       /* write into the vector */
71639381ba2SJed Brown       for (j = 0; j < nlocghost; j++) {
71739381ba2SJed Brown         ghostedcoords[i * nlocghost + j] = PetscMLdata->pwork[bs * j];
71839381ba2SJed Brown       }
71939381ba2SJed Brown     }
72039381ba2SJed Brown     /* replace the original coords with the ghosted coords, because these are
72139381ba2SJed Brown      * what ML needs */
72239381ba2SJed Brown     ierr = PetscFree(pc_ml->coords);CHKERRQ(ierr);
72339381ba2SJed Brown     pc_ml->coords = ghostedcoords;
72439381ba2SJed Brown   }
72524a42b14SHong Zhang 
7265582bec1SHong Zhang   /* create ML discretization matrix at fine grid */
72745cf47abSHong Zhang   /* ML requires input of fine-grid matrix. It determines nlevels. */
7285582bec1SHong Zhang   ierr = MatGetSize(Aloc,&m,&nlocal_allcols);CHKERRQ(ierr);
7294f8eab3cSJed Brown   ierr = MatGetBlockSize(A,&bs);CHKERRQ(ierr);
730815d23e5SBarry Smith   PetscStackCall("ML_Create",ML_Create(&ml_object,pc_ml->MaxNlevels));
731ce94432eSBarry Smith   PetscStackCall("ML_Comm_Set_UsrComm",ML_Comm_Set_UsrComm(ml_object->comm,PetscObjectComm((PetscObject)A)));
732573998d7SHong Zhang   pc_ml->ml_object = ml_object;
733815d23e5SBarry Smith   PetscStackCall("ML_Init_Amatrix",ML_Init_Amatrix(ml_object,0,m,m,PetscMLdata));
734815d23e5SBarry Smith   PetscStackCall("ML_Set_Amatrix_Getrow",ML_Set_Amatrix_Getrow(ml_object,0,PetscML_getrow,PetscML_comm,nlocal_allcols));
735815d23e5SBarry Smith   PetscStackCall("ML_Set_Amatrix_Matvec",ML_Set_Amatrix_Matvec(ml_object,0,PetscML_matvec));
7365582bec1SHong Zhang 
737815d23e5SBarry Smith   PetscStackCall("ML_Set_Symmetrize",ML_Set_Symmetrize(ml_object,pc_ml->Symmetrize ? ML_YES : ML_NO));
738b5c8bdf8SJed Brown 
7395582bec1SHong Zhang   /* aggregation */
740815d23e5SBarry Smith   PetscStackCall("ML_Aggregate_Create",ML_Aggregate_Create(&agg_object));
741573998d7SHong Zhang   pc_ml->agg_object = agg_object;
742573998d7SHong Zhang 
743fb6a8e6dSJed Brown   {
744fb6a8e6dSJed Brown     MatNullSpace mnull;
745fb6a8e6dSJed Brown     ierr = MatGetNearNullSpace(A,&mnull);CHKERRQ(ierr);
746fb6a8e6dSJed Brown     if (pc_ml->nulltype == PCML_NULLSPACE_AUTO) {
747fb6a8e6dSJed Brown       if (mnull) pc_ml->nulltype = PCML_NULLSPACE_USER;
748fb6a8e6dSJed Brown       else if (bs > 1) pc_ml->nulltype = PCML_NULLSPACE_BLOCK;
749fb6a8e6dSJed Brown       else pc_ml->nulltype = PCML_NULLSPACE_SCALAR;
750fb6a8e6dSJed Brown     }
751fb6a8e6dSJed Brown     switch (pc_ml->nulltype) {
752fb6a8e6dSJed Brown     case PCML_NULLSPACE_USER: {
753fb6a8e6dSJed Brown       PetscScalar       *nullvec;
754fb6a8e6dSJed Brown       const PetscScalar *v;
755fb6a8e6dSJed Brown       PetscBool         has_const;
7561c547e14SJed Brown       PetscInt          i,j,mlocal,nvec,M;
757fb6a8e6dSJed Brown       const Vec         *vecs;
7582fa5cd67SKarl Rupp 
759ce94432eSBarry Smith       if (!mnull) SETERRQ(PetscObjectComm((PetscObject)pc),PETSC_ERR_USER,"Must provide explicit null space using MatSetNearNullSpace() to use user-specified null space");
7600298fd71SBarry Smith       ierr = MatGetSize(A,&M,NULL);CHKERRQ(ierr);
7610298fd71SBarry Smith       ierr = MatGetLocalSize(Aloc,&mlocal,NULL);CHKERRQ(ierr);
762fb6a8e6dSJed Brown       ierr = MatNullSpaceGetVecs(mnull,&has_const,&nvec,&vecs);CHKERRQ(ierr);
763785e854fSJed Brown       ierr = PetscMalloc1((nvec+!!has_const)*mlocal,&nullvec);CHKERRQ(ierr);
7641c547e14SJed Brown       if (has_const) for (i=0; i<mlocal; i++) nullvec[i] = 1.0/M;
765fb6a8e6dSJed Brown       for (i=0; i<nvec; i++) {
766fb6a8e6dSJed Brown         ierr = VecGetArrayRead(vecs[i],&v);CHKERRQ(ierr);
767fb6a8e6dSJed Brown         for (j=0; j<mlocal; j++) nullvec[(i+!!has_const)*mlocal + j] = v[j];
768fb6a8e6dSJed Brown         ierr = VecRestoreArrayRead(vecs[i],&v);CHKERRQ(ierr);
769fb6a8e6dSJed Brown       }
770815d23e5SBarry Smith       PetscStackCall("ML_Aggregate_Create",ierr = ML_Aggregate_Set_NullSpace(agg_object,bs,nvec+!!has_const,nullvec,mlocal);CHKERRQ(ierr));
771fb6a8e6dSJed Brown       ierr = PetscFree(nullvec);CHKERRQ(ierr);
772fb6a8e6dSJed Brown     } break;
773fb6a8e6dSJed Brown     case PCML_NULLSPACE_BLOCK:
774815d23e5SBarry Smith       PetscStackCall("ML_Aggregate_Set_NullSpace",ierr = ML_Aggregate_Set_NullSpace(agg_object,bs,bs,0,0);CHKERRQ(ierr));
775fb6a8e6dSJed Brown       break;
776fb6a8e6dSJed Brown     case PCML_NULLSPACE_SCALAR:
777fb6a8e6dSJed Brown       break;
778ce94432eSBarry Smith     default: SETERRQ(PetscObjectComm((PetscObject)pc),PETSC_ERR_SUP,"Unknown null space type");
779fb6a8e6dSJed Brown     }
780fb6a8e6dSJed Brown   }
781815d23e5SBarry Smith   PetscStackCall("ML_Aggregate_Set_MaxCoarseSize",ML_Aggregate_Set_MaxCoarseSize(agg_object,pc_ml->MaxCoarseSize));
7825582bec1SHong Zhang   /* set options */
7835582bec1SHong Zhang   switch (pc_ml->CoarsenScheme) {
7845582bec1SHong Zhang   case 1:
785815d23e5SBarry Smith     PetscStackCall("ML_Aggregate_Set_CoarsenScheme_Coupled",ML_Aggregate_Set_CoarsenScheme_Coupled(agg_object));break;
7865582bec1SHong Zhang   case 2:
787815d23e5SBarry Smith     PetscStackCall("ML_Aggregate_Set_CoarsenScheme_MIS",ML_Aggregate_Set_CoarsenScheme_MIS(agg_object));break;
7885582bec1SHong Zhang   case 3:
789815d23e5SBarry Smith     PetscStackCall("ML_Aggregate_Set_CoarsenScheme_METIS",ML_Aggregate_Set_CoarsenScheme_METIS(agg_object));break;
7905582bec1SHong Zhang   }
791815d23e5SBarry Smith   PetscStackCall("ML_Aggregate_Set_Threshold",ML_Aggregate_Set_Threshold(agg_object,pc_ml->Threshold));
792815d23e5SBarry Smith   PetscStackCall("ML_Aggregate_Set_DampingFactor",ML_Aggregate_Set_DampingFactor(agg_object,pc_ml->DampingFactor));
7935582bec1SHong Zhang   if (pc_ml->SpectralNormScheme_Anorm) {
794815d23e5SBarry Smith     PetscStackCall("ML_Set_SpectralNormScheme_Anorm",ML_Set_SpectralNormScheme_Anorm(ml_object));
7955582bec1SHong Zhang   }
796b5c8bdf8SJed Brown   agg_object->keep_agg_information      = (int)pc_ml->KeepAggInfo;
797b5c8bdf8SJed Brown   agg_object->keep_P_tentative          = (int)pc_ml->Reusable;
798b5c8bdf8SJed Brown   agg_object->block_scaled_SA           = (int)pc_ml->BlockScaling;
799b5c8bdf8SJed Brown   agg_object->minimizing_energy         = (int)pc_ml->EnergyMinimization;
800b5c8bdf8SJed Brown   agg_object->minimizing_energy_droptol = (double)pc_ml->EnergyMinimizationDropTol;
801b5c8bdf8SJed Brown   agg_object->cheap_minimizing_energy   = (int)pc_ml->EnergyMinimizationCheap;
8025582bec1SHong Zhang 
80339381ba2SJed Brown   if (pc_ml->Aux) {
804ce94432eSBarry Smith     if (!pc_ml->dim) SETERRQ(PetscObjectComm((PetscObject)pc),PETSC_ERR_USER,"Auxiliary matrix requires coordinates");
80539381ba2SJed Brown     ml_object->Amat[0].aux_data->threshold = pc_ml->AuxThreshold;
80639381ba2SJed Brown     ml_object->Amat[0].aux_data->enable    = 1;
80739381ba2SJed Brown     ml_object->Amat[0].aux_data->max_level = 10;
80839381ba2SJed Brown     ml_object->Amat[0].num_PDEs            = bs;
80939381ba2SJed Brown   }
81039381ba2SJed Brown 
8118a62b701SToby Isaac   ierr = MatGetInfo(A,MAT_LOCAL,&info);CHKERRQ(ierr);
8128a62b701SToby Isaac   ml_object->Amat[0].N_nonzeros = (int) info.nz_used;
8138a62b701SToby Isaac 
81439381ba2SJed Brown   if (pc_ml->dim) {
81539381ba2SJed Brown     PetscInt               i,dim = pc_ml->dim;
81639381ba2SJed Brown     ML_Aggregate_Viz_Stats *grid_info;
81739381ba2SJed Brown     PetscInt               nlocghost;
81839381ba2SJed Brown 
81939381ba2SJed Brown     ierr      = MatGetBlockSize(A,&bs);CHKERRQ(ierr);
82039381ba2SJed Brown     nlocghost = Aloc->cmap->n / bs;
82139381ba2SJed Brown 
822815d23e5SBarry Smith     PetscStackCall("ML_Aggregate_VizAndStats_Setup(",ML_Aggregate_VizAndStats_Setup(ml_object)); /* create ml info for coords */
82339381ba2SJed Brown     grid_info = (ML_Aggregate_Viz_Stats*) ml_object->Grid[0].Grid;
82439381ba2SJed Brown     for (i = 0; i < dim; i++) {
82539381ba2SJed Brown       /* set the finest level coordinates to point to the column-order array
82639381ba2SJed Brown        * in pc_ml */
82739381ba2SJed Brown       /* NOTE: must point away before VizAndStats_Clean so ML doesn't free */
82839381ba2SJed Brown       switch (i) {
82939381ba2SJed Brown       case 0: grid_info->x = pc_ml->coords + nlocghost * i; break;
83039381ba2SJed Brown       case 1: grid_info->y = pc_ml->coords + nlocghost * i; break;
83139381ba2SJed Brown       case 2: grid_info->z = pc_ml->coords + nlocghost * i; break;
832ce94432eSBarry Smith       default: SETERRQ(PetscObjectComm((PetscObject)pc),PETSC_ERR_ARG_SIZ,"PCML coordinate dimension must be <= 3");
83339381ba2SJed Brown       }
83439381ba2SJed Brown     }
83539381ba2SJed Brown     grid_info->Ndim = dim;
83639381ba2SJed Brown   }
83739381ba2SJed Brown 
83839381ba2SJed Brown   /* repartitioning */
83939381ba2SJed Brown   if (pc_ml->Repartition) {
840815d23e5SBarry Smith     PetscStackCall("ML_Repartition_Activate",ML_Repartition_Activate(ml_object));
841815d23e5SBarry Smith     PetscStackCall("ML_Repartition_Set_LargestMinMaxRatio",ML_Repartition_Set_LargestMinMaxRatio(ml_object,pc_ml->MaxMinRatio));
842815d23e5SBarry Smith     PetscStackCall("ML_Repartition_Set_MinPerProc",ML_Repartition_Set_MinPerProc(ml_object,pc_ml->MinPerProc));
843815d23e5SBarry Smith     PetscStackCall("ML_Repartition_Set_PutOnSingleProc",ML_Repartition_Set_PutOnSingleProc(ml_object,pc_ml->PutOnSingleProc));
84439381ba2SJed Brown #if 0                           /* Function not yet defined in ml-6.2 */
84539381ba2SJed Brown     /* I'm not sure what compatibility issues might crop up if we partitioned
84639381ba2SJed Brown      * on the finest level, so to be safe repartition starts on the next
84739381ba2SJed Brown      * finest level (reflection default behavior in
84839381ba2SJed Brown      * ml_MultiLevelPreconditioner) */
849815d23e5SBarry Smith     PetscStackCall("ML_Repartition_Set_StartLevel",ML_Repartition_Set_StartLevel(ml_object,1));
85039381ba2SJed Brown #endif
85139381ba2SJed Brown 
85239381ba2SJed Brown     if (!pc_ml->RepartitionType) {
85339381ba2SJed Brown       PetscInt i;
85439381ba2SJed Brown 
855ce94432eSBarry Smith       if (!pc_ml->dim) SETERRQ(PetscObjectComm((PetscObject)pc),PETSC_ERR_USER,"ML Zoltan repartitioning requires coordinates");
856815d23e5SBarry Smith       PetscStackCall("ML_Repartition_Set_Partitioner",ML_Repartition_Set_Partitioner(ml_object,ML_USEZOLTAN));
857815d23e5SBarry Smith       PetscStackCall("ML_Aggregate_Set_Dimensions",ML_Aggregate_Set_Dimensions(agg_object, pc_ml->dim));
85839381ba2SJed Brown 
85939381ba2SJed Brown       for (i = 0; i < ml_object->ML_num_levels; i++) {
86039381ba2SJed Brown         ML_Aggregate_Viz_Stats *grid_info = (ML_Aggregate_Viz_Stats*)ml_object->Grid[i].Grid;
86139381ba2SJed Brown         grid_info->zoltan_type = pc_ml->ZoltanScheme + 1; /* ml numbers options 1, 2, 3 */
86239381ba2SJed Brown         /* defaults from ml_agg_info.c */
86339381ba2SJed Brown         grid_info->zoltan_estimated_its = 40; /* only relevant to hypergraph / fast hypergraph */
86439381ba2SJed Brown         grid_info->zoltan_timers        = 0;
86539381ba2SJed Brown         grid_info->smoothing_steps      = 4;  /* only relevant to hypergraph / fast hypergraph */
86639381ba2SJed Brown       }
8672fa5cd67SKarl Rupp     } else {
868815d23e5SBarry Smith       PetscStackCall("ML_Repartition_Set_Partitioner",ML_Repartition_Set_Partitioner(ml_object,ML_USEPARMETIS));
86939381ba2SJed Brown     }
87039381ba2SJed Brown   }
87139381ba2SJed Brown 
872b5c8bdf8SJed Brown   if (pc_ml->OldHierarchy) {
873815d23e5SBarry Smith     PetscStackCall("ML_Gen_MGHierarchy_UsingAggregation",Nlevels = ML_Gen_MGHierarchy_UsingAggregation(ml_object,0,ML_INCREASING,agg_object));
874b5c8bdf8SJed Brown   } else {
875815d23e5SBarry Smith     PetscStackCall("ML_Gen_MultiLevelHierarchy_UsingAggregation",Nlevels = ML_Gen_MultiLevelHierarchy_UsingAggregation(ml_object,0,ML_INCREASING,agg_object));
876b5c8bdf8SJed Brown   }
877ce94432eSBarry Smith   if (Nlevels<=0) SETERRQ1(PetscObjectComm((PetscObject)pc),PETSC_ERR_ARG_OUTOFRANGE,"Nlevels %d must > 0",Nlevels);
878573998d7SHong Zhang   pc_ml->Nlevels = Nlevels;
879aa85bbbfSHong Zhang   fine_level     = Nlevels - 1;
880c07bf074SBarry Smith 
8810298fd71SBarry Smith   ierr = PCMGSetLevels(pc,Nlevels,NULL);CHKERRQ(ierr);
882aa85bbbfSHong Zhang   /* set default smoothers */
883aa85bbbfSHong Zhang   for (level=1; level<=fine_level; level++) {
884aa85bbbfSHong Zhang     ierr = PCMGGetSmoother(pc,level,&smoother);CHKERRQ(ierr);
885aa85bbbfSHong Zhang     ierr = KSPSetType(smoother,KSPRICHARDSON);CHKERRQ(ierr);
886aa85bbbfSHong Zhang     ierr = KSPGetPC(smoother,&subpc);CHKERRQ(ierr);
887aa85bbbfSHong Zhang     ierr = PCSetType(subpc,PCSOR);CHKERRQ(ierr);
888aa85bbbfSHong Zhang   }
889f2e59741SMatthew G Knepley   ierr = PetscObjectOptionsBegin((PetscObject)pc);CHKERRQ(ierr);
89097177400SBarry Smith   ierr = PCSetFromOptions_MG(pc);CHKERRQ(ierr); /* should be called in PCSetFromOptions_ML(), but cannot be called prior to PCMGSetLevels() */
891f2e59741SMatthew G Knepley   ierr = PetscOptionsEnd();CHKERRQ(ierr);
8925582bec1SHong Zhang 
893785e854fSJed Brown   ierr = PetscMalloc1(Nlevels,&gridctx);CHKERRQ(ierr);
8942fa5cd67SKarl Rupp 
8955582bec1SHong Zhang   pc_ml->gridctx = gridctx;
8965582bec1SHong Zhang 
8975582bec1SHong Zhang   /* wrap ML matrices by PETSc shell matrices at coarsened grids.
8985582bec1SHong Zhang      Level 0 is the finest grid for ML, but coarsest for PETSc! */
899e14861a4SHong Zhang   gridctx[fine_level].A = A;
900573998d7SHong Zhang 
901e14861a4SHong Zhang   level = fine_level - 1;
902ab718edeSHong Zhang   if (size == 1) { /* convert ML P, R and A into seqaij format */
9035582bec1SHong Zhang     for (mllevel=1; mllevel<Nlevels; mllevel++) {
904e14861a4SHong Zhang       mlmat = &(ml_object->Pmat[mllevel]);
905db571536SBarry Smith       ierr  = MatWrapML_SeqAIJ(mlmat,MAT_INITIAL_MATRIX,&gridctx[level].P);CHKERRQ(ierr);
906e14861a4SHong Zhang       mlmat = &(ml_object->Rmat[mllevel-1]);
907db571536SBarry Smith       ierr  = MatWrapML_SeqAIJ(mlmat,MAT_INITIAL_MATRIX,&gridctx[level].R);CHKERRQ(ierr);
908573998d7SHong Zhang 
909573998d7SHong Zhang       mlmat = &(ml_object->Amat[mllevel]);
910573998d7SHong Zhang       ierr  = MatWrapML_SeqAIJ(mlmat,MAT_INITIAL_MATRIX,&gridctx[level].A);CHKERRQ(ierr);
9115582bec1SHong Zhang       level--;
9125582bec1SHong Zhang     }
913ab718edeSHong Zhang   } else { /* convert ML P and R into shell format, ML A into mpiaij format */
9145582bec1SHong Zhang     for (mllevel=1; mllevel<Nlevels; mllevel++) {
9155582bec1SHong Zhang       mlmat  = &(ml_object->Pmat[mllevel]);
916db571536SBarry Smith       ierr = MatWrapML_SHELL(mlmat,MAT_INITIAL_MATRIX,&gridctx[level].P);CHKERRQ(ierr);
917ab718edeSHong Zhang       mlmat  = &(ml_object->Rmat[mllevel-1]);
918db571536SBarry Smith       ierr = MatWrapML_SHELL(mlmat,MAT_INITIAL_MATRIX,&gridctx[level].R);CHKERRQ(ierr);
919573998d7SHong Zhang 
9205582bec1SHong Zhang       mlmat  = &(ml_object->Amat[mllevel]);
921ae7fe62dSJed Brown       ierr = MatWrapML_MPIAIJ(mlmat,MAT_INITIAL_MATRIX,&gridctx[level].A);CHKERRQ(ierr);
9225582bec1SHong Zhang       level--;
9235582bec1SHong Zhang     }
9245582bec1SHong Zhang   }
9255582bec1SHong Zhang 
926573998d7SHong Zhang   /* create vectors and ksp at all levels */
927ac346b81SHong Zhang   for (level=0; level<fine_level; level++) {
928573998d7SHong Zhang     level1 = level + 1;
929e64afeacSLisandro Dalcin     ierr   = VecCreate(((PetscObject)gridctx[level].A)->comm,&gridctx[level].x);CHKERRQ(ierr);
930d0f46423SBarry Smith     ierr   = VecSetSizes(gridctx[level].x,gridctx[level].A->cmap->n,PETSC_DECIDE);CHKERRQ(ierr);
9315582bec1SHong Zhang     ierr   = VecSetType(gridctx[level].x,VECMPI);CHKERRQ(ierr);
93297177400SBarry Smith     ierr   = PCMGSetX(pc,level,gridctx[level].x);CHKERRQ(ierr);
9335582bec1SHong Zhang 
934e64afeacSLisandro Dalcin     ierr = VecCreate(((PetscObject)gridctx[level].A)->comm,&gridctx[level].b);CHKERRQ(ierr);
935d0f46423SBarry Smith     ierr = VecSetSizes(gridctx[level].b,gridctx[level].A->rmap->n,PETSC_DECIDE);CHKERRQ(ierr);
9365582bec1SHong Zhang     ierr = VecSetType(gridctx[level].b,VECMPI);CHKERRQ(ierr);
93797177400SBarry Smith     ierr = PCMGSetRhs(pc,level,gridctx[level].b);CHKERRQ(ierr);
938ac346b81SHong Zhang 
939e64afeacSLisandro Dalcin     ierr = VecCreate(((PetscObject)gridctx[level1].A)->comm,&gridctx[level1].r);CHKERRQ(ierr);
940d0f46423SBarry Smith     ierr = VecSetSizes(gridctx[level1].r,gridctx[level1].A->rmap->n,PETSC_DECIDE);CHKERRQ(ierr);
941ac346b81SHong Zhang     ierr = VecSetType(gridctx[level1].r,VECMPI);CHKERRQ(ierr);
94297177400SBarry Smith     ierr = PCMGSetR(pc,level1,gridctx[level1].r);CHKERRQ(ierr);
943ac346b81SHong Zhang 
9445582bec1SHong Zhang     if (level == 0) {
94597177400SBarry Smith       ierr = PCMGGetCoarseSolve(pc,&gridctx[level].ksp);CHKERRQ(ierr);
9465582bec1SHong Zhang     } else {
94797177400SBarry Smith       ierr = PCMGGetSmoother(pc,level,&gridctx[level].ksp);CHKERRQ(ierr);
948573998d7SHong Zhang     }
949573998d7SHong Zhang   }
950573998d7SHong Zhang   ierr = PCMGGetSmoother(pc,fine_level,&gridctx[fine_level].ksp);CHKERRQ(ierr);
951573998d7SHong Zhang 
952573998d7SHong Zhang   /* create coarse level and the interpolation between the levels */
953573998d7SHong Zhang   for (level=0; level<fine_level; level++) {
954573998d7SHong Zhang     level1 = level + 1;
955aea2a34eSBarry Smith     ierr   = PCMGSetInterpolation(pc,level1,gridctx[level].P);CHKERRQ(ierr);
956573998d7SHong Zhang     ierr   = PCMGSetRestriction(pc,level1,gridctx[level].R);CHKERRQ(ierr);
957573998d7SHong Zhang     if (level > 0) {
95854b2cd4bSJed Brown       ierr = PCMGSetResidual(pc,level,PCMGResidualDefault,gridctx[level].A);CHKERRQ(ierr);
9595582bec1SHong Zhang     }
96023ee1639SBarry Smith     ierr = KSPSetOperators(gridctx[level].ksp,gridctx[level].A,gridctx[level].A);CHKERRQ(ierr);
9615582bec1SHong Zhang   }
96254b2cd4bSJed Brown   ierr = PCMGSetResidual(pc,fine_level,PCMGResidualDefault,gridctx[fine_level].A);CHKERRQ(ierr);
96323ee1639SBarry Smith   ierr = KSPSetOperators(gridctx[fine_level].ksp,gridctx[level].A,gridctx[fine_level].A);CHKERRQ(ierr);
9645582bec1SHong Zhang 
96539381ba2SJed Brown   /* put coordinate info in levels */
96639381ba2SJed Brown   if (pc_ml->dim) {
96739381ba2SJed Brown     PetscInt  i,j,dim = pc_ml->dim;
96839381ba2SJed Brown     PetscInt  bs, nloc;
96939381ba2SJed Brown     PC        subpc;
97039381ba2SJed Brown     PetscReal *array;
97139381ba2SJed Brown 
97239381ba2SJed Brown     level = fine_level;
97339381ba2SJed Brown     for (mllevel = 0; mllevel < Nlevels; mllevel++) {
974ebbbbe33SJed Brown       ML_Aggregate_Viz_Stats *grid_info = (ML_Aggregate_Viz_Stats*)ml_object->Amat[mllevel].to->Grid->Grid;
97539381ba2SJed Brown       MPI_Comm               comm       = ((PetscObject)gridctx[level].A)->comm;
97639381ba2SJed Brown 
97739381ba2SJed Brown       ierr  = MatGetBlockSize (gridctx[level].A, &bs);CHKERRQ(ierr);
9780298fd71SBarry Smith       ierr  = MatGetLocalSize (gridctx[level].A, NULL, &nloc);CHKERRQ(ierr);
97939381ba2SJed Brown       nloc /= bs; /* number of local nodes */
98039381ba2SJed Brown 
98139381ba2SJed Brown       ierr = VecCreate(comm,&gridctx[level].coords);CHKERRQ(ierr);
98239381ba2SJed Brown       ierr = VecSetSizes(gridctx[level].coords,dim * nloc,PETSC_DECIDE);CHKERRQ(ierr);
98339381ba2SJed Brown       ierr = VecSetType(gridctx[level].coords,VECMPI);CHKERRQ(ierr);
98439381ba2SJed Brown       ierr = VecGetArray(gridctx[level].coords,&array);CHKERRQ(ierr);
98539381ba2SJed Brown       for (j = 0; j < nloc; j++) {
98639381ba2SJed Brown         for (i = 0; i < dim; i++) {
98739381ba2SJed Brown           switch (i) {
98839381ba2SJed Brown           case 0: array[dim * j + i] = grid_info->x[j]; break;
98939381ba2SJed Brown           case 1: array[dim * j + i] = grid_info->y[j]; break;
99039381ba2SJed Brown           case 2: array[dim * j + i] = grid_info->z[j]; break;
991ce94432eSBarry Smith           default: SETERRQ(PetscObjectComm((PetscObject)pc),PETSC_ERR_ARG_SIZ,"PCML coordinate dimension must be <= 3");
99239381ba2SJed Brown           }
99339381ba2SJed Brown         }
99439381ba2SJed Brown       }
99539381ba2SJed Brown 
99639381ba2SJed Brown       /* passing coordinates to smoothers/coarse solver, should they need them */
99739381ba2SJed Brown       ierr = KSPGetPC(gridctx[level].ksp,&subpc);CHKERRQ(ierr);
99839381ba2SJed Brown       ierr = PCSetCoordinates(subpc,dim,nloc,array);CHKERRQ(ierr);
99939381ba2SJed Brown       ierr = VecRestoreArray(gridctx[level].coords,&array);CHKERRQ(ierr);
100039381ba2SJed Brown       level--;
100139381ba2SJed Brown     }
100239381ba2SJed Brown   }
100339381ba2SJed Brown 
1004c07bf074SBarry Smith   /* setupcalled is set to 0 so that MG is setup from scratch */
1005c07bf074SBarry Smith   pc->setupcalled = 0;
10063751b4bdSBarry Smith   ierr            = PCSetUp_MG(pc);CHKERRQ(ierr);
10075582bec1SHong Zhang   PetscFunctionReturn(0);
10085582bec1SHong Zhang }
10095582bec1SHong Zhang 
10105582bec1SHong Zhang /* -------------------------------------------------------------------------- */
10115582bec1SHong Zhang /*
10125582bec1SHong Zhang    PCDestroy_ML - Destroys the private context for the ML preconditioner
10135582bec1SHong Zhang    that was created with PCCreate_ML().
10145582bec1SHong Zhang 
10155582bec1SHong Zhang    Input Parameter:
10165582bec1SHong Zhang .  pc - the preconditioner context
10175582bec1SHong Zhang 
10185582bec1SHong Zhang    Application Interface Routine: PCDestroy()
10195582bec1SHong Zhang */
10205582bec1SHong Zhang #undef __FUNCT__
10215582bec1SHong Zhang #define __FUNCT__ "PCDestroy_ML"
10226ca4d86aSHong Zhang PetscErrorCode PCDestroy_ML(PC pc)
10235582bec1SHong Zhang {
10245582bec1SHong Zhang   PetscErrorCode ierr;
102501da6913SBarry Smith   PC_MG          *mg   = (PC_MG*)pc->data;
102601da6913SBarry Smith   PC_ML          *pc_ml= (PC_ML*)mg->innerctx;
10275582bec1SHong Zhang 
10285582bec1SHong Zhang   PetscFunctionBegin;
102916336fedSMatthew G Knepley   ierr = PCReset_ML(pc);CHKERRQ(ierr);
103001da6913SBarry Smith   ierr = PetscFree(pc_ml);CHKERRQ(ierr);
103101da6913SBarry Smith   ierr = PCDestroy_MG(pc);CHKERRQ(ierr);
1032bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCSetCoordinates_C",NULL);CHKERRQ(ierr);
10335582bec1SHong Zhang   PetscFunctionReturn(0);
10345582bec1SHong Zhang }
10355582bec1SHong Zhang 
10365582bec1SHong Zhang #undef __FUNCT__
10375582bec1SHong Zhang #define __FUNCT__ "PCSetFromOptions_ML"
10386ca4d86aSHong Zhang PetscErrorCode PCSetFromOptions_ML(PC pc)
10395582bec1SHong Zhang {
10405582bec1SHong Zhang   PetscErrorCode ierr;
104139381ba2SJed Brown   PetscInt       indx,PrintLevel,partindx;
10425582bec1SHong Zhang   const char     *scheme[] = {"Uncoupled","Coupled","MIS","METIS"};
104339381ba2SJed Brown   const char     *part[]   = {"Zoltan","ParMETIS"};
104439381ba2SJed Brown #if defined(HAVE_ML_ZOLTAN)
104539381ba2SJed Brown   PetscInt   zidx;
104639381ba2SJed Brown   const char *zscheme[] = {"RCB","hypergraph","fast_hypergraph"};
104739381ba2SJed Brown #endif
104801da6913SBarry Smith   PC_MG       *mg    = (PC_MG*)pc->data;
104901da6913SBarry Smith   PC_ML       *pc_ml = (PC_ML*)mg->innerctx;
1050b5c8bdf8SJed Brown   PetscMPIInt size;
1051ce94432eSBarry Smith   MPI_Comm    comm;
10525582bec1SHong Zhang 
10535582bec1SHong Zhang   PetscFunctionBegin;
1054ce94432eSBarry Smith   ierr = PetscObjectGetComm((PetscObject)pc,&comm);CHKERRQ(ierr);
105588ff4cc7SJed Brown   ierr = MPI_Comm_size(comm,&size);CHKERRQ(ierr);
10565582bec1SHong Zhang   ierr = PetscOptionsHead("ML options");CHKERRQ(ierr);
10572fa5cd67SKarl Rupp 
10585582bec1SHong Zhang   PrintLevel = 0;
10595582bec1SHong Zhang   indx       = 0;
106039381ba2SJed Brown   partindx   = 0;
10612fa5cd67SKarl Rupp 
10620298fd71SBarry Smith   ierr = PetscOptionsInt("-pc_ml_PrintLevel","Print level","ML_Set_PrintLevel",PrintLevel,&PrintLevel,NULL);CHKERRQ(ierr);
1063815d23e5SBarry Smith   PetscStackCall("ML_Set_PrintLeve",ML_Set_PrintLevel(PrintLevel));
10640298fd71SBarry Smith   ierr = PetscOptionsInt("-pc_ml_maxNlevels","Maximum number of levels","None",pc_ml->MaxNlevels,&pc_ml->MaxNlevels,NULL);CHKERRQ(ierr);
10650298fd71SBarry Smith   ierr = PetscOptionsInt("-pc_ml_maxCoarseSize","Maximum coarsest mesh size","ML_Aggregate_Set_MaxCoarseSize",pc_ml->MaxCoarseSize,&pc_ml->MaxCoarseSize,NULL);CHKERRQ(ierr);
10660298fd71SBarry Smith   ierr = PetscOptionsEList("-pc_ml_CoarsenScheme","Aggregate Coarsen Scheme","ML_Aggregate_Set_CoarsenScheme_*",scheme,4,scheme[0],&indx,NULL);CHKERRQ(ierr);
10672fa5cd67SKarl Rupp 
10685582bec1SHong Zhang   pc_ml->CoarsenScheme = indx;
10692fa5cd67SKarl Rupp 
10700298fd71SBarry Smith   ierr = PetscOptionsReal("-pc_ml_DampingFactor","P damping factor","ML_Aggregate_Set_DampingFactor",pc_ml->DampingFactor,&pc_ml->DampingFactor,NULL);CHKERRQ(ierr);
10710298fd71SBarry Smith   ierr = PetscOptionsReal("-pc_ml_Threshold","Smoother drop tol","ML_Aggregate_Set_Threshold",pc_ml->Threshold,&pc_ml->Threshold,NULL);CHKERRQ(ierr);
10720298fd71SBarry Smith   ierr = PetscOptionsBool("-pc_ml_SpectralNormScheme_Anorm","Method used for estimating spectral radius","ML_Set_SpectralNormScheme_Anorm",pc_ml->SpectralNormScheme_Anorm,&pc_ml->SpectralNormScheme_Anorm,NULL);CHKERRQ(ierr);
10730298fd71SBarry Smith   ierr = PetscOptionsBool("-pc_ml_Symmetrize","Symmetrize aggregation","ML_Set_Symmetrize",pc_ml->Symmetrize,&pc_ml->Symmetrize,NULL);CHKERRQ(ierr);
10740298fd71SBarry Smith   ierr = PetscOptionsBool("-pc_ml_BlockScaling","Scale all dofs at each node together","None",pc_ml->BlockScaling,&pc_ml->BlockScaling,NULL);CHKERRQ(ierr);
10750298fd71SBarry Smith   ierr = PetscOptionsEnum("-pc_ml_nullspace","Which type of null space information to use","None",PCMLNullSpaceTypes,(PetscEnum)pc_ml->nulltype,(PetscEnum*)&pc_ml->nulltype,NULL);CHKERRQ(ierr);
10760298fd71SBarry Smith   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,NULL);CHKERRQ(ierr);
10770298fd71SBarry Smith   ierr = PetscOptionsBool("-pc_ml_reuse_interpolation","Reuse the interpolation operators when possible (cheaper, weaker when matrix entries change a lot)","None",pc_ml->reuse_interpolation,&pc_ml->reuse_interpolation,NULL);CHKERRQ(ierr);
1078b5c8bdf8SJed Brown   /*
1079b5c8bdf8SJed Brown     The following checks a number of conditions.  If we let this stuff slip by, then ML's error handling will take over.
1080b5c8bdf8SJed Brown     This is suboptimal because it amounts to calling exit(1) so we check for the most common conditions.
1081b5c8bdf8SJed Brown 
1082b5c8bdf8SJed Brown     We also try to set some sane defaults when energy minimization is activated, otherwise it's hard to find a working
1083b5c8bdf8SJed Brown     combination of options and ML's exit(1) explanations don't help matters.
1084b5c8bdf8SJed Brown   */
108588ff4cc7SJed Brown   if (pc_ml->EnergyMinimization < -1 || pc_ml->EnergyMinimization > 4) SETERRQ(comm,PETSC_ERR_ARG_OUTOFRANGE,"EnergyMinimization must be in range -1..4");
108688ff4cc7SJed Brown   if (pc_ml->EnergyMinimization == 4 && size > 1) SETERRQ(comm,PETSC_ERR_SUP,"Energy minimization type 4 does not work in parallel");
1087b5c8bdf8SJed Brown   if (pc_ml->EnergyMinimization == 4) {ierr = PetscInfo(pc,"Mandel's energy minimization scheme is experimental and broken in ML-6.2");CHKERRQ(ierr);}
1088b5c8bdf8SJed Brown   if (pc_ml->EnergyMinimization) {
10890298fd71SBarry Smith     ierr = PetscOptionsReal("-pc_ml_EnergyMinimizationDropTol","Energy minimization drop tolerance","None",pc_ml->EnergyMinimizationDropTol,&pc_ml->EnergyMinimizationDropTol,NULL);CHKERRQ(ierr);
1090b5c8bdf8SJed Brown   }
1091b5c8bdf8SJed Brown   if (pc_ml->EnergyMinimization == 2) {
1092b5c8bdf8SJed Brown     /* According to ml_MultiLevelPreconditioner.cpp, this option is only meaningful for norm type (2) */
10930298fd71SBarry Smith     ierr = PetscOptionsBool("-pc_ml_EnergyMinimizationCheap","Use cheaper variant of norm type 2","None",pc_ml->EnergyMinimizationCheap,&pc_ml->EnergyMinimizationCheap,NULL);CHKERRQ(ierr);
1094b5c8bdf8SJed Brown   }
1095b5c8bdf8SJed Brown   /* energy minimization sometimes breaks if this is turned off, the more classical stuff should be okay without it */
1096b5c8bdf8SJed Brown   if (pc_ml->EnergyMinimization) pc_ml->KeepAggInfo = PETSC_TRUE;
10970298fd71SBarry Smith   ierr = PetscOptionsBool("-pc_ml_KeepAggInfo","Allows the preconditioner to be reused, or auxilliary matrices to be generated","None",pc_ml->KeepAggInfo,&pc_ml->KeepAggInfo,NULL);CHKERRQ(ierr);
1098b5c8bdf8SJed Brown   /* Option (-1) doesn't work at all (calls exit(1)) if the tentative restriction operator isn't stored. */
1099b5c8bdf8SJed Brown   if (pc_ml->EnergyMinimization == -1) pc_ml->Reusable = PETSC_TRUE;
11000298fd71SBarry Smith   ierr = PetscOptionsBool("-pc_ml_Reusable","Store intermedaiate data structures so that the multilevel hierarchy is reusable","None",pc_ml->Reusable,&pc_ml->Reusable,NULL);CHKERRQ(ierr);
1101b5c8bdf8SJed Brown   /*
1102b5c8bdf8SJed Brown     ML's C API is severely underdocumented and lacks significant functionality.  The C++ API calls
1103b5c8bdf8SJed Brown     ML_Gen_MultiLevelHierarchy_UsingAggregation() which is a modified copy (!?) of the documented function
1104b5c8bdf8SJed Brown     ML_Gen_MGHierarchy_UsingAggregation().  This modification, however, does not provide a strict superset of the
1105b5c8bdf8SJed Brown     functionality in the old function, so some users may still want to use it.  Note that many options are ignored in
1106b5c8bdf8SJed Brown     this context, but ML doesn't provide a way to find out which ones.
1107b5c8bdf8SJed Brown    */
11080298fd71SBarry Smith   ierr = PetscOptionsBool("-pc_ml_OldHierarchy","Use old routine to generate hierarchy","None",pc_ml->OldHierarchy,&pc_ml->OldHierarchy,NULL);CHKERRQ(ierr);
11090298fd71SBarry Smith   ierr = PetscOptionsBool("-pc_ml_repartition", "Allow ML to repartition levels of the heirarchy","ML_Repartition_Activate",pc_ml->Repartition,&pc_ml->Repartition,NULL);CHKERRQ(ierr);
111039381ba2SJed Brown   if (pc_ml->Repartition) {
11110298fd71SBarry Smith     ierr = PetscOptionsReal("-pc_ml_repartitionMaxMinRatio", "Acceptable ratio of repartitioned sizes","ML_Repartition_Set_LargestMinMaxRatio",pc_ml->MaxMinRatio,&pc_ml->MaxMinRatio,NULL);CHKERRQ(ierr);
11120298fd71SBarry Smith     ierr = PetscOptionsInt("-pc_ml_repartitionMinPerProc", "Smallest repartitioned size","ML_Repartition_Set_MinPerProc",pc_ml->MinPerProc,&pc_ml->MinPerProc,NULL);CHKERRQ(ierr);
11130298fd71SBarry Smith     ierr = PetscOptionsInt("-pc_ml_repartitionPutOnSingleProc", "Problem size automatically repartitioned to one processor","ML_Repartition_Set_PutOnSingleProc",pc_ml->PutOnSingleProc,&pc_ml->PutOnSingleProc,NULL);CHKERRQ(ierr);
111439381ba2SJed Brown #if defined(HAVE_ML_ZOLTAN)
111539381ba2SJed Brown     partindx = 0;
11160298fd71SBarry Smith     ierr     = PetscOptionsEList("-pc_ml_repartitionType", "Repartitioning library to use","ML_Repartition_Set_Partitioner",part,2,part[0],&partindx,NULL);CHKERRQ(ierr);
11172fa5cd67SKarl Rupp 
111839381ba2SJed Brown     pc_ml->RepartitionType = partindx;
111939381ba2SJed Brown     if (!partindx) {
11205572b5bbSJed Brown       PetscInt zindx = 0;
11212fa5cd67SKarl Rupp 
11220298fd71SBarry Smith       ierr = PetscOptionsEList("-pc_ml_repartitionZoltanScheme", "Repartitioning scheme to use","None",zscheme,3,zscheme[0],&zindx,NULL);CHKERRQ(ierr);
11232fa5cd67SKarl Rupp 
112439381ba2SJed Brown       pc_ml->ZoltanScheme = zindx;
112539381ba2SJed Brown     }
112639381ba2SJed Brown #else
112739381ba2SJed Brown     partindx = 1;
11280298fd71SBarry Smith     ierr     = PetscOptionsEList("-pc_ml_repartitionType", "Repartitioning library to use","ML_Repartition_Set_Partitioner",part,2,part[1],&partindx,NULL);CHKERRQ(ierr);
1129e6b1cc6bSSatish Balay     pc_ml->RepartitionType = partindx;
1130ce94432eSBarry Smith     if (!partindx) SETERRQ(PetscObjectComm((PetscObject)pc),PETSC_ERR_SUP_SYS,"ML not compiled with Zoltan");
113139381ba2SJed Brown #endif
11320298fd71SBarry Smith     ierr = PetscOptionsBool("-pc_ml_Aux","Aggregate using auxiliary coordinate-based laplacian","None",pc_ml->Aux,&pc_ml->Aux,NULL);CHKERRQ(ierr);
11330298fd71SBarry Smith     ierr = PetscOptionsReal("-pc_ml_AuxThreshold","Auxiliary smoother drop tol","None",pc_ml->AuxThreshold,&pc_ml->AuxThreshold,NULL);CHKERRQ(ierr);
113439381ba2SJed Brown   }
11355582bec1SHong Zhang   ierr = PetscOptionsTail();CHKERRQ(ierr);
11365582bec1SHong Zhang   PetscFunctionReturn(0);
11375582bec1SHong Zhang }
11385582bec1SHong Zhang 
11395582bec1SHong Zhang /* -------------------------------------------------------------------------- */
11405582bec1SHong Zhang /*
11415582bec1SHong Zhang    PCCreate_ML - Creates a ML preconditioner context, PC_ML,
11425582bec1SHong Zhang    and sets this as the private data within the generic preconditioning
11435582bec1SHong Zhang    context, PC, that was created within PCCreate().
11445582bec1SHong Zhang 
11455582bec1SHong Zhang    Input Parameter:
11465582bec1SHong Zhang .  pc - the preconditioner context
11475582bec1SHong Zhang 
11485582bec1SHong Zhang    Application Interface Routine: PCCreate()
11495582bec1SHong Zhang */
11505582bec1SHong Zhang 
11515582bec1SHong Zhang /*MC
11521e5ab15bSHong Zhang      PCML - Use algebraic multigrid preconditioning. This preconditioner requires you provide
11535582bec1SHong Zhang        fine grid discretization matrix. The coarser grid matrices and restriction/interpolation
11546ca4d86aSHong Zhang        operators are computed by ML, with the matrices coverted to PETSc matrices in aij format
11556ca4d86aSHong Zhang        and the restriction/interpolation operators wrapped as PETSc shell matrices.
11565582bec1SHong Zhang 
11576ca4d86aSHong Zhang    Options Database Key:
11582612397fSMatthew G. Knepley    Multigrid options(inherited):
11596ca4d86aSHong Zhang +  -pc_mg_cycles <1>: 1 for V cycle, 2 for W-cycle (MGSetCycles)
11606ca4d86aSHong Zhang .  -pc_mg_smoothup <1>: Number of post-smoothing steps (MGSetNumberSmoothUp)
11616ca4d86aSHong Zhang .  -pc_mg_smoothdown <1>: Number of pre-smoothing steps (MGSetNumberSmoothDown)
11622612397fSMatthew G. Knepley -  -pc_mg_type <multiplicative>: (one of) additive multiplicative full kascade
116351f519a2SBarry Smith    ML options:
11642612397fSMatthew G. Knepley +  -pc_ml_PrintLevel <0>: Print level (ML_Set_PrintLevel)
11656ca4d86aSHong Zhang .  -pc_ml_maxNlevels <10>: Maximum number of levels (None)
11666ca4d86aSHong Zhang .  -pc_ml_maxCoarseSize <1>: Maximum coarsest mesh size (ML_Aggregate_Set_MaxCoarseSize)
1167f41ab451SVictor Eijkhout .  -pc_ml_CoarsenScheme <Uncoupled>: (one of) Uncoupled Coupled MIS METIS
11686ca4d86aSHong Zhang .  -pc_ml_DampingFactor <1.33333>: P damping factor (ML_Aggregate_Set_DampingFactor)
11696ca4d86aSHong Zhang .  -pc_ml_Threshold <0>: Smoother drop tol (ML_Aggregate_Set_Threshold)
117039381ba2SJed Brown .  -pc_ml_SpectralNormScheme_Anorm <false>: Method used for estimating spectral radius (ML_Set_SpectralNormScheme_Anorm)
117139381ba2SJed Brown .  -pc_ml_repartition <false>: Allow ML to repartition levels of the heirarchy (ML_Repartition_Activate)
117239381ba2SJed Brown .  -pc_ml_repartitionMaxMinRatio <1.3>: Acceptable ratio of repartitioned sizes (ML_Repartition_Set_LargestMinMaxRatio)
117339381ba2SJed Brown .  -pc_ml_repartitionMinPerProc <512>: Smallest repartitioned size (ML_Repartition_Set_MinPerProc)
117439381ba2SJed Brown .  -pc_ml_repartitionPutOnSingleProc <5000>: Problem size automatically repartitioned to one processor (ML_Repartition_Set_PutOnSingleProc)
117539381ba2SJed Brown .  -pc_ml_repartitionType <Zoltan>: Repartitioning library to use (ML_Repartition_Set_Partitioner)
117639381ba2SJed Brown .  -pc_ml_repartitionZoltanScheme <RCB>: Repartitioning scheme to use (None)
117739381ba2SJed Brown .  -pc_ml_Aux <false>: Aggregate using auxiliary coordinate-based laplacian (None)
117839381ba2SJed Brown -  -pc_ml_AuxThreshold <0.0>: Auxiliary smoother drop tol (None)
11795582bec1SHong Zhang 
11805582bec1SHong Zhang    Level: intermediate
11815582bec1SHong Zhang 
11825582bec1SHong Zhang   Concepts: multigrid
11835582bec1SHong Zhang 
11845582bec1SHong Zhang .seealso:  PCCreate(), PCSetType(), PCType (for list of available types), PC, PCMGType,
118597177400SBarry Smith            PCMGSetLevels(), PCMGGetLevels(), PCMGSetType(), MPSetCycles(), PCMGSetNumberSmoothDown(),
118697177400SBarry Smith            PCMGSetNumberSmoothUp(), PCMGGetCoarseSolve(), PCMGSetResidual(), PCMGSetInterpolation(),
118797177400SBarry Smith            PCMGSetRestriction(), PCMGGetSmoother(), PCMGGetSmootherUp(), PCMGGetSmootherDown(),
118897177400SBarry Smith            PCMGSetCyclesOnLevel(), PCMGSetRhs(), PCMGSetX(), PCMGSetR()
11895582bec1SHong Zhang M*/
11905582bec1SHong Zhang 
11915582bec1SHong Zhang #undef __FUNCT__
11925582bec1SHong Zhang #define __FUNCT__ "PCCreate_ML"
11938cc058d9SJed Brown PETSC_EXTERN PetscErrorCode PCCreate_ML(PC pc)
11945582bec1SHong Zhang {
11955582bec1SHong Zhang   PetscErrorCode ierr;
11965582bec1SHong Zhang   PC_ML          *pc_ml;
119701da6913SBarry Smith   PC_MG          *mg;
11985582bec1SHong Zhang 
11995582bec1SHong Zhang   PetscFunctionBegin;
1200573998d7SHong Zhang   /* PCML is an inherited class of PCMG. Initialize pc as PCMG */
12015582bec1SHong Zhang   ierr = PCSetType(pc,PCMG);CHKERRQ(ierr); /* calls PCCreate_MG() and MGCreate_Private() */
120203bfa161SLisandro Dalcin   ierr = PetscObjectChangeTypeName((PetscObject)pc,PCML);CHKERRQ(ierr);
1203e0f5d30fSBarry Smith   /* Since PCMG tries to use DM assocated with PC must delete it */
1204e0f5d30fSBarry Smith   ierr         = DMDestroy(&pc->dm);CHKERRQ(ierr);
1205e0f5d30fSBarry Smith   mg           = (PC_MG*)pc->data;
1206c91913d3SJed Brown   mg->galerkin = 2;             /* Use Galerkin, but it is computed externally */
12075582bec1SHong Zhang 
12085582bec1SHong Zhang   /* create a supporting struct and attach it to pc */
1209b00a9115SJed Brown   ierr         = PetscNewLog(pc,&pc_ml);CHKERRQ(ierr);
121001da6913SBarry Smith   mg->innerctx = pc_ml;
12115582bec1SHong Zhang 
1212573998d7SHong Zhang   pc_ml->ml_object                = 0;
1213573998d7SHong Zhang   pc_ml->agg_object               = 0;
1214573998d7SHong Zhang   pc_ml->gridctx                  = 0;
1215573998d7SHong Zhang   pc_ml->PetscMLdata              = 0;
1216573998d7SHong Zhang   pc_ml->Nlevels                  = -1;
1217573998d7SHong Zhang   pc_ml->MaxNlevels               = 10;
1218573998d7SHong Zhang   pc_ml->MaxCoarseSize            = 1;
12193751b4bdSBarry Smith   pc_ml->CoarsenScheme            = 1;
1220573998d7SHong Zhang   pc_ml->Threshold                = 0.0;
1221573998d7SHong Zhang   pc_ml->DampingFactor            = 4.0/3.0;
1222573998d7SHong Zhang   pc_ml->SpectralNormScheme_Anorm = PETSC_FALSE;
1223573998d7SHong Zhang   pc_ml->size                     = 0;
122439381ba2SJed Brown   pc_ml->dim                      = 0;
122539381ba2SJed Brown   pc_ml->nloc                     = 0;
122639381ba2SJed Brown   pc_ml->coords                   = 0;
122739381ba2SJed Brown   pc_ml->Repartition              = PETSC_FALSE;
122839381ba2SJed Brown   pc_ml->MaxMinRatio              = 1.3;
122939381ba2SJed Brown   pc_ml->MinPerProc               = 512;
123039381ba2SJed Brown   pc_ml->PutOnSingleProc          = 5000;
123139381ba2SJed Brown   pc_ml->RepartitionType          = 0;
123239381ba2SJed Brown   pc_ml->ZoltanScheme             = 0;
123339381ba2SJed Brown   pc_ml->Aux                      = PETSC_FALSE;
123439381ba2SJed Brown   pc_ml->AuxThreshold             = 0.0;
123539381ba2SJed Brown 
123639381ba2SJed Brown   /* allow for coordinates to be passed */
1237bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCSetCoordinates_C",PCSetCoordinates_ML);CHKERRQ(ierr);
1238573998d7SHong Zhang 
12395582bec1SHong Zhang   /* overwrite the pointers of PCMG by the functions of PCML */
12405582bec1SHong Zhang   pc->ops->setfromoptions = PCSetFromOptions_ML;
12415582bec1SHong Zhang   pc->ops->setup          = PCSetUp_ML;
1242a06653b4SBarry Smith   pc->ops->reset          = PCReset_ML;
12435582bec1SHong Zhang   pc->ops->destroy        = PCDestroy_ML;
12445582bec1SHong Zhang   PetscFunctionReturn(0);
12455582bec1SHong Zhang }
1246