Actual source code: pinit.c

petsc-3.13.0 2020-03-29
Report Typos and Errors
  1: #define PETSC_DESIRE_FEATURE_TEST_MACROS
  2: /*
  3:    This file defines the initialization of PETSc, including PetscInitialize()
  4: */
  5:  #include <petsc/private/petscimpl.h>
  6:  #include <petscvalgrind.h>
  7:  #include <petscviewer.h>

  9: #if defined(PETSC_USE_LOG)
 10: PETSC_INTERN PetscErrorCode PetscLogFinalize(void);
 11: #endif

 13: #if defined(PETSC_SERIALIZE_FUNCTIONS)
 14: PETSC_INTERN PetscFPT PetscFPTData;
 15: PetscFPT PetscFPTData = 0;
 16: #endif

 18: #if defined(PETSC_HAVE_SAWS)
 19:  #include <petscviewersaws.h>
 20: #endif

 22: /* -----------------------------------------------------------------------------------------*/

 24: PETSC_INTERN FILE *petsc_history;

 26: PETSC_INTERN PetscErrorCode PetscInitialize_DynamicLibraries(void);
 27: PETSC_INTERN PetscErrorCode PetscFinalize_DynamicLibraries(void);
 28: PETSC_INTERN PetscErrorCode PetscFunctionListPrintAll(void);
 29: PETSC_INTERN PetscErrorCode PetscSequentialPhaseBegin_Private(MPI_Comm,int);
 30: PETSC_INTERN PetscErrorCode PetscSequentialPhaseEnd_Private(MPI_Comm,int);
 31: PETSC_INTERN PetscErrorCode PetscCloseHistoryFile(FILE**);

 33: /* user may set this BEFORE calling PetscInitialize() */
 34: MPI_Comm PETSC_COMM_WORLD = MPI_COMM_NULL;

 36: PetscMPIInt Petsc_Counter_keyval   = MPI_KEYVAL_INVALID;
 37: PetscMPIInt Petsc_InnerComm_keyval = MPI_KEYVAL_INVALID;
 38: PetscMPIInt Petsc_OuterComm_keyval = MPI_KEYVAL_INVALID;
 39: PetscMPIInt Petsc_ShmComm_keyval   = MPI_KEYVAL_INVALID;

 41: /*
 42:      Declare and set all the string names of the PETSc enums
 43: */
 44: const char *const PetscBools[]     = {"FALSE","TRUE","PetscBool","PETSC_",NULL};
 45: const char *const PetscCopyModes[] = {"COPY_VALUES","OWN_POINTER","USE_POINTER","PetscCopyMode","PETSC_",NULL};

 47: PetscBool PetscPreLoadingUsed = PETSC_FALSE;
 48: PetscBool PetscPreLoadingOn   = PETSC_FALSE;

 50: PetscInt PetscHotRegionDepth;

 52: #if defined(PETSC_HAVE_THREADSAFETY)
 53: PetscSpinlock PetscViewerASCIISpinLockOpen;
 54: PetscSpinlock PetscViewerASCIISpinLockStdout;
 55: PetscSpinlock PetscViewerASCIISpinLockStderr;
 56: PetscSpinlock PetscCommSpinLock;
 57: #endif

 59: /*
 60:       PetscInitializeNoPointers - Calls PetscInitialize() from C/C++ without the pointers to argc and args

 62:    Collective

 64:    Level: advanced

 66:     Notes:
 67:     this is called only by the PETSc Julia interface. Even though it might start MPI it sets the flag to
 68:      indicate that it did NOT start MPI so that the PetscFinalize() does not end MPI, thus allowing PetscInitialize() to
 69:      be called multiple times from Julia without the problem of trying to initialize MPI more than once.

 71:      Developer Note: Turns off PETSc signal handling to allow Julia to manage signals

 73: .seealso: PetscInitialize(), PetscInitializeFortran(), PetscInitializeNoArguments()
 74: */
 75: PetscErrorCode  PetscInitializeNoPointers(int argc,char **args,const char *filename,const char *help)
 76: {
 78:   int            myargc   = argc;
 79:   char           **myargs = args;

 82:   PetscInitialize(&myargc,&myargs,filename,help);if (ierr) return ierr;
 83:   PetscPopSignalHandler();
 84:   PetscBeganMPI = PETSC_FALSE;
 85:   PetscFunctionReturn(ierr);
 86: }

 88: /*
 89:       Used by Julia interface to get communicator
 90: */
 91: PetscErrorCode  PetscGetPETSC_COMM_SELF(MPI_Comm *comm)
 92: {
 94:   *comm = PETSC_COMM_SELF;
 95:   return(0);
 96: }

 98: /*@C
 99:       PetscInitializeNoArguments - Calls PetscInitialize() from C/C++ without
100:         the command line arguments.

102:    Collective

104:    Level: advanced

106: .seealso: PetscInitialize(), PetscInitializeFortran()
107: @*/
108: PetscErrorCode  PetscInitializeNoArguments(void)
109: {
111:   int            argc   = 0;
112:   char           **args = NULL;

115:   PetscInitialize(&argc,&args,NULL,NULL);
116:   PetscFunctionReturn(ierr);
117: }

119: /*@
120:       PetscInitialized - Determine whether PETSc is initialized.

122:    Level: beginner

124: .seealso: PetscInitialize(), PetscInitializeNoArguments(), PetscInitializeFortran()
125: @*/
126: PetscErrorCode PetscInitialized(PetscBool  *isInitialized)
127: {
128:   *isInitialized = PetscInitializeCalled;
129:   return 0;
130: }

132: /*@
133:       PetscFinalized - Determine whether PetscFinalize() has been called yet

135:    Level: developer

137: .seealso: PetscInitialize(), PetscInitializeNoArguments(), PetscInitializeFortran()
138: @*/
139: PetscErrorCode  PetscFinalized(PetscBool  *isFinalized)
140: {
141:   *isFinalized = PetscFinalizeCalled;
142:   return 0;
143: }

145: PETSC_INTERN PetscErrorCode PetscOptionsCheckInitial_Private(void);

147: /*
148:        This function is the MPI reduction operation used to compute the sum of the
149:    first half of the datatype and the max of the second half.
150: */
151: MPI_Op MPIU_MAXSUM_OP = 0;

153: PETSC_INTERN void MPIAPI MPIU_MaxSum_Local(void *in,void *out,int *cnt,MPI_Datatype *datatype)
154: {
155:   PetscInt *xin = (PetscInt*)in,*xout = (PetscInt*)out,i,count = *cnt;

158:   if (*datatype != MPIU_2INT) {
159:     (*PetscErrorPrintf)("Can only handle MPIU_2INT data types");
160:     PETSCABORT(MPI_COMM_SELF,PETSC_ERR_ARG_WRONG);
161:   }

163:   for (i=0; i<count; i++) {
164:     xout[2*i]    = PetscMax(xout[2*i],xin[2*i]);
165:     xout[2*i+1] += xin[2*i+1];
166:   }
167:   PetscFunctionReturnVoid();
168: }

170: /*
171:     Returns the max of the first entry owned by this processor and the
172: sum of the second entry.

174:     The reason sizes[2*i] contains lengths sizes[2*i+1] contains flag of 1 if length is nonzero
175: is so that the MPIU_MAXSUM_OP() can set TWO values, if we passed in only sizes[i] with lengths
176: there would be no place to store the both needed results.
177: */
178: PetscErrorCode  PetscMaxSum(MPI_Comm comm,const PetscInt sizes[],PetscInt *max,PetscInt *sum)
179: {

183: #if defined(PETSC_HAVE_MPI_REDUCE_SCATTER_BLOCK)
184:   {
185:     struct {PetscInt max,sum;} work;
186:     MPI_Reduce_scatter_block((void*)sizes,&work,1,MPIU_2INT,MPIU_MAXSUM_OP,comm);
187:     *max = work.max;
188:     *sum = work.sum;
189:   }
190: #else
191:   {
192:     PetscMPIInt    size,rank;
193:     struct {PetscInt max,sum;} *work;
194:     MPI_Comm_size(comm,&size);
195:     MPI_Comm_rank(comm,&rank);
196:     PetscMalloc1(size,&work);
197:     MPIU_Allreduce((void*)sizes,work,size,MPIU_2INT,MPIU_MAXSUM_OP,comm);
198:     *max = work[rank].max;
199:     *sum = work[rank].sum;
200:     PetscFree(work);
201:   }
202: #endif
203:   return(0);
204: }

206: /* ----------------------------------------------------------------------------*/

208: #if (defined(PETSC_HAVE_COMPLEX) && !defined(PETSC_HAVE_MPI_C_DOUBLE_COMPLEX)) || defined(PETSC_USE_REAL___FLOAT128) || defined(PETSC_USE_REAL___FP16)
209: MPI_Op MPIU_SUM = 0;

211: PETSC_EXTERN void PetscSum_Local(void *in,void *out,PetscMPIInt *cnt,MPI_Datatype *datatype)
212: {
213:   PetscInt i,count = *cnt;

216:   if (*datatype == MPIU_REAL) {
217:     PetscReal *xin = (PetscReal*)in,*xout = (PetscReal*)out;
218:     for (i=0; i<count; i++) xout[i] += xin[i];
219:   }
220: #if defined(PETSC_HAVE_COMPLEX)
221:   else if (*datatype == MPIU_COMPLEX) {
222:     PetscComplex *xin = (PetscComplex*)in,*xout = (PetscComplex*)out;
223:     for (i=0; i<count; i++) xout[i] += xin[i];
224:   }
225: #endif
226:   else {
227:     (*PetscErrorPrintf)("Can only handle MPIU_REAL or MPIU_COMPLEX data types");
228:     PETSCABORT(MPI_COMM_SELF,PETSC_ERR_ARG_WRONG);
229:   }
230:   PetscFunctionReturnVoid();
231: }
232: #endif

