Actual source code: pinit.c

  1: #define PETSC_DLL
  2: /*
  3:    This file defines the initialization of PETSc, including PetscInitialize()
  4: */

 6:  #include petsc.h
 7:  #include petscsys.h

  9: #if defined(PETSC_USE_LOG)
 10: EXTERN PetscErrorCode PetscLogBegin_Private(void);
 11: #endif

 14: /* -----------------------------------------------------------------------------------------*/


 18: EXTERN PetscErrorCode PetscInitialize_DynamicLibraries(void);
 19: EXTERN PetscErrorCode PetscFinalize_DynamicLibraries(void);
 20: EXTERN PetscErrorCode PetscFListDestroyAll(void);
 21: EXTERN PetscErrorCode PetscSequentialPhaseBegin_Private(MPI_Comm,int);
 22: EXTERN PetscErrorCode PetscSequentialPhaseEnd_Private(MPI_Comm,int);
 23: EXTERN PetscErrorCode PetscLogCloseHistoryFile(FILE **);
 24: EXTERN PetscErrorCode PetscOptionsHelpDestroyList(void);

 26: /* this is used by the _, __, and ___ macros (see include/petscerror.h) */
 27: PetscErrorCode __g0;

 29: /* user may set this BEFORE calling PetscInitialize() */
 30: MPI_Comm PETSC_COMM_WORLD = 0;

 32: /*
 33:      Declare and set all the string names of the PETSc enums
 34: */
 35: const char *PetscTruths[]    = {"FALSE","TRUE","PetscTruth","PETSC_",0};
 36: const char *PetscDataTypes[] = {"INT", "DOUBLE", "COMPLEX",
 37:                                 "LONG","SHORT",  "FLOAT",
 38:                                 "CHAR","LOGICAL","ENUM","TRUTH","LONGDOUBLE","PetscDataType","PETSC_",0};

 40: PetscTruth PetscPreLoadingUsed = PETSC_FALSE;
 41: PetscTruth PetscPreLoadingOn   = PETSC_FALSE;

 43: /*
 44:        Checks the options database for initializations related to the 
 45:     PETSc components
 46: */
 49: PetscErrorCode  PetscOptionsCheckInitial_Components(void)
 50: {
 51:   PetscTruth flg1;

 55:   PetscOptionsHasName(PETSC_NULL,"-help",&flg1);
 56:   if (flg1) {
 57: #if defined (PETSC_USE_LOG)
 58:     MPI_Comm   comm = PETSC_COMM_WORLD;
 59:     (*PetscHelpPrintf)(comm,"------Additional PETSc component options--------\n");
 60:     (*PetscHelpPrintf)(comm," -log_summary_exclude: <vec,mat,pc.ksp,snes>\n");
 61:     (*PetscHelpPrintf)(comm," -info_exclude: <null,vec,mat,pc,ksp,snes,ts>\n");
 62:     (*PetscHelpPrintf)(comm,"-----------------------------------------------\n");
 63: #endif
 64:   }
 65:   return(0);
 66: }

 70: /*@C
 71:       PetscInitializeNoArguments - Calls PetscInitialize() from C/C++ without
 72:         the command line arguments.

 74:    Collective
 75:   
 76:    Level: advanced

 78: .seealso: PetscInitialize(), PetscInitializeFortran()
 79: @*/
 80: PetscErrorCode  PetscInitializeNoArguments(void)
 81: {
 83:   int            argc = 0;
 84:   char           **args = 0;

 87:   PetscInitialize(&argc,&args,PETSC_NULL,PETSC_NULL);
 88:   PetscFunctionReturn(ierr);
 89: }

 93: /*@
 94:       PetscInitialized - Determine whether PETSc is initialized.
 95:   
 96: 7   Level: beginner

 98: .seealso: PetscInitialize(), PetscInitializeNoArguments(), PetscInitializeFortran()
 99: @*/
100: PetscErrorCode  PetscInitialized(PetscTruth *isInitialized)
101: {
104:   *isInitialized = PetscInitializeCalled;
105:   return(0);
106: }

110: /*@
111:       PetscFinalized - Determine whether PetscFinalize() has been called yet
112:   
113:    Level: developer

115: .seealso: PetscInitialize(), PetscInitializeNoArguments(), PetscInitializeFortran()
116: @*/
117: PetscErrorCode  PetscFinalized(PetscTruth *isFinalized)
118: {
121:   *isFinalized = PetscFinalizeCalled;
122:   return(0);
123: }

125: EXTERN PetscErrorCode        PetscOptionsCheckInitial_Private(void);

128: /*
129:        This function is the MPI reduction operation used to compute the sum of the 
130:    first half of the datatype and the max of the second half.
131: */
132: MPI_Op PetscMaxSum_Op = 0;

