xref: /petsc/src/mat/impls/aij/mpi/mpiaij.h (revision 73a71a0f875e342bef2af9dbfc05b9368f8a1bc4)
1 
2 #if !defined(__MPIAIJ_H)
3 #define __MPIAIJ_H
4 
5 #include <../src/mat/impls/aij/seq/aij.h>
6 
7 typedef struct { /* used by MatCreateMPIAIJSumSeqAIJ for reusing the merged matrix */
8   PetscLayout    rowmap;
9   PetscInt       **buf_ri,**buf_rj;
10   PetscMPIInt    *len_s,*len_r,*id_r; /* array of length of comm->size, store send/recv matrix values */
11   PetscMPIInt    nsend,nrecv;
12   PetscInt       *bi,*bj; /* i and j array of the local portion of mpi C (matrix product) - rename to ci, cj! */
13   PetscInt       *owners_co,*coi,*coj; /* i and j array of (p->B)^T*A*P - used in the communication */
14   PetscErrorCode (*destroy)(Mat);
15   PetscErrorCode (*duplicate)(Mat,MatDuplicateOption,Mat*);
16 } Mat_Merge_SeqsToMPI;
17 
18 typedef struct { /* used by MatPtAP_MPIAIJ_MPIAIJ() and MatMatMult_MPIAIJ_MPIAIJ() */
19   PetscInt       *startsj_s,*startsj_r; /* used by MatGetBrowsOfAoCols_MPIAIJ */
20   PetscScalar    *bufa;                 /* used by MatGetBrowsOfAoCols_MPIAIJ */
21   Mat            P_loc,P_oth;  /* partial B_seq -- intend to replace B_seq */
22   PetscInt       *api,*apj;    /* symbolic i and j arrays of the local product A_loc*B_seq */
23   PetscInt       rmax;         /* max num of nnz in a local row of the matrix product */
24   MatReuse       reuse;        /* flag to skip MatGetBrowsOfAoCols_MPIAIJ() and MatMPIAIJGetLocalMat() in 1st call of MatPtAPNumeric_MPIAIJ_MPIAIJ() */
25   PetscScalar    *apa;         /* tmp array for store a row of A*P used in MatMatMult() */
26   Mat            A_loc;        /* used by MatTransposeMatMult(), contains api and apj */
27   Mat            Pt;           /* used by MatTransposeMatMult(), Pt = P^T */
28 
29   Mat_Merge_SeqsToMPI *merge;
30   PetscErrorCode (*destroy)(Mat);
31   PetscErrorCode (*duplicate)(Mat,MatDuplicateOption,Mat*);
32 } Mat_PtAPMPI;
33 
34 typedef struct {
35   Mat           A,B;                   /* local submatrices: A (diag part),
36                                            B (off-diag part) */
37   PetscMPIInt   size;                   /* size of communicator */
38   PetscMPIInt   rank;                   /* rank of proc in communicator */
39 
40   /* The following variables are used for matrix assembly */
41   PetscBool     donotstash;             /* PETSC_TRUE if off processor entries dropped */
42   MPI_Request   *send_waits;            /* array of send requests */
43   MPI_Request   *recv_waits;            /* array of receive requests */
44   PetscInt      nsends,nrecvs;         /* numbers of sends and receives */
45   PetscScalar   *svalues,*rvalues;     /* sending and receiving data */
46   PetscInt      rmax;                   /* maximum message length */
47 #if defined (PETSC_USE_CTABLE)
48   PetscTable    colmap;
49 #else
50   PetscInt      *colmap;                /* local col number of off-diag col */
51 #endif
52   PetscInt      *garray;                /* global index of all off-processor columns */
53 
54   /* The following variables are used for matrix-vector products */
55   Vec           lvec;              /* local vector */
56   Vec           diag;
57   VecScatter    Mvctx;             /* scatter context for vector */
58   PetscBool     roworiented;       /* if true, row-oriented input, default true */
59 
60   /* The following variables are for MatGetRow() */
61   PetscInt      *rowindices;       /* column indices for row */
62   PetscScalar   *rowvalues;        /* nonzero values in row */
63   PetscBool     getrowactive;      /* indicates MatGetRow(), not restored */
64 
65   /* Used by MatDistribute_MPIAIJ() to allow reuse of previous matrix allocation  and nonzero pattern */
66   PetscInt      *ld;               /* number of entries per row left of diagona block */
67 
68   /* Used by MatMatMult() and MatPtAP() */
69   Mat_PtAPMPI   *ptap;
70 
71   /* Used by MPICUSP and MPICUSPARSE classes */
72   void * spptr;
73 } Mat_MPIAIJ;
74 
75 EXTERN_C_BEGIN
76 extern PetscErrorCode  MatCreate_MPIAIJ(Mat);
77 EXTERN_C_END
78 
79 extern PetscErrorCode MatSetColoring_MPIAIJ(Mat,ISColoring);
80 extern PetscErrorCode MatSetValuesAdic_MPIAIJ(Mat,void*);
81 extern PetscErrorCode MatSetValuesAdifor_MPIAIJ(Mat,PetscInt,void*);
82 extern PetscErrorCode MatSetUpMultiply_MPIAIJ(Mat);
83 extern PetscErrorCode MatDisAssemble_MPIAIJ(Mat);
84 extern PetscErrorCode MatDuplicate_MPIAIJ(Mat,MatDuplicateOption,Mat *);
85 extern PetscErrorCode MatIncreaseOverlap_MPIAIJ(Mat,PetscInt,IS [],PetscInt);
86 extern PetscErrorCode MatFDColoringCreate_MPIAIJ(Mat,ISColoring,MatFDColoring);
87 extern PetscErrorCode MatGetSubMatrices_MPIAIJ (Mat,PetscInt,const IS[],const IS[],MatReuse,Mat *[]);
88 extern PetscErrorCode MatGetSubMatrix_MPIAIJ_All(Mat,MatGetSubMatrixOption,MatReuse,Mat *[]);
89 extern PetscErrorCode MatGetSubMatricesParallel_MPIAIJ (Mat,PetscInt,const IS[],const IS[],MatReuse,Mat *[]);
90 
91 extern PetscErrorCode MatGetSubMatrix_MPIAIJ(Mat,IS,IS,MatReuse,Mat *);
92 extern PetscErrorCode MatGetSubMatrix_MPIAIJ_Private (Mat,IS,IS,PetscInt,MatReuse,Mat *);
93 extern PetscErrorCode MatGetMultiProcBlock_MPIAIJ(Mat,MPI_Comm,MatReuse,Mat*);
94 
95 extern PetscErrorCode MatLoad_MPIAIJ(Mat,PetscViewer);
96 extern PetscErrorCode MatMatMult_MPIDense_MPIAIJ(Mat,Mat,MatReuse,PetscReal,Mat*);
97 extern PetscErrorCode MatMatMult_MPIAIJ_MPIAIJ(Mat,Mat,MatReuse,PetscReal,Mat*);
98 extern PetscErrorCode MatMatMultSymbolic_MPIAIJ_MPIAIJ(Mat,Mat,PetscReal,Mat*);
99 extern PetscErrorCode MatMatMultSymbolic_MPIAIJ_MPIAIJ_Scalable(Mat,Mat,PetscReal,Mat*);
100 extern PetscErrorCode MatMatMultNumeric_MPIAIJ_MPIAIJ(Mat,Mat,Mat);
101 
102 extern PetscErrorCode MatPtAPSymbolic_MPIAIJ(Mat,Mat,PetscReal,Mat*);
103 extern PetscErrorCode MatPtAPNumeric_MPIAIJ(Mat,Mat,Mat);
104 extern PetscErrorCode MatPtAPSymbolic_MPIAIJ_MPIAIJ(Mat,Mat,PetscReal,Mat*);
105 extern PetscErrorCode MatPtAPNumeric_MPIAIJ_MPIAIJ(Mat,Mat,Mat);
106 extern PetscErrorCode MatDestroy_MPIAIJ_PtAP(Mat);
107 extern PetscErrorCode MatDestroy_MPIAIJ(Mat);
108 
109 extern PetscErrorCode MatGetBrowsOfAoCols_MPIAIJ(Mat,Mat,MatReuse,PetscInt**,PetscInt**,MatScalar**,Mat*);
110 extern PetscErrorCode MatSetValues_MPIAIJ(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],const PetscScalar [],InsertMode);
111 extern PetscErrorCode MatDestroy_MPIAIJ_MatMatMult(Mat);
112 extern PetscErrorCode PetscContainerDestroy_Mat_MatMatMultMPI(void*);
113 extern PetscErrorCode MatSetOption_MPIAIJ(Mat,MatOption,PetscBool);
114 
115 extern PetscErrorCode MatTransposeMatMult_MPIAIJ_MPIAIJ(Mat,Mat,MatReuse,PetscReal,Mat*);
116 extern PetscErrorCode MatTransposeMatMultSymbolic_MPIAIJ_MPIAIJ(Mat,Mat,PetscReal,Mat*);
117 extern PetscErrorCode MatTransposeMatMultSymbolic_MPIAIJ_MPIAIJ_Scalable(Mat,Mat,PetscReal,Mat*);
118 extern PetscErrorCode MatTransposeMatMultNumeric_MPIAIJ_MPIAIJ(Mat,Mat,Mat);
119 
120 extern PetscErrorCode MatGetRedundantMatrix_MPIAIJ(Mat,PetscInt,MPI_Comm,PetscInt,MatReuse,Mat*);
121 extern PetscErrorCode MatGetSeqNonzeroStructure_MPIAIJ(Mat,Mat*);
122 
123 EXTERN_C_BEGIN
124 extern PetscErrorCode MatMPIAIJSetPreallocation_MPIAIJ(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[]);
125 EXTERN_C_END
126 
127 #if !defined(PETSC_USE_COMPLEX) && !defined(PETSC_USE_REAL_SINGLE) && !defined(PETSC_USE_REAL___FLOAT128)
128 extern PetscErrorCode MatLUFactorSymbolic_MPIAIJ_TFS(Mat,IS,IS,const MatFactorInfo*,Mat*);
129 #endif
130 extern PetscErrorCode MatSolve_MPIAIJ(Mat,Vec,Vec);
131 extern PetscErrorCode MatILUFactor_MPIAIJ(Mat,IS,IS,const MatFactorInfo *);
132 
133 EXTERN_C_BEGIN
134 extern PetscErrorCode  MatGetDiagonalBlock_MPIAIJ(Mat,Mat *);
135 extern PetscErrorCode  MatDiagonalScaleLocal_MPIAIJ(Mat,Vec);
136 EXTERN_C_END
137 
138 #endif
139