1 #define PETSC_DLL 2 /* 3 This file defines the initialization of PETSc, including PetscInitialize() 4 */ 5 6 #include "petsc.h" /*I "petsc.h" I*/ 7 #include "petscsys.h" 8 9 #if defined(PETSC_USE_LOG) 10 EXTERN PetscErrorCode PetscLogBegin_Private(void); 11 #endif 12 13 /* -----------------------------------------------------------------------------------------*/ 14 15 extern FILE *petsc_history; 16 17 EXTERN PetscErrorCode PetscInitialize_DynamicLibraries(void); 18 EXTERN PetscErrorCode PetscFinalize_DynamicLibraries(void); 19 EXTERN PetscErrorCode PetscFListDestroyAll(void); 20 EXTERN PetscErrorCode PetscSequentialPhaseBegin_Private(MPI_Comm,int); 21 EXTERN PetscErrorCode PetscSequentialPhaseEnd_Private(MPI_Comm,int); 22 EXTERN PetscErrorCode PetscLogCloseHistoryFile(FILE **); 23 24 /* this is used by the _, __, and ___ macros (see include/petscerror.h) */ 25 PetscErrorCode __gierr = 0; 26 27 /* user may set this BEFORE calling PetscInitialize() */ 28 MPI_Comm PETSC_COMM_WORLD = 0; 29 30 /* 31 Declare and set all the string names of the PETSc enums 32 */ 33 const char *PetscTruths[] = {"FALSE","TRUE","PetscTruth","PETSC_",0}; 34 const char *PetscDataTypes[] = {"INT", "DOUBLE", "COMPLEX", 35 "LONG","SHORT", "FLOAT", 36 "CHAR","LOGICAL","ENUM","TRUTH","LONGDOUBLE","PetscDataType","PETSC_",0}; 37 38 PetscCookie PETSC_LARGEST_COOKIE = PETSC_COOKIE; 39 PetscCookie PETSC_OBJECT_COOKIE = 0; 40 41 PetscTruth PetscPreLoadingUsed = PETSC_FALSE; 42 PetscTruth PetscPreLoadingOn = PETSC_FALSE; 43 44 PetscErrorCode PETSC_DLLEXPORT PetscCookieRegister(PetscCookie *cookie) 45 { 46 if (*cookie == PETSC_DECIDE || *cookie == PETSC_NULL) { 47 *cookie = ++PETSC_LARGEST_COOKIE; 48 } else if (*cookie > 0) { 49 /* Need to check here for montonicity and insert if necessary */ 50 return 0; 51 } else { 52 SETERRQ1(PETSC_ERR_ARG_OUTOFRANGE, "Invalid suggested cookie %d", (int)*cookie); 53 } 54 return 0; 55 } 56 57 /* 58 Checks the options database for initializations related to the 59 PETSc components 60 */ 61 #undef __FUNCT__ 62 #define __FUNCT__ "PetscOptionsCheckInitial_Components" 63 PetscErrorCode PETSC_DLLEXPORT PetscOptionsCheckInitial_Components(void) 64 { 65 PetscTruth flg1; 66 PetscErrorCode ierr; 67 68 PetscFunctionBegin; 69 ierr = PetscOptionsHasName(PETSC_NULL,"-help",&flg1);CHKERRQ(ierr); 70 if (flg1) { 71 #if defined (PETSC_USE_LOG) 72 MPI_Comm comm = PETSC_COMM_WORLD; 73 ierr = (*PetscHelpPrintf)(comm,"------Additional PETSc component options--------\n");CHKERRQ(ierr); 74 ierr = (*PetscHelpPrintf)(comm," -log_summary_exclude: <vec,mat,pc.ksp,snes>\n");CHKERRQ(ierr); 75 ierr = (*PetscHelpPrintf)(comm," -verbose_info_exclude: <null,vec,mat,pc,ksp,snes,ts>\n");CHKERRQ(ierr); 76 ierr = (*PetscHelpPrintf)(comm,"-----------------------------------------------\n");CHKERRQ(ierr); 77 #endif 78 } 79 PetscFunctionReturn(0); 80 } 81 82 #undef __FUNCT__ 83 #define __FUNCT__ "PetscInitializeNoArguments" 84 /*@C 85 PetscInitializeNoArguments - Calls PetscInitialize() from C/C++ without 86 the command line arguments. 87 88 Collective 89 90 Level: advanced 91 92 .seealso: PetscInitialize(), PetscInitializeFortran() 93 @*/ 94 PetscErrorCode PETSC_DLLEXPORT PetscInitializeNoArguments(void) 95 { 96 PetscErrorCode ierr; 97 int argc = 0; 98 char **args = 0; 99 100 PetscFunctionBegin; 101 ierr = PetscInitialize(&argc,&args,PETSC_NULL,PETSC_NULL); 102 PetscFunctionReturn(ierr); 103 } 104 105 #undef __FUNCT__ 106 #define __FUNCT__ "PetscInitialized" 107 /*@ 108 PetscInitialized - Determine whether PETSc is initialized. 109 110 Level: beginner 111 112 .seealso: PetscInitialize(), PetscInitializeNoArguments(), PetscInitializeFortran() 113 @*/ 114 PetscErrorCode PETSC_DLLEXPORT PetscInitialized(PetscTruth *isInitialized) 115 { 116 PetscFunctionBegin; 117 PetscValidPointer(isInitialized, 1); 118 *isInitialized = PetscInitializeCalled; 119 PetscFunctionReturn(0); 120 } 121 122 #undef __FUNCT__ 123 #define __FUNCT__ "PetscFinalized" 124 /*@ 125 PetscFinalized - Determine whether PetscFinalize() has been called yet 126 127 Level: developer 128 129 .seealso: PetscInitialize(), PetscInitializeNoArguments(), PetscInitializeFortran() 130 @*/ 131 PetscErrorCode PETSC_DLLEXPORT PetscFinalized(PetscTruth *isFinalized) 132 { 133 PetscFunctionBegin; 134 PetscValidPointer(isFinalized, 1); 135 *isFinalized = PetscFinalizeCalled; 136 PetscFunctionReturn(0); 137 } 138 139 EXTERN PetscErrorCode PetscOptionsCheckInitial_Private(void); 140 extern PetscTruth PetscBeganMPI; 141 142 /* 143 This function is the MPI reduction operation used to compute the sum of the 144 first half of the datatype and the max of the second half. 145 */ 146 MPI_Op PetscMaxSum_Op = 0; 147 148 EXTERN_C_BEGIN 149 #undef __FUNCT__ 150 #define __FUNCT__ "PetscMaxSum_Local" 151 void PETSC_DLLEXPORT PetscMaxSum_Local(void *in,void *out,int *cnt,MPI_Datatype *datatype) 152 { 153 PetscInt *xin = (PetscInt*)in,*xout = (PetscInt*)out,i,count = *cnt; 154 155 PetscFunctionBegin; 156 if (*datatype != MPIU_2INT) { 157 (*PetscErrorPrintf)("Can only handle MPIU_2INT data types"); 158 MPI_Abort(MPI_COMM_WORLD,1); 159 } 160 161 for (i=0; i<count; i++) { 162 xout[2*i] = PetscMax(xout[2*i],xin[2*i]); 163 xout[2*i+1] += xin[2*i+1]; 164 } 165 PetscStackPop; 166 return; 167 } 168 EXTERN_C_END 169 170 /* 171 Returns the max of the first entry owned by this processor and the 172 sum of the second entry. 173 */ 174 #undef __FUNCT__ 175 #define __FUNCT__ "PetscMaxSum" 176 PetscErrorCode PETSC_DLLEXPORT PetscMaxSum(MPI_Comm comm,const PetscInt nprocs[],PetscInt *max,PetscInt *sum) 177 { 178 PetscMPIInt size,rank; 179 PetscInt *work; 180 PetscErrorCode ierr; 181 182 PetscFunctionBegin; 183 ierr = MPI_Comm_size(comm,&size);CHKERRQ(ierr); 184 ierr = MPI_Comm_rank(comm,&rank);CHKERRQ(ierr); 185 ierr = PetscMalloc(2*size*sizeof(PetscInt),&work);CHKERRQ(ierr); 186 ierr = MPI_Allreduce((void*)nprocs,work,size,MPIU_2INT,PetscMaxSum_Op,comm);CHKERRQ(ierr); 187 *max = work[2*rank]; 188 *sum = work[2*rank+1]; 189 ierr = PetscFree(work);CHKERRQ(ierr); 190 PetscFunctionReturn(0); 191 } 192 193 /* ----------------------------------------------------------------------------*/ 194 MPI_Op PETSC_DLLEXPORT PetscADMax_Op = 0; 195 196 EXTERN_C_BEGIN 197 #undef __FUNCT__ 198 #define __FUNCT__ "PetscADMax_Local" 199 void PETSC_DLLEXPORT PetscADMax_Local(void *in,void *out,PetscMPIInt *cnt,MPI_Datatype *datatype) 200 { 201 PetscScalar *xin = (PetscScalar *)in,*xout = (PetscScalar*)out; 202 PetscInt i,count = *cnt; 203 204 PetscFunctionBegin; 205 if (*datatype != MPIU_2SCALAR) { 206 (*PetscErrorPrintf)("Can only handle MPIU_2SCALAR data (i.e. double or complex) types"); 207 MPI_Abort(MPI_COMM_WORLD,1); 208 } 209 210 for (i=0; i<count; i++) { 211 if (PetscRealPart(xout[2*i]) < PetscRealPart(xin[2*i])) { 212 xout[2*i] = xin[2*i]; 213 xout[2*i+1] = xin[2*i+1]; 214 } 215 } 216 217 PetscStackPop; 218 return; 219 } 220 EXTERN_C_END 221 222 MPI_Op PETSC_DLLEXPORT PetscADMin_Op = 0; 223 224 EXTERN_C_BEGIN 225 #undef __FUNCT__ 226 #define __FUNCT__ "PetscADMin_Local" 227 void PETSC_DLLEXPORT PetscADMin_Local(void *in,void *out,PetscMPIInt *cnt,MPI_Datatype *datatype) 228 { 229 PetscScalar *xin = (PetscScalar *)in,*xout = (PetscScalar*)out; 230 PetscInt i,count = *cnt; 231 232 PetscFunctionBegin; 233 if (*datatype != MPIU_2SCALAR) { 234 (*PetscErrorPrintf)("Can only handle MPIU_2SCALAR data (i.e. double or complex) types"); 235 MPI_Abort(MPI_COMM_WORLD,1); 236 } 237 238 for (i=0; i<count; i++) { 239 if (PetscRealPart(xout[2*i]) > PetscRealPart(xin[2*i])) { 240 xout[2*i] = xin[2*i]; 241 xout[2*i+1] = xin[2*i+1]; 242 } 243 } 244 245 PetscStackPop; 246 return; 247 } 248 EXTERN_C_END 249 /* ---------------------------------------------------------------------------------------*/ 250 251 #if defined(PETSC_USE_COMPLEX) 252 MPI_Op PetscSum_Op = 0; 253 254 EXTERN_C_BEGIN 255 #undef __FUNCT__ 256 #define __FUNCT__ "PetscSum_Local" 257 void PETSC_DLLEXPORT PetscSum_Local(void *in,void *out,PetscMPIInt *cnt,MPI_Datatype *datatype) 258 { 259 PetscScalar *xin = (PetscScalar *)in,*xout = (PetscScalar*)out; 260 PetscInt i,count = *cnt; 261 262 PetscFunctionBegin; 263 if (*datatype != MPIU_SCALAR) { 264 (*PetscErrorPrintf)("Can only handle MPIU_SCALAR data (i.e. double or complex) types"); 265 MPI_Abort(MPI_COMM_WORLD,1); 266 } 267 268 for (i=0; i<count; i++) { 269 xout[i] += xin[i]; 270 } 271 272 PetscStackPop; 273 return; 274 } 275 EXTERN_C_END 276 #endif 277 278 static int PetscGlobalArgc = 0; 279 static char **PetscGlobalArgs = 0; 280 281 #undef __FUNCT__ 282 #define __FUNCT__ "PetscGetArgs" 283 /*@C 284 PetscGetArgs - Allows you to access the raw command line arguments anywhere 285 after PetscInitialize() is called but before PetscFinalize(). 286 287 Not Collective 288 289 Output Parameters: 290 + argc - count of number of command line arguments 291 - args - the command line arguments 292 293 Level: intermediate 294 295 Notes: 296 This is usually used to pass the command line arguments into other libraries 297 that are called internally deep in PETSc or the application. 298 299 Concepts: command line arguments 300 301 .seealso: PetscFinalize(), PetscInitializeFortran() 302 303 @*/ 304 PetscErrorCode PETSC_DLLEXPORT PetscGetArgs(int *argc,char ***args) 305 { 306 PetscFunctionBegin; 307 if (!PetscGlobalArgs) { 308 SETERRQ(PETSC_ERR_ORDER,"You must call after PetscInitialize() but before PetscFinalize()"); 309 } 310 *argc = PetscGlobalArgc; 311 *args = PetscGlobalArgs; 312 PetscFunctionReturn(0); 313 } 314 315 #undef __FUNCT__ 316 #define __FUNCT__ "PetscInitialize" 317 /*@C 318 PetscInitialize - Initializes the PETSc database and MPI. 319 PetscInitialize() calls MPI_Init() if that has yet to be called, 320 so this routine should always be called near the beginning of 321 your program -- usually the very first line! 322 323 Collective on MPI_COMM_WORLD or PETSC_COMM_WORLD if it has been set 324 325 Input Parameters: 326 + argc - count of number of command line arguments 327 . args - the command line arguments 328 . file - [optional] PETSc database file, defaults to ~username/.petscrc 329 (use PETSC_NULL for default) 330 - help - [optional] Help message to print, use PETSC_NULL for no message 331 332 If you wish PETSc to run on a subcommunicator of MPI_COMM_WORLD, create that 333 communicator first and assign it to PETSC_COMM_WORLD BEFORE calling PetscInitialize() 334 335 Options Database Keys: 336 + -start_in_debugger [noxterm,dbx,xdb,gdb,...] - Starts program in debugger 337 . -on_error_attach_debugger [noxterm,dbx,xdb,gdb,...] - Starts debugger when error detected 338 . -on_error_emacs <machinename> causes emacsclient to jump to error file 339 . -debugger_nodes [node1,node2,...] - Indicates nodes to start in debugger 340 . -debugger_pause [sleeptime] (in seconds) - Pauses debugger 341 . -stop_for_debugger - Print message on how to attach debugger manually to 342 process and wait (-debugger_pause) seconds for attachment 343 . -malloc - Indicates use of PETSc error-checking malloc 344 . -malloc no - Indicates not to use error-checking malloc 345 . -fp_trap - Stops on floating point exceptions (Note that on the 346 IBM RS6000 this slows code by at least a factor of 10.) 347 . -no_signal_handler - Indicates not to trap error signals 348 . -shared_tmp - indicates /tmp directory is shared by all processors 349 . -not_shared_tmp - each processor has own /tmp 350 . -tmp - alternative name of /tmp directory 351 . -get_total_flops - returns total flops done by all processors 352 - -memory_info - Print memory usage at end of run 353 354 Options Database Keys for Profiling: 355 See the Profiling chapter of the users manual for details. 356 + -log_trace [filename] - Print traces of all PETSc calls 357 to the screen (useful to determine where a program 358 hangs without running in the debugger). See PetscLogTraceBegin(). 359 . -verbose_info <optional filename> - Prints verbose information to the screen 360 - -verbose_info_exclude <null,vec,mat,pc,ksp,snes,ts> - Excludes some of the verbose messages 361 362 Environmental Variables: 363 + PETSC_TMP - alternative tmp directory 364 . PETSC_SHARED_TMP - tmp is shared by all processes 365 . PETSC_NOT_SHARED_TMP - each process has its own private tmp 366 . PETSC_VIEWER_SOCKET_PORT - socket number to use for socket viewer 367 - PETSC_VIEWER_SOCKET_MACHINE - machine to use for socket viewer to connect to 368 369 370 Level: beginner 371 372 Notes: 373 If for some reason you must call MPI_Init() separately, call 374 it before PetscInitialize(). 375 376 Fortran Version: 377 In Fortran this routine has the format 378 $ call PetscInitialize(file,ierr) 379 380 + ierr - error return code 381 - file - [optional] PETSc database file name, defaults to 382 ~username/.petscrc (use PETSC_NULL_CHARACTER for default) 383 384 Important Fortran Note: 385 In Fortran, you MUST use PETSC_NULL_CHARACTER to indicate a 386 null character string; you CANNOT just use PETSC_NULL as 387 in the C version. See the users manual for details. 388 389 390 Concepts: initializing PETSc 391 392 .seealso: PetscFinalize(), PetscInitializeFortran(), PetscGetArgs() 393 394 @*/ 395 PetscErrorCode PETSC_DLLEXPORT PetscInitialize(int *argc,char ***args,const char file[],const char help[]) 396 { 397 PetscErrorCode ierr; 398 PetscMPIInt flag, size; 399 PetscTruth flg; 400 char hostname[256]; 401 402 PetscFunctionBegin; 403 if (PetscInitializeCalled) PetscFunctionReturn(0); 404 405 /* this must be initialized in a routine, not as a constant declaration*/ 406 PETSC_STDOUT = stdout; 407 408 ierr = PetscOptionsCreate();CHKERRQ(ierr); 409 410 /* 411 We initialize the program name here (before MPI_Init()) because MPICH has a bug in 412 it that it sets args[0] on all processors to be args[0] on the first processor. 413 */ 414 if (argc && *argc) { 415 ierr = PetscSetProgramName(**args);CHKERRQ(ierr); 416 } else { 417 ierr = PetscSetProgramName("Unknown Name");CHKERRQ(ierr); 418 } 419 420 421 ierr = MPI_Initialized(&flag);CHKERRQ(ierr); 422 if (!flag) { 423 if (PETSC_COMM_WORLD) SETERRQ(PETSC_ERR_SUP,"You cannot set PETSC_COMM_WORLD if you have not initialized MPI first"); 424 ierr = MPI_Init(argc,args);CHKERRQ(ierr); 425 PetscBeganMPI = PETSC_TRUE; 426 } 427 if (argc && args) { 428 PetscGlobalArgc = *argc; 429 PetscGlobalArgs = *args; 430 } 431 PetscInitializeCalled = PETSC_TRUE; 432 PetscFinalizeCalled = PETSC_FALSE; 433 434 if (!PETSC_COMM_WORLD) { 435 PETSC_COMM_WORLD = MPI_COMM_WORLD; 436 } 437 438 /* Done after init due to a bug in MPICH-GM? */ 439 ierr = PetscErrorPrintfInitialize();CHKERRQ(ierr); 440 441 ierr = MPI_Comm_rank(MPI_COMM_WORLD,&PetscGlobalRank);CHKERRQ(ierr); 442 ierr = MPI_Comm_size(MPI_COMM_WORLD,&PetscGlobalSize);CHKERRQ(ierr); 443 444 #if defined(PETSC_USE_COMPLEX) 445 /* 446 Initialized the global complex variable; this is because with 447 shared libraries the constructors for global variables 448 are not called; at least on IRIX. 449 */ 450 { 451 PetscScalar ic(0.0,1.0); 452 PETSC_i = ic; 453 } 454 ierr = MPI_Type_contiguous(2,MPIU_REAL,&MPIU_COMPLEX);CHKERRQ(ierr); 455 ierr = MPI_Type_commit(&MPIU_COMPLEX);CHKERRQ(ierr); 456 ierr = MPI_Op_create(PetscSum_Local,1,&PetscSum_Op);CHKERRQ(ierr); 457 #endif 458 459 /* 460 Create the PETSc MPI reduction operator that sums of the first 461 half of the entries and maxes the second half. 462 */ 463 ierr = MPI_Op_create(PetscMaxSum_Local,1,&PetscMaxSum_Op);CHKERRQ(ierr); 464 465 ierr = MPI_Type_contiguous(2,MPIU_SCALAR,&MPIU_2SCALAR);CHKERRQ(ierr); 466 ierr = MPI_Type_commit(&MPIU_2SCALAR);CHKERRQ(ierr); 467 ierr = MPI_Op_create(PetscADMax_Local,1,&PetscADMax_Op);CHKERRQ(ierr); 468 ierr = MPI_Op_create(PetscADMin_Local,1,&PetscADMin_Op);CHKERRQ(ierr); 469 470 ierr = MPI_Type_contiguous(2,MPIU_INT,&MPIU_2INT);CHKERRQ(ierr); 471 ierr = MPI_Type_commit(&MPIU_2INT);CHKERRQ(ierr); 472 473 /* 474 Build the options database and check for user setup requests 475 */ 476 ierr = PetscOptionsInsert(argc,args,file);CHKERRQ(ierr); 477 478 /* 479 Print main application help message 480 */ 481 ierr = PetscOptionsHasName(PETSC_NULL,"-help",&flg);CHKERRQ(ierr); 482 if (help && flg) { 483 ierr = PetscPrintf(PETSC_COMM_WORLD,help);CHKERRQ(ierr); 484 } 485 ierr = PetscOptionsCheckInitial_Private();CHKERRQ(ierr); 486 487 /* SHOULD PUT IN GUARDS: Make sure logging is initialized, even if we do not print it out */ 488 #if defined(PETSC_USE_LOG) 489 ierr = PetscLogBegin_Private();CHKERRQ(ierr); 490 #endif 491 492 /* 493 Load the dynamic libraries (on machines that support them), this registers all 494 the solvers etc. (On non-dynamic machines this initializes the PetscDraw and PetscViewer classes) 495 */ 496 ierr = PetscInitialize_DynamicLibraries();CHKERRQ(ierr); 497 498 /* 499 Initialize all the default viewers 500 */ 501 ierr = MPI_Comm_size(PETSC_COMM_WORLD,&size);CHKERRQ(ierr); 502 ierr = PetscVerboseInfo((0,"PetscInitialize:PETSc successfully started: number of processors = %d\n",size));CHKERRQ(ierr); 503 ierr = PetscGetHostName(hostname,256);CHKERRQ(ierr); 504 ierr = PetscVerboseInfo((0,"PetscInitialize:Running on machine: %s\n",hostname));CHKERRQ(ierr); 505 506 ierr = PetscOptionsCheckInitial_Components();CHKERRQ(ierr); 507 508 PetscFunctionReturn(ierr); 509 } 510 511 512 #undef __FUNCT__ 513 #define __FUNCT__ "PetscFinalize" 514 /*@C 515 PetscFinalize - Checks for options to be called at the conclusion 516 of the program. MPI_Finalize() is called only if the user had not 517 called MPI_Init() before calling PetscInitialize(). 518 519 Collective on PETSC_COMM_WORLD 520 521 Options Database Keys: 522 + -options_table - Calls PetscOptionsPrint() 523 . -options_left - Prints unused options that remain in the database 524 . -options_left no - Does not print unused options that remain in the database 525 . -mpidump - Calls PetscMPIDump() 526 . -malloc_dump - Calls PetscMallocDump() 527 . -malloc_info - Prints total memory usage 528 . -malloc_debug - Calls PetscMallocDebug(), checks allocated memory for corruption while running 529 - -malloc_log - Prints summary of memory usage 530 531 Options Database Keys for Profiling: 532 See the Profiling chapter of the users manual for details. 533 + -log_summary [filename] - Prints summary of flop and timing 534 information to screen. If the filename is specified the 535 summary is written to the file. (for code compiled with 536 PETSC_USE_LOG). See PetscLogPrintSummary(). 537 . -log_all [filename] - Logs extensive profiling information 538 (for code compiled with PETSC_USE_LOG). See PetscLogDump(). 539 . -log [filename] - Logs basic profiline information (for 540 code compiled with PETSC_USE_LOG). See PetscLogDump(). 541 . -log_sync - Log the synchronization in scatters, inner products 542 and norms 543 - -log_mpe [filename] - Creates a logfile viewable by the 544 utility Upshot/Nupshot (in MPICH distribution) 545 546 Level: beginner 547 548 Note: 549 See PetscInitialize() for more general runtime options. 550 551 .seealso: PetscInitialize(), PetscOptionsPrint(), PetscMallocDump(), PetscMPIDump(), PetscEnd() 552 @*/ 553 PetscErrorCode PETSC_DLLEXPORT PetscFinalize(void) 554 { 555 PetscErrorCode ierr; 556 PetscMPIInt rank; 557 int nopt; 558 PetscTruth flg1,flg2,flg3; 559 560 PetscFunctionBegin; 561 562 if (!PetscInitializeCalled) { 563 (*PetscErrorPrintf)("PetscInitialize() must be called before PetscFinalize()\n"); 564 PetscFunctionReturn(0); 565 } 566 567 ierr = MPI_Comm_rank(PETSC_COMM_WORLD,&rank);CHKERRQ(ierr); 568 ierr = PetscOptionsHasName(PETSC_NULL,"-malloc_info",&flg2);CHKERRQ(ierr); 569 if (!flg2) { 570 ierr = PetscOptionsHasName(PETSC_NULL,"-memory_info",&flg2);CHKERRQ(ierr); 571 } 572 if (flg2) { 573 ierr = PetscMemoryShowUsage(PETSC_VIEWER_STDOUT_WORLD,"Summary of Memory Usage in PETSc\n");CHKERRQ(ierr); 574 } 575 576 /* Destroy auxiliary packages */ 577 #if defined(PETSC_HAVE_MATHEMATICA) 578 ierr = PetscViewerMathematicaFinalizePackage();CHKERRQ(ierr); 579 #endif 580 581 /* 582 Destroy all the function registration lists created 583 */ 584 ierr = PetscFinalize_DynamicLibraries();CHKERRQ(ierr); 585 586 #if defined(PETSC_USE_LOG) 587 ierr = PetscOptionsHasName(PETSC_NULL,"-get_total_flops",&flg1);CHKERRQ(ierr); 588 if (flg1) { 589 PetscLogDouble flops = 0; 590 ierr = MPI_Reduce(&_TotalFlops,&flops,1,MPI_DOUBLE,MPI_SUM,0,PETSC_COMM_WORLD);CHKERRQ(ierr); 591 ierr = PetscPrintf(PETSC_COMM_WORLD,"Total flops over all processors %g\n",flops);CHKERRQ(ierr); 592 } 593 #endif 594 595 /* 596 Free all objects registered with PetscObjectRegisterDestroy() such ast 597 PETSC_VIEWER_XXX_(). 598 */ 599 ierr = PetscObjectRegisterDestroyAll();CHKERRQ(ierr); 600 601 #if defined(PETSC_USE_DEBUG) 602 if (PetscStackActive) { 603 ierr = PetscStackDestroy();CHKERRQ(ierr); 604 } 605 #endif 606 607 #if defined(PETSC_USE_LOG) 608 { 609 char mname[PETSC_MAX_PATH_LEN]; 610 #if defined(PETSC_HAVE_MPE) 611 mname[0] = 0; 612 ierr = PetscOptionsGetString(PETSC_NULL,"-log_mpe",mname,PETSC_MAX_PATH_LEN,&flg1);CHKERRQ(ierr); 613 if (flg1){ 614 if (mname[0]) {ierr = PetscLogMPEDump(mname);CHKERRQ(ierr);} 615 else {ierr = PetscLogMPEDump(0);CHKERRQ(ierr);} 616 } 617 #endif 618 mname[0] = 0; 619 ierr = PetscOptionsGetString(PETSC_NULL,"-log_summary",mname,PETSC_MAX_PATH_LEN,&flg1);CHKERRQ(ierr); 620 if (flg1) { 621 if (mname[0]) {ierr = PetscLogPrintSummary(PETSC_COMM_WORLD,mname);CHKERRQ(ierr);} 622 else {ierr = PetscLogPrintSummary(PETSC_COMM_WORLD,0);CHKERRQ(ierr);} 623 } 624 625 mname[0] = 0; 626 ierr = PetscOptionsGetString(PETSC_NULL,"-log_all",mname,PETSC_MAX_PATH_LEN,&flg1);CHKERRQ(ierr); 627 ierr = PetscOptionsGetString(PETSC_NULL,"-log",mname,PETSC_MAX_PATH_LEN,&flg2);CHKERRQ(ierr); 628 if (flg1 || flg2){ 629 if (mname[0]) PetscLogDump(mname); 630 else PetscLogDump(0); 631 } 632 ierr = PetscLogDestroy();CHKERRQ(ierr); 633 } 634 #endif 635 ierr = PetscOptionsHasName(PETSC_NULL,"-no_signal_handler",&flg1);CHKERRQ(ierr); 636 if (!flg1) { ierr = PetscPopSignalHandler();CHKERRQ(ierr);} 637 ierr = PetscOptionsHasName(PETSC_NULL,"-mpidump",&flg1);CHKERRQ(ierr); 638 if (flg1) { 639 ierr = PetscMPIDump(stdout);CHKERRQ(ierr); 640 } 641 ierr = PetscOptionsHasName(PETSC_NULL,"-malloc_dump",&flg1);CHKERRQ(ierr); 642 ierr = PetscOptionsHasName(PETSC_NULL,"-options_table",&flg2);CHKERRQ(ierr); 643 if (flg2) { 644 if (!rank) {ierr = PetscOptionsPrint(stdout);CHKERRQ(ierr);} 645 } 646 647 /* to prevent PETSc -options_left from warning */ 648 ierr = PetscOptionsHasName(PETSC_NULL,"-nox_warning",&flg1);CHKERRQ(ierr) 649 ierr = PetscOptionsHasName(PETSC_NULL,"-error_output_stderr",&flg1);CHKERRQ(ierr); 650 651 flg3 = PETSC_FALSE; 652 ierr = PetscOptionsGetTruth(PETSC_NULL,"-options_left",&flg3,PETSC_NULL);CHKERRQ(ierr); 653 ierr = PetscOptionsAllUsed(&nopt);CHKERRQ(ierr); 654 if (flg3) { 655 if (!flg2) { /* have not yet printed the options */ 656 ierr = PetscOptionsPrint(stdout);CHKERRQ(ierr); 657 } 658 if (!nopt) { 659 ierr = PetscPrintf(PETSC_COMM_WORLD,"There are no unused options.\n");CHKERRQ(ierr); 660 } else if (nopt == 1) { 661 ierr = PetscPrintf(PETSC_COMM_WORLD,"There is one unused database option. It is:\n");CHKERRQ(ierr); 662 } else { 663 ierr = PetscPrintf(PETSC_COMM_WORLD,"There are %d unused database options. They are:\n",nopt);CHKERRQ(ierr); 664 } 665 } 666 #if defined(PETSC_USE_DEBUG) 667 if (nopt && !flg3) { 668 ierr = PetscPrintf(PETSC_COMM_WORLD,"WARNING! There are options you set that were not used!\n");CHKERRQ(ierr); 669 ierr = PetscPrintf(PETSC_COMM_WORLD,"WARNING! could be spelling mistake, etc!\n");CHKERRQ(ierr); 670 ierr = PetscOptionsLeft();CHKERRQ(ierr); 671 } else if (nopt && flg3) { 672 #else 673 if (nopt && flg3) { 674 #endif 675 ierr = PetscOptionsLeft();CHKERRQ(ierr); 676 } 677 678 ierr = PetscOptionsHasName(PETSC_NULL,"-log_history",&flg1);CHKERRQ(ierr); 679 if (flg1) { 680 ierr = PetscLogCloseHistoryFile(&petsc_history);CHKERRQ(ierr); 681 petsc_history = 0; 682 } 683 684 ierr = PetscVerboseInfoAllow(PETSC_FALSE,PETSC_NULL);CHKERRQ(ierr); 685 686 /* 687 Free all the registered create functions, such as KSPList, VecList, SNESList, etc 688 */ 689 ierr = PetscFListDestroyAll();CHKERRQ(ierr); 690 691 ierr = PetscOptionsHasName(PETSC_NULL,"-malloc_dump",&flg1);CHKERRQ(ierr); 692 ierr = PetscOptionsHasName(PETSC_NULL,"-malloc_log",&flg3);CHKERRQ(ierr); 693 if (flg1) { 694 char fname[PETSC_MAX_PATH_LEN]; 695 FILE *fd; 696 697 fname[0] = 0; 698 ierr = PetscOptionsGetString(PETSC_NULL,"-malloc_dump",fname,250,&flg1);CHKERRQ(ierr); 699 if (flg1 && fname[0]) { 700 char sname[PETSC_MAX_PATH_LEN]; 701 702 sprintf(sname,"%s_%d",fname,rank); 703 fd = fopen(sname,"w"); if (!fd) SETERRQ1(PETSC_ERR_FILE_OPEN,"Cannot open log file: %s",sname); 704 ierr = PetscMallocDump(fd);CHKERRQ(ierr); 705 fclose(fd); 706 } else { 707 MPI_Comm local_comm; 708 709 ierr = MPI_Comm_dup(MPI_COMM_WORLD,&local_comm);CHKERRQ(ierr); 710 ierr = PetscSequentialPhaseBegin_Private(local_comm,1);CHKERRQ(ierr); 711 ierr = PetscMallocDump(stdout);CHKERRQ(ierr); 712 ierr = PetscSequentialPhaseEnd_Private(local_comm,1);CHKERRQ(ierr); 713 ierr = MPI_Comm_free(&local_comm);CHKERRQ(ierr); 714 } 715 } 716 if (flg3) { 717 char fname[PETSC_MAX_PATH_LEN]; 718 FILE *fd; 719 720 fname[0] = 0; 721 ierr = PetscOptionsGetString(PETSC_NULL,"-malloc_log",fname,250,&flg1);CHKERRQ(ierr); 722 if (flg1 && fname[0]) { 723 char sname[PETSC_MAX_PATH_LEN]; 724 725 sprintf(sname,"%s_%d",fname,rank); 726 fd = fopen(sname,"w"); if (!fd) SETERRQ1(PETSC_ERR_FILE_OPEN,"Cannot open log file: %s",sname); 727 ierr = PetscMallocDumpLog(fd);CHKERRQ(ierr); 728 fclose(fd); 729 } else { 730 ierr = PetscMallocDumpLog(stdout);CHKERRQ(ierr); 731 } 732 } 733 /* Can be destroyed only after all the options are used */ 734 ierr = PetscOptionsDestroy();CHKERRQ(ierr); 735 736 PetscGlobalArgc = 0; 737 PetscGlobalArgs = 0; 738 739 #if defined(PETSC_USE_COMPLEX) 740 ierr = MPI_Op_free(&PetscSum_Op);CHKERRQ(ierr); 741 ierr = MPI_Type_free(&MPIU_COMPLEX);CHKERRQ(ierr); 742 #endif 743 ierr = MPI_Type_free(&MPIU_2SCALAR);CHKERRQ(ierr); 744 ierr = MPI_Type_free(&MPIU_2INT);CHKERRQ(ierr); 745 ierr = MPI_Op_free(&PetscMaxSum_Op);CHKERRQ(ierr); 746 ierr = MPI_Op_free(&PetscADMax_Op);CHKERRQ(ierr); 747 ierr = MPI_Op_free(&PetscADMin_Op);CHKERRQ(ierr); 748 749 ierr = PetscVerboseInfo((0,"PetscFinalize:PETSc successfully ended!\n"));CHKERRQ(ierr); 750 if (PetscBeganMPI) { 751 ierr = MPI_Finalize();CHKERRQ(ierr); 752 } 753 754 /* 755 756 Note: In certain cases PETSC_COMM_WORLD is never MPI_Comm_free()ed because 757 the communicator has some outstanding requests on it. Specifically if the 758 flag PETSC_HAVE_BROKEN_REQUEST_FREE is set (for IBM MPI implementation). See 759 src/vec/utils/vpscat.c. Due to this the memory allocated in PetscCommDuplicate() 760 is never freed as it should be. Thus one may obtain messages of the form 761 [ 1] 8 bytes PetscCommDuplicate() line 645 in src/sys/mpiu.c indicating the 762 memory was not freed. 763 764 */ 765 ierr = PetscClearMalloc();CHKERRQ(ierr); 766 PetscInitializeCalled = PETSC_FALSE; 767 PetscFinalizeCalled = PETSC_TRUE; 768 PetscFunctionReturn(ierr); 769 } 770 771 /* 772 These may be used in code that ADIC is to be used on 773 */ 774 775 #undef __FUNCT__ 776 #define __FUNCT__ "PetscGlobalMax" 777 /*@C 778 PetscGlobalMax - Computes the maximum value over several processors 779 780 Collective on MPI_Comm 781 782 Input Parameters: 783 + local - the local value 784 - comm - the processors that find the maximum 785 786 Output Parameter: 787 . result - the maximum value 788 789 Level: intermediate 790 791 Notes: 792 These functions are to be used inside user functions that are to be processed with 793 ADIC. PETSc will automatically provide differentiated versions of these functions 794 795 .seealso: PetscGlobalMin(), PetscGlobalSum() 796 @*/ 797 PetscErrorCode PETSC_DLLEXPORT PetscGlobalMax(PetscReal* local,PetscReal* result,MPI_Comm comm) 798 { 799 return MPI_Allreduce(local,result,1,MPIU_REAL,MPI_MAX,comm); 800 } 801 802 #undef __FUNCT__ 803 #define __FUNCT__ "PetscGlobalMin" 804 /*@C 805 PetscGlobalMin - Computes the minimum value over several processors 806 807 Collective on MPI_Comm 808 809 Input Parameters: 810 + local - the local value 811 - comm - the processors that find the minimum 812 813 Output Parameter: 814 . result - the minimum value 815 816 Level: intermediate 817 818 Notes: 819 These functions are to be used inside user functions that are to be processed with 820 ADIC. PETSc will automatically provide differentiated versions of these functions 821 822 .seealso: PetscGlobalMax(), PetscGlobalSum() 823 @*/ 824 PetscErrorCode PETSC_DLLEXPORT PetscGlobalMin(PetscReal* local,PetscReal* result,MPI_Comm comm) 825 { 826 return MPI_Allreduce(local,result,1,MPIU_REAL,MPI_MIN,comm); 827 } 828 829 #undef __FUNCT__ 830 #define __FUNCT__ "PetscGlobalSum" 831 /*@C 832 PetscGlobalSum - Computes the sum over sever processors 833 834 Collective on MPI_Comm 835 836 Input Parameters: 837 + local - the local value 838 - comm - the processors that find the sum 839 840 Output Parameter: 841 . result - the sum 842 843 Level: intermediate 844 845 Notes: 846 These functions are to be used inside user functions that are to be processed with 847 ADIC. PETSc will automatically provide differentiated versions of these functions 848 849 .seealso: PetscGlobalMin(), PetscGlobalMax() 850 @*/ 851 PetscErrorCode PETSC_DLLEXPORT PetscGlobalSum(PetscScalar* local,PetscScalar* result,MPI_Comm comm) 852 { 853 return MPI_Allreduce(local,result,1,MPIU_SCALAR,PetscSum_Op,comm); 854 } 855 856 857