xref: /petsc/include/petsc.h (revision 4ee90b5ea4b1ea789a057ce2e6ee891e15dba83a)
1 /* $Id: petsc.h,v 1.297 2001/09/07 20:13:16 bsmith Exp $ */
2 /*
3    This is the main PETSc include file (for C and C++).  It is included by all
4    other PETSc include files, so it almost never has to be specifically included.
5 */
6 #if !defined(__PETSC_H)
7 #define __PETSC_H
8 
9 /* ========================================================================== */
10 /*
11    Current PETSc version number and release date
12 */
13 #include "petscversion.h"
14 
15 /* ========================================================================== */
16 /*
17    The PETSc configuration file.  Contains various definitions that
18    handle portability issues and the presence of machine features.
19 
20    petscconf.h is contained in bmake/${PETSC_ARCH}/petscconf.h it is
21    found automatically by the compiler due to the -I${PETSC_DIR}/bmake/${PETSC_ARCH}
22    in the bmake/common_variables definition of PETSC_INCLUDE
23 */
24 #include "petscconf.h"
25 
26 /* ========================================================================== */
27 
28 #include <stdio.h>
29 /*
30     Defines the interface to MPI allowing the use of all MPI functions.
31 */
32 #include "mpi.h"
33 
34 /*
35     EXTERN indicates a PETSc function defined elsewhere
36 */
37 #define EXTERN extern
38 
39 /*
40     Defines some elementary mathematics functions and constants.
41 */
42 #include "petscmath.h"
43 
44 /*
45        Basic PETSc constants
46 */
47 
48 /*E
49     PetscTruth - Logical variable. Actually an integer
50 
51    Level: beginner
52 
53 E*/
54 typedef enum { PETSC_FALSE,PETSC_TRUE } PetscTruth;
55 
56 #define PETSC_NULL           0
57 #define PETSC_DECIDE         -1
58 #define PETSC_DEFAULT        -2
59 
60 #define PETSC_YES            PETSC_TRUE
61 #define PETSC_NO             PETSC_FALSE
62 #define PETSC_IGNORE         PETSC_NULL
63 #define PETSC_DETERMINE      PETSC_DECIDE
64 
65 
66 extern MPI_Comm   PETSC_COMM_WORLD;
67 extern MPI_Comm   PETSC_COMM_SELF;
68 extern PetscTruth PetscInitializeCalled;
69 EXTERN int        PetscSetCommWorld(MPI_Comm);
70 EXTERN int        PetscSetHelpVersionFunctions(int (*)(MPI_Comm),int (*)(MPI_Comm));
71 
72 /*MC
73    PetscMalloc - Allocates memory
74 
75    Input Parameter:
76 .  m - number of bytes to allocate
77 
78    Output Parameter:
79 .  result - memory allocated
80 
81    Synopsis:
82    int PetscMalloc(int m,void **result)
83 
84    Level: beginner
85 
86    Notes: Memory is always allocated at least double aligned
87 
88 .seealso: PetscFree(), PetscNew()
89 
90   Concepts: memory allocation
91 
92 M*/
93 #define PetscMalloc(a,b)     (*PetscTrMalloc)((a),__LINE__,__FUNCT__,__FILE__,__SDIR__,(void**)(b))
94 /*MC
95    PetscNew - Allocates memory of a particular type
96 
97    Input Parameter:
98 . type - structure name of space to be allocated. Memory of size sizeof(type) is allocated
99 
100    Output Parameter:
101 .  result - memory allocated
102 
103    Synopsis:
104    int PetscNew(struct type,((type *))result)
105 
106    Level: beginner
107 
108 .seealso: PetscFree(), PetscMalloc()
109 
110   Concepts: memory allocation
111 
112 M*/
113 #define PetscNew(A,b)        PetscMalloc(sizeof(A),(b))
114 /*MC
115    PetscFree - Frees memory
116 
117    Input Parameter:
118 .   memory - memory to free
119 
120    Synopsis:
121    int PetscFree(void *memory)
122 
123    Level: beginner
124 
125    Notes: Memory must have been obtained with PetscNew() or PetscMalloc()
126 
127 .seealso: PetscNew(), PetscMalloc()
128 
129   Concepts: memory allocation
130 
131 M*/
132 #define PetscFree(a)         (*PetscTrFree)((a),__LINE__,__FUNCT__,__FILE__,__SDIR__)
133 EXTERN int  (*PetscTrMalloc)(int,int,char*,char*,char*,void**);
134 EXTERN int  (*PetscTrFree)(void *,int,char*,char*,char*);
135 EXTERN int  PetscSetMalloc(int (*)(int,int,char*,char*,char*,void**),int (*)(void *,int,char*,char*,char*));
136 EXTERN int  PetscClearMalloc(void);
137 
138 /*
139    Routines for tracing memory corruption/bleeding with default PETSc
140    memory allocation
141 */
142 EXTERN int   PetscTrDump(FILE *);
143 EXTERN int   PetscTrSpace(PetscLogDouble *,PetscLogDouble *,PetscLogDouble *);
144 EXTERN int   PetscTrValid(int,const char[],const char[],const char[]);
145 EXTERN int   PetscTrDebugLevel(int);
146 EXTERN int   PetscTrLog(void);
147 EXTERN int   PetscTrLogDump(FILE *);
148 EXTERN int   PetscGetResidentSetSize(PetscLogDouble *);
149 
150 /*
151     Variable type where we stash PETSc object pointers in Fortran.
152     Assumes that sizeof(long) == sizeof(void*)which is true on
153     all machines that we know.
154 */
155 #define PetscFortranAddr   long
156 
157 /*E
158     PetscDataType - Used for handling different basic data types.
159 
160    Level: beginner
161 
162 .seealso: PetscBinaryRead(), PetscBinaryWrite(), PetscDataTypeToMPIDataType(),
163           PetscDataTypeGetSize(), PetscDataTypeGetName()
164 
165 E*/
166 typedef enum {PETSC_INT = 0,PETSC_DOUBLE = 1,PETSC_COMPLEX = 2,
167               PETSC_LONG =3 ,PETSC_SHORT = 4,PETSC_FLOAT = 5,
168               PETSC_CHAR = 6,PETSC_LOGICAL = 7} PetscDataType;
169 #if defined(PETSC_USE_COMPLEX)
170 #define PETSC_SCALAR PETSC_COMPLEX
171 #else
172 #if defined(PETSC_USE_SINGLE)
173 #define PETSC_SCALAR PETSC_FLOAT
174 #else
175 #define PETSC_SCALAR PETSC_DOUBLE
176 #endif
177 #endif
178 #if defined(PETSC_USE_SINGLE)
179 #define PETSC_REAL PETSC_FLOAT
180 #else
181 #define PETSC_REAL PETSC_DOUBLE
182 #endif
183 #define PETSC_FORTRANADDR PETSC_LONG
184 
185 EXTERN int PetscDataTypeToMPIDataType(PetscDataType,MPI_Datatype*);
186 EXTERN int PetscDataTypeGetSize(PetscDataType,int*);
187 EXTERN int PetscDataTypeGetName(PetscDataType,char*[]);
188 
189 /*
190     Basic memory and string operations. These are usually simple wrappers
191    around the basic Unix system calls, but a few of them have additional
192    functionality and/or error checking.
193 */
194 EXTERN int   PetscMemcpy(void *,const void *,int);
195 EXTERN int   PetscBitMemcpy(void*,int,const void*,int,int,PetscDataType);
196 EXTERN int   PetscMemmove(void *,void *,int);
197 EXTERN int   PetscMemzero(void *,int);
198 EXTERN int   PetscMemcmp(const void*,const void*,int,PetscTruth *);
199 EXTERN int   PetscStrlen(const char[],int*);
200 EXTERN int   PetscStrcmp(const char[],const char[],PetscTruth *);
201 EXTERN int   PetscStrgrt(const char[],const char[],PetscTruth *);
202 EXTERN int   PetscStrcasecmp(const char[],const char[],PetscTruth*);
203 EXTERN int   PetscStrncmp(const char[],const char[],int,PetscTruth*);
204 EXTERN int   PetscStrcpy(char[],const char[]);
205 EXTERN int   PetscStrcat(char[],const char[]);
206 EXTERN int   PetscStrncat(char[],const char[],int);
207 EXTERN int   PetscStrncpy(char[],const char[],int);
208 EXTERN int   PetscStrchr(const char[],char,char **);
209 EXTERN int   PetscStrtolower(char[]);
210 EXTERN int   PetscStrrchr(const char[],char,char **);
211 EXTERN int   PetscStrstr(const char[],const char[],char **);
212 EXTERN int   PetscStrallocpy(const char[],char **);
213 EXTERN int   PetscStrreplace(MPI_Comm,const char[],char*,int);
214 #define      PetscStrfree(a) ((a) ? PetscFree(a) : 0)
215 typedef struct {char token;char *array;char *current;} PetscToken;
216 EXTERN int   PetscTokenCreate(const char[],const char,PetscToken**);
217 EXTERN int   PetscTokenFind(PetscToken*,char **);
218 EXTERN int   PetscTokenDestroy(PetscToken*);
219 
220 /*
221    These are  MPI operations for MPI_Allreduce() etc
222 */
223 EXTERN MPI_Op PetscMaxSum_Op;
224 #if defined(PETSC_USE_COMPLEX)
225 EXTERN MPI_Op PetscSum_Op;
226 #else
227 #define PetscSum_Op MPI_SUM
228 #endif
229 
230 /*S
231      PetscObject - any PETSc object, PetscViewer, Mat, Vec, SLES etc
232 
233    Level: beginner
234 
235 .seealso:  PetscObjectDestroy(), PetscObjectView(), PetscObjectGetName(), PetscObjectSetName()
236 S*/
237 typedef struct _p_PetscObject* PetscObject;
238 
239 /*S
240      PetscFList - Linked list of functions, possibly stored in dynamic libraries, accessed
241       by string name
242 
243    Level: advanced
244 
245 .seealso:  PetscFListAdd(), PetscFListDestroy()
246 S*/
247 typedef struct _PetscFList *PetscFList;
248 
249 #include "petscviewer.h"
250 #include "petscoptions.h"
251 
252 EXTERN int PetscShowMemoryUsage(PetscViewer,char*);
253 EXTERN int PetscGetTime(PetscLogDouble*);
254 EXTERN int PetscGetCPUTime(PetscLogDouble*);
255 EXTERN int PetscSleep(int);
256 
257 /*
258     Initialization of PETSc
259 */
260 EXTERN int  PetscInitialize(int*,char***,char[],const char[]);
261 EXTERN int  PetscInitializeNoArguments(void);
262 EXTERN int  PetscFinalize(void);
263 EXTERN int  PetscInitializeFortran(void);
264 EXTERN int  PetscGetArgs(int*,char ***);
265 EXTERN int  PetscEnd(void);
266 
267 /*
268    ParameterDict is an abstraction for arguments to interface mechanisms
269 */
270 extern int DICT_COOKIE;
271 typedef struct _p_Dict *ParameterDict;
272 
273 /*
274     Functions that can act on any PETSc object.
275 */
276 EXTERN int PetscObjectDestroy(PetscObject);
277 EXTERN int PetscObjectExists(PetscObject,PetscTruth*);
278 EXTERN int PetscObjectGetComm(PetscObject,MPI_Comm *);
279 EXTERN int PetscObjectGetCookie(PetscObject,int *);
280 EXTERN int PetscObjectGetType(PetscObject,int *);
281 EXTERN int PetscObjectSetName(PetscObject,const char[]);
282 EXTERN int PetscObjectGetName(PetscObject,char*[]);
283 EXTERN int PetscObjectReference(PetscObject);
284 EXTERN int PetscObjectGetReference(PetscObject,int*);
285 EXTERN int PetscObjectDereference(PetscObject);
286 EXTERN int PetscObjectGetNewTag(PetscObject,int *);
287 EXTERN int PetscObjectSetParameterDict(PetscObject,ParameterDict);
288 EXTERN int PetscObjectGetParameterDict(PetscObject,ParameterDict*);
289 EXTERN int PetscCommGetNewTag(MPI_Comm,int *);
290 EXTERN int PetscObjectView(PetscObject,PetscViewer);
291 EXTERN int PetscObjectCompose(PetscObject,const char[],PetscObject);
292 EXTERN int PetscObjectQuery(PetscObject,const char[],PetscObject *);
293 EXTERN int PetscObjectComposeFunction(PetscObject,const char[],const char[],void (*)(void));
294 #if defined(PETSC_USE_DYNAMIC_LIBRARIES)
295 #define PetscObjectComposeFunctionDynamic(a,b,c,d) PetscObjectComposeFunction(a,b,c,0)
296 #else
297 #define PetscObjectComposeFunctionDynamic(a,b,c,d) PetscObjectComposeFunction(a,b,c,(void (*)(void))(d))
298 #endif
299 EXTERN int PetscObjectQueryFunction(PetscObject,const char[],void (**)(void));
300 EXTERN int PetscObjectSetOptionsPrefix(PetscObject,const char[]);
301 EXTERN int PetscObjectAppendOptionsPrefix(PetscObject,const char[]);
302 EXTERN int PetscObjectPrependOptionsPrefix(PetscObject,const char[]);
303 EXTERN int PetscObjectGetOptionsPrefix(PetscObject,char*[]);
304 EXTERN int PetscObjectPublish(PetscObject);
305 EXTERN int PetscObjectChangeTypeName(PetscObject,char *);
306 EXTERN int PetscObjectChangeSerializeName(PetscObject,char *);
307 EXTERN int PetscObjectRegisterDestroy(PetscObject);
308 EXTERN int PetscObjectRegisterDestroyAll(void);
309 EXTERN int PetscObjectName(PetscObject);
310 EXTERN int PetscTypeCompare(PetscObject,char*,PetscTruth*);
311 EXTERN int PetscSerializeCompare(PetscObject,char*,PetscTruth*);
312 
313 /*
314     Defines PETSc error handling.
315 */
316 #include "petscerror.h"
317 
318 /*S
319      PetscOList - Linked list of PETSc objects, accessable by string name
320 
321    Level: advanced
322 
323 .seealso:  PetscOListAdd(), PetscOListDestroy(), PetscOListFind()
324 S*/
325 typedef struct _PetscOList *PetscOList;
326 
327 EXTERN int PetscOListDestroy(PetscOList *);
328 EXTERN int PetscOListFind(PetscOList,const char[],PetscObject*);
329 EXTERN int PetscOListReverseFind(PetscOList,PetscObject,char**);
330 EXTERN int PetscOListAdd(PetscOList *,const char[],PetscObject);
331 EXTERN int PetscOListDuplicate(PetscOList,PetscOList *);
332 
333 /*
334     Dynamic library lists. Lists of names of routines in dynamic
335   link libraries that will be loaded as needed.
336 */
337 EXTERN int PetscFListAdd(PetscFList*,const char[],const char[],void (*)(void));
338 EXTERN int PetscFListDestroy(PetscFList*);
339 EXTERN int PetscFListFind(MPI_Comm,PetscFList,const char[],void (**)(void));
340 EXTERN int PetscFListPrintTypes(MPI_Comm,FILE*,const char[],const char[],char *,char *,PetscFList);
341 #if defined(PETSC_USE_DYNAMIC_LIBRARIES)
342 #define    PetscFListAddDynamic(a,b,p,c) PetscFListAdd(a,b,p,0)
343 #else
344 #define    PetscFListAddDynamic(a,b,p,c) PetscFListAdd(a,b,p,(void (*)(void))c)
345 #endif
346 EXTERN int PetscFListDuplicate(PetscFList,PetscFList *);
347 EXTERN int PetscFListView(PetscFList,PetscViewer);
348 EXTERN int PetscFListConcat(const char [],const char [],char []);
349 EXTERN int PetscFListGet(PetscFList,char ***,int*);
350 
351 /*S
352      PetscDLLibraryList - Linked list of dynamics libraries to search for functions
353 
354    Level: advanced
355 
356    PETSC_USE_DYNAMIC_LIBRARIES must be defined in petscconf.h to use dynamic libraries
357 
358 .seealso:  PetscDLLibraryOpen()
359 S*/
360 typedef struct _PetscDLLibraryList *PetscDLLibraryList;
361 extern PetscDLLibraryList DLLibrariesLoaded;
362 EXTERN int PetscDLLibraryRetrieve(MPI_Comm,const char[],char *,int,PetscTruth *);
363 EXTERN int PetscDLLibraryOpen(MPI_Comm,const char[],void **);
364 EXTERN int PetscDLLibrarySym(MPI_Comm,PetscDLLibraryList *,const char[],const char[],void **);
365 EXTERN int PetscDLLibraryAppend(MPI_Comm,PetscDLLibraryList *,const char[]);
366 EXTERN int PetscDLLibraryPrepend(MPI_Comm,PetscDLLibraryList *,const char[]);
367 EXTERN int PetscDLLibraryClose(PetscDLLibraryList);
368 EXTERN int PetscDLLibraryPrintPath(void);
369 EXTERN int PetscDLLibraryGetInfo(void *,char *,char **);
370 
371 /*
372     Mechanism for translating PETSc object representations between languages
373     Not currently used.
374 */
375 typedef enum {PETSC_LANGUAGE_C,PETSC_LANGUAGE_CPP} PetscLanguage;
376 #define PETSC_LANGUAGE_F77 PETSC_LANGUAGE_C
377 EXTERN int PetscObjectComposeLanguage(PetscObject,PetscLanguage,void *);
378 EXTERN int PetscObjectQueryLanguage(PetscObject,PetscLanguage,void **);
379 
380 /*
381      Useful utility routines
382 */
383 EXTERN int PetscSplitOwnership(MPI_Comm,int*,int*);
384 EXTERN int PetscSplitOwnershipBlock(MPI_Comm,int,int*,int*);
385 EXTERN int PetscSequentialPhaseBegin(MPI_Comm,int);
386 EXTERN int PetscSequentialPhaseEnd(MPI_Comm,int);
387 EXTERN int PetscBarrier(PetscObject);
388 EXTERN int PetscMPIDump(FILE*);
389 
390 #define PetscNot(a) ((a) ? PETSC_FALSE : PETSC_TRUE)
391 /*
392     Defines basic graphics available from PETSc.
393 */
394 #include "petscdraw.h"
395 
396 /*
397     Defines the base data structures for all PETSc objects
398 */
399 #include "petschead.h"
400 
401 /*
402      Defines PETSc profiling.
403 */
404 #include "petsclog.h"
405 
406 /*
407           For locking, unlocking and destroying AMS memories associated with
408     PETSc objects
409 */
410 #if defined(PETSC_HAVE_AMS)
411 
412 extern PetscTruth PetscAMSPublishAll;
413 #define PetscPublishAll(v) (PetscAMSPublishAll ? PetscObjectPublish((PetscObject)v) : 0)
414 #define PetscObjectTakeAccess(obj)  ((((PetscObject)(obj))->amem == -1) ? 0 : AMS_Memory_take_access(((PetscObject)(obj))->amem))
415 #define PetscObjectGrantAccess(obj) ((((PetscObject)(obj))->amem == -1) ? 0 : AMS_Memory_grant_access(((PetscObject)(obj))->amem))
416 #define PetscObjectDepublish(obj)   ((((PetscObject)(obj))->amem == -1) ? 0 : AMS_Memory_destroy(((PetscObject)(obj))->amem)); \
417     ((PetscObject)(obj))->amem = -1;
418 
419 #else
420 
421 #define PetscPublishAll(v)           0
422 #define PetscObjectTakeAccess(obj)   0
423 #define PetscObjectGrantAccess(obj)  0
424 #define PetscObjectDepublish(obj)      0
425 
426 #endif
427 
428 
429 
430 /*
431       This code allows one to pass a MPI communicator between
432     C and Fortran. MPI 2.0 defines a standard API for doing this.
433     The code here is provided to allow PETSc to work with MPI 1.1
434     standard MPI libraries.
435 */
436 EXTERN int  MPICCommToFortranComm(MPI_Comm,int *);
437 EXTERN int  MPIFortranCommToCComm(int,MPI_Comm*);
438 
439 /*
440       Simple PETSc parallel IO for ASCII printing
441 */
442 EXTERN int  PetscFixFilename(const char[],char[]);
443 EXTERN int  PetscFOpen(MPI_Comm,const char[],const char[],FILE**);
444 EXTERN int  PetscFClose(MPI_Comm,FILE*);
445 EXTERN int  PetscFPrintf(MPI_Comm,FILE*,const char[],...);
446 EXTERN int  PetscPrintf(MPI_Comm,const char[],...);
447 EXTERN int  (*PetscErrorPrintf)(const char[],...);
448 EXTERN int  (*PetscHelpPrintf)(MPI_Comm,const char[],...);
449 EXTERN int  PetscPOpen(MPI_Comm,char *,char*,const char[],FILE **);
450 EXTERN int  PetscPClose(MPI_Comm,FILE*);
451 EXTERN int  PetscSynchronizedPrintf(MPI_Comm,const char[],...);
452 EXTERN int  PetscSynchronizedFPrintf(MPI_Comm,FILE*,const char[],...);
453 EXTERN int  PetscSynchronizedFlush(MPI_Comm);
454 EXTERN int  PetscSynchronizedFGets(MPI_Comm,FILE*,int,char[]);
455 EXTERN int  PetscStartMatlab(MPI_Comm,char *,char*,FILE**);
456 EXTERN int  PetscStartJava(MPI_Comm,char *,char*,FILE**);
457 EXTERN int  PetscGetPetscDir(char**);
458 
459 EXTERN int  PetscPopUpSelect(MPI_Comm,char*,char*,int,char**,int*);
460 /*S
461      PetscObjectContainer - Simple PETSc object that contains a pointer to any required data
462 
463    Level: advanced
464 
465 .seealso:  PetscObject, PetscObjectContainerCreate()
466 S*/
467 typedef struct _p_PetscObjectContainer*  PetscObjectContainer;
468 EXTERN int PetscObjectContainerGetPointer(PetscObjectContainer,void **);
469 EXTERN int PetscObjectContainerSetPointer(PetscObjectContainer,void *);
470 EXTERN int PetscObjectContainerDestroy(PetscObjectContainer);
471 EXTERN int PetscObjectContainerCreate(MPI_Comm comm,PetscObjectContainer *);
472 
473 /*
474    For incremental debugging
475 */
476 extern PetscTruth PetscCompare;
477 EXTERN int        PetscCompareDouble(double);
478 EXTERN int        PetscCompareScalar(PetscScalar);
479 EXTERN int        PetscCompareInt(int);
480 
481 /*
482    For use in debuggers
483 */
484 extern int PetscGlobalRank,PetscGlobalSize;
485 EXTERN int PetscIntView(int,int[],PetscViewer);
486 EXTERN int PetscRealView(int,PetscReal[],PetscViewer);
487 EXTERN int PetscScalarView(int,PetscScalar[],PetscViewer);
488 
489 /*
490     Allows accessing Matlab Engine
491 */
492 #include "petscengine.h"
493 
494 /*
495     C code optimization is often enhanced by telling the compiler
496   that certain pointer arguments to functions are not aliased to
497   to other arguments. This is not yet ANSI C standard so we define
498   the macro "restrict" to indicate that the variable is not aliased
499   to any other argument.
500 */
501 #if defined(PETSC_HAVE_RESTRICT) && !defined(__cplusplus)
502 #define restrict _Restrict
503 #else
504 #define restrict
505 #endif
506 
507 /*
508       Determine if some of the kernel computation routines use
509    Fortran (rather than C) for the numerical calculations. On some machines
510    and compilers (like complex numbers) the Fortran version of the routines
511    is faster than the C/C++ versions. The flag PETSC_USE_FORTRAN_KERNELS
512    would be set in the petscconf.h file
513 */
514 #if defined(PETSC_USE_FORTRAN_KERNELS)
515 
516 #if !defined(PETSC_USE_FORTRAN_KERNEL_MULTAIJ)
517 #define PETSC_USE_FORTRAN_KERNEL_MULTAIJ
518 #endif
519 
520 #if !defined(PETSC_USE_FORTRAN_KERNEL_MULTTRANSPOSEAIJ)
521 #define PETSC_USE_FORTRAN_KERNEL_MULTTRANSPOSEAIJ
522 #endif
523 
524 #if !defined(PETSC_USE_FORTRAN_KERNEL_NORMSQR)
525 #define PETSC_USE_FORTRAN_KERNEL_NORMSQR
526 #endif
527 
528 #if !defined(PETSC_USE_FORTRAN_KERNEL_MAXPY)
529 #define PETSC_USE_FORTRAN_KERNEL_MAXPY
530 #endif
531 
532 #if !defined(PETSC_USE_FORTRAN_KERNEL_SOLVEAIJ)
533 #define PETSC_USE_FORTRAN_KERNEL_SOLVEAIJ
534 #endif
535 
536 #if !defined(PETSC_USE_FORTRAN_KERNEL_RELAXAIJ)
537 #define PETSC_USE_FORTRAN_KERNEL_RELAXAIJ
538 #endif
539 
540 #if !defined(PETSC_USE_FORTRAN_KERNEL_SOLVEBAIJ)
541 #define PETSC_USE_FORTRAN_KERNEL_SOLVEBAIJ
542 #endif
543 
544 #if !defined(PETSC_USE_FORTRAN_KERNEL_MULTADDAIJ)
545 #define PETSC_USE_FORTRAN_KERNEL_MULTADDAIJ
546 #endif
547 
548 #if !defined(PETSC_USE_FORTRAN_KERNEL_MDOT)
549 #define PETSC_USE_FORTRAN_KERNEL_MDOT
550 #endif
551 
552 #if !defined(PETSC_USE_FORTRAN_KERNEL_XTIMESY)
553 #define PETSC_USE_FORTRAN_KERNEL_XTIMESY
554 #endif
555 
556 #endif
557 
558 /*
559     Macros for indicating code that should be compiled with a C interface,
560    rather than a C++ interface. Any routines that are dynamically loaded
561    (such as the PCCreate_XXX() routines) must be wrapped so that the name
562    mangler does not change the functions symbol name. This just hides the
563    ugly extern "C" {} wrappers.
564 */
565 #if defined(__cplusplus)
566 #define EXTERN_C_BEGIN extern "C" {
567 #define EXTERN_C_END }
568 #else
569 #define EXTERN_C_BEGIN
570 #define EXTERN_C_END
571 #endif
572 
573 /* --------------------------------------------------------------------*/
574 /*
575     DVF (win32) uses STDCALL calling convention by default.
576     The following is used by the fortran interface.
577 */
578 #if defined (PETSC_USE_FORTRAN_STDCALL)
579 #define PETSC_STDCALL __stdcall
580 #else
581 #define PETSC_STDCALL
582 #endif
583 
584 
585 /*M
586     size - integer variable used to contain the number of processors in
587            the relevent MPI_Comm
588 
589    Level: beginner
590 
591 .seealso: rank, comm
592 M*/
593 
594 /*M
595     rank - integer variable used to contain the number of this processor relative
596            to all in the relevent MPI_Comm
597 
598    Level: beginner
599 
600 .seealso: size, comm
601 M*/
602 
603 /*M
604     comm - MPI_Comm used in the current routine or object
605 
606    Level: beginner
607 
608 .seealso: size, rank
609 M*/
610 
611 /*M
612     PetscScalar - PETSc type that represents either a double precision real number or
613        a double precision complex number if the code is compiled with BOPT=g_complex or O_complex
614 
615    Level: beginner
616 
617 M*/
618 
619 /*
620      The IBM include files define hz, here we hide it so that it may be used
621    as a regular user variable.
622 */
623 #if defined(hz)
624 #undef hz
625 #endif
626 
627 #endif
628 
629 
630