Actual source code: matimpl.h

petsc-master 2021-02-25
Report Typos and Errors

  2: #ifndef __MATIMPL_H

  5: #include <petscmat.h>
  6: #include <petscmatcoarsen.h>
  7: #include <petsc/private/petscimpl.h>

  9: PETSC_EXTERN PetscBool MatRegisterAllCalled;
 10: PETSC_EXTERN PetscBool MatSeqAIJRegisterAllCalled;
 11: PETSC_EXTERN PetscBool MatOrderingRegisterAllCalled;
 12: PETSC_EXTERN PetscBool MatColoringRegisterAllCalled;
 13: PETSC_EXTERN PetscBool MatPartitioningRegisterAllCalled;
 14: PETSC_EXTERN PetscBool MatCoarsenRegisterAllCalled;
 15: PETSC_EXTERN PetscErrorCode MatRegisterAll(void);
 16: PETSC_EXTERN PetscErrorCode MatOrderingRegisterAll(void);
 17: PETSC_EXTERN PetscErrorCode MatColoringRegisterAll(void);
 18: PETSC_EXTERN PetscErrorCode MatPartitioningRegisterAll(void);
 19: PETSC_EXTERN PetscErrorCode MatCoarsenRegisterAll(void);
 20: PETSC_EXTERN PetscErrorCode MatSeqAIJRegisterAll(void);

 22: /*
 23:   This file defines the parts of the matrix data structure that are
 24:   shared by all matrix types.
 25: */

 27: /*
 28:     If you add entries here also add them to the MATOP enum
 29:     in include/petscmat.h and src/mat/f90-mod/petscmat.h
 30: */
 31: typedef struct _MatOps *MatOps;
 32: struct _MatOps {
 33:   /* 0*/
 34:   PetscErrorCode (*setvalues)(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],const PetscScalar[],InsertMode);
 35:   PetscErrorCode (*getrow)(Mat,PetscInt,PetscInt *,PetscInt*[],PetscScalar*[]);
 36:   PetscErrorCode (*restorerow)(Mat,PetscInt,PetscInt *,PetscInt *[],PetscScalar *[]);
 37:   PetscErrorCode (*mult)(Mat,Vec,Vec);
 38:   PetscErrorCode (*multadd)(Mat,Vec,Vec,Vec);
 39:   /* 5*/
 40:   PetscErrorCode (*multtranspose)(Mat,Vec,Vec);
 41:   PetscErrorCode (*multtransposeadd)(Mat,Vec,Vec,Vec);
 42:   PetscErrorCode (*solve)(Mat,Vec,Vec);
 43:   PetscErrorCode (*solveadd)(Mat,Vec,Vec,Vec);
 44:   PetscErrorCode (*solvetranspose)(Mat,Vec,Vec);
 45:   /*10*/
 46:   PetscErrorCode (*solvetransposeadd)(Mat,Vec,Vec,Vec);
 47:   PetscErrorCode (*lufactor)(Mat,IS,IS,const MatFactorInfo*);
 48:   PetscErrorCode (*choleskyfactor)(Mat,IS,const MatFactorInfo*);
 49:   PetscErrorCode (*sor)(Mat,Vec,PetscReal,MatSORType,PetscReal,PetscInt,PetscInt,Vec);
 50:   PetscErrorCode (*transpose)(Mat,MatReuse,Mat*);
 51:   /*15*/
 52:   PetscErrorCode (*getinfo)(Mat,MatInfoType,MatInfo*);
 53:   PetscErrorCode (*equal)(Mat,Mat,PetscBool*);
 54:   PetscErrorCode (*getdiagonal)(Mat,Vec);
 55:   PetscErrorCode (*diagonalscale)(Mat,Vec,Vec);
 56:   PetscErrorCode (*norm)(Mat,NormType,PetscReal*);
 57:   /*20*/
 58:   PetscErrorCode (*assemblybegin)(Mat,MatAssemblyType);
 59:   PetscErrorCode (*assemblyend)(Mat,MatAssemblyType);
 60:   PetscErrorCode (*setoption)(Mat,MatOption,PetscBool);
 61:   PetscErrorCode (*zeroentries)(Mat);
 62:   /*24*/
 63:   PetscErrorCode (*zerorows)(Mat,PetscInt,const PetscInt[],PetscScalar,Vec,Vec);
 64:   PetscErrorCode (*lufactorsymbolic)(Mat,Mat,IS,IS,const MatFactorInfo*);
 65:   PetscErrorCode (*lufactornumeric)(Mat,Mat,const MatFactorInfo*);
 66:   PetscErrorCode (*choleskyfactorsymbolic)(Mat,Mat,IS,const MatFactorInfo*);
 67:   PetscErrorCode (*choleskyfactornumeric)(Mat,Mat,const MatFactorInfo*);
 68:   /*29*/
 69:   PetscErrorCode (*setup)(Mat);
 70:   PetscErrorCode (*ilufactorsymbolic)(Mat,Mat,IS,IS,const MatFactorInfo*);
 71:   PetscErrorCode (*iccfactorsymbolic)(Mat,Mat,IS,const MatFactorInfo*);
 72:   PetscErrorCode (*getdiagonalblock)(Mat,Mat*);
 73:   PetscErrorCode (*setinf)(Mat);
 74:   /*34*/
 75:   PetscErrorCode (*duplicate)(Mat,MatDuplicateOption,Mat*);
 76:   PetscErrorCode (*forwardsolve)(Mat,Vec,Vec);
 77:   PetscErrorCode (*backwardsolve)(Mat,Vec,Vec);
 78:   PetscErrorCode (*ilufactor)(Mat,IS,IS,const MatFactorInfo*);
 79:   PetscErrorCode (*iccfactor)(Mat,IS,const MatFactorInfo*);
 80:   /*39*/
 81:   PetscErrorCode (*axpy)(Mat,PetscScalar,Mat,MatStructure);
 82:   PetscErrorCode (*createsubmatrices)(Mat,PetscInt,const IS[],const IS[],MatReuse,Mat *[]);
 83:   PetscErrorCode (*increaseoverlap)(Mat,PetscInt,IS[],PetscInt);
 84:   PetscErrorCode (*getvalues)(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],PetscScalar []);
 85:   PetscErrorCode (*copy)(Mat,Mat,MatStructure);
 86:   /*44*/
 87:   PetscErrorCode (*getrowmax)(Mat,Vec,PetscInt[]);
 88:   PetscErrorCode (*scale)(Mat,PetscScalar);
 89:   PetscErrorCode (*shift)(Mat,PetscScalar);
 90:   PetscErrorCode (*diagonalset)(Mat,Vec,InsertMode);
 91:   PetscErrorCode (*zerorowscolumns)(Mat,PetscInt,const PetscInt[],PetscScalar,Vec,Vec);
 92:   /*49*/
 93:   PetscErrorCode (*setrandom)(Mat,PetscRandom);
 94:   PetscErrorCode (*getrowij)(Mat,PetscInt,PetscBool ,PetscBool ,PetscInt*,const PetscInt *[],const PetscInt *[],PetscBool  *);
 95:   PetscErrorCode (*restorerowij)(Mat,PetscInt,PetscBool ,PetscBool ,PetscInt *,const PetscInt *[],const PetscInt *[],PetscBool  *);
 96:   PetscErrorCode (*getcolumnij)(Mat,PetscInt,PetscBool ,PetscBool ,PetscInt*,const PetscInt *[],const PetscInt *[],PetscBool  *);
 97:   PetscErrorCode (*restorecolumnij)(Mat,PetscInt,PetscBool ,PetscBool ,PetscInt*,const PetscInt *[],const PetscInt *[],PetscBool  *);
 98:   /*54*/
 99:   PetscErrorCode (*fdcoloringcreate)(Mat,ISColoring,MatFDColoring);
100:   PetscErrorCode (*coloringpatch)(Mat,PetscInt,PetscInt,ISColoringValue[],ISColoring*);
101:   PetscErrorCode (*setunfactored)(Mat);
102:   PetscErrorCode (*permute)(Mat,IS,IS,Mat*);
103:   PetscErrorCode (*setvaluesblocked)(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],const PetscScalar[],InsertMode);
104:   /*59*/
105:   PetscErrorCode (*createsubmatrix)(Mat,IS,IS,MatReuse,Mat*);
106:   PetscErrorCode (*destroy)(Mat);
107:   PetscErrorCode (*view)(Mat,PetscViewer);
108:   PetscErrorCode (*convertfrom)(Mat,MatType,MatReuse,Mat*);
109:   PetscErrorCode (*placeholder_63)(void);
110:   /*64*/
111:   PetscErrorCode (*matmatmultsymbolic)(Mat,Mat,Mat,PetscReal,Mat);
112:   PetscErrorCode (*matmatmultnumeric)(Mat,Mat,Mat,Mat);
113:   PetscErrorCode (*setlocaltoglobalmapping)(Mat,ISLocalToGlobalMapping,ISLocalToGlobalMapping);
114:   PetscErrorCode (*setvalueslocal)(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],const PetscScalar[],InsertMode);
115:   PetscErrorCode (*zerorowslocal)(Mat,PetscInt,const PetscInt[],PetscScalar,Vec,Vec);
116:   /*69*/
117:   PetscErrorCode (*getrowmaxabs)(Mat,Vec,PetscInt[]);
118:   PetscErrorCode (*getrowminabs)(Mat,Vec,PetscInt[]);
119:   PetscErrorCode (*convert)(Mat, MatType,MatReuse,Mat*);
120:   PetscErrorCode (*hasoperation)(Mat,MatOperation,PetscBool*);
121:   PetscErrorCode (*placeholder_73)(void);
122:   /*74*/
123:   PetscErrorCode (*setvaluesadifor)(Mat,PetscInt,void*);
124:   PetscErrorCode (*fdcoloringapply)(Mat,MatFDColoring,Vec,void*);
125:   PetscErrorCode (*setfromoptions)(PetscOptionItems*,Mat);
126:   PetscErrorCode (*multconstrained)(Mat,Vec,Vec);
127:   PetscErrorCode (*multtransposeconstrained)(Mat,Vec,Vec);
128:   /*79*/
129:   PetscErrorCode (*findzerodiagonals)(Mat,IS*);
130:   PetscErrorCode (*mults)(Mat,Vecs,Vecs);
131:   PetscErrorCode (*solves)(Mat,Vecs,Vecs);
132:   PetscErrorCode (*getinertia)(Mat,PetscInt*,PetscInt*,PetscInt*);
133:   PetscErrorCode (*load)(Mat,PetscViewer);
134:   /*84*/
135:   PetscErrorCode (*issymmetric)(Mat,PetscReal,PetscBool*);
136:   PetscErrorCode (*ishermitian)(Mat,PetscReal,PetscBool*);
137:   PetscErrorCode (*isstructurallysymmetric)(Mat,PetscBool *);
138:   PetscErrorCode (*setvaluesblockedlocal)(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],const PetscScalar[],InsertMode);
139:   PetscErrorCode (*getvecs)(Mat,Vec*,Vec*);
140:   /*89*/
141:   PetscErrorCode (*placeholder_89)(void);
142:   PetscErrorCode (*matmultsymbolic)(Mat,Mat,PetscReal,Mat);
143:   PetscErrorCode (*matmultnumeric)(Mat,Mat,Mat);
144:   PetscErrorCode (*placeholder_92)(void);
145:   PetscErrorCode (*ptapsymbolic)(Mat,Mat,PetscReal,Mat); /* double dispatch wrapper routine */
146:   /*94*/
147:   PetscErrorCode (*ptapnumeric)(Mat,Mat,Mat);            /* double dispatch wrapper routine */
148:   PetscErrorCode (*placeholder_95)(void);
149:   PetscErrorCode (*mattransposemultsymbolic)(Mat,Mat,PetscReal,Mat);
150:   PetscErrorCode (*mattransposemultnumeric)(Mat,Mat,Mat);
151:   PetscErrorCode (*bindtocpu)(Mat,PetscBool);
152:   /*99*/
153:   PetscErrorCode (*productsetfromoptions)(Mat);
154:   PetscErrorCode (*productsymbolic)(Mat);
155:   PetscErrorCode (*productnumeric)(Mat);
156:   PetscErrorCode (*conjugate)(Mat);                              /* complex conjugate */
157:   PetscErrorCode (*viewnative)(Mat,PetscViewer);
158:   /*104*/
159:   PetscErrorCode (*setvaluesrow)(Mat,PetscInt,const PetscScalar[]);
160:   PetscErrorCode (*realpart)(Mat);
161:   PetscErrorCode (*imaginarypart)(Mat);
162:   PetscErrorCode (*getrowuppertriangular)(Mat);
163:   PetscErrorCode (*restorerowuppertriangular)(Mat);
164:   /*109*/
165:   PetscErrorCode (*matsolve)(Mat,Mat,Mat);
166:   PetscErrorCode (*matsolvetranspose)(Mat,Mat,Mat);
167:   PetscErrorCode (*getrowmin)(Mat,Vec,PetscInt[]);
168:   PetscErrorCode (*getcolumnvector)(Mat,Vec,PetscInt);
169:   PetscErrorCode (*missingdiagonal)(Mat,PetscBool *,PetscInt*);
170:   /*114*/
171:   PetscErrorCode (*getseqnonzerostructure)(Mat,Mat *);
172:   PetscErrorCode (*create)(Mat);
173:   PetscErrorCode (*getghosts)(Mat,PetscInt*,const PetscInt *[]);
174:   PetscErrorCode (*getlocalsubmatrix)(Mat,IS,IS,Mat*);
175:   PetscErrorCode (*restorelocalsubmatrix)(Mat,IS,IS,Mat*);
176:   /*119*/
177:   PetscErrorCode (*multdiagonalblock)(Mat,Vec,Vec);
178:   PetscErrorCode (*hermitiantranspose)(Mat,MatReuse,Mat*);
179:   PetscErrorCode (*multhermitiantranspose)(Mat,Vec,Vec);
180:   PetscErrorCode (*multhermitiantransposeadd)(Mat,Vec,Vec,Vec);
181:   PetscErrorCode (*getmultiprocblock)(Mat,MPI_Comm,MatReuse,Mat*);
182:   /*124*/
183:   PetscErrorCode (*findnonzerorows)(Mat,IS*);
184:   PetscErrorCode (*getcolumnnorms)(Mat,NormType,PetscReal*);
185:   PetscErrorCode (*invertblockdiagonal)(Mat,const PetscScalar**);
186:   PetscErrorCode (*invertvariableblockdiagonal)(Mat,PetscInt,const PetscInt*,PetscScalar*);
187:   PetscErrorCode (*createsubmatricesmpi)(Mat,PetscInt,const IS[], const IS[], MatReuse, Mat**);
188:   /*129*/
189:   PetscErrorCode (*setvaluesbatch)(Mat,PetscInt,PetscInt,PetscInt*,const PetscScalar*);
190:   PetscErrorCode (*placeholder_130)(void);
191:   PetscErrorCode (*transposematmultsymbolic)(Mat,Mat,PetscReal,Mat);
192:   PetscErrorCode (*transposematmultnumeric)(Mat,Mat,Mat);
193:   PetscErrorCode (*transposecoloringcreate)(Mat,ISColoring,MatTransposeColoring);
194:   /*134*/
195:   PetscErrorCode (*transcoloringapplysptoden)(MatTransposeColoring,Mat,Mat);
196:   PetscErrorCode (*transcoloringapplydentosp)(MatTransposeColoring,Mat,Mat);
197:   PetscErrorCode (*placeholder_136)(void);
198:   PetscErrorCode (*rartsymbolic)(Mat,Mat,PetscReal,Mat); /* double dispatch wrapper routine */
199:   PetscErrorCode (*rartnumeric)(Mat,Mat,Mat);            /* double dispatch wrapper routine */
200:   /*139*/
201:   PetscErrorCode (*setblocksizes)(Mat,PetscInt,PetscInt);
202:   PetscErrorCode (*aypx)(Mat,PetscScalar,Mat,MatStructure);
203:   PetscErrorCode (*residual)(Mat,Vec,Vec,Vec);
204:   PetscErrorCode (*fdcoloringsetup)(Mat,ISColoring,MatFDColoring);
205:   PetscErrorCode (*findoffblockdiagonalentries)(Mat,IS*);
206:   PetscErrorCode (*creatempimatconcatenateseqmat)(MPI_Comm,Mat,PetscInt,MatReuse,Mat*);
207:   /*145*/
208:   PetscErrorCode (*destroysubmatrices)(PetscInt,Mat*[]);
209:   PetscErrorCode (*mattransposesolve)(Mat,Mat,Mat);
210:   PetscErrorCode (*getvalueslocal)(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],PetscScalar[]);
211: };
212: /*
213:     If you add MatOps entries above also add them to the MATOP enum
214:     in include/petscmat.h and src/mat/f90-mod/petscmat.h
215: */

