xref: /petsc/src/sys/objects/pinit.c (revision 3cbbc5ff037ae03fd9010ee4a8e4d7c21ef7cb71)
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 
1782f73ecaSAlejandro Lamas Daviña #if defined(PETSC_HAVE_CUDA)
1882f73ecaSAlejandro Lamas Daviña cublasHandle_t cublasv2handle = NULL;
1982f73ecaSAlejandro Lamas Daviña #endif
2082f73ecaSAlejandro Lamas Daviña 
21a6790183SBarry Smith #if defined(PETSC_HAVE_SAWS)
2216ad0300SBarry Smith #include <petscviewersaws.h>
23a6790183SBarry Smith #endif
24e5c89e4eSSatish Balay /* -----------------------------------------------------------------------------------------*/
25e5c89e4eSSatish Balay 
26e5c89e4eSSatish Balay extern FILE *petsc_history;
27e5c89e4eSSatish Balay 
2809573ac7SBarry Smith extern PetscErrorCode PetscInitialize_DynamicLibraries(void);
2909573ac7SBarry Smith extern PetscErrorCode PetscFinalize_DynamicLibraries(void);
3037e93019SBarry Smith extern PetscErrorCode PetscFunctionListPrintAll(void);
3109573ac7SBarry Smith extern PetscErrorCode PetscSequentialPhaseBegin_Private(MPI_Comm,int);
3209573ac7SBarry Smith extern PetscErrorCode PetscSequentialPhaseEnd_Private(MPI_Comm,int);
3309573ac7SBarry Smith extern PetscErrorCode PetscCloseHistoryFile(FILE**);
340069ddf5SShri Abhyankar 
35e5c89e4eSSatish Balay /* user may set this BEFORE calling PetscInitialize() */
36e8373e55SMatthew Knepley MPI_Comm PETSC_COMM_WORLD = MPI_COMM_NULL;
37e5c89e4eSSatish Balay 
38480cf27aSJed Brown PetscMPIInt Petsc_Counter_keyval   = MPI_KEYVAL_INVALID;
39480cf27aSJed Brown PetscMPIInt Petsc_InnerComm_keyval = MPI_KEYVAL_INVALID;
40480cf27aSJed Brown PetscMPIInt Petsc_OuterComm_keyval = MPI_KEYVAL_INVALID;
4142218b76SBarry Smith PetscMPIInt Petsc_Shared_keyval    = MPI_KEYVAL_INVALID;
42480cf27aSJed Brown 
43e5c89e4eSSatish Balay /*
44e5c89e4eSSatish Balay      Declare and set all the string names of the PETSc enums
45e5c89e4eSSatish Balay */
466a6fc655SJed Brown const char *const PetscBools[]     = {"FALSE","TRUE","PetscBool","PETSC_",0};
476a6fc655SJed Brown const char *const PetscCopyModes[] = {"COPY_VALUES","OWN_POINTER","USE_POINTER","PetscCopyMode","PETSC_",0};
486a6fc655SJed Brown const char *const PetscDataTypes[] = {"INT","DOUBLE","COMPLEX","LONG","SHORT","FLOAT",
492d53ad75SBarry Smith                                       "CHAR","LOGICAL","ENUM","BOOL","LONGDOUBLE","OBJECT","FUNCTION","PetscDataType","PETSC_",0};
50e5c89e4eSSatish Balay 
51ace3abfcSBarry Smith PetscBool PetscPreLoadingUsed = PETSC_FALSE;
52ace3abfcSBarry Smith PetscBool PetscPreLoadingOn   = PETSC_FALSE;
530f8e0872SSatish Balay 
54a2f94806SJed Brown PetscInt PetscHotRegionDepth;
55a2f94806SJed Brown 
56b22622e2STadeu Manoel #if defined(PETSC_HAVE_THREADSAFETY)
57b22622e2STadeu Manoel PetscSpinlock PetscViewerASCIISpinLockOpen;
58b22622e2STadeu Manoel PetscSpinlock PetscViewerASCIISpinLockStdout;
59b22622e2STadeu Manoel PetscSpinlock PetscViewerASCIISpinLockStderr;
60b22622e2STadeu Manoel PetscSpinlock PetscCommSpinLock;
61b22622e2STadeu Manoel #endif
62b22622e2STadeu Manoel 
63e5c89e4eSSatish Balay /*
64e5c89e4eSSatish Balay        Checks the options database for initializations related to the
65e5c89e4eSSatish Balay     PETSc components
66e5c89e4eSSatish Balay */
677087cfbeSBarry Smith PetscErrorCode  PetscOptionsCheckInitial_Components(void)
68e5c89e4eSSatish Balay {
69ace3abfcSBarry Smith   PetscBool      flg1;
70e5c89e4eSSatish Balay   PetscErrorCode ierr;
71e5c89e4eSSatish Balay 
72e5c89e4eSSatish Balay   PetscFunctionBegin;
73c5929fdfSBarry Smith   ierr = PetscOptionsHasName(NULL,NULL,"-help",&flg1);CHKERRQ(ierr);
74e5c89e4eSSatish Balay   if (flg1) {
75e5c89e4eSSatish Balay #if defined(PETSC_USE_LOG)
76e8e7597cSSatish Balay     MPI_Comm comm = PETSC_COMM_WORLD;
77e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm,"------Additional PETSc component options--------\n");CHKERRQ(ierr);
789a9a5d4cSBarry Smith     ierr = (*PetscHelpPrintf)(comm," -log_exclude: <vec,mat,pc.ksp,snes>\n");CHKERRQ(ierr);
796cf91177SBarry Smith     ierr = (*PetscHelpPrintf)(comm," -info_exclude: <null,vec,mat,pc,ksp,snes,ts>\n");CHKERRQ(ierr);
80e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm,"-----------------------------------------------\n");CHKERRQ(ierr);
81e5c89e4eSSatish Balay #endif
82e5c89e4eSSatish Balay   }
83e5c89e4eSSatish Balay   PetscFunctionReturn(0);
84e5c89e4eSSatish Balay }
85e5c89e4eSSatish Balay 
860f11a792SBarry Smith /*
87945d1669SBarry Smith       PetscInitializeNoPointers - Calls PetscInitialize() from C/C++ without the pointers to argc and args
8872a42c3cSBarry Smith 
8972a42c3cSBarry Smith    Collective
9072a42c3cSBarry Smith 
9172a42c3cSBarry Smith    Level: advanced
9272a42c3cSBarry Smith 
93945d1669SBarry Smith     Notes: this is called only by the PETSc MATLAB and Julia interface. Even though it might start MPI it sets the flag to
940f11a792SBarry Smith      indicate that it did NOT start MPI so that the PetscFinalize() does not end MPI, thus allowing PetscInitialize() to
95945d1669SBarry Smith      be called multiple times from MATLAB and Julia without the problem of trying to initialize MPI more than once.
960f11a792SBarry Smith 
971ea5a559SBarry Smith      Turns off PETSc signal handling because that can interact with MATLAB's signal handling causing random crashes.
981ea5a559SBarry Smith 
9972a42c3cSBarry Smith .seealso: PetscInitialize(), PetscInitializeFortran(), PetscInitializeNoArguments()
1000f11a792SBarry Smith */
101945d1669SBarry Smith PetscErrorCode  PetscInitializeNoPointers(int argc,char **args,const char *filename,const char *help)
10272a42c3cSBarry Smith {
10372a42c3cSBarry Smith   PetscErrorCode ierr;
10472a42c3cSBarry Smith   int            myargc   = argc;
10572a42c3cSBarry Smith   char           **myargs = args;
10672a42c3cSBarry Smith 
10772a42c3cSBarry Smith   PetscFunctionBegin;
1083bf036e2SBarry Smith   ierr = PetscInitialize(&myargc,&myargs,filename,help);CHKERRQ(ierr);
1091ea5a559SBarry Smith   ierr = PetscPopSignalHandler();CHKERRQ(ierr);
110df413903SBarry Smith   PetscBeganMPI = PETSC_FALSE;
11172a42c3cSBarry Smith   PetscFunctionReturn(ierr);
11272a42c3cSBarry Smith }
11372a42c3cSBarry Smith 
114f0865b08SBarry Smith /*
115945d1669SBarry Smith       Used by MATLAB and Julia interface to get communicator
116f0865b08SBarry Smith */
117945d1669SBarry Smith PetscErrorCode  PetscGetPETSC_COMM_SELF(MPI_Comm *comm)
118f0865b08SBarry Smith {
119f0865b08SBarry Smith   PetscFunctionBegin;
120f0865b08SBarry Smith   *comm = PETSC_COMM_SELF;
121f0865b08SBarry Smith   PetscFunctionReturn(0);
122f0865b08SBarry Smith }
123f0865b08SBarry Smith 
124e5c89e4eSSatish Balay /*@C
125e5c89e4eSSatish Balay       PetscInitializeNoArguments - Calls PetscInitialize() from C/C++ without
126e5c89e4eSSatish Balay         the command line arguments.
127e5c89e4eSSatish Balay 
128e5c89e4eSSatish Balay    Collective
129e5c89e4eSSatish Balay 
130e5c89e4eSSatish Balay    Level: advanced
131e5c89e4eSSatish Balay 
132e5c89e4eSSatish Balay .seealso: PetscInitialize(), PetscInitializeFortran()
133e5c89e4eSSatish Balay @*/
1347087cfbeSBarry Smith PetscErrorCode  PetscInitializeNoArguments(void)
135e5c89e4eSSatish Balay {
136e5c89e4eSSatish Balay   PetscErrorCode ierr;
137e5c89e4eSSatish Balay   int            argc   = 0;
138e5c89e4eSSatish Balay   char           **args = 0;
139e5c89e4eSSatish Balay 
140e5c89e4eSSatish Balay   PetscFunctionBegin;
1410298fd71SBarry Smith   ierr = PetscInitialize(&argc,&args,NULL,NULL);
142e5c89e4eSSatish Balay   PetscFunctionReturn(ierr);
143e5c89e4eSSatish Balay }
144e5c89e4eSSatish Balay 
145e5c89e4eSSatish Balay /*@
146e5c89e4eSSatish Balay       PetscInitialized - Determine whether PETSc is initialized.
147e5c89e4eSSatish Balay 
14893b6d2d1SJed Brown    Level: beginner
149e5c89e4eSSatish Balay 
150e5c89e4eSSatish Balay .seealso: PetscInitialize(), PetscInitializeNoArguments(), PetscInitializeFortran()
151e5c89e4eSSatish Balay @*/
1527087cfbeSBarry Smith PetscErrorCode PetscInitialized(PetscBool  *isInitialized)
153e5c89e4eSSatish Balay {
154e5c89e4eSSatish Balay   *isInitialized = PetscInitializeCalled;
15593b6d2d1SJed Brown   return 0;
156e5c89e4eSSatish Balay }
157e5c89e4eSSatish Balay 
158e5c89e4eSSatish Balay /*@
159e5c89e4eSSatish Balay       PetscFinalized - Determine whether PetscFinalize() has been called yet
160e5c89e4eSSatish Balay 
161e5c89e4eSSatish Balay    Level: developer
162e5c89e4eSSatish Balay 
163e5c89e4eSSatish Balay .seealso: PetscInitialize(), PetscInitializeNoArguments(), PetscInitializeFortran()
164e5c89e4eSSatish Balay @*/
1657087cfbeSBarry Smith PetscErrorCode  PetscFinalized(PetscBool  *isFinalized)
166e5c89e4eSSatish Balay {
167e5c89e4eSSatish Balay   *isFinalized = PetscFinalizeCalled;
16893b6d2d1SJed Brown   return 0;
169e5c89e4eSSatish Balay }
170e5c89e4eSSatish Balay 
17109573ac7SBarry Smith extern PetscErrorCode PetscOptionsCheckInitial_Private(void);
172e5c89e4eSSatish Balay 
173e5c89e4eSSatish Balay /*
174e5c89e4eSSatish Balay        This function is the MPI reduction operation used to compute the sum of the
175e5c89e4eSSatish Balay    first half of the datatype and the max of the second half.
176e5c89e4eSSatish Balay */
177367daffbSBarry Smith MPI_Op MPIU_MAXSUM_OP = 0;
178e5c89e4eSSatish Balay 
179367daffbSBarry Smith PETSC_INTERN void MPIAPI MPIU_MaxSum_Local(void *in,void *out,int *cnt,MPI_Datatype *datatype)
180e5c89e4eSSatish Balay {
181e5c89e4eSSatish Balay   PetscInt *xin = (PetscInt*)in,*xout = (PetscInt*)out,i,count = *cnt;
182e5c89e4eSSatish Balay 
183e5c89e4eSSatish Balay   PetscFunctionBegin;
184e5c89e4eSSatish Balay   if (*datatype != MPIU_2INT) {
185e5c89e4eSSatish Balay     (*PetscErrorPrintf)("Can only handle MPIU_2INT data types");
186e5c89e4eSSatish Balay     MPI_Abort(MPI_COMM_WORLD,1);
187e5c89e4eSSatish Balay   }
188e5c89e4eSSatish Balay 
189e5c89e4eSSatish Balay   for (i=0; i<count; i++) {
190e5c89e4eSSatish Balay     xout[2*i]    = PetscMax(xout[2*i],xin[2*i]);
191e5c89e4eSSatish Balay     xout[2*i+1] += xin[2*i+1];
192e5c89e4eSSatish Balay   }
193812af9f3SBarry Smith   PetscFunctionReturnVoid();
194e5c89e4eSSatish Balay }
195e5c89e4eSSatish Balay 
196e5c89e4eSSatish Balay /*
197e5c89e4eSSatish Balay     Returns the max of the first entry owned by this processor and the
198e5c89e4eSSatish Balay sum of the second entry.
199b693b147SBarry Smith 
20076f543a4SJed Brown     The reason sizes[2*i] contains lengths sizes[2*i+1] contains flag of 1 if length is nonzero
201367daffbSBarry Smith is so that the MPIU_MAXSUM_OP() can set TWO values, if we passed in only sizes[i] with lengths
202b693b147SBarry Smith there would be no place to store the both needed results.
203e5c89e4eSSatish Balay */
20476ec1555SBarry Smith PetscErrorCode  PetscMaxSum(MPI_Comm comm,const PetscInt sizes[],PetscInt *max,PetscInt *sum)
205e5c89e4eSSatish Balay {
206e5c89e4eSSatish Balay   PetscErrorCode ierr;
207e5c89e4eSSatish Balay 
208e5c89e4eSSatish Balay   PetscFunctionBegin;
209d6e4c47cSJed Brown #if defined(PETSC_HAVE_MPI_REDUCE_SCATTER_BLOCK)
210d6e4c47cSJed Brown   {
211d6e4c47cSJed Brown     struct {PetscInt max,sum;} work;
212367daffbSBarry Smith     ierr = MPI_Reduce_scatter_block((void*)sizes,&work,1,MPIU_2INT,MPIU_MAXSUM_OP,comm);CHKERRQ(ierr);
213d6e4c47cSJed Brown     *max = work.max;
214d6e4c47cSJed Brown     *sum = work.sum;
215d6e4c47cSJed Brown   }
216d6e4c47cSJed Brown #else
217d6e4c47cSJed Brown   {
218d6e4c47cSJed Brown     PetscMPIInt    size,rank;
219d6e4c47cSJed Brown     struct {PetscInt max,sum;} *work;
220e5c89e4eSSatish Balay     ierr = MPI_Comm_size(comm,&size);CHKERRQ(ierr);
221e5c89e4eSSatish Balay     ierr = MPI_Comm_rank(comm,&rank);CHKERRQ(ierr);
222785e854fSJed Brown     ierr = PetscMalloc1(size,&work);CHKERRQ(ierr);
223367daffbSBarry Smith     ierr = MPIU_Allreduce((void*)sizes,work,size,MPIU_2INT,MPIU_MAXSUM_OP,comm);CHKERRQ(ierr);
2246ac3741eSJed Brown     *max = work[rank].max;
2256ac3741eSJed Brown     *sum = work[rank].sum;
226e5c89e4eSSatish Balay     ierr = PetscFree(work);CHKERRQ(ierr);
227d6e4c47cSJed Brown   }
228d6e4c47cSJed Brown #endif
229e5c89e4eSSatish Balay   PetscFunctionReturn(0);
230e5c89e4eSSatish Balay }
231e5c89e4eSSatish Balay 
232e5c89e4eSSatish Balay /* ----------------------------------------------------------------------------*/
233e5c89e4eSSatish Balay 
234570b7f6dSBarry Smith #if (defined(PETSC_HAVE_COMPLEX) && !defined(PETSC_HAVE_MPI_C_DOUBLE_COMPLEX)) || defined(PETSC_USE_REAL___FLOAT128) || defined(PETSC_USE_REAL___FP16)
23506a205a8SBarry Smith MPI_Op MPIU_SUM = 0;
236e5c89e4eSSatish Balay 
2378cc058d9SJed Brown PETSC_EXTERN void PetscSum_Local(void *in,void *out,PetscMPIInt *cnt,MPI_Datatype *datatype)
238e5c89e4eSSatish Balay {
239e5c89e4eSSatish Balay   PetscInt i,count = *cnt;
240e5c89e4eSSatish Balay 
241e5c89e4eSSatish Balay   PetscFunctionBegin;
2427c2de775SJed Brown   if (*datatype == MPIU_REAL) {
243e2e03761SBarry Smith     PetscReal *xin = (PetscReal*)in,*xout = (PetscReal*)out;
244a297a907SKarl Rupp     for (i=0; i<count; i++) xout[i] += xin[i];
2457c2de775SJed Brown   }
2467c2de775SJed Brown #if defined(PETSC_HAVE_COMPLEX)
2477c2de775SJed Brown   else if (*datatype == MPIU_COMPLEX) {
2487c2de775SJed Brown     PetscComplex *xin = (PetscComplex*)in,*xout = (PetscComplex*)out;
249a297a907SKarl Rupp     for (i=0; i<count; i++) xout[i] += xin[i];
2507c2de775SJed Brown   }
2517c2de775SJed Brown #endif
2527c2de775SJed Brown   else {
2537c2de775SJed Brown     (*PetscErrorPrintf)("Can only handle MPIU_REAL or MPIU_COMPLEX data types");
254e2e03761SBarry Smith     MPI_Abort(MPI_COMM_WORLD,1);
255e2e03761SBarry Smith   }
256812af9f3SBarry Smith   PetscFunctionReturnVoid();
257e5c89e4eSSatish Balay }
258e5c89e4eSSatish Balay #endif
259e5c89e4eSSatish Balay 
260570b7f6dSBarry Smith #if defined(PETSC_USE_REAL___FLOAT128) || defined(PETSC_USE_REAL___FP16)
261d9822059SBarry Smith MPI_Op MPIU_MAX = 0;
262d9822059SBarry Smith MPI_Op MPIU_MIN = 0;
263d9822059SBarry Smith 
2648cc058d9SJed Brown PETSC_EXTERN void PetscMax_Local(void *in,void *out,PetscMPIInt *cnt,MPI_Datatype *datatype)
265d9822059SBarry Smith {
266d9822059SBarry Smith   PetscInt i,count = *cnt;
267d9822059SBarry Smith 
268d9822059SBarry Smith   PetscFunctionBegin;
2697c2de775SJed Brown   if (*datatype == MPIU_REAL) {
2708c764dc5SJose Roman     PetscReal *xin = (PetscReal*)in,*xout = (PetscReal*)out;
271a297a907SKarl Rupp     for (i=0; i<count; i++) xout[i] = PetscMax(xout[i],xin[i]);
2727c2de775SJed Brown   }
2737c2de775SJed Brown #if defined(PETSC_HAVE_COMPLEX)
2747c2de775SJed Brown   else if (*datatype == MPIU_COMPLEX) {
2757c2de775SJed Brown     PetscComplex *xin = (PetscComplex*)in,*xout = (PetscComplex*)out;
2767c2de775SJed Brown     for (i=0; i<count; i++) {
2777c2de775SJed Brown       xout[i] = PetscRealPartComplex(xout[i])<PetscRealPartComplex(xin[i]) ? xin[i] : xout[i];
2787c2de775SJed Brown     }
2797c2de775SJed Brown   }
2807c2de775SJed Brown #endif
2817c2de775SJed Brown   else {
2827c2de775SJed Brown     (*PetscErrorPrintf)("Can only handle MPIU_REAL or MPIU_COMPLEX data types");
2838c764dc5SJose Roman     MPI_Abort(MPI_COMM_WORLD,1);
2848c764dc5SJose Roman   }
285d9822059SBarry Smith   PetscFunctionReturnVoid();
286d9822059SBarry Smith }
287d9822059SBarry Smith 
2888cc058d9SJed Brown PETSC_EXTERN void PetscMin_Local(void *in,void *out,PetscMPIInt *cnt,MPI_Datatype *datatype)
289d9822059SBarry Smith {
290d9822059SBarry Smith   PetscInt    i,count = *cnt;
291d9822059SBarry Smith 
292d9822059SBarry Smith   PetscFunctionBegin;
2937c2de775SJed Brown   if (*datatype == MPIU_REAL) {
2948c764dc5SJose Roman     PetscReal *xin = (PetscReal*)in,*xout = (PetscReal*)out;
295a297a907SKarl Rupp     for (i=0; i<count; i++) xout[i] = PetscMin(xout[i],xin[i]);
2967c2de775SJed Brown   }
2977c2de775SJed Brown #if defined(PETSC_HAVE_COMPLEX)
2987c2de775SJed Brown   else if (*datatype == MPIU_COMPLEX) {
2997c2de775SJed Brown     PetscComplex *xin = (PetscComplex*)in,*xout = (PetscComplex*)out;
3007c2de775SJed Brown     for (i=0; i<count; i++) {
3017c2de775SJed Brown       xout[i] = PetscRealPartComplex(xout[i])>PetscRealPartComplex(xin[i]) ? xin[i] : xout[i];
3027c2de775SJed Brown     }
3037c2de775SJed Brown   }
3047c2de775SJed Brown #endif
3057c2de775SJed Brown   else {
3068c764dc5SJose Roman     (*PetscErrorPrintf)("Can only handle MPIU_REAL or MPIU_SCALAR data (i.e. double or complex) types");
3078c764dc5SJose Roman     MPI_Abort(MPI_COMM_WORLD,1);
3088c764dc5SJose Roman   }
309d9822059SBarry Smith   PetscFunctionReturnVoid();
310d9822059SBarry Smith }
311d9822059SBarry Smith #endif
312d9822059SBarry Smith 
313480cf27aSJed Brown /*
314480cf27aSJed Brown    Private routine to delete internal tag/name counter storage when a communicator is freed.
315480cf27aSJed Brown 
316ff0e51ddSBarry 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.
317480cf27aSJed Brown 
318480cf27aSJed Brown    Note: this is declared extern "C" because it is passed to MPI_Keyval_create()
319480cf27aSJed Brown 
320480cf27aSJed Brown */
3218cc058d9SJed Brown PETSC_EXTERN PetscMPIInt MPIAPI Petsc_DelCounter(MPI_Comm comm,PetscMPIInt keyval,void *count_val,void *extra_state)
322480cf27aSJed Brown {
323480cf27aSJed Brown   PetscErrorCode ierr;
324480cf27aSJed Brown 
325480cf27aSJed Brown   PetscFunctionBegin;
326480cf27aSJed Brown   ierr = PetscInfo1(0,"Deleting counter data in an MPI_Comm %ld\n",(long)comm);if (ierr) PetscFunctionReturn((PetscMPIInt)ierr);
327480cf27aSJed Brown   ierr = PetscFree(count_val);if (ierr) PetscFunctionReturn((PetscMPIInt)ierr);
328480cf27aSJed Brown   PetscFunctionReturn(MPI_SUCCESS);
329480cf27aSJed Brown }
330480cf27aSJed Brown 
331480cf27aSJed Brown /*
332da3039f7SJed Brown   This is invoked on the outer comm as a result of either PetscCommDestroy() (via MPI_Attr_delete) or when the user
333da3039f7SJed Brown   calls MPI_Comm_free().
334da3039f7SJed Brown 
335da3039f7SJed Brown   This is the only entry point for breaking the links between inner and outer comms.
336480cf27aSJed Brown 
337ff0e51ddSBarry Smith   This is called by MPI, not by users. This is called when MPI_Comm_free() is called on the communicator.
338480cf27aSJed Brown 
339480cf27aSJed Brown   Note: this is declared extern "C" because it is passed to MPI_Keyval_create()
340480cf27aSJed Brown 
341480cf27aSJed Brown */
342da3039f7SJed Brown PETSC_EXTERN PetscMPIInt MPIAPI Petsc_DelComm_Outer(MPI_Comm comm,PetscMPIInt keyval,void *attr_val,void *extra_state)
343480cf27aSJed Brown {
344480cf27aSJed Brown   PetscErrorCode ierr;
345b89831e5SBarry Smith   PetscMPIInt    flg;
346265f3f35SJed Brown   union {MPI_Comm comm; void *ptr;} icomm,ocomm;
347480cf27aSJed Brown 
348480cf27aSJed Brown   PetscFunctionBegin;
349da3039f7SJed Brown   if (keyval != Petsc_InnerComm_keyval) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_CORRUPT,"Unexpected keyval");
350ec4fadc2SJed Brown   icomm.ptr = attr_val;
351da3039f7SJed Brown 
352265f3f35SJed Brown   ierr = MPI_Attr_get(icomm.comm,Petsc_OuterComm_keyval,&ocomm,&flg);CHKERRQ(ierr);
353b3ef52cdSBarry Smith   if (!flg) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_CORRUPT,"Inner MPI_Comm does not have expected reference to outer comm");
354da3039f7SJed Brown   if (ocomm.comm != comm) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_CORRUPT,"Inner MPI_Comm has reference to non-matching outer comm");
355da3039f7SJed Brown   ierr = MPI_Attr_delete(icomm.comm,Petsc_OuterComm_keyval);CHKERRQ(ierr); /* Calls Petsc_DelComm_Inner */
356da3039f7SJed Brown   ierr = PetscInfo1(0,"User MPI_Comm %ld is being freed after removing reference from inner PETSc comm to this outer comm\n",(long)comm);if (ierr) PetscFunctionReturn((PetscMPIInt)ierr);
357da3039f7SJed Brown   PetscFunctionReturn(MPI_SUCCESS);
358b89831e5SBarry Smith }
359da3039f7SJed Brown 
360da3039f7SJed Brown /*
361da3039f7SJed Brown  * This is invoked on the inner comm when Petsc_DelComm_Outer calls MPI_Attr_delete.  It should not be reached any other way.
362da3039f7SJed Brown  */
363da3039f7SJed Brown PETSC_EXTERN PetscMPIInt MPIAPI Petsc_DelComm_Inner(MPI_Comm comm,PetscMPIInt keyval,void *attr_val,void *extra_state)
364da3039f7SJed Brown {
365da3039f7SJed Brown   PetscErrorCode ierr;
366da3039f7SJed Brown 
367da3039f7SJed Brown   PetscFunctionBegin;
368da3039f7SJed Brown   ierr = PetscInfo1(0,"Removing reference to PETSc communicator embedded in a user MPI_Comm %ld\n",(long)comm);if (ierr) PetscFunctionReturn((PetscMPIInt)ierr);
369480cf27aSJed Brown   PetscFunctionReturn(MPI_SUCCESS);
370480cf27aSJed Brown }
371480cf27aSJed Brown 
37242218b76SBarry Smith PETSC_EXTERN PetscMPIInt MPIAPI Petsc_DelShared(MPI_Comm,PetscMPIInt,void *,void *);
37342218b76SBarry Smith 
374951e3c8eSBarry Smith #if defined(PETSC_USE_PETSC_MPI_EXTERNAL32)
375e39fd77fSBarry Smith #if !defined(PETSC_WORDS_BIGENDIAN)
3768cc058d9SJed Brown PETSC_EXTERN PetscMPIInt PetscDataRep_extent_fn(MPI_Datatype,MPI_Aint*,void*);
3778cc058d9SJed Brown PETSC_EXTERN PetscMPIInt PetscDataRep_read_conv_fn(void*, MPI_Datatype,PetscMPIInt,void*,MPI_Offset,void*);
3788cc058d9SJed Brown PETSC_EXTERN PetscMPIInt PetscDataRep_write_conv_fn(void*, MPI_Datatype,PetscMPIInt,void*,MPI_Offset,void*);
379e39fd77fSBarry Smith #endif
380951e3c8eSBarry Smith #endif
381e39fd77fSBarry Smith 
3826ae9a8a6SBarry Smith int  PetscGlobalArgc   = 0;
3836ae9a8a6SBarry Smith char **PetscGlobalArgs = 0;
384dff31646SBarry Smith PetscSegBuffer PetscCitationsList;
385e5c89e4eSSatish Balay 
386dd63322aSSatish Balay PetscErrorCode PetscCitationsInitialize(void)
387051e4cf2SJed Brown {
388051e4cf2SJed Brown   PetscErrorCode ierr;
389051e4cf2SJed Brown 
390051e4cf2SJed Brown   PetscFunctionBegin;
391051e4cf2SJed Brown   ierr = PetscSegBufferCreate(1,10000,&PetscCitationsList);CHKERRQ(ierr);
3920e50f9e5SSatish 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\n            and Lois Curfman McInnes and Karl Rupp and Barry F. Smith\n            and Stefano Zampini and Hong Zhang and Hong Zhang},\n  Title = {{PETS}c Users Manual},\n  Number = {ANL-95/11 - Revision 3.8},\n  Institution = {Argonne National Laboratory},\n  Year = {2017}\n}\n",NULL);CHKERRQ(ierr);
393051e4cf2SJed 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);
394051e4cf2SJed Brown   PetscFunctionReturn(0);
395051e4cf2SJed Brown }
396e5c89e4eSSatish Balay 
397e5c89e4eSSatish Balay /*@C
398e5c89e4eSSatish Balay    PetscGetArgs - Allows you to access the raw command line arguments anywhere
399e5c89e4eSSatish Balay      after PetscInitialize() is called but before PetscFinalize().
400e5c89e4eSSatish Balay 
401e5c89e4eSSatish Balay    Not Collective
402e5c89e4eSSatish Balay 
403e5c89e4eSSatish Balay    Output Parameters:
404e5c89e4eSSatish Balay +  argc - count of number of command line arguments
405e5c89e4eSSatish Balay -  args - the command line arguments
406e5c89e4eSSatish Balay 
407e5c89e4eSSatish Balay    Level: intermediate
408e5c89e4eSSatish Balay 
409e5c89e4eSSatish Balay    Notes:
410e5c89e4eSSatish Balay       This is usually used to pass the command line arguments into other libraries
411e5c89e4eSSatish Balay    that are called internally deep in PETSc or the application.
412e5c89e4eSSatish Balay 
413f177e3b1SBarry Smith       The first argument contains the program name as is normal for C arguments.
414f177e3b1SBarry Smith 
415e5c89e4eSSatish Balay    Concepts: command line arguments
416e5c89e4eSSatish Balay 
417793721a6SBarry Smith .seealso: PetscFinalize(), PetscInitializeFortran(), PetscGetArguments()
418e5c89e4eSSatish Balay 
419e5c89e4eSSatish Balay @*/
4207087cfbeSBarry Smith PetscErrorCode  PetscGetArgs(int *argc,char ***args)
421e5c89e4eSSatish Balay {
422e5c89e4eSSatish Balay   PetscFunctionBegin;
42317186662SBarry Smith   if (!PetscInitializeCalled && PetscFinalizeCalled) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ORDER,"You must call after PetscInitialize() but before PetscFinalize()");
424e5c89e4eSSatish Balay   *argc = PetscGlobalArgc;
425e5c89e4eSSatish Balay   *args = PetscGlobalArgs;
426e5c89e4eSSatish Balay   PetscFunctionReturn(0);
427e5c89e4eSSatish Balay }
428e5c89e4eSSatish Balay 
429793721a6SBarry Smith /*@C
430793721a6SBarry Smith    PetscGetArguments - Allows you to access the  command line arguments anywhere
431793721a6SBarry Smith      after PetscInitialize() is called but before PetscFinalize().
432793721a6SBarry Smith 
433793721a6SBarry Smith    Not Collective
434793721a6SBarry Smith 
435793721a6SBarry Smith    Output Parameters:
436793721a6SBarry Smith .  args - the command line arguments
437793721a6SBarry Smith 
438793721a6SBarry Smith    Level: intermediate
439793721a6SBarry Smith 
440793721a6SBarry Smith    Notes:
441793721a6SBarry Smith       This does NOT start with the program name and IS null terminated (final arg is void)
442793721a6SBarry Smith 
443793721a6SBarry Smith    Concepts: command line arguments
444793721a6SBarry Smith 
445793721a6SBarry Smith .seealso: PetscFinalize(), PetscInitializeFortran(), PetscGetArgs(), PetscFreeArguments()
446793721a6SBarry Smith 
447793721a6SBarry Smith @*/
4487087cfbeSBarry Smith PetscErrorCode  PetscGetArguments(char ***args)
449793721a6SBarry Smith {
450793721a6SBarry Smith   PetscInt       i,argc = PetscGlobalArgc;
451793721a6SBarry Smith   PetscErrorCode ierr;
452793721a6SBarry Smith 
453793721a6SBarry Smith   PetscFunctionBegin;
45417186662SBarry Smith   if (!PetscInitializeCalled && PetscFinalizeCalled) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ORDER,"You must call after PetscInitialize() but before PetscFinalize()");
455717030eeSLisandro Dalcin   if (!argc) {*args = 0; PetscFunctionReturn(0);}
456785e854fSJed Brown   ierr = PetscMalloc1(argc,args);CHKERRQ(ierr);
457793721a6SBarry Smith   for (i=0; i<argc-1; i++) {
458793721a6SBarry Smith     ierr = PetscStrallocpy(PetscGlobalArgs[i+1],&(*args)[i]);CHKERRQ(ierr);
459793721a6SBarry Smith   }
460793721a6SBarry Smith   (*args)[argc-1] = 0;
461793721a6SBarry Smith   PetscFunctionReturn(0);
462793721a6SBarry Smith }
463793721a6SBarry Smith 
464793721a6SBarry Smith /*@C
465793721a6SBarry Smith    PetscFreeArguments - Frees the memory obtained with PetscGetArguments()
466793721a6SBarry Smith 
467793721a6SBarry Smith    Not Collective
468793721a6SBarry Smith 
469793721a6SBarry Smith    Output Parameters:
470793721a6SBarry Smith .  args - the command line arguments
471793721a6SBarry Smith 
472793721a6SBarry Smith    Level: intermediate
473793721a6SBarry Smith 
474793721a6SBarry Smith    Concepts: command line arguments
475793721a6SBarry Smith 
476793721a6SBarry Smith .seealso: PetscFinalize(), PetscInitializeFortran(), PetscGetArgs(), PetscGetArguments()
477793721a6SBarry Smith 
478793721a6SBarry Smith @*/
4797087cfbeSBarry Smith PetscErrorCode  PetscFreeArguments(char **args)
480793721a6SBarry Smith {
481793721a6SBarry Smith   PetscInt       i = 0;
482793721a6SBarry Smith   PetscErrorCode ierr;
483793721a6SBarry Smith 
484793721a6SBarry Smith   PetscFunctionBegin;
485a297a907SKarl Rupp   if (!args) PetscFunctionReturn(0);
486793721a6SBarry Smith   while (args[i]) {
487793721a6SBarry Smith     ierr = PetscFree(args[i]);CHKERRQ(ierr);
488793721a6SBarry Smith     i++;
489793721a6SBarry Smith   }
490793721a6SBarry Smith   ierr = PetscFree(args);CHKERRQ(ierr);
491793721a6SBarry Smith   PetscFunctionReturn(0);
492793721a6SBarry Smith }
493793721a6SBarry Smith 
49411525c0dSBarry Smith #if defined(PETSC_HAVE_SAWS)
49530befbd2SBarry Smith #include <petscconfiginfo.h>
49630befbd2SBarry Smith 
49711525c0dSBarry Smith PetscErrorCode  PetscInitializeSAWs(const char help[])
49811525c0dSBarry Smith {
49911525c0dSBarry Smith   if (!PetscGlobalRank) {
50030befbd2SBarry Smith     char           cert[PETSC_MAX_PATH_LEN],root[PETSC_MAX_PATH_LEN],*intro,programname[64],*appline,*options,version[64];
50111525c0dSBarry Smith     int            port;
502ffbd1cfbSBarry Smith     PetscBool      flg,rootlocal = PETSC_FALSE,flg2,selectport = PETSC_FALSE;
50311525c0dSBarry Smith     size_t         applinelen,introlen;
50411525c0dSBarry Smith     PetscErrorCode ierr;
505ffbd1cfbSBarry Smith     char           sawsurl[256];
50611525c0dSBarry Smith 
507c5929fdfSBarry Smith     ierr = PetscOptionsHasName(NULL,NULL,"-saws_log",&flg);CHKERRQ(ierr);
50811525c0dSBarry Smith     if (flg) {
50911525c0dSBarry Smith       char  sawslog[PETSC_MAX_PATH_LEN];
51011525c0dSBarry Smith 
511c5929fdfSBarry Smith       ierr = PetscOptionsGetString(NULL,NULL,"-saws_log",sawslog,PETSC_MAX_PATH_LEN,NULL);CHKERRQ(ierr);
51211525c0dSBarry Smith       if (sawslog[0]) {
51311525c0dSBarry Smith         PetscStackCallSAWs(SAWs_Set_Use_Logfile,(sawslog));
51411525c0dSBarry Smith       } else {
51511525c0dSBarry Smith         PetscStackCallSAWs(SAWs_Set_Use_Logfile,(NULL));
51611525c0dSBarry Smith       }
51711525c0dSBarry Smith     }
518c5929fdfSBarry Smith     ierr = PetscOptionsGetString(NULL,NULL,"-saws_https",cert,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr);
51911525c0dSBarry Smith     if (flg) {
52011525c0dSBarry Smith       PetscStackCallSAWs(SAWs_Set_Use_HTTPS,(cert));
52111525c0dSBarry Smith     }
522c5929fdfSBarry Smith     ierr = PetscOptionsGetBool(NULL,NULL,"-saws_port_auto_select",&selectport,NULL);CHKERRQ(ierr);
523ffbd1cfbSBarry Smith     if (selectport) {
524ffbd1cfbSBarry Smith         PetscStackCallSAWs(SAWs_Get_Available_Port,(&port));
525ffbd1cfbSBarry Smith         PetscStackCallSAWs(SAWs_Set_Port,(port));
526ffbd1cfbSBarry Smith     } else {
527c5929fdfSBarry Smith       ierr = PetscOptionsGetInt(NULL,NULL,"-saws_port",&port,&flg);CHKERRQ(ierr);
52811525c0dSBarry Smith       if (flg) {
52911525c0dSBarry Smith         PetscStackCallSAWs(SAWs_Set_Port,(port));
53011525c0dSBarry Smith       }
531ffbd1cfbSBarry Smith     }
532c5929fdfSBarry Smith     ierr = PetscOptionsGetString(NULL,NULL,"-saws_root",root,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr);
53311525c0dSBarry Smith     if (flg) {
53411525c0dSBarry Smith       PetscStackCallSAWs(SAWs_Set_Document_Root,(root));CHKERRQ(ierr);
53511525c0dSBarry Smith       ierr = PetscStrcmp(root,".",&rootlocal);CHKERRQ(ierr);
5369c1e0ce8SBarry Smith     } else {
537c5929fdfSBarry Smith       ierr = PetscOptionsHasName(NULL,NULL,"-saws_options",&flg);CHKERRQ(ierr);
5389c1e0ce8SBarry Smith       if (flg) {
5393c01dfcfSBarry Smith         ierr = PetscStrreplace(PETSC_COMM_WORLD,"${PETSC_DIR}/share/petsc/saws",root,PETSC_MAX_PATH_LEN);CHKERRQ(ierr);
5409c1e0ce8SBarry Smith         PetscStackCallSAWs(SAWs_Set_Document_Root,(root));CHKERRQ(ierr);
5419c1e0ce8SBarry Smith       }
54211525c0dSBarry Smith     }
543c5929fdfSBarry Smith     ierr = PetscOptionsHasName(NULL,NULL,"-saws_local",&flg2);CHKERRQ(ierr);
54411525c0dSBarry Smith     if (flg2) {
54511525c0dSBarry Smith       char jsdir[PETSC_MAX_PATH_LEN];
54611525c0dSBarry Smith       if (!flg) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SUP,"-saws_local option requires -saws_root option");
54711525c0dSBarry Smith       ierr = PetscSNPrintf(jsdir,PETSC_MAX_PATH_LEN,"%s/js",root);CHKERRQ(ierr);
54811525c0dSBarry Smith       ierr = PetscTestDirectory(jsdir,'r',&flg);CHKERRQ(ierr);
54911525c0dSBarry Smith       if (!flg) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_FILE_READ,"-saws_local option requires js directory in root directory");
55043da4ab2SBarry Smith       PetscStackCallSAWs(SAWs_Push_Local_Header,());CHKERRQ(ierr);
55111525c0dSBarry Smith     }
55211525c0dSBarry Smith     ierr = PetscGetProgramName(programname,64);CHKERRQ(ierr);
55311525c0dSBarry Smith     ierr = PetscStrlen(help,&applinelen);CHKERRQ(ierr);
55411525c0dSBarry Smith     introlen   = 4096 + applinelen;
55530a8c9c0SSurtai Han     applinelen += 1024;
55611525c0dSBarry Smith     ierr = PetscMalloc(applinelen,&appline);CHKERRQ(ierr);
55711525c0dSBarry Smith     ierr = PetscMalloc(introlen,&intro);CHKERRQ(ierr);
55811525c0dSBarry Smith 
55911525c0dSBarry Smith     if (rootlocal) {
56011525c0dSBarry Smith       ierr = PetscSNPrintf(appline,applinelen,"%s.c.html",programname);CHKERRQ(ierr);
56111525c0dSBarry Smith       ierr = PetscTestFile(appline,'r',&rootlocal);CHKERRQ(ierr);
56211525c0dSBarry Smith     }
56376a34f28SBarry Smith     ierr = PetscOptionsGetAll(NULL,&options);CHKERRQ(ierr);
56411525c0dSBarry Smith     if (rootlocal && help) {
56530befbd2SBarry 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);
56611525c0dSBarry Smith     } else if (help) {
56730a8c9c0SSurtai Han       ierr = PetscSNPrintf(appline,applinelen,"<center>Running %s %s</center><br><center><pre>%s</pre></center><br>",programname,options,help);
56811525c0dSBarry Smith     } else {
56930befbd2SBarry Smith       ierr = PetscSNPrintf(appline,applinelen,"<center> Running %s %s</center><br>\n",programname,options);
57011525c0dSBarry Smith     }
571b0bb5815SBarry Smith     ierr = PetscFree(options);CHKERRQ(ierr);
57230befbd2SBarry Smith     ierr = PetscGetVersion(version,sizeof(version));CHKERRQ(ierr);
57311525c0dSBarry Smith     ierr = PetscSNPrintf(intro,introlen,"<body>\n"
57411525c0dSBarry 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"
575df62c222SBarry 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"
576df62c222SBarry Smith                                     "%s",version,petscconfigureoptions,appline);
57743da4ab2SBarry Smith     PetscStackCallSAWs(SAWs_Push_Body,("index.html",0,intro));
57811525c0dSBarry Smith     ierr = PetscFree(intro);CHKERRQ(ierr);
57911525c0dSBarry Smith     ierr = PetscFree(appline);CHKERRQ(ierr);
580ffbd1cfbSBarry Smith     if (selectport) {
581aa573868SBarry Smith       PetscBool silent;
5827d812c46SBarry Smith 
5837d812c46SBarry Smith       ierr = SAWs_Initialize();
5847d812c46SBarry Smith       /* another process may have grabbed the port so keep trying */
5857d812c46SBarry Smith       while (ierr) {
5867d812c46SBarry Smith         PetscStackCallSAWs(SAWs_Get_Available_Port,(&port));
5877d812c46SBarry Smith         PetscStackCallSAWs(SAWs_Set_Port,(port));
5887d812c46SBarry Smith         ierr = SAWs_Initialize();
5897d812c46SBarry Smith       }
5907d812c46SBarry Smith 
591aa573868SBarry Smith       ierr = PetscOptionsGetBool(NULL,NULL,"-saws_port_auto_select_silent",&silent,NULL);CHKERRQ(ierr);
592aa573868SBarry Smith       if (!silent) {
593ffbd1cfbSBarry Smith         PetscStackCallSAWs(SAWs_Get_FullURL,(sizeof(sawsurl),sawsurl));
594ffbd1cfbSBarry Smith         ierr = PetscPrintf(PETSC_COMM_WORLD,"Point your browser to %s for SAWs\n",sawsurl);CHKERRQ(ierr);
595ffbd1cfbSBarry Smith       }
5967d812c46SBarry Smith     } else {
5977d812c46SBarry Smith       PetscStackCallSAWs(SAWs_Initialize,());
598aa573868SBarry Smith     }
5990af79b04SBarry Smith     ierr = PetscCitationsRegister("@TechReport{ saws,\n"
6000af79b04SBarry Smith                                   "  Author = {Matt Otten and Jed Brown and Barry Smith},\n"
6010af79b04SBarry Smith                                   "  Title  = {Scientific Application Web Server (SAWs) Users Manual},\n"
6020af79b04SBarry Smith                                   "  Institution = {Argonne National Laboratory},\n"
6030af79b04SBarry Smith                                   "  Year   = 2013\n}\n",NULL);CHKERRQ(ierr);
60411525c0dSBarry Smith   }
60511525c0dSBarry Smith   PetscFunctionReturn(0);
60611525c0dSBarry Smith }
60711525c0dSBarry Smith #endif
60811525c0dSBarry Smith 
609e5c89e4eSSatish Balay /*@C
610e5c89e4eSSatish Balay    PetscInitialize - Initializes the PETSc database and MPI.
611e5c89e4eSSatish Balay    PetscInitialize() calls MPI_Init() if that has yet to be called,
612e5c89e4eSSatish Balay    so this routine should always be called near the beginning of
613e5c89e4eSSatish Balay    your program -- usually the very first line!
614e5c89e4eSSatish Balay 
615e5c89e4eSSatish Balay    Collective on MPI_COMM_WORLD or PETSC_COMM_WORLD if it has been set
616e5c89e4eSSatish Balay 
617e5c89e4eSSatish Balay    Input Parameters:
618e5c89e4eSSatish Balay +  argc - count of number of command line arguments
619e5c89e4eSSatish Balay .  args - the command line arguments
6200298fd71SBarry Smith .  file - [optional] PETSc database file, also checks ~username/.petscrc and .petscrc use NULL to not check for
621fc2bca9aSBarry Smith           code specific file. Use -skip_petscrc in the code specific file to skip the .petscrc files
6220298fd71SBarry Smith -  help - [optional] Help message to print, use NULL for no message
623e5c89e4eSSatish Balay 
62405827820SBarry Smith    If you wish PETSc code to run ONLY on a subcommunicator of MPI_COMM_WORLD, create that
62505827820SBarry Smith    communicator first and assign it to PETSC_COMM_WORLD BEFORE calling PetscInitialize(). Thus if you are running a
62605827820SBarry Smith    four process job and two processes will run PETSc and have PetscInitialize() and PetscFinalize() and two process will not,
62705827820SBarry Smith    then do this. If ALL processes in the job are using PetscInitialize() and PetscFinalize() then you don't need to do this, even
62805827820SBarry Smith    if different subcommunicators of the job are doing different things with PETSc.
629e5c89e4eSSatish Balay 
630e5c89e4eSSatish Balay    Options Database Keys:
6317ca660e7SBarry Smith +  -help [intro] - prints help method for each option; if intro is given the program stops after printing the introductory help message
6327ca660e7SBarry Smith .  -start_in_debugger [noxterm,dbx,xdb,gdb,...] - Starts program in debugger
633e5c89e4eSSatish Balay .  -on_error_attach_debugger [noxterm,dbx,xdb,gdb,...] - Starts debugger when error detected
634e5c89e4eSSatish Balay .  -on_error_emacs <machinename> causes emacsclient to jump to error file
635b52f573bSBarry Smith .  -on_error_abort calls abort() when error detected (no traceback)
636e8fb0fc0SBarry Smith .  -on_error_mpiabort calls MPI_abort() when error detected
637e8fb0fc0SBarry Smith .  -error_output_stderr prints error messages to stderr instead of the default stdout
638e8fb0fc0SBarry Smith .  -error_output_none does not print the error messages (but handles errors in the same way as if this was not called)
639e5c89e4eSSatish Balay .  -debugger_nodes [node1,node2,...] - Indicates nodes to start in debugger
640e5c89e4eSSatish Balay .  -debugger_pause [sleeptime] (in seconds) - Pauses debugger
641e5c89e4eSSatish Balay .  -stop_for_debugger - Print message on how to attach debugger manually to
642e5c89e4eSSatish Balay                         process and wait (-debugger_pause) seconds for attachment
6432fb0ec9aSBarry Smith .  -malloc - Indicates use of PETSc error-checking malloc (on by default for debug version of libraries)
644e5c89e4eSSatish Balay .  -malloc no - Indicates not to use error-checking malloc
6452fb0ec9aSBarry Smith .  -malloc_debug - check for memory corruption at EVERY malloc or free
646aee23540SBarry Smith .  -malloc_dump - prints a list of all unfreed memory at the end of the run
647dc92acbaSJed Brown .  -malloc_test - like -malloc_dump -malloc_debug, but only active for debugging builds
648e5c89e4eSSatish Balay .  -fp_trap - Stops on floating point exceptions (Note that on the
649e5c89e4eSSatish Balay               IBM RS6000 this slows code by at least a factor of 10.)
650e5c89e4eSSatish Balay .  -no_signal_handler - Indicates not to trap error signals
651e5c89e4eSSatish Balay .  -shared_tmp - indicates /tmp directory is shared by all processors
652e5c89e4eSSatish Balay .  -not_shared_tmp - each processor has own /tmp
653e5c89e4eSSatish Balay .  -tmp - alternative name of /tmp directory
654e5c89e4eSSatish Balay .  -get_total_flops - returns total flops done by all processors
6550841954dSBarry Smith -  -memory_view - Print memory usage at end of run
656e5c89e4eSSatish Balay 
657e5c89e4eSSatish Balay    Options Database Keys for Profiling:
658a7f22e61SSatish Balay    See Users-Manual: ch_profiling for details.
659495fc317SBarry Smith +  -info <optional filename> - Prints verbose information to the screen
660495fc317SBarry Smith .  -info_exclude <null,vec,mat,pc,ksp,snes,ts> - Excludes some of the verbose messages
661495fc317SBarry Smith .  -log_sync - Log the synchronization in scatters, inner products and norms
662495fc317SBarry Smith .  -log_trace [filename] - Print traces of all PETSc calls to the screen (useful to determine where a program
663e5c89e4eSSatish Balay         hangs without running in the debugger).  See PetscLogTraceBegin().
6649a9a5d4cSBarry Smith .  -log_view [:filename:format] - Prints summary of flop and timing information to screen or file, see PetscLogView().
6659a9a5d4cSBarry Smith .  -log_summary [filename] - (Deprecated, use -log_view) Prints summary of flop and timing information to screen. If the filename is specified the
666495fc317SBarry Smith         summary is written to the file.  See PetscLogView().
6679a9a5d4cSBarry Smith .  -log_exclude: <vec,mat,pc.ksp,snes> - excludes subset of object classes from logging
668495fc317SBarry Smith .  -log_all [filename] - Logs extensive profiling information  See PetscLogDump().
669495fc317SBarry Smith .  -log [filename] - Logs basic profiline information  See PetscLogDump().
670495fc317SBarry Smith -  -log_mpe [filename] - Creates a logfile viewable by the utility Jumpshot (in MPICH distribution)
671495fc317SBarry Smith 
672609bdbeeSBarry Smith     Only one of -log_trace, -log_view, -log_view, -log_all, -log, or -log_mpe may be used at a time
673e5c89e4eSSatish Balay 
674ffbd1cfbSBarry Smith    Options Database Keys for SAWs:
675ffbd1cfbSBarry Smith +  -saws_port <portnumber> - port number to publish SAWs data, default is 8080
676ffbd1cfbSBarry 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
677ffbd1cfbSBarry Smith                             this is useful when you are running many jobs that utilize SAWs at the same time
678ffbd1cfbSBarry Smith .  -saws_log <filename> - save a log of all SAWs communication
679ffbd1cfbSBarry Smith .  -saws_https <certificate file> - have SAWs use HTTPS instead of HTTP
680ffbd1cfbSBarry Smith -  -saws_root <directory> - allow SAWs to have access to the given directory to search for requested resources and files
681ffbd1cfbSBarry Smith 
682e5c89e4eSSatish Balay    Environmental Variables:
683e5c89e4eSSatish Balay +   PETSC_TMP - alternative tmp directory
684e5c89e4eSSatish Balay .   PETSC_SHARED_TMP - tmp is shared by all processes
685e5c89e4eSSatish Balay .   PETSC_NOT_SHARED_TMP - each process has its own private tmp
686e5c89e4eSSatish Balay .   PETSC_VIEWER_SOCKET_PORT - socket number to use for socket viewer
687e5c89e4eSSatish Balay -   PETSC_VIEWER_SOCKET_MACHINE - machine to use for socket viewer to connect to
688e5c89e4eSSatish Balay 
689e5c89e4eSSatish Balay 
690e5c89e4eSSatish Balay    Level: beginner
691e5c89e4eSSatish Balay 
692e5c89e4eSSatish Balay    Notes:
693e5c89e4eSSatish Balay    If for some reason you must call MPI_Init() separately, call
694e5c89e4eSSatish Balay    it before PetscInitialize().
695e5c89e4eSSatish Balay 
696e5c89e4eSSatish Balay    Fortran Version:
697e5c89e4eSSatish Balay    In Fortran this routine has the format
698e5c89e4eSSatish Balay $       call PetscInitialize(file,ierr)
699e5c89e4eSSatish Balay 
700e5c89e4eSSatish Balay +   ierr - error return code
7010eb4c9c0SBarry Smith -  file - [optional] PETSc database file, also checks ~username/.petscrc and .petscrc use PETSC_NULL_CHARACTER to not check for
702fc2bca9aSBarry Smith           code specific file. Use -skip_petscrc in the code specific file to skip the .petscrc files
703e5c89e4eSSatish Balay 
704e5c89e4eSSatish Balay    Important Fortran Note:
7050eb4c9c0SBarry Smith    In Fortran, you MUST use PETSC_NULL_CHARACTER to indicate a
7060298fd71SBarry Smith    null character string; you CANNOT just use NULL as
707a7f22e61SSatish Balay    in the C version. See Users-Manual: ch_fortran for details.
708e5c89e4eSSatish Balay 
70901cb0274SBarry Smith    If your main program is C but you call Fortran code that also uses PETSc you need to call PetscInitializeFortran() soon after
71001cb0274SBarry Smith    calling PetscInitialize().
711e5c89e4eSSatish Balay 
712e5c89e4eSSatish Balay    Concepts: initializing PETSc
713e5c89e4eSSatish Balay 
71401cb0274SBarry Smith .seealso: PetscFinalize(), PetscInitializeFortran(), PetscGetArgs(), PetscInitializeNoArguments()
715e5c89e4eSSatish Balay 
716e5c89e4eSSatish Balay @*/
7177087cfbeSBarry Smith PetscErrorCode  PetscInitialize(int *argc,char ***args,const char file[],const char help[])
718e5c89e4eSSatish Balay {
719e5c89e4eSSatish Balay   PetscErrorCode ierr;
7204bb5149bSJed Brown   PetscMPIInt    flag, size;
72119c5658aSBarry Smith   PetscBool      flg = PETSC_TRUE;
722e5c89e4eSSatish Balay   char           hostname[256];
72382f73ecaSAlejandro Lamas Daviña #if defined(PETSC_HAVE_CUDA)
72482f73ecaSAlejandro Lamas Daviña   cublasStatus_t cberr;
72582f73ecaSAlejandro Lamas Daviña #endif
7265e71baefSBarry Smith #if defined(PETSC_HAVE_HWLOC)
7275e71baefSBarry Smith   PetscViewer    viewer;
7285e71baefSBarry Smith #endif
729e5c89e4eSSatish Balay 
730e5c89e4eSSatish Balay   PetscFunctionBegin;
731e5c89e4eSSatish Balay   if (PetscInitializeCalled) PetscFunctionReturn(0);
7323d96e996SBarry Smith   /*
7333d96e996SBarry Smith       The checking over compatible runtime libraries is complicated by the MPI ABI initiative
7343d96e996SBarry Smith       https://wiki.mpich.org/mpich/index.php/ABI_Compatibility_Initiative which started with
7353d96e996SBarry Smith         MPICH v3.1 (Released Feburary 2014)
7363d96e996SBarry Smith         IBM MPI v2.1 (December 2014)
7373d96e996SBarry Smith         Intel® MPI Library v5.0 (2014)
7383d96e996SBarry Smith         Cray MPT v7.0.0 (June 2014)
7393d96e996SBarry Smith       As of July 31, 2017 the ABI number still appears to be 12, that is all of the versions
7403d96e996SBarry Smith       listed above and since that time are compatible.
7413d96e996SBarry Smith 
7423d96e996SBarry Smith       Unfortunately the MPI ABI initiative has not defined a way to determine the ABI number
7433d96e996SBarry Smith       at compile time or runtime. Thus we will need to systematically track the allowed versions
7443d96e996SBarry Smith       and how they are represented in the mpi.h and MPI_Get_library_version() output in order
7453d96e996SBarry Smith       to perform the checking.
7463d96e996SBarry Smith 
7473d96e996SBarry Smith       Currently we only check for pre MPI ABI versions (and packages that do not follow the MPI ABI).
7483d96e996SBarry Smith 
7493d96e996SBarry Smith       Questions:
7503d96e996SBarry Smith 
7513d96e996SBarry Smith         Should the checks for ABI incompatibility be only on the major version number below?
7523d96e996SBarry Smith         Presumably the output to stderr will be removed before a release.
7533d96e996SBarry Smith   */
7543d96e996SBarry Smith 
75519c5658aSBarry Smith #if defined(PETSC_HAVE_MPI_GET_LIBRARY_VERSION)
75619c5658aSBarry Smith   {
75719c5658aSBarry Smith     char        mpilibraryversion[MPI_MAX_LIBRARY_VERSION_STRING];
75819c5658aSBarry Smith     PetscMPIInt mpilibraryversionlength;
75919c5658aSBarry Smith     ierr = MPI_Get_library_version(mpilibraryversion,&mpilibraryversionlength);if (ierr) return ierr;
7603d96e996SBarry Smith     /* check for MPICH versions before MPI ABI initiative */
76119c5658aSBarry Smith #if defined(MPICH_VERSION)
7623d96e996SBarry Smith #if MPICH_NUMVERSION < 30100000
76319c5658aSBarry Smith     {
76419c5658aSBarry Smith       char *ver,*lf;
76519c5658aSBarry Smith       flg = PETSC_FALSE;
76619c5658aSBarry Smith       ierr = PetscStrstr(mpilibraryversion,"MPICH Version:",&ver);if (ierr) return ierr;
76719c5658aSBarry Smith       if (ver) {
76819c5658aSBarry Smith         ierr = PetscStrchr(ver,'\n',&lf);if (ierr) return ierr;
76919c5658aSBarry Smith         if (lf) {
77019c5658aSBarry Smith           *lf = 0;
77119c5658aSBarry Smith           ierr = PetscStrendswith(ver,MPICH_VERSION,&flg);if (ierr) return ierr;
77219c5658aSBarry Smith         }
77319c5658aSBarry Smith       }
77419c5658aSBarry Smith       if (!flg) {
77519c5658aSBarry Smith         fprintf(stderr,"PETSc Error --- MPICH library version \n%s does not match what PETSc was compiled with %s, aborting\n",mpilibraryversion,MPICH_VERSION);
7763d96e996SBarry Smith         return PETSC_ERR_MPI_LIB_INCOMP;
77719c5658aSBarry Smith       }
77819c5658aSBarry Smith     }
7793d96e996SBarry Smith #endif
7803d96e996SBarry Smith     /* check for OpenMPI version, it is not part of the MPI ABI initiative (is it part of another initiative that needs to be handled?) */
78119c5658aSBarry Smith #elif defined(OMPI_MAJOR_VERSION)
78219c5658aSBarry Smith     {
78319c5658aSBarry Smith       char *ver,bs[32],*bsf;
78419c5658aSBarry Smith       flg = PETSC_FALSE;
78519c5658aSBarry Smith       ierr = PetscStrstr(mpilibraryversion,"Open MPI",&ver);if (ierr) return ierr;
78619c5658aSBarry Smith       if (ver) {
78719c5658aSBarry Smith         sprintf(bs,"v%d.%d",OMPI_MAJOR_VERSION,OMPI_MINOR_VERSION);
78819c5658aSBarry Smith         ierr = PetscStrstr(ver,bs,&bsf);if (ierr) return ierr;
78919c5658aSBarry Smith         if (bsf) flg = PETSC_TRUE;
79019c5658aSBarry Smith       }
79119c5658aSBarry Smith       if (!flg) {
79219c5658aSBarry Smith         fprintf(stderr,"PETSc Error --- Open MPI library version \n%s does not match what PETSc was compiled with %d.%d, aborting\n",mpilibraryversion,OMPI_MAJOR_VERSION,OMPI_MINOR_VERSION);
7933d96e996SBarry Smith         return PETSC_ERR_MPI_LIB_INCOMP;
79419c5658aSBarry Smith       }
79519c5658aSBarry Smith     }
79619c5658aSBarry Smith #endif
79719c5658aSBarry Smith   }
79819c5658aSBarry Smith #endif
79919c5658aSBarry Smith 
800e5c89e4eSSatish Balay 
801ae9b4142SLisandro Dalcin   /* these must be initialized in a routine, not as a constant declaration*/
802d89683f4Sbcordonn   PETSC_STDOUT = stdout;
803ae9b4142SLisandro Dalcin   PETSC_STDERR = stderr;
804e5c89e4eSSatish Balay 
8050c30907bSSatish Balay   /* on Windows - set printf to default to printing 2 digit exponents */
8060c30907bSSatish Balay #if defined(PETSC_HAVE__SET_OUTPUT_FORMAT)
8070c30907bSSatish Balay   _set_output_format(_TWO_DIGIT_EXPONENT);
8080c30907bSSatish Balay #endif
8090c30907bSSatish Balay 
8104416b707SBarry Smith   ierr = PetscOptionsCreateDefault();CHKERRQ(ierr);
811e5c89e4eSSatish Balay 
812e5c89e4eSSatish Balay   /*
813e5c89e4eSSatish Balay      We initialize the program name here (before MPI_Init()) because MPICH has a bug in
814e5c89e4eSSatish Balay      it that it sets args[0] on all processors to be args[0] on the first processor.
815e5c89e4eSSatish Balay   */
816e5c89e4eSSatish Balay   if (argc && *argc) {
817e5c89e4eSSatish Balay     ierr = PetscSetProgramName(**args);CHKERRQ(ierr);
818e5c89e4eSSatish Balay   } else {
819e5c89e4eSSatish Balay     ierr = PetscSetProgramName("Unknown Name");CHKERRQ(ierr);
820e5c89e4eSSatish Balay   }
821e5c89e4eSSatish Balay 
822e5c89e4eSSatish Balay   ierr = MPI_Initialized(&flag);CHKERRQ(ierr);
823e5c89e4eSSatish Balay   if (!flag) {
824e32f2f54SBarry Smith     if (PETSC_COMM_WORLD != MPI_COMM_NULL) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SUP,"You cannot set PETSC_COMM_WORLD if you have not initialized MPI first");
8255e765c61SJed Brown #if defined(PETSC_HAVE_MPI_INIT_THREAD)
8265e765c61SJed Brown     {
8275e765c61SJed Brown       PetscMPIInt provided;
8285e765c61SJed Brown       ierr = MPI_Init_thread(argc,args,MPI_THREAD_FUNNELED,&provided);CHKERRQ(ierr);
8295e765c61SJed Brown     }
8305e765c61SJed Brown #else
831e5c89e4eSSatish Balay     ierr = MPI_Init(argc,args);CHKERRQ(ierr);
8325e765c61SJed Brown #endif
833e5c89e4eSSatish Balay     PetscBeganMPI = PETSC_TRUE;
834e5c89e4eSSatish Balay   }
835e5c89e4eSSatish Balay   if (argc && args) {
836e5c89e4eSSatish Balay     PetscGlobalArgc = *argc;
837e5c89e4eSSatish Balay     PetscGlobalArgs = *args;
838e5c89e4eSSatish Balay   }
839e5c89e4eSSatish Balay   PetscFinalizeCalled = PETSC_FALSE;
8405ad9ad5bSBarry Smith   ierr = PetscSpinlockCreate(&PetscViewerASCIISpinLockOpen);CHKERRQ(ierr);
8415ad9ad5bSBarry Smith   ierr = PetscSpinlockCreate(&PetscViewerASCIISpinLockStdout);CHKERRQ(ierr);
8425ad9ad5bSBarry Smith   ierr = PetscSpinlockCreate(&PetscViewerASCIISpinLockStderr);CHKERRQ(ierr);
843ef19f930SBarry Smith   ierr = PetscSpinlockCreate(&PetscCommSpinLock);CHKERRQ(ierr);
844e5c89e4eSSatish Balay 
845a297a907SKarl Rupp   if (PETSC_COMM_WORLD == MPI_COMM_NULL) PETSC_COMM_WORLD = MPI_COMM_WORLD;
846d54338ecSKarl Rupp   ierr = MPI_Comm_set_errhandler(PETSC_COMM_WORLD,MPI_ERRORS_RETURN);CHKERRQ(ierr);
847e5c89e4eSSatish Balay 
848e5c89e4eSSatish Balay   /* Done after init due to a bug in MPICH-GM? */
849e5c89e4eSSatish Balay   ierr = PetscErrorPrintfInitialize();CHKERRQ(ierr);
850e5c89e4eSSatish Balay 
851e5c89e4eSSatish Balay   ierr = MPI_Comm_rank(MPI_COMM_WORLD,&PetscGlobalRank);CHKERRQ(ierr);
852e5c89e4eSSatish Balay   ierr = MPI_Comm_size(MPI_COMM_WORLD,&PetscGlobalSize);CHKERRQ(ierr);
853e5c89e4eSSatish Balay 
8548ad47952SJed Brown   MPIU_BOOL = MPI_INT;
8558ad47952SJed Brown   MPIU_ENUM = MPI_INT;
8568ad47952SJed Brown 
857e5c89e4eSSatish Balay   /*
858e5c89e4eSSatish Balay      Initialized the global complex variable; this is because with
859e5c89e4eSSatish Balay      shared libraries the constructors for global variables
860e5c89e4eSSatish Balay      are not called; at least on IRIX.
861e5c89e4eSSatish Balay   */
862886cfec0SSatish Balay #if defined(PETSC_HAVE_COMPLEX)
863e5c89e4eSSatish Balay   {
864252ecd31SSatish Balay #if defined(PETSC_CLANGUAGE_CXX) && !defined(PETSC_USE_REAL___FLOAT128)
86550f81f78SJed Brown     PetscComplex ic(0.0,1.0);
866e5c89e4eSSatish Balay     PETSC_i = ic;
867252ecd31SSatish Balay #else
86850f81f78SJed Brown     PETSC_i = _Complex_I;
869b7940d39SSatish Balay #endif
870762437b8SSatish Balay   }
871762437b8SSatish Balay 
8722c876bd9SBarry Smith #if !defined(PETSC_HAVE_MPI_C_DOUBLE_COMPLEX)
873e69cd0e6SSatish Balay   ierr = MPI_Type_contiguous(2,MPI_DOUBLE,&MPIU_C_DOUBLE_COMPLEX);CHKERRQ(ierr);
874500d8756SSatish Balay   ierr = MPI_Type_commit(&MPIU_C_DOUBLE_COMPLEX);CHKERRQ(ierr);
875500d8756SSatish Balay   ierr = MPI_Type_contiguous(2,MPI_FLOAT,&MPIU_C_COMPLEX);CHKERRQ(ierr);
876500d8756SSatish Balay   ierr = MPI_Type_commit(&MPIU_C_COMPLEX);CHKERRQ(ierr);
8772c876bd9SBarry Smith #endif
878886cfec0SSatish Balay #endif /* PETSC_HAVE_COMPLEX */
879e5c89e4eSSatish Balay 
880e5c89e4eSSatish Balay   /*
881e5c89e4eSSatish Balay      Create the PETSc MPI reduction operator that sums of the first
882e5c89e4eSSatish Balay      half of the entries and maxes the second half.
883e5c89e4eSSatish Balay   */
884367daffbSBarry Smith   ierr = MPI_Op_create(MPIU_MaxSum_Local,1,&MPIU_MAXSUM_OP);CHKERRQ(ierr);
885e5c89e4eSSatish Balay 
886ce63c4c1SBarry Smith #if defined(PETSC_USE_REAL___FLOAT128)
887c90a1750SBarry Smith   ierr = MPI_Type_contiguous(2,MPI_DOUBLE,&MPIU___FLOAT128);CHKERRQ(ierr);
888c90a1750SBarry Smith   ierr = MPI_Type_commit(&MPIU___FLOAT128);CHKERRQ(ierr);
8897c2de775SJed Brown #if defined(PETSC_HAVE_COMPLEX)
8908c764dc5SJose Roman   ierr = MPI_Type_contiguous(4,MPI_DOUBLE,&MPIU___COMPLEX128);CHKERRQ(ierr);
8918c764dc5SJose Roman   ierr = MPI_Type_commit(&MPIU___COMPLEX128);CHKERRQ(ierr);
8928c764dc5SJose Roman #endif
893d9822059SBarry Smith   ierr = MPI_Op_create(PetscMax_Local,1,&MPIU_MAX);CHKERRQ(ierr);
894d9822059SBarry Smith   ierr = MPI_Op_create(PetscMin_Local,1,&MPIU_MIN);CHKERRQ(ierr);
895570b7f6dSBarry Smith #elif defined(PETSC_USE_REAL___FP16)
896570b7f6dSBarry Smith   ierr = MPI_Type_contiguous(2,MPI_CHAR,&MPIU___FP16);CHKERRQ(ierr);
897570b7f6dSBarry Smith   ierr = MPI_Type_commit(&MPIU___FP16);CHKERRQ(ierr);
898570b7f6dSBarry Smith   ierr = MPI_Op_create(PetscMax_Local,1,&MPIU_MAX);CHKERRQ(ierr);
899570b7f6dSBarry Smith   ierr = MPI_Op_create(PetscMin_Local,1,&MPIU_MIN);CHKERRQ(ierr);
900c90a1750SBarry Smith #endif
901c90a1750SBarry Smith 
902570b7f6dSBarry Smith #if (defined(PETSC_HAVE_COMPLEX) && !defined(PETSC_HAVE_MPI_C_DOUBLE_COMPLEX)) || defined(PETSC_USE_REAL___FLOAT128) || defined(PETSC_USE_REAL___FP16)
903cca4cb22SSatish Balay   ierr = MPI_Op_create(PetscSum_Local,1,&MPIU_SUM);CHKERRQ(ierr);
904cca4cb22SSatish Balay #endif
905cca4cb22SSatish Balay 
906e5c89e4eSSatish Balay   ierr = MPI_Type_contiguous(2,MPIU_SCALAR,&MPIU_2SCALAR);CHKERRQ(ierr);
907e5c89e4eSSatish Balay   ierr = MPI_Type_commit(&MPIU_2SCALAR);CHKERRQ(ierr);
908e5c89e4eSSatish Balay 
90944041f26SJed Brown #if defined(PETSC_USE_64BIT_INDICES) || !defined(MPI_2INT)
910e5c89e4eSSatish Balay   ierr = MPI_Type_contiguous(2,MPIU_INT,&MPIU_2INT);CHKERRQ(ierr);
911e5c89e4eSSatish Balay   ierr = MPI_Type_commit(&MPIU_2INT);CHKERRQ(ierr);
91244041f26SJed Brown #endif
913e5c89e4eSSatish Balay 
914ec957eceSBarry Smith 
915e5c89e4eSSatish Balay   /*
916480cf27aSJed Brown      Attributes to be set on PETSc communicators
917480cf27aSJed Brown   */
918480cf27aSJed Brown   ierr = MPI_Keyval_create(MPI_NULL_COPY_FN,Petsc_DelCounter,&Petsc_Counter_keyval,(void*)0);CHKERRQ(ierr);
919da3039f7SJed Brown   ierr = MPI_Keyval_create(MPI_NULL_COPY_FN,Petsc_DelComm_Outer,&Petsc_InnerComm_keyval,(void*)0);CHKERRQ(ierr);
920da3039f7SJed Brown   ierr = MPI_Keyval_create(MPI_NULL_COPY_FN,Petsc_DelComm_Inner,&Petsc_OuterComm_keyval,(void*)0);CHKERRQ(ierr);
92142218b76SBarry Smith   ierr = MPI_Keyval_create(MPI_NULL_COPY_FN,Petsc_DelShared,&Petsc_Shared_keyval,(void*)0);CHKERRQ(ierr);
922480cf27aSJed Brown 
923480cf27aSJed Brown   /*
924e8fb0fc0SBarry Smith      Build the options database
925e5c89e4eSSatish Balay   */
926c5929fdfSBarry Smith   ierr = PetscOptionsInsert(NULL,argc,args,file);CHKERRQ(ierr);
927e5c89e4eSSatish Balay 
9286dc8fec2Sbcordonn 
929e5c89e4eSSatish Balay   /*
930e5c89e4eSSatish Balay      Print main application help message
931e5c89e4eSSatish Balay   */
932c5929fdfSBarry Smith   ierr = PetscOptionsHasName(NULL,NULL,"-help",&flg);CHKERRQ(ierr);
933e5c89e4eSSatish Balay   if (help && flg) {
934e5c89e4eSSatish Balay     ierr = PetscPrintf(PETSC_COMM_WORLD,help);CHKERRQ(ierr);
935e5c89e4eSSatish Balay   }
936e5c89e4eSSatish Balay   ierr = PetscOptionsCheckInitial_Private();CHKERRQ(ierr);
937e5c89e4eSSatish Balay 
938d45a07a7SBarry Smith   ierr = PetscCitationsInitialize();CHKERRQ(ierr);
939d45a07a7SBarry Smith 
940e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS)
94111525c0dSBarry Smith   ierr = PetscInitializeSAWs(help);CHKERRQ(ierr);
942f4202a44SBarry Smith #endif
943f4202a44SBarry Smith 
944896238b9SBarry Smith   /* Creates the logging data structures; this is enabled even if logging is not turned on */
945a9f03627SSatish Balay #if defined(PETSC_USE_LOG)
946896238b9SBarry Smith   ierr = PetscLogInitialize();CHKERRQ(ierr);
947a9f03627SSatish Balay #endif
948e5c89e4eSSatish Balay 
949e5c89e4eSSatish Balay   /*
950e5c89e4eSSatish Balay      Load the dynamic libraries (on machines that support them), this registers all
951e5c89e4eSSatish Balay      the solvers etc. (On non-dynamic machines this initializes the PetscDraw and PetscViewer classes)
952e5c89e4eSSatish Balay   */
953e5c89e4eSSatish Balay   ierr = PetscInitialize_DynamicLibraries();CHKERRQ(ierr);
954e5c89e4eSSatish Balay 
955e5c89e4eSSatish Balay   ierr = MPI_Comm_size(PETSC_COMM_WORLD,&size);CHKERRQ(ierr);
956ae15b995SBarry Smith   ierr = PetscInfo1(0,"PETSc successfully started: number of processors = %d\n",size);CHKERRQ(ierr);
957e5c89e4eSSatish Balay   ierr = PetscGetHostName(hostname,256);CHKERRQ(ierr);
958ae15b995SBarry Smith   ierr = PetscInfo1(0,"Running on machine: %s\n",hostname);CHKERRQ(ierr);
959e5c89e4eSSatish Balay 
960e5c89e4eSSatish Balay   ierr = PetscOptionsCheckInitial_Components();CHKERRQ(ierr);
961ef6c6fedSBoyana Norris   /* Check the options database for options related to the options database itself */
962c5929fdfSBarry Smith   ierr = PetscOptionsSetFromOptions(NULL);CHKERRQ(ierr);
963ef6c6fedSBoyana Norris 
964951e3c8eSBarry Smith #if defined(PETSC_USE_PETSC_MPI_EXTERNAL32)
965e39fd77fSBarry Smith   /*
966e39fd77fSBarry Smith       Tell MPI about our own data representation converter, this would/should be used if extern32 is not supported by the MPI
967e39fd77fSBarry Smith 
968e39fd77fSBarry Smith       Currently not used because it is not supported by MPICH.
969e39fd77fSBarry Smith   */
970e39fd77fSBarry Smith #if !defined(PETSC_WORDS_BIGENDIAN)
9710298fd71SBarry Smith   ierr = MPI_Register_datarep((char*)"petsc",PetscDataRep_read_conv_fn,PetscDataRep_write_conv_fn,PetscDataRep_extent_fn,NULL);CHKERRQ(ierr);
972e39fd77fSBarry Smith #endif
973951e3c8eSBarry Smith #endif
974e39fd77fSBarry Smith 
97535d88935SVictor Minden #if defined(PETSC_HAVE_CUDA)
97620e2c332SMatthew G. Knepley   flg  = PETSC_TRUE;
977c5929fdfSBarry Smith   ierr = PetscOptionsGetBool(NULL,NULL,"-cublas",&flg,NULL);CHKERRQ(ierr);
97820e2c332SMatthew G. Knepley   if (flg) {
9794bb5149bSJed Brown     PetscMPIInt p;
980663ba86aSMatthew G Knepley     for (p = 0; p < PetscGlobalSize; ++p) {
98182f73ecaSAlejandro Lamas Daviña       if (p == PetscGlobalRank) {
98282f73ecaSAlejandro Lamas Daviña         cberr = cublasCreate(&cublasv2handle);CHKERRCUBLAS(cberr);
98382f73ecaSAlejandro Lamas Daviña       }
984663ba86aSMatthew G Knepley       ierr = MPI_Barrier(PETSC_COMM_WORLD);CHKERRQ(ierr);
985663ba86aSMatthew G Knepley     }
9864bb5149bSJed Brown   }
9873e39abd9SVictor Minden #endif
98892e62aa6SBarry Smith 
989c5929fdfSBarry Smith   ierr = PetscOptionsHasName(NULL,NULL,"-python",&flg);CHKERRQ(ierr);
9909ac80d5eSLisandro Dalcin   if (flg) {
9919ac80d5eSLisandro Dalcin     PetscInitializeCalled = PETSC_TRUE;
9920298fd71SBarry Smith     ierr = PetscPythonInitialize(NULL,NULL);CHKERRQ(ierr);
9939ac80d5eSLisandro Dalcin   }
9949ac80d5eSLisandro Dalcin 
99541c0b4b3SShri Abhyankar   /*
99641c0b4b3SShri Abhyankar       Setup building of stack frames for all function calls
99741c0b4b3SShri Abhyankar   */
998ef19f930SBarry Smith #if defined(PETSC_USE_DEBUG) && !defined(PETSC_HAVE_THREADSAFETY)
999e1167bb9SShri Abhyankar   ierr = PetscStackCreate();CHKERRQ(ierr);
1000e1167bb9SShri Abhyankar #endif
1001e1167bb9SShri Abhyankar 
10022d53ad75SBarry Smith #if defined(PETSC_SERIALIZE_FUNCTIONS)
10032d53ad75SBarry Smith   ierr = PetscFPTCreate(10000);CHKERRQ(ierr);
10042d53ad75SBarry Smith #endif
10052d53ad75SBarry Smith 
10065e71baefSBarry Smith #if defined(PETSC_HAVE_HWLOC)
10075e71baefSBarry Smith   ierr   = PetscOptionsGetViewer(PETSC_COMM_WORLD,NULL,"-process_view",&viewer,NULL,&flg);CHKERRQ(ierr);
10085e71baefSBarry Smith   if (flg) {
10095e71baefSBarry Smith     ierr = PetscProcessPlacementView(viewer);CHKERRQ(ierr);
10105e71baefSBarry Smith   }
10115e71baefSBarry Smith #endif
1012dff31646SBarry Smith 
1013301d30feSBarry Smith   /*
1014301d30feSBarry Smith       Once we are completedly initialized then we can set this variables
1015301d30feSBarry Smith   */
1016301d30feSBarry Smith   PetscInitializeCalled = PETSC_TRUE;
1017301d30feSBarry Smith   PetscFunctionReturn(0);
1018e5c89e4eSSatish Balay }
1019e5c89e4eSSatish Balay 
10204097062eSBarry Smith #if defined(PETSC_USE_LOG)
10212eff7a51SBarry Smith extern PetscObject *PetscObjects;
10222eff7a51SBarry Smith extern PetscInt    PetscObjectsCounts, PetscObjectsMaxCounts;
102305df10baSBarry Smith extern PetscBool   PetscObjectsLog;
10244097062eSBarry Smith #endif
1025e5c89e4eSSatish Balay 
1026008a6e76SBarry Smith /*
1027008a6e76SBarry Smith     Frees all the MPI types and operations that PETSc may have created
1028008a6e76SBarry Smith */
1029008a6e76SBarry Smith PetscErrorCode  PetscFreeMPIResources(void)
1030008a6e76SBarry Smith {
1031008a6e76SBarry Smith   PetscErrorCode ierr;
1032008a6e76SBarry Smith 
1033008a6e76SBarry Smith   PetscFunctionBegin;
1034008a6e76SBarry Smith #if defined(PETSC_USE_REAL___FLOAT128)
1035008a6e76SBarry Smith   ierr = MPI_Type_free(&MPIU___FLOAT128);CHKERRQ(ierr);
1036008a6e76SBarry Smith #if defined(PETSC_HAVE_COMPLEX)
1037008a6e76SBarry Smith   ierr = MPI_Type_free(&MPIU___COMPLEX128);CHKERRQ(ierr);
1038008a6e76SBarry Smith #endif
1039008a6e76SBarry Smith   ierr = MPI_Op_free(&MPIU_MAX);CHKERRQ(ierr);
1040008a6e76SBarry Smith   ierr = MPI_Op_free(&MPIU_MIN);CHKERRQ(ierr);
1041008a6e76SBarry Smith #elif defined(PETSC_USE_REAL___FP16)
1042008a6e76SBarry Smith   ierr = MPI_Type_free(&MPIU___FP16);CHKERRQ(ierr);
1043008a6e76SBarry Smith   ierr = MPI_Op_free(&MPIU_MAX);CHKERRQ(ierr);
1044008a6e76SBarry Smith   ierr = MPI_Op_free(&MPIU_MIN);CHKERRQ(ierr);
1045008a6e76SBarry Smith #endif
1046008a6e76SBarry Smith 
1047008a6e76SBarry Smith #if defined(PETSC_HAVE_COMPLEX)
1048008a6e76SBarry Smith #if !defined(PETSC_HAVE_MPI_C_DOUBLE_COMPLEX)
1049008a6e76SBarry Smith   ierr = MPI_Type_free(&MPIU_C_DOUBLE_COMPLEX);CHKERRQ(ierr);
1050008a6e76SBarry Smith   ierr = MPI_Type_free(&MPIU_C_COMPLEX);CHKERRQ(ierr);
1051008a6e76SBarry Smith #endif
1052008a6e76SBarry Smith #endif
1053008a6e76SBarry Smith 
1054008a6e76SBarry Smith #if (defined(PETSC_HAVE_COMPLEX) && !defined(PETSC_HAVE_MPI_C_DOUBLE_COMPLEX)) || defined(PETSC_USE_REAL___FLOAT128) || defined(PETSC_USE_REAL___FP16)
1055008a6e76SBarry Smith   ierr = MPI_Op_free(&MPIU_SUM);CHKERRQ(ierr);
1056008a6e76SBarry Smith #endif
1057008a6e76SBarry Smith 
1058008a6e76SBarry Smith   ierr = MPI_Type_free(&MPIU_2SCALAR);CHKERRQ(ierr);
1059008a6e76SBarry Smith #if defined(PETSC_USE_64BIT_INDICES) || !defined(MPI_2INT)
1060008a6e76SBarry Smith   ierr = MPI_Type_free(&MPIU_2INT);CHKERRQ(ierr);
1061008a6e76SBarry Smith #endif
1062008a6e76SBarry Smith   ierr = MPI_Op_free(&MPIU_MAXSUM_OP);CHKERRQ(ierr);
1063008a6e76SBarry Smith   PetscFunctionReturn(0);
1064008a6e76SBarry Smith }
1065008a6e76SBarry Smith 
1066e5c89e4eSSatish Balay /*@C
1067e5c89e4eSSatish Balay    PetscFinalize - Checks for options to be called at the conclusion
1068e5c89e4eSSatish Balay    of the program. MPI_Finalize() is called only if the user had not
1069e5c89e4eSSatish Balay    called MPI_Init() before calling PetscInitialize().
1070e5c89e4eSSatish Balay 
1071e5c89e4eSSatish Balay    Collective on PETSC_COMM_WORLD
1072e5c89e4eSSatish Balay 
1073e5c89e4eSSatish Balay    Options Database Keys:
107488c29154SBarry Smith +  -options_table - Calls PetscOptionsView()
1075e5c89e4eSSatish Balay .  -options_left - Prints unused options that remain in the database
10767eb1d149SBarry 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
1077e5c89e4eSSatish Balay .  -mpidump - Calls PetscMPIDump()
1078e5c89e4eSSatish Balay .  -malloc_dump - Calls PetscMallocDump()
1079e5c89e4eSSatish Balay .  -malloc_info - Prints total memory usage
1080e5c89e4eSSatish Balay -  -malloc_log - Prints summary of memory usage
1081e5c89e4eSSatish Balay 
1082e5c89e4eSSatish Balay    Level: beginner
1083e5c89e4eSSatish Balay 
1084e5c89e4eSSatish Balay    Note:
1085e5c89e4eSSatish Balay    See PetscInitialize() for more general runtime options.
1086e5c89e4eSSatish Balay 
108788c29154SBarry Smith .seealso: PetscInitialize(), PetscOptionsView(), PetscMallocDump(), PetscMPIDump(), PetscEnd()
1088e5c89e4eSSatish Balay @*/
10897087cfbeSBarry Smith PetscErrorCode  PetscFinalize(void)
1090e5c89e4eSSatish Balay {
1091e5c89e4eSSatish Balay   PetscErrorCode ierr;
10924bb5149bSJed Brown   PetscMPIInt    rank;
1093a8d2bbe5SBarry Smith   PetscInt       nopt;
10942bf49c77SBarry Smith   PetscBool      flg1 = PETSC_FALSE,flg2 = PETSC_FALSE,flg3 = PETSC_FALSE;
1095dff31646SBarry Smith   PetscBool      flg;
109610463e74SBarry Smith #if defined(PETSC_USE_LOG)
109710463e74SBarry Smith   char           mname[PETSC_MAX_PATH_LEN];
109810463e74SBarry Smith #endif
109982f73ecaSAlejandro Lamas Daviña #if defined(PETSC_HAVE_CUDA)
110082f73ecaSAlejandro Lamas Daviña   cublasStatus_t cberr;
110182f73ecaSAlejandro Lamas Daviña #endif
1102e5c89e4eSSatish Balay 
1103e5c89e4eSSatish Balay   if (!PetscInitializeCalled) {
11044b09e917SBarry Smith     printf("PetscInitialize() must be called before PetscFinalize()\n");
1105*3cbbc5ffSBarry Smith     return(PETSC_ERR_ARG_WRONGSTATE);
1106e5c89e4eSSatish Balay   }
1107*3cbbc5ffSBarry Smith   PetscFunctionBegin;
11080298fd71SBarry Smith   ierr = PetscInfo(NULL,"PetscFinalize() called\n");CHKERRQ(ierr);
1109b022a5c1SBarry Smith 
11101f817a21SBarry Smith   ierr = MPI_Comm_rank(PETSC_COMM_WORLD,&rank);CHKERRQ(ierr);
11111f817a21SBarry Smith 
1112c5929fdfSBarry Smith   ierr = PetscOptionsHasName(NULL,NULL,"-citations",&flg);CHKERRQ(ierr);
1113dff31646SBarry Smith   if (flg) {
11141f817a21SBarry Smith     char  *cits, filename[PETSC_MAX_PATH_LEN];
11151f817a21SBarry Smith     FILE  *fd = PETSC_STDOUT;
11161f817a21SBarry Smith 
1117c5929fdfSBarry Smith     ierr = PetscOptionsGetString(NULL,NULL,"-citations",filename,PETSC_MAX_PATH_LEN,NULL);CHKERRQ(ierr);
11181f817a21SBarry Smith     if (filename[0]) {
11191f817a21SBarry Smith       ierr = PetscFOpen(PETSC_COMM_WORLD,filename,"w",&fd);CHKERRQ(ierr);
11201f817a21SBarry Smith     }
1121dff31646SBarry Smith     ierr = PetscSegBufferGet(PetscCitationsList,1,&cits);CHKERRQ(ierr);
1122dff31646SBarry Smith     cits[0] = 0;
1123dff31646SBarry Smith     ierr = PetscSegBufferExtractAlloc(PetscCitationsList,&cits);CHKERRQ(ierr);
11241f817a21SBarry Smith     ierr = PetscFPrintf(PETSC_COMM_WORLD,fd,"If you publish results based on this computation please cite the following:\n");CHKERRQ(ierr);
11251f817a21SBarry Smith     ierr = PetscFPrintf(PETSC_COMM_WORLD,fd,"===========================================================================\n");CHKERRQ(ierr);
11261f817a21SBarry Smith     ierr = PetscFPrintf(PETSC_COMM_WORLD,fd,"%s",cits);CHKERRQ(ierr);
11271f817a21SBarry Smith     ierr = PetscFPrintf(PETSC_COMM_WORLD,fd,"===========================================================================\n");CHKERRQ(ierr);
11281f817a21SBarry Smith     ierr = PetscFClose(PETSC_COMM_WORLD,fd);CHKERRQ(ierr);
1129dff31646SBarry Smith     ierr = PetscFree(cits);CHKERRQ(ierr);
1130dff31646SBarry Smith   }
1131dff31646SBarry Smith   ierr = PetscSegBufferDestroy(&PetscCitationsList);CHKERRQ(ierr);
1132dff31646SBarry Smith 
1133c2a97968SBarry Smith #if defined(PETSC_HAVE_SSL) && defined(PETSC_USE_SOCKET_VIEWER)
113404102261SBarry Smith   /* TextBelt is run for testing purposes only, please do not use this feature often */
113504102261SBarry Smith   {
113604102261SBarry Smith     PetscInt nmax = 2;
113704102261SBarry Smith     char     **buffs;
113804102261SBarry Smith     ierr = PetscMalloc1(2,&buffs);CHKERRQ(ierr);
1139c5929fdfSBarry Smith     ierr = PetscOptionsGetStringArray(NULL,NULL,"-textbelt",buffs,&nmax,&flg1);CHKERRQ(ierr);
114004102261SBarry Smith     if (flg1) {
114104102261SBarry Smith       if (!nmax) SETERRQ(PETSC_COMM_WORLD,PETSC_ERR_USER,"-textbelt requires either the phone number or number,\"message\"");
114204102261SBarry Smith       if (nmax == 1) {
114304102261SBarry Smith         ierr = PetscMalloc1(128,&buffs[1]);CHKERRQ(ierr);
114404102261SBarry Smith         ierr = PetscGetProgramName(buffs[1],32);CHKERRQ(ierr);
114504102261SBarry Smith         ierr = PetscStrcat(buffs[1]," has completed");CHKERRQ(ierr);
114604102261SBarry Smith       }
114704102261SBarry Smith       ierr = PetscTextBelt(PETSC_COMM_WORLD,buffs[0],buffs[1],NULL);CHKERRQ(ierr);
114804102261SBarry Smith       ierr = PetscFree(buffs[0]);CHKERRQ(ierr);
114904102261SBarry Smith       ierr = PetscFree(buffs[1]);CHKERRQ(ierr);
115004102261SBarry Smith     }
115104102261SBarry Smith     ierr = PetscFree(buffs);CHKERRQ(ierr);
115204102261SBarry Smith   }
1153763ec7b1SBarry Smith   {
1154763ec7b1SBarry Smith     PetscInt nmax = 2;
1155763ec7b1SBarry Smith     char     **buffs;
1156763ec7b1SBarry Smith     ierr = PetscMalloc1(2,&buffs);CHKERRQ(ierr);
1157763ec7b1SBarry Smith     ierr = PetscOptionsGetStringArray(NULL,NULL,"-tellmycell",buffs,&nmax,&flg1);CHKERRQ(ierr);
1158763ec7b1SBarry Smith     if (flg1) {
1159763ec7b1SBarry Smith       if (!nmax) SETERRQ(PETSC_COMM_WORLD,PETSC_ERR_USER,"-tellmycell requires either the phone number or number,\"message\"");
1160763ec7b1SBarry Smith       if (nmax == 1) {
1161763ec7b1SBarry Smith         ierr = PetscMalloc1(128,&buffs[1]);CHKERRQ(ierr);
1162763ec7b1SBarry Smith         ierr = PetscGetProgramName(buffs[1],32);CHKERRQ(ierr);
1163763ec7b1SBarry Smith         ierr = PetscStrcat(buffs[1]," has completed");CHKERRQ(ierr);
1164763ec7b1SBarry Smith       }
1165763ec7b1SBarry Smith       ierr = PetscTellMyCell(PETSC_COMM_WORLD,buffs[0],buffs[1],NULL);CHKERRQ(ierr);
1166763ec7b1SBarry Smith       ierr = PetscFree(buffs[0]);CHKERRQ(ierr);
1167763ec7b1SBarry Smith       ierr = PetscFree(buffs[1]);CHKERRQ(ierr);
1168763ec7b1SBarry Smith     }
1169763ec7b1SBarry Smith     ierr = PetscFree(buffs);CHKERRQ(ierr);
1170763ec7b1SBarry Smith   }
117104102261SBarry Smith #endif
117267234432SDmitry Karpeev   /*
117367234432SDmitry Karpeev     It should be safe to cancel the options monitors, since we don't expect to be setting options
117467234432SDmitry Karpeev     here (at least that are worth monitoring).  Monitors ought to be released so that they release
117567234432SDmitry Karpeev     whatever memory was allocated there before -malloc_dump reports unfreed memory.
117667234432SDmitry Karpeev   */
117767234432SDmitry Karpeev   ierr = PetscOptionsMonitorCancel();CHKERRQ(ierr);
117804102261SBarry Smith 
11792d53ad75SBarry Smith #if defined(PETSC_SERIALIZE_FUNCTIONS)
11802d53ad75SBarry Smith   ierr = PetscFPTDestroy();CHKERRQ(ierr);
11812d53ad75SBarry Smith #endif
11822d53ad75SBarry Smith 
11832d53ad75SBarry Smith 
1184e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS)
1185dff31646SBarry Smith   flg = PETSC_FALSE;
1186c5929fdfSBarry Smith   ierr = PetscOptionsGetBool(NULL,NULL,"-saw_options",&flg,NULL);CHKERRQ(ierr);
1187d5649816SBarry Smith   if (flg) {
1188e04113cfSBarry Smith     ierr = PetscOptionsSAWsDestroy();CHKERRQ(ierr);
1189d5649816SBarry Smith   }
1190d5649816SBarry Smith #endif
1191d5649816SBarry Smith 
1192681455b2SBarry Smith #if defined(PETSC_HAVE_X)
1193681455b2SBarry Smith   flg1 = PETSC_FALSE;
1194c5929fdfSBarry Smith   ierr = PetscOptionsGetBool(NULL,NULL,"-x_virtual",&flg1,NULL);CHKERRQ(ierr);
1195681455b2SBarry Smith   if (flg1) {
1196681455b2SBarry Smith     /*  this is a crude hack, but better than nothing */
1197681455b2SBarry Smith     ierr = PetscPOpen(PETSC_COMM_WORLD,NULL,"pkill -9 Xvfb","r",NULL);CHKERRQ(ierr);
1198681455b2SBarry Smith   }
1199681455b2SBarry Smith #endif
1200681455b2SBarry Smith 
120167584ceeSBarry Smith #if !defined(PETSC_HAVE_THREADSAFETY)
1202c5929fdfSBarry Smith   ierr = PetscOptionsGetBool(NULL,NULL,"-malloc_info",&flg2,NULL);CHKERRQ(ierr);
1203e5c89e4eSSatish Balay   if (!flg2) {
120490d69ab7SBarry Smith     flg2 = PETSC_FALSE;
1205c5929fdfSBarry Smith     ierr = PetscOptionsGetBool(NULL,NULL,"-memory_view",&flg2,NULL);CHKERRQ(ierr);
1206e5c89e4eSSatish Balay   }
1207e5c89e4eSSatish Balay   if (flg2) {
12080841954dSBarry Smith     ierr = PetscMemoryView(PETSC_VIEWER_STDOUT_WORLD,"Summary of Memory Usage in PETSc\n");CHKERRQ(ierr);
1209e5c89e4eSSatish Balay   }
121067584ceeSBarry Smith #endif
1211e5c89e4eSSatish Balay 
1212e5c89e4eSSatish Balay #if defined(PETSC_USE_LOG)
121390d69ab7SBarry Smith   flg1 = PETSC_FALSE;
1214c5929fdfSBarry Smith   ierr = PetscOptionsGetBool(NULL,NULL,"-get_total_flops",&flg1,NULL);CHKERRQ(ierr);
1215e5c89e4eSSatish Balay   if (flg1) {
1216e5c89e4eSSatish Balay     PetscLogDouble flops = 0;
1217205a32c2SJed Brown     ierr = MPI_Reduce(&petsc_TotalFlops,&flops,1,MPI_DOUBLE,MPI_SUM,0,PETSC_COMM_WORLD);CHKERRQ(ierr);
1218e5c89e4eSSatish Balay     ierr = PetscPrintf(PETSC_COMM_WORLD,"Total flops over all processors %g\n",flops);CHKERRQ(ierr);
1219e5c89e4eSSatish Balay   }
1220e5c89e4eSSatish Balay #endif
1221e5c89e4eSSatish Balay 
1222e5c89e4eSSatish Balay 
1223e5c89e4eSSatish Balay #if defined(PETSC_USE_LOG)
1224e5c89e4eSSatish Balay #if defined(PETSC_HAVE_MPE)
1225e5c89e4eSSatish Balay   mname[0] = 0;
1226c5929fdfSBarry Smith   ierr = PetscOptionsGetString(NULL,NULL,"-log_mpe",mname,PETSC_MAX_PATH_LEN,&flg1);CHKERRQ(ierr);
1227e5c89e4eSSatish Balay   if (flg1) {
1228e5c89e4eSSatish Balay     if (mname[0]) {ierr = PetscLogMPEDump(mname);CHKERRQ(ierr);}
1229e5c89e4eSSatish Balay     else          {ierr = PetscLogMPEDump(0);CHKERRQ(ierr);}
1230e5c89e4eSSatish Balay   }
1231e5c89e4eSSatish Balay #endif
1232356e5837SBarry Smith #endif
1233a297a907SKarl Rupp 
1234dd710f27SBarry Smith   /*
1235dd710f27SBarry Smith      Free all objects registered with PetscObjectRegisterDestroy() such as PETSC_VIEWER_XXX_().
1236dd710f27SBarry Smith   */
1237dd710f27SBarry Smith   ierr = PetscObjectRegisterDestroyAll();CHKERRQ(ierr);
1238dd710f27SBarry Smith 
1239356e5837SBarry Smith #if defined(PETSC_USE_LOG)
1240f14045dbSBarry Smith   ierr = PetscLogViewFromOptions();CHKERRQ(ierr);
1241356e5837SBarry Smith   mname[0] = 0;
1242c5929fdfSBarry Smith   ierr = PetscOptionsGetString(NULL,NULL,"-log_summary",mname,PETSC_MAX_PATH_LEN,&flg1);CHKERRQ(ierr);
1243e5c89e4eSSatish Balay   if (flg1) {
124491eabc43SBarry Smith     PetscViewer viewer;
124520a8bfc3SBarry Smith     ierr = (*PetscHelpPrintf)(PETSC_COMM_WORLD,"\n\n WARNING:   -log_summary is being deprecated; switch to -log_view\n\n\n");CHKERRQ(ierr);
124691eabc43SBarry Smith     if (mname[0]) {
124791eabc43SBarry Smith       ierr = PetscViewerASCIIOpen(PETSC_COMM_WORLD,mname,&viewer);CHKERRQ(ierr);
124891eabc43SBarry Smith       ierr = PetscLogView(viewer);CHKERRQ(ierr);
12496bf464f9SBarry Smith       ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr);
125033f85c2fSBarry Smith     } else {
125133f85c2fSBarry Smith       viewer = PETSC_VIEWER_STDOUT_WORLD;
12529a9a5d4cSBarry Smith       ierr   = PetscViewerPushFormat(viewer,PETSC_VIEWER_DEFAULT);CHKERRQ(ierr);
125333f85c2fSBarry Smith       ierr   = PetscLogView(viewer);CHKERRQ(ierr);
12549a9a5d4cSBarry Smith       ierr   = PetscViewerPopFormat(viewer);CHKERRQ(ierr);
125533f85c2fSBarry Smith     }
1256e5c89e4eSSatish Balay   }
1257a297a907SKarl Rupp 
1258dd710f27SBarry Smith   /*
1259dd710f27SBarry Smith      Free any objects created by the last block of code.
1260dd710f27SBarry Smith   */
1261dd710f27SBarry Smith   ierr = PetscObjectRegisterDestroyAll();CHKERRQ(ierr);
1262dd710f27SBarry Smith 
1263dd710f27SBarry Smith   mname[0] = 0;
1264c5929fdfSBarry Smith   ierr = PetscOptionsGetString(NULL,NULL,"-log_all",mname,PETSC_MAX_PATH_LEN,&flg1);CHKERRQ(ierr);
1265c5929fdfSBarry Smith   ierr = PetscOptionsGetString(NULL,NULL,"-log",mname,PETSC_MAX_PATH_LEN,&flg2);CHKERRQ(ierr);
1266e5c89e4eSSatish Balay   if (flg1 || flg2) {
1267e5c89e4eSSatish Balay     if (mname[0]) PetscLogDump(mname);
1268e5c89e4eSSatish Balay     else          PetscLogDump(0);
1269e5c89e4eSSatish Balay   }
1270e5c89e4eSSatish Balay #endif
127110463e74SBarry Smith 
127233f85c2fSBarry Smith   ierr = PetscStackDestroy();CHKERRQ(ierr);
127310463e74SBarry Smith 
127490d69ab7SBarry Smith   flg1 = PETSC_FALSE;
1275c5929fdfSBarry Smith   ierr = PetscOptionsGetBool(NULL,NULL,"-no_signal_handler",&flg1,NULL);CHKERRQ(ierr);
1276e5c89e4eSSatish Balay   if (!flg1) { ierr = PetscPopSignalHandler();CHKERRQ(ierr);}
127790d69ab7SBarry Smith   flg1 = PETSC_FALSE;
1278c5929fdfSBarry Smith   ierr = PetscOptionsGetBool(NULL,NULL,"-mpidump",&flg1,NULL);CHKERRQ(ierr);
1279e5c89e4eSSatish Balay   if (flg1) {
1280e5c89e4eSSatish Balay     ierr = PetscMPIDump(stdout);CHKERRQ(ierr);
1281e5c89e4eSSatish Balay   }
128290d69ab7SBarry Smith   flg1 = PETSC_FALSE;
128390d69ab7SBarry Smith   flg2 = PETSC_FALSE;
12848bb29257SSatish Balay   /* preemptive call to avoid listing this option in options table as unused */
1285c5929fdfSBarry Smith   ierr = PetscOptionsHasName(NULL,NULL,"-malloc_dump",&flg1);CHKERRQ(ierr);
1286c5929fdfSBarry Smith   ierr = PetscOptionsHasName(NULL,NULL,"-objects_dump",&flg1);CHKERRQ(ierr);
1287c5929fdfSBarry Smith   ierr = PetscOptionsGetBool(NULL,NULL,"-options_view",&flg2,NULL);CHKERRQ(ierr);
1288e4c476e2SSatish Balay 
1289e5c89e4eSSatish Balay   if (flg2) {
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 
1297e5c89e4eSSatish Balay   /* to prevent PETSc -options_left from warning */
1298c5929fdfSBarry Smith   ierr = PetscOptionsHasName(NULL,NULL,"-nox",&flg1);CHKERRQ(ierr);
1299c5929fdfSBarry Smith   ierr = PetscOptionsHasName(NULL,NULL,"-nox_warning",&flg1);CHKERRQ(ierr);
1300e5c89e4eSSatish Balay 
130133fc4174SSatish Balay   flg3 = PETSC_FALSE; /* default value is required */
1302c5929fdfSBarry Smith   ierr = PetscOptionsGetBool(NULL,NULL,"-options_left",&flg3,&flg1);CHKERRQ(ierr);
1303c5929fdfSBarry Smith   ierr = PetscOptionsAllUsed(NULL,&nopt);CHKERRQ(ierr);
1304e5c89e4eSSatish Balay   if (flg3) {
1305e5c89e4eSSatish Balay     if (!flg2) { /* have not yet printed the options */
1306be56827dSJed Brown       PetscViewer viewer;
130702ba9f54SBarry Smith       ierr = PetscViewerCreate(PETSC_COMM_WORLD,&viewer);CHKERRQ(ierr);
130802ba9f54SBarry Smith       ierr = PetscViewerSetType(viewer,PETSCVIEWERASCII);CHKERRQ(ierr);
1309c5929fdfSBarry Smith       ierr = PetscOptionsView(NULL,viewer);CHKERRQ(ierr);
1310be56827dSJed Brown       ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr);
1311e5c89e4eSSatish Balay     }
1312e5c89e4eSSatish Balay     if (!nopt) {
1313e5c89e4eSSatish Balay       ierr = PetscPrintf(PETSC_COMM_WORLD,"There are no unused options.\n");CHKERRQ(ierr);
1314e5c89e4eSSatish Balay     } else if (nopt == 1) {
1315e5c89e4eSSatish Balay       ierr = PetscPrintf(PETSC_COMM_WORLD,"There is one unused database option. It is:\n");CHKERRQ(ierr);
1316e5c89e4eSSatish Balay     } else {
13177582186dSLisandro Dalcin       ierr = PetscPrintf(PETSC_COMM_WORLD,"There are %D unused database options. They are:\n",nopt);CHKERRQ(ierr);
1318e5c89e4eSSatish Balay     }
1319df12ba86SBarry Smith   }
1320e5c89e4eSSatish Balay #if defined(PETSC_USE_DEBUG)
1321da8b8a77SBarry Smith   if (nopt && !flg3 && !flg1) {
1322e5c89e4eSSatish Balay     ierr = PetscPrintf(PETSC_COMM_WORLD,"WARNING! There are options you set that were not used!\n");CHKERRQ(ierr);
1323e5c89e4eSSatish Balay     ierr = PetscPrintf(PETSC_COMM_WORLD,"WARNING! could be spelling mistake, etc!\n");CHKERRQ(ierr);
1324c5929fdfSBarry Smith     ierr = PetscOptionsLeft(NULL);CHKERRQ(ierr);
1325e5c89e4eSSatish Balay   } else if (nopt && flg3) {
1326e5c89e4eSSatish Balay #else
1327e5c89e4eSSatish Balay   if (nopt && flg3) {
1328e5c89e4eSSatish Balay #endif
1329c5929fdfSBarry Smith     ierr = PetscOptionsLeft(NULL);CHKERRQ(ierr);
1330e5c89e4eSSatish Balay   }
1331e5c89e4eSSatish Balay 
1332e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS)
1333d45a07a7SBarry Smith   if (!PetscGlobalRank) {
133487f587eeSBarry Smith     ierr = PetscStackSAWsViewOff();CHKERRQ(ierr);
133516ad0300SBarry Smith     PetscStackCallSAWs(SAWs_Finalize,());
1336d45a07a7SBarry Smith   }
1337ec957eceSBarry Smith #endif
1338ec957eceSBarry Smith 
13394097062eSBarry Smith #if defined(PETSC_USE_LOG)
134010463e74SBarry Smith   /*
1341dbc8283eSBarry Smith        List all objects the user may have forgot to free
13422eff7a51SBarry Smith   */
134305df10baSBarry Smith   if (PetscObjectsLog) {
1344c5929fdfSBarry Smith     ierr = PetscOptionsHasName(NULL,NULL,"-objects_dump",&flg1);CHKERRQ(ierr);
1345a64a8e02SBarry Smith     if (flg1) {
1346a64a8e02SBarry Smith       MPI_Comm local_comm;
13477eb1d149SBarry Smith       char     string[64];
1348a64a8e02SBarry Smith 
1349c5929fdfSBarry Smith       ierr = PetscOptionsGetString(NULL,NULL,"-objects_dump",string,64,NULL);CHKERRQ(ierr);
1350a64a8e02SBarry Smith       ierr = MPI_Comm_dup(MPI_COMM_WORLD,&local_comm);CHKERRQ(ierr);
1351a64a8e02SBarry Smith       ierr = PetscSequentialPhaseBegin_Private(local_comm,1);CHKERRQ(ierr);
13527eb1d149SBarry Smith       ierr = PetscObjectsDump(stdout,(string[0] == 'a') ? PETSC_TRUE : PETSC_FALSE);CHKERRQ(ierr);
1353a64a8e02SBarry Smith       ierr = PetscSequentialPhaseEnd_Private(local_comm,1);CHKERRQ(ierr);
1354a64a8e02SBarry Smith       ierr = MPI_Comm_free(&local_comm);CHKERRQ(ierr);
13550a1571b3SBarry Smith     }
135605df10baSBarry Smith   }
13574097062eSBarry Smith #endif
13584097062eSBarry Smith 
13594097062eSBarry Smith #if defined(PETSC_USE_LOG)
1360dbc8283eSBarry Smith   PetscObjectsCounts    = 0;
1361dbc8283eSBarry Smith   PetscObjectsMaxCounts = 0;
1362a297a907SKarl Rupp   ierr = PetscFree(PetscObjects);CHKERRQ(ierr);
13634097062eSBarry Smith #endif
13642eff7a51SBarry Smith 
136533f85c2fSBarry Smith   /*
136633f85c2fSBarry Smith      Destroy any packages that registered a finalize
136733f85c2fSBarry Smith   */
136833f85c2fSBarry Smith   ierr = PetscRegisterFinalizeAll();CHKERRQ(ierr);
136933f85c2fSBarry Smith 
1370101409b8SToby Isaac #if defined(PETSC_USE_LOG)
1371101409b8SToby Isaac   ierr = PetscLogDestroy();CHKERRQ(ierr);
1372101409b8SToby Isaac #endif
1373101409b8SToby Isaac 
137433f85c2fSBarry Smith   /*
137548dd1dffSBarry Smith      Print PetscFunctionLists that have not been properly freed
137648dd1dffSBarry Smith 
137737e93019SBarry Smith   ierr = PetscFunctionListPrintAll();CHKERRQ(ierr);
137848dd1dffSBarry Smith   */
137937e93019SBarry Smith 
13804028d114SSatish Balay   if (petsc_history) {
1381f3dea69dSBarry Smith     ierr = PetscCloseHistoryFile(&petsc_history);CHKERRQ(ierr);
1382e5c89e4eSSatish Balay     petsc_history = 0;
1383e5c89e4eSSatish Balay   }
13849de0f6ecSBarry Smith   ierr = PetscOptionsHelpPrintedDestroy(&PetscOptionsHelpPrintedSingleton);CHKERRQ(ierr);
1385e5c89e4eSSatish Balay 
13860298fd71SBarry Smith   ierr = PetscInfoAllow(PETSC_FALSE,NULL);CHKERRQ(ierr);
1387e5c89e4eSSatish Balay 
138867584ceeSBarry Smith #if !defined(PETSC_HAVE_THREADSAFETY)
13898bb29257SSatish Balay   {
1390e5c89e4eSSatish Balay     char fname[PETSC_MAX_PATH_LEN];
1391e5c89e4eSSatish Balay     FILE *fd;
1392ed9cf6e9SBarry Smith     int  err;
1393e5c89e4eSSatish Balay 
1394e5c89e4eSSatish Balay     fname[0] = 0;
1395a297a907SKarl Rupp 
1396c5929fdfSBarry Smith     ierr = PetscOptionsGetString(NULL,NULL,"-malloc_dump",fname,250,&flg1);CHKERRQ(ierr);
1397dc92acbaSJed Brown     flg2 = PETSC_FALSE;
1398c5929fdfSBarry Smith     ierr = PetscOptionsGetBool(NULL,NULL,"-malloc_test",&flg2,NULL);CHKERRQ(ierr);
13998bf1f09cSShri Abhyankar #if defined(PETSC_USE_DEBUG)
1400dc92acbaSJed Brown     if (PETSC_RUNNING_ON_VALGRIND) flg2 = PETSC_FALSE;
1401dc92acbaSJed Brown #else
1402dc92acbaSJed Brown     flg2 = PETSC_FALSE;         /* Skip reporting for optimized builds regardless of -malloc_test */
1403dc92acbaSJed Brown #endif
1404e5c89e4eSSatish Balay     if (flg1 && fname[0]) {
1405e5c89e4eSSatish Balay       char sname[PETSC_MAX_PATH_LEN];
1406e5c89e4eSSatish Balay 
1407e5c89e4eSSatish Balay       sprintf(sname,"%s_%d",fname,rank);
1408e32f2f54SBarry Smith       fd   = fopen(sname,"w"); if (!fd) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_FILE_OPEN,"Cannot open log file: %s",sname);
1409e5c89e4eSSatish Balay       ierr = PetscMallocDump(fd);CHKERRQ(ierr);
1410ed9cf6e9SBarry Smith       err  = fclose(fd);
1411e32f2f54SBarry Smith       if (err) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SYS,"fclose() failed on file");
1412dc92acbaSJed Brown     } else if (flg1 || flg2) {
1413e5c89e4eSSatish Balay       MPI_Comm local_comm;
1414e5c89e4eSSatish Balay 
1415e5c89e4eSSatish Balay       ierr = MPI_Comm_dup(MPI_COMM_WORLD,&local_comm);CHKERRQ(ierr);
1416e5c89e4eSSatish Balay       ierr = PetscSequentialPhaseBegin_Private(local_comm,1);CHKERRQ(ierr);
1417e5c89e4eSSatish Balay       ierr = PetscMallocDump(stdout);CHKERRQ(ierr);
1418e5c89e4eSSatish Balay       ierr = PetscSequentialPhaseEnd_Private(local_comm,1);CHKERRQ(ierr);
1419e5c89e4eSSatish Balay       ierr = MPI_Comm_free(&local_comm);CHKERRQ(ierr);
1420e5c89e4eSSatish Balay     }
1421e5c89e4eSSatish Balay   }
1422a64a8e02SBarry Smith 
14238bb29257SSatish Balay   {
1424e5c89e4eSSatish Balay     char fname[PETSC_MAX_PATH_LEN];
14250298fd71SBarry Smith     FILE *fd = NULL;
1426e5c89e4eSSatish Balay 
1427e5c89e4eSSatish Balay     fname[0] = 0;
1428a297a907SKarl Rupp 
1429c5929fdfSBarry Smith     ierr = PetscOptionsGetString(NULL,NULL,"-malloc_log",fname,250,&flg1);CHKERRQ(ierr);
1430c5929fdfSBarry Smith     ierr = PetscOptionsHasName(NULL,NULL,"-malloc_log_threshold",&flg2);CHKERRQ(ierr);
1431e5c89e4eSSatish Balay     if (flg1 && fname[0]) {
1432ed9cf6e9SBarry Smith       int err;
1433e5c89e4eSSatish Balay 
1434574034a9SJed Brown       if (!rank) {
1435574034a9SJed Brown         fd = fopen(fname,"w");
1436574034a9SJed Brown         if (!fd) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_FILE_OPEN,"Cannot open log file: %s",fname);
1437574034a9SJed Brown       }
1438e5c89e4eSSatish Balay       ierr = PetscMallocDumpLog(fd);CHKERRQ(ierr);
1439574034a9SJed Brown       if (fd) {
1440ed9cf6e9SBarry Smith         err = fclose(fd);
1441e32f2f54SBarry Smith         if (err) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SYS,"fclose() failed on file");
1442574034a9SJed Brown       }
1443574034a9SJed Brown     } else if (flg1 || flg2) {
1444e5c89e4eSSatish Balay       ierr = PetscMallocDumpLog(stdout);CHKERRQ(ierr);
1445e5c89e4eSSatish Balay     }
1446e5c89e4eSSatish Balay   }
144767584ceeSBarry Smith #endif
144820e2c332SMatthew G. Knepley 
14495486ca60SMatthew G. Knepley   /*
14505486ca60SMatthew G. Knepley      Close any open dynamic libraries
14515486ca60SMatthew G. Knepley   */
14525486ca60SMatthew G. Knepley   ierr = PetscFinalize_DynamicLibraries();CHKERRQ(ierr);
14535486ca60SMatthew G. Knepley 
145420e2c332SMatthew G. Knepley #if defined(PETSC_HAVE_CUDA)
145520e2c332SMatthew G. Knepley   flg  = PETSC_TRUE;
1456c5929fdfSBarry Smith   ierr = PetscOptionsGetBool(NULL,NULL,"-cublas",&flg,NULL);CHKERRQ(ierr);
145720e2c332SMatthew G. Knepley   if (flg) {
145820e2c332SMatthew G. Knepley     PetscInt p;
145920e2c332SMatthew G. Knepley     for (p = 0; p < PetscGlobalSize; ++p) {
146082f73ecaSAlejandro Lamas Daviña       if (p == PetscGlobalRank) {
146182f73ecaSAlejandro Lamas Daviña         if (cublasv2handle) {
146282f73ecaSAlejandro Lamas Daviña           cberr = cublasDestroy(cublasv2handle);CHKERRCUBLAS(cberr);
146382f73ecaSAlejandro Lamas Daviña         }
146482f73ecaSAlejandro Lamas Daviña       }
146520e2c332SMatthew G. Knepley       ierr = MPI_Barrier(PETSC_COMM_WORLD);CHKERRQ(ierr);
146620e2c332SMatthew G. Knepley     }
146720e2c332SMatthew G. Knepley   }
146820e2c332SMatthew G. Knepley #endif
146920e2c332SMatthew G. Knepley 
1470e5c89e4eSSatish Balay   /* Can be destroyed only after all the options are used */
14714416b707SBarry Smith   ierr = PetscOptionsDestroyDefault();CHKERRQ(ierr);
1472e5c89e4eSSatish Balay 
1473e5c89e4eSSatish Balay   PetscGlobalArgc = 0;
1474e5c89e4eSSatish Balay   PetscGlobalArgs = 0;
1475e5c89e4eSSatish Balay 
1476008a6e76SBarry Smith   ierr = PetscFreeMPIResources();CHKERRQ(ierr);
1477e5c89e4eSSatish Balay 
1478dbc8283eSBarry Smith   /*
1479efb80d3cSBarry Smith      Destroy any known inner MPI_Comm's and attributes pointing to them
1480efb80d3cSBarry Smith      Note this will not destroy any new communicators the user has created.
1481efb80d3cSBarry Smith 
1482efb80d3cSBarry Smith      If all PETSc objects were not destroyed those left over objects will have hanging references to
1483efb80d3cSBarry Smith      the MPI_Comms that were freed; but that is ok because those PETSc objects will never be used again
1484dbc8283eSBarry Smith  */
1485b770b1f6SSatish Balay   {
1486dbc8283eSBarry Smith     PetscCommCounter *counter;
1487dbc8283eSBarry Smith     PetscMPIInt      flg;
1488dbc8283eSBarry Smith     MPI_Comm         icomm;
1489265f3f35SJed Brown     union {MPI_Comm comm; void *ptr;} ucomm;
1490265f3f35SJed Brown     ierr = MPI_Attr_get(PETSC_COMM_SELF,Petsc_InnerComm_keyval,&ucomm,&flg);CHKERRQ(ierr);
1491dbc8283eSBarry Smith     if (flg) {
1492265f3f35SJed Brown       icomm = ucomm.comm;
1493dbc8283eSBarry Smith       ierr = MPI_Attr_get(icomm,Petsc_Counter_keyval,&counter,&flg);CHKERRQ(ierr);
1494dbc8283eSBarry 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");
1495dbc8283eSBarry Smith 
1496dbc8283eSBarry Smith       ierr = MPI_Attr_delete(PETSC_COMM_SELF,Petsc_InnerComm_keyval);CHKERRQ(ierr);
1497efb80d3cSBarry Smith       ierr = MPI_Attr_delete(icomm,Petsc_Counter_keyval);CHKERRQ(ierr);
1498efb80d3cSBarry Smith       ierr = MPI_Comm_free(&icomm);CHKERRQ(ierr);
1499dbc8283eSBarry Smith     }
1500265f3f35SJed Brown     ierr = MPI_Attr_get(PETSC_COMM_WORLD,Petsc_InnerComm_keyval,&ucomm,&flg);CHKERRQ(ierr);
1501dbc8283eSBarry Smith     if (flg) {
1502265f3f35SJed Brown       icomm = ucomm.comm;
1503dbc8283eSBarry Smith       ierr = MPI_Attr_get(icomm,Petsc_Counter_keyval,&counter,&flg);CHKERRQ(ierr);
1504dbc8283eSBarry 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");
1505dbc8283eSBarry Smith 
1506dbc8283eSBarry Smith       ierr = MPI_Attr_delete(PETSC_COMM_WORLD,Petsc_InnerComm_keyval);CHKERRQ(ierr);
1507efb80d3cSBarry Smith       ierr = MPI_Attr_delete(icomm,Petsc_Counter_keyval);CHKERRQ(ierr);
1508efb80d3cSBarry Smith       ierr = MPI_Comm_free(&icomm);CHKERRQ(ierr);
1509dbc8283eSBarry Smith     }
1510b770b1f6SSatish Balay   }
1511dbc8283eSBarry Smith 
1512480cf27aSJed Brown   ierr = MPI_Keyval_free(&Petsc_Counter_keyval);CHKERRQ(ierr);
1513480cf27aSJed Brown   ierr = MPI_Keyval_free(&Petsc_InnerComm_keyval);CHKERRQ(ierr);
1514480cf27aSJed Brown   ierr = MPI_Keyval_free(&Petsc_OuterComm_keyval);CHKERRQ(ierr);
151524b04858SSatish Balay   ierr = MPI_Keyval_free(&Petsc_Shared_keyval);CHKERRQ(ierr);
1516480cf27aSJed Brown 
15175ad9ad5bSBarry Smith   ierr = PetscSpinlockDestroy(&PetscViewerASCIISpinLockOpen);CHKERRQ(ierr);
15185ad9ad5bSBarry Smith   ierr = PetscSpinlockDestroy(&PetscViewerASCIISpinLockStdout);CHKERRQ(ierr);
15195ad9ad5bSBarry Smith   ierr = PetscSpinlockDestroy(&PetscViewerASCIISpinLockStderr);CHKERRQ(ierr);
1520ef19f930SBarry Smith   ierr = PetscSpinlockDestroy(&PetscCommSpinLock);CHKERRQ(ierr);
1521ef19f930SBarry Smith 
1522e5c89e4eSSatish Balay   if (PetscBeganMPI) {
152399608316SBarry Smith #if defined(PETSC_HAVE_MPI_FINALIZED)
152499b1327fSBarry Smith     PetscMPIInt flag;
152599b1327fSBarry Smith     ierr = MPI_Finalized(&flag);CHKERRQ(ierr);
1526e32f2f54SBarry Smith     if (flag) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_LIB,"MPI_Finalize() has already been called, even though MPI_Init() was called by PetscInitialize()");
152799608316SBarry Smith #endif
1528e5c89e4eSSatish Balay     ierr = MPI_Finalize();CHKERRQ(ierr);
1529e5c89e4eSSatish Balay   }
1530e5c89e4eSSatish Balay /*
1531e5c89e4eSSatish Balay 
1532e5c89e4eSSatish Balay      Note: In certain cases PETSC_COMM_WORLD is never MPI_Comm_free()ed because
1533e5c89e4eSSatish Balay    the communicator has some outstanding requests on it. Specifically if the
1534e5c89e4eSSatish Balay    flag PETSC_HAVE_BROKEN_REQUEST_FREE is set (for IBM MPI implementation). See
1535e5c89e4eSSatish Balay    src/vec/utils/vpscat.c. Due to this the memory allocated in PetscCommDuplicate()
1536e5c89e4eSSatish Balay    is never freed as it should be. Thus one may obtain messages of the form
15370e5e90baSSatish Balay    [ 1] 8 bytes PetscCommDuplicate() line 645 in src/sys/mpiu.c indicating the
1538e5c89e4eSSatish Balay    memory was not freed.
1539e5c89e4eSSatish Balay 
1540e5c89e4eSSatish Balay */
15411d1a0024SBarry Smith   ierr = PetscMallocClear();CHKERRQ(ierr);
1542a297a907SKarl Rupp 
1543e5c89e4eSSatish Balay   PetscInitializeCalled = PETSC_FALSE;
1544e5c89e4eSSatish Balay   PetscFinalizeCalled   = PETSC_TRUE;
15453db9a53dSBarry Smith   PetscFunctionReturn(0);
1546e5c89e4eSSatish Balay }
1547e5c89e4eSSatish Balay 
154843db4dbbSBarry Smith #if defined(PETSC_MISSING_LAPACK_lsame_)
15498cc058d9SJed Brown PETSC_EXTERN int lsame_(char *a,char *b)
155043db4dbbSBarry Smith {
155143db4dbbSBarry Smith   if (*a == *b) return 1;
155243db4dbbSBarry Smith   if (*a + 32 == *b) return 1;
155343db4dbbSBarry Smith   if (*a - 32 == *b) return 1;
155443db4dbbSBarry Smith   return 0;
155543db4dbbSBarry Smith }
1556a70650f6SBarry Smith #endif
155743db4dbbSBarry Smith 
155843db4dbbSBarry Smith #if defined(PETSC_MISSING_LAPACK_lsame)
15598cc058d9SJed Brown PETSC_EXTERN int lsame(char *a,char *b)
156043db4dbbSBarry Smith {
156143db4dbbSBarry Smith   if (*a == *b) return 1;
156243db4dbbSBarry Smith   if (*a + 32 == *b) return 1;
156343db4dbbSBarry Smith   if (*a - 32 == *b) return 1;
156443db4dbbSBarry Smith   return 0;
156543db4dbbSBarry Smith }
156643db4dbbSBarry Smith #endif
1567