xref: /petsc/include/petsc/private/pcgamgimpl.h (revision 7d5fd1e4d9337468ad3f05b65b7facdcd2dfd2a4)
1 #if !defined(__GAMG_IMPL)
2 #define __GAMG_IMPL
3 #include <petscksp.h>
4 #include <petsc/private/pcimpl.h>
5 #include <petsc/private/pcmgimpl.h>                    /*I "petscksp.h" I*/
6 #include <petscmatcoarsen.h>                           /*I "petscmatcoarsen.h" I*/
7 
8 struct _PCGAMGOps {
9   PetscErrorCode (*graph)(PC, Mat, Mat*);
10   PetscErrorCode (*coarsen)(PC, Mat*, PetscCoarsenData**);
11   PetscErrorCode (*prolongator)(PC, Mat, Mat, PetscCoarsenData*, Mat*);
12   PetscErrorCode (*optprolongator)(PC, Mat, Mat*);
13   PetscErrorCode (*createlevel)(PC, Mat, PetscInt, Mat *, Mat *, PetscMPIInt *, IS *, PetscBool);
14   PetscErrorCode (*createdefaultdata)(PC, Mat); /* for data methods that have a default (SA) */
15   PetscErrorCode (*setfromoptions)(PetscOptionItems*,PC);
16   PetscErrorCode (*destroy)(PC);
17   PetscErrorCode (*view)(PC,PetscViewer);
18 };
19 /* Private context for the GAMG preconditioner */
20 typedef struct gamg_TAG {
21   PCGAMGType type;
22   PetscInt  Nlevels;
23   PetscBool repart;
24   PetscBool reuse_prol;
25   PetscBool use_aggs_in_asm;
26   PetscBool use_parallel_coarse_grid_solver;
27   PCGAMGLayoutType layout_type;
28   PetscBool cpu_pin_coarse_grids;
29   PetscInt  min_eq_proc;
30   PetscInt  coarse_eq_limit;
31   PetscReal threshold_scale;
32   PetscReal threshold[PETSC_MG_MAXLEVELS]; /* common quatity to many AMG methods so keep it up here */
33   PetscInt  level_reduction_factors[PETSC_MG_MAXLEVELS];
34   PetscInt  current_level; /* stash construction state */
35   /* these 4 are all related to the method data and should be in the subctx */
36   PetscInt  data_sz;      /* nloc*data_rows*data_cols */
37   PetscInt  data_cell_rows;
38   PetscInt  data_cell_cols;
39   PetscInt  orig_data_cell_rows;
40   PetscInt  orig_data_cell_cols;
41   PetscReal *data;          /* [data_sz] blocked vector of vertex data on fine grid (coordinates/nullspace) */
42   PetscReal *orig_data;          /* cache data */
43 
44   struct _PCGAMGOps *ops;
45   char      *gamg_type_name;
46 
47   void      *subctx;
48 
49   char       esteig_type[32];
50   PetscInt   esteig_max_it;
51   PetscInt   use_sa_esteig;
52   PetscReal  emin,emax;
53 } PC_GAMG;
54 
55 PetscErrorCode PCReset_MG(PC);
56 
57 /* hooks create derivied classes */
58 PetscErrorCode PCCreateGAMG_GEO(PC);
59 PetscErrorCode PCCreateGAMG_AGG(PC);
60 PetscErrorCode PCCreateGAMG_Classical(PC);
61 
62 PetscErrorCode PCDestroy_GAMG(PC);
63 
64 /* helper methods */
65 PetscErrorCode PCGAMGCreateGraph(Mat, Mat*);
66 PetscErrorCode PCGAMGFilterGraph(Mat*, PetscReal, PetscBool);
67 PetscErrorCode PCGAMGGetDataWithGhosts(Mat, PetscInt, PetscReal[],PetscInt*, PetscReal **);
68 
69 enum tag {SET1,SET2,GRAPH,GRAPH_MAT,GRAPH_FILTER,GRAPH_SQR,SET4,SET5,SET6,FIND_V,SET7,SET8,SET9,SET10,SET11,SET12,SET13,SET14,SET15,SET16,NUM_SET};
70 PETSC_EXTERN PetscLogEvent petsc_gamg_setup_events[NUM_SET];
71 PETSC_EXTERN PetscLogEvent PC_GAMGGraph_AGG;
72 PETSC_EXTERN PetscLogEvent PC_GAMGGraph_GEO;
73 PETSC_EXTERN PetscLogEvent PC_GAMGCoarsen_AGG;
74 PETSC_EXTERN PetscLogEvent PC_GAMGCoarsen_GEO;
75 PETSC_EXTERN PetscLogEvent PC_GAMGProlongator_AGG;
76 PETSC_EXTERN PetscLogEvent PC_GAMGProlongator_GEO;
77 PETSC_EXTERN PetscLogEvent PC_GAMGOptProlongator_AGG;
78 PETSC_EXTERN PetscLogEvent petsc_gamg_setup_matmat_events[PETSC_MG_MAXLEVELS][3];
79 
80 typedef struct _PCGAMGHashTable {
81   PetscInt *table;
82   PetscInt *data;
83   PetscInt size;
84 } PCGAMGHashTable;
85 
86 PETSC_INTERN PetscErrorCode PCGAMGHashTableCreate(PetscInt, PCGAMGHashTable*);
87 PETSC_INTERN PetscErrorCode PCGAMGHashTableDestroy(PCGAMGHashTable*);
88 PETSC_INTERN PetscErrorCode PCGAMGHashTableAdd(PCGAMGHashTable*,PetscInt,PetscInt);
89 
90 #define GAMG_HASH(key) (PetscInt)((((PetscInt64)7)*(PetscInt64)key)%(PetscInt64)a_tab->size)
91 PETSC_STATIC_INLINE PetscErrorCode PCGAMGHashTableFind(PCGAMGHashTable *a_tab, PetscInt a_key, PetscInt *a_data)
92 {
93   PetscInt kk,idx;
94 
95   PetscFunctionBegin;
96   if (a_key<0) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_USER,"Negative key %D.",a_key);
97   for (kk = 0, idx = GAMG_HASH(a_key); kk < a_tab->size; kk++, idx = (idx==(a_tab->size-1)) ? 0 : idx + 1) {
98     if (a_tab->table[idx] == a_key) {
99       *a_data = a_tab->data[idx];
100       break;
101     } else if (a_tab->table[idx] == -1) {
102       /* not here */
103       *a_data = -1;
104       break;
105     }
106   }
107   if (kk==a_tab->size) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_USER,"key %D not found in table",a_key);
108   PetscFunctionReturn(0);
109 }
110 
111 #endif
112 
113