xref: /petsc/src/mat/impls/aij/mpi/mpiaij.h (revision 3d96e9964ff330fd2a9eee374bcd4376da7efe60)
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   PetscScalar *apv;
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   PetscBool   scalable;        /* flag determines scalable or non-scalable implementation */
29   Mat         Rd,Ro,AP_loc,C_loc,C_oth;
30 
31   Mat_Merge_SeqsToMPI *merge;
32   PetscErrorCode (*destroy)(Mat);
33   PetscErrorCode (*duplicate)(Mat,MatDuplicateOption,Mat*);
34 } Mat_PtAPMPI;
35 
36 typedef struct {
37   Mat A,B;                             /* local submatrices: A (diag part),
38                                            B (off-diag part) */
39   PetscMPIInt size;                     /* size of communicator */
40   PetscMPIInt rank;                     /* rank of proc in communicator */
41 
42   /* The following variables are used for matrix assembly */
43   PetscBool   donotstash;               /* PETSC_TRUE if off processor entries dropped */
44   MPI_Request *send_waits;              /* array of send requests */
45   MPI_Request *recv_waits;              /* array of receive requests */
46   PetscInt    nsends,nrecvs;           /* numbers of sends and receives */
47   PetscScalar *svalues,*rvalues;       /* sending and receiving data */
48   PetscInt    rmax;                     /* maximum message length */
49 #if defined(PETSC_USE_CTABLE)
50   PetscTable colmap;
51 #else
52   PetscInt *colmap;                     /* local col number of off-diag col */
53 #endif
54   PetscInt *garray;                     /* global index of all off-processor columns */
55 
56   /* The following variables are used for matrix-vector products */
57   Vec        lvec;                 /* local vector */
58   Vec        diag;
59   VecScatter Mvctx;                /* scatter context for vector */
60   PetscBool  roworiented;          /* if true, row-oriented input, default true */
61 
62   /* The following variables are for MatGetRow() */
63   PetscInt    *rowindices;         /* column indices for row */
64   PetscScalar *rowvalues;          /* nonzero values in row */
65   PetscBool   getrowactive;        /* indicates MatGetRow(), not restored */
66 
67   /* Used by MatDistribute_MPIAIJ() to allow reuse of previous matrix allocation  and nonzero pattern */
68   PetscInt *ld;                    /* number of entries per row left of diagona block */
69 
70   /* Used by MatMatMult() and MatPtAP() */
71   Mat_PtAPMPI *ptap;
72 
73   /* used by MatMatMatMult() */
74   Mat_MatMatMatMult *matmatmatmult;
75 
76   /* Used by MPICUSP and MPICUSPARSE classes */
77   void * spptr;
78 
79 } Mat_MPIAIJ;
80 
81 PETSC_EXTERN PetscErrorCode MatCreate_MPIAIJ(Mat);
82 
83 PETSC_INTERN PetscErrorCode MatAssemblyEnd_MPIAIJ(Mat,MatAssemblyType);
84 
85 PETSC_INTERN PetscErrorCode MatSetUpMultiply_MPIAIJ(Mat);
86 PETSC_INTERN PetscErrorCode MatDisAssemble_MPIAIJ(Mat);
87 PETSC_INTERN PetscErrorCode MatDuplicate_MPIAIJ(Mat,MatDuplicateOption,Mat*);
88 PETSC_INTERN PetscErrorCode MatIncreaseOverlap_MPIAIJ(Mat,PetscInt,IS [],PetscInt);
89 PETSC_INTERN PetscErrorCode MatIncreaseOverlap_MPIAIJ_Scalable(Mat,PetscInt,IS [],PetscInt);
90 PETSC_INTERN PetscErrorCode MatFDColoringCreate_MPIXAIJ(Mat,ISColoring,MatFDColoring);
91 PETSC_INTERN PetscErrorCode MatFDColoringSetUp_MPIXAIJ(Mat,ISColoring,MatFDColoring);
92 PETSC_INTERN PetscErrorCode MatCreateSubMatrices_MPIAIJ (Mat,PetscInt,const IS[],const IS[],MatReuse,Mat *[]);
93 PETSC_INTERN PetscErrorCode MatCreateSubMatricesMPI_MPIAIJ (Mat,PetscInt,const IS[],const IS[],MatReuse,Mat *[]);
94 PETSC_INTERN PetscErrorCode MatCreateSubMatrix_MPIAIJ_All(Mat,MatCreateSubMatrixOption,MatReuse,Mat *[]);
95 
96 
97 PETSC_INTERN PetscErrorCode MatCreateSubMatrix_MPIAIJ(Mat,IS,IS,MatReuse,Mat*);
98 PETSC_INTERN PetscErrorCode MatCreateSubMatrix_MPIAIJ_nonscalable(Mat,IS,IS,PetscInt,MatReuse,Mat*);
99 PETSC_INTERN PetscErrorCode MatCreateSubMatrix_MPIAIJ_SameRowDist(Mat,IS,IS,MatReuse,Mat*);
100 PETSC_INTERN PetscErrorCode MatCreateSubMatrix_MPIAIJ_SameRowColDist(Mat,IS,IS,MatReuse,Mat*);
101 PETSC_INTERN PetscErrorCode MatGetMultiProcBlock_MPIAIJ(Mat,MPI_Comm,MatReuse,Mat*);
102 
103 PETSC_INTERN PetscErrorCode MatLoad_MPIAIJ(Mat,PetscViewer);
104 PETSC_INTERN PetscErrorCode MatCreateColmap_MPIAIJ_Private(Mat);
105 PETSC_INTERN PetscErrorCode MatMatMult_MPIDense_MPIAIJ(Mat,Mat,MatReuse,PetscReal,Mat*);
106 PETSC_INTERN PetscErrorCode MatMatMult_MPIAIJ_MPIAIJ(Mat,Mat,MatReuse,PetscReal,Mat*);
107 PETSC_INTERN PetscErrorCode MatMatMultSymbolic_MPIAIJ_MPIAIJ_nonscalable(Mat,Mat,PetscReal,Mat*);
108 PETSC_INTERN PetscErrorCode MatMatMultSymbolic_MPIAIJ_MPIAIJ(Mat,Mat,PetscReal,Mat*);
109 PETSC_INTERN PetscErrorCode MatMatMultNumeric_MPIAIJ_MPIAIJ(Mat,Mat,Mat);
110 PETSC_INTERN PetscErrorCode MatMatMultNumeric_MPIAIJ_MPIAIJ_nonscalable(Mat,Mat,Mat);
111 
112 PETSC_INTERN PetscErrorCode MatMatMatMult_MPIAIJ_MPIAIJ_MPIAIJ(Mat,Mat,Mat,MatReuse,PetscReal,Mat*);
113 PETSC_INTERN PetscErrorCode MatMatMatMultSymbolic_MPIAIJ_MPIAIJ_MPIAIJ(Mat,Mat,Mat,PetscReal,Mat*);
114 PETSC_INTERN PetscErrorCode MatMatMatMultNumeric_MPIAIJ_MPIAIJ_MPIAIJ(Mat,Mat,Mat,Mat);
115 
116 PETSC_INTERN PetscErrorCode MatPtAP_MPIAIJ_MPIAIJ(Mat,Mat,MatReuse,PetscReal,Mat*);
117 PETSC_INTERN PetscErrorCode MatPtAPSymbolic_MPIAIJ_MPIAIJ(Mat,Mat,PetscReal,Mat*);
118 PETSC_INTERN PetscErrorCode MatPtAPNumeric_MPIAIJ_MPIAIJ(Mat,Mat,Mat);
119 
120 PETSC_INTERN PetscErrorCode MatPtAPSymbolic_MPIAIJ_MPIAIJ_ptap(Mat,Mat,PetscReal,Mat*);
121 PETSC_INTERN PetscErrorCode MatPtAPNumeric_MPIAIJ_MPIAIJ_ptap(Mat,Mat,Mat);
122 
123 PETSC_INTERN PetscErrorCode MatDestroy_MPIAIJ_PtAP(Mat);
124 PETSC_INTERN PetscErrorCode MatDestroy_MPIAIJ(Mat);
125 
126 PETSC_INTERN PetscErrorCode MatRARt_MPIAIJ_MPIAIJ(Mat,Mat,MatReuse,PetscReal,Mat*);
127 
128 PETSC_INTERN PetscErrorCode MatGetBrowsOfAoCols_MPIAIJ(Mat,Mat,MatReuse,PetscInt**,PetscInt**,MatScalar**,Mat*);
129 PETSC_INTERN PetscErrorCode MatSetValues_MPIAIJ(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],const PetscScalar [],InsertMode);
130 PETSC_INTERN PetscErrorCode MatDestroy_MPIAIJ_MatMatMult(Mat);
131 PETSC_INTERN PetscErrorCode PetscContainerDestroy_Mat_MatMatMultMPI(void*);
132 PETSC_INTERN PetscErrorCode MatSetOption_MPIAIJ(Mat,MatOption,PetscBool);
133 
134 PETSC_INTERN PetscErrorCode MatTransposeMatMult_MPIAIJ_MPIAIJ(Mat,Mat,MatReuse,PetscReal,Mat*);
135 PETSC_INTERN PetscErrorCode MatTransposeMatMultSymbolic_MPIAIJ_MPIAIJ_nonscalable(Mat,Mat,PetscReal,Mat*);
136 PETSC_INTERN PetscErrorCode MatTransposeMatMultSymbolic_MPIAIJ_MPIAIJ(Mat,Mat,PetscReal,Mat*);
137 PETSC_INTERN PetscErrorCode MatTransposeMatMultNumeric_MPIAIJ_MPIAIJ(Mat,Mat,Mat);
138 PETSC_INTERN PetscErrorCode MatTransposeMatMultNumeric_MPIAIJ_MPIAIJ_nonscalable(Mat,Mat,Mat);
139 PETSC_INTERN PetscErrorCode MatTransposeMatMultNumeric_MPIAIJ_MPIAIJ_matmatmult(Mat,Mat,Mat);
140 PETSC_INTERN PetscErrorCode MatTransposeMatMult_MPIAIJ_MPIDense(Mat,Mat,MatReuse,PetscReal,Mat*);
141 PETSC_INTERN PetscErrorCode MatTransposeMatMultSymbolic_MPIAIJ_MPIDense(Mat,Mat,PetscReal,Mat*);
142 PETSC_INTERN PetscErrorCode MatTransposeMatMultNumeric_MPIAIJ_MPIDense(Mat,Mat,Mat);
143 PETSC_INTERN PetscErrorCode MatGetSeqNonzeroStructure_MPIAIJ(Mat,Mat*);
144 
145 PETSC_INTERN PetscErrorCode MatSetFromOptions_MPIAIJ(PetscOptionItems*,Mat);
146 PETSC_INTERN PetscErrorCode MatMPIAIJSetPreallocation_MPIAIJ(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[]);
147 
148 #if !defined(PETSC_USE_COMPLEX) && !defined(PETSC_USE_REAL_SINGLE) && !defined(PETSC_USE_REAL___FLOAT128) && !defined(PETSC_USE_REAL___FP16)
149 PETSC_INTERN PetscErrorCode MatLUFactorSymbolic_MPIAIJ_TFS(Mat,IS,IS,const MatFactorInfo*,Mat*);
150 #endif
151 PETSC_INTERN PetscErrorCode MatSolve_MPIAIJ(Mat,Vec,Vec);
152 PETSC_INTERN PetscErrorCode MatILUFactor_MPIAIJ(Mat,IS,IS,const MatFactorInfo*);
153 
154 PETSC_INTERN PetscErrorCode MatAXPYGetPreallocation_MPIX_private(PetscInt,const PetscInt*,const PetscInt*,const PetscInt*,const PetscInt*,const PetscInt*,const PetscInt*,PetscInt*);
155 
156 extern PetscErrorCode MatGetDiagonalBlock_MPIAIJ(Mat,Mat*);
157 extern PetscErrorCode MatDiagonalScaleLocal_MPIAIJ(Mat,Vec);
158 
159 PETSC_INTERN PetscErrorCode MatGetSeqMats_MPIAIJ(Mat,Mat*,Mat*);
160 PETSC_INTERN PetscErrorCode MatSetSeqMats_MPIAIJ(Mat,IS,IS,IS,MatStructure,Mat,Mat);
161 
162 /* compute apa = A[i,:]*P = Ad[i,:]*P_loc + Ao*[i,:]*P_oth using sparse axpy */
163 #define AProw_scalable(i,ad,ao,p_loc,p_oth,api,apj,apa) \
164 {\
165   PetscInt    _anz,_pnz,_j,_k,*_ai,*_aj,_row,*_pi,*_pj,_nextp,*_apJ;      \
166   PetscScalar *_aa,_valtmp,*_pa;                             \
167   _apJ = apj + api[i];\
168   /* diagonal portion of A */\
169   _ai  = ad->i;\
170   _anz = _ai[i+1] - _ai[i];\
171   _aj  = ad->j + _ai[i];\
172   _aa  = ad->a + _ai[i];\
173   for (_j=0; _j<_anz; _j++) {\
174     _row = _aj[_j]; \
175     _pi  = p_loc->i;                                 \
176     _pnz = _pi[_row+1] - _pi[_row];         \
177     _pj  = p_loc->j + _pi[_row];                 \
178     _pa  = p_loc->a + _pi[_row];                 \
179     /* perform sparse axpy */                    \
180     _valtmp = _aa[_j];                           \
181     _nextp  = 0; \
182     for (_k=0; _nextp<_pnz; _k++) {                    \
183       if (_apJ[_k] == _pj[_nextp]) { /* column of AP == column of P */   \
184         apa[_k] += _valtmp*_pa[_nextp++];                                \
185       } \
186     }                                           \
187     (void)PetscLogFlops(2.0*_pnz);              \
188   }                                             \
189   /* off-diagonal portion of A */               \
190   _ai  = ao->i;\
191   _anz = _ai[i+1] - _ai[i];                     \
192   _aj  = ao->j + _ai[i];                         \
193   _aa  = ao->a + _ai[i];                         \
194   for (_j=0; _j<_anz; _j++) {                      \
195     _row = _aj[_j];    \
196     _pi  = p_oth->i;                         \
197     _pnz = _pi[_row+1] - _pi[_row];          \
198     _pj  = p_oth->j + _pi[_row];                  \
199     _pa  = p_oth->a + _pi[_row];                  \
200     /* perform sparse axpy */                     \
201     _valtmp = _aa[_j];                             \
202     _nextp  = 0; \
203     for (_k=0; _nextp<_pnz; _k++) {                     \
204       if (_apJ[_k] == _pj[_nextp]) { /* column of AP == column of P */\
205         apa[_k] += _valtmp*_pa[_nextp++];                       \
206       }                                                     \
207     }                                            \
208     (void)PetscLogFlops(2.0*_pnz);               \
209   } \
210 }
211 
212 #define AProw_nonscalable(i,ad,ao,p_loc,p_oth,apa) \
213 {\
214   PetscInt    _anz,_pnz,_j,_k,*_ai,*_aj,_row,*_pi,*_pj;      \
215   PetscScalar *_aa,_valtmp,*_pa;                             \
216   /* diagonal portion of A */\
217   _ai  = ad->i;\
218   _anz = _ai[i+1] - _ai[i];\
219   _aj  = ad->j + _ai[i];\
220   _aa  = ad->a + _ai[i];\
221   for (_j=0; _j<_anz; _j++) {\
222     _row = _aj[_j]; \
223     _pi  = p_loc->i;                                 \
224     _pnz = _pi[_row+1] - _pi[_row];         \
225     _pj  = p_loc->j + _pi[_row];                 \
226     _pa  = p_loc->a + _pi[_row];                 \
227     /* perform dense axpy */                    \
228     _valtmp = _aa[_j];                           \
229     for (_k=0; _k<_pnz; _k++) {                    \
230       apa[_pj[_k]] += _valtmp*_pa[_k];               \
231     }                                           \
232     (void)PetscLogFlops(2.0*_pnz);              \
233   }                                             \
234   /* off-diagonal portion of A */               \
235   _ai  = ao->i;\
236   _anz = _ai[i+1] - _ai[i];                     \
237   _aj  = ao->j + _ai[i];                         \
238   _aa  = ao->a + _ai[i];                         \
239   for (_j=0; _j<_anz; _j++) {                      \
240     _row = _aj[_j];    \
241     _pi  = p_oth->i;                         \
242     _pnz = _pi[_row+1] - _pi[_row];          \
243     _pj  = p_oth->j + _pi[_row];                  \
244     _pa  = p_oth->a + _pi[_row];                  \
245     /* perform dense axpy */                     \
246     _valtmp = _aa[_j];                             \
247     for (_k=0; _k<_pnz; _k++) {                     \
248       apa[_pj[_k]] += _valtmp*_pa[_k];                \
249     }                                            \
250     (void)PetscLogFlops(2.0*_pnz);               \
251   } \
252 }
253 
254 #endif
255