217: #include <petscsys.h>
218: PETSC_EXTERN PetscErrorCode MatRegisterOp(MPI_Comm, const char[], PetscVoidFunction, const char[], PetscInt, ...);
219: PETSC_EXTERN PetscErrorCode MatQueryOp(MPI_Comm, PetscVoidFunction*, const char[], PetscInt, ...);

221: typedef struct _p_MatRootName* MatRootName;
222: struct _p_MatRootName {
223:   char        *rname,*sname,*mname;
224:   MatRootName next;
225: };

227: PETSC_EXTERN MatRootName MatRootNameList;

229: /*
230:    Utility private matrix routines
231: */
232: PETSC_INTERN PetscErrorCode MatFindNonzeroRowsOrCols_Basic(Mat,PetscBool,PetscReal,IS*);
233: PETSC_INTERN PetscErrorCode MatConvert_Basic(Mat,MatType,MatReuse,Mat*);
234: PETSC_INTERN PetscErrorCode MatConvert_Shell(Mat,MatType,MatReuse,Mat*);
235: PETSC_INTERN PetscErrorCode MatConvertFrom_Shell(Mat,MatType,MatReuse,Mat*);
236: PETSC_INTERN PetscErrorCode MatCopy_Basic(Mat,Mat,MatStructure);
237: PETSC_INTERN PetscErrorCode MatDiagonalSet_Default(Mat,Vec,InsertMode);
238: #if defined(PETSC_HAVE_SCALAPACK)
239: PETSC_INTERN PetscErrorCode MatConvert_Dense_ScaLAPACK(Mat,MatType,MatReuse,Mat*);
240: #endif
241: PETSC_INTERN PetscErrorCode MatSetPreallocationCOO_Basic(Mat,PetscInt,const PetscInt[],const PetscInt[]);
242: PETSC_INTERN PetscErrorCode MatSetValuesCOO_Basic(Mat,const PetscScalar[],InsertMode);

244: /* these callbacks rely on the old matrix function pointers for
245:    matmat operations. They are unsafe, and should be removed.
246:    However, the amount of work needed to clean up all the
247:    implementations is not negligible */
248: PETSC_INTERN PetscErrorCode MatProductSymbolic_AB(Mat);
249: PETSC_INTERN PetscErrorCode MatProductNumeric_AB(Mat);
250: PETSC_INTERN PetscErrorCode MatProductSymbolic_AtB(Mat);
251: PETSC_INTERN PetscErrorCode MatProductNumeric_AtB(Mat);
252: PETSC_INTERN PetscErrorCode MatProductSymbolic_ABt(Mat);
253: PETSC_INTERN PetscErrorCode MatProductNumeric_ABt(Mat);
254: PETSC_INTERN PetscErrorCode MatProductNumeric_PtAP(Mat);
255: PETSC_INTERN PetscErrorCode MatProductNumeric_RARt(Mat);
256: PETSC_INTERN PetscErrorCode MatProductSymbolic_ABC(Mat);
257: PETSC_INTERN PetscErrorCode MatProductNumeric_ABC(Mat);

259: PETSC_INTERN PetscErrorCode MatProductCreate_Private(Mat,Mat,Mat,Mat);
260: /* this callback handles all the different triple products and
261:    does not rely on the function pointers; used by cuSPARSE and KOKKOS-KERNELS */
262: PETSC_INTERN PetscErrorCode MatProductSymbolic_ABC_Basic(Mat);


265: #if defined(PETSC_USE_DEBUG)
266: #  define MatCheckPreallocated(A,arg) do {                              \
267:     if (PetscUnlikely(!(A)->preallocated)) SETERRQ3(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Must call MatXXXSetPreallocation() or MatSetUp() on argument %D \"%s\" before %s()",(arg),#A,PETSC_FUNCTION_NAME); \
268:   } while (0)
269: #else
270: #  define MatCheckPreallocated(A,arg) do {} while (0)
271: #endif

273: #if defined(PETSC_USE_DEBUG)
274: #  define MatCheckProduct(A,arg) do {                              \
275:     if (PetscUnlikely(!(A)->product)) SETERRQ2(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Argument %D \"%s\" is not a matrix obtained from MatProductCreate()",(arg),#A); \
276:   } while (0)
277: #else
278: #  define MatCheckProduct(A,arg) do {} while (0)
279: #endif

281: /*
282:   The stash is used to temporarily store inserted matrix values that
283:   belong to another processor. During the assembly phase the stashed
284:   values are moved to the correct processor and
285: */

287: typedef struct _MatStashSpace *PetscMatStashSpace;

289: struct _MatStashSpace {
290:   PetscMatStashSpace next;
291:   PetscScalar        *space_head,*val;
292:   PetscInt           *idx,*idy;
293:   PetscInt           total_space_size;
294:   PetscInt           local_used;
295:   PetscInt           local_remaining;
296: };

298: PETSC_EXTERN PetscErrorCode PetscMatStashSpaceGet(PetscInt,PetscInt,PetscMatStashSpace *);
299: PETSC_EXTERN PetscErrorCode PetscMatStashSpaceContiguous(PetscInt,PetscMatStashSpace *,PetscScalar *,PetscInt *,PetscInt *);
300: PETSC_EXTERN PetscErrorCode PetscMatStashSpaceDestroy(PetscMatStashSpace*);

302: typedef struct {
303:   PetscInt    count;
304: } MatStashHeader;

306: typedef struct {
307:   void        *buffer;          /* Of type blocktype, dynamically constructed  */
308:   PetscInt    count;
309:   char        pending;
310: } MatStashFrame;

312: typedef struct _MatStash MatStash;
313: struct _MatStash {
314:   PetscInt      nmax;                   /* maximum stash size */
315:   PetscInt      umax;                   /* user specified max-size */
316:   PetscInt      oldnmax;                /* the nmax value used previously */
317:   PetscInt      n;                      /* stash size */
318:   PetscInt      bs;                     /* block size of the stash */
319:   PetscInt      reallocs;               /* preserve the no of mallocs invoked */
320:   PetscMatStashSpace space_head,space;  /* linked list to hold stashed global row/column numbers and matrix values */

322:   PetscErrorCode (*ScatterBegin)(Mat,MatStash*,PetscInt*);
323:   PetscErrorCode (*ScatterGetMesg)(MatStash*,PetscMPIInt*,PetscInt**,PetscInt**,PetscScalar**,PetscInt*);
324:   PetscErrorCode (*ScatterEnd)(MatStash*);
325:   PetscErrorCode (*ScatterDestroy)(MatStash*);

327:   /* The following variables are used for communication */
328:   MPI_Comm      comm;
329:   PetscMPIInt   size,rank;
330:   PetscMPIInt   tag1,tag2;
331:   MPI_Request   *send_waits;            /* array of send requests */
332:   MPI_Request   *recv_waits;            /* array of receive requests */
333:   MPI_Status    *send_status;           /* array of send status */
334:   PetscInt      nsends,nrecvs;          /* numbers of sends and receives */
335:   PetscScalar   *svalues;               /* sending data */
336:   PetscInt      *sindices;
337:   PetscScalar   **rvalues;              /* receiving data (values) */
338:   PetscInt      **rindices;             /* receiving data (indices) */
339:   PetscInt      nprocessed;             /* number of messages already processed */
340:   PetscMPIInt   *flg_v;                 /* indicates what messages have arrived so far and from whom */
341:   PetscBool     reproduce;
342:   PetscInt      reproduce_count;

344:   /* The following variables are used for BTS communication */
345:   PetscBool      first_assembly_done;   /* Is the first time matrix assembly done? */
346:   PetscBool      use_status;            /* Use MPI_Status to determine number of items in each message */
347:   PetscMPIInt    nsendranks;
348:   PetscMPIInt    nrecvranks;
349:   PetscMPIInt    *sendranks;
350:   PetscMPIInt    *recvranks;
351:   MatStashHeader *sendhdr,*recvhdr;
352:   MatStashFrame  *sendframes;   /* pointers to the main messages */
353:   MatStashFrame  *recvframes;
354:   MatStashFrame  *recvframe_active;
355:   PetscInt       recvframe_i;     /* index of block within active frame */
356:   PetscMPIInt    recvframe_count; /* Count actually sent for current frame */
357:   PetscInt       recvcount;       /* Number of receives processed so far */
358:   PetscMPIInt    *some_indices;   /* From last call to MPI_Waitsome */
359:   MPI_Status     *some_statuses;  /* Statuses from last call to MPI_Waitsome */
360:   PetscMPIInt    some_count;      /* Number of requests completed in last call to MPI_Waitsome */
361:   PetscMPIInt    some_i;          /* Index of request currently being processed */
362:   MPI_Request    *sendreqs;
363:   MPI_Request    *recvreqs;
364:   PetscSegBuffer segsendblocks;
365:   PetscSegBuffer segrecvframe;
366:   PetscSegBuffer segrecvblocks;
367:   MPI_Datatype   blocktype;
368:   size_t         blocktype_size;
369:   InsertMode     *insertmode;   /* Pointer to check mat->insertmode and set upon message arrival in case no local values have been set. */
370: };

