xref: /petsc/src/sys/objects/pinit.c (revision e4d1774bba497c88855ca48ceec8de09b31e2d79)
17d0a6c19SBarry Smith 
2e5c89e4eSSatish Balay /*
3e5c89e4eSSatish Balay    This file defines the initialization of PETSc, including PetscInitialize()
4e5c89e4eSSatish Balay */
5e5c89e4eSSatish Balay 
6c6db04a5SJed Brown #include <petscsys.h>        /*I  "petscsys.h"   I*/
78101f56cSMatthew Knepley 
88154be41SBarry Smith #if defined(PETSC_HAVE_CUSP)
92f947c57SVictor Minden #include <cublas.h>
107a025f21SVictor Minden #endif
117a025f21SVictor Minden 
12a9f03627SSatish Balay #if defined(PETSC_USE_LOG)
1309573ac7SBarry Smith extern PetscErrorCode PetscLogBegin_Private(void);
14a9f03627SSatish Balay #endif
1585afcc9aSBarry Smith extern PetscBool  PetscHMPIWorker;
16f2d66bcaSShri Abhyankar 
17e5c89e4eSSatish Balay /* -----------------------------------------------------------------------------------------*/
18e5c89e4eSSatish Balay 
19e5c89e4eSSatish Balay extern FILE *petsc_history;
20e5c89e4eSSatish Balay 
2109573ac7SBarry Smith extern PetscErrorCode PetscInitialize_DynamicLibraries(void);
2209573ac7SBarry Smith extern PetscErrorCode PetscFinalize_DynamicLibraries(void);
2309573ac7SBarry Smith extern PetscErrorCode PetscFListDestroyAll(void);
24*e4d1774bSDmitry Karpeev extern PetscErrorCode PetscOpFListDestroyAll(void);
2509573ac7SBarry Smith extern PetscErrorCode PetscSequentialPhaseBegin_Private(MPI_Comm,int);
2609573ac7SBarry Smith extern PetscErrorCode PetscSequentialPhaseEnd_Private(MPI_Comm,int);
2709573ac7SBarry Smith extern PetscErrorCode PetscCloseHistoryFile(FILE **);
280069ddf5SShri Abhyankar 
290069ddf5SShri Abhyankar #if defined(PETSC_HAVE_PTHREADCLASSES)
30cfcfc605SKerry Stevens extern int* ThreadCoreAffinity;
31f2d66bcaSShri Abhyankar extern PetscErrorCode (*PetscThreadFinalize)(void);
320069ddf5SShri Abhyankar extern PetscErrorCode (*PetscThreadInitialize)(PetscInt);
330069ddf5SShri Abhyankar extern PetscMPIInt PetscMaxThreads;
340069ddf5SShri Abhyankar #endif
350069ddf5SShri Abhyankar 
36e5c89e4eSSatish Balay /* this is used by the _, __, and ___ macros (see include/petscerror.h) */
37e5c89e4eSSatish Balay PetscErrorCode __gierr = 0;
38e5c89e4eSSatish Balay 
39e5c89e4eSSatish Balay /* user may set this BEFORE calling PetscInitialize() */
40e8373e55SMatthew Knepley MPI_Comm PETSC_COMM_WORLD = MPI_COMM_NULL;
41e5c89e4eSSatish Balay 
42480cf27aSJed Brown PetscMPIInt Petsc_Counter_keyval   = MPI_KEYVAL_INVALID;
43480cf27aSJed Brown PetscMPIInt Petsc_InnerComm_keyval = MPI_KEYVAL_INVALID;
44480cf27aSJed Brown PetscMPIInt Petsc_OuterComm_keyval = MPI_KEYVAL_INVALID;
45480cf27aSJed Brown 
46e5c89e4eSSatish Balay /*
47e5c89e4eSSatish Balay      Declare and set all the string names of the PETSc enums
48e5c89e4eSSatish Balay */
49ace3abfcSBarry Smith const char *PetscBools[]     = {"FALSE","TRUE","PetscBool","PETSC_",0};
5070b3c8c7SBarry Smith const char *PetscCopyModes[] = {"COPY_VALUES","OWN_POINTER","USE_POINTER","PetscCopyMode","PETSC_",0};
5170b3c8c7SBarry Smith const char *PetscDataTypes[] = {"INT","DOUBLE","COMPLEX","LONG","SHORT","FLOAT",
52ace3abfcSBarry Smith                                 "CHAR","LOGICAL","ENUM","BOOL","LONGDOUBLE","PetscDataType","PETSC_",0};
53e5c89e4eSSatish Balay 
54ace3abfcSBarry Smith PetscBool  PetscPreLoadingUsed = PETSC_FALSE;
55ace3abfcSBarry Smith PetscBool  PetscPreLoadingOn   = PETSC_FALSE;
560f8e0872SSatish Balay 
57e5c89e4eSSatish Balay /*
58e5c89e4eSSatish Balay        Checks the options database for initializations related to the
59e5c89e4eSSatish Balay     PETSc components
60e5c89e4eSSatish Balay */
61e5c89e4eSSatish Balay #undef __FUNCT__
62e5c89e4eSSatish Balay #define __FUNCT__ "PetscOptionsCheckInitial_Components"
637087cfbeSBarry Smith PetscErrorCode  PetscOptionsCheckInitial_Components(void)
64e5c89e4eSSatish Balay {
65ace3abfcSBarry Smith   PetscBool  flg1;
66e5c89e4eSSatish Balay   PetscErrorCode ierr;
67e5c89e4eSSatish Balay 
68e5c89e4eSSatish Balay   PetscFunctionBegin;
69e5c89e4eSSatish Balay   ierr = PetscOptionsHasName(PETSC_NULL,"-help",&flg1);CHKERRQ(ierr);
70e5c89e4eSSatish Balay   if (flg1) {
71e5c89e4eSSatish Balay #if defined (PETSC_USE_LOG)
72e8e7597cSSatish Balay     MPI_Comm   comm = PETSC_COMM_WORLD;
73e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm,"------Additional PETSc component options--------\n");CHKERRQ(ierr);
74e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm," -log_summary_exclude: <vec,mat,pc.ksp,snes>\n");CHKERRQ(ierr);
756cf91177SBarry Smith     ierr = (*PetscHelpPrintf)(comm," -info_exclude: <null,vec,mat,pc,ksp,snes,ts>\n");CHKERRQ(ierr);
76e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm,"-----------------------------------------------\n");CHKERRQ(ierr);
77e5c89e4eSSatish Balay #endif
78e5c89e4eSSatish Balay   }
79e5c89e4eSSatish Balay   PetscFunctionReturn(0);
80e5c89e4eSSatish Balay }
81e5c89e4eSSatish Balay 
820f11a792SBarry Smith #if defined(PETSC_HAVE_MATLAB_ENGINE)
83df413903SBarry Smith extern PetscBool PetscBeganMPI;
84df413903SBarry Smith 
85e5c89e4eSSatish Balay #undef __FUNCT__
860f11a792SBarry Smith #define __FUNCT__ "PetscInitializeMatlab"
870f11a792SBarry Smith /*
880f11a792SBarry Smith       PetscInitializeMatlab - Calls PetscInitialize() from C/C++ without the pointers to argc and args
8972a42c3cSBarry Smith 
9072a42c3cSBarry Smith    Collective
9172a42c3cSBarry Smith 
9272a42c3cSBarry Smith    Level: advanced
9372a42c3cSBarry Smith 
940f11a792SBarry Smith     Notes: this is called only by the PETSc MATLAB interface. Even though it might start MPI it sets the flag to
950f11a792SBarry Smith      indicate that it did NOT start MPI so that the PetscFinalize() does not end MPI, thus allowing PetscInitialize() to
960f11a792SBarry Smith      be called multiple times from MATLAB without the problem of trying to initialize MPI more than once.
970f11a792SBarry Smith 
981ea5a559SBarry Smith      Turns off PETSc signal handling because that can interact with MATLAB's signal handling causing random crashes.
991ea5a559SBarry Smith 
10072a42c3cSBarry Smith .seealso: PetscInitialize(), PetscInitializeFortran(), PetscInitializeNoArguments()
1010f11a792SBarry Smith */
1020f11a792SBarry Smith PetscErrorCode  PetscInitializeMatlab(int argc,char **args,const char *filename,const char *help)
10372a42c3cSBarry Smith {
10472a42c3cSBarry Smith   PetscErrorCode ierr;
10572a42c3cSBarry Smith   int            myargc = argc;
10672a42c3cSBarry Smith   char           **myargs = args;
10772a42c3cSBarry Smith 
10872a42c3cSBarry Smith   PetscFunctionBegin;
10972a42c3cSBarry Smith   ierr = PetscInitialize(&myargc,&myargs,filename,help);
1101ea5a559SBarry Smith   ierr = PetscPopSignalHandler();CHKERRQ(ierr);
111df413903SBarry Smith   PetscBeganMPI = PETSC_FALSE;
11272a42c3cSBarry Smith   PetscFunctionReturn(ierr);
11372a42c3cSBarry Smith }
11472a42c3cSBarry Smith 
11572a42c3cSBarry Smith #undef __FUNCT__
1160f11a792SBarry Smith #define __FUNCT__ "PetscInitializedMatlab"
1170f11a792SBarry Smith /*
1180f11a792SBarry Smith       PetscInitializedMatlab - Has PETSc been initialized already?
1190f11a792SBarry Smith 
1200f11a792SBarry Smith    Not Collective
1210f11a792SBarry Smith 
1220f11a792SBarry Smith    Level: advanced
1230f11a792SBarry Smith 
1240f11a792SBarry Smith     Notes: this is called only by the PETSc MATLAB interface.
1250f11a792SBarry Smith 
1260f11a792SBarry Smith .seealso: PetscInitialize(), PetscInitializeFortran(), PetscInitializeNoArguments()
1270f11a792SBarry Smith */
1280f11a792SBarry Smith int  PetscInitializedMatlab(void)
1290f11a792SBarry Smith {
1300f11a792SBarry Smith   PetscBool flg;
1310f11a792SBarry Smith 
1320f11a792SBarry Smith   PetscInitialized(&flg);
1330f11a792SBarry Smith   if (flg) return 1;
1340f11a792SBarry Smith   else return 0;
1350f11a792SBarry Smith }
1360f11a792SBarry Smith 
1370f11a792SBarry Smith #undef __FUNCT__
1380f11a792SBarry Smith #define __FUNCT__ "PetscGetPETSC_COMM_SELFMatlab"
139f0865b08SBarry Smith /*
140e3c5b3baSBarry Smith       Used by MATLAB interface to get communicator
141f0865b08SBarry Smith */
1420f11a792SBarry Smith PetscErrorCode  PetscGetPETSC_COMM_SELFMatlab(MPI_Comm *comm)
143f0865b08SBarry Smith {
144f0865b08SBarry Smith   PetscFunctionBegin;
145f0865b08SBarry Smith   *comm = PETSC_COMM_SELF;
146f0865b08SBarry Smith   PetscFunctionReturn(0);
147f0865b08SBarry Smith }
1480f11a792SBarry Smith #endif
149f0865b08SBarry Smith 
150f0865b08SBarry Smith #undef __FUNCT__
151e5c89e4eSSatish Balay #define __FUNCT__ "PetscInitializeNoArguments"
152e5c89e4eSSatish Balay /*@C
153e5c89e4eSSatish Balay       PetscInitializeNoArguments - Calls PetscInitialize() from C/C++ without
154e5c89e4eSSatish Balay         the command line arguments.
155e5c89e4eSSatish Balay 
156e5c89e4eSSatish Balay    Collective
157e5c89e4eSSatish Balay 
158e5c89e4eSSatish Balay    Level: advanced
159e5c89e4eSSatish Balay 
160e5c89e4eSSatish Balay .seealso: PetscInitialize(), PetscInitializeFortran()
161e5c89e4eSSatish Balay @*/
1627087cfbeSBarry Smith PetscErrorCode  PetscInitializeNoArguments(void)
163e5c89e4eSSatish Balay {
164e5c89e4eSSatish Balay   PetscErrorCode ierr;
165e5c89e4eSSatish Balay   int            argc = 0;
166e5c89e4eSSatish Balay   char           **args = 0;
167e5c89e4eSSatish Balay 
168e5c89e4eSSatish Balay   PetscFunctionBegin;
169e5c89e4eSSatish Balay   ierr = PetscInitialize(&argc,&args,PETSC_NULL,PETSC_NULL);
170e5c89e4eSSatish Balay   PetscFunctionReturn(ierr);
171e5c89e4eSSatish Balay }
172e5c89e4eSSatish Balay 
173e5c89e4eSSatish Balay #undef __FUNCT__
174e5c89e4eSSatish Balay #define __FUNCT__ "PetscInitialized"
175e5c89e4eSSatish Balay /*@
176e5c89e4eSSatish Balay       PetscInitialized - Determine whether PETSc is initialized.
177e5c89e4eSSatish Balay 
1786dc8fec2Sbcordonn 7   Level: beginner
179e5c89e4eSSatish Balay 
180e5c89e4eSSatish Balay .seealso: PetscInitialize(), PetscInitializeNoArguments(), PetscInitializeFortran()
181e5c89e4eSSatish Balay @*/
1827087cfbeSBarry Smith PetscErrorCode  PetscInitialized(PetscBool  *isInitialized)
183e5c89e4eSSatish Balay {
184e5c89e4eSSatish Balay   PetscFunctionBegin;
185e5c89e4eSSatish Balay   PetscValidPointer(isInitialized, 1);
186e5c89e4eSSatish Balay   *isInitialized = PetscInitializeCalled;
187e5c89e4eSSatish Balay   PetscFunctionReturn(0);
188e5c89e4eSSatish Balay }
189e5c89e4eSSatish Balay 
190e5c89e4eSSatish Balay #undef __FUNCT__
191e5c89e4eSSatish Balay #define __FUNCT__ "PetscFinalized"
192e5c89e4eSSatish Balay /*@
193e5c89e4eSSatish Balay       PetscFinalized - Determine whether PetscFinalize() has been called yet
194e5c89e4eSSatish Balay 
195e5c89e4eSSatish Balay    Level: developer
196e5c89e4eSSatish Balay 
197e5c89e4eSSatish Balay .seealso: PetscInitialize(), PetscInitializeNoArguments(), PetscInitializeFortran()
198e5c89e4eSSatish Balay @*/
1997087cfbeSBarry Smith PetscErrorCode  PetscFinalized(PetscBool  *isFinalized)
200e5c89e4eSSatish Balay {
201e5c89e4eSSatish Balay   PetscFunctionBegin;
202e5c89e4eSSatish Balay   PetscValidPointer(isFinalized, 1);
203e5c89e4eSSatish Balay   *isFinalized = PetscFinalizeCalled;
204e5c89e4eSSatish Balay   PetscFunctionReturn(0);
205e5c89e4eSSatish Balay }
206e5c89e4eSSatish Balay 
20709573ac7SBarry Smith extern PetscErrorCode        PetscOptionsCheckInitial_Private(void);
208ace3abfcSBarry Smith extern PetscBool  PetscBeganMPI;
209e5c89e4eSSatish Balay 
210e5c89e4eSSatish Balay /*
211e5c89e4eSSatish Balay        This function is the MPI reduction operation used to compute the sum of the
212e5c89e4eSSatish Balay    first half of the datatype and the max of the second half.
213e5c89e4eSSatish Balay */
214e5c89e4eSSatish Balay MPI_Op PetscMaxSum_Op = 0;
215e5c89e4eSSatish Balay 
216e5c89e4eSSatish Balay EXTERN_C_BEGIN
217e5c89e4eSSatish Balay #undef __FUNCT__
218e5c89e4eSSatish Balay #define __FUNCT__ "PetscMaxSum_Local"
2197087cfbeSBarry Smith void  MPIAPI PetscMaxSum_Local(void *in,void *out,int *cnt,MPI_Datatype *datatype)
220e5c89e4eSSatish Balay {
221e5c89e4eSSatish Balay   PetscInt *xin = (PetscInt*)in,*xout = (PetscInt*)out,i,count = *cnt;
222e5c89e4eSSatish Balay 
223e5c89e4eSSatish Balay   PetscFunctionBegin;
224e5c89e4eSSatish Balay   if (*datatype != MPIU_2INT) {
225e5c89e4eSSatish Balay     (*PetscErrorPrintf)("Can only handle MPIU_2INT data types");
226e5c89e4eSSatish Balay     MPI_Abort(MPI_COMM_WORLD,1);
227e5c89e4eSSatish Balay   }
228e5c89e4eSSatish Balay 
229e5c89e4eSSatish Balay   for (i=0; i<count; i++) {
230e5c89e4eSSatish Balay     xout[2*i]    = PetscMax(xout[2*i],xin[2*i]);
231e5c89e4eSSatish Balay     xout[2*i+1] += xin[2*i+1];
232e5c89e4eSSatish Balay   }
233812af9f3SBarry Smith   PetscFunctionReturnVoid();
234e5c89e4eSSatish Balay }
235e5c89e4eSSatish Balay EXTERN_C_END
236e5c89e4eSSatish Balay 
237e5c89e4eSSatish Balay /*
238e5c89e4eSSatish Balay     Returns the max of the first entry owned by this processor and the
239e5c89e4eSSatish Balay sum of the second entry.
240b693b147SBarry Smith 
241b693b147SBarry Smith     The reason nprocs[2*i] contains lengths nprocs[2*i+1] contains flag of 1 if length is nonzero
242b693b147SBarry Smith is so that the PetscMaxSum_Op() can set TWO values, if we passed in only nprocs[i] with lengths
243b693b147SBarry Smith there would be no place to store the both needed results.
244e5c89e4eSSatish Balay */
245e5c89e4eSSatish Balay #undef __FUNCT__
246e5c89e4eSSatish Balay #define __FUNCT__ "PetscMaxSum"
2477087cfbeSBarry Smith PetscErrorCode  PetscMaxSum(MPI_Comm comm,const PetscInt nprocs[],PetscInt *max,PetscInt *sum)
248e5c89e4eSSatish Balay {
249e5c89e4eSSatish Balay   PetscMPIInt    size,rank;
250e5c89e4eSSatish Balay   PetscInt       *work;
251e5c89e4eSSatish Balay   PetscErrorCode ierr;
252e5c89e4eSSatish Balay 
253e5c89e4eSSatish Balay   PetscFunctionBegin;
254e5c89e4eSSatish Balay   ierr   = MPI_Comm_size(comm,&size);CHKERRQ(ierr);
255e5c89e4eSSatish Balay   ierr   = MPI_Comm_rank(comm,&rank);CHKERRQ(ierr);
256e5c89e4eSSatish Balay   ierr   = PetscMalloc(2*size*sizeof(PetscInt),&work);CHKERRQ(ierr);
257e5c89e4eSSatish Balay   ierr   = MPI_Allreduce((void*)nprocs,work,size,MPIU_2INT,PetscMaxSum_Op,comm);CHKERRQ(ierr);
258e5c89e4eSSatish Balay   *max   = work[2*rank];
259e5c89e4eSSatish Balay   *sum   = work[2*rank+1];
260e5c89e4eSSatish Balay   ierr   = PetscFree(work);CHKERRQ(ierr);
261e5c89e4eSSatish Balay   PetscFunctionReturn(0);
262e5c89e4eSSatish Balay }
263e5c89e4eSSatish Balay 
264e5c89e4eSSatish Balay /* ----------------------------------------------------------------------------*/
2657087cfbeSBarry Smith MPI_Op  PetscADMax_Op = 0;
266e5c89e4eSSatish Balay 
267e5c89e4eSSatish Balay EXTERN_C_BEGIN
268e5c89e4eSSatish Balay #undef __FUNCT__
269e5c89e4eSSatish Balay #define __FUNCT__ "PetscADMax_Local"
2707087cfbeSBarry Smith void  MPIAPI PetscADMax_Local(void *in,void *out,PetscMPIInt *cnt,MPI_Datatype *datatype)
271e5c89e4eSSatish Balay {
272e5c89e4eSSatish Balay   PetscScalar *xin = (PetscScalar *)in,*xout = (PetscScalar*)out;
273e5c89e4eSSatish Balay   PetscInt    i,count = *cnt;
274e5c89e4eSSatish Balay 
275e5c89e4eSSatish Balay   PetscFunctionBegin;
276e5c89e4eSSatish Balay   if (*datatype != MPIU_2SCALAR) {
277e5c89e4eSSatish Balay     (*PetscErrorPrintf)("Can only handle MPIU_2SCALAR data (i.e. double or complex) types");
278e5c89e4eSSatish Balay     MPI_Abort(MPI_COMM_WORLD,1);
279e5c89e4eSSatish Balay   }
280e5c89e4eSSatish Balay 
281e5c89e4eSSatish Balay   for (i=0; i<count; i++) {
282e5c89e4eSSatish Balay     if (PetscRealPart(xout[2*i]) < PetscRealPart(xin[2*i])) {
283e5c89e4eSSatish Balay       xout[2*i]   = xin[2*i];
284e5c89e4eSSatish Balay       xout[2*i+1] = xin[2*i+1];
285e5c89e4eSSatish Balay     }
286e5c89e4eSSatish Balay   }
287812af9f3SBarry Smith   PetscFunctionReturnVoid();
288e5c89e4eSSatish Balay }
289e5c89e4eSSatish Balay EXTERN_C_END
290e5c89e4eSSatish Balay 
2917087cfbeSBarry Smith MPI_Op  PetscADMin_Op = 0;
292e5c89e4eSSatish Balay 
293e5c89e4eSSatish Balay EXTERN_C_BEGIN
294e5c89e4eSSatish Balay #undef __FUNCT__
295e5c89e4eSSatish Balay #define __FUNCT__ "PetscADMin_Local"
2967087cfbeSBarry Smith void  MPIAPI PetscADMin_Local(void *in,void *out,PetscMPIInt *cnt,MPI_Datatype *datatype)
297e5c89e4eSSatish Balay {
298e5c89e4eSSatish Balay   PetscScalar *xin = (PetscScalar *)in,*xout = (PetscScalar*)out;
299e5c89e4eSSatish Balay   PetscInt    i,count = *cnt;
300e5c89e4eSSatish Balay 
301e5c89e4eSSatish Balay   PetscFunctionBegin;
302e5c89e4eSSatish Balay   if (*datatype != MPIU_2SCALAR) {
303e5c89e4eSSatish Balay     (*PetscErrorPrintf)("Can only handle MPIU_2SCALAR data (i.e. double or complex) types");
304e5c89e4eSSatish Balay     MPI_Abort(MPI_COMM_WORLD,1);
305e5c89e4eSSatish Balay   }
306e5c89e4eSSatish Balay 
307e5c89e4eSSatish Balay   for (i=0; i<count; i++) {
308e5c89e4eSSatish Balay     if (PetscRealPart(xout[2*i]) > PetscRealPart(xin[2*i])) {
309e5c89e4eSSatish Balay       xout[2*i]   = xin[2*i];
310e5c89e4eSSatish Balay       xout[2*i+1] = xin[2*i+1];
311e5c89e4eSSatish Balay     }
312e5c89e4eSSatish Balay   }
313812af9f3SBarry Smith   PetscFunctionReturnVoid();
314e5c89e4eSSatish Balay }
315e5c89e4eSSatish Balay EXTERN_C_END
316e5c89e4eSSatish Balay /* ---------------------------------------------------------------------------------------*/
317e5c89e4eSSatish Balay 
318ce63c4c1SBarry Smith #if (defined(PETSC_USE_COMPLEX) && !defined(PETSC_HAVE_MPI_C_DOUBLE_COMPLEX)) || defined(PETSC_USE_REAL___FLOAT128)
31906a205a8SBarry Smith MPI_Op MPIU_SUM = 0;
320e5c89e4eSSatish Balay 
321e5c89e4eSSatish Balay EXTERN_C_BEGIN
322e5c89e4eSSatish Balay #undef __FUNCT__
323e5c89e4eSSatish Balay #define __FUNCT__ "PetscSum_Local"
3247087cfbeSBarry Smith void  PetscSum_Local(void *in,void *out,PetscMPIInt *cnt,MPI_Datatype *datatype)
325e5c89e4eSSatish Balay {
326e5c89e4eSSatish Balay   PetscInt    i,count = *cnt;
327e5c89e4eSSatish Balay 
328e5c89e4eSSatish Balay   PetscFunctionBegin;
329e2e03761SBarry Smith   if (*datatype == MPIU_SCALAR) {
330e2e03761SBarry Smith     PetscScalar *xin = (PetscScalar *)in,*xout = (PetscScalar*)out;
331e5c89e4eSSatish Balay     for (i=0; i<count; i++) {
332e5c89e4eSSatish Balay       xout[i] += xin[i];
333e5c89e4eSSatish Balay     }
334e2e03761SBarry Smith   } else if (*datatype == MPIU_REAL) {
335e2e03761SBarry Smith     PetscReal *xin = (PetscReal *)in,*xout = (PetscReal*)out;
336e2e03761SBarry Smith     for (i=0; i<count; i++) {
337e2e03761SBarry Smith       xout[i] += xin[i];
338e2e03761SBarry Smith     }
339e2e03761SBarry Smith   } else {
340e2e03761SBarry Smith     (*PetscErrorPrintf)("Can only handle MPIU_REAL or MPIU_SCALAR data (i.e. double or complex) types");
341e2e03761SBarry Smith     MPI_Abort(MPI_COMM_WORLD,1);
342e2e03761SBarry Smith   }
343812af9f3SBarry Smith   PetscFunctionReturnVoid();
344e5c89e4eSSatish Balay }
345e5c89e4eSSatish Balay EXTERN_C_END
346e5c89e4eSSatish Balay #endif
347e5c89e4eSSatish Balay 
348ce63c4c1SBarry Smith #if defined(PETSC_USE_REAL___FLOAT128)
349d9822059SBarry Smith MPI_Op MPIU_MAX = 0;
350d9822059SBarry Smith MPI_Op MPIU_MIN = 0;
351d9822059SBarry Smith 
352d9822059SBarry Smith EXTERN_C_BEGIN
353d9822059SBarry Smith #undef __FUNCT__
354d9822059SBarry Smith #define __FUNCT__ "PetscMax_Local"
355d9822059SBarry Smith void  PetscMax_Local(void *in,void *out,PetscMPIInt *cnt,MPI_Datatype *datatype)
356d9822059SBarry Smith {
357d9822059SBarry Smith   PetscScalar *xin = (PetscScalar *)in,*xout = (PetscScalar*)out;
358d9822059SBarry Smith   PetscInt    i,count = *cnt;
359d9822059SBarry Smith 
360d9822059SBarry Smith   PetscFunctionBegin;
361d9822059SBarry Smith   if (*datatype != MPIU_SCALAR) {
362d9822059SBarry Smith     (*PetscErrorPrintf)("Can only handle MPIU_SCALAR data (i.e. double or complex) types");
363d9822059SBarry Smith     MPI_Abort(MPI_COMM_WORLD,1);
364d9822059SBarry Smith   }
365d9822059SBarry Smith 
366d9822059SBarry Smith   for (i=0; i<count; i++) {
367dbf7f789SBarry Smith     xout[i] = PetscMax(xout[i],xin[i]);
368d9822059SBarry Smith   }
369d9822059SBarry Smith   PetscFunctionReturnVoid();
370d9822059SBarry Smith }
371d9822059SBarry Smith EXTERN_C_END
372d9822059SBarry Smith 
373d9822059SBarry Smith EXTERN_C_BEGIN
374d9822059SBarry Smith #undef __FUNCT__
375d9822059SBarry Smith #define __FUNCT__ "PetscMin_Local"
376d9822059SBarry Smith void  PetscMin_Local(void *in,void *out,PetscMPIInt *cnt,MPI_Datatype *datatype)
377d9822059SBarry Smith {
378d9822059SBarry Smith   PetscScalar *xin = (PetscScalar *)in,*xout = (PetscScalar*)out;
379d9822059SBarry Smith   PetscInt    i,count = *cnt;
380d9822059SBarry Smith 
381d9822059SBarry Smith   PetscFunctionBegin;
382d9822059SBarry Smith   if (*datatype != MPIU_SCALAR) {
383d9822059SBarry Smith     (*PetscErrorPrintf)("Can only handle MPIU_SCALAR data (i.e. double or complex) types");
384d9822059SBarry Smith     MPI_Abort(MPI_COMM_WORLD,1);
385d9822059SBarry Smith   }
386d9822059SBarry Smith 
387d9822059SBarry Smith   for (i=0; i<count; i++) {
388dbf7f789SBarry Smith     xout[i] = PetscMin(xout[i],xin[i]);
389d9822059SBarry Smith   }
390d9822059SBarry Smith   PetscFunctionReturnVoid();
391d9822059SBarry Smith }
392d9822059SBarry Smith EXTERN_C_END
393d9822059SBarry Smith #endif
394d9822059SBarry Smith 
395480cf27aSJed Brown EXTERN_C_BEGIN
396480cf27aSJed Brown #undef __FUNCT__
397480cf27aSJed Brown #define __FUNCT__ "Petsc_DelCounter"
398480cf27aSJed Brown /*
399480cf27aSJed Brown    Private routine to delete internal tag/name counter storage when a communicator is freed.
400480cf27aSJed Brown 
401ff0e51ddSBarry 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.
402480cf27aSJed Brown 
403480cf27aSJed Brown    Note: this is declared extern "C" because it is passed to MPI_Keyval_create()
404480cf27aSJed Brown 
405480cf27aSJed Brown */
4067087cfbeSBarry Smith PetscMPIInt  MPIAPI Petsc_DelCounter(MPI_Comm comm,PetscMPIInt keyval,void *count_val,void *extra_state)
407480cf27aSJed Brown {
408480cf27aSJed Brown   PetscErrorCode ierr;
409480cf27aSJed Brown 
410480cf27aSJed Brown   PetscFunctionBegin;
411480cf27aSJed Brown   ierr = PetscInfo1(0,"Deleting counter data in an MPI_Comm %ld\n",(long)comm);if (ierr) PetscFunctionReturn((PetscMPIInt)ierr);
412480cf27aSJed Brown   ierr = PetscFree(count_val);if (ierr) PetscFunctionReturn((PetscMPIInt)ierr);
413480cf27aSJed Brown   PetscFunctionReturn(MPI_SUCCESS);
414480cf27aSJed Brown }
415480cf27aSJed Brown EXTERN_C_END
416480cf27aSJed Brown 
417480cf27aSJed Brown EXTERN_C_BEGIN
418480cf27aSJed Brown #undef __FUNCT__
419480cf27aSJed Brown #define __FUNCT__ "Petsc_DelComm"
420480cf27aSJed Brown /*
421ff0e51ddSBarry Smith   This does not actually free anything, it simply marks when a reference count to an internal or external MPI_Comm reaches zero and the
422ff0e51ddSBarry Smith   the external MPI_Comm drops its reference to the internal or external MPI_Comm
423480cf27aSJed Brown 
424ff0e51ddSBarry Smith   This is called by MPI, not by users. This is called when MPI_Comm_free() is called on the communicator.
425480cf27aSJed Brown 
426480cf27aSJed Brown   Note: this is declared extern "C" because it is passed to MPI_Keyval_create()
427480cf27aSJed Brown 
428480cf27aSJed Brown */
4297087cfbeSBarry Smith PetscMPIInt  MPIAPI Petsc_DelComm(MPI_Comm comm,PetscMPIInt keyval,void *attr_val,void *extra_state)
430480cf27aSJed Brown {
431480cf27aSJed Brown   PetscErrorCode   ierr;
432b89831e5SBarry Smith   PetscMPIInt      flg;
433b89831e5SBarry Smith   MPI_Comm         icomm;
434b89831e5SBarry Smith   void             *ptr;
435480cf27aSJed Brown 
436480cf27aSJed Brown   PetscFunctionBegin;
437b89831e5SBarry Smith   ierr  = MPI_Attr_get(comm,Petsc_InnerComm_keyval,&ptr,&flg);CHKERRQ(ierr);
438b89831e5SBarry Smith   if (flg) {
439b89831e5SBarry Smith     /*  Use PetscMemcpy() because casting from pointer to integer of different size is not allowed with some compilers  */
440b89831e5SBarry Smith     ierr = PetscMemcpy(&icomm,&ptr,sizeof(MPI_Comm));CHKERRQ(ierr);
441b89831e5SBarry Smith     ierr = MPI_Attr_get(icomm,Petsc_OuterComm_keyval,&ptr,&flg);CHKERRQ(ierr);
442b3ef52cdSBarry Smith     if (!flg) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_CORRUPT,"Inner MPI_Comm does not have expected reference to outer comm");
443b89831e5SBarry Smith     ierr = MPI_Attr_delete(icomm,Petsc_OuterComm_keyval);CHKERRQ(ierr);
444b3ef52cdSBarry Smith     ierr = PetscInfo1(0,"User MPI_Comm m %ld is being freed, removing reference from inner PETSc comm to this outer comm\n",(long)comm);if (ierr) PetscFunctionReturn((PetscMPIInt)ierr);
445b89831e5SBarry Smith   } else {
446b89831e5SBarry Smith     ierr = PetscInfo1(0,"Removing reference to PETSc communicator imbedded in a user MPI_Comm m %ld\n",(long)comm);if (ierr) PetscFunctionReturn((PetscMPIInt)ierr);
447b89831e5SBarry Smith   }
448480cf27aSJed Brown   PetscFunctionReturn(MPI_SUCCESS);
449480cf27aSJed Brown }
450480cf27aSJed Brown EXTERN_C_END
451480cf27aSJed Brown 
452951e3c8eSBarry Smith #if defined(PETSC_USE_PETSC_MPI_EXTERNAL32)
453e39fd77fSBarry Smith #if !defined(PETSC_WORDS_BIGENDIAN)
454e39fd77fSBarry Smith EXTERN_C_BEGIN
455e39fd77fSBarry Smith extern PetscMPIInt PetscDataRep_extent_fn(MPI_Datatype,MPI_Aint*,void*);
456e39fd77fSBarry Smith extern PetscMPIInt PetscDataRep_read_conv_fn(void*, MPI_Datatype,PetscMPIInt,void*,MPI_Offset,void*);
457e39fd77fSBarry Smith extern PetscMPIInt PetscDataRep_write_conv_fn(void*, MPI_Datatype,PetscMPIInt,void*,MPI_Offset,void*);
458e39fd77fSBarry Smith EXTERN_C_END
459e39fd77fSBarry Smith #endif
460951e3c8eSBarry Smith #endif
461e39fd77fSBarry Smith 
4626ae9a8a6SBarry Smith int  PetscGlobalArgc   = 0;
4636ae9a8a6SBarry Smith char **PetscGlobalArgs = 0;
464e5c89e4eSSatish Balay 
465e5c89e4eSSatish Balay #undef __FUNCT__
466e5c89e4eSSatish Balay #define __FUNCT__ "PetscGetArgs"
467e5c89e4eSSatish Balay /*@C
468e5c89e4eSSatish Balay    PetscGetArgs - Allows you to access the raw command line arguments anywhere
469e5c89e4eSSatish Balay      after PetscInitialize() is called but before PetscFinalize().
470e5c89e4eSSatish Balay 
471e5c89e4eSSatish Balay    Not Collective
472e5c89e4eSSatish Balay 
473e5c89e4eSSatish Balay    Output Parameters:
474e5c89e4eSSatish Balay +  argc - count of number of command line arguments
475e5c89e4eSSatish Balay -  args - the command line arguments
476e5c89e4eSSatish Balay 
477e5c89e4eSSatish Balay    Level: intermediate
478e5c89e4eSSatish Balay 
479e5c89e4eSSatish Balay    Notes:
480e5c89e4eSSatish Balay       This is usually used to pass the command line arguments into other libraries
481e5c89e4eSSatish Balay    that are called internally deep in PETSc or the application.
482e5c89e4eSSatish Balay 
483f177e3b1SBarry Smith       The first argument contains the program name as is normal for C arguments.
484f177e3b1SBarry Smith 
485e5c89e4eSSatish Balay    Concepts: command line arguments
486e5c89e4eSSatish Balay 
487793721a6SBarry Smith .seealso: PetscFinalize(), PetscInitializeFortran(), PetscGetArguments()
488e5c89e4eSSatish Balay 
489e5c89e4eSSatish Balay @*/
4907087cfbeSBarry Smith PetscErrorCode  PetscGetArgs(int *argc,char ***args)
491e5c89e4eSSatish Balay {
492e5c89e4eSSatish Balay   PetscFunctionBegin;
49317186662SBarry Smith   if (!PetscInitializeCalled && PetscFinalizeCalled) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ORDER,"You must call after PetscInitialize() but before PetscFinalize()");
494e5c89e4eSSatish Balay   *argc = PetscGlobalArgc;
495e5c89e4eSSatish Balay   *args = PetscGlobalArgs;
496e5c89e4eSSatish Balay   PetscFunctionReturn(0);
497e5c89e4eSSatish Balay }
498e5c89e4eSSatish Balay 
499e5c89e4eSSatish Balay #undef __FUNCT__
500793721a6SBarry Smith #define __FUNCT__ "PetscGetArguments"
501793721a6SBarry Smith /*@C
502793721a6SBarry Smith    PetscGetArguments - Allows you to access the  command line arguments anywhere
503793721a6SBarry Smith      after PetscInitialize() is called but before PetscFinalize().
504793721a6SBarry Smith 
505793721a6SBarry Smith    Not Collective
506793721a6SBarry Smith 
507793721a6SBarry Smith    Output Parameters:
508793721a6SBarry Smith .  args - the command line arguments
509793721a6SBarry Smith 
510793721a6SBarry Smith    Level: intermediate
511793721a6SBarry Smith 
512793721a6SBarry Smith    Notes:
513793721a6SBarry Smith       This does NOT start with the program name and IS null terminated (final arg is void)
514793721a6SBarry Smith 
515793721a6SBarry Smith    Concepts: command line arguments
516793721a6SBarry Smith 
517793721a6SBarry Smith .seealso: PetscFinalize(), PetscInitializeFortran(), PetscGetArgs(), PetscFreeArguments()
518793721a6SBarry Smith 
519793721a6SBarry Smith @*/
5207087cfbeSBarry Smith PetscErrorCode  PetscGetArguments(char ***args)
521793721a6SBarry Smith {
522793721a6SBarry Smith   PetscInt       i,argc = PetscGlobalArgc;
523793721a6SBarry Smith   PetscErrorCode ierr;
524793721a6SBarry Smith 
525793721a6SBarry Smith   PetscFunctionBegin;
52617186662SBarry Smith   if (!PetscInitializeCalled && PetscFinalizeCalled) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ORDER,"You must call after PetscInitialize() but before PetscFinalize()");
527717030eeSLisandro Dalcin   if (!argc) {*args = 0; PetscFunctionReturn(0);}
528793721a6SBarry Smith   ierr = PetscMalloc(argc*sizeof(char*),args);CHKERRQ(ierr);
529793721a6SBarry Smith   for (i=0; i<argc-1; i++) {
530793721a6SBarry Smith     ierr = PetscStrallocpy(PetscGlobalArgs[i+1],&(*args)[i]);CHKERRQ(ierr);
531793721a6SBarry Smith   }
532793721a6SBarry Smith   (*args)[argc-1] = 0;
533793721a6SBarry Smith   PetscFunctionReturn(0);
534793721a6SBarry Smith }
535793721a6SBarry Smith 
536793721a6SBarry Smith #undef __FUNCT__
537793721a6SBarry Smith #define __FUNCT__ "PetscFreeArguments"
538793721a6SBarry Smith /*@C
539793721a6SBarry Smith    PetscFreeArguments - Frees the memory obtained with PetscGetArguments()
540793721a6SBarry Smith 
541793721a6SBarry Smith    Not Collective
542793721a6SBarry Smith 
543793721a6SBarry Smith    Output Parameters:
544793721a6SBarry Smith .  args - the command line arguments
545793721a6SBarry Smith 
546793721a6SBarry Smith    Level: intermediate
547793721a6SBarry Smith 
548793721a6SBarry Smith    Concepts: command line arguments
549793721a6SBarry Smith 
550793721a6SBarry Smith .seealso: PetscFinalize(), PetscInitializeFortran(), PetscGetArgs(), PetscGetArguments()
551793721a6SBarry Smith 
552793721a6SBarry Smith @*/
5537087cfbeSBarry Smith PetscErrorCode  PetscFreeArguments(char **args)
554793721a6SBarry Smith {
555793721a6SBarry Smith   PetscInt       i = 0;
556793721a6SBarry Smith   PetscErrorCode ierr;
557793721a6SBarry Smith 
558793721a6SBarry Smith   PetscFunctionBegin;
559717030eeSLisandro Dalcin   if (!args) {PetscFunctionReturn(0);}
560793721a6SBarry Smith   while (args[i]) {
561793721a6SBarry Smith     ierr = PetscFree(args[i]);CHKERRQ(ierr);
562793721a6SBarry Smith     i++;
563793721a6SBarry Smith   }
564793721a6SBarry Smith   ierr = PetscFree(args);CHKERRQ(ierr);
565793721a6SBarry Smith   PetscFunctionReturn(0);
566793721a6SBarry Smith }
567793721a6SBarry Smith 
568793721a6SBarry Smith #undef __FUNCT__
569e5c89e4eSSatish Balay #define __FUNCT__ "PetscInitialize"
570e5c89e4eSSatish Balay /*@C
571e5c89e4eSSatish Balay    PetscInitialize - Initializes the PETSc database and MPI.
572e5c89e4eSSatish Balay    PetscInitialize() calls MPI_Init() if that has yet to be called,
573e5c89e4eSSatish Balay    so this routine should always be called near the beginning of
574e5c89e4eSSatish Balay    your program -- usually the very first line!
575e5c89e4eSSatish Balay 
576e5c89e4eSSatish Balay    Collective on MPI_COMM_WORLD or PETSC_COMM_WORLD if it has been set
577e5c89e4eSSatish Balay 
578e5c89e4eSSatish Balay    Input Parameters:
579e5c89e4eSSatish Balay +  argc - count of number of command line arguments
580e5c89e4eSSatish Balay .  args - the command line arguments
581fc2bca9aSBarry Smith .  file - [optional] PETSc database file, also checks ~username/.petscrc and .petscrc use PETSC_NULL to not check for
582fc2bca9aSBarry Smith           code specific file. Use -skip_petscrc in the code specific file to skip the .petscrc files
583e5c89e4eSSatish Balay -  help - [optional] Help message to print, use PETSC_NULL for no message
584e5c89e4eSSatish Balay 
58505827820SBarry Smith    If you wish PETSc code to run ONLY on a subcommunicator of MPI_COMM_WORLD, create that
58605827820SBarry Smith    communicator first and assign it to PETSC_COMM_WORLD BEFORE calling PetscInitialize(). Thus if you are running a
58705827820SBarry Smith    four process job and two processes will run PETSc and have PetscInitialize() and PetscFinalize() and two process will not,
58805827820SBarry Smith    then do this. If ALL processes in the job are using PetscInitialize() and PetscFinalize() then you don't need to do this, even
58905827820SBarry Smith    if different subcommunicators of the job are doing different things with PETSc.
590e5c89e4eSSatish Balay 
591e5c89e4eSSatish Balay    Options Database Keys:
592e5c89e4eSSatish Balay +  -start_in_debugger [noxterm,dbx,xdb,gdb,...] - Starts program in debugger
593e5c89e4eSSatish Balay .  -on_error_attach_debugger [noxterm,dbx,xdb,gdb,...] - Starts debugger when error detected
594e5c89e4eSSatish Balay .  -on_error_emacs <machinename> causes emacsclient to jump to error file
595b52f573bSBarry Smith .  -on_error_abort calls abort() when error detected (no traceback)
596e8fb0fc0SBarry Smith .  -on_error_mpiabort calls MPI_abort() when error detected
597e8fb0fc0SBarry Smith .  -error_output_stderr prints error messages to stderr instead of the default stdout
598e8fb0fc0SBarry Smith .  -error_output_none does not print the error messages (but handles errors in the same way as if this was not called)
599e5c89e4eSSatish Balay .  -debugger_nodes [node1,node2,...] - Indicates nodes to start in debugger
600e5c89e4eSSatish Balay .  -debugger_pause [sleeptime] (in seconds) - Pauses debugger
601e5c89e4eSSatish Balay .  -stop_for_debugger - Print message on how to attach debugger manually to
602e5c89e4eSSatish Balay                         process and wait (-debugger_pause) seconds for attachment
6032fb0ec9aSBarry Smith .  -malloc - Indicates use of PETSc error-checking malloc (on by default for debug version of libraries)
604e5c89e4eSSatish Balay .  -malloc no - Indicates not to use error-checking malloc
6052fb0ec9aSBarry Smith .  -malloc_debug - check for memory corruption at EVERY malloc or free
606e5c89e4eSSatish Balay .  -fp_trap - Stops on floating point exceptions (Note that on the
607e5c89e4eSSatish Balay               IBM RS6000 this slows code by at least a factor of 10.)
608e5c89e4eSSatish Balay .  -no_signal_handler - Indicates not to trap error signals
609e5c89e4eSSatish Balay .  -shared_tmp - indicates /tmp directory is shared by all processors
610e5c89e4eSSatish Balay .  -not_shared_tmp - each processor has own /tmp
611e5c89e4eSSatish Balay .  -tmp - alternative name of /tmp directory
612e5c89e4eSSatish Balay .  -get_total_flops - returns total flops done by all processors
61340ab9619SBarry Smith .  -memory_info - Print memory usage at end of run
61440ab9619SBarry Smith -  -server <port> - start PETSc webserver (default port is 8080)
615e5c89e4eSSatish Balay 
616e5c89e4eSSatish Balay    Options Database Keys for Profiling:
6170598bfebSBarry Smith    See the <a href="../../docs/manual.pdf#nameddest=ch_profiling">profiling chapter of the users manual</a> for details.
618e5c89e4eSSatish Balay +  -log_trace [filename] - Print traces of all PETSc calls
619e5c89e4eSSatish Balay         to the screen (useful to determine where a program
620e5c89e4eSSatish Balay         hangs without running in the debugger).  See PetscLogTraceBegin().
6216cf91177SBarry Smith .  -info <optional filename> - Prints verbose information to the screen
6226cf91177SBarry Smith -  -info_exclude <null,vec,mat,pc,ksp,snes,ts> - Excludes some of the verbose messages
623e5c89e4eSSatish Balay 
624e5c89e4eSSatish Balay    Environmental Variables:
625e5c89e4eSSatish Balay +   PETSC_TMP - alternative tmp directory
626e5c89e4eSSatish Balay .   PETSC_SHARED_TMP - tmp is shared by all processes
627e5c89e4eSSatish Balay .   PETSC_NOT_SHARED_TMP - each process has its own private tmp
628e5c89e4eSSatish Balay .   PETSC_VIEWER_SOCKET_PORT - socket number to use for socket viewer
629e5c89e4eSSatish Balay -   PETSC_VIEWER_SOCKET_MACHINE - machine to use for socket viewer to connect to
630e5c89e4eSSatish Balay 
631e5c89e4eSSatish Balay 
632e5c89e4eSSatish Balay    Level: beginner
633e5c89e4eSSatish Balay 
634e5c89e4eSSatish Balay    Notes:
635e5c89e4eSSatish Balay    If for some reason you must call MPI_Init() separately, call
636e5c89e4eSSatish Balay    it before PetscInitialize().
637e5c89e4eSSatish Balay 
638e5c89e4eSSatish Balay    Fortran Version:
639e5c89e4eSSatish Balay    In Fortran this routine has the format
640e5c89e4eSSatish Balay $       call PetscInitialize(file,ierr)
641e5c89e4eSSatish Balay 
642e5c89e4eSSatish Balay +   ierr - error return code
6433dae0d48SMatthew Knepley -  file - [optional] PETSc database file, also checks ~username/.petscrc and .petscrc use PETSC_NULL_CHARACTER to not check for
644fc2bca9aSBarry Smith           code specific file. Use -skip_petscrc in the code specific file to skip the .petscrc files
645e5c89e4eSSatish Balay 
646e5c89e4eSSatish Balay    Important Fortran Note:
647e5c89e4eSSatish Balay    In Fortran, you MUST use PETSC_NULL_CHARACTER to indicate a
648e5c89e4eSSatish Balay    null character string; you CANNOT just use PETSC_NULL as
6490598bfebSBarry Smith    in the C version. See the <a href="../../docs/manual.pdf">users manual</a> for details.
650e5c89e4eSSatish Balay 
65101cb0274SBarry Smith    If your main program is C but you call Fortran code that also uses PETSc you need to call PetscInitializeFortran() soon after
65201cb0274SBarry Smith    calling PetscInitialize().
653e5c89e4eSSatish Balay 
654e5c89e4eSSatish Balay    Concepts: initializing PETSc
655e5c89e4eSSatish Balay 
65601cb0274SBarry Smith .seealso: PetscFinalize(), PetscInitializeFortran(), PetscGetArgs(), PetscInitializeNoArguments()
657e5c89e4eSSatish Balay 
658e5c89e4eSSatish Balay @*/
6597087cfbeSBarry Smith PetscErrorCode  PetscInitialize(int *argc,char ***args,const char file[],const char help[])
660e5c89e4eSSatish Balay {
661e5c89e4eSSatish Balay   PetscErrorCode ierr;
662aa5bb8c0SSatish Balay   PetscMPIInt    flag, size;
663aa5bb8c0SSatish Balay   PetscInt       nodesize;
664ace3abfcSBarry Smith   PetscBool      flg;
665e5c89e4eSSatish Balay   char           hostname[256];
666e5c89e4eSSatish Balay 
667e5c89e4eSSatish Balay   PetscFunctionBegin;
668e5c89e4eSSatish Balay   if (PetscInitializeCalled) PetscFunctionReturn(0);
669e5c89e4eSSatish Balay 
670ae9b4142SLisandro Dalcin   /* these must be initialized in a routine, not as a constant declaration*/
671d89683f4Sbcordonn   PETSC_STDOUT = stdout;
672ae9b4142SLisandro Dalcin   PETSC_STDERR = stderr;
673e5c89e4eSSatish Balay 
674e5c89e4eSSatish Balay   ierr = PetscOptionsCreate();CHKERRQ(ierr);
675e5c89e4eSSatish Balay 
676e5c89e4eSSatish Balay   /*
677e5c89e4eSSatish Balay      We initialize the program name here (before MPI_Init()) because MPICH has a bug in
678e5c89e4eSSatish Balay      it that it sets args[0] on all processors to be args[0] on the first processor.
679e5c89e4eSSatish Balay   */
680e5c89e4eSSatish Balay   if (argc && *argc) {
681e5c89e4eSSatish Balay     ierr = PetscSetProgramName(**args);CHKERRQ(ierr);
682e5c89e4eSSatish Balay   } else {
683e5c89e4eSSatish Balay     ierr = PetscSetProgramName("Unknown Name");CHKERRQ(ierr);
684e5c89e4eSSatish Balay   }
685e5c89e4eSSatish Balay 
686e5c89e4eSSatish Balay   ierr = MPI_Initialized(&flag);CHKERRQ(ierr);
687e5c89e4eSSatish Balay   if (!flag) {
688e32f2f54SBarry 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");
689e5c89e4eSSatish Balay     ierr          = MPI_Init(argc,args);CHKERRQ(ierr);
690e5c89e4eSSatish Balay     PetscBeganMPI = PETSC_TRUE;
691e5c89e4eSSatish Balay   }
692e5c89e4eSSatish Balay   if (argc && args) {
693e5c89e4eSSatish Balay     PetscGlobalArgc = *argc;
694e5c89e4eSSatish Balay     PetscGlobalArgs = *args;
695e5c89e4eSSatish Balay   }
696e5c89e4eSSatish Balay   PetscFinalizeCalled   = PETSC_FALSE;
697e5c89e4eSSatish Balay 
698e8373e55SMatthew Knepley   if (PETSC_COMM_WORLD == MPI_COMM_NULL) {
699e5c89e4eSSatish Balay     PETSC_COMM_WORLD = MPI_COMM_WORLD;
700e5c89e4eSSatish Balay   }
701660746e0SBarry Smith   ierr = MPI_Errhandler_set(PETSC_COMM_WORLD,MPI_ERRORS_RETURN);CHKERRQ(ierr);
702e5c89e4eSSatish Balay 
703e5c89e4eSSatish Balay   /* Done after init due to a bug in MPICH-GM? */
704e5c89e4eSSatish Balay   ierr = PetscErrorPrintfInitialize();CHKERRQ(ierr);
705e5c89e4eSSatish Balay 
706e5c89e4eSSatish Balay   ierr = MPI_Comm_rank(MPI_COMM_WORLD,&PetscGlobalRank);CHKERRQ(ierr);
707e5c89e4eSSatish Balay   ierr = MPI_Comm_size(MPI_COMM_WORLD,&PetscGlobalSize);CHKERRQ(ierr);
708e5c89e4eSSatish Balay 
709e5c89e4eSSatish Balay #if defined(PETSC_USE_COMPLEX)
710e5c89e4eSSatish Balay   /*
711e5c89e4eSSatish Balay      Initialized the global complex variable; this is because with
712e5c89e4eSSatish Balay      shared libraries the constructors for global variables
713e5c89e4eSSatish Balay      are not called; at least on IRIX.
714e5c89e4eSSatish Balay   */
715e5c89e4eSSatish Balay   {
716762437b8SSatish Balay #if defined(PETSC_CLANGUAGE_CXX)
717e5c89e4eSSatish Balay     PetscScalar ic(0.0,1.0);
718e5c89e4eSSatish Balay     PETSC_i = ic;
719b7940d39SSatish Balay #else
7203433f298SSatish Balay     PETSC_i = I;
721b7940d39SSatish Balay #endif
722762437b8SSatish Balay   }
723762437b8SSatish Balay 
7242c876bd9SBarry Smith #if !defined(PETSC_HAVE_MPI_C_DOUBLE_COMPLEX)
725500d8756SSatish Balay   ierr = MPI_Type_contiguous(2,MPIU_REAL,&MPIU_C_DOUBLE_COMPLEX);CHKERRQ(ierr);
726500d8756SSatish Balay   ierr = MPI_Type_commit(&MPIU_C_DOUBLE_COMPLEX);CHKERRQ(ierr);
727500d8756SSatish Balay   ierr = MPI_Type_contiguous(2,MPI_FLOAT,&MPIU_C_COMPLEX);CHKERRQ(ierr);
728500d8756SSatish Balay   ierr = MPI_Type_commit(&MPIU_C_COMPLEX);CHKERRQ(ierr);
72906a205a8SBarry Smith   ierr = MPI_Op_create(PetscSum_Local,1,&MPIU_SUM);CHKERRQ(ierr);
730e5c89e4eSSatish Balay #endif
7312c876bd9SBarry Smith #endif
732e5c89e4eSSatish Balay 
733e5c89e4eSSatish Balay   /*
734e5c89e4eSSatish Balay      Create the PETSc MPI reduction operator that sums of the first
735e5c89e4eSSatish Balay      half of the entries and maxes the second half.
736e5c89e4eSSatish Balay   */
737e5c89e4eSSatish Balay   ierr = MPI_Op_create(PetscMaxSum_Local,1,&PetscMaxSum_Op);CHKERRQ(ierr);
738e5c89e4eSSatish Balay 
739ce63c4c1SBarry Smith #if defined(PETSC_USE_REAL___FLOAT128)
740c90a1750SBarry Smith   ierr = MPI_Type_contiguous(2,MPI_DOUBLE,&MPIU___FLOAT128);CHKERRQ(ierr);
741c90a1750SBarry Smith   ierr = MPI_Type_commit(&MPIU___FLOAT128);CHKERRQ(ierr);
742854411e3SBarry Smith   ierr = MPI_Op_create(PetscSum_Local,1,&MPIU_SUM);CHKERRQ(ierr);
743d9822059SBarry Smith   ierr = MPI_Op_create(PetscMax_Local,1,&MPIU_MAX);CHKERRQ(ierr);
744d9822059SBarry Smith   ierr = MPI_Op_create(PetscMin_Local,1,&MPIU_MIN);CHKERRQ(ierr);
745c90a1750SBarry Smith #endif
746c90a1750SBarry Smith 
747e5c89e4eSSatish Balay   ierr = MPI_Type_contiguous(2,MPIU_SCALAR,&MPIU_2SCALAR);CHKERRQ(ierr);
748e5c89e4eSSatish Balay   ierr = MPI_Type_commit(&MPIU_2SCALAR);CHKERRQ(ierr);
749e5c89e4eSSatish Balay   ierr = MPI_Op_create(PetscADMax_Local,1,&PetscADMax_Op);CHKERRQ(ierr);
750e5c89e4eSSatish Balay   ierr = MPI_Op_create(PetscADMin_Local,1,&PetscADMin_Op);CHKERRQ(ierr);
751e5c89e4eSSatish Balay 
752e5c89e4eSSatish Balay   ierr = MPI_Type_contiguous(2,MPIU_INT,&MPIU_2INT);CHKERRQ(ierr);
753e5c89e4eSSatish Balay   ierr = MPI_Type_commit(&MPIU_2INT);CHKERRQ(ierr);
754e5c89e4eSSatish Balay 
755e5c89e4eSSatish Balay   /*
756480cf27aSJed Brown      Attributes to be set on PETSc communicators
757480cf27aSJed Brown   */
758480cf27aSJed Brown   ierr = MPI_Keyval_create(MPI_NULL_COPY_FN,Petsc_DelCounter,&Petsc_Counter_keyval,(void*)0);CHKERRQ(ierr);
759480cf27aSJed Brown   ierr = MPI_Keyval_create(MPI_NULL_COPY_FN,Petsc_DelComm,&Petsc_InnerComm_keyval,(void*)0);CHKERRQ(ierr);
760480cf27aSJed Brown   ierr = MPI_Keyval_create(MPI_NULL_COPY_FN,Petsc_DelComm,&Petsc_OuterComm_keyval,(void*)0);CHKERRQ(ierr);
761480cf27aSJed Brown 
762480cf27aSJed Brown   /*
763e8fb0fc0SBarry Smith      Build the options database
764e5c89e4eSSatish Balay   */
765e5c89e4eSSatish Balay   ierr = PetscOptionsInsert(argc,args,file);CHKERRQ(ierr);
766e5c89e4eSSatish Balay 
7676dc8fec2Sbcordonn 
768e5c89e4eSSatish Balay   /*
769e5c89e4eSSatish Balay      Print main application help message
770e5c89e4eSSatish Balay   */
771e5c89e4eSSatish Balay   ierr = PetscOptionsHasName(PETSC_NULL,"-help",&flg);CHKERRQ(ierr);
772e5c89e4eSSatish Balay   if (help && flg) {
773e5c89e4eSSatish Balay     ierr = PetscPrintf(PETSC_COMM_WORLD,help);CHKERRQ(ierr);
774e5c89e4eSSatish Balay   }
775e5c89e4eSSatish Balay   ierr = PetscOptionsCheckInitial_Private();CHKERRQ(ierr);
776e5c89e4eSSatish Balay 
777e5c89e4eSSatish Balay   /* SHOULD PUT IN GUARDS: Make sure logging is initialized, even if we do not print it out */
778a9f03627SSatish Balay #if defined(PETSC_USE_LOG)
779e5c89e4eSSatish Balay   ierr = PetscLogBegin_Private();CHKERRQ(ierr);
780a9f03627SSatish Balay #endif
781e5c89e4eSSatish Balay 
782e5c89e4eSSatish Balay   /*
783e5c89e4eSSatish Balay      Load the dynamic libraries (on machines that support them), this registers all
784e5c89e4eSSatish Balay      the solvers etc. (On non-dynamic machines this initializes the PetscDraw and PetscViewer classes)
785e5c89e4eSSatish Balay   */
786e5c89e4eSSatish Balay   ierr = PetscInitialize_DynamicLibraries();CHKERRQ(ierr);
787e5c89e4eSSatish Balay 
788e5c89e4eSSatish Balay   ierr = MPI_Comm_size(PETSC_COMM_WORLD,&size);CHKERRQ(ierr);
789ae15b995SBarry Smith   ierr = PetscInfo1(0,"PETSc successfully started: number of processors = %d\n",size);CHKERRQ(ierr);
790e5c89e4eSSatish Balay   ierr = PetscGetHostName(hostname,256);CHKERRQ(ierr);
791ae15b995SBarry Smith   ierr = PetscInfo1(0,"Running on machine: %s\n",hostname);CHKERRQ(ierr);
792e5c89e4eSSatish Balay 
793e5c89e4eSSatish Balay   ierr = PetscOptionsCheckInitial_Components();CHKERRQ(ierr);
794ef6c6fedSBoyana Norris   /* Check the options database for options related to the options database itself */
795ef6c6fedSBoyana Norris   ierr = PetscOptionsSetFromOptions();CHKERRQ(ierr);
796ef6c6fedSBoyana Norris 
797951e3c8eSBarry Smith #if defined(PETSC_USE_PETSC_MPI_EXTERNAL32)
798e39fd77fSBarry Smith   /*
799e39fd77fSBarry Smith       Tell MPI about our own data representation converter, this would/should be used if extern32 is not supported by the MPI
800e39fd77fSBarry Smith 
801e39fd77fSBarry Smith       Currently not used because it is not supported by MPICH.
802e39fd77fSBarry Smith   */
803e39fd77fSBarry Smith #if !defined(PETSC_WORDS_BIGENDIAN)
804708350f5SSatish Balay   ierr = MPI_Register_datarep((char *)"petsc",PetscDataRep_read_conv_fn,PetscDataRep_write_conv_fn,PetscDataRep_extent_fn,PETSC_NULL);CHKERRQ(ierr);
805e39fd77fSBarry Smith #endif
806951e3c8eSBarry Smith #endif
807e39fd77fSBarry Smith 
80885afcc9aSBarry Smith   ierr = PetscOptionsGetInt(PETSC_NULL,"-hmpi_spawn_size",&nodesize,&flg);CHKERRQ(ierr);
809793721a6SBarry Smith   if (flg) {
81023464e94SBarry Smith #if defined(PETSC_HAVE_MPI_COMM_SPAWN)
81185afcc9aSBarry Smith     ierr = PetscHMPISpawn((PetscMPIInt) nodesize);CHKERRQ(ierr); /* worker nodes never return from here; they go directly to PetscEnd() */
81223464e94SBarry Smith #else
81385afcc9aSBarry Smith     SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SUP,"PETSc built without MPI 2 (MPI_Comm_spawn) support, use -hmpi_merge_size instead");
81423464e94SBarry Smith #endif
815793721a6SBarry Smith   } else {
81685afcc9aSBarry Smith     ierr = PetscOptionsGetInt(PETSC_NULL,"-hmpi_merge_size",&nodesize,&flg);CHKERRQ(ierr);
8178002f1cdSBarry Smith     if (flg) {
81885afcc9aSBarry Smith       ierr = PetscHMPIMerge((PetscMPIInt) nodesize,PETSC_NULL,PETSC_NULL);CHKERRQ(ierr);
81985afcc9aSBarry Smith       if (PetscHMPIWorker) { /* if worker then never enter user code */
820bad7cb1dSBarry Smith         PetscInitializeCalled = PETSC_TRUE;
8219505b675SBarry Smith         ierr = PetscEnd();
8229505b675SBarry Smith       }
8238002f1cdSBarry Smith     }
824793721a6SBarry Smith   }
825e5c89e4eSSatish Balay 
82635d88935SVictor Minden #if defined(PETSC_HAVE_CUDA)
8272f947c57SVictor Minden   cublasInit();
8283e39abd9SVictor Minden #endif
82992e62aa6SBarry Smith 
8300069ddf5SShri Abhyankar #if defined(PETSC_HAVE_PTHREADCLASSES)
8310069ddf5SShri Abhyankar   if(PetscThreadInitialize)
8320069ddf5SShri Abhyankar     ierr = (*PetscThreadInitialize)(PetscMaxThreads);CHKERRQ(ierr);
8330069ddf5SShri Abhyankar #endif
8340069ddf5SShri Abhyankar 
83592e62aa6SBarry Smith #if defined(PETSC_HAVE_AMS)
836c457296dSBarry Smith   ierr = PetscOptionsHasName(PETSC_NULL,"-ams_publish_objects",&flg);CHKERRQ(ierr);
83792e62aa6SBarry Smith   if (flg) {
83892e62aa6SBarry Smith     PetscAMSPublishAll = PETSC_TRUE;
83992e62aa6SBarry Smith   }
84092e62aa6SBarry Smith #endif
84192e62aa6SBarry Smith 
8429ac80d5eSLisandro Dalcin   ierr = PetscOptionsHasName(PETSC_NULL,"-python",&flg);CHKERRQ(ierr);
8439ac80d5eSLisandro Dalcin   if (flg) {
8449ac80d5eSLisandro Dalcin     PetscInitializeCalled = PETSC_TRUE;
8459ac80d5eSLisandro Dalcin     ierr = PetscPythonInitialize(PETSC_NULL,PETSC_NULL);CHKERRQ(ierr);
8469ac80d5eSLisandro Dalcin   }
8479ac80d5eSLisandro Dalcin 
848301d30feSBarry Smith   /*
849301d30feSBarry Smith       Once we are completedly initialized then we can set this variables
850301d30feSBarry Smith   */
851301d30feSBarry Smith   PetscInitializeCalled = PETSC_TRUE;
852301d30feSBarry Smith   PetscFunctionReturn(0);
853e5c89e4eSSatish Balay }
854e5c89e4eSSatish Balay 
8552eff7a51SBarry Smith extern PetscObject *PetscObjects;
8562eff7a51SBarry Smith extern PetscInt    PetscObjectsCounts, PetscObjectsMaxCounts;
857e5c89e4eSSatish Balay 
858e5c89e4eSSatish Balay #undef __FUNCT__
859e5c89e4eSSatish Balay #define __FUNCT__ "PetscFinalize"
860e5c89e4eSSatish Balay /*@C
861e5c89e4eSSatish Balay    PetscFinalize - Checks for options to be called at the conclusion
862e5c89e4eSSatish Balay    of the program. MPI_Finalize() is called only if the user had not
863e5c89e4eSSatish Balay    called MPI_Init() before calling PetscInitialize().
864e5c89e4eSSatish Balay 
865e5c89e4eSSatish Balay    Collective on PETSC_COMM_WORLD
866e5c89e4eSSatish Balay 
867e5c89e4eSSatish Balay    Options Database Keys:
86888c29154SBarry Smith +  -options_table - Calls PetscOptionsView()
869e5c89e4eSSatish Balay .  -options_left - Prints unused options that remain in the database
8700a1571b3SBarry Smith .  -objects_left  - Prints list of all objects that have not been freed
871e5c89e4eSSatish Balay .  -mpidump - Calls PetscMPIDump()
872e5c89e4eSSatish Balay .  -malloc_dump - Calls PetscMallocDump()
873e5c89e4eSSatish Balay .  -malloc_info - Prints total memory usage
874e5c89e4eSSatish Balay -  -malloc_log - Prints summary of memory usage
875e5c89e4eSSatish Balay 
876e5c89e4eSSatish Balay    Options Database Keys for Profiling:
8770598bfebSBarry Smith    See the <a href="../../docs/manual.pdf#nameddest=ch_profiling">profiling chapter of the users manual</a> for details.
878e5c89e4eSSatish Balay +  -log_summary [filename] - Prints summary of flop and timing
879e5c89e4eSSatish Balay         information to screen. If the filename is specified the
88091eabc43SBarry Smith         summary is written to the file.  See PetscLogView().
881ff5bc46bSBarry Smith .  -log_summary_python [filename] - Prints data on of flop and timing usage to a file or screen.
88291eabc43SBarry Smith         See PetscLogPrintSViewPython().
883e5c89e4eSSatish Balay .  -log_all [filename] - Logs extensive profiling information
884ff5bc46bSBarry Smith         See PetscLogDump().
885ff5bc46bSBarry Smith .  -log [filename] - Logs basic profiline information  See PetscLogDump().
886e5c89e4eSSatish Balay .  -log_sync - Log the synchronization in scatters, inner products
887e5c89e4eSSatish Balay         and norms
888e5c89e4eSSatish Balay -  -log_mpe [filename] - Creates a logfile viewable by the
889e5c89e4eSSatish Balay       utility Upshot/Nupshot (in MPICH distribution)
890e5c89e4eSSatish Balay 
891e5c89e4eSSatish Balay    Level: beginner
892e5c89e4eSSatish Balay 
893e5c89e4eSSatish Balay    Note:
894e5c89e4eSSatish Balay    See PetscInitialize() for more general runtime options.
895e5c89e4eSSatish Balay 
89688c29154SBarry Smith .seealso: PetscInitialize(), PetscOptionsView(), PetscMallocDump(), PetscMPIDump(), PetscEnd()
897e5c89e4eSSatish Balay @*/
8987087cfbeSBarry Smith PetscErrorCode  PetscFinalize(void)
899e5c89e4eSSatish Balay {
900e5c89e4eSSatish Balay   PetscErrorCode ierr;
901e5c89e4eSSatish Balay   PetscMPIInt    rank;
9022eff7a51SBarry Smith   PetscInt       i,nopt;
9030a1571b3SBarry Smith   PetscBool      flg1 = PETSC_FALSE,flg2 = PETSC_FALSE,flg3 = PETSC_FALSE,objects_left = PETSC_FALSE;
904d5649816SBarry Smith #if defined(PETSC_HAVE_AMS)
905ace3abfcSBarry Smith   PetscBool      flg = PETSC_FALSE;
906d5649816SBarry Smith #endif
90710463e74SBarry Smith #if defined(PETSC_USE_LOG)
90810463e74SBarry Smith   char           mname[PETSC_MAX_PATH_LEN];
90910463e74SBarry Smith #endif
910e5c89e4eSSatish Balay 
911e5c89e4eSSatish Balay   PetscFunctionBegin;
912e5c89e4eSSatish Balay 
913e5c89e4eSSatish Balay   if (!PetscInitializeCalled) {
9144b09e917SBarry Smith     printf("PetscInitialize() must be called before PetscFinalize()\n");
9154b09e917SBarry Smith     PetscFunctionReturn(PETSC_ERR_ARG_WRONGSTATE);
916e5c89e4eSSatish Balay   }
917b022a5c1SBarry Smith   ierr = PetscInfo(PETSC_NULL,"PetscFinalize() called\n");
918b022a5c1SBarry Smith 
919d5649816SBarry Smith #if defined(PETSC_HAVE_AMS)
920acfcf0e5SJed Brown   ierr = PetscOptionsGetBool(PETSC_NULL,"-options_gui",&flg,PETSC_NULL);CHKERRQ(ierr);
921d5649816SBarry Smith   if (flg) {
922d5649816SBarry Smith     ierr = PetscOptionsAMSDestroy();CHKERRQ(ierr);
923d5649816SBarry Smith   }
924d5649816SBarry Smith #endif
925d5649816SBarry Smith 
92685afcc9aSBarry Smith   ierr = PetscHMPIFinalize();CHKERRQ(ierr);
9272e4784d6SShri Abhyankar #if defined(PETSC_HAVE_PTHREADCLASSES)
928fc087633SBarry Smith   if (PetscThreadFinalize) {
929cfcfc605SKerry Stevens     /* thread pool case */
930fc087633SBarry Smith     ierr = (*PetscThreadFinalize)();CHKERRQ(ierr);
931fc087633SBarry Smith   }
932cfcfc605SKerry Stevens   free(ThreadCoreAffinity);
933fc087633SBarry Smith #endif
9340ca81413SKerry Stevens 
935e5c89e4eSSatish Balay   ierr = MPI_Comm_rank(PETSC_COMM_WORLD,&rank);CHKERRQ(ierr);
936acfcf0e5SJed Brown   ierr = PetscOptionsGetBool(PETSC_NULL,"-malloc_info",&flg2,PETSC_NULL);CHKERRQ(ierr);
937e5c89e4eSSatish Balay   if (!flg2) {
93890d69ab7SBarry Smith     flg2 = PETSC_FALSE;
939acfcf0e5SJed Brown     ierr = PetscOptionsGetBool(PETSC_NULL,"-memory_info",&flg2,PETSC_NULL);CHKERRQ(ierr);
940e5c89e4eSSatish Balay   }
941e5c89e4eSSatish Balay   if (flg2) {
942e5c89e4eSSatish Balay     ierr = PetscMemoryShowUsage(PETSC_VIEWER_STDOUT_WORLD,"Summary of Memory Usage in PETSc\n");CHKERRQ(ierr);
943e5c89e4eSSatish Balay   }
944e5c89e4eSSatish Balay 
945e5c89e4eSSatish Balay #if defined(PETSC_USE_LOG)
94690d69ab7SBarry Smith   flg1 = PETSC_FALSE;
947acfcf0e5SJed Brown   ierr = PetscOptionsGetBool(PETSC_NULL,"-get_total_flops",&flg1,PETSC_NULL);CHKERRQ(ierr);
948e5c89e4eSSatish Balay   if (flg1) {
949e5c89e4eSSatish Balay     PetscLogDouble flops = 0;
950e5c89e4eSSatish Balay     ierr = MPI_Reduce(&_TotalFlops,&flops,1,MPI_DOUBLE,MPI_SUM,0,PETSC_COMM_WORLD);CHKERRQ(ierr);
951e5c89e4eSSatish Balay     ierr = PetscPrintf(PETSC_COMM_WORLD,"Total flops over all processors %g\n",flops);CHKERRQ(ierr);
952e5c89e4eSSatish Balay   }
953e5c89e4eSSatish Balay #endif
954e5c89e4eSSatish Balay 
955e5c89e4eSSatish Balay 
956e5c89e4eSSatish Balay #if defined(PETSC_USE_LOG)
957e5c89e4eSSatish Balay #if defined(PETSC_HAVE_MPE)
958e5c89e4eSSatish Balay   mname[0] = 0;
959e5c89e4eSSatish Balay   ierr = PetscOptionsGetString(PETSC_NULL,"-log_mpe",mname,PETSC_MAX_PATH_LEN,&flg1);CHKERRQ(ierr);
960e5c89e4eSSatish Balay   if (flg1){
961e5c89e4eSSatish Balay     if (mname[0]) {ierr = PetscLogMPEDump(mname);CHKERRQ(ierr);}
962e5c89e4eSSatish Balay     else          {ierr = PetscLogMPEDump(0);CHKERRQ(ierr);}
963e5c89e4eSSatish Balay   }
964e5c89e4eSSatish Balay #endif
965e5c89e4eSSatish Balay   mname[0] = 0;
966e5c89e4eSSatish Balay   ierr = PetscOptionsGetString(PETSC_NULL,"-log_summary",mname,PETSC_MAX_PATH_LEN,&flg1);CHKERRQ(ierr);
967e5c89e4eSSatish Balay   if (flg1) {
96891eabc43SBarry Smith     PetscViewer viewer;
96991eabc43SBarry Smith     if (mname[0])  {
97091eabc43SBarry Smith       ierr = PetscViewerASCIIOpen(PETSC_COMM_WORLD,mname,&viewer);CHKERRQ(ierr);
97191eabc43SBarry Smith       ierr = PetscLogView(viewer);CHKERRQ(ierr);
9726bf464f9SBarry Smith       ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr);
97333f85c2fSBarry Smith     } else {
97433f85c2fSBarry Smith       viewer = PETSC_VIEWER_STDOUT_WORLD;
97533f85c2fSBarry Smith       ierr = PetscLogView(viewer);CHKERRQ(ierr);
97633f85c2fSBarry Smith     }
977e5c89e4eSSatish Balay   }
978e5c89e4eSSatish Balay 
979ff5bc46bSBarry Smith   mname[0] = 0;
980ff5bc46bSBarry Smith   ierr = PetscOptionsGetString(PETSC_NULL,"-log_summary_python",mname,PETSC_MAX_PATH_LEN,&flg1);CHKERRQ(ierr);
981ff5bc46bSBarry Smith   if (flg1) {
982ff5bc46bSBarry Smith     PetscViewer viewer;
983ff5bc46bSBarry Smith     if (mname[0])  {
984ff5bc46bSBarry Smith       ierr = PetscViewerASCIIOpen(PETSC_COMM_WORLD,mname,&viewer);CHKERRQ(ierr);
98591eabc43SBarry Smith       ierr = PetscLogViewPython(viewer);CHKERRQ(ierr);
9866bf464f9SBarry Smith       ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr);
98733f85c2fSBarry Smith     } else {
98833f85c2fSBarry Smith       viewer = PETSC_VIEWER_STDOUT_WORLD;
98933f85c2fSBarry Smith       ierr = PetscLogViewPython(viewer);CHKERRQ(ierr);
99033f85c2fSBarry Smith     }
991ff5bc46bSBarry Smith   }
992ff5bc46bSBarry Smith 
99378392ef1SBarry Smith   ierr = PetscOptionsGetString(PETSC_NULL,"-log_detailed",mname,PETSC_MAX_PATH_LEN,&flg1);CHKERRQ(ierr);
99478392ef1SBarry Smith   if (flg1) {
99578392ef1SBarry Smith     if (mname[0])  {ierr = PetscLogPrintDetailed(PETSC_COMM_WORLD,mname);CHKERRQ(ierr);}
99678392ef1SBarry Smith     else           {ierr = PetscLogPrintDetailed(PETSC_COMM_WORLD,0);CHKERRQ(ierr);}
99778392ef1SBarry Smith   }
99878392ef1SBarry Smith 
999e5c89e4eSSatish Balay   mname[0] = 0;
1000e5c89e4eSSatish Balay   ierr = PetscOptionsGetString(PETSC_NULL,"-log_all",mname,PETSC_MAX_PATH_LEN,&flg1);CHKERRQ(ierr);
1001e5c89e4eSSatish Balay   ierr = PetscOptionsGetString(PETSC_NULL,"-log",mname,PETSC_MAX_PATH_LEN,&flg2);CHKERRQ(ierr);
1002e5c89e4eSSatish Balay   if (flg1 || flg2){
1003e5c89e4eSSatish Balay     if (mname[0]) PetscLogDump(mname);
1004e5c89e4eSSatish Balay     else          PetscLogDump(0);
1005e5c89e4eSSatish Balay   }
1006e5c89e4eSSatish Balay #endif
100710463e74SBarry Smith 
100833f85c2fSBarry Smith #if defined(PETSC_USE_DEBUG) && !defined(PETSC_USE_PTHREAD)
100933f85c2fSBarry Smith   if (PetscStackActive) {
101033f85c2fSBarry Smith     ierr = PetscStackDestroy();CHKERRQ(ierr);
101133f85c2fSBarry Smith   }
101233f85c2fSBarry Smith #endif
101310463e74SBarry Smith 
101490d69ab7SBarry Smith   flg1 = PETSC_FALSE;
1015acfcf0e5SJed Brown   ierr = PetscOptionsGetBool(PETSC_NULL,"-no_signal_handler",&flg1,PETSC_NULL);CHKERRQ(ierr);
1016e5c89e4eSSatish Balay   if (!flg1) { ierr = PetscPopSignalHandler();CHKERRQ(ierr);}
101790d69ab7SBarry Smith   flg1 = PETSC_FALSE;
1018acfcf0e5SJed Brown   ierr = PetscOptionsGetBool(PETSC_NULL,"-mpidump",&flg1,PETSC_NULL);CHKERRQ(ierr);
1019e5c89e4eSSatish Balay   if (flg1) {
1020e5c89e4eSSatish Balay     ierr = PetscMPIDump(stdout);CHKERRQ(ierr);
1021e5c89e4eSSatish Balay   }
102290d69ab7SBarry Smith   flg1 = PETSC_FALSE;
102390d69ab7SBarry Smith   flg2 = PETSC_FALSE;
10248bb29257SSatish Balay   /* preemptive call to avoid listing this option in options table as unused */
10258bb29257SSatish Balay   ierr = PetscOptionsHasName(PETSC_NULL,"-malloc_dump",&flg1);CHKERRQ(ierr);
1026acfcf0e5SJed Brown   ierr = PetscOptionsGetBool(PETSC_NULL,"-options_table",&flg2,PETSC_NULL);CHKERRQ(ierr);
1027e4c476e2SSatish Balay 
1028e5c89e4eSSatish Balay   if (flg2) {
102919fcac0cSJed Brown     ierr = PetscOptionsView(PETSC_VIEWER_STDOUT_WORLD);CHKERRQ(ierr);
1030e5c89e4eSSatish Balay   }
1031e5c89e4eSSatish Balay 
1032e5c89e4eSSatish Balay   /* to prevent PETSc -options_left from warning */
1033cb9801acSJed Brown   ierr = PetscOptionsHasName(PETSC_NULL,"-nox",&flg1);CHKERRQ(ierr);
1034cb9801acSJed Brown   ierr = PetscOptionsHasName(PETSC_NULL,"-nox_warning",&flg1);CHKERRQ(ierr);
10350a1571b3SBarry Smith   ierr = PetscOptionsGetBool(PETSC_NULL,"-objects_left",&objects_left,PETSC_NULL);CHKERRQ(ierr);
1036e5c89e4eSSatish Balay 
103785afcc9aSBarry Smith   if (!PetscHMPIWorker) { /* worker processes skip this because they do not usually process options */
103833fc4174SSatish Balay     flg3 = PETSC_FALSE; /* default value is required */
1039acfcf0e5SJed Brown     ierr = PetscOptionsGetBool(PETSC_NULL,"-options_left",&flg3,&flg1);CHKERRQ(ierr);
1040e5c89e4eSSatish Balay     ierr = PetscOptionsAllUsed(&nopt);CHKERRQ(ierr);
1041e5c89e4eSSatish Balay     if (flg3) {
1042e5c89e4eSSatish Balay       if (!flg2) { /* have not yet printed the options */
104333f85c2fSBarry Smith 	ierr = PetscOptionsView(PETSC_VIEWER_STDOUT_WORLD);CHKERRQ(ierr);
1044e5c89e4eSSatish Balay       }
1045e5c89e4eSSatish Balay       if (!nopt) {
1046e5c89e4eSSatish Balay 	ierr = PetscPrintf(PETSC_COMM_WORLD,"There are no unused options.\n");CHKERRQ(ierr);
1047e5c89e4eSSatish Balay       } else if (nopt == 1) {
1048e5c89e4eSSatish Balay 	ierr = PetscPrintf(PETSC_COMM_WORLD,"There is one unused database option. It is:\n");CHKERRQ(ierr);
1049e5c89e4eSSatish Balay       } else {
10507582186dSLisandro Dalcin 	ierr = PetscPrintf(PETSC_COMM_WORLD,"There are %D unused database options. They are:\n",nopt);CHKERRQ(ierr);
1051e5c89e4eSSatish Balay       }
1052e5c89e4eSSatish Balay     }
1053e5c89e4eSSatish Balay #if defined(PETSC_USE_DEBUG)
1054da8b8a77SBarry Smith     if (nopt && !flg3 && !flg1) {
1055e5c89e4eSSatish Balay       ierr = PetscPrintf(PETSC_COMM_WORLD,"WARNING! There are options you set that were not used!\n");CHKERRQ(ierr);
1056e5c89e4eSSatish Balay       ierr = PetscPrintf(PETSC_COMM_WORLD,"WARNING! could be spelling mistake, etc!\n");CHKERRQ(ierr);
1057e5c89e4eSSatish Balay       ierr = PetscOptionsLeft();CHKERRQ(ierr);
1058e5c89e4eSSatish Balay     } else if (nopt && flg3) {
1059e5c89e4eSSatish Balay #else
1060e5c89e4eSSatish Balay     if (nopt && flg3) {
1061e5c89e4eSSatish Balay #endif
1062e5c89e4eSSatish Balay       ierr = PetscOptionsLeft();CHKERRQ(ierr);
1063e5c89e4eSSatish Balay     }
1064931f367cSBarry Smith   }
1065e5c89e4eSSatish Balay 
106610463e74SBarry Smith   /*
106733f85c2fSBarry Smith      Free all objects registered with PetscObjectRegisterDestroy() such as PETSC_VIEWER_XXX_().
106833f85c2fSBarry Smith   */
106933f85c2fSBarry Smith   ierr = PetscObjectRegisterDestroyAll();CHKERRQ(ierr);
107033f85c2fSBarry Smith 
10712eff7a51SBarry Smith   /*
1072dbc8283eSBarry Smith        List all objects the user may have forgot to free
10732eff7a51SBarry Smith   */
10740a1571b3SBarry Smith   if (objects_left && PetscObjectsCounts) {
1075dbc8283eSBarry Smith     ierr = PetscPrintf(PETSC_COMM_WORLD,"The following objects %D were never freed\n",PetscObjectsCounts);
10760a1571b3SBarry Smith   }
10772eff7a51SBarry Smith   for (i=0; i<PetscObjectsMaxCounts; i++) {
10782eff7a51SBarry Smith     if (PetscObjects[i]) {
10790a1571b3SBarry Smith       if (objects_left) {
10800a1571b3SBarry Smith         ierr = PetscPrintf(PETSC_COMM_WORLD,"  %s %s %s\n",PetscObjects[i]->class_name,PetscObjects[i]->type_name,PetscObjects[i]->name);CHKERRQ(ierr);
10810a1571b3SBarry Smith       }
10822eff7a51SBarry Smith     }
10832eff7a51SBarry Smith   }
1084dbc8283eSBarry Smith   /* cannot actually destroy the left over objects, but destroy the list */
1085dbc8283eSBarry Smith   PetscObjectsCounts    = 0;
1086dbc8283eSBarry Smith   PetscObjectsMaxCounts = 0;
1087dbc8283eSBarry Smith   ierr = PetscFree(PetscObjects);CHKERRQ(ierr);
10882eff7a51SBarry Smith 
10892eff7a51SBarry Smith 
109033f85c2fSBarry Smith #if defined(PETSC_USE_LOG)
109133f85c2fSBarry Smith   ierr = PetscLogDestroy();CHKERRQ(ierr);
109233f85c2fSBarry Smith #endif
109333f85c2fSBarry Smith 
109433f85c2fSBarry Smith   /*
109533f85c2fSBarry Smith        Free all the registered create functions, such as KSPList, VecList, SNESList, etc
109633f85c2fSBarry Smith   */
109733f85c2fSBarry Smith   ierr = PetscFListDestroyAll();CHKERRQ(ierr);
109833f85c2fSBarry Smith 
109933f85c2fSBarry Smith   /*
1100*e4d1774bSDmitry Karpeev        Free all the registered op functions, such as MatOpList, etc
1101*e4d1774bSDmitry Karpeev   */
1102*e4d1774bSDmitry Karpeev   ierr = PetscOpFListDestroyAll();CHKERRQ(ierr);
1103*e4d1774bSDmitry Karpeev 
1104*e4d1774bSDmitry Karpeev   /*
110533f85c2fSBarry Smith      Destroy any packages that registered a finalize
110633f85c2fSBarry Smith   */
110733f85c2fSBarry Smith   ierr = PetscRegisterFinalizeAll();CHKERRQ(ierr);
110833f85c2fSBarry Smith 
110933f85c2fSBarry Smith   /*
111010463e74SBarry Smith      Destroy all the function registration lists created
111110463e74SBarry Smith   */
111210463e74SBarry Smith   ierr = PetscFinalize_DynamicLibraries();CHKERRQ(ierr);
111310463e74SBarry Smith 
11144028d114SSatish Balay   if (petsc_history) {
1115f3dea69dSBarry Smith     ierr = PetscCloseHistoryFile(&petsc_history);CHKERRQ(ierr);
1116e5c89e4eSSatish Balay     petsc_history = 0;
1117e5c89e4eSSatish Balay   }
1118e5c89e4eSSatish Balay 
11196cf91177SBarry Smith   ierr = PetscInfoAllow(PETSC_FALSE,PETSC_NULL);CHKERRQ(ierr);
1120e5c89e4eSSatish Balay 
11218bb29257SSatish Balay   {
1122e5c89e4eSSatish Balay     char fname[PETSC_MAX_PATH_LEN];
1123e5c89e4eSSatish Balay     FILE *fd;
1124ed9cf6e9SBarry Smith     int  err;
1125e5c89e4eSSatish Balay 
1126e5c89e4eSSatish Balay     fname[0] = 0;
1127e5c89e4eSSatish Balay     ierr = PetscOptionsGetString(PETSC_NULL,"-malloc_dump",fname,250,&flg1);CHKERRQ(ierr);
1128e5c89e4eSSatish Balay     if (flg1 && fname[0]) {
1129e5c89e4eSSatish Balay       char sname[PETSC_MAX_PATH_LEN];
1130e5c89e4eSSatish Balay 
1131e5c89e4eSSatish Balay       sprintf(sname,"%s_%d",fname,rank);
1132e32f2f54SBarry Smith       fd   = fopen(sname,"w"); if (!fd) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_FILE_OPEN,"Cannot open log file: %s",sname);
1133e5c89e4eSSatish Balay       ierr = PetscMallocDump(fd);CHKERRQ(ierr);
1134ed9cf6e9SBarry Smith       err = fclose(fd);
1135e32f2f54SBarry Smith       if (err) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SYS,"fclose() failed on file");
11368bb29257SSatish Balay     } else if (flg1) {
1137e5c89e4eSSatish Balay       MPI_Comm local_comm;
1138e5c89e4eSSatish Balay 
1139e5c89e4eSSatish Balay       ierr = MPI_Comm_dup(MPI_COMM_WORLD,&local_comm);CHKERRQ(ierr);
1140e5c89e4eSSatish Balay       ierr = PetscSequentialPhaseBegin_Private(local_comm,1);CHKERRQ(ierr);
1141e5c89e4eSSatish Balay         ierr = PetscMallocDump(stdout);CHKERRQ(ierr);
1142e5c89e4eSSatish Balay       ierr = PetscSequentialPhaseEnd_Private(local_comm,1);CHKERRQ(ierr);
1143e5c89e4eSSatish Balay       ierr = MPI_Comm_free(&local_comm);CHKERRQ(ierr);
1144e5c89e4eSSatish Balay     }
1145e5c89e4eSSatish Balay   }
11468bb29257SSatish Balay   {
1147e5c89e4eSSatish Balay     char fname[PETSC_MAX_PATH_LEN];
1148e5c89e4eSSatish Balay     FILE *fd;
1149e5c89e4eSSatish Balay 
1150e5c89e4eSSatish Balay     fname[0] = 0;
1151e5c89e4eSSatish Balay     ierr = PetscOptionsGetString(PETSC_NULL,"-malloc_log",fname,250,&flg1);CHKERRQ(ierr);
1152e5c89e4eSSatish Balay     if (flg1 && fname[0]) {
1153e5c89e4eSSatish Balay       char sname[PETSC_MAX_PATH_LEN];
1154ed9cf6e9SBarry Smith       int  err;
1155e5c89e4eSSatish Balay 
1156e5c89e4eSSatish Balay       sprintf(sname,"%s_%d",fname,rank);
1157e32f2f54SBarry Smith       fd   = fopen(sname,"w"); if (!fd) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_FILE_OPEN,"Cannot open log file: %s",sname);
1158e5c89e4eSSatish Balay       ierr = PetscMallocDumpLog(fd);CHKERRQ(ierr);
1159ed9cf6e9SBarry Smith       err = fclose(fd);
1160e32f2f54SBarry Smith       if (err) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SYS,"fclose() failed on file");
11618bb29257SSatish Balay     } else if (flg1) {
1162e5c89e4eSSatish Balay       ierr = PetscMallocDumpLog(stdout);CHKERRQ(ierr);
1163e5c89e4eSSatish Balay     }
1164e5c89e4eSSatish Balay   }
1165e5c89e4eSSatish Balay   /* Can be destroyed only after all the options are used */
1166e5c89e4eSSatish Balay   ierr = PetscOptionsDestroy();CHKERRQ(ierr);
1167e5c89e4eSSatish Balay 
1168e5c89e4eSSatish Balay   PetscGlobalArgc = 0;
1169e5c89e4eSSatish Balay   PetscGlobalArgs = 0;
1170e5c89e4eSSatish Balay 
1171ce63c4c1SBarry Smith #if defined(PETSC_USE_REAL___FLOAT128)
1172c90a1750SBarry Smith   ierr = MPI_Type_free(&MPIU___FLOAT128);CHKERRQ(ierr);
1173854411e3SBarry Smith   ierr = MPI_Op_free(&MPIU_SUM);CHKERRQ(ierr);
1174d9822059SBarry Smith   ierr = MPI_Op_free(&MPIU_MAX);CHKERRQ(ierr);
1175d9822059SBarry Smith   ierr = MPI_Op_free(&MPIU_MIN);CHKERRQ(ierr);
1176c90a1750SBarry Smith #endif
1177c90a1750SBarry Smith 
1178e5c89e4eSSatish Balay #if defined(PETSC_USE_COMPLEX)
11792c876bd9SBarry Smith #if !defined(PETSC_HAVE_MPI_C_DOUBLE_COMPLEX)
118006a205a8SBarry Smith   ierr = MPI_Op_free(&MPIU_SUM);CHKERRQ(ierr);
1181500d8756SSatish Balay   ierr = MPI_Type_free(&MPIU_C_DOUBLE_COMPLEX);CHKERRQ(ierr);
1182500d8756SSatish Balay   ierr = MPI_Type_free(&MPIU_C_COMPLEX);CHKERRQ(ierr);
11832c876bd9SBarry Smith #endif
1184e5c89e4eSSatish Balay #endif
1185e5c89e4eSSatish Balay   ierr = MPI_Type_free(&MPIU_2SCALAR);CHKERRQ(ierr);
1186e5c89e4eSSatish Balay   ierr = MPI_Type_free(&MPIU_2INT);CHKERRQ(ierr);
1187e5c89e4eSSatish Balay   ierr = MPI_Op_free(&PetscMaxSum_Op);CHKERRQ(ierr);
1188e5c89e4eSSatish Balay   ierr = MPI_Op_free(&PetscADMax_Op);CHKERRQ(ierr);
1189e5c89e4eSSatish Balay   ierr = MPI_Op_free(&PetscADMin_Op);CHKERRQ(ierr);
1190e5c89e4eSSatish Balay 
1191dbc8283eSBarry Smith   /*
1192efb80d3cSBarry Smith      Destroy any known inner MPI_Comm's and attributes pointing to them
1193efb80d3cSBarry Smith      Note this will not destroy any new communicators the user has created.
1194efb80d3cSBarry Smith 
1195efb80d3cSBarry Smith      If all PETSc objects were not destroyed those left over objects will have hanging references to
1196efb80d3cSBarry Smith      the MPI_Comms that were freed; but that is ok because those PETSc objects will never be used again
1197dbc8283eSBarry Smith  */
1198b770b1f6SSatish Balay   {
1199dbc8283eSBarry Smith     PetscCommCounter *counter;
1200dbc8283eSBarry Smith     PetscMPIInt      flg;
1201dbc8283eSBarry Smith     MPI_Comm         icomm;
1202dbc8283eSBarry Smith     void             *ptr;
1203dbc8283eSBarry Smith     ierr  = MPI_Attr_get(PETSC_COMM_SELF,Petsc_InnerComm_keyval,&ptr,&flg);CHKERRQ(ierr);
1204dbc8283eSBarry Smith     if (flg) {
1205dbc8283eSBarry Smith       /*  Use PetscMemcpy() because casting from pointer to integer of different size is not allowed with some compilers  */
1206dbc8283eSBarry Smith       ierr = PetscMemcpy(&icomm,&ptr,sizeof(MPI_Comm));CHKERRQ(ierr);
1207dbc8283eSBarry Smith       ierr = MPI_Attr_get(icomm,Petsc_Counter_keyval,&counter,&flg);CHKERRQ(ierr);
1208dbc8283eSBarry 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");
1209dbc8283eSBarry Smith 
1210dbc8283eSBarry Smith       ierr = MPI_Attr_delete(PETSC_COMM_SELF,Petsc_InnerComm_keyval);CHKERRQ(ierr);
1211efb80d3cSBarry Smith       ierr = MPI_Attr_delete(icomm,Petsc_Counter_keyval);CHKERRQ(ierr);
1212efb80d3cSBarry Smith       ierr = MPI_Comm_free(&icomm);CHKERRQ(ierr);
1213dbc8283eSBarry Smith     }
1214dbc8283eSBarry Smith     ierr  = MPI_Attr_get(PETSC_COMM_WORLD,Petsc_InnerComm_keyval,&ptr,&flg);CHKERRQ(ierr);
1215dbc8283eSBarry Smith     if (flg) {
1216dbc8283eSBarry Smith       /*  Use PetscMemcpy() because casting from pointer to integer of different size is not allowed with some compilers  */
1217dbc8283eSBarry Smith       ierr = PetscMemcpy(&icomm,&ptr,sizeof(MPI_Comm));CHKERRQ(ierr);
1218dbc8283eSBarry Smith       ierr = MPI_Attr_get(icomm,Petsc_Counter_keyval,&counter,&flg);CHKERRQ(ierr);
1219dbc8283eSBarry 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");
1220dbc8283eSBarry Smith 
1221dbc8283eSBarry Smith       ierr = MPI_Attr_delete(PETSC_COMM_WORLD,Petsc_InnerComm_keyval);CHKERRQ(ierr);
1222efb80d3cSBarry Smith       ierr = MPI_Attr_delete(icomm,Petsc_Counter_keyval);CHKERRQ(ierr);
1223efb80d3cSBarry Smith       ierr = MPI_Comm_free(&icomm);CHKERRQ(ierr);
1224dbc8283eSBarry Smith     }
1225b770b1f6SSatish Balay   }
1226dbc8283eSBarry Smith 
1227480cf27aSJed Brown   ierr = MPI_Keyval_free(&Petsc_Counter_keyval);CHKERRQ(ierr);
1228480cf27aSJed Brown   ierr = MPI_Keyval_free(&Petsc_InnerComm_keyval);CHKERRQ(ierr);
1229480cf27aSJed Brown   ierr = MPI_Keyval_free(&Petsc_OuterComm_keyval);CHKERRQ(ierr);
1230480cf27aSJed Brown 
1231ae15b995SBarry Smith   ierr = PetscInfo(0,"PETSc successfully ended!\n");CHKERRQ(ierr);
1232e5c89e4eSSatish Balay   if (PetscBeganMPI) {
123399608316SBarry Smith #if defined(PETSC_HAVE_MPI_FINALIZED)
123499b1327fSBarry Smith     PetscMPIInt flag;
123599b1327fSBarry Smith     ierr = MPI_Finalized(&flag);CHKERRQ(ierr);
1236e32f2f54SBarry Smith     if (flag) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_LIB,"MPI_Finalize() has already been called, even though MPI_Init() was called by PetscInitialize()");
123799608316SBarry Smith #endif
1238e5c89e4eSSatish Balay     ierr = MPI_Finalize();CHKERRQ(ierr);
1239e5c89e4eSSatish Balay   }
1240e5c89e4eSSatish Balay 
12419c4c166aSBarry Smith   if (PETSC_ZOPEFD){
124222b84c2fSbcordonn     if (PETSC_ZOPEFD != PETSC_STDOUT) fprintf(PETSC_ZOPEFD, "<<<end>>>");
12439c4c166aSBarry Smith     else fprintf(PETSC_STDOUT, "<<<end>>>");
12449c4c166aSBarry Smith   }
124536186564Sbcordonn 
124635d88935SVictor Minden #if defined(PETSC_HAVE_CUDA)
12472f947c57SVictor Minden   cublasShutdown();
1248440a5bbfSVictor Minden #endif
1249e5c89e4eSSatish Balay /*
1250e5c89e4eSSatish Balay 
1251e5c89e4eSSatish Balay      Note: In certain cases PETSC_COMM_WORLD is never MPI_Comm_free()ed because
1252e5c89e4eSSatish Balay    the communicator has some outstanding requests on it. Specifically if the
1253e5c89e4eSSatish Balay    flag PETSC_HAVE_BROKEN_REQUEST_FREE is set (for IBM MPI implementation). See
1254e5c89e4eSSatish Balay    src/vec/utils/vpscat.c. Due to this the memory allocated in PetscCommDuplicate()
1255e5c89e4eSSatish Balay    is never freed as it should be. Thus one may obtain messages of the form
12560e5e90baSSatish Balay    [ 1] 8 bytes PetscCommDuplicate() line 645 in src/sys/mpiu.c indicating the
1257e5c89e4eSSatish Balay    memory was not freed.
1258e5c89e4eSSatish Balay 
1259e5c89e4eSSatish Balay */
12601d1a0024SBarry Smith   ierr = PetscMallocClear();CHKERRQ(ierr);
1261e5c89e4eSSatish Balay   PetscInitializeCalled = PETSC_FALSE;
1262e5c89e4eSSatish Balay   PetscFinalizeCalled   = PETSC_TRUE;
1263e5c89e4eSSatish Balay   PetscFunctionReturn(ierr);
1264e5c89e4eSSatish Balay }
1265e5c89e4eSSatish Balay 
1266