Actual source code: aij.h

petsc-master 2020-03-31
Report Typos and Errors


  5:  #include <petsc/private/matimpl.h>
  6:  #include <petscctable.h>

  8: /*
  9:     Struct header shared by SeqAIJ, SeqBAIJ and SeqSBAIJ matrix formats
 10: */
 11: #define SEQAIJHEADER(datatype)        \
 12:   PetscBool roworiented;              /* if true, row-oriented input, default */ \
 13:   PetscInt  nonew;                    /* 1 don't add new nonzeros, -1 generate error on new */ \
 14:   PetscInt  nounused;                 /* -1 generate error on unused space */ \
 15:   PetscBool singlemalloc;             /* if true a, i, and j have been obtained with one big malloc */ \
 16:   PetscInt  maxnz;                    /* allocated nonzeros */ \
 17:   PetscInt  *imax;                    /* maximum space allocated for each row */ \
 18:   PetscInt  *ilen;                    /* actual length of each row */ \
 19:   PetscInt  *ipre;                    /* space preallocated for each row by user */ \
 20:   PetscBool free_imax_ilen;  \
 21:   PetscInt  reallocs;                 /* number of mallocs done during MatSetValues() \
 22:                                         as more values are set than were prealloced */\
 23:   PetscInt          rmax;             /* max nonzeros in any row */ \
 24:   PetscBool         keepnonzeropattern;   /* keeps matrix structure same in calls to MatZeroRows()*/ \
 25:   PetscBool         ignorezeroentries; \
 26:   PetscBool         free_ij;          /* free the column indices j and row offsets i when the matrix is destroyed */ \
 27:   PetscBool         free_a;           /* free the numerical values when matrix is destroy */ \
 28:   Mat_CompressedRow compressedrow;    /* use compressed row format */                      \
 29:   PetscInt          nz;               /* nonzeros */                                       \
 30:   PetscInt          *i;               /* pointer to beginning of each row */               \
 31:   PetscInt          *j;               /* column values: j + i[k] - 1 is start of row k */  \
 32:   PetscInt          *diag;            /* pointers to diagonal elements */                  \
 33:   PetscInt          nonzerorowcnt;    /* how many rows have nonzero entries */             \
 34:   PetscBool         free_diag;         \
 35:   datatype          *a;               /* nonzero elements */                               \
 36:   PetscScalar       *solve_work;      /* work space used in MatSolve */                    \
 37:   IS                row, col, icol;   /* index sets, used for reorderings */ \
 38:   PetscBool         pivotinblocks;    /* pivot inside factorization of each diagonal block */ \
 39:   Mat               parent;           /* set if this matrix was formed with MatDuplicate(...,MAT_SHARE_NONZERO_PATTERN,....); \
 40:                                          means that this shares some data structures with the parent including diag, ilen, imax, i, j */\
 41:   Mat_SubSppt       *submatis1         /* used by MatCreateSubMatrices_MPIXAIJ_Local */

 43: typedef struct {
 44:   MatTransposeColoring matcoloring;
 45:   Mat                  Bt_den;       /* dense matrix of B^T */
 46:   Mat                  ABt_den;      /* dense matrix of A*B^T */
 47:   PetscBool            usecoloring;
 48:   PetscErrorCode (*destroy)(Mat);
 49: } Mat_MatMatTransMult;

 51: typedef struct { /* used by MatTransposeMatMult() */
 52:   Mat          At;           /* transpose of the first matrix */
 53:   Mat          mA;           /* maij matrix of A */
 54:   Vec          bt,ct;        /* vectors to hold locally transposed arrays of B and C */
 55:   PetscBool    updateAt;     /* flg to avoid recomputing At in MatProductNumeric_AtB_SeqAIJ_SeqAIJ() */
 56:   PetscErrorCode (*destroy)(Mat);
 57: } Mat_MatTransMatMult;

 59: typedef struct {
 60:   PetscInt    *api,*apj;       /* symbolic structure of A*P */
 61:   PetscScalar *apa;            /* temporary array for storing one row of A*P */
 62:   PetscErrorCode (*destroy)(Mat);
 63: } Mat_AP;

 65: typedef struct {
 66:   MatTransposeColoring matcoloring;
 67:   Mat                  Rt;    /* sparse or dense matrix of R^T */
 68:   Mat                  RARt;  /* dense matrix of R*A*R^T */
 69:   Mat                  ARt;   /* A*R^T used for the case -matrart_color_art */
 70:   MatScalar            *work; /* work array to store columns of A*R^T used in MatMatMatMultNumeric_SeqAIJ_SeqAIJ_SeqDense() */
 71:   PetscErrorCode (*destroy)(Mat);
 72: } Mat_RARt;

 74: typedef struct {
 75:   Mat BC;               /* temp matrix for storing B*C */
 76:   PetscErrorCode (*destroy)(Mat);
 77: } Mat_MatMatMatMult;

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

 86: /* Info about i-nodes (identical nodes) helper class for SeqAIJ */
 87: typedef struct {
 88:   MatScalar        *bdiag,*ibdiag,*ssor_work;        /* diagonal blocks of matrix used for MatSOR_SeqAIJ_Inode() */
 89:   PetscInt         bdiagsize;                         /* length of bdiag and ibdiag */
 90:   PetscBool        ibdiagvalid;                       /* do ibdiag[] and bdiag[] contain the most recent values */

 92:   PetscBool        use;
 93:   PetscInt         node_count;                     /* number of inodes */
 94:   PetscInt         *size;                          /* size of each inode */
 95:   PetscInt         limit;                          /* inode limit */
 96:   PetscInt         max_limit;                      /* maximum supported inode limit */
 97:   PetscBool        checked;                        /* if inodes have been checked for */
 98:   PetscObjectState mat_nonzerostate;               /* non-zero state when inodes were checked for */
 99: } Mat_SeqAIJ_Inode;