372: #if !defined(PETSC_HAVE_MPIUNI)
373: PETSC_INTERN PetscErrorCode MatStashScatterDestroy_BTS(MatStash*);
374: #endif
375: PETSC_INTERN PetscErrorCode MatStashCreate_Private(MPI_Comm,PetscInt,MatStash*);
376: PETSC_INTERN PetscErrorCode MatStashDestroy_Private(MatStash*);
377: PETSC_INTERN PetscErrorCode MatStashScatterEnd_Private(MatStash*);
378: PETSC_INTERN PetscErrorCode MatStashSetInitialSize_Private(MatStash*,PetscInt);
379: PETSC_INTERN PetscErrorCode MatStashGetInfo_Private(MatStash*,PetscInt*,PetscInt*);
380: PETSC_INTERN PetscErrorCode MatStashValuesRow_Private(MatStash*,PetscInt,PetscInt,const PetscInt[],const PetscScalar[],PetscBool);
381: PETSC_INTERN PetscErrorCode MatStashValuesCol_Private(MatStash*,PetscInt,PetscInt,const PetscInt[],const PetscScalar[],PetscInt,PetscBool);
382: PETSC_INTERN PetscErrorCode MatStashValuesRowBlocked_Private(MatStash*,PetscInt,PetscInt,const PetscInt[],const PetscScalar[],PetscInt,PetscInt,PetscInt);
383: PETSC_INTERN PetscErrorCode MatStashValuesColBlocked_Private(MatStash*,PetscInt,PetscInt,const PetscInt[],const PetscScalar[],PetscInt,PetscInt,PetscInt);
384: PETSC_INTERN PetscErrorCode MatStashScatterBegin_Private(Mat,MatStash*,PetscInt*);
385: PETSC_INTERN PetscErrorCode MatStashScatterGetMesg_Private(MatStash*,PetscMPIInt*,PetscInt**,PetscInt**,PetscScalar**,PetscInt*);
386: PETSC_INTERN PetscErrorCode MatGetInfo_External(Mat,MatInfoType,MatInfo*);

388: typedef struct {
389:   PetscInt   dim;
390:   PetscInt   dims[4];
391:   PetscInt   starts[4];
392:   PetscBool  noc;        /* this is a single component problem, hence user will not set MatStencil.c */
393: } MatStencilInfo;

395: /* Info about using compressed row format */
396: typedef struct {
397:   PetscBool  use;                           /* indicates compressed rows have been checked and will be used */
398:   PetscInt   nrows;                         /* number of non-zero rows */
399:   PetscInt   *i;                            /* compressed row pointer  */
400:   PetscInt   *rindex;                       /* compressed row index               */
401: } Mat_CompressedRow;
402: PETSC_EXTERN PetscErrorCode MatCheckCompressedRow(Mat,PetscInt,Mat_CompressedRow*,PetscInt*,PetscInt,PetscReal);

404: typedef struct { /* used by MatCreateRedundantMatrix() for reusing matredundant */
405:   PetscInt     nzlocal,nsends,nrecvs;
406:   PetscMPIInt  *send_rank,*recv_rank;
407:   PetscInt     *sbuf_nz,*rbuf_nz,*sbuf_j,**rbuf_j;
408:   PetscScalar  *sbuf_a,**rbuf_a;
409:   MPI_Comm     subcomm;   /* when user does not provide a subcomm */
410:   IS           isrow,iscol;
411:   Mat          *matseq;
412: } Mat_Redundant;

414: typedef struct { /* used by MatProduct() */
415:   MatProductType type;
416:   char           *alg;
417:   Mat            A,B,C,Dwork;
418:   PetscReal      fill;
419:   PetscBool      api_user; /* used to distinguish command line options and to indicate the matrix values are ready to be consumed at symbolic phase if needed */

421:   /* Some products may display the information on the algorithm used */
422:   PetscErrorCode (*view)(Mat,PetscViewer);

424:   /* many products have intermediate data structures, each specific to Mat types and product type */
425:   PetscBool      clear;             /* whether or not to clear the data structures after MatProductNumeric has been called */
426:   void           *data;             /* where to stash those structures */
427:   PetscErrorCode (*destroy)(void*); /* destroy routine */
428: } Mat_Product;

430: #define CSRDataStructure(datatype)  \
431:   int         *i; \
432:   int         *j; \
433:   datatype    *a;\
434:   PetscInt    n;\
435:   PetscInt    ignorezeroentries;

437: typedef struct {
438:   CSRDataStructure(PetscScalar)
439: } PetscCSRDataStructure;

441: struct _p_SplitCSRMat {
442:   PetscInt              cstart,cend,rstart,rend;
443:   PetscCSRDataStructure diag,offdiag;
444:   PetscInt              *colmap;
445:   PetscMPIInt           rank;
446: };

448: struct _p_Mat {
449:   PETSCHEADER(struct _MatOps);
450:   PetscLayout            rmap,cmap;
451:   void                   *data;            /* implementation-specific data */
452:   MatFactorType          factortype;       /* MAT_FACTOR_LU, ILU, CHOLESKY or ICC */
453:   PetscBool              useordering;      /* factorization using ordering provide to routine (most PETSc implementations) */
454:   PetscBool              assembled;        /* is the matrix assembled? */
455:   PetscBool              was_assembled;    /* new values inserted into assembled mat */
456:   PetscInt               num_ass;          /* number of times matrix has been assembled */
457:   PetscObjectState       nonzerostate;     /* each time new nonzeros locations are introduced into the matrix this is updated */
458:   PetscObjectState       ass_nonzerostate; /* nonzero state at last assembly */
459:   MatInfo                info;             /* matrix information */
460:   InsertMode             insertmode;       /* have values been inserted in matrix or added? */
461:   MatStash               stash,bstash;     /* used for assembling off-proc mat emements */
462:   MatNullSpace           nullsp;           /* null space (operator is singular) */
463:   MatNullSpace           transnullsp;      /* null space of transpose of operator */
464:   MatNullSpace           nearnullsp;       /* near null space to be used by multigrid methods */
465:   PetscInt               congruentlayouts; /* are the rows and columns layouts congruent? */
466:   PetscBool              preallocated;
467:   MatStencilInfo         stencil;          /* information for structured grid */
468:   PetscBool              symmetric,hermitian,structurally_symmetric,spd;
469:   PetscBool              symmetric_set,hermitian_set,structurally_symmetric_set,spd_set; /* if true, then corresponding flag is correct*/
470:   PetscBool              symmetric_eternal;
471:   PetscBool              nooffprocentries,nooffproczerorows;
472:   PetscBool              assembly_subset;  /* set by MAT_SUBSET_OFF_PROC_ENTRIES */
473:   PetscBool              submat_singleis;  /* for efficient PCSetUp_ASM() */
474:   PetscBool              structure_only;
475:   PetscBool              sortedfull;       /* full, sorted rows are inserted */
476:   PetscBool              force_diagonals;  /* set by MAT_FORCE_DIAGONAL_ENTRIES */
477: #if defined(PETSC_HAVE_DEVICE)
478:   PetscOffloadMask       offloadmask;      /* a mask which indicates where the valid matrix data is (GPU, CPU or both) */
479:   PetscBool              boundtocpu;
480: #endif
481:   void                   *spptr;          /* pointer for special library like SuperLU */
482:   char                   *solvertype;
483:   PetscBool              checksymmetryonassembly,checknullspaceonassembly;
484:   PetscReal              checksymmetrytol;
485:   Mat                    schur;             /* Schur complement matrix */
486:   MatFactorSchurStatus   schur_status;      /* status of the Schur complement matrix */
487:   Mat_Redundant          *redundant;        /* used by MatCreateRedundantMatrix() */
488:   PetscBool              erroriffailure;    /* Generate an error if detected (for example a zero pivot) instead of returning */
489:   MatFactorError         factorerrortype;               /* type of error in factorization */
490:   PetscReal              factorerror_zeropivot_value;   /* If numerical zero pivot was detected this is the computed value */
491:   PetscInt               factorerror_zeropivot_row;     /* Row where zero pivot was detected */
492:   PetscInt               nblocks,*bsizes;   /* support for MatSetVariableBlockSizes() */
493:   char                   *defaultvectype;
494:   Mat_Product            *product;
495: };

497: PETSC_INTERN PetscErrorCode MatAXPY_Basic(Mat,PetscScalar,Mat,MatStructure);
498: PETSC_INTERN PetscErrorCode MatAXPY_BasicWithPreallocation(Mat,Mat,PetscScalar,Mat,MatStructure);
499: PETSC_INTERN PetscErrorCode MatAXPY_Basic_Preallocate(Mat,Mat,Mat*);

501: /*
502:     Utility for MatFactor (Schur complement)
503: */
504: PETSC_INTERN PetscErrorCode MatFactorFactorizeSchurComplement_Private(Mat);
505: PETSC_INTERN PetscErrorCode MatFactorInvertSchurComplement_Private(Mat);
506: PETSC_INTERN PetscErrorCode MatFactorUpdateSchurStatus_Private(Mat);
507: PETSC_INTERN PetscErrorCode MatFactorSetUpInPlaceSchur_Private(Mat);

509: /*
510:     Utility for MatZeroRows
511: */
512: PETSC_INTERN PetscErrorCode MatZeroRowsMapLocal_Private(Mat,PetscInt,const PetscInt*,PetscInt*,PetscInt**);

514: /*
515:     Utility for MatView/MatLoad
516: */
517: PETSC_INTERN PetscErrorCode MatView_Binary_BlockSizes(Mat,PetscViewer);
518: PETSC_INTERN PetscErrorCode MatLoad_Binary_BlockSizes(Mat,PetscViewer);


521: /*
522:     Object for partitioning graphs
523: */

525: typedef struct _MatPartitioningOps *MatPartitioningOps;
526: struct _MatPartitioningOps {
527:   PetscErrorCode (*apply)(MatPartitioning,IS*);
528:   PetscErrorCode (*applynd)(MatPartitioning,IS*);
529:   PetscErrorCode (*setfromoptions)(PetscOptionItems*,MatPartitioning);
530:   PetscErrorCode (*destroy)(MatPartitioning);
531:   PetscErrorCode (*view)(MatPartitioning,PetscViewer);
532:   PetscErrorCode (*improve)(MatPartitioning,IS*);
533: };

535: struct _p_MatPartitioning {
536:   PETSCHEADER(struct _MatPartitioningOps);
537:   Mat         adj;
538:   PetscInt    *vertex_weights;
539:   PetscReal   *part_weights;
540:   PetscInt    n;                                 /* number of partitions */
541:   void        *data;
542:   PetscInt    setupcalled;
543:   PetscBool   use_edge_weights;  /* A flag indicates whether or not to use edge weights */
544: };

546: /* needed for parallel nested dissection by ParMetis and PTSCOTCH */
547: PETSC_INTERN PetscErrorCode MatPartitioningSizesToSep_Private(PetscInt,PetscInt[],PetscInt[],PetscInt[]);

549: /*
550:     Object for coarsen graphs
551: */
552: typedef struct _MatCoarsenOps *MatCoarsenOps;
553: struct _MatCoarsenOps {
554:   PetscErrorCode (*apply)(MatCoarsen);
555:   PetscErrorCode (*setfromoptions)(PetscOptionItems*,MatCoarsen);
556:   PetscErrorCode (*destroy)(MatCoarsen);
557:   PetscErrorCode (*view)(MatCoarsen,PetscViewer);
558: };

560: struct _p_MatCoarsen {
561:   PETSCHEADER(struct _MatCoarsenOps);
562:   Mat              graph;
563:   void             *subctx;
564:   /* */
565:   PetscBool        strict_aggs;
566:   IS               perm;
567:   PetscCoarsenData *agg_lists;
568: };

570: /*
571:     MatFDColoring is used to compute Jacobian matrices efficiently
572:   via coloring. The data structure is explained below in an example.

574:    Color =   0    1     0    2   |   2      3       0
575:    ---------------------------------------------------
576:             00   01              |          05
577:             10   11              |   14     15               Processor  0
578:                        22    23  |          25
579:                        32    33  |
580:    ===================================================
581:                                  |   44     45     46
582:             50                   |          55               Processor 1
583:                                  |   64            66
584:    ---------------------------------------------------

586:     ncolors = 4;

588:     ncolumns      = {2,1,1,0}
589:     columns       = {{0,2},{1},{3},{}}
590:     nrows         = {4,2,3,3}
591:     rows          = {{0,1,2,3},{0,1},{1,2,3},{0,1,2}}
592:     vwscale       = {dx(0),dx(1),dx(2),dx(3)}               MPI Vec
593:     vscale        = {dx(0),dx(1),dx(2),dx(3),dx(4),dx(5)}   Seq Vec

595:     ncolumns      = {1,0,1,1}
596:     columns       = {{6},{},{4},{5}}
597:     nrows         = {3,0,2,2}
598:     rows          = {{0,1,2},{},{1,2},{1,2}}
599:     vwscale       = {dx(4),dx(5),dx(6)}              MPI Vec
600:     vscale        = {dx(0),dx(4),dx(5),dx(6)}        Seq Vec

602:     See the routine MatFDColoringApply() for how this data is used
603:     to compute the Jacobian.

605: */
606: typedef struct {
607:   PetscInt     row;
608:   PetscInt     col;
609:   PetscScalar  *valaddr;   /* address of value */
610: } MatEntry;

