Actual source code: aij.h

  1: #pragma once

  3: #include <petsc/private/matimpl.h>
  4: #include <petsc/private/hashmapi.h>
  5: #include <petsc/private/hashmapijv.h>

  7: /*
  8:  Used by MatCreateSubMatrices_MPIXAIJ_Local()
  9: */
 10: typedef struct {   /* used by MatCreateSubMatrices_MPIAIJ_SingleIS_Local() and MatCreateSubMatrices_MPIAIJ_Local */
 11:   PetscInt     id; /* index of submats, only submats[0] is responsible for deleting some arrays below */
 12:   PetscMPIInt  nrqs, nrqr;
 13:   PetscInt   **rbuf1, **rbuf2, **rbuf3, **sbuf1, **sbuf2;
 14:   PetscInt   **ptr;
 15:   PetscInt    *tmp;
 16:   PetscInt    *ctr;
 17:   PetscMPIInt *pa; /* process array */
 18:   PetscInt    *req_size;
 19:   PetscMPIInt *req_source1, *req_source2;
 20:   PetscBool    allcolumns, allrows;
 21:   PetscBool    singleis;
 22:   PetscBool    csrcached;                    /* owned-row maps have been built, including a valid empty cache */
 23:   PetscMPIInt *row2proc;                     /* row to process (MPI rank) map */
 24:   PetscInt     nlocal_a, nlocal_b;           /* cached entries from the parent diagonal and off-diagonal blocks */
 25:   PetscInt    *local_a_parent, *local_a_sub; /* positions in the parent diagonal and submatrix value arrays */
 26:   PetscInt    *local_b_parent, *local_b_sub; /* positions in the parent off-diagonal and submatrix value arrays */
 27:   PetscInt     nstages;
 28: #if PetscDefined(USE_CTABLE)
 29:   PetscHMapI cmap, rmap;
 30:   PetscInt  *cmap_loc, *rmap_loc;
 31: #else
 32:   PetscInt *cmap, *rmap;
 33: #endif
 34:   PetscObjectState nonzerostate; /* initial submatrix graph state; cached positions require it unchanged */
 35:   PetscErrorCode (*destroy)(Mat);
 36: } Mat_SubSppt;

 38: /* Operations provided by MATSEQAIJ and its subclasses */
 39: typedef struct {
 40:   PetscErrorCode (*getarray)(Mat, PetscScalar **);
 41:   PetscErrorCode (*restorearray)(Mat, PetscScalar **);
 42:   PetscErrorCode (*getarrayread)(Mat, const PetscScalar **);
 43:   PetscErrorCode (*restorearrayread)(Mat, const PetscScalar **);
 44:   PetscErrorCode (*getarraywrite)(Mat, PetscScalar **);
 45:   PetscErrorCode (*restorearraywrite)(Mat, PetscScalar **);
 46:   PetscErrorCode (*getcsrandmemtype)(Mat, const PetscInt **, const PetscInt **, PetscScalar **, PetscMemType *);
 47: } Mat_SeqAIJOps;

 49: /*
 50:     Struct header shared by SeqAIJ, SeqBAIJ, and SeqSBAIJ matrix formats
 51: */
 52: #define SEQAIJHEADER(datatype) \
 53:   PetscBool         roworiented; /* if true, row-oriented input, default */ \
 54:   PetscInt          nonew;       /* 1 don't add new nonzeros, -1 generate error on new */ \
 55:   PetscInt          nounused;    /* -1 generate error on unused space */ \
 56:   PetscInt          maxnz;       /* allocated nonzeros */ \
 57:   PetscInt         *imax;        /* maximum space allocated for each row */ \
 58:   PetscInt         *ilen;        /* actual length of each row */ \
 59:   PetscInt         *ipre;        /* space preallocated for each row by user */ \
 60:   PetscBool         free_imax_ilen; \
 61:   PetscInt          reallocs;           /* number of mallocs done during MatSetValues() \
 62:                                         as more values are set than were prealloced */ \
 63:   PetscInt          rmax;               /* max nonzeros in any row */ \
 64:   PetscBool         keepnonzeropattern; /* keeps matrix nonzero structure same in calls to MatZeroRows()*/ \
 65:   PetscBool         ignorezeroentries; \
 66:   PetscBool         free_ij;          /* free the column indices j and row offsets i when the matrix is destroyed */ \
 67:   PetscBool         free_a;           /* free the numerical values when matrix is destroy */ \
 68:   Mat_CompressedRow compressedrow;    /* use compressed row format */ \
 69:   PetscInt          nz;               /* nonzeros */ \
 70:   PetscInt         *i;                /* pointer to beginning of each row */ \
 71:   PetscInt         *j;                /* column values: j + i[k] - 1 is start of row k */ \
 72:   PetscInt         *diag;             /* pointers to diagonal elements */ \
 73:   PetscObjectState  diagNonzeroState; /* nonzero state of the matrix when diag was obtained */ \
 74:   PetscBool         diagDense;        /* all entries along the diagonal have been set; i.e. no missing diagonal terms */ \
 75:   PetscInt          nonzerorowcnt;    /* how many rows have nonzero entries */ \
 76:   datatype         *a;                /* nonzero elements */ \
 77:   PetscScalar      *solve_work;       /* work space used in MatSolve */ \
 78:   IS                row, col, icol;   /* index sets, used for reorderings */ \
 79:   PetscBool         pivotinblocks;    /* pivot inside factorization of each diagonal block */ \
 80:   Mat               parent;           /* set if this matrix was formed with MatDuplicate(...,MAT_SHARE_NONZERO_PATTERN,....); \
 81:                                          means that this shares some data structures with the parent including diag, ilen, imax, i, j */ \
 82:   Mat_SubSppt      *submatis1;        /* used by MatCreateSubMatrices_MPIXAIJ_Local */ \
 83:   Mat_SeqAIJOps     ops[1]            /* operations for SeqAIJ and its subclasses */

 85: typedef struct {
 86:   MatTransposeColoring matcoloring;
 87:   Mat                  Bt_den;  /* dense matrix of B^T */
 88:   Mat                  ABt_den; /* dense matrix of A*B^T */
 89:   PetscBool            usecoloring;
 90: } MatProductCtx_MatMatTransMult;

 92: typedef struct { /* used by MatTransposeMatMult() */
 93:   Mat At;        /* transpose of the first matrix */
 94:   Mat mA;        /* maij matrix of A */
 95:   Vec bt, ct;    /* vectors to hold locally transposed arrays of B and C */
 96:   /* used by PtAP */
 97:   void              *data;
 98:   PetscCtxDestroyFn *destroy;
 99: } MatProductCtx_MatTransMatMult;

101: typedef struct {
102:   PetscInt    *api, *apj; /* symbolic structure of A*P */
103:   PetscScalar *apa;       /* temporary array for storing one row of A*P */
104: } MatProductCtx_AP;

