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