137: void  MPIAPI PetscMaxSum_Local(void *in,void *out,int *cnt,MPI_Datatype *datatype)
138: {
139:   PetscInt *xin = (PetscInt*)in,*xout = (PetscInt*)out,i,count = *cnt;

142:   if (*datatype != MPIU_2INT) {
143:     (*PetscErrorPrintf)("Can only handle MPIU_2INT data types");
144:     MPI_Abort(MPI_COMM_WORLD,1);
145:   }

147:   for (i=0; i<count; i++) {
148:     xout[2*i]    = PetscMax(xout[2*i],xin[2*i]);
149:     xout[2*i+1] += xin[2*i+1];
150:   }
151:   PetscStackPop;
152:   return;
153: }

156: /*
157:     Returns the max of the first entry owned by this processor and the
158: sum of the second entry.

160:     The reason nprocs[2*i] contains lengths nprocs[2*i+1] contains flag of 1 if length is nonzero
161: is so that the PetscMaxSum_Op() can set TWO values, if we passed in only nprocs[i] with lengths
162: there would be no place to store the both needed results.
163: */
166: PetscErrorCode  PetscMaxSum(MPI_Comm comm,const PetscInt nprocs[],PetscInt *max,PetscInt *sum)
167: {
168:   PetscMPIInt    size,rank;
169:   PetscInt       *work;

173:   MPI_Comm_size(comm,&size);
174:   MPI_Comm_rank(comm,&rank);
175:   PetscMalloc(2*size*sizeof(PetscInt),&work);
176:   MPI_Allreduce((void*)nprocs,work,size,MPIU_2INT,PetscMaxSum_Op,comm);
177:   *max   = work[2*rank];
178:   *sum   = work[2*rank+1];
179:   PetscFree(work);
180:   return(0);
181: }

183: /* ----------------------------------------------------------------------------*/
184: MPI_Op  PetscADMax_Op = 0;

189: void  MPIAPI PetscADMax_Local(void *in,void *out,PetscMPIInt *cnt,MPI_Datatype *datatype)
190: {
191:   PetscScalar *xin = (PetscScalar *)in,*xout = (PetscScalar*)out;
192:   PetscInt    i,count = *cnt;

195:   if (*datatype != MPIU_2SCALAR) {
196:     (*PetscErrorPrintf)("Can only handle MPIU_2SCALAR data (i.e. double or complex) types");
197:     MPI_Abort(MPI_COMM_WORLD,1);
198:   }

200:   for (i=0; i<count; i++) {
201:     if (PetscRealPart(xout[2*i]) < PetscRealPart(xin[2*i])) {
202:       xout[2*i]   = xin[2*i];
203:       xout[2*i+1] = xin[2*i+1];
204:     }
205:   }

207:   PetscStackPop;
208:   return;
209: }

212: MPI_Op  PetscADMin_Op = 0;

217: void  MPIAPI PetscADMin_Local(void *in,void *out,PetscMPIInt *cnt,MPI_Datatype *datatype)
218: {
219:   PetscScalar *xin = (PetscScalar *)in,*xout = (PetscScalar*)out;
220:   PetscInt    i,count = *cnt;

223:   if (*datatype != MPIU_2SCALAR) {
224:     (*PetscErrorPrintf)("Can only handle MPIU_2SCALAR data (i.e. double or complex) types");
225:     MPI_Abort(MPI_COMM_WORLD,1);
226:   }

228:   for (i=0; i<count; i++) {
229:     if (PetscRealPart(xout[2*i]) > PetscRealPart(xin[2*i])) {
230:       xout[2*i]   = xin[2*i];
231:       xout[2*i+1] = xin[2*i+1];
232:     }
233:   }

235:   PetscStackPop;
236:   return;
237: }
239: /* ---------------------------------------------------------------------------------------*/

241: #if defined(PETSC_USE_COMPLEX)
242: MPI_Op PetscSum_Op = 0;

247: void  PetscSum_Local(void *in,void *out,PetscMPIInt *cnt,MPI_Datatype *datatype)
248: {
249:   PetscScalar *xin = (PetscScalar *)in,*xout = (PetscScalar*)out;
250:   PetscInt    i,count = *cnt;

253:   if (*datatype != MPIU_SCALAR) {
254:     (*PetscErrorPrintf)("Can only handle MPIU_SCALAR data (i.e. double or complex) types");
255:     MPI_Abort(MPI_COMM_WORLD,1);
256:   }

258:   for (i=0; i<count; i++) {
259:     xout[i] += xin[i];
260:   }

262:   PetscStackPop;
263:   return;
264: }
266: #endif

268: #if defined(PETSC_USE_PETSC_MPI_EXTERNAL32)
269: #if !defined(PETSC_WORDS_BIGENDIAN)
275: #endif
276: #endif

278: int  PetscGlobalArgc   = 0;
279: char **PetscGlobalArgs = 0;

