xref: /petsc/src/sys/objects/pinit.c (revision c2f74817a55282e9ec39a838b0f9da7b0c7fe029)
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 
31812801b39SBarry Smith    Note: this is declared extern "C" because it is passed to MPI_Comm_create_keyval()
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;
32612801b39SBarry Smith   ierr = PetscInfo1(0,"Deleting counter data in an MPI_Comm %ld\n",(long)comm);CHKERRMPI(ierr);
32712801b39SBarry Smith   ierr = PetscFree(count_val);CHKERRMPI(ierr);
328480cf27aSJed Brown   PetscFunctionReturn(MPI_SUCCESS);
329480cf27aSJed Brown }
330480cf27aSJed Brown 
331480cf27aSJed Brown /*
33247435625SJed Brown   This is invoked on the outer comm as a result of either PetscCommDestroy() (via MPI_Comm_delete_attr) 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 
33912801b39SBarry Smith   Note: this is declared extern "C" because it is passed to MPI_Comm_create_keyval()
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;
34912801b39SBarry Smith   if (keyval != Petsc_InnerComm_keyval) SETERRMPI(PETSC_COMM_SELF,PETSC_ERR_ARG_CORRUPT,"Unexpected keyval");
350ec4fadc2SJed Brown   icomm.ptr = attr_val;
351da3039f7SJed Brown 
35247435625SJed Brown   ierr = MPI_Comm_get_attr(icomm.comm,Petsc_OuterComm_keyval,&ocomm,&flg);CHKERRMPI(ierr);
35312801b39SBarry Smith   if (!flg) SETERRMPI(PETSC_COMM_SELF,PETSC_ERR_ARG_CORRUPT,"Inner MPI_Comm does not have expected reference to outer comm");
35412801b39SBarry Smith   if (ocomm.comm != comm) SETERRMPI(PETSC_COMM_SELF,PETSC_ERR_ARG_CORRUPT,"Inner MPI_Comm has reference to non-matching outer comm");
35547435625SJed Brown   ierr = MPI_Comm_delete_attr(icomm.comm,Petsc_OuterComm_keyval);CHKERRMPI(ierr);
35612801b39SBarry Smith   ierr = PetscInfo1(0,"User MPI_Comm %ld is being freed after removing reference from inner PETSc comm to this outer comm\n",(long)comm);CHKERRMPI(ierr);
357da3039f7SJed Brown   PetscFunctionReturn(MPI_SUCCESS);
358b89831e5SBarry Smith }
359da3039f7SJed Brown 
360da3039f7SJed Brown /*
36147435625SJed Brown  * This is invoked on the inner comm when Petsc_DelComm_Outer calls MPI_Comm_delete_attr.  It should not be reached any other way.
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;
36812801b39SBarry Smith   ierr = PetscInfo1(0,"Removing reference to PETSc communicator embedded in a user MPI_Comm %ld\n",(long)comm);CHKERRMPI(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 
38212801b39SBarry Smith PetscMPIInt PETSC_MPI_ERROR_CLASS,PETSC_MPI_ERROR_CODE;
38312801b39SBarry Smith 
3846ae9a8a6SBarry Smith int  PetscGlobalArgc   = 0;
3856ae9a8a6SBarry Smith char **PetscGlobalArgs = 0;
386dff31646SBarry Smith PetscSegBuffer PetscCitationsList;
387e5c89e4eSSatish Balay 
388dd63322aSSatish Balay PetscErrorCode PetscCitationsInitialize(void)
389051e4cf2SJed Brown {
390051e4cf2SJed Brown   PetscErrorCode ierr;
391051e4cf2SJed Brown 
392051e4cf2SJed Brown   PetscFunctionBegin;
393051e4cf2SJed Brown   ierr = PetscSegBufferCreate(1,10000,&PetscCitationsList);CHKERRQ(ierr);
3940e50f9e5SSatish 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);
395051e4cf2SJed 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);
396051e4cf2SJed Brown   PetscFunctionReturn(0);
397051e4cf2SJed Brown }
398e5c89e4eSSatish Balay 
399e5c89e4eSSatish Balay /*@C
400e5c89e4eSSatish Balay    PetscGetArgs - Allows you to access the raw command line arguments anywhere
401e5c89e4eSSatish Balay      after PetscInitialize() is called but before PetscFinalize().
402e5c89e4eSSatish Balay 
403e5c89e4eSSatish Balay    Not Collective
404e5c89e4eSSatish Balay 
405e5c89e4eSSatish Balay    Output Parameters:
406e5c89e4eSSatish Balay +  argc - count of number of command line arguments
407e5c89e4eSSatish Balay -  args - the command line arguments
408e5c89e4eSSatish Balay 
409e5c89e4eSSatish Balay    Level: intermediate
410e5c89e4eSSatish Balay 
411e5c89e4eSSatish Balay    Notes:
412e5c89e4eSSatish Balay       This is usually used to pass the command line arguments into other libraries
413e5c89e4eSSatish Balay    that are called internally deep in PETSc or the application.
414e5c89e4eSSatish Balay 
415f177e3b1SBarry Smith       The first argument contains the program name as is normal for C arguments.
416f177e3b1SBarry Smith 
417e5c89e4eSSatish Balay    Concepts: command line arguments
418e5c89e4eSSatish Balay 
419793721a6SBarry Smith .seealso: PetscFinalize(), PetscInitializeFortran(), PetscGetArguments()
420e5c89e4eSSatish Balay 
421e5c89e4eSSatish Balay @*/
4227087cfbeSBarry Smith PetscErrorCode  PetscGetArgs(int *argc,char ***args)
423e5c89e4eSSatish Balay {
424e5c89e4eSSatish Balay   PetscFunctionBegin;
42517186662SBarry Smith   if (!PetscInitializeCalled && PetscFinalizeCalled) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ORDER,"You must call after PetscInitialize() but before PetscFinalize()");
426e5c89e4eSSatish Balay   *argc = PetscGlobalArgc;
427e5c89e4eSSatish Balay   *args = PetscGlobalArgs;
428e5c89e4eSSatish Balay   PetscFunctionReturn(0);
429e5c89e4eSSatish Balay }
430e5c89e4eSSatish Balay 
431793721a6SBarry Smith /*@C
432793721a6SBarry Smith    PetscGetArguments - Allows you to access the  command line arguments anywhere
433793721a6SBarry Smith      after PetscInitialize() is called but before PetscFinalize().
434793721a6SBarry Smith 
435793721a6SBarry Smith    Not Collective
436793721a6SBarry Smith 
437793721a6SBarry Smith    Output Parameters:
438793721a6SBarry Smith .  args - the command line arguments
439793721a6SBarry Smith 
440793721a6SBarry Smith    Level: intermediate
441793721a6SBarry Smith 
442793721a6SBarry Smith    Notes:
443793721a6SBarry Smith       This does NOT start with the program name and IS null terminated (final arg is void)
444793721a6SBarry Smith 
445793721a6SBarry Smith    Concepts: command line arguments
446793721a6SBarry Smith 
447793721a6SBarry Smith .seealso: PetscFinalize(), PetscInitializeFortran(), PetscGetArgs(), PetscFreeArguments()
448793721a6SBarry Smith 
449793721a6SBarry Smith @*/
4507087cfbeSBarry Smith PetscErrorCode  PetscGetArguments(char ***args)
451793721a6SBarry Smith {
452793721a6SBarry Smith   PetscInt       i,argc = PetscGlobalArgc;
453793721a6SBarry Smith   PetscErrorCode ierr;
454793721a6SBarry Smith 
455793721a6SBarry Smith   PetscFunctionBegin;
45617186662SBarry Smith   if (!PetscInitializeCalled && PetscFinalizeCalled) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ORDER,"You must call after PetscInitialize() but before PetscFinalize()");
457717030eeSLisandro Dalcin   if (!argc) {*args = 0; PetscFunctionReturn(0);}
458785e854fSJed Brown   ierr = PetscMalloc1(argc,args);CHKERRQ(ierr);
459793721a6SBarry Smith   for (i=0; i<argc-1; i++) {
460793721a6SBarry Smith     ierr = PetscStrallocpy(PetscGlobalArgs[i+1],&(*args)[i]);CHKERRQ(ierr);
461793721a6SBarry Smith   }
462793721a6SBarry Smith   (*args)[argc-1] = 0;
463793721a6SBarry Smith   PetscFunctionReturn(0);
464793721a6SBarry Smith }
465793721a6SBarry Smith 
466793721a6SBarry Smith /*@C
467793721a6SBarry Smith    PetscFreeArguments - Frees the memory obtained with PetscGetArguments()
468793721a6SBarry Smith 
469793721a6SBarry Smith    Not Collective
470793721a6SBarry Smith 
471793721a6SBarry Smith    Output Parameters:
472793721a6SBarry Smith .  args - the command line arguments
473793721a6SBarry Smith 
474793721a6SBarry Smith    Level: intermediate
475793721a6SBarry Smith 
476793721a6SBarry Smith    Concepts: command line arguments
477793721a6SBarry Smith 
478793721a6SBarry Smith .seealso: PetscFinalize(), PetscInitializeFortran(), PetscGetArgs(), PetscGetArguments()
479793721a6SBarry Smith 
480793721a6SBarry Smith @*/
4817087cfbeSBarry Smith PetscErrorCode  PetscFreeArguments(char **args)
482793721a6SBarry Smith {
483793721a6SBarry Smith   PetscInt       i = 0;
484793721a6SBarry Smith   PetscErrorCode ierr;
485793721a6SBarry Smith 
486793721a6SBarry Smith   PetscFunctionBegin;
487a297a907SKarl Rupp   if (!args) PetscFunctionReturn(0);
488793721a6SBarry Smith   while (args[i]) {
489793721a6SBarry Smith     ierr = PetscFree(args[i]);CHKERRQ(ierr);
490793721a6SBarry Smith     i++;
491793721a6SBarry Smith   }
492793721a6SBarry Smith   ierr = PetscFree(args);CHKERRQ(ierr);
493793721a6SBarry Smith   PetscFunctionReturn(0);
494793721a6SBarry Smith }
495793721a6SBarry Smith 
49611525c0dSBarry Smith #if defined(PETSC_HAVE_SAWS)
49730befbd2SBarry Smith #include <petscconfiginfo.h>
49830befbd2SBarry Smith 
49911525c0dSBarry Smith PetscErrorCode  PetscInitializeSAWs(const char help[])
50011525c0dSBarry Smith {
50111525c0dSBarry Smith   if (!PetscGlobalRank) {
50230befbd2SBarry Smith     char           cert[PETSC_MAX_PATH_LEN],root[PETSC_MAX_PATH_LEN],*intro,programname[64],*appline,*options,version[64];
50311525c0dSBarry Smith     int            port;
504ffbd1cfbSBarry Smith     PetscBool      flg,rootlocal = PETSC_FALSE,flg2,selectport = PETSC_FALSE;
50511525c0dSBarry Smith     size_t         applinelen,introlen;
50611525c0dSBarry Smith     PetscErrorCode ierr;
507ffbd1cfbSBarry Smith     char           sawsurl[256];
50811525c0dSBarry Smith 
509c5929fdfSBarry Smith     ierr = PetscOptionsHasName(NULL,NULL,"-saws_log",&flg);CHKERRQ(ierr);
51011525c0dSBarry Smith     if (flg) {
51111525c0dSBarry Smith       char  sawslog[PETSC_MAX_PATH_LEN];
51211525c0dSBarry Smith 
513c5929fdfSBarry Smith       ierr = PetscOptionsGetString(NULL,NULL,"-saws_log",sawslog,PETSC_MAX_PATH_LEN,NULL);CHKERRQ(ierr);
51411525c0dSBarry Smith       if (sawslog[0]) {
51511525c0dSBarry Smith         PetscStackCallSAWs(SAWs_Set_Use_Logfile,(sawslog));
51611525c0dSBarry Smith       } else {
51711525c0dSBarry Smith         PetscStackCallSAWs(SAWs_Set_Use_Logfile,(NULL));
51811525c0dSBarry Smith       }
51911525c0dSBarry Smith     }
520c5929fdfSBarry Smith     ierr = PetscOptionsGetString(NULL,NULL,"-saws_https",cert,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr);
52111525c0dSBarry Smith     if (flg) {
52211525c0dSBarry Smith       PetscStackCallSAWs(SAWs_Set_Use_HTTPS,(cert));
52311525c0dSBarry Smith     }
524c5929fdfSBarry Smith     ierr = PetscOptionsGetBool(NULL,NULL,"-saws_port_auto_select",&selectport,NULL);CHKERRQ(ierr);
525ffbd1cfbSBarry Smith     if (selectport) {
526ffbd1cfbSBarry Smith         PetscStackCallSAWs(SAWs_Get_Available_Port,(&port));
527ffbd1cfbSBarry Smith         PetscStackCallSAWs(SAWs_Set_Port,(port));
528ffbd1cfbSBarry Smith     } else {
529c5929fdfSBarry Smith       ierr = PetscOptionsGetInt(NULL,NULL,"-saws_port",&port,&flg);CHKERRQ(ierr);
53011525c0dSBarry Smith       if (flg) {
53111525c0dSBarry Smith         PetscStackCallSAWs(SAWs_Set_Port,(port));
53211525c0dSBarry Smith       }
533ffbd1cfbSBarry Smith     }
534c5929fdfSBarry Smith     ierr = PetscOptionsGetString(NULL,NULL,"-saws_root",root,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr);
53511525c0dSBarry Smith     if (flg) {
53611525c0dSBarry Smith       PetscStackCallSAWs(SAWs_Set_Document_Root,(root));CHKERRQ(ierr);
53711525c0dSBarry Smith       ierr = PetscStrcmp(root,".",&rootlocal);CHKERRQ(ierr);
5389c1e0ce8SBarry Smith     } else {
539c5929fdfSBarry Smith       ierr = PetscOptionsHasName(NULL,NULL,"-saws_options",&flg);CHKERRQ(ierr);
5409c1e0ce8SBarry Smith       if (flg) {
5413c01dfcfSBarry Smith         ierr = PetscStrreplace(PETSC_COMM_WORLD,"${PETSC_DIR}/share/petsc/saws",root,PETSC_MAX_PATH_LEN);CHKERRQ(ierr);
5429c1e0ce8SBarry Smith         PetscStackCallSAWs(SAWs_Set_Document_Root,(root));CHKERRQ(ierr);
5439c1e0ce8SBarry Smith       }
54411525c0dSBarry Smith     }
545c5929fdfSBarry Smith     ierr = PetscOptionsHasName(NULL,NULL,"-saws_local",&flg2);CHKERRQ(ierr);
54611525c0dSBarry Smith     if (flg2) {
54711525c0dSBarry Smith       char jsdir[PETSC_MAX_PATH_LEN];
54811525c0dSBarry Smith       if (!flg) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SUP,"-saws_local option requires -saws_root option");
54911525c0dSBarry Smith       ierr = PetscSNPrintf(jsdir,PETSC_MAX_PATH_LEN,"%s/js",root);CHKERRQ(ierr);
55011525c0dSBarry Smith       ierr = PetscTestDirectory(jsdir,'r',&flg);CHKERRQ(ierr);
55111525c0dSBarry Smith       if (!flg) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_FILE_READ,"-saws_local option requires js directory in root directory");
55243da4ab2SBarry Smith       PetscStackCallSAWs(SAWs_Push_Local_Header,());CHKERRQ(ierr);
55311525c0dSBarry Smith     }
55411525c0dSBarry Smith     ierr = PetscGetProgramName(programname,64);CHKERRQ(ierr);
55511525c0dSBarry Smith     ierr = PetscStrlen(help,&applinelen);CHKERRQ(ierr);
55611525c0dSBarry Smith     introlen   = 4096 + applinelen;
55730a8c9c0SSurtai Han     applinelen += 1024;
55811525c0dSBarry Smith     ierr = PetscMalloc(applinelen,&appline);CHKERRQ(ierr);
55911525c0dSBarry Smith     ierr = PetscMalloc(introlen,&intro);CHKERRQ(ierr);
56011525c0dSBarry Smith 
56111525c0dSBarry Smith     if (rootlocal) {
56211525c0dSBarry Smith       ierr = PetscSNPrintf(appline,applinelen,"%s.c.html",programname);CHKERRQ(ierr);
56311525c0dSBarry Smith       ierr = PetscTestFile(appline,'r',&rootlocal);CHKERRQ(ierr);
56411525c0dSBarry Smith     }
56576a34f28SBarry Smith     ierr = PetscOptionsGetAll(NULL,&options);CHKERRQ(ierr);
56611525c0dSBarry Smith     if (rootlocal && help) {
56730befbd2SBarry 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);
56811525c0dSBarry Smith     } else if (help) {
56930a8c9c0SSurtai Han       ierr = PetscSNPrintf(appline,applinelen,"<center>Running %s %s</center><br><center><pre>%s</pre></center><br>",programname,options,help);
57011525c0dSBarry Smith     } else {
57130befbd2SBarry Smith       ierr = PetscSNPrintf(appline,applinelen,"<center> Running %s %s</center><br>\n",programname,options);
57211525c0dSBarry Smith     }
573b0bb5815SBarry Smith     ierr = PetscFree(options);CHKERRQ(ierr);
57430befbd2SBarry Smith     ierr = PetscGetVersion(version,sizeof(version));CHKERRQ(ierr);
57511525c0dSBarry Smith     ierr = PetscSNPrintf(intro,introlen,"<body>\n"
57611525c0dSBarry 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"
577df62c222SBarry 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"
578df62c222SBarry Smith                                     "%s",version,petscconfigureoptions,appline);
57943da4ab2SBarry Smith     PetscStackCallSAWs(SAWs_Push_Body,("index.html",0,intro));
58011525c0dSBarry Smith     ierr = PetscFree(intro);CHKERRQ(ierr);
58111525c0dSBarry Smith     ierr = PetscFree(appline);CHKERRQ(ierr);
582ffbd1cfbSBarry Smith     if (selectport) {
583aa573868SBarry Smith       PetscBool silent;
5847d812c46SBarry Smith 
5857d812c46SBarry Smith       ierr = SAWs_Initialize();
5867d812c46SBarry Smith       /* another process may have grabbed the port so keep trying */
5877d812c46SBarry Smith       while (ierr) {
5887d812c46SBarry Smith         PetscStackCallSAWs(SAWs_Get_Available_Port,(&port));
5897d812c46SBarry Smith         PetscStackCallSAWs(SAWs_Set_Port,(port));
5907d812c46SBarry Smith         ierr = SAWs_Initialize();
5917d812c46SBarry Smith       }
5927d812c46SBarry Smith 
593aa573868SBarry Smith       ierr = PetscOptionsGetBool(NULL,NULL,"-saws_port_auto_select_silent",&silent,NULL);CHKERRQ(ierr);
594aa573868SBarry Smith       if (!silent) {
595ffbd1cfbSBarry Smith         PetscStackCallSAWs(SAWs_Get_FullURL,(sizeof(sawsurl),sawsurl));
596ffbd1cfbSBarry Smith         ierr = PetscPrintf(PETSC_COMM_WORLD,"Point your browser to %s for SAWs\n",sawsurl);CHKERRQ(ierr);
597ffbd1cfbSBarry Smith       }
5987d812c46SBarry Smith     } else {
5997d812c46SBarry Smith       PetscStackCallSAWs(SAWs_Initialize,());
600aa573868SBarry Smith     }
6010af79b04SBarry Smith     ierr = PetscCitationsRegister("@TechReport{ saws,\n"
6020af79b04SBarry Smith                                   "  Author = {Matt Otten and Jed Brown and Barry Smith},\n"
6030af79b04SBarry Smith                                   "  Title  = {Scientific Application Web Server (SAWs) Users Manual},\n"
6040af79b04SBarry Smith                                   "  Institution = {Argonne National Laboratory},\n"
6050af79b04SBarry Smith                                   "  Year   = 2013\n}\n",NULL);CHKERRQ(ierr);
60611525c0dSBarry Smith   }
60711525c0dSBarry Smith   PetscFunctionReturn(0);
60811525c0dSBarry Smith }
60911525c0dSBarry Smith #endif
61011525c0dSBarry Smith 
611e5c89e4eSSatish Balay /*@C
612e5c89e4eSSatish Balay    PetscInitialize - Initializes the PETSc database and MPI.
613e5c89e4eSSatish Balay    PetscInitialize() calls MPI_Init() if that has yet to be called,
614e5c89e4eSSatish Balay    so this routine should always be called near the beginning of
615e5c89e4eSSatish Balay    your program -- usually the very first line!
616e5c89e4eSSatish Balay 
617e5c89e4eSSatish Balay    Collective on MPI_COMM_WORLD or PETSC_COMM_WORLD if it has been set
618e5c89e4eSSatish Balay 
619e5c89e4eSSatish Balay    Input Parameters:
620e5c89e4eSSatish Balay +  argc - count of number of command line arguments
621e5c89e4eSSatish Balay .  args - the command line arguments
6220298fd71SBarry Smith .  file - [optional] PETSc database file, also checks ~username/.petscrc and .petscrc use NULL to not check for
623fc2bca9aSBarry Smith           code specific file. Use -skip_petscrc in the code specific file to skip the .petscrc files
6240298fd71SBarry Smith -  help - [optional] Help message to print, use NULL for no message
625e5c89e4eSSatish Balay 
62605827820SBarry Smith    If you wish PETSc code to run ONLY on a subcommunicator of MPI_COMM_WORLD, create that
62705827820SBarry Smith    communicator first and assign it to PETSC_COMM_WORLD BEFORE calling PetscInitialize(). Thus if you are running a
62805827820SBarry Smith    four process job and two processes will run PETSc and have PetscInitialize() and PetscFinalize() and two process will not,
62905827820SBarry Smith    then do this. If ALL processes in the job are using PetscInitialize() and PetscFinalize() then you don't need to do this, even
63005827820SBarry Smith    if different subcommunicators of the job are doing different things with PETSc.
631e5c89e4eSSatish Balay 
632e5c89e4eSSatish Balay    Options Database Keys:
6337ca660e7SBarry Smith +  -help [intro] - prints help method for each option; if intro is given the program stops after printing the introductory help message
6347ca660e7SBarry Smith .  -start_in_debugger [noxterm,dbx,xdb,gdb,...] - Starts program in debugger
635e5c89e4eSSatish Balay .  -on_error_attach_debugger [noxterm,dbx,xdb,gdb,...] - Starts debugger when error detected
636e5c89e4eSSatish Balay .  -on_error_emacs <machinename> causes emacsclient to jump to error file
637b52f573bSBarry Smith .  -on_error_abort calls abort() when error detected (no traceback)
638e8fb0fc0SBarry Smith .  -on_error_mpiabort calls MPI_abort() when error detected
639e8fb0fc0SBarry Smith .  -error_output_stderr prints error messages to stderr instead of the default stdout
640e8fb0fc0SBarry Smith .  -error_output_none does not print the error messages (but handles errors in the same way as if this was not called)
641e5c89e4eSSatish Balay .  -debugger_nodes [node1,node2,...] - Indicates nodes to start in debugger
642e5c89e4eSSatish Balay .  -debugger_pause [sleeptime] (in seconds) - Pauses debugger
643e5c89e4eSSatish Balay .  -stop_for_debugger - Print message on how to attach debugger manually to
644e5c89e4eSSatish Balay                         process and wait (-debugger_pause) seconds for attachment
6452fb0ec9aSBarry Smith .  -malloc - Indicates use of PETSc error-checking malloc (on by default for debug version of libraries)
646e5c89e4eSSatish Balay .  -malloc no - Indicates not to use error-checking malloc
6472fb0ec9aSBarry Smith .  -malloc_debug - check for memory corruption at EVERY malloc or free
648aee23540SBarry Smith .  -malloc_dump - prints a list of all unfreed memory at the end of the run
649dc92acbaSJed Brown .  -malloc_test - like -malloc_dump -malloc_debug, but only active for debugging builds
650e5c89e4eSSatish Balay .  -fp_trap - Stops on floating point exceptions (Note that on the
651e5c89e4eSSatish Balay               IBM RS6000 this slows code by at least a factor of 10.)
652e5c89e4eSSatish Balay .  -no_signal_handler - Indicates not to trap error signals
653e5c89e4eSSatish Balay .  -shared_tmp - indicates /tmp directory is shared by all processors
654e5c89e4eSSatish Balay .  -not_shared_tmp - each processor has own /tmp
655e5c89e4eSSatish Balay .  -tmp - alternative name of /tmp directory
656e5c89e4eSSatish Balay .  -get_total_flops - returns total flops done by all processors
6570841954dSBarry Smith -  -memory_view - Print memory usage at end of run
658e5c89e4eSSatish Balay 
659e5c89e4eSSatish Balay    Options Database Keys for Profiling:
660a7f22e61SSatish Balay    See Users-Manual: ch_profiling for details.
661495fc317SBarry Smith +  -info <optional filename> - Prints verbose information to the screen
662495fc317SBarry Smith .  -info_exclude <null,vec,mat,pc,ksp,snes,ts> - Excludes some of the verbose messages
663495fc317SBarry Smith .  -log_sync - Log the synchronization in scatters, inner products and norms
664495fc317SBarry Smith .  -log_trace [filename] - Print traces of all PETSc calls to the screen (useful to determine where a program
665e5c89e4eSSatish Balay         hangs without running in the debugger).  See PetscLogTraceBegin().
6669a9a5d4cSBarry Smith .  -log_view [:filename:format] - Prints summary of flop and timing information to screen or file, see PetscLogView().
6679a9a5d4cSBarry Smith .  -log_summary [filename] - (Deprecated, use -log_view) Prints summary of flop and timing information to screen. If the filename is specified the
668495fc317SBarry Smith         summary is written to the file.  See PetscLogView().
6699a9a5d4cSBarry Smith .  -log_exclude: <vec,mat,pc.ksp,snes> - excludes subset of object classes from logging
670495fc317SBarry Smith .  -log_all [filename] - Logs extensive profiling information  See PetscLogDump().
671495fc317SBarry Smith .  -log [filename] - Logs basic profiline information  See PetscLogDump().
672*c2f74817SBarry Smith .  -log_mpe [filename] - Creates a logfile viewable by the utility Jumpshot (in MPICH distribution)
673*c2f74817SBarry Smith -  -check_pointer_intensity 0,1,2 - if pointers are checked for validity (debug version only), using 0 will result in faster code
674495fc317SBarry Smith 
675609bdbeeSBarry Smith     Only one of -log_trace, -log_view, -log_view, -log_all, -log, or -log_mpe may be used at a time
676e5c89e4eSSatish Balay 
677ffbd1cfbSBarry Smith    Options Database Keys for SAWs:
678ffbd1cfbSBarry Smith +  -saws_port <portnumber> - port number to publish SAWs data, default is 8080
679ffbd1cfbSBarry 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
680ffbd1cfbSBarry Smith                             this is useful when you are running many jobs that utilize SAWs at the same time
681ffbd1cfbSBarry Smith .  -saws_log <filename> - save a log of all SAWs communication
682ffbd1cfbSBarry Smith .  -saws_https <certificate file> - have SAWs use HTTPS instead of HTTP
683ffbd1cfbSBarry Smith -  -saws_root <directory> - allow SAWs to have access to the given directory to search for requested resources and files
684ffbd1cfbSBarry Smith 
685e5c89e4eSSatish Balay    Environmental Variables:
686e5c89e4eSSatish Balay +   PETSC_TMP - alternative tmp directory
687e5c89e4eSSatish Balay .   PETSC_SHARED_TMP - tmp is shared by all processes
688e5c89e4eSSatish Balay .   PETSC_NOT_SHARED_TMP - each process has its own private tmp
689e5c89e4eSSatish Balay .   PETSC_VIEWER_SOCKET_PORT - socket number to use for socket viewer
690e5c89e4eSSatish Balay -   PETSC_VIEWER_SOCKET_MACHINE - machine to use for socket viewer to connect to
691e5c89e4eSSatish Balay 
692e5c89e4eSSatish Balay 
693e5c89e4eSSatish Balay    Level: beginner
694e5c89e4eSSatish Balay 
695e5c89e4eSSatish Balay    Notes:
696e5c89e4eSSatish Balay    If for some reason you must call MPI_Init() separately, call
697e5c89e4eSSatish Balay    it before PetscInitialize().
698e5c89e4eSSatish Balay 
699e5c89e4eSSatish Balay    Fortran Version:
700e5c89e4eSSatish Balay    In Fortran this routine has the format
701e5c89e4eSSatish Balay $       call PetscInitialize(file,ierr)
702e5c89e4eSSatish Balay 
703e5c89e4eSSatish Balay +   ierr - error return code
7040eb4c9c0SBarry Smith -  file - [optional] PETSc database file, also checks ~username/.petscrc and .petscrc use PETSC_NULL_CHARACTER to not check for
705fc2bca9aSBarry Smith           code specific file. Use -skip_petscrc in the code specific file to skip the .petscrc files
706e5c89e4eSSatish Balay 
707e5c89e4eSSatish Balay    Important Fortran Note:
7080eb4c9c0SBarry Smith    In Fortran, you MUST use PETSC_NULL_CHARACTER to indicate a
7090298fd71SBarry Smith    null character string; you CANNOT just use NULL as
710a7f22e61SSatish Balay    in the C version. See Users-Manual: ch_fortran for details.
711e5c89e4eSSatish Balay 
71201cb0274SBarry Smith    If your main program is C but you call Fortran code that also uses PETSc you need to call PetscInitializeFortran() soon after
71301cb0274SBarry Smith    calling PetscInitialize().
714e5c89e4eSSatish Balay 
715e5c89e4eSSatish Balay    Concepts: initializing PETSc
716e5c89e4eSSatish Balay 
71701cb0274SBarry Smith .seealso: PetscFinalize(), PetscInitializeFortran(), PetscGetArgs(), PetscInitializeNoArguments()
718e5c89e4eSSatish Balay 
719e5c89e4eSSatish Balay @*/
7207087cfbeSBarry Smith PetscErrorCode  PetscInitialize(int *argc,char ***args,const char file[],const char help[])
721e5c89e4eSSatish Balay {
722e5c89e4eSSatish Balay   PetscErrorCode ierr;
7234bb5149bSJed Brown   PetscMPIInt    flag, size;
72419c5658aSBarry Smith   PetscBool      flg = PETSC_TRUE;
725e5c89e4eSSatish Balay   char           hostname[256];
72682f73ecaSAlejandro Lamas Daviña #if defined(PETSC_HAVE_CUDA)
72782f73ecaSAlejandro Lamas Daviña   cublasStatus_t cberr;
72882f73ecaSAlejandro Lamas Daviña #endif
7295e71baefSBarry Smith #if defined(PETSC_HAVE_HWLOC)
7305e71baefSBarry Smith   PetscViewer    viewer;
7315e71baefSBarry Smith #endif
732e5c89e4eSSatish Balay 
733e5c89e4eSSatish Balay   PetscFunctionBegin;
734e5c89e4eSSatish Balay   if (PetscInitializeCalled) PetscFunctionReturn(0);
7353d96e996SBarry Smith   /*
7363d96e996SBarry Smith       The checking over compatible runtime libraries is complicated by the MPI ABI initiative
7373d96e996SBarry Smith       https://wiki.mpich.org/mpich/index.php/ABI_Compatibility_Initiative which started with
7383d96e996SBarry Smith         MPICH v3.1 (Released Feburary 2014)
7393d96e996SBarry Smith         IBM MPI v2.1 (December 2014)
7403d96e996SBarry Smith         Intel® MPI Library v5.0 (2014)
7413d96e996SBarry Smith         Cray MPT v7.0.0 (June 2014)
7423d96e996SBarry Smith       As of July 31, 2017 the ABI number still appears to be 12, that is all of the versions
7433d96e996SBarry Smith       listed above and since that time are compatible.
7443d96e996SBarry Smith 
7453d96e996SBarry Smith       Unfortunately the MPI ABI initiative has not defined a way to determine the ABI number
7463d96e996SBarry Smith       at compile time or runtime. Thus we will need to systematically track the allowed versions
7473d96e996SBarry Smith       and how they are represented in the mpi.h and MPI_Get_library_version() output in order
7483d96e996SBarry Smith       to perform the checking.
7493d96e996SBarry Smith 
7503d96e996SBarry Smith       Currently we only check for pre MPI ABI versions (and packages that do not follow the MPI ABI).
7513d96e996SBarry Smith 
7523d96e996SBarry Smith       Questions:
7533d96e996SBarry Smith 
7543d96e996SBarry Smith         Should the checks for ABI incompatibility be only on the major version number below?
7553d96e996SBarry Smith         Presumably the output to stderr will be removed before a release.
7563d96e996SBarry Smith   */
7573d96e996SBarry Smith 
75819c5658aSBarry Smith #if defined(PETSC_HAVE_MPI_GET_LIBRARY_VERSION)
75919c5658aSBarry Smith   {
76019c5658aSBarry Smith     char        mpilibraryversion[MPI_MAX_LIBRARY_VERSION_STRING];
76119c5658aSBarry Smith     PetscMPIInt mpilibraryversionlength;
76219c5658aSBarry Smith     ierr = MPI_Get_library_version(mpilibraryversion,&mpilibraryversionlength);if (ierr) return ierr;
7633d96e996SBarry Smith     /* check for MPICH versions before MPI ABI initiative */
76419c5658aSBarry Smith #if defined(MPICH_VERSION)
7653d96e996SBarry Smith #if MPICH_NUMVERSION < 30100000
76619c5658aSBarry Smith     {
76719c5658aSBarry Smith       char *ver,*lf;
76819c5658aSBarry Smith       flg = PETSC_FALSE;
76919c5658aSBarry Smith       ierr = PetscStrstr(mpilibraryversion,"MPICH Version:",&ver);if (ierr) return ierr;
77019c5658aSBarry Smith       if (ver) {
77119c5658aSBarry Smith         ierr = PetscStrchr(ver,'\n',&lf);if (ierr) return ierr;
77219c5658aSBarry Smith         if (lf) {
77319c5658aSBarry Smith           *lf = 0;
77419c5658aSBarry Smith           ierr = PetscStrendswith(ver,MPICH_VERSION,&flg);if (ierr) return ierr;
77519c5658aSBarry Smith         }
77619c5658aSBarry Smith       }
77719c5658aSBarry Smith       if (!flg) {
77819c5658aSBarry Smith         fprintf(stderr,"PETSc Error --- MPICH library version \n%s does not match what PETSc was compiled with %s, aborting\n",mpilibraryversion,MPICH_VERSION);
7793d96e996SBarry Smith         return PETSC_ERR_MPI_LIB_INCOMP;
78019c5658aSBarry Smith       }
78119c5658aSBarry Smith     }
7823d96e996SBarry Smith #endif
7833d96e996SBarry 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?) */
78419c5658aSBarry Smith #elif defined(OMPI_MAJOR_VERSION)
78519c5658aSBarry Smith     {
78619c5658aSBarry Smith       char *ver,bs[32],*bsf;
78719c5658aSBarry Smith       flg = PETSC_FALSE;
78819c5658aSBarry Smith       ierr = PetscStrstr(mpilibraryversion,"Open MPI",&ver);if (ierr) return ierr;
78919c5658aSBarry Smith       if (ver) {
79019c5658aSBarry Smith         sprintf(bs,"v%d.%d",OMPI_MAJOR_VERSION,OMPI_MINOR_VERSION);
79119c5658aSBarry Smith         ierr = PetscStrstr(ver,bs,&bsf);if (ierr) return ierr;
79219c5658aSBarry Smith         if (bsf) flg = PETSC_TRUE;
79319c5658aSBarry Smith       }
79419c5658aSBarry Smith       if (!flg) {
79519c5658aSBarry 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);
7963d96e996SBarry Smith         return PETSC_ERR_MPI_LIB_INCOMP;
79719c5658aSBarry Smith       }
79819c5658aSBarry Smith     }
79919c5658aSBarry Smith #endif
80019c5658aSBarry Smith   }
80119c5658aSBarry Smith #endif
80219c5658aSBarry Smith 
803e5c89e4eSSatish Balay 
804ae9b4142SLisandro Dalcin   /* these must be initialized in a routine, not as a constant declaration*/
805d89683f4Sbcordonn   PETSC_STDOUT = stdout;
806ae9b4142SLisandro Dalcin   PETSC_STDERR = stderr;
807e5c89e4eSSatish Balay 
8080c30907bSSatish Balay   /* on Windows - set printf to default to printing 2 digit exponents */
8090c30907bSSatish Balay #if defined(PETSC_HAVE__SET_OUTPUT_FORMAT)
8100c30907bSSatish Balay   _set_output_format(_TWO_DIGIT_EXPONENT);
8110c30907bSSatish Balay #endif
8120c30907bSSatish Balay 
8134416b707SBarry Smith   ierr = PetscOptionsCreateDefault();CHKERRQ(ierr);
814e5c89e4eSSatish Balay 
815e5c89e4eSSatish Balay   /*
816e5c89e4eSSatish Balay      We initialize the program name here (before MPI_Init()) because MPICH has a bug in
817e5c89e4eSSatish Balay      it that it sets args[0] on all processors to be args[0] on the first processor.
818e5c89e4eSSatish Balay   */
819e5c89e4eSSatish Balay   if (argc && *argc) {
820e5c89e4eSSatish Balay     ierr = PetscSetProgramName(**args);CHKERRQ(ierr);
821e5c89e4eSSatish Balay   } else {
822e5c89e4eSSatish Balay     ierr = PetscSetProgramName("Unknown Name");CHKERRQ(ierr);
823e5c89e4eSSatish Balay   }
824e5c89e4eSSatish Balay 
825e5c89e4eSSatish Balay   ierr = MPI_Initialized(&flag);CHKERRQ(ierr);
826e5c89e4eSSatish Balay   if (!flag) {
827e32f2f54SBarry 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");
8285e765c61SJed Brown #if defined(PETSC_HAVE_MPI_INIT_THREAD)
8295e765c61SJed Brown     {
8305e765c61SJed Brown       PetscMPIInt provided;
8315e765c61SJed Brown       ierr = MPI_Init_thread(argc,args,MPI_THREAD_FUNNELED,&provided);CHKERRQ(ierr);
8325e765c61SJed Brown     }
8335e765c61SJed Brown #else
834e5c89e4eSSatish Balay     ierr = MPI_Init(argc,args);CHKERRQ(ierr);
8355e765c61SJed Brown #endif
836e5c89e4eSSatish Balay     PetscBeganMPI = PETSC_TRUE;
837e5c89e4eSSatish Balay   }
838e5c89e4eSSatish Balay   if (argc && args) {
839e5c89e4eSSatish Balay     PetscGlobalArgc = *argc;
840e5c89e4eSSatish Balay     PetscGlobalArgs = *args;
841e5c89e4eSSatish Balay   }
842e5c89e4eSSatish Balay   PetscFinalizeCalled = PETSC_FALSE;
8435ad9ad5bSBarry Smith   ierr = PetscSpinlockCreate(&PetscViewerASCIISpinLockOpen);CHKERRQ(ierr);
8445ad9ad5bSBarry Smith   ierr = PetscSpinlockCreate(&PetscViewerASCIISpinLockStdout);CHKERRQ(ierr);
8455ad9ad5bSBarry Smith   ierr = PetscSpinlockCreate(&PetscViewerASCIISpinLockStderr);CHKERRQ(ierr);
846ef19f930SBarry Smith   ierr = PetscSpinlockCreate(&PetscCommSpinLock);CHKERRQ(ierr);
847e5c89e4eSSatish Balay 
848a297a907SKarl Rupp   if (PETSC_COMM_WORLD == MPI_COMM_NULL) PETSC_COMM_WORLD = MPI_COMM_WORLD;
849d54338ecSKarl Rupp   ierr = MPI_Comm_set_errhandler(PETSC_COMM_WORLD,MPI_ERRORS_RETURN);CHKERRQ(ierr);
850e5c89e4eSSatish Balay 
85112801b39SBarry Smith   ierr = MPI_Add_error_class(&PETSC_MPI_ERROR_CLASS);CHKERRQ(ierr);
85212801b39SBarry Smith   ierr = MPI_Add_error_code(PETSC_MPI_ERROR_CLASS,&PETSC_MPI_ERROR_CODE);CHKERRQ(ierr);
85312801b39SBarry Smith 
854e5c89e4eSSatish Balay   /* Done after init due to a bug in MPICH-GM? */
855e5c89e4eSSatish Balay   ierr = PetscErrorPrintfInitialize();CHKERRQ(ierr);
856e5c89e4eSSatish Balay 
857e5c89e4eSSatish Balay   ierr = MPI_Comm_rank(MPI_COMM_WORLD,&PetscGlobalRank);CHKERRQ(ierr);
858e5c89e4eSSatish Balay   ierr = MPI_Comm_size(MPI_COMM_WORLD,&PetscGlobalSize);CHKERRQ(ierr);
859e5c89e4eSSatish Balay 
8608ad47952SJed Brown   MPIU_BOOL = MPI_INT;
8618ad47952SJed Brown   MPIU_ENUM = MPI_INT;
8628ad47952SJed Brown 
863e5c89e4eSSatish Balay   /*
864e5c89e4eSSatish Balay      Initialized the global complex variable; this is because with
865e5c89e4eSSatish Balay      shared libraries the constructors for global variables
866e5c89e4eSSatish Balay      are not called; at least on IRIX.
867e5c89e4eSSatish Balay   */
868886cfec0SSatish Balay #if defined(PETSC_HAVE_COMPLEX)
869e5c89e4eSSatish Balay   {
870252ecd31SSatish Balay #if defined(PETSC_CLANGUAGE_CXX) && !defined(PETSC_USE_REAL___FLOAT128)
87150f81f78SJed Brown     PetscComplex ic(0.0,1.0);
872e5c89e4eSSatish Balay     PETSC_i = ic;
873252ecd31SSatish Balay #else
87450f81f78SJed Brown     PETSC_i = _Complex_I;
875b7940d39SSatish Balay #endif
876762437b8SSatish Balay   }
877762437b8SSatish Balay 
8782c876bd9SBarry Smith #if !defined(PETSC_HAVE_MPI_C_DOUBLE_COMPLEX)
879e69cd0e6SSatish Balay   ierr = MPI_Type_contiguous(2,MPI_DOUBLE,&MPIU_C_DOUBLE_COMPLEX);CHKERRQ(ierr);
880500d8756SSatish Balay   ierr = MPI_Type_commit(&MPIU_C_DOUBLE_COMPLEX);CHKERRQ(ierr);
881500d8756SSatish Balay   ierr = MPI_Type_contiguous(2,MPI_FLOAT,&MPIU_C_COMPLEX);CHKERRQ(ierr);
882500d8756SSatish Balay   ierr = MPI_Type_commit(&MPIU_C_COMPLEX);CHKERRQ(ierr);
8832c876bd9SBarry Smith #endif
884886cfec0SSatish Balay #endif /* PETSC_HAVE_COMPLEX */
885e5c89e4eSSatish Balay 
886e5c89e4eSSatish Balay   /*
887e5c89e4eSSatish Balay      Create the PETSc MPI reduction operator that sums of the first
888e5c89e4eSSatish Balay      half of the entries and maxes the second half.
889e5c89e4eSSatish Balay   */
890367daffbSBarry Smith   ierr = MPI_Op_create(MPIU_MaxSum_Local,1,&MPIU_MAXSUM_OP);CHKERRQ(ierr);
891e5c89e4eSSatish Balay 
892ce63c4c1SBarry Smith #if defined(PETSC_USE_REAL___FLOAT128)
893c90a1750SBarry Smith   ierr = MPI_Type_contiguous(2,MPI_DOUBLE,&MPIU___FLOAT128);CHKERRQ(ierr);
894c90a1750SBarry Smith   ierr = MPI_Type_commit(&MPIU___FLOAT128);CHKERRQ(ierr);
8957c2de775SJed Brown #if defined(PETSC_HAVE_COMPLEX)
8968c764dc5SJose Roman   ierr = MPI_Type_contiguous(4,MPI_DOUBLE,&MPIU___COMPLEX128);CHKERRQ(ierr);
8978c764dc5SJose Roman   ierr = MPI_Type_commit(&MPIU___COMPLEX128);CHKERRQ(ierr);
8988c764dc5SJose Roman #endif
899d9822059SBarry Smith   ierr = MPI_Op_create(PetscMax_Local,1,&MPIU_MAX);CHKERRQ(ierr);
900d9822059SBarry Smith   ierr = MPI_Op_create(PetscMin_Local,1,&MPIU_MIN);CHKERRQ(ierr);
901570b7f6dSBarry Smith #elif defined(PETSC_USE_REAL___FP16)
902570b7f6dSBarry Smith   ierr = MPI_Type_contiguous(2,MPI_CHAR,&MPIU___FP16);CHKERRQ(ierr);
903570b7f6dSBarry Smith   ierr = MPI_Type_commit(&MPIU___FP16);CHKERRQ(ierr);
904570b7f6dSBarry Smith   ierr = MPI_Op_create(PetscMax_Local,1,&MPIU_MAX);CHKERRQ(ierr);
905570b7f6dSBarry Smith   ierr = MPI_Op_create(PetscMin_Local,1,&MPIU_MIN);CHKERRQ(ierr);
906c90a1750SBarry Smith #endif
907c90a1750SBarry Smith 
908570b7f6dSBarry Smith #if (defined(PETSC_HAVE_COMPLEX) && !defined(PETSC_HAVE_MPI_C_DOUBLE_COMPLEX)) || defined(PETSC_USE_REAL___FLOAT128) || defined(PETSC_USE_REAL___FP16)
909cca4cb22SSatish Balay   ierr = MPI_Op_create(PetscSum_Local,1,&MPIU_SUM);CHKERRQ(ierr);
910cca4cb22SSatish Balay #endif
911cca4cb22SSatish Balay 
912e5c89e4eSSatish Balay   ierr = MPI_Type_contiguous(2,MPIU_SCALAR,&MPIU_2SCALAR);CHKERRQ(ierr);
913e5c89e4eSSatish Balay   ierr = MPI_Type_commit(&MPIU_2SCALAR);CHKERRQ(ierr);
914e5c89e4eSSatish Balay 
91544041f26SJed Brown #if defined(PETSC_USE_64BIT_INDICES) || !defined(MPI_2INT)
916e5c89e4eSSatish Balay   ierr = MPI_Type_contiguous(2,MPIU_INT,&MPIU_2INT);CHKERRQ(ierr);
917e5c89e4eSSatish Balay   ierr = MPI_Type_commit(&MPIU_2INT);CHKERRQ(ierr);
91844041f26SJed Brown #endif
919e5c89e4eSSatish Balay 
920ec957eceSBarry Smith 
921e5c89e4eSSatish Balay   /*
922480cf27aSJed Brown      Attributes to be set on PETSc communicators
923480cf27aSJed Brown   */
92412801b39SBarry Smith   ierr = MPI_Comm_create_keyval(MPI_COMM_NULL_COPY_FN,Petsc_DelCounter,&Petsc_Counter_keyval,(void*)0);CHKERRQ(ierr);
92512801b39SBarry Smith   ierr = MPI_Comm_create_keyval(MPI_COMM_NULL_COPY_FN,Petsc_DelComm_Outer,&Petsc_InnerComm_keyval,(void*)0);CHKERRQ(ierr);
92612801b39SBarry Smith   ierr = MPI_Comm_create_keyval(MPI_COMM_NULL_COPY_FN,Petsc_DelComm_Inner,&Petsc_OuterComm_keyval,(void*)0);CHKERRQ(ierr);
92712801b39SBarry Smith   ierr = MPI_Comm_create_keyval(MPI_COMM_NULL_COPY_FN,Petsc_DelShared,&Petsc_Shared_keyval,(void*)0);CHKERRQ(ierr);
928480cf27aSJed Brown 
929480cf27aSJed Brown   /*
930e8fb0fc0SBarry Smith      Build the options database
931e5c89e4eSSatish Balay   */
932c5929fdfSBarry Smith   ierr = PetscOptionsInsert(NULL,argc,args,file);CHKERRQ(ierr);
933e5c89e4eSSatish Balay 
9346dc8fec2Sbcordonn 
935e5c89e4eSSatish Balay   /*
936e5c89e4eSSatish Balay      Print main application help message
937e5c89e4eSSatish Balay   */
938c5929fdfSBarry Smith   ierr = PetscOptionsHasName(NULL,NULL,"-help",&flg);CHKERRQ(ierr);
939e5c89e4eSSatish Balay   if (help && flg) {
940e5c89e4eSSatish Balay     ierr = PetscPrintf(PETSC_COMM_WORLD,help);CHKERRQ(ierr);
941e5c89e4eSSatish Balay   }
942e5c89e4eSSatish Balay   ierr = PetscOptionsCheckInitial_Private();CHKERRQ(ierr);
943e5c89e4eSSatish Balay 
944d45a07a7SBarry Smith   ierr = PetscCitationsInitialize();CHKERRQ(ierr);
945d45a07a7SBarry Smith 
946e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS)
94711525c0dSBarry Smith   ierr = PetscInitializeSAWs(help);CHKERRQ(ierr);
948f4202a44SBarry Smith #endif
949f4202a44SBarry Smith 
950896238b9SBarry Smith   /* Creates the logging data structures; this is enabled even if logging is not turned on */
951a9f03627SSatish Balay #if defined(PETSC_USE_LOG)
952896238b9SBarry Smith   ierr = PetscLogInitialize();CHKERRQ(ierr);
953a9f03627SSatish Balay #endif
954e5c89e4eSSatish Balay 
955e5c89e4eSSatish Balay   /*
956e5c89e4eSSatish Balay      Load the dynamic libraries (on machines that support them), this registers all
957e5c89e4eSSatish Balay      the solvers etc. (On non-dynamic machines this initializes the PetscDraw and PetscViewer classes)
958e5c89e4eSSatish Balay   */
959e5c89e4eSSatish Balay   ierr = PetscInitialize_DynamicLibraries();CHKERRQ(ierr);
960e5c89e4eSSatish Balay 
961e5c89e4eSSatish Balay   ierr = MPI_Comm_size(PETSC_COMM_WORLD,&size);CHKERRQ(ierr);
962ae15b995SBarry Smith   ierr = PetscInfo1(0,"PETSc successfully started: number of processors = %d\n",size);CHKERRQ(ierr);
963e5c89e4eSSatish Balay   ierr = PetscGetHostName(hostname,256);CHKERRQ(ierr);
964ae15b995SBarry Smith   ierr = PetscInfo1(0,"Running on machine: %s\n",hostname);CHKERRQ(ierr);
965e5c89e4eSSatish Balay 
966e5c89e4eSSatish Balay   ierr = PetscOptionsCheckInitial_Components();CHKERRQ(ierr);
967ef6c6fedSBoyana Norris   /* Check the options database for options related to the options database itself */
968c5929fdfSBarry Smith   ierr = PetscOptionsSetFromOptions(NULL);CHKERRQ(ierr);
969ef6c6fedSBoyana Norris 
970951e3c8eSBarry Smith #if defined(PETSC_USE_PETSC_MPI_EXTERNAL32)
971e39fd77fSBarry Smith   /*
972e39fd77fSBarry Smith       Tell MPI about our own data representation converter, this would/should be used if extern32 is not supported by the MPI
973e39fd77fSBarry Smith 
974e39fd77fSBarry Smith       Currently not used because it is not supported by MPICH.
975e39fd77fSBarry Smith   */
976e39fd77fSBarry Smith #if !defined(PETSC_WORDS_BIGENDIAN)
9770298fd71SBarry Smith   ierr = MPI_Register_datarep((char*)"petsc",PetscDataRep_read_conv_fn,PetscDataRep_write_conv_fn,PetscDataRep_extent_fn,NULL);CHKERRQ(ierr);
978e39fd77fSBarry Smith #endif
979951e3c8eSBarry Smith #endif
980e39fd77fSBarry Smith 
98135d88935SVictor Minden #if defined(PETSC_HAVE_CUDA)
98220e2c332SMatthew G. Knepley   flg  = PETSC_TRUE;
983c5929fdfSBarry Smith   ierr = PetscOptionsGetBool(NULL,NULL,"-cublas",&flg,NULL);CHKERRQ(ierr);
98420e2c332SMatthew G. Knepley   if (flg) {
9854bb5149bSJed Brown     PetscMPIInt p;
986663ba86aSMatthew G Knepley     for (p = 0; p < PetscGlobalSize; ++p) {
98782f73ecaSAlejandro Lamas Daviña       if (p == PetscGlobalRank) {
98882f73ecaSAlejandro Lamas Daviña         cberr = cublasCreate(&cublasv2handle);CHKERRCUBLAS(cberr);
98982f73ecaSAlejandro Lamas Daviña       }
990663ba86aSMatthew G Knepley       ierr = MPI_Barrier(PETSC_COMM_WORLD);CHKERRQ(ierr);
991663ba86aSMatthew G Knepley     }
9924bb5149bSJed Brown   }
9933e39abd9SVictor Minden #endif
99492e62aa6SBarry Smith 
995c5929fdfSBarry Smith   ierr = PetscOptionsHasName(NULL,NULL,"-python",&flg);CHKERRQ(ierr);
9969ac80d5eSLisandro Dalcin   if (flg) {
9979ac80d5eSLisandro Dalcin     PetscInitializeCalled = PETSC_TRUE;
9980298fd71SBarry Smith     ierr = PetscPythonInitialize(NULL,NULL);CHKERRQ(ierr);
9999ac80d5eSLisandro Dalcin   }
10009ac80d5eSLisandro Dalcin 
100141c0b4b3SShri Abhyankar   /*
100241c0b4b3SShri Abhyankar       Setup building of stack frames for all function calls
100341c0b4b3SShri Abhyankar   */
1004ef19f930SBarry Smith #if defined(PETSC_USE_DEBUG) && !defined(PETSC_HAVE_THREADSAFETY)
1005e1167bb9SShri Abhyankar   ierr = PetscStackCreate();CHKERRQ(ierr);
1006e1167bb9SShri Abhyankar #endif
1007e1167bb9SShri Abhyankar 
10082d53ad75SBarry Smith #if defined(PETSC_SERIALIZE_FUNCTIONS)
10092d53ad75SBarry Smith   ierr = PetscFPTCreate(10000);CHKERRQ(ierr);
10102d53ad75SBarry Smith #endif
10112d53ad75SBarry Smith 
10125e71baefSBarry Smith #if defined(PETSC_HAVE_HWLOC)
10135e71baefSBarry Smith   ierr   = PetscOptionsGetViewer(PETSC_COMM_WORLD,NULL,"-process_view",&viewer,NULL,&flg);CHKERRQ(ierr);
10145e71baefSBarry Smith   if (flg) {
10155e71baefSBarry Smith     ierr = PetscProcessPlacementView(viewer);CHKERRQ(ierr);
10165e71baefSBarry Smith   }
10175e71baefSBarry Smith #endif
1018dff31646SBarry Smith 
1019301d30feSBarry Smith   /*
1020301d30feSBarry Smith       Once we are completedly initialized then we can set this variables
1021301d30feSBarry Smith   */
1022301d30feSBarry Smith   PetscInitializeCalled = PETSC_TRUE;
1023301d30feSBarry Smith   PetscFunctionReturn(0);
1024e5c89e4eSSatish Balay }
1025e5c89e4eSSatish Balay 
10264097062eSBarry Smith #if defined(PETSC_USE_LOG)
10272eff7a51SBarry Smith extern PetscObject *PetscObjects;
10282eff7a51SBarry Smith extern PetscInt    PetscObjectsCounts, PetscObjectsMaxCounts;
102905df10baSBarry Smith extern PetscBool   PetscObjectsLog;
10304097062eSBarry Smith #endif
1031e5c89e4eSSatish Balay 
1032008a6e76SBarry Smith /*
1033008a6e76SBarry Smith     Frees all the MPI types and operations that PETSc may have created
1034008a6e76SBarry Smith */
1035008a6e76SBarry Smith PetscErrorCode  PetscFreeMPIResources(void)
1036008a6e76SBarry Smith {
1037008a6e76SBarry Smith   PetscErrorCode ierr;
1038008a6e76SBarry Smith 
1039008a6e76SBarry Smith   PetscFunctionBegin;
1040008a6e76SBarry Smith #if defined(PETSC_USE_REAL___FLOAT128)
1041008a6e76SBarry Smith   ierr = MPI_Type_free(&MPIU___FLOAT128);CHKERRQ(ierr);
1042008a6e76SBarry Smith #if defined(PETSC_HAVE_COMPLEX)
1043008a6e76SBarry Smith   ierr = MPI_Type_free(&MPIU___COMPLEX128);CHKERRQ(ierr);
1044008a6e76SBarry Smith #endif
1045008a6e76SBarry Smith   ierr = MPI_Op_free(&MPIU_MAX);CHKERRQ(ierr);
1046008a6e76SBarry Smith   ierr = MPI_Op_free(&MPIU_MIN);CHKERRQ(ierr);
1047008a6e76SBarry Smith #elif defined(PETSC_USE_REAL___FP16)
1048008a6e76SBarry Smith   ierr = MPI_Type_free(&MPIU___FP16);CHKERRQ(ierr);
1049008a6e76SBarry Smith   ierr = MPI_Op_free(&MPIU_MAX);CHKERRQ(ierr);
1050008a6e76SBarry Smith   ierr = MPI_Op_free(&MPIU_MIN);CHKERRQ(ierr);
1051008a6e76SBarry Smith #endif
1052008a6e76SBarry Smith 
1053008a6e76SBarry Smith #if defined(PETSC_HAVE_COMPLEX)
1054008a6e76SBarry Smith #if !defined(PETSC_HAVE_MPI_C_DOUBLE_COMPLEX)
1055008a6e76SBarry Smith   ierr = MPI_Type_free(&MPIU_C_DOUBLE_COMPLEX);CHKERRQ(ierr);
1056008a6e76SBarry Smith   ierr = MPI_Type_free(&MPIU_C_COMPLEX);CHKERRQ(ierr);
1057008a6e76SBarry Smith #endif
1058008a6e76SBarry Smith #endif
1059008a6e76SBarry Smith 
1060008a6e76SBarry Smith #if (defined(PETSC_HAVE_COMPLEX) && !defined(PETSC_HAVE_MPI_C_DOUBLE_COMPLEX)) || defined(PETSC_USE_REAL___FLOAT128) || defined(PETSC_USE_REAL___FP16)
1061008a6e76SBarry Smith   ierr = MPI_Op_free(&MPIU_SUM);CHKERRQ(ierr);
1062008a6e76SBarry Smith #endif
1063008a6e76SBarry Smith 
1064008a6e76SBarry Smith   ierr = MPI_Type_free(&MPIU_2SCALAR);CHKERRQ(ierr);
1065008a6e76SBarry Smith #if defined(PETSC_USE_64BIT_INDICES) || !defined(MPI_2INT)
1066008a6e76SBarry Smith   ierr = MPI_Type_free(&MPIU_2INT);CHKERRQ(ierr);
1067008a6e76SBarry Smith #endif
1068008a6e76SBarry Smith   ierr = MPI_Op_free(&MPIU_MAXSUM_OP);CHKERRQ(ierr);
1069008a6e76SBarry Smith   PetscFunctionReturn(0);
1070008a6e76SBarry Smith }
1071008a6e76SBarry Smith 
1072e5c89e4eSSatish Balay /*@C
1073e5c89e4eSSatish Balay    PetscFinalize - Checks for options to be called at the conclusion
1074e5c89e4eSSatish Balay    of the program. MPI_Finalize() is called only if the user had not
1075e5c89e4eSSatish Balay    called MPI_Init() before calling PetscInitialize().
1076e5c89e4eSSatish Balay 
1077e5c89e4eSSatish Balay    Collective on PETSC_COMM_WORLD
1078e5c89e4eSSatish Balay 
1079e5c89e4eSSatish Balay    Options Database Keys:
108088c29154SBarry Smith +  -options_table - Calls PetscOptionsView()
1081e5c89e4eSSatish Balay .  -options_left - Prints unused options that remain in the database
10827eb1d149SBarry Smith .  -objects_dump [all] - Prints list of objects allocated by the user that have not been freed, the option all cause all outstanding objects to be listed
1083e5c89e4eSSatish Balay .  -mpidump - Calls PetscMPIDump()
1084e5c89e4eSSatish Balay .  -malloc_dump - Calls PetscMallocDump()
1085e5c89e4eSSatish Balay .  -malloc_info - Prints total memory usage
1086e5c89e4eSSatish Balay -  -malloc_log - Prints summary of memory usage
1087e5c89e4eSSatish Balay 
1088e5c89e4eSSatish Balay    Level: beginner
1089e5c89e4eSSatish Balay 
1090e5c89e4eSSatish Balay    Note:
1091e5c89e4eSSatish Balay    See PetscInitialize() for more general runtime options.
1092e5c89e4eSSatish Balay 
109388c29154SBarry Smith .seealso: PetscInitialize(), PetscOptionsView(), PetscMallocDump(), PetscMPIDump(), PetscEnd()
1094e5c89e4eSSatish Balay @*/
10957087cfbeSBarry Smith PetscErrorCode  PetscFinalize(void)
1096e5c89e4eSSatish Balay {
1097e5c89e4eSSatish Balay   PetscErrorCode ierr;
10984bb5149bSJed Brown   PetscMPIInt    rank;
1099a8d2bbe5SBarry Smith   PetscInt       nopt;
11002bf49c77SBarry Smith   PetscBool      flg1 = PETSC_FALSE,flg2 = PETSC_FALSE,flg3 = PETSC_FALSE;
1101dff31646SBarry Smith   PetscBool      flg;
110210463e74SBarry Smith #if defined(PETSC_USE_LOG)
110310463e74SBarry Smith   char           mname[PETSC_MAX_PATH_LEN];
110410463e74SBarry Smith #endif
110582f73ecaSAlejandro Lamas Daviña #if defined(PETSC_HAVE_CUDA)
110682f73ecaSAlejandro Lamas Daviña   cublasStatus_t cberr;
110782f73ecaSAlejandro Lamas Daviña #endif
1108e5c89e4eSSatish Balay 
1109e5c89e4eSSatish Balay   if (!PetscInitializeCalled) {
11104b09e917SBarry Smith     printf("PetscInitialize() must be called before PetscFinalize()\n");
11113cbbc5ffSBarry Smith     return(PETSC_ERR_ARG_WRONGSTATE);
1112e5c89e4eSSatish Balay   }
11133cbbc5ffSBarry Smith   PetscFunctionBegin;
11140298fd71SBarry Smith   ierr = PetscInfo(NULL,"PetscFinalize() called\n");CHKERRQ(ierr);
1115b022a5c1SBarry Smith 
11161f817a21SBarry Smith   ierr = MPI_Comm_rank(PETSC_COMM_WORLD,&rank);CHKERRQ(ierr);
11171f817a21SBarry Smith 
1118c5929fdfSBarry Smith   ierr = PetscOptionsHasName(NULL,NULL,"-citations",&flg);CHKERRQ(ierr);
1119dff31646SBarry Smith   if (flg) {
11201f817a21SBarry Smith     char  *cits, filename[PETSC_MAX_PATH_LEN];
11211f817a21SBarry Smith     FILE  *fd = PETSC_STDOUT;
11221f817a21SBarry Smith 
1123c5929fdfSBarry Smith     ierr = PetscOptionsGetString(NULL,NULL,"-citations",filename,PETSC_MAX_PATH_LEN,NULL);CHKERRQ(ierr);
11241f817a21SBarry Smith     if (filename[0]) {
11251f817a21SBarry Smith       ierr = PetscFOpen(PETSC_COMM_WORLD,filename,"w",&fd);CHKERRQ(ierr);
11261f817a21SBarry Smith     }
1127dff31646SBarry Smith     ierr = PetscSegBufferGet(PetscCitationsList,1,&cits);CHKERRQ(ierr);
1128dff31646SBarry Smith     cits[0] = 0;
1129dff31646SBarry Smith     ierr = PetscSegBufferExtractAlloc(PetscCitationsList,&cits);CHKERRQ(ierr);
11301f817a21SBarry Smith     ierr = PetscFPrintf(PETSC_COMM_WORLD,fd,"If you publish results based on this computation please cite the following:\n");CHKERRQ(ierr);
11311f817a21SBarry Smith     ierr = PetscFPrintf(PETSC_COMM_WORLD,fd,"===========================================================================\n");CHKERRQ(ierr);
11321f817a21SBarry Smith     ierr = PetscFPrintf(PETSC_COMM_WORLD,fd,"%s",cits);CHKERRQ(ierr);
11331f817a21SBarry Smith     ierr = PetscFPrintf(PETSC_COMM_WORLD,fd,"===========================================================================\n");CHKERRQ(ierr);
11341f817a21SBarry Smith     ierr = PetscFClose(PETSC_COMM_WORLD,fd);CHKERRQ(ierr);
1135dff31646SBarry Smith     ierr = PetscFree(cits);CHKERRQ(ierr);
1136dff31646SBarry Smith   }
1137dff31646SBarry Smith   ierr = PetscSegBufferDestroy(&PetscCitationsList);CHKERRQ(ierr);
1138dff31646SBarry Smith 
1139c2a97968SBarry Smith #if defined(PETSC_HAVE_SSL) && defined(PETSC_USE_SOCKET_VIEWER)
114004102261SBarry Smith   /* TextBelt is run for testing purposes only, please do not use this feature often */
114104102261SBarry Smith   {
114204102261SBarry Smith     PetscInt nmax = 2;
114304102261SBarry Smith     char     **buffs;
114404102261SBarry Smith     ierr = PetscMalloc1(2,&buffs);CHKERRQ(ierr);
1145c5929fdfSBarry Smith     ierr = PetscOptionsGetStringArray(NULL,NULL,"-textbelt",buffs,&nmax,&flg1);CHKERRQ(ierr);
114604102261SBarry Smith     if (flg1) {
114704102261SBarry Smith       if (!nmax) SETERRQ(PETSC_COMM_WORLD,PETSC_ERR_USER,"-textbelt requires either the phone number or number,\"message\"");
114804102261SBarry Smith       if (nmax == 1) {
114904102261SBarry Smith         ierr = PetscMalloc1(128,&buffs[1]);CHKERRQ(ierr);
115004102261SBarry Smith         ierr = PetscGetProgramName(buffs[1],32);CHKERRQ(ierr);
115104102261SBarry Smith         ierr = PetscStrcat(buffs[1]," has completed");CHKERRQ(ierr);
115204102261SBarry Smith       }
115304102261SBarry Smith       ierr = PetscTextBelt(PETSC_COMM_WORLD,buffs[0],buffs[1],NULL);CHKERRQ(ierr);
115404102261SBarry Smith       ierr = PetscFree(buffs[0]);CHKERRQ(ierr);
115504102261SBarry Smith       ierr = PetscFree(buffs[1]);CHKERRQ(ierr);
115604102261SBarry Smith     }
115704102261SBarry Smith     ierr = PetscFree(buffs);CHKERRQ(ierr);
115804102261SBarry Smith   }
1159763ec7b1SBarry Smith   {
1160763ec7b1SBarry Smith     PetscInt nmax = 2;
1161763ec7b1SBarry Smith     char     **buffs;
1162763ec7b1SBarry Smith     ierr = PetscMalloc1(2,&buffs);CHKERRQ(ierr);
1163763ec7b1SBarry Smith     ierr = PetscOptionsGetStringArray(NULL,NULL,"-tellmycell",buffs,&nmax,&flg1);CHKERRQ(ierr);
1164763ec7b1SBarry Smith     if (flg1) {
1165763ec7b1SBarry Smith       if (!nmax) SETERRQ(PETSC_COMM_WORLD,PETSC_ERR_USER,"-tellmycell requires either the phone number or number,\"message\"");
1166763ec7b1SBarry Smith       if (nmax == 1) {
1167763ec7b1SBarry Smith         ierr = PetscMalloc1(128,&buffs[1]);CHKERRQ(ierr);
1168763ec7b1SBarry Smith         ierr = PetscGetProgramName(buffs[1],32);CHKERRQ(ierr);
1169763ec7b1SBarry Smith         ierr = PetscStrcat(buffs[1]," has completed");CHKERRQ(ierr);
1170763ec7b1SBarry Smith       }
1171763ec7b1SBarry Smith       ierr = PetscTellMyCell(PETSC_COMM_WORLD,buffs[0],buffs[1],NULL);CHKERRQ(ierr);
1172763ec7b1SBarry Smith       ierr = PetscFree(buffs[0]);CHKERRQ(ierr);
1173763ec7b1SBarry Smith       ierr = PetscFree(buffs[1]);CHKERRQ(ierr);
1174763ec7b1SBarry Smith     }
1175763ec7b1SBarry Smith     ierr = PetscFree(buffs);CHKERRQ(ierr);
1176763ec7b1SBarry Smith   }
117704102261SBarry Smith #endif
117867234432SDmitry Karpeev   /*
117967234432SDmitry Karpeev     It should be safe to cancel the options monitors, since we don't expect to be setting options
118067234432SDmitry Karpeev     here (at least that are worth monitoring).  Monitors ought to be released so that they release
118167234432SDmitry Karpeev     whatever memory was allocated there before -malloc_dump reports unfreed memory.
118267234432SDmitry Karpeev   */
118367234432SDmitry Karpeev   ierr = PetscOptionsMonitorCancel();CHKERRQ(ierr);
118404102261SBarry Smith 
11852d53ad75SBarry Smith #if defined(PETSC_SERIALIZE_FUNCTIONS)
11862d53ad75SBarry Smith   ierr = PetscFPTDestroy();CHKERRQ(ierr);
11872d53ad75SBarry Smith #endif
11882d53ad75SBarry Smith 
11892d53ad75SBarry Smith 
1190e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS)
1191dff31646SBarry Smith   flg = PETSC_FALSE;
1192c5929fdfSBarry Smith   ierr = PetscOptionsGetBool(NULL,NULL,"-saw_options",&flg,NULL);CHKERRQ(ierr);
1193d5649816SBarry Smith   if (flg) {
1194e04113cfSBarry Smith     ierr = PetscOptionsSAWsDestroy();CHKERRQ(ierr);
1195d5649816SBarry Smith   }
1196d5649816SBarry Smith #endif
1197d5649816SBarry Smith 
1198681455b2SBarry Smith #if defined(PETSC_HAVE_X)
1199681455b2SBarry Smith   flg1 = PETSC_FALSE;
1200c5929fdfSBarry Smith   ierr = PetscOptionsGetBool(NULL,NULL,"-x_virtual",&flg1,NULL);CHKERRQ(ierr);
1201681455b2SBarry Smith   if (flg1) {
1202681455b2SBarry Smith     /*  this is a crude hack, but better than nothing */
1203681455b2SBarry Smith     ierr = PetscPOpen(PETSC_COMM_WORLD,NULL,"pkill -9 Xvfb","r",NULL);CHKERRQ(ierr);
1204681455b2SBarry Smith   }
1205681455b2SBarry Smith #endif
1206681455b2SBarry Smith 
120767584ceeSBarry Smith #if !defined(PETSC_HAVE_THREADSAFETY)
1208c5929fdfSBarry Smith   ierr = PetscOptionsGetBool(NULL,NULL,"-malloc_info",&flg2,NULL);CHKERRQ(ierr);
1209e5c89e4eSSatish Balay   if (!flg2) {
121090d69ab7SBarry Smith     flg2 = PETSC_FALSE;
1211c5929fdfSBarry Smith     ierr = PetscOptionsGetBool(NULL,NULL,"-memory_view",&flg2,NULL);CHKERRQ(ierr);
1212e5c89e4eSSatish Balay   }
1213e5c89e4eSSatish Balay   if (flg2) {
12140841954dSBarry Smith     ierr = PetscMemoryView(PETSC_VIEWER_STDOUT_WORLD,"Summary of Memory Usage in PETSc\n");CHKERRQ(ierr);
1215e5c89e4eSSatish Balay   }
121667584ceeSBarry Smith #endif
1217e5c89e4eSSatish Balay 
1218e5c89e4eSSatish Balay #if defined(PETSC_USE_LOG)
121990d69ab7SBarry Smith   flg1 = PETSC_FALSE;
1220c5929fdfSBarry Smith   ierr = PetscOptionsGetBool(NULL,NULL,"-get_total_flops",&flg1,NULL);CHKERRQ(ierr);
1221e5c89e4eSSatish Balay   if (flg1) {
1222e5c89e4eSSatish Balay     PetscLogDouble flops = 0;
1223205a32c2SJed Brown     ierr = MPI_Reduce(&petsc_TotalFlops,&flops,1,MPI_DOUBLE,MPI_SUM,0,PETSC_COMM_WORLD);CHKERRQ(ierr);
1224e5c89e4eSSatish Balay     ierr = PetscPrintf(PETSC_COMM_WORLD,"Total flops over all processors %g\n",flops);CHKERRQ(ierr);
1225e5c89e4eSSatish Balay   }
1226e5c89e4eSSatish Balay #endif
1227e5c89e4eSSatish Balay 
1228e5c89e4eSSatish Balay 
1229e5c89e4eSSatish Balay #if defined(PETSC_USE_LOG)
1230e5c89e4eSSatish Balay #if defined(PETSC_HAVE_MPE)
1231e5c89e4eSSatish Balay   mname[0] = 0;
1232c5929fdfSBarry Smith   ierr = PetscOptionsGetString(NULL,NULL,"-log_mpe",mname,PETSC_MAX_PATH_LEN,&flg1);CHKERRQ(ierr);
1233e5c89e4eSSatish Balay   if (flg1) {
1234e5c89e4eSSatish Balay     if (mname[0]) {ierr = PetscLogMPEDump(mname);CHKERRQ(ierr);}
1235e5c89e4eSSatish Balay     else          {ierr = PetscLogMPEDump(0);CHKERRQ(ierr);}
1236e5c89e4eSSatish Balay   }
1237e5c89e4eSSatish Balay #endif
1238356e5837SBarry Smith #endif
1239a297a907SKarl Rupp 
1240dd710f27SBarry Smith   /*
1241dd710f27SBarry Smith      Free all objects registered with PetscObjectRegisterDestroy() such as PETSC_VIEWER_XXX_().
1242dd710f27SBarry Smith   */
1243dd710f27SBarry Smith   ierr = PetscObjectRegisterDestroyAll();CHKERRQ(ierr);
1244dd710f27SBarry Smith 
1245356e5837SBarry Smith #if defined(PETSC_USE_LOG)
1246f14045dbSBarry Smith   ierr = PetscLogViewFromOptions();CHKERRQ(ierr);
1247356e5837SBarry Smith   mname[0] = 0;
1248c5929fdfSBarry Smith   ierr = PetscOptionsGetString(NULL,NULL,"-log_summary",mname,PETSC_MAX_PATH_LEN,&flg1);CHKERRQ(ierr);
1249e5c89e4eSSatish Balay   if (flg1) {
125091eabc43SBarry Smith     PetscViewer viewer;
125120a8bfc3SBarry Smith     ierr = (*PetscHelpPrintf)(PETSC_COMM_WORLD,"\n\n WARNING:   -log_summary is being deprecated; switch to -log_view\n\n\n");CHKERRQ(ierr);
125291eabc43SBarry Smith     if (mname[0]) {
125391eabc43SBarry Smith       ierr = PetscViewerASCIIOpen(PETSC_COMM_WORLD,mname,&viewer);CHKERRQ(ierr);
125491eabc43SBarry Smith       ierr = PetscLogView(viewer);CHKERRQ(ierr);
12556bf464f9SBarry Smith       ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr);
125633f85c2fSBarry Smith     } else {
125733f85c2fSBarry Smith       viewer = PETSC_VIEWER_STDOUT_WORLD;
12589a9a5d4cSBarry Smith       ierr   = PetscViewerPushFormat(viewer,PETSC_VIEWER_DEFAULT);CHKERRQ(ierr);
125933f85c2fSBarry Smith       ierr   = PetscLogView(viewer);CHKERRQ(ierr);
12609a9a5d4cSBarry Smith       ierr   = PetscViewerPopFormat(viewer);CHKERRQ(ierr);
126133f85c2fSBarry Smith     }
1262e5c89e4eSSatish Balay   }
1263a297a907SKarl Rupp 
1264dd710f27SBarry Smith   /*
1265dd710f27SBarry Smith      Free any objects created by the last block of code.
1266dd710f27SBarry Smith   */
1267dd710f27SBarry Smith   ierr = PetscObjectRegisterDestroyAll();CHKERRQ(ierr);
1268dd710f27SBarry Smith 
1269dd710f27SBarry Smith   mname[0] = 0;
1270c5929fdfSBarry Smith   ierr = PetscOptionsGetString(NULL,NULL,"-log_all",mname,PETSC_MAX_PATH_LEN,&flg1);CHKERRQ(ierr);
1271c5929fdfSBarry Smith   ierr = PetscOptionsGetString(NULL,NULL,"-log",mname,PETSC_MAX_PATH_LEN,&flg2);CHKERRQ(ierr);
1272e5c89e4eSSatish Balay   if (flg1 || flg2) {
1273e5c89e4eSSatish Balay     if (mname[0]) PetscLogDump(mname);
1274e5c89e4eSSatish Balay     else          PetscLogDump(0);
1275e5c89e4eSSatish Balay   }
1276e5c89e4eSSatish Balay #endif
127710463e74SBarry Smith 
127833f85c2fSBarry Smith   ierr = PetscStackDestroy();CHKERRQ(ierr);
127910463e74SBarry Smith 
128090d69ab7SBarry Smith   flg1 = PETSC_FALSE;
1281c5929fdfSBarry Smith   ierr = PetscOptionsGetBool(NULL,NULL,"-no_signal_handler",&flg1,NULL);CHKERRQ(ierr);
1282e5c89e4eSSatish Balay   if (!flg1) { ierr = PetscPopSignalHandler();CHKERRQ(ierr);}
128390d69ab7SBarry Smith   flg1 = PETSC_FALSE;
1284c5929fdfSBarry Smith   ierr = PetscOptionsGetBool(NULL,NULL,"-mpidump",&flg1,NULL);CHKERRQ(ierr);
1285e5c89e4eSSatish Balay   if (flg1) {
1286e5c89e4eSSatish Balay     ierr = PetscMPIDump(stdout);CHKERRQ(ierr);
1287e5c89e4eSSatish Balay   }
128890d69ab7SBarry Smith   flg1 = PETSC_FALSE;
128990d69ab7SBarry Smith   flg2 = PETSC_FALSE;
12908bb29257SSatish Balay   /* preemptive call to avoid listing this option in options table as unused */
1291c5929fdfSBarry Smith   ierr = PetscOptionsHasName(NULL,NULL,"-malloc_dump",&flg1);CHKERRQ(ierr);
1292c5929fdfSBarry Smith   ierr = PetscOptionsHasName(NULL,NULL,"-objects_dump",&flg1);CHKERRQ(ierr);
1293c5929fdfSBarry Smith   ierr = PetscOptionsGetBool(NULL,NULL,"-options_view",&flg2,NULL);CHKERRQ(ierr);
1294e4c476e2SSatish Balay 
1295e5c89e4eSSatish Balay   if (flg2) {
1296be56827dSJed Brown     PetscViewer viewer;
129702ba9f54SBarry Smith     ierr = PetscViewerCreate(PETSC_COMM_WORLD,&viewer);CHKERRQ(ierr);
129802ba9f54SBarry Smith     ierr = PetscViewerSetType(viewer,PETSCVIEWERASCII);CHKERRQ(ierr);
1299c5929fdfSBarry Smith     ierr = PetscOptionsView(NULL,viewer);CHKERRQ(ierr);
1300be56827dSJed Brown     ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr);
1301e5c89e4eSSatish Balay   }
1302e5c89e4eSSatish Balay 
1303e5c89e4eSSatish Balay   /* to prevent PETSc -options_left from warning */
1304c5929fdfSBarry Smith   ierr = PetscOptionsHasName(NULL,NULL,"-nox",&flg1);CHKERRQ(ierr);
1305c5929fdfSBarry Smith   ierr = PetscOptionsHasName(NULL,NULL,"-nox_warning",&flg1);CHKERRQ(ierr);
1306e5c89e4eSSatish Balay 
130733fc4174SSatish Balay   flg3 = PETSC_FALSE; /* default value is required */
1308c5929fdfSBarry Smith   ierr = PetscOptionsGetBool(NULL,NULL,"-options_left",&flg3,&flg1);CHKERRQ(ierr);
1309c5929fdfSBarry Smith   ierr = PetscOptionsAllUsed(NULL,&nopt);CHKERRQ(ierr);
1310e5c89e4eSSatish Balay   if (flg3) {
1311e5c89e4eSSatish Balay     if (!flg2) { /* have not yet printed the options */
1312be56827dSJed Brown       PetscViewer viewer;
131302ba9f54SBarry Smith       ierr = PetscViewerCreate(PETSC_COMM_WORLD,&viewer);CHKERRQ(ierr);
131402ba9f54SBarry Smith       ierr = PetscViewerSetType(viewer,PETSCVIEWERASCII);CHKERRQ(ierr);
1315c5929fdfSBarry Smith       ierr = PetscOptionsView(NULL,viewer);CHKERRQ(ierr);
1316be56827dSJed Brown       ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr);
1317e5c89e4eSSatish Balay     }
1318e5c89e4eSSatish Balay     if (!nopt) {
1319e5c89e4eSSatish Balay       ierr = PetscPrintf(PETSC_COMM_WORLD,"There are no unused options.\n");CHKERRQ(ierr);
1320e5c89e4eSSatish Balay     } else if (nopt == 1) {
1321e5c89e4eSSatish Balay       ierr = PetscPrintf(PETSC_COMM_WORLD,"There is one unused database option. It is:\n");CHKERRQ(ierr);
1322e5c89e4eSSatish Balay     } else {
13237582186dSLisandro Dalcin       ierr = PetscPrintf(PETSC_COMM_WORLD,"There are %D unused database options. They are:\n",nopt);CHKERRQ(ierr);
1324e5c89e4eSSatish Balay     }
1325df12ba86SBarry Smith   }
1326e5c89e4eSSatish Balay #if defined(PETSC_USE_DEBUG)
1327da8b8a77SBarry Smith   if (nopt && !flg3 && !flg1) {
1328e5c89e4eSSatish Balay     ierr = PetscPrintf(PETSC_COMM_WORLD,"WARNING! There are options you set that were not used!\n");CHKERRQ(ierr);
1329e5c89e4eSSatish Balay     ierr = PetscPrintf(PETSC_COMM_WORLD,"WARNING! could be spelling mistake, etc!\n");CHKERRQ(ierr);
1330c5929fdfSBarry Smith     ierr = PetscOptionsLeft(NULL);CHKERRQ(ierr);
1331e5c89e4eSSatish Balay   } else if (nopt && flg3) {
1332e5c89e4eSSatish Balay #else
1333e5c89e4eSSatish Balay   if (nopt && flg3) {
1334e5c89e4eSSatish Balay #endif
1335c5929fdfSBarry Smith     ierr = PetscOptionsLeft(NULL);CHKERRQ(ierr);
1336e5c89e4eSSatish Balay   }
1337e5c89e4eSSatish Balay 
1338e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS)
1339d45a07a7SBarry Smith   if (!PetscGlobalRank) {
134087f587eeSBarry Smith     ierr = PetscStackSAWsViewOff();CHKERRQ(ierr);
134116ad0300SBarry Smith     PetscStackCallSAWs(SAWs_Finalize,());
1342d45a07a7SBarry Smith   }
1343ec957eceSBarry Smith #endif
1344ec957eceSBarry Smith 
13454097062eSBarry Smith #if defined(PETSC_USE_LOG)
134610463e74SBarry Smith   /*
1347dbc8283eSBarry Smith        List all objects the user may have forgot to free
13482eff7a51SBarry Smith   */
134905df10baSBarry Smith   if (PetscObjectsLog) {
1350c5929fdfSBarry Smith     ierr = PetscOptionsHasName(NULL,NULL,"-objects_dump",&flg1);CHKERRQ(ierr);
1351a64a8e02SBarry Smith     if (flg1) {
1352a64a8e02SBarry Smith       MPI_Comm local_comm;
13537eb1d149SBarry Smith       char     string[64];
1354a64a8e02SBarry Smith 
1355c5929fdfSBarry Smith       ierr = PetscOptionsGetString(NULL,NULL,"-objects_dump",string,64,NULL);CHKERRQ(ierr);
1356a64a8e02SBarry Smith       ierr = MPI_Comm_dup(MPI_COMM_WORLD,&local_comm);CHKERRQ(ierr);
1357a64a8e02SBarry Smith       ierr = PetscSequentialPhaseBegin_Private(local_comm,1);CHKERRQ(ierr);
13587eb1d149SBarry Smith       ierr = PetscObjectsDump(stdout,(string[0] == 'a') ? PETSC_TRUE : PETSC_FALSE);CHKERRQ(ierr);
1359a64a8e02SBarry Smith       ierr = PetscSequentialPhaseEnd_Private(local_comm,1);CHKERRQ(ierr);
1360a64a8e02SBarry Smith       ierr = MPI_Comm_free(&local_comm);CHKERRQ(ierr);
13610a1571b3SBarry Smith     }
136205df10baSBarry Smith   }
13634097062eSBarry Smith #endif
13644097062eSBarry Smith 
13654097062eSBarry Smith #if defined(PETSC_USE_LOG)
1366dbc8283eSBarry Smith   PetscObjectsCounts    = 0;
1367dbc8283eSBarry Smith   PetscObjectsMaxCounts = 0;
1368a297a907SKarl Rupp   ierr = PetscFree(PetscObjects);CHKERRQ(ierr);
13694097062eSBarry Smith #endif
13702eff7a51SBarry Smith 
137133f85c2fSBarry Smith   /*
137233f85c2fSBarry Smith      Destroy any packages that registered a finalize
137333f85c2fSBarry Smith   */
137433f85c2fSBarry Smith   ierr = PetscRegisterFinalizeAll();CHKERRQ(ierr);
137533f85c2fSBarry Smith 
1376101409b8SToby Isaac #if defined(PETSC_USE_LOG)
1377101409b8SToby Isaac   ierr = PetscLogDestroy();CHKERRQ(ierr);
1378101409b8SToby Isaac #endif
1379101409b8SToby Isaac 
138033f85c2fSBarry Smith   /*
138148dd1dffSBarry Smith      Print PetscFunctionLists that have not been properly freed
138248dd1dffSBarry Smith 
138337e93019SBarry Smith   ierr = PetscFunctionListPrintAll();CHKERRQ(ierr);
138448dd1dffSBarry Smith   */
138537e93019SBarry Smith 
13864028d114SSatish Balay   if (petsc_history) {
1387f3dea69dSBarry Smith     ierr = PetscCloseHistoryFile(&petsc_history);CHKERRQ(ierr);
1388e5c89e4eSSatish Balay     petsc_history = 0;
1389e5c89e4eSSatish Balay   }
13909de0f6ecSBarry Smith   ierr = PetscOptionsHelpPrintedDestroy(&PetscOptionsHelpPrintedSingleton);CHKERRQ(ierr);
1391e5c89e4eSSatish Balay 
13920298fd71SBarry Smith   ierr = PetscInfoAllow(PETSC_FALSE,NULL);CHKERRQ(ierr);
1393e5c89e4eSSatish Balay 
139467584ceeSBarry Smith #if !defined(PETSC_HAVE_THREADSAFETY)
13958bb29257SSatish Balay   {
1396e5c89e4eSSatish Balay     char fname[PETSC_MAX_PATH_LEN];
1397e5c89e4eSSatish Balay     FILE *fd;
1398ed9cf6e9SBarry Smith     int  err;
1399e5c89e4eSSatish Balay 
1400e5c89e4eSSatish Balay     fname[0] = 0;
1401a297a907SKarl Rupp 
1402c5929fdfSBarry Smith     ierr = PetscOptionsGetString(NULL,NULL,"-malloc_dump",fname,250,&flg1);CHKERRQ(ierr);
1403dc92acbaSJed Brown     flg2 = PETSC_FALSE;
1404c5929fdfSBarry Smith     ierr = PetscOptionsGetBool(NULL,NULL,"-malloc_test",&flg2,NULL);CHKERRQ(ierr);
14058bf1f09cSShri Abhyankar #if defined(PETSC_USE_DEBUG)
1406dc92acbaSJed Brown     if (PETSC_RUNNING_ON_VALGRIND) flg2 = PETSC_FALSE;
1407dc92acbaSJed Brown #else
1408dc92acbaSJed Brown     flg2 = PETSC_FALSE;         /* Skip reporting for optimized builds regardless of -malloc_test */
1409dc92acbaSJed Brown #endif
1410e5c89e4eSSatish Balay     if (flg1 && fname[0]) {
1411e5c89e4eSSatish Balay       char sname[PETSC_MAX_PATH_LEN];
1412e5c89e4eSSatish Balay 
1413e5c89e4eSSatish Balay       sprintf(sname,"%s_%d",fname,rank);
1414e32f2f54SBarry Smith       fd   = fopen(sname,"w"); if (!fd) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_FILE_OPEN,"Cannot open log file: %s",sname);
1415e5c89e4eSSatish Balay       ierr = PetscMallocDump(fd);CHKERRQ(ierr);
1416ed9cf6e9SBarry Smith       err  = fclose(fd);
1417e32f2f54SBarry Smith       if (err) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SYS,"fclose() failed on file");
1418dc92acbaSJed Brown     } else if (flg1 || flg2) {
1419e5c89e4eSSatish Balay       MPI_Comm local_comm;
1420e5c89e4eSSatish Balay 
1421e5c89e4eSSatish Balay       ierr = MPI_Comm_dup(MPI_COMM_WORLD,&local_comm);CHKERRQ(ierr);
1422e5c89e4eSSatish Balay       ierr = PetscSequentialPhaseBegin_Private(local_comm,1);CHKERRQ(ierr);
1423e5c89e4eSSatish Balay       ierr = PetscMallocDump(stdout);CHKERRQ(ierr);
1424e5c89e4eSSatish Balay       ierr = PetscSequentialPhaseEnd_Private(local_comm,1);CHKERRQ(ierr);
1425e5c89e4eSSatish Balay       ierr = MPI_Comm_free(&local_comm);CHKERRQ(ierr);
1426e5c89e4eSSatish Balay     }
1427e5c89e4eSSatish Balay   }
1428a64a8e02SBarry Smith 
14298bb29257SSatish Balay   {
1430e5c89e4eSSatish Balay     char fname[PETSC_MAX_PATH_LEN];
14310298fd71SBarry Smith     FILE *fd = NULL;
1432e5c89e4eSSatish Balay 
1433e5c89e4eSSatish Balay     fname[0] = 0;
1434a297a907SKarl Rupp 
1435c5929fdfSBarry Smith     ierr = PetscOptionsGetString(NULL,NULL,"-malloc_log",fname,250,&flg1);CHKERRQ(ierr);
1436c5929fdfSBarry Smith     ierr = PetscOptionsHasName(NULL,NULL,"-malloc_log_threshold",&flg2);CHKERRQ(ierr);
1437e5c89e4eSSatish Balay     if (flg1 && fname[0]) {
1438ed9cf6e9SBarry Smith       int err;
1439e5c89e4eSSatish Balay 
1440574034a9SJed Brown       if (!rank) {
1441574034a9SJed Brown         fd = fopen(fname,"w");
1442574034a9SJed Brown         if (!fd) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_FILE_OPEN,"Cannot open log file: %s",fname);
1443574034a9SJed Brown       }
1444e5c89e4eSSatish Balay       ierr = PetscMallocDumpLog(fd);CHKERRQ(ierr);
1445574034a9SJed Brown       if (fd) {
1446ed9cf6e9SBarry Smith         err = fclose(fd);
1447e32f2f54SBarry Smith         if (err) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SYS,"fclose() failed on file");
1448574034a9SJed Brown       }
1449574034a9SJed Brown     } else if (flg1 || flg2) {
1450e5c89e4eSSatish Balay       ierr = PetscMallocDumpLog(stdout);CHKERRQ(ierr);
1451e5c89e4eSSatish Balay     }
1452e5c89e4eSSatish Balay   }
145367584ceeSBarry Smith #endif
145420e2c332SMatthew G. Knepley 
14555486ca60SMatthew G. Knepley   /*
14565486ca60SMatthew G. Knepley      Close any open dynamic libraries
14575486ca60SMatthew G. Knepley   */
14585486ca60SMatthew G. Knepley   ierr = PetscFinalize_DynamicLibraries();CHKERRQ(ierr);
14595486ca60SMatthew G. Knepley 
146020e2c332SMatthew G. Knepley #if defined(PETSC_HAVE_CUDA)
146120e2c332SMatthew G. Knepley   flg  = PETSC_TRUE;
1462c5929fdfSBarry Smith   ierr = PetscOptionsGetBool(NULL,NULL,"-cublas",&flg,NULL);CHKERRQ(ierr);
146320e2c332SMatthew G. Knepley   if (flg) {
146420e2c332SMatthew G. Knepley     PetscInt p;
146520e2c332SMatthew G. Knepley     for (p = 0; p < PetscGlobalSize; ++p) {
146682f73ecaSAlejandro Lamas Daviña       if (p == PetscGlobalRank) {
146782f73ecaSAlejandro Lamas Daviña         if (cublasv2handle) {
146882f73ecaSAlejandro Lamas Daviña           cberr = cublasDestroy(cublasv2handle);CHKERRCUBLAS(cberr);
146982f73ecaSAlejandro Lamas Daviña         }
147082f73ecaSAlejandro Lamas Daviña       }
147120e2c332SMatthew G. Knepley       ierr = MPI_Barrier(PETSC_COMM_WORLD);CHKERRQ(ierr);
147220e2c332SMatthew G. Knepley     }
147320e2c332SMatthew G. Knepley   }
147420e2c332SMatthew G. Knepley #endif
147520e2c332SMatthew G. Knepley 
1476e5c89e4eSSatish Balay   /* Can be destroyed only after all the options are used */
14774416b707SBarry Smith   ierr = PetscOptionsDestroyDefault();CHKERRQ(ierr);
1478e5c89e4eSSatish Balay 
1479e5c89e4eSSatish Balay   PetscGlobalArgc = 0;
1480e5c89e4eSSatish Balay   PetscGlobalArgs = 0;
1481e5c89e4eSSatish Balay 
1482008a6e76SBarry Smith   ierr = PetscFreeMPIResources();CHKERRQ(ierr);
1483e5c89e4eSSatish Balay 
1484dbc8283eSBarry Smith   /*
1485efb80d3cSBarry Smith      Destroy any known inner MPI_Comm's and attributes pointing to them
1486efb80d3cSBarry Smith      Note this will not destroy any new communicators the user has created.
1487efb80d3cSBarry Smith 
1488efb80d3cSBarry Smith      If all PETSc objects were not destroyed those left over objects will have hanging references to
1489efb80d3cSBarry Smith      the MPI_Comms that were freed; but that is ok because those PETSc objects will never be used again
1490dbc8283eSBarry Smith  */
1491b770b1f6SSatish Balay   {
1492dbc8283eSBarry Smith     PetscCommCounter *counter;
1493dbc8283eSBarry Smith     PetscMPIInt      flg;
1494dbc8283eSBarry Smith     MPI_Comm         icomm;
1495265f3f35SJed Brown     union {MPI_Comm comm; void *ptr;} ucomm;
149647435625SJed Brown     ierr = MPI_Comm_get_attr(PETSC_COMM_SELF,Petsc_InnerComm_keyval,&ucomm,&flg);CHKERRQ(ierr);
1497dbc8283eSBarry Smith     if (flg) {
1498265f3f35SJed Brown       icomm = ucomm.comm;
149947435625SJed Brown       ierr = MPI_Comm_get_attr(icomm,Petsc_Counter_keyval,&counter,&flg);CHKERRQ(ierr);
1500dbc8283eSBarry 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");
1501dbc8283eSBarry Smith 
150247435625SJed Brown       ierr = MPI_Comm_delete_attr(PETSC_COMM_SELF,Petsc_InnerComm_keyval);CHKERRQ(ierr);
150347435625SJed Brown       ierr = MPI_Comm_delete_attr(icomm,Petsc_Counter_keyval);CHKERRQ(ierr);
1504efb80d3cSBarry Smith       ierr = MPI_Comm_free(&icomm);CHKERRQ(ierr);
1505dbc8283eSBarry Smith     }
150647435625SJed Brown     ierr = MPI_Comm_get_attr(PETSC_COMM_WORLD,Petsc_InnerComm_keyval,&ucomm,&flg);CHKERRQ(ierr);
1507dbc8283eSBarry Smith     if (flg) {
1508265f3f35SJed Brown       icomm = ucomm.comm;
150947435625SJed Brown       ierr = MPI_Comm_get_attr(icomm,Petsc_Counter_keyval,&counter,&flg);CHKERRQ(ierr);
1510dbc8283eSBarry 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");
1511dbc8283eSBarry Smith 
151247435625SJed Brown       ierr = MPI_Comm_delete_attr(PETSC_COMM_WORLD,Petsc_InnerComm_keyval);CHKERRQ(ierr);
151347435625SJed Brown       ierr = MPI_Comm_delete_attr(icomm,Petsc_Counter_keyval);CHKERRQ(ierr);
1514efb80d3cSBarry Smith       ierr = MPI_Comm_free(&icomm);CHKERRQ(ierr);
1515dbc8283eSBarry Smith     }
1516b770b1f6SSatish Balay   }
1517dbc8283eSBarry Smith 
151847435625SJed Brown   ierr = MPI_Comm_free_keyval(&Petsc_Counter_keyval);CHKERRQ(ierr);
151947435625SJed Brown   ierr = MPI_Comm_free_keyval(&Petsc_InnerComm_keyval);CHKERRQ(ierr);
152047435625SJed Brown   ierr = MPI_Comm_free_keyval(&Petsc_OuterComm_keyval);CHKERRQ(ierr);
152147435625SJed Brown   ierr = MPI_Comm_free_keyval(&Petsc_Shared_keyval);CHKERRQ(ierr);
1522480cf27aSJed Brown 
15235ad9ad5bSBarry Smith   ierr = PetscSpinlockDestroy(&PetscViewerASCIISpinLockOpen);CHKERRQ(ierr);
15245ad9ad5bSBarry Smith   ierr = PetscSpinlockDestroy(&PetscViewerASCIISpinLockStdout);CHKERRQ(ierr);
15255ad9ad5bSBarry Smith   ierr = PetscSpinlockDestroy(&PetscViewerASCIISpinLockStderr);CHKERRQ(ierr);
1526ef19f930SBarry Smith   ierr = PetscSpinlockDestroy(&PetscCommSpinLock);CHKERRQ(ierr);
1527ef19f930SBarry Smith 
1528e5c89e4eSSatish Balay   if (PetscBeganMPI) {
152999608316SBarry Smith #if defined(PETSC_HAVE_MPI_FINALIZED)
153099b1327fSBarry Smith     PetscMPIInt flag;
153199b1327fSBarry Smith     ierr = MPI_Finalized(&flag);CHKERRQ(ierr);
1532e32f2f54SBarry Smith     if (flag) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_LIB,"MPI_Finalize() has already been called, even though MPI_Init() was called by PetscInitialize()");
153399608316SBarry Smith #endif
1534e5c89e4eSSatish Balay     ierr = MPI_Finalize();CHKERRQ(ierr);
1535e5c89e4eSSatish Balay   }
1536e5c89e4eSSatish Balay /*
1537e5c89e4eSSatish Balay 
1538e5c89e4eSSatish Balay      Note: In certain cases PETSC_COMM_WORLD is never MPI_Comm_free()ed because
1539e5c89e4eSSatish Balay    the communicator has some outstanding requests on it. Specifically if the
1540e5c89e4eSSatish Balay    flag PETSC_HAVE_BROKEN_REQUEST_FREE is set (for IBM MPI implementation). See
1541e5c89e4eSSatish Balay    src/vec/utils/vpscat.c. Due to this the memory allocated in PetscCommDuplicate()
1542e5c89e4eSSatish Balay    is never freed as it should be. Thus one may obtain messages of the form
15430e5e90baSSatish Balay    [ 1] 8 bytes PetscCommDuplicate() line 645 in src/sys/mpiu.c indicating the
1544e5c89e4eSSatish Balay    memory was not freed.
1545e5c89e4eSSatish Balay 
1546e5c89e4eSSatish Balay */
15471d1a0024SBarry Smith   ierr = PetscMallocClear();CHKERRQ(ierr);
1548a297a907SKarl Rupp 
1549e5c89e4eSSatish Balay   PetscInitializeCalled = PETSC_FALSE;
1550e5c89e4eSSatish Balay   PetscFinalizeCalled   = PETSC_TRUE;
15513db9a53dSBarry Smith   PetscFunctionReturn(0);
1552e5c89e4eSSatish Balay }
1553e5c89e4eSSatish Balay 
155443db4dbbSBarry Smith #if defined(PETSC_MISSING_LAPACK_lsame_)
15558cc058d9SJed Brown PETSC_EXTERN int lsame_(char *a,char *b)
155643db4dbbSBarry Smith {
155743db4dbbSBarry Smith   if (*a == *b) return 1;
155843db4dbbSBarry Smith   if (*a + 32 == *b) return 1;
155943db4dbbSBarry Smith   if (*a - 32 == *b) return 1;
156043db4dbbSBarry Smith   return 0;
156143db4dbbSBarry Smith }
1562a70650f6SBarry Smith #endif
156343db4dbbSBarry Smith 
156443db4dbbSBarry Smith #if defined(PETSC_MISSING_LAPACK_lsame)
15658cc058d9SJed Brown PETSC_EXTERN int lsame(char *a,char *b)
156643db4dbbSBarry Smith {
156743db4dbbSBarry Smith   if (*a == *b) return 1;
156843db4dbbSBarry Smith   if (*a + 32 == *b) return 1;
156943db4dbbSBarry Smith   if (*a - 32 == *b) return 1;
157043db4dbbSBarry Smith   return 0;
157143db4dbbSBarry Smith }
157243db4dbbSBarry Smith #endif
1573