101: PETSC_INTERN PetscErrorCode MatView_SeqAIJ_Inode(Mat,PetscViewer);
102: PETSC_INTERN PetscErrorCode MatAssemblyEnd_SeqAIJ_Inode(Mat,MatAssemblyType);
103: PETSC_INTERN PetscErrorCode MatDestroy_SeqAIJ_Inode(Mat);
104: PETSC_INTERN PetscErrorCode MatCreate_SeqAIJ_Inode(Mat);
105: PETSC_INTERN PetscErrorCode MatSetOption_SeqAIJ_Inode(Mat,MatOption,PetscBool);
106: PETSC_INTERN PetscErrorCode MatDuplicate_SeqAIJ_Inode(Mat,MatDuplicateOption,Mat*);
107: PETSC_INTERN PetscErrorCode MatDuplicateNoCreate_SeqAIJ(Mat,Mat,MatDuplicateOption,PetscBool);
108: PETSC_INTERN PetscErrorCode MatLUFactorNumeric_SeqAIJ_Inode_inplace(Mat,Mat,const MatFactorInfo*);
109: PETSC_INTERN PetscErrorCode MatLUFactorNumeric_SeqAIJ_Inode(Mat,Mat,const MatFactorInfo*);
110: PETSC_INTERN PetscErrorCode MatSeqAIJGetArray_SeqAIJ(Mat,PetscScalar**);
111: PETSC_INTERN PetscErrorCode MatSeqAIJRestoreArray_SeqAIJ(Mat,PetscScalar**);

113: typedef struct {
114:   SEQAIJHEADER(MatScalar);
115:   Mat_SeqAIJ_Inode inode;
116:   MatScalar        *saved_values;             /* location for stashing nonzero values of matrix */

118:   PetscScalar *idiag,*mdiag,*ssor_work;       /* inverse of diagonal entries, diagonal values and workspace for Eisenstat trick */
119:   PetscBool   idiagvalid;                     /* current idiag[] and mdiag[] are valid */
120:   PetscScalar *ibdiag;                        /* inverses of block diagonals */
121:   PetscBool   ibdiagvalid;                    /* inverses of block diagonals are valid. */
122:   PetscBool   diagonaldense;                  /* all entries along the diagonal have been set; i.e. no missing diagonal terms */
123:   PetscScalar fshift,omega;                   /* last used omega and fshift */

125:   ISColoring  coloring;                       /* set with MatADSetColoring() used by MatADSetValues() */

127:   PetscScalar         *matmult_abdense;    /* used by MatMatMult() */
128:   Mat_AP              *ap;                 /* used by MatPtAP() */
129:   Mat_MatMatMatMult   *matmatmatmult;      /* used by MatMatMatMult() */
130:   Mat_RARt            *rart;               /* used by MatRARt() */
131:   Mat_MatMatTransMult *abt;                /* used by MatMatTransposeMult() */
132:   Mat_MatTransMatMult *atb;                /* used by MatTransposeMatMult() */
133: } Mat_SeqAIJ;

135: /*
136:   Frees the a, i, and j arrays from the XAIJ (AIJ, BAIJ, and SBAIJ) matrix types
137: */
138: PETSC_STATIC_INLINE PetscErrorCode MatSeqXAIJFreeAIJ(Mat AA,MatScalar **a,PetscInt **j,PetscInt **i)
139: {
141:   Mat_SeqAIJ     *A = (Mat_SeqAIJ*) AA->data;
142:   if (A->singlemalloc) {
143:     PetscFree3(*a,*j,*i);
144:   } else {
145:     if (A->free_a)  {PetscFree(*a);}
146:     if (A->free_ij) {PetscFree(*j);}
147:     if (A->free_ij) {PetscFree(*i);}
148:   }
149:   return 0;
150: }
151: /*
152:     Allocates larger a, i, and j arrays for the XAIJ (AIJ, BAIJ, and SBAIJ) matrix types
153:     This is a macro because it takes the datatype as an argument which can be either a Mat or a MatScalar
154: */
155: #define MatSeqXAIJReallocateAIJ(Amat,AM,BS2,NROW,ROW,COL,RMAX,AA,AI,AJ,RP,AP,AIMAX,NONEW,datatype) \
156:   if (NROW >= RMAX) { \
157:     Mat_SeqAIJ *Ain = (Mat_SeqAIJ*)Amat->data; \
158:     /* there is no extra room in row, therefore enlarge */ \
159:     PetscInt CHUNKSIZE = 15,new_nz = AI[AM] + CHUNKSIZE,len,*new_i=0,*new_j=0; \
160:     datatype *new_a; \
161:  \
162:     if (NONEW == -2) SETERRQ2(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"New nonzero at (%D,%D) caused a malloc\nUse MatSetOption(A, MAT_NEW_NONZERO_ALLOCATION_ERR, PETSC_FALSE) to turn off this check",ROW,COL); \
163:     /* malloc new storage space */ \
164:     PetscMalloc3(BS2*new_nz,&new_a,new_nz,&new_j,AM+1,&new_i); \
165:  \
166:     /* copy over old data into new slots */ \
167:     for (ii=0; ii<ROW+1; ii++) {new_i[ii] = AI[ii];} \
168:     for (ii=ROW+1; ii<AM+1; ii++) {new_i[ii] = AI[ii]+CHUNKSIZE;} \
169:     PetscArraycpy(new_j,AJ,AI[ROW]+NROW); \
170:     len  = (new_nz - CHUNKSIZE - AI[ROW] - NROW); \
171:     PetscArraycpy(new_j+AI[ROW]+NROW+CHUNKSIZE,AJ+AI[ROW]+NROW,len); \
172:     PetscArraycpy(new_a,AA,BS2*(AI[ROW]+NROW));    \
173:     PetscArrayzero(new_a+BS2*(AI[ROW]+NROW),BS2*CHUNKSIZE); \
174:     PetscArraycpy(new_a+BS2*(AI[ROW]+NROW+CHUNKSIZE),AA+BS2*(AI[ROW]+NROW),BS2*len);  \
175:     /* free up old matrix storage */ \
176:     MatSeqXAIJFreeAIJ(A,&Ain->a,&Ain->j,&Ain->i); \
177:     AA                = new_a; \
178:     Ain->a            = (MatScalar*) new_a;                   \
179:     AI                = Ain->i = new_i; AJ = Ain->j = new_j;  \
180:     Ain->singlemalloc = PETSC_TRUE; \
181:  \
182:     RP          = AJ + AI[ROW]; AP = AA + BS2*AI[ROW]; \
183:     RMAX        = AIMAX[ROW] = AIMAX[ROW] + CHUNKSIZE; \
184:     Ain->maxnz += BS2*CHUNKSIZE; \
185:     Ain->reallocs++; \
186:   } \