106: typedef struct {
107:   MatTransposeColoring matcoloring;
108:   Mat                  Rt;   /* sparse or dense matrix of R^T */
109:   Mat                  RARt; /* dense matrix of R*A*R^T */
110:   Mat                  ARt;  /* A*R^T used for the case -matrart_color_art */
111:   MatScalar           *work; /* work array to store columns of A*R^T used in MatMatMatMultNumeric_SeqAIJ_SeqAIJ_SeqDense() */
112:   /* free intermediate products needed for PtAP */
113:   void              *data;
114:   PetscCtxDestroyFn *destroy;
115: } MatProductCtx_RARt;

117: typedef struct {
118:   Mat BC; /* temp matrix for storing B*C */
119: } MatProductCtx_MatMatMatMult;

121: /*
122:   MATSEQAIJ format - Compressed row storage (also called Yale sparse matrix
123:   format) or compressed sparse row (CSR).  The i[] and j[] arrays start at 0. For example,
124:   j[i[k]+p] is the pth column in row k.  Note that the diagonal
125:   matrix elements are stored with the rest of the nonzeros (not separately).
126: */

128: /* Info about i-nodes (identical nodes) helper class for SeqAIJ */
129: typedef struct {
130:   /* data for  MatSOR_SeqAIJ_Inode() */
131:   MatScalar       *bdiag, *ibdiag, *ssor_work; /* diagonal blocks of matrices */
132:   PetscInt         bdiagsize;                  /* length of bdiag and ibdiag */
133:   PetscObjectState ibdiagState;                /* state of the matrix when  ibdiag[] and bdiag[] were constructed */

135:   PetscBool        use;
136:   PetscInt         node_count;       /* number of inodes */
137:   PetscInt        *size_csr;         /* inode sizes in csr with size_csr[0] = 0 and i-th node size = size_csr[i+1] - size_csr[i], to facilitate parallel computation */
138:   PetscInt         limit;            /* inode limit */
139:   PetscInt         max_limit;        /* maximum supported inode limit */
140:   PetscBool        checked;          /* if inodes have been checked for */
141:   PetscObjectState mat_nonzerostate; /* non-zero state when inodes were checked for */
142: } Mat_SeqAIJ_Inode;

144: PETSC_INTERN PetscErrorCode MatView_SeqAIJ_Inode(Mat, PetscViewer);
145: PETSC_INTERN PetscErrorCode MatAssemblyEnd_SeqAIJ_Inode(Mat, MatAssemblyType);
146: PETSC_INTERN PetscErrorCode MatDestroy_SeqAIJ_Inode(Mat);
147: PETSC_INTERN PetscErrorCode MatCreate_SeqAIJ_Inode(Mat);
148: PETSC_INTERN PetscErrorCode MatSetOption_SeqAIJ_Inode(Mat, MatOption, PetscBool);
149: PETSC_INTERN PetscErrorCode MatDuplicate_SeqAIJ_Inode(Mat, MatDuplicateOption, Mat *);
150: PETSC_INTERN PetscErrorCode MatDuplicateNoCreate_SeqAIJ(Mat, Mat, MatDuplicateOption, PetscBool);
151: PETSC_INTERN PetscErrorCode MatLUFactorNumeric_SeqAIJ_Inode(Mat, Mat, const MatFactorInfo *);
152: PETSC_INTERN PetscErrorCode MatSeqAIJGetArray_SeqAIJ(Mat, PetscScalar **);
153: PETSC_INTERN PetscErrorCode MatSeqAIJRestoreArray_SeqAIJ(Mat, PetscScalar **);

155: typedef struct {
156:   SEQAIJHEADER(MatScalar);
157:   Mat_SeqAIJ_Inode inode;
158:   MatScalar       *saved_values; /* location for stashing nonzero values of matrix */

160:   /* data needed for MatSOR_SeqAIJ() */
161:   PetscScalar     *mdiag, *idiag; /* diagonal values, inverse of diagonal entries */
162:   PetscScalar     *ssor_work;     /* workspace for Eisenstat trick */
163:   PetscObjectState idiagState;    /* state of the matrix when mdiag and idiag was obtained */
164:   PetscScalar      fshift, omega; /* last used omega and fshift */

166:   PetscScalar     *ibdiag;      /* inverses of block diagonals */
167:   PetscInt         ibdiagsize;  /* length of ibdiag[], which changes if the block size does */
168:   PetscObjectState ibdiagState; /* state of the matrix when ibdiag[] was obtained */

170:   /* MatSetValues() via hash related fields */
171:   PetscHMapIJV   ht;
172:   PetscInt      *dnz;
173:   struct _MatOps cops;
174: } Mat_SeqAIJ;

176: typedef struct {
177:   PetscInt    nz;   /* nz of the matrix after assembly */
178:   PetscCount  n;    /* Number of entries in MatSetPreallocationCOO() */
179:   PetscCount  Atot; /* Total number of valid (i.e., w/ non-negative indices) entries in the COO array */
180:   PetscCount *jmap; /* perm[jmap[i]..jmap[i+1]) give indices of entries in v[] associated with i-th nonzero of the matrix */
181:   PetscCount *perm; /* The permutation array in sorting (i,j) by row and then by col */
182: } MatCOOStruct_SeqAIJ;

184: #define MatSeqXAIJGetOptions_Private(A) \
185:   { \
186:     const PetscBool oldvalues = (PetscBool)(A != PETSC_NULLPTR); \
187:     PetscInt        nonew = 0, nounused = 0; \
188:     PetscBool       roworiented = PETSC_FALSE; \
189:     if (oldvalues) { \
190:       nonew       = ((Mat_SeqAIJ *)(A)->data)->nonew; \
191:       nounused    = ((Mat_SeqAIJ *)(A)->data)->nounused; \
192:       roworiented = ((Mat_SeqAIJ *)(A)->data)->roworiented; \
193:     } \
194:     (void)0

196: #define MatSeqSBAIJGetOptions_Private(A) \
197:   { \
198:     PetscBool ignore_ltriangular = PETSC_FALSE, getrow_utriangular = PETSC_FALSE; \
199:     MatSeqXAIJGetOptions_Private(A); \
200:     if (oldvalues) { \
201:       ignore_ltriangular = ((Mat_SeqSBAIJ *)(A)->data)->ignore_ltriangular; \
202:       getrow_utriangular = ((Mat_SeqSBAIJ *)(A)->data)->getrow_utriangular; \
203:     } \
204:     (void)0

206: #define MatSeqXAIJRestoreOptions_Private(A) \
207:   if (oldvalues) { \
208:     ((Mat_SeqAIJ *)(A)->data)->nonew       = nonew; \
209:     ((Mat_SeqAIJ *)(A)->data)->nounused    = nounused; \
210:     ((Mat_SeqAIJ *)(A)->data)->roworiented = roworiented; \
211:   } \
212:   } \
213:   (void)0

215: #define MatSeqSBAIJRestoreOptions_Private(A) \
216:   if (oldvalues) { \
217:     ((Mat_SeqSBAIJ *)(A)->data)->ignore_ltriangular = ignore_ltriangular; \
218:     ((Mat_SeqSBAIJ *)(A)->data)->getrow_utriangular = getrow_utriangular; \
219:   } \
220:   MatSeqXAIJRestoreOptions_Private(A); \
221:   } \
222:   (void)0

