xref: /petsc/src/sys/objects/pinit.c (revision f14045db5fd3d1c032aaffb2d88135b8c9a96cef)
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
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);
451051e4cf2SJed 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);
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;
57211525c0dSBarry Smith 
57311525c0dSBarry Smith     ierr = PetscOptionsHasName(NULL,"-saws_log",&flg);CHKERRQ(ierr);
57411525c0dSBarry Smith     if (flg) {
57511525c0dSBarry Smith       char  sawslog[PETSC_MAX_PATH_LEN];
57611525c0dSBarry Smith 
57711525c0dSBarry Smith       ierr = PetscOptionsGetString(NULL,"-saws_log",sawslog,PETSC_MAX_PATH_LEN,NULL);CHKERRQ(ierr);
57811525c0dSBarry Smith       if (sawslog[0]) {
57911525c0dSBarry Smith         PetscStackCallSAWs(SAWs_Set_Use_Logfile,(sawslog));
58011525c0dSBarry Smith       } else {
58111525c0dSBarry Smith         PetscStackCallSAWs(SAWs_Set_Use_Logfile,(NULL));
58211525c0dSBarry Smith       }
58311525c0dSBarry Smith     }
58411525c0dSBarry Smith     ierr = PetscOptionsGetString(NULL,"-saws_https",cert,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr);
58511525c0dSBarry Smith     if (flg) {
58611525c0dSBarry Smith       PetscStackCallSAWs(SAWs_Set_Use_HTTPS,(cert));
58711525c0dSBarry Smith     }
58811525c0dSBarry Smith     ierr = PetscOptionsGetInt(NULL,"-saws_port",&port,&flg);CHKERRQ(ierr);
58911525c0dSBarry Smith     if (flg) {
59011525c0dSBarry Smith       PetscStackCallSAWs(SAWs_Set_Port,(port));
59111525c0dSBarry Smith     }
59211525c0dSBarry Smith     ierr = PetscOptionsGetString(NULL,"-saws_root",root,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr);
59311525c0dSBarry Smith     if (flg) {
59411525c0dSBarry Smith       PetscStackCallSAWs(SAWs_Set_Document_Root,(root));CHKERRQ(ierr);
59511525c0dSBarry Smith       ierr = PetscStrcmp(root,".",&rootlocal);CHKERRQ(ierr);
59611525c0dSBarry Smith     }
59711525c0dSBarry Smith     ierr = PetscOptionsHasName(NULL,"-saws_local",&flg2);CHKERRQ(ierr);
59811525c0dSBarry Smith     if (flg2) {
59911525c0dSBarry Smith       char jsdir[PETSC_MAX_PATH_LEN];
60011525c0dSBarry Smith       if (!flg) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SUP,"-saws_local option requires -saws_root option");
60111525c0dSBarry Smith       ierr = PetscSNPrintf(jsdir,PETSC_MAX_PATH_LEN,"%s/js",root);CHKERRQ(ierr);
60211525c0dSBarry Smith       ierr = PetscTestDirectory(jsdir,'r',&flg);CHKERRQ(ierr);
60311525c0dSBarry Smith       if (!flg) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_FILE_READ,"-saws_local option requires js directory in root directory");
60443da4ab2SBarry Smith       PetscStackCallSAWs(SAWs_Push_Local_Header,());CHKERRQ(ierr);
60511525c0dSBarry Smith     }
60611525c0dSBarry Smith     ierr = PetscGetProgramName(programname,64);CHKERRQ(ierr);
60711525c0dSBarry Smith     ierr = PetscStrlen(help,&applinelen);CHKERRQ(ierr);
60811525c0dSBarry Smith     introlen   = 4096 + applinelen;
60911525c0dSBarry Smith     applinelen += 256;
61011525c0dSBarry Smith     ierr = PetscMalloc(applinelen,&appline);CHKERRQ(ierr);
61111525c0dSBarry Smith     ierr = PetscMalloc(introlen,&intro);CHKERRQ(ierr);
61211525c0dSBarry Smith 
61311525c0dSBarry Smith     if (rootlocal) {
61411525c0dSBarry Smith       ierr = PetscSNPrintf(appline,applinelen,"%s.c.html",programname);CHKERRQ(ierr);
61511525c0dSBarry Smith       ierr = PetscTestFile(appline,'r',&rootlocal);CHKERRQ(ierr);
61611525c0dSBarry Smith     }
61730befbd2SBarry Smith     ierr = PetscOptionsGetAll(&options);CHKERRQ(ierr);
61811525c0dSBarry Smith     if (rootlocal && help) {
61930befbd2SBarry 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);
62011525c0dSBarry Smith     } else if (help) {
62130befbd2SBarry Smith       ierr = PetscSNPrintf(appline,applinelen,"<center>Running %s %s</center><br><center><pre>%s</pre></center><br>\n",programname,options,help);
62211525c0dSBarry Smith     } else {
62330befbd2SBarry Smith       ierr = PetscSNPrintf(appline,applinelen,"<center> Running %s %s</center><br>\n",programname,options);
62411525c0dSBarry Smith     }
625b0bb5815SBarry Smith     ierr = PetscFree(options);CHKERRQ(ierr);
62630befbd2SBarry Smith     ierr = PetscGetVersion(version,sizeof(version));CHKERRQ(ierr);
62711525c0dSBarry Smith     ierr = PetscSNPrintf(intro,introlen,"<body>\n"
62811525c0dSBarry 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"
62930befbd2SBarry 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 at %s with %s</center><br>\n"
63030befbd2SBarry Smith                          "%s",version,petscconfigureruntime,petscconfigureoptions,appline);
63143da4ab2SBarry Smith     PetscStackCallSAWs(SAWs_Push_Body,("index.html",0,intro));
63211525c0dSBarry Smith     ierr = PetscFree(intro);CHKERRQ(ierr);
63311525c0dSBarry Smith     ierr = PetscFree(appline);CHKERRQ(ierr);
63411525c0dSBarry Smith     PetscStackCallSAWs(SAWs_Initialize,());
63511525c0dSBarry Smith     ierr = PetscCitationsRegister("@TechReport{ saws,"
63611525c0dSBarry Smith                                   "Author = {Matt Otten and Jed Brown and Barry Smith},"
63711525c0dSBarry Smith                                   "Title  = {Scientific Application Web Server (SAWs) Users Manual},"
63811525c0dSBarry Smith                                   "Institution = {Argonne National Laboratory},"
63911525c0dSBarry Smith                                   "Year   = 2013}",NULL);CHKERRQ(ierr);
64011525c0dSBarry Smith   }
64111525c0dSBarry Smith   PetscFunctionReturn(0);
64211525c0dSBarry Smith }
64311525c0dSBarry Smith #endif
64411525c0dSBarry Smith 
645793721a6SBarry Smith #undef __FUNCT__
646e5c89e4eSSatish Balay #define __FUNCT__ "PetscInitialize"
647e5c89e4eSSatish Balay /*@C
648e5c89e4eSSatish Balay    PetscInitialize - Initializes the PETSc database and MPI.
649e5c89e4eSSatish Balay    PetscInitialize() calls MPI_Init() if that has yet to be called,
650e5c89e4eSSatish Balay    so this routine should always be called near the beginning of
651e5c89e4eSSatish Balay    your program -- usually the very first line!
652e5c89e4eSSatish Balay 
653e5c89e4eSSatish Balay    Collective on MPI_COMM_WORLD or PETSC_COMM_WORLD if it has been set
654e5c89e4eSSatish Balay 
655e5c89e4eSSatish Balay    Input Parameters:
656e5c89e4eSSatish Balay +  argc - count of number of command line arguments
657e5c89e4eSSatish Balay .  args - the command line arguments
6580298fd71SBarry Smith .  file - [optional] PETSc database file, also checks ~username/.petscrc and .petscrc use NULL to not check for
659fc2bca9aSBarry Smith           code specific file. Use -skip_petscrc in the code specific file to skip the .petscrc files
6600298fd71SBarry Smith -  help - [optional] Help message to print, use NULL for no message
661e5c89e4eSSatish Balay 
66205827820SBarry Smith    If you wish PETSc code to run ONLY on a subcommunicator of MPI_COMM_WORLD, create that
66305827820SBarry Smith    communicator first and assign it to PETSC_COMM_WORLD BEFORE calling PetscInitialize(). Thus if you are running a
66405827820SBarry Smith    four process job and two processes will run PETSc and have PetscInitialize() and PetscFinalize() and two process will not,
66505827820SBarry Smith    then do this. If ALL processes in the job are using PetscInitialize() and PetscFinalize() then you don't need to do this, even
66605827820SBarry Smith    if different subcommunicators of the job are doing different things with PETSc.
667e5c89e4eSSatish Balay 
668e5c89e4eSSatish Balay    Options Database Keys:
669e5c89e4eSSatish Balay +  -start_in_debugger [noxterm,dbx,xdb,gdb,...] - Starts program in debugger
670e5c89e4eSSatish Balay .  -on_error_attach_debugger [noxterm,dbx,xdb,gdb,...] - Starts debugger when error detected
671e5c89e4eSSatish Balay .  -on_error_emacs <machinename> causes emacsclient to jump to error file
672b52f573bSBarry Smith .  -on_error_abort calls abort() when error detected (no traceback)
673e8fb0fc0SBarry Smith .  -on_error_mpiabort calls MPI_abort() when error detected
674e8fb0fc0SBarry Smith .  -error_output_stderr prints error messages to stderr instead of the default stdout
675e8fb0fc0SBarry Smith .  -error_output_none does not print the error messages (but handles errors in the same way as if this was not called)
676e5c89e4eSSatish Balay .  -debugger_nodes [node1,node2,...] - Indicates nodes to start in debugger
677e5c89e4eSSatish Balay .  -debugger_pause [sleeptime] (in seconds) - Pauses debugger
678e5c89e4eSSatish Balay .  -stop_for_debugger - Print message on how to attach debugger manually to
679e5c89e4eSSatish Balay                         process and wait (-debugger_pause) seconds for attachment
6802fb0ec9aSBarry Smith .  -malloc - Indicates use of PETSc error-checking malloc (on by default for debug version of libraries)
681e5c89e4eSSatish Balay .  -malloc no - Indicates not to use error-checking malloc
6822fb0ec9aSBarry Smith .  -malloc_debug - check for memory corruption at EVERY malloc or free
683aee23540SBarry Smith .  -malloc_dump - prints a list of all unfreed memory at the end of the run
684dc92acbaSJed Brown .  -malloc_test - like -malloc_dump -malloc_debug, but only active for debugging builds
685e5c89e4eSSatish Balay .  -fp_trap - Stops on floating point exceptions (Note that on the
686e5c89e4eSSatish Balay               IBM RS6000 this slows code by at least a factor of 10.)
687e5c89e4eSSatish Balay .  -no_signal_handler - Indicates not to trap error signals
688e5c89e4eSSatish Balay .  -shared_tmp - indicates /tmp directory is shared by all processors
689e5c89e4eSSatish Balay .  -not_shared_tmp - each processor has own /tmp
690e5c89e4eSSatish Balay .  -tmp - alternative name of /tmp directory
691e5c89e4eSSatish Balay .  -get_total_flops - returns total flops done by all processors
692142c234bSBarry Smith -  -memory_info - Print memory usage at end of run
693e5c89e4eSSatish Balay 
694e5c89e4eSSatish Balay    Options Database Keys for Profiling:
6950598bfebSBarry Smith    See the <a href="../../docs/manual.pdf#nameddest=ch_profiling">profiling chapter of the users manual</a> for details.
696495fc317SBarry Smith +  -info <optional filename> - Prints verbose information to the screen
697495fc317SBarry Smith .  -info_exclude <null,vec,mat,pc,ksp,snes,ts> - Excludes some of the verbose messages
698495fc317SBarry Smith .  -log_sync - Log the synchronization in scatters, inner products and norms
699495fc317SBarry Smith .  -log_trace [filename] - Print traces of all PETSc calls to the screen (useful to determine where a program
700e5c89e4eSSatish Balay         hangs without running in the debugger).  See PetscLogTraceBegin().
701495fc317SBarry Smith .  -log_summary [filename] - Prints summary of flop and timing information to screen. If the filename is specified the
702495fc317SBarry Smith         summary is written to the file.  See PetscLogView().
703495fc317SBarry Smith .  -log_all [filename] - Logs extensive profiling information  See PetscLogDump().
704495fc317SBarry Smith .  -log [filename] - Logs basic profiline information  See PetscLogDump().
705495fc317SBarry Smith -  -log_mpe [filename] - Creates a logfile viewable by the utility Jumpshot (in MPICH distribution)
706495fc317SBarry Smith 
707495fc317SBarry Smith     Only one of -log_trace, -log_summary, -log_all, -log, or -log_mpe may be used at a time
708e5c89e4eSSatish Balay 
709e5c89e4eSSatish Balay    Environmental Variables:
710e5c89e4eSSatish Balay +   PETSC_TMP - alternative tmp directory
711e5c89e4eSSatish Balay .   PETSC_SHARED_TMP - tmp is shared by all processes
712e5c89e4eSSatish Balay .   PETSC_NOT_SHARED_TMP - each process has its own private tmp
713e5c89e4eSSatish Balay .   PETSC_VIEWER_SOCKET_PORT - socket number to use for socket viewer
714e5c89e4eSSatish Balay -   PETSC_VIEWER_SOCKET_MACHINE - machine to use for socket viewer to connect to
715e5c89e4eSSatish Balay 
716e5c89e4eSSatish Balay 
717e5c89e4eSSatish Balay    Level: beginner
718e5c89e4eSSatish Balay 
719e5c89e4eSSatish Balay    Notes:
720e5c89e4eSSatish Balay    If for some reason you must call MPI_Init() separately, call
721e5c89e4eSSatish Balay    it before PetscInitialize().
722e5c89e4eSSatish Balay 
723e5c89e4eSSatish Balay    Fortran Version:
724e5c89e4eSSatish Balay    In Fortran this routine has the format
725e5c89e4eSSatish Balay $       call PetscInitialize(file,ierr)
726e5c89e4eSSatish Balay 
727e5c89e4eSSatish Balay +   ierr - error return code
7280298fd71SBarry Smith -  file - [optional] PETSc database file, also checks ~username/.petscrc and .petscrc use NULL_CHARACTER to not check for
729fc2bca9aSBarry Smith           code specific file. Use -skip_petscrc in the code specific file to skip the .petscrc files
730e5c89e4eSSatish Balay 
731e5c89e4eSSatish Balay    Important Fortran Note:
7320298fd71SBarry Smith    In Fortran, you MUST use NULL_CHARACTER to indicate a
7330298fd71SBarry Smith    null character string; you CANNOT just use NULL as
7340598bfebSBarry Smith    in the C version. See the <a href="../../docs/manual.pdf">users manual</a> for details.
735e5c89e4eSSatish Balay 
73601cb0274SBarry Smith    If your main program is C but you call Fortran code that also uses PETSc you need to call PetscInitializeFortran() soon after
73701cb0274SBarry Smith    calling PetscInitialize().
738e5c89e4eSSatish Balay 
739e5c89e4eSSatish Balay    Concepts: initializing PETSc
740e5c89e4eSSatish Balay 
74101cb0274SBarry Smith .seealso: PetscFinalize(), PetscInitializeFortran(), PetscGetArgs(), PetscInitializeNoArguments()
742e5c89e4eSSatish Balay 
743e5c89e4eSSatish Balay @*/
7447087cfbeSBarry Smith PetscErrorCode  PetscInitialize(int *argc,char ***args,const char file[],const char help[])
745e5c89e4eSSatish Balay {
746e5c89e4eSSatish Balay   PetscErrorCode ierr;
7474bb5149bSJed Brown   PetscMPIInt    flag, size;
748ace3abfcSBarry Smith   PetscBool      flg;
749e5c89e4eSSatish Balay   char           hostname[256];
750e5c89e4eSSatish Balay 
751e5c89e4eSSatish Balay   PetscFunctionBegin;
752e5c89e4eSSatish Balay   if (PetscInitializeCalled) PetscFunctionReturn(0);
753e5c89e4eSSatish Balay 
754ae9b4142SLisandro Dalcin   /* these must be initialized in a routine, not as a constant declaration*/
755d89683f4Sbcordonn   PETSC_STDOUT = stdout;
756ae9b4142SLisandro Dalcin   PETSC_STDERR = stderr;
757e5c89e4eSSatish Balay 
758e5c89e4eSSatish Balay   ierr = PetscOptionsCreate();CHKERRQ(ierr);
759e5c89e4eSSatish Balay 
760e5c89e4eSSatish Balay   /*
761e5c89e4eSSatish Balay      We initialize the program name here (before MPI_Init()) because MPICH has a bug in
762e5c89e4eSSatish Balay      it that it sets args[0] on all processors to be args[0] on the first processor.
763e5c89e4eSSatish Balay   */
764e5c89e4eSSatish Balay   if (argc && *argc) {
765e5c89e4eSSatish Balay     ierr = PetscSetProgramName(**args);CHKERRQ(ierr);
766e5c89e4eSSatish Balay   } else {
767e5c89e4eSSatish Balay     ierr = PetscSetProgramName("Unknown Name");CHKERRQ(ierr);
768e5c89e4eSSatish Balay   }
769e5c89e4eSSatish Balay 
770e5c89e4eSSatish Balay   ierr = MPI_Initialized(&flag);CHKERRQ(ierr);
771e5c89e4eSSatish Balay   if (!flag) {
772e32f2f54SBarry 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");
7735e765c61SJed Brown #if defined(PETSC_HAVE_MPI_INIT_THREAD)
7745e765c61SJed Brown     {
7755e765c61SJed Brown       PetscMPIInt provided;
7765e765c61SJed Brown       ierr = MPI_Init_thread(argc,args,MPI_THREAD_FUNNELED,&provided);CHKERRQ(ierr);
7775e765c61SJed Brown     }
7785e765c61SJed Brown #else
779e5c89e4eSSatish Balay     ierr = MPI_Init(argc,args);CHKERRQ(ierr);
7805e765c61SJed Brown #endif
781e5c89e4eSSatish Balay     PetscBeganMPI = PETSC_TRUE;
782e5c89e4eSSatish Balay   }
783e5c89e4eSSatish Balay   if (argc && args) {
784e5c89e4eSSatish Balay     PetscGlobalArgc = *argc;
785e5c89e4eSSatish Balay     PetscGlobalArgs = *args;
786e5c89e4eSSatish Balay   }
787e5c89e4eSSatish Balay   PetscFinalizeCalled = PETSC_FALSE;
788e5c89e4eSSatish Balay 
789a297a907SKarl Rupp   if (PETSC_COMM_WORLD == MPI_COMM_NULL) PETSC_COMM_WORLD = MPI_COMM_WORLD;
790d54338ecSKarl Rupp   ierr = MPI_Comm_set_errhandler(PETSC_COMM_WORLD,MPI_ERRORS_RETURN);CHKERRQ(ierr);
791e5c89e4eSSatish Balay 
792e5c89e4eSSatish Balay   /* Done after init due to a bug in MPICH-GM? */
793e5c89e4eSSatish Balay   ierr = PetscErrorPrintfInitialize();CHKERRQ(ierr);
794e5c89e4eSSatish Balay 
795e5c89e4eSSatish Balay   ierr = MPI_Comm_rank(MPI_COMM_WORLD,&PetscGlobalRank);CHKERRQ(ierr);
796e5c89e4eSSatish Balay   ierr = MPI_Comm_size(MPI_COMM_WORLD,&PetscGlobalSize);CHKERRQ(ierr);
797e5c89e4eSSatish Balay 
7988ad47952SJed Brown   MPIU_BOOL = MPI_INT;
7998ad47952SJed Brown   MPIU_ENUM = MPI_INT;
8008ad47952SJed Brown 
801e5c89e4eSSatish Balay   /*
802e5c89e4eSSatish Balay      Initialized the global complex variable; this is because with
803e5c89e4eSSatish Balay      shared libraries the constructors for global variables
804e5c89e4eSSatish Balay      are not called; at least on IRIX.
805e5c89e4eSSatish Balay   */
806886cfec0SSatish Balay #if defined(PETSC_HAVE_COMPLEX)
807e5c89e4eSSatish Balay   {
808a24ee22aSSatish Balay #if defined(PETSC_CLANGUAGE_CXX)
80950f81f78SJed Brown     PetscComplex ic(0.0,1.0);
810e5c89e4eSSatish Balay     PETSC_i = ic;
811a24ee22aSSatish Balay #elif defined(PETSC_CLANGUAGE_C)
81250f81f78SJed Brown     PETSC_i = _Complex_I;
813b7940d39SSatish Balay #endif
814762437b8SSatish Balay   }
815762437b8SSatish Balay 
8162c876bd9SBarry Smith #if !defined(PETSC_HAVE_MPI_C_DOUBLE_COMPLEX)
817e69cd0e6SSatish Balay   ierr = MPI_Type_contiguous(2,MPI_DOUBLE,&MPIU_C_DOUBLE_COMPLEX);CHKERRQ(ierr);
818500d8756SSatish Balay   ierr = MPI_Type_commit(&MPIU_C_DOUBLE_COMPLEX);CHKERRQ(ierr);
819500d8756SSatish Balay   ierr = MPI_Type_contiguous(2,MPI_FLOAT,&MPIU_C_COMPLEX);CHKERRQ(ierr);
820500d8756SSatish Balay   ierr = MPI_Type_commit(&MPIU_C_COMPLEX);CHKERRQ(ierr);
8212c876bd9SBarry Smith #endif
822886cfec0SSatish Balay #endif /* PETSC_HAVE_COMPLEX */
823e5c89e4eSSatish Balay 
824e5c89e4eSSatish Balay   /*
825e5c89e4eSSatish Balay      Create the PETSc MPI reduction operator that sums of the first
826e5c89e4eSSatish Balay      half of the entries and maxes the second half.
827e5c89e4eSSatish Balay   */
828e5c89e4eSSatish Balay   ierr = MPI_Op_create(PetscMaxSum_Local,1,&PetscMaxSum_Op);CHKERRQ(ierr);
829e5c89e4eSSatish Balay 
830ce63c4c1SBarry Smith #if defined(PETSC_USE_REAL___FLOAT128)
831c90a1750SBarry Smith   ierr = MPI_Type_contiguous(2,MPI_DOUBLE,&MPIU___FLOAT128);CHKERRQ(ierr);
832c90a1750SBarry Smith   ierr = MPI_Type_commit(&MPIU___FLOAT128);CHKERRQ(ierr);
8337c2de775SJed Brown #if defined(PETSC_HAVE_COMPLEX)
8348c764dc5SJose Roman   ierr = MPI_Type_contiguous(4,MPI_DOUBLE,&MPIU___COMPLEX128);CHKERRQ(ierr);
8358c764dc5SJose Roman   ierr = MPI_Type_commit(&MPIU___COMPLEX128);CHKERRQ(ierr);
8368c764dc5SJose Roman #endif
837d9822059SBarry Smith   ierr = MPI_Op_create(PetscMax_Local,1,&MPIU_MAX);CHKERRQ(ierr);
838d9822059SBarry Smith   ierr = MPI_Op_create(PetscMin_Local,1,&MPIU_MIN);CHKERRQ(ierr);
839c90a1750SBarry Smith #endif
840c90a1750SBarry Smith 
8417c2de775SJed Brown #if (defined(PETSC_HAVE_COMPLEX) && !defined(PETSC_HAVE_MPI_C_DOUBLE_COMPLEX)) || defined(PETSC_USE_REAL___FLOAT128)
842cca4cb22SSatish Balay   ierr = MPI_Op_create(PetscSum_Local,1,&MPIU_SUM);CHKERRQ(ierr);
843cca4cb22SSatish Balay #endif
844cca4cb22SSatish Balay 
845e5c89e4eSSatish Balay   ierr = MPI_Type_contiguous(2,MPIU_SCALAR,&MPIU_2SCALAR);CHKERRQ(ierr);
846e5c89e4eSSatish Balay   ierr = MPI_Type_commit(&MPIU_2SCALAR);CHKERRQ(ierr);
847e5c89e4eSSatish Balay   ierr = MPI_Op_create(PetscADMax_Local,1,&PetscADMax_Op);CHKERRQ(ierr);
848e5c89e4eSSatish Balay   ierr = MPI_Op_create(PetscADMin_Local,1,&PetscADMin_Op);CHKERRQ(ierr);
849e5c89e4eSSatish Balay 
85044041f26SJed Brown #if defined(PETSC_USE_64BIT_INDICES) || !defined(MPI_2INT)
851e5c89e4eSSatish Balay   ierr = MPI_Type_contiguous(2,MPIU_INT,&MPIU_2INT);CHKERRQ(ierr);
852e5c89e4eSSatish Balay   ierr = MPI_Type_commit(&MPIU_2INT);CHKERRQ(ierr);
85344041f26SJed Brown #endif
854e5c89e4eSSatish Balay 
855ec957eceSBarry Smith 
856e5c89e4eSSatish Balay   /*
857480cf27aSJed Brown      Attributes to be set on PETSc communicators
858480cf27aSJed Brown   */
859480cf27aSJed Brown   ierr = MPI_Keyval_create(MPI_NULL_COPY_FN,Petsc_DelCounter,&Petsc_Counter_keyval,(void*)0);CHKERRQ(ierr);
860da3039f7SJed Brown   ierr = MPI_Keyval_create(MPI_NULL_COPY_FN,Petsc_DelComm_Outer,&Petsc_InnerComm_keyval,(void*)0);CHKERRQ(ierr);
861da3039f7SJed Brown   ierr = MPI_Keyval_create(MPI_NULL_COPY_FN,Petsc_DelComm_Inner,&Petsc_OuterComm_keyval,(void*)0);CHKERRQ(ierr);
862480cf27aSJed Brown 
863480cf27aSJed Brown   /*
864e8fb0fc0SBarry Smith      Build the options database
865e5c89e4eSSatish Balay   */
866e5c89e4eSSatish Balay   ierr = PetscOptionsInsert(argc,args,file);CHKERRQ(ierr);
867e5c89e4eSSatish Balay 
8686dc8fec2Sbcordonn 
869e5c89e4eSSatish Balay   /*
870e5c89e4eSSatish Balay      Print main application help message
871e5c89e4eSSatish Balay   */
8720298fd71SBarry Smith   ierr = PetscOptionsHasName(NULL,"-help",&flg);CHKERRQ(ierr);
873e5c89e4eSSatish Balay   if (help && flg) {
874e5c89e4eSSatish Balay     ierr = PetscPrintf(PETSC_COMM_WORLD,help);CHKERRQ(ierr);
875e5c89e4eSSatish Balay   }
876e5c89e4eSSatish Balay   ierr = PetscOptionsCheckInitial_Private();CHKERRQ(ierr);
877e5c89e4eSSatish Balay 
878d45a07a7SBarry Smith   ierr = PetscCitationsInitialize();CHKERRQ(ierr);
879d45a07a7SBarry Smith 
880e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS)
88111525c0dSBarry Smith   ierr = PetscInitializeSAWs(help);CHKERRQ(ierr);
882f4202a44SBarry Smith #endif
883f4202a44SBarry Smith 
884e5c89e4eSSatish Balay   /* SHOULD PUT IN GUARDS: Make sure logging is initialized, even if we do not print it out */
885a9f03627SSatish Balay #if defined(PETSC_USE_LOG)
886e5c89e4eSSatish Balay   ierr = PetscLogBegin_Private();CHKERRQ(ierr);
887a9f03627SSatish Balay #endif
888e5c89e4eSSatish Balay 
889e5c89e4eSSatish Balay   /*
890e5c89e4eSSatish Balay      Load the dynamic libraries (on machines that support them), this registers all
891e5c89e4eSSatish Balay      the solvers etc. (On non-dynamic machines this initializes the PetscDraw and PetscViewer classes)
892e5c89e4eSSatish Balay   */
893e5c89e4eSSatish Balay   ierr = PetscInitialize_DynamicLibraries();CHKERRQ(ierr);
894e5c89e4eSSatish Balay 
895e5c89e4eSSatish Balay   ierr = MPI_Comm_size(PETSC_COMM_WORLD,&size);CHKERRQ(ierr);
896ae15b995SBarry Smith   ierr = PetscInfo1(0,"PETSc successfully started: number of processors = %d\n",size);CHKERRQ(ierr);
897e5c89e4eSSatish Balay   ierr = PetscGetHostName(hostname,256);CHKERRQ(ierr);
898ae15b995SBarry Smith   ierr = PetscInfo1(0,"Running on machine: %s\n",hostname);CHKERRQ(ierr);
899e5c89e4eSSatish Balay 
900e5c89e4eSSatish Balay   ierr = PetscOptionsCheckInitial_Components();CHKERRQ(ierr);
901ef6c6fedSBoyana Norris   /* Check the options database for options related to the options database itself */
902ef6c6fedSBoyana Norris   ierr = PetscOptionsSetFromOptions();CHKERRQ(ierr);
903ef6c6fedSBoyana Norris 
904951e3c8eSBarry Smith #if defined(PETSC_USE_PETSC_MPI_EXTERNAL32)
905e39fd77fSBarry Smith   /*
906e39fd77fSBarry Smith       Tell MPI about our own data representation converter, this would/should be used if extern32 is not supported by the MPI
907e39fd77fSBarry Smith 
908e39fd77fSBarry Smith       Currently not used because it is not supported by MPICH.
909e39fd77fSBarry Smith   */
910e39fd77fSBarry Smith #if !defined(PETSC_WORDS_BIGENDIAN)
9110298fd71SBarry Smith   ierr = MPI_Register_datarep((char*)"petsc",PetscDataRep_read_conv_fn,PetscDataRep_write_conv_fn,PetscDataRep_extent_fn,NULL);CHKERRQ(ierr);
912e39fd77fSBarry Smith #endif
913951e3c8eSBarry Smith #endif
914e39fd77fSBarry Smith 
91535d88935SVictor Minden #if defined(PETSC_HAVE_CUDA)
91620e2c332SMatthew G. Knepley   flg  = PETSC_TRUE;
91720e2c332SMatthew G. Knepley   ierr = PetscOptionsGetBool(NULL,"-cublas",&flg,NULL);CHKERRQ(ierr);
91820e2c332SMatthew G. Knepley   if (flg) {
9194bb5149bSJed Brown     PetscMPIInt p;
920663ba86aSMatthew G Knepley     for (p = 0; p < PetscGlobalSize; ++p) {
921a297a907SKarl Rupp       if (p == PetscGlobalRank) cublasInit();
922663ba86aSMatthew G Knepley       ierr = MPI_Barrier(PETSC_COMM_WORLD);CHKERRQ(ierr);
923663ba86aSMatthew G Knepley     }
9244bb5149bSJed Brown   }
9253e39abd9SVictor Minden #endif
92692e62aa6SBarry Smith 
9270298fd71SBarry Smith   ierr = PetscOptionsHasName(NULL,"-python",&flg);CHKERRQ(ierr);
9289ac80d5eSLisandro Dalcin   if (flg) {
9299ac80d5eSLisandro Dalcin     PetscInitializeCalled = PETSC_TRUE;
9300298fd71SBarry Smith     ierr = PetscPythonInitialize(NULL,NULL);CHKERRQ(ierr);
9319ac80d5eSLisandro Dalcin   }
9329ac80d5eSLisandro Dalcin 
933607a6623SBarry Smith   ierr = PetscThreadCommInitializePackage();CHKERRQ(ierr);
934bd8b14e7SShri Abhyankar 
93541c0b4b3SShri Abhyankar   /*
93641c0b4b3SShri Abhyankar       Setup building of stack frames for all function calls
93741c0b4b3SShri Abhyankar   */
93876386721SLisandro Dalcin   PetscThreadLocalRegister((PetscThreadKey*)&petscstack); /* Creates pthread_key */
939e1167bb9SShri Abhyankar #if defined(PETSC_USE_DEBUG)
940e1167bb9SShri Abhyankar   ierr = PetscStackCreate();CHKERRQ(ierr);
941e1167bb9SShri Abhyankar #endif
942e1167bb9SShri Abhyankar 
9432d53ad75SBarry Smith #if defined(PETSC_SERIALIZE_FUNCTIONS)
9442d53ad75SBarry Smith   ierr = PetscFPTCreate(10000);CHKERRQ(ierr);
9452d53ad75SBarry Smith #endif
9462d53ad75SBarry Smith 
947dff31646SBarry Smith 
948301d30feSBarry Smith   /*
949301d30feSBarry Smith       Once we are completedly initialized then we can set this variables
950301d30feSBarry Smith   */
951301d30feSBarry Smith   PetscInitializeCalled = PETSC_TRUE;
952301d30feSBarry Smith   PetscFunctionReturn(0);
953e5c89e4eSSatish Balay }
954e5c89e4eSSatish Balay 
9554097062eSBarry Smith #if defined(PETSC_USE_LOG)
9562eff7a51SBarry Smith extern PetscObject *PetscObjects;
9572eff7a51SBarry Smith extern PetscInt    PetscObjectsCounts, PetscObjectsMaxCounts;
9584097062eSBarry Smith #endif
959e5c89e4eSSatish Balay 
960e5c89e4eSSatish Balay #undef __FUNCT__
961e5c89e4eSSatish Balay #define __FUNCT__ "PetscFinalize"
962e5c89e4eSSatish Balay /*@C
963e5c89e4eSSatish Balay    PetscFinalize - Checks for options to be called at the conclusion
964e5c89e4eSSatish Balay    of the program. MPI_Finalize() is called only if the user had not
965e5c89e4eSSatish Balay    called MPI_Init() before calling PetscInitialize().
966e5c89e4eSSatish Balay 
967e5c89e4eSSatish Balay    Collective on PETSC_COMM_WORLD
968e5c89e4eSSatish Balay 
969e5c89e4eSSatish Balay    Options Database Keys:
97088c29154SBarry Smith +  -options_table - Calls PetscOptionsView()
971e5c89e4eSSatish Balay .  -options_left - Prints unused options that remain in the database
9727eb1d149SBarry 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
973e5c89e4eSSatish Balay .  -mpidump - Calls PetscMPIDump()
974e5c89e4eSSatish Balay .  -malloc_dump - Calls PetscMallocDump()
975e5c89e4eSSatish Balay .  -malloc_info - Prints total memory usage
976e5c89e4eSSatish Balay -  -malloc_log - Prints summary of memory usage
977e5c89e4eSSatish Balay 
978e5c89e4eSSatish Balay    Level: beginner
979e5c89e4eSSatish Balay 
980e5c89e4eSSatish Balay    Note:
981e5c89e4eSSatish Balay    See PetscInitialize() for more general runtime options.
982e5c89e4eSSatish Balay 
98388c29154SBarry Smith .seealso: PetscInitialize(), PetscOptionsView(), PetscMallocDump(), PetscMPIDump(), PetscEnd()
984e5c89e4eSSatish Balay @*/
9857087cfbeSBarry Smith PetscErrorCode  PetscFinalize(void)
986e5c89e4eSSatish Balay {
987e5c89e4eSSatish Balay   PetscErrorCode ierr;
9884bb5149bSJed Brown   PetscMPIInt    rank;
989a8d2bbe5SBarry Smith   PetscInt       nopt;
9902bf49c77SBarry Smith   PetscBool      flg1 = PETSC_FALSE,flg2 = PETSC_FALSE,flg3 = PETSC_FALSE;
991dff31646SBarry Smith   PetscBool      flg;
99210463e74SBarry Smith #if defined(PETSC_USE_LOG)
99310463e74SBarry Smith   char           mname[PETSC_MAX_PATH_LEN];
99410463e74SBarry Smith #endif
995e5c89e4eSSatish Balay 
996e5c89e4eSSatish Balay   PetscFunctionBegin;
997e5c89e4eSSatish Balay   if (!PetscInitializeCalled) {
9984b09e917SBarry Smith     printf("PetscInitialize() must be called before PetscFinalize()\n");
9994b09e917SBarry Smith     PetscFunctionReturn(PETSC_ERR_ARG_WRONGSTATE);
1000e5c89e4eSSatish Balay   }
10010298fd71SBarry Smith   ierr = PetscInfo(NULL,"PetscFinalize() called\n");CHKERRQ(ierr);
1002b022a5c1SBarry Smith 
10031f817a21SBarry Smith   ierr = MPI_Comm_rank(PETSC_COMM_WORLD,&rank);CHKERRQ(ierr);
10041f817a21SBarry Smith 
10051f817a21SBarry Smith   ierr = PetscOptionsHasName(NULL,"-citations",&flg);CHKERRQ(ierr);
1006dff31646SBarry Smith   if (flg) {
10071f817a21SBarry Smith     char  *cits, filename[PETSC_MAX_PATH_LEN];
10081f817a21SBarry Smith     FILE  *fd = PETSC_STDOUT;
10091f817a21SBarry Smith 
10101f817a21SBarry Smith     ierr = PetscOptionsGetString(NULL,"-citations",filename,PETSC_MAX_PATH_LEN,NULL);CHKERRQ(ierr);
10111f817a21SBarry Smith     if (filename[0]) {
10121f817a21SBarry Smith       ierr = PetscFOpen(PETSC_COMM_WORLD,filename,"w",&fd);CHKERRQ(ierr);
10131f817a21SBarry Smith     }
1014dff31646SBarry Smith     ierr = PetscSegBufferGet(PetscCitationsList,1,&cits);CHKERRQ(ierr);
1015dff31646SBarry Smith     cits[0] = 0;
1016dff31646SBarry Smith     ierr = PetscSegBufferExtractAlloc(PetscCitationsList,&cits);CHKERRQ(ierr);
10171f817a21SBarry Smith     ierr = PetscFPrintf(PETSC_COMM_WORLD,fd,"If you publish results based on this computation please cite the following:\n");CHKERRQ(ierr);
10181f817a21SBarry Smith     ierr = PetscFPrintf(PETSC_COMM_WORLD,fd,"===========================================================================\n");CHKERRQ(ierr);
10191f817a21SBarry Smith     ierr = PetscFPrintf(PETSC_COMM_WORLD,fd,"%s",cits);CHKERRQ(ierr);
10201f817a21SBarry Smith     ierr = PetscFPrintf(PETSC_COMM_WORLD,fd,"===========================================================================\n");CHKERRQ(ierr);
10211f817a21SBarry Smith     ierr = PetscFClose(PETSC_COMM_WORLD,fd);CHKERRQ(ierr);
1022dff31646SBarry Smith     ierr = PetscFree(cits);CHKERRQ(ierr);
1023dff31646SBarry Smith   }
1024dff31646SBarry Smith   ierr = PetscSegBufferDestroy(&PetscCitationsList);CHKERRQ(ierr);
1025dff31646SBarry Smith 
10262d53ad75SBarry Smith #if defined(PETSC_SERIALIZE_FUNCTIONS)
10272d53ad75SBarry Smith   ierr = PetscFPTDestroy();CHKERRQ(ierr);
10282d53ad75SBarry Smith #endif
10292d53ad75SBarry Smith 
10302d53ad75SBarry Smith 
1031e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS)
1032dff31646SBarry Smith   flg = PETSC_FALSE;
1033e78c4b8cSBarry Smith   ierr = PetscOptionsGetBool(NULL,"-saw_options",&flg,NULL);CHKERRQ(ierr);
1034d5649816SBarry Smith   if (flg) {
1035e04113cfSBarry Smith     ierr = PetscOptionsSAWsDestroy();CHKERRQ(ierr);
1036d5649816SBarry Smith   }
1037d5649816SBarry Smith #endif
1038d5649816SBarry Smith 
1039681455b2SBarry Smith #if defined(PETSC_HAVE_X)
1040681455b2SBarry Smith   flg1 = PETSC_FALSE;
1041681455b2SBarry Smith   ierr = PetscOptionsGetBool(NULL,"-x_virtual",&flg1,NULL);CHKERRQ(ierr);
1042681455b2SBarry Smith   if (flg1) {
1043681455b2SBarry Smith     /*  this is a crude hack, but better than nothing */
1044681455b2SBarry Smith     ierr = PetscPOpen(PETSC_COMM_WORLD,NULL,"pkill -9 Xvfb","r",NULL);CHKERRQ(ierr);
1045681455b2SBarry Smith   }
1046681455b2SBarry Smith #endif
1047681455b2SBarry Smith 
10480298fd71SBarry Smith   ierr = PetscOptionsGetBool(NULL,"-malloc_info",&flg2,NULL);CHKERRQ(ierr);
1049e5c89e4eSSatish Balay   if (!flg2) {
105090d69ab7SBarry Smith     flg2 = PETSC_FALSE;
10510298fd71SBarry Smith     ierr = PetscOptionsGetBool(NULL,"-memory_info",&flg2,NULL);CHKERRQ(ierr);
1052e5c89e4eSSatish Balay   }
1053e5c89e4eSSatish Balay   if (flg2) {
1054e5c89e4eSSatish Balay     ierr = PetscMemoryShowUsage(PETSC_VIEWER_STDOUT_WORLD,"Summary of Memory Usage in PETSc\n");CHKERRQ(ierr);
1055e5c89e4eSSatish Balay   }
1056e5c89e4eSSatish Balay 
1057e5c89e4eSSatish Balay #if defined(PETSC_USE_LOG)
105890d69ab7SBarry Smith   flg1 = PETSC_FALSE;
10590298fd71SBarry Smith   ierr = PetscOptionsGetBool(NULL,"-get_total_flops",&flg1,NULL);CHKERRQ(ierr);
1060e5c89e4eSSatish Balay   if (flg1) {
1061e5c89e4eSSatish Balay     PetscLogDouble flops = 0;
1062205a32c2SJed Brown     ierr = MPI_Reduce(&petsc_TotalFlops,&flops,1,MPI_DOUBLE,MPI_SUM,0,PETSC_COMM_WORLD);CHKERRQ(ierr);
1063e5c89e4eSSatish Balay     ierr = PetscPrintf(PETSC_COMM_WORLD,"Total flops over all processors %g\n",flops);CHKERRQ(ierr);
1064e5c89e4eSSatish Balay   }
1065e5c89e4eSSatish Balay #endif
1066e5c89e4eSSatish Balay 
1067e5c89e4eSSatish Balay 
1068e5c89e4eSSatish Balay #if defined(PETSC_USE_LOG)
1069e5c89e4eSSatish Balay #if defined(PETSC_HAVE_MPE)
1070e5c89e4eSSatish Balay   mname[0] = 0;
1071a297a907SKarl Rupp 
10720298fd71SBarry Smith   ierr = PetscOptionsGetString(NULL,"-log_mpe",mname,PETSC_MAX_PATH_LEN,&flg1);CHKERRQ(ierr);
1073e5c89e4eSSatish Balay   if (flg1) {
1074e5c89e4eSSatish Balay     if (mname[0]) {ierr = PetscLogMPEDump(mname);CHKERRQ(ierr);}
1075e5c89e4eSSatish Balay     else          {ierr = PetscLogMPEDump(0);CHKERRQ(ierr);}
1076e5c89e4eSSatish Balay   }
1077e5c89e4eSSatish Balay #endif
1078e5c89e4eSSatish Balay   mname[0] = 0;
1079a297a907SKarl Rupp 
1080*f14045dbSBarry Smith   ierr = PetscLogViewFromOptions();CHKERRQ(ierr);
10810298fd71SBarry Smith   ierr = PetscOptionsGetString(NULL,"-log_summary",mname,PETSC_MAX_PATH_LEN,&flg1);CHKERRQ(ierr);
1082e5c89e4eSSatish Balay   if (flg1) {
108391eabc43SBarry Smith     PetscViewer viewer;
108491eabc43SBarry Smith     if (mname[0]) {
108591eabc43SBarry Smith       ierr = PetscViewerASCIIOpen(PETSC_COMM_WORLD,mname,&viewer);CHKERRQ(ierr);
108691eabc43SBarry Smith       ierr = PetscLogView(viewer);CHKERRQ(ierr);
10876bf464f9SBarry Smith       ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr);
108833f85c2fSBarry Smith     } else {
108933f85c2fSBarry Smith       viewer = PETSC_VIEWER_STDOUT_WORLD;
109033f85c2fSBarry Smith       ierr   = PetscLogView(viewer);CHKERRQ(ierr);
109133f85c2fSBarry Smith     }
1092e5c89e4eSSatish Balay   }
1093e5c89e4eSSatish Balay   mname[0] = 0;
1094a297a907SKarl Rupp 
10950298fd71SBarry Smith   ierr = PetscOptionsGetString(NULL,"-log_all",mname,PETSC_MAX_PATH_LEN,&flg1);CHKERRQ(ierr);
10960298fd71SBarry Smith   ierr = PetscOptionsGetString(NULL,"-log",mname,PETSC_MAX_PATH_LEN,&flg2);CHKERRQ(ierr);
1097e5c89e4eSSatish Balay   if (flg1 || flg2) {
1098e5c89e4eSSatish Balay     if (mname[0]) PetscLogDump(mname);
1099e5c89e4eSSatish Balay     else          PetscLogDump(0);
1100e5c89e4eSSatish Balay   }
1101e5c89e4eSSatish Balay #endif
110210463e74SBarry Smith 
1103b58ca069SBarry Smith   /*
1104b58ca069SBarry Smith      Free all objects registered with PetscObjectRegisterDestroy() such as PETSC_VIEWER_XXX_().
1105b58ca069SBarry Smith   */
1106b58ca069SBarry Smith   ierr = PetscObjectRegisterDestroyAll();CHKERRQ(ierr);
1107b58ca069SBarry Smith 
110833f85c2fSBarry Smith   ierr = PetscStackDestroy();CHKERRQ(ierr);
110976386721SLisandro Dalcin   PetscThreadLocalDestroy((PetscThreadKey)petscstack); /* Deletes pthread_key */
111010463e74SBarry Smith 
111190d69ab7SBarry Smith   flg1 = PETSC_FALSE;
11120298fd71SBarry Smith   ierr = PetscOptionsGetBool(NULL,"-no_signal_handler",&flg1,NULL);CHKERRQ(ierr);
1113e5c89e4eSSatish Balay   if (!flg1) { ierr = PetscPopSignalHandler();CHKERRQ(ierr);}
111490d69ab7SBarry Smith   flg1 = PETSC_FALSE;
11150298fd71SBarry Smith   ierr = PetscOptionsGetBool(NULL,"-mpidump",&flg1,NULL);CHKERRQ(ierr);
1116e5c89e4eSSatish Balay   if (flg1) {
1117e5c89e4eSSatish Balay     ierr = PetscMPIDump(stdout);CHKERRQ(ierr);
1118e5c89e4eSSatish Balay   }
111990d69ab7SBarry Smith   flg1 = PETSC_FALSE;
112090d69ab7SBarry Smith   flg2 = PETSC_FALSE;
11218bb29257SSatish Balay   /* preemptive call to avoid listing this option in options table as unused */
11220298fd71SBarry Smith   ierr = PetscOptionsHasName(NULL,"-malloc_dump",&flg1);CHKERRQ(ierr);
11230298fd71SBarry Smith   ierr = PetscOptionsHasName(NULL,"-objects_dump",&flg1);CHKERRQ(ierr);
11240298fd71SBarry Smith   ierr = PetscOptionsGetBool(NULL,"-options_table",&flg2,NULL);CHKERRQ(ierr);
1125e4c476e2SSatish Balay 
1126e5c89e4eSSatish Balay   if (flg2) {
1127be56827dSJed Brown     PetscViewer viewer;
1128be56827dSJed Brown     ierr = PetscViewerASCIIGetStdout(PETSC_COMM_WORLD,&viewer);CHKERRQ(ierr);
1129be56827dSJed Brown     ierr = PetscOptionsView(viewer);CHKERRQ(ierr);
1130be56827dSJed Brown     ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr);
1131e5c89e4eSSatish Balay   }
1132e5c89e4eSSatish Balay 
1133e5c89e4eSSatish Balay   /* to prevent PETSc -options_left from warning */
11340298fd71SBarry Smith   ierr = PetscOptionsHasName(NULL,"-nox",&flg1);CHKERRQ(ierr);
11350298fd71SBarry Smith   ierr = PetscOptionsHasName(NULL,"-nox_warning",&flg1);CHKERRQ(ierr);
1136e5c89e4eSSatish Balay 
113733fc4174SSatish Balay   flg3 = PETSC_FALSE; /* default value is required */
11380298fd71SBarry Smith   ierr = PetscOptionsGetBool(NULL,"-options_left",&flg3,&flg1);CHKERRQ(ierr);
1139e5c89e4eSSatish Balay   ierr = PetscOptionsAllUsed(&nopt);CHKERRQ(ierr);
1140e5c89e4eSSatish Balay   if (flg3) {
1141e5c89e4eSSatish Balay     if (!flg2) { /* have not yet printed the options */
1142be56827dSJed Brown       PetscViewer viewer;
1143be56827dSJed Brown       ierr = PetscViewerASCIIGetStdout(PETSC_COMM_WORLD,&viewer);CHKERRQ(ierr);
1144be56827dSJed Brown       ierr = PetscOptionsView(viewer);CHKERRQ(ierr);
1145be56827dSJed Brown       ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr);
1146e5c89e4eSSatish Balay     }
1147e5c89e4eSSatish Balay     if (!nopt) {
1148e5c89e4eSSatish Balay       ierr = PetscPrintf(PETSC_COMM_WORLD,"There are no unused options.\n");CHKERRQ(ierr);
1149e5c89e4eSSatish Balay     } else if (nopt == 1) {
1150e5c89e4eSSatish Balay       ierr = PetscPrintf(PETSC_COMM_WORLD,"There is one unused database option. It is:\n");CHKERRQ(ierr);
1151e5c89e4eSSatish Balay     } else {
11527582186dSLisandro Dalcin       ierr = PetscPrintf(PETSC_COMM_WORLD,"There are %D unused database options. They are:\n",nopt);CHKERRQ(ierr);
1153e5c89e4eSSatish Balay     }
1154e5c89e4eSSatish Balay #if defined(PETSC_USE_DEBUG)
1155da8b8a77SBarry Smith     if (nopt && !flg3 && !flg1) {
1156e5c89e4eSSatish Balay       ierr = PetscPrintf(PETSC_COMM_WORLD,"WARNING! There are options you set that were not used!\n");CHKERRQ(ierr);
1157e5c89e4eSSatish Balay       ierr = PetscPrintf(PETSC_COMM_WORLD,"WARNING! could be spelling mistake, etc!\n");CHKERRQ(ierr);
1158e5c89e4eSSatish Balay       ierr = PetscOptionsLeft();CHKERRQ(ierr);
1159e5c89e4eSSatish Balay     } else if (nopt && flg3) {
1160e5c89e4eSSatish Balay #else
1161e5c89e4eSSatish Balay     if (nopt && flg3) {
1162e5c89e4eSSatish Balay #endif
1163e5c89e4eSSatish Balay       ierr = PetscOptionsLeft();CHKERRQ(ierr);
1164e5c89e4eSSatish Balay     }
1165931f367cSBarry Smith   }
1166e5c89e4eSSatish Balay 
1167e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS)
1168d45a07a7SBarry Smith   if (!PetscGlobalRank) {
116987f587eeSBarry Smith     ierr = PetscStackSAWsViewOff();CHKERRQ(ierr);
117016ad0300SBarry Smith     PetscStackCallSAWs(SAWs_Finalize,());
1171d45a07a7SBarry Smith   }
1172ec957eceSBarry Smith #endif
1173ec957eceSBarry Smith 
1174eea2bdeeSJed Brown   {
1175eea2bdeeSJed Brown     PetscThreadComm tcomm_world;
1176eea2bdeeSJed Brown     ierr = PetscGetThreadCommWorld(&tcomm_world);CHKERRQ(ierr);
1177eea2bdeeSJed Brown     /* Free global thread communicator */
1178eea2bdeeSJed Brown     ierr = PetscThreadCommDestroy(&tcomm_world);CHKERRQ(ierr);
1179eea2bdeeSJed Brown   }
1180eea2bdeeSJed Brown 
11814097062eSBarry Smith #if defined(PETSC_USE_LOG)
118210463e74SBarry Smith   /*
1183dbc8283eSBarry Smith        List all objects the user may have forgot to free
11842eff7a51SBarry Smith   */
11850298fd71SBarry Smith   ierr = PetscOptionsHasName(NULL,"-objects_dump",&flg1);CHKERRQ(ierr);
1186a64a8e02SBarry Smith   if (flg1) {
1187a64a8e02SBarry Smith     MPI_Comm local_comm;
11887eb1d149SBarry Smith     char     string[64];
1189a64a8e02SBarry Smith 
11900298fd71SBarry Smith     ierr = PetscOptionsGetString(NULL,"-objects_dump",string,64,NULL);CHKERRQ(ierr);
1191a64a8e02SBarry Smith     ierr = MPI_Comm_dup(MPI_COMM_WORLD,&local_comm);CHKERRQ(ierr);
1192a64a8e02SBarry Smith     ierr = PetscSequentialPhaseBegin_Private(local_comm,1);CHKERRQ(ierr);
11937eb1d149SBarry Smith     ierr = PetscObjectsDump(stdout,(string[0] == 'a') ? PETSC_TRUE : PETSC_FALSE);CHKERRQ(ierr);
1194a64a8e02SBarry Smith     ierr = PetscSequentialPhaseEnd_Private(local_comm,1);CHKERRQ(ierr);
1195a64a8e02SBarry Smith     ierr = MPI_Comm_free(&local_comm);CHKERRQ(ierr);
11960a1571b3SBarry Smith   }
11974097062eSBarry Smith #endif
11984097062eSBarry Smith 
11994097062eSBarry Smith #if defined(PETSC_USE_LOG)
1200dbc8283eSBarry Smith   PetscObjectsCounts    = 0;
1201dbc8283eSBarry Smith   PetscObjectsMaxCounts = 0;
1202a297a907SKarl Rupp   ierr = PetscFree(PetscObjects);CHKERRQ(ierr);
12034097062eSBarry Smith #endif
12042eff7a51SBarry Smith 
120533f85c2fSBarry Smith #if defined(PETSC_USE_LOG)
120633f85c2fSBarry Smith   ierr = PetscLogDestroy();CHKERRQ(ierr);
120733f85c2fSBarry Smith #endif
120833f85c2fSBarry Smith 
120933f85c2fSBarry Smith   /*
121033f85c2fSBarry Smith      Destroy any packages that registered a finalize
121133f85c2fSBarry Smith   */
121233f85c2fSBarry Smith   ierr = PetscRegisterFinalizeAll();CHKERRQ(ierr);
121333f85c2fSBarry Smith 
121433f85c2fSBarry Smith   /*
121510463e74SBarry Smith      Destroy all the function registration lists created
121610463e74SBarry Smith   */
121710463e74SBarry Smith   ierr = PetscFinalize_DynamicLibraries();CHKERRQ(ierr);
121810463e74SBarry Smith 
121948dd1dffSBarry Smith   /*
122048dd1dffSBarry Smith      Print PetscFunctionLists that have not been properly freed
122148dd1dffSBarry Smith 
122237e93019SBarry Smith   ierr = PetscFunctionListPrintAll();CHKERRQ(ierr);
122348dd1dffSBarry Smith   */
122437e93019SBarry Smith 
12254028d114SSatish Balay   if (petsc_history) {
1226f3dea69dSBarry Smith     ierr = PetscCloseHistoryFile(&petsc_history);CHKERRQ(ierr);
1227e5c89e4eSSatish Balay     petsc_history = 0;
1228e5c89e4eSSatish Balay   }
1229e5c89e4eSSatish Balay 
12300298fd71SBarry Smith   ierr = PetscInfoAllow(PETSC_FALSE,NULL);CHKERRQ(ierr);
1231e5c89e4eSSatish Balay 
12328bb29257SSatish Balay   {
1233e5c89e4eSSatish Balay     char fname[PETSC_MAX_PATH_LEN];
1234e5c89e4eSSatish Balay     FILE *fd;
1235ed9cf6e9SBarry Smith     int  err;
1236e5c89e4eSSatish Balay 
1237e5c89e4eSSatish Balay     fname[0] = 0;
1238a297a907SKarl Rupp 
12390298fd71SBarry Smith     ierr = PetscOptionsGetString(NULL,"-malloc_dump",fname,250,&flg1);CHKERRQ(ierr);
1240dc92acbaSJed Brown     flg2 = PETSC_FALSE;
12410298fd71SBarry Smith     ierr = PetscOptionsGetBool(NULL,"-malloc_test",&flg2,NULL);CHKERRQ(ierr);
12428bf1f09cSShri Abhyankar #if defined(PETSC_USE_DEBUG)
1243dc92acbaSJed Brown     if (PETSC_RUNNING_ON_VALGRIND) flg2 = PETSC_FALSE;
1244dc92acbaSJed Brown #else
1245dc92acbaSJed Brown     flg2 = PETSC_FALSE;         /* Skip reporting for optimized builds regardless of -malloc_test */
1246dc92acbaSJed Brown #endif
1247e5c89e4eSSatish Balay     if (flg1 && fname[0]) {
1248e5c89e4eSSatish Balay       char sname[PETSC_MAX_PATH_LEN];
1249e5c89e4eSSatish Balay 
1250e5c89e4eSSatish Balay       sprintf(sname,"%s_%d",fname,rank);
1251e32f2f54SBarry Smith       fd   = fopen(sname,"w"); if (!fd) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_FILE_OPEN,"Cannot open log file: %s",sname);
1252e5c89e4eSSatish Balay       ierr = PetscMallocDump(fd);CHKERRQ(ierr);
1253ed9cf6e9SBarry Smith       err  = fclose(fd);
1254e32f2f54SBarry Smith       if (err) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SYS,"fclose() failed on file");
1255dc92acbaSJed Brown     } else if (flg1 || flg2) {
1256e5c89e4eSSatish Balay       MPI_Comm local_comm;
1257e5c89e4eSSatish Balay 
1258e5c89e4eSSatish Balay       ierr = MPI_Comm_dup(MPI_COMM_WORLD,&local_comm);CHKERRQ(ierr);
1259e5c89e4eSSatish Balay       ierr = PetscSequentialPhaseBegin_Private(local_comm,1);CHKERRQ(ierr);
1260e5c89e4eSSatish Balay       ierr = PetscMallocDump(stdout);CHKERRQ(ierr);
1261e5c89e4eSSatish Balay       ierr = PetscSequentialPhaseEnd_Private(local_comm,1);CHKERRQ(ierr);
1262e5c89e4eSSatish Balay       ierr = MPI_Comm_free(&local_comm);CHKERRQ(ierr);
1263e5c89e4eSSatish Balay     }
1264e5c89e4eSSatish Balay   }
1265a64a8e02SBarry Smith 
12668bb29257SSatish Balay   {
1267e5c89e4eSSatish Balay     char fname[PETSC_MAX_PATH_LEN];
12680298fd71SBarry Smith     FILE *fd = NULL;
1269e5c89e4eSSatish Balay 
1270e5c89e4eSSatish Balay     fname[0] = 0;
1271a297a907SKarl Rupp 
12720298fd71SBarry Smith     ierr = PetscOptionsGetString(NULL,"-malloc_log",fname,250,&flg1);CHKERRQ(ierr);
12730298fd71SBarry Smith     ierr = PetscOptionsHasName(NULL,"-malloc_log_threshold",&flg2);CHKERRQ(ierr);
1274e5c89e4eSSatish Balay     if (flg1 && fname[0]) {
1275ed9cf6e9SBarry Smith       int err;
1276e5c89e4eSSatish Balay 
1277574034a9SJed Brown       if (!rank) {
1278574034a9SJed Brown         fd = fopen(fname,"w");
1279574034a9SJed Brown         if (!fd) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_FILE_OPEN,"Cannot open log file: %s",fname);
1280574034a9SJed Brown       }
1281e5c89e4eSSatish Balay       ierr = PetscMallocDumpLog(fd);CHKERRQ(ierr);
1282574034a9SJed Brown       if (fd) {
1283ed9cf6e9SBarry Smith         err = fclose(fd);
1284e32f2f54SBarry Smith         if (err) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SYS,"fclose() failed on file");
1285574034a9SJed Brown       }
1286574034a9SJed Brown     } else if (flg1 || flg2) {
1287e5c89e4eSSatish Balay       ierr = PetscMallocDumpLog(stdout);CHKERRQ(ierr);
1288e5c89e4eSSatish Balay     }
1289e5c89e4eSSatish Balay   }
129020e2c332SMatthew G. Knepley 
129120e2c332SMatthew G. Knepley #if defined(PETSC_HAVE_CUDA)
129220e2c332SMatthew G. Knepley   flg  = PETSC_TRUE;
129320e2c332SMatthew G. Knepley   ierr = PetscOptionsGetBool(NULL,"-cublas",&flg,NULL);CHKERRQ(ierr);
129420e2c332SMatthew G. Knepley   if (flg) {
129520e2c332SMatthew G. Knepley     PetscInt p;
129620e2c332SMatthew G. Knepley     for (p = 0; p < PetscGlobalSize; ++p) {
129720e2c332SMatthew G. Knepley       if (p == PetscGlobalRank) cublasShutdown();
129820e2c332SMatthew G. Knepley       ierr = MPI_Barrier(PETSC_COMM_WORLD);CHKERRQ(ierr);
129920e2c332SMatthew G. Knepley     }
130020e2c332SMatthew G. Knepley   }
130120e2c332SMatthew G. Knepley #endif
130220e2c332SMatthew G. Knepley 
1303e5c89e4eSSatish Balay   /* Can be destroyed only after all the options are used */
1304e5c89e4eSSatish Balay   ierr = PetscOptionsDestroy();CHKERRQ(ierr);
1305e5c89e4eSSatish Balay 
1306e5c89e4eSSatish Balay   PetscGlobalArgc = 0;
1307e5c89e4eSSatish Balay   PetscGlobalArgs = 0;
1308e5c89e4eSSatish Balay 
1309ce63c4c1SBarry Smith #if defined(PETSC_USE_REAL___FLOAT128)
1310c90a1750SBarry Smith   ierr = MPI_Type_free(&MPIU___FLOAT128);CHKERRQ(ierr);
13117c2de775SJed Brown #if defined(PETSC_HAVE_COMPLEX)
13128c764dc5SJose Roman   ierr = MPI_Type_free(&MPIU___COMPLEX128);CHKERRQ(ierr);
13138c764dc5SJose Roman #endif
1314d9822059SBarry Smith   ierr = MPI_Op_free(&MPIU_MAX);CHKERRQ(ierr);
1315d9822059SBarry Smith   ierr = MPI_Op_free(&MPIU_MIN);CHKERRQ(ierr);
1316c90a1750SBarry Smith #endif
1317c90a1750SBarry Smith 
13187c2de775SJed Brown #if defined(PETSC_HAVE_COMPLEX)
13192c876bd9SBarry Smith #if !defined(PETSC_HAVE_MPI_C_DOUBLE_COMPLEX)
1320500d8756SSatish Balay   ierr = MPI_Type_free(&MPIU_C_DOUBLE_COMPLEX);CHKERRQ(ierr);
1321500d8756SSatish Balay   ierr = MPI_Type_free(&MPIU_C_COMPLEX);CHKERRQ(ierr);
13222c876bd9SBarry Smith #endif
1323e5c89e4eSSatish Balay #endif
1324cca4cb22SSatish Balay 
13257c2de775SJed Brown #if (defined(PETSC_HAVE_COMPLEX) && !defined(PETSC_HAVE_MPI_C_DOUBLE_COMPLEX)) || defined(PETSC_USE_REAL___FLOAT128)
1326cca4cb22SSatish Balay   ierr = MPI_Op_free(&MPIU_SUM);CHKERRQ(ierr);
1327cca4cb22SSatish Balay #endif
1328cca4cb22SSatish Balay 
1329e5c89e4eSSatish Balay   ierr = MPI_Type_free(&MPIU_2SCALAR);CHKERRQ(ierr);
133044041f26SJed Brown #if defined(PETSC_USE_64BIT_INDICES) || !defined(MPI_2INT)
1331e5c89e4eSSatish Balay   ierr = MPI_Type_free(&MPIU_2INT);CHKERRQ(ierr);
133244041f26SJed Brown #endif
1333e5c89e4eSSatish Balay   ierr = MPI_Op_free(&PetscMaxSum_Op);CHKERRQ(ierr);
1334e5c89e4eSSatish Balay   ierr = MPI_Op_free(&PetscADMax_Op);CHKERRQ(ierr);
1335e5c89e4eSSatish Balay   ierr = MPI_Op_free(&PetscADMin_Op);CHKERRQ(ierr);
1336e5c89e4eSSatish Balay 
1337dbc8283eSBarry Smith   /*
1338efb80d3cSBarry Smith      Destroy any known inner MPI_Comm's and attributes pointing to them
1339efb80d3cSBarry Smith      Note this will not destroy any new communicators the user has created.
1340efb80d3cSBarry Smith 
1341efb80d3cSBarry Smith      If all PETSc objects were not destroyed those left over objects will have hanging references to
1342efb80d3cSBarry Smith      the MPI_Comms that were freed; but that is ok because those PETSc objects will never be used again
1343dbc8283eSBarry Smith  */
1344b770b1f6SSatish Balay   {
1345dbc8283eSBarry Smith     PetscCommCounter *counter;
1346dbc8283eSBarry Smith     PetscMPIInt      flg;
1347dbc8283eSBarry Smith     MPI_Comm         icomm;
1348265f3f35SJed Brown     union {MPI_Comm comm; void *ptr;} ucomm;
1349265f3f35SJed Brown     ierr = MPI_Attr_get(PETSC_COMM_SELF,Petsc_InnerComm_keyval,&ucomm,&flg);CHKERRQ(ierr);
1350dbc8283eSBarry Smith     if (flg) {
1351265f3f35SJed Brown       icomm = ucomm.comm;
1352dbc8283eSBarry Smith       ierr = MPI_Attr_get(icomm,Petsc_Counter_keyval,&counter,&flg);CHKERRQ(ierr);
1353dbc8283eSBarry 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");
1354dbc8283eSBarry Smith 
1355dbc8283eSBarry Smith       ierr = MPI_Attr_delete(PETSC_COMM_SELF,Petsc_InnerComm_keyval);CHKERRQ(ierr);
1356efb80d3cSBarry Smith       ierr = MPI_Attr_delete(icomm,Petsc_Counter_keyval);CHKERRQ(ierr);
1357efb80d3cSBarry Smith       ierr = MPI_Comm_free(&icomm);CHKERRQ(ierr);
1358dbc8283eSBarry Smith     }
1359265f3f35SJed Brown     ierr = MPI_Attr_get(PETSC_COMM_WORLD,Petsc_InnerComm_keyval,&ucomm,&flg);CHKERRQ(ierr);
1360dbc8283eSBarry Smith     if (flg) {
1361265f3f35SJed Brown       icomm = ucomm.comm;
1362dbc8283eSBarry Smith       ierr = MPI_Attr_get(icomm,Petsc_Counter_keyval,&counter,&flg);CHKERRQ(ierr);
1363dbc8283eSBarry 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");
1364dbc8283eSBarry Smith 
1365dbc8283eSBarry Smith       ierr = MPI_Attr_delete(PETSC_COMM_WORLD,Petsc_InnerComm_keyval);CHKERRQ(ierr);
1366efb80d3cSBarry Smith       ierr = MPI_Attr_delete(icomm,Petsc_Counter_keyval);CHKERRQ(ierr);
1367efb80d3cSBarry Smith       ierr = MPI_Comm_free(&icomm);CHKERRQ(ierr);
1368dbc8283eSBarry Smith     }
1369b770b1f6SSatish Balay   }
1370dbc8283eSBarry Smith 
1371480cf27aSJed Brown   ierr = MPI_Keyval_free(&Petsc_Counter_keyval);CHKERRQ(ierr);
1372480cf27aSJed Brown   ierr = MPI_Keyval_free(&Petsc_InnerComm_keyval);CHKERRQ(ierr);
1373480cf27aSJed Brown   ierr = MPI_Keyval_free(&Petsc_OuterComm_keyval);CHKERRQ(ierr);
1374480cf27aSJed Brown 
1375e5c89e4eSSatish Balay   if (PetscBeganMPI) {
137699608316SBarry Smith #if defined(PETSC_HAVE_MPI_FINALIZED)
137799b1327fSBarry Smith     PetscMPIInt flag;
137899b1327fSBarry Smith     ierr = MPI_Finalized(&flag);CHKERRQ(ierr);
1379e32f2f54SBarry Smith     if (flag) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_LIB,"MPI_Finalize() has already been called, even though MPI_Init() was called by PetscInitialize()");
138099608316SBarry Smith #endif
1381e5c89e4eSSatish Balay     ierr = MPI_Finalize();CHKERRQ(ierr);
1382e5c89e4eSSatish Balay   }
1383e5c89e4eSSatish Balay /*
1384e5c89e4eSSatish Balay 
1385e5c89e4eSSatish Balay      Note: In certain cases PETSC_COMM_WORLD is never MPI_Comm_free()ed because
1386e5c89e4eSSatish Balay    the communicator has some outstanding requests on it. Specifically if the
1387e5c89e4eSSatish Balay    flag PETSC_HAVE_BROKEN_REQUEST_FREE is set (for IBM MPI implementation). See
1388e5c89e4eSSatish Balay    src/vec/utils/vpscat.c. Due to this the memory allocated in PetscCommDuplicate()
1389e5c89e4eSSatish Balay    is never freed as it should be. Thus one may obtain messages of the form
13900e5e90baSSatish Balay    [ 1] 8 bytes PetscCommDuplicate() line 645 in src/sys/mpiu.c indicating the
1391e5c89e4eSSatish Balay    memory was not freed.
1392e5c89e4eSSatish Balay 
1393e5c89e4eSSatish Balay */
13941d1a0024SBarry Smith   ierr = PetscMallocClear();CHKERRQ(ierr);
1395a297a907SKarl Rupp 
1396e5c89e4eSSatish Balay   PetscInitializeCalled = PETSC_FALSE;
1397e5c89e4eSSatish Balay   PetscFinalizeCalled   = PETSC_TRUE;
1398e5c89e4eSSatish Balay   PetscFunctionReturn(ierr);
1399e5c89e4eSSatish Balay }
1400e5c89e4eSSatish Balay 
140143db4dbbSBarry Smith #if defined(PETSC_MISSING_LAPACK_lsame_)
14028cc058d9SJed Brown PETSC_EXTERN int lsame_(char *a,char *b)
140343db4dbbSBarry Smith {
140443db4dbbSBarry Smith   if (*a == *b) return 1;
140543db4dbbSBarry Smith   if (*a + 32 == *b) return 1;
140643db4dbbSBarry Smith   if (*a - 32 == *b) return 1;
140743db4dbbSBarry Smith   return 0;
140843db4dbbSBarry Smith }
1409a70650f6SBarry Smith #endif
141043db4dbbSBarry Smith 
141143db4dbbSBarry Smith #if defined(PETSC_MISSING_LAPACK_lsame)
14128cc058d9SJed Brown PETSC_EXTERN int lsame(char *a,char *b)
141343db4dbbSBarry Smith {
141443db4dbbSBarry Smith   if (*a == *b) return 1;
141543db4dbbSBarry Smith   if (*a + 32 == *b) return 1;
141643db4dbbSBarry Smith   if (*a - 32 == *b) return 1;
141743db4dbbSBarry Smith   return 0;
141843db4dbbSBarry Smith }
141943db4dbbSBarry Smith #endif
1420