xref: /petsc/src/sys/objects/pinit.c (revision d50831c44aeb795bfe318cd7aecdd61216e9ac7c)
1 
2 /*
3    This file defines the initialization of PETSc, including PetscInitialize()
4 */
5 #define PETSC_DESIRE_COMPLEX
6 #include <petsc-private/petscimpl.h>        /*I  "petscsys.h"   I*/
7 #include <petscviewer.h>
8 
9 #if defined(PETSC_HAVE_CUDA)
10 #include <cublas.h>
11 #endif
12 
13 #include <petscthreadcomm.h>
14 
15 #if defined(PETSC_USE_LOG)
16 extern PetscErrorCode PetscLogBegin_Private(void);
17 #endif
18 extern PetscBool PetscHMPIWorker;
19 
20 #if defined(PETSC_SERIALIZE_FUNCTIONS)
21 PetscFPT PetscFPTData = 0;
22 #endif
23 
24 #if defined(PETSC_HAVE_SAWS)
25 #include <petscviewersaws.h>
26 #endif
27 /* -----------------------------------------------------------------------------------------*/
28 
29 extern FILE *petsc_history;
30 
31 extern PetscErrorCode PetscInitialize_DynamicLibraries(void);
32 extern PetscErrorCode PetscFinalize_DynamicLibraries(void);
33 extern PetscErrorCode PetscFunctionListPrintAll(void);
34 extern PetscErrorCode PetscSequentialPhaseBegin_Private(MPI_Comm,int);
35 extern PetscErrorCode PetscSequentialPhaseEnd_Private(MPI_Comm,int);
36 extern PetscErrorCode PetscCloseHistoryFile(FILE**);
37 
38 /* user may set this BEFORE calling PetscInitialize() */
39 MPI_Comm PETSC_COMM_WORLD = MPI_COMM_NULL;
40 
41 PetscMPIInt Petsc_Counter_keyval   = MPI_KEYVAL_INVALID;
42 PetscMPIInt Petsc_InnerComm_keyval = MPI_KEYVAL_INVALID;
43 PetscMPIInt Petsc_OuterComm_keyval = MPI_KEYVAL_INVALID;
44 
45 /*
46      Declare and set all the string names of the PETSc enums
47 */
48 const char *const PetscBools[]     = {"FALSE","TRUE","PetscBool","PETSC_",0};
49 const char *const PetscCopyModes[] = {"COPY_VALUES","OWN_POINTER","USE_POINTER","PetscCopyMode","PETSC_",0};
50 const char *const PetscDataTypes[] = {"INT","DOUBLE","COMPLEX","LONG","SHORT","FLOAT",
51                                       "CHAR","LOGICAL","ENUM","BOOL","LONGDOUBLE","OBJECT","FUNCTION","PetscDataType","PETSC_",0};
52 
53 PetscBool PetscPreLoadingUsed = PETSC_FALSE;
54 PetscBool PetscPreLoadingOn   = PETSC_FALSE;
55 
56 /*
57        Checks the options database for initializations related to the
58     PETSc components
59 */
60 #undef __FUNCT__
61 #define __FUNCT__ "PetscOptionsCheckInitial_Components"
62 PetscErrorCode  PetscOptionsCheckInitial_Components(void)
63 {
64   PetscBool      flg1;
65   PetscErrorCode ierr;
66 
67   PetscFunctionBegin;
68   ierr = PetscOptionsHasName(NULL,"-help",&flg1);CHKERRQ(ierr);
69   if (flg1) {
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_summary_exclude: <vec,mat,pc.ksp,snes>\n");CHKERRQ(ierr);
74     ierr = (*PetscHelpPrintf)(comm," -info_exclude: <null,vec,mat,pc,ksp,snes,ts>\n");CHKERRQ(ierr);
75     ierr = (*PetscHelpPrintf)(comm,"-----------------------------------------------\n");CHKERRQ(ierr);
76 #endif
77   }
78   PetscFunctionReturn(0);
79 }
80 
81 #undef __FUNCT__
82 #define __FUNCT__ "PetscInitializeNoPointers"
83 /*
84       PetscInitializeNoPointers - Calls PetscInitialize() from C/C++ without the pointers to argc and args
85 
86    Collective
87 
88    Level: advanced
89 
90     Notes: this is called only by the PETSc MATLAB and Julia interface. Even though it might start MPI it sets the flag to
91      indicate that it did NOT start MPI so that the PetscFinalize() does not end MPI, thus allowing PetscInitialize() to
92      be called multiple times from MATLAB and Julia without the problem of trying to initialize MPI more than once.
93 
94      Turns off PETSc signal handling because that can interact with MATLAB's signal handling causing random crashes.
95 
96 .seealso: PetscInitialize(), PetscInitializeFortran(), PetscInitializeNoArguments()
97 */
98 PetscErrorCode  PetscInitializeNoPointers(int argc,char **args,const char *filename,const char *help)
99 {
100   PetscErrorCode ierr;
101   int            myargc   = argc;
102   char           **myargs = args;
103 
104   PetscFunctionBegin;
105   ierr = PetscInitialize(&myargc,&myargs,filename,help);CHKERRQ(ierr);
106   ierr = PetscPopSignalHandler();CHKERRQ(ierr);
107   PetscBeganMPI = PETSC_FALSE;
108   PetscFunctionReturn(ierr);
109 }
110 
111 #undef __FUNCT__
112 #define __FUNCT__ "PetscGetPETSC_COMM_SELF"
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 #undef __FUNCT__
124 #define __FUNCT__ "PetscInitializeNoArguments"
125 /*@C
126       PetscInitializeNoArguments - Calls PetscInitialize() from C/C++ without
127         the command line arguments.
128 
129    Collective
130 
131    Level: advanced
132 
133 .seealso: PetscInitialize(), PetscInitializeFortran()
134 @*/
135 PetscErrorCode  PetscInitializeNoArguments(void)
136 {
137   PetscErrorCode ierr;
138   int            argc   = 0;
139   char           **args = 0;
140 
141   PetscFunctionBegin;
142   ierr = PetscInitialize(&argc,&args,NULL,NULL);
143   PetscFunctionReturn(ierr);
144 }
145 
146 #undef __FUNCT__
147 #define __FUNCT__ "PetscInitialized"
148 /*@
149       PetscInitialized - Determine whether PETSc is initialized.
150 
151    Level: beginner
152 
153 .seealso: PetscInitialize(), PetscInitializeNoArguments(), PetscInitializeFortran()
154 @*/
155 PetscErrorCode PetscInitialized(PetscBool  *isInitialized)
156 {
157   *isInitialized = PetscInitializeCalled;
158   return 0;
159 }
160 
161 #undef __FUNCT__
162 #define __FUNCT__ "PetscFinalized"
163 /*@
164       PetscFinalized - Determine whether PetscFinalize() has been called yet
165 
166    Level: developer
167 
168 .seealso: PetscInitialize(), PetscInitializeNoArguments(), PetscInitializeFortran()
169 @*/
170 PetscErrorCode  PetscFinalized(PetscBool  *isFinalized)
171 {
172   *isFinalized = PetscFinalizeCalled;
173   return 0;
174 }
175 
176 extern PetscErrorCode PetscOptionsCheckInitial_Private(void);
177 
178 /*
179        This function is the MPI reduction operation used to compute the sum of the
180    first half of the datatype and the max of the second half.
181 */
182 MPI_Op PetscMaxSum_Op = 0;
183 
184 #undef __FUNCT__
185 #define __FUNCT__ "PetscMaxSum_Local"
186 PETSC_EXTERN void MPIAPI PetscMaxSum_Local(void *in,void *out,int *cnt,MPI_Datatype *datatype)
187 {
188   PetscInt *xin = (PetscInt*)in,*xout = (PetscInt*)out,i,count = *cnt;
189 
190   PetscFunctionBegin;
191   if (*datatype != MPIU_2INT) {
192     (*PetscErrorPrintf)("Can only handle MPIU_2INT data types");
193     MPI_Abort(MPI_COMM_WORLD,1);
194   }
195 
196   for (i=0; i<count; i++) {
197     xout[2*i]    = PetscMax(xout[2*i],xin[2*i]);
198     xout[2*i+1] += xin[2*i+1];
199   }
200   PetscFunctionReturnVoid();
201 }
202 
203 /*
204     Returns the max of the first entry owned by this processor and the
205 sum of the second entry.
206 
207     The reason nprocs[2*i] contains lengths nprocs[2*i+1] contains flag of 1 if length is nonzero
208 is so that the PetscMaxSum_Op() can set TWO values, if we passed in only nprocs[i] with lengths
209 there would be no place to store the both needed results.
210 */
211 #undef __FUNCT__
212 #define __FUNCT__ "PetscMaxSum"
213 PetscErrorCode  PetscMaxSum(MPI_Comm comm,const PetscInt nprocs[],PetscInt *max,PetscInt *sum)
214 {
215   PetscMPIInt    size,rank;
216   struct {PetscInt max,sum;} *work;
217   PetscErrorCode ierr;
218 
219   PetscFunctionBegin;
220   ierr = MPI_Comm_size(comm,&size);CHKERRQ(ierr);
221   ierr = MPI_Comm_rank(comm,&rank);CHKERRQ(ierr);
222   ierr = PetscMalloc(size*sizeof(*work),&work);CHKERRQ(ierr);
223   ierr = MPI_Allreduce((void*)nprocs,work,size,MPIU_2INT,PetscMaxSum_Op,comm);CHKERRQ(ierr);
224   *max = work[rank].max;
225   *sum = work[rank].sum;
226   ierr = PetscFree(work);CHKERRQ(ierr);
227   PetscFunctionReturn(0);
228 }
229 
230 /* ----------------------------------------------------------------------------*/
231 MPI_Op  PetscADMax_Op = 0;
232 
233 #undef __FUNCT__
234 #define __FUNCT__ "PetscADMax_Local"
235 PETSC_EXTERN void MPIAPI PetscADMax_Local(void *in,void *out,PetscMPIInt *cnt,MPI_Datatype *datatype)
236 {
237   PetscScalar *xin = (PetscScalar*)in,*xout = (PetscScalar*)out;
238   PetscInt    i,count = *cnt;
239 
240   PetscFunctionBegin;
241   if (*datatype != MPIU_2SCALAR) {
242     (*PetscErrorPrintf)("Can only handle MPIU_2SCALAR data (i.e. double or complex) types");
243     MPI_Abort(MPI_COMM_WORLD,1);
244   }
245 
246   for (i=0; i<count; i++) {
247     if (PetscRealPart(xout[2*i]) < PetscRealPart(xin[2*i])) {
248       xout[2*i]   = xin[2*i];
249       xout[2*i+1] = xin[2*i+1];
250     }
251   }
252   PetscFunctionReturnVoid();
253 }
254 
255 MPI_Op PetscADMin_Op = 0;
256 
257 #undef __FUNCT__
258 #define __FUNCT__ "PetscADMin_Local"
259 PETSC_EXTERN void MPIAPI PetscADMin_Local(void *in,void *out,PetscMPIInt *cnt,MPI_Datatype *datatype)
260 {
261   PetscScalar *xin = (PetscScalar*)in,*xout = (PetscScalar*)out;
262   PetscInt    i,count = *cnt;
263 
264   PetscFunctionBegin;
265   if (*datatype != MPIU_2SCALAR) {
266     (*PetscErrorPrintf)("Can only handle MPIU_2SCALAR data (i.e. double or complex) types");
267     MPI_Abort(MPI_COMM_WORLD,1);
268   }
269 
270   for (i=0; i<count; i++) {
271     if (PetscRealPart(xout[2*i]) > PetscRealPart(xin[2*i])) {
272       xout[2*i]   = xin[2*i];
273       xout[2*i+1] = xin[2*i+1];
274     }
275   }
276   PetscFunctionReturnVoid();
277 }
278 /* ---------------------------------------------------------------------------------------*/
279 
280 #if (defined(PETSC_HAVE_COMPLEX) && !defined(PETSC_HAVE_MPI_C_DOUBLE_COMPLEX)) || defined(PETSC_USE_REAL___FLOAT128)
281 MPI_Op MPIU_SUM = 0;
282 
283 #undef __FUNCT__
284 #define __FUNCT__ "PetscSum_Local"
285 PETSC_EXTERN void PetscSum_Local(void *in,void *out,PetscMPIInt *cnt,MPI_Datatype *datatype)
286 {
287   PetscInt i,count = *cnt;
288 
289   PetscFunctionBegin;
290   if (*datatype == MPIU_REAL) {
291     PetscReal *xin = (PetscReal*)in,*xout = (PetscReal*)out;
292     for (i=0; i<count; i++) xout[i] += xin[i];
293   }
294 #if defined(PETSC_HAVE_COMPLEX)
295   else if (*datatype == MPIU_COMPLEX) {
296     PetscComplex *xin = (PetscComplex*)in,*xout = (PetscComplex*)out;
297     for (i=0; i<count; i++) xout[i] += xin[i];
298   }
299 #endif
300   else {
301     (*PetscErrorPrintf)("Can only handle MPIU_REAL or MPIU_COMPLEX data types");
302     MPI_Abort(MPI_COMM_WORLD,1);
303   }
304   PetscFunctionReturnVoid();
305 }
306 #endif
307 
308 #if defined(PETSC_USE_REAL___FLOAT128)
309 MPI_Op MPIU_MAX = 0;
310 MPI_Op MPIU_MIN = 0;
311 
312 #undef __FUNCT__
313 #define __FUNCT__ "PetscMax_Local"
314 PETSC_EXTERN void PetscMax_Local(void *in,void *out,PetscMPIInt *cnt,MPI_Datatype *datatype)
315 {
316   PetscInt i,count = *cnt;
317 
318   PetscFunctionBegin;
319   if (*datatype == MPIU_REAL) {
320     PetscReal *xin = (PetscReal*)in,*xout = (PetscReal*)out;
321     for (i=0; i<count; i++) xout[i] = PetscMax(xout[i],xin[i]);
322   }
323 #if defined(PETSC_HAVE_COMPLEX)
324   else if (*datatype == MPIU_COMPLEX) {
325     PetscComplex *xin = (PetscComplex*)in,*xout = (PetscComplex*)out;
326     for (i=0; i<count; i++) {
327       xout[i] = PetscRealPartComplex(xout[i])<PetscRealPartComplex(xin[i]) ? xin[i] : xout[i];
328     }
329   }
330 #endif
331   else {
332     (*PetscErrorPrintf)("Can only handle MPIU_REAL or MPIU_COMPLEX data types");
333     MPI_Abort(MPI_COMM_WORLD,1);
334   }
335   PetscFunctionReturnVoid();
336 }
337 
338 #undef __FUNCT__
339 #define __FUNCT__ "PetscMin_Local"
340 PETSC_EXTERN void PetscMin_Local(void *in,void *out,PetscMPIInt *cnt,MPI_Datatype *datatype)
341 {
342   PetscInt    i,count = *cnt;
343 
344   PetscFunctionBegin;
345   if (*datatype == MPIU_REAL) {
346     PetscReal *xin = (PetscReal*)in,*xout = (PetscReal*)out;
347     for (i=0; i<count; i++) xout[i] = PetscMin(xout[i],xin[i]);
348   }
349 #if defined(PETSC_HAVE_COMPLEX)
350   else if (*datatype == MPIU_COMPLEX) {
351     PetscComplex *xin = (PetscComplex*)in,*xout = (PetscComplex*)out;
352     for (i=0; i<count; i++) {
353       xout[i] = PetscRealPartComplex(xout[i])>PetscRealPartComplex(xin[i]) ? xin[i] : xout[i];
354     }
355   }
356 #endif
357   else {
358     (*PetscErrorPrintf)("Can only handle MPIU_REAL or MPIU_SCALAR data (i.e. double or complex) types");
359     MPI_Abort(MPI_COMM_WORLD,1);
360   }
361   PetscFunctionReturnVoid();
362 }
363 #endif
364 
365 #undef __FUNCT__
366 #define __FUNCT__ "Petsc_DelCounter"
367 /*
368    Private routine to delete internal tag/name counter storage when a communicator is freed.
369 
370    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.
371 
372    Note: this is declared extern "C" because it is passed to MPI_Keyval_create()
373 
374 */
375 PETSC_EXTERN PetscMPIInt MPIAPI Petsc_DelCounter(MPI_Comm comm,PetscMPIInt keyval,void *count_val,void *extra_state)
376 {
377   PetscErrorCode ierr;
378 
379   PetscFunctionBegin;
380   ierr = PetscInfo1(0,"Deleting counter data in an MPI_Comm %ld\n",(long)comm);if (ierr) PetscFunctionReturn((PetscMPIInt)ierr);
381   ierr = PetscFree(count_val);if (ierr) PetscFunctionReturn((PetscMPIInt)ierr);
382   PetscFunctionReturn(MPI_SUCCESS);
383 }
384 
385 #undef __FUNCT__
386 #define __FUNCT__ "Petsc_DelComm_Outer"
387 /*
388   This is invoked on the outer comm as a result of either PetscCommDestroy() (via MPI_Attr_delete) or when the user
389   calls MPI_Comm_free().
390 
391   This is the only entry point for breaking the links between inner and outer comms.
392 
393   This is called by MPI, not by users. This is called when MPI_Comm_free() is called on the communicator.
394 
395   Note: this is declared extern "C" because it is passed to MPI_Keyval_create()
396 
397 */
398 PETSC_EXTERN PetscMPIInt MPIAPI Petsc_DelComm_Outer(MPI_Comm comm,PetscMPIInt keyval,void *attr_val,void *extra_state)
399 {
400   PetscErrorCode ierr;
401   PetscMPIInt    flg;
402   union {MPI_Comm comm; void *ptr;} icomm,ocomm;
403 
404   PetscFunctionBegin;
405   if (keyval != Petsc_InnerComm_keyval) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_CORRUPT,"Unexpected keyval");
406   icomm.ptr = attr_val;
407 
408   ierr = MPI_Attr_get(icomm.comm,Petsc_OuterComm_keyval,&ocomm,&flg);CHKERRQ(ierr);
409   if (!flg) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_CORRUPT,"Inner MPI_Comm does not have expected reference to outer comm");
410   if (ocomm.comm != comm) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_CORRUPT,"Inner MPI_Comm has reference to non-matching outer comm");
411   ierr = MPI_Attr_delete(icomm.comm,Petsc_OuterComm_keyval);CHKERRQ(ierr); /* Calls Petsc_DelComm_Inner */
412   ierr = PetscInfo1(0,"User MPI_Comm %ld is being freed after removing reference from inner PETSc comm to this outer comm\n",(long)comm);if (ierr) PetscFunctionReturn((PetscMPIInt)ierr);
413   PetscFunctionReturn(MPI_SUCCESS);
414 }
415 
416 #undef __FUNCT__
417 #define __FUNCT__ "Petsc_DelComm_Inner"
418 /*
419  * This is invoked on the inner comm when Petsc_DelComm_Outer calls MPI_Attr_delete.  It should not be reached any other way.
420  */
421 PETSC_EXTERN PetscMPIInt MPIAPI Petsc_DelComm_Inner(MPI_Comm comm,PetscMPIInt keyval,void *attr_val,void *extra_state)
422 {
423   PetscErrorCode ierr;
424 
425   PetscFunctionBegin;
426   ierr = PetscInfo1(0,"Removing reference to PETSc communicator embedded in a user MPI_Comm %ld\n",(long)comm);if (ierr) PetscFunctionReturn((PetscMPIInt)ierr);
427   PetscFunctionReturn(MPI_SUCCESS);
428 }
429 
430 #if defined(PETSC_USE_PETSC_MPI_EXTERNAL32)
431 #if !defined(PETSC_WORDS_BIGENDIAN)
432 PETSC_EXTERN PetscMPIInt PetscDataRep_extent_fn(MPI_Datatype,MPI_Aint*,void*);
433 PETSC_EXTERN PetscMPIInt PetscDataRep_read_conv_fn(void*, MPI_Datatype,PetscMPIInt,void*,MPI_Offset,void*);
434 PETSC_EXTERN PetscMPIInt PetscDataRep_write_conv_fn(void*, MPI_Datatype,PetscMPIInt,void*,MPI_Offset,void*);
435 #endif
436 #endif
437 
438 int  PetscGlobalArgc   = 0;
439 char **PetscGlobalArgs = 0;
440 PetscSegBuffer PetscCitationsList;
441 
442 #undef __FUNCT__
443 #define __FUNCT__ "PetscCitationsInitialize"
444 PetscErrorCode PetscCitationsInitialize()
445 {
446   PetscErrorCode ierr;
447 
448   PetscFunctionBegin;
449   ierr = PetscSegBufferCreate(1,10000,&PetscCitationsList);CHKERRQ(ierr);
450   ierr = PetscCitationsRegister("@TechReport{petsc-user-ref,\n  Author = {Satish Balay and Jed Brown and and Kris Buschelman and Victor Eijkhout\n            and William D.  Gropp and Dinesh Kaushik and Matthew G. Knepley\n            and Lois Curfman McInnes and Barry F. Smith and Hong Zhang},\n  Title = {{PETS}c Users Manual},\n  Number = {ANL-95/11 - Revision 3.4},\n  Institution = {Argonne National Laboratory},\n  Year = {2013}\n}\n",NULL);CHKERRQ(ierr);
451   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);
452   PetscFunctionReturn(0);
453 }
454 
455 #undef __FUNCT__
456 #define __FUNCT__ "PetscGetArgs"
457 /*@C
458    PetscGetArgs - Allows you to access the raw command line arguments anywhere
459      after PetscInitialize() is called but before PetscFinalize().
460 
461    Not Collective
462 
463    Output Parameters:
464 +  argc - count of number of command line arguments
465 -  args - the command line arguments
466 
467    Level: intermediate
468 
469    Notes:
470       This is usually used to pass the command line arguments into other libraries
471    that are called internally deep in PETSc or the application.
472 
473       The first argument contains the program name as is normal for C arguments.
474 
475    Concepts: command line arguments
476 
477 .seealso: PetscFinalize(), PetscInitializeFortran(), PetscGetArguments()
478 
479 @*/
480 PetscErrorCode  PetscGetArgs(int *argc,char ***args)
481 {
482   PetscFunctionBegin;
483   if (!PetscInitializeCalled && PetscFinalizeCalled) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ORDER,"You must call after PetscInitialize() but before PetscFinalize()");
484   *argc = PetscGlobalArgc;
485   *args = PetscGlobalArgs;
486   PetscFunctionReturn(0);
487 }
488 
489 #undef __FUNCT__
490 #define __FUNCT__ "PetscGetArguments"
491 /*@C
492    PetscGetArguments - Allows you to access the  command line arguments anywhere
493      after PetscInitialize() is called but before PetscFinalize().
494 
495    Not Collective
496 
497    Output Parameters:
498 .  args - the command line arguments
499 
500    Level: intermediate
501 
502    Notes:
503       This does NOT start with the program name and IS null terminated (final arg is void)
504 
505    Concepts: command line arguments
506 
507 .seealso: PetscFinalize(), PetscInitializeFortran(), PetscGetArgs(), PetscFreeArguments()
508 
509 @*/
510 PetscErrorCode  PetscGetArguments(char ***args)
511 {
512   PetscInt       i,argc = PetscGlobalArgc;
513   PetscErrorCode ierr;
514 
515   PetscFunctionBegin;
516   if (!PetscInitializeCalled && PetscFinalizeCalled) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ORDER,"You must call after PetscInitialize() but before PetscFinalize()");
517   if (!argc) {*args = 0; PetscFunctionReturn(0);}
518   ierr = PetscMalloc(argc*sizeof(char*),args);CHKERRQ(ierr);
519   for (i=0; i<argc-1; i++) {
520     ierr = PetscStrallocpy(PetscGlobalArgs[i+1],&(*args)[i]);CHKERRQ(ierr);
521   }
522   (*args)[argc-1] = 0;
523   PetscFunctionReturn(0);
524 }
525 
526 #undef __FUNCT__
527 #define __FUNCT__ "PetscFreeArguments"
528 /*@C
529    PetscFreeArguments - Frees the memory obtained with PetscGetArguments()
530 
531    Not Collective
532 
533    Output Parameters:
534 .  args - the command line arguments
535 
536    Level: intermediate
537 
538    Concepts: command line arguments
539 
540 .seealso: PetscFinalize(), PetscInitializeFortran(), PetscGetArgs(), PetscGetArguments()
541 
542 @*/
543 PetscErrorCode  PetscFreeArguments(char **args)
544 {
545   PetscInt       i = 0;
546   PetscErrorCode ierr;
547 
548   PetscFunctionBegin;
549   if (!args) PetscFunctionReturn(0);
550   while (args[i]) {
551     ierr = PetscFree(args[i]);CHKERRQ(ierr);
552     i++;
553   }
554   ierr = PetscFree(args);CHKERRQ(ierr);
555   PetscFunctionReturn(0);
556 }
557 
558 #undef __FUNCT__
559 #define __FUNCT__ "PetscInitialize"
560 /*@C
561    PetscInitialize - Initializes the PETSc database and MPI.
562    PetscInitialize() calls MPI_Init() if that has yet to be called,
563    so this routine should always be called near the beginning of
564    your program -- usually the very first line!
565 
566    Collective on MPI_COMM_WORLD or PETSC_COMM_WORLD if it has been set
567 
568    Input Parameters:
569 +  argc - count of number of command line arguments
570 .  args - the command line arguments
571 .  file - [optional] PETSc database file, also checks ~username/.petscrc and .petscrc use NULL to not check for
572           code specific file. Use -skip_petscrc in the code specific file to skip the .petscrc files
573 -  help - [optional] Help message to print, use NULL for no message
574 
575    If you wish PETSc code to run ONLY on a subcommunicator of MPI_COMM_WORLD, create that
576    communicator first and assign it to PETSC_COMM_WORLD BEFORE calling PetscInitialize(). Thus if you are running a
577    four process job and two processes will run PETSc and have PetscInitialize() and PetscFinalize() and two process will not,
578    then do this. If ALL processes in the job are using PetscInitialize() and PetscFinalize() then you don't need to do this, even
579    if different subcommunicators of the job are doing different things with PETSc.
580 
581    Options Database Keys:
582 +  -start_in_debugger [noxterm,dbx,xdb,gdb,...] - Starts program in debugger
583 .  -on_error_attach_debugger [noxterm,dbx,xdb,gdb,...] - Starts debugger when error detected
584 .  -on_error_emacs <machinename> causes emacsclient to jump to error file
585 .  -on_error_abort calls abort() when error detected (no traceback)
586 .  -on_error_mpiabort calls MPI_abort() when error detected
587 .  -error_output_stderr prints error messages to stderr instead of the default stdout
588 .  -error_output_none does not print the error messages (but handles errors in the same way as if this was not called)
589 .  -debugger_nodes [node1,node2,...] - Indicates nodes to start in debugger
590 .  -debugger_pause [sleeptime] (in seconds) - Pauses debugger
591 .  -stop_for_debugger - Print message on how to attach debugger manually to
592                         process and wait (-debugger_pause) seconds for attachment
593 .  -malloc - Indicates use of PETSc error-checking malloc (on by default for debug version of libraries)
594 .  -malloc no - Indicates not to use error-checking malloc
595 .  -malloc_debug - check for memory corruption at EVERY malloc or free
596 .  -malloc_dump - prints a list of all unfreed memory at the end of the run
597 .  -malloc_test - like -malloc_dump -malloc_debug, but only active for debugging builds
598 .  -fp_trap - Stops on floating point exceptions (Note that on the
599               IBM RS6000 this slows code by at least a factor of 10.)
600 .  -no_signal_handler - Indicates not to trap error signals
601 .  -shared_tmp - indicates /tmp directory is shared by all processors
602 .  -not_shared_tmp - each processor has own /tmp
603 .  -tmp - alternative name of /tmp directory
604 .  -get_total_flops - returns total flops done by all processors
605 .  -memory_info - Print memory usage at end of run
606 -  -server <port> - start PETSc webserver (default port is 8080)
607 
608    Options Database Keys for Profiling:
609    See the <a href="../../docs/manual.pdf#nameddest=ch_profiling">profiling chapter of the users manual</a> for details.
610 +  -info <optional filename> - Prints verbose information to the screen
611 .  -info_exclude <null,vec,mat,pc,ksp,snes,ts> - Excludes some of the verbose messages
612 .  -log_sync - Log the synchronization in scatters, inner products and norms
613 .  -log_trace [filename] - Print traces of all PETSc calls to the screen (useful to determine where a program
614         hangs without running in the debugger).  See PetscLogTraceBegin().
615 .  -log_summary [filename] - Prints summary of flop and timing information to screen. If the filename is specified the
616         summary is written to the file.  See PetscLogView().
617 .  -log_summary_python [filename] - Prints data on of flop and timing usage to a file or screen. See PetscLogPrintSViewPython().
618 .  -log_all [filename] - Logs extensive profiling information  See PetscLogDump().
619 .  -log [filename] - Logs basic profiline information  See PetscLogDump().
620 -  -log_mpe [filename] - Creates a logfile viewable by the utility Jumpshot (in MPICH distribution)
621 
622     Only one of -log_trace, -log_summary, -log_all, -log, or -log_mpe may be used at a time
623 
624    Environmental Variables:
625 +   PETSC_TMP - alternative tmp directory
626 .   PETSC_SHARED_TMP - tmp is shared by all processes
627 .   PETSC_NOT_SHARED_TMP - each process has its own private tmp
628 .   PETSC_VIEWER_SOCKET_PORT - socket number to use for socket viewer
629 -   PETSC_VIEWER_SOCKET_MACHINE - machine to use for socket viewer to connect to
630 
631 
632    Level: beginner
633 
634    Notes:
635    If for some reason you must call MPI_Init() separately, call
636    it before PetscInitialize().
637 
638    Fortran Version:
639    In Fortran this routine has the format
640 $       call PetscInitialize(file,ierr)
641 
642 +   ierr - error return code
643 -  file - [optional] PETSc database file, also checks ~username/.petscrc and .petscrc use NULL_CHARACTER to not check for
644           code specific file. Use -skip_petscrc in the code specific file to skip the .petscrc files
645 
646    Important Fortran Note:
647    In Fortran, you MUST use NULL_CHARACTER to indicate a
648    null character string; you CANNOT just use NULL as
649    in the C version. See the <a href="../../docs/manual.pdf">users manual</a> for details.
650 
651    If your main program is C but you call Fortran code that also uses PETSc you need to call PetscInitializeFortran() soon after
652    calling PetscInitialize().
653 
654    Concepts: initializing PETSc
655 
656 .seealso: PetscFinalize(), PetscInitializeFortran(), PetscGetArgs(), PetscInitializeNoArguments()
657 
658 @*/
659 PetscErrorCode  PetscInitialize(int *argc,char ***args,const char file[],const char help[])
660 {
661   PetscErrorCode ierr;
662   PetscMPIInt    flag, size;
663   PetscInt       nodesize;
664   PetscBool      flg;
665   char           hostname[256];
666 
667   PetscFunctionBegin;
668   if (PetscInitializeCalled) PetscFunctionReturn(0);
669 
670   /* these must be initialized in a routine, not as a constant declaration*/
671   PETSC_STDOUT = stdout;
672   PETSC_STDERR = stderr;
673 
674   ierr = PetscOptionsCreate();CHKERRQ(ierr);
675 
676   /*
677      We initialize the program name here (before MPI_Init()) because MPICH has a bug in
678      it that it sets args[0] on all processors to be args[0] on the first processor.
679   */
680   if (argc && *argc) {
681     ierr = PetscSetProgramName(**args);CHKERRQ(ierr);
682   } else {
683     ierr = PetscSetProgramName("Unknown Name");CHKERRQ(ierr);
684   }
685 
686   ierr = MPI_Initialized(&flag);CHKERRQ(ierr);
687   if (!flag) {
688     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");
689 #if defined(PETSC_HAVE_MPI_INIT_THREAD)
690     {
691       PetscMPIInt provided;
692       ierr = MPI_Init_thread(argc,args,MPI_THREAD_FUNNELED,&provided);CHKERRQ(ierr);
693     }
694 #else
695     ierr = MPI_Init(argc,args);CHKERRQ(ierr);
696 #endif
697     PetscBeganMPI = PETSC_TRUE;
698   }
699   if (argc && args) {
700     PetscGlobalArgc = *argc;
701     PetscGlobalArgs = *args;
702   }
703   PetscFinalizeCalled = PETSC_FALSE;
704 
705   if (PETSC_COMM_WORLD == MPI_COMM_NULL) PETSC_COMM_WORLD = MPI_COMM_WORLD;
706   ierr = MPI_Comm_set_errhandler(PETSC_COMM_WORLD,MPI_ERRORS_RETURN);CHKERRQ(ierr);
707 
708   /* Done after init due to a bug in MPICH-GM? */
709   ierr = PetscErrorPrintfInitialize();CHKERRQ(ierr);
710 
711   ierr = MPI_Comm_rank(MPI_COMM_WORLD,&PetscGlobalRank);CHKERRQ(ierr);
712   ierr = MPI_Comm_size(MPI_COMM_WORLD,&PetscGlobalSize);CHKERRQ(ierr);
713 
714   MPIU_BOOL = MPI_INT;
715   MPIU_ENUM = MPI_INT;
716 
717   /*
718      Initialized the global complex variable; this is because with
719      shared libraries the constructors for global variables
720      are not called; at least on IRIX.
721   */
722 #if defined(PETSC_HAVE_COMPLEX)
723   {
724 #if defined(PETSC_CLANGUAGE_CXX)
725     PetscComplex ic(0.0,1.0);
726     PETSC_i = ic;
727 #elif defined(PETSC_CLANGUAGE_C)
728     PETSC_i = _Complex_I;
729 #endif
730   }
731 
732 #if !defined(PETSC_HAVE_MPI_C_DOUBLE_COMPLEX)
733   ierr = MPI_Type_contiguous(2,MPI_DOUBLE,&MPIU_C_DOUBLE_COMPLEX);CHKERRQ(ierr);
734   ierr = MPI_Type_commit(&MPIU_C_DOUBLE_COMPLEX);CHKERRQ(ierr);
735   ierr = MPI_Type_contiguous(2,MPI_FLOAT,&MPIU_C_COMPLEX);CHKERRQ(ierr);
736   ierr = MPI_Type_commit(&MPIU_C_COMPLEX);CHKERRQ(ierr);
737 #endif
738 #endif /* PETSC_HAVE_COMPLEX */
739 
740   /*
741      Create the PETSc MPI reduction operator that sums of the first
742      half of the entries and maxes the second half.
743   */
744   ierr = MPI_Op_create(PetscMaxSum_Local,1,&PetscMaxSum_Op);CHKERRQ(ierr);
745 
746 #if defined(PETSC_USE_REAL___FLOAT128)
747   ierr = MPI_Type_contiguous(2,MPI_DOUBLE,&MPIU___FLOAT128);CHKERRQ(ierr);
748   ierr = MPI_Type_commit(&MPIU___FLOAT128);CHKERRQ(ierr);
749 #if defined(PETSC_HAVE_COMPLEX)
750   ierr = MPI_Type_contiguous(4,MPI_DOUBLE,&MPIU___COMPLEX128);CHKERRQ(ierr);
751   ierr = MPI_Type_commit(&MPIU___COMPLEX128);CHKERRQ(ierr);
752 #endif
753   ierr = MPI_Op_create(PetscMax_Local,1,&MPIU_MAX);CHKERRQ(ierr);
754   ierr = MPI_Op_create(PetscMin_Local,1,&MPIU_MIN);CHKERRQ(ierr);
755 #endif
756 
757 #if (defined(PETSC_HAVE_COMPLEX) && !defined(PETSC_HAVE_MPI_C_DOUBLE_COMPLEX)) || defined(PETSC_USE_REAL___FLOAT128)
758   ierr = MPI_Op_create(PetscSum_Local,1,&MPIU_SUM);CHKERRQ(ierr);
759 #endif
760 
761   ierr = MPI_Type_contiguous(2,MPIU_SCALAR,&MPIU_2SCALAR);CHKERRQ(ierr);
762   ierr = MPI_Type_commit(&MPIU_2SCALAR);CHKERRQ(ierr);
763   ierr = MPI_Op_create(PetscADMax_Local,1,&PetscADMax_Op);CHKERRQ(ierr);
764   ierr = MPI_Op_create(PetscADMin_Local,1,&PetscADMin_Op);CHKERRQ(ierr);
765 
766 #if defined(PETSC_USE_64BIT_INDICES) || !defined(MPI_2INT)
767   ierr = MPI_Type_contiguous(2,MPIU_INT,&MPIU_2INT);CHKERRQ(ierr);
768   ierr = MPI_Type_commit(&MPIU_2INT);CHKERRQ(ierr);
769 #endif
770 
771 
772   /*
773      Attributes to be set on PETSc communicators
774   */
775   ierr = MPI_Keyval_create(MPI_NULL_COPY_FN,Petsc_DelCounter,&Petsc_Counter_keyval,(void*)0);CHKERRQ(ierr);
776   ierr = MPI_Keyval_create(MPI_NULL_COPY_FN,Petsc_DelComm_Outer,&Petsc_InnerComm_keyval,(void*)0);CHKERRQ(ierr);
777   ierr = MPI_Keyval_create(MPI_NULL_COPY_FN,Petsc_DelComm_Inner,&Petsc_OuterComm_keyval,(void*)0);CHKERRQ(ierr);
778 
779   /*
780      Build the options database
781   */
782   ierr = PetscOptionsInsert(argc,args,file);CHKERRQ(ierr);
783 
784 
785   /*
786      Print main application help message
787   */
788   ierr = PetscOptionsHasName(NULL,"-help",&flg);CHKERRQ(ierr);
789   if (help && flg) {
790     ierr = PetscPrintf(PETSC_COMM_WORLD,help);CHKERRQ(ierr);
791   }
792   ierr = PetscOptionsCheckInitial_Private();CHKERRQ(ierr);
793 
794   ierr = PetscCitationsInitialize();CHKERRQ(ierr);
795 
796 #if defined(PETSC_HAVE_SAWS)
797   if (!PetscGlobalRank) {
798     char        cert[PETSC_MAX_PATH_LEN],root[PETSC_MAX_PATH_LEN],*intro,programname[64],*appline;
799     int         port;
800     PetscBool   rootlocal = PETSC_FALSE,flg2;
801     size_t      applinelen,introlen;
802 
803     ierr = PetscOptionsHasName(NULL,"-saws_log",&flg);CHKERRQ(ierr);
804     if (flg) {
805       char  sawslog[PETSC_MAX_PATH_LEN];
806 
807       ierr = PetscOptionsGetString(NULL,"-saws_log",sawslog,PETSC_MAX_PATH_LEN,NULL);CHKERRQ(ierr);
808       if (sawslog[0]) {
809         PetscStackCallSAWs(SAWs_Set_Use_Logfile,(sawslog));
810       } else {
811         PetscStackCallSAWs(SAWs_Set_Use_Logfile,(NULL));
812       }
813     }
814     ierr = PetscOptionsGetString(NULL,"-saws_https",cert,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr);
815     if (flg) {
816       PetscStackCallSAWs(SAWs_Set_Use_HTTPS,(cert));
817     }
818     ierr = PetscOptionsGetInt(NULL,"-saws_port",&port,&flg);CHKERRQ(ierr);
819     if (flg) {
820       PetscStackCallSAWs(SAWs_Set_Port,(port));
821     }
822     ierr = PetscOptionsGetString(NULL,"-saws_root",root,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr);
823     if (flg) {
824       PetscStackCallSAWs(SAWs_Set_Document_Root,(root));CHKERRQ(ierr);
825       ierr = PetscStrcmp(root,".",&rootlocal);CHKERRQ(ierr);
826     }
827     ierr = PetscOptionsHasName(NULL,"-saws_local",&flg2);CHKERRQ(ierr);
828     if (flg2) {
829       char jsdir[PETSC_MAX_PATH_LEN];
830       if (!flg) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SUP,"-saws_local option requires -saws_root option");
831       ierr = PetscSNPrintf(jsdir,PETSC_MAX_PATH_LEN,"%s/js",root);CHKERRQ(ierr);
832       ierr = PetscTestDirectory(jsdir,'r',&flg);CHKERRQ(ierr);
833       if (!flg) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_FILE_READ,"-saws_local option requires js directory in root directory");
834       PetscStackCallSAWs(SAWs_Set_Local_JSHeader,());CHKERRQ(ierr);
835     }
836     ierr = PetscGetProgramName(programname,64);CHKERRQ(ierr);
837     ierr = PetscStrlen(help,&applinelen);CHKERRQ(ierr);
838     introlen   = 4096 + applinelen;
839     applinelen += 256;
840     ierr = PetscMalloc(applinelen,&appline);CHKERRQ(ierr);
841     ierr = PetscMalloc(introlen,&intro);CHKERRQ(ierr);
842 
843     if (rootlocal) {
844       ierr = PetscSNPrintf(appline,applinelen,"%s.c.html",programname);CHKERRQ(ierr);
845       ierr = PetscTestFile(appline,'r',&rootlocal);CHKERRQ(ierr);
846     }
847     if (rootlocal && help) {
848       ierr = PetscSNPrintf(appline,applinelen,"<center> Running <a href=\"%s.c.html\">%s</a></center><br><pre>%s</pre><br>\n",programname,programname,help);
849     } else if (help) {
850       ierr = PetscSNPrintf(appline,applinelen,"<center>Running %s </center><br><pre>%s</pre><br>\n",programname,help);
851     } else {
852       ierr = PetscSNPrintf(appline,applinelen,"<center> Running %s</center><br>\n",programname);
853     }
854 
855     ierr = PetscSNPrintf(intro,introlen,"<body>\n"
856                                     "<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"
857                                     "%s"
858                                     "<center>This is the default PETSc application dashboard, from it you can access any published PETSc objects or logging data</center><br>\n",appline);
859     PetscStackCallSAWs(SAWs_Set_Body,("index.html",0,intro));
860     ierr = PetscFree(intro);CHKERRQ(ierr);
861     ierr = PetscFree(appline);CHKERRQ(ierr);
862     PetscStackCallSAWs(SAWs_Initialize,());
863     ierr = PetscCitationsRegister("@TechReport{ saws,"
864                                   "Author = {Matt Otten and Jed Brown and Barry Smith},"
865                                   "Title  = {Scientific Application Web Server (SAWs) Users Manual},"
866                                   "Institution = {Argonne National Laboratory},"
867                                   "Year   = 2013}",NULL);CHKERRQ(ierr);
868   }
869 
870 #endif
871 
872   /* SHOULD PUT IN GUARDS: Make sure logging is initialized, even if we do not print it out */
873 #if defined(PETSC_USE_LOG)
874   ierr = PetscLogBegin_Private();CHKERRQ(ierr);
875 #endif
876 
877   /*
878      Load the dynamic libraries (on machines that support them), this registers all
879      the solvers etc. (On non-dynamic machines this initializes the PetscDraw and PetscViewer classes)
880   */
881   ierr = PetscInitialize_DynamicLibraries();CHKERRQ(ierr);
882 
883   ierr = MPI_Comm_size(PETSC_COMM_WORLD,&size);CHKERRQ(ierr);
884   ierr = PetscInfo1(0,"PETSc successfully started: number of processors = %d\n",size);CHKERRQ(ierr);
885   ierr = PetscGetHostName(hostname,256);CHKERRQ(ierr);
886   ierr = PetscInfo1(0,"Running on machine: %s\n",hostname);CHKERRQ(ierr);
887 
888   ierr = PetscOptionsCheckInitial_Components();CHKERRQ(ierr);
889   /* Check the options database for options related to the options database itself */
890   ierr = PetscOptionsSetFromOptions();CHKERRQ(ierr);
891 
892 #if defined(PETSC_USE_PETSC_MPI_EXTERNAL32)
893   /*
894       Tell MPI about our own data representation converter, this would/should be used if extern32 is not supported by the MPI
895 
896       Currently not used because it is not supported by MPICH.
897   */
898 #if !defined(PETSC_WORDS_BIGENDIAN)
899   ierr = MPI_Register_datarep((char*)"petsc",PetscDataRep_read_conv_fn,PetscDataRep_write_conv_fn,PetscDataRep_extent_fn,NULL);CHKERRQ(ierr);
900 #endif
901 #endif
902 
903   ierr = PetscOptionsGetInt(NULL,"-hmpi_spawn_size",&nodesize,&flg);CHKERRQ(ierr);
904   if (flg) {
905 #if defined(PETSC_HAVE_MPI_COMM_SPAWN)
906     ierr = PetscHMPISpawn((PetscMPIInt) nodesize);CHKERRQ(ierr); /* worker nodes never return from here; they go directly to PetscEnd() */
907 #else
908     SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SUP,"PETSc built without MPI 2 (MPI_Comm_spawn) support, use -hmpi_merge_size instead");
909 #endif
910   } else {
911     ierr = PetscOptionsGetInt(NULL,"-hmpi_merge_size",&nodesize,&flg);CHKERRQ(ierr);
912     if (flg) {
913       ierr = PetscHMPIMerge((PetscMPIInt) nodesize,NULL,NULL);CHKERRQ(ierr);
914       if (PetscHMPIWorker) { /* if worker then never enter user code */
915         PetscInitializeCalled = PETSC_TRUE;
916         PetscEnd();
917       }
918     }
919   }
920 
921 #if defined(PETSC_HAVE_CUDA)
922   {
923     PetscMPIInt p;
924     for (p = 0; p < PetscGlobalSize; ++p) {
925       if (p == PetscGlobalRank) cublasInit();
926       ierr = MPI_Barrier(PETSC_COMM_WORLD);CHKERRQ(ierr);
927     }
928   }
929 #endif
930 
931   ierr = PetscOptionsHasName(NULL,"-python",&flg);CHKERRQ(ierr);
932   if (flg) {
933     PetscInitializeCalled = PETSC_TRUE;
934     ierr = PetscPythonInitialize(NULL,NULL);CHKERRQ(ierr);
935   }
936 
937   ierr = PetscThreadCommInitializePackage();CHKERRQ(ierr);
938 
939   /*
940       Setup building of stack frames for all function calls
941   */
942   PetscThreadLocalRegister((PetscThreadKey*)&petscstack); /* Creates pthread_key */
943 #if defined(PETSC_USE_DEBUG)
944   ierr = PetscStackCreate();CHKERRQ(ierr);
945 #endif
946 
947 #if defined(PETSC_SERIALIZE_FUNCTIONS)
948   ierr = PetscFPTCreate(10000);CHKERRQ(ierr);
949 #endif
950 
951 
952   /*
953       Once we are completedly initialized then we can set this variables
954   */
955   PetscInitializeCalled = PETSC_TRUE;
956   PetscFunctionReturn(0);
957 }
958 
959 extern PetscObject *PetscObjects;
960 extern PetscInt    PetscObjectsCounts, PetscObjectsMaxCounts;
961 
962 #undef __FUNCT__
963 #define __FUNCT__ "PetscFinalize"
964 /*@C
965    PetscFinalize - Checks for options to be called at the conclusion
966    of the program. MPI_Finalize() is called only if the user had not
967    called MPI_Init() before calling PetscInitialize().
968 
969    Collective on PETSC_COMM_WORLD
970 
971    Options Database Keys:
972 +  -options_table - Calls PetscOptionsView()
973 .  -options_left - Prints unused options that remain in the database
974 .  -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
975 .  -mpidump - Calls PetscMPIDump()
976 .  -malloc_dump - Calls PetscMallocDump()
977 .  -malloc_info - Prints total memory usage
978 -  -malloc_log - Prints summary of memory usage
979 
980    Level: beginner
981 
982    Note:
983    See PetscInitialize() for more general runtime options.
984 
985 .seealso: PetscInitialize(), PetscOptionsView(), PetscMallocDump(), PetscMPIDump(), PetscEnd()
986 @*/
987 PetscErrorCode  PetscFinalize(void)
988 {
989   PetscErrorCode ierr;
990   PetscMPIInt    rank;
991   PetscInt       nopt;
992   PetscBool      flg1 = PETSC_FALSE,flg2 = PETSC_FALSE,flg3 = PETSC_FALSE;
993   PetscBool      flg;
994 #if defined(PETSC_USE_LOG)
995   char           mname[PETSC_MAX_PATH_LEN];
996 #endif
997 
998   PetscFunctionBegin;
999   if (!PetscInitializeCalled) {
1000     printf("PetscInitialize() must be called before PetscFinalize()\n");
1001     PetscFunctionReturn(PETSC_ERR_ARG_WRONGSTATE);
1002   }
1003   ierr = PetscInfo(NULL,"PetscFinalize() called\n");CHKERRQ(ierr);
1004 
1005   ierr = MPI_Comm_rank(PETSC_COMM_WORLD,&rank);CHKERRQ(ierr);
1006 
1007   ierr = PetscOptionsHasName(NULL,"-citations",&flg);CHKERRQ(ierr);
1008   if (flg) {
1009     char  *cits, filename[PETSC_MAX_PATH_LEN];
1010     FILE  *fd = PETSC_STDOUT;
1011 
1012     ierr = PetscOptionsGetString(NULL,"-citations",filename,PETSC_MAX_PATH_LEN,NULL);CHKERRQ(ierr);
1013     if (filename[0]) {
1014       ierr = PetscFOpen(PETSC_COMM_WORLD,filename,"w",&fd);CHKERRQ(ierr);
1015     }
1016     ierr = PetscSegBufferGet(PetscCitationsList,1,&cits);CHKERRQ(ierr);
1017     cits[0] = 0;
1018     ierr = PetscSegBufferExtractAlloc(PetscCitationsList,&cits);CHKERRQ(ierr);
1019     ierr = PetscFPrintf(PETSC_COMM_WORLD,fd,"If you publish results based on this computation please cite the following:\n");CHKERRQ(ierr);
1020     ierr = PetscFPrintf(PETSC_COMM_WORLD,fd,"===========================================================================\n");CHKERRQ(ierr);
1021     ierr = PetscFPrintf(PETSC_COMM_WORLD,fd,"%s",cits);CHKERRQ(ierr);
1022     ierr = PetscFPrintf(PETSC_COMM_WORLD,fd,"===========================================================================\n");CHKERRQ(ierr);
1023     ierr = PetscFClose(PETSC_COMM_WORLD,fd);CHKERRQ(ierr);
1024     ierr = PetscFree(cits);CHKERRQ(ierr);
1025   }
1026   ierr = PetscSegBufferDestroy(&PetscCitationsList);CHKERRQ(ierr);
1027 
1028 #if defined(PETSC_SERIALIZE_FUNCTIONS)
1029   ierr = PetscFPTDestroy();CHKERRQ(ierr);
1030 #endif
1031 
1032 
1033 #if defined(PETSC_HAVE_SAWS)
1034   flg = PETSC_FALSE;
1035   ierr = PetscOptionsGetBool(NULL,"-saw_options",&flg,NULL);CHKERRQ(ierr);
1036   if (flg) {
1037     ierr = PetscOptionsSAWsDestroy();CHKERRQ(ierr);
1038   }
1039 #endif
1040 
1041 #if defined(PETSC_HAVE_SERVER)
1042   flg1 = PETSC_FALSE;
1043   ierr = PetscOptionsGetBool(NULL,"-server",&flg1,NULL);CHKERRQ(ierr);
1044   if (flg1) {
1045     /*  this is a crude hack, but better than nothing */
1046     ierr = PetscPOpen(PETSC_COMM_WORLD,NULL,"pkill -9 petscwebserver","r",NULL);CHKERRQ(ierr);
1047   }
1048 #endif
1049 
1050 #if defined(PETSC_HAVE_X)
1051   flg1 = PETSC_FALSE;
1052   ierr = PetscOptionsGetBool(NULL,"-x_virtual",&flg1,NULL);CHKERRQ(ierr);
1053   if (flg1) {
1054     /*  this is a crude hack, but better than nothing */
1055     ierr = PetscPOpen(PETSC_COMM_WORLD,NULL,"pkill -9 Xvfb","r",NULL);CHKERRQ(ierr);
1056   }
1057 #endif
1058 
1059   ierr = PetscHMPIFinalize();CHKERRQ(ierr);
1060 
1061   ierr = PetscOptionsGetBool(NULL,"-malloc_info",&flg2,NULL);CHKERRQ(ierr);
1062   if (!flg2) {
1063     flg2 = PETSC_FALSE;
1064     ierr = PetscOptionsGetBool(NULL,"-memory_info",&flg2,NULL);CHKERRQ(ierr);
1065   }
1066   if (flg2) {
1067     ierr = PetscMemoryShowUsage(PETSC_VIEWER_STDOUT_WORLD,"Summary of Memory Usage in PETSc\n");CHKERRQ(ierr);
1068   }
1069 
1070 #if defined(PETSC_USE_LOG)
1071   flg1 = PETSC_FALSE;
1072   ierr = PetscOptionsGetBool(NULL,"-get_total_flops",&flg1,NULL);CHKERRQ(ierr);
1073   if (flg1) {
1074     PetscLogDouble flops = 0;
1075     ierr = MPI_Reduce(&petsc_TotalFlops,&flops,1,MPI_DOUBLE,MPI_SUM,0,PETSC_COMM_WORLD);CHKERRQ(ierr);
1076     ierr = PetscPrintf(PETSC_COMM_WORLD,"Total flops over all processors %g\n",flops);CHKERRQ(ierr);
1077   }
1078 #endif
1079 
1080 
1081 #if defined(PETSC_USE_LOG)
1082 #if defined(PETSC_HAVE_MPE)
1083   mname[0] = 0;
1084 
1085   ierr = PetscOptionsGetString(NULL,"-log_mpe",mname,PETSC_MAX_PATH_LEN,&flg1);CHKERRQ(ierr);
1086   if (flg1) {
1087     if (mname[0]) {ierr = PetscLogMPEDump(mname);CHKERRQ(ierr);}
1088     else          {ierr = PetscLogMPEDump(0);CHKERRQ(ierr);}
1089   }
1090 #endif
1091   mname[0] = 0;
1092 
1093   ierr = PetscOptionsGetString(NULL,"-log_summary",mname,PETSC_MAX_PATH_LEN,&flg1);CHKERRQ(ierr);
1094   if (flg1) {
1095     PetscViewer viewer;
1096     if (mname[0]) {
1097       ierr = PetscViewerASCIIOpen(PETSC_COMM_WORLD,mname,&viewer);CHKERRQ(ierr);
1098       ierr = PetscLogView(viewer);CHKERRQ(ierr);
1099       ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr);
1100     } else {
1101       viewer = PETSC_VIEWER_STDOUT_WORLD;
1102       ierr   = PetscLogView(viewer);CHKERRQ(ierr);
1103     }
1104   }
1105 
1106   mname[0] = 0;
1107 
1108   ierr = PetscOptionsGetString(NULL,"-log_summary_python",mname,PETSC_MAX_PATH_LEN,&flg1);CHKERRQ(ierr);
1109   if (flg1) {
1110     PetscViewer viewer;
1111     if (mname[0]) {
1112       ierr = PetscViewerASCIIOpen(PETSC_COMM_WORLD,mname,&viewer);CHKERRQ(ierr);
1113       ierr = PetscLogViewPython(viewer);CHKERRQ(ierr);
1114       ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr);
1115     } else {
1116       viewer = PETSC_VIEWER_STDOUT_WORLD;
1117       ierr   = PetscLogViewPython(viewer);CHKERRQ(ierr);
1118     }
1119   }
1120 
1121   ierr = PetscOptionsGetString(NULL,"-log_detailed",mname,PETSC_MAX_PATH_LEN,&flg1);CHKERRQ(ierr);
1122   if (flg1) {
1123     if (mname[0])  {ierr = PetscLogPrintDetailed(PETSC_COMM_WORLD,mname);CHKERRQ(ierr);}
1124     else           {ierr = PetscLogPrintDetailed(PETSC_COMM_WORLD,0);CHKERRQ(ierr);}
1125   }
1126 
1127   mname[0] = 0;
1128 
1129   ierr = PetscOptionsGetString(NULL,"-log_all",mname,PETSC_MAX_PATH_LEN,&flg1);CHKERRQ(ierr);
1130   ierr = PetscOptionsGetString(NULL,"-log",mname,PETSC_MAX_PATH_LEN,&flg2);CHKERRQ(ierr);
1131   if (flg1 || flg2) {
1132     if (mname[0]) PetscLogDump(mname);
1133     else          PetscLogDump(0);
1134   }
1135 #endif
1136 
1137   /*
1138      Free all objects registered with PetscObjectRegisterDestroy() such as PETSC_VIEWER_XXX_().
1139   */
1140   ierr = PetscObjectRegisterDestroyAll();CHKERRQ(ierr);
1141 
1142   ierr = PetscStackDestroy();CHKERRQ(ierr);
1143   PetscThreadLocalDestroy((PetscThreadKey)petscstack); /* Deletes pthread_key */
1144 
1145   flg1 = PETSC_FALSE;
1146   ierr = PetscOptionsGetBool(NULL,"-no_signal_handler",&flg1,NULL);CHKERRQ(ierr);
1147   if (!flg1) { ierr = PetscPopSignalHandler();CHKERRQ(ierr);}
1148   flg1 = PETSC_FALSE;
1149   ierr = PetscOptionsGetBool(NULL,"-mpidump",&flg1,NULL);CHKERRQ(ierr);
1150   if (flg1) {
1151     ierr = PetscMPIDump(stdout);CHKERRQ(ierr);
1152   }
1153   flg1 = PETSC_FALSE;
1154   flg2 = PETSC_FALSE;
1155   /* preemptive call to avoid listing this option in options table as unused */
1156   ierr = PetscOptionsHasName(NULL,"-malloc_dump",&flg1);CHKERRQ(ierr);
1157   ierr = PetscOptionsHasName(NULL,"-objects_dump",&flg1);CHKERRQ(ierr);
1158   ierr = PetscOptionsGetBool(NULL,"-options_table",&flg2,NULL);CHKERRQ(ierr);
1159 
1160   if (flg2) {
1161     PetscViewer viewer;
1162     ierr = PetscViewerASCIIGetStdout(PETSC_COMM_WORLD,&viewer);CHKERRQ(ierr);
1163     ierr = PetscOptionsView(viewer);CHKERRQ(ierr);
1164     ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr);
1165   }
1166 
1167   /* to prevent PETSc -options_left from warning */
1168   ierr = PetscOptionsHasName(NULL,"-nox",&flg1);CHKERRQ(ierr);
1169   ierr = PetscOptionsHasName(NULL,"-nox_warning",&flg1);CHKERRQ(ierr);
1170 
1171   if (!PetscHMPIWorker) { /* worker processes skip this because they do not usually process options */
1172     flg3 = PETSC_FALSE; /* default value is required */
1173     ierr = PetscOptionsGetBool(NULL,"-options_left",&flg3,&flg1);CHKERRQ(ierr);
1174     ierr = PetscOptionsAllUsed(&nopt);CHKERRQ(ierr);
1175     if (flg3) {
1176       if (!flg2) { /* have not yet printed the options */
1177         PetscViewer viewer;
1178         ierr = PetscViewerASCIIGetStdout(PETSC_COMM_WORLD,&viewer);CHKERRQ(ierr);
1179         ierr = PetscOptionsView(viewer);CHKERRQ(ierr);
1180         ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr);
1181       }
1182       if (!nopt) {
1183         ierr = PetscPrintf(PETSC_COMM_WORLD,"There are no unused options.\n");CHKERRQ(ierr);
1184       } else if (nopt == 1) {
1185         ierr = PetscPrintf(PETSC_COMM_WORLD,"There is one unused database option. It is:\n");CHKERRQ(ierr);
1186       } else {
1187         ierr = PetscPrintf(PETSC_COMM_WORLD,"There are %D unused database options. They are:\n",nopt);CHKERRQ(ierr);
1188       }
1189     }
1190 #if defined(PETSC_USE_DEBUG)
1191     if (nopt && !flg3 && !flg1) {
1192       ierr = PetscPrintf(PETSC_COMM_WORLD,"WARNING! There are options you set that were not used!\n");CHKERRQ(ierr);
1193       ierr = PetscPrintf(PETSC_COMM_WORLD,"WARNING! could be spelling mistake, etc!\n");CHKERRQ(ierr);
1194       ierr = PetscOptionsLeft();CHKERRQ(ierr);
1195     } else if (nopt && flg3) {
1196 #else
1197     if (nopt && flg3) {
1198 #endif
1199       ierr = PetscOptionsLeft();CHKERRQ(ierr);
1200     }
1201   }
1202 
1203 #if defined(PETSC_HAVE_SAWS)
1204   if (!PetscGlobalRank) {
1205     ierr = PetscStackSAWsViewOff();CHKERRQ(ierr);
1206     PetscStackCallSAWs(SAWs_Finalize,());
1207   }
1208 #endif
1209 
1210   {
1211     PetscThreadComm tcomm_world;
1212     ierr = PetscGetThreadCommWorld(&tcomm_world);CHKERRQ(ierr);
1213     /* Free global thread communicator */
1214     ierr = PetscThreadCommDestroy(&tcomm_world);CHKERRQ(ierr);
1215   }
1216 
1217   /*
1218        List all objects the user may have forgot to free
1219   */
1220   ierr = PetscOptionsHasName(NULL,"-objects_dump",&flg1);CHKERRQ(ierr);
1221   if (flg1) {
1222     MPI_Comm local_comm;
1223     char     string[64];
1224 
1225     ierr = PetscOptionsGetString(NULL,"-objects_dump",string,64,NULL);CHKERRQ(ierr);
1226     ierr = MPI_Comm_dup(MPI_COMM_WORLD,&local_comm);CHKERRQ(ierr);
1227     ierr = PetscSequentialPhaseBegin_Private(local_comm,1);CHKERRQ(ierr);
1228     ierr = PetscObjectsDump(stdout,(string[0] == 'a') ? PETSC_TRUE : PETSC_FALSE);CHKERRQ(ierr);
1229     ierr = PetscSequentialPhaseEnd_Private(local_comm,1);CHKERRQ(ierr);
1230     ierr = MPI_Comm_free(&local_comm);CHKERRQ(ierr);
1231   }
1232   PetscObjectsCounts    = 0;
1233   PetscObjectsMaxCounts = 0;
1234 
1235   ierr = PetscFree(PetscObjects);CHKERRQ(ierr);
1236 
1237 #if defined(PETSC_USE_LOG)
1238   ierr = PetscLogDestroy();CHKERRQ(ierr);
1239 #endif
1240 
1241   /*
1242      Destroy any packages that registered a finalize
1243   */
1244   ierr = PetscRegisterFinalizeAll();CHKERRQ(ierr);
1245 
1246   /*
1247      Destroy all the function registration lists created
1248   */
1249   ierr = PetscFinalize_DynamicLibraries();CHKERRQ(ierr);
1250 
1251   /*
1252      Print PetscFunctionLists that have not been properly freed
1253 
1254   ierr = PetscFunctionListPrintAll();CHKERRQ(ierr);
1255   */
1256 
1257   if (petsc_history) {
1258     ierr = PetscCloseHistoryFile(&petsc_history);CHKERRQ(ierr);
1259     petsc_history = 0;
1260   }
1261 
1262   ierr = PetscInfoAllow(PETSC_FALSE,NULL);CHKERRQ(ierr);
1263 
1264   {
1265     char fname[PETSC_MAX_PATH_LEN];
1266     FILE *fd;
1267     int  err;
1268 
1269     fname[0] = 0;
1270 
1271     ierr = PetscOptionsGetString(NULL,"-malloc_dump",fname,250,&flg1);CHKERRQ(ierr);
1272     flg2 = PETSC_FALSE;
1273     ierr = PetscOptionsGetBool(NULL,"-malloc_test",&flg2,NULL);CHKERRQ(ierr);
1274 #if defined(PETSC_USE_DEBUG)
1275     if (PETSC_RUNNING_ON_VALGRIND) flg2 = PETSC_FALSE;
1276 #else
1277     flg2 = PETSC_FALSE;         /* Skip reporting for optimized builds regardless of -malloc_test */
1278 #endif
1279     if (flg1 && fname[0]) {
1280       char sname[PETSC_MAX_PATH_LEN];
1281 
1282       sprintf(sname,"%s_%d",fname,rank);
1283       fd   = fopen(sname,"w"); if (!fd) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_FILE_OPEN,"Cannot open log file: %s",sname);
1284       ierr = PetscMallocDump(fd);CHKERRQ(ierr);
1285       err  = fclose(fd);
1286       if (err) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SYS,"fclose() failed on file");
1287     } else if (flg1 || flg2) {
1288       MPI_Comm local_comm;
1289 
1290       ierr = MPI_Comm_dup(MPI_COMM_WORLD,&local_comm);CHKERRQ(ierr);
1291       ierr = PetscSequentialPhaseBegin_Private(local_comm,1);CHKERRQ(ierr);
1292       ierr = PetscMallocDump(stdout);CHKERRQ(ierr);
1293       ierr = PetscSequentialPhaseEnd_Private(local_comm,1);CHKERRQ(ierr);
1294       ierr = MPI_Comm_free(&local_comm);CHKERRQ(ierr);
1295     }
1296   }
1297 
1298   {
1299     char fname[PETSC_MAX_PATH_LEN];
1300     FILE *fd = NULL;
1301 
1302     fname[0] = 0;
1303 
1304     ierr = PetscOptionsGetString(NULL,"-malloc_log",fname,250,&flg1);CHKERRQ(ierr);
1305     ierr = PetscOptionsHasName(NULL,"-malloc_log_threshold",&flg2);CHKERRQ(ierr);
1306     if (flg1 && fname[0]) {
1307       int err;
1308 
1309       if (!rank) {
1310         fd = fopen(fname,"w");
1311         if (!fd) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_FILE_OPEN,"Cannot open log file: %s",fname);
1312       }
1313       ierr = PetscMallocDumpLog(fd);CHKERRQ(ierr);
1314       if (fd) {
1315         err = fclose(fd);
1316         if (err) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SYS,"fclose() failed on file");
1317       }
1318     } else if (flg1 || flg2) {
1319       ierr = PetscMallocDumpLog(stdout);CHKERRQ(ierr);
1320     }
1321   }
1322   /* Can be destroyed only after all the options are used */
1323   ierr = PetscOptionsDestroy();CHKERRQ(ierr);
1324 
1325   PetscGlobalArgc = 0;
1326   PetscGlobalArgs = 0;
1327 
1328 #if defined(PETSC_USE_REAL___FLOAT128)
1329   ierr = MPI_Type_free(&MPIU___FLOAT128);CHKERRQ(ierr);
1330 #if defined(PETSC_HAVE_COMPLEX)
1331   ierr = MPI_Type_free(&MPIU___COMPLEX128);CHKERRQ(ierr);
1332 #endif
1333   ierr = MPI_Op_free(&MPIU_MAX);CHKERRQ(ierr);
1334   ierr = MPI_Op_free(&MPIU_MIN);CHKERRQ(ierr);
1335 #endif
1336 
1337 #if defined(PETSC_HAVE_COMPLEX)
1338 #if !defined(PETSC_HAVE_MPI_C_DOUBLE_COMPLEX)
1339   ierr = MPI_Type_free(&MPIU_C_DOUBLE_COMPLEX);CHKERRQ(ierr);
1340   ierr = MPI_Type_free(&MPIU_C_COMPLEX);CHKERRQ(ierr);
1341 #endif
1342 #endif
1343 
1344 #if (defined(PETSC_HAVE_COMPLEX) && !defined(PETSC_HAVE_MPI_C_DOUBLE_COMPLEX)) || defined(PETSC_USE_REAL___FLOAT128)
1345   ierr = MPI_Op_free(&MPIU_SUM);CHKERRQ(ierr);
1346 #endif
1347 
1348   ierr = MPI_Type_free(&MPIU_2SCALAR);CHKERRQ(ierr);
1349 #if defined(PETSC_USE_64BIT_INDICES) || !defined(MPI_2INT)
1350   ierr = MPI_Type_free(&MPIU_2INT);CHKERRQ(ierr);
1351 #endif
1352   ierr = MPI_Op_free(&PetscMaxSum_Op);CHKERRQ(ierr);
1353   ierr = MPI_Op_free(&PetscADMax_Op);CHKERRQ(ierr);
1354   ierr = MPI_Op_free(&PetscADMin_Op);CHKERRQ(ierr);
1355 
1356   /*
1357      Destroy any known inner MPI_Comm's and attributes pointing to them
1358      Note this will not destroy any new communicators the user has created.
1359 
1360      If all PETSc objects were not destroyed those left over objects will have hanging references to
1361      the MPI_Comms that were freed; but that is ok because those PETSc objects will never be used again
1362  */
1363   {
1364     PetscCommCounter *counter;
1365     PetscMPIInt      flg;
1366     MPI_Comm         icomm;
1367     union {MPI_Comm comm; void *ptr;} ucomm;
1368     ierr = MPI_Attr_get(PETSC_COMM_SELF,Petsc_InnerComm_keyval,&ucomm,&flg);CHKERRQ(ierr);
1369     if (flg) {
1370       icomm = ucomm.comm;
1371       ierr = MPI_Attr_get(icomm,Petsc_Counter_keyval,&counter,&flg);CHKERRQ(ierr);
1372       if (!flg) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_CORRUPT,"Inner MPI_Comm does not have expected tag/name counter, problem with corrupted memory");
1373 
1374       ierr = MPI_Attr_delete(PETSC_COMM_SELF,Petsc_InnerComm_keyval);CHKERRQ(ierr);
1375       ierr = MPI_Attr_delete(icomm,Petsc_Counter_keyval);CHKERRQ(ierr);
1376       ierr = MPI_Comm_free(&icomm);CHKERRQ(ierr);
1377     }
1378     ierr = MPI_Attr_get(PETSC_COMM_WORLD,Petsc_InnerComm_keyval,&ucomm,&flg);CHKERRQ(ierr);
1379     if (flg) {
1380       icomm = ucomm.comm;
1381       ierr = MPI_Attr_get(icomm,Petsc_Counter_keyval,&counter,&flg);CHKERRQ(ierr);
1382       if (!flg) SETERRQ(PETSC_COMM_WORLD,PETSC_ERR_ARG_CORRUPT,"Inner MPI_Comm does not have expected tag/name counter, problem with corrupted memory");
1383 
1384       ierr = MPI_Attr_delete(PETSC_COMM_WORLD,Petsc_InnerComm_keyval);CHKERRQ(ierr);
1385       ierr = MPI_Attr_delete(icomm,Petsc_Counter_keyval);CHKERRQ(ierr);
1386       ierr = MPI_Comm_free(&icomm);CHKERRQ(ierr);
1387     }
1388   }
1389 
1390   ierr = MPI_Keyval_free(&Petsc_Counter_keyval);CHKERRQ(ierr);
1391   ierr = MPI_Keyval_free(&Petsc_InnerComm_keyval);CHKERRQ(ierr);
1392   ierr = MPI_Keyval_free(&Petsc_OuterComm_keyval);CHKERRQ(ierr);
1393 
1394 #if defined(PETSC_HAVE_CUDA)
1395   {
1396     PetscInt p;
1397     for (p = 0; p < PetscGlobalSize; ++p) {
1398       if (p == PetscGlobalRank) cublasShutdown();
1399       ierr = MPI_Barrier(PETSC_COMM_WORLD);CHKERRQ(ierr);
1400     }
1401   }
1402 #endif
1403 
1404   if (PetscBeganMPI) {
1405 #if defined(PETSC_HAVE_MPI_FINALIZED)
1406     PetscMPIInt flag;
1407     ierr = MPI_Finalized(&flag);CHKERRQ(ierr);
1408     if (flag) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_LIB,"MPI_Finalize() has already been called, even though MPI_Init() was called by PetscInitialize()");
1409 #endif
1410     ierr = MPI_Finalize();CHKERRQ(ierr);
1411   }
1412 /*
1413 
1414      Note: In certain cases PETSC_COMM_WORLD is never MPI_Comm_free()ed because
1415    the communicator has some outstanding requests on it. Specifically if the
1416    flag PETSC_HAVE_BROKEN_REQUEST_FREE is set (for IBM MPI implementation). See
1417    src/vec/utils/vpscat.c. Due to this the memory allocated in PetscCommDuplicate()
1418    is never freed as it should be. Thus one may obtain messages of the form
1419    [ 1] 8 bytes PetscCommDuplicate() line 645 in src/sys/mpiu.c indicating the
1420    memory was not freed.
1421 
1422 */
1423   ierr = PetscMallocClear();CHKERRQ(ierr);
1424 
1425   PetscInitializeCalled = PETSC_FALSE;
1426   PetscFinalizeCalled   = PETSC_TRUE;
1427   PetscFunctionReturn(ierr);
1428 }
1429 
1430 #if defined(PETSC_MISSING_LAPACK_lsame_)
1431 PETSC_EXTERN int lsame_(char *a,char *b)
1432 {
1433   if (*a == *b) return 1;
1434   if (*a + 32 == *b) return 1;
1435   if (*a - 32 == *b) return 1;
1436   return 0;
1437 }
1438 #endif
1439 
1440 #if defined(PETSC_MISSING_LAPACK_lsame)
1441 PETSC_EXTERN int lsame(char *a,char *b)
1442 {
1443   if (*a == *b) return 1;
1444   if (*a + 32 == *b) return 1;
1445   if (*a - 32 == *b) return 1;
1446   return 0;
1447 }
1448 #endif
1449