xref: /petsc/src/sys/objects/pinit.c (revision 7a0030261dd1b46d2b74d0bbc90eda8c2f64db07)
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    Concepts: command line arguments
453 
454 .seealso: PetscFinalize(), PetscInitializeFortran(), PetscGetArguments()
455 
456 @*/
457 PetscErrorCode  PetscGetArgs(int *argc,char ***args)
458 {
459   PetscFunctionBegin;
460   if (!PetscInitializeCalled && PetscFinalizeCalled) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ORDER,"You must call after PetscInitialize() but before PetscFinalize()");
461   *argc = PetscGlobalArgc;
462   *args = PetscGlobalArgs;
463   PetscFunctionReturn(0);
464 }
465 
466 /*@C
467    PetscGetArguments - Allows you to access the  command line arguments anywhere
468      after PetscInitialize() is called but before PetscFinalize().
469 
470    Not Collective
471 
472    Output Parameters:
473 .  args - the command line arguments
474 
475    Level: intermediate
476 
477    Notes:
478       This does NOT start with the program name and IS null terminated (final arg is void)
479 
480    Concepts: command line arguments
481 
482 .seealso: PetscFinalize(), PetscInitializeFortran(), PetscGetArgs(), PetscFreeArguments()
483 
484 @*/
485 PetscErrorCode  PetscGetArguments(char ***args)
486 {
487   PetscInt       i,argc = PetscGlobalArgc;
488   PetscErrorCode ierr;
489 
490   PetscFunctionBegin;
491   if (!PetscInitializeCalled && PetscFinalizeCalled) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ORDER,"You must call after PetscInitialize() but before PetscFinalize()");
492   if (!argc) {*args = NULL; PetscFunctionReturn(0);}
493   ierr = PetscMalloc1(argc,args);CHKERRQ(ierr);
494   for (i=0; i<argc-1; i++) {
495     ierr = PetscStrallocpy(PetscGlobalArgs[i+1],&(*args)[i]);CHKERRQ(ierr);
496   }
497   (*args)[argc-1] = NULL;
498   PetscFunctionReturn(0);
499 }
500 
501 /*@C
502    PetscFreeArguments - Frees the memory obtained with PetscGetArguments()
503 
504    Not Collective
505 
506    Output Parameters:
507 .  args - the command line arguments
508 
509    Level: intermediate
510 
511    Concepts: command line arguments
512 
513 .seealso: PetscFinalize(), PetscInitializeFortran(), PetscGetArgs(), PetscGetArguments()
514 
515 @*/
516 PetscErrorCode  PetscFreeArguments(char **args)
517 {
518   PetscInt       i = 0;
519   PetscErrorCode ierr;
520 
521   PetscFunctionBegin;
522   if (!args) PetscFunctionReturn(0);
523   while (args[i]) {
524     ierr = PetscFree(args[i]);CHKERRQ(ierr);
525     i++;
526   }
527   ierr = PetscFree(args);CHKERRQ(ierr);
528   PetscFunctionReturn(0);
529 }
530 
531 #if defined(PETSC_HAVE_SAWS)
532 #include <petscconfiginfo.h>
533 
534 PETSC_INTERN PetscErrorCode PetscInitializeSAWs(const char help[])
535 {
536   if (!PetscGlobalRank) {
537     char           cert[PETSC_MAX_PATH_LEN],root[PETSC_MAX_PATH_LEN],*intro,programname[64],*appline,*options,version[64];
538     int            port;
539     PetscBool      flg,rootlocal = PETSC_FALSE,flg2,selectport = PETSC_FALSE;
540     size_t         applinelen,introlen;
541     PetscErrorCode ierr;
542     char           sawsurl[256];
543 
544     ierr = PetscOptionsHasName(NULL,NULL,"-saws_log",&flg);CHKERRQ(ierr);
545     if (flg) {
546       char  sawslog[PETSC_MAX_PATH_LEN];
547 
548       ierr = PetscOptionsGetString(NULL,NULL,"-saws_log",sawslog,PETSC_MAX_PATH_LEN,NULL);CHKERRQ(ierr);
549       if (sawslog[0]) {
550         PetscStackCallSAWs(SAWs_Set_Use_Logfile,(sawslog));
551       } else {
552         PetscStackCallSAWs(SAWs_Set_Use_Logfile,(NULL));
553       }
554     }
555     ierr = PetscOptionsGetString(NULL,NULL,"-saws_https",cert,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr);
556     if (flg) {
557       PetscStackCallSAWs(SAWs_Set_Use_HTTPS,(cert));
558     }
559     ierr = PetscOptionsGetBool(NULL,NULL,"-saws_port_auto_select",&selectport,NULL);CHKERRQ(ierr);
560     if (selectport) {
561         PetscStackCallSAWs(SAWs_Get_Available_Port,(&port));
562         PetscStackCallSAWs(SAWs_Set_Port,(port));
563     } else {
564       ierr = PetscOptionsGetInt(NULL,NULL,"-saws_port",&port,&flg);CHKERRQ(ierr);
565       if (flg) {
566         PetscStackCallSAWs(SAWs_Set_Port,(port));
567       }
568     }
569     ierr = PetscOptionsGetString(NULL,NULL,"-saws_root",root,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr);
570     if (flg) {
571       PetscStackCallSAWs(SAWs_Set_Document_Root,(root));CHKERRQ(ierr);
572       ierr = PetscStrcmp(root,".",&rootlocal);CHKERRQ(ierr);
573     } else {
574       ierr = PetscOptionsHasName(NULL,NULL,"-saws_options",&flg);CHKERRQ(ierr);
575       if (flg) {
576         ierr = PetscStrreplace(PETSC_COMM_WORLD,"${PETSC_DIR}/share/petsc/saws",root,PETSC_MAX_PATH_LEN);CHKERRQ(ierr);
577         PetscStackCallSAWs(SAWs_Set_Document_Root,(root));CHKERRQ(ierr);
578       }
579     }
580     ierr = PetscOptionsHasName(NULL,NULL,"-saws_local",&flg2);CHKERRQ(ierr);
581     if (flg2) {
582       char jsdir[PETSC_MAX_PATH_LEN];
583       if (!flg) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SUP,"-saws_local option requires -saws_root option");
584       ierr = PetscSNPrintf(jsdir,PETSC_MAX_PATH_LEN,"%s/js",root);CHKERRQ(ierr);
585       ierr = PetscTestDirectory(jsdir,'r',&flg);CHKERRQ(ierr);
586       if (!flg) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_FILE_READ,"-saws_local option requires js directory in root directory");
587       PetscStackCallSAWs(SAWs_Push_Local_Header,());CHKERRQ(ierr);
588     }
589     ierr = PetscGetProgramName(programname,64);CHKERRQ(ierr);
590     ierr = PetscStrlen(help,&applinelen);CHKERRQ(ierr);
591     introlen   = 4096 + applinelen;
592     applinelen += 1024;
593     ierr = PetscMalloc(applinelen,&appline);CHKERRQ(ierr);
594     ierr = PetscMalloc(introlen,&intro);CHKERRQ(ierr);
595 
596     if (rootlocal) {
597       ierr = PetscSNPrintf(appline,applinelen,"%s.c.html",programname);CHKERRQ(ierr);
598       ierr = PetscTestFile(appline,'r',&rootlocal);CHKERRQ(ierr);
599     }
600     ierr = PetscOptionsGetAll(NULL,&options);CHKERRQ(ierr);
601     if (rootlocal && help) {
602       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);
603     } else if (help) {
604       ierr = PetscSNPrintf(appline,applinelen,"<center>Running %s %s</center><br><center><pre>%s</pre></center><br>",programname,options,help);CHKERRQ(ierr);
605     } else {
606       ierr = PetscSNPrintf(appline,applinelen,"<center> Running %s %s</center><br>\n",programname,options);CHKERRQ(ierr);
607     }
608     ierr = PetscFree(options);CHKERRQ(ierr);
609     ierr = PetscGetVersion(version,sizeof(version));CHKERRQ(ierr);
610     ierr = PetscSNPrintf(intro,introlen,"<body>\n"
611                                     "<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"
612                                     "<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"
613                                     "%s",version,petscconfigureoptions,appline);CHKERRQ(ierr);
614     PetscStackCallSAWs(SAWs_Push_Body,("index.html",0,intro));
615     ierr = PetscFree(intro);CHKERRQ(ierr);
616     ierr = PetscFree(appline);CHKERRQ(ierr);
617     if (selectport) {
618       PetscBool silent;
619 
620       ierr = SAWs_Initialize();
621       /* another process may have grabbed the port so keep trying */
622       while (ierr) {
623         PetscStackCallSAWs(SAWs_Get_Available_Port,(&port));
624         PetscStackCallSAWs(SAWs_Set_Port,(port));
625         ierr = SAWs_Initialize();
626       }
627 
628       ierr = PetscOptionsGetBool(NULL,NULL,"-saws_port_auto_select_silent",&silent,NULL);CHKERRQ(ierr);
629       if (!silent) {
630         PetscStackCallSAWs(SAWs_Get_FullURL,(sizeof(sawsurl),sawsurl));
631         ierr = PetscPrintf(PETSC_COMM_WORLD,"Point your browser to %s for SAWs\n",sawsurl);CHKERRQ(ierr);
632       }
633     } else {
634       PetscStackCallSAWs(SAWs_Initialize,());
635     }
636     ierr = PetscCitationsRegister("@TechReport{ saws,\n"
637                                   "  Author = {Matt Otten and Jed Brown and Barry Smith},\n"
638                                   "  Title  = {Scientific Application Web Server (SAWs) Users Manual},\n"
639                                   "  Institution = {Argonne National Laboratory},\n"
640                                   "  Year   = 2013\n}\n",NULL);CHKERRQ(ierr);
641   }
642   PetscFunctionReturn(0);
643 }
644 #endif
645 
646 #if defined(PETSC_HAVE_ADIOS)
647 #include <adios.h>
648 #include <adios_read.h>
649 int64_t Petsc_adios_group;
650 #endif
651 #if defined(PETSC_HAVE_ADIOS2)
652 #include <adios2_c.h>
653 #endif
654 
655 /*@C
656    PetscInitialize - Initializes the PETSc database and MPI.
657    PetscInitialize() calls MPI_Init() if that has yet to be called,
658    so this routine should always be called near the beginning of
659    your program -- usually the very first line!
660 
661    Collective on MPI_COMM_WORLD or PETSC_COMM_WORLD if it has been set
662 
663    Input Parameters:
664 +  argc - count of number of command line arguments
665 .  args - the command line arguments
666 .  file - [optional] PETSc database file, also checks ~username/.petscrc and .petscrc use NULL to not check for
667           code specific file. Use -skip_petscrc in the code specific file to skip the .petscrc files
668 -  help - [optional] Help message to print, use NULL for no message
669 
670    If you wish PETSc code to run ONLY on a subcommunicator of MPI_COMM_WORLD, create that
671    communicator first and assign it to PETSC_COMM_WORLD BEFORE calling PetscInitialize(). Thus if you are running a
672    four process job and two processes will run PETSc and have PetscInitialize() and PetscFinalize() and two process will not,
673    then do this. If ALL processes in the job are using PetscInitialize() and PetscFinalize() then you don't need to do this, even
674    if different subcommunicators of the job are doing different things with PETSc.
675 
676    Options Database Keys:
677 +  -help [intro] - prints help method for each option; if intro is given the program stops after printing the introductory help message
678 .  -start_in_debugger [noxterm,dbx,xdb,gdb,...] - Starts program in debugger
679 .  -on_error_attach_debugger [noxterm,dbx,xdb,gdb,...] - Starts debugger when error detected
680 .  -on_error_emacs <machinename> - causes emacsclient to jump to error file
681 .  -on_error_abort - calls abort() when error detected (no traceback)
682 .  -on_error_mpiabort - calls MPI_abort() when error detected
683 .  -error_output_stderr - prints error messages to stderr instead of the default stdout
684 .  -error_output_none - does not print the error messages (but handles errors in the same way as if this was not called)
685 .  -debugger_nodes [node1,node2,...] - Indicates nodes to start in debugger
686 .  -debugger_pause [sleeptime] (in seconds) - Pauses debugger
687 .  -stop_for_debugger - Print message on how to attach debugger manually to
688                         process and wait (-debugger_pause) seconds for attachment
689 .  -malloc - Indicates use of PETSc error-checking malloc (on by default for debug version of libraries)
690 .  -malloc no - Indicates not to use error-checking malloc
691 .  -malloc_debug - check for memory corruption at EVERY malloc or free
692 .  -malloc_dump - prints a list of all unfreed memory at the end of the run
693 .  -malloc_test - like -malloc_dump -malloc_debug, but only active for debugging builds
694 .  -fp_trap - Stops on floating point exceptions (Note that on the
695               IBM RS6000 this slows code by at least a factor of 10.)
696 .  -no_signal_handler - Indicates not to trap error signals
697 .  -shared_tmp - indicates /tmp directory is shared by all processors
698 .  -not_shared_tmp - each processor has own /tmp
699 .  -tmp - alternative name of /tmp directory
700 .  -get_total_flops - returns total flops done by all processors
701 -  -memory_view - Print memory usage at end of run
702 
703    Options Database Keys for Profiling:
704    See Users-Manual: ch_profiling for details.
705 +  -info <optional filename> - Prints verbose information to the screen
706 .  -info_exclude <null,vec,mat,pc,ksp,snes,ts> - Excludes some of the verbose messages
707 .  -log_sync - Enable barrier synchronization for all events. This option is useful to debug imbalance within each event,
708         however it slows things down and gives a distorted view of the overall runtime.
709 .  -log_trace [filename] - Print traces of all PETSc calls to the screen (useful to determine where a program
710         hangs without running in the debugger).  See PetscLogTraceBegin().
711 .  -log_view [:filename:format] - Prints summary of flop and timing information to screen or file, see PetscLogView().
712 .  -log_summary [filename] - (Deprecated, use -log_view) Prints summary of flop and timing information to screen. If the filename is specified the
713         summary is written to the file.  See PetscLogView().
714 .  -log_exclude: <vec,mat,pc,ksp,snes> - excludes subset of object classes from logging
715 .  -log_all [filename] - Logs extensive profiling information  See PetscLogDump().
716 .  -log [filename] - Logs basic profiline information  See PetscLogDump().
717 .  -log_mpe [filename] - Creates a logfile viewable by the utility Jumpshot (in MPICH distribution)
718 .  -viewfromoptions on,off - Enable or disable XXXSetFromOptions() calls, for applications with many small solves turn this off
719 -  -check_pointer_intensity 0,1,2 - if pointers are checked for validity (debug version only), using 0 will result in faster code
720 
721     Only one of -log_trace, -log_view, -log_view, -log_all, -log, or -log_mpe may be used at a time
722 
723    Options Database Keys for SAWs:
724 +  -saws_port <portnumber> - port number to publish SAWs data, default is 8080
725 .  -saws_port_auto_select - have SAWs select a new unique port number where it publishes the data, the URL is printed to the screen
726                             this is useful when you are running many jobs that utilize SAWs at the same time
727 .  -saws_log <filename> - save a log of all SAWs communication
728 .  -saws_https <certificate file> - have SAWs use HTTPS instead of HTTP
729 -  -saws_root <directory> - allow SAWs to have access to the given directory to search for requested resources and files
730 
731    Environmental Variables:
732 +   PETSC_TMP - alternative tmp directory
733 .   PETSC_SHARED_TMP - tmp is shared by all processes
734 .   PETSC_NOT_SHARED_TMP - each process has its own private tmp
735 .   PETSC_VIEWER_SOCKET_PORT - socket number to use for socket viewer
736 -   PETSC_VIEWER_SOCKET_MACHINE - machine to use for socket viewer to connect to
737 
738 
739    Level: beginner
740 
741    Notes:
742    If for some reason you must call MPI_Init() separately, call
743    it before PetscInitialize().
744 
745    Fortran Version:
746    In Fortran this routine has the format
747 $       call PetscInitialize(file,ierr)
748 
749 +   ierr - error return code
750 -  file - [optional] PETSc database file, also checks ~username/.petscrc and .petscrc use PETSC_NULL_CHARACTER to not check for
751           code specific file. Use -skip_petscrc in the code specific file to skip the .petscrc files
752 
753    Important Fortran Note:
754    In Fortran, you MUST use PETSC_NULL_CHARACTER to indicate a
755    null character string; you CANNOT just use NULL as
756    in the C version. See Users-Manual: ch_fortran for details.
757 
758    If your main program is C but you call Fortran code that also uses PETSc you need to call PetscInitializeFortran() soon after
759    calling PetscInitialize().
760 
761    Concepts: initializing PETSc
762 
763 .seealso: PetscFinalize(), PetscInitializeFortran(), PetscGetArgs(), PetscInitializeNoArguments()
764 
765 @*/
766 PetscErrorCode  PetscInitialize(int *argc,char ***args,const char file[],const char help[])
767 {
768   PetscErrorCode ierr;
769   PetscMPIInt    flag, size;
770   PetscBool      flg = PETSC_TRUE;
771   char           hostname[256];
772 
773   PetscFunctionBegin;
774   if (PetscInitializeCalled) PetscFunctionReturn(0);
775   /*
776       The checking over compatible runtime libraries is complicated by the MPI ABI initiative
777       https://wiki.mpich.org/mpich/index.php/ABI_Compatibility_Initiative which started with
778         MPICH v3.1 (Released Feburary 2014)
779         IBM MPI v2.1 (December 2014)
780         Intel® MPI Library v5.0 (2014)
781         Cray MPT v7.0.0 (June 2014)
782       As of July 31, 2017 the ABI number still appears to be 12, that is all of the versions
783       listed above and since that time are compatible.
784 
785       Unfortunately the MPI ABI initiative has not defined a way to determine the ABI number
786       at compile time or runtime. Thus we will need to systematically track the allowed versions
787       and how they are represented in the mpi.h and MPI_Get_library_version() output in order
788       to perform the checking.
789 
790       Currently we only check for pre MPI ABI versions (and packages that do not follow the MPI ABI).
791 
792       Questions:
793 
794         Should the checks for ABI incompatibility be only on the major version number below?
795         Presumably the output to stderr will be removed before a release.
796   */
797 
798 #if defined(PETSC_HAVE_MPI_GET_LIBRARY_VERSION)
799   {
800     char        mpilibraryversion[MPI_MAX_LIBRARY_VERSION_STRING];
801     PetscMPIInt mpilibraryversionlength;
802     ierr = MPI_Get_library_version(mpilibraryversion,&mpilibraryversionlength);if (ierr) return ierr;
803     /* check for MPICH versions before MPI ABI initiative */
804 #if defined(MPICH_VERSION)
805 #if MPICH_NUMVERSION < 30100000
806     {
807       char *ver,*lf;
808       flg = PETSC_FALSE;
809       ierr = PetscStrstr(mpilibraryversion,"MPICH Version:",&ver);if (ierr) return ierr;
810       if (ver) {
811         ierr = PetscStrchr(ver,'\n',&lf);if (ierr) return ierr;
812         if (lf) {
813           *lf = 0;
814           ierr = PetscStrendswith(ver,MPICH_VERSION,&flg);if (ierr) return ierr;
815         }
816       }
817       if (!flg) {
818         fprintf(stderr,"PETSc Error --- MPICH library version \n%s does not match what PETSc was compiled with %s, aborting\n",mpilibraryversion,MPICH_VERSION);
819         return PETSC_ERR_MPI_LIB_INCOMP;
820       }
821     }
822 #endif
823     /* check for OpenMPI version, it is not part of the MPI ABI initiative (is it part of another initiative that needs to be handled?) */
824 #elif defined(OMPI_MAJOR_VERSION)
825     {
826       char *ver,bs[32],*bsf;
827       flg = PETSC_FALSE;
828       ierr = PetscStrstr(mpilibraryversion,"Open MPI",&ver);if (ierr) return ierr;
829       if (ver) {
830         PetscSNPrintf(bs,32,"v%d.%d",OMPI_MAJOR_VERSION,OMPI_MINOR_VERSION);
831         ierr = PetscStrstr(ver,bs,&bsf);if (ierr) return ierr;
832         if (bsf) flg = PETSC_TRUE;
833       }
834       if (!flg) {
835         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);
836         return PETSC_ERR_MPI_LIB_INCOMP;
837       }
838     }
839 #endif
840   }
841 #endif
842 
843 
844   /* these must be initialized in a routine, not as a constant declaration*/
845   PETSC_STDOUT = stdout;
846   PETSC_STDERR = stderr;
847 
848   /* on Windows - set printf to default to printing 2 digit exponents */
849 #if defined(PETSC_HAVE__SET_OUTPUT_FORMAT)
850   _set_output_format(_TWO_DIGIT_EXPONENT);
851 #endif
852 
853   ierr = PetscOptionsCreateDefault();CHKERRQ(ierr);
854 
855   /*
856      We initialize the program name here (before MPI_Init()) because MPICH has a bug in
857      it that it sets args[0] on all processors to be args[0] on the first processor.
858   */
859   if (argc && *argc) {
860     ierr = PetscSetProgramName(**args);CHKERRQ(ierr);
861   } else {
862     ierr = PetscSetProgramName("Unknown Name");CHKERRQ(ierr);
863   }
864 
865   ierr = MPI_Initialized(&flag);CHKERRQ(ierr);
866   if (!flag) {
867     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");
868 #if defined(PETSC_HAVE_MPI_INIT_THREAD)
869     {
870       PetscMPIInt provided;
871       ierr = MPI_Init_thread(argc,args,MPI_THREAD_FUNNELED,&provided);CHKERRQ(ierr);
872     }
873 #else
874     ierr = MPI_Init(argc,args);CHKERRQ(ierr);
875 #endif
876     PetscBeganMPI = PETSC_TRUE;
877   }
878   if (argc && args) {
879     PetscGlobalArgc = *argc;
880     PetscGlobalArgs = *args;
881   }
882   PetscFinalizeCalled = PETSC_FALSE;
883   ierr = PetscSpinlockCreate(&PetscViewerASCIISpinLockOpen);CHKERRQ(ierr);
884   ierr = PetscSpinlockCreate(&PetscViewerASCIISpinLockStdout);CHKERRQ(ierr);
885   ierr = PetscSpinlockCreate(&PetscViewerASCIISpinLockStderr);CHKERRQ(ierr);
886   ierr = PetscSpinlockCreate(&PetscCommSpinLock);CHKERRQ(ierr);
887 
888   if (PETSC_COMM_WORLD == MPI_COMM_NULL) PETSC_COMM_WORLD = MPI_COMM_WORLD;
889   ierr = MPI_Comm_set_errhandler(PETSC_COMM_WORLD,MPI_ERRORS_RETURN);CHKERRQ(ierr);
890 
891   ierr = MPI_Add_error_class(&PETSC_MPI_ERROR_CLASS);CHKERRQ(ierr);
892   ierr = MPI_Add_error_code(PETSC_MPI_ERROR_CLASS,&PETSC_MPI_ERROR_CODE);CHKERRQ(ierr);
893 
894   /* Done after init due to a bug in MPICH-GM? */
895   ierr = PetscErrorPrintfInitialize();CHKERRQ(ierr);
896 
897   ierr = MPI_Comm_rank(MPI_COMM_WORLD,&PetscGlobalRank);CHKERRQ(ierr);
898   ierr = MPI_Comm_size(MPI_COMM_WORLD,&PetscGlobalSize);CHKERRQ(ierr);
899 
900   MPIU_BOOL = MPI_INT;
901   MPIU_ENUM = MPI_INT;
902   MPIU_FORTRANADDR = (sizeof(void*) == sizeof(int)) ? MPI_INT : MPIU_INT64;
903   if (sizeof(size_t) == sizeof(unsigned)) MPIU_SIZE_T = MPI_UNSIGNED;
904   else if (sizeof(size_t) == sizeof(unsigned long)) MPIU_SIZE_T = MPI_UNSIGNED_LONG;
905 #if defined(PETSC_SIZEOF_LONG_LONG)
906   else if (sizeof(size_t) == sizeof(unsigned long long)) MPIU_SIZE_T = MPI_UNSIGNED_LONG_LONG;
907 #endif
908   else {(*PetscErrorPrintf)("PetscInitialize: Could not find MPI type for size_t\n"); return PETSC_ERR_SUP_SYS;}
909 
910   /*
911      Initialized the global complex variable; this is because with
912      shared libraries the constructors for global variables
913      are not called; at least on IRIX.
914   */
915 #if defined(PETSC_HAVE_COMPLEX)
916   {
917 #if defined(PETSC_CLANGUAGE_CXX) && !defined(PETSC_USE_REAL___FLOAT128)
918     PetscComplex ic(0.0,1.0);
919     PETSC_i = ic;
920 #else
921     PETSC_i = _Complex_I;
922 #endif
923   }
924 
925 #if !defined(PETSC_HAVE_MPI_C_DOUBLE_COMPLEX)
926   ierr = MPI_Type_contiguous(2,MPI_DOUBLE,&MPIU_C_DOUBLE_COMPLEX);CHKERRQ(ierr);
927   ierr = MPI_Type_commit(&MPIU_C_DOUBLE_COMPLEX);CHKERRQ(ierr);
928   ierr = MPI_Type_contiguous(2,MPI_FLOAT,&MPIU_C_COMPLEX);CHKERRQ(ierr);
929   ierr = MPI_Type_commit(&MPIU_C_COMPLEX);CHKERRQ(ierr);
930 #endif
931 #endif /* PETSC_HAVE_COMPLEX */
932 
933   /*
934      Create the PETSc MPI reduction operator that sums of the first
935      half of the entries and maxes the second half.
936   */
937   ierr = MPI_Op_create(MPIU_MaxSum_Local,1,&MPIU_MAXSUM_OP);CHKERRQ(ierr);
938 
939 #if defined(PETSC_USE_REAL___FLOAT128)
940   ierr = MPI_Type_contiguous(2,MPI_DOUBLE,&MPIU___FLOAT128);CHKERRQ(ierr);
941   ierr = MPI_Type_commit(&MPIU___FLOAT128);CHKERRQ(ierr);
942 #if defined(PETSC_HAVE_COMPLEX)
943   ierr = MPI_Type_contiguous(4,MPI_DOUBLE,&MPIU___COMPLEX128);CHKERRQ(ierr);
944   ierr = MPI_Type_commit(&MPIU___COMPLEX128);CHKERRQ(ierr);
945 #endif
946   ierr = MPI_Op_create(PetscMax_Local,1,&MPIU_MAX);CHKERRQ(ierr);
947   ierr = MPI_Op_create(PetscMin_Local,1,&MPIU_MIN);CHKERRQ(ierr);
948 #elif defined(PETSC_USE_REAL___FP16)
949   ierr = MPI_Type_contiguous(2,MPI_CHAR,&MPIU___FP16);CHKERRQ(ierr);
950   ierr = MPI_Type_commit(&MPIU___FP16);CHKERRQ(ierr);
951   ierr = MPI_Op_create(PetscMax_Local,1,&MPIU_MAX);CHKERRQ(ierr);
952   ierr = MPI_Op_create(PetscMin_Local,1,&MPIU_MIN);CHKERRQ(ierr);
953 #endif
954 
955 #if (defined(PETSC_HAVE_COMPLEX) && !defined(PETSC_HAVE_MPI_C_DOUBLE_COMPLEX)) || defined(PETSC_USE_REAL___FLOAT128) || defined(PETSC_USE_REAL___FP16)
956   ierr = MPI_Op_create(PetscSum_Local,1,&MPIU_SUM);CHKERRQ(ierr);
957 #endif
958 
959   ierr = MPI_Type_contiguous(2,MPIU_SCALAR,&MPIU_2SCALAR);CHKERRQ(ierr);
960   ierr = MPI_Type_commit(&MPIU_2SCALAR);CHKERRQ(ierr);
961 
962 #if defined(PETSC_USE_64BIT_INDICES)
963   ierr = MPI_Type_contiguous(2,MPIU_INT,&MPIU_2INT);CHKERRQ(ierr);
964   ierr = MPI_Type_commit(&MPIU_2INT);CHKERRQ(ierr);
965 #endif
966 
967 
968   /*
969      Attributes to be set on PETSc communicators
970   */
971   ierr = MPI_Comm_create_keyval(MPI_COMM_NULL_COPY_FN,Petsc_DelCounter,&Petsc_Counter_keyval,(void*)0);CHKERRQ(ierr);
972   ierr = MPI_Comm_create_keyval(MPI_COMM_NULL_COPY_FN,Petsc_DelComm_Outer,&Petsc_InnerComm_keyval,(void*)0);CHKERRQ(ierr);
973   ierr = MPI_Comm_create_keyval(MPI_COMM_NULL_COPY_FN,Petsc_DelComm_Inner,&Petsc_OuterComm_keyval,(void*)0);CHKERRQ(ierr);
974   ierr = MPI_Comm_create_keyval(MPI_COMM_NULL_COPY_FN,Petsc_DelComm_Shm,&Petsc_ShmComm_keyval,(void*)0);CHKERRQ(ierr);
975 
976   /*
977      Build the options database
978   */
979   ierr = PetscOptionsInsert(NULL,argc,args,file);CHKERRQ(ierr);
980 
981   /* call a second time so it can look in the options database */
982   ierr = PetscErrorPrintfInitialize();CHKERRQ(ierr);
983 
984   /*
985      Print main application help message
986   */
987   ierr = PetscOptionsHasHelp(NULL,&flg);CHKERRQ(ierr);
988   if (help && flg) {
989     ierr = PetscPrintf(PETSC_COMM_WORLD,help);CHKERRQ(ierr);
990   }
991   ierr = PetscOptionsCheckInitial_Private();CHKERRQ(ierr);
992 
993   ierr = PetscCitationsInitialize();CHKERRQ(ierr);
994 
995 #if defined(PETSC_HAVE_SAWS)
996   ierr = PetscInitializeSAWs(help);CHKERRQ(ierr);
997 #endif
998 
999   /* Creates the logging data structures; this is enabled even if logging is not turned on */
1000 #if defined(PETSC_USE_LOG)
1001   ierr = PetscLogInitialize();CHKERRQ(ierr);
1002 #endif
1003 
1004   /*
1005      Load the dynamic libraries (on machines that support them), this registers all
1006      the solvers etc. (On non-dynamic machines this initializes the PetscDraw and PetscViewer classes)
1007   */
1008   ierr = PetscInitialize_DynamicLibraries();CHKERRQ(ierr);
1009 
1010   ierr = MPI_Comm_size(PETSC_COMM_WORLD,&size);CHKERRQ(ierr);
1011   ierr = PetscInfo1(0,"PETSc successfully started: number of processors = %d\n",size);CHKERRQ(ierr);
1012   ierr = PetscGetHostName(hostname,256);CHKERRQ(ierr);
1013   ierr = PetscInfo1(0,"Running on machine: %s\n",hostname);CHKERRQ(ierr);
1014 
1015   ierr = PetscOptionsCheckInitial_Components();CHKERRQ(ierr);
1016   /* Check the options database for options related to the options database itself */
1017   ierr = PetscOptionsSetFromOptions(NULL);CHKERRQ(ierr);
1018 
1019 #if defined(PETSC_USE_PETSC_MPI_EXTERNAL32)
1020   /*
1021       Tell MPI about our own data representation converter, this would/should be used if extern32 is not supported by the MPI
1022 
1023       Currently not used because it is not supported by MPICH.
1024   */
1025   if (!PetscBinaryBigEndian()) {
1026     ierr = MPI_Register_datarep((char*)"petsc",PetscDataRep_read_conv_fn,PetscDataRep_write_conv_fn,PetscDataRep_extent_fn,NULL);CHKERRQ(ierr);
1027   }
1028 #endif
1029 
1030   /*
1031       Setup building of stack frames for all function calls
1032   */
1033 #if defined(PETSC_USE_DEBUG) && !defined(PETSC_HAVE_THREADSAFETY)
1034   ierr = PetscStackCreate();CHKERRQ(ierr);
1035 #endif
1036 
1037 #if defined(PETSC_SERIALIZE_FUNCTIONS)
1038   ierr = PetscFPTCreate(10000);CHKERRQ(ierr);
1039 #endif
1040 
1041 #if defined(PETSC_HAVE_HWLOC)
1042   {
1043     PetscViewer viewer;
1044     ierr = PetscOptionsGetViewer(PETSC_COMM_WORLD,NULL,NULL,"-process_view",&viewer,NULL,&flg);CHKERRQ(ierr);
1045     if (flg) {
1046       ierr = PetscProcessPlacementView(viewer);CHKERRQ(ierr);
1047       ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr);
1048     }
1049   }
1050 #endif
1051 
1052   flg = PETSC_TRUE;
1053   ierr = PetscOptionsGetBool(NULL,NULL,"-viewfromoptions",&flg,NULL);CHKERRQ(ierr);
1054   if (!flg) {ierr = PetscOptionsPushGetViewerOff(PETSC_TRUE); CHKERRQ(ierr);}
1055 
1056 #if defined(PETSC_HAVE_ADIOS)
1057   ierr = adios_init_noxml(PETSC_COMM_WORLD);CHKERRQ(ierr);
1058   ierr = adios_declare_group(&Petsc_adios_group,"PETSc","",adios_stat_default);CHKERRQ(ierr);
1059   ierr = adios_select_method(Petsc_adios_group,"MPI","","");CHKERRQ(ierr);
1060   ierr = adios_read_init_method(ADIOS_READ_METHOD_BP,PETSC_COMM_WORLD,"");CHKERRQ(ierr);
1061 #endif
1062 #if defined(PETSC_HAVE_ADIOS2)
1063 #endif
1064 
1065   /*
1066       Once we are completedly initialized then we can set this variables
1067   */
1068   PetscInitializeCalled = PETSC_TRUE;
1069 
1070   ierr = PetscOptionsHasName(NULL,NULL,"-python",&flg);CHKERRQ(ierr);
1071   if (flg) {ierr = PetscPythonInitialize(NULL,NULL);CHKERRQ(ierr);}
1072   PetscFunctionReturn(0);
1073 }
1074 
1075 #if defined(PETSC_USE_LOG)
1076 PETSC_INTERN PetscObject *PetscObjects;
1077 PETSC_INTERN PetscInt    PetscObjectsCounts;
1078 PETSC_INTERN PetscInt    PetscObjectsMaxCounts;
1079 PETSC_INTERN PetscBool   PetscObjectsLog;
1080 #endif
1081 
1082 /*
1083     Frees all the MPI types and operations that PETSc may have created
1084 */
1085 PetscErrorCode  PetscFreeMPIResources(void)
1086 {
1087   PetscErrorCode ierr;
1088 
1089   PetscFunctionBegin;
1090 #if defined(PETSC_USE_REAL___FLOAT128)
1091   ierr = MPI_Type_free(&MPIU___FLOAT128);CHKERRQ(ierr);
1092 #if defined(PETSC_HAVE_COMPLEX)
1093   ierr = MPI_Type_free(&MPIU___COMPLEX128);CHKERRQ(ierr);
1094 #endif
1095   ierr = MPI_Op_free(&MPIU_MAX);CHKERRQ(ierr);
1096   ierr = MPI_Op_free(&MPIU_MIN);CHKERRQ(ierr);
1097 #elif defined(PETSC_USE_REAL___FP16)
1098   ierr = MPI_Type_free(&MPIU___FP16);CHKERRQ(ierr);
1099   ierr = MPI_Op_free(&MPIU_MAX);CHKERRQ(ierr);
1100   ierr = MPI_Op_free(&MPIU_MIN);CHKERRQ(ierr);
1101 #endif
1102 
1103 #if defined(PETSC_HAVE_COMPLEX)
1104 #if !defined(PETSC_HAVE_MPI_C_DOUBLE_COMPLEX)
1105   ierr = MPI_Type_free(&MPIU_C_DOUBLE_COMPLEX);CHKERRQ(ierr);
1106   ierr = MPI_Type_free(&MPIU_C_COMPLEX);CHKERRQ(ierr);
1107 #endif
1108 #endif
1109 
1110 #if (defined(PETSC_HAVE_COMPLEX) && !defined(PETSC_HAVE_MPI_C_DOUBLE_COMPLEX)) || defined(PETSC_USE_REAL___FLOAT128) || defined(PETSC_USE_REAL___FP16)
1111   ierr = MPI_Op_free(&MPIU_SUM);CHKERRQ(ierr);
1112 #endif
1113 
1114   ierr = MPI_Type_free(&MPIU_2SCALAR);CHKERRQ(ierr);
1115 #if defined(PETSC_USE_64BIT_INDICES)
1116   ierr = MPI_Type_free(&MPIU_2INT);CHKERRQ(ierr);
1117 #endif
1118   ierr = MPI_Op_free(&MPIU_MAXSUM_OP);CHKERRQ(ierr);
1119   PetscFunctionReturn(0);
1120 }
1121 
1122 /*@C
1123    PetscFinalize - Checks for options to be called at the conclusion
1124    of the program. MPI_Finalize() is called only if the user had not
1125    called MPI_Init() before calling PetscInitialize().
1126 
1127    Collective on PETSC_COMM_WORLD
1128 
1129    Options Database Keys:
1130 +  -options_view - Calls PetscOptionsView()
1131 .  -options_left - Prints unused options that remain in the database
1132 .  -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
1133 .  -mpidump - Calls PetscMPIDump()
1134 .  -malloc_dump - Calls PetscMallocDump()
1135 .  -malloc_info - Prints total memory usage
1136 -  -malloc_log - Prints summary of memory usage
1137 
1138    Level: beginner
1139 
1140    Note:
1141    See PetscInitialize() for more general runtime options.
1142 
1143 .seealso: PetscInitialize(), PetscOptionsView(), PetscMallocDump(), PetscMPIDump(), PetscEnd()
1144 @*/
1145 PetscErrorCode  PetscFinalize(void)
1146 {
1147   PetscErrorCode ierr;
1148   PetscMPIInt    rank;
1149   PetscInt       nopt;
1150   PetscBool      flg1 = PETSC_FALSE,flg2 = PETSC_FALSE,flg3 = PETSC_FALSE;
1151   PetscBool      flg;
1152 #if defined(PETSC_USE_LOG)
1153   char           mname[PETSC_MAX_PATH_LEN];
1154 #endif
1155 
1156   if (!PetscInitializeCalled) {
1157     printf("PetscInitialize() must be called before PetscFinalize()\n");
1158     return(PETSC_ERR_ARG_WRONGSTATE);
1159   }
1160   PetscFunctionBegin;
1161   ierr = PetscInfo(NULL,"PetscFinalize() called\n");CHKERRQ(ierr);
1162 
1163   ierr = MPI_Comm_rank(PETSC_COMM_WORLD,&rank);CHKERRQ(ierr);
1164 #if defined(PETSC_HAVE_ADIOS)
1165   ierr = adios_read_finalize_method(ADIOS_READ_METHOD_BP_AGGREGATE);CHKERRQ(ierr);
1166   ierr = adios_finalize(rank);CHKERRQ(ierr);
1167 #endif
1168 #if defined(PETSC_HAVE_ADIOS2)
1169 #endif
1170   ierr = PetscOptionsHasName(NULL,NULL,"-citations",&flg);CHKERRQ(ierr);
1171   if (flg) {
1172     char  *cits, filename[PETSC_MAX_PATH_LEN];
1173     FILE  *fd = PETSC_STDOUT;
1174 
1175     ierr = PetscOptionsGetString(NULL,NULL,"-citations",filename,PETSC_MAX_PATH_LEN,NULL);CHKERRQ(ierr);
1176     if (filename[0]) {
1177       ierr = PetscFOpen(PETSC_COMM_WORLD,filename,"w",&fd);CHKERRQ(ierr);
1178     }
1179     ierr = PetscSegBufferGet(PetscCitationsList,1,&cits);CHKERRQ(ierr);
1180     cits[0] = 0;
1181     ierr = PetscSegBufferExtractAlloc(PetscCitationsList,&cits);CHKERRQ(ierr);
1182     ierr = PetscFPrintf(PETSC_COMM_WORLD,fd,"If you publish results based on this computation please cite the following:\n");CHKERRQ(ierr);
1183     ierr = PetscFPrintf(PETSC_COMM_WORLD,fd,"===========================================================================\n");CHKERRQ(ierr);
1184     ierr = PetscFPrintf(PETSC_COMM_WORLD,fd,"%s",cits);CHKERRQ(ierr);
1185     ierr = PetscFPrintf(PETSC_COMM_WORLD,fd,"===========================================================================\n");CHKERRQ(ierr);
1186     ierr = PetscFClose(PETSC_COMM_WORLD,fd);CHKERRQ(ierr);
1187     ierr = PetscFree(cits);CHKERRQ(ierr);
1188   }
1189   ierr = PetscSegBufferDestroy(&PetscCitationsList);CHKERRQ(ierr);
1190 
1191 #if defined(PETSC_HAVE_SSL) && defined(PETSC_USE_SOCKET_VIEWER)
1192   /* TextBelt is run for testing purposes only, please do not use this feature often */
1193   {
1194     PetscInt nmax = 2;
1195     char     **buffs;
1196     ierr = PetscMalloc1(2,&buffs);CHKERRQ(ierr);
1197     ierr = PetscOptionsGetStringArray(NULL,NULL,"-textbelt",buffs,&nmax,&flg1);CHKERRQ(ierr);
1198     if (flg1) {
1199       if (!nmax) SETERRQ(PETSC_COMM_WORLD,PETSC_ERR_USER,"-textbelt requires either the phone number or number,\"message\"");
1200       if (nmax == 1) {
1201         ierr = PetscMalloc1(128,&buffs[1]);CHKERRQ(ierr);
1202         ierr = PetscGetProgramName(buffs[1],32);CHKERRQ(ierr);
1203         ierr = PetscStrcat(buffs[1]," has completed");CHKERRQ(ierr);
1204       }
1205       ierr = PetscTextBelt(PETSC_COMM_WORLD,buffs[0],buffs[1],NULL);CHKERRQ(ierr);
1206       ierr = PetscFree(buffs[0]);CHKERRQ(ierr);
1207       ierr = PetscFree(buffs[1]);CHKERRQ(ierr);
1208     }
1209     ierr = PetscFree(buffs);CHKERRQ(ierr);
1210   }
1211   {
1212     PetscInt nmax = 2;
1213     char     **buffs;
1214     ierr = PetscMalloc1(2,&buffs);CHKERRQ(ierr);
1215     ierr = PetscOptionsGetStringArray(NULL,NULL,"-tellmycell",buffs,&nmax,&flg1);CHKERRQ(ierr);
1216     if (flg1) {
1217       if (!nmax) SETERRQ(PETSC_COMM_WORLD,PETSC_ERR_USER,"-tellmycell requires either the phone number or number,\"message\"");
1218       if (nmax == 1) {
1219         ierr = PetscMalloc1(128,&buffs[1]);CHKERRQ(ierr);
1220         ierr = PetscGetProgramName(buffs[1],32);CHKERRQ(ierr);
1221         ierr = PetscStrcat(buffs[1]," has completed");CHKERRQ(ierr);
1222       }
1223       ierr = PetscTellMyCell(PETSC_COMM_WORLD,buffs[0],buffs[1],NULL);CHKERRQ(ierr);
1224       ierr = PetscFree(buffs[0]);CHKERRQ(ierr);
1225       ierr = PetscFree(buffs[1]);CHKERRQ(ierr);
1226     }
1227     ierr = PetscFree(buffs);CHKERRQ(ierr);
1228   }
1229 #endif
1230   /*
1231     It should be safe to cancel the options monitors, since we don't expect to be setting options
1232     here (at least that are worth monitoring).  Monitors ought to be released so that they release
1233     whatever memory was allocated there before -malloc_dump reports unfreed memory.
1234   */
1235   ierr = PetscOptionsMonitorCancel();CHKERRQ(ierr);
1236 
1237 #if defined(PETSC_SERIALIZE_FUNCTIONS)
1238   ierr = PetscFPTDestroy();CHKERRQ(ierr);
1239 #endif
1240 
1241 
1242 #if defined(PETSC_HAVE_SAWS)
1243   flg = PETSC_FALSE;
1244   ierr = PetscOptionsGetBool(NULL,NULL,"-saw_options",&flg,NULL);CHKERRQ(ierr);
1245   if (flg) {
1246     ierr = PetscOptionsSAWsDestroy();CHKERRQ(ierr);
1247   }
1248 #endif
1249 
1250 #if defined(PETSC_HAVE_X)
1251   flg1 = PETSC_FALSE;
1252   ierr = PetscOptionsGetBool(NULL,NULL,"-x_virtual",&flg1,NULL);CHKERRQ(ierr);
1253   if (flg1) {
1254     /*  this is a crude hack, but better than nothing */
1255     ierr = PetscPOpen(PETSC_COMM_WORLD,NULL,"pkill -9 Xvfb","r",NULL);CHKERRQ(ierr);
1256   }
1257 #endif
1258 
1259 #if !defined(PETSC_HAVE_THREADSAFETY)
1260   ierr = PetscOptionsGetBool(NULL,NULL,"-malloc_info",&flg2,NULL);CHKERRQ(ierr);
1261   if (!flg2) {
1262     flg2 = PETSC_FALSE;
1263     ierr = PetscOptionsGetBool(NULL,NULL,"-memory_view",&flg2,NULL);CHKERRQ(ierr);
1264   }
1265   if (flg2) {
1266     ierr = PetscMemoryView(PETSC_VIEWER_STDOUT_WORLD,"Summary of Memory Usage in PETSc\n");CHKERRQ(ierr);
1267   }
1268 #endif
1269 
1270 #if defined(PETSC_USE_LOG)
1271   flg1 = PETSC_FALSE;
1272   ierr = PetscOptionsGetBool(NULL,NULL,"-get_total_flops",&flg1,NULL);CHKERRQ(ierr);
1273   if (flg1) {
1274     PetscLogDouble flops = 0;
1275     ierr = MPI_Reduce(&petsc_TotalFlops,&flops,1,MPI_DOUBLE,MPI_SUM,0,PETSC_COMM_WORLD);CHKERRQ(ierr);
1276     ierr = PetscPrintf(PETSC_COMM_WORLD,"Total flops over all processors %g\n",flops);CHKERRQ(ierr);
1277   }
1278 #endif
1279 
1280 
1281 #if defined(PETSC_USE_LOG)
1282 #if defined(PETSC_HAVE_MPE)
1283   mname[0] = 0;
1284   ierr = PetscOptionsGetString(NULL,NULL,"-log_mpe",mname,PETSC_MAX_PATH_LEN,&flg1);CHKERRQ(ierr);
1285   if (flg1) {
1286     if (mname[0]) {ierr = PetscLogMPEDump(mname);CHKERRQ(ierr);}
1287     else          {ierr = PetscLogMPEDump(0);CHKERRQ(ierr);}
1288   }
1289 #endif
1290 #endif
1291 
1292   /*
1293      Free all objects registered with PetscObjectRegisterDestroy() such as PETSC_VIEWER_XXX_().
1294   */
1295   ierr = PetscObjectRegisterDestroyAll();CHKERRQ(ierr);
1296 
1297 #if defined(PETSC_USE_LOG)
1298   ierr = PetscOptionsPushGetViewerOff(PETSC_FALSE);CHKERRQ(ierr);
1299   ierr = PetscLogViewFromOptions();CHKERRQ(ierr);
1300   ierr = PetscOptionsPopGetViewerOff();CHKERRQ(ierr);
1301 
1302   mname[0] = 0;
1303   ierr = PetscOptionsGetString(NULL,NULL,"-log_summary",mname,PETSC_MAX_PATH_LEN,&flg1);CHKERRQ(ierr);
1304   if (flg1) {
1305     PetscViewer viewer;
1306     ierr = (*PetscHelpPrintf)(PETSC_COMM_WORLD,"\n\n WARNING:   -log_summary is being deprecated; switch to -log_view\n\n\n");CHKERRQ(ierr);
1307     if (mname[0]) {
1308       ierr = PetscViewerASCIIOpen(PETSC_COMM_WORLD,mname,&viewer);CHKERRQ(ierr);
1309       ierr = PetscLogView(viewer);CHKERRQ(ierr);
1310       ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr);
1311     } else {
1312       viewer = PETSC_VIEWER_STDOUT_WORLD;
1313       ierr   = PetscViewerPushFormat(viewer,PETSC_VIEWER_DEFAULT);CHKERRQ(ierr);
1314       ierr   = PetscLogView(viewer);CHKERRQ(ierr);
1315       ierr   = PetscViewerPopFormat(viewer);CHKERRQ(ierr);
1316     }
1317   }
1318 
1319   /*
1320      Free any objects created by the last block of code.
1321   */
1322   ierr = PetscObjectRegisterDestroyAll();CHKERRQ(ierr);
1323 
1324   mname[0] = 0;
1325   ierr = PetscOptionsGetString(NULL,NULL,"-log_all",mname,PETSC_MAX_PATH_LEN,&flg1);CHKERRQ(ierr);
1326   ierr = PetscOptionsGetString(NULL,NULL,"-log",mname,PETSC_MAX_PATH_LEN,&flg2);CHKERRQ(ierr);
1327   if (flg1 || flg2) {ierr = PetscLogDump(mname);CHKERRQ(ierr);}
1328 #endif
1329 
1330   ierr = PetscStackDestroy();CHKERRQ(ierr);
1331 
1332   flg1 = PETSC_FALSE;
1333   ierr = PetscOptionsGetBool(NULL,NULL,"-no_signal_handler",&flg1,NULL);CHKERRQ(ierr);
1334   if (!flg1) { ierr = PetscPopSignalHandler();CHKERRQ(ierr);}
1335   flg1 = PETSC_FALSE;
1336   ierr = PetscOptionsGetBool(NULL,NULL,"-mpidump",&flg1,NULL);CHKERRQ(ierr);
1337   if (flg1) {
1338     ierr = PetscMPIDump(stdout);CHKERRQ(ierr);
1339   }
1340   flg1 = PETSC_FALSE;
1341   flg2 = PETSC_FALSE;
1342   /* preemptive call to avoid listing this option in options table as unused */
1343   ierr = PetscOptionsHasName(NULL,NULL,"-malloc_dump",&flg1);CHKERRQ(ierr);
1344   ierr = PetscOptionsHasName(NULL,NULL,"-objects_dump",&flg1);CHKERRQ(ierr);
1345   ierr = PetscOptionsGetBool(NULL,NULL,"-options_view",&flg2,NULL);CHKERRQ(ierr);
1346 
1347   if (flg2) {
1348     PetscViewer viewer;
1349     ierr = PetscViewerCreate(PETSC_COMM_WORLD,&viewer);CHKERRQ(ierr);
1350     ierr = PetscViewerSetType(viewer,PETSCVIEWERASCII);CHKERRQ(ierr);
1351     ierr = PetscOptionsView(NULL,viewer);CHKERRQ(ierr);
1352     ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr);
1353   }
1354 
1355   /* to prevent PETSc -options_left from warning */
1356   ierr = PetscOptionsHasName(NULL,NULL,"-nox",&flg1);CHKERRQ(ierr);
1357   ierr = PetscOptionsHasName(NULL,NULL,"-nox_warning",&flg1);CHKERRQ(ierr);
1358 
1359   flg3 = PETSC_FALSE; /* default value is required */
1360   ierr = PetscOptionsGetBool(NULL,NULL,"-options_left",&flg3,&flg1);CHKERRQ(ierr);
1361   ierr = PetscOptionsAllUsed(NULL,&nopt);CHKERRQ(ierr);
1362   if (flg3) {
1363     if (!flg2) { /* have not yet printed the options */
1364       PetscViewer viewer;
1365       ierr = PetscViewerCreate(PETSC_COMM_WORLD,&viewer);CHKERRQ(ierr);
1366       ierr = PetscViewerSetType(viewer,PETSCVIEWERASCII);CHKERRQ(ierr);
1367       ierr = PetscOptionsView(NULL,viewer);CHKERRQ(ierr);
1368       ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr);
1369     }
1370     if (!nopt) {
1371       ierr = PetscPrintf(PETSC_COMM_WORLD,"There are no unused options.\n");CHKERRQ(ierr);
1372     } else if (nopt == 1) {
1373       ierr = PetscPrintf(PETSC_COMM_WORLD,"There is one unused database option. It is:\n");CHKERRQ(ierr);
1374     } else {
1375       ierr = PetscPrintf(PETSC_COMM_WORLD,"There are %D unused database options. They are:\n",nopt);CHKERRQ(ierr);
1376     }
1377   }
1378 #if defined(PETSC_USE_DEBUG)
1379   if (nopt && !flg3 && !flg1) {
1380     ierr = PetscPrintf(PETSC_COMM_WORLD,"WARNING! There are options you set that were not used!\n");CHKERRQ(ierr);
1381     ierr = PetscPrintf(PETSC_COMM_WORLD,"WARNING! could be spelling mistake, etc!\n");CHKERRQ(ierr);
1382     ierr = PetscOptionsLeft(NULL);CHKERRQ(ierr);
1383   } else if (nopt && flg3) {
1384 #else
1385   if (nopt && flg3) {
1386 #endif
1387     ierr = PetscOptionsLeft(NULL);CHKERRQ(ierr);
1388   }
1389 
1390 #if defined(PETSC_HAVE_SAWS)
1391   if (!PetscGlobalRank) {
1392     ierr = PetscStackSAWsViewOff();CHKERRQ(ierr);
1393     PetscStackCallSAWs(SAWs_Finalize,());
1394   }
1395 #endif
1396 
1397 #if defined(PETSC_USE_LOG)
1398   /*
1399        List all objects the user may have forgot to free
1400   */
1401   if (PetscObjectsLog) {
1402     ierr = PetscOptionsHasName(NULL,NULL,"-objects_dump",&flg1);CHKERRQ(ierr);
1403     if (flg1) {
1404       MPI_Comm local_comm;
1405       char     string[64];
1406 
1407       ierr = PetscOptionsGetString(NULL,NULL,"-objects_dump",string,64,NULL);CHKERRQ(ierr);
1408       ierr = MPI_Comm_dup(MPI_COMM_WORLD,&local_comm);CHKERRQ(ierr);
1409       ierr = PetscSequentialPhaseBegin_Private(local_comm,1);CHKERRQ(ierr);
1410       ierr = PetscObjectsDump(stdout,(string[0] == 'a') ? PETSC_TRUE : PETSC_FALSE);CHKERRQ(ierr);
1411       ierr = PetscSequentialPhaseEnd_Private(local_comm,1);CHKERRQ(ierr);
1412       ierr = MPI_Comm_free(&local_comm);CHKERRQ(ierr);
1413     }
1414   }
1415 #endif
1416 
1417 #if defined(PETSC_USE_LOG)
1418   PetscObjectsCounts    = 0;
1419   PetscObjectsMaxCounts = 0;
1420   ierr = PetscFree(PetscObjects);CHKERRQ(ierr);
1421 #endif
1422 
1423   /*
1424      Destroy any packages that registered a finalize
1425   */
1426   ierr = PetscRegisterFinalizeAll();CHKERRQ(ierr);
1427 
1428 #if defined(PETSC_USE_LOG)
1429   ierr = PetscLogFinalize();CHKERRQ(ierr);
1430 #endif
1431 
1432   /*
1433      Print PetscFunctionLists that have not been properly freed
1434 
1435   ierr = PetscFunctionListPrintAll();CHKERRQ(ierr);
1436   */
1437 
1438   if (petsc_history) {
1439     ierr = PetscCloseHistoryFile(&petsc_history);CHKERRQ(ierr);
1440     petsc_history = 0;
1441   }
1442   ierr = PetscOptionsHelpPrintedDestroy(&PetscOptionsHelpPrintedSingleton);CHKERRQ(ierr);
1443 
1444   ierr = PetscInfoAllow(PETSC_FALSE,NULL);CHKERRQ(ierr);
1445 
1446 #if !defined(PETSC_HAVE_THREADSAFETY)
1447   {
1448     char fname[PETSC_MAX_PATH_LEN];
1449     FILE *fd;
1450     int  err;
1451 
1452     fname[0] = 0;
1453 
1454     ierr = PetscOptionsGetString(NULL,NULL,"-malloc_dump",fname,250,&flg1);CHKERRQ(ierr);
1455     flg2 = PETSC_FALSE;
1456     ierr = PetscOptionsGetBool(NULL,NULL,"-malloc_test",&flg2,NULL);CHKERRQ(ierr);
1457 #if defined(PETSC_USE_DEBUG)
1458     if (PETSC_RUNNING_ON_VALGRIND) flg2 = PETSC_FALSE;
1459 #else
1460     flg2 = PETSC_FALSE;         /* Skip reporting for optimized builds regardless of -malloc_test */
1461 #endif
1462     if (flg1 && fname[0]) {
1463       char sname[PETSC_MAX_PATH_LEN];
1464 
1465       PetscSNPrintf(sname,PETSC_MAX_PATH_LEN,"%s_%d",fname,rank);
1466       fd   = fopen(sname,"w"); if (!fd) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_FILE_OPEN,"Cannot open log file: %s",sname);
1467       ierr = PetscMallocDump(fd);CHKERRQ(ierr);
1468       err  = fclose(fd);
1469       if (err) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SYS,"fclose() failed on file");
1470     } else if (flg1 || flg2) {
1471       MPI_Comm local_comm;
1472 
1473       ierr = MPI_Comm_dup(MPI_COMM_WORLD,&local_comm);CHKERRQ(ierr);
1474       ierr = PetscSequentialPhaseBegin_Private(local_comm,1);CHKERRQ(ierr);
1475       ierr = PetscMallocDump(stdout);CHKERRQ(ierr);
1476       ierr = PetscSequentialPhaseEnd_Private(local_comm,1);CHKERRQ(ierr);
1477       ierr = MPI_Comm_free(&local_comm);CHKERRQ(ierr);
1478     }
1479   }
1480 
1481   {
1482     char fname[PETSC_MAX_PATH_LEN];
1483     FILE *fd = NULL;
1484 
1485     fname[0] = 0;
1486 
1487     ierr = PetscOptionsGetString(NULL,NULL,"-malloc_log",fname,250,&flg1);CHKERRQ(ierr);
1488     ierr = PetscOptionsHasName(NULL,NULL,"-malloc_log_threshold",&flg2);CHKERRQ(ierr);
1489     if (flg1 && fname[0]) {
1490       int err;
1491 
1492       if (!rank) {
1493         fd = fopen(fname,"w");
1494         if (!fd) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_FILE_OPEN,"Cannot open log file: %s",fname);
1495       }
1496       ierr = PetscMallocDumpLog(fd);CHKERRQ(ierr);
1497       if (fd) {
1498         err = fclose(fd);
1499         if (err) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SYS,"fclose() failed on file");
1500       }
1501     } else if (flg1 || flg2) {
1502       ierr = PetscMallocDumpLog(stdout);CHKERRQ(ierr);
1503     }
1504   }
1505 #endif
1506 
1507   /*
1508      Close any open dynamic libraries
1509   */
1510   ierr = PetscFinalize_DynamicLibraries();CHKERRQ(ierr);
1511 
1512   /* Can be destroyed only after all the options are used */
1513   ierr = PetscOptionsDestroyDefault();CHKERRQ(ierr);
1514 
1515   PetscGlobalArgc = 0;
1516   PetscGlobalArgs = 0;
1517 
1518   ierr = PetscFreeMPIResources();CHKERRQ(ierr);
1519 
1520   /*
1521      Destroy any known inner MPI_Comm's and attributes pointing to them
1522      Note this will not destroy any new communicators the user has created.
1523 
1524      If all PETSc objects were not destroyed those left over objects will have hanging references to
1525      the MPI_Comms that were freed; but that is ok because those PETSc objects will never be used again
1526  */
1527   {
1528     PetscCommCounter *counter;
1529     PetscMPIInt      flg;
1530     MPI_Comm         icomm;
1531     union {MPI_Comm comm; void *ptr;} ucomm;
1532     ierr = MPI_Comm_get_attr(PETSC_COMM_SELF,Petsc_InnerComm_keyval,&ucomm,&flg);CHKERRQ(ierr);
1533     if (flg) {
1534       icomm = ucomm.comm;
1535       ierr = MPI_Comm_get_attr(icomm,Petsc_Counter_keyval,&counter,&flg);CHKERRQ(ierr);
1536       if (!flg) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_CORRUPT,"Inner MPI_Comm does not have expected tag/name counter, problem with corrupted memory");
1537 
1538       ierr = MPI_Comm_delete_attr(PETSC_COMM_SELF,Petsc_InnerComm_keyval);CHKERRQ(ierr);
1539       ierr = MPI_Comm_delete_attr(icomm,Petsc_Counter_keyval);CHKERRQ(ierr);
1540       ierr = MPI_Comm_free(&icomm);CHKERRQ(ierr);
1541     }
1542     ierr = MPI_Comm_get_attr(PETSC_COMM_WORLD,Petsc_InnerComm_keyval,&ucomm,&flg);CHKERRQ(ierr);
1543     if (flg) {
1544       icomm = ucomm.comm;
1545       ierr = MPI_Comm_get_attr(icomm,Petsc_Counter_keyval,&counter,&flg);CHKERRQ(ierr);
1546       if (!flg) SETERRQ(PETSC_COMM_WORLD,PETSC_ERR_ARG_CORRUPT,"Inner MPI_Comm does not have expected tag/name counter, problem with corrupted memory");
1547 
1548       ierr = MPI_Comm_delete_attr(PETSC_COMM_WORLD,Petsc_InnerComm_keyval);CHKERRQ(ierr);
1549       ierr = MPI_Comm_delete_attr(icomm,Petsc_Counter_keyval);CHKERRQ(ierr);
1550       ierr = MPI_Comm_free(&icomm);CHKERRQ(ierr);
1551     }
1552   }
1553 
1554   ierr = MPI_Comm_free_keyval(&Petsc_Counter_keyval);CHKERRQ(ierr);
1555   ierr = MPI_Comm_free_keyval(&Petsc_InnerComm_keyval);CHKERRQ(ierr);
1556   ierr = MPI_Comm_free_keyval(&Petsc_OuterComm_keyval);CHKERRQ(ierr);
1557   ierr = MPI_Comm_free_keyval(&Petsc_ShmComm_keyval);CHKERRQ(ierr);
1558 
1559   ierr = PetscSpinlockDestroy(&PetscViewerASCIISpinLockOpen);CHKERRQ(ierr);
1560   ierr = PetscSpinlockDestroy(&PetscViewerASCIISpinLockStdout);CHKERRQ(ierr);
1561   ierr = PetscSpinlockDestroy(&PetscViewerASCIISpinLockStderr);CHKERRQ(ierr);
1562   ierr = PetscSpinlockDestroy(&PetscCommSpinLock);CHKERRQ(ierr);
1563 
1564   if (PetscBeganMPI) {
1565 #if defined(PETSC_HAVE_MPI_FINALIZED)
1566     PetscMPIInt flag;
1567     ierr = MPI_Finalized(&flag);CHKERRQ(ierr);
1568     if (flag) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_LIB,"MPI_Finalize() has already been called, even though MPI_Init() was called by PetscInitialize()");
1569 #endif
1570     ierr = MPI_Finalize();CHKERRQ(ierr);
1571   }
1572 /*
1573 
1574      Note: In certain cases PETSC_COMM_WORLD is never MPI_Comm_free()ed because
1575    the communicator has some outstanding requests on it. Specifically if the
1576    flag PETSC_HAVE_BROKEN_REQUEST_FREE is set (for IBM MPI implementation). See
1577    src/vec/utils/vpscat.c. Due to this the memory allocated in PetscCommDuplicate()
1578    is never freed as it should be. Thus one may obtain messages of the form
1579    [ 1] 8 bytes PetscCommDuplicate() line 645 in src/sys/mpiu.c indicating the
1580    memory was not freed.
1581 
1582 */
1583   ierr = PetscMallocClear();CHKERRQ(ierr);
1584 
1585   PetscInitializeCalled = PETSC_FALSE;
1586   PetscFinalizeCalled   = PETSC_TRUE;
1587   PetscFunctionReturn(0);
1588 }
1589 
1590 #if defined(PETSC_MISSING_LAPACK_lsame_)
1591 PETSC_EXTERN int lsame_(char *a,char *b)
1592 {
1593   if (*a == *b) return 1;
1594   if (*a + 32 == *b) return 1;
1595   if (*a - 32 == *b) return 1;
1596   return 0;
1597 }
1598 #endif
1599 
1600 #if defined(PETSC_MISSING_LAPACK_lsame)
1601 PETSC_EXTERN int lsame(char *a,char *b)
1602 {
1603   if (*a == *b) return 1;
1604   if (*a + 32 == *b) return 1;
1605   if (*a - 32 == *b) return 1;
1606   return 0;
1607 }
1608 #endif
1609