224: static inline PetscErrorCode MatXAIJAllocatea(Mat A, PetscInt nz, PetscScalar **array)
225: {
226:   Mat_SeqAIJ *a = (Mat_SeqAIJ *)A->data;

228:   PetscFunctionBegin;
229:   PetscCall(PetscShmgetAllocateArray(nz, sizeof(PetscScalar), (void **)array));
230:   a->free_a = PETSC_TRUE;
231:   PetscFunctionReturn(PETSC_SUCCESS);
232: }

234: static inline PetscErrorCode MatXAIJDeallocatea(Mat A, PetscScalar **array)
235: {
236:   Mat_SeqAIJ *a = (Mat_SeqAIJ *)A->data;

238:   PetscFunctionBegin;
239:   if (a->free_a) PetscCall(PetscShmgetDeallocateArray((void **)array));
240:   a->free_a = PETSC_FALSE;
241:   PetscFunctionReturn(PETSC_SUCCESS);
242: }

244: /*
245:   Frees the a, i, and j arrays from the XAIJ (AIJ, BAIJ, and SBAIJ) matrix types
246: */
247: static inline PetscErrorCode MatSeqXAIJFreeAIJ(Mat AA, MatScalar **a, PetscInt **j, PetscInt **i)
248: {
249:   Mat_SeqAIJ *A = (Mat_SeqAIJ *)AA->data;

251:   PetscFunctionBegin;
252:   if (A->free_a) PetscCall(PetscShmgetDeallocateArray((void **)a));
253:   if (A->free_ij) PetscCall(PetscShmgetDeallocateArray((void **)j));
254:   if (A->free_ij) PetscCall(PetscShmgetDeallocateArray((void **)i));
255:   PetscFunctionReturn(PETSC_SUCCESS);
256: }
257: /*
258:     Allocates larger a, i, and j arrays for the XAIJ (AIJ, BAIJ, and SBAIJ) matrix types
259:     This is a macro because it takes the datatype as an argument which can be either a Mat or a MatScalar
260: */
261: #define MatSeqXAIJReallocateAIJ(Amat, AM, BS2, NROW, ROW, COL, RMAX, AA, AI, AJ, RP, AP, AIMAX, NONEW, datatype) \
262:   do { \
263:     if ((NROW) >= (RMAX)) { \
264:       Mat_SeqAIJ *Ain       = (Mat_SeqAIJ *)(Amat)->data; \
265:       PetscInt    CHUNKSIZE = 15, new_nz = (AI)[AM] + CHUNKSIZE, len, *new_i = NULL, *new_j = NULL; \
266:       datatype   *new_a; \
267: \
268:       PetscCheck((NONEW) != -2, PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "New nonzero at (%" PetscInt_FMT ",%" PetscInt_FMT ") caused a malloc. Use MatSetOption(A, MAT_NEW_NONZERO_ALLOCATION_ERR, PETSC_FALSE) to turn off this check", ROW, COL); \
269:       /* malloc new storage space */ \
270:       PetscCall(PetscShmgetAllocateArray((BS2) * new_nz, sizeof(PetscScalar), (void **)&new_a)); \
271:       PetscCall(PetscShmgetAllocateArray(new_nz, sizeof(PetscInt), (void **)&new_j)); \
272:       PetscCall(PetscShmgetAllocateArray((AM) + 1, sizeof(PetscInt), (void **)&new_i)); \
273:       Ain->free_a  = PETSC_TRUE; \
274:       Ain->free_ij = PETSC_TRUE; \
275:       /* copy over old data into new slots */ \
276:       for (ii = 0; ii < (ROW) + 1; ii++) new_i[ii] = (AI)[ii]; \
277:       for (ii = (ROW) + 1; ii < (AM) + 1; ii++) new_i[ii] = (AI)[ii] + CHUNKSIZE; \
278:       PetscCall(PetscArraycpy(new_j, AJ, (AI)[ROW] + (NROW))); \
279:       len = (new_nz - CHUNKSIZE - (AI)[ROW] - (NROW)); \
280:       PetscCall(PetscArraycpy(new_j + (AI)[ROW] + (NROW) + CHUNKSIZE, PetscSafePointerPlusOffset(AJ, (AI)[ROW] + (NROW)), len)); \
281:       PetscCall(PetscArraycpy(new_a, AA, (BS2) * ((AI)[ROW] + (NROW)))); \
282:       PetscCall(PetscArrayzero(new_a + (BS2) * ((AI)[ROW] + (NROW)), (BS2) * CHUNKSIZE)); \
283:       PetscCall(PetscArraycpy(new_a + (BS2) * ((AI)[ROW] + (NROW) + CHUNKSIZE), PetscSafePointerPlusOffset(AA, (BS2) * ((AI)[ROW] + (NROW))), (BS2) * len)); \
284:       /* free up old matrix storage */ \
285:       PetscCall(MatSeqXAIJFreeAIJ(A, &Ain->a, &Ain->j, &Ain->i)); \
286:       AA     = new_a; \
287:       Ain->a = new_a; \
288:       AI = Ain->i = new_i; \
289:       AJ = Ain->j = new_j; \
290: \
291:       RP   = (AJ) + (AI)[ROW]; \
292:       AP   = (AA) + (BS2) * (AI)[ROW]; \
293:       RMAX = (AIMAX)[ROW] = (AIMAX)[ROW] + CHUNKSIZE; \
294:       Ain->maxnz += (BS2) * CHUNKSIZE; \
295:       Ain->reallocs++; \
296:       (Amat)->nonzerostate++; \
297:     } \
298:   } while (0)