234: #if defined(PETSC_USE_REAL___FLOAT128) || defined(PETSC_USE_REAL___FP16)
235: MPI_Op MPIU_MAX = 0;
236: MPI_Op MPIU_MIN = 0;

238: PETSC_EXTERN void PetscMax_Local(void *in,void *out,PetscMPIInt *cnt,MPI_Datatype *datatype)
239: {
240:   PetscInt i,count = *cnt;

243:   if (*datatype == MPIU_REAL) {
244:     PetscReal *xin = (PetscReal*)in,*xout = (PetscReal*)out;
245:     for (i=0; i<count; i++) xout[i] = PetscMax(xout[i],xin[i]);
246:   }
247: #if defined(PETSC_HAVE_COMPLEX)
248:   else if (*datatype == MPIU_COMPLEX) {
249:     PetscComplex *xin = (PetscComplex*)in,*xout = (PetscComplex*)out;
250:     for (i=0; i<count; i++) {
251:       xout[i] = PetscRealPartComplex(xout[i])<PetscRealPartComplex(xin[i]) ? xin[i] : xout[i];
252:     }
253:   }
254: #endif
255:   else {
256:     (*PetscErrorPrintf)("Can only handle MPIU_REAL or MPIU_COMPLEX data types");
257:     PETSCABORT(MPI_COMM_SELF,PETSC_ERR_ARG_WRONG);
258:   }
259:   PetscFunctionReturnVoid();
260: }

262: PETSC_EXTERN void PetscMin_Local(void *in,void *out,PetscMPIInt *cnt,MPI_Datatype *datatype)
263: {
264:   PetscInt    i,count = *cnt;

267:   if (*datatype == MPIU_REAL) {
268:     PetscReal *xin = (PetscReal*)in,*xout = (PetscReal*)out;
269:     for (i=0; i<count; i++) xout[i] = PetscMin(xout[i],xin[i]);
270:   }
271: #if defined(PETSC_HAVE_COMPLEX)
272:   else if (*datatype == MPIU_COMPLEX) {
273:     PetscComplex *xin = (PetscComplex*)in,*xout = (PetscComplex*)out;
274:     for (i=0; i<count; i++) {
275:       xout[i] = PetscRealPartComplex(xout[i])>PetscRealPartComplex(xin[i]) ? xin[i] : xout[i];
276:     }
277:   }
278: #endif
279:   else {
280:     (*PetscErrorPrintf)("Can only handle MPIU_REAL or MPIU_SCALAR data (i.e. double or complex) types");
281:     PETSCABORT(MPI_COMM_SELF,PETSC_ERR_ARG_WRONG);
282:   }
283:   PetscFunctionReturnVoid();
284: }
285: #endif

287: /*
288:    Private routine to delete internal tag/name counter storage when a communicator is freed.

290:    This is called by MPI, not by users. This is called by MPI_Comm_free() when the communicator that has this  data as an attribute is freed.

292:    Note: this is declared extern "C" because it is passed to MPI_Comm_create_keyval()

294: */
295: PETSC_EXTERN PetscMPIInt MPIAPI Petsc_Counter_Attr_Delete_Fn(MPI_Comm comm,PetscMPIInt keyval,void *count_val,void *extra_state)
296: {
297:   PetscErrorCode   ierr;
298:   PetscCommCounter *counter=(PetscCommCounter*)count_val;

301:   PetscInfo1(NULL,"Deleting counter data in an MPI_Comm %ld\n",(long)comm);CHKERRMPI(ierr);
302:   PetscFree(counter->iflags);CHKERRMPI(ierr);
303:   PetscFree(counter);CHKERRMPI(ierr);
304:   PetscFunctionReturn(MPI_SUCCESS);
305: }

307: /*
308:   This is invoked on the outer comm as a result of either PetscCommDestroy() (via MPI_Comm_delete_attr) or when the user
309:   calls MPI_Comm_free().

311:   This is the only entry point for breaking the links between inner and outer comms.

313:   This is called by MPI, not by users. This is called when MPI_Comm_free() is called on the communicator.

315:   Note: this is declared extern "C" because it is passed to MPI_Comm_create_keyval()

317: */
318: PETSC_EXTERN PetscMPIInt MPIAPI Petsc_InnerComm_Attr_Delete_Fn(MPI_Comm comm,PetscMPIInt keyval,void *attr_val,void *extra_state)
319: {
320:   PetscErrorCode                    ierr;
321:   union {MPI_Comm comm; void *ptr;} icomm;

324:   if (keyval != Petsc_InnerComm_keyval) SETERRMPI(PETSC_COMM_SELF,PETSC_ERR_ARG_CORRUPT,"Unexpected keyval");
325:   icomm.ptr = attr_val;
326: #if defined(PETSC_USE_DEBUG)
327:   {
328:     /* Error out if the inner/outer comms are not correctly linked through their Outer/InnterComm attributes */
329:     PetscMPIInt flg;
330:     union {MPI_Comm comm; void *ptr;} ocomm;
331:     MPI_Comm_get_attr(icomm.comm,Petsc_OuterComm_keyval,&ocomm,&flg);CHKERRMPI(ierr);
332:     if (!flg) SETERRMPI(PETSC_COMM_SELF,PETSC_ERR_ARG_CORRUPT,"Inner comm does not have OuterComm attribute");
333:     if (ocomm.comm != comm) SETERRMPI(PETSC_COMM_SELF,PETSC_ERR_ARG_CORRUPT,"Inner comm's OuterComm attribute does not point to outer PETSc comm");
334:   }
335: #endif
336:   MPI_Comm_delete_attr(icomm.comm,Petsc_OuterComm_keyval);CHKERRMPI(ierr);
337:   PetscInfo2(NULL,"User MPI_Comm %ld is being unlinked from inner PETSc comm %ld\n",(long)comm,(long)icomm.comm);CHKERRMPI(ierr);
338:   PetscFunctionReturn(MPI_SUCCESS);
339: }

341: /*
342:  * This is invoked on the inner comm when Petsc_InnerComm_Attr_Delete_Fn calls MPI_Comm_delete_attr().  It should not be reached any other way.
343:  */
344: PETSC_EXTERN PetscMPIInt MPIAPI Petsc_OuterComm_Attr_Delete_Fn(MPI_Comm comm,PetscMPIInt keyval,void *attr_val,void *extra_state)
345: {

349:   PetscInfo1(NULL,"Removing reference to PETSc communicator embedded in a user MPI_Comm %ld\n",(long)comm);CHKERRMPI(ierr);
350:   PetscFunctionReturn(MPI_SUCCESS);
351: }

353: PETSC_EXTERN PetscMPIInt MPIAPI Petsc_ShmComm_Attr_Delete_Fn(MPI_Comm,PetscMPIInt,void *,void *);

355: #if defined(PETSC_USE_PETSC_MPI_EXTERNAL32)
356: PETSC_EXTERN PetscMPIInt PetscDataRep_extent_fn(MPI_Datatype,MPI_Aint*,void*);
357: PETSC_EXTERN PetscMPIInt PetscDataRep_read_conv_fn(void*, MPI_Datatype,PetscMPIInt,void*,MPI_Offset,void*);
358: PETSC_EXTERN PetscMPIInt PetscDataRep_write_conv_fn(void*, MPI_Datatype,PetscMPIInt,void*,MPI_Offset,void*);
359: #endif

361: PetscMPIInt PETSC_MPI_ERROR_CLASS=MPI_ERR_LASTCODE,PETSC_MPI_ERROR_CODE;

363: PETSC_INTERN int  PetscGlobalArgc;
364: PETSC_INTERN char **PetscGlobalArgs;
365: int  PetscGlobalArgc   = 0;
366: char **PetscGlobalArgs = NULL;
367: PetscSegBuffer PetscCitationsList;

369: PetscErrorCode PetscCitationsInitialize(void)
370: {

374:   PetscSegBufferCreate(1,10000,&PetscCitationsList);
375:   PetscCitationsRegister("@TechReport{petsc-user-ref,\n  Author = {Satish Balay and Shrirang Abhyankar and Mark F. Adams and Jed Brown \n            and Peter Brune and Kris Buschelman and Lisandro Dalcin and\n            Victor Eijkhout and William D. Gropp and Dmitry Karpeyev and\n            Dinesh Kaushik and Matthew G. Knepley and Dave A. May and Lois Curfman McInnes\n            and Richard Tran Mills and Todd Munson and Karl Rupp and Patrick Sanan\n            and Barry F. Smith and Stefano Zampini and Hong Zhang and Hong Zhang},\n  Title = {{PETS}c Users Manual},\n  Number = {ANL-95/11 - Revision 3.11},\n  Institution = {Argonne National Laboratory},\n  Year = {2019}\n}\n",NULL);
376:   PetscCitationsRegister("@InProceedings{petsc-efficient,\n  Author = {Satish Balay and William D. Gropp and Lois Curfman McInnes and Barry F. Smith},\n  Title = {Efficient Management of Parallelism in Object Oriented Numerical Software Libraries},\n  Booktitle = {Modern Software Tools in Scientific Computing},\n  Editor = {E. Arge and A. M. Bruaset and H. P. Langtangen},\n  Pages = {163--202},\n  Publisher = {Birkh{\\\"{a}}user Press},\n  Year = {1997}\n}\n",NULL);
377:   return(0);
378: }

380: static char programname[PETSC_MAX_PATH_LEN] = ""; /* HP includes entire path in name */

382: PetscErrorCode  PetscSetProgramName(const char name[])
383: {

387:   PetscStrncpy(programname,name,PETSC_MAX_PATH_LEN);
388:   return(0);
389: }

391: /*@C
392:     PetscGetProgramName - Gets the name of the running program.

394:     Not Collective

396:     Input Parameter:
397: .   len - length of the string name

399:     Output Parameter:
400: .   name - the name of the running program

402:    Level: advanced

404:     Notes:
405:     The name of the program is copied into the user-provided character
406:     array of length len.  On some machines the program name includes
407:     its entire path, so one should generally set len >= PETSC_MAX_PATH_LEN.
408: @*/
409: PetscErrorCode  PetscGetProgramName(char name[],size_t len)
410: {

414:    PetscStrncpy(name,programname,len);
415:   return(0);
416: }

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