612: typedef struct {
613:   PetscInt     row;
614:   PetscScalar  *valaddr;   /* address of value */
615: } MatEntry2;

617: struct  _p_MatFDColoring{
618:   PETSCHEADER(int);
619:   PetscInt       M,N,m;            /* total rows, columns; local rows */
620:   PetscInt       rstart;           /* first row owned by local processor */
621:   PetscInt       ncolors;          /* number of colors */
622:   PetscInt       *ncolumns;        /* number of local columns for a color */
623:   PetscInt       **columns;        /* lists the local columns of each color (using global column numbering) */
624:   IS             *isa;             /* these are the IS that contain the column values given in columns */
625:   PetscInt       *nrows;           /* number of local rows for each color */
626:   MatEntry       *matentry;        /* holds (row, column, address of value) for Jacobian matrix entry */
627:   MatEntry2      *matentry2;       /* holds (row, address of value) for Jacobian matrix entry */
628:   PetscScalar    *dy;              /* store a block of F(x+dx)-F(x) when J is in BAIJ format */
629:   PetscReal      error_rel;        /* square root of relative error in computing function */
630:   PetscReal      umin;             /* minimum allowable u'dx value */
631:   Vec            w1,w2,w3;         /* work vectors used in computing Jacobian */
632:   PetscBool      fset;             /* indicates that the initial function value F(X) is set */
633:   PetscErrorCode (*f)(void);       /* function that defines Jacobian */
634:   void           *fctx;            /* optional user-defined context for use by the function f */
635:   Vec            vscale;           /* holds FD scaling, i.e. 1/dx for each perturbed column */
636:   PetscInt       currentcolor;     /* color for which function evaluation is being done now */
637:   const char     *htype;           /* "wp" or "ds" */
638:   ISColoringType ctype;            /* IS_COLORING_GLOBAL or IS_COLORING_LOCAL */
639:   PetscInt       brows,bcols;      /* number of block rows or columns for speedup inserting the dense matrix into sparse Jacobian */
640:   PetscBool      setupcalled;      /* true if setup has been called */
641:   PetscBool      viewed;           /* true if the -mat_fd_coloring_view has been triggered already */
642:   void           (*ftn_func_pointer)(void),*ftn_func_cntx; /* serve the same purpose as *fortran_func_pointers in PETSc objects */
643:   PetscObjectId  matid;            /* matrix this object was created with, must always be the same */
644: };

646: typedef struct _MatColoringOps *MatColoringOps;
647: struct _MatColoringOps {
648:   PetscErrorCode (*destroy)(MatColoring);
649:   PetscErrorCode (*setfromoptions)(PetscOptionItems*,MatColoring);
650:   PetscErrorCode (*view)(MatColoring,PetscViewer);
651:   PetscErrorCode (*apply)(MatColoring,ISColoring*);
652:   PetscErrorCode (*weights)(MatColoring,PetscReal**,PetscInt**);
653: };

655: struct _p_MatColoring {
656:   PETSCHEADER(struct _MatColoringOps);
657:   Mat                   mat;
658:   PetscInt              dist;             /* distance of the coloring */
659:   PetscInt              maxcolors;        /* the maximum number of colors returned, maxcolors=1 for MIS */
660:   void                  *data;            /* inner context */
661:   PetscBool             valid;            /* check to see if what is produced is a valid coloring */
662:   MatColoringWeightType weight_type;      /* type of weight computation to be performed */
663:   PetscReal             *user_weights;    /* custom weights and permutation */
664:   PetscInt              *user_lperm;
665:   PetscBool             valid_iscoloring; /* check to see if matcoloring is produced a valid iscoloring */
666: };

668: struct  _p_MatTransposeColoring{
669:   PETSCHEADER(int);
670:   PetscInt       M,N,m;            /* total rows, columns; local rows */
671:   PetscInt       rstart;           /* first row owned by local processor */
672:   PetscInt       ncolors;          /* number of colors */
673:   PetscInt       *ncolumns;        /* number of local columns for a color */
674:   PetscInt       *nrows;           /* number of local rows for each color */
675:   PetscInt       currentcolor;     /* color for which function evaluation is being done now */
676:   ISColoringType ctype;            /* IS_COLORING_GLOBAL or IS_COLORING_LOCAL */

678:   PetscInt       *colorforrow,*colorforcol;  /* pointer to rows and columns */
679:   PetscInt       *rows;                      /* lists the local rows for each color (using the local row numbering) */
680:   PetscInt       *den2sp;                    /* maps (row,color) in the dense matrix to index of sparse matrix array a->a */
681:   PetscInt       *columns;                   /* lists the local columns of each color (using global column numbering) */
682:   PetscInt       brows;                      /* number of rows for efficient implementation of MatTransColoringApplyDenToSp() */
683:   PetscInt       *lstart;                    /* array used for loop over row blocks of Csparse */
684: };

686: /*
687:    Null space context for preconditioner/operators
688: */
689: struct _p_MatNullSpace {
690:   PETSCHEADER(int);
691:   PetscBool      has_cnst;
692:   PetscInt       n;
693:   Vec*           vecs;
694:   PetscScalar*   alpha;                 /* for projections */
695:   PetscErrorCode (*remove)(MatNullSpace,Vec,void*);  /* for user provided removal function */
696:   void*          rmctx;                 /* context for remove() function */
697: };

699: /*
700:    Checking zero pivot for LU, ILU preconditioners.
701: */
702: typedef struct {
703:   PetscInt       nshift,nshift_max;
704:   PetscReal      shift_amount,shift_lo,shift_hi,shift_top,shift_fraction;
705:   PetscBool      newshift;
706:   PetscReal      rs;  /* active row sum of abs(offdiagonals) */
707:   PetscScalar    pv;  /* pivot of the active row */
708: } FactorShiftCtx;

710: /*
711:  Used by MatCreateSubMatrices_MPIXAIJ_Local()
712: */
713: #include <petscctable.h>
714: typedef struct { /* used by MatCreateSubMatrices_MPIAIJ_SingleIS_Local() and MatCreateSubMatrices_MPIAIJ_Local */
715:   PetscInt   id;   /* index of submats, only submats[0] is responsible for deleting some arrays below */
716:   PetscInt   nrqs,nrqr;
717:   PetscInt   **rbuf1,**rbuf2,**rbuf3,**sbuf1,**sbuf2;
718:   PetscInt   **ptr;
719:   PetscInt   *tmp;
720:   PetscInt   *ctr;
721:   PetscInt   *pa; /* proc array */
722:   PetscInt   *req_size,*req_source1,*req_source2;
723:   PetscBool  allcolumns,allrows;
724:   PetscBool  singleis;
725:   PetscInt   *row2proc; /* row to proc map */
726:   PetscInt   nstages;
727: #if defined(PETSC_USE_CTABLE)
728:   PetscTable cmap,rmap;
729:   PetscInt   *cmap_loc,*rmap_loc;
730: #else
731:   PetscInt   *cmap,*rmap;
732: #endif

734:   PetscErrorCode (*destroy)(Mat);
735: } Mat_SubSppt;

737: PETSC_EXTERN PetscErrorCode MatFactorDumpMatrix(Mat);
738: PETSC_INTERN PetscErrorCode MatShift_Basic(Mat,PetscScalar);
739: PETSC_INTERN PetscErrorCode MatSetBlockSizes_Default(Mat,PetscInt,PetscInt);

741: PETSC_STATIC_INLINE PetscErrorCode MatPivotCheck_nz(Mat mat,const MatFactorInfo *info,FactorShiftCtx *sctx,PetscInt row)
742: {
743:   PetscReal _rs   = sctx->rs;
744:   PetscReal _zero = info->zeropivot*_rs;

747:   if (PetscAbsScalar(sctx->pv) <= _zero && !PetscIsNanScalar(sctx->pv)){
748:     /* force |diag| > zeropivot*rs */
749:     if (!sctx->nshift) sctx->shift_amount = info->shiftamount;
750:     else sctx->shift_amount *= 2.0;
751:     sctx->newshift = PETSC_TRUE;
752:     (sctx->nshift)++;
753:   } else {
754:     sctx->newshift = PETSC_FALSE;
755:   }
756:   return(0);
757: }

759: PETSC_STATIC_INLINE PetscErrorCode MatPivotCheck_pd(Mat mat,const MatFactorInfo *info,FactorShiftCtx *sctx,PetscInt row)
760: {
761:   PetscReal _rs   = sctx->rs;
762:   PetscReal _zero = info->zeropivot*_rs;

765:   if (PetscRealPart(sctx->pv) <= _zero && !PetscIsNanScalar(sctx->pv)){
766:     /* force matfactor to be diagonally dominant */
767:     if (sctx->nshift == sctx->nshift_max) {
768:       sctx->shift_fraction = sctx->shift_hi;
769:     } else {
770:       sctx->shift_lo = sctx->shift_fraction;
771:       sctx->shift_fraction = (sctx->shift_hi+sctx->shift_lo)/2.;
772:     }
773:     sctx->shift_amount = sctx->shift_fraction * sctx->shift_top;
774:     sctx->nshift++;
775:     sctx->newshift = PETSC_TRUE;
776:   } else {
777:     sctx->newshift = PETSC_FALSE;
778:   }
779:   return(0);
780: }

782: PETSC_STATIC_INLINE PetscErrorCode MatPivotCheck_inblocks(Mat mat,const MatFactorInfo *info,FactorShiftCtx *sctx,PetscInt row)
783: {
784:   PetscReal _zero = info->zeropivot;

787:   if (PetscAbsScalar(sctx->pv) <= _zero && !PetscIsNanScalar(sctx->pv)){
788:     sctx->pv          += info->shiftamount;
789:     sctx->shift_amount = 0.0;
790:     sctx->nshift++;
791:   }
792:   sctx->newshift = PETSC_FALSE;
793:   return(0);
794: }

796: PETSC_STATIC_INLINE PetscErrorCode MatPivotCheck_none(Mat fact,Mat mat,const MatFactorInfo *info,FactorShiftCtx *sctx,PetscInt row)
797: {
798:   PetscReal      _zero = info->zeropivot;

802:   sctx->newshift = PETSC_FALSE;
803:   if (PetscAbsScalar(sctx->pv) <= _zero && !PetscIsNanScalar(sctx->pv)) {
804:     if (!mat->erroriffailure) {
805:       PetscInfo3(mat,"Detected zero pivot in factorization in row %D value %g tolerance %g\n",row,(double)PetscAbsScalar(sctx->pv),(double)_zero);
806:       fact->factorerrortype             = MAT_FACTOR_NUMERIC_ZEROPIVOT;
807:       fact->factorerror_zeropivot_value = PetscAbsScalar(sctx->pv);
808:       fact->factorerror_zeropivot_row   = row;
809:     } else SETERRQ3(PETSC_COMM_SELF,PETSC_ERR_MAT_LU_ZRPVT,"Zero pivot row %D value %g tolerance %g\n",row,(double)PetscAbsScalar(sctx->pv),(double)_zero);
810:   }
811:   return(0);
812: }

814: PETSC_STATIC_INLINE PetscErrorCode MatPivotCheck(Mat fact,Mat mat,const MatFactorInfo *info,FactorShiftCtx *sctx,PetscInt row)
815: {

819:   if (info->shifttype == (PetscReal) MAT_SHIFT_NONZERO){
820:     MatPivotCheck_nz(mat,info,sctx,row);
821:   } else if (info->shifttype == (PetscReal) MAT_SHIFT_POSITIVE_DEFINITE){
822:     MatPivotCheck_pd(mat,info,sctx,row);
823:   } else if (info->shifttype == (PetscReal) MAT_SHIFT_INBLOCKS){
824:     MatPivotCheck_inblocks(mat,info,sctx,row);
825:   } else {
826:     MatPivotCheck_none(fact,mat,info,sctx,row);
827:   }
828:   return(0);
829: }

831: /*
832:   Create and initialize a linked list
833:   Input Parameters:
834:     idx_start - starting index of the list
835:     lnk_max   - max value of lnk indicating the end of the list
836:     nlnk      - max length of the list
837:   Output Parameters:
838:     lnk       - list initialized
839:     bt        - PetscBT (bitarray) with all bits set to false
840:     lnk_empty - flg indicating the list is empty
841: */
842: #define PetscLLCreate(idx_start,lnk_max,nlnk,lnk,bt) \
843:   (PetscMalloc1(nlnk,&lnk) || PetscBTCreate(nlnk,&(bt)) || (lnk[idx_start] = lnk_max,0))

