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