422:    Not Collective

424:    Output Parameters:
425: +  argc - count of number of command line arguments
426: -  args - the command line arguments

428:    Level: intermediate

430:    Notes:
431:       This is usually used to pass the command line arguments into other libraries
432:    that are called internally deep in PETSc or the application.

434:       The first argument contains the program name as is normal for C arguments.

436: .seealso: PetscFinalize(), PetscInitializeFortran(), PetscGetArguments()

438: @*/
439: PetscErrorCode  PetscGetArgs(int *argc,char ***args)
440: {
442:   if (!PetscInitializeCalled && PetscFinalizeCalled) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ORDER,"You must call after PetscInitialize() but before PetscFinalize()");
443:   *argc = PetscGlobalArgc;
444:   *args = PetscGlobalArgs;
445:   return(0);
446: }

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

452:    Not Collective

454:    Output Parameters:
455: .  args - the command line arguments

457:    Level: intermediate

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

462: .seealso: PetscFinalize(), PetscInitializeFortran(), PetscGetArgs(), PetscFreeArguments()

464: @*/
465: PetscErrorCode  PetscGetArguments(char ***args)
466: {
467:   PetscInt       i,argc = PetscGlobalArgc;

471:   if (!PetscInitializeCalled && PetscFinalizeCalled) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ORDER,"You must call after PetscInitialize() but before PetscFinalize()");
472:   if (!argc) {*args = NULL; return(0);}
473:   PetscMalloc1(argc,args);
474:   for (i=0; i<argc-1; i++) {
475:     PetscStrallocpy(PetscGlobalArgs[i+1],&(*args)[i]);
476:   }
477:   (*args)[argc-1] = NULL;
478:   return(0);
479: }

481: /*@C
482:    PetscFreeArguments - Frees the memory obtained with PetscGetArguments()

484:    Not Collective

486:    Output Parameters:
487: .  args - the command line arguments

489:    Level: intermediate

491: .seealso: PetscFinalize(), PetscInitializeFortran(), PetscGetArgs(), PetscGetArguments()

493: @*/
494: PetscErrorCode  PetscFreeArguments(char **args)
495: {
496:   PetscInt       i = 0;

500:   if (!args) return(0);
501:   while (args[i]) {
502:     PetscFree(args[i]);
503:     i++;
504:   }
505:   PetscFree(args);
506:   return(0);
507: }

509: #if defined(PETSC_HAVE_SAWS)
510: #include <petscconfiginfo.h>

512: PETSC_INTERN PetscErrorCode PetscInitializeSAWs(const char help[])
513: {
514:   if (!PetscGlobalRank) {
515:     char           cert[PETSC_MAX_PATH_LEN],root[PETSC_MAX_PATH_LEN],*intro,programname[64],*appline,*options,version[64];
516:     int            port;
517:     PetscBool      flg,rootlocal = PETSC_FALSE,flg2,selectport = PETSC_FALSE;
518:     size_t         applinelen,introlen;
520:     char           sawsurl[256];

522:     PetscOptionsHasName(NULL,NULL,"-saws_log",&flg);
523:     if (flg) {
524:       char  sawslog[PETSC_MAX_PATH_LEN];

526:       PetscOptionsGetString(NULL,NULL,"-saws_log",sawslog,PETSC_MAX_PATH_LEN,NULL);
527:       if (sawslog[0]) {
528:         PetscStackCallSAWs(SAWs_Set_Use_Logfile,(sawslog));
529:       } else {
530:         PetscStackCallSAWs(SAWs_Set_Use_Logfile,(NULL));
531:       }
532:     }
533:     PetscOptionsGetString(NULL,NULL,"-saws_https",cert,PETSC_MAX_PATH_LEN,&flg);
534:     if (flg) {
535:       PetscStackCallSAWs(SAWs_Set_Use_HTTPS,(cert));
536:     }
537:     PetscOptionsGetBool(NULL,NULL,"-saws_port_auto_select",&selectport,NULL);
538:     if (selectport) {
539:         PetscStackCallSAWs(SAWs_Get_Available_Port,(&port));
540:         PetscStackCallSAWs(SAWs_Set_Port,(port));
541:     } else {
542:       PetscOptionsGetInt(NULL,NULL,"-saws_port",&port,&flg);
543:       if (flg) {
544:         PetscStackCallSAWs(SAWs_Set_Port,(port));
545:       }
546:     }
547:     PetscOptionsGetString(NULL,NULL,"-saws_root",root,PETSC_MAX_PATH_LEN,&flg);
548:     if (flg) {
549:       PetscStackCallSAWs(SAWs_Set_Document_Root,(root));
550:       PetscStrcmp(root,".",&rootlocal);
551:     } else {
552:       PetscOptionsHasName(NULL,NULL,"-saws_options",&flg);
553:       if (flg) {
554:         PetscStrreplace(PETSC_COMM_WORLD,"${PETSC_DIR}/share/petsc/saws",root,PETSC_MAX_PATH_LEN);
555:         PetscStackCallSAWs(SAWs_Set_Document_Root,(root));
556:       }
557:     }
558:     PetscOptionsHasName(NULL,NULL,"-saws_local",&flg2);
559:     if (flg2) {
560:       char jsdir[PETSC_MAX_PATH_LEN];
561:       if (!flg) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SUP,"-saws_local option requires -saws_root option");
562:       PetscSNPrintf(jsdir,PETSC_MAX_PATH_LEN,"%s/js",root);
563:       PetscTestDirectory(jsdir,'r',&flg);
564:       if (!flg) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_FILE_READ,"-saws_local option requires js directory in root directory");
565:       PetscStackCallSAWs(SAWs_Push_Local_Header,());
566:     }
567:     PetscGetProgramName(programname,64);
568:     PetscStrlen(help,&applinelen);
569:     introlen   = 4096 + applinelen;
570:     applinelen += 1024;
571:     PetscMalloc(applinelen,&appline);
572:     PetscMalloc(introlen,&intro);

574:     if (rootlocal) {
575:       PetscSNPrintf(appline,applinelen,"%s.c.html",programname);
576:       PetscTestFile(appline,'r',&rootlocal);
577:     }
578:     PetscOptionsGetAll(NULL,&options);
579:     if (rootlocal && help) {
580:       PetscSNPrintf(appline,applinelen,"<center> Running <a href=\"%s.c.html\">%s</a> %s</center><br><center><pre>%s</pre></center><br>\n",programname,programname,options,help);
581:     } else if (help) {
582:       PetscSNPrintf(appline,applinelen,"<center>Running %s %s</center><br><center><pre>%s</pre></center><br>",programname,options,help);
583:     } else {
584:       PetscSNPrintf(appline,applinelen,"<center> Running %s %s</center><br>\n",programname,options);
585:     }
586:     PetscFree(options);
587:     PetscGetVersion(version,sizeof(version));
588:     PetscSNPrintf(intro,introlen,"<body>\n"
589:                                     "<center><h2> <a href=\"https://www.mcs.anl.gov/petsc\">PETSc</a> Application Web server powered by <a href=\"https://bitbucket.org/saws/saws\">SAWs</a> </h2></center>\n"
590:                                     "<center>This is the default PETSc application dashboard, from it you can access any published PETSc objects or logging data</center><br><center>%s configured with %s</center><br>\n"
591:                                     "%s",version,petscconfigureoptions,appline);
592:     PetscStackCallSAWs(SAWs_Push_Body,("index.html",0,intro));
593:     PetscFree(intro);
594:     PetscFree(appline);
595:     if (selectport) {
596:       PetscBool silent;

598:       SAWs_Initialize();
599:       /* another process may have grabbed the port so keep trying */
600:       while (ierr) {
601:         PetscStackCallSAWs(SAWs_Get_Available_Port,(&port));
602:         PetscStackCallSAWs(SAWs_Set_Port,(port));
603:         SAWs_Initialize();
604:       }

606:       PetscOptionsGetBool(NULL,NULL,"-saws_port_auto_select_silent",&silent,NULL);
607:       if (!silent) {
608:         PetscStackCallSAWs(SAWs_Get_FullURL,(sizeof(sawsurl),sawsurl));
609:         PetscPrintf(PETSC_COMM_WORLD,"Point your browser to %s for SAWs\n",sawsurl);
610:       }
611:     } else {
612:       PetscStackCallSAWs(SAWs_Initialize,());
613:     }
614:     PetscCitationsRegister("@TechReport{ saws,\n"
615:                                   "  Author = {Matt Otten and Jed Brown and Barry Smith},\n"
616:                                   "  Title  = {Scientific Application Web Server (SAWs) Users Manual},\n"
617:                                   "  Institution = {Argonne National Laboratory},\n"
618:                                   "  Year   = 2013\n}\n",NULL);
619:   }
620:   return(0);
621: }
622: #endif

624: /* Things must be done before MPI_Init() when MPI is not yet initialized, and can be shared between C init and Fortran init */
625: PETSC_INTERN PetscErrorCode PetscPreMPIInit_Private(void)
626: {
628: #if defined(PETSC_HAVE_HWLOC_SOLARIS_BUG)
629:     /* see MPI.py for details on this bug */
630:     (void) setenv("HWLOC_COMPONENTS","-x86",1);
631: #endif
632:   return(0);
633: }

635: #if defined(PETSC_HAVE_ADIOS)
636: #include <adios.h>
637: #include <adios_read.h>
638: int64_t Petsc_adios_group;
639: #endif
640: #if defined(PETSC_HAVE_ADIOS2)
641: #include <adios2_c.h>
642: #endif
643: #if defined(PETSC_HAVE_OPENMP)
644: #include <omp.h>
645: PetscInt PetscNumOMPThreads;
646: #endif

