xref: /petsc/src/ksp/pc/impls/hypre/hypre.c (revision f8add62471838b7f79626f44861f7e48968ecb76)
116d9e3a6SLisandro Dalcin /*
216d9e3a6SLisandro Dalcin    Provides an interface to the LLNL package hypre
316d9e3a6SLisandro Dalcin */
40f1074feSSatish Balay 
5589dcaf0SStefano Zampini #include <petscpkg_version.h>
6af0996ceSBarry Smith #include <petsc/private/pcimpl.h>          /*I "petscpc.h" I*/
749a781f5SStefano Zampini /* this include is needed ONLY to allow access to the private data inside the Mat object specific to hypre */
849a781f5SStefano Zampini #include <petsc/private/matimpl.h>
96ea7df73SStefano Zampini #include <petsc/private/vecimpl.h>
1058968eb6SStefano Zampini #include <../src/vec/vec/impls/hypre/vhyp.h>
1149a781f5SStefano Zampini #include <../src/mat/impls/hypre/mhypre.h>
12c6db04a5SJed Brown #include <../src/dm/impls/da/hypre/mhyp.h>
134cb006feSStefano Zampini #include <_hypre_parcsr_ls.h>
148a2c336bSFande Kong #include <petscmathypre.h>
1516d9e3a6SLisandro Dalcin 
16dff31646SBarry Smith static PetscBool cite = PETSC_FALSE;
17a8d69d7bSBarry Smith static const char hypreCitation[] = "@manual{hypre-web-page,\n  title  = {{\\sl hypre}: High Performance Preconditioners},\n  organization = {Lawrence Livermore National Laboratory},\n  note  = {\\url{https://computation.llnl.gov/projects/hypre-scalable-linear-solvers-multigrid-methods}}\n}\n";
181f817a21SBarry Smith 
1916d9e3a6SLisandro Dalcin /*
2016d9e3a6SLisandro Dalcin    Private context (data structure) for the  preconditioner.
2116d9e3a6SLisandro Dalcin */
2216d9e3a6SLisandro Dalcin typedef struct {
2316d9e3a6SLisandro Dalcin   HYPRE_Solver   hsolver;
2449a781f5SStefano Zampini   Mat            hpmat; /* MatHYPRE */
2516d9e3a6SLisandro Dalcin 
264ddd07fcSJed Brown   HYPRE_Int (*destroy)(HYPRE_Solver);
274ddd07fcSJed Brown   HYPRE_Int (*solve)(HYPRE_Solver,HYPRE_ParCSRMatrix,HYPRE_ParVector,HYPRE_ParVector);
284ddd07fcSJed Brown   HYPRE_Int (*setup)(HYPRE_Solver,HYPRE_ParCSRMatrix,HYPRE_ParVector,HYPRE_ParVector);
2916d9e3a6SLisandro Dalcin 
3016d9e3a6SLisandro Dalcin   MPI_Comm comm_hypre;
3116d9e3a6SLisandro Dalcin   char     *hypre_type;
3216d9e3a6SLisandro Dalcin 
3316d9e3a6SLisandro Dalcin   /* options for Pilut and BoomerAMG*/
344ddd07fcSJed Brown   PetscInt  maxiter;
3539accc25SStefano Zampini   PetscReal tol;
3616d9e3a6SLisandro Dalcin 
3716d9e3a6SLisandro Dalcin   /* options for Pilut */
384ddd07fcSJed Brown   PetscInt factorrowsize;
3916d9e3a6SLisandro Dalcin 
4016d9e3a6SLisandro Dalcin   /* options for ParaSails */
414ddd07fcSJed Brown   PetscInt  nlevels;
428966356dSPierre Jolivet   PetscReal threshold;
4339accc25SStefano Zampini   PetscReal filter;
4439accc25SStefano Zampini   PetscReal loadbal;
454ddd07fcSJed Brown   PetscInt  logging;
464ddd07fcSJed Brown   PetscInt  ruse;
474ddd07fcSJed Brown   PetscInt  symt;
4816d9e3a6SLisandro Dalcin 
4922b6d1caSBarry Smith   /* options for BoomerAMG */
50ace3abfcSBarry Smith   PetscBool printstatistics;
5116d9e3a6SLisandro Dalcin 
5216d9e3a6SLisandro Dalcin   /* options for BoomerAMG */
534ddd07fcSJed Brown   PetscInt  cycletype;
544ddd07fcSJed Brown   PetscInt  maxlevels;
5539accc25SStefano Zampini   PetscReal strongthreshold;
5639accc25SStefano Zampini   PetscReal maxrowsum;
574ddd07fcSJed Brown   PetscInt  gridsweeps[3];
584ddd07fcSJed Brown   PetscInt  coarsentype;
594ddd07fcSJed Brown   PetscInt  measuretype;
606a251517SEike Mueller   PetscInt  smoothtype;
618131ecf7SEike Mueller   PetscInt  smoothnumlevels;
62ec64516dSEike Mueller   PetscInt  eu_level;   /* Number of levels for ILU(k) in Euclid */
6339accc25SStefano Zampini   PetscReal eu_droptolerance; /* Drop tolerance for ILU(k) in Euclid */
64ec64516dSEike Mueller   PetscInt  eu_bj;      /* Defines use of Block Jacobi ILU in Euclid */
654ddd07fcSJed Brown   PetscInt  relaxtype[3];
6639accc25SStefano Zampini   PetscReal relaxweight;
6739accc25SStefano Zampini   PetscReal outerrelaxweight;
684ddd07fcSJed Brown   PetscInt  relaxorder;
6939accc25SStefano Zampini   PetscReal truncfactor;
70ace3abfcSBarry Smith   PetscBool applyrichardson;
714ddd07fcSJed Brown   PetscInt  pmax;
724ddd07fcSJed Brown   PetscInt  interptype;
73589dcaf0SStefano Zampini   PetscInt  maxc;
74589dcaf0SStefano Zampini   PetscInt  minc;
75589dcaf0SStefano Zampini 
766ea7df73SStefano Zampini   /* GPU */
776ea7df73SStefano Zampini   PetscBool keeptranspose;
786ea7df73SStefano Zampini   PetscInt  rap2;
796ea7df73SStefano Zampini   PetscInt  mod_rap2;
806ea7df73SStefano Zampini 
81589dcaf0SStefano Zampini   /* AIR */
82589dcaf0SStefano Zampini   PetscInt  Rtype;
83589dcaf0SStefano Zampini   PetscReal Rstrongthreshold;
84589dcaf0SStefano Zampini   PetscReal Rfilterthreshold;
85589dcaf0SStefano Zampini   PetscInt  Adroptype;
86589dcaf0SStefano Zampini   PetscReal Adroptol;
87589dcaf0SStefano Zampini 
884ddd07fcSJed Brown   PetscInt  agg_nl;
896ea7df73SStefano Zampini   PetscInt  agg_interptype;
904ddd07fcSJed Brown   PetscInt  agg_num_paths;
91ace3abfcSBarry Smith   PetscBool nodal_relax;
924ddd07fcSJed Brown   PetscInt  nodal_relax_levels;
934cb006feSStefano Zampini 
945272c319SBarry Smith   PetscInt  nodal_coarsening;
9522e51d31SStefano Zampini   PetscInt  nodal_coarsening_diag;
965272c319SBarry Smith   PetscInt  vec_interp_variant;
9722e51d31SStefano Zampini   PetscInt  vec_interp_qmax;
9822e51d31SStefano Zampini   PetscBool vec_interp_smooth;
9922e51d31SStefano Zampini   PetscInt  interp_refine;
10022e51d31SStefano Zampini 
1016ea7df73SStefano Zampini   /* NearNullSpace support */
1026ea7df73SStefano Zampini   VecHYPRE_IJVector *hmnull;
1036ea7df73SStefano Zampini   HYPRE_ParVector   *phmnull;
1045272c319SBarry Smith   PetscInt          n_hmnull;
1055272c319SBarry Smith   Vec               hmnull_constant;
1065272c319SBarry Smith 
107863406b8SStefano Zampini   /* options for AS (Auxiliary Space preconditioners) */
108863406b8SStefano Zampini   PetscInt  as_print;
109863406b8SStefano Zampini   PetscInt  as_max_iter;
110863406b8SStefano Zampini   PetscReal as_tol;
111863406b8SStefano Zampini   PetscInt  as_relax_type;
112863406b8SStefano Zampini   PetscInt  as_relax_times;
113863406b8SStefano Zampini   PetscReal as_relax_weight;
114863406b8SStefano Zampini   PetscReal as_omega;
115863406b8SStefano Zampini   PetscInt  as_amg_alpha_opts[5]; /* AMG coarsen type, agg_levels, relax_type, interp_type, Pmax for vector Poisson (AMS) or Curl problem (ADS) */
116863406b8SStefano Zampini   PetscReal as_amg_alpha_theta;   /* AMG strength for vector Poisson (AMS) or Curl problem (ADS) */
117863406b8SStefano Zampini   PetscInt  as_amg_beta_opts[5];  /* AMG coarsen type, agg_levels, relax_type, interp_type, Pmax for scalar Poisson (AMS) or vector Poisson (ADS) */
118863406b8SStefano Zampini   PetscReal as_amg_beta_theta;    /* AMG strength for scalar Poisson (AMS) or vector Poisson (ADS)  */
1194cb006feSStefano Zampini   PetscInt  ams_cycle_type;
120863406b8SStefano Zampini   PetscInt  ads_cycle_type;
1214cb006feSStefano Zampini 
1224cb006feSStefano Zampini   /* additional data */
1235ac14e1cSStefano Zampini   Mat G;             /* MatHYPRE */
1245ac14e1cSStefano Zampini   Mat C;             /* MatHYPRE */
1255ac14e1cSStefano Zampini   Mat alpha_Poisson; /* MatHYPRE */
1265ac14e1cSStefano Zampini   Mat beta_Poisson;  /* MatHYPRE */
1275ac14e1cSStefano Zampini 
1285ac14e1cSStefano Zampini   /* extra information for AMS */
1295ac14e1cSStefano Zampini   PetscInt          dim; /* geometrical dimension */
1306ea7df73SStefano Zampini   VecHYPRE_IJVector coords[3];
1316ea7df73SStefano Zampini   VecHYPRE_IJVector constants[3];
1326bf688a0SCe Qin   Mat               RT_PiFull, RT_Pi[3];
1336bf688a0SCe Qin   Mat               ND_PiFull, ND_Pi[3];
1344cb006feSStefano Zampini   PetscBool         ams_beta_is_zero;
13523df4f25SStefano Zampini   PetscBool         ams_beta_is_zero_part;
13623df4f25SStefano Zampini   PetscInt          ams_proj_freq;
13716d9e3a6SLisandro Dalcin } PC_HYPRE;
13816d9e3a6SLisandro Dalcin 
139d2128fa2SBarry Smith PetscErrorCode PCHYPREGetSolver(PC pc,HYPRE_Solver *hsolver)
140d2128fa2SBarry Smith {
141d2128fa2SBarry Smith   PC_HYPRE *jac = (PC_HYPRE*)pc->data;
142d2128fa2SBarry Smith 
143d2128fa2SBarry Smith   PetscFunctionBegin;
144d2128fa2SBarry Smith   *hsolver = jac->hsolver;
145d2128fa2SBarry Smith   PetscFunctionReturn(0);
146d2128fa2SBarry Smith }
14716d9e3a6SLisandro Dalcin 
148fd2dd295SFande Kong /*
1498a2c336bSFande Kong   Matrices with AIJ format are created IN PLACE with using (I,J,data) from BoomerAMG. Since the data format in hypre_ParCSRMatrix
1508a2c336bSFande Kong   is different from that used in PETSc, the original hypre_ParCSRMatrix can not be used any more after call this routine.
1518a2c336bSFande Kong   It is used in PCHMG. Other users should avoid using this function.
152fd2dd295SFande Kong */
153fd2dd295SFande Kong static PetscErrorCode PCGetCoarseOperators_BoomerAMG(PC pc,PetscInt *nlevels,Mat *operators[])
1548a2c336bSFande Kong {
1558a2c336bSFande Kong   PC_HYPRE             *jac  = (PC_HYPRE*)pc->data;
1568a2c336bSFande Kong   PetscBool            same = PETSC_FALSE;
1578a2c336bSFande Kong   PetscErrorCode       ierr;
1588a2c336bSFande Kong   PetscInt             num_levels,l;
1598a2c336bSFande Kong   Mat                  *mattmp;
1608a2c336bSFande Kong   hypre_ParCSRMatrix   **A_array;
1618a2c336bSFande Kong 
1628a2c336bSFande Kong   PetscFunctionBegin;
1638a2c336bSFande Kong   ierr = PetscStrcmp(jac->hypre_type,"boomeramg",&same);CHKERRQ(ierr);
1648a2c336bSFande Kong   if (!same) SETERRQ(PetscObjectComm((PetscObject)pc),PETSC_ERR_ARG_NOTSAMETYPE,"Hypre type is not BoomerAMG \n");
1658a2c336bSFande Kong   num_levels = hypre_ParAMGDataNumLevels((hypre_ParAMGData*) (jac->hsolver));
1668a2c336bSFande Kong   ierr = PetscMalloc1(num_levels,&mattmp);CHKERRQ(ierr);
1678a2c336bSFande Kong   A_array    = hypre_ParAMGDataAArray((hypre_ParAMGData*) (jac->hsolver));
1688a2c336bSFande Kong   for (l=1; l<num_levels; l++) {
1698a2c336bSFande Kong     ierr = MatCreateFromParCSR(A_array[l],MATAIJ,PETSC_OWN_POINTER, &(mattmp[num_levels-1-l]));CHKERRQ(ierr);
1708a2c336bSFande Kong     /* We want to own the data, and HYPRE can not touch this matrix any more */
1718a2c336bSFande Kong     A_array[l] = NULL;
1728a2c336bSFande Kong   }
1738a2c336bSFande Kong   *nlevels = num_levels;
1748a2c336bSFande Kong   *operators = mattmp;
1758a2c336bSFande Kong   PetscFunctionReturn(0);
1768a2c336bSFande Kong }
1778a2c336bSFande Kong 
178fd2dd295SFande Kong /*
1798a2c336bSFande Kong   Matrices with AIJ format are created IN PLACE with using (I,J,data) from BoomerAMG. Since the data format in hypre_ParCSRMatrix
1808a2c336bSFande Kong   is different from that used in PETSc, the original hypre_ParCSRMatrix can not be used any more after call this routine.
1818a2c336bSFande Kong   It is used in PCHMG. Other users should avoid using this function.
182fd2dd295SFande Kong */
183fd2dd295SFande Kong static PetscErrorCode PCGetInterpolations_BoomerAMG(PC pc,PetscInt *nlevels,Mat *interpolations[])
1848a2c336bSFande Kong {
1858a2c336bSFande Kong   PC_HYPRE             *jac  = (PC_HYPRE*)pc->data;
1868a2c336bSFande Kong   PetscBool            same = PETSC_FALSE;
1878a2c336bSFande Kong   PetscErrorCode       ierr;
1888a2c336bSFande Kong   PetscInt             num_levels,l;
1898a2c336bSFande Kong   Mat                  *mattmp;
1908a2c336bSFande Kong   hypre_ParCSRMatrix   **P_array;
1918a2c336bSFande Kong 
1928a2c336bSFande Kong   PetscFunctionBegin;
1938a2c336bSFande Kong   ierr = PetscStrcmp(jac->hypre_type,"boomeramg",&same);CHKERRQ(ierr);
1948a2c336bSFande Kong   if (!same) SETERRQ(PetscObjectComm((PetscObject)pc),PETSC_ERR_ARG_NOTSAMETYPE,"Hypre type is not BoomerAMG \n");
1958a2c336bSFande Kong   num_levels = hypre_ParAMGDataNumLevels((hypre_ParAMGData*) (jac->hsolver));
1968a2c336bSFande Kong   ierr = PetscMalloc1(num_levels,&mattmp);CHKERRQ(ierr);
1978a2c336bSFande Kong   P_array  = hypre_ParAMGDataPArray((hypre_ParAMGData*) (jac->hsolver));
1988a2c336bSFande Kong   for (l=1; l<num_levels; l++) {
1998a2c336bSFande Kong     ierr = MatCreateFromParCSR(P_array[num_levels-1-l],MATAIJ,PETSC_OWN_POINTER, &(mattmp[l-1]));CHKERRQ(ierr);
2008a2c336bSFande Kong     /* We want to own the data, and HYPRE can not touch this matrix any more */
2018a2c336bSFande Kong     P_array[num_levels-1-l] = NULL;
2028a2c336bSFande Kong   }
2038a2c336bSFande Kong   *nlevels = num_levels;
2048a2c336bSFande Kong   *interpolations = mattmp;
2058a2c336bSFande Kong   PetscFunctionReturn(0);
2068a2c336bSFande Kong }
2078a2c336bSFande Kong 
208ce6a8a0dSJed Brown /* Resets (frees) Hypre's representation of the near null space */
209ce6a8a0dSJed Brown static PetscErrorCode PCHYPREResetNearNullSpace_Private(PC pc)
210ce6a8a0dSJed Brown {
211ce6a8a0dSJed Brown   PC_HYPRE       *jac = (PC_HYPRE*)pc->data;
212ce6a8a0dSJed Brown   PetscInt       i;
2139d678128SJed Brown   PetscErrorCode ierr;
214ce6a8a0dSJed Brown 
2159d678128SJed Brown   PetscFunctionBegin;
216ce6a8a0dSJed Brown   for (i=0; i<jac->n_hmnull; i++) {
2176ea7df73SStefano Zampini     ierr = VecHYPRE_IJVectorDestroy(&jac->hmnull[i]);CHKERRQ(ierr);
218ce6a8a0dSJed Brown   }
219ce6a8a0dSJed Brown   ierr = PetscFree(jac->hmnull);CHKERRQ(ierr);
220ce6a8a0dSJed Brown   ierr = PetscFree(jac->phmnull);CHKERRQ(ierr);
221ce6a8a0dSJed Brown   ierr = VecDestroy(&jac->hmnull_constant);CHKERRQ(ierr);
2229d678128SJed Brown   jac->n_hmnull = 0;
223ce6a8a0dSJed Brown   PetscFunctionReturn(0);
224ce6a8a0dSJed Brown }
225ce6a8a0dSJed Brown 
22616d9e3a6SLisandro Dalcin static PetscErrorCode PCSetUp_HYPRE(PC pc)
22716d9e3a6SLisandro Dalcin {
22816d9e3a6SLisandro Dalcin   PC_HYPRE           *jac = (PC_HYPRE*)pc->data;
22949a781f5SStefano Zampini   Mat_HYPRE          *hjac;
23016d9e3a6SLisandro Dalcin   HYPRE_ParCSRMatrix hmat;
23116d9e3a6SLisandro Dalcin   HYPRE_ParVector    bv,xv;
23249a781f5SStefano Zampini   PetscBool          ishypre;
23349a781f5SStefano Zampini   PetscErrorCode     ierr;
23416d9e3a6SLisandro Dalcin 
23516d9e3a6SLisandro Dalcin   PetscFunctionBegin;
23616d9e3a6SLisandro Dalcin   if (!jac->hypre_type) {
23702a17cd4SBarry Smith     ierr = PCHYPRESetType(pc,"boomeramg");CHKERRQ(ierr);
23816d9e3a6SLisandro Dalcin   }
2395f5c5b43SBarry Smith 
24049a781f5SStefano Zampini   ierr = PetscObjectTypeCompare((PetscObject)pc->pmat,MATHYPRE,&ishypre);CHKERRQ(ierr);
24149a781f5SStefano Zampini   if (!ishypre) {
2426bf688a0SCe Qin     ierr = MatDestroy(&jac->hpmat);CHKERRQ(ierr);
2436bf688a0SCe Qin     ierr = MatConvert(pc->pmat,MATHYPRE,MAT_INITIAL_MATRIX,&jac->hpmat);CHKERRQ(ierr);
244589dcaf0SStefano Zampini     ierr = PetscLogObjectParent((PetscObject)pc,(PetscObject)jac->hpmat);CHKERRQ(ierr);
24549a781f5SStefano Zampini   } else {
24649a781f5SStefano Zampini     ierr = PetscObjectReference((PetscObject)pc->pmat);CHKERRQ(ierr);
24749a781f5SStefano Zampini     ierr = MatDestroy(&jac->hpmat);CHKERRQ(ierr);
24849a781f5SStefano Zampini     jac->hpmat = pc->pmat;
24916d9e3a6SLisandro Dalcin   }
2506ea7df73SStefano Zampini   /* allow debug */
2516ea7df73SStefano Zampini   ierr = MatViewFromOptions(jac->hpmat,NULL,"-pc_hypre_mat_view");CHKERRQ(ierr);
25249a781f5SStefano Zampini   hjac = (Mat_HYPRE*)(jac->hpmat->data);
2535f5c5b43SBarry Smith 
25416d9e3a6SLisandro Dalcin   /* special case for BoomerAMG */
25516d9e3a6SLisandro Dalcin   if (jac->setup == HYPRE_BoomerAMGSetup) {
2565272c319SBarry Smith     MatNullSpace mnull;
2575272c319SBarry Smith     PetscBool    has_const;
25849a781f5SStefano Zampini     PetscInt     bs,nvec,i;
2595272c319SBarry Smith     const Vec    *vecs;
2605272c319SBarry Smith 
26116d9e3a6SLisandro Dalcin     ierr = MatGetBlockSize(pc->pmat,&bs);CHKERRQ(ierr);
2622fa5cd67SKarl Rupp     if (bs > 1) PetscStackCallStandard(HYPRE_BoomerAMGSetNumFunctions,(jac->hsolver,bs));
2635272c319SBarry Smith     ierr = MatGetNearNullSpace(pc->mat, &mnull);CHKERRQ(ierr);
2645272c319SBarry Smith     if (mnull) {
265ce6a8a0dSJed Brown       ierr = PCHYPREResetNearNullSpace_Private(pc);CHKERRQ(ierr);
2665272c319SBarry Smith       ierr = MatNullSpaceGetVecs(mnull, &has_const, &nvec, &vecs);CHKERRQ(ierr);
2675272c319SBarry Smith       ierr = PetscMalloc1(nvec+1,&jac->hmnull);CHKERRQ(ierr);
2685272c319SBarry Smith       ierr = PetscMalloc1(nvec+1,&jac->phmnull);CHKERRQ(ierr);
2695272c319SBarry Smith       for (i=0; i<nvec; i++) {
2706ea7df73SStefano Zampini         ierr = VecHYPRE_IJVectorCreate(vecs[i]->map,&jac->hmnull[i]);CHKERRQ(ierr);
2716ea7df73SStefano Zampini         ierr = VecHYPRE_IJVectorCopy(vecs[i],jac->hmnull[i]);CHKERRQ(ierr);
2726ea7df73SStefano Zampini         PetscStackCallStandard(HYPRE_IJVectorGetObject,(jac->hmnull[i]->ij,(void**)&jac->phmnull[i]));
2735272c319SBarry Smith       }
2745272c319SBarry Smith       if (has_const) {
2755272c319SBarry Smith         ierr = MatCreateVecs(pc->pmat,&jac->hmnull_constant,NULL);CHKERRQ(ierr);
276589dcaf0SStefano Zampini         ierr = PetscLogObjectParent((PetscObject)pc,(PetscObject)jac->hmnull_constant);CHKERRQ(ierr);
2775272c319SBarry Smith         ierr = VecSet(jac->hmnull_constant,1);CHKERRQ(ierr);
2781e1ea65dSPierre Jolivet         ierr = VecNormalize(jac->hmnull_constant,NULL);CHKERRQ(ierr);
2796ea7df73SStefano Zampini         ierr = VecHYPRE_IJVectorCreate(jac->hmnull_constant->map,&jac->hmnull[nvec]);CHKERRQ(ierr);
2806ea7df73SStefano Zampini         ierr = VecHYPRE_IJVectorCopy(jac->hmnull_constant,jac->hmnull[nvec]);CHKERRQ(ierr);
2816ea7df73SStefano Zampini         PetscStackCallStandard(HYPRE_IJVectorGetObject,(jac->hmnull[nvec]->ij,(void**)&jac->phmnull[nvec]));
2825272c319SBarry Smith         nvec++;
2835272c319SBarry Smith       }
2845272c319SBarry Smith       PetscStackCallStandard(HYPRE_BoomerAMGSetInterpVectors,(jac->hsolver,nvec,jac->phmnull));
2855272c319SBarry Smith       jac->n_hmnull = nvec;
2865272c319SBarry Smith     }
2874cb006feSStefano Zampini   }
288863406b8SStefano Zampini 
2894cb006feSStefano Zampini   /* special case for AMS */
2904cb006feSStefano Zampini   if (jac->setup == HYPRE_AMSSetup) {
2915ac14e1cSStefano Zampini     Mat_HYPRE          *hm;
2925ac14e1cSStefano Zampini     HYPRE_ParCSRMatrix parcsr;
2936bf688a0SCe Qin     if (!jac->coords[0] && !jac->constants[0] && !(jac->ND_PiFull || (jac->ND_Pi[0] && jac->ND_Pi[1]))) {
2946bf688a0SCe Qin       SETERRQ(PetscObjectComm((PetscObject)pc),PETSC_ERR_USER,"HYPRE AMS preconditioner needs either the coordinate vectors via PCSetCoordinates() or the edge constant vectors via PCHYPRESetEdgeConstantVectors() or the interpolation matrix via PCHYPRESetInterpolations");
2956bf688a0SCe Qin     }
2965ac14e1cSStefano Zampini     if (jac->dim) {
2975ac14e1cSStefano Zampini       PetscStackCallStandard(HYPRE_AMSSetDimension,(jac->hsolver,jac->dim));
2985ac14e1cSStefano Zampini     }
2995ac14e1cSStefano Zampini     if (jac->constants[0]) {
3005ac14e1cSStefano Zampini       HYPRE_ParVector ozz,zoz,zzo = NULL;
3016ea7df73SStefano Zampini       PetscStackCallStandard(HYPRE_IJVectorGetObject,(jac->constants[0]->ij,(void**)(&ozz)));
3026ea7df73SStefano Zampini       PetscStackCallStandard(HYPRE_IJVectorGetObject,(jac->constants[1]->ij,(void**)(&zoz)));
3035ac14e1cSStefano Zampini       if (jac->constants[2]) {
3046ea7df73SStefano Zampini         PetscStackCallStandard(HYPRE_IJVectorGetObject,(jac->constants[2]->ij,(void**)(&zzo)));
3055ac14e1cSStefano Zampini       }
3065ac14e1cSStefano Zampini       PetscStackCallStandard(HYPRE_AMSSetEdgeConstantVectors,(jac->hsolver,ozz,zoz,zzo));
3075ac14e1cSStefano Zampini     }
3085ac14e1cSStefano Zampini     if (jac->coords[0]) {
3095ac14e1cSStefano Zampini       HYPRE_ParVector coords[3];
3105ac14e1cSStefano Zampini       coords[0] = NULL;
3115ac14e1cSStefano Zampini       coords[1] = NULL;
3125ac14e1cSStefano Zampini       coords[2] = NULL;
3136ea7df73SStefano Zampini       if (jac->coords[0]) PetscStackCallStandard(HYPRE_IJVectorGetObject,(jac->coords[0]->ij,(void**)(&coords[0])));
3146ea7df73SStefano Zampini       if (jac->coords[1]) PetscStackCallStandard(HYPRE_IJVectorGetObject,(jac->coords[1]->ij,(void**)(&coords[1])));
3156ea7df73SStefano Zampini       if (jac->coords[2]) PetscStackCallStandard(HYPRE_IJVectorGetObject,(jac->coords[2]->ij,(void**)(&coords[2])));
3165ac14e1cSStefano Zampini       PetscStackCallStandard(HYPRE_AMSSetCoordinateVectors,(jac->hsolver,coords[0],coords[1],coords[2]));
3175ac14e1cSStefano Zampini     }
31849a781f5SStefano Zampini     if (!jac->G) SETERRQ(PetscObjectComm((PetscObject)pc),PETSC_ERR_USER,"HYPRE AMS preconditioner needs the discrete gradient operator via PCHYPRESetDiscreteGradient");
3195ac14e1cSStefano Zampini     hm = (Mat_HYPRE*)(jac->G->data);
3205ac14e1cSStefano Zampini     PetscStackCallStandard(HYPRE_IJMatrixGetObject,(hm->ij,(void**)(&parcsr)));
3215ac14e1cSStefano Zampini     PetscStackCallStandard(HYPRE_AMSSetDiscreteGradient,(jac->hsolver,parcsr));
3225ac14e1cSStefano Zampini     if (jac->alpha_Poisson) {
3235ac14e1cSStefano Zampini       hm = (Mat_HYPRE*)(jac->alpha_Poisson->data);
3245ac14e1cSStefano Zampini       PetscStackCallStandard(HYPRE_IJMatrixGetObject,(hm->ij,(void**)(&parcsr)));
3255ac14e1cSStefano Zampini       PetscStackCallStandard(HYPRE_AMSSetAlphaPoissonMatrix,(jac->hsolver,parcsr));
3265ac14e1cSStefano Zampini     }
3275ac14e1cSStefano Zampini     if (jac->ams_beta_is_zero) {
3285ac14e1cSStefano Zampini       PetscStackCallStandard(HYPRE_AMSSetBetaPoissonMatrix,(jac->hsolver,NULL));
3295ac14e1cSStefano Zampini     } else if (jac->beta_Poisson) {
3305ac14e1cSStefano Zampini       hm = (Mat_HYPRE*)(jac->beta_Poisson->data);
3315ac14e1cSStefano Zampini       PetscStackCallStandard(HYPRE_IJMatrixGetObject,(hm->ij,(void**)(&parcsr)));
3325ac14e1cSStefano Zampini       PetscStackCallStandard(HYPRE_AMSSetBetaPoissonMatrix,(jac->hsolver,parcsr));
3335ac14e1cSStefano Zampini     }
3346bf688a0SCe Qin     if (jac->ND_PiFull || (jac->ND_Pi[0] && jac->ND_Pi[1])) {
3356bf688a0SCe Qin       PetscInt           i;
3366bf688a0SCe Qin       HYPRE_ParCSRMatrix nd_parcsrfull, nd_parcsr[3];
3376bf688a0SCe Qin       if (jac->ND_PiFull) {
3386bf688a0SCe Qin         hm = (Mat_HYPRE*)(jac->ND_PiFull->data);
3396bf688a0SCe Qin         PetscStackCallStandard(HYPRE_IJMatrixGetObject,(hm->ij,(void**)(&nd_parcsrfull)));
3406bf688a0SCe Qin       } else {
3416bf688a0SCe Qin         nd_parcsrfull = NULL;
3426bf688a0SCe Qin       }
3436bf688a0SCe Qin       for (i=0;i<3;++i) {
3446bf688a0SCe Qin         if (jac->ND_Pi[i]) {
3456bf688a0SCe Qin           hm = (Mat_HYPRE*)(jac->ND_Pi[i]->data);
3466bf688a0SCe Qin           PetscStackCallStandard(HYPRE_IJMatrixGetObject,(hm->ij,(void**)(&nd_parcsr[i])));
3476bf688a0SCe Qin         } else {
3486bf688a0SCe Qin           nd_parcsr[i] = NULL;
3496bf688a0SCe Qin         }
3506bf688a0SCe Qin       }
3516bf688a0SCe Qin       PetscStackCallStandard(HYPRE_AMSSetInterpolations,(jac->hsolver,nd_parcsrfull,nd_parcsr[0],nd_parcsr[1],nd_parcsr[2]));
3526bf688a0SCe Qin     }
3534cb006feSStefano Zampini   }
354863406b8SStefano Zampini   /* special case for ADS */
355863406b8SStefano Zampini   if (jac->setup == HYPRE_ADSSetup) {
3565ac14e1cSStefano Zampini     Mat_HYPRE          *hm;
3575ac14e1cSStefano Zampini     HYPRE_ParCSRMatrix parcsr;
3586bf688a0SCe Qin     if (!jac->coords[0] && !((jac->RT_PiFull || (jac->RT_Pi[0] && jac->RT_Pi[1])) && (jac->ND_PiFull || (jac->ND_Pi[0] && jac->ND_Pi[1])))) {
3596bf688a0SCe Qin       SETERRQ(PetscObjectComm((PetscObject)pc),PETSC_ERR_USER,"HYPRE ADS preconditioner needs either the coordinate vectors via PCSetCoordinates() or the interpolation matrices via PCHYPRESetInterpolations");
3606bf688a0SCe Qin     }
36137096e45SBarry Smith     else if (!jac->coords[1] || !jac->coords[2]) SETERRQ(PetscObjectComm((PetscObject)pc),PETSC_ERR_USER,"HYPRE ADS preconditioner has been designed for three dimensional problems! For two dimensional problems, use HYPRE AMS instead");
36249a781f5SStefano Zampini     if (!jac->G) SETERRQ(PetscObjectComm((PetscObject)pc),PETSC_ERR_USER,"HYPRE ADS preconditioner needs the discrete gradient operator via PCHYPRESetDiscreteGradient");
36349a781f5SStefano Zampini     if (!jac->C) SETERRQ(PetscObjectComm((PetscObject)pc),PETSC_ERR_USER,"HYPRE ADS preconditioner needs the discrete curl operator via PCHYPRESetDiscreteGradient");
3645ac14e1cSStefano Zampini     if (jac->coords[0]) {
3655ac14e1cSStefano Zampini       HYPRE_ParVector coords[3];
3665ac14e1cSStefano Zampini       coords[0] = NULL;
3675ac14e1cSStefano Zampini       coords[1] = NULL;
3685ac14e1cSStefano Zampini       coords[2] = NULL;
3696ea7df73SStefano Zampini       if (jac->coords[0]) PetscStackCallStandard(HYPRE_IJVectorGetObject,(jac->coords[0]->ij,(void**)(&coords[0])));
3706ea7df73SStefano Zampini       if (jac->coords[1]) PetscStackCallStandard(HYPRE_IJVectorGetObject,(jac->coords[1]->ij,(void**)(&coords[1])));
3716ea7df73SStefano Zampini       if (jac->coords[2]) PetscStackCallStandard(HYPRE_IJVectorGetObject,(jac->coords[2]->ij,(void**)(&coords[2])));
3725ac14e1cSStefano Zampini       PetscStackCallStandard(HYPRE_ADSSetCoordinateVectors,(jac->hsolver,coords[0],coords[1],coords[2]));
3735ac14e1cSStefano Zampini     }
3745ac14e1cSStefano Zampini     hm = (Mat_HYPRE*)(jac->G->data);
3755ac14e1cSStefano Zampini     PetscStackCallStandard(HYPRE_IJMatrixGetObject,(hm->ij,(void**)(&parcsr)));
3765ac14e1cSStefano Zampini     PetscStackCallStandard(HYPRE_ADSSetDiscreteGradient,(jac->hsolver,parcsr));
3775ac14e1cSStefano Zampini     hm = (Mat_HYPRE*)(jac->C->data);
3785ac14e1cSStefano Zampini     PetscStackCallStandard(HYPRE_IJMatrixGetObject,(hm->ij,(void**)(&parcsr)));
3795ac14e1cSStefano Zampini     PetscStackCallStandard(HYPRE_ADSSetDiscreteCurl,(jac->hsolver,parcsr));
3806bf688a0SCe Qin     if ((jac->RT_PiFull || (jac->RT_Pi[0] && jac->RT_Pi[1])) && (jac->ND_PiFull || (jac->ND_Pi[0] && jac->ND_Pi[1]))) {
3816bf688a0SCe Qin       PetscInt           i;
3826bf688a0SCe Qin       HYPRE_ParCSRMatrix rt_parcsrfull, rt_parcsr[3];
3836bf688a0SCe Qin       HYPRE_ParCSRMatrix nd_parcsrfull, nd_parcsr[3];
3846bf688a0SCe Qin       if (jac->RT_PiFull) {
3856bf688a0SCe Qin         hm = (Mat_HYPRE*)(jac->RT_PiFull->data);
3866bf688a0SCe Qin         PetscStackCallStandard(HYPRE_IJMatrixGetObject,(hm->ij,(void**)(&rt_parcsrfull)));
3876bf688a0SCe Qin       } else {
3886bf688a0SCe Qin         rt_parcsrfull = NULL;
3896bf688a0SCe Qin       }
3906bf688a0SCe Qin       for (i=0;i<3;++i) {
3916bf688a0SCe Qin         if (jac->RT_Pi[i]) {
3926bf688a0SCe Qin           hm = (Mat_HYPRE*)(jac->RT_Pi[i]->data);
3936bf688a0SCe Qin           PetscStackCallStandard(HYPRE_IJMatrixGetObject,(hm->ij,(void**)(&rt_parcsr[i])));
3946bf688a0SCe Qin         } else {
3956bf688a0SCe Qin           rt_parcsr[i] = NULL;
3966bf688a0SCe Qin         }
3976bf688a0SCe Qin       }
3986bf688a0SCe Qin       if (jac->ND_PiFull) {
3996bf688a0SCe Qin         hm = (Mat_HYPRE*)(jac->ND_PiFull->data);
4006bf688a0SCe Qin         PetscStackCallStandard(HYPRE_IJMatrixGetObject,(hm->ij,(void**)(&nd_parcsrfull)));
4016bf688a0SCe Qin       } else {
4026bf688a0SCe Qin         nd_parcsrfull = NULL;
4036bf688a0SCe Qin       }
4046bf688a0SCe Qin       for (i=0;i<3;++i) {
4056bf688a0SCe Qin         if (jac->ND_Pi[i]) {
4066bf688a0SCe Qin           hm = (Mat_HYPRE*)(jac->ND_Pi[i]->data);
4076bf688a0SCe Qin           PetscStackCallStandard(HYPRE_IJMatrixGetObject,(hm->ij,(void**)(&nd_parcsr[i])));
4086bf688a0SCe Qin         } else {
4096bf688a0SCe Qin           nd_parcsr[i] = NULL;
4106bf688a0SCe Qin         }
4116bf688a0SCe Qin       }
4126bf688a0SCe Qin       PetscStackCallStandard(HYPRE_ADSSetInterpolations,(jac->hsolver,rt_parcsrfull,rt_parcsr[0],rt_parcsr[1],rt_parcsr[2],nd_parcsrfull,nd_parcsr[0],nd_parcsr[1],nd_parcsr[2]));
4136bf688a0SCe Qin     }
414863406b8SStefano Zampini   }
41549a781f5SStefano Zampini   PetscStackCallStandard(HYPRE_IJMatrixGetObject,(hjac->ij,(void**)&hmat));
4166ea7df73SStefano Zampini   PetscStackCallStandard(HYPRE_IJVectorGetObject,(hjac->b->ij,(void**)&bv));
4176ea7df73SStefano Zampini   PetscStackCallStandard(HYPRE_IJVectorGetObject,(hjac->x->ij,(void**)&xv));
41822e51d31SStefano Zampini   PetscStackCallStandard(jac->setup,(jac->hsolver,hmat,bv,xv));
41916d9e3a6SLisandro Dalcin   PetscFunctionReturn(0);
42016d9e3a6SLisandro Dalcin }
42116d9e3a6SLisandro Dalcin 
42216d9e3a6SLisandro Dalcin static PetscErrorCode PCApply_HYPRE(PC pc,Vec b,Vec x)
42316d9e3a6SLisandro Dalcin {
42416d9e3a6SLisandro Dalcin   PC_HYPRE           *jac = (PC_HYPRE*)pc->data;
42549a781f5SStefano Zampini   Mat_HYPRE          *hjac = (Mat_HYPRE*)(jac->hpmat->data);
42616d9e3a6SLisandro Dalcin   PetscErrorCode     ierr;
42716d9e3a6SLisandro Dalcin   HYPRE_ParCSRMatrix hmat;
42816d9e3a6SLisandro Dalcin   HYPRE_ParVector    jbv,jxv;
4294ddd07fcSJed Brown   PetscInt           hierr;
43016d9e3a6SLisandro Dalcin 
43116d9e3a6SLisandro Dalcin   PetscFunctionBegin;
432dff31646SBarry Smith   ierr = PetscCitationsRegister(hypreCitation,&cite);CHKERRQ(ierr);
43316d9e3a6SLisandro Dalcin   if (!jac->applyrichardson) {ierr = VecSet(x,0.0);CHKERRQ(ierr);}
4346ea7df73SStefano Zampini   ierr = VecHYPRE_IJVectorPushVecRead(hjac->b,b);CHKERRQ(ierr);
4356ea7df73SStefano Zampini   if (jac->applyrichardson) { ierr = VecHYPRE_IJVectorPushVec(hjac->x,x);CHKERRQ(ierr); }
4366ea7df73SStefano Zampini   else { ierr = VecHYPRE_IJVectorPushVecWrite(hjac->x,x);CHKERRQ(ierr); }
43749a781f5SStefano Zampini   PetscStackCallStandard(HYPRE_IJMatrixGetObject,(hjac->ij,(void**)&hmat));
4386ea7df73SStefano Zampini   PetscStackCallStandard(HYPRE_IJVectorGetObject,(hjac->b->ij,(void**)&jbv));
4396ea7df73SStefano Zampini   PetscStackCallStandard(HYPRE_IJVectorGetObject,(hjac->x->ij,(void**)&jxv));
440fd3f9acdSBarry Smith   PetscStackCall("Hypre solve",hierr = (*jac->solve)(jac->hsolver,hmat,jbv,jxv);
44165e19b50SBarry Smith   if (hierr && hierr != HYPRE_ERROR_CONV) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_LIB,"Error in HYPRE solver, error code %d",hierr);
442fd3f9acdSBarry Smith   if (hierr) hypre__global_error = 0;);
44316d9e3a6SLisandro Dalcin 
44423df4f25SStefano Zampini   if (jac->setup == HYPRE_AMSSetup && jac->ams_beta_is_zero_part) {
4455ac14e1cSStefano Zampini     PetscStackCallStandard(HYPRE_AMSProjectOutGradients,(jac->hsolver,jxv));
44621df291bSStefano Zampini   }
4476ea7df73SStefano Zampini   ierr = VecHYPRE_IJVectorPopVec(hjac->x);CHKERRQ(ierr);
4486ea7df73SStefano Zampini   ierr = VecHYPRE_IJVectorPopVec(hjac->b);CHKERRQ(ierr);
44916d9e3a6SLisandro Dalcin   PetscFunctionReturn(0);
45016d9e3a6SLisandro Dalcin }
45116d9e3a6SLisandro Dalcin 
4528695de01SBarry Smith static PetscErrorCode PCReset_HYPRE(PC pc)
4538695de01SBarry Smith {
4548695de01SBarry Smith   PC_HYPRE       *jac = (PC_HYPRE*)pc->data;
4558695de01SBarry Smith   PetscErrorCode ierr;
4568695de01SBarry Smith 
4578695de01SBarry Smith   PetscFunctionBegin;
45849a781f5SStefano Zampini   ierr = MatDestroy(&jac->hpmat);CHKERRQ(ierr);
4595ac14e1cSStefano Zampini   ierr = MatDestroy(&jac->G);CHKERRQ(ierr);
4605ac14e1cSStefano Zampini   ierr = MatDestroy(&jac->C);CHKERRQ(ierr);
4615ac14e1cSStefano Zampini   ierr = MatDestroy(&jac->alpha_Poisson);CHKERRQ(ierr);
4625ac14e1cSStefano Zampini   ierr = MatDestroy(&jac->beta_Poisson);CHKERRQ(ierr);
4636bf688a0SCe Qin   ierr = MatDestroy(&jac->RT_PiFull);CHKERRQ(ierr);
4646bf688a0SCe Qin   ierr = MatDestroy(&jac->RT_Pi[0]);CHKERRQ(ierr);
4656bf688a0SCe Qin   ierr = MatDestroy(&jac->RT_Pi[1]);CHKERRQ(ierr);
4666bf688a0SCe Qin   ierr = MatDestroy(&jac->RT_Pi[2]);CHKERRQ(ierr);
4676bf688a0SCe Qin   ierr = MatDestroy(&jac->ND_PiFull);CHKERRQ(ierr);
4686bf688a0SCe Qin   ierr = MatDestroy(&jac->ND_Pi[0]);CHKERRQ(ierr);
4696bf688a0SCe Qin   ierr = MatDestroy(&jac->ND_Pi[1]);CHKERRQ(ierr);
4706bf688a0SCe Qin   ierr = MatDestroy(&jac->ND_Pi[2]);CHKERRQ(ierr);
4716ea7df73SStefano Zampini   ierr = VecHYPRE_IJVectorDestroy(&jac->coords[0]);CHKERRQ(ierr);
4726ea7df73SStefano Zampini   ierr = VecHYPRE_IJVectorDestroy(&jac->coords[1]);CHKERRQ(ierr);
4736ea7df73SStefano Zampini   ierr = VecHYPRE_IJVectorDestroy(&jac->coords[2]);CHKERRQ(ierr);
4746ea7df73SStefano Zampini   ierr = VecHYPRE_IJVectorDestroy(&jac->constants[0]);CHKERRQ(ierr);
4756ea7df73SStefano Zampini   ierr = VecHYPRE_IJVectorDestroy(&jac->constants[1]);CHKERRQ(ierr);
4766ea7df73SStefano Zampini   ierr = VecHYPRE_IJVectorDestroy(&jac->constants[2]);CHKERRQ(ierr);
477ce6a8a0dSJed Brown   ierr = PCHYPREResetNearNullSpace_Private(pc);CHKERRQ(ierr);
4785ac14e1cSStefano Zampini   jac->ams_beta_is_zero = PETSC_FALSE;
4795ac14e1cSStefano Zampini   jac->dim = 0;
4808695de01SBarry Smith   PetscFunctionReturn(0);
4818695de01SBarry Smith }
4828695de01SBarry Smith 
48316d9e3a6SLisandro Dalcin static PetscErrorCode PCDestroy_HYPRE(PC pc)
48416d9e3a6SLisandro Dalcin {
48516d9e3a6SLisandro Dalcin   PC_HYPRE                 *jac = (PC_HYPRE*)pc->data;
48616d9e3a6SLisandro Dalcin   PetscErrorCode           ierr;
48716d9e3a6SLisandro Dalcin 
48816d9e3a6SLisandro Dalcin   PetscFunctionBegin;
4898695de01SBarry Smith   ierr = PCReset_HYPRE(pc);CHKERRQ(ierr);
49022e51d31SStefano Zampini   if (jac->destroy) PetscStackCallStandard(jac->destroy,(jac->hsolver));
491503cfb0cSBarry Smith   ierr = PetscFree(jac->hypre_type);CHKERRQ(ierr);
492ffc4695bSBarry Smith   if (jac->comm_hypre != MPI_COMM_NULL) {ierr = MPI_Comm_free(&(jac->comm_hypre));CHKERRMPI(ierr);}
493c31cb41cSBarry Smith   ierr = PetscFree(pc->data);CHKERRQ(ierr);
49416d9e3a6SLisandro Dalcin 
49516d9e3a6SLisandro Dalcin   ierr = PetscObjectChangeTypeName((PetscObject)pc,0);CHKERRQ(ierr);
496bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCHYPRESetType_C",NULL);CHKERRQ(ierr);
497bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCHYPREGetType_C",NULL);CHKERRQ(ierr);
4984cb006feSStefano Zampini   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCHYPRESetCoordinates_C",NULL);CHKERRQ(ierr);
4994cb006feSStefano Zampini   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCHYPRESetDiscreteGradient_C",NULL);CHKERRQ(ierr);
500863406b8SStefano Zampini   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCHYPRESetDiscreteCurl_C",NULL);CHKERRQ(ierr);
5016bf688a0SCe Qin   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCHYPRESetInterpolations_C",NULL);CHKERRQ(ierr);
5024cb006feSStefano Zampini   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCHYPRESetConstantEdgeVectors_C",NULL);CHKERRQ(ierr);
5035ac14e1cSStefano Zampini   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCHYPRESetPoissonMatrix_C",NULL);CHKERRQ(ierr);
504fd2dd295SFande Kong   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCGetInterpolations_C",NULL);CHKERRQ(ierr);
505fd2dd295SFande Kong   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCGetCoarseOperators_C",NULL);CHKERRQ(ierr);
50616d9e3a6SLisandro Dalcin   PetscFunctionReturn(0);
50716d9e3a6SLisandro Dalcin }
50816d9e3a6SLisandro Dalcin 
50916d9e3a6SLisandro Dalcin /* --------------------------------------------------------------------------------------------*/
5104416b707SBarry Smith static PetscErrorCode PCSetFromOptions_HYPRE_Pilut(PetscOptionItems *PetscOptionsObject,PC pc)
51116d9e3a6SLisandro Dalcin {
51216d9e3a6SLisandro Dalcin   PC_HYPRE       *jac = (PC_HYPRE*)pc->data;
51316d9e3a6SLisandro Dalcin   PetscErrorCode ierr;
514ace3abfcSBarry Smith   PetscBool      flag;
51516d9e3a6SLisandro Dalcin 
51616d9e3a6SLisandro Dalcin   PetscFunctionBegin;
517e55864a3SBarry Smith   ierr = PetscOptionsHead(PetscOptionsObject,"HYPRE Pilut Options");CHKERRQ(ierr);
51816d9e3a6SLisandro Dalcin   ierr = PetscOptionsInt("-pc_hypre_pilut_maxiter","Number of iterations","None",jac->maxiter,&jac->maxiter,&flag);CHKERRQ(ierr);
519fd3f9acdSBarry Smith   if (flag) PetscStackCallStandard(HYPRE_ParCSRPilutSetMaxIter,(jac->hsolver,jac->maxiter));
52016d9e3a6SLisandro Dalcin   ierr = PetscOptionsReal("-pc_hypre_pilut_tol","Drop tolerance","None",jac->tol,&jac->tol,&flag);CHKERRQ(ierr);
521fd3f9acdSBarry Smith   if (flag) PetscStackCallStandard(HYPRE_ParCSRPilutSetDropTolerance,(jac->hsolver,jac->tol));
52216d9e3a6SLisandro Dalcin   ierr = PetscOptionsInt("-pc_hypre_pilut_factorrowsize","FactorRowSize","None",jac->factorrowsize,&jac->factorrowsize,&flag);CHKERRQ(ierr);
523fd3f9acdSBarry Smith   if (flag) PetscStackCallStandard(HYPRE_ParCSRPilutSetFactorRowSize,(jac->hsolver,jac->factorrowsize));
52416d9e3a6SLisandro Dalcin   ierr = PetscOptionsTail();CHKERRQ(ierr);
52516d9e3a6SLisandro Dalcin   PetscFunctionReturn(0);
52616d9e3a6SLisandro Dalcin }
52716d9e3a6SLisandro Dalcin 
52816d9e3a6SLisandro Dalcin static PetscErrorCode PCView_HYPRE_Pilut(PC pc,PetscViewer viewer)
52916d9e3a6SLisandro Dalcin {
53016d9e3a6SLisandro Dalcin   PC_HYPRE       *jac = (PC_HYPRE*)pc->data;
53116d9e3a6SLisandro Dalcin   PetscErrorCode ierr;
532ace3abfcSBarry Smith   PetscBool      iascii;
53316d9e3a6SLisandro Dalcin 
53416d9e3a6SLisandro Dalcin   PetscFunctionBegin;
535251f4c67SDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&iascii);CHKERRQ(ierr);
53616d9e3a6SLisandro Dalcin   if (iascii) {
53716d9e3a6SLisandro Dalcin     ierr = PetscViewerASCIIPrintf(viewer,"  HYPRE Pilut preconditioning\n");CHKERRQ(ierr);
53816d9e3a6SLisandro Dalcin     if (jac->maxiter != PETSC_DEFAULT) {
539efd4aadfSBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"    maximum number of iterations %d\n",jac->maxiter);CHKERRQ(ierr);
54016d9e3a6SLisandro Dalcin     } else {
541efd4aadfSBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"    default maximum number of iterations \n");CHKERRQ(ierr);
54216d9e3a6SLisandro Dalcin     }
54316d9e3a6SLisandro Dalcin     if (jac->tol != PETSC_DEFAULT) {
544efd4aadfSBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"    drop tolerance %g\n",(double)jac->tol);CHKERRQ(ierr);
54516d9e3a6SLisandro Dalcin     } else {
546efd4aadfSBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"    default drop tolerance \n");CHKERRQ(ierr);
54716d9e3a6SLisandro Dalcin     }
54816d9e3a6SLisandro Dalcin     if (jac->factorrowsize != PETSC_DEFAULT) {
549efd4aadfSBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"    factor row size %d\n",jac->factorrowsize);CHKERRQ(ierr);
55016d9e3a6SLisandro Dalcin     } else {
551efd4aadfSBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"    default factor row size \n");CHKERRQ(ierr);
55216d9e3a6SLisandro Dalcin     }
55316d9e3a6SLisandro Dalcin   }
55416d9e3a6SLisandro Dalcin   PetscFunctionReturn(0);
55516d9e3a6SLisandro Dalcin }
55616d9e3a6SLisandro Dalcin 
55716d9e3a6SLisandro Dalcin /* --------------------------------------------------------------------------------------------*/
558db966c6cSHong Zhang static PetscErrorCode PCSetFromOptions_HYPRE_Euclid(PetscOptionItems *PetscOptionsObject,PC pc)
559db966c6cSHong Zhang {
560db966c6cSHong Zhang   PC_HYPRE       *jac = (PC_HYPRE*)pc->data;
561db966c6cSHong Zhang   PetscErrorCode ierr;
5628bf83915SBarry Smith   PetscBool      flag,eu_bj = jac->eu_bj ? PETSC_TRUE : PETSC_FALSE;
563db966c6cSHong Zhang 
564db966c6cSHong Zhang   PetscFunctionBegin;
565db966c6cSHong Zhang   ierr = PetscOptionsHead(PetscOptionsObject,"HYPRE Euclid Options");CHKERRQ(ierr);
566db966c6cSHong Zhang   ierr = PetscOptionsInt("-pc_hypre_euclid_level","Factorization levels","None",jac->eu_level,&jac->eu_level,&flag);CHKERRQ(ierr);
567db966c6cSHong Zhang   if (flag) PetscStackCallStandard(HYPRE_EuclidSetLevel,(jac->hsolver,jac->eu_level));
5688bf83915SBarry Smith 
5698bf83915SBarry Smith   ierr = PetscOptionsReal("-pc_hypre_euclid_droptolerance","Drop tolerance for ILU(k) in Euclid","None",jac->eu_droptolerance,&jac->eu_droptolerance,&flag);CHKERRQ(ierr);
5708bf83915SBarry Smith   if (flag) {
5718bf83915SBarry Smith     PetscMPIInt size;
5728bf83915SBarry Smith 
57355b25c41SPierre Jolivet     ierr = MPI_Comm_size(PetscObjectComm((PetscObject)pc),&size);CHKERRMPI(ierr);
5748bf83915SBarry Smith     if (size > 1) SETERRQ(PetscObjectComm((PetscObject)pc),PETSC_ERR_SUP,"hypre's Euclid does not support a parallel drop tolerance");
5758bf83915SBarry Smith     PetscStackCallStandard(HYPRE_EuclidSetILUT,(jac->hsolver,jac->eu_droptolerance));
5768bf83915SBarry Smith   }
5778bf83915SBarry Smith 
5788bf83915SBarry Smith   ierr = PetscOptionsBool("-pc_hypre_euclid_bj", "Use Block Jacobi for ILU in Euclid", "None", eu_bj,&eu_bj,&flag);CHKERRQ(ierr);
5798bf83915SBarry Smith   if (flag) {
5808bf83915SBarry Smith     jac->eu_bj = eu_bj ? 1 : 0;
5818bf83915SBarry Smith     PetscStackCallStandard(HYPRE_EuclidSetBJ,(jac->hsolver,jac->eu_bj));
5828bf83915SBarry Smith   }
583db966c6cSHong Zhang   ierr = PetscOptionsTail();CHKERRQ(ierr);
584db966c6cSHong Zhang   PetscFunctionReturn(0);
585db966c6cSHong Zhang }
586db966c6cSHong Zhang 
587db966c6cSHong Zhang static PetscErrorCode PCView_HYPRE_Euclid(PC pc,PetscViewer viewer)
588db966c6cSHong Zhang {
589db966c6cSHong Zhang   PC_HYPRE       *jac = (PC_HYPRE*)pc->data;
590db966c6cSHong Zhang   PetscErrorCode ierr;
591db966c6cSHong Zhang   PetscBool      iascii;
592db966c6cSHong Zhang 
593db966c6cSHong Zhang   PetscFunctionBegin;
594db966c6cSHong Zhang   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&iascii);CHKERRQ(ierr);
595db966c6cSHong Zhang   if (iascii) {
596db966c6cSHong Zhang     ierr = PetscViewerASCIIPrintf(viewer,"  HYPRE Euclid preconditioning\n");CHKERRQ(ierr);
597db966c6cSHong Zhang     if (jac->eu_level != PETSC_DEFAULT) {
598db966c6cSHong Zhang       ierr = PetscViewerASCIIPrintf(viewer,"    factorization levels %d\n",jac->eu_level);CHKERRQ(ierr);
599db966c6cSHong Zhang     } else {
600db966c6cSHong Zhang       ierr = PetscViewerASCIIPrintf(viewer,"    default factorization levels \n");CHKERRQ(ierr);
601db966c6cSHong Zhang     }
6028bf83915SBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"    drop tolerance %g\n",(double)jac->eu_droptolerance);CHKERRQ(ierr);
6038bf83915SBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"    use Block-Jacobi? %D\n",jac->eu_bj);CHKERRQ(ierr);
604db966c6cSHong Zhang   }
605db966c6cSHong Zhang   PetscFunctionReturn(0);
606db966c6cSHong Zhang }
607db966c6cSHong Zhang 
608db966c6cSHong Zhang /* --------------------------------------------------------------------------------------------*/
60916d9e3a6SLisandro Dalcin 
61016d9e3a6SLisandro Dalcin static PetscErrorCode PCApplyTranspose_HYPRE_BoomerAMG(PC pc,Vec b,Vec x)
61116d9e3a6SLisandro Dalcin {
61216d9e3a6SLisandro Dalcin   PC_HYPRE           *jac = (PC_HYPRE*)pc->data;
61349a781f5SStefano Zampini   Mat_HYPRE          *hjac = (Mat_HYPRE*)(jac->hpmat->data);
61416d9e3a6SLisandro Dalcin   PetscErrorCode     ierr;
61516d9e3a6SLisandro Dalcin   HYPRE_ParCSRMatrix hmat;
61616d9e3a6SLisandro Dalcin   HYPRE_ParVector    jbv,jxv;
6174ddd07fcSJed Brown   PetscInt           hierr;
61816d9e3a6SLisandro Dalcin 
61916d9e3a6SLisandro Dalcin   PetscFunctionBegin;
620dff31646SBarry Smith   ierr = PetscCitationsRegister(hypreCitation,&cite);CHKERRQ(ierr);
62116d9e3a6SLisandro Dalcin   ierr = VecSet(x,0.0);CHKERRQ(ierr);
6226ea7df73SStefano Zampini   ierr = VecHYPRE_IJVectorPushVecRead(hjac->x,b);CHKERRQ(ierr);
6236ea7df73SStefano Zampini   ierr = VecHYPRE_IJVectorPushVecWrite(hjac->b,x);CHKERRQ(ierr);
62416d9e3a6SLisandro Dalcin 
62549a781f5SStefano Zampini   PetscStackCallStandard(HYPRE_IJMatrixGetObject,(hjac->ij,(void**)&hmat));
6266ea7df73SStefano Zampini   PetscStackCallStandard(HYPRE_IJVectorGetObject,(hjac->b->ij,(void**)&jbv));
6276ea7df73SStefano Zampini   PetscStackCallStandard(HYPRE_IJVectorGetObject,(hjac->x->ij,(void**)&jxv));
62816d9e3a6SLisandro Dalcin 
6296ea7df73SStefano Zampini   hierr = HYPRE_BoomerAMGSolveT(jac->hsolver,hmat,jxv,jbv);
63016d9e3a6SLisandro Dalcin   /* error code of 1 in BoomerAMG merely means convergence not achieved */
631e32f2f54SBarry Smith   if (hierr && (hierr != 1)) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_LIB,"Error in HYPRE solver, error code %d",hierr);
63216d9e3a6SLisandro Dalcin   if (hierr) hypre__global_error = 0;
63316d9e3a6SLisandro Dalcin 
6346ea7df73SStefano Zampini   ierr = VecHYPRE_IJVectorPopVec(hjac->x);CHKERRQ(ierr);
6356ea7df73SStefano Zampini   ierr = VecHYPRE_IJVectorPopVec(hjac->b);CHKERRQ(ierr);
63616d9e3a6SLisandro Dalcin   PetscFunctionReturn(0);
63716d9e3a6SLisandro Dalcin }
63816d9e3a6SLisandro Dalcin 
639a669f990SJed Brown /* static array length */
640a669f990SJed Brown #define ALEN(a) (sizeof(a)/sizeof((a)[0]))
641a669f990SJed Brown 
64216d9e3a6SLisandro Dalcin static const char *HYPREBoomerAMGCycleType[]   = {"","V","W"};
6430f1074feSSatish Balay static const char *HYPREBoomerAMGCoarsenType[] = {"CLJP","Ruge-Stueben","","modifiedRuge-Stueben","","","Falgout", "", "PMIS", "", "HMIS"};
64416d9e3a6SLisandro Dalcin static const char *HYPREBoomerAMGMeasureType[] = {"local","global"};
64565de4495SJed Brown /* The following corresponds to HYPRE_BoomerAMGSetRelaxType which has many missing numbers in the enum */
6466a251517SEike Mueller static const char *HYPREBoomerAMGSmoothType[]  = {"Schwarz-smoothers","Pilut","ParaSails","Euclid"};
64765de4495SJed Brown static const char *HYPREBoomerAMGRelaxType[]   = {"Jacobi","sequential-Gauss-Seidel","seqboundary-Gauss-Seidel","SOR/Jacobi","backward-SOR/Jacobi",
64865de4495SJed Brown                                                   "" /* [5] hybrid chaotic Gauss-Seidel (works only with OpenMP) */,"symmetric-SOR/Jacobi",
64965de4495SJed Brown                                                   "" /* 7 */,"l1scaled-SOR/Jacobi","Gaussian-elimination",
6507b7fa87dSPierre Jolivet                                                   "" /* 10 */, "" /* 11 */, "" /* 12 */, "l1-Gauss-Seidel" /* nonsymmetric */, "backward-l1-Gauss-Seidel" /* nonsymmetric */,
65165de4495SJed Brown                                                   "CG" /* non-stationary */,"Chebyshev","FCF-Jacobi","l1scaled-Jacobi"};
6520f1074feSSatish Balay static const char *HYPREBoomerAMGInterpType[]  = {"classical", "", "", "direct", "multipass", "multipass-wts", "ext+i",
653589dcaf0SStefano Zampini                                                   "ext+i-cc", "standard", "standard-wts", "block", "block-wtd", "FF", "FF1",
654589dcaf0SStefano Zampini                                                   "ext", "ad-wts", "ext-mm", "ext+i-mm", "ext+e-mm"};
6554416b707SBarry Smith static PetscErrorCode PCSetFromOptions_HYPRE_BoomerAMG(PetscOptionItems *PetscOptionsObject,PC pc)
65616d9e3a6SLisandro Dalcin {
65716d9e3a6SLisandro Dalcin   PC_HYPRE       *jac = (PC_HYPRE*)pc->data;
65816d9e3a6SLisandro Dalcin   PetscErrorCode ierr;
65922e51d31SStefano Zampini   PetscInt       bs,n,indx,level;
660ace3abfcSBarry Smith   PetscBool      flg, tmp_truth;
66116d9e3a6SLisandro Dalcin   double         tmpdbl, twodbl[2];
662589dcaf0SStefano Zampini   const char     *symtlist[] = {"nonsymmetric","SPD","nonsymmetric,SPD"};
66316d9e3a6SLisandro Dalcin 
66416d9e3a6SLisandro Dalcin   PetscFunctionBegin;
665e55864a3SBarry Smith   ierr = PetscOptionsHead(PetscOptionsObject,"HYPRE BoomerAMG Options");CHKERRQ(ierr);
6664336a9eeSBarry Smith   ierr = PetscOptionsEList("-pc_hypre_boomeramg_cycle_type","Cycle type","None",HYPREBoomerAMGCycleType+1,2,HYPREBoomerAMGCycleType[jac->cycletype],&indx,&flg);CHKERRQ(ierr);
66716d9e3a6SLisandro Dalcin   if (flg) {
6684336a9eeSBarry Smith     jac->cycletype = indx+1;
669fd3f9acdSBarry Smith     PetscStackCallStandard(HYPRE_BoomerAMGSetCycleType,(jac->hsolver,jac->cycletype));
67016d9e3a6SLisandro Dalcin   }
67116d9e3a6SLisandro Dalcin   ierr = PetscOptionsInt("-pc_hypre_boomeramg_max_levels","Number of levels (of grids) allowed","None",jac->maxlevels,&jac->maxlevels,&flg);CHKERRQ(ierr);
67216d9e3a6SLisandro Dalcin   if (flg) {
673ce94432eSBarry Smith     if (jac->maxlevels < 2) SETERRQ1(PetscObjectComm((PetscObject)pc),PETSC_ERR_ARG_OUTOFRANGE,"Number of levels %d must be at least two",jac->maxlevels);
674fd3f9acdSBarry Smith     PetscStackCallStandard(HYPRE_BoomerAMGSetMaxLevels,(jac->hsolver,jac->maxlevels));
67516d9e3a6SLisandro Dalcin   }
67616d9e3a6SLisandro Dalcin   ierr = PetscOptionsInt("-pc_hypre_boomeramg_max_iter","Maximum iterations used PER hypre call","None",jac->maxiter,&jac->maxiter,&flg);CHKERRQ(ierr);
67716d9e3a6SLisandro Dalcin   if (flg) {
678ce94432eSBarry Smith     if (jac->maxiter < 1) SETERRQ1(PetscObjectComm((PetscObject)pc),PETSC_ERR_ARG_OUTOFRANGE,"Number of iterations %d must be at least one",jac->maxiter);
679fd3f9acdSBarry Smith     PetscStackCallStandard(HYPRE_BoomerAMGSetMaxIter,(jac->hsolver,jac->maxiter));
68016d9e3a6SLisandro Dalcin   }
68139accc25SStefano Zampini   ierr = PetscOptionsReal("-pc_hypre_boomeramg_tol","Convergence tolerance PER hypre call (0.0 = use a fixed number of iterations)","None",jac->tol,&jac->tol,&flg);CHKERRQ(ierr);
68216d9e3a6SLisandro Dalcin   if (flg) {
68357622a8eSBarry Smith     if (jac->tol < 0.0) SETERRQ1(PetscObjectComm((PetscObject)pc),PETSC_ERR_ARG_OUTOFRANGE,"Tolerance %g must be greater than or equal to zero",(double)jac->tol);
684fd3f9acdSBarry Smith     PetscStackCallStandard(HYPRE_BoomerAMGSetTol,(jac->hsolver,jac->tol));
68516d9e3a6SLisandro Dalcin   }
68622e51d31SStefano Zampini   bs = 1;
68722e51d31SStefano Zampini   if (pc->pmat) {
68822e51d31SStefano Zampini     ierr = MatGetBlockSize(pc->pmat,&bs);CHKERRQ(ierr);
68922e51d31SStefano Zampini   }
69022e51d31SStefano Zampini   ierr = PetscOptionsInt("-pc_hypre_boomeramg_numfunctions","Number of functions","HYPRE_BoomerAMGSetNumFunctions",bs,&bs,&flg);CHKERRQ(ierr);
69122e51d31SStefano Zampini   if (flg) {
69222e51d31SStefano Zampini     PetscStackCallStandard(HYPRE_BoomerAMGSetNumFunctions,(jac->hsolver,bs));
69322e51d31SStefano Zampini   }
69416d9e3a6SLisandro Dalcin 
69539accc25SStefano Zampini   ierr = PetscOptionsReal("-pc_hypre_boomeramg_truncfactor","Truncation factor for interpolation (0=no truncation)","None",jac->truncfactor,&jac->truncfactor,&flg);CHKERRQ(ierr);
69616d9e3a6SLisandro Dalcin   if (flg) {
69757622a8eSBarry Smith     if (jac->truncfactor < 0.0) SETERRQ1(PetscObjectComm((PetscObject)pc),PETSC_ERR_ARG_OUTOFRANGE,"Truncation factor %g must be great than or equal zero",(double)jac->truncfactor);
698fd3f9acdSBarry Smith     PetscStackCallStandard(HYPRE_BoomerAMGSetTruncFactor,(jac->hsolver,jac->truncfactor));
69916d9e3a6SLisandro Dalcin   }
70016d9e3a6SLisandro Dalcin 
7010f1074feSSatish Balay   ierr = PetscOptionsInt("-pc_hypre_boomeramg_P_max","Max elements per row for interpolation operator (0=unlimited)","None",jac->pmax,&jac->pmax,&flg);CHKERRQ(ierr);
7020f1074feSSatish Balay   if (flg) {
703*f8add624SPierre Jolivet     if (jac->pmax < 0) SETERRQ1(PetscObjectComm((PetscObject)pc),PETSC_ERR_ARG_OUTOFRANGE,"P_max %D must be greater than or equal to zero",jac->pmax);
704fd3f9acdSBarry Smith     PetscStackCallStandard(HYPRE_BoomerAMGSetPMaxElmts,(jac->hsolver,jac->pmax));
7050f1074feSSatish Balay   }
7060f1074feSSatish Balay 
707*f8add624SPierre Jolivet   ierr = PetscOptionsRangeInt("-pc_hypre_boomeramg_agg_nl","Number of levels of aggressive coarsening","None",jac->agg_nl,&jac->agg_nl,&flg,0,jac->maxlevels);CHKERRQ(ierr);
708*f8add624SPierre Jolivet   if (flg) PetscStackCallStandard(HYPRE_BoomerAMGSetAggNumLevels,(jac->hsolver,jac->agg_nl));
7090f1074feSSatish Balay 
7100f1074feSSatish Balay   ierr = PetscOptionsInt("-pc_hypre_boomeramg_agg_num_paths","Number of paths for aggressive coarsening","None",jac->agg_num_paths,&jac->agg_num_paths,&flg);CHKERRQ(ierr);
7110f1074feSSatish Balay   if (flg) {
712*f8add624SPierre Jolivet     if (jac->agg_num_paths < 1) SETERRQ1(PetscObjectComm((PetscObject)pc),PETSC_ERR_ARG_OUTOFRANGE,"Number of paths %D must be greater than or equal to 1",jac->agg_num_paths);
713fd3f9acdSBarry Smith     PetscStackCallStandard(HYPRE_BoomerAMGSetNumPaths,(jac->hsolver,jac->agg_num_paths));
7140f1074feSSatish Balay   }
7150f1074feSSatish Balay 
71639accc25SStefano Zampini   ierr = PetscOptionsReal("-pc_hypre_boomeramg_strong_threshold","Threshold for being strongly connected","None",jac->strongthreshold,&jac->strongthreshold,&flg);CHKERRQ(ierr);
71716d9e3a6SLisandro Dalcin   if (flg) {
71857622a8eSBarry Smith     if (jac->strongthreshold < 0.0) SETERRQ1(PetscObjectComm((PetscObject)pc),PETSC_ERR_ARG_OUTOFRANGE,"Strong threshold %g must be great than or equal zero",(double)jac->strongthreshold);
719fd3f9acdSBarry Smith     PetscStackCallStandard(HYPRE_BoomerAMGSetStrongThreshold,(jac->hsolver,jac->strongthreshold));
72016d9e3a6SLisandro Dalcin   }
72139accc25SStefano Zampini   ierr = PetscOptionsReal("-pc_hypre_boomeramg_max_row_sum","Maximum row sum","None",jac->maxrowsum,&jac->maxrowsum,&flg);CHKERRQ(ierr);
72216d9e3a6SLisandro Dalcin   if (flg) {
72357622a8eSBarry Smith     if (jac->maxrowsum < 0.0) SETERRQ1(PetscObjectComm((PetscObject)pc),PETSC_ERR_ARG_OUTOFRANGE,"Maximum row sum %g must be greater than zero",(double)jac->maxrowsum);
72457622a8eSBarry Smith     if (jac->maxrowsum > 1.0) SETERRQ1(PetscObjectComm((PetscObject)pc),PETSC_ERR_ARG_OUTOFRANGE,"Maximum row sum %g must be less than or equal one",(double)jac->maxrowsum);
725fd3f9acdSBarry Smith     PetscStackCallStandard(HYPRE_BoomerAMGSetMaxRowSum,(jac->hsolver,jac->maxrowsum));
72616d9e3a6SLisandro Dalcin   }
72716d9e3a6SLisandro Dalcin 
72816d9e3a6SLisandro Dalcin   /* Grid sweeps */
7290f1074feSSatish Balay   ierr = PetscOptionsInt("-pc_hypre_boomeramg_grid_sweeps_all","Number of sweeps for the up and down grid levels","None",jac->gridsweeps[0],&indx,&flg);CHKERRQ(ierr);
73016d9e3a6SLisandro Dalcin   if (flg) {
731fd3f9acdSBarry Smith     PetscStackCallStandard(HYPRE_BoomerAMGSetNumSweeps,(jac->hsolver,indx));
73216d9e3a6SLisandro Dalcin     /* modify the jac structure so we can view the updated options with PC_View */
73316d9e3a6SLisandro Dalcin     jac->gridsweeps[0] = indx;
7340f1074feSSatish Balay     jac->gridsweeps[1] = indx;
7350f1074feSSatish Balay     /*defaults coarse to 1 */
7360f1074feSSatish Balay     jac->gridsweeps[2] = 1;
73716d9e3a6SLisandro Dalcin   }
7385272c319SBarry Smith   ierr = PetscOptionsInt("-pc_hypre_boomeramg_nodal_coarsen","Use a nodal based coarsening 1-6","HYPRE_BoomerAMGSetNodal",jac->nodal_coarsening,&jac->nodal_coarsening,&flg);CHKERRQ(ierr);
7395272c319SBarry Smith   if (flg) {
7405272c319SBarry Smith     PetscStackCallStandard(HYPRE_BoomerAMGSetNodal,(jac->hsolver,jac->nodal_coarsening));
7415272c319SBarry Smith   }
74222e51d31SStefano Zampini   ierr = PetscOptionsInt("-pc_hypre_boomeramg_nodal_coarsen_diag","Diagonal in strength matrix for nodal based coarsening 0-2","HYPRE_BoomerAMGSetNodalDiag",jac->nodal_coarsening_diag,&jac->nodal_coarsening_diag,&flg);CHKERRQ(ierr);
74322e51d31SStefano Zampini   if (flg) {
74422e51d31SStefano Zampini     PetscStackCallStandard(HYPRE_BoomerAMGSetNodalDiag,(jac->hsolver,jac->nodal_coarsening_diag));
74522e51d31SStefano Zampini   }
746cbc39033SBarry Smith   ierr = PetscOptionsInt("-pc_hypre_boomeramg_vec_interp_variant","Variant of algorithm 1-3","HYPRE_BoomerAMGSetInterpVecVariant",jac->vec_interp_variant, &jac->vec_interp_variant,&flg);CHKERRQ(ierr);
7475272c319SBarry Smith   if (flg) {
7485272c319SBarry Smith     PetscStackCallStandard(HYPRE_BoomerAMGSetInterpVecVariant,(jac->hsolver,jac->vec_interp_variant));
7495272c319SBarry Smith   }
75022e51d31SStefano Zampini   ierr = PetscOptionsInt("-pc_hypre_boomeramg_vec_interp_qmax","Max elements per row for each Q","HYPRE_BoomerAMGSetInterpVecQMax",jac->vec_interp_qmax, &jac->vec_interp_qmax,&flg);CHKERRQ(ierr);
75122e51d31SStefano Zampini   if (flg) {
75222e51d31SStefano Zampini     PetscStackCallStandard(HYPRE_BoomerAMGSetInterpVecQMax,(jac->hsolver,jac->vec_interp_qmax));
75322e51d31SStefano Zampini   }
75422e51d31SStefano Zampini   ierr = PetscOptionsBool("-pc_hypre_boomeramg_vec_interp_smooth","Whether to smooth the interpolation vectors","HYPRE_BoomerAMGSetSmoothInterpVectors",jac->vec_interp_smooth, &jac->vec_interp_smooth,&flg);CHKERRQ(ierr);
75522e51d31SStefano Zampini   if (flg) {
75622e51d31SStefano Zampini     PetscStackCallStandard(HYPRE_BoomerAMGSetSmoothInterpVectors,(jac->hsolver,jac->vec_interp_smooth));
75722e51d31SStefano Zampini   }
75822e51d31SStefano Zampini   ierr = PetscOptionsInt("-pc_hypre_boomeramg_interp_refine","Preprocess the interpolation matrix through iterative weight refinement","HYPRE_BoomerAMGSetInterpRefine",jac->interp_refine, &jac->interp_refine,&flg);CHKERRQ(ierr);
75922e51d31SStefano Zampini   if (flg) {
76022e51d31SStefano Zampini     PetscStackCallStandard(HYPRE_BoomerAMGSetInterpRefine,(jac->hsolver,jac->interp_refine));
76122e51d31SStefano Zampini   }
7620f1074feSSatish Balay   ierr = PetscOptionsInt("-pc_hypre_boomeramg_grid_sweeps_down","Number of sweeps for the down cycles","None",jac->gridsweeps[0], &indx,&flg);CHKERRQ(ierr);
76316d9e3a6SLisandro Dalcin   if (flg) {
764fd3f9acdSBarry Smith     PetscStackCallStandard(HYPRE_BoomerAMGSetCycleNumSweeps,(jac->hsolver,indx, 1));
7650f1074feSSatish Balay     jac->gridsweeps[0] = indx;
76616d9e3a6SLisandro Dalcin   }
76716d9e3a6SLisandro Dalcin   ierr = PetscOptionsInt("-pc_hypre_boomeramg_grid_sweeps_up","Number of sweeps for the up cycles","None",jac->gridsweeps[1],&indx,&flg);CHKERRQ(ierr);
76816d9e3a6SLisandro Dalcin   if (flg) {
769fd3f9acdSBarry Smith     PetscStackCallStandard(HYPRE_BoomerAMGSetCycleNumSweeps,(jac->hsolver,indx, 2));
7700f1074feSSatish Balay     jac->gridsweeps[1] = indx;
77116d9e3a6SLisandro Dalcin   }
7720f1074feSSatish Balay   ierr = PetscOptionsInt("-pc_hypre_boomeramg_grid_sweeps_coarse","Number of sweeps for the coarse level","None",jac->gridsweeps[2],&indx,&flg);CHKERRQ(ierr);
77316d9e3a6SLisandro Dalcin   if (flg) {
774fd3f9acdSBarry Smith     PetscStackCallStandard(HYPRE_BoomerAMGSetCycleNumSweeps,(jac->hsolver,indx, 3));
7750f1074feSSatish Balay     jac->gridsweeps[2] = indx;
77616d9e3a6SLisandro Dalcin   }
77716d9e3a6SLisandro Dalcin 
7786a251517SEike Mueller   /* Smooth type */
7791e1ea65dSPierre Jolivet   ierr = PetscOptionsEList("-pc_hypre_boomeramg_smooth_type","Enable more complex smoothers","None",HYPREBoomerAMGSmoothType,ALEN(HYPREBoomerAMGSmoothType),HYPREBoomerAMGSmoothType[0],&indx,&flg);CHKERRQ(ierr);
7806a251517SEike Mueller   if (flg) {
7816a251517SEike Mueller     jac->smoothtype = indx;
7826a251517SEike Mueller     PetscStackCallStandard(HYPRE_BoomerAMGSetSmoothType,(jac->hsolver,indx+6));
7838131ecf7SEike Mueller     jac->smoothnumlevels = 25;
7848131ecf7SEike Mueller     PetscStackCallStandard(HYPRE_BoomerAMGSetSmoothNumLevels,(jac->hsolver,25));
7858131ecf7SEike Mueller   }
7868131ecf7SEike Mueller 
7878131ecf7SEike Mueller   /* Number of smoothing levels */
7888131ecf7SEike Mueller   ierr = PetscOptionsInt("-pc_hypre_boomeramg_smooth_num_levels","Number of levels on which more complex smoothers are used","None",25,&indx,&flg);CHKERRQ(ierr);
7898131ecf7SEike Mueller   if (flg && (jac->smoothtype != -1)) {
7908131ecf7SEike Mueller     jac->smoothnumlevels = indx;
7918131ecf7SEike Mueller     PetscStackCallStandard(HYPRE_BoomerAMGSetSmoothNumLevels,(jac->hsolver,indx));
7926a251517SEike Mueller   }
7936a251517SEike Mueller 
7941810e44eSEike Mueller   /* Number of levels for ILU(k) for Euclid */
7951810e44eSEike Mueller   ierr = PetscOptionsInt("-pc_hypre_boomeramg_eu_level","Number of levels for ILU(k) in Euclid smoother","None",0,&indx,&flg);CHKERRQ(ierr);
7961810e44eSEike Mueller   if (flg && (jac->smoothtype == 3)) {
7971810e44eSEike Mueller     jac->eu_level = indx;
7981810e44eSEike Mueller     PetscStackCallStandard(HYPRE_BoomerAMGSetEuLevel,(jac->hsolver,indx));
7991810e44eSEike Mueller   }
8001810e44eSEike Mueller 
8011810e44eSEike Mueller   /* Filter for ILU(k) for Euclid */
8021810e44eSEike Mueller   double droptolerance;
80339accc25SStefano Zampini   ierr = PetscOptionsReal("-pc_hypre_boomeramg_eu_droptolerance","Drop tolerance for ILU(k) in Euclid smoother","None",0,&droptolerance,&flg);CHKERRQ(ierr);
8041810e44eSEike Mueller   if (flg && (jac->smoothtype == 3)) {
8051810e44eSEike Mueller     jac->eu_droptolerance = droptolerance;
8061810e44eSEike Mueller     PetscStackCallStandard(HYPRE_BoomerAMGSetEuLevel,(jac->hsolver,droptolerance));
8071810e44eSEike Mueller   }
8081810e44eSEike Mueller 
8091810e44eSEike Mueller   /* Use Block Jacobi ILUT for Euclid */
8101810e44eSEike Mueller   ierr = PetscOptionsBool("-pc_hypre_boomeramg_eu_bj", "Use Block Jacobi for ILU in Euclid smoother?", "None", PETSC_FALSE, &tmp_truth, &flg);CHKERRQ(ierr);
8111810e44eSEike Mueller   if (flg && (jac->smoothtype == 3)) {
8121810e44eSEike Mueller     jac->eu_bj = tmp_truth;
813493fc9d9SEike Mueller     PetscStackCallStandard(HYPRE_BoomerAMGSetEuBJ,(jac->hsolver,jac->eu_bj));
8141810e44eSEike Mueller   }
8151810e44eSEike Mueller 
81616d9e3a6SLisandro Dalcin   /* Relax type */
817a669f990SJed Brown   ierr = PetscOptionsEList("-pc_hypre_boomeramg_relax_type_all","Relax type for the up and down cycles","None",HYPREBoomerAMGRelaxType,ALEN(HYPREBoomerAMGRelaxType),HYPREBoomerAMGRelaxType[6],&indx,&flg);CHKERRQ(ierr);
81816d9e3a6SLisandro Dalcin   if (flg) {
8190f1074feSSatish Balay     jac->relaxtype[0] = jac->relaxtype[1]  = indx;
820fd3f9acdSBarry Smith     PetscStackCallStandard(HYPRE_BoomerAMGSetRelaxType,(jac->hsolver, indx));
8210f1074feSSatish Balay     /* by default, coarse type set to 9 */
8220f1074feSSatish Balay     jac->relaxtype[2] = 9;
823ddbeb582SStefano Zampini     PetscStackCallStandard(HYPRE_BoomerAMGSetCycleRelaxType,(jac->hsolver, 9, 3));
82416d9e3a6SLisandro Dalcin   }
825a669f990SJed Brown   ierr = PetscOptionsEList("-pc_hypre_boomeramg_relax_type_down","Relax type for the down cycles","None",HYPREBoomerAMGRelaxType,ALEN(HYPREBoomerAMGRelaxType),HYPREBoomerAMGRelaxType[6],&indx,&flg);CHKERRQ(ierr);
82616d9e3a6SLisandro Dalcin   if (flg) {
82716d9e3a6SLisandro Dalcin     jac->relaxtype[0] = indx;
828fd3f9acdSBarry Smith     PetscStackCallStandard(HYPRE_BoomerAMGSetCycleRelaxType,(jac->hsolver, indx, 1));
82916d9e3a6SLisandro Dalcin   }
830a669f990SJed Brown   ierr = PetscOptionsEList("-pc_hypre_boomeramg_relax_type_up","Relax type for the up cycles","None",HYPREBoomerAMGRelaxType,ALEN(HYPREBoomerAMGRelaxType),HYPREBoomerAMGRelaxType[6],&indx,&flg);CHKERRQ(ierr);
83116d9e3a6SLisandro Dalcin   if (flg) {
8320f1074feSSatish Balay     jac->relaxtype[1] = indx;
833fd3f9acdSBarry Smith     PetscStackCallStandard(HYPRE_BoomerAMGSetCycleRelaxType,(jac->hsolver, indx, 2));
83416d9e3a6SLisandro Dalcin   }
835a669f990SJed Brown   ierr = PetscOptionsEList("-pc_hypre_boomeramg_relax_type_coarse","Relax type on coarse grid","None",HYPREBoomerAMGRelaxType,ALEN(HYPREBoomerAMGRelaxType),HYPREBoomerAMGRelaxType[9],&indx,&flg);CHKERRQ(ierr);
83616d9e3a6SLisandro Dalcin   if (flg) {
8370f1074feSSatish Balay     jac->relaxtype[2] = indx;
838fd3f9acdSBarry Smith     PetscStackCallStandard(HYPRE_BoomerAMGSetCycleRelaxType,(jac->hsolver, indx, 3));
83916d9e3a6SLisandro Dalcin   }
84016d9e3a6SLisandro Dalcin 
84116d9e3a6SLisandro Dalcin   /* Relaxation Weight */
84216d9e3a6SLisandro Dalcin   ierr = PetscOptionsReal("-pc_hypre_boomeramg_relax_weight_all","Relaxation weight for all levels (0 = hypre estimates, -k = determined with k CG steps)","None",jac->relaxweight, &tmpdbl,&flg);CHKERRQ(ierr);
84316d9e3a6SLisandro Dalcin   if (flg) {
844fd3f9acdSBarry Smith     PetscStackCallStandard(HYPRE_BoomerAMGSetRelaxWt,(jac->hsolver,tmpdbl));
84516d9e3a6SLisandro Dalcin     jac->relaxweight = tmpdbl;
84616d9e3a6SLisandro Dalcin   }
84716d9e3a6SLisandro Dalcin 
84816d9e3a6SLisandro Dalcin   n         = 2;
84916d9e3a6SLisandro Dalcin   twodbl[0] = twodbl[1] = 1.0;
85016d9e3a6SLisandro Dalcin   ierr      = PetscOptionsRealArray("-pc_hypre_boomeramg_relax_weight_level","Set the relaxation weight for a particular level (weight,level)","None",twodbl, &n, &flg);CHKERRQ(ierr);
85116d9e3a6SLisandro Dalcin   if (flg) {
85216d9e3a6SLisandro Dalcin     if (n == 2) {
85316d9e3a6SLisandro Dalcin       indx =  (int)PetscAbsReal(twodbl[1]);
854fd3f9acdSBarry Smith       PetscStackCallStandard(HYPRE_BoomerAMGSetLevelRelaxWt,(jac->hsolver,twodbl[0],indx));
855ce94432eSBarry Smith     } else SETERRQ1(PetscObjectComm((PetscObject)pc),PETSC_ERR_ARG_OUTOFRANGE,"Relax weight level: you must provide 2 values separated by a comma (and no space), you provided %d",n);
85616d9e3a6SLisandro Dalcin   }
85716d9e3a6SLisandro Dalcin 
85816d9e3a6SLisandro Dalcin   /* Outer relaxation Weight */
85916d9e3a6SLisandro Dalcin   ierr = PetscOptionsReal("-pc_hypre_boomeramg_outer_relax_weight_all","Outer relaxation weight for all levels (-k = determined with k CG steps)","None",jac->outerrelaxweight, &tmpdbl,&flg);CHKERRQ(ierr);
86016d9e3a6SLisandro Dalcin   if (flg) {
861fd3f9acdSBarry Smith     PetscStackCallStandard(HYPRE_BoomerAMGSetOuterWt,(jac->hsolver, tmpdbl));
86216d9e3a6SLisandro Dalcin     jac->outerrelaxweight = tmpdbl;
86316d9e3a6SLisandro Dalcin   }
86416d9e3a6SLisandro Dalcin 
86516d9e3a6SLisandro Dalcin   n         = 2;
86616d9e3a6SLisandro Dalcin   twodbl[0] = twodbl[1] = 1.0;
86716d9e3a6SLisandro Dalcin   ierr      = PetscOptionsRealArray("-pc_hypre_boomeramg_outer_relax_weight_level","Set the outer relaxation weight for a particular level (weight,level)","None",twodbl, &n, &flg);CHKERRQ(ierr);
86816d9e3a6SLisandro Dalcin   if (flg) {
86916d9e3a6SLisandro Dalcin     if (n == 2) {
87016d9e3a6SLisandro Dalcin       indx =  (int)PetscAbsReal(twodbl[1]);
871fd3f9acdSBarry Smith       PetscStackCallStandard(HYPRE_BoomerAMGSetLevelOuterWt,(jac->hsolver, twodbl[0], indx));
872ce94432eSBarry Smith     } else SETERRQ1(PetscObjectComm((PetscObject)pc),PETSC_ERR_ARG_OUTOFRANGE,"Relax weight outer level: You must provide 2 values separated by a comma (and no space), you provided %d",n);
87316d9e3a6SLisandro Dalcin   }
87416d9e3a6SLisandro Dalcin 
87516d9e3a6SLisandro Dalcin   /* the Relax Order */
876acfcf0e5SJed Brown   ierr = PetscOptionsBool("-pc_hypre_boomeramg_no_CF", "Do not use CF-relaxation", "None", PETSC_FALSE, &tmp_truth, &flg);CHKERRQ(ierr);
87716d9e3a6SLisandro Dalcin 
8788afaa268SBarry Smith   if (flg && tmp_truth) {
87916d9e3a6SLisandro Dalcin     jac->relaxorder = 0;
880fd3f9acdSBarry Smith     PetscStackCallStandard(HYPRE_BoomerAMGSetRelaxOrder,(jac->hsolver, jac->relaxorder));
88116d9e3a6SLisandro Dalcin   }
882a669f990SJed Brown   ierr = PetscOptionsEList("-pc_hypre_boomeramg_measure_type","Measure type","None",HYPREBoomerAMGMeasureType,ALEN(HYPREBoomerAMGMeasureType),HYPREBoomerAMGMeasureType[0],&indx,&flg);CHKERRQ(ierr);
88316d9e3a6SLisandro Dalcin   if (flg) {
88416d9e3a6SLisandro Dalcin     jac->measuretype = indx;
885fd3f9acdSBarry Smith     PetscStackCallStandard(HYPRE_BoomerAMGSetMeasureType,(jac->hsolver,jac->measuretype));
88616d9e3a6SLisandro Dalcin   }
8870f1074feSSatish Balay   /* update list length 3/07 */
888a669f990SJed Brown   ierr = PetscOptionsEList("-pc_hypre_boomeramg_coarsen_type","Coarsen type","None",HYPREBoomerAMGCoarsenType,ALEN(HYPREBoomerAMGCoarsenType),HYPREBoomerAMGCoarsenType[6],&indx,&flg);CHKERRQ(ierr);
88916d9e3a6SLisandro Dalcin   if (flg) {
89016d9e3a6SLisandro Dalcin     jac->coarsentype = indx;
891fd3f9acdSBarry Smith     PetscStackCallStandard(HYPRE_BoomerAMGSetCoarsenType,(jac->hsolver,jac->coarsentype));
89216d9e3a6SLisandro Dalcin   }
8930f1074feSSatish Balay 
894589dcaf0SStefano Zampini   ierr = PetscOptionsInt("-pc_hypre_boomeramg_max_coarse_size", "Maximum size of coarsest grid", "None", jac->maxc, &jac->maxc, &flg);CHKERRQ(ierr);
895589dcaf0SStefano Zampini   if (flg) {
896589dcaf0SStefano Zampini     PetscStackCallStandard(HYPRE_BoomerAMGSetMaxCoarseSize,(jac->hsolver, jac->maxc));
897589dcaf0SStefano Zampini   }
898589dcaf0SStefano Zampini   ierr = PetscOptionsInt("-pc_hypre_boomeramg_min_coarse_size", "Minimum size of coarsest grid", "None", jac->minc, &jac->minc, &flg);CHKERRQ(ierr);
899589dcaf0SStefano Zampini   if (flg) {
900589dcaf0SStefano Zampini     PetscStackCallStandard(HYPRE_BoomerAMGSetMinCoarseSize,(jac->hsolver, jac->minc));
901589dcaf0SStefano Zampini   }
902589dcaf0SStefano Zampini 
903589dcaf0SStefano Zampini   /* AIR */
904589dcaf0SStefano Zampini #if PETSC_PKG_HYPRE_VERSION_GE(2,18,0)
905589dcaf0SStefano Zampini   ierr = PetscOptionsInt("-pc_hypre_boomeramg_restriction_type", "Type of AIR method (distance 1 or 2, 0 means no AIR)", "None", jac->Rtype, &jac->Rtype, NULL);CHKERRQ(ierr);
906589dcaf0SStefano Zampini   PetscStackCallStandard(HYPRE_BoomerAMGSetRestriction,(jac->hsolver,jac->Rtype));
907589dcaf0SStefano Zampini   if (jac->Rtype) {
908589dcaf0SStefano Zampini     jac->interptype = 100; /* no way we can pass this with strings... Set it as default as in MFEM, then users can still customize it back to a different one */
909589dcaf0SStefano Zampini 
910589dcaf0SStefano Zampini     ierr = PetscOptionsReal("-pc_hypre_boomeramg_strongthresholdR","Threshold for R","None",jac->Rstrongthreshold,&jac->Rstrongthreshold,NULL);CHKERRQ(ierr);
911589dcaf0SStefano Zampini     PetscStackCallStandard(HYPRE_BoomerAMGSetStrongThresholdR,(jac->hsolver,jac->Rstrongthreshold));
912589dcaf0SStefano Zampini 
913589dcaf0SStefano Zampini     ierr = PetscOptionsReal("-pc_hypre_boomeramg_filterthresholdR","Filter threshold for R","None",jac->Rfilterthreshold,&jac->Rfilterthreshold,NULL);CHKERRQ(ierr);
914589dcaf0SStefano Zampini     PetscStackCallStandard(HYPRE_BoomerAMGSetFilterThresholdR,(jac->hsolver,jac->Rfilterthreshold));
915589dcaf0SStefano Zampini 
916589dcaf0SStefano Zampini     ierr = PetscOptionsReal("-pc_hypre_boomeramg_Adroptol","Defines the drop tolerance for the A-matrices from the 2nd level of AMG","None",jac->Adroptol,&jac->Adroptol,NULL);CHKERRQ(ierr);
917589dcaf0SStefano Zampini     PetscStackCallStandard(HYPRE_BoomerAMGSetADropTol,(jac->hsolver,jac->Adroptol));
918589dcaf0SStefano Zampini 
919589dcaf0SStefano Zampini     ierr = PetscOptionsInt("-pc_hypre_boomeramg_Adroptype","Drops the entries that are not on the diagonal and smaller than its row norm: type 1: 1-norm, 2: 2-norm, -1: infinity norm","None",jac->Adroptype,&jac->Adroptype,NULL);CHKERRQ(ierr);
920589dcaf0SStefano Zampini     PetscStackCallStandard(HYPRE_BoomerAMGSetADropType,(jac->hsolver,jac->Adroptype));
921589dcaf0SStefano Zampini   }
922589dcaf0SStefano Zampini #endif
923589dcaf0SStefano Zampini 
9240f1074feSSatish Balay   /* new 3/07 */
925a669f990SJed Brown   ierr = PetscOptionsEList("-pc_hypre_boomeramg_interp_type","Interpolation type","None",HYPREBoomerAMGInterpType,ALEN(HYPREBoomerAMGInterpType),HYPREBoomerAMGInterpType[0],&indx,&flg);CHKERRQ(ierr);
926589dcaf0SStefano Zampini   if (flg || jac->Rtype) {
927589dcaf0SStefano Zampini     if (flg) jac->interptype = indx;
928fd3f9acdSBarry Smith     PetscStackCallStandard(HYPRE_BoomerAMGSetInterpType,(jac->hsolver,jac->interptype));
9290f1074feSSatish Balay   }
9300f1074feSSatish Balay 
931b96a4a96SBarry Smith   ierr = PetscOptionsName("-pc_hypre_boomeramg_print_statistics","Print statistics","None",&flg);CHKERRQ(ierr);
93216d9e3a6SLisandro Dalcin   if (flg) {
933b96a4a96SBarry Smith     level = 3;
9340298fd71SBarry Smith     ierr = PetscOptionsInt("-pc_hypre_boomeramg_print_statistics","Print statistics","None",level,&level,NULL);CHKERRQ(ierr);
9352fa5cd67SKarl Rupp 
936b96a4a96SBarry Smith     jac->printstatistics = PETSC_TRUE;
937fd3f9acdSBarry Smith     PetscStackCallStandard(HYPRE_BoomerAMGSetPrintLevel,(jac->hsolver,level));
9382ae77aedSBarry Smith   }
9392ae77aedSBarry Smith 
940b96a4a96SBarry Smith   ierr = PetscOptionsName("-pc_hypre_boomeramg_print_debug","Print debug information","None",&flg);CHKERRQ(ierr);
9412ae77aedSBarry Smith   if (flg) {
942b96a4a96SBarry Smith     level = 3;
9430298fd71SBarry Smith     ierr = PetscOptionsInt("-pc_hypre_boomeramg_print_debug","Print debug information","None",level,&level,NULL);CHKERRQ(ierr);
9442fa5cd67SKarl Rupp 
945b96a4a96SBarry Smith     jac->printstatistics = PETSC_TRUE;
946fd3f9acdSBarry Smith     PetscStackCallStandard(HYPRE_BoomerAMGSetDebugFlag,(jac->hsolver,level));
94716d9e3a6SLisandro Dalcin   }
9488f87f92bSBarry Smith 
949acfcf0e5SJed Brown   ierr = PetscOptionsBool("-pc_hypre_boomeramg_nodal_relaxation", "Nodal relaxation via Schwarz", "None", PETSC_FALSE, &tmp_truth, &flg);CHKERRQ(ierr);
9508f87f92bSBarry Smith   if (flg && tmp_truth) {
9518f87f92bSBarry Smith     PetscInt tmp_int;
9528f87f92bSBarry Smith     ierr = PetscOptionsInt("-pc_hypre_boomeramg_nodal_relaxation", "Nodal relaxation via Schwarz", "None",jac->nodal_relax_levels,&tmp_int,&flg);CHKERRQ(ierr);
9538f87f92bSBarry Smith     if (flg) jac->nodal_relax_levels = tmp_int;
954fd3f9acdSBarry Smith     PetscStackCallStandard(HYPRE_BoomerAMGSetSmoothType,(jac->hsolver,6));
955fd3f9acdSBarry Smith     PetscStackCallStandard(HYPRE_BoomerAMGSetDomainType,(jac->hsolver,1));
956fd3f9acdSBarry Smith     PetscStackCallStandard(HYPRE_BoomerAMGSetOverlap,(jac->hsolver,0));
957fd3f9acdSBarry Smith     PetscStackCallStandard(HYPRE_BoomerAMGSetSmoothNumLevels,(jac->hsolver,jac->nodal_relax_levels));
9588f87f92bSBarry Smith   }
9598f87f92bSBarry Smith 
960589dcaf0SStefano Zampini   ierr = PetscOptionsBool("-pc_hypre_boomeramg_keeptranspose", "Avoid transpose matvecs in preconditioner application", "None", jac->keeptranspose, &jac->keeptranspose, NULL);CHKERRQ(ierr);
961589dcaf0SStefano Zampini   PetscStackCallStandard(HYPRE_BoomerAMGSetKeepTranspose,(jac->hsolver,jac->keeptranspose ? 1 : 0));
962589dcaf0SStefano Zampini 
963589dcaf0SStefano Zampini   /* options for ParaSails solvers */
964589dcaf0SStefano Zampini   ierr = PetscOptionsEList("-pc_hypre_boomeramg_parasails_sym","Symmetry of matrix and preconditioner","None",symtlist,ALEN(symtlist),symtlist[0],&indx,&flg);CHKERRQ(ierr);
965589dcaf0SStefano Zampini   if (flg) {
966589dcaf0SStefano Zampini     jac->symt = indx;
967589dcaf0SStefano Zampini     PetscStackCallStandard(HYPRE_BoomerAMGSetSym,(jac->hsolver,jac->symt));
968589dcaf0SStefano Zampini   }
969589dcaf0SStefano Zampini 
97016d9e3a6SLisandro Dalcin   ierr = PetscOptionsTail();CHKERRQ(ierr);
97116d9e3a6SLisandro Dalcin   PetscFunctionReturn(0);
97216d9e3a6SLisandro Dalcin }
97316d9e3a6SLisandro Dalcin 
974ace3abfcSBarry Smith static PetscErrorCode PCApplyRichardson_HYPRE_BoomerAMG(PC pc,Vec b,Vec y,Vec w,PetscReal rtol,PetscReal abstol, PetscReal dtol,PetscInt its,PetscBool guesszero,PetscInt *outits,PCRichardsonConvergedReason *reason)
97516d9e3a6SLisandro Dalcin {
97616d9e3a6SLisandro Dalcin   PC_HYPRE       *jac = (PC_HYPRE*)pc->data;
97716d9e3a6SLisandro Dalcin   PetscErrorCode ierr;
9782cf14000SStefano Zampini   HYPRE_Int      oits;
97916d9e3a6SLisandro Dalcin 
98016d9e3a6SLisandro Dalcin   PetscFunctionBegin;
981dff31646SBarry Smith   ierr = PetscCitationsRegister(hypreCitation,&cite);CHKERRQ(ierr);
982fd3f9acdSBarry Smith   PetscStackCallStandard(HYPRE_BoomerAMGSetMaxIter,(jac->hsolver,its*jac->maxiter));
983fd3f9acdSBarry Smith   PetscStackCallStandard(HYPRE_BoomerAMGSetTol,(jac->hsolver,rtol));
98416d9e3a6SLisandro Dalcin   jac->applyrichardson = PETSC_TRUE;
98516d9e3a6SLisandro Dalcin   ierr                 = PCApply_HYPRE(pc,b,y);CHKERRQ(ierr);
98616d9e3a6SLisandro Dalcin   jac->applyrichardson = PETSC_FALSE;
9872cf14000SStefano Zampini   PetscStackCallStandard(HYPRE_BoomerAMGGetNumIterations,(jac->hsolver,&oits));
9884d0a8057SBarry Smith   *outits = oits;
9894d0a8057SBarry Smith   if (oits == its) *reason = PCRICHARDSON_CONVERGED_ITS;
9904d0a8057SBarry Smith   else             *reason = PCRICHARDSON_CONVERGED_RTOL;
991fd3f9acdSBarry Smith   PetscStackCallStandard(HYPRE_BoomerAMGSetTol,(jac->hsolver,jac->tol));
992fd3f9acdSBarry Smith   PetscStackCallStandard(HYPRE_BoomerAMGSetMaxIter,(jac->hsolver,jac->maxiter));
99316d9e3a6SLisandro Dalcin   PetscFunctionReturn(0);
99416d9e3a6SLisandro Dalcin }
99516d9e3a6SLisandro Dalcin 
99616d9e3a6SLisandro Dalcin static PetscErrorCode PCView_HYPRE_BoomerAMG(PC pc,PetscViewer viewer)
99716d9e3a6SLisandro Dalcin {
99816d9e3a6SLisandro Dalcin   PC_HYPRE       *jac = (PC_HYPRE*)pc->data;
99916d9e3a6SLisandro Dalcin   PetscErrorCode ierr;
1000ace3abfcSBarry Smith   PetscBool      iascii;
100116d9e3a6SLisandro Dalcin 
100216d9e3a6SLisandro Dalcin   PetscFunctionBegin;
1003251f4c67SDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&iascii);CHKERRQ(ierr);
100416d9e3a6SLisandro Dalcin   if (iascii) {
100516d9e3a6SLisandro Dalcin     ierr = PetscViewerASCIIPrintf(viewer,"  HYPRE BoomerAMG preconditioning\n");CHKERRQ(ierr);
1006efd4aadfSBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"    Cycle type %s\n",HYPREBoomerAMGCycleType[jac->cycletype]);CHKERRQ(ierr);
100722e51d31SStefano Zampini     ierr = PetscViewerASCIIPrintf(viewer,"    Maximum number of levels %D\n",jac->maxlevels);CHKERRQ(ierr);
100822e51d31SStefano Zampini     ierr = PetscViewerASCIIPrintf(viewer,"    Maximum number of iterations PER hypre call %D\n",jac->maxiter);CHKERRQ(ierr);
1009efd4aadfSBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"    Convergence tolerance PER hypre call %g\n",(double)jac->tol);CHKERRQ(ierr);
1010efd4aadfSBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"    Threshold for strong coupling %g\n",(double)jac->strongthreshold);CHKERRQ(ierr);
1011efd4aadfSBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"    Interpolation truncation factor %g\n",(double)jac->truncfactor);CHKERRQ(ierr);
101222e51d31SStefano Zampini     ierr = PetscViewerASCIIPrintf(viewer,"    Interpolation: max elements per row %D\n",jac->pmax);CHKERRQ(ierr);
101322e51d31SStefano Zampini     if (jac->interp_refine) {
101422e51d31SStefano Zampini       ierr = PetscViewerASCIIPrintf(viewer,"    Interpolation: number of steps of weighted refinement %D\n",jac->interp_refine);CHKERRQ(ierr);
101522e51d31SStefano Zampini     }
101622e51d31SStefano Zampini     ierr = PetscViewerASCIIPrintf(viewer,"    Number of levels of aggressive coarsening %D\n",jac->agg_nl);CHKERRQ(ierr);
101722e51d31SStefano Zampini     ierr = PetscViewerASCIIPrintf(viewer,"    Number of paths for aggressive coarsening %D\n",jac->agg_num_paths);CHKERRQ(ierr);
10180f1074feSSatish Balay 
1019efd4aadfSBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"    Maximum row sums %g\n",(double)jac->maxrowsum);CHKERRQ(ierr);
102016d9e3a6SLisandro Dalcin 
102122e51d31SStefano Zampini     ierr = PetscViewerASCIIPrintf(viewer,"    Sweeps down         %D\n",jac->gridsweeps[0]);CHKERRQ(ierr);
102222e51d31SStefano Zampini     ierr = PetscViewerASCIIPrintf(viewer,"    Sweeps up           %D\n",jac->gridsweeps[1]);CHKERRQ(ierr);
102322e51d31SStefano Zampini     ierr = PetscViewerASCIIPrintf(viewer,"    Sweeps on coarse    %D\n",jac->gridsweeps[2]);CHKERRQ(ierr);
102416d9e3a6SLisandro Dalcin 
1025efd4aadfSBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"    Relax down          %s\n",HYPREBoomerAMGRelaxType[jac->relaxtype[0]]);CHKERRQ(ierr);
1026efd4aadfSBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"    Relax up            %s\n",HYPREBoomerAMGRelaxType[jac->relaxtype[1]]);CHKERRQ(ierr);
1027efd4aadfSBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"    Relax on coarse     %s\n",HYPREBoomerAMGRelaxType[jac->relaxtype[2]]);CHKERRQ(ierr);
102816d9e3a6SLisandro Dalcin 
1029efd4aadfSBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"    Relax weight  (all)      %g\n",(double)jac->relaxweight);CHKERRQ(ierr);
1030efd4aadfSBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"    Outer relax weight (all) %g\n",(double)jac->outerrelaxweight);CHKERRQ(ierr);
103116d9e3a6SLisandro Dalcin 
103216d9e3a6SLisandro Dalcin     if (jac->relaxorder) {
1033efd4aadfSBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"    Using CF-relaxation\n");CHKERRQ(ierr);
103416d9e3a6SLisandro Dalcin     } else {
1035efd4aadfSBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"    Not using CF-relaxation\n");CHKERRQ(ierr);
103616d9e3a6SLisandro Dalcin     }
10376a251517SEike Mueller     if (jac->smoothtype!=-1) {
1038efd4aadfSBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"    Smooth type          %s\n",HYPREBoomerAMGSmoothType[jac->smoothtype]);CHKERRQ(ierr);
103922e51d31SStefano Zampini       ierr = PetscViewerASCIIPrintf(viewer,"    Smooth num levels    %D\n",jac->smoothnumlevels);CHKERRQ(ierr);
10407e352d70SEike Mueller     } else {
1041efd4aadfSBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"    Not using more complex smoothers.\n");CHKERRQ(ierr);
10421810e44eSEike Mueller     }
10431810e44eSEike Mueller     if (jac->smoothtype==3) {
104422e51d31SStefano Zampini       ierr = PetscViewerASCIIPrintf(viewer,"    Euclid ILU(k) levels %D\n",jac->eu_level);CHKERRQ(ierr);
104522e51d31SStefano Zampini       ierr = PetscViewerASCIIPrintf(viewer,"    Euclid ILU(k) drop tolerance %g\n",(double)jac->eu_droptolerance);CHKERRQ(ierr);
104622e51d31SStefano Zampini       ierr = PetscViewerASCIIPrintf(viewer,"    Euclid ILU use Block-Jacobi? %D\n",jac->eu_bj);CHKERRQ(ierr);
10476a251517SEike Mueller     }
1048efd4aadfSBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"    Measure type        %s\n",HYPREBoomerAMGMeasureType[jac->measuretype]);CHKERRQ(ierr);
1049efd4aadfSBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"    Coarsen type        %s\n",HYPREBoomerAMGCoarsenType[jac->coarsentype]);CHKERRQ(ierr);
1050589dcaf0SStefano Zampini     ierr = PetscViewerASCIIPrintf(viewer,"    Interpolation type  %s\n",jac->interptype != 100 ? HYPREBoomerAMGInterpType[jac->interptype] : "1pt");CHKERRQ(ierr);
10515272c319SBarry Smith     if (jac->nodal_coarsening) {
105284c7a2fdSPierre Jolivet       ierr = PetscViewerASCIIPrintf(viewer,"    Using nodal coarsening with HYPRE_BOOMERAMGSetNodal() %D\n",jac->nodal_coarsening);CHKERRQ(ierr);
10535272c319SBarry Smith     }
10545272c319SBarry Smith     if (jac->vec_interp_variant) {
1055efd4aadfSBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"    HYPRE_BoomerAMGSetInterpVecVariant() %D\n",jac->vec_interp_variant);CHKERRQ(ierr);
105622e51d31SStefano Zampini       ierr = PetscViewerASCIIPrintf(viewer,"    HYPRE_BoomerAMGSetInterpVecQMax() %D\n",jac->vec_interp_qmax);CHKERRQ(ierr);
105722e51d31SStefano Zampini       ierr = PetscViewerASCIIPrintf(viewer,"    HYPRE_BoomerAMGSetSmoothInterpVectors() %d\n",jac->vec_interp_smooth);CHKERRQ(ierr);
10588f87f92bSBarry Smith     }
10598f87f92bSBarry Smith     if (jac->nodal_relax) {
106022e51d31SStefano Zampini       ierr = PetscViewerASCIIPrintf(viewer,"    Using nodal relaxation via Schwarz smoothing on levels %D\n",jac->nodal_relax_levels);CHKERRQ(ierr);
10618f87f92bSBarry Smith     }
1062589dcaf0SStefano Zampini 
1063589dcaf0SStefano Zampini     /* AIR */
1064589dcaf0SStefano Zampini     if (jac->Rtype) {
1065589dcaf0SStefano Zampini       ierr = PetscViewerASCIIPrintf(viewer,"    Using approximate ideal restriction type %D\n",jac->Rtype);CHKERRQ(ierr);
1066589dcaf0SStefano Zampini       ierr = PetscViewerASCIIPrintf(viewer,"      Threshold for R %g\n",(double)jac->Rstrongthreshold);CHKERRQ(ierr);
1067589dcaf0SStefano Zampini       ierr = PetscViewerASCIIPrintf(viewer,"      Filter for R %g\n",(double)jac->Rfilterthreshold);CHKERRQ(ierr);
1068589dcaf0SStefano Zampini       ierr = PetscViewerASCIIPrintf(viewer,"      A drop tolerance %g\n",(double)jac->Adroptol);CHKERRQ(ierr);
1069589dcaf0SStefano Zampini       ierr = PetscViewerASCIIPrintf(viewer,"      A drop type %D\n",jac->Adroptype);CHKERRQ(ierr);
1070589dcaf0SStefano Zampini     }
107116d9e3a6SLisandro Dalcin   }
107216d9e3a6SLisandro Dalcin   PetscFunctionReturn(0);
107316d9e3a6SLisandro Dalcin }
107416d9e3a6SLisandro Dalcin 
107516d9e3a6SLisandro Dalcin /* --------------------------------------------------------------------------------------------*/
10764416b707SBarry Smith static PetscErrorCode PCSetFromOptions_HYPRE_ParaSails(PetscOptionItems *PetscOptionsObject,PC pc)
107716d9e3a6SLisandro Dalcin {
107816d9e3a6SLisandro Dalcin   PC_HYPRE       *jac = (PC_HYPRE*)pc->data;
107916d9e3a6SLisandro Dalcin   PetscErrorCode ierr;
10804ddd07fcSJed Brown   PetscInt       indx;
1081ace3abfcSBarry Smith   PetscBool      flag;
108216d9e3a6SLisandro Dalcin   const char     *symtlist[] = {"nonsymmetric","SPD","nonsymmetric,SPD"};
108316d9e3a6SLisandro Dalcin 
108416d9e3a6SLisandro Dalcin   PetscFunctionBegin;
1085e55864a3SBarry Smith   ierr = PetscOptionsHead(PetscOptionsObject,"HYPRE ParaSails Options");CHKERRQ(ierr);
108616d9e3a6SLisandro Dalcin   ierr = PetscOptionsInt("-pc_hypre_parasails_nlevels","Number of number of levels","None",jac->nlevels,&jac->nlevels,0);CHKERRQ(ierr);
10878966356dSPierre Jolivet   ierr = PetscOptionsReal("-pc_hypre_parasails_thresh","Threshold","None",jac->threshold,&jac->threshold,&flag);CHKERRQ(ierr);
10888966356dSPierre Jolivet   if (flag) PetscStackCallStandard(HYPRE_ParaSailsSetParams,(jac->hsolver,jac->threshold,jac->nlevels));
108916d9e3a6SLisandro Dalcin 
109016d9e3a6SLisandro Dalcin   ierr = PetscOptionsReal("-pc_hypre_parasails_filter","filter","None",jac->filter,&jac->filter,&flag);CHKERRQ(ierr);
10912fa5cd67SKarl Rupp   if (flag) PetscStackCallStandard(HYPRE_ParaSailsSetFilter,(jac->hsolver,jac->filter));
109216d9e3a6SLisandro Dalcin 
109316d9e3a6SLisandro Dalcin   ierr = PetscOptionsReal("-pc_hypre_parasails_loadbal","Load balance","None",jac->loadbal,&jac->loadbal,&flag);CHKERRQ(ierr);
10942fa5cd67SKarl Rupp   if (flag) PetscStackCallStandard(HYPRE_ParaSailsSetLoadbal,(jac->hsolver,jac->loadbal));
109516d9e3a6SLisandro Dalcin 
1096acfcf0e5SJed Brown   ierr = PetscOptionsBool("-pc_hypre_parasails_logging","Print info to screen","None",(PetscBool)jac->logging,(PetscBool*)&jac->logging,&flag);CHKERRQ(ierr);
10972fa5cd67SKarl Rupp   if (flag) PetscStackCallStandard(HYPRE_ParaSailsSetLogging,(jac->hsolver,jac->logging));
109816d9e3a6SLisandro Dalcin 
1099acfcf0e5SJed Brown   ierr = PetscOptionsBool("-pc_hypre_parasails_reuse","Reuse nonzero pattern in preconditioner","None",(PetscBool)jac->ruse,(PetscBool*)&jac->ruse,&flag);CHKERRQ(ierr);
11002fa5cd67SKarl Rupp   if (flag) PetscStackCallStandard(HYPRE_ParaSailsSetReuse,(jac->hsolver,jac->ruse));
110116d9e3a6SLisandro Dalcin 
1102a669f990SJed Brown   ierr = PetscOptionsEList("-pc_hypre_parasails_sym","Symmetry of matrix and preconditioner","None",symtlist,ALEN(symtlist),symtlist[0],&indx,&flag);CHKERRQ(ierr);
110316d9e3a6SLisandro Dalcin   if (flag) {
110416d9e3a6SLisandro Dalcin     jac->symt = indx;
1105fd3f9acdSBarry Smith     PetscStackCallStandard(HYPRE_ParaSailsSetSym,(jac->hsolver,jac->symt));
110616d9e3a6SLisandro Dalcin   }
110716d9e3a6SLisandro Dalcin 
110816d9e3a6SLisandro Dalcin   ierr = PetscOptionsTail();CHKERRQ(ierr);
110916d9e3a6SLisandro Dalcin   PetscFunctionReturn(0);
111016d9e3a6SLisandro Dalcin }
111116d9e3a6SLisandro Dalcin 
111216d9e3a6SLisandro Dalcin static PetscErrorCode PCView_HYPRE_ParaSails(PC pc,PetscViewer viewer)
111316d9e3a6SLisandro Dalcin {
111416d9e3a6SLisandro Dalcin   PC_HYPRE       *jac = (PC_HYPRE*)pc->data;
111516d9e3a6SLisandro Dalcin   PetscErrorCode ierr;
1116ace3abfcSBarry Smith   PetscBool      iascii;
1117feb237baSPierre Jolivet   const char     *symt = 0;
111816d9e3a6SLisandro Dalcin 
111916d9e3a6SLisandro Dalcin   PetscFunctionBegin;
1120251f4c67SDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&iascii);CHKERRQ(ierr);
112116d9e3a6SLisandro Dalcin   if (iascii) {
112216d9e3a6SLisandro Dalcin     ierr = PetscViewerASCIIPrintf(viewer,"  HYPRE ParaSails preconditioning\n");CHKERRQ(ierr);
1123efd4aadfSBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"    nlevels %d\n",jac->nlevels);CHKERRQ(ierr);
11248966356dSPierre Jolivet     ierr = PetscViewerASCIIPrintf(viewer,"    threshold %g\n",(double)jac->threshold);CHKERRQ(ierr);
1125efd4aadfSBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"    filter %g\n",(double)jac->filter);CHKERRQ(ierr);
1126efd4aadfSBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"    load balance %g\n",(double)jac->loadbal);CHKERRQ(ierr);
1127efd4aadfSBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"    reuse nonzero structure %s\n",PetscBools[jac->ruse]);CHKERRQ(ierr);
1128efd4aadfSBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"    print info to screen %s\n",PetscBools[jac->logging]);CHKERRQ(ierr);
11292fa5cd67SKarl Rupp     if (!jac->symt) symt = "nonsymmetric matrix and preconditioner";
11302fa5cd67SKarl Rupp     else if (jac->symt == 1) symt = "SPD matrix and preconditioner";
11312fa5cd67SKarl Rupp     else if (jac->symt == 2) symt = "nonsymmetric matrix but SPD preconditioner";
1132ce94432eSBarry Smith     else SETERRQ1(PetscObjectComm((PetscObject)pc),PETSC_ERR_ARG_WRONG,"Unknown HYPRE ParaSails symmetric option %d",jac->symt);
1133efd4aadfSBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"    %s\n",symt);CHKERRQ(ierr);
113416d9e3a6SLisandro Dalcin   }
113516d9e3a6SLisandro Dalcin   PetscFunctionReturn(0);
113616d9e3a6SLisandro Dalcin }
11374cb006feSStefano Zampini /* --------------------------------------------------------------------------------------------*/
11384416b707SBarry Smith static PetscErrorCode PCSetFromOptions_HYPRE_AMS(PetscOptionItems *PetscOptionsObject,PC pc)
11394cb006feSStefano Zampini {
11404cb006feSStefano Zampini   PC_HYPRE       *jac = (PC_HYPRE*)pc->data;
11414cb006feSStefano Zampini   PetscErrorCode ierr;
11424cb006feSStefano Zampini   PetscInt       n;
11434cb006feSStefano Zampini   PetscBool      flag,flag2,flag3,flag4;
11444cb006feSStefano Zampini 
11454cb006feSStefano Zampini   PetscFunctionBegin;
11469fa463a7SBarry Smith   ierr = PetscOptionsHead(PetscOptionsObject,"HYPRE AMS Options");CHKERRQ(ierr);
1147863406b8SStefano Zampini   ierr = PetscOptionsInt("-pc_hypre_ams_print_level","Debugging output level for AMS","None",jac->as_print,&jac->as_print,&flag);CHKERRQ(ierr);
1148863406b8SStefano Zampini   if (flag) PetscStackCallStandard(HYPRE_AMSSetPrintLevel,(jac->hsolver,jac->as_print));
1149863406b8SStefano Zampini   ierr = PetscOptionsInt("-pc_hypre_ams_max_iter","Maximum number of AMS multigrid iterations within PCApply","None",jac->as_max_iter,&jac->as_max_iter,&flag);CHKERRQ(ierr);
1150863406b8SStefano Zampini   if (flag) PetscStackCallStandard(HYPRE_AMSSetMaxIter,(jac->hsolver,jac->as_max_iter));
11514cb006feSStefano Zampini   ierr = PetscOptionsInt("-pc_hypre_ams_cycle_type","Cycle type for AMS multigrid","None",jac->ams_cycle_type,&jac->ams_cycle_type,&flag);CHKERRQ(ierr);
11524cb006feSStefano Zampini   if (flag) PetscStackCallStandard(HYPRE_AMSSetCycleType,(jac->hsolver,jac->ams_cycle_type));
1153863406b8SStefano Zampini   ierr = PetscOptionsReal("-pc_hypre_ams_tol","Error tolerance for AMS multigrid","None",jac->as_tol,&jac->as_tol,&flag);CHKERRQ(ierr);
1154863406b8SStefano Zampini   if (flag) PetscStackCallStandard(HYPRE_AMSSetTol,(jac->hsolver,jac->as_tol));
1155863406b8SStefano Zampini   ierr = PetscOptionsInt("-pc_hypre_ams_relax_type","Relaxation type for AMS smoother","None",jac->as_relax_type,&jac->as_relax_type,&flag);CHKERRQ(ierr);
1156863406b8SStefano Zampini   ierr = PetscOptionsInt("-pc_hypre_ams_relax_times","Number of relaxation steps for AMS smoother","None",jac->as_relax_times,&jac->as_relax_times,&flag2);CHKERRQ(ierr);
1157863406b8SStefano Zampini   ierr = PetscOptionsReal("-pc_hypre_ams_relax_weight","Relaxation weight for AMS smoother","None",jac->as_relax_weight,&jac->as_relax_weight,&flag3);CHKERRQ(ierr);
1158863406b8SStefano Zampini   ierr = PetscOptionsReal("-pc_hypre_ams_omega","SSOR coefficient for AMS smoother","None",jac->as_omega,&jac->as_omega,&flag4);CHKERRQ(ierr);
11594cb006feSStefano Zampini   if (flag || flag2 || flag3 || flag4) {
1160863406b8SStefano Zampini     PetscStackCallStandard(HYPRE_AMSSetSmoothingOptions,(jac->hsolver,jac->as_relax_type,
1161863406b8SStefano Zampini                                                                       jac->as_relax_times,
1162863406b8SStefano Zampini                                                                       jac->as_relax_weight,
1163863406b8SStefano Zampini                                                                       jac->as_omega));
11644cb006feSStefano Zampini   }
1165863406b8SStefano Zampini   ierr = PetscOptionsReal("-pc_hypre_ams_amg_alpha_theta","Threshold for strong coupling of vector Poisson AMG solver","None",jac->as_amg_alpha_theta,&jac->as_amg_alpha_theta,&flag);CHKERRQ(ierr);
11664cb006feSStefano Zampini   n = 5;
1167863406b8SStefano Zampini   ierr = PetscOptionsIntArray("-pc_hypre_ams_amg_alpha_options","AMG options for vector Poisson","None",jac->as_amg_alpha_opts,&n,&flag2);CHKERRQ(ierr);
11684cb006feSStefano Zampini   if (flag || flag2) {
1169863406b8SStefano Zampini     PetscStackCallStandard(HYPRE_AMSSetAlphaAMGOptions,(jac->hsolver,jac->as_amg_alpha_opts[0],       /* AMG coarsen type */
1170863406b8SStefano Zampini                                                                      jac->as_amg_alpha_opts[1],       /* AMG agg_levels */
1171863406b8SStefano Zampini                                                                      jac->as_amg_alpha_opts[2],       /* AMG relax_type */
1172863406b8SStefano Zampini                                                                      jac->as_amg_alpha_theta,
1173863406b8SStefano Zampini                                                                      jac->as_amg_alpha_opts[3],       /* AMG interp_type */
1174863406b8SStefano Zampini                                                                      jac->as_amg_alpha_opts[4]));     /* AMG Pmax */
11754cb006feSStefano Zampini   }
1176863406b8SStefano Zampini   ierr = PetscOptionsReal("-pc_hypre_ams_amg_beta_theta","Threshold for strong coupling of scalar Poisson AMG solver","None",jac->as_amg_beta_theta,&jac->as_amg_beta_theta,&flag);CHKERRQ(ierr);
11774cb006feSStefano Zampini   n = 5;
1178863406b8SStefano Zampini   ierr = PetscOptionsIntArray("-pc_hypre_ams_amg_beta_options","AMG options for scalar Poisson solver","None",jac->as_amg_beta_opts,&n,&flag2);CHKERRQ(ierr);
11794cb006feSStefano Zampini   if (flag || flag2) {
1180863406b8SStefano Zampini     PetscStackCallStandard(HYPRE_AMSSetBetaAMGOptions,(jac->hsolver,jac->as_amg_beta_opts[0],       /* AMG coarsen type */
1181863406b8SStefano Zampini                                                                     jac->as_amg_beta_opts[1],       /* AMG agg_levels */
1182863406b8SStefano Zampini                                                                     jac->as_amg_beta_opts[2],       /* AMG relax_type */
1183863406b8SStefano Zampini                                                                     jac->as_amg_beta_theta,
1184863406b8SStefano Zampini                                                                     jac->as_amg_beta_opts[3],       /* AMG interp_type */
1185863406b8SStefano Zampini                                                                     jac->as_amg_beta_opts[4]));     /* AMG Pmax */
11864cb006feSStefano Zampini   }
118723df4f25SStefano Zampini   ierr = PetscOptionsInt("-pc_hypre_ams_projection_frequency","Frequency at which a projection onto the compatible subspace for problems with zero conductivity regions is performed","None",jac->ams_proj_freq,&jac->ams_proj_freq,&flag);CHKERRQ(ierr);
118823df4f25SStefano Zampini   if (flag) { /* override HYPRE's default only if the options is used */
118923df4f25SStefano Zampini     PetscStackCallStandard(HYPRE_AMSSetProjectionFrequency,(jac->hsolver,jac->ams_proj_freq));
119023df4f25SStefano Zampini   }
11914cb006feSStefano Zampini   ierr = PetscOptionsTail();CHKERRQ(ierr);
11924cb006feSStefano Zampini   PetscFunctionReturn(0);
11934cb006feSStefano Zampini }
11944cb006feSStefano Zampini 
11954cb006feSStefano Zampini static PetscErrorCode PCView_HYPRE_AMS(PC pc,PetscViewer viewer)
11964cb006feSStefano Zampini {
11974cb006feSStefano Zampini   PC_HYPRE       *jac = (PC_HYPRE*)pc->data;
11984cb006feSStefano Zampini   PetscErrorCode ierr;
11994cb006feSStefano Zampini   PetscBool      iascii;
12004cb006feSStefano Zampini 
12014cb006feSStefano Zampini   PetscFunctionBegin;
12024cb006feSStefano Zampini   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&iascii);CHKERRQ(ierr);
12034cb006feSStefano Zampini   if (iascii) {
12044cb006feSStefano Zampini     ierr = PetscViewerASCIIPrintf(viewer,"  HYPRE AMS preconditioning\n");CHKERRQ(ierr);
1205efd4aadfSBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"    subspace iterations per application %d\n",jac->as_max_iter);CHKERRQ(ierr);
1206efd4aadfSBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"    subspace cycle type %d\n",jac->ams_cycle_type);CHKERRQ(ierr);
1207efd4aadfSBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"    subspace iteration tolerance %g\n",jac->as_tol);CHKERRQ(ierr);
1208efd4aadfSBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"    smoother type %d\n",jac->as_relax_type);CHKERRQ(ierr);
1209efd4aadfSBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"    number of smoothing steps %d\n",jac->as_relax_times);CHKERRQ(ierr);
1210efd4aadfSBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"    smoother weight %g\n",jac->as_relax_weight);CHKERRQ(ierr);
1211efd4aadfSBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"    smoother omega %g\n",jac->as_omega);CHKERRQ(ierr);
12124cb006feSStefano Zampini     if (jac->alpha_Poisson) {
1213efd4aadfSBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"    vector Poisson solver (passed in by user)\n");CHKERRQ(ierr);
12144cb006feSStefano Zampini     } else {
1215efd4aadfSBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"    vector Poisson solver (computed) \n");CHKERRQ(ierr);
12164cb006feSStefano Zampini     }
1217efd4aadfSBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"        boomerAMG coarsening type %d\n",jac->as_amg_alpha_opts[0]);CHKERRQ(ierr);
1218efd4aadfSBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"        boomerAMG levels of aggressive coarsening %d\n",jac->as_amg_alpha_opts[1]);CHKERRQ(ierr);
1219efd4aadfSBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"        boomerAMG relaxation type %d\n",jac->as_amg_alpha_opts[2]);CHKERRQ(ierr);
1220efd4aadfSBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"        boomerAMG interpolation type %d\n",jac->as_amg_alpha_opts[3]);CHKERRQ(ierr);
1221efd4aadfSBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"        boomerAMG max nonzero elements in interpolation rows %d\n",jac->as_amg_alpha_opts[4]);CHKERRQ(ierr);
1222efd4aadfSBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"        boomerAMG strength threshold %g\n",jac->as_amg_alpha_theta);CHKERRQ(ierr);
12234cb006feSStefano Zampini     if (!jac->ams_beta_is_zero) {
12244cb006feSStefano Zampini       if (jac->beta_Poisson) {
1225efd4aadfSBarry Smith         ierr = PetscViewerASCIIPrintf(viewer,"    scalar Poisson solver (passed in by user)\n");CHKERRQ(ierr);
12264cb006feSStefano Zampini       } else {
1227efd4aadfSBarry Smith         ierr = PetscViewerASCIIPrintf(viewer,"    scalar Poisson solver (computed) \n");CHKERRQ(ierr);
12284cb006feSStefano Zampini       }
1229efd4aadfSBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"        boomerAMG coarsening type %d\n",jac->as_amg_beta_opts[0]);CHKERRQ(ierr);
1230efd4aadfSBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"        boomerAMG levels of aggressive coarsening %d\n",jac->as_amg_beta_opts[1]);CHKERRQ(ierr);
1231efd4aadfSBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"        boomerAMG relaxation type %d\n",jac->as_amg_beta_opts[2]);CHKERRQ(ierr);
1232efd4aadfSBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"        boomerAMG interpolation type %d\n",jac->as_amg_beta_opts[3]);CHKERRQ(ierr);
1233efd4aadfSBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"        boomerAMG max nonzero elements in interpolation rows %d\n",jac->as_amg_beta_opts[4]);CHKERRQ(ierr);
1234efd4aadfSBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"        boomerAMG strength threshold %g\n",jac->as_amg_beta_theta);CHKERRQ(ierr);
123523df4f25SStefano Zampini       if (jac->ams_beta_is_zero_part) {
1236efd4aadfSBarry Smith         ierr = PetscViewerASCIIPrintf(viewer,"        compatible subspace projection frequency %d (-1 HYPRE uses default)\n",jac->ams_proj_freq);CHKERRQ(ierr);
123723df4f25SStefano Zampini       }
123823df4f25SStefano Zampini     } else {
1239efd4aadfSBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"    scalar Poisson solver not used (zero-conductivity everywhere) \n");CHKERRQ(ierr);
12404cb006feSStefano Zampini     }
12414cb006feSStefano Zampini   }
12424cb006feSStefano Zampini   PetscFunctionReturn(0);
12434cb006feSStefano Zampini }
12444cb006feSStefano Zampini 
12454416b707SBarry Smith static PetscErrorCode PCSetFromOptions_HYPRE_ADS(PetscOptionItems *PetscOptionsObject,PC pc)
1246863406b8SStefano Zampini {
1247863406b8SStefano Zampini   PC_HYPRE       *jac = (PC_HYPRE*)pc->data;
1248863406b8SStefano Zampini   PetscErrorCode ierr;
1249863406b8SStefano Zampini   PetscInt       n;
1250863406b8SStefano Zampini   PetscBool      flag,flag2,flag3,flag4;
1251863406b8SStefano Zampini 
1252863406b8SStefano Zampini   PetscFunctionBegin;
1253863406b8SStefano Zampini   ierr = PetscOptionsHead(PetscOptionsObject,"HYPRE ADS Options");CHKERRQ(ierr);
1254863406b8SStefano Zampini   ierr = PetscOptionsInt("-pc_hypre_ads_print_level","Debugging output level for ADS","None",jac->as_print,&jac->as_print,&flag);CHKERRQ(ierr);
1255863406b8SStefano Zampini   if (flag) PetscStackCallStandard(HYPRE_ADSSetPrintLevel,(jac->hsolver,jac->as_print));
1256863406b8SStefano Zampini   ierr = PetscOptionsInt("-pc_hypre_ads_max_iter","Maximum number of ADS multigrid iterations within PCApply","None",jac->as_max_iter,&jac->as_max_iter,&flag);CHKERRQ(ierr);
1257863406b8SStefano Zampini   if (flag) PetscStackCallStandard(HYPRE_ADSSetMaxIter,(jac->hsolver,jac->as_max_iter));
1258863406b8SStefano Zampini   ierr = PetscOptionsInt("-pc_hypre_ads_cycle_type","Cycle type for ADS multigrid","None",jac->ads_cycle_type,&jac->ads_cycle_type,&flag);CHKERRQ(ierr);
1259863406b8SStefano Zampini   if (flag) PetscStackCallStandard(HYPRE_ADSSetCycleType,(jac->hsolver,jac->ads_cycle_type));
1260863406b8SStefano Zampini   ierr = PetscOptionsReal("-pc_hypre_ads_tol","Error tolerance for ADS multigrid","None",jac->as_tol,&jac->as_tol,&flag);CHKERRQ(ierr);
1261863406b8SStefano Zampini   if (flag) PetscStackCallStandard(HYPRE_ADSSetTol,(jac->hsolver,jac->as_tol));
1262863406b8SStefano Zampini   ierr = PetscOptionsInt("-pc_hypre_ads_relax_type","Relaxation type for ADS smoother","None",jac->as_relax_type,&jac->as_relax_type,&flag);CHKERRQ(ierr);
1263863406b8SStefano Zampini   ierr = PetscOptionsInt("-pc_hypre_ads_relax_times","Number of relaxation steps for ADS smoother","None",jac->as_relax_times,&jac->as_relax_times,&flag2);CHKERRQ(ierr);
1264863406b8SStefano Zampini   ierr = PetscOptionsReal("-pc_hypre_ads_relax_weight","Relaxation weight for ADS smoother","None",jac->as_relax_weight,&jac->as_relax_weight,&flag3);CHKERRQ(ierr);
1265863406b8SStefano Zampini   ierr = PetscOptionsReal("-pc_hypre_ads_omega","SSOR coefficient for ADS smoother","None",jac->as_omega,&jac->as_omega,&flag4);CHKERRQ(ierr);
1266863406b8SStefano Zampini   if (flag || flag2 || flag3 || flag4) {
1267863406b8SStefano Zampini     PetscStackCallStandard(HYPRE_ADSSetSmoothingOptions,(jac->hsolver,jac->as_relax_type,
1268863406b8SStefano Zampini                                                                       jac->as_relax_times,
1269863406b8SStefano Zampini                                                                       jac->as_relax_weight,
1270863406b8SStefano Zampini                                                                       jac->as_omega));
1271863406b8SStefano Zampini   }
1272863406b8SStefano Zampini   ierr = PetscOptionsReal("-pc_hypre_ads_ams_theta","Threshold for strong coupling of AMS solver inside ADS","None",jac->as_amg_alpha_theta,&jac->as_amg_alpha_theta,&flag);CHKERRQ(ierr);
1273863406b8SStefano Zampini   n = 5;
1274863406b8SStefano Zampini   ierr = PetscOptionsIntArray("-pc_hypre_ads_ams_options","AMG options for AMS solver inside ADS","None",jac->as_amg_alpha_opts,&n,&flag2);CHKERRQ(ierr);
1275863406b8SStefano Zampini   ierr = PetscOptionsInt("-pc_hypre_ads_ams_cycle_type","Cycle type for AMS solver inside ADS","None",jac->ams_cycle_type,&jac->ams_cycle_type,&flag3);CHKERRQ(ierr);
1276863406b8SStefano Zampini   if (flag || flag2 || flag3) {
1277863406b8SStefano Zampini     PetscStackCallStandard(HYPRE_ADSSetAMSOptions,(jac->hsolver,jac->ams_cycle_type,             /* AMS cycle type */
1278863406b8SStefano Zampini                                                                 jac->as_amg_alpha_opts[0],       /* AMG coarsen type */
1279863406b8SStefano Zampini                                                                 jac->as_amg_alpha_opts[1],       /* AMG agg_levels */
1280863406b8SStefano Zampini                                                                 jac->as_amg_alpha_opts[2],       /* AMG relax_type */
1281863406b8SStefano Zampini                                                                 jac->as_amg_alpha_theta,
1282863406b8SStefano Zampini                                                                 jac->as_amg_alpha_opts[3],       /* AMG interp_type */
1283863406b8SStefano Zampini                                                                 jac->as_amg_alpha_opts[4]));     /* AMG Pmax */
1284863406b8SStefano Zampini   }
1285863406b8SStefano Zampini   ierr = PetscOptionsReal("-pc_hypre_ads_amg_theta","Threshold for strong coupling of vector AMG solver inside ADS","None",jac->as_amg_beta_theta,&jac->as_amg_beta_theta,&flag);CHKERRQ(ierr);
1286863406b8SStefano Zampini   n = 5;
1287863406b8SStefano Zampini   ierr = PetscOptionsIntArray("-pc_hypre_ads_amg_options","AMG options for vector AMG solver inside ADS","None",jac->as_amg_beta_opts,&n,&flag2);CHKERRQ(ierr);
1288863406b8SStefano Zampini   if (flag || flag2) {
1289863406b8SStefano Zampini     PetscStackCallStandard(HYPRE_ADSSetAMGOptions,(jac->hsolver,jac->as_amg_beta_opts[0],       /* AMG coarsen type */
1290863406b8SStefano Zampini                                                                 jac->as_amg_beta_opts[1],       /* AMG agg_levels */
1291863406b8SStefano Zampini                                                                 jac->as_amg_beta_opts[2],       /* AMG relax_type */
1292863406b8SStefano Zampini                                                                 jac->as_amg_beta_theta,
1293863406b8SStefano Zampini                                                                 jac->as_amg_beta_opts[3],       /* AMG interp_type */
1294863406b8SStefano Zampini                                                                 jac->as_amg_beta_opts[4]));     /* AMG Pmax */
1295863406b8SStefano Zampini   }
1296863406b8SStefano Zampini   ierr = PetscOptionsTail();CHKERRQ(ierr);
1297863406b8SStefano Zampini   PetscFunctionReturn(0);
1298863406b8SStefano Zampini }
1299863406b8SStefano Zampini 
1300863406b8SStefano Zampini static PetscErrorCode PCView_HYPRE_ADS(PC pc,PetscViewer viewer)
1301863406b8SStefano Zampini {
1302863406b8SStefano Zampini   PC_HYPRE       *jac = (PC_HYPRE*)pc->data;
1303863406b8SStefano Zampini   PetscErrorCode ierr;
1304863406b8SStefano Zampini   PetscBool      iascii;
1305863406b8SStefano Zampini 
1306863406b8SStefano Zampini   PetscFunctionBegin;
1307863406b8SStefano Zampini   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&iascii);CHKERRQ(ierr);
1308863406b8SStefano Zampini   if (iascii) {
1309863406b8SStefano Zampini     ierr = PetscViewerASCIIPrintf(viewer,"  HYPRE ADS preconditioning\n");CHKERRQ(ierr);
1310efd4aadfSBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"    subspace iterations per application %d\n",jac->as_max_iter);CHKERRQ(ierr);
1311efd4aadfSBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"    subspace cycle type %d\n",jac->ads_cycle_type);CHKERRQ(ierr);
1312efd4aadfSBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"    subspace iteration tolerance %g\n",jac->as_tol);CHKERRQ(ierr);
1313efd4aadfSBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"    smoother type %d\n",jac->as_relax_type);CHKERRQ(ierr);
1314efd4aadfSBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"    number of smoothing steps %d\n",jac->as_relax_times);CHKERRQ(ierr);
1315efd4aadfSBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"    smoother weight %g\n",jac->as_relax_weight);CHKERRQ(ierr);
1316efd4aadfSBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"    smoother omega %g\n",jac->as_omega);CHKERRQ(ierr);
1317efd4aadfSBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"    AMS solver using boomerAMG\n");CHKERRQ(ierr);
1318efd4aadfSBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"        subspace cycle type %d\n",jac->ams_cycle_type);CHKERRQ(ierr);
1319efd4aadfSBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"        coarsening type %d\n",jac->as_amg_alpha_opts[0]);CHKERRQ(ierr);
1320efd4aadfSBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"        levels of aggressive coarsening %d\n",jac->as_amg_alpha_opts[1]);CHKERRQ(ierr);
1321efd4aadfSBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"        relaxation type %d\n",jac->as_amg_alpha_opts[2]);CHKERRQ(ierr);
1322efd4aadfSBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"        interpolation type %d\n",jac->as_amg_alpha_opts[3]);CHKERRQ(ierr);
1323efd4aadfSBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"        max nonzero elements in interpolation rows %d\n",jac->as_amg_alpha_opts[4]);CHKERRQ(ierr);
1324efd4aadfSBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"        strength threshold %g\n",jac->as_amg_alpha_theta);CHKERRQ(ierr);
1325efd4aadfSBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"    vector Poisson solver using boomerAMG\n");CHKERRQ(ierr);
1326efd4aadfSBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"        coarsening type %d\n",jac->as_amg_beta_opts[0]);CHKERRQ(ierr);
1327efd4aadfSBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"        levels of aggressive coarsening %d\n",jac->as_amg_beta_opts[1]);CHKERRQ(ierr);
1328efd4aadfSBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"        relaxation type %d\n",jac->as_amg_beta_opts[2]);CHKERRQ(ierr);
1329efd4aadfSBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"        interpolation type %d\n",jac->as_amg_beta_opts[3]);CHKERRQ(ierr);
1330efd4aadfSBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"        max nonzero elements in interpolation rows %d\n",jac->as_amg_beta_opts[4]);CHKERRQ(ierr);
1331efd4aadfSBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"        strength threshold %g\n",jac->as_amg_beta_theta);CHKERRQ(ierr);
1332863406b8SStefano Zampini   }
1333863406b8SStefano Zampini   PetscFunctionReturn(0);
1334863406b8SStefano Zampini }
1335863406b8SStefano Zampini 
1336863406b8SStefano Zampini static PetscErrorCode PCHYPRESetDiscreteGradient_HYPRE(PC pc, Mat G)
13374cb006feSStefano Zampini {
13384cb006feSStefano Zampini   PC_HYPRE       *jac = (PC_HYPRE*)pc->data;
13395ac14e1cSStefano Zampini   PetscBool      ishypre;
13404cb006feSStefano Zampini   PetscErrorCode ierr;
13414cb006feSStefano Zampini 
13424cb006feSStefano Zampini   PetscFunctionBegin;
13435ac14e1cSStefano Zampini   ierr = PetscObjectTypeCompare((PetscObject)G,MATHYPRE,&ishypre);CHKERRQ(ierr);
13445ac14e1cSStefano Zampini   if (ishypre) {
13455ac14e1cSStefano Zampini     ierr = PetscObjectReference((PetscObject)G);CHKERRQ(ierr);
13465ac14e1cSStefano Zampini     ierr = MatDestroy(&jac->G);CHKERRQ(ierr);
13475ac14e1cSStefano Zampini     jac->G = G;
13485ac14e1cSStefano Zampini   } else {
13496bf688a0SCe Qin     ierr = MatDestroy(&jac->G);CHKERRQ(ierr);
13506bf688a0SCe Qin     ierr = MatConvert(G,MATHYPRE,MAT_INITIAL_MATRIX,&jac->G);CHKERRQ(ierr);
13515ac14e1cSStefano Zampini   }
13524cb006feSStefano Zampini   PetscFunctionReturn(0);
13534cb006feSStefano Zampini }
13544cb006feSStefano Zampini 
13554cb006feSStefano Zampini /*@
13564cb006feSStefano Zampini  PCHYPRESetDiscreteGradient - Set discrete gradient matrix
13574cb006feSStefano Zampini 
13584cb006feSStefano Zampini    Collective on PC
13594cb006feSStefano Zampini 
13604cb006feSStefano Zampini    Input Parameters:
13614cb006feSStefano Zampini +  pc - the preconditioning context
13624cb006feSStefano Zampini -  G - the discrete gradient
13634cb006feSStefano Zampini 
13644cb006feSStefano Zampini    Level: intermediate
13654cb006feSStefano Zampini 
136695452b02SPatrick Sanan    Notes:
136795452b02SPatrick Sanan     G should have as many rows as the number of edges and as many columns as the number of vertices in the mesh
1368863406b8SStefano Zampini           Each row of G has 2 nonzeros, with column indexes being the global indexes of edge's endpoints: matrix entries are +1 and -1 depending on edge orientation
13694cb006feSStefano Zampini 
13704cb006feSStefano Zampini .seealso:
13714cb006feSStefano Zampini @*/
13724cb006feSStefano Zampini PetscErrorCode PCHYPRESetDiscreteGradient(PC pc, Mat G)
13734cb006feSStefano Zampini {
13744cb006feSStefano Zampini   PetscErrorCode ierr;
13754cb006feSStefano Zampini 
13764cb006feSStefano Zampini   PetscFunctionBegin;
13774cb006feSStefano Zampini   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
13784cb006feSStefano Zampini   PetscValidHeaderSpecific(G,MAT_CLASSID,2);
13794cb006feSStefano Zampini   PetscCheckSameComm(pc,1,G,2);
13804cb006feSStefano Zampini   ierr = PetscTryMethod(pc,"PCHYPRESetDiscreteGradient_C",(PC,Mat),(pc,G));CHKERRQ(ierr);
13814cb006feSStefano Zampini   PetscFunctionReturn(0);
13824cb006feSStefano Zampini }
13834cb006feSStefano Zampini 
1384863406b8SStefano Zampini static PetscErrorCode PCHYPRESetDiscreteCurl_HYPRE(PC pc, Mat C)
1385863406b8SStefano Zampini {
1386863406b8SStefano Zampini   PC_HYPRE       *jac = (PC_HYPRE*)pc->data;
13875ac14e1cSStefano Zampini   PetscBool      ishypre;
1388863406b8SStefano Zampini   PetscErrorCode ierr;
1389863406b8SStefano Zampini 
1390863406b8SStefano Zampini   PetscFunctionBegin;
13915ac14e1cSStefano Zampini   ierr = PetscObjectTypeCompare((PetscObject)C,MATHYPRE,&ishypre);CHKERRQ(ierr);
13925ac14e1cSStefano Zampini   if (ishypre) {
13935ac14e1cSStefano Zampini     ierr = PetscObjectReference((PetscObject)C);CHKERRQ(ierr);
13945ac14e1cSStefano Zampini     ierr = MatDestroy(&jac->C);CHKERRQ(ierr);
13955ac14e1cSStefano Zampini     jac->C = C;
13965ac14e1cSStefano Zampini   } else {
13976bf688a0SCe Qin     ierr = MatDestroy(&jac->C);CHKERRQ(ierr);
13986bf688a0SCe Qin     ierr = MatConvert(C,MATHYPRE,MAT_INITIAL_MATRIX,&jac->C);CHKERRQ(ierr);
13995ac14e1cSStefano Zampini   }
1400863406b8SStefano Zampini   PetscFunctionReturn(0);
1401863406b8SStefano Zampini }
1402863406b8SStefano Zampini 
1403863406b8SStefano Zampini /*@
1404863406b8SStefano Zampini  PCHYPRESetDiscreteCurl - Set discrete curl matrix
1405863406b8SStefano Zampini 
1406863406b8SStefano Zampini    Collective on PC
1407863406b8SStefano Zampini 
1408863406b8SStefano Zampini    Input Parameters:
1409863406b8SStefano Zampini +  pc - the preconditioning context
1410863406b8SStefano Zampini -  C - the discrete curl
1411863406b8SStefano Zampini 
1412863406b8SStefano Zampini    Level: intermediate
1413863406b8SStefano Zampini 
141495452b02SPatrick Sanan    Notes:
141595452b02SPatrick Sanan     C should have as many rows as the number of faces and as many columns as the number of edges in the mesh
1416863406b8SStefano Zampini           Each row of G has as many nonzeros as the number of edges of a face, with column indexes being the global indexes of the corresponding edge: matrix entries are +1 and -1 depending on edge orientation with respect to the face orientation
1417863406b8SStefano Zampini 
1418863406b8SStefano Zampini .seealso:
1419863406b8SStefano Zampini @*/
1420863406b8SStefano Zampini PetscErrorCode PCHYPRESetDiscreteCurl(PC pc, Mat C)
1421863406b8SStefano Zampini {
1422863406b8SStefano Zampini   PetscErrorCode ierr;
1423863406b8SStefano Zampini 
1424863406b8SStefano Zampini   PetscFunctionBegin;
1425863406b8SStefano Zampini   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
1426863406b8SStefano Zampini   PetscValidHeaderSpecific(C,MAT_CLASSID,2);
1427863406b8SStefano Zampini   PetscCheckSameComm(pc,1,C,2);
1428863406b8SStefano Zampini   ierr = PetscTryMethod(pc,"PCHYPRESetDiscreteCurl_C",(PC,Mat),(pc,C));CHKERRQ(ierr);
1429863406b8SStefano Zampini   PetscFunctionReturn(0);
1430863406b8SStefano Zampini }
1431863406b8SStefano Zampini 
14326bf688a0SCe Qin static PetscErrorCode PCHYPRESetInterpolations_HYPRE(PC pc, PetscInt dim, Mat RT_PiFull, Mat RT_Pi[], Mat ND_PiFull, Mat ND_Pi[])
14336bf688a0SCe Qin {
14346bf688a0SCe Qin   PC_HYPRE       *jac = (PC_HYPRE*)pc->data;
14356bf688a0SCe Qin   PetscBool      ishypre;
14366bf688a0SCe Qin   PetscErrorCode ierr;
14376bf688a0SCe Qin   PetscInt       i;
14386bf688a0SCe Qin   PetscFunctionBegin;
14396bf688a0SCe Qin 
14406bf688a0SCe Qin   ierr = MatDestroy(&jac->RT_PiFull);CHKERRQ(ierr);
14416bf688a0SCe Qin   ierr = MatDestroy(&jac->ND_PiFull);CHKERRQ(ierr);
14426bf688a0SCe Qin   for (i=0;i<3;++i) {
14436bf688a0SCe Qin     ierr = MatDestroy(&jac->RT_Pi[i]);CHKERRQ(ierr);
14446bf688a0SCe Qin     ierr = MatDestroy(&jac->ND_Pi[i]);CHKERRQ(ierr);
14456bf688a0SCe Qin   }
14466bf688a0SCe Qin 
14476bf688a0SCe Qin   jac->dim = dim;
14486bf688a0SCe Qin   if (RT_PiFull) {
14496bf688a0SCe Qin     ierr = PetscObjectTypeCompare((PetscObject)RT_PiFull,MATHYPRE,&ishypre);CHKERRQ(ierr);
14506bf688a0SCe Qin     if (ishypre) {
14516bf688a0SCe Qin       ierr = PetscObjectReference((PetscObject)RT_PiFull);CHKERRQ(ierr);
14526bf688a0SCe Qin       jac->RT_PiFull = RT_PiFull;
14536bf688a0SCe Qin     } else {
14546bf688a0SCe Qin       ierr = MatConvert(RT_PiFull,MATHYPRE,MAT_INITIAL_MATRIX,&jac->RT_PiFull);CHKERRQ(ierr);
14556bf688a0SCe Qin     }
14566bf688a0SCe Qin   }
14576bf688a0SCe Qin   if (RT_Pi) {
14586bf688a0SCe Qin     for (i=0;i<dim;++i) {
14596bf688a0SCe Qin       if (RT_Pi[i]) {
14606bf688a0SCe Qin         ierr = PetscObjectTypeCompare((PetscObject)RT_Pi[i],MATHYPRE,&ishypre);CHKERRQ(ierr);
14616bf688a0SCe Qin         if (ishypre) {
14626bf688a0SCe Qin           ierr = PetscObjectReference((PetscObject)RT_Pi[i]);CHKERRQ(ierr);
14636bf688a0SCe Qin           jac->RT_Pi[i] = RT_Pi[i];
14646bf688a0SCe Qin         } else {
14656bf688a0SCe Qin           ierr = MatConvert(RT_Pi[i],MATHYPRE,MAT_INITIAL_MATRIX,&jac->RT_Pi[i]);CHKERRQ(ierr);
14666bf688a0SCe Qin         }
14676bf688a0SCe Qin       }
14686bf688a0SCe Qin     }
14696bf688a0SCe Qin   }
14706bf688a0SCe Qin   if (ND_PiFull) {
14716bf688a0SCe Qin     ierr = PetscObjectTypeCompare((PetscObject)ND_PiFull,MATHYPRE,&ishypre);CHKERRQ(ierr);
14726bf688a0SCe Qin     if (ishypre) {
14736bf688a0SCe Qin       ierr = PetscObjectReference((PetscObject)ND_PiFull);CHKERRQ(ierr);
14746bf688a0SCe Qin       jac->ND_PiFull = ND_PiFull;
14756bf688a0SCe Qin     } else {
14766bf688a0SCe Qin       ierr = MatConvert(ND_PiFull,MATHYPRE,MAT_INITIAL_MATRIX,&jac->ND_PiFull);CHKERRQ(ierr);
14776bf688a0SCe Qin     }
14786bf688a0SCe Qin   }
14796bf688a0SCe Qin   if (ND_Pi) {
14806bf688a0SCe Qin     for (i=0;i<dim;++i) {
14816bf688a0SCe Qin       if (ND_Pi[i]) {
14826bf688a0SCe Qin         ierr = PetscObjectTypeCompare((PetscObject)ND_Pi[i],MATHYPRE,&ishypre);CHKERRQ(ierr);
14836bf688a0SCe Qin         if (ishypre) {
14846bf688a0SCe Qin           ierr = PetscObjectReference((PetscObject)ND_Pi[i]);CHKERRQ(ierr);
14856bf688a0SCe Qin           jac->ND_Pi[i] = ND_Pi[i];
14866bf688a0SCe Qin         } else {
14876bf688a0SCe Qin           ierr = MatConvert(ND_Pi[i],MATHYPRE,MAT_INITIAL_MATRIX,&jac->ND_Pi[i]);CHKERRQ(ierr);
14886bf688a0SCe Qin         }
14896bf688a0SCe Qin       }
14906bf688a0SCe Qin     }
14916bf688a0SCe Qin   }
14926bf688a0SCe Qin 
14936bf688a0SCe Qin   PetscFunctionReturn(0);
14946bf688a0SCe Qin }
14956bf688a0SCe Qin 
14966bf688a0SCe Qin /*@
14976bf688a0SCe Qin  PCHYPRESetInterpolations - Set interpolation matrices for AMS/ADS preconditioner
14986bf688a0SCe Qin 
14996bf688a0SCe Qin    Collective on PC
15006bf688a0SCe Qin 
15016bf688a0SCe Qin    Input Parameters:
15026bf688a0SCe Qin +  pc - the preconditioning context
15036bf688a0SCe Qin -  dim - the dimension of the problem, only used in AMS
15046bf688a0SCe Qin -  RT_PiFull - Raviart-Thomas interpolation matrix
15056bf688a0SCe Qin -  RT_Pi - x/y/z component of Raviart-Thomas interpolation matrix
15066bf688a0SCe Qin -  ND_PiFull - Nedelec interpolation matrix
15076bf688a0SCe Qin -  ND_Pi - x/y/z component of Nedelec interpolation matrix
15086bf688a0SCe Qin 
150995452b02SPatrick Sanan    Notes:
151095452b02SPatrick Sanan     For AMS, only Nedelec interpolation matrices are needed, the Raviart-Thomas interpolation matrices can be set to NULL.
15116bf688a0SCe Qin           For ADS, both type of interpolation matrices are needed.
15126bf688a0SCe Qin    Level: intermediate
15136bf688a0SCe Qin 
15146bf688a0SCe Qin .seealso:
15156bf688a0SCe Qin @*/
15166bf688a0SCe Qin PetscErrorCode PCHYPRESetInterpolations(PC pc, PetscInt dim, Mat RT_PiFull, Mat RT_Pi[], Mat ND_PiFull, Mat ND_Pi[])
15176bf688a0SCe Qin {
15186bf688a0SCe Qin   PetscErrorCode ierr;
15196bf688a0SCe Qin   PetscInt       i;
15206bf688a0SCe Qin 
15216bf688a0SCe Qin   PetscFunctionBegin;
15226bf688a0SCe Qin   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
15236bf688a0SCe Qin   if (RT_PiFull) {
15246bf688a0SCe Qin     PetscValidHeaderSpecific(RT_PiFull,MAT_CLASSID,3);
15256bf688a0SCe Qin     PetscCheckSameComm(pc,1,RT_PiFull,3);
15266bf688a0SCe Qin   }
15276bf688a0SCe Qin   if (RT_Pi) {
15286bf688a0SCe Qin     PetscValidPointer(RT_Pi,4);
15296bf688a0SCe Qin     for (i=0;i<dim;++i) {
15306bf688a0SCe Qin       if (RT_Pi[i]) {
15316bf688a0SCe Qin         PetscValidHeaderSpecific(RT_Pi[i],MAT_CLASSID,4);
15326bf688a0SCe Qin         PetscCheckSameComm(pc,1,RT_Pi[i],4);
15336bf688a0SCe Qin       }
15346bf688a0SCe Qin     }
15356bf688a0SCe Qin   }
15366bf688a0SCe Qin   if (ND_PiFull) {
15376bf688a0SCe Qin     PetscValidHeaderSpecific(ND_PiFull,MAT_CLASSID,5);
15386bf688a0SCe Qin     PetscCheckSameComm(pc,1,ND_PiFull,5);
15396bf688a0SCe Qin   }
15406bf688a0SCe Qin   if (ND_Pi) {
15416bf688a0SCe Qin     PetscValidPointer(ND_Pi,6);
15426bf688a0SCe Qin     for (i=0;i<dim;++i) {
15436bf688a0SCe Qin       if (ND_Pi[i]) {
15446bf688a0SCe Qin         PetscValidHeaderSpecific(ND_Pi[i],MAT_CLASSID,6);
15456bf688a0SCe Qin         PetscCheckSameComm(pc,1,ND_Pi[i],6);
15466bf688a0SCe Qin       }
15476bf688a0SCe Qin     }
15486bf688a0SCe Qin   }
15496bf688a0SCe Qin   ierr = PetscTryMethod(pc,"PCHYPRESetInterpolations_C",(PC,PetscInt,Mat,Mat[],Mat,Mat[]),(pc,dim,RT_PiFull,RT_Pi,ND_PiFull,ND_Pi));CHKERRQ(ierr);
15506bf688a0SCe Qin   PetscFunctionReturn(0);
15516bf688a0SCe Qin }
15526bf688a0SCe Qin 
15535ac14e1cSStefano Zampini static PetscErrorCode PCHYPRESetPoissonMatrix_HYPRE(PC pc, Mat A, PetscBool isalpha)
15544cb006feSStefano Zampini {
15554cb006feSStefano Zampini   PC_HYPRE       *jac = (PC_HYPRE*)pc->data;
15565ac14e1cSStefano Zampini   PetscBool      ishypre;
15574cb006feSStefano Zampini   PetscErrorCode ierr;
15584cb006feSStefano Zampini 
15594cb006feSStefano Zampini   PetscFunctionBegin;
15605ac14e1cSStefano Zampini   ierr = PetscObjectTypeCompare((PetscObject)A,MATHYPRE,&ishypre);CHKERRQ(ierr);
15615ac14e1cSStefano Zampini   if (ishypre) {
15625ac14e1cSStefano Zampini     if (isalpha) {
15635ac14e1cSStefano Zampini       ierr = PetscObjectReference((PetscObject)A);CHKERRQ(ierr);
15645ac14e1cSStefano Zampini       ierr = MatDestroy(&jac->alpha_Poisson);CHKERRQ(ierr);
15655ac14e1cSStefano Zampini       jac->alpha_Poisson = A;
15665ac14e1cSStefano Zampini     } else {
15675ac14e1cSStefano Zampini       if (A) {
15685ac14e1cSStefano Zampini         ierr = PetscObjectReference((PetscObject)A);CHKERRQ(ierr);
15695ac14e1cSStefano Zampini       } else {
15705ac14e1cSStefano Zampini         jac->ams_beta_is_zero = PETSC_TRUE;
15715ac14e1cSStefano Zampini       }
15725ac14e1cSStefano Zampini       ierr = MatDestroy(&jac->beta_Poisson);CHKERRQ(ierr);
15735ac14e1cSStefano Zampini       jac->beta_Poisson = A;
15745ac14e1cSStefano Zampini     }
15755ac14e1cSStefano Zampini   } else {
15765ac14e1cSStefano Zampini     if (isalpha) {
15776bf688a0SCe Qin       ierr = MatDestroy(&jac->alpha_Poisson);CHKERRQ(ierr);
15786bf688a0SCe Qin       ierr = MatConvert(A,MATHYPRE,MAT_INITIAL_MATRIX,&jac->alpha_Poisson);CHKERRQ(ierr);
15795ac14e1cSStefano Zampini     } else {
15805ac14e1cSStefano Zampini       if (A) {
15816bf688a0SCe Qin         ierr = MatDestroy(&jac->beta_Poisson);CHKERRQ(ierr);
15826bf688a0SCe Qin         ierr = MatConvert(A,MATHYPRE,MAT_INITIAL_MATRIX,&jac->beta_Poisson);CHKERRQ(ierr);
15835ac14e1cSStefano Zampini       } else {
15845ac14e1cSStefano Zampini         ierr = MatDestroy(&jac->beta_Poisson);CHKERRQ(ierr);
15855ac14e1cSStefano Zampini         jac->ams_beta_is_zero = PETSC_TRUE;
15865ac14e1cSStefano Zampini       }
15875ac14e1cSStefano Zampini     }
15885ac14e1cSStefano Zampini   }
15894cb006feSStefano Zampini   PetscFunctionReturn(0);
15904cb006feSStefano Zampini }
15914cb006feSStefano Zampini 
15924cb006feSStefano Zampini /*@
15934cb006feSStefano Zampini  PCHYPRESetAlphaPoissonMatrix - Set vector Poisson matrix
15944cb006feSStefano Zampini 
15954cb006feSStefano Zampini    Collective on PC
15964cb006feSStefano Zampini 
15974cb006feSStefano Zampini    Input Parameters:
15984cb006feSStefano Zampini +  pc - the preconditioning context
15994cb006feSStefano Zampini -  A - the matrix
16004cb006feSStefano Zampini 
16014cb006feSStefano Zampini    Level: intermediate
16024cb006feSStefano Zampini 
160395452b02SPatrick Sanan    Notes:
160495452b02SPatrick Sanan     A should be obtained by discretizing the vector valued Poisson problem with linear finite elements
16054cb006feSStefano Zampini 
16064cb006feSStefano Zampini .seealso:
16074cb006feSStefano Zampini @*/
16084cb006feSStefano Zampini PetscErrorCode PCHYPRESetAlphaPoissonMatrix(PC pc, Mat A)
16094cb006feSStefano Zampini {
16104cb006feSStefano Zampini   PetscErrorCode ierr;
16114cb006feSStefano Zampini 
16124cb006feSStefano Zampini   PetscFunctionBegin;
16134cb006feSStefano Zampini   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
16144cb006feSStefano Zampini   PetscValidHeaderSpecific(A,MAT_CLASSID,2);
16154cb006feSStefano Zampini   PetscCheckSameComm(pc,1,A,2);
16165ac14e1cSStefano Zampini   ierr = PetscTryMethod(pc,"PCHYPRESetPoissonMatrix_C",(PC,Mat,PetscBool),(pc,A,PETSC_TRUE));CHKERRQ(ierr);
16174cb006feSStefano Zampini   PetscFunctionReturn(0);
16184cb006feSStefano Zampini }
16194cb006feSStefano Zampini 
16204cb006feSStefano Zampini /*@
16214cb006feSStefano Zampini  PCHYPRESetBetaPoissonMatrix - Set Poisson matrix
16224cb006feSStefano Zampini 
16234cb006feSStefano Zampini    Collective on PC
16244cb006feSStefano Zampini 
16254cb006feSStefano Zampini    Input Parameters:
16264cb006feSStefano Zampini +  pc - the preconditioning context
16274cb006feSStefano Zampini -  A - the matrix
16284cb006feSStefano Zampini 
16294cb006feSStefano Zampini    Level: intermediate
16304cb006feSStefano Zampini 
163195452b02SPatrick Sanan    Notes:
163295452b02SPatrick Sanan     A should be obtained by discretizing the Poisson problem with linear finite elements.
16334cb006feSStefano Zampini           Following HYPRE convention, the scalar Poisson solver of AMS can be turned off by passing NULL.
16344cb006feSStefano Zampini 
16354cb006feSStefano Zampini .seealso:
16364cb006feSStefano Zampini @*/
16374cb006feSStefano Zampini PetscErrorCode PCHYPRESetBetaPoissonMatrix(PC pc, Mat A)
16384cb006feSStefano Zampini {
16394cb006feSStefano Zampini   PetscErrorCode ierr;
16404cb006feSStefano Zampini 
16414cb006feSStefano Zampini   PetscFunctionBegin;
16424cb006feSStefano Zampini   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
16434cb006feSStefano Zampini   if (A) {
16444cb006feSStefano Zampini     PetscValidHeaderSpecific(A,MAT_CLASSID,2);
16454cb006feSStefano Zampini     PetscCheckSameComm(pc,1,A,2);
16464cb006feSStefano Zampini   }
16475ac14e1cSStefano Zampini   ierr = PetscTryMethod(pc,"PCHYPRESetPoissonMatrix_C",(PC,Mat,PetscBool),(pc,A,PETSC_FALSE));CHKERRQ(ierr);
16484cb006feSStefano Zampini   PetscFunctionReturn(0);
16494cb006feSStefano Zampini }
16504cb006feSStefano Zampini 
16515ac14e1cSStefano Zampini static PetscErrorCode PCHYPRESetEdgeConstantVectors_HYPRE(PC pc,Vec ozz, Vec zoz, Vec zzo)
16524cb006feSStefano Zampini {
16534cb006feSStefano Zampini   PC_HYPRE           *jac = (PC_HYPRE*)pc->data;
16544cb006feSStefano Zampini   PetscErrorCode     ierr;
16554cb006feSStefano Zampini 
16564cb006feSStefano Zampini   PetscFunctionBegin;
16574cb006feSStefano Zampini   /* throw away any vector if already set */
16586ea7df73SStefano Zampini   ierr = VecHYPRE_IJVectorDestroy(&jac->constants[0]);CHKERRQ(ierr);
16596ea7df73SStefano Zampini   ierr = VecHYPRE_IJVectorDestroy(&jac->constants[1]);CHKERRQ(ierr);
16606ea7df73SStefano Zampini   ierr = VecHYPRE_IJVectorDestroy(&jac->constants[2]);CHKERRQ(ierr);
16616ea7df73SStefano Zampini   ierr = VecHYPRE_IJVectorCreate(ozz->map,&jac->constants[0]);CHKERRQ(ierr);
16624cb006feSStefano Zampini   ierr = VecHYPRE_IJVectorCopy(ozz,jac->constants[0]);CHKERRQ(ierr);
16636ea7df73SStefano Zampini   ierr = VecHYPRE_IJVectorCreate(zoz->map,&jac->constants[1]);CHKERRQ(ierr);
16644cb006feSStefano Zampini   ierr = VecHYPRE_IJVectorCopy(zoz,jac->constants[1]);CHKERRQ(ierr);
16655ac14e1cSStefano Zampini   jac->dim = 2;
16664cb006feSStefano Zampini   if (zzo) {
16676ea7df73SStefano Zampini     ierr = VecHYPRE_IJVectorCreate(zzo->map,&jac->constants[2]);CHKERRQ(ierr);
16684cb006feSStefano Zampini     ierr = VecHYPRE_IJVectorCopy(zzo,jac->constants[2]);CHKERRQ(ierr);
16695ac14e1cSStefano Zampini     jac->dim++;
16704cb006feSStefano Zampini   }
16714cb006feSStefano Zampini   PetscFunctionReturn(0);
16724cb006feSStefano Zampini }
16734cb006feSStefano Zampini 
16744cb006feSStefano Zampini /*@
16754cb006feSStefano Zampini  PCHYPRESetEdgeConstantVectors - Set the representation of the constant vector fields in edge element basis
16764cb006feSStefano Zampini 
16774cb006feSStefano Zampini    Collective on PC
16784cb006feSStefano Zampini 
16794cb006feSStefano Zampini    Input Parameters:
16804cb006feSStefano Zampini +  pc - the preconditioning context
16814cb006feSStefano Zampini -  ozz - vector representing (1,0,0) (or (1,0) in 2D)
16824cb006feSStefano Zampini -  zoz - vector representing (0,1,0) (or (0,1) in 2D)
16834cb006feSStefano Zampini -  zzo - vector representing (0,0,1) (use NULL in 2D)
16844cb006feSStefano Zampini 
16854cb006feSStefano Zampini    Level: intermediate
16864cb006feSStefano Zampini 
16874cb006feSStefano Zampini    Notes:
16884cb006feSStefano Zampini 
16894cb006feSStefano Zampini .seealso:
16904cb006feSStefano Zampini @*/
16914cb006feSStefano Zampini PetscErrorCode PCHYPRESetEdgeConstantVectors(PC pc, Vec ozz, Vec zoz, Vec zzo)
16924cb006feSStefano Zampini {
16934cb006feSStefano Zampini   PetscErrorCode ierr;
16944cb006feSStefano Zampini 
16954cb006feSStefano Zampini   PetscFunctionBegin;
16964cb006feSStefano Zampini   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
16974cb006feSStefano Zampini   PetscValidHeaderSpecific(ozz,VEC_CLASSID,2);
16984cb006feSStefano Zampini   PetscValidHeaderSpecific(zoz,VEC_CLASSID,3);
16994cb006feSStefano Zampini   if (zzo) PetscValidHeaderSpecific(zzo,VEC_CLASSID,4);
17004cb006feSStefano Zampini   PetscCheckSameComm(pc,1,ozz,2);
17014cb006feSStefano Zampini   PetscCheckSameComm(pc,1,zoz,3);
17024cb006feSStefano Zampini   if (zzo) PetscCheckSameComm(pc,1,zzo,4);
17034cb006feSStefano Zampini   ierr = PetscTryMethod(pc,"PCHYPRESetEdgeConstantVectors_C",(PC,Vec,Vec,Vec),(pc,ozz,zoz,zzo));CHKERRQ(ierr);
17044cb006feSStefano Zampini   PetscFunctionReturn(0);
17054cb006feSStefano Zampini }
17064cb006feSStefano Zampini 
1707863406b8SStefano Zampini static PetscErrorCode PCSetCoordinates_HYPRE(PC pc, PetscInt dim, PetscInt nloc, PetscReal *coords)
17084cb006feSStefano Zampini {
17094cb006feSStefano Zampini   PC_HYPRE        *jac = (PC_HYPRE*)pc->data;
17104cb006feSStefano Zampini   Vec             tv;
17114cb006feSStefano Zampini   PetscInt        i;
17124cb006feSStefano Zampini   PetscErrorCode  ierr;
17134cb006feSStefano Zampini 
17144cb006feSStefano Zampini   PetscFunctionBegin;
17154cb006feSStefano Zampini   /* throw away any coordinate vector if already set */
17166ea7df73SStefano Zampini   ierr = VecHYPRE_IJVectorDestroy(&jac->coords[0]);CHKERRQ(ierr);
17176ea7df73SStefano Zampini   ierr = VecHYPRE_IJVectorDestroy(&jac->coords[1]);CHKERRQ(ierr);
17186ea7df73SStefano Zampini   ierr = VecHYPRE_IJVectorDestroy(&jac->coords[2]);CHKERRQ(ierr);
17195ac14e1cSStefano Zampini   jac->dim = dim;
17205ac14e1cSStefano Zampini 
17214cb006feSStefano Zampini   /* compute IJ vector for coordinates */
17224cb006feSStefano Zampini   ierr = VecCreate(PetscObjectComm((PetscObject)pc),&tv);CHKERRQ(ierr);
17234cb006feSStefano Zampini   ierr = VecSetType(tv,VECSTANDARD);CHKERRQ(ierr);
17244cb006feSStefano Zampini   ierr = VecSetSizes(tv,nloc,PETSC_DECIDE);CHKERRQ(ierr);
17254cb006feSStefano Zampini   for (i=0;i<dim;i++) {
17264cb006feSStefano Zampini     PetscScalar *array;
17274cb006feSStefano Zampini     PetscInt    j;
17284cb006feSStefano Zampini 
17296ea7df73SStefano Zampini     ierr = VecHYPRE_IJVectorCreate(tv->map,&jac->coords[i]);CHKERRQ(ierr);
1730589dcaf0SStefano Zampini     ierr = VecGetArrayWrite(tv,&array);CHKERRQ(ierr);
17316ea7df73SStefano Zampini     for (j=0;j<nloc;j++) array[j] = coords[j*dim+i];
1732589dcaf0SStefano Zampini     ierr = VecRestoreArrayWrite(tv,&array);CHKERRQ(ierr);
17336ea7df73SStefano Zampini     ierr = VecHYPRE_IJVectorCopy(tv,jac->coords[i]);CHKERRQ(ierr);
17344cb006feSStefano Zampini   }
17354cb006feSStefano Zampini   ierr = VecDestroy(&tv);CHKERRQ(ierr);
17364cb006feSStefano Zampini   PetscFunctionReturn(0);
17374cb006feSStefano Zampini }
17384cb006feSStefano Zampini 
173916d9e3a6SLisandro Dalcin /* ---------------------------------------------------------------------------------*/
174016d9e3a6SLisandro Dalcin 
1741f7a08781SBarry Smith static PetscErrorCode  PCHYPREGetType_HYPRE(PC pc,const char *name[])
174216d9e3a6SLisandro Dalcin {
174316d9e3a6SLisandro Dalcin   PC_HYPRE *jac = (PC_HYPRE*)pc->data;
174416d9e3a6SLisandro Dalcin 
174516d9e3a6SLisandro Dalcin   PetscFunctionBegin;
174616d9e3a6SLisandro Dalcin   *name = jac->hypre_type;
174716d9e3a6SLisandro Dalcin   PetscFunctionReturn(0);
174816d9e3a6SLisandro Dalcin }
174916d9e3a6SLisandro Dalcin 
1750f7a08781SBarry Smith static PetscErrorCode  PCHYPRESetType_HYPRE(PC pc,const char name[])
175116d9e3a6SLisandro Dalcin {
175216d9e3a6SLisandro Dalcin   PC_HYPRE       *jac = (PC_HYPRE*)pc->data;
175316d9e3a6SLisandro Dalcin   PetscErrorCode ierr;
1754ace3abfcSBarry Smith   PetscBool      flag;
175516d9e3a6SLisandro Dalcin 
175616d9e3a6SLisandro Dalcin   PetscFunctionBegin;
175716d9e3a6SLisandro Dalcin   if (jac->hypre_type) {
175816d9e3a6SLisandro Dalcin     ierr = PetscStrcmp(jac->hypre_type,name,&flag);CHKERRQ(ierr);
1759ce94432eSBarry Smith     if (!flag) SETERRQ(PetscObjectComm((PetscObject)pc),PETSC_ERR_ORDER,"Cannot reset the HYPRE preconditioner type once it has been set");
176016d9e3a6SLisandro Dalcin     PetscFunctionReturn(0);
176116d9e3a6SLisandro Dalcin   } else {
176216d9e3a6SLisandro Dalcin     ierr = PetscStrallocpy(name, &jac->hypre_type);CHKERRQ(ierr);
176316d9e3a6SLisandro Dalcin   }
176416d9e3a6SLisandro Dalcin 
176516d9e3a6SLisandro Dalcin   jac->maxiter         = PETSC_DEFAULT;
176616d9e3a6SLisandro Dalcin   jac->tol             = PETSC_DEFAULT;
176716d9e3a6SLisandro Dalcin   jac->printstatistics = PetscLogPrintInfo;
176816d9e3a6SLisandro Dalcin 
176916d9e3a6SLisandro Dalcin   ierr = PetscStrcmp("pilut",jac->hypre_type,&flag);CHKERRQ(ierr);
177016d9e3a6SLisandro Dalcin   if (flag) {
1771ffc4695bSBarry Smith     ierr = MPI_Comm_dup(PetscObjectComm((PetscObject)pc),&(jac->comm_hypre));CHKERRMPI(ierr);
1772fd3f9acdSBarry Smith     PetscStackCallStandard(HYPRE_ParCSRPilutCreate,(jac->comm_hypre,&jac->hsolver));
177316d9e3a6SLisandro Dalcin     pc->ops->setfromoptions = PCSetFromOptions_HYPRE_Pilut;
177416d9e3a6SLisandro Dalcin     pc->ops->view           = PCView_HYPRE_Pilut;
177516d9e3a6SLisandro Dalcin     jac->destroy            = HYPRE_ParCSRPilutDestroy;
177616d9e3a6SLisandro Dalcin     jac->setup              = HYPRE_ParCSRPilutSetup;
177716d9e3a6SLisandro Dalcin     jac->solve              = HYPRE_ParCSRPilutSolve;
177816d9e3a6SLisandro Dalcin     jac->factorrowsize      = PETSC_DEFAULT;
177916d9e3a6SLisandro Dalcin     PetscFunctionReturn(0);
178016d9e3a6SLisandro Dalcin   }
1781db966c6cSHong Zhang   ierr = PetscStrcmp("euclid",jac->hypre_type,&flag);CHKERRQ(ierr);
1782db966c6cSHong Zhang   if (flag) {
17838bf83915SBarry Smith #if defined(PETSC_HAVE_64BIT_INDICES)
17848bf83915SBarry Smith     SETERRQ(PetscObjectComm((PetscObject)pc),PETSC_ERR_SUP,"Hypre Euclid not support with 64 bit indices");
17858bf83915SBarry Smith #endif
1786ffc4695bSBarry Smith     ierr = MPI_Comm_dup(PetscObjectComm((PetscObject)pc),&(jac->comm_hypre));CHKERRMPI(ierr);
1787db966c6cSHong Zhang     PetscStackCallStandard(HYPRE_EuclidCreate,(jac->comm_hypre,&jac->hsolver));
1788db966c6cSHong Zhang     pc->ops->setfromoptions = PCSetFromOptions_HYPRE_Euclid;
1789db966c6cSHong Zhang     pc->ops->view           = PCView_HYPRE_Euclid;
1790db966c6cSHong Zhang     jac->destroy            = HYPRE_EuclidDestroy;
1791db966c6cSHong Zhang     jac->setup              = HYPRE_EuclidSetup;
1792db966c6cSHong Zhang     jac->solve              = HYPRE_EuclidSolve;
1793db966c6cSHong Zhang     jac->factorrowsize      = PETSC_DEFAULT;
1794db966c6cSHong Zhang     jac->eu_level           = PETSC_DEFAULT; /* default */
1795db966c6cSHong Zhang     PetscFunctionReturn(0);
1796db966c6cSHong Zhang   }
179716d9e3a6SLisandro Dalcin   ierr = PetscStrcmp("parasails",jac->hypre_type,&flag);CHKERRQ(ierr);
179816d9e3a6SLisandro Dalcin   if (flag) {
1799ffc4695bSBarry Smith     ierr = MPI_Comm_dup(PetscObjectComm((PetscObject)pc),&(jac->comm_hypre));CHKERRMPI(ierr);
1800fd3f9acdSBarry Smith     PetscStackCallStandard(HYPRE_ParaSailsCreate,(jac->comm_hypre,&jac->hsolver));
180116d9e3a6SLisandro Dalcin     pc->ops->setfromoptions = PCSetFromOptions_HYPRE_ParaSails;
180216d9e3a6SLisandro Dalcin     pc->ops->view           = PCView_HYPRE_ParaSails;
180316d9e3a6SLisandro Dalcin     jac->destroy            = HYPRE_ParaSailsDestroy;
180416d9e3a6SLisandro Dalcin     jac->setup              = HYPRE_ParaSailsSetup;
180516d9e3a6SLisandro Dalcin     jac->solve              = HYPRE_ParaSailsSolve;
180616d9e3a6SLisandro Dalcin     /* initialize */
180716d9e3a6SLisandro Dalcin     jac->nlevels   = 1;
18088966356dSPierre Jolivet     jac->threshold = .1;
180916d9e3a6SLisandro Dalcin     jac->filter    = .1;
181016d9e3a6SLisandro Dalcin     jac->loadbal   = 0;
18112fa5cd67SKarl Rupp     if (PetscLogPrintInfo) jac->logging = (int) PETSC_TRUE;
18122fa5cd67SKarl Rupp     else jac->logging = (int) PETSC_FALSE;
18132fa5cd67SKarl Rupp 
181416d9e3a6SLisandro Dalcin     jac->ruse = (int) PETSC_FALSE;
181516d9e3a6SLisandro Dalcin     jac->symt = 0;
18168966356dSPierre Jolivet     PetscStackCallStandard(HYPRE_ParaSailsSetParams,(jac->hsolver,jac->threshold,jac->nlevels));
1817fd3f9acdSBarry Smith     PetscStackCallStandard(HYPRE_ParaSailsSetFilter,(jac->hsolver,jac->filter));
1818fd3f9acdSBarry Smith     PetscStackCallStandard(HYPRE_ParaSailsSetLoadbal,(jac->hsolver,jac->loadbal));
1819fd3f9acdSBarry Smith     PetscStackCallStandard(HYPRE_ParaSailsSetLogging,(jac->hsolver,jac->logging));
1820fd3f9acdSBarry Smith     PetscStackCallStandard(HYPRE_ParaSailsSetReuse,(jac->hsolver,jac->ruse));
1821fd3f9acdSBarry Smith     PetscStackCallStandard(HYPRE_ParaSailsSetSym,(jac->hsolver,jac->symt));
182216d9e3a6SLisandro Dalcin     PetscFunctionReturn(0);
182316d9e3a6SLisandro Dalcin   }
182416d9e3a6SLisandro Dalcin   ierr = PetscStrcmp("boomeramg",jac->hypre_type,&flag);CHKERRQ(ierr);
182516d9e3a6SLisandro Dalcin   if (flag) {
182616d9e3a6SLisandro Dalcin     ierr                     = HYPRE_BoomerAMGCreate(&jac->hsolver);
182716d9e3a6SLisandro Dalcin     pc->ops->setfromoptions  = PCSetFromOptions_HYPRE_BoomerAMG;
182816d9e3a6SLisandro Dalcin     pc->ops->view            = PCView_HYPRE_BoomerAMG;
182916d9e3a6SLisandro Dalcin     pc->ops->applytranspose  = PCApplyTranspose_HYPRE_BoomerAMG;
183016d9e3a6SLisandro Dalcin     pc->ops->applyrichardson = PCApplyRichardson_HYPRE_BoomerAMG;
1831fd2dd295SFande Kong     ierr = PetscObjectComposeFunction((PetscObject)pc,"PCGetInterpolations_C",PCGetInterpolations_BoomerAMG);CHKERRQ(ierr);
1832fd2dd295SFande Kong     ierr = PetscObjectComposeFunction((PetscObject)pc,"PCGetCoarseOperators_C",PCGetCoarseOperators_BoomerAMG);CHKERRQ(ierr);
183316d9e3a6SLisandro Dalcin     jac->destroy             = HYPRE_BoomerAMGDestroy;
183416d9e3a6SLisandro Dalcin     jac->setup               = HYPRE_BoomerAMGSetup;
183516d9e3a6SLisandro Dalcin     jac->solve               = HYPRE_BoomerAMGSolve;
183616d9e3a6SLisandro Dalcin     jac->applyrichardson     = PETSC_FALSE;
183716d9e3a6SLisandro Dalcin     /* these defaults match the hypre defaults */
183816d9e3a6SLisandro Dalcin     jac->cycletype        = 1;
183916d9e3a6SLisandro Dalcin     jac->maxlevels        = 25;
184016d9e3a6SLisandro Dalcin     jac->maxiter          = 1;
18418f87f92bSBarry Smith     jac->tol              = 0.0; /* tolerance of zero indicates use as preconditioner (suppresses convergence errors) */
184216d9e3a6SLisandro Dalcin     jac->truncfactor      = 0.0;
184316d9e3a6SLisandro Dalcin     jac->strongthreshold  = .25;
184416d9e3a6SLisandro Dalcin     jac->maxrowsum        = .9;
184516d9e3a6SLisandro Dalcin     jac->coarsentype      = 6;
184616d9e3a6SLisandro Dalcin     jac->measuretype      = 0;
18470f1074feSSatish Balay     jac->gridsweeps[0]    = jac->gridsweeps[1] = jac->gridsweeps[2] = 1;
18486a251517SEike Mueller     jac->smoothtype       = -1; /* Not set by default */
1849b9eb5777SEike Mueller     jac->smoothnumlevels  = 25;
18501810e44eSEike Mueller     jac->eu_level         = 0;
18511810e44eSEike Mueller     jac->eu_droptolerance = 0;
18521810e44eSEike Mueller     jac->eu_bj            = 0;
1853589dcaf0SStefano Zampini     jac->relaxtype[0]     = jac->relaxtype[1] = 6; /* Defaults to SYMMETRIC since in PETSc we are using a PC - most likely with CG */
18540f1074feSSatish Balay     jac->relaxtype[2]     = 9; /*G.E. */
185516d9e3a6SLisandro Dalcin     jac->relaxweight      = 1.0;
185616d9e3a6SLisandro Dalcin     jac->outerrelaxweight = 1.0;
185716d9e3a6SLisandro Dalcin     jac->relaxorder       = 1;
18580f1074feSSatish Balay     jac->interptype       = 0;
1859589dcaf0SStefano Zampini     jac->Rtype            = 0;
1860589dcaf0SStefano Zampini     jac->Rstrongthreshold = 0.25;
1861589dcaf0SStefano Zampini     jac->Rfilterthreshold = 0.0;
1862589dcaf0SStefano Zampini     jac->Adroptype        = -1;
1863589dcaf0SStefano Zampini     jac->Adroptol         = 0.0;
18640f1074feSSatish Balay     jac->agg_nl           = 0;
18656ea7df73SStefano Zampini     jac->agg_interptype   = 4;
18660f1074feSSatish Balay     jac->pmax             = 0;
18670f1074feSSatish Balay     jac->truncfactor      = 0.0;
18680f1074feSSatish Balay     jac->agg_num_paths    = 1;
1869589dcaf0SStefano Zampini     jac->maxc             = 9;
1870589dcaf0SStefano Zampini     jac->minc             = 1;
18718f87f92bSBarry Smith 
187222e51d31SStefano Zampini     jac->nodal_coarsening      = 0;
187322e51d31SStefano Zampini     jac->nodal_coarsening_diag = 0;
187422e51d31SStefano Zampini     jac->vec_interp_variant    = 0;
187522e51d31SStefano Zampini     jac->vec_interp_qmax       = 0;
187622e51d31SStefano Zampini     jac->vec_interp_smooth     = PETSC_FALSE;
187722e51d31SStefano Zampini     jac->interp_refine         = 0;
18788f87f92bSBarry Smith     jac->nodal_relax           = PETSC_FALSE;
18798f87f92bSBarry Smith     jac->nodal_relax_levels    = 1;
18806ea7df73SStefano Zampini     jac->rap2                  = 0;
18816ea7df73SStefano Zampini 
18826ea7df73SStefano Zampini     /* GPU defaults
18836ea7df73SStefano Zampini          from https://hypre.readthedocs.io/en/latest/solvers-boomeramg.html#gpu-supported-options
18846ea7df73SStefano Zampini          and /src/parcsr_ls/par_amg.c */
18856ea7df73SStefano Zampini #if defined(PETSC_HAVE_HYPRE_DEVICE)
18866ea7df73SStefano Zampini     jac->keeptranspose         = PETSC_TRUE;
18876ea7df73SStefano Zampini     jac->mod_rap2              = 1;
18886ea7df73SStefano Zampini     jac->coarsentype           = 8;
18896ea7df73SStefano Zampini     jac->relaxorder            = 0;
18906ea7df73SStefano Zampini     jac->interptype            = 6;
18916ea7df73SStefano Zampini     jac->relaxtype[0]          = 18;
18926ea7df73SStefano Zampini     jac->relaxtype[1]          = 18;
18936ea7df73SStefano Zampini     jac->agg_interptype        = 7;
18946ea7df73SStefano Zampini #else
18956ea7df73SStefano Zampini     jac->keeptranspose         = PETSC_FALSE;
18966ea7df73SStefano Zampini     jac->mod_rap2              = 0;
18976ea7df73SStefano Zampini #endif
1898fd3f9acdSBarry Smith     PetscStackCallStandard(HYPRE_BoomerAMGSetCycleType,(jac->hsolver,jac->cycletype));
1899fd3f9acdSBarry Smith     PetscStackCallStandard(HYPRE_BoomerAMGSetMaxLevels,(jac->hsolver,jac->maxlevels));
1900fd3f9acdSBarry Smith     PetscStackCallStandard(HYPRE_BoomerAMGSetMaxIter,(jac->hsolver,jac->maxiter));
1901fd3f9acdSBarry Smith     PetscStackCallStandard(HYPRE_BoomerAMGSetTol,(jac->hsolver,jac->tol));
1902fd3f9acdSBarry Smith     PetscStackCallStandard(HYPRE_BoomerAMGSetTruncFactor,(jac->hsolver,jac->truncfactor));
1903fd3f9acdSBarry Smith     PetscStackCallStandard(HYPRE_BoomerAMGSetStrongThreshold,(jac->hsolver,jac->strongthreshold));
1904fd3f9acdSBarry Smith     PetscStackCallStandard(HYPRE_BoomerAMGSetMaxRowSum,(jac->hsolver,jac->maxrowsum));
1905fd3f9acdSBarry Smith     PetscStackCallStandard(HYPRE_BoomerAMGSetCoarsenType,(jac->hsolver,jac->coarsentype));
1906fd3f9acdSBarry Smith     PetscStackCallStandard(HYPRE_BoomerAMGSetMeasureType,(jac->hsolver,jac->measuretype));
1907fd3f9acdSBarry Smith     PetscStackCallStandard(HYPRE_BoomerAMGSetRelaxOrder,(jac->hsolver, jac->relaxorder));
1908fd3f9acdSBarry Smith     PetscStackCallStandard(HYPRE_BoomerAMGSetInterpType,(jac->hsolver,jac->interptype));
1909fd3f9acdSBarry Smith     PetscStackCallStandard(HYPRE_BoomerAMGSetAggNumLevels,(jac->hsolver,jac->agg_nl));
19106ea7df73SStefano Zampini     PetscStackCallStandard(HYPRE_BoomerAMGSetAggInterpType,(jac->hsolver,jac->agg_interptype));
1911fd3f9acdSBarry Smith     PetscStackCallStandard(HYPRE_BoomerAMGSetPMaxElmts,(jac->hsolver,jac->pmax));
1912fd3f9acdSBarry Smith     PetscStackCallStandard(HYPRE_BoomerAMGSetNumPaths,(jac->hsolver,jac->agg_num_paths));
1913fd3f9acdSBarry Smith     PetscStackCallStandard(HYPRE_BoomerAMGSetRelaxType,(jac->hsolver, jac->relaxtype[0]));  /* defaults coarse to 9 */
1914fd3f9acdSBarry Smith     PetscStackCallStandard(HYPRE_BoomerAMGSetNumSweeps,(jac->hsolver, jac->gridsweeps[0])); /* defaults coarse to 1 */
1915589dcaf0SStefano Zampini     PetscStackCallStandard(HYPRE_BoomerAMGSetMaxCoarseSize,(jac->hsolver, jac->maxc));
1916589dcaf0SStefano Zampini     PetscStackCallStandard(HYPRE_BoomerAMGSetMinCoarseSize,(jac->hsolver, jac->minc));
1917589dcaf0SStefano Zampini 
19186ea7df73SStefano Zampini     /* GPU */
19196ea7df73SStefano Zampini #if PETSC_PKG_HYPRE_VERSION_GE(2,18,0)
19206ea7df73SStefano Zampini     PetscStackCallStandard(HYPRE_BoomerAMGSetKeepTranspose,(jac->hsolver,jac->keeptranspose ? 1 : 0));
19216ea7df73SStefano Zampini     PetscStackCallStandard(HYPRE_BoomerAMGSetRAP2,(jac->hsolver, jac->rap2));
19226ea7df73SStefano Zampini     PetscStackCallStandard(HYPRE_BoomerAMGSetModuleRAP2,(jac->hsolver, jac->mod_rap2));
19236ea7df73SStefano Zampini #endif
19246ea7df73SStefano Zampini 
1925589dcaf0SStefano Zampini     /* AIR */
19266ea7df73SStefano Zampini #if PETSC_PKG_HYPRE_VERSION_GE(2,18,0)
1927589dcaf0SStefano Zampini     PetscStackCallStandard(HYPRE_BoomerAMGSetRestriction,(jac->hsolver,jac->Rtype));
1928589dcaf0SStefano Zampini     PetscStackCallStandard(HYPRE_BoomerAMGSetStrongThresholdR,(jac->hsolver,jac->Rstrongthreshold));
1929589dcaf0SStefano Zampini     PetscStackCallStandard(HYPRE_BoomerAMGSetFilterThresholdR,(jac->hsolver,jac->Rfilterthreshold));
1930589dcaf0SStefano Zampini     PetscStackCallStandard(HYPRE_BoomerAMGSetADropTol,(jac->hsolver,jac->Adroptol));
1931589dcaf0SStefano Zampini     PetscStackCallStandard(HYPRE_BoomerAMGSetADropType,(jac->hsolver,jac->Adroptype));
19326ea7df73SStefano Zampini #endif
193316d9e3a6SLisandro Dalcin     PetscFunctionReturn(0);
193416d9e3a6SLisandro Dalcin   }
19354cb006feSStefano Zampini   ierr = PetscStrcmp("ams",jac->hypre_type,&flag);CHKERRQ(ierr);
19364cb006feSStefano Zampini   if (flag) {
19374cb006feSStefano Zampini     ierr                     = HYPRE_AMSCreate(&jac->hsolver);
19384cb006feSStefano Zampini     pc->ops->setfromoptions  = PCSetFromOptions_HYPRE_AMS;
19394cb006feSStefano Zampini     pc->ops->view            = PCView_HYPRE_AMS;
19404cb006feSStefano Zampini     jac->destroy             = HYPRE_AMSDestroy;
19414cb006feSStefano Zampini     jac->setup               = HYPRE_AMSSetup;
19424cb006feSStefano Zampini     jac->solve               = HYPRE_AMSSolve;
19434cb006feSStefano Zampini     jac->coords[0]           = NULL;
19444cb006feSStefano Zampini     jac->coords[1]           = NULL;
19454cb006feSStefano Zampini     jac->coords[2]           = NULL;
19464cb006feSStefano Zampini     /* solver parameters: these are borrowed from mfem package, and they are not the default values from HYPRE AMS */
1947863406b8SStefano Zampini     jac->as_print           = 0;
1948863406b8SStefano Zampini     jac->as_max_iter        = 1; /* used as a preconditioner */
1949863406b8SStefano Zampini     jac->as_tol             = 0.; /* used as a preconditioner */
19504cb006feSStefano Zampini     jac->ams_cycle_type     = 13;
19514cb006feSStefano Zampini     /* Smoothing options */
1952863406b8SStefano Zampini     jac->as_relax_type      = 2;
1953863406b8SStefano Zampini     jac->as_relax_times     = 1;
1954863406b8SStefano Zampini     jac->as_relax_weight    = 1.0;
1955863406b8SStefano Zampini     jac->as_omega           = 1.0;
19564cb006feSStefano Zampini     /* Vector valued Poisson AMG solver parameters: coarsen type, agg_levels, relax_type, interp_type, Pmax */
1957863406b8SStefano Zampini     jac->as_amg_alpha_opts[0] = 10;
1958863406b8SStefano Zampini     jac->as_amg_alpha_opts[1] = 1;
19590bdd8552SBarry Smith     jac->as_amg_alpha_opts[2] = 6;
1960863406b8SStefano Zampini     jac->as_amg_alpha_opts[3] = 6;
1961863406b8SStefano Zampini     jac->as_amg_alpha_opts[4] = 4;
1962863406b8SStefano Zampini     jac->as_amg_alpha_theta   = 0.25;
19634cb006feSStefano Zampini     /* Scalar Poisson AMG solver parameters: coarsen type, agg_levels, relax_type, interp_type, Pmax */
1964863406b8SStefano Zampini     jac->as_amg_beta_opts[0] = 10;
1965863406b8SStefano Zampini     jac->as_amg_beta_opts[1] = 1;
19660bdd8552SBarry Smith     jac->as_amg_beta_opts[2] = 6;
1967863406b8SStefano Zampini     jac->as_amg_beta_opts[3] = 6;
1968863406b8SStefano Zampini     jac->as_amg_beta_opts[4] = 4;
1969863406b8SStefano Zampini     jac->as_amg_beta_theta   = 0.25;
1970863406b8SStefano Zampini     PetscStackCallStandard(HYPRE_AMSSetPrintLevel,(jac->hsolver,jac->as_print));
1971863406b8SStefano Zampini     PetscStackCallStandard(HYPRE_AMSSetMaxIter,(jac->hsolver,jac->as_max_iter));
19724cb006feSStefano Zampini     PetscStackCallStandard(HYPRE_AMSSetCycleType,(jac->hsolver,jac->ams_cycle_type));
1973863406b8SStefano Zampini     PetscStackCallStandard(HYPRE_AMSSetTol,(jac->hsolver,jac->as_tol));
1974863406b8SStefano Zampini     PetscStackCallStandard(HYPRE_AMSSetSmoothingOptions,(jac->hsolver,jac->as_relax_type,
1975863406b8SStefano Zampini                                                                       jac->as_relax_times,
1976863406b8SStefano Zampini                                                                       jac->as_relax_weight,
1977863406b8SStefano Zampini                                                                       jac->as_omega));
1978863406b8SStefano Zampini     PetscStackCallStandard(HYPRE_AMSSetAlphaAMGOptions,(jac->hsolver,jac->as_amg_alpha_opts[0],       /* AMG coarsen type */
1979863406b8SStefano Zampini                                                                      jac->as_amg_alpha_opts[1],       /* AMG agg_levels */
1980863406b8SStefano Zampini                                                                      jac->as_amg_alpha_opts[2],       /* AMG relax_type */
1981863406b8SStefano Zampini                                                                      jac->as_amg_alpha_theta,
1982863406b8SStefano Zampini                                                                      jac->as_amg_alpha_opts[3],       /* AMG interp_type */
1983863406b8SStefano Zampini                                                                      jac->as_amg_alpha_opts[4]));     /* AMG Pmax */
1984863406b8SStefano Zampini     PetscStackCallStandard(HYPRE_AMSSetBetaAMGOptions,(jac->hsolver,jac->as_amg_beta_opts[0],       /* AMG coarsen type */
1985863406b8SStefano Zampini                                                                     jac->as_amg_beta_opts[1],       /* AMG agg_levels */
1986863406b8SStefano Zampini                                                                     jac->as_amg_beta_opts[2],       /* AMG relax_type */
1987863406b8SStefano Zampini                                                                     jac->as_amg_beta_theta,
1988863406b8SStefano Zampini                                                                     jac->as_amg_beta_opts[3],       /* AMG interp_type */
1989863406b8SStefano Zampini                                                                     jac->as_amg_beta_opts[4]));     /* AMG Pmax */
199023df4f25SStefano Zampini     /* Zero conductivity */
199123df4f25SStefano Zampini     jac->ams_beta_is_zero      = PETSC_FALSE;
199223df4f25SStefano Zampini     jac->ams_beta_is_zero_part = PETSC_FALSE;
19934cb006feSStefano Zampini     PetscFunctionReturn(0);
19944cb006feSStefano Zampini   }
1995863406b8SStefano Zampini   ierr = PetscStrcmp("ads",jac->hypre_type,&flag);CHKERRQ(ierr);
1996863406b8SStefano Zampini   if (flag) {
1997863406b8SStefano Zampini     ierr                     = HYPRE_ADSCreate(&jac->hsolver);
1998863406b8SStefano Zampini     pc->ops->setfromoptions  = PCSetFromOptions_HYPRE_ADS;
1999863406b8SStefano Zampini     pc->ops->view            = PCView_HYPRE_ADS;
2000863406b8SStefano Zampini     jac->destroy             = HYPRE_ADSDestroy;
2001863406b8SStefano Zampini     jac->setup               = HYPRE_ADSSetup;
2002863406b8SStefano Zampini     jac->solve               = HYPRE_ADSSolve;
2003863406b8SStefano Zampini     jac->coords[0]           = NULL;
2004863406b8SStefano Zampini     jac->coords[1]           = NULL;
2005863406b8SStefano Zampini     jac->coords[2]           = NULL;
2006863406b8SStefano Zampini     /* solver parameters: these are borrowed from mfem package, and they are not the default values from HYPRE ADS */
2007863406b8SStefano Zampini     jac->as_print           = 0;
2008863406b8SStefano Zampini     jac->as_max_iter        = 1; /* used as a preconditioner */
2009863406b8SStefano Zampini     jac->as_tol             = 0.; /* used as a preconditioner */
2010863406b8SStefano Zampini     jac->ads_cycle_type     = 13;
2011863406b8SStefano Zampini     /* Smoothing options */
2012863406b8SStefano Zampini     jac->as_relax_type      = 2;
2013863406b8SStefano Zampini     jac->as_relax_times     = 1;
2014863406b8SStefano Zampini     jac->as_relax_weight    = 1.0;
2015863406b8SStefano Zampini     jac->as_omega           = 1.0;
2016863406b8SStefano Zampini     /* AMS solver parameters: cycle_type, coarsen type, agg_levels, relax_type, interp_type, Pmax */
2017863406b8SStefano Zampini     jac->ams_cycle_type       = 14;
2018863406b8SStefano Zampini     jac->as_amg_alpha_opts[0] = 10;
2019863406b8SStefano Zampini     jac->as_amg_alpha_opts[1] = 1;
2020863406b8SStefano Zampini     jac->as_amg_alpha_opts[2] = 6;
2021863406b8SStefano Zampini     jac->as_amg_alpha_opts[3] = 6;
2022863406b8SStefano Zampini     jac->as_amg_alpha_opts[4] = 4;
2023863406b8SStefano Zampini     jac->as_amg_alpha_theta   = 0.25;
2024863406b8SStefano Zampini     /* Vector Poisson AMG solver parameters: coarsen type, agg_levels, relax_type, interp_type, Pmax */
2025863406b8SStefano Zampini     jac->as_amg_beta_opts[0] = 10;
2026863406b8SStefano Zampini     jac->as_amg_beta_opts[1] = 1;
2027863406b8SStefano Zampini     jac->as_amg_beta_opts[2] = 6;
2028863406b8SStefano Zampini     jac->as_amg_beta_opts[3] = 6;
2029863406b8SStefano Zampini     jac->as_amg_beta_opts[4] = 4;
2030863406b8SStefano Zampini     jac->as_amg_beta_theta   = 0.25;
2031863406b8SStefano Zampini     PetscStackCallStandard(HYPRE_ADSSetPrintLevel,(jac->hsolver,jac->as_print));
2032863406b8SStefano Zampini     PetscStackCallStandard(HYPRE_ADSSetMaxIter,(jac->hsolver,jac->as_max_iter));
2033863406b8SStefano Zampini     PetscStackCallStandard(HYPRE_ADSSetCycleType,(jac->hsolver,jac->ams_cycle_type));
2034863406b8SStefano Zampini     PetscStackCallStandard(HYPRE_ADSSetTol,(jac->hsolver,jac->as_tol));
2035863406b8SStefano Zampini     PetscStackCallStandard(HYPRE_ADSSetSmoothingOptions,(jac->hsolver,jac->as_relax_type,
2036863406b8SStefano Zampini                                                                       jac->as_relax_times,
2037863406b8SStefano Zampini                                                                       jac->as_relax_weight,
2038863406b8SStefano Zampini                                                                       jac->as_omega));
2039863406b8SStefano Zampini     PetscStackCallStandard(HYPRE_ADSSetAMSOptions,(jac->hsolver,jac->ams_cycle_type,             /* AMG coarsen type */
2040863406b8SStefano Zampini                                                                 jac->as_amg_alpha_opts[0],       /* AMG coarsen type */
2041863406b8SStefano Zampini                                                                 jac->as_amg_alpha_opts[1],       /* AMG agg_levels */
2042863406b8SStefano Zampini                                                                 jac->as_amg_alpha_opts[2],       /* AMG relax_type */
2043863406b8SStefano Zampini                                                                 jac->as_amg_alpha_theta,
2044863406b8SStefano Zampini                                                                 jac->as_amg_alpha_opts[3],       /* AMG interp_type */
2045863406b8SStefano Zampini                                                                 jac->as_amg_alpha_opts[4]));     /* AMG Pmax */
2046863406b8SStefano Zampini     PetscStackCallStandard(HYPRE_ADSSetAMGOptions,(jac->hsolver,jac->as_amg_beta_opts[0],       /* AMG coarsen type */
2047863406b8SStefano Zampini                                                                 jac->as_amg_beta_opts[1],       /* AMG agg_levels */
2048863406b8SStefano Zampini                                                                 jac->as_amg_beta_opts[2],       /* AMG relax_type */
2049863406b8SStefano Zampini                                                                 jac->as_amg_beta_theta,
2050863406b8SStefano Zampini                                                                 jac->as_amg_beta_opts[3],       /* AMG interp_type */
2051863406b8SStefano Zampini                                                                 jac->as_amg_beta_opts[4]));     /* AMG Pmax */
2052863406b8SStefano Zampini     PetscFunctionReturn(0);
2053863406b8SStefano Zampini   }
2054503cfb0cSBarry Smith   ierr = PetscFree(jac->hypre_type);CHKERRQ(ierr);
20552fa5cd67SKarl Rupp 
20560298fd71SBarry Smith   jac->hypre_type = NULL;
2057db966c6cSHong Zhang   SETERRQ1(PetscObjectComm((PetscObject)pc),PETSC_ERR_ARG_UNKNOWN_TYPE,"Unknown HYPRE preconditioner %s; Choices are euclid, pilut, parasails, boomeramg, ams",name);
205816d9e3a6SLisandro Dalcin }
205916d9e3a6SLisandro Dalcin 
206016d9e3a6SLisandro Dalcin /*
206116d9e3a6SLisandro Dalcin     It only gets here if the HYPRE type has not been set before the call to
206216d9e3a6SLisandro Dalcin    ...SetFromOptions() which actually is most of the time
206316d9e3a6SLisandro Dalcin */
2064360ee056SFande Kong PetscErrorCode PCSetFromOptions_HYPRE(PetscOptionItems *PetscOptionsObject,PC pc)
206516d9e3a6SLisandro Dalcin {
206616d9e3a6SLisandro Dalcin   PetscErrorCode ierr;
20674ddd07fcSJed Brown   PetscInt       indx;
2068db966c6cSHong Zhang   const char     *type[] = {"euclid","pilut","parasails","boomeramg","ams","ads"};
2069ace3abfcSBarry Smith   PetscBool      flg;
207016d9e3a6SLisandro Dalcin 
207116d9e3a6SLisandro Dalcin   PetscFunctionBegin;
20729fa463a7SBarry Smith   ierr = PetscOptionsHead(PetscOptionsObject,"HYPRE preconditioner options");CHKERRQ(ierr);
2073cab5ea25SPierre Jolivet   ierr = PetscOptionsEList("-pc_hypre_type","HYPRE preconditioner type","PCHYPRESetType",type,ALEN(type),"boomeramg",&indx,&flg);CHKERRQ(ierr);
207416d9e3a6SLisandro Dalcin   if (flg) {
207516d9e3a6SLisandro Dalcin     ierr = PCHYPRESetType_HYPRE(pc,type[indx]);CHKERRQ(ierr);
207602a17cd4SBarry Smith   } else {
207702a17cd4SBarry Smith     ierr = PCHYPRESetType_HYPRE(pc,"boomeramg");CHKERRQ(ierr);
207816d9e3a6SLisandro Dalcin   }
207916d9e3a6SLisandro Dalcin   if (pc->ops->setfromoptions) {
20803931853cSBarry Smith     ierr = pc->ops->setfromoptions(PetscOptionsObject,pc);CHKERRQ(ierr);
208116d9e3a6SLisandro Dalcin   }
208216d9e3a6SLisandro Dalcin   ierr = PetscOptionsTail();CHKERRQ(ierr);
208316d9e3a6SLisandro Dalcin   PetscFunctionReturn(0);
208416d9e3a6SLisandro Dalcin }
208516d9e3a6SLisandro Dalcin 
208616d9e3a6SLisandro Dalcin /*@C
208716d9e3a6SLisandro Dalcin      PCHYPRESetType - Sets which hypre preconditioner you wish to use
208816d9e3a6SLisandro Dalcin 
208916d9e3a6SLisandro Dalcin    Input Parameters:
209016d9e3a6SLisandro Dalcin +     pc - the preconditioner context
2091db966c6cSHong Zhang -     name - either  euclid, pilut, parasails, boomeramg, ams, ads
209216d9e3a6SLisandro Dalcin 
209316d9e3a6SLisandro Dalcin    Options Database Keys:
2094db966c6cSHong Zhang    -pc_hypre_type - One of euclid, pilut, parasails, boomeramg, ams, ads
209516d9e3a6SLisandro Dalcin 
209616d9e3a6SLisandro Dalcin    Level: intermediate
209716d9e3a6SLisandro Dalcin 
209816d9e3a6SLisandro Dalcin .seealso:  PCCreate(), PCSetType(), PCType (for list of available types), PC,
209916d9e3a6SLisandro Dalcin            PCHYPRE
210016d9e3a6SLisandro Dalcin 
210116d9e3a6SLisandro Dalcin @*/
21027087cfbeSBarry Smith PetscErrorCode  PCHYPRESetType(PC pc,const char name[])
210316d9e3a6SLisandro Dalcin {
21044ac538c5SBarry Smith   PetscErrorCode ierr;
210516d9e3a6SLisandro Dalcin 
210616d9e3a6SLisandro Dalcin   PetscFunctionBegin;
21070700a824SBarry Smith   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
210816d9e3a6SLisandro Dalcin   PetscValidCharPointer(name,2);
21094ac538c5SBarry Smith   ierr = PetscTryMethod(pc,"PCHYPRESetType_C",(PC,const char[]),(pc,name));CHKERRQ(ierr);
211016d9e3a6SLisandro Dalcin   PetscFunctionReturn(0);
211116d9e3a6SLisandro Dalcin }
211216d9e3a6SLisandro Dalcin 
211316d9e3a6SLisandro Dalcin /*@C
211416d9e3a6SLisandro Dalcin      PCHYPREGetType - Gets which hypre preconditioner you are using
211516d9e3a6SLisandro Dalcin 
211616d9e3a6SLisandro Dalcin    Input Parameter:
211716d9e3a6SLisandro Dalcin .     pc - the preconditioner context
211816d9e3a6SLisandro Dalcin 
211916d9e3a6SLisandro Dalcin    Output Parameter:
2120db966c6cSHong Zhang .     name - either  euclid, pilut, parasails, boomeramg, ams, ads
212116d9e3a6SLisandro Dalcin 
212216d9e3a6SLisandro Dalcin    Level: intermediate
212316d9e3a6SLisandro Dalcin 
212416d9e3a6SLisandro Dalcin .seealso:  PCCreate(), PCHYPRESetType(), PCType (for list of available types), PC,
212516d9e3a6SLisandro Dalcin            PCHYPRE
212616d9e3a6SLisandro Dalcin 
212716d9e3a6SLisandro Dalcin @*/
21287087cfbeSBarry Smith PetscErrorCode  PCHYPREGetType(PC pc,const char *name[])
212916d9e3a6SLisandro Dalcin {
21304ac538c5SBarry Smith   PetscErrorCode ierr;
213116d9e3a6SLisandro Dalcin 
213216d9e3a6SLisandro Dalcin   PetscFunctionBegin;
21330700a824SBarry Smith   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
213416d9e3a6SLisandro Dalcin   PetscValidPointer(name,2);
21354ac538c5SBarry Smith   ierr = PetscTryMethod(pc,"PCHYPREGetType_C",(PC,const char*[]),(pc,name));CHKERRQ(ierr);
213616d9e3a6SLisandro Dalcin   PetscFunctionReturn(0);
213716d9e3a6SLisandro Dalcin }
213816d9e3a6SLisandro Dalcin 
213916d9e3a6SLisandro Dalcin /*MC
214016d9e3a6SLisandro Dalcin      PCHYPRE - Allows you to use the matrix element based preconditioners in the LLNL package hypre
214116d9e3a6SLisandro Dalcin 
214216d9e3a6SLisandro Dalcin    Options Database Keys:
2143db966c6cSHong Zhang +   -pc_hypre_type - One of euclid, pilut, parasails, boomeramg, ams, ads
214416d9e3a6SLisandro Dalcin -   Too many others to list, run with -pc_type hypre -pc_hypre_type XXX -help to see options for the XXX
214516d9e3a6SLisandro Dalcin           preconditioner
214616d9e3a6SLisandro Dalcin 
214716d9e3a6SLisandro Dalcin    Level: intermediate
214816d9e3a6SLisandro Dalcin 
214995452b02SPatrick Sanan    Notes:
215095452b02SPatrick Sanan     Apart from pc_hypre_type (for which there is PCHYPRESetType()),
215116d9e3a6SLisandro Dalcin           the many hypre options can ONLY be set via the options database (e.g. the command line
215216d9e3a6SLisandro Dalcin           or with PetscOptionsSetValue(), there are no functions to set them)
215316d9e3a6SLisandro Dalcin 
2154c231f9e3SBarryFSmith           The options -pc_hypre_boomeramg_max_iter and -pc_hypre_boomeramg_tol refer to the number of iterations
21550f1074feSSatish Balay           (V-cycles) and tolerance that boomeramg does EACH time it is called. So for example, if
21560f1074feSSatish Balay           -pc_hypre_boomeramg_max_iter is set to 2 then 2-V-cycles are being used to define the preconditioner
2157c231f9e3SBarryFSmith           (-pc_hypre_boomeramg_tol should be set to 0.0 - the default - to strictly use a fixed number of
21588f87f92bSBarry Smith           iterations per hypre call). -ksp_max_it and -ksp_rtol STILL determine the total number of iterations
21590f1074feSSatish Balay           and tolerance for the Krylov solver. For example, if -pc_hypre_boomeramg_max_iter is 2 and -ksp_max_it is 10
21600f1074feSSatish Balay           then AT MOST twenty V-cycles of boomeramg will be called.
216116d9e3a6SLisandro Dalcin 
21620f1074feSSatish Balay            Note that the option -pc_hypre_boomeramg_relax_type_all defaults to symmetric relaxation
21630f1074feSSatish Balay            (symmetric-SOR/Jacobi), which is required for Krylov solvers like CG that expect symmetry.
21640f1074feSSatish Balay            Otherwise, you may want to use -pc_hypre_boomeramg_relax_type_all SOR/Jacobi.
216516d9e3a6SLisandro Dalcin           If you wish to use BoomerAMG WITHOUT a Krylov method use -ksp_type richardson NOT -ksp_type preonly
216616d9e3a6SLisandro Dalcin           and use -ksp_max_it to control the number of V-cycles.
216716d9e3a6SLisandro Dalcin           (see the PETSc FAQ.html at the PETSc website under the Documentation tab).
216816d9e3a6SLisandro Dalcin 
216916d9e3a6SLisandro Dalcin           2007-02-03 Using HYPRE-1.11.1b, the routine HYPRE_BoomerAMGSolveT and the option
217016d9e3a6SLisandro Dalcin           -pc_hypre_parasails_reuse were failing with SIGSEGV. Dalcin L.
217116d9e3a6SLisandro Dalcin 
21725272c319SBarry Smith           MatSetNearNullSpace() - if you provide a near null space to your matrix it is ignored by hypre UNLESS you also use
2173fdd15c9aSJunchao Zhang           the following two options:
21740b1a5bd9SEric Chamberland 
2175fdd15c9aSJunchao Zhang    Options Database Keys:
21765272c319SBarry Smith +   -pc_hypre_boomeramg_nodal_coarsen <n> - where n is from 1 to 6 (see HYPRE_BOOMERAMGSetNodal())
2177fdd15c9aSJunchao Zhang -   -pc_hypre_boomeramg_vec_interp_variant <v> - where v is from 1 to 3 (see HYPRE_BoomerAMGSetInterpVecVariant())
21785272c319SBarry Smith 
21795272c319SBarry Smith           Depending on the linear system you may see the same or different convergence depending on the values you use.
21805272c319SBarry Smith 
21819e5bc791SBarry Smith           See PCPFMG for access to the hypre Struct PFMG solver
21829e5bc791SBarry Smith 
218316d9e3a6SLisandro Dalcin .seealso:  PCCreate(), PCSetType(), PCType (for list of available types), PC,
21849e5bc791SBarry Smith            PCHYPRESetType(), PCPFMG
218516d9e3a6SLisandro Dalcin 
218616d9e3a6SLisandro Dalcin M*/
218716d9e3a6SLisandro Dalcin 
21888cc058d9SJed Brown PETSC_EXTERN PetscErrorCode PCCreate_HYPRE(PC pc)
218916d9e3a6SLisandro Dalcin {
219016d9e3a6SLisandro Dalcin   PC_HYPRE       *jac;
219116d9e3a6SLisandro Dalcin   PetscErrorCode ierr;
219216d9e3a6SLisandro Dalcin 
219316d9e3a6SLisandro Dalcin   PetscFunctionBegin;
2194b00a9115SJed Brown   ierr = PetscNewLog(pc,&jac);CHKERRQ(ierr);
21952fa5cd67SKarl Rupp 
219616d9e3a6SLisandro Dalcin   pc->data                = jac;
21978695de01SBarry Smith   pc->ops->reset          = PCReset_HYPRE;
219816d9e3a6SLisandro Dalcin   pc->ops->destroy        = PCDestroy_HYPRE;
219916d9e3a6SLisandro Dalcin   pc->ops->setfromoptions = PCSetFromOptions_HYPRE;
220016d9e3a6SLisandro Dalcin   pc->ops->setup          = PCSetUp_HYPRE;
220116d9e3a6SLisandro Dalcin   pc->ops->apply          = PCApply_HYPRE;
220216d9e3a6SLisandro Dalcin   jac->comm_hypre         = MPI_COMM_NULL;
2203bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCHYPRESetType_C",PCHYPRESetType_HYPRE);CHKERRQ(ierr);
2204bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCHYPREGetType_C",PCHYPREGetType_HYPRE);CHKERRQ(ierr);
22055ac14e1cSStefano Zampini   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCSetCoordinates_C",PCSetCoordinates_HYPRE);CHKERRQ(ierr);
22065ac14e1cSStefano Zampini   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCHYPRESetDiscreteGradient_C",PCHYPRESetDiscreteGradient_HYPRE);CHKERRQ(ierr);
22075ac14e1cSStefano Zampini   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCHYPRESetDiscreteCurl_C",PCHYPRESetDiscreteCurl_HYPRE);CHKERRQ(ierr);
22086bf688a0SCe Qin   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCHYPRESetInterpolations_C",PCHYPRESetInterpolations_HYPRE);CHKERRQ(ierr);
22095ac14e1cSStefano Zampini   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCHYPRESetEdgeConstantVectors_C",PCHYPRESetEdgeConstantVectors_HYPRE);CHKERRQ(ierr);
22105ac14e1cSStefano Zampini   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCHYPRESetPoissonMatrix_C",PCHYPRESetPoissonMatrix_HYPRE);CHKERRQ(ierr);
22116ea7df73SStefano Zampini #if defined(PETSC_HAVE_HYPRE_DEVICE)
22126ea7df73SStefano Zampini #if defined(HYPRE_USING_HIP)
22136ea7df73SStefano Zampini   ierr = PetscHIPInitializeCheck();CHKERRQ(ierr);
22146ea7df73SStefano Zampini #endif
22156ea7df73SStefano Zampini #if defined(HYPRE_USING_CUDA)
22166ea7df73SStefano Zampini   ierr = PetscCUDAInitializeCheck();CHKERRQ(ierr);
22176ea7df73SStefano Zampini #endif
22186ea7df73SStefano Zampini #endif
221916d9e3a6SLisandro Dalcin   PetscFunctionReturn(0);
222016d9e3a6SLisandro Dalcin }
2221ebc551c0SBarry Smith 
2222f91d8e95SBarry Smith /* ---------------------------------------------------------------------------------------------------------------------------------*/
2223f91d8e95SBarry Smith 
2224ebc551c0SBarry Smith typedef struct {
222568326731SBarry Smith   MPI_Comm           hcomm;        /* does not share comm with HYPRE_StructMatrix because need to create solver before getting matrix */
2226f91d8e95SBarry Smith   HYPRE_StructSolver hsolver;
22279e5bc791SBarry Smith 
22289e5bc791SBarry Smith   /* keep copy of PFMG options used so may view them */
22294ddd07fcSJed Brown   PetscInt its;
22309e5bc791SBarry Smith   double   tol;
22314ddd07fcSJed Brown   PetscInt relax_type;
22324ddd07fcSJed Brown   PetscInt rap_type;
22334ddd07fcSJed Brown   PetscInt num_pre_relax,num_post_relax;
22344ddd07fcSJed Brown   PetscInt max_levels;
2235ebc551c0SBarry Smith } PC_PFMG;
2236ebc551c0SBarry Smith 
2237ebc551c0SBarry Smith PetscErrorCode PCDestroy_PFMG(PC pc)
2238ebc551c0SBarry Smith {
2239ebc551c0SBarry Smith   PetscErrorCode ierr;
2240f91d8e95SBarry Smith   PC_PFMG        *ex = (PC_PFMG*) pc->data;
2241ebc551c0SBarry Smith 
2242ebc551c0SBarry Smith   PetscFunctionBegin;
22432fa5cd67SKarl Rupp   if (ex->hsolver) PetscStackCallStandard(HYPRE_StructPFMGDestroy,(ex->hsolver));
2244ffc4695bSBarry Smith   ierr = MPI_Comm_free(&ex->hcomm);CHKERRMPI(ierr);
2245c31cb41cSBarry Smith   ierr = PetscFree(pc->data);CHKERRQ(ierr);
2246ebc551c0SBarry Smith   PetscFunctionReturn(0);
2247ebc551c0SBarry Smith }
2248ebc551c0SBarry Smith 
22499e5bc791SBarry Smith static const char *PFMGRelaxType[] = {"Jacobi","Weighted-Jacobi","symmetric-Red/Black-Gauss-Seidel","Red/Black-Gauss-Seidel"};
22509e5bc791SBarry Smith static const char *PFMGRAPType[] = {"Galerkin","non-Galerkin"};
22519e5bc791SBarry Smith 
2252ebc551c0SBarry Smith PetscErrorCode PCView_PFMG(PC pc,PetscViewer viewer)
2253ebc551c0SBarry Smith {
2254ebc551c0SBarry Smith   PetscErrorCode ierr;
2255ace3abfcSBarry Smith   PetscBool      iascii;
2256f91d8e95SBarry Smith   PC_PFMG        *ex = (PC_PFMG*) pc->data;
2257ebc551c0SBarry Smith 
2258ebc551c0SBarry Smith   PetscFunctionBegin;
2259251f4c67SDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&iascii);CHKERRQ(ierr);
22609e5bc791SBarry Smith   if (iascii) {
22619e5bc791SBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"  HYPRE PFMG preconditioning\n");CHKERRQ(ierr);
2262efd4aadfSBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"    max iterations %d\n",ex->its);CHKERRQ(ierr);
2263efd4aadfSBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"    tolerance %g\n",ex->tol);CHKERRQ(ierr);
2264efd4aadfSBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"    relax type %s\n",PFMGRelaxType[ex->relax_type]);CHKERRQ(ierr);
2265efd4aadfSBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"    RAP type %s\n",PFMGRAPType[ex->rap_type]);CHKERRQ(ierr);
2266efd4aadfSBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"    number pre-relax %d post-relax %d\n",ex->num_pre_relax,ex->num_post_relax);CHKERRQ(ierr);
2267efd4aadfSBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"    max levels %d\n",ex->max_levels);CHKERRQ(ierr);
22689e5bc791SBarry Smith   }
2269ebc551c0SBarry Smith   PetscFunctionReturn(0);
2270ebc551c0SBarry Smith }
2271ebc551c0SBarry Smith 
22724416b707SBarry Smith PetscErrorCode PCSetFromOptions_PFMG(PetscOptionItems *PetscOptionsObject,PC pc)
2273ebc551c0SBarry Smith {
2274ebc551c0SBarry Smith   PetscErrorCode ierr;
2275f91d8e95SBarry Smith   PC_PFMG        *ex = (PC_PFMG*) pc->data;
2276ace3abfcSBarry Smith   PetscBool      flg = PETSC_FALSE;
2277ebc551c0SBarry Smith 
2278ebc551c0SBarry Smith   PetscFunctionBegin;
2279e55864a3SBarry Smith   ierr = PetscOptionsHead(PetscOptionsObject,"PFMG options");CHKERRQ(ierr);
22800298fd71SBarry Smith   ierr = PetscOptionsBool("-pc_pfmg_print_statistics","Print statistics","HYPRE_StructPFMGSetPrintLevel",flg,&flg,NULL);CHKERRQ(ierr);
228168326731SBarry Smith   if (flg) {
22825bd1e576SStefano Zampini     PetscStackCallStandard(HYPRE_StructPFMGSetPrintLevel,(ex->hsolver,3));
228368326731SBarry Smith   }
22840298fd71SBarry Smith   ierr = PetscOptionsInt("-pc_pfmg_its","Number of iterations of PFMG to use as preconditioner","HYPRE_StructPFMGSetMaxIter",ex->its,&ex->its,NULL);CHKERRQ(ierr);
2285fd3f9acdSBarry Smith   PetscStackCallStandard(HYPRE_StructPFMGSetMaxIter,(ex->hsolver,ex->its));
22860298fd71SBarry Smith   ierr = PetscOptionsInt("-pc_pfmg_num_pre_relax","Number of smoothing steps before coarse grid","HYPRE_StructPFMGSetNumPreRelax",ex->num_pre_relax,&ex->num_pre_relax,NULL);CHKERRQ(ierr);
2287fd3f9acdSBarry Smith   PetscStackCallStandard(HYPRE_StructPFMGSetNumPreRelax,(ex->hsolver,ex->num_pre_relax));
22880298fd71SBarry Smith   ierr = PetscOptionsInt("-pc_pfmg_num_post_relax","Number of smoothing steps after coarse grid","HYPRE_StructPFMGSetNumPostRelax",ex->num_post_relax,&ex->num_post_relax,NULL);CHKERRQ(ierr);
2289fd3f9acdSBarry Smith   PetscStackCallStandard(HYPRE_StructPFMGSetNumPostRelax,(ex->hsolver,ex->num_post_relax));
22909e5bc791SBarry Smith 
22910298fd71SBarry Smith   ierr = PetscOptionsInt("-pc_pfmg_max_levels","Max Levels for MG hierarchy","HYPRE_StructPFMGSetMaxLevels",ex->max_levels,&ex->max_levels,NULL);CHKERRQ(ierr);
2292fd3f9acdSBarry Smith   PetscStackCallStandard(HYPRE_StructPFMGSetMaxLevels,(ex->hsolver,ex->max_levels));
22933b46a515SGlenn Hammond 
22940298fd71SBarry Smith   ierr = PetscOptionsReal("-pc_pfmg_tol","Tolerance of PFMG","HYPRE_StructPFMGSetTol",ex->tol,&ex->tol,NULL);CHKERRQ(ierr);
2295fd3f9acdSBarry Smith   PetscStackCallStandard(HYPRE_StructPFMGSetTol,(ex->hsolver,ex->tol));
22960298fd71SBarry Smith   ierr = PetscOptionsEList("-pc_pfmg_relax_type","Relax type for the up and down cycles","HYPRE_StructPFMGSetRelaxType",PFMGRelaxType,ALEN(PFMGRelaxType),PFMGRelaxType[ex->relax_type],&ex->relax_type,NULL);CHKERRQ(ierr);
2297fd3f9acdSBarry Smith   PetscStackCallStandard(HYPRE_StructPFMGSetRelaxType,(ex->hsolver, ex->relax_type));
22980298fd71SBarry Smith   ierr = PetscOptionsEList("-pc_pfmg_rap_type","RAP type","HYPRE_StructPFMGSetRAPType",PFMGRAPType,ALEN(PFMGRAPType),PFMGRAPType[ex->rap_type],&ex->rap_type,NULL);CHKERRQ(ierr);
2299fd3f9acdSBarry Smith   PetscStackCallStandard(HYPRE_StructPFMGSetRAPType,(ex->hsolver, ex->rap_type));
2300ebc551c0SBarry Smith   ierr = PetscOptionsTail();CHKERRQ(ierr);
2301ebc551c0SBarry Smith   PetscFunctionReturn(0);
2302ebc551c0SBarry Smith }
2303ebc551c0SBarry Smith 
2304f91d8e95SBarry Smith PetscErrorCode PCApply_PFMG(PC pc,Vec x,Vec y)
2305f91d8e95SBarry Smith {
2306f91d8e95SBarry Smith   PetscErrorCode    ierr;
2307f91d8e95SBarry Smith   PC_PFMG           *ex = (PC_PFMG*) pc->data;
2308d9ca1df4SBarry Smith   PetscScalar       *yy;
2309d9ca1df4SBarry Smith   const PetscScalar *xx;
23104ddd07fcSJed Brown   PetscInt          ilower[3],iupper[3];
23112cf14000SStefano Zampini   HYPRE_Int         hlower[3],hupper[3];
231268326731SBarry Smith   Mat_HYPREStruct   *mx = (Mat_HYPREStruct*)(pc->pmat->data);
2313f91d8e95SBarry Smith 
2314f91d8e95SBarry Smith   PetscFunctionBegin;
2315dff31646SBarry Smith   ierr = PetscCitationsRegister(hypreCitation,&cite);CHKERRQ(ierr);
2316aa219208SBarry Smith   ierr = DMDAGetCorners(mx->da,&ilower[0],&ilower[1],&ilower[2],&iupper[0],&iupper[1],&iupper[2]);CHKERRQ(ierr);
23172cf14000SStefano Zampini   /* when HYPRE_MIXEDINT is defined, sizeof(HYPRE_Int) == 32 */
2318f91d8e95SBarry Smith   iupper[0] += ilower[0] - 1;
2319f91d8e95SBarry Smith   iupper[1] += ilower[1] - 1;
2320f91d8e95SBarry Smith   iupper[2] += ilower[2] - 1;
23212cf14000SStefano Zampini   hlower[0]  = (HYPRE_Int)ilower[0];
23222cf14000SStefano Zampini   hlower[1]  = (HYPRE_Int)ilower[1];
23232cf14000SStefano Zampini   hlower[2]  = (HYPRE_Int)ilower[2];
23242cf14000SStefano Zampini   hupper[0]  = (HYPRE_Int)iupper[0];
23252cf14000SStefano Zampini   hupper[1]  = (HYPRE_Int)iupper[1];
23262cf14000SStefano Zampini   hupper[2]  = (HYPRE_Int)iupper[2];
2327f91d8e95SBarry Smith 
2328f91d8e95SBarry Smith   /* copy x values over to hypre */
2329fd3f9acdSBarry Smith   PetscStackCallStandard(HYPRE_StructVectorSetConstantValues,(mx->hb,0.0));
2330d9ca1df4SBarry Smith   ierr = VecGetArrayRead(x,&xx);CHKERRQ(ierr);
233139accc25SStefano Zampini   PetscStackCallStandard(HYPRE_StructVectorSetBoxValues,(mx->hb,hlower,hupper,(HYPRE_Complex*)xx));
2332d9ca1df4SBarry Smith   ierr = VecRestoreArrayRead(x,&xx);CHKERRQ(ierr);
2333fd3f9acdSBarry Smith   PetscStackCallStandard(HYPRE_StructVectorAssemble,(mx->hb));
2334fd3f9acdSBarry Smith   PetscStackCallStandard(HYPRE_StructPFMGSolve,(ex->hsolver,mx->hmat,mx->hb,mx->hx));
2335f91d8e95SBarry Smith 
2336f91d8e95SBarry Smith   /* copy solution values back to PETSc */
2337f91d8e95SBarry Smith   ierr = VecGetArray(y,&yy);CHKERRQ(ierr);
233839accc25SStefano Zampini   PetscStackCallStandard(HYPRE_StructVectorGetBoxValues,(mx->hx,hlower,hupper,(HYPRE_Complex*)yy));
2339f91d8e95SBarry Smith   ierr = VecRestoreArray(y,&yy);CHKERRQ(ierr);
2340f91d8e95SBarry Smith   PetscFunctionReturn(0);
2341f91d8e95SBarry Smith }
2342f91d8e95SBarry Smith 
2343ace3abfcSBarry Smith static PetscErrorCode PCApplyRichardson_PFMG(PC pc,Vec b,Vec y,Vec w,PetscReal rtol,PetscReal abstol, PetscReal dtol,PetscInt its,PetscBool guesszero,PetscInt *outits,PCRichardsonConvergedReason *reason)
23449e5bc791SBarry Smith {
23459e5bc791SBarry Smith   PC_PFMG        *jac = (PC_PFMG*)pc->data;
23469e5bc791SBarry Smith   PetscErrorCode ierr;
23472cf14000SStefano Zampini   HYPRE_Int      oits;
23489e5bc791SBarry Smith 
23499e5bc791SBarry Smith   PetscFunctionBegin;
2350dff31646SBarry Smith   ierr = PetscCitationsRegister(hypreCitation,&cite);CHKERRQ(ierr);
2351fd3f9acdSBarry Smith   PetscStackCallStandard(HYPRE_StructPFMGSetMaxIter,(jac->hsolver,its*jac->its));
2352fd3f9acdSBarry Smith   PetscStackCallStandard(HYPRE_StructPFMGSetTol,(jac->hsolver,rtol));
23539e5bc791SBarry Smith 
23549e5bc791SBarry Smith   ierr = PCApply_PFMG(pc,b,y);CHKERRQ(ierr);
23552cf14000SStefano Zampini   PetscStackCallStandard(HYPRE_StructPFMGGetNumIterations,(jac->hsolver,&oits));
23569e5bc791SBarry Smith   *outits = oits;
23579e5bc791SBarry Smith   if (oits == its) *reason = PCRICHARDSON_CONVERGED_ITS;
23589e5bc791SBarry Smith   else             *reason = PCRICHARDSON_CONVERGED_RTOL;
2359fd3f9acdSBarry Smith   PetscStackCallStandard(HYPRE_StructPFMGSetTol,(jac->hsolver,jac->tol));
2360fd3f9acdSBarry Smith   PetscStackCallStandard(HYPRE_StructPFMGSetMaxIter,(jac->hsolver,jac->its));
23619e5bc791SBarry Smith   PetscFunctionReturn(0);
23629e5bc791SBarry Smith }
23639e5bc791SBarry Smith 
23643a32d3dbSGlenn Hammond PetscErrorCode PCSetUp_PFMG(PC pc)
23653a32d3dbSGlenn Hammond {
23663a32d3dbSGlenn Hammond   PetscErrorCode  ierr;
23673a32d3dbSGlenn Hammond   PC_PFMG         *ex = (PC_PFMG*) pc->data;
23683a32d3dbSGlenn Hammond   Mat_HYPREStruct *mx = (Mat_HYPREStruct*)(pc->pmat->data);
2369ace3abfcSBarry Smith   PetscBool       flg;
23703a32d3dbSGlenn Hammond 
23713a32d3dbSGlenn Hammond   PetscFunctionBegin;
2372251f4c67SDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)pc->pmat,MATHYPRESTRUCT,&flg);CHKERRQ(ierr);
2373ce94432eSBarry Smith   if (!flg) SETERRQ(PetscObjectComm((PetscObject)pc),PETSC_ERR_ARG_INCOMP,"Must use MATHYPRESTRUCT with this preconditioner");
23743a32d3dbSGlenn Hammond 
23753a32d3dbSGlenn Hammond   /* create the hypre solver object and set its information */
23762fa5cd67SKarl Rupp   if (ex->hsolver) PetscStackCallStandard(HYPRE_StructPFMGDestroy,(ex->hsolver));
2377fd3f9acdSBarry Smith   PetscStackCallStandard(HYPRE_StructPFMGCreate,(ex->hcomm,&ex->hsolver));
2378fd3f9acdSBarry Smith   PetscStackCallStandard(HYPRE_StructPFMGSetup,(ex->hsolver,mx->hmat,mx->hb,mx->hx));
2379fd3f9acdSBarry Smith   PetscStackCallStandard(HYPRE_StructPFMGSetZeroGuess,(ex->hsolver));
23803a32d3dbSGlenn Hammond   PetscFunctionReturn(0);
23813a32d3dbSGlenn Hammond }
23823a32d3dbSGlenn Hammond 
2383ebc551c0SBarry Smith /*MC
2384ebc551c0SBarry Smith      PCPFMG - the hypre PFMG multigrid solver
2385ebc551c0SBarry Smith 
2386ebc551c0SBarry Smith    Level: advanced
2387ebc551c0SBarry Smith 
23889e5bc791SBarry Smith    Options Database:
23899e5bc791SBarry Smith + -pc_pfmg_its <its> number of iterations of PFMG to use as preconditioner
23909e5bc791SBarry Smith . -pc_pfmg_num_pre_relax <steps> number of smoothing steps before coarse grid
23919e5bc791SBarry Smith . -pc_pfmg_num_post_relax <steps> number of smoothing steps after coarse grid
23929e5bc791SBarry Smith . -pc_pfmg_tol <tol> tolerance of PFMG
23939e5bc791SBarry Smith . -pc_pfmg_relax_type -relaxation type for the up and down cycles, one of Jacobi,Weighted-Jacobi,symmetric-Red/Black-Gauss-Seidel,Red/Black-Gauss-Seidel
23949e5bc791SBarry Smith - -pc_pfmg_rap_type - type of coarse matrix generation, one of Galerkin,non-Galerkin
2395f91d8e95SBarry Smith 
239695452b02SPatrick Sanan    Notes:
239795452b02SPatrick Sanan     This is for CELL-centered descretizations
23989e5bc791SBarry Smith 
23998e395302SJed Brown            This must be used with the MATHYPRESTRUCT matrix type.
2400aa219208SBarry Smith            This is less general than in hypre, it supports only one block per process defined by a PETSc DMDA.
24019e5bc791SBarry Smith 
24029e5bc791SBarry Smith .seealso:  PCMG, MATHYPRESTRUCT
2403ebc551c0SBarry Smith M*/
2404ebc551c0SBarry Smith 
24058cc058d9SJed Brown PETSC_EXTERN PetscErrorCode PCCreate_PFMG(PC pc)
2406ebc551c0SBarry Smith {
2407ebc551c0SBarry Smith   PetscErrorCode ierr;
2408ebc551c0SBarry Smith   PC_PFMG        *ex;
2409ebc551c0SBarry Smith 
2410ebc551c0SBarry Smith   PetscFunctionBegin;
2411b00a9115SJed Brown   ierr     = PetscNew(&ex);CHKERRQ(ierr); \
241268326731SBarry Smith   pc->data = ex;
2413ebc551c0SBarry Smith 
24149e5bc791SBarry Smith   ex->its            = 1;
24159e5bc791SBarry Smith   ex->tol            = 1.e-8;
24169e5bc791SBarry Smith   ex->relax_type     = 1;
24179e5bc791SBarry Smith   ex->rap_type       = 0;
24189e5bc791SBarry Smith   ex->num_pre_relax  = 1;
24199e5bc791SBarry Smith   ex->num_post_relax = 1;
24203b46a515SGlenn Hammond   ex->max_levels     = 0;
24219e5bc791SBarry Smith 
2422ebc551c0SBarry Smith   pc->ops->setfromoptions  = PCSetFromOptions_PFMG;
2423ebc551c0SBarry Smith   pc->ops->view            = PCView_PFMG;
2424ebc551c0SBarry Smith   pc->ops->destroy         = PCDestroy_PFMG;
2425f91d8e95SBarry Smith   pc->ops->apply           = PCApply_PFMG;
24269e5bc791SBarry Smith   pc->ops->applyrichardson = PCApplyRichardson_PFMG;
242768326731SBarry Smith   pc->ops->setup           = PCSetUp_PFMG;
24282fa5cd67SKarl Rupp 
2429ffc4695bSBarry Smith   ierr = MPI_Comm_dup(PetscObjectComm((PetscObject)pc),&(ex->hcomm));CHKERRMPI(ierr);
2430fd3f9acdSBarry Smith   PetscStackCallStandard(HYPRE_StructPFMGCreate,(ex->hcomm,&ex->hsolver));
2431ebc551c0SBarry Smith   PetscFunctionReturn(0);
2432ebc551c0SBarry Smith }
2433d851a50bSGlenn Hammond 
2434325fc9f4SBarry Smith /* ---------------------------------------------------------------------------------------------------------------------------------------------------*/
2435325fc9f4SBarry Smith 
2436d851a50bSGlenn Hammond /* we know we are working with a HYPRE_SStructMatrix */
2437d851a50bSGlenn Hammond typedef struct {
2438d851a50bSGlenn Hammond   MPI_Comm            hcomm;       /* does not share comm with HYPRE_SStructMatrix because need to create solver before getting matrix */
2439d851a50bSGlenn Hammond   HYPRE_SStructSolver ss_solver;
2440d851a50bSGlenn Hammond 
2441d851a50bSGlenn Hammond   /* keep copy of SYSPFMG options used so may view them */
24424ddd07fcSJed Brown   PetscInt its;
2443d851a50bSGlenn Hammond   double   tol;
24444ddd07fcSJed Brown   PetscInt relax_type;
24454ddd07fcSJed Brown   PetscInt num_pre_relax,num_post_relax;
2446d851a50bSGlenn Hammond } PC_SysPFMG;
2447d851a50bSGlenn Hammond 
2448d851a50bSGlenn Hammond PetscErrorCode PCDestroy_SysPFMG(PC pc)
2449d851a50bSGlenn Hammond {
2450d851a50bSGlenn Hammond   PetscErrorCode ierr;
2451d851a50bSGlenn Hammond   PC_SysPFMG     *ex = (PC_SysPFMG*) pc->data;
2452d851a50bSGlenn Hammond 
2453d851a50bSGlenn Hammond   PetscFunctionBegin;
24542fa5cd67SKarl Rupp   if (ex->ss_solver) PetscStackCallStandard(HYPRE_SStructSysPFMGDestroy,(ex->ss_solver));
2455ffc4695bSBarry Smith   ierr = MPI_Comm_free(&ex->hcomm);CHKERRMPI(ierr);
2456c31cb41cSBarry Smith   ierr = PetscFree(pc->data);CHKERRQ(ierr);
2457d851a50bSGlenn Hammond   PetscFunctionReturn(0);
2458d851a50bSGlenn Hammond }
2459d851a50bSGlenn Hammond 
2460d851a50bSGlenn Hammond static const char *SysPFMGRelaxType[] = {"Weighted-Jacobi","Red/Black-Gauss-Seidel"};
2461d851a50bSGlenn Hammond 
2462d851a50bSGlenn Hammond PetscErrorCode PCView_SysPFMG(PC pc,PetscViewer viewer)
2463d851a50bSGlenn Hammond {
2464d851a50bSGlenn Hammond   PetscErrorCode ierr;
2465ace3abfcSBarry Smith   PetscBool      iascii;
2466d851a50bSGlenn Hammond   PC_SysPFMG     *ex = (PC_SysPFMG*) pc->data;
2467d851a50bSGlenn Hammond 
2468d851a50bSGlenn Hammond   PetscFunctionBegin;
2469251f4c67SDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&iascii);CHKERRQ(ierr);
2470d851a50bSGlenn Hammond   if (iascii) {
2471d851a50bSGlenn Hammond     ierr = PetscViewerASCIIPrintf(viewer,"  HYPRE SysPFMG preconditioning\n");CHKERRQ(ierr);
2472efd4aadfSBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"  max iterations %d\n",ex->its);CHKERRQ(ierr);
2473efd4aadfSBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"  tolerance %g\n",ex->tol);CHKERRQ(ierr);
2474efd4aadfSBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"  relax type %s\n",PFMGRelaxType[ex->relax_type]);CHKERRQ(ierr);
2475efd4aadfSBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"  number pre-relax %d post-relax %d\n",ex->num_pre_relax,ex->num_post_relax);CHKERRQ(ierr);
2476d851a50bSGlenn Hammond   }
2477d851a50bSGlenn Hammond   PetscFunctionReturn(0);
2478d851a50bSGlenn Hammond }
2479d851a50bSGlenn Hammond 
24804416b707SBarry Smith PetscErrorCode PCSetFromOptions_SysPFMG(PetscOptionItems *PetscOptionsObject,PC pc)
2481d851a50bSGlenn Hammond {
2482d851a50bSGlenn Hammond   PetscErrorCode ierr;
2483d851a50bSGlenn Hammond   PC_SysPFMG     *ex = (PC_SysPFMG*) pc->data;
2484ace3abfcSBarry Smith   PetscBool      flg = PETSC_FALSE;
2485d851a50bSGlenn Hammond 
2486d851a50bSGlenn Hammond   PetscFunctionBegin;
2487e55864a3SBarry Smith   ierr = PetscOptionsHead(PetscOptionsObject,"SysPFMG options");CHKERRQ(ierr);
24880298fd71SBarry Smith   ierr = PetscOptionsBool("-pc_syspfmg_print_statistics","Print statistics","HYPRE_SStructSysPFMGSetPrintLevel",flg,&flg,NULL);CHKERRQ(ierr);
2489d851a50bSGlenn Hammond   if (flg) {
24905bd1e576SStefano Zampini     PetscStackCallStandard(HYPRE_SStructSysPFMGSetPrintLevel,(ex->ss_solver,3));
2491d851a50bSGlenn Hammond   }
24920298fd71SBarry Smith   ierr = PetscOptionsInt("-pc_syspfmg_its","Number of iterations of SysPFMG to use as preconditioner","HYPRE_SStructSysPFMGSetMaxIter",ex->its,&ex->its,NULL);CHKERRQ(ierr);
2493fd3f9acdSBarry Smith   PetscStackCallStandard(HYPRE_SStructSysPFMGSetMaxIter,(ex->ss_solver,ex->its));
24940298fd71SBarry Smith   ierr = PetscOptionsInt("-pc_syspfmg_num_pre_relax","Number of smoothing steps before coarse grid","HYPRE_SStructSysPFMGSetNumPreRelax",ex->num_pre_relax,&ex->num_pre_relax,NULL);CHKERRQ(ierr);
2495fd3f9acdSBarry Smith   PetscStackCallStandard(HYPRE_SStructSysPFMGSetNumPreRelax,(ex->ss_solver,ex->num_pre_relax));
24960298fd71SBarry Smith   ierr = PetscOptionsInt("-pc_syspfmg_num_post_relax","Number of smoothing steps after coarse grid","HYPRE_SStructSysPFMGSetNumPostRelax",ex->num_post_relax,&ex->num_post_relax,NULL);CHKERRQ(ierr);
2497fd3f9acdSBarry Smith   PetscStackCallStandard(HYPRE_SStructSysPFMGSetNumPostRelax,(ex->ss_solver,ex->num_post_relax));
2498d851a50bSGlenn Hammond 
24990298fd71SBarry Smith   ierr = PetscOptionsReal("-pc_syspfmg_tol","Tolerance of SysPFMG","HYPRE_SStructSysPFMGSetTol",ex->tol,&ex->tol,NULL);CHKERRQ(ierr);
2500fd3f9acdSBarry Smith   PetscStackCallStandard(HYPRE_SStructSysPFMGSetTol,(ex->ss_solver,ex->tol));
250161710fbeSStefano Zampini   ierr = PetscOptionsEList("-pc_syspfmg_relax_type","Relax type for the up and down cycles","HYPRE_SStructSysPFMGSetRelaxType",SysPFMGRelaxType,ALEN(SysPFMGRelaxType),SysPFMGRelaxType[ex->relax_type],&ex->relax_type,NULL);CHKERRQ(ierr);
2502fd3f9acdSBarry Smith   PetscStackCallStandard(HYPRE_SStructSysPFMGSetRelaxType,(ex->ss_solver, ex->relax_type));
2503d851a50bSGlenn Hammond   ierr = PetscOptionsTail();CHKERRQ(ierr);
2504d851a50bSGlenn Hammond   PetscFunctionReturn(0);
2505d851a50bSGlenn Hammond }
2506d851a50bSGlenn Hammond 
2507d851a50bSGlenn Hammond PetscErrorCode PCApply_SysPFMG(PC pc,Vec x,Vec y)
2508d851a50bSGlenn Hammond {
2509d851a50bSGlenn Hammond   PetscErrorCode    ierr;
2510d851a50bSGlenn Hammond   PC_SysPFMG        *ex = (PC_SysPFMG*) pc->data;
2511d9ca1df4SBarry Smith   PetscScalar       *yy;
2512d9ca1df4SBarry Smith   const PetscScalar *xx;
25134ddd07fcSJed Brown   PetscInt          ilower[3],iupper[3];
25142cf14000SStefano Zampini   HYPRE_Int         hlower[3],hupper[3];
2515d851a50bSGlenn Hammond   Mat_HYPRESStruct  *mx     = (Mat_HYPRESStruct*)(pc->pmat->data);
25164ddd07fcSJed Brown   PetscInt          ordering= mx->dofs_order;
25174ddd07fcSJed Brown   PetscInt          nvars   = mx->nvars;
25184ddd07fcSJed Brown   PetscInt          part    = 0;
25194ddd07fcSJed Brown   PetscInt          size;
25204ddd07fcSJed Brown   PetscInt          i;
2521d851a50bSGlenn Hammond 
2522d851a50bSGlenn Hammond   PetscFunctionBegin;
2523dff31646SBarry Smith   ierr       = PetscCitationsRegister(hypreCitation,&cite);CHKERRQ(ierr);
2524aa219208SBarry Smith   ierr       = DMDAGetCorners(mx->da,&ilower[0],&ilower[1],&ilower[2],&iupper[0],&iupper[1],&iupper[2]);CHKERRQ(ierr);
25252cf14000SStefano Zampini   /* when HYPRE_MIXEDINT is defined, sizeof(HYPRE_Int) == 32 */
2526d851a50bSGlenn Hammond   iupper[0] += ilower[0] - 1;
2527d851a50bSGlenn Hammond   iupper[1] += ilower[1] - 1;
2528d851a50bSGlenn Hammond   iupper[2] += ilower[2] - 1;
25292cf14000SStefano Zampini   hlower[0]  = (HYPRE_Int)ilower[0];
25302cf14000SStefano Zampini   hlower[1]  = (HYPRE_Int)ilower[1];
25312cf14000SStefano Zampini   hlower[2]  = (HYPRE_Int)ilower[2];
25322cf14000SStefano Zampini   hupper[0]  = (HYPRE_Int)iupper[0];
25332cf14000SStefano Zampini   hupper[1]  = (HYPRE_Int)iupper[1];
25342cf14000SStefano Zampini   hupper[2]  = (HYPRE_Int)iupper[2];
2535d851a50bSGlenn Hammond 
2536d851a50bSGlenn Hammond   size = 1;
25372fa5cd67SKarl Rupp   for (i= 0; i< 3; i++) size *= (iupper[i]-ilower[i]+1);
25382fa5cd67SKarl Rupp 
2539d851a50bSGlenn Hammond   /* copy x values over to hypre for variable ordering */
2540d851a50bSGlenn Hammond   if (ordering) {
2541fd3f9acdSBarry Smith     PetscStackCallStandard(HYPRE_SStructVectorSetConstantValues,(mx->ss_b,0.0));
2542d9ca1df4SBarry Smith     ierr = VecGetArrayRead(x,&xx);CHKERRQ(ierr);
254339accc25SStefano Zampini     for (i= 0; i< nvars; i++) PetscStackCallStandard(HYPRE_SStructVectorSetBoxValues,(mx->ss_b,part,hlower,hupper,i,(HYPRE_Complex*)(xx+(size*i))));
2544d9ca1df4SBarry Smith     ierr = VecRestoreArrayRead(x,&xx);CHKERRQ(ierr);
2545fd3f9acdSBarry Smith     PetscStackCallStandard(HYPRE_SStructVectorAssemble,(mx->ss_b));
2546fd3f9acdSBarry Smith     PetscStackCallStandard(HYPRE_SStructMatrixMatvec,(1.0,mx->ss_mat,mx->ss_b,0.0,mx->ss_x));
2547fd3f9acdSBarry Smith     PetscStackCallStandard(HYPRE_SStructSysPFMGSolve,(ex->ss_solver,mx->ss_mat,mx->ss_b,mx->ss_x));
2548d851a50bSGlenn Hammond 
2549d851a50bSGlenn Hammond     /* copy solution values back to PETSc */
2550d851a50bSGlenn Hammond     ierr = VecGetArray(y,&yy);CHKERRQ(ierr);
255139accc25SStefano Zampini     for (i= 0; i< nvars; i++) PetscStackCallStandard(HYPRE_SStructVectorGetBoxValues,(mx->ss_x,part,hlower,hupper,i,(HYPRE_Complex*)(yy+(size*i))));
2552d851a50bSGlenn Hammond     ierr = VecRestoreArray(y,&yy);CHKERRQ(ierr);
2553a65764d7SBarry Smith   } else {      /* nodal ordering must be mapped to variable ordering for sys_pfmg */
2554d851a50bSGlenn Hammond     PetscScalar *z;
25554ddd07fcSJed Brown     PetscInt    j, k;
2556d851a50bSGlenn Hammond 
2557785e854fSJed Brown     ierr = PetscMalloc1(nvars*size,&z);CHKERRQ(ierr);
2558fd3f9acdSBarry Smith     PetscStackCallStandard(HYPRE_SStructVectorSetConstantValues,(mx->ss_b,0.0));
2559d9ca1df4SBarry Smith     ierr = VecGetArrayRead(x,&xx);CHKERRQ(ierr);
2560d851a50bSGlenn Hammond 
2561d851a50bSGlenn Hammond     /* transform nodal to hypre's variable ordering for sys_pfmg */
2562d851a50bSGlenn Hammond     for (i= 0; i< size; i++) {
2563d851a50bSGlenn Hammond       k= i*nvars;
25642fa5cd67SKarl Rupp       for (j= 0; j< nvars; j++) z[j*size+i]= xx[k+j];
2565d851a50bSGlenn Hammond     }
256639accc25SStefano Zampini     for (i= 0; i< nvars; i++) PetscStackCallStandard(HYPRE_SStructVectorSetBoxValues,(mx->ss_b,part,hlower,hupper,i,(HYPRE_Complex*)(z+(size*i))));
2567d9ca1df4SBarry Smith     ierr = VecRestoreArrayRead(x,&xx);CHKERRQ(ierr);
2568fd3f9acdSBarry Smith     PetscStackCallStandard(HYPRE_SStructVectorAssemble,(mx->ss_b));
2569fd3f9acdSBarry Smith     PetscStackCallStandard(HYPRE_SStructSysPFMGSolve,(ex->ss_solver,mx->ss_mat,mx->ss_b,mx->ss_x));
2570d851a50bSGlenn Hammond 
2571d851a50bSGlenn Hammond     /* copy solution values back to PETSc */
2572d851a50bSGlenn Hammond     ierr = VecGetArray(y,&yy);CHKERRQ(ierr);
257339accc25SStefano Zampini     for (i= 0; i< nvars; i++) PetscStackCallStandard(HYPRE_SStructVectorGetBoxValues,(mx->ss_x,part,hlower,hupper,i,(HYPRE_Complex*)(z+(size*i))));
2574d851a50bSGlenn Hammond     /* transform hypre's variable ordering for sys_pfmg to nodal ordering */
2575d851a50bSGlenn Hammond     for (i= 0; i< size; i++) {
2576d851a50bSGlenn Hammond       k= i*nvars;
25772fa5cd67SKarl Rupp       for (j= 0; j< nvars; j++) yy[k+j]= z[j*size+i];
2578d851a50bSGlenn Hammond     }
2579d851a50bSGlenn Hammond     ierr = VecRestoreArray(y,&yy);CHKERRQ(ierr);
2580d851a50bSGlenn Hammond     ierr = PetscFree(z);CHKERRQ(ierr);
2581d851a50bSGlenn Hammond   }
2582d851a50bSGlenn Hammond   PetscFunctionReturn(0);
2583d851a50bSGlenn Hammond }
2584d851a50bSGlenn Hammond 
2585ace3abfcSBarry Smith static PetscErrorCode PCApplyRichardson_SysPFMG(PC pc,Vec b,Vec y,Vec w,PetscReal rtol,PetscReal abstol, PetscReal dtol,PetscInt its,PetscBool guesszero,PetscInt *outits,PCRichardsonConvergedReason *reason)
2586d851a50bSGlenn Hammond {
2587d851a50bSGlenn Hammond   PC_SysPFMG     *jac = (PC_SysPFMG*)pc->data;
2588d851a50bSGlenn Hammond   PetscErrorCode ierr;
25892cf14000SStefano Zampini   HYPRE_Int      oits;
2590d851a50bSGlenn Hammond 
2591d851a50bSGlenn Hammond   PetscFunctionBegin;
2592dff31646SBarry Smith   ierr = PetscCitationsRegister(hypreCitation,&cite);CHKERRQ(ierr);
2593fd3f9acdSBarry Smith   PetscStackCallStandard(HYPRE_SStructSysPFMGSetMaxIter,(jac->ss_solver,its*jac->its));
2594fd3f9acdSBarry Smith   PetscStackCallStandard(HYPRE_SStructSysPFMGSetTol,(jac->ss_solver,rtol));
2595d851a50bSGlenn Hammond   ierr = PCApply_SysPFMG(pc,b,y);CHKERRQ(ierr);
25962cf14000SStefano Zampini   PetscStackCallStandard(HYPRE_SStructSysPFMGGetNumIterations,(jac->ss_solver,&oits));
2597d851a50bSGlenn Hammond   *outits = oits;
2598d851a50bSGlenn Hammond   if (oits == its) *reason = PCRICHARDSON_CONVERGED_ITS;
2599d851a50bSGlenn Hammond   else             *reason = PCRICHARDSON_CONVERGED_RTOL;
2600fd3f9acdSBarry Smith   PetscStackCallStandard(HYPRE_SStructSysPFMGSetTol,(jac->ss_solver,jac->tol));
2601fd3f9acdSBarry Smith   PetscStackCallStandard(HYPRE_SStructSysPFMGSetMaxIter,(jac->ss_solver,jac->its));
2602d851a50bSGlenn Hammond   PetscFunctionReturn(0);
2603d851a50bSGlenn Hammond }
2604d851a50bSGlenn Hammond 
2605d851a50bSGlenn Hammond PetscErrorCode PCSetUp_SysPFMG(PC pc)
2606d851a50bSGlenn Hammond {
2607d851a50bSGlenn Hammond   PetscErrorCode   ierr;
2608d851a50bSGlenn Hammond   PC_SysPFMG       *ex = (PC_SysPFMG*) pc->data;
2609d851a50bSGlenn Hammond   Mat_HYPRESStruct *mx = (Mat_HYPRESStruct*)(pc->pmat->data);
2610ace3abfcSBarry Smith   PetscBool        flg;
2611d851a50bSGlenn Hammond 
2612d851a50bSGlenn Hammond   PetscFunctionBegin;
2613251f4c67SDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)pc->pmat,MATHYPRESSTRUCT,&flg);CHKERRQ(ierr);
2614ce94432eSBarry Smith   if (!flg) SETERRQ(PetscObjectComm((PetscObject)pc),PETSC_ERR_ARG_INCOMP,"Must use MATHYPRESSTRUCT with this preconditioner");
2615d851a50bSGlenn Hammond 
2616d851a50bSGlenn Hammond   /* create the hypre sstruct solver object and set its information */
26172fa5cd67SKarl Rupp   if (ex->ss_solver) PetscStackCallStandard(HYPRE_SStructSysPFMGDestroy,(ex->ss_solver));
2618fd3f9acdSBarry Smith   PetscStackCallStandard(HYPRE_SStructSysPFMGCreate,(ex->hcomm,&ex->ss_solver));
2619fd3f9acdSBarry Smith   PetscStackCallStandard(HYPRE_SStructSysPFMGSetZeroGuess,(ex->ss_solver));
2620fd3f9acdSBarry Smith   PetscStackCallStandard(HYPRE_SStructSysPFMGSetup,(ex->ss_solver,mx->ss_mat,mx->ss_b,mx->ss_x));
2621d851a50bSGlenn Hammond   PetscFunctionReturn(0);
2622d851a50bSGlenn Hammond }
2623d851a50bSGlenn Hammond 
2624d851a50bSGlenn Hammond /*MC
2625d851a50bSGlenn Hammond      PCSysPFMG - the hypre SysPFMG multigrid solver
2626d851a50bSGlenn Hammond 
2627d851a50bSGlenn Hammond    Level: advanced
2628d851a50bSGlenn Hammond 
2629d851a50bSGlenn Hammond    Options Database:
2630d851a50bSGlenn Hammond + -pc_syspfmg_its <its> number of iterations of SysPFMG to use as preconditioner
2631d851a50bSGlenn Hammond . -pc_syspfmg_num_pre_relax <steps> number of smoothing steps before coarse grid
2632d851a50bSGlenn Hammond . -pc_syspfmg_num_post_relax <steps> number of smoothing steps after coarse grid
2633d851a50bSGlenn Hammond . -pc_syspfmg_tol <tol> tolerance of SysPFMG
2634a2b725a8SWilliam Gropp - -pc_syspfmg_relax_type -relaxation type for the up and down cycles, one of Weighted-Jacobi,Red/Black-Gauss-Seidel
2635d851a50bSGlenn Hammond 
263695452b02SPatrick Sanan    Notes:
263795452b02SPatrick Sanan     This is for CELL-centered descretizations
2638d851a50bSGlenn Hammond 
2639f6680f47SSatish Balay            This must be used with the MATHYPRESSTRUCT matrix type.
2640aa219208SBarry Smith            This is less general than in hypre, it supports only one part, and one block per process defined by a PETSc DMDA.
2641d851a50bSGlenn Hammond            Also, only cell-centered variables.
2642d851a50bSGlenn Hammond 
2643d851a50bSGlenn Hammond .seealso:  PCMG, MATHYPRESSTRUCT
2644d851a50bSGlenn Hammond M*/
2645d851a50bSGlenn Hammond 
26468cc058d9SJed Brown PETSC_EXTERN PetscErrorCode PCCreate_SysPFMG(PC pc)
2647d851a50bSGlenn Hammond {
2648d851a50bSGlenn Hammond   PetscErrorCode ierr;
2649d851a50bSGlenn Hammond   PC_SysPFMG     *ex;
2650d851a50bSGlenn Hammond 
2651d851a50bSGlenn Hammond   PetscFunctionBegin;
2652b00a9115SJed Brown   ierr     = PetscNew(&ex);CHKERRQ(ierr); \
2653d851a50bSGlenn Hammond   pc->data = ex;
2654d851a50bSGlenn Hammond 
2655d851a50bSGlenn Hammond   ex->its            = 1;
2656d851a50bSGlenn Hammond   ex->tol            = 1.e-8;
2657d851a50bSGlenn Hammond   ex->relax_type     = 1;
2658d851a50bSGlenn Hammond   ex->num_pre_relax  = 1;
2659d851a50bSGlenn Hammond   ex->num_post_relax = 1;
2660d851a50bSGlenn Hammond 
2661d851a50bSGlenn Hammond   pc->ops->setfromoptions  = PCSetFromOptions_SysPFMG;
2662d851a50bSGlenn Hammond   pc->ops->view            = PCView_SysPFMG;
2663d851a50bSGlenn Hammond   pc->ops->destroy         = PCDestroy_SysPFMG;
2664d851a50bSGlenn Hammond   pc->ops->apply           = PCApply_SysPFMG;
2665d851a50bSGlenn Hammond   pc->ops->applyrichardson = PCApplyRichardson_SysPFMG;
2666d851a50bSGlenn Hammond   pc->ops->setup           = PCSetUp_SysPFMG;
26672fa5cd67SKarl Rupp 
2668ffc4695bSBarry Smith   ierr = MPI_Comm_dup(PetscObjectComm((PetscObject)pc),&(ex->hcomm));CHKERRMPI(ierr);
2669fd3f9acdSBarry Smith   PetscStackCallStandard(HYPRE_SStructSysPFMGCreate,(ex->hcomm,&ex->ss_solver));
2670d851a50bSGlenn Hammond   PetscFunctionReturn(0);
2671d851a50bSGlenn Hammond }
2672