xref: /petsc/src/sys/objects/pinit.c (revision 785e854f82a3c614b452fca2cf5ad4f2afe8bdde)
17d0a6c19SBarry Smith 
2e5c89e4eSSatish Balay /*
3e5c89e4eSSatish Balay    This file defines the initialization of PETSc, including PetscInitialize()
4e5c89e4eSSatish Balay */
550f81f78SJed Brown #define PETSC_DESIRE_COMPLEX
6afcb2eb5SJed Brown #include <petsc-private/petscimpl.h>        /*I  "petscsys.h"   I*/
7665c2dedSJed Brown #include <petscviewer.h>
88101f56cSMatthew Knepley 
9663ba86aSMatthew G Knepley #if defined(PETSC_HAVE_CUDA)
102f947c57SVictor Minden #include <cublas.h>
117a025f21SVictor Minden #endif
127a025f21SVictor Minden 
13bd8b14e7SShri Abhyankar #include <petscthreadcomm.h>
14bd8b14e7SShri Abhyankar 
15a9f03627SSatish Balay #if defined(PETSC_USE_LOG)
1609573ac7SBarry Smith extern PetscErrorCode PetscLogBegin_Private(void);
17a9f03627SSatish Balay #endif
1885afcc9aSBarry Smith extern PetscBool PetscHMPIWorker;
19f2d66bcaSShri Abhyankar 
202d53ad75SBarry Smith #if defined(PETSC_SERIALIZE_FUNCTIONS)
212d53ad75SBarry Smith PetscFPT PetscFPTData = 0;
222d53ad75SBarry Smith #endif
232d53ad75SBarry Smith 
24a6790183SBarry Smith #if defined(PETSC_HAVE_SAWS)
2516ad0300SBarry Smith #include <petscviewersaws.h>
26a6790183SBarry Smith #endif
27e5c89e4eSSatish Balay /* -----------------------------------------------------------------------------------------*/
28e5c89e4eSSatish Balay 
29e5c89e4eSSatish Balay extern FILE *petsc_history;
30e5c89e4eSSatish Balay 
3109573ac7SBarry Smith extern PetscErrorCode PetscInitialize_DynamicLibraries(void);
3209573ac7SBarry Smith extern PetscErrorCode PetscFinalize_DynamicLibraries(void);
3337e93019SBarry Smith extern PetscErrorCode PetscFunctionListPrintAll(void);
3409573ac7SBarry Smith extern PetscErrorCode PetscSequentialPhaseBegin_Private(MPI_Comm,int);
3509573ac7SBarry Smith extern PetscErrorCode PetscSequentialPhaseEnd_Private(MPI_Comm,int);
3609573ac7SBarry Smith extern PetscErrorCode PetscCloseHistoryFile(FILE**);
370069ddf5SShri Abhyankar 
38e5c89e4eSSatish Balay /* user may set this BEFORE calling PetscInitialize() */
39e8373e55SMatthew Knepley MPI_Comm PETSC_COMM_WORLD = MPI_COMM_NULL;
40e5c89e4eSSatish Balay 
41480cf27aSJed Brown PetscMPIInt Petsc_Counter_keyval   = MPI_KEYVAL_INVALID;
42480cf27aSJed Brown PetscMPIInt Petsc_InnerComm_keyval = MPI_KEYVAL_INVALID;
43480cf27aSJed Brown PetscMPIInt Petsc_OuterComm_keyval = MPI_KEYVAL_INVALID;
44480cf27aSJed Brown 
45e5c89e4eSSatish Balay /*
46e5c89e4eSSatish Balay      Declare and set all the string names of the PETSc enums
47e5c89e4eSSatish Balay */
486a6fc655SJed Brown const char *const PetscBools[]     = {"FALSE","TRUE","PetscBool","PETSC_",0};
496a6fc655SJed Brown const char *const PetscCopyModes[] = {"COPY_VALUES","OWN_POINTER","USE_POINTER","PetscCopyMode","PETSC_",0};
506a6fc655SJed Brown const char *const PetscDataTypes[] = {"INT","DOUBLE","COMPLEX","LONG","SHORT","FLOAT",
512d53ad75SBarry Smith                                       "CHAR","LOGICAL","ENUM","BOOL","LONGDOUBLE","OBJECT","FUNCTION","PetscDataType","PETSC_",0};
52e5c89e4eSSatish Balay 
53ace3abfcSBarry Smith PetscBool PetscPreLoadingUsed = PETSC_FALSE;
54ace3abfcSBarry Smith PetscBool PetscPreLoadingOn   = PETSC_FALSE;
550f8e0872SSatish Balay 
56a2f94806SJed Brown PetscInt PetscHotRegionDepth;
57a2f94806SJed Brown 
58e5c89e4eSSatish Balay /*
59e5c89e4eSSatish Balay        Checks the options database for initializations related to the
60e5c89e4eSSatish Balay     PETSc components
61e5c89e4eSSatish Balay */
62e5c89e4eSSatish Balay #undef __FUNCT__
63e5c89e4eSSatish Balay #define __FUNCT__ "PetscOptionsCheckInitial_Components"
647087cfbeSBarry Smith PetscErrorCode  PetscOptionsCheckInitial_Components(void)
65e5c89e4eSSatish Balay {
66ace3abfcSBarry Smith   PetscBool      flg1;
67e5c89e4eSSatish Balay   PetscErrorCode ierr;
68e5c89e4eSSatish Balay 
69e5c89e4eSSatish Balay   PetscFunctionBegin;
700298fd71SBarry Smith   ierr = PetscOptionsHasName(NULL,"-help",&flg1);CHKERRQ(ierr);
71e5c89e4eSSatish Balay   if (flg1) {
72e5c89e4eSSatish Balay #if defined(PETSC_USE_LOG)
73e8e7597cSSatish Balay     MPI_Comm comm = PETSC_COMM_WORLD;
74e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm,"------Additional PETSc component options--------\n");CHKERRQ(ierr);
75e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm," -log_summary_exclude: <vec,mat,pc.ksp,snes>\n");CHKERRQ(ierr);
766cf91177SBarry Smith     ierr = (*PetscHelpPrintf)(comm," -info_exclude: <null,vec,mat,pc,ksp,snes,ts>\n");CHKERRQ(ierr);
77e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm,"-----------------------------------------------\n");CHKERRQ(ierr);
78e5c89e4eSSatish Balay #endif
79e5c89e4eSSatish Balay   }
80e5c89e4eSSatish Balay   PetscFunctionReturn(0);
81e5c89e4eSSatish Balay }
82e5c89e4eSSatish Balay 
83e5c89e4eSSatish Balay #undef __FUNCT__
84945d1669SBarry Smith #define __FUNCT__ "PetscInitializeNoPointers"
850f11a792SBarry Smith /*
86945d1669SBarry Smith       PetscInitializeNoPointers - Calls PetscInitialize() from C/C++ without the pointers to argc and args
8772a42c3cSBarry Smith 
8872a42c3cSBarry Smith    Collective
8972a42c3cSBarry Smith 
9072a42c3cSBarry Smith    Level: advanced
9172a42c3cSBarry Smith 
92945d1669SBarry Smith     Notes: this is called only by the PETSc MATLAB and Julia interface. Even though it might start MPI it sets the flag to
930f11a792SBarry Smith      indicate that it did NOT start MPI so that the PetscFinalize() does not end MPI, thus allowing PetscInitialize() to
94945d1669SBarry Smith      be called multiple times from MATLAB and Julia without the problem of trying to initialize MPI more than once.
950f11a792SBarry Smith 
961ea5a559SBarry Smith      Turns off PETSc signal handling because that can interact with MATLAB's signal handling causing random crashes.
971ea5a559SBarry Smith 
9872a42c3cSBarry Smith .seealso: PetscInitialize(), PetscInitializeFortran(), PetscInitializeNoArguments()
990f11a792SBarry Smith */
100945d1669SBarry Smith PetscErrorCode  PetscInitializeNoPointers(int argc,char **args,const char *filename,const char *help)
10172a42c3cSBarry Smith {
10272a42c3cSBarry Smith   PetscErrorCode ierr;
10372a42c3cSBarry Smith   int            myargc   = argc;
10472a42c3cSBarry Smith   char           **myargs = args;
10572a42c3cSBarry Smith 
10672a42c3cSBarry Smith   PetscFunctionBegin;
1073bf036e2SBarry Smith   ierr = PetscInitialize(&myargc,&myargs,filename,help);CHKERRQ(ierr);
1081ea5a559SBarry Smith   ierr = PetscPopSignalHandler();CHKERRQ(ierr);
109df413903SBarry Smith   PetscBeganMPI = PETSC_FALSE;
11072a42c3cSBarry Smith   PetscFunctionReturn(ierr);
11172a42c3cSBarry Smith }
11272a42c3cSBarry Smith 
11372a42c3cSBarry Smith #undef __FUNCT__
114945d1669SBarry Smith #define __FUNCT__ "PetscGetPETSC_COMM_SELF"
115f0865b08SBarry Smith /*
116945d1669SBarry Smith       Used by MATLAB and Julia interface to get communicator
117f0865b08SBarry Smith */
118945d1669SBarry Smith PetscErrorCode  PetscGetPETSC_COMM_SELF(MPI_Comm *comm)
119f0865b08SBarry Smith {
120f0865b08SBarry Smith   PetscFunctionBegin;
121f0865b08SBarry Smith   *comm = PETSC_COMM_SELF;
122f0865b08SBarry Smith   PetscFunctionReturn(0);
123f0865b08SBarry Smith }
124f0865b08SBarry Smith 
125f0865b08SBarry Smith #undef __FUNCT__
126e5c89e4eSSatish Balay #define __FUNCT__ "PetscInitializeNoArguments"
127e5c89e4eSSatish Balay /*@C
128e5c89e4eSSatish Balay       PetscInitializeNoArguments - Calls PetscInitialize() from C/C++ without
129e5c89e4eSSatish Balay         the command line arguments.
130e5c89e4eSSatish Balay 
131e5c89e4eSSatish Balay    Collective
132e5c89e4eSSatish Balay 
133e5c89e4eSSatish Balay    Level: advanced
134e5c89e4eSSatish Balay 
135e5c89e4eSSatish Balay .seealso: PetscInitialize(), PetscInitializeFortran()
136e5c89e4eSSatish Balay @*/
1377087cfbeSBarry Smith PetscErrorCode  PetscInitializeNoArguments(void)
138e5c89e4eSSatish Balay {
139e5c89e4eSSatish Balay   PetscErrorCode ierr;
140e5c89e4eSSatish Balay   int            argc   = 0;
141e5c89e4eSSatish Balay   char           **args = 0;
142e5c89e4eSSatish Balay 
143e5c89e4eSSatish Balay   PetscFunctionBegin;
1440298fd71SBarry Smith   ierr = PetscInitialize(&argc,&args,NULL,NULL);
145e5c89e4eSSatish Balay   PetscFunctionReturn(ierr);
146e5c89e4eSSatish Balay }
147e5c89e4eSSatish Balay 
148e5c89e4eSSatish Balay #undef __FUNCT__
149e5c89e4eSSatish Balay #define __FUNCT__ "PetscInitialized"
150e5c89e4eSSatish Balay /*@
151e5c89e4eSSatish Balay       PetscInitialized - Determine whether PETSc is initialized.
152e5c89e4eSSatish Balay 
15393b6d2d1SJed Brown    Level: beginner
154e5c89e4eSSatish Balay 
155e5c89e4eSSatish Balay .seealso: PetscInitialize(), PetscInitializeNoArguments(), PetscInitializeFortran()
156e5c89e4eSSatish Balay @*/
1577087cfbeSBarry Smith PetscErrorCode PetscInitialized(PetscBool  *isInitialized)
158e5c89e4eSSatish Balay {
159e5c89e4eSSatish Balay   *isInitialized = PetscInitializeCalled;
16093b6d2d1SJed Brown   return 0;
161e5c89e4eSSatish Balay }
162e5c89e4eSSatish Balay 
163e5c89e4eSSatish Balay #undef __FUNCT__
164e5c89e4eSSatish Balay #define __FUNCT__ "PetscFinalized"
165e5c89e4eSSatish Balay /*@
166e5c89e4eSSatish Balay       PetscFinalized - Determine whether PetscFinalize() has been called yet
167e5c89e4eSSatish Balay 
168e5c89e4eSSatish Balay    Level: developer
169e5c89e4eSSatish Balay 
170e5c89e4eSSatish Balay .seealso: PetscInitialize(), PetscInitializeNoArguments(), PetscInitializeFortran()
171e5c89e4eSSatish Balay @*/
1727087cfbeSBarry Smith PetscErrorCode  PetscFinalized(PetscBool  *isFinalized)
173e5c89e4eSSatish Balay {
174e5c89e4eSSatish Balay   *isFinalized = PetscFinalizeCalled;
17593b6d2d1SJed Brown   return 0;
176e5c89e4eSSatish Balay }
177e5c89e4eSSatish Balay 
17809573ac7SBarry Smith extern PetscErrorCode PetscOptionsCheckInitial_Private(void);
179e5c89e4eSSatish Balay 
180e5c89e4eSSatish Balay /*
181e5c89e4eSSatish Balay        This function is the MPI reduction operation used to compute the sum of the
182e5c89e4eSSatish Balay    first half of the datatype and the max of the second half.
183e5c89e4eSSatish Balay */
184e5c89e4eSSatish Balay MPI_Op PetscMaxSum_Op = 0;
185e5c89e4eSSatish Balay 
186e5c89e4eSSatish Balay #undef __FUNCT__
187e5c89e4eSSatish Balay #define __FUNCT__ "PetscMaxSum_Local"
1888cc058d9SJed Brown PETSC_EXTERN void MPIAPI PetscMaxSum_Local(void *in,void *out,int *cnt,MPI_Datatype *datatype)
189e5c89e4eSSatish Balay {
190e5c89e4eSSatish Balay   PetscInt *xin = (PetscInt*)in,*xout = (PetscInt*)out,i,count = *cnt;
191e5c89e4eSSatish Balay 
192e5c89e4eSSatish Balay   PetscFunctionBegin;
193e5c89e4eSSatish Balay   if (*datatype != MPIU_2INT) {
194e5c89e4eSSatish Balay     (*PetscErrorPrintf)("Can only handle MPIU_2INT data types");
195e5c89e4eSSatish Balay     MPI_Abort(MPI_COMM_WORLD,1);
196e5c89e4eSSatish Balay   }
197e5c89e4eSSatish Balay 
198e5c89e4eSSatish Balay   for (i=0; i<count; i++) {
199e5c89e4eSSatish Balay     xout[2*i]    = PetscMax(xout[2*i],xin[2*i]);
200e5c89e4eSSatish Balay     xout[2*i+1] += xin[2*i+1];
201e5c89e4eSSatish Balay   }
202812af9f3SBarry Smith   PetscFunctionReturnVoid();
203e5c89e4eSSatish Balay }
204e5c89e4eSSatish Balay 
205e5c89e4eSSatish Balay /*
206e5c89e4eSSatish Balay     Returns the max of the first entry owned by this processor and the
207e5c89e4eSSatish Balay sum of the second entry.
208b693b147SBarry Smith 
209b693b147SBarry Smith     The reason nprocs[2*i] contains lengths nprocs[2*i+1] contains flag of 1 if length is nonzero
210b693b147SBarry Smith is so that the PetscMaxSum_Op() can set TWO values, if we passed in only nprocs[i] with lengths
211b693b147SBarry Smith there would be no place to store the both needed results.
212e5c89e4eSSatish Balay */
213e5c89e4eSSatish Balay #undef __FUNCT__
214e5c89e4eSSatish Balay #define __FUNCT__ "PetscMaxSum"
2157087cfbeSBarry Smith PetscErrorCode  PetscMaxSum(MPI_Comm comm,const PetscInt nprocs[],PetscInt *max,PetscInt *sum)
216e5c89e4eSSatish Balay {
217e5c89e4eSSatish Balay   PetscMPIInt    size,rank;
2186ac3741eSJed Brown   struct {PetscInt max,sum;} *work;
219e5c89e4eSSatish Balay   PetscErrorCode ierr;
220e5c89e4eSSatish Balay 
221e5c89e4eSSatish Balay   PetscFunctionBegin;
222e5c89e4eSSatish Balay   ierr = MPI_Comm_size(comm,&size);CHKERRQ(ierr);
223e5c89e4eSSatish Balay   ierr = MPI_Comm_rank(comm,&rank);CHKERRQ(ierr);
224*785e854fSJed Brown   ierr = PetscMalloc1(size,&work);CHKERRQ(ierr);
225e5c89e4eSSatish Balay   ierr = MPI_Allreduce((void*)nprocs,work,size,MPIU_2INT,PetscMaxSum_Op,comm);CHKERRQ(ierr);
2266ac3741eSJed Brown   *max = work[rank].max;
2276ac3741eSJed Brown   *sum = work[rank].sum;
228e5c89e4eSSatish Balay   ierr = PetscFree(work);CHKERRQ(ierr);
229e5c89e4eSSatish Balay   PetscFunctionReturn(0);
230e5c89e4eSSatish Balay }
231e5c89e4eSSatish Balay 
232e5c89e4eSSatish Balay /* ----------------------------------------------------------------------------*/
2337087cfbeSBarry Smith MPI_Op  PetscADMax_Op = 0;
234e5c89e4eSSatish Balay 
235e5c89e4eSSatish Balay #undef __FUNCT__
236e5c89e4eSSatish Balay #define __FUNCT__ "PetscADMax_Local"
2378cc058d9SJed Brown PETSC_EXTERN void MPIAPI PetscADMax_Local(void *in,void *out,PetscMPIInt *cnt,MPI_Datatype *datatype)
238e5c89e4eSSatish Balay {
239e5c89e4eSSatish Balay   PetscScalar *xin = (PetscScalar*)in,*xout = (PetscScalar*)out;
240e5c89e4eSSatish Balay   PetscInt    i,count = *cnt;
241e5c89e4eSSatish Balay 
242e5c89e4eSSatish Balay   PetscFunctionBegin;
243e5c89e4eSSatish Balay   if (*datatype != MPIU_2SCALAR) {
244e5c89e4eSSatish Balay     (*PetscErrorPrintf)("Can only handle MPIU_2SCALAR data (i.e. double or complex) types");
245e5c89e4eSSatish Balay     MPI_Abort(MPI_COMM_WORLD,1);
246e5c89e4eSSatish Balay   }
247e5c89e4eSSatish Balay 
248e5c89e4eSSatish Balay   for (i=0; i<count; i++) {
249e5c89e4eSSatish Balay     if (PetscRealPart(xout[2*i]) < PetscRealPart(xin[2*i])) {
250e5c89e4eSSatish Balay       xout[2*i]   = xin[2*i];
251e5c89e4eSSatish Balay       xout[2*i+1] = xin[2*i+1];
252e5c89e4eSSatish Balay     }
253e5c89e4eSSatish Balay   }
254812af9f3SBarry Smith   PetscFunctionReturnVoid();
255e5c89e4eSSatish Balay }
256e5c89e4eSSatish Balay 
2577087cfbeSBarry Smith MPI_Op PetscADMin_Op = 0;
258e5c89e4eSSatish Balay 
259e5c89e4eSSatish Balay #undef __FUNCT__
260e5c89e4eSSatish Balay #define __FUNCT__ "PetscADMin_Local"
2618cc058d9SJed Brown PETSC_EXTERN void MPIAPI PetscADMin_Local(void *in,void *out,PetscMPIInt *cnt,MPI_Datatype *datatype)
262e5c89e4eSSatish Balay {
263e5c89e4eSSatish Balay   PetscScalar *xin = (PetscScalar*)in,*xout = (PetscScalar*)out;
264e5c89e4eSSatish Balay   PetscInt    i,count = *cnt;
265e5c89e4eSSatish Balay 
266e5c89e4eSSatish Balay   PetscFunctionBegin;
267e5c89e4eSSatish Balay   if (*datatype != MPIU_2SCALAR) {
268e5c89e4eSSatish Balay     (*PetscErrorPrintf)("Can only handle MPIU_2SCALAR data (i.e. double or complex) types");
269e5c89e4eSSatish Balay     MPI_Abort(MPI_COMM_WORLD,1);
270e5c89e4eSSatish Balay   }
271e5c89e4eSSatish Balay 
272e5c89e4eSSatish Balay   for (i=0; i<count; i++) {
273e5c89e4eSSatish Balay     if (PetscRealPart(xout[2*i]) > PetscRealPart(xin[2*i])) {
274e5c89e4eSSatish Balay       xout[2*i]   = xin[2*i];
275e5c89e4eSSatish Balay       xout[2*i+1] = xin[2*i+1];
276e5c89e4eSSatish Balay     }
277e5c89e4eSSatish Balay   }
278812af9f3SBarry Smith   PetscFunctionReturnVoid();
279e5c89e4eSSatish Balay }
280e5c89e4eSSatish Balay /* ---------------------------------------------------------------------------------------*/
281e5c89e4eSSatish Balay 
2827c2de775SJed Brown #if (defined(PETSC_HAVE_COMPLEX) && !defined(PETSC_HAVE_MPI_C_DOUBLE_COMPLEX)) || defined(PETSC_USE_REAL___FLOAT128)
28306a205a8SBarry Smith MPI_Op MPIU_SUM = 0;
284e5c89e4eSSatish Balay 
285e5c89e4eSSatish Balay #undef __FUNCT__
286e5c89e4eSSatish Balay #define __FUNCT__ "PetscSum_Local"
2878cc058d9SJed Brown PETSC_EXTERN void PetscSum_Local(void *in,void *out,PetscMPIInt *cnt,MPI_Datatype *datatype)
288e5c89e4eSSatish Balay {
289e5c89e4eSSatish Balay   PetscInt i,count = *cnt;
290e5c89e4eSSatish Balay 
291e5c89e4eSSatish Balay   PetscFunctionBegin;
2927c2de775SJed Brown   if (*datatype == MPIU_REAL) {
293e2e03761SBarry Smith     PetscReal *xin = (PetscReal*)in,*xout = (PetscReal*)out;
294a297a907SKarl Rupp     for (i=0; i<count; i++) xout[i] += xin[i];
2957c2de775SJed Brown   }
2967c2de775SJed Brown #if defined(PETSC_HAVE_COMPLEX)
2977c2de775SJed Brown   else if (*datatype == MPIU_COMPLEX) {
2987c2de775SJed Brown     PetscComplex *xin = (PetscComplex*)in,*xout = (PetscComplex*)out;
299a297a907SKarl Rupp     for (i=0; i<count; i++) xout[i] += xin[i];
3007c2de775SJed Brown   }
3017c2de775SJed Brown #endif
3027c2de775SJed Brown   else {
3037c2de775SJed Brown     (*PetscErrorPrintf)("Can only handle MPIU_REAL or MPIU_COMPLEX data types");
304e2e03761SBarry Smith     MPI_Abort(MPI_COMM_WORLD,1);
305e2e03761SBarry Smith   }
306812af9f3SBarry Smith   PetscFunctionReturnVoid();
307e5c89e4eSSatish Balay }
308e5c89e4eSSatish Balay #endif
309e5c89e4eSSatish Balay 
310ce63c4c1SBarry Smith #if defined(PETSC_USE_REAL___FLOAT128)
311d9822059SBarry Smith MPI_Op MPIU_MAX = 0;
312d9822059SBarry Smith MPI_Op MPIU_MIN = 0;
313d9822059SBarry Smith 
314d9822059SBarry Smith #undef __FUNCT__
315d9822059SBarry Smith #define __FUNCT__ "PetscMax_Local"
3168cc058d9SJed Brown PETSC_EXTERN void PetscMax_Local(void *in,void *out,PetscMPIInt *cnt,MPI_Datatype *datatype)
317d9822059SBarry Smith {
318d9822059SBarry Smith   PetscInt i,count = *cnt;
319d9822059SBarry Smith 
320d9822059SBarry Smith   PetscFunctionBegin;
3217c2de775SJed Brown   if (*datatype == MPIU_REAL) {
3228c764dc5SJose Roman     PetscReal *xin = (PetscReal*)in,*xout = (PetscReal*)out;
323a297a907SKarl Rupp     for (i=0; i<count; i++) xout[i] = PetscMax(xout[i],xin[i]);
3247c2de775SJed Brown   }
3257c2de775SJed Brown #if defined(PETSC_HAVE_COMPLEX)
3267c2de775SJed Brown   else if (*datatype == MPIU_COMPLEX) {
3277c2de775SJed Brown     PetscComplex *xin = (PetscComplex*)in,*xout = (PetscComplex*)out;
3287c2de775SJed Brown     for (i=0; i<count; i++) {
3297c2de775SJed Brown       xout[i] = PetscRealPartComplex(xout[i])<PetscRealPartComplex(xin[i]) ? xin[i] : xout[i];
3307c2de775SJed Brown     }
3317c2de775SJed Brown   }
3327c2de775SJed Brown #endif
3337c2de775SJed Brown   else {
3347c2de775SJed Brown     (*PetscErrorPrintf)("Can only handle MPIU_REAL or MPIU_COMPLEX data types");
3358c764dc5SJose Roman     MPI_Abort(MPI_COMM_WORLD,1);
3368c764dc5SJose Roman   }
337d9822059SBarry Smith   PetscFunctionReturnVoid();
338d9822059SBarry Smith }
339d9822059SBarry Smith 
340d9822059SBarry Smith #undef __FUNCT__
341d9822059SBarry Smith #define __FUNCT__ "PetscMin_Local"
3428cc058d9SJed Brown PETSC_EXTERN void PetscMin_Local(void *in,void *out,PetscMPIInt *cnt,MPI_Datatype *datatype)
343d9822059SBarry Smith {
344d9822059SBarry Smith   PetscInt    i,count = *cnt;
345d9822059SBarry Smith 
346d9822059SBarry Smith   PetscFunctionBegin;
3477c2de775SJed Brown   if (*datatype == MPIU_REAL) {
3488c764dc5SJose Roman     PetscReal *xin = (PetscReal*)in,*xout = (PetscReal*)out;
349a297a907SKarl Rupp     for (i=0; i<count; i++) xout[i] = PetscMin(xout[i],xin[i]);
3507c2de775SJed Brown   }
3517c2de775SJed Brown #if defined(PETSC_HAVE_COMPLEX)
3527c2de775SJed Brown   else if (*datatype == MPIU_COMPLEX) {
3537c2de775SJed Brown     PetscComplex *xin = (PetscComplex*)in,*xout = (PetscComplex*)out;
3547c2de775SJed Brown     for (i=0; i<count; i++) {
3557c2de775SJed Brown       xout[i] = PetscRealPartComplex(xout[i])>PetscRealPartComplex(xin[i]) ? xin[i] : xout[i];
3567c2de775SJed Brown     }
3577c2de775SJed Brown   }
3587c2de775SJed Brown #endif
3597c2de775SJed Brown   else {
3608c764dc5SJose Roman     (*PetscErrorPrintf)("Can only handle MPIU_REAL or MPIU_SCALAR data (i.e. double or complex) types");
3618c764dc5SJose Roman     MPI_Abort(MPI_COMM_WORLD,1);
3628c764dc5SJose Roman   }
363d9822059SBarry Smith   PetscFunctionReturnVoid();
364d9822059SBarry Smith }
365d9822059SBarry Smith #endif
366d9822059SBarry Smith 
367480cf27aSJed Brown #undef __FUNCT__
368480cf27aSJed Brown #define __FUNCT__ "Petsc_DelCounter"
369480cf27aSJed Brown /*
370480cf27aSJed Brown    Private routine to delete internal tag/name counter storage when a communicator is freed.
371480cf27aSJed Brown 
372ff0e51ddSBarry Smith    This is called by MPI, not by users. This is called by MPI_Comm_free() when the communicator that has this  data as an attribute is freed.
373480cf27aSJed Brown 
374480cf27aSJed Brown    Note: this is declared extern "C" because it is passed to MPI_Keyval_create()
375480cf27aSJed Brown 
376480cf27aSJed Brown */
3778cc058d9SJed Brown PETSC_EXTERN PetscMPIInt MPIAPI Petsc_DelCounter(MPI_Comm comm,PetscMPIInt keyval,void *count_val,void *extra_state)
378480cf27aSJed Brown {
379480cf27aSJed Brown   PetscErrorCode ierr;
380480cf27aSJed Brown 
381480cf27aSJed Brown   PetscFunctionBegin;
382480cf27aSJed Brown   ierr = PetscInfo1(0,"Deleting counter data in an MPI_Comm %ld\n",(long)comm);if (ierr) PetscFunctionReturn((PetscMPIInt)ierr);
383480cf27aSJed Brown   ierr = PetscFree(count_val);if (ierr) PetscFunctionReturn((PetscMPIInt)ierr);
384480cf27aSJed Brown   PetscFunctionReturn(MPI_SUCCESS);
385480cf27aSJed Brown }
386480cf27aSJed Brown 
387480cf27aSJed Brown #undef __FUNCT__
388da3039f7SJed Brown #define __FUNCT__ "Petsc_DelComm_Outer"
389480cf27aSJed Brown /*
390da3039f7SJed Brown   This is invoked on the outer comm as a result of either PetscCommDestroy() (via MPI_Attr_delete) or when the user
391da3039f7SJed Brown   calls MPI_Comm_free().
392da3039f7SJed Brown 
393da3039f7SJed Brown   This is the only entry point for breaking the links between inner and outer comms.
394480cf27aSJed Brown 
395ff0e51ddSBarry Smith   This is called by MPI, not by users. This is called when MPI_Comm_free() is called on the communicator.
396480cf27aSJed Brown 
397480cf27aSJed Brown   Note: this is declared extern "C" because it is passed to MPI_Keyval_create()
398480cf27aSJed Brown 
399480cf27aSJed Brown */
400da3039f7SJed Brown PETSC_EXTERN PetscMPIInt MPIAPI Petsc_DelComm_Outer(MPI_Comm comm,PetscMPIInt keyval,void *attr_val,void *extra_state)
401480cf27aSJed Brown {
402480cf27aSJed Brown   PetscErrorCode ierr;
403b89831e5SBarry Smith   PetscMPIInt    flg;
404265f3f35SJed Brown   union {MPI_Comm comm; void *ptr;} icomm,ocomm;
405480cf27aSJed Brown 
406480cf27aSJed Brown   PetscFunctionBegin;
407da3039f7SJed Brown   if (keyval != Petsc_InnerComm_keyval) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_CORRUPT,"Unexpected keyval");
408ec4fadc2SJed Brown   icomm.ptr = attr_val;
409da3039f7SJed Brown 
410265f3f35SJed Brown   ierr = MPI_Attr_get(icomm.comm,Petsc_OuterComm_keyval,&ocomm,&flg);CHKERRQ(ierr);
411b3ef52cdSBarry Smith   if (!flg) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_CORRUPT,"Inner MPI_Comm does not have expected reference to outer comm");
412da3039f7SJed Brown   if (ocomm.comm != comm) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_CORRUPT,"Inner MPI_Comm has reference to non-matching outer comm");
413da3039f7SJed Brown   ierr = MPI_Attr_delete(icomm.comm,Petsc_OuterComm_keyval);CHKERRQ(ierr); /* Calls Petsc_DelComm_Inner */
414da3039f7SJed Brown   ierr = PetscInfo1(0,"User MPI_Comm %ld is being freed after removing reference from inner PETSc comm to this outer comm\n",(long)comm);if (ierr) PetscFunctionReturn((PetscMPIInt)ierr);
415da3039f7SJed Brown   PetscFunctionReturn(MPI_SUCCESS);
416b89831e5SBarry Smith }
417da3039f7SJed Brown 
418da3039f7SJed Brown #undef __FUNCT__
419da3039f7SJed Brown #define __FUNCT__ "Petsc_DelComm_Inner"
420da3039f7SJed Brown /*
421da3039f7SJed Brown  * This is invoked on the inner comm when Petsc_DelComm_Outer calls MPI_Attr_delete.  It should not be reached any other way.
422da3039f7SJed Brown  */
423da3039f7SJed Brown PETSC_EXTERN PetscMPIInt MPIAPI Petsc_DelComm_Inner(MPI_Comm comm,PetscMPIInt keyval,void *attr_val,void *extra_state)
424da3039f7SJed Brown {
425da3039f7SJed Brown   PetscErrorCode ierr;
426da3039f7SJed Brown 
427da3039f7SJed Brown   PetscFunctionBegin;
428da3039f7SJed Brown   ierr = PetscInfo1(0,"Removing reference to PETSc communicator embedded in a user MPI_Comm %ld\n",(long)comm);if (ierr) PetscFunctionReturn((PetscMPIInt)ierr);
429480cf27aSJed Brown   PetscFunctionReturn(MPI_SUCCESS);
430480cf27aSJed Brown }
431480cf27aSJed Brown 
432951e3c8eSBarry Smith #if defined(PETSC_USE_PETSC_MPI_EXTERNAL32)
433e39fd77fSBarry Smith #if !defined(PETSC_WORDS_BIGENDIAN)
4348cc058d9SJed Brown PETSC_EXTERN PetscMPIInt PetscDataRep_extent_fn(MPI_Datatype,MPI_Aint*,void*);
4358cc058d9SJed Brown PETSC_EXTERN PetscMPIInt PetscDataRep_read_conv_fn(void*, MPI_Datatype,PetscMPIInt,void*,MPI_Offset,void*);
4368cc058d9SJed Brown PETSC_EXTERN PetscMPIInt PetscDataRep_write_conv_fn(void*, MPI_Datatype,PetscMPIInt,void*,MPI_Offset,void*);
437e39fd77fSBarry Smith #endif
438951e3c8eSBarry Smith #endif
439e39fd77fSBarry Smith 
4406ae9a8a6SBarry Smith int  PetscGlobalArgc   = 0;
4416ae9a8a6SBarry Smith char **PetscGlobalArgs = 0;
442dff31646SBarry Smith PetscSegBuffer PetscCitationsList;
443e5c89e4eSSatish Balay 
444e5c89e4eSSatish Balay #undef __FUNCT__
445051e4cf2SJed Brown #define __FUNCT__ "PetscCitationsInitialize"
446051e4cf2SJed Brown PetscErrorCode PetscCitationsInitialize()
447051e4cf2SJed Brown {
448051e4cf2SJed Brown   PetscErrorCode ierr;
449051e4cf2SJed Brown 
450051e4cf2SJed Brown   PetscFunctionBegin;
451051e4cf2SJed Brown   ierr = PetscSegBufferCreate(1,10000,&PetscCitationsList);CHKERRQ(ierr);
452051e4cf2SJed Brown   ierr = PetscCitationsRegister("@TechReport{petsc-user-ref,\n  Author = {Satish Balay and Jed Brown and and Kris Buschelman and Victor Eijkhout\n            and William D.  Gropp and Dinesh Kaushik and Matthew G. Knepley\n            and Lois Curfman McInnes and Barry F. Smith and Hong Zhang},\n  Title = {{PETS}c Users Manual},\n  Number = {ANL-95/11 - Revision 3.4},\n  Institution = {Argonne National Laboratory},\n  Year = {2013}\n}\n",NULL);CHKERRQ(ierr);
453051e4cf2SJed Brown   ierr = PetscCitationsRegister("@InProceedings{petsc-efficient,\n  Author = {Satish Balay and William D. Gropp and Lois Curfman McInnes and Barry F. Smith},\n  Title = {Efficient Management of Parallelism in Object Oriented Numerical Software Libraries},\n  Booktitle = {Modern Software Tools in Scientific Computing},\n  Editor = {E. Arge and A. M. Bruaset and H. P. Langtangen},\n  Pages = {163--202},\n  Publisher = {Birkh{\\\"{a}}user Press},\n  Year = {1997}\n}\n",NULL);CHKERRQ(ierr);
454051e4cf2SJed Brown   PetscFunctionReturn(0);
455051e4cf2SJed Brown }
456e5c89e4eSSatish Balay 
457e5c89e4eSSatish Balay #undef __FUNCT__
458e5c89e4eSSatish Balay #define __FUNCT__ "PetscGetArgs"
459e5c89e4eSSatish Balay /*@C
460e5c89e4eSSatish Balay    PetscGetArgs - Allows you to access the raw command line arguments anywhere
461e5c89e4eSSatish Balay      after PetscInitialize() is called but before PetscFinalize().
462e5c89e4eSSatish Balay 
463e5c89e4eSSatish Balay    Not Collective
464e5c89e4eSSatish Balay 
465e5c89e4eSSatish Balay    Output Parameters:
466e5c89e4eSSatish Balay +  argc - count of number of command line arguments
467e5c89e4eSSatish Balay -  args - the command line arguments
468e5c89e4eSSatish Balay 
469e5c89e4eSSatish Balay    Level: intermediate
470e5c89e4eSSatish Balay 
471e5c89e4eSSatish Balay    Notes:
472e5c89e4eSSatish Balay       This is usually used to pass the command line arguments into other libraries
473e5c89e4eSSatish Balay    that are called internally deep in PETSc or the application.
474e5c89e4eSSatish Balay 
475f177e3b1SBarry Smith       The first argument contains the program name as is normal for C arguments.
476f177e3b1SBarry Smith 
477e5c89e4eSSatish Balay    Concepts: command line arguments
478e5c89e4eSSatish Balay 
479793721a6SBarry Smith .seealso: PetscFinalize(), PetscInitializeFortran(), PetscGetArguments()
480e5c89e4eSSatish Balay 
481e5c89e4eSSatish Balay @*/
4827087cfbeSBarry Smith PetscErrorCode  PetscGetArgs(int *argc,char ***args)
483e5c89e4eSSatish Balay {
484e5c89e4eSSatish Balay   PetscFunctionBegin;
48517186662SBarry Smith   if (!PetscInitializeCalled && PetscFinalizeCalled) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ORDER,"You must call after PetscInitialize() but before PetscFinalize()");
486e5c89e4eSSatish Balay   *argc = PetscGlobalArgc;
487e5c89e4eSSatish Balay   *args = PetscGlobalArgs;
488e5c89e4eSSatish Balay   PetscFunctionReturn(0);
489e5c89e4eSSatish Balay }
490e5c89e4eSSatish Balay 
491e5c89e4eSSatish Balay #undef __FUNCT__
492793721a6SBarry Smith #define __FUNCT__ "PetscGetArguments"
493793721a6SBarry Smith /*@C
494793721a6SBarry Smith    PetscGetArguments - Allows you to access the  command line arguments anywhere
495793721a6SBarry Smith      after PetscInitialize() is called but before PetscFinalize().
496793721a6SBarry Smith 
497793721a6SBarry Smith    Not Collective
498793721a6SBarry Smith 
499793721a6SBarry Smith    Output Parameters:
500793721a6SBarry Smith .  args - the command line arguments
501793721a6SBarry Smith 
502793721a6SBarry Smith    Level: intermediate
503793721a6SBarry Smith 
504793721a6SBarry Smith    Notes:
505793721a6SBarry Smith       This does NOT start with the program name and IS null terminated (final arg is void)
506793721a6SBarry Smith 
507793721a6SBarry Smith    Concepts: command line arguments
508793721a6SBarry Smith 
509793721a6SBarry Smith .seealso: PetscFinalize(), PetscInitializeFortran(), PetscGetArgs(), PetscFreeArguments()
510793721a6SBarry Smith 
511793721a6SBarry Smith @*/
5127087cfbeSBarry Smith PetscErrorCode  PetscGetArguments(char ***args)
513793721a6SBarry Smith {
514793721a6SBarry Smith   PetscInt       i,argc = PetscGlobalArgc;
515793721a6SBarry Smith   PetscErrorCode ierr;
516793721a6SBarry Smith 
517793721a6SBarry Smith   PetscFunctionBegin;
51817186662SBarry Smith   if (!PetscInitializeCalled && PetscFinalizeCalled) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ORDER,"You must call after PetscInitialize() but before PetscFinalize()");
519717030eeSLisandro Dalcin   if (!argc) {*args = 0; PetscFunctionReturn(0);}
520*785e854fSJed Brown   ierr = PetscMalloc1(argc,args);CHKERRQ(ierr);
521793721a6SBarry Smith   for (i=0; i<argc-1; i++) {
522793721a6SBarry Smith     ierr = PetscStrallocpy(PetscGlobalArgs[i+1],&(*args)[i]);CHKERRQ(ierr);
523793721a6SBarry Smith   }
524793721a6SBarry Smith   (*args)[argc-1] = 0;
525793721a6SBarry Smith   PetscFunctionReturn(0);
526793721a6SBarry Smith }
527793721a6SBarry Smith 
528793721a6SBarry Smith #undef __FUNCT__
529793721a6SBarry Smith #define __FUNCT__ "PetscFreeArguments"
530793721a6SBarry Smith /*@C
531793721a6SBarry Smith    PetscFreeArguments - Frees the memory obtained with PetscGetArguments()
532793721a6SBarry Smith 
533793721a6SBarry Smith    Not Collective
534793721a6SBarry Smith 
535793721a6SBarry Smith    Output Parameters:
536793721a6SBarry Smith .  args - the command line arguments
537793721a6SBarry Smith 
538793721a6SBarry Smith    Level: intermediate
539793721a6SBarry Smith 
540793721a6SBarry Smith    Concepts: command line arguments
541793721a6SBarry Smith 
542793721a6SBarry Smith .seealso: PetscFinalize(), PetscInitializeFortran(), PetscGetArgs(), PetscGetArguments()
543793721a6SBarry Smith 
544793721a6SBarry Smith @*/
5457087cfbeSBarry Smith PetscErrorCode  PetscFreeArguments(char **args)
546793721a6SBarry Smith {
547793721a6SBarry Smith   PetscInt       i = 0;
548793721a6SBarry Smith   PetscErrorCode ierr;
549793721a6SBarry Smith 
550793721a6SBarry Smith   PetscFunctionBegin;
551a297a907SKarl Rupp   if (!args) PetscFunctionReturn(0);
552793721a6SBarry Smith   while (args[i]) {
553793721a6SBarry Smith     ierr = PetscFree(args[i]);CHKERRQ(ierr);
554793721a6SBarry Smith     i++;
555793721a6SBarry Smith   }
556793721a6SBarry Smith   ierr = PetscFree(args);CHKERRQ(ierr);
557793721a6SBarry Smith   PetscFunctionReturn(0);
558793721a6SBarry Smith }
559793721a6SBarry Smith 
56011525c0dSBarry Smith #if defined(PETSC_HAVE_SAWS)
56130befbd2SBarry Smith #include <petscconfiginfo.h>
56230befbd2SBarry Smith 
56311525c0dSBarry Smith #undef __FUNCT__
56411525c0dSBarry Smith #define __FUNCT__ "PetscInitializeSAWs"
56511525c0dSBarry Smith PetscErrorCode  PetscInitializeSAWs(const char help[])
56611525c0dSBarry Smith {
56711525c0dSBarry Smith   if (!PetscGlobalRank) {
56830befbd2SBarry Smith     char           cert[PETSC_MAX_PATH_LEN],root[PETSC_MAX_PATH_LEN],*intro,programname[64],*appline,*options,version[64];
56911525c0dSBarry Smith     int            port;
57011525c0dSBarry Smith     PetscBool      flg,rootlocal = PETSC_FALSE,flg2;
57111525c0dSBarry Smith     size_t         applinelen,introlen;
57211525c0dSBarry Smith     PetscErrorCode ierr;
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);
59711525c0dSBarry Smith     }
59811525c0dSBarry Smith     ierr = PetscOptionsHasName(NULL,"-saws_local",&flg2);CHKERRQ(ierr);
59911525c0dSBarry Smith     if (flg2) {
60011525c0dSBarry Smith       char jsdir[PETSC_MAX_PATH_LEN];
60111525c0dSBarry Smith       if (!flg) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SUP,"-saws_local option requires -saws_root option");
60211525c0dSBarry Smith       ierr = PetscSNPrintf(jsdir,PETSC_MAX_PATH_LEN,"%s/js",root);CHKERRQ(ierr);
60311525c0dSBarry Smith       ierr = PetscTestDirectory(jsdir,'r',&flg);CHKERRQ(ierr);
60411525c0dSBarry Smith       if (!flg) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_FILE_READ,"-saws_local option requires js directory in root directory");
60511525c0dSBarry Smith       PetscStackCallSAWs(SAWs_Set_Local_JSHeader,());CHKERRQ(ierr);
60611525c0dSBarry Smith     }
60711525c0dSBarry Smith     ierr = PetscGetProgramName(programname,64);CHKERRQ(ierr);
60811525c0dSBarry Smith     ierr = PetscStrlen(help,&applinelen);CHKERRQ(ierr);
60911525c0dSBarry Smith     introlen   = 4096 + applinelen;
61011525c0dSBarry Smith     applinelen += 256;
61111525c0dSBarry Smith     ierr = PetscMalloc(applinelen,&appline);CHKERRQ(ierr);
61211525c0dSBarry Smith     ierr = PetscMalloc(introlen,&intro);CHKERRQ(ierr);
61311525c0dSBarry Smith 
61411525c0dSBarry Smith     if (rootlocal) {
61511525c0dSBarry Smith       ierr = PetscSNPrintf(appline,applinelen,"%s.c.html",programname);CHKERRQ(ierr);
61611525c0dSBarry Smith       ierr = PetscTestFile(appline,'r',&rootlocal);CHKERRQ(ierr);
61711525c0dSBarry Smith     }
61830befbd2SBarry Smith     ierr = PetscOptionsGetAll(&options);CHKERRQ(ierr);
61911525c0dSBarry Smith     if (rootlocal && help) {
62030befbd2SBarry 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);
62111525c0dSBarry Smith     } else if (help) {
62230befbd2SBarry Smith       ierr = PetscSNPrintf(appline,applinelen,"<center>Running %s %s</center><br><center><pre>%s</pre></center><br>\n",programname,options,help);
62311525c0dSBarry Smith     } else {
62430befbd2SBarry Smith       ierr = PetscSNPrintf(appline,applinelen,"<center> Running %s %s</center><br>\n",programname,options);
62511525c0dSBarry Smith     }
626b0bb5815SBarry Smith     ierr = PetscFree(options);CHKERRQ(ierr);
62730befbd2SBarry Smith     ierr = PetscGetVersion(version,sizeof(version));CHKERRQ(ierr);
62811525c0dSBarry Smith     ierr = PetscSNPrintf(intro,introlen,"<body>\n"
62911525c0dSBarry 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"
63030befbd2SBarry 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"
63130befbd2SBarry Smith                          "%s",version,petscconfigureruntime,petscconfigureoptions,appline);
63211525c0dSBarry Smith     PetscStackCallSAWs(SAWs_Set_Body,("index.html",0,intro));
63311525c0dSBarry Smith     ierr = PetscFree(intro);CHKERRQ(ierr);
63411525c0dSBarry Smith     ierr = PetscFree(appline);CHKERRQ(ierr);
63511525c0dSBarry Smith     PetscStackCallSAWs(SAWs_Initialize,());
63611525c0dSBarry Smith     ierr = PetscCitationsRegister("@TechReport{ saws,"
63711525c0dSBarry Smith                                   "Author = {Matt Otten and Jed Brown and Barry Smith},"
63811525c0dSBarry Smith                                   "Title  = {Scientific Application Web Server (SAWs) Users Manual},"
63911525c0dSBarry Smith                                   "Institution = {Argonne National Laboratory},"
64011525c0dSBarry Smith                                   "Year   = 2013}",NULL);CHKERRQ(ierr);
64111525c0dSBarry Smith   }
64211525c0dSBarry Smith   PetscFunctionReturn(0);
64311525c0dSBarry Smith }
64411525c0dSBarry Smith #endif
64511525c0dSBarry Smith 
646793721a6SBarry Smith #undef __FUNCT__
647e5c89e4eSSatish Balay #define __FUNCT__ "PetscInitialize"
648e5c89e4eSSatish Balay /*@C
649e5c89e4eSSatish Balay    PetscInitialize - Initializes the PETSc database and MPI.
650e5c89e4eSSatish Balay    PetscInitialize() calls MPI_Init() if that has yet to be called,
651e5c89e4eSSatish Balay    so this routine should always be called near the beginning of
652e5c89e4eSSatish Balay    your program -- usually the very first line!
653e5c89e4eSSatish Balay 
654e5c89e4eSSatish Balay    Collective on MPI_COMM_WORLD or PETSC_COMM_WORLD if it has been set
655e5c89e4eSSatish Balay 
656e5c89e4eSSatish Balay    Input Parameters:
657e5c89e4eSSatish Balay +  argc - count of number of command line arguments
658e5c89e4eSSatish Balay .  args - the command line arguments
6590298fd71SBarry Smith .  file - [optional] PETSc database file, also checks ~username/.petscrc and .petscrc use NULL to not check for
660fc2bca9aSBarry Smith           code specific file. Use -skip_petscrc in the code specific file to skip the .petscrc files
6610298fd71SBarry Smith -  help - [optional] Help message to print, use NULL for no message
662e5c89e4eSSatish Balay 
66305827820SBarry Smith    If you wish PETSc code to run ONLY on a subcommunicator of MPI_COMM_WORLD, create that
66405827820SBarry Smith    communicator first and assign it to PETSC_COMM_WORLD BEFORE calling PetscInitialize(). Thus if you are running a
66505827820SBarry Smith    four process job and two processes will run PETSc and have PetscInitialize() and PetscFinalize() and two process will not,
66605827820SBarry Smith    then do this. If ALL processes in the job are using PetscInitialize() and PetscFinalize() then you don't need to do this, even
66705827820SBarry Smith    if different subcommunicators of the job are doing different things with PETSc.
668e5c89e4eSSatish Balay 
669e5c89e4eSSatish Balay    Options Database Keys:
670e5c89e4eSSatish Balay +  -start_in_debugger [noxterm,dbx,xdb,gdb,...] - Starts program in debugger
671e5c89e4eSSatish Balay .  -on_error_attach_debugger [noxterm,dbx,xdb,gdb,...] - Starts debugger when error detected
672e5c89e4eSSatish Balay .  -on_error_emacs <machinename> causes emacsclient to jump to error file
673b52f573bSBarry Smith .  -on_error_abort calls abort() when error detected (no traceback)
674e8fb0fc0SBarry Smith .  -on_error_mpiabort calls MPI_abort() when error detected
675e8fb0fc0SBarry Smith .  -error_output_stderr prints error messages to stderr instead of the default stdout
676e8fb0fc0SBarry Smith .  -error_output_none does not print the error messages (but handles errors in the same way as if this was not called)
677e5c89e4eSSatish Balay .  -debugger_nodes [node1,node2,...] - Indicates nodes to start in debugger
678e5c89e4eSSatish Balay .  -debugger_pause [sleeptime] (in seconds) - Pauses debugger
679e5c89e4eSSatish Balay .  -stop_for_debugger - Print message on how to attach debugger manually to
680e5c89e4eSSatish Balay                         process and wait (-debugger_pause) seconds for attachment
6812fb0ec9aSBarry Smith .  -malloc - Indicates use of PETSc error-checking malloc (on by default for debug version of libraries)
682e5c89e4eSSatish Balay .  -malloc no - Indicates not to use error-checking malloc
6832fb0ec9aSBarry Smith .  -malloc_debug - check for memory corruption at EVERY malloc or free
684aee23540SBarry Smith .  -malloc_dump - prints a list of all unfreed memory at the end of the run
685dc92acbaSJed Brown .  -malloc_test - like -malloc_dump -malloc_debug, but only active for debugging builds
686e5c89e4eSSatish Balay .  -fp_trap - Stops on floating point exceptions (Note that on the
687e5c89e4eSSatish Balay               IBM RS6000 this slows code by at least a factor of 10.)
688e5c89e4eSSatish Balay .  -no_signal_handler - Indicates not to trap error signals
689e5c89e4eSSatish Balay .  -shared_tmp - indicates /tmp directory is shared by all processors
690e5c89e4eSSatish Balay .  -not_shared_tmp - each processor has own /tmp
691e5c89e4eSSatish Balay .  -tmp - alternative name of /tmp directory
692e5c89e4eSSatish Balay .  -get_total_flops - returns total flops done by all processors
693142c234bSBarry Smith -  -memory_info - Print memory usage at end of run
694e5c89e4eSSatish Balay 
695e5c89e4eSSatish Balay    Options Database Keys for Profiling:
6960598bfebSBarry Smith    See the <a href="../../docs/manual.pdf#nameddest=ch_profiling">profiling chapter of the users manual</a> for details.
697495fc317SBarry Smith +  -info <optional filename> - Prints verbose information to the screen
698495fc317SBarry Smith .  -info_exclude <null,vec,mat,pc,ksp,snes,ts> - Excludes some of the verbose messages
699495fc317SBarry Smith .  -log_sync - Log the synchronization in scatters, inner products and norms
700495fc317SBarry Smith .  -log_trace [filename] - Print traces of all PETSc calls to the screen (useful to determine where a program
701e5c89e4eSSatish Balay         hangs without running in the debugger).  See PetscLogTraceBegin().
702495fc317SBarry Smith .  -log_summary [filename] - Prints summary of flop and timing information to screen. If the filename is specified the
703495fc317SBarry Smith         summary is written to the file.  See PetscLogView().
704495fc317SBarry Smith .  -log_summary_python [filename] - Prints data on of flop and timing usage to a file or screen. See PetscLogPrintSViewPython().
705495fc317SBarry Smith .  -log_all [filename] - Logs extensive profiling information  See PetscLogDump().
706495fc317SBarry Smith .  -log [filename] - Logs basic profiline information  See PetscLogDump().
707495fc317SBarry Smith -  -log_mpe [filename] - Creates a logfile viewable by the utility Jumpshot (in MPICH distribution)
708495fc317SBarry Smith 
709495fc317SBarry Smith     Only one of -log_trace, -log_summary, -log_all, -log, or -log_mpe may be used at a time
710e5c89e4eSSatish Balay 
711e5c89e4eSSatish Balay    Environmental Variables:
712e5c89e4eSSatish Balay +   PETSC_TMP - alternative tmp directory
713e5c89e4eSSatish Balay .   PETSC_SHARED_TMP - tmp is shared by all processes
714e5c89e4eSSatish Balay .   PETSC_NOT_SHARED_TMP - each process has its own private tmp
715e5c89e4eSSatish Balay .   PETSC_VIEWER_SOCKET_PORT - socket number to use for socket viewer
716e5c89e4eSSatish Balay -   PETSC_VIEWER_SOCKET_MACHINE - machine to use for socket viewer to connect to
717e5c89e4eSSatish Balay 
718e5c89e4eSSatish Balay 
719e5c89e4eSSatish Balay    Level: beginner
720e5c89e4eSSatish Balay 
721e5c89e4eSSatish Balay    Notes:
722e5c89e4eSSatish Balay    If for some reason you must call MPI_Init() separately, call
723e5c89e4eSSatish Balay    it before PetscInitialize().
724e5c89e4eSSatish Balay 
725e5c89e4eSSatish Balay    Fortran Version:
726e5c89e4eSSatish Balay    In Fortran this routine has the format
727e5c89e4eSSatish Balay $       call PetscInitialize(file,ierr)
728e5c89e4eSSatish Balay 
729e5c89e4eSSatish Balay +   ierr - error return code
7300298fd71SBarry Smith -  file - [optional] PETSc database file, also checks ~username/.petscrc and .petscrc use NULL_CHARACTER to not check for
731fc2bca9aSBarry Smith           code specific file. Use -skip_petscrc in the code specific file to skip the .petscrc files
732e5c89e4eSSatish Balay 
733e5c89e4eSSatish Balay    Important Fortran Note:
7340298fd71SBarry Smith    In Fortran, you MUST use NULL_CHARACTER to indicate a
7350298fd71SBarry Smith    null character string; you CANNOT just use NULL as
7360598bfebSBarry Smith    in the C version. See the <a href="../../docs/manual.pdf">users manual</a> for details.
737e5c89e4eSSatish Balay 
73801cb0274SBarry Smith    If your main program is C but you call Fortran code that also uses PETSc you need to call PetscInitializeFortran() soon after
73901cb0274SBarry Smith    calling PetscInitialize().
740e5c89e4eSSatish Balay 
741e5c89e4eSSatish Balay    Concepts: initializing PETSc
742e5c89e4eSSatish Balay 
74301cb0274SBarry Smith .seealso: PetscFinalize(), PetscInitializeFortran(), PetscGetArgs(), PetscInitializeNoArguments()
744e5c89e4eSSatish Balay 
745e5c89e4eSSatish Balay @*/
7467087cfbeSBarry Smith PetscErrorCode  PetscInitialize(int *argc,char ***args,const char file[],const char help[])
747e5c89e4eSSatish Balay {
748e5c89e4eSSatish Balay   PetscErrorCode ierr;
7494bb5149bSJed Brown   PetscMPIInt    flag, size;
750aa5bb8c0SSatish Balay   PetscInt       nodesize;
751ace3abfcSBarry Smith   PetscBool      flg;
752e5c89e4eSSatish Balay   char           hostname[256];
753e5c89e4eSSatish Balay 
754e5c89e4eSSatish Balay   PetscFunctionBegin;
755e5c89e4eSSatish Balay   if (PetscInitializeCalled) PetscFunctionReturn(0);
756e5c89e4eSSatish Balay 
757ae9b4142SLisandro Dalcin   /* these must be initialized in a routine, not as a constant declaration*/
758d89683f4Sbcordonn   PETSC_STDOUT = stdout;
759ae9b4142SLisandro Dalcin   PETSC_STDERR = stderr;
760e5c89e4eSSatish Balay 
761e5c89e4eSSatish Balay   ierr = PetscOptionsCreate();CHKERRQ(ierr);
762e5c89e4eSSatish Balay 
763e5c89e4eSSatish Balay   /*
764e5c89e4eSSatish Balay      We initialize the program name here (before MPI_Init()) because MPICH has a bug in
765e5c89e4eSSatish Balay      it that it sets args[0] on all processors to be args[0] on the first processor.
766e5c89e4eSSatish Balay   */
767e5c89e4eSSatish Balay   if (argc && *argc) {
768e5c89e4eSSatish Balay     ierr = PetscSetProgramName(**args);CHKERRQ(ierr);
769e5c89e4eSSatish Balay   } else {
770e5c89e4eSSatish Balay     ierr = PetscSetProgramName("Unknown Name");CHKERRQ(ierr);
771e5c89e4eSSatish Balay   }
772e5c89e4eSSatish Balay 
773e5c89e4eSSatish Balay   ierr = MPI_Initialized(&flag);CHKERRQ(ierr);
774e5c89e4eSSatish Balay   if (!flag) {
775e32f2f54SBarry 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");
7765e765c61SJed Brown #if defined(PETSC_HAVE_MPI_INIT_THREAD)
7775e765c61SJed Brown     {
7785e765c61SJed Brown       PetscMPIInt provided;
7795e765c61SJed Brown       ierr = MPI_Init_thread(argc,args,MPI_THREAD_FUNNELED,&provided);CHKERRQ(ierr);
7805e765c61SJed Brown     }
7815e765c61SJed Brown #else
782e5c89e4eSSatish Balay     ierr = MPI_Init(argc,args);CHKERRQ(ierr);
7835e765c61SJed Brown #endif
784e5c89e4eSSatish Balay     PetscBeganMPI = PETSC_TRUE;
785e5c89e4eSSatish Balay   }
786e5c89e4eSSatish Balay   if (argc && args) {
787e5c89e4eSSatish Balay     PetscGlobalArgc = *argc;
788e5c89e4eSSatish Balay     PetscGlobalArgs = *args;
789e5c89e4eSSatish Balay   }
790e5c89e4eSSatish Balay   PetscFinalizeCalled = PETSC_FALSE;
791e5c89e4eSSatish Balay 
792a297a907SKarl Rupp   if (PETSC_COMM_WORLD == MPI_COMM_NULL) PETSC_COMM_WORLD = MPI_COMM_WORLD;
793d54338ecSKarl Rupp   ierr = MPI_Comm_set_errhandler(PETSC_COMM_WORLD,MPI_ERRORS_RETURN);CHKERRQ(ierr);
794e5c89e4eSSatish Balay 
795e5c89e4eSSatish Balay   /* Done after init due to a bug in MPICH-GM? */
796e5c89e4eSSatish Balay   ierr = PetscErrorPrintfInitialize();CHKERRQ(ierr);
797e5c89e4eSSatish Balay 
798e5c89e4eSSatish Balay   ierr = MPI_Comm_rank(MPI_COMM_WORLD,&PetscGlobalRank);CHKERRQ(ierr);
799e5c89e4eSSatish Balay   ierr = MPI_Comm_size(MPI_COMM_WORLD,&PetscGlobalSize);CHKERRQ(ierr);
800e5c89e4eSSatish Balay 
8018ad47952SJed Brown   MPIU_BOOL = MPI_INT;
8028ad47952SJed Brown   MPIU_ENUM = MPI_INT;
8038ad47952SJed Brown 
804e5c89e4eSSatish Balay   /*
805e5c89e4eSSatish Balay      Initialized the global complex variable; this is because with
806e5c89e4eSSatish Balay      shared libraries the constructors for global variables
807e5c89e4eSSatish Balay      are not called; at least on IRIX.
808e5c89e4eSSatish Balay   */
809886cfec0SSatish Balay #if defined(PETSC_HAVE_COMPLEX)
810e5c89e4eSSatish Balay   {
811a24ee22aSSatish Balay #if defined(PETSC_CLANGUAGE_CXX)
81250f81f78SJed Brown     PetscComplex ic(0.0,1.0);
813e5c89e4eSSatish Balay     PETSC_i = ic;
814a24ee22aSSatish Balay #elif defined(PETSC_CLANGUAGE_C)
81550f81f78SJed Brown     PETSC_i = _Complex_I;
816b7940d39SSatish Balay #endif
817762437b8SSatish Balay   }
818762437b8SSatish Balay 
8192c876bd9SBarry Smith #if !defined(PETSC_HAVE_MPI_C_DOUBLE_COMPLEX)
820e69cd0e6SSatish Balay   ierr = MPI_Type_contiguous(2,MPI_DOUBLE,&MPIU_C_DOUBLE_COMPLEX);CHKERRQ(ierr);
821500d8756SSatish Balay   ierr = MPI_Type_commit(&MPIU_C_DOUBLE_COMPLEX);CHKERRQ(ierr);
822500d8756SSatish Balay   ierr = MPI_Type_contiguous(2,MPI_FLOAT,&MPIU_C_COMPLEX);CHKERRQ(ierr);
823500d8756SSatish Balay   ierr = MPI_Type_commit(&MPIU_C_COMPLEX);CHKERRQ(ierr);
8242c876bd9SBarry Smith #endif
825886cfec0SSatish Balay #endif /* PETSC_HAVE_COMPLEX */
826e5c89e4eSSatish Balay 
827e5c89e4eSSatish Balay   /*
828e5c89e4eSSatish Balay      Create the PETSc MPI reduction operator that sums of the first
829e5c89e4eSSatish Balay      half of the entries and maxes the second half.
830e5c89e4eSSatish Balay   */
831e5c89e4eSSatish Balay   ierr = MPI_Op_create(PetscMaxSum_Local,1,&PetscMaxSum_Op);CHKERRQ(ierr);
832e5c89e4eSSatish Balay 
833ce63c4c1SBarry Smith #if defined(PETSC_USE_REAL___FLOAT128)
834c90a1750SBarry Smith   ierr = MPI_Type_contiguous(2,MPI_DOUBLE,&MPIU___FLOAT128);CHKERRQ(ierr);
835c90a1750SBarry Smith   ierr = MPI_Type_commit(&MPIU___FLOAT128);CHKERRQ(ierr);
8367c2de775SJed Brown #if defined(PETSC_HAVE_COMPLEX)
8378c764dc5SJose Roman   ierr = MPI_Type_contiguous(4,MPI_DOUBLE,&MPIU___COMPLEX128);CHKERRQ(ierr);
8388c764dc5SJose Roman   ierr = MPI_Type_commit(&MPIU___COMPLEX128);CHKERRQ(ierr);
8398c764dc5SJose Roman #endif
840d9822059SBarry Smith   ierr = MPI_Op_create(PetscMax_Local,1,&MPIU_MAX);CHKERRQ(ierr);
841d9822059SBarry Smith   ierr = MPI_Op_create(PetscMin_Local,1,&MPIU_MIN);CHKERRQ(ierr);
842c90a1750SBarry Smith #endif
843c90a1750SBarry Smith 
8447c2de775SJed Brown #if (defined(PETSC_HAVE_COMPLEX) && !defined(PETSC_HAVE_MPI_C_DOUBLE_COMPLEX)) || defined(PETSC_USE_REAL___FLOAT128)
845cca4cb22SSatish Balay   ierr = MPI_Op_create(PetscSum_Local,1,&MPIU_SUM);CHKERRQ(ierr);
846cca4cb22SSatish Balay #endif
847cca4cb22SSatish Balay 
848e5c89e4eSSatish Balay   ierr = MPI_Type_contiguous(2,MPIU_SCALAR,&MPIU_2SCALAR);CHKERRQ(ierr);
849e5c89e4eSSatish Balay   ierr = MPI_Type_commit(&MPIU_2SCALAR);CHKERRQ(ierr);
850e5c89e4eSSatish Balay   ierr = MPI_Op_create(PetscADMax_Local,1,&PetscADMax_Op);CHKERRQ(ierr);
851e5c89e4eSSatish Balay   ierr = MPI_Op_create(PetscADMin_Local,1,&PetscADMin_Op);CHKERRQ(ierr);
852e5c89e4eSSatish Balay 
85344041f26SJed Brown #if defined(PETSC_USE_64BIT_INDICES) || !defined(MPI_2INT)
854e5c89e4eSSatish Balay   ierr = MPI_Type_contiguous(2,MPIU_INT,&MPIU_2INT);CHKERRQ(ierr);
855e5c89e4eSSatish Balay   ierr = MPI_Type_commit(&MPIU_2INT);CHKERRQ(ierr);
85644041f26SJed Brown #endif
857e5c89e4eSSatish Balay 
858ec957eceSBarry Smith 
859e5c89e4eSSatish Balay   /*
860480cf27aSJed Brown      Attributes to be set on PETSc communicators
861480cf27aSJed Brown   */
862480cf27aSJed Brown   ierr = MPI_Keyval_create(MPI_NULL_COPY_FN,Petsc_DelCounter,&Petsc_Counter_keyval,(void*)0);CHKERRQ(ierr);
863da3039f7SJed Brown   ierr = MPI_Keyval_create(MPI_NULL_COPY_FN,Petsc_DelComm_Outer,&Petsc_InnerComm_keyval,(void*)0);CHKERRQ(ierr);
864da3039f7SJed Brown   ierr = MPI_Keyval_create(MPI_NULL_COPY_FN,Petsc_DelComm_Inner,&Petsc_OuterComm_keyval,(void*)0);CHKERRQ(ierr);
865480cf27aSJed Brown 
866480cf27aSJed Brown   /*
867e8fb0fc0SBarry Smith      Build the options database
868e5c89e4eSSatish Balay   */
869e5c89e4eSSatish Balay   ierr = PetscOptionsInsert(argc,args,file);CHKERRQ(ierr);
870e5c89e4eSSatish Balay 
8716dc8fec2Sbcordonn 
872e5c89e4eSSatish Balay   /*
873e5c89e4eSSatish Balay      Print main application help message
874e5c89e4eSSatish Balay   */
8750298fd71SBarry Smith   ierr = PetscOptionsHasName(NULL,"-help",&flg);CHKERRQ(ierr);
876e5c89e4eSSatish Balay   if (help && flg) {
877e5c89e4eSSatish Balay     ierr = PetscPrintf(PETSC_COMM_WORLD,help);CHKERRQ(ierr);
878e5c89e4eSSatish Balay   }
879e5c89e4eSSatish Balay   ierr = PetscOptionsCheckInitial_Private();CHKERRQ(ierr);
880e5c89e4eSSatish Balay 
881d45a07a7SBarry Smith   ierr = PetscCitationsInitialize();CHKERRQ(ierr);
882d45a07a7SBarry Smith 
883e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS)
88411525c0dSBarry Smith   ierr = PetscInitializeSAWs(help);CHKERRQ(ierr);
885f4202a44SBarry Smith #endif
886f4202a44SBarry Smith 
887e5c89e4eSSatish Balay   /* SHOULD PUT IN GUARDS: Make sure logging is initialized, even if we do not print it out */
888a9f03627SSatish Balay #if defined(PETSC_USE_LOG)
889e5c89e4eSSatish Balay   ierr = PetscLogBegin_Private();CHKERRQ(ierr);
890a9f03627SSatish Balay #endif
891e5c89e4eSSatish Balay 
892e5c89e4eSSatish Balay   /*
893e5c89e4eSSatish Balay      Load the dynamic libraries (on machines that support them), this registers all
894e5c89e4eSSatish Balay      the solvers etc. (On non-dynamic machines this initializes the PetscDraw and PetscViewer classes)
895e5c89e4eSSatish Balay   */
896e5c89e4eSSatish Balay   ierr = PetscInitialize_DynamicLibraries();CHKERRQ(ierr);
897e5c89e4eSSatish Balay 
898e5c89e4eSSatish Balay   ierr = MPI_Comm_size(PETSC_COMM_WORLD,&size);CHKERRQ(ierr);
899ae15b995SBarry Smith   ierr = PetscInfo1(0,"PETSc successfully started: number of processors = %d\n",size);CHKERRQ(ierr);
900e5c89e4eSSatish Balay   ierr = PetscGetHostName(hostname,256);CHKERRQ(ierr);
901ae15b995SBarry Smith   ierr = PetscInfo1(0,"Running on machine: %s\n",hostname);CHKERRQ(ierr);
902e5c89e4eSSatish Balay 
903e5c89e4eSSatish Balay   ierr = PetscOptionsCheckInitial_Components();CHKERRQ(ierr);
904ef6c6fedSBoyana Norris   /* Check the options database for options related to the options database itself */
905ef6c6fedSBoyana Norris   ierr = PetscOptionsSetFromOptions();CHKERRQ(ierr);
906ef6c6fedSBoyana Norris 
907951e3c8eSBarry Smith #if defined(PETSC_USE_PETSC_MPI_EXTERNAL32)
908e39fd77fSBarry Smith   /*
909e39fd77fSBarry Smith       Tell MPI about our own data representation converter, this would/should be used if extern32 is not supported by the MPI
910e39fd77fSBarry Smith 
911e39fd77fSBarry Smith       Currently not used because it is not supported by MPICH.
912e39fd77fSBarry Smith   */
913e39fd77fSBarry Smith #if !defined(PETSC_WORDS_BIGENDIAN)
9140298fd71SBarry Smith   ierr = MPI_Register_datarep((char*)"petsc",PetscDataRep_read_conv_fn,PetscDataRep_write_conv_fn,PetscDataRep_extent_fn,NULL);CHKERRQ(ierr);
915e39fd77fSBarry Smith #endif
916951e3c8eSBarry Smith #endif
917e39fd77fSBarry Smith 
9180298fd71SBarry Smith   ierr = PetscOptionsGetInt(NULL,"-hmpi_spawn_size",&nodesize,&flg);CHKERRQ(ierr);
919793721a6SBarry Smith   if (flg) {
92023464e94SBarry Smith #if defined(PETSC_HAVE_MPI_COMM_SPAWN)
92185afcc9aSBarry Smith     ierr = PetscHMPISpawn((PetscMPIInt) nodesize);CHKERRQ(ierr); /* worker nodes never return from here; they go directly to PetscEnd() */
92223464e94SBarry Smith #else
92385afcc9aSBarry Smith     SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SUP,"PETSc built without MPI 2 (MPI_Comm_spawn) support, use -hmpi_merge_size instead");
92423464e94SBarry Smith #endif
925793721a6SBarry Smith   } else {
9260298fd71SBarry Smith     ierr = PetscOptionsGetInt(NULL,"-hmpi_merge_size",&nodesize,&flg);CHKERRQ(ierr);
9278002f1cdSBarry Smith     if (flg) {
9280298fd71SBarry Smith       ierr = PetscHMPIMerge((PetscMPIInt) nodesize,NULL,NULL);CHKERRQ(ierr);
92985afcc9aSBarry Smith       if (PetscHMPIWorker) { /* if worker then never enter user code */
930bad7cb1dSBarry Smith         PetscInitializeCalled = PETSC_TRUE;
9313bf036e2SBarry Smith         PetscEnd();
9329505b675SBarry Smith       }
9338002f1cdSBarry Smith     }
934793721a6SBarry Smith   }
935e5c89e4eSSatish Balay 
93635d88935SVictor Minden #if defined(PETSC_HAVE_CUDA)
93720e2c332SMatthew G. Knepley   flg  = PETSC_TRUE;
93820e2c332SMatthew G. Knepley   ierr = PetscOptionsGetBool(NULL,"-cublas",&flg,NULL);CHKERRQ(ierr);
93920e2c332SMatthew G. Knepley   if (flg) {
9404bb5149bSJed Brown     PetscMPIInt p;
941663ba86aSMatthew G Knepley     for (p = 0; p < PetscGlobalSize; ++p) {
942a297a907SKarl Rupp       if (p == PetscGlobalRank) cublasInit();
943663ba86aSMatthew G Knepley       ierr = MPI_Barrier(PETSC_COMM_WORLD);CHKERRQ(ierr);
944663ba86aSMatthew G Knepley     }
9454bb5149bSJed Brown   }
9463e39abd9SVictor Minden #endif
94792e62aa6SBarry Smith 
9480298fd71SBarry Smith   ierr = PetscOptionsHasName(NULL,"-python",&flg);CHKERRQ(ierr);
9499ac80d5eSLisandro Dalcin   if (flg) {
9509ac80d5eSLisandro Dalcin     PetscInitializeCalled = PETSC_TRUE;
9510298fd71SBarry Smith     ierr = PetscPythonInitialize(NULL,NULL);CHKERRQ(ierr);
9529ac80d5eSLisandro Dalcin   }
9539ac80d5eSLisandro Dalcin 
954607a6623SBarry Smith   ierr = PetscThreadCommInitializePackage();CHKERRQ(ierr);
955bd8b14e7SShri Abhyankar 
95641c0b4b3SShri Abhyankar   /*
95741c0b4b3SShri Abhyankar       Setup building of stack frames for all function calls
95841c0b4b3SShri Abhyankar   */
95976386721SLisandro Dalcin   PetscThreadLocalRegister((PetscThreadKey*)&petscstack); /* Creates pthread_key */
960e1167bb9SShri Abhyankar #if defined(PETSC_USE_DEBUG)
961e1167bb9SShri Abhyankar   ierr = PetscStackCreate();CHKERRQ(ierr);
962e1167bb9SShri Abhyankar #endif
963e1167bb9SShri Abhyankar 
9642d53ad75SBarry Smith #if defined(PETSC_SERIALIZE_FUNCTIONS)
9652d53ad75SBarry Smith   ierr = PetscFPTCreate(10000);CHKERRQ(ierr);
9662d53ad75SBarry Smith #endif
9672d53ad75SBarry Smith 
968dff31646SBarry Smith 
969301d30feSBarry Smith   /*
970301d30feSBarry Smith       Once we are completedly initialized then we can set this variables
971301d30feSBarry Smith   */
972301d30feSBarry Smith   PetscInitializeCalled = PETSC_TRUE;
973301d30feSBarry Smith   PetscFunctionReturn(0);
974e5c89e4eSSatish Balay }
975e5c89e4eSSatish Balay 
9764097062eSBarry Smith #if defined(PETSC_USE_LOG)
9772eff7a51SBarry Smith extern PetscObject *PetscObjects;
9782eff7a51SBarry Smith extern PetscInt    PetscObjectsCounts, PetscObjectsMaxCounts;
9794097062eSBarry Smith #endif
980e5c89e4eSSatish Balay 
981e5c89e4eSSatish Balay #undef __FUNCT__
982e5c89e4eSSatish Balay #define __FUNCT__ "PetscFinalize"
983e5c89e4eSSatish Balay /*@C
984e5c89e4eSSatish Balay    PetscFinalize - Checks for options to be called at the conclusion
985e5c89e4eSSatish Balay    of the program. MPI_Finalize() is called only if the user had not
986e5c89e4eSSatish Balay    called MPI_Init() before calling PetscInitialize().
987e5c89e4eSSatish Balay 
988e5c89e4eSSatish Balay    Collective on PETSC_COMM_WORLD
989e5c89e4eSSatish Balay 
990e5c89e4eSSatish Balay    Options Database Keys:
99188c29154SBarry Smith +  -options_table - Calls PetscOptionsView()
992e5c89e4eSSatish Balay .  -options_left - Prints unused options that remain in the database
9937eb1d149SBarry 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
994e5c89e4eSSatish Balay .  -mpidump - Calls PetscMPIDump()
995e5c89e4eSSatish Balay .  -malloc_dump - Calls PetscMallocDump()
996e5c89e4eSSatish Balay .  -malloc_info - Prints total memory usage
997e5c89e4eSSatish Balay -  -malloc_log - Prints summary of memory usage
998e5c89e4eSSatish Balay 
999e5c89e4eSSatish Balay    Level: beginner
1000e5c89e4eSSatish Balay 
1001e5c89e4eSSatish Balay    Note:
1002e5c89e4eSSatish Balay    See PetscInitialize() for more general runtime options.
1003e5c89e4eSSatish Balay 
100488c29154SBarry Smith .seealso: PetscInitialize(), PetscOptionsView(), PetscMallocDump(), PetscMPIDump(), PetscEnd()
1005e5c89e4eSSatish Balay @*/
10067087cfbeSBarry Smith PetscErrorCode  PetscFinalize(void)
1007e5c89e4eSSatish Balay {
1008e5c89e4eSSatish Balay   PetscErrorCode ierr;
10094bb5149bSJed Brown   PetscMPIInt    rank;
1010a8d2bbe5SBarry Smith   PetscInt       nopt;
10112bf49c77SBarry Smith   PetscBool      flg1 = PETSC_FALSE,flg2 = PETSC_FALSE,flg3 = PETSC_FALSE;
1012dff31646SBarry Smith   PetscBool      flg;
101310463e74SBarry Smith #if defined(PETSC_USE_LOG)
101410463e74SBarry Smith   char           mname[PETSC_MAX_PATH_LEN];
101510463e74SBarry Smith #endif
1016e5c89e4eSSatish Balay 
1017e5c89e4eSSatish Balay   PetscFunctionBegin;
1018e5c89e4eSSatish Balay   if (!PetscInitializeCalled) {
10194b09e917SBarry Smith     printf("PetscInitialize() must be called before PetscFinalize()\n");
10204b09e917SBarry Smith     PetscFunctionReturn(PETSC_ERR_ARG_WRONGSTATE);
1021e5c89e4eSSatish Balay   }
10220298fd71SBarry Smith   ierr = PetscInfo(NULL,"PetscFinalize() called\n");CHKERRQ(ierr);
1023b022a5c1SBarry Smith 
10241f817a21SBarry Smith   ierr = MPI_Comm_rank(PETSC_COMM_WORLD,&rank);CHKERRQ(ierr);
10251f817a21SBarry Smith 
10261f817a21SBarry Smith   ierr = PetscOptionsHasName(NULL,"-citations",&flg);CHKERRQ(ierr);
1027dff31646SBarry Smith   if (flg) {
10281f817a21SBarry Smith     char  *cits, filename[PETSC_MAX_PATH_LEN];
10291f817a21SBarry Smith     FILE  *fd = PETSC_STDOUT;
10301f817a21SBarry Smith 
10311f817a21SBarry Smith     ierr = PetscOptionsGetString(NULL,"-citations",filename,PETSC_MAX_PATH_LEN,NULL);CHKERRQ(ierr);
10321f817a21SBarry Smith     if (filename[0]) {
10331f817a21SBarry Smith       ierr = PetscFOpen(PETSC_COMM_WORLD,filename,"w",&fd);CHKERRQ(ierr);
10341f817a21SBarry Smith     }
1035dff31646SBarry Smith     ierr = PetscSegBufferGet(PetscCitationsList,1,&cits);CHKERRQ(ierr);
1036dff31646SBarry Smith     cits[0] = 0;
1037dff31646SBarry Smith     ierr = PetscSegBufferExtractAlloc(PetscCitationsList,&cits);CHKERRQ(ierr);
10381f817a21SBarry Smith     ierr = PetscFPrintf(PETSC_COMM_WORLD,fd,"If you publish results based on this computation please cite the following:\n");CHKERRQ(ierr);
10391f817a21SBarry Smith     ierr = PetscFPrintf(PETSC_COMM_WORLD,fd,"===========================================================================\n");CHKERRQ(ierr);
10401f817a21SBarry Smith     ierr = PetscFPrintf(PETSC_COMM_WORLD,fd,"%s",cits);CHKERRQ(ierr);
10411f817a21SBarry Smith     ierr = PetscFPrintf(PETSC_COMM_WORLD,fd,"===========================================================================\n");CHKERRQ(ierr);
10421f817a21SBarry Smith     ierr = PetscFClose(PETSC_COMM_WORLD,fd);CHKERRQ(ierr);
1043dff31646SBarry Smith     ierr = PetscFree(cits);CHKERRQ(ierr);
1044dff31646SBarry Smith   }
1045dff31646SBarry Smith   ierr = PetscSegBufferDestroy(&PetscCitationsList);CHKERRQ(ierr);
1046dff31646SBarry Smith 
10472d53ad75SBarry Smith #if defined(PETSC_SERIALIZE_FUNCTIONS)
10482d53ad75SBarry Smith   ierr = PetscFPTDestroy();CHKERRQ(ierr);
10492d53ad75SBarry Smith #endif
10502d53ad75SBarry Smith 
10512d53ad75SBarry Smith 
1052e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS)
1053dff31646SBarry Smith   flg = PETSC_FALSE;
1054e78c4b8cSBarry Smith   ierr = PetscOptionsGetBool(NULL,"-saw_options",&flg,NULL);CHKERRQ(ierr);
1055d5649816SBarry Smith   if (flg) {
1056e04113cfSBarry Smith     ierr = PetscOptionsSAWsDestroy();CHKERRQ(ierr);
1057d5649816SBarry Smith   }
1058d5649816SBarry Smith #endif
1059d5649816SBarry Smith 
1060681455b2SBarry Smith #if defined(PETSC_HAVE_X)
1061681455b2SBarry Smith   flg1 = PETSC_FALSE;
1062681455b2SBarry Smith   ierr = PetscOptionsGetBool(NULL,"-x_virtual",&flg1,NULL);CHKERRQ(ierr);
1063681455b2SBarry Smith   if (flg1) {
1064681455b2SBarry Smith     /*  this is a crude hack, but better than nothing */
1065681455b2SBarry Smith     ierr = PetscPOpen(PETSC_COMM_WORLD,NULL,"pkill -9 Xvfb","r",NULL);CHKERRQ(ierr);
1066681455b2SBarry Smith   }
1067681455b2SBarry Smith #endif
1068681455b2SBarry Smith 
106985afcc9aSBarry Smith   ierr = PetscHMPIFinalize();CHKERRQ(ierr);
1070d3f95da6SShri Abhyankar 
10710298fd71SBarry Smith   ierr = PetscOptionsGetBool(NULL,"-malloc_info",&flg2,NULL);CHKERRQ(ierr);
1072e5c89e4eSSatish Balay   if (!flg2) {
107390d69ab7SBarry Smith     flg2 = PETSC_FALSE;
10740298fd71SBarry Smith     ierr = PetscOptionsGetBool(NULL,"-memory_info",&flg2,NULL);CHKERRQ(ierr);
1075e5c89e4eSSatish Balay   }
1076e5c89e4eSSatish Balay   if (flg2) {
1077e5c89e4eSSatish Balay     ierr = PetscMemoryShowUsage(PETSC_VIEWER_STDOUT_WORLD,"Summary of Memory Usage in PETSc\n");CHKERRQ(ierr);
1078e5c89e4eSSatish Balay   }
1079e5c89e4eSSatish Balay 
1080e5c89e4eSSatish Balay #if defined(PETSC_USE_LOG)
108190d69ab7SBarry Smith   flg1 = PETSC_FALSE;
10820298fd71SBarry Smith   ierr = PetscOptionsGetBool(NULL,"-get_total_flops",&flg1,NULL);CHKERRQ(ierr);
1083e5c89e4eSSatish Balay   if (flg1) {
1084e5c89e4eSSatish Balay     PetscLogDouble flops = 0;
1085205a32c2SJed Brown     ierr = MPI_Reduce(&petsc_TotalFlops,&flops,1,MPI_DOUBLE,MPI_SUM,0,PETSC_COMM_WORLD);CHKERRQ(ierr);
1086e5c89e4eSSatish Balay     ierr = PetscPrintf(PETSC_COMM_WORLD,"Total flops over all processors %g\n",flops);CHKERRQ(ierr);
1087e5c89e4eSSatish Balay   }
1088e5c89e4eSSatish Balay #endif
1089e5c89e4eSSatish Balay 
1090e5c89e4eSSatish Balay 
1091e5c89e4eSSatish Balay #if defined(PETSC_USE_LOG)
1092e5c89e4eSSatish Balay #if defined(PETSC_HAVE_MPE)
1093e5c89e4eSSatish Balay   mname[0] = 0;
1094a297a907SKarl Rupp 
10950298fd71SBarry Smith   ierr = PetscOptionsGetString(NULL,"-log_mpe",mname,PETSC_MAX_PATH_LEN,&flg1);CHKERRQ(ierr);
1096e5c89e4eSSatish Balay   if (flg1) {
1097e5c89e4eSSatish Balay     if (mname[0]) {ierr = PetscLogMPEDump(mname);CHKERRQ(ierr);}
1098e5c89e4eSSatish Balay     else          {ierr = PetscLogMPEDump(0);CHKERRQ(ierr);}
1099e5c89e4eSSatish Balay   }
1100e5c89e4eSSatish Balay #endif
1101e5c89e4eSSatish Balay   mname[0] = 0;
1102a297a907SKarl Rupp 
11030298fd71SBarry Smith   ierr = PetscOptionsGetString(NULL,"-log_summary",mname,PETSC_MAX_PATH_LEN,&flg1);CHKERRQ(ierr);
1104e5c89e4eSSatish Balay   if (flg1) {
110591eabc43SBarry Smith     PetscViewer viewer;
110691eabc43SBarry Smith     if (mname[0]) {
110791eabc43SBarry Smith       ierr = PetscViewerASCIIOpen(PETSC_COMM_WORLD,mname,&viewer);CHKERRQ(ierr);
110891eabc43SBarry Smith       ierr = PetscLogView(viewer);CHKERRQ(ierr);
11096bf464f9SBarry Smith       ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr);
111033f85c2fSBarry Smith     } else {
111133f85c2fSBarry Smith       viewer = PETSC_VIEWER_STDOUT_WORLD;
111233f85c2fSBarry Smith       ierr   = PetscLogView(viewer);CHKERRQ(ierr);
111333f85c2fSBarry Smith     }
1114e5c89e4eSSatish Balay   }
1115e5c89e4eSSatish Balay 
1116ff5bc46bSBarry Smith   mname[0] = 0;
1117a297a907SKarl Rupp 
11180298fd71SBarry Smith   ierr = PetscOptionsGetString(NULL,"-log_summary_python",mname,PETSC_MAX_PATH_LEN,&flg1);CHKERRQ(ierr);
1119ff5bc46bSBarry Smith   if (flg1) {
1120ff5bc46bSBarry Smith     PetscViewer viewer;
1121ff5bc46bSBarry Smith     if (mname[0]) {
1122ff5bc46bSBarry Smith       ierr = PetscViewerASCIIOpen(PETSC_COMM_WORLD,mname,&viewer);CHKERRQ(ierr);
112391eabc43SBarry Smith       ierr = PetscLogViewPython(viewer);CHKERRQ(ierr);
11246bf464f9SBarry Smith       ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr);
112533f85c2fSBarry Smith     } else {
112633f85c2fSBarry Smith       viewer = PETSC_VIEWER_STDOUT_WORLD;
112733f85c2fSBarry Smith       ierr   = PetscLogViewPython(viewer);CHKERRQ(ierr);
112833f85c2fSBarry Smith     }
1129ff5bc46bSBarry Smith   }
1130ff5bc46bSBarry Smith 
11310298fd71SBarry Smith   ierr = PetscOptionsGetString(NULL,"-log_detailed",mname,PETSC_MAX_PATH_LEN,&flg1);CHKERRQ(ierr);
113278392ef1SBarry Smith   if (flg1) {
113378392ef1SBarry Smith     if (mname[0])  {ierr = PetscLogPrintDetailed(PETSC_COMM_WORLD,mname);CHKERRQ(ierr);}
113478392ef1SBarry Smith     else           {ierr = PetscLogPrintDetailed(PETSC_COMM_WORLD,0);CHKERRQ(ierr);}
113578392ef1SBarry Smith   }
113678392ef1SBarry Smith 
1137e5c89e4eSSatish Balay   mname[0] = 0;
1138a297a907SKarl Rupp 
11390298fd71SBarry Smith   ierr = PetscOptionsGetString(NULL,"-log_all",mname,PETSC_MAX_PATH_LEN,&flg1);CHKERRQ(ierr);
11400298fd71SBarry Smith   ierr = PetscOptionsGetString(NULL,"-log",mname,PETSC_MAX_PATH_LEN,&flg2);CHKERRQ(ierr);
1141e5c89e4eSSatish Balay   if (flg1 || flg2) {
1142e5c89e4eSSatish Balay     if (mname[0]) PetscLogDump(mname);
1143e5c89e4eSSatish Balay     else          PetscLogDump(0);
1144e5c89e4eSSatish Balay   }
1145e5c89e4eSSatish Balay #endif
114610463e74SBarry Smith 
1147b58ca069SBarry Smith   /*
1148b58ca069SBarry Smith      Free all objects registered with PetscObjectRegisterDestroy() such as PETSC_VIEWER_XXX_().
1149b58ca069SBarry Smith   */
1150b58ca069SBarry Smith   ierr = PetscObjectRegisterDestroyAll();CHKERRQ(ierr);
1151b58ca069SBarry Smith 
115233f85c2fSBarry Smith   ierr = PetscStackDestroy();CHKERRQ(ierr);
115376386721SLisandro Dalcin   PetscThreadLocalDestroy((PetscThreadKey)petscstack); /* Deletes pthread_key */
115410463e74SBarry Smith 
115590d69ab7SBarry Smith   flg1 = PETSC_FALSE;
11560298fd71SBarry Smith   ierr = PetscOptionsGetBool(NULL,"-no_signal_handler",&flg1,NULL);CHKERRQ(ierr);
1157e5c89e4eSSatish Balay   if (!flg1) { ierr = PetscPopSignalHandler();CHKERRQ(ierr);}
115890d69ab7SBarry Smith   flg1 = PETSC_FALSE;
11590298fd71SBarry Smith   ierr = PetscOptionsGetBool(NULL,"-mpidump",&flg1,NULL);CHKERRQ(ierr);
1160e5c89e4eSSatish Balay   if (flg1) {
1161e5c89e4eSSatish Balay     ierr = PetscMPIDump(stdout);CHKERRQ(ierr);
1162e5c89e4eSSatish Balay   }
116390d69ab7SBarry Smith   flg1 = PETSC_FALSE;
116490d69ab7SBarry Smith   flg2 = PETSC_FALSE;
11658bb29257SSatish Balay   /* preemptive call to avoid listing this option in options table as unused */
11660298fd71SBarry Smith   ierr = PetscOptionsHasName(NULL,"-malloc_dump",&flg1);CHKERRQ(ierr);
11670298fd71SBarry Smith   ierr = PetscOptionsHasName(NULL,"-objects_dump",&flg1);CHKERRQ(ierr);
11680298fd71SBarry Smith   ierr = PetscOptionsGetBool(NULL,"-options_table",&flg2,NULL);CHKERRQ(ierr);
1169e4c476e2SSatish Balay 
1170e5c89e4eSSatish Balay   if (flg2) {
1171be56827dSJed Brown     PetscViewer viewer;
1172be56827dSJed Brown     ierr = PetscViewerASCIIGetStdout(PETSC_COMM_WORLD,&viewer);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 
118185afcc9aSBarry Smith   if (!PetscHMPIWorker) { /* worker processes skip this because they do not usually process options */
118233fc4174SSatish Balay     flg3 = PETSC_FALSE; /* default value is required */
11830298fd71SBarry Smith     ierr = PetscOptionsGetBool(NULL,"-options_left",&flg3,&flg1);CHKERRQ(ierr);
1184e5c89e4eSSatish Balay     ierr = PetscOptionsAllUsed(&nopt);CHKERRQ(ierr);
1185e5c89e4eSSatish Balay     if (flg3) {
1186e5c89e4eSSatish Balay       if (!flg2) { /* have not yet printed the options */
1187be56827dSJed Brown         PetscViewer viewer;
1188be56827dSJed Brown         ierr = PetscViewerASCIIGetStdout(PETSC_COMM_WORLD,&viewer);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     }
1211931f367cSBarry Smith   }
1212e5c89e4eSSatish Balay 
1213e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS)
1214d45a07a7SBarry Smith   if (!PetscGlobalRank) {
121587f587eeSBarry Smith     ierr = PetscStackSAWsViewOff();CHKERRQ(ierr);
121616ad0300SBarry Smith     PetscStackCallSAWs(SAWs_Finalize,());
1217d45a07a7SBarry Smith   }
1218ec957eceSBarry Smith #endif
1219ec957eceSBarry Smith 
1220eea2bdeeSJed Brown   {
1221eea2bdeeSJed Brown     PetscThreadComm tcomm_world;
1222eea2bdeeSJed Brown     ierr = PetscGetThreadCommWorld(&tcomm_world);CHKERRQ(ierr);
1223eea2bdeeSJed Brown     /* Free global thread communicator */
1224eea2bdeeSJed Brown     ierr = PetscThreadCommDestroy(&tcomm_world);CHKERRQ(ierr);
1225eea2bdeeSJed Brown   }
1226eea2bdeeSJed Brown 
12274097062eSBarry Smith #if defined(PETSC_USE_LOG)
122810463e74SBarry Smith   /*
1229dbc8283eSBarry Smith        List all objects the user may have forgot to free
12302eff7a51SBarry Smith   */
12310298fd71SBarry Smith   ierr = PetscOptionsHasName(NULL,"-objects_dump",&flg1);CHKERRQ(ierr);
1232a64a8e02SBarry Smith   if (flg1) {
1233a64a8e02SBarry Smith     MPI_Comm local_comm;
12347eb1d149SBarry Smith     char     string[64];
1235a64a8e02SBarry Smith 
12360298fd71SBarry Smith     ierr = PetscOptionsGetString(NULL,"-objects_dump",string,64,NULL);CHKERRQ(ierr);
1237a64a8e02SBarry Smith     ierr = MPI_Comm_dup(MPI_COMM_WORLD,&local_comm);CHKERRQ(ierr);
1238a64a8e02SBarry Smith     ierr = PetscSequentialPhaseBegin_Private(local_comm,1);CHKERRQ(ierr);
12397eb1d149SBarry Smith     ierr = PetscObjectsDump(stdout,(string[0] == 'a') ? PETSC_TRUE : PETSC_FALSE);CHKERRQ(ierr);
1240a64a8e02SBarry Smith     ierr = PetscSequentialPhaseEnd_Private(local_comm,1);CHKERRQ(ierr);
1241a64a8e02SBarry Smith     ierr = MPI_Comm_free(&local_comm);CHKERRQ(ierr);
12420a1571b3SBarry Smith   }
12434097062eSBarry Smith #endif
12444097062eSBarry Smith 
12454097062eSBarry Smith #if defined(PETSC_USE_LOG)
1246dbc8283eSBarry Smith   PetscObjectsCounts    = 0;
1247dbc8283eSBarry Smith   PetscObjectsMaxCounts = 0;
1248a297a907SKarl Rupp   ierr = PetscFree(PetscObjects);CHKERRQ(ierr);
12494097062eSBarry Smith #endif
12502eff7a51SBarry Smith 
125133f85c2fSBarry Smith #if defined(PETSC_USE_LOG)
125233f85c2fSBarry Smith   ierr = PetscLogDestroy();CHKERRQ(ierr);
125333f85c2fSBarry Smith #endif
125433f85c2fSBarry Smith 
125533f85c2fSBarry Smith   /*
125633f85c2fSBarry Smith      Destroy any packages that registered a finalize
125733f85c2fSBarry Smith   */
125833f85c2fSBarry Smith   ierr = PetscRegisterFinalizeAll();CHKERRQ(ierr);
125933f85c2fSBarry Smith 
126033f85c2fSBarry Smith   /*
126110463e74SBarry Smith      Destroy all the function registration lists created
126210463e74SBarry Smith   */
126310463e74SBarry Smith   ierr = PetscFinalize_DynamicLibraries();CHKERRQ(ierr);
126410463e74SBarry Smith 
126548dd1dffSBarry Smith   /*
126648dd1dffSBarry Smith      Print PetscFunctionLists that have not been properly freed
126748dd1dffSBarry Smith 
126837e93019SBarry Smith   ierr = PetscFunctionListPrintAll();CHKERRQ(ierr);
126948dd1dffSBarry Smith   */
127037e93019SBarry Smith 
12714028d114SSatish Balay   if (petsc_history) {
1272f3dea69dSBarry Smith     ierr = PetscCloseHistoryFile(&petsc_history);CHKERRQ(ierr);
1273e5c89e4eSSatish Balay     petsc_history = 0;
1274e5c89e4eSSatish Balay   }
1275e5c89e4eSSatish Balay 
12760298fd71SBarry Smith   ierr = PetscInfoAllow(PETSC_FALSE,NULL);CHKERRQ(ierr);
1277e5c89e4eSSatish Balay 
12788bb29257SSatish Balay   {
1279e5c89e4eSSatish Balay     char fname[PETSC_MAX_PATH_LEN];
1280e5c89e4eSSatish Balay     FILE *fd;
1281ed9cf6e9SBarry Smith     int  err;
1282e5c89e4eSSatish Balay 
1283e5c89e4eSSatish Balay     fname[0] = 0;
1284a297a907SKarl Rupp 
12850298fd71SBarry Smith     ierr = PetscOptionsGetString(NULL,"-malloc_dump",fname,250,&flg1);CHKERRQ(ierr);
1286dc92acbaSJed Brown     flg2 = PETSC_FALSE;
12870298fd71SBarry Smith     ierr = PetscOptionsGetBool(NULL,"-malloc_test",&flg2,NULL);CHKERRQ(ierr);
12888bf1f09cSShri Abhyankar #if defined(PETSC_USE_DEBUG)
1289dc92acbaSJed Brown     if (PETSC_RUNNING_ON_VALGRIND) flg2 = PETSC_FALSE;
1290dc92acbaSJed Brown #else
1291dc92acbaSJed Brown     flg2 = PETSC_FALSE;         /* Skip reporting for optimized builds regardless of -malloc_test */
1292dc92acbaSJed Brown #endif
1293e5c89e4eSSatish Balay     if (flg1 && fname[0]) {
1294e5c89e4eSSatish Balay       char sname[PETSC_MAX_PATH_LEN];
1295e5c89e4eSSatish Balay 
1296e5c89e4eSSatish Balay       sprintf(sname,"%s_%d",fname,rank);
1297e32f2f54SBarry Smith       fd   = fopen(sname,"w"); if (!fd) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_FILE_OPEN,"Cannot open log file: %s",sname);
1298e5c89e4eSSatish Balay       ierr = PetscMallocDump(fd);CHKERRQ(ierr);
1299ed9cf6e9SBarry Smith       err  = fclose(fd);
1300e32f2f54SBarry Smith       if (err) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SYS,"fclose() failed on file");
1301dc92acbaSJed Brown     } else if (flg1 || flg2) {
1302e5c89e4eSSatish Balay       MPI_Comm local_comm;
1303e5c89e4eSSatish Balay 
1304e5c89e4eSSatish Balay       ierr = MPI_Comm_dup(MPI_COMM_WORLD,&local_comm);CHKERRQ(ierr);
1305e5c89e4eSSatish Balay       ierr = PetscSequentialPhaseBegin_Private(local_comm,1);CHKERRQ(ierr);
1306e5c89e4eSSatish Balay       ierr = PetscMallocDump(stdout);CHKERRQ(ierr);
1307e5c89e4eSSatish Balay       ierr = PetscSequentialPhaseEnd_Private(local_comm,1);CHKERRQ(ierr);
1308e5c89e4eSSatish Balay       ierr = MPI_Comm_free(&local_comm);CHKERRQ(ierr);
1309e5c89e4eSSatish Balay     }
1310e5c89e4eSSatish Balay   }
1311a64a8e02SBarry Smith 
13128bb29257SSatish Balay   {
1313e5c89e4eSSatish Balay     char fname[PETSC_MAX_PATH_LEN];
13140298fd71SBarry Smith     FILE *fd = NULL;
1315e5c89e4eSSatish Balay 
1316e5c89e4eSSatish Balay     fname[0] = 0;
1317a297a907SKarl Rupp 
13180298fd71SBarry Smith     ierr = PetscOptionsGetString(NULL,"-malloc_log",fname,250,&flg1);CHKERRQ(ierr);
13190298fd71SBarry Smith     ierr = PetscOptionsHasName(NULL,"-malloc_log_threshold",&flg2);CHKERRQ(ierr);
1320e5c89e4eSSatish Balay     if (flg1 && fname[0]) {
1321ed9cf6e9SBarry Smith       int err;
1322e5c89e4eSSatish Balay 
1323574034a9SJed Brown       if (!rank) {
1324574034a9SJed Brown         fd = fopen(fname,"w");
1325574034a9SJed Brown         if (!fd) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_FILE_OPEN,"Cannot open log file: %s",fname);
1326574034a9SJed Brown       }
1327e5c89e4eSSatish Balay       ierr = PetscMallocDumpLog(fd);CHKERRQ(ierr);
1328574034a9SJed Brown       if (fd) {
1329ed9cf6e9SBarry Smith         err = fclose(fd);
1330e32f2f54SBarry Smith         if (err) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SYS,"fclose() failed on file");
1331574034a9SJed Brown       }
1332574034a9SJed Brown     } else if (flg1 || flg2) {
1333e5c89e4eSSatish Balay       ierr = PetscMallocDumpLog(stdout);CHKERRQ(ierr);
1334e5c89e4eSSatish Balay     }
1335e5c89e4eSSatish Balay   }
133620e2c332SMatthew G. Knepley 
133720e2c332SMatthew G. Knepley #if defined(PETSC_HAVE_CUDA)
133820e2c332SMatthew G. Knepley   flg  = PETSC_TRUE;
133920e2c332SMatthew G. Knepley   ierr = PetscOptionsGetBool(NULL,"-cublas",&flg,NULL);CHKERRQ(ierr);
134020e2c332SMatthew G. Knepley   if (flg) {
134120e2c332SMatthew G. Knepley     PetscInt p;
134220e2c332SMatthew G. Knepley     for (p = 0; p < PetscGlobalSize; ++p) {
134320e2c332SMatthew G. Knepley       if (p == PetscGlobalRank) cublasShutdown();
134420e2c332SMatthew G. Knepley       ierr = MPI_Barrier(PETSC_COMM_WORLD);CHKERRQ(ierr);
134520e2c332SMatthew G. Knepley     }
134620e2c332SMatthew G. Knepley   }
134720e2c332SMatthew G. Knepley #endif
134820e2c332SMatthew G. Knepley 
1349e5c89e4eSSatish Balay   /* Can be destroyed only after all the options are used */
1350e5c89e4eSSatish Balay   ierr = PetscOptionsDestroy();CHKERRQ(ierr);
1351e5c89e4eSSatish Balay 
1352e5c89e4eSSatish Balay   PetscGlobalArgc = 0;
1353e5c89e4eSSatish Balay   PetscGlobalArgs = 0;
1354e5c89e4eSSatish Balay 
1355ce63c4c1SBarry Smith #if defined(PETSC_USE_REAL___FLOAT128)
1356c90a1750SBarry Smith   ierr = MPI_Type_free(&MPIU___FLOAT128);CHKERRQ(ierr);
13577c2de775SJed Brown #if defined(PETSC_HAVE_COMPLEX)
13588c764dc5SJose Roman   ierr = MPI_Type_free(&MPIU___COMPLEX128);CHKERRQ(ierr);
13598c764dc5SJose Roman #endif
1360d9822059SBarry Smith   ierr = MPI_Op_free(&MPIU_MAX);CHKERRQ(ierr);
1361d9822059SBarry Smith   ierr = MPI_Op_free(&MPIU_MIN);CHKERRQ(ierr);
1362c90a1750SBarry Smith #endif
1363c90a1750SBarry Smith 
13647c2de775SJed Brown #if defined(PETSC_HAVE_COMPLEX)
13652c876bd9SBarry Smith #if !defined(PETSC_HAVE_MPI_C_DOUBLE_COMPLEX)
1366500d8756SSatish Balay   ierr = MPI_Type_free(&MPIU_C_DOUBLE_COMPLEX);CHKERRQ(ierr);
1367500d8756SSatish Balay   ierr = MPI_Type_free(&MPIU_C_COMPLEX);CHKERRQ(ierr);
13682c876bd9SBarry Smith #endif
1369e5c89e4eSSatish Balay #endif
1370cca4cb22SSatish Balay 
13717c2de775SJed Brown #if (defined(PETSC_HAVE_COMPLEX) && !defined(PETSC_HAVE_MPI_C_DOUBLE_COMPLEX)) || defined(PETSC_USE_REAL___FLOAT128)
1372cca4cb22SSatish Balay   ierr = MPI_Op_free(&MPIU_SUM);CHKERRQ(ierr);
1373cca4cb22SSatish Balay #endif
1374cca4cb22SSatish Balay 
1375e5c89e4eSSatish Balay   ierr = MPI_Type_free(&MPIU_2SCALAR);CHKERRQ(ierr);
137644041f26SJed Brown #if defined(PETSC_USE_64BIT_INDICES) || !defined(MPI_2INT)
1377e5c89e4eSSatish Balay   ierr = MPI_Type_free(&MPIU_2INT);CHKERRQ(ierr);
137844041f26SJed Brown #endif
1379e5c89e4eSSatish Balay   ierr = MPI_Op_free(&PetscMaxSum_Op);CHKERRQ(ierr);
1380e5c89e4eSSatish Balay   ierr = MPI_Op_free(&PetscADMax_Op);CHKERRQ(ierr);
1381e5c89e4eSSatish Balay   ierr = MPI_Op_free(&PetscADMin_Op);CHKERRQ(ierr);
1382e5c89e4eSSatish Balay 
1383dbc8283eSBarry Smith   /*
1384efb80d3cSBarry Smith      Destroy any known inner MPI_Comm's and attributes pointing to them
1385efb80d3cSBarry Smith      Note this will not destroy any new communicators the user has created.
1386efb80d3cSBarry Smith 
1387efb80d3cSBarry Smith      If all PETSc objects were not destroyed those left over objects will have hanging references to
1388efb80d3cSBarry Smith      the MPI_Comms that were freed; but that is ok because those PETSc objects will never be used again
1389dbc8283eSBarry Smith  */
1390b770b1f6SSatish Balay   {
1391dbc8283eSBarry Smith     PetscCommCounter *counter;
1392dbc8283eSBarry Smith     PetscMPIInt      flg;
1393dbc8283eSBarry Smith     MPI_Comm         icomm;
1394265f3f35SJed Brown     union {MPI_Comm comm; void *ptr;} ucomm;
1395265f3f35SJed Brown     ierr = MPI_Attr_get(PETSC_COMM_SELF,Petsc_InnerComm_keyval,&ucomm,&flg);CHKERRQ(ierr);
1396dbc8283eSBarry Smith     if (flg) {
1397265f3f35SJed Brown       icomm = ucomm.comm;
1398dbc8283eSBarry Smith       ierr = MPI_Attr_get(icomm,Petsc_Counter_keyval,&counter,&flg);CHKERRQ(ierr);
1399dbc8283eSBarry Smith       if (!flg) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_CORRUPT,"Inner MPI_Comm does not have expected tag/name counter, problem with corrupted memory");
1400dbc8283eSBarry Smith 
1401dbc8283eSBarry Smith       ierr = MPI_Attr_delete(PETSC_COMM_SELF,Petsc_InnerComm_keyval);CHKERRQ(ierr);
1402efb80d3cSBarry Smith       ierr = MPI_Attr_delete(icomm,Petsc_Counter_keyval);CHKERRQ(ierr);
1403efb80d3cSBarry Smith       ierr = MPI_Comm_free(&icomm);CHKERRQ(ierr);
1404dbc8283eSBarry Smith     }
1405265f3f35SJed Brown     ierr = MPI_Attr_get(PETSC_COMM_WORLD,Petsc_InnerComm_keyval,&ucomm,&flg);CHKERRQ(ierr);
1406dbc8283eSBarry Smith     if (flg) {
1407265f3f35SJed Brown       icomm = ucomm.comm;
1408dbc8283eSBarry Smith       ierr = MPI_Attr_get(icomm,Petsc_Counter_keyval,&counter,&flg);CHKERRQ(ierr);
1409dbc8283eSBarry 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");
1410dbc8283eSBarry Smith 
1411dbc8283eSBarry Smith       ierr = MPI_Attr_delete(PETSC_COMM_WORLD,Petsc_InnerComm_keyval);CHKERRQ(ierr);
1412efb80d3cSBarry Smith       ierr = MPI_Attr_delete(icomm,Petsc_Counter_keyval);CHKERRQ(ierr);
1413efb80d3cSBarry Smith       ierr = MPI_Comm_free(&icomm);CHKERRQ(ierr);
1414dbc8283eSBarry Smith     }
1415b770b1f6SSatish Balay   }
1416dbc8283eSBarry Smith 
1417480cf27aSJed Brown   ierr = MPI_Keyval_free(&Petsc_Counter_keyval);CHKERRQ(ierr);
1418480cf27aSJed Brown   ierr = MPI_Keyval_free(&Petsc_InnerComm_keyval);CHKERRQ(ierr);
1419480cf27aSJed Brown   ierr = MPI_Keyval_free(&Petsc_OuterComm_keyval);CHKERRQ(ierr);
1420480cf27aSJed Brown 
1421e5c89e4eSSatish Balay   if (PetscBeganMPI) {
142299608316SBarry Smith #if defined(PETSC_HAVE_MPI_FINALIZED)
142399b1327fSBarry Smith     PetscMPIInt flag;
142499b1327fSBarry Smith     ierr = MPI_Finalized(&flag);CHKERRQ(ierr);
1425e32f2f54SBarry Smith     if (flag) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_LIB,"MPI_Finalize() has already been called, even though MPI_Init() was called by PetscInitialize()");
142699608316SBarry Smith #endif
1427e5c89e4eSSatish Balay     ierr = MPI_Finalize();CHKERRQ(ierr);
1428e5c89e4eSSatish Balay   }
1429e5c89e4eSSatish Balay /*
1430e5c89e4eSSatish Balay 
1431e5c89e4eSSatish Balay      Note: In certain cases PETSC_COMM_WORLD is never MPI_Comm_free()ed because
1432e5c89e4eSSatish Balay    the communicator has some outstanding requests on it. Specifically if the
1433e5c89e4eSSatish Balay    flag PETSC_HAVE_BROKEN_REQUEST_FREE is set (for IBM MPI implementation). See
1434e5c89e4eSSatish Balay    src/vec/utils/vpscat.c. Due to this the memory allocated in PetscCommDuplicate()
1435e5c89e4eSSatish Balay    is never freed as it should be. Thus one may obtain messages of the form
14360e5e90baSSatish Balay    [ 1] 8 bytes PetscCommDuplicate() line 645 in src/sys/mpiu.c indicating the
1437e5c89e4eSSatish Balay    memory was not freed.
1438e5c89e4eSSatish Balay 
1439e5c89e4eSSatish Balay */
14401d1a0024SBarry Smith   ierr = PetscMallocClear();CHKERRQ(ierr);
1441a297a907SKarl Rupp 
1442e5c89e4eSSatish Balay   PetscInitializeCalled = PETSC_FALSE;
1443e5c89e4eSSatish Balay   PetscFinalizeCalled   = PETSC_TRUE;
1444e5c89e4eSSatish Balay   PetscFunctionReturn(ierr);
1445e5c89e4eSSatish Balay }
1446e5c89e4eSSatish Balay 
144743db4dbbSBarry Smith #if defined(PETSC_MISSING_LAPACK_lsame_)
14488cc058d9SJed Brown PETSC_EXTERN int lsame_(char *a,char *b)
144943db4dbbSBarry Smith {
145043db4dbbSBarry Smith   if (*a == *b) return 1;
145143db4dbbSBarry Smith   if (*a + 32 == *b) return 1;
145243db4dbbSBarry Smith   if (*a - 32 == *b) return 1;
145343db4dbbSBarry Smith   return 0;
145443db4dbbSBarry Smith }
1455a70650f6SBarry Smith #endif
145643db4dbbSBarry Smith 
145743db4dbbSBarry Smith #if defined(PETSC_MISSING_LAPACK_lsame)
14588cc058d9SJed Brown PETSC_EXTERN int lsame(char *a,char *b)
145943db4dbbSBarry Smith {
146043db4dbbSBarry Smith   if (*a == *b) return 1;
146143db4dbbSBarry Smith   if (*a + 32 == *b) return 1;
146243db4dbbSBarry Smith   if (*a - 32 == *b) return 1;
146343db4dbbSBarry Smith   return 0;
146443db4dbbSBarry Smith }
146543db4dbbSBarry Smith #endif
1466