648: #if defined(PETSC_HAVE_DLFCN_H)
649: #include <dlfcn.h>
650: #endif

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

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

660:    Input Parameters:
661: +  argc - count of number of command line arguments
662: .  args - the command line arguments
663: .  file - [optional] PETSc database file, also checks ~username/.petscrc and .petscrc use NULL to not check for
664:           code specific file. Use -skip_petscrc in the code specific file to skip the .petscrc files
665: -  help - [optional] Help message to print, use NULL for no message

667:    If you wish PETSc code to run ONLY on a subcommunicator of MPI_COMM_WORLD, create that
668:    communicator first and assign it to PETSC_COMM_WORLD BEFORE calling PetscInitialize(). Thus if you are running a
669:    four process job and two processes will run PETSc and have PetscInitialize() and PetscFinalize() and two process will not,
670:    then do this. If ALL processes in the job are using PetscInitialize() and PetscFinalize() then you don't need to do this, even
671:    if different subcommunicators of the job are doing different things with PETSc.

673:    Options Database Keys:
674: +  -help [intro] - prints help method for each option; if intro is given the program stops after printing the introductory help message
675: .  -start_in_debugger [noxterm,dbx,xdb,gdb,...] - Starts program in debugger
676: .  -on_error_attach_debugger [noxterm,dbx,xdb,gdb,...] - Starts debugger when error detected
677: .  -on_error_emacs <machinename> - causes emacsclient to jump to error file
678: .  -on_error_abort - calls abort() when error detected (no traceback)
679: .  -on_error_mpiabort - calls MPI_abort() when error detected
680: .  -error_output_stderr - prints error messages to stderr instead of the default stdout
681: .  -error_output_none - does not print the error messages (but handles errors in the same way as if this was not called)
682: .  -debugger_nodes [node1,node2,...] - Indicates nodes to start in debugger
683: .  -debugger_pause [sleeptime] (in seconds) - Pauses debugger
684: .  -stop_for_debugger - Print message on how to attach debugger manually to
685:                         process and wait (-debugger_pause) seconds for attachment
686: .  -malloc - Indicates use of PETSc error-checking malloc (on by default for debug version of libraries) (deprecated, use -malloc_debug)
687: .  -malloc no - Indicates not to use error-checking malloc (deprecated, use -malloc_debug no)
688: .  -malloc_debug - check for memory corruption at EVERY malloc or free, see PetscMallocSetDebug()
689: .  -malloc_dump - prints a list of all unfreed memory at the end of the run
690: .  -malloc_test - like -malloc_dump -malloc_debug, but only active for debugging builds, ignored in optimized build. May want to set in PETSC_OPTIONS environmental variable
691: .  -malloc_view - show a list of all allocated memory during PetscFinalize()
692: .  -malloc_view_threshold <t> - only list memory allocations of size greater than t with -malloc_view
693: .  -fp_trap - Stops on floating point exceptions
694: .  -no_signal_handler - Indicates not to trap error signals
695: .  -shared_tmp - indicates /tmp directory is shared by all processors
696: .  -not_shared_tmp - each processor has own /tmp
697: .  -tmp - alternative name of /tmp directory
698: .  -get_total_flops - returns total flops done by all processors
699: -  -memory_view - Print memory usage at end of run

701:    Options Database Keys for Profiling:
702:    See Users-Manual: Chapter 13 Profiling for details.
703: +  -info [filename][:[~]<list,of,classnames>[:[~]self]] - Prints verbose information. See PetscInfo().
704: .  -log_sync - Enable barrier synchronization for all events. This option is useful to debug imbalance within each event,
705:         however it slows things down and gives a distorted view of the overall runtime.
706: .  -log_trace [filename] - Print traces of all PETSc calls to the screen (useful to determine where a program
707:         hangs without running in the debugger).  See PetscLogTraceBegin().
708: .  -log_view [:filename:format] - Prints summary of flop and timing information to screen or file, see PetscLogView().
709: .  -log_view_memory - Includes in the summary from -log_view the memory used in each method, see PetscLogView().
710: .  -log_summary [filename] - (Deprecated, use -log_view) Prints summary of flop and timing information to screen. If the filename is specified the
711:         summary is written to the file.  See PetscLogView().
712: .  -log_exclude: <vec,mat,pc,ksp,snes> - excludes subset of object classes from logging
713: .  -log_all [filename] - Logs extensive profiling information  See PetscLogDump().
714: .  -log [filename] - Logs basic profiline information  See PetscLogDump().
715: .  -log_mpe [filename] - Creates a logfile viewable by the utility Jumpshot (in MPICH distribution)
716: .  -viewfromoptions on,off - Enable or disable XXXSetFromOptions() calls, for applications with many small solves turn this off
717: -  -check_pointer_intensity 0,1,2 - if pointers are checked for validity (debug version only), using 0 will result in faster code

719:     Only one of -log_trace, -log_view, -log_view, -log_all, -log, or -log_mpe may be used at a time

721:    Options Database Keys for SAWs:
722: +  -saws_port <portnumber> - port number to publish SAWs data, default is 8080
723: .  -saws_port_auto_select - have SAWs select a new unique port number where it publishes the data, the URL is printed to the screen
724:                             this is useful when you are running many jobs that utilize SAWs at the same time
725: .  -saws_log <filename> - save a log of all SAWs communication
726: .  -saws_https <certificate file> - have SAWs use HTTPS instead of HTTP
727: -  -saws_root <directory> - allow SAWs to have access to the given directory to search for requested resources and files

729:    Environmental Variables:
730: +   PETSC_TMP - alternative tmp directory
731: .   PETSC_SHARED_TMP - tmp is shared by all processes
732: .   PETSC_NOT_SHARED_TMP - each process has its own private tmp
733: .   PETSC_VIEWER_SOCKET_PORT - socket number to use for socket viewer
734: -   PETSC_VIEWER_SOCKET_MACHINE - machine to use for socket viewer to connect to


737:    Level: beginner

739:    Notes:
740:    If for some reason you must call MPI_Init() separately, call
741:    it before PetscInitialize().

743:    Fortran Version:
744:    In Fortran this routine has the format
745: $       call PetscInitialize(file,ierr)

747: +   ierr - error return code
748: -  file - [optional] PETSc database file, also checks ~username/.petscrc and .petscrc use PETSC_NULL_CHARACTER to not check for
749:           code specific file. Use -skip_petscrc in the code specific file to skip the .petscrc files

751:    Important Fortran Note:
752:    In Fortran, you MUST use PETSC_NULL_CHARACTER to indicate a
753:    null character string; you CANNOT just use NULL as
754:    in the C version. See Users-Manual: Chapter 11 PETSc for Fortran Users for details.

756:    If your main program is C but you call Fortran code that also uses PETSc you need to call PetscInitializeFortran() soon after
757:    calling PetscInitialize().

759: .seealso: PetscFinalize(), PetscInitializeFortran(), PetscGetArgs(), PetscInitializeNoArguments()

761: @*/
762: PetscErrorCode  PetscInitialize(int *argc,char ***args,const char file[],const char help[])
763: {
765:   PetscMPIInt    flag, size;
766:   PetscBool      flg = PETSC_TRUE;
767:   char           hostname[256];

770:   if (PetscInitializeCalled) return(0);
771:   /*
772:       The checking over compatible runtime libraries is complicated by the MPI ABI initiative
773:       https://wiki.mpich.org/mpich/index.php/ABI_Compatibility_Initiative which started with
774:         MPICH v3.1 (Released Feburary 2014)
775:         IBM MPI v2.1 (December 2014)
776:         Intel® MPI Library v5.0 (2014)
777:         Cray MPT v7.0.0 (June 2014)
778:       As of July 31, 2017 the ABI number still appears to be 12, that is all of the versions
779:       listed above and since that time are compatible.

781:       Unfortunately the MPI ABI initiative has not defined a way to determine the ABI number
782:       at compile time or runtime. Thus we will need to systematically track the allowed versions
783:       and how they are represented in the mpi.h and MPI_Get_library_version() output in order
784:       to perform the checking.

786:       Currently we only check for pre MPI ABI versions (and packages that do not follow the MPI ABI).

788:       Questions:

790:         Should the checks for ABI incompatibility be only on the major version number below?
791:         Presumably the output to stderr will be removed before a release.
792:   */

794: #if defined(PETSC_HAVE_MPI_GET_LIBRARY_VERSION)
795:   {
796:     char        mpilibraryversion[MPI_MAX_LIBRARY_VERSION_STRING];
797:     PetscMPIInt mpilibraryversionlength;
798:     MPI_Get_library_version(mpilibraryversion,&mpilibraryversionlength);if (ierr) return ierr;
799:     /* check for MPICH versions before MPI ABI initiative */
800: #if defined(MPICH_VERSION)
801: #if MPICH_NUMVERSION < 30100000
802:     {
803:       char *ver,*lf;
804:       flg = PETSC_FALSE;
805:       PetscStrstr(mpilibraryversion,"MPICH Version:",&ver);if (ierr) return ierr;
806:       if (ver) {
807:         PetscStrchr(ver,'\n',&lf);if (ierr) return ierr;
808:         if (lf) {
809:           *lf = 0;
810:           PetscStrendswith(ver,MPICH_VERSION,&flg);if (ierr) return ierr;
811:         }
812:       }
813:       if (!flg) {
814:         fprintf(stderr,"PETSc Error --- MPICH library version \n%s does not match what PETSc was compiled with %s, aborting\n",mpilibraryversion,MPICH_VERSION);
815:         return PETSC_ERR_MPI_LIB_INCOMP;
816:       }
817:     }
818: #endif
819:     /* check for OpenMPI version, it is not part of the MPI ABI initiative (is it part of another initiative that needs to be handled?) */
820: #elif defined(OMPI_MAJOR_VERSION)
821:     {
822:       char *ver,bs[32],*bsf;
823:       flg = PETSC_FALSE;
824:       PetscStrstr(mpilibraryversion,"Open MPI",&ver);if (ierr) return ierr;
825:       if (ver) {
826:         PetscSNPrintf(bs,32,"v%d.%d",OMPI_MAJOR_VERSION,OMPI_MINOR_VERSION);
827:         PetscStrstr(ver,bs,&bsf);if (ierr) return ierr;
828:         if (bsf) flg = PETSC_TRUE;
829:       }
830:       if (!flg) {
831:         fprintf(stderr,"PETSc Error --- Open MPI library version \n%s does not match what PETSc was compiled with %d.%d, aborting\n",mpilibraryversion,OMPI_MAJOR_VERSION,OMPI_MINOR_VERSION);
832:         return PETSC_ERR_MPI_LIB_INCOMP;
833:       }
834:     }
835: #endif
836:   }
837: #endif

839: #if defined(PETSC_HAVE_DLSYM)
840:   {
841:     PetscInt cnt = 0;
842:     /* These symbols are currently in the OpenMPI and MPICH libraries; they may not always be, in that case the test will simply not detect the problem */
843:     if (dlsym(RTLD_DEFAULT,"ompi_mpi_init")) cnt++;
844:     if (dlsym(RTLD_DEFAULT,"MPL_exit")) cnt++;
845:     if (cnt > 1) {
846:       fprintf(stderr,"PETSc Error --- Application was linked against both OpenMPI and MPICH based MPI libraries and will not run correctly\n");
847:       return PETSC_ERR_MPI_LIB_INCOMP;
848:     }
849:   }
850: #endif

852:   /* these must be initialized in a routine, not as a constant declaration*/
853:   PETSC_STDOUT = stdout;
854:   PETSC_STDERR = stderr;

856:   /* on Windows - set printf to default to printing 2 digit exponents */
857: #if defined(PETSC_HAVE__SET_OUTPUT_FORMAT)
858:   _set_output_format(_TWO_DIGIT_EXPONENT);
859: #endif

861:   PetscOptionsCreateDefault();

863:   /*
864:      We initialize the program name here (before MPI_Init()) because MPICH has a bug in
865:      it that it sets args[0] on all processors to be args[0] on the first processor.
866:   */
867:   if (argc && *argc) {
868:     PetscSetProgramName(**args);
869:   } else {
870:     PetscSetProgramName("Unknown Name");
871:   }

873:   MPI_Initialized(&flag);
874:   if (!flag) {
875:     if (PETSC_COMM_WORLD != MPI_COMM_NULL) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SUP,"You cannot set PETSC_COMM_WORLD if you have not initialized MPI first");
876:     PetscPreMPIInit_Private();
877: #if defined(PETSC_HAVE_MPI_INIT_THREAD)
878:     {
879:       PetscMPIInt provided;
880:       MPI_Init_thread(argc,args,MPI_THREAD_FUNNELED,&provided);
881:     }
882: #else
883:     MPI_Init(argc,args);
884: #endif
885:     PetscBeganMPI = PETSC_TRUE;
886:   }

