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