xref: /petsc/src/sys/objects/pinit.c (revision c90a1750bdbee6915dd9fc4c3be647ac513fbcb1)
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
15ace3abfcSBarry Smith extern PetscBool  PetscOpenMPWorker;
16e5c89e4eSSatish Balay 
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);
2409573ac7SBarry Smith extern PetscErrorCode PetscSequentialPhaseBegin_Private(MPI_Comm,int);
2509573ac7SBarry Smith extern PetscErrorCode PetscSequentialPhaseEnd_Private(MPI_Comm,int);
2609573ac7SBarry Smith extern PetscErrorCode PetscCloseHistoryFile(FILE **);
27e5c89e4eSSatish Balay 
28e5c89e4eSSatish Balay /* this is used by the _, __, and ___ macros (see include/petscerror.h) */
29e5c89e4eSSatish Balay PetscErrorCode __gierr = 0;
30e5c89e4eSSatish Balay 
31e5c89e4eSSatish Balay /* user may set this BEFORE calling PetscInitialize() */
32e8373e55SMatthew Knepley MPI_Comm PETSC_COMM_WORLD = MPI_COMM_NULL;
33e5c89e4eSSatish Balay 
34480cf27aSJed Brown PetscMPIInt Petsc_Counter_keyval   = MPI_KEYVAL_INVALID;
35480cf27aSJed Brown PetscMPIInt Petsc_InnerComm_keyval = MPI_KEYVAL_INVALID;
36480cf27aSJed Brown PetscMPIInt Petsc_OuterComm_keyval = MPI_KEYVAL_INVALID;
37480cf27aSJed Brown 
38e5c89e4eSSatish Balay /*
39e5c89e4eSSatish Balay      Declare and set all the string names of the PETSc enums
40e5c89e4eSSatish Balay */
41ace3abfcSBarry Smith const char *PetscBools[]     = {"FALSE","TRUE","PetscBool","PETSC_",0};
4270b3c8c7SBarry Smith const char *PetscCopyModes[] = {"COPY_VALUES","OWN_POINTER","USE_POINTER","PetscCopyMode","PETSC_",0};
4370b3c8c7SBarry Smith const char *PetscDataTypes[] = {"INT","DOUBLE","COMPLEX","LONG","SHORT","FLOAT",
44ace3abfcSBarry Smith                                 "CHAR","LOGICAL","ENUM","BOOL","LONGDOUBLE","PetscDataType","PETSC_",0};
45e5c89e4eSSatish Balay 
46ace3abfcSBarry Smith PetscBool  PetscPreLoadingUsed = PETSC_FALSE;
47ace3abfcSBarry Smith PetscBool  PetscPreLoadingOn   = PETSC_FALSE;
480f8e0872SSatish Balay 
49e5c89e4eSSatish Balay /*
50e5c89e4eSSatish Balay        Checks the options database for initializations related to the
51e5c89e4eSSatish Balay     PETSc components
52e5c89e4eSSatish Balay */
53e5c89e4eSSatish Balay #undef __FUNCT__
54e5c89e4eSSatish Balay #define __FUNCT__ "PetscOptionsCheckInitial_Components"
557087cfbeSBarry Smith PetscErrorCode  PetscOptionsCheckInitial_Components(void)
56e5c89e4eSSatish Balay {
57ace3abfcSBarry Smith   PetscBool  flg1;
58e5c89e4eSSatish Balay   PetscErrorCode ierr;
59e5c89e4eSSatish Balay 
60e5c89e4eSSatish Balay   PetscFunctionBegin;
61e5c89e4eSSatish Balay   ierr = PetscOptionsHasName(PETSC_NULL,"-help",&flg1);CHKERRQ(ierr);
62e5c89e4eSSatish Balay   if (flg1) {
63e5c89e4eSSatish Balay #if defined (PETSC_USE_LOG)
64e8e7597cSSatish Balay     MPI_Comm   comm = PETSC_COMM_WORLD;
65e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm,"------Additional PETSc component options--------\n");CHKERRQ(ierr);
66e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm," -log_summary_exclude: <vec,mat,pc.ksp,snes>\n");CHKERRQ(ierr);
676cf91177SBarry Smith     ierr = (*PetscHelpPrintf)(comm," -info_exclude: <null,vec,mat,pc,ksp,snes,ts>\n");CHKERRQ(ierr);
68e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm,"-----------------------------------------------\n");CHKERRQ(ierr);
69e5c89e4eSSatish Balay #endif
70e5c89e4eSSatish Balay   }
71e5c89e4eSSatish Balay   PetscFunctionReturn(0);
72e5c89e4eSSatish Balay }
73e5c89e4eSSatish Balay 
740f11a792SBarry Smith #if defined(PETSC_HAVE_MATLAB_ENGINE)
75df413903SBarry Smith extern PetscBool PetscBeganMPI;
76df413903SBarry Smith 
77e5c89e4eSSatish Balay #undef __FUNCT__
780f11a792SBarry Smith #define __FUNCT__ "PetscInitializeMatlab"
790f11a792SBarry Smith /*
800f11a792SBarry Smith       PetscInitializeMatlab - Calls PetscInitialize() from C/C++ without the pointers to argc and args
8172a42c3cSBarry Smith 
8272a42c3cSBarry Smith    Collective
8372a42c3cSBarry Smith 
8472a42c3cSBarry Smith    Level: advanced
8572a42c3cSBarry Smith 
860f11a792SBarry Smith     Notes: this is called only by the PETSc MATLAB interface. Even though it might start MPI it sets the flag to
870f11a792SBarry Smith      indicate that it did NOT start MPI so that the PetscFinalize() does not end MPI, thus allowing PetscInitialize() to
880f11a792SBarry Smith      be called multiple times from MATLAB without the problem of trying to initialize MPI more than once.
890f11a792SBarry Smith 
9072a42c3cSBarry Smith .seealso: PetscInitialize(), PetscInitializeFortran(), PetscInitializeNoArguments()
910f11a792SBarry Smith */
920f11a792SBarry Smith PetscErrorCode  PetscInitializeMatlab(int argc,char **args,const char *filename,const char *help)
9372a42c3cSBarry Smith {
9472a42c3cSBarry Smith   PetscErrorCode ierr;
9572a42c3cSBarry Smith   int            myargc = argc;
9672a42c3cSBarry Smith   char           **myargs = args;
9772a42c3cSBarry Smith 
9872a42c3cSBarry Smith   PetscFunctionBegin;
9972a42c3cSBarry Smith   ierr = PetscInitialize(&myargc,&myargs,filename,help);
100df413903SBarry Smith   PetscBeganMPI = PETSC_FALSE;
10172a42c3cSBarry Smith   PetscFunctionReturn(ierr);
10272a42c3cSBarry Smith }
10372a42c3cSBarry Smith 
10472a42c3cSBarry Smith #undef __FUNCT__
1050f11a792SBarry Smith #define __FUNCT__ "PetscInitializedMatlab"
1060f11a792SBarry Smith /*
1070f11a792SBarry Smith       PetscInitializedMatlab - Has PETSc been initialized already?
1080f11a792SBarry Smith 
1090f11a792SBarry Smith    Not Collective
1100f11a792SBarry Smith 
1110f11a792SBarry Smith    Level: advanced
1120f11a792SBarry Smith 
1130f11a792SBarry Smith     Notes: this is called only by the PETSc MATLAB interface.
1140f11a792SBarry Smith 
1150f11a792SBarry Smith .seealso: PetscInitialize(), PetscInitializeFortran(), PetscInitializeNoArguments()
1160f11a792SBarry Smith */
1170f11a792SBarry Smith int  PetscInitializedMatlab(void)
1180f11a792SBarry Smith {
1190f11a792SBarry Smith   PetscBool flg;
1200f11a792SBarry Smith 
1210f11a792SBarry Smith   PetscInitialized(&flg);
1220f11a792SBarry Smith   if (flg) return 1;
1230f11a792SBarry Smith   else return 0;
1240f11a792SBarry Smith }
1250f11a792SBarry Smith 
1260f11a792SBarry Smith #undef __FUNCT__
1270f11a792SBarry Smith #define __FUNCT__ "PetscGetPETSC_COMM_SELFMatlab"
128f0865b08SBarry Smith /*
129e3c5b3baSBarry Smith       Used by MATLAB interface to get communicator
130f0865b08SBarry Smith */
1310f11a792SBarry Smith PetscErrorCode  PetscGetPETSC_COMM_SELFMatlab(MPI_Comm *comm)
132f0865b08SBarry Smith {
133f0865b08SBarry Smith   PetscFunctionBegin;
134f0865b08SBarry Smith   *comm = PETSC_COMM_SELF;
135f0865b08SBarry Smith   PetscFunctionReturn(0);
136f0865b08SBarry Smith }
1370f11a792SBarry Smith #endif
138f0865b08SBarry Smith 
139f0865b08SBarry Smith #undef __FUNCT__
140e5c89e4eSSatish Balay #define __FUNCT__ "PetscInitializeNoArguments"
141e5c89e4eSSatish Balay /*@C
142e5c89e4eSSatish Balay       PetscInitializeNoArguments - Calls PetscInitialize() from C/C++ without
143e5c89e4eSSatish Balay         the command line arguments.
144e5c89e4eSSatish Balay 
145e5c89e4eSSatish Balay    Collective
146e5c89e4eSSatish Balay 
147e5c89e4eSSatish Balay    Level: advanced
148e5c89e4eSSatish Balay 
149e5c89e4eSSatish Balay .seealso: PetscInitialize(), PetscInitializeFortran()
150e5c89e4eSSatish Balay @*/
1517087cfbeSBarry Smith PetscErrorCode  PetscInitializeNoArguments(void)
152e5c89e4eSSatish Balay {
153e5c89e4eSSatish Balay   PetscErrorCode ierr;
154e5c89e4eSSatish Balay   int            argc = 0;
155e5c89e4eSSatish Balay   char           **args = 0;
156e5c89e4eSSatish Balay 
157e5c89e4eSSatish Balay   PetscFunctionBegin;
158e5c89e4eSSatish Balay   ierr = PetscInitialize(&argc,&args,PETSC_NULL,PETSC_NULL);
159e5c89e4eSSatish Balay   PetscFunctionReturn(ierr);
160e5c89e4eSSatish Balay }
161e5c89e4eSSatish Balay 
162e5c89e4eSSatish Balay #undef __FUNCT__
163e5c89e4eSSatish Balay #define __FUNCT__ "PetscInitialized"
164e5c89e4eSSatish Balay /*@
165e5c89e4eSSatish Balay       PetscInitialized - Determine whether PETSc is initialized.
166e5c89e4eSSatish Balay 
1676dc8fec2Sbcordonn 7   Level: beginner
168e5c89e4eSSatish Balay 
169e5c89e4eSSatish Balay .seealso: PetscInitialize(), PetscInitializeNoArguments(), PetscInitializeFortran()
170e5c89e4eSSatish Balay @*/
1717087cfbeSBarry Smith PetscErrorCode  PetscInitialized(PetscBool  *isInitialized)
172e5c89e4eSSatish Balay {
173e5c89e4eSSatish Balay   PetscFunctionBegin;
174e5c89e4eSSatish Balay   PetscValidPointer(isInitialized, 1);
175e5c89e4eSSatish Balay   *isInitialized = PetscInitializeCalled;
176e5c89e4eSSatish Balay   PetscFunctionReturn(0);
177e5c89e4eSSatish Balay }
178e5c89e4eSSatish Balay 
179e5c89e4eSSatish Balay #undef __FUNCT__
180e5c89e4eSSatish Balay #define __FUNCT__ "PetscFinalized"
181e5c89e4eSSatish Balay /*@
182e5c89e4eSSatish Balay       PetscFinalized - Determine whether PetscFinalize() has been called yet
183e5c89e4eSSatish Balay 
184e5c89e4eSSatish Balay    Level: developer
185e5c89e4eSSatish Balay 
186e5c89e4eSSatish Balay .seealso: PetscInitialize(), PetscInitializeNoArguments(), PetscInitializeFortran()
187e5c89e4eSSatish Balay @*/
1887087cfbeSBarry Smith PetscErrorCode  PetscFinalized(PetscBool  *isFinalized)
189e5c89e4eSSatish Balay {
190e5c89e4eSSatish Balay   PetscFunctionBegin;
191e5c89e4eSSatish Balay   PetscValidPointer(isFinalized, 1);
192e5c89e4eSSatish Balay   *isFinalized = PetscFinalizeCalled;
193e5c89e4eSSatish Balay   PetscFunctionReturn(0);
194e5c89e4eSSatish Balay }
195e5c89e4eSSatish Balay 
19609573ac7SBarry Smith extern PetscErrorCode        PetscOptionsCheckInitial_Private(void);
197ace3abfcSBarry Smith extern PetscBool  PetscBeganMPI;
198e5c89e4eSSatish Balay 
199e5c89e4eSSatish Balay /*
200e5c89e4eSSatish Balay        This function is the MPI reduction operation used to compute the sum of the
201e5c89e4eSSatish Balay    first half of the datatype and the max of the second half.
202e5c89e4eSSatish Balay */
203e5c89e4eSSatish Balay MPI_Op PetscMaxSum_Op = 0;
204e5c89e4eSSatish Balay 
205e5c89e4eSSatish Balay EXTERN_C_BEGIN
206e5c89e4eSSatish Balay #undef __FUNCT__
207e5c89e4eSSatish Balay #define __FUNCT__ "PetscMaxSum_Local"
2087087cfbeSBarry Smith void  MPIAPI PetscMaxSum_Local(void *in,void *out,int *cnt,MPI_Datatype *datatype)
209e5c89e4eSSatish Balay {
210e5c89e4eSSatish Balay   PetscInt *xin = (PetscInt*)in,*xout = (PetscInt*)out,i,count = *cnt;
211e5c89e4eSSatish Balay 
212e5c89e4eSSatish Balay   PetscFunctionBegin;
213e5c89e4eSSatish Balay   if (*datatype != MPIU_2INT) {
214e5c89e4eSSatish Balay     (*PetscErrorPrintf)("Can only handle MPIU_2INT data types");
215e5c89e4eSSatish Balay     MPI_Abort(MPI_COMM_WORLD,1);
216e5c89e4eSSatish Balay   }
217e5c89e4eSSatish Balay 
218e5c89e4eSSatish Balay   for (i=0; i<count; i++) {
219e5c89e4eSSatish Balay     xout[2*i]    = PetscMax(xout[2*i],xin[2*i]);
220e5c89e4eSSatish Balay     xout[2*i+1] += xin[2*i+1];
221e5c89e4eSSatish Balay   }
222812af9f3SBarry Smith   PetscFunctionReturnVoid();
223e5c89e4eSSatish Balay }
224e5c89e4eSSatish Balay EXTERN_C_END
225e5c89e4eSSatish Balay 
226e5c89e4eSSatish Balay /*
227e5c89e4eSSatish Balay     Returns the max of the first entry owned by this processor and the
228e5c89e4eSSatish Balay sum of the second entry.
229b693b147SBarry Smith 
230b693b147SBarry Smith     The reason nprocs[2*i] contains lengths nprocs[2*i+1] contains flag of 1 if length is nonzero
231b693b147SBarry Smith is so that the PetscMaxSum_Op() can set TWO values, if we passed in only nprocs[i] with lengths
232b693b147SBarry Smith there would be no place to store the both needed results.
233e5c89e4eSSatish Balay */
234e5c89e4eSSatish Balay #undef __FUNCT__
235e5c89e4eSSatish Balay #define __FUNCT__ "PetscMaxSum"
2367087cfbeSBarry Smith PetscErrorCode  PetscMaxSum(MPI_Comm comm,const PetscInt nprocs[],PetscInt *max,PetscInt *sum)
237e5c89e4eSSatish Balay {
238e5c89e4eSSatish Balay   PetscMPIInt    size,rank;
239e5c89e4eSSatish Balay   PetscInt       *work;
240e5c89e4eSSatish Balay   PetscErrorCode ierr;
241e5c89e4eSSatish Balay 
242e5c89e4eSSatish Balay   PetscFunctionBegin;
243e5c89e4eSSatish Balay   ierr   = MPI_Comm_size(comm,&size);CHKERRQ(ierr);
244e5c89e4eSSatish Balay   ierr   = MPI_Comm_rank(comm,&rank);CHKERRQ(ierr);
245e5c89e4eSSatish Balay   ierr   = PetscMalloc(2*size*sizeof(PetscInt),&work);CHKERRQ(ierr);
246e5c89e4eSSatish Balay   ierr   = MPI_Allreduce((void*)nprocs,work,size,MPIU_2INT,PetscMaxSum_Op,comm);CHKERRQ(ierr);
247e5c89e4eSSatish Balay   *max   = work[2*rank];
248e5c89e4eSSatish Balay   *sum   = work[2*rank+1];
249e5c89e4eSSatish Balay   ierr   = PetscFree(work);CHKERRQ(ierr);
250e5c89e4eSSatish Balay   PetscFunctionReturn(0);
251e5c89e4eSSatish Balay }
252e5c89e4eSSatish Balay 
253e5c89e4eSSatish Balay /* ----------------------------------------------------------------------------*/
2547087cfbeSBarry Smith MPI_Op  PetscADMax_Op = 0;
255e5c89e4eSSatish Balay 
256e5c89e4eSSatish Balay EXTERN_C_BEGIN
257e5c89e4eSSatish Balay #undef __FUNCT__
258e5c89e4eSSatish Balay #define __FUNCT__ "PetscADMax_Local"
2597087cfbeSBarry Smith void  MPIAPI PetscADMax_Local(void *in,void *out,PetscMPIInt *cnt,MPI_Datatype *datatype)
260e5c89e4eSSatish Balay {
261e5c89e4eSSatish Balay   PetscScalar *xin = (PetscScalar *)in,*xout = (PetscScalar*)out;
262e5c89e4eSSatish Balay   PetscInt    i,count = *cnt;
263e5c89e4eSSatish Balay 
264e5c89e4eSSatish Balay   PetscFunctionBegin;
265e5c89e4eSSatish Balay   if (*datatype != MPIU_2SCALAR) {
266e5c89e4eSSatish Balay     (*PetscErrorPrintf)("Can only handle MPIU_2SCALAR data (i.e. double or complex) types");
267e5c89e4eSSatish Balay     MPI_Abort(MPI_COMM_WORLD,1);
268e5c89e4eSSatish Balay   }
269e5c89e4eSSatish Balay 
270e5c89e4eSSatish Balay   for (i=0; i<count; i++) {
271e5c89e4eSSatish Balay     if (PetscRealPart(xout[2*i]) < PetscRealPart(xin[2*i])) {
272e5c89e4eSSatish Balay       xout[2*i]   = xin[2*i];
273e5c89e4eSSatish Balay       xout[2*i+1] = xin[2*i+1];
274e5c89e4eSSatish Balay     }
275e5c89e4eSSatish Balay   }
276812af9f3SBarry Smith   PetscFunctionReturnVoid();
277e5c89e4eSSatish Balay }
278e5c89e4eSSatish Balay EXTERN_C_END
279e5c89e4eSSatish Balay 
2807087cfbeSBarry Smith MPI_Op  PetscADMin_Op = 0;
281e5c89e4eSSatish Balay 
282e5c89e4eSSatish Balay EXTERN_C_BEGIN
283e5c89e4eSSatish Balay #undef __FUNCT__
284e5c89e4eSSatish Balay #define __FUNCT__ "PetscADMin_Local"
2857087cfbeSBarry Smith void  MPIAPI PetscADMin_Local(void *in,void *out,PetscMPIInt *cnt,MPI_Datatype *datatype)
286e5c89e4eSSatish Balay {
287e5c89e4eSSatish Balay   PetscScalar *xin = (PetscScalar *)in,*xout = (PetscScalar*)out;
288e5c89e4eSSatish Balay   PetscInt    i,count = *cnt;
289e5c89e4eSSatish Balay 
290e5c89e4eSSatish Balay   PetscFunctionBegin;
291e5c89e4eSSatish Balay   if (*datatype != MPIU_2SCALAR) {
292e5c89e4eSSatish Balay     (*PetscErrorPrintf)("Can only handle MPIU_2SCALAR data (i.e. double or complex) types");
293e5c89e4eSSatish Balay     MPI_Abort(MPI_COMM_WORLD,1);
294e5c89e4eSSatish Balay   }
295e5c89e4eSSatish Balay 
296e5c89e4eSSatish Balay   for (i=0; i<count; i++) {
297e5c89e4eSSatish Balay     if (PetscRealPart(xout[2*i]) > PetscRealPart(xin[2*i])) {
298e5c89e4eSSatish Balay       xout[2*i]   = xin[2*i];
299e5c89e4eSSatish Balay       xout[2*i+1] = xin[2*i+1];
300e5c89e4eSSatish Balay     }
301e5c89e4eSSatish Balay   }
302812af9f3SBarry Smith   PetscFunctionReturnVoid();
303e5c89e4eSSatish Balay }
304e5c89e4eSSatish Balay EXTERN_C_END
305e5c89e4eSSatish Balay /* ---------------------------------------------------------------------------------------*/
306e5c89e4eSSatish Balay 
307e5c89e4eSSatish Balay #if defined(PETSC_USE_COMPLEX)
3082c876bd9SBarry Smith 
3092c876bd9SBarry Smith /*
3102c876bd9SBarry Smith     This operation is only needed when using complex numbers with older MPI that does not support complex numbers
3112c876bd9SBarry Smith */
3122c876bd9SBarry Smith #if !defined(PETSC_HAVE_MPI_C_DOUBLE_COMPLEX)
31306a205a8SBarry Smith MPI_Op MPIU_SUM = 0;
314e5c89e4eSSatish Balay 
315e5c89e4eSSatish Balay EXTERN_C_BEGIN
316e5c89e4eSSatish Balay #undef __FUNCT__
317e5c89e4eSSatish Balay #define __FUNCT__ "PetscSum_Local"
3187087cfbeSBarry Smith void  PetscSum_Local(void *in,void *out,PetscMPIInt *cnt,MPI_Datatype *datatype)
319e5c89e4eSSatish Balay {
320e5c89e4eSSatish Balay   PetscScalar *xin = (PetscScalar *)in,*xout = (PetscScalar*)out;
321e5c89e4eSSatish Balay   PetscInt    i,count = *cnt;
322e5c89e4eSSatish Balay 
323e5c89e4eSSatish Balay   PetscFunctionBegin;
324e5c89e4eSSatish Balay   if (*datatype != MPIU_SCALAR) {
325e5c89e4eSSatish Balay     (*PetscErrorPrintf)("Can only handle MPIU_SCALAR data (i.e. double or complex) types");
326e5c89e4eSSatish Balay     MPI_Abort(MPI_COMM_WORLD,1);
327e5c89e4eSSatish Balay   }
328e5c89e4eSSatish Balay 
329e5c89e4eSSatish Balay   for (i=0; i<count; i++) {
330e5c89e4eSSatish Balay     xout[i] += xin[i];
331e5c89e4eSSatish Balay   }
332812af9f3SBarry Smith   PetscFunctionReturnVoid();
333e5c89e4eSSatish Balay }
334e5c89e4eSSatish Balay EXTERN_C_END
335e5c89e4eSSatish Balay #endif
3362c876bd9SBarry Smith #endif
337e5c89e4eSSatish Balay 
338480cf27aSJed Brown EXTERN_C_BEGIN
339480cf27aSJed Brown #undef __FUNCT__
340480cf27aSJed Brown #define __FUNCT__ "Petsc_DelCounter"
341480cf27aSJed Brown /*
342480cf27aSJed Brown    Private routine to delete internal tag/name counter storage when a communicator is freed.
343480cf27aSJed Brown 
344480cf27aSJed Brown    This is called by MPI, not by users.
345480cf27aSJed Brown 
346480cf27aSJed Brown    Note: this is declared extern "C" because it is passed to MPI_Keyval_create()
347480cf27aSJed Brown 
348480cf27aSJed Brown */
3497087cfbeSBarry Smith PetscMPIInt  MPIAPI Petsc_DelCounter(MPI_Comm comm,PetscMPIInt keyval,void *count_val,void *extra_state)
350480cf27aSJed Brown {
351480cf27aSJed Brown   PetscErrorCode ierr;
352480cf27aSJed Brown 
353480cf27aSJed Brown   PetscFunctionBegin;
354480cf27aSJed Brown   ierr = PetscInfo1(0,"Deleting counter data in an MPI_Comm %ld\n",(long)comm);if (ierr) PetscFunctionReturn((PetscMPIInt)ierr);
355480cf27aSJed Brown   ierr = PetscFree(count_val);if (ierr) PetscFunctionReturn((PetscMPIInt)ierr);
356480cf27aSJed Brown   PetscFunctionReturn(MPI_SUCCESS);
357480cf27aSJed Brown }
358480cf27aSJed Brown EXTERN_C_END
359480cf27aSJed Brown 
360480cf27aSJed Brown EXTERN_C_BEGIN
361480cf27aSJed Brown #undef __FUNCT__
362480cf27aSJed Brown #define __FUNCT__ "Petsc_DelComm"
363480cf27aSJed Brown /*
364480cf27aSJed Brown   This does not actually free anything, it simply marks when a reference count to an internal MPI_Comm reaches zero and the
365480cf27aSJed Brown   the external MPI_Comm drops its reference to the internal MPI_Comm
366480cf27aSJed Brown 
367480cf27aSJed Brown   This is called by MPI, not by users.
368480cf27aSJed Brown 
369480cf27aSJed Brown   Note: this is declared extern "C" because it is passed to MPI_Keyval_create()
370480cf27aSJed Brown 
371480cf27aSJed Brown */
3727087cfbeSBarry Smith PetscMPIInt  MPIAPI Petsc_DelComm(MPI_Comm comm,PetscMPIInt keyval,void *attr_val,void *extra_state)
373480cf27aSJed Brown {
374480cf27aSJed Brown   PetscErrorCode ierr;
375480cf27aSJed Brown 
376480cf27aSJed Brown   PetscFunctionBegin;
377480cf27aSJed Brown   ierr = PetscInfo1(0,"Deleting PETSc communicator imbedded in a user MPI_Comm %ld\n",(long)comm);if (ierr) PetscFunctionReturn((PetscMPIInt)ierr);
378480cf27aSJed Brown   /* actually don't delete anything because we cannot increase the reference count of the communicator anyways */
379480cf27aSJed Brown   PetscFunctionReturn(MPI_SUCCESS);
380480cf27aSJed Brown }
381480cf27aSJed Brown EXTERN_C_END
382480cf27aSJed Brown 
383951e3c8eSBarry Smith #if defined(PETSC_USE_PETSC_MPI_EXTERNAL32)
384e39fd77fSBarry Smith #if !defined(PETSC_WORDS_BIGENDIAN)
385e39fd77fSBarry Smith EXTERN_C_BEGIN
386e39fd77fSBarry Smith extern PetscMPIInt PetscDataRep_extent_fn(MPI_Datatype,MPI_Aint*,void*);
387e39fd77fSBarry Smith extern PetscMPIInt PetscDataRep_read_conv_fn(void*, MPI_Datatype,PetscMPIInt,void*,MPI_Offset,void*);
388e39fd77fSBarry Smith extern PetscMPIInt PetscDataRep_write_conv_fn(void*, MPI_Datatype,PetscMPIInt,void*,MPI_Offset,void*);
389e39fd77fSBarry Smith EXTERN_C_END
390e39fd77fSBarry Smith #endif
391951e3c8eSBarry Smith #endif
392e39fd77fSBarry Smith 
3936ae9a8a6SBarry Smith int  PetscGlobalArgc   = 0;
3946ae9a8a6SBarry Smith char **PetscGlobalArgs = 0;
395e5c89e4eSSatish Balay 
396e5c89e4eSSatish Balay #undef __FUNCT__
397e5c89e4eSSatish Balay #define __FUNCT__ "PetscGetArgs"
398e5c89e4eSSatish Balay /*@C
399e5c89e4eSSatish Balay    PetscGetArgs - Allows you to access the raw command line arguments anywhere
400e5c89e4eSSatish Balay      after PetscInitialize() is called but before PetscFinalize().
401e5c89e4eSSatish Balay 
402e5c89e4eSSatish Balay    Not Collective
403e5c89e4eSSatish Balay 
404e5c89e4eSSatish Balay    Output Parameters:
405e5c89e4eSSatish Balay +  argc - count of number of command line arguments
406e5c89e4eSSatish Balay -  args - the command line arguments
407e5c89e4eSSatish Balay 
408e5c89e4eSSatish Balay    Level: intermediate
409e5c89e4eSSatish Balay 
410e5c89e4eSSatish Balay    Notes:
411e5c89e4eSSatish Balay       This is usually used to pass the command line arguments into other libraries
412e5c89e4eSSatish Balay    that are called internally deep in PETSc or the application.
413e5c89e4eSSatish Balay 
414f177e3b1SBarry Smith       The first argument contains the program name as is normal for C arguments.
415f177e3b1SBarry Smith 
416e5c89e4eSSatish Balay    Concepts: command line arguments
417e5c89e4eSSatish Balay 
418793721a6SBarry Smith .seealso: PetscFinalize(), PetscInitializeFortran(), PetscGetArguments()
419e5c89e4eSSatish Balay 
420e5c89e4eSSatish Balay @*/
4217087cfbeSBarry Smith PetscErrorCode  PetscGetArgs(int *argc,char ***args)
422e5c89e4eSSatish Balay {
423e5c89e4eSSatish Balay   PetscFunctionBegin;
42417186662SBarry Smith   if (!PetscInitializeCalled && PetscFinalizeCalled) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ORDER,"You must call after PetscInitialize() but before PetscFinalize()");
425e5c89e4eSSatish Balay   *argc = PetscGlobalArgc;
426e5c89e4eSSatish Balay   *args = PetscGlobalArgs;
427e5c89e4eSSatish Balay   PetscFunctionReturn(0);
428e5c89e4eSSatish Balay }
429e5c89e4eSSatish Balay 
430e5c89e4eSSatish Balay #undef __FUNCT__
431793721a6SBarry Smith #define __FUNCT__ "PetscGetArguments"
432793721a6SBarry Smith /*@C
433793721a6SBarry Smith    PetscGetArguments - Allows you to access the  command line arguments anywhere
434793721a6SBarry Smith      after PetscInitialize() is called but before PetscFinalize().
435793721a6SBarry Smith 
436793721a6SBarry Smith    Not Collective
437793721a6SBarry Smith 
438793721a6SBarry Smith    Output Parameters:
439793721a6SBarry Smith .  args - the command line arguments
440793721a6SBarry Smith 
441793721a6SBarry Smith    Level: intermediate
442793721a6SBarry Smith 
443793721a6SBarry Smith    Notes:
444793721a6SBarry Smith       This does NOT start with the program name and IS null terminated (final arg is void)
445793721a6SBarry Smith 
446793721a6SBarry Smith    Concepts: command line arguments
447793721a6SBarry Smith 
448793721a6SBarry Smith .seealso: PetscFinalize(), PetscInitializeFortran(), PetscGetArgs(), PetscFreeArguments()
449793721a6SBarry Smith 
450793721a6SBarry Smith @*/
4517087cfbeSBarry Smith PetscErrorCode  PetscGetArguments(char ***args)
452793721a6SBarry Smith {
453793721a6SBarry Smith   PetscInt       i,argc = PetscGlobalArgc;
454793721a6SBarry Smith   PetscErrorCode ierr;
455793721a6SBarry Smith 
456793721a6SBarry Smith   PetscFunctionBegin;
45717186662SBarry Smith   if (!PetscInitializeCalled && PetscFinalizeCalled) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ORDER,"You must call after PetscInitialize() but before PetscFinalize()");
458717030eeSLisandro Dalcin   if (!argc) {*args = 0; PetscFunctionReturn(0);}
459793721a6SBarry Smith   ierr = PetscMalloc(argc*sizeof(char*),args);CHKERRQ(ierr);
460793721a6SBarry Smith   for (i=0; i<argc-1; i++) {
461793721a6SBarry Smith     ierr = PetscStrallocpy(PetscGlobalArgs[i+1],&(*args)[i]);CHKERRQ(ierr);
462793721a6SBarry Smith   }
463793721a6SBarry Smith   (*args)[argc-1] = 0;
464793721a6SBarry Smith   PetscFunctionReturn(0);
465793721a6SBarry Smith }
466793721a6SBarry Smith 
467793721a6SBarry Smith #undef __FUNCT__
468793721a6SBarry Smith #define __FUNCT__ "PetscFreeArguments"
469793721a6SBarry Smith /*@C
470793721a6SBarry Smith    PetscFreeArguments - Frees the memory obtained with PetscGetArguments()
471793721a6SBarry Smith 
472793721a6SBarry Smith    Not Collective
473793721a6SBarry Smith 
474793721a6SBarry Smith    Output Parameters:
475793721a6SBarry Smith .  args - the command line arguments
476793721a6SBarry Smith 
477793721a6SBarry Smith    Level: intermediate
478793721a6SBarry Smith 
479793721a6SBarry Smith    Concepts: command line arguments
480793721a6SBarry Smith 
481793721a6SBarry Smith .seealso: PetscFinalize(), PetscInitializeFortran(), PetscGetArgs(), PetscGetArguments()
482793721a6SBarry Smith 
483793721a6SBarry Smith @*/
4847087cfbeSBarry Smith PetscErrorCode  PetscFreeArguments(char **args)
485793721a6SBarry Smith {
486793721a6SBarry Smith   PetscInt       i = 0;
487793721a6SBarry Smith   PetscErrorCode ierr;
488793721a6SBarry Smith 
489793721a6SBarry Smith   PetscFunctionBegin;
490717030eeSLisandro Dalcin   if (!args) {PetscFunctionReturn(0);}
491793721a6SBarry Smith   while (args[i]) {
492793721a6SBarry Smith     ierr = PetscFree(args[i]);CHKERRQ(ierr);
493793721a6SBarry Smith     i++;
494793721a6SBarry Smith   }
495793721a6SBarry Smith   ierr = PetscFree(args);CHKERRQ(ierr);
496793721a6SBarry Smith   PetscFunctionReturn(0);
497793721a6SBarry Smith }
498793721a6SBarry Smith 
499793721a6SBarry Smith #undef __FUNCT__
500e5c89e4eSSatish Balay #define __FUNCT__ "PetscInitialize"
501e5c89e4eSSatish Balay /*@C
502e5c89e4eSSatish Balay    PetscInitialize - Initializes the PETSc database and MPI.
503e5c89e4eSSatish Balay    PetscInitialize() calls MPI_Init() if that has yet to be called,
504e5c89e4eSSatish Balay    so this routine should always be called near the beginning of
505e5c89e4eSSatish Balay    your program -- usually the very first line!
506e5c89e4eSSatish Balay 
507e5c89e4eSSatish Balay    Collective on MPI_COMM_WORLD or PETSC_COMM_WORLD if it has been set
508e5c89e4eSSatish Balay 
509e5c89e4eSSatish Balay    Input Parameters:
510e5c89e4eSSatish Balay +  argc - count of number of command line arguments
511e5c89e4eSSatish Balay .  args - the command line arguments
512fc2bca9aSBarry Smith .  file - [optional] PETSc database file, also checks ~username/.petscrc and .petscrc use PETSC_NULL to not check for
513fc2bca9aSBarry Smith           code specific file. Use -skip_petscrc in the code specific file to skip the .petscrc files
514e5c89e4eSSatish Balay -  help - [optional] Help message to print, use PETSC_NULL for no message
515e5c89e4eSSatish Balay 
51605827820SBarry Smith    If you wish PETSc code to run ONLY on a subcommunicator of MPI_COMM_WORLD, create that
51705827820SBarry Smith    communicator first and assign it to PETSC_COMM_WORLD BEFORE calling PetscInitialize(). Thus if you are running a
51805827820SBarry Smith    four process job and two processes will run PETSc and have PetscInitialize() and PetscFinalize() and two process will not,
51905827820SBarry Smith    then do this. If ALL processes in the job are using PetscInitialize() and PetscFinalize() then you don't need to do this, even
52005827820SBarry Smith    if different subcommunicators of the job are doing different things with PETSc.
521e5c89e4eSSatish Balay 
522e5c89e4eSSatish Balay    Options Database Keys:
523e5c89e4eSSatish Balay +  -start_in_debugger [noxterm,dbx,xdb,gdb,...] - Starts program in debugger
524e5c89e4eSSatish Balay .  -on_error_attach_debugger [noxterm,dbx,xdb,gdb,...] - Starts debugger when error detected
525e5c89e4eSSatish Balay .  -on_error_emacs <machinename> causes emacsclient to jump to error file
526b52f573bSBarry Smith .  -on_error_abort calls abort() when error detected (no traceback)
527e8fb0fc0SBarry Smith .  -on_error_mpiabort calls MPI_abort() when error detected
528e8fb0fc0SBarry Smith .  -error_output_stderr prints error messages to stderr instead of the default stdout
529e8fb0fc0SBarry Smith .  -error_output_none does not print the error messages (but handles errors in the same way as if this was not called)
530e5c89e4eSSatish Balay .  -debugger_nodes [node1,node2,...] - Indicates nodes to start in debugger
531e5c89e4eSSatish Balay .  -debugger_pause [sleeptime] (in seconds) - Pauses debugger
532e5c89e4eSSatish Balay .  -stop_for_debugger - Print message on how to attach debugger manually to
533e5c89e4eSSatish Balay                         process and wait (-debugger_pause) seconds for attachment
5342fb0ec9aSBarry Smith .  -malloc - Indicates use of PETSc error-checking malloc (on by default for debug version of libraries)
535e5c89e4eSSatish Balay .  -malloc no - Indicates not to use error-checking malloc
5362fb0ec9aSBarry Smith .  -malloc_debug - check for memory corruption at EVERY malloc or free
537e5c89e4eSSatish Balay .  -fp_trap - Stops on floating point exceptions (Note that on the
538e5c89e4eSSatish Balay               IBM RS6000 this slows code by at least a factor of 10.)
539e5c89e4eSSatish Balay .  -no_signal_handler - Indicates not to trap error signals
540e5c89e4eSSatish Balay .  -shared_tmp - indicates /tmp directory is shared by all processors
541e5c89e4eSSatish Balay .  -not_shared_tmp - each processor has own /tmp
542e5c89e4eSSatish Balay .  -tmp - alternative name of /tmp directory
543e5c89e4eSSatish Balay .  -get_total_flops - returns total flops done by all processors
544e5c89e4eSSatish Balay -  -memory_info - Print memory usage at end of run
545e5c89e4eSSatish Balay 
546e5c89e4eSSatish Balay    Options Database Keys for Profiling:
5470598bfebSBarry Smith    See the <a href="../../docs/manual.pdf#nameddest=ch_profiling">profiling chapter of the users manual</a> for details.
548e5c89e4eSSatish Balay +  -log_trace [filename] - Print traces of all PETSc calls
549e5c89e4eSSatish Balay         to the screen (useful to determine where a program
550e5c89e4eSSatish Balay         hangs without running in the debugger).  See PetscLogTraceBegin().
5516cf91177SBarry Smith .  -info <optional filename> - Prints verbose information to the screen
5526cf91177SBarry Smith -  -info_exclude <null,vec,mat,pc,ksp,snes,ts> - Excludes some of the verbose messages
553e5c89e4eSSatish Balay 
554e5c89e4eSSatish Balay    Environmental Variables:
555e5c89e4eSSatish Balay +   PETSC_TMP - alternative tmp directory
556e5c89e4eSSatish Balay .   PETSC_SHARED_TMP - tmp is shared by all processes
557e5c89e4eSSatish Balay .   PETSC_NOT_SHARED_TMP - each process has its own private tmp
558e5c89e4eSSatish Balay .   PETSC_VIEWER_SOCKET_PORT - socket number to use for socket viewer
559e5c89e4eSSatish Balay -   PETSC_VIEWER_SOCKET_MACHINE - machine to use for socket viewer to connect to
560e5c89e4eSSatish Balay 
561e5c89e4eSSatish Balay 
562e5c89e4eSSatish Balay    Level: beginner
563e5c89e4eSSatish Balay 
564e5c89e4eSSatish Balay    Notes:
565e5c89e4eSSatish Balay    If for some reason you must call MPI_Init() separately, call
566e5c89e4eSSatish Balay    it before PetscInitialize().
567e5c89e4eSSatish Balay 
568e5c89e4eSSatish Balay    Fortran Version:
569e5c89e4eSSatish Balay    In Fortran this routine has the format
570e5c89e4eSSatish Balay $       call PetscInitialize(file,ierr)
571e5c89e4eSSatish Balay 
572e5c89e4eSSatish Balay +   ierr - error return code
5733dae0d48SMatthew Knepley -  file - [optional] PETSc database file, also checks ~username/.petscrc and .petscrc use PETSC_NULL_CHARACTER to not check for
574fc2bca9aSBarry Smith           code specific file. Use -skip_petscrc in the code specific file to skip the .petscrc files
575e5c89e4eSSatish Balay 
576e5c89e4eSSatish Balay    Important Fortran Note:
577e5c89e4eSSatish Balay    In Fortran, you MUST use PETSC_NULL_CHARACTER to indicate a
578e5c89e4eSSatish Balay    null character string; you CANNOT just use PETSC_NULL as
5790598bfebSBarry Smith    in the C version. See the <a href="../../docs/manual.pdf">users manual</a> for details.
580e5c89e4eSSatish Balay 
58101cb0274SBarry Smith    If your main program is C but you call Fortran code that also uses PETSc you need to call PetscInitializeFortran() soon after
58201cb0274SBarry Smith    calling PetscInitialize().
583e5c89e4eSSatish Balay 
584e5c89e4eSSatish Balay    Concepts: initializing PETSc
585e5c89e4eSSatish Balay 
58601cb0274SBarry Smith .seealso: PetscFinalize(), PetscInitializeFortran(), PetscGetArgs(), PetscInitializeNoArguments()
587e5c89e4eSSatish Balay 
588e5c89e4eSSatish Balay @*/
5897087cfbeSBarry Smith PetscErrorCode  PetscInitialize(int *argc,char ***args,const char file[],const char help[])
590e5c89e4eSSatish Balay {
591e5c89e4eSSatish Balay   PetscErrorCode ierr;
592aa5bb8c0SSatish Balay   PetscMPIInt    flag, size;
593aa5bb8c0SSatish Balay   PetscInt       nodesize;
594ace3abfcSBarry Smith   PetscBool      flg;
595e5c89e4eSSatish Balay   char           hostname[256];
596e5c89e4eSSatish Balay 
597e5c89e4eSSatish Balay   PetscFunctionBegin;
598e5c89e4eSSatish Balay   if (PetscInitializeCalled) PetscFunctionReturn(0);
599e5c89e4eSSatish Balay 
600ae9b4142SLisandro Dalcin   /* these must be initialized in a routine, not as a constant declaration*/
601d89683f4Sbcordonn   PETSC_STDOUT = stdout;
602ae9b4142SLisandro Dalcin   PETSC_STDERR = stderr;
603e5c89e4eSSatish Balay 
604e5c89e4eSSatish Balay   ierr = PetscOptionsCreate();CHKERRQ(ierr);
605e5c89e4eSSatish Balay 
606e5c89e4eSSatish Balay   /*
607e5c89e4eSSatish Balay      We initialize the program name here (before MPI_Init()) because MPICH has a bug in
608e5c89e4eSSatish Balay      it that it sets args[0] on all processors to be args[0] on the first processor.
609e5c89e4eSSatish Balay   */
610e5c89e4eSSatish Balay   if (argc && *argc) {
611e5c89e4eSSatish Balay     ierr = PetscSetProgramName(**args);CHKERRQ(ierr);
612e5c89e4eSSatish Balay   } else {
613e5c89e4eSSatish Balay     ierr = PetscSetProgramName("Unknown Name");CHKERRQ(ierr);
614e5c89e4eSSatish Balay   }
615e5c89e4eSSatish Balay 
616e5c89e4eSSatish Balay   ierr = MPI_Initialized(&flag);CHKERRQ(ierr);
617e5c89e4eSSatish Balay   if (!flag) {
618e32f2f54SBarry 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");
619e5c89e4eSSatish Balay     ierr          = MPI_Init(argc,args);CHKERRQ(ierr);
620e5c89e4eSSatish Balay     PetscBeganMPI = PETSC_TRUE;
621e5c89e4eSSatish Balay   }
622e5c89e4eSSatish Balay   if (argc && args) {
623e5c89e4eSSatish Balay     PetscGlobalArgc = *argc;
624e5c89e4eSSatish Balay     PetscGlobalArgs = *args;
625e5c89e4eSSatish Balay   }
626e5c89e4eSSatish Balay   PetscFinalizeCalled   = PETSC_FALSE;
627e5c89e4eSSatish Balay 
628e8373e55SMatthew Knepley   if (PETSC_COMM_WORLD == MPI_COMM_NULL) {
629e5c89e4eSSatish Balay     PETSC_COMM_WORLD = MPI_COMM_WORLD;
630e5c89e4eSSatish Balay   }
631660746e0SBarry Smith   ierr = MPI_Errhandler_set(PETSC_COMM_WORLD,MPI_ERRORS_RETURN);CHKERRQ(ierr);
632e5c89e4eSSatish Balay 
633e5c89e4eSSatish Balay   /* Done after init due to a bug in MPICH-GM? */
634e5c89e4eSSatish Balay   ierr = PetscErrorPrintfInitialize();CHKERRQ(ierr);
635e5c89e4eSSatish Balay 
636e5c89e4eSSatish Balay   ierr = MPI_Comm_rank(MPI_COMM_WORLD,&PetscGlobalRank);CHKERRQ(ierr);
637e5c89e4eSSatish Balay   ierr = MPI_Comm_size(MPI_COMM_WORLD,&PetscGlobalSize);CHKERRQ(ierr);
638e5c89e4eSSatish Balay 
639e5c89e4eSSatish Balay #if defined(PETSC_USE_COMPLEX)
640e5c89e4eSSatish Balay   /*
641e5c89e4eSSatish Balay      Initialized the global complex variable; this is because with
642e5c89e4eSSatish Balay      shared libraries the constructors for global variables
643e5c89e4eSSatish Balay      are not called; at least on IRIX.
644e5c89e4eSSatish Balay   */
645e5c89e4eSSatish Balay   {
646762437b8SSatish Balay #if defined(PETSC_CLANGUAGE_CXX)
647e5c89e4eSSatish Balay     PetscScalar ic(0.0,1.0);
648e5c89e4eSSatish Balay     PETSC_i = ic;
649b7940d39SSatish Balay #else
6503433f298SSatish Balay     PETSC_i = I;
651b7940d39SSatish Balay #endif
652762437b8SSatish Balay   }
653762437b8SSatish Balay 
6542c876bd9SBarry Smith #if !defined(PETSC_HAVE_MPI_C_DOUBLE_COMPLEX)
6552c876bd9SBarry Smith   ierr = MPI_Type_contiguous(2,MPIU_REAL,&MPI_C_DOUBLE_COMPLEX);CHKERRQ(ierr);
6562c876bd9SBarry Smith   ierr = MPI_Type_commit(&MPI_C_DOUBLE_COMPLEX);CHKERRQ(ierr);
657a83b8d76SBarry Smith   ierr = MPI_Type_contiguous(2,MPI_FLOAT,&MPI_C_COMPLEX);CHKERRQ(ierr);
658a83b8d76SBarry Smith   ierr = MPI_Type_commit(&MPI_C_COMPLEX);CHKERRQ(ierr);
65906a205a8SBarry Smith   ierr = MPI_Op_create(PetscSum_Local,1,&MPIU_SUM);CHKERRQ(ierr);
660e5c89e4eSSatish Balay #endif
6612c876bd9SBarry Smith #endif
662e5c89e4eSSatish Balay 
663e5c89e4eSSatish Balay   /*
664e5c89e4eSSatish Balay      Create the PETSc MPI reduction operator that sums of the first
665e5c89e4eSSatish Balay      half of the entries and maxes the second half.
666e5c89e4eSSatish Balay   */
667e5c89e4eSSatish Balay   ierr = MPI_Op_create(PetscMaxSum_Local,1,&PetscMaxSum_Op);CHKERRQ(ierr);
668e5c89e4eSSatish Balay 
669*c90a1750SBarry Smith #if defined(PETSC_USE_SCALAR___FLOAT128)
670*c90a1750SBarry Smith   ierr = MPI_Type_contiguous(2,MPI_DOUBLE,&MPIU___FLOAT128);CHKERRQ(ierr);
671*c90a1750SBarry Smith   ierr = MPI_Type_commit(&MPIU___FLOAT128);CHKERRQ(ierr);
672*c90a1750SBarry Smith #endif
673*c90a1750SBarry Smith 
674e5c89e4eSSatish Balay   ierr = MPI_Type_contiguous(2,MPIU_SCALAR,&MPIU_2SCALAR);CHKERRQ(ierr);
675e5c89e4eSSatish Balay   ierr = MPI_Type_commit(&MPIU_2SCALAR);CHKERRQ(ierr);
676e5c89e4eSSatish Balay   ierr = MPI_Op_create(PetscADMax_Local,1,&PetscADMax_Op);CHKERRQ(ierr);
677e5c89e4eSSatish Balay   ierr = MPI_Op_create(PetscADMin_Local,1,&PetscADMin_Op);CHKERRQ(ierr);
678e5c89e4eSSatish Balay 
679e5c89e4eSSatish Balay   ierr = MPI_Type_contiguous(2,MPIU_INT,&MPIU_2INT);CHKERRQ(ierr);
680e5c89e4eSSatish Balay   ierr = MPI_Type_commit(&MPIU_2INT);CHKERRQ(ierr);
681e5c89e4eSSatish Balay 
682e5c89e4eSSatish Balay   /*
683480cf27aSJed Brown      Attributes to be set on PETSc communicators
684480cf27aSJed Brown   */
685480cf27aSJed Brown   ierr = MPI_Keyval_create(MPI_NULL_COPY_FN,Petsc_DelCounter,&Petsc_Counter_keyval,(void*)0);CHKERRQ(ierr);
686480cf27aSJed Brown   ierr = MPI_Keyval_create(MPI_NULL_COPY_FN,Petsc_DelComm,&Petsc_InnerComm_keyval,(void*)0);CHKERRQ(ierr);
687480cf27aSJed Brown   ierr = MPI_Keyval_create(MPI_NULL_COPY_FN,Petsc_DelComm,&Petsc_OuterComm_keyval,(void*)0);CHKERRQ(ierr);
688480cf27aSJed Brown 
689480cf27aSJed Brown   /*
690e8fb0fc0SBarry Smith      Build the options database
691e5c89e4eSSatish Balay   */
692e5c89e4eSSatish Balay   ierr = PetscOptionsInsert(argc,args,file);CHKERRQ(ierr);
693e5c89e4eSSatish Balay 
6946dc8fec2Sbcordonn 
695e5c89e4eSSatish Balay   /*
696e5c89e4eSSatish Balay      Print main application help message
697e5c89e4eSSatish Balay   */
698e5c89e4eSSatish Balay   ierr = PetscOptionsHasName(PETSC_NULL,"-help",&flg);CHKERRQ(ierr);
699e5c89e4eSSatish Balay   if (help && flg) {
700e5c89e4eSSatish Balay     ierr = PetscPrintf(PETSC_COMM_WORLD,help);CHKERRQ(ierr);
701e5c89e4eSSatish Balay   }
702e5c89e4eSSatish Balay   ierr = PetscOptionsCheckInitial_Private();CHKERRQ(ierr);
703e5c89e4eSSatish Balay 
704e5c89e4eSSatish Balay   /* SHOULD PUT IN GUARDS: Make sure logging is initialized, even if we do not print it out */
705a9f03627SSatish Balay #if defined(PETSC_USE_LOG)
706e5c89e4eSSatish Balay   ierr = PetscLogBegin_Private();CHKERRQ(ierr);
707a9f03627SSatish Balay #endif
708e5c89e4eSSatish Balay 
709e5c89e4eSSatish Balay   /*
710e5c89e4eSSatish Balay      Load the dynamic libraries (on machines that support them), this registers all
711e5c89e4eSSatish Balay      the solvers etc. (On non-dynamic machines this initializes the PetscDraw and PetscViewer classes)
712e5c89e4eSSatish Balay   */
713e5c89e4eSSatish Balay   ierr = PetscInitialize_DynamicLibraries();CHKERRQ(ierr);
714e5c89e4eSSatish Balay 
715e5c89e4eSSatish Balay   ierr = MPI_Comm_size(PETSC_COMM_WORLD,&size);CHKERRQ(ierr);
716ae15b995SBarry Smith   ierr = PetscInfo1(0,"PETSc successfully started: number of processors = %d\n",size);CHKERRQ(ierr);
717e5c89e4eSSatish Balay   ierr = PetscGetHostName(hostname,256);CHKERRQ(ierr);
718ae15b995SBarry Smith   ierr = PetscInfo1(0,"Running on machine: %s\n",hostname);CHKERRQ(ierr);
719e5c89e4eSSatish Balay 
720e5c89e4eSSatish Balay   ierr = PetscOptionsCheckInitial_Components();CHKERRQ(ierr);
721ef6c6fedSBoyana Norris   /* Check the options database for options related to the options database itself */
722ef6c6fedSBoyana Norris   ierr = PetscOptionsSetFromOptions();CHKERRQ(ierr);
723ef6c6fedSBoyana Norris 
724951e3c8eSBarry Smith #if defined(PETSC_USE_PETSC_MPI_EXTERNAL32)
725e39fd77fSBarry Smith   /*
726e39fd77fSBarry Smith       Tell MPI about our own data representation converter, this would/should be used if extern32 is not supported by the MPI
727e39fd77fSBarry Smith 
728e39fd77fSBarry Smith       Currently not used because it is not supported by MPICH.
729e39fd77fSBarry Smith   */
730e39fd77fSBarry Smith #if !defined(PETSC_WORDS_BIGENDIAN)
731708350f5SSatish Balay   ierr = MPI_Register_datarep((char *)"petsc",PetscDataRep_read_conv_fn,PetscDataRep_write_conv_fn,PetscDataRep_extent_fn,PETSC_NULL);CHKERRQ(ierr);
732e39fd77fSBarry Smith #endif
733951e3c8eSBarry Smith #endif
734e39fd77fSBarry Smith 
735793721a6SBarry Smith   ierr = PetscOptionsGetInt(PETSC_NULL,"-openmp_spawn_size",&nodesize,&flg);CHKERRQ(ierr);
736793721a6SBarry Smith   if (flg) {
73723464e94SBarry Smith #if defined(PETSC_HAVE_MPI_COMM_SPAWN)
7389505b675SBarry Smith     ierr = PetscOpenMPSpawn((PetscMPIInt) nodesize);CHKERRQ(ierr); /* worker nodes never return from here; they go directly to PetscEnd() */
73923464e94SBarry Smith #else
740e32f2f54SBarry Smith     SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SUP,"PETSc built without MPI 2 (MPI_Comm_spawn) support, use -openmp_merge_size instead");
74123464e94SBarry Smith #endif
742793721a6SBarry Smith   } else {
74323464e94SBarry Smith     ierr = PetscOptionsGetInt(PETSC_NULL,"-openmp_merge_size",&nodesize,&flg);CHKERRQ(ierr);
7448002f1cdSBarry Smith     if (flg) {
7459505b675SBarry Smith       ierr = PetscOpenMPMerge((PetscMPIInt) nodesize,PETSC_NULL,PETSC_NULL);CHKERRQ(ierr);
7469505b675SBarry Smith       if (PetscOpenMPWorker) { /* if worker then never enter user code */
7479505b675SBarry Smith         ierr = PetscEnd();
7489505b675SBarry Smith       }
7498002f1cdSBarry Smith     }
750793721a6SBarry Smith   }
751e5c89e4eSSatish Balay 
75235d88935SVictor Minden #if defined(PETSC_HAVE_CUDA)
7532f947c57SVictor Minden   cublasInit();
7543e39abd9SVictor Minden #endif
75592e62aa6SBarry Smith 
75692e62aa6SBarry Smith #if defined(PETSC_HAVE_AMS)
757c457296dSBarry Smith   ierr = PetscOptionsHasName(PETSC_NULL,"-ams_publish_objects",&flg);CHKERRQ(ierr);
75892e62aa6SBarry Smith   if (flg) {
75992e62aa6SBarry Smith     PetscAMSPublishAll = PETSC_TRUE;
76092e62aa6SBarry Smith   }
76192e62aa6SBarry Smith #endif
76292e62aa6SBarry Smith 
7639ac80d5eSLisandro Dalcin   ierr = PetscOptionsHasName(PETSC_NULL,"-python",&flg);CHKERRQ(ierr);
7649ac80d5eSLisandro Dalcin   if (flg) {
7659ac80d5eSLisandro Dalcin     PetscInitializeCalled = PETSC_TRUE;
7669ac80d5eSLisandro Dalcin     ierr = PetscPythonInitialize(PETSC_NULL,PETSC_NULL);CHKERRQ(ierr);
7679ac80d5eSLisandro Dalcin   }
7689ac80d5eSLisandro Dalcin 
769301d30feSBarry Smith   /*
770301d30feSBarry Smith       Once we are completedly initialized then we can set this variables
771301d30feSBarry Smith   */
772301d30feSBarry Smith   PetscInitializeCalled = PETSC_TRUE;
773301d30feSBarry Smith   PetscFunctionReturn(0);
774e5c89e4eSSatish Balay }
775e5c89e4eSSatish Balay 
7762eff7a51SBarry Smith extern PetscObject *PetscObjects;
7772eff7a51SBarry Smith extern PetscInt    PetscObjectsCounts, PetscObjectsMaxCounts;
778e5c89e4eSSatish Balay 
779e5c89e4eSSatish Balay #undef __FUNCT__
780e5c89e4eSSatish Balay #define __FUNCT__ "PetscFinalize"
781e5c89e4eSSatish Balay /*@C
782e5c89e4eSSatish Balay    PetscFinalize - Checks for options to be called at the conclusion
783e5c89e4eSSatish Balay    of the program. MPI_Finalize() is called only if the user had not
784e5c89e4eSSatish Balay    called MPI_Init() before calling PetscInitialize().
785e5c89e4eSSatish Balay 
786e5c89e4eSSatish Balay    Collective on PETSC_COMM_WORLD
787e5c89e4eSSatish Balay 
788e5c89e4eSSatish Balay    Options Database Keys:
78988c29154SBarry Smith +  -options_table - Calls PetscOptionsView()
790e5c89e4eSSatish Balay .  -options_left - Prints unused options that remain in the database
7910a1571b3SBarry Smith .  -objects_left  - Prints list of all objects that have not been freed
792e5c89e4eSSatish Balay .  -mpidump - Calls PetscMPIDump()
793e5c89e4eSSatish Balay .  -malloc_dump - Calls PetscMallocDump()
794e5c89e4eSSatish Balay .  -malloc_info - Prints total memory usage
795e5c89e4eSSatish Balay -  -malloc_log - Prints summary of memory usage
796e5c89e4eSSatish Balay 
797e5c89e4eSSatish Balay    Options Database Keys for Profiling:
7980598bfebSBarry Smith    See the <a href="../../docs/manual.pdf#nameddest=ch_profiling">profiling chapter of the users manual</a> for details.
799e5c89e4eSSatish Balay +  -log_summary [filename] - Prints summary of flop and timing
800e5c89e4eSSatish Balay         information to screen. If the filename is specified the
80191eabc43SBarry Smith         summary is written to the file.  See PetscLogView().
802ff5bc46bSBarry Smith .  -log_summary_python [filename] - Prints data on of flop and timing usage to a file or screen.
80391eabc43SBarry Smith         See PetscLogPrintSViewPython().
804e5c89e4eSSatish Balay .  -log_all [filename] - Logs extensive profiling information
805ff5bc46bSBarry Smith         See PetscLogDump().
806ff5bc46bSBarry Smith .  -log [filename] - Logs basic profiline information  See PetscLogDump().
807e5c89e4eSSatish Balay .  -log_sync - Log the synchronization in scatters, inner products
808e5c89e4eSSatish Balay         and norms
809e5c89e4eSSatish Balay -  -log_mpe [filename] - Creates a logfile viewable by the
810e5c89e4eSSatish Balay       utility Upshot/Nupshot (in MPICH distribution)
811e5c89e4eSSatish Balay 
812e5c89e4eSSatish Balay    Level: beginner
813e5c89e4eSSatish Balay 
814e5c89e4eSSatish Balay    Note:
815e5c89e4eSSatish Balay    See PetscInitialize() for more general runtime options.
816e5c89e4eSSatish Balay 
81788c29154SBarry Smith .seealso: PetscInitialize(), PetscOptionsView(), PetscMallocDump(), PetscMPIDump(), PetscEnd()
818e5c89e4eSSatish Balay @*/
8197087cfbeSBarry Smith PetscErrorCode  PetscFinalize(void)
820e5c89e4eSSatish Balay {
821e5c89e4eSSatish Balay   PetscErrorCode ierr;
822e5c89e4eSSatish Balay   PetscMPIInt    rank;
8232eff7a51SBarry Smith   PetscInt       i,nopt;
8240a1571b3SBarry Smith   PetscBool      flg1 = PETSC_FALSE,flg2 = PETSC_FALSE,flg3 = PETSC_FALSE,objects_left = PETSC_FALSE;
825d5649816SBarry Smith #if defined(PETSC_HAVE_AMS)
826ace3abfcSBarry Smith   PetscBool      flg = PETSC_FALSE;
827d5649816SBarry Smith #endif
82810463e74SBarry Smith #if defined(PETSC_USE_LOG)
82910463e74SBarry Smith   char           mname[PETSC_MAX_PATH_LEN];
83010463e74SBarry Smith #endif
831e5c89e4eSSatish Balay 
832e5c89e4eSSatish Balay   PetscFunctionBegin;
833e5c89e4eSSatish Balay 
834e5c89e4eSSatish Balay   if (!PetscInitializeCalled) {
8354b09e917SBarry Smith     printf("PetscInitialize() must be called before PetscFinalize()\n");
8364b09e917SBarry Smith     PetscFunctionReturn(PETSC_ERR_ARG_WRONGSTATE);
837e5c89e4eSSatish Balay   }
838b022a5c1SBarry Smith   ierr = PetscInfo(PETSC_NULL,"PetscFinalize() called\n");
839b022a5c1SBarry Smith 
840d5649816SBarry Smith #if defined(PETSC_HAVE_AMS)
841acfcf0e5SJed Brown   ierr = PetscOptionsGetBool(PETSC_NULL,"-options_gui",&flg,PETSC_NULL);CHKERRQ(ierr);
842d5649816SBarry Smith   if (flg) {
843d5649816SBarry Smith     ierr = PetscOptionsAMSDestroy();CHKERRQ(ierr);
844d5649816SBarry Smith   }
845d5649816SBarry Smith #endif
846d5649816SBarry Smith 
8478002f1cdSBarry Smith   ierr = PetscOpenMPFinalize();CHKERRQ(ierr);
8488002f1cdSBarry Smith 
849e5c89e4eSSatish Balay   ierr = MPI_Comm_rank(PETSC_COMM_WORLD,&rank);CHKERRQ(ierr);
850acfcf0e5SJed Brown   ierr = PetscOptionsGetBool(PETSC_NULL,"-malloc_info",&flg2,PETSC_NULL);CHKERRQ(ierr);
851e5c89e4eSSatish Balay   if (!flg2) {
85290d69ab7SBarry Smith     flg2 = PETSC_FALSE;
853acfcf0e5SJed Brown     ierr = PetscOptionsGetBool(PETSC_NULL,"-memory_info",&flg2,PETSC_NULL);CHKERRQ(ierr);
854e5c89e4eSSatish Balay   }
855e5c89e4eSSatish Balay   if (flg2) {
856e5c89e4eSSatish Balay     ierr = PetscMemoryShowUsage(PETSC_VIEWER_STDOUT_WORLD,"Summary of Memory Usage in PETSc\n");CHKERRQ(ierr);
857e5c89e4eSSatish Balay   }
858e5c89e4eSSatish Balay 
859e5c89e4eSSatish Balay #if defined(PETSC_USE_LOG)
86090d69ab7SBarry Smith   flg1 = PETSC_FALSE;
861acfcf0e5SJed Brown   ierr = PetscOptionsGetBool(PETSC_NULL,"-get_total_flops",&flg1,PETSC_NULL);CHKERRQ(ierr);
862e5c89e4eSSatish Balay   if (flg1) {
863e5c89e4eSSatish Balay     PetscLogDouble flops = 0;
864e5c89e4eSSatish Balay     ierr = MPI_Reduce(&_TotalFlops,&flops,1,MPI_DOUBLE,MPI_SUM,0,PETSC_COMM_WORLD);CHKERRQ(ierr);
865e5c89e4eSSatish Balay     ierr = PetscPrintf(PETSC_COMM_WORLD,"Total flops over all processors %g\n",flops);CHKERRQ(ierr);
866e5c89e4eSSatish Balay   }
867e5c89e4eSSatish Balay #endif
868e5c89e4eSSatish Balay 
869e5c89e4eSSatish Balay 
870e5c89e4eSSatish Balay #if defined(PETSC_USE_LOG)
871e5c89e4eSSatish Balay #if defined(PETSC_HAVE_MPE)
872e5c89e4eSSatish Balay   mname[0] = 0;
873e5c89e4eSSatish Balay   ierr = PetscOptionsGetString(PETSC_NULL,"-log_mpe",mname,PETSC_MAX_PATH_LEN,&flg1);CHKERRQ(ierr);
874e5c89e4eSSatish Balay   if (flg1){
875e5c89e4eSSatish Balay     if (mname[0]) {ierr = PetscLogMPEDump(mname);CHKERRQ(ierr);}
876e5c89e4eSSatish Balay     else          {ierr = PetscLogMPEDump(0);CHKERRQ(ierr);}
877e5c89e4eSSatish Balay   }
878e5c89e4eSSatish Balay #endif
879e5c89e4eSSatish Balay   mname[0] = 0;
880e5c89e4eSSatish Balay   ierr = PetscOptionsGetString(PETSC_NULL,"-log_summary",mname,PETSC_MAX_PATH_LEN,&flg1);CHKERRQ(ierr);
881e5c89e4eSSatish Balay   if (flg1) {
88291eabc43SBarry Smith     PetscViewer viewer;
88391eabc43SBarry Smith     if (mname[0])  {
88491eabc43SBarry Smith       ierr = PetscViewerASCIIOpen(PETSC_COMM_WORLD,mname,&viewer);CHKERRQ(ierr);
88591eabc43SBarry Smith       ierr = PetscLogView(viewer);CHKERRQ(ierr);
88691eabc43SBarry Smith       ierr = PetscViewerDestroy(viewer);CHKERRQ(ierr);
88733f85c2fSBarry Smith     } else {
88833f85c2fSBarry Smith       viewer = PETSC_VIEWER_STDOUT_WORLD;
88933f85c2fSBarry Smith       ierr = PetscLogView(viewer);CHKERRQ(ierr);
89033f85c2fSBarry Smith     }
891e5c89e4eSSatish Balay   }
892e5c89e4eSSatish Balay 
893ff5bc46bSBarry Smith   mname[0] = 0;
894ff5bc46bSBarry Smith   ierr = PetscOptionsGetString(PETSC_NULL,"-log_summary_python",mname,PETSC_MAX_PATH_LEN,&flg1);CHKERRQ(ierr);
895ff5bc46bSBarry Smith   if (flg1) {
896ff5bc46bSBarry Smith     PetscViewer viewer;
897ff5bc46bSBarry Smith     if (mname[0])  {
898ff5bc46bSBarry Smith       ierr = PetscViewerASCIIOpen(PETSC_COMM_WORLD,mname,&viewer);CHKERRQ(ierr);
89991eabc43SBarry Smith       ierr = PetscLogViewPython(viewer);CHKERRQ(ierr);
900ff5bc46bSBarry Smith       ierr = PetscViewerDestroy(viewer);CHKERRQ(ierr);
90133f85c2fSBarry Smith     } else {
90233f85c2fSBarry Smith       viewer = PETSC_VIEWER_STDOUT_WORLD;
90333f85c2fSBarry Smith       ierr = PetscLogViewPython(viewer);CHKERRQ(ierr);
90433f85c2fSBarry Smith     }
905ff5bc46bSBarry Smith   }
906ff5bc46bSBarry Smith 
90778392ef1SBarry Smith   ierr = PetscOptionsGetString(PETSC_NULL,"-log_detailed",mname,PETSC_MAX_PATH_LEN,&flg1);CHKERRQ(ierr);
90878392ef1SBarry Smith   if (flg1) {
90978392ef1SBarry Smith     if (mname[0])  {ierr = PetscLogPrintDetailed(PETSC_COMM_WORLD,mname);CHKERRQ(ierr);}
91078392ef1SBarry Smith     else           {ierr = PetscLogPrintDetailed(PETSC_COMM_WORLD,0);CHKERRQ(ierr);}
91178392ef1SBarry Smith   }
91278392ef1SBarry Smith 
913e5c89e4eSSatish Balay   mname[0] = 0;
914e5c89e4eSSatish Balay   ierr = PetscOptionsGetString(PETSC_NULL,"-log_all",mname,PETSC_MAX_PATH_LEN,&flg1);CHKERRQ(ierr);
915e5c89e4eSSatish Balay   ierr = PetscOptionsGetString(PETSC_NULL,"-log",mname,PETSC_MAX_PATH_LEN,&flg2);CHKERRQ(ierr);
916e5c89e4eSSatish Balay   if (flg1 || flg2){
917e5c89e4eSSatish Balay     if (mname[0]) PetscLogDump(mname);
918e5c89e4eSSatish Balay     else          PetscLogDump(0);
919e5c89e4eSSatish Balay   }
920e5c89e4eSSatish Balay #endif
92110463e74SBarry Smith 
92233f85c2fSBarry Smith #if defined(PETSC_USE_DEBUG) && !defined(PETSC_USE_PTHREAD)
92333f85c2fSBarry Smith   if (PetscStackActive) {
92433f85c2fSBarry Smith     ierr = PetscStackDestroy();CHKERRQ(ierr);
92533f85c2fSBarry Smith   }
92633f85c2fSBarry Smith #endif
92710463e74SBarry Smith 
92890d69ab7SBarry Smith   flg1 = PETSC_FALSE;
929acfcf0e5SJed Brown   ierr = PetscOptionsGetBool(PETSC_NULL,"-no_signal_handler",&flg1,PETSC_NULL);CHKERRQ(ierr);
930e5c89e4eSSatish Balay   if (!flg1) { ierr = PetscPopSignalHandler();CHKERRQ(ierr);}
93190d69ab7SBarry Smith   flg1 = PETSC_FALSE;
932acfcf0e5SJed Brown   ierr = PetscOptionsGetBool(PETSC_NULL,"-mpidump",&flg1,PETSC_NULL);CHKERRQ(ierr);
933e5c89e4eSSatish Balay   if (flg1) {
934e5c89e4eSSatish Balay     ierr = PetscMPIDump(stdout);CHKERRQ(ierr);
935e5c89e4eSSatish Balay   }
93690d69ab7SBarry Smith   flg1 = PETSC_FALSE;
93790d69ab7SBarry Smith   flg2 = PETSC_FALSE;
9388bb29257SSatish Balay   /* preemptive call to avoid listing this option in options table as unused */
9398bb29257SSatish Balay   ierr = PetscOptionsHasName(PETSC_NULL,"-malloc_dump",&flg1);CHKERRQ(ierr);
940acfcf0e5SJed Brown   ierr = PetscOptionsGetBool(PETSC_NULL,"-options_table",&flg2,PETSC_NULL);CHKERRQ(ierr);
941e4c476e2SSatish Balay 
942e5c89e4eSSatish Balay   if (flg2) {
94388c29154SBarry Smith     if (!rank) {ierr = PetscOptionsView(PETSC_NULL);CHKERRQ(ierr);}
944e5c89e4eSSatish Balay   }
945e5c89e4eSSatish Balay 
946e5c89e4eSSatish Balay   /* to prevent PETSc -options_left from warning */
947cb9801acSJed Brown   ierr = PetscOptionsHasName(PETSC_NULL,"-nox",&flg1);CHKERRQ(ierr);
948cb9801acSJed Brown   ierr = PetscOptionsHasName(PETSC_NULL,"-nox_warning",&flg1);CHKERRQ(ierr);
9490a1571b3SBarry Smith   ierr = PetscOptionsGetBool(PETSC_NULL,"-objects_left",&objects_left,PETSC_NULL);CHKERRQ(ierr);
950e5c89e4eSSatish Balay 
951f43cc0c9SSatish Balay   if (!PetscOpenMPWorker) { /* worker processes skip this because they do not usually process options */
95233fc4174SSatish Balay     flg3 = PETSC_FALSE; /* default value is required */
953acfcf0e5SJed Brown     ierr = PetscOptionsGetBool(PETSC_NULL,"-options_left",&flg3,&flg1);CHKERRQ(ierr);
954e5c89e4eSSatish Balay     ierr = PetscOptionsAllUsed(&nopt);CHKERRQ(ierr);
955e5c89e4eSSatish Balay     if (flg3) {
956e5c89e4eSSatish Balay       if (!flg2) { /* have not yet printed the options */
95733f85c2fSBarry Smith 	ierr = PetscOptionsView(PETSC_VIEWER_STDOUT_WORLD);CHKERRQ(ierr);
958e5c89e4eSSatish Balay       }
959e5c89e4eSSatish Balay       if (!nopt) {
960e5c89e4eSSatish Balay 	ierr = PetscPrintf(PETSC_COMM_WORLD,"There are no unused options.\n");CHKERRQ(ierr);
961e5c89e4eSSatish Balay       } else if (nopt == 1) {
962e5c89e4eSSatish Balay 	ierr = PetscPrintf(PETSC_COMM_WORLD,"There is one unused database option. It is:\n");CHKERRQ(ierr);
963e5c89e4eSSatish Balay       } else {
964e5c89e4eSSatish Balay 	ierr = PetscPrintf(PETSC_COMM_WORLD,"There are %d unused database options. They are:\n",nopt);CHKERRQ(ierr);
965e5c89e4eSSatish Balay       }
966e5c89e4eSSatish Balay     }
967e5c89e4eSSatish Balay #if defined(PETSC_USE_DEBUG)
968da8b8a77SBarry Smith     if (nopt && !flg3 && !flg1) {
969e5c89e4eSSatish Balay       ierr = PetscPrintf(PETSC_COMM_WORLD,"WARNING! There are options you set that were not used!\n");CHKERRQ(ierr);
970e5c89e4eSSatish Balay       ierr = PetscPrintf(PETSC_COMM_WORLD,"WARNING! could be spelling mistake, etc!\n");CHKERRQ(ierr);
971e5c89e4eSSatish Balay       ierr = PetscOptionsLeft();CHKERRQ(ierr);
972e5c89e4eSSatish Balay     } else if (nopt && flg3) {
973e5c89e4eSSatish Balay #else
974e5c89e4eSSatish Balay     if (nopt && flg3) {
975e5c89e4eSSatish Balay #endif
976e5c89e4eSSatish Balay       ierr = PetscOptionsLeft();CHKERRQ(ierr);
977e5c89e4eSSatish Balay     }
978931f367cSBarry Smith   }
979e5c89e4eSSatish Balay 
98010463e74SBarry Smith   /*
98133f85c2fSBarry Smith      Free all objects registered with PetscObjectRegisterDestroy() such as PETSC_VIEWER_XXX_().
98233f85c2fSBarry Smith   */
98333f85c2fSBarry Smith   ierr = PetscObjectRegisterDestroyAll();CHKERRQ(ierr);
98433f85c2fSBarry Smith 
9852eff7a51SBarry Smith   /*
986dbc8283eSBarry Smith        List all objects the user may have forgot to free
9872eff7a51SBarry Smith   */
9880a1571b3SBarry Smith   if (objects_left && PetscObjectsCounts) {
989dbc8283eSBarry Smith     ierr = PetscPrintf(PETSC_COMM_WORLD,"The following objects %D were never freed\n",PetscObjectsCounts);
9900a1571b3SBarry Smith   }
9912eff7a51SBarry Smith   for (i=0; i<PetscObjectsMaxCounts; i++) {
9922eff7a51SBarry Smith     if (PetscObjects[i]) {
9930a1571b3SBarry Smith       if (objects_left) {
9940a1571b3SBarry Smith         ierr = PetscPrintf(PETSC_COMM_WORLD,"  %s %s %s\n",PetscObjects[i]->class_name,PetscObjects[i]->type_name,PetscObjects[i]->name);CHKERRQ(ierr);
9950a1571b3SBarry Smith       }
9962eff7a51SBarry Smith     }
9972eff7a51SBarry Smith   }
998dbc8283eSBarry Smith   /* cannot actually destroy the left over objects, but destroy the list */
999dbc8283eSBarry Smith   PetscObjectsCounts    = 0;
1000dbc8283eSBarry Smith   PetscObjectsMaxCounts = 0;
1001dbc8283eSBarry Smith   ierr = PetscFree(PetscObjects);CHKERRQ(ierr);
10022eff7a51SBarry Smith 
10032eff7a51SBarry Smith 
100433f85c2fSBarry Smith #if defined(PETSC_USE_LOG)
100533f85c2fSBarry Smith   ierr = PetscLogDestroy();CHKERRQ(ierr);
100633f85c2fSBarry Smith #endif
100733f85c2fSBarry Smith 
100833f85c2fSBarry Smith   /*
100933f85c2fSBarry Smith        Free all the registered create functions, such as KSPList, VecList, SNESList, etc
101033f85c2fSBarry Smith   */
101133f85c2fSBarry Smith   ierr = PetscFListDestroyAll();CHKERRQ(ierr);
101233f85c2fSBarry Smith 
101333f85c2fSBarry Smith   /*
101433f85c2fSBarry Smith      Destroy any packages that registered a finalize
101533f85c2fSBarry Smith   */
101633f85c2fSBarry Smith   ierr = PetscRegisterFinalizeAll();CHKERRQ(ierr);
101733f85c2fSBarry Smith 
101833f85c2fSBarry Smith   /*
101910463e74SBarry Smith      Destroy all the function registration lists created
102010463e74SBarry Smith   */
102110463e74SBarry Smith   ierr = PetscFinalize_DynamicLibraries();CHKERRQ(ierr);
102210463e74SBarry Smith 
10234028d114SSatish Balay   if (petsc_history) {
1024f3dea69dSBarry Smith     ierr = PetscCloseHistoryFile(&petsc_history);CHKERRQ(ierr);
1025e5c89e4eSSatish Balay     petsc_history = 0;
1026e5c89e4eSSatish Balay   }
1027e5c89e4eSSatish Balay 
10286cf91177SBarry Smith   ierr = PetscInfoAllow(PETSC_FALSE,PETSC_NULL);CHKERRQ(ierr);
1029e5c89e4eSSatish Balay 
10308bb29257SSatish Balay   {
1031e5c89e4eSSatish Balay     char fname[PETSC_MAX_PATH_LEN];
1032e5c89e4eSSatish Balay     FILE *fd;
1033ed9cf6e9SBarry Smith     int  err;
1034e5c89e4eSSatish Balay 
1035e5c89e4eSSatish Balay     fname[0] = 0;
1036e5c89e4eSSatish Balay     ierr = PetscOptionsGetString(PETSC_NULL,"-malloc_dump",fname,250,&flg1);CHKERRQ(ierr);
1037e5c89e4eSSatish Balay     if (flg1 && fname[0]) {
1038e5c89e4eSSatish Balay       char sname[PETSC_MAX_PATH_LEN];
1039e5c89e4eSSatish Balay 
1040e5c89e4eSSatish Balay       sprintf(sname,"%s_%d",fname,rank);
1041e32f2f54SBarry Smith       fd   = fopen(sname,"w"); if (!fd) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_FILE_OPEN,"Cannot open log file: %s",sname);
1042e5c89e4eSSatish Balay       ierr = PetscMallocDump(fd);CHKERRQ(ierr);
1043ed9cf6e9SBarry Smith       err = fclose(fd);
1044e32f2f54SBarry Smith       if (err) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SYS,"fclose() failed on file");
10458bb29257SSatish Balay     } else if (flg1) {
1046e5c89e4eSSatish Balay       MPI_Comm local_comm;
1047e5c89e4eSSatish Balay 
1048e5c89e4eSSatish Balay       ierr = MPI_Comm_dup(MPI_COMM_WORLD,&local_comm);CHKERRQ(ierr);
1049e5c89e4eSSatish Balay       ierr = PetscSequentialPhaseBegin_Private(local_comm,1);CHKERRQ(ierr);
1050e5c89e4eSSatish Balay         ierr = PetscMallocDump(stdout);CHKERRQ(ierr);
1051e5c89e4eSSatish Balay       ierr = PetscSequentialPhaseEnd_Private(local_comm,1);CHKERRQ(ierr);
1052e5c89e4eSSatish Balay       ierr = MPI_Comm_free(&local_comm);CHKERRQ(ierr);
1053e5c89e4eSSatish Balay     }
1054e5c89e4eSSatish Balay   }
10558bb29257SSatish Balay   {
1056e5c89e4eSSatish Balay     char fname[PETSC_MAX_PATH_LEN];
1057e5c89e4eSSatish Balay     FILE *fd;
1058e5c89e4eSSatish Balay 
1059e5c89e4eSSatish Balay     fname[0] = 0;
1060e5c89e4eSSatish Balay     ierr = PetscOptionsGetString(PETSC_NULL,"-malloc_log",fname,250,&flg1);CHKERRQ(ierr);
1061e5c89e4eSSatish Balay     if (flg1 && fname[0]) {
1062e5c89e4eSSatish Balay       char sname[PETSC_MAX_PATH_LEN];
1063ed9cf6e9SBarry Smith       int  err;
1064e5c89e4eSSatish Balay 
1065e5c89e4eSSatish Balay       sprintf(sname,"%s_%d",fname,rank);
1066e32f2f54SBarry Smith       fd   = fopen(sname,"w"); if (!fd) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_FILE_OPEN,"Cannot open log file: %s",sname);
1067e5c89e4eSSatish Balay       ierr = PetscMallocDumpLog(fd);CHKERRQ(ierr);
1068ed9cf6e9SBarry Smith       err = fclose(fd);
1069e32f2f54SBarry Smith       if (err) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SYS,"fclose() failed on file");
10708bb29257SSatish Balay     } else if (flg1) {
1071e5c89e4eSSatish Balay       ierr = PetscMallocDumpLog(stdout);CHKERRQ(ierr);
1072e5c89e4eSSatish Balay     }
1073e5c89e4eSSatish Balay   }
1074e5c89e4eSSatish Balay   /* Can be destroyed only after all the options are used */
1075e5c89e4eSSatish Balay   ierr = PetscOptionsDestroy();CHKERRQ(ierr);
1076e5c89e4eSSatish Balay 
1077e5c89e4eSSatish Balay   PetscGlobalArgc = 0;
1078e5c89e4eSSatish Balay   PetscGlobalArgs = 0;
1079e5c89e4eSSatish Balay 
1080*c90a1750SBarry Smith #if defined(PETSC_USE_SCALAR___FLOAT128)
1081*c90a1750SBarry Smith   ierr = MPI_Type_free(&MPIU___FLOAT128);CHKERRQ(ierr);
1082*c90a1750SBarry Smith #endif
1083*c90a1750SBarry Smith 
1084e5c89e4eSSatish Balay #if defined(PETSC_USE_COMPLEX)
10852c876bd9SBarry Smith #if !defined(PETSC_HAVE_MPI_C_DOUBLE_COMPLEX)
108606a205a8SBarry Smith   ierr = MPI_Op_free(&MPIU_SUM);CHKERRQ(ierr);
10872c876bd9SBarry Smith   ierr = MPI_Type_free(&MPI_C_DOUBLE_COMPLEX);CHKERRQ(ierr);
1088a83b8d76SBarry Smith   ierr = MPI_Type_free(&MPI_C_COMPLEX);CHKERRQ(ierr);
10892c876bd9SBarry Smith #endif
1090e5c89e4eSSatish Balay #endif
1091e5c89e4eSSatish Balay   ierr = MPI_Type_free(&MPIU_2SCALAR);CHKERRQ(ierr);
1092e5c89e4eSSatish Balay   ierr = MPI_Type_free(&MPIU_2INT);CHKERRQ(ierr);
1093e5c89e4eSSatish Balay   ierr = MPI_Op_free(&PetscMaxSum_Op);CHKERRQ(ierr);
1094e5c89e4eSSatish Balay   ierr = MPI_Op_free(&PetscADMax_Op);CHKERRQ(ierr);
1095e5c89e4eSSatish Balay   ierr = MPI_Op_free(&PetscADMin_Op);CHKERRQ(ierr);
1096e5c89e4eSSatish Balay 
1097dbc8283eSBarry Smith   /*
1098dbc8283eSBarry Smith      Destroy any known inner communicators and attributes pointing to them
1099dbc8283eSBarry Smith      Note this will not destroy any new communicators the user has created
1100dbc8283eSBarry Smith  */
1101b770b1f6SSatish Balay   {
1102dbc8283eSBarry Smith     PetscCommCounter *counter;
1103dbc8283eSBarry Smith     PetscMPIInt      flg;
1104dbc8283eSBarry Smith     MPI_Comm         icomm;
1105dbc8283eSBarry Smith     void             *ptr;
1106dbc8283eSBarry Smith     ierr  = MPI_Attr_get(PETSC_COMM_SELF,Petsc_InnerComm_keyval,&ptr,&flg);CHKERRQ(ierr);
1107dbc8283eSBarry Smith     if (flg) {
1108dbc8283eSBarry Smith       /*  Use PetscMemcpy() because casting from pointer to integer of different size is not allowed with some compilers  */
1109dbc8283eSBarry Smith       ierr = PetscMemcpy(&icomm,&ptr,sizeof(MPI_Comm));CHKERRQ(ierr);
1110dbc8283eSBarry Smith       ierr = MPI_Attr_get(icomm,Petsc_Counter_keyval,&counter,&flg);CHKERRQ(ierr);
1111dbc8283eSBarry 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");
1112dbc8283eSBarry Smith 
1113dbc8283eSBarry Smith       ierr = MPI_Attr_delete(icomm,Petsc_Counter_keyval);CHKERRQ(ierr);
1114dbc8283eSBarry Smith       ierr = MPI_Attr_delete(icomm,Petsc_OuterComm_keyval);CHKERRQ(ierr);
1115dbc8283eSBarry Smith       ierr = MPI_Comm_free(&icomm);CHKERRQ(ierr);
1116dbc8283eSBarry Smith       ierr = MPI_Attr_delete(PETSC_COMM_SELF,Petsc_InnerComm_keyval);CHKERRQ(ierr);
1117dbc8283eSBarry Smith     }
1118dbc8283eSBarry Smith     ierr  = MPI_Attr_get(PETSC_COMM_WORLD,Petsc_InnerComm_keyval,&ptr,&flg);CHKERRQ(ierr);
1119dbc8283eSBarry Smith     if (flg) {
1120dbc8283eSBarry Smith       /*  Use PetscMemcpy() because casting from pointer to integer of different size is not allowed with some compilers  */
1121dbc8283eSBarry Smith       ierr = PetscMemcpy(&icomm,&ptr,sizeof(MPI_Comm));CHKERRQ(ierr);
1122dbc8283eSBarry Smith       ierr = MPI_Attr_get(icomm,Petsc_Counter_keyval,&counter,&flg);CHKERRQ(ierr);
1123dbc8283eSBarry 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");
1124dbc8283eSBarry Smith 
1125dbc8283eSBarry Smith       ierr = MPI_Attr_delete(icomm,Petsc_Counter_keyval);CHKERRQ(ierr);
1126dbc8283eSBarry Smith       ierr = MPI_Attr_delete(icomm,Petsc_OuterComm_keyval);CHKERRQ(ierr);
1127dbc8283eSBarry Smith       ierr = MPI_Comm_free(&icomm);CHKERRQ(ierr);
1128dbc8283eSBarry Smith       ierr = MPI_Attr_delete(PETSC_COMM_WORLD,Petsc_InnerComm_keyval);CHKERRQ(ierr);
1129dbc8283eSBarry Smith     }
1130b770b1f6SSatish Balay   }
1131dbc8283eSBarry Smith 
1132480cf27aSJed Brown   ierr = MPI_Keyval_free(&Petsc_Counter_keyval);CHKERRQ(ierr);
1133480cf27aSJed Brown   ierr = MPI_Keyval_free(&Petsc_InnerComm_keyval);CHKERRQ(ierr);
1134480cf27aSJed Brown   ierr = MPI_Keyval_free(&Petsc_OuterComm_keyval);CHKERRQ(ierr);
1135480cf27aSJed Brown 
1136ae15b995SBarry Smith   ierr = PetscInfo(0,"PETSc successfully ended!\n");CHKERRQ(ierr);
1137e5c89e4eSSatish Balay   if (PetscBeganMPI) {
113899608316SBarry Smith #if defined(PETSC_HAVE_MPI_FINALIZED)
113999b1327fSBarry Smith     PetscMPIInt flag;
114099b1327fSBarry Smith     ierr = MPI_Finalized(&flag);CHKERRQ(ierr);
1141e32f2f54SBarry Smith     if (flag) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_LIB,"MPI_Finalize() has already been called, even though MPI_Init() was called by PetscInitialize()");
114299608316SBarry Smith #endif
1143e5c89e4eSSatish Balay     ierr = MPI_Finalize();CHKERRQ(ierr);
1144e5c89e4eSSatish Balay   }
1145e5c89e4eSSatish Balay 
11469c4c166aSBarry Smith   if (PETSC_ZOPEFD){
114722b84c2fSbcordonn     if (PETSC_ZOPEFD != PETSC_STDOUT) fprintf(PETSC_ZOPEFD, "<<<end>>>");
11489c4c166aSBarry Smith     else fprintf(PETSC_STDOUT, "<<<end>>>");
11499c4c166aSBarry Smith   }
115036186564Sbcordonn 
115135d88935SVictor Minden #if defined(PETSC_HAVE_CUDA)
11522f947c57SVictor Minden   cublasShutdown();
1153440a5bbfSVictor Minden #endif
1154e5c89e4eSSatish Balay /*
1155e5c89e4eSSatish Balay 
1156e5c89e4eSSatish Balay      Note: In certain cases PETSC_COMM_WORLD is never MPI_Comm_free()ed because
1157e5c89e4eSSatish Balay    the communicator has some outstanding requests on it. Specifically if the
1158e5c89e4eSSatish Balay    flag PETSC_HAVE_BROKEN_REQUEST_FREE is set (for IBM MPI implementation). See
1159e5c89e4eSSatish Balay    src/vec/utils/vpscat.c. Due to this the memory allocated in PetscCommDuplicate()
1160e5c89e4eSSatish Balay    is never freed as it should be. Thus one may obtain messages of the form
11610e5e90baSSatish Balay    [ 1] 8 bytes PetscCommDuplicate() line 645 in src/sys/mpiu.c indicating the
1162e5c89e4eSSatish Balay    memory was not freed.
1163e5c89e4eSSatish Balay 
1164e5c89e4eSSatish Balay */
11651d1a0024SBarry Smith   ierr = PetscMallocClear();CHKERRQ(ierr);
1166e5c89e4eSSatish Balay   PetscInitializeCalled = PETSC_FALSE;
1167e5c89e4eSSatish Balay   PetscFinalizeCalled   = PETSC_TRUE;
1168e5c89e4eSSatish Balay   PetscFunctionReturn(ierr);
1169e5c89e4eSSatish Balay }
1170e5c89e4eSSatish Balay 
1171