283: /*@C
284:    PetscGetArgs - Allows you to access the raw command line arguments anywhere
285:      after PetscInitialize() is called but before PetscFinalize().

287:    Not Collective

289:    Output Parameters:
290: +  argc - count of number of command line arguments
291: -  args - the command line arguments

293:    Level: intermediate

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.

299:    Concepts: command line arguments
300:    
301: .seealso: PetscFinalize(), PetscInitializeFortran(), PetscGetArguments()

303: @*/
304: PetscErrorCode  PetscGetArgs(int *argc,char ***args)
305: {
307:   if (!PetscInitializeCalled && PetscFinalizeCalled) {
308:     SETERRQ(PETSC_ERR_ORDER,"You must call after PetscInitialize() but before PetscFinalize()");
309:   }
310:   *argc = PetscGlobalArgc;
311:   *args = PetscGlobalArgs;
312:   return(0);
313: }

317: /*@C
318:    PetscGetArguments - Allows you to access the  command line arguments anywhere
319:      after PetscInitialize() is called but before PetscFinalize().

321:    Not Collective

323:    Output Parameters:
324: .  args - the command line arguments

326:    Level: intermediate

328:    Notes:
329:       This does NOT start with the program name and IS null terminated (final arg is void)

331:    Concepts: command line arguments
332:    
333: .seealso: PetscFinalize(), PetscInitializeFortran(), PetscGetArgs(), PetscFreeArguments()

335: @*/
336: PetscErrorCode  PetscGetArguments(char ***args)
337: {
338:   PetscInt       i,argc = PetscGlobalArgc;

342:   if (!PetscInitializeCalled && PetscFinalizeCalled) {
343:     SETERRQ(PETSC_ERR_ORDER,"You must call after PetscInitialize() but before PetscFinalize()");
344:   }
345:   if (!argc) {*args = 0; return(0);}
346:   PetscMalloc(argc*sizeof(char*),args);
347:   for (i=0; i<argc-1; i++) {
348:     PetscStrallocpy(PetscGlobalArgs[i+1],&(*args)[i]);
349:   }
350:   (*args)[argc-1] = 0;
351:   return(0);
352: }

356: /*@C
357:    PetscFreeArguments - Frees the memory obtained with PetscGetArguments()

359:    Not Collective

361:    Output Parameters:
362: .  args - the command line arguments 

364:    Level: intermediate

366:    Concepts: command line arguments
367:    
368: .seealso: PetscFinalize(), PetscInitializeFortran(), PetscGetArgs(), PetscGetArguments()

370: @*/
371: PetscErrorCode  PetscFreeArguments(char **args)
372: {
373:   PetscInt       i = 0;

377:   if (!args) {return(0);}
378:   while (args[i]) {
379:     PetscFree(args[i]);
380:     i++;
381:   }
382:   PetscFree(args);
383:   return(0);
384: }

