xref: /petsc/include/petscmatcoarsen.h (revision feff33ee0b5b037fa8f9f294dede656a2f85cc47)
1 
2 #ifndef __PETSCMATCOARSEN_H
3 #define __PETSCMATCOARSEN_H
4 #include <petscmat.h>
5 
6 PETSC_EXTERN PetscFunctionList MatCoarsenList;
7 
8 /*S
9      MatCoarsen - Object for managing the coarsening of a graph (symmetric matrix)
10 
11    Level: advanced
12 
13   Notes: This is used by the PCGAMG to generate coarser representations of an algebraic problem
14 
15   Concepts: coarsen
16 
17 .seealso:  MatCoarsenCreate(), MatCoarsenType
18 S*/
19 typedef struct _p_MatCoarsen* MatCoarsen;
20 
21 /*J
22     MatCoarsenType - String with the name of a PETSc matrix coarsen algorithm
23 
24    Level: beginner
25 
26 .seealso: MatCoarsenCreate(), MatCoarsen
27 J*/
28 typedef const char* MatCoarsenType;
29 #define MATCOARSENMIS  "mis"
30 #define MATCOARSENHEM  "hem"
31 
32 /* linked list for aggregates */
33 typedef struct _PetscCDIntNd{
34   struct _PetscCDIntNd *next;
35   PetscInt             gid;
36 }PetscCDIntNd;
37 
38 /* only used by node pool */
39 typedef struct _PetscCDArrNd{
40   struct _PetscCDArrNd *next;
41   struct _PetscCDIntNd *array;
42 }PetscCDArrNd;
43 
44 typedef struct _PetscCoarsenData{
45   PetscCDArrNd pool_list;  /* node pool */
46   PetscCDIntNd *new_node;
47   PetscInt     new_left;
48   PetscInt     chk_sz;
49   PetscCDIntNd *extra_nodes;
50   PetscCDIntNd **array;  /* Array of lists */
51   PetscInt     size;
52   Mat          mat;  /* cache a Mat for communication data */
53 }PetscCoarsenData;
54 
55 PETSC_EXTERN PetscErrorCode MatCoarsenCreate(MPI_Comm,MatCoarsen*);
56 PETSC_EXTERN PetscErrorCode MatCoarsenSetType(MatCoarsen,MatCoarsenType);
57 PETSC_EXTERN PetscErrorCode MatCoarsenSetAdjacency(MatCoarsen,Mat);
58 PETSC_EXTERN PetscErrorCode MatCoarsenSetGreedyOrdering(MatCoarsen,const IS);
59 PETSC_EXTERN PetscErrorCode MatCoarsenSetStrictAggs(MatCoarsen,PetscBool);
60 PETSC_EXTERN PetscErrorCode MatCoarsenGetData( MatCoarsen, PetscCoarsenData ** );
61 PETSC_EXTERN PetscErrorCode MatCoarsenApply(MatCoarsen);
62 PETSC_EXTERN PetscErrorCode MatCoarsenDestroy(MatCoarsen*);
63 PETSC_EXTERN PetscErrorCode MatCoarsenRegister(const char[],PetscErrorCode (*)(MatCoarsen));
64 PETSC_EXTERN PetscErrorCode MatCoarsenView(MatCoarsen,PetscViewer);
65 PETSC_EXTERN PetscErrorCode MatCoarsenSetFromOptions(MatCoarsen);
66 PETSC_EXTERN PetscErrorCode MatCoarsenGetType(MatCoarsen,MatCoarsenType*);
67 PETSC_STATIC_INLINE PetscErrorCode MatCoarsenViewFromOptions(MatCoarsen A,PetscObject obj,const char name[]) {return PetscObjectViewFromOptions((PetscObject)A,obj,name);}
68 
69 PETSC_EXTERN PetscErrorCode PetscCDCreate(PetscInt,PetscCoarsenData**);
70 PETSC_EXTERN PetscErrorCode PetscCDDestroy(PetscCoarsenData*);
71 PETSC_EXTERN PetscErrorCode PetscCDIntNdSetID(PetscCDIntNd*,PetscInt);
72 PETSC_EXTERN PetscErrorCode PetscCDIntNdGetID(const PetscCDIntNd*,PetscInt*);
73 PETSC_EXTERN PetscErrorCode PetscCDAppendID(PetscCoarsenData*,PetscInt,PetscInt);
74 PETSC_EXTERN PetscErrorCode PetscCDAppendRemove(PetscCoarsenData*,PetscInt,PetscInt);
75 PETSC_EXTERN PetscErrorCode PetscCDAppendNode(PetscCoarsenData*,PetscInt,PetscCDIntNd*);
76 PETSC_EXTERN PetscErrorCode PetscCDRemoveNextNode(PetscCoarsenData*,PetscInt,PetscCDIntNd*);
77 PETSC_EXTERN PetscErrorCode PetscCDRemoveAllAt(PetscCoarsenData*,PetscInt);
78 PETSC_EXTERN PetscErrorCode PetscCDSizeAt(const PetscCoarsenData*,PetscInt,PetscInt*);
79 PETSC_EXTERN PetscErrorCode PetscCDEmptyAt(const PetscCoarsenData*,PetscInt,PetscBool*);
80 PETSC_EXTERN PetscErrorCode PetscCDSetChuckSize(PetscCoarsenData*,PetscInt);
81 PETSC_EXTERN PetscErrorCode PetscCDPrint(const PetscCoarsenData*,MPI_Comm);
82 PETSC_EXTERN PetscErrorCode PetscCDGetMIS(PetscCoarsenData*,IS*);
83 PETSC_EXTERN PetscErrorCode PetscCDGetMat(const PetscCoarsenData*,Mat*);
84 PETSC_EXTERN PetscErrorCode PetscCDSetMat(PetscCoarsenData*,Mat);
85 
86 PETSC_EXTERN PetscErrorCode PetscCDGetHeadPos(const PetscCoarsenData*,PetscInt,PetscCDIntNd**);
87 PETSC_EXTERN PetscErrorCode PetscCDGetNextPos(const PetscCoarsenData*,PetscInt,PetscCDIntNd**);
88 PETSC_EXTERN PetscErrorCode PetscCDGetASMBlocks(const PetscCoarsenData*,const PetscInt,Mat,PetscInt*,IS**);
89 
90 
91 #endif
92