1 #ifndef PETSC_MATAIJ_IMPL_H 2 #define PETSC_MATAIJ_IMPL_H 3 4 #include <petsc/private/matimpl.h> 5 #include <petsc/private/hashmapi.h> 6 #include <petsc/private/hashmapijv.h> 7 8 /* 9 Used by MatCreateSubMatrices_MPIXAIJ_Local() 10 */ 11 typedef struct { /* used by MatCreateSubMatrices_MPIAIJ_SingleIS_Local() and MatCreateSubMatrices_MPIAIJ_Local */ 12 PetscInt id; /* index of submats, only submats[0] is responsible for deleting some arrays below */ 13 PetscInt nrqs, nrqr; 14 PetscInt **rbuf1, **rbuf2, **rbuf3, **sbuf1, **sbuf2; 15 PetscInt **ptr; 16 PetscInt *tmp; 17 PetscInt *ctr; 18 PetscInt *pa; /* proc array */ 19 PetscInt *req_size, *req_source1, *req_source2; 20 PetscBool allcolumns, allrows; 21 PetscBool singleis; 22 PetscInt *row2proc; /* row to proc map */ 23 PetscInt nstages; 24 #if defined(PETSC_USE_CTABLE) 25 PetscHMapI cmap, rmap; 26 PetscInt *cmap_loc, *rmap_loc; 27 #else 28 PetscInt *cmap, *rmap; 29 #endif 30 PetscErrorCode (*destroy)(Mat); 31 } Mat_SubSppt; 32 33 /* Operations provided by MATSEQAIJ and its subclasses */ 34 typedef struct { 35 PetscErrorCode (*getarray)(Mat, PetscScalar **); 36 PetscErrorCode (*restorearray)(Mat, PetscScalar **); 37 PetscErrorCode (*getarrayread)(Mat, const PetscScalar **); 38 PetscErrorCode (*restorearrayread)(Mat, const PetscScalar **); 39 PetscErrorCode (*getarraywrite)(Mat, PetscScalar **); 40 PetscErrorCode (*restorearraywrite)(Mat, PetscScalar **); 41 PetscErrorCode (*getcsrandmemtype)(Mat, const PetscInt **, const PetscInt **, PetscScalar **, PetscMemType *); 42 } Mat_SeqAIJOps; 43 44 /* 45 Struct header shared by SeqAIJ, SeqBAIJ and SeqSBAIJ matrix formats 46 */ 47 #define SEQAIJHEADER(datatype) \ 48 PetscBool roworiented; /* if true, row-oriented input, default */ \ 49 PetscInt nonew; /* 1 don't add new nonzeros, -1 generate error on new */ \ 50 PetscInt nounused; /* -1 generate error on unused space */ \ 51 PetscBool singlemalloc; /* if true a, i, and j have been obtained with one big malloc */ \ 52 PetscInt maxnz; /* allocated nonzeros */ \ 53 PetscInt *imax; /* maximum space allocated for each row */ \ 54 PetscInt *ilen; /* actual length of each row */ \ 55 PetscInt *ipre; /* space preallocated for each row by user */ \ 56 PetscBool free_imax_ilen; \ 57 PetscInt reallocs; /* number of mallocs done during MatSetValues() \ 58 as more values are set than were prealloced */ \ 59 PetscInt rmax; /* max nonzeros in any row */ \ 60 PetscBool keepnonzeropattern; /* keeps matrix structure same in calls to MatZeroRows()*/ \ 61 PetscBool ignorezeroentries; \ 62 PetscBool free_ij; /* free the column indices j and row offsets i when the matrix is destroyed */ \ 63 PetscBool free_a; /* free the numerical values when matrix is destroy */ \ 64 Mat_CompressedRow compressedrow; /* use compressed row format */ \ 65 PetscInt nz; /* nonzeros */ \ 66 PetscInt *i; /* pointer to beginning of each row */ \ 67 PetscInt *j; /* column values: j + i[k] - 1 is start of row k */ \ 68 PetscInt *diag; /* pointers to diagonal elements */ \ 69 PetscInt nonzerorowcnt; /* how many rows have nonzero entries */ \ 70 PetscBool free_diag; \ 71 datatype *a; /* nonzero elements */ \ 72 PetscScalar *solve_work; /* work space used in MatSolve */ \ 73 IS row, col, icol; /* index sets, used for reorderings */ \ 74 PetscBool pivotinblocks; /* pivot inside factorization of each diagonal block */ \ 75 Mat parent; /* set if this matrix was formed with MatDuplicate(...,MAT_SHARE_NONZERO_PATTERN,....); \ 76 means that this shares some data structures with the parent including diag, ilen, imax, i, j */ \ 77 Mat_SubSppt *submatis1; /* used by MatCreateSubMatrices_MPIXAIJ_Local */ \ 78 Mat_SeqAIJOps ops[1] /* operations for SeqAIJ and its subclasses */ 79 80 typedef struct { 81 MatTransposeColoring matcoloring; 82 Mat Bt_den; /* dense matrix of B^T */ 83 Mat ABt_den; /* dense matrix of A*B^T */ 84 PetscBool usecoloring; 85 } Mat_MatMatTransMult; 86 87 typedef struct { /* used by MatTransposeMatMult() */ 88 Mat At; /* transpose of the first matrix */ 89 Mat mA; /* maij matrix of A */ 90 Vec bt, ct; /* vectors to hold locally transposed arrays of B and C */ 91 /* used by PtAP */ 92 void *data; 93 PetscErrorCode (*destroy)(void *); 94 } Mat_MatTransMatMult; 95 96 typedef struct { 97 PetscInt *api, *apj; /* symbolic structure of A*P */ 98 PetscScalar *apa; /* temporary array for storing one row of A*P */ 99 } Mat_AP; 100 101 typedef struct { 102 MatTransposeColoring matcoloring; 103 Mat Rt; /* sparse or dense matrix of R^T */ 104 Mat RARt; /* dense matrix of R*A*R^T */ 105 Mat ARt; /* A*R^T used for the case -matrart_color_art */ 106 MatScalar *work; /* work array to store columns of A*R^T used in MatMatMatMultNumeric_SeqAIJ_SeqAIJ_SeqDense() */ 107 /* free intermediate products needed for PtAP */ 108 void *data; 109 PetscErrorCode (*destroy)(void *); 110 } Mat_RARt; 111 112 typedef struct { 113 Mat BC; /* temp matrix for storing B*C */ 114 } Mat_MatMatMatMult; 115 116 /* 117 MATSEQAIJ format - Compressed row storage (also called Yale sparse matrix 118 format) or compressed sparse row (CSR). The i[] and j[] arrays start at 0. For example, 119 j[i[k]+p] is the pth column in row k. Note that the diagonal 120 matrix elements are stored with the rest of the nonzeros (not separately). 121 */ 122 123 /* Info about i-nodes (identical nodes) helper class for SeqAIJ */ 124 typedef struct { 125 MatScalar *bdiag, *ibdiag, *ssor_work; /* diagonal blocks of matrix used for MatSOR_SeqAIJ_Inode() */ 126 PetscInt bdiagsize; /* length of bdiag and ibdiag */ 127 PetscBool ibdiagvalid; /* do ibdiag[] and bdiag[] contain the most recent values */ 128 129 PetscBool use; 130 PetscInt node_count; /* number of inodes */ 131 PetscInt *size; /* size of each inode */ 132 PetscInt limit; /* inode limit */ 133 PetscInt max_limit; /* maximum supported inode limit */ 134 PetscBool checked; /* if inodes have been checked for */ 135 PetscObjectState mat_nonzerostate; /* non-zero state when inodes were checked for */ 136 } Mat_SeqAIJ_Inode; 137 138 PETSC_INTERN PetscErrorCode MatView_SeqAIJ_Inode(Mat, PetscViewer); 139 PETSC_INTERN PetscErrorCode MatAssemblyEnd_SeqAIJ_Inode(Mat, MatAssemblyType); 140 PETSC_INTERN PetscErrorCode MatDestroy_SeqAIJ_Inode(Mat); 141 PETSC_INTERN PetscErrorCode MatCreate_SeqAIJ_Inode(Mat); 142 PETSC_INTERN PetscErrorCode MatSetOption_SeqAIJ_Inode(Mat, MatOption, PetscBool); 143 PETSC_INTERN PetscErrorCode MatDuplicate_SeqAIJ_Inode(Mat, MatDuplicateOption, Mat *); 144 PETSC_INTERN PetscErrorCode MatDuplicateNoCreate_SeqAIJ(Mat, Mat, MatDuplicateOption, PetscBool); 145 PETSC_INTERN PetscErrorCode MatLUFactorNumeric_SeqAIJ_Inode(Mat, Mat, const MatFactorInfo *); 146 PETSC_INTERN PetscErrorCode MatSeqAIJGetArray_SeqAIJ(Mat, PetscScalar **); 147 PETSC_INTERN PetscErrorCode MatSeqAIJRestoreArray_SeqAIJ(Mat, PetscScalar **); 148 149 typedef struct { 150 SEQAIJHEADER(MatScalar); 151 Mat_SeqAIJ_Inode inode; 152 MatScalar *saved_values; /* location for stashing nonzero values of matrix */ 153 154 PetscScalar *idiag, *mdiag, *ssor_work; /* inverse of diagonal entries, diagonal values and workspace for Eisenstat trick */ 155 PetscBool idiagvalid; /* current idiag[] and mdiag[] are valid */ 156 PetscScalar *ibdiag; /* inverses of block diagonals */ 157 PetscBool ibdiagvalid; /* inverses of block diagonals are valid. */ 158 PetscBool diagonaldense; /* all entries along the diagonal have been set; i.e. no missing diagonal terms */ 159 PetscScalar fshift, omega; /* last used omega and fshift */ 160 161 /* MatSetValues() via hash related fields */ 162 PetscHMapIJV ht; 163 PetscInt *dnz; 164 struct _MatOps cops; 165 } Mat_SeqAIJ; 166 167 typedef struct { 168 PetscInt nz; /* nz of the matrix after assembly */ 169 PetscCount n; /* Number of entries in MatSetPreallocationCOO() */ 170 PetscCount Atot; /* Total number of valid (i.e., w/ non-negative indices) entries in the COO array */ 171 PetscCount *jmap; /* perm[jmap[i]..jmap[i+1]) give indices of entries in v[] associated with i-th nonzero of the matrix */ 172 PetscCount *perm; /* The permutation array in sorting (i,j) by row and then by col */ 173 } MatCOOStruct_SeqAIJ; 174 175 /* 176 Frees the a, i, and j arrays from the XAIJ (AIJ, BAIJ, and SBAIJ) matrix types 177 */ 178 static inline PetscErrorCode MatSeqXAIJFreeAIJ(Mat AA, MatScalar **a, PetscInt **j, PetscInt **i) 179 { 180 Mat_SeqAIJ *A = (Mat_SeqAIJ *)AA->data; 181 182 PetscFunctionBegin; 183 if (A->singlemalloc) { 184 PetscCall(PetscFree3(*a, *j, *i)); 185 } else { 186 if (A->free_a) PetscCall(PetscFree(*a)); 187 if (A->free_ij) PetscCall(PetscFree(*j)); 188 if (A->free_ij) PetscCall(PetscFree(*i)); 189 } 190 PetscFunctionReturn(PETSC_SUCCESS); 191 } 192 /* 193 Allocates larger a, i, and j arrays for the XAIJ (AIJ, BAIJ, and SBAIJ) matrix types 194 This is a macro because it takes the datatype as an argument which can be either a Mat or a MatScalar 195 */ 196 #define MatSeqXAIJReallocateAIJ(Amat, AM, BS2, NROW, ROW, COL, RMAX, AA, AI, AJ, RP, AP, AIMAX, NONEW, datatype) \ 197 do { \ 198 if (NROW >= RMAX) { \ 199 Mat_SeqAIJ *Ain = (Mat_SeqAIJ *)Amat->data; \ 200 /* there is no extra room in row, therefore enlarge */ \ 201 PetscInt CHUNKSIZE = 15, new_nz = AI[AM] + CHUNKSIZE, len, *new_i = NULL, *new_j = NULL; \ 202 datatype *new_a; \ 203 \ 204 PetscCheck(NONEW != -2, PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "New nonzero at (%" PetscInt_FMT ",%" PetscInt_FMT ") caused a malloc\nUse MatSetOption(A, MAT_NEW_NONZERO_ALLOCATION_ERR, PETSC_FALSE) to turn off this check", ROW, COL); \ 205 /* malloc new storage space */ \ 206 PetscCall(PetscMalloc3(BS2 *new_nz, &new_a, new_nz, &new_j, AM + 1, &new_i)); \ 207 \ 208 /* copy over old data into new slots */ \ 209 for (ii = 0; ii < ROW + 1; ii++) new_i[ii] = AI[ii]; \ 210 for (ii = ROW + 1; ii < AM + 1; ii++) new_i[ii] = AI[ii] + CHUNKSIZE; \ 211 PetscCall(PetscArraycpy(new_j, AJ, AI[ROW] + NROW)); \ 212 len = (new_nz - CHUNKSIZE - AI[ROW] - NROW); \ 213 PetscCall(PetscArraycpy(new_j + AI[ROW] + NROW + CHUNKSIZE, AJ + AI[ROW] + NROW, len)); \ 214 PetscCall(PetscArraycpy(new_a, AA, BS2 *(AI[ROW] + NROW))); \ 215 PetscCall(PetscArrayzero(new_a + BS2 * (AI[ROW] + NROW), BS2 * CHUNKSIZE)); \ 216 PetscCall(PetscArraycpy(new_a + BS2 * (AI[ROW] + NROW + CHUNKSIZE), AA + BS2 * (AI[ROW] + NROW), BS2 * len)); \ 217 /* free up old matrix storage */ \ 218 PetscCall(MatSeqXAIJFreeAIJ(A, &Ain->a, &Ain->j, &Ain->i)); \ 219 AA = new_a; \ 220 Ain->a = (MatScalar *)new_a; \ 221 AI = Ain->i = new_i; \ 222 AJ = Ain->j = new_j; \ 223 Ain->singlemalloc = PETSC_TRUE; \ 224 \ 225 RP = AJ + AI[ROW]; \ 226 AP = AA + BS2 * AI[ROW]; \ 227 RMAX = AIMAX[ROW] = AIMAX[ROW] + CHUNKSIZE; \ 228 Ain->maxnz += BS2 * CHUNKSIZE; \ 229 Ain->reallocs++; \ 230 } \ 231 } while (0) 232 233 #define MatSeqXAIJReallocateAIJ_structure_only(Amat, AM, BS2, NROW, ROW, COL, RMAX, AI, AJ, RP, AIMAX, NONEW, datatype) \ 234 do { \ 235 if (NROW >= RMAX) { \ 236 Mat_SeqAIJ *Ain = (Mat_SeqAIJ *)Amat->data; \ 237 /* there is no extra room in row, therefore enlarge */ \ 238 PetscInt CHUNKSIZE = 15, new_nz = AI[AM] + CHUNKSIZE, len, *new_i = NULL, *new_j = NULL; \ 239 \ 240 PetscCheck(NONEW != -2, PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "New nonzero at (%" PetscInt_FMT ",%" PetscInt_FMT ") caused a malloc\nUse MatSetOption(A, MAT_NEW_NONZERO_ALLOCATION_ERR, PETSC_FALSE) to turn off this check", ROW, COL); \ 241 /* malloc new storage space */ \ 242 PetscCall(PetscMalloc1(new_nz, &new_j)); \ 243 PetscCall(PetscMalloc1(AM + 1, &new_i)); \ 244 \ 245 /* copy over old data into new slots */ \ 246 for (ii = 0; ii < ROW + 1; ii++) new_i[ii] = AI[ii]; \ 247 for (ii = ROW + 1; ii < AM + 1; ii++) new_i[ii] = AI[ii] + CHUNKSIZE; \ 248 PetscCall(PetscArraycpy(new_j, AJ, AI[ROW] + NROW)); \ 249 len = (new_nz - CHUNKSIZE - AI[ROW] - NROW); \ 250 PetscCall(PetscArraycpy(new_j + AI[ROW] + NROW + CHUNKSIZE, AJ + AI[ROW] + NROW, len)); \ 251 \ 252 /* free up old matrix storage */ \ 253 PetscCall(MatSeqXAIJFreeAIJ(A, &Ain->a, &Ain->j, &Ain->i)); \ 254 Ain->a = NULL; \ 255 AI = Ain->i = new_i; \ 256 AJ = Ain->j = new_j; \ 257 Ain->singlemalloc = PETSC_FALSE; \ 258 Ain->free_a = PETSC_FALSE; \ 259 \ 260 RP = AJ + AI[ROW]; \ 261 RMAX = AIMAX[ROW] = AIMAX[ROW] + CHUNKSIZE; \ 262 Ain->maxnz += BS2 * CHUNKSIZE; \ 263 Ain->reallocs++; \ 264 } \ 265 } while (0) 266 267 PETSC_INTERN PetscErrorCode MatSeqAIJSetPreallocation_SeqAIJ(Mat, PetscInt, const PetscInt *); 268 PETSC_INTERN PetscErrorCode MatSetPreallocationCOO_SeqAIJ(Mat, PetscCount, PetscInt[], PetscInt[]); 269 270 PETSC_INTERN PetscErrorCode MatILUFactorSymbolic_SeqAIJ(Mat, Mat, IS, IS, const MatFactorInfo *); 271 PETSC_INTERN PetscErrorCode MatILUFactorSymbolic_SeqAIJ_ilu0(Mat, Mat, IS, IS, const MatFactorInfo *); 272 273 PETSC_INTERN PetscErrorCode MatICCFactorSymbolic_SeqAIJ(Mat, Mat, IS, const MatFactorInfo *); 274 PETSC_INTERN PetscErrorCode MatCholeskyFactorSymbolic_SeqAIJ(Mat, Mat, IS, const MatFactorInfo *); 275 PETSC_INTERN PetscErrorCode MatCholeskyFactorNumeric_SeqAIJ_inplace(Mat, Mat, const MatFactorInfo *); 276 PETSC_INTERN PetscErrorCode MatCholeskyFactorNumeric_SeqAIJ(Mat, Mat, const MatFactorInfo *); 277 PETSC_INTERN PetscErrorCode MatDuplicate_SeqAIJ(Mat, MatDuplicateOption, Mat *); 278 PETSC_INTERN PetscErrorCode MatCopy_SeqAIJ(Mat, Mat, MatStructure); 279 PETSC_INTERN PetscErrorCode MatMissingDiagonal_SeqAIJ(Mat, PetscBool *, PetscInt *); 280 PETSC_INTERN PetscErrorCode MatMarkDiagonal_SeqAIJ(Mat); 281 PETSC_INTERN PetscErrorCode MatFindZeroDiagonals_SeqAIJ_Private(Mat, PetscInt *, PetscInt **); 282 283 PETSC_INTERN PetscErrorCode MatMult_SeqAIJ(Mat, Vec, Vec); 284 PETSC_INTERN PetscErrorCode MatMult_SeqAIJ_Inode(Mat, Vec, Vec); 285 PETSC_INTERN PetscErrorCode MatMultAdd_SeqAIJ(Mat, Vec, Vec, Vec); 286 PETSC_INTERN PetscErrorCode MatMultAdd_SeqAIJ_Inode(Mat, Vec, Vec, Vec); 287 PETSC_INTERN PetscErrorCode MatMultTranspose_SeqAIJ(Mat, Vec, Vec); 288 PETSC_INTERN PetscErrorCode MatMultTransposeAdd_SeqAIJ(Mat, Vec, Vec, Vec); 289 PETSC_INTERN PetscErrorCode MatSOR_SeqAIJ(Mat, Vec, PetscReal, MatSORType, PetscReal, PetscInt, PetscInt, Vec); 290 PETSC_INTERN PetscErrorCode MatSOR_SeqAIJ_Inode(Mat, Vec, PetscReal, MatSORType, PetscReal, PetscInt, PetscInt, Vec); 291 292 PETSC_INTERN PetscErrorCode MatSetOption_SeqAIJ(Mat, MatOption, PetscBool); 293 294 PETSC_INTERN PetscErrorCode MatGetSymbolicTranspose_SeqAIJ(Mat, PetscInt *[], PetscInt *[]); 295 PETSC_INTERN PetscErrorCode MatRestoreSymbolicTranspose_SeqAIJ(Mat, PetscInt *[], PetscInt *[]); 296 PETSC_INTERN PetscErrorCode MatGetSymbolicTransposeReduced_SeqAIJ(Mat, PetscInt, PetscInt, PetscInt *[], PetscInt *[]); 297 PETSC_INTERN PetscErrorCode MatTransposeSymbolic_SeqAIJ(Mat, Mat *); 298 PETSC_INTERN PetscErrorCode MatTranspose_SeqAIJ(Mat, MatReuse, Mat *); 299 300 PETSC_INTERN PetscErrorCode MatToSymmetricIJ_SeqAIJ(PetscInt, PetscInt *, PetscInt *, PetscBool, PetscInt, PetscInt, PetscInt **, PetscInt **); 301 PETSC_INTERN PetscErrorCode MatLUFactorSymbolic_SeqAIJ(Mat, Mat, IS, IS, const MatFactorInfo *); 302 PETSC_INTERN PetscErrorCode MatLUFactorNumeric_SeqAIJ_inplace(Mat, Mat, const MatFactorInfo *); 303 PETSC_INTERN PetscErrorCode MatLUFactorNumeric_SeqAIJ(Mat, Mat, const MatFactorInfo *); 304 PETSC_INTERN PetscErrorCode MatLUFactorNumeric_SeqAIJ_InplaceWithPerm(Mat, Mat, const MatFactorInfo *); 305 PETSC_INTERN PetscErrorCode MatLUFactor_SeqAIJ(Mat, IS, IS, const MatFactorInfo *); 306 PETSC_INTERN PetscErrorCode MatSolve_SeqAIJ_inplace(Mat, Vec, Vec); 307 PETSC_INTERN PetscErrorCode MatSolve_SeqAIJ(Mat, Vec, Vec); 308 PETSC_INTERN PetscErrorCode MatSolve_SeqAIJ_Inode(Mat, Vec, Vec); 309 PETSC_INTERN PetscErrorCode MatSolve_SeqAIJ_NaturalOrdering(Mat, Vec, Vec); 310 PETSC_INTERN PetscErrorCode MatSolveAdd_SeqAIJ(Mat, Vec, Vec, Vec); 311 PETSC_INTERN PetscErrorCode MatSolveTranspose_SeqAIJ_inplace(Mat, Vec, Vec); 312 PETSC_INTERN PetscErrorCode MatSolveTranspose_SeqAIJ(Mat, Vec, Vec); 313 PETSC_INTERN PetscErrorCode MatSolveTransposeAdd_SeqAIJ_inplace(Mat, Vec, Vec, Vec); 314 PETSC_INTERN PetscErrorCode MatSolveTransposeAdd_SeqAIJ(Mat, Vec, Vec, Vec); 315 PETSC_INTERN PetscErrorCode MatMatSolve_SeqAIJ(Mat, Mat, Mat); 316 PETSC_INTERN PetscErrorCode MatEqual_SeqAIJ(Mat, Mat, PetscBool *); 317 PETSC_INTERN PetscErrorCode MatFDColoringCreate_SeqXAIJ(Mat, ISColoring, MatFDColoring); 318 PETSC_INTERN PetscErrorCode MatFDColoringSetUp_SeqXAIJ(Mat, ISColoring, MatFDColoring); 319 PETSC_INTERN PetscErrorCode MatFDColoringSetUpBlocked_AIJ_Private(Mat, MatFDColoring, PetscInt); 320 PETSC_INTERN PetscErrorCode MatLoad_AIJ_HDF5(Mat, PetscViewer); 321 PETSC_INTERN PetscErrorCode MatLoad_SeqAIJ_Binary(Mat, PetscViewer); 322 PETSC_INTERN PetscErrorCode MatLoad_SeqAIJ(Mat, PetscViewer); 323 PETSC_INTERN PetscErrorCode RegisterApplyPtAPRoutines_Private(Mat); 324 325 #if defined(PETSC_HAVE_HYPRE) 326 PETSC_INTERN PetscErrorCode MatProductSetFromOptions_Transpose_AIJ_AIJ(Mat); 327 #endif 328 PETSC_INTERN PetscErrorCode MatProductSetFromOptions_SeqAIJ(Mat); 329 330 PETSC_INTERN PetscErrorCode MatProductSymbolic_SeqAIJ_SeqAIJ(Mat); 331 PETSC_INTERN PetscErrorCode MatProductSymbolic_PtAP_SeqAIJ_SeqAIJ(Mat); 332 PETSC_INTERN PetscErrorCode MatProductSymbolic_RARt_SeqAIJ_SeqAIJ(Mat); 333 334 PETSC_INTERN PetscErrorCode MatMatMultSymbolic_SeqAIJ_SeqAIJ(Mat, Mat, PetscReal, Mat); 335 PETSC_INTERN PetscErrorCode MatMatMultSymbolic_SeqAIJ_SeqAIJ_Sorted(Mat, Mat, PetscReal, Mat); 336 PETSC_INTERN PetscErrorCode MatMatMultSymbolic_SeqDense_SeqAIJ(Mat, Mat, PetscReal, Mat); 337 PETSC_INTERN PetscErrorCode MatMatMultSymbolic_SeqAIJ_SeqAIJ_Scalable(Mat, Mat, PetscReal, Mat); 338 PETSC_INTERN PetscErrorCode MatMatMultSymbolic_SeqAIJ_SeqAIJ_Scalable_fast(Mat, Mat, PetscReal, Mat); 339 PETSC_INTERN PetscErrorCode MatMatMultSymbolic_SeqAIJ_SeqAIJ_Heap(Mat, Mat, PetscReal, Mat); 340 PETSC_INTERN PetscErrorCode MatMatMultSymbolic_SeqAIJ_SeqAIJ_BTHeap(Mat, Mat, PetscReal, Mat); 341 PETSC_INTERN PetscErrorCode MatMatMultSymbolic_SeqAIJ_SeqAIJ_RowMerge(Mat, Mat, PetscReal, Mat); 342 PETSC_INTERN PetscErrorCode MatMatMultSymbolic_SeqAIJ_SeqAIJ_LLCondensed(Mat, Mat, PetscReal, Mat); 343 #if defined(PETSC_HAVE_HYPRE) 344 PETSC_INTERN PetscErrorCode MatMatMultSymbolic_AIJ_AIJ_wHYPRE(Mat, Mat, PetscReal, Mat); 345 #endif 346 347 PETSC_INTERN PetscErrorCode MatMatMultNumeric_SeqAIJ_SeqAIJ(Mat, Mat, Mat); 348 PETSC_INTERN PetscErrorCode MatMatMultNumeric_SeqAIJ_SeqAIJ_Sorted(Mat, Mat, Mat); 349 350 PETSC_INTERN PetscErrorCode MatMatMultNumeric_SeqDense_SeqAIJ(Mat, Mat, Mat); 351 PETSC_INTERN PetscErrorCode MatMatMultNumeric_SeqAIJ_SeqAIJ_Scalable(Mat, Mat, Mat); 352 353 PETSC_INTERN PetscErrorCode MatPtAPSymbolic_SeqAIJ_SeqAIJ_SparseAxpy(Mat, Mat, PetscReal, Mat); 354 PETSC_INTERN PetscErrorCode MatPtAPNumeric_SeqAIJ_SeqAIJ(Mat, Mat, Mat); 355 PETSC_INTERN PetscErrorCode MatPtAPNumeric_SeqAIJ_SeqAIJ_SparseAxpy(Mat, Mat, Mat); 356 357 PETSC_INTERN PetscErrorCode MatRARtSymbolic_SeqAIJ_SeqAIJ(Mat, Mat, PetscReal, Mat); 358 PETSC_INTERN PetscErrorCode MatRARtSymbolic_SeqAIJ_SeqAIJ_matmattransposemult(Mat, Mat, PetscReal, Mat); 359 PETSC_INTERN PetscErrorCode MatRARtSymbolic_SeqAIJ_SeqAIJ_colorrart(Mat, Mat, PetscReal, Mat); 360 PETSC_INTERN PetscErrorCode MatRARtNumeric_SeqAIJ_SeqAIJ(Mat, Mat, Mat); 361 PETSC_INTERN PetscErrorCode MatRARtNumeric_SeqAIJ_SeqAIJ_matmattransposemult(Mat, Mat, Mat); 362 PETSC_INTERN PetscErrorCode MatRARtNumeric_SeqAIJ_SeqAIJ_colorrart(Mat, Mat, Mat); 363 364 PETSC_INTERN PetscErrorCode MatTransposeMatMultSymbolic_SeqAIJ_SeqAIJ(Mat, Mat, PetscReal, Mat); 365 PETSC_INTERN PetscErrorCode MatTransposeMatMultNumeric_SeqAIJ_SeqAIJ(Mat, Mat, Mat); 366 PETSC_INTERN PetscErrorCode MatDestroy_SeqAIJ_MatTransMatMult(void *); 367 368 PETSC_INTERN PetscErrorCode MatMatTransposeMultSymbolic_SeqAIJ_SeqAIJ(Mat, Mat, PetscReal, Mat); 369 PETSC_INTERN PetscErrorCode MatMatTransposeMultNumeric_SeqAIJ_SeqAIJ(Mat, Mat, Mat); 370 PETSC_INTERN PetscErrorCode MatTransposeColoringCreate_SeqAIJ(Mat, ISColoring, MatTransposeColoring); 371 PETSC_INTERN PetscErrorCode MatTransColoringApplySpToDen_SeqAIJ(MatTransposeColoring, Mat, Mat); 372 PETSC_INTERN PetscErrorCode MatTransColoringApplyDenToSp_SeqAIJ(MatTransposeColoring, Mat, Mat); 373 374 PETSC_INTERN PetscErrorCode MatMatMatMultSymbolic_SeqAIJ_SeqAIJ_SeqAIJ(Mat, Mat, Mat, PetscReal, Mat); 375 PETSC_INTERN PetscErrorCode MatMatMatMultNumeric_SeqAIJ_SeqAIJ_SeqAIJ(Mat, Mat, Mat, Mat); 376 377 PETSC_INTERN PetscErrorCode MatSetRandomSkipColumnRange_SeqAIJ_Private(Mat, PetscInt, PetscInt, PetscRandom); 378 PETSC_INTERN PetscErrorCode MatSetValues_SeqAIJ(Mat, PetscInt, const PetscInt[], PetscInt, const PetscInt[], const PetscScalar[], InsertMode); 379 PETSC_INTERN PetscErrorCode MatGetRow_SeqAIJ(Mat, PetscInt, PetscInt *, PetscInt **, PetscScalar **); 380 PETSC_INTERN PetscErrorCode MatRestoreRow_SeqAIJ(Mat, PetscInt, PetscInt *, PetscInt **, PetscScalar **); 381 PETSC_INTERN PetscErrorCode MatScale_SeqAIJ(Mat, PetscScalar); 382 PETSC_INTERN PetscErrorCode MatDiagonalScale_SeqAIJ(Mat, Vec, Vec); 383 PETSC_INTERN PetscErrorCode MatDiagonalSet_SeqAIJ(Mat, Vec, InsertMode); 384 PETSC_INTERN PetscErrorCode MatAXPY_SeqAIJ(Mat, PetscScalar, Mat, MatStructure); 385 PETSC_INTERN PetscErrorCode MatGetRowIJ_SeqAIJ(Mat, PetscInt, PetscBool, PetscBool, PetscInt *, const PetscInt *[], const PetscInt *[], PetscBool *); 386 PETSC_INTERN PetscErrorCode MatRestoreRowIJ_SeqAIJ(Mat, PetscInt, PetscBool, PetscBool, PetscInt *, const PetscInt *[], const PetscInt *[], PetscBool *); 387 PETSC_INTERN PetscErrorCode MatGetColumnIJ_SeqAIJ(Mat, PetscInt, PetscBool, PetscBool, PetscInt *, const PetscInt *[], const PetscInt *[], PetscBool *); 388 PETSC_INTERN PetscErrorCode MatRestoreColumnIJ_SeqAIJ(Mat, PetscInt, PetscBool, PetscBool, PetscInt *, const PetscInt *[], const PetscInt *[], PetscBool *); 389 PETSC_INTERN PetscErrorCode MatGetColumnIJ_SeqAIJ_Color(Mat, PetscInt, PetscBool, PetscBool, PetscInt *, const PetscInt *[], const PetscInt *[], PetscInt *[], PetscBool *); 390 PETSC_INTERN PetscErrorCode MatRestoreColumnIJ_SeqAIJ_Color(Mat, PetscInt, PetscBool, PetscBool, PetscInt *, const PetscInt *[], const PetscInt *[], PetscInt *[], PetscBool *); 391 PETSC_INTERN PetscErrorCode MatDestroy_SeqAIJ(Mat); 392 PETSC_INTERN PetscErrorCode MatView_SeqAIJ(Mat, PetscViewer); 393 394 PETSC_INTERN PetscErrorCode MatSeqAIJInvalidateDiagonal(Mat); 395 PETSC_INTERN PetscErrorCode MatSeqAIJInvalidateDiagonal_Inode(Mat); 396 PETSC_INTERN PetscErrorCode MatSeqAIJCheckInode(Mat); 397 PETSC_INTERN PetscErrorCode MatSeqAIJCheckInode_FactorLU(Mat); 398 399 PETSC_INTERN PetscErrorCode MatAXPYGetPreallocation_SeqAIJ(Mat, Mat, PetscInt *); 400 401 #if defined(PETSC_HAVE_MATLAB) 402 PETSC_EXTERN PetscErrorCode MatlabEnginePut_SeqAIJ(PetscObject, void *); 403 PETSC_EXTERN PetscErrorCode MatlabEngineGet_SeqAIJ(PetscObject, void *); 404 #endif 405 PETSC_INTERN PetscErrorCode MatConvert_SeqAIJ_SeqSBAIJ(Mat, MatType, MatReuse, Mat *); 406 PETSC_INTERN PetscErrorCode MatConvert_SeqAIJ_SeqBAIJ(Mat, MatType, MatReuse, Mat *); 407 PETSC_INTERN PetscErrorCode MatConvert_SeqAIJ_SeqDense(Mat, MatType, MatReuse, Mat *); 408 PETSC_INTERN PetscErrorCode MatConvert_SeqAIJ_SeqAIJCRL(Mat, MatType, MatReuse, Mat *); 409 PETSC_INTERN PetscErrorCode MatConvert_SeqAIJ_Elemental(Mat, MatType, MatReuse, Mat *); 410 #if defined(PETSC_HAVE_SCALAPACK) 411 PETSC_INTERN PetscErrorCode MatConvert_AIJ_ScaLAPACK(Mat, MatType, MatReuse, Mat *); 412 #endif 413 PETSC_INTERN PetscErrorCode MatConvert_AIJ_HYPRE(Mat, MatType, MatReuse, Mat *); 414 PETSC_INTERN PetscErrorCode MatConvert_SeqAIJ_SeqAIJPERM(Mat, MatType, MatReuse, Mat *); 415 PETSC_INTERN PetscErrorCode MatConvert_SeqAIJ_SeqAIJSELL(Mat, MatType, MatReuse, Mat *); 416 PETSC_INTERN PetscErrorCode MatConvert_SeqAIJ_SeqAIJMKL(Mat, MatType, MatReuse, Mat *); 417 PETSC_INTERN PetscErrorCode MatConvert_SeqAIJ_SeqAIJViennaCL(Mat, MatType, MatReuse, Mat *); 418 PETSC_INTERN PetscErrorCode MatReorderForNonzeroDiagonal_SeqAIJ(Mat, PetscReal, IS, IS); 419 PETSC_INTERN PetscErrorCode MatRARt_SeqAIJ_SeqAIJ(Mat, Mat, MatReuse, PetscReal, Mat *); 420 PETSC_EXTERN PetscErrorCode MatCreate_SeqAIJ(Mat); 421 PETSC_INTERN PetscErrorCode MatAssemblyEnd_SeqAIJ(Mat, MatAssemblyType); 422 PETSC_EXTERN PetscErrorCode MatZeroEntries_SeqAIJ(Mat); 423 424 PETSC_INTERN PetscErrorCode MatAXPYGetPreallocation_SeqX_private(PetscInt, const PetscInt *, const PetscInt *, const PetscInt *, const PetscInt *, PetscInt *); 425 PETSC_INTERN PetscErrorCode MatCreateMPIMatConcatenateSeqMat_SeqAIJ(MPI_Comm, Mat, PetscInt, MatReuse, Mat *); 426 PETSC_INTERN PetscErrorCode MatCreateMPIMatConcatenateSeqMat_MPIAIJ(MPI_Comm, Mat, PetscInt, MatReuse, Mat *); 427 428 PETSC_INTERN PetscErrorCode MatSetSeqMat_SeqAIJ(Mat, IS, IS, MatStructure, Mat); 429 PETSC_INTERN PetscErrorCode MatEliminateZeros_SeqAIJ(Mat, PetscBool); 430 PETSC_INTERN PetscErrorCode MatDestroySubMatrix_Private(Mat_SubSppt *); 431 PETSC_INTERN PetscErrorCode MatDestroySubMatrix_SeqAIJ(Mat); 432 PETSC_INTERN PetscErrorCode MatDestroySubMatrix_Dummy(Mat); 433 PETSC_INTERN PetscErrorCode MatDestroySubMatrices_Dummy(PetscInt, Mat *[]); 434 PETSC_INTERN PetscErrorCode MatCreateSubMatrix_SeqAIJ(Mat, IS, IS, PetscInt, MatReuse, Mat *); 435 436 PETSC_INTERN PetscErrorCode MatSeqAIJCompactOutExtraColumns_SeqAIJ(Mat, ISLocalToGlobalMapping *); 437 PETSC_INTERN PetscErrorCode MatSetSeqAIJWithArrays_private(MPI_Comm, PetscInt, PetscInt, PetscInt[], PetscInt[], PetscScalar[], MatType, Mat); 438 439 /* 440 PetscSparseDenseMinusDot - The inner kernel of triangular solves and Gauss-Siedel smoothing. \sum_i xv[i] * r[xi[i]] for CSR storage 441 442 Input Parameters: 443 + nnz - the number of entries 444 . r - the array of vector values 445 . xv - the matrix values for the row 446 - xi - the column indices of the nonzeros in the row 447 448 Output Parameter: 449 . sum - negative the sum of results 450 451 PETSc compile flags: 452 + PETSC_KERNEL_USE_UNROLL_4 453 - PETSC_KERNEL_USE_UNROLL_2 454 455 Developer Note: 456 The macro changes sum but not other parameters 457 458 .seealso: `PetscSparseDensePlusDot()` 459 */ 460 #if defined(PETSC_KERNEL_USE_UNROLL_4) 461 #define PetscSparseDenseMinusDot(sum, r, xv, xi, nnz) \ 462 do { \ 463 if (nnz > 0) { \ 464 PetscInt nnz2 = nnz, rem = nnz & 0x3; \ 465 switch (rem) { \ 466 case 3: \ 467 sum -= *xv++ * r[*xi++]; \ 468 case 2: \ 469 sum -= *xv++ * r[*xi++]; \ 470 case 1: \ 471 sum -= *xv++ * r[*xi++]; \ 472 nnz2 -= rem; \ 473 } \ 474 while (nnz2 > 0) { \ 475 sum -= xv[0] * r[xi[0]] + xv[1] * r[xi[1]] + xv[2] * r[xi[2]] + xv[3] * r[xi[3]]; \ 476 xv += 4; \ 477 xi += 4; \ 478 nnz2 -= 4; \ 479 } \ 480 xv -= nnz; \ 481 xi -= nnz; \ 482 } \ 483 } while (0) 484 485 #elif defined(PETSC_KERNEL_USE_UNROLL_2) 486 #define PetscSparseDenseMinusDot(sum, r, xv, xi, nnz) \ 487 do { \ 488 PetscInt __i, __i1, __i2; \ 489 for (__i = 0; __i < nnz - 1; __i += 2) { \ 490 __i1 = xi[__i]; \ 491 __i2 = xi[__i + 1]; \ 492 sum -= (xv[__i] * r[__i1] + xv[__i + 1] * r[__i2]); \ 493 } \ 494 if (nnz & 0x1) sum -= xv[__i] * r[xi[__i]]; \ 495 } while (0) 496 497 #else 498 #define PetscSparseDenseMinusDot(sum, r, xv, xi, nnz) \ 499 do { \ 500 PetscInt __i; \ 501 for (__i = 0; __i < nnz; __i++) sum -= xv[__i] * r[xi[__i]]; \ 502 } while (0) 503 #endif 504 505 /* 506 PetscSparseDensePlusDot - The inner kernel of matrix-vector product \sum_i xv[i] * r[xi[i]] for CSR storage 507 508 Input Parameters: 509 + nnz - the number of entries 510 . r - the array of vector values 511 . xv - the matrix values for the row 512 - xi - the column indices of the nonzeros in the row 513 514 Output Parameter: 515 . sum - the sum of results 516 517 PETSc compile flags: 518 + PETSC_KERNEL_USE_UNROLL_4 519 - PETSC_KERNEL_USE_UNROLL_2 520 521 Developer Note: 522 The macro changes sum but not other parameters 523 524 .seealso: `PetscSparseDenseMinusDot()` 525 */ 526 #if defined(PETSC_KERNEL_USE_UNROLL_4) 527 #define PetscSparseDensePlusDot(sum, r, xv, xi, nnz) \ 528 do { \ 529 if (nnz > 0) { \ 530 PetscInt nnz2 = nnz, rem = nnz & 0x3; \ 531 switch (rem) { \ 532 case 3: \ 533 sum += *xv++ * r[*xi++]; \ 534 case 2: \ 535 sum += *xv++ * r[*xi++]; \ 536 case 1: \ 537 sum += *xv++ * r[*xi++]; \ 538 nnz2 -= rem; \ 539 } \ 540 while (nnz2 > 0) { \ 541 sum += xv[0] * r[xi[0]] + xv[1] * r[xi[1]] + xv[2] * r[xi[2]] + xv[3] * r[xi[3]]; \ 542 xv += 4; \ 543 xi += 4; \ 544 nnz2 -= 4; \ 545 } \ 546 xv -= nnz; \ 547 xi -= nnz; \ 548 } \ 549 } while (0) 550 551 #elif defined(PETSC_KERNEL_USE_UNROLL_2) 552 #define PetscSparseDensePlusDot(sum, r, xv, xi, nnz) \ 553 do { \ 554 PetscInt __i, __i1, __i2; \ 555 for (__i = 0; __i < nnz - 1; __i += 2) { \ 556 __i1 = xi[__i]; \ 557 __i2 = xi[__i + 1]; \ 558 sum += (xv[__i] * r[__i1] + xv[__i + 1] * r[__i2]); \ 559 } \ 560 if (nnz & 0x1) sum += xv[__i] * r[xi[__i]]; \ 561 } while (0) 562 563 #elif defined(PETSC_USE_AVX512_KERNELS) && defined(PETSC_HAVE_IMMINTRIN_H) && defined(__AVX512F__) && defined(PETSC_USE_REAL_DOUBLE) && !defined(PETSC_USE_COMPLEX) && !defined(PETSC_USE_64BIT_INDICES) && !defined(PETSC_SKIP_IMMINTRIN_H_CUDAWORKAROUND) 564 #define PetscSparseDensePlusDot(sum, r, xv, xi, nnz) PetscSparseDensePlusDot_AVX512_Private(&(sum), (r), (xv), (xi), (nnz)) 565 566 #else 567 #define PetscSparseDensePlusDot(sum, r, xv, xi, nnz) \ 568 do { \ 569 PetscInt __i; \ 570 for (__i = 0; __i < nnz; __i++) sum += xv[__i] * r[xi[__i]]; \ 571 } while (0) 572 #endif 573 574 #if defined(PETSC_USE_AVX512_KERNELS) && defined(PETSC_HAVE_IMMINTRIN_H) && defined(__AVX512F__) && defined(PETSC_USE_REAL_DOUBLE) && !defined(PETSC_USE_COMPLEX) && !defined(PETSC_USE_64BIT_INDICES) && !defined(PETSC_SKIP_IMMINTRIN_H_CUDAWORKAROUND) 575 #include <immintrin.h> 576 #if !defined(_MM_SCALE_8) 577 #define _MM_SCALE_8 8 578 #endif 579 580 static inline void PetscSparseDensePlusDot_AVX512_Private(PetscScalar *sum, const PetscScalar *x, const MatScalar *aa, const PetscInt *aj, PetscInt n) 581 { 582 __m512d vec_x, vec_y, vec_vals; 583 __m256i vec_idx; 584 PetscInt j; 585 586 vec_y = _mm512_setzero_pd(); 587 for (j = 0; j < (n >> 3); j++) { 588 vec_idx = _mm256_loadu_si256((__m256i const *)aj); 589 vec_vals = _mm512_loadu_pd(aa); 590 vec_x = _mm512_i32gather_pd(vec_idx, x, _MM_SCALE_8); 591 vec_y = _mm512_fmadd_pd(vec_x, vec_vals, vec_y); 592 aj += 8; 593 aa += 8; 594 } 595 #if defined(__AVX512VL__) 596 /* masked load requires avx512vl, which is not supported by KNL */ 597 if (n & 0x07) { 598 __mmask8 mask; 599 mask = (__mmask8)(0xff >> (8 - (n & 0x07))); 600 vec_idx = _mm256_mask_loadu_epi32(vec_idx, mask, aj); 601 vec_vals = _mm512_mask_loadu_pd(vec_vals, mask, aa); 602 vec_x = _mm512_mask_i32gather_pd(vec_x, mask, vec_idx, x, _MM_SCALE_8); 603 vec_y = _mm512_mask3_fmadd_pd(vec_x, vec_vals, vec_y, mask); 604 } 605 *sum += _mm512_reduce_add_pd(vec_y); 606 #else 607 *sum += _mm512_reduce_add_pd(vec_y); 608 for (j = 0; j < (n & 0x07); j++) *sum += aa[j] * x[aj[j]]; 609 #endif 610 } 611 #endif 612 613 /* 614 PetscSparseDenseMaxDot - The inner kernel of a modified matrix-vector product \max_i xv[i] * r[xi[i]] for CSR storage 615 616 Input Parameters: 617 + nnz - the number of entries 618 . r - the array of vector values 619 . xv - the matrix values for the row 620 - xi - the column indices of the nonzeros in the row 621 622 Output Parameter: 623 . max - the max of results 624 625 .seealso: `PetscSparseDensePlusDot()`, `PetscSparseDenseMinusDot()` 626 */ 627 #define PetscSparseDenseMaxDot(max, r, xv, xi, nnz) \ 628 do { \ 629 for (PetscInt __i = 0; __i < (nnz); __i++) { max = PetscMax(PetscRealPart(max), PetscRealPart((xv)[__i] * (r)[(xi)[__i]])); } \ 630 } while (0) 631 632 /* 633 Add column indices into table for counting the max nonzeros of merged rows 634 */ 635 #define MatRowMergeMax_SeqAIJ(mat, nrows, ta) \ 636 do { \ 637 if ((mat)) { \ 638 for (PetscInt _row = 0; _row < (nrows); _row++) { \ 639 const PetscInt _nz = (mat)->i[_row + 1] - (mat)->i[_row]; \ 640 for (PetscInt _j = 0; _j < _nz; _j++) { \ 641 PetscInt *_col = _j + (mat)->j + (mat)->i[_row]; \ 642 PetscCall(PetscHMapISet((ta), *_col + 1, 1)); \ 643 } \ 644 } \ 645 } \ 646 } while (0) 647 648 /* 649 Add column indices into table for counting the nonzeros of merged rows 650 */ 651 #define MatMergeRows_SeqAIJ(mat, nrows, rows, ta) \ 652 do { \ 653 for (PetscInt _i = 0; _i < (nrows); _i++) { \ 654 const PetscInt _row = (rows)[_i]; \ 655 const PetscInt _nz = (mat)->i[_row + 1] - (mat)->i[_row]; \ 656 for (PetscInt _j = 0; _j < _nz; _j++) { \ 657 PetscInt *_col = _j + (mat)->j + (mat)->i[_row]; \ 658 PetscCall(PetscHMapISetWithMode((ta), *_col + 1, 1, INSERT_VALUES)); \ 659 } \ 660 } \ 661 } while (0) 662 663 #endif 664