xref: /petsc/src/sys/objects/pinit.c (revision 142c234b3435c5a5de021f631545538f3713b883)
17d0a6c19SBarry Smith 
2e5c89e4eSSatish Balay /*
3e5c89e4eSSatish Balay    This file defines the initialization of PETSc, including PetscInitialize()
4e5c89e4eSSatish Balay */
550f81f78SJed Brown #define PETSC_DESIRE_COMPLEX
6afcb2eb5SJed Brown #include <petsc-private/petscimpl.h>        /*I  "petscsys.h"   I*/
7665c2dedSJed Brown #include <petscviewer.h>
88101f56cSMatthew Knepley 
9663ba86aSMatthew G Knepley #if defined(PETSC_HAVE_CUDA)
102f947c57SVictor Minden #include <cublas.h>
117a025f21SVictor Minden #endif
127a025f21SVictor Minden 
13bd8b14e7SShri Abhyankar #include <petscthreadcomm.h>
14bd8b14e7SShri Abhyankar 
15a9f03627SSatish Balay #if defined(PETSC_USE_LOG)
1609573ac7SBarry Smith extern PetscErrorCode PetscLogBegin_Private(void);
17a9f03627SSatish Balay #endif
1885afcc9aSBarry Smith extern PetscBool PetscHMPIWorker;
19f2d66bcaSShri Abhyankar 
202d53ad75SBarry Smith #if defined(PETSC_SERIALIZE_FUNCTIONS)
212d53ad75SBarry Smith PetscFPT PetscFPTData = 0;
222d53ad75SBarry Smith #endif
232d53ad75SBarry Smith 
24a6790183SBarry Smith #if defined(PETSC_HAVE_SAWS)
2516ad0300SBarry Smith #include <petscviewersaws.h>
26a6790183SBarry Smith #endif
27e5c89e4eSSatish Balay /* -----------------------------------------------------------------------------------------*/
28e5c89e4eSSatish Balay 
29e5c89e4eSSatish Balay extern FILE *petsc_history;
30e5c89e4eSSatish Balay 
3109573ac7SBarry Smith extern PetscErrorCode PetscInitialize_DynamicLibraries(void);
3209573ac7SBarry Smith extern PetscErrorCode PetscFinalize_DynamicLibraries(void);
3337e93019SBarry Smith extern PetscErrorCode PetscFunctionListPrintAll(void);
3409573ac7SBarry Smith extern PetscErrorCode PetscSequentialPhaseBegin_Private(MPI_Comm,int);
3509573ac7SBarry Smith extern PetscErrorCode PetscSequentialPhaseEnd_Private(MPI_Comm,int);
3609573ac7SBarry Smith extern PetscErrorCode PetscCloseHistoryFile(FILE**);
370069ddf5SShri Abhyankar 
38e5c89e4eSSatish Balay /* user may set this BEFORE calling PetscInitialize() */
39e8373e55SMatthew Knepley MPI_Comm PETSC_COMM_WORLD = MPI_COMM_NULL;
40e5c89e4eSSatish Balay 
41480cf27aSJed Brown PetscMPIInt Petsc_Counter_keyval   = MPI_KEYVAL_INVALID;
42480cf27aSJed Brown PetscMPIInt Petsc_InnerComm_keyval = MPI_KEYVAL_INVALID;
43480cf27aSJed Brown PetscMPIInt Petsc_OuterComm_keyval = MPI_KEYVAL_INVALID;
44480cf27aSJed Brown 
45e5c89e4eSSatish Balay /*
46e5c89e4eSSatish Balay      Declare and set all the string names of the PETSc enums
47e5c89e4eSSatish Balay */
486a6fc655SJed Brown const char *const PetscBools[]     = {"FALSE","TRUE","PetscBool","PETSC_",0};
496a6fc655SJed Brown const char *const PetscCopyModes[] = {"COPY_VALUES","OWN_POINTER","USE_POINTER","PetscCopyMode","PETSC_",0};
506a6fc655SJed Brown const char *const PetscDataTypes[] = {"INT","DOUBLE","COMPLEX","LONG","SHORT","FLOAT",
512d53ad75SBarry Smith                                       "CHAR","LOGICAL","ENUM","BOOL","LONGDOUBLE","OBJECT","FUNCTION","PetscDataType","PETSC_",0};
52e5c89e4eSSatish Balay 
53ace3abfcSBarry Smith PetscBool PetscPreLoadingUsed = PETSC_FALSE;
54ace3abfcSBarry Smith PetscBool PetscPreLoadingOn   = PETSC_FALSE;
550f8e0872SSatish Balay 
56a2f94806SJed Brown PetscInt PetscHotRegionDepth;
57a2f94806SJed Brown 
58e5c89e4eSSatish Balay /*
59e5c89e4eSSatish Balay        Checks the options database for initializations related to the
60e5c89e4eSSatish Balay     PETSc components
61e5c89e4eSSatish Balay */
62e5c89e4eSSatish Balay #undef __FUNCT__
63e5c89e4eSSatish Balay #define __FUNCT__ "PetscOptionsCheckInitial_Components"
647087cfbeSBarry Smith PetscErrorCode  PetscOptionsCheckInitial_Components(void)
65e5c89e4eSSatish Balay {
66ace3abfcSBarry Smith   PetscBool      flg1;
67e5c89e4eSSatish Balay   PetscErrorCode ierr;
68e5c89e4eSSatish Balay 
69e5c89e4eSSatish Balay   PetscFunctionBegin;
700298fd71SBarry Smith   ierr = PetscOptionsHasName(NULL,"-help",&flg1);CHKERRQ(ierr);
71e5c89e4eSSatish Balay   if (flg1) {
72e5c89e4eSSatish Balay #if defined(PETSC_USE_LOG)
73e8e7597cSSatish Balay     MPI_Comm comm = PETSC_COMM_WORLD;
74e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm,"------Additional PETSc component options--------\n");CHKERRQ(ierr);
75e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm," -log_summary_exclude: <vec,mat,pc.ksp,snes>\n");CHKERRQ(ierr);
766cf91177SBarry Smith     ierr = (*PetscHelpPrintf)(comm," -info_exclude: <null,vec,mat,pc,ksp,snes,ts>\n");CHKERRQ(ierr);
77e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm,"-----------------------------------------------\n");CHKERRQ(ierr);
78e5c89e4eSSatish Balay #endif
79e5c89e4eSSatish Balay   }
80e5c89e4eSSatish Balay   PetscFunctionReturn(0);
81e5c89e4eSSatish Balay }
82e5c89e4eSSatish Balay 
83e5c89e4eSSatish Balay #undef __FUNCT__
84945d1669SBarry Smith #define __FUNCT__ "PetscInitializeNoPointers"
850f11a792SBarry Smith /*
86945d1669SBarry Smith       PetscInitializeNoPointers - Calls PetscInitialize() from C/C++ without the pointers to argc and args
8772a42c3cSBarry Smith 
8872a42c3cSBarry Smith    Collective
8972a42c3cSBarry Smith 
9072a42c3cSBarry Smith    Level: advanced
9172a42c3cSBarry Smith 
92945d1669SBarry Smith     Notes: this is called only by the PETSc MATLAB and Julia interface. Even though it might start MPI it sets the flag to
930f11a792SBarry Smith      indicate that it did NOT start MPI so that the PetscFinalize() does not end MPI, thus allowing PetscInitialize() to
94945d1669SBarry Smith      be called multiple times from MATLAB and Julia without the problem of trying to initialize MPI more than once.
950f11a792SBarry Smith 
961ea5a559SBarry Smith      Turns off PETSc signal handling because that can interact with MATLAB's signal handling causing random crashes.
971ea5a559SBarry Smith 
9872a42c3cSBarry Smith .seealso: PetscInitialize(), PetscInitializeFortran(), PetscInitializeNoArguments()
990f11a792SBarry Smith */
100945d1669SBarry Smith PetscErrorCode  PetscInitializeNoPointers(int argc,char **args,const char *filename,const char *help)
10172a42c3cSBarry Smith {
10272a42c3cSBarry Smith   PetscErrorCode ierr;
10372a42c3cSBarry Smith   int            myargc   = argc;
10472a42c3cSBarry Smith   char           **myargs = args;
10572a42c3cSBarry Smith 
10672a42c3cSBarry Smith   PetscFunctionBegin;
1073bf036e2SBarry Smith   ierr = PetscInitialize(&myargc,&myargs,filename,help);CHKERRQ(ierr);
1081ea5a559SBarry Smith   ierr = PetscPopSignalHandler();CHKERRQ(ierr);
109df413903SBarry Smith   PetscBeganMPI = PETSC_FALSE;
11072a42c3cSBarry Smith   PetscFunctionReturn(ierr);
11172a42c3cSBarry Smith }
11272a42c3cSBarry Smith 
11372a42c3cSBarry Smith #undef __FUNCT__
114945d1669SBarry Smith #define __FUNCT__ "PetscGetPETSC_COMM_SELF"
115f0865b08SBarry Smith /*
116945d1669SBarry Smith       Used by MATLAB and Julia interface to get communicator
117f0865b08SBarry Smith */
118945d1669SBarry Smith PetscErrorCode  PetscGetPETSC_COMM_SELF(MPI_Comm *comm)
119f0865b08SBarry Smith {
120f0865b08SBarry Smith   PetscFunctionBegin;
121f0865b08SBarry Smith   *comm = PETSC_COMM_SELF;
122f0865b08SBarry Smith   PetscFunctionReturn(0);
123f0865b08SBarry Smith }
124f0865b08SBarry Smith 
125f0865b08SBarry Smith #undef __FUNCT__
126e5c89e4eSSatish Balay #define __FUNCT__ "PetscInitializeNoArguments"
127e5c89e4eSSatish Balay /*@C
128e5c89e4eSSatish Balay       PetscInitializeNoArguments - Calls PetscInitialize() from C/C++ without
129e5c89e4eSSatish Balay         the command line arguments.
130e5c89e4eSSatish Balay 
131e5c89e4eSSatish Balay    Collective
132e5c89e4eSSatish Balay 
133e5c89e4eSSatish Balay    Level: advanced
134e5c89e4eSSatish Balay 
135e5c89e4eSSatish Balay .seealso: PetscInitialize(), PetscInitializeFortran()
136e5c89e4eSSatish Balay @*/
1377087cfbeSBarry Smith PetscErrorCode  PetscInitializeNoArguments(void)
138e5c89e4eSSatish Balay {
139e5c89e4eSSatish Balay   PetscErrorCode ierr;
140e5c89e4eSSatish Balay   int            argc   = 0;
141e5c89e4eSSatish Balay   char           **args = 0;
142e5c89e4eSSatish Balay 
143e5c89e4eSSatish Balay   PetscFunctionBegin;
1440298fd71SBarry Smith   ierr = PetscInitialize(&argc,&args,NULL,NULL);
145e5c89e4eSSatish Balay   PetscFunctionReturn(ierr);
146e5c89e4eSSatish Balay }
147e5c89e4eSSatish Balay 
148e5c89e4eSSatish Balay #undef __FUNCT__
149e5c89e4eSSatish Balay #define __FUNCT__ "PetscInitialized"
150e5c89e4eSSatish Balay /*@
151e5c89e4eSSatish Balay       PetscInitialized - Determine whether PETSc is initialized.
152e5c89e4eSSatish Balay 
15393b6d2d1SJed Brown    Level: beginner
154e5c89e4eSSatish Balay 
155e5c89e4eSSatish Balay .seealso: PetscInitialize(), PetscInitializeNoArguments(), PetscInitializeFortran()
156e5c89e4eSSatish Balay @*/
1577087cfbeSBarry Smith PetscErrorCode PetscInitialized(PetscBool  *isInitialized)
158e5c89e4eSSatish Balay {
159e5c89e4eSSatish Balay   *isInitialized = PetscInitializeCalled;
16093b6d2d1SJed Brown   return 0;
161e5c89e4eSSatish Balay }
162e5c89e4eSSatish Balay 
163e5c89e4eSSatish Balay #undef __FUNCT__
164e5c89e4eSSatish Balay #define __FUNCT__ "PetscFinalized"
165e5c89e4eSSatish Balay /*@
166e5c89e4eSSatish Balay       PetscFinalized - Determine whether PetscFinalize() has been called yet
167e5c89e4eSSatish Balay 
168e5c89e4eSSatish Balay    Level: developer
169e5c89e4eSSatish Balay 
170e5c89e4eSSatish Balay .seealso: PetscInitialize(), PetscInitializeNoArguments(), PetscInitializeFortran()
171e5c89e4eSSatish Balay @*/
1727087cfbeSBarry Smith PetscErrorCode  PetscFinalized(PetscBool  *isFinalized)
173e5c89e4eSSatish Balay {
174e5c89e4eSSatish Balay   *isFinalized = PetscFinalizeCalled;
17593b6d2d1SJed Brown   return 0;
176e5c89e4eSSatish Balay }
177e5c89e4eSSatish Balay 
17809573ac7SBarry Smith extern PetscErrorCode PetscOptionsCheckInitial_Private(void);
179e5c89e4eSSatish Balay 
180e5c89e4eSSatish Balay /*
181e5c89e4eSSatish Balay        This function is the MPI reduction operation used to compute the sum of the
182e5c89e4eSSatish Balay    first half of the datatype and the max of the second half.
183e5c89e4eSSatish Balay */
184e5c89e4eSSatish Balay MPI_Op PetscMaxSum_Op = 0;
185e5c89e4eSSatish Balay 
186e5c89e4eSSatish Balay #undef __FUNCT__
187e5c89e4eSSatish Balay #define __FUNCT__ "PetscMaxSum_Local"
1888cc058d9SJed Brown PETSC_EXTERN void MPIAPI PetscMaxSum_Local(void *in,void *out,int *cnt,MPI_Datatype *datatype)
189e5c89e4eSSatish Balay {
190e5c89e4eSSatish Balay   PetscInt *xin = (PetscInt*)in,*xout = (PetscInt*)out,i,count = *cnt;
191e5c89e4eSSatish Balay 
192e5c89e4eSSatish Balay   PetscFunctionBegin;
193e5c89e4eSSatish Balay   if (*datatype != MPIU_2INT) {
194e5c89e4eSSatish Balay     (*PetscErrorPrintf)("Can only handle MPIU_2INT data types");
195e5c89e4eSSatish Balay     MPI_Abort(MPI_COMM_WORLD,1);
196e5c89e4eSSatish Balay   }
197e5c89e4eSSatish Balay 
198e5c89e4eSSatish Balay   for (i=0; i<count; i++) {
199e5c89e4eSSatish Balay     xout[2*i]    = PetscMax(xout[2*i],xin[2*i]);
200e5c89e4eSSatish Balay     xout[2*i+1] += xin[2*i+1];
201e5c89e4eSSatish Balay   }
202812af9f3SBarry Smith   PetscFunctionReturnVoid();
203e5c89e4eSSatish Balay }
204e5c89e4eSSatish Balay 
205e5c89e4eSSatish Balay /*
206e5c89e4eSSatish Balay     Returns the max of the first entry owned by this processor and the
207e5c89e4eSSatish Balay sum of the second entry.
208b693b147SBarry Smith 
209b693b147SBarry Smith     The reason nprocs[2*i] contains lengths nprocs[2*i+1] contains flag of 1 if length is nonzero
210b693b147SBarry Smith is so that the PetscMaxSum_Op() can set TWO values, if we passed in only nprocs[i] with lengths
211b693b147SBarry Smith there would be no place to store the both needed results.
212e5c89e4eSSatish Balay */
213e5c89e4eSSatish Balay #undef __FUNCT__
214e5c89e4eSSatish Balay #define __FUNCT__ "PetscMaxSum"
2157087cfbeSBarry Smith PetscErrorCode  PetscMaxSum(MPI_Comm comm,const PetscInt nprocs[],PetscInt *max,PetscInt *sum)
216e5c89e4eSSatish Balay {
217e5c89e4eSSatish Balay   PetscMPIInt    size,rank;
2186ac3741eSJed Brown   struct {PetscInt max,sum;} *work;
219e5c89e4eSSatish Balay   PetscErrorCode ierr;
220e5c89e4eSSatish Balay 
221e5c89e4eSSatish Balay   PetscFunctionBegin;
222e5c89e4eSSatish Balay   ierr = MPI_Comm_size(comm,&size);CHKERRQ(ierr);
223e5c89e4eSSatish Balay   ierr = MPI_Comm_rank(comm,&rank);CHKERRQ(ierr);
2246ac3741eSJed Brown   ierr = PetscMalloc(size*sizeof(*work),&work);CHKERRQ(ierr);
225e5c89e4eSSatish Balay   ierr = MPI_Allreduce((void*)nprocs,work,size,MPIU_2INT,PetscMaxSum_Op,comm);CHKERRQ(ierr);
2266ac3741eSJed Brown   *max = work[rank].max;
2276ac3741eSJed Brown   *sum = work[rank].sum;
228e5c89e4eSSatish Balay   ierr = PetscFree(work);CHKERRQ(ierr);
229e5c89e4eSSatish Balay   PetscFunctionReturn(0);
230e5c89e4eSSatish Balay }
231e5c89e4eSSatish Balay 
232e5c89e4eSSatish Balay /* ----------------------------------------------------------------------------*/
2337087cfbeSBarry Smith MPI_Op  PetscADMax_Op = 0;
234e5c89e4eSSatish Balay 
235e5c89e4eSSatish Balay #undef __FUNCT__
236e5c89e4eSSatish Balay #define __FUNCT__ "PetscADMax_Local"
2378cc058d9SJed Brown PETSC_EXTERN void MPIAPI PetscADMax_Local(void *in,void *out,PetscMPIInt *cnt,MPI_Datatype *datatype)
238e5c89e4eSSatish Balay {
239e5c89e4eSSatish Balay   PetscScalar *xin = (PetscScalar*)in,*xout = (PetscScalar*)out;
240e5c89e4eSSatish Balay   PetscInt    i,count = *cnt;
241e5c89e4eSSatish Balay 
242e5c89e4eSSatish Balay   PetscFunctionBegin;
243e5c89e4eSSatish Balay   if (*datatype != MPIU_2SCALAR) {
244e5c89e4eSSatish Balay     (*PetscErrorPrintf)("Can only handle MPIU_2SCALAR data (i.e. double or complex) types");
245e5c89e4eSSatish Balay     MPI_Abort(MPI_COMM_WORLD,1);
246e5c89e4eSSatish Balay   }
247e5c89e4eSSatish Balay 
248e5c89e4eSSatish Balay   for (i=0; i<count; i++) {
249e5c89e4eSSatish Balay     if (PetscRealPart(xout[2*i]) < PetscRealPart(xin[2*i])) {
250e5c89e4eSSatish Balay       xout[2*i]   = xin[2*i];
251e5c89e4eSSatish Balay       xout[2*i+1] = xin[2*i+1];
252e5c89e4eSSatish Balay     }
253e5c89e4eSSatish Balay   }
254812af9f3SBarry Smith   PetscFunctionReturnVoid();
255e5c89e4eSSatish Balay }
256e5c89e4eSSatish Balay 
2577087cfbeSBarry Smith MPI_Op PetscADMin_Op = 0;
258e5c89e4eSSatish Balay 
259e5c89e4eSSatish Balay #undef __FUNCT__
260e5c89e4eSSatish Balay #define __FUNCT__ "PetscADMin_Local"
2618cc058d9SJed Brown PETSC_EXTERN void MPIAPI PetscADMin_Local(void *in,void *out,PetscMPIInt *cnt,MPI_Datatype *datatype)
262e5c89e4eSSatish Balay {
263e5c89e4eSSatish Balay   PetscScalar *xin = (PetscScalar*)in,*xout = (PetscScalar*)out;
264e5c89e4eSSatish Balay   PetscInt    i,count = *cnt;
265e5c89e4eSSatish Balay 
266e5c89e4eSSatish Balay   PetscFunctionBegin;
267e5c89e4eSSatish Balay   if (*datatype != MPIU_2SCALAR) {
268e5c89e4eSSatish Balay     (*PetscErrorPrintf)("Can only handle MPIU_2SCALAR data (i.e. double or complex) types");
269e5c89e4eSSatish Balay     MPI_Abort(MPI_COMM_WORLD,1);
270e5c89e4eSSatish Balay   }
271e5c89e4eSSatish Balay 
272e5c89e4eSSatish Balay   for (i=0; i<count; i++) {
273e5c89e4eSSatish Balay     if (PetscRealPart(xout[2*i]) > PetscRealPart(xin[2*i])) {
274e5c89e4eSSatish Balay       xout[2*i]   = xin[2*i];
275e5c89e4eSSatish Balay       xout[2*i+1] = xin[2*i+1];
276e5c89e4eSSatish Balay     }
277e5c89e4eSSatish Balay   }
278812af9f3SBarry Smith   PetscFunctionReturnVoid();
279e5c89e4eSSatish Balay }
280e5c89e4eSSatish Balay /* ---------------------------------------------------------------------------------------*/
281e5c89e4eSSatish Balay 
2827c2de775SJed Brown #if (defined(PETSC_HAVE_COMPLEX) && !defined(PETSC_HAVE_MPI_C_DOUBLE_COMPLEX)) || defined(PETSC_USE_REAL___FLOAT128)
28306a205a8SBarry Smith MPI_Op MPIU_SUM = 0;
284e5c89e4eSSatish Balay 
285e5c89e4eSSatish Balay #undef __FUNCT__
286e5c89e4eSSatish Balay #define __FUNCT__ "PetscSum_Local"
2878cc058d9SJed Brown PETSC_EXTERN void PetscSum_Local(void *in,void *out,PetscMPIInt *cnt,MPI_Datatype *datatype)
288e5c89e4eSSatish Balay {
289e5c89e4eSSatish Balay   PetscInt i,count = *cnt;
290e5c89e4eSSatish Balay 
291e5c89e4eSSatish Balay   PetscFunctionBegin;
2927c2de775SJed Brown   if (*datatype == MPIU_REAL) {
293e2e03761SBarry Smith     PetscReal *xin = (PetscReal*)in,*xout = (PetscReal*)out;
294a297a907SKarl Rupp     for (i=0; i<count; i++) xout[i] += xin[i];
2957c2de775SJed Brown   }
2967c2de775SJed Brown #if defined(PETSC_HAVE_COMPLEX)
2977c2de775SJed Brown   else if (*datatype == MPIU_COMPLEX) {
2987c2de775SJed Brown     PetscComplex *xin = (PetscComplex*)in,*xout = (PetscComplex*)out;
299a297a907SKarl Rupp     for (i=0; i<count; i++) xout[i] += xin[i];
3007c2de775SJed Brown   }
3017c2de775SJed Brown #endif
3027c2de775SJed Brown   else {
3037c2de775SJed Brown     (*PetscErrorPrintf)("Can only handle MPIU_REAL or MPIU_COMPLEX data types");
304e2e03761SBarry Smith     MPI_Abort(MPI_COMM_WORLD,1);
305e2e03761SBarry Smith   }
306812af9f3SBarry Smith   PetscFunctionReturnVoid();
307e5c89e4eSSatish Balay }
308e5c89e4eSSatish Balay #endif
309e5c89e4eSSatish Balay 
310ce63c4c1SBarry Smith #if defined(PETSC_USE_REAL___FLOAT128)
311d9822059SBarry Smith MPI_Op MPIU_MAX = 0;
312d9822059SBarry Smith MPI_Op MPIU_MIN = 0;
313d9822059SBarry Smith 
314d9822059SBarry Smith #undef __FUNCT__
315d9822059SBarry Smith #define __FUNCT__ "PetscMax_Local"
3168cc058d9SJed Brown PETSC_EXTERN void PetscMax_Local(void *in,void *out,PetscMPIInt *cnt,MPI_Datatype *datatype)
317d9822059SBarry Smith {
318d9822059SBarry Smith   PetscInt i,count = *cnt;
319d9822059SBarry Smith 
320d9822059SBarry Smith   PetscFunctionBegin;
3217c2de775SJed Brown   if (*datatype == MPIU_REAL) {
3228c764dc5SJose Roman     PetscReal *xin = (PetscReal*)in,*xout = (PetscReal*)out;
323a297a907SKarl Rupp     for (i=0; i<count; i++) xout[i] = PetscMax(xout[i],xin[i]);
3247c2de775SJed Brown   }
3257c2de775SJed Brown #if defined(PETSC_HAVE_COMPLEX)
3267c2de775SJed Brown   else if (*datatype == MPIU_COMPLEX) {
3277c2de775SJed Brown     PetscComplex *xin = (PetscComplex*)in,*xout = (PetscComplex*)out;
3287c2de775SJed Brown     for (i=0; i<count; i++) {
3297c2de775SJed Brown       xout[i] = PetscRealPartComplex(xout[i])<PetscRealPartComplex(xin[i]) ? xin[i] : xout[i];
3307c2de775SJed Brown     }
3317c2de775SJed Brown   }
3327c2de775SJed Brown #endif
3337c2de775SJed Brown   else {
3347c2de775SJed Brown     (*PetscErrorPrintf)("Can only handle MPIU_REAL or MPIU_COMPLEX data types");
3358c764dc5SJose Roman     MPI_Abort(MPI_COMM_WORLD,1);
3368c764dc5SJose Roman   }
337d9822059SBarry Smith   PetscFunctionReturnVoid();
338d9822059SBarry Smith }
339d9822059SBarry Smith 
340d9822059SBarry Smith #undef __FUNCT__
341d9822059SBarry Smith #define __FUNCT__ "PetscMin_Local"
3428cc058d9SJed Brown PETSC_EXTERN void PetscMin_Local(void *in,void *out,PetscMPIInt *cnt,MPI_Datatype *datatype)
343d9822059SBarry Smith {
344d9822059SBarry Smith   PetscInt    i,count = *cnt;
345d9822059SBarry Smith 
346d9822059SBarry Smith   PetscFunctionBegin;
3477c2de775SJed Brown   if (*datatype == MPIU_REAL) {
3488c764dc5SJose Roman     PetscReal *xin = (PetscReal*)in,*xout = (PetscReal*)out;
349a297a907SKarl Rupp     for (i=0; i<count; i++) xout[i] = PetscMin(xout[i],xin[i]);
3507c2de775SJed Brown   }
3517c2de775SJed Brown #if defined(PETSC_HAVE_COMPLEX)
3527c2de775SJed Brown   else if (*datatype == MPIU_COMPLEX) {
3537c2de775SJed Brown     PetscComplex *xin = (PetscComplex*)in,*xout = (PetscComplex*)out;
3547c2de775SJed Brown     for (i=0; i<count; i++) {
3557c2de775SJed Brown       xout[i] = PetscRealPartComplex(xout[i])>PetscRealPartComplex(xin[i]) ? xin[i] : xout[i];
3567c2de775SJed Brown     }
3577c2de775SJed Brown   }
3587c2de775SJed Brown #endif
3597c2de775SJed Brown   else {
3608c764dc5SJose Roman     (*PetscErrorPrintf)("Can only handle MPIU_REAL or MPIU_SCALAR data (i.e. double or complex) types");
3618c764dc5SJose Roman     MPI_Abort(MPI_COMM_WORLD,1);
3628c764dc5SJose Roman   }
363d9822059SBarry Smith   PetscFunctionReturnVoid();
364d9822059SBarry Smith }
365d9822059SBarry Smith #endif
366d9822059SBarry Smith 
367480cf27aSJed Brown #undef __FUNCT__
368480cf27aSJed Brown #define __FUNCT__ "Petsc_DelCounter"
369480cf27aSJed Brown /*
370480cf27aSJed Brown    Private routine to delete internal tag/name counter storage when a communicator is freed.
371480cf27aSJed Brown 
372ff0e51ddSBarry Smith    This is called by MPI, not by users. This is called by MPI_Comm_free() when the communicator that has this  data as an attribute is freed.
373480cf27aSJed Brown 
374480cf27aSJed Brown    Note: this is declared extern "C" because it is passed to MPI_Keyval_create()
375480cf27aSJed Brown 
376480cf27aSJed Brown */
3778cc058d9SJed Brown PETSC_EXTERN PetscMPIInt MPIAPI Petsc_DelCounter(MPI_Comm comm,PetscMPIInt keyval,void *count_val,void *extra_state)
378480cf27aSJed Brown {
379480cf27aSJed Brown   PetscErrorCode ierr;
380480cf27aSJed Brown 
381480cf27aSJed Brown   PetscFunctionBegin;
382480cf27aSJed Brown   ierr = PetscInfo1(0,"Deleting counter data in an MPI_Comm %ld\n",(long)comm);if (ierr) PetscFunctionReturn((PetscMPIInt)ierr);
383480cf27aSJed Brown   ierr = PetscFree(count_val);if (ierr) PetscFunctionReturn((PetscMPIInt)ierr);
384480cf27aSJed Brown   PetscFunctionReturn(MPI_SUCCESS);
385480cf27aSJed Brown }
386480cf27aSJed Brown 
387480cf27aSJed Brown #undef __FUNCT__
388da3039f7SJed Brown #define __FUNCT__ "Petsc_DelComm_Outer"
389480cf27aSJed Brown /*
390da3039f7SJed Brown   This is invoked on the outer comm as a result of either PetscCommDestroy() (via MPI_Attr_delete) or when the user
391da3039f7SJed Brown   calls MPI_Comm_free().
392da3039f7SJed Brown 
393da3039f7SJed Brown   This is the only entry point for breaking the links between inner and outer comms.
394480cf27aSJed Brown 
395ff0e51ddSBarry Smith   This is called by MPI, not by users. This is called when MPI_Comm_free() is called on the communicator.
396480cf27aSJed Brown 
397480cf27aSJed Brown   Note: this is declared extern "C" because it is passed to MPI_Keyval_create()
398480cf27aSJed Brown 
399480cf27aSJed Brown */
400da3039f7SJed Brown PETSC_EXTERN PetscMPIInt MPIAPI Petsc_DelComm_Outer(MPI_Comm comm,PetscMPIInt keyval,void *attr_val,void *extra_state)
401480cf27aSJed Brown {
402480cf27aSJed Brown   PetscErrorCode ierr;
403b89831e5SBarry Smith   PetscMPIInt    flg;
404265f3f35SJed Brown   union {MPI_Comm comm; void *ptr;} icomm,ocomm;
405480cf27aSJed Brown 
406480cf27aSJed Brown   PetscFunctionBegin;
407da3039f7SJed Brown   if (keyval != Petsc_InnerComm_keyval) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_CORRUPT,"Unexpected keyval");
408ec4fadc2SJed Brown   icomm.ptr = attr_val;
409da3039f7SJed Brown 
410265f3f35SJed Brown   ierr = MPI_Attr_get(icomm.comm,Petsc_OuterComm_keyval,&ocomm,&flg);CHKERRQ(ierr);
411b3ef52cdSBarry Smith   if (!flg) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_CORRUPT,"Inner MPI_Comm does not have expected reference to outer comm");
412da3039f7SJed Brown   if (ocomm.comm != comm) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_CORRUPT,"Inner MPI_Comm has reference to non-matching outer comm");
413da3039f7SJed Brown   ierr = MPI_Attr_delete(icomm.comm,Petsc_OuterComm_keyval);CHKERRQ(ierr); /* Calls Petsc_DelComm_Inner */
414da3039f7SJed Brown   ierr = PetscInfo1(0,"User MPI_Comm %ld is being freed after removing reference from inner PETSc comm to this outer comm\n",(long)comm);if (ierr) PetscFunctionReturn((PetscMPIInt)ierr);
415da3039f7SJed Brown   PetscFunctionReturn(MPI_SUCCESS);
416b89831e5SBarry Smith }
417da3039f7SJed Brown 
418da3039f7SJed Brown #undef __FUNCT__
419da3039f7SJed Brown #define __FUNCT__ "Petsc_DelComm_Inner"
420da3039f7SJed Brown /*
421da3039f7SJed Brown  * This is invoked on the inner comm when Petsc_DelComm_Outer calls MPI_Attr_delete.  It should not be reached any other way.
422da3039f7SJed Brown  */
423da3039f7SJed Brown PETSC_EXTERN PetscMPIInt MPIAPI Petsc_DelComm_Inner(MPI_Comm comm,PetscMPIInt keyval,void *attr_val,void *extra_state)
424da3039f7SJed Brown {
425da3039f7SJed Brown   PetscErrorCode ierr;
426da3039f7SJed Brown 
427da3039f7SJed Brown   PetscFunctionBegin;
428da3039f7SJed Brown   ierr = PetscInfo1(0,"Removing reference to PETSc communicator embedded in a user MPI_Comm %ld\n",(long)comm);if (ierr) PetscFunctionReturn((PetscMPIInt)ierr);
429480cf27aSJed Brown   PetscFunctionReturn(MPI_SUCCESS);
430480cf27aSJed Brown }
431480cf27aSJed Brown 
432951e3c8eSBarry Smith #if defined(PETSC_USE_PETSC_MPI_EXTERNAL32)
433e39fd77fSBarry Smith #if !defined(PETSC_WORDS_BIGENDIAN)
4348cc058d9SJed Brown PETSC_EXTERN PetscMPIInt PetscDataRep_extent_fn(MPI_Datatype,MPI_Aint*,void*);
4358cc058d9SJed Brown PETSC_EXTERN PetscMPIInt PetscDataRep_read_conv_fn(void*, MPI_Datatype,PetscMPIInt,void*,MPI_Offset,void*);
4368cc058d9SJed Brown PETSC_EXTERN PetscMPIInt PetscDataRep_write_conv_fn(void*, MPI_Datatype,PetscMPIInt,void*,MPI_Offset,void*);
437e39fd77fSBarry Smith #endif
438951e3c8eSBarry Smith #endif
439e39fd77fSBarry Smith 
4406ae9a8a6SBarry Smith int  PetscGlobalArgc   = 0;
4416ae9a8a6SBarry Smith char **PetscGlobalArgs = 0;
442dff31646SBarry Smith PetscSegBuffer PetscCitationsList;
443e5c89e4eSSatish Balay 
444e5c89e4eSSatish Balay #undef __FUNCT__
445051e4cf2SJed Brown #define __FUNCT__ "PetscCitationsInitialize"
446051e4cf2SJed Brown PetscErrorCode PetscCitationsInitialize()
447051e4cf2SJed Brown {
448051e4cf2SJed Brown   PetscErrorCode ierr;
449051e4cf2SJed Brown 
450051e4cf2SJed Brown   PetscFunctionBegin;
451051e4cf2SJed Brown   ierr = PetscSegBufferCreate(1,10000,&PetscCitationsList);CHKERRQ(ierr);
452051e4cf2SJed Brown   ierr = PetscCitationsRegister("@TechReport{petsc-user-ref,\n  Author = {Satish Balay and Jed Brown and and Kris Buschelman and Victor Eijkhout\n            and William D.  Gropp and Dinesh Kaushik and Matthew G. Knepley\n            and Lois Curfman McInnes and Barry F. Smith and Hong Zhang},\n  Title = {{PETS}c Users Manual},\n  Number = {ANL-95/11 - Revision 3.4},\n  Institution = {Argonne National Laboratory},\n  Year = {2013}\n}\n",NULL);CHKERRQ(ierr);
453051e4cf2SJed Brown   ierr = PetscCitationsRegister("@InProceedings{petsc-efficient,\n  Author = {Satish Balay and William D. Gropp and Lois Curfman McInnes and Barry F. Smith},\n  Title = {Efficient Management of Parallelism in Object Oriented Numerical Software Libraries},\n  Booktitle = {Modern Software Tools in Scientific Computing},\n  Editor = {E. Arge and A. M. Bruaset and H. P. Langtangen},\n  Pages = {163--202},\n  Publisher = {Birkh{\\\"{a}}user Press},\n  Year = {1997}\n}\n",NULL);CHKERRQ(ierr);
454051e4cf2SJed Brown   PetscFunctionReturn(0);
455051e4cf2SJed Brown }
456e5c89e4eSSatish Balay 
457e5c89e4eSSatish Balay #undef __FUNCT__
458e5c89e4eSSatish Balay #define __FUNCT__ "PetscGetArgs"
459e5c89e4eSSatish Balay /*@C
460e5c89e4eSSatish Balay    PetscGetArgs - Allows you to access the raw command line arguments anywhere
461e5c89e4eSSatish Balay      after PetscInitialize() is called but before PetscFinalize().
462e5c89e4eSSatish Balay 
463e5c89e4eSSatish Balay    Not Collective
464e5c89e4eSSatish Balay 
465e5c89e4eSSatish Balay    Output Parameters:
466e5c89e4eSSatish Balay +  argc - count of number of command line arguments
467e5c89e4eSSatish Balay -  args - the command line arguments
468e5c89e4eSSatish Balay 
469e5c89e4eSSatish Balay    Level: intermediate
470e5c89e4eSSatish Balay 
471e5c89e4eSSatish Balay    Notes:
472e5c89e4eSSatish Balay       This is usually used to pass the command line arguments into other libraries
473e5c89e4eSSatish Balay    that are called internally deep in PETSc or the application.
474e5c89e4eSSatish Balay 
475f177e3b1SBarry Smith       The first argument contains the program name as is normal for C arguments.
476f177e3b1SBarry Smith 
477e5c89e4eSSatish Balay    Concepts: command line arguments
478e5c89e4eSSatish Balay 
479793721a6SBarry Smith .seealso: PetscFinalize(), PetscInitializeFortran(), PetscGetArguments()
480e5c89e4eSSatish Balay 
481e5c89e4eSSatish Balay @*/
4827087cfbeSBarry Smith PetscErrorCode  PetscGetArgs(int *argc,char ***args)
483e5c89e4eSSatish Balay {
484e5c89e4eSSatish Balay   PetscFunctionBegin;
48517186662SBarry Smith   if (!PetscInitializeCalled && PetscFinalizeCalled) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ORDER,"You must call after PetscInitialize() but before PetscFinalize()");
486e5c89e4eSSatish Balay   *argc = PetscGlobalArgc;
487e5c89e4eSSatish Balay   *args = PetscGlobalArgs;
488e5c89e4eSSatish Balay   PetscFunctionReturn(0);
489e5c89e4eSSatish Balay }
490e5c89e4eSSatish Balay 
491e5c89e4eSSatish Balay #undef __FUNCT__
492793721a6SBarry Smith #define __FUNCT__ "PetscGetArguments"
493793721a6SBarry Smith /*@C
494793721a6SBarry Smith    PetscGetArguments - Allows you to access the  command line arguments anywhere
495793721a6SBarry Smith      after PetscInitialize() is called but before PetscFinalize().
496793721a6SBarry Smith 
497793721a6SBarry Smith    Not Collective
498793721a6SBarry Smith 
499793721a6SBarry Smith    Output Parameters:
500793721a6SBarry Smith .  args - the command line arguments
501793721a6SBarry Smith 
502793721a6SBarry Smith    Level: intermediate
503793721a6SBarry Smith 
504793721a6SBarry Smith    Notes:
505793721a6SBarry Smith       This does NOT start with the program name and IS null terminated (final arg is void)
506793721a6SBarry Smith 
507793721a6SBarry Smith    Concepts: command line arguments
508793721a6SBarry Smith 
509793721a6SBarry Smith .seealso: PetscFinalize(), PetscInitializeFortran(), PetscGetArgs(), PetscFreeArguments()
510793721a6SBarry Smith 
511793721a6SBarry Smith @*/
5127087cfbeSBarry Smith PetscErrorCode  PetscGetArguments(char ***args)
513793721a6SBarry Smith {
514793721a6SBarry Smith   PetscInt       i,argc = PetscGlobalArgc;
515793721a6SBarry Smith   PetscErrorCode ierr;
516793721a6SBarry Smith 
517793721a6SBarry Smith   PetscFunctionBegin;
51817186662SBarry Smith   if (!PetscInitializeCalled && PetscFinalizeCalled) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ORDER,"You must call after PetscInitialize() but before PetscFinalize()");
519717030eeSLisandro Dalcin   if (!argc) {*args = 0; PetscFunctionReturn(0);}
520793721a6SBarry Smith   ierr = PetscMalloc(argc*sizeof(char*),args);CHKERRQ(ierr);
521793721a6SBarry Smith   for (i=0; i<argc-1; i++) {
522793721a6SBarry Smith     ierr = PetscStrallocpy(PetscGlobalArgs[i+1],&(*args)[i]);CHKERRQ(ierr);
523793721a6SBarry Smith   }
524793721a6SBarry Smith   (*args)[argc-1] = 0;
525793721a6SBarry Smith   PetscFunctionReturn(0);
526793721a6SBarry Smith }
527793721a6SBarry Smith 
528793721a6SBarry Smith #undef __FUNCT__
529793721a6SBarry Smith #define __FUNCT__ "PetscFreeArguments"
530793721a6SBarry Smith /*@C
531793721a6SBarry Smith    PetscFreeArguments - Frees the memory obtained with PetscGetArguments()
532793721a6SBarry Smith 
533793721a6SBarry Smith    Not Collective
534793721a6SBarry Smith 
535793721a6SBarry Smith    Output Parameters:
536793721a6SBarry Smith .  args - the command line arguments
537793721a6SBarry Smith 
538793721a6SBarry Smith    Level: intermediate
539793721a6SBarry Smith 
540793721a6SBarry Smith    Concepts: command line arguments
541793721a6SBarry Smith 
542793721a6SBarry Smith .seealso: PetscFinalize(), PetscInitializeFortran(), PetscGetArgs(), PetscGetArguments()
543793721a6SBarry Smith 
544793721a6SBarry Smith @*/
5457087cfbeSBarry Smith PetscErrorCode  PetscFreeArguments(char **args)
546793721a6SBarry Smith {
547793721a6SBarry Smith   PetscInt       i = 0;
548793721a6SBarry Smith   PetscErrorCode ierr;
549793721a6SBarry Smith 
550793721a6SBarry Smith   PetscFunctionBegin;
551a297a907SKarl Rupp   if (!args) PetscFunctionReturn(0);
552793721a6SBarry Smith   while (args[i]) {
553793721a6SBarry Smith     ierr = PetscFree(args[i]);CHKERRQ(ierr);
554793721a6SBarry Smith     i++;
555793721a6SBarry Smith   }
556793721a6SBarry Smith   ierr = PetscFree(args);CHKERRQ(ierr);
557793721a6SBarry Smith   PetscFunctionReturn(0);
558793721a6SBarry Smith }
559793721a6SBarry Smith 
56011525c0dSBarry Smith #if defined(PETSC_HAVE_SAWS)
56111525c0dSBarry Smith #undef __FUNCT__
56211525c0dSBarry Smith #define __FUNCT__ "PetscInitializeSAWs"
56311525c0dSBarry Smith PetscErrorCode  PetscInitializeSAWs(const char help[])
56411525c0dSBarry Smith {
56511525c0dSBarry Smith   if (!PetscGlobalRank) {
56611525c0dSBarry Smith     char           cert[PETSC_MAX_PATH_LEN],root[PETSC_MAX_PATH_LEN],*intro,programname[64],*appline;
56711525c0dSBarry Smith     int            port;
56811525c0dSBarry Smith     PetscBool      flg,rootlocal = PETSC_FALSE,flg2;
56911525c0dSBarry Smith     size_t         applinelen,introlen;
57011525c0dSBarry Smith     PetscErrorCode ierr;
57111525c0dSBarry Smith 
57211525c0dSBarry Smith     ierr = PetscOptionsHasName(NULL,"-saws_log",&flg);CHKERRQ(ierr);
57311525c0dSBarry Smith     if (flg) {
57411525c0dSBarry Smith       char  sawslog[PETSC_MAX_PATH_LEN];
57511525c0dSBarry Smith 
57611525c0dSBarry Smith       ierr = PetscOptionsGetString(NULL,"-saws_log",sawslog,PETSC_MAX_PATH_LEN,NULL);CHKERRQ(ierr);
57711525c0dSBarry Smith       if (sawslog[0]) {
57811525c0dSBarry Smith         PetscStackCallSAWs(SAWs_Set_Use_Logfile,(sawslog));
57911525c0dSBarry Smith       } else {
58011525c0dSBarry Smith         PetscStackCallSAWs(SAWs_Set_Use_Logfile,(NULL));
58111525c0dSBarry Smith       }
58211525c0dSBarry Smith     }
58311525c0dSBarry Smith     ierr = PetscOptionsGetString(NULL,"-saws_https",cert,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr);
58411525c0dSBarry Smith     if (flg) {
58511525c0dSBarry Smith       PetscStackCallSAWs(SAWs_Set_Use_HTTPS,(cert));
58611525c0dSBarry Smith     }
58711525c0dSBarry Smith     ierr = PetscOptionsGetInt(NULL,"-saws_port",&port,&flg);CHKERRQ(ierr);
58811525c0dSBarry Smith     if (flg) {
58911525c0dSBarry Smith       PetscStackCallSAWs(SAWs_Set_Port,(port));
59011525c0dSBarry Smith     }
59111525c0dSBarry Smith     ierr = PetscOptionsGetString(NULL,"-saws_root",root,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr);
59211525c0dSBarry Smith     if (flg) {
59311525c0dSBarry Smith       PetscStackCallSAWs(SAWs_Set_Document_Root,(root));CHKERRQ(ierr);
59411525c0dSBarry Smith       ierr = PetscStrcmp(root,".",&rootlocal);CHKERRQ(ierr);
59511525c0dSBarry Smith     }
59611525c0dSBarry Smith     ierr = PetscOptionsHasName(NULL,"-saws_local",&flg2);CHKERRQ(ierr);
59711525c0dSBarry Smith     if (flg2) {
59811525c0dSBarry Smith       char jsdir[PETSC_MAX_PATH_LEN];
59911525c0dSBarry Smith       if (!flg) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SUP,"-saws_local option requires -saws_root option");
60011525c0dSBarry Smith       ierr = PetscSNPrintf(jsdir,PETSC_MAX_PATH_LEN,"%s/js",root);CHKERRQ(ierr);
60111525c0dSBarry Smith       ierr = PetscTestDirectory(jsdir,'r',&flg);CHKERRQ(ierr);
60211525c0dSBarry Smith       if (!flg) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_FILE_READ,"-saws_local option requires js directory in root directory");
60311525c0dSBarry Smith       PetscStackCallSAWs(SAWs_Set_Local_JSHeader,());CHKERRQ(ierr);
60411525c0dSBarry Smith     }
60511525c0dSBarry Smith     ierr = PetscGetProgramName(programname,64);CHKERRQ(ierr);
60611525c0dSBarry Smith     ierr = PetscStrlen(help,&applinelen);CHKERRQ(ierr);
60711525c0dSBarry Smith     introlen   = 4096 + applinelen;
60811525c0dSBarry Smith     applinelen += 256;
60911525c0dSBarry Smith     ierr = PetscMalloc(applinelen,&appline);CHKERRQ(ierr);
61011525c0dSBarry Smith     ierr = PetscMalloc(introlen,&intro);CHKERRQ(ierr);
61111525c0dSBarry Smith 
61211525c0dSBarry Smith     if (rootlocal) {
61311525c0dSBarry Smith       ierr = PetscSNPrintf(appline,applinelen,"%s.c.html",programname);CHKERRQ(ierr);
61411525c0dSBarry Smith       ierr = PetscTestFile(appline,'r',&rootlocal);CHKERRQ(ierr);
61511525c0dSBarry Smith     }
61611525c0dSBarry Smith     if (rootlocal && help) {
61711525c0dSBarry Smith       ierr = PetscSNPrintf(appline,applinelen,"<center> Running <a href=\"%s.c.html\">%s</a></center><br><pre>%s</pre><br>\n",programname,programname,help);
61811525c0dSBarry Smith     } else if (help) {
61911525c0dSBarry Smith       ierr = PetscSNPrintf(appline,applinelen,"<center>Running %s </center><br><pre>%s</pre><br>\n",programname,help);
62011525c0dSBarry Smith     } else {
62111525c0dSBarry Smith       ierr = PetscSNPrintf(appline,applinelen,"<center> Running %s</center><br>\n",programname);
62211525c0dSBarry Smith     }
62311525c0dSBarry Smith 
62411525c0dSBarry Smith     ierr = PetscSNPrintf(intro,introlen,"<body>\n"
62511525c0dSBarry Smith                                     "<center><h2> <a href=\"http://www.mcs.anl.gov/petsc\">PETSc</a> Application Web server powered by <a href=\"https://bitbucket.org/saws/saws\">SAWs</a> </h2></center>\n"
62611525c0dSBarry Smith                                     "<center>This is the default PETSc application dashboard, from it you can access any published PETSc objects or logging data</center><br>\n"
62711525c0dSBarry Smith                                     "%s",appline);
62811525c0dSBarry Smith     PetscStackCallSAWs(SAWs_Set_Body,("index.html",0,intro));
62911525c0dSBarry Smith     ierr = PetscFree(intro);CHKERRQ(ierr);
63011525c0dSBarry Smith     ierr = PetscFree(appline);CHKERRQ(ierr);
63111525c0dSBarry Smith     PetscStackCallSAWs(SAWs_Initialize,());
63211525c0dSBarry Smith     ierr = PetscCitationsRegister("@TechReport{ saws,"
63311525c0dSBarry Smith                                   "Author = {Matt Otten and Jed Brown and Barry Smith},"
63411525c0dSBarry Smith                                   "Title  = {Scientific Application Web Server (SAWs) Users Manual},"
63511525c0dSBarry Smith                                   "Institution = {Argonne National Laboratory},"
63611525c0dSBarry Smith                                   "Year   = 2013}",NULL);CHKERRQ(ierr);
63711525c0dSBarry Smith   }
63811525c0dSBarry Smith   PetscFunctionReturn(0);
63911525c0dSBarry Smith }
64011525c0dSBarry Smith #endif
64111525c0dSBarry Smith 
642793721a6SBarry Smith #undef __FUNCT__
643e5c89e4eSSatish Balay #define __FUNCT__ "PetscInitialize"
644e5c89e4eSSatish Balay /*@C
645e5c89e4eSSatish Balay    PetscInitialize - Initializes the PETSc database and MPI.
646e5c89e4eSSatish Balay    PetscInitialize() calls MPI_Init() if that has yet to be called,
647e5c89e4eSSatish Balay    so this routine should always be called near the beginning of
648e5c89e4eSSatish Balay    your program -- usually the very first line!
649e5c89e4eSSatish Balay 
650e5c89e4eSSatish Balay    Collective on MPI_COMM_WORLD or PETSC_COMM_WORLD if it has been set
651e5c89e4eSSatish Balay 
652e5c89e4eSSatish Balay    Input Parameters:
653e5c89e4eSSatish Balay +  argc - count of number of command line arguments
654e5c89e4eSSatish Balay .  args - the command line arguments
6550298fd71SBarry Smith .  file - [optional] PETSc database file, also checks ~username/.petscrc and .petscrc use NULL to not check for
656fc2bca9aSBarry Smith           code specific file. Use -skip_petscrc in the code specific file to skip the .petscrc files
6570298fd71SBarry Smith -  help - [optional] Help message to print, use NULL for no message
658e5c89e4eSSatish Balay 
65905827820SBarry Smith    If you wish PETSc code to run ONLY on a subcommunicator of MPI_COMM_WORLD, create that
66005827820SBarry Smith    communicator first and assign it to PETSC_COMM_WORLD BEFORE calling PetscInitialize(). Thus if you are running a
66105827820SBarry Smith    four process job and two processes will run PETSc and have PetscInitialize() and PetscFinalize() and two process will not,
66205827820SBarry Smith    then do this. If ALL processes in the job are using PetscInitialize() and PetscFinalize() then you don't need to do this, even
66305827820SBarry Smith    if different subcommunicators of the job are doing different things with PETSc.
664e5c89e4eSSatish Balay 
665e5c89e4eSSatish Balay    Options Database Keys:
666e5c89e4eSSatish Balay +  -start_in_debugger [noxterm,dbx,xdb,gdb,...] - Starts program in debugger
667e5c89e4eSSatish Balay .  -on_error_attach_debugger [noxterm,dbx,xdb,gdb,...] - Starts debugger when error detected
668e5c89e4eSSatish Balay .  -on_error_emacs <machinename> causes emacsclient to jump to error file
669b52f573bSBarry Smith .  -on_error_abort calls abort() when error detected (no traceback)
670e8fb0fc0SBarry Smith .  -on_error_mpiabort calls MPI_abort() when error detected
671e8fb0fc0SBarry Smith .  -error_output_stderr prints error messages to stderr instead of the default stdout
672e8fb0fc0SBarry Smith .  -error_output_none does not print the error messages (but handles errors in the same way as if this was not called)
673e5c89e4eSSatish Balay .  -debugger_nodes [node1,node2,...] - Indicates nodes to start in debugger
674e5c89e4eSSatish Balay .  -debugger_pause [sleeptime] (in seconds) - Pauses debugger
675e5c89e4eSSatish Balay .  -stop_for_debugger - Print message on how to attach debugger manually to
676e5c89e4eSSatish Balay                         process and wait (-debugger_pause) seconds for attachment
6772fb0ec9aSBarry Smith .  -malloc - Indicates use of PETSc error-checking malloc (on by default for debug version of libraries)
678e5c89e4eSSatish Balay .  -malloc no - Indicates not to use error-checking malloc
6792fb0ec9aSBarry Smith .  -malloc_debug - check for memory corruption at EVERY malloc or free
680aee23540SBarry Smith .  -malloc_dump - prints a list of all unfreed memory at the end of the run
681dc92acbaSJed Brown .  -malloc_test - like -malloc_dump -malloc_debug, but only active for debugging builds
682e5c89e4eSSatish Balay .  -fp_trap - Stops on floating point exceptions (Note that on the
683e5c89e4eSSatish Balay               IBM RS6000 this slows code by at least a factor of 10.)
684e5c89e4eSSatish Balay .  -no_signal_handler - Indicates not to trap error signals
685e5c89e4eSSatish Balay .  -shared_tmp - indicates /tmp directory is shared by all processors
686e5c89e4eSSatish Balay .  -not_shared_tmp - each processor has own /tmp
687e5c89e4eSSatish Balay .  -tmp - alternative name of /tmp directory
688e5c89e4eSSatish Balay .  -get_total_flops - returns total flops done by all processors
689*142c234bSBarry Smith -  -memory_info - Print memory usage at end of run
690e5c89e4eSSatish Balay 
691e5c89e4eSSatish Balay    Options Database Keys for Profiling:
6920598bfebSBarry Smith    See the <a href="../../docs/manual.pdf#nameddest=ch_profiling">profiling chapter of the users manual</a> for details.
693495fc317SBarry Smith +  -info <optional filename> - Prints verbose information to the screen
694495fc317SBarry Smith .  -info_exclude <null,vec,mat,pc,ksp,snes,ts> - Excludes some of the verbose messages
695495fc317SBarry Smith .  -log_sync - Log the synchronization in scatters, inner products and norms
696495fc317SBarry Smith .  -log_trace [filename] - Print traces of all PETSc calls to the screen (useful to determine where a program
697e5c89e4eSSatish Balay         hangs without running in the debugger).  See PetscLogTraceBegin().
698495fc317SBarry Smith .  -log_summary [filename] - Prints summary of flop and timing information to screen. If the filename is specified the
699495fc317SBarry Smith         summary is written to the file.  See PetscLogView().
700495fc317SBarry Smith .  -log_summary_python [filename] - Prints data on of flop and timing usage to a file or screen. See PetscLogPrintSViewPython().
701495fc317SBarry Smith .  -log_all [filename] - Logs extensive profiling information  See PetscLogDump().
702495fc317SBarry Smith .  -log [filename] - Logs basic profiline information  See PetscLogDump().
703495fc317SBarry Smith -  -log_mpe [filename] - Creates a logfile viewable by the utility Jumpshot (in MPICH distribution)
704495fc317SBarry Smith 
705495fc317SBarry Smith     Only one of -log_trace, -log_summary, -log_all, -log, or -log_mpe may be used at a time
706e5c89e4eSSatish Balay 
707e5c89e4eSSatish Balay    Environmental Variables:
708e5c89e4eSSatish Balay +   PETSC_TMP - alternative tmp directory
709e5c89e4eSSatish Balay .   PETSC_SHARED_TMP - tmp is shared by all processes
710e5c89e4eSSatish Balay .   PETSC_NOT_SHARED_TMP - each process has its own private tmp
711e5c89e4eSSatish Balay .   PETSC_VIEWER_SOCKET_PORT - socket number to use for socket viewer
712e5c89e4eSSatish Balay -   PETSC_VIEWER_SOCKET_MACHINE - machine to use for socket viewer to connect to
713e5c89e4eSSatish Balay 
714e5c89e4eSSatish Balay 
715e5c89e4eSSatish Balay    Level: beginner
716e5c89e4eSSatish Balay 
717e5c89e4eSSatish Balay    Notes:
718e5c89e4eSSatish Balay    If for some reason you must call MPI_Init() separately, call
719e5c89e4eSSatish Balay    it before PetscInitialize().
720e5c89e4eSSatish Balay 
721e5c89e4eSSatish Balay    Fortran Version:
722e5c89e4eSSatish Balay    In Fortran this routine has the format
723e5c89e4eSSatish Balay $       call PetscInitialize(file,ierr)
724e5c89e4eSSatish Balay 
725e5c89e4eSSatish Balay +   ierr - error return code
7260298fd71SBarry Smith -  file - [optional] PETSc database file, also checks ~username/.petscrc and .petscrc use NULL_CHARACTER to not check for
727fc2bca9aSBarry Smith           code specific file. Use -skip_petscrc in the code specific file to skip the .petscrc files
728e5c89e4eSSatish Balay 
729e5c89e4eSSatish Balay    Important Fortran Note:
7300298fd71SBarry Smith    In Fortran, you MUST use NULL_CHARACTER to indicate a
7310298fd71SBarry Smith    null character string; you CANNOT just use NULL as
7320598bfebSBarry Smith    in the C version. See the <a href="../../docs/manual.pdf">users manual</a> for details.
733e5c89e4eSSatish Balay 
73401cb0274SBarry Smith    If your main program is C but you call Fortran code that also uses PETSc you need to call PetscInitializeFortran() soon after
73501cb0274SBarry Smith    calling PetscInitialize().
736e5c89e4eSSatish Balay 
737e5c89e4eSSatish Balay    Concepts: initializing PETSc
738e5c89e4eSSatish Balay 
73901cb0274SBarry Smith .seealso: PetscFinalize(), PetscInitializeFortran(), PetscGetArgs(), PetscInitializeNoArguments()
740e5c89e4eSSatish Balay 
741e5c89e4eSSatish Balay @*/
7427087cfbeSBarry Smith PetscErrorCode  PetscInitialize(int *argc,char ***args,const char file[],const char help[])
743e5c89e4eSSatish Balay {
744e5c89e4eSSatish Balay   PetscErrorCode ierr;
7454bb5149bSJed Brown   PetscMPIInt    flag, size;
746aa5bb8c0SSatish Balay   PetscInt       nodesize;
747ace3abfcSBarry Smith   PetscBool      flg;
748e5c89e4eSSatish Balay   char           hostname[256];
749e5c89e4eSSatish Balay 
750e5c89e4eSSatish Balay   PetscFunctionBegin;
751e5c89e4eSSatish Balay   if (PetscInitializeCalled) PetscFunctionReturn(0);
752e5c89e4eSSatish Balay 
753ae9b4142SLisandro Dalcin   /* these must be initialized in a routine, not as a constant declaration*/
754d89683f4Sbcordonn   PETSC_STDOUT = stdout;
755ae9b4142SLisandro Dalcin   PETSC_STDERR = stderr;
756e5c89e4eSSatish Balay 
757e5c89e4eSSatish Balay   ierr = PetscOptionsCreate();CHKERRQ(ierr);
758e5c89e4eSSatish Balay 
759e5c89e4eSSatish Balay   /*
760e5c89e4eSSatish Balay      We initialize the program name here (before MPI_Init()) because MPICH has a bug in
761e5c89e4eSSatish Balay      it that it sets args[0] on all processors to be args[0] on the first processor.
762e5c89e4eSSatish Balay   */
763e5c89e4eSSatish Balay   if (argc && *argc) {
764e5c89e4eSSatish Balay     ierr = PetscSetProgramName(**args);CHKERRQ(ierr);
765e5c89e4eSSatish Balay   } else {
766e5c89e4eSSatish Balay     ierr = PetscSetProgramName("Unknown Name");CHKERRQ(ierr);
767e5c89e4eSSatish Balay   }
768e5c89e4eSSatish Balay 
769e5c89e4eSSatish Balay   ierr = MPI_Initialized(&flag);CHKERRQ(ierr);
770e5c89e4eSSatish Balay   if (!flag) {
771e32f2f54SBarry 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");
7725e765c61SJed Brown #if defined(PETSC_HAVE_MPI_INIT_THREAD)
7735e765c61SJed Brown     {
7745e765c61SJed Brown       PetscMPIInt provided;
7755e765c61SJed Brown       ierr = MPI_Init_thread(argc,args,MPI_THREAD_FUNNELED,&provided);CHKERRQ(ierr);
7765e765c61SJed Brown     }
7775e765c61SJed Brown #else
778e5c89e4eSSatish Balay     ierr = MPI_Init(argc,args);CHKERRQ(ierr);
7795e765c61SJed Brown #endif
780e5c89e4eSSatish Balay     PetscBeganMPI = PETSC_TRUE;
781e5c89e4eSSatish Balay   }
782e5c89e4eSSatish Balay   if (argc && args) {
783e5c89e4eSSatish Balay     PetscGlobalArgc = *argc;
784e5c89e4eSSatish Balay     PetscGlobalArgs = *args;
785e5c89e4eSSatish Balay   }
786e5c89e4eSSatish Balay   PetscFinalizeCalled = PETSC_FALSE;
787e5c89e4eSSatish Balay 
788a297a907SKarl Rupp   if (PETSC_COMM_WORLD == MPI_COMM_NULL) PETSC_COMM_WORLD = MPI_COMM_WORLD;
789d54338ecSKarl Rupp   ierr = MPI_Comm_set_errhandler(PETSC_COMM_WORLD,MPI_ERRORS_RETURN);CHKERRQ(ierr);
790e5c89e4eSSatish Balay 
791e5c89e4eSSatish Balay   /* Done after init due to a bug in MPICH-GM? */
792e5c89e4eSSatish Balay   ierr = PetscErrorPrintfInitialize();CHKERRQ(ierr);
793e5c89e4eSSatish Balay 
794e5c89e4eSSatish Balay   ierr = MPI_Comm_rank(MPI_COMM_WORLD,&PetscGlobalRank);CHKERRQ(ierr);
795e5c89e4eSSatish Balay   ierr = MPI_Comm_size(MPI_COMM_WORLD,&PetscGlobalSize);CHKERRQ(ierr);
796e5c89e4eSSatish Balay 
7978ad47952SJed Brown   MPIU_BOOL = MPI_INT;
7988ad47952SJed Brown   MPIU_ENUM = MPI_INT;
7998ad47952SJed Brown 
800e5c89e4eSSatish Balay   /*
801e5c89e4eSSatish Balay      Initialized the global complex variable; this is because with
802e5c89e4eSSatish Balay      shared libraries the constructors for global variables
803e5c89e4eSSatish Balay      are not called; at least on IRIX.
804e5c89e4eSSatish Balay   */
805886cfec0SSatish Balay #if defined(PETSC_HAVE_COMPLEX)
806e5c89e4eSSatish Balay   {
807a24ee22aSSatish Balay #if defined(PETSC_CLANGUAGE_CXX)
80850f81f78SJed Brown     PetscComplex ic(0.0,1.0);
809e5c89e4eSSatish Balay     PETSC_i = ic;
810a24ee22aSSatish Balay #elif defined(PETSC_CLANGUAGE_C)
81150f81f78SJed Brown     PETSC_i = _Complex_I;
812b7940d39SSatish Balay #endif
813762437b8SSatish Balay   }
814762437b8SSatish Balay 
8152c876bd9SBarry Smith #if !defined(PETSC_HAVE_MPI_C_DOUBLE_COMPLEX)
816e69cd0e6SSatish Balay   ierr = MPI_Type_contiguous(2,MPI_DOUBLE,&MPIU_C_DOUBLE_COMPLEX);CHKERRQ(ierr);
817500d8756SSatish Balay   ierr = MPI_Type_commit(&MPIU_C_DOUBLE_COMPLEX);CHKERRQ(ierr);
818500d8756SSatish Balay   ierr = MPI_Type_contiguous(2,MPI_FLOAT,&MPIU_C_COMPLEX);CHKERRQ(ierr);
819500d8756SSatish Balay   ierr = MPI_Type_commit(&MPIU_C_COMPLEX);CHKERRQ(ierr);
8202c876bd9SBarry Smith #endif
821886cfec0SSatish Balay #endif /* PETSC_HAVE_COMPLEX */
822e5c89e4eSSatish Balay 
823e5c89e4eSSatish Balay   /*
824e5c89e4eSSatish Balay      Create the PETSc MPI reduction operator that sums of the first
825e5c89e4eSSatish Balay      half of the entries and maxes the second half.
826e5c89e4eSSatish Balay   */
827e5c89e4eSSatish Balay   ierr = MPI_Op_create(PetscMaxSum_Local,1,&PetscMaxSum_Op);CHKERRQ(ierr);
828e5c89e4eSSatish Balay 
829ce63c4c1SBarry Smith #if defined(PETSC_USE_REAL___FLOAT128)
830c90a1750SBarry Smith   ierr = MPI_Type_contiguous(2,MPI_DOUBLE,&MPIU___FLOAT128);CHKERRQ(ierr);
831c90a1750SBarry Smith   ierr = MPI_Type_commit(&MPIU___FLOAT128);CHKERRQ(ierr);
8327c2de775SJed Brown #if defined(PETSC_HAVE_COMPLEX)
8338c764dc5SJose Roman   ierr = MPI_Type_contiguous(4,MPI_DOUBLE,&MPIU___COMPLEX128);CHKERRQ(ierr);
8348c764dc5SJose Roman   ierr = MPI_Type_commit(&MPIU___COMPLEX128);CHKERRQ(ierr);
8358c764dc5SJose Roman #endif
836d9822059SBarry Smith   ierr = MPI_Op_create(PetscMax_Local,1,&MPIU_MAX);CHKERRQ(ierr);
837d9822059SBarry Smith   ierr = MPI_Op_create(PetscMin_Local,1,&MPIU_MIN);CHKERRQ(ierr);
838c90a1750SBarry Smith #endif
839c90a1750SBarry Smith 
8407c2de775SJed Brown #if (defined(PETSC_HAVE_COMPLEX) && !defined(PETSC_HAVE_MPI_C_DOUBLE_COMPLEX)) || defined(PETSC_USE_REAL___FLOAT128)
841cca4cb22SSatish Balay   ierr = MPI_Op_create(PetscSum_Local,1,&MPIU_SUM);CHKERRQ(ierr);
842cca4cb22SSatish Balay #endif
843cca4cb22SSatish Balay 
844e5c89e4eSSatish Balay   ierr = MPI_Type_contiguous(2,MPIU_SCALAR,&MPIU_2SCALAR);CHKERRQ(ierr);
845e5c89e4eSSatish Balay   ierr = MPI_Type_commit(&MPIU_2SCALAR);CHKERRQ(ierr);
846e5c89e4eSSatish Balay   ierr = MPI_Op_create(PetscADMax_Local,1,&PetscADMax_Op);CHKERRQ(ierr);
847e5c89e4eSSatish Balay   ierr = MPI_Op_create(PetscADMin_Local,1,&PetscADMin_Op);CHKERRQ(ierr);
848e5c89e4eSSatish Balay 
84944041f26SJed Brown #if defined(PETSC_USE_64BIT_INDICES) || !defined(MPI_2INT)
850e5c89e4eSSatish Balay   ierr = MPI_Type_contiguous(2,MPIU_INT,&MPIU_2INT);CHKERRQ(ierr);
851e5c89e4eSSatish Balay   ierr = MPI_Type_commit(&MPIU_2INT);CHKERRQ(ierr);
85244041f26SJed Brown #endif
853e5c89e4eSSatish Balay 
854ec957eceSBarry Smith 
855e5c89e4eSSatish Balay   /*
856480cf27aSJed Brown      Attributes to be set on PETSc communicators
857480cf27aSJed Brown   */
858480cf27aSJed Brown   ierr = MPI_Keyval_create(MPI_NULL_COPY_FN,Petsc_DelCounter,&Petsc_Counter_keyval,(void*)0);CHKERRQ(ierr);
859da3039f7SJed Brown   ierr = MPI_Keyval_create(MPI_NULL_COPY_FN,Petsc_DelComm_Outer,&Petsc_InnerComm_keyval,(void*)0);CHKERRQ(ierr);
860da3039f7SJed Brown   ierr = MPI_Keyval_create(MPI_NULL_COPY_FN,Petsc_DelComm_Inner,&Petsc_OuterComm_keyval,(void*)0);CHKERRQ(ierr);
861480cf27aSJed Brown 
862480cf27aSJed Brown   /*
863e8fb0fc0SBarry Smith      Build the options database
864e5c89e4eSSatish Balay   */
865e5c89e4eSSatish Balay   ierr = PetscOptionsInsert(argc,args,file);CHKERRQ(ierr);
866e5c89e4eSSatish Balay 
8676dc8fec2Sbcordonn 
868e5c89e4eSSatish Balay   /*
869e5c89e4eSSatish Balay      Print main application help message
870e5c89e4eSSatish Balay   */
8710298fd71SBarry Smith   ierr = PetscOptionsHasName(NULL,"-help",&flg);CHKERRQ(ierr);
872e5c89e4eSSatish Balay   if (help && flg) {
873e5c89e4eSSatish Balay     ierr = PetscPrintf(PETSC_COMM_WORLD,help);CHKERRQ(ierr);
874e5c89e4eSSatish Balay   }
875e5c89e4eSSatish Balay   ierr = PetscOptionsCheckInitial_Private();CHKERRQ(ierr);
876e5c89e4eSSatish Balay 
877d45a07a7SBarry Smith   ierr = PetscCitationsInitialize();CHKERRQ(ierr);
878d45a07a7SBarry Smith 
879e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS)
88011525c0dSBarry Smith   ierr = PetscInitializeSAWs(help);CHKERRQ(ierr);
881f4202a44SBarry Smith #endif
882f4202a44SBarry Smith 
883e5c89e4eSSatish Balay   /* SHOULD PUT IN GUARDS: Make sure logging is initialized, even if we do not print it out */
884a9f03627SSatish Balay #if defined(PETSC_USE_LOG)
885e5c89e4eSSatish Balay   ierr = PetscLogBegin_Private();CHKERRQ(ierr);
886a9f03627SSatish Balay #endif
887e5c89e4eSSatish Balay 
888e5c89e4eSSatish Balay   /*
889e5c89e4eSSatish Balay      Load the dynamic libraries (on machines that support them), this registers all
890e5c89e4eSSatish Balay      the solvers etc. (On non-dynamic machines this initializes the PetscDraw and PetscViewer classes)
891e5c89e4eSSatish Balay   */
892e5c89e4eSSatish Balay   ierr = PetscInitialize_DynamicLibraries();CHKERRQ(ierr);
893e5c89e4eSSatish Balay 
894e5c89e4eSSatish Balay   ierr = MPI_Comm_size(PETSC_COMM_WORLD,&size);CHKERRQ(ierr);
895ae15b995SBarry Smith   ierr = PetscInfo1(0,"PETSc successfully started: number of processors = %d\n",size);CHKERRQ(ierr);
896e5c89e4eSSatish Balay   ierr = PetscGetHostName(hostname,256);CHKERRQ(ierr);
897ae15b995SBarry Smith   ierr = PetscInfo1(0,"Running on machine: %s\n",hostname);CHKERRQ(ierr);
898e5c89e4eSSatish Balay 
899e5c89e4eSSatish Balay   ierr = PetscOptionsCheckInitial_Components();CHKERRQ(ierr);
900ef6c6fedSBoyana Norris   /* Check the options database for options related to the options database itself */
901ef6c6fedSBoyana Norris   ierr = PetscOptionsSetFromOptions();CHKERRQ(ierr);
902ef6c6fedSBoyana Norris 
903951e3c8eSBarry Smith #if defined(PETSC_USE_PETSC_MPI_EXTERNAL32)
904e39fd77fSBarry Smith   /*
905e39fd77fSBarry Smith       Tell MPI about our own data representation converter, this would/should be used if extern32 is not supported by the MPI
906e39fd77fSBarry Smith 
907e39fd77fSBarry Smith       Currently not used because it is not supported by MPICH.
908e39fd77fSBarry Smith   */
909e39fd77fSBarry Smith #if !defined(PETSC_WORDS_BIGENDIAN)
9100298fd71SBarry Smith   ierr = MPI_Register_datarep((char*)"petsc",PetscDataRep_read_conv_fn,PetscDataRep_write_conv_fn,PetscDataRep_extent_fn,NULL);CHKERRQ(ierr);
911e39fd77fSBarry Smith #endif
912951e3c8eSBarry Smith #endif
913e39fd77fSBarry Smith 
9140298fd71SBarry Smith   ierr = PetscOptionsGetInt(NULL,"-hmpi_spawn_size",&nodesize,&flg);CHKERRQ(ierr);
915793721a6SBarry Smith   if (flg) {
91623464e94SBarry Smith #if defined(PETSC_HAVE_MPI_COMM_SPAWN)
91785afcc9aSBarry Smith     ierr = PetscHMPISpawn((PetscMPIInt) nodesize);CHKERRQ(ierr); /* worker nodes never return from here; they go directly to PetscEnd() */
91823464e94SBarry Smith #else
91985afcc9aSBarry Smith     SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SUP,"PETSc built without MPI 2 (MPI_Comm_spawn) support, use -hmpi_merge_size instead");
92023464e94SBarry Smith #endif
921793721a6SBarry Smith   } else {
9220298fd71SBarry Smith     ierr = PetscOptionsGetInt(NULL,"-hmpi_merge_size",&nodesize,&flg);CHKERRQ(ierr);
9238002f1cdSBarry Smith     if (flg) {
9240298fd71SBarry Smith       ierr = PetscHMPIMerge((PetscMPIInt) nodesize,NULL,NULL);CHKERRQ(ierr);
92585afcc9aSBarry Smith       if (PetscHMPIWorker) { /* if worker then never enter user code */
926bad7cb1dSBarry Smith         PetscInitializeCalled = PETSC_TRUE;
9273bf036e2SBarry Smith         PetscEnd();
9289505b675SBarry Smith       }
9298002f1cdSBarry Smith     }
930793721a6SBarry Smith   }
931e5c89e4eSSatish Balay 
93235d88935SVictor Minden #if defined(PETSC_HAVE_CUDA)
93320e2c332SMatthew G. Knepley   flg  = PETSC_TRUE;
93420e2c332SMatthew G. Knepley   ierr = PetscOptionsGetBool(NULL,"-cublas",&flg,NULL);CHKERRQ(ierr);
93520e2c332SMatthew G. Knepley   if (flg) {
9364bb5149bSJed Brown     PetscMPIInt p;
937663ba86aSMatthew G Knepley     for (p = 0; p < PetscGlobalSize; ++p) {
938a297a907SKarl Rupp       if (p == PetscGlobalRank) cublasInit();
939663ba86aSMatthew G Knepley       ierr = MPI_Barrier(PETSC_COMM_WORLD);CHKERRQ(ierr);
940663ba86aSMatthew G Knepley     }
9414bb5149bSJed Brown   }
9423e39abd9SVictor Minden #endif
94392e62aa6SBarry Smith 
9440298fd71SBarry Smith   ierr = PetscOptionsHasName(NULL,"-python",&flg);CHKERRQ(ierr);
9459ac80d5eSLisandro Dalcin   if (flg) {
9469ac80d5eSLisandro Dalcin     PetscInitializeCalled = PETSC_TRUE;
9470298fd71SBarry Smith     ierr = PetscPythonInitialize(NULL,NULL);CHKERRQ(ierr);
9489ac80d5eSLisandro Dalcin   }
9499ac80d5eSLisandro Dalcin 
950607a6623SBarry Smith   ierr = PetscThreadCommInitializePackage();CHKERRQ(ierr);
951bd8b14e7SShri Abhyankar 
95241c0b4b3SShri Abhyankar   /*
95341c0b4b3SShri Abhyankar       Setup building of stack frames for all function calls
95441c0b4b3SShri Abhyankar   */
95576386721SLisandro Dalcin   PetscThreadLocalRegister((PetscThreadKey*)&petscstack); /* Creates pthread_key */
956e1167bb9SShri Abhyankar #if defined(PETSC_USE_DEBUG)
957e1167bb9SShri Abhyankar   ierr = PetscStackCreate();CHKERRQ(ierr);
958e1167bb9SShri Abhyankar #endif
959e1167bb9SShri Abhyankar 
9602d53ad75SBarry Smith #if defined(PETSC_SERIALIZE_FUNCTIONS)
9612d53ad75SBarry Smith   ierr = PetscFPTCreate(10000);CHKERRQ(ierr);
9622d53ad75SBarry Smith #endif
9632d53ad75SBarry Smith 
964dff31646SBarry Smith 
965301d30feSBarry Smith   /*
966301d30feSBarry Smith       Once we are completedly initialized then we can set this variables
967301d30feSBarry Smith   */
968301d30feSBarry Smith   PetscInitializeCalled = PETSC_TRUE;
969301d30feSBarry Smith   PetscFunctionReturn(0);
970e5c89e4eSSatish Balay }
971e5c89e4eSSatish Balay 
9722eff7a51SBarry Smith extern PetscObject *PetscObjects;
9732eff7a51SBarry Smith extern PetscInt    PetscObjectsCounts, PetscObjectsMaxCounts;
974e5c89e4eSSatish Balay 
975e5c89e4eSSatish Balay #undef __FUNCT__
976e5c89e4eSSatish Balay #define __FUNCT__ "PetscFinalize"
977e5c89e4eSSatish Balay /*@C
978e5c89e4eSSatish Balay    PetscFinalize - Checks for options to be called at the conclusion
979e5c89e4eSSatish Balay    of the program. MPI_Finalize() is called only if the user had not
980e5c89e4eSSatish Balay    called MPI_Init() before calling PetscInitialize().
981e5c89e4eSSatish Balay 
982e5c89e4eSSatish Balay    Collective on PETSC_COMM_WORLD
983e5c89e4eSSatish Balay 
984e5c89e4eSSatish Balay    Options Database Keys:
98588c29154SBarry Smith +  -options_table - Calls PetscOptionsView()
986e5c89e4eSSatish Balay .  -options_left - Prints unused options that remain in the database
9877eb1d149SBarry Smith .  -objects_dump [all] - Prints list of objects allocated by the user that have not been freed, the option all cause all outstanding objects to be listed
988e5c89e4eSSatish Balay .  -mpidump - Calls PetscMPIDump()
989e5c89e4eSSatish Balay .  -malloc_dump - Calls PetscMallocDump()
990e5c89e4eSSatish Balay .  -malloc_info - Prints total memory usage
991e5c89e4eSSatish Balay -  -malloc_log - Prints summary of memory usage
992e5c89e4eSSatish Balay 
993e5c89e4eSSatish Balay    Level: beginner
994e5c89e4eSSatish Balay 
995e5c89e4eSSatish Balay    Note:
996e5c89e4eSSatish Balay    See PetscInitialize() for more general runtime options.
997e5c89e4eSSatish Balay 
99888c29154SBarry Smith .seealso: PetscInitialize(), PetscOptionsView(), PetscMallocDump(), PetscMPIDump(), PetscEnd()
999e5c89e4eSSatish Balay @*/
10007087cfbeSBarry Smith PetscErrorCode  PetscFinalize(void)
1001e5c89e4eSSatish Balay {
1002e5c89e4eSSatish Balay   PetscErrorCode ierr;
10034bb5149bSJed Brown   PetscMPIInt    rank;
1004a8d2bbe5SBarry Smith   PetscInt       nopt;
10052bf49c77SBarry Smith   PetscBool      flg1 = PETSC_FALSE,flg2 = PETSC_FALSE,flg3 = PETSC_FALSE;
1006dff31646SBarry Smith   PetscBool      flg;
100710463e74SBarry Smith #if defined(PETSC_USE_LOG)
100810463e74SBarry Smith   char           mname[PETSC_MAX_PATH_LEN];
100910463e74SBarry Smith #endif
1010e5c89e4eSSatish Balay 
1011e5c89e4eSSatish Balay   PetscFunctionBegin;
1012e5c89e4eSSatish Balay   if (!PetscInitializeCalled) {
10134b09e917SBarry Smith     printf("PetscInitialize() must be called before PetscFinalize()\n");
10144b09e917SBarry Smith     PetscFunctionReturn(PETSC_ERR_ARG_WRONGSTATE);
1015e5c89e4eSSatish Balay   }
10160298fd71SBarry Smith   ierr = PetscInfo(NULL,"PetscFinalize() called\n");CHKERRQ(ierr);
1017b022a5c1SBarry Smith 
10181f817a21SBarry Smith   ierr = MPI_Comm_rank(PETSC_COMM_WORLD,&rank);CHKERRQ(ierr);
10191f817a21SBarry Smith 
10201f817a21SBarry Smith   ierr = PetscOptionsHasName(NULL,"-citations",&flg);CHKERRQ(ierr);
1021dff31646SBarry Smith   if (flg) {
10221f817a21SBarry Smith     char  *cits, filename[PETSC_MAX_PATH_LEN];
10231f817a21SBarry Smith     FILE  *fd = PETSC_STDOUT;
10241f817a21SBarry Smith 
10251f817a21SBarry Smith     ierr = PetscOptionsGetString(NULL,"-citations",filename,PETSC_MAX_PATH_LEN,NULL);CHKERRQ(ierr);
10261f817a21SBarry Smith     if (filename[0]) {
10271f817a21SBarry Smith       ierr = PetscFOpen(PETSC_COMM_WORLD,filename,"w",&fd);CHKERRQ(ierr);
10281f817a21SBarry Smith     }
1029dff31646SBarry Smith     ierr = PetscSegBufferGet(PetscCitationsList,1,&cits);CHKERRQ(ierr);
1030dff31646SBarry Smith     cits[0] = 0;
1031dff31646SBarry Smith     ierr = PetscSegBufferExtractAlloc(PetscCitationsList,&cits);CHKERRQ(ierr);
10321f817a21SBarry Smith     ierr = PetscFPrintf(PETSC_COMM_WORLD,fd,"If you publish results based on this computation please cite the following:\n");CHKERRQ(ierr);
10331f817a21SBarry Smith     ierr = PetscFPrintf(PETSC_COMM_WORLD,fd,"===========================================================================\n");CHKERRQ(ierr);
10341f817a21SBarry Smith     ierr = PetscFPrintf(PETSC_COMM_WORLD,fd,"%s",cits);CHKERRQ(ierr);
10351f817a21SBarry Smith     ierr = PetscFPrintf(PETSC_COMM_WORLD,fd,"===========================================================================\n");CHKERRQ(ierr);
10361f817a21SBarry Smith     ierr = PetscFClose(PETSC_COMM_WORLD,fd);CHKERRQ(ierr);
1037dff31646SBarry Smith     ierr = PetscFree(cits);CHKERRQ(ierr);
1038dff31646SBarry Smith   }
1039dff31646SBarry Smith   ierr = PetscSegBufferDestroy(&PetscCitationsList);CHKERRQ(ierr);
1040dff31646SBarry Smith 
10412d53ad75SBarry Smith #if defined(PETSC_SERIALIZE_FUNCTIONS)
10422d53ad75SBarry Smith   ierr = PetscFPTDestroy();CHKERRQ(ierr);
10432d53ad75SBarry Smith #endif
10442d53ad75SBarry Smith 
10452d53ad75SBarry Smith 
1046e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS)
1047dff31646SBarry Smith   flg = PETSC_FALSE;
1048e78c4b8cSBarry Smith   ierr = PetscOptionsGetBool(NULL,"-saw_options",&flg,NULL);CHKERRQ(ierr);
1049d5649816SBarry Smith   if (flg) {
1050e04113cfSBarry Smith     ierr = PetscOptionsSAWsDestroy();CHKERRQ(ierr);
1051d5649816SBarry Smith   }
1052d5649816SBarry Smith #endif
1053d5649816SBarry Smith 
1054681455b2SBarry Smith #if defined(PETSC_HAVE_X)
1055681455b2SBarry Smith   flg1 = PETSC_FALSE;
1056681455b2SBarry Smith   ierr = PetscOptionsGetBool(NULL,"-x_virtual",&flg1,NULL);CHKERRQ(ierr);
1057681455b2SBarry Smith   if (flg1) {
1058681455b2SBarry Smith     /*  this is a crude hack, but better than nothing */
1059681455b2SBarry Smith     ierr = PetscPOpen(PETSC_COMM_WORLD,NULL,"pkill -9 Xvfb","r",NULL);CHKERRQ(ierr);
1060681455b2SBarry Smith   }
1061681455b2SBarry Smith #endif
1062681455b2SBarry Smith 
106385afcc9aSBarry Smith   ierr = PetscHMPIFinalize();CHKERRQ(ierr);
1064d3f95da6SShri Abhyankar 
10650298fd71SBarry Smith   ierr = PetscOptionsGetBool(NULL,"-malloc_info",&flg2,NULL);CHKERRQ(ierr);
1066e5c89e4eSSatish Balay   if (!flg2) {
106790d69ab7SBarry Smith     flg2 = PETSC_FALSE;
10680298fd71SBarry Smith     ierr = PetscOptionsGetBool(NULL,"-memory_info",&flg2,NULL);CHKERRQ(ierr);
1069e5c89e4eSSatish Balay   }
1070e5c89e4eSSatish Balay   if (flg2) {
1071e5c89e4eSSatish Balay     ierr = PetscMemoryShowUsage(PETSC_VIEWER_STDOUT_WORLD,"Summary of Memory Usage in PETSc\n");CHKERRQ(ierr);
1072e5c89e4eSSatish Balay   }
1073e5c89e4eSSatish Balay 
1074e5c89e4eSSatish Balay #if defined(PETSC_USE_LOG)
107590d69ab7SBarry Smith   flg1 = PETSC_FALSE;
10760298fd71SBarry Smith   ierr = PetscOptionsGetBool(NULL,"-get_total_flops",&flg1,NULL);CHKERRQ(ierr);
1077e5c89e4eSSatish Balay   if (flg1) {
1078e5c89e4eSSatish Balay     PetscLogDouble flops = 0;
1079205a32c2SJed Brown     ierr = MPI_Reduce(&petsc_TotalFlops,&flops,1,MPI_DOUBLE,MPI_SUM,0,PETSC_COMM_WORLD);CHKERRQ(ierr);
1080e5c89e4eSSatish Balay     ierr = PetscPrintf(PETSC_COMM_WORLD,"Total flops over all processors %g\n",flops);CHKERRQ(ierr);
1081e5c89e4eSSatish Balay   }
1082e5c89e4eSSatish Balay #endif
1083e5c89e4eSSatish Balay 
1084e5c89e4eSSatish Balay 
1085e5c89e4eSSatish Balay #if defined(PETSC_USE_LOG)
1086e5c89e4eSSatish Balay #if defined(PETSC_HAVE_MPE)
1087e5c89e4eSSatish Balay   mname[0] = 0;
1088a297a907SKarl Rupp 
10890298fd71SBarry Smith   ierr = PetscOptionsGetString(NULL,"-log_mpe",mname,PETSC_MAX_PATH_LEN,&flg1);CHKERRQ(ierr);
1090e5c89e4eSSatish Balay   if (flg1) {
1091e5c89e4eSSatish Balay     if (mname[0]) {ierr = PetscLogMPEDump(mname);CHKERRQ(ierr);}
1092e5c89e4eSSatish Balay     else          {ierr = PetscLogMPEDump(0);CHKERRQ(ierr);}
1093e5c89e4eSSatish Balay   }
1094e5c89e4eSSatish Balay #endif
1095e5c89e4eSSatish Balay   mname[0] = 0;
1096a297a907SKarl Rupp 
10970298fd71SBarry Smith   ierr = PetscOptionsGetString(NULL,"-log_summary",mname,PETSC_MAX_PATH_LEN,&flg1);CHKERRQ(ierr);
1098e5c89e4eSSatish Balay   if (flg1) {
109991eabc43SBarry Smith     PetscViewer viewer;
110091eabc43SBarry Smith     if (mname[0]) {
110191eabc43SBarry Smith       ierr = PetscViewerASCIIOpen(PETSC_COMM_WORLD,mname,&viewer);CHKERRQ(ierr);
110291eabc43SBarry Smith       ierr = PetscLogView(viewer);CHKERRQ(ierr);
11036bf464f9SBarry Smith       ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr);
110433f85c2fSBarry Smith     } else {
110533f85c2fSBarry Smith       viewer = PETSC_VIEWER_STDOUT_WORLD;
110633f85c2fSBarry Smith       ierr   = PetscLogView(viewer);CHKERRQ(ierr);
110733f85c2fSBarry Smith     }
1108e5c89e4eSSatish Balay   }
1109e5c89e4eSSatish Balay 
1110ff5bc46bSBarry Smith   mname[0] = 0;
1111a297a907SKarl Rupp 
11120298fd71SBarry Smith   ierr = PetscOptionsGetString(NULL,"-log_summary_python",mname,PETSC_MAX_PATH_LEN,&flg1);CHKERRQ(ierr);
1113ff5bc46bSBarry Smith   if (flg1) {
1114ff5bc46bSBarry Smith     PetscViewer viewer;
1115ff5bc46bSBarry Smith     if (mname[0]) {
1116ff5bc46bSBarry Smith       ierr = PetscViewerASCIIOpen(PETSC_COMM_WORLD,mname,&viewer);CHKERRQ(ierr);
111791eabc43SBarry Smith       ierr = PetscLogViewPython(viewer);CHKERRQ(ierr);
11186bf464f9SBarry Smith       ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr);
111933f85c2fSBarry Smith     } else {
112033f85c2fSBarry Smith       viewer = PETSC_VIEWER_STDOUT_WORLD;
112133f85c2fSBarry Smith       ierr   = PetscLogViewPython(viewer);CHKERRQ(ierr);
112233f85c2fSBarry Smith     }
1123ff5bc46bSBarry Smith   }
1124ff5bc46bSBarry Smith 
11250298fd71SBarry Smith   ierr = PetscOptionsGetString(NULL,"-log_detailed",mname,PETSC_MAX_PATH_LEN,&flg1);CHKERRQ(ierr);
112678392ef1SBarry Smith   if (flg1) {
112778392ef1SBarry Smith     if (mname[0])  {ierr = PetscLogPrintDetailed(PETSC_COMM_WORLD,mname);CHKERRQ(ierr);}
112878392ef1SBarry Smith     else           {ierr = PetscLogPrintDetailed(PETSC_COMM_WORLD,0);CHKERRQ(ierr);}
112978392ef1SBarry Smith   }
113078392ef1SBarry Smith 
1131e5c89e4eSSatish Balay   mname[0] = 0;
1132a297a907SKarl Rupp 
11330298fd71SBarry Smith   ierr = PetscOptionsGetString(NULL,"-log_all",mname,PETSC_MAX_PATH_LEN,&flg1);CHKERRQ(ierr);
11340298fd71SBarry Smith   ierr = PetscOptionsGetString(NULL,"-log",mname,PETSC_MAX_PATH_LEN,&flg2);CHKERRQ(ierr);
1135e5c89e4eSSatish Balay   if (flg1 || flg2) {
1136e5c89e4eSSatish Balay     if (mname[0]) PetscLogDump(mname);
1137e5c89e4eSSatish Balay     else          PetscLogDump(0);
1138e5c89e4eSSatish Balay   }
1139e5c89e4eSSatish Balay #endif
114010463e74SBarry Smith 
1141b58ca069SBarry Smith   /*
1142b58ca069SBarry Smith      Free all objects registered with PetscObjectRegisterDestroy() such as PETSC_VIEWER_XXX_().
1143b58ca069SBarry Smith   */
1144b58ca069SBarry Smith   ierr = PetscObjectRegisterDestroyAll();CHKERRQ(ierr);
1145b58ca069SBarry Smith 
114633f85c2fSBarry Smith   ierr = PetscStackDestroy();CHKERRQ(ierr);
114776386721SLisandro Dalcin   PetscThreadLocalDestroy((PetscThreadKey)petscstack); /* Deletes pthread_key */
114810463e74SBarry Smith 
114990d69ab7SBarry Smith   flg1 = PETSC_FALSE;
11500298fd71SBarry Smith   ierr = PetscOptionsGetBool(NULL,"-no_signal_handler",&flg1,NULL);CHKERRQ(ierr);
1151e5c89e4eSSatish Balay   if (!flg1) { ierr = PetscPopSignalHandler();CHKERRQ(ierr);}
115290d69ab7SBarry Smith   flg1 = PETSC_FALSE;
11530298fd71SBarry Smith   ierr = PetscOptionsGetBool(NULL,"-mpidump",&flg1,NULL);CHKERRQ(ierr);
1154e5c89e4eSSatish Balay   if (flg1) {
1155e5c89e4eSSatish Balay     ierr = PetscMPIDump(stdout);CHKERRQ(ierr);
1156e5c89e4eSSatish Balay   }
115790d69ab7SBarry Smith   flg1 = PETSC_FALSE;
115890d69ab7SBarry Smith   flg2 = PETSC_FALSE;
11598bb29257SSatish Balay   /* preemptive call to avoid listing this option in options table as unused */
11600298fd71SBarry Smith   ierr = PetscOptionsHasName(NULL,"-malloc_dump",&flg1);CHKERRQ(ierr);
11610298fd71SBarry Smith   ierr = PetscOptionsHasName(NULL,"-objects_dump",&flg1);CHKERRQ(ierr);
11620298fd71SBarry Smith   ierr = PetscOptionsGetBool(NULL,"-options_table",&flg2,NULL);CHKERRQ(ierr);
1163e4c476e2SSatish Balay 
1164e5c89e4eSSatish Balay   if (flg2) {
1165be56827dSJed Brown     PetscViewer viewer;
1166be56827dSJed Brown     ierr = PetscViewerASCIIGetStdout(PETSC_COMM_WORLD,&viewer);CHKERRQ(ierr);
1167be56827dSJed Brown     ierr = PetscOptionsView(viewer);CHKERRQ(ierr);
1168be56827dSJed Brown     ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr);
1169e5c89e4eSSatish Balay   }
1170e5c89e4eSSatish Balay 
1171e5c89e4eSSatish Balay   /* to prevent PETSc -options_left from warning */
11720298fd71SBarry Smith   ierr = PetscOptionsHasName(NULL,"-nox",&flg1);CHKERRQ(ierr);
11730298fd71SBarry Smith   ierr = PetscOptionsHasName(NULL,"-nox_warning",&flg1);CHKERRQ(ierr);
1174e5c89e4eSSatish Balay 
117585afcc9aSBarry Smith   if (!PetscHMPIWorker) { /* worker processes skip this because they do not usually process options */
117633fc4174SSatish Balay     flg3 = PETSC_FALSE; /* default value is required */
11770298fd71SBarry Smith     ierr = PetscOptionsGetBool(NULL,"-options_left",&flg3,&flg1);CHKERRQ(ierr);
1178e5c89e4eSSatish Balay     ierr = PetscOptionsAllUsed(&nopt);CHKERRQ(ierr);
1179e5c89e4eSSatish Balay     if (flg3) {
1180e5c89e4eSSatish Balay       if (!flg2) { /* have not yet printed the options */
1181be56827dSJed Brown         PetscViewer viewer;
1182be56827dSJed Brown         ierr = PetscViewerASCIIGetStdout(PETSC_COMM_WORLD,&viewer);CHKERRQ(ierr);
1183be56827dSJed Brown         ierr = PetscOptionsView(viewer);CHKERRQ(ierr);
1184be56827dSJed Brown         ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr);
1185e5c89e4eSSatish Balay       }
1186e5c89e4eSSatish Balay       if (!nopt) {
1187e5c89e4eSSatish Balay         ierr = PetscPrintf(PETSC_COMM_WORLD,"There are no unused options.\n");CHKERRQ(ierr);
1188e5c89e4eSSatish Balay       } else if (nopt == 1) {
1189e5c89e4eSSatish Balay         ierr = PetscPrintf(PETSC_COMM_WORLD,"There is one unused database option. It is:\n");CHKERRQ(ierr);
1190e5c89e4eSSatish Balay       } else {
11917582186dSLisandro Dalcin         ierr = PetscPrintf(PETSC_COMM_WORLD,"There are %D unused database options. They are:\n",nopt);CHKERRQ(ierr);
1192e5c89e4eSSatish Balay       }
1193e5c89e4eSSatish Balay     }
1194e5c89e4eSSatish Balay #if defined(PETSC_USE_DEBUG)
1195da8b8a77SBarry Smith     if (nopt && !flg3 && !flg1) {
1196e5c89e4eSSatish Balay       ierr = PetscPrintf(PETSC_COMM_WORLD,"WARNING! There are options you set that were not used!\n");CHKERRQ(ierr);
1197e5c89e4eSSatish Balay       ierr = PetscPrintf(PETSC_COMM_WORLD,"WARNING! could be spelling mistake, etc!\n");CHKERRQ(ierr);
1198e5c89e4eSSatish Balay       ierr = PetscOptionsLeft();CHKERRQ(ierr);
1199e5c89e4eSSatish Balay     } else if (nopt && flg3) {
1200e5c89e4eSSatish Balay #else
1201e5c89e4eSSatish Balay     if (nopt && flg3) {
1202e5c89e4eSSatish Balay #endif
1203e5c89e4eSSatish Balay       ierr = PetscOptionsLeft();CHKERRQ(ierr);
1204e5c89e4eSSatish Balay     }
1205931f367cSBarry Smith   }
1206e5c89e4eSSatish Balay 
1207e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS)
1208d45a07a7SBarry Smith   if (!PetscGlobalRank) {
120987f587eeSBarry Smith     ierr = PetscStackSAWsViewOff();CHKERRQ(ierr);
121016ad0300SBarry Smith     PetscStackCallSAWs(SAWs_Finalize,());
1211d45a07a7SBarry Smith   }
1212ec957eceSBarry Smith #endif
1213ec957eceSBarry Smith 
1214eea2bdeeSJed Brown   {
1215eea2bdeeSJed Brown     PetscThreadComm tcomm_world;
1216eea2bdeeSJed Brown     ierr = PetscGetThreadCommWorld(&tcomm_world);CHKERRQ(ierr);
1217eea2bdeeSJed Brown     /* Free global thread communicator */
1218eea2bdeeSJed Brown     ierr = PetscThreadCommDestroy(&tcomm_world);CHKERRQ(ierr);
1219eea2bdeeSJed Brown   }
1220eea2bdeeSJed Brown 
122110463e74SBarry Smith   /*
1222dbc8283eSBarry Smith        List all objects the user may have forgot to free
12232eff7a51SBarry Smith   */
12240298fd71SBarry Smith   ierr = PetscOptionsHasName(NULL,"-objects_dump",&flg1);CHKERRQ(ierr);
1225a64a8e02SBarry Smith   if (flg1) {
1226a64a8e02SBarry Smith     MPI_Comm local_comm;
12277eb1d149SBarry Smith     char     string[64];
1228a64a8e02SBarry Smith 
12290298fd71SBarry Smith     ierr = PetscOptionsGetString(NULL,"-objects_dump",string,64,NULL);CHKERRQ(ierr);
1230a64a8e02SBarry Smith     ierr = MPI_Comm_dup(MPI_COMM_WORLD,&local_comm);CHKERRQ(ierr);
1231a64a8e02SBarry Smith     ierr = PetscSequentialPhaseBegin_Private(local_comm,1);CHKERRQ(ierr);
12327eb1d149SBarry Smith     ierr = PetscObjectsDump(stdout,(string[0] == 'a') ? PETSC_TRUE : PETSC_FALSE);CHKERRQ(ierr);
1233a64a8e02SBarry Smith     ierr = PetscSequentialPhaseEnd_Private(local_comm,1);CHKERRQ(ierr);
1234a64a8e02SBarry Smith     ierr = MPI_Comm_free(&local_comm);CHKERRQ(ierr);
12350a1571b3SBarry Smith   }
1236dbc8283eSBarry Smith   PetscObjectsCounts    = 0;
1237dbc8283eSBarry Smith   PetscObjectsMaxCounts = 0;
12382eff7a51SBarry Smith 
1239a297a907SKarl Rupp   ierr = PetscFree(PetscObjects);CHKERRQ(ierr);
12402eff7a51SBarry Smith 
124133f85c2fSBarry Smith #if defined(PETSC_USE_LOG)
124233f85c2fSBarry Smith   ierr = PetscLogDestroy();CHKERRQ(ierr);
124333f85c2fSBarry Smith #endif
124433f85c2fSBarry Smith 
124533f85c2fSBarry Smith   /*
124633f85c2fSBarry Smith      Destroy any packages that registered a finalize
124733f85c2fSBarry Smith   */
124833f85c2fSBarry Smith   ierr = PetscRegisterFinalizeAll();CHKERRQ(ierr);
124933f85c2fSBarry Smith 
125033f85c2fSBarry Smith   /*
125110463e74SBarry Smith      Destroy all the function registration lists created
125210463e74SBarry Smith   */
125310463e74SBarry Smith   ierr = PetscFinalize_DynamicLibraries();CHKERRQ(ierr);
125410463e74SBarry Smith 
125548dd1dffSBarry Smith   /*
125648dd1dffSBarry Smith      Print PetscFunctionLists that have not been properly freed
125748dd1dffSBarry Smith 
125837e93019SBarry Smith   ierr = PetscFunctionListPrintAll();CHKERRQ(ierr);
125948dd1dffSBarry Smith   */
126037e93019SBarry Smith 
12614028d114SSatish Balay   if (petsc_history) {
1262f3dea69dSBarry Smith     ierr = PetscCloseHistoryFile(&petsc_history);CHKERRQ(ierr);
1263e5c89e4eSSatish Balay     petsc_history = 0;
1264e5c89e4eSSatish Balay   }
1265e5c89e4eSSatish Balay 
12660298fd71SBarry Smith   ierr = PetscInfoAllow(PETSC_FALSE,NULL);CHKERRQ(ierr);
1267e5c89e4eSSatish Balay 
12688bb29257SSatish Balay   {
1269e5c89e4eSSatish Balay     char fname[PETSC_MAX_PATH_LEN];
1270e5c89e4eSSatish Balay     FILE *fd;
1271ed9cf6e9SBarry Smith     int  err;
1272e5c89e4eSSatish Balay 
1273e5c89e4eSSatish Balay     fname[0] = 0;
1274a297a907SKarl Rupp 
12750298fd71SBarry Smith     ierr = PetscOptionsGetString(NULL,"-malloc_dump",fname,250,&flg1);CHKERRQ(ierr);
1276dc92acbaSJed Brown     flg2 = PETSC_FALSE;
12770298fd71SBarry Smith     ierr = PetscOptionsGetBool(NULL,"-malloc_test",&flg2,NULL);CHKERRQ(ierr);
12788bf1f09cSShri Abhyankar #if defined(PETSC_USE_DEBUG)
1279dc92acbaSJed Brown     if (PETSC_RUNNING_ON_VALGRIND) flg2 = PETSC_FALSE;
1280dc92acbaSJed Brown #else
1281dc92acbaSJed Brown     flg2 = PETSC_FALSE;         /* Skip reporting for optimized builds regardless of -malloc_test */
1282dc92acbaSJed Brown #endif
1283e5c89e4eSSatish Balay     if (flg1 && fname[0]) {
1284e5c89e4eSSatish Balay       char sname[PETSC_MAX_PATH_LEN];
1285e5c89e4eSSatish Balay 
1286e5c89e4eSSatish Balay       sprintf(sname,"%s_%d",fname,rank);
1287e32f2f54SBarry Smith       fd   = fopen(sname,"w"); if (!fd) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_FILE_OPEN,"Cannot open log file: %s",sname);
1288e5c89e4eSSatish Balay       ierr = PetscMallocDump(fd);CHKERRQ(ierr);
1289ed9cf6e9SBarry Smith       err  = fclose(fd);
1290e32f2f54SBarry Smith       if (err) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SYS,"fclose() failed on file");
1291dc92acbaSJed Brown     } else if (flg1 || flg2) {
1292e5c89e4eSSatish Balay       MPI_Comm local_comm;
1293e5c89e4eSSatish Balay 
1294e5c89e4eSSatish Balay       ierr = MPI_Comm_dup(MPI_COMM_WORLD,&local_comm);CHKERRQ(ierr);
1295e5c89e4eSSatish Balay       ierr = PetscSequentialPhaseBegin_Private(local_comm,1);CHKERRQ(ierr);
1296e5c89e4eSSatish Balay       ierr = PetscMallocDump(stdout);CHKERRQ(ierr);
1297e5c89e4eSSatish Balay       ierr = PetscSequentialPhaseEnd_Private(local_comm,1);CHKERRQ(ierr);
1298e5c89e4eSSatish Balay       ierr = MPI_Comm_free(&local_comm);CHKERRQ(ierr);
1299e5c89e4eSSatish Balay     }
1300e5c89e4eSSatish Balay   }
1301a64a8e02SBarry Smith 
13028bb29257SSatish Balay   {
1303e5c89e4eSSatish Balay     char fname[PETSC_MAX_PATH_LEN];
13040298fd71SBarry Smith     FILE *fd = NULL;
1305e5c89e4eSSatish Balay 
1306e5c89e4eSSatish Balay     fname[0] = 0;
1307a297a907SKarl Rupp 
13080298fd71SBarry Smith     ierr = PetscOptionsGetString(NULL,"-malloc_log",fname,250,&flg1);CHKERRQ(ierr);
13090298fd71SBarry Smith     ierr = PetscOptionsHasName(NULL,"-malloc_log_threshold",&flg2);CHKERRQ(ierr);
1310e5c89e4eSSatish Balay     if (flg1 && fname[0]) {
1311ed9cf6e9SBarry Smith       int err;
1312e5c89e4eSSatish Balay 
1313574034a9SJed Brown       if (!rank) {
1314574034a9SJed Brown         fd = fopen(fname,"w");
1315574034a9SJed Brown         if (!fd) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_FILE_OPEN,"Cannot open log file: %s",fname);
1316574034a9SJed Brown       }
1317e5c89e4eSSatish Balay       ierr = PetscMallocDumpLog(fd);CHKERRQ(ierr);
1318574034a9SJed Brown       if (fd) {
1319ed9cf6e9SBarry Smith         err = fclose(fd);
1320e32f2f54SBarry Smith         if (err) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SYS,"fclose() failed on file");
1321574034a9SJed Brown       }
1322574034a9SJed Brown     } else if (flg1 || flg2) {
1323e5c89e4eSSatish Balay       ierr = PetscMallocDumpLog(stdout);CHKERRQ(ierr);
1324e5c89e4eSSatish Balay     }
1325e5c89e4eSSatish Balay   }
132620e2c332SMatthew G. Knepley 
132720e2c332SMatthew G. Knepley #if defined(PETSC_HAVE_CUDA)
132820e2c332SMatthew G. Knepley   flg  = PETSC_TRUE;
132920e2c332SMatthew G. Knepley   ierr = PetscOptionsGetBool(NULL,"-cublas",&flg,NULL);CHKERRQ(ierr);
133020e2c332SMatthew G. Knepley   if (flg) {
133120e2c332SMatthew G. Knepley     PetscInt p;
133220e2c332SMatthew G. Knepley     for (p = 0; p < PetscGlobalSize; ++p) {
133320e2c332SMatthew G. Knepley       if (p == PetscGlobalRank) cublasShutdown();
133420e2c332SMatthew G. Knepley       ierr = MPI_Barrier(PETSC_COMM_WORLD);CHKERRQ(ierr);
133520e2c332SMatthew G. Knepley     }
133620e2c332SMatthew G. Knepley   }
133720e2c332SMatthew G. Knepley #endif
133820e2c332SMatthew G. Knepley 
1339e5c89e4eSSatish Balay   /* Can be destroyed only after all the options are used */
1340e5c89e4eSSatish Balay   ierr = PetscOptionsDestroy();CHKERRQ(ierr);
1341e5c89e4eSSatish Balay 
1342e5c89e4eSSatish Balay   PetscGlobalArgc = 0;
1343e5c89e4eSSatish Balay   PetscGlobalArgs = 0;
1344e5c89e4eSSatish Balay 
1345ce63c4c1SBarry Smith #if defined(PETSC_USE_REAL___FLOAT128)
1346c90a1750SBarry Smith   ierr = MPI_Type_free(&MPIU___FLOAT128);CHKERRQ(ierr);
13477c2de775SJed Brown #if defined(PETSC_HAVE_COMPLEX)
13488c764dc5SJose Roman   ierr = MPI_Type_free(&MPIU___COMPLEX128);CHKERRQ(ierr);
13498c764dc5SJose Roman #endif
1350d9822059SBarry Smith   ierr = MPI_Op_free(&MPIU_MAX);CHKERRQ(ierr);
1351d9822059SBarry Smith   ierr = MPI_Op_free(&MPIU_MIN);CHKERRQ(ierr);
1352c90a1750SBarry Smith #endif
1353c90a1750SBarry Smith 
13547c2de775SJed Brown #if defined(PETSC_HAVE_COMPLEX)
13552c876bd9SBarry Smith #if !defined(PETSC_HAVE_MPI_C_DOUBLE_COMPLEX)
1356500d8756SSatish Balay   ierr = MPI_Type_free(&MPIU_C_DOUBLE_COMPLEX);CHKERRQ(ierr);
1357500d8756SSatish Balay   ierr = MPI_Type_free(&MPIU_C_COMPLEX);CHKERRQ(ierr);
13582c876bd9SBarry Smith #endif
1359e5c89e4eSSatish Balay #endif
1360cca4cb22SSatish Balay 
13617c2de775SJed Brown #if (defined(PETSC_HAVE_COMPLEX) && !defined(PETSC_HAVE_MPI_C_DOUBLE_COMPLEX)) || defined(PETSC_USE_REAL___FLOAT128)
1362cca4cb22SSatish Balay   ierr = MPI_Op_free(&MPIU_SUM);CHKERRQ(ierr);
1363cca4cb22SSatish Balay #endif
1364cca4cb22SSatish Balay 
1365e5c89e4eSSatish Balay   ierr = MPI_Type_free(&MPIU_2SCALAR);CHKERRQ(ierr);
136644041f26SJed Brown #if defined(PETSC_USE_64BIT_INDICES) || !defined(MPI_2INT)
1367e5c89e4eSSatish Balay   ierr = MPI_Type_free(&MPIU_2INT);CHKERRQ(ierr);
136844041f26SJed Brown #endif
1369e5c89e4eSSatish Balay   ierr = MPI_Op_free(&PetscMaxSum_Op);CHKERRQ(ierr);
1370e5c89e4eSSatish Balay   ierr = MPI_Op_free(&PetscADMax_Op);CHKERRQ(ierr);
1371e5c89e4eSSatish Balay   ierr = MPI_Op_free(&PetscADMin_Op);CHKERRQ(ierr);
1372e5c89e4eSSatish Balay 
1373dbc8283eSBarry Smith   /*
1374efb80d3cSBarry Smith      Destroy any known inner MPI_Comm's and attributes pointing to them
1375efb80d3cSBarry Smith      Note this will not destroy any new communicators the user has created.
1376efb80d3cSBarry Smith 
1377efb80d3cSBarry Smith      If all PETSc objects were not destroyed those left over objects will have hanging references to
1378efb80d3cSBarry Smith      the MPI_Comms that were freed; but that is ok because those PETSc objects will never be used again
1379dbc8283eSBarry Smith  */
1380b770b1f6SSatish Balay   {
1381dbc8283eSBarry Smith     PetscCommCounter *counter;
1382dbc8283eSBarry Smith     PetscMPIInt      flg;
1383dbc8283eSBarry Smith     MPI_Comm         icomm;
1384265f3f35SJed Brown     union {MPI_Comm comm; void *ptr;} ucomm;
1385265f3f35SJed Brown     ierr = MPI_Attr_get(PETSC_COMM_SELF,Petsc_InnerComm_keyval,&ucomm,&flg);CHKERRQ(ierr);
1386dbc8283eSBarry Smith     if (flg) {
1387265f3f35SJed Brown       icomm = ucomm.comm;
1388dbc8283eSBarry Smith       ierr = MPI_Attr_get(icomm,Petsc_Counter_keyval,&counter,&flg);CHKERRQ(ierr);
1389dbc8283eSBarry 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");
1390dbc8283eSBarry Smith 
1391dbc8283eSBarry Smith       ierr = MPI_Attr_delete(PETSC_COMM_SELF,Petsc_InnerComm_keyval);CHKERRQ(ierr);
1392efb80d3cSBarry Smith       ierr = MPI_Attr_delete(icomm,Petsc_Counter_keyval);CHKERRQ(ierr);
1393efb80d3cSBarry Smith       ierr = MPI_Comm_free(&icomm);CHKERRQ(ierr);
1394dbc8283eSBarry Smith     }
1395265f3f35SJed Brown     ierr = MPI_Attr_get(PETSC_COMM_WORLD,Petsc_InnerComm_keyval,&ucomm,&flg);CHKERRQ(ierr);
1396dbc8283eSBarry Smith     if (flg) {
1397265f3f35SJed Brown       icomm = ucomm.comm;
1398dbc8283eSBarry Smith       ierr = MPI_Attr_get(icomm,Petsc_Counter_keyval,&counter,&flg);CHKERRQ(ierr);
1399dbc8283eSBarry 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");
1400dbc8283eSBarry Smith 
1401dbc8283eSBarry Smith       ierr = MPI_Attr_delete(PETSC_COMM_WORLD,Petsc_InnerComm_keyval);CHKERRQ(ierr);
1402efb80d3cSBarry Smith       ierr = MPI_Attr_delete(icomm,Petsc_Counter_keyval);CHKERRQ(ierr);
1403efb80d3cSBarry Smith       ierr = MPI_Comm_free(&icomm);CHKERRQ(ierr);
1404dbc8283eSBarry Smith     }
1405b770b1f6SSatish Balay   }
1406dbc8283eSBarry Smith 
1407480cf27aSJed Brown   ierr = MPI_Keyval_free(&Petsc_Counter_keyval);CHKERRQ(ierr);
1408480cf27aSJed Brown   ierr = MPI_Keyval_free(&Petsc_InnerComm_keyval);CHKERRQ(ierr);
1409480cf27aSJed Brown   ierr = MPI_Keyval_free(&Petsc_OuterComm_keyval);CHKERRQ(ierr);
1410480cf27aSJed Brown 
1411e5c89e4eSSatish Balay   if (PetscBeganMPI) {
141299608316SBarry Smith #if defined(PETSC_HAVE_MPI_FINALIZED)
141399b1327fSBarry Smith     PetscMPIInt flag;
141499b1327fSBarry Smith     ierr = MPI_Finalized(&flag);CHKERRQ(ierr);
1415e32f2f54SBarry Smith     if (flag) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_LIB,"MPI_Finalize() has already been called, even though MPI_Init() was called by PetscInitialize()");
141699608316SBarry Smith #endif
1417e5c89e4eSSatish Balay     ierr = MPI_Finalize();CHKERRQ(ierr);
1418e5c89e4eSSatish Balay   }
1419e5c89e4eSSatish Balay /*
1420e5c89e4eSSatish Balay 
1421e5c89e4eSSatish Balay      Note: In certain cases PETSC_COMM_WORLD is never MPI_Comm_free()ed because
1422e5c89e4eSSatish Balay    the communicator has some outstanding requests on it. Specifically if the
1423e5c89e4eSSatish Balay    flag PETSC_HAVE_BROKEN_REQUEST_FREE is set (for IBM MPI implementation). See
1424e5c89e4eSSatish Balay    src/vec/utils/vpscat.c. Due to this the memory allocated in PetscCommDuplicate()
1425e5c89e4eSSatish Balay    is never freed as it should be. Thus one may obtain messages of the form
14260e5e90baSSatish Balay    [ 1] 8 bytes PetscCommDuplicate() line 645 in src/sys/mpiu.c indicating the
1427e5c89e4eSSatish Balay    memory was not freed.
1428e5c89e4eSSatish Balay 
1429e5c89e4eSSatish Balay */
14301d1a0024SBarry Smith   ierr = PetscMallocClear();CHKERRQ(ierr);
1431a297a907SKarl Rupp 
1432e5c89e4eSSatish Balay   PetscInitializeCalled = PETSC_FALSE;
1433e5c89e4eSSatish Balay   PetscFinalizeCalled   = PETSC_TRUE;
1434e5c89e4eSSatish Balay   PetscFunctionReturn(ierr);
1435e5c89e4eSSatish Balay }
1436e5c89e4eSSatish Balay 
143743db4dbbSBarry Smith #if defined(PETSC_MISSING_LAPACK_lsame_)
14388cc058d9SJed Brown PETSC_EXTERN int lsame_(char *a,char *b)
143943db4dbbSBarry Smith {
144043db4dbbSBarry Smith   if (*a == *b) return 1;
144143db4dbbSBarry Smith   if (*a + 32 == *b) return 1;
144243db4dbbSBarry Smith   if (*a - 32 == *b) return 1;
144343db4dbbSBarry Smith   return 0;
144443db4dbbSBarry Smith }
1445a70650f6SBarry Smith #endif
144643db4dbbSBarry Smith 
144743db4dbbSBarry Smith #if defined(PETSC_MISSING_LAPACK_lsame)
14488cc058d9SJed Brown PETSC_EXTERN int lsame(char *a,char *b)
144943db4dbbSBarry Smith {
145043db4dbbSBarry Smith   if (*a == *b) return 1;
145143db4dbbSBarry Smith   if (*a + 32 == *b) return 1;
145243db4dbbSBarry Smith   if (*a - 32 == *b) return 1;
145343db4dbbSBarry Smith   return 0;
145443db4dbbSBarry Smith }
145543db4dbbSBarry Smith #endif
1456