xref: /petsc/src/sys/objects/pinit.c (revision 037b95cde79452d70b8bdd0435431ae8a288d18d)
1 
2 /*
3    This file defines the initialization of PETSc, including PetscInitialize()
4 */
5 #include <petsc/private/petscimpl.h>        /*I  "petscsys.h"   I*/
6 #include <petscvalgrind.h>
7 #include <petscviewer.h>
8 
9 #if defined(PETSC_USE_LOG)
10 PETSC_INTERN PetscErrorCode PetscLogInitialize(void);
11 PETSC_INTERN PetscErrorCode PetscLogFinalize(void);
12 #endif
13 
14 #if defined(PETSC_SERIALIZE_FUNCTIONS)
15 PETSC_INTERN PetscFPT PetscFPTData;
16 PetscFPT PetscFPTData = 0;
17 #endif
18 
19 #if defined(PETSC_HAVE_SAWS)
20 #include <petscviewersaws.h>
21 #endif
22 /* -----------------------------------------------------------------------------------------*/
23 
24 PETSC_INTERN FILE *petsc_history;
25 
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**);
32 
33 /* user may set this BEFORE calling PetscInitialize() */
34 MPI_Comm PETSC_COMM_WORLD = MPI_COMM_NULL;
35 
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;
40 
41 /*
42      Declare and set all the string names of the PETSc enums
43 */
44 const char *const PetscBools[]     = {"FALSE","TRUE","PetscBool","PETSC_",0};
45 const char *const PetscCopyModes[] = {"COPY_VALUES","OWN_POINTER","USE_POINTER","PetscCopyMode","PETSC_",0};
46 
47 PetscBool PetscPreLoadingUsed = PETSC_FALSE;
48 PetscBool PetscPreLoadingOn   = PETSC_FALSE;
49 
50 PetscInt PetscHotRegionDepth;
51 
52 #if defined(PETSC_HAVE_THREADSAFETY)
53 PetscSpinlock PetscViewerASCIISpinLockOpen;
54 PetscSpinlock PetscViewerASCIISpinLockStdout;
55 PetscSpinlock PetscViewerASCIISpinLockStderr;
56 PetscSpinlock PetscCommSpinLock;
57 #endif
58 
59 /*
60        Checks the options database for initializations related to the
61     PETSc components
62 */
63 PETSC_INTERN PetscErrorCode  PetscOptionsCheckInitial_Components(void)
64 {
65   PetscBool      flg;
66   PetscErrorCode ierr;
67 
68   PetscFunctionBegin;
69   ierr = PetscOptionsHasHelp(NULL,&flg);CHKERRQ(ierr);
70   if (flg) {
71 #if defined(PETSC_USE_LOG)
72     MPI_Comm comm = PETSC_COMM_WORLD;
73     ierr = (*PetscHelpPrintf)(comm,"------Additional PETSc component options--------\n");CHKERRQ(ierr);
74     ierr = (*PetscHelpPrintf)(comm," -log_exclude: <vec,mat,pc,ksp,snes,tao,ts>\n");CHKERRQ(ierr);
75     ierr = (*PetscHelpPrintf)(comm," -info_exclude: <null,vec,mat,pc,ksp,snes,tao,ts>\n");CHKERRQ(ierr);
76     ierr = (*PetscHelpPrintf)(comm,"-----------------------------------------------\n");CHKERRQ(ierr);
77 #endif
78   }
79   PetscFunctionReturn(0);
80 }
81 
82 /*
83       PetscInitializeNoPointers - Calls PetscInitialize() from C/C++ without the pointers to argc and args
84 
85    Collective
86 
87    Level: advanced
88 
89     Notes:
90     this is called only by the PETSc Julia interface. Even though it might start MPI it sets the flag to
91      indicate that it did NOT start MPI so that the PetscFinalize() does not end MPI, thus allowing PetscInitialize() to
92      be called multiple times from Julia without the problem of trying to initialize MPI more than once.
93 
94      Developer Note: Turns off PETSc signal handling to allow Julia to manage signals
95 
96 .seealso: PetscInitialize(), PetscInitializeFortran(), PetscInitializeNoArguments()
97 */
98 PetscErrorCode  PetscInitializeNoPointers(int argc,char **args,const char *filename,const char *help)
99 {
100   PetscErrorCode ierr;
101   int            myargc   = argc;
102   char           **myargs = args;
103 
104   PetscFunctionBegin;
105   ierr = PetscInitialize(&myargc,&myargs,filename,help);CHKERRQ(ierr);
106   ierr = PetscPopSignalHandler();CHKERRQ(ierr);
107   PetscBeganMPI = PETSC_FALSE;
108   PetscFunctionReturn(ierr);
109 }
110 
111 /*
112       Used by Julia interface to get communicator
113 */
114 PetscErrorCode  PetscGetPETSC_COMM_SELF(MPI_Comm *comm)
115 {
116   PetscFunctionBegin;
117   *comm = PETSC_COMM_SELF;
118   PetscFunctionReturn(0);
119 }
120 
121 /*@C
122       PetscInitializeNoArguments - Calls PetscInitialize() from C/C++ without
123         the command line arguments.
124 
125    Collective
126 
127    Level: advanced
128 
129 .seealso: PetscInitialize(), PetscInitializeFortran()
130 @*/
131 PetscErrorCode  PetscInitializeNoArguments(void)
132 {
133   PetscErrorCode ierr;
134   int            argc   = 0;
135   char           **args = 0;
136 
137   PetscFunctionBegin;
138   ierr = PetscInitialize(&argc,&args,NULL,NULL);
139   PetscFunctionReturn(ierr);
140 }
141 
142 /*@
143       PetscInitialized - Determine whether PETSc is initialized.
144 
145    Level: beginner
146 
147 .seealso: PetscInitialize(), PetscInitializeNoArguments(), PetscInitializeFortran()
148 @*/
149 PetscErrorCode PetscInitialized(PetscBool  *isInitialized)
150 {
151   *isInitialized = PetscInitializeCalled;
152   return 0;
153 }
154 
155 /*@
156       PetscFinalized - Determine whether PetscFinalize() has been called yet
157 
158    Level: developer
159 
160 .seealso: PetscInitialize(), PetscInitializeNoArguments(), PetscInitializeFortran()
161 @*/
162 PetscErrorCode  PetscFinalized(PetscBool  *isFinalized)
163 {
164   *isFinalized = PetscFinalizeCalled;
165   return 0;
166 }
167 
168 PETSC_INTERN PetscErrorCode PetscOptionsCheckInitial_Private(void);
169 
170 /*
171        This function is the MPI reduction operation used to compute the sum of the
172    first half of the datatype and the max of the second half.
173 */
174 MPI_Op MPIU_MAXSUM_OP = 0;
175 
176 PETSC_INTERN void MPIAPI MPIU_MaxSum_Local(void *in,void *out,int *cnt,MPI_Datatype *datatype)
177 {
178   PetscInt *xin = (PetscInt*)in,*xout = (PetscInt*)out,i,count = *cnt;
179 
180   PetscFunctionBegin;
181   if (*datatype != MPIU_2INT) {
182     (*PetscErrorPrintf)("Can only handle MPIU_2INT data types");
183     MPI_Abort(MPI_COMM_WORLD,1);
184   }
185 
186   for (i=0; i<count; i++) {
187     xout[2*i]    = PetscMax(xout[2*i],xin[2*i]);
188     xout[2*i+1] += xin[2*i+1];
189   }
190   PetscFunctionReturnVoid();
191 }
192 
193 /*
194     Returns the max of the first entry owned by this processor and the
195 sum of the second entry.
196 
197     The reason sizes[2*i] contains lengths sizes[2*i+1] contains flag of 1 if length is nonzero
198 is so that the MPIU_MAXSUM_OP() can set TWO values, if we passed in only sizes[i] with lengths
199 there would be no place to store the both needed results.
200 */
201 PetscErrorCode  PetscMaxSum(MPI_Comm comm,const PetscInt sizes[],PetscInt *max,PetscInt *sum)
202 {
203   PetscErrorCode ierr;
204 
205   PetscFunctionBegin;
206 #if defined(PETSC_HAVE_MPI_REDUCE_SCATTER_BLOCK)
207   {
208     struct {PetscInt max,sum;} work;
209     ierr = MPI_Reduce_scatter_block((void*)sizes,&work,1,MPIU_2INT,MPIU_MAXSUM_OP,comm);CHKERRQ(ierr);
210     *max = work.max;
211     *sum = work.sum;
212   }
213 #else
214   {
215     PetscMPIInt    size,rank;
216     struct {PetscInt max,sum;} *work;
217     ierr = MPI_Comm_size(comm,&size);CHKERRQ(ierr);
218     ierr = MPI_Comm_rank(comm,&rank);CHKERRQ(ierr);
219     ierr = PetscMalloc1(size,&work);CHKERRQ(ierr);
220     ierr = MPIU_Allreduce((void*)sizes,work,size,MPIU_2INT,MPIU_MAXSUM_OP,comm);CHKERRQ(ierr);
221     *max = work[rank].max;
222     *sum = work[rank].sum;
223     ierr = PetscFree(work);CHKERRQ(ierr);
224   }
225 #endif
226   PetscFunctionReturn(0);
227 }
228 
229 /* ----------------------------------------------------------------------------*/
230 
231 #if (defined(PETSC_HAVE_COMPLEX) && !defined(PETSC_HAVE_MPI_C_DOUBLE_COMPLEX)) || defined(PETSC_USE_REAL___FLOAT128) || defined(PETSC_USE_REAL___FP16)
232 MPI_Op MPIU_SUM = 0;
233 
234 PETSC_EXTERN void PetscSum_Local(void *in,void *out,PetscMPIInt *cnt,MPI_Datatype *datatype)
235 {
236   PetscInt i,count = *cnt;
237 
238   PetscFunctionBegin;
239   if (*datatype == MPIU_REAL) {
240     PetscReal *xin = (PetscReal*)in,*xout = (PetscReal*)out;
241     for (i=0; i<count; i++) xout[i] += xin[i];
242   }
243 #if defined(PETSC_HAVE_COMPLEX)
244   else if (*datatype == MPIU_COMPLEX) {
245     PetscComplex *xin = (PetscComplex*)in,*xout = (PetscComplex*)out;
246     for (i=0; i<count; i++) xout[i] += xin[i];
247   }
248 #endif
249   else {
250     (*PetscErrorPrintf)("Can only handle MPIU_REAL or MPIU_COMPLEX data types");
251     MPI_Abort(MPI_COMM_WORLD,1);
252   }
253   PetscFunctionReturnVoid();
254 }
255 #endif
256 
257 #if defined(PETSC_USE_REAL___FLOAT128) || defined(PETSC_USE_REAL___FP16)
258 MPI_Op MPIU_MAX = 0;
259 MPI_Op MPIU_MIN = 0;
260 
261 PETSC_EXTERN void PetscMax_Local(void *in,void *out,PetscMPIInt *cnt,MPI_Datatype *datatype)
262 {
263   PetscInt i,count = *cnt;
264 
265   PetscFunctionBegin;
266   if (*datatype == MPIU_REAL) {
267     PetscReal *xin = (PetscReal*)in,*xout = (PetscReal*)out;
268     for (i=0; i<count; i++) xout[i] = PetscMax(xout[i],xin[i]);
269   }
270 #if defined(PETSC_HAVE_COMPLEX)
271   else if (*datatype == MPIU_COMPLEX) {
272     PetscComplex *xin = (PetscComplex*)in,*xout = (PetscComplex*)out;
273     for (i=0; i<count; i++) {
274       xout[i] = PetscRealPartComplex(xout[i])<PetscRealPartComplex(xin[i]) ? xin[i] : xout[i];
275     }
276   }
277 #endif
278   else {
279     (*PetscErrorPrintf)("Can only handle MPIU_REAL or MPIU_COMPLEX data types");
280     MPI_Abort(MPI_COMM_WORLD,1);
281   }
282   PetscFunctionReturnVoid();
283 }
284 
285 PETSC_EXTERN void PetscMin_Local(void *in,void *out,PetscMPIInt *cnt,MPI_Datatype *datatype)
286 {
287   PetscInt    i,count = *cnt;
288 
289   PetscFunctionBegin;
290   if (*datatype == MPIU_REAL) {
291     PetscReal *xin = (PetscReal*)in,*xout = (PetscReal*)out;
292     for (i=0; i<count; i++) xout[i] = PetscMin(xout[i],xin[i]);
293   }
294 #if defined(PETSC_HAVE_COMPLEX)
295   else if (*datatype == MPIU_COMPLEX) {
296     PetscComplex *xin = (PetscComplex*)in,*xout = (PetscComplex*)out;
297     for (i=0; i<count; i++) {
298       xout[i] = PetscRealPartComplex(xout[i])>PetscRealPartComplex(xin[i]) ? xin[i] : xout[i];
299     }
300   }
301 #endif
302   else {
303     (*PetscErrorPrintf)("Can only handle MPIU_REAL or MPIU_SCALAR data (i.e. double or complex) types");
304     MPI_Abort(MPI_COMM_WORLD,1);
305   }
306   PetscFunctionReturnVoid();
307 }
308 #endif
309 
310 /*
311    Private routine to delete internal tag/name counter storage when a communicator is freed.
312 
313    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.
314 
315    Note: this is declared extern "C" because it is passed to MPI_Comm_create_keyval()
316 
317 */
318 PETSC_EXTERN PetscMPIInt MPIAPI Petsc_DelCounter(MPI_Comm comm,PetscMPIInt keyval,void *count_val,void *extra_state)
319 {
320   PetscErrorCode ierr;
321 
322   PetscFunctionBegin;
323   ierr = PetscInfo1(0,"Deleting counter data in an MPI_Comm %ld\n",(long)comm);CHKERRMPI(ierr);
324   ierr = PetscFree(count_val);CHKERRMPI(ierr);
325   PetscFunctionReturn(MPI_SUCCESS);
326 }
327 
328 /*
329   This is invoked on the outer comm as a result of either PetscCommDestroy() (via MPI_Comm_delete_attr) or when the user
330   calls MPI_Comm_free().
331 
332   This is the only entry point for breaking the links between inner and outer comms.
333 
334   This is called by MPI, not by users. This is called when MPI_Comm_free() is called on the communicator.
335 
336   Note: this is declared extern "C" because it is passed to MPI_Comm_create_keyval()
337 
338 */
339 PETSC_EXTERN PetscMPIInt MPIAPI Petsc_DelComm_Outer(MPI_Comm comm,PetscMPIInt keyval,void *attr_val,void *extra_state)
340 {
341   PetscErrorCode                    ierr;
342   PetscMPIInt                       flg;
343   union {MPI_Comm comm; void *ptr;} icomm,ocomm;
344 
345   PetscFunctionBegin;
346   if (keyval != Petsc_InnerComm_keyval) SETERRMPI(PETSC_COMM_SELF,PETSC_ERR_ARG_CORRUPT,"Unexpected keyval");
347   icomm.ptr = attr_val;
348 
349   ierr = MPI_Comm_get_attr(icomm.comm,Petsc_OuterComm_keyval,&ocomm,&flg);CHKERRMPI(ierr);
350   if (!flg) SETERRMPI(PETSC_COMM_SELF,PETSC_ERR_ARG_CORRUPT,"Inner MPI_Comm does not have expected reference to outer comm");
351   if (ocomm.comm != comm) SETERRMPI(PETSC_COMM_SELF,PETSC_ERR_ARG_CORRUPT,"Inner MPI_Comm has reference to non-matching outer comm");
352   ierr = MPI_Comm_delete_attr(icomm.comm,Petsc_OuterComm_keyval);CHKERRMPI(ierr);
353   ierr = PetscInfo1(0,"User MPI_Comm %ld is being freed after removing reference from inner PETSc comm to this outer comm\n",(long)comm);CHKERRMPI(ierr);
354   PetscFunctionReturn(MPI_SUCCESS);
355 }
356 
357 /*
358  * This is invoked on the inner comm when Petsc_DelComm_Outer calls MPI_Comm_delete_attr.  It should not be reached any other way.
359  */
360 PETSC_EXTERN PetscMPIInt MPIAPI Petsc_DelComm_Inner(MPI_Comm comm,PetscMPIInt keyval,void *attr_val,void *extra_state)
361 {
362   PetscErrorCode ierr;
363 
364   PetscFunctionBegin;
365   ierr = PetscInfo1(0,"Removing reference to PETSc communicator embedded in a user MPI_Comm %ld\n",(long)comm);CHKERRMPI(ierr);
366   PetscFunctionReturn(MPI_SUCCESS);
367 }
368 
369 PETSC_EXTERN PetscMPIInt MPIAPI Petsc_DelComm_Shm(MPI_Comm,PetscMPIInt,void *,void *);
370 
371 #if defined(PETSC_USE_PETSC_MPI_EXTERNAL32)
372 PETSC_EXTERN PetscMPIInt PetscDataRep_extent_fn(MPI_Datatype,MPI_Aint*,void*);
373 PETSC_EXTERN PetscMPIInt PetscDataRep_read_conv_fn(void*, MPI_Datatype,PetscMPIInt,void*,MPI_Offset,void*);
374 PETSC_EXTERN PetscMPIInt PetscDataRep_write_conv_fn(void*, MPI_Datatype,PetscMPIInt,void*,MPI_Offset,void*);
375 #endif
376 
377 PetscMPIInt PETSC_MPI_ERROR_CLASS,PETSC_MPI_ERROR_CODE;
378 
379 PETSC_INTERN int  PetscGlobalArgc;
380 PETSC_INTERN char **PetscGlobalArgs;
381 int  PetscGlobalArgc   = 0;
382 char **PetscGlobalArgs = 0;
383 PetscSegBuffer PetscCitationsList;
384 
385 PetscErrorCode PetscCitationsInitialize(void)
386 {
387   PetscErrorCode ierr;
388 
389   PetscFunctionBegin;
390   ierr = PetscSegBufferCreate(1,10000,&PetscCitationsList);CHKERRQ(ierr);
391   ierr = 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);CHKERRQ(ierr);
392   ierr = 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);CHKERRQ(ierr);
393   PetscFunctionReturn(0);
394 }
395 
396 static char programname[PETSC_MAX_PATH_LEN] = ""; /* HP includes entire path in name */
397 
398 PetscErrorCode  PetscSetProgramName(const char name[])
399 {
400   PetscErrorCode ierr;
401 
402   PetscFunctionBegin;
403   ierr  = PetscStrncpy(programname,name,PETSC_MAX_PATH_LEN);CHKERRQ(ierr);
404   PetscFunctionReturn(0);
405 }
406 
407 /*@C
408     PetscGetProgramName - Gets the name of the running program.
409 
410     Not Collective
411 
412     Input Parameter:
413 .   len - length of the string name
414 
415     Output Parameter:
416 .   name - the name of the running program
417 
418    Level: advanced
419 
420     Notes:
421     The name of the program is copied into the user-provided character
422     array of length len.  On some machines the program name includes
423     its entire path, so one should generally set len >= PETSC_MAX_PATH_LEN.
424 @*/
425 PetscErrorCode  PetscGetProgramName(char name[],size_t len)
426 {
427   PetscErrorCode ierr;
428 
429   PetscFunctionBegin;
430    ierr = PetscStrncpy(name,programname,len);CHKERRQ(ierr);
431   PetscFunctionReturn(0);
432 }
433 
434 /*@C
435    PetscGetArgs - Allows you to access the raw command line arguments anywhere
436      after PetscInitialize() is called but before PetscFinalize().
437 
438    Not Collective
439 
440    Output Parameters:
441 +  argc - count of number of command line arguments
442 -  args - the command line arguments
443 
444    Level: intermediate
445 
446    Notes:
447       This is usually used to pass the command line arguments into other libraries
448    that are called internally deep in PETSc or the application.
449 
450       The first argument contains the program name as is normal for C arguments.
451 
452 .seealso: PetscFinalize(), PetscInitializeFortran(), PetscGetArguments()
453 
454 @*/
455 PetscErrorCode  PetscGetArgs(int *argc,char ***args)
456 {
457   PetscFunctionBegin;
458   if (!PetscInitializeCalled && PetscFinalizeCalled) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ORDER,"You must call after PetscInitialize() but before PetscFinalize()");
459   *argc = PetscGlobalArgc;
460   *args = PetscGlobalArgs;
461   PetscFunctionReturn(0);
462 }
463 
464 /*@C
465    PetscGetArguments - Allows you to access the  command line arguments anywhere
466      after PetscInitialize() is called but before PetscFinalize().
467 
468    Not Collective
469 
470    Output Parameters:
471 .  args - the command line arguments
472 
473    Level: intermediate
474 
475    Notes:
476       This does NOT start with the program name and IS null terminated (final arg is void)
477 
478 .seealso: PetscFinalize(), PetscInitializeFortran(), PetscGetArgs(), PetscFreeArguments()
479 
480 @*/
481 PetscErrorCode  PetscGetArguments(char ***args)
482 {
483   PetscInt       i,argc = PetscGlobalArgc;
484   PetscErrorCode ierr;
485 
486   PetscFunctionBegin;
487   if (!PetscInitializeCalled && PetscFinalizeCalled) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ORDER,"You must call after PetscInitialize() but before PetscFinalize()");
488   if (!argc) {*args = NULL; PetscFunctionReturn(0);}
489   ierr = PetscMalloc1(argc,args);CHKERRQ(ierr);
490   for (i=0; i<argc-1; i++) {
491     ierr = PetscStrallocpy(PetscGlobalArgs[i+1],&(*args)[i]);CHKERRQ(ierr);
492   }
493   (*args)[argc-1] = NULL;
494   PetscFunctionReturn(0);
495 }
496 
497 /*@C
498    PetscFreeArguments - Frees the memory obtained with PetscGetArguments()
499 
500    Not Collective
501 
502    Output Parameters:
503 .  args - the command line arguments
504 
505    Level: intermediate
506 
507 .seealso: PetscFinalize(), PetscInitializeFortran(), PetscGetArgs(), PetscGetArguments()
508 
509 @*/
510 PetscErrorCode  PetscFreeArguments(char **args)
511 {
512   PetscInt       i = 0;
513   PetscErrorCode ierr;
514 
515   PetscFunctionBegin;
516   if (!args) PetscFunctionReturn(0);
517   while (args[i]) {
518     ierr = PetscFree(args[i]);CHKERRQ(ierr);
519     i++;
520   }
521   ierr = PetscFree(args);CHKERRQ(ierr);
522   PetscFunctionReturn(0);
523 }
524 
525 #if defined(PETSC_HAVE_SAWS)
526 #include <petscconfiginfo.h>
527 
528 PETSC_INTERN PetscErrorCode PetscInitializeSAWs(const char help[])
529 {
530   if (!PetscGlobalRank) {
531     char           cert[PETSC_MAX_PATH_LEN],root[PETSC_MAX_PATH_LEN],*intro,programname[64],*appline,*options,version[64];
532     int            port;
533     PetscBool      flg,rootlocal = PETSC_FALSE,flg2,selectport = PETSC_FALSE;
534     size_t         applinelen,introlen;
535     PetscErrorCode ierr;
536     char           sawsurl[256];
537 
538     ierr = PetscOptionsHasName(NULL,NULL,"-saws_log",&flg);CHKERRQ(ierr);
539     if (flg) {
540       char  sawslog[PETSC_MAX_PATH_LEN];
541 
542       ierr = PetscOptionsGetString(NULL,NULL,"-saws_log",sawslog,PETSC_MAX_PATH_LEN,NULL);CHKERRQ(ierr);
543       if (sawslog[0]) {
544         PetscStackCallSAWs(SAWs_Set_Use_Logfile,(sawslog));
545       } else {
546         PetscStackCallSAWs(SAWs_Set_Use_Logfile,(NULL));
547       }
548     }
549     ierr = PetscOptionsGetString(NULL,NULL,"-saws_https",cert,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr);
550     if (flg) {
551       PetscStackCallSAWs(SAWs_Set_Use_HTTPS,(cert));
552     }
553     ierr = PetscOptionsGetBool(NULL,NULL,"-saws_port_auto_select",&selectport,NULL);CHKERRQ(ierr);
554     if (selectport) {
555         PetscStackCallSAWs(SAWs_Get_Available_Port,(&port));
556         PetscStackCallSAWs(SAWs_Set_Port,(port));
557     } else {
558       ierr = PetscOptionsGetInt(NULL,NULL,"-saws_port",&port,&flg);CHKERRQ(ierr);
559       if (flg) {
560         PetscStackCallSAWs(SAWs_Set_Port,(port));
561       }
562     }
563     ierr = PetscOptionsGetString(NULL,NULL,"-saws_root",root,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr);
564     if (flg) {
565       PetscStackCallSAWs(SAWs_Set_Document_Root,(root));CHKERRQ(ierr);
566       ierr = PetscStrcmp(root,".",&rootlocal);CHKERRQ(ierr);
567     } else {
568       ierr = PetscOptionsHasName(NULL,NULL,"-saws_options",&flg);CHKERRQ(ierr);
569       if (flg) {
570         ierr = PetscStrreplace(PETSC_COMM_WORLD,"${PETSC_DIR}/share/petsc/saws",root,PETSC_MAX_PATH_LEN);CHKERRQ(ierr);
571         PetscStackCallSAWs(SAWs_Set_Document_Root,(root));CHKERRQ(ierr);
572       }
573     }
574     ierr = PetscOptionsHasName(NULL,NULL,"-saws_local",&flg2);CHKERRQ(ierr);
575     if (flg2) {
576       char jsdir[PETSC_MAX_PATH_LEN];
577       if (!flg) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SUP,"-saws_local option requires -saws_root option");
578       ierr = PetscSNPrintf(jsdir,PETSC_MAX_PATH_LEN,"%s/js",root);CHKERRQ(ierr);
579       ierr = PetscTestDirectory(jsdir,'r',&flg);CHKERRQ(ierr);
580       if (!flg) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_FILE_READ,"-saws_local option requires js directory in root directory");
581       PetscStackCallSAWs(SAWs_Push_Local_Header,());CHKERRQ(ierr);
582     }
583     ierr = PetscGetProgramName(programname,64);CHKERRQ(ierr);
584     ierr = PetscStrlen(help,&applinelen);CHKERRQ(ierr);
585     introlen   = 4096 + applinelen;
586     applinelen += 1024;
587     ierr = PetscMalloc(applinelen,&appline);CHKERRQ(ierr);
588     ierr = PetscMalloc(introlen,&intro);CHKERRQ(ierr);
589 
590     if (rootlocal) {
591       ierr = PetscSNPrintf(appline,applinelen,"%s.c.html",programname);CHKERRQ(ierr);
592       ierr = PetscTestFile(appline,'r',&rootlocal);CHKERRQ(ierr);
593     }
594     ierr = PetscOptionsGetAll(NULL,&options);CHKERRQ(ierr);
595     if (rootlocal && help) {
596       ierr = 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);CHKERRQ(ierr);
597     } else if (help) {
598       ierr = PetscSNPrintf(appline,applinelen,"<center>Running %s %s</center><br><center><pre>%s</pre></center><br>",programname,options,help);CHKERRQ(ierr);
599     } else {
600       ierr = PetscSNPrintf(appline,applinelen,"<center> Running %s %s</center><br>\n",programname,options);CHKERRQ(ierr);
601     }
602     ierr = PetscFree(options);CHKERRQ(ierr);
603     ierr = PetscGetVersion(version,sizeof(version));CHKERRQ(ierr);
604     ierr = PetscSNPrintf(intro,introlen,"<body>\n"
605                                     "<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"
606                                     "<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"
607                                     "%s",version,petscconfigureoptions,appline);CHKERRQ(ierr);
608     PetscStackCallSAWs(SAWs_Push_Body,("index.html",0,intro));
609     ierr = PetscFree(intro);CHKERRQ(ierr);
610     ierr = PetscFree(appline);CHKERRQ(ierr);
611     if (selectport) {
612       PetscBool silent;
613 
614       ierr = SAWs_Initialize();
615       /* another process may have grabbed the port so keep trying */
616       while (ierr) {
617         PetscStackCallSAWs(SAWs_Get_Available_Port,(&port));
618         PetscStackCallSAWs(SAWs_Set_Port,(port));
619         ierr = SAWs_Initialize();
620       }
621 
622       ierr = PetscOptionsGetBool(NULL,NULL,"-saws_port_auto_select_silent",&silent,NULL);CHKERRQ(ierr);
623       if (!silent) {
624         PetscStackCallSAWs(SAWs_Get_FullURL,(sizeof(sawsurl),sawsurl));
625         ierr = PetscPrintf(PETSC_COMM_WORLD,"Point your browser to %s for SAWs\n",sawsurl);CHKERRQ(ierr);
626       }
627     } else {
628       PetscStackCallSAWs(SAWs_Initialize,());
629     }
630     ierr = PetscCitationsRegister("@TechReport{ saws,\n"
631                                   "  Author = {Matt Otten and Jed Brown and Barry Smith},\n"
632                                   "  Title  = {Scientific Application Web Server (SAWs) Users Manual},\n"
633                                   "  Institution = {Argonne National Laboratory},\n"
634                                   "  Year   = 2013\n}\n",NULL);CHKERRQ(ierr);
635   }
636   PetscFunctionReturn(0);
637 }
638 #endif
639 
640 #if defined(PETSC_HAVE_ADIOS)
641 #include <adios.h>
642 #include <adios_read.h>
643 int64_t Petsc_adios_group;
644 #endif
645 #if defined(PETSC_HAVE_ADIOS2)
646 #include <adios2_c.h>
647 #endif
648 #if defined(PETSC_HAVE_OPENMP)
649 #include <omp.h>
650 PetscInt PetscNumOMPThreads;
651 #endif
652 
653 /*@C
654    PetscInitialize - Initializes the PETSc database and MPI.
655    PetscInitialize() calls MPI_Init() if that has yet to be called,
656    so this routine should always be called near the beginning of
657    your program -- usually the very first line!
658 
659    Collective on MPI_COMM_WORLD or PETSC_COMM_WORLD if it has been set
660 
661    Input Parameters:
662 +  argc - count of number of command line arguments
663 .  args - the command line arguments
664 .  file - [optional] PETSc database file, also checks ~username/.petscrc and .petscrc use NULL to not check for
665           code specific file. Use -skip_petscrc in the code specific file to skip the .petscrc files
666 -  help - [optional] Help message to print, use NULL for no message
667 
668    If you wish PETSc code to run ONLY on a subcommunicator of MPI_COMM_WORLD, create that
669    communicator first and assign it to PETSC_COMM_WORLD BEFORE calling PetscInitialize(). Thus if you are running a
670    four process job and two processes will run PETSc and have PetscInitialize() and PetscFinalize() and two process will not,
671    then do this. If ALL processes in the job are using PetscInitialize() and PetscFinalize() then you don't need to do this, even
672    if different subcommunicators of the job are doing different things with PETSc.
673 
674    Options Database Keys:
675 +  -help [intro] - prints help method for each option; if intro is given the program stops after printing the introductory help message
676 .  -start_in_debugger [noxterm,dbx,xdb,gdb,...] - Starts program in debugger
677 .  -on_error_attach_debugger [noxterm,dbx,xdb,gdb,...] - Starts debugger when error detected
678 .  -on_error_emacs <machinename> - causes emacsclient to jump to error file
679 .  -on_error_abort - calls abort() when error detected (no traceback)
680 .  -on_error_mpiabort - calls MPI_abort() when error detected
681 .  -error_output_stderr - prints error messages to stderr instead of the default stdout
682 .  -error_output_none - does not print the error messages (but handles errors in the same way as if this was not called)
683 .  -debugger_nodes [node1,node2,...] - Indicates nodes to start in debugger
684 .  -debugger_pause [sleeptime] (in seconds) - Pauses debugger
685 .  -stop_for_debugger - Print message on how to attach debugger manually to
686                         process and wait (-debugger_pause) seconds for attachment
687 .  -malloc - Indicates use of PETSc error-checking malloc (on by default for debug version of libraries)
688 .  -malloc no - Indicates not to use error-checking malloc
689 .  -malloc_debug - check for memory corruption at EVERY malloc or free
690 .  -malloc_dump - prints a list of all unfreed memory at the end of the run
691 .  -malloc_test - like -malloc_dump -malloc_debug, but only active for debugging builds
692 .  -fp_trap - Stops on floating point exceptions (Note that on the
693               IBM RS6000 this slows code by at least a factor of 10.)
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
700 
701    Options Database Keys for Profiling:
702    See Users-Manual: ch_profiling for details.
703 +  -info <optional filename> - Prints verbose information to the screen
704 .  -info_exclude <null,vec,mat,pc,ksp,snes,ts> - Excludes some of the verbose messages
705 .  -log_sync - Enable barrier synchronization for all events. This option is useful to debug imbalance within each event,
706         however it slows things down and gives a distorted view of the overall runtime.
707 .  -log_trace [filename] - Print traces of all PETSc calls to the screen (useful to determine where a program
708         hangs without running in the debugger).  See PetscLogTraceBegin().
709 .  -log_view [:filename:format] - Prints summary of flop and timing information to screen or file, 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
718 
719     Only one of -log_trace, -log_view, -log_view, -log_all, -log, or -log_mpe may be used at a time
720 
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
728 
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
735 
736 
737    Level: beginner
738 
739    Notes:
740    If for some reason you must call MPI_Init() separately, call
741    it before PetscInitialize().
742 
743    Fortran Version:
744    In Fortran this routine has the format
745 $       call PetscInitialize(file,ierr)
746 
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
750 
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: ch_fortran for details.
755 
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().
758 
759 .seealso: PetscFinalize(), PetscInitializeFortran(), PetscGetArgs(), PetscInitializeNoArguments()
760 
761 @*/
762 PetscErrorCode  PetscInitialize(int *argc,char ***args,const char file[],const char help[])
763 {
764   PetscErrorCode ierr;
765   PetscMPIInt    flag, size;
766   PetscBool      flg = PETSC_TRUE;
767   char           hostname[256];
768 
769   PetscFunctionBegin;
770   if (PetscInitializeCalled) PetscFunctionReturn(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.
780 
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.
785 
786       Currently we only check for pre MPI ABI versions (and packages that do not follow the MPI ABI).
787 
788       Questions:
789 
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   */
793 
794 #if defined(PETSC_HAVE_MPI_GET_LIBRARY_VERSION)
795   {
796     char        mpilibraryversion[MPI_MAX_LIBRARY_VERSION_STRING];
797     PetscMPIInt mpilibraryversionlength;
798     ierr = 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       ierr = PetscStrstr(mpilibraryversion,"MPICH Version:",&ver);if (ierr) return ierr;
806       if (ver) {
807         ierr = PetscStrchr(ver,'\n',&lf);if (ierr) return ierr;
808         if (lf) {
809           *lf = 0;
810           ierr = 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       ierr = 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         ierr = 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
838 
839 
840   /* these must be initialized in a routine, not as a constant declaration*/
841   PETSC_STDOUT = stdout;
842   PETSC_STDERR = stderr;
843 
844   /* on Windows - set printf to default to printing 2 digit exponents */
845 #if defined(PETSC_HAVE__SET_OUTPUT_FORMAT)
846   _set_output_format(_TWO_DIGIT_EXPONENT);
847 #endif
848 
849   ierr = PetscOptionsCreateDefault();CHKERRQ(ierr);
850 
851   /*
852      We initialize the program name here (before MPI_Init()) because MPICH has a bug in
853      it that it sets args[0] on all processors to be args[0] on the first processor.
854   */
855   if (argc && *argc) {
856     ierr = PetscSetProgramName(**args);CHKERRQ(ierr);
857   } else {
858     ierr = PetscSetProgramName("Unknown Name");CHKERRQ(ierr);
859   }
860 
861   ierr = MPI_Initialized(&flag);CHKERRQ(ierr);
862   if (!flag) {
863     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");
864 #if defined(PETSC_HAVE_MPI_INIT_THREAD)
865     {
866       PetscMPIInt provided;
867       ierr = MPI_Init_thread(argc,args,MPI_THREAD_FUNNELED,&provided);CHKERRQ(ierr);
868     }
869 #else
870     ierr = MPI_Init(argc,args);CHKERRQ(ierr);
871 #endif
872     PetscBeganMPI = PETSC_TRUE;
873   }
874   if (argc && args) {
875     PetscGlobalArgc = *argc;
876     PetscGlobalArgs = *args;
877   }
878   PetscFinalizeCalled = PETSC_FALSE;
879   ierr = PetscSpinlockCreate(&PetscViewerASCIISpinLockOpen);CHKERRQ(ierr);
880   ierr = PetscSpinlockCreate(&PetscViewerASCIISpinLockStdout);CHKERRQ(ierr);
881   ierr = PetscSpinlockCreate(&PetscViewerASCIISpinLockStderr);CHKERRQ(ierr);
882   ierr = PetscSpinlockCreate(&PetscCommSpinLock);CHKERRQ(ierr);
883 
884   if (PETSC_COMM_WORLD == MPI_COMM_NULL) PETSC_COMM_WORLD = MPI_COMM_WORLD;
885   ierr = MPI_Comm_set_errhandler(PETSC_COMM_WORLD,MPI_ERRORS_RETURN);CHKERRQ(ierr);
886 
887   ierr = MPI_Add_error_class(&PETSC_MPI_ERROR_CLASS);CHKERRQ(ierr);
888   ierr = MPI_Add_error_code(PETSC_MPI_ERROR_CLASS,&PETSC_MPI_ERROR_CODE);CHKERRQ(ierr);
889 
890   /* Done after init due to a bug in MPICH-GM? */
891   ierr = PetscErrorPrintfInitialize();CHKERRQ(ierr);
892 
893   ierr = MPI_Comm_rank(MPI_COMM_WORLD,&PetscGlobalRank);CHKERRQ(ierr);
894   ierr = MPI_Comm_size(MPI_COMM_WORLD,&PetscGlobalSize);CHKERRQ(ierr);
895 
896   MPIU_BOOL = MPI_INT;
897   MPIU_ENUM = MPI_INT;
898   MPIU_FORTRANADDR = (sizeof(void*) == sizeof(int)) ? MPI_INT : MPIU_INT64;
899   if (sizeof(size_t) == sizeof(unsigned)) MPIU_SIZE_T = MPI_UNSIGNED;
900   else if (sizeof(size_t) == sizeof(unsigned long)) MPIU_SIZE_T = MPI_UNSIGNED_LONG;
901 #if defined(PETSC_SIZEOF_LONG_LONG)
902   else if (sizeof(size_t) == sizeof(unsigned long long)) MPIU_SIZE_T = MPI_UNSIGNED_LONG_LONG;
903 #endif
904   else {(*PetscErrorPrintf)("PetscInitialize: Could not find MPI type for size_t\n"); return PETSC_ERR_SUP_SYS;}
905 
906   /*
907      Initialized the global complex variable; this is because with
908      shared libraries the constructors for global variables
909      are not called; at least on IRIX.
910   */
911 #if defined(PETSC_HAVE_COMPLEX)
912   {
913 #if defined(PETSC_CLANGUAGE_CXX) && !defined(PETSC_USE_REAL___FLOAT128)
914     PetscComplex ic(0.0,1.0);
915     PETSC_i = ic;
916 #else
917     PETSC_i = _Complex_I;
918 #endif
919   }
920 
921 #if !defined(PETSC_HAVE_MPI_C_DOUBLE_COMPLEX)
922   ierr = MPI_Type_contiguous(2,MPI_DOUBLE,&MPIU_C_DOUBLE_COMPLEX);CHKERRQ(ierr);
923   ierr = MPI_Type_commit(&MPIU_C_DOUBLE_COMPLEX);CHKERRQ(ierr);
924   ierr = MPI_Type_contiguous(2,MPI_FLOAT,&MPIU_C_COMPLEX);CHKERRQ(ierr);
925   ierr = MPI_Type_commit(&MPIU_C_COMPLEX);CHKERRQ(ierr);
926 #endif
927 #endif /* PETSC_HAVE_COMPLEX */
928 
929   /*
930      Create the PETSc MPI reduction operator that sums of the first
931      half of the entries and maxes the second half.
932   */
933   ierr = MPI_Op_create(MPIU_MaxSum_Local,1,&MPIU_MAXSUM_OP);CHKERRQ(ierr);
934 
935 #if defined(PETSC_USE_REAL___FLOAT128)
936   ierr = MPI_Type_contiguous(2,MPI_DOUBLE,&MPIU___FLOAT128);CHKERRQ(ierr);
937   ierr = MPI_Type_commit(&MPIU___FLOAT128);CHKERRQ(ierr);
938 #if defined(PETSC_HAVE_COMPLEX)
939   ierr = MPI_Type_contiguous(4,MPI_DOUBLE,&MPIU___COMPLEX128);CHKERRQ(ierr);
940   ierr = MPI_Type_commit(&MPIU___COMPLEX128);CHKERRQ(ierr);
941 #endif
942   ierr = MPI_Op_create(PetscMax_Local,1,&MPIU_MAX);CHKERRQ(ierr);
943   ierr = MPI_Op_create(PetscMin_Local,1,&MPIU_MIN);CHKERRQ(ierr);
944 #elif defined(PETSC_USE_REAL___FP16)
945   ierr = MPI_Type_contiguous(2,MPI_CHAR,&MPIU___FP16);CHKERRQ(ierr);
946   ierr = MPI_Type_commit(&MPIU___FP16);CHKERRQ(ierr);
947   ierr = MPI_Op_create(PetscMax_Local,1,&MPIU_MAX);CHKERRQ(ierr);
948   ierr = MPI_Op_create(PetscMin_Local,1,&MPIU_MIN);CHKERRQ(ierr);
949 #endif
950 
951 #if (defined(PETSC_HAVE_COMPLEX) && !defined(PETSC_HAVE_MPI_C_DOUBLE_COMPLEX)) || defined(PETSC_USE_REAL___FLOAT128) || defined(PETSC_USE_REAL___FP16)
952   ierr = MPI_Op_create(PetscSum_Local,1,&MPIU_SUM);CHKERRQ(ierr);
953 #endif
954 
955   ierr = MPI_Type_contiguous(2,MPIU_SCALAR,&MPIU_2SCALAR);CHKERRQ(ierr);
956   ierr = MPI_Type_commit(&MPIU_2SCALAR);CHKERRQ(ierr);
957 
958 #if defined(PETSC_USE_64BIT_INDICES)
959   ierr = MPI_Type_contiguous(2,MPIU_INT,&MPIU_2INT);CHKERRQ(ierr);
960   ierr = MPI_Type_commit(&MPIU_2INT);CHKERRQ(ierr);
961 #endif
962 
963 
964   /*
965      Attributes to be set on PETSc communicators
966   */
967   ierr = MPI_Comm_create_keyval(MPI_COMM_NULL_COPY_FN,Petsc_DelCounter,&Petsc_Counter_keyval,(void*)0);CHKERRQ(ierr);
968   ierr = MPI_Comm_create_keyval(MPI_COMM_NULL_COPY_FN,Petsc_DelComm_Outer,&Petsc_InnerComm_keyval,(void*)0);CHKERRQ(ierr);
969   ierr = MPI_Comm_create_keyval(MPI_COMM_NULL_COPY_FN,Petsc_DelComm_Inner,&Petsc_OuterComm_keyval,(void*)0);CHKERRQ(ierr);
970   ierr = MPI_Comm_create_keyval(MPI_COMM_NULL_COPY_FN,Petsc_DelComm_Shm,&Petsc_ShmComm_keyval,(void*)0);CHKERRQ(ierr);
971 
972   /*
973      Build the options database
974   */
975   ierr = PetscOptionsInsert(NULL,argc,args,file);CHKERRQ(ierr);
976 
977   /* call a second time so it can look in the options database */
978   ierr = PetscErrorPrintfInitialize();CHKERRQ(ierr);
979 
980   /*
981      Print main application help message
982   */
983   ierr = PetscOptionsHasHelp(NULL,&flg);CHKERRQ(ierr);
984   if (help && flg) {
985     ierr = PetscPrintf(PETSC_COMM_WORLD,help);CHKERRQ(ierr);
986   }
987   ierr = PetscOptionsCheckInitial_Private();CHKERRQ(ierr);
988 
989   ierr = PetscCitationsInitialize();CHKERRQ(ierr);
990 
991 #if defined(PETSC_HAVE_SAWS)
992   ierr = PetscInitializeSAWs(help);CHKERRQ(ierr);
993 #endif
994 
995   /* Creates the logging data structures; this is enabled even if logging is not turned on */
996 #if defined(PETSC_USE_LOG)
997   ierr = PetscLogInitialize();CHKERRQ(ierr);
998 #endif
999 
1000   /*
1001      Load the dynamic libraries (on machines that support them), this registers all
1002      the solvers etc. (On non-dynamic machines this initializes the PetscDraw and PetscViewer classes)
1003   */
1004   ierr = PetscInitialize_DynamicLibraries();CHKERRQ(ierr);
1005 
1006   ierr = MPI_Comm_size(PETSC_COMM_WORLD,&size);CHKERRQ(ierr);
1007   ierr = PetscInfo1(0,"PETSc successfully started: number of processors = %d\n",size);CHKERRQ(ierr);
1008   ierr = PetscGetHostName(hostname,256);CHKERRQ(ierr);
1009   ierr = PetscInfo1(0,"Running on machine: %s\n",hostname);CHKERRQ(ierr);
1010 #if defined(PETSC_HAVE_OPENMP)
1011   {
1012     PetscBool omp_view_flag;
1013     char      *threads = getenv("OMP_NUM_THREADS");
1014 
1015    if (threads) {
1016      ierr = PetscInfo1(0,"Number of OpenMP threads %s (given by OMP_NUM_THREADS)\n",threads);CHKERRQ(ierr);
1017      (void) sscanf(threads, "%" PetscInt_FMT,&PetscNumOMPThreads);
1018    } else {
1019 #define NMAX  10000
1020      int          i;
1021       PetscScalar *x;
1022       ierr = PetscMalloc1(NMAX,&x);CHKERRQ(ierr);
1023 #pragma omp parallel for
1024       for (i=0; i<NMAX; i++) {
1025         x[i] = 0.0;
1026         PetscNumOMPThreads  = (PetscInt) omp_get_num_threads();
1027       }
1028       ierr = PetscFree(x);CHKERRQ(ierr);
1029       ierr = PetscInfo1(0,"Number of OpenMP threads %D (number not set with OMP_NUM_THREADS, chosen by system)\n",PetscNumOMPThreads);CHKERRQ(ierr);
1030     }
1031     ierr = PetscOptionsBegin(PETSC_COMM_WORLD,NULL,"OpenMP options","Sys");CHKERRQ(ierr);
1032     ierr = PetscOptionsInt("-omp_num_threads","Number of OpenMP threads to use (can also use environmental variable OMP_NUM_THREADS","None",PetscNumOMPThreads,&PetscNumOMPThreads,&flg);CHKERRQ(ierr);
1033     ierr = PetscOptionsName("-omp_view","Display OpenMP number of threads",NULL,&omp_view_flag);CHKERRQ(ierr);
1034     ierr = PetscOptionsEnd();CHKERRQ(ierr);
1035     if (flg) {
1036       ierr = PetscInfo1(0,"Number of OpenMP theads %D (given by -omp_num_threads)\n",PetscNumOMPThreads);CHKERRQ(ierr);
1037       omp_set_num_threads((int)PetscNumOMPThreads);
1038     }
1039     if (omp_view_flag) {
1040       ierr = PetscPrintf(PETSC_COMM_WORLD,"OpenMP: number of threads %D\n",PetscNumOMPThreads);CHKERRQ(ierr);
1041     }
1042   }
1043 #endif
1044   ierr = PetscOptionsCheckInitial_Components();CHKERRQ(ierr);
1045   /* Check the options database for options related to the options database itself */
1046   ierr = PetscOptionsSetFromOptions(NULL);CHKERRQ(ierr);
1047 
1048 #if defined(PETSC_USE_PETSC_MPI_EXTERNAL32)
1049   /*
1050       Tell MPI about our own data representation converter, this would/should be used if extern32 is not supported by the MPI
1051 
1052       Currently not used because it is not supported by MPICH.
1053   */
1054   if (!PetscBinaryBigEndian()) {
1055     ierr = MPI_Register_datarep((char*)"petsc",PetscDataRep_read_conv_fn,PetscDataRep_write_conv_fn,PetscDataRep_extent_fn,NULL);CHKERRQ(ierr);
1056   }
1057 #endif
1058 
1059   /*
1060       Setup building of stack frames for all function calls
1061   */
1062 #if defined(PETSC_USE_DEBUG) && !defined(PETSC_HAVE_THREADSAFETY)
1063   ierr = PetscStackCreate();CHKERRQ(ierr);
1064 #endif
1065 
1066 #if defined(PETSC_SERIALIZE_FUNCTIONS)
1067   ierr = PetscFPTCreate(10000);CHKERRQ(ierr);
1068 #endif
1069 
1070 #if defined(PETSC_HAVE_HWLOC)
1071   {
1072     PetscViewer viewer;
1073     ierr = PetscOptionsGetViewer(PETSC_COMM_WORLD,NULL,NULL,"-process_view",&viewer,NULL,&flg);CHKERRQ(ierr);
1074     if (flg) {
1075       ierr = PetscProcessPlacementView(viewer);CHKERRQ(ierr);
1076       ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr);
1077     }
1078   }
1079 #endif
1080 
1081   flg = PETSC_TRUE;
1082   ierr = PetscOptionsGetBool(NULL,NULL,"-viewfromoptions",&flg,NULL);CHKERRQ(ierr);
1083   if (!flg) {ierr = PetscOptionsPushGetViewerOff(PETSC_TRUE); CHKERRQ(ierr);}
1084 
1085 #if defined(PETSC_HAVE_ADIOS)
1086   ierr = adios_init_noxml(PETSC_COMM_WORLD);CHKERRQ(ierr);
1087   ierr = adios_declare_group(&Petsc_adios_group,"PETSc","",adios_stat_default);CHKERRQ(ierr);
1088   ierr = adios_select_method(Petsc_adios_group,"MPI","","");CHKERRQ(ierr);
1089   ierr = adios_read_init_method(ADIOS_READ_METHOD_BP,PETSC_COMM_WORLD,"");CHKERRQ(ierr);
1090 #endif
1091 #if defined(PETSC_HAVE_ADIOS2)
1092 #endif
1093 
1094   /*
1095       Once we are completedly initialized then we can set this variables
1096   */
1097   PetscInitializeCalled = PETSC_TRUE;
1098 
1099   ierr = PetscOptionsHasName(NULL,NULL,"-python",&flg);CHKERRQ(ierr);
1100   if (flg) {ierr = PetscPythonInitialize(NULL,NULL);CHKERRQ(ierr);}
1101   PetscFunctionReturn(0);
1102 }
1103 
1104 #if defined(PETSC_USE_LOG)
1105 PETSC_INTERN PetscObject *PetscObjects;
1106 PETSC_INTERN PetscInt    PetscObjectsCounts;
1107 PETSC_INTERN PetscInt    PetscObjectsMaxCounts;
1108 PETSC_INTERN PetscBool   PetscObjectsLog;
1109 #endif
1110 
1111 /*
1112     Frees all the MPI types and operations that PETSc may have created
1113 */
1114 PetscErrorCode  PetscFreeMPIResources(void)
1115 {
1116   PetscErrorCode ierr;
1117 
1118   PetscFunctionBegin;
1119 #if defined(PETSC_USE_REAL___FLOAT128)
1120   ierr = MPI_Type_free(&MPIU___FLOAT128);CHKERRQ(ierr);
1121 #if defined(PETSC_HAVE_COMPLEX)
1122   ierr = MPI_Type_free(&MPIU___COMPLEX128);CHKERRQ(ierr);
1123 #endif
1124   ierr = MPI_Op_free(&MPIU_MAX);CHKERRQ(ierr);
1125   ierr = MPI_Op_free(&MPIU_MIN);CHKERRQ(ierr);
1126 #elif defined(PETSC_USE_REAL___FP16)
1127   ierr = MPI_Type_free(&MPIU___FP16);CHKERRQ(ierr);
1128   ierr = MPI_Op_free(&MPIU_MAX);CHKERRQ(ierr);
1129   ierr = MPI_Op_free(&MPIU_MIN);CHKERRQ(ierr);
1130 #endif
1131 
1132 #if defined(PETSC_HAVE_COMPLEX)
1133 #if !defined(PETSC_HAVE_MPI_C_DOUBLE_COMPLEX)
1134   ierr = MPI_Type_free(&MPIU_C_DOUBLE_COMPLEX);CHKERRQ(ierr);
1135   ierr = MPI_Type_free(&MPIU_C_COMPLEX);CHKERRQ(ierr);
1136 #endif
1137 #endif
1138 
1139 #if (defined(PETSC_HAVE_COMPLEX) && !defined(PETSC_HAVE_MPI_C_DOUBLE_COMPLEX)) || defined(PETSC_USE_REAL___FLOAT128) || defined(PETSC_USE_REAL___FP16)
1140   ierr = MPI_Op_free(&MPIU_SUM);CHKERRQ(ierr);
1141 #endif
1142 
1143   ierr = MPI_Type_free(&MPIU_2SCALAR);CHKERRQ(ierr);
1144 #if defined(PETSC_USE_64BIT_INDICES)
1145   ierr = MPI_Type_free(&MPIU_2INT);CHKERRQ(ierr);
1146 #endif
1147   ierr = MPI_Op_free(&MPIU_MAXSUM_OP);CHKERRQ(ierr);
1148   PetscFunctionReturn(0);
1149 }
1150 
1151 /*@C
1152    PetscFinalize - Checks for options to be called at the conclusion
1153    of the program. MPI_Finalize() is called only if the user had not
1154    called MPI_Init() before calling PetscInitialize().
1155 
1156    Collective on PETSC_COMM_WORLD
1157 
1158    Options Database Keys:
1159 +  -options_view - Calls PetscOptionsView()
1160 .  -options_left - Prints unused options that remain in the database
1161 .  -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
1162 .  -mpidump - Calls PetscMPIDump()
1163 .  -malloc_dump - Calls PetscMallocDump()
1164 .  -malloc_info - Prints total memory usage
1165 -  -malloc_log - Prints summary of memory usage
1166 
1167    Level: beginner
1168 
1169    Note:
1170    See PetscInitialize() for more general runtime options.
1171 
1172 .seealso: PetscInitialize(), PetscOptionsView(), PetscMallocDump(), PetscMPIDump(), PetscEnd()
1173 @*/
1174 PetscErrorCode  PetscFinalize(void)
1175 {
1176   PetscErrorCode ierr;
1177   PetscMPIInt    rank;
1178   PetscInt       nopt;
1179   PetscBool      flg1 = PETSC_FALSE,flg2 = PETSC_FALSE,flg3 = PETSC_FALSE;
1180   PetscBool      flg;
1181 #if defined(PETSC_USE_LOG)
1182   char           mname[PETSC_MAX_PATH_LEN];
1183 #endif
1184 
1185   if (!PetscInitializeCalled) {
1186     printf("PetscInitialize() must be called before PetscFinalize()\n");
1187     return(PETSC_ERR_ARG_WRONGSTATE);
1188   }
1189   PetscFunctionBegin;
1190   ierr = PetscInfo(NULL,"PetscFinalize() called\n");CHKERRQ(ierr);
1191 
1192   ierr = MPI_Comm_rank(PETSC_COMM_WORLD,&rank);CHKERRQ(ierr);
1193 #if defined(PETSC_HAVE_ADIOS)
1194   ierr = adios_read_finalize_method(ADIOS_READ_METHOD_BP_AGGREGATE);CHKERRQ(ierr);
1195   ierr = adios_finalize(rank);CHKERRQ(ierr);
1196 #endif
1197 #if defined(PETSC_HAVE_ADIOS2)
1198 #endif
1199   ierr = PetscOptionsHasName(NULL,NULL,"-citations",&flg);CHKERRQ(ierr);
1200   if (flg) {
1201     char  *cits, filename[PETSC_MAX_PATH_LEN];
1202     FILE  *fd = PETSC_STDOUT;
1203 
1204     ierr = PetscOptionsGetString(NULL,NULL,"-citations",filename,PETSC_MAX_PATH_LEN,NULL);CHKERRQ(ierr);
1205     if (filename[0]) {
1206       ierr = PetscFOpen(PETSC_COMM_WORLD,filename,"w",&fd);CHKERRQ(ierr);
1207     }
1208     ierr = PetscSegBufferGet(PetscCitationsList,1,&cits);CHKERRQ(ierr);
1209     cits[0] = 0;
1210     ierr = PetscSegBufferExtractAlloc(PetscCitationsList,&cits);CHKERRQ(ierr);
1211     ierr = PetscFPrintf(PETSC_COMM_WORLD,fd,"If you publish results based on this computation please cite the following:\n");CHKERRQ(ierr);
1212     ierr = PetscFPrintf(PETSC_COMM_WORLD,fd,"===========================================================================\n");CHKERRQ(ierr);
1213     ierr = PetscFPrintf(PETSC_COMM_WORLD,fd,"%s",cits);CHKERRQ(ierr);
1214     ierr = PetscFPrintf(PETSC_COMM_WORLD,fd,"===========================================================================\n");CHKERRQ(ierr);
1215     ierr = PetscFClose(PETSC_COMM_WORLD,fd);CHKERRQ(ierr);
1216     ierr = PetscFree(cits);CHKERRQ(ierr);
1217   }
1218   ierr = PetscSegBufferDestroy(&PetscCitationsList);CHKERRQ(ierr);
1219 
1220 #if defined(PETSC_HAVE_SSL) && defined(PETSC_USE_SOCKET_VIEWER)
1221   /* TextBelt is run for testing purposes only, please do not use this feature often */
1222   {
1223     PetscInt nmax = 2;
1224     char     **buffs;
1225     ierr = PetscMalloc1(2,&buffs);CHKERRQ(ierr);
1226     ierr = PetscOptionsGetStringArray(NULL,NULL,"-textbelt",buffs,&nmax,&flg1);CHKERRQ(ierr);
1227     if (flg1) {
1228       if (!nmax) SETERRQ(PETSC_COMM_WORLD,PETSC_ERR_USER,"-textbelt requires either the phone number or number,\"message\"");
1229       if (nmax == 1) {
1230         ierr = PetscMalloc1(128,&buffs[1]);CHKERRQ(ierr);
1231         ierr = PetscGetProgramName(buffs[1],32);CHKERRQ(ierr);
1232         ierr = PetscStrcat(buffs[1]," has completed");CHKERRQ(ierr);
1233       }
1234       ierr = PetscTextBelt(PETSC_COMM_WORLD,buffs[0],buffs[1],NULL);CHKERRQ(ierr);
1235       ierr = PetscFree(buffs[0]);CHKERRQ(ierr);
1236       ierr = PetscFree(buffs[1]);CHKERRQ(ierr);
1237     }
1238     ierr = PetscFree(buffs);CHKERRQ(ierr);
1239   }
1240   {
1241     PetscInt nmax = 2;
1242     char     **buffs;
1243     ierr = PetscMalloc1(2,&buffs);CHKERRQ(ierr);
1244     ierr = PetscOptionsGetStringArray(NULL,NULL,"-tellmycell",buffs,&nmax,&flg1);CHKERRQ(ierr);
1245     if (flg1) {
1246       if (!nmax) SETERRQ(PETSC_COMM_WORLD,PETSC_ERR_USER,"-tellmycell requires either the phone number or number,\"message\"");
1247       if (nmax == 1) {
1248         ierr = PetscMalloc1(128,&buffs[1]);CHKERRQ(ierr);
1249         ierr = PetscGetProgramName(buffs[1],32);CHKERRQ(ierr);
1250         ierr = PetscStrcat(buffs[1]," has completed");CHKERRQ(ierr);
1251       }
1252       ierr = PetscTellMyCell(PETSC_COMM_WORLD,buffs[0],buffs[1],NULL);CHKERRQ(ierr);
1253       ierr = PetscFree(buffs[0]);CHKERRQ(ierr);
1254       ierr = PetscFree(buffs[1]);CHKERRQ(ierr);
1255     }
1256     ierr = PetscFree(buffs);CHKERRQ(ierr);
1257   }
1258 #endif
1259   /*
1260     It should be safe to cancel the options monitors, since we don't expect to be setting options
1261     here (at least that are worth monitoring).  Monitors ought to be released so that they release
1262     whatever memory was allocated there before -malloc_dump reports unfreed memory.
1263   */
1264   ierr = PetscOptionsMonitorCancel();CHKERRQ(ierr);
1265 
1266 #if defined(PETSC_SERIALIZE_FUNCTIONS)
1267   ierr = PetscFPTDestroy();CHKERRQ(ierr);
1268 #endif
1269 
1270 
1271 #if defined(PETSC_HAVE_SAWS)
1272   flg = PETSC_FALSE;
1273   ierr = PetscOptionsGetBool(NULL,NULL,"-saw_options",&flg,NULL);CHKERRQ(ierr);
1274   if (flg) {
1275     ierr = PetscOptionsSAWsDestroy();CHKERRQ(ierr);
1276   }
1277 #endif
1278 
1279 #if defined(PETSC_HAVE_X)
1280   flg1 = PETSC_FALSE;
1281   ierr = PetscOptionsGetBool(NULL,NULL,"-x_virtual",&flg1,NULL);CHKERRQ(ierr);
1282   if (flg1) {
1283     /*  this is a crude hack, but better than nothing */
1284     ierr = PetscPOpen(PETSC_COMM_WORLD,NULL,"pkill -9 Xvfb","r",NULL);CHKERRQ(ierr);
1285   }
1286 #endif
1287 
1288 #if !defined(PETSC_HAVE_THREADSAFETY)
1289   ierr = PetscOptionsGetBool(NULL,NULL,"-malloc_info",&flg2,NULL);CHKERRQ(ierr);
1290   if (!flg2) {
1291     flg2 = PETSC_FALSE;
1292     ierr = PetscOptionsGetBool(NULL,NULL,"-memory_view",&flg2,NULL);CHKERRQ(ierr);
1293   }
1294   if (flg2) {
1295     ierr = PetscMemoryView(PETSC_VIEWER_STDOUT_WORLD,"Summary of Memory Usage in PETSc\n");CHKERRQ(ierr);
1296   }
1297 #endif
1298 
1299 #if defined(PETSC_USE_LOG)
1300   flg1 = PETSC_FALSE;
1301   ierr = PetscOptionsGetBool(NULL,NULL,"-get_total_flops",&flg1,NULL);CHKERRQ(ierr);
1302   if (flg1) {
1303     PetscLogDouble flops = 0;
1304     ierr = MPI_Reduce(&petsc_TotalFlops,&flops,1,MPI_DOUBLE,MPI_SUM,0,PETSC_COMM_WORLD);CHKERRQ(ierr);
1305     ierr = PetscPrintf(PETSC_COMM_WORLD,"Total flops over all processors %g\n",flops);CHKERRQ(ierr);
1306   }
1307 #endif
1308 
1309 
1310 #if defined(PETSC_USE_LOG)
1311 #if defined(PETSC_HAVE_MPE)
1312   mname[0] = 0;
1313   ierr = PetscOptionsGetString(NULL,NULL,"-log_mpe",mname,PETSC_MAX_PATH_LEN,&flg1);CHKERRQ(ierr);
1314   if (flg1) {
1315     if (mname[0]) {ierr = PetscLogMPEDump(mname);CHKERRQ(ierr);}
1316     else          {ierr = PetscLogMPEDump(0);CHKERRQ(ierr);}
1317   }
1318 #endif
1319 #endif
1320 
1321   /*
1322      Free all objects registered with PetscObjectRegisterDestroy() such as PETSC_VIEWER_XXX_().
1323   */
1324   ierr = PetscObjectRegisterDestroyAll();CHKERRQ(ierr);
1325 
1326 #if defined(PETSC_USE_LOG)
1327   ierr = PetscOptionsPushGetViewerOff(PETSC_FALSE);CHKERRQ(ierr);
1328   ierr = PetscLogViewFromOptions();CHKERRQ(ierr);
1329   ierr = PetscOptionsPopGetViewerOff();CHKERRQ(ierr);
1330 
1331   mname[0] = 0;
1332   ierr = PetscOptionsGetString(NULL,NULL,"-log_summary",mname,PETSC_MAX_PATH_LEN,&flg1);CHKERRQ(ierr);
1333   if (flg1) {
1334     PetscViewer viewer;
1335     ierr = (*PetscHelpPrintf)(PETSC_COMM_WORLD,"\n\n WARNING:   -log_summary is being deprecated; switch to -log_view\n\n\n");CHKERRQ(ierr);
1336     if (mname[0]) {
1337       ierr = PetscViewerASCIIOpen(PETSC_COMM_WORLD,mname,&viewer);CHKERRQ(ierr);
1338       ierr = PetscLogView(viewer);CHKERRQ(ierr);
1339       ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr);
1340     } else {
1341       viewer = PETSC_VIEWER_STDOUT_WORLD;
1342       ierr   = PetscViewerPushFormat(viewer,PETSC_VIEWER_DEFAULT);CHKERRQ(ierr);
1343       ierr   = PetscLogView(viewer);CHKERRQ(ierr);
1344       ierr   = PetscViewerPopFormat(viewer);CHKERRQ(ierr);
1345     }
1346   }
1347 
1348   /*
1349      Free any objects created by the last block of code.
1350   */
1351   ierr = PetscObjectRegisterDestroyAll();CHKERRQ(ierr);
1352 
1353   mname[0] = 0;
1354   ierr = PetscOptionsGetString(NULL,NULL,"-log_all",mname,PETSC_MAX_PATH_LEN,&flg1);CHKERRQ(ierr);
1355   ierr = PetscOptionsGetString(NULL,NULL,"-log",mname,PETSC_MAX_PATH_LEN,&flg2);CHKERRQ(ierr);
1356   if (flg1 || flg2) {ierr = PetscLogDump(mname);CHKERRQ(ierr);}
1357 #endif
1358 
1359   ierr = PetscStackDestroy();CHKERRQ(ierr);
1360 
1361   flg1 = PETSC_FALSE;
1362   ierr = PetscOptionsGetBool(NULL,NULL,"-no_signal_handler",&flg1,NULL);CHKERRQ(ierr);
1363   if (!flg1) { ierr = PetscPopSignalHandler();CHKERRQ(ierr);}
1364   flg1 = PETSC_FALSE;
1365   ierr = PetscOptionsGetBool(NULL,NULL,"-mpidump",&flg1,NULL);CHKERRQ(ierr);
1366   if (flg1) {
1367     ierr = PetscMPIDump(stdout);CHKERRQ(ierr);
1368   }
1369   flg1 = PETSC_FALSE;
1370   flg2 = PETSC_FALSE;
1371   /* preemptive call to avoid listing this option in options table as unused */
1372   ierr = PetscOptionsHasName(NULL,NULL,"-malloc_dump",&flg1);CHKERRQ(ierr);
1373   ierr = PetscOptionsHasName(NULL,NULL,"-objects_dump",&flg1);CHKERRQ(ierr);
1374   ierr = PetscOptionsGetBool(NULL,NULL,"-options_view",&flg2,NULL);CHKERRQ(ierr);
1375 
1376   if (flg2) {
1377     PetscViewer viewer;
1378     ierr = PetscViewerCreate(PETSC_COMM_WORLD,&viewer);CHKERRQ(ierr);
1379     ierr = PetscViewerSetType(viewer,PETSCVIEWERASCII);CHKERRQ(ierr);
1380     ierr = PetscOptionsView(NULL,viewer);CHKERRQ(ierr);
1381     ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr);
1382   }
1383 
1384   /* to prevent PETSc -options_left from warning */
1385   ierr = PetscOptionsHasName(NULL,NULL,"-nox",&flg1);CHKERRQ(ierr);
1386   ierr = PetscOptionsHasName(NULL,NULL,"-nox_warning",&flg1);CHKERRQ(ierr);
1387 
1388   flg3 = PETSC_FALSE; /* default value is required */
1389   ierr = PetscOptionsGetBool(NULL,NULL,"-options_left",&flg3,&flg1);CHKERRQ(ierr);
1390   ierr = PetscOptionsAllUsed(NULL,&nopt);CHKERRQ(ierr);
1391   if (flg3) {
1392     if (!flg2) { /* have not yet printed the options */
1393       PetscViewer viewer;
1394       ierr = PetscViewerCreate(PETSC_COMM_WORLD,&viewer);CHKERRQ(ierr);
1395       ierr = PetscViewerSetType(viewer,PETSCVIEWERASCII);CHKERRQ(ierr);
1396       ierr = PetscOptionsView(NULL,viewer);CHKERRQ(ierr);
1397       ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr);
1398     }
1399     if (!nopt) {
1400       ierr = PetscPrintf(PETSC_COMM_WORLD,"There are no unused options.\n");CHKERRQ(ierr);
1401     } else if (nopt == 1) {
1402       ierr = PetscPrintf(PETSC_COMM_WORLD,"There is one unused database option. It is:\n");CHKERRQ(ierr);
1403     } else {
1404       ierr = PetscPrintf(PETSC_COMM_WORLD,"There are %D unused database options. They are:\n",nopt);CHKERRQ(ierr);
1405     }
1406   }
1407 #if defined(PETSC_USE_DEBUG)
1408   if (nopt && !flg3 && !flg1) {
1409     ierr = PetscPrintf(PETSC_COMM_WORLD,"WARNING! There are options you set that were not used!\n");CHKERRQ(ierr);
1410     ierr = PetscPrintf(PETSC_COMM_WORLD,"WARNING! could be spelling mistake, etc!\n");CHKERRQ(ierr);
1411     ierr = PetscOptionsLeft(NULL);CHKERRQ(ierr);
1412   } else if (nopt && flg3) {
1413 #else
1414   if (nopt && flg3) {
1415 #endif
1416     ierr = PetscOptionsLeft(NULL);CHKERRQ(ierr);
1417   }
1418 
1419 #if defined(PETSC_HAVE_SAWS)
1420   if (!PetscGlobalRank) {
1421     ierr = PetscStackSAWsViewOff();CHKERRQ(ierr);
1422     PetscStackCallSAWs(SAWs_Finalize,());
1423   }
1424 #endif
1425 
1426 #if defined(PETSC_USE_LOG)
1427   /*
1428        List all objects the user may have forgot to free
1429   */
1430   if (PetscObjectsLog) {
1431     ierr = PetscOptionsHasName(NULL,NULL,"-objects_dump",&flg1);CHKERRQ(ierr);
1432     if (flg1) {
1433       MPI_Comm local_comm;
1434       char     string[64];
1435 
1436       ierr = PetscOptionsGetString(NULL,NULL,"-objects_dump",string,64,NULL);CHKERRQ(ierr);
1437       ierr = MPI_Comm_dup(MPI_COMM_WORLD,&local_comm);CHKERRQ(ierr);
1438       ierr = PetscSequentialPhaseBegin_Private(local_comm,1);CHKERRQ(ierr);
1439       ierr = PetscObjectsDump(stdout,(string[0] == 'a') ? PETSC_TRUE : PETSC_FALSE);CHKERRQ(ierr);
1440       ierr = PetscSequentialPhaseEnd_Private(local_comm,1);CHKERRQ(ierr);
1441       ierr = MPI_Comm_free(&local_comm);CHKERRQ(ierr);
1442     }
1443   }
1444 #endif
1445 
1446 #if defined(PETSC_USE_LOG)
1447   PetscObjectsCounts    = 0;
1448   PetscObjectsMaxCounts = 0;
1449   ierr = PetscFree(PetscObjects);CHKERRQ(ierr);
1450 #endif
1451 
1452   /*
1453      Destroy any packages that registered a finalize
1454   */
1455   ierr = PetscRegisterFinalizeAll();CHKERRQ(ierr);
1456 
1457 #if defined(PETSC_USE_LOG)
1458   ierr = PetscLogFinalize();CHKERRQ(ierr);
1459 #endif
1460 
1461   /*
1462      Print PetscFunctionLists that have not been properly freed
1463 
1464   ierr = PetscFunctionListPrintAll();CHKERRQ(ierr);
1465   */
1466 
1467   if (petsc_history) {
1468     ierr = PetscCloseHistoryFile(&petsc_history);CHKERRQ(ierr);
1469     petsc_history = 0;
1470   }
1471   ierr = PetscOptionsHelpPrintedDestroy(&PetscOptionsHelpPrintedSingleton);CHKERRQ(ierr);
1472 
1473   ierr = PetscInfoAllow(PETSC_FALSE,NULL);CHKERRQ(ierr);
1474 
1475 #if !defined(PETSC_HAVE_THREADSAFETY)
1476   {
1477     char fname[PETSC_MAX_PATH_LEN];
1478     FILE *fd;
1479     int  err;
1480 
1481     fname[0] = 0;
1482 
1483     ierr = PetscOptionsGetString(NULL,NULL,"-malloc_dump",fname,250,&flg1);CHKERRQ(ierr);
1484     flg2 = PETSC_FALSE;
1485     ierr = PetscOptionsGetBool(NULL,NULL,"-malloc_test",&flg2,NULL);CHKERRQ(ierr);
1486 #if defined(PETSC_USE_DEBUG)
1487     if (PETSC_RUNNING_ON_VALGRIND) flg2 = PETSC_FALSE;
1488 #else
1489     flg2 = PETSC_FALSE;         /* Skip reporting for optimized builds regardless of -malloc_test */
1490 #endif
1491     if (flg1 && fname[0]) {
1492       char sname[PETSC_MAX_PATH_LEN];
1493 
1494       PetscSNPrintf(sname,PETSC_MAX_PATH_LEN,"%s_%d",fname,rank);
1495       fd   = fopen(sname,"w"); if (!fd) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_FILE_OPEN,"Cannot open log file: %s",sname);
1496       ierr = PetscMallocDump(fd);CHKERRQ(ierr);
1497       err  = fclose(fd);
1498       if (err) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SYS,"fclose() failed on file");
1499     } else if (flg1 || flg2) {
1500       MPI_Comm local_comm;
1501 
1502       ierr = MPI_Comm_dup(MPI_COMM_WORLD,&local_comm);CHKERRQ(ierr);
1503       ierr = PetscSequentialPhaseBegin_Private(local_comm,1);CHKERRQ(ierr);
1504       ierr = PetscMallocDump(stdout);CHKERRQ(ierr);
1505       ierr = PetscSequentialPhaseEnd_Private(local_comm,1);CHKERRQ(ierr);
1506       ierr = MPI_Comm_free(&local_comm);CHKERRQ(ierr);
1507     }
1508   }
1509 
1510   {
1511     char fname[PETSC_MAX_PATH_LEN];
1512     FILE *fd = NULL;
1513 
1514     fname[0] = 0;
1515 
1516     ierr = PetscOptionsGetString(NULL,NULL,"-malloc_log",fname,250,&flg1);CHKERRQ(ierr);
1517     ierr = PetscOptionsHasName(NULL,NULL,"-malloc_log_threshold",&flg2);CHKERRQ(ierr);
1518     if (flg1 && fname[0]) {
1519       int err;
1520 
1521       if (!rank) {
1522         fd = fopen(fname,"w");
1523         if (!fd) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_FILE_OPEN,"Cannot open log file: %s",fname);
1524       }
1525       ierr = PetscMallocDumpLog(fd);CHKERRQ(ierr);
1526       if (fd) {
1527         err = fclose(fd);
1528         if (err) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SYS,"fclose() failed on file");
1529       }
1530     } else if (flg1 || flg2) {
1531       ierr = PetscMallocDumpLog(stdout);CHKERRQ(ierr);
1532     }
1533   }
1534 #endif
1535 
1536   /*
1537      Close any open dynamic libraries
1538   */
1539   ierr = PetscFinalize_DynamicLibraries();CHKERRQ(ierr);
1540 
1541   /* Can be destroyed only after all the options are used */
1542   ierr = PetscOptionsDestroyDefault();CHKERRQ(ierr);
1543 
1544   PetscGlobalArgc = 0;
1545   PetscGlobalArgs = 0;
1546 
1547   ierr = PetscFreeMPIResources();CHKERRQ(ierr);
1548 
1549   /*
1550      Destroy any known inner MPI_Comm's and attributes pointing to them
1551      Note this will not destroy any new communicators the user has created.
1552 
1553      If all PETSc objects were not destroyed those left over objects will have hanging references to
1554      the MPI_Comms that were freed; but that is ok because those PETSc objects will never be used again
1555  */
1556   {
1557     PetscCommCounter *counter;
1558     PetscMPIInt      flg;
1559     MPI_Comm         icomm;
1560     union {MPI_Comm comm; void *ptr;} ucomm;
1561     ierr = MPI_Comm_get_attr(PETSC_COMM_SELF,Petsc_InnerComm_keyval,&ucomm,&flg);CHKERRQ(ierr);
1562     if (flg) {
1563       icomm = ucomm.comm;
1564       ierr = MPI_Comm_get_attr(icomm,Petsc_Counter_keyval,&counter,&flg);CHKERRQ(ierr);
1565       if (!flg) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_CORRUPT,"Inner MPI_Comm does not have expected tag/name counter, problem with corrupted memory");
1566 
1567       ierr = MPI_Comm_delete_attr(PETSC_COMM_SELF,Petsc_InnerComm_keyval);CHKERRQ(ierr);
1568       ierr = MPI_Comm_delete_attr(icomm,Petsc_Counter_keyval);CHKERRQ(ierr);
1569       ierr = MPI_Comm_free(&icomm);CHKERRQ(ierr);
1570     }
1571     ierr = MPI_Comm_get_attr(PETSC_COMM_WORLD,Petsc_InnerComm_keyval,&ucomm,&flg);CHKERRQ(ierr);
1572     if (flg) {
1573       icomm = ucomm.comm;
1574       ierr = MPI_Comm_get_attr(icomm,Petsc_Counter_keyval,&counter,&flg);CHKERRQ(ierr);
1575       if (!flg) SETERRQ(PETSC_COMM_WORLD,PETSC_ERR_ARG_CORRUPT,"Inner MPI_Comm does not have expected tag/name counter, problem with corrupted memory");
1576 
1577       ierr = MPI_Comm_delete_attr(PETSC_COMM_WORLD,Petsc_InnerComm_keyval);CHKERRQ(ierr);
1578       ierr = MPI_Comm_delete_attr(icomm,Petsc_Counter_keyval);CHKERRQ(ierr);
1579       ierr = MPI_Comm_free(&icomm);CHKERRQ(ierr);
1580     }
1581   }
1582 
1583   ierr = MPI_Comm_free_keyval(&Petsc_Counter_keyval);CHKERRQ(ierr);
1584   ierr = MPI_Comm_free_keyval(&Petsc_InnerComm_keyval);CHKERRQ(ierr);
1585   ierr = MPI_Comm_free_keyval(&Petsc_OuterComm_keyval);CHKERRQ(ierr);
1586   ierr = MPI_Comm_free_keyval(&Petsc_ShmComm_keyval);CHKERRQ(ierr);
1587 
1588   ierr = PetscSpinlockDestroy(&PetscViewerASCIISpinLockOpen);CHKERRQ(ierr);
1589   ierr = PetscSpinlockDestroy(&PetscViewerASCIISpinLockStdout);CHKERRQ(ierr);
1590   ierr = PetscSpinlockDestroy(&PetscViewerASCIISpinLockStderr);CHKERRQ(ierr);
1591   ierr = PetscSpinlockDestroy(&PetscCommSpinLock);CHKERRQ(ierr);
1592 
1593   if (PetscBeganMPI) {
1594 #if defined(PETSC_HAVE_MPI_FINALIZED)
1595     PetscMPIInt flag;
1596     ierr = MPI_Finalized(&flag);CHKERRQ(ierr);
1597     if (flag) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_LIB,"MPI_Finalize() has already been called, even though MPI_Init() was called by PetscInitialize()");
1598 #endif
1599     ierr = MPI_Finalize();CHKERRQ(ierr);
1600   }
1601 /*
1602 
1603      Note: In certain cases PETSC_COMM_WORLD is never MPI_Comm_free()ed because
1604    the communicator has some outstanding requests on it. Specifically if the
1605    flag PETSC_HAVE_BROKEN_REQUEST_FREE is set (for IBM MPI implementation). See
1606    src/vec/utils/vpscat.c. Due to this the memory allocated in PetscCommDuplicate()
1607    is never freed as it should be. Thus one may obtain messages of the form
1608    [ 1] 8 bytes PetscCommDuplicate() line 645 in src/sys/mpiu.c indicating the
1609    memory was not freed.
1610 
1611 */
1612   ierr = PetscMallocClear();CHKERRQ(ierr);
1613 
1614   PetscInitializeCalled = PETSC_FALSE;
1615   PetscFinalizeCalled   = PETSC_TRUE;
1616   PetscFunctionReturn(0);
1617 }
1618 
1619 #if defined(PETSC_MISSING_LAPACK_lsame_)
1620 PETSC_EXTERN int lsame_(char *a,char *b)
1621 {
1622   if (*a == *b) return 1;
1623   if (*a + 32 == *b) return 1;
1624   if (*a - 32 == *b) return 1;
1625   return 0;
1626 }
1627 #endif
1628 
1629 #if defined(PETSC_MISSING_LAPACK_lsame)
1630 PETSC_EXTERN int lsame(char *a,char *b)
1631 {
1632   if (*a == *b) return 1;
1633   if (*a + 32 == *b) return 1;
1634   if (*a - 32 == *b) return 1;
1635   return 0;
1636 }
1637 #endif
1638