188: #define MatSeqXAIJReallocateAIJ_structure_only(Amat,AM,BS2,NROW,ROW,COL,RMAX,AI,AJ,RP,AIMAX,NONEW,datatype) \
189:   if (NROW >= RMAX) { \
190:     Mat_SeqAIJ *Ain = (Mat_SeqAIJ*)Amat->data; \
191:     /* there is no extra room in row, therefore enlarge */ \
192:     PetscInt CHUNKSIZE = 15,new_nz = AI[AM] + CHUNKSIZE,len,*new_i=0,*new_j=0; \
193:  \
194:     if (NONEW == -2) SETERRQ2(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"New nonzero at (%D,%D) caused a malloc\nUse MatSetOption(A, MAT_NEW_NONZERO_ALLOCATION_ERR, PETSC_FALSE) to turn off this check",ROW,COL); \
195:     /* malloc new storage space */ \
196:     PetscMalloc1(new_nz,&new_j); \
197:     PetscMalloc1(AM+1,&new_i);\
198:  \
199:     /* copy over old data into new slots */ \
200:     for (ii=0; ii<ROW+1; ii++) {new_i[ii] = AI[ii];} \
201:     for (ii=ROW+1; ii<AM+1; ii++) {new_i[ii] = AI[ii]+CHUNKSIZE;} \
202:     PetscArraycpy(new_j,AJ,AI[ROW]+NROW); \
203:     len  = (new_nz - CHUNKSIZE - AI[ROW] - NROW); \
204:     PetscArraycpy(new_j+AI[ROW]+NROW+CHUNKSIZE,AJ+AI[ROW]+NROW,len); \
205:  \
206:     /* free up old matrix storage */ \
207:     MatSeqXAIJFreeAIJ(A,&Ain->a,&Ain->j,&Ain->i); \
208:     Ain->a            = NULL;                   \
209:     AI                = Ain->i = new_i; AJ = Ain->j = new_j;  \
210:     Ain->singlemalloc = PETSC_FALSE; \
211:     Ain->free_a       = PETSC_FALSE;             \
212:  \
213:     RP          = AJ + AI[ROW];    \
214:     RMAX        = AIMAX[ROW] = AIMAX[ROW] + CHUNKSIZE; \
215:     Ain->maxnz += BS2*CHUNKSIZE; \
216:     Ain->reallocs++; \
217:   } \

219: PETSC_INTERN PetscErrorCode MatSeqAIJSetPreallocation_SeqAIJ(Mat,PetscInt,const PetscInt*);
220: PETSC_INTERN PetscErrorCode MatILUFactorSymbolic_SeqAIJ_inplace(Mat,Mat,IS,IS,const MatFactorInfo*);
221: PETSC_INTERN PetscErrorCode MatILUFactorSymbolic_SeqAIJ(Mat,Mat,IS,IS,const MatFactorInfo*);
222: PETSC_INTERN PetscErrorCode MatILUFactorSymbolic_SeqAIJ_ilu0(Mat,Mat,IS,IS,const MatFactorInfo*);

224: PETSC_INTERN PetscErrorCode MatICCFactorSymbolic_SeqAIJ_inplace(Mat,Mat,IS,const MatFactorInfo*);
225: PETSC_INTERN PetscErrorCode MatICCFactorSymbolic_SeqAIJ(Mat,Mat,IS,const MatFactorInfo*);
226: PETSC_INTERN PetscErrorCode MatCholeskyFactorSymbolic_SeqAIJ_inplace(Mat,Mat,IS,const MatFactorInfo*);
227: PETSC_INTERN PetscErrorCode MatCholeskyFactorSymbolic_SeqAIJ(Mat,Mat,IS,const MatFactorInfo*);
228: PETSC_INTERN PetscErrorCode MatCholeskyFactorNumeric_SeqAIJ_inplace(Mat,Mat,const MatFactorInfo*);
229: PETSC_INTERN PetscErrorCode MatCholeskyFactorNumeric_SeqAIJ(Mat,Mat,const MatFactorInfo*);
230: PETSC_INTERN PetscErrorCode MatDuplicate_SeqAIJ(Mat,MatDuplicateOption,Mat*);
231: PETSC_INTERN PetscErrorCode MatCopy_SeqAIJ(Mat,Mat,MatStructure);
232: PETSC_INTERN PetscErrorCode MatMissingDiagonal_SeqAIJ(Mat,PetscBool*,PetscInt*);
233: PETSC_INTERN PetscErrorCode MatMarkDiagonal_SeqAIJ(Mat);
234: PETSC_INTERN PetscErrorCode MatFindZeroDiagonals_SeqAIJ_Private(Mat,PetscInt*,PetscInt**);

