xref: /petsc/src/sys/objects/pinit.c (revision eb27c7c8e0383f8dd4d9e3db12bf6ddf57d4ad20)
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)
1095c0884eSLisandro Dalcin PETSC_INTERN PetscErrorCode PetscLogInitialize(void);
1195c0884eSLisandro Dalcin PETSC_INTERN PetscErrorCode PetscLogFinalize(void);
12a9f03627SSatish Balay #endif
13f2d66bcaSShri Abhyankar 
142d53ad75SBarry Smith #if defined(PETSC_SERIALIZE_FUNCTIONS)
1595c0884eSLisandro Dalcin PETSC_INTERN PetscFPT PetscFPTData;
162d53ad75SBarry Smith PetscFPT PetscFPTData = 0;
172d53ad75SBarry Smith #endif
182d53ad75SBarry Smith 
19a6790183SBarry Smith #if defined(PETSC_HAVE_SAWS)
2016ad0300SBarry Smith #include <petscviewersaws.h>
21a6790183SBarry Smith #endif
22e5c89e4eSSatish Balay /* -----------------------------------------------------------------------------------------*/
23e5c89e4eSSatish Balay 
2495c0884eSLisandro Dalcin PETSC_INTERN FILE *petsc_history;
25e5c89e4eSSatish Balay 
2695c0884eSLisandro Dalcin PETSC_INTERN PetscErrorCode PetscInitialize_DynamicLibraries(void);
2795c0884eSLisandro Dalcin PETSC_INTERN PetscErrorCode PetscFinalize_DynamicLibraries(void);
2895c0884eSLisandro Dalcin PETSC_INTERN PetscErrorCode PetscFunctionListPrintAll(void);
2995c0884eSLisandro Dalcin PETSC_INTERN PetscErrorCode PetscSequentialPhaseBegin_Private(MPI_Comm,int);
3095c0884eSLisandro Dalcin PETSC_INTERN PetscErrorCode PetscSequentialPhaseEnd_Private(MPI_Comm,int);
3195c0884eSLisandro Dalcin PETSC_INTERN PetscErrorCode PetscCloseHistoryFile(FILE**);
320069ddf5SShri Abhyankar 
33e5c89e4eSSatish Balay /* user may set this BEFORE calling PetscInitialize() */
34e8373e55SMatthew Knepley MPI_Comm PETSC_COMM_WORLD = MPI_COMM_NULL;
35e5c89e4eSSatish Balay 
36480cf27aSJed Brown PetscMPIInt Petsc_Counter_keyval   = MPI_KEYVAL_INVALID;
37480cf27aSJed Brown PetscMPIInt Petsc_InnerComm_keyval = MPI_KEYVAL_INVALID;
38480cf27aSJed Brown PetscMPIInt Petsc_OuterComm_keyval = MPI_KEYVAL_INVALID;
3942218b76SBarry Smith PetscMPIInt Petsc_Shared_keyval    = MPI_KEYVAL_INVALID;
40480cf27aSJed Brown 
41e5c89e4eSSatish Balay /*
42e5c89e4eSSatish Balay      Declare and set all the string names of the PETSc enums
43e5c89e4eSSatish Balay */
446a6fc655SJed Brown const char *const PetscBools[]     = {"FALSE","TRUE","PetscBool","PETSC_",0};
456a6fc655SJed Brown const char *const PetscCopyModes[] = {"COPY_VALUES","OWN_POINTER","USE_POINTER","PetscCopyMode","PETSC_",0};
466a6fc655SJed Brown const char *const PetscDataTypes[] = {"INT","DOUBLE","COMPLEX","LONG","SHORT","FLOAT",
472d53ad75SBarry Smith                                       "CHAR","LOGICAL","ENUM","BOOL","LONGDOUBLE","OBJECT","FUNCTION","PetscDataType","PETSC_",0};
48e5c89e4eSSatish Balay 
49ace3abfcSBarry Smith PetscBool PetscPreLoadingUsed = PETSC_FALSE;
50ace3abfcSBarry Smith PetscBool PetscPreLoadingOn   = PETSC_FALSE;
510f8e0872SSatish Balay 
52a2f94806SJed Brown PetscInt PetscHotRegionDepth;
53a2f94806SJed Brown 
54b22622e2STadeu Manoel #if defined(PETSC_HAVE_THREADSAFETY)
55b22622e2STadeu Manoel PetscSpinlock PetscViewerASCIISpinLockOpen;
56b22622e2STadeu Manoel PetscSpinlock PetscViewerASCIISpinLockStdout;
57b22622e2STadeu Manoel PetscSpinlock PetscViewerASCIISpinLockStderr;
58b22622e2STadeu Manoel PetscSpinlock PetscCommSpinLock;
59b22622e2STadeu Manoel #endif
60b22622e2STadeu Manoel 
61e5c89e4eSSatish Balay /*
62e5c89e4eSSatish Balay        Checks the options database for initializations related to the
63e5c89e4eSSatish Balay     PETSc components
64e5c89e4eSSatish Balay */
6595c0884eSLisandro Dalcin PETSC_INTERN PetscErrorCode  PetscOptionsCheckInitial_Components(void)
66e5c89e4eSSatish Balay {
67ace3abfcSBarry Smith   PetscBool      flg1;
68e5c89e4eSSatish Balay   PetscErrorCode ierr;
69e5c89e4eSSatish Balay 
70e5c89e4eSSatish Balay   PetscFunctionBegin;
71c5929fdfSBarry Smith   ierr = PetscOptionsHasName(NULL,NULL,"-help",&flg1);CHKERRQ(ierr);
72e5c89e4eSSatish Balay   if (flg1) {
73e5c89e4eSSatish Balay #if defined(PETSC_USE_LOG)
74e8e7597cSSatish Balay     MPI_Comm comm = PETSC_COMM_WORLD;
75e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm,"------Additional PETSc component options--------\n");CHKERRQ(ierr);
768e81d068SLisandro Dalcin     ierr = (*PetscHelpPrintf)(comm," -log_exclude: <vec,mat,pc,ksp,snes,tao,ts>\n");CHKERRQ(ierr);
778e81d068SLisandro Dalcin     ierr = (*PetscHelpPrintf)(comm," -info_exclude: <null,vec,mat,pc,ksp,snes,tao,ts>\n");CHKERRQ(ierr);
78e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm,"-----------------------------------------------\n");CHKERRQ(ierr);
79e5c89e4eSSatish Balay #endif
80e5c89e4eSSatish Balay   }
81e5c89e4eSSatish Balay   PetscFunctionReturn(0);
82e5c89e4eSSatish Balay }
83e5c89e4eSSatish Balay 
840f11a792SBarry Smith /*
85945d1669SBarry Smith       PetscInitializeNoPointers - Calls PetscInitialize() from C/C++ without the pointers to argc and args
8672a42c3cSBarry Smith 
8772a42c3cSBarry Smith    Collective
8872a42c3cSBarry Smith 
8972a42c3cSBarry Smith    Level: advanced
9072a42c3cSBarry Smith 
9195452b02SPatrick Sanan     Notes:
9295452b02SPatrick Sanan     this is called only by the PETSc MATLAB and Julia interface. Even though it might start MPI it sets the flag to
930f11a792SBarry Smith      indicate that it did NOT start MPI so that the PetscFinalize() does not end MPI, thus allowing PetscInitialize() to
94945d1669SBarry Smith      be called multiple times from MATLAB and Julia without the problem of trying to initialize MPI more than once.
950f11a792SBarry Smith 
961ea5a559SBarry Smith      Turns off PETSc signal handling because that can interact with MATLAB's signal handling causing random crashes.
971ea5a559SBarry Smith 
9872a42c3cSBarry Smith .seealso: PetscInitialize(), PetscInitializeFortran(), PetscInitializeNoArguments()
990f11a792SBarry Smith */
100945d1669SBarry Smith PetscErrorCode  PetscInitializeNoPointers(int argc,char **args,const char *filename,const char *help)
10172a42c3cSBarry Smith {
10272a42c3cSBarry Smith   PetscErrorCode ierr;
10372a42c3cSBarry Smith   int            myargc   = argc;
10472a42c3cSBarry Smith   char           **myargs = args;
10572a42c3cSBarry Smith 
10672a42c3cSBarry Smith   PetscFunctionBegin;
1073bf036e2SBarry Smith   ierr = PetscInitialize(&myargc,&myargs,filename,help);CHKERRQ(ierr);
1081ea5a559SBarry Smith   ierr = PetscPopSignalHandler();CHKERRQ(ierr);
109df413903SBarry Smith   PetscBeganMPI = PETSC_FALSE;
11072a42c3cSBarry Smith   PetscFunctionReturn(ierr);
11172a42c3cSBarry Smith }
11272a42c3cSBarry Smith 
113f0865b08SBarry Smith /*
114945d1669SBarry Smith       Used by MATLAB and Julia interface to get communicator
115f0865b08SBarry Smith */
116945d1669SBarry Smith PetscErrorCode  PetscGetPETSC_COMM_SELF(MPI_Comm *comm)
117f0865b08SBarry Smith {
118f0865b08SBarry Smith   PetscFunctionBegin;
119f0865b08SBarry Smith   *comm = PETSC_COMM_SELF;
120f0865b08SBarry Smith   PetscFunctionReturn(0);
121f0865b08SBarry Smith }
122f0865b08SBarry Smith 
123e5c89e4eSSatish Balay /*@C
124e5c89e4eSSatish Balay       PetscInitializeNoArguments - Calls PetscInitialize() from C/C++ without
125e5c89e4eSSatish Balay         the command line arguments.
126e5c89e4eSSatish Balay 
127e5c89e4eSSatish Balay    Collective
128e5c89e4eSSatish Balay 
129e5c89e4eSSatish Balay    Level: advanced
130e5c89e4eSSatish Balay 
131e5c89e4eSSatish Balay .seealso: PetscInitialize(), PetscInitializeFortran()
132e5c89e4eSSatish Balay @*/
1337087cfbeSBarry Smith PetscErrorCode  PetscInitializeNoArguments(void)
134e5c89e4eSSatish Balay {
135e5c89e4eSSatish Balay   PetscErrorCode ierr;
136e5c89e4eSSatish Balay   int            argc   = 0;
137e5c89e4eSSatish Balay   char           **args = 0;
138e5c89e4eSSatish Balay 
139e5c89e4eSSatish Balay   PetscFunctionBegin;
1400298fd71SBarry Smith   ierr = PetscInitialize(&argc,&args,NULL,NULL);
141e5c89e4eSSatish Balay   PetscFunctionReturn(ierr);
142e5c89e4eSSatish Balay }
143e5c89e4eSSatish Balay 
144e5c89e4eSSatish Balay /*@
145e5c89e4eSSatish Balay       PetscInitialized - Determine whether PETSc is initialized.
146e5c89e4eSSatish Balay 
14793b6d2d1SJed Brown    Level: beginner
148e5c89e4eSSatish Balay 
149e5c89e4eSSatish Balay .seealso: PetscInitialize(), PetscInitializeNoArguments(), PetscInitializeFortran()
150e5c89e4eSSatish Balay @*/
1517087cfbeSBarry Smith PetscErrorCode PetscInitialized(PetscBool  *isInitialized)
152e5c89e4eSSatish Balay {
153e5c89e4eSSatish Balay   *isInitialized = PetscInitializeCalled;
15493b6d2d1SJed Brown   return 0;
155e5c89e4eSSatish Balay }
156e5c89e4eSSatish Balay 
157e5c89e4eSSatish Balay /*@
158e5c89e4eSSatish Balay       PetscFinalized - Determine whether PetscFinalize() has been called yet
159e5c89e4eSSatish Balay 
160e5c89e4eSSatish Balay    Level: developer
161e5c89e4eSSatish Balay 
162e5c89e4eSSatish Balay .seealso: PetscInitialize(), PetscInitializeNoArguments(), PetscInitializeFortran()
163e5c89e4eSSatish Balay @*/
1647087cfbeSBarry Smith PetscErrorCode  PetscFinalized(PetscBool  *isFinalized)
165e5c89e4eSSatish Balay {
166e5c89e4eSSatish Balay   *isFinalized = PetscFinalizeCalled;
16793b6d2d1SJed Brown   return 0;
168e5c89e4eSSatish Balay }
169e5c89e4eSSatish Balay 
17095c0884eSLisandro Dalcin PETSC_INTERN PetscErrorCode PetscOptionsCheckInitial_Private(void);
171e5c89e4eSSatish Balay 
172e5c89e4eSSatish Balay /*
173e5c89e4eSSatish Balay        This function is the MPI reduction operation used to compute the sum of the
174e5c89e4eSSatish Balay    first half of the datatype and the max of the second half.
175e5c89e4eSSatish Balay */
176367daffbSBarry Smith MPI_Op MPIU_MAXSUM_OP = 0;
177e5c89e4eSSatish Balay 
178367daffbSBarry Smith PETSC_INTERN void MPIAPI MPIU_MaxSum_Local(void *in,void *out,int *cnt,MPI_Datatype *datatype)
179e5c89e4eSSatish Balay {
180e5c89e4eSSatish Balay   PetscInt *xin = (PetscInt*)in,*xout = (PetscInt*)out,i,count = *cnt;
181e5c89e4eSSatish Balay 
182e5c89e4eSSatish Balay   PetscFunctionBegin;
183e5c89e4eSSatish Balay   if (*datatype != MPIU_2INT) {
184e5c89e4eSSatish Balay     (*PetscErrorPrintf)("Can only handle MPIU_2INT data types");
185e5c89e4eSSatish Balay     MPI_Abort(MPI_COMM_WORLD,1);
186e5c89e4eSSatish Balay   }
187e5c89e4eSSatish Balay 
188e5c89e4eSSatish Balay   for (i=0; i<count; i++) {
189e5c89e4eSSatish Balay     xout[2*i]    = PetscMax(xout[2*i],xin[2*i]);
190e5c89e4eSSatish Balay     xout[2*i+1] += xin[2*i+1];
191e5c89e4eSSatish Balay   }
192812af9f3SBarry Smith   PetscFunctionReturnVoid();
193e5c89e4eSSatish Balay }
194e5c89e4eSSatish Balay 
195e5c89e4eSSatish Balay /*
196e5c89e4eSSatish Balay     Returns the max of the first entry owned by this processor and the
197e5c89e4eSSatish Balay sum of the second entry.
198b693b147SBarry Smith 
19976f543a4SJed Brown     The reason sizes[2*i] contains lengths sizes[2*i+1] contains flag of 1 if length is nonzero
200367daffbSBarry Smith is so that the MPIU_MAXSUM_OP() can set TWO values, if we passed in only sizes[i] with lengths
201b693b147SBarry Smith there would be no place to store the both needed results.
202e5c89e4eSSatish Balay */
20376ec1555SBarry Smith PetscErrorCode  PetscMaxSum(MPI_Comm comm,const PetscInt sizes[],PetscInt *max,PetscInt *sum)
204e5c89e4eSSatish Balay {
205e5c89e4eSSatish Balay   PetscErrorCode ierr;
206e5c89e4eSSatish Balay 
207e5c89e4eSSatish Balay   PetscFunctionBegin;
208d6e4c47cSJed Brown #if defined(PETSC_HAVE_MPI_REDUCE_SCATTER_BLOCK)
209d6e4c47cSJed Brown   {
210d6e4c47cSJed Brown     struct {PetscInt max,sum;} work;
211367daffbSBarry Smith     ierr = MPI_Reduce_scatter_block((void*)sizes,&work,1,MPIU_2INT,MPIU_MAXSUM_OP,comm);CHKERRQ(ierr);
212d6e4c47cSJed Brown     *max = work.max;
213d6e4c47cSJed Brown     *sum = work.sum;
214d6e4c47cSJed Brown   }
215d6e4c47cSJed Brown #else
216d6e4c47cSJed Brown   {
217d6e4c47cSJed Brown     PetscMPIInt    size,rank;
218d6e4c47cSJed Brown     struct {PetscInt max,sum;} *work;
219e5c89e4eSSatish Balay     ierr = MPI_Comm_size(comm,&size);CHKERRQ(ierr);
220e5c89e4eSSatish Balay     ierr = MPI_Comm_rank(comm,&rank);CHKERRQ(ierr);
221785e854fSJed Brown     ierr = PetscMalloc1(size,&work);CHKERRQ(ierr);
222367daffbSBarry Smith     ierr = MPIU_Allreduce((void*)sizes,work,size,MPIU_2INT,MPIU_MAXSUM_OP,comm);CHKERRQ(ierr);
2236ac3741eSJed Brown     *max = work[rank].max;
2246ac3741eSJed Brown     *sum = work[rank].sum;
225e5c89e4eSSatish Balay     ierr = PetscFree(work);CHKERRQ(ierr);
226d6e4c47cSJed Brown   }
227d6e4c47cSJed Brown #endif
228e5c89e4eSSatish Balay   PetscFunctionReturn(0);
229e5c89e4eSSatish Balay }
230e5c89e4eSSatish Balay 
231e5c89e4eSSatish Balay /* ----------------------------------------------------------------------------*/
232e5c89e4eSSatish Balay 
233570b7f6dSBarry Smith #if (defined(PETSC_HAVE_COMPLEX) && !defined(PETSC_HAVE_MPI_C_DOUBLE_COMPLEX)) || defined(PETSC_USE_REAL___FLOAT128) || defined(PETSC_USE_REAL___FP16)
23406a205a8SBarry Smith MPI_Op MPIU_SUM = 0;
235e5c89e4eSSatish Balay 
2368cc058d9SJed Brown PETSC_EXTERN void PetscSum_Local(void *in,void *out,PetscMPIInt *cnt,MPI_Datatype *datatype)
237e5c89e4eSSatish Balay {
238e5c89e4eSSatish Balay   PetscInt i,count = *cnt;
239e5c89e4eSSatish Balay 
240e5c89e4eSSatish Balay   PetscFunctionBegin;
2417c2de775SJed Brown   if (*datatype == MPIU_REAL) {
242e2e03761SBarry Smith     PetscReal *xin = (PetscReal*)in,*xout = (PetscReal*)out;
243a297a907SKarl Rupp     for (i=0; i<count; i++) xout[i] += xin[i];
2447c2de775SJed Brown   }
2457c2de775SJed Brown #if defined(PETSC_HAVE_COMPLEX)
2467c2de775SJed Brown   else if (*datatype == MPIU_COMPLEX) {
2477c2de775SJed Brown     PetscComplex *xin = (PetscComplex*)in,*xout = (PetscComplex*)out;
248a297a907SKarl Rupp     for (i=0; i<count; i++) xout[i] += xin[i];
2497c2de775SJed Brown   }
2507c2de775SJed Brown #endif
2517c2de775SJed Brown   else {
2527c2de775SJed Brown     (*PetscErrorPrintf)("Can only handle MPIU_REAL or MPIU_COMPLEX data types");
253e2e03761SBarry Smith     MPI_Abort(MPI_COMM_WORLD,1);
254e2e03761SBarry Smith   }
255812af9f3SBarry Smith   PetscFunctionReturnVoid();
256e5c89e4eSSatish Balay }
257e5c89e4eSSatish Balay #endif
258e5c89e4eSSatish Balay 
259570b7f6dSBarry Smith #if defined(PETSC_USE_REAL___FLOAT128) || defined(PETSC_USE_REAL___FP16)
260d9822059SBarry Smith MPI_Op MPIU_MAX = 0;
261d9822059SBarry Smith MPI_Op MPIU_MIN = 0;
262d9822059SBarry Smith 
2638cc058d9SJed Brown PETSC_EXTERN void PetscMax_Local(void *in,void *out,PetscMPIInt *cnt,MPI_Datatype *datatype)
264d9822059SBarry Smith {
265d9822059SBarry Smith   PetscInt i,count = *cnt;
266d9822059SBarry Smith 
267d9822059SBarry Smith   PetscFunctionBegin;
2687c2de775SJed Brown   if (*datatype == MPIU_REAL) {
2698c764dc5SJose Roman     PetscReal *xin = (PetscReal*)in,*xout = (PetscReal*)out;
270a297a907SKarl Rupp     for (i=0; i<count; i++) xout[i] = PetscMax(xout[i],xin[i]);
2717c2de775SJed Brown   }
2727c2de775SJed Brown #if defined(PETSC_HAVE_COMPLEX)
2737c2de775SJed Brown   else if (*datatype == MPIU_COMPLEX) {
2747c2de775SJed Brown     PetscComplex *xin = (PetscComplex*)in,*xout = (PetscComplex*)out;
2757c2de775SJed Brown     for (i=0; i<count; i++) {
2767c2de775SJed Brown       xout[i] = PetscRealPartComplex(xout[i])<PetscRealPartComplex(xin[i]) ? xin[i] : xout[i];
2777c2de775SJed Brown     }
2787c2de775SJed Brown   }
2797c2de775SJed Brown #endif
2807c2de775SJed Brown   else {
2817c2de775SJed Brown     (*PetscErrorPrintf)("Can only handle MPIU_REAL or MPIU_COMPLEX data types");
2828c764dc5SJose Roman     MPI_Abort(MPI_COMM_WORLD,1);
2838c764dc5SJose Roman   }
284d9822059SBarry Smith   PetscFunctionReturnVoid();
285d9822059SBarry Smith }
286d9822059SBarry Smith 
2878cc058d9SJed Brown PETSC_EXTERN void PetscMin_Local(void *in,void *out,PetscMPIInt *cnt,MPI_Datatype *datatype)
288d9822059SBarry Smith {
289d9822059SBarry Smith   PetscInt    i,count = *cnt;
290d9822059SBarry Smith 
291d9822059SBarry Smith   PetscFunctionBegin;
2927c2de775SJed Brown   if (*datatype == MPIU_REAL) {
2938c764dc5SJose Roman     PetscReal *xin = (PetscReal*)in,*xout = (PetscReal*)out;
294a297a907SKarl Rupp     for (i=0; i<count; i++) xout[i] = PetscMin(xout[i],xin[i]);
2957c2de775SJed Brown   }
2967c2de775SJed Brown #if defined(PETSC_HAVE_COMPLEX)
2977c2de775SJed Brown   else if (*datatype == MPIU_COMPLEX) {
2987c2de775SJed Brown     PetscComplex *xin = (PetscComplex*)in,*xout = (PetscComplex*)out;
2997c2de775SJed Brown     for (i=0; i<count; i++) {
3007c2de775SJed Brown       xout[i] = PetscRealPartComplex(xout[i])>PetscRealPartComplex(xin[i]) ? xin[i] : xout[i];
3017c2de775SJed Brown     }
3027c2de775SJed Brown   }
3037c2de775SJed Brown #endif
3047c2de775SJed Brown   else {
3058c764dc5SJose Roman     (*PetscErrorPrintf)("Can only handle MPIU_REAL or MPIU_SCALAR data (i.e. double or complex) types");
3068c764dc5SJose Roman     MPI_Abort(MPI_COMM_WORLD,1);
3078c764dc5SJose Roman   }
308d9822059SBarry Smith   PetscFunctionReturnVoid();
309d9822059SBarry Smith }
310d9822059SBarry Smith #endif
311d9822059SBarry Smith 
312480cf27aSJed Brown /*
313480cf27aSJed Brown    Private routine to delete internal tag/name counter storage when a communicator is freed.
314480cf27aSJed Brown 
315ff0e51ddSBarry 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.
316480cf27aSJed Brown 
31712801b39SBarry Smith    Note: this is declared extern "C" because it is passed to MPI_Comm_create_keyval()
318480cf27aSJed Brown 
319480cf27aSJed Brown */
3208cc058d9SJed Brown PETSC_EXTERN PetscMPIInt MPIAPI Petsc_DelCounter(MPI_Comm comm,PetscMPIInt keyval,void *count_val,void *extra_state)
321480cf27aSJed Brown {
322480cf27aSJed Brown   PetscErrorCode ierr;
323480cf27aSJed Brown 
324480cf27aSJed Brown   PetscFunctionBegin;
32512801b39SBarry Smith   ierr = PetscInfo1(0,"Deleting counter data in an MPI_Comm %ld\n",(long)comm);CHKERRMPI(ierr);
32612801b39SBarry Smith   ierr = PetscFree(count_val);CHKERRMPI(ierr);
327480cf27aSJed Brown   PetscFunctionReturn(MPI_SUCCESS);
328480cf27aSJed Brown }
329480cf27aSJed Brown 
330480cf27aSJed Brown /*
33147435625SJed Brown   This is invoked on the outer comm as a result of either PetscCommDestroy() (via MPI_Comm_delete_attr) or when the user
332da3039f7SJed Brown   calls MPI_Comm_free().
333da3039f7SJed Brown 
334da3039f7SJed Brown   This is the only entry point for breaking the links between inner and outer comms.
335480cf27aSJed Brown 
336ff0e51ddSBarry Smith   This is called by MPI, not by users. This is called when MPI_Comm_free() is called on the communicator.
337480cf27aSJed Brown 
33812801b39SBarry Smith   Note: this is declared extern "C" because it is passed to MPI_Comm_create_keyval()
339480cf27aSJed Brown 
340480cf27aSJed Brown */
341da3039f7SJed Brown PETSC_EXTERN PetscMPIInt MPIAPI Petsc_DelComm_Outer(MPI_Comm comm,PetscMPIInt keyval,void *attr_val,void *extra_state)
342480cf27aSJed Brown {
343480cf27aSJed Brown   PetscErrorCode                    ierr;
344b89831e5SBarry Smith   PetscMPIInt                       flg;
345265f3f35SJed Brown   union {MPI_Comm comm; void *ptr;} icomm,ocomm;
346480cf27aSJed Brown 
347480cf27aSJed Brown   PetscFunctionBegin;
34812801b39SBarry Smith   if (keyval != Petsc_InnerComm_keyval) SETERRMPI(PETSC_COMM_SELF,PETSC_ERR_ARG_CORRUPT,"Unexpected keyval");
349ec4fadc2SJed Brown   icomm.ptr = attr_val;
350da3039f7SJed Brown 
35147435625SJed Brown   ierr = MPI_Comm_get_attr(icomm.comm,Petsc_OuterComm_keyval,&ocomm,&flg);CHKERRMPI(ierr);
35212801b39SBarry Smith   if (!flg) SETERRMPI(PETSC_COMM_SELF,PETSC_ERR_ARG_CORRUPT,"Inner MPI_Comm does not have expected reference to outer comm");
35312801b39SBarry Smith   if (ocomm.comm != comm) SETERRMPI(PETSC_COMM_SELF,PETSC_ERR_ARG_CORRUPT,"Inner MPI_Comm has reference to non-matching outer comm");
35447435625SJed Brown   ierr = MPI_Comm_delete_attr(icomm.comm,Petsc_OuterComm_keyval);CHKERRMPI(ierr);
35512801b39SBarry 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);
356da3039f7SJed Brown   PetscFunctionReturn(MPI_SUCCESS);
357b89831e5SBarry Smith }
358da3039f7SJed Brown 
359da3039f7SJed Brown /*
36047435625SJed 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.
361da3039f7SJed Brown  */
362da3039f7SJed Brown PETSC_EXTERN PetscMPIInt MPIAPI Petsc_DelComm_Inner(MPI_Comm comm,PetscMPIInt keyval,void *attr_val,void *extra_state)
363da3039f7SJed Brown {
364da3039f7SJed Brown   PetscErrorCode ierr;
365da3039f7SJed Brown 
366da3039f7SJed Brown   PetscFunctionBegin;
36712801b39SBarry Smith   ierr = PetscInfo1(0,"Removing reference to PETSc communicator embedded in a user MPI_Comm %ld\n",(long)comm);CHKERRMPI(ierr);
368480cf27aSJed Brown   PetscFunctionReturn(MPI_SUCCESS);
369480cf27aSJed Brown }
370480cf27aSJed Brown 
37142218b76SBarry Smith PETSC_EXTERN PetscMPIInt MPIAPI Petsc_DelShared(MPI_Comm,PetscMPIInt,void *,void *);
37242218b76SBarry Smith 
373951e3c8eSBarry Smith #if defined(PETSC_USE_PETSC_MPI_EXTERNAL32)
374e39fd77fSBarry Smith #if !defined(PETSC_WORDS_BIGENDIAN)
3758cc058d9SJed Brown PETSC_EXTERN PetscMPIInt PetscDataRep_extent_fn(MPI_Datatype,MPI_Aint*,void*);
3768cc058d9SJed Brown PETSC_EXTERN PetscMPIInt PetscDataRep_read_conv_fn(void*, MPI_Datatype,PetscMPIInt,void*,MPI_Offset,void*);
3778cc058d9SJed Brown PETSC_EXTERN PetscMPIInt PetscDataRep_write_conv_fn(void*, MPI_Datatype,PetscMPIInt,void*,MPI_Offset,void*);
378e39fd77fSBarry Smith #endif
379951e3c8eSBarry Smith #endif
380e39fd77fSBarry Smith 
38112801b39SBarry Smith PetscMPIInt PETSC_MPI_ERROR_CLASS,PETSC_MPI_ERROR_CODE;
38212801b39SBarry Smith 
383*eb27c7c8SSatish Balay PETSC_INTERN int  PetscGlobalArgc;
384*eb27c7c8SSatish Balay PETSC_INTERN char **PetscGlobalArgs;
3856ae9a8a6SBarry Smith int  PetscGlobalArgc   = 0;
3866ae9a8a6SBarry Smith char **PetscGlobalArgs = 0;
387dff31646SBarry Smith PetscSegBuffer PetscCitationsList;
388e5c89e4eSSatish Balay 
389dd63322aSSatish Balay PetscErrorCode PetscCitationsInitialize(void)
390051e4cf2SJed Brown {
391051e4cf2SJed Brown   PetscErrorCode ierr;
392051e4cf2SJed Brown 
393051e4cf2SJed Brown   PetscFunctionBegin;
394051e4cf2SJed Brown   ierr = PetscSegBufferCreate(1,10000,&PetscCitationsList);CHKERRQ(ierr);
395f191ac77SSatish 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);
396051e4cf2SJed 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);
397051e4cf2SJed Brown   PetscFunctionReturn(0);
398051e4cf2SJed Brown }
399e5c89e4eSSatish Balay 
400e5c89e4eSSatish Balay /*@C
401e5c89e4eSSatish Balay    PetscGetArgs - Allows you to access the raw command line arguments anywhere
402e5c89e4eSSatish Balay      after PetscInitialize() is called but before PetscFinalize().
403e5c89e4eSSatish Balay 
404e5c89e4eSSatish Balay    Not Collective
405e5c89e4eSSatish Balay 
406e5c89e4eSSatish Balay    Output Parameters:
407e5c89e4eSSatish Balay +  argc - count of number of command line arguments
408e5c89e4eSSatish Balay -  args - the command line arguments
409e5c89e4eSSatish Balay 
410e5c89e4eSSatish Balay    Level: intermediate
411e5c89e4eSSatish Balay 
412e5c89e4eSSatish Balay    Notes:
413e5c89e4eSSatish Balay       This is usually used to pass the command line arguments into other libraries
414e5c89e4eSSatish Balay    that are called internally deep in PETSc or the application.
415e5c89e4eSSatish Balay 
416f177e3b1SBarry Smith       The first argument contains the program name as is normal for C arguments.
417f177e3b1SBarry Smith 
418e5c89e4eSSatish Balay    Concepts: command line arguments
419e5c89e4eSSatish Balay 
420793721a6SBarry Smith .seealso: PetscFinalize(), PetscInitializeFortran(), PetscGetArguments()
421e5c89e4eSSatish Balay 
422e5c89e4eSSatish Balay @*/
4237087cfbeSBarry Smith PetscErrorCode  PetscGetArgs(int *argc,char ***args)
424e5c89e4eSSatish Balay {
425e5c89e4eSSatish Balay   PetscFunctionBegin;
42617186662SBarry Smith   if (!PetscInitializeCalled && PetscFinalizeCalled) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ORDER,"You must call after PetscInitialize() but before PetscFinalize()");
427e5c89e4eSSatish Balay   *argc = PetscGlobalArgc;
428e5c89e4eSSatish Balay   *args = PetscGlobalArgs;
429e5c89e4eSSatish Balay   PetscFunctionReturn(0);
430e5c89e4eSSatish Balay }
431e5c89e4eSSatish Balay 
432793721a6SBarry Smith /*@C
433793721a6SBarry Smith    PetscGetArguments - Allows you to access the  command line arguments anywhere
434793721a6SBarry Smith      after PetscInitialize() is called but before PetscFinalize().
435793721a6SBarry Smith 
436793721a6SBarry Smith    Not Collective
437793721a6SBarry Smith 
438793721a6SBarry Smith    Output Parameters:
439793721a6SBarry Smith .  args - the command line arguments
440793721a6SBarry Smith 
441793721a6SBarry Smith    Level: intermediate
442793721a6SBarry Smith 
443793721a6SBarry Smith    Notes:
444793721a6SBarry Smith       This does NOT start with the program name and IS null terminated (final arg is void)
445793721a6SBarry Smith 
446793721a6SBarry Smith    Concepts: command line arguments
447793721a6SBarry Smith 
448793721a6SBarry Smith .seealso: PetscFinalize(), PetscInitializeFortran(), PetscGetArgs(), PetscFreeArguments()
449793721a6SBarry Smith 
450793721a6SBarry Smith @*/
4517087cfbeSBarry Smith PetscErrorCode  PetscGetArguments(char ***args)
452793721a6SBarry Smith {
453793721a6SBarry Smith   PetscInt       i,argc = PetscGlobalArgc;
454793721a6SBarry Smith   PetscErrorCode ierr;
455793721a6SBarry Smith 
456793721a6SBarry Smith   PetscFunctionBegin;
45717186662SBarry Smith   if (!PetscInitializeCalled && PetscFinalizeCalled) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ORDER,"You must call after PetscInitialize() but before PetscFinalize()");
458717030eeSLisandro Dalcin   if (!argc) {*args = 0; PetscFunctionReturn(0);}
459785e854fSJed Brown   ierr = PetscMalloc1(argc,args);CHKERRQ(ierr);
460793721a6SBarry Smith   for (i=0; i<argc-1; i++) {
461793721a6SBarry Smith     ierr = PetscStrallocpy(PetscGlobalArgs[i+1],&(*args)[i]);CHKERRQ(ierr);
462793721a6SBarry Smith   }
463793721a6SBarry Smith   (*args)[argc-1] = 0;
464793721a6SBarry Smith   PetscFunctionReturn(0);
465793721a6SBarry Smith }
466793721a6SBarry Smith 
467793721a6SBarry Smith /*@C
468793721a6SBarry Smith    PetscFreeArguments - Frees the memory obtained with PetscGetArguments()
469793721a6SBarry Smith 
470793721a6SBarry Smith    Not Collective
471793721a6SBarry Smith 
472793721a6SBarry Smith    Output Parameters:
473793721a6SBarry Smith .  args - the command line arguments
474793721a6SBarry Smith 
475793721a6SBarry Smith    Level: intermediate
476793721a6SBarry Smith 
477793721a6SBarry Smith    Concepts: command line arguments
478793721a6SBarry Smith 
479793721a6SBarry Smith .seealso: PetscFinalize(), PetscInitializeFortran(), PetscGetArgs(), PetscGetArguments()
480793721a6SBarry Smith 
481793721a6SBarry Smith @*/
4827087cfbeSBarry Smith PetscErrorCode  PetscFreeArguments(char **args)
483793721a6SBarry Smith {
484793721a6SBarry Smith   PetscInt       i = 0;
485793721a6SBarry Smith   PetscErrorCode ierr;
486793721a6SBarry Smith 
487793721a6SBarry Smith   PetscFunctionBegin;
488a297a907SKarl Rupp   if (!args) PetscFunctionReturn(0);
489793721a6SBarry Smith   while (args[i]) {
490793721a6SBarry Smith     ierr = PetscFree(args[i]);CHKERRQ(ierr);
491793721a6SBarry Smith     i++;
492793721a6SBarry Smith   }
493793721a6SBarry Smith   ierr = PetscFree(args);CHKERRQ(ierr);
494793721a6SBarry Smith   PetscFunctionReturn(0);
495793721a6SBarry Smith }
496793721a6SBarry Smith 
49711525c0dSBarry Smith #if defined(PETSC_HAVE_SAWS)
49830befbd2SBarry Smith #include <petscconfiginfo.h>
49930befbd2SBarry Smith 
50095c0884eSLisandro Dalcin PETSC_INTERN PetscErrorCode PetscInitializeSAWs(const char help[])
50111525c0dSBarry Smith {
50211525c0dSBarry Smith   if (!PetscGlobalRank) {
50330befbd2SBarry Smith     char           cert[PETSC_MAX_PATH_LEN],root[PETSC_MAX_PATH_LEN],*intro,programname[64],*appline,*options,version[64];
50411525c0dSBarry Smith     int            port;
505ffbd1cfbSBarry Smith     PetscBool      flg,rootlocal = PETSC_FALSE,flg2,selectport = PETSC_FALSE;
50611525c0dSBarry Smith     size_t         applinelen,introlen;
50711525c0dSBarry Smith     PetscErrorCode ierr;
508ffbd1cfbSBarry Smith     char           sawsurl[256];
50911525c0dSBarry Smith 
510c5929fdfSBarry Smith     ierr = PetscOptionsHasName(NULL,NULL,"-saws_log",&flg);CHKERRQ(ierr);
51111525c0dSBarry Smith     if (flg) {
51211525c0dSBarry Smith       char  sawslog[PETSC_MAX_PATH_LEN];
51311525c0dSBarry Smith 
514c5929fdfSBarry Smith       ierr = PetscOptionsGetString(NULL,NULL,"-saws_log",sawslog,PETSC_MAX_PATH_LEN,NULL);CHKERRQ(ierr);
51511525c0dSBarry Smith       if (sawslog[0]) {
51611525c0dSBarry Smith         PetscStackCallSAWs(SAWs_Set_Use_Logfile,(sawslog));
51711525c0dSBarry Smith       } else {
51811525c0dSBarry Smith         PetscStackCallSAWs(SAWs_Set_Use_Logfile,(NULL));
51911525c0dSBarry Smith       }
52011525c0dSBarry Smith     }
521c5929fdfSBarry Smith     ierr = PetscOptionsGetString(NULL,NULL,"-saws_https",cert,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr);
52211525c0dSBarry Smith     if (flg) {
52311525c0dSBarry Smith       PetscStackCallSAWs(SAWs_Set_Use_HTTPS,(cert));
52411525c0dSBarry Smith     }
525c5929fdfSBarry Smith     ierr = PetscOptionsGetBool(NULL,NULL,"-saws_port_auto_select",&selectport,NULL);CHKERRQ(ierr);
526ffbd1cfbSBarry Smith     if (selectport) {
527ffbd1cfbSBarry Smith         PetscStackCallSAWs(SAWs_Get_Available_Port,(&port));
528ffbd1cfbSBarry Smith         PetscStackCallSAWs(SAWs_Set_Port,(port));
529ffbd1cfbSBarry Smith     } else {
530c5929fdfSBarry Smith       ierr = PetscOptionsGetInt(NULL,NULL,"-saws_port",&port,&flg);CHKERRQ(ierr);
53111525c0dSBarry Smith       if (flg) {
53211525c0dSBarry Smith         PetscStackCallSAWs(SAWs_Set_Port,(port));
53311525c0dSBarry Smith       }
534ffbd1cfbSBarry Smith     }
535c5929fdfSBarry Smith     ierr = PetscOptionsGetString(NULL,NULL,"-saws_root",root,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr);
53611525c0dSBarry Smith     if (flg) {
53711525c0dSBarry Smith       PetscStackCallSAWs(SAWs_Set_Document_Root,(root));CHKERRQ(ierr);
53811525c0dSBarry Smith       ierr = PetscStrcmp(root,".",&rootlocal);CHKERRQ(ierr);
5399c1e0ce8SBarry Smith     } else {
540c5929fdfSBarry Smith       ierr = PetscOptionsHasName(NULL,NULL,"-saws_options",&flg);CHKERRQ(ierr);
5419c1e0ce8SBarry Smith       if (flg) {
5423c01dfcfSBarry Smith         ierr = PetscStrreplace(PETSC_COMM_WORLD,"${PETSC_DIR}/share/petsc/saws",root,PETSC_MAX_PATH_LEN);CHKERRQ(ierr);
5439c1e0ce8SBarry Smith         PetscStackCallSAWs(SAWs_Set_Document_Root,(root));CHKERRQ(ierr);
5449c1e0ce8SBarry Smith       }
54511525c0dSBarry Smith     }
546c5929fdfSBarry Smith     ierr = PetscOptionsHasName(NULL,NULL,"-saws_local",&flg2);CHKERRQ(ierr);
54711525c0dSBarry Smith     if (flg2) {
54811525c0dSBarry Smith       char jsdir[PETSC_MAX_PATH_LEN];
54911525c0dSBarry Smith       if (!flg) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SUP,"-saws_local option requires -saws_root option");
55011525c0dSBarry Smith       ierr = PetscSNPrintf(jsdir,PETSC_MAX_PATH_LEN,"%s/js",root);CHKERRQ(ierr);
55111525c0dSBarry Smith       ierr = PetscTestDirectory(jsdir,'r',&flg);CHKERRQ(ierr);
55211525c0dSBarry Smith       if (!flg) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_FILE_READ,"-saws_local option requires js directory in root directory");
55343da4ab2SBarry Smith       PetscStackCallSAWs(SAWs_Push_Local_Header,());CHKERRQ(ierr);
55411525c0dSBarry Smith     }
55511525c0dSBarry Smith     ierr = PetscGetProgramName(programname,64);CHKERRQ(ierr);
55611525c0dSBarry Smith     ierr = PetscStrlen(help,&applinelen);CHKERRQ(ierr);
55711525c0dSBarry Smith     introlen   = 4096 + applinelen;
55830a8c9c0SSurtai Han     applinelen += 1024;
55911525c0dSBarry Smith     ierr = PetscMalloc(applinelen,&appline);CHKERRQ(ierr);
56011525c0dSBarry Smith     ierr = PetscMalloc(introlen,&intro);CHKERRQ(ierr);
56111525c0dSBarry Smith 
56211525c0dSBarry Smith     if (rootlocal) {
56311525c0dSBarry Smith       ierr = PetscSNPrintf(appline,applinelen,"%s.c.html",programname);CHKERRQ(ierr);
56411525c0dSBarry Smith       ierr = PetscTestFile(appline,'r',&rootlocal);CHKERRQ(ierr);
56511525c0dSBarry Smith     }
56676a34f28SBarry Smith     ierr = PetscOptionsGetAll(NULL,&options);CHKERRQ(ierr);
56711525c0dSBarry Smith     if (rootlocal && help) {
56830befbd2SBarry 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);
56911525c0dSBarry Smith     } else if (help) {
57030a8c9c0SSurtai Han       ierr = PetscSNPrintf(appline,applinelen,"<center>Running %s %s</center><br><center><pre>%s</pre></center><br>",programname,options,help);
57111525c0dSBarry Smith     } else {
57230befbd2SBarry Smith       ierr = PetscSNPrintf(appline,applinelen,"<center> Running %s %s</center><br>\n",programname,options);
57311525c0dSBarry Smith     }
574b0bb5815SBarry Smith     ierr = PetscFree(options);CHKERRQ(ierr);
57530befbd2SBarry Smith     ierr = PetscGetVersion(version,sizeof(version));CHKERRQ(ierr);
57611525c0dSBarry Smith     ierr = PetscSNPrintf(intro,introlen,"<body>\n"
57711525c0dSBarry 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"
578df62c222SBarry 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"
579df62c222SBarry Smith                                     "%s",version,petscconfigureoptions,appline);
58043da4ab2SBarry Smith     PetscStackCallSAWs(SAWs_Push_Body,("index.html",0,intro));
58111525c0dSBarry Smith     ierr = PetscFree(intro);CHKERRQ(ierr);
58211525c0dSBarry Smith     ierr = PetscFree(appline);CHKERRQ(ierr);
583ffbd1cfbSBarry Smith     if (selectport) {
584aa573868SBarry Smith       PetscBool silent;
5857d812c46SBarry Smith 
5867d812c46SBarry Smith       ierr = SAWs_Initialize();
5877d812c46SBarry Smith       /* another process may have grabbed the port so keep trying */
5887d812c46SBarry Smith       while (ierr) {
5897d812c46SBarry Smith         PetscStackCallSAWs(SAWs_Get_Available_Port,(&port));
5907d812c46SBarry Smith         PetscStackCallSAWs(SAWs_Set_Port,(port));
5917d812c46SBarry Smith         ierr = SAWs_Initialize();
5927d812c46SBarry Smith       }
5937d812c46SBarry Smith 
594aa573868SBarry Smith       ierr = PetscOptionsGetBool(NULL,NULL,"-saws_port_auto_select_silent",&silent,NULL);CHKERRQ(ierr);
595aa573868SBarry Smith       if (!silent) {
596ffbd1cfbSBarry Smith         PetscStackCallSAWs(SAWs_Get_FullURL,(sizeof(sawsurl),sawsurl));
597ffbd1cfbSBarry Smith         ierr = PetscPrintf(PETSC_COMM_WORLD,"Point your browser to %s for SAWs\n",sawsurl);CHKERRQ(ierr);
598ffbd1cfbSBarry Smith       }
5997d812c46SBarry Smith     } else {
6007d812c46SBarry Smith       PetscStackCallSAWs(SAWs_Initialize,());
601aa573868SBarry Smith     }
6020af79b04SBarry Smith     ierr = PetscCitationsRegister("@TechReport{ saws,\n"
6030af79b04SBarry Smith                                   "  Author = {Matt Otten and Jed Brown and Barry Smith},\n"
6040af79b04SBarry Smith                                   "  Title  = {Scientific Application Web Server (SAWs) Users Manual},\n"
6050af79b04SBarry Smith                                   "  Institution = {Argonne National Laboratory},\n"
6060af79b04SBarry Smith                                   "  Year   = 2013\n}\n",NULL);CHKERRQ(ierr);
60711525c0dSBarry Smith   }
60811525c0dSBarry Smith   PetscFunctionReturn(0);
60911525c0dSBarry Smith }
61011525c0dSBarry Smith #endif
61111525c0dSBarry Smith 
612e5c89e4eSSatish Balay /*@C
613e5c89e4eSSatish Balay    PetscInitialize - Initializes the PETSc database and MPI.
614e5c89e4eSSatish Balay    PetscInitialize() calls MPI_Init() if that has yet to be called,
615e5c89e4eSSatish Balay    so this routine should always be called near the beginning of
616e5c89e4eSSatish Balay    your program -- usually the very first line!
617e5c89e4eSSatish Balay 
618e5c89e4eSSatish Balay    Collective on MPI_COMM_WORLD or PETSC_COMM_WORLD if it has been set
619e5c89e4eSSatish Balay 
620e5c89e4eSSatish Balay    Input Parameters:
621e5c89e4eSSatish Balay +  argc - count of number of command line arguments
622e5c89e4eSSatish Balay .  args - the command line arguments
6230298fd71SBarry Smith .  file - [optional] PETSc database file, also checks ~username/.petscrc and .petscrc use NULL to not check for
624fc2bca9aSBarry Smith           code specific file. Use -skip_petscrc in the code specific file to skip the .petscrc files
6250298fd71SBarry Smith -  help - [optional] Help message to print, use NULL for no message
626e5c89e4eSSatish Balay 
62705827820SBarry Smith    If you wish PETSc code to run ONLY on a subcommunicator of MPI_COMM_WORLD, create that
62805827820SBarry Smith    communicator first and assign it to PETSC_COMM_WORLD BEFORE calling PetscInitialize(). Thus if you are running a
62905827820SBarry Smith    four process job and two processes will run PETSc and have PetscInitialize() and PetscFinalize() and two process will not,
63005827820SBarry Smith    then do this. If ALL processes in the job are using PetscInitialize() and PetscFinalize() then you don't need to do this, even
63105827820SBarry Smith    if different subcommunicators of the job are doing different things with PETSc.
632e5c89e4eSSatish Balay 
633e5c89e4eSSatish Balay    Options Database Keys:
6347ca660e7SBarry Smith +  -help [intro] - prints help method for each option; if intro is given the program stops after printing the introductory help message
6357ca660e7SBarry Smith .  -start_in_debugger [noxterm,dbx,xdb,gdb,...] - Starts program in debugger
636e5c89e4eSSatish Balay .  -on_error_attach_debugger [noxterm,dbx,xdb,gdb,...] - Starts debugger when error detected
637e5c89e4eSSatish Balay .  -on_error_emacs <machinename> causes emacsclient to jump to error file
638b52f573bSBarry Smith .  -on_error_abort calls abort() when error detected (no traceback)
639e8fb0fc0SBarry Smith .  -on_error_mpiabort calls MPI_abort() when error detected
640e8fb0fc0SBarry Smith .  -error_output_stderr prints error messages to stderr instead of the default stdout
641e8fb0fc0SBarry Smith .  -error_output_none does not print the error messages (but handles errors in the same way as if this was not called)
642e5c89e4eSSatish Balay .  -debugger_nodes [node1,node2,...] - Indicates nodes to start in debugger
643e5c89e4eSSatish Balay .  -debugger_pause [sleeptime] (in seconds) - Pauses debugger
644e5c89e4eSSatish Balay .  -stop_for_debugger - Print message on how to attach debugger manually to
645e5c89e4eSSatish Balay                         process and wait (-debugger_pause) seconds for attachment
6462fb0ec9aSBarry Smith .  -malloc - Indicates use of PETSc error-checking malloc (on by default for debug version of libraries)
647e5c89e4eSSatish Balay .  -malloc no - Indicates not to use error-checking malloc
6482fb0ec9aSBarry Smith .  -malloc_debug - check for memory corruption at EVERY malloc or free
649aee23540SBarry Smith .  -malloc_dump - prints a list of all unfreed memory at the end of the run
650dc92acbaSJed Brown .  -malloc_test - like -malloc_dump -malloc_debug, but only active for debugging builds
651e5c89e4eSSatish Balay .  -fp_trap - Stops on floating point exceptions (Note that on the
652e5c89e4eSSatish Balay               IBM RS6000 this slows code by at least a factor of 10.)
653e5c89e4eSSatish Balay .  -no_signal_handler - Indicates not to trap error signals
654e5c89e4eSSatish Balay .  -shared_tmp - indicates /tmp directory is shared by all processors
655e5c89e4eSSatish Balay .  -not_shared_tmp - each processor has own /tmp
656e5c89e4eSSatish Balay .  -tmp - alternative name of /tmp directory
657e5c89e4eSSatish Balay .  -get_total_flops - returns total flops done by all processors
6580841954dSBarry Smith -  -memory_view - Print memory usage at end of run
659e5c89e4eSSatish Balay 
660e5c89e4eSSatish Balay    Options Database Keys for Profiling:
661a7f22e61SSatish Balay    See Users-Manual: ch_profiling for details.
662495fc317SBarry Smith +  -info <optional filename> - Prints verbose information to the screen
663495fc317SBarry Smith .  -info_exclude <null,vec,mat,pc,ksp,snes,ts> - Excludes some of the verbose messages
664217044c2SLisandro Dalcin .  -log_sync - Enable barrier synchronization for all events. This option is useful to debug imbalance within each event,
665217044c2SLisandro Dalcin         however it slows things down and gives a distorted view of the overall runtime.
666495fc317SBarry Smith .  -log_trace [filename] - Print traces of all PETSc calls to the screen (useful to determine where a program
667e5c89e4eSSatish Balay         hangs without running in the debugger).  See PetscLogTraceBegin().
6689a9a5d4cSBarry Smith .  -log_view [:filename:format] - Prints summary of flop and timing information to screen or file, see PetscLogView().
6699a9a5d4cSBarry Smith .  -log_summary [filename] - (Deprecated, use -log_view) Prints summary of flop and timing information to screen. If the filename is specified the
670495fc317SBarry Smith         summary is written to the file.  See PetscLogView().
671f5d6ab90SLisandro Dalcin .  -log_exclude: <vec,mat,pc,ksp,snes> - excludes subset of object classes from logging
672495fc317SBarry Smith .  -log_all [filename] - Logs extensive profiling information  See PetscLogDump().
673495fc317SBarry Smith .  -log [filename] - Logs basic profiline information  See PetscLogDump().
674c2f74817SBarry Smith .  -log_mpe [filename] - Creates a logfile viewable by the utility Jumpshot (in MPICH distribution)
67587c3beb6SLisandro Dalcin .  -viewfromoptions on,off - Enable or disable XXXSetFromOptions() calls, for applications with many small solves turn this off
676c2f74817SBarry Smith -  -check_pointer_intensity 0,1,2 - if pointers are checked for validity (debug version only), using 0 will result in faster code
677495fc317SBarry Smith 
678609bdbeeSBarry Smith     Only one of -log_trace, -log_view, -log_view, -log_all, -log, or -log_mpe may be used at a time
679e5c89e4eSSatish Balay 
680ffbd1cfbSBarry Smith    Options Database Keys for SAWs:
681ffbd1cfbSBarry Smith +  -saws_port <portnumber> - port number to publish SAWs data, default is 8080
682ffbd1cfbSBarry 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
683ffbd1cfbSBarry Smith                             this is useful when you are running many jobs that utilize SAWs at the same time
684ffbd1cfbSBarry Smith .  -saws_log <filename> - save a log of all SAWs communication
685ffbd1cfbSBarry Smith .  -saws_https <certificate file> - have SAWs use HTTPS instead of HTTP
686ffbd1cfbSBarry Smith -  -saws_root <directory> - allow SAWs to have access to the given directory to search for requested resources and files
687ffbd1cfbSBarry Smith 
688e5c89e4eSSatish Balay    Environmental Variables:
689e5c89e4eSSatish Balay +   PETSC_TMP - alternative tmp directory
690e5c89e4eSSatish Balay .   PETSC_SHARED_TMP - tmp is shared by all processes
691e5c89e4eSSatish Balay .   PETSC_NOT_SHARED_TMP - each process has its own private tmp
692e5c89e4eSSatish Balay .   PETSC_VIEWER_SOCKET_PORT - socket number to use for socket viewer
693e5c89e4eSSatish Balay -   PETSC_VIEWER_SOCKET_MACHINE - machine to use for socket viewer to connect to
694e5c89e4eSSatish Balay 
695e5c89e4eSSatish Balay 
696e5c89e4eSSatish Balay    Level: beginner
697e5c89e4eSSatish Balay 
698e5c89e4eSSatish Balay    Notes:
699e5c89e4eSSatish Balay    If for some reason you must call MPI_Init() separately, call
700e5c89e4eSSatish Balay    it before PetscInitialize().
701e5c89e4eSSatish Balay 
702e5c89e4eSSatish Balay    Fortran Version:
703e5c89e4eSSatish Balay    In Fortran this routine has the format
704e5c89e4eSSatish Balay $       call PetscInitialize(file,ierr)
705e5c89e4eSSatish Balay 
706e5c89e4eSSatish Balay +   ierr - error return code
7070eb4c9c0SBarry Smith -  file - [optional] PETSc database file, also checks ~username/.petscrc and .petscrc use PETSC_NULL_CHARACTER to not check for
708fc2bca9aSBarry Smith           code specific file. Use -skip_petscrc in the code specific file to skip the .petscrc files
709e5c89e4eSSatish Balay 
710e5c89e4eSSatish Balay    Important Fortran Note:
7110eb4c9c0SBarry Smith    In Fortran, you MUST use PETSC_NULL_CHARACTER to indicate a
7120298fd71SBarry Smith    null character string; you CANNOT just use NULL as
713a7f22e61SSatish Balay    in the C version. See Users-Manual: ch_fortran for details.
714e5c89e4eSSatish Balay 
71501cb0274SBarry Smith    If your main program is C but you call Fortran code that also uses PETSc you need to call PetscInitializeFortran() soon after
71601cb0274SBarry Smith    calling PetscInitialize().
717e5c89e4eSSatish Balay 
718e5c89e4eSSatish Balay    Concepts: initializing PETSc
719e5c89e4eSSatish Balay 
72001cb0274SBarry Smith .seealso: PetscFinalize(), PetscInitializeFortran(), PetscGetArgs(), PetscInitializeNoArguments()
721e5c89e4eSSatish Balay 
722e5c89e4eSSatish Balay @*/
7237087cfbeSBarry Smith PetscErrorCode  PetscInitialize(int *argc,char ***args,const char file[],const char help[])
724e5c89e4eSSatish Balay {
725e5c89e4eSSatish Balay   PetscErrorCode ierr;
7264bb5149bSJed Brown   PetscMPIInt    flag, size;
72719c5658aSBarry Smith   PetscBool      flg = PETSC_TRUE;
728e5c89e4eSSatish Balay   char           hostname[256];
729e5c89e4eSSatish Balay 
730e5c89e4eSSatish Balay   PetscFunctionBegin;
731e5c89e4eSSatish Balay   if (PetscInitializeCalled) PetscFunctionReturn(0);
7323d96e996SBarry Smith   /*
7333d96e996SBarry Smith       The checking over compatible runtime libraries is complicated by the MPI ABI initiative
7343d96e996SBarry Smith       https://wiki.mpich.org/mpich/index.php/ABI_Compatibility_Initiative which started with
7353d96e996SBarry Smith         MPICH v3.1 (Released Feburary 2014)
7363d96e996SBarry Smith         IBM MPI v2.1 (December 2014)
7373d96e996SBarry Smith         Intel® MPI Library v5.0 (2014)
7383d96e996SBarry Smith         Cray MPT v7.0.0 (June 2014)
7393d96e996SBarry Smith       As of July 31, 2017 the ABI number still appears to be 12, that is all of the versions
7403d96e996SBarry Smith       listed above and since that time are compatible.
7413d96e996SBarry Smith 
7423d96e996SBarry Smith       Unfortunately the MPI ABI initiative has not defined a way to determine the ABI number
7433d96e996SBarry Smith       at compile time or runtime. Thus we will need to systematically track the allowed versions
7443d96e996SBarry Smith       and how they are represented in the mpi.h and MPI_Get_library_version() output in order
7453d96e996SBarry Smith       to perform the checking.
7463d96e996SBarry Smith 
7473d96e996SBarry Smith       Currently we only check for pre MPI ABI versions (and packages that do not follow the MPI ABI).
7483d96e996SBarry Smith 
7493d96e996SBarry Smith       Questions:
7503d96e996SBarry Smith 
7513d96e996SBarry Smith         Should the checks for ABI incompatibility be only on the major version number below?
7523d96e996SBarry Smith         Presumably the output to stderr will be removed before a release.
7533d96e996SBarry Smith   */
7543d96e996SBarry Smith 
75519c5658aSBarry Smith #if defined(PETSC_HAVE_MPI_GET_LIBRARY_VERSION)
75619c5658aSBarry Smith   {
75719c5658aSBarry Smith     char        mpilibraryversion[MPI_MAX_LIBRARY_VERSION_STRING];
75819c5658aSBarry Smith     PetscMPIInt mpilibraryversionlength;
75919c5658aSBarry Smith     ierr = MPI_Get_library_version(mpilibraryversion,&mpilibraryversionlength);if (ierr) return ierr;
7603d96e996SBarry Smith     /* check for MPICH versions before MPI ABI initiative */
76119c5658aSBarry Smith #if defined(MPICH_VERSION)
7623d96e996SBarry Smith #if MPICH_NUMVERSION < 30100000
76319c5658aSBarry Smith     {
76419c5658aSBarry Smith       char *ver,*lf;
76519c5658aSBarry Smith       flg = PETSC_FALSE;
76619c5658aSBarry Smith       ierr = PetscStrstr(mpilibraryversion,"MPICH Version:",&ver);if (ierr) return ierr;
76719c5658aSBarry Smith       if (ver) {
76819c5658aSBarry Smith         ierr = PetscStrchr(ver,'\n',&lf);if (ierr) return ierr;
76919c5658aSBarry Smith         if (lf) {
77019c5658aSBarry Smith           *lf = 0;
77119c5658aSBarry Smith           ierr = PetscStrendswith(ver,MPICH_VERSION,&flg);if (ierr) return ierr;
77219c5658aSBarry Smith         }
77319c5658aSBarry Smith       }
77419c5658aSBarry Smith       if (!flg) {
77519c5658aSBarry Smith         fprintf(stderr,"PETSc Error --- MPICH library version \n%s does not match what PETSc was compiled with %s, aborting\n",mpilibraryversion,MPICH_VERSION);
7763d96e996SBarry Smith         return PETSC_ERR_MPI_LIB_INCOMP;
77719c5658aSBarry Smith       }
77819c5658aSBarry Smith     }
7793d96e996SBarry Smith #endif
7803d96e996SBarry 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?) */
78119c5658aSBarry Smith #elif defined(OMPI_MAJOR_VERSION)
78219c5658aSBarry Smith     {
78319c5658aSBarry Smith       char *ver,bs[32],*bsf;
78419c5658aSBarry Smith       flg = PETSC_FALSE;
78519c5658aSBarry Smith       ierr = PetscStrstr(mpilibraryversion,"Open MPI",&ver);if (ierr) return ierr;
78619c5658aSBarry Smith       if (ver) {
7872e924ca5SSatish Balay         PetscSNPrintf(bs,32,"v%d.%d",OMPI_MAJOR_VERSION,OMPI_MINOR_VERSION);
78819c5658aSBarry Smith         ierr = PetscStrstr(ver,bs,&bsf);if (ierr) return ierr;
78919c5658aSBarry Smith         if (bsf) flg = PETSC_TRUE;
79019c5658aSBarry Smith       }
79119c5658aSBarry Smith       if (!flg) {
79219c5658aSBarry 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);
7933d96e996SBarry Smith         return PETSC_ERR_MPI_LIB_INCOMP;
79419c5658aSBarry Smith       }
79519c5658aSBarry Smith     }
79619c5658aSBarry Smith #endif
79719c5658aSBarry Smith   }
79819c5658aSBarry Smith #endif
79919c5658aSBarry Smith 
800e5c89e4eSSatish Balay 
801ae9b4142SLisandro Dalcin   /* these must be initialized in a routine, not as a constant declaration*/
802d89683f4Sbcordonn   PETSC_STDOUT = stdout;
803ae9b4142SLisandro Dalcin   PETSC_STDERR = stderr;
804e5c89e4eSSatish Balay 
8050c30907bSSatish Balay   /* on Windows - set printf to default to printing 2 digit exponents */
8060c30907bSSatish Balay #if defined(PETSC_HAVE__SET_OUTPUT_FORMAT)
8070c30907bSSatish Balay   _set_output_format(_TWO_DIGIT_EXPONENT);
8080c30907bSSatish Balay #endif
8090c30907bSSatish Balay 
8104416b707SBarry Smith   ierr = PetscOptionsCreateDefault();CHKERRQ(ierr);
811e5c89e4eSSatish Balay 
812e5c89e4eSSatish Balay   /*
813e5c89e4eSSatish Balay      We initialize the program name here (before MPI_Init()) because MPICH has a bug in
814e5c89e4eSSatish Balay      it that it sets args[0] on all processors to be args[0] on the first processor.
815e5c89e4eSSatish Balay   */
816e5c89e4eSSatish Balay   if (argc && *argc) {
817e5c89e4eSSatish Balay     ierr = PetscSetProgramName(**args);CHKERRQ(ierr);
818e5c89e4eSSatish Balay   } else {
819e5c89e4eSSatish Balay     ierr = PetscSetProgramName("Unknown Name");CHKERRQ(ierr);
820e5c89e4eSSatish Balay   }
821e5c89e4eSSatish Balay 
822e5c89e4eSSatish Balay   ierr = MPI_Initialized(&flag);CHKERRQ(ierr);
823e5c89e4eSSatish Balay   if (!flag) {
824e32f2f54SBarry 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");
8255e765c61SJed Brown #if defined(PETSC_HAVE_MPI_INIT_THREAD)
8265e765c61SJed Brown     {
8275e765c61SJed Brown       PetscMPIInt provided;
8285e765c61SJed Brown       ierr = MPI_Init_thread(argc,args,MPI_THREAD_FUNNELED,&provided);CHKERRQ(ierr);
8295e765c61SJed Brown     }
8305e765c61SJed Brown #else
831e5c89e4eSSatish Balay     ierr = MPI_Init(argc,args);CHKERRQ(ierr);
8325e765c61SJed Brown #endif
833e5c89e4eSSatish Balay     PetscBeganMPI = PETSC_TRUE;
834e5c89e4eSSatish Balay   }
835e5c89e4eSSatish Balay   if (argc && args) {
836e5c89e4eSSatish Balay     PetscGlobalArgc = *argc;
837e5c89e4eSSatish Balay     PetscGlobalArgs = *args;
838e5c89e4eSSatish Balay   }
839e5c89e4eSSatish Balay   PetscFinalizeCalled = PETSC_FALSE;
8405ad9ad5bSBarry Smith   ierr = PetscSpinlockCreate(&PetscViewerASCIISpinLockOpen);CHKERRQ(ierr);
8415ad9ad5bSBarry Smith   ierr = PetscSpinlockCreate(&PetscViewerASCIISpinLockStdout);CHKERRQ(ierr);
8425ad9ad5bSBarry Smith   ierr = PetscSpinlockCreate(&PetscViewerASCIISpinLockStderr);CHKERRQ(ierr);
843ef19f930SBarry Smith   ierr = PetscSpinlockCreate(&PetscCommSpinLock);CHKERRQ(ierr);
844e5c89e4eSSatish Balay 
845a297a907SKarl Rupp   if (PETSC_COMM_WORLD == MPI_COMM_NULL) PETSC_COMM_WORLD = MPI_COMM_WORLD;
846d54338ecSKarl Rupp   ierr = MPI_Comm_set_errhandler(PETSC_COMM_WORLD,MPI_ERRORS_RETURN);CHKERRQ(ierr);
847e5c89e4eSSatish Balay 
84812801b39SBarry Smith   ierr = MPI_Add_error_class(&PETSC_MPI_ERROR_CLASS);CHKERRQ(ierr);
84912801b39SBarry Smith   ierr = MPI_Add_error_code(PETSC_MPI_ERROR_CLASS,&PETSC_MPI_ERROR_CODE);CHKERRQ(ierr);
85012801b39SBarry Smith 
851e5c89e4eSSatish Balay   /* Done after init due to a bug in MPICH-GM? */
852e5c89e4eSSatish Balay   ierr = PetscErrorPrintfInitialize();CHKERRQ(ierr);
853e5c89e4eSSatish Balay 
854e5c89e4eSSatish Balay   ierr = MPI_Comm_rank(MPI_COMM_WORLD,&PetscGlobalRank);CHKERRQ(ierr);
855e5c89e4eSSatish Balay   ierr = MPI_Comm_size(MPI_COMM_WORLD,&PetscGlobalSize);CHKERRQ(ierr);
856e5c89e4eSSatish Balay 
8578ad47952SJed Brown   MPIU_BOOL = MPI_INT;
8588ad47952SJed Brown   MPIU_ENUM = MPI_INT;
8598ad47952SJed Brown 
860e5c89e4eSSatish Balay   /*
861e5c89e4eSSatish Balay      Initialized the global complex variable; this is because with
862e5c89e4eSSatish Balay      shared libraries the constructors for global variables
863e5c89e4eSSatish Balay      are not called; at least on IRIX.
864e5c89e4eSSatish Balay   */
865886cfec0SSatish Balay #if defined(PETSC_HAVE_COMPLEX)
866e5c89e4eSSatish Balay   {
867252ecd31SSatish Balay #if defined(PETSC_CLANGUAGE_CXX) && !defined(PETSC_USE_REAL___FLOAT128)
86850f81f78SJed Brown     PetscComplex ic(0.0,1.0);
869e5c89e4eSSatish Balay     PETSC_i = ic;
870252ecd31SSatish Balay #else
87150f81f78SJed Brown     PETSC_i = _Complex_I;
872b7940d39SSatish Balay #endif
873762437b8SSatish Balay   }
874762437b8SSatish Balay 
8752c876bd9SBarry Smith #if !defined(PETSC_HAVE_MPI_C_DOUBLE_COMPLEX)
876e69cd0e6SSatish Balay   ierr = MPI_Type_contiguous(2,MPI_DOUBLE,&MPIU_C_DOUBLE_COMPLEX);CHKERRQ(ierr);
877500d8756SSatish Balay   ierr = MPI_Type_commit(&MPIU_C_DOUBLE_COMPLEX);CHKERRQ(ierr);
878500d8756SSatish Balay   ierr = MPI_Type_contiguous(2,MPI_FLOAT,&MPIU_C_COMPLEX);CHKERRQ(ierr);
879500d8756SSatish Balay   ierr = MPI_Type_commit(&MPIU_C_COMPLEX);CHKERRQ(ierr);
8802c876bd9SBarry Smith #endif
881886cfec0SSatish Balay #endif /* PETSC_HAVE_COMPLEX */
882e5c89e4eSSatish Balay 
883e5c89e4eSSatish Balay   /*
884e5c89e4eSSatish Balay      Create the PETSc MPI reduction operator that sums of the first
885e5c89e4eSSatish Balay      half of the entries and maxes the second half.
886e5c89e4eSSatish Balay   */
887367daffbSBarry Smith   ierr = MPI_Op_create(MPIU_MaxSum_Local,1,&MPIU_MAXSUM_OP);CHKERRQ(ierr);
888e5c89e4eSSatish Balay 
889ce63c4c1SBarry Smith #if defined(PETSC_USE_REAL___FLOAT128)
890c90a1750SBarry Smith   ierr = MPI_Type_contiguous(2,MPI_DOUBLE,&MPIU___FLOAT128);CHKERRQ(ierr);
891c90a1750SBarry Smith   ierr = MPI_Type_commit(&MPIU___FLOAT128);CHKERRQ(ierr);
8927c2de775SJed Brown #if defined(PETSC_HAVE_COMPLEX)
8938c764dc5SJose Roman   ierr = MPI_Type_contiguous(4,MPI_DOUBLE,&MPIU___COMPLEX128);CHKERRQ(ierr);
8948c764dc5SJose Roman   ierr = MPI_Type_commit(&MPIU___COMPLEX128);CHKERRQ(ierr);
8958c764dc5SJose Roman #endif
896d9822059SBarry Smith   ierr = MPI_Op_create(PetscMax_Local,1,&MPIU_MAX);CHKERRQ(ierr);
897d9822059SBarry Smith   ierr = MPI_Op_create(PetscMin_Local,1,&MPIU_MIN);CHKERRQ(ierr);
898570b7f6dSBarry Smith #elif defined(PETSC_USE_REAL___FP16)
899570b7f6dSBarry Smith   ierr = MPI_Type_contiguous(2,MPI_CHAR,&MPIU___FP16);CHKERRQ(ierr);
900570b7f6dSBarry Smith   ierr = MPI_Type_commit(&MPIU___FP16);CHKERRQ(ierr);
901570b7f6dSBarry Smith   ierr = MPI_Op_create(PetscMax_Local,1,&MPIU_MAX);CHKERRQ(ierr);
902570b7f6dSBarry Smith   ierr = MPI_Op_create(PetscMin_Local,1,&MPIU_MIN);CHKERRQ(ierr);
903c90a1750SBarry Smith #endif
904c90a1750SBarry Smith 
905570b7f6dSBarry Smith #if (defined(PETSC_HAVE_COMPLEX) && !defined(PETSC_HAVE_MPI_C_DOUBLE_COMPLEX)) || defined(PETSC_USE_REAL___FLOAT128) || defined(PETSC_USE_REAL___FP16)
906cca4cb22SSatish Balay   ierr = MPI_Op_create(PetscSum_Local,1,&MPIU_SUM);CHKERRQ(ierr);
907cca4cb22SSatish Balay #endif
908cca4cb22SSatish Balay 
909e5c89e4eSSatish Balay   ierr = MPI_Type_contiguous(2,MPIU_SCALAR,&MPIU_2SCALAR);CHKERRQ(ierr);
910e5c89e4eSSatish Balay   ierr = MPI_Type_commit(&MPIU_2SCALAR);CHKERRQ(ierr);
911e5c89e4eSSatish Balay 
91244041f26SJed Brown #if defined(PETSC_USE_64BIT_INDICES) || !defined(MPI_2INT)
913e5c89e4eSSatish Balay   ierr = MPI_Type_contiguous(2,MPIU_INT,&MPIU_2INT);CHKERRQ(ierr);
914e5c89e4eSSatish Balay   ierr = MPI_Type_commit(&MPIU_2INT);CHKERRQ(ierr);
91544041f26SJed Brown #endif
916e5c89e4eSSatish Balay 
917ec957eceSBarry Smith 
918e5c89e4eSSatish Balay   /*
919480cf27aSJed Brown      Attributes to be set on PETSc communicators
920480cf27aSJed Brown   */
92112801b39SBarry Smith   ierr = MPI_Comm_create_keyval(MPI_COMM_NULL_COPY_FN,Petsc_DelCounter,&Petsc_Counter_keyval,(void*)0);CHKERRQ(ierr);
92212801b39SBarry Smith   ierr = MPI_Comm_create_keyval(MPI_COMM_NULL_COPY_FN,Petsc_DelComm_Outer,&Petsc_InnerComm_keyval,(void*)0);CHKERRQ(ierr);
92312801b39SBarry Smith   ierr = MPI_Comm_create_keyval(MPI_COMM_NULL_COPY_FN,Petsc_DelComm_Inner,&Petsc_OuterComm_keyval,(void*)0);CHKERRQ(ierr);
92412801b39SBarry Smith   ierr = MPI_Comm_create_keyval(MPI_COMM_NULL_COPY_FN,Petsc_DelShared,&Petsc_Shared_keyval,(void*)0);CHKERRQ(ierr);
925480cf27aSJed Brown 
926480cf27aSJed Brown   /*
927e8fb0fc0SBarry Smith      Build the options database
928e5c89e4eSSatish Balay   */
929c5929fdfSBarry Smith   ierr = PetscOptionsInsert(NULL,argc,args,file);CHKERRQ(ierr);
930e5c89e4eSSatish Balay 
931703f3eceSBarry Smith   /* call a second time so it can look in the options database */
932703f3eceSBarry Smith   ierr = PetscErrorPrintfInitialize();CHKERRQ(ierr);
9336dc8fec2Sbcordonn 
934e5c89e4eSSatish Balay   /*
935e5c89e4eSSatish Balay      Print main application help message
936e5c89e4eSSatish Balay   */
937c5929fdfSBarry Smith   ierr = PetscOptionsHasName(NULL,NULL,"-help",&flg);CHKERRQ(ierr);
938e5c89e4eSSatish Balay   if (help && flg) {
939e5c89e4eSSatish Balay     ierr = PetscPrintf(PETSC_COMM_WORLD,help);CHKERRQ(ierr);
940e5c89e4eSSatish Balay   }
941e5c89e4eSSatish Balay   ierr = PetscOptionsCheckInitial_Private();CHKERRQ(ierr);
942e5c89e4eSSatish Balay 
943d45a07a7SBarry Smith   ierr = PetscCitationsInitialize();CHKERRQ(ierr);
944d45a07a7SBarry Smith 
945e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS)
94611525c0dSBarry Smith   ierr = PetscInitializeSAWs(help);CHKERRQ(ierr);
947f4202a44SBarry Smith #endif
948f4202a44SBarry Smith 
949896238b9SBarry Smith   /* Creates the logging data structures; this is enabled even if logging is not turned on */
950a9f03627SSatish Balay #if defined(PETSC_USE_LOG)
951896238b9SBarry Smith   ierr = PetscLogInitialize();CHKERRQ(ierr);
952a9f03627SSatish Balay #endif
953e5c89e4eSSatish Balay 
954e5c89e4eSSatish Balay   /*
955e5c89e4eSSatish Balay      Load the dynamic libraries (on machines that support them), this registers all
956e5c89e4eSSatish Balay      the solvers etc. (On non-dynamic machines this initializes the PetscDraw and PetscViewer classes)
957e5c89e4eSSatish Balay   */
958e5c89e4eSSatish Balay   ierr = PetscInitialize_DynamicLibraries();CHKERRQ(ierr);
959e5c89e4eSSatish Balay 
960e5c89e4eSSatish Balay   ierr = MPI_Comm_size(PETSC_COMM_WORLD,&size);CHKERRQ(ierr);
961ae15b995SBarry Smith   ierr = PetscInfo1(0,"PETSc successfully started: number of processors = %d\n",size);CHKERRQ(ierr);
962e5c89e4eSSatish Balay   ierr = PetscGetHostName(hostname,256);CHKERRQ(ierr);
963ae15b995SBarry Smith   ierr = PetscInfo1(0,"Running on machine: %s\n",hostname);CHKERRQ(ierr);
964e5c89e4eSSatish Balay 
965e5c89e4eSSatish Balay   ierr = PetscOptionsCheckInitial_Components();CHKERRQ(ierr);
966ef6c6fedSBoyana Norris   /* Check the options database for options related to the options database itself */
967c5929fdfSBarry Smith   ierr = PetscOptionsSetFromOptions(NULL);CHKERRQ(ierr);
968ef6c6fedSBoyana Norris 
969951e3c8eSBarry Smith #if defined(PETSC_USE_PETSC_MPI_EXTERNAL32)
970e39fd77fSBarry Smith   /*
971e39fd77fSBarry Smith       Tell MPI about our own data representation converter, this would/should be used if extern32 is not supported by the MPI
972e39fd77fSBarry Smith 
973e39fd77fSBarry Smith       Currently not used because it is not supported by MPICH.
974e39fd77fSBarry Smith   */
975e39fd77fSBarry Smith #if !defined(PETSC_WORDS_BIGENDIAN)
9760298fd71SBarry Smith   ierr = MPI_Register_datarep((char*)"petsc",PetscDataRep_read_conv_fn,PetscDataRep_write_conv_fn,PetscDataRep_extent_fn,NULL);CHKERRQ(ierr);
977e39fd77fSBarry Smith #endif
978951e3c8eSBarry Smith #endif
979e39fd77fSBarry Smith 
98041c0b4b3SShri Abhyankar   /*
98141c0b4b3SShri Abhyankar       Setup building of stack frames for all function calls
98241c0b4b3SShri Abhyankar   */
983ef19f930SBarry Smith #if defined(PETSC_USE_DEBUG) && !defined(PETSC_HAVE_THREADSAFETY)
984e1167bb9SShri Abhyankar   ierr = PetscStackCreate();CHKERRQ(ierr);
985e1167bb9SShri Abhyankar #endif
986e1167bb9SShri Abhyankar 
9872d53ad75SBarry Smith #if defined(PETSC_SERIALIZE_FUNCTIONS)
9882d53ad75SBarry Smith   ierr = PetscFPTCreate(10000);CHKERRQ(ierr);
9892d53ad75SBarry Smith #endif
9902d53ad75SBarry Smith 
9915e71baefSBarry Smith #if defined(PETSC_HAVE_HWLOC)
99287c3beb6SLisandro Dalcin   {
99387c3beb6SLisandro Dalcin     PetscViewer viewer;
9945e71baefSBarry Smith     ierr = PetscOptionsGetViewer(PETSC_COMM_WORLD,NULL,"-process_view",&viewer,NULL,&flg);CHKERRQ(ierr);
9955e71baefSBarry Smith     if (flg) {
9965e71baefSBarry Smith       ierr = PetscProcessPlacementView(viewer);CHKERRQ(ierr);
99787c3beb6SLisandro Dalcin       ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr);
99887c3beb6SLisandro Dalcin     }
9995e71baefSBarry Smith   }
10005e71baefSBarry Smith #endif
1001dff31646SBarry Smith 
100287c3beb6SLisandro Dalcin   flg = PETSC_TRUE;
100387c3beb6SLisandro Dalcin   ierr = PetscOptionsGetBool(NULL,NULL,"-viewfromoptions",&flg,NULL);CHKERRQ(ierr);
100487c3beb6SLisandro Dalcin   if (!flg) {ierr = PetscOptionsPushGetViewerOff(PETSC_TRUE); CHKERRQ(ierr);}
100587c3beb6SLisandro Dalcin 
1006301d30feSBarry Smith   /*
1007301d30feSBarry Smith       Once we are completedly initialized then we can set this variables
1008301d30feSBarry Smith   */
1009301d30feSBarry Smith   PetscInitializeCalled = PETSC_TRUE;
10102db0e300SLisandro Dalcin 
10112db0e300SLisandro Dalcin   ierr = PetscOptionsHasName(NULL,NULL,"-python",&flg);CHKERRQ(ierr);
10122db0e300SLisandro Dalcin   if (flg) {ierr = PetscPythonInitialize(NULL,NULL);CHKERRQ(ierr);}
1013301d30feSBarry Smith   PetscFunctionReturn(0);
1014e5c89e4eSSatish Balay }
1015e5c89e4eSSatish Balay 
10164097062eSBarry Smith #if defined(PETSC_USE_LOG)
101795c0884eSLisandro Dalcin PETSC_INTERN PetscObject *PetscObjects;
1018ecfe9a72SLisandro Dalcin PETSC_INTERN PetscInt    PetscObjectsCounts;
1019ecfe9a72SLisandro Dalcin PETSC_INTERN PetscInt    PetscObjectsMaxCounts;
102095c0884eSLisandro Dalcin PETSC_INTERN PetscBool   PetscObjectsLog;
10214097062eSBarry Smith #endif
1022e5c89e4eSSatish Balay 
1023008a6e76SBarry Smith /*
1024008a6e76SBarry Smith     Frees all the MPI types and operations that PETSc may have created
1025008a6e76SBarry Smith */
1026008a6e76SBarry Smith PetscErrorCode  PetscFreeMPIResources(void)
1027008a6e76SBarry Smith {
1028008a6e76SBarry Smith   PetscErrorCode ierr;
1029008a6e76SBarry Smith 
1030008a6e76SBarry Smith   PetscFunctionBegin;
1031008a6e76SBarry Smith #if defined(PETSC_USE_REAL___FLOAT128)
1032008a6e76SBarry Smith   ierr = MPI_Type_free(&MPIU___FLOAT128);CHKERRQ(ierr);
1033008a6e76SBarry Smith #if defined(PETSC_HAVE_COMPLEX)
1034008a6e76SBarry Smith   ierr = MPI_Type_free(&MPIU___COMPLEX128);CHKERRQ(ierr);
1035008a6e76SBarry Smith #endif
1036008a6e76SBarry Smith   ierr = MPI_Op_free(&MPIU_MAX);CHKERRQ(ierr);
1037008a6e76SBarry Smith   ierr = MPI_Op_free(&MPIU_MIN);CHKERRQ(ierr);
1038008a6e76SBarry Smith #elif defined(PETSC_USE_REAL___FP16)
1039008a6e76SBarry Smith   ierr = MPI_Type_free(&MPIU___FP16);CHKERRQ(ierr);
1040008a6e76SBarry Smith   ierr = MPI_Op_free(&MPIU_MAX);CHKERRQ(ierr);
1041008a6e76SBarry Smith   ierr = MPI_Op_free(&MPIU_MIN);CHKERRQ(ierr);
1042008a6e76SBarry Smith #endif
1043008a6e76SBarry Smith 
1044008a6e76SBarry Smith #if defined(PETSC_HAVE_COMPLEX)
1045008a6e76SBarry Smith #if !defined(PETSC_HAVE_MPI_C_DOUBLE_COMPLEX)
1046008a6e76SBarry Smith   ierr = MPI_Type_free(&MPIU_C_DOUBLE_COMPLEX);CHKERRQ(ierr);
1047008a6e76SBarry Smith   ierr = MPI_Type_free(&MPIU_C_COMPLEX);CHKERRQ(ierr);
1048008a6e76SBarry Smith #endif
1049008a6e76SBarry Smith #endif
1050008a6e76SBarry Smith 
1051008a6e76SBarry Smith #if (defined(PETSC_HAVE_COMPLEX) && !defined(PETSC_HAVE_MPI_C_DOUBLE_COMPLEX)) || defined(PETSC_USE_REAL___FLOAT128) || defined(PETSC_USE_REAL___FP16)
1052008a6e76SBarry Smith   ierr = MPI_Op_free(&MPIU_SUM);CHKERRQ(ierr);
1053008a6e76SBarry Smith #endif
1054008a6e76SBarry Smith 
1055008a6e76SBarry Smith   ierr = MPI_Type_free(&MPIU_2SCALAR);CHKERRQ(ierr);
1056008a6e76SBarry Smith #if defined(PETSC_USE_64BIT_INDICES) || !defined(MPI_2INT)
1057008a6e76SBarry Smith   ierr = MPI_Type_free(&MPIU_2INT);CHKERRQ(ierr);
1058008a6e76SBarry Smith #endif
1059008a6e76SBarry Smith   ierr = MPI_Op_free(&MPIU_MAXSUM_OP);CHKERRQ(ierr);
1060008a6e76SBarry Smith   PetscFunctionReturn(0);
1061008a6e76SBarry Smith }
1062008a6e76SBarry Smith 
1063e5c89e4eSSatish Balay /*@C
1064e5c89e4eSSatish Balay    PetscFinalize - Checks for options to be called at the conclusion
1065e5c89e4eSSatish Balay    of the program. MPI_Finalize() is called only if the user had not
1066e5c89e4eSSatish Balay    called MPI_Init() before calling PetscInitialize().
1067e5c89e4eSSatish Balay 
1068e5c89e4eSSatish Balay    Collective on PETSC_COMM_WORLD
1069e5c89e4eSSatish Balay 
1070e5c89e4eSSatish Balay    Options Database Keys:
107188c29154SBarry Smith +  -options_table - Calls PetscOptionsView()
1072e5c89e4eSSatish Balay .  -options_left - Prints unused options that remain in the database
10737eb1d149SBarry 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
1074e5c89e4eSSatish Balay .  -mpidump - Calls PetscMPIDump()
1075e5c89e4eSSatish Balay .  -malloc_dump - Calls PetscMallocDump()
1076e5c89e4eSSatish Balay .  -malloc_info - Prints total memory usage
1077e5c89e4eSSatish Balay -  -malloc_log - Prints summary of memory usage
1078e5c89e4eSSatish Balay 
1079e5c89e4eSSatish Balay    Level: beginner
1080e5c89e4eSSatish Balay 
1081e5c89e4eSSatish Balay    Note:
1082e5c89e4eSSatish Balay    See PetscInitialize() for more general runtime options.
1083e5c89e4eSSatish Balay 
108488c29154SBarry Smith .seealso: PetscInitialize(), PetscOptionsView(), PetscMallocDump(), PetscMPIDump(), PetscEnd()
1085e5c89e4eSSatish Balay @*/
10867087cfbeSBarry Smith PetscErrorCode  PetscFinalize(void)
1087e5c89e4eSSatish Balay {
1088e5c89e4eSSatish Balay   PetscErrorCode ierr;
10894bb5149bSJed Brown   PetscMPIInt    rank;
1090a8d2bbe5SBarry Smith   PetscInt       nopt;
10912bf49c77SBarry Smith   PetscBool      flg1 = PETSC_FALSE,flg2 = PETSC_FALSE,flg3 = PETSC_FALSE;
1092dff31646SBarry Smith   PetscBool      flg;
109310463e74SBarry Smith #if defined(PETSC_USE_LOG)
109410463e74SBarry Smith   char           mname[PETSC_MAX_PATH_LEN];
109510463e74SBarry Smith #endif
1096e5c89e4eSSatish Balay 
1097e5c89e4eSSatish Balay   if (!PetscInitializeCalled) {
10984b09e917SBarry Smith     printf("PetscInitialize() must be called before PetscFinalize()\n");
10993cbbc5ffSBarry Smith     return(PETSC_ERR_ARG_WRONGSTATE);
1100e5c89e4eSSatish Balay   }
11013cbbc5ffSBarry Smith   PetscFunctionBegin;
11020298fd71SBarry Smith   ierr = PetscInfo(NULL,"PetscFinalize() called\n");CHKERRQ(ierr);
1103b022a5c1SBarry Smith 
11041f817a21SBarry Smith   ierr = MPI_Comm_rank(PETSC_COMM_WORLD,&rank);CHKERRQ(ierr);
11051f817a21SBarry Smith 
1106c5929fdfSBarry Smith   ierr = PetscOptionsHasName(NULL,NULL,"-citations",&flg);CHKERRQ(ierr);
1107dff31646SBarry Smith   if (flg) {
11081f817a21SBarry Smith     char  *cits, filename[PETSC_MAX_PATH_LEN];
11091f817a21SBarry Smith     FILE  *fd = PETSC_STDOUT;
11101f817a21SBarry Smith 
1111c5929fdfSBarry Smith     ierr = PetscOptionsGetString(NULL,NULL,"-citations",filename,PETSC_MAX_PATH_LEN,NULL);CHKERRQ(ierr);
11121f817a21SBarry Smith     if (filename[0]) {
11131f817a21SBarry Smith       ierr = PetscFOpen(PETSC_COMM_WORLD,filename,"w",&fd);CHKERRQ(ierr);
11141f817a21SBarry Smith     }
1115dff31646SBarry Smith     ierr = PetscSegBufferGet(PetscCitationsList,1,&cits);CHKERRQ(ierr);
1116dff31646SBarry Smith     cits[0] = 0;
1117dff31646SBarry Smith     ierr = PetscSegBufferExtractAlloc(PetscCitationsList,&cits);CHKERRQ(ierr);
11181f817a21SBarry Smith     ierr = PetscFPrintf(PETSC_COMM_WORLD,fd,"If you publish results based on this computation please cite the following:\n");CHKERRQ(ierr);
11191f817a21SBarry Smith     ierr = PetscFPrintf(PETSC_COMM_WORLD,fd,"===========================================================================\n");CHKERRQ(ierr);
11201f817a21SBarry Smith     ierr = PetscFPrintf(PETSC_COMM_WORLD,fd,"%s",cits);CHKERRQ(ierr);
11211f817a21SBarry Smith     ierr = PetscFPrintf(PETSC_COMM_WORLD,fd,"===========================================================================\n");CHKERRQ(ierr);
11221f817a21SBarry Smith     ierr = PetscFClose(PETSC_COMM_WORLD,fd);CHKERRQ(ierr);
1123dff31646SBarry Smith     ierr = PetscFree(cits);CHKERRQ(ierr);
1124dff31646SBarry Smith   }
1125dff31646SBarry Smith   ierr = PetscSegBufferDestroy(&PetscCitationsList);CHKERRQ(ierr);
1126dff31646SBarry Smith 
1127c2a97968SBarry Smith #if defined(PETSC_HAVE_SSL) && defined(PETSC_USE_SOCKET_VIEWER)
112804102261SBarry Smith   /* TextBelt is run for testing purposes only, please do not use this feature often */
112904102261SBarry Smith   {
113004102261SBarry Smith     PetscInt nmax = 2;
113104102261SBarry Smith     char     **buffs;
113204102261SBarry Smith     ierr = PetscMalloc1(2,&buffs);CHKERRQ(ierr);
1133c5929fdfSBarry Smith     ierr = PetscOptionsGetStringArray(NULL,NULL,"-textbelt",buffs,&nmax,&flg1);CHKERRQ(ierr);
113404102261SBarry Smith     if (flg1) {
113504102261SBarry Smith       if (!nmax) SETERRQ(PETSC_COMM_WORLD,PETSC_ERR_USER,"-textbelt requires either the phone number or number,\"message\"");
113604102261SBarry Smith       if (nmax == 1) {
113704102261SBarry Smith         ierr = PetscMalloc1(128,&buffs[1]);CHKERRQ(ierr);
113804102261SBarry Smith         ierr = PetscGetProgramName(buffs[1],32);CHKERRQ(ierr);
113904102261SBarry Smith         ierr = PetscStrcat(buffs[1]," has completed");CHKERRQ(ierr);
114004102261SBarry Smith       }
114104102261SBarry Smith       ierr = PetscTextBelt(PETSC_COMM_WORLD,buffs[0],buffs[1],NULL);CHKERRQ(ierr);
114204102261SBarry Smith       ierr = PetscFree(buffs[0]);CHKERRQ(ierr);
114304102261SBarry Smith       ierr = PetscFree(buffs[1]);CHKERRQ(ierr);
114404102261SBarry Smith     }
114504102261SBarry Smith     ierr = PetscFree(buffs);CHKERRQ(ierr);
114604102261SBarry Smith   }
1147763ec7b1SBarry Smith   {
1148763ec7b1SBarry Smith     PetscInt nmax = 2;
1149763ec7b1SBarry Smith     char     **buffs;
1150763ec7b1SBarry Smith     ierr = PetscMalloc1(2,&buffs);CHKERRQ(ierr);
1151763ec7b1SBarry Smith     ierr = PetscOptionsGetStringArray(NULL,NULL,"-tellmycell",buffs,&nmax,&flg1);CHKERRQ(ierr);
1152763ec7b1SBarry Smith     if (flg1) {
1153763ec7b1SBarry Smith       if (!nmax) SETERRQ(PETSC_COMM_WORLD,PETSC_ERR_USER,"-tellmycell requires either the phone number or number,\"message\"");
1154763ec7b1SBarry Smith       if (nmax == 1) {
1155763ec7b1SBarry Smith         ierr = PetscMalloc1(128,&buffs[1]);CHKERRQ(ierr);
1156763ec7b1SBarry Smith         ierr = PetscGetProgramName(buffs[1],32);CHKERRQ(ierr);
1157763ec7b1SBarry Smith         ierr = PetscStrcat(buffs[1]," has completed");CHKERRQ(ierr);
1158763ec7b1SBarry Smith       }
1159763ec7b1SBarry Smith       ierr = PetscTellMyCell(PETSC_COMM_WORLD,buffs[0],buffs[1],NULL);CHKERRQ(ierr);
1160763ec7b1SBarry Smith       ierr = PetscFree(buffs[0]);CHKERRQ(ierr);
1161763ec7b1SBarry Smith       ierr = PetscFree(buffs[1]);CHKERRQ(ierr);
1162763ec7b1SBarry Smith     }
1163763ec7b1SBarry Smith     ierr = PetscFree(buffs);CHKERRQ(ierr);
1164763ec7b1SBarry Smith   }
116504102261SBarry Smith #endif
116667234432SDmitry Karpeev   /*
116767234432SDmitry Karpeev     It should be safe to cancel the options monitors, since we don't expect to be setting options
116867234432SDmitry Karpeev     here (at least that are worth monitoring).  Monitors ought to be released so that they release
116967234432SDmitry Karpeev     whatever memory was allocated there before -malloc_dump reports unfreed memory.
117067234432SDmitry Karpeev   */
117167234432SDmitry Karpeev   ierr = PetscOptionsMonitorCancel();CHKERRQ(ierr);
117204102261SBarry Smith 
11732d53ad75SBarry Smith #if defined(PETSC_SERIALIZE_FUNCTIONS)
11742d53ad75SBarry Smith   ierr = PetscFPTDestroy();CHKERRQ(ierr);
11752d53ad75SBarry Smith #endif
11762d53ad75SBarry Smith 
11772d53ad75SBarry Smith 
1178e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS)
1179dff31646SBarry Smith   flg = PETSC_FALSE;
1180c5929fdfSBarry Smith   ierr = PetscOptionsGetBool(NULL,NULL,"-saw_options",&flg,NULL);CHKERRQ(ierr);
1181d5649816SBarry Smith   if (flg) {
1182e04113cfSBarry Smith     ierr = PetscOptionsSAWsDestroy();CHKERRQ(ierr);
1183d5649816SBarry Smith   }
1184d5649816SBarry Smith #endif
1185d5649816SBarry Smith 
1186681455b2SBarry Smith #if defined(PETSC_HAVE_X)
1187681455b2SBarry Smith   flg1 = PETSC_FALSE;
1188c5929fdfSBarry Smith   ierr = PetscOptionsGetBool(NULL,NULL,"-x_virtual",&flg1,NULL);CHKERRQ(ierr);
1189681455b2SBarry Smith   if (flg1) {
1190681455b2SBarry Smith     /*  this is a crude hack, but better than nothing */
1191681455b2SBarry Smith     ierr = PetscPOpen(PETSC_COMM_WORLD,NULL,"pkill -9 Xvfb","r",NULL);CHKERRQ(ierr);
1192681455b2SBarry Smith   }
1193681455b2SBarry Smith #endif
1194681455b2SBarry Smith 
119567584ceeSBarry Smith #if !defined(PETSC_HAVE_THREADSAFETY)
1196c5929fdfSBarry Smith   ierr = PetscOptionsGetBool(NULL,NULL,"-malloc_info",&flg2,NULL);CHKERRQ(ierr);
1197e5c89e4eSSatish Balay   if (!flg2) {
119890d69ab7SBarry Smith     flg2 = PETSC_FALSE;
1199c5929fdfSBarry Smith     ierr = PetscOptionsGetBool(NULL,NULL,"-memory_view",&flg2,NULL);CHKERRQ(ierr);
1200e5c89e4eSSatish Balay   }
1201e5c89e4eSSatish Balay   if (flg2) {
12020841954dSBarry Smith     ierr = PetscMemoryView(PETSC_VIEWER_STDOUT_WORLD,"Summary of Memory Usage in PETSc\n");CHKERRQ(ierr);
1203e5c89e4eSSatish Balay   }
120467584ceeSBarry Smith #endif
1205e5c89e4eSSatish Balay 
1206e5c89e4eSSatish Balay #if defined(PETSC_USE_LOG)
120790d69ab7SBarry Smith   flg1 = PETSC_FALSE;
1208c5929fdfSBarry Smith   ierr = PetscOptionsGetBool(NULL,NULL,"-get_total_flops",&flg1,NULL);CHKERRQ(ierr);
1209e5c89e4eSSatish Balay   if (flg1) {
1210e5c89e4eSSatish Balay     PetscLogDouble flops = 0;
1211205a32c2SJed Brown     ierr = MPI_Reduce(&petsc_TotalFlops,&flops,1,MPI_DOUBLE,MPI_SUM,0,PETSC_COMM_WORLD);CHKERRQ(ierr);
1212e5c89e4eSSatish Balay     ierr = PetscPrintf(PETSC_COMM_WORLD,"Total flops over all processors %g\n",flops);CHKERRQ(ierr);
1213e5c89e4eSSatish Balay   }
1214e5c89e4eSSatish Balay #endif
1215e5c89e4eSSatish Balay 
1216e5c89e4eSSatish Balay 
1217e5c89e4eSSatish Balay #if defined(PETSC_USE_LOG)
1218e5c89e4eSSatish Balay #if defined(PETSC_HAVE_MPE)
1219e5c89e4eSSatish Balay   mname[0] = 0;
1220c5929fdfSBarry Smith   ierr = PetscOptionsGetString(NULL,NULL,"-log_mpe",mname,PETSC_MAX_PATH_LEN,&flg1);CHKERRQ(ierr);
1221e5c89e4eSSatish Balay   if (flg1) {
1222e5c89e4eSSatish Balay     if (mname[0]) {ierr = PetscLogMPEDump(mname);CHKERRQ(ierr);}
1223e5c89e4eSSatish Balay     else          {ierr = PetscLogMPEDump(0);CHKERRQ(ierr);}
1224e5c89e4eSSatish Balay   }
1225e5c89e4eSSatish Balay #endif
1226356e5837SBarry Smith #endif
1227a297a907SKarl Rupp 
1228dd710f27SBarry Smith   /*
1229dd710f27SBarry Smith      Free all objects registered with PetscObjectRegisterDestroy() such as PETSC_VIEWER_XXX_().
1230dd710f27SBarry Smith   */
1231dd710f27SBarry Smith   ierr = PetscObjectRegisterDestroyAll();CHKERRQ(ierr);
1232dd710f27SBarry Smith 
1233356e5837SBarry Smith #if defined(PETSC_USE_LOG)
123487c3beb6SLisandro Dalcin   ierr = PetscOptionsPushGetViewerOff(PETSC_FALSE);CHKERRQ(ierr);
1235f14045dbSBarry Smith   ierr = PetscLogViewFromOptions();CHKERRQ(ierr);
123687c3beb6SLisandro Dalcin   ierr = PetscOptionsPopGetViewerOff();CHKERRQ(ierr);
123787c3beb6SLisandro Dalcin 
1238356e5837SBarry Smith   mname[0] = 0;
1239c5929fdfSBarry Smith   ierr = PetscOptionsGetString(NULL,NULL,"-log_summary",mname,PETSC_MAX_PATH_LEN,&flg1);CHKERRQ(ierr);
1240e5c89e4eSSatish Balay   if (flg1) {
124191eabc43SBarry Smith     PetscViewer viewer;
124220a8bfc3SBarry Smith     ierr = (*PetscHelpPrintf)(PETSC_COMM_WORLD,"\n\n WARNING:   -log_summary is being deprecated; switch to -log_view\n\n\n");CHKERRQ(ierr);
124391eabc43SBarry Smith     if (mname[0]) {
124491eabc43SBarry Smith       ierr = PetscViewerASCIIOpen(PETSC_COMM_WORLD,mname,&viewer);CHKERRQ(ierr);
124591eabc43SBarry Smith       ierr = PetscLogView(viewer);CHKERRQ(ierr);
12466bf464f9SBarry Smith       ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr);
124733f85c2fSBarry Smith     } else {
124833f85c2fSBarry Smith       viewer = PETSC_VIEWER_STDOUT_WORLD;
12499a9a5d4cSBarry Smith       ierr   = PetscViewerPushFormat(viewer,PETSC_VIEWER_DEFAULT);CHKERRQ(ierr);
125033f85c2fSBarry Smith       ierr   = PetscLogView(viewer);CHKERRQ(ierr);
12519a9a5d4cSBarry Smith       ierr   = PetscViewerPopFormat(viewer);CHKERRQ(ierr);
125233f85c2fSBarry Smith     }
1253e5c89e4eSSatish Balay   }
1254a297a907SKarl Rupp 
1255dd710f27SBarry Smith   /*
1256dd710f27SBarry Smith      Free any objects created by the last block of code.
1257dd710f27SBarry Smith   */
1258dd710f27SBarry Smith   ierr = PetscObjectRegisterDestroyAll();CHKERRQ(ierr);
1259dd710f27SBarry Smith 
1260dd710f27SBarry Smith   mname[0] = 0;
1261c5929fdfSBarry Smith   ierr = PetscOptionsGetString(NULL,NULL,"-log_all",mname,PETSC_MAX_PATH_LEN,&flg1);CHKERRQ(ierr);
1262c5929fdfSBarry Smith   ierr = PetscOptionsGetString(NULL,NULL,"-log",mname,PETSC_MAX_PATH_LEN,&flg2);CHKERRQ(ierr);
12637ff663adSLisandro Dalcin   if (flg1 || flg2) {ierr = PetscLogDump(mname);CHKERRQ(ierr);}
1264e5c89e4eSSatish Balay #endif
126510463e74SBarry Smith 
126633f85c2fSBarry Smith   ierr = PetscStackDestroy();CHKERRQ(ierr);
126710463e74SBarry Smith 
126890d69ab7SBarry Smith   flg1 = PETSC_FALSE;
1269c5929fdfSBarry Smith   ierr = PetscOptionsGetBool(NULL,NULL,"-no_signal_handler",&flg1,NULL);CHKERRQ(ierr);
1270e5c89e4eSSatish Balay   if (!flg1) { ierr = PetscPopSignalHandler();CHKERRQ(ierr);}
127190d69ab7SBarry Smith   flg1 = PETSC_FALSE;
1272c5929fdfSBarry Smith   ierr = PetscOptionsGetBool(NULL,NULL,"-mpidump",&flg1,NULL);CHKERRQ(ierr);
1273e5c89e4eSSatish Balay   if (flg1) {
1274e5c89e4eSSatish Balay     ierr = PetscMPIDump(stdout);CHKERRQ(ierr);
1275e5c89e4eSSatish Balay   }
127690d69ab7SBarry Smith   flg1 = PETSC_FALSE;
127790d69ab7SBarry Smith   flg2 = PETSC_FALSE;
12788bb29257SSatish Balay   /* preemptive call to avoid listing this option in options table as unused */
1279c5929fdfSBarry Smith   ierr = PetscOptionsHasName(NULL,NULL,"-malloc_dump",&flg1);CHKERRQ(ierr);
1280c5929fdfSBarry Smith   ierr = PetscOptionsHasName(NULL,NULL,"-objects_dump",&flg1);CHKERRQ(ierr);
1281c5929fdfSBarry Smith   ierr = PetscOptionsGetBool(NULL,NULL,"-options_view",&flg2,NULL);CHKERRQ(ierr);
1282e4c476e2SSatish Balay 
1283e5c89e4eSSatish Balay   if (flg2) {
1284be56827dSJed Brown     PetscViewer viewer;
128502ba9f54SBarry Smith     ierr = PetscViewerCreate(PETSC_COMM_WORLD,&viewer);CHKERRQ(ierr);
128602ba9f54SBarry Smith     ierr = PetscViewerSetType(viewer,PETSCVIEWERASCII);CHKERRQ(ierr);
1287c5929fdfSBarry Smith     ierr = PetscOptionsView(NULL,viewer);CHKERRQ(ierr);
1288be56827dSJed Brown     ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr);
1289e5c89e4eSSatish Balay   }
1290e5c89e4eSSatish Balay 
1291e5c89e4eSSatish Balay   /* to prevent PETSc -options_left from warning */
1292c5929fdfSBarry Smith   ierr = PetscOptionsHasName(NULL,NULL,"-nox",&flg1);CHKERRQ(ierr);
1293c5929fdfSBarry Smith   ierr = PetscOptionsHasName(NULL,NULL,"-nox_warning",&flg1);CHKERRQ(ierr);
1294e5c89e4eSSatish Balay 
129533fc4174SSatish Balay   flg3 = PETSC_FALSE; /* default value is required */
1296c5929fdfSBarry Smith   ierr = PetscOptionsGetBool(NULL,NULL,"-options_left",&flg3,&flg1);CHKERRQ(ierr);
1297c5929fdfSBarry Smith   ierr = PetscOptionsAllUsed(NULL,&nopt);CHKERRQ(ierr);
1298e5c89e4eSSatish Balay   if (flg3) {
1299e5c89e4eSSatish Balay     if (!flg2) { /* have not yet printed the options */
1300be56827dSJed Brown       PetscViewer viewer;
130102ba9f54SBarry Smith       ierr = PetscViewerCreate(PETSC_COMM_WORLD,&viewer);CHKERRQ(ierr);
130202ba9f54SBarry Smith       ierr = PetscViewerSetType(viewer,PETSCVIEWERASCII);CHKERRQ(ierr);
1303c5929fdfSBarry Smith       ierr = PetscOptionsView(NULL,viewer);CHKERRQ(ierr);
1304be56827dSJed Brown       ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr);
1305e5c89e4eSSatish Balay     }
1306e5c89e4eSSatish Balay     if (!nopt) {
1307e5c89e4eSSatish Balay       ierr = PetscPrintf(PETSC_COMM_WORLD,"There are no unused options.\n");CHKERRQ(ierr);
1308e5c89e4eSSatish Balay     } else if (nopt == 1) {
1309e5c89e4eSSatish Balay       ierr = PetscPrintf(PETSC_COMM_WORLD,"There is one unused database option. It is:\n");CHKERRQ(ierr);
1310e5c89e4eSSatish Balay     } else {
13117582186dSLisandro Dalcin       ierr = PetscPrintf(PETSC_COMM_WORLD,"There are %D unused database options. They are:\n",nopt);CHKERRQ(ierr);
1312e5c89e4eSSatish Balay     }
1313df12ba86SBarry Smith   }
1314e5c89e4eSSatish Balay #if defined(PETSC_USE_DEBUG)
1315da8b8a77SBarry Smith   if (nopt && !flg3 && !flg1) {
1316e5c89e4eSSatish Balay     ierr = PetscPrintf(PETSC_COMM_WORLD,"WARNING! There are options you set that were not used!\n");CHKERRQ(ierr);
1317e5c89e4eSSatish Balay     ierr = PetscPrintf(PETSC_COMM_WORLD,"WARNING! could be spelling mistake, etc!\n");CHKERRQ(ierr);
1318c5929fdfSBarry Smith     ierr = PetscOptionsLeft(NULL);CHKERRQ(ierr);
1319e5c89e4eSSatish Balay   } else if (nopt && flg3) {
1320e5c89e4eSSatish Balay #else
1321e5c89e4eSSatish Balay   if (nopt && flg3) {
1322e5c89e4eSSatish Balay #endif
1323c5929fdfSBarry Smith     ierr = PetscOptionsLeft(NULL);CHKERRQ(ierr);
1324e5c89e4eSSatish Balay   }
1325e5c89e4eSSatish Balay 
1326e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS)
1327d45a07a7SBarry Smith   if (!PetscGlobalRank) {
132887f587eeSBarry Smith     ierr = PetscStackSAWsViewOff();CHKERRQ(ierr);
132916ad0300SBarry Smith     PetscStackCallSAWs(SAWs_Finalize,());
1330d45a07a7SBarry Smith   }
1331ec957eceSBarry Smith #endif
1332ec957eceSBarry Smith 
13334097062eSBarry Smith #if defined(PETSC_USE_LOG)
133410463e74SBarry Smith   /*
1335dbc8283eSBarry Smith        List all objects the user may have forgot to free
13362eff7a51SBarry Smith   */
133705df10baSBarry Smith   if (PetscObjectsLog) {
1338c5929fdfSBarry Smith     ierr = PetscOptionsHasName(NULL,NULL,"-objects_dump",&flg1);CHKERRQ(ierr);
1339a64a8e02SBarry Smith     if (flg1) {
1340a64a8e02SBarry Smith       MPI_Comm local_comm;
13417eb1d149SBarry Smith       char     string[64];
1342a64a8e02SBarry Smith 
1343c5929fdfSBarry Smith       ierr = PetscOptionsGetString(NULL,NULL,"-objects_dump",string,64,NULL);CHKERRQ(ierr);
1344a64a8e02SBarry Smith       ierr = MPI_Comm_dup(MPI_COMM_WORLD,&local_comm);CHKERRQ(ierr);
1345a64a8e02SBarry Smith       ierr = PetscSequentialPhaseBegin_Private(local_comm,1);CHKERRQ(ierr);
13467eb1d149SBarry Smith       ierr = PetscObjectsDump(stdout,(string[0] == 'a') ? PETSC_TRUE : PETSC_FALSE);CHKERRQ(ierr);
1347a64a8e02SBarry Smith       ierr = PetscSequentialPhaseEnd_Private(local_comm,1);CHKERRQ(ierr);
1348a64a8e02SBarry Smith       ierr = MPI_Comm_free(&local_comm);CHKERRQ(ierr);
13490a1571b3SBarry Smith     }
135005df10baSBarry Smith   }
13514097062eSBarry Smith #endif
13524097062eSBarry Smith 
13534097062eSBarry Smith #if defined(PETSC_USE_LOG)
1354dbc8283eSBarry Smith   PetscObjectsCounts    = 0;
1355dbc8283eSBarry Smith   PetscObjectsMaxCounts = 0;
1356a297a907SKarl Rupp   ierr = PetscFree(PetscObjects);CHKERRQ(ierr);
13574097062eSBarry Smith #endif
13582eff7a51SBarry Smith 
135933f85c2fSBarry Smith   /*
136033f85c2fSBarry Smith      Destroy any packages that registered a finalize
136133f85c2fSBarry Smith   */
136233f85c2fSBarry Smith   ierr = PetscRegisterFinalizeAll();CHKERRQ(ierr);
136333f85c2fSBarry Smith 
1364101409b8SToby Isaac #if defined(PETSC_USE_LOG)
1365fa2bb9feSLisandro Dalcin   ierr = PetscLogFinalize();CHKERRQ(ierr);
1366101409b8SToby Isaac #endif
1367101409b8SToby Isaac 
136833f85c2fSBarry Smith   /*
136948dd1dffSBarry Smith      Print PetscFunctionLists that have not been properly freed
137048dd1dffSBarry Smith 
137137e93019SBarry Smith   ierr = PetscFunctionListPrintAll();CHKERRQ(ierr);
137248dd1dffSBarry Smith   */
137337e93019SBarry Smith 
13744028d114SSatish Balay   if (petsc_history) {
1375f3dea69dSBarry Smith     ierr = PetscCloseHistoryFile(&petsc_history);CHKERRQ(ierr);
1376e5c89e4eSSatish Balay     petsc_history = 0;
1377e5c89e4eSSatish Balay   }
13789de0f6ecSBarry Smith   ierr = PetscOptionsHelpPrintedDestroy(&PetscOptionsHelpPrintedSingleton);CHKERRQ(ierr);
1379e5c89e4eSSatish Balay 
13800298fd71SBarry Smith   ierr = PetscInfoAllow(PETSC_FALSE,NULL);CHKERRQ(ierr);
1381e5c89e4eSSatish Balay 
138267584ceeSBarry Smith #if !defined(PETSC_HAVE_THREADSAFETY)
13838bb29257SSatish Balay   {
1384e5c89e4eSSatish Balay     char fname[PETSC_MAX_PATH_LEN];
1385e5c89e4eSSatish Balay     FILE *fd;
1386ed9cf6e9SBarry Smith     int  err;
1387e5c89e4eSSatish Balay 
1388e5c89e4eSSatish Balay     fname[0] = 0;
1389a297a907SKarl Rupp 
1390c5929fdfSBarry Smith     ierr = PetscOptionsGetString(NULL,NULL,"-malloc_dump",fname,250,&flg1);CHKERRQ(ierr);
1391dc92acbaSJed Brown     flg2 = PETSC_FALSE;
1392c5929fdfSBarry Smith     ierr = PetscOptionsGetBool(NULL,NULL,"-malloc_test",&flg2,NULL);CHKERRQ(ierr);
13938bf1f09cSShri Abhyankar #if defined(PETSC_USE_DEBUG)
1394dc92acbaSJed Brown     if (PETSC_RUNNING_ON_VALGRIND) flg2 = PETSC_FALSE;
1395dc92acbaSJed Brown #else
1396dc92acbaSJed Brown     flg2 = PETSC_FALSE;         /* Skip reporting for optimized builds regardless of -malloc_test */
1397dc92acbaSJed Brown #endif
1398e5c89e4eSSatish Balay     if (flg1 && fname[0]) {
1399e5c89e4eSSatish Balay       char sname[PETSC_MAX_PATH_LEN];
1400e5c89e4eSSatish Balay 
14012e924ca5SSatish Balay       PetscSNPrintf(sname,PETSC_MAX_PATH_LEN,"%s_%d",fname,rank);
1402e32f2f54SBarry Smith       fd   = fopen(sname,"w"); if (!fd) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_FILE_OPEN,"Cannot open log file: %s",sname);
1403e5c89e4eSSatish Balay       ierr = PetscMallocDump(fd);CHKERRQ(ierr);
1404ed9cf6e9SBarry Smith       err  = fclose(fd);
1405e32f2f54SBarry Smith       if (err) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SYS,"fclose() failed on file");
1406dc92acbaSJed Brown     } else if (flg1 || flg2) {
1407e5c89e4eSSatish Balay       MPI_Comm local_comm;
1408e5c89e4eSSatish Balay 
1409e5c89e4eSSatish Balay       ierr = MPI_Comm_dup(MPI_COMM_WORLD,&local_comm);CHKERRQ(ierr);
1410e5c89e4eSSatish Balay       ierr = PetscSequentialPhaseBegin_Private(local_comm,1);CHKERRQ(ierr);
1411e5c89e4eSSatish Balay       ierr = PetscMallocDump(stdout);CHKERRQ(ierr);
1412e5c89e4eSSatish Balay       ierr = PetscSequentialPhaseEnd_Private(local_comm,1);CHKERRQ(ierr);
1413e5c89e4eSSatish Balay       ierr = MPI_Comm_free(&local_comm);CHKERRQ(ierr);
1414e5c89e4eSSatish Balay     }
1415e5c89e4eSSatish Balay   }
1416a64a8e02SBarry Smith 
14178bb29257SSatish Balay   {
1418e5c89e4eSSatish Balay     char fname[PETSC_MAX_PATH_LEN];
14190298fd71SBarry Smith     FILE *fd = NULL;
1420e5c89e4eSSatish Balay 
1421e5c89e4eSSatish Balay     fname[0] = 0;
1422a297a907SKarl Rupp 
1423c5929fdfSBarry Smith     ierr = PetscOptionsGetString(NULL,NULL,"-malloc_log",fname,250,&flg1);CHKERRQ(ierr);
1424c5929fdfSBarry Smith     ierr = PetscOptionsHasName(NULL,NULL,"-malloc_log_threshold",&flg2);CHKERRQ(ierr);
1425e5c89e4eSSatish Balay     if (flg1 && fname[0]) {
1426ed9cf6e9SBarry Smith       int err;
1427e5c89e4eSSatish Balay 
1428574034a9SJed Brown       if (!rank) {
1429574034a9SJed Brown         fd = fopen(fname,"w");
1430574034a9SJed Brown         if (!fd) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_FILE_OPEN,"Cannot open log file: %s",fname);
1431574034a9SJed Brown       }
1432e5c89e4eSSatish Balay       ierr = PetscMallocDumpLog(fd);CHKERRQ(ierr);
1433574034a9SJed Brown       if (fd) {
1434ed9cf6e9SBarry Smith         err = fclose(fd);
1435e32f2f54SBarry Smith         if (err) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SYS,"fclose() failed on file");
1436574034a9SJed Brown       }
1437574034a9SJed Brown     } else if (flg1 || flg2) {
1438e5c89e4eSSatish Balay       ierr = PetscMallocDumpLog(stdout);CHKERRQ(ierr);
1439e5c89e4eSSatish Balay     }
1440e5c89e4eSSatish Balay   }
144167584ceeSBarry Smith #endif
144220e2c332SMatthew G. Knepley 
14435486ca60SMatthew G. Knepley   /*
14445486ca60SMatthew G. Knepley      Close any open dynamic libraries
14455486ca60SMatthew G. Knepley   */
14465486ca60SMatthew G. Knepley   ierr = PetscFinalize_DynamicLibraries();CHKERRQ(ierr);
14475486ca60SMatthew G. Knepley 
1448e5c89e4eSSatish Balay   /* Can be destroyed only after all the options are used */
14494416b707SBarry Smith   ierr = PetscOptionsDestroyDefault();CHKERRQ(ierr);
1450e5c89e4eSSatish Balay 
1451e5c89e4eSSatish Balay   PetscGlobalArgc = 0;
1452e5c89e4eSSatish Balay   PetscGlobalArgs = 0;
1453e5c89e4eSSatish Balay 
1454008a6e76SBarry Smith   ierr = PetscFreeMPIResources();CHKERRQ(ierr);
1455e5c89e4eSSatish Balay 
1456dbc8283eSBarry Smith   /*
1457efb80d3cSBarry Smith      Destroy any known inner MPI_Comm's and attributes pointing to them
1458efb80d3cSBarry Smith      Note this will not destroy any new communicators the user has created.
1459efb80d3cSBarry Smith 
1460efb80d3cSBarry Smith      If all PETSc objects were not destroyed those left over objects will have hanging references to
1461efb80d3cSBarry Smith      the MPI_Comms that were freed; but that is ok because those PETSc objects will never be used again
1462dbc8283eSBarry Smith  */
1463b770b1f6SSatish Balay   {
1464dbc8283eSBarry Smith     PetscCommCounter *counter;
1465dbc8283eSBarry Smith     PetscMPIInt      flg;
1466dbc8283eSBarry Smith     MPI_Comm         icomm;
1467265f3f35SJed Brown     union {MPI_Comm comm; void *ptr;} ucomm;
146847435625SJed Brown     ierr = MPI_Comm_get_attr(PETSC_COMM_SELF,Petsc_InnerComm_keyval,&ucomm,&flg);CHKERRQ(ierr);
1469dbc8283eSBarry Smith     if (flg) {
1470265f3f35SJed Brown       icomm = ucomm.comm;
147147435625SJed Brown       ierr = MPI_Comm_get_attr(icomm,Petsc_Counter_keyval,&counter,&flg);CHKERRQ(ierr);
1472dbc8283eSBarry 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");
1473dbc8283eSBarry Smith 
147447435625SJed Brown       ierr = MPI_Comm_delete_attr(PETSC_COMM_SELF,Petsc_InnerComm_keyval);CHKERRQ(ierr);
147547435625SJed Brown       ierr = MPI_Comm_delete_attr(icomm,Petsc_Counter_keyval);CHKERRQ(ierr);
1476efb80d3cSBarry Smith       ierr = MPI_Comm_free(&icomm);CHKERRQ(ierr);
1477dbc8283eSBarry Smith     }
147847435625SJed Brown     ierr = MPI_Comm_get_attr(PETSC_COMM_WORLD,Petsc_InnerComm_keyval,&ucomm,&flg);CHKERRQ(ierr);
1479dbc8283eSBarry Smith     if (flg) {
1480265f3f35SJed Brown       icomm = ucomm.comm;
148147435625SJed Brown       ierr = MPI_Comm_get_attr(icomm,Petsc_Counter_keyval,&counter,&flg);CHKERRQ(ierr);
1482dbc8283eSBarry 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");
1483dbc8283eSBarry Smith 
148447435625SJed Brown       ierr = MPI_Comm_delete_attr(PETSC_COMM_WORLD,Petsc_InnerComm_keyval);CHKERRQ(ierr);
148547435625SJed Brown       ierr = MPI_Comm_delete_attr(icomm,Petsc_Counter_keyval);CHKERRQ(ierr);
1486efb80d3cSBarry Smith       ierr = MPI_Comm_free(&icomm);CHKERRQ(ierr);
1487dbc8283eSBarry Smith     }
1488b770b1f6SSatish Balay   }
1489dbc8283eSBarry Smith 
149047435625SJed Brown   ierr = MPI_Comm_free_keyval(&Petsc_Counter_keyval);CHKERRQ(ierr);
149147435625SJed Brown   ierr = MPI_Comm_free_keyval(&Petsc_InnerComm_keyval);CHKERRQ(ierr);
149247435625SJed Brown   ierr = MPI_Comm_free_keyval(&Petsc_OuterComm_keyval);CHKERRQ(ierr);
149347435625SJed Brown   ierr = MPI_Comm_free_keyval(&Petsc_Shared_keyval);CHKERRQ(ierr);
1494480cf27aSJed Brown 
14955ad9ad5bSBarry Smith   ierr = PetscSpinlockDestroy(&PetscViewerASCIISpinLockOpen);CHKERRQ(ierr);
14965ad9ad5bSBarry Smith   ierr = PetscSpinlockDestroy(&PetscViewerASCIISpinLockStdout);CHKERRQ(ierr);
14975ad9ad5bSBarry Smith   ierr = PetscSpinlockDestroy(&PetscViewerASCIISpinLockStderr);CHKERRQ(ierr);
1498ef19f930SBarry Smith   ierr = PetscSpinlockDestroy(&PetscCommSpinLock);CHKERRQ(ierr);
1499ef19f930SBarry Smith 
1500e5c89e4eSSatish Balay   if (PetscBeganMPI) {
150199608316SBarry Smith #if defined(PETSC_HAVE_MPI_FINALIZED)
150299b1327fSBarry Smith     PetscMPIInt flag;
150399b1327fSBarry Smith     ierr = MPI_Finalized(&flag);CHKERRQ(ierr);
1504e32f2f54SBarry Smith     if (flag) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_LIB,"MPI_Finalize() has already been called, even though MPI_Init() was called by PetscInitialize()");
150599608316SBarry Smith #endif
1506e5c89e4eSSatish Balay     ierr = MPI_Finalize();CHKERRQ(ierr);
1507e5c89e4eSSatish Balay   }
1508e5c89e4eSSatish Balay /*
1509e5c89e4eSSatish Balay 
1510e5c89e4eSSatish Balay      Note: In certain cases PETSC_COMM_WORLD is never MPI_Comm_free()ed because
1511e5c89e4eSSatish Balay    the communicator has some outstanding requests on it. Specifically if the
1512e5c89e4eSSatish Balay    flag PETSC_HAVE_BROKEN_REQUEST_FREE is set (for IBM MPI implementation). See
1513e5c89e4eSSatish Balay    src/vec/utils/vpscat.c. Due to this the memory allocated in PetscCommDuplicate()
1514e5c89e4eSSatish Balay    is never freed as it should be. Thus one may obtain messages of the form
15150e5e90baSSatish Balay    [ 1] 8 bytes PetscCommDuplicate() line 645 in src/sys/mpiu.c indicating the
1516e5c89e4eSSatish Balay    memory was not freed.
1517e5c89e4eSSatish Balay 
1518e5c89e4eSSatish Balay */
15191d1a0024SBarry Smith   ierr = PetscMallocClear();CHKERRQ(ierr);
1520a297a907SKarl Rupp 
1521e5c89e4eSSatish Balay   PetscInitializeCalled = PETSC_FALSE;
1522e5c89e4eSSatish Balay   PetscFinalizeCalled   = PETSC_TRUE;
15233db9a53dSBarry Smith   PetscFunctionReturn(0);
1524e5c89e4eSSatish Balay }
1525e5c89e4eSSatish Balay 
152643db4dbbSBarry Smith #if defined(PETSC_MISSING_LAPACK_lsame_)
15278cc058d9SJed Brown PETSC_EXTERN int lsame_(char *a,char *b)
152843db4dbbSBarry Smith {
152943db4dbbSBarry Smith   if (*a == *b) return 1;
153043db4dbbSBarry Smith   if (*a + 32 == *b) return 1;
153143db4dbbSBarry Smith   if (*a - 32 == *b) return 1;
153243db4dbbSBarry Smith   return 0;
153343db4dbbSBarry Smith }
1534a70650f6SBarry Smith #endif
153543db4dbbSBarry Smith 
153643db4dbbSBarry Smith #if defined(PETSC_MISSING_LAPACK_lsame)
15378cc058d9SJed Brown PETSC_EXTERN int lsame(char *a,char *b)
153843db4dbbSBarry Smith {
153943db4dbbSBarry Smith   if (*a == *b) return 1;
154043db4dbbSBarry Smith   if (*a + 32 == *b) return 1;
154143db4dbbSBarry Smith   if (*a - 32 == *b) return 1;
154243db4dbbSBarry Smith   return 0;
154343db4dbbSBarry Smith }
154443db4dbbSBarry Smith #endif
1545