xref: /petsc/src/sys/objects/pinit.c (revision 40ab9619e392b3f556aa44976dc0e673a12bb605)
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 
901ea5a559SBarry Smith      Turns off PETSc signal handling because that can interact with MATLAB's signal handling causing random crashes.
911ea5a559SBarry Smith 
9272a42c3cSBarry Smith .seealso: PetscInitialize(), PetscInitializeFortran(), PetscInitializeNoArguments()
930f11a792SBarry Smith */
940f11a792SBarry Smith PetscErrorCode  PetscInitializeMatlab(int argc,char **args,const char *filename,const char *help)
9572a42c3cSBarry Smith {
9672a42c3cSBarry Smith   PetscErrorCode ierr;
9772a42c3cSBarry Smith   int            myargc = argc;
9872a42c3cSBarry Smith   char           **myargs = args;
9972a42c3cSBarry Smith 
10072a42c3cSBarry Smith   PetscFunctionBegin;
10172a42c3cSBarry Smith   ierr = PetscInitialize(&myargc,&myargs,filename,help);
1021ea5a559SBarry Smith   ierr = PetscPopSignalHandler();CHKERRQ(ierr);
103df413903SBarry Smith   PetscBeganMPI = PETSC_FALSE;
10472a42c3cSBarry Smith   PetscFunctionReturn(ierr);
10572a42c3cSBarry Smith }
10672a42c3cSBarry Smith 
10772a42c3cSBarry Smith #undef __FUNCT__
1080f11a792SBarry Smith #define __FUNCT__ "PetscInitializedMatlab"
1090f11a792SBarry Smith /*
1100f11a792SBarry Smith       PetscInitializedMatlab - Has PETSc been initialized already?
1110f11a792SBarry Smith 
1120f11a792SBarry Smith    Not Collective
1130f11a792SBarry Smith 
1140f11a792SBarry Smith    Level: advanced
1150f11a792SBarry Smith 
1160f11a792SBarry Smith     Notes: this is called only by the PETSc MATLAB interface.
1170f11a792SBarry Smith 
1180f11a792SBarry Smith .seealso: PetscInitialize(), PetscInitializeFortran(), PetscInitializeNoArguments()
1190f11a792SBarry Smith */
1200f11a792SBarry Smith int  PetscInitializedMatlab(void)
1210f11a792SBarry Smith {
1220f11a792SBarry Smith   PetscBool flg;
1230f11a792SBarry Smith 
1240f11a792SBarry Smith   PetscInitialized(&flg);
1250f11a792SBarry Smith   if (flg) return 1;
1260f11a792SBarry Smith   else return 0;
1270f11a792SBarry Smith }
1280f11a792SBarry Smith 
1290f11a792SBarry Smith #undef __FUNCT__
1300f11a792SBarry Smith #define __FUNCT__ "PetscGetPETSC_COMM_SELFMatlab"
131f0865b08SBarry Smith /*
132e3c5b3baSBarry Smith       Used by MATLAB interface to get communicator
133f0865b08SBarry Smith */
1340f11a792SBarry Smith PetscErrorCode  PetscGetPETSC_COMM_SELFMatlab(MPI_Comm *comm)
135f0865b08SBarry Smith {
136f0865b08SBarry Smith   PetscFunctionBegin;
137f0865b08SBarry Smith   *comm = PETSC_COMM_SELF;
138f0865b08SBarry Smith   PetscFunctionReturn(0);
139f0865b08SBarry Smith }
1400f11a792SBarry Smith #endif
141f0865b08SBarry Smith 
142f0865b08SBarry Smith #undef __FUNCT__
143e5c89e4eSSatish Balay #define __FUNCT__ "PetscInitializeNoArguments"
144e5c89e4eSSatish Balay /*@C
145e5c89e4eSSatish Balay       PetscInitializeNoArguments - Calls PetscInitialize() from C/C++ without
146e5c89e4eSSatish Balay         the command line arguments.
147e5c89e4eSSatish Balay 
148e5c89e4eSSatish Balay    Collective
149e5c89e4eSSatish Balay 
150e5c89e4eSSatish Balay    Level: advanced
151e5c89e4eSSatish Balay 
152e5c89e4eSSatish Balay .seealso: PetscInitialize(), PetscInitializeFortran()
153e5c89e4eSSatish Balay @*/
1547087cfbeSBarry Smith PetscErrorCode  PetscInitializeNoArguments(void)
155e5c89e4eSSatish Balay {
156e5c89e4eSSatish Balay   PetscErrorCode ierr;
157e5c89e4eSSatish Balay   int            argc = 0;
158e5c89e4eSSatish Balay   char           **args = 0;
159e5c89e4eSSatish Balay 
160e5c89e4eSSatish Balay   PetscFunctionBegin;
161e5c89e4eSSatish Balay   ierr = PetscInitialize(&argc,&args,PETSC_NULL,PETSC_NULL);
162e5c89e4eSSatish Balay   PetscFunctionReturn(ierr);
163e5c89e4eSSatish Balay }
164e5c89e4eSSatish Balay 
165e5c89e4eSSatish Balay #undef __FUNCT__
166e5c89e4eSSatish Balay #define __FUNCT__ "PetscInitialized"
167e5c89e4eSSatish Balay /*@
168e5c89e4eSSatish Balay       PetscInitialized - Determine whether PETSc is initialized.
169e5c89e4eSSatish Balay 
1706dc8fec2Sbcordonn 7   Level: beginner
171e5c89e4eSSatish Balay 
172e5c89e4eSSatish Balay .seealso: PetscInitialize(), PetscInitializeNoArguments(), PetscInitializeFortran()
173e5c89e4eSSatish Balay @*/
1747087cfbeSBarry Smith PetscErrorCode  PetscInitialized(PetscBool  *isInitialized)
175e5c89e4eSSatish Balay {
176e5c89e4eSSatish Balay   PetscFunctionBegin;
177e5c89e4eSSatish Balay   PetscValidPointer(isInitialized, 1);
178e5c89e4eSSatish Balay   *isInitialized = PetscInitializeCalled;
179e5c89e4eSSatish Balay   PetscFunctionReturn(0);
180e5c89e4eSSatish Balay }
181e5c89e4eSSatish Balay 
182e5c89e4eSSatish Balay #undef __FUNCT__
183e5c89e4eSSatish Balay #define __FUNCT__ "PetscFinalized"
184e5c89e4eSSatish Balay /*@
185e5c89e4eSSatish Balay       PetscFinalized - Determine whether PetscFinalize() has been called yet
186e5c89e4eSSatish Balay 
187e5c89e4eSSatish Balay    Level: developer
188e5c89e4eSSatish Balay 
189e5c89e4eSSatish Balay .seealso: PetscInitialize(), PetscInitializeNoArguments(), PetscInitializeFortran()
190e5c89e4eSSatish Balay @*/
1917087cfbeSBarry Smith PetscErrorCode  PetscFinalized(PetscBool  *isFinalized)
192e5c89e4eSSatish Balay {
193e5c89e4eSSatish Balay   PetscFunctionBegin;
194e5c89e4eSSatish Balay   PetscValidPointer(isFinalized, 1);
195e5c89e4eSSatish Balay   *isFinalized = PetscFinalizeCalled;
196e5c89e4eSSatish Balay   PetscFunctionReturn(0);
197e5c89e4eSSatish Balay }
198e5c89e4eSSatish Balay 
19909573ac7SBarry Smith extern PetscErrorCode        PetscOptionsCheckInitial_Private(void);
200ace3abfcSBarry Smith extern PetscBool  PetscBeganMPI;
201e5c89e4eSSatish Balay 
202e5c89e4eSSatish Balay /*
203e5c89e4eSSatish Balay        This function is the MPI reduction operation used to compute the sum of the
204e5c89e4eSSatish Balay    first half of the datatype and the max of the second half.
205e5c89e4eSSatish Balay */
206e5c89e4eSSatish Balay MPI_Op PetscMaxSum_Op = 0;
207e5c89e4eSSatish Balay 
208e5c89e4eSSatish Balay EXTERN_C_BEGIN
209e5c89e4eSSatish Balay #undef __FUNCT__
210e5c89e4eSSatish Balay #define __FUNCT__ "PetscMaxSum_Local"
2117087cfbeSBarry Smith void  MPIAPI PetscMaxSum_Local(void *in,void *out,int *cnt,MPI_Datatype *datatype)
212e5c89e4eSSatish Balay {
213e5c89e4eSSatish Balay   PetscInt *xin = (PetscInt*)in,*xout = (PetscInt*)out,i,count = *cnt;
214e5c89e4eSSatish Balay 
215e5c89e4eSSatish Balay   PetscFunctionBegin;
216e5c89e4eSSatish Balay   if (*datatype != MPIU_2INT) {
217e5c89e4eSSatish Balay     (*PetscErrorPrintf)("Can only handle MPIU_2INT data types");
218e5c89e4eSSatish Balay     MPI_Abort(MPI_COMM_WORLD,1);
219e5c89e4eSSatish Balay   }
220e5c89e4eSSatish Balay 
221e5c89e4eSSatish Balay   for (i=0; i<count; i++) {
222e5c89e4eSSatish Balay     xout[2*i]    = PetscMax(xout[2*i],xin[2*i]);
223e5c89e4eSSatish Balay     xout[2*i+1] += xin[2*i+1];
224e5c89e4eSSatish Balay   }
225812af9f3SBarry Smith   PetscFunctionReturnVoid();
226e5c89e4eSSatish Balay }
227e5c89e4eSSatish Balay EXTERN_C_END
228e5c89e4eSSatish Balay 
229e5c89e4eSSatish Balay /*
230e5c89e4eSSatish Balay     Returns the max of the first entry owned by this processor and the
231e5c89e4eSSatish Balay sum of the second entry.
232b693b147SBarry Smith 
233b693b147SBarry Smith     The reason nprocs[2*i] contains lengths nprocs[2*i+1] contains flag of 1 if length is nonzero
234b693b147SBarry Smith is so that the PetscMaxSum_Op() can set TWO values, if we passed in only nprocs[i] with lengths
235b693b147SBarry Smith there would be no place to store the both needed results.
236e5c89e4eSSatish Balay */
237e5c89e4eSSatish Balay #undef __FUNCT__
238e5c89e4eSSatish Balay #define __FUNCT__ "PetscMaxSum"
2397087cfbeSBarry Smith PetscErrorCode  PetscMaxSum(MPI_Comm comm,const PetscInt nprocs[],PetscInt *max,PetscInt *sum)
240e5c89e4eSSatish Balay {
241e5c89e4eSSatish Balay   PetscMPIInt    size,rank;
242e5c89e4eSSatish Balay   PetscInt       *work;
243e5c89e4eSSatish Balay   PetscErrorCode ierr;
244e5c89e4eSSatish Balay 
245e5c89e4eSSatish Balay   PetscFunctionBegin;
246e5c89e4eSSatish Balay   ierr   = MPI_Comm_size(comm,&size);CHKERRQ(ierr);
247e5c89e4eSSatish Balay   ierr   = MPI_Comm_rank(comm,&rank);CHKERRQ(ierr);
248e5c89e4eSSatish Balay   ierr   = PetscMalloc(2*size*sizeof(PetscInt),&work);CHKERRQ(ierr);
249e5c89e4eSSatish Balay   ierr   = MPI_Allreduce((void*)nprocs,work,size,MPIU_2INT,PetscMaxSum_Op,comm);CHKERRQ(ierr);
250e5c89e4eSSatish Balay   *max   = work[2*rank];
251e5c89e4eSSatish Balay   *sum   = work[2*rank+1];
252e5c89e4eSSatish Balay   ierr   = PetscFree(work);CHKERRQ(ierr);
253e5c89e4eSSatish Balay   PetscFunctionReturn(0);
254e5c89e4eSSatish Balay }
255e5c89e4eSSatish Balay 
256e5c89e4eSSatish Balay /* ----------------------------------------------------------------------------*/
2577087cfbeSBarry Smith MPI_Op  PetscADMax_Op = 0;
258e5c89e4eSSatish Balay 
259e5c89e4eSSatish Balay EXTERN_C_BEGIN
260e5c89e4eSSatish Balay #undef __FUNCT__
261e5c89e4eSSatish Balay #define __FUNCT__ "PetscADMax_Local"
2627087cfbeSBarry Smith void  MPIAPI PetscADMax_Local(void *in,void *out,PetscMPIInt *cnt,MPI_Datatype *datatype)
263e5c89e4eSSatish Balay {
264e5c89e4eSSatish Balay   PetscScalar *xin = (PetscScalar *)in,*xout = (PetscScalar*)out;
265e5c89e4eSSatish Balay   PetscInt    i,count = *cnt;
266e5c89e4eSSatish Balay 
267e5c89e4eSSatish Balay   PetscFunctionBegin;
268e5c89e4eSSatish Balay   if (*datatype != MPIU_2SCALAR) {
269e5c89e4eSSatish Balay     (*PetscErrorPrintf)("Can only handle MPIU_2SCALAR data (i.e. double or complex) types");
270e5c89e4eSSatish Balay     MPI_Abort(MPI_COMM_WORLD,1);
271e5c89e4eSSatish Balay   }
272e5c89e4eSSatish Balay 
273e5c89e4eSSatish Balay   for (i=0; i<count; i++) {
274e5c89e4eSSatish Balay     if (PetscRealPart(xout[2*i]) < PetscRealPart(xin[2*i])) {
275e5c89e4eSSatish Balay       xout[2*i]   = xin[2*i];
276e5c89e4eSSatish Balay       xout[2*i+1] = xin[2*i+1];
277e5c89e4eSSatish Balay     }
278e5c89e4eSSatish Balay   }
279812af9f3SBarry Smith   PetscFunctionReturnVoid();
280e5c89e4eSSatish Balay }
281e5c89e4eSSatish Balay EXTERN_C_END
282e5c89e4eSSatish Balay 
2837087cfbeSBarry Smith MPI_Op  PetscADMin_Op = 0;
284e5c89e4eSSatish Balay 
285e5c89e4eSSatish Balay EXTERN_C_BEGIN
286e5c89e4eSSatish Balay #undef __FUNCT__
287e5c89e4eSSatish Balay #define __FUNCT__ "PetscADMin_Local"
2887087cfbeSBarry Smith void  MPIAPI PetscADMin_Local(void *in,void *out,PetscMPIInt *cnt,MPI_Datatype *datatype)
289e5c89e4eSSatish Balay {
290e5c89e4eSSatish Balay   PetscScalar *xin = (PetscScalar *)in,*xout = (PetscScalar*)out;
291e5c89e4eSSatish Balay   PetscInt    i,count = *cnt;
292e5c89e4eSSatish Balay 
293e5c89e4eSSatish Balay   PetscFunctionBegin;
294e5c89e4eSSatish Balay   if (*datatype != MPIU_2SCALAR) {
295e5c89e4eSSatish Balay     (*PetscErrorPrintf)("Can only handle MPIU_2SCALAR data (i.e. double or complex) types");
296e5c89e4eSSatish Balay     MPI_Abort(MPI_COMM_WORLD,1);
297e5c89e4eSSatish Balay   }
298e5c89e4eSSatish Balay 
299e5c89e4eSSatish Balay   for (i=0; i<count; i++) {
300e5c89e4eSSatish Balay     if (PetscRealPart(xout[2*i]) > PetscRealPart(xin[2*i])) {
301e5c89e4eSSatish Balay       xout[2*i]   = xin[2*i];
302e5c89e4eSSatish Balay       xout[2*i+1] = xin[2*i+1];
303e5c89e4eSSatish Balay     }
304e5c89e4eSSatish Balay   }
305812af9f3SBarry Smith   PetscFunctionReturnVoid();
306e5c89e4eSSatish Balay }
307e5c89e4eSSatish Balay EXTERN_C_END
308e5c89e4eSSatish Balay /* ---------------------------------------------------------------------------------------*/
309e5c89e4eSSatish Balay 
310ce63c4c1SBarry Smith #if (defined(PETSC_USE_COMPLEX) && !defined(PETSC_HAVE_MPI_C_DOUBLE_COMPLEX)) || defined(PETSC_USE_REAL___FLOAT128)
31106a205a8SBarry Smith MPI_Op MPIU_SUM = 0;
312e5c89e4eSSatish Balay 
313e5c89e4eSSatish Balay EXTERN_C_BEGIN
314e5c89e4eSSatish Balay #undef __FUNCT__
315e5c89e4eSSatish Balay #define __FUNCT__ "PetscSum_Local"
3167087cfbeSBarry Smith void  PetscSum_Local(void *in,void *out,PetscMPIInt *cnt,MPI_Datatype *datatype)
317e5c89e4eSSatish Balay {
318e5c89e4eSSatish Balay   PetscInt    i,count = *cnt;
319e5c89e4eSSatish Balay 
320e5c89e4eSSatish Balay   PetscFunctionBegin;
321e2e03761SBarry Smith   if (*datatype == MPIU_SCALAR) {
322e2e03761SBarry Smith     PetscScalar *xin = (PetscScalar *)in,*xout = (PetscScalar*)out;
323e5c89e4eSSatish Balay     for (i=0; i<count; i++) {
324e5c89e4eSSatish Balay       xout[i] += xin[i];
325e5c89e4eSSatish Balay     }
326e2e03761SBarry Smith   } else if (*datatype == MPIU_REAL) {
327e2e03761SBarry Smith     PetscReal *xin = (PetscReal *)in,*xout = (PetscReal*)out;
328e2e03761SBarry Smith     for (i=0; i<count; i++) {
329e2e03761SBarry Smith       xout[i] += xin[i];
330e2e03761SBarry Smith     }
331e2e03761SBarry Smith   } else {
332e2e03761SBarry Smith     (*PetscErrorPrintf)("Can only handle MPIU_REAL or MPIU_SCALAR data (i.e. double or complex) types");
333e2e03761SBarry Smith     MPI_Abort(MPI_COMM_WORLD,1);
334e2e03761SBarry Smith   }
335812af9f3SBarry Smith   PetscFunctionReturnVoid();
336e5c89e4eSSatish Balay }
337e5c89e4eSSatish Balay EXTERN_C_END
338e5c89e4eSSatish Balay #endif
339e5c89e4eSSatish Balay 
340ce63c4c1SBarry Smith #if defined(PETSC_USE_REAL___FLOAT128)
341d9822059SBarry Smith MPI_Op MPIU_MAX = 0;
342d9822059SBarry Smith MPI_Op MPIU_MIN = 0;
343d9822059SBarry Smith 
344d9822059SBarry Smith EXTERN_C_BEGIN
345d9822059SBarry Smith #undef __FUNCT__
346d9822059SBarry Smith #define __FUNCT__ "PetscMax_Local"
347d9822059SBarry Smith void  PetscMax_Local(void *in,void *out,PetscMPIInt *cnt,MPI_Datatype *datatype)
348d9822059SBarry Smith {
349d9822059SBarry Smith   PetscScalar *xin = (PetscScalar *)in,*xout = (PetscScalar*)out;
350d9822059SBarry Smith   PetscInt    i,count = *cnt;
351d9822059SBarry Smith 
352d9822059SBarry Smith   PetscFunctionBegin;
353d9822059SBarry Smith   if (*datatype != MPIU_SCALAR) {
354d9822059SBarry Smith     (*PetscErrorPrintf)("Can only handle MPIU_SCALAR data (i.e. double or complex) types");
355d9822059SBarry Smith     MPI_Abort(MPI_COMM_WORLD,1);
356d9822059SBarry Smith   }
357d9822059SBarry Smith 
358d9822059SBarry Smith   for (i=0; i<count; i++) {
359d9822059SBarry Smith     xout[i] += PetscMax(xout[i],xin[i]);
360d9822059SBarry Smith   }
361d9822059SBarry Smith   PetscFunctionReturnVoid();
362d9822059SBarry Smith }
363d9822059SBarry Smith EXTERN_C_END
364d9822059SBarry Smith 
365d9822059SBarry Smith EXTERN_C_BEGIN
366d9822059SBarry Smith #undef __FUNCT__
367d9822059SBarry Smith #define __FUNCT__ "PetscMin_Local"
368d9822059SBarry Smith void  PetscMin_Local(void *in,void *out,PetscMPIInt *cnt,MPI_Datatype *datatype)
369d9822059SBarry Smith {
370d9822059SBarry Smith   PetscScalar *xin = (PetscScalar *)in,*xout = (PetscScalar*)out;
371d9822059SBarry Smith   PetscInt    i,count = *cnt;
372d9822059SBarry Smith 
373d9822059SBarry Smith   PetscFunctionBegin;
374d9822059SBarry Smith   if (*datatype != MPIU_SCALAR) {
375d9822059SBarry Smith     (*PetscErrorPrintf)("Can only handle MPIU_SCALAR data (i.e. double or complex) types");
376d9822059SBarry Smith     MPI_Abort(MPI_COMM_WORLD,1);
377d9822059SBarry Smith   }
378d9822059SBarry Smith 
379d9822059SBarry Smith   for (i=0; i<count; i++) {
380d9822059SBarry Smith     xout[i] += PetscMin(xout[i],xin[i]);
381d9822059SBarry Smith   }
382d9822059SBarry Smith   PetscFunctionReturnVoid();
383d9822059SBarry Smith }
384d9822059SBarry Smith EXTERN_C_END
385d9822059SBarry Smith #endif
386d9822059SBarry Smith 
387480cf27aSJed Brown EXTERN_C_BEGIN
388480cf27aSJed Brown #undef __FUNCT__
389480cf27aSJed Brown #define __FUNCT__ "Petsc_DelCounter"
390480cf27aSJed Brown /*
391480cf27aSJed Brown    Private routine to delete internal tag/name counter storage when a communicator is freed.
392480cf27aSJed Brown 
393480cf27aSJed Brown    This is called by MPI, not by users.
394480cf27aSJed Brown 
395480cf27aSJed Brown    Note: this is declared extern "C" because it is passed to MPI_Keyval_create()
396480cf27aSJed Brown 
397480cf27aSJed Brown */
3987087cfbeSBarry Smith PetscMPIInt  MPIAPI Petsc_DelCounter(MPI_Comm comm,PetscMPIInt keyval,void *count_val,void *extra_state)
399480cf27aSJed Brown {
400480cf27aSJed Brown   PetscErrorCode ierr;
401480cf27aSJed Brown 
402480cf27aSJed Brown   PetscFunctionBegin;
403480cf27aSJed Brown   ierr = PetscInfo1(0,"Deleting counter data in an MPI_Comm %ld\n",(long)comm);if (ierr) PetscFunctionReturn((PetscMPIInt)ierr);
404480cf27aSJed Brown   ierr = PetscFree(count_val);if (ierr) PetscFunctionReturn((PetscMPIInt)ierr);
405480cf27aSJed Brown   PetscFunctionReturn(MPI_SUCCESS);
406480cf27aSJed Brown }
407480cf27aSJed Brown EXTERN_C_END
408480cf27aSJed Brown 
409480cf27aSJed Brown EXTERN_C_BEGIN
410480cf27aSJed Brown #undef __FUNCT__
411480cf27aSJed Brown #define __FUNCT__ "Petsc_DelComm"
412480cf27aSJed Brown /*
413480cf27aSJed Brown   This does not actually free anything, it simply marks when a reference count to an internal MPI_Comm reaches zero and the
414480cf27aSJed Brown   the external MPI_Comm drops its reference to the internal MPI_Comm
415480cf27aSJed Brown 
416480cf27aSJed Brown   This is called by MPI, not by users.
417480cf27aSJed Brown 
418480cf27aSJed Brown   Note: this is declared extern "C" because it is passed to MPI_Keyval_create()
419480cf27aSJed Brown 
420480cf27aSJed Brown */
4217087cfbeSBarry Smith PetscMPIInt  MPIAPI Petsc_DelComm(MPI_Comm comm,PetscMPIInt keyval,void *attr_val,void *extra_state)
422480cf27aSJed Brown {
423480cf27aSJed Brown   PetscErrorCode ierr;
424480cf27aSJed Brown 
425480cf27aSJed Brown   PetscFunctionBegin;
426480cf27aSJed Brown   ierr = PetscInfo1(0,"Deleting PETSc communicator imbedded in a user MPI_Comm %ld\n",(long)comm);if (ierr) PetscFunctionReturn((PetscMPIInt)ierr);
427480cf27aSJed Brown   /* actually don't delete anything because we cannot increase the reference count of the communicator anyways */
428480cf27aSJed Brown   PetscFunctionReturn(MPI_SUCCESS);
429480cf27aSJed Brown }
430480cf27aSJed Brown EXTERN_C_END
431480cf27aSJed Brown 
432951e3c8eSBarry Smith #if defined(PETSC_USE_PETSC_MPI_EXTERNAL32)
433e39fd77fSBarry Smith #if !defined(PETSC_WORDS_BIGENDIAN)
434e39fd77fSBarry Smith EXTERN_C_BEGIN
435e39fd77fSBarry Smith extern PetscMPIInt PetscDataRep_extent_fn(MPI_Datatype,MPI_Aint*,void*);
436e39fd77fSBarry Smith extern PetscMPIInt PetscDataRep_read_conv_fn(void*, MPI_Datatype,PetscMPIInt,void*,MPI_Offset,void*);
437e39fd77fSBarry Smith extern PetscMPIInt PetscDataRep_write_conv_fn(void*, MPI_Datatype,PetscMPIInt,void*,MPI_Offset,void*);
438e39fd77fSBarry Smith EXTERN_C_END
439e39fd77fSBarry Smith #endif
440951e3c8eSBarry Smith #endif
441e39fd77fSBarry Smith 
4426ae9a8a6SBarry Smith int  PetscGlobalArgc   = 0;
4436ae9a8a6SBarry Smith char **PetscGlobalArgs = 0;
444e5c89e4eSSatish Balay 
445e5c89e4eSSatish Balay #undef __FUNCT__
446e5c89e4eSSatish Balay #define __FUNCT__ "PetscGetArgs"
447e5c89e4eSSatish Balay /*@C
448e5c89e4eSSatish Balay    PetscGetArgs - Allows you to access the raw command line arguments anywhere
449e5c89e4eSSatish Balay      after PetscInitialize() is called but before PetscFinalize().
450e5c89e4eSSatish Balay 
451e5c89e4eSSatish Balay    Not Collective
452e5c89e4eSSatish Balay 
453e5c89e4eSSatish Balay    Output Parameters:
454e5c89e4eSSatish Balay +  argc - count of number of command line arguments
455e5c89e4eSSatish Balay -  args - the command line arguments
456e5c89e4eSSatish Balay 
457e5c89e4eSSatish Balay    Level: intermediate
458e5c89e4eSSatish Balay 
459e5c89e4eSSatish Balay    Notes:
460e5c89e4eSSatish Balay       This is usually used to pass the command line arguments into other libraries
461e5c89e4eSSatish Balay    that are called internally deep in PETSc or the application.
462e5c89e4eSSatish Balay 
463f177e3b1SBarry Smith       The first argument contains the program name as is normal for C arguments.
464f177e3b1SBarry Smith 
465e5c89e4eSSatish Balay    Concepts: command line arguments
466e5c89e4eSSatish Balay 
467793721a6SBarry Smith .seealso: PetscFinalize(), PetscInitializeFortran(), PetscGetArguments()
468e5c89e4eSSatish Balay 
469e5c89e4eSSatish Balay @*/
4707087cfbeSBarry Smith PetscErrorCode  PetscGetArgs(int *argc,char ***args)
471e5c89e4eSSatish Balay {
472e5c89e4eSSatish Balay   PetscFunctionBegin;
47317186662SBarry Smith   if (!PetscInitializeCalled && PetscFinalizeCalled) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ORDER,"You must call after PetscInitialize() but before PetscFinalize()");
474e5c89e4eSSatish Balay   *argc = PetscGlobalArgc;
475e5c89e4eSSatish Balay   *args = PetscGlobalArgs;
476e5c89e4eSSatish Balay   PetscFunctionReturn(0);
477e5c89e4eSSatish Balay }
478e5c89e4eSSatish Balay 
479e5c89e4eSSatish Balay #undef __FUNCT__
480793721a6SBarry Smith #define __FUNCT__ "PetscGetArguments"
481793721a6SBarry Smith /*@C
482793721a6SBarry Smith    PetscGetArguments - Allows you to access the  command line arguments anywhere
483793721a6SBarry Smith      after PetscInitialize() is called but before PetscFinalize().
484793721a6SBarry Smith 
485793721a6SBarry Smith    Not Collective
486793721a6SBarry Smith 
487793721a6SBarry Smith    Output Parameters:
488793721a6SBarry Smith .  args - the command line arguments
489793721a6SBarry Smith 
490793721a6SBarry Smith    Level: intermediate
491793721a6SBarry Smith 
492793721a6SBarry Smith    Notes:
493793721a6SBarry Smith       This does NOT start with the program name and IS null terminated (final arg is void)
494793721a6SBarry Smith 
495793721a6SBarry Smith    Concepts: command line arguments
496793721a6SBarry Smith 
497793721a6SBarry Smith .seealso: PetscFinalize(), PetscInitializeFortran(), PetscGetArgs(), PetscFreeArguments()
498793721a6SBarry Smith 
499793721a6SBarry Smith @*/
5007087cfbeSBarry Smith PetscErrorCode  PetscGetArguments(char ***args)
501793721a6SBarry Smith {
502793721a6SBarry Smith   PetscInt       i,argc = PetscGlobalArgc;
503793721a6SBarry Smith   PetscErrorCode ierr;
504793721a6SBarry Smith 
505793721a6SBarry Smith   PetscFunctionBegin;
50617186662SBarry Smith   if (!PetscInitializeCalled && PetscFinalizeCalled) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ORDER,"You must call after PetscInitialize() but before PetscFinalize()");
507717030eeSLisandro Dalcin   if (!argc) {*args = 0; PetscFunctionReturn(0);}
508793721a6SBarry Smith   ierr = PetscMalloc(argc*sizeof(char*),args);CHKERRQ(ierr);
509793721a6SBarry Smith   for (i=0; i<argc-1; i++) {
510793721a6SBarry Smith     ierr = PetscStrallocpy(PetscGlobalArgs[i+1],&(*args)[i]);CHKERRQ(ierr);
511793721a6SBarry Smith   }
512793721a6SBarry Smith   (*args)[argc-1] = 0;
513793721a6SBarry Smith   PetscFunctionReturn(0);
514793721a6SBarry Smith }
515793721a6SBarry Smith 
516793721a6SBarry Smith #undef __FUNCT__
517793721a6SBarry Smith #define __FUNCT__ "PetscFreeArguments"
518793721a6SBarry Smith /*@C
519793721a6SBarry Smith    PetscFreeArguments - Frees the memory obtained with PetscGetArguments()
520793721a6SBarry Smith 
521793721a6SBarry Smith    Not Collective
522793721a6SBarry Smith 
523793721a6SBarry Smith    Output Parameters:
524793721a6SBarry Smith .  args - the command line arguments
525793721a6SBarry Smith 
526793721a6SBarry Smith    Level: intermediate
527793721a6SBarry Smith 
528793721a6SBarry Smith    Concepts: command line arguments
529793721a6SBarry Smith 
530793721a6SBarry Smith .seealso: PetscFinalize(), PetscInitializeFortran(), PetscGetArgs(), PetscGetArguments()
531793721a6SBarry Smith 
532793721a6SBarry Smith @*/
5337087cfbeSBarry Smith PetscErrorCode  PetscFreeArguments(char **args)
534793721a6SBarry Smith {
535793721a6SBarry Smith   PetscInt       i = 0;
536793721a6SBarry Smith   PetscErrorCode ierr;
537793721a6SBarry Smith 
538793721a6SBarry Smith   PetscFunctionBegin;
539717030eeSLisandro Dalcin   if (!args) {PetscFunctionReturn(0);}
540793721a6SBarry Smith   while (args[i]) {
541793721a6SBarry Smith     ierr = PetscFree(args[i]);CHKERRQ(ierr);
542793721a6SBarry Smith     i++;
543793721a6SBarry Smith   }
544793721a6SBarry Smith   ierr = PetscFree(args);CHKERRQ(ierr);
545793721a6SBarry Smith   PetscFunctionReturn(0);
546793721a6SBarry Smith }
547793721a6SBarry Smith 
548793721a6SBarry Smith #undef __FUNCT__
549e5c89e4eSSatish Balay #define __FUNCT__ "PetscInitialize"
550e5c89e4eSSatish Balay /*@C
551e5c89e4eSSatish Balay    PetscInitialize - Initializes the PETSc database and MPI.
552e5c89e4eSSatish Balay    PetscInitialize() calls MPI_Init() if that has yet to be called,
553e5c89e4eSSatish Balay    so this routine should always be called near the beginning of
554e5c89e4eSSatish Balay    your program -- usually the very first line!
555e5c89e4eSSatish Balay 
556e5c89e4eSSatish Balay    Collective on MPI_COMM_WORLD or PETSC_COMM_WORLD if it has been set
557e5c89e4eSSatish Balay 
558e5c89e4eSSatish Balay    Input Parameters:
559e5c89e4eSSatish Balay +  argc - count of number of command line arguments
560e5c89e4eSSatish Balay .  args - the command line arguments
561fc2bca9aSBarry Smith .  file - [optional] PETSc database file, also checks ~username/.petscrc and .petscrc use PETSC_NULL to not check for
562fc2bca9aSBarry Smith           code specific file. Use -skip_petscrc in the code specific file to skip the .petscrc files
563e5c89e4eSSatish Balay -  help - [optional] Help message to print, use PETSC_NULL for no message
564e5c89e4eSSatish Balay 
56505827820SBarry Smith    If you wish PETSc code to run ONLY on a subcommunicator of MPI_COMM_WORLD, create that
56605827820SBarry Smith    communicator first and assign it to PETSC_COMM_WORLD BEFORE calling PetscInitialize(). Thus if you are running a
56705827820SBarry Smith    four process job and two processes will run PETSc and have PetscInitialize() and PetscFinalize() and two process will not,
56805827820SBarry Smith    then do this. If ALL processes in the job are using PetscInitialize() and PetscFinalize() then you don't need to do this, even
56905827820SBarry Smith    if different subcommunicators of the job are doing different things with PETSc.
570e5c89e4eSSatish Balay 
571e5c89e4eSSatish Balay    Options Database Keys:
572e5c89e4eSSatish Balay +  -start_in_debugger [noxterm,dbx,xdb,gdb,...] - Starts program in debugger
573e5c89e4eSSatish Balay .  -on_error_attach_debugger [noxterm,dbx,xdb,gdb,...] - Starts debugger when error detected
574e5c89e4eSSatish Balay .  -on_error_emacs <machinename> causes emacsclient to jump to error file
575b52f573bSBarry Smith .  -on_error_abort calls abort() when error detected (no traceback)
576e8fb0fc0SBarry Smith .  -on_error_mpiabort calls MPI_abort() when error detected
577e8fb0fc0SBarry Smith .  -error_output_stderr prints error messages to stderr instead of the default stdout
578e8fb0fc0SBarry Smith .  -error_output_none does not print the error messages (but handles errors in the same way as if this was not called)
579e5c89e4eSSatish Balay .  -debugger_nodes [node1,node2,...] - Indicates nodes to start in debugger
580e5c89e4eSSatish Balay .  -debugger_pause [sleeptime] (in seconds) - Pauses debugger
581e5c89e4eSSatish Balay .  -stop_for_debugger - Print message on how to attach debugger manually to
582e5c89e4eSSatish Balay                         process and wait (-debugger_pause) seconds for attachment
5832fb0ec9aSBarry Smith .  -malloc - Indicates use of PETSc error-checking malloc (on by default for debug version of libraries)
584e5c89e4eSSatish Balay .  -malloc no - Indicates not to use error-checking malloc
5852fb0ec9aSBarry Smith .  -malloc_debug - check for memory corruption at EVERY malloc or free
586e5c89e4eSSatish Balay .  -fp_trap - Stops on floating point exceptions (Note that on the
587e5c89e4eSSatish Balay               IBM RS6000 this slows code by at least a factor of 10.)
588e5c89e4eSSatish Balay .  -no_signal_handler - Indicates not to trap error signals
589e5c89e4eSSatish Balay .  -shared_tmp - indicates /tmp directory is shared by all processors
590e5c89e4eSSatish Balay .  -not_shared_tmp - each processor has own /tmp
591e5c89e4eSSatish Balay .  -tmp - alternative name of /tmp directory
592e5c89e4eSSatish Balay .  -get_total_flops - returns total flops done by all processors
593*40ab9619SBarry Smith .  -memory_info - Print memory usage at end of run
594*40ab9619SBarry Smith -  -server <port> - start PETSc webserver (default port is 8080)
595e5c89e4eSSatish Balay 
596e5c89e4eSSatish Balay    Options Database Keys for Profiling:
5970598bfebSBarry Smith    See the <a href="../../docs/manual.pdf#nameddest=ch_profiling">profiling chapter of the users manual</a> for details.
598e5c89e4eSSatish Balay +  -log_trace [filename] - Print traces of all PETSc calls
599e5c89e4eSSatish Balay         to the screen (useful to determine where a program
600e5c89e4eSSatish Balay         hangs without running in the debugger).  See PetscLogTraceBegin().
6016cf91177SBarry Smith .  -info <optional filename> - Prints verbose information to the screen
6026cf91177SBarry Smith -  -info_exclude <null,vec,mat,pc,ksp,snes,ts> - Excludes some of the verbose messages
603e5c89e4eSSatish Balay 
604e5c89e4eSSatish Balay    Environmental Variables:
605e5c89e4eSSatish Balay +   PETSC_TMP - alternative tmp directory
606e5c89e4eSSatish Balay .   PETSC_SHARED_TMP - tmp is shared by all processes
607e5c89e4eSSatish Balay .   PETSC_NOT_SHARED_TMP - each process has its own private tmp
608e5c89e4eSSatish Balay .   PETSC_VIEWER_SOCKET_PORT - socket number to use for socket viewer
609e5c89e4eSSatish Balay -   PETSC_VIEWER_SOCKET_MACHINE - machine to use for socket viewer to connect to
610e5c89e4eSSatish Balay 
611e5c89e4eSSatish Balay 
612e5c89e4eSSatish Balay    Level: beginner
613e5c89e4eSSatish Balay 
614e5c89e4eSSatish Balay    Notes:
615e5c89e4eSSatish Balay    If for some reason you must call MPI_Init() separately, call
616e5c89e4eSSatish Balay    it before PetscInitialize().
617e5c89e4eSSatish Balay 
618e5c89e4eSSatish Balay    Fortran Version:
619e5c89e4eSSatish Balay    In Fortran this routine has the format
620e5c89e4eSSatish Balay $       call PetscInitialize(file,ierr)
621e5c89e4eSSatish Balay 
622e5c89e4eSSatish Balay +   ierr - error return code
6233dae0d48SMatthew Knepley -  file - [optional] PETSc database file, also checks ~username/.petscrc and .petscrc use PETSC_NULL_CHARACTER to not check for
624fc2bca9aSBarry Smith           code specific file. Use -skip_petscrc in the code specific file to skip the .petscrc files
625e5c89e4eSSatish Balay 
626e5c89e4eSSatish Balay    Important Fortran Note:
627e5c89e4eSSatish Balay    In Fortran, you MUST use PETSC_NULL_CHARACTER to indicate a
628e5c89e4eSSatish Balay    null character string; you CANNOT just use PETSC_NULL as
6290598bfebSBarry Smith    in the C version. See the <a href="../../docs/manual.pdf">users manual</a> for details.
630e5c89e4eSSatish Balay 
63101cb0274SBarry Smith    If your main program is C but you call Fortran code that also uses PETSc you need to call PetscInitializeFortran() soon after
63201cb0274SBarry Smith    calling PetscInitialize().
633e5c89e4eSSatish Balay 
634e5c89e4eSSatish Balay    Concepts: initializing PETSc
635e5c89e4eSSatish Balay 
63601cb0274SBarry Smith .seealso: PetscFinalize(), PetscInitializeFortran(), PetscGetArgs(), PetscInitializeNoArguments()
637e5c89e4eSSatish Balay 
638e5c89e4eSSatish Balay @*/
6397087cfbeSBarry Smith PetscErrorCode  PetscInitialize(int *argc,char ***args,const char file[],const char help[])
640e5c89e4eSSatish Balay {
641e5c89e4eSSatish Balay   PetscErrorCode ierr;
642aa5bb8c0SSatish Balay   PetscMPIInt    flag, size;
643aa5bb8c0SSatish Balay   PetscInt       nodesize;
644ace3abfcSBarry Smith   PetscBool      flg;
645e5c89e4eSSatish Balay   char           hostname[256];
646e5c89e4eSSatish Balay 
647e5c89e4eSSatish Balay   PetscFunctionBegin;
648e5c89e4eSSatish Balay   if (PetscInitializeCalled) PetscFunctionReturn(0);
649e5c89e4eSSatish Balay 
650ae9b4142SLisandro Dalcin   /* these must be initialized in a routine, not as a constant declaration*/
651d89683f4Sbcordonn   PETSC_STDOUT = stdout;
652ae9b4142SLisandro Dalcin   PETSC_STDERR = stderr;
653e5c89e4eSSatish Balay 
654e5c89e4eSSatish Balay   ierr = PetscOptionsCreate();CHKERRQ(ierr);
655e5c89e4eSSatish Balay 
656e5c89e4eSSatish Balay   /*
657e5c89e4eSSatish Balay      We initialize the program name here (before MPI_Init()) because MPICH has a bug in
658e5c89e4eSSatish Balay      it that it sets args[0] on all processors to be args[0] on the first processor.
659e5c89e4eSSatish Balay   */
660e5c89e4eSSatish Balay   if (argc && *argc) {
661e5c89e4eSSatish Balay     ierr = PetscSetProgramName(**args);CHKERRQ(ierr);
662e5c89e4eSSatish Balay   } else {
663e5c89e4eSSatish Balay     ierr = PetscSetProgramName("Unknown Name");CHKERRQ(ierr);
664e5c89e4eSSatish Balay   }
665e5c89e4eSSatish Balay 
666e5c89e4eSSatish Balay   ierr = MPI_Initialized(&flag);CHKERRQ(ierr);
667e5c89e4eSSatish Balay   if (!flag) {
668e32f2f54SBarry 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");
669e5c89e4eSSatish Balay     ierr          = MPI_Init(argc,args);CHKERRQ(ierr);
670e5c89e4eSSatish Balay     PetscBeganMPI = PETSC_TRUE;
671e5c89e4eSSatish Balay   }
672e5c89e4eSSatish Balay   if (argc && args) {
673e5c89e4eSSatish Balay     PetscGlobalArgc = *argc;
674e5c89e4eSSatish Balay     PetscGlobalArgs = *args;
675e5c89e4eSSatish Balay   }
676e5c89e4eSSatish Balay   PetscFinalizeCalled   = PETSC_FALSE;
677e5c89e4eSSatish Balay 
678e8373e55SMatthew Knepley   if (PETSC_COMM_WORLD == MPI_COMM_NULL) {
679e5c89e4eSSatish Balay     PETSC_COMM_WORLD = MPI_COMM_WORLD;
680e5c89e4eSSatish Balay   }
681660746e0SBarry Smith   ierr = MPI_Errhandler_set(PETSC_COMM_WORLD,MPI_ERRORS_RETURN);CHKERRQ(ierr);
682e5c89e4eSSatish Balay 
683e5c89e4eSSatish Balay   /* Done after init due to a bug in MPICH-GM? */
684e5c89e4eSSatish Balay   ierr = PetscErrorPrintfInitialize();CHKERRQ(ierr);
685e5c89e4eSSatish Balay 
686e5c89e4eSSatish Balay   ierr = MPI_Comm_rank(MPI_COMM_WORLD,&PetscGlobalRank);CHKERRQ(ierr);
687e5c89e4eSSatish Balay   ierr = MPI_Comm_size(MPI_COMM_WORLD,&PetscGlobalSize);CHKERRQ(ierr);
688e5c89e4eSSatish Balay 
689e5c89e4eSSatish Balay #if defined(PETSC_USE_COMPLEX)
690e5c89e4eSSatish Balay   /*
691e5c89e4eSSatish Balay      Initialized the global complex variable; this is because with
692e5c89e4eSSatish Balay      shared libraries the constructors for global variables
693e5c89e4eSSatish Balay      are not called; at least on IRIX.
694e5c89e4eSSatish Balay   */
695e5c89e4eSSatish Balay   {
696762437b8SSatish Balay #if defined(PETSC_CLANGUAGE_CXX)
697e5c89e4eSSatish Balay     PetscScalar ic(0.0,1.0);
698e5c89e4eSSatish Balay     PETSC_i = ic;
699b7940d39SSatish Balay #else
7003433f298SSatish Balay     PETSC_i = I;
701b7940d39SSatish Balay #endif
702762437b8SSatish Balay   }
703762437b8SSatish Balay 
7042c876bd9SBarry Smith #if !defined(PETSC_HAVE_MPI_C_DOUBLE_COMPLEX)
7052c876bd9SBarry Smith   ierr = MPI_Type_contiguous(2,MPIU_REAL,&MPI_C_DOUBLE_COMPLEX);CHKERRQ(ierr);
7062c876bd9SBarry Smith   ierr = MPI_Type_commit(&MPI_C_DOUBLE_COMPLEX);CHKERRQ(ierr);
707a83b8d76SBarry Smith   ierr = MPI_Type_contiguous(2,MPI_FLOAT,&MPI_C_COMPLEX);CHKERRQ(ierr);
708a83b8d76SBarry Smith   ierr = MPI_Type_commit(&MPI_C_COMPLEX);CHKERRQ(ierr);
70906a205a8SBarry Smith   ierr = MPI_Op_create(PetscSum_Local,1,&MPIU_SUM);CHKERRQ(ierr);
710e5c89e4eSSatish Balay #endif
7112c876bd9SBarry Smith #endif
712e5c89e4eSSatish Balay 
713e5c89e4eSSatish Balay   /*
714e5c89e4eSSatish Balay      Create the PETSc MPI reduction operator that sums of the first
715e5c89e4eSSatish Balay      half of the entries and maxes the second half.
716e5c89e4eSSatish Balay   */
717e5c89e4eSSatish Balay   ierr = MPI_Op_create(PetscMaxSum_Local,1,&PetscMaxSum_Op);CHKERRQ(ierr);
718e5c89e4eSSatish Balay 
719ce63c4c1SBarry Smith #if defined(PETSC_USE_REAL___FLOAT128)
720c90a1750SBarry Smith   ierr = MPI_Type_contiguous(2,MPI_DOUBLE,&MPIU___FLOAT128);CHKERRQ(ierr);
721c90a1750SBarry Smith   ierr = MPI_Type_commit(&MPIU___FLOAT128);CHKERRQ(ierr);
722854411e3SBarry Smith   ierr = MPI_Op_create(PetscSum_Local,1,&MPIU_SUM);CHKERRQ(ierr);
723d9822059SBarry Smith   ierr = MPI_Op_create(PetscMax_Local,1,&MPIU_MAX);CHKERRQ(ierr);
724d9822059SBarry Smith   ierr = MPI_Op_create(PetscMin_Local,1,&MPIU_MIN);CHKERRQ(ierr);
725c90a1750SBarry Smith #endif
726c90a1750SBarry Smith 
727e5c89e4eSSatish Balay   ierr = MPI_Type_contiguous(2,MPIU_SCALAR,&MPIU_2SCALAR);CHKERRQ(ierr);
728e5c89e4eSSatish Balay   ierr = MPI_Type_commit(&MPIU_2SCALAR);CHKERRQ(ierr);
729e5c89e4eSSatish Balay   ierr = MPI_Op_create(PetscADMax_Local,1,&PetscADMax_Op);CHKERRQ(ierr);
730e5c89e4eSSatish Balay   ierr = MPI_Op_create(PetscADMin_Local,1,&PetscADMin_Op);CHKERRQ(ierr);
731e5c89e4eSSatish Balay 
732e5c89e4eSSatish Balay   ierr = MPI_Type_contiguous(2,MPIU_INT,&MPIU_2INT);CHKERRQ(ierr);
733e5c89e4eSSatish Balay   ierr = MPI_Type_commit(&MPIU_2INT);CHKERRQ(ierr);
734e5c89e4eSSatish Balay 
735e5c89e4eSSatish Balay   /*
736480cf27aSJed Brown      Attributes to be set on PETSc communicators
737480cf27aSJed Brown   */
738480cf27aSJed Brown   ierr = MPI_Keyval_create(MPI_NULL_COPY_FN,Petsc_DelCounter,&Petsc_Counter_keyval,(void*)0);CHKERRQ(ierr);
739480cf27aSJed Brown   ierr = MPI_Keyval_create(MPI_NULL_COPY_FN,Petsc_DelComm,&Petsc_InnerComm_keyval,(void*)0);CHKERRQ(ierr);
740480cf27aSJed Brown   ierr = MPI_Keyval_create(MPI_NULL_COPY_FN,Petsc_DelComm,&Petsc_OuterComm_keyval,(void*)0);CHKERRQ(ierr);
741480cf27aSJed Brown 
742480cf27aSJed Brown   /*
743e8fb0fc0SBarry Smith      Build the options database
744e5c89e4eSSatish Balay   */
745e5c89e4eSSatish Balay   ierr = PetscOptionsInsert(argc,args,file);CHKERRQ(ierr);
746e5c89e4eSSatish Balay 
7476dc8fec2Sbcordonn 
748e5c89e4eSSatish Balay   /*
749e5c89e4eSSatish Balay      Print main application help message
750e5c89e4eSSatish Balay   */
751e5c89e4eSSatish Balay   ierr = PetscOptionsHasName(PETSC_NULL,"-help",&flg);CHKERRQ(ierr);
752e5c89e4eSSatish Balay   if (help && flg) {
753e5c89e4eSSatish Balay     ierr = PetscPrintf(PETSC_COMM_WORLD,help);CHKERRQ(ierr);
754e5c89e4eSSatish Balay   }
755e5c89e4eSSatish Balay   ierr = PetscOptionsCheckInitial_Private();CHKERRQ(ierr);
756e5c89e4eSSatish Balay 
757e5c89e4eSSatish Balay   /* SHOULD PUT IN GUARDS: Make sure logging is initialized, even if we do not print it out */
758a9f03627SSatish Balay #if defined(PETSC_USE_LOG)
759e5c89e4eSSatish Balay   ierr = PetscLogBegin_Private();CHKERRQ(ierr);
760a9f03627SSatish Balay #endif
761e5c89e4eSSatish Balay 
762e5c89e4eSSatish Balay   /*
763e5c89e4eSSatish Balay      Load the dynamic libraries (on machines that support them), this registers all
764e5c89e4eSSatish Balay      the solvers etc. (On non-dynamic machines this initializes the PetscDraw and PetscViewer classes)
765e5c89e4eSSatish Balay   */
766e5c89e4eSSatish Balay   ierr = PetscInitialize_DynamicLibraries();CHKERRQ(ierr);
767e5c89e4eSSatish Balay 
768e5c89e4eSSatish Balay   ierr = MPI_Comm_size(PETSC_COMM_WORLD,&size);CHKERRQ(ierr);
769ae15b995SBarry Smith   ierr = PetscInfo1(0,"PETSc successfully started: number of processors = %d\n",size);CHKERRQ(ierr);
770e5c89e4eSSatish Balay   ierr = PetscGetHostName(hostname,256);CHKERRQ(ierr);
771ae15b995SBarry Smith   ierr = PetscInfo1(0,"Running on machine: %s\n",hostname);CHKERRQ(ierr);
772e5c89e4eSSatish Balay 
773e5c89e4eSSatish Balay   ierr = PetscOptionsCheckInitial_Components();CHKERRQ(ierr);
774ef6c6fedSBoyana Norris   /* Check the options database for options related to the options database itself */
775ef6c6fedSBoyana Norris   ierr = PetscOptionsSetFromOptions();CHKERRQ(ierr);
776ef6c6fedSBoyana Norris 
777951e3c8eSBarry Smith #if defined(PETSC_USE_PETSC_MPI_EXTERNAL32)
778e39fd77fSBarry Smith   /*
779e39fd77fSBarry Smith       Tell MPI about our own data representation converter, this would/should be used if extern32 is not supported by the MPI
780e39fd77fSBarry Smith 
781e39fd77fSBarry Smith       Currently not used because it is not supported by MPICH.
782e39fd77fSBarry Smith   */
783e39fd77fSBarry Smith #if !defined(PETSC_WORDS_BIGENDIAN)
784708350f5SSatish Balay   ierr = MPI_Register_datarep((char *)"petsc",PetscDataRep_read_conv_fn,PetscDataRep_write_conv_fn,PetscDataRep_extent_fn,PETSC_NULL);CHKERRQ(ierr);
785e39fd77fSBarry Smith #endif
786951e3c8eSBarry Smith #endif
787e39fd77fSBarry Smith 
788793721a6SBarry Smith   ierr = PetscOptionsGetInt(PETSC_NULL,"-openmp_spawn_size",&nodesize,&flg);CHKERRQ(ierr);
789793721a6SBarry Smith   if (flg) {
79023464e94SBarry Smith #if defined(PETSC_HAVE_MPI_COMM_SPAWN)
7919505b675SBarry Smith     ierr = PetscOpenMPSpawn((PetscMPIInt) nodesize);CHKERRQ(ierr); /* worker nodes never return from here; they go directly to PetscEnd() */
79223464e94SBarry Smith #else
793e32f2f54SBarry Smith     SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SUP,"PETSc built without MPI 2 (MPI_Comm_spawn) support, use -openmp_merge_size instead");
79423464e94SBarry Smith #endif
795793721a6SBarry Smith   } else {
79623464e94SBarry Smith     ierr = PetscOptionsGetInt(PETSC_NULL,"-openmp_merge_size",&nodesize,&flg);CHKERRQ(ierr);
7978002f1cdSBarry Smith     if (flg) {
7989505b675SBarry Smith       ierr = PetscOpenMPMerge((PetscMPIInt) nodesize,PETSC_NULL,PETSC_NULL);CHKERRQ(ierr);
7999505b675SBarry Smith       if (PetscOpenMPWorker) { /* if worker then never enter user code */
8009505b675SBarry Smith         ierr = PetscEnd();
8019505b675SBarry Smith       }
8028002f1cdSBarry Smith     }
803793721a6SBarry Smith   }
804e5c89e4eSSatish Balay 
80535d88935SVictor Minden #if defined(PETSC_HAVE_CUDA)
8062f947c57SVictor Minden   cublasInit();
8073e39abd9SVictor Minden #endif
80892e62aa6SBarry Smith 
80992e62aa6SBarry Smith #if defined(PETSC_HAVE_AMS)
810c457296dSBarry Smith   ierr = PetscOptionsHasName(PETSC_NULL,"-ams_publish_objects",&flg);CHKERRQ(ierr);
81192e62aa6SBarry Smith   if (flg) {
81292e62aa6SBarry Smith     PetscAMSPublishAll = PETSC_TRUE;
81392e62aa6SBarry Smith   }
81492e62aa6SBarry Smith #endif
81592e62aa6SBarry Smith 
8169ac80d5eSLisandro Dalcin   ierr = PetscOptionsHasName(PETSC_NULL,"-python",&flg);CHKERRQ(ierr);
8179ac80d5eSLisandro Dalcin   if (flg) {
8189ac80d5eSLisandro Dalcin     PetscInitializeCalled = PETSC_TRUE;
8199ac80d5eSLisandro Dalcin     ierr = PetscPythonInitialize(PETSC_NULL,PETSC_NULL);CHKERRQ(ierr);
8209ac80d5eSLisandro Dalcin   }
8219ac80d5eSLisandro Dalcin 
822301d30feSBarry Smith   /*
823301d30feSBarry Smith       Once we are completedly initialized then we can set this variables
824301d30feSBarry Smith   */
825301d30feSBarry Smith   PetscInitializeCalled = PETSC_TRUE;
826301d30feSBarry Smith   PetscFunctionReturn(0);
827e5c89e4eSSatish Balay }
828e5c89e4eSSatish Balay 
8292eff7a51SBarry Smith extern PetscObject *PetscObjects;
8302eff7a51SBarry Smith extern PetscInt    PetscObjectsCounts, PetscObjectsMaxCounts;
831e5c89e4eSSatish Balay 
832e5c89e4eSSatish Balay #undef __FUNCT__
833e5c89e4eSSatish Balay #define __FUNCT__ "PetscFinalize"
834e5c89e4eSSatish Balay /*@C
835e5c89e4eSSatish Balay    PetscFinalize - Checks for options to be called at the conclusion
836e5c89e4eSSatish Balay    of the program. MPI_Finalize() is called only if the user had not
837e5c89e4eSSatish Balay    called MPI_Init() before calling PetscInitialize().
838e5c89e4eSSatish Balay 
839e5c89e4eSSatish Balay    Collective on PETSC_COMM_WORLD
840e5c89e4eSSatish Balay 
841e5c89e4eSSatish Balay    Options Database Keys:
84288c29154SBarry Smith +  -options_table - Calls PetscOptionsView()
843e5c89e4eSSatish Balay .  -options_left - Prints unused options that remain in the database
8440a1571b3SBarry Smith .  -objects_left  - Prints list of all objects that have not been freed
845e5c89e4eSSatish Balay .  -mpidump - Calls PetscMPIDump()
846e5c89e4eSSatish Balay .  -malloc_dump - Calls PetscMallocDump()
847e5c89e4eSSatish Balay .  -malloc_info - Prints total memory usage
848e5c89e4eSSatish Balay -  -malloc_log - Prints summary of memory usage
849e5c89e4eSSatish Balay 
850e5c89e4eSSatish Balay    Options Database Keys for Profiling:
8510598bfebSBarry Smith    See the <a href="../../docs/manual.pdf#nameddest=ch_profiling">profiling chapter of the users manual</a> for details.
852e5c89e4eSSatish Balay +  -log_summary [filename] - Prints summary of flop and timing
853e5c89e4eSSatish Balay         information to screen. If the filename is specified the
85491eabc43SBarry Smith         summary is written to the file.  See PetscLogView().
855ff5bc46bSBarry Smith .  -log_summary_python [filename] - Prints data on of flop and timing usage to a file or screen.
85691eabc43SBarry Smith         See PetscLogPrintSViewPython().
857e5c89e4eSSatish Balay .  -log_all [filename] - Logs extensive profiling information
858ff5bc46bSBarry Smith         See PetscLogDump().
859ff5bc46bSBarry Smith .  -log [filename] - Logs basic profiline information  See PetscLogDump().
860e5c89e4eSSatish Balay .  -log_sync - Log the synchronization in scatters, inner products
861e5c89e4eSSatish Balay         and norms
862e5c89e4eSSatish Balay -  -log_mpe [filename] - Creates a logfile viewable by the
863e5c89e4eSSatish Balay       utility Upshot/Nupshot (in MPICH distribution)
864e5c89e4eSSatish Balay 
865e5c89e4eSSatish Balay    Level: beginner
866e5c89e4eSSatish Balay 
867e5c89e4eSSatish Balay    Note:
868e5c89e4eSSatish Balay    See PetscInitialize() for more general runtime options.
869e5c89e4eSSatish Balay 
87088c29154SBarry Smith .seealso: PetscInitialize(), PetscOptionsView(), PetscMallocDump(), PetscMPIDump(), PetscEnd()
871e5c89e4eSSatish Balay @*/
8727087cfbeSBarry Smith PetscErrorCode  PetscFinalize(void)
873e5c89e4eSSatish Balay {
874e5c89e4eSSatish Balay   PetscErrorCode ierr;
875e5c89e4eSSatish Balay   PetscMPIInt    rank;
8762eff7a51SBarry Smith   PetscInt       i,nopt;
8770a1571b3SBarry Smith   PetscBool      flg1 = PETSC_FALSE,flg2 = PETSC_FALSE,flg3 = PETSC_FALSE,objects_left = PETSC_FALSE;
878d5649816SBarry Smith #if defined(PETSC_HAVE_AMS)
879ace3abfcSBarry Smith   PetscBool      flg = PETSC_FALSE;
880d5649816SBarry Smith #endif
88110463e74SBarry Smith #if defined(PETSC_USE_LOG)
88210463e74SBarry Smith   char           mname[PETSC_MAX_PATH_LEN];
88310463e74SBarry Smith #endif
884e5c89e4eSSatish Balay 
885e5c89e4eSSatish Balay   PetscFunctionBegin;
886e5c89e4eSSatish Balay 
887e5c89e4eSSatish Balay   if (!PetscInitializeCalled) {
8884b09e917SBarry Smith     printf("PetscInitialize() must be called before PetscFinalize()\n");
8894b09e917SBarry Smith     PetscFunctionReturn(PETSC_ERR_ARG_WRONGSTATE);
890e5c89e4eSSatish Balay   }
891b022a5c1SBarry Smith   ierr = PetscInfo(PETSC_NULL,"PetscFinalize() called\n");
892b022a5c1SBarry Smith 
893d5649816SBarry Smith #if defined(PETSC_HAVE_AMS)
894acfcf0e5SJed Brown   ierr = PetscOptionsGetBool(PETSC_NULL,"-options_gui",&flg,PETSC_NULL);CHKERRQ(ierr);
895d5649816SBarry Smith   if (flg) {
896d5649816SBarry Smith     ierr = PetscOptionsAMSDestroy();CHKERRQ(ierr);
897d5649816SBarry Smith   }
898d5649816SBarry Smith #endif
899d5649816SBarry Smith 
9008002f1cdSBarry Smith   ierr = PetscOpenMPFinalize();CHKERRQ(ierr);
9018002f1cdSBarry Smith 
902e5c89e4eSSatish Balay   ierr = MPI_Comm_rank(PETSC_COMM_WORLD,&rank);CHKERRQ(ierr);
903acfcf0e5SJed Brown   ierr = PetscOptionsGetBool(PETSC_NULL,"-malloc_info",&flg2,PETSC_NULL);CHKERRQ(ierr);
904e5c89e4eSSatish Balay   if (!flg2) {
90590d69ab7SBarry Smith     flg2 = PETSC_FALSE;
906acfcf0e5SJed Brown     ierr = PetscOptionsGetBool(PETSC_NULL,"-memory_info",&flg2,PETSC_NULL);CHKERRQ(ierr);
907e5c89e4eSSatish Balay   }
908e5c89e4eSSatish Balay   if (flg2) {
909e5c89e4eSSatish Balay     ierr = PetscMemoryShowUsage(PETSC_VIEWER_STDOUT_WORLD,"Summary of Memory Usage in PETSc\n");CHKERRQ(ierr);
910e5c89e4eSSatish Balay   }
911e5c89e4eSSatish Balay 
912e5c89e4eSSatish Balay #if defined(PETSC_USE_LOG)
91390d69ab7SBarry Smith   flg1 = PETSC_FALSE;
914acfcf0e5SJed Brown   ierr = PetscOptionsGetBool(PETSC_NULL,"-get_total_flops",&flg1,PETSC_NULL);CHKERRQ(ierr);
915e5c89e4eSSatish Balay   if (flg1) {
916e5c89e4eSSatish Balay     PetscLogDouble flops = 0;
917e5c89e4eSSatish Balay     ierr = MPI_Reduce(&_TotalFlops,&flops,1,MPI_DOUBLE,MPI_SUM,0,PETSC_COMM_WORLD);CHKERRQ(ierr);
918e5c89e4eSSatish Balay     ierr = PetscPrintf(PETSC_COMM_WORLD,"Total flops over all processors %g\n",flops);CHKERRQ(ierr);
919e5c89e4eSSatish Balay   }
920e5c89e4eSSatish Balay #endif
921e5c89e4eSSatish Balay 
922e5c89e4eSSatish Balay 
923e5c89e4eSSatish Balay #if defined(PETSC_USE_LOG)
924e5c89e4eSSatish Balay #if defined(PETSC_HAVE_MPE)
925e5c89e4eSSatish Balay   mname[0] = 0;
926e5c89e4eSSatish Balay   ierr = PetscOptionsGetString(PETSC_NULL,"-log_mpe",mname,PETSC_MAX_PATH_LEN,&flg1);CHKERRQ(ierr);
927e5c89e4eSSatish Balay   if (flg1){
928e5c89e4eSSatish Balay     if (mname[0]) {ierr = PetscLogMPEDump(mname);CHKERRQ(ierr);}
929e5c89e4eSSatish Balay     else          {ierr = PetscLogMPEDump(0);CHKERRQ(ierr);}
930e5c89e4eSSatish Balay   }
931e5c89e4eSSatish Balay #endif
932e5c89e4eSSatish Balay   mname[0] = 0;
933e5c89e4eSSatish Balay   ierr = PetscOptionsGetString(PETSC_NULL,"-log_summary",mname,PETSC_MAX_PATH_LEN,&flg1);CHKERRQ(ierr);
934e5c89e4eSSatish Balay   if (flg1) {
93591eabc43SBarry Smith     PetscViewer viewer;
93691eabc43SBarry Smith     if (mname[0])  {
93791eabc43SBarry Smith       ierr = PetscViewerASCIIOpen(PETSC_COMM_WORLD,mname,&viewer);CHKERRQ(ierr);
93891eabc43SBarry Smith       ierr = PetscLogView(viewer);CHKERRQ(ierr);
9396bf464f9SBarry Smith       ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr);
94033f85c2fSBarry Smith     } else {
94133f85c2fSBarry Smith       viewer = PETSC_VIEWER_STDOUT_WORLD;
94233f85c2fSBarry Smith       ierr = PetscLogView(viewer);CHKERRQ(ierr);
94333f85c2fSBarry Smith     }
944e5c89e4eSSatish Balay   }
945e5c89e4eSSatish Balay 
946ff5bc46bSBarry Smith   mname[0] = 0;
947ff5bc46bSBarry Smith   ierr = PetscOptionsGetString(PETSC_NULL,"-log_summary_python",mname,PETSC_MAX_PATH_LEN,&flg1);CHKERRQ(ierr);
948ff5bc46bSBarry Smith   if (flg1) {
949ff5bc46bSBarry Smith     PetscViewer viewer;
950ff5bc46bSBarry Smith     if (mname[0])  {
951ff5bc46bSBarry Smith       ierr = PetscViewerASCIIOpen(PETSC_COMM_WORLD,mname,&viewer);CHKERRQ(ierr);
95291eabc43SBarry Smith       ierr = PetscLogViewPython(viewer);CHKERRQ(ierr);
9536bf464f9SBarry Smith       ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr);
95433f85c2fSBarry Smith     } else {
95533f85c2fSBarry Smith       viewer = PETSC_VIEWER_STDOUT_WORLD;
95633f85c2fSBarry Smith       ierr = PetscLogViewPython(viewer);CHKERRQ(ierr);
95733f85c2fSBarry Smith     }
958ff5bc46bSBarry Smith   }
959ff5bc46bSBarry Smith 
96078392ef1SBarry Smith   ierr = PetscOptionsGetString(PETSC_NULL,"-log_detailed",mname,PETSC_MAX_PATH_LEN,&flg1);CHKERRQ(ierr);
96178392ef1SBarry Smith   if (flg1) {
96278392ef1SBarry Smith     if (mname[0])  {ierr = PetscLogPrintDetailed(PETSC_COMM_WORLD,mname);CHKERRQ(ierr);}
96378392ef1SBarry Smith     else           {ierr = PetscLogPrintDetailed(PETSC_COMM_WORLD,0);CHKERRQ(ierr);}
96478392ef1SBarry Smith   }
96578392ef1SBarry Smith 
966e5c89e4eSSatish Balay   mname[0] = 0;
967e5c89e4eSSatish Balay   ierr = PetscOptionsGetString(PETSC_NULL,"-log_all",mname,PETSC_MAX_PATH_LEN,&flg1);CHKERRQ(ierr);
968e5c89e4eSSatish Balay   ierr = PetscOptionsGetString(PETSC_NULL,"-log",mname,PETSC_MAX_PATH_LEN,&flg2);CHKERRQ(ierr);
969e5c89e4eSSatish Balay   if (flg1 || flg2){
970e5c89e4eSSatish Balay     if (mname[0]) PetscLogDump(mname);
971e5c89e4eSSatish Balay     else          PetscLogDump(0);
972e5c89e4eSSatish Balay   }
973e5c89e4eSSatish Balay #endif
97410463e74SBarry Smith 
97533f85c2fSBarry Smith #if defined(PETSC_USE_DEBUG) && !defined(PETSC_USE_PTHREAD)
97633f85c2fSBarry Smith   if (PetscStackActive) {
97733f85c2fSBarry Smith     ierr = PetscStackDestroy();CHKERRQ(ierr);
97833f85c2fSBarry Smith   }
97933f85c2fSBarry Smith #endif
98010463e74SBarry Smith 
98190d69ab7SBarry Smith   flg1 = PETSC_FALSE;
982acfcf0e5SJed Brown   ierr = PetscOptionsGetBool(PETSC_NULL,"-no_signal_handler",&flg1,PETSC_NULL);CHKERRQ(ierr);
983e5c89e4eSSatish Balay   if (!flg1) { ierr = PetscPopSignalHandler();CHKERRQ(ierr);}
98490d69ab7SBarry Smith   flg1 = PETSC_FALSE;
985acfcf0e5SJed Brown   ierr = PetscOptionsGetBool(PETSC_NULL,"-mpidump",&flg1,PETSC_NULL);CHKERRQ(ierr);
986e5c89e4eSSatish Balay   if (flg1) {
987e5c89e4eSSatish Balay     ierr = PetscMPIDump(stdout);CHKERRQ(ierr);
988e5c89e4eSSatish Balay   }
98990d69ab7SBarry Smith   flg1 = PETSC_FALSE;
99090d69ab7SBarry Smith   flg2 = PETSC_FALSE;
9918bb29257SSatish Balay   /* preemptive call to avoid listing this option in options table as unused */
9928bb29257SSatish Balay   ierr = PetscOptionsHasName(PETSC_NULL,"-malloc_dump",&flg1);CHKERRQ(ierr);
993acfcf0e5SJed Brown   ierr = PetscOptionsGetBool(PETSC_NULL,"-options_table",&flg2,PETSC_NULL);CHKERRQ(ierr);
994e4c476e2SSatish Balay 
995e5c89e4eSSatish Balay   if (flg2) {
99619fcac0cSJed Brown     ierr = PetscOptionsView(PETSC_VIEWER_STDOUT_WORLD);CHKERRQ(ierr);
997e5c89e4eSSatish Balay   }
998e5c89e4eSSatish Balay 
999e5c89e4eSSatish Balay   /* to prevent PETSc -options_left from warning */
1000cb9801acSJed Brown   ierr = PetscOptionsHasName(PETSC_NULL,"-nox",&flg1);CHKERRQ(ierr);
1001cb9801acSJed Brown   ierr = PetscOptionsHasName(PETSC_NULL,"-nox_warning",&flg1);CHKERRQ(ierr);
10020a1571b3SBarry Smith   ierr = PetscOptionsGetBool(PETSC_NULL,"-objects_left",&objects_left,PETSC_NULL);CHKERRQ(ierr);
1003e5c89e4eSSatish Balay 
1004f43cc0c9SSatish Balay   if (!PetscOpenMPWorker) { /* worker processes skip this because they do not usually process options */
100533fc4174SSatish Balay     flg3 = PETSC_FALSE; /* default value is required */
1006acfcf0e5SJed Brown     ierr = PetscOptionsGetBool(PETSC_NULL,"-options_left",&flg3,&flg1);CHKERRQ(ierr);
1007e5c89e4eSSatish Balay     ierr = PetscOptionsAllUsed(&nopt);CHKERRQ(ierr);
1008e5c89e4eSSatish Balay     if (flg3) {
1009e5c89e4eSSatish Balay       if (!flg2) { /* have not yet printed the options */
101033f85c2fSBarry Smith 	ierr = PetscOptionsView(PETSC_VIEWER_STDOUT_WORLD);CHKERRQ(ierr);
1011e5c89e4eSSatish Balay       }
1012e5c89e4eSSatish Balay       if (!nopt) {
1013e5c89e4eSSatish Balay 	ierr = PetscPrintf(PETSC_COMM_WORLD,"There are no unused options.\n");CHKERRQ(ierr);
1014e5c89e4eSSatish Balay       } else if (nopt == 1) {
1015e5c89e4eSSatish Balay 	ierr = PetscPrintf(PETSC_COMM_WORLD,"There is one unused database option. It is:\n");CHKERRQ(ierr);
1016e5c89e4eSSatish Balay       } else {
10177582186dSLisandro Dalcin 	ierr = PetscPrintf(PETSC_COMM_WORLD,"There are %D unused database options. They are:\n",nopt);CHKERRQ(ierr);
1018e5c89e4eSSatish Balay       }
1019e5c89e4eSSatish Balay     }
1020e5c89e4eSSatish Balay #if defined(PETSC_USE_DEBUG)
1021da8b8a77SBarry Smith     if (nopt && !flg3 && !flg1) {
1022e5c89e4eSSatish Balay       ierr = PetscPrintf(PETSC_COMM_WORLD,"WARNING! There are options you set that were not used!\n");CHKERRQ(ierr);
1023e5c89e4eSSatish Balay       ierr = PetscPrintf(PETSC_COMM_WORLD,"WARNING! could be spelling mistake, etc!\n");CHKERRQ(ierr);
1024e5c89e4eSSatish Balay       ierr = PetscOptionsLeft();CHKERRQ(ierr);
1025e5c89e4eSSatish Balay     } else if (nopt && flg3) {
1026e5c89e4eSSatish Balay #else
1027e5c89e4eSSatish Balay     if (nopt && flg3) {
1028e5c89e4eSSatish Balay #endif
1029e5c89e4eSSatish Balay       ierr = PetscOptionsLeft();CHKERRQ(ierr);
1030e5c89e4eSSatish Balay     }
1031931f367cSBarry Smith   }
1032e5c89e4eSSatish Balay 
103310463e74SBarry Smith   /*
103433f85c2fSBarry Smith      Free all objects registered with PetscObjectRegisterDestroy() such as PETSC_VIEWER_XXX_().
103533f85c2fSBarry Smith   */
103633f85c2fSBarry Smith   ierr = PetscObjectRegisterDestroyAll();CHKERRQ(ierr);
103733f85c2fSBarry Smith 
10382eff7a51SBarry Smith   /*
1039dbc8283eSBarry Smith        List all objects the user may have forgot to free
10402eff7a51SBarry Smith   */
10410a1571b3SBarry Smith   if (objects_left && PetscObjectsCounts) {
1042dbc8283eSBarry Smith     ierr = PetscPrintf(PETSC_COMM_WORLD,"The following objects %D were never freed\n",PetscObjectsCounts);
10430a1571b3SBarry Smith   }
10442eff7a51SBarry Smith   for (i=0; i<PetscObjectsMaxCounts; i++) {
10452eff7a51SBarry Smith     if (PetscObjects[i]) {
10460a1571b3SBarry Smith       if (objects_left) {
10470a1571b3SBarry Smith         ierr = PetscPrintf(PETSC_COMM_WORLD,"  %s %s %s\n",PetscObjects[i]->class_name,PetscObjects[i]->type_name,PetscObjects[i]->name);CHKERRQ(ierr);
10480a1571b3SBarry Smith       }
10492eff7a51SBarry Smith     }
10502eff7a51SBarry Smith   }
1051dbc8283eSBarry Smith   /* cannot actually destroy the left over objects, but destroy the list */
1052dbc8283eSBarry Smith   PetscObjectsCounts    = 0;
1053dbc8283eSBarry Smith   PetscObjectsMaxCounts = 0;
1054dbc8283eSBarry Smith   ierr = PetscFree(PetscObjects);CHKERRQ(ierr);
10552eff7a51SBarry Smith 
10562eff7a51SBarry Smith 
105733f85c2fSBarry Smith #if defined(PETSC_USE_LOG)
105833f85c2fSBarry Smith   ierr = PetscLogDestroy();CHKERRQ(ierr);
105933f85c2fSBarry Smith #endif
106033f85c2fSBarry Smith 
106133f85c2fSBarry Smith   /*
106233f85c2fSBarry Smith        Free all the registered create functions, such as KSPList, VecList, SNESList, etc
106333f85c2fSBarry Smith   */
106433f85c2fSBarry Smith   ierr = PetscFListDestroyAll();CHKERRQ(ierr);
106533f85c2fSBarry Smith 
106633f85c2fSBarry Smith   /*
106733f85c2fSBarry Smith      Destroy any packages that registered a finalize
106833f85c2fSBarry Smith   */
106933f85c2fSBarry Smith   ierr = PetscRegisterFinalizeAll();CHKERRQ(ierr);
107033f85c2fSBarry Smith 
107133f85c2fSBarry Smith   /*
107210463e74SBarry Smith      Destroy all the function registration lists created
107310463e74SBarry Smith   */
107410463e74SBarry Smith   ierr = PetscFinalize_DynamicLibraries();CHKERRQ(ierr);
107510463e74SBarry Smith 
10764028d114SSatish Balay   if (petsc_history) {
1077f3dea69dSBarry Smith     ierr = PetscCloseHistoryFile(&petsc_history);CHKERRQ(ierr);
1078e5c89e4eSSatish Balay     petsc_history = 0;
1079e5c89e4eSSatish Balay   }
1080e5c89e4eSSatish Balay 
10816cf91177SBarry Smith   ierr = PetscInfoAllow(PETSC_FALSE,PETSC_NULL);CHKERRQ(ierr);
1082e5c89e4eSSatish Balay 
10838bb29257SSatish Balay   {
1084e5c89e4eSSatish Balay     char fname[PETSC_MAX_PATH_LEN];
1085e5c89e4eSSatish Balay     FILE *fd;
1086ed9cf6e9SBarry Smith     int  err;
1087e5c89e4eSSatish Balay 
1088e5c89e4eSSatish Balay     fname[0] = 0;
1089e5c89e4eSSatish Balay     ierr = PetscOptionsGetString(PETSC_NULL,"-malloc_dump",fname,250,&flg1);CHKERRQ(ierr);
1090e5c89e4eSSatish Balay     if (flg1 && fname[0]) {
1091e5c89e4eSSatish Balay       char sname[PETSC_MAX_PATH_LEN];
1092e5c89e4eSSatish Balay 
1093e5c89e4eSSatish Balay       sprintf(sname,"%s_%d",fname,rank);
1094e32f2f54SBarry Smith       fd   = fopen(sname,"w"); if (!fd) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_FILE_OPEN,"Cannot open log file: %s",sname);
1095e5c89e4eSSatish Balay       ierr = PetscMallocDump(fd);CHKERRQ(ierr);
1096ed9cf6e9SBarry Smith       err = fclose(fd);
1097e32f2f54SBarry Smith       if (err) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SYS,"fclose() failed on file");
10988bb29257SSatish Balay     } else if (flg1) {
1099e5c89e4eSSatish Balay       MPI_Comm local_comm;
1100e5c89e4eSSatish Balay 
1101e5c89e4eSSatish Balay       ierr = MPI_Comm_dup(MPI_COMM_WORLD,&local_comm);CHKERRQ(ierr);
1102e5c89e4eSSatish Balay       ierr = PetscSequentialPhaseBegin_Private(local_comm,1);CHKERRQ(ierr);
1103e5c89e4eSSatish Balay         ierr = PetscMallocDump(stdout);CHKERRQ(ierr);
1104e5c89e4eSSatish Balay       ierr = PetscSequentialPhaseEnd_Private(local_comm,1);CHKERRQ(ierr);
1105e5c89e4eSSatish Balay       ierr = MPI_Comm_free(&local_comm);CHKERRQ(ierr);
1106e5c89e4eSSatish Balay     }
1107e5c89e4eSSatish Balay   }
11088bb29257SSatish Balay   {
1109e5c89e4eSSatish Balay     char fname[PETSC_MAX_PATH_LEN];
1110e5c89e4eSSatish Balay     FILE *fd;
1111e5c89e4eSSatish Balay 
1112e5c89e4eSSatish Balay     fname[0] = 0;
1113e5c89e4eSSatish Balay     ierr = PetscOptionsGetString(PETSC_NULL,"-malloc_log",fname,250,&flg1);CHKERRQ(ierr);
1114e5c89e4eSSatish Balay     if (flg1 && fname[0]) {
1115e5c89e4eSSatish Balay       char sname[PETSC_MAX_PATH_LEN];
1116ed9cf6e9SBarry Smith       int  err;
1117e5c89e4eSSatish Balay 
1118e5c89e4eSSatish Balay       sprintf(sname,"%s_%d",fname,rank);
1119e32f2f54SBarry Smith       fd   = fopen(sname,"w"); if (!fd) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_FILE_OPEN,"Cannot open log file: %s",sname);
1120e5c89e4eSSatish Balay       ierr = PetscMallocDumpLog(fd);CHKERRQ(ierr);
1121ed9cf6e9SBarry Smith       err = fclose(fd);
1122e32f2f54SBarry Smith       if (err) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SYS,"fclose() failed on file");
11238bb29257SSatish Balay     } else if (flg1) {
1124e5c89e4eSSatish Balay       ierr = PetscMallocDumpLog(stdout);CHKERRQ(ierr);
1125e5c89e4eSSatish Balay     }
1126e5c89e4eSSatish Balay   }
1127e5c89e4eSSatish Balay   /* Can be destroyed only after all the options are used */
1128e5c89e4eSSatish Balay   ierr = PetscOptionsDestroy();CHKERRQ(ierr);
1129e5c89e4eSSatish Balay 
1130e5c89e4eSSatish Balay   PetscGlobalArgc = 0;
1131e5c89e4eSSatish Balay   PetscGlobalArgs = 0;
1132e5c89e4eSSatish Balay 
1133ce63c4c1SBarry Smith #if defined(PETSC_USE_REAL___FLOAT128)
1134c90a1750SBarry Smith   ierr = MPI_Type_free(&MPIU___FLOAT128);CHKERRQ(ierr);
1135854411e3SBarry Smith   ierr = MPI_Op_free(&MPIU_SUM);CHKERRQ(ierr);
1136d9822059SBarry Smith   ierr = MPI_Op_free(&MPIU_MAX);CHKERRQ(ierr);
1137d9822059SBarry Smith   ierr = MPI_Op_free(&MPIU_MIN);CHKERRQ(ierr);
1138c90a1750SBarry Smith #endif
1139c90a1750SBarry Smith 
1140e5c89e4eSSatish Balay #if defined(PETSC_USE_COMPLEX)
11412c876bd9SBarry Smith #if !defined(PETSC_HAVE_MPI_C_DOUBLE_COMPLEX)
114206a205a8SBarry Smith   ierr = MPI_Op_free(&MPIU_SUM);CHKERRQ(ierr);
11432c876bd9SBarry Smith   ierr = MPI_Type_free(&MPI_C_DOUBLE_COMPLEX);CHKERRQ(ierr);
1144a83b8d76SBarry Smith   ierr = MPI_Type_free(&MPI_C_COMPLEX);CHKERRQ(ierr);
11452c876bd9SBarry Smith #endif
1146e5c89e4eSSatish Balay #endif
1147e5c89e4eSSatish Balay   ierr = MPI_Type_free(&MPIU_2SCALAR);CHKERRQ(ierr);
1148e5c89e4eSSatish Balay   ierr = MPI_Type_free(&MPIU_2INT);CHKERRQ(ierr);
1149e5c89e4eSSatish Balay   ierr = MPI_Op_free(&PetscMaxSum_Op);CHKERRQ(ierr);
1150e5c89e4eSSatish Balay   ierr = MPI_Op_free(&PetscADMax_Op);CHKERRQ(ierr);
1151e5c89e4eSSatish Balay   ierr = MPI_Op_free(&PetscADMin_Op);CHKERRQ(ierr);
1152e5c89e4eSSatish Balay 
1153dbc8283eSBarry Smith   /*
1154dbc8283eSBarry Smith      Destroy any known inner communicators and attributes pointing to them
1155dbc8283eSBarry Smith      Note this will not destroy any new communicators the user has created
1156dbc8283eSBarry Smith  */
1157b770b1f6SSatish Balay   {
1158dbc8283eSBarry Smith     PetscCommCounter *counter;
1159dbc8283eSBarry Smith     PetscMPIInt      flg;
1160dbc8283eSBarry Smith     MPI_Comm         icomm;
1161dbc8283eSBarry Smith     void             *ptr;
1162dbc8283eSBarry Smith     ierr  = MPI_Attr_get(PETSC_COMM_SELF,Petsc_InnerComm_keyval,&ptr,&flg);CHKERRQ(ierr);
1163dbc8283eSBarry Smith     if (flg) {
1164dbc8283eSBarry Smith       /*  Use PetscMemcpy() because casting from pointer to integer of different size is not allowed with some compilers  */
1165dbc8283eSBarry Smith       ierr = PetscMemcpy(&icomm,&ptr,sizeof(MPI_Comm));CHKERRQ(ierr);
1166dbc8283eSBarry Smith       ierr = MPI_Attr_get(icomm,Petsc_Counter_keyval,&counter,&flg);CHKERRQ(ierr);
1167dbc8283eSBarry 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");
1168dbc8283eSBarry Smith 
1169dbc8283eSBarry Smith       ierr = MPI_Attr_delete(icomm,Petsc_Counter_keyval);CHKERRQ(ierr);
1170dbc8283eSBarry Smith       ierr = MPI_Attr_delete(icomm,Petsc_OuterComm_keyval);CHKERRQ(ierr);
1171dbc8283eSBarry Smith       ierr = MPI_Comm_free(&icomm);CHKERRQ(ierr);
1172dbc8283eSBarry Smith       ierr = MPI_Attr_delete(PETSC_COMM_SELF,Petsc_InnerComm_keyval);CHKERRQ(ierr);
1173dbc8283eSBarry Smith     }
1174dbc8283eSBarry Smith     ierr  = MPI_Attr_get(PETSC_COMM_WORLD,Petsc_InnerComm_keyval,&ptr,&flg);CHKERRQ(ierr);
1175dbc8283eSBarry Smith     if (flg) {
1176dbc8283eSBarry Smith       /*  Use PetscMemcpy() because casting from pointer to integer of different size is not allowed with some compilers  */
1177dbc8283eSBarry Smith       ierr = PetscMemcpy(&icomm,&ptr,sizeof(MPI_Comm));CHKERRQ(ierr);
1178dbc8283eSBarry Smith       ierr = MPI_Attr_get(icomm,Petsc_Counter_keyval,&counter,&flg);CHKERRQ(ierr);
1179dbc8283eSBarry 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");
1180dbc8283eSBarry Smith 
1181dbc8283eSBarry Smith       ierr = MPI_Attr_delete(icomm,Petsc_Counter_keyval);CHKERRQ(ierr);
1182dbc8283eSBarry Smith       ierr = MPI_Attr_delete(icomm,Petsc_OuterComm_keyval);CHKERRQ(ierr);
1183dbc8283eSBarry Smith       ierr = MPI_Comm_free(&icomm);CHKERRQ(ierr);
1184dbc8283eSBarry Smith       ierr = MPI_Attr_delete(PETSC_COMM_WORLD,Petsc_InnerComm_keyval);CHKERRQ(ierr);
1185dbc8283eSBarry Smith     }
1186b770b1f6SSatish Balay   }
1187dbc8283eSBarry Smith 
1188480cf27aSJed Brown   ierr = MPI_Keyval_free(&Petsc_Counter_keyval);CHKERRQ(ierr);
1189480cf27aSJed Brown   ierr = MPI_Keyval_free(&Petsc_InnerComm_keyval);CHKERRQ(ierr);
1190480cf27aSJed Brown   ierr = MPI_Keyval_free(&Petsc_OuterComm_keyval);CHKERRQ(ierr);
1191480cf27aSJed Brown 
1192ae15b995SBarry Smith   ierr = PetscInfo(0,"PETSc successfully ended!\n");CHKERRQ(ierr);
1193e5c89e4eSSatish Balay   if (PetscBeganMPI) {
119499608316SBarry Smith #if defined(PETSC_HAVE_MPI_FINALIZED)
119599b1327fSBarry Smith     PetscMPIInt flag;
119699b1327fSBarry Smith     ierr = MPI_Finalized(&flag);CHKERRQ(ierr);
1197e32f2f54SBarry Smith     if (flag) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_LIB,"MPI_Finalize() has already been called, even though MPI_Init() was called by PetscInitialize()");
119899608316SBarry Smith #endif
1199e5c89e4eSSatish Balay     ierr = MPI_Finalize();CHKERRQ(ierr);
1200e5c89e4eSSatish Balay   }
1201e5c89e4eSSatish Balay 
12029c4c166aSBarry Smith   if (PETSC_ZOPEFD){
120322b84c2fSbcordonn     if (PETSC_ZOPEFD != PETSC_STDOUT) fprintf(PETSC_ZOPEFD, "<<<end>>>");
12049c4c166aSBarry Smith     else fprintf(PETSC_STDOUT, "<<<end>>>");
12059c4c166aSBarry Smith   }
120636186564Sbcordonn 
120735d88935SVictor Minden #if defined(PETSC_HAVE_CUDA)
12082f947c57SVictor Minden   cublasShutdown();
1209440a5bbfSVictor Minden #endif
1210e5c89e4eSSatish Balay /*
1211e5c89e4eSSatish Balay 
1212e5c89e4eSSatish Balay      Note: In certain cases PETSC_COMM_WORLD is never MPI_Comm_free()ed because
1213e5c89e4eSSatish Balay    the communicator has some outstanding requests on it. Specifically if the
1214e5c89e4eSSatish Balay    flag PETSC_HAVE_BROKEN_REQUEST_FREE is set (for IBM MPI implementation). See
1215e5c89e4eSSatish Balay    src/vec/utils/vpscat.c. Due to this the memory allocated in PetscCommDuplicate()
1216e5c89e4eSSatish Balay    is never freed as it should be. Thus one may obtain messages of the form
12170e5e90baSSatish Balay    [ 1] 8 bytes PetscCommDuplicate() line 645 in src/sys/mpiu.c indicating the
1218e5c89e4eSSatish Balay    memory was not freed.
1219e5c89e4eSSatish Balay 
1220e5c89e4eSSatish Balay */
12211d1a0024SBarry Smith   ierr = PetscMallocClear();CHKERRQ(ierr);
1222e5c89e4eSSatish Balay   PetscInitializeCalled = PETSC_FALSE;
1223e5c89e4eSSatish Balay   PetscFinalizeCalled   = PETSC_TRUE;
1224e5c89e4eSSatish Balay   PetscFunctionReturn(ierr);
1225e5c89e4eSSatish Balay }
1226e5c89e4eSSatish Balay 
1227