236: PETSC_INTERN PetscErrorCode MatMult_SeqAIJ(Mat A,Vec,Vec);
237: PETSC_INTERN PetscErrorCode MatMultAdd_SeqAIJ(Mat A,Vec,Vec,Vec);
238: PETSC_INTERN PetscErrorCode MatMultTranspose_SeqAIJ(Mat A,Vec,Vec);
239: PETSC_INTERN PetscErrorCode MatMultTransposeAdd_SeqAIJ(Mat A,Vec,Vec,Vec);
240: PETSC_INTERN PetscErrorCode MatSOR_SeqAIJ(Mat,Vec,PetscReal,MatSORType,PetscReal,PetscInt,PetscInt,Vec);

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

244: PETSC_INTERN PetscErrorCode MatGetSymbolicTranspose_SeqAIJ(Mat,PetscInt *[],PetscInt *[]);
245: PETSC_INTERN PetscErrorCode MatGetSymbolicTransposeReduced_SeqAIJ(Mat,PetscInt,PetscInt,PetscInt *[],PetscInt *[]);
246: PETSC_INTERN PetscErrorCode MatRestoreSymbolicTranspose_SeqAIJ(Mat,PetscInt *[],PetscInt *[]);
247: PETSC_INTERN PetscErrorCode MatTransposeSymbolic_SeqAIJ(Mat,Mat*);
248: PETSC_INTERN PetscErrorCode MatTranspose_SeqAIJ(Mat,MatReuse,Mat*);
249: PETSC_INTERN PetscErrorCode MatToSymmetricIJ_SeqAIJ(PetscInt,PetscInt*,PetscInt*,PetscBool,PetscInt,PetscInt,PetscInt**,PetscInt**);
250: PETSC_INTERN PetscErrorCode MatLUFactorSymbolic_SeqAIJ_inplace(Mat,Mat,IS,IS,const MatFactorInfo*);
251: PETSC_INTERN PetscErrorCode MatLUFactorSymbolic_SeqAIJ(Mat,Mat,IS,IS,const MatFactorInfo*);
252: PETSC_INTERN PetscErrorCode MatLUFactorNumeric_SeqAIJ_inplace(Mat,Mat,const MatFactorInfo*);
253: PETSC_INTERN PetscErrorCode MatLUFactorNumeric_SeqAIJ(Mat,Mat,const MatFactorInfo*);
254: PETSC_INTERN PetscErrorCode MatLUFactorNumeric_SeqAIJ_InplaceWithPerm(Mat,Mat,const MatFactorInfo*);
255: PETSC_INTERN PetscErrorCode MatLUFactor_SeqAIJ(Mat,IS,IS,const MatFactorInfo*);
256: PETSC_INTERN PetscErrorCode MatSolve_SeqAIJ_inplace(Mat,Vec,Vec);
257: PETSC_INTERN PetscErrorCode MatSolve_SeqAIJ(Mat,Vec,Vec);
258: PETSC_INTERN PetscErrorCode MatSolve_SeqAIJ_Inode_inplace(Mat,Vec,Vec);
259: PETSC_INTERN PetscErrorCode MatSolve_SeqAIJ_Inode(Mat,Vec,Vec);
260: PETSC_INTERN PetscErrorCode MatSolve_SeqAIJ_NaturalOrdering_inplace(Mat,Vec,Vec);
261: PETSC_INTERN PetscErrorCode MatSolve_SeqAIJ_NaturalOrdering(Mat,Vec,Vec);
262: PETSC_INTERN PetscErrorCode MatSolve_SeqAIJ_InplaceWithPerm(Mat,Vec,Vec);
263: PETSC_INTERN PetscErrorCode MatSolveAdd_SeqAIJ_inplace(Mat,Vec,Vec,Vec);
264: PETSC_INTERN PetscErrorCode MatSolveAdd_SeqAIJ(Mat,Vec,Vec,Vec);
265: PETSC_INTERN PetscErrorCode MatSolveTranspose_SeqAIJ_inplace(Mat,Vec,Vec);
266: PETSC_INTERN PetscErrorCode MatSolveTranspose_SeqAIJ(Mat,Vec,Vec);
267: PETSC_INTERN PetscErrorCode MatSolveTransposeAdd_SeqAIJ_inplace(Mat,Vec,Vec,Vec);
268: PETSC_INTERN PetscErrorCode MatSolveTransposeAdd_SeqAIJ(Mat,Vec,Vec,Vec);
269: PETSC_INTERN PetscErrorCode MatMatSolve_SeqAIJ_inplace(Mat,Mat,Mat);
270: PETSC_INTERN PetscErrorCode MatMatSolve_SeqAIJ(Mat,Mat,Mat);
271: PETSC_INTERN PetscErrorCode MatEqual_SeqAIJ(Mat,Mat,PetscBool*);
272: PETSC_INTERN PetscErrorCode MatFDColoringCreate_SeqXAIJ(Mat,ISColoring,MatFDColoring);
273: PETSC_INTERN PetscErrorCode MatFDColoringSetUp_SeqXAIJ(Mat,ISColoring,MatFDColoring);
274: PETSC_INTERN PetscErrorCode MatFDColoringSetUpBlocked_AIJ_Private(Mat,MatFDColoring,PetscInt);
275: PETSC_INTERN PetscErrorCode MatLoad_AIJ_HDF5(Mat,PetscViewer);
276: PETSC_INTERN PetscErrorCode MatLoad_SeqAIJ_Binary(Mat,PetscViewer);
277: PETSC_INTERN PetscErrorCode MatLoad_SeqAIJ(Mat,PetscViewer);
278: PETSC_INTERN PetscErrorCode RegisterApplyPtAPRoutines_Private(Mat);

