xref: /petsc/src/sys/objects/pinit.c (revision 051e4cf2c877cadc199afcf951ee51ad35f26766)
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 
202d53ad75SBarry Smith 
212d53ad75SBarry Smith #if defined(PETSC_SERIALIZE_FUNCTIONS)
222d53ad75SBarry Smith PetscFPT PetscFPTData = 0;
232d53ad75SBarry Smith #endif
242d53ad75SBarry Smith 
25e5c89e4eSSatish Balay /* -----------------------------------------------------------------------------------------*/
26e5c89e4eSSatish Balay 
27e5c89e4eSSatish Balay extern FILE *petsc_history;
28e5c89e4eSSatish Balay 
2909573ac7SBarry Smith extern PetscErrorCode PetscInitialize_DynamicLibraries(void);
3009573ac7SBarry Smith extern PetscErrorCode PetscFinalize_DynamicLibraries(void);
3137e93019SBarry Smith extern PetscErrorCode PetscFunctionListPrintAll(void);
3209573ac7SBarry Smith extern PetscErrorCode PetscSequentialPhaseBegin_Private(MPI_Comm,int);
3309573ac7SBarry Smith extern PetscErrorCode PetscSequentialPhaseEnd_Private(MPI_Comm,int);
3409573ac7SBarry Smith extern PetscErrorCode PetscCloseHistoryFile(FILE**);
350069ddf5SShri Abhyankar 
36e5c89e4eSSatish Balay /* user may set this BEFORE calling PetscInitialize() */
37e8373e55SMatthew Knepley MPI_Comm PETSC_COMM_WORLD = MPI_COMM_NULL;
38e5c89e4eSSatish Balay 
39480cf27aSJed Brown PetscMPIInt Petsc_Counter_keyval   = MPI_KEYVAL_INVALID;
40480cf27aSJed Brown PetscMPIInt Petsc_InnerComm_keyval = MPI_KEYVAL_INVALID;
41480cf27aSJed Brown PetscMPIInt Petsc_OuterComm_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 
54e1167bb9SShri Abhyankar /* pthread_key for PetscStack */
55e1167bb9SShri Abhyankar #if defined(PETSC_HAVE_PTHREADCLASSES) && !defined(PETSC_PTHREAD_LOCAL)
56f5dc6901SShri Abhyankar pthread_key_t petscstack;
57e1167bb9SShri Abhyankar #endif
58e1167bb9SShri Abhyankar 
59e5c89e4eSSatish Balay /*
60e5c89e4eSSatish Balay        Checks the options database for initializations related to the
61e5c89e4eSSatish Balay     PETSc components
62e5c89e4eSSatish Balay */
63e5c89e4eSSatish Balay #undef __FUNCT__
64e5c89e4eSSatish Balay #define __FUNCT__ "PetscOptionsCheckInitial_Components"
657087cfbeSBarry Smith PetscErrorCode  PetscOptionsCheckInitial_Components(void)
66e5c89e4eSSatish Balay {
67ace3abfcSBarry Smith   PetscBool      flg1;
68e5c89e4eSSatish Balay   PetscErrorCode ierr;
69e5c89e4eSSatish Balay 
70e5c89e4eSSatish Balay   PetscFunctionBegin;
710298fd71SBarry Smith   ierr = PetscOptionsHasName(NULL,"-help",&flg1);CHKERRQ(ierr);
72e5c89e4eSSatish Balay   if (flg1) {
73e5c89e4eSSatish Balay #if defined(PETSC_USE_LOG)
74e8e7597cSSatish Balay     MPI_Comm comm = PETSC_COMM_WORLD;
75e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm,"------Additional PETSc component options--------\n");CHKERRQ(ierr);
76e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm," -log_summary_exclude: <vec,mat,pc.ksp,snes>\n");CHKERRQ(ierr);
776cf91177SBarry Smith     ierr = (*PetscHelpPrintf)(comm," -info_exclude: <null,vec,mat,pc,ksp,snes,ts>\n");CHKERRQ(ierr);
78e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm,"-----------------------------------------------\n");CHKERRQ(ierr);
79e5c89e4eSSatish Balay #endif
80e5c89e4eSSatish Balay   }
81e5c89e4eSSatish Balay   PetscFunctionReturn(0);
82e5c89e4eSSatish Balay }
83e5c89e4eSSatish Balay 
84e5c89e4eSSatish Balay #undef __FUNCT__
85945d1669SBarry Smith #define __FUNCT__ "PetscInitializeNoPointers"
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 
11472a42c3cSBarry Smith #undef __FUNCT__
115945d1669SBarry Smith #define __FUNCT__ "PetscGetPETSC_COMM_SELF"
116f0865b08SBarry Smith /*
117945d1669SBarry Smith       Used by MATLAB and Julia interface to get communicator
118f0865b08SBarry Smith */
119945d1669SBarry Smith PetscErrorCode  PetscGetPETSC_COMM_SELF(MPI_Comm *comm)
120f0865b08SBarry Smith {
121f0865b08SBarry Smith   PetscFunctionBegin;
122f0865b08SBarry Smith   *comm = PETSC_COMM_SELF;
123f0865b08SBarry Smith   PetscFunctionReturn(0);
124f0865b08SBarry Smith }
125f0865b08SBarry Smith 
126f0865b08SBarry Smith #undef __FUNCT__
127e5c89e4eSSatish Balay #define __FUNCT__ "PetscInitializeNoArguments"
128e5c89e4eSSatish Balay /*@C
129e5c89e4eSSatish Balay       PetscInitializeNoArguments - Calls PetscInitialize() from C/C++ without
130e5c89e4eSSatish Balay         the command line arguments.
131e5c89e4eSSatish Balay 
132e5c89e4eSSatish Balay    Collective
133e5c89e4eSSatish Balay 
134e5c89e4eSSatish Balay    Level: advanced
135e5c89e4eSSatish Balay 
136e5c89e4eSSatish Balay .seealso: PetscInitialize(), PetscInitializeFortran()
137e5c89e4eSSatish Balay @*/
1387087cfbeSBarry Smith PetscErrorCode  PetscInitializeNoArguments(void)
139e5c89e4eSSatish Balay {
140e5c89e4eSSatish Balay   PetscErrorCode ierr;
141e5c89e4eSSatish Balay   int            argc   = 0;
142e5c89e4eSSatish Balay   char           **args = 0;
143e5c89e4eSSatish Balay 
144e5c89e4eSSatish Balay   PetscFunctionBegin;
1450298fd71SBarry Smith   ierr = PetscInitialize(&argc,&args,NULL,NULL);
146e5c89e4eSSatish Balay   PetscFunctionReturn(ierr);
147e5c89e4eSSatish Balay }
148e5c89e4eSSatish Balay 
149e5c89e4eSSatish Balay #undef __FUNCT__
150e5c89e4eSSatish Balay #define __FUNCT__ "PetscInitialized"
151e5c89e4eSSatish Balay /*@
152e5c89e4eSSatish Balay       PetscInitialized - Determine whether PETSc is initialized.
153e5c89e4eSSatish Balay 
1546dc8fec2Sbcordonn 7   Level: beginner
155e5c89e4eSSatish Balay 
156e5c89e4eSSatish Balay .seealso: PetscInitialize(), PetscInitializeNoArguments(), PetscInitializeFortran()
157e5c89e4eSSatish Balay @*/
1587087cfbeSBarry Smith PetscErrorCode  PetscInitialized(PetscBool  *isInitialized)
159e5c89e4eSSatish Balay {
160e5c89e4eSSatish Balay   PetscFunctionBegin;
161e5c89e4eSSatish Balay   PetscValidPointer(isInitialized, 1);
162e5c89e4eSSatish Balay   *isInitialized = PetscInitializeCalled;
163e5c89e4eSSatish Balay   PetscFunctionReturn(0);
164e5c89e4eSSatish Balay }
165e5c89e4eSSatish Balay 
166e5c89e4eSSatish Balay #undef __FUNCT__
167e5c89e4eSSatish Balay #define __FUNCT__ "PetscFinalized"
168e5c89e4eSSatish Balay /*@
169e5c89e4eSSatish Balay       PetscFinalized - Determine whether PetscFinalize() has been called yet
170e5c89e4eSSatish Balay 
171e5c89e4eSSatish Balay    Level: developer
172e5c89e4eSSatish Balay 
173e5c89e4eSSatish Balay .seealso: PetscInitialize(), PetscInitializeNoArguments(), PetscInitializeFortran()
174e5c89e4eSSatish Balay @*/
1757087cfbeSBarry Smith PetscErrorCode  PetscFinalized(PetscBool  *isFinalized)
176e5c89e4eSSatish Balay {
177e5c89e4eSSatish Balay   PetscFunctionBegin;
178e5c89e4eSSatish Balay   PetscValidPointer(isFinalized, 1);
179e5c89e4eSSatish Balay   *isFinalized = PetscFinalizeCalled;
180e5c89e4eSSatish Balay   PetscFunctionReturn(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__
393480cf27aSJed Brown #define __FUNCT__ "Petsc_DelComm"
394480cf27aSJed Brown /*
395ff0e51ddSBarry Smith   This does not actually free anything, it simply marks when a reference count to an internal or external MPI_Comm reaches zero and the
396ff0e51ddSBarry Smith   the external MPI_Comm drops its reference to the internal or external MPI_Comm
397480cf27aSJed Brown 
398ff0e51ddSBarry Smith   This is called by MPI, not by users. This is called when MPI_Comm_free() is called on the communicator.
399480cf27aSJed Brown 
400480cf27aSJed Brown   Note: this is declared extern "C" because it is passed to MPI_Keyval_create()
401480cf27aSJed Brown 
402480cf27aSJed Brown */
4038cc058d9SJed Brown PETSC_EXTERN PetscMPIInt MPIAPI Petsc_DelComm(MPI_Comm comm,PetscMPIInt keyval,void *attr_val,void *extra_state)
404480cf27aSJed Brown {
405480cf27aSJed Brown   PetscErrorCode ierr;
406b89831e5SBarry Smith   PetscMPIInt    flg;
407b89831e5SBarry Smith   MPI_Comm       icomm;
408b89831e5SBarry Smith   void           *ptr;
409480cf27aSJed Brown 
410480cf27aSJed Brown   PetscFunctionBegin;
411b89831e5SBarry Smith   ierr = MPI_Attr_get(comm,Petsc_InnerComm_keyval,&ptr,&flg);CHKERRQ(ierr);
412b89831e5SBarry Smith   if (flg) {
413b89831e5SBarry Smith     /*  Use PetscMemcpy() because casting from pointer to integer of different size is not allowed with some compilers  */
414b89831e5SBarry Smith     ierr = PetscMemcpy(&icomm,&ptr,sizeof(MPI_Comm));CHKERRQ(ierr);
415b89831e5SBarry Smith     ierr = MPI_Attr_get(icomm,Petsc_OuterComm_keyval,&ptr,&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");
417b89831e5SBarry Smith     ierr = MPI_Attr_delete(icomm,Petsc_OuterComm_keyval);CHKERRQ(ierr);
418b3ef52cdSBarry Smith     ierr = PetscInfo1(0,"User MPI_Comm m %ld is being freed, removing reference from inner PETSc comm to this outer comm\n",(long)comm);if (ierr) PetscFunctionReturn((PetscMPIInt)ierr);
419b89831e5SBarry Smith   } else {
420b89831e5SBarry Smith     ierr = PetscInfo1(0,"Removing reference to PETSc communicator imbedded in a user MPI_Comm m %ld\n",(long)comm);if (ierr) PetscFunctionReturn((PetscMPIInt)ierr);
421b89831e5SBarry Smith   }
422480cf27aSJed Brown   PetscFunctionReturn(MPI_SUCCESS);
423480cf27aSJed Brown }
424480cf27aSJed Brown 
425951e3c8eSBarry Smith #if defined(PETSC_USE_PETSC_MPI_EXTERNAL32)
426e39fd77fSBarry Smith #if !defined(PETSC_WORDS_BIGENDIAN)
4278cc058d9SJed Brown PETSC_EXTERN PetscMPIInt PetscDataRep_extent_fn(MPI_Datatype,MPI_Aint*,void*);
4288cc058d9SJed Brown PETSC_EXTERN PetscMPIInt PetscDataRep_read_conv_fn(void*, MPI_Datatype,PetscMPIInt,void*,MPI_Offset,void*);
4298cc058d9SJed Brown PETSC_EXTERN PetscMPIInt PetscDataRep_write_conv_fn(void*, MPI_Datatype,PetscMPIInt,void*,MPI_Offset,void*);
430e39fd77fSBarry Smith #endif
431951e3c8eSBarry Smith #endif
432e39fd77fSBarry Smith 
4336ae9a8a6SBarry Smith int  PetscGlobalArgc   = 0;
4346ae9a8a6SBarry Smith char **PetscGlobalArgs = 0;
435dff31646SBarry Smith PetscSegBuffer PetscCitationsList;
436e5c89e4eSSatish Balay 
437e5c89e4eSSatish Balay #undef __FUNCT__
438*051e4cf2SJed Brown #define __FUNCT__ "PetscCitationsInitialize"
439*051e4cf2SJed Brown PetscErrorCode PetscCitationsInitialize()
440*051e4cf2SJed Brown {
441*051e4cf2SJed Brown   PetscErrorCode ierr;
442*051e4cf2SJed Brown 
443*051e4cf2SJed Brown   PetscFunctionBegin;
444*051e4cf2SJed Brown   ierr = PetscSegBufferCreate(1,10000,&PetscCitationsList);CHKERRQ(ierr);
445*051e4cf2SJed 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);
446*051e4cf2SJed 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);
447*051e4cf2SJed Brown   PetscFunctionReturn(0);
448*051e4cf2SJed Brown }
449*051e4cf2SJed Brown 
450*051e4cf2SJed Brown #undef __FUNCT__
451e5c89e4eSSatish Balay #define __FUNCT__ "PetscGetArgs"
452e5c89e4eSSatish Balay /*@C
453e5c89e4eSSatish Balay    PetscGetArgs - Allows you to access the raw command line arguments anywhere
454e5c89e4eSSatish Balay      after PetscInitialize() is called but before PetscFinalize().
455e5c89e4eSSatish Balay 
456e5c89e4eSSatish Balay    Not Collective
457e5c89e4eSSatish Balay 
458e5c89e4eSSatish Balay    Output Parameters:
459e5c89e4eSSatish Balay +  argc - count of number of command line arguments
460e5c89e4eSSatish Balay -  args - the command line arguments
461e5c89e4eSSatish Balay 
462e5c89e4eSSatish Balay    Level: intermediate
463e5c89e4eSSatish Balay 
464e5c89e4eSSatish Balay    Notes:
465e5c89e4eSSatish Balay       This is usually used to pass the command line arguments into other libraries
466e5c89e4eSSatish Balay    that are called internally deep in PETSc or the application.
467e5c89e4eSSatish Balay 
468f177e3b1SBarry Smith       The first argument contains the program name as is normal for C arguments.
469f177e3b1SBarry Smith 
470e5c89e4eSSatish Balay    Concepts: command line arguments
471e5c89e4eSSatish Balay 
472793721a6SBarry Smith .seealso: PetscFinalize(), PetscInitializeFortran(), PetscGetArguments()
473e5c89e4eSSatish Balay 
474e5c89e4eSSatish Balay @*/
4757087cfbeSBarry Smith PetscErrorCode  PetscGetArgs(int *argc,char ***args)
476e5c89e4eSSatish Balay {
477e5c89e4eSSatish Balay   PetscFunctionBegin;
47817186662SBarry Smith   if (!PetscInitializeCalled && PetscFinalizeCalled) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ORDER,"You must call after PetscInitialize() but before PetscFinalize()");
479e5c89e4eSSatish Balay   *argc = PetscGlobalArgc;
480e5c89e4eSSatish Balay   *args = PetscGlobalArgs;
481e5c89e4eSSatish Balay   PetscFunctionReturn(0);
482e5c89e4eSSatish Balay }
483e5c89e4eSSatish Balay 
484e5c89e4eSSatish Balay #undef __FUNCT__
485793721a6SBarry Smith #define __FUNCT__ "PetscGetArguments"
486793721a6SBarry Smith /*@C
487793721a6SBarry Smith    PetscGetArguments - Allows you to access the  command line arguments anywhere
488793721a6SBarry Smith      after PetscInitialize() is called but before PetscFinalize().
489793721a6SBarry Smith 
490793721a6SBarry Smith    Not Collective
491793721a6SBarry Smith 
492793721a6SBarry Smith    Output Parameters:
493793721a6SBarry Smith .  args - the command line arguments
494793721a6SBarry Smith 
495793721a6SBarry Smith    Level: intermediate
496793721a6SBarry Smith 
497793721a6SBarry Smith    Notes:
498793721a6SBarry Smith       This does NOT start with the program name and IS null terminated (final arg is void)
499793721a6SBarry Smith 
500793721a6SBarry Smith    Concepts: command line arguments
501793721a6SBarry Smith 
502793721a6SBarry Smith .seealso: PetscFinalize(), PetscInitializeFortran(), PetscGetArgs(), PetscFreeArguments()
503793721a6SBarry Smith 
504793721a6SBarry Smith @*/
5057087cfbeSBarry Smith PetscErrorCode  PetscGetArguments(char ***args)
506793721a6SBarry Smith {
507793721a6SBarry Smith   PetscInt       i,argc = PetscGlobalArgc;
508793721a6SBarry Smith   PetscErrorCode ierr;
509793721a6SBarry Smith 
510793721a6SBarry Smith   PetscFunctionBegin;
51117186662SBarry Smith   if (!PetscInitializeCalled && PetscFinalizeCalled) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ORDER,"You must call after PetscInitialize() but before PetscFinalize()");
512717030eeSLisandro Dalcin   if (!argc) {*args = 0; PetscFunctionReturn(0);}
513793721a6SBarry Smith   ierr = PetscMalloc(argc*sizeof(char*),args);CHKERRQ(ierr);
514793721a6SBarry Smith   for (i=0; i<argc-1; i++) {
515793721a6SBarry Smith     ierr = PetscStrallocpy(PetscGlobalArgs[i+1],&(*args)[i]);CHKERRQ(ierr);
516793721a6SBarry Smith   }
517793721a6SBarry Smith   (*args)[argc-1] = 0;
518793721a6SBarry Smith   PetscFunctionReturn(0);
519793721a6SBarry Smith }
520793721a6SBarry Smith 
521793721a6SBarry Smith #undef __FUNCT__
522793721a6SBarry Smith #define __FUNCT__ "PetscFreeArguments"
523793721a6SBarry Smith /*@C
524793721a6SBarry Smith    PetscFreeArguments - Frees the memory obtained with PetscGetArguments()
525793721a6SBarry Smith 
526793721a6SBarry Smith    Not Collective
527793721a6SBarry Smith 
528793721a6SBarry Smith    Output Parameters:
529793721a6SBarry Smith .  args - the command line arguments
530793721a6SBarry Smith 
531793721a6SBarry Smith    Level: intermediate
532793721a6SBarry Smith 
533793721a6SBarry Smith    Concepts: command line arguments
534793721a6SBarry Smith 
535793721a6SBarry Smith .seealso: PetscFinalize(), PetscInitializeFortran(), PetscGetArgs(), PetscGetArguments()
536793721a6SBarry Smith 
537793721a6SBarry Smith @*/
5387087cfbeSBarry Smith PetscErrorCode  PetscFreeArguments(char **args)
539793721a6SBarry Smith {
540793721a6SBarry Smith   PetscInt       i = 0;
541793721a6SBarry Smith   PetscErrorCode ierr;
542793721a6SBarry Smith 
543793721a6SBarry Smith   PetscFunctionBegin;
544a297a907SKarl Rupp   if (!args) PetscFunctionReturn(0);
545793721a6SBarry Smith   while (args[i]) {
546793721a6SBarry Smith     ierr = PetscFree(args[i]);CHKERRQ(ierr);
547793721a6SBarry Smith     i++;
548793721a6SBarry Smith   }
549793721a6SBarry Smith   ierr = PetscFree(args);CHKERRQ(ierr);
550793721a6SBarry Smith   PetscFunctionReturn(0);
551793721a6SBarry Smith }
552793721a6SBarry Smith 
553793721a6SBarry Smith #undef __FUNCT__
554e5c89e4eSSatish Balay #define __FUNCT__ "PetscInitialize"
555e5c89e4eSSatish Balay /*@C
556e5c89e4eSSatish Balay    PetscInitialize - Initializes the PETSc database and MPI.
557e5c89e4eSSatish Balay    PetscInitialize() calls MPI_Init() if that has yet to be called,
558e5c89e4eSSatish Balay    so this routine should always be called near the beginning of
559e5c89e4eSSatish Balay    your program -- usually the very first line!
560e5c89e4eSSatish Balay 
561e5c89e4eSSatish Balay    Collective on MPI_COMM_WORLD or PETSC_COMM_WORLD if it has been set
562e5c89e4eSSatish Balay 
563e5c89e4eSSatish Balay    Input Parameters:
564e5c89e4eSSatish Balay +  argc - count of number of command line arguments
565e5c89e4eSSatish Balay .  args - the command line arguments
5660298fd71SBarry Smith .  file - [optional] PETSc database file, also checks ~username/.petscrc and .petscrc use NULL to not check for
567fc2bca9aSBarry Smith           code specific file. Use -skip_petscrc in the code specific file to skip the .petscrc files
5680298fd71SBarry Smith -  help - [optional] Help message to print, use NULL for no message
569e5c89e4eSSatish Balay 
57005827820SBarry Smith    If you wish PETSc code to run ONLY on a subcommunicator of MPI_COMM_WORLD, create that
57105827820SBarry Smith    communicator first and assign it to PETSC_COMM_WORLD BEFORE calling PetscInitialize(). Thus if you are running a
57205827820SBarry Smith    four process job and two processes will run PETSc and have PetscInitialize() and PetscFinalize() and two process will not,
57305827820SBarry Smith    then do this. If ALL processes in the job are using PetscInitialize() and PetscFinalize() then you don't need to do this, even
57405827820SBarry Smith    if different subcommunicators of the job are doing different things with PETSc.
575e5c89e4eSSatish Balay 
576e5c89e4eSSatish Balay    Options Database Keys:
577e5c89e4eSSatish Balay +  -start_in_debugger [noxterm,dbx,xdb,gdb,...] - Starts program in debugger
578e5c89e4eSSatish Balay .  -on_error_attach_debugger [noxterm,dbx,xdb,gdb,...] - Starts debugger when error detected
579e5c89e4eSSatish Balay .  -on_error_emacs <machinename> causes emacsclient to jump to error file
580b52f573bSBarry Smith .  -on_error_abort calls abort() when error detected (no traceback)
581e8fb0fc0SBarry Smith .  -on_error_mpiabort calls MPI_abort() when error detected
582e8fb0fc0SBarry Smith .  -error_output_stderr prints error messages to stderr instead of the default stdout
583e8fb0fc0SBarry Smith .  -error_output_none does not print the error messages (but handles errors in the same way as if this was not called)
584e5c89e4eSSatish Balay .  -debugger_nodes [node1,node2,...] - Indicates nodes to start in debugger
585e5c89e4eSSatish Balay .  -debugger_pause [sleeptime] (in seconds) - Pauses debugger
586e5c89e4eSSatish Balay .  -stop_for_debugger - Print message on how to attach debugger manually to
587e5c89e4eSSatish Balay                         process and wait (-debugger_pause) seconds for attachment
5882fb0ec9aSBarry Smith .  -malloc - Indicates use of PETSc error-checking malloc (on by default for debug version of libraries)
589e5c89e4eSSatish Balay .  -malloc no - Indicates not to use error-checking malloc
5902fb0ec9aSBarry Smith .  -malloc_debug - check for memory corruption at EVERY malloc or free
591dc92acbaSJed Brown .  -malloc_test - like -malloc_dump -malloc_debug, but only active for debugging builds
592e5c89e4eSSatish Balay .  -fp_trap - Stops on floating point exceptions (Note that on the
593e5c89e4eSSatish Balay               IBM RS6000 this slows code by at least a factor of 10.)
594e5c89e4eSSatish Balay .  -no_signal_handler - Indicates not to trap error signals
595e5c89e4eSSatish Balay .  -shared_tmp - indicates /tmp directory is shared by all processors
596e5c89e4eSSatish Balay .  -not_shared_tmp - each processor has own /tmp
597e5c89e4eSSatish Balay .  -tmp - alternative name of /tmp directory
598e5c89e4eSSatish Balay .  -get_total_flops - returns total flops done by all processors
59940ab9619SBarry Smith .  -memory_info - Print memory usage at end of run
60040ab9619SBarry Smith -  -server <port> - start PETSc webserver (default port is 8080)
601e5c89e4eSSatish Balay 
602e5c89e4eSSatish Balay    Options Database Keys for Profiling:
6030598bfebSBarry Smith    See the <a href="../../docs/manual.pdf#nameddest=ch_profiling">profiling chapter of the users manual</a> for details.
604495fc317SBarry Smith +  -info <optional filename> - Prints verbose information to the screen
605495fc317SBarry Smith .  -info_exclude <null,vec,mat,pc,ksp,snes,ts> - Excludes some of the verbose messages
606495fc317SBarry Smith .  -log_sync - Log the synchronization in scatters, inner products and norms
607495fc317SBarry Smith .  -log_trace [filename] - Print traces of all PETSc calls to the screen (useful to determine where a program
608e5c89e4eSSatish Balay         hangs without running in the debugger).  See PetscLogTraceBegin().
609495fc317SBarry Smith .  -log_summary [filename] - Prints summary of flop and timing information to screen. If the filename is specified the
610495fc317SBarry Smith         summary is written to the file.  See PetscLogView().
611495fc317SBarry Smith .  -log_summary_python [filename] - Prints data on of flop and timing usage to a file or screen. See PetscLogPrintSViewPython().
612495fc317SBarry Smith .  -log_all [filename] - Logs extensive profiling information  See PetscLogDump().
613495fc317SBarry Smith .  -log [filename] - Logs basic profiline information  See PetscLogDump().
614495fc317SBarry Smith -  -log_mpe [filename] - Creates a logfile viewable by the utility Jumpshot (in MPICH distribution)
615495fc317SBarry Smith 
616495fc317SBarry Smith     Only one of -log_trace, -log_summary, -log_all, -log, or -log_mpe may be used at a time
617e5c89e4eSSatish Balay 
618e5c89e4eSSatish Balay    Environmental Variables:
619e5c89e4eSSatish Balay +   PETSC_TMP - alternative tmp directory
620e5c89e4eSSatish Balay .   PETSC_SHARED_TMP - tmp is shared by all processes
621e5c89e4eSSatish Balay .   PETSC_NOT_SHARED_TMP - each process has its own private tmp
622e5c89e4eSSatish Balay .   PETSC_VIEWER_SOCKET_PORT - socket number to use for socket viewer
623e5c89e4eSSatish Balay -   PETSC_VIEWER_SOCKET_MACHINE - machine to use for socket viewer to connect to
624e5c89e4eSSatish Balay 
625e5c89e4eSSatish Balay 
626e5c89e4eSSatish Balay    Level: beginner
627e5c89e4eSSatish Balay 
628e5c89e4eSSatish Balay    Notes:
629e5c89e4eSSatish Balay    If for some reason you must call MPI_Init() separately, call
630e5c89e4eSSatish Balay    it before PetscInitialize().
631e5c89e4eSSatish Balay 
632e5c89e4eSSatish Balay    Fortran Version:
633e5c89e4eSSatish Balay    In Fortran this routine has the format
634e5c89e4eSSatish Balay $       call PetscInitialize(file,ierr)
635e5c89e4eSSatish Balay 
636e5c89e4eSSatish Balay +   ierr - error return code
6370298fd71SBarry Smith -  file - [optional] PETSc database file, also checks ~username/.petscrc and .petscrc use NULL_CHARACTER to not check for
638fc2bca9aSBarry Smith           code specific file. Use -skip_petscrc in the code specific file to skip the .petscrc files
639e5c89e4eSSatish Balay 
640e5c89e4eSSatish Balay    Important Fortran Note:
6410298fd71SBarry Smith    In Fortran, you MUST use NULL_CHARACTER to indicate a
6420298fd71SBarry Smith    null character string; you CANNOT just use NULL as
6430598bfebSBarry Smith    in the C version. See the <a href="../../docs/manual.pdf">users manual</a> for details.
644e5c89e4eSSatish Balay 
64501cb0274SBarry Smith    If your main program is C but you call Fortran code that also uses PETSc you need to call PetscInitializeFortran() soon after
64601cb0274SBarry Smith    calling PetscInitialize().
647e5c89e4eSSatish Balay 
648e5c89e4eSSatish Balay    Concepts: initializing PETSc
649e5c89e4eSSatish Balay 
65001cb0274SBarry Smith .seealso: PetscFinalize(), PetscInitializeFortran(), PetscGetArgs(), PetscInitializeNoArguments()
651e5c89e4eSSatish Balay 
652e5c89e4eSSatish Balay @*/
6537087cfbeSBarry Smith PetscErrorCode  PetscInitialize(int *argc,char ***args,const char file[],const char help[])
654e5c89e4eSSatish Balay {
655e5c89e4eSSatish Balay   PetscErrorCode ierr;
6564bb5149bSJed Brown   PetscMPIInt    flag, size;
657aa5bb8c0SSatish Balay   PetscInt       nodesize;
658ace3abfcSBarry Smith   PetscBool      flg;
659e5c89e4eSSatish Balay   char           hostname[256];
660e5c89e4eSSatish Balay 
661e5c89e4eSSatish Balay   PetscFunctionBegin;
662e5c89e4eSSatish Balay   if (PetscInitializeCalled) PetscFunctionReturn(0);
663e5c89e4eSSatish Balay 
664ae9b4142SLisandro Dalcin   /* these must be initialized in a routine, not as a constant declaration*/
665d89683f4Sbcordonn   PETSC_STDOUT = stdout;
666ae9b4142SLisandro Dalcin   PETSC_STDERR = stderr;
667e5c89e4eSSatish Balay 
668e5c89e4eSSatish Balay   ierr = PetscOptionsCreate();CHKERRQ(ierr);
669e5c89e4eSSatish Balay 
670e5c89e4eSSatish Balay   /*
671e5c89e4eSSatish Balay      We initialize the program name here (before MPI_Init()) because MPICH has a bug in
672e5c89e4eSSatish Balay      it that it sets args[0] on all processors to be args[0] on the first processor.
673e5c89e4eSSatish Balay   */
674e5c89e4eSSatish Balay   if (argc && *argc) {
675e5c89e4eSSatish Balay     ierr = PetscSetProgramName(**args);CHKERRQ(ierr);
676e5c89e4eSSatish Balay   } else {
677e5c89e4eSSatish Balay     ierr = PetscSetProgramName("Unknown Name");CHKERRQ(ierr);
678e5c89e4eSSatish Balay   }
679e5c89e4eSSatish Balay 
680e5c89e4eSSatish Balay   ierr = MPI_Initialized(&flag);CHKERRQ(ierr);
681e5c89e4eSSatish Balay   if (!flag) {
682e32f2f54SBarry 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");
6835e765c61SJed Brown #if defined(PETSC_HAVE_MPI_INIT_THREAD)
6845e765c61SJed Brown     {
6855e765c61SJed Brown       PetscMPIInt provided;
6865e765c61SJed Brown       ierr = MPI_Init_thread(argc,args,MPI_THREAD_FUNNELED,&provided);CHKERRQ(ierr);
6875e765c61SJed Brown     }
6885e765c61SJed Brown #else
689e5c89e4eSSatish Balay     ierr = MPI_Init(argc,args);CHKERRQ(ierr);
6905e765c61SJed Brown #endif
691e5c89e4eSSatish Balay     PetscBeganMPI = PETSC_TRUE;
692e5c89e4eSSatish Balay   }
693e5c89e4eSSatish Balay   if (argc && args) {
694e5c89e4eSSatish Balay     PetscGlobalArgc = *argc;
695e5c89e4eSSatish Balay     PetscGlobalArgs = *args;
696e5c89e4eSSatish Balay   }
697e5c89e4eSSatish Balay   PetscFinalizeCalled = PETSC_FALSE;
698e5c89e4eSSatish Balay 
699a297a907SKarl Rupp   if (PETSC_COMM_WORLD == MPI_COMM_NULL) PETSC_COMM_WORLD = MPI_COMM_WORLD;
700d54338ecSKarl Rupp   ierr = MPI_Comm_set_errhandler(PETSC_COMM_WORLD,MPI_ERRORS_RETURN);CHKERRQ(ierr);
701e5c89e4eSSatish Balay 
702e5c89e4eSSatish Balay   /* Done after init due to a bug in MPICH-GM? */
703e5c89e4eSSatish Balay   ierr = PetscErrorPrintfInitialize();CHKERRQ(ierr);
704e5c89e4eSSatish Balay 
705e5c89e4eSSatish Balay   ierr = MPI_Comm_rank(MPI_COMM_WORLD,&PetscGlobalRank);CHKERRQ(ierr);
706e5c89e4eSSatish Balay   ierr = MPI_Comm_size(MPI_COMM_WORLD,&PetscGlobalSize);CHKERRQ(ierr);
707e5c89e4eSSatish Balay 
7088ad47952SJed Brown   MPIU_BOOL = MPI_INT;
7098ad47952SJed Brown   MPIU_ENUM = MPI_INT;
7108ad47952SJed Brown 
711e5c89e4eSSatish Balay   /*
712e5c89e4eSSatish Balay      Initialized the global complex variable; this is because with
713e5c89e4eSSatish Balay      shared libraries the constructors for global variables
714e5c89e4eSSatish Balay      are not called; at least on IRIX.
715e5c89e4eSSatish Balay   */
716886cfec0SSatish Balay #if defined(PETSC_HAVE_COMPLEX)
717e5c89e4eSSatish Balay   {
718a24ee22aSSatish Balay #if defined(PETSC_CLANGUAGE_CXX)
71950f81f78SJed Brown     PetscComplex ic(0.0,1.0);
720e5c89e4eSSatish Balay     PETSC_i = ic;
721a24ee22aSSatish Balay #elif defined(PETSC_CLANGUAGE_C)
72250f81f78SJed Brown     PETSC_i = _Complex_I;
723b7940d39SSatish Balay #endif
724762437b8SSatish Balay   }
725762437b8SSatish Balay 
7262c876bd9SBarry Smith #if !defined(PETSC_HAVE_MPI_C_DOUBLE_COMPLEX)
727e69cd0e6SSatish Balay   ierr = MPI_Type_contiguous(2,MPI_DOUBLE,&MPIU_C_DOUBLE_COMPLEX);CHKERRQ(ierr);
728500d8756SSatish Balay   ierr = MPI_Type_commit(&MPIU_C_DOUBLE_COMPLEX);CHKERRQ(ierr);
729500d8756SSatish Balay   ierr = MPI_Type_contiguous(2,MPI_FLOAT,&MPIU_C_COMPLEX);CHKERRQ(ierr);
730500d8756SSatish Balay   ierr = MPI_Type_commit(&MPIU_C_COMPLEX);CHKERRQ(ierr);
7312c876bd9SBarry Smith #endif
732886cfec0SSatish Balay #endif /* PETSC_HAVE_COMPLEX */
733e5c89e4eSSatish Balay 
734e5c89e4eSSatish Balay   /*
735e5c89e4eSSatish Balay      Create the PETSc MPI reduction operator that sums of the first
736e5c89e4eSSatish Balay      half of the entries and maxes the second half.
737e5c89e4eSSatish Balay   */
738e5c89e4eSSatish Balay   ierr = MPI_Op_create(PetscMaxSum_Local,1,&PetscMaxSum_Op);CHKERRQ(ierr);
739e5c89e4eSSatish Balay 
740ce63c4c1SBarry Smith #if defined(PETSC_USE_REAL___FLOAT128)
741c90a1750SBarry Smith   ierr = MPI_Type_contiguous(2,MPI_DOUBLE,&MPIU___FLOAT128);CHKERRQ(ierr);
742c90a1750SBarry Smith   ierr = MPI_Type_commit(&MPIU___FLOAT128);CHKERRQ(ierr);
7437c2de775SJed Brown #if defined(PETSC_HAVE_COMPLEX)
7448c764dc5SJose Roman   ierr = MPI_Type_contiguous(4,MPI_DOUBLE,&MPIU___COMPLEX128);CHKERRQ(ierr);
7458c764dc5SJose Roman   ierr = MPI_Type_commit(&MPIU___COMPLEX128);CHKERRQ(ierr);
7468c764dc5SJose Roman #endif
747d9822059SBarry Smith   ierr = MPI_Op_create(PetscMax_Local,1,&MPIU_MAX);CHKERRQ(ierr);
748d9822059SBarry Smith   ierr = MPI_Op_create(PetscMin_Local,1,&MPIU_MIN);CHKERRQ(ierr);
749c90a1750SBarry Smith #endif
750c90a1750SBarry Smith 
7517c2de775SJed Brown #if (defined(PETSC_HAVE_COMPLEX) && !defined(PETSC_HAVE_MPI_C_DOUBLE_COMPLEX)) || defined(PETSC_USE_REAL___FLOAT128)
752cca4cb22SSatish Balay   ierr = MPI_Op_create(PetscSum_Local,1,&MPIU_SUM);CHKERRQ(ierr);
753cca4cb22SSatish Balay #endif
754cca4cb22SSatish Balay 
755e5c89e4eSSatish Balay   ierr = MPI_Type_contiguous(2,MPIU_SCALAR,&MPIU_2SCALAR);CHKERRQ(ierr);
756e5c89e4eSSatish Balay   ierr = MPI_Type_commit(&MPIU_2SCALAR);CHKERRQ(ierr);
757e5c89e4eSSatish Balay   ierr = MPI_Op_create(PetscADMax_Local,1,&PetscADMax_Op);CHKERRQ(ierr);
758e5c89e4eSSatish Balay   ierr = MPI_Op_create(PetscADMin_Local,1,&PetscADMin_Op);CHKERRQ(ierr);
759e5c89e4eSSatish Balay 
76044041f26SJed Brown #if defined(PETSC_USE_64BIT_INDICES) || !defined(MPI_2INT)
761e5c89e4eSSatish Balay   ierr = MPI_Type_contiguous(2,MPIU_INT,&MPIU_2INT);CHKERRQ(ierr);
762e5c89e4eSSatish Balay   ierr = MPI_Type_commit(&MPIU_2INT);CHKERRQ(ierr);
76344041f26SJed Brown #endif
764e5c89e4eSSatish Balay 
765e5c89e4eSSatish Balay   /*
766480cf27aSJed Brown      Attributes to be set on PETSc communicators
767480cf27aSJed Brown   */
768480cf27aSJed Brown   ierr = MPI_Keyval_create(MPI_NULL_COPY_FN,Petsc_DelCounter,&Petsc_Counter_keyval,(void*)0);CHKERRQ(ierr);
769480cf27aSJed Brown   ierr = MPI_Keyval_create(MPI_NULL_COPY_FN,Petsc_DelComm,&Petsc_InnerComm_keyval,(void*)0);CHKERRQ(ierr);
770480cf27aSJed Brown   ierr = MPI_Keyval_create(MPI_NULL_COPY_FN,Petsc_DelComm,&Petsc_OuterComm_keyval,(void*)0);CHKERRQ(ierr);
771480cf27aSJed Brown 
772480cf27aSJed Brown   /*
773e8fb0fc0SBarry Smith      Build the options database
774e5c89e4eSSatish Balay   */
775e5c89e4eSSatish Balay   ierr = PetscOptionsInsert(argc,args,file);CHKERRQ(ierr);
776e5c89e4eSSatish Balay 
7776dc8fec2Sbcordonn 
778e5c89e4eSSatish Balay   /*
779e5c89e4eSSatish Balay      Print main application help message
780e5c89e4eSSatish Balay   */
7810298fd71SBarry Smith   ierr = PetscOptionsHasName(NULL,"-help",&flg);CHKERRQ(ierr);
782e5c89e4eSSatish Balay   if (help && flg) {
783e5c89e4eSSatish Balay     ierr = PetscPrintf(PETSC_COMM_WORLD,help);CHKERRQ(ierr);
784e5c89e4eSSatish Balay   }
785e5c89e4eSSatish Balay   ierr = PetscOptionsCheckInitial_Private();CHKERRQ(ierr);
786e5c89e4eSSatish Balay 
787e5c89e4eSSatish Balay   /* SHOULD PUT IN GUARDS: Make sure logging is initialized, even if we do not print it out */
788a9f03627SSatish Balay #if defined(PETSC_USE_LOG)
789e5c89e4eSSatish Balay   ierr = PetscLogBegin_Private();CHKERRQ(ierr);
790a9f03627SSatish Balay #endif
791e5c89e4eSSatish Balay 
792e5c89e4eSSatish Balay   /*
793e5c89e4eSSatish Balay      Load the dynamic libraries (on machines that support them), this registers all
794e5c89e4eSSatish Balay      the solvers etc. (On non-dynamic machines this initializes the PetscDraw and PetscViewer classes)
795e5c89e4eSSatish Balay   */
796e5c89e4eSSatish Balay   ierr = PetscInitialize_DynamicLibraries();CHKERRQ(ierr);
797e5c89e4eSSatish Balay 
798e5c89e4eSSatish Balay   ierr = MPI_Comm_size(PETSC_COMM_WORLD,&size);CHKERRQ(ierr);
799ae15b995SBarry Smith   ierr = PetscInfo1(0,"PETSc successfully started: number of processors = %d\n",size);CHKERRQ(ierr);
800e5c89e4eSSatish Balay   ierr = PetscGetHostName(hostname,256);CHKERRQ(ierr);
801ae15b995SBarry Smith   ierr = PetscInfo1(0,"Running on machine: %s\n",hostname);CHKERRQ(ierr);
802e5c89e4eSSatish Balay 
803e5c89e4eSSatish Balay   ierr = PetscOptionsCheckInitial_Components();CHKERRQ(ierr);
804ef6c6fedSBoyana Norris   /* Check the options database for options related to the options database itself */
805ef6c6fedSBoyana Norris   ierr = PetscOptionsSetFromOptions();CHKERRQ(ierr);
806ef6c6fedSBoyana Norris 
807951e3c8eSBarry Smith #if defined(PETSC_USE_PETSC_MPI_EXTERNAL32)
808e39fd77fSBarry Smith   /*
809e39fd77fSBarry Smith       Tell MPI about our own data representation converter, this would/should be used if extern32 is not supported by the MPI
810e39fd77fSBarry Smith 
811e39fd77fSBarry Smith       Currently not used because it is not supported by MPICH.
812e39fd77fSBarry Smith   */
813e39fd77fSBarry Smith #if !defined(PETSC_WORDS_BIGENDIAN)
8140298fd71SBarry Smith   ierr = MPI_Register_datarep((char*)"petsc",PetscDataRep_read_conv_fn,PetscDataRep_write_conv_fn,PetscDataRep_extent_fn,NULL);CHKERRQ(ierr);
815e39fd77fSBarry Smith #endif
816951e3c8eSBarry Smith #endif
817e39fd77fSBarry Smith 
8180298fd71SBarry Smith   ierr = PetscOptionsGetInt(NULL,"-hmpi_spawn_size",&nodesize,&flg);CHKERRQ(ierr);
819793721a6SBarry Smith   if (flg) {
82023464e94SBarry Smith #if defined(PETSC_HAVE_MPI_COMM_SPAWN)
82185afcc9aSBarry Smith     ierr = PetscHMPISpawn((PetscMPIInt) nodesize);CHKERRQ(ierr); /* worker nodes never return from here; they go directly to PetscEnd() */
82223464e94SBarry Smith #else
82385afcc9aSBarry Smith     SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SUP,"PETSc built without MPI 2 (MPI_Comm_spawn) support, use -hmpi_merge_size instead");
82423464e94SBarry Smith #endif
825793721a6SBarry Smith   } else {
8260298fd71SBarry Smith     ierr = PetscOptionsGetInt(NULL,"-hmpi_merge_size",&nodesize,&flg);CHKERRQ(ierr);
8278002f1cdSBarry Smith     if (flg) {
8280298fd71SBarry Smith       ierr = PetscHMPIMerge((PetscMPIInt) nodesize,NULL,NULL);CHKERRQ(ierr);
82985afcc9aSBarry Smith       if (PetscHMPIWorker) { /* if worker then never enter user code */
830bad7cb1dSBarry Smith         PetscInitializeCalled = PETSC_TRUE;
8313bf036e2SBarry Smith         PetscEnd();
8329505b675SBarry Smith       }
8338002f1cdSBarry Smith     }
834793721a6SBarry Smith   }
835e5c89e4eSSatish Balay 
83635d88935SVictor Minden #if defined(PETSC_HAVE_CUDA)
8374bb5149bSJed Brown   {
8384bb5149bSJed Brown     PetscMPIInt p;
839663ba86aSMatthew G Knepley     for (p = 0; p < PetscGlobalSize; ++p) {
840a297a907SKarl Rupp       if (p == PetscGlobalRank) cublasInit();
841663ba86aSMatthew G Knepley       ierr = MPI_Barrier(PETSC_COMM_WORLD);CHKERRQ(ierr);
842663ba86aSMatthew G Knepley     }
8434bb5149bSJed Brown   }
8443e39abd9SVictor Minden #endif
84592e62aa6SBarry Smith 
8460298fd71SBarry Smith   ierr = PetscOptionsHasName(NULL,"-python",&flg);CHKERRQ(ierr);
8479ac80d5eSLisandro Dalcin   if (flg) {
8489ac80d5eSLisandro Dalcin     PetscInitializeCalled = PETSC_TRUE;
8490298fd71SBarry Smith     ierr = PetscPythonInitialize(NULL,NULL);CHKERRQ(ierr);
8509ac80d5eSLisandro Dalcin   }
8519ac80d5eSLisandro Dalcin 
852607a6623SBarry Smith   ierr = PetscThreadCommInitializePackage();CHKERRQ(ierr);
853bd8b14e7SShri Abhyankar 
85441c0b4b3SShri Abhyankar   /*
85541c0b4b3SShri Abhyankar       Setup building of stack frames for all function calls
85641c0b4b3SShri Abhyankar   */
857e1167bb9SShri Abhyankar #if defined(PETSC_USE_DEBUG)
858047240e1SBarry Smith   PetscThreadLocalRegister((PetscThreadKey*)&petscstack); /* Creates petscstack_key if needed */
859e1167bb9SShri Abhyankar   ierr = PetscStackCreate();CHKERRQ(ierr);
860e1167bb9SShri Abhyankar #endif
861e1167bb9SShri Abhyankar 
8622d53ad75SBarry Smith #if defined(PETSC_SERIALIZE_FUNCTIONS)
8632d53ad75SBarry Smith   ierr = PetscFPTCreate(10000);CHKERRQ(ierr);
8642d53ad75SBarry Smith #endif
8652d53ad75SBarry Smith 
866*051e4cf2SJed Brown   ierr = PetscCitationsInitialize();CHKERRQ(ierr);
867dff31646SBarry Smith 
868301d30feSBarry Smith   /*
869301d30feSBarry Smith       Once we are completedly initialized then we can set this variables
870301d30feSBarry Smith   */
871301d30feSBarry Smith   PetscInitializeCalled = PETSC_TRUE;
872301d30feSBarry Smith   PetscFunctionReturn(0);
873e5c89e4eSSatish Balay }
874e5c89e4eSSatish Balay 
8752eff7a51SBarry Smith extern PetscObject *PetscObjects;
8762eff7a51SBarry Smith extern PetscInt    PetscObjectsCounts, PetscObjectsMaxCounts;
877e5c89e4eSSatish Balay 
878e5c89e4eSSatish Balay #undef __FUNCT__
879e5c89e4eSSatish Balay #define __FUNCT__ "PetscFinalize"
880e5c89e4eSSatish Balay /*@C
881e5c89e4eSSatish Balay    PetscFinalize - Checks for options to be called at the conclusion
882e5c89e4eSSatish Balay    of the program. MPI_Finalize() is called only if the user had not
883e5c89e4eSSatish Balay    called MPI_Init() before calling PetscInitialize().
884e5c89e4eSSatish Balay 
885e5c89e4eSSatish Balay    Collective on PETSC_COMM_WORLD
886e5c89e4eSSatish Balay 
887e5c89e4eSSatish Balay    Options Database Keys:
88888c29154SBarry Smith +  -options_table - Calls PetscOptionsView()
889e5c89e4eSSatish Balay .  -options_left - Prints unused options that remain in the database
8907eb1d149SBarry 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
891e5c89e4eSSatish Balay .  -mpidump - Calls PetscMPIDump()
892e5c89e4eSSatish Balay .  -malloc_dump - Calls PetscMallocDump()
893e5c89e4eSSatish Balay .  -malloc_info - Prints total memory usage
894e5c89e4eSSatish Balay -  -malloc_log - Prints summary of memory usage
895e5c89e4eSSatish Balay 
896e5c89e4eSSatish Balay    Level: beginner
897e5c89e4eSSatish Balay 
898e5c89e4eSSatish Balay    Note:
899e5c89e4eSSatish Balay    See PetscInitialize() for more general runtime options.
900e5c89e4eSSatish Balay 
90188c29154SBarry Smith .seealso: PetscInitialize(), PetscOptionsView(), PetscMallocDump(), PetscMPIDump(), PetscEnd()
902e5c89e4eSSatish Balay @*/
9037087cfbeSBarry Smith PetscErrorCode  PetscFinalize(void)
904e5c89e4eSSatish Balay {
905e5c89e4eSSatish Balay   PetscErrorCode ierr;
9064bb5149bSJed Brown   PetscMPIInt    rank;
907a8d2bbe5SBarry Smith   PetscInt       nopt;
9082bf49c77SBarry Smith   PetscBool      flg1 = PETSC_FALSE,flg2 = PETSC_FALSE,flg3 = PETSC_FALSE;
909dff31646SBarry Smith   PetscBool      flg;
91010463e74SBarry Smith #if defined(PETSC_USE_LOG)
91110463e74SBarry Smith   char           mname[PETSC_MAX_PATH_LEN];
91210463e74SBarry Smith #endif
913e5c89e4eSSatish Balay 
914e5c89e4eSSatish Balay   PetscFunctionBegin;
915e5c89e4eSSatish Balay   if (!PetscInitializeCalled) {
9164b09e917SBarry Smith     printf("PetscInitialize() must be called before PetscFinalize()\n");
9174b09e917SBarry Smith     PetscFunctionReturn(PETSC_ERR_ARG_WRONGSTATE);
918e5c89e4eSSatish Balay   }
9190298fd71SBarry Smith   ierr = PetscInfo(NULL,"PetscFinalize() called\n");CHKERRQ(ierr);
920b022a5c1SBarry Smith 
9211f817a21SBarry Smith   ierr = MPI_Comm_rank(PETSC_COMM_WORLD,&rank);CHKERRQ(ierr);
9221f817a21SBarry Smith 
9231f817a21SBarry Smith   ierr = PetscOptionsHasName(NULL,"-citations",&flg);CHKERRQ(ierr);
924dff31646SBarry Smith   if (flg) {
9251f817a21SBarry Smith     char  *cits, filename[PETSC_MAX_PATH_LEN];
9261f817a21SBarry Smith     FILE  *fd = PETSC_STDOUT;
9271f817a21SBarry Smith 
9281f817a21SBarry Smith     ierr = PetscOptionsGetString(NULL,"-citations",filename,PETSC_MAX_PATH_LEN,NULL);CHKERRQ(ierr);
9291f817a21SBarry Smith     if (filename[0]) {
9301f817a21SBarry Smith       ierr = PetscFOpen(PETSC_COMM_WORLD,filename,"w",&fd);CHKERRQ(ierr);
9311f817a21SBarry Smith     }
932dff31646SBarry Smith     ierr = PetscSegBufferGet(PetscCitationsList,1,&cits);CHKERRQ(ierr);
933dff31646SBarry Smith     cits[0] = 0;
934dff31646SBarry Smith     ierr = PetscSegBufferExtractAlloc(PetscCitationsList,&cits);CHKERRQ(ierr);
9351f817a21SBarry Smith     ierr = PetscFPrintf(PETSC_COMM_WORLD,fd,"If you publish results based on this computation please cite the following:\n");CHKERRQ(ierr);
9361f817a21SBarry Smith     ierr = PetscFPrintf(PETSC_COMM_WORLD,fd,"===========================================================================\n");CHKERRQ(ierr);
9371f817a21SBarry Smith     ierr = PetscFPrintf(PETSC_COMM_WORLD,fd,"%s",cits);CHKERRQ(ierr);
9381f817a21SBarry Smith     ierr = PetscFPrintf(PETSC_COMM_WORLD,fd,"===========================================================================\n");CHKERRQ(ierr);
9391f817a21SBarry Smith     ierr = PetscFClose(PETSC_COMM_WORLD,fd);CHKERRQ(ierr);
940dff31646SBarry Smith     ierr = PetscFree(cits);CHKERRQ(ierr);
941dff31646SBarry Smith   }
942dff31646SBarry Smith   ierr = PetscSegBufferDestroy(&PetscCitationsList);CHKERRQ(ierr);
943dff31646SBarry Smith 
9442d53ad75SBarry Smith #if defined(PETSC_SERIALIZE_FUNCTIONS)
9452d53ad75SBarry Smith   ierr = PetscFPTDestroy();CHKERRQ(ierr);
9462d53ad75SBarry Smith #endif
9472d53ad75SBarry Smith 
9482d53ad75SBarry Smith 
949d5649816SBarry Smith #if defined(PETSC_HAVE_AMS)
950dff31646SBarry Smith   flg = PETSC_FALSE;
9510298fd71SBarry Smith   ierr = PetscOptionsGetBool(NULL,"-options_gui",&flg,NULL);CHKERRQ(ierr);
952d5649816SBarry Smith   if (flg) {
953d5649816SBarry Smith     ierr = PetscOptionsAMSDestroy();CHKERRQ(ierr);
954d5649816SBarry Smith   }
955d5649816SBarry Smith #endif
956d5649816SBarry Smith 
9576d065ec1SBarry Smith #if defined(PETSC_HAVE_SERVER)
9582d139d8fSBarry Smith   flg1 = PETSC_FALSE;
9592d139d8fSBarry Smith   ierr = PetscOptionsGetBool(NULL,"-server",&flg1,NULL);CHKERRQ(ierr);
9602d139d8fSBarry Smith   if (flg1) {
9616d065ec1SBarry Smith     /*  this is a crude hack, but better than nothing */
9622d139d8fSBarry Smith     ierr = PetscPOpen(PETSC_COMM_WORLD,NULL,"pkill -9 petscwebserver","r",NULL);CHKERRQ(ierr);
9632d139d8fSBarry Smith   }
9646d065ec1SBarry Smith #endif
9652d139d8fSBarry Smith 
96685afcc9aSBarry Smith   ierr = PetscHMPIFinalize();CHKERRQ(ierr);
967d3f95da6SShri Abhyankar 
9680298fd71SBarry Smith   ierr = PetscOptionsGetBool(NULL,"-malloc_info",&flg2,NULL);CHKERRQ(ierr);
969e5c89e4eSSatish Balay   if (!flg2) {
97090d69ab7SBarry Smith     flg2 = PETSC_FALSE;
9710298fd71SBarry Smith     ierr = PetscOptionsGetBool(NULL,"-memory_info",&flg2,NULL);CHKERRQ(ierr);
972e5c89e4eSSatish Balay   }
973e5c89e4eSSatish Balay   if (flg2) {
974e5c89e4eSSatish Balay     ierr = PetscMemoryShowUsage(PETSC_VIEWER_STDOUT_WORLD,"Summary of Memory Usage in PETSc\n");CHKERRQ(ierr);
975e5c89e4eSSatish Balay   }
976e5c89e4eSSatish Balay 
977e5c89e4eSSatish Balay #if defined(PETSC_USE_LOG)
97890d69ab7SBarry Smith   flg1 = PETSC_FALSE;
9790298fd71SBarry Smith   ierr = PetscOptionsGetBool(NULL,"-get_total_flops",&flg1,NULL);CHKERRQ(ierr);
980e5c89e4eSSatish Balay   if (flg1) {
981e5c89e4eSSatish Balay     PetscLogDouble flops = 0;
982205a32c2SJed Brown     ierr = MPI_Reduce(&petsc_TotalFlops,&flops,1,MPI_DOUBLE,MPI_SUM,0,PETSC_COMM_WORLD);CHKERRQ(ierr);
983e5c89e4eSSatish Balay     ierr = PetscPrintf(PETSC_COMM_WORLD,"Total flops over all processors %g\n",flops);CHKERRQ(ierr);
984e5c89e4eSSatish Balay   }
985e5c89e4eSSatish Balay #endif
986e5c89e4eSSatish Balay 
987e5c89e4eSSatish Balay 
988e5c89e4eSSatish Balay #if defined(PETSC_USE_LOG)
989e5c89e4eSSatish Balay #if defined(PETSC_HAVE_MPE)
990e5c89e4eSSatish Balay   mname[0] = 0;
991a297a907SKarl Rupp 
9920298fd71SBarry Smith   ierr = PetscOptionsGetString(NULL,"-log_mpe",mname,PETSC_MAX_PATH_LEN,&flg1);CHKERRQ(ierr);
993e5c89e4eSSatish Balay   if (flg1) {
994e5c89e4eSSatish Balay     if (mname[0]) {ierr = PetscLogMPEDump(mname);CHKERRQ(ierr);}
995e5c89e4eSSatish Balay     else          {ierr = PetscLogMPEDump(0);CHKERRQ(ierr);}
996e5c89e4eSSatish Balay   }
997e5c89e4eSSatish Balay #endif
998e5c89e4eSSatish Balay   mname[0] = 0;
999a297a907SKarl Rupp 
10000298fd71SBarry Smith   ierr = PetscOptionsGetString(NULL,"-log_summary",mname,PETSC_MAX_PATH_LEN,&flg1);CHKERRQ(ierr);
1001e5c89e4eSSatish Balay   if (flg1) {
100291eabc43SBarry Smith     PetscViewer viewer;
100391eabc43SBarry Smith     if (mname[0]) {
100491eabc43SBarry Smith       ierr = PetscViewerASCIIOpen(PETSC_COMM_WORLD,mname,&viewer);CHKERRQ(ierr);
100591eabc43SBarry Smith       ierr = PetscLogView(viewer);CHKERRQ(ierr);
10066bf464f9SBarry Smith       ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr);
100733f85c2fSBarry Smith     } else {
100833f85c2fSBarry Smith       viewer = PETSC_VIEWER_STDOUT_WORLD;
100933f85c2fSBarry Smith       ierr   = PetscLogView(viewer);CHKERRQ(ierr);
101033f85c2fSBarry Smith     }
1011e5c89e4eSSatish Balay   }
1012e5c89e4eSSatish Balay 
1013ff5bc46bSBarry Smith   mname[0] = 0;
1014a297a907SKarl Rupp 
10150298fd71SBarry Smith   ierr = PetscOptionsGetString(NULL,"-log_summary_python",mname,PETSC_MAX_PATH_LEN,&flg1);CHKERRQ(ierr);
1016ff5bc46bSBarry Smith   if (flg1) {
1017ff5bc46bSBarry Smith     PetscViewer viewer;
1018ff5bc46bSBarry Smith     if (mname[0]) {
1019ff5bc46bSBarry Smith       ierr = PetscViewerASCIIOpen(PETSC_COMM_WORLD,mname,&viewer);CHKERRQ(ierr);
102091eabc43SBarry Smith       ierr = PetscLogViewPython(viewer);CHKERRQ(ierr);
10216bf464f9SBarry Smith       ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr);
102233f85c2fSBarry Smith     } else {
102333f85c2fSBarry Smith       viewer = PETSC_VIEWER_STDOUT_WORLD;
102433f85c2fSBarry Smith       ierr   = PetscLogViewPython(viewer);CHKERRQ(ierr);
102533f85c2fSBarry Smith     }
1026ff5bc46bSBarry Smith   }
1027ff5bc46bSBarry Smith 
10280298fd71SBarry Smith   ierr = PetscOptionsGetString(NULL,"-log_detailed",mname,PETSC_MAX_PATH_LEN,&flg1);CHKERRQ(ierr);
102978392ef1SBarry Smith   if (flg1) {
103078392ef1SBarry Smith     if (mname[0])  {ierr = PetscLogPrintDetailed(PETSC_COMM_WORLD,mname);CHKERRQ(ierr);}
103178392ef1SBarry Smith     else           {ierr = PetscLogPrintDetailed(PETSC_COMM_WORLD,0);CHKERRQ(ierr);}
103278392ef1SBarry Smith   }
103378392ef1SBarry Smith 
1034e5c89e4eSSatish Balay   mname[0] = 0;
1035a297a907SKarl Rupp 
10360298fd71SBarry Smith   ierr = PetscOptionsGetString(NULL,"-log_all",mname,PETSC_MAX_PATH_LEN,&flg1);CHKERRQ(ierr);
10370298fd71SBarry Smith   ierr = PetscOptionsGetString(NULL,"-log",mname,PETSC_MAX_PATH_LEN,&flg2);CHKERRQ(ierr);
1038e5c89e4eSSatish Balay   if (flg1 || flg2) {
1039e5c89e4eSSatish Balay     if (mname[0]) PetscLogDump(mname);
1040e5c89e4eSSatish Balay     else          PetscLogDump(0);
1041e5c89e4eSSatish Balay   }
1042e5c89e4eSSatish Balay #endif
104310463e74SBarry Smith 
1044b58ca069SBarry Smith   /*
1045b58ca069SBarry Smith      Free all objects registered with PetscObjectRegisterDestroy() such as PETSC_VIEWER_XXX_().
1046b58ca069SBarry Smith   */
1047b58ca069SBarry Smith   ierr = PetscObjectRegisterDestroyAll();CHKERRQ(ierr);
1048b58ca069SBarry Smith 
1049ffdaebb2SJed Brown   {
1050f5565f11SShri Abhyankar     PetscThreadComm tcomm_world;
1051f5565f11SShri Abhyankar     ierr = PetscGetThreadCommWorld(&tcomm_world);CHKERRQ(ierr);
1052f5565f11SShri Abhyankar     /* Free global thread communicator */
1053f5565f11SShri Abhyankar     ierr = PetscThreadCommDestroy(&tcomm_world);CHKERRQ(ierr);
1054ffdaebb2SJed Brown   }
1055f5565f11SShri Abhyankar 
10568bf1f09cSShri Abhyankar #if defined(PETSC_USE_DEBUG)
105733f85c2fSBarry Smith   ierr = PetscStackDestroy();CHKERRQ(ierr);
105833f85c2fSBarry Smith #endif
105910463e74SBarry Smith 
106090d69ab7SBarry Smith   flg1 = PETSC_FALSE;
10610298fd71SBarry Smith   ierr = PetscOptionsGetBool(NULL,"-no_signal_handler",&flg1,NULL);CHKERRQ(ierr);
1062e5c89e4eSSatish Balay   if (!flg1) { ierr = PetscPopSignalHandler();CHKERRQ(ierr);}
106390d69ab7SBarry Smith   flg1 = PETSC_FALSE;
10640298fd71SBarry Smith   ierr = PetscOptionsGetBool(NULL,"-mpidump",&flg1,NULL);CHKERRQ(ierr);
1065e5c89e4eSSatish Balay   if (flg1) {
1066e5c89e4eSSatish Balay     ierr = PetscMPIDump(stdout);CHKERRQ(ierr);
1067e5c89e4eSSatish Balay   }
106890d69ab7SBarry Smith   flg1 = PETSC_FALSE;
106990d69ab7SBarry Smith   flg2 = PETSC_FALSE;
10708bb29257SSatish Balay   /* preemptive call to avoid listing this option in options table as unused */
10710298fd71SBarry Smith   ierr = PetscOptionsHasName(NULL,"-malloc_dump",&flg1);CHKERRQ(ierr);
10720298fd71SBarry Smith   ierr = PetscOptionsHasName(NULL,"-objects_dump",&flg1);CHKERRQ(ierr);
10730298fd71SBarry Smith   ierr = PetscOptionsGetBool(NULL,"-options_table",&flg2,NULL);CHKERRQ(ierr);
1074e4c476e2SSatish Balay 
1075e5c89e4eSSatish Balay   if (flg2) {
1076be56827dSJed Brown     PetscViewer viewer;
1077be56827dSJed Brown     ierr = PetscViewerASCIIGetStdout(PETSC_COMM_WORLD,&viewer);CHKERRQ(ierr);
1078be56827dSJed Brown     ierr = PetscOptionsView(viewer);CHKERRQ(ierr);
1079be56827dSJed Brown     ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr);
1080e5c89e4eSSatish Balay   }
1081e5c89e4eSSatish Balay 
1082e5c89e4eSSatish Balay   /* to prevent PETSc -options_left from warning */
10830298fd71SBarry Smith   ierr = PetscOptionsHasName(NULL,"-nox",&flg1);CHKERRQ(ierr);
10840298fd71SBarry Smith   ierr = PetscOptionsHasName(NULL,"-nox_warning",&flg1);CHKERRQ(ierr);
1085e5c89e4eSSatish Balay 
108685afcc9aSBarry Smith   if (!PetscHMPIWorker) { /* worker processes skip this because they do not usually process options */
108733fc4174SSatish Balay     flg3 = PETSC_FALSE; /* default value is required */
10880298fd71SBarry Smith     ierr = PetscOptionsGetBool(NULL,"-options_left",&flg3,&flg1);CHKERRQ(ierr);
1089e5c89e4eSSatish Balay     ierr = PetscOptionsAllUsed(&nopt);CHKERRQ(ierr);
1090e5c89e4eSSatish Balay     if (flg3) {
1091e5c89e4eSSatish Balay       if (!flg2) { /* have not yet printed the options */
1092be56827dSJed Brown         PetscViewer viewer;
1093be56827dSJed Brown         ierr = PetscViewerASCIIGetStdout(PETSC_COMM_WORLD,&viewer);CHKERRQ(ierr);
1094be56827dSJed Brown         ierr = PetscOptionsView(viewer);CHKERRQ(ierr);
1095be56827dSJed Brown         ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr);
1096e5c89e4eSSatish Balay       }
1097e5c89e4eSSatish Balay       if (!nopt) {
1098e5c89e4eSSatish Balay         ierr = PetscPrintf(PETSC_COMM_WORLD,"There are no unused options.\n");CHKERRQ(ierr);
1099e5c89e4eSSatish Balay       } else if (nopt == 1) {
1100e5c89e4eSSatish Balay         ierr = PetscPrintf(PETSC_COMM_WORLD,"There is one unused database option. It is:\n");CHKERRQ(ierr);
1101e5c89e4eSSatish Balay       } else {
11027582186dSLisandro Dalcin         ierr = PetscPrintf(PETSC_COMM_WORLD,"There are %D unused database options. They are:\n",nopt);CHKERRQ(ierr);
1103e5c89e4eSSatish Balay       }
1104e5c89e4eSSatish Balay     }
1105e5c89e4eSSatish Balay #if defined(PETSC_USE_DEBUG)
1106da8b8a77SBarry Smith     if (nopt && !flg3 && !flg1) {
1107e5c89e4eSSatish Balay       ierr = PetscPrintf(PETSC_COMM_WORLD,"WARNING! There are options you set that were not used!\n");CHKERRQ(ierr);
1108e5c89e4eSSatish Balay       ierr = PetscPrintf(PETSC_COMM_WORLD,"WARNING! could be spelling mistake, etc!\n");CHKERRQ(ierr);
1109e5c89e4eSSatish Balay       ierr = PetscOptionsLeft();CHKERRQ(ierr);
1110e5c89e4eSSatish Balay     } else if (nopt && flg3) {
1111e5c89e4eSSatish Balay #else
1112e5c89e4eSSatish Balay     if (nopt && flg3) {
1113e5c89e4eSSatish Balay #endif
1114e5c89e4eSSatish Balay       ierr = PetscOptionsLeft();CHKERRQ(ierr);
1115e5c89e4eSSatish Balay     }
1116931f367cSBarry Smith   }
1117e5c89e4eSSatish Balay 
111810463e74SBarry Smith   /*
1119dbc8283eSBarry Smith        List all objects the user may have forgot to free
11202eff7a51SBarry Smith   */
11210298fd71SBarry Smith   ierr = PetscOptionsHasName(NULL,"-objects_dump",&flg1);CHKERRQ(ierr);
1122a64a8e02SBarry Smith   if (flg1) {
1123a64a8e02SBarry Smith     MPI_Comm local_comm;
11247eb1d149SBarry Smith     char     string[64];
1125a64a8e02SBarry Smith 
11260298fd71SBarry Smith     ierr = PetscOptionsGetString(NULL,"-objects_dump",string,64,NULL);CHKERRQ(ierr);
1127a64a8e02SBarry Smith     ierr = MPI_Comm_dup(MPI_COMM_WORLD,&local_comm);CHKERRQ(ierr);
1128a64a8e02SBarry Smith     ierr = PetscSequentialPhaseBegin_Private(local_comm,1);CHKERRQ(ierr);
11297eb1d149SBarry Smith     ierr = PetscObjectsDump(stdout,(string[0] == 'a') ? PETSC_TRUE : PETSC_FALSE);CHKERRQ(ierr);
1130a64a8e02SBarry Smith     ierr = PetscSequentialPhaseEnd_Private(local_comm,1);CHKERRQ(ierr);
1131a64a8e02SBarry Smith     ierr = MPI_Comm_free(&local_comm);CHKERRQ(ierr);
11320a1571b3SBarry Smith   }
1133dbc8283eSBarry Smith   PetscObjectsCounts    = 0;
1134dbc8283eSBarry Smith   PetscObjectsMaxCounts = 0;
11352eff7a51SBarry Smith 
1136a297a907SKarl Rupp   ierr = PetscFree(PetscObjects);CHKERRQ(ierr);
11372eff7a51SBarry Smith 
113833f85c2fSBarry Smith #if defined(PETSC_USE_LOG)
113933f85c2fSBarry Smith   ierr = PetscLogDestroy();CHKERRQ(ierr);
114033f85c2fSBarry Smith #endif
114133f85c2fSBarry Smith 
114233f85c2fSBarry Smith   /*
114333f85c2fSBarry Smith      Destroy any packages that registered a finalize
114433f85c2fSBarry Smith   */
114533f85c2fSBarry Smith   ierr = PetscRegisterFinalizeAll();CHKERRQ(ierr);
114633f85c2fSBarry Smith 
114733f85c2fSBarry Smith   /*
114810463e74SBarry Smith      Destroy all the function registration lists created
114910463e74SBarry Smith   */
115010463e74SBarry Smith   ierr = PetscFinalize_DynamicLibraries();CHKERRQ(ierr);
115110463e74SBarry Smith 
115248dd1dffSBarry Smith   /*
115348dd1dffSBarry Smith      Print PetscFunctionLists that have not been properly freed
115448dd1dffSBarry Smith 
115537e93019SBarry Smith   ierr = PetscFunctionListPrintAll();CHKERRQ(ierr);
115648dd1dffSBarry Smith   */
115737e93019SBarry Smith 
11584028d114SSatish Balay   if (petsc_history) {
1159f3dea69dSBarry Smith     ierr = PetscCloseHistoryFile(&petsc_history);CHKERRQ(ierr);
1160e5c89e4eSSatish Balay     petsc_history = 0;
1161e5c89e4eSSatish Balay   }
1162e5c89e4eSSatish Balay 
11630298fd71SBarry Smith   ierr = PetscInfoAllow(PETSC_FALSE,NULL);CHKERRQ(ierr);
1164e5c89e4eSSatish Balay 
11658bb29257SSatish Balay   {
1166e5c89e4eSSatish Balay     char fname[PETSC_MAX_PATH_LEN];
1167e5c89e4eSSatish Balay     FILE *fd;
1168ed9cf6e9SBarry Smith     int  err;
1169e5c89e4eSSatish Balay 
1170e5c89e4eSSatish Balay     fname[0] = 0;
1171a297a907SKarl Rupp 
11720298fd71SBarry Smith     ierr = PetscOptionsGetString(NULL,"-malloc_dump",fname,250,&flg1);CHKERRQ(ierr);
1173dc92acbaSJed Brown     flg2 = PETSC_FALSE;
11740298fd71SBarry Smith     ierr = PetscOptionsGetBool(NULL,"-malloc_test",&flg2,NULL);CHKERRQ(ierr);
11758bf1f09cSShri Abhyankar #if defined(PETSC_USE_DEBUG)
1176dc92acbaSJed Brown     if (PETSC_RUNNING_ON_VALGRIND) flg2 = PETSC_FALSE;
1177dc92acbaSJed Brown #else
1178dc92acbaSJed Brown     flg2 = PETSC_FALSE;         /* Skip reporting for optimized builds regardless of -malloc_test */
1179dc92acbaSJed Brown #endif
1180e5c89e4eSSatish Balay     if (flg1 && fname[0]) {
1181e5c89e4eSSatish Balay       char sname[PETSC_MAX_PATH_LEN];
1182e5c89e4eSSatish Balay 
1183e5c89e4eSSatish Balay       sprintf(sname,"%s_%d",fname,rank);
1184e32f2f54SBarry Smith       fd   = fopen(sname,"w"); if (!fd) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_FILE_OPEN,"Cannot open log file: %s",sname);
1185e5c89e4eSSatish Balay       ierr = PetscMallocDump(fd);CHKERRQ(ierr);
1186ed9cf6e9SBarry Smith       err  = fclose(fd);
1187e32f2f54SBarry Smith       if (err) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SYS,"fclose() failed on file");
1188dc92acbaSJed Brown     } else if (flg1 || flg2) {
1189e5c89e4eSSatish Balay       MPI_Comm local_comm;
1190e5c89e4eSSatish Balay 
1191e5c89e4eSSatish Balay       ierr = MPI_Comm_dup(MPI_COMM_WORLD,&local_comm);CHKERRQ(ierr);
1192e5c89e4eSSatish Balay       ierr = PetscSequentialPhaseBegin_Private(local_comm,1);CHKERRQ(ierr);
1193e5c89e4eSSatish Balay       ierr = PetscMallocDump(stdout);CHKERRQ(ierr);
1194e5c89e4eSSatish Balay       ierr = PetscSequentialPhaseEnd_Private(local_comm,1);CHKERRQ(ierr);
1195e5c89e4eSSatish Balay       ierr = MPI_Comm_free(&local_comm);CHKERRQ(ierr);
1196e5c89e4eSSatish Balay     }
1197e5c89e4eSSatish Balay   }
1198a64a8e02SBarry Smith 
11998bb29257SSatish Balay   {
1200e5c89e4eSSatish Balay     char fname[PETSC_MAX_PATH_LEN];
12010298fd71SBarry Smith     FILE *fd = NULL;
1202e5c89e4eSSatish Balay 
1203e5c89e4eSSatish Balay     fname[0] = 0;
1204a297a907SKarl Rupp 
12050298fd71SBarry Smith     ierr = PetscOptionsGetString(NULL,"-malloc_log",fname,250,&flg1);CHKERRQ(ierr);
12060298fd71SBarry Smith     ierr = PetscOptionsHasName(NULL,"-malloc_log_threshold",&flg2);CHKERRQ(ierr);
1207e5c89e4eSSatish Balay     if (flg1 && fname[0]) {
1208ed9cf6e9SBarry Smith       int err;
1209e5c89e4eSSatish Balay 
1210574034a9SJed Brown       if (!rank) {
1211574034a9SJed Brown         fd = fopen(fname,"w");
1212574034a9SJed Brown         if (!fd) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_FILE_OPEN,"Cannot open log file: %s",fname);
1213574034a9SJed Brown       }
1214e5c89e4eSSatish Balay       ierr = PetscMallocDumpLog(fd);CHKERRQ(ierr);
1215574034a9SJed Brown       if (fd) {
1216ed9cf6e9SBarry Smith         err = fclose(fd);
1217e32f2f54SBarry Smith         if (err) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SYS,"fclose() failed on file");
1218574034a9SJed Brown       }
1219574034a9SJed Brown     } else if (flg1 || flg2) {
1220e5c89e4eSSatish Balay       ierr = PetscMallocDumpLog(stdout);CHKERRQ(ierr);
1221e5c89e4eSSatish Balay     }
1222e5c89e4eSSatish Balay   }
1223e5c89e4eSSatish Balay   /* Can be destroyed only after all the options are used */
1224e5c89e4eSSatish Balay   ierr = PetscOptionsDestroy();CHKERRQ(ierr);
1225e5c89e4eSSatish Balay 
1226e5c89e4eSSatish Balay   PetscGlobalArgc = 0;
1227e5c89e4eSSatish Balay   PetscGlobalArgs = 0;
1228e5c89e4eSSatish Balay 
1229ce63c4c1SBarry Smith #if defined(PETSC_USE_REAL___FLOAT128)
1230c90a1750SBarry Smith   ierr = MPI_Type_free(&MPIU___FLOAT128);CHKERRQ(ierr);
12317c2de775SJed Brown #if defined(PETSC_HAVE_COMPLEX)
12328c764dc5SJose Roman   ierr = MPI_Type_free(&MPIU___COMPLEX128);CHKERRQ(ierr);
12338c764dc5SJose Roman #endif
1234d9822059SBarry Smith   ierr = MPI_Op_free(&MPIU_MAX);CHKERRQ(ierr);
1235d9822059SBarry Smith   ierr = MPI_Op_free(&MPIU_MIN);CHKERRQ(ierr);
1236c90a1750SBarry Smith #endif
1237c90a1750SBarry Smith 
12387c2de775SJed Brown #if defined(PETSC_HAVE_COMPLEX)
12392c876bd9SBarry Smith #if !defined(PETSC_HAVE_MPI_C_DOUBLE_COMPLEX)
1240500d8756SSatish Balay   ierr = MPI_Type_free(&MPIU_C_DOUBLE_COMPLEX);CHKERRQ(ierr);
1241500d8756SSatish Balay   ierr = MPI_Type_free(&MPIU_C_COMPLEX);CHKERRQ(ierr);
12422c876bd9SBarry Smith #endif
1243e5c89e4eSSatish Balay #endif
1244cca4cb22SSatish Balay 
12457c2de775SJed Brown #if (defined(PETSC_HAVE_COMPLEX) && !defined(PETSC_HAVE_MPI_C_DOUBLE_COMPLEX)) || defined(PETSC_USE_REAL___FLOAT128)
1246cca4cb22SSatish Balay   ierr = MPI_Op_free(&MPIU_SUM);CHKERRQ(ierr);
1247cca4cb22SSatish Balay #endif
1248cca4cb22SSatish Balay 
1249e5c89e4eSSatish Balay   ierr = MPI_Type_free(&MPIU_2SCALAR);CHKERRQ(ierr);
125044041f26SJed Brown #if defined(PETSC_USE_64BIT_INDICES) || !defined(MPI_2INT)
1251e5c89e4eSSatish Balay   ierr = MPI_Type_free(&MPIU_2INT);CHKERRQ(ierr);
125244041f26SJed Brown #endif
1253e5c89e4eSSatish Balay   ierr = MPI_Op_free(&PetscMaxSum_Op);CHKERRQ(ierr);
1254e5c89e4eSSatish Balay   ierr = MPI_Op_free(&PetscADMax_Op);CHKERRQ(ierr);
1255e5c89e4eSSatish Balay   ierr = MPI_Op_free(&PetscADMin_Op);CHKERRQ(ierr);
1256e5c89e4eSSatish Balay 
1257dbc8283eSBarry Smith   /*
1258efb80d3cSBarry Smith      Destroy any known inner MPI_Comm's and attributes pointing to them
1259efb80d3cSBarry Smith      Note this will not destroy any new communicators the user has created.
1260efb80d3cSBarry Smith 
1261efb80d3cSBarry Smith      If all PETSc objects were not destroyed those left over objects will have hanging references to
1262efb80d3cSBarry Smith      the MPI_Comms that were freed; but that is ok because those PETSc objects will never be used again
1263dbc8283eSBarry Smith  */
1264b770b1f6SSatish Balay   {
1265dbc8283eSBarry Smith     PetscCommCounter *counter;
1266dbc8283eSBarry Smith     PetscMPIInt      flg;
1267dbc8283eSBarry Smith     MPI_Comm         icomm;
1268dbc8283eSBarry Smith     void             *ptr;
1269dbc8283eSBarry Smith     ierr = MPI_Attr_get(PETSC_COMM_SELF,Petsc_InnerComm_keyval,&ptr,&flg);CHKERRQ(ierr);
1270dbc8283eSBarry Smith     if (flg) {
1271dbc8283eSBarry Smith       /*  Use PetscMemcpy() because casting from pointer to integer of different size is not allowed with some compilers  */
1272dbc8283eSBarry Smith       ierr = PetscMemcpy(&icomm,&ptr,sizeof(MPI_Comm));CHKERRQ(ierr);
1273dbc8283eSBarry Smith       ierr = MPI_Attr_get(icomm,Petsc_Counter_keyval,&counter,&flg);CHKERRQ(ierr);
1274dbc8283eSBarry 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");
1275dbc8283eSBarry Smith 
1276dbc8283eSBarry Smith       ierr = MPI_Attr_delete(PETSC_COMM_SELF,Petsc_InnerComm_keyval);CHKERRQ(ierr);
1277efb80d3cSBarry Smith       ierr = MPI_Attr_delete(icomm,Petsc_Counter_keyval);CHKERRQ(ierr);
1278efb80d3cSBarry Smith       ierr = MPI_Comm_free(&icomm);CHKERRQ(ierr);
1279dbc8283eSBarry Smith     }
1280dbc8283eSBarry Smith     ierr = MPI_Attr_get(PETSC_COMM_WORLD,Petsc_InnerComm_keyval,&ptr,&flg);CHKERRQ(ierr);
1281dbc8283eSBarry Smith     if (flg) {
1282dbc8283eSBarry Smith       /*  Use PetscMemcpy() because casting from pointer to integer of different size is not allowed with some compilers  */
1283dbc8283eSBarry Smith       ierr = PetscMemcpy(&icomm,&ptr,sizeof(MPI_Comm));CHKERRQ(ierr);
1284dbc8283eSBarry Smith       ierr = MPI_Attr_get(icomm,Petsc_Counter_keyval,&counter,&flg);CHKERRQ(ierr);
1285dbc8283eSBarry 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");
1286dbc8283eSBarry Smith 
1287dbc8283eSBarry Smith       ierr = MPI_Attr_delete(PETSC_COMM_WORLD,Petsc_InnerComm_keyval);CHKERRQ(ierr);
1288efb80d3cSBarry Smith       ierr = MPI_Attr_delete(icomm,Petsc_Counter_keyval);CHKERRQ(ierr);
1289efb80d3cSBarry Smith       ierr = MPI_Comm_free(&icomm);CHKERRQ(ierr);
1290dbc8283eSBarry Smith     }
1291b770b1f6SSatish Balay   }
1292dbc8283eSBarry Smith 
1293480cf27aSJed Brown   ierr = MPI_Keyval_free(&Petsc_Counter_keyval);CHKERRQ(ierr);
1294480cf27aSJed Brown   ierr = MPI_Keyval_free(&Petsc_InnerComm_keyval);CHKERRQ(ierr);
1295480cf27aSJed Brown   ierr = MPI_Keyval_free(&Petsc_OuterComm_keyval);CHKERRQ(ierr);
1296480cf27aSJed Brown 
1297663ba86aSMatthew G Knepley #if defined(PETSC_HAVE_CUDA)
12984bb5149bSJed Brown   {
12994bb5149bSJed Brown     PetscInt p;
1300663ba86aSMatthew G Knepley     for (p = 0; p < PetscGlobalSize; ++p) {
1301a297a907SKarl Rupp       if (p == PetscGlobalRank) cublasShutdown();
1302663ba86aSMatthew G Knepley       ierr = MPI_Barrier(PETSC_COMM_WORLD);CHKERRQ(ierr);
1303663ba86aSMatthew G Knepley     }
13044bb5149bSJed Brown   }
1305663ba86aSMatthew G Knepley #endif
1306663ba86aSMatthew G Knepley 
1307e5c89e4eSSatish Balay   if (PetscBeganMPI) {
130899608316SBarry Smith #if defined(PETSC_HAVE_MPI_FINALIZED)
130999b1327fSBarry Smith     PetscMPIInt flag;
131099b1327fSBarry Smith     ierr = MPI_Finalized(&flag);CHKERRQ(ierr);
1311e32f2f54SBarry Smith     if (flag) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_LIB,"MPI_Finalize() has already been called, even though MPI_Init() was called by PetscInitialize()");
131299608316SBarry Smith #endif
1313e5c89e4eSSatish Balay     ierr = MPI_Finalize();CHKERRQ(ierr);
1314e5c89e4eSSatish Balay   }
1315e5c89e4eSSatish Balay /*
1316e5c89e4eSSatish Balay 
1317e5c89e4eSSatish Balay      Note: In certain cases PETSC_COMM_WORLD is never MPI_Comm_free()ed because
1318e5c89e4eSSatish Balay    the communicator has some outstanding requests on it. Specifically if the
1319e5c89e4eSSatish Balay    flag PETSC_HAVE_BROKEN_REQUEST_FREE is set (for IBM MPI implementation). See
1320e5c89e4eSSatish Balay    src/vec/utils/vpscat.c. Due to this the memory allocated in PetscCommDuplicate()
1321e5c89e4eSSatish Balay    is never freed as it should be. Thus one may obtain messages of the form
13220e5e90baSSatish Balay    [ 1] 8 bytes PetscCommDuplicate() line 645 in src/sys/mpiu.c indicating the
1323e5c89e4eSSatish Balay    memory was not freed.
1324e5c89e4eSSatish Balay 
1325e5c89e4eSSatish Balay */
13261d1a0024SBarry Smith   ierr = PetscMallocClear();CHKERRQ(ierr);
1327a297a907SKarl Rupp 
1328e5c89e4eSSatish Balay   PetscInitializeCalled = PETSC_FALSE;
1329e5c89e4eSSatish Balay   PetscFinalizeCalled   = PETSC_TRUE;
1330e5c89e4eSSatish Balay   PetscFunctionReturn(ierr);
1331e5c89e4eSSatish Balay }
1332e5c89e4eSSatish Balay 
133343db4dbbSBarry Smith #if defined(PETSC_MISSING_LAPACK_lsame_)
13348cc058d9SJed Brown PETSC_EXTERN int lsame_(char *a,char *b)
133543db4dbbSBarry Smith {
133643db4dbbSBarry Smith   if (*a == *b) return 1;
133743db4dbbSBarry Smith   if (*a + 32 == *b) return 1;
133843db4dbbSBarry Smith   if (*a - 32 == *b) return 1;
133943db4dbbSBarry Smith   return 0;
134043db4dbbSBarry Smith }
1341a70650f6SBarry Smith #endif
134243db4dbbSBarry Smith 
134343db4dbbSBarry Smith #if defined(PETSC_MISSING_LAPACK_lsame)
13448cc058d9SJed Brown PETSC_EXTERN int lsame(char *a,char *b)
134543db4dbbSBarry Smith {
134643db4dbbSBarry Smith   if (*a == *b) return 1;
134743db4dbbSBarry Smith   if (*a + 32 == *b) return 1;
134843db4dbbSBarry Smith   if (*a - 32 == *b) return 1;
134943db4dbbSBarry Smith   return 0;
135043db4dbbSBarry Smith }
135143db4dbbSBarry Smith #endif
1352