xref: /petsc/include/petsc.h (revision e74ef6923b2c0251c8aab3a0671bbb2dfd6aaf97) !
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 /*
231   Each PETSc object class has it's own cookie (internal integer in the
232   data structure used for error checking). These are all defined by an offset
233   from the lowest one, PETSC_COOKIE.
234 */
235 #define PETSC_COOKIE                    1211211
236 #define PETSC_MAX_COOKIES               60
237 #define PETSC_LARGEST_COOKIE_PREDEFINED PETSC_COOKIE + 30
238 #define PETSC_LARGEST_COOKIE_ALLOWED    PETSC_COOKIE + PETSC_MAX_COOKIES
239 extern int PETSC_LARGEST_COOKIE;
240 
241 /*S
242      PetscObject - any PETSc object, PetscViewer, Mat, Vec, SLES etc
243 
244    Level: beginner
245 
246 .seealso:  PetscObjectDestroy(), PetscObjectView(), PetscObjectGetName(), PetscObjectSetName()
247 S*/
248 typedef struct _p_PetscObject* PetscObject;
249 
250 /*S
251      PetscFList - Linked list of functions, possibly stored in dynamic libraries, accessed
252       by string name
253 
254    Level: advanced
255 
256 .seealso:  PetscFListAdd(), PetscFListDestroy()
257 S*/
258 typedef struct _PetscFList *PetscFList;
259 
260 #include "petscviewer.h"
261 #include "petscoptions.h"
262 
263 EXTERN int PetscShowMemoryUsage(PetscViewer,char*);
264 EXTERN int PetscGetTime(PetscLogDouble*);
265 EXTERN int PetscGetCPUTime(PetscLogDouble*);
266 EXTERN int PetscSleep(int);
267 
268 /*
269     Initialization of PETSc
270 */
271 EXTERN int  PetscInitialize(int*,char***,char[],const char[]);
272 EXTERN int  PetscInitializeNoArguments(void);
273 EXTERN int  PetscFinalize(void);
274 EXTERN int  PetscInitializeFortran(void);
275 EXTERN int  PetscGetArgs(int*,char ***);
276 EXTERN int  PetscEnd();
277 
278 /*
279    ParameterDict is an abstraction for arguments to interface mechanisms
280 */
281 extern int DICT_COOKIE;
282 typedef struct _p_Dict *ParameterDict;
283 
284 /*
285     Functions that can act on any PETSc object.
286 */
287 EXTERN int PetscObjectDestroy(PetscObject);
288 EXTERN int PetscObjectExists(PetscObject,PetscTruth*);
289 EXTERN int PetscObjectGetComm(PetscObject,MPI_Comm *);
290 EXTERN int PetscObjectGetCookie(PetscObject,int *);
291 EXTERN int PetscObjectGetType(PetscObject,int *);
292 EXTERN int PetscObjectSetName(PetscObject,const char[]);
293 EXTERN int PetscObjectGetName(PetscObject,char*[]);
294 EXTERN int PetscObjectReference(PetscObject);
295 EXTERN int PetscObjectGetReference(PetscObject,int*);
296 EXTERN int PetscObjectDereference(PetscObject);
297 EXTERN int PetscObjectGetNewTag(PetscObject,int *);
298 EXTERN int PetscCommGetNewTag(MPI_Comm,int *);
299 EXTERN int PetscObjectView(PetscObject,PetscViewer);
300 EXTERN int PetscObjectCompose(PetscObject,const char[],PetscObject);
301 EXTERN int PetscObjectQuery(PetscObject,const char[],PetscObject *);
302 EXTERN int PetscObjectComposeFunction(PetscObject,const char[],const char[],void (*)());
303 #if defined(PETSC_USE_DYNAMIC_LIBRARIES)
304 #define PetscObjectComposeFunctionDynamic(a,b,c,d) PetscObjectComposeFunction(a,b,c,0)
305 #else
306 #define PetscObjectComposeFunctionDynamic(a,b,c,d) PetscObjectComposeFunction(a,b,c,(void (*)())(d))
307 #endif
308 EXTERN int PetscObjectQueryFunction(PetscObject,const char[],void (**)());
309 EXTERN int PetscObjectSetOptionsPrefix(PetscObject,const char[]);
310 EXTERN int PetscObjectAppendOptionsPrefix(PetscObject,const char[]);
311 EXTERN int PetscObjectPrependOptionsPrefix(PetscObject,const char[]);
312 EXTERN int PetscObjectGetOptionsPrefix(PetscObject,char*[]);
313 EXTERN int PetscObjectPublish(PetscObject);
314 EXTERN int PetscObjectChangeTypeName(PetscObject,char *);
315 EXTERN int PetscObjectChangeSerializeName(PetscObject,char *);
316 EXTERN int PetscObjectRegisterDestroy(PetscObject);
317 EXTERN int PetscObjectRegisterDestroyAll(void);
318 EXTERN int PetscObjectName(PetscObject);
319 EXTERN int PetscTypeCompare(PetscObject,char*,PetscTruth*);
320 EXTERN int PetscSerializeCompare(PetscObject,char*,PetscTruth*);
321 
322 /*
323     Defines PETSc error handling.
324 */
325 #include "petscerror.h"
326 
327 /*S
328      PetscOList - Linked list of PETSc objects, accessable by string name
329 
330    Level: advanced
331 
332 .seealso:  PetscOListAdd(), PetscOListDestroy(), PetscOListFind()
333 S*/
334 typedef struct _PetscOList *PetscOList;
335 
336 EXTERN int PetscOListDestroy(PetscOList *);
337 EXTERN int PetscOListFind(PetscOList,const char[],PetscObject*);
338 EXTERN int PetscOListReverseFind(PetscOList,PetscObject,char**);
339 EXTERN int PetscOListAdd(PetscOList *,const char[],PetscObject);
340 EXTERN int PetscOListDuplicate(PetscOList,PetscOList *);
341 
342 /*
343     Dynamic library lists. Lists of names of routines in dynamic
344   link libraries that will be loaded as needed.
345 */
346 EXTERN int PetscFListAdd(PetscFList*,const char[],const char[],void (*)());
347 EXTERN int PetscFListDestroy(PetscFList*);
348 EXTERN int PetscFListFind(MPI_Comm,PetscFList,const char[],void (**)());
349 EXTERN int PetscFListPrintTypes(MPI_Comm,FILE*,const char[],const char[],char *,char *,PetscFList);
350 #if defined(PETSC_USE_DYNAMIC_LIBRARIES)
351 #define    PetscFListAddDynamic(a,b,p,c) PetscFListAdd(a,b,p,0)
352 #else
353 #define    PetscFListAddDynamic(a,b,p,c) PetscFListAdd(a,b,p,(void (*)())c)
354 #endif
355 EXTERN int PetscFListDuplicate(PetscFList,PetscFList *);
356 EXTERN int PetscFListView(PetscFList,PetscViewer);
357 EXTERN int PetscFListConcat(const char [],const char [],char []);
358 EXTERN int PetscFListGet(PetscFList,char ***,int*);
359 
360 /*S
361      PetscDLLibraryList - Linked list of dynamics libraries to search for functions
362 
363    Level: advanced
364 
365    PETSC_USE_DYNAMIC_LIBRARIES must be defined in petscconf.h to use dynamic libraries
366 
367 .seealso:  PetscDLLibraryOpen()
368 S*/
369 typedef struct _PetscDLLibraryList *PetscDLLibraryList;
370 extern PetscDLLibraryList DLLibrariesLoaded;
371 EXTERN int PetscDLLibraryRetrieve(MPI_Comm,const char[],char *,int,PetscTruth *);
372 EXTERN int PetscDLLibraryOpen(MPI_Comm,const char[],void **);
373 EXTERN int PetscDLLibrarySym(MPI_Comm,PetscDLLibraryList *,const char[],const char[],void **);
374 EXTERN int PetscDLLibraryAppend(MPI_Comm,PetscDLLibraryList *,const char[]);
375 EXTERN int PetscDLLibraryPrepend(MPI_Comm,PetscDLLibraryList *,const char[]);
376 EXTERN int PetscDLLibraryClose(PetscDLLibraryList);
377 EXTERN int PetscDLLibraryPrintPath(void);
378 EXTERN int PetscDLLibraryGetInfo(void *,char *,char **);
379 
380 /*
381     Mechanism for translating PETSc object representations between languages
382     Not currently used.
383 */
384 typedef enum {PETSC_LANGUAGE_C,PETSC_LANGUAGE_CPP} PetscLanguage;
385 #define PETSC_LANGUAGE_F77 PETSC_LANGUAGE_C
386 EXTERN int PetscObjectComposeLanguage(PetscObject,PetscLanguage,void *);
387 EXTERN int PetscObjectQueryLanguage(PetscObject,PetscLanguage,void **);
388 
389 /*
390      Useful utility routines
391 */
392 EXTERN int PetscSplitOwnership(MPI_Comm,int*,int*);
393 EXTERN int PetscSplitOwnershipBlock(MPI_Comm,int,int*,int*);
394 EXTERN int PetscSequentialPhaseBegin(MPI_Comm,int);
395 EXTERN int PetscSequentialPhaseEnd(MPI_Comm,int);
396 EXTERN int PetscBarrier(PetscObject);
397 EXTERN int PetscMPIDump(FILE*);
398 
399 #define PetscNot(a) ((a) ? PETSC_FALSE : PETSC_TRUE)
400 /*
401     Defines basic graphics available from PETSc.
402 */
403 #include "petscdraw.h"
404 
405 /*
406     Defines the base data structures for all PETSc objects
407 */
408 #include "petschead.h"
409 
410 /*
411      Defines PETSc profiling.
412 */
413 #include "petsclog.h"
414 
415 /*
416           For locking, unlocking and destroying AMS memories associated with
417     PETSc objects
418 */
419 #if defined(PETSC_HAVE_AMS)
420 
421 extern PetscTruth PetscAMSPublishAll;
422 #define PetscPublishAll(v) (PetscAMSPublishAll ? PetscObjectPublish((PetscObject)v) : 0)
423 #define PetscObjectTakeAccess(obj)  ((((PetscObject)(obj))->amem == -1) ? 0 : AMS_Memory_take_access(((PetscObject)(obj))->amem))
424 #define PetscObjectGrantAccess(obj) ((((PetscObject)(obj))->amem == -1) ? 0 : AMS_Memory_grant_access(((PetscObject)(obj))->amem))
425 #define PetscObjectDepublish(obj)   ((((PetscObject)(obj))->amem == -1) ? 0 : AMS_Memory_destroy(((PetscObject)(obj))->amem)); \
426     ((PetscObject)(obj))->amem = -1;
427 
428 #else
429 
430 #define PetscPublishAll(v)           0
431 #define PetscObjectTakeAccess(obj)   0
432 #define PetscObjectGrantAccess(obj)  0
433 #define PetscObjectDepublish(obj)      0
434 
435 #endif
436 
437 
438 
439 /*
440       This code allows one to pass a MPI communicator between
441     C and Fortran. MPI 2.0 defines a standard API for doing this.
442     The code here is provided to allow PETSc to work with MPI 1.1
443     standard MPI libraries.
444 */
445 EXTERN int  MPICCommToFortranComm(MPI_Comm,int *);
446 EXTERN int  MPIFortranCommToCComm(int,MPI_Comm*);
447 
448 /*
449       Simple PETSc parallel IO for ASCII printing
450 */
451 EXTERN int  PetscFixFilename(const char[],char[]);
452 EXTERN int  PetscFOpen(MPI_Comm,const char[],const char[],FILE**);
453 EXTERN int  PetscFClose(MPI_Comm,FILE*);
454 EXTERN int  PetscFPrintf(MPI_Comm,FILE*,const char[],...);
455 EXTERN int  PetscPrintf(MPI_Comm,const char[],...);
456 EXTERN int  (*PetscErrorPrintf)(const char[],...);
457 EXTERN int  (*PetscHelpPrintf)(MPI_Comm,const char[],...);
458 EXTERN int  PetscPOpen(MPI_Comm,char *,char*,const char[],FILE **);
459 EXTERN int  PetscPClose(MPI_Comm,FILE*);
460 EXTERN int  PetscSynchronizedPrintf(MPI_Comm,const char[],...);
461 EXTERN int  PetscSynchronizedFPrintf(MPI_Comm,FILE*,const char[],...);
462 EXTERN int  PetscSynchronizedFlush(MPI_Comm);
463 EXTERN int  PetscSynchronizedFGets(MPI_Comm,FILE*,int,char[]);
464 EXTERN int  PetscStartMatlab(MPI_Comm,char *,char*,FILE**);
465 EXTERN int  PetscStartJava(MPI_Comm,char *,char*,FILE**);
466 EXTERN int  PetscGetPetscDir(char**);
467 
468 EXTERN int  PetscPopUpSelect(MPI_Comm,char*,char*,int,char**,int*);
469 /*S
470      PetscObjectContainer - Simple PETSc object that contains a pointer to any required data
471 
472    Level: advanced
473 
474 .seealso:  PetscObject, PetscObjectContainerCreate()
475 S*/
476 typedef struct _p_PetscObjectContainer*  PetscObjectContainer;
477 EXTERN int PetscObjectContainerGetPointer(PetscObjectContainer,void **);
478 EXTERN int PetscObjectContainerSetPointer(PetscObjectContainer,void *);
479 EXTERN int PetscObjectContainerDestroy(PetscObjectContainer);
480 EXTERN int PetscObjectContainerCreate(MPI_Comm comm,PetscObjectContainer *);
481 
482 /*
483    For incremental debugging
484 */
485 extern PetscTruth PetscCompare;
486 EXTERN int        PetscCompareDouble(double);
487 EXTERN int        PetscCompareScalar(PetscScalar);
488 EXTERN int        PetscCompareInt(int);
489 
490 /*
491    For use in debuggers
492 */
493 extern int PetscGlobalRank,PetscGlobalSize;
494 EXTERN int PetscIntView(int,int[],PetscViewer);
495 EXTERN int PetscRealView(int,PetscReal[],PetscViewer);
496 EXTERN int PetscScalarView(int,PetscScalar[],PetscViewer);
497 
498 /*
499     Allows accessing Matlab Engine
500 */
501 #include "petscengine.h"
502 
503 /*
504     C code optimization is often enhanced by telling the compiler
505   that certain pointer arguments to functions are not aliased to
506   to other arguments. This is not yet ANSI C standard so we define
507   the macro "restrict" to indicate that the variable is not aliased
508   to any other argument.
509 */
510 #if defined(PETSC_HAVE_RESTRICT) && !defined(__cplusplus)
511 #define restrict _Restrict
512 #else
513 #define restrict
514 #endif
515 
516 /*
517       Determine if some of the kernel computation routines use
518    Fortran (rather than C) for the numerical calculations. On some machines
519    and compilers (like complex numbers) the Fortran version of the routines
520    is faster than the C/C++ versions. The flag PETSC_USE_FORTRAN_KERNELS
521    would be set in the petscconf.h file
522 */
523 #if defined(PETSC_USE_FORTRAN_KERNELS)
524 
525 #if !defined(PETSC_USE_FORTRAN_KERNEL_MULTAIJ)
526 #define PETSC_USE_FORTRAN_KERNEL_MULTAIJ
527 #endif
528 
529 #if !defined(PETSC_USE_FORTRAN_KERNEL_MULTTRANSPOSEAIJ)
530 #define PETSC_USE_FORTRAN_KERNEL_MULTTRANSPOSEAIJ
531 #endif
532 
533 #if !defined(PETSC_USE_FORTRAN_KERNEL_NORMSQR)
534 #define PETSC_USE_FORTRAN_KERNEL_NORMSQR
535 #endif
536 
537 #if !defined(PETSC_USE_FORTRAN_KERNEL_MAXPY)
538 #define PETSC_USE_FORTRAN_KERNEL_MAXPY
539 #endif
540 
541 #if !defined(PETSC_USE_FORTRAN_KERNEL_SOLVEAIJ)
542 #define PETSC_USE_FORTRAN_KERNEL_SOLVEAIJ
543 #endif
544 
545 #if !defined(PETSC_USE_FORTRAN_KERNEL_RELAXAIJ)
546 #define PETSC_USE_FORTRAN_KERNEL_RELAXAIJ
547 #endif
548 
549 #if !defined(PETSC_USE_FORTRAN_KERNEL_SOLVEBAIJ)
550 #define PETSC_USE_FORTRAN_KERNEL_SOLVEBAIJ
551 #endif
552 
553 #if !defined(PETSC_USE_FORTRAN_KERNEL_MULTADDAIJ)
554 #define PETSC_USE_FORTRAN_KERNEL_MULTADDAIJ
555 #endif
556 
557 #if !defined(PETSC_USE_FORTRAN_KERNEL_MDOT)
558 #define PETSC_USE_FORTRAN_KERNEL_MDOT
559 #endif
560 
561 #if !defined(PETSC_USE_FORTRAN_KERNEL_XTIMESY)
562 #define PETSC_USE_FORTRAN_KERNEL_XTIMESY
563 #endif
564 
565 #endif
566 
567 /*
568     Macros for indicating code that should be compiled with a C interface,
569    rather than a C++ interface. Any routines that are dynamically loaded
570    (such as the PCCreate_XXX() routines) must be wrapped so that the name
571    mangler does not change the functions symbol name. This just hides the
572    ugly extern "C" {} wrappers.
573 */
574 #if defined(__cplusplus)
575 #define EXTERN_C_BEGIN extern "C" {
576 #define EXTERN_C_END }
577 #else
578 #define EXTERN_C_BEGIN
579 #define EXTERN_C_END
580 #endif
581 
582 /* --------------------------------------------------------------------*/
583 /*
584     DVF (win32) uses STDCALL calling convention by default.
585     The following is used by the fortran interface.
586 */
587 #if defined (PETSC_USE_FORTRAN_STDCALL)
588 #define PETSC_STDCALL __stdcall
589 #else
590 #define PETSC_STDCALL
591 #endif
592 
593 
594 /*M
595     size - integer variable used to contain the number of processors in
596            the relevent MPI_Comm
597 
598    Level: beginner
599 
600 .seealso: rank, comm
601 M*/
602 
603 /*M
604     rank - integer variable used to contain the number of this processor relative
605            to all in the relevent MPI_Comm
606 
607    Level: beginner
608 
609 .seealso: size, comm
610 M*/
611 
612 /*M
613     comm - MPI_Comm used in the current routine or object
614 
615    Level: beginner
616 
617 .seealso: size, rank
618 M*/
619 
620 /*M
621     PetscScalar - PETSc type that represents either a double precision real number or
622        a double precision complex number if the code is compiled with BOPT=g_complex or O_complex
623 
624    Level: beginner
625 
626 M*/
627 
628 /*
629      The IBM include files define hz, here we hide it so that it may be used
630    as a regular user variable.
631 */
632 #if defined(hz)
633 #undef hz
634 #endif
635 
636 #endif
637 
638 
639