300: #define MatSeqXAIJReallocateAIJ_structure_only(Amat, AM, BS2, NROW, ROW, COL, RMAX, AI, AJ, RP, AIMAX, NONEW, datatype) \
301:   do { \
302:     if ((NROW) >= (RMAX)) { \
303:       Mat_SeqAIJ *Ain = (Mat_SeqAIJ *)(Amat)->data; \
304:       /* there is no extra room in row, therefore enlarge */ \
305:       PetscInt CHUNKSIZE = 15, new_nz = (AI)[AM] + CHUNKSIZE, len, *new_i = NULL, *new_j = NULL; \
306: \
307:       PetscCheck((NONEW) != -2, PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "New nonzero at (%" PetscInt_FMT ",%" PetscInt_FMT ") caused a malloc. Use MatSetOption(A, MAT_NEW_NONZERO_ALLOCATION_ERR, PETSC_FALSE) to turn off this check", ROW, COL); \
308:       /* malloc new storage space */ \
309:       PetscCall(PetscShmgetAllocateArray(new_nz, sizeof(PetscInt), (void **)&new_j)); \
310:       PetscCall(PetscShmgetAllocateArray((AM) + 1, sizeof(PetscInt), (void **)&new_i)); \
311:       Ain->free_a  = PETSC_FALSE; \
312:       Ain->free_ij = PETSC_TRUE; \
313: \
314:       /* copy over old data into new slots */ \
315:       for (ii = 0; ii < (ROW) + 1; ii++) new_i[ii] = (AI)[ii]; \
316:       for (ii = (ROW) + 1; ii < (AM) + 1; ii++) new_i[ii] = (AI)[ii] + CHUNKSIZE; \
317:       PetscCall(PetscArraycpy(new_j, AJ, (AI)[ROW] + (NROW))); \
318:       len = (new_nz - CHUNKSIZE - (AI)[ROW] - (NROW)); \
319:       PetscCall(PetscArraycpy(new_j + (AI)[ROW] + (NROW) + CHUNKSIZE, (AJ) + (AI)[ROW] + (NROW), len)); \
320: \
321:       /* free up old matrix storage */ \
322:       PetscCall(MatSeqXAIJFreeAIJ(A, &Ain->a, &Ain->j, &Ain->i)); \
323:       Ain->a = NULL; \
324:       AI = Ain->i = new_i; \
325:       AJ = Ain->j = new_j; \
326: \
327:       RP   = (AJ) + (AI)[ROW]; \
328:       RMAX = (AIMAX)[ROW] = (AIMAX)[ROW] + CHUNKSIZE; \
329:       Ain->maxnz += (BS2) * CHUNKSIZE; \
330:       Ain->reallocs++; \
331:       (Amat)->nonzerostate++; \
332:     } \
333:   } while (0)

335: PETSC_INTERN PetscErrorCode MatSeqAIJSetPreallocation_SeqAIJ(Mat, PetscInt, const PetscInt *);
336: PETSC_INTERN PetscErrorCode MatSetPreallocationCOO_SeqAIJ(Mat, PetscCount, PetscInt[], PetscInt[]);

338: PETSC_INTERN PetscErrorCode MatILUFactorSymbolic_SeqAIJ(Mat, Mat, IS, IS, const MatFactorInfo *);
339: PETSC_INTERN PetscErrorCode MatILUFactorSymbolic_SeqAIJ_ilu0(Mat, Mat, IS, IS, const MatFactorInfo *);

341: PETSC_INTERN PetscErrorCode MatICCFactorSymbolic_SeqAIJ(Mat, Mat, IS, const MatFactorInfo *);
342: PETSC_INTERN PetscErrorCode MatCholeskyFactorSymbolic_SeqAIJ(Mat, Mat, IS, const MatFactorInfo *);
343: PETSC_INTERN PetscErrorCode MatCholeskyFactorNumeric_SeqAIJ_inplace(Mat, Mat, const MatFactorInfo *);
344: PETSC_INTERN PetscErrorCode MatCholeskyFactorNumeric_SeqAIJ(Mat, Mat, const MatFactorInfo *);
345: PETSC_INTERN PetscErrorCode MatDuplicate_SeqAIJ(Mat, MatDuplicateOption, Mat *);
346: PETSC_INTERN PetscErrorCode MatCopy_SeqAIJ(Mat, Mat, MatStructure);
347: PETSC_EXTERN PetscErrorCode MatGetDiagonalMarkers_SeqAIJ(Mat, const PetscInt **, PetscBool *);
348: PETSC_INTERN PetscErrorCode MatFindZeroDiagonals_SeqAIJ_Private(Mat, PetscInt *, PetscInt **);

350: PETSC_INTERN PetscErrorCode MatMult_SeqAIJ(Mat, Vec, Vec);
351: PETSC_INTERN PetscErrorCode MatMult_SeqAIJ_Inode(Mat, Vec, Vec);
352: PETSC_INTERN PetscErrorCode MatMultAdd_SeqAIJ(Mat, Vec, Vec, Vec);
353: PETSC_INTERN PetscErrorCode MatMultAdd_SeqAIJ_Inode(Mat, Vec, Vec, Vec);
354: PETSC_INTERN PetscErrorCode MatMultTranspose_SeqAIJ(Mat, Vec, Vec);
355: PETSC_INTERN PetscErrorCode MatMultTransposeAdd_SeqAIJ(Mat, Vec, Vec, Vec);
356: PETSC_INTERN PetscErrorCode MatSOR_SeqAIJ(Mat, Vec, PetscReal, MatSORType, PetscReal, PetscInt, PetscInt, Vec);
357: PETSC_INTERN PetscErrorCode MatSOR_SeqAIJ_Inode(Mat, Vec, PetscReal, MatSORType, PetscReal, PetscInt, PetscInt, Vec);

359: PETSC_INTERN PetscErrorCode MatSetOption_SeqAIJ(Mat, MatOption, PetscBool);

361: PETSC_INTERN PetscErrorCode MatGetSymbolicTranspose_SeqAIJ(Mat, PetscInt *[], PetscInt *[]);
362: PETSC_INTERN PetscErrorCode MatRestoreSymbolicTranspose_SeqAIJ(Mat, PetscInt *[], PetscInt *[]);
363: PETSC_INTERN PetscErrorCode MatGetSymbolicTransposeReduced_SeqAIJ(Mat, PetscInt, PetscInt, PetscInt *[], PetscInt *[]);
364: PETSC_INTERN PetscErrorCode MatTransposeSymbolic_SeqAIJ(Mat, Mat *);
365: PETSC_INTERN PetscErrorCode MatTranspose_SeqAIJ(Mat, MatReuse, Mat *);

