xref: /petsc/src/ksp/pc/impls/gamg/gamg.h (revision 5f042095cd6794de959e41580753d6ff4dec299c)
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   PetscInt       min_eq_proc;
15   PetscInt       coarse_eq_limit;
16   PetscReal      threshold; /* common quatity to many AMG methods so keep it up here */
17   PetscInt       verbose;
18   PetscInt       emax_id; /* stashing places */
19   PetscInt       col_bs_id;
20   /* these 4 are all related to the method data and should be in the subctx */
21   PetscInt       data_sz; /* nloc*data_rows*data_cols */
22   PetscInt       data_cell_rows;
23   PetscInt       data_cell_cols;
24   PetscReal     *data;      /* [data_sz] blocked vector of vertex data on fine grid (coordinates/nullspace) */
25   PetscErrorCode (*graph)( PC, const Mat, Mat * );
26   PetscErrorCode (*coarsen)( PC, Mat *, PetscCoarsenData** );
27   PetscErrorCode (*prolongator)( PC, const Mat, const Mat, PetscCoarsenData *, Mat* );
28   PetscErrorCode (*optprol)( PC, const Mat, Mat* );
29 
30   PetscErrorCode (*createdefaultdata)( PC ); /* for data methods that have a default (SA) */
31   void          *subctx;
32 } PC_GAMG;
33 
34 /* #if defined(PETSC_USE_DYNAMIC_LIBRARIES) */
35 /* #  define PCGAMGRegisterDynamic(a,b,c,d)       PCGAMGRegister(a,b,c,0) */
36 /* #else */
37 /* #  define PCGAMGRegisterDynamic(a,b,c,d)       PCGAMGRegister(a,b,c,d) */
38 /* #endif */
39 /* PetscErrorCode PCGAMGRegister(const char *implname,const char *path,const char *fname,PetscErrorCode (*cfunc)(PC)); */
40 
41 #define GAMGAGG "agg"
42 #define GAMGGEO "geo"
43 
44 PetscErrorCode PCSetFromOptions_MG( PC );
45 PetscErrorCode PCReset_MG( PC );
46 
47 /* hooks create derivied classes */
48 PetscErrorCode  PCCreateGAMG_GEO( PC pc );
49 PetscErrorCode  PCCreateGAMG_AGG( PC pc );
50 
51 PetscErrorCode PCSetFromOptions_GAMG( PC pc );
52 PetscErrorCode PCDestroy_GAMG(PC pc);
53 
54 /* helper methods */
55 PetscErrorCode PCGAMGCreateSimpleGraph( const Mat, Mat * );
56 PetscErrorCode PCGAMGScaleFilterGraph( Mat *, const PetscReal, const PetscBool, const PetscInt );
57 PetscErrorCode PCGAMGGetDataWithGhosts( const Mat a_Gmat, const PetscInt a_data_sz, const PetscReal a_data_in[],
58                                        PetscInt *a_stride, PetscReal **a_data_out );
59 
60 #if defined PETSC_USE_LOG
61 /* #define PETSC_GAMG_USE_LOG */
62 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};
63 #if defined PETSC_GAMG_USE_LOG
64 extern PetscLogEvent petsc_gamg_setup_events[NUM_SET];
65 #endif
66 extern PetscLogEvent PC_GAMGGgraph_AGG;
67 extern PetscLogEvent PC_GAMGGgraph_GEO;
68 extern PetscLogEvent PC_GAMGCoarsen_AGG;
69 extern PetscLogEvent PC_GAMGCoarsen_GEO;
70 extern PetscLogEvent PC_GAMGProlongator_AGG;
71 extern PetscLogEvent PC_GAMGProlongator_GEO;
72 extern PetscLogEvent PC_GAMGOptprol_AGG;
73 #endif
74 
75 typedef struct _GAMGHashTable{
76   PetscInt  *table;
77   PetscInt  *data;
78   PetscInt   size;
79 }GAMGHashTable;
80 
81 extern PetscErrorCode GAMGTableCreate( PetscInt a_size, GAMGHashTable *a_tab );
82 extern PetscErrorCode GAMGTableDestroy( GAMGHashTable * );
83 extern PetscErrorCode GAMGTableAdd( GAMGHashTable *a_tab, PetscInt a_key, PetscInt a_data );
84 extern PetscErrorCode GAMGTableFind( GAMGHashTable *a_tab, PetscInt a_key, PetscInt *a_data );
85 
86 #endif
87 
88