888:   if (argc && args) {
889:     PetscGlobalArgc = *argc;
890:     PetscGlobalArgs = *args;
891:   }
892:   PetscFinalizeCalled = PETSC_FALSE;
893:   PetscSpinlockCreate(&PetscViewerASCIISpinLockOpen);
894:   PetscSpinlockCreate(&PetscViewerASCIISpinLockStdout);
895:   PetscSpinlockCreate(&PetscViewerASCIISpinLockStderr);
896:   PetscSpinlockCreate(&PetscCommSpinLock);

898:   if (PETSC_COMM_WORLD == MPI_COMM_NULL) PETSC_COMM_WORLD = MPI_COMM_WORLD;
899:   MPI_Comm_set_errhandler(PETSC_COMM_WORLD,MPI_ERRORS_RETURN);

901:   if (PETSC_MPI_ERROR_CLASS == MPI_ERR_LASTCODE) {
902:     MPI_Add_error_class(&PETSC_MPI_ERROR_CLASS);
903:     MPI_Add_error_code(PETSC_MPI_ERROR_CLASS,&PETSC_MPI_ERROR_CODE);
904:   }

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

909:   MPI_Comm_rank(MPI_COMM_WORLD,&PetscGlobalRank);
910:   MPI_Comm_size(MPI_COMM_WORLD,&PetscGlobalSize);

912:   MPIU_BOOL = MPI_INT;
913:   MPIU_ENUM = MPI_INT;
914:   MPIU_FORTRANADDR = (sizeof(void*) == sizeof(int)) ? MPI_INT : MPIU_INT64;
915:   if (sizeof(size_t) == sizeof(unsigned)) MPIU_SIZE_T = MPI_UNSIGNED;
916:   else if (sizeof(size_t) == sizeof(unsigned long)) MPIU_SIZE_T = MPI_UNSIGNED_LONG;
917: #if defined(PETSC_SIZEOF_LONG_LONG)
918:   else if (sizeof(size_t) == sizeof(unsigned long long)) MPIU_SIZE_T = MPI_UNSIGNED_LONG_LONG;
919: #endif
920:   else {(*PetscErrorPrintf)("PetscInitialize: Could not find MPI type for size_t\n"); return PETSC_ERR_SUP_SYS;}

922:   /*
923:      Initialized the global complex variable; this is because with
924:      shared libraries the constructors for global variables
925:      are not called; at least on IRIX.
926:   */
927: #if defined(PETSC_HAVE_COMPLEX)
928:   {
929: #if defined(PETSC_CLANGUAGE_CXX) && !defined(PETSC_USE_REAL___FLOAT128)
930:     PetscComplex ic(0.0,1.0);
931:     PETSC_i = ic;
932: #else
933:     PETSC_i = _Complex_I;
934: #endif
935:   }

937: #if !defined(PETSC_HAVE_MPI_C_DOUBLE_COMPLEX)
938:   MPI_Type_contiguous(2,MPI_DOUBLE,&MPIU_C_DOUBLE_COMPLEX);
939:   MPI_Type_commit(&MPIU_C_DOUBLE_COMPLEX);
940:   MPI_Type_contiguous(2,MPI_FLOAT,&MPIU_C_COMPLEX);
941:   MPI_Type_commit(&MPIU_C_COMPLEX);
942: #endif
943: #endif /* PETSC_HAVE_COMPLEX */

945:   /*
946:      Create the PETSc MPI reduction operator that sums of the first
947:      half of the entries and maxes the second half.
948:   */
949:   MPI_Op_create(MPIU_MaxSum_Local,1,&MPIU_MAXSUM_OP);

951: #if defined(PETSC_USE_REAL___FLOAT128)
952:   MPI_Type_contiguous(2,MPI_DOUBLE,&MPIU___FLOAT128);
953:   MPI_Type_commit(&MPIU___FLOAT128);
954: #if defined(PETSC_HAVE_COMPLEX)
955:   MPI_Type_contiguous(4,MPI_DOUBLE,&MPIU___COMPLEX128);
956:   MPI_Type_commit(&MPIU___COMPLEX128);
957: #endif
958:   MPI_Op_create(PetscMax_Local,1,&MPIU_MAX);
959:   MPI_Op_create(PetscMin_Local,1,&MPIU_MIN);
960: #elif defined(PETSC_USE_REAL___FP16)
961:   MPI_Type_contiguous(2,MPI_CHAR,&MPIU___FP16);
962:   MPI_Type_commit(&MPIU___FP16);
963:   MPI_Op_create(PetscMax_Local,1,&MPIU_MAX);
964:   MPI_Op_create(PetscMin_Local,1,&MPIU_MIN);
965: #endif

967: #if (defined(PETSC_HAVE_COMPLEX) && !defined(PETSC_HAVE_MPI_C_DOUBLE_COMPLEX)) || defined(PETSC_USE_REAL___FLOAT128) || defined(PETSC_USE_REAL___FP16)
968:   MPI_Op_create(PetscSum_Local,1,&MPIU_SUM);
969: #endif

971:   MPI_Type_contiguous(2,MPIU_SCALAR,&MPIU_2SCALAR);
972:   MPI_Type_commit(&MPIU_2SCALAR);

974: #if defined(PETSC_USE_64BIT_INDICES)
975:   MPI_Type_contiguous(2,MPIU_INT,&MPIU_2INT);
976:   MPI_Type_commit(&MPIU_2INT);
977: #endif


980:   /*
981:      Attributes to be set on PETSc communicators
982:   */
983:   MPI_Comm_create_keyval(MPI_COMM_NULL_COPY_FN,Petsc_Counter_Attr_Delete_Fn,&Petsc_Counter_keyval,(void*)0);
984:   MPI_Comm_create_keyval(MPI_COMM_NULL_COPY_FN,Petsc_InnerComm_Attr_Delete_Fn,&Petsc_InnerComm_keyval,(void*)0);
985:   MPI_Comm_create_keyval(MPI_COMM_NULL_COPY_FN,Petsc_OuterComm_Attr_Delete_Fn,&Petsc_OuterComm_keyval,(void*)0);
986:   MPI_Comm_create_keyval(MPI_COMM_NULL_COPY_FN,Petsc_ShmComm_Attr_Delete_Fn,&Petsc_ShmComm_keyval,(void*)0);

988:   /*
989:      Build the options database
990:   */
991:   PetscOptionsInsert(NULL,argc,args,file);

993:   /* call a second time so it can look in the options database */
994:   PetscErrorPrintfInitialize();

996:   /*
997:      Print main application help message
998:   */
999:   PetscOptionsHasHelp(NULL,&flg);
1000:   if (help && flg) {
1001:     PetscPrintf(PETSC_COMM_WORLD,help);
1002:   }
1003:   PetscOptionsCheckInitial_Private();

1005:   PetscCitationsInitialize();

1007: #if defined(PETSC_HAVE_SAWS)
1008:   PetscInitializeSAWs(help);
1009: #endif