367: PETSC_INTERN PetscErrorCode MatToSymmetricIJ_SeqAIJ(PetscInt, PetscInt *, PetscInt *, PetscBool, PetscInt, PetscInt, PetscInt **, PetscInt **);
368: PETSC_INTERN PetscErrorCode MatLUFactorSymbolic_SeqAIJ(Mat, Mat, IS, IS, const MatFactorInfo *);
369: PETSC_INTERN PetscErrorCode MatLUFactorNumeric_SeqAIJ_inplace(Mat, Mat, const MatFactorInfo *);
370: PETSC_INTERN PetscErrorCode MatLUFactorNumeric_SeqAIJ(Mat, Mat, const MatFactorInfo *);
371: PETSC_INTERN PetscErrorCode MatLUFactorNumeric_SeqAIJ_InplaceWithPerm(Mat, Mat, const MatFactorInfo *);
372: PETSC_INTERN PetscErrorCode MatLUFactor_SeqAIJ(Mat, IS, IS, const MatFactorInfo *);
373: PETSC_INTERN PetscErrorCode MatSolve_SeqAIJ_inplace(Mat, Vec, Vec);
374: PETSC_INTERN PetscErrorCode MatSolve_SeqAIJ(Mat, Vec, Vec);
375: PETSC_INTERN PetscErrorCode MatSolve_SeqAIJ_Inode(Mat, Vec, Vec);
376: PETSC_INTERN PetscErrorCode MatSolve_SeqAIJ_NaturalOrdering(Mat, Vec, Vec);
377: PETSC_INTERN PetscErrorCode MatSolveAdd_SeqAIJ(Mat, Vec, Vec, Vec);
378: PETSC_INTERN PetscErrorCode MatSolveTranspose_SeqAIJ_inplace(Mat, Vec, Vec);
379: PETSC_INTERN PetscErrorCode MatSolveTranspose_SeqAIJ(Mat, Vec, Vec);
380: PETSC_INTERN PetscErrorCode MatSolveTransposeAdd_SeqAIJ_inplace(Mat, Vec, Vec, Vec);
381: PETSC_INTERN PetscErrorCode MatSolveTransposeAdd_SeqAIJ(Mat, Vec, Vec, Vec);
382: PETSC_INTERN PetscErrorCode MatMatSolve_SeqAIJ(Mat, Mat, Mat);
383: PETSC_INTERN PetscErrorCode MatMatSolveTranspose_SeqAIJ(Mat, Mat, Mat);
384: PETSC_INTERN PetscErrorCode MatEqual_SeqAIJ(Mat, Mat, PetscBool *);
385: PETSC_INTERN PetscErrorCode MatFDColoringCreate_SeqXAIJ(Mat, ISColoring, MatFDColoring);
386: PETSC_INTERN PetscErrorCode MatFDColoringSetUp_SeqXAIJ(Mat, ISColoring, MatFDColoring);
387: PETSC_INTERN PetscErrorCode MatFDColoringSetUpBlocked_AIJ_Private(Mat, MatFDColoring, PetscInt);
388: PETSC_INTERN PetscErrorCode MatLoad_AIJ_HDF5(Mat, PetscViewer);
389: PETSC_INTERN PetscErrorCode MatLoad_SeqAIJ_Binary(Mat, PetscViewer);
390: PETSC_INTERN PetscErrorCode MatLoad_SeqAIJ(Mat, PetscViewer);

392: #if PetscDefined(HAVE_HYPRE)
393: PETSC_INTERN PetscErrorCode MatProductSetFromOptions_Transpose_AIJ_AIJ(Mat);
394: #endif
395: PETSC_INTERN PetscErrorCode MatProductSetFromOptions_SeqAIJ(Mat);

397: PETSC_INTERN PetscErrorCode MatProductSymbolic_PtAP_SeqAIJ_SeqAIJ(Mat);
398: PETSC_INTERN PetscErrorCode MatProductSymbolic_RARt_SeqAIJ_SeqAIJ(Mat);

400: PETSC_INTERN PetscErrorCode MatMatMultSymbolic_SeqAIJ_SeqAIJ(Mat, Mat, PetscReal, Mat);
401: PETSC_INTERN PetscErrorCode MatMatMultSymbolic_SeqAIJ_SeqAIJ_Sorted(Mat, Mat, PetscReal, Mat);
402: PETSC_INTERN PetscErrorCode MatMatMultSymbolic_SeqDense_SeqAIJ(Mat, Mat, PetscReal, Mat);
403: PETSC_INTERN PetscErrorCode MatMatMultSymbolic_SeqAIJ_SeqAIJ_Scalable(Mat, Mat, PetscReal, Mat);
404: PETSC_INTERN PetscErrorCode MatMatMultSymbolic_SeqAIJ_SeqAIJ_Scalable_fast(Mat, Mat, PetscReal, Mat);
405: PETSC_INTERN PetscErrorCode MatMatMultSymbolic_SeqAIJ_SeqAIJ_Heap(Mat, Mat, PetscReal, Mat);
406: PETSC_INTERN PetscErrorCode MatMatMultSymbolic_SeqAIJ_SeqAIJ_BTHeap(Mat, Mat, PetscReal, Mat);
407: PETSC_INTERN PetscErrorCode MatMatMultSymbolic_SeqAIJ_SeqAIJ_RowMerge(Mat, Mat, PetscReal, Mat);
408: PETSC_INTERN PetscErrorCode MatMatMultSymbolic_SeqAIJ_SeqAIJ_LLCondensed(Mat, Mat, PetscReal, Mat);
409: #if PetscDefined(HAVE_HYPRE)
410: PETSC_INTERN PetscErrorCode MatMatMultSymbolic_AIJ_AIJ_wHYPRE(Mat, Mat, PetscReal, Mat);
411: #endif

413: PETSC_INTERN PetscErrorCode MatMatMultNumeric_SeqAIJ_SeqAIJ(Mat, Mat, Mat);
414: PETSC_INTERN PetscErrorCode MatMatMultNumeric_SeqAIJ_SeqAIJ_Sorted(Mat, Mat, Mat);

416: PETSC_INTERN PetscErrorCode MatMatMultNumeric_SeqDense_SeqAIJ(Mat, Mat, Mat);
417: PETSC_INTERN PetscErrorCode MatMatMultNumeric_SeqAIJ_SeqAIJ_Scalable(Mat, Mat, Mat);

419: PETSC_INTERN PetscErrorCode MatPtAPSymbolic_SeqAIJ_SeqAIJ_SparseAxpy(Mat, Mat, PetscReal, Mat);
420: PETSC_INTERN PetscErrorCode MatPtAPNumeric_SeqAIJ_SeqAIJ(Mat, Mat, Mat);
421: PETSC_INTERN PetscErrorCode MatPtAPNumeric_SeqAIJ_SeqAIJ_SparseAxpy(Mat, Mat, Mat);

423: PETSC_INTERN PetscErrorCode MatRARtSymbolic_SeqAIJ_SeqAIJ(Mat, Mat, PetscReal, Mat);
424: PETSC_INTERN PetscErrorCode MatRARtSymbolic_SeqAIJ_SeqAIJ_matmattransposemult(Mat, Mat, PetscReal, Mat);
425: PETSC_INTERN PetscErrorCode MatRARtSymbolic_SeqAIJ_SeqAIJ_colorrart(Mat, Mat, PetscReal, Mat);
426: PETSC_INTERN PetscErrorCode MatRARtNumeric_SeqAIJ_SeqAIJ(Mat, Mat, Mat);
427: PETSC_INTERN PetscErrorCode MatRARtNumeric_SeqAIJ_SeqAIJ_matmattransposemult(Mat, Mat, Mat);
428: PETSC_INTERN PetscErrorCode MatRARtNumeric_SeqAIJ_SeqAIJ_colorrart(Mat, Mat, Mat);

