xref: /petsc/src/sys/objects/pinit.c (revision 37bef68685c1f05064f72c911cffeeaba9b107d9)
17d0a6c19SBarry Smith 
2e5c89e4eSSatish Balay /*
3e5c89e4eSSatish Balay    This file defines the initialization of PETSc, including PetscInitialize()
4e5c89e4eSSatish Balay */
550f81f78SJed Brown #define PETSC_DESIRE_COMPLEX
6afcb2eb5SJed Brown #include <petsc-private/petscimpl.h>        /*I  "petscsys.h"   I*/
7665c2dedSJed Brown #include <petscviewer.h>
88101f56cSMatthew Knepley 
9663ba86aSMatthew G Knepley #if defined(PETSC_HAVE_CUDA)
102f947c57SVictor Minden #include <cublas.h>
117a025f21SVictor Minden #endif
127a025f21SVictor Minden 
13bd8b14e7SShri Abhyankar #include <petscthreadcomm.h>
14bd8b14e7SShri Abhyankar 
15a9f03627SSatish Balay #if defined(PETSC_USE_LOG)
1609573ac7SBarry Smith extern PetscErrorCode PetscLogBegin_Private(void);
17a9f03627SSatish Balay #endif
1885afcc9aSBarry Smith extern PetscBool PetscHMPIWorker;
19f2d66bcaSShri Abhyankar 
20*37bef686SBarry Smith #if defined(PETSC_HAVE_SAWS)
21*37bef686SBarry Smith SAWs_Directory PETSC_SAWs_ROOT_DIRECTORY         = 0;
22*37bef686SBarry Smith SAWs_Directory PETSC_OBJECTS_SAWs_ROOT_DIRECTORY = 0;
23*37bef686SBarry Smith #endif
242d53ad75SBarry Smith 
252d53ad75SBarry Smith #if defined(PETSC_SERIALIZE_FUNCTIONS)
262d53ad75SBarry Smith PetscFPT PetscFPTData = 0;
272d53ad75SBarry Smith #endif
282d53ad75SBarry Smith 
29e5c89e4eSSatish Balay /* -----------------------------------------------------------------------------------------*/
30e5c89e4eSSatish Balay 
31e5c89e4eSSatish Balay extern FILE *petsc_history;
32e5c89e4eSSatish Balay 
3309573ac7SBarry Smith extern PetscErrorCode PetscInitialize_DynamicLibraries(void);
3409573ac7SBarry Smith extern PetscErrorCode PetscFinalize_DynamicLibraries(void);
3537e93019SBarry Smith extern PetscErrorCode PetscFunctionListPrintAll(void);
3609573ac7SBarry Smith extern PetscErrorCode PetscSequentialPhaseBegin_Private(MPI_Comm,int);
3709573ac7SBarry Smith extern PetscErrorCode PetscSequentialPhaseEnd_Private(MPI_Comm,int);
3809573ac7SBarry Smith extern PetscErrorCode PetscCloseHistoryFile(FILE**);
390069ddf5SShri Abhyankar 
40e5c89e4eSSatish Balay /* user may set this BEFORE calling PetscInitialize() */
41e8373e55SMatthew Knepley MPI_Comm PETSC_COMM_WORLD = MPI_COMM_NULL;
42e5c89e4eSSatish Balay 
43480cf27aSJed Brown PetscMPIInt Petsc_Counter_keyval   = MPI_KEYVAL_INVALID;
44480cf27aSJed Brown PetscMPIInt Petsc_InnerComm_keyval = MPI_KEYVAL_INVALID;
45480cf27aSJed Brown PetscMPIInt Petsc_OuterComm_keyval = MPI_KEYVAL_INVALID;
46480cf27aSJed Brown 
47e5c89e4eSSatish Balay /*
48e5c89e4eSSatish Balay      Declare and set all the string names of the PETSc enums
49e5c89e4eSSatish Balay */
506a6fc655SJed Brown const char *const PetscBools[]     = {"FALSE","TRUE","PetscBool","PETSC_",0};
516a6fc655SJed Brown const char *const PetscCopyModes[] = {"COPY_VALUES","OWN_POINTER","USE_POINTER","PetscCopyMode","PETSC_",0};
526a6fc655SJed Brown const char *const PetscDataTypes[] = {"INT","DOUBLE","COMPLEX","LONG","SHORT","FLOAT",
532d53ad75SBarry Smith                                       "CHAR","LOGICAL","ENUM","BOOL","LONGDOUBLE","OBJECT","FUNCTION","PetscDataType","PETSC_",0};
54e5c89e4eSSatish Balay 
55ace3abfcSBarry Smith PetscBool PetscPreLoadingUsed = PETSC_FALSE;
56ace3abfcSBarry Smith PetscBool PetscPreLoadingOn   = PETSC_FALSE;
570f8e0872SSatish Balay 
58e1167bb9SShri Abhyankar /* pthread_key for PetscStack */
59e1167bb9SShri Abhyankar #if defined(PETSC_HAVE_PTHREADCLASSES) && !defined(PETSC_PTHREAD_LOCAL)
60f5dc6901SShri Abhyankar pthread_key_t petscstack;
61e1167bb9SShri Abhyankar #endif
62e1167bb9SShri Abhyankar 
63e5c89e4eSSatish Balay /*
64e5c89e4eSSatish Balay        Checks the options database for initializations related to the
65e5c89e4eSSatish Balay     PETSc components
66e5c89e4eSSatish Balay */
67e5c89e4eSSatish Balay #undef __FUNCT__
68e5c89e4eSSatish Balay #define __FUNCT__ "PetscOptionsCheckInitial_Components"
697087cfbeSBarry Smith PetscErrorCode  PetscOptionsCheckInitial_Components(void)
70e5c89e4eSSatish Balay {
71ace3abfcSBarry Smith   PetscBool      flg1;
72e5c89e4eSSatish Balay   PetscErrorCode ierr;
73e5c89e4eSSatish Balay 
74e5c89e4eSSatish Balay   PetscFunctionBegin;
750298fd71SBarry Smith   ierr = PetscOptionsHasName(NULL,"-help",&flg1);CHKERRQ(ierr);
76e5c89e4eSSatish Balay   if (flg1) {
77e5c89e4eSSatish Balay #if defined(PETSC_USE_LOG)
78e8e7597cSSatish Balay     MPI_Comm comm = PETSC_COMM_WORLD;
79e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm,"------Additional PETSc component options--------\n");CHKERRQ(ierr);
80e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm," -log_summary_exclude: <vec,mat,pc.ksp,snes>\n");CHKERRQ(ierr);
816cf91177SBarry Smith     ierr = (*PetscHelpPrintf)(comm," -info_exclude: <null,vec,mat,pc,ksp,snes,ts>\n");CHKERRQ(ierr);
82e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm,"-----------------------------------------------\n");CHKERRQ(ierr);
83e5c89e4eSSatish Balay #endif
84e5c89e4eSSatish Balay   }
85e5c89e4eSSatish Balay   PetscFunctionReturn(0);
86e5c89e4eSSatish Balay }
87e5c89e4eSSatish Balay 
88e5c89e4eSSatish Balay #undef __FUNCT__
89945d1669SBarry Smith #define __FUNCT__ "PetscInitializeNoPointers"
900f11a792SBarry Smith /*
91945d1669SBarry Smith       PetscInitializeNoPointers - Calls PetscInitialize() from C/C++ without the pointers to argc and args
9272a42c3cSBarry Smith 
9372a42c3cSBarry Smith    Collective
9472a42c3cSBarry Smith 
9572a42c3cSBarry Smith    Level: advanced
9672a42c3cSBarry Smith 
97945d1669SBarry Smith     Notes: this is called only by the PETSc MATLAB and Julia interface. Even though it might start MPI it sets the flag to
980f11a792SBarry Smith      indicate that it did NOT start MPI so that the PetscFinalize() does not end MPI, thus allowing PetscInitialize() to
99945d1669SBarry Smith      be called multiple times from MATLAB and Julia without the problem of trying to initialize MPI more than once.
1000f11a792SBarry Smith 
1011ea5a559SBarry Smith      Turns off PETSc signal handling because that can interact with MATLAB's signal handling causing random crashes.
1021ea5a559SBarry Smith 
10372a42c3cSBarry Smith .seealso: PetscInitialize(), PetscInitializeFortran(), PetscInitializeNoArguments()
1040f11a792SBarry Smith */
105945d1669SBarry Smith PetscErrorCode  PetscInitializeNoPointers(int argc,char **args,const char *filename,const char *help)
10672a42c3cSBarry Smith {
10772a42c3cSBarry Smith   PetscErrorCode ierr;
10872a42c3cSBarry Smith   int            myargc   = argc;
10972a42c3cSBarry Smith   char           **myargs = args;
11072a42c3cSBarry Smith 
11172a42c3cSBarry Smith   PetscFunctionBegin;
1123bf036e2SBarry Smith   ierr = PetscInitialize(&myargc,&myargs,filename,help);CHKERRQ(ierr);
1131ea5a559SBarry Smith   ierr = PetscPopSignalHandler();CHKERRQ(ierr);
114df413903SBarry Smith   PetscBeganMPI = PETSC_FALSE;
11572a42c3cSBarry Smith   PetscFunctionReturn(ierr);
11672a42c3cSBarry Smith }
11772a42c3cSBarry Smith 
11872a42c3cSBarry Smith #undef __FUNCT__
119945d1669SBarry Smith #define __FUNCT__ "PetscGetPETSC_COMM_SELF"
120f0865b08SBarry Smith /*
121945d1669SBarry Smith       Used by MATLAB and Julia interface to get communicator
122f0865b08SBarry Smith */
123945d1669SBarry Smith PetscErrorCode  PetscGetPETSC_COMM_SELF(MPI_Comm *comm)
124f0865b08SBarry Smith {
125f0865b08SBarry Smith   PetscFunctionBegin;
126f0865b08SBarry Smith   *comm = PETSC_COMM_SELF;
127f0865b08SBarry Smith   PetscFunctionReturn(0);
128f0865b08SBarry Smith }
129f0865b08SBarry Smith 
130f0865b08SBarry Smith #undef __FUNCT__
131e5c89e4eSSatish Balay #define __FUNCT__ "PetscInitializeNoArguments"
132e5c89e4eSSatish Balay /*@C
133e5c89e4eSSatish Balay       PetscInitializeNoArguments - Calls PetscInitialize() from C/C++ without
134e5c89e4eSSatish Balay         the command line arguments.
135e5c89e4eSSatish Balay 
136e5c89e4eSSatish Balay    Collective
137e5c89e4eSSatish Balay 
138e5c89e4eSSatish Balay    Level: advanced
139e5c89e4eSSatish Balay 
140e5c89e4eSSatish Balay .seealso: PetscInitialize(), PetscInitializeFortran()
141e5c89e4eSSatish Balay @*/
1427087cfbeSBarry Smith PetscErrorCode  PetscInitializeNoArguments(void)
143e5c89e4eSSatish Balay {
144e5c89e4eSSatish Balay   PetscErrorCode ierr;
145e5c89e4eSSatish Balay   int            argc   = 0;
146e5c89e4eSSatish Balay   char           **args = 0;
147e5c89e4eSSatish Balay 
148e5c89e4eSSatish Balay   PetscFunctionBegin;
1490298fd71SBarry Smith   ierr = PetscInitialize(&argc,&args,NULL,NULL);
150e5c89e4eSSatish Balay   PetscFunctionReturn(ierr);
151e5c89e4eSSatish Balay }
152e5c89e4eSSatish Balay 
153e5c89e4eSSatish Balay #undef __FUNCT__
154e5c89e4eSSatish Balay #define __FUNCT__ "PetscInitialized"
155e5c89e4eSSatish Balay /*@
156e5c89e4eSSatish Balay       PetscInitialized - Determine whether PETSc is initialized.
157e5c89e4eSSatish Balay 
15893b6d2d1SJed Brown    Level: beginner
159e5c89e4eSSatish Balay 
160e5c89e4eSSatish Balay .seealso: PetscInitialize(), PetscInitializeNoArguments(), PetscInitializeFortran()
161e5c89e4eSSatish Balay @*/
1627087cfbeSBarry Smith PetscErrorCode PetscInitialized(PetscBool  *isInitialized)
163e5c89e4eSSatish Balay {
164e5c89e4eSSatish Balay   *isInitialized = PetscInitializeCalled;
16593b6d2d1SJed Brown   return 0;
166e5c89e4eSSatish Balay }
167e5c89e4eSSatish Balay 
168e5c89e4eSSatish Balay #undef __FUNCT__
169e5c89e4eSSatish Balay #define __FUNCT__ "PetscFinalized"
170e5c89e4eSSatish Balay /*@
171e5c89e4eSSatish Balay       PetscFinalized - Determine whether PetscFinalize() has been called yet
172e5c89e4eSSatish Balay 
173e5c89e4eSSatish Balay    Level: developer
174e5c89e4eSSatish Balay 
175e5c89e4eSSatish Balay .seealso: PetscInitialize(), PetscInitializeNoArguments(), PetscInitializeFortran()
176e5c89e4eSSatish Balay @*/
1777087cfbeSBarry Smith PetscErrorCode  PetscFinalized(PetscBool  *isFinalized)
178e5c89e4eSSatish Balay {
179e5c89e4eSSatish Balay   *isFinalized = PetscFinalizeCalled;
18093b6d2d1SJed Brown   return 0;
181e5c89e4eSSatish Balay }
182e5c89e4eSSatish Balay 
18309573ac7SBarry Smith extern PetscErrorCode PetscOptionsCheckInitial_Private(void);
184e5c89e4eSSatish Balay 
185e5c89e4eSSatish Balay /*
186e5c89e4eSSatish Balay        This function is the MPI reduction operation used to compute the sum of the
187e5c89e4eSSatish Balay    first half of the datatype and the max of the second half.
188e5c89e4eSSatish Balay */
189e5c89e4eSSatish Balay MPI_Op PetscMaxSum_Op = 0;
190e5c89e4eSSatish Balay 
191e5c89e4eSSatish Balay #undef __FUNCT__
192e5c89e4eSSatish Balay #define __FUNCT__ "PetscMaxSum_Local"
1938cc058d9SJed Brown PETSC_EXTERN void MPIAPI PetscMaxSum_Local(void *in,void *out,int *cnt,MPI_Datatype *datatype)
194e5c89e4eSSatish Balay {
195e5c89e4eSSatish Balay   PetscInt *xin = (PetscInt*)in,*xout = (PetscInt*)out,i,count = *cnt;
196e5c89e4eSSatish Balay 
197e5c89e4eSSatish Balay   PetscFunctionBegin;
198e5c89e4eSSatish Balay   if (*datatype != MPIU_2INT) {
199e5c89e4eSSatish Balay     (*PetscErrorPrintf)("Can only handle MPIU_2INT data types");
200e5c89e4eSSatish Balay     MPI_Abort(MPI_COMM_WORLD,1);
201e5c89e4eSSatish Balay   }
202e5c89e4eSSatish Balay 
203e5c89e4eSSatish Balay   for (i=0; i<count; i++) {
204e5c89e4eSSatish Balay     xout[2*i]    = PetscMax(xout[2*i],xin[2*i]);
205e5c89e4eSSatish Balay     xout[2*i+1] += xin[2*i+1];
206e5c89e4eSSatish Balay   }
207812af9f3SBarry Smith   PetscFunctionReturnVoid();
208e5c89e4eSSatish Balay }
209e5c89e4eSSatish Balay 
210e5c89e4eSSatish Balay /*
211e5c89e4eSSatish Balay     Returns the max of the first entry owned by this processor and the
212e5c89e4eSSatish Balay sum of the second entry.
213b693b147SBarry Smith 
214b693b147SBarry Smith     The reason nprocs[2*i] contains lengths nprocs[2*i+1] contains flag of 1 if length is nonzero
215b693b147SBarry Smith is so that the PetscMaxSum_Op() can set TWO values, if we passed in only nprocs[i] with lengths
216b693b147SBarry Smith there would be no place to store the both needed results.
217e5c89e4eSSatish Balay */
218e5c89e4eSSatish Balay #undef __FUNCT__
219e5c89e4eSSatish Balay #define __FUNCT__ "PetscMaxSum"
2207087cfbeSBarry Smith PetscErrorCode  PetscMaxSum(MPI_Comm comm,const PetscInt nprocs[],PetscInt *max,PetscInt *sum)
221e5c89e4eSSatish Balay {
222e5c89e4eSSatish Balay   PetscMPIInt    size,rank;
2236ac3741eSJed Brown   struct {PetscInt max,sum;} *work;
224e5c89e4eSSatish Balay   PetscErrorCode ierr;
225e5c89e4eSSatish Balay 
226e5c89e4eSSatish Balay   PetscFunctionBegin;
227e5c89e4eSSatish Balay   ierr = MPI_Comm_size(comm,&size);CHKERRQ(ierr);
228e5c89e4eSSatish Balay   ierr = MPI_Comm_rank(comm,&rank);CHKERRQ(ierr);
2296ac3741eSJed Brown   ierr = PetscMalloc(size*sizeof(*work),&work);CHKERRQ(ierr);
230e5c89e4eSSatish Balay   ierr = MPI_Allreduce((void*)nprocs,work,size,MPIU_2INT,PetscMaxSum_Op,comm);CHKERRQ(ierr);
2316ac3741eSJed Brown   *max = work[rank].max;
2326ac3741eSJed Brown   *sum = work[rank].sum;
233e5c89e4eSSatish Balay   ierr = PetscFree(work);CHKERRQ(ierr);
234e5c89e4eSSatish Balay   PetscFunctionReturn(0);
235e5c89e4eSSatish Balay }
236e5c89e4eSSatish Balay 
237e5c89e4eSSatish Balay /* ----------------------------------------------------------------------------*/
2387087cfbeSBarry Smith MPI_Op  PetscADMax_Op = 0;
239e5c89e4eSSatish Balay 
240e5c89e4eSSatish Balay #undef __FUNCT__
241e5c89e4eSSatish Balay #define __FUNCT__ "PetscADMax_Local"
2428cc058d9SJed Brown PETSC_EXTERN void MPIAPI PetscADMax_Local(void *in,void *out,PetscMPIInt *cnt,MPI_Datatype *datatype)
243e5c89e4eSSatish Balay {
244e5c89e4eSSatish Balay   PetscScalar *xin = (PetscScalar*)in,*xout = (PetscScalar*)out;
245e5c89e4eSSatish Balay   PetscInt    i,count = *cnt;
246e5c89e4eSSatish Balay 
247e5c89e4eSSatish Balay   PetscFunctionBegin;
248e5c89e4eSSatish Balay   if (*datatype != MPIU_2SCALAR) {
249e5c89e4eSSatish Balay     (*PetscErrorPrintf)("Can only handle MPIU_2SCALAR data (i.e. double or complex) types");
250e5c89e4eSSatish Balay     MPI_Abort(MPI_COMM_WORLD,1);
251e5c89e4eSSatish Balay   }
252e5c89e4eSSatish Balay 
253e5c89e4eSSatish Balay   for (i=0; i<count; i++) {
254e5c89e4eSSatish Balay     if (PetscRealPart(xout[2*i]) < PetscRealPart(xin[2*i])) {
255e5c89e4eSSatish Balay       xout[2*i]   = xin[2*i];
256e5c89e4eSSatish Balay       xout[2*i+1] = xin[2*i+1];
257e5c89e4eSSatish Balay     }
258e5c89e4eSSatish Balay   }
259812af9f3SBarry Smith   PetscFunctionReturnVoid();
260e5c89e4eSSatish Balay }
261e5c89e4eSSatish Balay 
2627087cfbeSBarry Smith MPI_Op PetscADMin_Op = 0;
263e5c89e4eSSatish Balay 
264e5c89e4eSSatish Balay #undef __FUNCT__
265e5c89e4eSSatish Balay #define __FUNCT__ "PetscADMin_Local"
2668cc058d9SJed Brown PETSC_EXTERN void MPIAPI PetscADMin_Local(void *in,void *out,PetscMPIInt *cnt,MPI_Datatype *datatype)
267e5c89e4eSSatish Balay {
268e5c89e4eSSatish Balay   PetscScalar *xin = (PetscScalar*)in,*xout = (PetscScalar*)out;
269e5c89e4eSSatish Balay   PetscInt    i,count = *cnt;
270e5c89e4eSSatish Balay 
271e5c89e4eSSatish Balay   PetscFunctionBegin;
272e5c89e4eSSatish Balay   if (*datatype != MPIU_2SCALAR) {
273e5c89e4eSSatish Balay     (*PetscErrorPrintf)("Can only handle MPIU_2SCALAR data (i.e. double or complex) types");
274e5c89e4eSSatish Balay     MPI_Abort(MPI_COMM_WORLD,1);
275e5c89e4eSSatish Balay   }
276e5c89e4eSSatish Balay 
277e5c89e4eSSatish Balay   for (i=0; i<count; i++) {
278e5c89e4eSSatish Balay     if (PetscRealPart(xout[2*i]) > PetscRealPart(xin[2*i])) {
279e5c89e4eSSatish Balay       xout[2*i]   = xin[2*i];
280e5c89e4eSSatish Balay       xout[2*i+1] = xin[2*i+1];
281e5c89e4eSSatish Balay     }
282e5c89e4eSSatish Balay   }
283812af9f3SBarry Smith   PetscFunctionReturnVoid();
284e5c89e4eSSatish Balay }
285e5c89e4eSSatish Balay /* ---------------------------------------------------------------------------------------*/
286e5c89e4eSSatish Balay 
2877c2de775SJed Brown #if (defined(PETSC_HAVE_COMPLEX) && !defined(PETSC_HAVE_MPI_C_DOUBLE_COMPLEX)) || defined(PETSC_USE_REAL___FLOAT128)
28806a205a8SBarry Smith MPI_Op MPIU_SUM = 0;
289e5c89e4eSSatish Balay 
290e5c89e4eSSatish Balay #undef __FUNCT__
291e5c89e4eSSatish Balay #define __FUNCT__ "PetscSum_Local"
2928cc058d9SJed Brown PETSC_EXTERN void PetscSum_Local(void *in,void *out,PetscMPIInt *cnt,MPI_Datatype *datatype)
293e5c89e4eSSatish Balay {
294e5c89e4eSSatish Balay   PetscInt i,count = *cnt;
295e5c89e4eSSatish Balay 
296e5c89e4eSSatish Balay   PetscFunctionBegin;
2977c2de775SJed Brown   if (*datatype == MPIU_REAL) {
298e2e03761SBarry Smith     PetscReal *xin = (PetscReal*)in,*xout = (PetscReal*)out;
299a297a907SKarl Rupp     for (i=0; i<count; i++) xout[i] += xin[i];
3007c2de775SJed Brown   }
3017c2de775SJed Brown #if defined(PETSC_HAVE_COMPLEX)
3027c2de775SJed Brown   else if (*datatype == MPIU_COMPLEX) {
3037c2de775SJed Brown     PetscComplex *xin = (PetscComplex*)in,*xout = (PetscComplex*)out;
304a297a907SKarl Rupp     for (i=0; i<count; i++) xout[i] += xin[i];
3057c2de775SJed Brown   }
3067c2de775SJed Brown #endif
3077c2de775SJed Brown   else {
3087c2de775SJed Brown     (*PetscErrorPrintf)("Can only handle MPIU_REAL or MPIU_COMPLEX data types");
309e2e03761SBarry Smith     MPI_Abort(MPI_COMM_WORLD,1);
310e2e03761SBarry Smith   }
311812af9f3SBarry Smith   PetscFunctionReturnVoid();
312e5c89e4eSSatish Balay }
313e5c89e4eSSatish Balay #endif
314e5c89e4eSSatish Balay 
315ce63c4c1SBarry Smith #if defined(PETSC_USE_REAL___FLOAT128)
316d9822059SBarry Smith MPI_Op MPIU_MAX = 0;
317d9822059SBarry Smith MPI_Op MPIU_MIN = 0;
318d9822059SBarry Smith 
319d9822059SBarry Smith #undef __FUNCT__
320d9822059SBarry Smith #define __FUNCT__ "PetscMax_Local"
3218cc058d9SJed Brown PETSC_EXTERN void PetscMax_Local(void *in,void *out,PetscMPIInt *cnt,MPI_Datatype *datatype)
322d9822059SBarry Smith {
323d9822059SBarry Smith   PetscInt i,count = *cnt;
324d9822059SBarry Smith 
325d9822059SBarry Smith   PetscFunctionBegin;
3267c2de775SJed Brown   if (*datatype == MPIU_REAL) {
3278c764dc5SJose Roman     PetscReal *xin = (PetscReal*)in,*xout = (PetscReal*)out;
328a297a907SKarl Rupp     for (i=0; i<count; i++) xout[i] = PetscMax(xout[i],xin[i]);
3297c2de775SJed Brown   }
3307c2de775SJed Brown #if defined(PETSC_HAVE_COMPLEX)
3317c2de775SJed Brown   else if (*datatype == MPIU_COMPLEX) {
3327c2de775SJed Brown     PetscComplex *xin = (PetscComplex*)in,*xout = (PetscComplex*)out;
3337c2de775SJed Brown     for (i=0; i<count; i++) {
3347c2de775SJed Brown       xout[i] = PetscRealPartComplex(xout[i])<PetscRealPartComplex(xin[i]) ? xin[i] : xout[i];
3357c2de775SJed Brown     }
3367c2de775SJed Brown   }
3377c2de775SJed Brown #endif
3387c2de775SJed Brown   else {
3397c2de775SJed Brown     (*PetscErrorPrintf)("Can only handle MPIU_REAL or MPIU_COMPLEX data types");
3408c764dc5SJose Roman     MPI_Abort(MPI_COMM_WORLD,1);
3418c764dc5SJose Roman   }
342d9822059SBarry Smith   PetscFunctionReturnVoid();
343d9822059SBarry Smith }
344d9822059SBarry Smith 
345d9822059SBarry Smith #undef __FUNCT__
346d9822059SBarry Smith #define __FUNCT__ "PetscMin_Local"
3478cc058d9SJed Brown PETSC_EXTERN void PetscMin_Local(void *in,void *out,PetscMPIInt *cnt,MPI_Datatype *datatype)
348d9822059SBarry Smith {
349d9822059SBarry Smith   PetscInt    i,count = *cnt;
350d9822059SBarry Smith 
351d9822059SBarry Smith   PetscFunctionBegin;
3527c2de775SJed Brown   if (*datatype == MPIU_REAL) {
3538c764dc5SJose Roman     PetscReal *xin = (PetscReal*)in,*xout = (PetscReal*)out;
354a297a907SKarl Rupp     for (i=0; i<count; i++) xout[i] = PetscMin(xout[i],xin[i]);
3557c2de775SJed Brown   }
3567c2de775SJed Brown #if defined(PETSC_HAVE_COMPLEX)
3577c2de775SJed Brown   else if (*datatype == MPIU_COMPLEX) {
3587c2de775SJed Brown     PetscComplex *xin = (PetscComplex*)in,*xout = (PetscComplex*)out;
3597c2de775SJed Brown     for (i=0; i<count; i++) {
3607c2de775SJed Brown       xout[i] = PetscRealPartComplex(xout[i])>PetscRealPartComplex(xin[i]) ? xin[i] : xout[i];
3617c2de775SJed Brown     }
3627c2de775SJed Brown   }
3637c2de775SJed Brown #endif
3647c2de775SJed Brown   else {
3658c764dc5SJose Roman     (*PetscErrorPrintf)("Can only handle MPIU_REAL or MPIU_SCALAR data (i.e. double or complex) types");
3668c764dc5SJose Roman     MPI_Abort(MPI_COMM_WORLD,1);
3678c764dc5SJose Roman   }
368d9822059SBarry Smith   PetscFunctionReturnVoid();
369d9822059SBarry Smith }
370d9822059SBarry Smith #endif
371d9822059SBarry Smith 
372480cf27aSJed Brown #undef __FUNCT__
373480cf27aSJed Brown #define __FUNCT__ "Petsc_DelCounter"
374480cf27aSJed Brown /*
375480cf27aSJed Brown    Private routine to delete internal tag/name counter storage when a communicator is freed.
376480cf27aSJed Brown 
377ff0e51ddSBarry 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.
378480cf27aSJed Brown 
379480cf27aSJed Brown    Note: this is declared extern "C" because it is passed to MPI_Keyval_create()
380480cf27aSJed Brown 
381480cf27aSJed Brown */
3828cc058d9SJed Brown PETSC_EXTERN PetscMPIInt MPIAPI Petsc_DelCounter(MPI_Comm comm,PetscMPIInt keyval,void *count_val,void *extra_state)
383480cf27aSJed Brown {
384480cf27aSJed Brown   PetscErrorCode ierr;
385480cf27aSJed Brown 
386480cf27aSJed Brown   PetscFunctionBegin;
387480cf27aSJed Brown   ierr = PetscInfo1(0,"Deleting counter data in an MPI_Comm %ld\n",(long)comm);if (ierr) PetscFunctionReturn((PetscMPIInt)ierr);
388480cf27aSJed Brown   ierr = PetscFree(count_val);if (ierr) PetscFunctionReturn((PetscMPIInt)ierr);
389480cf27aSJed Brown   PetscFunctionReturn(MPI_SUCCESS);
390480cf27aSJed Brown }
391480cf27aSJed Brown 
392480cf27aSJed Brown #undef __FUNCT__
393da3039f7SJed Brown #define __FUNCT__ "Petsc_DelComm_Outer"
394480cf27aSJed Brown /*
395da3039f7SJed Brown   This is invoked on the outer comm as a result of either PetscCommDestroy() (via MPI_Attr_delete) or when the user
396da3039f7SJed Brown   calls MPI_Comm_free().
397da3039f7SJed Brown 
398da3039f7SJed Brown   This is the only entry point for breaking the links between inner and outer comms.
399480cf27aSJed Brown 
400ff0e51ddSBarry Smith   This is called by MPI, not by users. This is called when MPI_Comm_free() is called on the communicator.
401480cf27aSJed Brown 
402480cf27aSJed Brown   Note: this is declared extern "C" because it is passed to MPI_Keyval_create()
403480cf27aSJed Brown 
404480cf27aSJed Brown */
405da3039f7SJed Brown PETSC_EXTERN PetscMPIInt MPIAPI Petsc_DelComm_Outer(MPI_Comm comm,PetscMPIInt keyval,void *attr_val,void *extra_state)
406480cf27aSJed Brown {
407480cf27aSJed Brown   PetscErrorCode ierr;
408b89831e5SBarry Smith   PetscMPIInt    flg;
409265f3f35SJed Brown   union {MPI_Comm comm; void *ptr;} icomm,ocomm;
410480cf27aSJed Brown 
411480cf27aSJed Brown   PetscFunctionBegin;
412da3039f7SJed Brown   if (keyval != Petsc_InnerComm_keyval) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_CORRUPT,"Unexpected keyval");
413ec4fadc2SJed Brown   icomm.ptr = attr_val;
414da3039f7SJed Brown 
415265f3f35SJed Brown   ierr = MPI_Attr_get(icomm.comm,Petsc_OuterComm_keyval,&ocomm,&flg);CHKERRQ(ierr);
416b3ef52cdSBarry Smith   if (!flg) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_CORRUPT,"Inner MPI_Comm does not have expected reference to outer comm");
417da3039f7SJed Brown   if (ocomm.comm != comm) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_CORRUPT,"Inner MPI_Comm has reference to non-matching outer comm");
418da3039f7SJed Brown   ierr = MPI_Attr_delete(icomm.comm,Petsc_OuterComm_keyval);CHKERRQ(ierr); /* Calls Petsc_DelComm_Inner */
419da3039f7SJed Brown   ierr = PetscInfo1(0,"User MPI_Comm %ld is being freed after removing reference from inner PETSc comm to this outer comm\n",(long)comm);if (ierr) PetscFunctionReturn((PetscMPIInt)ierr);
420da3039f7SJed Brown   PetscFunctionReturn(MPI_SUCCESS);
421b89831e5SBarry Smith }
422da3039f7SJed Brown 
423da3039f7SJed Brown #undef __FUNCT__
424da3039f7SJed Brown #define __FUNCT__ "Petsc_DelComm_Inner"
425da3039f7SJed Brown /*
426da3039f7SJed Brown  * This is invoked on the inner comm when Petsc_DelComm_Outer calls MPI_Attr_delete.  It should not be reached any other way.
427da3039f7SJed Brown  */
428da3039f7SJed Brown PETSC_EXTERN PetscMPIInt MPIAPI Petsc_DelComm_Inner(MPI_Comm comm,PetscMPIInt keyval,void *attr_val,void *extra_state)
429da3039f7SJed Brown {
430da3039f7SJed Brown   PetscErrorCode ierr;
431da3039f7SJed Brown 
432da3039f7SJed Brown   PetscFunctionBegin;
433da3039f7SJed Brown   ierr = PetscInfo1(0,"Removing reference to PETSc communicator embedded in a user MPI_Comm %ld\n",(long)comm);if (ierr) PetscFunctionReturn((PetscMPIInt)ierr);
434480cf27aSJed Brown   PetscFunctionReturn(MPI_SUCCESS);
435480cf27aSJed Brown }
436480cf27aSJed Brown 
437951e3c8eSBarry Smith #if defined(PETSC_USE_PETSC_MPI_EXTERNAL32)
438e39fd77fSBarry Smith #if !defined(PETSC_WORDS_BIGENDIAN)
4398cc058d9SJed Brown PETSC_EXTERN PetscMPIInt PetscDataRep_extent_fn(MPI_Datatype,MPI_Aint*,void*);
4408cc058d9SJed Brown PETSC_EXTERN PetscMPIInt PetscDataRep_read_conv_fn(void*, MPI_Datatype,PetscMPIInt,void*,MPI_Offset,void*);
4418cc058d9SJed Brown PETSC_EXTERN PetscMPIInt PetscDataRep_write_conv_fn(void*, MPI_Datatype,PetscMPIInt,void*,MPI_Offset,void*);
442e39fd77fSBarry Smith #endif
443951e3c8eSBarry Smith #endif
444e39fd77fSBarry Smith 
4456ae9a8a6SBarry Smith int  PetscGlobalArgc   = 0;
4466ae9a8a6SBarry Smith char **PetscGlobalArgs = 0;
447dff31646SBarry Smith PetscSegBuffer PetscCitationsList;
448e5c89e4eSSatish Balay 
449e5c89e4eSSatish Balay #undef __FUNCT__
450051e4cf2SJed Brown #define __FUNCT__ "PetscCitationsInitialize"
451051e4cf2SJed Brown PetscErrorCode PetscCitationsInitialize()
452051e4cf2SJed Brown {
453051e4cf2SJed Brown   PetscErrorCode ierr;
454051e4cf2SJed Brown 
455051e4cf2SJed Brown   PetscFunctionBegin;
456051e4cf2SJed Brown   ierr = PetscSegBufferCreate(1,10000,&PetscCitationsList);CHKERRQ(ierr);
457051e4cf2SJed Brown   ierr = PetscCitationsRegister("@TechReport{petsc-user-ref,\n  Author = {Satish Balay and Jed Brown and and Kris Buschelman and Victor Eijkhout\n            and William D.  Gropp and Dinesh Kaushik and Matthew G. Knepley\n            and Lois Curfman McInnes and Barry F. Smith and Hong Zhang},\n  Title = {{PETS}c Users Manual},\n  Number = {ANL-95/11 - Revision 3.4},\n  Institution = {Argonne National Laboratory},\n  Year = {2013}\n}\n",NULL);CHKERRQ(ierr);
458051e4cf2SJed 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);
459051e4cf2SJed Brown   PetscFunctionReturn(0);
460051e4cf2SJed Brown }
461e5c89e4eSSatish Balay 
462e5c89e4eSSatish Balay #undef __FUNCT__
463e5c89e4eSSatish Balay #define __FUNCT__ "PetscGetArgs"
464e5c89e4eSSatish Balay /*@C
465e5c89e4eSSatish Balay    PetscGetArgs - Allows you to access the raw command line arguments anywhere
466e5c89e4eSSatish Balay      after PetscInitialize() is called but before PetscFinalize().
467e5c89e4eSSatish Balay 
468e5c89e4eSSatish Balay    Not Collective
469e5c89e4eSSatish Balay 
470e5c89e4eSSatish Balay    Output Parameters:
471e5c89e4eSSatish Balay +  argc - count of number of command line arguments
472e5c89e4eSSatish Balay -  args - the command line arguments
473e5c89e4eSSatish Balay 
474e5c89e4eSSatish Balay    Level: intermediate
475e5c89e4eSSatish Balay 
476e5c89e4eSSatish Balay    Notes:
477e5c89e4eSSatish Balay       This is usually used to pass the command line arguments into other libraries
478e5c89e4eSSatish Balay    that are called internally deep in PETSc or the application.
479e5c89e4eSSatish Balay 
480f177e3b1SBarry Smith       The first argument contains the program name as is normal for C arguments.
481f177e3b1SBarry Smith 
482e5c89e4eSSatish Balay    Concepts: command line arguments
483e5c89e4eSSatish Balay 
484793721a6SBarry Smith .seealso: PetscFinalize(), PetscInitializeFortran(), PetscGetArguments()
485e5c89e4eSSatish Balay 
486e5c89e4eSSatish Balay @*/
4877087cfbeSBarry Smith PetscErrorCode  PetscGetArgs(int *argc,char ***args)
488e5c89e4eSSatish Balay {
489e5c89e4eSSatish Balay   PetscFunctionBegin;
49017186662SBarry Smith   if (!PetscInitializeCalled && PetscFinalizeCalled) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ORDER,"You must call after PetscInitialize() but before PetscFinalize()");
491e5c89e4eSSatish Balay   *argc = PetscGlobalArgc;
492e5c89e4eSSatish Balay   *args = PetscGlobalArgs;
493e5c89e4eSSatish Balay   PetscFunctionReturn(0);
494e5c89e4eSSatish Balay }
495e5c89e4eSSatish Balay 
496e5c89e4eSSatish Balay #undef __FUNCT__
497793721a6SBarry Smith #define __FUNCT__ "PetscGetArguments"
498793721a6SBarry Smith /*@C
499793721a6SBarry Smith    PetscGetArguments - Allows you to access the  command line arguments anywhere
500793721a6SBarry Smith      after PetscInitialize() is called but before PetscFinalize().
501793721a6SBarry Smith 
502793721a6SBarry Smith    Not Collective
503793721a6SBarry Smith 
504793721a6SBarry Smith    Output Parameters:
505793721a6SBarry Smith .  args - the command line arguments
506793721a6SBarry Smith 
507793721a6SBarry Smith    Level: intermediate
508793721a6SBarry Smith 
509793721a6SBarry Smith    Notes:
510793721a6SBarry Smith       This does NOT start with the program name and IS null terminated (final arg is void)
511793721a6SBarry Smith 
512793721a6SBarry Smith    Concepts: command line arguments
513793721a6SBarry Smith 
514793721a6SBarry Smith .seealso: PetscFinalize(), PetscInitializeFortran(), PetscGetArgs(), PetscFreeArguments()
515793721a6SBarry Smith 
516793721a6SBarry Smith @*/
5177087cfbeSBarry Smith PetscErrorCode  PetscGetArguments(char ***args)
518793721a6SBarry Smith {
519793721a6SBarry Smith   PetscInt       i,argc = PetscGlobalArgc;
520793721a6SBarry Smith   PetscErrorCode ierr;
521793721a6SBarry Smith 
522793721a6SBarry Smith   PetscFunctionBegin;
52317186662SBarry Smith   if (!PetscInitializeCalled && PetscFinalizeCalled) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ORDER,"You must call after PetscInitialize() but before PetscFinalize()");
524717030eeSLisandro Dalcin   if (!argc) {*args = 0; PetscFunctionReturn(0);}
525793721a6SBarry Smith   ierr = PetscMalloc(argc*sizeof(char*),args);CHKERRQ(ierr);
526793721a6SBarry Smith   for (i=0; i<argc-1; i++) {
527793721a6SBarry Smith     ierr = PetscStrallocpy(PetscGlobalArgs[i+1],&(*args)[i]);CHKERRQ(ierr);
528793721a6SBarry Smith   }
529793721a6SBarry Smith   (*args)[argc-1] = 0;
530793721a6SBarry Smith   PetscFunctionReturn(0);
531793721a6SBarry Smith }
532793721a6SBarry Smith 
533793721a6SBarry Smith #undef __FUNCT__
534793721a6SBarry Smith #define __FUNCT__ "PetscFreeArguments"
535793721a6SBarry Smith /*@C
536793721a6SBarry Smith    PetscFreeArguments - Frees the memory obtained with PetscGetArguments()
537793721a6SBarry Smith 
538793721a6SBarry Smith    Not Collective
539793721a6SBarry Smith 
540793721a6SBarry Smith    Output Parameters:
541793721a6SBarry Smith .  args - the command line arguments
542793721a6SBarry Smith 
543793721a6SBarry Smith    Level: intermediate
544793721a6SBarry Smith 
545793721a6SBarry Smith    Concepts: command line arguments
546793721a6SBarry Smith 
547793721a6SBarry Smith .seealso: PetscFinalize(), PetscInitializeFortran(), PetscGetArgs(), PetscGetArguments()
548793721a6SBarry Smith 
549793721a6SBarry Smith @*/
5507087cfbeSBarry Smith PetscErrorCode  PetscFreeArguments(char **args)
551793721a6SBarry Smith {
552793721a6SBarry Smith   PetscInt       i = 0;
553793721a6SBarry Smith   PetscErrorCode ierr;
554793721a6SBarry Smith 
555793721a6SBarry Smith   PetscFunctionBegin;
556a297a907SKarl Rupp   if (!args) PetscFunctionReturn(0);
557793721a6SBarry Smith   while (args[i]) {
558793721a6SBarry Smith     ierr = PetscFree(args[i]);CHKERRQ(ierr);
559793721a6SBarry Smith     i++;
560793721a6SBarry Smith   }
561793721a6SBarry Smith   ierr = PetscFree(args);CHKERRQ(ierr);
562793721a6SBarry Smith   PetscFunctionReturn(0);
563793721a6SBarry Smith }
564793721a6SBarry Smith 
565793721a6SBarry Smith #undef __FUNCT__
566e5c89e4eSSatish Balay #define __FUNCT__ "PetscInitialize"
567e5c89e4eSSatish Balay /*@C
568e5c89e4eSSatish Balay    PetscInitialize - Initializes the PETSc database and MPI.
569e5c89e4eSSatish Balay    PetscInitialize() calls MPI_Init() if that has yet to be called,
570e5c89e4eSSatish Balay    so this routine should always be called near the beginning of
571e5c89e4eSSatish Balay    your program -- usually the very first line!
572e5c89e4eSSatish Balay 
573e5c89e4eSSatish Balay    Collective on MPI_COMM_WORLD or PETSC_COMM_WORLD if it has been set
574e5c89e4eSSatish Balay 
575e5c89e4eSSatish Balay    Input Parameters:
576e5c89e4eSSatish Balay +  argc - count of number of command line arguments
577e5c89e4eSSatish Balay .  args - the command line arguments
5780298fd71SBarry Smith .  file - [optional] PETSc database file, also checks ~username/.petscrc and .petscrc use NULL to not check for
579fc2bca9aSBarry Smith           code specific file. Use -skip_petscrc in the code specific file to skip the .petscrc files
5800298fd71SBarry Smith -  help - [optional] Help message to print, use NULL for no message
581e5c89e4eSSatish Balay 
58205827820SBarry Smith    If you wish PETSc code to run ONLY on a subcommunicator of MPI_COMM_WORLD, create that
58305827820SBarry Smith    communicator first and assign it to PETSC_COMM_WORLD BEFORE calling PetscInitialize(). Thus if you are running a
58405827820SBarry Smith    four process job and two processes will run PETSc and have PetscInitialize() and PetscFinalize() and two process will not,
58505827820SBarry Smith    then do this. If ALL processes in the job are using PetscInitialize() and PetscFinalize() then you don't need to do this, even
58605827820SBarry Smith    if different subcommunicators of the job are doing different things with PETSc.
587e5c89e4eSSatish Balay 
588e5c89e4eSSatish Balay    Options Database Keys:
589e5c89e4eSSatish Balay +  -start_in_debugger [noxterm,dbx,xdb,gdb,...] - Starts program in debugger
590e5c89e4eSSatish Balay .  -on_error_attach_debugger [noxterm,dbx,xdb,gdb,...] - Starts debugger when error detected
591e5c89e4eSSatish Balay .  -on_error_emacs <machinename> causes emacsclient to jump to error file
592b52f573bSBarry Smith .  -on_error_abort calls abort() when error detected (no traceback)
593e8fb0fc0SBarry Smith .  -on_error_mpiabort calls MPI_abort() when error detected
594e8fb0fc0SBarry Smith .  -error_output_stderr prints error messages to stderr instead of the default stdout
595e8fb0fc0SBarry Smith .  -error_output_none does not print the error messages (but handles errors in the same way as if this was not called)
596e5c89e4eSSatish Balay .  -debugger_nodes [node1,node2,...] - Indicates nodes to start in debugger
597e5c89e4eSSatish Balay .  -debugger_pause [sleeptime] (in seconds) - Pauses debugger
598e5c89e4eSSatish Balay .  -stop_for_debugger - Print message on how to attach debugger manually to
599e5c89e4eSSatish Balay                         process and wait (-debugger_pause) seconds for attachment
6002fb0ec9aSBarry Smith .  -malloc - Indicates use of PETSc error-checking malloc (on by default for debug version of libraries)
601e5c89e4eSSatish Balay .  -malloc no - Indicates not to use error-checking malloc
6022fb0ec9aSBarry Smith .  -malloc_debug - check for memory corruption at EVERY malloc or free
603dc92acbaSJed Brown .  -malloc_test - like -malloc_dump -malloc_debug, but only active for debugging builds
604e5c89e4eSSatish Balay .  -fp_trap - Stops on floating point exceptions (Note that on the
605e5c89e4eSSatish Balay               IBM RS6000 this slows code by at least a factor of 10.)
606e5c89e4eSSatish Balay .  -no_signal_handler - Indicates not to trap error signals
607e5c89e4eSSatish Balay .  -shared_tmp - indicates /tmp directory is shared by all processors
608e5c89e4eSSatish Balay .  -not_shared_tmp - each processor has own /tmp
609e5c89e4eSSatish Balay .  -tmp - alternative name of /tmp directory
610e5c89e4eSSatish Balay .  -get_total_flops - returns total flops done by all processors
61140ab9619SBarry Smith .  -memory_info - Print memory usage at end of run
61240ab9619SBarry Smith -  -server <port> - start PETSc webserver (default port is 8080)
613e5c89e4eSSatish Balay 
614e5c89e4eSSatish Balay    Options Database Keys for Profiling:
6150598bfebSBarry Smith    See the <a href="../../docs/manual.pdf#nameddest=ch_profiling">profiling chapter of the users manual</a> for details.
616495fc317SBarry Smith +  -info <optional filename> - Prints verbose information to the screen
617495fc317SBarry Smith .  -info_exclude <null,vec,mat,pc,ksp,snes,ts> - Excludes some of the verbose messages
618495fc317SBarry Smith .  -log_sync - Log the synchronization in scatters, inner products and norms
619495fc317SBarry Smith .  -log_trace [filename] - Print traces of all PETSc calls to the screen (useful to determine where a program
620e5c89e4eSSatish Balay         hangs without running in the debugger).  See PetscLogTraceBegin().
621495fc317SBarry Smith .  -log_summary [filename] - Prints summary of flop and timing information to screen. If the filename is specified the
622495fc317SBarry Smith         summary is written to the file.  See PetscLogView().
623495fc317SBarry Smith .  -log_summary_python [filename] - Prints data on of flop and timing usage to a file or screen. See PetscLogPrintSViewPython().
624495fc317SBarry Smith .  -log_all [filename] - Logs extensive profiling information  See PetscLogDump().
625495fc317SBarry Smith .  -log [filename] - Logs basic profiline information  See PetscLogDump().
626495fc317SBarry Smith -  -log_mpe [filename] - Creates a logfile viewable by the utility Jumpshot (in MPICH distribution)
627495fc317SBarry Smith 
628495fc317SBarry Smith     Only one of -log_trace, -log_summary, -log_all, -log, or -log_mpe may be used at a time
629e5c89e4eSSatish Balay 
630e5c89e4eSSatish Balay    Environmental Variables:
631e5c89e4eSSatish Balay +   PETSC_TMP - alternative tmp directory
632e5c89e4eSSatish Balay .   PETSC_SHARED_TMP - tmp is shared by all processes
633e5c89e4eSSatish Balay .   PETSC_NOT_SHARED_TMP - each process has its own private tmp
634e5c89e4eSSatish Balay .   PETSC_VIEWER_SOCKET_PORT - socket number to use for socket viewer
635e5c89e4eSSatish Balay -   PETSC_VIEWER_SOCKET_MACHINE - machine to use for socket viewer to connect to
636e5c89e4eSSatish Balay 
637e5c89e4eSSatish Balay 
638e5c89e4eSSatish Balay    Level: beginner
639e5c89e4eSSatish Balay 
640e5c89e4eSSatish Balay    Notes:
641e5c89e4eSSatish Balay    If for some reason you must call MPI_Init() separately, call
642e5c89e4eSSatish Balay    it before PetscInitialize().
643e5c89e4eSSatish Balay 
644e5c89e4eSSatish Balay    Fortran Version:
645e5c89e4eSSatish Balay    In Fortran this routine has the format
646e5c89e4eSSatish Balay $       call PetscInitialize(file,ierr)
647e5c89e4eSSatish Balay 
648e5c89e4eSSatish Balay +   ierr - error return code
6490298fd71SBarry Smith -  file - [optional] PETSc database file, also checks ~username/.petscrc and .petscrc use NULL_CHARACTER to not check for
650fc2bca9aSBarry Smith           code specific file. Use -skip_petscrc in the code specific file to skip the .petscrc files
651e5c89e4eSSatish Balay 
652e5c89e4eSSatish Balay    Important Fortran Note:
6530298fd71SBarry Smith    In Fortran, you MUST use NULL_CHARACTER to indicate a
6540298fd71SBarry Smith    null character string; you CANNOT just use NULL as
6550598bfebSBarry Smith    in the C version. See the <a href="../../docs/manual.pdf">users manual</a> for details.
656e5c89e4eSSatish Balay 
65701cb0274SBarry Smith    If your main program is C but you call Fortran code that also uses PETSc you need to call PetscInitializeFortran() soon after
65801cb0274SBarry Smith    calling PetscInitialize().
659e5c89e4eSSatish Balay 
660e5c89e4eSSatish Balay    Concepts: initializing PETSc
661e5c89e4eSSatish Balay 
66201cb0274SBarry Smith .seealso: PetscFinalize(), PetscInitializeFortran(), PetscGetArgs(), PetscInitializeNoArguments()
663e5c89e4eSSatish Balay 
664e5c89e4eSSatish Balay @*/
6657087cfbeSBarry Smith PetscErrorCode  PetscInitialize(int *argc,char ***args,const char file[],const char help[])
666e5c89e4eSSatish Balay {
667e5c89e4eSSatish Balay   PetscErrorCode ierr;
6684bb5149bSJed Brown   PetscMPIInt    flag, size;
669aa5bb8c0SSatish Balay   PetscInt       nodesize;
670ace3abfcSBarry Smith   PetscBool      flg;
671e5c89e4eSSatish Balay   char           hostname[256];
672e5c89e4eSSatish Balay 
673e5c89e4eSSatish Balay   PetscFunctionBegin;
674e5c89e4eSSatish Balay   if (PetscInitializeCalled) PetscFunctionReturn(0);
675e5c89e4eSSatish Balay 
676ae9b4142SLisandro Dalcin   /* these must be initialized in a routine, not as a constant declaration*/
677d89683f4Sbcordonn   PETSC_STDOUT = stdout;
678ae9b4142SLisandro Dalcin   PETSC_STDERR = stderr;
679e5c89e4eSSatish Balay 
680e5c89e4eSSatish Balay   ierr = PetscOptionsCreate();CHKERRQ(ierr);
681e5c89e4eSSatish Balay 
682e5c89e4eSSatish Balay   /*
683e5c89e4eSSatish Balay      We initialize the program name here (before MPI_Init()) because MPICH has a bug in
684e5c89e4eSSatish Balay      it that it sets args[0] on all processors to be args[0] on the first processor.
685e5c89e4eSSatish Balay   */
686e5c89e4eSSatish Balay   if (argc && *argc) {
687e5c89e4eSSatish Balay     ierr = PetscSetProgramName(**args);CHKERRQ(ierr);
688e5c89e4eSSatish Balay   } else {
689e5c89e4eSSatish Balay     ierr = PetscSetProgramName("Unknown Name");CHKERRQ(ierr);
690e5c89e4eSSatish Balay   }
691e5c89e4eSSatish Balay 
692e5c89e4eSSatish Balay   ierr = MPI_Initialized(&flag);CHKERRQ(ierr);
693e5c89e4eSSatish Balay   if (!flag) {
694e32f2f54SBarry 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");
6955e765c61SJed Brown #if defined(PETSC_HAVE_MPI_INIT_THREAD)
6965e765c61SJed Brown     {
6975e765c61SJed Brown       PetscMPIInt provided;
6985e765c61SJed Brown       ierr = MPI_Init_thread(argc,args,MPI_THREAD_FUNNELED,&provided);CHKERRQ(ierr);
6995e765c61SJed Brown     }
7005e765c61SJed Brown #else
701e5c89e4eSSatish Balay     ierr = MPI_Init(argc,args);CHKERRQ(ierr);
7025e765c61SJed Brown #endif
703e5c89e4eSSatish Balay     PetscBeganMPI = PETSC_TRUE;
704e5c89e4eSSatish Balay   }
705e5c89e4eSSatish Balay   if (argc && args) {
706e5c89e4eSSatish Balay     PetscGlobalArgc = *argc;
707e5c89e4eSSatish Balay     PetscGlobalArgs = *args;
708e5c89e4eSSatish Balay   }
709e5c89e4eSSatish Balay   PetscFinalizeCalled = PETSC_FALSE;
710e5c89e4eSSatish Balay 
711a297a907SKarl Rupp   if (PETSC_COMM_WORLD == MPI_COMM_NULL) PETSC_COMM_WORLD = MPI_COMM_WORLD;
712d54338ecSKarl Rupp   ierr = MPI_Comm_set_errhandler(PETSC_COMM_WORLD,MPI_ERRORS_RETURN);CHKERRQ(ierr);
713e5c89e4eSSatish Balay 
714e5c89e4eSSatish Balay   /* Done after init due to a bug in MPICH-GM? */
715e5c89e4eSSatish Balay   ierr = PetscErrorPrintfInitialize();CHKERRQ(ierr);
716e5c89e4eSSatish Balay 
717e5c89e4eSSatish Balay   ierr = MPI_Comm_rank(MPI_COMM_WORLD,&PetscGlobalRank);CHKERRQ(ierr);
718e5c89e4eSSatish Balay   ierr = MPI_Comm_size(MPI_COMM_WORLD,&PetscGlobalSize);CHKERRQ(ierr);
719e5c89e4eSSatish Balay 
7208ad47952SJed Brown   MPIU_BOOL = MPI_INT;
7218ad47952SJed Brown   MPIU_ENUM = MPI_INT;
7228ad47952SJed Brown 
723e5c89e4eSSatish Balay   /*
724e5c89e4eSSatish Balay      Initialized the global complex variable; this is because with
725e5c89e4eSSatish Balay      shared libraries the constructors for global variables
726e5c89e4eSSatish Balay      are not called; at least on IRIX.
727e5c89e4eSSatish Balay   */
728886cfec0SSatish Balay #if defined(PETSC_HAVE_COMPLEX)
729e5c89e4eSSatish Balay   {
730a24ee22aSSatish Balay #if defined(PETSC_CLANGUAGE_CXX)
73150f81f78SJed Brown     PetscComplex ic(0.0,1.0);
732e5c89e4eSSatish Balay     PETSC_i = ic;
733a24ee22aSSatish Balay #elif defined(PETSC_CLANGUAGE_C)
73450f81f78SJed Brown     PETSC_i = _Complex_I;
735b7940d39SSatish Balay #endif
736762437b8SSatish Balay   }
737762437b8SSatish Balay 
7382c876bd9SBarry Smith #if !defined(PETSC_HAVE_MPI_C_DOUBLE_COMPLEX)
739e69cd0e6SSatish Balay   ierr = MPI_Type_contiguous(2,MPI_DOUBLE,&MPIU_C_DOUBLE_COMPLEX);CHKERRQ(ierr);
740500d8756SSatish Balay   ierr = MPI_Type_commit(&MPIU_C_DOUBLE_COMPLEX);CHKERRQ(ierr);
741500d8756SSatish Balay   ierr = MPI_Type_contiguous(2,MPI_FLOAT,&MPIU_C_COMPLEX);CHKERRQ(ierr);
742500d8756SSatish Balay   ierr = MPI_Type_commit(&MPIU_C_COMPLEX);CHKERRQ(ierr);
7432c876bd9SBarry Smith #endif
744886cfec0SSatish Balay #endif /* PETSC_HAVE_COMPLEX */
745e5c89e4eSSatish Balay 
746e5c89e4eSSatish Balay   /*
747e5c89e4eSSatish Balay      Create the PETSc MPI reduction operator that sums of the first
748e5c89e4eSSatish Balay      half of the entries and maxes the second half.
749e5c89e4eSSatish Balay   */
750e5c89e4eSSatish Balay   ierr = MPI_Op_create(PetscMaxSum_Local,1,&PetscMaxSum_Op);CHKERRQ(ierr);
751e5c89e4eSSatish Balay 
752ce63c4c1SBarry Smith #if defined(PETSC_USE_REAL___FLOAT128)
753c90a1750SBarry Smith   ierr = MPI_Type_contiguous(2,MPI_DOUBLE,&MPIU___FLOAT128);CHKERRQ(ierr);
754c90a1750SBarry Smith   ierr = MPI_Type_commit(&MPIU___FLOAT128);CHKERRQ(ierr);
7557c2de775SJed Brown #if defined(PETSC_HAVE_COMPLEX)
7568c764dc5SJose Roman   ierr = MPI_Type_contiguous(4,MPI_DOUBLE,&MPIU___COMPLEX128);CHKERRQ(ierr);
7578c764dc5SJose Roman   ierr = MPI_Type_commit(&MPIU___COMPLEX128);CHKERRQ(ierr);
7588c764dc5SJose Roman #endif
759d9822059SBarry Smith   ierr = MPI_Op_create(PetscMax_Local,1,&MPIU_MAX);CHKERRQ(ierr);
760d9822059SBarry Smith   ierr = MPI_Op_create(PetscMin_Local,1,&MPIU_MIN);CHKERRQ(ierr);
761c90a1750SBarry Smith #endif
762c90a1750SBarry Smith 
7637c2de775SJed Brown #if (defined(PETSC_HAVE_COMPLEX) && !defined(PETSC_HAVE_MPI_C_DOUBLE_COMPLEX)) || defined(PETSC_USE_REAL___FLOAT128)
764cca4cb22SSatish Balay   ierr = MPI_Op_create(PetscSum_Local,1,&MPIU_SUM);CHKERRQ(ierr);
765cca4cb22SSatish Balay #endif
766cca4cb22SSatish Balay 
767e5c89e4eSSatish Balay   ierr = MPI_Type_contiguous(2,MPIU_SCALAR,&MPIU_2SCALAR);CHKERRQ(ierr);
768e5c89e4eSSatish Balay   ierr = MPI_Type_commit(&MPIU_2SCALAR);CHKERRQ(ierr);
769e5c89e4eSSatish Balay   ierr = MPI_Op_create(PetscADMax_Local,1,&PetscADMax_Op);CHKERRQ(ierr);
770e5c89e4eSSatish Balay   ierr = MPI_Op_create(PetscADMin_Local,1,&PetscADMin_Op);CHKERRQ(ierr);
771e5c89e4eSSatish Balay 
77244041f26SJed Brown #if defined(PETSC_USE_64BIT_INDICES) || !defined(MPI_2INT)
773e5c89e4eSSatish Balay   ierr = MPI_Type_contiguous(2,MPIU_INT,&MPIU_2INT);CHKERRQ(ierr);
774e5c89e4eSSatish Balay   ierr = MPI_Type_commit(&MPIU_2INT);CHKERRQ(ierr);
77544041f26SJed Brown #endif
776e5c89e4eSSatish Balay 
777ec957eceSBarry Smith 
778e5c89e4eSSatish Balay   /*
779480cf27aSJed Brown      Attributes to be set on PETSc communicators
780480cf27aSJed Brown   */
781480cf27aSJed Brown   ierr = MPI_Keyval_create(MPI_NULL_COPY_FN,Petsc_DelCounter,&Petsc_Counter_keyval,(void*)0);CHKERRQ(ierr);
782da3039f7SJed Brown   ierr = MPI_Keyval_create(MPI_NULL_COPY_FN,Petsc_DelComm_Outer,&Petsc_InnerComm_keyval,(void*)0);CHKERRQ(ierr);
783da3039f7SJed Brown   ierr = MPI_Keyval_create(MPI_NULL_COPY_FN,Petsc_DelComm_Inner,&Petsc_OuterComm_keyval,(void*)0);CHKERRQ(ierr);
784480cf27aSJed Brown 
785480cf27aSJed Brown   /*
786e8fb0fc0SBarry Smith      Build the options database
787e5c89e4eSSatish Balay   */
788e5c89e4eSSatish Balay   ierr = PetscOptionsInsert(argc,args,file);CHKERRQ(ierr);
789e5c89e4eSSatish Balay 
7906dc8fec2Sbcordonn 
791e5c89e4eSSatish Balay   /*
792e5c89e4eSSatish Balay      Print main application help message
793e5c89e4eSSatish Balay   */
7940298fd71SBarry Smith   ierr = PetscOptionsHasName(NULL,"-help",&flg);CHKERRQ(ierr);
795e5c89e4eSSatish Balay   if (help && flg) {
796e5c89e4eSSatish Balay     ierr = PetscPrintf(PETSC_COMM_WORLD,help);CHKERRQ(ierr);
797e5c89e4eSSatish Balay   }
798e5c89e4eSSatish Balay   ierr = PetscOptionsCheckInitial_Private();CHKERRQ(ierr);
799e5c89e4eSSatish Balay 
800e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS)
801ca93e954SBarry Smith   ierr = SAWs_Initialize();CHKERRQ(ierr);
802*37bef686SBarry Smith   ierr = SAWs_Add_Directory(SAWs_ROOT_DIRECTORY,"PETSc",&PETSC_SAWs_ROOT_DIRECTORY);CHKERRQ(ierr);
803*37bef686SBarry Smith   ierr = SAWs_Add_Directory(PETSC_SAWs_ROOT_DIRECTORY,"Objects",&PETSC_OBJECTS_SAWs_ROOT_DIRECTORY);CHKERRQ(ierr);
804f4202a44SBarry Smith #endif
805f4202a44SBarry Smith 
806e5c89e4eSSatish Balay   /* SHOULD PUT IN GUARDS: Make sure logging is initialized, even if we do not print it out */
807a9f03627SSatish Balay #if defined(PETSC_USE_LOG)
808e5c89e4eSSatish Balay   ierr = PetscLogBegin_Private();CHKERRQ(ierr);
809a9f03627SSatish Balay #endif
810e5c89e4eSSatish Balay 
811e5c89e4eSSatish Balay   /*
812e5c89e4eSSatish Balay      Load the dynamic libraries (on machines that support them), this registers all
813e5c89e4eSSatish Balay      the solvers etc. (On non-dynamic machines this initializes the PetscDraw and PetscViewer classes)
814e5c89e4eSSatish Balay   */
815e5c89e4eSSatish Balay   ierr = PetscInitialize_DynamicLibraries();CHKERRQ(ierr);
816e5c89e4eSSatish Balay 
817e5c89e4eSSatish Balay   ierr = MPI_Comm_size(PETSC_COMM_WORLD,&size);CHKERRQ(ierr);
818ae15b995SBarry Smith   ierr = PetscInfo1(0,"PETSc successfully started: number of processors = %d\n",size);CHKERRQ(ierr);
819e5c89e4eSSatish Balay   ierr = PetscGetHostName(hostname,256);CHKERRQ(ierr);
820ae15b995SBarry Smith   ierr = PetscInfo1(0,"Running on machine: %s\n",hostname);CHKERRQ(ierr);
821e5c89e4eSSatish Balay 
822e5c89e4eSSatish Balay   ierr = PetscOptionsCheckInitial_Components();CHKERRQ(ierr);
823ef6c6fedSBoyana Norris   /* Check the options database for options related to the options database itself */
824ef6c6fedSBoyana Norris   ierr = PetscOptionsSetFromOptions();CHKERRQ(ierr);
825ef6c6fedSBoyana Norris 
826951e3c8eSBarry Smith #if defined(PETSC_USE_PETSC_MPI_EXTERNAL32)
827e39fd77fSBarry Smith   /*
828e39fd77fSBarry Smith       Tell MPI about our own data representation converter, this would/should be used if extern32 is not supported by the MPI
829e39fd77fSBarry Smith 
830e39fd77fSBarry Smith       Currently not used because it is not supported by MPICH.
831e39fd77fSBarry Smith   */
832e39fd77fSBarry Smith #if !defined(PETSC_WORDS_BIGENDIAN)
8330298fd71SBarry Smith   ierr = MPI_Register_datarep((char*)"petsc",PetscDataRep_read_conv_fn,PetscDataRep_write_conv_fn,PetscDataRep_extent_fn,NULL);CHKERRQ(ierr);
834e39fd77fSBarry Smith #endif
835951e3c8eSBarry Smith #endif
836e39fd77fSBarry Smith 
8370298fd71SBarry Smith   ierr = PetscOptionsGetInt(NULL,"-hmpi_spawn_size",&nodesize,&flg);CHKERRQ(ierr);
838793721a6SBarry Smith   if (flg) {
83923464e94SBarry Smith #if defined(PETSC_HAVE_MPI_COMM_SPAWN)
84085afcc9aSBarry Smith     ierr = PetscHMPISpawn((PetscMPIInt) nodesize);CHKERRQ(ierr); /* worker nodes never return from here; they go directly to PetscEnd() */
84123464e94SBarry Smith #else
84285afcc9aSBarry Smith     SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SUP,"PETSc built without MPI 2 (MPI_Comm_spawn) support, use -hmpi_merge_size instead");
84323464e94SBarry Smith #endif
844793721a6SBarry Smith   } else {
8450298fd71SBarry Smith     ierr = PetscOptionsGetInt(NULL,"-hmpi_merge_size",&nodesize,&flg);CHKERRQ(ierr);
8468002f1cdSBarry Smith     if (flg) {
8470298fd71SBarry Smith       ierr = PetscHMPIMerge((PetscMPIInt) nodesize,NULL,NULL);CHKERRQ(ierr);
84885afcc9aSBarry Smith       if (PetscHMPIWorker) { /* if worker then never enter user code */
849bad7cb1dSBarry Smith         PetscInitializeCalled = PETSC_TRUE;
8503bf036e2SBarry Smith         PetscEnd();
8519505b675SBarry Smith       }
8528002f1cdSBarry Smith     }
853793721a6SBarry Smith   }
854e5c89e4eSSatish Balay 
85535d88935SVictor Minden #if defined(PETSC_HAVE_CUDA)
8564bb5149bSJed Brown   {
8574bb5149bSJed Brown     PetscMPIInt p;
858663ba86aSMatthew G Knepley     for (p = 0; p < PetscGlobalSize; ++p) {
859a297a907SKarl Rupp       if (p == PetscGlobalRank) cublasInit();
860663ba86aSMatthew G Knepley       ierr = MPI_Barrier(PETSC_COMM_WORLD);CHKERRQ(ierr);
861663ba86aSMatthew G Knepley     }
8624bb5149bSJed Brown   }
8633e39abd9SVictor Minden #endif
86492e62aa6SBarry Smith 
8650298fd71SBarry Smith   ierr = PetscOptionsHasName(NULL,"-python",&flg);CHKERRQ(ierr);
8669ac80d5eSLisandro Dalcin   if (flg) {
8679ac80d5eSLisandro Dalcin     PetscInitializeCalled = PETSC_TRUE;
8680298fd71SBarry Smith     ierr = PetscPythonInitialize(NULL,NULL);CHKERRQ(ierr);
8699ac80d5eSLisandro Dalcin   }
8709ac80d5eSLisandro Dalcin 
871607a6623SBarry Smith   ierr = PetscThreadCommInitializePackage();CHKERRQ(ierr);
872bd8b14e7SShri Abhyankar 
87341c0b4b3SShri Abhyankar   /*
87441c0b4b3SShri Abhyankar       Setup building of stack frames for all function calls
87541c0b4b3SShri Abhyankar   */
876e1167bb9SShri Abhyankar #if defined(PETSC_USE_DEBUG)
877047240e1SBarry Smith   PetscThreadLocalRegister((PetscThreadKey*)&petscstack); /* Creates petscstack_key if needed */
878e1167bb9SShri Abhyankar   ierr = PetscStackCreate();CHKERRQ(ierr);
879e1167bb9SShri Abhyankar #endif
880e1167bb9SShri Abhyankar 
8812d53ad75SBarry Smith #if defined(PETSC_SERIALIZE_FUNCTIONS)
8822d53ad75SBarry Smith   ierr = PetscFPTCreate(10000);CHKERRQ(ierr);
8832d53ad75SBarry Smith #endif
8842d53ad75SBarry Smith 
885051e4cf2SJed Brown   ierr = PetscCitationsInitialize();CHKERRQ(ierr);
886dff31646SBarry Smith 
887301d30feSBarry Smith   /*
888301d30feSBarry Smith       Once we are completedly initialized then we can set this variables
889301d30feSBarry Smith   */
890301d30feSBarry Smith   PetscInitializeCalled = PETSC_TRUE;
891301d30feSBarry Smith   PetscFunctionReturn(0);
892e5c89e4eSSatish Balay }
893e5c89e4eSSatish Balay 
8942eff7a51SBarry Smith extern PetscObject *PetscObjects;
8952eff7a51SBarry Smith extern PetscInt    PetscObjectsCounts, PetscObjectsMaxCounts;
896e5c89e4eSSatish Balay 
897e5c89e4eSSatish Balay #undef __FUNCT__
898e5c89e4eSSatish Balay #define __FUNCT__ "PetscFinalize"
899e5c89e4eSSatish Balay /*@C
900e5c89e4eSSatish Balay    PetscFinalize - Checks for options to be called at the conclusion
901e5c89e4eSSatish Balay    of the program. MPI_Finalize() is called only if the user had not
902e5c89e4eSSatish Balay    called MPI_Init() before calling PetscInitialize().
903e5c89e4eSSatish Balay 
904e5c89e4eSSatish Balay    Collective on PETSC_COMM_WORLD
905e5c89e4eSSatish Balay 
906e5c89e4eSSatish Balay    Options Database Keys:
90788c29154SBarry Smith +  -options_table - Calls PetscOptionsView()
908e5c89e4eSSatish Balay .  -options_left - Prints unused options that remain in the database
9097eb1d149SBarry 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
910e5c89e4eSSatish Balay .  -mpidump - Calls PetscMPIDump()
911e5c89e4eSSatish Balay .  -malloc_dump - Calls PetscMallocDump()
912e5c89e4eSSatish Balay .  -malloc_info - Prints total memory usage
913e5c89e4eSSatish Balay -  -malloc_log - Prints summary of memory usage
914e5c89e4eSSatish Balay 
915e5c89e4eSSatish Balay    Level: beginner
916e5c89e4eSSatish Balay 
917e5c89e4eSSatish Balay    Note:
918e5c89e4eSSatish Balay    See PetscInitialize() for more general runtime options.
919e5c89e4eSSatish Balay 
92088c29154SBarry Smith .seealso: PetscInitialize(), PetscOptionsView(), PetscMallocDump(), PetscMPIDump(), PetscEnd()
921e5c89e4eSSatish Balay @*/
9227087cfbeSBarry Smith PetscErrorCode  PetscFinalize(void)
923e5c89e4eSSatish Balay {
924e5c89e4eSSatish Balay   PetscErrorCode ierr;
9254bb5149bSJed Brown   PetscMPIInt    rank;
926a8d2bbe5SBarry Smith   PetscInt       nopt;
9272bf49c77SBarry Smith   PetscBool      flg1 = PETSC_FALSE,flg2 = PETSC_FALSE,flg3 = PETSC_FALSE;
928dff31646SBarry Smith   PetscBool      flg;
92910463e74SBarry Smith #if defined(PETSC_USE_LOG)
93010463e74SBarry Smith   char           mname[PETSC_MAX_PATH_LEN];
93110463e74SBarry Smith #endif
932e5c89e4eSSatish Balay 
933e5c89e4eSSatish Balay   PetscFunctionBegin;
934e5c89e4eSSatish Balay   if (!PetscInitializeCalled) {
9354b09e917SBarry Smith     printf("PetscInitialize() must be called before PetscFinalize()\n");
9364b09e917SBarry Smith     PetscFunctionReturn(PETSC_ERR_ARG_WRONGSTATE);
937e5c89e4eSSatish Balay   }
9380298fd71SBarry Smith   ierr = PetscInfo(NULL,"PetscFinalize() called\n");CHKERRQ(ierr);
939b022a5c1SBarry Smith 
9401f817a21SBarry Smith   ierr = MPI_Comm_rank(PETSC_COMM_WORLD,&rank);CHKERRQ(ierr);
9411f817a21SBarry Smith 
9421f817a21SBarry Smith   ierr = PetscOptionsHasName(NULL,"-citations",&flg);CHKERRQ(ierr);
943dff31646SBarry Smith   if (flg) {
9441f817a21SBarry Smith     char  *cits, filename[PETSC_MAX_PATH_LEN];
9451f817a21SBarry Smith     FILE  *fd = PETSC_STDOUT;
9461f817a21SBarry Smith 
9471f817a21SBarry Smith     ierr = PetscOptionsGetString(NULL,"-citations",filename,PETSC_MAX_PATH_LEN,NULL);CHKERRQ(ierr);
9481f817a21SBarry Smith     if (filename[0]) {
9491f817a21SBarry Smith       ierr = PetscFOpen(PETSC_COMM_WORLD,filename,"w",&fd);CHKERRQ(ierr);
9501f817a21SBarry Smith     }
951dff31646SBarry Smith     ierr = PetscSegBufferGet(PetscCitationsList,1,&cits);CHKERRQ(ierr);
952dff31646SBarry Smith     cits[0] = 0;
953dff31646SBarry Smith     ierr = PetscSegBufferExtractAlloc(PetscCitationsList,&cits);CHKERRQ(ierr);
9541f817a21SBarry Smith     ierr = PetscFPrintf(PETSC_COMM_WORLD,fd,"If you publish results based on this computation please cite the following:\n");CHKERRQ(ierr);
9551f817a21SBarry Smith     ierr = PetscFPrintf(PETSC_COMM_WORLD,fd,"===========================================================================\n");CHKERRQ(ierr);
9561f817a21SBarry Smith     ierr = PetscFPrintf(PETSC_COMM_WORLD,fd,"%s",cits);CHKERRQ(ierr);
9571f817a21SBarry Smith     ierr = PetscFPrintf(PETSC_COMM_WORLD,fd,"===========================================================================\n");CHKERRQ(ierr);
9581f817a21SBarry Smith     ierr = PetscFClose(PETSC_COMM_WORLD,fd);CHKERRQ(ierr);
959dff31646SBarry Smith     ierr = PetscFree(cits);CHKERRQ(ierr);
960dff31646SBarry Smith   }
961dff31646SBarry Smith   ierr = PetscSegBufferDestroy(&PetscCitationsList);CHKERRQ(ierr);
962dff31646SBarry Smith 
9632d53ad75SBarry Smith #if defined(PETSC_SERIALIZE_FUNCTIONS)
9642d53ad75SBarry Smith   ierr = PetscFPTDestroy();CHKERRQ(ierr);
9652d53ad75SBarry Smith #endif
9662d53ad75SBarry Smith 
9672d53ad75SBarry Smith 
968e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS)
969dff31646SBarry Smith   flg = PETSC_FALSE;
9700298fd71SBarry Smith   ierr = PetscOptionsGetBool(NULL,"-options_gui",&flg,NULL);CHKERRQ(ierr);
971d5649816SBarry Smith   if (flg) {
972e04113cfSBarry Smith     ierr = PetscOptionsSAWsDestroy();CHKERRQ(ierr);
973d5649816SBarry Smith   }
974d5649816SBarry Smith #endif
975d5649816SBarry Smith 
9766d065ec1SBarry Smith #if defined(PETSC_HAVE_SERVER)
9772d139d8fSBarry Smith   flg1 = PETSC_FALSE;
9782d139d8fSBarry Smith   ierr = PetscOptionsGetBool(NULL,"-server",&flg1,NULL);CHKERRQ(ierr);
9792d139d8fSBarry Smith   if (flg1) {
9806d065ec1SBarry Smith     /*  this is a crude hack, but better than nothing */
9812d139d8fSBarry Smith     ierr = PetscPOpen(PETSC_COMM_WORLD,NULL,"pkill -9 petscwebserver","r",NULL);CHKERRQ(ierr);
9822d139d8fSBarry Smith   }
9836d065ec1SBarry Smith #endif
9842d139d8fSBarry Smith 
985681455b2SBarry Smith #if defined(PETSC_HAVE_X)
986681455b2SBarry Smith   flg1 = PETSC_FALSE;
987681455b2SBarry Smith   ierr = PetscOptionsGetBool(NULL,"-x_virtual",&flg1,NULL);CHKERRQ(ierr);
988681455b2SBarry Smith   if (flg1) {
989681455b2SBarry Smith     /*  this is a crude hack, but better than nothing */
990681455b2SBarry Smith     ierr = PetscPOpen(PETSC_COMM_WORLD,NULL,"pkill -9 Xvfb","r",NULL);CHKERRQ(ierr);
991681455b2SBarry Smith   }
992681455b2SBarry Smith #endif
993681455b2SBarry Smith 
99485afcc9aSBarry Smith   ierr = PetscHMPIFinalize();CHKERRQ(ierr);
995d3f95da6SShri Abhyankar 
9960298fd71SBarry Smith   ierr = PetscOptionsGetBool(NULL,"-malloc_info",&flg2,NULL);CHKERRQ(ierr);
997e5c89e4eSSatish Balay   if (!flg2) {
99890d69ab7SBarry Smith     flg2 = PETSC_FALSE;
9990298fd71SBarry Smith     ierr = PetscOptionsGetBool(NULL,"-memory_info",&flg2,NULL);CHKERRQ(ierr);
1000e5c89e4eSSatish Balay   }
1001e5c89e4eSSatish Balay   if (flg2) {
1002e5c89e4eSSatish Balay     ierr = PetscMemoryShowUsage(PETSC_VIEWER_STDOUT_WORLD,"Summary of Memory Usage in PETSc\n");CHKERRQ(ierr);
1003e5c89e4eSSatish Balay   }
1004e5c89e4eSSatish Balay 
1005e5c89e4eSSatish Balay #if defined(PETSC_USE_LOG)
100690d69ab7SBarry Smith   flg1 = PETSC_FALSE;
10070298fd71SBarry Smith   ierr = PetscOptionsGetBool(NULL,"-get_total_flops",&flg1,NULL);CHKERRQ(ierr);
1008e5c89e4eSSatish Balay   if (flg1) {
1009e5c89e4eSSatish Balay     PetscLogDouble flops = 0;
1010205a32c2SJed Brown     ierr = MPI_Reduce(&petsc_TotalFlops,&flops,1,MPI_DOUBLE,MPI_SUM,0,PETSC_COMM_WORLD);CHKERRQ(ierr);
1011e5c89e4eSSatish Balay     ierr = PetscPrintf(PETSC_COMM_WORLD,"Total flops over all processors %g\n",flops);CHKERRQ(ierr);
1012e5c89e4eSSatish Balay   }
1013e5c89e4eSSatish Balay #endif
1014e5c89e4eSSatish Balay 
1015e5c89e4eSSatish Balay 
1016e5c89e4eSSatish Balay #if defined(PETSC_USE_LOG)
1017e5c89e4eSSatish Balay #if defined(PETSC_HAVE_MPE)
1018e5c89e4eSSatish Balay   mname[0] = 0;
1019a297a907SKarl Rupp 
10200298fd71SBarry Smith   ierr = PetscOptionsGetString(NULL,"-log_mpe",mname,PETSC_MAX_PATH_LEN,&flg1);CHKERRQ(ierr);
1021e5c89e4eSSatish Balay   if (flg1) {
1022e5c89e4eSSatish Balay     if (mname[0]) {ierr = PetscLogMPEDump(mname);CHKERRQ(ierr);}
1023e5c89e4eSSatish Balay     else          {ierr = PetscLogMPEDump(0);CHKERRQ(ierr);}
1024e5c89e4eSSatish Balay   }
1025e5c89e4eSSatish Balay #endif
1026e5c89e4eSSatish Balay   mname[0] = 0;
1027a297a907SKarl Rupp 
10280298fd71SBarry Smith   ierr = PetscOptionsGetString(NULL,"-log_summary",mname,PETSC_MAX_PATH_LEN,&flg1);CHKERRQ(ierr);
1029e5c89e4eSSatish Balay   if (flg1) {
103091eabc43SBarry Smith     PetscViewer viewer;
103191eabc43SBarry Smith     if (mname[0]) {
103291eabc43SBarry Smith       ierr = PetscViewerASCIIOpen(PETSC_COMM_WORLD,mname,&viewer);CHKERRQ(ierr);
103391eabc43SBarry Smith       ierr = PetscLogView(viewer);CHKERRQ(ierr);
10346bf464f9SBarry Smith       ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr);
103533f85c2fSBarry Smith     } else {
103633f85c2fSBarry Smith       viewer = PETSC_VIEWER_STDOUT_WORLD;
103733f85c2fSBarry Smith       ierr   = PetscLogView(viewer);CHKERRQ(ierr);
103833f85c2fSBarry Smith     }
1039e5c89e4eSSatish Balay   }
1040e5c89e4eSSatish Balay 
1041ff5bc46bSBarry Smith   mname[0] = 0;
1042a297a907SKarl Rupp 
10430298fd71SBarry Smith   ierr = PetscOptionsGetString(NULL,"-log_summary_python",mname,PETSC_MAX_PATH_LEN,&flg1);CHKERRQ(ierr);
1044ff5bc46bSBarry Smith   if (flg1) {
1045ff5bc46bSBarry Smith     PetscViewer viewer;
1046ff5bc46bSBarry Smith     if (mname[0]) {
1047ff5bc46bSBarry Smith       ierr = PetscViewerASCIIOpen(PETSC_COMM_WORLD,mname,&viewer);CHKERRQ(ierr);
104891eabc43SBarry Smith       ierr = PetscLogViewPython(viewer);CHKERRQ(ierr);
10496bf464f9SBarry Smith       ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr);
105033f85c2fSBarry Smith     } else {
105133f85c2fSBarry Smith       viewer = PETSC_VIEWER_STDOUT_WORLD;
105233f85c2fSBarry Smith       ierr   = PetscLogViewPython(viewer);CHKERRQ(ierr);
105333f85c2fSBarry Smith     }
1054ff5bc46bSBarry Smith   }
1055ff5bc46bSBarry Smith 
10560298fd71SBarry Smith   ierr = PetscOptionsGetString(NULL,"-log_detailed",mname,PETSC_MAX_PATH_LEN,&flg1);CHKERRQ(ierr);
105778392ef1SBarry Smith   if (flg1) {
105878392ef1SBarry Smith     if (mname[0])  {ierr = PetscLogPrintDetailed(PETSC_COMM_WORLD,mname);CHKERRQ(ierr);}
105978392ef1SBarry Smith     else           {ierr = PetscLogPrintDetailed(PETSC_COMM_WORLD,0);CHKERRQ(ierr);}
106078392ef1SBarry Smith   }
106178392ef1SBarry Smith 
1062e5c89e4eSSatish Balay   mname[0] = 0;
1063a297a907SKarl Rupp 
10640298fd71SBarry Smith   ierr = PetscOptionsGetString(NULL,"-log_all",mname,PETSC_MAX_PATH_LEN,&flg1);CHKERRQ(ierr);
10650298fd71SBarry Smith   ierr = PetscOptionsGetString(NULL,"-log",mname,PETSC_MAX_PATH_LEN,&flg2);CHKERRQ(ierr);
1066e5c89e4eSSatish Balay   if (flg1 || flg2) {
1067e5c89e4eSSatish Balay     if (mname[0]) PetscLogDump(mname);
1068e5c89e4eSSatish Balay     else          PetscLogDump(0);
1069e5c89e4eSSatish Balay   }
1070e5c89e4eSSatish Balay #endif
107110463e74SBarry Smith 
1072b58ca069SBarry Smith   /*
1073b58ca069SBarry Smith      Free all objects registered with PetscObjectRegisterDestroy() such as PETSC_VIEWER_XXX_().
1074b58ca069SBarry Smith   */
1075b58ca069SBarry Smith   ierr = PetscObjectRegisterDestroyAll();CHKERRQ(ierr);
1076b58ca069SBarry Smith 
107733f85c2fSBarry Smith   ierr = PetscStackDestroy();CHKERRQ(ierr);
107810463e74SBarry Smith 
107990d69ab7SBarry Smith   flg1 = PETSC_FALSE;
10800298fd71SBarry Smith   ierr = PetscOptionsGetBool(NULL,"-no_signal_handler",&flg1,NULL);CHKERRQ(ierr);
1081e5c89e4eSSatish Balay   if (!flg1) { ierr = PetscPopSignalHandler();CHKERRQ(ierr);}
108290d69ab7SBarry Smith   flg1 = PETSC_FALSE;
10830298fd71SBarry Smith   ierr = PetscOptionsGetBool(NULL,"-mpidump",&flg1,NULL);CHKERRQ(ierr);
1084e5c89e4eSSatish Balay   if (flg1) {
1085e5c89e4eSSatish Balay     ierr = PetscMPIDump(stdout);CHKERRQ(ierr);
1086e5c89e4eSSatish Balay   }
108790d69ab7SBarry Smith   flg1 = PETSC_FALSE;
108890d69ab7SBarry Smith   flg2 = PETSC_FALSE;
10898bb29257SSatish Balay   /* preemptive call to avoid listing this option in options table as unused */
10900298fd71SBarry Smith   ierr = PetscOptionsHasName(NULL,"-malloc_dump",&flg1);CHKERRQ(ierr);
10910298fd71SBarry Smith   ierr = PetscOptionsHasName(NULL,"-objects_dump",&flg1);CHKERRQ(ierr);
10920298fd71SBarry Smith   ierr = PetscOptionsGetBool(NULL,"-options_table",&flg2,NULL);CHKERRQ(ierr);
1093e4c476e2SSatish Balay 
1094e5c89e4eSSatish Balay   if (flg2) {
1095be56827dSJed Brown     PetscViewer viewer;
1096be56827dSJed Brown     ierr = PetscViewerASCIIGetStdout(PETSC_COMM_WORLD,&viewer);CHKERRQ(ierr);
1097be56827dSJed Brown     ierr = PetscOptionsView(viewer);CHKERRQ(ierr);
1098be56827dSJed Brown     ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr);
1099e5c89e4eSSatish Balay   }
1100e5c89e4eSSatish Balay 
1101e5c89e4eSSatish Balay   /* to prevent PETSc -options_left from warning */
11020298fd71SBarry Smith   ierr = PetscOptionsHasName(NULL,"-nox",&flg1);CHKERRQ(ierr);
11030298fd71SBarry Smith   ierr = PetscOptionsHasName(NULL,"-nox_warning",&flg1);CHKERRQ(ierr);
1104e5c89e4eSSatish Balay 
110585afcc9aSBarry Smith   if (!PetscHMPIWorker) { /* worker processes skip this because they do not usually process options */
110633fc4174SSatish Balay     flg3 = PETSC_FALSE; /* default value is required */
11070298fd71SBarry Smith     ierr = PetscOptionsGetBool(NULL,"-options_left",&flg3,&flg1);CHKERRQ(ierr);
1108e5c89e4eSSatish Balay     ierr = PetscOptionsAllUsed(&nopt);CHKERRQ(ierr);
1109e5c89e4eSSatish Balay     if (flg3) {
1110e5c89e4eSSatish Balay       if (!flg2) { /* have not yet printed the options */
1111be56827dSJed Brown         PetscViewer viewer;
1112be56827dSJed Brown         ierr = PetscViewerASCIIGetStdout(PETSC_COMM_WORLD,&viewer);CHKERRQ(ierr);
1113be56827dSJed Brown         ierr = PetscOptionsView(viewer);CHKERRQ(ierr);
1114be56827dSJed Brown         ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr);
1115e5c89e4eSSatish Balay       }
1116e5c89e4eSSatish Balay       if (!nopt) {
1117e5c89e4eSSatish Balay         ierr = PetscPrintf(PETSC_COMM_WORLD,"There are no unused options.\n");CHKERRQ(ierr);
1118e5c89e4eSSatish Balay       } else if (nopt == 1) {
1119e5c89e4eSSatish Balay         ierr = PetscPrintf(PETSC_COMM_WORLD,"There is one unused database option. It is:\n");CHKERRQ(ierr);
1120e5c89e4eSSatish Balay       } else {
11217582186dSLisandro Dalcin         ierr = PetscPrintf(PETSC_COMM_WORLD,"There are %D unused database options. They are:\n",nopt);CHKERRQ(ierr);
1122e5c89e4eSSatish Balay       }
1123e5c89e4eSSatish Balay     }
1124e5c89e4eSSatish Balay #if defined(PETSC_USE_DEBUG)
1125da8b8a77SBarry Smith     if (nopt && !flg3 && !flg1) {
1126e5c89e4eSSatish Balay       ierr = PetscPrintf(PETSC_COMM_WORLD,"WARNING! There are options you set that were not used!\n");CHKERRQ(ierr);
1127e5c89e4eSSatish Balay       ierr = PetscPrintf(PETSC_COMM_WORLD,"WARNING! could be spelling mistake, etc!\n");CHKERRQ(ierr);
1128e5c89e4eSSatish Balay       ierr = PetscOptionsLeft();CHKERRQ(ierr);
1129e5c89e4eSSatish Balay     } else if (nopt && flg3) {
1130e5c89e4eSSatish Balay #else
1131e5c89e4eSSatish Balay     if (nopt && flg3) {
1132e5c89e4eSSatish Balay #endif
1133e5c89e4eSSatish Balay       ierr = PetscOptionsLeft();CHKERRQ(ierr);
1134e5c89e4eSSatish Balay     }
1135931f367cSBarry Smith   }
1136e5c89e4eSSatish Balay 
1137e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS)
1138*37bef686SBarry Smith   ierr = SAWs_Destroy_Directory(&PETSC_OBJECTS_SAWs_ROOT_DIRECTORY);CHKERRQ(ierr);
1139*37bef686SBarry Smith   ierr = SAWs_Destroy_Directory(&PETSC_SAWs_ROOT_DIRECTORY);CHKERRQ(ierr);
1140*37bef686SBarry Smith   ierr = SAWs_Finalize();CHKERRQ(ierr);
1141ec957eceSBarry Smith #endif
1142ec957eceSBarry Smith 
1143eea2bdeeSJed Brown   {
1144eea2bdeeSJed Brown     PetscThreadComm tcomm_world;
1145eea2bdeeSJed Brown     ierr = PetscGetThreadCommWorld(&tcomm_world);CHKERRQ(ierr);
1146eea2bdeeSJed Brown     /* Free global thread communicator */
1147eea2bdeeSJed Brown     ierr = PetscThreadCommDestroy(&tcomm_world);CHKERRQ(ierr);
1148eea2bdeeSJed Brown   }
1149eea2bdeeSJed Brown 
115010463e74SBarry Smith   /*
1151dbc8283eSBarry Smith        List all objects the user may have forgot to free
11522eff7a51SBarry Smith   */
11530298fd71SBarry Smith   ierr = PetscOptionsHasName(NULL,"-objects_dump",&flg1);CHKERRQ(ierr);
1154a64a8e02SBarry Smith   if (flg1) {
1155a64a8e02SBarry Smith     MPI_Comm local_comm;
11567eb1d149SBarry Smith     char     string[64];
1157a64a8e02SBarry Smith 
11580298fd71SBarry Smith     ierr = PetscOptionsGetString(NULL,"-objects_dump",string,64,NULL);CHKERRQ(ierr);
1159a64a8e02SBarry Smith     ierr = MPI_Comm_dup(MPI_COMM_WORLD,&local_comm);CHKERRQ(ierr);
1160a64a8e02SBarry Smith     ierr = PetscSequentialPhaseBegin_Private(local_comm,1);CHKERRQ(ierr);
11617eb1d149SBarry Smith     ierr = PetscObjectsDump(stdout,(string[0] == 'a') ? PETSC_TRUE : PETSC_FALSE);CHKERRQ(ierr);
1162a64a8e02SBarry Smith     ierr = PetscSequentialPhaseEnd_Private(local_comm,1);CHKERRQ(ierr);
1163a64a8e02SBarry Smith     ierr = MPI_Comm_free(&local_comm);CHKERRQ(ierr);
11640a1571b3SBarry Smith   }
1165dbc8283eSBarry Smith   PetscObjectsCounts    = 0;
1166dbc8283eSBarry Smith   PetscObjectsMaxCounts = 0;
11672eff7a51SBarry Smith 
1168a297a907SKarl Rupp   ierr = PetscFree(PetscObjects);CHKERRQ(ierr);
11692eff7a51SBarry Smith 
117033f85c2fSBarry Smith #if defined(PETSC_USE_LOG)
117133f85c2fSBarry Smith   ierr = PetscLogDestroy();CHKERRQ(ierr);
117233f85c2fSBarry Smith #endif
117333f85c2fSBarry Smith 
117433f85c2fSBarry Smith   /*
117533f85c2fSBarry Smith      Destroy any packages that registered a finalize
117633f85c2fSBarry Smith   */
117733f85c2fSBarry Smith   ierr = PetscRegisterFinalizeAll();CHKERRQ(ierr);
117833f85c2fSBarry Smith 
117933f85c2fSBarry Smith   /*
118010463e74SBarry Smith      Destroy all the function registration lists created
118110463e74SBarry Smith   */
118210463e74SBarry Smith   ierr = PetscFinalize_DynamicLibraries();CHKERRQ(ierr);
118310463e74SBarry Smith 
118448dd1dffSBarry Smith   /*
118548dd1dffSBarry Smith      Print PetscFunctionLists that have not been properly freed
118648dd1dffSBarry Smith 
118737e93019SBarry Smith   ierr = PetscFunctionListPrintAll();CHKERRQ(ierr);
118848dd1dffSBarry Smith   */
118937e93019SBarry Smith 
11904028d114SSatish Balay   if (petsc_history) {
1191f3dea69dSBarry Smith     ierr = PetscCloseHistoryFile(&petsc_history);CHKERRQ(ierr);
1192e5c89e4eSSatish Balay     petsc_history = 0;
1193e5c89e4eSSatish Balay   }
1194e5c89e4eSSatish Balay 
11950298fd71SBarry Smith   ierr = PetscInfoAllow(PETSC_FALSE,NULL);CHKERRQ(ierr);
1196e5c89e4eSSatish Balay 
11978bb29257SSatish Balay   {
1198e5c89e4eSSatish Balay     char fname[PETSC_MAX_PATH_LEN];
1199e5c89e4eSSatish Balay     FILE *fd;
1200ed9cf6e9SBarry Smith     int  err;
1201e5c89e4eSSatish Balay 
1202e5c89e4eSSatish Balay     fname[0] = 0;
1203a297a907SKarl Rupp 
12040298fd71SBarry Smith     ierr = PetscOptionsGetString(NULL,"-malloc_dump",fname,250,&flg1);CHKERRQ(ierr);
1205dc92acbaSJed Brown     flg2 = PETSC_FALSE;
12060298fd71SBarry Smith     ierr = PetscOptionsGetBool(NULL,"-malloc_test",&flg2,NULL);CHKERRQ(ierr);
12078bf1f09cSShri Abhyankar #if defined(PETSC_USE_DEBUG)
1208dc92acbaSJed Brown     if (PETSC_RUNNING_ON_VALGRIND) flg2 = PETSC_FALSE;
1209dc92acbaSJed Brown #else
1210dc92acbaSJed Brown     flg2 = PETSC_FALSE;         /* Skip reporting for optimized builds regardless of -malloc_test */
1211dc92acbaSJed Brown #endif
1212e5c89e4eSSatish Balay     if (flg1 && fname[0]) {
1213e5c89e4eSSatish Balay       char sname[PETSC_MAX_PATH_LEN];
1214e5c89e4eSSatish Balay 
1215e5c89e4eSSatish Balay       sprintf(sname,"%s_%d",fname,rank);
1216e32f2f54SBarry Smith       fd   = fopen(sname,"w"); if (!fd) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_FILE_OPEN,"Cannot open log file: %s",sname);
1217e5c89e4eSSatish Balay       ierr = PetscMallocDump(fd);CHKERRQ(ierr);
1218ed9cf6e9SBarry Smith       err  = fclose(fd);
1219e32f2f54SBarry Smith       if (err) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SYS,"fclose() failed on file");
1220dc92acbaSJed Brown     } else if (flg1 || flg2) {
1221e5c89e4eSSatish Balay       MPI_Comm local_comm;
1222e5c89e4eSSatish Balay 
1223e5c89e4eSSatish Balay       ierr = MPI_Comm_dup(MPI_COMM_WORLD,&local_comm);CHKERRQ(ierr);
1224e5c89e4eSSatish Balay       ierr = PetscSequentialPhaseBegin_Private(local_comm,1);CHKERRQ(ierr);
1225e5c89e4eSSatish Balay       ierr = PetscMallocDump(stdout);CHKERRQ(ierr);
1226e5c89e4eSSatish Balay       ierr = PetscSequentialPhaseEnd_Private(local_comm,1);CHKERRQ(ierr);
1227e5c89e4eSSatish Balay       ierr = MPI_Comm_free(&local_comm);CHKERRQ(ierr);
1228e5c89e4eSSatish Balay     }
1229e5c89e4eSSatish Balay   }
1230a64a8e02SBarry Smith 
12318bb29257SSatish Balay   {
1232e5c89e4eSSatish Balay     char fname[PETSC_MAX_PATH_LEN];
12330298fd71SBarry Smith     FILE *fd = NULL;
1234e5c89e4eSSatish Balay 
1235e5c89e4eSSatish Balay     fname[0] = 0;
1236a297a907SKarl Rupp 
12370298fd71SBarry Smith     ierr = PetscOptionsGetString(NULL,"-malloc_log",fname,250,&flg1);CHKERRQ(ierr);
12380298fd71SBarry Smith     ierr = PetscOptionsHasName(NULL,"-malloc_log_threshold",&flg2);CHKERRQ(ierr);
1239e5c89e4eSSatish Balay     if (flg1 && fname[0]) {
1240ed9cf6e9SBarry Smith       int err;
1241e5c89e4eSSatish Balay 
1242574034a9SJed Brown       if (!rank) {
1243574034a9SJed Brown         fd = fopen(fname,"w");
1244574034a9SJed Brown         if (!fd) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_FILE_OPEN,"Cannot open log file: %s",fname);
1245574034a9SJed Brown       }
1246e5c89e4eSSatish Balay       ierr = PetscMallocDumpLog(fd);CHKERRQ(ierr);
1247574034a9SJed Brown       if (fd) {
1248ed9cf6e9SBarry Smith         err = fclose(fd);
1249e32f2f54SBarry Smith         if (err) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SYS,"fclose() failed on file");
1250574034a9SJed Brown       }
1251574034a9SJed Brown     } else if (flg1 || flg2) {
1252e5c89e4eSSatish Balay       ierr = PetscMallocDumpLog(stdout);CHKERRQ(ierr);
1253e5c89e4eSSatish Balay     }
1254e5c89e4eSSatish Balay   }
1255e5c89e4eSSatish Balay   /* Can be destroyed only after all the options are used */
1256e5c89e4eSSatish Balay   ierr = PetscOptionsDestroy();CHKERRQ(ierr);
1257e5c89e4eSSatish Balay 
1258e5c89e4eSSatish Balay   PetscGlobalArgc = 0;
1259e5c89e4eSSatish Balay   PetscGlobalArgs = 0;
1260e5c89e4eSSatish Balay 
1261ce63c4c1SBarry Smith #if defined(PETSC_USE_REAL___FLOAT128)
1262c90a1750SBarry Smith   ierr = MPI_Type_free(&MPIU___FLOAT128);CHKERRQ(ierr);
12637c2de775SJed Brown #if defined(PETSC_HAVE_COMPLEX)
12648c764dc5SJose Roman   ierr = MPI_Type_free(&MPIU___COMPLEX128);CHKERRQ(ierr);
12658c764dc5SJose Roman #endif
1266d9822059SBarry Smith   ierr = MPI_Op_free(&MPIU_MAX);CHKERRQ(ierr);
1267d9822059SBarry Smith   ierr = MPI_Op_free(&MPIU_MIN);CHKERRQ(ierr);
1268c90a1750SBarry Smith #endif
1269c90a1750SBarry Smith 
12707c2de775SJed Brown #if defined(PETSC_HAVE_COMPLEX)
12712c876bd9SBarry Smith #if !defined(PETSC_HAVE_MPI_C_DOUBLE_COMPLEX)
1272500d8756SSatish Balay   ierr = MPI_Type_free(&MPIU_C_DOUBLE_COMPLEX);CHKERRQ(ierr);
1273500d8756SSatish Balay   ierr = MPI_Type_free(&MPIU_C_COMPLEX);CHKERRQ(ierr);
12742c876bd9SBarry Smith #endif
1275e5c89e4eSSatish Balay #endif
1276cca4cb22SSatish Balay 
12777c2de775SJed Brown #if (defined(PETSC_HAVE_COMPLEX) && !defined(PETSC_HAVE_MPI_C_DOUBLE_COMPLEX)) || defined(PETSC_USE_REAL___FLOAT128)
1278cca4cb22SSatish Balay   ierr = MPI_Op_free(&MPIU_SUM);CHKERRQ(ierr);
1279cca4cb22SSatish Balay #endif
1280cca4cb22SSatish Balay 
1281e5c89e4eSSatish Balay   ierr = MPI_Type_free(&MPIU_2SCALAR);CHKERRQ(ierr);
128244041f26SJed Brown #if defined(PETSC_USE_64BIT_INDICES) || !defined(MPI_2INT)
1283e5c89e4eSSatish Balay   ierr = MPI_Type_free(&MPIU_2INT);CHKERRQ(ierr);
128444041f26SJed Brown #endif
1285e5c89e4eSSatish Balay   ierr = MPI_Op_free(&PetscMaxSum_Op);CHKERRQ(ierr);
1286e5c89e4eSSatish Balay   ierr = MPI_Op_free(&PetscADMax_Op);CHKERRQ(ierr);
1287e5c89e4eSSatish Balay   ierr = MPI_Op_free(&PetscADMin_Op);CHKERRQ(ierr);
1288e5c89e4eSSatish Balay 
1289dbc8283eSBarry Smith   /*
1290efb80d3cSBarry Smith      Destroy any known inner MPI_Comm's and attributes pointing to them
1291efb80d3cSBarry Smith      Note this will not destroy any new communicators the user has created.
1292efb80d3cSBarry Smith 
1293efb80d3cSBarry Smith      If all PETSc objects were not destroyed those left over objects will have hanging references to
1294efb80d3cSBarry Smith      the MPI_Comms that were freed; but that is ok because those PETSc objects will never be used again
1295dbc8283eSBarry Smith  */
1296b770b1f6SSatish Balay   {
1297dbc8283eSBarry Smith     PetscCommCounter *counter;
1298dbc8283eSBarry Smith     PetscMPIInt      flg;
1299dbc8283eSBarry Smith     MPI_Comm         icomm;
1300265f3f35SJed Brown     union {MPI_Comm comm; void *ptr;} ucomm;
1301265f3f35SJed Brown     ierr = MPI_Attr_get(PETSC_COMM_SELF,Petsc_InnerComm_keyval,&ucomm,&flg);CHKERRQ(ierr);
1302dbc8283eSBarry Smith     if (flg) {
1303265f3f35SJed Brown       icomm = ucomm.comm;
1304dbc8283eSBarry Smith       ierr = MPI_Attr_get(icomm,Petsc_Counter_keyval,&counter,&flg);CHKERRQ(ierr);
1305dbc8283eSBarry 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");
1306dbc8283eSBarry Smith 
1307dbc8283eSBarry Smith       ierr = MPI_Attr_delete(PETSC_COMM_SELF,Petsc_InnerComm_keyval);CHKERRQ(ierr);
1308efb80d3cSBarry Smith       ierr = MPI_Attr_delete(icomm,Petsc_Counter_keyval);CHKERRQ(ierr);
1309efb80d3cSBarry Smith       ierr = MPI_Comm_free(&icomm);CHKERRQ(ierr);
1310dbc8283eSBarry Smith     }
1311265f3f35SJed Brown     ierr = MPI_Attr_get(PETSC_COMM_WORLD,Petsc_InnerComm_keyval,&ucomm,&flg);CHKERRQ(ierr);
1312dbc8283eSBarry Smith     if (flg) {
1313265f3f35SJed Brown       icomm = ucomm.comm;
1314dbc8283eSBarry Smith       ierr = MPI_Attr_get(icomm,Petsc_Counter_keyval,&counter,&flg);CHKERRQ(ierr);
1315dbc8283eSBarry 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");
1316dbc8283eSBarry Smith 
1317dbc8283eSBarry Smith       ierr = MPI_Attr_delete(PETSC_COMM_WORLD,Petsc_InnerComm_keyval);CHKERRQ(ierr);
1318efb80d3cSBarry Smith       ierr = MPI_Attr_delete(icomm,Petsc_Counter_keyval);CHKERRQ(ierr);
1319efb80d3cSBarry Smith       ierr = MPI_Comm_free(&icomm);CHKERRQ(ierr);
1320dbc8283eSBarry Smith     }
1321b770b1f6SSatish Balay   }
1322dbc8283eSBarry Smith 
1323480cf27aSJed Brown   ierr = MPI_Keyval_free(&Petsc_Counter_keyval);CHKERRQ(ierr);
1324480cf27aSJed Brown   ierr = MPI_Keyval_free(&Petsc_InnerComm_keyval);CHKERRQ(ierr);
1325480cf27aSJed Brown   ierr = MPI_Keyval_free(&Petsc_OuterComm_keyval);CHKERRQ(ierr);
1326480cf27aSJed Brown 
1327663ba86aSMatthew G Knepley #if defined(PETSC_HAVE_CUDA)
13284bb5149bSJed Brown   {
13294bb5149bSJed Brown     PetscInt p;
1330663ba86aSMatthew G Knepley     for (p = 0; p < PetscGlobalSize; ++p) {
1331a297a907SKarl Rupp       if (p == PetscGlobalRank) cublasShutdown();
1332663ba86aSMatthew G Knepley       ierr = MPI_Barrier(PETSC_COMM_WORLD);CHKERRQ(ierr);
1333663ba86aSMatthew G Knepley     }
13344bb5149bSJed Brown   }
1335663ba86aSMatthew G Knepley #endif
1336663ba86aSMatthew G Knepley 
1337e5c89e4eSSatish Balay   if (PetscBeganMPI) {
133899608316SBarry Smith #if defined(PETSC_HAVE_MPI_FINALIZED)
133999b1327fSBarry Smith     PetscMPIInt flag;
134099b1327fSBarry Smith     ierr = MPI_Finalized(&flag);CHKERRQ(ierr);
1341e32f2f54SBarry Smith     if (flag) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_LIB,"MPI_Finalize() has already been called, even though MPI_Init() was called by PetscInitialize()");
134299608316SBarry Smith #endif
1343e5c89e4eSSatish Balay     ierr = MPI_Finalize();CHKERRQ(ierr);
1344e5c89e4eSSatish Balay   }
1345e5c89e4eSSatish Balay /*
1346e5c89e4eSSatish Balay 
1347e5c89e4eSSatish Balay      Note: In certain cases PETSC_COMM_WORLD is never MPI_Comm_free()ed because
1348e5c89e4eSSatish Balay    the communicator has some outstanding requests on it. Specifically if the
1349e5c89e4eSSatish Balay    flag PETSC_HAVE_BROKEN_REQUEST_FREE is set (for IBM MPI implementation). See
1350e5c89e4eSSatish Balay    src/vec/utils/vpscat.c. Due to this the memory allocated in PetscCommDuplicate()
1351e5c89e4eSSatish Balay    is never freed as it should be. Thus one may obtain messages of the form
13520e5e90baSSatish Balay    [ 1] 8 bytes PetscCommDuplicate() line 645 in src/sys/mpiu.c indicating the
1353e5c89e4eSSatish Balay    memory was not freed.
1354e5c89e4eSSatish Balay 
1355e5c89e4eSSatish Balay */
13561d1a0024SBarry Smith   ierr = PetscMallocClear();CHKERRQ(ierr);
1357a297a907SKarl Rupp 
1358e5c89e4eSSatish Balay   PetscInitializeCalled = PETSC_FALSE;
1359e5c89e4eSSatish Balay   PetscFinalizeCalled   = PETSC_TRUE;
1360e5c89e4eSSatish Balay   PetscFunctionReturn(ierr);
1361e5c89e4eSSatish Balay }
1362e5c89e4eSSatish Balay 
136343db4dbbSBarry Smith #if defined(PETSC_MISSING_LAPACK_lsame_)
13648cc058d9SJed Brown PETSC_EXTERN int lsame_(char *a,char *b)
136543db4dbbSBarry Smith {
136643db4dbbSBarry Smith   if (*a == *b) return 1;
136743db4dbbSBarry Smith   if (*a + 32 == *b) return 1;
136843db4dbbSBarry Smith   if (*a - 32 == *b) return 1;
136943db4dbbSBarry Smith   return 0;
137043db4dbbSBarry Smith }
1371a70650f6SBarry Smith #endif
137243db4dbbSBarry Smith 
137343db4dbbSBarry Smith #if defined(PETSC_MISSING_LAPACK_lsame)
13748cc058d9SJed Brown PETSC_EXTERN int lsame(char *a,char *b)
137543db4dbbSBarry Smith {
137643db4dbbSBarry Smith   if (*a == *b) return 1;
137743db4dbbSBarry Smith   if (*a + 32 == *b) return 1;
137843db4dbbSBarry Smith   if (*a - 32 == *b) return 1;
137943db4dbbSBarry Smith   return 0;
138043db4dbbSBarry Smith }
138143db4dbbSBarry Smith #endif
1382