1011:   /*
1012:      Load the dynamic libraries (on machines that support them), this registers all
1013:      the solvers etc. (On non-dynamic machines this initializes the PetscDraw and PetscViewer classes)
1014:   */
1015:   PetscInitialize_DynamicLibraries();

1017:   MPI_Comm_size(PETSC_COMM_WORLD,&size);
1018:   PetscInfo1(NULL,"PETSc successfully started: number of processors = %d\n",size);
1019:   PetscGetHostName(hostname,256);
1020:   PetscInfo1(NULL,"Running on machine: %s\n",hostname);
1021: #if defined(PETSC_HAVE_OPENMP)
1022:   {
1023:     PetscBool omp_view_flag;
1024:     char      *threads = getenv("OMP_NUM_THREADS");

1026:    if (threads) {
1027:      PetscInfo1(NULL,"Number of OpenMP threads %s (given by OMP_NUM_THREADS)\n",threads);
1028:      (void) sscanf(threads, "%" PetscInt_FMT,&PetscNumOMPThreads);
1029:    } else {
1030: #define NMAX  10000
1031:      int          i;
1032:       PetscScalar *x;
1033:       PetscMalloc1(NMAX,&x);
1034: #pragma omp parallel for
1035:       for (i=0; i<NMAX; i++) {
1036:         x[i] = 0.0;
1037:         PetscNumOMPThreads  = (PetscInt) omp_get_num_threads();
1038:       }
1039:       PetscFree(x);
1040:       PetscInfo1(NULL,"Number of OpenMP threads %D (number not set with OMP_NUM_THREADS, chosen by system)\n",PetscNumOMPThreads);
1041:     }
1042:     PetscOptionsBegin(PETSC_COMM_WORLD,NULL,"OpenMP options","Sys");
1043:     PetscOptionsInt("-omp_num_threads","Number of OpenMP threads to use (can also use environmental variable OMP_NUM_THREADS","None",PetscNumOMPThreads,&PetscNumOMPThreads,&flg);
1044:     PetscOptionsName("-omp_view","Display OpenMP number of threads",NULL,&omp_view_flag);
1045:     PetscOptionsEnd();
1046:     if (flg) {
1047:       PetscInfo1(NULL,"Number of OpenMP theads %D (given by -omp_num_threads)\n",PetscNumOMPThreads);
1048:       omp_set_num_threads((int)PetscNumOMPThreads);
1049:     }
1050:     if (omp_view_flag) {
1051:       PetscPrintf(PETSC_COMM_WORLD,"OpenMP: number of threads %D\n",PetscNumOMPThreads);
1052:     }
1053:   }
1054: #endif
1055:   /* Check the options database for options related to the options database itself */
1056:   PetscOptionsSetFromOptions(NULL);

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

1062:       Currently not used because it is not supported by MPICH.
1063:   */
1064:   if (!PetscBinaryBigEndian()) {
1065:     MPI_Register_datarep((char*)"petsc",PetscDataRep_read_conv_fn,PetscDataRep_write_conv_fn,PetscDataRep_extent_fn,NULL);
1066:   }
1067: #endif

1069:   /*
1070:       Setup building of stack frames for all function calls
1071:   */
1072: #if defined(PETSC_USE_DEBUG) && !defined(PETSC_HAVE_THREADSAFETY)
1073:   PetscStackCreate();
1074: #endif

1076: #if defined(PETSC_SERIALIZE_FUNCTIONS)
1077:   PetscFPTCreate(10000);
1078: #endif

1080: #if defined(PETSC_HAVE_HWLOC)
1081:   {
1082:     PetscViewer viewer;
1083:     PetscOptionsGetViewer(PETSC_COMM_WORLD,NULL,NULL,"-process_view",&viewer,NULL,&flg);
1084:     if (flg) {
1085:       PetscProcessPlacementView(viewer);
1086:       PetscViewerDestroy(&viewer);
1087:     }
1088:   }
1089: #endif

1091:   flg = PETSC_TRUE;
1092:   PetscOptionsGetBool(NULL,NULL,"-viewfromoptions",&flg,NULL);
1093:   if (!flg) {PetscOptionsPushGetViewerOff(PETSC_TRUE); }

1095: #if defined(PETSC_HAVE_ADIOS)
1096:   adios_init_noxml(PETSC_COMM_WORLD);
1097:   adios_declare_group(&Petsc_adios_group,"PETSc","",adios_stat_default);
1098:   adios_select_method(Petsc_adios_group,"MPI","","");
1099:   adios_read_init_method(ADIOS_READ_METHOD_BP,PETSC_COMM_WORLD,"");
1100: #endif
1101: #if defined(PETSC_HAVE_ADIOS2)
1102: #endif

1104:   /*
1105:       Once we are completedly initialized then we can set this variables
1106:   */
1107:   PetscInitializeCalled = PETSC_TRUE;

1109:   PetscOptionsHasName(NULL,NULL,"-python",&flg);
1110:   if (flg) {PetscPythonInitialize(NULL,NULL);}
1111:   return(0);
1112: }

1114: #if defined(PETSC_USE_LOG)
1115: PETSC_INTERN PetscObject *PetscObjects;
1116: PETSC_INTERN PetscInt    PetscObjectsCounts;
1117: PETSC_INTERN PetscInt    PetscObjectsMaxCounts;
1118: PETSC_INTERN PetscBool   PetscObjectsLog;
1119: #endif

1121: /*
1122:     Frees all the MPI types and operations that PETSc may have created
1123: */
1124: PetscErrorCode  PetscFreeMPIResources(void)
1125: {

1129: #if defined(PETSC_USE_REAL___FLOAT128)
1130:   MPI_Type_free(&MPIU___FLOAT128);
1131: #if defined(PETSC_HAVE_COMPLEX)
1132:   MPI_Type_free(&MPIU___COMPLEX128);
1133: #endif
1134:   MPI_Op_free(&MPIU_MAX);
1135:   MPI_Op_free(&MPIU_MIN);
1136: #elif defined(PETSC_USE_REAL___FP16)
1137:   MPI_Type_free(&MPIU___FP16);
1138:   MPI_Op_free(&MPIU_MAX);
1139:   MPI_Op_free(&MPIU_MIN);
1140: #endif

1142: #if defined(PETSC_HAVE_COMPLEX)
1143: #if !defined(PETSC_HAVE_MPI_C_DOUBLE_COMPLEX)
1144:   MPI_Type_free(&MPIU_C_DOUBLE_COMPLEX);
1145:   MPI_Type_free(&MPIU_C_COMPLEX);
1146: #endif
1147: #endif

1149: #if (defined(PETSC_HAVE_COMPLEX) && !defined(PETSC_HAVE_MPI_C_DOUBLE_COMPLEX)) || defined(PETSC_USE_REAL___FLOAT128) || defined(PETSC_USE_REAL___FP16)
1150:   MPI_Op_free(&MPIU_SUM);
1151: #endif

1153:   MPI_Type_free(&MPIU_2SCALAR);
1154: #if defined(PETSC_USE_64BIT_INDICES)
1155:   MPI_Type_free(&MPIU_2INT);
1156: #endif
1157:   MPI_Op_free(&MPIU_MAXSUM_OP);
1158:   return(0);
1159: }

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

1166:    Collective on PETSC_COMM_WORLD

1168:    Options Database Keys:
1169: +  -options_view - Calls PetscOptionsView()
1170: .  -options_left - Prints unused options that remain in the database
1171: .  -objects_dump [all] - Prints list of objects allocated by the user that have not been freed, the option all cause all outstanding objects to be listed
1172: .  -mpidump - Calls PetscMPIDump()
1173: .  -malloc_dump <optional filename> - Calls PetscMallocDump(), displays all memory allocated that has not been freed
1174: .  -malloc_info - Prints total memory usage
1175: -  -malloc_view <optional filename> - Prints list of all memory allocated and where

1177:    Level: beginner

1179:    Note:
1180:    See PetscInitialize() for more general runtime options.