430: PETSC_INTERN PetscErrorCode MatTransposeMatMultSymbolic_SeqAIJ_SeqAIJ(Mat, Mat, PetscReal, Mat);
431: PETSC_INTERN PetscErrorCode MatTransposeMatMultNumeric_SeqAIJ_SeqAIJ(Mat, Mat, Mat);
432: PETSC_INTERN PetscErrorCode MatProductCtxDestroy_SeqAIJ_MatTransMatMult(PetscCtxRt);

434: PETSC_INTERN PetscErrorCode MatMatTransposeMultSymbolic_SeqAIJ_SeqAIJ(Mat, Mat, PetscReal, Mat);
435: PETSC_INTERN PetscErrorCode MatMatTransposeMultNumeric_SeqAIJ_SeqAIJ(Mat, Mat, Mat);
436: PETSC_INTERN PetscErrorCode MatTransposeColoringCreate_SeqAIJ(Mat, ISColoring, MatTransposeColoring);
437: PETSC_INTERN PetscErrorCode MatTransColoringApplySpToDen_SeqAIJ(MatTransposeColoring, Mat, Mat);
438: PETSC_INTERN PetscErrorCode MatTransColoringApplyDenToSp_SeqAIJ(MatTransposeColoring, Mat, Mat);

440: PETSC_INTERN PetscErrorCode MatMatMatMultSymbolic_SeqAIJ_SeqAIJ_SeqAIJ(Mat, Mat, Mat, PetscReal, Mat);
441: PETSC_INTERN PetscErrorCode MatMatMatMultNumeric_SeqAIJ_SeqAIJ_SeqAIJ(Mat, Mat, Mat, Mat);

443: PETSC_INTERN PetscErrorCode MatSetRandomSkipColumnRange_SeqAIJ_Private(Mat, PetscInt, PetscInt, PetscRandom);
444: PETSC_INTERN PetscErrorCode MatSetValues_SeqAIJ(Mat, PetscInt, const PetscInt[], PetscInt, const PetscInt[], const PetscScalar[], InsertMode);
445: PETSC_INTERN PetscErrorCode MatGetRow_SeqAIJ(Mat, PetscInt, PetscInt *, PetscInt **, PetscScalar **);
446: PETSC_INTERN PetscErrorCode MatRestoreRow_SeqAIJ(Mat, PetscInt, PetscInt *, PetscInt **, PetscScalar **);
447: PETSC_INTERN PetscErrorCode MatScale_SeqAIJ(Mat, PetscScalar);
448: PETSC_INTERN PetscErrorCode MatDiagonalScale_SeqAIJ(Mat, Vec, Vec);
449: PETSC_INTERN PetscErrorCode MatDiagonalSet_SeqAIJ(Mat, Vec, InsertMode);
450: PETSC_INTERN PetscErrorCode MatAXPY_SeqAIJ(Mat, PetscScalar, Mat, MatStructure);
451: PETSC_INTERN PetscErrorCode MatGetRowIJ_SeqAIJ(Mat, PetscInt, PetscBool, PetscBool, PetscInt *, const PetscInt *[], const PetscInt *[], PetscBool *);
452: PETSC_INTERN PetscErrorCode MatRestoreRowIJ_SeqAIJ(Mat, PetscInt, PetscBool, PetscBool, PetscInt *, const PetscInt *[], const PetscInt *[], PetscBool *);
453: PETSC_INTERN PetscErrorCode MatGetColumnIJ_SeqAIJ(Mat, PetscInt, PetscBool, PetscBool, PetscInt *, const PetscInt *[], const PetscInt *[], PetscBool *);
454: PETSC_INTERN PetscErrorCode MatRestoreColumnIJ_SeqAIJ(Mat, PetscInt, PetscBool, PetscBool, PetscInt *, const PetscInt *[], const PetscInt *[], PetscBool *);
455: PETSC_INTERN PetscErrorCode MatGetColumnIJ_SeqAIJ_Color(Mat, PetscInt, PetscBool, PetscBool, PetscInt *, const PetscInt *[], const PetscInt *[], PetscInt *[], PetscBool *);
456: PETSC_INTERN PetscErrorCode MatRestoreColumnIJ_SeqAIJ_Color(Mat, PetscInt, PetscBool, PetscBool, PetscInt *, const PetscInt *[], const PetscInt *[], PetscInt *[], PetscBool *);
457: PETSC_INTERN PetscErrorCode MatDestroy_SeqAIJ(Mat);
458: PETSC_INTERN PetscErrorCode MatView_SeqAIJ(Mat, PetscViewer);

460: PETSC_INTERN PetscErrorCode MatSeqAIJCheckInode(Mat);
461: PETSC_INTERN PetscErrorCode MatSeqAIJCheckInode_FactorLU(Mat);

463: PETSC_INTERN PetscErrorCode MatAXPYGetPreallocation_SeqAIJ(Mat, Mat, PetscInt *);

465: #if PetscDefined(HAVE_MATLAB)
466: PETSC_EXTERN PetscErrorCode MatlabEnginePut_SeqAIJ(PetscObject, void *);
467: PETSC_EXTERN PetscErrorCode MatlabEngineGet_SeqAIJ(PetscObject, void *);
468: #endif
469: PETSC_INTERN PetscErrorCode MatConvert_SeqAIJ_SeqSBAIJ(Mat, MatType, MatReuse, Mat *);
470: PETSC_INTERN PetscErrorCode MatConvert_SeqAIJ_SeqBAIJ(Mat, MatType, MatReuse, Mat *);
471: PETSC_INTERN PetscErrorCode MatConvert_SeqAIJ_SeqDense(Mat, MatType, MatReuse, Mat *);
472: PETSC_INTERN PetscErrorCode MatConvert_SeqAIJ_SeqAIJCRL(Mat, MatType, MatReuse, Mat *);
473: PETSC_INTERN PetscErrorCode MatConvert_SeqAIJ_Elemental(Mat, MatType, MatReuse, Mat *);
474: #if PetscDefined(HAVE_SCALAPACK)
475: PETSC_INTERN PetscErrorCode MatConvert_AIJ_ScaLAPACK(Mat, MatType, MatReuse, Mat *);
476: #endif
477: PETSC_INTERN PetscErrorCode MatConvert_AIJ_HYPRE(Mat, MatType, MatReuse, Mat *);
478: PETSC_INTERN PetscErrorCode MatConvert_SeqAIJ_SeqAIJPERM(Mat, MatType, MatReuse, Mat *);
479: PETSC_INTERN PetscErrorCode MatConvert_SeqAIJ_SeqAIJSELL(Mat, MatType, MatReuse, Mat *);
480: PETSC_INTERN PetscErrorCode MatConvert_SeqAIJ_SeqAIJMKL(Mat, MatType, MatReuse, Mat *);
481: PETSC_INTERN PetscErrorCode MatConvert_SeqAIJ_SeqAIJViennaCL(Mat, MatType, MatReuse, Mat *);
482: PETSC_INTERN PetscErrorCode MatReorderForNonzeroDiagonal_SeqAIJ(Mat, PetscReal, IS, IS);
483: PETSC_INTERN PetscErrorCode MatRARt_SeqAIJ_SeqAIJ(Mat, Mat, MatReuse, PetscReal, Mat *);
484: PETSC_EXTERN PetscErrorCode MatCreate_SeqAIJ(Mat);
485: PETSC_INTERN PetscErrorCode MatAssemblyEnd_SeqAIJ(Mat, MatAssemblyType);
486: PETSC_INTERN PetscErrorCode MatZeroEntries_SeqAIJ(Mat);

