xref: /petsc/include/petsc/private/pcgamgimpl.h (revision 1404853cd07923df46691f50dfd5de8bf2e82a6a)
1 #pragma once
2 #include <petscksp.h>
3 #include <petsc/private/pcimpl.h>
4 #include <petsc/private/pcmgimpl.h> /*I "petscksp.h" I*/
5 #include <petscmatcoarsen.h>        /*I "petscmatcoarsen.h" I*/
6 #include <petsc/private/matimpl.h>
7 
8 struct _PCGAMGOps {
9   PetscErrorCode (*creategraph)(PC, Mat, Mat *);
10   PetscErrorCode (*coarsen)(PC, Mat *, PetscCoarsenData **);
11   PetscErrorCode (*prolongator)(PC, 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)(PC, PetscOptionItems);
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         asm_hem_aggs;
31   MatCoarsen       asm_crs; /* used to generate ASM aggregates */
32   PetscInt         coarse_eq_limit;
33   PetscReal        threshold_scale;
34   PetscReal        threshold[PETSC_MG_MAXLEVELS]; /* common quantity to many AMG methods so keep it up here */
35   PetscInt         level_reduction_factors[PETSC_MG_MAXLEVELS];
36   PetscInt         current_level; /* stash construction state */
37   /* these 4 are all related to the method data and should be in the subctx */
38   PetscInt   data_sz; /* nloc*data_rows*data_cols */
39   PetscInt   data_cell_rows;
40   PetscInt   data_cell_cols;
41   PetscInt   orig_data_cell_rows;
42   PetscInt   orig_data_cell_cols;
43   PetscReal *data;      /* [data_sz] blocked vector of vertex data on fine grid (coordinates/nullspace) */
44   PetscReal *orig_data; /* cache data */
45 
46   struct _PCGAMGOps *ops;
47   char              *gamg_type_name;
48 
49   void *subctx;
50 
51   PetscBool use_sa_esteig;
52   PetscReal emin, emax;
53   PetscBool recompute_esteig;
54   PetscInt  injection_index_size;
55   PetscInt  injection_index[MAT_COARSEN_STRENGTH_INDEX_SIZE];
56 } PC_GAMG;
57 
58 /* hooks create derivied classes */
59 PetscErrorCode PCCreateGAMG_GEO(PC);
60 PetscErrorCode PCCreateGAMG_AGG(PC);
61 PetscErrorCode PCCreateGAMG_Classical(PC);
62 
63 PetscErrorCode PCDestroy_GAMG(PC);
64 
65 /* helper methods */
66 PetscErrorCode PCGAMGGetDataWithGhosts(Mat, PetscInt, PetscReal[], PetscInt *, PetscReal **);
67 
68 enum tag {
69   GAMG_SETUP = 0,
70   GAMG_MESH,
71   GAMG_MATRIX,
72   GAMG_GRAPH,
73   GAMG_COARSEN,
74   GAMG_SQUARE,
75   GAMG_MIS,
76   GAMG_PROL,
77   GAMG_PROLA,
78   GAMG_PROLB,
79   GAMG_OPT,
80   GAMG_OPTSM,
81   GAMG_LEVEL,
82   GAMG_PTAP,
83   GAMG_REDUCE,
84   GAMG_REPART,
85   SET13,
86   SET14,
87   SET15,
88   GAMG_NUM_SET
89 };
90 PETSC_EXTERN PetscLogEvent petsc_gamg_setup_events[GAMG_NUM_SET];
91 PETSC_EXTERN PetscLogEvent petsc_gamg_setup_matmat_events[PETSC_MG_MAXLEVELS][3];
92 
93 typedef struct _PCGAMGHashTable {
94   PetscInt *table;
95   PetscInt *data;
96   PetscInt  size;
97 } PCGAMGHashTable;
98 
99 PETSC_INTERN PetscErrorCode PCGAMGHashTableCreate(PetscInt, PCGAMGHashTable *);
100 PETSC_INTERN PetscErrorCode PCGAMGHashTableDestroy(PCGAMGHashTable *);
101 PETSC_INTERN PetscErrorCode PCGAMGHashTableAdd(PCGAMGHashTable *, PetscInt, PetscInt);
102 
103 #define GAMG_HASH(key) (PetscInt)((((PetscInt64)7) * (PetscInt64)key) % (PetscInt64)a_tab->size)
104 static inline PetscErrorCode PCGAMGHashTableFind(PCGAMGHashTable *a_tab, PetscInt a_key, PetscInt *a_data)
105 {
106   PetscInt kk, idx;
107 
108   PetscFunctionBegin;
109   PetscCheck(a_key >= 0, PETSC_COMM_SELF, PETSC_ERR_USER, "Negative key %" PetscInt_FMT, a_key);
110   for (kk = 0, idx = GAMG_HASH(a_key); kk < a_tab->size; kk++, idx = (idx == (a_tab->size - 1)) ? 0 : idx + 1) {
111     if (a_tab->table[idx] == a_key) {
112       *a_data = a_tab->data[idx];
113       break;
114     } else if (a_tab->table[idx] == -1) {
115       /* not here */
116       *a_data = -1;
117       break;
118     }
119   }
120   PetscCheck(kk != a_tab->size, PETSC_COMM_SELF, PETSC_ERR_USER, "key %" PetscInt_FMT " not found in table", a_key);
121   PetscFunctionReturn(PETSC_SUCCESS);
122 }
123