xref: /petsc/src/sys/objects/pinit.c (revision 26a7e8d4e09c279f8415befc673616c1506e57c3)
17d0a6c19SBarry Smith 
2e5c89e4eSSatish Balay /*
3e5c89e4eSSatish Balay    This file defines the initialization of PETSc, including PetscInitialize()
4e5c89e4eSSatish Balay */
5af0996ceSBarry Smith #include <petsc/private/petscimpl.h>        /*I  "petscsys.h"   I*/
6022afb99SBarry Smith #include <petscvalgrind.h>
7665c2dedSJed Brown #include <petscviewer.h>
88101f56cSMatthew Knepley 
9a9f03627SSatish Balay #if defined(PETSC_USE_LOG)
10896238b9SBarry Smith extern PetscErrorCode PetscLogInitialize(void);
11a9f03627SSatish Balay #endif
12f2d66bcaSShri Abhyankar 
132d53ad75SBarry Smith #if defined(PETSC_SERIALIZE_FUNCTIONS)
142d53ad75SBarry Smith PetscFPT PetscFPTData = 0;
152d53ad75SBarry Smith #endif
162d53ad75SBarry Smith 
17a6790183SBarry Smith #if defined(PETSC_HAVE_SAWS)
1816ad0300SBarry Smith #include <petscviewersaws.h>
19a6790183SBarry Smith #endif
20e5c89e4eSSatish Balay /* -----------------------------------------------------------------------------------------*/
21e5c89e4eSSatish Balay 
22e5c89e4eSSatish Balay extern FILE *petsc_history;
23e5c89e4eSSatish Balay 
2409573ac7SBarry Smith extern PetscErrorCode PetscInitialize_DynamicLibraries(void);
2509573ac7SBarry Smith extern PetscErrorCode PetscFinalize_DynamicLibraries(void);
2637e93019SBarry Smith extern PetscErrorCode PetscFunctionListPrintAll(void);
2709573ac7SBarry Smith extern PetscErrorCode PetscSequentialPhaseBegin_Private(MPI_Comm,int);
2809573ac7SBarry Smith extern PetscErrorCode PetscSequentialPhaseEnd_Private(MPI_Comm,int);
2909573ac7SBarry Smith extern PetscErrorCode PetscCloseHistoryFile(FILE**);
300069ddf5SShri Abhyankar 
31e5c89e4eSSatish Balay /* user may set this BEFORE calling PetscInitialize() */
32e8373e55SMatthew Knepley MPI_Comm PETSC_COMM_WORLD = MPI_COMM_NULL;
33e5c89e4eSSatish Balay 
34480cf27aSJed Brown PetscMPIInt Petsc_Counter_keyval   = MPI_KEYVAL_INVALID;
35480cf27aSJed Brown PetscMPIInt Petsc_InnerComm_keyval = MPI_KEYVAL_INVALID;
36480cf27aSJed Brown PetscMPIInt Petsc_OuterComm_keyval = MPI_KEYVAL_INVALID;
3742218b76SBarry Smith PetscMPIInt Petsc_Shared_keyval    = MPI_KEYVAL_INVALID;
38480cf27aSJed Brown 
39e5c89e4eSSatish Balay /*
40e5c89e4eSSatish Balay      Declare and set all the string names of the PETSc enums
41e5c89e4eSSatish Balay */
426a6fc655SJed Brown const char *const PetscBools[]     = {"FALSE","TRUE","PetscBool","PETSC_",0};
436a6fc655SJed Brown const char *const PetscCopyModes[] = {"COPY_VALUES","OWN_POINTER","USE_POINTER","PetscCopyMode","PETSC_",0};
446a6fc655SJed Brown const char *const PetscDataTypes[] = {"INT","DOUBLE","COMPLEX","LONG","SHORT","FLOAT",
452d53ad75SBarry Smith                                       "CHAR","LOGICAL","ENUM","BOOL","LONGDOUBLE","OBJECT","FUNCTION","PetscDataType","PETSC_",0};
46e5c89e4eSSatish Balay 
47ace3abfcSBarry Smith PetscBool PetscPreLoadingUsed = PETSC_FALSE;
48ace3abfcSBarry Smith PetscBool PetscPreLoadingOn   = PETSC_FALSE;
490f8e0872SSatish Balay 
50a2f94806SJed Brown PetscInt PetscHotRegionDepth;
51a2f94806SJed Brown 
52b22622e2STadeu Manoel #if defined(PETSC_HAVE_THREADSAFETY)
53b22622e2STadeu Manoel PetscSpinlock PetscViewerASCIISpinLockOpen;
54b22622e2STadeu Manoel PetscSpinlock PetscViewerASCIISpinLockStdout;
55b22622e2STadeu Manoel PetscSpinlock PetscViewerASCIISpinLockStderr;
56b22622e2STadeu Manoel PetscSpinlock PetscCommSpinLock;
57b22622e2STadeu Manoel #endif
58b22622e2STadeu Manoel 
59e5c89e4eSSatish Balay /*
60e5c89e4eSSatish Balay        Checks the options database for initializations related to the
61e5c89e4eSSatish Balay     PETSc components
62e5c89e4eSSatish Balay */
637087cfbeSBarry Smith PetscErrorCode  PetscOptionsCheckInitial_Components(void)
64e5c89e4eSSatish Balay {
65ace3abfcSBarry Smith   PetscBool      flg1;
66e5c89e4eSSatish Balay   PetscErrorCode ierr;
67e5c89e4eSSatish Balay 
68e5c89e4eSSatish Balay   PetscFunctionBegin;
69c5929fdfSBarry Smith   ierr = PetscOptionsHasName(NULL,NULL,"-help",&flg1);CHKERRQ(ierr);
70e5c89e4eSSatish Balay   if (flg1) {
71e5c89e4eSSatish Balay #if defined(PETSC_USE_LOG)
72e8e7597cSSatish Balay     MPI_Comm comm = PETSC_COMM_WORLD;
73e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm,"------Additional PETSc component options--------\n");CHKERRQ(ierr);
748e81d068SLisandro Dalcin     ierr = (*PetscHelpPrintf)(comm," -log_exclude: <vec,mat,pc,ksp,snes,tao,ts>\n");CHKERRQ(ierr);
758e81d068SLisandro Dalcin     ierr = (*PetscHelpPrintf)(comm," -info_exclude: <null,vec,mat,pc,ksp,snes,tao,ts>\n");CHKERRQ(ierr);
76e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm,"-----------------------------------------------\n");CHKERRQ(ierr);
77e5c89e4eSSatish Balay #endif
78e5c89e4eSSatish Balay   }
79e5c89e4eSSatish Balay   PetscFunctionReturn(0);
80e5c89e4eSSatish Balay }
81e5c89e4eSSatish Balay 
820f11a792SBarry Smith /*
83945d1669SBarry Smith       PetscInitializeNoPointers - Calls PetscInitialize() from C/C++ without the pointers to argc and args
8472a42c3cSBarry Smith 
8572a42c3cSBarry Smith    Collective
8672a42c3cSBarry Smith 
8772a42c3cSBarry Smith    Level: advanced
8872a42c3cSBarry Smith 
89945d1669SBarry Smith     Notes: this is called only by the PETSc MATLAB and Julia interface. Even though it might start MPI it sets the flag to
900f11a792SBarry Smith      indicate that it did NOT start MPI so that the PetscFinalize() does not end MPI, thus allowing PetscInitialize() to
91945d1669SBarry Smith      be called multiple times from MATLAB and Julia without the problem of trying to initialize MPI more than once.
920f11a792SBarry Smith 
931ea5a559SBarry Smith      Turns off PETSc signal handling because that can interact with MATLAB's signal handling causing random crashes.
941ea5a559SBarry Smith 
9572a42c3cSBarry Smith .seealso: PetscInitialize(), PetscInitializeFortran(), PetscInitializeNoArguments()
960f11a792SBarry Smith */
97945d1669SBarry Smith PetscErrorCode  PetscInitializeNoPointers(int argc,char **args,const char *filename,const char *help)
9872a42c3cSBarry Smith {
9972a42c3cSBarry Smith   PetscErrorCode ierr;
10072a42c3cSBarry Smith   int            myargc   = argc;
10172a42c3cSBarry Smith   char           **myargs = args;
10272a42c3cSBarry Smith 
10372a42c3cSBarry Smith   PetscFunctionBegin;
1043bf036e2SBarry Smith   ierr = PetscInitialize(&myargc,&myargs,filename,help);CHKERRQ(ierr);
1051ea5a559SBarry Smith   ierr = PetscPopSignalHandler();CHKERRQ(ierr);
106df413903SBarry Smith   PetscBeganMPI = PETSC_FALSE;
10772a42c3cSBarry Smith   PetscFunctionReturn(ierr);
10872a42c3cSBarry Smith }
10972a42c3cSBarry Smith 
110f0865b08SBarry Smith /*
111945d1669SBarry Smith       Used by MATLAB and Julia interface to get communicator
112f0865b08SBarry Smith */
113945d1669SBarry Smith PetscErrorCode  PetscGetPETSC_COMM_SELF(MPI_Comm *comm)
114f0865b08SBarry Smith {
115f0865b08SBarry Smith   PetscFunctionBegin;
116f0865b08SBarry Smith   *comm = PETSC_COMM_SELF;
117f0865b08SBarry Smith   PetscFunctionReturn(0);
118f0865b08SBarry Smith }
119f0865b08SBarry Smith 
120e5c89e4eSSatish Balay /*@C
121e5c89e4eSSatish Balay       PetscInitializeNoArguments - Calls PetscInitialize() from C/C++ without
122e5c89e4eSSatish Balay         the command line arguments.
123e5c89e4eSSatish Balay 
124e5c89e4eSSatish Balay    Collective
125e5c89e4eSSatish Balay 
126e5c89e4eSSatish Balay    Level: advanced
127e5c89e4eSSatish Balay 
128e5c89e4eSSatish Balay .seealso: PetscInitialize(), PetscInitializeFortran()
129e5c89e4eSSatish Balay @*/
1307087cfbeSBarry Smith PetscErrorCode  PetscInitializeNoArguments(void)
131e5c89e4eSSatish Balay {
132e5c89e4eSSatish Balay   PetscErrorCode ierr;
133e5c89e4eSSatish Balay   int            argc   = 0;
134e5c89e4eSSatish Balay   char           **args = 0;
135e5c89e4eSSatish Balay 
136e5c89e4eSSatish Balay   PetscFunctionBegin;
1370298fd71SBarry Smith   ierr = PetscInitialize(&argc,&args,NULL,NULL);
138e5c89e4eSSatish Balay   PetscFunctionReturn(ierr);
139e5c89e4eSSatish Balay }
140e5c89e4eSSatish Balay 
141e5c89e4eSSatish Balay /*@
142e5c89e4eSSatish Balay       PetscInitialized - Determine whether PETSc is initialized.
143e5c89e4eSSatish Balay 
14493b6d2d1SJed Brown    Level: beginner
145e5c89e4eSSatish Balay 
146e5c89e4eSSatish Balay .seealso: PetscInitialize(), PetscInitializeNoArguments(), PetscInitializeFortran()
147e5c89e4eSSatish Balay @*/
1487087cfbeSBarry Smith PetscErrorCode PetscInitialized(PetscBool  *isInitialized)
149e5c89e4eSSatish Balay {
150e5c89e4eSSatish Balay   *isInitialized = PetscInitializeCalled;
15193b6d2d1SJed Brown   return 0;
152e5c89e4eSSatish Balay }
153e5c89e4eSSatish Balay 
154e5c89e4eSSatish Balay /*@
155e5c89e4eSSatish Balay       PetscFinalized - Determine whether PetscFinalize() has been called yet
156e5c89e4eSSatish Balay 
157e5c89e4eSSatish Balay    Level: developer
158e5c89e4eSSatish Balay 
159e5c89e4eSSatish Balay .seealso: PetscInitialize(), PetscInitializeNoArguments(), PetscInitializeFortran()
160e5c89e4eSSatish Balay @*/
1617087cfbeSBarry Smith PetscErrorCode  PetscFinalized(PetscBool  *isFinalized)
162e5c89e4eSSatish Balay {
163e5c89e4eSSatish Balay   *isFinalized = PetscFinalizeCalled;
16493b6d2d1SJed Brown   return 0;
165e5c89e4eSSatish Balay }
166e5c89e4eSSatish Balay 
16709573ac7SBarry Smith extern PetscErrorCode PetscOptionsCheckInitial_Private(void);
168e5c89e4eSSatish Balay 
169e5c89e4eSSatish Balay /*
170e5c89e4eSSatish Balay        This function is the MPI reduction operation used to compute the sum of the
171e5c89e4eSSatish Balay    first half of the datatype and the max of the second half.
172e5c89e4eSSatish Balay */
173367daffbSBarry Smith MPI_Op MPIU_MAXSUM_OP = 0;
174e5c89e4eSSatish Balay 
175367daffbSBarry Smith PETSC_INTERN void MPIAPI MPIU_MaxSum_Local(void *in,void *out,int *cnt,MPI_Datatype *datatype)
176e5c89e4eSSatish Balay {
177e5c89e4eSSatish Balay   PetscInt *xin = (PetscInt*)in,*xout = (PetscInt*)out,i,count = *cnt;
178e5c89e4eSSatish Balay 
179e5c89e4eSSatish Balay   PetscFunctionBegin;
180e5c89e4eSSatish Balay   if (*datatype != MPIU_2INT) {
181e5c89e4eSSatish Balay     (*PetscErrorPrintf)("Can only handle MPIU_2INT data types");
182e5c89e4eSSatish Balay     MPI_Abort(MPI_COMM_WORLD,1);
183e5c89e4eSSatish Balay   }
184e5c89e4eSSatish Balay 
185e5c89e4eSSatish Balay   for (i=0; i<count; i++) {
186e5c89e4eSSatish Balay     xout[2*i]    = PetscMax(xout[2*i],xin[2*i]);
187e5c89e4eSSatish Balay     xout[2*i+1] += xin[2*i+1];
188e5c89e4eSSatish Balay   }
189812af9f3SBarry Smith   PetscFunctionReturnVoid();
190e5c89e4eSSatish Balay }
191e5c89e4eSSatish Balay 
192e5c89e4eSSatish Balay /*
193e5c89e4eSSatish Balay     Returns the max of the first entry owned by this processor and the
194e5c89e4eSSatish Balay sum of the second entry.
195b693b147SBarry Smith 
19676f543a4SJed Brown     The reason sizes[2*i] contains lengths sizes[2*i+1] contains flag of 1 if length is nonzero
197367daffbSBarry Smith is so that the MPIU_MAXSUM_OP() can set TWO values, if we passed in only sizes[i] with lengths
198b693b147SBarry Smith there would be no place to store the both needed results.
199e5c89e4eSSatish Balay */
20076ec1555SBarry Smith PetscErrorCode  PetscMaxSum(MPI_Comm comm,const PetscInt sizes[],PetscInt *max,PetscInt *sum)
201e5c89e4eSSatish Balay {
202e5c89e4eSSatish Balay   PetscErrorCode ierr;
203e5c89e4eSSatish Balay 
204e5c89e4eSSatish Balay   PetscFunctionBegin;
205d6e4c47cSJed Brown #if defined(PETSC_HAVE_MPI_REDUCE_SCATTER_BLOCK)
206d6e4c47cSJed Brown   {
207d6e4c47cSJed Brown     struct {PetscInt max,sum;} work;
208367daffbSBarry Smith     ierr = MPI_Reduce_scatter_block((void*)sizes,&work,1,MPIU_2INT,MPIU_MAXSUM_OP,comm);CHKERRQ(ierr);
209d6e4c47cSJed Brown     *max = work.max;
210d6e4c47cSJed Brown     *sum = work.sum;
211d6e4c47cSJed Brown   }
212d6e4c47cSJed Brown #else
213d6e4c47cSJed Brown   {
214d6e4c47cSJed Brown     PetscMPIInt    size,rank;
215d6e4c47cSJed Brown     struct {PetscInt max,sum;} *work;
216e5c89e4eSSatish Balay     ierr = MPI_Comm_size(comm,&size);CHKERRQ(ierr);
217e5c89e4eSSatish Balay     ierr = MPI_Comm_rank(comm,&rank);CHKERRQ(ierr);
218785e854fSJed Brown     ierr = PetscMalloc1(size,&work);CHKERRQ(ierr);
219367daffbSBarry Smith     ierr = MPIU_Allreduce((void*)sizes,work,size,MPIU_2INT,MPIU_MAXSUM_OP,comm);CHKERRQ(ierr);
2206ac3741eSJed Brown     *max = work[rank].max;
2216ac3741eSJed Brown     *sum = work[rank].sum;
222e5c89e4eSSatish Balay     ierr = PetscFree(work);CHKERRQ(ierr);
223d6e4c47cSJed Brown   }
224d6e4c47cSJed Brown #endif
225e5c89e4eSSatish Balay   PetscFunctionReturn(0);
226e5c89e4eSSatish Balay }
227e5c89e4eSSatish Balay 
228e5c89e4eSSatish Balay /* ----------------------------------------------------------------------------*/
229e5c89e4eSSatish Balay 
230570b7f6dSBarry Smith #if (defined(PETSC_HAVE_COMPLEX) && !defined(PETSC_HAVE_MPI_C_DOUBLE_COMPLEX)) || defined(PETSC_USE_REAL___FLOAT128) || defined(PETSC_USE_REAL___FP16)
23106a205a8SBarry Smith MPI_Op MPIU_SUM = 0;
232e5c89e4eSSatish Balay 
2338cc058d9SJed Brown PETSC_EXTERN void PetscSum_Local(void *in,void *out,PetscMPIInt *cnt,MPI_Datatype *datatype)
234e5c89e4eSSatish Balay {
235e5c89e4eSSatish Balay   PetscInt i,count = *cnt;
236e5c89e4eSSatish Balay 
237e5c89e4eSSatish Balay   PetscFunctionBegin;
2387c2de775SJed Brown   if (*datatype == MPIU_REAL) {
239e2e03761SBarry Smith     PetscReal *xin = (PetscReal*)in,*xout = (PetscReal*)out;
240a297a907SKarl Rupp     for (i=0; i<count; i++) xout[i] += xin[i];
2417c2de775SJed Brown   }
2427c2de775SJed Brown #if defined(PETSC_HAVE_COMPLEX)
2437c2de775SJed Brown   else if (*datatype == MPIU_COMPLEX) {
2447c2de775SJed Brown     PetscComplex *xin = (PetscComplex*)in,*xout = (PetscComplex*)out;
245a297a907SKarl Rupp     for (i=0; i<count; i++) xout[i] += xin[i];
2467c2de775SJed Brown   }
2477c2de775SJed Brown #endif
2487c2de775SJed Brown   else {
2497c2de775SJed Brown     (*PetscErrorPrintf)("Can only handle MPIU_REAL or MPIU_COMPLEX data types");
250e2e03761SBarry Smith     MPI_Abort(MPI_COMM_WORLD,1);
251e2e03761SBarry Smith   }
252812af9f3SBarry Smith   PetscFunctionReturnVoid();
253e5c89e4eSSatish Balay }
254e5c89e4eSSatish Balay #endif
255e5c89e4eSSatish Balay 
256570b7f6dSBarry Smith #if defined(PETSC_USE_REAL___FLOAT128) || defined(PETSC_USE_REAL___FP16)
257d9822059SBarry Smith MPI_Op MPIU_MAX = 0;
258d9822059SBarry Smith MPI_Op MPIU_MIN = 0;
259d9822059SBarry Smith 
2608cc058d9SJed Brown PETSC_EXTERN void PetscMax_Local(void *in,void *out,PetscMPIInt *cnt,MPI_Datatype *datatype)
261d9822059SBarry Smith {
262d9822059SBarry Smith   PetscInt i,count = *cnt;
263d9822059SBarry Smith 
264d9822059SBarry Smith   PetscFunctionBegin;
2657c2de775SJed Brown   if (*datatype == MPIU_REAL) {
2668c764dc5SJose Roman     PetscReal *xin = (PetscReal*)in,*xout = (PetscReal*)out;
267a297a907SKarl Rupp     for (i=0; i<count; i++) xout[i] = PetscMax(xout[i],xin[i]);
2687c2de775SJed Brown   }
2697c2de775SJed Brown #if defined(PETSC_HAVE_COMPLEX)
2707c2de775SJed Brown   else if (*datatype == MPIU_COMPLEX) {
2717c2de775SJed Brown     PetscComplex *xin = (PetscComplex*)in,*xout = (PetscComplex*)out;
2727c2de775SJed Brown     for (i=0; i<count; i++) {
2737c2de775SJed Brown       xout[i] = PetscRealPartComplex(xout[i])<PetscRealPartComplex(xin[i]) ? xin[i] : xout[i];
2747c2de775SJed Brown     }
2757c2de775SJed Brown   }
2767c2de775SJed Brown #endif
2777c2de775SJed Brown   else {
2787c2de775SJed Brown     (*PetscErrorPrintf)("Can only handle MPIU_REAL or MPIU_COMPLEX data types");
2798c764dc5SJose Roman     MPI_Abort(MPI_COMM_WORLD,1);
2808c764dc5SJose Roman   }
281d9822059SBarry Smith   PetscFunctionReturnVoid();
282d9822059SBarry Smith }
283d9822059SBarry Smith 
2848cc058d9SJed Brown PETSC_EXTERN void PetscMin_Local(void *in,void *out,PetscMPIInt *cnt,MPI_Datatype *datatype)
285d9822059SBarry Smith {
286d9822059SBarry Smith   PetscInt    i,count = *cnt;
287d9822059SBarry Smith 
288d9822059SBarry Smith   PetscFunctionBegin;
2897c2de775SJed Brown   if (*datatype == MPIU_REAL) {
2908c764dc5SJose Roman     PetscReal *xin = (PetscReal*)in,*xout = (PetscReal*)out;
291a297a907SKarl Rupp     for (i=0; i<count; i++) xout[i] = PetscMin(xout[i],xin[i]);
2927c2de775SJed Brown   }
2937c2de775SJed Brown #if defined(PETSC_HAVE_COMPLEX)
2947c2de775SJed Brown   else if (*datatype == MPIU_COMPLEX) {
2957c2de775SJed Brown     PetscComplex *xin = (PetscComplex*)in,*xout = (PetscComplex*)out;
2967c2de775SJed Brown     for (i=0; i<count; i++) {
2977c2de775SJed Brown       xout[i] = PetscRealPartComplex(xout[i])>PetscRealPartComplex(xin[i]) ? xin[i] : xout[i];
2987c2de775SJed Brown     }
2997c2de775SJed Brown   }
3007c2de775SJed Brown #endif
3017c2de775SJed Brown   else {
3028c764dc5SJose Roman     (*PetscErrorPrintf)("Can only handle MPIU_REAL or MPIU_SCALAR data (i.e. double or complex) types");
3038c764dc5SJose Roman     MPI_Abort(MPI_COMM_WORLD,1);
3048c764dc5SJose Roman   }
305d9822059SBarry Smith   PetscFunctionReturnVoid();
306d9822059SBarry Smith }
307d9822059SBarry Smith #endif
308d9822059SBarry Smith 
309480cf27aSJed Brown /*
310480cf27aSJed Brown    Private routine to delete internal tag/name counter storage when a communicator is freed.
311480cf27aSJed Brown 
312ff0e51ddSBarry 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.
313480cf27aSJed Brown 
31412801b39SBarry Smith    Note: this is declared extern "C" because it is passed to MPI_Comm_create_keyval()
315480cf27aSJed Brown 
316480cf27aSJed Brown */
3178cc058d9SJed Brown PETSC_EXTERN PetscMPIInt MPIAPI Petsc_DelCounter(MPI_Comm comm,PetscMPIInt keyval,void *count_val,void *extra_state)
318480cf27aSJed Brown {
319480cf27aSJed Brown   PetscErrorCode ierr;
320480cf27aSJed Brown 
321480cf27aSJed Brown   PetscFunctionBegin;
32212801b39SBarry Smith   ierr = PetscInfo1(0,"Deleting counter data in an MPI_Comm %ld\n",(long)comm);CHKERRMPI(ierr);
32312801b39SBarry Smith   ierr = PetscFree(count_val);CHKERRMPI(ierr);
324480cf27aSJed Brown   PetscFunctionReturn(MPI_SUCCESS);
325480cf27aSJed Brown }
326480cf27aSJed Brown 
327480cf27aSJed Brown /*
32847435625SJed Brown   This is invoked on the outer comm as a result of either PetscCommDestroy() (via MPI_Comm_delete_attr) or when the user
329da3039f7SJed Brown   calls MPI_Comm_free().
330da3039f7SJed Brown 
331da3039f7SJed Brown   This is the only entry point for breaking the links between inner and outer comms.
332480cf27aSJed Brown 
333ff0e51ddSBarry Smith   This is called by MPI, not by users. This is called when MPI_Comm_free() is called on the communicator.
334480cf27aSJed Brown 
33512801b39SBarry Smith   Note: this is declared extern "C" because it is passed to MPI_Comm_create_keyval()
336480cf27aSJed Brown 
337480cf27aSJed Brown */
338da3039f7SJed Brown PETSC_EXTERN PetscMPIInt MPIAPI Petsc_DelComm_Outer(MPI_Comm comm,PetscMPIInt keyval,void *attr_val,void *extra_state)
339480cf27aSJed Brown {
340480cf27aSJed Brown   PetscErrorCode                    ierr;
341b89831e5SBarry Smith   PetscMPIInt                       flg;
342265f3f35SJed Brown   union {MPI_Comm comm; void *ptr;} icomm,ocomm;
343480cf27aSJed Brown 
344480cf27aSJed Brown   PetscFunctionBegin;
34512801b39SBarry Smith   if (keyval != Petsc_InnerComm_keyval) SETERRMPI(PETSC_COMM_SELF,PETSC_ERR_ARG_CORRUPT,"Unexpected keyval");
346ec4fadc2SJed Brown   icomm.ptr = attr_val;
347da3039f7SJed Brown 
34847435625SJed Brown   ierr = MPI_Comm_get_attr(icomm.comm,Petsc_OuterComm_keyval,&ocomm,&flg);CHKERRMPI(ierr);
34912801b39SBarry Smith   if (!flg) SETERRMPI(PETSC_COMM_SELF,PETSC_ERR_ARG_CORRUPT,"Inner MPI_Comm does not have expected reference to outer comm");
35012801b39SBarry Smith   if (ocomm.comm != comm) SETERRMPI(PETSC_COMM_SELF,PETSC_ERR_ARG_CORRUPT,"Inner MPI_Comm has reference to non-matching outer comm");
35147435625SJed Brown   ierr = MPI_Comm_delete_attr(icomm.comm,Petsc_OuterComm_keyval);CHKERRMPI(ierr);
35212801b39SBarry 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);
353da3039f7SJed Brown   PetscFunctionReturn(MPI_SUCCESS);
354b89831e5SBarry Smith }
355da3039f7SJed Brown 
356da3039f7SJed Brown /*
35747435625SJed 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.
358da3039f7SJed Brown  */
359da3039f7SJed Brown PETSC_EXTERN PetscMPIInt MPIAPI Petsc_DelComm_Inner(MPI_Comm comm,PetscMPIInt keyval,void *attr_val,void *extra_state)
360da3039f7SJed Brown {
361da3039f7SJed Brown   PetscErrorCode ierr;
362da3039f7SJed Brown 
363da3039f7SJed Brown   PetscFunctionBegin;
36412801b39SBarry Smith   ierr = PetscInfo1(0,"Removing reference to PETSc communicator embedded in a user MPI_Comm %ld\n",(long)comm);CHKERRMPI(ierr);
365480cf27aSJed Brown   PetscFunctionReturn(MPI_SUCCESS);
366480cf27aSJed Brown }
367480cf27aSJed Brown 
36842218b76SBarry Smith PETSC_EXTERN PetscMPIInt MPIAPI Petsc_DelShared(MPI_Comm,PetscMPIInt,void *,void *);
36942218b76SBarry Smith 
370951e3c8eSBarry Smith #if defined(PETSC_USE_PETSC_MPI_EXTERNAL32)
371e39fd77fSBarry Smith #if !defined(PETSC_WORDS_BIGENDIAN)
3728cc058d9SJed Brown PETSC_EXTERN PetscMPIInt PetscDataRep_extent_fn(MPI_Datatype,MPI_Aint*,void*);
3738cc058d9SJed Brown PETSC_EXTERN PetscMPIInt PetscDataRep_read_conv_fn(void*, MPI_Datatype,PetscMPIInt,void*,MPI_Offset,void*);
3748cc058d9SJed Brown PETSC_EXTERN PetscMPIInt PetscDataRep_write_conv_fn(void*, MPI_Datatype,PetscMPIInt,void*,MPI_Offset,void*);
375e39fd77fSBarry Smith #endif
376951e3c8eSBarry Smith #endif
377e39fd77fSBarry Smith 
37812801b39SBarry Smith PetscMPIInt PETSC_MPI_ERROR_CLASS,PETSC_MPI_ERROR_CODE;
37912801b39SBarry Smith 
3806ae9a8a6SBarry Smith int  PetscGlobalArgc   = 0;
3816ae9a8a6SBarry Smith char **PetscGlobalArgs = 0;
382dff31646SBarry Smith PetscSegBuffer PetscCitationsList;
383e5c89e4eSSatish Balay 
384dd63322aSSatish Balay PetscErrorCode PetscCitationsInitialize(void)
385051e4cf2SJed Brown {
386051e4cf2SJed Brown   PetscErrorCode ierr;
387051e4cf2SJed Brown 
388051e4cf2SJed Brown   PetscFunctionBegin;
389051e4cf2SJed Brown   ierr = PetscSegBufferCreate(1,10000,&PetscCitationsList);CHKERRQ(ierr);
390f191ac77SSatish 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);
391051e4cf2SJed 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);
392051e4cf2SJed Brown   PetscFunctionReturn(0);
393051e4cf2SJed Brown }
394e5c89e4eSSatish Balay 
395e5c89e4eSSatish Balay /*@C
396e5c89e4eSSatish Balay    PetscGetArgs - Allows you to access the raw command line arguments anywhere
397e5c89e4eSSatish Balay      after PetscInitialize() is called but before PetscFinalize().
398e5c89e4eSSatish Balay 
399e5c89e4eSSatish Balay    Not Collective
400e5c89e4eSSatish Balay 
401e5c89e4eSSatish Balay    Output Parameters:
402e5c89e4eSSatish Balay +  argc - count of number of command line arguments
403e5c89e4eSSatish Balay -  args - the command line arguments
404e5c89e4eSSatish Balay 
405e5c89e4eSSatish Balay    Level: intermediate
406e5c89e4eSSatish Balay 
407e5c89e4eSSatish Balay    Notes:
408e5c89e4eSSatish Balay       This is usually used to pass the command line arguments into other libraries
409e5c89e4eSSatish Balay    that are called internally deep in PETSc or the application.
410e5c89e4eSSatish Balay 
411f177e3b1SBarry Smith       The first argument contains the program name as is normal for C arguments.
412f177e3b1SBarry Smith 
413e5c89e4eSSatish Balay    Concepts: command line arguments
414e5c89e4eSSatish Balay 
415793721a6SBarry Smith .seealso: PetscFinalize(), PetscInitializeFortran(), PetscGetArguments()
416e5c89e4eSSatish Balay 
417e5c89e4eSSatish Balay @*/
4187087cfbeSBarry Smith PetscErrorCode  PetscGetArgs(int *argc,char ***args)
419e5c89e4eSSatish Balay {
420e5c89e4eSSatish Balay   PetscFunctionBegin;
42117186662SBarry Smith   if (!PetscInitializeCalled && PetscFinalizeCalled) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ORDER,"You must call after PetscInitialize() but before PetscFinalize()");
422e5c89e4eSSatish Balay   *argc = PetscGlobalArgc;
423e5c89e4eSSatish Balay   *args = PetscGlobalArgs;
424e5c89e4eSSatish Balay   PetscFunctionReturn(0);
425e5c89e4eSSatish Balay }
426e5c89e4eSSatish Balay 
427793721a6SBarry Smith /*@C
428793721a6SBarry Smith    PetscGetArguments - Allows you to access the  command line arguments anywhere
429793721a6SBarry Smith      after PetscInitialize() is called but before PetscFinalize().
430793721a6SBarry Smith 
431793721a6SBarry Smith    Not Collective
432793721a6SBarry Smith 
433793721a6SBarry Smith    Output Parameters:
434793721a6SBarry Smith .  args - the command line arguments
435793721a6SBarry Smith 
436793721a6SBarry Smith    Level: intermediate
437793721a6SBarry Smith 
438793721a6SBarry Smith    Notes:
439793721a6SBarry Smith       This does NOT start with the program name and IS null terminated (final arg is void)
440793721a6SBarry Smith 
441793721a6SBarry Smith    Concepts: command line arguments
442793721a6SBarry Smith 
443793721a6SBarry Smith .seealso: PetscFinalize(), PetscInitializeFortran(), PetscGetArgs(), PetscFreeArguments()
444793721a6SBarry Smith 
445793721a6SBarry Smith @*/
4467087cfbeSBarry Smith PetscErrorCode  PetscGetArguments(char ***args)
447793721a6SBarry Smith {
448793721a6SBarry Smith   PetscInt       i,argc = PetscGlobalArgc;
449793721a6SBarry Smith   PetscErrorCode ierr;
450793721a6SBarry Smith 
451793721a6SBarry Smith   PetscFunctionBegin;
45217186662SBarry Smith   if (!PetscInitializeCalled && PetscFinalizeCalled) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ORDER,"You must call after PetscInitialize() but before PetscFinalize()");
453717030eeSLisandro Dalcin   if (!argc) {*args = 0; PetscFunctionReturn(0);}
454785e854fSJed Brown   ierr = PetscMalloc1(argc,args);CHKERRQ(ierr);
455793721a6SBarry Smith   for (i=0; i<argc-1; i++) {
456793721a6SBarry Smith     ierr = PetscStrallocpy(PetscGlobalArgs[i+1],&(*args)[i]);CHKERRQ(ierr);
457793721a6SBarry Smith   }
458793721a6SBarry Smith   (*args)[argc-1] = 0;
459793721a6SBarry Smith   PetscFunctionReturn(0);
460793721a6SBarry Smith }
461793721a6SBarry Smith 
462793721a6SBarry Smith /*@C
463793721a6SBarry Smith    PetscFreeArguments - Frees the memory obtained with PetscGetArguments()
464793721a6SBarry Smith 
465793721a6SBarry Smith    Not Collective
466793721a6SBarry Smith 
467793721a6SBarry Smith    Output Parameters:
468793721a6SBarry Smith .  args - the command line arguments
469793721a6SBarry Smith 
470793721a6SBarry Smith    Level: intermediate
471793721a6SBarry Smith 
472793721a6SBarry Smith    Concepts: command line arguments
473793721a6SBarry Smith 
474793721a6SBarry Smith .seealso: PetscFinalize(), PetscInitializeFortran(), PetscGetArgs(), PetscGetArguments()
475793721a6SBarry Smith 
476793721a6SBarry Smith @*/
4777087cfbeSBarry Smith PetscErrorCode  PetscFreeArguments(char **args)
478793721a6SBarry Smith {
479793721a6SBarry Smith   PetscInt       i = 0;
480793721a6SBarry Smith   PetscErrorCode ierr;
481793721a6SBarry Smith 
482793721a6SBarry Smith   PetscFunctionBegin;
483a297a907SKarl Rupp   if (!args) PetscFunctionReturn(0);
484793721a6SBarry Smith   while (args[i]) {
485793721a6SBarry Smith     ierr = PetscFree(args[i]);CHKERRQ(ierr);
486793721a6SBarry Smith     i++;
487793721a6SBarry Smith   }
488793721a6SBarry Smith   ierr = PetscFree(args);CHKERRQ(ierr);
489793721a6SBarry Smith   PetscFunctionReturn(0);
490793721a6SBarry Smith }
491793721a6SBarry Smith 
49211525c0dSBarry Smith #if defined(PETSC_HAVE_SAWS)
49330befbd2SBarry Smith #include <petscconfiginfo.h>
49430befbd2SBarry Smith 
49511525c0dSBarry Smith PetscErrorCode  PetscInitializeSAWs(const char help[])
49611525c0dSBarry Smith {
49711525c0dSBarry Smith   if (!PetscGlobalRank) {
49830befbd2SBarry Smith     char           cert[PETSC_MAX_PATH_LEN],root[PETSC_MAX_PATH_LEN],*intro,programname[64],*appline,*options,version[64];
49911525c0dSBarry Smith     int            port;
500ffbd1cfbSBarry Smith     PetscBool      flg,rootlocal = PETSC_FALSE,flg2,selectport = PETSC_FALSE;
50111525c0dSBarry Smith     size_t         applinelen,introlen;
50211525c0dSBarry Smith     PetscErrorCode ierr;
503ffbd1cfbSBarry Smith     char           sawsurl[256];
50411525c0dSBarry Smith 
505c5929fdfSBarry Smith     ierr = PetscOptionsHasName(NULL,NULL,"-saws_log",&flg);CHKERRQ(ierr);
50611525c0dSBarry Smith     if (flg) {
50711525c0dSBarry Smith       char  sawslog[PETSC_MAX_PATH_LEN];
50811525c0dSBarry Smith 
509c5929fdfSBarry Smith       ierr = PetscOptionsGetString(NULL,NULL,"-saws_log",sawslog,PETSC_MAX_PATH_LEN,NULL);CHKERRQ(ierr);
51011525c0dSBarry Smith       if (sawslog[0]) {
51111525c0dSBarry Smith         PetscStackCallSAWs(SAWs_Set_Use_Logfile,(sawslog));
51211525c0dSBarry Smith       } else {
51311525c0dSBarry Smith         PetscStackCallSAWs(SAWs_Set_Use_Logfile,(NULL));
51411525c0dSBarry Smith       }
51511525c0dSBarry Smith     }
516c5929fdfSBarry Smith     ierr = PetscOptionsGetString(NULL,NULL,"-saws_https",cert,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr);
51711525c0dSBarry Smith     if (flg) {
51811525c0dSBarry Smith       PetscStackCallSAWs(SAWs_Set_Use_HTTPS,(cert));
51911525c0dSBarry Smith     }
520c5929fdfSBarry Smith     ierr = PetscOptionsGetBool(NULL,NULL,"-saws_port_auto_select",&selectport,NULL);CHKERRQ(ierr);
521ffbd1cfbSBarry Smith     if (selectport) {
522ffbd1cfbSBarry Smith         PetscStackCallSAWs(SAWs_Get_Available_Port,(&port));
523ffbd1cfbSBarry Smith         PetscStackCallSAWs(SAWs_Set_Port,(port));
524ffbd1cfbSBarry Smith     } else {
525c5929fdfSBarry Smith       ierr = PetscOptionsGetInt(NULL,NULL,"-saws_port",&port,&flg);CHKERRQ(ierr);
52611525c0dSBarry Smith       if (flg) {
52711525c0dSBarry Smith         PetscStackCallSAWs(SAWs_Set_Port,(port));
52811525c0dSBarry Smith       }
529ffbd1cfbSBarry Smith     }
530c5929fdfSBarry Smith     ierr = PetscOptionsGetString(NULL,NULL,"-saws_root",root,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr);
53111525c0dSBarry Smith     if (flg) {
53211525c0dSBarry Smith       PetscStackCallSAWs(SAWs_Set_Document_Root,(root));CHKERRQ(ierr);
53311525c0dSBarry Smith       ierr = PetscStrcmp(root,".",&rootlocal);CHKERRQ(ierr);
5349c1e0ce8SBarry Smith     } else {
535c5929fdfSBarry Smith       ierr = PetscOptionsHasName(NULL,NULL,"-saws_options",&flg);CHKERRQ(ierr);
5369c1e0ce8SBarry Smith       if (flg) {
5373c01dfcfSBarry Smith         ierr = PetscStrreplace(PETSC_COMM_WORLD,"${PETSC_DIR}/share/petsc/saws",root,PETSC_MAX_PATH_LEN);CHKERRQ(ierr);
5389c1e0ce8SBarry Smith         PetscStackCallSAWs(SAWs_Set_Document_Root,(root));CHKERRQ(ierr);
5399c1e0ce8SBarry Smith       }
54011525c0dSBarry Smith     }
541c5929fdfSBarry Smith     ierr = PetscOptionsHasName(NULL,NULL,"-saws_local",&flg2);CHKERRQ(ierr);
54211525c0dSBarry Smith     if (flg2) {
54311525c0dSBarry Smith       char jsdir[PETSC_MAX_PATH_LEN];
54411525c0dSBarry Smith       if (!flg) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SUP,"-saws_local option requires -saws_root option");
54511525c0dSBarry Smith       ierr = PetscSNPrintf(jsdir,PETSC_MAX_PATH_LEN,"%s/js",root);CHKERRQ(ierr);
54611525c0dSBarry Smith       ierr = PetscTestDirectory(jsdir,'r',&flg);CHKERRQ(ierr);
54711525c0dSBarry Smith       if (!flg) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_FILE_READ,"-saws_local option requires js directory in root directory");
54843da4ab2SBarry Smith       PetscStackCallSAWs(SAWs_Push_Local_Header,());CHKERRQ(ierr);
54911525c0dSBarry Smith     }
55011525c0dSBarry Smith     ierr = PetscGetProgramName(programname,64);CHKERRQ(ierr);
55111525c0dSBarry Smith     ierr = PetscStrlen(help,&applinelen);CHKERRQ(ierr);
55211525c0dSBarry Smith     introlen   = 4096 + applinelen;
55330a8c9c0SSurtai Han     applinelen += 1024;
55411525c0dSBarry Smith     ierr = PetscMalloc(applinelen,&appline);CHKERRQ(ierr);
55511525c0dSBarry Smith     ierr = PetscMalloc(introlen,&intro);CHKERRQ(ierr);
55611525c0dSBarry Smith 
55711525c0dSBarry Smith     if (rootlocal) {
55811525c0dSBarry Smith       ierr = PetscSNPrintf(appline,applinelen,"%s.c.html",programname);CHKERRQ(ierr);
55911525c0dSBarry Smith       ierr = PetscTestFile(appline,'r',&rootlocal);CHKERRQ(ierr);
56011525c0dSBarry Smith     }
56176a34f28SBarry Smith     ierr = PetscOptionsGetAll(NULL,&options);CHKERRQ(ierr);
56211525c0dSBarry Smith     if (rootlocal && help) {
56330befbd2SBarry 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);
56411525c0dSBarry Smith     } else if (help) {
56530a8c9c0SSurtai Han       ierr = PetscSNPrintf(appline,applinelen,"<center>Running %s %s</center><br><center><pre>%s</pre></center><br>",programname,options,help);
56611525c0dSBarry Smith     } else {
56730befbd2SBarry Smith       ierr = PetscSNPrintf(appline,applinelen,"<center> Running %s %s</center><br>\n",programname,options);
56811525c0dSBarry Smith     }
569b0bb5815SBarry Smith     ierr = PetscFree(options);CHKERRQ(ierr);
57030befbd2SBarry Smith     ierr = PetscGetVersion(version,sizeof(version));CHKERRQ(ierr);
57111525c0dSBarry Smith     ierr = PetscSNPrintf(intro,introlen,"<body>\n"
57211525c0dSBarry 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"
573df62c222SBarry 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"
574df62c222SBarry Smith                                     "%s",version,petscconfigureoptions,appline);
57543da4ab2SBarry Smith     PetscStackCallSAWs(SAWs_Push_Body,("index.html",0,intro));
57611525c0dSBarry Smith     ierr = PetscFree(intro);CHKERRQ(ierr);
57711525c0dSBarry Smith     ierr = PetscFree(appline);CHKERRQ(ierr);
578ffbd1cfbSBarry Smith     if (selectport) {
579aa573868SBarry Smith       PetscBool silent;
5807d812c46SBarry Smith 
5817d812c46SBarry Smith       ierr = SAWs_Initialize();
5827d812c46SBarry Smith       /* another process may have grabbed the port so keep trying */
5837d812c46SBarry Smith       while (ierr) {
5847d812c46SBarry Smith         PetscStackCallSAWs(SAWs_Get_Available_Port,(&port));
5857d812c46SBarry Smith         PetscStackCallSAWs(SAWs_Set_Port,(port));
5867d812c46SBarry Smith         ierr = SAWs_Initialize();
5877d812c46SBarry Smith       }
5887d812c46SBarry Smith 
589aa573868SBarry Smith       ierr = PetscOptionsGetBool(NULL,NULL,"-saws_port_auto_select_silent",&silent,NULL);CHKERRQ(ierr);
590aa573868SBarry Smith       if (!silent) {
591ffbd1cfbSBarry Smith         PetscStackCallSAWs(SAWs_Get_FullURL,(sizeof(sawsurl),sawsurl));
592ffbd1cfbSBarry Smith         ierr = PetscPrintf(PETSC_COMM_WORLD,"Point your browser to %s for SAWs\n",sawsurl);CHKERRQ(ierr);
593ffbd1cfbSBarry Smith       }
5947d812c46SBarry Smith     } else {
5957d812c46SBarry Smith       PetscStackCallSAWs(SAWs_Initialize,());
596aa573868SBarry Smith     }
5970af79b04SBarry Smith     ierr = PetscCitationsRegister("@TechReport{ saws,\n"
5980af79b04SBarry Smith                                   "  Author = {Matt Otten and Jed Brown and Barry Smith},\n"
5990af79b04SBarry Smith                                   "  Title  = {Scientific Application Web Server (SAWs) Users Manual},\n"
6000af79b04SBarry Smith                                   "  Institution = {Argonne National Laboratory},\n"
6010af79b04SBarry Smith                                   "  Year   = 2013\n}\n",NULL);CHKERRQ(ierr);
60211525c0dSBarry Smith   }
60311525c0dSBarry Smith   PetscFunctionReturn(0);
60411525c0dSBarry Smith }
60511525c0dSBarry Smith #endif
60611525c0dSBarry Smith 
607e5c89e4eSSatish Balay /*@C
608e5c89e4eSSatish Balay    PetscInitialize - Initializes the PETSc database and MPI.
609e5c89e4eSSatish Balay    PetscInitialize() calls MPI_Init() if that has yet to be called,
610e5c89e4eSSatish Balay    so this routine should always be called near the beginning of
611e5c89e4eSSatish Balay    your program -- usually the very first line!
612e5c89e4eSSatish Balay 
613e5c89e4eSSatish Balay    Collective on MPI_COMM_WORLD or PETSC_COMM_WORLD if it has been set
614e5c89e4eSSatish Balay 
615e5c89e4eSSatish Balay    Input Parameters:
616e5c89e4eSSatish Balay +  argc - count of number of command line arguments
617e5c89e4eSSatish Balay .  args - the command line arguments
6180298fd71SBarry Smith .  file - [optional] PETSc database file, also checks ~username/.petscrc and .petscrc use NULL to not check for
619fc2bca9aSBarry Smith           code specific file. Use -skip_petscrc in the code specific file to skip the .petscrc files
6200298fd71SBarry Smith -  help - [optional] Help message to print, use NULL for no message
621e5c89e4eSSatish Balay 
62205827820SBarry Smith    If you wish PETSc code to run ONLY on a subcommunicator of MPI_COMM_WORLD, create that
62305827820SBarry Smith    communicator first and assign it to PETSC_COMM_WORLD BEFORE calling PetscInitialize(). Thus if you are running a
62405827820SBarry Smith    four process job and two processes will run PETSc and have PetscInitialize() and PetscFinalize() and two process will not,
62505827820SBarry Smith    then do this. If ALL processes in the job are using PetscInitialize() and PetscFinalize() then you don't need to do this, even
62605827820SBarry Smith    if different subcommunicators of the job are doing different things with PETSc.
627e5c89e4eSSatish Balay 
628e5c89e4eSSatish Balay    Options Database Keys:
6297ca660e7SBarry Smith +  -help [intro] - prints help method for each option; if intro is given the program stops after printing the introductory help message
6307ca660e7SBarry Smith .  -start_in_debugger [noxterm,dbx,xdb,gdb,...] - Starts program in debugger
631e5c89e4eSSatish Balay .  -on_error_attach_debugger [noxterm,dbx,xdb,gdb,...] - Starts debugger when error detected
632e5c89e4eSSatish Balay .  -on_error_emacs <machinename> causes emacsclient to jump to error file
633b52f573bSBarry Smith .  -on_error_abort calls abort() when error detected (no traceback)
634e8fb0fc0SBarry Smith .  -on_error_mpiabort calls MPI_abort() when error detected
635e8fb0fc0SBarry Smith .  -error_output_stderr prints error messages to stderr instead of the default stdout
636e8fb0fc0SBarry Smith .  -error_output_none does not print the error messages (but handles errors in the same way as if this was not called)
637e5c89e4eSSatish Balay .  -debugger_nodes [node1,node2,...] - Indicates nodes to start in debugger
638e5c89e4eSSatish Balay .  -debugger_pause [sleeptime] (in seconds) - Pauses debugger
639e5c89e4eSSatish Balay .  -stop_for_debugger - Print message on how to attach debugger manually to
640e5c89e4eSSatish Balay                         process and wait (-debugger_pause) seconds for attachment
6412fb0ec9aSBarry Smith .  -malloc - Indicates use of PETSc error-checking malloc (on by default for debug version of libraries)
642e5c89e4eSSatish Balay .  -malloc no - Indicates not to use error-checking malloc
6432fb0ec9aSBarry Smith .  -malloc_debug - check for memory corruption at EVERY malloc or free
644aee23540SBarry Smith .  -malloc_dump - prints a list of all unfreed memory at the end of the run
645dc92acbaSJed Brown .  -malloc_test - like -malloc_dump -malloc_debug, but only active for debugging builds
646e5c89e4eSSatish Balay .  -fp_trap - Stops on floating point exceptions (Note that on the
647e5c89e4eSSatish Balay               IBM RS6000 this slows code by at least a factor of 10.)
648e5c89e4eSSatish Balay .  -no_signal_handler - Indicates not to trap error signals
649e5c89e4eSSatish Balay .  -shared_tmp - indicates /tmp directory is shared by all processors
650e5c89e4eSSatish Balay .  -not_shared_tmp - each processor has own /tmp
651e5c89e4eSSatish Balay .  -tmp - alternative name of /tmp directory
652e5c89e4eSSatish Balay .  -get_total_flops - returns total flops done by all processors
6530841954dSBarry Smith -  -memory_view - Print memory usage at end of run
654e5c89e4eSSatish Balay 
655e5c89e4eSSatish Balay    Options Database Keys for Profiling:
656a7f22e61SSatish Balay    See Users-Manual: ch_profiling for details.
657495fc317SBarry Smith +  -info <optional filename> - Prints verbose information to the screen
658495fc317SBarry Smith .  -info_exclude <null,vec,mat,pc,ksp,snes,ts> - Excludes some of the verbose messages
659495fc317SBarry Smith .  -log_sync - Log the synchronization in scatters, inner products and norms
660495fc317SBarry Smith .  -log_trace [filename] - Print traces of all PETSc calls to the screen (useful to determine where a program
661e5c89e4eSSatish Balay         hangs without running in the debugger).  See PetscLogTraceBegin().
6629a9a5d4cSBarry Smith .  -log_view [:filename:format] - Prints summary of flop and timing information to screen or file, see PetscLogView().
6639a9a5d4cSBarry Smith .  -log_summary [filename] - (Deprecated, use -log_view) Prints summary of flop and timing information to screen. If the filename is specified the
664495fc317SBarry Smith         summary is written to the file.  See PetscLogView().
6659a9a5d4cSBarry Smith .  -log_exclude: <vec,mat,pc.ksp,snes> - excludes subset of object classes from logging
666495fc317SBarry Smith .  -log_all [filename] - Logs extensive profiling information  See PetscLogDump().
667495fc317SBarry Smith .  -log [filename] - Logs basic profiline information  See PetscLogDump().
668c2f74817SBarry Smith .  -log_mpe [filename] - Creates a logfile viewable by the utility Jumpshot (in MPICH distribution)
669c2f74817SBarry Smith -  -check_pointer_intensity 0,1,2 - if pointers are checked for validity (debug version only), using 0 will result in faster code
670495fc317SBarry Smith 
671609bdbeeSBarry Smith     Only one of -log_trace, -log_view, -log_view, -log_all, -log, or -log_mpe may be used at a time
672e5c89e4eSSatish Balay 
673ffbd1cfbSBarry Smith    Options Database Keys for SAWs:
674ffbd1cfbSBarry Smith +  -saws_port <portnumber> - port number to publish SAWs data, default is 8080
675ffbd1cfbSBarry 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
676ffbd1cfbSBarry Smith                             this is useful when you are running many jobs that utilize SAWs at the same time
677ffbd1cfbSBarry Smith .  -saws_log <filename> - save a log of all SAWs communication
678ffbd1cfbSBarry Smith .  -saws_https <certificate file> - have SAWs use HTTPS instead of HTTP
679ffbd1cfbSBarry Smith -  -saws_root <directory> - allow SAWs to have access to the given directory to search for requested resources and files
680ffbd1cfbSBarry Smith 
681e5c89e4eSSatish Balay    Environmental Variables:
682e5c89e4eSSatish Balay +   PETSC_TMP - alternative tmp directory
683e5c89e4eSSatish Balay .   PETSC_SHARED_TMP - tmp is shared by all processes
684e5c89e4eSSatish Balay .   PETSC_NOT_SHARED_TMP - each process has its own private tmp
685e5c89e4eSSatish Balay .   PETSC_VIEWER_SOCKET_PORT - socket number to use for socket viewer
686e5c89e4eSSatish Balay -   PETSC_VIEWER_SOCKET_MACHINE - machine to use for socket viewer to connect to
687e5c89e4eSSatish Balay 
688e5c89e4eSSatish Balay 
689e5c89e4eSSatish Balay    Level: beginner
690e5c89e4eSSatish Balay 
691e5c89e4eSSatish Balay    Notes:
692e5c89e4eSSatish Balay    If for some reason you must call MPI_Init() separately, call
693e5c89e4eSSatish Balay    it before PetscInitialize().
694e5c89e4eSSatish Balay 
695e5c89e4eSSatish Balay    Fortran Version:
696e5c89e4eSSatish Balay    In Fortran this routine has the format
697e5c89e4eSSatish Balay $       call PetscInitialize(file,ierr)
698e5c89e4eSSatish Balay 
699e5c89e4eSSatish Balay +   ierr - error return code
7000eb4c9c0SBarry Smith -  file - [optional] PETSc database file, also checks ~username/.petscrc and .petscrc use PETSC_NULL_CHARACTER to not check for
701fc2bca9aSBarry Smith           code specific file. Use -skip_petscrc in the code specific file to skip the .petscrc files
702e5c89e4eSSatish Balay 
703e5c89e4eSSatish Balay    Important Fortran Note:
7040eb4c9c0SBarry Smith    In Fortran, you MUST use PETSC_NULL_CHARACTER to indicate a
7050298fd71SBarry Smith    null character string; you CANNOT just use NULL as
706a7f22e61SSatish Balay    in the C version. See Users-Manual: ch_fortran for details.
707e5c89e4eSSatish Balay 
70801cb0274SBarry Smith    If your main program is C but you call Fortran code that also uses PETSc you need to call PetscInitializeFortran() soon after
70901cb0274SBarry Smith    calling PetscInitialize().
710e5c89e4eSSatish Balay 
711e5c89e4eSSatish Balay    Concepts: initializing PETSc
712e5c89e4eSSatish Balay 
71301cb0274SBarry Smith .seealso: PetscFinalize(), PetscInitializeFortran(), PetscGetArgs(), PetscInitializeNoArguments()
714e5c89e4eSSatish Balay 
715e5c89e4eSSatish Balay @*/
7167087cfbeSBarry Smith PetscErrorCode  PetscInitialize(int *argc,char ***args,const char file[],const char help[])
717e5c89e4eSSatish Balay {
718e5c89e4eSSatish Balay   PetscErrorCode ierr;
7194bb5149bSJed Brown   PetscMPIInt    flag, size;
72019c5658aSBarry Smith   PetscBool      flg = PETSC_TRUE;
721e5c89e4eSSatish Balay   char           hostname[256];
7225e71baefSBarry Smith #if defined(PETSC_HAVE_HWLOC)
7235e71baefSBarry Smith   PetscViewer    viewer;
7245e71baefSBarry Smith #endif
725e5c89e4eSSatish Balay 
726e5c89e4eSSatish Balay   PetscFunctionBegin;
727e5c89e4eSSatish Balay   if (PetscInitializeCalled) PetscFunctionReturn(0);
7283d96e996SBarry Smith   /*
7293d96e996SBarry Smith       The checking over compatible runtime libraries is complicated by the MPI ABI initiative
7303d96e996SBarry Smith       https://wiki.mpich.org/mpich/index.php/ABI_Compatibility_Initiative which started with
7313d96e996SBarry Smith         MPICH v3.1 (Released Feburary 2014)
7323d96e996SBarry Smith         IBM MPI v2.1 (December 2014)
7333d96e996SBarry Smith         Intel® MPI Library v5.0 (2014)
7343d96e996SBarry Smith         Cray MPT v7.0.0 (June 2014)
7353d96e996SBarry Smith       As of July 31, 2017 the ABI number still appears to be 12, that is all of the versions
7363d96e996SBarry Smith       listed above and since that time are compatible.
7373d96e996SBarry Smith 
7383d96e996SBarry Smith       Unfortunately the MPI ABI initiative has not defined a way to determine the ABI number
7393d96e996SBarry Smith       at compile time or runtime. Thus we will need to systematically track the allowed versions
7403d96e996SBarry Smith       and how they are represented in the mpi.h and MPI_Get_library_version() output in order
7413d96e996SBarry Smith       to perform the checking.
7423d96e996SBarry Smith 
7433d96e996SBarry Smith       Currently we only check for pre MPI ABI versions (and packages that do not follow the MPI ABI).
7443d96e996SBarry Smith 
7453d96e996SBarry Smith       Questions:
7463d96e996SBarry Smith 
7473d96e996SBarry Smith         Should the checks for ABI incompatibility be only on the major version number below?
7483d96e996SBarry Smith         Presumably the output to stderr will be removed before a release.
7493d96e996SBarry Smith   */
7503d96e996SBarry Smith 
75119c5658aSBarry Smith #if defined(PETSC_HAVE_MPI_GET_LIBRARY_VERSION)
75219c5658aSBarry Smith   {
75319c5658aSBarry Smith     char        mpilibraryversion[MPI_MAX_LIBRARY_VERSION_STRING];
75419c5658aSBarry Smith     PetscMPIInt mpilibraryversionlength;
75519c5658aSBarry Smith     ierr = MPI_Get_library_version(mpilibraryversion,&mpilibraryversionlength);if (ierr) return ierr;
7563d96e996SBarry Smith     /* check for MPICH versions before MPI ABI initiative */
75719c5658aSBarry Smith #if defined(MPICH_VERSION)
7583d96e996SBarry Smith #if MPICH_NUMVERSION < 30100000
75919c5658aSBarry Smith     {
76019c5658aSBarry Smith       char *ver,*lf;
76119c5658aSBarry Smith       flg = PETSC_FALSE;
76219c5658aSBarry Smith       ierr = PetscStrstr(mpilibraryversion,"MPICH Version:",&ver);if (ierr) return ierr;
76319c5658aSBarry Smith       if (ver) {
76419c5658aSBarry Smith         ierr = PetscStrchr(ver,'\n',&lf);if (ierr) return ierr;
76519c5658aSBarry Smith         if (lf) {
76619c5658aSBarry Smith           *lf = 0;
76719c5658aSBarry Smith           ierr = PetscStrendswith(ver,MPICH_VERSION,&flg);if (ierr) return ierr;
76819c5658aSBarry Smith         }
76919c5658aSBarry Smith       }
77019c5658aSBarry Smith       if (!flg) {
77119c5658aSBarry Smith         fprintf(stderr,"PETSc Error --- MPICH library version \n%s does not match what PETSc was compiled with %s, aborting\n",mpilibraryversion,MPICH_VERSION);
7723d96e996SBarry Smith         return PETSC_ERR_MPI_LIB_INCOMP;
77319c5658aSBarry Smith       }
77419c5658aSBarry Smith     }
7753d96e996SBarry Smith #endif
7763d96e996SBarry 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?) */
77719c5658aSBarry Smith #elif defined(OMPI_MAJOR_VERSION)
77819c5658aSBarry Smith     {
77919c5658aSBarry Smith       char *ver,bs[32],*bsf;
78019c5658aSBarry Smith       flg = PETSC_FALSE;
78119c5658aSBarry Smith       ierr = PetscStrstr(mpilibraryversion,"Open MPI",&ver);if (ierr) return ierr;
78219c5658aSBarry Smith       if (ver) {
7832e924ca5SSatish Balay         PetscSNPrintf(bs,32,"v%d.%d",OMPI_MAJOR_VERSION,OMPI_MINOR_VERSION);
78419c5658aSBarry Smith         ierr = PetscStrstr(ver,bs,&bsf);if (ierr) return ierr;
78519c5658aSBarry Smith         if (bsf) flg = PETSC_TRUE;
78619c5658aSBarry Smith       }
78719c5658aSBarry Smith       if (!flg) {
78819c5658aSBarry 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);
7893d96e996SBarry Smith         return PETSC_ERR_MPI_LIB_INCOMP;
79019c5658aSBarry Smith       }
79119c5658aSBarry Smith     }
79219c5658aSBarry Smith #endif
79319c5658aSBarry Smith   }
79419c5658aSBarry Smith #endif
79519c5658aSBarry Smith 
796e5c89e4eSSatish Balay 
797ae9b4142SLisandro Dalcin   /* these must be initialized in a routine, not as a constant declaration*/
798d89683f4Sbcordonn   PETSC_STDOUT = stdout;
799ae9b4142SLisandro Dalcin   PETSC_STDERR = stderr;
800e5c89e4eSSatish Balay 
8010c30907bSSatish Balay   /* on Windows - set printf to default to printing 2 digit exponents */
8020c30907bSSatish Balay #if defined(PETSC_HAVE__SET_OUTPUT_FORMAT)
8030c30907bSSatish Balay   _set_output_format(_TWO_DIGIT_EXPONENT);
8040c30907bSSatish Balay #endif
8050c30907bSSatish Balay 
8064416b707SBarry Smith   ierr = PetscOptionsCreateDefault();CHKERRQ(ierr);
807e5c89e4eSSatish Balay 
808e5c89e4eSSatish Balay   /*
809e5c89e4eSSatish Balay      We initialize the program name here (before MPI_Init()) because MPICH has a bug in
810e5c89e4eSSatish Balay      it that it sets args[0] on all processors to be args[0] on the first processor.
811e5c89e4eSSatish Balay   */
812e5c89e4eSSatish Balay   if (argc && *argc) {
813e5c89e4eSSatish Balay     ierr = PetscSetProgramName(**args);CHKERRQ(ierr);
814e5c89e4eSSatish Balay   } else {
815e5c89e4eSSatish Balay     ierr = PetscSetProgramName("Unknown Name");CHKERRQ(ierr);
816e5c89e4eSSatish Balay   }
817e5c89e4eSSatish Balay 
818e5c89e4eSSatish Balay   ierr = MPI_Initialized(&flag);CHKERRQ(ierr);
819e5c89e4eSSatish Balay   if (!flag) {
820e32f2f54SBarry 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");
8215e765c61SJed Brown #if defined(PETSC_HAVE_MPI_INIT_THREAD)
8225e765c61SJed Brown     {
8235e765c61SJed Brown       PetscMPIInt provided;
8245e765c61SJed Brown       ierr = MPI_Init_thread(argc,args,MPI_THREAD_FUNNELED,&provided);CHKERRQ(ierr);
8255e765c61SJed Brown     }
8265e765c61SJed Brown #else
827e5c89e4eSSatish Balay     ierr = MPI_Init(argc,args);CHKERRQ(ierr);
8285e765c61SJed Brown #endif
829e5c89e4eSSatish Balay     PetscBeganMPI = PETSC_TRUE;
830e5c89e4eSSatish Balay   }
831e5c89e4eSSatish Balay   if (argc && args) {
832e5c89e4eSSatish Balay     PetscGlobalArgc = *argc;
833e5c89e4eSSatish Balay     PetscGlobalArgs = *args;
834e5c89e4eSSatish Balay   }
835e5c89e4eSSatish Balay   PetscFinalizeCalled = PETSC_FALSE;
8365ad9ad5bSBarry Smith   ierr = PetscSpinlockCreate(&PetscViewerASCIISpinLockOpen);CHKERRQ(ierr);
8375ad9ad5bSBarry Smith   ierr = PetscSpinlockCreate(&PetscViewerASCIISpinLockStdout);CHKERRQ(ierr);
8385ad9ad5bSBarry Smith   ierr = PetscSpinlockCreate(&PetscViewerASCIISpinLockStderr);CHKERRQ(ierr);
839ef19f930SBarry Smith   ierr = PetscSpinlockCreate(&PetscCommSpinLock);CHKERRQ(ierr);
840e5c89e4eSSatish Balay 
841a297a907SKarl Rupp   if (PETSC_COMM_WORLD == MPI_COMM_NULL) PETSC_COMM_WORLD = MPI_COMM_WORLD;
842d54338ecSKarl Rupp   ierr = MPI_Comm_set_errhandler(PETSC_COMM_WORLD,MPI_ERRORS_RETURN);CHKERRQ(ierr);
843e5c89e4eSSatish Balay 
84412801b39SBarry Smith   ierr = MPI_Add_error_class(&PETSC_MPI_ERROR_CLASS);CHKERRQ(ierr);
84512801b39SBarry Smith   ierr = MPI_Add_error_code(PETSC_MPI_ERROR_CLASS,&PETSC_MPI_ERROR_CODE);CHKERRQ(ierr);
84612801b39SBarry Smith 
847e5c89e4eSSatish Balay   /* Done after init due to a bug in MPICH-GM? */
848e5c89e4eSSatish Balay   ierr = PetscErrorPrintfInitialize();CHKERRQ(ierr);
849e5c89e4eSSatish Balay 
850e5c89e4eSSatish Balay   ierr = MPI_Comm_rank(MPI_COMM_WORLD,&PetscGlobalRank);CHKERRQ(ierr);
851e5c89e4eSSatish Balay   ierr = MPI_Comm_size(MPI_COMM_WORLD,&PetscGlobalSize);CHKERRQ(ierr);
852e5c89e4eSSatish Balay 
8538ad47952SJed Brown   MPIU_BOOL = MPI_INT;
8548ad47952SJed Brown   MPIU_ENUM = MPI_INT;
8558ad47952SJed Brown 
856e5c89e4eSSatish Balay   /*
857e5c89e4eSSatish Balay      Initialized the global complex variable; this is because with
858e5c89e4eSSatish Balay      shared libraries the constructors for global variables
859e5c89e4eSSatish Balay      are not called; at least on IRIX.
860e5c89e4eSSatish Balay   */
861886cfec0SSatish Balay #if defined(PETSC_HAVE_COMPLEX)
862e5c89e4eSSatish Balay   {
863252ecd31SSatish Balay #if defined(PETSC_CLANGUAGE_CXX) && !defined(PETSC_USE_REAL___FLOAT128)
86450f81f78SJed Brown     PetscComplex ic(0.0,1.0);
865e5c89e4eSSatish Balay     PETSC_i = ic;
866252ecd31SSatish Balay #else
86750f81f78SJed Brown     PETSC_i = _Complex_I;
868b7940d39SSatish Balay #endif
869762437b8SSatish Balay   }
870762437b8SSatish Balay 
8712c876bd9SBarry Smith #if !defined(PETSC_HAVE_MPI_C_DOUBLE_COMPLEX)
872e69cd0e6SSatish Balay   ierr = MPI_Type_contiguous(2,MPI_DOUBLE,&MPIU_C_DOUBLE_COMPLEX);CHKERRQ(ierr);
873500d8756SSatish Balay   ierr = MPI_Type_commit(&MPIU_C_DOUBLE_COMPLEX);CHKERRQ(ierr);
874500d8756SSatish Balay   ierr = MPI_Type_contiguous(2,MPI_FLOAT,&MPIU_C_COMPLEX);CHKERRQ(ierr);
875500d8756SSatish Balay   ierr = MPI_Type_commit(&MPIU_C_COMPLEX);CHKERRQ(ierr);
8762c876bd9SBarry Smith #endif
877886cfec0SSatish Balay #endif /* PETSC_HAVE_COMPLEX */
878e5c89e4eSSatish Balay 
879e5c89e4eSSatish Balay   /*
880e5c89e4eSSatish Balay      Create the PETSc MPI reduction operator that sums of the first
881e5c89e4eSSatish Balay      half of the entries and maxes the second half.
882e5c89e4eSSatish Balay   */
883367daffbSBarry Smith   ierr = MPI_Op_create(MPIU_MaxSum_Local,1,&MPIU_MAXSUM_OP);CHKERRQ(ierr);
884e5c89e4eSSatish Balay 
885ce63c4c1SBarry Smith #if defined(PETSC_USE_REAL___FLOAT128)
886c90a1750SBarry Smith   ierr = MPI_Type_contiguous(2,MPI_DOUBLE,&MPIU___FLOAT128);CHKERRQ(ierr);
887c90a1750SBarry Smith   ierr = MPI_Type_commit(&MPIU___FLOAT128);CHKERRQ(ierr);
8887c2de775SJed Brown #if defined(PETSC_HAVE_COMPLEX)
8898c764dc5SJose Roman   ierr = MPI_Type_contiguous(4,MPI_DOUBLE,&MPIU___COMPLEX128);CHKERRQ(ierr);
8908c764dc5SJose Roman   ierr = MPI_Type_commit(&MPIU___COMPLEX128);CHKERRQ(ierr);
8918c764dc5SJose Roman #endif
892d9822059SBarry Smith   ierr = MPI_Op_create(PetscMax_Local,1,&MPIU_MAX);CHKERRQ(ierr);
893d9822059SBarry Smith   ierr = MPI_Op_create(PetscMin_Local,1,&MPIU_MIN);CHKERRQ(ierr);
894570b7f6dSBarry Smith #elif defined(PETSC_USE_REAL___FP16)
895570b7f6dSBarry Smith   ierr = MPI_Type_contiguous(2,MPI_CHAR,&MPIU___FP16);CHKERRQ(ierr);
896570b7f6dSBarry Smith   ierr = MPI_Type_commit(&MPIU___FP16);CHKERRQ(ierr);
897570b7f6dSBarry Smith   ierr = MPI_Op_create(PetscMax_Local,1,&MPIU_MAX);CHKERRQ(ierr);
898570b7f6dSBarry Smith   ierr = MPI_Op_create(PetscMin_Local,1,&MPIU_MIN);CHKERRQ(ierr);
899c90a1750SBarry Smith #endif
900c90a1750SBarry Smith 
901570b7f6dSBarry Smith #if (defined(PETSC_HAVE_COMPLEX) && !defined(PETSC_HAVE_MPI_C_DOUBLE_COMPLEX)) || defined(PETSC_USE_REAL___FLOAT128) || defined(PETSC_USE_REAL___FP16)
902cca4cb22SSatish Balay   ierr = MPI_Op_create(PetscSum_Local,1,&MPIU_SUM);CHKERRQ(ierr);
903cca4cb22SSatish Balay #endif
904cca4cb22SSatish Balay 
905e5c89e4eSSatish Balay   ierr = MPI_Type_contiguous(2,MPIU_SCALAR,&MPIU_2SCALAR);CHKERRQ(ierr);
906e5c89e4eSSatish Balay   ierr = MPI_Type_commit(&MPIU_2SCALAR);CHKERRQ(ierr);
907e5c89e4eSSatish Balay 
90844041f26SJed Brown #if defined(PETSC_USE_64BIT_INDICES) || !defined(MPI_2INT)
909e5c89e4eSSatish Balay   ierr = MPI_Type_contiguous(2,MPIU_INT,&MPIU_2INT);CHKERRQ(ierr);
910e5c89e4eSSatish Balay   ierr = MPI_Type_commit(&MPIU_2INT);CHKERRQ(ierr);
91144041f26SJed Brown #endif
912e5c89e4eSSatish Balay 
913ec957eceSBarry Smith 
914e5c89e4eSSatish Balay   /*
915480cf27aSJed Brown      Attributes to be set on PETSc communicators
916480cf27aSJed Brown   */
91712801b39SBarry Smith   ierr = MPI_Comm_create_keyval(MPI_COMM_NULL_COPY_FN,Petsc_DelCounter,&Petsc_Counter_keyval,(void*)0);CHKERRQ(ierr);
91812801b39SBarry Smith   ierr = MPI_Comm_create_keyval(MPI_COMM_NULL_COPY_FN,Petsc_DelComm_Outer,&Petsc_InnerComm_keyval,(void*)0);CHKERRQ(ierr);
91912801b39SBarry Smith   ierr = MPI_Comm_create_keyval(MPI_COMM_NULL_COPY_FN,Petsc_DelComm_Inner,&Petsc_OuterComm_keyval,(void*)0);CHKERRQ(ierr);
92012801b39SBarry Smith   ierr = MPI_Comm_create_keyval(MPI_COMM_NULL_COPY_FN,Petsc_DelShared,&Petsc_Shared_keyval,(void*)0);CHKERRQ(ierr);
921480cf27aSJed Brown 
922480cf27aSJed Brown   /*
923e8fb0fc0SBarry Smith      Build the options database
924e5c89e4eSSatish Balay   */
925c5929fdfSBarry Smith   ierr = PetscOptionsInsert(NULL,argc,args,file);CHKERRQ(ierr);
926e5c89e4eSSatish Balay 
927703f3eceSBarry Smith   /* call a second time so it can look in the options database */
928703f3eceSBarry Smith   ierr = PetscErrorPrintfInitialize();CHKERRQ(ierr);
9296dc8fec2Sbcordonn 
930e5c89e4eSSatish Balay   /*
931e5c89e4eSSatish Balay      Print main application help message
932e5c89e4eSSatish Balay   */
933c5929fdfSBarry Smith   ierr = PetscOptionsHasName(NULL,NULL,"-help",&flg);CHKERRQ(ierr);
934e5c89e4eSSatish Balay   if (help && flg) {
935e5c89e4eSSatish Balay     ierr = PetscPrintf(PETSC_COMM_WORLD,help);CHKERRQ(ierr);
936e5c89e4eSSatish Balay   }
937e5c89e4eSSatish Balay   ierr = PetscOptionsCheckInitial_Private();CHKERRQ(ierr);
938e5c89e4eSSatish Balay 
939d45a07a7SBarry Smith   ierr = PetscCitationsInitialize();CHKERRQ(ierr);
940d45a07a7SBarry Smith 
941e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS)
94211525c0dSBarry Smith   ierr = PetscInitializeSAWs(help);CHKERRQ(ierr);
943f4202a44SBarry Smith #endif
944f4202a44SBarry Smith 
945896238b9SBarry Smith   /* Creates the logging data structures; this is enabled even if logging is not turned on */
946a9f03627SSatish Balay #if defined(PETSC_USE_LOG)
947896238b9SBarry Smith   ierr = PetscLogInitialize();CHKERRQ(ierr);
948a9f03627SSatish Balay #endif
949e5c89e4eSSatish Balay 
950e5c89e4eSSatish Balay   /*
951e5c89e4eSSatish Balay      Load the dynamic libraries (on machines that support them), this registers all
952e5c89e4eSSatish Balay      the solvers etc. (On non-dynamic machines this initializes the PetscDraw and PetscViewer classes)
953e5c89e4eSSatish Balay   */
954e5c89e4eSSatish Balay   ierr = PetscInitialize_DynamicLibraries();CHKERRQ(ierr);
955e5c89e4eSSatish Balay 
956e5c89e4eSSatish Balay   ierr = MPI_Comm_size(PETSC_COMM_WORLD,&size);CHKERRQ(ierr);
957ae15b995SBarry Smith   ierr = PetscInfo1(0,"PETSc successfully started: number of processors = %d\n",size);CHKERRQ(ierr);
958e5c89e4eSSatish Balay   ierr = PetscGetHostName(hostname,256);CHKERRQ(ierr);
959ae15b995SBarry Smith   ierr = PetscInfo1(0,"Running on machine: %s\n",hostname);CHKERRQ(ierr);
960e5c89e4eSSatish Balay 
961e5c89e4eSSatish Balay   ierr = PetscOptionsCheckInitial_Components();CHKERRQ(ierr);
962ef6c6fedSBoyana Norris   /* Check the options database for options related to the options database itself */
963c5929fdfSBarry Smith   ierr = PetscOptionsSetFromOptions(NULL);CHKERRQ(ierr);
964ef6c6fedSBoyana Norris 
965951e3c8eSBarry Smith #if defined(PETSC_USE_PETSC_MPI_EXTERNAL32)
966e39fd77fSBarry Smith   /*
967e39fd77fSBarry Smith       Tell MPI about our own data representation converter, this would/should be used if extern32 is not supported by the MPI
968e39fd77fSBarry Smith 
969e39fd77fSBarry Smith       Currently not used because it is not supported by MPICH.
970e39fd77fSBarry Smith   */
971e39fd77fSBarry Smith #if !defined(PETSC_WORDS_BIGENDIAN)
9720298fd71SBarry Smith   ierr = MPI_Register_datarep((char*)"petsc",PetscDataRep_read_conv_fn,PetscDataRep_write_conv_fn,PetscDataRep_extent_fn,NULL);CHKERRQ(ierr);
973e39fd77fSBarry Smith #endif
974951e3c8eSBarry Smith #endif
975e39fd77fSBarry Smith 
976c5929fdfSBarry Smith   ierr = PetscOptionsHasName(NULL,NULL,"-python",&flg);CHKERRQ(ierr);
9779ac80d5eSLisandro Dalcin   if (flg) {
9789ac80d5eSLisandro Dalcin     PetscInitializeCalled = PETSC_TRUE;
9790298fd71SBarry Smith     ierr = PetscPythonInitialize(NULL,NULL);CHKERRQ(ierr);
9809ac80d5eSLisandro Dalcin   }
9819ac80d5eSLisandro Dalcin 
98241c0b4b3SShri Abhyankar   /*
98341c0b4b3SShri Abhyankar       Setup building of stack frames for all function calls
98441c0b4b3SShri Abhyankar   */
985ef19f930SBarry Smith #if defined(PETSC_USE_DEBUG) && !defined(PETSC_HAVE_THREADSAFETY)
986e1167bb9SShri Abhyankar   ierr = PetscStackCreate();CHKERRQ(ierr);
987e1167bb9SShri Abhyankar #endif
988e1167bb9SShri Abhyankar 
9892d53ad75SBarry Smith #if defined(PETSC_SERIALIZE_FUNCTIONS)
9902d53ad75SBarry Smith   ierr = PetscFPTCreate(10000);CHKERRQ(ierr);
9912d53ad75SBarry Smith #endif
9922d53ad75SBarry Smith 
9935e71baefSBarry Smith #if defined(PETSC_HAVE_HWLOC)
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);
9975e71baefSBarry Smith   }
9985e71baefSBarry Smith #endif
999dff31646SBarry Smith 
1000301d30feSBarry Smith   /*
1001301d30feSBarry Smith       Once we are completedly initialized then we can set this variables
1002301d30feSBarry Smith   */
1003301d30feSBarry Smith   PetscInitializeCalled = PETSC_TRUE;
1004301d30feSBarry Smith   PetscFunctionReturn(0);
1005e5c89e4eSSatish Balay }
1006e5c89e4eSSatish Balay 
10074097062eSBarry Smith #if defined(PETSC_USE_LOG)
10082eff7a51SBarry Smith extern PetscObject *PetscObjects;
10092eff7a51SBarry Smith extern PetscInt    PetscObjectsCounts, PetscObjectsMaxCounts;
101005df10baSBarry Smith extern PetscBool   PetscObjectsLog;
10114097062eSBarry Smith #endif
1012e5c89e4eSSatish Balay 
1013008a6e76SBarry Smith /*
1014008a6e76SBarry Smith     Frees all the MPI types and operations that PETSc may have created
1015008a6e76SBarry Smith */
1016008a6e76SBarry Smith PetscErrorCode  PetscFreeMPIResources(void)
1017008a6e76SBarry Smith {
1018008a6e76SBarry Smith   PetscErrorCode ierr;
1019008a6e76SBarry Smith 
1020008a6e76SBarry Smith   PetscFunctionBegin;
1021008a6e76SBarry Smith #if defined(PETSC_USE_REAL___FLOAT128)
1022008a6e76SBarry Smith   ierr = MPI_Type_free(&MPIU___FLOAT128);CHKERRQ(ierr);
1023008a6e76SBarry Smith #if defined(PETSC_HAVE_COMPLEX)
1024008a6e76SBarry Smith   ierr = MPI_Type_free(&MPIU___COMPLEX128);CHKERRQ(ierr);
1025008a6e76SBarry Smith #endif
1026008a6e76SBarry Smith   ierr = MPI_Op_free(&MPIU_MAX);CHKERRQ(ierr);
1027008a6e76SBarry Smith   ierr = MPI_Op_free(&MPIU_MIN);CHKERRQ(ierr);
1028008a6e76SBarry Smith #elif defined(PETSC_USE_REAL___FP16)
1029008a6e76SBarry Smith   ierr = MPI_Type_free(&MPIU___FP16);CHKERRQ(ierr);
1030008a6e76SBarry Smith   ierr = MPI_Op_free(&MPIU_MAX);CHKERRQ(ierr);
1031008a6e76SBarry Smith   ierr = MPI_Op_free(&MPIU_MIN);CHKERRQ(ierr);
1032008a6e76SBarry Smith #endif
1033008a6e76SBarry Smith 
1034008a6e76SBarry Smith #if defined(PETSC_HAVE_COMPLEX)
1035008a6e76SBarry Smith #if !defined(PETSC_HAVE_MPI_C_DOUBLE_COMPLEX)
1036008a6e76SBarry Smith   ierr = MPI_Type_free(&MPIU_C_DOUBLE_COMPLEX);CHKERRQ(ierr);
1037008a6e76SBarry Smith   ierr = MPI_Type_free(&MPIU_C_COMPLEX);CHKERRQ(ierr);
1038008a6e76SBarry Smith #endif
1039008a6e76SBarry Smith #endif
1040008a6e76SBarry Smith 
1041008a6e76SBarry Smith #if (defined(PETSC_HAVE_COMPLEX) && !defined(PETSC_HAVE_MPI_C_DOUBLE_COMPLEX)) || defined(PETSC_USE_REAL___FLOAT128) || defined(PETSC_USE_REAL___FP16)
1042008a6e76SBarry Smith   ierr = MPI_Op_free(&MPIU_SUM);CHKERRQ(ierr);
1043008a6e76SBarry Smith #endif
1044008a6e76SBarry Smith 
1045008a6e76SBarry Smith   ierr = MPI_Type_free(&MPIU_2SCALAR);CHKERRQ(ierr);
1046008a6e76SBarry Smith #if defined(PETSC_USE_64BIT_INDICES) || !defined(MPI_2INT)
1047008a6e76SBarry Smith   ierr = MPI_Type_free(&MPIU_2INT);CHKERRQ(ierr);
1048008a6e76SBarry Smith #endif
1049008a6e76SBarry Smith   ierr = MPI_Op_free(&MPIU_MAXSUM_OP);CHKERRQ(ierr);
1050008a6e76SBarry Smith   PetscFunctionReturn(0);
1051008a6e76SBarry Smith }
1052008a6e76SBarry Smith 
1053e5c89e4eSSatish Balay /*@C
1054e5c89e4eSSatish Balay    PetscFinalize - Checks for options to be called at the conclusion
1055e5c89e4eSSatish Balay    of the program. MPI_Finalize() is called only if the user had not
1056e5c89e4eSSatish Balay    called MPI_Init() before calling PetscInitialize().
1057e5c89e4eSSatish Balay 
1058e5c89e4eSSatish Balay    Collective on PETSC_COMM_WORLD
1059e5c89e4eSSatish Balay 
1060e5c89e4eSSatish Balay    Options Database Keys:
1061*26a7e8d4SBarry Smith +  -options_view - Calls PetscOptionsView()
1062e5c89e4eSSatish Balay .  -options_left - Prints unused options that remain in the database
10637eb1d149SBarry 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
1064e5c89e4eSSatish Balay .  -mpidump - Calls PetscMPIDump()
1065e5c89e4eSSatish Balay .  -malloc_dump - Calls PetscMallocDump()
1066e5c89e4eSSatish Balay .  -malloc_info - Prints total memory usage
1067e5c89e4eSSatish Balay -  -malloc_log - Prints summary of memory usage
1068e5c89e4eSSatish Balay 
1069e5c89e4eSSatish Balay    Level: beginner
1070e5c89e4eSSatish Balay 
1071e5c89e4eSSatish Balay    Note:
1072e5c89e4eSSatish Balay    See PetscInitialize() for more general runtime options.
1073e5c89e4eSSatish Balay 
107488c29154SBarry Smith .seealso: PetscInitialize(), PetscOptionsView(), PetscMallocDump(), PetscMPIDump(), PetscEnd()
1075e5c89e4eSSatish Balay @*/
10767087cfbeSBarry Smith PetscErrorCode  PetscFinalize(void)
1077e5c89e4eSSatish Balay {
1078e5c89e4eSSatish Balay   PetscErrorCode ierr;
10794bb5149bSJed Brown   PetscMPIInt    rank;
1080a8d2bbe5SBarry Smith   PetscInt       nopt;
10812bf49c77SBarry Smith   PetscBool      flg1 = PETSC_FALSE,flg2 = PETSC_FALSE,flg3 = PETSC_FALSE;
1082dff31646SBarry Smith   PetscBool      flg;
108310463e74SBarry Smith #if defined(PETSC_USE_LOG)
108410463e74SBarry Smith   char           mname[PETSC_MAX_PATH_LEN];
108510463e74SBarry Smith #endif
1086e5c89e4eSSatish Balay 
1087e5c89e4eSSatish Balay   if (!PetscInitializeCalled) {
10884b09e917SBarry Smith     printf("PetscInitialize() must be called before PetscFinalize()\n");
10893cbbc5ffSBarry Smith     return(PETSC_ERR_ARG_WRONGSTATE);
1090e5c89e4eSSatish Balay   }
10913cbbc5ffSBarry Smith   PetscFunctionBegin;
10920298fd71SBarry Smith   ierr = PetscInfo(NULL,"PetscFinalize() called\n");CHKERRQ(ierr);
1093b022a5c1SBarry Smith 
10941f817a21SBarry Smith   ierr = MPI_Comm_rank(PETSC_COMM_WORLD,&rank);CHKERRQ(ierr);
10951f817a21SBarry Smith 
1096c5929fdfSBarry Smith   ierr = PetscOptionsHasName(NULL,NULL,"-citations",&flg);CHKERRQ(ierr);
1097dff31646SBarry Smith   if (flg) {
10981f817a21SBarry Smith     char  *cits, filename[PETSC_MAX_PATH_LEN];
10991f817a21SBarry Smith     FILE  *fd = PETSC_STDOUT;
11001f817a21SBarry Smith 
1101c5929fdfSBarry Smith     ierr = PetscOptionsGetString(NULL,NULL,"-citations",filename,PETSC_MAX_PATH_LEN,NULL);CHKERRQ(ierr);
11021f817a21SBarry Smith     if (filename[0]) {
11031f817a21SBarry Smith       ierr = PetscFOpen(PETSC_COMM_WORLD,filename,"w",&fd);CHKERRQ(ierr);
11041f817a21SBarry Smith     }
1105dff31646SBarry Smith     ierr = PetscSegBufferGet(PetscCitationsList,1,&cits);CHKERRQ(ierr);
1106dff31646SBarry Smith     cits[0] = 0;
1107dff31646SBarry Smith     ierr = PetscSegBufferExtractAlloc(PetscCitationsList,&cits);CHKERRQ(ierr);
11081f817a21SBarry Smith     ierr = PetscFPrintf(PETSC_COMM_WORLD,fd,"If you publish results based on this computation please cite the following:\n");CHKERRQ(ierr);
11091f817a21SBarry Smith     ierr = PetscFPrintf(PETSC_COMM_WORLD,fd,"===========================================================================\n");CHKERRQ(ierr);
11101f817a21SBarry Smith     ierr = PetscFPrintf(PETSC_COMM_WORLD,fd,"%s",cits);CHKERRQ(ierr);
11111f817a21SBarry Smith     ierr = PetscFPrintf(PETSC_COMM_WORLD,fd,"===========================================================================\n");CHKERRQ(ierr);
11121f817a21SBarry Smith     ierr = PetscFClose(PETSC_COMM_WORLD,fd);CHKERRQ(ierr);
1113dff31646SBarry Smith     ierr = PetscFree(cits);CHKERRQ(ierr);
1114dff31646SBarry Smith   }
1115dff31646SBarry Smith   ierr = PetscSegBufferDestroy(&PetscCitationsList);CHKERRQ(ierr);
1116dff31646SBarry Smith 
1117c2a97968SBarry Smith #if defined(PETSC_HAVE_SSL) && defined(PETSC_USE_SOCKET_VIEWER)
111804102261SBarry Smith   /* TextBelt is run for testing purposes only, please do not use this feature often */
111904102261SBarry Smith   {
112004102261SBarry Smith     PetscInt nmax = 2;
112104102261SBarry Smith     char     **buffs;
112204102261SBarry Smith     ierr = PetscMalloc1(2,&buffs);CHKERRQ(ierr);
1123c5929fdfSBarry Smith     ierr = PetscOptionsGetStringArray(NULL,NULL,"-textbelt",buffs,&nmax,&flg1);CHKERRQ(ierr);
112404102261SBarry Smith     if (flg1) {
112504102261SBarry Smith       if (!nmax) SETERRQ(PETSC_COMM_WORLD,PETSC_ERR_USER,"-textbelt requires either the phone number or number,\"message\"");
112604102261SBarry Smith       if (nmax == 1) {
112704102261SBarry Smith         ierr = PetscMalloc1(128,&buffs[1]);CHKERRQ(ierr);
112804102261SBarry Smith         ierr = PetscGetProgramName(buffs[1],32);CHKERRQ(ierr);
112904102261SBarry Smith         ierr = PetscStrcat(buffs[1]," has completed");CHKERRQ(ierr);
113004102261SBarry Smith       }
113104102261SBarry Smith       ierr = PetscTextBelt(PETSC_COMM_WORLD,buffs[0],buffs[1],NULL);CHKERRQ(ierr);
113204102261SBarry Smith       ierr = PetscFree(buffs[0]);CHKERRQ(ierr);
113304102261SBarry Smith       ierr = PetscFree(buffs[1]);CHKERRQ(ierr);
113404102261SBarry Smith     }
113504102261SBarry Smith     ierr = PetscFree(buffs);CHKERRQ(ierr);
113604102261SBarry Smith   }
1137763ec7b1SBarry Smith   {
1138763ec7b1SBarry Smith     PetscInt nmax = 2;
1139763ec7b1SBarry Smith     char     **buffs;
1140763ec7b1SBarry Smith     ierr = PetscMalloc1(2,&buffs);CHKERRQ(ierr);
1141763ec7b1SBarry Smith     ierr = PetscOptionsGetStringArray(NULL,NULL,"-tellmycell",buffs,&nmax,&flg1);CHKERRQ(ierr);
1142763ec7b1SBarry Smith     if (flg1) {
1143763ec7b1SBarry Smith       if (!nmax) SETERRQ(PETSC_COMM_WORLD,PETSC_ERR_USER,"-tellmycell requires either the phone number or number,\"message\"");
1144763ec7b1SBarry Smith       if (nmax == 1) {
1145763ec7b1SBarry Smith         ierr = PetscMalloc1(128,&buffs[1]);CHKERRQ(ierr);
1146763ec7b1SBarry Smith         ierr = PetscGetProgramName(buffs[1],32);CHKERRQ(ierr);
1147763ec7b1SBarry Smith         ierr = PetscStrcat(buffs[1]," has completed");CHKERRQ(ierr);
1148763ec7b1SBarry Smith       }
1149763ec7b1SBarry Smith       ierr = PetscTellMyCell(PETSC_COMM_WORLD,buffs[0],buffs[1],NULL);CHKERRQ(ierr);
1150763ec7b1SBarry Smith       ierr = PetscFree(buffs[0]);CHKERRQ(ierr);
1151763ec7b1SBarry Smith       ierr = PetscFree(buffs[1]);CHKERRQ(ierr);
1152763ec7b1SBarry Smith     }
1153763ec7b1SBarry Smith     ierr = PetscFree(buffs);CHKERRQ(ierr);
1154763ec7b1SBarry Smith   }
115504102261SBarry Smith #endif
115667234432SDmitry Karpeev   /*
115767234432SDmitry Karpeev     It should be safe to cancel the options monitors, since we don't expect to be setting options
115867234432SDmitry Karpeev     here (at least that are worth monitoring).  Monitors ought to be released so that they release
115967234432SDmitry Karpeev     whatever memory was allocated there before -malloc_dump reports unfreed memory.
116067234432SDmitry Karpeev   */
116167234432SDmitry Karpeev   ierr = PetscOptionsMonitorCancel();CHKERRQ(ierr);
116204102261SBarry Smith 
11632d53ad75SBarry Smith #if defined(PETSC_SERIALIZE_FUNCTIONS)
11642d53ad75SBarry Smith   ierr = PetscFPTDestroy();CHKERRQ(ierr);
11652d53ad75SBarry Smith #endif
11662d53ad75SBarry Smith 
11672d53ad75SBarry Smith 
1168e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS)
1169dff31646SBarry Smith   flg = PETSC_FALSE;
1170c5929fdfSBarry Smith   ierr = PetscOptionsGetBool(NULL,NULL,"-saw_options",&flg,NULL);CHKERRQ(ierr);
1171d5649816SBarry Smith   if (flg) {
1172e04113cfSBarry Smith     ierr = PetscOptionsSAWsDestroy();CHKERRQ(ierr);
1173d5649816SBarry Smith   }
1174d5649816SBarry Smith #endif
1175d5649816SBarry Smith 
1176681455b2SBarry Smith #if defined(PETSC_HAVE_X)
1177681455b2SBarry Smith   flg1 = PETSC_FALSE;
1178c5929fdfSBarry Smith   ierr = PetscOptionsGetBool(NULL,NULL,"-x_virtual",&flg1,NULL);CHKERRQ(ierr);
1179681455b2SBarry Smith   if (flg1) {
1180681455b2SBarry Smith     /*  this is a crude hack, but better than nothing */
1181681455b2SBarry Smith     ierr = PetscPOpen(PETSC_COMM_WORLD,NULL,"pkill -9 Xvfb","r",NULL);CHKERRQ(ierr);
1182681455b2SBarry Smith   }
1183681455b2SBarry Smith #endif
1184681455b2SBarry Smith 
118567584ceeSBarry Smith #if !defined(PETSC_HAVE_THREADSAFETY)
1186c5929fdfSBarry Smith   ierr = PetscOptionsGetBool(NULL,NULL,"-malloc_info",&flg2,NULL);CHKERRQ(ierr);
1187e5c89e4eSSatish Balay   if (!flg2) {
118890d69ab7SBarry Smith     flg2 = PETSC_FALSE;
1189c5929fdfSBarry Smith     ierr = PetscOptionsGetBool(NULL,NULL,"-memory_view",&flg2,NULL);CHKERRQ(ierr);
1190e5c89e4eSSatish Balay   }
1191e5c89e4eSSatish Balay   if (flg2) {
11920841954dSBarry Smith     ierr = PetscMemoryView(PETSC_VIEWER_STDOUT_WORLD,"Summary of Memory Usage in PETSc\n");CHKERRQ(ierr);
1193e5c89e4eSSatish Balay   }
119467584ceeSBarry Smith #endif
1195e5c89e4eSSatish Balay 
1196e5c89e4eSSatish Balay #if defined(PETSC_USE_LOG)
119790d69ab7SBarry Smith   flg1 = PETSC_FALSE;
1198c5929fdfSBarry Smith   ierr = PetscOptionsGetBool(NULL,NULL,"-get_total_flops",&flg1,NULL);CHKERRQ(ierr);
1199e5c89e4eSSatish Balay   if (flg1) {
1200e5c89e4eSSatish Balay     PetscLogDouble flops = 0;
1201205a32c2SJed Brown     ierr = MPI_Reduce(&petsc_TotalFlops,&flops,1,MPI_DOUBLE,MPI_SUM,0,PETSC_COMM_WORLD);CHKERRQ(ierr);
1202e5c89e4eSSatish Balay     ierr = PetscPrintf(PETSC_COMM_WORLD,"Total flops over all processors %g\n",flops);CHKERRQ(ierr);
1203e5c89e4eSSatish Balay   }
1204e5c89e4eSSatish Balay #endif
1205e5c89e4eSSatish Balay 
1206e5c89e4eSSatish Balay 
1207e5c89e4eSSatish Balay #if defined(PETSC_USE_LOG)
1208e5c89e4eSSatish Balay #if defined(PETSC_HAVE_MPE)
1209e5c89e4eSSatish Balay   mname[0] = 0;
1210c5929fdfSBarry Smith   ierr = PetscOptionsGetString(NULL,NULL,"-log_mpe",mname,PETSC_MAX_PATH_LEN,&flg1);CHKERRQ(ierr);
1211e5c89e4eSSatish Balay   if (flg1) {
1212e5c89e4eSSatish Balay     if (mname[0]) {ierr = PetscLogMPEDump(mname);CHKERRQ(ierr);}
1213e5c89e4eSSatish Balay     else          {ierr = PetscLogMPEDump(0);CHKERRQ(ierr);}
1214e5c89e4eSSatish Balay   }
1215e5c89e4eSSatish Balay #endif
1216356e5837SBarry Smith #endif
1217a297a907SKarl Rupp 
1218dd710f27SBarry Smith   /*
1219dd710f27SBarry Smith      Free all objects registered with PetscObjectRegisterDestroy() such as PETSC_VIEWER_XXX_().
1220dd710f27SBarry Smith   */
1221dd710f27SBarry Smith   ierr = PetscObjectRegisterDestroyAll();CHKERRQ(ierr);
1222dd710f27SBarry Smith 
1223356e5837SBarry Smith #if defined(PETSC_USE_LOG)
1224f14045dbSBarry Smith   ierr = PetscLogViewFromOptions();CHKERRQ(ierr);
1225356e5837SBarry Smith   mname[0] = 0;
1226c5929fdfSBarry Smith   ierr = PetscOptionsGetString(NULL,NULL,"-log_summary",mname,PETSC_MAX_PATH_LEN,&flg1);CHKERRQ(ierr);
1227e5c89e4eSSatish Balay   if (flg1) {
122891eabc43SBarry Smith     PetscViewer viewer;
122920a8bfc3SBarry Smith     ierr = (*PetscHelpPrintf)(PETSC_COMM_WORLD,"\n\n WARNING:   -log_summary is being deprecated; switch to -log_view\n\n\n");CHKERRQ(ierr);
123091eabc43SBarry Smith     if (mname[0]) {
123191eabc43SBarry Smith       ierr = PetscViewerASCIIOpen(PETSC_COMM_WORLD,mname,&viewer);CHKERRQ(ierr);
123291eabc43SBarry Smith       ierr = PetscLogView(viewer);CHKERRQ(ierr);
12336bf464f9SBarry Smith       ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr);
123433f85c2fSBarry Smith     } else {
123533f85c2fSBarry Smith       viewer = PETSC_VIEWER_STDOUT_WORLD;
12369a9a5d4cSBarry Smith       ierr   = PetscViewerPushFormat(viewer,PETSC_VIEWER_DEFAULT);CHKERRQ(ierr);
123733f85c2fSBarry Smith       ierr   = PetscLogView(viewer);CHKERRQ(ierr);
12389a9a5d4cSBarry Smith       ierr   = PetscViewerPopFormat(viewer);CHKERRQ(ierr);
123933f85c2fSBarry Smith     }
1240e5c89e4eSSatish Balay   }
1241a297a907SKarl Rupp 
1242dd710f27SBarry Smith   /*
1243dd710f27SBarry Smith      Free any objects created by the last block of code.
1244dd710f27SBarry Smith   */
1245dd710f27SBarry Smith   ierr = PetscObjectRegisterDestroyAll();CHKERRQ(ierr);
1246dd710f27SBarry Smith 
1247dd710f27SBarry Smith   mname[0] = 0;
1248c5929fdfSBarry Smith   ierr = PetscOptionsGetString(NULL,NULL,"-log_all",mname,PETSC_MAX_PATH_LEN,&flg1);CHKERRQ(ierr);
1249c5929fdfSBarry Smith   ierr = PetscOptionsGetString(NULL,NULL,"-log",mname,PETSC_MAX_PATH_LEN,&flg2);CHKERRQ(ierr);
1250e5c89e4eSSatish Balay   if (flg1 || flg2) {
1251e5c89e4eSSatish Balay     if (mname[0]) PetscLogDump(mname);
1252e5c89e4eSSatish Balay     else          PetscLogDump(0);
1253e5c89e4eSSatish Balay   }
1254e5c89e4eSSatish Balay #endif
125510463e74SBarry Smith 
125633f85c2fSBarry Smith   ierr = PetscStackDestroy();CHKERRQ(ierr);
125710463e74SBarry Smith 
125890d69ab7SBarry Smith   flg1 = PETSC_FALSE;
1259c5929fdfSBarry Smith   ierr = PetscOptionsGetBool(NULL,NULL,"-no_signal_handler",&flg1,NULL);CHKERRQ(ierr);
1260e5c89e4eSSatish Balay   if (!flg1) { ierr = PetscPopSignalHandler();CHKERRQ(ierr);}
126190d69ab7SBarry Smith   flg1 = PETSC_FALSE;
1262c5929fdfSBarry Smith   ierr = PetscOptionsGetBool(NULL,NULL,"-mpidump",&flg1,NULL);CHKERRQ(ierr);
1263e5c89e4eSSatish Balay   if (flg1) {
1264e5c89e4eSSatish Balay     ierr = PetscMPIDump(stdout);CHKERRQ(ierr);
1265e5c89e4eSSatish Balay   }
126690d69ab7SBarry Smith   flg1 = PETSC_FALSE;
126790d69ab7SBarry Smith   flg2 = PETSC_FALSE;
12688bb29257SSatish Balay   /* preemptive call to avoid listing this option in options table as unused */
1269c5929fdfSBarry Smith   ierr = PetscOptionsHasName(NULL,NULL,"-malloc_dump",&flg1);CHKERRQ(ierr);
1270c5929fdfSBarry Smith   ierr = PetscOptionsHasName(NULL,NULL,"-objects_dump",&flg1);CHKERRQ(ierr);
1271c5929fdfSBarry Smith   ierr = PetscOptionsGetBool(NULL,NULL,"-options_view",&flg2,NULL);CHKERRQ(ierr);
1272e4c476e2SSatish Balay 
1273e5c89e4eSSatish Balay   if (flg2) {
1274be56827dSJed Brown     PetscViewer viewer;
127502ba9f54SBarry Smith     ierr = PetscViewerCreate(PETSC_COMM_WORLD,&viewer);CHKERRQ(ierr);
127602ba9f54SBarry Smith     ierr = PetscViewerSetType(viewer,PETSCVIEWERASCII);CHKERRQ(ierr);
1277c5929fdfSBarry Smith     ierr = PetscOptionsView(NULL,viewer);CHKERRQ(ierr);
1278be56827dSJed Brown     ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr);
1279e5c89e4eSSatish Balay   }
1280e5c89e4eSSatish Balay 
1281e5c89e4eSSatish Balay   /* to prevent PETSc -options_left from warning */
1282c5929fdfSBarry Smith   ierr = PetscOptionsHasName(NULL,NULL,"-nox",&flg1);CHKERRQ(ierr);
1283c5929fdfSBarry Smith   ierr = PetscOptionsHasName(NULL,NULL,"-nox_warning",&flg1);CHKERRQ(ierr);
1284e5c89e4eSSatish Balay 
128533fc4174SSatish Balay   flg3 = PETSC_FALSE; /* default value is required */
1286c5929fdfSBarry Smith   ierr = PetscOptionsGetBool(NULL,NULL,"-options_left",&flg3,&flg1);CHKERRQ(ierr);
1287c5929fdfSBarry Smith   ierr = PetscOptionsAllUsed(NULL,&nopt);CHKERRQ(ierr);
1288e5c89e4eSSatish Balay   if (flg3) {
1289e5c89e4eSSatish Balay     if (!flg2) { /* have not yet printed the options */
1290be56827dSJed Brown       PetscViewer viewer;
129102ba9f54SBarry Smith       ierr = PetscViewerCreate(PETSC_COMM_WORLD,&viewer);CHKERRQ(ierr);
129202ba9f54SBarry Smith       ierr = PetscViewerSetType(viewer,PETSCVIEWERASCII);CHKERRQ(ierr);
1293c5929fdfSBarry Smith       ierr = PetscOptionsView(NULL,viewer);CHKERRQ(ierr);
1294be56827dSJed Brown       ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr);
1295e5c89e4eSSatish Balay     }
1296e5c89e4eSSatish Balay     if (!nopt) {
1297e5c89e4eSSatish Balay       ierr = PetscPrintf(PETSC_COMM_WORLD,"There are no unused options.\n");CHKERRQ(ierr);
1298e5c89e4eSSatish Balay     } else if (nopt == 1) {
1299e5c89e4eSSatish Balay       ierr = PetscPrintf(PETSC_COMM_WORLD,"There is one unused database option. It is:\n");CHKERRQ(ierr);
1300e5c89e4eSSatish Balay     } else {
13017582186dSLisandro Dalcin       ierr = PetscPrintf(PETSC_COMM_WORLD,"There are %D unused database options. They are:\n",nopt);CHKERRQ(ierr);
1302e5c89e4eSSatish Balay     }
1303df12ba86SBarry Smith   }
1304e5c89e4eSSatish Balay #if defined(PETSC_USE_DEBUG)
1305da8b8a77SBarry Smith   if (nopt && !flg3 && !flg1) {
1306e5c89e4eSSatish Balay     ierr = PetscPrintf(PETSC_COMM_WORLD,"WARNING! There are options you set that were not used!\n");CHKERRQ(ierr);
1307e5c89e4eSSatish Balay     ierr = PetscPrintf(PETSC_COMM_WORLD,"WARNING! could be spelling mistake, etc!\n");CHKERRQ(ierr);
1308c5929fdfSBarry Smith     ierr = PetscOptionsLeft(NULL);CHKERRQ(ierr);
1309e5c89e4eSSatish Balay   } else if (nopt && flg3) {
1310e5c89e4eSSatish Balay #else
1311e5c89e4eSSatish Balay   if (nopt && flg3) {
1312e5c89e4eSSatish Balay #endif
1313c5929fdfSBarry Smith     ierr = PetscOptionsLeft(NULL);CHKERRQ(ierr);
1314e5c89e4eSSatish Balay   }
1315e5c89e4eSSatish Balay 
1316e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS)
1317d45a07a7SBarry Smith   if (!PetscGlobalRank) {
131887f587eeSBarry Smith     ierr = PetscStackSAWsViewOff();CHKERRQ(ierr);
131916ad0300SBarry Smith     PetscStackCallSAWs(SAWs_Finalize,());
1320d45a07a7SBarry Smith   }
1321ec957eceSBarry Smith #endif
1322ec957eceSBarry Smith 
13234097062eSBarry Smith #if defined(PETSC_USE_LOG)
132410463e74SBarry Smith   /*
1325dbc8283eSBarry Smith        List all objects the user may have forgot to free
13262eff7a51SBarry Smith   */
132705df10baSBarry Smith   if (PetscObjectsLog) {
1328c5929fdfSBarry Smith     ierr = PetscOptionsHasName(NULL,NULL,"-objects_dump",&flg1);CHKERRQ(ierr);
1329a64a8e02SBarry Smith     if (flg1) {
1330a64a8e02SBarry Smith       MPI_Comm local_comm;
13317eb1d149SBarry Smith       char     string[64];
1332a64a8e02SBarry Smith 
1333c5929fdfSBarry Smith       ierr = PetscOptionsGetString(NULL,NULL,"-objects_dump",string,64,NULL);CHKERRQ(ierr);
1334a64a8e02SBarry Smith       ierr = MPI_Comm_dup(MPI_COMM_WORLD,&local_comm);CHKERRQ(ierr);
1335a64a8e02SBarry Smith       ierr = PetscSequentialPhaseBegin_Private(local_comm,1);CHKERRQ(ierr);
13367eb1d149SBarry Smith       ierr = PetscObjectsDump(stdout,(string[0] == 'a') ? PETSC_TRUE : PETSC_FALSE);CHKERRQ(ierr);
1337a64a8e02SBarry Smith       ierr = PetscSequentialPhaseEnd_Private(local_comm,1);CHKERRQ(ierr);
1338a64a8e02SBarry Smith       ierr = MPI_Comm_free(&local_comm);CHKERRQ(ierr);
13390a1571b3SBarry Smith     }
134005df10baSBarry Smith   }
13414097062eSBarry Smith #endif
13424097062eSBarry Smith 
13434097062eSBarry Smith #if defined(PETSC_USE_LOG)
1344dbc8283eSBarry Smith   PetscObjectsCounts    = 0;
1345dbc8283eSBarry Smith   PetscObjectsMaxCounts = 0;
1346a297a907SKarl Rupp   ierr = PetscFree(PetscObjects);CHKERRQ(ierr);
13474097062eSBarry Smith #endif
13482eff7a51SBarry Smith 
134933f85c2fSBarry Smith   /*
135033f85c2fSBarry Smith      Destroy any packages that registered a finalize
135133f85c2fSBarry Smith   */
135233f85c2fSBarry Smith   ierr = PetscRegisterFinalizeAll();CHKERRQ(ierr);
135333f85c2fSBarry Smith 
1354101409b8SToby Isaac #if defined(PETSC_USE_LOG)
1355101409b8SToby Isaac   ierr = PetscLogDestroy();CHKERRQ(ierr);
1356101409b8SToby Isaac #endif
1357101409b8SToby Isaac 
135833f85c2fSBarry Smith   /*
135948dd1dffSBarry Smith      Print PetscFunctionLists that have not been properly freed
136048dd1dffSBarry Smith 
136137e93019SBarry Smith   ierr = PetscFunctionListPrintAll();CHKERRQ(ierr);
136248dd1dffSBarry Smith   */
136337e93019SBarry Smith 
13644028d114SSatish Balay   if (petsc_history) {
1365f3dea69dSBarry Smith     ierr = PetscCloseHistoryFile(&petsc_history);CHKERRQ(ierr);
1366e5c89e4eSSatish Balay     petsc_history = 0;
1367e5c89e4eSSatish Balay   }
13689de0f6ecSBarry Smith   ierr = PetscOptionsHelpPrintedDestroy(&PetscOptionsHelpPrintedSingleton);CHKERRQ(ierr);
1369e5c89e4eSSatish Balay 
13700298fd71SBarry Smith   ierr = PetscInfoAllow(PETSC_FALSE,NULL);CHKERRQ(ierr);
1371e5c89e4eSSatish Balay 
137267584ceeSBarry Smith #if !defined(PETSC_HAVE_THREADSAFETY)
13738bb29257SSatish Balay   {
1374e5c89e4eSSatish Balay     char fname[PETSC_MAX_PATH_LEN];
1375e5c89e4eSSatish Balay     FILE *fd;
1376ed9cf6e9SBarry Smith     int  err;
1377e5c89e4eSSatish Balay 
1378e5c89e4eSSatish Balay     fname[0] = 0;
1379a297a907SKarl Rupp 
1380c5929fdfSBarry Smith     ierr = PetscOptionsGetString(NULL,NULL,"-malloc_dump",fname,250,&flg1);CHKERRQ(ierr);
1381dc92acbaSJed Brown     flg2 = PETSC_FALSE;
1382c5929fdfSBarry Smith     ierr = PetscOptionsGetBool(NULL,NULL,"-malloc_test",&flg2,NULL);CHKERRQ(ierr);
13838bf1f09cSShri Abhyankar #if defined(PETSC_USE_DEBUG)
1384dc92acbaSJed Brown     if (PETSC_RUNNING_ON_VALGRIND) flg2 = PETSC_FALSE;
1385dc92acbaSJed Brown #else
1386dc92acbaSJed Brown     flg2 = PETSC_FALSE;         /* Skip reporting for optimized builds regardless of -malloc_test */
1387dc92acbaSJed Brown #endif
1388e5c89e4eSSatish Balay     if (flg1 && fname[0]) {
1389e5c89e4eSSatish Balay       char sname[PETSC_MAX_PATH_LEN];
1390e5c89e4eSSatish Balay 
13912e924ca5SSatish Balay       PetscSNPrintf(sname,PETSC_MAX_PATH_LEN,"%s_%d",fname,rank);
1392e32f2f54SBarry Smith       fd   = fopen(sname,"w"); if (!fd) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_FILE_OPEN,"Cannot open log file: %s",sname);
1393e5c89e4eSSatish Balay       ierr = PetscMallocDump(fd);CHKERRQ(ierr);
1394ed9cf6e9SBarry Smith       err  = fclose(fd);
1395e32f2f54SBarry Smith       if (err) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SYS,"fclose() failed on file");
1396dc92acbaSJed Brown     } else if (flg1 || flg2) {
1397e5c89e4eSSatish Balay       MPI_Comm local_comm;
1398e5c89e4eSSatish Balay 
1399e5c89e4eSSatish Balay       ierr = MPI_Comm_dup(MPI_COMM_WORLD,&local_comm);CHKERRQ(ierr);
1400e5c89e4eSSatish Balay       ierr = PetscSequentialPhaseBegin_Private(local_comm,1);CHKERRQ(ierr);
1401e5c89e4eSSatish Balay       ierr = PetscMallocDump(stdout);CHKERRQ(ierr);
1402e5c89e4eSSatish Balay       ierr = PetscSequentialPhaseEnd_Private(local_comm,1);CHKERRQ(ierr);
1403e5c89e4eSSatish Balay       ierr = MPI_Comm_free(&local_comm);CHKERRQ(ierr);
1404e5c89e4eSSatish Balay     }
1405e5c89e4eSSatish Balay   }
1406a64a8e02SBarry Smith 
14078bb29257SSatish Balay   {
1408e5c89e4eSSatish Balay     char fname[PETSC_MAX_PATH_LEN];
14090298fd71SBarry Smith     FILE *fd = NULL;
1410e5c89e4eSSatish Balay 
1411e5c89e4eSSatish Balay     fname[0] = 0;
1412a297a907SKarl Rupp 
1413c5929fdfSBarry Smith     ierr = PetscOptionsGetString(NULL,NULL,"-malloc_log",fname,250,&flg1);CHKERRQ(ierr);
1414c5929fdfSBarry Smith     ierr = PetscOptionsHasName(NULL,NULL,"-malloc_log_threshold",&flg2);CHKERRQ(ierr);
1415e5c89e4eSSatish Balay     if (flg1 && fname[0]) {
1416ed9cf6e9SBarry Smith       int err;
1417e5c89e4eSSatish Balay 
1418574034a9SJed Brown       if (!rank) {
1419574034a9SJed Brown         fd = fopen(fname,"w");
1420574034a9SJed Brown         if (!fd) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_FILE_OPEN,"Cannot open log file: %s",fname);
1421574034a9SJed Brown       }
1422e5c89e4eSSatish Balay       ierr = PetscMallocDumpLog(fd);CHKERRQ(ierr);
1423574034a9SJed Brown       if (fd) {
1424ed9cf6e9SBarry Smith         err = fclose(fd);
1425e32f2f54SBarry Smith         if (err) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SYS,"fclose() failed on file");
1426574034a9SJed Brown       }
1427574034a9SJed Brown     } else if (flg1 || flg2) {
1428e5c89e4eSSatish Balay       ierr = PetscMallocDumpLog(stdout);CHKERRQ(ierr);
1429e5c89e4eSSatish Balay     }
1430e5c89e4eSSatish Balay   }
143167584ceeSBarry Smith #endif
143220e2c332SMatthew G. Knepley 
14335486ca60SMatthew G. Knepley   /*
14345486ca60SMatthew G. Knepley      Close any open dynamic libraries
14355486ca60SMatthew G. Knepley   */
14365486ca60SMatthew G. Knepley   ierr = PetscFinalize_DynamicLibraries();CHKERRQ(ierr);
14375486ca60SMatthew G. Knepley 
1438e5c89e4eSSatish Balay   /* Can be destroyed only after all the options are used */
14394416b707SBarry Smith   ierr = PetscOptionsDestroyDefault();CHKERRQ(ierr);
1440e5c89e4eSSatish Balay 
1441e5c89e4eSSatish Balay   PetscGlobalArgc = 0;
1442e5c89e4eSSatish Balay   PetscGlobalArgs = 0;
1443e5c89e4eSSatish Balay 
1444008a6e76SBarry Smith   ierr = PetscFreeMPIResources();CHKERRQ(ierr);
1445e5c89e4eSSatish Balay 
1446dbc8283eSBarry Smith   /*
1447efb80d3cSBarry Smith      Destroy any known inner MPI_Comm's and attributes pointing to them
1448efb80d3cSBarry Smith      Note this will not destroy any new communicators the user has created.
1449efb80d3cSBarry Smith 
1450efb80d3cSBarry Smith      If all PETSc objects were not destroyed those left over objects will have hanging references to
1451efb80d3cSBarry Smith      the MPI_Comms that were freed; but that is ok because those PETSc objects will never be used again
1452dbc8283eSBarry Smith  */
1453b770b1f6SSatish Balay   {
1454dbc8283eSBarry Smith     PetscCommCounter *counter;
1455dbc8283eSBarry Smith     PetscMPIInt      flg;
1456dbc8283eSBarry Smith     MPI_Comm         icomm;
1457265f3f35SJed Brown     union {MPI_Comm comm; void *ptr;} ucomm;
145847435625SJed Brown     ierr = MPI_Comm_get_attr(PETSC_COMM_SELF,Petsc_InnerComm_keyval,&ucomm,&flg);CHKERRQ(ierr);
1459dbc8283eSBarry Smith     if (flg) {
1460265f3f35SJed Brown       icomm = ucomm.comm;
146147435625SJed Brown       ierr = MPI_Comm_get_attr(icomm,Petsc_Counter_keyval,&counter,&flg);CHKERRQ(ierr);
1462dbc8283eSBarry 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");
1463dbc8283eSBarry Smith 
146447435625SJed Brown       ierr = MPI_Comm_delete_attr(PETSC_COMM_SELF,Petsc_InnerComm_keyval);CHKERRQ(ierr);
146547435625SJed Brown       ierr = MPI_Comm_delete_attr(icomm,Petsc_Counter_keyval);CHKERRQ(ierr);
1466efb80d3cSBarry Smith       ierr = MPI_Comm_free(&icomm);CHKERRQ(ierr);
1467dbc8283eSBarry Smith     }
146847435625SJed Brown     ierr = MPI_Comm_get_attr(PETSC_COMM_WORLD,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_WORLD,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_WORLD,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     }
1478b770b1f6SSatish Balay   }
1479dbc8283eSBarry Smith 
148047435625SJed Brown   ierr = MPI_Comm_free_keyval(&Petsc_Counter_keyval);CHKERRQ(ierr);
148147435625SJed Brown   ierr = MPI_Comm_free_keyval(&Petsc_InnerComm_keyval);CHKERRQ(ierr);
148247435625SJed Brown   ierr = MPI_Comm_free_keyval(&Petsc_OuterComm_keyval);CHKERRQ(ierr);
148347435625SJed Brown   ierr = MPI_Comm_free_keyval(&Petsc_Shared_keyval);CHKERRQ(ierr);
1484480cf27aSJed Brown 
14855ad9ad5bSBarry Smith   ierr = PetscSpinlockDestroy(&PetscViewerASCIISpinLockOpen);CHKERRQ(ierr);
14865ad9ad5bSBarry Smith   ierr = PetscSpinlockDestroy(&PetscViewerASCIISpinLockStdout);CHKERRQ(ierr);
14875ad9ad5bSBarry Smith   ierr = PetscSpinlockDestroy(&PetscViewerASCIISpinLockStderr);CHKERRQ(ierr);
1488ef19f930SBarry Smith   ierr = PetscSpinlockDestroy(&PetscCommSpinLock);CHKERRQ(ierr);
1489ef19f930SBarry Smith 
1490e5c89e4eSSatish Balay   if (PetscBeganMPI) {
149199608316SBarry Smith #if defined(PETSC_HAVE_MPI_FINALIZED)
149299b1327fSBarry Smith     PetscMPIInt flag;
149399b1327fSBarry Smith     ierr = MPI_Finalized(&flag);CHKERRQ(ierr);
1494e32f2f54SBarry Smith     if (flag) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_LIB,"MPI_Finalize() has already been called, even though MPI_Init() was called by PetscInitialize()");
149599608316SBarry Smith #endif
1496e5c89e4eSSatish Balay     ierr = MPI_Finalize();CHKERRQ(ierr);
1497e5c89e4eSSatish Balay   }
1498e5c89e4eSSatish Balay /*
1499e5c89e4eSSatish Balay 
1500e5c89e4eSSatish Balay      Note: In certain cases PETSC_COMM_WORLD is never MPI_Comm_free()ed because
1501e5c89e4eSSatish Balay    the communicator has some outstanding requests on it. Specifically if the
1502e5c89e4eSSatish Balay    flag PETSC_HAVE_BROKEN_REQUEST_FREE is set (for IBM MPI implementation). See
1503e5c89e4eSSatish Balay    src/vec/utils/vpscat.c. Due to this the memory allocated in PetscCommDuplicate()
1504e5c89e4eSSatish Balay    is never freed as it should be. Thus one may obtain messages of the form
15050e5e90baSSatish Balay    [ 1] 8 bytes PetscCommDuplicate() line 645 in src/sys/mpiu.c indicating the
1506e5c89e4eSSatish Balay    memory was not freed.
1507e5c89e4eSSatish Balay 
1508e5c89e4eSSatish Balay */
15091d1a0024SBarry Smith   ierr = PetscMallocClear();CHKERRQ(ierr);
1510a297a907SKarl Rupp 
1511e5c89e4eSSatish Balay   PetscInitializeCalled = PETSC_FALSE;
1512e5c89e4eSSatish Balay   PetscFinalizeCalled   = PETSC_TRUE;
15133db9a53dSBarry Smith   PetscFunctionReturn(0);
1514e5c89e4eSSatish Balay }
1515e5c89e4eSSatish Balay 
151643db4dbbSBarry Smith #if defined(PETSC_MISSING_LAPACK_lsame_)
15178cc058d9SJed Brown PETSC_EXTERN int lsame_(char *a,char *b)
151843db4dbbSBarry Smith {
151943db4dbbSBarry Smith   if (*a == *b) return 1;
152043db4dbbSBarry Smith   if (*a + 32 == *b) return 1;
152143db4dbbSBarry Smith   if (*a - 32 == *b) return 1;
152243db4dbbSBarry Smith   return 0;
152343db4dbbSBarry Smith }
1524a70650f6SBarry Smith #endif
152543db4dbbSBarry Smith 
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 }
153443db4dbbSBarry Smith #endif
1535