280: #if defined(PETSC_HAVE_HYPRE)
281: PETSC_INTERN PetscErrorCode MatProductSetFromOptions_Transpose_AIJ_AIJ(Mat);
282: #endif
283: PETSC_INTERN PetscErrorCode MatProductSetFromOptions_SeqAIJ(Mat);

285: PETSC_INTERN PetscErrorCode MatProductSymbolic_SeqAIJ_SeqAIJ(Mat);
286: PETSC_INTERN PetscErrorCode MatProductSymbolic_PtAP_SeqAIJ_SeqAIJ(Mat);
287: PETSC_INTERN PetscErrorCode MatProductSymbolic_RARt_SeqAIJ_SeqAIJ(Mat);

289: PETSC_INTERN PetscErrorCode MatMatMultSymbolic_SeqAIJ_SeqAIJ(Mat,Mat,PetscReal,Mat);
290: PETSC_INTERN PetscErrorCode MatMatMultSymbolic_SeqAIJ_SeqAIJ_Sorted(Mat,Mat,PetscReal,Mat);
291: PETSC_INTERN PetscErrorCode MatMatMultSymbolic_SeqDense_SeqAIJ(Mat,Mat,PetscReal,Mat);
292: PETSC_INTERN PetscErrorCode MatMatMultSymbolic_SeqAIJ_SeqAIJ_Scalable(Mat,Mat,PetscReal,Mat);
293: PETSC_INTERN PetscErrorCode MatMatMultSymbolic_SeqAIJ_SeqAIJ_Scalable_fast(Mat,Mat,PetscReal,Mat);
294: PETSC_INTERN PetscErrorCode MatMatMultSymbolic_SeqAIJ_SeqAIJ_Heap(Mat,Mat,PetscReal,Mat);
295: PETSC_INTERN PetscErrorCode MatMatMultSymbolic_SeqAIJ_SeqAIJ_BTHeap(Mat,Mat,PetscReal,Mat);
296: PETSC_INTERN PetscErrorCode MatMatMultSymbolic_SeqAIJ_SeqAIJ_RowMerge(Mat,Mat,PetscReal,Mat);
297: PETSC_INTERN PetscErrorCode MatMatMultSymbolic_SeqAIJ_SeqAIJ_LLCondensed(Mat,Mat,PetscReal,Mat);
298: #if defined(PETSC_HAVE_HYPRE)
299: PETSC_INTERN PetscErrorCode MatMatMultSymbolic_AIJ_AIJ_wHYPRE(Mat,Mat,PetscReal,Mat);
300: #endif

302: PETSC_INTERN PetscErrorCode MatMatMultNumeric_SeqAIJ_SeqAIJ(Mat,Mat,Mat);
303: PETSC_INTERN PetscErrorCode MatMatMultNumeric_SeqAIJ_SeqAIJ_Sorted(Mat,Mat,Mat);

305: PETSC_INTERN PetscErrorCode MatMatMultNumeric_SeqDense_SeqAIJ(Mat,Mat,Mat);
306: PETSC_INTERN PetscErrorCode MatMatMultNumeric_SeqAIJ_SeqAIJ_Scalable(Mat,Mat,Mat);

308: PETSC_INTERN PetscErrorCode MatPtAPSymbolic_SeqAIJ_SeqAIJ_SparseAxpy(Mat,Mat,PetscReal,Mat);
309: PETSC_INTERN PetscErrorCode MatPtAPNumeric_SeqAIJ_SeqAIJ(Mat,Mat,Mat);
310: PETSC_INTERN PetscErrorCode MatPtAPNumeric_SeqAIJ_SeqAIJ_SparseAxpy(Mat,Mat,Mat);

312: PETSC_INTERN PetscErrorCode MatRARtSymbolic_SeqAIJ_SeqAIJ(Mat,Mat,PetscReal,Mat);
313: PETSC_INTERN PetscErrorCode MatRARtSymbolic_SeqAIJ_SeqAIJ_matmattransposemult(Mat,Mat,PetscReal,Mat);
314: PETSC_INTERN PetscErrorCode MatRARtSymbolic_SeqAIJ_SeqAIJ_colorrart(Mat,Mat,PetscReal,Mat);
315: PETSC_INTERN PetscErrorCode MatRARtNumeric_SeqAIJ_SeqAIJ(Mat,Mat,Mat);
316: PETSC_INTERN PetscErrorCode MatRARtNumeric_SeqAIJ_SeqAIJ_matmattransposemult(Mat,Mat,Mat);
317: PETSC_INTERN PetscErrorCode MatRARtNumeric_SeqAIJ_SeqAIJ_colorrart(Mat,Mat,Mat);

319: PETSC_INTERN PetscErrorCode MatTransposeMatMultSymbolic_SeqAIJ_SeqAIJ(Mat,Mat,PetscReal,Mat);
320: PETSC_INTERN PetscErrorCode MatTransposeMatMultNumeric_SeqAIJ_SeqAIJ(Mat,Mat,Mat);
321: PETSC_INTERN PetscErrorCode MatDestroy_SeqAIJ_MatTransMatMult(Mat);

323: PETSC_INTERN PetscErrorCode MatTransposeMatMultSymbolic_SeqAIJ_SeqDense(Mat,Mat,PetscReal,Mat);
324: PETSC_INTERN PetscErrorCode MatTransposeMatMultNumeric_SeqAIJ_SeqDense(Mat,Mat,Mat);

326: PETSC_INTERN PetscErrorCode MatMatTransposeMultSymbolic_SeqAIJ_SeqAIJ(Mat,Mat,PetscReal,Mat);
327: PETSC_INTERN PetscErrorCode MatMatTransposeMultNumeric_SeqAIJ_SeqAIJ(Mat,Mat,Mat);
328: PETSC_INTERN PetscErrorCode MatTransposeColoringCreate_SeqAIJ(Mat,ISColoring,MatTransposeColoring);
329: PETSC_INTERN PetscErrorCode MatTransColoringApplySpToDen_SeqAIJ(MatTransposeColoring,Mat,Mat);
330: PETSC_INTERN PetscErrorCode MatTransColoringApplyDenToSp_SeqAIJ(MatTransposeColoring,Mat,Mat);

