xref: /petsc/src/sys/objects/pinit.c (revision 20e2c33252c083ae472ed01d23233c3c5d62af9d)
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 
54e5c89e4eSSatish Balay /*
55e5c89e4eSSatish Balay        Checks the options database for initializations related to the
56e5c89e4eSSatish Balay     PETSc components
57e5c89e4eSSatish Balay */
58e5c89e4eSSatish Balay #undef __FUNCT__
59e5c89e4eSSatish Balay #define __FUNCT__ "PetscOptionsCheckInitial_Components"
607087cfbeSBarry Smith PetscErrorCode  PetscOptionsCheckInitial_Components(void)
61e5c89e4eSSatish Balay {
62ace3abfcSBarry Smith   PetscBool      flg1;
63e5c89e4eSSatish Balay   PetscErrorCode ierr;
64e5c89e4eSSatish Balay 
65e5c89e4eSSatish Balay   PetscFunctionBegin;
660298fd71SBarry Smith   ierr = PetscOptionsHasName(NULL,"-help",&flg1);CHKERRQ(ierr);
67e5c89e4eSSatish Balay   if (flg1) {
68e5c89e4eSSatish Balay #if defined(PETSC_USE_LOG)
69e8e7597cSSatish Balay     MPI_Comm comm = PETSC_COMM_WORLD;
70e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm,"------Additional PETSc component options--------\n");CHKERRQ(ierr);
71e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm," -log_summary_exclude: <vec,mat,pc.ksp,snes>\n");CHKERRQ(ierr);
726cf91177SBarry Smith     ierr = (*PetscHelpPrintf)(comm," -info_exclude: <null,vec,mat,pc,ksp,snes,ts>\n");CHKERRQ(ierr);
73e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm,"-----------------------------------------------\n");CHKERRQ(ierr);
74e5c89e4eSSatish Balay #endif
75e5c89e4eSSatish Balay   }
76e5c89e4eSSatish Balay   PetscFunctionReturn(0);
77e5c89e4eSSatish Balay }
78e5c89e4eSSatish Balay 
79e5c89e4eSSatish Balay #undef __FUNCT__
80945d1669SBarry Smith #define __FUNCT__ "PetscInitializeNoPointers"
810f11a792SBarry Smith /*
82945d1669SBarry Smith       PetscInitializeNoPointers - Calls PetscInitialize() from C/C++ without the pointers to argc and args
8372a42c3cSBarry Smith 
8472a42c3cSBarry Smith    Collective
8572a42c3cSBarry Smith 
8672a42c3cSBarry Smith    Level: advanced
8772a42c3cSBarry Smith 
88945d1669SBarry Smith     Notes: this is called only by the PETSc MATLAB and Julia interface. Even though it might start MPI it sets the flag to
890f11a792SBarry Smith      indicate that it did NOT start MPI so that the PetscFinalize() does not end MPI, thus allowing PetscInitialize() to
90945d1669SBarry Smith      be called multiple times from MATLAB and Julia without the problem of trying to initialize MPI more than once.
910f11a792SBarry Smith 
921ea5a559SBarry Smith      Turns off PETSc signal handling because that can interact with MATLAB's signal handling causing random crashes.
931ea5a559SBarry Smith 
9472a42c3cSBarry Smith .seealso: PetscInitialize(), PetscInitializeFortran(), PetscInitializeNoArguments()
950f11a792SBarry Smith */
96945d1669SBarry Smith PetscErrorCode  PetscInitializeNoPointers(int argc,char **args,const char *filename,const char *help)
9772a42c3cSBarry Smith {
9872a42c3cSBarry Smith   PetscErrorCode ierr;
9972a42c3cSBarry Smith   int            myargc   = argc;
10072a42c3cSBarry Smith   char           **myargs = args;
10172a42c3cSBarry Smith 
10272a42c3cSBarry Smith   PetscFunctionBegin;
1033bf036e2SBarry Smith   ierr = PetscInitialize(&myargc,&myargs,filename,help);CHKERRQ(ierr);
1041ea5a559SBarry Smith   ierr = PetscPopSignalHandler();CHKERRQ(ierr);
105df413903SBarry Smith   PetscBeganMPI = PETSC_FALSE;
10672a42c3cSBarry Smith   PetscFunctionReturn(ierr);
10772a42c3cSBarry Smith }
10872a42c3cSBarry Smith 
10972a42c3cSBarry Smith #undef __FUNCT__
110945d1669SBarry Smith #define __FUNCT__ "PetscGetPETSC_COMM_SELF"
111f0865b08SBarry Smith /*
112945d1669SBarry Smith       Used by MATLAB and Julia interface to get communicator
113f0865b08SBarry Smith */
114945d1669SBarry Smith PetscErrorCode  PetscGetPETSC_COMM_SELF(MPI_Comm *comm)
115f0865b08SBarry Smith {
116f0865b08SBarry Smith   PetscFunctionBegin;
117f0865b08SBarry Smith   *comm = PETSC_COMM_SELF;
118f0865b08SBarry Smith   PetscFunctionReturn(0);
119f0865b08SBarry Smith }
120f0865b08SBarry Smith 
121f0865b08SBarry Smith #undef __FUNCT__
122e5c89e4eSSatish Balay #define __FUNCT__ "PetscInitializeNoArguments"
123e5c89e4eSSatish Balay /*@C
124e5c89e4eSSatish Balay       PetscInitializeNoArguments - Calls PetscInitialize() from C/C++ without
125e5c89e4eSSatish Balay         the command line arguments.
126e5c89e4eSSatish Balay 
127e5c89e4eSSatish Balay    Collective
128e5c89e4eSSatish Balay 
129e5c89e4eSSatish Balay    Level: advanced
130e5c89e4eSSatish Balay 
131e5c89e4eSSatish Balay .seealso: PetscInitialize(), PetscInitializeFortran()
132e5c89e4eSSatish Balay @*/
1337087cfbeSBarry Smith PetscErrorCode  PetscInitializeNoArguments(void)
134e5c89e4eSSatish Balay {
135e5c89e4eSSatish Balay   PetscErrorCode ierr;
136e5c89e4eSSatish Balay   int            argc   = 0;
137e5c89e4eSSatish Balay   char           **args = 0;
138e5c89e4eSSatish Balay 
139e5c89e4eSSatish Balay   PetscFunctionBegin;
1400298fd71SBarry Smith   ierr = PetscInitialize(&argc,&args,NULL,NULL);
141e5c89e4eSSatish Balay   PetscFunctionReturn(ierr);
142e5c89e4eSSatish Balay }
143e5c89e4eSSatish Balay 
144e5c89e4eSSatish Balay #undef __FUNCT__
145e5c89e4eSSatish Balay #define __FUNCT__ "PetscInitialized"
146e5c89e4eSSatish Balay /*@
147e5c89e4eSSatish Balay       PetscInitialized - Determine whether PETSc is initialized.
148e5c89e4eSSatish Balay 
14993b6d2d1SJed Brown    Level: beginner
150e5c89e4eSSatish Balay 
151e5c89e4eSSatish Balay .seealso: PetscInitialize(), PetscInitializeNoArguments(), PetscInitializeFortran()
152e5c89e4eSSatish Balay @*/
1537087cfbeSBarry Smith PetscErrorCode PetscInitialized(PetscBool  *isInitialized)
154e5c89e4eSSatish Balay {
155e5c89e4eSSatish Balay   *isInitialized = PetscInitializeCalled;
15693b6d2d1SJed Brown   return 0;
157e5c89e4eSSatish Balay }
158e5c89e4eSSatish Balay 
159e5c89e4eSSatish Balay #undef __FUNCT__
160e5c89e4eSSatish Balay #define __FUNCT__ "PetscFinalized"
161e5c89e4eSSatish Balay /*@
162e5c89e4eSSatish Balay       PetscFinalized - Determine whether PetscFinalize() has been called yet
163e5c89e4eSSatish Balay 
164e5c89e4eSSatish Balay    Level: developer
165e5c89e4eSSatish Balay 
166e5c89e4eSSatish Balay .seealso: PetscInitialize(), PetscInitializeNoArguments(), PetscInitializeFortran()
167e5c89e4eSSatish Balay @*/
1687087cfbeSBarry Smith PetscErrorCode  PetscFinalized(PetscBool  *isFinalized)
169e5c89e4eSSatish Balay {
170e5c89e4eSSatish Balay   *isFinalized = PetscFinalizeCalled;
17193b6d2d1SJed Brown   return 0;
172e5c89e4eSSatish Balay }
173e5c89e4eSSatish Balay 
17409573ac7SBarry Smith extern PetscErrorCode PetscOptionsCheckInitial_Private(void);
175e5c89e4eSSatish Balay 
176e5c89e4eSSatish Balay /*
177e5c89e4eSSatish Balay        This function is the MPI reduction operation used to compute the sum of the
178e5c89e4eSSatish Balay    first half of the datatype and the max of the second half.
179e5c89e4eSSatish Balay */
180e5c89e4eSSatish Balay MPI_Op PetscMaxSum_Op = 0;
181e5c89e4eSSatish Balay 
182e5c89e4eSSatish Balay #undef __FUNCT__
183e5c89e4eSSatish Balay #define __FUNCT__ "PetscMaxSum_Local"
1848cc058d9SJed Brown PETSC_EXTERN void MPIAPI PetscMaxSum_Local(void *in,void *out,int *cnt,MPI_Datatype *datatype)
185e5c89e4eSSatish Balay {
186e5c89e4eSSatish Balay   PetscInt *xin = (PetscInt*)in,*xout = (PetscInt*)out,i,count = *cnt;
187e5c89e4eSSatish Balay 
188e5c89e4eSSatish Balay   PetscFunctionBegin;
189e5c89e4eSSatish Balay   if (*datatype != MPIU_2INT) {
190e5c89e4eSSatish Balay     (*PetscErrorPrintf)("Can only handle MPIU_2INT data types");
191e5c89e4eSSatish Balay     MPI_Abort(MPI_COMM_WORLD,1);
192e5c89e4eSSatish Balay   }
193e5c89e4eSSatish Balay 
194e5c89e4eSSatish Balay   for (i=0; i<count; i++) {
195e5c89e4eSSatish Balay     xout[2*i]    = PetscMax(xout[2*i],xin[2*i]);
196e5c89e4eSSatish Balay     xout[2*i+1] += xin[2*i+1];
197e5c89e4eSSatish Balay   }
198812af9f3SBarry Smith   PetscFunctionReturnVoid();
199e5c89e4eSSatish Balay }
200e5c89e4eSSatish Balay 
201e5c89e4eSSatish Balay /*
202e5c89e4eSSatish Balay     Returns the max of the first entry owned by this processor and the
203e5c89e4eSSatish Balay sum of the second entry.
204b693b147SBarry Smith 
205b693b147SBarry Smith     The reason nprocs[2*i] contains lengths nprocs[2*i+1] contains flag of 1 if length is nonzero
206b693b147SBarry Smith is so that the PetscMaxSum_Op() can set TWO values, if we passed in only nprocs[i] with lengths
207b693b147SBarry Smith there would be no place to store the both needed results.
208e5c89e4eSSatish Balay */
209e5c89e4eSSatish Balay #undef __FUNCT__
210e5c89e4eSSatish Balay #define __FUNCT__ "PetscMaxSum"
2117087cfbeSBarry Smith PetscErrorCode  PetscMaxSum(MPI_Comm comm,const PetscInt nprocs[],PetscInt *max,PetscInt *sum)
212e5c89e4eSSatish Balay {
213e5c89e4eSSatish Balay   PetscMPIInt    size,rank;
2146ac3741eSJed Brown   struct {PetscInt max,sum;} *work;
215e5c89e4eSSatish Balay   PetscErrorCode ierr;
216e5c89e4eSSatish Balay 
217e5c89e4eSSatish Balay   PetscFunctionBegin;
218e5c89e4eSSatish Balay   ierr = MPI_Comm_size(comm,&size);CHKERRQ(ierr);
219e5c89e4eSSatish Balay   ierr = MPI_Comm_rank(comm,&rank);CHKERRQ(ierr);
2206ac3741eSJed Brown   ierr = PetscMalloc(size*sizeof(*work),&work);CHKERRQ(ierr);
221e5c89e4eSSatish Balay   ierr = MPI_Allreduce((void*)nprocs,work,size,MPIU_2INT,PetscMaxSum_Op,comm);CHKERRQ(ierr);
2226ac3741eSJed Brown   *max = work[rank].max;
2236ac3741eSJed Brown   *sum = work[rank].sum;
224e5c89e4eSSatish Balay   ierr = PetscFree(work);CHKERRQ(ierr);
225e5c89e4eSSatish Balay   PetscFunctionReturn(0);
226e5c89e4eSSatish Balay }
227e5c89e4eSSatish Balay 
228e5c89e4eSSatish Balay /* ----------------------------------------------------------------------------*/
2297087cfbeSBarry Smith MPI_Op  PetscADMax_Op = 0;
230e5c89e4eSSatish Balay 
231e5c89e4eSSatish Balay #undef __FUNCT__
232e5c89e4eSSatish Balay #define __FUNCT__ "PetscADMax_Local"
2338cc058d9SJed Brown PETSC_EXTERN void MPIAPI PetscADMax_Local(void *in,void *out,PetscMPIInt *cnt,MPI_Datatype *datatype)
234e5c89e4eSSatish Balay {
235e5c89e4eSSatish Balay   PetscScalar *xin = (PetscScalar*)in,*xout = (PetscScalar*)out;
236e5c89e4eSSatish Balay   PetscInt    i,count = *cnt;
237e5c89e4eSSatish Balay 
238e5c89e4eSSatish Balay   PetscFunctionBegin;
239e5c89e4eSSatish Balay   if (*datatype != MPIU_2SCALAR) {
240e5c89e4eSSatish Balay     (*PetscErrorPrintf)("Can only handle MPIU_2SCALAR data (i.e. double or complex) types");
241e5c89e4eSSatish Balay     MPI_Abort(MPI_COMM_WORLD,1);
242e5c89e4eSSatish Balay   }
243e5c89e4eSSatish Balay 
244e5c89e4eSSatish Balay   for (i=0; i<count; i++) {
245e5c89e4eSSatish Balay     if (PetscRealPart(xout[2*i]) < PetscRealPart(xin[2*i])) {
246e5c89e4eSSatish Balay       xout[2*i]   = xin[2*i];
247e5c89e4eSSatish Balay       xout[2*i+1] = xin[2*i+1];
248e5c89e4eSSatish Balay     }
249e5c89e4eSSatish Balay   }
250812af9f3SBarry Smith   PetscFunctionReturnVoid();
251e5c89e4eSSatish Balay }
252e5c89e4eSSatish Balay 
2537087cfbeSBarry Smith MPI_Op PetscADMin_Op = 0;
254e5c89e4eSSatish Balay 
255e5c89e4eSSatish Balay #undef __FUNCT__
256e5c89e4eSSatish Balay #define __FUNCT__ "PetscADMin_Local"
2578cc058d9SJed Brown PETSC_EXTERN void MPIAPI PetscADMin_Local(void *in,void *out,PetscMPIInt *cnt,MPI_Datatype *datatype)
258e5c89e4eSSatish Balay {
259e5c89e4eSSatish Balay   PetscScalar *xin = (PetscScalar*)in,*xout = (PetscScalar*)out;
260e5c89e4eSSatish Balay   PetscInt    i,count = *cnt;
261e5c89e4eSSatish Balay 
262e5c89e4eSSatish Balay   PetscFunctionBegin;
263e5c89e4eSSatish Balay   if (*datatype != MPIU_2SCALAR) {
264e5c89e4eSSatish Balay     (*PetscErrorPrintf)("Can only handle MPIU_2SCALAR data (i.e. double or complex) types");
265e5c89e4eSSatish Balay     MPI_Abort(MPI_COMM_WORLD,1);
266e5c89e4eSSatish Balay   }
267e5c89e4eSSatish Balay 
268e5c89e4eSSatish Balay   for (i=0; i<count; i++) {
269e5c89e4eSSatish Balay     if (PetscRealPart(xout[2*i]) > PetscRealPart(xin[2*i])) {
270e5c89e4eSSatish Balay       xout[2*i]   = xin[2*i];
271e5c89e4eSSatish Balay       xout[2*i+1] = xin[2*i+1];
272e5c89e4eSSatish Balay     }
273e5c89e4eSSatish Balay   }
274812af9f3SBarry Smith   PetscFunctionReturnVoid();
275e5c89e4eSSatish Balay }
276e5c89e4eSSatish Balay /* ---------------------------------------------------------------------------------------*/
277e5c89e4eSSatish Balay 
2787c2de775SJed Brown #if (defined(PETSC_HAVE_COMPLEX) && !defined(PETSC_HAVE_MPI_C_DOUBLE_COMPLEX)) || defined(PETSC_USE_REAL___FLOAT128)
27906a205a8SBarry Smith MPI_Op MPIU_SUM = 0;
280e5c89e4eSSatish Balay 
281e5c89e4eSSatish Balay #undef __FUNCT__
282e5c89e4eSSatish Balay #define __FUNCT__ "PetscSum_Local"
2838cc058d9SJed Brown PETSC_EXTERN void PetscSum_Local(void *in,void *out,PetscMPIInt *cnt,MPI_Datatype *datatype)
284e5c89e4eSSatish Balay {
285e5c89e4eSSatish Balay   PetscInt i,count = *cnt;
286e5c89e4eSSatish Balay 
287e5c89e4eSSatish Balay   PetscFunctionBegin;
2887c2de775SJed Brown   if (*datatype == MPIU_REAL) {
289e2e03761SBarry Smith     PetscReal *xin = (PetscReal*)in,*xout = (PetscReal*)out;
290a297a907SKarl Rupp     for (i=0; i<count; i++) xout[i] += xin[i];
2917c2de775SJed Brown   }
2927c2de775SJed Brown #if defined(PETSC_HAVE_COMPLEX)
2937c2de775SJed Brown   else if (*datatype == MPIU_COMPLEX) {
2947c2de775SJed Brown     PetscComplex *xin = (PetscComplex*)in,*xout = (PetscComplex*)out;
295a297a907SKarl Rupp     for (i=0; i<count; i++) xout[i] += xin[i];
2967c2de775SJed Brown   }
2977c2de775SJed Brown #endif
2987c2de775SJed Brown   else {
2997c2de775SJed Brown     (*PetscErrorPrintf)("Can only handle MPIU_REAL or MPIU_COMPLEX data types");
300e2e03761SBarry Smith     MPI_Abort(MPI_COMM_WORLD,1);
301e2e03761SBarry Smith   }
302812af9f3SBarry Smith   PetscFunctionReturnVoid();
303e5c89e4eSSatish Balay }
304e5c89e4eSSatish Balay #endif
305e5c89e4eSSatish Balay 
306ce63c4c1SBarry Smith #if defined(PETSC_USE_REAL___FLOAT128)
307d9822059SBarry Smith MPI_Op MPIU_MAX = 0;
308d9822059SBarry Smith MPI_Op MPIU_MIN = 0;
309d9822059SBarry Smith 
310d9822059SBarry Smith #undef __FUNCT__
311d9822059SBarry Smith #define __FUNCT__ "PetscMax_Local"
3128cc058d9SJed Brown PETSC_EXTERN void PetscMax_Local(void *in,void *out,PetscMPIInt *cnt,MPI_Datatype *datatype)
313d9822059SBarry Smith {
314d9822059SBarry Smith   PetscInt i,count = *cnt;
315d9822059SBarry Smith 
316d9822059SBarry Smith   PetscFunctionBegin;
3177c2de775SJed Brown   if (*datatype == MPIU_REAL) {
3188c764dc5SJose Roman     PetscReal *xin = (PetscReal*)in,*xout = (PetscReal*)out;
319a297a907SKarl Rupp     for (i=0; i<count; i++) xout[i] = PetscMax(xout[i],xin[i]);
3207c2de775SJed Brown   }
3217c2de775SJed Brown #if defined(PETSC_HAVE_COMPLEX)
3227c2de775SJed Brown   else if (*datatype == MPIU_COMPLEX) {
3237c2de775SJed Brown     PetscComplex *xin = (PetscComplex*)in,*xout = (PetscComplex*)out;
3247c2de775SJed Brown     for (i=0; i<count; i++) {
3257c2de775SJed Brown       xout[i] = PetscRealPartComplex(xout[i])<PetscRealPartComplex(xin[i]) ? xin[i] : xout[i];
3267c2de775SJed Brown     }
3277c2de775SJed Brown   }
3287c2de775SJed Brown #endif
3297c2de775SJed Brown   else {
3307c2de775SJed Brown     (*PetscErrorPrintf)("Can only handle MPIU_REAL or MPIU_COMPLEX data types");
3318c764dc5SJose Roman     MPI_Abort(MPI_COMM_WORLD,1);
3328c764dc5SJose Roman   }
333d9822059SBarry Smith   PetscFunctionReturnVoid();
334d9822059SBarry Smith }
335d9822059SBarry Smith 
336d9822059SBarry Smith #undef __FUNCT__
337d9822059SBarry Smith #define __FUNCT__ "PetscMin_Local"
3388cc058d9SJed Brown PETSC_EXTERN void PetscMin_Local(void *in,void *out,PetscMPIInt *cnt,MPI_Datatype *datatype)
339d9822059SBarry Smith {
340d9822059SBarry Smith   PetscInt    i,count = *cnt;
341d9822059SBarry Smith 
342d9822059SBarry Smith   PetscFunctionBegin;
3437c2de775SJed Brown   if (*datatype == MPIU_REAL) {
3448c764dc5SJose Roman     PetscReal *xin = (PetscReal*)in,*xout = (PetscReal*)out;
345a297a907SKarl Rupp     for (i=0; i<count; i++) xout[i] = PetscMin(xout[i],xin[i]);
3467c2de775SJed Brown   }
3477c2de775SJed Brown #if defined(PETSC_HAVE_COMPLEX)
3487c2de775SJed Brown   else if (*datatype == MPIU_COMPLEX) {
3497c2de775SJed Brown     PetscComplex *xin = (PetscComplex*)in,*xout = (PetscComplex*)out;
3507c2de775SJed Brown     for (i=0; i<count; i++) {
3517c2de775SJed Brown       xout[i] = PetscRealPartComplex(xout[i])>PetscRealPartComplex(xin[i]) ? xin[i] : xout[i];
3527c2de775SJed Brown     }
3537c2de775SJed Brown   }
3547c2de775SJed Brown #endif
3557c2de775SJed Brown   else {
3568c764dc5SJose Roman     (*PetscErrorPrintf)("Can only handle MPIU_REAL or MPIU_SCALAR data (i.e. double or complex) types");
3578c764dc5SJose Roman     MPI_Abort(MPI_COMM_WORLD,1);
3588c764dc5SJose Roman   }
359d9822059SBarry Smith   PetscFunctionReturnVoid();
360d9822059SBarry Smith }
361d9822059SBarry Smith #endif
362d9822059SBarry Smith 
363480cf27aSJed Brown #undef __FUNCT__
364480cf27aSJed Brown #define __FUNCT__ "Petsc_DelCounter"
365480cf27aSJed Brown /*
366480cf27aSJed Brown    Private routine to delete internal tag/name counter storage when a communicator is freed.
367480cf27aSJed Brown 
368ff0e51ddSBarry 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.
369480cf27aSJed Brown 
370480cf27aSJed Brown    Note: this is declared extern "C" because it is passed to MPI_Keyval_create()
371480cf27aSJed Brown 
372480cf27aSJed Brown */
3738cc058d9SJed Brown PETSC_EXTERN PetscMPIInt MPIAPI Petsc_DelCounter(MPI_Comm comm,PetscMPIInt keyval,void *count_val,void *extra_state)
374480cf27aSJed Brown {
375480cf27aSJed Brown   PetscErrorCode ierr;
376480cf27aSJed Brown 
377480cf27aSJed Brown   PetscFunctionBegin;
378480cf27aSJed Brown   ierr = PetscInfo1(0,"Deleting counter data in an MPI_Comm %ld\n",(long)comm);if (ierr) PetscFunctionReturn((PetscMPIInt)ierr);
379480cf27aSJed Brown   ierr = PetscFree(count_val);if (ierr) PetscFunctionReturn((PetscMPIInt)ierr);
380480cf27aSJed Brown   PetscFunctionReturn(MPI_SUCCESS);
381480cf27aSJed Brown }
382480cf27aSJed Brown 
383480cf27aSJed Brown #undef __FUNCT__
384da3039f7SJed Brown #define __FUNCT__ "Petsc_DelComm_Outer"
385480cf27aSJed Brown /*
386da3039f7SJed Brown   This is invoked on the outer comm as a result of either PetscCommDestroy() (via MPI_Attr_delete) or when the user
387da3039f7SJed Brown   calls MPI_Comm_free().
388da3039f7SJed Brown 
389da3039f7SJed Brown   This is the only entry point for breaking the links between inner and outer comms.
390480cf27aSJed Brown 
391ff0e51ddSBarry Smith   This is called by MPI, not by users. This is called when MPI_Comm_free() is called on the communicator.
392480cf27aSJed Brown 
393480cf27aSJed Brown   Note: this is declared extern "C" because it is passed to MPI_Keyval_create()
394480cf27aSJed Brown 
395480cf27aSJed Brown */
396da3039f7SJed Brown PETSC_EXTERN PetscMPIInt MPIAPI Petsc_DelComm_Outer(MPI_Comm comm,PetscMPIInt keyval,void *attr_val,void *extra_state)
397480cf27aSJed Brown {
398480cf27aSJed Brown   PetscErrorCode ierr;
399b89831e5SBarry Smith   PetscMPIInt    flg;
400265f3f35SJed Brown   union {MPI_Comm comm; void *ptr;} icomm,ocomm;
401480cf27aSJed Brown 
402480cf27aSJed Brown   PetscFunctionBegin;
403da3039f7SJed Brown   if (keyval != Petsc_InnerComm_keyval) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_CORRUPT,"Unexpected keyval");
404ec4fadc2SJed Brown   icomm.ptr = attr_val;
405da3039f7SJed Brown 
406265f3f35SJed Brown   ierr = MPI_Attr_get(icomm.comm,Petsc_OuterComm_keyval,&ocomm,&flg);CHKERRQ(ierr);
407b3ef52cdSBarry Smith   if (!flg) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_CORRUPT,"Inner MPI_Comm does not have expected reference to outer comm");
408da3039f7SJed Brown   if (ocomm.comm != comm) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_CORRUPT,"Inner MPI_Comm has reference to non-matching outer comm");
409da3039f7SJed Brown   ierr = MPI_Attr_delete(icomm.comm,Petsc_OuterComm_keyval);CHKERRQ(ierr); /* Calls Petsc_DelComm_Inner */
410da3039f7SJed 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);
411da3039f7SJed Brown   PetscFunctionReturn(MPI_SUCCESS);
412b89831e5SBarry Smith }
413da3039f7SJed Brown 
414da3039f7SJed Brown #undef __FUNCT__
415da3039f7SJed Brown #define __FUNCT__ "Petsc_DelComm_Inner"
416da3039f7SJed Brown /*
417da3039f7SJed Brown  * This is invoked on the inner comm when Petsc_DelComm_Outer calls MPI_Attr_delete.  It should not be reached any other way.
418da3039f7SJed Brown  */
419da3039f7SJed Brown PETSC_EXTERN PetscMPIInt MPIAPI Petsc_DelComm_Inner(MPI_Comm comm,PetscMPIInt keyval,void *attr_val,void *extra_state)
420da3039f7SJed Brown {
421da3039f7SJed Brown   PetscErrorCode ierr;
422da3039f7SJed Brown 
423da3039f7SJed Brown   PetscFunctionBegin;
424da3039f7SJed Brown   ierr = PetscInfo1(0,"Removing reference to PETSc communicator embedded in a user MPI_Comm %ld\n",(long)comm);if (ierr) PetscFunctionReturn((PetscMPIInt)ierr);
425480cf27aSJed Brown   PetscFunctionReturn(MPI_SUCCESS);
426480cf27aSJed Brown }
427480cf27aSJed Brown 
428951e3c8eSBarry Smith #if defined(PETSC_USE_PETSC_MPI_EXTERNAL32)
429e39fd77fSBarry Smith #if !defined(PETSC_WORDS_BIGENDIAN)
4308cc058d9SJed Brown PETSC_EXTERN PetscMPIInt PetscDataRep_extent_fn(MPI_Datatype,MPI_Aint*,void*);
4318cc058d9SJed Brown PETSC_EXTERN PetscMPIInt PetscDataRep_read_conv_fn(void*, MPI_Datatype,PetscMPIInt,void*,MPI_Offset,void*);
4328cc058d9SJed Brown PETSC_EXTERN PetscMPIInt PetscDataRep_write_conv_fn(void*, MPI_Datatype,PetscMPIInt,void*,MPI_Offset,void*);
433e39fd77fSBarry Smith #endif
434951e3c8eSBarry Smith #endif
435e39fd77fSBarry Smith 
4366ae9a8a6SBarry Smith int  PetscGlobalArgc   = 0;
4376ae9a8a6SBarry Smith char **PetscGlobalArgs = 0;
438dff31646SBarry Smith PetscSegBuffer PetscCitationsList;
439e5c89e4eSSatish Balay 
440e5c89e4eSSatish Balay #undef __FUNCT__
441051e4cf2SJed Brown #define __FUNCT__ "PetscCitationsInitialize"
442051e4cf2SJed Brown PetscErrorCode PetscCitationsInitialize()
443051e4cf2SJed Brown {
444051e4cf2SJed Brown   PetscErrorCode ierr;
445051e4cf2SJed Brown 
446051e4cf2SJed Brown   PetscFunctionBegin;
447051e4cf2SJed Brown   ierr = PetscSegBufferCreate(1,10000,&PetscCitationsList);CHKERRQ(ierr);
448051e4cf2SJed 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);
449051e4cf2SJed 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);
450051e4cf2SJed Brown   PetscFunctionReturn(0);
451051e4cf2SJed Brown }
452e5c89e4eSSatish Balay 
453e5c89e4eSSatish Balay #undef __FUNCT__
454e5c89e4eSSatish Balay #define __FUNCT__ "PetscGetArgs"
455e5c89e4eSSatish Balay /*@C
456e5c89e4eSSatish Balay    PetscGetArgs - Allows you to access the raw command line arguments anywhere
457e5c89e4eSSatish Balay      after PetscInitialize() is called but before PetscFinalize().
458e5c89e4eSSatish Balay 
459e5c89e4eSSatish Balay    Not Collective
460e5c89e4eSSatish Balay 
461e5c89e4eSSatish Balay    Output Parameters:
462e5c89e4eSSatish Balay +  argc - count of number of command line arguments
463e5c89e4eSSatish Balay -  args - the command line arguments
464e5c89e4eSSatish Balay 
465e5c89e4eSSatish Balay    Level: intermediate
466e5c89e4eSSatish Balay 
467e5c89e4eSSatish Balay    Notes:
468e5c89e4eSSatish Balay       This is usually used to pass the command line arguments into other libraries
469e5c89e4eSSatish Balay    that are called internally deep in PETSc or the application.
470e5c89e4eSSatish Balay 
471f177e3b1SBarry Smith       The first argument contains the program name as is normal for C arguments.
472f177e3b1SBarry Smith 
473e5c89e4eSSatish Balay    Concepts: command line arguments
474e5c89e4eSSatish Balay 
475793721a6SBarry Smith .seealso: PetscFinalize(), PetscInitializeFortran(), PetscGetArguments()
476e5c89e4eSSatish Balay 
477e5c89e4eSSatish Balay @*/
4787087cfbeSBarry Smith PetscErrorCode  PetscGetArgs(int *argc,char ***args)
479e5c89e4eSSatish Balay {
480e5c89e4eSSatish Balay   PetscFunctionBegin;
48117186662SBarry Smith   if (!PetscInitializeCalled && PetscFinalizeCalled) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ORDER,"You must call after PetscInitialize() but before PetscFinalize()");
482e5c89e4eSSatish Balay   *argc = PetscGlobalArgc;
483e5c89e4eSSatish Balay   *args = PetscGlobalArgs;
484e5c89e4eSSatish Balay   PetscFunctionReturn(0);
485e5c89e4eSSatish Balay }
486e5c89e4eSSatish Balay 
487e5c89e4eSSatish Balay #undef __FUNCT__
488793721a6SBarry Smith #define __FUNCT__ "PetscGetArguments"
489793721a6SBarry Smith /*@C
490793721a6SBarry Smith    PetscGetArguments - Allows you to access the  command line arguments anywhere
491793721a6SBarry Smith      after PetscInitialize() is called but before PetscFinalize().
492793721a6SBarry Smith 
493793721a6SBarry Smith    Not Collective
494793721a6SBarry Smith 
495793721a6SBarry Smith    Output Parameters:
496793721a6SBarry Smith .  args - the command line arguments
497793721a6SBarry Smith 
498793721a6SBarry Smith    Level: intermediate
499793721a6SBarry Smith 
500793721a6SBarry Smith    Notes:
501793721a6SBarry Smith       This does NOT start with the program name and IS null terminated (final arg is void)
502793721a6SBarry Smith 
503793721a6SBarry Smith    Concepts: command line arguments
504793721a6SBarry Smith 
505793721a6SBarry Smith .seealso: PetscFinalize(), PetscInitializeFortran(), PetscGetArgs(), PetscFreeArguments()
506793721a6SBarry Smith 
507793721a6SBarry Smith @*/
5087087cfbeSBarry Smith PetscErrorCode  PetscGetArguments(char ***args)
509793721a6SBarry Smith {
510793721a6SBarry Smith   PetscInt       i,argc = PetscGlobalArgc;
511793721a6SBarry Smith   PetscErrorCode ierr;
512793721a6SBarry Smith 
513793721a6SBarry Smith   PetscFunctionBegin;
51417186662SBarry Smith   if (!PetscInitializeCalled && PetscFinalizeCalled) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ORDER,"You must call after PetscInitialize() but before PetscFinalize()");
515717030eeSLisandro Dalcin   if (!argc) {*args = 0; PetscFunctionReturn(0);}
516793721a6SBarry Smith   ierr = PetscMalloc(argc*sizeof(char*),args);CHKERRQ(ierr);
517793721a6SBarry Smith   for (i=0; i<argc-1; i++) {
518793721a6SBarry Smith     ierr = PetscStrallocpy(PetscGlobalArgs[i+1],&(*args)[i]);CHKERRQ(ierr);
519793721a6SBarry Smith   }
520793721a6SBarry Smith   (*args)[argc-1] = 0;
521793721a6SBarry Smith   PetscFunctionReturn(0);
522793721a6SBarry Smith }
523793721a6SBarry Smith 
524793721a6SBarry Smith #undef __FUNCT__
525793721a6SBarry Smith #define __FUNCT__ "PetscFreeArguments"
526793721a6SBarry Smith /*@C
527793721a6SBarry Smith    PetscFreeArguments - Frees the memory obtained with PetscGetArguments()
528793721a6SBarry Smith 
529793721a6SBarry Smith    Not Collective
530793721a6SBarry Smith 
531793721a6SBarry Smith    Output Parameters:
532793721a6SBarry Smith .  args - the command line arguments
533793721a6SBarry Smith 
534793721a6SBarry Smith    Level: intermediate
535793721a6SBarry Smith 
536793721a6SBarry Smith    Concepts: command line arguments
537793721a6SBarry Smith 
538793721a6SBarry Smith .seealso: PetscFinalize(), PetscInitializeFortran(), PetscGetArgs(), PetscGetArguments()
539793721a6SBarry Smith 
540793721a6SBarry Smith @*/
5417087cfbeSBarry Smith PetscErrorCode  PetscFreeArguments(char **args)
542793721a6SBarry Smith {
543793721a6SBarry Smith   PetscInt       i = 0;
544793721a6SBarry Smith   PetscErrorCode ierr;
545793721a6SBarry Smith 
546793721a6SBarry Smith   PetscFunctionBegin;
547a297a907SKarl Rupp   if (!args) PetscFunctionReturn(0);
548793721a6SBarry Smith   while (args[i]) {
549793721a6SBarry Smith     ierr = PetscFree(args[i]);CHKERRQ(ierr);
550793721a6SBarry Smith     i++;
551793721a6SBarry Smith   }
552793721a6SBarry Smith   ierr = PetscFree(args);CHKERRQ(ierr);
553793721a6SBarry Smith   PetscFunctionReturn(0);
554793721a6SBarry Smith }
555793721a6SBarry Smith 
556793721a6SBarry Smith #undef __FUNCT__
557e5c89e4eSSatish Balay #define __FUNCT__ "PetscInitialize"
558e5c89e4eSSatish Balay /*@C
559e5c89e4eSSatish Balay    PetscInitialize - Initializes the PETSc database and MPI.
560e5c89e4eSSatish Balay    PetscInitialize() calls MPI_Init() if that has yet to be called,
561e5c89e4eSSatish Balay    so this routine should always be called near the beginning of
562e5c89e4eSSatish Balay    your program -- usually the very first line!
563e5c89e4eSSatish Balay 
564e5c89e4eSSatish Balay    Collective on MPI_COMM_WORLD or PETSC_COMM_WORLD if it has been set
565e5c89e4eSSatish Balay 
566e5c89e4eSSatish Balay    Input Parameters:
567e5c89e4eSSatish Balay +  argc - count of number of command line arguments
568e5c89e4eSSatish Balay .  args - the command line arguments
5690298fd71SBarry Smith .  file - [optional] PETSc database file, also checks ~username/.petscrc and .petscrc use NULL to not check for
570fc2bca9aSBarry Smith           code specific file. Use -skip_petscrc in the code specific file to skip the .petscrc files
5710298fd71SBarry Smith -  help - [optional] Help message to print, use NULL for no message
572e5c89e4eSSatish Balay 
57305827820SBarry Smith    If you wish PETSc code to run ONLY on a subcommunicator of MPI_COMM_WORLD, create that
57405827820SBarry Smith    communicator first and assign it to PETSC_COMM_WORLD BEFORE calling PetscInitialize(). Thus if you are running a
57505827820SBarry Smith    four process job and two processes will run PETSc and have PetscInitialize() and PetscFinalize() and two process will not,
57605827820SBarry Smith    then do this. If ALL processes in the job are using PetscInitialize() and PetscFinalize() then you don't need to do this, even
57705827820SBarry Smith    if different subcommunicators of the job are doing different things with PETSc.
578e5c89e4eSSatish Balay 
579e5c89e4eSSatish Balay    Options Database Keys:
580e5c89e4eSSatish Balay +  -start_in_debugger [noxterm,dbx,xdb,gdb,...] - Starts program in debugger
581e5c89e4eSSatish Balay .  -on_error_attach_debugger [noxterm,dbx,xdb,gdb,...] - Starts debugger when error detected
582e5c89e4eSSatish Balay .  -on_error_emacs <machinename> causes emacsclient to jump to error file
583b52f573bSBarry Smith .  -on_error_abort calls abort() when error detected (no traceback)
584e8fb0fc0SBarry Smith .  -on_error_mpiabort calls MPI_abort() when error detected
585e8fb0fc0SBarry Smith .  -error_output_stderr prints error messages to stderr instead of the default stdout
586e8fb0fc0SBarry Smith .  -error_output_none does not print the error messages (but handles errors in the same way as if this was not called)
587e5c89e4eSSatish Balay .  -debugger_nodes [node1,node2,...] - Indicates nodes to start in debugger
588e5c89e4eSSatish Balay .  -debugger_pause [sleeptime] (in seconds) - Pauses debugger
589e5c89e4eSSatish Balay .  -stop_for_debugger - Print message on how to attach debugger manually to
590e5c89e4eSSatish Balay                         process and wait (-debugger_pause) seconds for attachment
5912fb0ec9aSBarry Smith .  -malloc - Indicates use of PETSc error-checking malloc (on by default for debug version of libraries)
592e5c89e4eSSatish Balay .  -malloc no - Indicates not to use error-checking malloc
5932fb0ec9aSBarry Smith .  -malloc_debug - check for memory corruption at EVERY malloc or free
594dc92acbaSJed Brown .  -malloc_test - like -malloc_dump -malloc_debug, but only active for debugging builds
595e5c89e4eSSatish Balay .  -fp_trap - Stops on floating point exceptions (Note that on the
596e5c89e4eSSatish Balay               IBM RS6000 this slows code by at least a factor of 10.)
597e5c89e4eSSatish Balay .  -no_signal_handler - Indicates not to trap error signals
598e5c89e4eSSatish Balay .  -shared_tmp - indicates /tmp directory is shared by all processors
599e5c89e4eSSatish Balay .  -not_shared_tmp - each processor has own /tmp
600e5c89e4eSSatish Balay .  -tmp - alternative name of /tmp directory
601e5c89e4eSSatish Balay .  -get_total_flops - returns total flops done by all processors
60240ab9619SBarry Smith .  -memory_info - Print memory usage at end of run
60340ab9619SBarry Smith -  -server <port> - start PETSc webserver (default port is 8080)
604e5c89e4eSSatish Balay 
605e5c89e4eSSatish Balay    Options Database Keys for Profiling:
6060598bfebSBarry Smith    See the <a href="../../docs/manual.pdf#nameddest=ch_profiling">profiling chapter of the users manual</a> for details.
607495fc317SBarry Smith +  -info <optional filename> - Prints verbose information to the screen
608495fc317SBarry Smith .  -info_exclude <null,vec,mat,pc,ksp,snes,ts> - Excludes some of the verbose messages
609495fc317SBarry Smith .  -log_sync - Log the synchronization in scatters, inner products and norms
610495fc317SBarry Smith .  -log_trace [filename] - Print traces of all PETSc calls to the screen (useful to determine where a program
611e5c89e4eSSatish Balay         hangs without running in the debugger).  See PetscLogTraceBegin().
612495fc317SBarry Smith .  -log_summary [filename] - Prints summary of flop and timing information to screen. If the filename is specified the
613495fc317SBarry Smith         summary is written to the file.  See PetscLogView().
614495fc317SBarry Smith .  -log_summary_python [filename] - Prints data on of flop and timing usage to a file or screen. See PetscLogPrintSViewPython().
615495fc317SBarry Smith .  -log_all [filename] - Logs extensive profiling information  See PetscLogDump().
616495fc317SBarry Smith .  -log [filename] - Logs basic profiline information  See PetscLogDump().
617495fc317SBarry Smith -  -log_mpe [filename] - Creates a logfile viewable by the utility Jumpshot (in MPICH distribution)
618495fc317SBarry Smith 
619495fc317SBarry Smith     Only one of -log_trace, -log_summary, -log_all, -log, or -log_mpe may be used at a time
620e5c89e4eSSatish Balay 
621e5c89e4eSSatish Balay    Environmental Variables:
622e5c89e4eSSatish Balay +   PETSC_TMP - alternative tmp directory
623e5c89e4eSSatish Balay .   PETSC_SHARED_TMP - tmp is shared by all processes
624e5c89e4eSSatish Balay .   PETSC_NOT_SHARED_TMP - each process has its own private tmp
625e5c89e4eSSatish Balay .   PETSC_VIEWER_SOCKET_PORT - socket number to use for socket viewer
626e5c89e4eSSatish Balay -   PETSC_VIEWER_SOCKET_MACHINE - machine to use for socket viewer to connect to
627e5c89e4eSSatish Balay 
628e5c89e4eSSatish Balay 
629e5c89e4eSSatish Balay    Level: beginner
630e5c89e4eSSatish Balay 
631e5c89e4eSSatish Balay    Notes:
632e5c89e4eSSatish Balay    If for some reason you must call MPI_Init() separately, call
633e5c89e4eSSatish Balay    it before PetscInitialize().
634e5c89e4eSSatish Balay 
635e5c89e4eSSatish Balay    Fortran Version:
636e5c89e4eSSatish Balay    In Fortran this routine has the format
637e5c89e4eSSatish Balay $       call PetscInitialize(file,ierr)
638e5c89e4eSSatish Balay 
639e5c89e4eSSatish Balay +   ierr - error return code
6400298fd71SBarry Smith -  file - [optional] PETSc database file, also checks ~username/.petscrc and .petscrc use NULL_CHARACTER to not check for
641fc2bca9aSBarry Smith           code specific file. Use -skip_petscrc in the code specific file to skip the .petscrc files
642e5c89e4eSSatish Balay 
643e5c89e4eSSatish Balay    Important Fortran Note:
6440298fd71SBarry Smith    In Fortran, you MUST use NULL_CHARACTER to indicate a
6450298fd71SBarry Smith    null character string; you CANNOT just use NULL as
6460598bfebSBarry Smith    in the C version. See the <a href="../../docs/manual.pdf">users manual</a> for details.
647e5c89e4eSSatish Balay 
64801cb0274SBarry Smith    If your main program is C but you call Fortran code that also uses PETSc you need to call PetscInitializeFortran() soon after
64901cb0274SBarry Smith    calling PetscInitialize().
650e5c89e4eSSatish Balay 
651e5c89e4eSSatish Balay    Concepts: initializing PETSc
652e5c89e4eSSatish Balay 
65301cb0274SBarry Smith .seealso: PetscFinalize(), PetscInitializeFortran(), PetscGetArgs(), PetscInitializeNoArguments()
654e5c89e4eSSatish Balay 
655e5c89e4eSSatish Balay @*/
6567087cfbeSBarry Smith PetscErrorCode  PetscInitialize(int *argc,char ***args,const char file[],const char help[])
657e5c89e4eSSatish Balay {
658e5c89e4eSSatish Balay   PetscErrorCode ierr;
6594bb5149bSJed Brown   PetscMPIInt    flag, size;
660aa5bb8c0SSatish Balay   PetscInt       nodesize;
661ace3abfcSBarry Smith   PetscBool      flg;
662e5c89e4eSSatish Balay   char           hostname[256];
663e5c89e4eSSatish Balay 
664e5c89e4eSSatish Balay   PetscFunctionBegin;
665e5c89e4eSSatish Balay   if (PetscInitializeCalled) PetscFunctionReturn(0);
666e5c89e4eSSatish Balay 
667ae9b4142SLisandro Dalcin   /* these must be initialized in a routine, not as a constant declaration*/
668d89683f4Sbcordonn   PETSC_STDOUT = stdout;
669ae9b4142SLisandro Dalcin   PETSC_STDERR = stderr;
670e5c89e4eSSatish Balay 
671e5c89e4eSSatish Balay   ierr = PetscOptionsCreate();CHKERRQ(ierr);
672e5c89e4eSSatish Balay 
673e5c89e4eSSatish Balay   /*
674e5c89e4eSSatish Balay      We initialize the program name here (before MPI_Init()) because MPICH has a bug in
675e5c89e4eSSatish Balay      it that it sets args[0] on all processors to be args[0] on the first processor.
676e5c89e4eSSatish Balay   */
677e5c89e4eSSatish Balay   if (argc && *argc) {
678e5c89e4eSSatish Balay     ierr = PetscSetProgramName(**args);CHKERRQ(ierr);
679e5c89e4eSSatish Balay   } else {
680e5c89e4eSSatish Balay     ierr = PetscSetProgramName("Unknown Name");CHKERRQ(ierr);
681e5c89e4eSSatish Balay   }
682e5c89e4eSSatish Balay 
683e5c89e4eSSatish Balay   ierr = MPI_Initialized(&flag);CHKERRQ(ierr);
684e5c89e4eSSatish Balay   if (!flag) {
685e32f2f54SBarry 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");
6865e765c61SJed Brown #if defined(PETSC_HAVE_MPI_INIT_THREAD)
6875e765c61SJed Brown     {
6885e765c61SJed Brown       PetscMPIInt provided;
6895e765c61SJed Brown       ierr = MPI_Init_thread(argc,args,MPI_THREAD_FUNNELED,&provided);CHKERRQ(ierr);
6905e765c61SJed Brown     }
6915e765c61SJed Brown #else
692e5c89e4eSSatish Balay     ierr = MPI_Init(argc,args);CHKERRQ(ierr);
6935e765c61SJed Brown #endif
694e5c89e4eSSatish Balay     PetscBeganMPI = PETSC_TRUE;
695e5c89e4eSSatish Balay   }
696e5c89e4eSSatish Balay   if (argc && args) {
697e5c89e4eSSatish Balay     PetscGlobalArgc = *argc;
698e5c89e4eSSatish Balay     PetscGlobalArgs = *args;
699e5c89e4eSSatish Balay   }
700e5c89e4eSSatish Balay   PetscFinalizeCalled = PETSC_FALSE;
701e5c89e4eSSatish Balay 
702a297a907SKarl Rupp   if (PETSC_COMM_WORLD == MPI_COMM_NULL) PETSC_COMM_WORLD = MPI_COMM_WORLD;
703d54338ecSKarl Rupp   ierr = MPI_Comm_set_errhandler(PETSC_COMM_WORLD,MPI_ERRORS_RETURN);CHKERRQ(ierr);
704e5c89e4eSSatish Balay 
705e5c89e4eSSatish Balay   /* Done after init due to a bug in MPICH-GM? */
706e5c89e4eSSatish Balay   ierr = PetscErrorPrintfInitialize();CHKERRQ(ierr);
707e5c89e4eSSatish Balay 
708e5c89e4eSSatish Balay   ierr = MPI_Comm_rank(MPI_COMM_WORLD,&PetscGlobalRank);CHKERRQ(ierr);
709e5c89e4eSSatish Balay   ierr = MPI_Comm_size(MPI_COMM_WORLD,&PetscGlobalSize);CHKERRQ(ierr);
710e5c89e4eSSatish Balay 
7118ad47952SJed Brown   MPIU_BOOL = MPI_INT;
7128ad47952SJed Brown   MPIU_ENUM = MPI_INT;
7138ad47952SJed Brown 
714e5c89e4eSSatish Balay   /*
715e5c89e4eSSatish Balay      Initialized the global complex variable; this is because with
716e5c89e4eSSatish Balay      shared libraries the constructors for global variables
717e5c89e4eSSatish Balay      are not called; at least on IRIX.
718e5c89e4eSSatish Balay   */
719886cfec0SSatish Balay #if defined(PETSC_HAVE_COMPLEX)
720e5c89e4eSSatish Balay   {
721a24ee22aSSatish Balay #if defined(PETSC_CLANGUAGE_CXX)
72250f81f78SJed Brown     PetscComplex ic(0.0,1.0);
723e5c89e4eSSatish Balay     PETSC_i = ic;
724a24ee22aSSatish Balay #elif defined(PETSC_CLANGUAGE_C)
72550f81f78SJed Brown     PETSC_i = _Complex_I;
726b7940d39SSatish Balay #endif
727762437b8SSatish Balay   }
728762437b8SSatish Balay 
7292c876bd9SBarry Smith #if !defined(PETSC_HAVE_MPI_C_DOUBLE_COMPLEX)
730e69cd0e6SSatish Balay   ierr = MPI_Type_contiguous(2,MPI_DOUBLE,&MPIU_C_DOUBLE_COMPLEX);CHKERRQ(ierr);
731500d8756SSatish Balay   ierr = MPI_Type_commit(&MPIU_C_DOUBLE_COMPLEX);CHKERRQ(ierr);
732500d8756SSatish Balay   ierr = MPI_Type_contiguous(2,MPI_FLOAT,&MPIU_C_COMPLEX);CHKERRQ(ierr);
733500d8756SSatish Balay   ierr = MPI_Type_commit(&MPIU_C_COMPLEX);CHKERRQ(ierr);
7342c876bd9SBarry Smith #endif
735886cfec0SSatish Balay #endif /* PETSC_HAVE_COMPLEX */
736e5c89e4eSSatish Balay 
737e5c89e4eSSatish Balay   /*
738e5c89e4eSSatish Balay      Create the PETSc MPI reduction operator that sums of the first
739e5c89e4eSSatish Balay      half of the entries and maxes the second half.
740e5c89e4eSSatish Balay   */
741e5c89e4eSSatish Balay   ierr = MPI_Op_create(PetscMaxSum_Local,1,&PetscMaxSum_Op);CHKERRQ(ierr);
742e5c89e4eSSatish Balay 
743ce63c4c1SBarry Smith #if defined(PETSC_USE_REAL___FLOAT128)
744c90a1750SBarry Smith   ierr = MPI_Type_contiguous(2,MPI_DOUBLE,&MPIU___FLOAT128);CHKERRQ(ierr);
745c90a1750SBarry Smith   ierr = MPI_Type_commit(&MPIU___FLOAT128);CHKERRQ(ierr);
7467c2de775SJed Brown #if defined(PETSC_HAVE_COMPLEX)
7478c764dc5SJose Roman   ierr = MPI_Type_contiguous(4,MPI_DOUBLE,&MPIU___COMPLEX128);CHKERRQ(ierr);
7488c764dc5SJose Roman   ierr = MPI_Type_commit(&MPIU___COMPLEX128);CHKERRQ(ierr);
7498c764dc5SJose Roman #endif
750d9822059SBarry Smith   ierr = MPI_Op_create(PetscMax_Local,1,&MPIU_MAX);CHKERRQ(ierr);
751d9822059SBarry Smith   ierr = MPI_Op_create(PetscMin_Local,1,&MPIU_MIN);CHKERRQ(ierr);
752c90a1750SBarry Smith #endif
753c90a1750SBarry Smith 
7547c2de775SJed Brown #if (defined(PETSC_HAVE_COMPLEX) && !defined(PETSC_HAVE_MPI_C_DOUBLE_COMPLEX)) || defined(PETSC_USE_REAL___FLOAT128)
755cca4cb22SSatish Balay   ierr = MPI_Op_create(PetscSum_Local,1,&MPIU_SUM);CHKERRQ(ierr);
756cca4cb22SSatish Balay #endif
757cca4cb22SSatish Balay 
758e5c89e4eSSatish Balay   ierr = MPI_Type_contiguous(2,MPIU_SCALAR,&MPIU_2SCALAR);CHKERRQ(ierr);
759e5c89e4eSSatish Balay   ierr = MPI_Type_commit(&MPIU_2SCALAR);CHKERRQ(ierr);
760e5c89e4eSSatish Balay   ierr = MPI_Op_create(PetscADMax_Local,1,&PetscADMax_Op);CHKERRQ(ierr);
761e5c89e4eSSatish Balay   ierr = MPI_Op_create(PetscADMin_Local,1,&PetscADMin_Op);CHKERRQ(ierr);
762e5c89e4eSSatish Balay 
76344041f26SJed Brown #if defined(PETSC_USE_64BIT_INDICES) || !defined(MPI_2INT)
764e5c89e4eSSatish Balay   ierr = MPI_Type_contiguous(2,MPIU_INT,&MPIU_2INT);CHKERRQ(ierr);
765e5c89e4eSSatish Balay   ierr = MPI_Type_commit(&MPIU_2INT);CHKERRQ(ierr);
76644041f26SJed Brown #endif
767e5c89e4eSSatish Balay 
768e5c89e4eSSatish Balay   /*
769480cf27aSJed Brown      Attributes to be set on PETSc communicators
770480cf27aSJed Brown   */
771480cf27aSJed Brown   ierr = MPI_Keyval_create(MPI_NULL_COPY_FN,Petsc_DelCounter,&Petsc_Counter_keyval,(void*)0);CHKERRQ(ierr);
772da3039f7SJed Brown   ierr = MPI_Keyval_create(MPI_NULL_COPY_FN,Petsc_DelComm_Outer,&Petsc_InnerComm_keyval,(void*)0);CHKERRQ(ierr);
773da3039f7SJed Brown   ierr = MPI_Keyval_create(MPI_NULL_COPY_FN,Petsc_DelComm_Inner,&Petsc_OuterComm_keyval,(void*)0);CHKERRQ(ierr);
774480cf27aSJed Brown 
775480cf27aSJed Brown   /*
776e8fb0fc0SBarry Smith      Build the options database
777e5c89e4eSSatish Balay   */
778e5c89e4eSSatish Balay   ierr = PetscOptionsInsert(argc,args,file);CHKERRQ(ierr);
779e5c89e4eSSatish Balay 
7806dc8fec2Sbcordonn 
781e5c89e4eSSatish Balay   /*
782e5c89e4eSSatish Balay      Print main application help message
783e5c89e4eSSatish Balay   */
7840298fd71SBarry Smith   ierr = PetscOptionsHasName(NULL,"-help",&flg);CHKERRQ(ierr);
785e5c89e4eSSatish Balay   if (help && flg) {
786e5c89e4eSSatish Balay     ierr = PetscPrintf(PETSC_COMM_WORLD,help);CHKERRQ(ierr);
787e5c89e4eSSatish Balay   }
788e5c89e4eSSatish Balay   ierr = PetscOptionsCheckInitial_Private();CHKERRQ(ierr);
789e5c89e4eSSatish Balay 
790e5c89e4eSSatish Balay   /* SHOULD PUT IN GUARDS: Make sure logging is initialized, even if we do not print it out */
791a9f03627SSatish Balay #if defined(PETSC_USE_LOG)
792e5c89e4eSSatish Balay   ierr = PetscLogBegin_Private();CHKERRQ(ierr);
793a9f03627SSatish Balay #endif
794e5c89e4eSSatish Balay 
795e5c89e4eSSatish Balay   /*
796e5c89e4eSSatish Balay      Load the dynamic libraries (on machines that support them), this registers all
797e5c89e4eSSatish Balay      the solvers etc. (On non-dynamic machines this initializes the PetscDraw and PetscViewer classes)
798e5c89e4eSSatish Balay   */
799e5c89e4eSSatish Balay   ierr = PetscInitialize_DynamicLibraries();CHKERRQ(ierr);
800e5c89e4eSSatish Balay 
801e5c89e4eSSatish Balay   ierr = MPI_Comm_size(PETSC_COMM_WORLD,&size);CHKERRQ(ierr);
802ae15b995SBarry Smith   ierr = PetscInfo1(0,"PETSc successfully started: number of processors = %d\n",size);CHKERRQ(ierr);
803e5c89e4eSSatish Balay   ierr = PetscGetHostName(hostname,256);CHKERRQ(ierr);
804ae15b995SBarry Smith   ierr = PetscInfo1(0,"Running on machine: %s\n",hostname);CHKERRQ(ierr);
805e5c89e4eSSatish Balay 
806e5c89e4eSSatish Balay   ierr = PetscOptionsCheckInitial_Components();CHKERRQ(ierr);
807ef6c6fedSBoyana Norris   /* Check the options database for options related to the options database itself */
808ef6c6fedSBoyana Norris   ierr = PetscOptionsSetFromOptions();CHKERRQ(ierr);
809ef6c6fedSBoyana Norris 
810951e3c8eSBarry Smith #if defined(PETSC_USE_PETSC_MPI_EXTERNAL32)
811e39fd77fSBarry Smith   /*
812e39fd77fSBarry Smith       Tell MPI about our own data representation converter, this would/should be used if extern32 is not supported by the MPI
813e39fd77fSBarry Smith 
814e39fd77fSBarry Smith       Currently not used because it is not supported by MPICH.
815e39fd77fSBarry Smith   */
816e39fd77fSBarry Smith #if !defined(PETSC_WORDS_BIGENDIAN)
8170298fd71SBarry Smith   ierr = MPI_Register_datarep((char*)"petsc",PetscDataRep_read_conv_fn,PetscDataRep_write_conv_fn,PetscDataRep_extent_fn,NULL);CHKERRQ(ierr);
818e39fd77fSBarry Smith #endif
819951e3c8eSBarry Smith #endif
820e39fd77fSBarry Smith 
8210298fd71SBarry Smith   ierr = PetscOptionsGetInt(NULL,"-hmpi_spawn_size",&nodesize,&flg);CHKERRQ(ierr);
822793721a6SBarry Smith   if (flg) {
82323464e94SBarry Smith #if defined(PETSC_HAVE_MPI_COMM_SPAWN)
82485afcc9aSBarry Smith     ierr = PetscHMPISpawn((PetscMPIInt) nodesize);CHKERRQ(ierr); /* worker nodes never return from here; they go directly to PetscEnd() */
82523464e94SBarry Smith #else
82685afcc9aSBarry Smith     SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SUP,"PETSc built without MPI 2 (MPI_Comm_spawn) support, use -hmpi_merge_size instead");
82723464e94SBarry Smith #endif
828793721a6SBarry Smith   } else {
8290298fd71SBarry Smith     ierr = PetscOptionsGetInt(NULL,"-hmpi_merge_size",&nodesize,&flg);CHKERRQ(ierr);
8308002f1cdSBarry Smith     if (flg) {
8310298fd71SBarry Smith       ierr = PetscHMPIMerge((PetscMPIInt) nodesize,NULL,NULL);CHKERRQ(ierr);
83285afcc9aSBarry Smith       if (PetscHMPIWorker) { /* if worker then never enter user code */
833bad7cb1dSBarry Smith         PetscInitializeCalled = PETSC_TRUE;
8343bf036e2SBarry Smith         PetscEnd();
8359505b675SBarry Smith       }
8368002f1cdSBarry Smith     }
837793721a6SBarry Smith   }
838e5c89e4eSSatish Balay 
83935d88935SVictor Minden #if defined(PETSC_HAVE_CUDA)
840*20e2c332SMatthew G. Knepley   flg  = PETSC_TRUE;
841*20e2c332SMatthew G. Knepley   ierr = PetscOptionsGetBool(NULL,"-cublas",&flg,NULL);CHKERRQ(ierr);
842*20e2c332SMatthew G. Knepley   if (flg) {
8434bb5149bSJed Brown     PetscMPIInt p;
844663ba86aSMatthew G Knepley     for (p = 0; p < PetscGlobalSize; ++p) {
845a297a907SKarl Rupp       if (p == PetscGlobalRank) cublasInit();
846663ba86aSMatthew G Knepley       ierr = MPI_Barrier(PETSC_COMM_WORLD);CHKERRQ(ierr);
847663ba86aSMatthew G Knepley     }
8484bb5149bSJed Brown   }
8493e39abd9SVictor Minden #endif
85092e62aa6SBarry Smith 
8510298fd71SBarry Smith   ierr = PetscOptionsHasName(NULL,"-python",&flg);CHKERRQ(ierr);
8529ac80d5eSLisandro Dalcin   if (flg) {
8539ac80d5eSLisandro Dalcin     PetscInitializeCalled = PETSC_TRUE;
8540298fd71SBarry Smith     ierr = PetscPythonInitialize(NULL,NULL);CHKERRQ(ierr);
8559ac80d5eSLisandro Dalcin   }
8569ac80d5eSLisandro Dalcin 
857607a6623SBarry Smith   ierr = PetscThreadCommInitializePackage();CHKERRQ(ierr);
858bd8b14e7SShri Abhyankar 
85941c0b4b3SShri Abhyankar   /*
86041c0b4b3SShri Abhyankar       Setup building of stack frames for all function calls
86141c0b4b3SShri Abhyankar   */
86276386721SLisandro Dalcin   PetscThreadLocalRegister((PetscThreadKey*)&petscstack); /* Creates pthread_key */
863e1167bb9SShri Abhyankar #if defined(PETSC_USE_DEBUG)
864e1167bb9SShri Abhyankar   ierr = PetscStackCreate();CHKERRQ(ierr);
865e1167bb9SShri Abhyankar #endif
866e1167bb9SShri Abhyankar 
8672d53ad75SBarry Smith #if defined(PETSC_SERIALIZE_FUNCTIONS)
8682d53ad75SBarry Smith   ierr = PetscFPTCreate(10000);CHKERRQ(ierr);
8692d53ad75SBarry Smith #endif
8702d53ad75SBarry Smith 
871051e4cf2SJed Brown   ierr = PetscCitationsInitialize();CHKERRQ(ierr);
872dff31646SBarry Smith 
873301d30feSBarry Smith   /*
874301d30feSBarry Smith       Once we are completedly initialized then we can set this variables
875301d30feSBarry Smith   */
876301d30feSBarry Smith   PetscInitializeCalled = PETSC_TRUE;
877301d30feSBarry Smith   PetscFunctionReturn(0);
878e5c89e4eSSatish Balay }
879e5c89e4eSSatish Balay 
8802eff7a51SBarry Smith extern PetscObject *PetscObjects;
8812eff7a51SBarry Smith extern PetscInt    PetscObjectsCounts, PetscObjectsMaxCounts;
882e5c89e4eSSatish Balay 
883e5c89e4eSSatish Balay #undef __FUNCT__
884e5c89e4eSSatish Balay #define __FUNCT__ "PetscFinalize"
885e5c89e4eSSatish Balay /*@C
886e5c89e4eSSatish Balay    PetscFinalize - Checks for options to be called at the conclusion
887e5c89e4eSSatish Balay    of the program. MPI_Finalize() is called only if the user had not
888e5c89e4eSSatish Balay    called MPI_Init() before calling PetscInitialize().
889e5c89e4eSSatish Balay 
890e5c89e4eSSatish Balay    Collective on PETSC_COMM_WORLD
891e5c89e4eSSatish Balay 
892e5c89e4eSSatish Balay    Options Database Keys:
89388c29154SBarry Smith +  -options_table - Calls PetscOptionsView()
894e5c89e4eSSatish Balay .  -options_left - Prints unused options that remain in the database
8957eb1d149SBarry 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
896e5c89e4eSSatish Balay .  -mpidump - Calls PetscMPIDump()
897e5c89e4eSSatish Balay .  -malloc_dump - Calls PetscMallocDump()
898e5c89e4eSSatish Balay .  -malloc_info - Prints total memory usage
899e5c89e4eSSatish Balay -  -malloc_log - Prints summary of memory usage
900e5c89e4eSSatish Balay 
901e5c89e4eSSatish Balay    Level: beginner
902e5c89e4eSSatish Balay 
903e5c89e4eSSatish Balay    Note:
904e5c89e4eSSatish Balay    See PetscInitialize() for more general runtime options.
905e5c89e4eSSatish Balay 
90688c29154SBarry Smith .seealso: PetscInitialize(), PetscOptionsView(), PetscMallocDump(), PetscMPIDump(), PetscEnd()
907e5c89e4eSSatish Balay @*/
9087087cfbeSBarry Smith PetscErrorCode  PetscFinalize(void)
909e5c89e4eSSatish Balay {
910e5c89e4eSSatish Balay   PetscErrorCode ierr;
9114bb5149bSJed Brown   PetscMPIInt    rank;
912a8d2bbe5SBarry Smith   PetscInt       nopt;
9132bf49c77SBarry Smith   PetscBool      flg1 = PETSC_FALSE,flg2 = PETSC_FALSE,flg3 = PETSC_FALSE;
914dff31646SBarry Smith   PetscBool      flg;
91510463e74SBarry Smith #if defined(PETSC_USE_LOG)
91610463e74SBarry Smith   char           mname[PETSC_MAX_PATH_LEN];
91710463e74SBarry Smith #endif
918e5c89e4eSSatish Balay 
919e5c89e4eSSatish Balay   PetscFunctionBegin;
920e5c89e4eSSatish Balay   if (!PetscInitializeCalled) {
9214b09e917SBarry Smith     printf("PetscInitialize() must be called before PetscFinalize()\n");
9224b09e917SBarry Smith     PetscFunctionReturn(PETSC_ERR_ARG_WRONGSTATE);
923e5c89e4eSSatish Balay   }
9240298fd71SBarry Smith   ierr = PetscInfo(NULL,"PetscFinalize() called\n");CHKERRQ(ierr);
925b022a5c1SBarry Smith 
9261f817a21SBarry Smith   ierr = MPI_Comm_rank(PETSC_COMM_WORLD,&rank);CHKERRQ(ierr);
9271f817a21SBarry Smith 
9281f817a21SBarry Smith   ierr = PetscOptionsHasName(NULL,"-citations",&flg);CHKERRQ(ierr);
929dff31646SBarry Smith   if (flg) {
9301f817a21SBarry Smith     char  *cits, filename[PETSC_MAX_PATH_LEN];
9311f817a21SBarry Smith     FILE  *fd = PETSC_STDOUT;
9321f817a21SBarry Smith 
9331f817a21SBarry Smith     ierr = PetscOptionsGetString(NULL,"-citations",filename,PETSC_MAX_PATH_LEN,NULL);CHKERRQ(ierr);
9341f817a21SBarry Smith     if (filename[0]) {
9351f817a21SBarry Smith       ierr = PetscFOpen(PETSC_COMM_WORLD,filename,"w",&fd);CHKERRQ(ierr);
9361f817a21SBarry Smith     }
937dff31646SBarry Smith     ierr = PetscSegBufferGet(PetscCitationsList,1,&cits);CHKERRQ(ierr);
938dff31646SBarry Smith     cits[0] = 0;
939dff31646SBarry Smith     ierr = PetscSegBufferExtractAlloc(PetscCitationsList,&cits);CHKERRQ(ierr);
9401f817a21SBarry Smith     ierr = PetscFPrintf(PETSC_COMM_WORLD,fd,"If you publish results based on this computation please cite the following:\n");CHKERRQ(ierr);
9411f817a21SBarry Smith     ierr = PetscFPrintf(PETSC_COMM_WORLD,fd,"===========================================================================\n");CHKERRQ(ierr);
9421f817a21SBarry Smith     ierr = PetscFPrintf(PETSC_COMM_WORLD,fd,"%s",cits);CHKERRQ(ierr);
9431f817a21SBarry Smith     ierr = PetscFPrintf(PETSC_COMM_WORLD,fd,"===========================================================================\n");CHKERRQ(ierr);
9441f817a21SBarry Smith     ierr = PetscFClose(PETSC_COMM_WORLD,fd);CHKERRQ(ierr);
945dff31646SBarry Smith     ierr = PetscFree(cits);CHKERRQ(ierr);
946dff31646SBarry Smith   }
947dff31646SBarry Smith   ierr = PetscSegBufferDestroy(&PetscCitationsList);CHKERRQ(ierr);
948dff31646SBarry Smith 
9492d53ad75SBarry Smith #if defined(PETSC_SERIALIZE_FUNCTIONS)
9502d53ad75SBarry Smith   ierr = PetscFPTDestroy();CHKERRQ(ierr);
9512d53ad75SBarry Smith #endif
9522d53ad75SBarry Smith 
9532d53ad75SBarry Smith 
954d5649816SBarry Smith #if defined(PETSC_HAVE_AMS)
955dff31646SBarry Smith   flg = PETSC_FALSE;
9560298fd71SBarry Smith   ierr = PetscOptionsGetBool(NULL,"-options_gui",&flg,NULL);CHKERRQ(ierr);
957d5649816SBarry Smith   if (flg) {
958d5649816SBarry Smith     ierr = PetscOptionsAMSDestroy();CHKERRQ(ierr);
959d5649816SBarry Smith   }
960d5649816SBarry Smith #endif
961d5649816SBarry Smith 
9626d065ec1SBarry Smith #if defined(PETSC_HAVE_SERVER)
9632d139d8fSBarry Smith   flg1 = PETSC_FALSE;
9642d139d8fSBarry Smith   ierr = PetscOptionsGetBool(NULL,"-server",&flg1,NULL);CHKERRQ(ierr);
9652d139d8fSBarry Smith   if (flg1) {
9666d065ec1SBarry Smith     /*  this is a crude hack, but better than nothing */
9672d139d8fSBarry Smith     ierr = PetscPOpen(PETSC_COMM_WORLD,NULL,"pkill -9 petscwebserver","r",NULL);CHKERRQ(ierr);
9682d139d8fSBarry Smith   }
9696d065ec1SBarry Smith #endif
9702d139d8fSBarry Smith 
97185afcc9aSBarry Smith   ierr = PetscHMPIFinalize();CHKERRQ(ierr);
972d3f95da6SShri Abhyankar 
9730298fd71SBarry Smith   ierr = PetscOptionsGetBool(NULL,"-malloc_info",&flg2,NULL);CHKERRQ(ierr);
974e5c89e4eSSatish Balay   if (!flg2) {
97590d69ab7SBarry Smith     flg2 = PETSC_FALSE;
9760298fd71SBarry Smith     ierr = PetscOptionsGetBool(NULL,"-memory_info",&flg2,NULL);CHKERRQ(ierr);
977e5c89e4eSSatish Balay   }
978e5c89e4eSSatish Balay   if (flg2) {
979e5c89e4eSSatish Balay     ierr = PetscMemoryShowUsage(PETSC_VIEWER_STDOUT_WORLD,"Summary of Memory Usage in PETSc\n");CHKERRQ(ierr);
980e5c89e4eSSatish Balay   }
981e5c89e4eSSatish Balay 
982e5c89e4eSSatish Balay #if defined(PETSC_USE_LOG)
98390d69ab7SBarry Smith   flg1 = PETSC_FALSE;
9840298fd71SBarry Smith   ierr = PetscOptionsGetBool(NULL,"-get_total_flops",&flg1,NULL);CHKERRQ(ierr);
985e5c89e4eSSatish Balay   if (flg1) {
986e5c89e4eSSatish Balay     PetscLogDouble flops = 0;
987205a32c2SJed Brown     ierr = MPI_Reduce(&petsc_TotalFlops,&flops,1,MPI_DOUBLE,MPI_SUM,0,PETSC_COMM_WORLD);CHKERRQ(ierr);
988e5c89e4eSSatish Balay     ierr = PetscPrintf(PETSC_COMM_WORLD,"Total flops over all processors %g\n",flops);CHKERRQ(ierr);
989e5c89e4eSSatish Balay   }
990e5c89e4eSSatish Balay #endif
991e5c89e4eSSatish Balay 
992e5c89e4eSSatish Balay 
993e5c89e4eSSatish Balay #if defined(PETSC_USE_LOG)
994e5c89e4eSSatish Balay #if defined(PETSC_HAVE_MPE)
995e5c89e4eSSatish Balay   mname[0] = 0;
996a297a907SKarl Rupp 
9970298fd71SBarry Smith   ierr = PetscOptionsGetString(NULL,"-log_mpe",mname,PETSC_MAX_PATH_LEN,&flg1);CHKERRQ(ierr);
998e5c89e4eSSatish Balay   if (flg1) {
999e5c89e4eSSatish Balay     if (mname[0]) {ierr = PetscLogMPEDump(mname);CHKERRQ(ierr);}
1000e5c89e4eSSatish Balay     else          {ierr = PetscLogMPEDump(0);CHKERRQ(ierr);}
1001e5c89e4eSSatish Balay   }
1002e5c89e4eSSatish Balay #endif
1003e5c89e4eSSatish Balay   mname[0] = 0;
1004a297a907SKarl Rupp 
10050298fd71SBarry Smith   ierr = PetscOptionsGetString(NULL,"-log_summary",mname,PETSC_MAX_PATH_LEN,&flg1);CHKERRQ(ierr);
1006e5c89e4eSSatish Balay   if (flg1) {
100791eabc43SBarry Smith     PetscViewer viewer;
100891eabc43SBarry Smith     if (mname[0]) {
100991eabc43SBarry Smith       ierr = PetscViewerASCIIOpen(PETSC_COMM_WORLD,mname,&viewer);CHKERRQ(ierr);
101091eabc43SBarry Smith       ierr = PetscLogView(viewer);CHKERRQ(ierr);
10116bf464f9SBarry Smith       ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr);
101233f85c2fSBarry Smith     } else {
101333f85c2fSBarry Smith       viewer = PETSC_VIEWER_STDOUT_WORLD;
101433f85c2fSBarry Smith       ierr   = PetscLogView(viewer);CHKERRQ(ierr);
101533f85c2fSBarry Smith     }
1016e5c89e4eSSatish Balay   }
1017e5c89e4eSSatish Balay 
1018ff5bc46bSBarry Smith   mname[0] = 0;
1019a297a907SKarl Rupp 
10200298fd71SBarry Smith   ierr = PetscOptionsGetString(NULL,"-log_summary_python",mname,PETSC_MAX_PATH_LEN,&flg1);CHKERRQ(ierr);
1021ff5bc46bSBarry Smith   if (flg1) {
1022ff5bc46bSBarry Smith     PetscViewer viewer;
1023ff5bc46bSBarry Smith     if (mname[0]) {
1024ff5bc46bSBarry Smith       ierr = PetscViewerASCIIOpen(PETSC_COMM_WORLD,mname,&viewer);CHKERRQ(ierr);
102591eabc43SBarry Smith       ierr = PetscLogViewPython(viewer);CHKERRQ(ierr);
10266bf464f9SBarry Smith       ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr);
102733f85c2fSBarry Smith     } else {
102833f85c2fSBarry Smith       viewer = PETSC_VIEWER_STDOUT_WORLD;
102933f85c2fSBarry Smith       ierr   = PetscLogViewPython(viewer);CHKERRQ(ierr);
103033f85c2fSBarry Smith     }
1031ff5bc46bSBarry Smith   }
1032ff5bc46bSBarry Smith 
10330298fd71SBarry Smith   ierr = PetscOptionsGetString(NULL,"-log_detailed",mname,PETSC_MAX_PATH_LEN,&flg1);CHKERRQ(ierr);
103478392ef1SBarry Smith   if (flg1) {
103578392ef1SBarry Smith     if (mname[0])  {ierr = PetscLogPrintDetailed(PETSC_COMM_WORLD,mname);CHKERRQ(ierr);}
103678392ef1SBarry Smith     else           {ierr = PetscLogPrintDetailed(PETSC_COMM_WORLD,0);CHKERRQ(ierr);}
103778392ef1SBarry Smith   }
103878392ef1SBarry Smith 
1039e5c89e4eSSatish Balay   mname[0] = 0;
1040a297a907SKarl Rupp 
10410298fd71SBarry Smith   ierr = PetscOptionsGetString(NULL,"-log_all",mname,PETSC_MAX_PATH_LEN,&flg1);CHKERRQ(ierr);
10420298fd71SBarry Smith   ierr = PetscOptionsGetString(NULL,"-log",mname,PETSC_MAX_PATH_LEN,&flg2);CHKERRQ(ierr);
1043e5c89e4eSSatish Balay   if (flg1 || flg2) {
1044e5c89e4eSSatish Balay     if (mname[0]) PetscLogDump(mname);
1045e5c89e4eSSatish Balay     else          PetscLogDump(0);
1046e5c89e4eSSatish Balay   }
1047e5c89e4eSSatish Balay #endif
104810463e74SBarry Smith 
1049b58ca069SBarry Smith   /*
1050b58ca069SBarry Smith      Free all objects registered with PetscObjectRegisterDestroy() such as PETSC_VIEWER_XXX_().
1051b58ca069SBarry Smith   */
1052b58ca069SBarry Smith   ierr = PetscObjectRegisterDestroyAll();CHKERRQ(ierr);
1053b58ca069SBarry Smith 
105433f85c2fSBarry Smith   ierr = PetscStackDestroy();CHKERRQ(ierr);
105576386721SLisandro Dalcin   PetscThreadLocalDestroy((PetscThreadKey)petscstack); /* Deletes pthread_key */
105610463e74SBarry Smith 
105790d69ab7SBarry Smith   flg1 = PETSC_FALSE;
10580298fd71SBarry Smith   ierr = PetscOptionsGetBool(NULL,"-no_signal_handler",&flg1,NULL);CHKERRQ(ierr);
1059e5c89e4eSSatish Balay   if (!flg1) { ierr = PetscPopSignalHandler();CHKERRQ(ierr);}
106090d69ab7SBarry Smith   flg1 = PETSC_FALSE;
10610298fd71SBarry Smith   ierr = PetscOptionsGetBool(NULL,"-mpidump",&flg1,NULL);CHKERRQ(ierr);
1062e5c89e4eSSatish Balay   if (flg1) {
1063e5c89e4eSSatish Balay     ierr = PetscMPIDump(stdout);CHKERRQ(ierr);
1064e5c89e4eSSatish Balay   }
106590d69ab7SBarry Smith   flg1 = PETSC_FALSE;
106690d69ab7SBarry Smith   flg2 = PETSC_FALSE;
10678bb29257SSatish Balay   /* preemptive call to avoid listing this option in options table as unused */
10680298fd71SBarry Smith   ierr = PetscOptionsHasName(NULL,"-malloc_dump",&flg1);CHKERRQ(ierr);
10690298fd71SBarry Smith   ierr = PetscOptionsHasName(NULL,"-objects_dump",&flg1);CHKERRQ(ierr);
10700298fd71SBarry Smith   ierr = PetscOptionsGetBool(NULL,"-options_table",&flg2,NULL);CHKERRQ(ierr);
1071e4c476e2SSatish Balay 
1072e5c89e4eSSatish Balay   if (flg2) {
1073be56827dSJed Brown     PetscViewer viewer;
1074be56827dSJed Brown     ierr = PetscViewerASCIIGetStdout(PETSC_COMM_WORLD,&viewer);CHKERRQ(ierr);
1075be56827dSJed Brown     ierr = PetscOptionsView(viewer);CHKERRQ(ierr);
1076be56827dSJed Brown     ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr);
1077e5c89e4eSSatish Balay   }
1078e5c89e4eSSatish Balay 
1079e5c89e4eSSatish Balay   /* to prevent PETSc -options_left from warning */
10800298fd71SBarry Smith   ierr = PetscOptionsHasName(NULL,"-nox",&flg1);CHKERRQ(ierr);
10810298fd71SBarry Smith   ierr = PetscOptionsHasName(NULL,"-nox_warning",&flg1);CHKERRQ(ierr);
1082e5c89e4eSSatish Balay 
108385afcc9aSBarry Smith   if (!PetscHMPIWorker) { /* worker processes skip this because they do not usually process options */
108433fc4174SSatish Balay     flg3 = PETSC_FALSE; /* default value is required */
10850298fd71SBarry Smith     ierr = PetscOptionsGetBool(NULL,"-options_left",&flg3,&flg1);CHKERRQ(ierr);
1086e5c89e4eSSatish Balay     ierr = PetscOptionsAllUsed(&nopt);CHKERRQ(ierr);
1087e5c89e4eSSatish Balay     if (flg3) {
1088e5c89e4eSSatish Balay       if (!flg2) { /* have not yet printed the options */
1089be56827dSJed Brown         PetscViewer viewer;
1090be56827dSJed Brown         ierr = PetscViewerASCIIGetStdout(PETSC_COMM_WORLD,&viewer);CHKERRQ(ierr);
1091be56827dSJed Brown         ierr = PetscOptionsView(viewer);CHKERRQ(ierr);
1092be56827dSJed Brown         ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr);
1093e5c89e4eSSatish Balay       }
1094e5c89e4eSSatish Balay       if (!nopt) {
1095e5c89e4eSSatish Balay         ierr = PetscPrintf(PETSC_COMM_WORLD,"There are no unused options.\n");CHKERRQ(ierr);
1096e5c89e4eSSatish Balay       } else if (nopt == 1) {
1097e5c89e4eSSatish Balay         ierr = PetscPrintf(PETSC_COMM_WORLD,"There is one unused database option. It is:\n");CHKERRQ(ierr);
1098e5c89e4eSSatish Balay       } else {
10997582186dSLisandro Dalcin         ierr = PetscPrintf(PETSC_COMM_WORLD,"There are %D unused database options. They are:\n",nopt);CHKERRQ(ierr);
1100e5c89e4eSSatish Balay       }
1101e5c89e4eSSatish Balay     }
1102e5c89e4eSSatish Balay #if defined(PETSC_USE_DEBUG)
1103da8b8a77SBarry Smith     if (nopt && !flg3 && !flg1) {
1104e5c89e4eSSatish Balay       ierr = PetscPrintf(PETSC_COMM_WORLD,"WARNING! There are options you set that were not used!\n");CHKERRQ(ierr);
1105e5c89e4eSSatish Balay       ierr = PetscPrintf(PETSC_COMM_WORLD,"WARNING! could be spelling mistake, etc!\n");CHKERRQ(ierr);
1106e5c89e4eSSatish Balay       ierr = PetscOptionsLeft();CHKERRQ(ierr);
1107e5c89e4eSSatish Balay     } else if (nopt && flg3) {
1108e5c89e4eSSatish Balay #else
1109e5c89e4eSSatish Balay     if (nopt && flg3) {
1110e5c89e4eSSatish Balay #endif
1111e5c89e4eSSatish Balay       ierr = PetscOptionsLeft();CHKERRQ(ierr);
1112e5c89e4eSSatish Balay     }
1113931f367cSBarry Smith   }
1114e5c89e4eSSatish Balay 
1115eea2bdeeSJed Brown   {
1116eea2bdeeSJed Brown     PetscThreadComm tcomm_world;
1117eea2bdeeSJed Brown     ierr = PetscGetThreadCommWorld(&tcomm_world);CHKERRQ(ierr);
1118eea2bdeeSJed Brown     /* Free global thread communicator */
1119eea2bdeeSJed Brown     ierr = PetscThreadCommDestroy(&tcomm_world);CHKERRQ(ierr);
1120eea2bdeeSJed Brown   }
1121eea2bdeeSJed Brown 
112210463e74SBarry Smith   /*
1123dbc8283eSBarry Smith        List all objects the user may have forgot to free
11242eff7a51SBarry Smith   */
11250298fd71SBarry Smith   ierr = PetscOptionsHasName(NULL,"-objects_dump",&flg1);CHKERRQ(ierr);
1126a64a8e02SBarry Smith   if (flg1) {
1127a64a8e02SBarry Smith     MPI_Comm local_comm;
11287eb1d149SBarry Smith     char     string[64];
1129a64a8e02SBarry Smith 
11300298fd71SBarry Smith     ierr = PetscOptionsGetString(NULL,"-objects_dump",string,64,NULL);CHKERRQ(ierr);
1131a64a8e02SBarry Smith     ierr = MPI_Comm_dup(MPI_COMM_WORLD,&local_comm);CHKERRQ(ierr);
1132a64a8e02SBarry Smith     ierr = PetscSequentialPhaseBegin_Private(local_comm,1);CHKERRQ(ierr);
11337eb1d149SBarry Smith     ierr = PetscObjectsDump(stdout,(string[0] == 'a') ? PETSC_TRUE : PETSC_FALSE);CHKERRQ(ierr);
1134a64a8e02SBarry Smith     ierr = PetscSequentialPhaseEnd_Private(local_comm,1);CHKERRQ(ierr);
1135a64a8e02SBarry Smith     ierr = MPI_Comm_free(&local_comm);CHKERRQ(ierr);
11360a1571b3SBarry Smith   }
1137dbc8283eSBarry Smith   PetscObjectsCounts    = 0;
1138dbc8283eSBarry Smith   PetscObjectsMaxCounts = 0;
11392eff7a51SBarry Smith 
1140a297a907SKarl Rupp   ierr = PetscFree(PetscObjects);CHKERRQ(ierr);
11412eff7a51SBarry Smith 
114233f85c2fSBarry Smith #if defined(PETSC_USE_LOG)
114333f85c2fSBarry Smith   ierr = PetscLogDestroy();CHKERRQ(ierr);
114433f85c2fSBarry Smith #endif
114533f85c2fSBarry Smith 
114633f85c2fSBarry Smith   /*
114733f85c2fSBarry Smith      Destroy any packages that registered a finalize
114833f85c2fSBarry Smith   */
114933f85c2fSBarry Smith   ierr = PetscRegisterFinalizeAll();CHKERRQ(ierr);
115033f85c2fSBarry Smith 
115133f85c2fSBarry Smith   /*
115210463e74SBarry Smith      Destroy all the function registration lists created
115310463e74SBarry Smith   */
115410463e74SBarry Smith   ierr = PetscFinalize_DynamicLibraries();CHKERRQ(ierr);
115510463e74SBarry Smith 
115648dd1dffSBarry Smith   /*
115748dd1dffSBarry Smith      Print PetscFunctionLists that have not been properly freed
115848dd1dffSBarry Smith 
115937e93019SBarry Smith   ierr = PetscFunctionListPrintAll();CHKERRQ(ierr);
116048dd1dffSBarry Smith   */
116137e93019SBarry Smith 
11624028d114SSatish Balay   if (petsc_history) {
1163f3dea69dSBarry Smith     ierr = PetscCloseHistoryFile(&petsc_history);CHKERRQ(ierr);
1164e5c89e4eSSatish Balay     petsc_history = 0;
1165e5c89e4eSSatish Balay   }
1166e5c89e4eSSatish Balay 
11670298fd71SBarry Smith   ierr = PetscInfoAllow(PETSC_FALSE,NULL);CHKERRQ(ierr);
1168e5c89e4eSSatish Balay 
11698bb29257SSatish Balay   {
1170e5c89e4eSSatish Balay     char fname[PETSC_MAX_PATH_LEN];
1171e5c89e4eSSatish Balay     FILE *fd;
1172ed9cf6e9SBarry Smith     int  err;
1173e5c89e4eSSatish Balay 
1174e5c89e4eSSatish Balay     fname[0] = 0;
1175a297a907SKarl Rupp 
11760298fd71SBarry Smith     ierr = PetscOptionsGetString(NULL,"-malloc_dump",fname,250,&flg1);CHKERRQ(ierr);
1177dc92acbaSJed Brown     flg2 = PETSC_FALSE;
11780298fd71SBarry Smith     ierr = PetscOptionsGetBool(NULL,"-malloc_test",&flg2,NULL);CHKERRQ(ierr);
11798bf1f09cSShri Abhyankar #if defined(PETSC_USE_DEBUG)
1180dc92acbaSJed Brown     if (PETSC_RUNNING_ON_VALGRIND) flg2 = PETSC_FALSE;
1181dc92acbaSJed Brown #else
1182dc92acbaSJed Brown     flg2 = PETSC_FALSE;         /* Skip reporting for optimized builds regardless of -malloc_test */
1183dc92acbaSJed Brown #endif
1184e5c89e4eSSatish Balay     if (flg1 && fname[0]) {
1185e5c89e4eSSatish Balay       char sname[PETSC_MAX_PATH_LEN];
1186e5c89e4eSSatish Balay 
1187e5c89e4eSSatish Balay       sprintf(sname,"%s_%d",fname,rank);
1188e32f2f54SBarry Smith       fd   = fopen(sname,"w"); if (!fd) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_FILE_OPEN,"Cannot open log file: %s",sname);
1189e5c89e4eSSatish Balay       ierr = PetscMallocDump(fd);CHKERRQ(ierr);
1190ed9cf6e9SBarry Smith       err  = fclose(fd);
1191e32f2f54SBarry Smith       if (err) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SYS,"fclose() failed on file");
1192dc92acbaSJed Brown     } else if (flg1 || flg2) {
1193e5c89e4eSSatish Balay       MPI_Comm local_comm;
1194e5c89e4eSSatish Balay 
1195e5c89e4eSSatish Balay       ierr = MPI_Comm_dup(MPI_COMM_WORLD,&local_comm);CHKERRQ(ierr);
1196e5c89e4eSSatish Balay       ierr = PetscSequentialPhaseBegin_Private(local_comm,1);CHKERRQ(ierr);
1197e5c89e4eSSatish Balay       ierr = PetscMallocDump(stdout);CHKERRQ(ierr);
1198e5c89e4eSSatish Balay       ierr = PetscSequentialPhaseEnd_Private(local_comm,1);CHKERRQ(ierr);
1199e5c89e4eSSatish Balay       ierr = MPI_Comm_free(&local_comm);CHKERRQ(ierr);
1200e5c89e4eSSatish Balay     }
1201e5c89e4eSSatish Balay   }
1202a64a8e02SBarry Smith 
12038bb29257SSatish Balay   {
1204e5c89e4eSSatish Balay     char fname[PETSC_MAX_PATH_LEN];
12050298fd71SBarry Smith     FILE *fd = NULL;
1206e5c89e4eSSatish Balay 
1207e5c89e4eSSatish Balay     fname[0] = 0;
1208a297a907SKarl Rupp 
12090298fd71SBarry Smith     ierr = PetscOptionsGetString(NULL,"-malloc_log",fname,250,&flg1);CHKERRQ(ierr);
12100298fd71SBarry Smith     ierr = PetscOptionsHasName(NULL,"-malloc_log_threshold",&flg2);CHKERRQ(ierr);
1211e5c89e4eSSatish Balay     if (flg1 && fname[0]) {
1212ed9cf6e9SBarry Smith       int err;
1213e5c89e4eSSatish Balay 
1214574034a9SJed Brown       if (!rank) {
1215574034a9SJed Brown         fd = fopen(fname,"w");
1216574034a9SJed Brown         if (!fd) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_FILE_OPEN,"Cannot open log file: %s",fname);
1217574034a9SJed Brown       }
1218e5c89e4eSSatish Balay       ierr = PetscMallocDumpLog(fd);CHKERRQ(ierr);
1219574034a9SJed Brown       if (fd) {
1220ed9cf6e9SBarry Smith         err = fclose(fd);
1221e32f2f54SBarry Smith         if (err) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SYS,"fclose() failed on file");
1222574034a9SJed Brown       }
1223574034a9SJed Brown     } else if (flg1 || flg2) {
1224e5c89e4eSSatish Balay       ierr = PetscMallocDumpLog(stdout);CHKERRQ(ierr);
1225e5c89e4eSSatish Balay     }
1226e5c89e4eSSatish Balay   }
1227*20e2c332SMatthew G. Knepley 
1228*20e2c332SMatthew G. Knepley #if defined(PETSC_HAVE_CUDA)
1229*20e2c332SMatthew G. Knepley   flg  = PETSC_TRUE;
1230*20e2c332SMatthew G. Knepley   ierr = PetscOptionsGetBool(NULL,"-cublas",&flg,NULL);CHKERRQ(ierr);
1231*20e2c332SMatthew G. Knepley   if (flg) {
1232*20e2c332SMatthew G. Knepley     PetscInt p;
1233*20e2c332SMatthew G. Knepley     for (p = 0; p < PetscGlobalSize; ++p) {
1234*20e2c332SMatthew G. Knepley       if (p == PetscGlobalRank) cublasShutdown();
1235*20e2c332SMatthew G. Knepley       ierr = MPI_Barrier(PETSC_COMM_WORLD);CHKERRQ(ierr);
1236*20e2c332SMatthew G. Knepley     }
1237*20e2c332SMatthew G. Knepley   }
1238*20e2c332SMatthew G. Knepley #endif
1239*20e2c332SMatthew G. Knepley 
1240e5c89e4eSSatish Balay   /* Can be destroyed only after all the options are used */
1241e5c89e4eSSatish Balay   ierr = PetscOptionsDestroy();CHKERRQ(ierr);
1242e5c89e4eSSatish Balay 
1243e5c89e4eSSatish Balay   PetscGlobalArgc = 0;
1244e5c89e4eSSatish Balay   PetscGlobalArgs = 0;
1245e5c89e4eSSatish Balay 
1246ce63c4c1SBarry Smith #if defined(PETSC_USE_REAL___FLOAT128)
1247c90a1750SBarry Smith   ierr = MPI_Type_free(&MPIU___FLOAT128);CHKERRQ(ierr);
12487c2de775SJed Brown #if defined(PETSC_HAVE_COMPLEX)
12498c764dc5SJose Roman   ierr = MPI_Type_free(&MPIU___COMPLEX128);CHKERRQ(ierr);
12508c764dc5SJose Roman #endif
1251d9822059SBarry Smith   ierr = MPI_Op_free(&MPIU_MAX);CHKERRQ(ierr);
1252d9822059SBarry Smith   ierr = MPI_Op_free(&MPIU_MIN);CHKERRQ(ierr);
1253c90a1750SBarry Smith #endif
1254c90a1750SBarry Smith 
12557c2de775SJed Brown #if defined(PETSC_HAVE_COMPLEX)
12562c876bd9SBarry Smith #if !defined(PETSC_HAVE_MPI_C_DOUBLE_COMPLEX)
1257500d8756SSatish Balay   ierr = MPI_Type_free(&MPIU_C_DOUBLE_COMPLEX);CHKERRQ(ierr);
1258500d8756SSatish Balay   ierr = MPI_Type_free(&MPIU_C_COMPLEX);CHKERRQ(ierr);
12592c876bd9SBarry Smith #endif
1260e5c89e4eSSatish Balay #endif
1261cca4cb22SSatish Balay 
12627c2de775SJed Brown #if (defined(PETSC_HAVE_COMPLEX) && !defined(PETSC_HAVE_MPI_C_DOUBLE_COMPLEX)) || defined(PETSC_USE_REAL___FLOAT128)
1263cca4cb22SSatish Balay   ierr = MPI_Op_free(&MPIU_SUM);CHKERRQ(ierr);
1264cca4cb22SSatish Balay #endif
1265cca4cb22SSatish Balay 
1266e5c89e4eSSatish Balay   ierr = MPI_Type_free(&MPIU_2SCALAR);CHKERRQ(ierr);
126744041f26SJed Brown #if defined(PETSC_USE_64BIT_INDICES) || !defined(MPI_2INT)
1268e5c89e4eSSatish Balay   ierr = MPI_Type_free(&MPIU_2INT);CHKERRQ(ierr);
126944041f26SJed Brown #endif
1270e5c89e4eSSatish Balay   ierr = MPI_Op_free(&PetscMaxSum_Op);CHKERRQ(ierr);
1271e5c89e4eSSatish Balay   ierr = MPI_Op_free(&PetscADMax_Op);CHKERRQ(ierr);
1272e5c89e4eSSatish Balay   ierr = MPI_Op_free(&PetscADMin_Op);CHKERRQ(ierr);
1273e5c89e4eSSatish Balay 
1274dbc8283eSBarry Smith   /*
1275efb80d3cSBarry Smith      Destroy any known inner MPI_Comm's and attributes pointing to them
1276efb80d3cSBarry Smith      Note this will not destroy any new communicators the user has created.
1277efb80d3cSBarry Smith 
1278efb80d3cSBarry Smith      If all PETSc objects were not destroyed those left over objects will have hanging references to
1279efb80d3cSBarry Smith      the MPI_Comms that were freed; but that is ok because those PETSc objects will never be used again
1280dbc8283eSBarry Smith  */
1281b770b1f6SSatish Balay   {
1282dbc8283eSBarry Smith     PetscCommCounter *counter;
1283dbc8283eSBarry Smith     PetscMPIInt      flg;
1284dbc8283eSBarry Smith     MPI_Comm         icomm;
1285265f3f35SJed Brown     union {MPI_Comm comm; void *ptr;} ucomm;
1286265f3f35SJed Brown     ierr = MPI_Attr_get(PETSC_COMM_SELF,Petsc_InnerComm_keyval,&ucomm,&flg);CHKERRQ(ierr);
1287dbc8283eSBarry Smith     if (flg) {
1288265f3f35SJed Brown       icomm = ucomm.comm;
1289dbc8283eSBarry Smith       ierr = MPI_Attr_get(icomm,Petsc_Counter_keyval,&counter,&flg);CHKERRQ(ierr);
1290dbc8283eSBarry 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");
1291dbc8283eSBarry Smith 
1292dbc8283eSBarry Smith       ierr = MPI_Attr_delete(PETSC_COMM_SELF,Petsc_InnerComm_keyval);CHKERRQ(ierr);
1293efb80d3cSBarry Smith       ierr = MPI_Attr_delete(icomm,Petsc_Counter_keyval);CHKERRQ(ierr);
1294efb80d3cSBarry Smith       ierr = MPI_Comm_free(&icomm);CHKERRQ(ierr);
1295dbc8283eSBarry Smith     }
1296265f3f35SJed Brown     ierr = MPI_Attr_get(PETSC_COMM_WORLD,Petsc_InnerComm_keyval,&ucomm,&flg);CHKERRQ(ierr);
1297dbc8283eSBarry Smith     if (flg) {
1298265f3f35SJed Brown       icomm = ucomm.comm;
1299dbc8283eSBarry Smith       ierr = MPI_Attr_get(icomm,Petsc_Counter_keyval,&counter,&flg);CHKERRQ(ierr);
1300dbc8283eSBarry 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");
1301dbc8283eSBarry Smith 
1302dbc8283eSBarry Smith       ierr = MPI_Attr_delete(PETSC_COMM_WORLD,Petsc_InnerComm_keyval);CHKERRQ(ierr);
1303efb80d3cSBarry Smith       ierr = MPI_Attr_delete(icomm,Petsc_Counter_keyval);CHKERRQ(ierr);
1304efb80d3cSBarry Smith       ierr = MPI_Comm_free(&icomm);CHKERRQ(ierr);
1305dbc8283eSBarry Smith     }
1306b770b1f6SSatish Balay   }
1307dbc8283eSBarry Smith 
1308480cf27aSJed Brown   ierr = MPI_Keyval_free(&Petsc_Counter_keyval);CHKERRQ(ierr);
1309480cf27aSJed Brown   ierr = MPI_Keyval_free(&Petsc_InnerComm_keyval);CHKERRQ(ierr);
1310480cf27aSJed Brown   ierr = MPI_Keyval_free(&Petsc_OuterComm_keyval);CHKERRQ(ierr);
1311480cf27aSJed Brown 
1312e5c89e4eSSatish Balay   if (PetscBeganMPI) {
131399608316SBarry Smith #if defined(PETSC_HAVE_MPI_FINALIZED)
131499b1327fSBarry Smith     PetscMPIInt flag;
131599b1327fSBarry Smith     ierr = MPI_Finalized(&flag);CHKERRQ(ierr);
1316e32f2f54SBarry Smith     if (flag) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_LIB,"MPI_Finalize() has already been called, even though MPI_Init() was called by PetscInitialize()");
131799608316SBarry Smith #endif
1318e5c89e4eSSatish Balay     ierr = MPI_Finalize();CHKERRQ(ierr);
1319e5c89e4eSSatish Balay   }
1320e5c89e4eSSatish Balay /*
1321e5c89e4eSSatish Balay 
1322e5c89e4eSSatish Balay      Note: In certain cases PETSC_COMM_WORLD is never MPI_Comm_free()ed because
1323e5c89e4eSSatish Balay    the communicator has some outstanding requests on it. Specifically if the
1324e5c89e4eSSatish Balay    flag PETSC_HAVE_BROKEN_REQUEST_FREE is set (for IBM MPI implementation). See
1325e5c89e4eSSatish Balay    src/vec/utils/vpscat.c. Due to this the memory allocated in PetscCommDuplicate()
1326e5c89e4eSSatish Balay    is never freed as it should be. Thus one may obtain messages of the form
13270e5e90baSSatish Balay    [ 1] 8 bytes PetscCommDuplicate() line 645 in src/sys/mpiu.c indicating the
1328e5c89e4eSSatish Balay    memory was not freed.
1329e5c89e4eSSatish Balay 
1330e5c89e4eSSatish Balay */
13311d1a0024SBarry Smith   ierr = PetscMallocClear();CHKERRQ(ierr);
1332a297a907SKarl Rupp 
1333e5c89e4eSSatish Balay   PetscInitializeCalled = PETSC_FALSE;
1334e5c89e4eSSatish Balay   PetscFinalizeCalled   = PETSC_TRUE;
1335e5c89e4eSSatish Balay   PetscFunctionReturn(ierr);
1336e5c89e4eSSatish Balay }
1337e5c89e4eSSatish Balay 
133843db4dbbSBarry Smith #if defined(PETSC_MISSING_LAPACK_lsame_)
13398cc058d9SJed Brown PETSC_EXTERN int lsame_(char *a,char *b)
134043db4dbbSBarry Smith {
134143db4dbbSBarry Smith   if (*a == *b) return 1;
134243db4dbbSBarry Smith   if (*a + 32 == *b) return 1;
134343db4dbbSBarry Smith   if (*a - 32 == *b) return 1;
134443db4dbbSBarry Smith   return 0;
134543db4dbbSBarry Smith }
1346a70650f6SBarry Smith #endif
134743db4dbbSBarry Smith 
134843db4dbbSBarry Smith #if defined(PETSC_MISSING_LAPACK_lsame)
13498cc058d9SJed Brown PETSC_EXTERN int lsame(char *a,char *b)
135043db4dbbSBarry Smith {
135143db4dbbSBarry Smith   if (*a == *b) return 1;
135243db4dbbSBarry Smith   if (*a + 32 == *b) return 1;
135343db4dbbSBarry Smith   if (*a - 32 == *b) return 1;
135443db4dbbSBarry Smith   return 0;
135543db4dbbSBarry Smith }
135643db4dbbSBarry Smith #endif
1357