xref: /petsc/src/sys/objects/pinit.c (revision 3c01dfcf421c411ae9c3d0ace03ed71e0b739c3a)
17d0a6c19SBarry Smith 
2e5c89e4eSSatish Balay /*
3e5c89e4eSSatish Balay    This file defines the initialization of PETSc, including PetscInitialize()
4e5c89e4eSSatish Balay */
5afcb2eb5SJed Brown #include <petsc-private/petscimpl.h>        /*I  "petscsys.h"   I*/
6022afb99SBarry Smith #include <petscvalgrind.h>
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
18f2d66bcaSShri Abhyankar 
192d53ad75SBarry Smith #if defined(PETSC_SERIALIZE_FUNCTIONS)
202d53ad75SBarry Smith PetscFPT PetscFPTData = 0;
212d53ad75SBarry Smith #endif
222d53ad75SBarry Smith 
23a6790183SBarry Smith #if defined(PETSC_HAVE_SAWS)
2416ad0300SBarry Smith #include <petscviewersaws.h>
25a6790183SBarry Smith #endif
26e5c89e4eSSatish Balay /* -----------------------------------------------------------------------------------------*/
27e5c89e4eSSatish Balay 
28e5c89e4eSSatish Balay extern FILE *petsc_history;
29e5c89e4eSSatish Balay 
3009573ac7SBarry Smith extern PetscErrorCode PetscInitialize_DynamicLibraries(void);
3109573ac7SBarry Smith extern PetscErrorCode PetscFinalize_DynamicLibraries(void);
3237e93019SBarry Smith extern PetscErrorCode PetscFunctionListPrintAll(void);
3309573ac7SBarry Smith extern PetscErrorCode PetscSequentialPhaseBegin_Private(MPI_Comm,int);
3409573ac7SBarry Smith extern PetscErrorCode PetscSequentialPhaseEnd_Private(MPI_Comm,int);
3509573ac7SBarry Smith extern PetscErrorCode PetscCloseHistoryFile(FILE**);
360069ddf5SShri Abhyankar 
37e5c89e4eSSatish Balay /* user may set this BEFORE calling PetscInitialize() */
38e8373e55SMatthew Knepley MPI_Comm PETSC_COMM_WORLD = MPI_COMM_NULL;
39e5c89e4eSSatish Balay 
40480cf27aSJed Brown PetscMPIInt Petsc_Counter_keyval   = MPI_KEYVAL_INVALID;
41480cf27aSJed Brown PetscMPIInt Petsc_InnerComm_keyval = MPI_KEYVAL_INVALID;
42480cf27aSJed Brown PetscMPIInt Petsc_OuterComm_keyval = MPI_KEYVAL_INVALID;
43480cf27aSJed Brown 
44e5c89e4eSSatish Balay /*
45e5c89e4eSSatish Balay      Declare and set all the string names of the PETSc enums
46e5c89e4eSSatish Balay */
476a6fc655SJed Brown const char *const PetscBools[]     = {"FALSE","TRUE","PetscBool","PETSC_",0};
486a6fc655SJed Brown const char *const PetscCopyModes[] = {"COPY_VALUES","OWN_POINTER","USE_POINTER","PetscCopyMode","PETSC_",0};
496a6fc655SJed Brown const char *const PetscDataTypes[] = {"INT","DOUBLE","COMPLEX","LONG","SHORT","FLOAT",
502d53ad75SBarry Smith                                       "CHAR","LOGICAL","ENUM","BOOL","LONGDOUBLE","OBJECT","FUNCTION","PetscDataType","PETSC_",0};
51e5c89e4eSSatish Balay 
52ace3abfcSBarry Smith PetscBool PetscPreLoadingUsed = PETSC_FALSE;
53ace3abfcSBarry Smith PetscBool PetscPreLoadingOn   = PETSC_FALSE;
540f8e0872SSatish Balay 
55a2f94806SJed Brown PetscInt PetscHotRegionDepth;
56a2f94806SJed Brown 
57e5c89e4eSSatish Balay /*
58e5c89e4eSSatish Balay        Checks the options database for initializations related to the
59e5c89e4eSSatish Balay     PETSc components
60e5c89e4eSSatish Balay */
61e5c89e4eSSatish Balay #undef __FUNCT__
62e5c89e4eSSatish Balay #define __FUNCT__ "PetscOptionsCheckInitial_Components"
637087cfbeSBarry Smith PetscErrorCode  PetscOptionsCheckInitial_Components(void)
64e5c89e4eSSatish Balay {
65ace3abfcSBarry Smith   PetscBool      flg1;
66e5c89e4eSSatish Balay   PetscErrorCode ierr;
67e5c89e4eSSatish Balay 
68e5c89e4eSSatish Balay   PetscFunctionBegin;
690298fd71SBarry Smith   ierr = PetscOptionsHasName(NULL,"-help",&flg1);CHKERRQ(ierr);
70e5c89e4eSSatish Balay   if (flg1) {
71e5c89e4eSSatish Balay #if defined(PETSC_USE_LOG)
72e8e7597cSSatish Balay     MPI_Comm comm = PETSC_COMM_WORLD;
73e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm,"------Additional PETSc component options--------\n");CHKERRQ(ierr);
74e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm," -log_summary_exclude: <vec,mat,pc.ksp,snes>\n");CHKERRQ(ierr);
756cf91177SBarry Smith     ierr = (*PetscHelpPrintf)(comm," -info_exclude: <null,vec,mat,pc,ksp,snes,ts>\n");CHKERRQ(ierr);
76e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm,"-----------------------------------------------\n");CHKERRQ(ierr);
77e5c89e4eSSatish Balay #endif
78e5c89e4eSSatish Balay   }
79e5c89e4eSSatish Balay   PetscFunctionReturn(0);
80e5c89e4eSSatish Balay }
81e5c89e4eSSatish Balay 
82e5c89e4eSSatish Balay #undef __FUNCT__
83945d1669SBarry Smith #define __FUNCT__ "PetscInitializeNoPointers"
840f11a792SBarry Smith /*
85945d1669SBarry Smith       PetscInitializeNoPointers - Calls PetscInitialize() from C/C++ without the pointers to argc and args
8672a42c3cSBarry Smith 
8772a42c3cSBarry Smith    Collective
8872a42c3cSBarry Smith 
8972a42c3cSBarry Smith    Level: advanced
9072a42c3cSBarry Smith 
91945d1669SBarry Smith     Notes: this is called only by the PETSc MATLAB and Julia interface. Even though it might start MPI it sets the flag to
920f11a792SBarry Smith      indicate that it did NOT start MPI so that the PetscFinalize() does not end MPI, thus allowing PetscInitialize() to
93945d1669SBarry Smith      be called multiple times from MATLAB and Julia without the problem of trying to initialize MPI more than once.
940f11a792SBarry Smith 
951ea5a559SBarry Smith      Turns off PETSc signal handling because that can interact with MATLAB's signal handling causing random crashes.
961ea5a559SBarry Smith 
9772a42c3cSBarry Smith .seealso: PetscInitialize(), PetscInitializeFortran(), PetscInitializeNoArguments()
980f11a792SBarry Smith */
99945d1669SBarry Smith PetscErrorCode  PetscInitializeNoPointers(int argc,char **args,const char *filename,const char *help)
10072a42c3cSBarry Smith {
10172a42c3cSBarry Smith   PetscErrorCode ierr;
10272a42c3cSBarry Smith   int            myargc   = argc;
10372a42c3cSBarry Smith   char           **myargs = args;
10472a42c3cSBarry Smith 
10572a42c3cSBarry Smith   PetscFunctionBegin;
1063bf036e2SBarry Smith   ierr = PetscInitialize(&myargc,&myargs,filename,help);CHKERRQ(ierr);
1071ea5a559SBarry Smith   ierr = PetscPopSignalHandler();CHKERRQ(ierr);
108df413903SBarry Smith   PetscBeganMPI = PETSC_FALSE;
10972a42c3cSBarry Smith   PetscFunctionReturn(ierr);
11072a42c3cSBarry Smith }
11172a42c3cSBarry Smith 
11272a42c3cSBarry Smith #undef __FUNCT__
113945d1669SBarry Smith #define __FUNCT__ "PetscGetPETSC_COMM_SELF"
114f0865b08SBarry Smith /*
115945d1669SBarry Smith       Used by MATLAB and Julia interface to get communicator
116f0865b08SBarry Smith */
117945d1669SBarry Smith PetscErrorCode  PetscGetPETSC_COMM_SELF(MPI_Comm *comm)
118f0865b08SBarry Smith {
119f0865b08SBarry Smith   PetscFunctionBegin;
120f0865b08SBarry Smith   *comm = PETSC_COMM_SELF;
121f0865b08SBarry Smith   PetscFunctionReturn(0);
122f0865b08SBarry Smith }
123f0865b08SBarry Smith 
124f0865b08SBarry Smith #undef __FUNCT__
125e5c89e4eSSatish Balay #define __FUNCT__ "PetscInitializeNoArguments"
126e5c89e4eSSatish Balay /*@C
127e5c89e4eSSatish Balay       PetscInitializeNoArguments - Calls PetscInitialize() from C/C++ without
128e5c89e4eSSatish Balay         the command line arguments.
129e5c89e4eSSatish Balay 
130e5c89e4eSSatish Balay    Collective
131e5c89e4eSSatish Balay 
132e5c89e4eSSatish Balay    Level: advanced
133e5c89e4eSSatish Balay 
134e5c89e4eSSatish Balay .seealso: PetscInitialize(), PetscInitializeFortran()
135e5c89e4eSSatish Balay @*/
1367087cfbeSBarry Smith PetscErrorCode  PetscInitializeNoArguments(void)
137e5c89e4eSSatish Balay {
138e5c89e4eSSatish Balay   PetscErrorCode ierr;
139e5c89e4eSSatish Balay   int            argc   = 0;
140e5c89e4eSSatish Balay   char           **args = 0;
141e5c89e4eSSatish Balay 
142e5c89e4eSSatish Balay   PetscFunctionBegin;
1430298fd71SBarry Smith   ierr = PetscInitialize(&argc,&args,NULL,NULL);
144e5c89e4eSSatish Balay   PetscFunctionReturn(ierr);
145e5c89e4eSSatish Balay }
146e5c89e4eSSatish Balay 
147e5c89e4eSSatish Balay #undef __FUNCT__
148e5c89e4eSSatish Balay #define __FUNCT__ "PetscInitialized"
149e5c89e4eSSatish Balay /*@
150e5c89e4eSSatish Balay       PetscInitialized - Determine whether PETSc is initialized.
151e5c89e4eSSatish Balay 
15293b6d2d1SJed Brown    Level: beginner
153e5c89e4eSSatish Balay 
154e5c89e4eSSatish Balay .seealso: PetscInitialize(), PetscInitializeNoArguments(), PetscInitializeFortran()
155e5c89e4eSSatish Balay @*/
1567087cfbeSBarry Smith PetscErrorCode PetscInitialized(PetscBool  *isInitialized)
157e5c89e4eSSatish Balay {
158e5c89e4eSSatish Balay   *isInitialized = PetscInitializeCalled;
15993b6d2d1SJed Brown   return 0;
160e5c89e4eSSatish Balay }
161e5c89e4eSSatish Balay 
162e5c89e4eSSatish Balay #undef __FUNCT__
163e5c89e4eSSatish Balay #define __FUNCT__ "PetscFinalized"
164e5c89e4eSSatish Balay /*@
165e5c89e4eSSatish Balay       PetscFinalized - Determine whether PetscFinalize() has been called yet
166e5c89e4eSSatish Balay 
167e5c89e4eSSatish Balay    Level: developer
168e5c89e4eSSatish Balay 
169e5c89e4eSSatish Balay .seealso: PetscInitialize(), PetscInitializeNoArguments(), PetscInitializeFortran()
170e5c89e4eSSatish Balay @*/
1717087cfbeSBarry Smith PetscErrorCode  PetscFinalized(PetscBool  *isFinalized)
172e5c89e4eSSatish Balay {
173e5c89e4eSSatish Balay   *isFinalized = PetscFinalizeCalled;
17493b6d2d1SJed Brown   return 0;
175e5c89e4eSSatish Balay }
176e5c89e4eSSatish Balay 
17709573ac7SBarry Smith extern PetscErrorCode PetscOptionsCheckInitial_Private(void);
178e5c89e4eSSatish Balay 
179e5c89e4eSSatish Balay /*
180e5c89e4eSSatish Balay        This function is the MPI reduction operation used to compute the sum of the
181e5c89e4eSSatish Balay    first half of the datatype and the max of the second half.
182e5c89e4eSSatish Balay */
183e5c89e4eSSatish Balay MPI_Op PetscMaxSum_Op = 0;
184e5c89e4eSSatish Balay 
185e5c89e4eSSatish Balay #undef __FUNCT__
186e5c89e4eSSatish Balay #define __FUNCT__ "PetscMaxSum_Local"
1878cc058d9SJed Brown PETSC_EXTERN void MPIAPI PetscMaxSum_Local(void *in,void *out,int *cnt,MPI_Datatype *datatype)
188e5c89e4eSSatish Balay {
189e5c89e4eSSatish Balay   PetscInt *xin = (PetscInt*)in,*xout = (PetscInt*)out,i,count = *cnt;
190e5c89e4eSSatish Balay 
191e5c89e4eSSatish Balay   PetscFunctionBegin;
192e5c89e4eSSatish Balay   if (*datatype != MPIU_2INT) {
193e5c89e4eSSatish Balay     (*PetscErrorPrintf)("Can only handle MPIU_2INT data types");
194e5c89e4eSSatish Balay     MPI_Abort(MPI_COMM_WORLD,1);
195e5c89e4eSSatish Balay   }
196e5c89e4eSSatish Balay 
197e5c89e4eSSatish Balay   for (i=0; i<count; i++) {
198e5c89e4eSSatish Balay     xout[2*i]    = PetscMax(xout[2*i],xin[2*i]);
199e5c89e4eSSatish Balay     xout[2*i+1] += xin[2*i+1];
200e5c89e4eSSatish Balay   }
201812af9f3SBarry Smith   PetscFunctionReturnVoid();
202e5c89e4eSSatish Balay }
203e5c89e4eSSatish Balay 
204e5c89e4eSSatish Balay /*
205e5c89e4eSSatish Balay     Returns the max of the first entry owned by this processor and the
206e5c89e4eSSatish Balay sum of the second entry.
207b693b147SBarry Smith 
208b693b147SBarry Smith     The reason nprocs[2*i] contains lengths nprocs[2*i+1] contains flag of 1 if length is nonzero
209b693b147SBarry Smith is so that the PetscMaxSum_Op() can set TWO values, if we passed in only nprocs[i] with lengths
210b693b147SBarry Smith there would be no place to store the both needed results.
211e5c89e4eSSatish Balay */
212e5c89e4eSSatish Balay #undef __FUNCT__
213e5c89e4eSSatish Balay #define __FUNCT__ "PetscMaxSum"
21476ec1555SBarry Smith PetscErrorCode  PetscMaxSum(MPI_Comm comm,const PetscInt sizes[],PetscInt *max,PetscInt *sum)
215e5c89e4eSSatish Balay {
216e5c89e4eSSatish Balay   PetscMPIInt    size,rank;
2176ac3741eSJed Brown   struct {PetscInt max,sum;} *work;
218e5c89e4eSSatish Balay   PetscErrorCode ierr;
219e5c89e4eSSatish Balay 
220e5c89e4eSSatish Balay   PetscFunctionBegin;
221e5c89e4eSSatish Balay   ierr = MPI_Comm_size(comm,&size);CHKERRQ(ierr);
222e5c89e4eSSatish Balay   ierr = MPI_Comm_rank(comm,&rank);CHKERRQ(ierr);
223785e854fSJed Brown   ierr = PetscMalloc1(size,&work);CHKERRQ(ierr);
22476ec1555SBarry Smith   ierr = MPI_Allreduce((void*)sizes,work,size,MPIU_2INT,PetscMaxSum_Op,comm);CHKERRQ(ierr);
2256ac3741eSJed Brown   *max = work[rank].max;
2266ac3741eSJed Brown   *sum = work[rank].sum;
227e5c89e4eSSatish Balay   ierr = PetscFree(work);CHKERRQ(ierr);
228e5c89e4eSSatish Balay   PetscFunctionReturn(0);
229e5c89e4eSSatish Balay }
230e5c89e4eSSatish Balay 
231e5c89e4eSSatish Balay /* ----------------------------------------------------------------------------*/
2327087cfbeSBarry Smith MPI_Op  PetscADMax_Op = 0;
233e5c89e4eSSatish Balay 
234e5c89e4eSSatish Balay #undef __FUNCT__
235e5c89e4eSSatish Balay #define __FUNCT__ "PetscADMax_Local"
2368cc058d9SJed Brown PETSC_EXTERN void MPIAPI PetscADMax_Local(void *in,void *out,PetscMPIInt *cnt,MPI_Datatype *datatype)
237e5c89e4eSSatish Balay {
238e5c89e4eSSatish Balay   PetscScalar *xin = (PetscScalar*)in,*xout = (PetscScalar*)out;
239e5c89e4eSSatish Balay   PetscInt    i,count = *cnt;
240e5c89e4eSSatish Balay 
241e5c89e4eSSatish Balay   PetscFunctionBegin;
242e5c89e4eSSatish Balay   if (*datatype != MPIU_2SCALAR) {
243e5c89e4eSSatish Balay     (*PetscErrorPrintf)("Can only handle MPIU_2SCALAR data (i.e. double or complex) types");
244e5c89e4eSSatish Balay     MPI_Abort(MPI_COMM_WORLD,1);
245e5c89e4eSSatish Balay   }
246e5c89e4eSSatish Balay 
247e5c89e4eSSatish Balay   for (i=0; i<count; i++) {
248e5c89e4eSSatish Balay     if (PetscRealPart(xout[2*i]) < PetscRealPart(xin[2*i])) {
249e5c89e4eSSatish Balay       xout[2*i]   = xin[2*i];
250e5c89e4eSSatish Balay       xout[2*i+1] = xin[2*i+1];
251e5c89e4eSSatish Balay     }
252e5c89e4eSSatish Balay   }
253812af9f3SBarry Smith   PetscFunctionReturnVoid();
254e5c89e4eSSatish Balay }
255e5c89e4eSSatish Balay 
2567087cfbeSBarry Smith MPI_Op PetscADMin_Op = 0;
257e5c89e4eSSatish Balay 
258e5c89e4eSSatish Balay #undef __FUNCT__
259e5c89e4eSSatish Balay #define __FUNCT__ "PetscADMin_Local"
2608cc058d9SJed Brown PETSC_EXTERN void MPIAPI PetscADMin_Local(void *in,void *out,PetscMPIInt *cnt,MPI_Datatype *datatype)
261e5c89e4eSSatish Balay {
262e5c89e4eSSatish Balay   PetscScalar *xin = (PetscScalar*)in,*xout = (PetscScalar*)out;
263e5c89e4eSSatish Balay   PetscInt    i,count = *cnt;
264e5c89e4eSSatish Balay 
265e5c89e4eSSatish Balay   PetscFunctionBegin;
266e5c89e4eSSatish Balay   if (*datatype != MPIU_2SCALAR) {
267e5c89e4eSSatish Balay     (*PetscErrorPrintf)("Can only handle MPIU_2SCALAR data (i.e. double or complex) types");
268e5c89e4eSSatish Balay     MPI_Abort(MPI_COMM_WORLD,1);
269e5c89e4eSSatish Balay   }
270e5c89e4eSSatish Balay 
271e5c89e4eSSatish Balay   for (i=0; i<count; i++) {
272e5c89e4eSSatish Balay     if (PetscRealPart(xout[2*i]) > PetscRealPart(xin[2*i])) {
273e5c89e4eSSatish Balay       xout[2*i]   = xin[2*i];
274e5c89e4eSSatish Balay       xout[2*i+1] = xin[2*i+1];
275e5c89e4eSSatish Balay     }
276e5c89e4eSSatish Balay   }
277812af9f3SBarry Smith   PetscFunctionReturnVoid();
278e5c89e4eSSatish Balay }
279e5c89e4eSSatish Balay /* ---------------------------------------------------------------------------------------*/
280e5c89e4eSSatish Balay 
2817c2de775SJed Brown #if (defined(PETSC_HAVE_COMPLEX) && !defined(PETSC_HAVE_MPI_C_DOUBLE_COMPLEX)) || defined(PETSC_USE_REAL___FLOAT128)
28206a205a8SBarry Smith MPI_Op MPIU_SUM = 0;
283e5c89e4eSSatish Balay 
284e5c89e4eSSatish Balay #undef __FUNCT__
285e5c89e4eSSatish Balay #define __FUNCT__ "PetscSum_Local"
2868cc058d9SJed Brown PETSC_EXTERN void PetscSum_Local(void *in,void *out,PetscMPIInt *cnt,MPI_Datatype *datatype)
287e5c89e4eSSatish Balay {
288e5c89e4eSSatish Balay   PetscInt i,count = *cnt;
289e5c89e4eSSatish Balay 
290e5c89e4eSSatish Balay   PetscFunctionBegin;
2917c2de775SJed Brown   if (*datatype == MPIU_REAL) {
292e2e03761SBarry Smith     PetscReal *xin = (PetscReal*)in,*xout = (PetscReal*)out;
293a297a907SKarl Rupp     for (i=0; i<count; i++) xout[i] += xin[i];
2947c2de775SJed Brown   }
2957c2de775SJed Brown #if defined(PETSC_HAVE_COMPLEX)
2967c2de775SJed Brown   else if (*datatype == MPIU_COMPLEX) {
2977c2de775SJed Brown     PetscComplex *xin = (PetscComplex*)in,*xout = (PetscComplex*)out;
298a297a907SKarl Rupp     for (i=0; i<count; i++) xout[i] += xin[i];
2997c2de775SJed Brown   }
3007c2de775SJed Brown #endif
3017c2de775SJed Brown   else {
3027c2de775SJed Brown     (*PetscErrorPrintf)("Can only handle MPIU_REAL or MPIU_COMPLEX data types");
303e2e03761SBarry Smith     MPI_Abort(MPI_COMM_WORLD,1);
304e2e03761SBarry Smith   }
305812af9f3SBarry Smith   PetscFunctionReturnVoid();
306e5c89e4eSSatish Balay }
307e5c89e4eSSatish Balay #endif
308e5c89e4eSSatish Balay 
309ce63c4c1SBarry Smith #if defined(PETSC_USE_REAL___FLOAT128)
310d9822059SBarry Smith MPI_Op MPIU_MAX = 0;
311d9822059SBarry Smith MPI_Op MPIU_MIN = 0;
312d9822059SBarry Smith 
313d9822059SBarry Smith #undef __FUNCT__
314d9822059SBarry Smith #define __FUNCT__ "PetscMax_Local"
3158cc058d9SJed Brown PETSC_EXTERN void PetscMax_Local(void *in,void *out,PetscMPIInt *cnt,MPI_Datatype *datatype)
316d9822059SBarry Smith {
317d9822059SBarry Smith   PetscInt i,count = *cnt;
318d9822059SBarry Smith 
319d9822059SBarry Smith   PetscFunctionBegin;
3207c2de775SJed Brown   if (*datatype == MPIU_REAL) {
3218c764dc5SJose Roman     PetscReal *xin = (PetscReal*)in,*xout = (PetscReal*)out;
322a297a907SKarl Rupp     for (i=0; i<count; i++) xout[i] = PetscMax(xout[i],xin[i]);
3237c2de775SJed Brown   }
3247c2de775SJed Brown #if defined(PETSC_HAVE_COMPLEX)
3257c2de775SJed Brown   else if (*datatype == MPIU_COMPLEX) {
3267c2de775SJed Brown     PetscComplex *xin = (PetscComplex*)in,*xout = (PetscComplex*)out;
3277c2de775SJed Brown     for (i=0; i<count; i++) {
3287c2de775SJed Brown       xout[i] = PetscRealPartComplex(xout[i])<PetscRealPartComplex(xin[i]) ? xin[i] : xout[i];
3297c2de775SJed Brown     }
3307c2de775SJed Brown   }
3317c2de775SJed Brown #endif
3327c2de775SJed Brown   else {
3337c2de775SJed Brown     (*PetscErrorPrintf)("Can only handle MPIU_REAL or MPIU_COMPLEX data types");
3348c764dc5SJose Roman     MPI_Abort(MPI_COMM_WORLD,1);
3358c764dc5SJose Roman   }
336d9822059SBarry Smith   PetscFunctionReturnVoid();
337d9822059SBarry Smith }
338d9822059SBarry Smith 
339d9822059SBarry Smith #undef __FUNCT__
340d9822059SBarry Smith #define __FUNCT__ "PetscMin_Local"
3418cc058d9SJed Brown PETSC_EXTERN void PetscMin_Local(void *in,void *out,PetscMPIInt *cnt,MPI_Datatype *datatype)
342d9822059SBarry Smith {
343d9822059SBarry Smith   PetscInt    i,count = *cnt;
344d9822059SBarry Smith 
345d9822059SBarry Smith   PetscFunctionBegin;
3467c2de775SJed Brown   if (*datatype == MPIU_REAL) {
3478c764dc5SJose Roman     PetscReal *xin = (PetscReal*)in,*xout = (PetscReal*)out;
348a297a907SKarl Rupp     for (i=0; i<count; i++) xout[i] = PetscMin(xout[i],xin[i]);
3497c2de775SJed Brown   }
3507c2de775SJed Brown #if defined(PETSC_HAVE_COMPLEX)
3517c2de775SJed Brown   else if (*datatype == MPIU_COMPLEX) {
3527c2de775SJed Brown     PetscComplex *xin = (PetscComplex*)in,*xout = (PetscComplex*)out;
3537c2de775SJed Brown     for (i=0; i<count; i++) {
3547c2de775SJed Brown       xout[i] = PetscRealPartComplex(xout[i])>PetscRealPartComplex(xin[i]) ? xin[i] : xout[i];
3557c2de775SJed Brown     }
3567c2de775SJed Brown   }
3577c2de775SJed Brown #endif
3587c2de775SJed Brown   else {
3598c764dc5SJose Roman     (*PetscErrorPrintf)("Can only handle MPIU_REAL or MPIU_SCALAR data (i.e. double or complex) types");
3608c764dc5SJose Roman     MPI_Abort(MPI_COMM_WORLD,1);
3618c764dc5SJose Roman   }
362d9822059SBarry Smith   PetscFunctionReturnVoid();
363d9822059SBarry Smith }
364d9822059SBarry Smith #endif
365d9822059SBarry Smith 
366480cf27aSJed Brown #undef __FUNCT__
367480cf27aSJed Brown #define __FUNCT__ "Petsc_DelCounter"
368480cf27aSJed Brown /*
369480cf27aSJed Brown    Private routine to delete internal tag/name counter storage when a communicator is freed.
370480cf27aSJed Brown 
371ff0e51ddSBarry 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.
372480cf27aSJed Brown 
373480cf27aSJed Brown    Note: this is declared extern "C" because it is passed to MPI_Keyval_create()
374480cf27aSJed Brown 
375480cf27aSJed Brown */
3768cc058d9SJed Brown PETSC_EXTERN PetscMPIInt MPIAPI Petsc_DelCounter(MPI_Comm comm,PetscMPIInt keyval,void *count_val,void *extra_state)
377480cf27aSJed Brown {
378480cf27aSJed Brown   PetscErrorCode ierr;
379480cf27aSJed Brown 
380480cf27aSJed Brown   PetscFunctionBegin;
381480cf27aSJed Brown   ierr = PetscInfo1(0,"Deleting counter data in an MPI_Comm %ld\n",(long)comm);if (ierr) PetscFunctionReturn((PetscMPIInt)ierr);
382480cf27aSJed Brown   ierr = PetscFree(count_val);if (ierr) PetscFunctionReturn((PetscMPIInt)ierr);
383480cf27aSJed Brown   PetscFunctionReturn(MPI_SUCCESS);
384480cf27aSJed Brown }
385480cf27aSJed Brown 
386480cf27aSJed Brown #undef __FUNCT__
387da3039f7SJed Brown #define __FUNCT__ "Petsc_DelComm_Outer"
388480cf27aSJed Brown /*
389da3039f7SJed Brown   This is invoked on the outer comm as a result of either PetscCommDestroy() (via MPI_Attr_delete) or when the user
390da3039f7SJed Brown   calls MPI_Comm_free().
391da3039f7SJed Brown 
392da3039f7SJed Brown   This is the only entry point for breaking the links between inner and outer comms.
393480cf27aSJed Brown 
394ff0e51ddSBarry Smith   This is called by MPI, not by users. This is called when MPI_Comm_free() is called on the communicator.
395480cf27aSJed Brown 
396480cf27aSJed Brown   Note: this is declared extern "C" because it is passed to MPI_Keyval_create()
397480cf27aSJed Brown 
398480cf27aSJed Brown */
399da3039f7SJed Brown PETSC_EXTERN PetscMPIInt MPIAPI Petsc_DelComm_Outer(MPI_Comm comm,PetscMPIInt keyval,void *attr_val,void *extra_state)
400480cf27aSJed Brown {
401480cf27aSJed Brown   PetscErrorCode ierr;
402b89831e5SBarry Smith   PetscMPIInt    flg;
403265f3f35SJed Brown   union {MPI_Comm comm; void *ptr;} icomm,ocomm;
404480cf27aSJed Brown 
405480cf27aSJed Brown   PetscFunctionBegin;
406da3039f7SJed Brown   if (keyval != Petsc_InnerComm_keyval) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_CORRUPT,"Unexpected keyval");
407ec4fadc2SJed Brown   icomm.ptr = attr_val;
408da3039f7SJed Brown 
409265f3f35SJed Brown   ierr = MPI_Attr_get(icomm.comm,Petsc_OuterComm_keyval,&ocomm,&flg);CHKERRQ(ierr);
410b3ef52cdSBarry Smith   if (!flg) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_CORRUPT,"Inner MPI_Comm does not have expected reference to outer comm");
411da3039f7SJed Brown   if (ocomm.comm != comm) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_CORRUPT,"Inner MPI_Comm has reference to non-matching outer comm");
412da3039f7SJed Brown   ierr = MPI_Attr_delete(icomm.comm,Petsc_OuterComm_keyval);CHKERRQ(ierr); /* Calls Petsc_DelComm_Inner */
413da3039f7SJed 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);
414da3039f7SJed Brown   PetscFunctionReturn(MPI_SUCCESS);
415b89831e5SBarry Smith }
416da3039f7SJed Brown 
417da3039f7SJed Brown #undef __FUNCT__
418da3039f7SJed Brown #define __FUNCT__ "Petsc_DelComm_Inner"
419da3039f7SJed Brown /*
420da3039f7SJed Brown  * This is invoked on the inner comm when Petsc_DelComm_Outer calls MPI_Attr_delete.  It should not be reached any other way.
421da3039f7SJed Brown  */
422da3039f7SJed Brown PETSC_EXTERN PetscMPIInt MPIAPI Petsc_DelComm_Inner(MPI_Comm comm,PetscMPIInt keyval,void *attr_val,void *extra_state)
423da3039f7SJed Brown {
424da3039f7SJed Brown   PetscErrorCode ierr;
425da3039f7SJed Brown 
426da3039f7SJed Brown   PetscFunctionBegin;
427da3039f7SJed Brown   ierr = PetscInfo1(0,"Removing reference to PETSc communicator embedded in a user MPI_Comm %ld\n",(long)comm);if (ierr) PetscFunctionReturn((PetscMPIInt)ierr);
428480cf27aSJed Brown   PetscFunctionReturn(MPI_SUCCESS);
429480cf27aSJed Brown }
430480cf27aSJed Brown 
431951e3c8eSBarry Smith #if defined(PETSC_USE_PETSC_MPI_EXTERNAL32)
432e39fd77fSBarry Smith #if !defined(PETSC_WORDS_BIGENDIAN)
4338cc058d9SJed Brown PETSC_EXTERN PetscMPIInt PetscDataRep_extent_fn(MPI_Datatype,MPI_Aint*,void*);
4348cc058d9SJed Brown PETSC_EXTERN PetscMPIInt PetscDataRep_read_conv_fn(void*, MPI_Datatype,PetscMPIInt,void*,MPI_Offset,void*);
4358cc058d9SJed Brown PETSC_EXTERN PetscMPIInt PetscDataRep_write_conv_fn(void*, MPI_Datatype,PetscMPIInt,void*,MPI_Offset,void*);
436e39fd77fSBarry Smith #endif
437951e3c8eSBarry Smith #endif
438e39fd77fSBarry Smith 
4396ae9a8a6SBarry Smith int  PetscGlobalArgc   = 0;
4406ae9a8a6SBarry Smith char **PetscGlobalArgs = 0;
441dff31646SBarry Smith PetscSegBuffer PetscCitationsList;
442e5c89e4eSSatish Balay 
443e5c89e4eSSatish Balay #undef __FUNCT__
444051e4cf2SJed Brown #define __FUNCT__ "PetscCitationsInitialize"
445051e4cf2SJed Brown PetscErrorCode PetscCitationsInitialize()
446051e4cf2SJed Brown {
447051e4cf2SJed Brown   PetscErrorCode ierr;
448051e4cf2SJed Brown 
449051e4cf2SJed Brown   PetscFunctionBegin;
450051e4cf2SJed Brown   ierr = PetscSegBufferCreate(1,10000,&PetscCitationsList);CHKERRQ(ierr);
451fa9c09a1SSatish Balay   ierr = PetscCitationsRegister("@TechReport{petsc-user-ref,\n  Author = {Satish Balay and Shrirang Abhyankar and Mark F. Adams and Jed Brown and Peter Brune\n            and Kris Buschelman and Victor Eijkhout and William D. Gropp\n            and Dinesh Kaushik and Matthew G. Knepley\n            and Lois Curfman McInnes and Karl Rupp and Barry F. Smith\n            and Hong Zhang},\n  Title = {{PETS}c Users Manual},\n  Number = {ANL-95/11 - Revision 3.5},\n  Institution = {Argonne National Laboratory},\n  Year = {2014}\n}\n",NULL);CHKERRQ(ierr);
452051e4cf2SJed 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);
453051e4cf2SJed Brown   PetscFunctionReturn(0);
454051e4cf2SJed Brown }
455e5c89e4eSSatish Balay 
456e5c89e4eSSatish Balay #undef __FUNCT__
457e5c89e4eSSatish Balay #define __FUNCT__ "PetscGetArgs"
458e5c89e4eSSatish Balay /*@C
459e5c89e4eSSatish Balay    PetscGetArgs - Allows you to access the raw command line arguments anywhere
460e5c89e4eSSatish Balay      after PetscInitialize() is called but before PetscFinalize().
461e5c89e4eSSatish Balay 
462e5c89e4eSSatish Balay    Not Collective
463e5c89e4eSSatish Balay 
464e5c89e4eSSatish Balay    Output Parameters:
465e5c89e4eSSatish Balay +  argc - count of number of command line arguments
466e5c89e4eSSatish Balay -  args - the command line arguments
467e5c89e4eSSatish Balay 
468e5c89e4eSSatish Balay    Level: intermediate
469e5c89e4eSSatish Balay 
470e5c89e4eSSatish Balay    Notes:
471e5c89e4eSSatish Balay       This is usually used to pass the command line arguments into other libraries
472e5c89e4eSSatish Balay    that are called internally deep in PETSc or the application.
473e5c89e4eSSatish Balay 
474f177e3b1SBarry Smith       The first argument contains the program name as is normal for C arguments.
475f177e3b1SBarry Smith 
476e5c89e4eSSatish Balay    Concepts: command line arguments
477e5c89e4eSSatish Balay 
478793721a6SBarry Smith .seealso: PetscFinalize(), PetscInitializeFortran(), PetscGetArguments()
479e5c89e4eSSatish Balay 
480e5c89e4eSSatish Balay @*/
4817087cfbeSBarry Smith PetscErrorCode  PetscGetArgs(int *argc,char ***args)
482e5c89e4eSSatish Balay {
483e5c89e4eSSatish Balay   PetscFunctionBegin;
48417186662SBarry Smith   if (!PetscInitializeCalled && PetscFinalizeCalled) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ORDER,"You must call after PetscInitialize() but before PetscFinalize()");
485e5c89e4eSSatish Balay   *argc = PetscGlobalArgc;
486e5c89e4eSSatish Balay   *args = PetscGlobalArgs;
487e5c89e4eSSatish Balay   PetscFunctionReturn(0);
488e5c89e4eSSatish Balay }
489e5c89e4eSSatish Balay 
490e5c89e4eSSatish Balay #undef __FUNCT__
491793721a6SBarry Smith #define __FUNCT__ "PetscGetArguments"
492793721a6SBarry Smith /*@C
493793721a6SBarry Smith    PetscGetArguments - Allows you to access the  command line arguments anywhere
494793721a6SBarry Smith      after PetscInitialize() is called but before PetscFinalize().
495793721a6SBarry Smith 
496793721a6SBarry Smith    Not Collective
497793721a6SBarry Smith 
498793721a6SBarry Smith    Output Parameters:
499793721a6SBarry Smith .  args - the command line arguments
500793721a6SBarry Smith 
501793721a6SBarry Smith    Level: intermediate
502793721a6SBarry Smith 
503793721a6SBarry Smith    Notes:
504793721a6SBarry Smith       This does NOT start with the program name and IS null terminated (final arg is void)
505793721a6SBarry Smith 
506793721a6SBarry Smith    Concepts: command line arguments
507793721a6SBarry Smith 
508793721a6SBarry Smith .seealso: PetscFinalize(), PetscInitializeFortran(), PetscGetArgs(), PetscFreeArguments()
509793721a6SBarry Smith 
510793721a6SBarry Smith @*/
5117087cfbeSBarry Smith PetscErrorCode  PetscGetArguments(char ***args)
512793721a6SBarry Smith {
513793721a6SBarry Smith   PetscInt       i,argc = PetscGlobalArgc;
514793721a6SBarry Smith   PetscErrorCode ierr;
515793721a6SBarry Smith 
516793721a6SBarry Smith   PetscFunctionBegin;
51717186662SBarry Smith   if (!PetscInitializeCalled && PetscFinalizeCalled) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ORDER,"You must call after PetscInitialize() but before PetscFinalize()");
518717030eeSLisandro Dalcin   if (!argc) {*args = 0; PetscFunctionReturn(0);}
519785e854fSJed Brown   ierr = PetscMalloc1(argc,args);CHKERRQ(ierr);
520793721a6SBarry Smith   for (i=0; i<argc-1; i++) {
521793721a6SBarry Smith     ierr = PetscStrallocpy(PetscGlobalArgs[i+1],&(*args)[i]);CHKERRQ(ierr);
522793721a6SBarry Smith   }
523793721a6SBarry Smith   (*args)[argc-1] = 0;
524793721a6SBarry Smith   PetscFunctionReturn(0);
525793721a6SBarry Smith }
526793721a6SBarry Smith 
527793721a6SBarry Smith #undef __FUNCT__
528793721a6SBarry Smith #define __FUNCT__ "PetscFreeArguments"
529793721a6SBarry Smith /*@C
530793721a6SBarry Smith    PetscFreeArguments - Frees the memory obtained with PetscGetArguments()
531793721a6SBarry Smith 
532793721a6SBarry Smith    Not Collective
533793721a6SBarry Smith 
534793721a6SBarry Smith    Output Parameters:
535793721a6SBarry Smith .  args - the command line arguments
536793721a6SBarry Smith 
537793721a6SBarry Smith    Level: intermediate
538793721a6SBarry Smith 
539793721a6SBarry Smith    Concepts: command line arguments
540793721a6SBarry Smith 
541793721a6SBarry Smith .seealso: PetscFinalize(), PetscInitializeFortran(), PetscGetArgs(), PetscGetArguments()
542793721a6SBarry Smith 
543793721a6SBarry Smith @*/
5447087cfbeSBarry Smith PetscErrorCode  PetscFreeArguments(char **args)
545793721a6SBarry Smith {
546793721a6SBarry Smith   PetscInt       i = 0;
547793721a6SBarry Smith   PetscErrorCode ierr;
548793721a6SBarry Smith 
549793721a6SBarry Smith   PetscFunctionBegin;
550a297a907SKarl Rupp   if (!args) PetscFunctionReturn(0);
551793721a6SBarry Smith   while (args[i]) {
552793721a6SBarry Smith     ierr = PetscFree(args[i]);CHKERRQ(ierr);
553793721a6SBarry Smith     i++;
554793721a6SBarry Smith   }
555793721a6SBarry Smith   ierr = PetscFree(args);CHKERRQ(ierr);
556793721a6SBarry Smith   PetscFunctionReturn(0);
557793721a6SBarry Smith }
558793721a6SBarry Smith 
55911525c0dSBarry Smith #if defined(PETSC_HAVE_SAWS)
56030befbd2SBarry Smith #include <petscconfiginfo.h>
56130befbd2SBarry Smith 
56211525c0dSBarry Smith #undef __FUNCT__
56311525c0dSBarry Smith #define __FUNCT__ "PetscInitializeSAWs"
56411525c0dSBarry Smith PetscErrorCode  PetscInitializeSAWs(const char help[])
56511525c0dSBarry Smith {
56611525c0dSBarry Smith   if (!PetscGlobalRank) {
56730befbd2SBarry Smith     char           cert[PETSC_MAX_PATH_LEN],root[PETSC_MAX_PATH_LEN],*intro,programname[64],*appline,*options,version[64];
56811525c0dSBarry Smith     int            port;
56911525c0dSBarry Smith     PetscBool      flg,rootlocal = PETSC_FALSE,flg2;
57011525c0dSBarry Smith     size_t         applinelen,introlen;
57111525c0dSBarry Smith     PetscErrorCode ierr;
5727325c4a4SBarry Smith     char           sawsurl[256];
57311525c0dSBarry Smith 
57411525c0dSBarry Smith     ierr = PetscOptionsHasName(NULL,"-saws_log",&flg);CHKERRQ(ierr);
57511525c0dSBarry Smith     if (flg) {
57611525c0dSBarry Smith       char  sawslog[PETSC_MAX_PATH_LEN];
57711525c0dSBarry Smith 
57811525c0dSBarry Smith       ierr = PetscOptionsGetString(NULL,"-saws_log",sawslog,PETSC_MAX_PATH_LEN,NULL);CHKERRQ(ierr);
57911525c0dSBarry Smith       if (sawslog[0]) {
58011525c0dSBarry Smith         PetscStackCallSAWs(SAWs_Set_Use_Logfile,(sawslog));
58111525c0dSBarry Smith       } else {
58211525c0dSBarry Smith         PetscStackCallSAWs(SAWs_Set_Use_Logfile,(NULL));
58311525c0dSBarry Smith       }
58411525c0dSBarry Smith     }
58511525c0dSBarry Smith     ierr = PetscOptionsGetString(NULL,"-saws_https",cert,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr);
58611525c0dSBarry Smith     if (flg) {
58711525c0dSBarry Smith       PetscStackCallSAWs(SAWs_Set_Use_HTTPS,(cert));
58811525c0dSBarry Smith     }
58911525c0dSBarry Smith     ierr = PetscOptionsGetInt(NULL,"-saws_port",&port,&flg);CHKERRQ(ierr);
59011525c0dSBarry Smith     if (flg) {
59111525c0dSBarry Smith       PetscStackCallSAWs(SAWs_Set_Port,(port));
59211525c0dSBarry Smith     }
59311525c0dSBarry Smith     ierr = PetscOptionsGetString(NULL,"-saws_root",root,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr);
59411525c0dSBarry Smith     if (flg) {
59511525c0dSBarry Smith       PetscStackCallSAWs(SAWs_Set_Document_Root,(root));CHKERRQ(ierr);
59611525c0dSBarry Smith       ierr = PetscStrcmp(root,".",&rootlocal);CHKERRQ(ierr);
5979c1e0ce8SBarry Smith     } else {
5989c1e0ce8SBarry Smith       ierr = PetscOptionsHasName(NULL,"-saws_options",&flg);CHKERRQ(ierr);
5999c1e0ce8SBarry Smith       if (flg) {
600*3c01dfcfSBarry Smith         ierr = PetscStrreplace(PETSC_COMM_WORLD,"${PETSC_DIR}/share/petsc/saws",root,PETSC_MAX_PATH_LEN);CHKERRQ(ierr);
6019c1e0ce8SBarry Smith         PetscStackCallSAWs(SAWs_Set_Document_Root,(root));CHKERRQ(ierr);
6029c1e0ce8SBarry Smith       }
60311525c0dSBarry Smith     }
60411525c0dSBarry Smith     ierr = PetscOptionsHasName(NULL,"-saws_local",&flg2);CHKERRQ(ierr);
60511525c0dSBarry Smith     if (flg2) {
60611525c0dSBarry Smith       char jsdir[PETSC_MAX_PATH_LEN];
60711525c0dSBarry Smith       if (!flg) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SUP,"-saws_local option requires -saws_root option");
60811525c0dSBarry Smith       ierr = PetscSNPrintf(jsdir,PETSC_MAX_PATH_LEN,"%s/js",root);CHKERRQ(ierr);
60911525c0dSBarry Smith       ierr = PetscTestDirectory(jsdir,'r',&flg);CHKERRQ(ierr);
61011525c0dSBarry Smith       if (!flg) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_FILE_READ,"-saws_local option requires js directory in root directory");
61143da4ab2SBarry Smith       PetscStackCallSAWs(SAWs_Push_Local_Header,());CHKERRQ(ierr);
61211525c0dSBarry Smith     }
61311525c0dSBarry Smith     ierr = PetscGetProgramName(programname,64);CHKERRQ(ierr);
61411525c0dSBarry Smith     ierr = PetscStrlen(help,&applinelen);CHKERRQ(ierr);
61511525c0dSBarry Smith     introlen   = 4096 + applinelen;
61630a8c9c0SSurtai Han     applinelen += 1024;
61711525c0dSBarry Smith     ierr = PetscMalloc(applinelen,&appline);CHKERRQ(ierr);
61811525c0dSBarry Smith     ierr = PetscMalloc(introlen,&intro);CHKERRQ(ierr);
61911525c0dSBarry Smith 
62011525c0dSBarry Smith     if (rootlocal) {
62111525c0dSBarry Smith       ierr = PetscSNPrintf(appline,applinelen,"%s.c.html",programname);CHKERRQ(ierr);
62211525c0dSBarry Smith       ierr = PetscTestFile(appline,'r',&rootlocal);CHKERRQ(ierr);
62311525c0dSBarry Smith     }
62430befbd2SBarry Smith     ierr = PetscOptionsGetAll(&options);CHKERRQ(ierr);
62511525c0dSBarry Smith     if (rootlocal && help) {
62630befbd2SBarry Smith       ierr = PetscSNPrintf(appline,applinelen,"<center> Running <a href=\"%s.c.html\">%s</a> %s</center><br><center><pre>%s</pre></center><br>\n",programname,programname,options,help);
62711525c0dSBarry Smith     } else if (help) {
62830a8c9c0SSurtai Han       ierr = PetscSNPrintf(appline,applinelen,"<center>Running %s %s</center><br><center><pre>%s</pre></center><br>",programname,options,help);
62911525c0dSBarry Smith     } else {
63030befbd2SBarry Smith       ierr = PetscSNPrintf(appline,applinelen,"<center> Running %s %s</center><br>\n",programname,options);
63111525c0dSBarry Smith     }
632b0bb5815SBarry Smith     ierr = PetscFree(options);CHKERRQ(ierr);
63330befbd2SBarry Smith     ierr = PetscGetVersion(version,sizeof(version));CHKERRQ(ierr);
63411525c0dSBarry Smith     ierr = PetscSNPrintf(intro,introlen,"<body>\n"
63511525c0dSBarry 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"
636df62c222SBarry Smith                                     "<center>This is the default PETSc application dashboard, from it you can access any published PETSc objects or logging data</center><br><center>%s configured with %s</center><br>\n"
637df62c222SBarry Smith                                     "%s",version,petscconfigureoptions,appline);
63843da4ab2SBarry Smith     PetscStackCallSAWs(SAWs_Push_Body,("index.html",0,intro));
63911525c0dSBarry Smith     ierr = PetscFree(intro);CHKERRQ(ierr);
64011525c0dSBarry Smith     ierr = PetscFree(appline);CHKERRQ(ierr);
64111525c0dSBarry Smith     PetscStackCallSAWs(SAWs_Initialize,());
6427325c4a4SBarry Smith     PetscStackCallSAWs(SAWs_Get_FullURL,(sizeof(sawsurl),sawsurl));
6437325c4a4SBarry Smith     ierr = PetscPrintf(PETSC_COMM_WORLD,"Point your browser to %s for SAWs\n",sawsurl);CHKERRQ(ierr);
6440af79b04SBarry Smith     ierr = PetscCitationsRegister("@TechReport{ saws,\n"
6450af79b04SBarry Smith                                   "  Author = {Matt Otten and Jed Brown and Barry Smith},\n"
6460af79b04SBarry Smith                                   "  Title  = {Scientific Application Web Server (SAWs) Users Manual},\n"
6470af79b04SBarry Smith                                   "  Institution = {Argonne National Laboratory},\n"
6480af79b04SBarry Smith                                   "  Year   = 2013\n}\n",NULL);CHKERRQ(ierr);
64911525c0dSBarry Smith   }
65011525c0dSBarry Smith   PetscFunctionReturn(0);
65111525c0dSBarry Smith }
65211525c0dSBarry Smith #endif
65311525c0dSBarry Smith 
654793721a6SBarry Smith #undef __FUNCT__
655e5c89e4eSSatish Balay #define __FUNCT__ "PetscInitialize"
656e5c89e4eSSatish Balay /*@C
657e5c89e4eSSatish Balay    PetscInitialize - Initializes the PETSc database and MPI.
658e5c89e4eSSatish Balay    PetscInitialize() calls MPI_Init() if that has yet to be called,
659e5c89e4eSSatish Balay    so this routine should always be called near the beginning of
660e5c89e4eSSatish Balay    your program -- usually the very first line!
661e5c89e4eSSatish Balay 
662e5c89e4eSSatish Balay    Collective on MPI_COMM_WORLD or PETSC_COMM_WORLD if it has been set
663e5c89e4eSSatish Balay 
664e5c89e4eSSatish Balay    Input Parameters:
665e5c89e4eSSatish Balay +  argc - count of number of command line arguments
666e5c89e4eSSatish Balay .  args - the command line arguments
6670298fd71SBarry Smith .  file - [optional] PETSc database file, also checks ~username/.petscrc and .petscrc use NULL to not check for
668fc2bca9aSBarry Smith           code specific file. Use -skip_petscrc in the code specific file to skip the .petscrc files
6690298fd71SBarry Smith -  help - [optional] Help message to print, use NULL for no message
670e5c89e4eSSatish Balay 
67105827820SBarry Smith    If you wish PETSc code to run ONLY on a subcommunicator of MPI_COMM_WORLD, create that
67205827820SBarry Smith    communicator first and assign it to PETSC_COMM_WORLD BEFORE calling PetscInitialize(). Thus if you are running a
67305827820SBarry Smith    four process job and two processes will run PETSc and have PetscInitialize() and PetscFinalize() and two process will not,
67405827820SBarry Smith    then do this. If ALL processes in the job are using PetscInitialize() and PetscFinalize() then you don't need to do this, even
67505827820SBarry Smith    if different subcommunicators of the job are doing different things with PETSc.
676e5c89e4eSSatish Balay 
677e5c89e4eSSatish Balay    Options Database Keys:
678e5c89e4eSSatish Balay +  -start_in_debugger [noxterm,dbx,xdb,gdb,...] - Starts program in debugger
679e5c89e4eSSatish Balay .  -on_error_attach_debugger [noxterm,dbx,xdb,gdb,...] - Starts debugger when error detected
680e5c89e4eSSatish Balay .  -on_error_emacs <machinename> causes emacsclient to jump to error file
681b52f573bSBarry Smith .  -on_error_abort calls abort() when error detected (no traceback)
682e8fb0fc0SBarry Smith .  -on_error_mpiabort calls MPI_abort() when error detected
683e8fb0fc0SBarry Smith .  -error_output_stderr prints error messages to stderr instead of the default stdout
684e8fb0fc0SBarry Smith .  -error_output_none does not print the error messages (but handles errors in the same way as if this was not called)
685e5c89e4eSSatish Balay .  -debugger_nodes [node1,node2,...] - Indicates nodes to start in debugger
686e5c89e4eSSatish Balay .  -debugger_pause [sleeptime] (in seconds) - Pauses debugger
687e5c89e4eSSatish Balay .  -stop_for_debugger - Print message on how to attach debugger manually to
688e5c89e4eSSatish Balay                         process and wait (-debugger_pause) seconds for attachment
6892fb0ec9aSBarry Smith .  -malloc - Indicates use of PETSc error-checking malloc (on by default for debug version of libraries)
690e5c89e4eSSatish Balay .  -malloc no - Indicates not to use error-checking malloc
6912fb0ec9aSBarry Smith .  -malloc_debug - check for memory corruption at EVERY malloc or free
692aee23540SBarry Smith .  -malloc_dump - prints a list of all unfreed memory at the end of the run
693dc92acbaSJed Brown .  -malloc_test - like -malloc_dump -malloc_debug, but only active for debugging builds
694e5c89e4eSSatish Balay .  -fp_trap - Stops on floating point exceptions (Note that on the
695e5c89e4eSSatish Balay               IBM RS6000 this slows code by at least a factor of 10.)
696e5c89e4eSSatish Balay .  -no_signal_handler - Indicates not to trap error signals
697e5c89e4eSSatish Balay .  -shared_tmp - indicates /tmp directory is shared by all processors
698e5c89e4eSSatish Balay .  -not_shared_tmp - each processor has own /tmp
699e5c89e4eSSatish Balay .  -tmp - alternative name of /tmp directory
700e5c89e4eSSatish Balay .  -get_total_flops - returns total flops done by all processors
701142c234bSBarry Smith -  -memory_info - Print memory usage at end of run
702e5c89e4eSSatish Balay 
703e5c89e4eSSatish Balay    Options Database Keys for Profiling:
704a7f22e61SSatish Balay    See Users-Manual: ch_profiling for details.
705495fc317SBarry Smith +  -info <optional filename> - Prints verbose information to the screen
706495fc317SBarry Smith .  -info_exclude <null,vec,mat,pc,ksp,snes,ts> - Excludes some of the verbose messages
707495fc317SBarry Smith .  -log_sync - Log the synchronization in scatters, inner products and norms
708495fc317SBarry Smith .  -log_trace [filename] - Print traces of all PETSc calls to the screen (useful to determine where a program
709e5c89e4eSSatish Balay         hangs without running in the debugger).  See PetscLogTraceBegin().
710495fc317SBarry Smith .  -log_summary [filename] - Prints summary of flop and timing information to screen. If the filename is specified the
711495fc317SBarry Smith         summary is written to the file.  See PetscLogView().
712495fc317SBarry Smith .  -log_all [filename] - Logs extensive profiling information  See PetscLogDump().
713495fc317SBarry Smith .  -log [filename] - Logs basic profiline information  See PetscLogDump().
714495fc317SBarry Smith -  -log_mpe [filename] - Creates a logfile viewable by the utility Jumpshot (in MPICH distribution)
715495fc317SBarry Smith 
716495fc317SBarry Smith     Only one of -log_trace, -log_summary, -log_all, -log, or -log_mpe may be used at a time
717e5c89e4eSSatish Balay 
718e5c89e4eSSatish Balay    Environmental Variables:
719e5c89e4eSSatish Balay +   PETSC_TMP - alternative tmp directory
720e5c89e4eSSatish Balay .   PETSC_SHARED_TMP - tmp is shared by all processes
721e5c89e4eSSatish Balay .   PETSC_NOT_SHARED_TMP - each process has its own private tmp
722e5c89e4eSSatish Balay .   PETSC_VIEWER_SOCKET_PORT - socket number to use for socket viewer
723e5c89e4eSSatish Balay -   PETSC_VIEWER_SOCKET_MACHINE - machine to use for socket viewer to connect to
724e5c89e4eSSatish Balay 
725e5c89e4eSSatish Balay 
726e5c89e4eSSatish Balay    Level: beginner
727e5c89e4eSSatish Balay 
728e5c89e4eSSatish Balay    Notes:
729e5c89e4eSSatish Balay    If for some reason you must call MPI_Init() separately, call
730e5c89e4eSSatish Balay    it before PetscInitialize().
731e5c89e4eSSatish Balay 
732e5c89e4eSSatish Balay    Fortran Version:
733e5c89e4eSSatish Balay    In Fortran this routine has the format
734e5c89e4eSSatish Balay $       call PetscInitialize(file,ierr)
735e5c89e4eSSatish Balay 
736e5c89e4eSSatish Balay +   ierr - error return code
7370298fd71SBarry Smith -  file - [optional] PETSc database file, also checks ~username/.petscrc and .petscrc use NULL_CHARACTER to not check for
738fc2bca9aSBarry Smith           code specific file. Use -skip_petscrc in the code specific file to skip the .petscrc files
739e5c89e4eSSatish Balay 
740e5c89e4eSSatish Balay    Important Fortran Note:
7410298fd71SBarry Smith    In Fortran, you MUST use NULL_CHARACTER to indicate a
7420298fd71SBarry Smith    null character string; you CANNOT just use NULL as
743a7f22e61SSatish Balay    in the C version. See Users-Manual: ch_fortran for details.
744e5c89e4eSSatish Balay 
74501cb0274SBarry Smith    If your main program is C but you call Fortran code that also uses PETSc you need to call PetscInitializeFortran() soon after
74601cb0274SBarry Smith    calling PetscInitialize().
747e5c89e4eSSatish Balay 
748e5c89e4eSSatish Balay    Concepts: initializing PETSc
749e5c89e4eSSatish Balay 
75001cb0274SBarry Smith .seealso: PetscFinalize(), PetscInitializeFortran(), PetscGetArgs(), PetscInitializeNoArguments()
751e5c89e4eSSatish Balay 
752e5c89e4eSSatish Balay @*/
7537087cfbeSBarry Smith PetscErrorCode  PetscInitialize(int *argc,char ***args,const char file[],const char help[])
754e5c89e4eSSatish Balay {
755e5c89e4eSSatish Balay   PetscErrorCode ierr;
7564bb5149bSJed Brown   PetscMPIInt    flag, size;
757ace3abfcSBarry Smith   PetscBool      flg;
758e5c89e4eSSatish Balay   char           hostname[256];
759e5c89e4eSSatish Balay 
760e5c89e4eSSatish Balay   PetscFunctionBegin;
761e5c89e4eSSatish Balay   if (PetscInitializeCalled) PetscFunctionReturn(0);
762e5c89e4eSSatish Balay 
763ae9b4142SLisandro Dalcin   /* these must be initialized in a routine, not as a constant declaration*/
764d89683f4Sbcordonn   PETSC_STDOUT = stdout;
765ae9b4142SLisandro Dalcin   PETSC_STDERR = stderr;
766e5c89e4eSSatish Balay 
7670c30907bSSatish Balay   /* on Windows - set printf to default to printing 2 digit exponents */
7680c30907bSSatish Balay #if defined(PETSC_HAVE__SET_OUTPUT_FORMAT)
7690c30907bSSatish Balay   _set_output_format(_TWO_DIGIT_EXPONENT);
7700c30907bSSatish Balay #endif
7710c30907bSSatish Balay 
772e5c89e4eSSatish Balay   ierr = PetscOptionsCreate();CHKERRQ(ierr);
773e5c89e4eSSatish Balay 
774e5c89e4eSSatish Balay   /*
775e5c89e4eSSatish Balay      We initialize the program name here (before MPI_Init()) because MPICH has a bug in
776e5c89e4eSSatish Balay      it that it sets args[0] on all processors to be args[0] on the first processor.
777e5c89e4eSSatish Balay   */
778e5c89e4eSSatish Balay   if (argc && *argc) {
779e5c89e4eSSatish Balay     ierr = PetscSetProgramName(**args);CHKERRQ(ierr);
780e5c89e4eSSatish Balay   } else {
781e5c89e4eSSatish Balay     ierr = PetscSetProgramName("Unknown Name");CHKERRQ(ierr);
782e5c89e4eSSatish Balay   }
783e5c89e4eSSatish Balay 
784e5c89e4eSSatish Balay   ierr = MPI_Initialized(&flag);CHKERRQ(ierr);
785e5c89e4eSSatish Balay   if (!flag) {
786e32f2f54SBarry 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");
7875e765c61SJed Brown #if defined(PETSC_HAVE_MPI_INIT_THREAD)
7885e765c61SJed Brown     {
7895e765c61SJed Brown       PetscMPIInt provided;
7905e765c61SJed Brown       ierr = MPI_Init_thread(argc,args,MPI_THREAD_FUNNELED,&provided);CHKERRQ(ierr);
7915e765c61SJed Brown     }
7925e765c61SJed Brown #else
793e5c89e4eSSatish Balay     ierr = MPI_Init(argc,args);CHKERRQ(ierr);
7945e765c61SJed Brown #endif
795e5c89e4eSSatish Balay     PetscBeganMPI = PETSC_TRUE;
796e5c89e4eSSatish Balay   }
797e5c89e4eSSatish Balay   if (argc && args) {
798e5c89e4eSSatish Balay     PetscGlobalArgc = *argc;
799e5c89e4eSSatish Balay     PetscGlobalArgs = *args;
800e5c89e4eSSatish Balay   }
801e5c89e4eSSatish Balay   PetscFinalizeCalled = PETSC_FALSE;
802e5c89e4eSSatish Balay 
803a297a907SKarl Rupp   if (PETSC_COMM_WORLD == MPI_COMM_NULL) PETSC_COMM_WORLD = MPI_COMM_WORLD;
804d54338ecSKarl Rupp   ierr = MPI_Comm_set_errhandler(PETSC_COMM_WORLD,MPI_ERRORS_RETURN);CHKERRQ(ierr);
805e5c89e4eSSatish Balay 
806e5c89e4eSSatish Balay   /* Done after init due to a bug in MPICH-GM? */
807e5c89e4eSSatish Balay   ierr = PetscErrorPrintfInitialize();CHKERRQ(ierr);
808e5c89e4eSSatish Balay 
809e5c89e4eSSatish Balay   ierr = MPI_Comm_rank(MPI_COMM_WORLD,&PetscGlobalRank);CHKERRQ(ierr);
810e5c89e4eSSatish Balay   ierr = MPI_Comm_size(MPI_COMM_WORLD,&PetscGlobalSize);CHKERRQ(ierr);
811e5c89e4eSSatish Balay 
8128ad47952SJed Brown   MPIU_BOOL = MPI_INT;
8138ad47952SJed Brown   MPIU_ENUM = MPI_INT;
8148ad47952SJed Brown 
815e5c89e4eSSatish Balay   /*
816e5c89e4eSSatish Balay      Initialized the global complex variable; this is because with
817e5c89e4eSSatish Balay      shared libraries the constructors for global variables
818e5c89e4eSSatish Balay      are not called; at least on IRIX.
819e5c89e4eSSatish Balay   */
820886cfec0SSatish Balay #if defined(PETSC_HAVE_COMPLEX)
821e5c89e4eSSatish Balay   {
822a24ee22aSSatish Balay #if defined(PETSC_CLANGUAGE_CXX)
82350f81f78SJed Brown     PetscComplex ic(0.0,1.0);
824e5c89e4eSSatish Balay     PETSC_i = ic;
825a24ee22aSSatish Balay #elif defined(PETSC_CLANGUAGE_C)
82650f81f78SJed Brown     PETSC_i = _Complex_I;
827b7940d39SSatish Balay #endif
828762437b8SSatish Balay   }
829762437b8SSatish Balay 
8302c876bd9SBarry Smith #if !defined(PETSC_HAVE_MPI_C_DOUBLE_COMPLEX)
831e69cd0e6SSatish Balay   ierr = MPI_Type_contiguous(2,MPI_DOUBLE,&MPIU_C_DOUBLE_COMPLEX);CHKERRQ(ierr);
832500d8756SSatish Balay   ierr = MPI_Type_commit(&MPIU_C_DOUBLE_COMPLEX);CHKERRQ(ierr);
833500d8756SSatish Balay   ierr = MPI_Type_contiguous(2,MPI_FLOAT,&MPIU_C_COMPLEX);CHKERRQ(ierr);
834500d8756SSatish Balay   ierr = MPI_Type_commit(&MPIU_C_COMPLEX);CHKERRQ(ierr);
8352c876bd9SBarry Smith #endif
836886cfec0SSatish Balay #endif /* PETSC_HAVE_COMPLEX */
837e5c89e4eSSatish Balay 
838e5c89e4eSSatish Balay   /*
839e5c89e4eSSatish Balay      Create the PETSc MPI reduction operator that sums of the first
840e5c89e4eSSatish Balay      half of the entries and maxes the second half.
841e5c89e4eSSatish Balay   */
842e5c89e4eSSatish Balay   ierr = MPI_Op_create(PetscMaxSum_Local,1,&PetscMaxSum_Op);CHKERRQ(ierr);
843e5c89e4eSSatish Balay 
844ce63c4c1SBarry Smith #if defined(PETSC_USE_REAL___FLOAT128)
845c90a1750SBarry Smith   ierr = MPI_Type_contiguous(2,MPI_DOUBLE,&MPIU___FLOAT128);CHKERRQ(ierr);
846c90a1750SBarry Smith   ierr = MPI_Type_commit(&MPIU___FLOAT128);CHKERRQ(ierr);
8477c2de775SJed Brown #if defined(PETSC_HAVE_COMPLEX)
8488c764dc5SJose Roman   ierr = MPI_Type_contiguous(4,MPI_DOUBLE,&MPIU___COMPLEX128);CHKERRQ(ierr);
8498c764dc5SJose Roman   ierr = MPI_Type_commit(&MPIU___COMPLEX128);CHKERRQ(ierr);
8508c764dc5SJose Roman #endif
851d9822059SBarry Smith   ierr = MPI_Op_create(PetscMax_Local,1,&MPIU_MAX);CHKERRQ(ierr);
852d9822059SBarry Smith   ierr = MPI_Op_create(PetscMin_Local,1,&MPIU_MIN);CHKERRQ(ierr);
853c90a1750SBarry Smith #endif
854c90a1750SBarry Smith 
8557c2de775SJed Brown #if (defined(PETSC_HAVE_COMPLEX) && !defined(PETSC_HAVE_MPI_C_DOUBLE_COMPLEX)) || defined(PETSC_USE_REAL___FLOAT128)
856cca4cb22SSatish Balay   ierr = MPI_Op_create(PetscSum_Local,1,&MPIU_SUM);CHKERRQ(ierr);
857cca4cb22SSatish Balay #endif
858cca4cb22SSatish Balay 
859e5c89e4eSSatish Balay   ierr = MPI_Type_contiguous(2,MPIU_SCALAR,&MPIU_2SCALAR);CHKERRQ(ierr);
860e5c89e4eSSatish Balay   ierr = MPI_Type_commit(&MPIU_2SCALAR);CHKERRQ(ierr);
861e5c89e4eSSatish Balay   ierr = MPI_Op_create(PetscADMax_Local,1,&PetscADMax_Op);CHKERRQ(ierr);
862e5c89e4eSSatish Balay   ierr = MPI_Op_create(PetscADMin_Local,1,&PetscADMin_Op);CHKERRQ(ierr);
863e5c89e4eSSatish Balay 
86444041f26SJed Brown #if defined(PETSC_USE_64BIT_INDICES) || !defined(MPI_2INT)
865e5c89e4eSSatish Balay   ierr = MPI_Type_contiguous(2,MPIU_INT,&MPIU_2INT);CHKERRQ(ierr);
866e5c89e4eSSatish Balay   ierr = MPI_Type_commit(&MPIU_2INT);CHKERRQ(ierr);
86744041f26SJed Brown #endif
868e5c89e4eSSatish Balay 
869ec957eceSBarry Smith 
870e5c89e4eSSatish Balay   /*
871480cf27aSJed Brown      Attributes to be set on PETSc communicators
872480cf27aSJed Brown   */
873480cf27aSJed Brown   ierr = MPI_Keyval_create(MPI_NULL_COPY_FN,Petsc_DelCounter,&Petsc_Counter_keyval,(void*)0);CHKERRQ(ierr);
874da3039f7SJed Brown   ierr = MPI_Keyval_create(MPI_NULL_COPY_FN,Petsc_DelComm_Outer,&Petsc_InnerComm_keyval,(void*)0);CHKERRQ(ierr);
875da3039f7SJed Brown   ierr = MPI_Keyval_create(MPI_NULL_COPY_FN,Petsc_DelComm_Inner,&Petsc_OuterComm_keyval,(void*)0);CHKERRQ(ierr);
876480cf27aSJed Brown 
877480cf27aSJed Brown   /*
878e8fb0fc0SBarry Smith      Build the options database
879e5c89e4eSSatish Balay   */
880e5c89e4eSSatish Balay   ierr = PetscOptionsInsert(argc,args,file);CHKERRQ(ierr);
881e5c89e4eSSatish Balay 
8826dc8fec2Sbcordonn 
883e5c89e4eSSatish Balay   /*
884e5c89e4eSSatish Balay      Print main application help message
885e5c89e4eSSatish Balay   */
8860298fd71SBarry Smith   ierr = PetscOptionsHasName(NULL,"-help",&flg);CHKERRQ(ierr);
887e5c89e4eSSatish Balay   if (help && flg) {
888e5c89e4eSSatish Balay     ierr = PetscPrintf(PETSC_COMM_WORLD,help);CHKERRQ(ierr);
889e5c89e4eSSatish Balay   }
890e5c89e4eSSatish Balay   ierr = PetscOptionsCheckInitial_Private();CHKERRQ(ierr);
891e5c89e4eSSatish Balay 
892d45a07a7SBarry Smith   ierr = PetscCitationsInitialize();CHKERRQ(ierr);
893d45a07a7SBarry Smith 
894e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS)
89511525c0dSBarry Smith   ierr = PetscInitializeSAWs(help);CHKERRQ(ierr);
896f4202a44SBarry Smith #endif
897f4202a44SBarry Smith 
898e5c89e4eSSatish Balay   /* SHOULD PUT IN GUARDS: Make sure logging is initialized, even if we do not print it out */
899a9f03627SSatish Balay #if defined(PETSC_USE_LOG)
900e5c89e4eSSatish Balay   ierr = PetscLogBegin_Private();CHKERRQ(ierr);
901a9f03627SSatish Balay #endif
902e5c89e4eSSatish Balay 
903e5c89e4eSSatish Balay   /*
904e5c89e4eSSatish Balay      Load the dynamic libraries (on machines that support them), this registers all
905e5c89e4eSSatish Balay      the solvers etc. (On non-dynamic machines this initializes the PetscDraw and PetscViewer classes)
906e5c89e4eSSatish Balay   */
907e5c89e4eSSatish Balay   ierr = PetscInitialize_DynamicLibraries();CHKERRQ(ierr);
908e5c89e4eSSatish Balay 
909e5c89e4eSSatish Balay   ierr = MPI_Comm_size(PETSC_COMM_WORLD,&size);CHKERRQ(ierr);
910ae15b995SBarry Smith   ierr = PetscInfo1(0,"PETSc successfully started: number of processors = %d\n",size);CHKERRQ(ierr);
911e5c89e4eSSatish Balay   ierr = PetscGetHostName(hostname,256);CHKERRQ(ierr);
912ae15b995SBarry Smith   ierr = PetscInfo1(0,"Running on machine: %s\n",hostname);CHKERRQ(ierr);
913e5c89e4eSSatish Balay 
91467234432SDmitry Karpeev   /* Ensure that threadcomm-related keyval exists, so that PetscOptionsSetFromOptions can use PetscCommDuplicate. */
91567234432SDmitry Karpeev   ierr = PetscThreadCommInitializePackage();CHKERRQ(ierr);
91667234432SDmitry Karpeev 
917e5c89e4eSSatish Balay   ierr = PetscOptionsCheckInitial_Components();CHKERRQ(ierr);
918ef6c6fedSBoyana Norris   /* Check the options database for options related to the options database itself */
919ef6c6fedSBoyana Norris   ierr = PetscOptionsSetFromOptions();CHKERRQ(ierr);
920ef6c6fedSBoyana Norris 
921951e3c8eSBarry Smith #if defined(PETSC_USE_PETSC_MPI_EXTERNAL32)
922e39fd77fSBarry Smith   /*
923e39fd77fSBarry Smith       Tell MPI about our own data representation converter, this would/should be used if extern32 is not supported by the MPI
924e39fd77fSBarry Smith 
925e39fd77fSBarry Smith       Currently not used because it is not supported by MPICH.
926e39fd77fSBarry Smith   */
927e39fd77fSBarry Smith #if !defined(PETSC_WORDS_BIGENDIAN)
9280298fd71SBarry Smith   ierr = MPI_Register_datarep((char*)"petsc",PetscDataRep_read_conv_fn,PetscDataRep_write_conv_fn,PetscDataRep_extent_fn,NULL);CHKERRQ(ierr);
929e39fd77fSBarry Smith #endif
930951e3c8eSBarry Smith #endif
931e39fd77fSBarry Smith 
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 
95041c0b4b3SShri Abhyankar   /*
95141c0b4b3SShri Abhyankar       Setup building of stack frames for all function calls
95241c0b4b3SShri Abhyankar   */
95376386721SLisandro Dalcin   PetscThreadLocalRegister((PetscThreadKey*)&petscstack); /* Creates pthread_key */
954e1167bb9SShri Abhyankar #if defined(PETSC_USE_DEBUG)
955e1167bb9SShri Abhyankar   ierr = PetscStackCreate();CHKERRQ(ierr);
956e1167bb9SShri Abhyankar #endif
957e1167bb9SShri Abhyankar 
9582d53ad75SBarry Smith #if defined(PETSC_SERIALIZE_FUNCTIONS)
9592d53ad75SBarry Smith   ierr = PetscFPTCreate(10000);CHKERRQ(ierr);
9602d53ad75SBarry Smith #endif
9612d53ad75SBarry Smith 
962dff31646SBarry Smith 
963301d30feSBarry Smith   /*
964301d30feSBarry Smith       Once we are completedly initialized then we can set this variables
965301d30feSBarry Smith   */
966301d30feSBarry Smith   PetscInitializeCalled = PETSC_TRUE;
967301d30feSBarry Smith   PetscFunctionReturn(0);
968e5c89e4eSSatish Balay }
969e5c89e4eSSatish Balay 
9704097062eSBarry Smith #if defined(PETSC_USE_LOG)
9712eff7a51SBarry Smith extern PetscObject *PetscObjects;
9722eff7a51SBarry Smith extern PetscInt    PetscObjectsCounts, PetscObjectsMaxCounts;
9734097062eSBarry Smith #endif
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 
1041c2a97968SBarry Smith #if defined(PETSC_HAVE_SSL) && defined(PETSC_USE_SOCKET_VIEWER)
104204102261SBarry Smith   /* TextBelt is run for testing purposes only, please do not use this feature often */
104304102261SBarry Smith   {
104404102261SBarry Smith     PetscInt nmax = 2;
104504102261SBarry Smith     char     **buffs;
104604102261SBarry Smith     ierr = PetscMalloc1(2,&buffs);CHKERRQ(ierr);
104704102261SBarry Smith     ierr = PetscOptionsGetStringArray(NULL,"-textbelt",buffs,&nmax,&flg1);CHKERRQ(ierr);
104804102261SBarry Smith     if (flg1) {
104904102261SBarry Smith       if (!nmax) SETERRQ(PETSC_COMM_WORLD,PETSC_ERR_USER,"-textbelt requires either the phone number or number,\"message\"");
105004102261SBarry Smith       if (nmax == 1) {
105104102261SBarry Smith         ierr = PetscMalloc1(128,&buffs[1]);CHKERRQ(ierr);
105204102261SBarry Smith         ierr = PetscGetProgramName(buffs[1],32);CHKERRQ(ierr);
105304102261SBarry Smith         ierr = PetscStrcat(buffs[1]," has completed");CHKERRQ(ierr);
105404102261SBarry Smith       }
105504102261SBarry Smith       ierr = PetscTextBelt(PETSC_COMM_WORLD,buffs[0],buffs[1],NULL);CHKERRQ(ierr);
105604102261SBarry Smith       ierr = PetscFree(buffs[0]);CHKERRQ(ierr);
105704102261SBarry Smith       ierr = PetscFree(buffs[1]);CHKERRQ(ierr);
105804102261SBarry Smith     }
105904102261SBarry Smith     ierr = PetscFree(buffs);CHKERRQ(ierr);
106004102261SBarry Smith   }
106104102261SBarry Smith #endif
106267234432SDmitry Karpeev   /*
106367234432SDmitry Karpeev     It should be safe to cancel the options monitors, since we don't expect to be setting options
106467234432SDmitry Karpeev     here (at least that are worth monitoring).  Monitors ought to be released so that they release
106567234432SDmitry Karpeev     whatever memory was allocated there before -malloc_dump reports unfreed memory.
106667234432SDmitry Karpeev   */
106767234432SDmitry Karpeev   ierr = PetscOptionsMonitorCancel();CHKERRQ(ierr);
106804102261SBarry Smith 
10692d53ad75SBarry Smith #if defined(PETSC_SERIALIZE_FUNCTIONS)
10702d53ad75SBarry Smith   ierr = PetscFPTDestroy();CHKERRQ(ierr);
10712d53ad75SBarry Smith #endif
10722d53ad75SBarry Smith 
10732d53ad75SBarry Smith 
1074e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS)
1075dff31646SBarry Smith   flg = PETSC_FALSE;
1076e78c4b8cSBarry Smith   ierr = PetscOptionsGetBool(NULL,"-saw_options",&flg,NULL);CHKERRQ(ierr);
1077d5649816SBarry Smith   if (flg) {
1078e04113cfSBarry Smith     ierr = PetscOptionsSAWsDestroy();CHKERRQ(ierr);
1079d5649816SBarry Smith   }
1080d5649816SBarry Smith #endif
1081d5649816SBarry Smith 
1082681455b2SBarry Smith #if defined(PETSC_HAVE_X)
1083681455b2SBarry Smith   flg1 = PETSC_FALSE;
1084681455b2SBarry Smith   ierr = PetscOptionsGetBool(NULL,"-x_virtual",&flg1,NULL);CHKERRQ(ierr);
1085681455b2SBarry Smith   if (flg1) {
1086681455b2SBarry Smith     /*  this is a crude hack, but better than nothing */
1087681455b2SBarry Smith     ierr = PetscPOpen(PETSC_COMM_WORLD,NULL,"pkill -9 Xvfb","r",NULL);CHKERRQ(ierr);
1088681455b2SBarry Smith   }
1089681455b2SBarry Smith #endif
1090681455b2SBarry Smith 
10910298fd71SBarry Smith   ierr = PetscOptionsGetBool(NULL,"-malloc_info",&flg2,NULL);CHKERRQ(ierr);
1092e5c89e4eSSatish Balay   if (!flg2) {
109390d69ab7SBarry Smith     flg2 = PETSC_FALSE;
10940298fd71SBarry Smith     ierr = PetscOptionsGetBool(NULL,"-memory_info",&flg2,NULL);CHKERRQ(ierr);
1095e5c89e4eSSatish Balay   }
1096e5c89e4eSSatish Balay   if (flg2) {
1097e5c89e4eSSatish Balay     ierr = PetscMemoryShowUsage(PETSC_VIEWER_STDOUT_WORLD,"Summary of Memory Usage in PETSc\n");CHKERRQ(ierr);
1098e5c89e4eSSatish Balay   }
1099e5c89e4eSSatish Balay 
1100e5c89e4eSSatish Balay #if defined(PETSC_USE_LOG)
110190d69ab7SBarry Smith   flg1 = PETSC_FALSE;
11020298fd71SBarry Smith   ierr = PetscOptionsGetBool(NULL,"-get_total_flops",&flg1,NULL);CHKERRQ(ierr);
1103e5c89e4eSSatish Balay   if (flg1) {
1104e5c89e4eSSatish Balay     PetscLogDouble flops = 0;
1105205a32c2SJed Brown     ierr = MPI_Reduce(&petsc_TotalFlops,&flops,1,MPI_DOUBLE,MPI_SUM,0,PETSC_COMM_WORLD);CHKERRQ(ierr);
1106e5c89e4eSSatish Balay     ierr = PetscPrintf(PETSC_COMM_WORLD,"Total flops over all processors %g\n",flops);CHKERRQ(ierr);
1107e5c89e4eSSatish Balay   }
1108e5c89e4eSSatish Balay #endif
1109e5c89e4eSSatish Balay 
1110e5c89e4eSSatish Balay 
1111e5c89e4eSSatish Balay #if defined(PETSC_USE_LOG)
1112e5c89e4eSSatish Balay #if defined(PETSC_HAVE_MPE)
1113e5c89e4eSSatish Balay   mname[0] = 0;
1114a297a907SKarl Rupp 
11150298fd71SBarry Smith   ierr = PetscOptionsGetString(NULL,"-log_mpe",mname,PETSC_MAX_PATH_LEN,&flg1);CHKERRQ(ierr);
1116e5c89e4eSSatish Balay   if (flg1) {
1117e5c89e4eSSatish Balay     if (mname[0]) {ierr = PetscLogMPEDump(mname);CHKERRQ(ierr);}
1118e5c89e4eSSatish Balay     else          {ierr = PetscLogMPEDump(0);CHKERRQ(ierr);}
1119e5c89e4eSSatish Balay   }
1120e5c89e4eSSatish Balay #endif
1121e5c89e4eSSatish Balay   mname[0] = 0;
1122a297a907SKarl Rupp 
1123f14045dbSBarry Smith   ierr = PetscLogViewFromOptions();CHKERRQ(ierr);
11240298fd71SBarry Smith   ierr = PetscOptionsGetString(NULL,"-log_summary",mname,PETSC_MAX_PATH_LEN,&flg1);CHKERRQ(ierr);
1125e5c89e4eSSatish Balay   if (flg1) {
112691eabc43SBarry Smith     PetscViewer viewer;
112791eabc43SBarry Smith     if (mname[0]) {
112891eabc43SBarry Smith       ierr = PetscViewerASCIIOpen(PETSC_COMM_WORLD,mname,&viewer);CHKERRQ(ierr);
112991eabc43SBarry Smith       ierr = PetscLogView(viewer);CHKERRQ(ierr);
11306bf464f9SBarry Smith       ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr);
113133f85c2fSBarry Smith     } else {
113233f85c2fSBarry Smith       viewer = PETSC_VIEWER_STDOUT_WORLD;
113333f85c2fSBarry Smith       ierr   = PetscLogView(viewer);CHKERRQ(ierr);
113433f85c2fSBarry Smith     }
1135e5c89e4eSSatish Balay   }
1136e5c89e4eSSatish Balay   mname[0] = 0;
1137a297a907SKarl Rupp 
11380298fd71SBarry Smith   ierr = PetscOptionsGetString(NULL,"-log_all",mname,PETSC_MAX_PATH_LEN,&flg1);CHKERRQ(ierr);
11390298fd71SBarry Smith   ierr = PetscOptionsGetString(NULL,"-log",mname,PETSC_MAX_PATH_LEN,&flg2);CHKERRQ(ierr);
1140e5c89e4eSSatish Balay   if (flg1 || flg2) {
1141e5c89e4eSSatish Balay     if (mname[0]) PetscLogDump(mname);
1142e5c89e4eSSatish Balay     else          PetscLogDump(0);
1143e5c89e4eSSatish Balay   }
1144e5c89e4eSSatish Balay #endif
114510463e74SBarry Smith 
1146b58ca069SBarry Smith   /*
1147b58ca069SBarry Smith      Free all objects registered with PetscObjectRegisterDestroy() such as PETSC_VIEWER_XXX_().
1148b58ca069SBarry Smith   */
1149b58ca069SBarry Smith   ierr = PetscObjectRegisterDestroyAll();CHKERRQ(ierr);
1150b58ca069SBarry Smith 
115133f85c2fSBarry Smith   ierr = PetscStackDestroy();CHKERRQ(ierr);
115276386721SLisandro Dalcin   PetscThreadLocalDestroy((PetscThreadKey)petscstack); /* Deletes pthread_key */
115310463e74SBarry Smith 
115490d69ab7SBarry Smith   flg1 = PETSC_FALSE;
11550298fd71SBarry Smith   ierr = PetscOptionsGetBool(NULL,"-no_signal_handler",&flg1,NULL);CHKERRQ(ierr);
1156e5c89e4eSSatish Balay   if (!flg1) { ierr = PetscPopSignalHandler();CHKERRQ(ierr);}
115790d69ab7SBarry Smith   flg1 = PETSC_FALSE;
11580298fd71SBarry Smith   ierr = PetscOptionsGetBool(NULL,"-mpidump",&flg1,NULL);CHKERRQ(ierr);
1159e5c89e4eSSatish Balay   if (flg1) {
1160e5c89e4eSSatish Balay     ierr = PetscMPIDump(stdout);CHKERRQ(ierr);
1161e5c89e4eSSatish Balay   }
116290d69ab7SBarry Smith   flg1 = PETSC_FALSE;
116390d69ab7SBarry Smith   flg2 = PETSC_FALSE;
11648bb29257SSatish Balay   /* preemptive call to avoid listing this option in options table as unused */
11650298fd71SBarry Smith   ierr = PetscOptionsHasName(NULL,"-malloc_dump",&flg1);CHKERRQ(ierr);
11660298fd71SBarry Smith   ierr = PetscOptionsHasName(NULL,"-objects_dump",&flg1);CHKERRQ(ierr);
1167662a7babSBarry Smith   ierr = PetscOptionsGetBool(NULL,"-options_view",&flg2,NULL);CHKERRQ(ierr);
1168e4c476e2SSatish Balay 
1169e5c89e4eSSatish Balay   if (flg2) {
1170be56827dSJed Brown     PetscViewer viewer;
117102ba9f54SBarry Smith     ierr = PetscViewerCreate(PETSC_COMM_WORLD,&viewer);CHKERRQ(ierr);
117202ba9f54SBarry Smith     ierr = PetscViewerSetType(viewer,PETSCVIEWERASCII);CHKERRQ(ierr);
1173be56827dSJed Brown     ierr = PetscOptionsView(viewer);CHKERRQ(ierr);
1174be56827dSJed Brown     ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr);
1175e5c89e4eSSatish Balay   }
1176e5c89e4eSSatish Balay 
1177e5c89e4eSSatish Balay   /* to prevent PETSc -options_left from warning */
11780298fd71SBarry Smith   ierr = PetscOptionsHasName(NULL,"-nox",&flg1);CHKERRQ(ierr);
11790298fd71SBarry Smith   ierr = PetscOptionsHasName(NULL,"-nox_warning",&flg1);CHKERRQ(ierr);
1180e5c89e4eSSatish Balay 
118133fc4174SSatish Balay   flg3 = PETSC_FALSE; /* default value is required */
11820298fd71SBarry Smith   ierr = PetscOptionsGetBool(NULL,"-options_left",&flg3,&flg1);CHKERRQ(ierr);
1183e5c89e4eSSatish Balay   ierr = PetscOptionsAllUsed(&nopt);CHKERRQ(ierr);
1184e5c89e4eSSatish Balay   if (flg3) {
1185e5c89e4eSSatish Balay     if (!flg2) { /* have not yet printed the options */
1186be56827dSJed Brown       PetscViewer viewer;
118702ba9f54SBarry Smith       ierr = PetscViewerCreate(PETSC_COMM_WORLD,&viewer);CHKERRQ(ierr);
118802ba9f54SBarry Smith       ierr = PetscViewerSetType(viewer,PETSCVIEWERASCII);CHKERRQ(ierr);
1189be56827dSJed Brown       ierr = PetscOptionsView(viewer);CHKERRQ(ierr);
1190be56827dSJed Brown       ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr);
1191e5c89e4eSSatish Balay     }
1192e5c89e4eSSatish Balay     if (!nopt) {
1193e5c89e4eSSatish Balay       ierr = PetscPrintf(PETSC_COMM_WORLD,"There are no unused options.\n");CHKERRQ(ierr);
1194e5c89e4eSSatish Balay     } else if (nopt == 1) {
1195e5c89e4eSSatish Balay       ierr = PetscPrintf(PETSC_COMM_WORLD,"There is one unused database option. It is:\n");CHKERRQ(ierr);
1196e5c89e4eSSatish Balay     } else {
11977582186dSLisandro Dalcin       ierr = PetscPrintf(PETSC_COMM_WORLD,"There are %D unused database options. They are:\n",nopt);CHKERRQ(ierr);
1198e5c89e4eSSatish Balay     }
1199e5c89e4eSSatish Balay   }
1200e5c89e4eSSatish Balay #if defined(PETSC_USE_DEBUG)
1201da8b8a77SBarry Smith   if (nopt && !flg3 && !flg1) {
1202e5c89e4eSSatish Balay     ierr = PetscPrintf(PETSC_COMM_WORLD,"WARNING! There are options you set that were not used!\n");CHKERRQ(ierr);
1203e5c89e4eSSatish Balay     ierr = PetscPrintf(PETSC_COMM_WORLD,"WARNING! could be spelling mistake, etc!\n");CHKERRQ(ierr);
1204e5c89e4eSSatish Balay     ierr = PetscOptionsLeft();CHKERRQ(ierr);
1205e5c89e4eSSatish Balay   } else if (nopt && flg3) {
1206e5c89e4eSSatish Balay #else
1207e5c89e4eSSatish Balay   if (nopt && flg3) {
1208e5c89e4eSSatish Balay #endif
1209e5c89e4eSSatish Balay     ierr = PetscOptionsLeft();CHKERRQ(ierr);
1210e5c89e4eSSatish Balay   }
1211e5c89e4eSSatish Balay 
1212e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS)
1213d45a07a7SBarry Smith   if (!PetscGlobalRank) {
121487f587eeSBarry Smith     ierr = PetscStackSAWsViewOff();CHKERRQ(ierr);
121516ad0300SBarry Smith     PetscStackCallSAWs(SAWs_Finalize,());
1216d45a07a7SBarry Smith   }
1217ec957eceSBarry Smith #endif
1218ec957eceSBarry Smith 
1219eea2bdeeSJed Brown   {
1220eea2bdeeSJed Brown     PetscThreadComm tcomm_world;
1221eea2bdeeSJed Brown     ierr = PetscGetThreadCommWorld(&tcomm_world);CHKERRQ(ierr);
1222eea2bdeeSJed Brown     /* Free global thread communicator */
1223eea2bdeeSJed Brown     ierr = PetscThreadCommDestroy(&tcomm_world);CHKERRQ(ierr);
1224eea2bdeeSJed Brown   }
1225eea2bdeeSJed Brown 
12264097062eSBarry Smith #if defined(PETSC_USE_LOG)
122710463e74SBarry Smith   /*
1228dbc8283eSBarry Smith        List all objects the user may have forgot to free
12292eff7a51SBarry Smith   */
12300298fd71SBarry Smith   ierr = PetscOptionsHasName(NULL,"-objects_dump",&flg1);CHKERRQ(ierr);
1231a64a8e02SBarry Smith   if (flg1) {
1232a64a8e02SBarry Smith     MPI_Comm local_comm;
12337eb1d149SBarry Smith     char     string[64];
1234a64a8e02SBarry Smith 
12350298fd71SBarry Smith     ierr = PetscOptionsGetString(NULL,"-objects_dump",string,64,NULL);CHKERRQ(ierr);
1236a64a8e02SBarry Smith     ierr = MPI_Comm_dup(MPI_COMM_WORLD,&local_comm);CHKERRQ(ierr);
1237a64a8e02SBarry Smith     ierr = PetscSequentialPhaseBegin_Private(local_comm,1);CHKERRQ(ierr);
12387eb1d149SBarry Smith     ierr = PetscObjectsDump(stdout,(string[0] == 'a') ? PETSC_TRUE : PETSC_FALSE);CHKERRQ(ierr);
1239a64a8e02SBarry Smith     ierr = PetscSequentialPhaseEnd_Private(local_comm,1);CHKERRQ(ierr);
1240a64a8e02SBarry Smith     ierr = MPI_Comm_free(&local_comm);CHKERRQ(ierr);
12410a1571b3SBarry Smith   }
12424097062eSBarry Smith #endif
12434097062eSBarry Smith 
12444097062eSBarry Smith #if defined(PETSC_USE_LOG)
1245dbc8283eSBarry Smith   PetscObjectsCounts    = 0;
1246dbc8283eSBarry Smith   PetscObjectsMaxCounts = 0;
1247a297a907SKarl Rupp   ierr = PetscFree(PetscObjects);CHKERRQ(ierr);
12484097062eSBarry Smith #endif
12492eff7a51SBarry Smith 
125033f85c2fSBarry Smith #if defined(PETSC_USE_LOG)
125133f85c2fSBarry Smith   ierr = PetscLogDestroy();CHKERRQ(ierr);
125233f85c2fSBarry Smith #endif
125333f85c2fSBarry Smith 
125433f85c2fSBarry Smith   /*
125522b6d1caSBarry Smith      Close any open dynamic libraries
125622b6d1caSBarry Smith   */
125722b6d1caSBarry Smith   ierr = PetscFinalize_DynamicLibraries();CHKERRQ(ierr);
125822b6d1caSBarry Smith 
125922b6d1caSBarry Smith   /*
126033f85c2fSBarry Smith      Destroy any packages that registered a finalize
126133f85c2fSBarry Smith   */
126233f85c2fSBarry Smith   ierr = PetscRegisterFinalizeAll();CHKERRQ(ierr);
126333f85c2fSBarry Smith 
126433f85c2fSBarry Smith   /*
126548dd1dffSBarry Smith      Print PetscFunctionLists that have not been properly freed
126648dd1dffSBarry Smith 
126737e93019SBarry Smith   ierr = PetscFunctionListPrintAll();CHKERRQ(ierr);
126848dd1dffSBarry Smith   */
126937e93019SBarry Smith 
12704028d114SSatish Balay   if (petsc_history) {
1271f3dea69dSBarry Smith     ierr = PetscCloseHistoryFile(&petsc_history);CHKERRQ(ierr);
1272e5c89e4eSSatish Balay     petsc_history = 0;
1273e5c89e4eSSatish Balay   }
1274e5c89e4eSSatish Balay 
12750298fd71SBarry Smith   ierr = PetscInfoAllow(PETSC_FALSE,NULL);CHKERRQ(ierr);
1276e5c89e4eSSatish Balay 
12778bb29257SSatish Balay   {
1278e5c89e4eSSatish Balay     char fname[PETSC_MAX_PATH_LEN];
1279e5c89e4eSSatish Balay     FILE *fd;
1280ed9cf6e9SBarry Smith     int  err;
1281e5c89e4eSSatish Balay 
1282e5c89e4eSSatish Balay     fname[0] = 0;
1283a297a907SKarl Rupp 
12840298fd71SBarry Smith     ierr = PetscOptionsGetString(NULL,"-malloc_dump",fname,250,&flg1);CHKERRQ(ierr);
1285dc92acbaSJed Brown     flg2 = PETSC_FALSE;
12860298fd71SBarry Smith     ierr = PetscOptionsGetBool(NULL,"-malloc_test",&flg2,NULL);CHKERRQ(ierr);
12878bf1f09cSShri Abhyankar #if defined(PETSC_USE_DEBUG)
1288dc92acbaSJed Brown     if (PETSC_RUNNING_ON_VALGRIND) flg2 = PETSC_FALSE;
1289dc92acbaSJed Brown #else
1290dc92acbaSJed Brown     flg2 = PETSC_FALSE;         /* Skip reporting for optimized builds regardless of -malloc_test */
1291dc92acbaSJed Brown #endif
1292e5c89e4eSSatish Balay     if (flg1 && fname[0]) {
1293e5c89e4eSSatish Balay       char sname[PETSC_MAX_PATH_LEN];
1294e5c89e4eSSatish Balay 
1295e5c89e4eSSatish Balay       sprintf(sname,"%s_%d",fname,rank);
1296e32f2f54SBarry Smith       fd   = fopen(sname,"w"); if (!fd) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_FILE_OPEN,"Cannot open log file: %s",sname);
1297e5c89e4eSSatish Balay       ierr = PetscMallocDump(fd);CHKERRQ(ierr);
1298ed9cf6e9SBarry Smith       err  = fclose(fd);
1299e32f2f54SBarry Smith       if (err) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SYS,"fclose() failed on file");
1300dc92acbaSJed Brown     } else if (flg1 || flg2) {
1301e5c89e4eSSatish Balay       MPI_Comm local_comm;
1302e5c89e4eSSatish Balay 
1303e5c89e4eSSatish Balay       ierr = MPI_Comm_dup(MPI_COMM_WORLD,&local_comm);CHKERRQ(ierr);
1304e5c89e4eSSatish Balay       ierr = PetscSequentialPhaseBegin_Private(local_comm,1);CHKERRQ(ierr);
1305e5c89e4eSSatish Balay       ierr = PetscMallocDump(stdout);CHKERRQ(ierr);
1306e5c89e4eSSatish Balay       ierr = PetscSequentialPhaseEnd_Private(local_comm,1);CHKERRQ(ierr);
1307e5c89e4eSSatish Balay       ierr = MPI_Comm_free(&local_comm);CHKERRQ(ierr);
1308e5c89e4eSSatish Balay     }
1309e5c89e4eSSatish Balay   }
1310a64a8e02SBarry Smith 
13118bb29257SSatish Balay   {
1312e5c89e4eSSatish Balay     char fname[PETSC_MAX_PATH_LEN];
13130298fd71SBarry Smith     FILE *fd = NULL;
1314e5c89e4eSSatish Balay 
1315e5c89e4eSSatish Balay     fname[0] = 0;
1316a297a907SKarl Rupp 
13170298fd71SBarry Smith     ierr = PetscOptionsGetString(NULL,"-malloc_log",fname,250,&flg1);CHKERRQ(ierr);
13180298fd71SBarry Smith     ierr = PetscOptionsHasName(NULL,"-malloc_log_threshold",&flg2);CHKERRQ(ierr);
1319e5c89e4eSSatish Balay     if (flg1 && fname[0]) {
1320ed9cf6e9SBarry Smith       int err;
1321e5c89e4eSSatish Balay 
1322574034a9SJed Brown       if (!rank) {
1323574034a9SJed Brown         fd = fopen(fname,"w");
1324574034a9SJed Brown         if (!fd) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_FILE_OPEN,"Cannot open log file: %s",fname);
1325574034a9SJed Brown       }
1326e5c89e4eSSatish Balay       ierr = PetscMallocDumpLog(fd);CHKERRQ(ierr);
1327574034a9SJed Brown       if (fd) {
1328ed9cf6e9SBarry Smith         err = fclose(fd);
1329e32f2f54SBarry Smith         if (err) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SYS,"fclose() failed on file");
1330574034a9SJed Brown       }
1331574034a9SJed Brown     } else if (flg1 || flg2) {
1332e5c89e4eSSatish Balay       ierr = PetscMallocDumpLog(stdout);CHKERRQ(ierr);
1333e5c89e4eSSatish Balay     }
1334e5c89e4eSSatish Balay   }
133520e2c332SMatthew G. Knepley 
133620e2c332SMatthew G. Knepley #if defined(PETSC_HAVE_CUDA)
133720e2c332SMatthew G. Knepley   flg  = PETSC_TRUE;
133820e2c332SMatthew G. Knepley   ierr = PetscOptionsGetBool(NULL,"-cublas",&flg,NULL);CHKERRQ(ierr);
133920e2c332SMatthew G. Knepley   if (flg) {
134020e2c332SMatthew G. Knepley     PetscInt p;
134120e2c332SMatthew G. Knepley     for (p = 0; p < PetscGlobalSize; ++p) {
134220e2c332SMatthew G. Knepley       if (p == PetscGlobalRank) cublasShutdown();
134320e2c332SMatthew G. Knepley       ierr = MPI_Barrier(PETSC_COMM_WORLD);CHKERRQ(ierr);
134420e2c332SMatthew G. Knepley     }
134520e2c332SMatthew G. Knepley   }
134620e2c332SMatthew G. Knepley #endif
134720e2c332SMatthew G. Knepley 
1348e5c89e4eSSatish Balay   /* Can be destroyed only after all the options are used */
1349e5c89e4eSSatish Balay   ierr = PetscOptionsDestroy();CHKERRQ(ierr);
1350e5c89e4eSSatish Balay 
1351e5c89e4eSSatish Balay   PetscGlobalArgc = 0;
1352e5c89e4eSSatish Balay   PetscGlobalArgs = 0;
1353e5c89e4eSSatish Balay 
1354ce63c4c1SBarry Smith #if defined(PETSC_USE_REAL___FLOAT128)
1355c90a1750SBarry Smith   ierr = MPI_Type_free(&MPIU___FLOAT128);CHKERRQ(ierr);
13567c2de775SJed Brown #if defined(PETSC_HAVE_COMPLEX)
13578c764dc5SJose Roman   ierr = MPI_Type_free(&MPIU___COMPLEX128);CHKERRQ(ierr);
13588c764dc5SJose Roman #endif
1359d9822059SBarry Smith   ierr = MPI_Op_free(&MPIU_MAX);CHKERRQ(ierr);
1360d9822059SBarry Smith   ierr = MPI_Op_free(&MPIU_MIN);CHKERRQ(ierr);
1361c90a1750SBarry Smith #endif
1362c90a1750SBarry Smith 
13637c2de775SJed Brown #if defined(PETSC_HAVE_COMPLEX)
13642c876bd9SBarry Smith #if !defined(PETSC_HAVE_MPI_C_DOUBLE_COMPLEX)
1365500d8756SSatish Balay   ierr = MPI_Type_free(&MPIU_C_DOUBLE_COMPLEX);CHKERRQ(ierr);
1366500d8756SSatish Balay   ierr = MPI_Type_free(&MPIU_C_COMPLEX);CHKERRQ(ierr);
13672c876bd9SBarry Smith #endif
1368e5c89e4eSSatish Balay #endif
1369cca4cb22SSatish Balay 
13707c2de775SJed Brown #if (defined(PETSC_HAVE_COMPLEX) && !defined(PETSC_HAVE_MPI_C_DOUBLE_COMPLEX)) || defined(PETSC_USE_REAL___FLOAT128)
1371cca4cb22SSatish Balay   ierr = MPI_Op_free(&MPIU_SUM);CHKERRQ(ierr);
1372cca4cb22SSatish Balay #endif
1373cca4cb22SSatish Balay 
1374e5c89e4eSSatish Balay   ierr = MPI_Type_free(&MPIU_2SCALAR);CHKERRQ(ierr);
137544041f26SJed Brown #if defined(PETSC_USE_64BIT_INDICES) || !defined(MPI_2INT)
1376e5c89e4eSSatish Balay   ierr = MPI_Type_free(&MPIU_2INT);CHKERRQ(ierr);
137744041f26SJed Brown #endif
1378e5c89e4eSSatish Balay   ierr = MPI_Op_free(&PetscMaxSum_Op);CHKERRQ(ierr);
1379e5c89e4eSSatish Balay   ierr = MPI_Op_free(&PetscADMax_Op);CHKERRQ(ierr);
1380e5c89e4eSSatish Balay   ierr = MPI_Op_free(&PetscADMin_Op);CHKERRQ(ierr);
1381e5c89e4eSSatish Balay 
1382dbc8283eSBarry Smith   /*
1383efb80d3cSBarry Smith      Destroy any known inner MPI_Comm's and attributes pointing to them
1384efb80d3cSBarry Smith      Note this will not destroy any new communicators the user has created.
1385efb80d3cSBarry Smith 
1386efb80d3cSBarry Smith      If all PETSc objects were not destroyed those left over objects will have hanging references to
1387efb80d3cSBarry Smith      the MPI_Comms that were freed; but that is ok because those PETSc objects will never be used again
1388dbc8283eSBarry Smith  */
1389b770b1f6SSatish Balay   {
1390dbc8283eSBarry Smith     PetscCommCounter *counter;
1391dbc8283eSBarry Smith     PetscMPIInt      flg;
1392dbc8283eSBarry Smith     MPI_Comm         icomm;
1393265f3f35SJed Brown     union {MPI_Comm comm; void *ptr;} ucomm;
1394265f3f35SJed Brown     ierr = MPI_Attr_get(PETSC_COMM_SELF,Petsc_InnerComm_keyval,&ucomm,&flg);CHKERRQ(ierr);
1395dbc8283eSBarry Smith     if (flg) {
1396265f3f35SJed Brown       icomm = ucomm.comm;
1397dbc8283eSBarry Smith       ierr = MPI_Attr_get(icomm,Petsc_Counter_keyval,&counter,&flg);CHKERRQ(ierr);
1398dbc8283eSBarry 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");
1399dbc8283eSBarry Smith 
1400dbc8283eSBarry Smith       ierr = MPI_Attr_delete(PETSC_COMM_SELF,Petsc_InnerComm_keyval);CHKERRQ(ierr);
1401efb80d3cSBarry Smith       ierr = MPI_Attr_delete(icomm,Petsc_Counter_keyval);CHKERRQ(ierr);
1402efb80d3cSBarry Smith       ierr = MPI_Comm_free(&icomm);CHKERRQ(ierr);
1403dbc8283eSBarry Smith     }
1404265f3f35SJed Brown     ierr = MPI_Attr_get(PETSC_COMM_WORLD,Petsc_InnerComm_keyval,&ucomm,&flg);CHKERRQ(ierr);
1405dbc8283eSBarry Smith     if (flg) {
1406265f3f35SJed Brown       icomm = ucomm.comm;
1407dbc8283eSBarry Smith       ierr = MPI_Attr_get(icomm,Petsc_Counter_keyval,&counter,&flg);CHKERRQ(ierr);
1408dbc8283eSBarry 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");
1409dbc8283eSBarry Smith 
1410dbc8283eSBarry Smith       ierr = MPI_Attr_delete(PETSC_COMM_WORLD,Petsc_InnerComm_keyval);CHKERRQ(ierr);
1411efb80d3cSBarry Smith       ierr = MPI_Attr_delete(icomm,Petsc_Counter_keyval);CHKERRQ(ierr);
1412efb80d3cSBarry Smith       ierr = MPI_Comm_free(&icomm);CHKERRQ(ierr);
1413dbc8283eSBarry Smith     }
1414b770b1f6SSatish Balay   }
1415dbc8283eSBarry Smith 
1416480cf27aSJed Brown   ierr = MPI_Keyval_free(&Petsc_Counter_keyval);CHKERRQ(ierr);
1417480cf27aSJed Brown   ierr = MPI_Keyval_free(&Petsc_InnerComm_keyval);CHKERRQ(ierr);
1418480cf27aSJed Brown   ierr = MPI_Keyval_free(&Petsc_OuterComm_keyval);CHKERRQ(ierr);
1419480cf27aSJed Brown 
1420e5c89e4eSSatish Balay   if (PetscBeganMPI) {
142199608316SBarry Smith #if defined(PETSC_HAVE_MPI_FINALIZED)
142299b1327fSBarry Smith     PetscMPIInt flag;
142399b1327fSBarry Smith     ierr = MPI_Finalized(&flag);CHKERRQ(ierr);
1424e32f2f54SBarry Smith     if (flag) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_LIB,"MPI_Finalize() has already been called, even though MPI_Init() was called by PetscInitialize()");
142599608316SBarry Smith #endif
1426e5c89e4eSSatish Balay     ierr = MPI_Finalize();CHKERRQ(ierr);
1427e5c89e4eSSatish Balay   }
1428e5c89e4eSSatish Balay /*
1429e5c89e4eSSatish Balay 
1430e5c89e4eSSatish Balay      Note: In certain cases PETSC_COMM_WORLD is never MPI_Comm_free()ed because
1431e5c89e4eSSatish Balay    the communicator has some outstanding requests on it. Specifically if the
1432e5c89e4eSSatish Balay    flag PETSC_HAVE_BROKEN_REQUEST_FREE is set (for IBM MPI implementation). See
1433e5c89e4eSSatish Balay    src/vec/utils/vpscat.c. Due to this the memory allocated in PetscCommDuplicate()
1434e5c89e4eSSatish Balay    is never freed as it should be. Thus one may obtain messages of the form
14350e5e90baSSatish Balay    [ 1] 8 bytes PetscCommDuplicate() line 645 in src/sys/mpiu.c indicating the
1436e5c89e4eSSatish Balay    memory was not freed.
1437e5c89e4eSSatish Balay 
1438e5c89e4eSSatish Balay */
14391d1a0024SBarry Smith   ierr = PetscMallocClear();CHKERRQ(ierr);
1440a297a907SKarl Rupp 
1441e5c89e4eSSatish Balay   PetscInitializeCalled = PETSC_FALSE;
1442e5c89e4eSSatish Balay   PetscFinalizeCalled   = PETSC_TRUE;
1443e5c89e4eSSatish Balay   PetscFunctionReturn(ierr);
1444e5c89e4eSSatish Balay }
1445e5c89e4eSSatish Balay 
144643db4dbbSBarry Smith #if defined(PETSC_MISSING_LAPACK_lsame_)
14478cc058d9SJed Brown PETSC_EXTERN int lsame_(char *a,char *b)
144843db4dbbSBarry Smith {
144943db4dbbSBarry Smith   if (*a == *b) return 1;
145043db4dbbSBarry Smith   if (*a + 32 == *b) return 1;
145143db4dbbSBarry Smith   if (*a - 32 == *b) return 1;
145243db4dbbSBarry Smith   return 0;
145343db4dbbSBarry Smith }
1454a70650f6SBarry Smith #endif
145543db4dbbSBarry Smith 
145643db4dbbSBarry Smith #if defined(PETSC_MISSING_LAPACK_lsame)
14578cc058d9SJed Brown PETSC_EXTERN int lsame(char *a,char *b)
145843db4dbbSBarry Smith {
145943db4dbbSBarry Smith   if (*a == *b) return 1;
146043db4dbbSBarry Smith   if (*a + 32 == *b) return 1;
146143db4dbbSBarry Smith   if (*a - 32 == *b) return 1;
146243db4dbbSBarry Smith   return 0;
146343db4dbbSBarry Smith }
146443db4dbbSBarry Smith #endif
1465