xref: /petsc/src/sys/objects/pinit.c (revision fc087633cc6752a849b99017f1e2f5f28a8baece)
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;
1651dcc849SKerry Stevens extern PetscBool  PetscUseThreadPool;
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 **);
2751d315f7SKerry Stevens extern PetscErrorCode (*PetscThreadFinalize)(void);
28e5c89e4eSSatish Balay 
29e5c89e4eSSatish Balay /* this is used by the _, __, and ___ macros (see include/petscerror.h) */
30e5c89e4eSSatish Balay PetscErrorCode __gierr = 0;
31e5c89e4eSSatish Balay 
32e5c89e4eSSatish Balay /* user may set this BEFORE calling PetscInitialize() */
33e8373e55SMatthew Knepley MPI_Comm PETSC_COMM_WORLD = MPI_COMM_NULL;
34e5c89e4eSSatish Balay 
35480cf27aSJed Brown PetscMPIInt Petsc_Counter_keyval   = MPI_KEYVAL_INVALID;
36480cf27aSJed Brown PetscMPIInt Petsc_InnerComm_keyval = MPI_KEYVAL_INVALID;
37480cf27aSJed Brown PetscMPIInt Petsc_OuterComm_keyval = MPI_KEYVAL_INVALID;
38480cf27aSJed Brown 
39e5c89e4eSSatish Balay /*
40e5c89e4eSSatish Balay      Declare and set all the string names of the PETSc enums
41e5c89e4eSSatish Balay */
42ace3abfcSBarry Smith const char *PetscBools[]     = {"FALSE","TRUE","PetscBool","PETSC_",0};
4370b3c8c7SBarry Smith const char *PetscCopyModes[] = {"COPY_VALUES","OWN_POINTER","USE_POINTER","PetscCopyMode","PETSC_",0};
4470b3c8c7SBarry Smith const char *PetscDataTypes[] = {"INT","DOUBLE","COMPLEX","LONG","SHORT","FLOAT",
45ace3abfcSBarry Smith                                 "CHAR","LOGICAL","ENUM","BOOL","LONGDOUBLE","PetscDataType","PETSC_",0};
46e5c89e4eSSatish Balay 
47ace3abfcSBarry Smith PetscBool  PetscPreLoadingUsed = PETSC_FALSE;
48ace3abfcSBarry Smith PetscBool  PetscPreLoadingOn   = PETSC_FALSE;
490f8e0872SSatish Balay 
50e5c89e4eSSatish Balay /*
51e5c89e4eSSatish Balay        Checks the options database for initializations related to the
52e5c89e4eSSatish Balay     PETSc components
53e5c89e4eSSatish Balay */
54e5c89e4eSSatish Balay #undef __FUNCT__
55e5c89e4eSSatish Balay #define __FUNCT__ "PetscOptionsCheckInitial_Components"
567087cfbeSBarry Smith PetscErrorCode  PetscOptionsCheckInitial_Components(void)
57e5c89e4eSSatish Balay {
58ace3abfcSBarry Smith   PetscBool  flg1;
59e5c89e4eSSatish Balay   PetscErrorCode ierr;
60e5c89e4eSSatish Balay 
61e5c89e4eSSatish Balay   PetscFunctionBegin;
62e5c89e4eSSatish Balay   ierr = PetscOptionsHasName(PETSC_NULL,"-help",&flg1);CHKERRQ(ierr);
63e5c89e4eSSatish Balay   if (flg1) {
64e5c89e4eSSatish Balay #if defined (PETSC_USE_LOG)
65e8e7597cSSatish Balay     MPI_Comm   comm = PETSC_COMM_WORLD;
66e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm,"------Additional PETSc component options--------\n");CHKERRQ(ierr);
67e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm," -log_summary_exclude: <vec,mat,pc.ksp,snes>\n");CHKERRQ(ierr);
686cf91177SBarry Smith     ierr = (*PetscHelpPrintf)(comm," -info_exclude: <null,vec,mat,pc,ksp,snes,ts>\n");CHKERRQ(ierr);
69e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm,"-----------------------------------------------\n");CHKERRQ(ierr);
70e5c89e4eSSatish Balay #endif
71e5c89e4eSSatish Balay   }
72e5c89e4eSSatish Balay   PetscFunctionReturn(0);
73e5c89e4eSSatish Balay }
74e5c89e4eSSatish Balay 
750f11a792SBarry Smith #if defined(PETSC_HAVE_MATLAB_ENGINE)
76df413903SBarry Smith extern PetscBool PetscBeganMPI;
77df413903SBarry Smith 
78e5c89e4eSSatish Balay #undef __FUNCT__
790f11a792SBarry Smith #define __FUNCT__ "PetscInitializeMatlab"
800f11a792SBarry Smith /*
810f11a792SBarry Smith       PetscInitializeMatlab - Calls PetscInitialize() from C/C++ without the pointers to argc and args
8272a42c3cSBarry Smith 
8372a42c3cSBarry Smith    Collective
8472a42c3cSBarry Smith 
8572a42c3cSBarry Smith    Level: advanced
8672a42c3cSBarry Smith 
870f11a792SBarry Smith     Notes: this is called only by the PETSc MATLAB interface. Even though it might start MPI it sets the flag to
880f11a792SBarry Smith      indicate that it did NOT start MPI so that the PetscFinalize() does not end MPI, thus allowing PetscInitialize() to
890f11a792SBarry Smith      be called multiple times from MATLAB without the problem of trying to initialize MPI more than once.
900f11a792SBarry Smith 
9172a42c3cSBarry Smith .seealso: PetscInitialize(), PetscInitializeFortran(), PetscInitializeNoArguments()
920f11a792SBarry Smith */
930f11a792SBarry Smith PetscErrorCode  PetscInitializeMatlab(int argc,char **args,const char *filename,const char *help)
9472a42c3cSBarry Smith {
9572a42c3cSBarry Smith   PetscErrorCode ierr;
9672a42c3cSBarry Smith   int            myargc = argc;
9772a42c3cSBarry Smith   char           **myargs = args;
9872a42c3cSBarry Smith 
9972a42c3cSBarry Smith   PetscFunctionBegin;
10072a42c3cSBarry Smith   ierr = PetscInitialize(&myargc,&myargs,filename,help);
101df413903SBarry Smith   PetscBeganMPI = PETSC_FALSE;
10272a42c3cSBarry Smith   PetscFunctionReturn(ierr);
10372a42c3cSBarry Smith }
10472a42c3cSBarry Smith 
10572a42c3cSBarry Smith #undef __FUNCT__
1060f11a792SBarry Smith #define __FUNCT__ "PetscInitializedMatlab"
1070f11a792SBarry Smith /*
1080f11a792SBarry Smith       PetscInitializedMatlab - Has PETSc been initialized already?
1090f11a792SBarry Smith 
1100f11a792SBarry Smith    Not Collective
1110f11a792SBarry Smith 
1120f11a792SBarry Smith    Level: advanced
1130f11a792SBarry Smith 
1140f11a792SBarry Smith     Notes: this is called only by the PETSc MATLAB interface.
1150f11a792SBarry Smith 
1160f11a792SBarry Smith .seealso: PetscInitialize(), PetscInitializeFortran(), PetscInitializeNoArguments()
1170f11a792SBarry Smith */
1180f11a792SBarry Smith int  PetscInitializedMatlab(void)
1190f11a792SBarry Smith {
1200f11a792SBarry Smith   PetscBool flg;
1210f11a792SBarry Smith 
1220f11a792SBarry Smith   PetscInitialized(&flg);
1230f11a792SBarry Smith   if (flg) return 1;
1240f11a792SBarry Smith   else return 0;
1250f11a792SBarry Smith }
1260f11a792SBarry Smith 
1270f11a792SBarry Smith #undef __FUNCT__
1280f11a792SBarry Smith #define __FUNCT__ "PetscGetPETSC_COMM_SELFMatlab"
129f0865b08SBarry Smith /*
130e3c5b3baSBarry Smith       Used by MATLAB interface to get communicator
131f0865b08SBarry Smith */
1320f11a792SBarry Smith PetscErrorCode  PetscGetPETSC_COMM_SELFMatlab(MPI_Comm *comm)
133f0865b08SBarry Smith {
134f0865b08SBarry Smith   PetscFunctionBegin;
135f0865b08SBarry Smith   *comm = PETSC_COMM_SELF;
136f0865b08SBarry Smith   PetscFunctionReturn(0);
137f0865b08SBarry Smith }
1380f11a792SBarry Smith #endif
139f0865b08SBarry Smith 
140f0865b08SBarry Smith #undef __FUNCT__
141e5c89e4eSSatish Balay #define __FUNCT__ "PetscInitializeNoArguments"
142e5c89e4eSSatish Balay /*@C
143e5c89e4eSSatish Balay       PetscInitializeNoArguments - Calls PetscInitialize() from C/C++ without
144e5c89e4eSSatish Balay         the command line arguments.
145e5c89e4eSSatish Balay 
146e5c89e4eSSatish Balay    Collective
147e5c89e4eSSatish Balay 
148e5c89e4eSSatish Balay    Level: advanced
149e5c89e4eSSatish Balay 
150e5c89e4eSSatish Balay .seealso: PetscInitialize(), PetscInitializeFortran()
151e5c89e4eSSatish Balay @*/
1527087cfbeSBarry Smith PetscErrorCode  PetscInitializeNoArguments(void)
153e5c89e4eSSatish Balay {
154e5c89e4eSSatish Balay   PetscErrorCode ierr;
155e5c89e4eSSatish Balay   int            argc = 0;
156e5c89e4eSSatish Balay   char           **args = 0;
157e5c89e4eSSatish Balay 
158e5c89e4eSSatish Balay   PetscFunctionBegin;
159e5c89e4eSSatish Balay   ierr = PetscInitialize(&argc,&args,PETSC_NULL,PETSC_NULL);
160e5c89e4eSSatish Balay   PetscFunctionReturn(ierr);
161e5c89e4eSSatish Balay }
162e5c89e4eSSatish Balay 
163e5c89e4eSSatish Balay #undef __FUNCT__
164e5c89e4eSSatish Balay #define __FUNCT__ "PetscInitialized"
165e5c89e4eSSatish Balay /*@
166e5c89e4eSSatish Balay       PetscInitialized - Determine whether PETSc is initialized.
167e5c89e4eSSatish Balay 
1686dc8fec2Sbcordonn 7   Level: beginner
169e5c89e4eSSatish Balay 
170e5c89e4eSSatish Balay .seealso: PetscInitialize(), PetscInitializeNoArguments(), PetscInitializeFortran()
171e5c89e4eSSatish Balay @*/
1727087cfbeSBarry Smith PetscErrorCode  PetscInitialized(PetscBool  *isInitialized)
173e5c89e4eSSatish Balay {
174e5c89e4eSSatish Balay   PetscFunctionBegin;
175e5c89e4eSSatish Balay   PetscValidPointer(isInitialized, 1);
176e5c89e4eSSatish Balay   *isInitialized = PetscInitializeCalled;
177e5c89e4eSSatish Balay   PetscFunctionReturn(0);
178e5c89e4eSSatish Balay }
179e5c89e4eSSatish Balay 
180e5c89e4eSSatish Balay #undef __FUNCT__
181e5c89e4eSSatish Balay #define __FUNCT__ "PetscFinalized"
182e5c89e4eSSatish Balay /*@
183e5c89e4eSSatish Balay       PetscFinalized - Determine whether PetscFinalize() has been called yet
184e5c89e4eSSatish Balay 
185e5c89e4eSSatish Balay    Level: developer
186e5c89e4eSSatish Balay 
187e5c89e4eSSatish Balay .seealso: PetscInitialize(), PetscInitializeNoArguments(), PetscInitializeFortran()
188e5c89e4eSSatish Balay @*/
1897087cfbeSBarry Smith PetscErrorCode  PetscFinalized(PetscBool  *isFinalized)
190e5c89e4eSSatish Balay {
191e5c89e4eSSatish Balay   PetscFunctionBegin;
192e5c89e4eSSatish Balay   PetscValidPointer(isFinalized, 1);
193e5c89e4eSSatish Balay   *isFinalized = PetscFinalizeCalled;
194e5c89e4eSSatish Balay   PetscFunctionReturn(0);
195e5c89e4eSSatish Balay }
196e5c89e4eSSatish Balay 
19709573ac7SBarry Smith extern PetscErrorCode        PetscOptionsCheckInitial_Private(void);
198ace3abfcSBarry Smith extern PetscBool  PetscBeganMPI;
199e5c89e4eSSatish Balay 
200e5c89e4eSSatish Balay /*
201e5c89e4eSSatish Balay        This function is the MPI reduction operation used to compute the sum of the
202e5c89e4eSSatish Balay    first half of the datatype and the max of the second half.
203e5c89e4eSSatish Balay */
204e5c89e4eSSatish Balay MPI_Op PetscMaxSum_Op = 0;
205e5c89e4eSSatish Balay 
206e5c89e4eSSatish Balay EXTERN_C_BEGIN
207e5c89e4eSSatish Balay #undef __FUNCT__
208e5c89e4eSSatish Balay #define __FUNCT__ "PetscMaxSum_Local"
2097087cfbeSBarry Smith void  MPIAPI PetscMaxSum_Local(void *in,void *out,int *cnt,MPI_Datatype *datatype)
210e5c89e4eSSatish Balay {
211e5c89e4eSSatish Balay   PetscInt *xin = (PetscInt*)in,*xout = (PetscInt*)out,i,count = *cnt;
212e5c89e4eSSatish Balay 
213e5c89e4eSSatish Balay   PetscFunctionBegin;
214e5c89e4eSSatish Balay   if (*datatype != MPIU_2INT) {
215e5c89e4eSSatish Balay     (*PetscErrorPrintf)("Can only handle MPIU_2INT data types");
216e5c89e4eSSatish Balay     MPI_Abort(MPI_COMM_WORLD,1);
217e5c89e4eSSatish Balay   }
218e5c89e4eSSatish Balay 
219e5c89e4eSSatish Balay   for (i=0; i<count; i++) {
220e5c89e4eSSatish Balay     xout[2*i]    = PetscMax(xout[2*i],xin[2*i]);
221e5c89e4eSSatish Balay     xout[2*i+1] += xin[2*i+1];
222e5c89e4eSSatish Balay   }
223812af9f3SBarry Smith   PetscFunctionReturnVoid();
224e5c89e4eSSatish Balay }
225e5c89e4eSSatish Balay EXTERN_C_END
226e5c89e4eSSatish Balay 
227e5c89e4eSSatish Balay /*
228e5c89e4eSSatish Balay     Returns the max of the first entry owned by this processor and the
229e5c89e4eSSatish Balay sum of the second entry.
230b693b147SBarry Smith 
231b693b147SBarry Smith     The reason nprocs[2*i] contains lengths nprocs[2*i+1] contains flag of 1 if length is nonzero
232b693b147SBarry Smith is so that the PetscMaxSum_Op() can set TWO values, if we passed in only nprocs[i] with lengths
233b693b147SBarry Smith there would be no place to store the both needed results.
234e5c89e4eSSatish Balay */
235e5c89e4eSSatish Balay #undef __FUNCT__
236e5c89e4eSSatish Balay #define __FUNCT__ "PetscMaxSum"
2377087cfbeSBarry Smith PetscErrorCode  PetscMaxSum(MPI_Comm comm,const PetscInt nprocs[],PetscInt *max,PetscInt *sum)
238e5c89e4eSSatish Balay {
239e5c89e4eSSatish Balay   PetscMPIInt    size,rank;
240e5c89e4eSSatish Balay   PetscInt       *work;
241e5c89e4eSSatish Balay   PetscErrorCode ierr;
242e5c89e4eSSatish Balay 
243e5c89e4eSSatish Balay   PetscFunctionBegin;
244e5c89e4eSSatish Balay   ierr   = MPI_Comm_size(comm,&size);CHKERRQ(ierr);
245e5c89e4eSSatish Balay   ierr   = MPI_Comm_rank(comm,&rank);CHKERRQ(ierr);
246e5c89e4eSSatish Balay   ierr   = PetscMalloc(2*size*sizeof(PetscInt),&work);CHKERRQ(ierr);
247e5c89e4eSSatish Balay   ierr   = MPI_Allreduce((void*)nprocs,work,size,MPIU_2INT,PetscMaxSum_Op,comm);CHKERRQ(ierr);
248e5c89e4eSSatish Balay   *max   = work[2*rank];
249e5c89e4eSSatish Balay   *sum   = work[2*rank+1];
250e5c89e4eSSatish Balay   ierr   = PetscFree(work);CHKERRQ(ierr);
251e5c89e4eSSatish Balay   PetscFunctionReturn(0);
252e5c89e4eSSatish Balay }
253e5c89e4eSSatish Balay 
254e5c89e4eSSatish Balay /* ----------------------------------------------------------------------------*/
2557087cfbeSBarry Smith MPI_Op  PetscADMax_Op = 0;
256e5c89e4eSSatish Balay 
257e5c89e4eSSatish Balay EXTERN_C_BEGIN
258e5c89e4eSSatish Balay #undef __FUNCT__
259e5c89e4eSSatish Balay #define __FUNCT__ "PetscADMax_Local"
2607087cfbeSBarry Smith void  MPIAPI PetscADMax_Local(void *in,void *out,PetscMPIInt *cnt,MPI_Datatype *datatype)
261e5c89e4eSSatish Balay {
262e5c89e4eSSatish Balay   PetscScalar *xin = (PetscScalar *)in,*xout = (PetscScalar*)out;
263e5c89e4eSSatish Balay   PetscInt    i,count = *cnt;
264e5c89e4eSSatish Balay 
265e5c89e4eSSatish Balay   PetscFunctionBegin;
266e5c89e4eSSatish Balay   if (*datatype != MPIU_2SCALAR) {
267e5c89e4eSSatish Balay     (*PetscErrorPrintf)("Can only handle MPIU_2SCALAR data (i.e. double or complex) types");
268e5c89e4eSSatish Balay     MPI_Abort(MPI_COMM_WORLD,1);
269e5c89e4eSSatish Balay   }
270e5c89e4eSSatish Balay 
271e5c89e4eSSatish Balay   for (i=0; i<count; i++) {
272e5c89e4eSSatish Balay     if (PetscRealPart(xout[2*i]) < PetscRealPart(xin[2*i])) {
273e5c89e4eSSatish Balay       xout[2*i]   = xin[2*i];
274e5c89e4eSSatish Balay       xout[2*i+1] = xin[2*i+1];
275e5c89e4eSSatish Balay     }
276e5c89e4eSSatish Balay   }
277812af9f3SBarry Smith   PetscFunctionReturnVoid();
278e5c89e4eSSatish Balay }
279e5c89e4eSSatish Balay EXTERN_C_END
280e5c89e4eSSatish Balay 
2817087cfbeSBarry Smith MPI_Op  PetscADMin_Op = 0;
282e5c89e4eSSatish Balay 
283e5c89e4eSSatish Balay EXTERN_C_BEGIN
284e5c89e4eSSatish Balay #undef __FUNCT__
285e5c89e4eSSatish Balay #define __FUNCT__ "PetscADMin_Local"
2867087cfbeSBarry Smith void  MPIAPI PetscADMin_Local(void *in,void *out,PetscMPIInt *cnt,MPI_Datatype *datatype)
287e5c89e4eSSatish Balay {
288e5c89e4eSSatish Balay   PetscScalar *xin = (PetscScalar *)in,*xout = (PetscScalar*)out;
289e5c89e4eSSatish Balay   PetscInt    i,count = *cnt;
290e5c89e4eSSatish Balay 
291e5c89e4eSSatish Balay   PetscFunctionBegin;
292e5c89e4eSSatish Balay   if (*datatype != MPIU_2SCALAR) {
293e5c89e4eSSatish Balay     (*PetscErrorPrintf)("Can only handle MPIU_2SCALAR data (i.e. double or complex) types");
294e5c89e4eSSatish Balay     MPI_Abort(MPI_COMM_WORLD,1);
295e5c89e4eSSatish Balay   }
296e5c89e4eSSatish Balay 
297e5c89e4eSSatish Balay   for (i=0; i<count; i++) {
298e5c89e4eSSatish Balay     if (PetscRealPart(xout[2*i]) > PetscRealPart(xin[2*i])) {
299e5c89e4eSSatish Balay       xout[2*i]   = xin[2*i];
300e5c89e4eSSatish Balay       xout[2*i+1] = xin[2*i+1];
301e5c89e4eSSatish Balay     }
302e5c89e4eSSatish Balay   }
303812af9f3SBarry Smith   PetscFunctionReturnVoid();
304e5c89e4eSSatish Balay }
305e5c89e4eSSatish Balay EXTERN_C_END
306e5c89e4eSSatish Balay /* ---------------------------------------------------------------------------------------*/
307e5c89e4eSSatish Balay 
308ce63c4c1SBarry Smith #if (defined(PETSC_USE_COMPLEX) && !defined(PETSC_HAVE_MPI_C_DOUBLE_COMPLEX)) || defined(PETSC_USE_REAL___FLOAT128)
30906a205a8SBarry Smith MPI_Op MPIU_SUM = 0;
310e5c89e4eSSatish Balay 
311e5c89e4eSSatish Balay EXTERN_C_BEGIN
312e5c89e4eSSatish Balay #undef __FUNCT__
313e5c89e4eSSatish Balay #define __FUNCT__ "PetscSum_Local"
3147087cfbeSBarry Smith void  PetscSum_Local(void *in,void *out,PetscMPIInt *cnt,MPI_Datatype *datatype)
315e5c89e4eSSatish Balay {
316e5c89e4eSSatish Balay   PetscInt    i,count = *cnt;
317e5c89e4eSSatish Balay 
318e5c89e4eSSatish Balay   PetscFunctionBegin;
319e2e03761SBarry Smith   if (*datatype == MPIU_SCALAR) {
320e2e03761SBarry Smith     PetscScalar *xin = (PetscScalar *)in,*xout = (PetscScalar*)out;
321e5c89e4eSSatish Balay     for (i=0; i<count; i++) {
322e5c89e4eSSatish Balay       xout[i] += xin[i];
323e5c89e4eSSatish Balay     }
324e2e03761SBarry Smith   } else if (*datatype == MPIU_REAL) {
325e2e03761SBarry Smith     PetscReal *xin = (PetscReal *)in,*xout = (PetscReal*)out;
326e2e03761SBarry Smith     for (i=0; i<count; i++) {
327e2e03761SBarry Smith       xout[i] += xin[i];
328e2e03761SBarry Smith     }
329e2e03761SBarry Smith   } else {
330e2e03761SBarry Smith     (*PetscErrorPrintf)("Can only handle MPIU_REAL or MPIU_SCALAR data (i.e. double or complex) types");
331e2e03761SBarry Smith     MPI_Abort(MPI_COMM_WORLD,1);
332e2e03761SBarry Smith   }
333812af9f3SBarry Smith   PetscFunctionReturnVoid();
334e5c89e4eSSatish Balay }
335e5c89e4eSSatish Balay EXTERN_C_END
336e5c89e4eSSatish Balay #endif
337e5c89e4eSSatish Balay 
338ce63c4c1SBarry Smith #if defined(PETSC_USE_REAL___FLOAT128)
339d9822059SBarry Smith MPI_Op MPIU_MAX = 0;
340d9822059SBarry Smith MPI_Op MPIU_MIN = 0;
341d9822059SBarry Smith 
342d9822059SBarry Smith EXTERN_C_BEGIN
343d9822059SBarry Smith #undef __FUNCT__
344d9822059SBarry Smith #define __FUNCT__ "PetscMax_Local"
345d9822059SBarry Smith void  PetscMax_Local(void *in,void *out,PetscMPIInt *cnt,MPI_Datatype *datatype)
346d9822059SBarry Smith {
347d9822059SBarry Smith   PetscScalar *xin = (PetscScalar *)in,*xout = (PetscScalar*)out;
348d9822059SBarry Smith   PetscInt    i,count = *cnt;
349d9822059SBarry Smith 
350d9822059SBarry Smith   PetscFunctionBegin;
351d9822059SBarry Smith   if (*datatype != MPIU_SCALAR) {
352d9822059SBarry Smith     (*PetscErrorPrintf)("Can only handle MPIU_SCALAR data (i.e. double or complex) types");
353d9822059SBarry Smith     MPI_Abort(MPI_COMM_WORLD,1);
354d9822059SBarry Smith   }
355d9822059SBarry Smith 
356d9822059SBarry Smith   for (i=0; i<count; i++) {
357d9822059SBarry Smith     xout[i] += PetscMax(xout[i],xin[i]);
358d9822059SBarry Smith   }
359d9822059SBarry Smith   PetscFunctionReturnVoid();
360d9822059SBarry Smith }
361d9822059SBarry Smith EXTERN_C_END
362d9822059SBarry Smith 
363d9822059SBarry Smith EXTERN_C_BEGIN
364d9822059SBarry Smith #undef __FUNCT__
365d9822059SBarry Smith #define __FUNCT__ "PetscMin_Local"
366d9822059SBarry Smith void  PetscMin_Local(void *in,void *out,PetscMPIInt *cnt,MPI_Datatype *datatype)
367d9822059SBarry Smith {
368d9822059SBarry Smith   PetscScalar *xin = (PetscScalar *)in,*xout = (PetscScalar*)out;
369d9822059SBarry Smith   PetscInt    i,count = *cnt;
370d9822059SBarry Smith 
371d9822059SBarry Smith   PetscFunctionBegin;
372d9822059SBarry Smith   if (*datatype != MPIU_SCALAR) {
373d9822059SBarry Smith     (*PetscErrorPrintf)("Can only handle MPIU_SCALAR data (i.e. double or complex) types");
374d9822059SBarry Smith     MPI_Abort(MPI_COMM_WORLD,1);
375d9822059SBarry Smith   }
376d9822059SBarry Smith 
377d9822059SBarry Smith   for (i=0; i<count; i++) {
378d9822059SBarry Smith     xout[i] += PetscMin(xout[i],xin[i]);
379d9822059SBarry Smith   }
380d9822059SBarry Smith   PetscFunctionReturnVoid();
381d9822059SBarry Smith }
382d9822059SBarry Smith EXTERN_C_END
383d9822059SBarry Smith #endif
384d9822059SBarry Smith 
385480cf27aSJed Brown EXTERN_C_BEGIN
386480cf27aSJed Brown #undef __FUNCT__
387480cf27aSJed Brown #define __FUNCT__ "Petsc_DelCounter"
388480cf27aSJed Brown /*
389480cf27aSJed Brown    Private routine to delete internal tag/name counter storage when a communicator is freed.
390480cf27aSJed Brown 
391480cf27aSJed Brown    This is called by MPI, not by users.
392480cf27aSJed Brown 
393480cf27aSJed Brown    Note: this is declared extern "C" because it is passed to MPI_Keyval_create()
394480cf27aSJed Brown 
395480cf27aSJed Brown */
3967087cfbeSBarry Smith PetscMPIInt  MPIAPI Petsc_DelCounter(MPI_Comm comm,PetscMPIInt keyval,void *count_val,void *extra_state)
397480cf27aSJed Brown {
398480cf27aSJed Brown   PetscErrorCode ierr;
399480cf27aSJed Brown 
400480cf27aSJed Brown   PetscFunctionBegin;
401480cf27aSJed Brown   ierr = PetscInfo1(0,"Deleting counter data in an MPI_Comm %ld\n",(long)comm);if (ierr) PetscFunctionReturn((PetscMPIInt)ierr);
402480cf27aSJed Brown   ierr = PetscFree(count_val);if (ierr) PetscFunctionReturn((PetscMPIInt)ierr);
403480cf27aSJed Brown   PetscFunctionReturn(MPI_SUCCESS);
404480cf27aSJed Brown }
405480cf27aSJed Brown EXTERN_C_END
406480cf27aSJed Brown 
407480cf27aSJed Brown EXTERN_C_BEGIN
408480cf27aSJed Brown #undef __FUNCT__
409480cf27aSJed Brown #define __FUNCT__ "Petsc_DelComm"
410480cf27aSJed Brown /*
411480cf27aSJed Brown   This does not actually free anything, it simply marks when a reference count to an internal MPI_Comm reaches zero and the
412480cf27aSJed Brown   the external MPI_Comm drops its reference to the internal MPI_Comm
413480cf27aSJed Brown 
414480cf27aSJed Brown   This is called by MPI, not by users.
415480cf27aSJed Brown 
416480cf27aSJed Brown   Note: this is declared extern "C" because it is passed to MPI_Keyval_create()
417480cf27aSJed Brown 
418480cf27aSJed Brown */
4197087cfbeSBarry Smith PetscMPIInt  MPIAPI Petsc_DelComm(MPI_Comm comm,PetscMPIInt keyval,void *attr_val,void *extra_state)
420480cf27aSJed Brown {
421480cf27aSJed Brown   PetscErrorCode ierr;
422480cf27aSJed Brown 
423480cf27aSJed Brown   PetscFunctionBegin;
424480cf27aSJed Brown   ierr = PetscInfo1(0,"Deleting PETSc communicator imbedded in a user MPI_Comm %ld\n",(long)comm);if (ierr) PetscFunctionReturn((PetscMPIInt)ierr);
425480cf27aSJed Brown   /* actually don't delete anything because we cannot increase the reference count of the communicator anyways */
426480cf27aSJed Brown   PetscFunctionReturn(MPI_SUCCESS);
427480cf27aSJed Brown }
428480cf27aSJed Brown EXTERN_C_END
429480cf27aSJed Brown 
430951e3c8eSBarry Smith #if defined(PETSC_USE_PETSC_MPI_EXTERNAL32)
431e39fd77fSBarry Smith #if !defined(PETSC_WORDS_BIGENDIAN)
432e39fd77fSBarry Smith EXTERN_C_BEGIN
433e39fd77fSBarry Smith extern PetscMPIInt PetscDataRep_extent_fn(MPI_Datatype,MPI_Aint*,void*);
434e39fd77fSBarry Smith extern PetscMPIInt PetscDataRep_read_conv_fn(void*, MPI_Datatype,PetscMPIInt,void*,MPI_Offset,void*);
435e39fd77fSBarry Smith extern PetscMPIInt PetscDataRep_write_conv_fn(void*, MPI_Datatype,PetscMPIInt,void*,MPI_Offset,void*);
436e39fd77fSBarry Smith EXTERN_C_END
437e39fd77fSBarry Smith #endif
438951e3c8eSBarry Smith #endif
439e39fd77fSBarry Smith 
4406ae9a8a6SBarry Smith int  PetscGlobalArgc   = 0;
4416ae9a8a6SBarry Smith char **PetscGlobalArgs = 0;
442e5c89e4eSSatish Balay 
443e5c89e4eSSatish Balay #undef __FUNCT__
444e5c89e4eSSatish Balay #define __FUNCT__ "PetscGetArgs"
445e5c89e4eSSatish Balay /*@C
446e5c89e4eSSatish Balay    PetscGetArgs - Allows you to access the raw command line arguments anywhere
447e5c89e4eSSatish Balay      after PetscInitialize() is called but before PetscFinalize().
448e5c89e4eSSatish Balay 
449e5c89e4eSSatish Balay    Not Collective
450e5c89e4eSSatish Balay 
451e5c89e4eSSatish Balay    Output Parameters:
452e5c89e4eSSatish Balay +  argc - count of number of command line arguments
453e5c89e4eSSatish Balay -  args - the command line arguments
454e5c89e4eSSatish Balay 
455e5c89e4eSSatish Balay    Level: intermediate
456e5c89e4eSSatish Balay 
457e5c89e4eSSatish Balay    Notes:
458e5c89e4eSSatish Balay       This is usually used to pass the command line arguments into other libraries
459e5c89e4eSSatish Balay    that are called internally deep in PETSc or the application.
460e5c89e4eSSatish Balay 
461f177e3b1SBarry Smith       The first argument contains the program name as is normal for C arguments.
462f177e3b1SBarry Smith 
463e5c89e4eSSatish Balay    Concepts: command line arguments
464e5c89e4eSSatish Balay 
465793721a6SBarry Smith .seealso: PetscFinalize(), PetscInitializeFortran(), PetscGetArguments()
466e5c89e4eSSatish Balay 
467e5c89e4eSSatish Balay @*/
4687087cfbeSBarry Smith PetscErrorCode  PetscGetArgs(int *argc,char ***args)
469e5c89e4eSSatish Balay {
470e5c89e4eSSatish Balay   PetscFunctionBegin;
47117186662SBarry Smith   if (!PetscInitializeCalled && PetscFinalizeCalled) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ORDER,"You must call after PetscInitialize() but before PetscFinalize()");
472e5c89e4eSSatish Balay   *argc = PetscGlobalArgc;
473e5c89e4eSSatish Balay   *args = PetscGlobalArgs;
474e5c89e4eSSatish Balay   PetscFunctionReturn(0);
475e5c89e4eSSatish Balay }
476e5c89e4eSSatish Balay 
477e5c89e4eSSatish Balay #undef __FUNCT__
478793721a6SBarry Smith #define __FUNCT__ "PetscGetArguments"
479793721a6SBarry Smith /*@C
480793721a6SBarry Smith    PetscGetArguments - Allows you to access the  command line arguments anywhere
481793721a6SBarry Smith      after PetscInitialize() is called but before PetscFinalize().
482793721a6SBarry Smith 
483793721a6SBarry Smith    Not Collective
484793721a6SBarry Smith 
485793721a6SBarry Smith    Output Parameters:
486793721a6SBarry Smith .  args - the command line arguments
487793721a6SBarry Smith 
488793721a6SBarry Smith    Level: intermediate
489793721a6SBarry Smith 
490793721a6SBarry Smith    Notes:
491793721a6SBarry Smith       This does NOT start with the program name and IS null terminated (final arg is void)
492793721a6SBarry Smith 
493793721a6SBarry Smith    Concepts: command line arguments
494793721a6SBarry Smith 
495793721a6SBarry Smith .seealso: PetscFinalize(), PetscInitializeFortran(), PetscGetArgs(), PetscFreeArguments()
496793721a6SBarry Smith 
497793721a6SBarry Smith @*/
4987087cfbeSBarry Smith PetscErrorCode  PetscGetArguments(char ***args)
499793721a6SBarry Smith {
500793721a6SBarry Smith   PetscInt       i,argc = PetscGlobalArgc;
501793721a6SBarry Smith   PetscErrorCode ierr;
502793721a6SBarry Smith 
503793721a6SBarry Smith   PetscFunctionBegin;
50417186662SBarry Smith   if (!PetscInitializeCalled && PetscFinalizeCalled) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ORDER,"You must call after PetscInitialize() but before PetscFinalize()");
505717030eeSLisandro Dalcin   if (!argc) {*args = 0; PetscFunctionReturn(0);}
506793721a6SBarry Smith   ierr = PetscMalloc(argc*sizeof(char*),args);CHKERRQ(ierr);
507793721a6SBarry Smith   for (i=0; i<argc-1; i++) {
508793721a6SBarry Smith     ierr = PetscStrallocpy(PetscGlobalArgs[i+1],&(*args)[i]);CHKERRQ(ierr);
509793721a6SBarry Smith   }
510793721a6SBarry Smith   (*args)[argc-1] = 0;
511793721a6SBarry Smith   PetscFunctionReturn(0);
512793721a6SBarry Smith }
513793721a6SBarry Smith 
514793721a6SBarry Smith #undef __FUNCT__
515793721a6SBarry Smith #define __FUNCT__ "PetscFreeArguments"
516793721a6SBarry Smith /*@C
517793721a6SBarry Smith    PetscFreeArguments - Frees the memory obtained with PetscGetArguments()
518793721a6SBarry Smith 
519793721a6SBarry Smith    Not Collective
520793721a6SBarry Smith 
521793721a6SBarry Smith    Output Parameters:
522793721a6SBarry Smith .  args - the command line arguments
523793721a6SBarry Smith 
524793721a6SBarry Smith    Level: intermediate
525793721a6SBarry Smith 
526793721a6SBarry Smith    Concepts: command line arguments
527793721a6SBarry Smith 
528793721a6SBarry Smith .seealso: PetscFinalize(), PetscInitializeFortran(), PetscGetArgs(), PetscGetArguments()
529793721a6SBarry Smith 
530793721a6SBarry Smith @*/
5317087cfbeSBarry Smith PetscErrorCode  PetscFreeArguments(char **args)
532793721a6SBarry Smith {
533793721a6SBarry Smith   PetscInt       i = 0;
534793721a6SBarry Smith   PetscErrorCode ierr;
535793721a6SBarry Smith 
536793721a6SBarry Smith   PetscFunctionBegin;
537717030eeSLisandro Dalcin   if (!args) {PetscFunctionReturn(0);}
538793721a6SBarry Smith   while (args[i]) {
539793721a6SBarry Smith     ierr = PetscFree(args[i]);CHKERRQ(ierr);
540793721a6SBarry Smith     i++;
541793721a6SBarry Smith   }
542793721a6SBarry Smith   ierr = PetscFree(args);CHKERRQ(ierr);
543793721a6SBarry Smith   PetscFunctionReturn(0);
544793721a6SBarry Smith }
545793721a6SBarry Smith 
546793721a6SBarry Smith #undef __FUNCT__
547e5c89e4eSSatish Balay #define __FUNCT__ "PetscInitialize"
548e5c89e4eSSatish Balay /*@C
549e5c89e4eSSatish Balay    PetscInitialize - Initializes the PETSc database and MPI.
550e5c89e4eSSatish Balay    PetscInitialize() calls MPI_Init() if that has yet to be called,
551e5c89e4eSSatish Balay    so this routine should always be called near the beginning of
552e5c89e4eSSatish Balay    your program -- usually the very first line!
553e5c89e4eSSatish Balay 
554e5c89e4eSSatish Balay    Collective on MPI_COMM_WORLD or PETSC_COMM_WORLD if it has been set
555e5c89e4eSSatish Balay 
556e5c89e4eSSatish Balay    Input Parameters:
557e5c89e4eSSatish Balay +  argc - count of number of command line arguments
558e5c89e4eSSatish Balay .  args - the command line arguments
559fc2bca9aSBarry Smith .  file - [optional] PETSc database file, also checks ~username/.petscrc and .petscrc use PETSC_NULL to not check for
560fc2bca9aSBarry Smith           code specific file. Use -skip_petscrc in the code specific file to skip the .petscrc files
561e5c89e4eSSatish Balay -  help - [optional] Help message to print, use PETSC_NULL for no message
562e5c89e4eSSatish Balay 
56305827820SBarry Smith    If you wish PETSc code to run ONLY on a subcommunicator of MPI_COMM_WORLD, create that
56405827820SBarry Smith    communicator first and assign it to PETSC_COMM_WORLD BEFORE calling PetscInitialize(). Thus if you are running a
56505827820SBarry Smith    four process job and two processes will run PETSc and have PetscInitialize() and PetscFinalize() and two process will not,
56605827820SBarry Smith    then do this. If ALL processes in the job are using PetscInitialize() and PetscFinalize() then you don't need to do this, even
56705827820SBarry Smith    if different subcommunicators of the job are doing different things with PETSc.
568e5c89e4eSSatish Balay 
569e5c89e4eSSatish Balay    Options Database Keys:
570e5c89e4eSSatish Balay +  -start_in_debugger [noxterm,dbx,xdb,gdb,...] - Starts program in debugger
571e5c89e4eSSatish Balay .  -on_error_attach_debugger [noxterm,dbx,xdb,gdb,...] - Starts debugger when error detected
572e5c89e4eSSatish Balay .  -on_error_emacs <machinename> causes emacsclient to jump to error file
573b52f573bSBarry Smith .  -on_error_abort calls abort() when error detected (no traceback)
574e8fb0fc0SBarry Smith .  -on_error_mpiabort calls MPI_abort() when error detected
575e8fb0fc0SBarry Smith .  -error_output_stderr prints error messages to stderr instead of the default stdout
576e8fb0fc0SBarry Smith .  -error_output_none does not print the error messages (but handles errors in the same way as if this was not called)
577e5c89e4eSSatish Balay .  -debugger_nodes [node1,node2,...] - Indicates nodes to start in debugger
578e5c89e4eSSatish Balay .  -debugger_pause [sleeptime] (in seconds) - Pauses debugger
579e5c89e4eSSatish Balay .  -stop_for_debugger - Print message on how to attach debugger manually to
580e5c89e4eSSatish Balay                         process and wait (-debugger_pause) seconds for attachment
5812fb0ec9aSBarry Smith .  -malloc - Indicates use of PETSc error-checking malloc (on by default for debug version of libraries)
582e5c89e4eSSatish Balay .  -malloc no - Indicates not to use error-checking malloc
5832fb0ec9aSBarry Smith .  -malloc_debug - check for memory corruption at EVERY malloc or free
584e5c89e4eSSatish Balay .  -fp_trap - Stops on floating point exceptions (Note that on the
585e5c89e4eSSatish Balay               IBM RS6000 this slows code by at least a factor of 10.)
586e5c89e4eSSatish Balay .  -no_signal_handler - Indicates not to trap error signals
587e5c89e4eSSatish Balay .  -shared_tmp - indicates /tmp directory is shared by all processors
588e5c89e4eSSatish Balay .  -not_shared_tmp - each processor has own /tmp
589e5c89e4eSSatish Balay .  -tmp - alternative name of /tmp directory
590e5c89e4eSSatish Balay .  -get_total_flops - returns total flops done by all processors
591e5c89e4eSSatish Balay -  -memory_info - Print memory usage at end of run
592e5c89e4eSSatish Balay 
593e5c89e4eSSatish Balay    Options Database Keys for Profiling:
5940598bfebSBarry Smith    See the <a href="../../docs/manual.pdf#nameddest=ch_profiling">profiling chapter of the users manual</a> for details.
595e5c89e4eSSatish Balay +  -log_trace [filename] - Print traces of all PETSc calls
596e5c89e4eSSatish Balay         to the screen (useful to determine where a program
597e5c89e4eSSatish Balay         hangs without running in the debugger).  See PetscLogTraceBegin().
5986cf91177SBarry Smith .  -info <optional filename> - Prints verbose information to the screen
5996cf91177SBarry Smith -  -info_exclude <null,vec,mat,pc,ksp,snes,ts> - Excludes some of the verbose messages
600e5c89e4eSSatish Balay 
601e5c89e4eSSatish Balay    Environmental Variables:
602e5c89e4eSSatish Balay +   PETSC_TMP - alternative tmp directory
603e5c89e4eSSatish Balay .   PETSC_SHARED_TMP - tmp is shared by all processes
604e5c89e4eSSatish Balay .   PETSC_NOT_SHARED_TMP - each process has its own private tmp
605e5c89e4eSSatish Balay .   PETSC_VIEWER_SOCKET_PORT - socket number to use for socket viewer
606e5c89e4eSSatish Balay -   PETSC_VIEWER_SOCKET_MACHINE - machine to use for socket viewer to connect to
607e5c89e4eSSatish Balay 
608e5c89e4eSSatish Balay 
609e5c89e4eSSatish Balay    Level: beginner
610e5c89e4eSSatish Balay 
611e5c89e4eSSatish Balay    Notes:
612e5c89e4eSSatish Balay    If for some reason you must call MPI_Init() separately, call
613e5c89e4eSSatish Balay    it before PetscInitialize().
614e5c89e4eSSatish Balay 
615e5c89e4eSSatish Balay    Fortran Version:
616e5c89e4eSSatish Balay    In Fortran this routine has the format
617e5c89e4eSSatish Balay $       call PetscInitialize(file,ierr)
618e5c89e4eSSatish Balay 
619e5c89e4eSSatish Balay +   ierr - error return code
6203dae0d48SMatthew Knepley -  file - [optional] PETSc database file, also checks ~username/.petscrc and .petscrc use PETSC_NULL_CHARACTER to not check for
621fc2bca9aSBarry Smith           code specific file. Use -skip_petscrc in the code specific file to skip the .petscrc files
622e5c89e4eSSatish Balay 
623e5c89e4eSSatish Balay    Important Fortran Note:
624e5c89e4eSSatish Balay    In Fortran, you MUST use PETSC_NULL_CHARACTER to indicate a
625e5c89e4eSSatish Balay    null character string; you CANNOT just use PETSC_NULL as
6260598bfebSBarry Smith    in the C version. See the <a href="../../docs/manual.pdf">users manual</a> for details.
627e5c89e4eSSatish Balay 
62801cb0274SBarry Smith    If your main program is C but you call Fortran code that also uses PETSc you need to call PetscInitializeFortran() soon after
62901cb0274SBarry Smith    calling PetscInitialize().
630e5c89e4eSSatish Balay 
631e5c89e4eSSatish Balay    Concepts: initializing PETSc
632e5c89e4eSSatish Balay 
63301cb0274SBarry Smith .seealso: PetscFinalize(), PetscInitializeFortran(), PetscGetArgs(), PetscInitializeNoArguments()
634e5c89e4eSSatish Balay 
635e5c89e4eSSatish Balay @*/
6367087cfbeSBarry Smith PetscErrorCode  PetscInitialize(int *argc,char ***args,const char file[],const char help[])
637e5c89e4eSSatish Balay {
638e5c89e4eSSatish Balay   PetscErrorCode ierr;
639aa5bb8c0SSatish Balay   PetscMPIInt    flag, size;
640aa5bb8c0SSatish Balay   PetscInt       nodesize;
641ace3abfcSBarry Smith   PetscBool      flg;
642e5c89e4eSSatish Balay   char           hostname[256];
643e5c89e4eSSatish Balay 
644e5c89e4eSSatish Balay   PetscFunctionBegin;
645e5c89e4eSSatish Balay   if (PetscInitializeCalled) PetscFunctionReturn(0);
646e5c89e4eSSatish Balay 
647ae9b4142SLisandro Dalcin   /* these must be initialized in a routine, not as a constant declaration*/
648d89683f4Sbcordonn   PETSC_STDOUT = stdout;
649ae9b4142SLisandro Dalcin   PETSC_STDERR = stderr;
650e5c89e4eSSatish Balay 
651e5c89e4eSSatish Balay   ierr = PetscOptionsCreate();CHKERRQ(ierr);
652e5c89e4eSSatish Balay 
653e5c89e4eSSatish Balay   /*
654e5c89e4eSSatish Balay      We initialize the program name here (before MPI_Init()) because MPICH has a bug in
655e5c89e4eSSatish Balay      it that it sets args[0] on all processors to be args[0] on the first processor.
656e5c89e4eSSatish Balay   */
657e5c89e4eSSatish Balay   if (argc && *argc) {
658e5c89e4eSSatish Balay     ierr = PetscSetProgramName(**args);CHKERRQ(ierr);
659e5c89e4eSSatish Balay   } else {
660e5c89e4eSSatish Balay     ierr = PetscSetProgramName("Unknown Name");CHKERRQ(ierr);
661e5c89e4eSSatish Balay   }
662e5c89e4eSSatish Balay 
663e5c89e4eSSatish Balay   ierr = MPI_Initialized(&flag);CHKERRQ(ierr);
664e5c89e4eSSatish Balay   if (!flag) {
665e32f2f54SBarry 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");
666e5c89e4eSSatish Balay     ierr          = MPI_Init(argc,args);CHKERRQ(ierr);
667e5c89e4eSSatish Balay     PetscBeganMPI = PETSC_TRUE;
668e5c89e4eSSatish Balay   }
669e5c89e4eSSatish Balay   if (argc && args) {
670e5c89e4eSSatish Balay     PetscGlobalArgc = *argc;
671e5c89e4eSSatish Balay     PetscGlobalArgs = *args;
672e5c89e4eSSatish Balay   }
673e5c89e4eSSatish Balay   PetscFinalizeCalled   = PETSC_FALSE;
674e5c89e4eSSatish Balay 
675e8373e55SMatthew Knepley   if (PETSC_COMM_WORLD == MPI_COMM_NULL) {
676e5c89e4eSSatish Balay     PETSC_COMM_WORLD = MPI_COMM_WORLD;
677e5c89e4eSSatish Balay   }
678660746e0SBarry Smith   ierr = MPI_Errhandler_set(PETSC_COMM_WORLD,MPI_ERRORS_RETURN);CHKERRQ(ierr);
679e5c89e4eSSatish Balay 
680e5c89e4eSSatish Balay   /* Done after init due to a bug in MPICH-GM? */
681e5c89e4eSSatish Balay   ierr = PetscErrorPrintfInitialize();CHKERRQ(ierr);
682e5c89e4eSSatish Balay 
683e5c89e4eSSatish Balay   ierr = MPI_Comm_rank(MPI_COMM_WORLD,&PetscGlobalRank);CHKERRQ(ierr);
684e5c89e4eSSatish Balay   ierr = MPI_Comm_size(MPI_COMM_WORLD,&PetscGlobalSize);CHKERRQ(ierr);
685e5c89e4eSSatish Balay 
686e5c89e4eSSatish Balay #if defined(PETSC_USE_COMPLEX)
687e5c89e4eSSatish Balay   /*
688e5c89e4eSSatish Balay      Initialized the global complex variable; this is because with
689e5c89e4eSSatish Balay      shared libraries the constructors for global variables
690e5c89e4eSSatish Balay      are not called; at least on IRIX.
691e5c89e4eSSatish Balay   */
692e5c89e4eSSatish Balay   {
693762437b8SSatish Balay #if defined(PETSC_CLANGUAGE_CXX)
694e5c89e4eSSatish Balay     PetscScalar ic(0.0,1.0);
695e5c89e4eSSatish Balay     PETSC_i = ic;
696b7940d39SSatish Balay #else
6973433f298SSatish Balay     PETSC_i = I;
698b7940d39SSatish Balay #endif
699762437b8SSatish Balay   }
700762437b8SSatish Balay 
7012c876bd9SBarry Smith #if !defined(PETSC_HAVE_MPI_C_DOUBLE_COMPLEX)
7022c876bd9SBarry Smith   ierr = MPI_Type_contiguous(2,MPIU_REAL,&MPI_C_DOUBLE_COMPLEX);CHKERRQ(ierr);
7032c876bd9SBarry Smith   ierr = MPI_Type_commit(&MPI_C_DOUBLE_COMPLEX);CHKERRQ(ierr);
704a83b8d76SBarry Smith   ierr = MPI_Type_contiguous(2,MPI_FLOAT,&MPI_C_COMPLEX);CHKERRQ(ierr);
705a83b8d76SBarry Smith   ierr = MPI_Type_commit(&MPI_C_COMPLEX);CHKERRQ(ierr);
70606a205a8SBarry Smith   ierr = MPI_Op_create(PetscSum_Local,1,&MPIU_SUM);CHKERRQ(ierr);
707e5c89e4eSSatish Balay #endif
7082c876bd9SBarry Smith #endif
709e5c89e4eSSatish Balay 
710e5c89e4eSSatish Balay   /*
711e5c89e4eSSatish Balay      Create the PETSc MPI reduction operator that sums of the first
712e5c89e4eSSatish Balay      half of the entries and maxes the second half.
713e5c89e4eSSatish Balay   */
714e5c89e4eSSatish Balay   ierr = MPI_Op_create(PetscMaxSum_Local,1,&PetscMaxSum_Op);CHKERRQ(ierr);
715e5c89e4eSSatish Balay 
716ce63c4c1SBarry Smith #if defined(PETSC_USE_REAL___FLOAT128)
717c90a1750SBarry Smith   ierr = MPI_Type_contiguous(2,MPI_DOUBLE,&MPIU___FLOAT128);CHKERRQ(ierr);
718c90a1750SBarry Smith   ierr = MPI_Type_commit(&MPIU___FLOAT128);CHKERRQ(ierr);
719854411e3SBarry Smith   ierr = MPI_Op_create(PetscSum_Local,1,&MPIU_SUM);CHKERRQ(ierr);
720d9822059SBarry Smith   ierr = MPI_Op_create(PetscMax_Local,1,&MPIU_MAX);CHKERRQ(ierr);
721d9822059SBarry Smith   ierr = MPI_Op_create(PetscMin_Local,1,&MPIU_MIN);CHKERRQ(ierr);
722c90a1750SBarry Smith #endif
723c90a1750SBarry Smith 
724e5c89e4eSSatish Balay   ierr = MPI_Type_contiguous(2,MPIU_SCALAR,&MPIU_2SCALAR);CHKERRQ(ierr);
725e5c89e4eSSatish Balay   ierr = MPI_Type_commit(&MPIU_2SCALAR);CHKERRQ(ierr);
726e5c89e4eSSatish Balay   ierr = MPI_Op_create(PetscADMax_Local,1,&PetscADMax_Op);CHKERRQ(ierr);
727e5c89e4eSSatish Balay   ierr = MPI_Op_create(PetscADMin_Local,1,&PetscADMin_Op);CHKERRQ(ierr);
728e5c89e4eSSatish Balay 
729e5c89e4eSSatish Balay   ierr = MPI_Type_contiguous(2,MPIU_INT,&MPIU_2INT);CHKERRQ(ierr);
730e5c89e4eSSatish Balay   ierr = MPI_Type_commit(&MPIU_2INT);CHKERRQ(ierr);
731e5c89e4eSSatish Balay 
732e5c89e4eSSatish Balay   /*
733480cf27aSJed Brown      Attributes to be set on PETSc communicators
734480cf27aSJed Brown   */
735480cf27aSJed Brown   ierr = MPI_Keyval_create(MPI_NULL_COPY_FN,Petsc_DelCounter,&Petsc_Counter_keyval,(void*)0);CHKERRQ(ierr);
736480cf27aSJed Brown   ierr = MPI_Keyval_create(MPI_NULL_COPY_FN,Petsc_DelComm,&Petsc_InnerComm_keyval,(void*)0);CHKERRQ(ierr);
737480cf27aSJed Brown   ierr = MPI_Keyval_create(MPI_NULL_COPY_FN,Petsc_DelComm,&Petsc_OuterComm_keyval,(void*)0);CHKERRQ(ierr);
738480cf27aSJed Brown 
739480cf27aSJed Brown   /*
740e8fb0fc0SBarry Smith      Build the options database
741e5c89e4eSSatish Balay   */
742e5c89e4eSSatish Balay   ierr = PetscOptionsInsert(argc,args,file);CHKERRQ(ierr);
743e5c89e4eSSatish Balay 
7446dc8fec2Sbcordonn 
745e5c89e4eSSatish Balay   /*
746e5c89e4eSSatish Balay      Print main application help message
747e5c89e4eSSatish Balay   */
748e5c89e4eSSatish Balay   ierr = PetscOptionsHasName(PETSC_NULL,"-help",&flg);CHKERRQ(ierr);
749e5c89e4eSSatish Balay   if (help && flg) {
750e5c89e4eSSatish Balay     ierr = PetscPrintf(PETSC_COMM_WORLD,help);CHKERRQ(ierr);
751e5c89e4eSSatish Balay   }
752e5c89e4eSSatish Balay   ierr = PetscOptionsCheckInitial_Private();CHKERRQ(ierr);
753e5c89e4eSSatish Balay 
754e5c89e4eSSatish Balay   /* SHOULD PUT IN GUARDS: Make sure logging is initialized, even if we do not print it out */
755a9f03627SSatish Balay #if defined(PETSC_USE_LOG)
756e5c89e4eSSatish Balay   ierr = PetscLogBegin_Private();CHKERRQ(ierr);
757a9f03627SSatish Balay #endif
758e5c89e4eSSatish Balay 
759e5c89e4eSSatish Balay   /*
760e5c89e4eSSatish Balay      Load the dynamic libraries (on machines that support them), this registers all
761e5c89e4eSSatish Balay      the solvers etc. (On non-dynamic machines this initializes the PetscDraw and PetscViewer classes)
762e5c89e4eSSatish Balay   */
763e5c89e4eSSatish Balay   ierr = PetscInitialize_DynamicLibraries();CHKERRQ(ierr);
764e5c89e4eSSatish Balay 
765e5c89e4eSSatish Balay   ierr = MPI_Comm_size(PETSC_COMM_WORLD,&size);CHKERRQ(ierr);
766ae15b995SBarry Smith   ierr = PetscInfo1(0,"PETSc successfully started: number of processors = %d\n",size);CHKERRQ(ierr);
767e5c89e4eSSatish Balay   ierr = PetscGetHostName(hostname,256);CHKERRQ(ierr);
768ae15b995SBarry Smith   ierr = PetscInfo1(0,"Running on machine: %s\n",hostname);CHKERRQ(ierr);
769e5c89e4eSSatish Balay 
770e5c89e4eSSatish Balay   ierr = PetscOptionsCheckInitial_Components();CHKERRQ(ierr);
771ef6c6fedSBoyana Norris   /* Check the options database for options related to the options database itself */
772ef6c6fedSBoyana Norris   ierr = PetscOptionsSetFromOptions();CHKERRQ(ierr);
773ef6c6fedSBoyana Norris 
774951e3c8eSBarry Smith #if defined(PETSC_USE_PETSC_MPI_EXTERNAL32)
775e39fd77fSBarry Smith   /*
776e39fd77fSBarry Smith       Tell MPI about our own data representation converter, this would/should be used if extern32 is not supported by the MPI
777e39fd77fSBarry Smith 
778e39fd77fSBarry Smith       Currently not used because it is not supported by MPICH.
779e39fd77fSBarry Smith   */
780e39fd77fSBarry Smith #if !defined(PETSC_WORDS_BIGENDIAN)
781708350f5SSatish Balay   ierr = MPI_Register_datarep((char *)"petsc",PetscDataRep_read_conv_fn,PetscDataRep_write_conv_fn,PetscDataRep_extent_fn,PETSC_NULL);CHKERRQ(ierr);
782e39fd77fSBarry Smith #endif
783951e3c8eSBarry Smith #endif
784e39fd77fSBarry Smith 
785793721a6SBarry Smith   ierr = PetscOptionsGetInt(PETSC_NULL,"-openmp_spawn_size",&nodesize,&flg);CHKERRQ(ierr);
786793721a6SBarry Smith   if (flg) {
78723464e94SBarry Smith #if defined(PETSC_HAVE_MPI_COMM_SPAWN)
7889505b675SBarry Smith     ierr = PetscOpenMPSpawn((PetscMPIInt) nodesize);CHKERRQ(ierr); /* worker nodes never return from here; they go directly to PetscEnd() */
78923464e94SBarry Smith #else
790e32f2f54SBarry Smith     SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SUP,"PETSc built without MPI 2 (MPI_Comm_spawn) support, use -openmp_merge_size instead");
79123464e94SBarry Smith #endif
792793721a6SBarry Smith   } else {
79323464e94SBarry Smith     ierr = PetscOptionsGetInt(PETSC_NULL,"-openmp_merge_size",&nodesize,&flg);CHKERRQ(ierr);
7948002f1cdSBarry Smith     if (flg) {
7959505b675SBarry Smith       ierr = PetscOpenMPMerge((PetscMPIInt) nodesize,PETSC_NULL,PETSC_NULL);CHKERRQ(ierr);
7969505b675SBarry Smith       if (PetscOpenMPWorker) { /* if worker then never enter user code */
7979505b675SBarry Smith         ierr = PetscEnd();
7989505b675SBarry Smith       }
7998002f1cdSBarry Smith     }
800793721a6SBarry Smith   }
801e5c89e4eSSatish Balay 
80235d88935SVictor Minden #if defined(PETSC_HAVE_CUDA)
8032f947c57SVictor Minden   cublasInit();
8043e39abd9SVictor Minden #endif
80592e62aa6SBarry Smith 
80692e62aa6SBarry Smith #if defined(PETSC_HAVE_AMS)
807c457296dSBarry Smith   ierr = PetscOptionsHasName(PETSC_NULL,"-ams_publish_objects",&flg);CHKERRQ(ierr);
80892e62aa6SBarry Smith   if (flg) {
80992e62aa6SBarry Smith     PetscAMSPublishAll = PETSC_TRUE;
81092e62aa6SBarry Smith   }
81192e62aa6SBarry Smith #endif
81292e62aa6SBarry Smith 
8139ac80d5eSLisandro Dalcin   ierr = PetscOptionsHasName(PETSC_NULL,"-python",&flg);CHKERRQ(ierr);
8149ac80d5eSLisandro Dalcin   if (flg) {
8159ac80d5eSLisandro Dalcin     PetscInitializeCalled = PETSC_TRUE;
8169ac80d5eSLisandro Dalcin     ierr = PetscPythonInitialize(PETSC_NULL,PETSC_NULL);CHKERRQ(ierr);
8179ac80d5eSLisandro Dalcin   }
8189ac80d5eSLisandro Dalcin 
819301d30feSBarry Smith   /*
820301d30feSBarry Smith       Once we are completedly initialized then we can set this variables
821301d30feSBarry Smith   */
822301d30feSBarry Smith   PetscInitializeCalled = PETSC_TRUE;
823301d30feSBarry Smith   PetscFunctionReturn(0);
824e5c89e4eSSatish Balay }
825e5c89e4eSSatish Balay 
8262eff7a51SBarry Smith extern PetscObject *PetscObjects;
8272eff7a51SBarry Smith extern PetscInt    PetscObjectsCounts, PetscObjectsMaxCounts;
828e5c89e4eSSatish Balay 
829e5c89e4eSSatish Balay #undef __FUNCT__
830e5c89e4eSSatish Balay #define __FUNCT__ "PetscFinalize"
831e5c89e4eSSatish Balay /*@C
832e5c89e4eSSatish Balay    PetscFinalize - Checks for options to be called at the conclusion
833e5c89e4eSSatish Balay    of the program. MPI_Finalize() is called only if the user had not
834e5c89e4eSSatish Balay    called MPI_Init() before calling PetscInitialize().
835e5c89e4eSSatish Balay 
836e5c89e4eSSatish Balay    Collective on PETSC_COMM_WORLD
837e5c89e4eSSatish Balay 
838e5c89e4eSSatish Balay    Options Database Keys:
83988c29154SBarry Smith +  -options_table - Calls PetscOptionsView()
840e5c89e4eSSatish Balay .  -options_left - Prints unused options that remain in the database
8410a1571b3SBarry Smith .  -objects_left  - Prints list of all objects that have not been freed
842e5c89e4eSSatish Balay .  -mpidump - Calls PetscMPIDump()
843e5c89e4eSSatish Balay .  -malloc_dump - Calls PetscMallocDump()
844e5c89e4eSSatish Balay .  -malloc_info - Prints total memory usage
845e5c89e4eSSatish Balay -  -malloc_log - Prints summary of memory usage
846e5c89e4eSSatish Balay 
847e5c89e4eSSatish Balay    Options Database Keys for Profiling:
8480598bfebSBarry Smith    See the <a href="../../docs/manual.pdf#nameddest=ch_profiling">profiling chapter of the users manual</a> for details.
849e5c89e4eSSatish Balay +  -log_summary [filename] - Prints summary of flop and timing
850e5c89e4eSSatish Balay         information to screen. If the filename is specified the
85191eabc43SBarry Smith         summary is written to the file.  See PetscLogView().
852ff5bc46bSBarry Smith .  -log_summary_python [filename] - Prints data on of flop and timing usage to a file or screen.
85391eabc43SBarry Smith         See PetscLogPrintSViewPython().
854e5c89e4eSSatish Balay .  -log_all [filename] - Logs extensive profiling information
855ff5bc46bSBarry Smith         See PetscLogDump().
856ff5bc46bSBarry Smith .  -log [filename] - Logs basic profiline information  See PetscLogDump().
857e5c89e4eSSatish Balay .  -log_sync - Log the synchronization in scatters, inner products
858e5c89e4eSSatish Balay         and norms
859e5c89e4eSSatish Balay -  -log_mpe [filename] - Creates a logfile viewable by the
860e5c89e4eSSatish Balay       utility Upshot/Nupshot (in MPICH distribution)
861e5c89e4eSSatish Balay 
862e5c89e4eSSatish Balay    Level: beginner
863e5c89e4eSSatish Balay 
864e5c89e4eSSatish Balay    Note:
865e5c89e4eSSatish Balay    See PetscInitialize() for more general runtime options.
866e5c89e4eSSatish Balay 
86788c29154SBarry Smith .seealso: PetscInitialize(), PetscOptionsView(), PetscMallocDump(), PetscMPIDump(), PetscEnd()
868e5c89e4eSSatish Balay @*/
8697087cfbeSBarry Smith PetscErrorCode  PetscFinalize(void)
870e5c89e4eSSatish Balay {
871e5c89e4eSSatish Balay   PetscErrorCode ierr;
872e5c89e4eSSatish Balay   PetscMPIInt    rank;
8732eff7a51SBarry Smith   PetscInt       i,nopt;
8740a1571b3SBarry Smith   PetscBool      flg1 = PETSC_FALSE,flg2 = PETSC_FALSE,flg3 = PETSC_FALSE,objects_left = PETSC_FALSE;
875d5649816SBarry Smith #if defined(PETSC_HAVE_AMS)
876ace3abfcSBarry Smith   PetscBool      flg = PETSC_FALSE;
877d5649816SBarry Smith #endif
87810463e74SBarry Smith #if defined(PETSC_USE_LOG)
87910463e74SBarry Smith   char           mname[PETSC_MAX_PATH_LEN];
88010463e74SBarry Smith #endif
881e5c89e4eSSatish Balay 
882e5c89e4eSSatish Balay   PetscFunctionBegin;
883e5c89e4eSSatish Balay 
884e5c89e4eSSatish Balay   if (!PetscInitializeCalled) {
8854b09e917SBarry Smith     printf("PetscInitialize() must be called before PetscFinalize()\n");
8864b09e917SBarry Smith     PetscFunctionReturn(PETSC_ERR_ARG_WRONGSTATE);
887e5c89e4eSSatish Balay   }
888b022a5c1SBarry Smith   ierr = PetscInfo(PETSC_NULL,"PetscFinalize() called\n");
889b022a5c1SBarry Smith 
890d5649816SBarry Smith #if defined(PETSC_HAVE_AMS)
891acfcf0e5SJed Brown   ierr = PetscOptionsGetBool(PETSC_NULL,"-options_gui",&flg,PETSC_NULL);CHKERRQ(ierr);
892d5649816SBarry Smith   if (flg) {
893d5649816SBarry Smith     ierr = PetscOptionsAMSDestroy();CHKERRQ(ierr);
894d5649816SBarry Smith   }
895d5649816SBarry Smith #endif
896d5649816SBarry Smith 
8978002f1cdSBarry Smith   ierr = PetscOpenMPFinalize();CHKERRQ(ierr);
898*fc087633SBarry Smith #if defined(PETSC_USE_PTHREAD_CLASSES)
899*fc087633SBarry Smith   if (PetscThreadFinalize) {
900*fc087633SBarry Smith     ierr = (*PetscThreadFinalize)();CHKERRQ(ierr);
901*fc087633SBarry Smith   }
902*fc087633SBarry Smith #endif
9030ca81413SKerry Stevens 
904e5c89e4eSSatish Balay   ierr = MPI_Comm_rank(PETSC_COMM_WORLD,&rank);CHKERRQ(ierr);
905acfcf0e5SJed Brown   ierr = PetscOptionsGetBool(PETSC_NULL,"-malloc_info",&flg2,PETSC_NULL);CHKERRQ(ierr);
906e5c89e4eSSatish Balay   if (!flg2) {
90790d69ab7SBarry Smith     flg2 = PETSC_FALSE;
908acfcf0e5SJed Brown     ierr = PetscOptionsGetBool(PETSC_NULL,"-memory_info",&flg2,PETSC_NULL);CHKERRQ(ierr);
909e5c89e4eSSatish Balay   }
910e5c89e4eSSatish Balay   if (flg2) {
911e5c89e4eSSatish Balay     ierr = PetscMemoryShowUsage(PETSC_VIEWER_STDOUT_WORLD,"Summary of Memory Usage in PETSc\n");CHKERRQ(ierr);
912e5c89e4eSSatish Balay   }
913e5c89e4eSSatish Balay 
914e5c89e4eSSatish Balay #if defined(PETSC_USE_LOG)
91590d69ab7SBarry Smith   flg1 = PETSC_FALSE;
916acfcf0e5SJed Brown   ierr = PetscOptionsGetBool(PETSC_NULL,"-get_total_flops",&flg1,PETSC_NULL);CHKERRQ(ierr);
917e5c89e4eSSatish Balay   if (flg1) {
918e5c89e4eSSatish Balay     PetscLogDouble flops = 0;
919e5c89e4eSSatish Balay     ierr = MPI_Reduce(&_TotalFlops,&flops,1,MPI_DOUBLE,MPI_SUM,0,PETSC_COMM_WORLD);CHKERRQ(ierr);
920e5c89e4eSSatish Balay     ierr = PetscPrintf(PETSC_COMM_WORLD,"Total flops over all processors %g\n",flops);CHKERRQ(ierr);
921e5c89e4eSSatish Balay   }
922e5c89e4eSSatish Balay #endif
923e5c89e4eSSatish Balay 
924e5c89e4eSSatish Balay 
925e5c89e4eSSatish Balay #if defined(PETSC_USE_LOG)
926e5c89e4eSSatish Balay #if defined(PETSC_HAVE_MPE)
927e5c89e4eSSatish Balay   mname[0] = 0;
928e5c89e4eSSatish Balay   ierr = PetscOptionsGetString(PETSC_NULL,"-log_mpe",mname,PETSC_MAX_PATH_LEN,&flg1);CHKERRQ(ierr);
929e5c89e4eSSatish Balay   if (flg1){
930e5c89e4eSSatish Balay     if (mname[0]) {ierr = PetscLogMPEDump(mname);CHKERRQ(ierr);}
931e5c89e4eSSatish Balay     else          {ierr = PetscLogMPEDump(0);CHKERRQ(ierr);}
932e5c89e4eSSatish Balay   }
933e5c89e4eSSatish Balay #endif
934e5c89e4eSSatish Balay   mname[0] = 0;
935e5c89e4eSSatish Balay   ierr = PetscOptionsGetString(PETSC_NULL,"-log_summary",mname,PETSC_MAX_PATH_LEN,&flg1);CHKERRQ(ierr);
936e5c89e4eSSatish Balay   if (flg1) {
93791eabc43SBarry Smith     PetscViewer viewer;
93891eabc43SBarry Smith     if (mname[0])  {
93991eabc43SBarry Smith       ierr = PetscViewerASCIIOpen(PETSC_COMM_WORLD,mname,&viewer);CHKERRQ(ierr);
94091eabc43SBarry Smith       ierr = PetscLogView(viewer);CHKERRQ(ierr);
9416bf464f9SBarry Smith       ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr);
94233f85c2fSBarry Smith     } else {
94333f85c2fSBarry Smith       viewer = PETSC_VIEWER_STDOUT_WORLD;
94433f85c2fSBarry Smith       ierr = PetscLogView(viewer);CHKERRQ(ierr);
94533f85c2fSBarry Smith     }
946e5c89e4eSSatish Balay   }
947e5c89e4eSSatish Balay 
948ff5bc46bSBarry Smith   mname[0] = 0;
949ff5bc46bSBarry Smith   ierr = PetscOptionsGetString(PETSC_NULL,"-log_summary_python",mname,PETSC_MAX_PATH_LEN,&flg1);CHKERRQ(ierr);
950ff5bc46bSBarry Smith   if (flg1) {
951ff5bc46bSBarry Smith     PetscViewer viewer;
952ff5bc46bSBarry Smith     if (mname[0])  {
953ff5bc46bSBarry Smith       ierr = PetscViewerASCIIOpen(PETSC_COMM_WORLD,mname,&viewer);CHKERRQ(ierr);
95491eabc43SBarry Smith       ierr = PetscLogViewPython(viewer);CHKERRQ(ierr);
9556bf464f9SBarry Smith       ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr);
95633f85c2fSBarry Smith     } else {
95733f85c2fSBarry Smith       viewer = PETSC_VIEWER_STDOUT_WORLD;
95833f85c2fSBarry Smith       ierr = PetscLogViewPython(viewer);CHKERRQ(ierr);
95933f85c2fSBarry Smith     }
960ff5bc46bSBarry Smith   }
961ff5bc46bSBarry Smith 
96278392ef1SBarry Smith   ierr = PetscOptionsGetString(PETSC_NULL,"-log_detailed",mname,PETSC_MAX_PATH_LEN,&flg1);CHKERRQ(ierr);
96378392ef1SBarry Smith   if (flg1) {
96478392ef1SBarry Smith     if (mname[0])  {ierr = PetscLogPrintDetailed(PETSC_COMM_WORLD,mname);CHKERRQ(ierr);}
96578392ef1SBarry Smith     else           {ierr = PetscLogPrintDetailed(PETSC_COMM_WORLD,0);CHKERRQ(ierr);}
96678392ef1SBarry Smith   }
96778392ef1SBarry Smith 
968e5c89e4eSSatish Balay   mname[0] = 0;
969e5c89e4eSSatish Balay   ierr = PetscOptionsGetString(PETSC_NULL,"-log_all",mname,PETSC_MAX_PATH_LEN,&flg1);CHKERRQ(ierr);
970e5c89e4eSSatish Balay   ierr = PetscOptionsGetString(PETSC_NULL,"-log",mname,PETSC_MAX_PATH_LEN,&flg2);CHKERRQ(ierr);
971e5c89e4eSSatish Balay   if (flg1 || flg2){
972e5c89e4eSSatish Balay     if (mname[0]) PetscLogDump(mname);
973e5c89e4eSSatish Balay     else          PetscLogDump(0);
974e5c89e4eSSatish Balay   }
975e5c89e4eSSatish Balay #endif
97610463e74SBarry Smith 
97733f85c2fSBarry Smith #if defined(PETSC_USE_DEBUG) && !defined(PETSC_USE_PTHREAD)
97833f85c2fSBarry Smith   if (PetscStackActive) {
97933f85c2fSBarry Smith     ierr = PetscStackDestroy();CHKERRQ(ierr);
98033f85c2fSBarry Smith   }
98133f85c2fSBarry Smith #endif
98210463e74SBarry Smith 
98390d69ab7SBarry Smith   flg1 = PETSC_FALSE;
984acfcf0e5SJed Brown   ierr = PetscOptionsGetBool(PETSC_NULL,"-no_signal_handler",&flg1,PETSC_NULL);CHKERRQ(ierr);
985e5c89e4eSSatish Balay   if (!flg1) { ierr = PetscPopSignalHandler();CHKERRQ(ierr);}
98690d69ab7SBarry Smith   flg1 = PETSC_FALSE;
987acfcf0e5SJed Brown   ierr = PetscOptionsGetBool(PETSC_NULL,"-mpidump",&flg1,PETSC_NULL);CHKERRQ(ierr);
988e5c89e4eSSatish Balay   if (flg1) {
989e5c89e4eSSatish Balay     ierr = PetscMPIDump(stdout);CHKERRQ(ierr);
990e5c89e4eSSatish Balay   }
99190d69ab7SBarry Smith   flg1 = PETSC_FALSE;
99290d69ab7SBarry Smith   flg2 = PETSC_FALSE;
9938bb29257SSatish Balay   /* preemptive call to avoid listing this option in options table as unused */
9948bb29257SSatish Balay   ierr = PetscOptionsHasName(PETSC_NULL,"-malloc_dump",&flg1);CHKERRQ(ierr);
995acfcf0e5SJed Brown   ierr = PetscOptionsGetBool(PETSC_NULL,"-options_table",&flg2,PETSC_NULL);CHKERRQ(ierr);
996e4c476e2SSatish Balay 
997e5c89e4eSSatish Balay   if (flg2) {
99819fcac0cSJed Brown     ierr = PetscOptionsView(PETSC_VIEWER_STDOUT_WORLD);CHKERRQ(ierr);
999e5c89e4eSSatish Balay   }
1000e5c89e4eSSatish Balay 
1001e5c89e4eSSatish Balay   /* to prevent PETSc -options_left from warning */
1002cb9801acSJed Brown   ierr = PetscOptionsHasName(PETSC_NULL,"-nox",&flg1);CHKERRQ(ierr);
1003cb9801acSJed Brown   ierr = PetscOptionsHasName(PETSC_NULL,"-nox_warning",&flg1);CHKERRQ(ierr);
10040a1571b3SBarry Smith   ierr = PetscOptionsGetBool(PETSC_NULL,"-objects_left",&objects_left,PETSC_NULL);CHKERRQ(ierr);
1005e5c89e4eSSatish Balay 
1006f43cc0c9SSatish Balay   if (!PetscOpenMPWorker) { /* worker processes skip this because they do not usually process options */
100733fc4174SSatish Balay     flg3 = PETSC_FALSE; /* default value is required */
1008acfcf0e5SJed Brown     ierr = PetscOptionsGetBool(PETSC_NULL,"-options_left",&flg3,&flg1);CHKERRQ(ierr);
1009e5c89e4eSSatish Balay     ierr = PetscOptionsAllUsed(&nopt);CHKERRQ(ierr);
1010e5c89e4eSSatish Balay     if (flg3) {
1011e5c89e4eSSatish Balay       if (!flg2) { /* have not yet printed the options */
101233f85c2fSBarry Smith 	ierr = PetscOptionsView(PETSC_VIEWER_STDOUT_WORLD);CHKERRQ(ierr);
1013e5c89e4eSSatish Balay       }
1014e5c89e4eSSatish Balay       if (!nopt) {
1015e5c89e4eSSatish Balay 	ierr = PetscPrintf(PETSC_COMM_WORLD,"There are no unused options.\n");CHKERRQ(ierr);
1016e5c89e4eSSatish Balay       } else if (nopt == 1) {
1017e5c89e4eSSatish Balay 	ierr = PetscPrintf(PETSC_COMM_WORLD,"There is one unused database option. It is:\n");CHKERRQ(ierr);
1018e5c89e4eSSatish Balay       } else {
1019e5c89e4eSSatish Balay 	ierr = PetscPrintf(PETSC_COMM_WORLD,"There are %d unused database options. They are:\n",nopt);CHKERRQ(ierr);
1020e5c89e4eSSatish Balay       }
1021e5c89e4eSSatish Balay     }
1022e5c89e4eSSatish Balay #if defined(PETSC_USE_DEBUG)
1023da8b8a77SBarry Smith     if (nopt && !flg3 && !flg1) {
1024e5c89e4eSSatish Balay       ierr = PetscPrintf(PETSC_COMM_WORLD,"WARNING! There are options you set that were not used!\n");CHKERRQ(ierr);
1025e5c89e4eSSatish Balay       ierr = PetscPrintf(PETSC_COMM_WORLD,"WARNING! could be spelling mistake, etc!\n");CHKERRQ(ierr);
1026e5c89e4eSSatish Balay       ierr = PetscOptionsLeft();CHKERRQ(ierr);
1027e5c89e4eSSatish Balay     } else if (nopt && flg3) {
1028e5c89e4eSSatish Balay #else
1029e5c89e4eSSatish Balay     if (nopt && flg3) {
1030e5c89e4eSSatish Balay #endif
1031e5c89e4eSSatish Balay       ierr = PetscOptionsLeft();CHKERRQ(ierr);
1032e5c89e4eSSatish Balay     }
1033931f367cSBarry Smith   }
1034e5c89e4eSSatish Balay 
103510463e74SBarry Smith   /*
103633f85c2fSBarry Smith      Free all objects registered with PetscObjectRegisterDestroy() such as PETSC_VIEWER_XXX_().
103733f85c2fSBarry Smith   */
103833f85c2fSBarry Smith   ierr = PetscObjectRegisterDestroyAll();CHKERRQ(ierr);
103933f85c2fSBarry Smith 
10402eff7a51SBarry Smith   /*
1041dbc8283eSBarry Smith        List all objects the user may have forgot to free
10422eff7a51SBarry Smith   */
10430a1571b3SBarry Smith   if (objects_left && PetscObjectsCounts) {
1044dbc8283eSBarry Smith     ierr = PetscPrintf(PETSC_COMM_WORLD,"The following objects %D were never freed\n",PetscObjectsCounts);
10450a1571b3SBarry Smith   }
10462eff7a51SBarry Smith   for (i=0; i<PetscObjectsMaxCounts; i++) {
10472eff7a51SBarry Smith     if (PetscObjects[i]) {
10480a1571b3SBarry Smith       if (objects_left) {
10490a1571b3SBarry Smith         ierr = PetscPrintf(PETSC_COMM_WORLD,"  %s %s %s\n",PetscObjects[i]->class_name,PetscObjects[i]->type_name,PetscObjects[i]->name);CHKERRQ(ierr);
10500a1571b3SBarry Smith       }
10512eff7a51SBarry Smith     }
10522eff7a51SBarry Smith   }
1053dbc8283eSBarry Smith   /* cannot actually destroy the left over objects, but destroy the list */
1054dbc8283eSBarry Smith   PetscObjectsCounts    = 0;
1055dbc8283eSBarry Smith   PetscObjectsMaxCounts = 0;
1056dbc8283eSBarry Smith   ierr = PetscFree(PetscObjects);CHKERRQ(ierr);
10572eff7a51SBarry Smith 
10582eff7a51SBarry Smith 
105933f85c2fSBarry Smith #if defined(PETSC_USE_LOG)
106033f85c2fSBarry Smith   ierr = PetscLogDestroy();CHKERRQ(ierr);
106133f85c2fSBarry Smith #endif
106233f85c2fSBarry Smith 
106333f85c2fSBarry Smith   /*
106433f85c2fSBarry Smith        Free all the registered create functions, such as KSPList, VecList, SNESList, etc
106533f85c2fSBarry Smith   */
106633f85c2fSBarry Smith   ierr = PetscFListDestroyAll();CHKERRQ(ierr);
106733f85c2fSBarry Smith 
106833f85c2fSBarry Smith   /*
106933f85c2fSBarry Smith      Destroy any packages that registered a finalize
107033f85c2fSBarry Smith   */
107133f85c2fSBarry Smith   ierr = PetscRegisterFinalizeAll();CHKERRQ(ierr);
107233f85c2fSBarry Smith 
107333f85c2fSBarry Smith   /*
107410463e74SBarry Smith      Destroy all the function registration lists created
107510463e74SBarry Smith   */
107610463e74SBarry Smith   ierr = PetscFinalize_DynamicLibraries();CHKERRQ(ierr);
107710463e74SBarry Smith 
10784028d114SSatish Balay   if (petsc_history) {
1079f3dea69dSBarry Smith     ierr = PetscCloseHistoryFile(&petsc_history);CHKERRQ(ierr);
1080e5c89e4eSSatish Balay     petsc_history = 0;
1081e5c89e4eSSatish Balay   }
1082e5c89e4eSSatish Balay 
10836cf91177SBarry Smith   ierr = PetscInfoAllow(PETSC_FALSE,PETSC_NULL);CHKERRQ(ierr);
1084e5c89e4eSSatish Balay 
10858bb29257SSatish Balay   {
1086e5c89e4eSSatish Balay     char fname[PETSC_MAX_PATH_LEN];
1087e5c89e4eSSatish Balay     FILE *fd;
1088ed9cf6e9SBarry Smith     int  err;
1089e5c89e4eSSatish Balay 
1090e5c89e4eSSatish Balay     fname[0] = 0;
1091e5c89e4eSSatish Balay     ierr = PetscOptionsGetString(PETSC_NULL,"-malloc_dump",fname,250,&flg1);CHKERRQ(ierr);
1092e5c89e4eSSatish Balay     if (flg1 && fname[0]) {
1093e5c89e4eSSatish Balay       char sname[PETSC_MAX_PATH_LEN];
1094e5c89e4eSSatish Balay 
1095e5c89e4eSSatish Balay       sprintf(sname,"%s_%d",fname,rank);
1096e32f2f54SBarry Smith       fd   = fopen(sname,"w"); if (!fd) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_FILE_OPEN,"Cannot open log file: %s",sname);
1097e5c89e4eSSatish Balay       ierr = PetscMallocDump(fd);CHKERRQ(ierr);
1098ed9cf6e9SBarry Smith       err = fclose(fd);
1099e32f2f54SBarry Smith       if (err) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SYS,"fclose() failed on file");
11008bb29257SSatish Balay     } else if (flg1) {
1101e5c89e4eSSatish Balay       MPI_Comm local_comm;
1102e5c89e4eSSatish Balay 
1103e5c89e4eSSatish Balay       ierr = MPI_Comm_dup(MPI_COMM_WORLD,&local_comm);CHKERRQ(ierr);
1104e5c89e4eSSatish Balay       ierr = PetscSequentialPhaseBegin_Private(local_comm,1);CHKERRQ(ierr);
1105e5c89e4eSSatish Balay         ierr = PetscMallocDump(stdout);CHKERRQ(ierr);
1106e5c89e4eSSatish Balay       ierr = PetscSequentialPhaseEnd_Private(local_comm,1);CHKERRQ(ierr);
1107e5c89e4eSSatish Balay       ierr = MPI_Comm_free(&local_comm);CHKERRQ(ierr);
1108e5c89e4eSSatish Balay     }
1109e5c89e4eSSatish Balay   }
11108bb29257SSatish Balay   {
1111e5c89e4eSSatish Balay     char fname[PETSC_MAX_PATH_LEN];
1112e5c89e4eSSatish Balay     FILE *fd;
1113e5c89e4eSSatish Balay 
1114e5c89e4eSSatish Balay     fname[0] = 0;
1115e5c89e4eSSatish Balay     ierr = PetscOptionsGetString(PETSC_NULL,"-malloc_log",fname,250,&flg1);CHKERRQ(ierr);
1116e5c89e4eSSatish Balay     if (flg1 && fname[0]) {
1117e5c89e4eSSatish Balay       char sname[PETSC_MAX_PATH_LEN];
1118ed9cf6e9SBarry Smith       int  err;
1119e5c89e4eSSatish Balay 
1120e5c89e4eSSatish Balay       sprintf(sname,"%s_%d",fname,rank);
1121e32f2f54SBarry Smith       fd   = fopen(sname,"w"); if (!fd) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_FILE_OPEN,"Cannot open log file: %s",sname);
1122e5c89e4eSSatish Balay       ierr = PetscMallocDumpLog(fd);CHKERRQ(ierr);
1123ed9cf6e9SBarry Smith       err = fclose(fd);
1124e32f2f54SBarry Smith       if (err) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SYS,"fclose() failed on file");
11258bb29257SSatish Balay     } else if (flg1) {
1126e5c89e4eSSatish Balay       ierr = PetscMallocDumpLog(stdout);CHKERRQ(ierr);
1127e5c89e4eSSatish Balay     }
1128e5c89e4eSSatish Balay   }
1129e5c89e4eSSatish Balay   /* Can be destroyed only after all the options are used */
1130e5c89e4eSSatish Balay   ierr = PetscOptionsDestroy();CHKERRQ(ierr);
1131e5c89e4eSSatish Balay 
1132e5c89e4eSSatish Balay   PetscGlobalArgc = 0;
1133e5c89e4eSSatish Balay   PetscGlobalArgs = 0;
1134e5c89e4eSSatish Balay 
1135ce63c4c1SBarry Smith #if defined(PETSC_USE_REAL___FLOAT128)
1136c90a1750SBarry Smith   ierr = MPI_Type_free(&MPIU___FLOAT128);CHKERRQ(ierr);
1137854411e3SBarry Smith   ierr = MPI_Op_free(&MPIU_SUM);CHKERRQ(ierr);
1138d9822059SBarry Smith   ierr = MPI_Op_free(&MPIU_MAX);CHKERRQ(ierr);
1139d9822059SBarry Smith   ierr = MPI_Op_free(&MPIU_MIN);CHKERRQ(ierr);
1140c90a1750SBarry Smith #endif
1141c90a1750SBarry Smith 
1142e5c89e4eSSatish Balay #if defined(PETSC_USE_COMPLEX)
11432c876bd9SBarry Smith #if !defined(PETSC_HAVE_MPI_C_DOUBLE_COMPLEX)
114406a205a8SBarry Smith   ierr = MPI_Op_free(&MPIU_SUM);CHKERRQ(ierr);
11452c876bd9SBarry Smith   ierr = MPI_Type_free(&MPI_C_DOUBLE_COMPLEX);CHKERRQ(ierr);
1146a83b8d76SBarry Smith   ierr = MPI_Type_free(&MPI_C_COMPLEX);CHKERRQ(ierr);
11472c876bd9SBarry Smith #endif
1148e5c89e4eSSatish Balay #endif
1149e5c89e4eSSatish Balay   ierr = MPI_Type_free(&MPIU_2SCALAR);CHKERRQ(ierr);
1150e5c89e4eSSatish Balay   ierr = MPI_Type_free(&MPIU_2INT);CHKERRQ(ierr);
1151e5c89e4eSSatish Balay   ierr = MPI_Op_free(&PetscMaxSum_Op);CHKERRQ(ierr);
1152e5c89e4eSSatish Balay   ierr = MPI_Op_free(&PetscADMax_Op);CHKERRQ(ierr);
1153e5c89e4eSSatish Balay   ierr = MPI_Op_free(&PetscADMin_Op);CHKERRQ(ierr);
1154e5c89e4eSSatish Balay 
1155dbc8283eSBarry Smith   /*
1156dbc8283eSBarry Smith      Destroy any known inner communicators and attributes pointing to them
1157dbc8283eSBarry Smith      Note this will not destroy any new communicators the user has created
1158dbc8283eSBarry Smith  */
1159b770b1f6SSatish Balay   {
1160dbc8283eSBarry Smith     PetscCommCounter *counter;
1161dbc8283eSBarry Smith     PetscMPIInt      flg;
1162dbc8283eSBarry Smith     MPI_Comm         icomm;
1163dbc8283eSBarry Smith     void             *ptr;
1164dbc8283eSBarry Smith     ierr  = MPI_Attr_get(PETSC_COMM_SELF,Petsc_InnerComm_keyval,&ptr,&flg);CHKERRQ(ierr);
1165dbc8283eSBarry Smith     if (flg) {
1166dbc8283eSBarry Smith       /*  Use PetscMemcpy() because casting from pointer to integer of different size is not allowed with some compilers  */
1167dbc8283eSBarry Smith       ierr = PetscMemcpy(&icomm,&ptr,sizeof(MPI_Comm));CHKERRQ(ierr);
1168dbc8283eSBarry Smith       ierr = MPI_Attr_get(icomm,Petsc_Counter_keyval,&counter,&flg);CHKERRQ(ierr);
1169dbc8283eSBarry 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");
1170dbc8283eSBarry Smith 
1171dbc8283eSBarry Smith       ierr = MPI_Attr_delete(icomm,Petsc_Counter_keyval);CHKERRQ(ierr);
1172dbc8283eSBarry Smith       ierr = MPI_Attr_delete(icomm,Petsc_OuterComm_keyval);CHKERRQ(ierr);
1173dbc8283eSBarry Smith       ierr = MPI_Comm_free(&icomm);CHKERRQ(ierr);
1174dbc8283eSBarry Smith       ierr = MPI_Attr_delete(PETSC_COMM_SELF,Petsc_InnerComm_keyval);CHKERRQ(ierr);
1175dbc8283eSBarry Smith     }
1176dbc8283eSBarry Smith     ierr  = MPI_Attr_get(PETSC_COMM_WORLD,Petsc_InnerComm_keyval,&ptr,&flg);CHKERRQ(ierr);
1177dbc8283eSBarry Smith     if (flg) {
1178dbc8283eSBarry Smith       /*  Use PetscMemcpy() because casting from pointer to integer of different size is not allowed with some compilers  */
1179dbc8283eSBarry Smith       ierr = PetscMemcpy(&icomm,&ptr,sizeof(MPI_Comm));CHKERRQ(ierr);
1180dbc8283eSBarry Smith       ierr = MPI_Attr_get(icomm,Petsc_Counter_keyval,&counter,&flg);CHKERRQ(ierr);
1181dbc8283eSBarry 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");
1182dbc8283eSBarry Smith 
1183dbc8283eSBarry Smith       ierr = MPI_Attr_delete(icomm,Petsc_Counter_keyval);CHKERRQ(ierr);
1184dbc8283eSBarry Smith       ierr = MPI_Attr_delete(icomm,Petsc_OuterComm_keyval);CHKERRQ(ierr);
1185dbc8283eSBarry Smith       ierr = MPI_Comm_free(&icomm);CHKERRQ(ierr);
1186dbc8283eSBarry Smith       ierr = MPI_Attr_delete(PETSC_COMM_WORLD,Petsc_InnerComm_keyval);CHKERRQ(ierr);
1187dbc8283eSBarry Smith     }
1188b770b1f6SSatish Balay   }
1189dbc8283eSBarry Smith 
1190480cf27aSJed Brown   ierr = MPI_Keyval_free(&Petsc_Counter_keyval);CHKERRQ(ierr);
1191480cf27aSJed Brown   ierr = MPI_Keyval_free(&Petsc_InnerComm_keyval);CHKERRQ(ierr);
1192480cf27aSJed Brown   ierr = MPI_Keyval_free(&Petsc_OuterComm_keyval);CHKERRQ(ierr);
1193480cf27aSJed Brown 
1194ae15b995SBarry Smith   ierr = PetscInfo(0,"PETSc successfully ended!\n");CHKERRQ(ierr);
1195e5c89e4eSSatish Balay   if (PetscBeganMPI) {
119699608316SBarry Smith #if defined(PETSC_HAVE_MPI_FINALIZED)
119799b1327fSBarry Smith     PetscMPIInt flag;
119899b1327fSBarry Smith     ierr = MPI_Finalized(&flag);CHKERRQ(ierr);
1199e32f2f54SBarry Smith     if (flag) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_LIB,"MPI_Finalize() has already been called, even though MPI_Init() was called by PetscInitialize()");
120099608316SBarry Smith #endif
1201e5c89e4eSSatish Balay     ierr = MPI_Finalize();CHKERRQ(ierr);
1202e5c89e4eSSatish Balay   }
1203e5c89e4eSSatish Balay 
12049c4c166aSBarry Smith   if (PETSC_ZOPEFD){
120522b84c2fSbcordonn     if (PETSC_ZOPEFD != PETSC_STDOUT) fprintf(PETSC_ZOPEFD, "<<<end>>>");
12069c4c166aSBarry Smith     else fprintf(PETSC_STDOUT, "<<<end>>>");
12079c4c166aSBarry Smith   }
120836186564Sbcordonn 
120935d88935SVictor Minden #if defined(PETSC_HAVE_CUDA)
12102f947c57SVictor Minden   cublasShutdown();
1211440a5bbfSVictor Minden #endif
1212e5c89e4eSSatish Balay /*
1213e5c89e4eSSatish Balay 
1214e5c89e4eSSatish Balay      Note: In certain cases PETSC_COMM_WORLD is never MPI_Comm_free()ed because
1215e5c89e4eSSatish Balay    the communicator has some outstanding requests on it. Specifically if the
1216e5c89e4eSSatish Balay    flag PETSC_HAVE_BROKEN_REQUEST_FREE is set (for IBM MPI implementation). See
1217e5c89e4eSSatish Balay    src/vec/utils/vpscat.c. Due to this the memory allocated in PetscCommDuplicate()
1218e5c89e4eSSatish Balay    is never freed as it should be. Thus one may obtain messages of the form
12190e5e90baSSatish Balay    [ 1] 8 bytes PetscCommDuplicate() line 645 in src/sys/mpiu.c indicating the
1220e5c89e4eSSatish Balay    memory was not freed.
1221e5c89e4eSSatish Balay 
1222e5c89e4eSSatish Balay */
12231d1a0024SBarry Smith   ierr = PetscMallocClear();CHKERRQ(ierr);
1224e5c89e4eSSatish Balay   PetscInitializeCalled = PETSC_FALSE;
1225e5c89e4eSSatish Balay   PetscFinalizeCalled   = PETSC_TRUE;
1226e5c89e4eSSatish Balay   PetscFunctionReturn(ierr);
1227e5c89e4eSSatish Balay }
1228e5c89e4eSSatish Balay 
1229