xref: /petsc/src/sys/objects/pinit.c (revision 681455b24223727a2fe7419cf0a0464f43bf3bda)
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 
15493b6d2d1SJed Brown    Level: beginner
155e5c89e4eSSatish Balay 
156e5c89e4eSSatish Balay .seealso: PetscInitialize(), PetscInitializeNoArguments(), PetscInitializeFortran()
157e5c89e4eSSatish Balay @*/
1587087cfbeSBarry Smith PetscErrorCode PetscInitialized(PetscBool  *isInitialized)
159e5c89e4eSSatish Balay {
160e5c89e4eSSatish Balay   *isInitialized = PetscInitializeCalled;
16193b6d2d1SJed Brown   return 0;
162e5c89e4eSSatish Balay }
163e5c89e4eSSatish Balay 
164e5c89e4eSSatish Balay #undef __FUNCT__
165e5c89e4eSSatish Balay #define __FUNCT__ "PetscFinalized"
166e5c89e4eSSatish Balay /*@
167e5c89e4eSSatish Balay       PetscFinalized - Determine whether PetscFinalize() has been called yet
168e5c89e4eSSatish Balay 
169e5c89e4eSSatish Balay    Level: developer
170e5c89e4eSSatish Balay 
171e5c89e4eSSatish Balay .seealso: PetscInitialize(), PetscInitializeNoArguments(), PetscInitializeFortran()
172e5c89e4eSSatish Balay @*/
1737087cfbeSBarry Smith PetscErrorCode  PetscFinalized(PetscBool  *isFinalized)
174e5c89e4eSSatish Balay {
175e5c89e4eSSatish Balay   *isFinalized = PetscFinalizeCalled;
17693b6d2d1SJed Brown   return 0;
177e5c89e4eSSatish Balay }
178e5c89e4eSSatish Balay 
17909573ac7SBarry Smith extern PetscErrorCode PetscOptionsCheckInitial_Private(void);
180e5c89e4eSSatish Balay 
181e5c89e4eSSatish Balay /*
182e5c89e4eSSatish Balay        This function is the MPI reduction operation used to compute the sum of the
183e5c89e4eSSatish Balay    first half of the datatype and the max of the second half.
184e5c89e4eSSatish Balay */
185e5c89e4eSSatish Balay MPI_Op PetscMaxSum_Op = 0;
186e5c89e4eSSatish Balay 
187e5c89e4eSSatish Balay #undef __FUNCT__
188e5c89e4eSSatish Balay #define __FUNCT__ "PetscMaxSum_Local"
1898cc058d9SJed Brown PETSC_EXTERN void MPIAPI PetscMaxSum_Local(void *in,void *out,int *cnt,MPI_Datatype *datatype)
190e5c89e4eSSatish Balay {
191e5c89e4eSSatish Balay   PetscInt *xin = (PetscInt*)in,*xout = (PetscInt*)out,i,count = *cnt;
192e5c89e4eSSatish Balay 
193e5c89e4eSSatish Balay   PetscFunctionBegin;
194e5c89e4eSSatish Balay   if (*datatype != MPIU_2INT) {
195e5c89e4eSSatish Balay     (*PetscErrorPrintf)("Can only handle MPIU_2INT data types");
196e5c89e4eSSatish Balay     MPI_Abort(MPI_COMM_WORLD,1);
197e5c89e4eSSatish Balay   }
198e5c89e4eSSatish Balay 
199e5c89e4eSSatish Balay   for (i=0; i<count; i++) {
200e5c89e4eSSatish Balay     xout[2*i]    = PetscMax(xout[2*i],xin[2*i]);
201e5c89e4eSSatish Balay     xout[2*i+1] += xin[2*i+1];
202e5c89e4eSSatish Balay   }
203812af9f3SBarry Smith   PetscFunctionReturnVoid();
204e5c89e4eSSatish Balay }
205e5c89e4eSSatish Balay 
206e5c89e4eSSatish Balay /*
207e5c89e4eSSatish Balay     Returns the max of the first entry owned by this processor and the
208e5c89e4eSSatish Balay sum of the second entry.
209b693b147SBarry Smith 
210b693b147SBarry Smith     The reason nprocs[2*i] contains lengths nprocs[2*i+1] contains flag of 1 if length is nonzero
211b693b147SBarry Smith is so that the PetscMaxSum_Op() can set TWO values, if we passed in only nprocs[i] with lengths
212b693b147SBarry Smith there would be no place to store the both needed results.
213e5c89e4eSSatish Balay */
214e5c89e4eSSatish Balay #undef __FUNCT__
215e5c89e4eSSatish Balay #define __FUNCT__ "PetscMaxSum"
2167087cfbeSBarry Smith PetscErrorCode  PetscMaxSum(MPI_Comm comm,const PetscInt nprocs[],PetscInt *max,PetscInt *sum)
217e5c89e4eSSatish Balay {
218e5c89e4eSSatish Balay   PetscMPIInt    size,rank;
2196ac3741eSJed Brown   struct {PetscInt max,sum;} *work;
220e5c89e4eSSatish Balay   PetscErrorCode ierr;
221e5c89e4eSSatish Balay 
222e5c89e4eSSatish Balay   PetscFunctionBegin;
223e5c89e4eSSatish Balay   ierr = MPI_Comm_size(comm,&size);CHKERRQ(ierr);
224e5c89e4eSSatish Balay   ierr = MPI_Comm_rank(comm,&rank);CHKERRQ(ierr);
2256ac3741eSJed Brown   ierr = PetscMalloc(size*sizeof(*work),&work);CHKERRQ(ierr);
226e5c89e4eSSatish Balay   ierr = MPI_Allreduce((void*)nprocs,work,size,MPIU_2INT,PetscMaxSum_Op,comm);CHKERRQ(ierr);
2276ac3741eSJed Brown   *max = work[rank].max;
2286ac3741eSJed Brown   *sum = work[rank].sum;
229e5c89e4eSSatish Balay   ierr = PetscFree(work);CHKERRQ(ierr);
230e5c89e4eSSatish Balay   PetscFunctionReturn(0);
231e5c89e4eSSatish Balay }
232e5c89e4eSSatish Balay 
233e5c89e4eSSatish Balay /* ----------------------------------------------------------------------------*/
2347087cfbeSBarry Smith MPI_Op  PetscADMax_Op = 0;
235e5c89e4eSSatish Balay 
236e5c89e4eSSatish Balay #undef __FUNCT__
237e5c89e4eSSatish Balay #define __FUNCT__ "PetscADMax_Local"
2388cc058d9SJed Brown PETSC_EXTERN void MPIAPI PetscADMax_Local(void *in,void *out,PetscMPIInt *cnt,MPI_Datatype *datatype)
239e5c89e4eSSatish Balay {
240e5c89e4eSSatish Balay   PetscScalar *xin = (PetscScalar*)in,*xout = (PetscScalar*)out;
241e5c89e4eSSatish Balay   PetscInt    i,count = *cnt;
242e5c89e4eSSatish Balay 
243e5c89e4eSSatish Balay   PetscFunctionBegin;
244e5c89e4eSSatish Balay   if (*datatype != MPIU_2SCALAR) {
245e5c89e4eSSatish Balay     (*PetscErrorPrintf)("Can only handle MPIU_2SCALAR data (i.e. double or complex) types");
246e5c89e4eSSatish Balay     MPI_Abort(MPI_COMM_WORLD,1);
247e5c89e4eSSatish Balay   }
248e5c89e4eSSatish Balay 
249e5c89e4eSSatish Balay   for (i=0; i<count; i++) {
250e5c89e4eSSatish Balay     if (PetscRealPart(xout[2*i]) < PetscRealPart(xin[2*i])) {
251e5c89e4eSSatish Balay       xout[2*i]   = xin[2*i];
252e5c89e4eSSatish Balay       xout[2*i+1] = xin[2*i+1];
253e5c89e4eSSatish Balay     }
254e5c89e4eSSatish Balay   }
255812af9f3SBarry Smith   PetscFunctionReturnVoid();
256e5c89e4eSSatish Balay }
257e5c89e4eSSatish Balay 
2587087cfbeSBarry Smith MPI_Op PetscADMin_Op = 0;
259e5c89e4eSSatish Balay 
260e5c89e4eSSatish Balay #undef __FUNCT__
261e5c89e4eSSatish Balay #define __FUNCT__ "PetscADMin_Local"
2628cc058d9SJed Brown PETSC_EXTERN void MPIAPI PetscADMin_Local(void *in,void *out,PetscMPIInt *cnt,MPI_Datatype *datatype)
263e5c89e4eSSatish Balay {
264e5c89e4eSSatish Balay   PetscScalar *xin = (PetscScalar*)in,*xout = (PetscScalar*)out;
265e5c89e4eSSatish Balay   PetscInt    i,count = *cnt;
266e5c89e4eSSatish Balay 
267e5c89e4eSSatish Balay   PetscFunctionBegin;
268e5c89e4eSSatish Balay   if (*datatype != MPIU_2SCALAR) {
269e5c89e4eSSatish Balay     (*PetscErrorPrintf)("Can only handle MPIU_2SCALAR data (i.e. double or complex) types");
270e5c89e4eSSatish Balay     MPI_Abort(MPI_COMM_WORLD,1);
271e5c89e4eSSatish Balay   }
272e5c89e4eSSatish Balay 
273e5c89e4eSSatish Balay   for (i=0; i<count; i++) {
274e5c89e4eSSatish Balay     if (PetscRealPart(xout[2*i]) > PetscRealPart(xin[2*i])) {
275e5c89e4eSSatish Balay       xout[2*i]   = xin[2*i];
276e5c89e4eSSatish Balay       xout[2*i+1] = xin[2*i+1];
277e5c89e4eSSatish Balay     }
278e5c89e4eSSatish Balay   }
279812af9f3SBarry Smith   PetscFunctionReturnVoid();
280e5c89e4eSSatish Balay }
281e5c89e4eSSatish Balay /* ---------------------------------------------------------------------------------------*/
282e5c89e4eSSatish Balay 
2837c2de775SJed Brown #if (defined(PETSC_HAVE_COMPLEX) && !defined(PETSC_HAVE_MPI_C_DOUBLE_COMPLEX)) || defined(PETSC_USE_REAL___FLOAT128)
28406a205a8SBarry Smith MPI_Op MPIU_SUM = 0;
285e5c89e4eSSatish Balay 
286e5c89e4eSSatish Balay #undef __FUNCT__
287e5c89e4eSSatish Balay #define __FUNCT__ "PetscSum_Local"
2888cc058d9SJed Brown PETSC_EXTERN void PetscSum_Local(void *in,void *out,PetscMPIInt *cnt,MPI_Datatype *datatype)
289e5c89e4eSSatish Balay {
290e5c89e4eSSatish Balay   PetscInt i,count = *cnt;
291e5c89e4eSSatish Balay 
292e5c89e4eSSatish Balay   PetscFunctionBegin;
2937c2de775SJed Brown   if (*datatype == MPIU_REAL) {
294e2e03761SBarry Smith     PetscReal *xin = (PetscReal*)in,*xout = (PetscReal*)out;
295a297a907SKarl Rupp     for (i=0; i<count; i++) xout[i] += xin[i];
2967c2de775SJed Brown   }
2977c2de775SJed Brown #if defined(PETSC_HAVE_COMPLEX)
2987c2de775SJed Brown   else if (*datatype == MPIU_COMPLEX) {
2997c2de775SJed Brown     PetscComplex *xin = (PetscComplex*)in,*xout = (PetscComplex*)out;
300a297a907SKarl Rupp     for (i=0; i<count; i++) xout[i] += xin[i];
3017c2de775SJed Brown   }
3027c2de775SJed Brown #endif
3037c2de775SJed Brown   else {
3047c2de775SJed Brown     (*PetscErrorPrintf)("Can only handle MPIU_REAL or MPIU_COMPLEX data types");
305e2e03761SBarry Smith     MPI_Abort(MPI_COMM_WORLD,1);
306e2e03761SBarry Smith   }
307812af9f3SBarry Smith   PetscFunctionReturnVoid();
308e5c89e4eSSatish Balay }
309e5c89e4eSSatish Balay #endif
310e5c89e4eSSatish Balay 
311ce63c4c1SBarry Smith #if defined(PETSC_USE_REAL___FLOAT128)
312d9822059SBarry Smith MPI_Op MPIU_MAX = 0;
313d9822059SBarry Smith MPI_Op MPIU_MIN = 0;
314d9822059SBarry Smith 
315d9822059SBarry Smith #undef __FUNCT__
316d9822059SBarry Smith #define __FUNCT__ "PetscMax_Local"
3178cc058d9SJed Brown PETSC_EXTERN void PetscMax_Local(void *in,void *out,PetscMPIInt *cnt,MPI_Datatype *datatype)
318d9822059SBarry Smith {
319d9822059SBarry Smith   PetscInt i,count = *cnt;
320d9822059SBarry Smith 
321d9822059SBarry Smith   PetscFunctionBegin;
3227c2de775SJed Brown   if (*datatype == MPIU_REAL) {
3238c764dc5SJose Roman     PetscReal *xin = (PetscReal*)in,*xout = (PetscReal*)out;
324a297a907SKarl Rupp     for (i=0; i<count; i++) xout[i] = PetscMax(xout[i],xin[i]);
3257c2de775SJed Brown   }
3267c2de775SJed Brown #if defined(PETSC_HAVE_COMPLEX)
3277c2de775SJed Brown   else if (*datatype == MPIU_COMPLEX) {
3287c2de775SJed Brown     PetscComplex *xin = (PetscComplex*)in,*xout = (PetscComplex*)out;
3297c2de775SJed Brown     for (i=0; i<count; i++) {
3307c2de775SJed Brown       xout[i] = PetscRealPartComplex(xout[i])<PetscRealPartComplex(xin[i]) ? xin[i] : xout[i];
3317c2de775SJed Brown     }
3327c2de775SJed Brown   }
3337c2de775SJed Brown #endif
3347c2de775SJed Brown   else {
3357c2de775SJed Brown     (*PetscErrorPrintf)("Can only handle MPIU_REAL or MPIU_COMPLEX data types");
3368c764dc5SJose Roman     MPI_Abort(MPI_COMM_WORLD,1);
3378c764dc5SJose Roman   }
338d9822059SBarry Smith   PetscFunctionReturnVoid();
339d9822059SBarry Smith }
340d9822059SBarry Smith 
341d9822059SBarry Smith #undef __FUNCT__
342d9822059SBarry Smith #define __FUNCT__ "PetscMin_Local"
3438cc058d9SJed Brown PETSC_EXTERN void PetscMin_Local(void *in,void *out,PetscMPIInt *cnt,MPI_Datatype *datatype)
344d9822059SBarry Smith {
345d9822059SBarry Smith   PetscInt    i,count = *cnt;
346d9822059SBarry Smith 
347d9822059SBarry Smith   PetscFunctionBegin;
3487c2de775SJed Brown   if (*datatype == MPIU_REAL) {
3498c764dc5SJose Roman     PetscReal *xin = (PetscReal*)in,*xout = (PetscReal*)out;
350a297a907SKarl Rupp     for (i=0; i<count; i++) xout[i] = PetscMin(xout[i],xin[i]);
3517c2de775SJed Brown   }
3527c2de775SJed Brown #if defined(PETSC_HAVE_COMPLEX)
3537c2de775SJed Brown   else if (*datatype == MPIU_COMPLEX) {
3547c2de775SJed Brown     PetscComplex *xin = (PetscComplex*)in,*xout = (PetscComplex*)out;
3557c2de775SJed Brown     for (i=0; i<count; i++) {
3567c2de775SJed Brown       xout[i] = PetscRealPartComplex(xout[i])>PetscRealPartComplex(xin[i]) ? xin[i] : xout[i];
3577c2de775SJed Brown     }
3587c2de775SJed Brown   }
3597c2de775SJed Brown #endif
3607c2de775SJed Brown   else {
3618c764dc5SJose Roman     (*PetscErrorPrintf)("Can only handle MPIU_REAL or MPIU_SCALAR data (i.e. double or complex) types");
3628c764dc5SJose Roman     MPI_Abort(MPI_COMM_WORLD,1);
3638c764dc5SJose Roman   }
364d9822059SBarry Smith   PetscFunctionReturnVoid();
365d9822059SBarry Smith }
366d9822059SBarry Smith #endif
367d9822059SBarry Smith 
368480cf27aSJed Brown #undef __FUNCT__
369480cf27aSJed Brown #define __FUNCT__ "Petsc_DelCounter"
370480cf27aSJed Brown /*
371480cf27aSJed Brown    Private routine to delete internal tag/name counter storage when a communicator is freed.
372480cf27aSJed Brown 
373ff0e51ddSBarry 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.
374480cf27aSJed Brown 
375480cf27aSJed Brown    Note: this is declared extern "C" because it is passed to MPI_Keyval_create()
376480cf27aSJed Brown 
377480cf27aSJed Brown */
3788cc058d9SJed Brown PETSC_EXTERN PetscMPIInt MPIAPI Petsc_DelCounter(MPI_Comm comm,PetscMPIInt keyval,void *count_val,void *extra_state)
379480cf27aSJed Brown {
380480cf27aSJed Brown   PetscErrorCode ierr;
381480cf27aSJed Brown 
382480cf27aSJed Brown   PetscFunctionBegin;
383480cf27aSJed Brown   ierr = PetscInfo1(0,"Deleting counter data in an MPI_Comm %ld\n",(long)comm);if (ierr) PetscFunctionReturn((PetscMPIInt)ierr);
384480cf27aSJed Brown   ierr = PetscFree(count_val);if (ierr) PetscFunctionReturn((PetscMPIInt)ierr);
385480cf27aSJed Brown   PetscFunctionReturn(MPI_SUCCESS);
386480cf27aSJed Brown }
387480cf27aSJed Brown 
388480cf27aSJed Brown #undef __FUNCT__
389da3039f7SJed Brown #define __FUNCT__ "Petsc_DelComm_Outer"
390480cf27aSJed Brown /*
391da3039f7SJed Brown   This is invoked on the outer comm as a result of either PetscCommDestroy() (via MPI_Attr_delete) or when the user
392da3039f7SJed Brown   calls MPI_Comm_free().
393da3039f7SJed Brown 
394da3039f7SJed Brown   This is the only entry point for breaking the links between inner and outer comms.
395480cf27aSJed Brown 
396ff0e51ddSBarry Smith   This is called by MPI, not by users. This is called when MPI_Comm_free() is called on the communicator.
397480cf27aSJed Brown 
398480cf27aSJed Brown   Note: this is declared extern "C" because it is passed to MPI_Keyval_create()
399480cf27aSJed Brown 
400480cf27aSJed Brown */
401da3039f7SJed Brown PETSC_EXTERN PetscMPIInt MPIAPI Petsc_DelComm_Outer(MPI_Comm comm,PetscMPIInt keyval,void *attr_val,void *extra_state)
402480cf27aSJed Brown {
403480cf27aSJed Brown   PetscErrorCode ierr;
404b89831e5SBarry Smith   PetscMPIInt    flg;
405265f3f35SJed Brown   union {MPI_Comm comm; void *ptr;} icomm,ocomm;
406480cf27aSJed Brown 
407480cf27aSJed Brown   PetscFunctionBegin;
408da3039f7SJed Brown   if (keyval != Petsc_InnerComm_keyval) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_CORRUPT,"Unexpected keyval");
409ec4fadc2SJed Brown   icomm.ptr = attr_val;
410da3039f7SJed Brown 
411265f3f35SJed Brown   ierr = MPI_Attr_get(icomm.comm,Petsc_OuterComm_keyval,&ocomm,&flg);CHKERRQ(ierr);
412b3ef52cdSBarry Smith   if (!flg) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_CORRUPT,"Inner MPI_Comm does not have expected reference to outer comm");
413da3039f7SJed Brown   if (ocomm.comm != comm) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_CORRUPT,"Inner MPI_Comm has reference to non-matching outer comm");
414da3039f7SJed Brown   ierr = MPI_Attr_delete(icomm.comm,Petsc_OuterComm_keyval);CHKERRQ(ierr); /* Calls Petsc_DelComm_Inner */
415da3039f7SJed 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);
416da3039f7SJed Brown   PetscFunctionReturn(MPI_SUCCESS);
417b89831e5SBarry Smith }
418da3039f7SJed Brown 
419da3039f7SJed Brown #undef __FUNCT__
420da3039f7SJed Brown #define __FUNCT__ "Petsc_DelComm_Inner"
421da3039f7SJed Brown /*
422da3039f7SJed Brown  * This is invoked on the inner comm when Petsc_DelComm_Outer calls MPI_Attr_delete.  It should not be reached any other way.
423da3039f7SJed Brown  */
424da3039f7SJed Brown PETSC_EXTERN PetscMPIInt MPIAPI Petsc_DelComm_Inner(MPI_Comm comm,PetscMPIInt keyval,void *attr_val,void *extra_state)
425da3039f7SJed Brown {
426da3039f7SJed Brown   PetscErrorCode ierr;
427da3039f7SJed Brown 
428da3039f7SJed Brown   PetscFunctionBegin;
429da3039f7SJed Brown   ierr = PetscInfo1(0,"Removing reference to PETSc communicator embedded in a user MPI_Comm %ld\n",(long)comm);if (ierr) PetscFunctionReturn((PetscMPIInt)ierr);
430480cf27aSJed Brown   PetscFunctionReturn(MPI_SUCCESS);
431480cf27aSJed Brown }
432480cf27aSJed Brown 
433951e3c8eSBarry Smith #if defined(PETSC_USE_PETSC_MPI_EXTERNAL32)
434e39fd77fSBarry Smith #if !defined(PETSC_WORDS_BIGENDIAN)
4358cc058d9SJed Brown PETSC_EXTERN PetscMPIInt PetscDataRep_extent_fn(MPI_Datatype,MPI_Aint*,void*);
4368cc058d9SJed Brown PETSC_EXTERN PetscMPIInt PetscDataRep_read_conv_fn(void*, MPI_Datatype,PetscMPIInt,void*,MPI_Offset,void*);
4378cc058d9SJed Brown PETSC_EXTERN PetscMPIInt PetscDataRep_write_conv_fn(void*, MPI_Datatype,PetscMPIInt,void*,MPI_Offset,void*);
438e39fd77fSBarry Smith #endif
439951e3c8eSBarry Smith #endif
440e39fd77fSBarry Smith 
4416ae9a8a6SBarry Smith int  PetscGlobalArgc   = 0;
4426ae9a8a6SBarry Smith char **PetscGlobalArgs = 0;
443dff31646SBarry Smith PetscSegBuffer PetscCitationsList;
444e5c89e4eSSatish Balay 
445e5c89e4eSSatish Balay #undef __FUNCT__
446051e4cf2SJed Brown #define __FUNCT__ "PetscCitationsInitialize"
447051e4cf2SJed Brown PetscErrorCode PetscCitationsInitialize()
448051e4cf2SJed Brown {
449051e4cf2SJed Brown   PetscErrorCode ierr;
450051e4cf2SJed Brown 
451051e4cf2SJed Brown   PetscFunctionBegin;
452051e4cf2SJed Brown   ierr = PetscSegBufferCreate(1,10000,&PetscCitationsList);CHKERRQ(ierr);
453051e4cf2SJed 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);
454051e4cf2SJed 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);
455051e4cf2SJed Brown   PetscFunctionReturn(0);
456051e4cf2SJed Brown }
457e5c89e4eSSatish Balay 
458e5c89e4eSSatish Balay #undef __FUNCT__
459e5c89e4eSSatish Balay #define __FUNCT__ "PetscGetArgs"
460e5c89e4eSSatish Balay /*@C
461e5c89e4eSSatish Balay    PetscGetArgs - Allows you to access the raw command line arguments anywhere
462e5c89e4eSSatish Balay      after PetscInitialize() is called but before PetscFinalize().
463e5c89e4eSSatish Balay 
464e5c89e4eSSatish Balay    Not Collective
465e5c89e4eSSatish Balay 
466e5c89e4eSSatish Balay    Output Parameters:
467e5c89e4eSSatish Balay +  argc - count of number of command line arguments
468e5c89e4eSSatish Balay -  args - the command line arguments
469e5c89e4eSSatish Balay 
470e5c89e4eSSatish Balay    Level: intermediate
471e5c89e4eSSatish Balay 
472e5c89e4eSSatish Balay    Notes:
473e5c89e4eSSatish Balay       This is usually used to pass the command line arguments into other libraries
474e5c89e4eSSatish Balay    that are called internally deep in PETSc or the application.
475e5c89e4eSSatish Balay 
476f177e3b1SBarry Smith       The first argument contains the program name as is normal for C arguments.
477f177e3b1SBarry Smith 
478e5c89e4eSSatish Balay    Concepts: command line arguments
479e5c89e4eSSatish Balay 
480793721a6SBarry Smith .seealso: PetscFinalize(), PetscInitializeFortran(), PetscGetArguments()
481e5c89e4eSSatish Balay 
482e5c89e4eSSatish Balay @*/
4837087cfbeSBarry Smith PetscErrorCode  PetscGetArgs(int *argc,char ***args)
484e5c89e4eSSatish Balay {
485e5c89e4eSSatish Balay   PetscFunctionBegin;
48617186662SBarry Smith   if (!PetscInitializeCalled && PetscFinalizeCalled) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ORDER,"You must call after PetscInitialize() but before PetscFinalize()");
487e5c89e4eSSatish Balay   *argc = PetscGlobalArgc;
488e5c89e4eSSatish Balay   *args = PetscGlobalArgs;
489e5c89e4eSSatish Balay   PetscFunctionReturn(0);
490e5c89e4eSSatish Balay }
491e5c89e4eSSatish Balay 
492e5c89e4eSSatish Balay #undef __FUNCT__
493793721a6SBarry Smith #define __FUNCT__ "PetscGetArguments"
494793721a6SBarry Smith /*@C
495793721a6SBarry Smith    PetscGetArguments - Allows you to access the  command line arguments anywhere
496793721a6SBarry Smith      after PetscInitialize() is called but before PetscFinalize().
497793721a6SBarry Smith 
498793721a6SBarry Smith    Not Collective
499793721a6SBarry Smith 
500793721a6SBarry Smith    Output Parameters:
501793721a6SBarry Smith .  args - the command line arguments
502793721a6SBarry Smith 
503793721a6SBarry Smith    Level: intermediate
504793721a6SBarry Smith 
505793721a6SBarry Smith    Notes:
506793721a6SBarry Smith       This does NOT start with the program name and IS null terminated (final arg is void)
507793721a6SBarry Smith 
508793721a6SBarry Smith    Concepts: command line arguments
509793721a6SBarry Smith 
510793721a6SBarry Smith .seealso: PetscFinalize(), PetscInitializeFortran(), PetscGetArgs(), PetscFreeArguments()
511793721a6SBarry Smith 
512793721a6SBarry Smith @*/
5137087cfbeSBarry Smith PetscErrorCode  PetscGetArguments(char ***args)
514793721a6SBarry Smith {
515793721a6SBarry Smith   PetscInt       i,argc = PetscGlobalArgc;
516793721a6SBarry Smith   PetscErrorCode ierr;
517793721a6SBarry Smith 
518793721a6SBarry Smith   PetscFunctionBegin;
51917186662SBarry Smith   if (!PetscInitializeCalled && PetscFinalizeCalled) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ORDER,"You must call after PetscInitialize() but before PetscFinalize()");
520717030eeSLisandro Dalcin   if (!argc) {*args = 0; PetscFunctionReturn(0);}
521793721a6SBarry Smith   ierr = PetscMalloc(argc*sizeof(char*),args);CHKERRQ(ierr);
522793721a6SBarry Smith   for (i=0; i<argc-1; i++) {
523793721a6SBarry Smith     ierr = PetscStrallocpy(PetscGlobalArgs[i+1],&(*args)[i]);CHKERRQ(ierr);
524793721a6SBarry Smith   }
525793721a6SBarry Smith   (*args)[argc-1] = 0;
526793721a6SBarry Smith   PetscFunctionReturn(0);
527793721a6SBarry Smith }
528793721a6SBarry Smith 
529793721a6SBarry Smith #undef __FUNCT__
530793721a6SBarry Smith #define __FUNCT__ "PetscFreeArguments"
531793721a6SBarry Smith /*@C
532793721a6SBarry Smith    PetscFreeArguments - Frees the memory obtained with PetscGetArguments()
533793721a6SBarry Smith 
534793721a6SBarry Smith    Not Collective
535793721a6SBarry Smith 
536793721a6SBarry Smith    Output Parameters:
537793721a6SBarry Smith .  args - the command line arguments
538793721a6SBarry Smith 
539793721a6SBarry Smith    Level: intermediate
540793721a6SBarry Smith 
541793721a6SBarry Smith    Concepts: command line arguments
542793721a6SBarry Smith 
543793721a6SBarry Smith .seealso: PetscFinalize(), PetscInitializeFortran(), PetscGetArgs(), PetscGetArguments()
544793721a6SBarry Smith 
545793721a6SBarry Smith @*/
5467087cfbeSBarry Smith PetscErrorCode  PetscFreeArguments(char **args)
547793721a6SBarry Smith {
548793721a6SBarry Smith   PetscInt       i = 0;
549793721a6SBarry Smith   PetscErrorCode ierr;
550793721a6SBarry Smith 
551793721a6SBarry Smith   PetscFunctionBegin;
552a297a907SKarl Rupp   if (!args) PetscFunctionReturn(0);
553793721a6SBarry Smith   while (args[i]) {
554793721a6SBarry Smith     ierr = PetscFree(args[i]);CHKERRQ(ierr);
555793721a6SBarry Smith     i++;
556793721a6SBarry Smith   }
557793721a6SBarry Smith   ierr = PetscFree(args);CHKERRQ(ierr);
558793721a6SBarry Smith   PetscFunctionReturn(0);
559793721a6SBarry Smith }
560793721a6SBarry Smith 
561793721a6SBarry Smith #undef __FUNCT__
562e5c89e4eSSatish Balay #define __FUNCT__ "PetscInitialize"
563e5c89e4eSSatish Balay /*@C
564e5c89e4eSSatish Balay    PetscInitialize - Initializes the PETSc database and MPI.
565e5c89e4eSSatish Balay    PetscInitialize() calls MPI_Init() if that has yet to be called,
566e5c89e4eSSatish Balay    so this routine should always be called near the beginning of
567e5c89e4eSSatish Balay    your program -- usually the very first line!
568e5c89e4eSSatish Balay 
569e5c89e4eSSatish Balay    Collective on MPI_COMM_WORLD or PETSC_COMM_WORLD if it has been set
570e5c89e4eSSatish Balay 
571e5c89e4eSSatish Balay    Input Parameters:
572e5c89e4eSSatish Balay +  argc - count of number of command line arguments
573e5c89e4eSSatish Balay .  args - the command line arguments
5740298fd71SBarry Smith .  file - [optional] PETSc database file, also checks ~username/.petscrc and .petscrc use NULL to not check for
575fc2bca9aSBarry Smith           code specific file. Use -skip_petscrc in the code specific file to skip the .petscrc files
5760298fd71SBarry Smith -  help - [optional] Help message to print, use NULL for no message
577e5c89e4eSSatish Balay 
57805827820SBarry Smith    If you wish PETSc code to run ONLY on a subcommunicator of MPI_COMM_WORLD, create that
57905827820SBarry Smith    communicator first and assign it to PETSC_COMM_WORLD BEFORE calling PetscInitialize(). Thus if you are running a
58005827820SBarry Smith    four process job and two processes will run PETSc and have PetscInitialize() and PetscFinalize() and two process will not,
58105827820SBarry Smith    then do this. If ALL processes in the job are using PetscInitialize() and PetscFinalize() then you don't need to do this, even
58205827820SBarry Smith    if different subcommunicators of the job are doing different things with PETSc.
583e5c89e4eSSatish Balay 
584e5c89e4eSSatish Balay    Options Database Keys:
585e5c89e4eSSatish Balay +  -start_in_debugger [noxterm,dbx,xdb,gdb,...] - Starts program in debugger
586e5c89e4eSSatish Balay .  -on_error_attach_debugger [noxterm,dbx,xdb,gdb,...] - Starts debugger when error detected
587e5c89e4eSSatish Balay .  -on_error_emacs <machinename> causes emacsclient to jump to error file
588b52f573bSBarry Smith .  -on_error_abort calls abort() when error detected (no traceback)
589e8fb0fc0SBarry Smith .  -on_error_mpiabort calls MPI_abort() when error detected
590e8fb0fc0SBarry Smith .  -error_output_stderr prints error messages to stderr instead of the default stdout
591e8fb0fc0SBarry Smith .  -error_output_none does not print the error messages (but handles errors in the same way as if this was not called)
592e5c89e4eSSatish Balay .  -debugger_nodes [node1,node2,...] - Indicates nodes to start in debugger
593e5c89e4eSSatish Balay .  -debugger_pause [sleeptime] (in seconds) - Pauses debugger
594e5c89e4eSSatish Balay .  -stop_for_debugger - Print message on how to attach debugger manually to
595e5c89e4eSSatish Balay                         process and wait (-debugger_pause) seconds for attachment
5962fb0ec9aSBarry Smith .  -malloc - Indicates use of PETSc error-checking malloc (on by default for debug version of libraries)
597e5c89e4eSSatish Balay .  -malloc no - Indicates not to use error-checking malloc
5982fb0ec9aSBarry Smith .  -malloc_debug - check for memory corruption at EVERY malloc or free
599dc92acbaSJed Brown .  -malloc_test - like -malloc_dump -malloc_debug, but only active for debugging builds
600e5c89e4eSSatish Balay .  -fp_trap - Stops on floating point exceptions (Note that on the
601e5c89e4eSSatish Balay               IBM RS6000 this slows code by at least a factor of 10.)
602e5c89e4eSSatish Balay .  -no_signal_handler - Indicates not to trap error signals
603e5c89e4eSSatish Balay .  -shared_tmp - indicates /tmp directory is shared by all processors
604e5c89e4eSSatish Balay .  -not_shared_tmp - each processor has own /tmp
605e5c89e4eSSatish Balay .  -tmp - alternative name of /tmp directory
606e5c89e4eSSatish Balay .  -get_total_flops - returns total flops done by all processors
60740ab9619SBarry Smith .  -memory_info - Print memory usage at end of run
60840ab9619SBarry Smith -  -server <port> - start PETSc webserver (default port is 8080)
609e5c89e4eSSatish Balay 
610e5c89e4eSSatish Balay    Options Database Keys for Profiling:
6110598bfebSBarry Smith    See the <a href="../../docs/manual.pdf#nameddest=ch_profiling">profiling chapter of the users manual</a> for details.
612495fc317SBarry Smith +  -info <optional filename> - Prints verbose information to the screen
613495fc317SBarry Smith .  -info_exclude <null,vec,mat,pc,ksp,snes,ts> - Excludes some of the verbose messages
614495fc317SBarry Smith .  -log_sync - Log the synchronization in scatters, inner products and norms
615495fc317SBarry Smith .  -log_trace [filename] - Print traces of all PETSc calls to the screen (useful to determine where a program
616e5c89e4eSSatish Balay         hangs without running in the debugger).  See PetscLogTraceBegin().
617495fc317SBarry Smith .  -log_summary [filename] - Prints summary of flop and timing information to screen. If the filename is specified the
618495fc317SBarry Smith         summary is written to the file.  See PetscLogView().
619495fc317SBarry Smith .  -log_summary_python [filename] - Prints data on of flop and timing usage to a file or screen. See PetscLogPrintSViewPython().
620495fc317SBarry Smith .  -log_all [filename] - Logs extensive profiling information  See PetscLogDump().
621495fc317SBarry Smith .  -log [filename] - Logs basic profiline information  See PetscLogDump().
622495fc317SBarry Smith -  -log_mpe [filename] - Creates a logfile viewable by the utility Jumpshot (in MPICH distribution)
623495fc317SBarry Smith 
624495fc317SBarry Smith     Only one of -log_trace, -log_summary, -log_all, -log, or -log_mpe may be used at a time
625e5c89e4eSSatish Balay 
626e5c89e4eSSatish Balay    Environmental Variables:
627e5c89e4eSSatish Balay +   PETSC_TMP - alternative tmp directory
628e5c89e4eSSatish Balay .   PETSC_SHARED_TMP - tmp is shared by all processes
629e5c89e4eSSatish Balay .   PETSC_NOT_SHARED_TMP - each process has its own private tmp
630e5c89e4eSSatish Balay .   PETSC_VIEWER_SOCKET_PORT - socket number to use for socket viewer
631e5c89e4eSSatish Balay -   PETSC_VIEWER_SOCKET_MACHINE - machine to use for socket viewer to connect to
632e5c89e4eSSatish Balay 
633e5c89e4eSSatish Balay 
634e5c89e4eSSatish Balay    Level: beginner
635e5c89e4eSSatish Balay 
636e5c89e4eSSatish Balay    Notes:
637e5c89e4eSSatish Balay    If for some reason you must call MPI_Init() separately, call
638e5c89e4eSSatish Balay    it before PetscInitialize().
639e5c89e4eSSatish Balay 
640e5c89e4eSSatish Balay    Fortran Version:
641e5c89e4eSSatish Balay    In Fortran this routine has the format
642e5c89e4eSSatish Balay $       call PetscInitialize(file,ierr)
643e5c89e4eSSatish Balay 
644e5c89e4eSSatish Balay +   ierr - error return code
6450298fd71SBarry Smith -  file - [optional] PETSc database file, also checks ~username/.petscrc and .petscrc use NULL_CHARACTER to not check for
646fc2bca9aSBarry Smith           code specific file. Use -skip_petscrc in the code specific file to skip the .petscrc files
647e5c89e4eSSatish Balay 
648e5c89e4eSSatish Balay    Important Fortran Note:
6490298fd71SBarry Smith    In Fortran, you MUST use NULL_CHARACTER to indicate a
6500298fd71SBarry Smith    null character string; you CANNOT just use NULL as
6510598bfebSBarry Smith    in the C version. See the <a href="../../docs/manual.pdf">users manual</a> for details.
652e5c89e4eSSatish Balay 
65301cb0274SBarry Smith    If your main program is C but you call Fortran code that also uses PETSc you need to call PetscInitializeFortran() soon after
65401cb0274SBarry Smith    calling PetscInitialize().
655e5c89e4eSSatish Balay 
656e5c89e4eSSatish Balay    Concepts: initializing PETSc
657e5c89e4eSSatish Balay 
65801cb0274SBarry Smith .seealso: PetscFinalize(), PetscInitializeFortran(), PetscGetArgs(), PetscInitializeNoArguments()
659e5c89e4eSSatish Balay 
660e5c89e4eSSatish Balay @*/
6617087cfbeSBarry Smith PetscErrorCode  PetscInitialize(int *argc,char ***args,const char file[],const char help[])
662e5c89e4eSSatish Balay {
663e5c89e4eSSatish Balay   PetscErrorCode ierr;
6644bb5149bSJed Brown   PetscMPIInt    flag, size;
665aa5bb8c0SSatish Balay   PetscInt       nodesize;
666ace3abfcSBarry Smith   PetscBool      flg;
667e5c89e4eSSatish Balay   char           hostname[256];
668e5c89e4eSSatish Balay 
669e5c89e4eSSatish Balay   PetscFunctionBegin;
670e5c89e4eSSatish Balay   if (PetscInitializeCalled) PetscFunctionReturn(0);
671e5c89e4eSSatish Balay 
672ae9b4142SLisandro Dalcin   /* these must be initialized in a routine, not as a constant declaration*/
673d89683f4Sbcordonn   PETSC_STDOUT = stdout;
674ae9b4142SLisandro Dalcin   PETSC_STDERR = stderr;
675e5c89e4eSSatish Balay 
676e5c89e4eSSatish Balay   ierr = PetscOptionsCreate();CHKERRQ(ierr);
677e5c89e4eSSatish Balay 
678e5c89e4eSSatish Balay   /*
679e5c89e4eSSatish Balay      We initialize the program name here (before MPI_Init()) because MPICH has a bug in
680e5c89e4eSSatish Balay      it that it sets args[0] on all processors to be args[0] on the first processor.
681e5c89e4eSSatish Balay   */
682e5c89e4eSSatish Balay   if (argc && *argc) {
683e5c89e4eSSatish Balay     ierr = PetscSetProgramName(**args);CHKERRQ(ierr);
684e5c89e4eSSatish Balay   } else {
685e5c89e4eSSatish Balay     ierr = PetscSetProgramName("Unknown Name");CHKERRQ(ierr);
686e5c89e4eSSatish Balay   }
687e5c89e4eSSatish Balay 
688e5c89e4eSSatish Balay   ierr = MPI_Initialized(&flag);CHKERRQ(ierr);
689e5c89e4eSSatish Balay   if (!flag) {
690e32f2f54SBarry 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");
6915e765c61SJed Brown #if defined(PETSC_HAVE_MPI_INIT_THREAD)
6925e765c61SJed Brown     {
6935e765c61SJed Brown       PetscMPIInt provided;
6945e765c61SJed Brown       ierr = MPI_Init_thread(argc,args,MPI_THREAD_FUNNELED,&provided);CHKERRQ(ierr);
6955e765c61SJed Brown     }
6965e765c61SJed Brown #else
697e5c89e4eSSatish Balay     ierr = MPI_Init(argc,args);CHKERRQ(ierr);
6985e765c61SJed Brown #endif
699e5c89e4eSSatish Balay     PetscBeganMPI = PETSC_TRUE;
700e5c89e4eSSatish Balay   }
701e5c89e4eSSatish Balay   if (argc && args) {
702e5c89e4eSSatish Balay     PetscGlobalArgc = *argc;
703e5c89e4eSSatish Balay     PetscGlobalArgs = *args;
704e5c89e4eSSatish Balay   }
705e5c89e4eSSatish Balay   PetscFinalizeCalled = PETSC_FALSE;
706e5c89e4eSSatish Balay 
707a297a907SKarl Rupp   if (PETSC_COMM_WORLD == MPI_COMM_NULL) PETSC_COMM_WORLD = MPI_COMM_WORLD;
708d54338ecSKarl Rupp   ierr = MPI_Comm_set_errhandler(PETSC_COMM_WORLD,MPI_ERRORS_RETURN);CHKERRQ(ierr);
709e5c89e4eSSatish Balay 
710e5c89e4eSSatish Balay   /* Done after init due to a bug in MPICH-GM? */
711e5c89e4eSSatish Balay   ierr = PetscErrorPrintfInitialize();CHKERRQ(ierr);
712e5c89e4eSSatish Balay 
713e5c89e4eSSatish Balay   ierr = MPI_Comm_rank(MPI_COMM_WORLD,&PetscGlobalRank);CHKERRQ(ierr);
714e5c89e4eSSatish Balay   ierr = MPI_Comm_size(MPI_COMM_WORLD,&PetscGlobalSize);CHKERRQ(ierr);
715e5c89e4eSSatish Balay 
7168ad47952SJed Brown   MPIU_BOOL = MPI_INT;
7178ad47952SJed Brown   MPIU_ENUM = MPI_INT;
7188ad47952SJed Brown 
719e5c89e4eSSatish Balay   /*
720e5c89e4eSSatish Balay      Initialized the global complex variable; this is because with
721e5c89e4eSSatish Balay      shared libraries the constructors for global variables
722e5c89e4eSSatish Balay      are not called; at least on IRIX.
723e5c89e4eSSatish Balay   */
724886cfec0SSatish Balay #if defined(PETSC_HAVE_COMPLEX)
725e5c89e4eSSatish Balay   {
726a24ee22aSSatish Balay #if defined(PETSC_CLANGUAGE_CXX)
72750f81f78SJed Brown     PetscComplex ic(0.0,1.0);
728e5c89e4eSSatish Balay     PETSC_i = ic;
729a24ee22aSSatish Balay #elif defined(PETSC_CLANGUAGE_C)
73050f81f78SJed Brown     PETSC_i = _Complex_I;
731b7940d39SSatish Balay #endif
732762437b8SSatish Balay   }
733762437b8SSatish Balay 
7342c876bd9SBarry Smith #if !defined(PETSC_HAVE_MPI_C_DOUBLE_COMPLEX)
735e69cd0e6SSatish Balay   ierr = MPI_Type_contiguous(2,MPI_DOUBLE,&MPIU_C_DOUBLE_COMPLEX);CHKERRQ(ierr);
736500d8756SSatish Balay   ierr = MPI_Type_commit(&MPIU_C_DOUBLE_COMPLEX);CHKERRQ(ierr);
737500d8756SSatish Balay   ierr = MPI_Type_contiguous(2,MPI_FLOAT,&MPIU_C_COMPLEX);CHKERRQ(ierr);
738500d8756SSatish Balay   ierr = MPI_Type_commit(&MPIU_C_COMPLEX);CHKERRQ(ierr);
7392c876bd9SBarry Smith #endif
740886cfec0SSatish Balay #endif /* PETSC_HAVE_COMPLEX */
741e5c89e4eSSatish Balay 
742e5c89e4eSSatish Balay   /*
743e5c89e4eSSatish Balay      Create the PETSc MPI reduction operator that sums of the first
744e5c89e4eSSatish Balay      half of the entries and maxes the second half.
745e5c89e4eSSatish Balay   */
746e5c89e4eSSatish Balay   ierr = MPI_Op_create(PetscMaxSum_Local,1,&PetscMaxSum_Op);CHKERRQ(ierr);
747e5c89e4eSSatish Balay 
748ce63c4c1SBarry Smith #if defined(PETSC_USE_REAL___FLOAT128)
749c90a1750SBarry Smith   ierr = MPI_Type_contiguous(2,MPI_DOUBLE,&MPIU___FLOAT128);CHKERRQ(ierr);
750c90a1750SBarry Smith   ierr = MPI_Type_commit(&MPIU___FLOAT128);CHKERRQ(ierr);
7517c2de775SJed Brown #if defined(PETSC_HAVE_COMPLEX)
7528c764dc5SJose Roman   ierr = MPI_Type_contiguous(4,MPI_DOUBLE,&MPIU___COMPLEX128);CHKERRQ(ierr);
7538c764dc5SJose Roman   ierr = MPI_Type_commit(&MPIU___COMPLEX128);CHKERRQ(ierr);
7548c764dc5SJose Roman #endif
755d9822059SBarry Smith   ierr = MPI_Op_create(PetscMax_Local,1,&MPIU_MAX);CHKERRQ(ierr);
756d9822059SBarry Smith   ierr = MPI_Op_create(PetscMin_Local,1,&MPIU_MIN);CHKERRQ(ierr);
757c90a1750SBarry Smith #endif
758c90a1750SBarry Smith 
7597c2de775SJed Brown #if (defined(PETSC_HAVE_COMPLEX) && !defined(PETSC_HAVE_MPI_C_DOUBLE_COMPLEX)) || defined(PETSC_USE_REAL___FLOAT128)
760cca4cb22SSatish Balay   ierr = MPI_Op_create(PetscSum_Local,1,&MPIU_SUM);CHKERRQ(ierr);
761cca4cb22SSatish Balay #endif
762cca4cb22SSatish Balay 
763e5c89e4eSSatish Balay   ierr = MPI_Type_contiguous(2,MPIU_SCALAR,&MPIU_2SCALAR);CHKERRQ(ierr);
764e5c89e4eSSatish Balay   ierr = MPI_Type_commit(&MPIU_2SCALAR);CHKERRQ(ierr);
765e5c89e4eSSatish Balay   ierr = MPI_Op_create(PetscADMax_Local,1,&PetscADMax_Op);CHKERRQ(ierr);
766e5c89e4eSSatish Balay   ierr = MPI_Op_create(PetscADMin_Local,1,&PetscADMin_Op);CHKERRQ(ierr);
767e5c89e4eSSatish Balay 
76844041f26SJed Brown #if defined(PETSC_USE_64BIT_INDICES) || !defined(MPI_2INT)
769e5c89e4eSSatish Balay   ierr = MPI_Type_contiguous(2,MPIU_INT,&MPIU_2INT);CHKERRQ(ierr);
770e5c89e4eSSatish Balay   ierr = MPI_Type_commit(&MPIU_2INT);CHKERRQ(ierr);
77144041f26SJed Brown #endif
772e5c89e4eSSatish Balay 
773e5c89e4eSSatish Balay   /*
774480cf27aSJed Brown      Attributes to be set on PETSc communicators
775480cf27aSJed Brown   */
776480cf27aSJed Brown   ierr = MPI_Keyval_create(MPI_NULL_COPY_FN,Petsc_DelCounter,&Petsc_Counter_keyval,(void*)0);CHKERRQ(ierr);
777da3039f7SJed Brown   ierr = MPI_Keyval_create(MPI_NULL_COPY_FN,Petsc_DelComm_Outer,&Petsc_InnerComm_keyval,(void*)0);CHKERRQ(ierr);
778da3039f7SJed Brown   ierr = MPI_Keyval_create(MPI_NULL_COPY_FN,Petsc_DelComm_Inner,&Petsc_OuterComm_keyval,(void*)0);CHKERRQ(ierr);
779480cf27aSJed Brown 
780480cf27aSJed Brown   /*
781e8fb0fc0SBarry Smith      Build the options database
782e5c89e4eSSatish Balay   */
783e5c89e4eSSatish Balay   ierr = PetscOptionsInsert(argc,args,file);CHKERRQ(ierr);
784e5c89e4eSSatish Balay 
7856dc8fec2Sbcordonn 
786e5c89e4eSSatish Balay   /*
787e5c89e4eSSatish Balay      Print main application help message
788e5c89e4eSSatish Balay   */
7890298fd71SBarry Smith   ierr = PetscOptionsHasName(NULL,"-help",&flg);CHKERRQ(ierr);
790e5c89e4eSSatish Balay   if (help && flg) {
791e5c89e4eSSatish Balay     ierr = PetscPrintf(PETSC_COMM_WORLD,help);CHKERRQ(ierr);
792e5c89e4eSSatish Balay   }
793e5c89e4eSSatish Balay   ierr = PetscOptionsCheckInitial_Private();CHKERRQ(ierr);
794e5c89e4eSSatish Balay 
795e5c89e4eSSatish Balay   /* SHOULD PUT IN GUARDS: Make sure logging is initialized, even if we do not print it out */
796a9f03627SSatish Balay #if defined(PETSC_USE_LOG)
797e5c89e4eSSatish Balay   ierr = PetscLogBegin_Private();CHKERRQ(ierr);
798a9f03627SSatish Balay #endif
799e5c89e4eSSatish Balay 
800e5c89e4eSSatish Balay   /*
801e5c89e4eSSatish Balay      Load the dynamic libraries (on machines that support them), this registers all
802e5c89e4eSSatish Balay      the solvers etc. (On non-dynamic machines this initializes the PetscDraw and PetscViewer classes)
803e5c89e4eSSatish Balay   */
804e5c89e4eSSatish Balay   ierr = PetscInitialize_DynamicLibraries();CHKERRQ(ierr);
805e5c89e4eSSatish Balay 
806e5c89e4eSSatish Balay   ierr = MPI_Comm_size(PETSC_COMM_WORLD,&size);CHKERRQ(ierr);
807ae15b995SBarry Smith   ierr = PetscInfo1(0,"PETSc successfully started: number of processors = %d\n",size);CHKERRQ(ierr);
808e5c89e4eSSatish Balay   ierr = PetscGetHostName(hostname,256);CHKERRQ(ierr);
809ae15b995SBarry Smith   ierr = PetscInfo1(0,"Running on machine: %s\n",hostname);CHKERRQ(ierr);
810e5c89e4eSSatish Balay 
811e5c89e4eSSatish Balay   ierr = PetscOptionsCheckInitial_Components();CHKERRQ(ierr);
812ef6c6fedSBoyana Norris   /* Check the options database for options related to the options database itself */
813ef6c6fedSBoyana Norris   ierr = PetscOptionsSetFromOptions();CHKERRQ(ierr);
814ef6c6fedSBoyana Norris 
815951e3c8eSBarry Smith #if defined(PETSC_USE_PETSC_MPI_EXTERNAL32)
816e39fd77fSBarry Smith   /*
817e39fd77fSBarry Smith       Tell MPI about our own data representation converter, this would/should be used if extern32 is not supported by the MPI
818e39fd77fSBarry Smith 
819e39fd77fSBarry Smith       Currently not used because it is not supported by MPICH.
820e39fd77fSBarry Smith   */
821e39fd77fSBarry Smith #if !defined(PETSC_WORDS_BIGENDIAN)
8220298fd71SBarry Smith   ierr = MPI_Register_datarep((char*)"petsc",PetscDataRep_read_conv_fn,PetscDataRep_write_conv_fn,PetscDataRep_extent_fn,NULL);CHKERRQ(ierr);
823e39fd77fSBarry Smith #endif
824951e3c8eSBarry Smith #endif
825e39fd77fSBarry Smith 
8260298fd71SBarry Smith   ierr = PetscOptionsGetInt(NULL,"-hmpi_spawn_size",&nodesize,&flg);CHKERRQ(ierr);
827793721a6SBarry Smith   if (flg) {
82823464e94SBarry Smith #if defined(PETSC_HAVE_MPI_COMM_SPAWN)
82985afcc9aSBarry Smith     ierr = PetscHMPISpawn((PetscMPIInt) nodesize);CHKERRQ(ierr); /* worker nodes never return from here; they go directly to PetscEnd() */
83023464e94SBarry Smith #else
83185afcc9aSBarry Smith     SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SUP,"PETSc built without MPI 2 (MPI_Comm_spawn) support, use -hmpi_merge_size instead");
83223464e94SBarry Smith #endif
833793721a6SBarry Smith   } else {
8340298fd71SBarry Smith     ierr = PetscOptionsGetInt(NULL,"-hmpi_merge_size",&nodesize,&flg);CHKERRQ(ierr);
8358002f1cdSBarry Smith     if (flg) {
8360298fd71SBarry Smith       ierr = PetscHMPIMerge((PetscMPIInt) nodesize,NULL,NULL);CHKERRQ(ierr);
83785afcc9aSBarry Smith       if (PetscHMPIWorker) { /* if worker then never enter user code */
838bad7cb1dSBarry Smith         PetscInitializeCalled = PETSC_TRUE;
8393bf036e2SBarry Smith         PetscEnd();
8409505b675SBarry Smith       }
8418002f1cdSBarry Smith     }
842793721a6SBarry Smith   }
843e5c89e4eSSatish Balay 
84435d88935SVictor Minden #if defined(PETSC_HAVE_CUDA)
8454bb5149bSJed Brown   {
8464bb5149bSJed Brown     PetscMPIInt p;
847663ba86aSMatthew G Knepley     for (p = 0; p < PetscGlobalSize; ++p) {
848a297a907SKarl Rupp       if (p == PetscGlobalRank) cublasInit();
849663ba86aSMatthew G Knepley       ierr = MPI_Barrier(PETSC_COMM_WORLD);CHKERRQ(ierr);
850663ba86aSMatthew G Knepley     }
8514bb5149bSJed Brown   }
8523e39abd9SVictor Minden #endif
85392e62aa6SBarry Smith 
8540298fd71SBarry Smith   ierr = PetscOptionsHasName(NULL,"-python",&flg);CHKERRQ(ierr);
8559ac80d5eSLisandro Dalcin   if (flg) {
8569ac80d5eSLisandro Dalcin     PetscInitializeCalled = PETSC_TRUE;
8570298fd71SBarry Smith     ierr = PetscPythonInitialize(NULL,NULL);CHKERRQ(ierr);
8589ac80d5eSLisandro Dalcin   }
8599ac80d5eSLisandro Dalcin 
860607a6623SBarry Smith   ierr = PetscThreadCommInitializePackage();CHKERRQ(ierr);
861bd8b14e7SShri Abhyankar 
86241c0b4b3SShri Abhyankar   /*
86341c0b4b3SShri Abhyankar       Setup building of stack frames for all function calls
86441c0b4b3SShri Abhyankar   */
865e1167bb9SShri Abhyankar #if defined(PETSC_USE_DEBUG)
866047240e1SBarry Smith   PetscThreadLocalRegister((PetscThreadKey*)&petscstack); /* Creates petscstack_key if needed */
867e1167bb9SShri Abhyankar   ierr = PetscStackCreate();CHKERRQ(ierr);
868e1167bb9SShri Abhyankar #endif
869e1167bb9SShri Abhyankar 
8702d53ad75SBarry Smith #if defined(PETSC_SERIALIZE_FUNCTIONS)
8712d53ad75SBarry Smith   ierr = PetscFPTCreate(10000);CHKERRQ(ierr);
8722d53ad75SBarry Smith #endif
8732d53ad75SBarry Smith 
874051e4cf2SJed Brown   ierr = PetscCitationsInitialize();CHKERRQ(ierr);
875dff31646SBarry Smith 
876301d30feSBarry Smith   /*
877301d30feSBarry Smith       Once we are completedly initialized then we can set this variables
878301d30feSBarry Smith   */
879301d30feSBarry Smith   PetscInitializeCalled = PETSC_TRUE;
880301d30feSBarry Smith   PetscFunctionReturn(0);
881e5c89e4eSSatish Balay }
882e5c89e4eSSatish Balay 
8832eff7a51SBarry Smith extern PetscObject *PetscObjects;
8842eff7a51SBarry Smith extern PetscInt    PetscObjectsCounts, PetscObjectsMaxCounts;
885e5c89e4eSSatish Balay 
886e5c89e4eSSatish Balay #undef __FUNCT__
887e5c89e4eSSatish Balay #define __FUNCT__ "PetscFinalize"
888e5c89e4eSSatish Balay /*@C
889e5c89e4eSSatish Balay    PetscFinalize - Checks for options to be called at the conclusion
890e5c89e4eSSatish Balay    of the program. MPI_Finalize() is called only if the user had not
891e5c89e4eSSatish Balay    called MPI_Init() before calling PetscInitialize().
892e5c89e4eSSatish Balay 
893e5c89e4eSSatish Balay    Collective on PETSC_COMM_WORLD
894e5c89e4eSSatish Balay 
895e5c89e4eSSatish Balay    Options Database Keys:
89688c29154SBarry Smith +  -options_table - Calls PetscOptionsView()
897e5c89e4eSSatish Balay .  -options_left - Prints unused options that remain in the database
8987eb1d149SBarry 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
899e5c89e4eSSatish Balay .  -mpidump - Calls PetscMPIDump()
900e5c89e4eSSatish Balay .  -malloc_dump - Calls PetscMallocDump()
901e5c89e4eSSatish Balay .  -malloc_info - Prints total memory usage
902e5c89e4eSSatish Balay -  -malloc_log - Prints summary of memory usage
903e5c89e4eSSatish Balay 
904e5c89e4eSSatish Balay    Level: beginner
905e5c89e4eSSatish Balay 
906e5c89e4eSSatish Balay    Note:
907e5c89e4eSSatish Balay    See PetscInitialize() for more general runtime options.
908e5c89e4eSSatish Balay 
90988c29154SBarry Smith .seealso: PetscInitialize(), PetscOptionsView(), PetscMallocDump(), PetscMPIDump(), PetscEnd()
910e5c89e4eSSatish Balay @*/
9117087cfbeSBarry Smith PetscErrorCode  PetscFinalize(void)
912e5c89e4eSSatish Balay {
913e5c89e4eSSatish Balay   PetscErrorCode ierr;
9144bb5149bSJed Brown   PetscMPIInt    rank;
915a8d2bbe5SBarry Smith   PetscInt       nopt;
9162bf49c77SBarry Smith   PetscBool      flg1 = PETSC_FALSE,flg2 = PETSC_FALSE,flg3 = PETSC_FALSE;
917dff31646SBarry Smith   PetscBool      flg;
91810463e74SBarry Smith #if defined(PETSC_USE_LOG)
91910463e74SBarry Smith   char           mname[PETSC_MAX_PATH_LEN];
92010463e74SBarry Smith #endif
921e5c89e4eSSatish Balay 
922e5c89e4eSSatish Balay   PetscFunctionBegin;
923e5c89e4eSSatish Balay   if (!PetscInitializeCalled) {
9244b09e917SBarry Smith     printf("PetscInitialize() must be called before PetscFinalize()\n");
9254b09e917SBarry Smith     PetscFunctionReturn(PETSC_ERR_ARG_WRONGSTATE);
926e5c89e4eSSatish Balay   }
9270298fd71SBarry Smith   ierr = PetscInfo(NULL,"PetscFinalize() called\n");CHKERRQ(ierr);
928b022a5c1SBarry Smith 
9291f817a21SBarry Smith   ierr = MPI_Comm_rank(PETSC_COMM_WORLD,&rank);CHKERRQ(ierr);
9301f817a21SBarry Smith 
9311f817a21SBarry Smith   ierr = PetscOptionsHasName(NULL,"-citations",&flg);CHKERRQ(ierr);
932dff31646SBarry Smith   if (flg) {
9331f817a21SBarry Smith     char  *cits, filename[PETSC_MAX_PATH_LEN];
9341f817a21SBarry Smith     FILE  *fd = PETSC_STDOUT;
9351f817a21SBarry Smith 
9361f817a21SBarry Smith     ierr = PetscOptionsGetString(NULL,"-citations",filename,PETSC_MAX_PATH_LEN,NULL);CHKERRQ(ierr);
9371f817a21SBarry Smith     if (filename[0]) {
9381f817a21SBarry Smith       ierr = PetscFOpen(PETSC_COMM_WORLD,filename,"w",&fd);CHKERRQ(ierr);
9391f817a21SBarry Smith     }
940dff31646SBarry Smith     ierr = PetscSegBufferGet(PetscCitationsList,1,&cits);CHKERRQ(ierr);
941dff31646SBarry Smith     cits[0] = 0;
942dff31646SBarry Smith     ierr = PetscSegBufferExtractAlloc(PetscCitationsList,&cits);CHKERRQ(ierr);
9431f817a21SBarry Smith     ierr = PetscFPrintf(PETSC_COMM_WORLD,fd,"If you publish results based on this computation please cite the following:\n");CHKERRQ(ierr);
9441f817a21SBarry Smith     ierr = PetscFPrintf(PETSC_COMM_WORLD,fd,"===========================================================================\n");CHKERRQ(ierr);
9451f817a21SBarry Smith     ierr = PetscFPrintf(PETSC_COMM_WORLD,fd,"%s",cits);CHKERRQ(ierr);
9461f817a21SBarry Smith     ierr = PetscFPrintf(PETSC_COMM_WORLD,fd,"===========================================================================\n");CHKERRQ(ierr);
9471f817a21SBarry Smith     ierr = PetscFClose(PETSC_COMM_WORLD,fd);CHKERRQ(ierr);
948dff31646SBarry Smith     ierr = PetscFree(cits);CHKERRQ(ierr);
949dff31646SBarry Smith   }
950dff31646SBarry Smith   ierr = PetscSegBufferDestroy(&PetscCitationsList);CHKERRQ(ierr);
951dff31646SBarry Smith 
9522d53ad75SBarry Smith #if defined(PETSC_SERIALIZE_FUNCTIONS)
9532d53ad75SBarry Smith   ierr = PetscFPTDestroy();CHKERRQ(ierr);
9542d53ad75SBarry Smith #endif
9552d53ad75SBarry Smith 
9562d53ad75SBarry Smith 
957d5649816SBarry Smith #if defined(PETSC_HAVE_AMS)
958dff31646SBarry Smith   flg = PETSC_FALSE;
9590298fd71SBarry Smith   ierr = PetscOptionsGetBool(NULL,"-options_gui",&flg,NULL);CHKERRQ(ierr);
960d5649816SBarry Smith   if (flg) {
961d5649816SBarry Smith     ierr = PetscOptionsAMSDestroy();CHKERRQ(ierr);
962d5649816SBarry Smith   }
963d5649816SBarry Smith #endif
964d5649816SBarry Smith 
9656d065ec1SBarry Smith #if defined(PETSC_HAVE_SERVER)
9662d139d8fSBarry Smith   flg1 = PETSC_FALSE;
9672d139d8fSBarry Smith   ierr = PetscOptionsGetBool(NULL,"-server",&flg1,NULL);CHKERRQ(ierr);
9682d139d8fSBarry Smith   if (flg1) {
9696d065ec1SBarry Smith     /*  this is a crude hack, but better than nothing */
9702d139d8fSBarry Smith     ierr = PetscPOpen(PETSC_COMM_WORLD,NULL,"pkill -9 petscwebserver","r",NULL);CHKERRQ(ierr);
9712d139d8fSBarry Smith   }
9726d065ec1SBarry Smith #endif
9732d139d8fSBarry Smith 
974*681455b2SBarry Smith #if defined(PETSC_HAVE_X)
975*681455b2SBarry Smith   flg1 = PETSC_FALSE;
976*681455b2SBarry Smith   ierr = PetscOptionsGetBool(NULL,"-x_virtual",&flg1,NULL);CHKERRQ(ierr);
977*681455b2SBarry Smith   if (flg1) {
978*681455b2SBarry Smith     /*  this is a crude hack, but better than nothing */
979*681455b2SBarry Smith     ierr = PetscPOpen(PETSC_COMM_WORLD,NULL,"pkill -9 Xvfb","r",NULL);CHKERRQ(ierr);
980*681455b2SBarry Smith   }
981*681455b2SBarry Smith #endif
982*681455b2SBarry Smith 
98385afcc9aSBarry Smith   ierr = PetscHMPIFinalize();CHKERRQ(ierr);
984d3f95da6SShri Abhyankar 
9850298fd71SBarry Smith   ierr = PetscOptionsGetBool(NULL,"-malloc_info",&flg2,NULL);CHKERRQ(ierr);
986e5c89e4eSSatish Balay   if (!flg2) {
98790d69ab7SBarry Smith     flg2 = PETSC_FALSE;
9880298fd71SBarry Smith     ierr = PetscOptionsGetBool(NULL,"-memory_info",&flg2,NULL);CHKERRQ(ierr);
989e5c89e4eSSatish Balay   }
990e5c89e4eSSatish Balay   if (flg2) {
991e5c89e4eSSatish Balay     ierr = PetscMemoryShowUsage(PETSC_VIEWER_STDOUT_WORLD,"Summary of Memory Usage in PETSc\n");CHKERRQ(ierr);
992e5c89e4eSSatish Balay   }
993e5c89e4eSSatish Balay 
994e5c89e4eSSatish Balay #if defined(PETSC_USE_LOG)
99590d69ab7SBarry Smith   flg1 = PETSC_FALSE;
9960298fd71SBarry Smith   ierr = PetscOptionsGetBool(NULL,"-get_total_flops",&flg1,NULL);CHKERRQ(ierr);
997e5c89e4eSSatish Balay   if (flg1) {
998e5c89e4eSSatish Balay     PetscLogDouble flops = 0;
999205a32c2SJed Brown     ierr = MPI_Reduce(&petsc_TotalFlops,&flops,1,MPI_DOUBLE,MPI_SUM,0,PETSC_COMM_WORLD);CHKERRQ(ierr);
1000e5c89e4eSSatish Balay     ierr = PetscPrintf(PETSC_COMM_WORLD,"Total flops over all processors %g\n",flops);CHKERRQ(ierr);
1001e5c89e4eSSatish Balay   }
1002e5c89e4eSSatish Balay #endif
1003e5c89e4eSSatish Balay 
1004e5c89e4eSSatish Balay 
1005e5c89e4eSSatish Balay #if defined(PETSC_USE_LOG)
1006e5c89e4eSSatish Balay #if defined(PETSC_HAVE_MPE)
1007e5c89e4eSSatish Balay   mname[0] = 0;
1008a297a907SKarl Rupp 
10090298fd71SBarry Smith   ierr = PetscOptionsGetString(NULL,"-log_mpe",mname,PETSC_MAX_PATH_LEN,&flg1);CHKERRQ(ierr);
1010e5c89e4eSSatish Balay   if (flg1) {
1011e5c89e4eSSatish Balay     if (mname[0]) {ierr = PetscLogMPEDump(mname);CHKERRQ(ierr);}
1012e5c89e4eSSatish Balay     else          {ierr = PetscLogMPEDump(0);CHKERRQ(ierr);}
1013e5c89e4eSSatish Balay   }
1014e5c89e4eSSatish Balay #endif
1015e5c89e4eSSatish Balay   mname[0] = 0;
1016a297a907SKarl Rupp 
10170298fd71SBarry Smith   ierr = PetscOptionsGetString(NULL,"-log_summary",mname,PETSC_MAX_PATH_LEN,&flg1);CHKERRQ(ierr);
1018e5c89e4eSSatish Balay   if (flg1) {
101991eabc43SBarry Smith     PetscViewer viewer;
102091eabc43SBarry Smith     if (mname[0]) {
102191eabc43SBarry Smith       ierr = PetscViewerASCIIOpen(PETSC_COMM_WORLD,mname,&viewer);CHKERRQ(ierr);
102291eabc43SBarry Smith       ierr = PetscLogView(viewer);CHKERRQ(ierr);
10236bf464f9SBarry Smith       ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr);
102433f85c2fSBarry Smith     } else {
102533f85c2fSBarry Smith       viewer = PETSC_VIEWER_STDOUT_WORLD;
102633f85c2fSBarry Smith       ierr   = PetscLogView(viewer);CHKERRQ(ierr);
102733f85c2fSBarry Smith     }
1028e5c89e4eSSatish Balay   }
1029e5c89e4eSSatish Balay 
1030ff5bc46bSBarry Smith   mname[0] = 0;
1031a297a907SKarl Rupp 
10320298fd71SBarry Smith   ierr = PetscOptionsGetString(NULL,"-log_summary_python",mname,PETSC_MAX_PATH_LEN,&flg1);CHKERRQ(ierr);
1033ff5bc46bSBarry Smith   if (flg1) {
1034ff5bc46bSBarry Smith     PetscViewer viewer;
1035ff5bc46bSBarry Smith     if (mname[0]) {
1036ff5bc46bSBarry Smith       ierr = PetscViewerASCIIOpen(PETSC_COMM_WORLD,mname,&viewer);CHKERRQ(ierr);
103791eabc43SBarry Smith       ierr = PetscLogViewPython(viewer);CHKERRQ(ierr);
10386bf464f9SBarry Smith       ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr);
103933f85c2fSBarry Smith     } else {
104033f85c2fSBarry Smith       viewer = PETSC_VIEWER_STDOUT_WORLD;
104133f85c2fSBarry Smith       ierr   = PetscLogViewPython(viewer);CHKERRQ(ierr);
104233f85c2fSBarry Smith     }
1043ff5bc46bSBarry Smith   }
1044ff5bc46bSBarry Smith 
10450298fd71SBarry Smith   ierr = PetscOptionsGetString(NULL,"-log_detailed",mname,PETSC_MAX_PATH_LEN,&flg1);CHKERRQ(ierr);
104678392ef1SBarry Smith   if (flg1) {
104778392ef1SBarry Smith     if (mname[0])  {ierr = PetscLogPrintDetailed(PETSC_COMM_WORLD,mname);CHKERRQ(ierr);}
104878392ef1SBarry Smith     else           {ierr = PetscLogPrintDetailed(PETSC_COMM_WORLD,0);CHKERRQ(ierr);}
104978392ef1SBarry Smith   }
105078392ef1SBarry Smith 
1051e5c89e4eSSatish Balay   mname[0] = 0;
1052a297a907SKarl Rupp 
10530298fd71SBarry Smith   ierr = PetscOptionsGetString(NULL,"-log_all",mname,PETSC_MAX_PATH_LEN,&flg1);CHKERRQ(ierr);
10540298fd71SBarry Smith   ierr = PetscOptionsGetString(NULL,"-log",mname,PETSC_MAX_PATH_LEN,&flg2);CHKERRQ(ierr);
1055e5c89e4eSSatish Balay   if (flg1 || flg2) {
1056e5c89e4eSSatish Balay     if (mname[0]) PetscLogDump(mname);
1057e5c89e4eSSatish Balay     else          PetscLogDump(0);
1058e5c89e4eSSatish Balay   }
1059e5c89e4eSSatish Balay #endif
106010463e74SBarry Smith 
1061b58ca069SBarry Smith   /*
1062b58ca069SBarry Smith      Free all objects registered with PetscObjectRegisterDestroy() such as PETSC_VIEWER_XXX_().
1063b58ca069SBarry Smith   */
1064b58ca069SBarry Smith   ierr = PetscObjectRegisterDestroyAll();CHKERRQ(ierr);
1065b58ca069SBarry Smith 
106633f85c2fSBarry Smith   ierr = PetscStackDestroy();CHKERRQ(ierr);
106710463e74SBarry Smith 
106890d69ab7SBarry Smith   flg1 = PETSC_FALSE;
10690298fd71SBarry Smith   ierr = PetscOptionsGetBool(NULL,"-no_signal_handler",&flg1,NULL);CHKERRQ(ierr);
1070e5c89e4eSSatish Balay   if (!flg1) { ierr = PetscPopSignalHandler();CHKERRQ(ierr);}
107190d69ab7SBarry Smith   flg1 = PETSC_FALSE;
10720298fd71SBarry Smith   ierr = PetscOptionsGetBool(NULL,"-mpidump",&flg1,NULL);CHKERRQ(ierr);
1073e5c89e4eSSatish Balay   if (flg1) {
1074e5c89e4eSSatish Balay     ierr = PetscMPIDump(stdout);CHKERRQ(ierr);
1075e5c89e4eSSatish Balay   }
107690d69ab7SBarry Smith   flg1 = PETSC_FALSE;
107790d69ab7SBarry Smith   flg2 = PETSC_FALSE;
10788bb29257SSatish Balay   /* preemptive call to avoid listing this option in options table as unused */
10790298fd71SBarry Smith   ierr = PetscOptionsHasName(NULL,"-malloc_dump",&flg1);CHKERRQ(ierr);
10800298fd71SBarry Smith   ierr = PetscOptionsHasName(NULL,"-objects_dump",&flg1);CHKERRQ(ierr);
10810298fd71SBarry Smith   ierr = PetscOptionsGetBool(NULL,"-options_table",&flg2,NULL);CHKERRQ(ierr);
1082e4c476e2SSatish Balay 
1083e5c89e4eSSatish Balay   if (flg2) {
1084be56827dSJed Brown     PetscViewer viewer;
1085be56827dSJed Brown     ierr = PetscViewerASCIIGetStdout(PETSC_COMM_WORLD,&viewer);CHKERRQ(ierr);
1086be56827dSJed Brown     ierr = PetscOptionsView(viewer);CHKERRQ(ierr);
1087be56827dSJed Brown     ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr);
1088e5c89e4eSSatish Balay   }
1089e5c89e4eSSatish Balay 
1090e5c89e4eSSatish Balay   /* to prevent PETSc -options_left from warning */
10910298fd71SBarry Smith   ierr = PetscOptionsHasName(NULL,"-nox",&flg1);CHKERRQ(ierr);
10920298fd71SBarry Smith   ierr = PetscOptionsHasName(NULL,"-nox_warning",&flg1);CHKERRQ(ierr);
1093e5c89e4eSSatish Balay 
109485afcc9aSBarry Smith   if (!PetscHMPIWorker) { /* worker processes skip this because they do not usually process options */
109533fc4174SSatish Balay     flg3 = PETSC_FALSE; /* default value is required */
10960298fd71SBarry Smith     ierr = PetscOptionsGetBool(NULL,"-options_left",&flg3,&flg1);CHKERRQ(ierr);
1097e5c89e4eSSatish Balay     ierr = PetscOptionsAllUsed(&nopt);CHKERRQ(ierr);
1098e5c89e4eSSatish Balay     if (flg3) {
1099e5c89e4eSSatish Balay       if (!flg2) { /* have not yet printed the options */
1100be56827dSJed Brown         PetscViewer viewer;
1101be56827dSJed Brown         ierr = PetscViewerASCIIGetStdout(PETSC_COMM_WORLD,&viewer);CHKERRQ(ierr);
1102be56827dSJed Brown         ierr = PetscOptionsView(viewer);CHKERRQ(ierr);
1103be56827dSJed Brown         ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr);
1104e5c89e4eSSatish Balay       }
1105e5c89e4eSSatish Balay       if (!nopt) {
1106e5c89e4eSSatish Balay         ierr = PetscPrintf(PETSC_COMM_WORLD,"There are no unused options.\n");CHKERRQ(ierr);
1107e5c89e4eSSatish Balay       } else if (nopt == 1) {
1108e5c89e4eSSatish Balay         ierr = PetscPrintf(PETSC_COMM_WORLD,"There is one unused database option. It is:\n");CHKERRQ(ierr);
1109e5c89e4eSSatish Balay       } else {
11107582186dSLisandro Dalcin         ierr = PetscPrintf(PETSC_COMM_WORLD,"There are %D unused database options. They are:\n",nopt);CHKERRQ(ierr);
1111e5c89e4eSSatish Balay       }
1112e5c89e4eSSatish Balay     }
1113e5c89e4eSSatish Balay #if defined(PETSC_USE_DEBUG)
1114da8b8a77SBarry Smith     if (nopt && !flg3 && !flg1) {
1115e5c89e4eSSatish Balay       ierr = PetscPrintf(PETSC_COMM_WORLD,"WARNING! There are options you set that were not used!\n");CHKERRQ(ierr);
1116e5c89e4eSSatish Balay       ierr = PetscPrintf(PETSC_COMM_WORLD,"WARNING! could be spelling mistake, etc!\n");CHKERRQ(ierr);
1117e5c89e4eSSatish Balay       ierr = PetscOptionsLeft();CHKERRQ(ierr);
1118e5c89e4eSSatish Balay     } else if (nopt && flg3) {
1119e5c89e4eSSatish Balay #else
1120e5c89e4eSSatish Balay     if (nopt && flg3) {
1121e5c89e4eSSatish Balay #endif
1122e5c89e4eSSatish Balay       ierr = PetscOptionsLeft();CHKERRQ(ierr);
1123e5c89e4eSSatish Balay     }
1124931f367cSBarry Smith   }
1125e5c89e4eSSatish Balay 
1126eea2bdeeSJed Brown   {
1127eea2bdeeSJed Brown     PetscThreadComm tcomm_world;
1128eea2bdeeSJed Brown     ierr = PetscGetThreadCommWorld(&tcomm_world);CHKERRQ(ierr);
1129eea2bdeeSJed Brown     /* Free global thread communicator */
1130eea2bdeeSJed Brown     ierr = PetscThreadCommDestroy(&tcomm_world);CHKERRQ(ierr);
1131eea2bdeeSJed Brown   }
1132eea2bdeeSJed Brown 
113310463e74SBarry Smith   /*
1134dbc8283eSBarry Smith        List all objects the user may have forgot to free
11352eff7a51SBarry Smith   */
11360298fd71SBarry Smith   ierr = PetscOptionsHasName(NULL,"-objects_dump",&flg1);CHKERRQ(ierr);
1137a64a8e02SBarry Smith   if (flg1) {
1138a64a8e02SBarry Smith     MPI_Comm local_comm;
11397eb1d149SBarry Smith     char     string[64];
1140a64a8e02SBarry Smith 
11410298fd71SBarry Smith     ierr = PetscOptionsGetString(NULL,"-objects_dump",string,64,NULL);CHKERRQ(ierr);
1142a64a8e02SBarry Smith     ierr = MPI_Comm_dup(MPI_COMM_WORLD,&local_comm);CHKERRQ(ierr);
1143a64a8e02SBarry Smith     ierr = PetscSequentialPhaseBegin_Private(local_comm,1);CHKERRQ(ierr);
11447eb1d149SBarry Smith     ierr = PetscObjectsDump(stdout,(string[0] == 'a') ? PETSC_TRUE : PETSC_FALSE);CHKERRQ(ierr);
1145a64a8e02SBarry Smith     ierr = PetscSequentialPhaseEnd_Private(local_comm,1);CHKERRQ(ierr);
1146a64a8e02SBarry Smith     ierr = MPI_Comm_free(&local_comm);CHKERRQ(ierr);
11470a1571b3SBarry Smith   }
1148dbc8283eSBarry Smith   PetscObjectsCounts    = 0;
1149dbc8283eSBarry Smith   PetscObjectsMaxCounts = 0;
11502eff7a51SBarry Smith 
1151a297a907SKarl Rupp   ierr = PetscFree(PetscObjects);CHKERRQ(ierr);
11522eff7a51SBarry Smith 
115333f85c2fSBarry Smith #if defined(PETSC_USE_LOG)
115433f85c2fSBarry Smith   ierr = PetscLogDestroy();CHKERRQ(ierr);
115533f85c2fSBarry Smith #endif
115633f85c2fSBarry Smith 
115733f85c2fSBarry Smith   /*
115833f85c2fSBarry Smith      Destroy any packages that registered a finalize
115933f85c2fSBarry Smith   */
116033f85c2fSBarry Smith   ierr = PetscRegisterFinalizeAll();CHKERRQ(ierr);
116133f85c2fSBarry Smith 
116233f85c2fSBarry Smith   /*
116310463e74SBarry Smith      Destroy all the function registration lists created
116410463e74SBarry Smith   */
116510463e74SBarry Smith   ierr = PetscFinalize_DynamicLibraries();CHKERRQ(ierr);
116610463e74SBarry Smith 
116748dd1dffSBarry Smith   /*
116848dd1dffSBarry Smith      Print PetscFunctionLists that have not been properly freed
116948dd1dffSBarry Smith 
117037e93019SBarry Smith   ierr = PetscFunctionListPrintAll();CHKERRQ(ierr);
117148dd1dffSBarry Smith   */
117237e93019SBarry Smith 
11734028d114SSatish Balay   if (petsc_history) {
1174f3dea69dSBarry Smith     ierr = PetscCloseHistoryFile(&petsc_history);CHKERRQ(ierr);
1175e5c89e4eSSatish Balay     petsc_history = 0;
1176e5c89e4eSSatish Balay   }
1177e5c89e4eSSatish Balay 
11780298fd71SBarry Smith   ierr = PetscInfoAllow(PETSC_FALSE,NULL);CHKERRQ(ierr);
1179e5c89e4eSSatish Balay 
11808bb29257SSatish Balay   {
1181e5c89e4eSSatish Balay     char fname[PETSC_MAX_PATH_LEN];
1182e5c89e4eSSatish Balay     FILE *fd;
1183ed9cf6e9SBarry Smith     int  err;
1184e5c89e4eSSatish Balay 
1185e5c89e4eSSatish Balay     fname[0] = 0;
1186a297a907SKarl Rupp 
11870298fd71SBarry Smith     ierr = PetscOptionsGetString(NULL,"-malloc_dump",fname,250,&flg1);CHKERRQ(ierr);
1188dc92acbaSJed Brown     flg2 = PETSC_FALSE;
11890298fd71SBarry Smith     ierr = PetscOptionsGetBool(NULL,"-malloc_test",&flg2,NULL);CHKERRQ(ierr);
11908bf1f09cSShri Abhyankar #if defined(PETSC_USE_DEBUG)
1191dc92acbaSJed Brown     if (PETSC_RUNNING_ON_VALGRIND) flg2 = PETSC_FALSE;
1192dc92acbaSJed Brown #else
1193dc92acbaSJed Brown     flg2 = PETSC_FALSE;         /* Skip reporting for optimized builds regardless of -malloc_test */
1194dc92acbaSJed Brown #endif
1195e5c89e4eSSatish Balay     if (flg1 && fname[0]) {
1196e5c89e4eSSatish Balay       char sname[PETSC_MAX_PATH_LEN];
1197e5c89e4eSSatish Balay 
1198e5c89e4eSSatish Balay       sprintf(sname,"%s_%d",fname,rank);
1199e32f2f54SBarry Smith       fd   = fopen(sname,"w"); if (!fd) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_FILE_OPEN,"Cannot open log file: %s",sname);
1200e5c89e4eSSatish Balay       ierr = PetscMallocDump(fd);CHKERRQ(ierr);
1201ed9cf6e9SBarry Smith       err  = fclose(fd);
1202e32f2f54SBarry Smith       if (err) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SYS,"fclose() failed on file");
1203dc92acbaSJed Brown     } else if (flg1 || flg2) {
1204e5c89e4eSSatish Balay       MPI_Comm local_comm;
1205e5c89e4eSSatish Balay 
1206e5c89e4eSSatish Balay       ierr = MPI_Comm_dup(MPI_COMM_WORLD,&local_comm);CHKERRQ(ierr);
1207e5c89e4eSSatish Balay       ierr = PetscSequentialPhaseBegin_Private(local_comm,1);CHKERRQ(ierr);
1208e5c89e4eSSatish Balay       ierr = PetscMallocDump(stdout);CHKERRQ(ierr);
1209e5c89e4eSSatish Balay       ierr = PetscSequentialPhaseEnd_Private(local_comm,1);CHKERRQ(ierr);
1210e5c89e4eSSatish Balay       ierr = MPI_Comm_free(&local_comm);CHKERRQ(ierr);
1211e5c89e4eSSatish Balay     }
1212e5c89e4eSSatish Balay   }
1213a64a8e02SBarry Smith 
12148bb29257SSatish Balay   {
1215e5c89e4eSSatish Balay     char fname[PETSC_MAX_PATH_LEN];
12160298fd71SBarry Smith     FILE *fd = NULL;
1217e5c89e4eSSatish Balay 
1218e5c89e4eSSatish Balay     fname[0] = 0;
1219a297a907SKarl Rupp 
12200298fd71SBarry Smith     ierr = PetscOptionsGetString(NULL,"-malloc_log",fname,250,&flg1);CHKERRQ(ierr);
12210298fd71SBarry Smith     ierr = PetscOptionsHasName(NULL,"-malloc_log_threshold",&flg2);CHKERRQ(ierr);
1222e5c89e4eSSatish Balay     if (flg1 && fname[0]) {
1223ed9cf6e9SBarry Smith       int err;
1224e5c89e4eSSatish Balay 
1225574034a9SJed Brown       if (!rank) {
1226574034a9SJed Brown         fd = fopen(fname,"w");
1227574034a9SJed Brown         if (!fd) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_FILE_OPEN,"Cannot open log file: %s",fname);
1228574034a9SJed Brown       }
1229e5c89e4eSSatish Balay       ierr = PetscMallocDumpLog(fd);CHKERRQ(ierr);
1230574034a9SJed Brown       if (fd) {
1231ed9cf6e9SBarry Smith         err = fclose(fd);
1232e32f2f54SBarry Smith         if (err) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SYS,"fclose() failed on file");
1233574034a9SJed Brown       }
1234574034a9SJed Brown     } else if (flg1 || flg2) {
1235e5c89e4eSSatish Balay       ierr = PetscMallocDumpLog(stdout);CHKERRQ(ierr);
1236e5c89e4eSSatish Balay     }
1237e5c89e4eSSatish Balay   }
1238e5c89e4eSSatish Balay   /* Can be destroyed only after all the options are used */
1239e5c89e4eSSatish Balay   ierr = PetscOptionsDestroy();CHKERRQ(ierr);
1240e5c89e4eSSatish Balay 
1241e5c89e4eSSatish Balay   PetscGlobalArgc = 0;
1242e5c89e4eSSatish Balay   PetscGlobalArgs = 0;
1243e5c89e4eSSatish Balay 
1244ce63c4c1SBarry Smith #if defined(PETSC_USE_REAL___FLOAT128)
1245c90a1750SBarry Smith   ierr = MPI_Type_free(&MPIU___FLOAT128);CHKERRQ(ierr);
12467c2de775SJed Brown #if defined(PETSC_HAVE_COMPLEX)
12478c764dc5SJose Roman   ierr = MPI_Type_free(&MPIU___COMPLEX128);CHKERRQ(ierr);
12488c764dc5SJose Roman #endif
1249d9822059SBarry Smith   ierr = MPI_Op_free(&MPIU_MAX);CHKERRQ(ierr);
1250d9822059SBarry Smith   ierr = MPI_Op_free(&MPIU_MIN);CHKERRQ(ierr);
1251c90a1750SBarry Smith #endif
1252c90a1750SBarry Smith 
12537c2de775SJed Brown #if defined(PETSC_HAVE_COMPLEX)
12542c876bd9SBarry Smith #if !defined(PETSC_HAVE_MPI_C_DOUBLE_COMPLEX)
1255500d8756SSatish Balay   ierr = MPI_Type_free(&MPIU_C_DOUBLE_COMPLEX);CHKERRQ(ierr);
1256500d8756SSatish Balay   ierr = MPI_Type_free(&MPIU_C_COMPLEX);CHKERRQ(ierr);
12572c876bd9SBarry Smith #endif
1258e5c89e4eSSatish Balay #endif
1259cca4cb22SSatish Balay 
12607c2de775SJed Brown #if (defined(PETSC_HAVE_COMPLEX) && !defined(PETSC_HAVE_MPI_C_DOUBLE_COMPLEX)) || defined(PETSC_USE_REAL___FLOAT128)
1261cca4cb22SSatish Balay   ierr = MPI_Op_free(&MPIU_SUM);CHKERRQ(ierr);
1262cca4cb22SSatish Balay #endif
1263cca4cb22SSatish Balay 
1264e5c89e4eSSatish Balay   ierr = MPI_Type_free(&MPIU_2SCALAR);CHKERRQ(ierr);
126544041f26SJed Brown #if defined(PETSC_USE_64BIT_INDICES) || !defined(MPI_2INT)
1266e5c89e4eSSatish Balay   ierr = MPI_Type_free(&MPIU_2INT);CHKERRQ(ierr);
126744041f26SJed Brown #endif
1268e5c89e4eSSatish Balay   ierr = MPI_Op_free(&PetscMaxSum_Op);CHKERRQ(ierr);
1269e5c89e4eSSatish Balay   ierr = MPI_Op_free(&PetscADMax_Op);CHKERRQ(ierr);
1270e5c89e4eSSatish Balay   ierr = MPI_Op_free(&PetscADMin_Op);CHKERRQ(ierr);
1271e5c89e4eSSatish Balay 
1272dbc8283eSBarry Smith   /*
1273efb80d3cSBarry Smith      Destroy any known inner MPI_Comm's and attributes pointing to them
1274efb80d3cSBarry Smith      Note this will not destroy any new communicators the user has created.
1275efb80d3cSBarry Smith 
1276efb80d3cSBarry Smith      If all PETSc objects were not destroyed those left over objects will have hanging references to
1277efb80d3cSBarry Smith      the MPI_Comms that were freed; but that is ok because those PETSc objects will never be used again
1278dbc8283eSBarry Smith  */
1279b770b1f6SSatish Balay   {
1280dbc8283eSBarry Smith     PetscCommCounter *counter;
1281dbc8283eSBarry Smith     PetscMPIInt      flg;
1282dbc8283eSBarry Smith     MPI_Comm         icomm;
1283265f3f35SJed Brown     union {MPI_Comm comm; void *ptr;} ucomm;
1284265f3f35SJed Brown     ierr = MPI_Attr_get(PETSC_COMM_SELF,Petsc_InnerComm_keyval,&ucomm,&flg);CHKERRQ(ierr);
1285dbc8283eSBarry Smith     if (flg) {
1286265f3f35SJed Brown       icomm = ucomm.comm;
1287dbc8283eSBarry Smith       ierr = MPI_Attr_get(icomm,Petsc_Counter_keyval,&counter,&flg);CHKERRQ(ierr);
1288dbc8283eSBarry 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");
1289dbc8283eSBarry Smith 
1290dbc8283eSBarry Smith       ierr = MPI_Attr_delete(PETSC_COMM_SELF,Petsc_InnerComm_keyval);CHKERRQ(ierr);
1291efb80d3cSBarry Smith       ierr = MPI_Attr_delete(icomm,Petsc_Counter_keyval);CHKERRQ(ierr);
1292efb80d3cSBarry Smith       ierr = MPI_Comm_free(&icomm);CHKERRQ(ierr);
1293dbc8283eSBarry Smith     }
1294265f3f35SJed Brown     ierr = MPI_Attr_get(PETSC_COMM_WORLD,Petsc_InnerComm_keyval,&ucomm,&flg);CHKERRQ(ierr);
1295dbc8283eSBarry Smith     if (flg) {
1296265f3f35SJed Brown       icomm = ucomm.comm;
1297dbc8283eSBarry Smith       ierr = MPI_Attr_get(icomm,Petsc_Counter_keyval,&counter,&flg);CHKERRQ(ierr);
1298dbc8283eSBarry 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");
1299dbc8283eSBarry Smith 
1300dbc8283eSBarry Smith       ierr = MPI_Attr_delete(PETSC_COMM_WORLD,Petsc_InnerComm_keyval);CHKERRQ(ierr);
1301efb80d3cSBarry Smith       ierr = MPI_Attr_delete(icomm,Petsc_Counter_keyval);CHKERRQ(ierr);
1302efb80d3cSBarry Smith       ierr = MPI_Comm_free(&icomm);CHKERRQ(ierr);
1303dbc8283eSBarry Smith     }
1304b770b1f6SSatish Balay   }
1305dbc8283eSBarry Smith 
1306480cf27aSJed Brown   ierr = MPI_Keyval_free(&Petsc_Counter_keyval);CHKERRQ(ierr);
1307480cf27aSJed Brown   ierr = MPI_Keyval_free(&Petsc_InnerComm_keyval);CHKERRQ(ierr);
1308480cf27aSJed Brown   ierr = MPI_Keyval_free(&Petsc_OuterComm_keyval);CHKERRQ(ierr);
1309480cf27aSJed Brown 
1310663ba86aSMatthew G Knepley #if defined(PETSC_HAVE_CUDA)
13114bb5149bSJed Brown   {
13124bb5149bSJed Brown     PetscInt p;
1313663ba86aSMatthew G Knepley     for (p = 0; p < PetscGlobalSize; ++p) {
1314a297a907SKarl Rupp       if (p == PetscGlobalRank) cublasShutdown();
1315663ba86aSMatthew G Knepley       ierr = MPI_Barrier(PETSC_COMM_WORLD);CHKERRQ(ierr);
1316663ba86aSMatthew G Knepley     }
13174bb5149bSJed Brown   }
1318663ba86aSMatthew G Knepley #endif
1319663ba86aSMatthew G Knepley 
1320e5c89e4eSSatish Balay   if (PetscBeganMPI) {
132199608316SBarry Smith #if defined(PETSC_HAVE_MPI_FINALIZED)
132299b1327fSBarry Smith     PetscMPIInt flag;
132399b1327fSBarry Smith     ierr = MPI_Finalized(&flag);CHKERRQ(ierr);
1324e32f2f54SBarry Smith     if (flag) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_LIB,"MPI_Finalize() has already been called, even though MPI_Init() was called by PetscInitialize()");
132599608316SBarry Smith #endif
1326e5c89e4eSSatish Balay     ierr = MPI_Finalize();CHKERRQ(ierr);
1327e5c89e4eSSatish Balay   }
1328e5c89e4eSSatish Balay /*
1329e5c89e4eSSatish Balay 
1330e5c89e4eSSatish Balay      Note: In certain cases PETSC_COMM_WORLD is never MPI_Comm_free()ed because
1331e5c89e4eSSatish Balay    the communicator has some outstanding requests on it. Specifically if the
1332e5c89e4eSSatish Balay    flag PETSC_HAVE_BROKEN_REQUEST_FREE is set (for IBM MPI implementation). See
1333e5c89e4eSSatish Balay    src/vec/utils/vpscat.c. Due to this the memory allocated in PetscCommDuplicate()
1334e5c89e4eSSatish Balay    is never freed as it should be. Thus one may obtain messages of the form
13350e5e90baSSatish Balay    [ 1] 8 bytes PetscCommDuplicate() line 645 in src/sys/mpiu.c indicating the
1336e5c89e4eSSatish Balay    memory was not freed.
1337e5c89e4eSSatish Balay 
1338e5c89e4eSSatish Balay */
13391d1a0024SBarry Smith   ierr = PetscMallocClear();CHKERRQ(ierr);
1340a297a907SKarl Rupp 
1341e5c89e4eSSatish Balay   PetscInitializeCalled = PETSC_FALSE;
1342e5c89e4eSSatish Balay   PetscFinalizeCalled   = PETSC_TRUE;
1343e5c89e4eSSatish Balay   PetscFunctionReturn(ierr);
1344e5c89e4eSSatish Balay }
1345e5c89e4eSSatish Balay 
134643db4dbbSBarry Smith #if defined(PETSC_MISSING_LAPACK_lsame_)
13478cc058d9SJed Brown PETSC_EXTERN int lsame_(char *a,char *b)
134843db4dbbSBarry Smith {
134943db4dbbSBarry Smith   if (*a == *b) return 1;
135043db4dbbSBarry Smith   if (*a + 32 == *b) return 1;
135143db4dbbSBarry Smith   if (*a - 32 == *b) return 1;
135243db4dbbSBarry Smith   return 0;
135343db4dbbSBarry Smith }
1354a70650f6SBarry Smith #endif
135543db4dbbSBarry Smith 
135643db4dbbSBarry Smith #if defined(PETSC_MISSING_LAPACK_lsame)
13578cc058d9SJed Brown PETSC_EXTERN int lsame(char *a,char *b)
135843db4dbbSBarry Smith {
135943db4dbbSBarry Smith   if (*a == *b) return 1;
136043db4dbbSBarry Smith   if (*a + 32 == *b) return 1;
136143db4dbbSBarry Smith   if (*a - 32 == *b) return 1;
136243db4dbbSBarry Smith   return 0;
136343db4dbbSBarry Smith }
136443db4dbbSBarry Smith #endif
1365