xref: /petsc/src/ksp/pc/impls/gamg/gamg.h (revision 3e7ff0edd3573be01c8c0fa32db97c3db8fa5c8d)
1 #if !defined(__GAMG_IMPL)
2 #define __GAMG_IMPL
3 #include <petsc-private/pcimpl.h>
4 #include <../src/ksp/pc/impls/mg/mgimpl.h>                    /*I "petscksp.h" I*/
5 #include <../src/mat/impls/aij/seq/aij.h>
6 #include <../src/mat/impls/aij/mpi/mpiaij.h>
7 
8 struct _PCGAMGOps {
9   PetscErrorCode (*graph)(PC, const Mat, Mat*);
10   PetscErrorCode (*coarsen)(PC, Mat*, PetscCoarsenData**);
11   PetscErrorCode (*prolongator)(PC, const Mat, const Mat, PetscCoarsenData*, Mat*);
12   PetscErrorCode (*optprol)(PC, const Mat, Mat*);
13   PetscErrorCode (*createdefaultdata)(PC, Mat); /* for data methods that have a default (SA) */
14   PetscErrorCode (*setfromoptions)(PC);
15   PetscErrorCode (*destroy)(PC);
16 };
17 
18 /* Private context for the GAMG preconditioner */
19 typedef struct gamg_TAG {
20   PCGAMGType type;
21   PetscInt  Nlevels;
22   PetscInt  setup_count;
23   PetscBool repart;
24   PetscBool reuse_prol;
25   PetscBool use_aggs_in_gasm;
26   PetscInt  min_eq_proc;
27   PetscInt  coarse_eq_limit;
28   PetscReal threshold;      /* common quatity to many AMG methods so keep it up here */
29   PetscInt  verbose;
30   PetscInt  emax_id;      /* stashing places */
31 
32   /* these 4 are all related to the method data and should be in the subctx */
33   PetscInt  data_sz;      /* nloc*data_rows*data_cols */
34   PetscInt  data_cell_rows;
35   PetscInt  data_cell_cols;
36   PetscInt  orig_data_cell_rows;
37   PetscInt  orig_data_cell_cols;
38   PetscReal eigtarget[2];
39   PetscReal *data;          /* [data_sz] blocked vector of vertex data on fine grid (coordinates/nullspace) */
40   PetscReal *orig_data;          /* cache data */
41 
42   struct _PCGAMGOps *ops;
43   char *gamg_type_name;
44 
45   void *subctx;
46 } PC_GAMG;
47 
48 PetscErrorCode PCSetFromOptions_MG(PC);
49 PetscErrorCode PCReset_MG(PC);
50 
51 /* hooks create derivied classes */
52 PetscErrorCode  PCCreateGAMG_GEO(PC pc);
53 PetscErrorCode  PCCreateGAMG_AGG(PC pc);
54 PetscErrorCode  PCCreateGAMG_Classical(PC pc);
55 
56 PetscErrorCode PCSetFromOptions_GAMG(PC pc);
57 PetscErrorCode PCDestroy_GAMG(PC pc);
58 
59 /* helper methods */
60 PetscErrorCode PCGAMGCreateGraph(const Mat, Mat*);
61 PetscErrorCode PCGAMGFilterGraph(Mat*, const PetscReal, const PetscBool, const PetscInt);
62 PetscErrorCode PCGAMGGetDataWithGhosts(const Mat a_Gmat, const PetscInt a_data_sz, const PetscReal a_data_in[],PetscInt *a_stride, PetscReal **a_data_out);
63 
64 #if defined PETSC_USE_LOG
65 /* #define PETSC_GAMG_USE_LOG */
66 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};
67 #if defined PETSC_GAMG_USE_LOG
68 PETSC_INTERN PetscLogEvent petsc_gamg_setup_events[NUM_SET];
69 #endif
70 PETSC_INTERN PetscLogEvent PC_GAMGGgraph_AGG;
71 PETSC_INTERN PetscLogEvent PC_GAMGGgraph_GEO;
72 PETSC_INTERN PetscLogEvent PC_GAMGCoarsen_AGG;
73 PETSC_INTERN PetscLogEvent PC_GAMGCoarsen_GEO;
74 PETSC_INTERN PetscLogEvent PC_GAMGProlongator_AGG;
75 PETSC_INTERN PetscLogEvent PC_GAMGProlongator_GEO;
76 PETSC_INTERN PetscLogEvent PC_GAMGOptprol_AGG;
77 #endif
78 
79 typedef struct _GAMGHashTable {
80   PetscInt *table;
81   PetscInt *data;
82   PetscInt size;
83 } GAMGHashTable;
84 
85 PETSC_EXTERN PetscErrorCode GAMGTableCreate(PetscInt a_size, GAMGHashTable *a_tab);
86 PETSC_EXTERN PetscErrorCode GAMGTableDestroy(GAMGHashTable*);
87 PETSC_EXTERN PetscErrorCode GAMGTableAdd(GAMGHashTable *a_tab, PetscInt a_key, PetscInt a_data);
88 PETSC_EXTERN PetscErrorCode GAMGTableFind(GAMGHashTable *a_tab, PetscInt a_key, PetscInt *a_data);
89 
90 #endif
91 
92