488: PETSC_INTERN PetscErrorCode MatAXPYGetPreallocation_SeqX_private(PetscInt, const PetscInt *, const PetscInt *, const PetscInt *, const PetscInt *, PetscInt *);
489: PETSC_INTERN PetscErrorCode MatCreateMPIMatConcatenateSeqMat_SeqAIJ(MPI_Comm, Mat, PetscInt, MatReuse, Mat *);
490: PETSC_INTERN PetscErrorCode MatCreateMPIMatConcatenateSeqMat_MPIAIJ(MPI_Comm, Mat, PetscInt, MatReuse, Mat *);

492: PETSC_INTERN PetscErrorCode MatSetSeqMat_SeqAIJ(Mat, IS, IS, MatStructure, Mat);
493: PETSC_INTERN PetscErrorCode MatEliminateZeros_SeqAIJ(Mat, PetscBool);
494: PETSC_INTERN PetscErrorCode MatDestroySubMatrix_Private(Mat_SubSppt *);
495: PETSC_INTERN PetscErrorCode MatDestroySubMatrix_SeqAIJ(Mat);
496: PETSC_INTERN PetscErrorCode MatDestroySubMatrix_Dummy(Mat);
497: PETSC_INTERN PetscErrorCode MatDestroySubMatrices_Dummy(PetscInt, Mat *[]);
498: PETSC_INTERN PetscErrorCode MatCreateSubMatrix_SeqAIJ(Mat, IS, IS, PetscInt, MatReuse, Mat *);

500: PETSC_INTERN PetscErrorCode MatSetSeqAIJWithArrays_private(MPI_Comm, PetscInt, PetscInt, PetscInt[], PetscInt[], PetscScalar[], MatType, Mat);

502: PETSC_INTERN PetscErrorCode MatResetPreallocation_SeqAIJ_Private(Mat A, PetscBool *memoryreset);

504: PETSC_SINGLE_LIBRARY_INTERN PetscErrorCode MatSeqAIJCompactOutExtraColumns_SeqAIJ(Mat, ISLocalToGlobalMapping *);

506: /*
507:     PetscSparseDenseMinusDot - The inner kernel of triangular solves and Gauss-Siedel smoothing. \sum_i xv[i] * r[xi[i]] for CSR storage

509:   Input Parameters:
510: +  nnz - the number of entries
511: .  r - the array of vector values
512: .  xv - the matrix values for the row
513: -  xi - the column indices of the nonzeros in the row

515:   Output Parameter:
516: .  sum - negative the sum of results

518:   PETSc compile flags:
519: +   PETSC_KERNEL_USE_UNROLL_4
520: -   PETSC_KERNEL_USE_UNROLL_2

522:   Developer Note:
523:     The macro changes sum but not other parameters

525: .seealso: `PetscSparseDensePlusDot()`
526: */
527: #if PetscDefined(KERNEL_USE_UNROLL_4)
528:   #define PetscSparseDenseMinusDot(sum, r, xv, xi, nnz) \
529:     do { \
530:       if ((nnz) > 0) { \
531:         PetscInt nnz2 = nnz, rem = (nnz) & 0x3; \
532:         switch (rem) { \
533:         case 3: \
534:           (sum) -= *(xv)++ * (r)[*(xi)++]; \
535:         case 2: \
536:           (sum) -= *(xv)++ * (r)[*(xi)++]; \
537:         case 1: \
538:           (sum) -= *(xv)++ * (r)[*(xi)++]; \
539:           nnz2 -= rem; \
540:         } \
541:         while (nnz2 > 0) { \
542:           (sum) -= (xv)[0] * (r)[(xi)[0]] + (xv)[1] * (r)[(xi)[1]] + (xv)[2] * (r)[(xi)[2]] + (xv)[3] * (r)[(xi)[3]]; \
543:           (xv) += 4; \
544:           (xi) += 4; \
545:           nnz2 -= 4; \
546:         } \
547:         (xv) -= nnz; \
548:         (xi) -= nnz; \
549:       } \
550:     } while (0)

552: #elif PetscDefined(KERNEL_USE_UNROLL_2)
553:   #define PetscSparseDenseMinusDot(sum, r, xv, xi, nnz) \
554:     do { \
555:       PetscInt __i, __i1, __i2; \
556:       for (__i = 0; __i < (nnz) - 1; __i += 2) { \
557:         __i1 = (xi)[__i]; \
558:         __i2 = (xi)[__i + 1]; \
559:         (sum) -= ((xv)[__i] * (r)[__i1] + (xv)[__i + 1] * (r)[__i2]); \
560:       } \
561:       if ((nnz) & 0x1) (sum) -= (xv)[__i] * (r)[(xi)[__i]]; \
562:     } while (0)

564: #else
565:   #define PetscSparseDenseMinusDot(sum, r, xv, xi, nnz) \
566:     do { \
567:       PetscInt __i; \
568:       for (__i = 0; __i < (nnz); __i++) (sum) -= (xv)[__i] * (r)[(xi)[__i]]; \
569:     } while (0)
570: #endif

572: /*
573:     PetscSparseDensePlusDot - The inner kernel of matrix-vector product \sum_i xv[i] * r[xi[i]] for CSR storage

575:   Input Parameters:
576: +  nnz - the number of entries
577: .  r - the array of vector values
578: .  xv - the matrix values for the row
579: -  xi - the column indices of the nonzeros in the row

581:   Output Parameter:
582: .  sum - the sum of results

584:   PETSc compile flags:
585: +   PETSC_KERNEL_USE_UNROLL_4
586: -   PETSC_KERNEL_USE_UNROLL_2

588:   Developer Note:
589:     The macro changes sum but not other parameters

591: .seealso: `PetscSparseDenseMinusDot()`
592: */
593: #if PetscDefined(KERNEL_USE_UNROLL_4)
594:   #define PetscSparseDensePlusDot(sum, r, xv, xi, nnz) \
595:     do { \
596:       if ((nnz) > 0) { \
597:         PetscInt nnz2 = nnz, rem = (nnz) & 0x3; \
598:         switch (rem) { \
599:         case 3: \
600:           (sum) += *(xv)++ * (r)[*(xi)++]; \
601:         case 2: \
602:           (sum) += *(xv)++ * (r)[*(xi)++]; \
603:         case 1: \
604:           (sum) += *(xv)++ * (r)[*(xi)++]; \
605:           nnz2 -= rem; \
606:         } \
607:         while (nnz2 > 0) { \
608:           (sum) += (xv)[0] * (r)[(xi)[0]] + (xv)[1] * (r)[(xi)[1]] + (xv)[2] * (r)[(xi)[2]] + (xv)[3] * (r)[(xi)[3]]; \
609:           (xv) += 4; \
610:           (xi) += 4; \
611:           nnz2 -= 4; \
612:         } \
613:         (xv) -= nnz; \
614:         (xi) -= nnz; \
615:       } \
616:     } while (0)