1182: .seealso: PetscInitialize(), PetscOptionsView(), PetscMallocDump(), PetscMPIDump(), PetscEnd()
1183: @*/
1184: PetscErrorCode  PetscFinalize(void)
1185: {
1187:   PetscMPIInt    rank;
1188:   PetscInt       nopt;
1189:   PetscBool      flg1 = PETSC_FALSE,flg2 = PETSC_FALSE,flg3 = PETSC_FALSE;
1190:   PetscBool      flg;
1191: #if defined(PETSC_USE_LOG)
1192:   char           mname[PETSC_MAX_PATH_LEN];
1193: #endif

1195:   if (!PetscInitializeCalled) {
1196:     printf("PetscInitialize() must be called before PetscFinalize()\n");
1197:     return(PETSC_ERR_ARG_WRONGSTATE);
1198:   }
1200:   PetscInfo(NULL,"PetscFinalize() called\n");

1202:   MPI_Comm_rank(PETSC_COMM_WORLD,&rank);
1203: #if defined(PETSC_HAVE_ADIOS)
1204:   adios_read_finalize_method(ADIOS_READ_METHOD_BP_AGGREGATE);
1205:   adios_finalize(rank);
1206: #endif
1207: #if defined(PETSC_HAVE_ADIOS2)
1208: #endif
1209:   PetscOptionsHasName(NULL,NULL,"-citations",&flg);
1210:   if (flg) {
1211:     char  *cits, filename[PETSC_MAX_PATH_LEN];
1212:     FILE  *fd = PETSC_STDOUT;

1214:     PetscOptionsGetString(NULL,NULL,"-citations",filename,PETSC_MAX_PATH_LEN,NULL);
1215:     if (filename[0]) {
1216:       PetscFOpen(PETSC_COMM_WORLD,filename,"w",&fd);
1217:     }
1218:     PetscSegBufferGet(PetscCitationsList,1,&cits);
1219:     cits[0] = 0;
1220:     PetscSegBufferExtractAlloc(PetscCitationsList,&cits);
1221:     PetscFPrintf(PETSC_COMM_WORLD,fd,"If you publish results based on this computation please cite the following:\n");
1222:     PetscFPrintf(PETSC_COMM_WORLD,fd,"===========================================================================\n");
1223:     PetscFPrintf(PETSC_COMM_WORLD,fd,"%s",cits);
1224:     PetscFPrintf(PETSC_COMM_WORLD,fd,"===========================================================================\n");
1225:     PetscFClose(PETSC_COMM_WORLD,fd);
1226:     PetscFree(cits);
1227:   }
1228:   PetscSegBufferDestroy(&PetscCitationsList);

1230: #if defined(PETSC_HAVE_SSL) && defined(PETSC_USE_SOCKET_VIEWER)
1231:   /* TextBelt is run for testing purposes only, please do not use this feature often */
1232:   {
1233:     PetscInt nmax = 2;
1234:     char     **buffs;
1235:     PetscMalloc1(2,&buffs);
1236:     PetscOptionsGetStringArray(NULL,NULL,"-textbelt",buffs,&nmax,&flg1);
1237:     if (flg1) {
1238:       if (!nmax) SETERRQ(PETSC_COMM_WORLD,PETSC_ERR_USER,"-textbelt requires either the phone number or number,\"message\"");
1239:       if (nmax == 1) {
1240:         PetscMalloc1(128,&buffs[1]);
1241:         PetscGetProgramName(buffs[1],32);
1242:         PetscStrcat(buffs[1]," has completed");
1243:       }
1244:       PetscTextBelt(PETSC_COMM_WORLD,buffs[0],buffs[1],NULL);
1245:       PetscFree(buffs[0]);
1246:       PetscFree(buffs[1]);
1247:     }
1248:     PetscFree(buffs);
1249:   }
1250:   {
1251:     PetscInt nmax = 2;
1252:     char     **buffs;
1253:     PetscMalloc1(2,&buffs);
1254:     PetscOptionsGetStringArray(NULL,NULL,"-tellmycell",buffs,&nmax,&flg1);
1255:     if (flg1) {
1256:       if (!nmax) SETERRQ(PETSC_COMM_WORLD,PETSC_ERR_USER,"-tellmycell requires either the phone number or number,\"message\"");
1257:       if (nmax == 1) {
1258:         PetscMalloc1(128,&buffs[1]);
1259:         PetscGetProgramName(buffs[1],32);
1260:         PetscStrcat(buffs[1]," has completed");
1261:       }
1262:       PetscTellMyCell(PETSC_COMM_WORLD,buffs[0],buffs[1],NULL);
1263:       PetscFree(buffs[0]);
1264:       PetscFree(buffs[1]);
1265:     }
1266:     PetscFree(buffs);
1267:   }
1268: #endif
1269:   /*
1270:     It should be safe to cancel the options monitors, since we don't expect to be setting options
1271:     here (at least that are worth monitoring).  Monitors ought to be released so that they release
1272:     whatever memory was allocated there before -malloc_dump reports unfreed memory.
1273:   */
1274:   PetscOptionsMonitorCancel();

1276: #if defined(PETSC_SERIALIZE_FUNCTIONS)
1277:   PetscFPTDestroy();
1278: #endif


1281: #if defined(PETSC_HAVE_SAWS)
1282:   flg = PETSC_FALSE;
1283:   PetscOptionsGetBool(NULL,NULL,"-saw_options",&flg,NULL);
1284:   if (flg) {
1285:     PetscOptionsSAWsDestroy();
1286:   }
1287: #endif

1289: #if defined(PETSC_HAVE_X)
1290:   flg1 = PETSC_FALSE;
1291:   PetscOptionsGetBool(NULL,NULL,"-x_virtual",&flg1,NULL);
1292:   if (flg1) {
1293:     /*  this is a crude hack, but better than nothing */
1294:     PetscPOpen(PETSC_COMM_WORLD,NULL,"pkill -9 Xvfb","r",NULL);
1295:   }
1296: #endif

1298: #if !defined(PETSC_HAVE_THREADSAFETY)
1299:   PetscOptionsGetBool(NULL,NULL,"-malloc_info",&flg2,NULL);
1300:   if (!flg2) {
1301:     flg2 = PETSC_FALSE;
1302:     PetscOptionsGetBool(NULL,NULL,"-memory_view",&flg2,NULL);
1303:   }
1304:   if (flg2) {
1305:     PetscMemoryView(PETSC_VIEWER_STDOUT_WORLD,"Summary of Memory Usage in PETSc\n");
1306:   }
1307: #endif

1309: #if defined(PETSC_USE_LOG)
1310:   flg1 = PETSC_FALSE;
1311:   PetscOptionsGetBool(NULL,NULL,"-get_total_flops",&flg1,NULL);
1312:   if (flg1) {
1313:     PetscLogDouble flops = 0;
1314:     MPI_Reduce(&petsc_TotalFlops,&flops,1,MPI_DOUBLE,MPI_SUM,0,PETSC_COMM_WORLD);
1315:     PetscPrintf(PETSC_COMM_WORLD,"Total flops over all processors %g\n",flops);
1316:   }
1317: #endif


1320: #if defined(PETSC_USE_LOG)
1321: #if defined(PETSC_HAVE_MPE)
1322:   mname[0] = 0;
1323:   PetscOptionsGetString(NULL,NULL,"-log_mpe",mname,PETSC_MAX_PATH_LEN,&flg1);
1324:   if (flg1) {
1325:     if (mname[0]) {PetscLogMPEDump(mname);}
1326:     else          {PetscLogMPEDump(0);}
1327:   }
1328: #endif
1329: #endif

1331:   /*
1332:      Free all objects registered with PetscObjectRegisterDestroy() such as PETSC_VIEWER_XXX_().
1333:   */
1334:   PetscObjectRegisterDestroyAll();

1336: #if defined(PETSC_USE_LOG)
1337:   PetscOptionsPushGetViewerOff(PETSC_FALSE);
1338:   PetscLogViewFromOptions();
1339:   PetscOptionsPopGetViewerOff();

1341:   mname[0] = 0;
1342:   PetscOptionsGetString(NULL,NULL,"-log_summary",mname,PETSC_MAX_PATH_LEN,&flg1);
1343:   if (flg1) {
1344:     PetscViewer viewer;
1345:     (*PetscHelpPrintf)(PETSC_COMM_WORLD,"\n\n WARNING:   -log_summary is being deprecated; switch to -log_view\n\n\n");
1346:     if (mname[0]) {
1347:       PetscViewerASCIIOpen(PETSC_COMM_WORLD,mname,&viewer);
1348:       PetscLogView(viewer);
1349:       PetscViewerDestroy(&viewer);
1350:     } else {
1351:       viewer = PETSC_VIEWER_STDOUT_WORLD;
1352:       PetscViewerPushFormat(viewer,PETSC_VIEWER_DEFAULT);
1353:       PetscLogView(viewer);
1354:       PetscViewerPopFormat(viewer);
1355:     }
1356:   }

1358:   /*
1359:      Free any objects created by the last block of code.
1360:   */
1361:   PetscObjectRegisterDestroyAll();

1363:   mname[0] = 0;
1364:   PetscOptionsGetString(NULL,NULL,"-log_all",mname,PETSC_MAX_PATH_LEN,&flg1);
1365:   PetscOptionsGetString(NULL,NULL,"-log",mname,PETSC_MAX_PATH_LEN,&flg2);
1366:   if (flg1 || flg2) {PetscLogDump(mname);}
1367: #endif

1369:   PetscStackDestroy();

1371:   flg1 = PETSC_FALSE;
1372:   PetscOptionsGetBool(NULL,NULL,"-no_signal_handler",&flg1,NULL);
1373:   if (!flg1) { PetscPopSignalHandler();}
1374:   flg1 = PETSC_FALSE;
1375:   PetscOptionsGetBool(NULL,NULL,"-mpidump",&flg1,NULL);
1376:   if (flg1) {
1377:     PetscMPIDump(stdout);
1378:   }
1379:   flg1 = PETSC_FALSE;
1380:   flg2 = PETSC_FALSE;
1381:   /* preemptive call to avoid listing this option in options table as unused */
1382:   PetscOptionsHasName(NULL,NULL,"-malloc_dump",&flg1);
1383:   PetscOptionsHasName(NULL,NULL,"-objects_dump",&flg1);
1384:   PetscOptionsGetBool(NULL,NULL,"-options_view",&flg2,NULL);

1386:   if (flg2) {
1387:     PetscViewer viewer;
1388:     PetscViewerCreate(PETSC_COMM_WORLD,&viewer);
1389:     PetscViewerSetType(viewer,PETSCVIEWERASCII);
1390:     PetscOptionsView(NULL,viewer);
1391:     PetscViewerDestroy(&viewer);
1392:   }

1394:   /* to prevent PETSc -options_left from warning */
1395:   PetscOptionsHasName(NULL,NULL,"-nox",&flg1);
1396:   PetscOptionsHasName(NULL,NULL,"-nox_warning",&flg1);

1398:   flg3 = PETSC_FALSE; /* default value is required */
1399:   PetscOptionsGetBool(NULL,NULL,"-options_left",&flg3,&flg1);
1400: #if defined(PETSC_USE_DEBUG)
1401:   if (!flg1) flg3 = PETSC_TRUE;
1402: #endif
1403:   if (flg3) {
1404:     if (!flg2 && flg1) { /* have not yet printed the options */
1405:       PetscViewer viewer;
1406:       PetscViewerCreate(PETSC_COMM_WORLD,&viewer);
1407:       PetscViewerSetType(viewer,PETSCVIEWERASCII);
1408:       PetscOptionsView(NULL,viewer);
1409:       PetscViewerDestroy(&viewer);
1410:     }
1411:     PetscOptionsAllUsed(NULL,&nopt);
1412:     if (nopt) {
1413:       PetscPrintf(PETSC_COMM_WORLD,"WARNING! There are options you set that were not used!\n");
1414:       PetscPrintf(PETSC_COMM_WORLD,"WARNING! could be spelling mistake, etc!\n");
1415:       if (nopt == 1) {
1416:         PetscPrintf(PETSC_COMM_WORLD,"There is one unused database option. It is:\n");
1417:       } else {
1418:         PetscPrintf(PETSC_COMM_WORLD,"There are %D unused database options. They are:\n",nopt);
1419:       }
1420:     } else if (flg3 && flg1) {
1421:       PetscPrintf(PETSC_COMM_WORLD,"There are no unused options.\n");
1422:     }
1423:     PetscOptionsLeft(NULL);
1424:   }

1426: #if defined(PETSC_HAVE_SAWS)
1427:   if (!PetscGlobalRank) {
1428:     PetscStackSAWsViewOff();
1429:     PetscStackCallSAWs(SAWs_Finalize,());
1430:   }
1431: #endif

1433: #if defined(PETSC_USE_LOG)
1434:   /*
1435:        List all objects the user may have forgot to free
1436:   */
1437:   if (PetscObjectsLog) {
1438:     PetscOptionsHasName(NULL,NULL,"-objects_dump",&flg1);
1439:     if (flg1) {
1440:       MPI_Comm local_comm;
1441:       char     string[64];

1443:       PetscOptionsGetString(NULL,NULL,"-objects_dump",string,64,NULL);
1444:       MPI_Comm_dup(MPI_COMM_WORLD,&local_comm);
1445:       PetscSequentialPhaseBegin_Private(local_comm,1);
1446:       PetscObjectsDump(stdout,(string[0] == 'a') ? PETSC_TRUE : PETSC_FALSE);
1447:       PetscSequentialPhaseEnd_Private(local_comm,1);
1448:       MPI_Comm_free(&local_comm);
1449:     }
1450:   }
1451: #endif

1453: #if defined(PETSC_USE_LOG)
1454:   PetscObjectsCounts    = 0;
1455:   PetscObjectsMaxCounts = 0;
1456:   PetscFree(PetscObjects);
1457: #endif

1459:   /*
1460:      Destroy any packages that registered a finalize
1461:   */
1462:   PetscRegisterFinalizeAll();

1464: #if defined(PETSC_USE_LOG)
1465:   PetscLogFinalize();
1466: #endif

1468:   /*
1469:      Print PetscFunctionLists that have not been properly freed

1471:   PetscFunctionListPrintAll();
1472:   */

1474:   if (petsc_history) {
1475:     PetscCloseHistoryFile(&petsc_history);
1476:     petsc_history = NULL;
1477:   }
1478:   PetscOptionsHelpPrintedDestroy(&PetscOptionsHelpPrintedSingleton);
1479:   PetscInfoDestroy();

1481: #if !defined(PETSC_HAVE_THREADSAFETY)
1482:   if (!(PETSC_RUNNING_ON_VALGRIND)) {
1483:     char fname[PETSC_MAX_PATH_LEN];
1484:     char sname[PETSC_MAX_PATH_LEN];
1485:     FILE *fd;
1486:     int  err;

1488:     flg2 = PETSC_FALSE;
1489:     flg3 = PETSC_FALSE;
1490: #if defined(PETSC_USE_DEBUG)
1491:     PetscOptionsGetBool(NULL,NULL,"-malloc_test",&flg2,NULL);
1492: #endif
1493:     PetscOptionsGetBool(NULL,NULL,"-malloc_debug",&flg3,NULL);
1494:     fname[0] = 0;
1495:     PetscOptionsGetString(NULL,NULL,"-malloc_dump",fname,250,&flg1);
1496:     if (flg1 && fname[0]) {

1498:       PetscSNPrintf(sname,PETSC_MAX_PATH_LEN,"%s_%d",fname,rank);
1499:       fd   = fopen(sname,"w"); if (!fd) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_FILE_OPEN,"Cannot open log file: %s",sname);
1500:       PetscMallocDump(fd);
1501:       err  = fclose(fd);
1502:       if (err) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SYS,"fclose() failed on file");
1503:     } else if (flg1 || flg2 || flg3) {
1504:       MPI_Comm local_comm;

1506:       MPI_Comm_dup(MPI_COMM_WORLD,&local_comm);
1507:       PetscSequentialPhaseBegin_Private(local_comm,1);
1508:       PetscMallocDump(stdout);
1509:       PetscSequentialPhaseEnd_Private(local_comm,1);
1510:       MPI_Comm_free(&local_comm);
1511:     }
1512:     fname[0] = 0;
1513:     PetscOptionsGetString(NULL,NULL,"-malloc_view",fname,250,&flg1);
1514:     if (flg1 && fname[0]) {

1516:       PetscSNPrintf(sname,PETSC_MAX_PATH_LEN,"%s_%d",fname,rank);
1517:       fd   = fopen(sname,"w"); if (!fd) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_FILE_OPEN,"Cannot open log file: %s",sname);
1518:       PetscMallocView(fd);
1519:       err  = fclose(fd);
1520:       if (err) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SYS,"fclose() failed on file");
1521:     } else if (flg1) {
1522:       MPI_Comm local_comm;

1524:       MPI_Comm_dup(MPI_COMM_WORLD,&local_comm);
1525:       PetscSequentialPhaseBegin_Private(local_comm,1);
1526:       PetscMallocView(stdout);
1527:       PetscSequentialPhaseEnd_Private(local_comm,1);
1528:       MPI_Comm_free(&local_comm);
1529:     }
1530:   }
1531: #endif