845: #define PetscLLCreate_new(idx_start,lnk_max,nlnk,lnk,bt,lnk_empty)\
846:   (PetscMalloc1(nlnk,&lnk) || PetscBTCreate(nlnk,&(bt)) || (lnk_empty = PETSC_TRUE,0) ||(lnk[idx_start] = lnk_max,0))

848: /*
849:   Add an index set into a sorted linked list
850:   Input Parameters:
851:     nidx      - number of input indices
852:     indices   - integer array
853:     idx_start - starting index of the list
854:     lnk       - linked list(an integer array) that is created
855:     bt        - PetscBT (bitarray), bt[idx]=true marks idx is in lnk
856:   output Parameters:
857:     nlnk      - number of newly added indices
858:     lnk       - the sorted(increasing order) linked list containing new and non-redundate entries from indices
859:     bt        - updated PetscBT (bitarray)
860: */
861: #define PetscLLAdd(nidx,indices,idx_start,nlnk,lnk,bt) 0;\
862: {\
863:   PetscInt _k,_entry,_location,_lnkdata;\
864:   nlnk     = 0;\
865:   _lnkdata = idx_start;\
866:   for (_k=0; _k<nidx; _k++){\
867:     _entry = indices[_k];\
868:     if (!PetscBTLookupSet(bt,_entry)){  /* new entry */\
869:       /* search for insertion location */\
870:       /* start from the beginning if _entry < previous _entry */\
871:       if (_k && _entry < _lnkdata) _lnkdata  = idx_start;\
872:       do {\
873:         _location = _lnkdata;\
874:         _lnkdata  = lnk[_location];\
875:       } while (_entry > _lnkdata);\
876:       /* insertion location is found, add entry into lnk */\
877:       lnk[_location] = _entry;\
878:       lnk[_entry]    = _lnkdata;\
879:       nlnk++;\
880:       _lnkdata = _entry; /* next search starts from here if next_entry > _entry */\
881:     }\
882:   }\
883: }

885: /*
886:   Add a permuted index set into a sorted linked list
887:   Input Parameters:
888:     nidx      - number of input indices
889:     indices   - integer array
890:     perm      - permutation of indices
891:     idx_start - starting index of the list
892:     lnk       - linked list(an integer array) that is created
893:     bt        - PetscBT (bitarray), bt[idx]=true marks idx is in lnk
894:   output Parameters:
895:     nlnk      - number of newly added indices
896:     lnk       - the sorted(increasing order) linked list containing new and non-redundate entries from indices
897:     bt        - updated PetscBT (bitarray)
898: */
899: #define PetscLLAddPerm(nidx,indices,perm,idx_start,nlnk,lnk,bt) 0;\
900: {\
901:   PetscInt _k,_entry,_location,_lnkdata;\
902:   nlnk     = 0;\
903:   _lnkdata = idx_start;\
904:   for (_k=0; _k<nidx; _k++){\
905:     _entry = perm[indices[_k]];\
906:     if (!PetscBTLookupSet(bt,_entry)){  /* new entry */\
907:       /* search for insertion location */\
908:       /* start from the beginning if _entry < previous _entry */\
909:       if (_k && _entry < _lnkdata) _lnkdata  = idx_start;\
910:       do {\
911:         _location = _lnkdata;\
912:         _lnkdata  = lnk[_location];\
913:       } while (_entry > _lnkdata);\
914:       /* insertion location is found, add entry into lnk */\
915:       lnk[_location] = _entry;\
916:       lnk[_entry]    = _lnkdata;\
917:       nlnk++;\
918:       _lnkdata = _entry; /* next search starts from here if next_entry > _entry */\
919:     }\
920:   }\
921: }

923: /*
924:   Add a SORTED ascending index set into a sorted linked list - same as PetscLLAdd() bus skip 'if (_k && _entry < _lnkdata) _lnkdata  = idx_start;'
925:   Input Parameters:
926:     nidx      - number of input indices
927:     indices   - sorted integer array
928:     idx_start - starting index of the list
929:     lnk       - linked list(an integer array) that is created
930:     bt        - PetscBT (bitarray), bt[idx]=true marks idx is in lnk
931:   output Parameters:
932:     nlnk      - number of newly added indices
933:     lnk       - the sorted(increasing order) linked list containing new and non-redundate entries from indices
934:     bt        - updated PetscBT (bitarray)
935: */
936: #define PetscLLAddSorted(nidx,indices,idx_start,nlnk,lnk,bt) 0;\
937: {\
938:   PetscInt _k,_entry,_location,_lnkdata;\
939:   nlnk      = 0;\
940:   _lnkdata  = idx_start;\
941:   for (_k=0; _k<nidx; _k++){\
942:     _entry = indices[_k];\
943:     if (!PetscBTLookupSet(bt,_entry)){  /* new entry */\
944:       /* search for insertion location */\
945:       do {\
946:         _location = _lnkdata;\
947:         _lnkdata  = lnk[_location];\
948:       } while (_entry > _lnkdata);\
949:       /* insertion location is found, add entry into lnk */\
950:       lnk[_location] = _entry;\
951:       lnk[_entry]    = _lnkdata;\
952:       nlnk++;\
953:       _lnkdata = _entry; /* next search starts from here */\
954:     }\
955:   }\
956: }

958: #define PetscLLAddSorted_new(nidx,indices,idx_start,lnk_empty,nlnk,lnk,bt) 0; \
959: {\
960:   PetscInt _k,_entry,_location,_lnkdata;\
961:   if (lnk_empty){\
962:     _lnkdata  = idx_start;                      \
963:     for (_k=0; _k<nidx; _k++){                  \
964:       _entry = indices[_k];                             \
965:       PetscBTSet(bt,_entry);  /* mark the new entry */          \
966:           _location = _lnkdata;                                 \
967:           _lnkdata  = lnk[_location];                           \
968:         /* insertion location is found, add entry into lnk */   \
969:         lnk[_location] = _entry;                                \
970:         lnk[_entry]    = _lnkdata;                              \
971:         _lnkdata = _entry; /* next search starts from here */   \
972:     }                                                           \
973:     /*\
974:     lnk[indices[nidx-1]] = lnk[idx_start];\
975:     lnk[idx_start]       = indices[0];\
976:     PetscBTSet(bt,indices[0]);  \
977:     for (_k=1; _k<nidx; _k++){                  \
978:       PetscBTSet(bt,indices[_k]);                                          \
979:       lnk[indices[_k-1]] = indices[_k];                                  \
980:     }                                                           \
981:      */\
982:     nlnk      = nidx;\
983:     lnk_empty = PETSC_FALSE;\
984:   } else {\
985:     nlnk      = 0;                              \
986:     _lnkdata  = idx_start;                      \
987:     for (_k=0; _k<nidx; _k++){                  \
988:       _entry = indices[_k];                             \
989:       if (!PetscBTLookupSet(bt,_entry)){  /* new entry */       \
990:         /* search for insertion location */                     \
991:         do {                                                    \
992:           _location = _lnkdata;                                 \
993:           _lnkdata  = lnk[_location];                           \
994:         } while (_entry > _lnkdata);                            \
995:         /* insertion location is found, add entry into lnk */   \
996:         lnk[_location] = _entry;                                \
997:         lnk[_entry]    = _lnkdata;                              \
998:         nlnk++;                                                 \
999:         _lnkdata = _entry; /* next search starts from here */   \
1000:       }                                                         \
1001:     }                                                           \
1002:   }                                                             \
1003: }

1005: /*
1006:   Add a SORTED index set into a sorted linked list used for LUFactorSymbolic()
1007:   Same as PetscLLAddSorted() with an additional operation:
1008:        count the number of input indices that are no larger than 'diag'
1009:   Input Parameters:
1010:     indices   - sorted integer array
1011:     idx_start - starting index of the list, index of pivot row
1012:     lnk       - linked list(an integer array) that is created
1013:     bt        - PetscBT (bitarray), bt[idx]=true marks idx is in lnk
1014:     diag      - index of the active row in LUFactorSymbolic
1015:     nzbd      - number of input indices with indices <= idx_start
1016:     im        - im[idx_start] is initialized as num of nonzero entries in row=idx_start
1017:   output Parameters:
1018:     nlnk      - number of newly added indices
1019:     lnk       - the sorted(increasing order) linked list containing new and non-redundate entries from indices
1020:     bt        - updated PetscBT (bitarray)
1021:     im        - im[idx_start]: unchanged if diag is not an entry
1022:                              : num of entries with indices <= diag if diag is an entry
1023: */
1024: #define PetscLLAddSortedLU(indices,idx_start,nlnk,lnk,bt,diag,nzbd,im) 0;\
1025: {\
1026:   PetscInt _k,_entry,_location,_lnkdata,_nidx;\
1027:   nlnk     = 0;\
1028:   _lnkdata = idx_start;\
1029:   _nidx = im[idx_start] - nzbd; /* num of entries with idx_start < index <= diag */\
1030:   for (_k=0; _k<_nidx; _k++){\
1031:     _entry = indices[_k];\
1032:     nzbd++;\
1033:     if (_entry== diag) im[idx_start] = nzbd;\
1034:     if (!PetscBTLookupSet(bt,_entry)){  /* new entry */\
1035:       /* search for insertion location */\
1036:       do {\
1037:         _location = _lnkdata;\
1038:         _lnkdata  = lnk[_location];\
1039:       } while (_entry > _lnkdata);\
1040:       /* insertion location is found, add entry into lnk */\
1041:       lnk[_location] = _entry;\
1042:       lnk[_entry]    = _lnkdata;\
1043:       nlnk++;\
1044:       _lnkdata = _entry; /* next search starts from here */\
1045:     }\
1046:   }\
1047: }

1049: /*
1050:   Copy data on the list into an array, then initialize the list
1051:   Input Parameters:
1052:     idx_start - starting index of the list
1053:     lnk_max   - max value of lnk indicating the end of the list
1054:     nlnk      - number of data on the list to be copied
1055:     lnk       - linked list
1056:     bt        - PetscBT (bitarray), bt[idx]=true marks idx is in lnk
1057:   output Parameters:
1058:     indices   - array that contains the copied data
1059:     lnk       - linked list that is cleaned and initialize
1060:     bt        - PetscBT (bitarray) with all bits set to false
1061: */
1062: #define PetscLLClean(idx_start,lnk_max,nlnk,lnk,indices,bt) 0;\
1063: {\
1064:   PetscInt _j,_idx=idx_start;\
1065:   for (_j=0; _j<nlnk; _j++){\
1066:     _idx = lnk[_idx];\
1067:     indices[_j] = _idx;\
1068:     PetscBTClear(bt,_idx);\
1069:   }\
1070:   lnk[idx_start] = lnk_max;\
1071: }
1072: /*
1073:   Free memories used by the list
1074: */
1075: #define PetscLLDestroy(lnk,bt) (PetscFree(lnk) || PetscBTDestroy(&(bt)))

1077: /* Routines below are used for incomplete matrix factorization */
1078: /*
1079:   Create and initialize a linked list and its levels
1080:   Input Parameters:
1081:     idx_start - starting index of the list
1082:     lnk_max   - max value of lnk indicating the end of the list
1083:     nlnk      - max length of the list
1084:   Output Parameters:
1085:     lnk       - list initialized
1086:     lnk_lvl   - array of size nlnk for storing levels of lnk
1087:     bt        - PetscBT (bitarray) with all bits set to false
1088: */
1089: #define PetscIncompleteLLCreate(idx_start,lnk_max,nlnk,lnk,lnk_lvl,bt)\
1090:   (PetscIntMultError(2,nlnk,NULL) || PetscMalloc1(2*nlnk,&lnk) || PetscBTCreate(nlnk,&(bt)) || (lnk[idx_start] = lnk_max,lnk_lvl = lnk + nlnk,0))

1092: /*
1093:   Initialize a sorted linked list used for ILU and ICC
1094:   Input Parameters:
1095:     nidx      - number of input idx
1096:     idx       - integer array used for storing column indices
1097:     idx_start - starting index of the list
1098:     perm      - indices of an IS
1099:     lnk       - linked list(an integer array) that is created
1100:     lnklvl    - levels of lnk
1101:     bt        - PetscBT (bitarray), bt[idx]=true marks idx is in lnk
1102:   output Parameters:
1103:     nlnk     - number of newly added idx
1104:     lnk      - the sorted(increasing order) linked list containing new and non-redundate entries from idx
1105:     lnklvl   - levels of lnk
1106:     bt       - updated PetscBT (bitarray)
1107: */
1108: #define PetscIncompleteLLInit(nidx,idx,idx_start,perm,nlnk,lnk,lnklvl,bt) 0;\
1109: {\
1110:   PetscInt _k,_entry,_location,_lnkdata;\
1111:   nlnk     = 0;\
1112:   _lnkdata = idx_start;\
1113:   for (_k=0; _k<nidx; _k++){\
1114:     _entry = perm[idx[_k]];\
1115:     if (!PetscBTLookupSet(bt,_entry)){  /* new entry */\
1116:       /* search for insertion location */\
1117:       if (_k && _entry < _lnkdata) _lnkdata  = idx_start;\
1118:       do {\
1119:         _location = _lnkdata;\
1120:         _lnkdata  = lnk[_location];\
1121:       } while (_entry > _lnkdata);\
1122:       /* insertion location is found, add entry into lnk */\
1123:       lnk[_location]  = _entry;\
1124:       lnk[_entry]     = _lnkdata;\
1125:       lnklvl[_entry] = 0;\
1126:       nlnk++;\
1127:       _lnkdata = _entry; /* next search starts from here if next_entry > _entry */\
1128:     }\
1129:   }\
1130: }

