xref: /petsc/src/sys/objects/pinit.c (revision 55d657ee600a968eeb2e88647dd80b72fe3bda1d)
17d0a6c19SBarry Smith 
2e5c89e4eSSatish Balay /*
3e5c89e4eSSatish Balay    This file defines the initialization of PETSc, including PetscInitialize()
4e5c89e4eSSatish Balay */
5af0996ceSBarry Smith #include <petsc/private/petscimpl.h>        /*I  "petscsys.h"   I*/
6022afb99SBarry Smith #include <petscvalgrind.h>
7665c2dedSJed Brown #include <petscviewer.h>
88101f56cSMatthew Knepley 
9a9f03627SSatish Balay #if defined(PETSC_USE_LOG)
10896238b9SBarry Smith extern PetscErrorCode PetscLogInitialize(void);
11a9f03627SSatish Balay #endif
12f2d66bcaSShri Abhyankar 
132d53ad75SBarry Smith #if defined(PETSC_SERIALIZE_FUNCTIONS)
142d53ad75SBarry Smith PetscFPT PetscFPTData = 0;
152d53ad75SBarry Smith #endif
162d53ad75SBarry Smith 
17a6790183SBarry Smith #if defined(PETSC_HAVE_SAWS)
1816ad0300SBarry Smith #include <petscviewersaws.h>
19a6790183SBarry Smith #endif
20e5c89e4eSSatish Balay /* -----------------------------------------------------------------------------------------*/
21e5c89e4eSSatish Balay 
22e5c89e4eSSatish Balay extern FILE *petsc_history;
23e5c89e4eSSatish Balay 
2409573ac7SBarry Smith extern PetscErrorCode PetscInitialize_DynamicLibraries(void);
2509573ac7SBarry Smith extern PetscErrorCode PetscFinalize_DynamicLibraries(void);
2637e93019SBarry Smith extern PetscErrorCode PetscFunctionListPrintAll(void);
2709573ac7SBarry Smith extern PetscErrorCode PetscSequentialPhaseBegin_Private(MPI_Comm,int);
2809573ac7SBarry Smith extern PetscErrorCode PetscSequentialPhaseEnd_Private(MPI_Comm,int);
2909573ac7SBarry Smith extern PetscErrorCode PetscCloseHistoryFile(FILE**);
300069ddf5SShri Abhyankar 
31e5c89e4eSSatish Balay /* user may set this BEFORE calling PetscInitialize() */
32e8373e55SMatthew Knepley MPI_Comm PETSC_COMM_WORLD = MPI_COMM_NULL;
33e5c89e4eSSatish Balay 
34480cf27aSJed Brown PetscMPIInt Petsc_Counter_keyval   = MPI_KEYVAL_INVALID;
35480cf27aSJed Brown PetscMPIInt Petsc_InnerComm_keyval = MPI_KEYVAL_INVALID;
36480cf27aSJed Brown PetscMPIInt Petsc_OuterComm_keyval = MPI_KEYVAL_INVALID;
3742218b76SBarry Smith PetscMPIInt Petsc_Shared_keyval    = MPI_KEYVAL_INVALID;
38480cf27aSJed Brown 
39e5c89e4eSSatish Balay /*
40e5c89e4eSSatish Balay      Declare and set all the string names of the PETSc enums
41e5c89e4eSSatish Balay */
426a6fc655SJed Brown const char *const PetscBools[]     = {"FALSE","TRUE","PetscBool","PETSC_",0};
436a6fc655SJed Brown const char *const PetscCopyModes[] = {"COPY_VALUES","OWN_POINTER","USE_POINTER","PetscCopyMode","PETSC_",0};
446a6fc655SJed Brown const char *const PetscDataTypes[] = {"INT","DOUBLE","COMPLEX","LONG","SHORT","FLOAT",
452d53ad75SBarry Smith                                       "CHAR","LOGICAL","ENUM","BOOL","LONGDOUBLE","OBJECT","FUNCTION","PetscDataType","PETSC_",0};
46e5c89e4eSSatish Balay 
47ace3abfcSBarry Smith PetscBool PetscPreLoadingUsed = PETSC_FALSE;
48ace3abfcSBarry Smith PetscBool PetscPreLoadingOn   = PETSC_FALSE;
490f8e0872SSatish Balay 
50a2f94806SJed Brown PetscInt PetscHotRegionDepth;
51a2f94806SJed Brown 
52b22622e2STadeu Manoel #if defined(PETSC_HAVE_THREADSAFETY)
53b22622e2STadeu Manoel PetscSpinlock PetscViewerASCIISpinLockOpen;
54b22622e2STadeu Manoel PetscSpinlock PetscViewerASCIISpinLockStdout;
55b22622e2STadeu Manoel PetscSpinlock PetscViewerASCIISpinLockStderr;
56b22622e2STadeu Manoel PetscSpinlock PetscCommSpinLock;
57b22622e2STadeu Manoel #endif
58b22622e2STadeu Manoel 
59e5c89e4eSSatish Balay /*
60e5c89e4eSSatish Balay        Checks the options database for initializations related to the
61e5c89e4eSSatish Balay     PETSc components
62e5c89e4eSSatish Balay */
637087cfbeSBarry Smith PetscErrorCode  PetscOptionsCheckInitial_Components(void)
64e5c89e4eSSatish Balay {
65ace3abfcSBarry Smith   PetscBool      flg1;
66e5c89e4eSSatish Balay   PetscErrorCode ierr;
67e5c89e4eSSatish Balay 
68e5c89e4eSSatish Balay   PetscFunctionBegin;
69c5929fdfSBarry Smith   ierr = PetscOptionsHasName(NULL,NULL,"-help",&flg1);CHKERRQ(ierr);
70e5c89e4eSSatish Balay   if (flg1) {
71e5c89e4eSSatish Balay #if defined(PETSC_USE_LOG)
72e8e7597cSSatish Balay     MPI_Comm comm = PETSC_COMM_WORLD;
73e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm,"------Additional PETSc component options--------\n");CHKERRQ(ierr);
748e81d068SLisandro Dalcin     ierr = (*PetscHelpPrintf)(comm," -log_exclude: <vec,mat,pc,ksp,snes,tao,ts>\n");CHKERRQ(ierr);
758e81d068SLisandro Dalcin     ierr = (*PetscHelpPrintf)(comm," -info_exclude: <null,vec,mat,pc,ksp,snes,tao,ts>\n");CHKERRQ(ierr);
76e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm,"-----------------------------------------------\n");CHKERRQ(ierr);
77e5c89e4eSSatish Balay #endif
78e5c89e4eSSatish Balay   }
79e5c89e4eSSatish Balay   PetscFunctionReturn(0);
80e5c89e4eSSatish Balay }
81e5c89e4eSSatish Balay 
820f11a792SBarry Smith /*
83945d1669SBarry Smith       PetscInitializeNoPointers - Calls PetscInitialize() from C/C++ without the pointers to argc and args
8472a42c3cSBarry Smith 
8572a42c3cSBarry Smith    Collective
8672a42c3cSBarry Smith 
8772a42c3cSBarry Smith    Level: advanced
8872a42c3cSBarry Smith 
8995452b02SPatrick Sanan     Notes:
90a56f64adSBarry Smith     this is called only by the PETSc Julia interface. Even though it might start MPI it sets the flag to
910f11a792SBarry Smith      indicate that it did NOT start MPI so that the PetscFinalize() does not end MPI, thus allowing PetscInitialize() to
92a56f64adSBarry Smith      be called multiple times from Julia without the problem of trying to initialize MPI more than once.
930f11a792SBarry Smith 
94a56f64adSBarry Smith      Developer Note: Turns off PETSc signal handling to allow Julia to manage signals
951ea5a559SBarry Smith 
9672a42c3cSBarry Smith .seealso: PetscInitialize(), PetscInitializeFortran(), PetscInitializeNoArguments()
970f11a792SBarry Smith */
98945d1669SBarry Smith PetscErrorCode  PetscInitializeNoPointers(int argc,char **args,const char *filename,const char *help)
9972a42c3cSBarry Smith {
10072a42c3cSBarry Smith   PetscErrorCode ierr;
10172a42c3cSBarry Smith   int            myargc   = argc;
10272a42c3cSBarry Smith   char           **myargs = args;
10372a42c3cSBarry Smith 
10472a42c3cSBarry Smith   PetscFunctionBegin;
1053bf036e2SBarry Smith   ierr = PetscInitialize(&myargc,&myargs,filename,help);CHKERRQ(ierr);
1061ea5a559SBarry Smith   ierr = PetscPopSignalHandler();CHKERRQ(ierr);
107df413903SBarry Smith   PetscBeganMPI = PETSC_FALSE;
10872a42c3cSBarry Smith   PetscFunctionReturn(ierr);
10972a42c3cSBarry Smith }
11072a42c3cSBarry Smith 
111f0865b08SBarry Smith /*
112a56f64adSBarry Smith       Used by Julia interface to get communicator
113f0865b08SBarry Smith */
114945d1669SBarry Smith PetscErrorCode  PetscGetPETSC_COMM_SELF(MPI_Comm *comm)
115f0865b08SBarry Smith {
116f0865b08SBarry Smith   PetscFunctionBegin;
117f0865b08SBarry Smith   *comm = PETSC_COMM_SELF;
118f0865b08SBarry Smith   PetscFunctionReturn(0);
119f0865b08SBarry Smith }
120f0865b08SBarry Smith 
121e5c89e4eSSatish Balay /*@C
122e5c89e4eSSatish Balay       PetscInitializeNoArguments - Calls PetscInitialize() from C/C++ without
123e5c89e4eSSatish Balay         the command line arguments.
124e5c89e4eSSatish Balay 
125e5c89e4eSSatish Balay    Collective
126e5c89e4eSSatish Balay 
127e5c89e4eSSatish Balay    Level: advanced
128e5c89e4eSSatish Balay 
129e5c89e4eSSatish Balay .seealso: PetscInitialize(), PetscInitializeFortran()
130e5c89e4eSSatish Balay @*/
1317087cfbeSBarry Smith PetscErrorCode  PetscInitializeNoArguments(void)
132e5c89e4eSSatish Balay {
133e5c89e4eSSatish Balay   PetscErrorCode ierr;
134e5c89e4eSSatish Balay   int            argc   = 0;
135e5c89e4eSSatish Balay   char           **args = 0;
136e5c89e4eSSatish Balay 
137e5c89e4eSSatish Balay   PetscFunctionBegin;
1380298fd71SBarry Smith   ierr = PetscInitialize(&argc,&args,NULL,NULL);
139e5c89e4eSSatish Balay   PetscFunctionReturn(ierr);
140e5c89e4eSSatish Balay }
141e5c89e4eSSatish Balay 
142e5c89e4eSSatish Balay /*@
143e5c89e4eSSatish Balay       PetscInitialized - Determine whether PETSc is initialized.
144e5c89e4eSSatish Balay 
14593b6d2d1SJed Brown    Level: beginner
146e5c89e4eSSatish Balay 
147e5c89e4eSSatish Balay .seealso: PetscInitialize(), PetscInitializeNoArguments(), PetscInitializeFortran()
148e5c89e4eSSatish Balay @*/
1497087cfbeSBarry Smith PetscErrorCode PetscInitialized(PetscBool  *isInitialized)
150e5c89e4eSSatish Balay {
151e5c89e4eSSatish Balay   *isInitialized = PetscInitializeCalled;
15293b6d2d1SJed Brown   return 0;
153e5c89e4eSSatish Balay }
154e5c89e4eSSatish Balay 
155e5c89e4eSSatish Balay /*@
156e5c89e4eSSatish Balay       PetscFinalized - Determine whether PetscFinalize() has been called yet
157e5c89e4eSSatish Balay 
158e5c89e4eSSatish Balay    Level: developer
159e5c89e4eSSatish Balay 
160e5c89e4eSSatish Balay .seealso: PetscInitialize(), PetscInitializeNoArguments(), PetscInitializeFortran()
161e5c89e4eSSatish Balay @*/
1627087cfbeSBarry Smith PetscErrorCode  PetscFinalized(PetscBool  *isFinalized)
163e5c89e4eSSatish Balay {
164e5c89e4eSSatish Balay   *isFinalized = PetscFinalizeCalled;
16593b6d2d1SJed Brown   return 0;
166e5c89e4eSSatish Balay }
167e5c89e4eSSatish Balay 
16809573ac7SBarry Smith extern PetscErrorCode PetscOptionsCheckInitial_Private(void);
169e5c89e4eSSatish Balay 
170e5c89e4eSSatish Balay /*
171e5c89e4eSSatish Balay        This function is the MPI reduction operation used to compute the sum of the
172e5c89e4eSSatish Balay    first half of the datatype and the max of the second half.
173e5c89e4eSSatish Balay */
174367daffbSBarry Smith MPI_Op MPIU_MAXSUM_OP = 0;
175e5c89e4eSSatish Balay 
176367daffbSBarry Smith PETSC_INTERN void MPIAPI MPIU_MaxSum_Local(void *in,void *out,int *cnt,MPI_Datatype *datatype)
177e5c89e4eSSatish Balay {
178e5c89e4eSSatish Balay   PetscInt *xin = (PetscInt*)in,*xout = (PetscInt*)out,i,count = *cnt;
179e5c89e4eSSatish Balay 
180e5c89e4eSSatish Balay   PetscFunctionBegin;
181e5c89e4eSSatish Balay   if (*datatype != MPIU_2INT) {
182e5c89e4eSSatish Balay     (*PetscErrorPrintf)("Can only handle MPIU_2INT data types");
183e5c89e4eSSatish Balay     MPI_Abort(MPI_COMM_WORLD,1);
184e5c89e4eSSatish Balay   }
185e5c89e4eSSatish Balay 
186e5c89e4eSSatish Balay   for (i=0; i<count; i++) {
187e5c89e4eSSatish Balay     xout[2*i]    = PetscMax(xout[2*i],xin[2*i]);
188e5c89e4eSSatish Balay     xout[2*i+1] += xin[2*i+1];
189e5c89e4eSSatish Balay   }
190812af9f3SBarry Smith   PetscFunctionReturnVoid();
191e5c89e4eSSatish Balay }
192e5c89e4eSSatish Balay 
193e5c89e4eSSatish Balay /*
194e5c89e4eSSatish Balay     Returns the max of the first entry owned by this processor and the
195e5c89e4eSSatish Balay sum of the second entry.
196b693b147SBarry Smith 
19776f543a4SJed Brown     The reason sizes[2*i] contains lengths sizes[2*i+1] contains flag of 1 if length is nonzero
198367daffbSBarry Smith is so that the MPIU_MAXSUM_OP() can set TWO values, if we passed in only sizes[i] with lengths
199b693b147SBarry Smith there would be no place to store the both needed results.
200e5c89e4eSSatish Balay */
20176ec1555SBarry Smith PetscErrorCode  PetscMaxSum(MPI_Comm comm,const PetscInt sizes[],PetscInt *max,PetscInt *sum)
202e5c89e4eSSatish Balay {
203e5c89e4eSSatish Balay   PetscErrorCode ierr;
204e5c89e4eSSatish Balay 
205e5c89e4eSSatish Balay   PetscFunctionBegin;
206d6e4c47cSJed Brown #if defined(PETSC_HAVE_MPI_REDUCE_SCATTER_BLOCK)
207d6e4c47cSJed Brown   {
208d6e4c47cSJed Brown     struct {PetscInt max,sum;} work;
209367daffbSBarry Smith     ierr = MPI_Reduce_scatter_block((void*)sizes,&work,1,MPIU_2INT,MPIU_MAXSUM_OP,comm);CHKERRQ(ierr);
210d6e4c47cSJed Brown     *max = work.max;
211d6e4c47cSJed Brown     *sum = work.sum;
212d6e4c47cSJed Brown   }
213d6e4c47cSJed Brown #else
214d6e4c47cSJed Brown   {
215d6e4c47cSJed Brown     PetscMPIInt    size,rank;
216d6e4c47cSJed Brown     struct {PetscInt max,sum;} *work;
217e5c89e4eSSatish Balay     ierr = MPI_Comm_size(comm,&size);CHKERRQ(ierr);
218e5c89e4eSSatish Balay     ierr = MPI_Comm_rank(comm,&rank);CHKERRQ(ierr);
219785e854fSJed Brown     ierr = PetscMalloc1(size,&work);CHKERRQ(ierr);
220367daffbSBarry Smith     ierr = MPIU_Allreduce((void*)sizes,work,size,MPIU_2INT,MPIU_MAXSUM_OP,comm);CHKERRQ(ierr);
2216ac3741eSJed Brown     *max = work[rank].max;
2226ac3741eSJed Brown     *sum = work[rank].sum;
223e5c89e4eSSatish Balay     ierr = PetscFree(work);CHKERRQ(ierr);
224d6e4c47cSJed Brown   }
225d6e4c47cSJed Brown #endif
226e5c89e4eSSatish Balay   PetscFunctionReturn(0);
227e5c89e4eSSatish Balay }
228e5c89e4eSSatish Balay 
229e5c89e4eSSatish Balay /* ----------------------------------------------------------------------------*/
230e5c89e4eSSatish Balay 
231570b7f6dSBarry Smith #if (defined(PETSC_HAVE_COMPLEX) && !defined(PETSC_HAVE_MPI_C_DOUBLE_COMPLEX)) || defined(PETSC_USE_REAL___FLOAT128) || defined(PETSC_USE_REAL___FP16)
23206a205a8SBarry Smith MPI_Op MPIU_SUM = 0;
233e5c89e4eSSatish Balay 
2348cc058d9SJed Brown PETSC_EXTERN void PetscSum_Local(void *in,void *out,PetscMPIInt *cnt,MPI_Datatype *datatype)
235e5c89e4eSSatish Balay {
236e5c89e4eSSatish Balay   PetscInt i,count = *cnt;
237e5c89e4eSSatish Balay 
238e5c89e4eSSatish Balay   PetscFunctionBegin;
2397c2de775SJed Brown   if (*datatype == MPIU_REAL) {
240e2e03761SBarry Smith     PetscReal *xin = (PetscReal*)in,*xout = (PetscReal*)out;
241a297a907SKarl Rupp     for (i=0; i<count; i++) xout[i] += xin[i];
2427c2de775SJed Brown   }
2437c2de775SJed Brown #if defined(PETSC_HAVE_COMPLEX)
2447c2de775SJed Brown   else if (*datatype == MPIU_COMPLEX) {
2457c2de775SJed Brown     PetscComplex *xin = (PetscComplex*)in,*xout = (PetscComplex*)out;
246a297a907SKarl Rupp     for (i=0; i<count; i++) xout[i] += xin[i];
2477c2de775SJed Brown   }
2487c2de775SJed Brown #endif
2497c2de775SJed Brown   else {
2507c2de775SJed Brown     (*PetscErrorPrintf)("Can only handle MPIU_REAL or MPIU_COMPLEX data types");
251e2e03761SBarry Smith     MPI_Abort(MPI_COMM_WORLD,1);
252e2e03761SBarry Smith   }
253812af9f3SBarry Smith   PetscFunctionReturnVoid();
254e5c89e4eSSatish Balay }
255e5c89e4eSSatish Balay #endif
256e5c89e4eSSatish Balay 
257570b7f6dSBarry Smith #if defined(PETSC_USE_REAL___FLOAT128) || defined(PETSC_USE_REAL___FP16)
258d9822059SBarry Smith MPI_Op MPIU_MAX = 0;
259d9822059SBarry Smith MPI_Op MPIU_MIN = 0;
260d9822059SBarry Smith 
2618cc058d9SJed Brown PETSC_EXTERN void PetscMax_Local(void *in,void *out,PetscMPIInt *cnt,MPI_Datatype *datatype)
262d9822059SBarry Smith {
263d9822059SBarry Smith   PetscInt i,count = *cnt;
264d9822059SBarry Smith 
265d9822059SBarry Smith   PetscFunctionBegin;
2667c2de775SJed Brown   if (*datatype == MPIU_REAL) {
2678c764dc5SJose Roman     PetscReal *xin = (PetscReal*)in,*xout = (PetscReal*)out;
268a297a907SKarl Rupp     for (i=0; i<count; i++) xout[i] = PetscMax(xout[i],xin[i]);
2697c2de775SJed Brown   }
2707c2de775SJed Brown #if defined(PETSC_HAVE_COMPLEX)
2717c2de775SJed Brown   else if (*datatype == MPIU_COMPLEX) {
2727c2de775SJed Brown     PetscComplex *xin = (PetscComplex*)in,*xout = (PetscComplex*)out;
2737c2de775SJed Brown     for (i=0; i<count; i++) {
2747c2de775SJed Brown       xout[i] = PetscRealPartComplex(xout[i])<PetscRealPartComplex(xin[i]) ? xin[i] : xout[i];
2757c2de775SJed Brown     }
2767c2de775SJed Brown   }
2777c2de775SJed Brown #endif
2787c2de775SJed Brown   else {
2797c2de775SJed Brown     (*PetscErrorPrintf)("Can only handle MPIU_REAL or MPIU_COMPLEX data types");
2808c764dc5SJose Roman     MPI_Abort(MPI_COMM_WORLD,1);
2818c764dc5SJose Roman   }
282d9822059SBarry Smith   PetscFunctionReturnVoid();
283d9822059SBarry Smith }
284d9822059SBarry Smith 
2858cc058d9SJed Brown PETSC_EXTERN void PetscMin_Local(void *in,void *out,PetscMPIInt *cnt,MPI_Datatype *datatype)
286d9822059SBarry Smith {
287d9822059SBarry Smith   PetscInt    i,count = *cnt;
288d9822059SBarry Smith 
289d9822059SBarry Smith   PetscFunctionBegin;
2907c2de775SJed Brown   if (*datatype == MPIU_REAL) {
2918c764dc5SJose Roman     PetscReal *xin = (PetscReal*)in,*xout = (PetscReal*)out;
292a297a907SKarl Rupp     for (i=0; i<count; i++) xout[i] = PetscMin(xout[i],xin[i]);
2937c2de775SJed Brown   }
2947c2de775SJed Brown #if defined(PETSC_HAVE_COMPLEX)
2957c2de775SJed Brown   else if (*datatype == MPIU_COMPLEX) {
2967c2de775SJed Brown     PetscComplex *xin = (PetscComplex*)in,*xout = (PetscComplex*)out;
2977c2de775SJed Brown     for (i=0; i<count; i++) {
2987c2de775SJed Brown       xout[i] = PetscRealPartComplex(xout[i])>PetscRealPartComplex(xin[i]) ? xin[i] : xout[i];
2997c2de775SJed Brown     }
3007c2de775SJed Brown   }
3017c2de775SJed Brown #endif
3027c2de775SJed Brown   else {
3038c764dc5SJose Roman     (*PetscErrorPrintf)("Can only handle MPIU_REAL or MPIU_SCALAR data (i.e. double or complex) types");
3048c764dc5SJose Roman     MPI_Abort(MPI_COMM_WORLD,1);
3058c764dc5SJose Roman   }
306d9822059SBarry Smith   PetscFunctionReturnVoid();
307d9822059SBarry Smith }
308d9822059SBarry Smith #endif
309d9822059SBarry Smith 
310480cf27aSJed Brown /*
311480cf27aSJed Brown    Private routine to delete internal tag/name counter storage when a communicator is freed.
312480cf27aSJed Brown 
313ff0e51ddSBarry Smith    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.
314480cf27aSJed Brown 
31512801b39SBarry Smith    Note: this is declared extern "C" because it is passed to MPI_Comm_create_keyval()
316480cf27aSJed Brown 
317480cf27aSJed Brown */
3188cc058d9SJed Brown PETSC_EXTERN PetscMPIInt MPIAPI Petsc_DelCounter(MPI_Comm comm,PetscMPIInt keyval,void *count_val,void *extra_state)
319480cf27aSJed Brown {
320480cf27aSJed Brown   PetscErrorCode ierr;
321480cf27aSJed Brown 
322480cf27aSJed Brown   PetscFunctionBegin;
32312801b39SBarry Smith   ierr = PetscInfo1(0,"Deleting counter data in an MPI_Comm %ld\n",(long)comm);CHKERRMPI(ierr);
32412801b39SBarry Smith   ierr = PetscFree(count_val);CHKERRMPI(ierr);
325480cf27aSJed Brown   PetscFunctionReturn(MPI_SUCCESS);
326480cf27aSJed Brown }
327480cf27aSJed Brown 
328480cf27aSJed Brown /*
32947435625SJed Brown   This is invoked on the outer comm as a result of either PetscCommDestroy() (via MPI_Comm_delete_attr) or when the user
330da3039f7SJed Brown   calls MPI_Comm_free().
331da3039f7SJed Brown 
332da3039f7SJed Brown   This is the only entry point for breaking the links between inner and outer comms.
333480cf27aSJed Brown 
334ff0e51ddSBarry Smith   This is called by MPI, not by users. This is called when MPI_Comm_free() is called on the communicator.
335480cf27aSJed Brown 
33612801b39SBarry Smith   Note: this is declared extern "C" because it is passed to MPI_Comm_create_keyval()
337480cf27aSJed Brown 
338480cf27aSJed Brown */
339da3039f7SJed Brown PETSC_EXTERN PetscMPIInt MPIAPI Petsc_DelComm_Outer(MPI_Comm comm,PetscMPIInt keyval,void *attr_val,void *extra_state)
340480cf27aSJed Brown {
341480cf27aSJed Brown   PetscErrorCode                    ierr;
342b89831e5SBarry Smith   PetscMPIInt                       flg;
343265f3f35SJed Brown   union {MPI_Comm comm; void *ptr;} icomm,ocomm;
344480cf27aSJed Brown 
345480cf27aSJed Brown   PetscFunctionBegin;
34612801b39SBarry Smith   if (keyval != Petsc_InnerComm_keyval) SETERRMPI(PETSC_COMM_SELF,PETSC_ERR_ARG_CORRUPT,"Unexpected keyval");
347ec4fadc2SJed Brown   icomm.ptr = attr_val;
348da3039f7SJed Brown 
34947435625SJed Brown   ierr = MPI_Comm_get_attr(icomm.comm,Petsc_OuterComm_keyval,&ocomm,&flg);CHKERRMPI(ierr);
35012801b39SBarry Smith   if (!flg) SETERRMPI(PETSC_COMM_SELF,PETSC_ERR_ARG_CORRUPT,"Inner MPI_Comm does not have expected reference to outer comm");
35112801b39SBarry Smith   if (ocomm.comm != comm) SETERRMPI(PETSC_COMM_SELF,PETSC_ERR_ARG_CORRUPT,"Inner MPI_Comm has reference to non-matching outer comm");
35247435625SJed Brown   ierr = MPI_Comm_delete_attr(icomm.comm,Petsc_OuterComm_keyval);CHKERRMPI(ierr);
35312801b39SBarry Smith   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);
354da3039f7SJed Brown   PetscFunctionReturn(MPI_SUCCESS);
355b89831e5SBarry Smith }
356da3039f7SJed Brown 
357da3039f7SJed Brown /*
35847435625SJed Brown  * This is invoked on the inner comm when Petsc_DelComm_Outer calls MPI_Comm_delete_attr.  It should not be reached any other way.
359da3039f7SJed Brown  */
360da3039f7SJed Brown PETSC_EXTERN PetscMPIInt MPIAPI Petsc_DelComm_Inner(MPI_Comm comm,PetscMPIInt keyval,void *attr_val,void *extra_state)
361da3039f7SJed Brown {
362da3039f7SJed Brown   PetscErrorCode ierr;
363da3039f7SJed Brown 
364da3039f7SJed Brown   PetscFunctionBegin;
36512801b39SBarry Smith   ierr = PetscInfo1(0,"Removing reference to PETSc communicator embedded in a user MPI_Comm %ld\n",(long)comm);CHKERRMPI(ierr);
366480cf27aSJed Brown   PetscFunctionReturn(MPI_SUCCESS);
367480cf27aSJed Brown }
368480cf27aSJed Brown 
36942218b76SBarry Smith PETSC_EXTERN PetscMPIInt MPIAPI Petsc_DelShared(MPI_Comm,PetscMPIInt,void *,void *);
37042218b76SBarry Smith 
371951e3c8eSBarry Smith #if defined(PETSC_USE_PETSC_MPI_EXTERNAL32)
372e39fd77fSBarry Smith #if !defined(PETSC_WORDS_BIGENDIAN)
3738cc058d9SJed Brown PETSC_EXTERN PetscMPIInt PetscDataRep_extent_fn(MPI_Datatype,MPI_Aint*,void*);
3748cc058d9SJed Brown PETSC_EXTERN PetscMPIInt PetscDataRep_read_conv_fn(void*, MPI_Datatype,PetscMPIInt,void*,MPI_Offset,void*);
3758cc058d9SJed Brown PETSC_EXTERN PetscMPIInt PetscDataRep_write_conv_fn(void*, MPI_Datatype,PetscMPIInt,void*,MPI_Offset,void*);
376e39fd77fSBarry Smith #endif
377951e3c8eSBarry Smith #endif
378e39fd77fSBarry Smith 
37912801b39SBarry Smith PetscMPIInt PETSC_MPI_ERROR_CLASS,PETSC_MPI_ERROR_CODE;
38012801b39SBarry Smith 
3816ae9a8a6SBarry Smith int  PetscGlobalArgc   = 0;
3826ae9a8a6SBarry Smith char **PetscGlobalArgs = 0;
383dff31646SBarry Smith PetscSegBuffer PetscCitationsList;
384e5c89e4eSSatish Balay 
385dd63322aSSatish Balay PetscErrorCode PetscCitationsInitialize(void)
386051e4cf2SJed Brown {
387051e4cf2SJed Brown   PetscErrorCode ierr;
388051e4cf2SJed Brown 
389051e4cf2SJed Brown   PetscFunctionBegin;
390051e4cf2SJed Brown   ierr = PetscSegBufferCreate(1,10000,&PetscCitationsList);CHKERRQ(ierr);
391f191ac77SSatish Balay   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);
392051e4cf2SJed Brown   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);
393051e4cf2SJed Brown   PetscFunctionReturn(0);
394051e4cf2SJed Brown }
395e5c89e4eSSatish Balay 
396e5c89e4eSSatish Balay /*@C
397e5c89e4eSSatish Balay    PetscGetArgs - Allows you to access the raw command line arguments anywhere
398e5c89e4eSSatish Balay      after PetscInitialize() is called but before PetscFinalize().
399e5c89e4eSSatish Balay 
400e5c89e4eSSatish Balay    Not Collective
401e5c89e4eSSatish Balay 
402e5c89e4eSSatish Balay    Output Parameters:
403e5c89e4eSSatish Balay +  argc - count of number of command line arguments
404e5c89e4eSSatish Balay -  args - the command line arguments
405e5c89e4eSSatish Balay 
406e5c89e4eSSatish Balay    Level: intermediate
407e5c89e4eSSatish Balay 
408e5c89e4eSSatish Balay    Notes:
409e5c89e4eSSatish Balay       This is usually used to pass the command line arguments into other libraries
410e5c89e4eSSatish Balay    that are called internally deep in PETSc or the application.
411e5c89e4eSSatish Balay 
412f177e3b1SBarry Smith       The first argument contains the program name as is normal for C arguments.
413f177e3b1SBarry Smith 
414e5c89e4eSSatish Balay    Concepts: command line arguments
415e5c89e4eSSatish Balay 
416793721a6SBarry Smith .seealso: PetscFinalize(), PetscInitializeFortran(), PetscGetArguments()
417e5c89e4eSSatish Balay 
418e5c89e4eSSatish Balay @*/
4197087cfbeSBarry Smith PetscErrorCode  PetscGetArgs(int *argc,char ***args)
420e5c89e4eSSatish Balay {
421e5c89e4eSSatish Balay   PetscFunctionBegin;
42217186662SBarry Smith   if (!PetscInitializeCalled && PetscFinalizeCalled) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ORDER,"You must call after PetscInitialize() but before PetscFinalize()");
423e5c89e4eSSatish Balay   *argc = PetscGlobalArgc;
424e5c89e4eSSatish Balay   *args = PetscGlobalArgs;
425e5c89e4eSSatish Balay   PetscFunctionReturn(0);
426e5c89e4eSSatish Balay }
427e5c89e4eSSatish Balay 
428793721a6SBarry Smith /*@C
429793721a6SBarry Smith    PetscGetArguments - Allows you to access the  command line arguments anywhere
430793721a6SBarry Smith      after PetscInitialize() is called but before PetscFinalize().
431793721a6SBarry Smith 
432793721a6SBarry Smith    Not Collective
433793721a6SBarry Smith 
434793721a6SBarry Smith    Output Parameters:
435793721a6SBarry Smith .  args - the command line arguments
436793721a6SBarry Smith 
437793721a6SBarry Smith    Level: intermediate
438793721a6SBarry Smith 
439793721a6SBarry Smith    Notes:
440793721a6SBarry Smith       This does NOT start with the program name and IS null terminated (final arg is void)
441793721a6SBarry Smith 
442793721a6SBarry Smith    Concepts: command line arguments
443793721a6SBarry Smith 
444793721a6SBarry Smith .seealso: PetscFinalize(), PetscInitializeFortran(), PetscGetArgs(), PetscFreeArguments()
445793721a6SBarry Smith 
446793721a6SBarry Smith @*/
4477087cfbeSBarry Smith PetscErrorCode  PetscGetArguments(char ***args)
448793721a6SBarry Smith {
449793721a6SBarry Smith   PetscInt       i,argc = PetscGlobalArgc;
450793721a6SBarry Smith   PetscErrorCode ierr;
451793721a6SBarry Smith 
452793721a6SBarry Smith   PetscFunctionBegin;
45317186662SBarry Smith   if (!PetscInitializeCalled && PetscFinalizeCalled) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ORDER,"You must call after PetscInitialize() but before PetscFinalize()");
454717030eeSLisandro Dalcin   if (!argc) {*args = 0; PetscFunctionReturn(0);}
455785e854fSJed Brown   ierr = PetscMalloc1(argc,args);CHKERRQ(ierr);
456793721a6SBarry Smith   for (i=0; i<argc-1; i++) {
457793721a6SBarry Smith     ierr = PetscStrallocpy(PetscGlobalArgs[i+1],&(*args)[i]);CHKERRQ(ierr);
458793721a6SBarry Smith   }
459793721a6SBarry Smith   (*args)[argc-1] = 0;
460793721a6SBarry Smith   PetscFunctionReturn(0);
461793721a6SBarry Smith }
462793721a6SBarry Smith 
463793721a6SBarry Smith /*@C
464793721a6SBarry Smith    PetscFreeArguments - Frees the memory obtained with PetscGetArguments()
465793721a6SBarry Smith 
466793721a6SBarry Smith    Not Collective
467793721a6SBarry Smith 
468793721a6SBarry Smith    Output Parameters:
469793721a6SBarry Smith .  args - the command line arguments
470793721a6SBarry Smith 
471793721a6SBarry Smith    Level: intermediate
472793721a6SBarry Smith 
473793721a6SBarry Smith    Concepts: command line arguments
474793721a6SBarry Smith 
475793721a6SBarry Smith .seealso: PetscFinalize(), PetscInitializeFortran(), PetscGetArgs(), PetscGetArguments()
476793721a6SBarry Smith 
477793721a6SBarry Smith @*/
4787087cfbeSBarry Smith PetscErrorCode  PetscFreeArguments(char **args)
479793721a6SBarry Smith {
480793721a6SBarry Smith   PetscInt       i = 0;
481793721a6SBarry Smith   PetscErrorCode ierr;
482793721a6SBarry Smith 
483793721a6SBarry Smith   PetscFunctionBegin;
484a297a907SKarl Rupp   if (!args) PetscFunctionReturn(0);
485793721a6SBarry Smith   while (args[i]) {
486793721a6SBarry Smith     ierr = PetscFree(args[i]);CHKERRQ(ierr);
487793721a6SBarry Smith     i++;
488793721a6SBarry Smith   }
489793721a6SBarry Smith   ierr = PetscFree(args);CHKERRQ(ierr);
490793721a6SBarry Smith   PetscFunctionReturn(0);
491793721a6SBarry Smith }
492793721a6SBarry Smith 
49311525c0dSBarry Smith #if defined(PETSC_HAVE_SAWS)
49430befbd2SBarry Smith #include <petscconfiginfo.h>
49530befbd2SBarry Smith 
49611525c0dSBarry Smith PetscErrorCode  PetscInitializeSAWs(const char help[])
49711525c0dSBarry Smith {
49811525c0dSBarry Smith   if (!PetscGlobalRank) {
49930befbd2SBarry Smith     char           cert[PETSC_MAX_PATH_LEN],root[PETSC_MAX_PATH_LEN],*intro,programname[64],*appline,*options,version[64];
50011525c0dSBarry Smith     int            port;
501ffbd1cfbSBarry Smith     PetscBool      flg,rootlocal = PETSC_FALSE,flg2,selectport = PETSC_FALSE;
50211525c0dSBarry Smith     size_t         applinelen,introlen;
50311525c0dSBarry Smith     PetscErrorCode ierr;
504ffbd1cfbSBarry Smith     char           sawsurl[256];
50511525c0dSBarry Smith 
506c5929fdfSBarry Smith     ierr = PetscOptionsHasName(NULL,NULL,"-saws_log",&flg);CHKERRQ(ierr);
50711525c0dSBarry Smith     if (flg) {
50811525c0dSBarry Smith       char  sawslog[PETSC_MAX_PATH_LEN];
50911525c0dSBarry Smith 
510c5929fdfSBarry Smith       ierr = PetscOptionsGetString(NULL,NULL,"-saws_log",sawslog,PETSC_MAX_PATH_LEN,NULL);CHKERRQ(ierr);
51111525c0dSBarry Smith       if (sawslog[0]) {
51211525c0dSBarry Smith         PetscStackCallSAWs(SAWs_Set_Use_Logfile,(sawslog));
51311525c0dSBarry Smith       } else {
51411525c0dSBarry Smith         PetscStackCallSAWs(SAWs_Set_Use_Logfile,(NULL));
51511525c0dSBarry Smith       }
51611525c0dSBarry Smith     }
517c5929fdfSBarry Smith     ierr = PetscOptionsGetString(NULL,NULL,"-saws_https",cert,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr);
51811525c0dSBarry Smith     if (flg) {
51911525c0dSBarry Smith       PetscStackCallSAWs(SAWs_Set_Use_HTTPS,(cert));
52011525c0dSBarry Smith     }
521c5929fdfSBarry Smith     ierr = PetscOptionsGetBool(NULL,NULL,"-saws_port_auto_select",&selectport,NULL);CHKERRQ(ierr);
522ffbd1cfbSBarry Smith     if (selectport) {
523ffbd1cfbSBarry Smith         PetscStackCallSAWs(SAWs_Get_Available_Port,(&port));
524ffbd1cfbSBarry Smith         PetscStackCallSAWs(SAWs_Set_Port,(port));
525ffbd1cfbSBarry Smith     } else {
526c5929fdfSBarry Smith       ierr = PetscOptionsGetInt(NULL,NULL,"-saws_port",&port,&flg);CHKERRQ(ierr);
52711525c0dSBarry Smith       if (flg) {
52811525c0dSBarry Smith         PetscStackCallSAWs(SAWs_Set_Port,(port));
52911525c0dSBarry Smith       }
530ffbd1cfbSBarry Smith     }
531c5929fdfSBarry Smith     ierr = PetscOptionsGetString(NULL,NULL,"-saws_root",root,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr);
53211525c0dSBarry Smith     if (flg) {
53311525c0dSBarry Smith       PetscStackCallSAWs(SAWs_Set_Document_Root,(root));CHKERRQ(ierr);
53411525c0dSBarry Smith       ierr = PetscStrcmp(root,".",&rootlocal);CHKERRQ(ierr);
5359c1e0ce8SBarry Smith     } else {
536c5929fdfSBarry Smith       ierr = PetscOptionsHasName(NULL,NULL,"-saws_options",&flg);CHKERRQ(ierr);
5379c1e0ce8SBarry Smith       if (flg) {
5383c01dfcfSBarry Smith         ierr = PetscStrreplace(PETSC_COMM_WORLD,"${PETSC_DIR}/share/petsc/saws",root,PETSC_MAX_PATH_LEN);CHKERRQ(ierr);
5399c1e0ce8SBarry Smith         PetscStackCallSAWs(SAWs_Set_Document_Root,(root));CHKERRQ(ierr);
5409c1e0ce8SBarry Smith       }
54111525c0dSBarry Smith     }
542c5929fdfSBarry Smith     ierr = PetscOptionsHasName(NULL,NULL,"-saws_local",&flg2);CHKERRQ(ierr);
54311525c0dSBarry Smith     if (flg2) {
54411525c0dSBarry Smith       char jsdir[PETSC_MAX_PATH_LEN];
54511525c0dSBarry Smith       if (!flg) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SUP,"-saws_local option requires -saws_root option");
54611525c0dSBarry Smith       ierr = PetscSNPrintf(jsdir,PETSC_MAX_PATH_LEN,"%s/js",root);CHKERRQ(ierr);
54711525c0dSBarry Smith       ierr = PetscTestDirectory(jsdir,'r',&flg);CHKERRQ(ierr);
54811525c0dSBarry Smith       if (!flg) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_FILE_READ,"-saws_local option requires js directory in root directory");
54943da4ab2SBarry Smith       PetscStackCallSAWs(SAWs_Push_Local_Header,());CHKERRQ(ierr);
55011525c0dSBarry Smith     }
55111525c0dSBarry Smith     ierr = PetscGetProgramName(programname,64);CHKERRQ(ierr);
55211525c0dSBarry Smith     ierr = PetscStrlen(help,&applinelen);CHKERRQ(ierr);
55311525c0dSBarry Smith     introlen   = 4096 + applinelen;
55430a8c9c0SSurtai Han     applinelen += 1024;
55511525c0dSBarry Smith     ierr = PetscMalloc(applinelen,&appline);CHKERRQ(ierr);
55611525c0dSBarry Smith     ierr = PetscMalloc(introlen,&intro);CHKERRQ(ierr);
55711525c0dSBarry Smith 
55811525c0dSBarry Smith     if (rootlocal) {
55911525c0dSBarry Smith       ierr = PetscSNPrintf(appline,applinelen,"%s.c.html",programname);CHKERRQ(ierr);
56011525c0dSBarry Smith       ierr = PetscTestFile(appline,'r',&rootlocal);CHKERRQ(ierr);
56111525c0dSBarry Smith     }
56276a34f28SBarry Smith     ierr = PetscOptionsGetAll(NULL,&options);CHKERRQ(ierr);
56311525c0dSBarry Smith     if (rootlocal && help) {
56430befbd2SBarry Smith       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);
56511525c0dSBarry Smith     } else if (help) {
56630a8c9c0SSurtai Han       ierr = PetscSNPrintf(appline,applinelen,"<center>Running %s %s</center><br><center><pre>%s</pre></center><br>",programname,options,help);
56711525c0dSBarry Smith     } else {
56830befbd2SBarry Smith       ierr = PetscSNPrintf(appline,applinelen,"<center> Running %s %s</center><br>\n",programname,options);
56911525c0dSBarry Smith     }
570b0bb5815SBarry Smith     ierr = PetscFree(options);CHKERRQ(ierr);
57130befbd2SBarry Smith     ierr = PetscGetVersion(version,sizeof(version));CHKERRQ(ierr);
57211525c0dSBarry Smith     ierr = PetscSNPrintf(intro,introlen,"<body>\n"
57311525c0dSBarry Smith                                     "<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"
574df62c222SBarry Smith                                     "<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"
575df62c222SBarry Smith                                     "%s",version,petscconfigureoptions,appline);
57643da4ab2SBarry Smith     PetscStackCallSAWs(SAWs_Push_Body,("index.html",0,intro));
57711525c0dSBarry Smith     ierr = PetscFree(intro);CHKERRQ(ierr);
57811525c0dSBarry Smith     ierr = PetscFree(appline);CHKERRQ(ierr);
579ffbd1cfbSBarry Smith     if (selectport) {
580aa573868SBarry Smith       PetscBool silent;
5817d812c46SBarry Smith 
5827d812c46SBarry Smith       ierr = SAWs_Initialize();
5837d812c46SBarry Smith       /* another process may have grabbed the port so keep trying */
5847d812c46SBarry Smith       while (ierr) {
5857d812c46SBarry Smith         PetscStackCallSAWs(SAWs_Get_Available_Port,(&port));
5867d812c46SBarry Smith         PetscStackCallSAWs(SAWs_Set_Port,(port));
5877d812c46SBarry Smith         ierr = SAWs_Initialize();
5887d812c46SBarry Smith       }
5897d812c46SBarry Smith 
590aa573868SBarry Smith       ierr = PetscOptionsGetBool(NULL,NULL,"-saws_port_auto_select_silent",&silent,NULL);CHKERRQ(ierr);
591aa573868SBarry Smith       if (!silent) {
592ffbd1cfbSBarry Smith         PetscStackCallSAWs(SAWs_Get_FullURL,(sizeof(sawsurl),sawsurl));
593ffbd1cfbSBarry Smith         ierr = PetscPrintf(PETSC_COMM_WORLD,"Point your browser to %s for SAWs\n",sawsurl);CHKERRQ(ierr);
594ffbd1cfbSBarry Smith       }
5957d812c46SBarry Smith     } else {
5967d812c46SBarry Smith       PetscStackCallSAWs(SAWs_Initialize,());
597aa573868SBarry Smith     }
5980af79b04SBarry Smith     ierr = PetscCitationsRegister("@TechReport{ saws,\n"
5990af79b04SBarry Smith                                   "  Author = {Matt Otten and Jed Brown and Barry Smith},\n"
6000af79b04SBarry Smith                                   "  Title  = {Scientific Application Web Server (SAWs) Users Manual},\n"
6010af79b04SBarry Smith                                   "  Institution = {Argonne National Laboratory},\n"
6020af79b04SBarry Smith                                   "  Year   = 2013\n}\n",NULL);CHKERRQ(ierr);
60311525c0dSBarry Smith   }
60411525c0dSBarry Smith   PetscFunctionReturn(0);
60511525c0dSBarry Smith }
60611525c0dSBarry Smith #endif
60711525c0dSBarry Smith 
608a56f64adSBarry Smith #if defined(PETSC_HAVE_ADIOS)
609a56f64adSBarry Smith #include <adios.h>
61022580e64SBarry Smith #include <adios_read.h>
611a56f64adSBarry Smith extern int64_t Petsc_adios_group;
612a56f64adSBarry Smith #endif
613*55d657eeSBarry Smith #if defined(PETSC_HAVE_ADIOS2)
614*55d657eeSBarry Smith #include <adios2_c.h>
615*55d657eeSBarry Smith #endif
616a56f64adSBarry Smith 
617e5c89e4eSSatish Balay /*@C
618e5c89e4eSSatish Balay    PetscInitialize - Initializes the PETSc database and MPI.
619e5c89e4eSSatish Balay    PetscInitialize() calls MPI_Init() if that has yet to be called,
620e5c89e4eSSatish Balay    so this routine should always be called near the beginning of
621e5c89e4eSSatish Balay    your program -- usually the very first line!
622e5c89e4eSSatish Balay 
623e5c89e4eSSatish Balay    Collective on MPI_COMM_WORLD or PETSC_COMM_WORLD if it has been set
624e5c89e4eSSatish Balay 
625e5c89e4eSSatish Balay    Input Parameters:
626e5c89e4eSSatish Balay +  argc - count of number of command line arguments
627e5c89e4eSSatish Balay .  args - the command line arguments
6280298fd71SBarry Smith .  file - [optional] PETSc database file, also checks ~username/.petscrc and .petscrc use NULL to not check for
629fc2bca9aSBarry Smith           code specific file. Use -skip_petscrc in the code specific file to skip the .petscrc files
6300298fd71SBarry Smith -  help - [optional] Help message to print, use NULL for no message
631e5c89e4eSSatish Balay 
63205827820SBarry Smith    If you wish PETSc code to run ONLY on a subcommunicator of MPI_COMM_WORLD, create that
63305827820SBarry Smith    communicator first and assign it to PETSC_COMM_WORLD BEFORE calling PetscInitialize(). Thus if you are running a
63405827820SBarry Smith    four process job and two processes will run PETSc and have PetscInitialize() and PetscFinalize() and two process will not,
63505827820SBarry Smith    then do this. If ALL processes in the job are using PetscInitialize() and PetscFinalize() then you don't need to do this, even
63605827820SBarry Smith    if different subcommunicators of the job are doing different things with PETSc.
637e5c89e4eSSatish Balay 
638e5c89e4eSSatish Balay    Options Database Keys:
6397ca660e7SBarry Smith +  -help [intro] - prints help method for each option; if intro is given the program stops after printing the introductory help message
6407ca660e7SBarry Smith .  -start_in_debugger [noxterm,dbx,xdb,gdb,...] - Starts program in debugger
641e5c89e4eSSatish Balay .  -on_error_attach_debugger [noxterm,dbx,xdb,gdb,...] - Starts debugger when error detected
642e5c89e4eSSatish Balay .  -on_error_emacs <machinename> causes emacsclient to jump to error file
643b52f573bSBarry Smith .  -on_error_abort calls abort() when error detected (no traceback)
644e8fb0fc0SBarry Smith .  -on_error_mpiabort calls MPI_abort() when error detected
645e8fb0fc0SBarry Smith .  -error_output_stderr prints error messages to stderr instead of the default stdout
646e8fb0fc0SBarry Smith .  -error_output_none does not print the error messages (but handles errors in the same way as if this was not called)
647e5c89e4eSSatish Balay .  -debugger_nodes [node1,node2,...] - Indicates nodes to start in debugger
648e5c89e4eSSatish Balay .  -debugger_pause [sleeptime] (in seconds) - Pauses debugger
649e5c89e4eSSatish Balay .  -stop_for_debugger - Print message on how to attach debugger manually to
650e5c89e4eSSatish Balay                         process and wait (-debugger_pause) seconds for attachment
6512fb0ec9aSBarry Smith .  -malloc - Indicates use of PETSc error-checking malloc (on by default for debug version of libraries)
652e5c89e4eSSatish Balay .  -malloc no - Indicates not to use error-checking malloc
6532fb0ec9aSBarry Smith .  -malloc_debug - check for memory corruption at EVERY malloc or free
654aee23540SBarry Smith .  -malloc_dump - prints a list of all unfreed memory at the end of the run
655dc92acbaSJed Brown .  -malloc_test - like -malloc_dump -malloc_debug, but only active for debugging builds
656e5c89e4eSSatish Balay .  -fp_trap - Stops on floating point exceptions (Note that on the
657e5c89e4eSSatish Balay               IBM RS6000 this slows code by at least a factor of 10.)
658e5c89e4eSSatish Balay .  -no_signal_handler - Indicates not to trap error signals
659e5c89e4eSSatish Balay .  -shared_tmp - indicates /tmp directory is shared by all processors
660e5c89e4eSSatish Balay .  -not_shared_tmp - each processor has own /tmp
661e5c89e4eSSatish Balay .  -tmp - alternative name of /tmp directory
662e5c89e4eSSatish Balay .  -get_total_flops - returns total flops done by all processors
6630841954dSBarry Smith -  -memory_view - Print memory usage at end of run
664e5c89e4eSSatish Balay 
665e5c89e4eSSatish Balay    Options Database Keys for Profiling:
666a7f22e61SSatish Balay    See Users-Manual: ch_profiling for details.
667495fc317SBarry Smith +  -info <optional filename> - Prints verbose information to the screen
668495fc317SBarry Smith .  -info_exclude <null,vec,mat,pc,ksp,snes,ts> - Excludes some of the verbose messages
669495fc317SBarry Smith .  -log_sync - Log the synchronization in scatters, inner products and norms
670495fc317SBarry Smith .  -log_trace [filename] - Print traces of all PETSc calls to the screen (useful to determine where a program
671e5c89e4eSSatish Balay         hangs without running in the debugger).  See PetscLogTraceBegin().
6729a9a5d4cSBarry Smith .  -log_view [:filename:format] - Prints summary of flop and timing information to screen or file, see PetscLogView().
6739a9a5d4cSBarry Smith .  -log_summary [filename] - (Deprecated, use -log_view) Prints summary of flop and timing information to screen. If the filename is specified the
674495fc317SBarry Smith         summary is written to the file.  See PetscLogView().
6759a9a5d4cSBarry Smith .  -log_exclude: <vec,mat,pc.ksp,snes> - excludes subset of object classes from logging
676495fc317SBarry Smith .  -log_all [filename] - Logs extensive profiling information  See PetscLogDump().
677495fc317SBarry Smith .  -log [filename] - Logs basic profiline information  See PetscLogDump().
678c2f74817SBarry Smith .  -log_mpe [filename] - Creates a logfile viewable by the utility Jumpshot (in MPICH distribution)
679c2f74817SBarry Smith -  -check_pointer_intensity 0,1,2 - if pointers are checked for validity (debug version only), using 0 will result in faster code
680495fc317SBarry Smith 
681609bdbeeSBarry Smith     Only one of -log_trace, -log_view, -log_view, -log_all, -log, or -log_mpe may be used at a time
682e5c89e4eSSatish Balay 
683ffbd1cfbSBarry Smith    Options Database Keys for SAWs:
684ffbd1cfbSBarry Smith +  -saws_port <portnumber> - port number to publish SAWs data, default is 8080
685ffbd1cfbSBarry Smith .  -saws_port_auto_select - have SAWs select a new unique port number where it publishes the data, the URL is printed to the screen
686ffbd1cfbSBarry Smith                             this is useful when you are running many jobs that utilize SAWs at the same time
687ffbd1cfbSBarry Smith .  -saws_log <filename> - save a log of all SAWs communication
688ffbd1cfbSBarry Smith .  -saws_https <certificate file> - have SAWs use HTTPS instead of HTTP
689ffbd1cfbSBarry Smith -  -saws_root <directory> - allow SAWs to have access to the given directory to search for requested resources and files
690ffbd1cfbSBarry Smith 
691e5c89e4eSSatish Balay    Environmental Variables:
692e5c89e4eSSatish Balay +   PETSC_TMP - alternative tmp directory
693e5c89e4eSSatish Balay .   PETSC_SHARED_TMP - tmp is shared by all processes
694e5c89e4eSSatish Balay .   PETSC_NOT_SHARED_TMP - each process has its own private tmp
695e5c89e4eSSatish Balay .   PETSC_VIEWER_SOCKET_PORT - socket number to use for socket viewer
696e5c89e4eSSatish Balay -   PETSC_VIEWER_SOCKET_MACHINE - machine to use for socket viewer to connect to
697e5c89e4eSSatish Balay 
698e5c89e4eSSatish Balay 
699e5c89e4eSSatish Balay    Level: beginner
700e5c89e4eSSatish Balay 
701e5c89e4eSSatish Balay    Notes:
702e5c89e4eSSatish Balay    If for some reason you must call MPI_Init() separately, call
703e5c89e4eSSatish Balay    it before PetscInitialize().
704e5c89e4eSSatish Balay 
705e5c89e4eSSatish Balay    Fortran Version:
706e5c89e4eSSatish Balay    In Fortran this routine has the format
707e5c89e4eSSatish Balay $       call PetscInitialize(file,ierr)
708e5c89e4eSSatish Balay 
709e5c89e4eSSatish Balay +   ierr - error return code
7100eb4c9c0SBarry Smith -  file - [optional] PETSc database file, also checks ~username/.petscrc and .petscrc use PETSC_NULL_CHARACTER to not check for
711fc2bca9aSBarry Smith           code specific file. Use -skip_petscrc in the code specific file to skip the .petscrc files
712e5c89e4eSSatish Balay 
713e5c89e4eSSatish Balay    Important Fortran Note:
7140eb4c9c0SBarry Smith    In Fortran, you MUST use PETSC_NULL_CHARACTER to indicate a
7150298fd71SBarry Smith    null character string; you CANNOT just use NULL as
716a7f22e61SSatish Balay    in the C version. See Users-Manual: ch_fortran for details.
717e5c89e4eSSatish Balay 
71801cb0274SBarry Smith    If your main program is C but you call Fortran code that also uses PETSc you need to call PetscInitializeFortran() soon after
71901cb0274SBarry Smith    calling PetscInitialize().
720e5c89e4eSSatish Balay 
721e5c89e4eSSatish Balay    Concepts: initializing PETSc
722e5c89e4eSSatish Balay 
72301cb0274SBarry Smith .seealso: PetscFinalize(), PetscInitializeFortran(), PetscGetArgs(), PetscInitializeNoArguments()
724e5c89e4eSSatish Balay 
725e5c89e4eSSatish Balay @*/
7267087cfbeSBarry Smith PetscErrorCode  PetscInitialize(int *argc,char ***args,const char file[],const char help[])
727e5c89e4eSSatish Balay {
728e5c89e4eSSatish Balay   PetscErrorCode ierr;
7294bb5149bSJed Brown   PetscMPIInt    flag, size;
73019c5658aSBarry Smith   PetscBool      flg = PETSC_TRUE;
731e5c89e4eSSatish Balay   char           hostname[256];
7325e71baefSBarry Smith #if defined(PETSC_HAVE_HWLOC)
7335e71baefSBarry Smith   PetscViewer    viewer;
7345e71baefSBarry Smith #endif
735e5c89e4eSSatish Balay 
736e5c89e4eSSatish Balay   PetscFunctionBegin;
737e5c89e4eSSatish Balay   if (PetscInitializeCalled) PetscFunctionReturn(0);
7383d96e996SBarry Smith   /*
7393d96e996SBarry Smith       The checking over compatible runtime libraries is complicated by the MPI ABI initiative
7403d96e996SBarry Smith       https://wiki.mpich.org/mpich/index.php/ABI_Compatibility_Initiative which started with
7413d96e996SBarry Smith         MPICH v3.1 (Released Feburary 2014)
7423d96e996SBarry Smith         IBM MPI v2.1 (December 2014)
7433d96e996SBarry Smith         Intel® MPI Library v5.0 (2014)
7443d96e996SBarry Smith         Cray MPT v7.0.0 (June 2014)
7453d96e996SBarry Smith       As of July 31, 2017 the ABI number still appears to be 12, that is all of the versions
7463d96e996SBarry Smith       listed above and since that time are compatible.
7473d96e996SBarry Smith 
7483d96e996SBarry Smith       Unfortunately the MPI ABI initiative has not defined a way to determine the ABI number
7493d96e996SBarry Smith       at compile time or runtime. Thus we will need to systematically track the allowed versions
7503d96e996SBarry Smith       and how they are represented in the mpi.h and MPI_Get_library_version() output in order
7513d96e996SBarry Smith       to perform the checking.
7523d96e996SBarry Smith 
7533d96e996SBarry Smith       Currently we only check for pre MPI ABI versions (and packages that do not follow the MPI ABI).
7543d96e996SBarry Smith 
7553d96e996SBarry Smith       Questions:
7563d96e996SBarry Smith 
7573d96e996SBarry Smith         Should the checks for ABI incompatibility be only on the major version number below?
7583d96e996SBarry Smith         Presumably the output to stderr will be removed before a release.
7593d96e996SBarry Smith   */
7603d96e996SBarry Smith 
76119c5658aSBarry Smith #if defined(PETSC_HAVE_MPI_GET_LIBRARY_VERSION)
76219c5658aSBarry Smith   {
76319c5658aSBarry Smith     char        mpilibraryversion[MPI_MAX_LIBRARY_VERSION_STRING];
76419c5658aSBarry Smith     PetscMPIInt mpilibraryversionlength;
76519c5658aSBarry Smith     ierr = MPI_Get_library_version(mpilibraryversion,&mpilibraryversionlength);if (ierr) return ierr;
7663d96e996SBarry Smith     /* check for MPICH versions before MPI ABI initiative */
76719c5658aSBarry Smith #if defined(MPICH_VERSION)
7683d96e996SBarry Smith #if MPICH_NUMVERSION < 30100000
76919c5658aSBarry Smith     {
77019c5658aSBarry Smith       char *ver,*lf;
77119c5658aSBarry Smith       flg = PETSC_FALSE;
77219c5658aSBarry Smith       ierr = PetscStrstr(mpilibraryversion,"MPICH Version:",&ver);if (ierr) return ierr;
77319c5658aSBarry Smith       if (ver) {
77419c5658aSBarry Smith         ierr = PetscStrchr(ver,'\n',&lf);if (ierr) return ierr;
77519c5658aSBarry Smith         if (lf) {
77619c5658aSBarry Smith           *lf = 0;
77719c5658aSBarry Smith           ierr = PetscStrendswith(ver,MPICH_VERSION,&flg);if (ierr) return ierr;
77819c5658aSBarry Smith         }
77919c5658aSBarry Smith       }
78019c5658aSBarry Smith       if (!flg) {
78119c5658aSBarry Smith         fprintf(stderr,"PETSc Error --- MPICH library version \n%s does not match what PETSc was compiled with %s, aborting\n",mpilibraryversion,MPICH_VERSION);
7823d96e996SBarry Smith         return PETSC_ERR_MPI_LIB_INCOMP;
78319c5658aSBarry Smith       }
78419c5658aSBarry Smith     }
7853d96e996SBarry Smith #endif
7863d96e996SBarry Smith     /* check for OpenMPI version, it is not part of the MPI ABI initiative (is it part of another initiative that needs to be handled?) */
78719c5658aSBarry Smith #elif defined(OMPI_MAJOR_VERSION)
78819c5658aSBarry Smith     {
78919c5658aSBarry Smith       char *ver,bs[32],*bsf;
79019c5658aSBarry Smith       flg = PETSC_FALSE;
79119c5658aSBarry Smith       ierr = PetscStrstr(mpilibraryversion,"Open MPI",&ver);if (ierr) return ierr;
79219c5658aSBarry Smith       if (ver) {
7932e924ca5SSatish Balay         PetscSNPrintf(bs,32,"v%d.%d",OMPI_MAJOR_VERSION,OMPI_MINOR_VERSION);
79419c5658aSBarry Smith         ierr = PetscStrstr(ver,bs,&bsf);if (ierr) return ierr;
79519c5658aSBarry Smith         if (bsf) flg = PETSC_TRUE;
79619c5658aSBarry Smith       }
79719c5658aSBarry Smith       if (!flg) {
79819c5658aSBarry Smith         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);
7993d96e996SBarry Smith         return PETSC_ERR_MPI_LIB_INCOMP;
80019c5658aSBarry Smith       }
80119c5658aSBarry Smith     }
80219c5658aSBarry Smith #endif
80319c5658aSBarry Smith   }
80419c5658aSBarry Smith #endif
80519c5658aSBarry Smith 
806e5c89e4eSSatish Balay 
807ae9b4142SLisandro Dalcin   /* these must be initialized in a routine, not as a constant declaration*/
808d89683f4Sbcordonn   PETSC_STDOUT = stdout;
809ae9b4142SLisandro Dalcin   PETSC_STDERR = stderr;
810e5c89e4eSSatish Balay 
8110c30907bSSatish Balay   /* on Windows - set printf to default to printing 2 digit exponents */
8120c30907bSSatish Balay #if defined(PETSC_HAVE__SET_OUTPUT_FORMAT)
8130c30907bSSatish Balay   _set_output_format(_TWO_DIGIT_EXPONENT);
8140c30907bSSatish Balay #endif
8150c30907bSSatish Balay 
8164416b707SBarry Smith   ierr = PetscOptionsCreateDefault();CHKERRQ(ierr);
817e5c89e4eSSatish Balay 
818e5c89e4eSSatish Balay   /*
819e5c89e4eSSatish Balay      We initialize the program name here (before MPI_Init()) because MPICH has a bug in
820e5c89e4eSSatish Balay      it that it sets args[0] on all processors to be args[0] on the first processor.
821e5c89e4eSSatish Balay   */
822e5c89e4eSSatish Balay   if (argc && *argc) {
823e5c89e4eSSatish Balay     ierr = PetscSetProgramName(**args);CHKERRQ(ierr);
824e5c89e4eSSatish Balay   } else {
825e5c89e4eSSatish Balay     ierr = PetscSetProgramName("Unknown Name");CHKERRQ(ierr);
826e5c89e4eSSatish Balay   }
827e5c89e4eSSatish Balay 
828e5c89e4eSSatish Balay   ierr = MPI_Initialized(&flag);CHKERRQ(ierr);
829e5c89e4eSSatish Balay   if (!flag) {
830e32f2f54SBarry Smith     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");
8315e765c61SJed Brown #if defined(PETSC_HAVE_MPI_INIT_THREAD)
8325e765c61SJed Brown     {
8335e765c61SJed Brown       PetscMPIInt provided;
8345e765c61SJed Brown       ierr = MPI_Init_thread(argc,args,MPI_THREAD_FUNNELED,&provided);CHKERRQ(ierr);
8355e765c61SJed Brown     }
8365e765c61SJed Brown #else
837e5c89e4eSSatish Balay     ierr = MPI_Init(argc,args);CHKERRQ(ierr);
8385e765c61SJed Brown #endif
839e5c89e4eSSatish Balay     PetscBeganMPI = PETSC_TRUE;
840e5c89e4eSSatish Balay   }
841e5c89e4eSSatish Balay   if (argc && args) {
842e5c89e4eSSatish Balay     PetscGlobalArgc = *argc;
843e5c89e4eSSatish Balay     PetscGlobalArgs = *args;
844e5c89e4eSSatish Balay   }
845e5c89e4eSSatish Balay   PetscFinalizeCalled = PETSC_FALSE;
8465ad9ad5bSBarry Smith   ierr = PetscSpinlockCreate(&PetscViewerASCIISpinLockOpen);CHKERRQ(ierr);
8475ad9ad5bSBarry Smith   ierr = PetscSpinlockCreate(&PetscViewerASCIISpinLockStdout);CHKERRQ(ierr);
8485ad9ad5bSBarry Smith   ierr = PetscSpinlockCreate(&PetscViewerASCIISpinLockStderr);CHKERRQ(ierr);
849ef19f930SBarry Smith   ierr = PetscSpinlockCreate(&PetscCommSpinLock);CHKERRQ(ierr);
850e5c89e4eSSatish Balay 
851a297a907SKarl Rupp   if (PETSC_COMM_WORLD == MPI_COMM_NULL) PETSC_COMM_WORLD = MPI_COMM_WORLD;
852d54338ecSKarl Rupp   ierr = MPI_Comm_set_errhandler(PETSC_COMM_WORLD,MPI_ERRORS_RETURN);CHKERRQ(ierr);
853e5c89e4eSSatish Balay 
85412801b39SBarry Smith   ierr = MPI_Add_error_class(&PETSC_MPI_ERROR_CLASS);CHKERRQ(ierr);
85512801b39SBarry Smith   ierr = MPI_Add_error_code(PETSC_MPI_ERROR_CLASS,&PETSC_MPI_ERROR_CODE);CHKERRQ(ierr);
85612801b39SBarry Smith 
857e5c89e4eSSatish Balay   /* Done after init due to a bug in MPICH-GM? */
858e5c89e4eSSatish Balay   ierr = PetscErrorPrintfInitialize();CHKERRQ(ierr);
859e5c89e4eSSatish Balay 
860e5c89e4eSSatish Balay   ierr = MPI_Comm_rank(MPI_COMM_WORLD,&PetscGlobalRank);CHKERRQ(ierr);
861e5c89e4eSSatish Balay   ierr = MPI_Comm_size(MPI_COMM_WORLD,&PetscGlobalSize);CHKERRQ(ierr);
862e5c89e4eSSatish Balay 
8638ad47952SJed Brown   MPIU_BOOL = MPI_INT;
8648ad47952SJed Brown   MPIU_ENUM = MPI_INT;
8658ad47952SJed Brown 
866e5c89e4eSSatish Balay   /*
867e5c89e4eSSatish Balay      Initialized the global complex variable; this is because with
868e5c89e4eSSatish Balay      shared libraries the constructors for global variables
869e5c89e4eSSatish Balay      are not called; at least on IRIX.
870e5c89e4eSSatish Balay   */
871886cfec0SSatish Balay #if defined(PETSC_HAVE_COMPLEX)
872e5c89e4eSSatish Balay   {
873252ecd31SSatish Balay #if defined(PETSC_CLANGUAGE_CXX) && !defined(PETSC_USE_REAL___FLOAT128)
87450f81f78SJed Brown     PetscComplex ic(0.0,1.0);
875e5c89e4eSSatish Balay     PETSC_i = ic;
876252ecd31SSatish Balay #else
87750f81f78SJed Brown     PETSC_i = _Complex_I;
878b7940d39SSatish Balay #endif
879762437b8SSatish Balay   }
880762437b8SSatish Balay 
8812c876bd9SBarry Smith #if !defined(PETSC_HAVE_MPI_C_DOUBLE_COMPLEX)
882e69cd0e6SSatish Balay   ierr = MPI_Type_contiguous(2,MPI_DOUBLE,&MPIU_C_DOUBLE_COMPLEX);CHKERRQ(ierr);
883500d8756SSatish Balay   ierr = MPI_Type_commit(&MPIU_C_DOUBLE_COMPLEX);CHKERRQ(ierr);
884500d8756SSatish Balay   ierr = MPI_Type_contiguous(2,MPI_FLOAT,&MPIU_C_COMPLEX);CHKERRQ(ierr);
885500d8756SSatish Balay   ierr = MPI_Type_commit(&MPIU_C_COMPLEX);CHKERRQ(ierr);
8862c876bd9SBarry Smith #endif
887886cfec0SSatish Balay #endif /* PETSC_HAVE_COMPLEX */
888e5c89e4eSSatish Balay 
889e5c89e4eSSatish Balay   /*
890e5c89e4eSSatish Balay      Create the PETSc MPI reduction operator that sums of the first
891e5c89e4eSSatish Balay      half of the entries and maxes the second half.
892e5c89e4eSSatish Balay   */
893367daffbSBarry Smith   ierr = MPI_Op_create(MPIU_MaxSum_Local,1,&MPIU_MAXSUM_OP);CHKERRQ(ierr);
894e5c89e4eSSatish Balay 
895ce63c4c1SBarry Smith #if defined(PETSC_USE_REAL___FLOAT128)
896c90a1750SBarry Smith   ierr = MPI_Type_contiguous(2,MPI_DOUBLE,&MPIU___FLOAT128);CHKERRQ(ierr);
897c90a1750SBarry Smith   ierr = MPI_Type_commit(&MPIU___FLOAT128);CHKERRQ(ierr);
8987c2de775SJed Brown #if defined(PETSC_HAVE_COMPLEX)
8998c764dc5SJose Roman   ierr = MPI_Type_contiguous(4,MPI_DOUBLE,&MPIU___COMPLEX128);CHKERRQ(ierr);
9008c764dc5SJose Roman   ierr = MPI_Type_commit(&MPIU___COMPLEX128);CHKERRQ(ierr);
9018c764dc5SJose Roman #endif
902d9822059SBarry Smith   ierr = MPI_Op_create(PetscMax_Local,1,&MPIU_MAX);CHKERRQ(ierr);
903d9822059SBarry Smith   ierr = MPI_Op_create(PetscMin_Local,1,&MPIU_MIN);CHKERRQ(ierr);
904570b7f6dSBarry Smith #elif defined(PETSC_USE_REAL___FP16)
905570b7f6dSBarry Smith   ierr = MPI_Type_contiguous(2,MPI_CHAR,&MPIU___FP16);CHKERRQ(ierr);
906570b7f6dSBarry Smith   ierr = MPI_Type_commit(&MPIU___FP16);CHKERRQ(ierr);
907570b7f6dSBarry Smith   ierr = MPI_Op_create(PetscMax_Local,1,&MPIU_MAX);CHKERRQ(ierr);
908570b7f6dSBarry Smith   ierr = MPI_Op_create(PetscMin_Local,1,&MPIU_MIN);CHKERRQ(ierr);
909c90a1750SBarry Smith #endif
910c90a1750SBarry Smith 
911570b7f6dSBarry Smith #if (defined(PETSC_HAVE_COMPLEX) && !defined(PETSC_HAVE_MPI_C_DOUBLE_COMPLEX)) || defined(PETSC_USE_REAL___FLOAT128) || defined(PETSC_USE_REAL___FP16)
912cca4cb22SSatish Balay   ierr = MPI_Op_create(PetscSum_Local,1,&MPIU_SUM);CHKERRQ(ierr);
913cca4cb22SSatish Balay #endif
914cca4cb22SSatish Balay 
915e5c89e4eSSatish Balay   ierr = MPI_Type_contiguous(2,MPIU_SCALAR,&MPIU_2SCALAR);CHKERRQ(ierr);
916e5c89e4eSSatish Balay   ierr = MPI_Type_commit(&MPIU_2SCALAR);CHKERRQ(ierr);
917e5c89e4eSSatish Balay 
91844041f26SJed Brown #if defined(PETSC_USE_64BIT_INDICES) || !defined(MPI_2INT)
919e5c89e4eSSatish Balay   ierr = MPI_Type_contiguous(2,MPIU_INT,&MPIU_2INT);CHKERRQ(ierr);
920e5c89e4eSSatish Balay   ierr = MPI_Type_commit(&MPIU_2INT);CHKERRQ(ierr);
92144041f26SJed Brown #endif
922e5c89e4eSSatish Balay 
923ec957eceSBarry Smith 
924e5c89e4eSSatish Balay   /*
925480cf27aSJed Brown      Attributes to be set on PETSc communicators
926480cf27aSJed Brown   */
92712801b39SBarry Smith   ierr = MPI_Comm_create_keyval(MPI_COMM_NULL_COPY_FN,Petsc_DelCounter,&Petsc_Counter_keyval,(void*)0);CHKERRQ(ierr);
92812801b39SBarry Smith   ierr = MPI_Comm_create_keyval(MPI_COMM_NULL_COPY_FN,Petsc_DelComm_Outer,&Petsc_InnerComm_keyval,(void*)0);CHKERRQ(ierr);
92912801b39SBarry Smith   ierr = MPI_Comm_create_keyval(MPI_COMM_NULL_COPY_FN,Petsc_DelComm_Inner,&Petsc_OuterComm_keyval,(void*)0);CHKERRQ(ierr);
93012801b39SBarry Smith   ierr = MPI_Comm_create_keyval(MPI_COMM_NULL_COPY_FN,Petsc_DelShared,&Petsc_Shared_keyval,(void*)0);CHKERRQ(ierr);
931480cf27aSJed Brown 
932480cf27aSJed Brown   /*
933e8fb0fc0SBarry Smith      Build the options database
934e5c89e4eSSatish Balay   */
935c5929fdfSBarry Smith   ierr = PetscOptionsInsert(NULL,argc,args,file);CHKERRQ(ierr);
936e5c89e4eSSatish Balay 
937703f3eceSBarry Smith   /* call a second time so it can look in the options database */
938703f3eceSBarry Smith   ierr = PetscErrorPrintfInitialize();CHKERRQ(ierr);
9396dc8fec2Sbcordonn 
940e5c89e4eSSatish Balay   /*
941e5c89e4eSSatish Balay      Print main application help message
942e5c89e4eSSatish Balay   */
943c5929fdfSBarry Smith   ierr = PetscOptionsHasName(NULL,NULL,"-help",&flg);CHKERRQ(ierr);
944e5c89e4eSSatish Balay   if (help && flg) {
945e5c89e4eSSatish Balay     ierr = PetscPrintf(PETSC_COMM_WORLD,help);CHKERRQ(ierr);
946e5c89e4eSSatish Balay   }
947e5c89e4eSSatish Balay   ierr = PetscOptionsCheckInitial_Private();CHKERRQ(ierr);
948e5c89e4eSSatish Balay 
949d45a07a7SBarry Smith   ierr = PetscCitationsInitialize();CHKERRQ(ierr);
950d45a07a7SBarry Smith 
951e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS)
95211525c0dSBarry Smith   ierr = PetscInitializeSAWs(help);CHKERRQ(ierr);
953f4202a44SBarry Smith #endif
954f4202a44SBarry Smith 
955896238b9SBarry Smith   /* Creates the logging data structures; this is enabled even if logging is not turned on */
956a9f03627SSatish Balay #if defined(PETSC_USE_LOG)
957896238b9SBarry Smith   ierr = PetscLogInitialize();CHKERRQ(ierr);
958a9f03627SSatish Balay #endif
959e5c89e4eSSatish Balay 
960e5c89e4eSSatish Balay   /*
961e5c89e4eSSatish Balay      Load the dynamic libraries (on machines that support them), this registers all
962e5c89e4eSSatish Balay      the solvers etc. (On non-dynamic machines this initializes the PetscDraw and PetscViewer classes)
963e5c89e4eSSatish Balay   */
964e5c89e4eSSatish Balay   ierr = PetscInitialize_DynamicLibraries();CHKERRQ(ierr);
965e5c89e4eSSatish Balay 
966e5c89e4eSSatish Balay   ierr = MPI_Comm_size(PETSC_COMM_WORLD,&size);CHKERRQ(ierr);
967ae15b995SBarry Smith   ierr = PetscInfo1(0,"PETSc successfully started: number of processors = %d\n",size);CHKERRQ(ierr);
968e5c89e4eSSatish Balay   ierr = PetscGetHostName(hostname,256);CHKERRQ(ierr);
969ae15b995SBarry Smith   ierr = PetscInfo1(0,"Running on machine: %s\n",hostname);CHKERRQ(ierr);
970e5c89e4eSSatish Balay 
971e5c89e4eSSatish Balay   ierr = PetscOptionsCheckInitial_Components();CHKERRQ(ierr);
972ef6c6fedSBoyana Norris   /* Check the options database for options related to the options database itself */
973c5929fdfSBarry Smith   ierr = PetscOptionsSetFromOptions(NULL);CHKERRQ(ierr);
974ef6c6fedSBoyana Norris 
975951e3c8eSBarry Smith #if defined(PETSC_USE_PETSC_MPI_EXTERNAL32)
976e39fd77fSBarry Smith   /*
977e39fd77fSBarry Smith       Tell MPI about our own data representation converter, this would/should be used if extern32 is not supported by the MPI
978e39fd77fSBarry Smith 
979e39fd77fSBarry Smith       Currently not used because it is not supported by MPICH.
980e39fd77fSBarry Smith   */
981e39fd77fSBarry Smith #if !defined(PETSC_WORDS_BIGENDIAN)
9820298fd71SBarry Smith   ierr = MPI_Register_datarep((char*)"petsc",PetscDataRep_read_conv_fn,PetscDataRep_write_conv_fn,PetscDataRep_extent_fn,NULL);CHKERRQ(ierr);
983e39fd77fSBarry Smith #endif
984951e3c8eSBarry Smith #endif
985e39fd77fSBarry Smith 
986c5929fdfSBarry Smith   ierr = PetscOptionsHasName(NULL,NULL,"-python",&flg);CHKERRQ(ierr);
9879ac80d5eSLisandro Dalcin   if (flg) {
9889ac80d5eSLisandro Dalcin     PetscInitializeCalled = PETSC_TRUE;
9890298fd71SBarry Smith     ierr = PetscPythonInitialize(NULL,NULL);CHKERRQ(ierr);
9909ac80d5eSLisandro Dalcin   }
9919ac80d5eSLisandro Dalcin 
99241c0b4b3SShri Abhyankar   /*
99341c0b4b3SShri Abhyankar       Setup building of stack frames for all function calls
99441c0b4b3SShri Abhyankar   */
995ef19f930SBarry Smith #if defined(PETSC_USE_DEBUG) && !defined(PETSC_HAVE_THREADSAFETY)
996e1167bb9SShri Abhyankar   ierr = PetscStackCreate();CHKERRQ(ierr);
997e1167bb9SShri Abhyankar #endif
998e1167bb9SShri Abhyankar 
9992d53ad75SBarry Smith #if defined(PETSC_SERIALIZE_FUNCTIONS)
10002d53ad75SBarry Smith   ierr = PetscFPTCreate(10000);CHKERRQ(ierr);
10012d53ad75SBarry Smith #endif
10022d53ad75SBarry Smith 
10035e71baefSBarry Smith #if defined(PETSC_HAVE_HWLOC)
10045e71baefSBarry Smith   ierr   = PetscOptionsGetViewer(PETSC_COMM_WORLD,NULL,"-process_view",&viewer,NULL,&flg);CHKERRQ(ierr);
10055e71baefSBarry Smith   if (flg) {
10065e71baefSBarry Smith     ierr = PetscProcessPlacementView(viewer);CHKERRQ(ierr);
10075e71baefSBarry Smith   }
10085e71baefSBarry Smith #endif
1009dff31646SBarry Smith 
1010a56f64adSBarry Smith #if defined(PETSC_HAVE_ADIOS)
1011a56f64adSBarry Smith   ierr = adios_init_noxml(PETSC_COMM_WORLD);CHKERRQ(ierr);
1012a56f64adSBarry Smith   ierr = adios_declare_group(&Petsc_adios_group,"PETSc","",0);CHKERRQ(ierr);
1013a56f64adSBarry Smith   ierr = adios_select_method(Petsc_adios_group,"MPI","","");CHKERRQ(ierr);
10149fc7e16cSBarry Smith   ierr = adios_read_init_method(ADIOS_READ_METHOD_BP,PETSC_COMM_WORLD,"");CHKERRQ(ierr);
1015a56f64adSBarry Smith #endif
1016*55d657eeSBarry Smith #if defined(PETSC_HAVE_ADIOS2)
1017*55d657eeSBarry Smith #endif
1018a56f64adSBarry Smith 
1019301d30feSBarry Smith   /*
1020301d30feSBarry Smith       Once we are completedly initialized then we can set this variables
1021301d30feSBarry Smith   */
1022301d30feSBarry Smith   PetscInitializeCalled = PETSC_TRUE;
1023301d30feSBarry Smith   PetscFunctionReturn(0);
1024e5c89e4eSSatish Balay }
1025e5c89e4eSSatish Balay 
10264097062eSBarry Smith #if defined(PETSC_USE_LOG)
10272eff7a51SBarry Smith extern PetscObject *PetscObjects;
10282eff7a51SBarry Smith extern PetscInt    PetscObjectsCounts, PetscObjectsMaxCounts;
102905df10baSBarry Smith extern PetscBool   PetscObjectsLog;
10304097062eSBarry Smith #endif
1031e5c89e4eSSatish Balay 
1032008a6e76SBarry Smith /*
1033008a6e76SBarry Smith     Frees all the MPI types and operations that PETSc may have created
1034008a6e76SBarry Smith */
1035008a6e76SBarry Smith PetscErrorCode  PetscFreeMPIResources(void)
1036008a6e76SBarry Smith {
1037008a6e76SBarry Smith   PetscErrorCode ierr;
1038008a6e76SBarry Smith 
1039008a6e76SBarry Smith   PetscFunctionBegin;
1040008a6e76SBarry Smith #if defined(PETSC_USE_REAL___FLOAT128)
1041008a6e76SBarry Smith   ierr = MPI_Type_free(&MPIU___FLOAT128);CHKERRQ(ierr);
1042008a6e76SBarry Smith #if defined(PETSC_HAVE_COMPLEX)
1043008a6e76SBarry Smith   ierr = MPI_Type_free(&MPIU___COMPLEX128);CHKERRQ(ierr);
1044008a6e76SBarry Smith #endif
1045008a6e76SBarry Smith   ierr = MPI_Op_free(&MPIU_MAX);CHKERRQ(ierr);
1046008a6e76SBarry Smith   ierr = MPI_Op_free(&MPIU_MIN);CHKERRQ(ierr);
1047008a6e76SBarry Smith #elif defined(PETSC_USE_REAL___FP16)
1048008a6e76SBarry Smith   ierr = MPI_Type_free(&MPIU___FP16);CHKERRQ(ierr);
1049008a6e76SBarry Smith   ierr = MPI_Op_free(&MPIU_MAX);CHKERRQ(ierr);
1050008a6e76SBarry Smith   ierr = MPI_Op_free(&MPIU_MIN);CHKERRQ(ierr);
1051008a6e76SBarry Smith #endif
1052008a6e76SBarry Smith 
1053008a6e76SBarry Smith #if defined(PETSC_HAVE_COMPLEX)
1054008a6e76SBarry Smith #if !defined(PETSC_HAVE_MPI_C_DOUBLE_COMPLEX)
1055008a6e76SBarry Smith   ierr = MPI_Type_free(&MPIU_C_DOUBLE_COMPLEX);CHKERRQ(ierr);
1056008a6e76SBarry Smith   ierr = MPI_Type_free(&MPIU_C_COMPLEX);CHKERRQ(ierr);
1057008a6e76SBarry Smith #endif
1058008a6e76SBarry Smith #endif
1059008a6e76SBarry Smith 
1060008a6e76SBarry Smith #if (defined(PETSC_HAVE_COMPLEX) && !defined(PETSC_HAVE_MPI_C_DOUBLE_COMPLEX)) || defined(PETSC_USE_REAL___FLOAT128) || defined(PETSC_USE_REAL___FP16)
1061008a6e76SBarry Smith   ierr = MPI_Op_free(&MPIU_SUM);CHKERRQ(ierr);
1062008a6e76SBarry Smith #endif
1063008a6e76SBarry Smith 
1064008a6e76SBarry Smith   ierr = MPI_Type_free(&MPIU_2SCALAR);CHKERRQ(ierr);
1065008a6e76SBarry Smith #if defined(PETSC_USE_64BIT_INDICES) || !defined(MPI_2INT)
1066008a6e76SBarry Smith   ierr = MPI_Type_free(&MPIU_2INT);CHKERRQ(ierr);
1067008a6e76SBarry Smith #endif
1068008a6e76SBarry Smith   ierr = MPI_Op_free(&MPIU_MAXSUM_OP);CHKERRQ(ierr);
1069008a6e76SBarry Smith   PetscFunctionReturn(0);
1070008a6e76SBarry Smith }
1071008a6e76SBarry Smith 
1072e5c89e4eSSatish Balay /*@C
1073e5c89e4eSSatish Balay    PetscFinalize - Checks for options to be called at the conclusion
1074e5c89e4eSSatish Balay    of the program. MPI_Finalize() is called only if the user had not
1075e5c89e4eSSatish Balay    called MPI_Init() before calling PetscInitialize().
1076e5c89e4eSSatish Balay 
1077e5c89e4eSSatish Balay    Collective on PETSC_COMM_WORLD
1078e5c89e4eSSatish Balay 
1079e5c89e4eSSatish Balay    Options Database Keys:
108088c29154SBarry Smith +  -options_table - Calls PetscOptionsView()
1081e5c89e4eSSatish Balay .  -options_left - Prints unused options that remain in the database
10827eb1d149SBarry Smith .  -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
1083e5c89e4eSSatish Balay .  -mpidump - Calls PetscMPIDump()
1084e5c89e4eSSatish Balay .  -malloc_dump - Calls PetscMallocDump()
1085e5c89e4eSSatish Balay .  -malloc_info - Prints total memory usage
1086e5c89e4eSSatish Balay -  -malloc_log - Prints summary of memory usage
1087e5c89e4eSSatish Balay 
1088e5c89e4eSSatish Balay    Level: beginner
1089e5c89e4eSSatish Balay 
1090e5c89e4eSSatish Balay    Note:
1091e5c89e4eSSatish Balay    See PetscInitialize() for more general runtime options.
1092e5c89e4eSSatish Balay 
109388c29154SBarry Smith .seealso: PetscInitialize(), PetscOptionsView(), PetscMallocDump(), PetscMPIDump(), PetscEnd()
1094e5c89e4eSSatish Balay @*/
10957087cfbeSBarry Smith PetscErrorCode  PetscFinalize(void)
1096e5c89e4eSSatish Balay {
1097e5c89e4eSSatish Balay   PetscErrorCode ierr;
10984bb5149bSJed Brown   PetscMPIInt    rank;
1099a8d2bbe5SBarry Smith   PetscInt       nopt;
11002bf49c77SBarry Smith   PetscBool      flg1 = PETSC_FALSE,flg2 = PETSC_FALSE,flg3 = PETSC_FALSE;
1101dff31646SBarry Smith   PetscBool      flg;
110210463e74SBarry Smith #if defined(PETSC_USE_LOG)
110310463e74SBarry Smith   char           mname[PETSC_MAX_PATH_LEN];
110410463e74SBarry Smith #endif
1105e5c89e4eSSatish Balay 
1106e5c89e4eSSatish Balay   if (!PetscInitializeCalled) {
11074b09e917SBarry Smith     printf("PetscInitialize() must be called before PetscFinalize()\n");
11083cbbc5ffSBarry Smith     return(PETSC_ERR_ARG_WRONGSTATE);
1109e5c89e4eSSatish Balay   }
11103cbbc5ffSBarry Smith   PetscFunctionBegin;
11110298fd71SBarry Smith   ierr = PetscInfo(NULL,"PetscFinalize() called\n");CHKERRQ(ierr);
1112b022a5c1SBarry Smith 
11131f817a21SBarry Smith   ierr = MPI_Comm_rank(PETSC_COMM_WORLD,&rank);CHKERRQ(ierr);
1114a56f64adSBarry Smith #if defined(PETSC_HAVE_ADIOS)
111522580e64SBarry Smith   ierr = adios_read_finalize_method(ADIOS_READ_METHOD_BP_AGGREGATE);CHKERRQ(ierr);
1116a56f64adSBarry Smith   ierr = adios_finalize(rank);CHKERRQ(ierr);
1117a56f64adSBarry Smith #endif
1118*55d657eeSBarry Smith #if defined(PETSC_HAVE_ADIOS2)
1119*55d657eeSBarry Smith #endif
1120c5929fdfSBarry Smith   ierr = PetscOptionsHasName(NULL,NULL,"-citations",&flg);CHKERRQ(ierr);
1121dff31646SBarry Smith   if (flg) {
11221f817a21SBarry Smith     char  *cits, filename[PETSC_MAX_PATH_LEN];
11231f817a21SBarry Smith     FILE  *fd = PETSC_STDOUT;
11241f817a21SBarry Smith 
1125c5929fdfSBarry Smith     ierr = PetscOptionsGetString(NULL,NULL,"-citations",filename,PETSC_MAX_PATH_LEN,NULL);CHKERRQ(ierr);
11261f817a21SBarry Smith     if (filename[0]) {
11271f817a21SBarry Smith       ierr = PetscFOpen(PETSC_COMM_WORLD,filename,"w",&fd);CHKERRQ(ierr);
11281f817a21SBarry Smith     }
1129dff31646SBarry Smith     ierr = PetscSegBufferGet(PetscCitationsList,1,&cits);CHKERRQ(ierr);
1130dff31646SBarry Smith     cits[0] = 0;
1131dff31646SBarry Smith     ierr = PetscSegBufferExtractAlloc(PetscCitationsList,&cits);CHKERRQ(ierr);
11321f817a21SBarry Smith     ierr = PetscFPrintf(PETSC_COMM_WORLD,fd,"If you publish results based on this computation please cite the following:\n");CHKERRQ(ierr);
11331f817a21SBarry Smith     ierr = PetscFPrintf(PETSC_COMM_WORLD,fd,"===========================================================================\n");CHKERRQ(ierr);
11341f817a21SBarry Smith     ierr = PetscFPrintf(PETSC_COMM_WORLD,fd,"%s",cits);CHKERRQ(ierr);
11351f817a21SBarry Smith     ierr = PetscFPrintf(PETSC_COMM_WORLD,fd,"===========================================================================\n");CHKERRQ(ierr);
11361f817a21SBarry Smith     ierr = PetscFClose(PETSC_COMM_WORLD,fd);CHKERRQ(ierr);
1137dff31646SBarry Smith     ierr = PetscFree(cits);CHKERRQ(ierr);
1138dff31646SBarry Smith   }
1139dff31646SBarry Smith   ierr = PetscSegBufferDestroy(&PetscCitationsList);CHKERRQ(ierr);
1140dff31646SBarry Smith 
1141c2a97968SBarry Smith #if defined(PETSC_HAVE_SSL) && defined(PETSC_USE_SOCKET_VIEWER)
114204102261SBarry Smith   /* TextBelt is run for testing purposes only, please do not use this feature often */
114304102261SBarry Smith   {
114404102261SBarry Smith     PetscInt nmax = 2;
114504102261SBarry Smith     char     **buffs;
114604102261SBarry Smith     ierr = PetscMalloc1(2,&buffs);CHKERRQ(ierr);
1147c5929fdfSBarry Smith     ierr = PetscOptionsGetStringArray(NULL,NULL,"-textbelt",buffs,&nmax,&flg1);CHKERRQ(ierr);
114804102261SBarry Smith     if (flg1) {
114904102261SBarry Smith       if (!nmax) SETERRQ(PETSC_COMM_WORLD,PETSC_ERR_USER,"-textbelt requires either the phone number or number,\"message\"");
115004102261SBarry Smith       if (nmax == 1) {
115104102261SBarry Smith         ierr = PetscMalloc1(128,&buffs[1]);CHKERRQ(ierr);
115204102261SBarry Smith         ierr = PetscGetProgramName(buffs[1],32);CHKERRQ(ierr);
115304102261SBarry Smith         ierr = PetscStrcat(buffs[1]," has completed");CHKERRQ(ierr);
115404102261SBarry Smith       }
115504102261SBarry Smith       ierr = PetscTextBelt(PETSC_COMM_WORLD,buffs[0],buffs[1],NULL);CHKERRQ(ierr);
115604102261SBarry Smith       ierr = PetscFree(buffs[0]);CHKERRQ(ierr);
115704102261SBarry Smith       ierr = PetscFree(buffs[1]);CHKERRQ(ierr);
115804102261SBarry Smith     }
115904102261SBarry Smith     ierr = PetscFree(buffs);CHKERRQ(ierr);
116004102261SBarry Smith   }
1161763ec7b1SBarry Smith   {
1162763ec7b1SBarry Smith     PetscInt nmax = 2;
1163763ec7b1SBarry Smith     char     **buffs;
1164763ec7b1SBarry Smith     ierr = PetscMalloc1(2,&buffs);CHKERRQ(ierr);
1165763ec7b1SBarry Smith     ierr = PetscOptionsGetStringArray(NULL,NULL,"-tellmycell",buffs,&nmax,&flg1);CHKERRQ(ierr);
1166763ec7b1SBarry Smith     if (flg1) {
1167763ec7b1SBarry Smith       if (!nmax) SETERRQ(PETSC_COMM_WORLD,PETSC_ERR_USER,"-tellmycell requires either the phone number or number,\"message\"");
1168763ec7b1SBarry Smith       if (nmax == 1) {
1169763ec7b1SBarry Smith         ierr = PetscMalloc1(128,&buffs[1]);CHKERRQ(ierr);
1170763ec7b1SBarry Smith         ierr = PetscGetProgramName(buffs[1],32);CHKERRQ(ierr);
1171763ec7b1SBarry Smith         ierr = PetscStrcat(buffs[1]," has completed");CHKERRQ(ierr);
1172763ec7b1SBarry Smith       }
1173763ec7b1SBarry Smith       ierr = PetscTellMyCell(PETSC_COMM_WORLD,buffs[0],buffs[1],NULL);CHKERRQ(ierr);
1174763ec7b1SBarry Smith       ierr = PetscFree(buffs[0]);CHKERRQ(ierr);
1175763ec7b1SBarry Smith       ierr = PetscFree(buffs[1]);CHKERRQ(ierr);
1176763ec7b1SBarry Smith     }
1177763ec7b1SBarry Smith     ierr = PetscFree(buffs);CHKERRQ(ierr);
1178763ec7b1SBarry Smith   }
117904102261SBarry Smith #endif
118067234432SDmitry Karpeev   /*
118167234432SDmitry Karpeev     It should be safe to cancel the options monitors, since we don't expect to be setting options
118267234432SDmitry Karpeev     here (at least that are worth monitoring).  Monitors ought to be released so that they release
118367234432SDmitry Karpeev     whatever memory was allocated there before -malloc_dump reports unfreed memory.
118467234432SDmitry Karpeev   */
118567234432SDmitry Karpeev   ierr = PetscOptionsMonitorCancel();CHKERRQ(ierr);
118604102261SBarry Smith 
11872d53ad75SBarry Smith #if defined(PETSC_SERIALIZE_FUNCTIONS)
11882d53ad75SBarry Smith   ierr = PetscFPTDestroy();CHKERRQ(ierr);
11892d53ad75SBarry Smith #endif
11902d53ad75SBarry Smith 
11912d53ad75SBarry Smith 
1192e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS)
1193dff31646SBarry Smith   flg = PETSC_FALSE;
1194c5929fdfSBarry Smith   ierr = PetscOptionsGetBool(NULL,NULL,"-saw_options",&flg,NULL);CHKERRQ(ierr);
1195d5649816SBarry Smith   if (flg) {
1196e04113cfSBarry Smith     ierr = PetscOptionsSAWsDestroy();CHKERRQ(ierr);
1197d5649816SBarry Smith   }
1198d5649816SBarry Smith #endif
1199d5649816SBarry Smith 
1200681455b2SBarry Smith #if defined(PETSC_HAVE_X)
1201681455b2SBarry Smith   flg1 = PETSC_FALSE;
1202c5929fdfSBarry Smith   ierr = PetscOptionsGetBool(NULL,NULL,"-x_virtual",&flg1,NULL);CHKERRQ(ierr);
1203681455b2SBarry Smith   if (flg1) {
1204681455b2SBarry Smith     /*  this is a crude hack, but better than nothing */
1205681455b2SBarry Smith     ierr = PetscPOpen(PETSC_COMM_WORLD,NULL,"pkill -9 Xvfb","r",NULL);CHKERRQ(ierr);
1206681455b2SBarry Smith   }
1207681455b2SBarry Smith #endif
1208681455b2SBarry Smith 
120967584ceeSBarry Smith #if !defined(PETSC_HAVE_THREADSAFETY)
1210c5929fdfSBarry Smith   ierr = PetscOptionsGetBool(NULL,NULL,"-malloc_info",&flg2,NULL);CHKERRQ(ierr);
1211e5c89e4eSSatish Balay   if (!flg2) {
121290d69ab7SBarry Smith     flg2 = PETSC_FALSE;
1213c5929fdfSBarry Smith     ierr = PetscOptionsGetBool(NULL,NULL,"-memory_view",&flg2,NULL);CHKERRQ(ierr);
1214e5c89e4eSSatish Balay   }
1215e5c89e4eSSatish Balay   if (flg2) {
12160841954dSBarry Smith     ierr = PetscMemoryView(PETSC_VIEWER_STDOUT_WORLD,"Summary of Memory Usage in PETSc\n");CHKERRQ(ierr);
1217e5c89e4eSSatish Balay   }
121867584ceeSBarry Smith #endif
1219e5c89e4eSSatish Balay 
1220e5c89e4eSSatish Balay #if defined(PETSC_USE_LOG)
122190d69ab7SBarry Smith   flg1 = PETSC_FALSE;
1222c5929fdfSBarry Smith   ierr = PetscOptionsGetBool(NULL,NULL,"-get_total_flops",&flg1,NULL);CHKERRQ(ierr);
1223e5c89e4eSSatish Balay   if (flg1) {
1224e5c89e4eSSatish Balay     PetscLogDouble flops = 0;
1225205a32c2SJed Brown     ierr = MPI_Reduce(&petsc_TotalFlops,&flops,1,MPI_DOUBLE,MPI_SUM,0,PETSC_COMM_WORLD);CHKERRQ(ierr);
1226e5c89e4eSSatish Balay     ierr = PetscPrintf(PETSC_COMM_WORLD,"Total flops over all processors %g\n",flops);CHKERRQ(ierr);
1227e5c89e4eSSatish Balay   }
1228e5c89e4eSSatish Balay #endif
1229e5c89e4eSSatish Balay 
1230e5c89e4eSSatish Balay 
1231e5c89e4eSSatish Balay #if defined(PETSC_USE_LOG)
1232e5c89e4eSSatish Balay #if defined(PETSC_HAVE_MPE)
1233e5c89e4eSSatish Balay   mname[0] = 0;
1234c5929fdfSBarry Smith   ierr = PetscOptionsGetString(NULL,NULL,"-log_mpe",mname,PETSC_MAX_PATH_LEN,&flg1);CHKERRQ(ierr);
1235e5c89e4eSSatish Balay   if (flg1) {
1236e5c89e4eSSatish Balay     if (mname[0]) {ierr = PetscLogMPEDump(mname);CHKERRQ(ierr);}
1237e5c89e4eSSatish Balay     else          {ierr = PetscLogMPEDump(0);CHKERRQ(ierr);}
1238e5c89e4eSSatish Balay   }
1239e5c89e4eSSatish Balay #endif
1240356e5837SBarry Smith #endif
1241a297a907SKarl Rupp 
1242dd710f27SBarry Smith   /*
1243dd710f27SBarry Smith      Free all objects registered with PetscObjectRegisterDestroy() such as PETSC_VIEWER_XXX_().
1244dd710f27SBarry Smith   */
1245dd710f27SBarry Smith   ierr = PetscObjectRegisterDestroyAll();CHKERRQ(ierr);
1246dd710f27SBarry Smith 
1247356e5837SBarry Smith #if defined(PETSC_USE_LOG)
1248f14045dbSBarry Smith   ierr = PetscLogViewFromOptions();CHKERRQ(ierr);
1249356e5837SBarry Smith   mname[0] = 0;
1250c5929fdfSBarry Smith   ierr = PetscOptionsGetString(NULL,NULL,"-log_summary",mname,PETSC_MAX_PATH_LEN,&flg1);CHKERRQ(ierr);
1251e5c89e4eSSatish Balay   if (flg1) {
125291eabc43SBarry Smith     PetscViewer viewer;
125320a8bfc3SBarry Smith     ierr = (*PetscHelpPrintf)(PETSC_COMM_WORLD,"\n\n WARNING:   -log_summary is being deprecated; switch to -log_view\n\n\n");CHKERRQ(ierr);
125491eabc43SBarry Smith     if (mname[0]) {
125591eabc43SBarry Smith       ierr = PetscViewerASCIIOpen(PETSC_COMM_WORLD,mname,&viewer);CHKERRQ(ierr);
125691eabc43SBarry Smith       ierr = PetscLogView(viewer);CHKERRQ(ierr);
12576bf464f9SBarry Smith       ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr);
125833f85c2fSBarry Smith     } else {
125933f85c2fSBarry Smith       viewer = PETSC_VIEWER_STDOUT_WORLD;
12609a9a5d4cSBarry Smith       ierr   = PetscViewerPushFormat(viewer,PETSC_VIEWER_DEFAULT);CHKERRQ(ierr);
126133f85c2fSBarry Smith       ierr   = PetscLogView(viewer);CHKERRQ(ierr);
12629a9a5d4cSBarry Smith       ierr   = PetscViewerPopFormat(viewer);CHKERRQ(ierr);
126333f85c2fSBarry Smith     }
1264e5c89e4eSSatish Balay   }
1265a297a907SKarl Rupp 
1266dd710f27SBarry Smith   /*
1267dd710f27SBarry Smith      Free any objects created by the last block of code.
1268dd710f27SBarry Smith   */
1269dd710f27SBarry Smith   ierr = PetscObjectRegisterDestroyAll();CHKERRQ(ierr);
1270dd710f27SBarry Smith 
1271dd710f27SBarry Smith   mname[0] = 0;
1272c5929fdfSBarry Smith   ierr = PetscOptionsGetString(NULL,NULL,"-log_all",mname,PETSC_MAX_PATH_LEN,&flg1);CHKERRQ(ierr);
1273c5929fdfSBarry Smith   ierr = PetscOptionsGetString(NULL,NULL,"-log",mname,PETSC_MAX_PATH_LEN,&flg2);CHKERRQ(ierr);
1274e5c89e4eSSatish Balay   if (flg1 || flg2) {
1275e5c89e4eSSatish Balay     if (mname[0]) PetscLogDump(mname);
1276e5c89e4eSSatish Balay     else          PetscLogDump(0);
1277e5c89e4eSSatish Balay   }
1278e5c89e4eSSatish Balay #endif
127910463e74SBarry Smith 
128033f85c2fSBarry Smith   ierr = PetscStackDestroy();CHKERRQ(ierr);
128110463e74SBarry Smith 
128290d69ab7SBarry Smith   flg1 = PETSC_FALSE;
1283c5929fdfSBarry Smith   ierr = PetscOptionsGetBool(NULL,NULL,"-no_signal_handler",&flg1,NULL);CHKERRQ(ierr);
1284e5c89e4eSSatish Balay   if (!flg1) { ierr = PetscPopSignalHandler();CHKERRQ(ierr);}
128590d69ab7SBarry Smith   flg1 = PETSC_FALSE;
1286c5929fdfSBarry Smith   ierr = PetscOptionsGetBool(NULL,NULL,"-mpidump",&flg1,NULL);CHKERRQ(ierr);
1287e5c89e4eSSatish Balay   if (flg1) {
1288e5c89e4eSSatish Balay     ierr = PetscMPIDump(stdout);CHKERRQ(ierr);
1289e5c89e4eSSatish Balay   }
129090d69ab7SBarry Smith   flg1 = PETSC_FALSE;
129190d69ab7SBarry Smith   flg2 = PETSC_FALSE;
12928bb29257SSatish Balay   /* preemptive call to avoid listing this option in options table as unused */
1293c5929fdfSBarry Smith   ierr = PetscOptionsHasName(NULL,NULL,"-malloc_dump",&flg1);CHKERRQ(ierr);
1294c5929fdfSBarry Smith   ierr = PetscOptionsHasName(NULL,NULL,"-objects_dump",&flg1);CHKERRQ(ierr);
1295c5929fdfSBarry Smith   ierr = PetscOptionsGetBool(NULL,NULL,"-options_view",&flg2,NULL);CHKERRQ(ierr);
1296e4c476e2SSatish Balay 
1297e5c89e4eSSatish Balay   if (flg2) {
1298be56827dSJed Brown     PetscViewer viewer;
129902ba9f54SBarry Smith     ierr = PetscViewerCreate(PETSC_COMM_WORLD,&viewer);CHKERRQ(ierr);
130002ba9f54SBarry Smith     ierr = PetscViewerSetType(viewer,PETSCVIEWERASCII);CHKERRQ(ierr);
1301c5929fdfSBarry Smith     ierr = PetscOptionsView(NULL,viewer);CHKERRQ(ierr);
1302be56827dSJed Brown     ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr);
1303e5c89e4eSSatish Balay   }
1304e5c89e4eSSatish Balay 
1305e5c89e4eSSatish Balay   /* to prevent PETSc -options_left from warning */
1306c5929fdfSBarry Smith   ierr = PetscOptionsHasName(NULL,NULL,"-nox",&flg1);CHKERRQ(ierr);
1307c5929fdfSBarry Smith   ierr = PetscOptionsHasName(NULL,NULL,"-nox_warning",&flg1);CHKERRQ(ierr);
1308e5c89e4eSSatish Balay 
130933fc4174SSatish Balay   flg3 = PETSC_FALSE; /* default value is required */
1310c5929fdfSBarry Smith   ierr = PetscOptionsGetBool(NULL,NULL,"-options_left",&flg3,&flg1);CHKERRQ(ierr);
1311c5929fdfSBarry Smith   ierr = PetscOptionsAllUsed(NULL,&nopt);CHKERRQ(ierr);
1312e5c89e4eSSatish Balay   if (flg3) {
1313e5c89e4eSSatish Balay     if (!flg2) { /* have not yet printed the options */
1314be56827dSJed Brown       PetscViewer viewer;
131502ba9f54SBarry Smith       ierr = PetscViewerCreate(PETSC_COMM_WORLD,&viewer);CHKERRQ(ierr);
131602ba9f54SBarry Smith       ierr = PetscViewerSetType(viewer,PETSCVIEWERASCII);CHKERRQ(ierr);
1317c5929fdfSBarry Smith       ierr = PetscOptionsView(NULL,viewer);CHKERRQ(ierr);
1318be56827dSJed Brown       ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr);
1319e5c89e4eSSatish Balay     }
1320e5c89e4eSSatish Balay     if (!nopt) {
1321e5c89e4eSSatish Balay       ierr = PetscPrintf(PETSC_COMM_WORLD,"There are no unused options.\n");CHKERRQ(ierr);
1322e5c89e4eSSatish Balay     } else if (nopt == 1) {
1323e5c89e4eSSatish Balay       ierr = PetscPrintf(PETSC_COMM_WORLD,"There is one unused database option. It is:\n");CHKERRQ(ierr);
1324e5c89e4eSSatish Balay     } else {
13257582186dSLisandro Dalcin       ierr = PetscPrintf(PETSC_COMM_WORLD,"There are %D unused database options. They are:\n",nopt);CHKERRQ(ierr);
1326e5c89e4eSSatish Balay     }
1327df12ba86SBarry Smith   }
1328e5c89e4eSSatish Balay #if defined(PETSC_USE_DEBUG)
1329da8b8a77SBarry Smith   if (nopt && !flg3 && !flg1) {
1330e5c89e4eSSatish Balay     ierr = PetscPrintf(PETSC_COMM_WORLD,"WARNING! There are options you set that were not used!\n");CHKERRQ(ierr);
1331e5c89e4eSSatish Balay     ierr = PetscPrintf(PETSC_COMM_WORLD,"WARNING! could be spelling mistake, etc!\n");CHKERRQ(ierr);
1332c5929fdfSBarry Smith     ierr = PetscOptionsLeft(NULL);CHKERRQ(ierr);
1333e5c89e4eSSatish Balay   } else if (nopt && flg3) {
1334e5c89e4eSSatish Balay #else
1335e5c89e4eSSatish Balay   if (nopt && flg3) {
1336e5c89e4eSSatish Balay #endif
1337c5929fdfSBarry Smith     ierr = PetscOptionsLeft(NULL);CHKERRQ(ierr);
1338e5c89e4eSSatish Balay   }
1339e5c89e4eSSatish Balay 
1340e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS)
1341d45a07a7SBarry Smith   if (!PetscGlobalRank) {
134287f587eeSBarry Smith     ierr = PetscStackSAWsViewOff();CHKERRQ(ierr);
134316ad0300SBarry Smith     PetscStackCallSAWs(SAWs_Finalize,());
1344d45a07a7SBarry Smith   }
1345ec957eceSBarry Smith #endif
1346ec957eceSBarry Smith 
13474097062eSBarry Smith #if defined(PETSC_USE_LOG)
134810463e74SBarry Smith   /*
1349dbc8283eSBarry Smith        List all objects the user may have forgot to free
13502eff7a51SBarry Smith   */
135105df10baSBarry Smith   if (PetscObjectsLog) {
1352c5929fdfSBarry Smith     ierr = PetscOptionsHasName(NULL,NULL,"-objects_dump",&flg1);CHKERRQ(ierr);
1353a64a8e02SBarry Smith     if (flg1) {
1354a64a8e02SBarry Smith       MPI_Comm local_comm;
13557eb1d149SBarry Smith       char     string[64];
1356a64a8e02SBarry Smith 
1357c5929fdfSBarry Smith       ierr = PetscOptionsGetString(NULL,NULL,"-objects_dump",string,64,NULL);CHKERRQ(ierr);
1358a64a8e02SBarry Smith       ierr = MPI_Comm_dup(MPI_COMM_WORLD,&local_comm);CHKERRQ(ierr);
1359a64a8e02SBarry Smith       ierr = PetscSequentialPhaseBegin_Private(local_comm,1);CHKERRQ(ierr);
13607eb1d149SBarry Smith       ierr = PetscObjectsDump(stdout,(string[0] == 'a') ? PETSC_TRUE : PETSC_FALSE);CHKERRQ(ierr);
1361a64a8e02SBarry Smith       ierr = PetscSequentialPhaseEnd_Private(local_comm,1);CHKERRQ(ierr);
1362a64a8e02SBarry Smith       ierr = MPI_Comm_free(&local_comm);CHKERRQ(ierr);
13630a1571b3SBarry Smith     }
136405df10baSBarry Smith   }
13654097062eSBarry Smith #endif
13664097062eSBarry Smith 
13674097062eSBarry Smith #if defined(PETSC_USE_LOG)
1368dbc8283eSBarry Smith   PetscObjectsCounts    = 0;
1369dbc8283eSBarry Smith   PetscObjectsMaxCounts = 0;
1370a297a907SKarl Rupp   ierr = PetscFree(PetscObjects);CHKERRQ(ierr);
13714097062eSBarry Smith #endif
13722eff7a51SBarry Smith 
137333f85c2fSBarry Smith   /*
137433f85c2fSBarry Smith      Destroy any packages that registered a finalize
137533f85c2fSBarry Smith   */
137633f85c2fSBarry Smith   ierr = PetscRegisterFinalizeAll();CHKERRQ(ierr);
137733f85c2fSBarry Smith 
1378101409b8SToby Isaac #if defined(PETSC_USE_LOG)
1379101409b8SToby Isaac   ierr = PetscLogDestroy();CHKERRQ(ierr);
1380101409b8SToby Isaac #endif
1381101409b8SToby Isaac 
138233f85c2fSBarry Smith   /*
138348dd1dffSBarry Smith      Print PetscFunctionLists that have not been properly freed
138448dd1dffSBarry Smith 
138537e93019SBarry Smith   ierr = PetscFunctionListPrintAll();CHKERRQ(ierr);
138648dd1dffSBarry Smith   */
138737e93019SBarry Smith 
13884028d114SSatish Balay   if (petsc_history) {
1389f3dea69dSBarry Smith     ierr = PetscCloseHistoryFile(&petsc_history);CHKERRQ(ierr);
1390e5c89e4eSSatish Balay     petsc_history = 0;
1391e5c89e4eSSatish Balay   }
13929de0f6ecSBarry Smith   ierr = PetscOptionsHelpPrintedDestroy(&PetscOptionsHelpPrintedSingleton);CHKERRQ(ierr);
1393e5c89e4eSSatish Balay 
13940298fd71SBarry Smith   ierr = PetscInfoAllow(PETSC_FALSE,NULL);CHKERRQ(ierr);
1395e5c89e4eSSatish Balay 
139667584ceeSBarry Smith #if !defined(PETSC_HAVE_THREADSAFETY)
13978bb29257SSatish Balay   {
1398e5c89e4eSSatish Balay     char fname[PETSC_MAX_PATH_LEN];
1399e5c89e4eSSatish Balay     FILE *fd;
1400ed9cf6e9SBarry Smith     int  err;
1401e5c89e4eSSatish Balay 
1402e5c89e4eSSatish Balay     fname[0] = 0;
1403a297a907SKarl Rupp 
1404c5929fdfSBarry Smith     ierr = PetscOptionsGetString(NULL,NULL,"-malloc_dump",fname,250,&flg1);CHKERRQ(ierr);
1405dc92acbaSJed Brown     flg2 = PETSC_FALSE;
1406c5929fdfSBarry Smith     ierr = PetscOptionsGetBool(NULL,NULL,"-malloc_test",&flg2,NULL);CHKERRQ(ierr);
14078bf1f09cSShri Abhyankar #if defined(PETSC_USE_DEBUG)
1408dc92acbaSJed Brown     if (PETSC_RUNNING_ON_VALGRIND) flg2 = PETSC_FALSE;
1409dc92acbaSJed Brown #else
1410dc92acbaSJed Brown     flg2 = PETSC_FALSE;         /* Skip reporting for optimized builds regardless of -malloc_test */
1411dc92acbaSJed Brown #endif
1412e5c89e4eSSatish Balay     if (flg1 && fname[0]) {
1413e5c89e4eSSatish Balay       char sname[PETSC_MAX_PATH_LEN];
1414e5c89e4eSSatish Balay 
14152e924ca5SSatish Balay       PetscSNPrintf(sname,PETSC_MAX_PATH_LEN,"%s_%d",fname,rank);
1416e32f2f54SBarry Smith       fd   = fopen(sname,"w"); if (!fd) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_FILE_OPEN,"Cannot open log file: %s",sname);
1417e5c89e4eSSatish Balay       ierr = PetscMallocDump(fd);CHKERRQ(ierr);
1418ed9cf6e9SBarry Smith       err  = fclose(fd);
1419e32f2f54SBarry Smith       if (err) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SYS,"fclose() failed on file");
1420dc92acbaSJed Brown     } else if (flg1 || flg2) {
1421e5c89e4eSSatish Balay       MPI_Comm local_comm;
1422e5c89e4eSSatish Balay 
1423e5c89e4eSSatish Balay       ierr = MPI_Comm_dup(MPI_COMM_WORLD,&local_comm);CHKERRQ(ierr);
1424e5c89e4eSSatish Balay       ierr = PetscSequentialPhaseBegin_Private(local_comm,1);CHKERRQ(ierr);
1425e5c89e4eSSatish Balay       ierr = PetscMallocDump(stdout);CHKERRQ(ierr);
1426e5c89e4eSSatish Balay       ierr = PetscSequentialPhaseEnd_Private(local_comm,1);CHKERRQ(ierr);
1427e5c89e4eSSatish Balay       ierr = MPI_Comm_free(&local_comm);CHKERRQ(ierr);
1428e5c89e4eSSatish Balay     }
1429e5c89e4eSSatish Balay   }
1430a64a8e02SBarry Smith 
14318bb29257SSatish Balay   {
1432e5c89e4eSSatish Balay     char fname[PETSC_MAX_PATH_LEN];
14330298fd71SBarry Smith     FILE *fd = NULL;
1434e5c89e4eSSatish Balay 
1435e5c89e4eSSatish Balay     fname[0] = 0;
1436a297a907SKarl Rupp 
1437c5929fdfSBarry Smith     ierr = PetscOptionsGetString(NULL,NULL,"-malloc_log",fname,250,&flg1);CHKERRQ(ierr);
1438c5929fdfSBarry Smith     ierr = PetscOptionsHasName(NULL,NULL,"-malloc_log_threshold",&flg2);CHKERRQ(ierr);
1439e5c89e4eSSatish Balay     if (flg1 && fname[0]) {
1440ed9cf6e9SBarry Smith       int err;
1441e5c89e4eSSatish Balay 
1442574034a9SJed Brown       if (!rank) {
1443574034a9SJed Brown         fd = fopen(fname,"w");
1444574034a9SJed Brown         if (!fd) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_FILE_OPEN,"Cannot open log file: %s",fname);
1445574034a9SJed Brown       }
1446e5c89e4eSSatish Balay       ierr = PetscMallocDumpLog(fd);CHKERRQ(ierr);
1447574034a9SJed Brown       if (fd) {
1448ed9cf6e9SBarry Smith         err = fclose(fd);
1449e32f2f54SBarry Smith         if (err) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SYS,"fclose() failed on file");
1450574034a9SJed Brown       }
1451574034a9SJed Brown     } else if (flg1 || flg2) {
1452e5c89e4eSSatish Balay       ierr = PetscMallocDumpLog(stdout);CHKERRQ(ierr);
1453e5c89e4eSSatish Balay     }
1454e5c89e4eSSatish Balay   }
145567584ceeSBarry Smith #endif
145620e2c332SMatthew G. Knepley 
14575486ca60SMatthew G. Knepley   /*
14585486ca60SMatthew G. Knepley      Close any open dynamic libraries
14595486ca60SMatthew G. Knepley   */
14605486ca60SMatthew G. Knepley   ierr = PetscFinalize_DynamicLibraries();CHKERRQ(ierr);
14615486ca60SMatthew G. Knepley 
1462e5c89e4eSSatish Balay   /* Can be destroyed only after all the options are used */
14634416b707SBarry Smith   ierr = PetscOptionsDestroyDefault();CHKERRQ(ierr);
1464e5c89e4eSSatish Balay 
1465e5c89e4eSSatish Balay   PetscGlobalArgc = 0;
1466e5c89e4eSSatish Balay   PetscGlobalArgs = 0;
1467e5c89e4eSSatish Balay 
1468008a6e76SBarry Smith   ierr = PetscFreeMPIResources();CHKERRQ(ierr);
1469e5c89e4eSSatish Balay 
1470dbc8283eSBarry Smith   /*
1471efb80d3cSBarry Smith      Destroy any known inner MPI_Comm's and attributes pointing to them
1472efb80d3cSBarry Smith      Note this will not destroy any new communicators the user has created.
1473efb80d3cSBarry Smith 
1474efb80d3cSBarry Smith      If all PETSc objects were not destroyed those left over objects will have hanging references to
1475efb80d3cSBarry Smith      the MPI_Comms that were freed; but that is ok because those PETSc objects will never be used again
1476dbc8283eSBarry Smith  */
1477b770b1f6SSatish Balay   {
1478dbc8283eSBarry Smith     PetscCommCounter *counter;
1479dbc8283eSBarry Smith     PetscMPIInt      flg;
1480dbc8283eSBarry Smith     MPI_Comm         icomm;
1481265f3f35SJed Brown     union {MPI_Comm comm; void *ptr;} ucomm;
148247435625SJed Brown     ierr = MPI_Comm_get_attr(PETSC_COMM_SELF,Petsc_InnerComm_keyval,&ucomm,&flg);CHKERRQ(ierr);
1483dbc8283eSBarry Smith     if (flg) {
1484265f3f35SJed Brown       icomm = ucomm.comm;
148547435625SJed Brown       ierr = MPI_Comm_get_attr(icomm,Petsc_Counter_keyval,&counter,&flg);CHKERRQ(ierr);
1486dbc8283eSBarry Smith       if (!flg) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_CORRUPT,"Inner MPI_Comm does not have expected tag/name counter, problem with corrupted memory");
1487dbc8283eSBarry Smith 
148847435625SJed Brown       ierr = MPI_Comm_delete_attr(PETSC_COMM_SELF,Petsc_InnerComm_keyval);CHKERRQ(ierr);
148947435625SJed Brown       ierr = MPI_Comm_delete_attr(icomm,Petsc_Counter_keyval);CHKERRQ(ierr);
1490efb80d3cSBarry Smith       ierr = MPI_Comm_free(&icomm);CHKERRQ(ierr);
1491dbc8283eSBarry Smith     }
149247435625SJed Brown     ierr = MPI_Comm_get_attr(PETSC_COMM_WORLD,Petsc_InnerComm_keyval,&ucomm,&flg);CHKERRQ(ierr);
1493dbc8283eSBarry Smith     if (flg) {
1494265f3f35SJed Brown       icomm = ucomm.comm;
149547435625SJed Brown       ierr = MPI_Comm_get_attr(icomm,Petsc_Counter_keyval,&counter,&flg);CHKERRQ(ierr);
1496dbc8283eSBarry Smith       if (!flg) SETERRQ(PETSC_COMM_WORLD,PETSC_ERR_ARG_CORRUPT,"Inner MPI_Comm does not have expected tag/name counter, problem with corrupted memory");
1497dbc8283eSBarry Smith 
149847435625SJed Brown       ierr = MPI_Comm_delete_attr(PETSC_COMM_WORLD,Petsc_InnerComm_keyval);CHKERRQ(ierr);
149947435625SJed Brown       ierr = MPI_Comm_delete_attr(icomm,Petsc_Counter_keyval);CHKERRQ(ierr);
1500efb80d3cSBarry Smith       ierr = MPI_Comm_free(&icomm);CHKERRQ(ierr);
1501dbc8283eSBarry Smith     }
1502b770b1f6SSatish Balay   }
1503dbc8283eSBarry Smith 
150447435625SJed Brown   ierr = MPI_Comm_free_keyval(&Petsc_Counter_keyval);CHKERRQ(ierr);
150547435625SJed Brown   ierr = MPI_Comm_free_keyval(&Petsc_InnerComm_keyval);CHKERRQ(ierr);
150647435625SJed Brown   ierr = MPI_Comm_free_keyval(&Petsc_OuterComm_keyval);CHKERRQ(ierr);
150747435625SJed Brown   ierr = MPI_Comm_free_keyval(&Petsc_Shared_keyval);CHKERRQ(ierr);
1508480cf27aSJed Brown 
15095ad9ad5bSBarry Smith   ierr = PetscSpinlockDestroy(&PetscViewerASCIISpinLockOpen);CHKERRQ(ierr);
15105ad9ad5bSBarry Smith   ierr = PetscSpinlockDestroy(&PetscViewerASCIISpinLockStdout);CHKERRQ(ierr);
15115ad9ad5bSBarry Smith   ierr = PetscSpinlockDestroy(&PetscViewerASCIISpinLockStderr);CHKERRQ(ierr);
1512ef19f930SBarry Smith   ierr = PetscSpinlockDestroy(&PetscCommSpinLock);CHKERRQ(ierr);
1513ef19f930SBarry Smith 
1514e5c89e4eSSatish Balay   if (PetscBeganMPI) {
151599608316SBarry Smith #if defined(PETSC_HAVE_MPI_FINALIZED)
151699b1327fSBarry Smith     PetscMPIInt flag;
151799b1327fSBarry Smith     ierr = MPI_Finalized(&flag);CHKERRQ(ierr);
1518e32f2f54SBarry Smith     if (flag) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_LIB,"MPI_Finalize() has already been called, even though MPI_Init() was called by PetscInitialize()");
151999608316SBarry Smith #endif
1520e5c89e4eSSatish Balay     ierr = MPI_Finalize();CHKERRQ(ierr);
1521e5c89e4eSSatish Balay   }
1522e5c89e4eSSatish Balay /*
1523e5c89e4eSSatish Balay 
1524e5c89e4eSSatish Balay      Note: In certain cases PETSC_COMM_WORLD is never MPI_Comm_free()ed because
1525e5c89e4eSSatish Balay    the communicator has some outstanding requests on it. Specifically if the
1526e5c89e4eSSatish Balay    flag PETSC_HAVE_BROKEN_REQUEST_FREE is set (for IBM MPI implementation). See
1527e5c89e4eSSatish Balay    src/vec/utils/vpscat.c. Due to this the memory allocated in PetscCommDuplicate()
1528e5c89e4eSSatish Balay    is never freed as it should be. Thus one may obtain messages of the form
15290e5e90baSSatish Balay    [ 1] 8 bytes PetscCommDuplicate() line 645 in src/sys/mpiu.c indicating the
1530e5c89e4eSSatish Balay    memory was not freed.
1531e5c89e4eSSatish Balay 
1532e5c89e4eSSatish Balay */
15331d1a0024SBarry Smith   ierr = PetscMallocClear();CHKERRQ(ierr);
1534a297a907SKarl Rupp 
1535e5c89e4eSSatish Balay   PetscInitializeCalled = PETSC_FALSE;
1536e5c89e4eSSatish Balay   PetscFinalizeCalled   = PETSC_TRUE;
15373db9a53dSBarry Smith   PetscFunctionReturn(0);
1538e5c89e4eSSatish Balay }
1539e5c89e4eSSatish Balay 
154043db4dbbSBarry Smith #if defined(PETSC_MISSING_LAPACK_lsame_)
15418cc058d9SJed Brown PETSC_EXTERN int lsame_(char *a,char *b)
154243db4dbbSBarry Smith {
154343db4dbbSBarry Smith   if (*a == *b) return 1;
154443db4dbbSBarry Smith   if (*a + 32 == *b) return 1;
154543db4dbbSBarry Smith   if (*a - 32 == *b) return 1;
154643db4dbbSBarry Smith   return 0;
154743db4dbbSBarry Smith }
1548a70650f6SBarry Smith #endif
154943db4dbbSBarry Smith 
155043db4dbbSBarry Smith #if defined(PETSC_MISSING_LAPACK_lsame)
15518cc058d9SJed Brown PETSC_EXTERN int lsame(char *a,char *b)
155243db4dbbSBarry Smith {
155343db4dbbSBarry Smith   if (*a == *b) return 1;
155443db4dbbSBarry Smith   if (*a + 32 == *b) return 1;
155543db4dbbSBarry Smith   if (*a - 32 == *b) return 1;
155643db4dbbSBarry Smith   return 0;
155743db4dbbSBarry Smith }
155843db4dbbSBarry Smith #endif
1559