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