1132: /*
1133:   Add a SORTED index set into a sorted linked list for ILU
1134:   Input Parameters:
1135:     nidx      - number of input indices
1136:     idx       - sorted integer array used for storing column indices
1137:     level     - level of fill, e.g., ICC(level)
1138:     idxlvl    - level of idx
1139:     idx_start - starting index of the list
1140:     lnk       - linked list(an integer array) that is created
1141:     lnklvl    - levels of lnk
1142:     bt        - PetscBT (bitarray), bt[idx]=true marks idx is in lnk
1143:     prow      - the row number of idx
1144:   output Parameters:
1145:     nlnk     - number of newly added idx
1146:     lnk      - the sorted(increasing order) linked list containing new and non-redundate entries from idx
1147:     lnklvl   - levels of lnk
1148:     bt       - updated PetscBT (bitarray)

1150:   Note: the level of factor(i,j) is set as lvl(i,j) = min{ lvl(i,j), lvl(i,prow)+lvl(prow,j)+1)
1151:         where idx = non-zero columns of U(prow,prow+1:n-1), prow<i
1152: */
1153: #define PetscILULLAddSorted(nidx,idx,level,idxlvl,idx_start,nlnk,lnk,lnklvl,bt,lnklvl_prow) 0;\
1154: {\
1155:   PetscInt _k,_entry,_location,_lnkdata,_incrlev,_lnklvl_prow=lnklvl[prow];\
1156:   nlnk     = 0;\
1157:   _lnkdata = idx_start;\
1158:   for (_k=0; _k<nidx; _k++){\
1159:     _incrlev = idxlvl[_k] + _lnklvl_prow + 1;\
1160:     if (_incrlev > level) continue;\
1161:     _entry = idx[_k];\
1162:     if (!PetscBTLookupSet(bt,_entry)){  /* new entry */\
1163:       /* search for insertion location */\
1164:       do {\
1165:         _location = _lnkdata;\
1166:         _lnkdata  = lnk[_location];\
1167:       } while (_entry > _lnkdata);\
1168:       /* insertion location is found, add entry into lnk */\
1169:       lnk[_location]  = _entry;\
1170:       lnk[_entry]     = _lnkdata;\
1171:       lnklvl[_entry] = _incrlev;\
1172:       nlnk++;\
1173:       _lnkdata = _entry; /* next search starts from here if next_entry > _entry */\
1174:     } else { /* existing entry: update lnklvl */\
1175:       if (lnklvl[_entry] > _incrlev) lnklvl[_entry] = _incrlev;\
1176:     }\
1177:   }\
1178: }

1180: /*
1181:   Add a index set into a sorted linked list
1182:   Input Parameters:
1183:     nidx      - number of input idx
1184:     idx   - integer array used for storing column indices
1185:     level     - level of fill, e.g., ICC(level)
1186:     idxlvl - level of idx
1187:     idx_start - starting index of the list
1188:     lnk       - linked list(an integer array) that is created
1189:     lnklvl   - levels of lnk
1190:     bt        - PetscBT (bitarray), bt[idx]=true marks idx is in lnk
1191:   output Parameters:
1192:     nlnk      - number of newly added idx
1193:     lnk       - the sorted(increasing order) linked list containing new and non-redundate entries from idx
1194:     lnklvl   - levels of lnk
1195:     bt        - updated PetscBT (bitarray)
1196: */
1197: #define PetscIncompleteLLAdd(nidx,idx,level,idxlvl,idx_start,nlnk,lnk,lnklvl,bt) 0;\
1198: {\
1199:   PetscInt _k,_entry,_location,_lnkdata,_incrlev;\
1200:   nlnk     = 0;\
1201:   _lnkdata = idx_start;\
1202:   for (_k=0; _k<nidx; _k++){\
1203:     _incrlev = idxlvl[_k] + 1;\
1204:     if (_incrlev > level) continue;\
1205:     _entry = idx[_k];\
1206:     if (!PetscBTLookupSet(bt,_entry)){  /* new entry */\
1207:       /* search for insertion location */\
1208:       if (_k && _entry < _lnkdata) _lnkdata  = idx_start;\
1209:       do {\
1210:         _location = _lnkdata;\
1211:         _lnkdata  = lnk[_location];\
1212:       } while (_entry > _lnkdata);\
1213:       /* insertion location is found, add entry into lnk */\
1214:       lnk[_location]  = _entry;\
1215:       lnk[_entry]     = _lnkdata;\
1216:       lnklvl[_entry] = _incrlev;\
1217:       nlnk++;\
1218:       _lnkdata = _entry; /* next search starts from here if next_entry > _entry */\
1219:     } else { /* existing entry: update lnklvl */\
1220:       if (lnklvl[_entry] > _incrlev) lnklvl[_entry] = _incrlev;\
1221:     }\
1222:   }\
1223: }

1225: /*
1226:   Add a SORTED index set into a sorted linked list
1227:   Input Parameters:
1228:     nidx      - number of input indices
1229:     idx   - sorted integer array used for storing column indices
1230:     level     - level of fill, e.g., ICC(level)
1231:     idxlvl - level of idx
1232:     idx_start - starting index of the list
1233:     lnk       - linked list(an integer array) that is created
1234:     lnklvl    - levels of lnk
1235:     bt        - PetscBT (bitarray), bt[idx]=true marks idx is in lnk
1236:   output Parameters:
1237:     nlnk      - number of newly added idx
1238:     lnk       - the sorted(increasing order) linked list containing new and non-redundate entries from idx
1239:     lnklvl    - levels of lnk
1240:     bt        - updated PetscBT (bitarray)
1241: */
1242: #define PetscIncompleteLLAddSorted(nidx,idx,level,idxlvl,idx_start,nlnk,lnk,lnklvl,bt) 0;\
1243: {\
1244:   PetscInt _k,_entry,_location,_lnkdata,_incrlev;\
1245:   nlnk = 0;\
1246:   _lnkdata = idx_start;\
1247:   for (_k=0; _k<nidx; _k++){\
1248:     _incrlev = idxlvl[_k] + 1;\
1249:     if (_incrlev > level) continue;\
1250:     _entry = idx[_k];\
1251:     if (!PetscBTLookupSet(bt,_entry)){  /* new entry */\
1252:       /* search for insertion location */\
1253:       do {\
1254:         _location = _lnkdata;\
1255:         _lnkdata  = lnk[_location];\
1256:       } while (_entry > _lnkdata);\
1257:       /* insertion location is found, add entry into lnk */\
1258:       lnk[_location] = _entry;\
1259:       lnk[_entry]    = _lnkdata;\
1260:       lnklvl[_entry] = _incrlev;\
1261:       nlnk++;\
1262:       _lnkdata = _entry; /* next search starts from here */\
1263:     } else { /* existing entry: update lnklvl */\
1264:       if (lnklvl[_entry] > _incrlev) lnklvl[_entry] = _incrlev;\
1265:     }\
1266:   }\
1267: }

1269: /*
1270:   Add a SORTED index set into a sorted linked list for ICC
1271:   Input Parameters:
1272:     nidx      - number of input indices
1273:     idx       - sorted integer array used for storing column indices
1274:     level     - level of fill, e.g., ICC(level)
1275:     idxlvl    - level of idx
1276:     idx_start - starting index of the list
1277:     lnk       - linked list(an integer array) that is created
1278:     lnklvl    - levels of lnk
1279:     bt        - PetscBT (bitarray), bt[idx]=true marks idx is in lnk
1280:     idxlvl_prow - idxlvl[prow], where prow is the row number of the idx
1281:   output Parameters:
1282:     nlnk   - number of newly added indices
1283:     lnk    - the sorted(increasing order) linked list containing new and non-redundate entries from idx
1284:     lnklvl - levels of lnk
1285:     bt     - updated PetscBT (bitarray)
1286:   Note: the level of U(i,j) is set as lvl(i,j) = min{ lvl(i,j), lvl(prow,i)+lvl(prow,j)+1)
1287:         where idx = non-zero columns of U(prow,prow+1:n-1), prow<i
1288: */
1289: #define PetscICCLLAddSorted(nidx,idx,level,idxlvl,idx_start,nlnk,lnk,lnklvl,bt,idxlvl_prow) 0;\
1290: {\
1291:   PetscInt _k,_entry,_location,_lnkdata,_incrlev;\
1292:   nlnk = 0;\
1293:   _lnkdata = idx_start;\
1294:   for (_k=0; _k<nidx; _k++){\
1295:     _incrlev = idxlvl[_k] + idxlvl_prow + 1;\
1296:     if (_incrlev > level) continue;\
1297:     _entry = idx[_k];\
1298:     if (!PetscBTLookupSet(bt,_entry)){  /* new entry */\
1299:       /* search for insertion location */\
1300:       do {\
1301:         _location = _lnkdata;\
1302:         _lnkdata  = lnk[_location];\
1303:       } while (_entry > _lnkdata);\
1304:       /* insertion location is found, add entry into lnk */\
1305:       lnk[_location] = _entry;\
1306:       lnk[_entry]    = _lnkdata;\
1307:       lnklvl[_entry] = _incrlev;\
1308:       nlnk++;\
1309:       _lnkdata = _entry; /* next search starts from here */\
1310:     } else { /* existing entry: update lnklvl */\
1311:       if (lnklvl[_entry] > _incrlev) lnklvl[_entry] = _incrlev;\
1312:     }\
1313:   }\
1314: }

1316: /*
1317:   Copy data on the list into an array, then initialize the list
1318:   Input Parameters:
1319:     idx_start - starting index of the list
1320:     lnk_max   - max value of lnk indicating the end of the list
1321:     nlnk      - number of data on the list to be copied
1322:     lnk       - linked list
1323:     lnklvl    - level of lnk
1324:     bt        - PetscBT (bitarray), bt[idx]=true marks idx is in lnk
1325:   output Parameters:
1326:     indices - array that contains the copied data
1327:     lnk     - linked list that is cleaned and initialize
1328:     lnklvl  - level of lnk that is reinitialized
1329:     bt      - PetscBT (bitarray) with all bits set to false
1330: */
1331: #define PetscIncompleteLLClean(idx_start,lnk_max,nlnk,lnk,lnklvl,indices,indiceslvl,bt) 0;\
1332: do {\
1333:   PetscInt _j,_idx=idx_start;\
1334:   for (_j=0; _j<nlnk; _j++){\
1335:     _idx = lnk[_idx];\
1336:     *(indices+_j) = _idx;\
1337:     *(indiceslvl+_j) = lnklvl[_idx];\
1338:     lnklvl[_idx] = -1;\
1339:     PetscBTClear(bt,_idx);\
1340:   }\
1341:   lnk[idx_start] = lnk_max;\
1342: } while (0)
1343: /*
1344:   Free memories used by the list
1345: */
1346: #define PetscIncompleteLLDestroy(lnk,bt) (PetscFree(lnk) || PetscBTDestroy(&(bt)))

1348: #define MatCheckSameLocalSize(A,ar1,B,ar2) do { \
1350:   if ((A->rmap->n != B->rmap->n) || (A->cmap->n != B->cmap->n)) SETERRQ6(PETSC_COMM_SELF,PETSC_ERR_ARG_INCOMP,"Incompatible matrix local sizes: parameter # %d (%D x %D) != parameter # %d (%D x %D)",ar1,A->rmap->n,A->cmap->n,ar2,B->rmap->n,B->cmap->n);} while (0)

1352: #define MatCheckSameSize(A,ar1,B,ar2) do { \
1353:   if ((A->rmap->N != B->rmap->N) || (A->cmap->N != B->cmap->N)) SETERRQ6(PetscObjectComm((PetscObject)A),PETSC_ERR_ARG_INCOMP,"Incompatible matrix global sizes: parameter # %d (%D x %D) != parameter # %d (%D x %D)",ar1,A->rmap->N,A->cmap->N,ar2,B->rmap->N,B->cmap->N);\
1354:   MatCheckSameLocalSize(A,ar1,B,ar2);} while (0)

