1 /* $Id: petsc.h,v 1.247 1999/05/11 19:17:17 bsmith Exp bsmith $ */ 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 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 Defines some elementary mathematics functions and constants. 36 */ 37 #include "petscmath.h" 38 39 /* 40 Variable type where we stash PETSc object pointers in Fortran. 41 Assumes that sizeof(long) == sizeof(void *) which is true on 42 all machines that we know. 43 */ 44 #define PetscFortranAddr long 45 46 extern MPI_Comm PETSC_COMM_WORLD; 47 extern MPI_Comm PETSC_COMM_SELF; 48 extern int PetscInitializedCalled; 49 extern int PetscSetCommWorld(MPI_Comm); 50 51 /* 52 Defines the malloc employed by PETSc. Users may use these routines as well. 53 */ 54 #define PetscMalloc(a) (*PetscTrMalloc)(a,__LINE__,__FUNC__,__FILE__,__SDIR__) 55 #define PetscNew(A) (A*) PetscMalloc(sizeof(A)) 56 #define PetscFree(a) (*PetscTrFree)(a,__LINE__,__FUNC__,__FILE__,__SDIR__) 57 extern void *(*PetscTrMalloc)(int,int,char*,char*,char*); 58 extern int (*PetscTrFree)(void *,int,char*,char*,char*); 59 extern int PetscSetMalloc(void *(*)(int,int,char*,char*,char*), 60 int (*)(void *,int,char*,char*,char*)); 61 extern int PetscClearMalloc(void); 62 63 /* 64 Routines for tracing memory corruption/bleeding with default PETSc 65 memory allocation 66 */ 67 extern int PetscTrDump(FILE *); 68 extern int PetscTrSpace(PLogDouble *, PLogDouble *,PLogDouble *); 69 extern int PetscTrValid(int,const char[],const char[],const char[]); 70 extern int PetscTrDebugLevel(int); 71 extern int PetscTrLog(void); 72 extern int PetscTrLogDump(FILE *); 73 extern int PetscGetResidentSetSize(PLogDouble *); 74 75 /* 76 Constants and functions used for handling different basic data types. 77 These are used, for example, in binary IO routines 78 */ 79 typedef enum {PETSC_INT = 0, PETSC_DOUBLE = 1, PETSC_SHORT = 2, PETSC_FLOAT = 3, 80 PETSC_COMPLEX = 4, PETSC_CHAR = 5, PETSC_LOGICAL = 6} PetscDataType; 81 #if defined(PETSC_USE_COMPLEX) 82 #define PETSC_SCALAR PETSC_COMPLEX 83 #else 84 #define PETSC_SCALAR PETSC_DOUBLE 85 #endif 86 typedef enum {PETSC_INT_SIZE = sizeof(int), PETSC_DOUBLE_SIZE = sizeof(double), 87 PETSC_SCALAR_SIZE = sizeof(Scalar), PETSC_COMPLEX_SIZE = sizeof(double), 88 PETSC_CHAR_SIZE = sizeof(char), PETSC_LOGICAL_SIZE = 1} PetscDataTypeSize; 89 extern int PetscDataTypeToMPIDataType(PetscDataType,MPI_Datatype*); 90 extern int PetscDataTypeGetSize(PetscDataType,int*); 91 extern int PetscDataTypeGetName(PetscDataType,char*[]); 92 93 /* 94 Basic memory and string operations. These are usually simple wrappers 95 around the basic Unix system calls, but a few of them have additional 96 functionality and/or error checking. 97 */ 98 extern int PetscMemcpy(void *,const void *,int); 99 extern int PetscBitMemcpy(void*,int,const void*,int,int,PetscDataType); 100 extern int PetscMemmove(void *,void *,int); 101 extern int PetscMemzero(void *,int); 102 extern int PetscMemcmp(const void*,const void*, int); 103 extern int PetscStrlen(const char[]); 104 extern int PetscStrcmp(const char[],const char[]); 105 extern int PetscStrcasecmp(const char[],const char[]); 106 extern int PetscStrncmp(const char[],const char[],int ); 107 extern int PetscStrcpy(char[],const char[]); 108 extern int PetscStrcat(char[],const char[]); 109 extern int PetscStrncat(char[],const char[],int); 110 extern int PetscStrncpy(char[],const char[],int); 111 extern int PetscStrchr(const char[],char,char **); 112 extern int PetscStrrchr(const char[],char,char **); 113 extern int PetscStrstr(const char[],const char[],char **); 114 extern int PetscStrtok(const char[],const char[],char **); 115 116 #define PetscTypeCompare(a,b) (!PetscStrcmp((char*)(a),(char *)(b))) 117 118 /* 119 Basic PETSc constants 120 */ 121 typedef enum { PETSC_FALSE, PETSC_TRUE } PetscTruth; 122 #define PETSC_NULL 0 123 #define PETSC_DECIDE -1 124 #define PETSC_DETERMINE PETSC_DECIDE 125 #define PETSC_DEFAULT -2 126 127 /* 128 Each PETSc object class has it's own cookie (internal integer in the 129 data structure used for error checking). These are all defined by an offset 130 from the lowest one, PETSC_COOKIE. If you increase these you must 131 increase the field sizes in petsc/src/sys/src/plog/plog.c 132 */ 133 #define PETSC_COOKIE 1211211 134 #define LARGEST_PETSC_COOKIE_PREDEFINED PETSC_COOKIE + 30 135 #define LARGEST_PETSC_COOKIE_ALLOWED PETSC_COOKIE + 50 136 extern int LARGEST_PETSC_COOKIE; 137 138 typedef struct _FList *FList; 139 140 #include "viewer.h" 141 #include "options.h" 142 143 extern int PetscGetTime(PLogDouble*); 144 extern int PetscGetCPUTime(PLogDouble*); 145 extern int PetscSleep(int); 146 147 /* 148 Initialization of PETSc or its micro-kernel ALICE 149 */ 150 extern int AliceInitialize(int*,char***,const char[],const char[]); 151 extern int AliceInitializeNoArguments(void); 152 extern int AliceFinalize(void); 153 extern void AliceInitializeFortran(void); 154 155 extern int PetscInitialize(int*,char***,char[],const char[]); 156 extern int PetscInitializeNoArguments(void); 157 extern int PetscFinalize(void); 158 extern void PetscInitializeFortran(void); 159 160 /* 161 Functions that can act on any PETSc object. 162 */ 163 typedef struct _p_PetscObject* PetscObject; 164 extern int PetscObjectDestroy(PetscObject); 165 extern int PetscObjectExists(PetscObject,PetscTruth*); 166 extern int PetscObjectGetComm(PetscObject,MPI_Comm *comm); 167 extern int PetscObjectGetCookie(PetscObject,int *cookie); 168 extern int PetscObjectGetType(PetscObject,int *type); 169 extern int PetscObjectSetName(PetscObject,const char[]); 170 extern int PetscObjectGetName(PetscObject,char*[]); 171 extern int PetscObjectReference(PetscObject); 172 extern int PetscObjectGetReference(PetscObject,int*); 173 extern int PetscObjectDereference(PetscObject); 174 extern int PetscObjectGetNewTag(PetscObject,int *); 175 extern int PetscObjectRestoreNewTag(PetscObject,int *); 176 extern int PetscCommGetNewTag(MPI_Comm,int *); 177 extern int PetscCommRestoreNewTag(MPI_Comm,int *); 178 extern int PetscObjectView(PetscObject,Viewer); 179 extern int PetscObjectCompose(PetscObject,const char[],PetscObject); 180 extern int PetscObjectQuery(PetscObject,const char[],PetscObject *); 181 extern int PetscObjectComposeFunction_Private(PetscObject,const char[],const char[],void *); 182 #if defined(PETSC_USE_DYNAMIC_LIBRARIES) 183 #define PetscObjectComposeFunction(a,b,c,d) PetscObjectComposeFunction_Private(a,b,c,0) 184 #else 185 #define PetscObjectComposeFunction(a,b,c,d) PetscObjectComposeFunction_Private(a,b,c,d) 186 #endif 187 extern int PetscObjectQueryFunction(PetscObject,const char[],void **); 188 extern int PetscObjectSetOptionsPrefix(PetscObject,const char[]); 189 extern int PetscObjectAppendOptionsPrefix(PetscObject,const char[]); 190 extern int PetscObjectPrependOptionsPrefix(PetscObject,const char[]); 191 extern int PetscObjectGetOptionsPrefix(PetscObject,char*[]); 192 extern int PetscObjectPublish(PetscObject); 193 194 /* 195 Defines PETSc error handling. 196 */ 197 #include "petscerror.h" 198 199 /* 200 Mechanism for managing lists of objects attached (composed) with 201 a PETSc object. 202 */ 203 typedef struct _OList *OList; 204 extern int OListDestroy(OList *); 205 extern int OListFind(OList,const char[],PetscObject*); 206 extern int OListReverseFind(OList,PetscObject,char**); 207 extern int OListAdd(OList *,const char[],PetscObject); 208 extern int OListDuplicate(OList,OList *); 209 210 /* 211 Dynamic library lists. Lists of names of routines in dynamic 212 link libraries that will be loaded as needed. 213 */ 214 extern int FListAdd_Private(FList*,const char[],const char[],int (*)(void *)); 215 extern int FListDestroy(FList); 216 extern int FListFind(MPI_Comm,FList,const char[],int (**)(void*)); 217 extern int FListPrintTypes(MPI_Comm,FILE*,const char[],const char[],FList); 218 #if defined(PETSC_USE_DYNAMIC_LIBRARIES) 219 #define FListAdd(a,b,p,c) FListAdd_Private(a,b,p,0) 220 #else 221 #define FListAdd(a,b,p,c) FListAdd_Private(a,b,p,(int (*)(void *))c) 222 #endif 223 extern int FListDuplicate(FList,FList *); 224 extern int FListView(FList,Viewer); 225 226 /* 227 Routines for handling dynamic libraries. PETSc uses dynamic libraries 228 by default on most machines (except IBM). This is controlled by the 229 flag PETSC_USE_DYNAMIC_LIBRARIES in petscconf.h 230 */ 231 typedef struct _DLLibraryList *DLLibraryList; 232 extern DLLibraryList DLLibrariesLoaded; 233 extern int DLLibraryRetrieve(MPI_Comm,const char[],char *,int,PetscTruth *); 234 extern int DLLibraryOpen(MPI_Comm,const char[],void **); 235 extern int DLLibrarySym(MPI_Comm,DLLibraryList *,const char[],const char[],void **); 236 extern int DLLibraryAppend(MPI_Comm,DLLibraryList *,const char[]); 237 extern int DLLibraryPrepend(MPI_Comm,DLLibraryList *,const char[]); 238 extern int DLLibraryClose(DLLibraryList); 239 extern int DLLibraryPrintPath(void); 240 extern int DLLibraryGetInfo(void *,char *,char **); 241 242 /* 243 Mechanism for translating PETSc object representations between languages 244 Not currently used. 245 */ 246 typedef enum {PETSC_LANGUAGE_C,PETSC_LANGUAGE_CPP} PetscLanguage; 247 #define PETSC_LANGUAGE_F77 PETSC_LANGUAGE_C 248 extern int PetscObjectComposeLanguage(PetscObject,PetscLanguage,void *); 249 extern int PetscObjectQueryLanguage(PetscObject,PetscLanguage,void **); 250 251 /* 252 Useful utility routines 253 */ 254 extern int PetscSplitOwnership(MPI_Comm,int*,int*); 255 extern int PetscSequentialPhaseBegin(MPI_Comm,int); 256 extern int PetscSequentialPhaseEnd(MPI_Comm,int); 257 extern int PetscBarrier(PetscObject); 258 extern int PetscMPIDump(FILE*); 259 260 /* 261 Defines basic graphics available from PETSc. 262 */ 263 #include "draw.h" 264 265 /* 266 Defines the base data structures for all PETSc objects 267 */ 268 #include "petschead.h" 269 270 /* 271 Defines PETSc profiling. 272 */ 273 #include "petsclog.h" 274 275 #if defined(PETSC_HAVE_AMS) 276 extern PetscTruth PetscAMSPublishAll; 277 #define PetscPublishAll(v)\ 278 { if (PetscAMSPublishAll) { \ 279 int __ierr;\ 280 __ierr = PetscObjectPublish((PetscObject)v);CHKERRQ(__ierr);\ 281 }} 282 #else 283 #define PetscPublishAll(v) 284 #endif 285 286 /* 287 This code allows one to pass a MPI communicator between 288 C and Fortran. MPI 2.0 defines a standard API for doing this. 289 The code here is provided to allow PETSc to work with MPI 1.1 290 standard MPI libraries. 291 */ 292 extern int MPICCommToFortranComm(MPI_Comm,int *); 293 extern int MPIFortranCommToCComm(int,MPI_Comm*); 294 295 /* 296 Simple PETSc parallel IO for ASCII printing 297 */ 298 extern int PetscFixFilename(const char[],char[]); 299 extern FILE *PetscFOpen(MPI_Comm,const char[],const char[]); 300 extern int PetscFClose(MPI_Comm,FILE*); 301 extern int PetscFPrintf(MPI_Comm,FILE*,const char[],...); 302 extern int PetscPrintf(MPI_Comm,const char[],...); 303 extern int (*PetscErrorPrintf)(const char[],...); 304 extern int (*PetscHelpPrintf)(MPI_Comm,const char[],...); 305 306 extern int PetscSynchronizedPrintf(MPI_Comm,const char[],...); 307 extern int PetscSynchronizedFPrintf(MPI_Comm,FILE*,const char[],...); 308 extern int PetscSynchronizedFlush(MPI_Comm); 309 310 /* 311 Simple PETSc object that contains a pointer to any required data 312 */ 313 typedef struct _p_PetscObjectContainer* PetscObjectContainer; 314 extern int PetscObjectContainerGetPointer(PetscObjectContainer,void **); 315 extern int PetscObjectContainerSetPointer(PetscObjectContainer,void *); 316 extern int PetscObjectContainerDestroy(PetscObjectContainer); 317 extern int PetscObjectContainerCreate(MPI_Comm comm,PetscObjectContainer *); 318 319 /* 320 For incremental debugging 321 */ 322 extern int PetscCompare; 323 extern int PetscCompareDouble(double); 324 extern int PetscCompareScalar(Scalar); 325 extern int PetscCompareInt(int); 326 327 /* 328 For use in debuggers 329 */ 330 extern int PetscGlobalRank,PetscGlobalSize; 331 extern int PetscIntView(int,int[],Viewer); 332 extern int PetscDoubleView(int,double[],Viewer); 333 extern int PetscScalarView(int,Scalar[],Viewer); 334 335 /* 336 C code optimization is often enhanced by telling the compiler 337 that certain pointer arguments to functions are not aliased to 338 to other arguments. This is not yet ANSI C standard so we define 339 the macro "restrict" to indicate that the variable is not aliased 340 to any other argument. 341 */ 342 #if defined(PETSC_HAVE_RESTRICT) && !defined(__cplusplus) 343 #define restrict _Restrict 344 #else 345 #define restrict 346 #endif 347 348 /* 349 Determine if some of the kernel computation routines use 350 Fortran (rather than C) for the numerical calculations. On some machines 351 and compilers (like complex numbers) the Fortran version of the routines 352 is faster than the C/C++ versions. The flag PETSC_USE_FORTRAN_KERNELS 353 would be set in the petscconf.h file 354 */ 355 #if defined(PETSC_USE_FORTRAN_KERNELS) 356 357 #if !defined(PETSC_USE_FORTRAN_KERNEL_MULTAIJ) 358 #define PETSC_USE_FORTRAN_KERNEL_MULTAIJ 359 #endif 360 361 #if !defined(PETSC_USE_FORTRAN_KERNEL_NORMSQR) 362 #define PETSC_USE_FORTRAN_KERNEL_NORMSQR 363 #endif 364 365 #if !defined(PETSC_USE_FORTRAN_KERNEL_MAXPY) 366 #define PETSC_USE_FORTRAN_KERNEL_MAXPY 367 #endif 368 369 #if !defined(PETSC_USE_FORTRAN_KERNEL_SOLVEAIJ) 370 #define PETSC_USE_FORTRAN_KERNEL_SOLVEAIJ 371 #endif 372 373 #if !defined(PETSC_USE_FORTRAN_KERNEL_SOLVEBAIJ) 374 #define PETSC_USE_FORTRAN_KERNEL_SOLVEBAIJ 375 #endif 376 377 #if !defined(PETSC_USE_FORTRAN_KERNEL_MULTADDAIJ) 378 #define PETSC_USE_FORTRAN_KERNEL_MULTADDAIJ 379 #endif 380 381 #if !defined(PETSC_USE_FORTRAN_KERNEL_MDOT) 382 #define PETSC_USE_FORTRAN_KERNEL_MDOT 383 #endif 384 385 #if !defined(PETSC_USE_FORTRAN_KERNEL_XTIMESY) 386 #define PETSC_USE_FORTRAN_KERNEL_XTIMESY 387 #endif 388 389 #endif 390 391 /* 392 Macros for indicating code that should be compiled with a C interface, 393 rather than a C++ interface. Any routines that are dynamically loaded 394 (such as the PCCreate_XXX() routines) must be wrapped so that the name 395 mangler does not change the functions symbol name. This just hides the 396 ugly extern "C" {} wrappers. 397 */ 398 #if defined(__cplusplus) 399 #define EXTERN_C_BEGIN extern "C" { 400 #define EXTERN_C_END } 401 #else 402 #define EXTERN_C_BEGIN 403 #define EXTERN_C_END 404 #endif 405 406 #endif 407