332: PETSC_INTERN PetscErrorCode MatMatMatMultSymbolic_SeqAIJ_SeqAIJ_SeqAIJ(Mat,Mat,Mat,PetscReal,Mat);
333: PETSC_INTERN PetscErrorCode MatMatMatMultNumeric_SeqAIJ_SeqAIJ_SeqAIJ(Mat,Mat,Mat,Mat);

335: PETSC_INTERN PetscErrorCode MatSetRandomSkipColumnRange_SeqAIJ_Private(Mat,PetscInt,PetscInt,PetscRandom);
336: PETSC_INTERN PetscErrorCode MatSetValues_SeqAIJ(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],const PetscScalar[],InsertMode);
337: PETSC_INTERN PetscErrorCode MatGetRow_SeqAIJ(Mat,PetscInt,PetscInt*,PetscInt**,PetscScalar**);
338: PETSC_INTERN PetscErrorCode MatRestoreRow_SeqAIJ(Mat,PetscInt,PetscInt*,PetscInt**,PetscScalar**);
339: PETSC_INTERN PetscErrorCode MatScale_SeqAIJ(Mat,PetscScalar);
340: PETSC_INTERN PetscErrorCode MatDiagonalScale_SeqAIJ(Mat,Vec,Vec);
341: PETSC_INTERN PetscErrorCode MatDiagonalSet_SeqAIJ(Mat,Vec,InsertMode);
342: PETSC_INTERN PetscErrorCode MatAXPY_SeqAIJ(Mat,PetscScalar,Mat,MatStructure);
343: PETSC_INTERN PetscErrorCode MatGetRowIJ_SeqAIJ(Mat,PetscInt,PetscBool,PetscBool,PetscInt*,const PetscInt *[],const PetscInt *[],PetscBool*);
344: PETSC_INTERN PetscErrorCode MatRestoreRowIJ_SeqAIJ(Mat,PetscInt,PetscBool,PetscBool,PetscInt*,const PetscInt *[],const PetscInt *[],PetscBool*);
345: PETSC_INTERN PetscErrorCode MatGetColumnIJ_SeqAIJ(Mat,PetscInt,PetscBool,PetscBool,PetscInt*,const PetscInt *[],const PetscInt *[],PetscBool*);
346: PETSC_INTERN PetscErrorCode MatRestoreColumnIJ_SeqAIJ(Mat,PetscInt,PetscBool,PetscBool,PetscInt*,const PetscInt *[],const PetscInt *[],PetscBool*);
347: PETSC_INTERN PetscErrorCode MatGetColumnIJ_SeqAIJ_Color(Mat,PetscInt,PetscBool,PetscBool,PetscInt*,const PetscInt *[],const PetscInt *[],PetscInt *[],PetscBool*);
348: PETSC_INTERN PetscErrorCode MatRestoreColumnIJ_SeqAIJ_Color(Mat,PetscInt,PetscBool,PetscBool,PetscInt*,const PetscInt *[],const PetscInt *[],PetscInt *[],PetscBool*);
349: PETSC_INTERN PetscErrorCode MatDestroy_SeqAIJ(Mat);
350: PETSC_INTERN PetscErrorCode MatSetUp_SeqAIJ(Mat);
351: PETSC_INTERN PetscErrorCode MatView_SeqAIJ(Mat,PetscViewer);

353: PETSC_INTERN PetscErrorCode MatSeqAIJInvalidateDiagonal(Mat);
354: PETSC_INTERN PetscErrorCode MatSeqAIJInvalidateDiagonal_Inode(Mat);
355: PETSC_INTERN PetscErrorCode MatSeqAIJCheckInode(Mat);
356: PETSC_INTERN PetscErrorCode MatSeqAIJCheckInode_FactorLU(Mat);

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

360: #if defined(PETSC_HAVE_MATLAB_ENGINE)
361: PETSC_EXTERN PetscErrorCode MatlabEnginePut_SeqAIJ(PetscObject,void*);
362: PETSC_EXTERN PetscErrorCode MatlabEngineGet_SeqAIJ(PetscObject,void*);
363: #endif
364: PETSC_INTERN PetscErrorCode MatConvert_SeqAIJ_SeqSBAIJ(Mat,MatType,MatReuse,Mat*);
365: PETSC_INTERN PetscErrorCode MatConvert_SeqAIJ_SeqBAIJ(Mat,MatType,MatReuse,Mat*);
366: PETSC_INTERN PetscErrorCode MatConvert_SeqAIJ_SeqDense(Mat,MatType,MatReuse,Mat*);
367: PETSC_INTERN PetscErrorCode MatConvert_SeqAIJ_SeqAIJCRL(Mat,MatType,MatReuse,Mat*);
368: PETSC_INTERN PetscErrorCode MatConvert_SeqAIJ_Elemental(Mat,MatType,MatReuse,Mat*);
369: PETSC_INTERN PetscErrorCode MatConvert_AIJ_HYPRE(Mat,MatType,MatReuse,Mat*);
370: PETSC_INTERN PetscErrorCode MatConvert_SeqAIJ_SeqAIJPERM(Mat,MatType,MatReuse,Mat*);
371: PETSC_INTERN PetscErrorCode MatConvert_SeqAIJ_SeqAIJSELL(Mat,MatType,MatReuse,Mat*);
372: PETSC_INTERN PetscErrorCode MatConvert_SeqAIJ_SeqAIJMKL(Mat,MatType,MatReuse,Mat*);
373: PETSC_INTERN PetscErrorCode MatConvert_SeqAIJ_SeqAIJViennaCL(Mat,MatType,MatReuse,Mat*);
374: PETSC_INTERN PetscErrorCode MatReorderForNonzeroDiagonal_SeqAIJ(Mat,PetscReal,IS,IS);
375: PETSC_INTERN PetscErrorCode MatRARt_SeqAIJ_SeqAIJ(Mat,Mat,MatReuse,PetscReal,Mat*);
376: PETSC_EXTERN PetscErrorCode MatCreate_SeqAIJ(Mat);
377: PETSC_INTERN PetscErrorCode MatAssemblyEnd_SeqAIJ(Mat,MatAssemblyType);