1356: #define VecCheckMatCompatible(M,x,ar1,b,ar2) do { \
1357:   if (M->cmap->N != x->map->N) SETERRQ3(PetscObjectComm((PetscObject)M),PETSC_ERR_ARG_SIZ,"Vector global length incompatible with matrix: parameter # %d global size %D != matrix column global size %D",ar1,x->map->N,M->cmap->N); \
1358:   if (M->rmap->N != b->map->N) SETERRQ3(PetscObjectComm((PetscObject)M),PETSC_ERR_ARG_SIZ,"Vector global length incompatible with matrix: parameter # %d global size %D != matrix row global size %D",ar2,b->map->N,M->rmap->N);} while (0)

1360: /* -------------------------------------------------------------------------------------------------------*/
1361: #include <petscbt.h>
1362: /*
1363:   Create and initialize a condensed linked list -
1364:     same as PetscLLCreate(), but uses a scalable array 'lnk' with size of max number of entries, not O(N).
1365:     Barry suggested this approach (Dec. 6, 2011):
1366:       I've thought of an alternative way of representing a linked list that is efficient but doesn't have the O(N) scaling issue
1367:       (it may be faster than the O(N) even sequentially due to less crazy memory access).

1369:       Instead of having some like  a  2  -> 4 -> 11 ->  22  list that uses slot 2  4 11 and 22 in a big array use a small array with two slots
1370:       for each entry for example  [ 2 1 | 4 3 | 22 -1 | 11 2]   so the first number (of the pair) is the value while the second tells you where
1371:       in the list the next entry is. Inserting a new link means just append another pair at the end. For example say we want to insert 13 into the
1372:       list it would then become [2 1 | 4 3 | 22 -1 | 11 4 | 13 2 ] you just add a pair at the end and fix the point for the one that points to it.
1373:       That is 11 use to point to the 2 slot, after the change 11 points to the 4th slot which has the value 13. Note that values are always next
1374:       to each other so memory access is much better than using the big array.

1376:   Example:
1377:      nlnk_max=5, lnk_max=36:
1378:      Initial list: [0, 0 | 36, 2 | 0, 0 | 0, 0 | 0, 0 | 0, 0 | 0, 0]
1379:      here, head_node has index 2 with value lnk[2]=lnk_max=36,
1380:            0-th entry is used to store the number of entries in the list,
1381:      The initial lnk represents head -> tail(marked by 36) with number of entries = lnk[0]=0.

1383:      Now adding a sorted set {2,4}, the list becomes
1384:      [2, 0 | 36, 4 |2, 6 | 4, 2 | 0, 0 | 0, 0 | 0, 0 ]
1385:      represents head -> 2 -> 4 -> tail with number of entries = lnk[0]=2.

1387:      Then adding a sorted set {0,3,35}, the list
1388:      [5, 0 | 36, 8 | 2, 10 | 4, 12 | 0, 4 | 3, 6 | 35, 2 ]
1389:      represents head -> 0 -> 2 -> 3 -> 4 -> 35 -> tail with number of entries = lnk[0]=5.

1391:   Input Parameters:
1392:     nlnk_max  - max length of the list
1393:     lnk_max   - max value of the entries
1394:   Output Parameters:
1395:     lnk       - list created and initialized
1396:     bt        - PetscBT (bitarray) with all bits set to false. Note: bt has size lnk_max, not nln_max!
1397: */
1398: PETSC_STATIC_INLINE PetscErrorCode PetscLLCondensedCreate(PetscInt nlnk_max,PetscInt lnk_max,PetscInt **lnk,PetscBT *bt)
1399: {
1401:   PetscInt       *llnk,lsize = 0;

1404:   PetscIntMultError(2,nlnk_max+2,&lsize);
1405:   PetscMalloc1(lsize,lnk);
1406:   PetscBTCreate(lnk_max,bt);
1407:   llnk = *lnk;
1408:   llnk[0] = 0;         /* number of entries on the list */
1409:   llnk[2] = lnk_max;   /* value in the head node */
1410:   llnk[3] = 2;         /* next for the head node */
1411:   return(0);
1412: }

1414: /*
1415:   Add a SORTED ascending index set into a sorted linked list. See PetscLLCondensedCreate() for detailed description.
1416:   Input Parameters:
1417:     nidx      - number of input indices
1418:     indices   - sorted integer array
1419:     lnk       - condensed linked list(an integer array) that is created
1420:     bt        - PetscBT (bitarray), bt[idx]=true marks idx is in lnk
1421:   output Parameters:
1422:     lnk       - the sorted(increasing order) linked list containing previous and newly added non-redundate indices
1423:     bt        - updated PetscBT (bitarray)
1424: */
1425: PETSC_STATIC_INLINE PetscErrorCode PetscLLCondensedAddSorted(PetscInt nidx,const PetscInt indices[],PetscInt lnk[],PetscBT bt)
1426: {
1427:   PetscInt _k,_entry,_location,_next,_lnkdata,_nlnk,_newnode;

1430:   _nlnk     = lnk[0]; /* num of entries on the input lnk */
1431:   _location = 2; /* head */
1432:     for (_k=0; _k<nidx; _k++){
1433:       _entry = indices[_k];
1434:       if (!PetscBTLookupSet(bt,_entry)){  /* new entry */
1435:         /* search for insertion location */
1436:         do {
1437:           _next     = _location + 1; /* link from previous node to next node */
1438:           _location = lnk[_next];    /* idx of next node */
1439:           _lnkdata  = lnk[_location];/* value of next node */
1440:         } while (_entry > _lnkdata);
1441:         /* insertion location is found, add entry into lnk */
1442:         _newnode        = 2*(_nlnk+2);   /* index for this new node */
1443:         lnk[_next]      = _newnode;      /* connect previous node to the new node */
1444:         lnk[_newnode]   = _entry;        /* set value of the new node */
1445:         lnk[_newnode+1] = _location;     /* connect new node to next node */
1446:         _location       = _newnode;      /* next search starts from the new node */
1447:         _nlnk++;
1448:       }   \
1449:     }\
1450:   lnk[0]   = _nlnk;   /* number of entries in the list */
1451:   return(0);
1452: }

1454: PETSC_STATIC_INLINE PetscErrorCode PetscLLCondensedClean(PetscInt lnk_max,PetscInt nidx,PetscInt *indices,PetscInt lnk[],PetscBT bt)
1455: {
1457:   PetscInt       _k,_next,_nlnk;

1460:   _next = lnk[3];       /* head node */
1461:   _nlnk = lnk[0];       /* num of entries on the list */
1462:   for (_k=0; _k<_nlnk; _k++){
1463:     indices[_k] = lnk[_next];
1464:     _next       = lnk[_next + 1];
1465:     PetscBTClear(bt,indices[_k]);
1466:   }
1467:   lnk[0] = 0;          /* num of entries on the list */
1468:   lnk[2] = lnk_max;    /* initialize head node */
1469:   lnk[3] = 2;          /* head node */
1470:   return(0);
1471: }

1473: PETSC_STATIC_INLINE PetscErrorCode PetscLLCondensedView(PetscInt *lnk)
1474: {
1476:   PetscInt       k;

1479:   PetscPrintf(PETSC_COMM_SELF,"LLCondensed of size %D, (val,  next)\n",lnk[0]);
1480:   for (k=2; k< lnk[0]+2; k++){
1481:     PetscPrintf(PETSC_COMM_SELF," %D: (%D, %D)\n",2*k,lnk[2*k],lnk[2*k+1]);
1482:   }
1483:   return(0);
1484: }

1486: /*
1487:   Free memories used by the list
1488: */
1489: PETSC_STATIC_INLINE PetscErrorCode PetscLLCondensedDestroy(PetscInt *lnk,PetscBT bt)
1490: {

1494:   PetscFree(lnk);
1495:   PetscBTDestroy(&bt);
1496:   return(0);
1497: }

1499: /* -------------------------------------------------------------------------------------------------------*/
1500: /*
1501:  Same as PetscLLCondensedCreate(), but does not use non-scalable O(lnk_max) bitarray
1502:   Input Parameters:
1503:     nlnk_max  - max length of the list
1504:   Output Parameters:
1505:     lnk       - list created and initialized
1506: */
1507: PETSC_STATIC_INLINE PetscErrorCode PetscLLCondensedCreate_Scalable(PetscInt nlnk_max,PetscInt **lnk)
1508: {
1510:   PetscInt       *llnk,lsize = 0;

1513:   PetscIntMultError(2,nlnk_max+2,&lsize);
1514:   PetscMalloc1(lsize,lnk);
1515:   llnk = *lnk;
1516:   llnk[0] = 0;               /* number of entries on the list */
1517:   llnk[2] = PETSC_MAX_INT;   /* value in the head node */
1518:   llnk[3] = 2;               /* next for the head node */
1519:   return(0);
1520: }

1522: PETSC_STATIC_INLINE PetscErrorCode PetscLLCondensedExpand_Scalable(PetscInt nlnk_max,PetscInt **lnk)
1523: {
1525:   PetscInt       lsize = 0;

1528:   PetscIntMultError(2,nlnk_max+2,&lsize);
1529:   PetscRealloc(lsize*sizeof(PetscInt),lnk);
1530:   return(0);
1531: }

1533: PETSC_STATIC_INLINE PetscErrorCode PetscLLCondensedAddSorted_Scalable(PetscInt nidx,const PetscInt indices[],PetscInt lnk[])
1534: {
1535:   PetscInt _k,_entry,_location,_next,_lnkdata,_nlnk,_newnode;
1536:   _nlnk     = lnk[0]; /* num of entries on the input lnk */
1537:   _location = 2; /* head */ \
1538:     for (_k=0; _k<nidx; _k++){
1539:       _entry = indices[_k];
1540:       /* search for insertion location */
1541:       do {
1542:         _next     = _location + 1; /* link from previous node to next node */
1543:         _location = lnk[_next];    /* idx of next node */
1544:         _lnkdata  = lnk[_location];/* value of next node */
1545:       } while (_entry > _lnkdata);
1546:       if (_entry < _lnkdata) {
1547:         /* insertion location is found, add entry into lnk */
1548:         _newnode        = 2*(_nlnk+2);   /* index for this new node */
1549:         lnk[_next]      = _newnode;      /* connect previous node to the new node */
1550:         lnk[_newnode]   = _entry;        /* set value of the new node */
1551:         lnk[_newnode+1] = _location;     /* connect new node to next node */
1552:         _location       = _newnode;      /* next search starts from the new node */
1553:         _nlnk++;
1554:       }
1555:     }
1556:   lnk[0]   = _nlnk;   /* number of entries in the list */
1557:   return 0;
1558: }

1560: PETSC_STATIC_INLINE PetscErrorCode PetscLLCondensedClean_Scalable(PetscInt nidx,PetscInt *indices,PetscInt *lnk)
1561: {
1562:   PetscInt _k,_next,_nlnk;
1563:   _next = lnk[3];       /* head node */
1564:   _nlnk = lnk[0];
1565:   for (_k=0; _k<_nlnk; _k++){
1566:     indices[_k] = lnk[_next];
1567:     _next       = lnk[_next + 1];
1568:   }
1569:   lnk[0] = 0;          /* num of entries on the list */
1570:   lnk[3] = 2;          /* head node */
1571:   return 0;
1572: }

1574: PETSC_STATIC_INLINE PetscErrorCode PetscLLCondensedDestroy_Scalable(PetscInt *lnk)
1575: {
1576:   return PetscFree(lnk);
1577: }

1579: /* -------------------------------------------------------------------------------------------------------*/
1580: /*
1581:       lnk[0]   number of links
1582:       lnk[1]   number of entries
1583:       lnk[3n]  value
1584:       lnk[3n+1] len
1585:       lnk[3n+2] link to next value

1587:       The next three are always the first link

1589:       lnk[3]    PETSC_MIN_INT+1
1590:       lnk[4]    1
1591:       lnk[5]    link to first real entry

1593:       The next three are always the last link

1595:       lnk[6]    PETSC_MAX_INT - 1
1596:       lnk[7]    1
1597:       lnk[8]    next valid link (this is the same as lnk[0] but without the decreases)
1598: */

1600: PETSC_STATIC_INLINE PetscErrorCode PetscLLCondensedCreate_fast(PetscInt nlnk_max,PetscInt **lnk)
1601: {
1603:   PetscInt       *llnk,lsize = 0;

1606:   PetscIntMultError(3,nlnk_max+3,&lsize);
1607:   PetscMalloc1(lsize,lnk);
1608:   llnk = *lnk;
1609:   llnk[0] = 0;   /* nlnk: number of entries on the list */
1610:   llnk[1] = 0;          /* number of integer entries represented in list */
1611:   llnk[3] = PETSC_MIN_INT+1;   /* value in the first node */
1612:   llnk[4] = 1;           /* count for the first node */
1613:   llnk[5] = 6;         /* next for the first node */
1614:   llnk[6] = PETSC_MAX_INT-1;   /* value in the last node */
1615:   llnk[7] = 1;           /* count for the last node */
1616:   llnk[8] = 0;         /* next valid node to be used */
1617:   return(0);
1618: }