388: /*@C
389:    PetscInitialize - Initializes the PETSc database and MPI. 
390:    PetscInitialize() calls MPI_Init() if that has yet to be called,
391:    so this routine should always be called near the beginning of 
392:    your program -- usually the very first line! 

394:    Collective on MPI_COMM_WORLD or PETSC_COMM_WORLD if it has been set

396:    Input Parameters:
397: +  argc - count of number of command line arguments
398: .  args - the command line arguments
399: .  file - [optional] PETSc database file, also checks ~username/.petscrc and .petscrc use PETSC_NULL to not check for
400:           code specific file. Use -skip_petscrc in the code specific file to skip the .petscrc files
401: -  help - [optional] Help message to print, use PETSC_NULL for no message

403:    If you wish PETSc to run on a subcommunicator of MPI_COMM_WORLD, create that
404:    communicator first and assign it to PETSC_COMM_WORLD BEFORE calling PetscInitialize()

406:    Options Database Keys:
407: +  -start_in_debugger [noxterm,dbx,xdb,gdb,...] - Starts program in debugger
408: .  -on_error_attach_debugger [noxterm,dbx,xdb,gdb,...] - Starts debugger when error detected
409: .  -on_error_emacs <machinename> causes emacsclient to jump to error file
410: .  -on_error_abort calls abort() when error detected (no traceback)
411: .  -on_error_mpiabort calls MPI_abort() when error detected
412: .  -error_output_stderr prints error messages to stderr instead of the default stdout
413: .  -error_output_none does not print the error messages (but handles errors in the same way as if this was not called)
414: .  -debugger_nodes [node1,node2,...] - Indicates nodes to start in debugger
415: .  -debugger_pause [sleeptime] (in seconds) - Pauses debugger
416: .  -stop_for_debugger - Print message on how to attach debugger manually to 
417:                         process and wait (-debugger_pause) seconds for attachment
418: .  -malloc - Indicates use of PETSc error-checking malloc (on by default for debug version of libraries)
419: .  -malloc no - Indicates not to use error-checking malloc
420: .  -malloc_debug - check for memory corruption at EVERY malloc or free
421: .  -fp_trap - Stops on floating point exceptions (Note that on the
422:               IBM RS6000 this slows code by at least a factor of 10.)
423: .  -no_signal_handler - Indicates not to trap error signals
424: .  -shared_tmp - indicates /tmp directory is shared by all processors
425: .  -not_shared_tmp - each processor has own /tmp
426: .  -tmp - alternative name of /tmp directory
427: .  -get_total_flops - returns total flops done by all processors
428: -  -memory_info - Print memory usage at end of run

430:    Options Database Keys for Profiling:
431:    See the Profiling chapter of the users manual for details.
432: +  -log_trace [filename] - Print traces of all PETSc calls
433:         to the screen (useful to determine where a program
434:         hangs without running in the debugger).  See PetscLogTraceBegin().
435: .  -info <optional filename> - Prints verbose information to the screen
436: -  -info_exclude <null,vec,mat,pc,ksp,snes,ts> - Excludes some of the verbose messages

438:    Environmental Variables:
439: +   PETSC_TMP - alternative tmp directory
440: .   PETSC_SHARED_TMP - tmp is shared by all processes
441: .   PETSC_NOT_SHARED_TMP - each process has its own private tmp
442: .   PETSC_VIEWER_SOCKET_PORT - socket number to use for socket viewer
443: -   PETSC_VIEWER_SOCKET_MACHINE - machine to use for socket viewer to connect to


446:    Level: beginner

448:    Notes:
449:    If for some reason you must call MPI_Init() separately, call
450:    it before PetscInitialize().

452:    Fortran Version:
453:    In Fortran this routine has the format
454: $       call PetscInitialize(file,ierr)

456: +   ierr - error return code
457: -  file - [optional] PETSc database file, also checks ~username/.petscrc and .petscrc use PETSC_NULL_CHARACTER to not check for
458:           code specific file. Use -skip_petscrc in the code specific file to skip the .petscrc files
459:            
460:    Important Fortran Note:
461:    In Fortran, you MUST use PETSC_NULL_CHARACTER to indicate a
462:    null character string; you CANNOT just use PETSC_NULL as 
463:    in the C version.  See the users manual for details.


466:    Concepts: initializing PETSc
467:    
468: .seealso: PetscFinalize(), PetscInitializeFortran(), PetscGetArgs()

470: @*/
471: PetscErrorCode  PetscInitialize(int *argc,char ***args,const char file[],const char help[])
472: {
474:   PetscMPIInt    flag, size;
475:   PetscInt       nodesize;
476:   PetscTruth     flg;
477:   char           hostname[256];

480:   if (PetscInitializeCalled) return(0);
481:   if (PetscFinalizeCalled)
482:     SETERRQ(1,"You can not initialize PETSc a second time")

484:   /* these must be initialized in a routine, not as a constant declaration*/
485:   PETSC_STDOUT = stdout;
486:   PETSC_STDERR = stderr;

488:   PetscOptionsCreate();

490:   /*
491:      We initialize the program name here (before MPI_Init()) because MPICH has a bug in 
492:      it that it sets args[0] on all processors to be args[0] on the first processor.
493:   */
494:   if (argc && *argc) {
495:     PetscSetProgramName(**args);
496:   } else {
497:     PetscSetProgramName("Unknown Name");
498:   }

500:   MPI_Initialized(&flag);
501:   if (!flag) {
502:     if (PETSC_COMM_WORLD) SETERRQ(PETSC_ERR_SUP,"You cannot set PETSC_COMM_WORLD if you have not initialized MPI first");
503:     MPI_Init(argc,args);
504:     PetscBeganMPI = PETSC_TRUE;
505:   }
506:   if (argc && args) {
507:     PetscGlobalArgc = *argc;
508:     PetscGlobalArgs = *args;
509:   }
510:   PetscInitializeCalled = PETSC_TRUE;
511:   PetscFinalizeCalled   = PETSC_FALSE;

513:   if (!PETSC_COMM_WORLD) {
514:     PETSC_COMM_WORLD = MPI_COMM_WORLD;
515:   }

517:   /* Done after init due to a bug in MPICH-GM? */
518:   PetscErrorPrintfInitialize();

520:   MPI_Comm_rank(MPI_COMM_WORLD,&PetscGlobalRank);
521:   MPI_Comm_size(MPI_COMM_WORLD,&PetscGlobalSize);

523: #if defined(PETSC_USE_COMPLEX)
524:   /* 
525:      Initialized the global complex variable; this is because with 
526:      shared libraries the constructors for global variables
527:      are not called; at least on IRIX.
528:   */
529:   {
530: #if defined(PETSC_CLANGUAGE_CXX)
531:     PetscScalar ic(0.0,1.0);
532:     PETSC_i = ic;
533: #else
534:     PETSC_i = I;
535: #endif
536:   }

538:   MPI_Type_contiguous(2,MPIU_REAL,&MPIU_COMPLEX);
539:   MPI_Type_commit(&MPIU_COMPLEX);
540:   MPI_Op_create(PetscSum_Local,1,&PetscSum_Op);
541: #endif

543:   /*
544:      Create the PETSc MPI reduction operator that sums of the first
545:      half of the entries and maxes the second half.
546:   */
547:   MPI_Op_create(PetscMaxSum_Local,1,&PetscMaxSum_Op);

549:   MPI_Type_contiguous(2,MPIU_SCALAR,&MPIU_2SCALAR);
550:   MPI_Type_commit(&MPIU_2SCALAR);
551:   MPI_Op_create(PetscADMax_Local,1,&PetscADMax_Op);
552:   MPI_Op_create(PetscADMin_Local,1,&PetscADMin_Op);

554:   MPI_Type_contiguous(2,MPIU_INT,&MPIU_2INT);
555:   MPI_Type_commit(&MPIU_2INT);

557:   /*
558:      Build the options database
559:   */
560:   PetscOptionsInsert(argc,args,file);

562: 
563:   /*
564:      Print main application help message
565:   */
566:   PetscOptionsHasName(PETSC_NULL,"-help",&flg);
567:   if (help && flg) {
568:     PetscPrintf(PETSC_COMM_WORLD,help);
569:   }
570:   PetscOptionsCheckInitial_Private();
571: 
572:   /* SHOULD PUT IN GUARDS: Make sure logging is initialized, even if we do not print it out */
573: #if defined(PETSC_USE_LOG)
574:   PetscLogBegin_Private();
575: #endif

577:   /*
578:      Load the dynamic libraries (on machines that support them), this registers all
579:      the solvers etc. (On non-dynamic machines this initializes the PetscDraw and PetscViewer classes)
580:   */
581:   PetscInitialize_DynamicLibraries();

583:   MPI_Comm_size(PETSC_COMM_WORLD,&size);
584:   PetscInfo1(0,"PETSc successfully started: number of processors = %d\n",size);
585:   PetscGetHostName(hostname,256);
586:   PetscInfo1(0,"Running on machine: %s\n",hostname);

588:   PetscOptionsCheckInitial_Components();
589:   /* Check the options database for options related to the options database itself */
590:   PetscOptionsSetFromOptions();

592: #if defined(PETSC_USE_PETSC_MPI_EXTERNAL32)
593:   /* 
594:       Tell MPI about our own data representation converter, this would/should be used if extern32 is not supported by the MPI

596:       Currently not used because it is not supported by MPICH.
597:   */
598: #if !defined(PETSC_WORDS_BIGENDIAN)
599:   MPI_Register_datarep((char *)"petsc",PetscDataRep_read_conv_fn,PetscDataRep_write_conv_fn,PetscDataRep_extent_fn,PETSC_NULL);
600: #endif  
601: #endif

603:   PetscOptionsGetInt(PETSC_NULL,"-openmp_spawn_size",&nodesize,&flg);
604:   if (flg) {
605: #if defined(PETSC_HAVE_MPI_COMM_SPAWN)
606:     PetscOpenMPSpawn((PetscMPIInt) nodesize);
607: #else
608:     SETERRQ(PETSC_ERR_SUP,"PETSc built without MPI 2 (MPI_Comm_spawn) support, use -openmp_merge_size instead");
609: #endif
610:   } else {
611:     PetscOptionsGetInt(PETSC_NULL,"-openmp_merge_size",&nodesize,&flg);
612:     if (flg) {
613:       PetscOpenMPMerge((PetscMPIInt) nodesize);
614:     }
615:   }
616:   PetscOptionsHasName(PETSC_NULL,"-python",&flg);
617:   if (flg) {PetscPythonInitialize(PETSC_NULL,PETSC_NULL);}

619:   PetscFunctionReturn(ierr);
620: }