379: PETSC_INTERN PetscErrorCode MatAXPYGetPreallocation_SeqX_private(PetscInt,const PetscInt*,const PetscInt*,const PetscInt*,const PetscInt*,PetscInt*);
380: PETSC_INTERN PetscErrorCode MatCreateMPIMatConcatenateSeqMat_SeqAIJ(MPI_Comm,Mat,PetscInt,MatReuse,Mat*);
381: PETSC_INTERN PetscErrorCode MatCreateMPIMatConcatenateSeqMat_MPIAIJ(MPI_Comm,Mat,PetscInt,MatReuse,Mat*);

383: PETSC_INTERN PetscErrorCode MatSetSeqMat_SeqAIJ(Mat,IS,IS,MatStructure,Mat);
384: PETSC_INTERN PetscErrorCode MatDestroySubMatrix_Private(Mat_SubSppt*);
385: PETSC_INTERN PetscErrorCode MatDestroySubMatrix_SeqAIJ(Mat);
386: PETSC_INTERN PetscErrorCode MatDestroySubMatrix_Dummy(Mat);
387: PETSC_INTERN PetscErrorCode MatDestroySubMatrices_Dummy(PetscInt, Mat*[]);
388: PETSC_INTERN PetscErrorCode MatCreateSubMatrix_SeqAIJ(Mat,IS,IS,PetscInt,MatReuse,Mat*);

390: PETSC_INTERN PetscErrorCode MatSeqAIJCompactOutExtraColumns_SeqAIJ(Mat,ISLocalToGlobalMapping*);
391: PETSC_INTERN PetscErrorCode MatSetSeqAIJWithArrays_private(MPI_Comm,PetscInt,PetscInt,PetscInt[],PetscInt[],PetscScalar[],Mat);

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

396:   Input Parameters:
397: +  nnz - the number of entries
398: .  r - the array of vector values
399: .  xv - the matrix values for the row
400: -  xi - the column indices of the nonzeros in the row

402:   Output Parameter:
403: .  sum - negative the sum of results

405:   PETSc compile flags:
406: +   PETSC_KERNEL_USE_UNROLL_4
407: -   PETSC_KERNEL_USE_UNROLL_2

409:   Developer Notes:
410:     The macro changes sum but not other parameters

412: .seealso: PetscSparseDensePlusDot()

414: */
415: #if defined(PETSC_KERNEL_USE_UNROLL_4)
416: #define PetscSparseDenseMinusDot(sum,r,xv,xi,nnz) { \
417:     if (nnz > 0) { \
418:       PetscInt nnz2=nnz,rem=nnz&0x3; \
419:       switch (rem) { \
420:       case 3: sum -= *xv++ *r[*xi++]; \
421:       case 2: sum -= *xv++ *r[*xi++]; \
422:       case 1: sum -= *xv++ *r[*xi++]; \
423:         nnz2      -= rem;} \
424:       while (nnz2 > 0) { \
425:         sum -=  xv[0] * r[xi[0]] + xv[1] * r[xi[1]] + \
426:                 xv[2] * r[xi[2]] + xv[3] * r[xi[3]]; \
427:         xv += 4; xi += 4; nnz2 -= 4; \
428:       } \
429:       xv -= nnz; xi -= nnz; \
430:     } \
431:   }

433: #elif defined(PETSC_KERNEL_USE_UNROLL_2)
434: #define PetscSparseDenseMinusDot(sum,r,xv,xi,nnz) { \
435:     PetscInt __i,__i1,__i2; \
436:     for (__i=0; __i<nnz-1; __i+=2) {__i1 = xi[__i]; __i2=xi[__i+1]; \
437:                                     sum -= (xv[__i]*r[__i1] + xv[__i+1]*r[__i2]);} \
438:     if (nnz & 0x1) sum -= xv[__i] * r[xi[__i]];}

440: #else
441: #define PetscSparseDenseMinusDot(sum,r,xv,xi,nnz) { \
442:     PetscInt __i; \
443:     for (__i=0; __i<nnz; __i++) sum -= xv[__i] * r[xi[__i]];}
444: #endif



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

451:   Input Parameters:
452: +  nnz - the number of entries
453: .  r - the array of vector values
454: .  xv - the matrix values for the row
455: -  xi - the column indices of the nonzeros in the row

457:   Output Parameter:
458: .  sum - the sum of results

460:   PETSc compile flags:
461: +   PETSC_KERNEL_USE_UNROLL_4
462: -   PETSC_KERNEL_USE_UNROLL_2

464:   Developer Notes:
465:     The macro changes sum but not other parameters

467: .seealso: PetscSparseDenseMinusDot()