1620: PETSC_STATIC_INLINE PetscErrorCode PetscLLCondensedAddSorted_fast(PetscInt nidx,const PetscInt indices[],PetscInt lnk[])
1621: {
1622:   PetscInt k,entry,prev,next;
1623:   prev      = 3;      /* first value */
1624:   next      = lnk[prev+2];
1625:   for (k=0; k<nidx; k++){
1626:     entry = indices[k];
1627:     /* search for insertion location */
1628:     while (entry >= lnk[next]) {
1629:       prev = next;
1630:       next = lnk[next+2];
1631:     }
1632:     /* entry is in range of previous list */
1633:     if (entry < lnk[prev]+lnk[prev+1]) continue;
1634:     lnk[1]++;
1635:     /* entry is right after previous list */
1636:     if (entry == lnk[prev]+lnk[prev+1]) {
1637:       lnk[prev+1]++;
1638:       if (lnk[next] == entry+1) { /* combine two contiguous strings */
1639:         lnk[prev+1] += lnk[next+1];
1640:         lnk[prev+2]  = lnk[next+2];
1641:         next         = lnk[next+2];
1642:         lnk[0]--;
1643:       }
1644:       continue;
1645:     }
1646:     /* entry is right before next list */
1647:     if (entry == lnk[next]-1) {
1648:       lnk[next]--;
1649:       lnk[next+1]++;
1650:       prev = next;
1651:       next = lnk[prev+2];
1652:       continue;
1653:     }
1654:     /*  add entry into lnk */
1655:     lnk[prev+2]    = 3*((lnk[8]++)+3);      /* connect previous node to the new node */
1656:     prev           = lnk[prev+2];
1657:     lnk[prev]      = entry;        /* set value of the new node */
1658:     lnk[prev+1]    = 1;             /* number of values in contiguous string is one to start */
1659:     lnk[prev+2]    = next;          /* connect new node to next node */
1660:     lnk[0]++;
1661:   }
1662:   return 0;
1663: }

1665: PETSC_STATIC_INLINE PetscErrorCode PetscLLCondensedClean_fast(PetscInt nidx,PetscInt *indices,PetscInt *lnk)
1666: {
1667:   PetscInt _k,_next,_nlnk,cnt,j;
1668:   _next = lnk[5];       /* first node */
1669:   _nlnk = lnk[0];
1670:   cnt   = 0;
1671:   for (_k=0; _k<_nlnk; _k++){
1672:     for (j=0; j<lnk[_next+1]; j++) {
1673:       indices[cnt++] = lnk[_next] + j;
1674:     }
1675:     _next       = lnk[_next + 2];
1676:   }
1677:   lnk[0] = 0;   /* nlnk: number of links */
1678:   lnk[1] = 0;          /* number of integer entries represented in list */
1679:   lnk[3] = PETSC_MIN_INT+1;   /* value in the first node */
1680:   lnk[4] = 1;           /* count for the first node */
1681:   lnk[5] = 6;         /* next for the first node */
1682:   lnk[6] = PETSC_MAX_INT-1;   /* value in the last node */
1683:   lnk[7] = 1;           /* count for the last node */
1684:   lnk[8] = 0;         /* next valid location to make link */
1685:   return 0;
1686: }

1688: PETSC_STATIC_INLINE PetscErrorCode PetscLLCondensedView_fast(PetscInt *lnk)
1689: {
1690:   PetscInt k,next,nlnk;
1691:   next = lnk[5];       /* first node */
1692:   nlnk = lnk[0];
1693:   for (k=0; k<nlnk; k++){
1694: #if 0                           /* Debugging code */
1695:     printf("%d value %d len %d next %d\n",next,lnk[next],lnk[next+1],lnk[next+2]);
1696: #endif
1697:     next = lnk[next + 2];
1698:   }
1699:   return 0;
1700: }

1702: PETSC_STATIC_INLINE PetscErrorCode PetscLLCondensedDestroy_fast(PetscInt *lnk)
1703: {
1704:   return PetscFree(lnk);
1705: }

1707: /* this is extern because it is used in MatFDColoringUseDM() which is in the DM library */
1708: PETSC_EXTERN PetscErrorCode MatFDColoringApply_AIJ(Mat,MatFDColoring,Vec,void*);

1710: PETSC_EXTERN PetscLogEvent MAT_Mult;
1711: PETSC_EXTERN PetscLogEvent MAT_MultMatrixFree;
1712: PETSC_EXTERN PetscLogEvent MAT_Mults;
1713: PETSC_EXTERN PetscLogEvent MAT_MultConstrained;
1714: PETSC_EXTERN PetscLogEvent MAT_MultAdd;
1715: PETSC_EXTERN PetscLogEvent MAT_MultTranspose;
1716: PETSC_EXTERN PetscLogEvent MAT_MultTransposeConstrained;
1717: PETSC_EXTERN PetscLogEvent MAT_MultTransposeAdd;
1718: PETSC_EXTERN PetscLogEvent MAT_Solve;
1719: PETSC_EXTERN PetscLogEvent MAT_Solves;
1720: PETSC_EXTERN PetscLogEvent MAT_SolveAdd;
1721: PETSC_EXTERN PetscLogEvent MAT_SolveTranspose;
1722: PETSC_EXTERN PetscLogEvent MAT_SolveTransposeAdd;
1723: PETSC_EXTERN PetscLogEvent MAT_SOR;
1724: PETSC_EXTERN PetscLogEvent MAT_ForwardSolve;
1725: PETSC_EXTERN PetscLogEvent MAT_BackwardSolve;
1726: PETSC_EXTERN PetscLogEvent MAT_LUFactor;
1727: PETSC_EXTERN PetscLogEvent MAT_LUFactorSymbolic;
1728: PETSC_EXTERN PetscLogEvent MAT_LUFactorNumeric;
1729: PETSC_EXTERN PetscLogEvent MAT_CholeskyFactor;
1730: PETSC_EXTERN PetscLogEvent MAT_CholeskyFactorSymbolic;
1731: PETSC_EXTERN PetscLogEvent MAT_CholeskyFactorNumeric;
1732: PETSC_EXTERN PetscLogEvent MAT_ILUFactor;
1733: PETSC_EXTERN PetscLogEvent MAT_ILUFactorSymbolic;
1734: PETSC_EXTERN PetscLogEvent MAT_ICCFactorSymbolic;
1735: PETSC_EXTERN PetscLogEvent MAT_Copy;
1736: PETSC_EXTERN PetscLogEvent MAT_Convert;
1737: PETSC_EXTERN PetscLogEvent MAT_Scale;
1738: PETSC_EXTERN PetscLogEvent MAT_AssemblyBegin;
1739: PETSC_EXTERN PetscLogEvent MAT_AssemblyEnd;
1740: PETSC_EXTERN PetscLogEvent MAT_SetValues;
1741: PETSC_EXTERN PetscLogEvent MAT_GetValues;
1742: PETSC_EXTERN PetscLogEvent MAT_GetRow;
1743: PETSC_EXTERN PetscLogEvent MAT_GetRowIJ;
1744: PETSC_EXTERN PetscLogEvent MAT_CreateSubMats;
1745: PETSC_EXTERN PetscLogEvent MAT_GetColoring;
1746: PETSC_EXTERN PetscLogEvent MAT_GetOrdering;
1747: PETSC_EXTERN PetscLogEvent MAT_RedundantMat;
1748: PETSC_EXTERN PetscLogEvent MAT_IncreaseOverlap;
1749: PETSC_EXTERN PetscLogEvent MAT_Partitioning;
1750: PETSC_EXTERN PetscLogEvent MAT_PartitioningND;
1751: PETSC_EXTERN PetscLogEvent MAT_Coarsen;
1752: PETSC_EXTERN PetscLogEvent MAT_ZeroEntries;
1753: PETSC_EXTERN PetscLogEvent MAT_Load;
1754: PETSC_EXTERN PetscLogEvent MAT_View;
1755: PETSC_EXTERN PetscLogEvent MAT_AXPY;
1756: PETSC_EXTERN PetscLogEvent MAT_FDColoringCreate;
1757: PETSC_EXTERN PetscLogEvent MAT_TransposeColoringCreate;
1758: PETSC_EXTERN PetscLogEvent MAT_FDColoringSetUp;
1759: PETSC_EXTERN PetscLogEvent MAT_FDColoringApply;
1760: PETSC_EXTERN PetscLogEvent MAT_Transpose;
1761: PETSC_EXTERN PetscLogEvent MAT_FDColoringFunction;
1762: PETSC_EXTERN PetscLogEvent MAT_CreateSubMat;
1763: PETSC_EXTERN PetscLogEvent MAT_MatSolve;
1764: PETSC_EXTERN PetscLogEvent MAT_MatTrSolve;
1765: PETSC_EXTERN PetscLogEvent MAT_MatMultSymbolic;
1766: PETSC_EXTERN PetscLogEvent MAT_MatMultNumeric;
1767: PETSC_EXTERN PetscLogEvent MAT_Getlocalmatcondensed;
1768: PETSC_EXTERN PetscLogEvent MAT_GetBrowsOfAcols;
1769: PETSC_EXTERN PetscLogEvent MAT_GetBrowsOfAocols;
1770: PETSC_EXTERN PetscLogEvent MAT_PtAPSymbolic;
1771: PETSC_EXTERN PetscLogEvent MAT_PtAPNumeric;
1772: PETSC_EXTERN PetscLogEvent MAT_Seqstompinum;
1773: PETSC_EXTERN PetscLogEvent MAT_Seqstompisym;
1774: PETSC_EXTERN PetscLogEvent MAT_Seqstompi;
1775: PETSC_EXTERN PetscLogEvent MAT_Getlocalmat;
1776: PETSC_EXTERN PetscLogEvent MAT_RARtSymbolic;
1777: PETSC_EXTERN PetscLogEvent MAT_RARtNumeric;
1778: PETSC_EXTERN PetscLogEvent MAT_MatTransposeMultSymbolic;
1779: PETSC_EXTERN PetscLogEvent MAT_MatTransposeMultNumeric;
1780: PETSC_EXTERN PetscLogEvent MAT_TransposeMatMultSymbolic;
1781: PETSC_EXTERN PetscLogEvent MAT_TransposeMatMultNumeric;
1782: PETSC_EXTERN PetscLogEvent MAT_MatMatMultSymbolic;
1783: PETSC_EXTERN PetscLogEvent MAT_MatMatMultNumeric;
1784: PETSC_EXTERN PetscLogEvent MAT_Applypapt;
1785: PETSC_EXTERN PetscLogEvent MAT_Applypapt_symbolic;
1786: PETSC_EXTERN PetscLogEvent MAT_Applypapt_numeric;
1787: PETSC_EXTERN PetscLogEvent MAT_Getsymtranspose;
1788: PETSC_EXTERN PetscLogEvent MAT_Getsymtransreduced;
1789: PETSC_EXTERN PetscLogEvent MAT_GetSequentialNonzeroStructure;
1790: PETSC_EXTERN PetscLogEvent MATMFFD_Mult;
1791: PETSC_EXTERN PetscLogEvent MAT_GetMultiProcBlock;
1792: PETSC_EXTERN PetscLogEvent MAT_CUSPARSECopyToGPU;
1793: PETSC_EXTERN PetscLogEvent MAT_CUSPARSECopyFromGPU;
1794: PETSC_EXTERN PetscLogEvent MAT_CUSPARSEGenerateTranspose;
1795: PETSC_EXTERN PetscLogEvent MAT_CUSPARSESolveAnalysis;
1796: PETSC_EXTERN PetscLogEvent MAT_SetValuesBatch;
1797: PETSC_EXTERN PetscLogEvent MAT_ViennaCLCopyToGPU;
1798: PETSC_EXTERN PetscLogEvent MAT_DenseCopyToGPU;
1799: PETSC_EXTERN PetscLogEvent MAT_DenseCopyFromGPU;
1800: PETSC_EXTERN PetscLogEvent MAT_Merge;
1801: PETSC_EXTERN PetscLogEvent MAT_Residual;
1802: PETSC_EXTERN PetscLogEvent MAT_SetRandom;
1803: PETSC_EXTERN PetscLogEvent MAT_FactorFactS;
1804: PETSC_EXTERN PetscLogEvent MAT_FactorInvS;
1805: PETSC_EXTERN PetscLogEvent MAT_PreallCOO;
1806: PETSC_EXTERN PetscLogEvent MAT_SetVCOO;
1807: PETSC_EXTERN PetscLogEvent MATCOLORING_Apply;
1808: PETSC_EXTERN PetscLogEvent MATCOLORING_Comm;
1809: PETSC_EXTERN PetscLogEvent MATCOLORING_Local;
1810: PETSC_EXTERN PetscLogEvent MATCOLORING_ISCreate;
1811: PETSC_EXTERN PetscLogEvent MATCOLORING_SetUp;
1812: PETSC_EXTERN PetscLogEvent MATCOLORING_Weights;

1814: #endif