625: /*@C 
626:    PetscFinalize - Checks for options to be called at the conclusion
627:    of the program. MPI_Finalize() is called only if the user had not
628:    called MPI_Init() before calling PetscInitialize().

630:    Collective on PETSC_COMM_WORLD

632:    Options Database Keys:
633: +  -options_table - Calls PetscOptionsPrint()
634: .  -options_left - Prints unused options that remain in the database
635: .  -options_left no - Does not print unused options that remain in the database
636: .  -mpidump - Calls PetscMPIDump()
637: .  -malloc_dump - Calls PetscMallocDump()
638: .  -malloc_info - Prints total memory usage
639: -  -malloc_log - Prints summary of memory usage

641:    Options Database Keys for Profiling:
642:    See the Profiling chapter of the users manual for details.
643: +  -log_summary [filename] - Prints summary of flop and timing
644:         information to screen. If the filename is specified the
645:         summary is written to the file. (for code compiled with 
646:         PETSC_USE_LOG).  See PetscLogPrintSummary().
647: .  -log_all [filename] - Logs extensive profiling information
648:         (for code compiled with PETSC_USE_LOG). See PetscLogDump(). 
649: .  -log [filename] - Logs basic profiline information (for
650:         code compiled with PETSC_USE_LOG).  See PetscLogDump().
651: .  -log_sync - Log the synchronization in scatters, inner products
652:         and norms
653: -  -log_mpe [filename] - Creates a logfile viewable by the 
654:       utility Upshot/Nupshot (in MPICH distribution)

656:    Level: beginner

658:    Note:
659:    See PetscInitialize() for more general runtime options.

661: .seealso: PetscInitialize(), PetscOptionsPrint(), PetscMallocDump(), PetscMPIDump(), PetscEnd()
662: @*/
663: PetscErrorCode  PetscFinalize(void)
664: {
666:   PetscMPIInt    rank;
667:   int            nopt;
668:   PetscTruth     flg1,flg2,flg3;
670: 

673:   if (!PetscInitializeCalled) {
674:     (*PetscErrorPrintf)("PetscInitialize() must be called before PetscFinalize()\n");
675:     return(0);
676:   }
677:   PetscOpenMPFinalize();

679:   PetscOptionsHasName(PETSC_NULL,"-python",&flg1);
680:   if (flg1) {PetscPythonFinalize();}

682:   MPI_Comm_rank(PETSC_COMM_WORLD,&rank);
683:   PetscOptionsHasName(PETSC_NULL,"-malloc_info",&flg2);
684:   if (!flg2) {
685:     PetscOptionsHasName(PETSC_NULL,"-memory_info",&flg2);
686:   }
687:   if (flg2) {
688:     PetscMemoryShowUsage(PETSC_VIEWER_STDOUT_WORLD,"Summary of Memory Usage in PETSc\n");
689:   }

691:   /*
692:      Free all objects registered with PetscObjectRegisterDestroy() such as PETSC_VIEWER_XXX_().
693:   */
694:   PetscObjectRegisterDestroyAll();

696:   /*
697:        Free all the registered create functions, such as KSPList, VecList, SNESList, etc
698:   */
699:   PetscFListDestroyAll();

701:   /* 
702:      Destroy any packages that registered a finalize 
703:   */
704:   PetscRegisterFinalizeAll();

706:   /*
707:      Destroy all the function registration lists created
708:   */
709:   PetscFinalize_DynamicLibraries();

711: #if defined(PETSC_USE_LOG)
712:   PetscOptionsHasName(PETSC_NULL,"-get_total_flops",&flg1);
713:   if (flg1) {
714:     PetscLogDouble flops = 0;
715:     MPI_Reduce(&_TotalFlops,&flops,1,MPI_DOUBLE,MPI_SUM,0,PETSC_COMM_WORLD);
716:     PetscPrintf(PETSC_COMM_WORLD,"Total flops over all processors %g\n",flops);
717:   }
718: #endif

720:   PetscOptionsHelpDestroyList();

722: #if defined(PETSC_USE_DEBUG)
723:   if (PetscStackActive) {
724:     PetscStackDestroy();
725:   }
726: #endif

728: #if defined(PETSC_USE_LOG)
729:   {
730:     char mname[PETSC_MAX_PATH_LEN];
731: #if defined(PETSC_HAVE_MPE)
732:     mname[0] = 0;
733:     PetscOptionsGetString(PETSC_NULL,"-log_mpe",mname,PETSC_MAX_PATH_LEN,&flg1);
734:     if (flg1){
735:       if (mname[0]) {PetscLogMPEDump(mname);}
736:       else          {PetscLogMPEDump(0);}
737:     }
738: #endif
739:     mname[0] = 0;
740:     PetscOptionsGetString(PETSC_NULL,"-log_summary",mname,PETSC_MAX_PATH_LEN,&flg1);
741:     if (flg1) {
742:       if (mname[0])  {PetscLogPrintSummary(PETSC_COMM_WORLD,mname);}
743:       else           {PetscLogPrintSummary(PETSC_COMM_WORLD,0);}
744:     }

746:     PetscOptionsGetString(PETSC_NULL,"-log_detailed",mname,PETSC_MAX_PATH_LEN,&flg1);
747:     if (flg1) {
748:       if (mname[0])  {PetscLogPrintDetailed(PETSC_COMM_WORLD,mname);}
749:       else           {PetscLogPrintDetailed(PETSC_COMM_WORLD,0);}
750:     }

752:     mname[0] = 0;
753:     PetscOptionsGetString(PETSC_NULL,"-log_all",mname,PETSC_MAX_PATH_LEN,&flg1);
754:     PetscOptionsGetString(PETSC_NULL,"-log",mname,PETSC_MAX_PATH_LEN,&flg2);
755:     if (flg1 || flg2){
756:       if (mname[0]) PetscLogDump(mname);
757:       else          PetscLogDump(0);
758:     }
759:     PetscLogDestroy();
760:   }
761: #endif
762:   PetscOptionsHasName(PETSC_NULL,"-no_signal_handler",&flg1);
763:   if (!flg1) { PetscPopSignalHandler();}
764:   PetscOptionsHasName(PETSC_NULL,"-mpidump",&flg1);
765:   if (flg1) {
766:     PetscMPIDump(stdout);
767:   }
768:   PetscOptionsHasName(PETSC_NULL,"-malloc_dump",&flg1);
769:   PetscOptionsHasName(PETSC_NULL,"-options_table",&flg2);
770:   if (flg2) {
771:     if (!rank) {PetscOptionsPrint(stdout);}
772:   }

774:   /* to prevent PETSc -options_left from warning */
775:   PetscOptionsHasName(PETSC_NULL,"-nox",&flg1);CHKERRQ(ierr)
776:   PetscOptionsHasName(PETSC_NULL,"-nox_warning",&flg1);CHKERRQ(ierr)

778:   if (!PetscOpenMPWorker) { /* worker processes skip this because they do not usually process options */
779:     flg3 = PETSC_FALSE; /* default value is required */
780:     PetscOptionsGetTruth(PETSC_NULL,"-options_left",&flg3,&flg1);
781:     PetscOptionsAllUsed(&nopt);
782:     if (flg3) {
783:       if (!flg2) { /* have not yet printed the options */
784:         PetscOptionsPrint(stdout);
785:       }
786:       if (!nopt) {
787:         PetscPrintf(PETSC_COMM_WORLD,"There are no unused options.\n");
788:       } else if (nopt == 1) {
789:         PetscPrintf(PETSC_COMM_WORLD,"There is one unused database option. It is:\n");
790:       } else {
791:         PetscPrintf(PETSC_COMM_WORLD,"There are %d unused database options. They are:\n",nopt);
792:       }
793:     }
794: #if defined(PETSC_USE_DEBUG)
795:     if (nopt && !flg3 && !flg1) {
796:       PetscPrintf(PETSC_COMM_WORLD,"WARNING! There are options you set that were not used!\n");
797:       PetscPrintf(PETSC_COMM_WORLD,"WARNING! could be spelling mistake, etc!\n");
798:       PetscOptionsLeft();
799:     } else if (nopt && flg3) {
800: #else 
801:     if (nopt && flg3) {
802: #endif
803:       PetscOptionsLeft();
804:     }
805:   }

807:   PetscOptionsHasName(PETSC_NULL,"-log_history",&flg1);
808:   if (flg1) {
809:     PetscLogCloseHistoryFile(&petsc_history);
810:     petsc_history = 0;
811:   }

813:   PetscInfoAllow(PETSC_FALSE,PETSC_NULL);

815:   PetscOptionsHasName(PETSC_NULL,"-malloc_dump",&flg1);
816:   PetscOptionsHasName(PETSC_NULL,"-malloc_log",&flg3);
817:   if (flg1) {
818:     char fname[PETSC_MAX_PATH_LEN];
819:     FILE *fd;
820:     int  err;

822:     fname[0] = 0;
823:     PetscOptionsGetString(PETSC_NULL,"-malloc_dump",fname,250,&flg1);
824:     if (flg1 && fname[0]) {
825:       char sname[PETSC_MAX_PATH_LEN];

827:       sprintf(sname,"%s_%d",fname,rank);
828:       fd   = fopen(sname,"w"); if (!fd) SETERRQ1(PETSC_ERR_FILE_OPEN,"Cannot open log file: %s",sname);
829:       PetscMallocDump(fd);
830:       err = fclose(fd);
831:       if (err) SETERRQ(PETSC_ERR_SYS,"fclose() failed on file");
832:     } else {
833:       MPI_Comm local_comm;

835:       MPI_Comm_dup(MPI_COMM_WORLD,&local_comm);
836:       PetscSequentialPhaseBegin_Private(local_comm,1);
837:         PetscMallocDump(stdout);
838:       PetscSequentialPhaseEnd_Private(local_comm,1);
839:       MPI_Comm_free(&local_comm);
840:     }
841:   }
842:   if (flg3) {
843:     char fname[PETSC_MAX_PATH_LEN];
844:     FILE *fd;
845: 
846:     fname[0] = 0;
847:     PetscOptionsGetString(PETSC_NULL,"-malloc_log",fname,250,&flg1);
848:     if (flg1 && fname[0]) {
849:       char sname[PETSC_MAX_PATH_LEN];
850:       int  err;

852:       sprintf(sname,"%s_%d",fname,rank);
853:       fd   = fopen(sname,"w"); if (!fd) SETERRQ1(PETSC_ERR_FILE_OPEN,"Cannot open log file: %s",sname);
854:       PetscMallocDumpLog(fd);
855:       err = fclose(fd);
856:       if (err) SETERRQ(PETSC_ERR_SYS,"fclose() failed on file");
857:     } else {
858:       PetscMallocDumpLog(stdout);
859:     }
860:   }
861:   /* Can be destroyed only after all the options are used */
862:   PetscOptionsDestroy();

864:   PetscGlobalArgc = 0;
865:   PetscGlobalArgs = 0;

867: #if defined(PETSC_USE_COMPLEX)
868:   MPI_Op_free(&PetscSum_Op);
869:   MPI_Type_free(&MPIU_COMPLEX);
870: #endif
871:   MPI_Type_free(&MPIU_2SCALAR);
872:   MPI_Type_free(&MPIU_2INT);
873:   MPI_Op_free(&PetscMaxSum_Op);
874:   MPI_Op_free(&PetscADMax_Op);
875:   MPI_Op_free(&PetscADMin_Op);

877:   PetscInfo(0,"PETSc successfully ended!\n");
878:   if (PetscBeganMPI) {
879: #if defined(PETSC_HAVE_MPI_FINALIZED)
880:     PetscMPIInt flag;
881:     MPI_Finalized(&flag);
882:     if (flag) SETERRQ(PETSC_ERR_LIB,"MPI_Finalize() has already been called, even though MPI_Init() was called by PetscInitialize()");
883: #endif
884:     MPI_Finalize();
885:   }

887:   if(PETSC_ZOPEFD != NULL){
888:     if (PETSC_ZOPEFD != PETSC_STDOUT) fprintf(PETSC_ZOPEFD, "<<<end>>>");
889:     else fprintf(PETSC_STDOUT, "<<<end>>>");}

891: /*

893:      Note: In certain cases PETSC_COMM_WORLD is never MPI_Comm_free()ed because 
894:    the communicator has some outstanding requests on it. Specifically if the 
895:    flag PETSC_HAVE_BROKEN_REQUEST_FREE is set (for IBM MPI implementation). See 
896:    src/vec/utils/vpscat.c. Due to this the memory allocated in PetscCommDuplicate()
897:    is never freed as it should be. Thus one may obtain messages of the form
898:    [ 1] 8 bytes PetscCommDuplicate() line 645 in src/sys/mpiu.c indicating the
899:    memory was not freed.

901: */
902:   PetscMallocClear();
903:   PetscInitializeCalled = PETSC_FALSE;
904:   PetscFinalizeCalled   = PETSC_TRUE;
905:   PetscFunctionReturn(ierr);
906: }

908: /*
909:      These may be used in code that ADIC is to be used on
910: */

914: /*@
915:       PetscGlobalMax - Computes the maximum value over several processors

917:      Collective on MPI_Comm

919:    Input Parameters:
920: +   local - the local value
921: -   comm - the processors that find the maximum

923:    Output Parameter:
924: .   result - the maximum value
925:   
926:    Level: intermediate

928:    Notes:
929:      These functions are to be used inside user functions that are to be processed with 
930:    ADIC. PETSc will automatically provide differentiated versions of these functions

932: .seealso: PetscGlobalMin(), PetscGlobalSum()
933: @*/
934: PetscErrorCode  PetscGlobalMax(PetscReal* local,PetscReal* result,MPI_Comm comm)
935: {
936:   return MPI_Allreduce(local,result,1,MPIU_REAL,MPI_MAX,comm);
937: }

941: /*@
942:       PetscGlobalMin - Computes the minimum value over several processors

944:      Collective on MPI_Comm

946:    Input Parameters:
947: +   local - the local value
948: -   comm - the processors that find the minimum

950:    Output Parameter:
951: .   result - the minimum value
952:   
953:    Level: intermediate

955:    Notes:
956:      These functions are to be used inside user functions that are to be processed with 
957:    ADIC. PETSc will automatically provide differentiated versions of these functions

959: .seealso: PetscGlobalMax(), PetscGlobalSum()
960: @*/
961: PetscErrorCode  PetscGlobalMin(PetscReal* local,PetscReal* result,MPI_Comm comm)
962: {
963:   return MPI_Allreduce(local,result,1,MPIU_REAL,MPI_MIN,comm);
964: }

968: /*@
969:       PetscGlobalSum - Computes the sum over sever processors

971:      Collective on MPI_Comm

973:    Input Parameters:
974: +   local - the local value
975: -   comm - the processors that find the sum

977:    Output Parameter:
978: .   result - the sum
979:   
980:    Level: intermediate

982:    Notes:
983:      These functions are to be used inside user functions that are to be processed with 
984:    ADIC. PETSc will automatically provide differentiated versions of these functions

986: .seealso: PetscGlobalMin(), PetscGlobalMax()
987: @*/
988: PetscErrorCode  PetscGlobalSum(PetscScalar* local,PetscScalar* result,MPI_Comm comm)
989: {
990:   return MPI_Allreduce(local,result,1,MPIU_SCALAR,PetscSum_Op,comm);
991: }