1533:   /*
1534:      Close any open dynamic libraries
1535:   */
1536:   PetscFinalize_DynamicLibraries();

1538:   /* Can be destroyed only after all the options are used */
1539:   PetscOptionsDestroyDefault();

1541:   PetscGlobalArgc = 0;
1542:   PetscGlobalArgs = NULL;

1544:   PetscFreeMPIResources();

1546:   /*
1547:      Destroy any known inner MPI_Comm's and attributes pointing to them
1548:      Note this will not destroy any new communicators the user has created.

1550:      If all PETSc objects were not destroyed those left over objects will have hanging references to
1551:      the MPI_Comms that were freed; but that is ok because those PETSc objects will never be used again
1552:  */
1553:   {
1554:     PetscCommCounter *counter;
1555:     PetscMPIInt      flg;
1556:     MPI_Comm         icomm;
1557:     union {MPI_Comm comm; void *ptr;} ucomm;
1558:     MPI_Comm_get_attr(PETSC_COMM_SELF,Petsc_InnerComm_keyval,&ucomm,&flg);
1559:     if (flg) {
1560:       icomm = ucomm.comm;
1561:       MPI_Comm_get_attr(icomm,Petsc_Counter_keyval,&counter,&flg);
1562:       if (!flg) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_CORRUPT,"Inner MPI_Comm does not have expected tag/name counter, problem with corrupted memory");

1564:       MPI_Comm_delete_attr(PETSC_COMM_SELF,Petsc_InnerComm_keyval);
1565:       MPI_Comm_delete_attr(icomm,Petsc_Counter_keyval);
1566:       MPI_Comm_free(&icomm);
1567:     }
1568:     MPI_Comm_get_attr(PETSC_COMM_WORLD,Petsc_InnerComm_keyval,&ucomm,&flg);
1569:     if (flg) {
1570:       icomm = ucomm.comm;
1571:       MPI_Comm_get_attr(icomm,Petsc_Counter_keyval,&counter,&flg);
1572:       if (!flg) SETERRQ(PETSC_COMM_WORLD,PETSC_ERR_ARG_CORRUPT,"Inner MPI_Comm does not have expected tag/name counter, problem with corrupted memory");

1574:       MPI_Comm_delete_attr(PETSC_COMM_WORLD,Petsc_InnerComm_keyval);
1575:       MPI_Comm_delete_attr(icomm,Petsc_Counter_keyval);
1576:       MPI_Comm_free(&icomm);
1577:     }
1578:   }

1580:   MPI_Comm_free_keyval(&Petsc_Counter_keyval);
1581:   MPI_Comm_free_keyval(&Petsc_InnerComm_keyval);
1582:   MPI_Comm_free_keyval(&Petsc_OuterComm_keyval);
1583:   MPI_Comm_free_keyval(&Petsc_ShmComm_keyval);

1585:   PetscSpinlockDestroy(&PetscViewerASCIISpinLockOpen);
1586:   PetscSpinlockDestroy(&PetscViewerASCIISpinLockStdout);
1587:   PetscSpinlockDestroy(&PetscViewerASCIISpinLockStderr);
1588:   PetscSpinlockDestroy(&PetscCommSpinLock);

1590:   if (PetscBeganMPI) {
1591: #if defined(PETSC_HAVE_MPI_FINALIZED)
1592:     PetscMPIInt flag;
1593:     MPI_Finalized(&flag);
1594:     if (flag) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_LIB,"MPI_Finalize() has already been called, even though MPI_Init() was called by PetscInitialize()");
1595: #endif
1596:     MPI_Finalize();
1597:   }
1598: /*

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

1608: */
1609:   PetscMallocClear();

1611:   PetscInitializeCalled = PETSC_FALSE;
1612:   PetscFinalizeCalled   = PETSC_TRUE;
1613:   return(0);
1614: }

1616: #if defined(PETSC_MISSING_LAPACK_lsame_)
1617: PETSC_EXTERN int lsame_(char *a,char *b)
1618: {
1619:   if (*a == *b) return 1;
1620:   if (*a + 32 == *b) return 1;
1621:   if (*a - 32 == *b) return 1;
1622:   return 0;
1623: }
1624: #endif

1626: #if defined(PETSC_MISSING_LAPACK_lsame)
1627: PETSC_EXTERN int lsame(char *a,char *b)
1628: {
1629:   if (*a == *b) return 1;
1630:   if (*a + 32 == *b) return 1;
1631:   if (*a - 32 == *b) return 1;
1632:   return 0;
1633: }
1634: #endif