618: #elif PetscDefined(KERNEL_USE_UNROLL_2)
619:   #define PetscSparseDensePlusDot(sum, r, xv, xi, nnz) \
620:     do { \
621:       PetscInt __i, __i1, __i2; \
622:       for (__i = 0; __i < (nnz) - 1; __i += 2) { \
623:         __i1 = (xi)[__i]; \
624:         __i2 = (xi)[__i + 1]; \
625:         (sum) += ((xv)[__i] * (r)[__i1] + (xv)[__i + 1] * (r)[__i2]); \
626:       } \
627:       if ((nnz) & 0x1) (sum) += (xv)[__i] * (r)[(xi)[__i]]; \
628:     } while (0)

630: #elif !(defined(__GNUC__) && defined(_OPENMP)) && PetscDefined(USE_AVX512_KERNELS) && PetscDefined(HAVE_IMMINTRIN_H) && defined(__AVX512F__) && PetscDefined(USE_REAL_DOUBLE) && !PetscDefined(USE_COMPLEX) && !PetscDefined(USE_64BIT_INDICES) && !PetscDefined(SKIP_IMMINTRIN_H_CUDAWORKAROUND)
631:   #define PetscSparseDensePlusDot(sum, r, xv, xi, nnz) PetscSparseDensePlusDot_AVX512_Private(&(sum), (r), (xv), (xi), (nnz))

633: #else
634:   #define PetscSparseDensePlusDot(sum, r, xv, xi, nnz) \
635:     do { \
636:       PetscInt __i; \
637:       for (__i = 0; __i < (nnz); __i++) (sum) += (xv)[__i] * (r)[(xi)[__i]]; \
638:     } while (0)
639: #endif

641: #if PetscDefined(USE_AVX512_KERNELS) && PetscDefined(HAVE_IMMINTRIN_H) && defined(__AVX512F__) && PetscDefined(USE_REAL_DOUBLE) && !PetscDefined(USE_COMPLEX) && !PetscDefined(USE_64BIT_INDICES) && !PetscDefined(SKIP_IMMINTRIN_H_CUDAWORKAROUND)
642:   #include <immintrin.h>
643:   #if !defined(_MM_SCALE_8)
644:     #define _MM_SCALE_8 8
645:   #endif

647: static inline void PetscSparseDensePlusDot_AVX512_Private(PetscScalar *sum, const PetscScalar *x, const MatScalar *aa, const PetscInt *aj, PetscInt n)
648: {
649:   __m512d  vec_x, vec_y, vec_vals;
650:   __m256i  vec_idx;
651:   PetscInt j;

653:   vec_y = _mm512_setzero_pd();
654:   for (j = 0; j < (n >> 3); j++) {
655:     vec_idx  = _mm256_loadu_si256((__m256i const *)aj);
656:     vec_vals = _mm512_loadu_pd(aa);
657:     vec_x    = _mm512_i32gather_pd(vec_idx, x, _MM_SCALE_8);
658:     vec_y    = _mm512_fmadd_pd(vec_x, vec_vals, vec_y);
659:     aj += 8;
660:     aa += 8;
661:   }
662:   #if defined(__AVX512VL__)
663:   /* masked load requires avx512vl, which is not supported by KNL */
664:   if (n & 0x07) {
665:     __mmask8 mask;
666:     mask     = (__mmask8)(0xff >> (8 - (n & 0x07)));
667:     vec_idx  = _mm256_mask_loadu_epi32(vec_idx, mask, aj);
668:     vec_vals = _mm512_mask_loadu_pd(vec_vals, mask, aa);
669:     vec_x    = _mm512_mask_i32gather_pd(vec_x, mask, vec_idx, x, _MM_SCALE_8);
670:     vec_y    = _mm512_mask3_fmadd_pd(vec_x, vec_vals, vec_y, mask);
671:   }
672:   *sum += _mm512_reduce_add_pd(vec_y);
673:   #else
674:   *sum += _mm512_reduce_add_pd(vec_y);
675:   for (j = 0; j < (n & 0x07); j++) *sum += aa[j] * x[aj[j]];
676:   #endif
677: }
678: #endif

680: /*
681:     PetscSparseDenseMaxDot - The inner kernel of a modified matrix-vector product \max_i xv[i] * r[xi[i]] for CSR storage

683:   Input Parameters:
684: +  nnz - the number of entries
685: .  r - the array of vector values
686: .  xv - the matrix values for the row
687: -  xi - the column indices of the nonzeros in the row

689:   Output Parameter:
690: .  max - the max of results

692: .seealso: `PetscSparseDensePlusDot()`, `PetscSparseDenseMinusDot()`
693: */
694: #define PetscSparseDenseMaxDot(max, r, xv, xi, nnz) \
695:   do { \
696:     for (PetscInt __i = 0; __i < (nnz); __i++) max = PetscMax(PetscRealPart(max), PetscRealPart((xv)[__i] * (r)[(xi)[__i]])); \
697:   } while (0)

699: /*
700:  Add column indices into table for counting the max nonzeros of merged rows
701:  */
702: #define MatRowMergeMax_SeqAIJ(mat, nrows, ta) \
703:   do { \
704:     if (mat) { \
705:       for (PetscInt _row = 0; _row < (nrows); _row++) { \
706:         const PetscInt _nz = (mat)->i[_row + 1] - (mat)->i[_row]; \
707:         for (PetscInt _j = 0; _j < _nz; _j++) { \
708:           PetscInt *_col = _j + (mat)->j + (mat)->i[_row]; \
709:           PetscCall(PetscHMapISet((ta), *_col + 1, 1)); \
710:         } \
711:       } \
712:     } \
713:   } while (0)

715: /*
716:  Add column indices into table for counting the nonzeros of merged rows
717:  */
718: #define MatMergeRows_SeqAIJ(mat, nrows, rows, ta) \
719:   do { \
720:     for (PetscInt _i = 0; _i < (nrows); _i++) { \
721:       const PetscInt _row = (rows)[_i]; \
722:       const PetscInt _nz  = (mat)->i[_row + 1] - (mat)->i[_row]; \
723:       for (PetscInt _j = 0; _j < _nz; _j++) { \
724:         PetscInt *_col = _j + (mat)->j + (mat)->i[_row]; \
725:         PetscCall(PetscHMapISetWithMode((ta), *_col + 1, 1, INSERT_VALUES)); \
726:       } \
727:     } \
728:   } while (0)