469: */
470: #if defined(PETSC_KERNEL_USE_UNROLL_4)
471: #define PetscSparseDensePlusDot(sum,r,xv,xi,nnz) { \
472:     if (nnz > 0) { \
473:       PetscInt nnz2=nnz,rem=nnz&0x3; \
474:       switch (rem) { \
475:       case 3: sum += *xv++ *r[*xi++]; \
476:       case 2: sum += *xv++ *r[*xi++]; \
477:       case 1: sum += *xv++ *r[*xi++]; \
478:         nnz2      -= rem;} \
479:       while (nnz2 > 0) { \
480:         sum +=  xv[0] * r[xi[0]] + xv[1] * r[xi[1]] + \
481:                 xv[2] * r[xi[2]] + xv[3] * r[xi[3]]; \
482:         xv += 4; xi += 4; nnz2 -= 4; \
483:       } \
484:       xv -= nnz; xi -= nnz; \
485:     } \
486:   }

488: #elif defined(PETSC_KERNEL_USE_UNROLL_2)
489: #define PetscSparseDensePlusDot(sum,r,xv,xi,nnz) { \
490:     PetscInt __i,__i1,__i2; \
491:     for (__i=0; __i<nnz-1; __i+=2) {__i1 = xi[__i]; __i2=xi[__i+1]; \
492:                                     sum += (xv[__i]*r[__i1] + xv[__i+1]*r[__i2]);} \
493:     if (nnz & 0x1) sum += xv[__i] * r[xi[__i]];}

495: #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)
496: #define PetscSparseDensePlusDot(sum,r,xv,xi,nnz) PetscSparseDensePlusDot_AVX512_Private(&(sum),(r),(xv),(xi),(nnz))

498: #else
499: #define PetscSparseDensePlusDot(sum,r,xv,xi,nnz) { \
500:     PetscInt __i; \
501:     for (__i=0; __i<nnz; __i++) sum += xv[__i] * r[xi[__i]];}
502: #endif

504: #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)
505:   #include <immintrin.h>
506:   #if !defined(_MM_SCALE_8)
507:   #define _MM_SCALE_8    8
508:   #endif

510: PETSC_STATIC_INLINE void PetscSparseDensePlusDot_AVX512_Private(PetscScalar *sum,const PetscScalar *x,const MatScalar *aa,const PetscInt *aj,PetscInt n)
511: {
512:   __m512d  vec_x,vec_y,vec_vals;
513:   __m256i  vec_idx;
514:   __mmask8 mask;
515:   PetscInt j;

517:   vec_y = _mm512_setzero_pd();
518:   for (j=0; j<(n>>3); j++) {
519:     vec_idx  = _mm256_loadu_si256((__m256i const*)aj);
520:     vec_vals = _mm512_loadu_pd(aa);
521:     vec_x    = _mm512_i32gather_pd(vec_idx,x,_MM_SCALE_8);
522:     vec_y    = _mm512_fmadd_pd(vec_x,vec_vals,vec_y);
523:     aj += 8; aa += 8;
524:   }
525:   /* masked load does not work on KNL, it requires avx512vl */
526:   if ((n&0x07)>2) {
527:     mask     = (__mmask8)(0xff >> (8-(n&0x07)));
528:     vec_idx  = _mm256_loadu_si256((__m256i const*)aj);
529:     vec_vals = _mm512_loadu_pd(aa);
530:     vec_x    = _mm512_mask_i32gather_pd(vec_x,mask,vec_idx,x,_MM_SCALE_8);
531:     vec_y    = _mm512_mask3_fmadd_pd(vec_x,vec_vals,vec_y,mask);
532:   } else if ((n&0x07)==2) {
533:     *sum += aa[0]*x[aj[0]];
534:     *sum += aa[1]*x[aj[1]];
535:   } else if ((n&0x07)==1) {
536:     *sum += aa[0]*x[aj[0]];
537:   }
538:   if (n>2) *sum += _mm512_reduce_add_pd(vec_y);
539: /*
540:   for(j=0;j<(n&0x07);j++) *sum += aa[j]*x[aj[j]];
541: */
542: }
543: #endif

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

548:   Input Parameters:
549: +  nnz - the number of entries
550: .  r - the array of vector values
551: .  xv - the matrix values for the row
552: -  xi - the column indices of the nonzeros in the row

554:   Output Parameter:
555: .  max - the max of results

557: .seealso: PetscSparseDensePlusDot(), PetscSparseDenseMinusDot()

559: */
560: #define PetscSparseDenseMaxDot(max,r,xv,xi,nnz) { \
561:     PetscInt __i; \
562:     for (__i=0; __i<nnz; __i++) max = PetscMax(PetscRealPart(max), PetscRealPart(xv[__i] * r[xi[__i]]));}

564: /*
565:  Add column indices into table for counting the max nonzeros of merged rows
566:  */
567: #define MatRowMergeMax_SeqAIJ(mat,nrows,ta) {       \
568:     PetscInt _j,_row,_nz,*_col;                     \
569:     if (mat) { \
570:       for (_row=0; _row<nrows; _row++) {   \
571:         _nz = mat->i[_row+1] - mat->i[_row];    \
572:         for (_j=0; _j<_nz; _j++) {               \
573:           _col = _j + mat->j + mat->i[_row];       \
574:           PetscTableAdd(ta,*_col+1,1,INSERT_VALUES);                    \
575:         }                                                               \
576:       }                                                                 \
577:     }    \
578: }

580: /*
581:  Add column indices into table for counting the nonzeros of merged rows
582:  */
583: #define MatMergeRows_SeqAIJ(mat,nrows,rows,ta) {    \
584:   PetscInt _j,_row,_nz,*_col,_i;                      \
585:     for (_i=0; _i<nrows; _i++) {\
586:       _row = rows[_i]; \
587:       _nz = mat->i[_row+1] - mat->i[_row]; \
588:       for (_j=0; _j<_nz; _j++) {                \
589:         _col = _j + mat->j + mat->i[_row];       \
590:         PetscTableAdd(ta,*_col+1,1,INSERT_VALUES); \
591:       }                                                                 \
592:     }                                                                   \
593: }

595: #endif