xref: /petsc/src/sys/objects/pinit.c (revision 76f543a4c4f87cb621fd5325ef6ac5a2003d4fa9)
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 
208*76f543a4SJed Brown     The reason sizes[2*i] contains lengths sizes[2*i+1] contains flag of 1 if length is nonzero
209*76f543a4SJed Brown is so that the PetscMaxSum_Op() can set TWO values, if we passed in only sizes[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   PetscErrorCode ierr;
217e5c89e4eSSatish Balay 
218e5c89e4eSSatish Balay   PetscFunctionBegin;
219d6e4c47cSJed Brown #if defined(PETSC_HAVE_MPI_REDUCE_SCATTER_BLOCK)
220d6e4c47cSJed Brown   {
221d6e4c47cSJed Brown     struct {PetscInt max,sum;} work;
222*76f543a4SJed Brown     ierr = MPI_Reduce_scatter_block((void*)sizes,&work,1,MPIU_2INT,PetscMaxSum_Op,comm);CHKERRQ(ierr);
223d6e4c47cSJed Brown     *max = work.max;
224d6e4c47cSJed Brown     *sum = work.sum;
225d6e4c47cSJed Brown   }
226d6e4c47cSJed Brown #else
227d6e4c47cSJed Brown   {
228d6e4c47cSJed Brown     PetscMPIInt    size,rank;
229d6e4c47cSJed Brown     struct {PetscInt max,sum;} *work;
230e5c89e4eSSatish Balay     ierr = MPI_Comm_size(comm,&size);CHKERRQ(ierr);
231e5c89e4eSSatish Balay     ierr = MPI_Comm_rank(comm,&rank);CHKERRQ(ierr);
232785e854fSJed Brown     ierr = PetscMalloc1(size,&work);CHKERRQ(ierr);
23376ec1555SBarry Smith     ierr = MPI_Allreduce((void*)sizes,work,size,MPIU_2INT,PetscMaxSum_Op,comm);CHKERRQ(ierr);
2346ac3741eSJed Brown     *max = work[rank].max;
2356ac3741eSJed Brown     *sum = work[rank].sum;
236e5c89e4eSSatish Balay     ierr = PetscFree(work);CHKERRQ(ierr);
237d6e4c47cSJed Brown   }
238d6e4c47cSJed Brown #endif
239e5c89e4eSSatish Balay   PetscFunctionReturn(0);
240e5c89e4eSSatish Balay }
241e5c89e4eSSatish Balay 
242e5c89e4eSSatish Balay /* ----------------------------------------------------------------------------*/
2437087cfbeSBarry Smith MPI_Op  PetscADMax_Op = 0;
244e5c89e4eSSatish Balay 
245e5c89e4eSSatish Balay #undef __FUNCT__
246e5c89e4eSSatish Balay #define __FUNCT__ "PetscADMax_Local"
2478cc058d9SJed Brown PETSC_EXTERN void MPIAPI PetscADMax_Local(void *in,void *out,PetscMPIInt *cnt,MPI_Datatype *datatype)
248e5c89e4eSSatish Balay {
249e5c89e4eSSatish Balay   PetscScalar *xin = (PetscScalar*)in,*xout = (PetscScalar*)out;
250e5c89e4eSSatish Balay   PetscInt    i,count = *cnt;
251e5c89e4eSSatish Balay 
252e5c89e4eSSatish Balay   PetscFunctionBegin;
253e5c89e4eSSatish Balay   if (*datatype != MPIU_2SCALAR) {
254e5c89e4eSSatish Balay     (*PetscErrorPrintf)("Can only handle MPIU_2SCALAR data (i.e. double or complex) types");
255e5c89e4eSSatish Balay     MPI_Abort(MPI_COMM_WORLD,1);
256e5c89e4eSSatish Balay   }
257e5c89e4eSSatish Balay 
258e5c89e4eSSatish Balay   for (i=0; i<count; i++) {
259e5c89e4eSSatish Balay     if (PetscRealPart(xout[2*i]) < PetscRealPart(xin[2*i])) {
260e5c89e4eSSatish Balay       xout[2*i]   = xin[2*i];
261e5c89e4eSSatish Balay       xout[2*i+1] = xin[2*i+1];
262e5c89e4eSSatish Balay     }
263e5c89e4eSSatish Balay   }
264812af9f3SBarry Smith   PetscFunctionReturnVoid();
265e5c89e4eSSatish Balay }
266e5c89e4eSSatish Balay 
2677087cfbeSBarry Smith MPI_Op PetscADMin_Op = 0;
268e5c89e4eSSatish Balay 
269e5c89e4eSSatish Balay #undef __FUNCT__
270e5c89e4eSSatish Balay #define __FUNCT__ "PetscADMin_Local"
2718cc058d9SJed Brown PETSC_EXTERN void MPIAPI PetscADMin_Local(void *in,void *out,PetscMPIInt *cnt,MPI_Datatype *datatype)
272e5c89e4eSSatish Balay {
273e5c89e4eSSatish Balay   PetscScalar *xin = (PetscScalar*)in,*xout = (PetscScalar*)out;
274e5c89e4eSSatish Balay   PetscInt    i,count = *cnt;
275e5c89e4eSSatish Balay 
276e5c89e4eSSatish Balay   PetscFunctionBegin;
277e5c89e4eSSatish Balay   if (*datatype != MPIU_2SCALAR) {
278e5c89e4eSSatish Balay     (*PetscErrorPrintf)("Can only handle MPIU_2SCALAR data (i.e. double or complex) types");
279e5c89e4eSSatish Balay     MPI_Abort(MPI_COMM_WORLD,1);
280e5c89e4eSSatish Balay   }
281e5c89e4eSSatish Balay 
282e5c89e4eSSatish Balay   for (i=0; i<count; i++) {
283e5c89e4eSSatish Balay     if (PetscRealPart(xout[2*i]) > PetscRealPart(xin[2*i])) {
284e5c89e4eSSatish Balay       xout[2*i]   = xin[2*i];
285e5c89e4eSSatish Balay       xout[2*i+1] = xin[2*i+1];
286e5c89e4eSSatish Balay     }
287e5c89e4eSSatish Balay   }
288812af9f3SBarry Smith   PetscFunctionReturnVoid();
289e5c89e4eSSatish Balay }
290e5c89e4eSSatish Balay /* ---------------------------------------------------------------------------------------*/
291e5c89e4eSSatish Balay 
2927c2de775SJed Brown #if (defined(PETSC_HAVE_COMPLEX) && !defined(PETSC_HAVE_MPI_C_DOUBLE_COMPLEX)) || defined(PETSC_USE_REAL___FLOAT128)
29306a205a8SBarry Smith MPI_Op MPIU_SUM = 0;
294e5c89e4eSSatish Balay 
295e5c89e4eSSatish Balay #undef __FUNCT__
296e5c89e4eSSatish Balay #define __FUNCT__ "PetscSum_Local"
2978cc058d9SJed Brown PETSC_EXTERN void PetscSum_Local(void *in,void *out,PetscMPIInt *cnt,MPI_Datatype *datatype)
298e5c89e4eSSatish Balay {
299e5c89e4eSSatish Balay   PetscInt i,count = *cnt;
300e5c89e4eSSatish Balay 
301e5c89e4eSSatish Balay   PetscFunctionBegin;
3027c2de775SJed Brown   if (*datatype == MPIU_REAL) {
303e2e03761SBarry Smith     PetscReal *xin = (PetscReal*)in,*xout = (PetscReal*)out;
304a297a907SKarl Rupp     for (i=0; i<count; i++) xout[i] += xin[i];
3057c2de775SJed Brown   }
3067c2de775SJed Brown #if defined(PETSC_HAVE_COMPLEX)
3077c2de775SJed Brown   else if (*datatype == MPIU_COMPLEX) {
3087c2de775SJed Brown     PetscComplex *xin = (PetscComplex*)in,*xout = (PetscComplex*)out;
309a297a907SKarl Rupp     for (i=0; i<count; i++) xout[i] += xin[i];
3107c2de775SJed Brown   }
3117c2de775SJed Brown #endif
3127c2de775SJed Brown   else {
3137c2de775SJed Brown     (*PetscErrorPrintf)("Can only handle MPIU_REAL or MPIU_COMPLEX data types");
314e2e03761SBarry Smith     MPI_Abort(MPI_COMM_WORLD,1);
315e2e03761SBarry Smith   }
316812af9f3SBarry Smith   PetscFunctionReturnVoid();
317e5c89e4eSSatish Balay }
318e5c89e4eSSatish Balay #endif
319e5c89e4eSSatish Balay 
320ce63c4c1SBarry Smith #if defined(PETSC_USE_REAL___FLOAT128)
321d9822059SBarry Smith MPI_Op MPIU_MAX = 0;
322d9822059SBarry Smith MPI_Op MPIU_MIN = 0;
323d9822059SBarry Smith 
324d9822059SBarry Smith #undef __FUNCT__
325d9822059SBarry Smith #define __FUNCT__ "PetscMax_Local"
3268cc058d9SJed Brown PETSC_EXTERN void PetscMax_Local(void *in,void *out,PetscMPIInt *cnt,MPI_Datatype *datatype)
327d9822059SBarry Smith {
328d9822059SBarry Smith   PetscInt i,count = *cnt;
329d9822059SBarry Smith 
330d9822059SBarry Smith   PetscFunctionBegin;
3317c2de775SJed Brown   if (*datatype == MPIU_REAL) {
3328c764dc5SJose Roman     PetscReal *xin = (PetscReal*)in,*xout = (PetscReal*)out;
333a297a907SKarl Rupp     for (i=0; i<count; i++) xout[i] = PetscMax(xout[i],xin[i]);
3347c2de775SJed Brown   }
3357c2de775SJed Brown #if defined(PETSC_HAVE_COMPLEX)
3367c2de775SJed Brown   else if (*datatype == MPIU_COMPLEX) {
3377c2de775SJed Brown     PetscComplex *xin = (PetscComplex*)in,*xout = (PetscComplex*)out;
3387c2de775SJed Brown     for (i=0; i<count; i++) {
3397c2de775SJed Brown       xout[i] = PetscRealPartComplex(xout[i])<PetscRealPartComplex(xin[i]) ? xin[i] : xout[i];
3407c2de775SJed Brown     }
3417c2de775SJed Brown   }
3427c2de775SJed Brown #endif
3437c2de775SJed Brown   else {
3447c2de775SJed Brown     (*PetscErrorPrintf)("Can only handle MPIU_REAL or MPIU_COMPLEX data types");
3458c764dc5SJose Roman     MPI_Abort(MPI_COMM_WORLD,1);
3468c764dc5SJose Roman   }
347d9822059SBarry Smith   PetscFunctionReturnVoid();
348d9822059SBarry Smith }
349d9822059SBarry Smith 
350d9822059SBarry Smith #undef __FUNCT__
351d9822059SBarry Smith #define __FUNCT__ "PetscMin_Local"
3528cc058d9SJed Brown PETSC_EXTERN void PetscMin_Local(void *in,void *out,PetscMPIInt *cnt,MPI_Datatype *datatype)
353d9822059SBarry Smith {
354d9822059SBarry Smith   PetscInt    i,count = *cnt;
355d9822059SBarry Smith 
356d9822059SBarry Smith   PetscFunctionBegin;
3577c2de775SJed Brown   if (*datatype == MPIU_REAL) {
3588c764dc5SJose Roman     PetscReal *xin = (PetscReal*)in,*xout = (PetscReal*)out;
359a297a907SKarl Rupp     for (i=0; i<count; i++) xout[i] = PetscMin(xout[i],xin[i]);
3607c2de775SJed Brown   }
3617c2de775SJed Brown #if defined(PETSC_HAVE_COMPLEX)
3627c2de775SJed Brown   else if (*datatype == MPIU_COMPLEX) {
3637c2de775SJed Brown     PetscComplex *xin = (PetscComplex*)in,*xout = (PetscComplex*)out;
3647c2de775SJed Brown     for (i=0; i<count; i++) {
3657c2de775SJed Brown       xout[i] = PetscRealPartComplex(xout[i])>PetscRealPartComplex(xin[i]) ? xin[i] : xout[i];
3667c2de775SJed Brown     }
3677c2de775SJed Brown   }
3687c2de775SJed Brown #endif
3697c2de775SJed Brown   else {
3708c764dc5SJose Roman     (*PetscErrorPrintf)("Can only handle MPIU_REAL or MPIU_SCALAR data (i.e. double or complex) types");
3718c764dc5SJose Roman     MPI_Abort(MPI_COMM_WORLD,1);
3728c764dc5SJose Roman   }
373d9822059SBarry Smith   PetscFunctionReturnVoid();
374d9822059SBarry Smith }
375d9822059SBarry Smith #endif
376d9822059SBarry Smith 
377480cf27aSJed Brown #undef __FUNCT__
378480cf27aSJed Brown #define __FUNCT__ "Petsc_DelCounter"
379480cf27aSJed Brown /*
380480cf27aSJed Brown    Private routine to delete internal tag/name counter storage when a communicator is freed.
381480cf27aSJed Brown 
382ff0e51ddSBarry 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.
383480cf27aSJed Brown 
384480cf27aSJed Brown    Note: this is declared extern "C" because it is passed to MPI_Keyval_create()
385480cf27aSJed Brown 
386480cf27aSJed Brown */
3878cc058d9SJed Brown PETSC_EXTERN PetscMPIInt MPIAPI Petsc_DelCounter(MPI_Comm comm,PetscMPIInt keyval,void *count_val,void *extra_state)
388480cf27aSJed Brown {
389480cf27aSJed Brown   PetscErrorCode ierr;
390480cf27aSJed Brown 
391480cf27aSJed Brown   PetscFunctionBegin;
392480cf27aSJed Brown   ierr = PetscInfo1(0,"Deleting counter data in an MPI_Comm %ld\n",(long)comm);if (ierr) PetscFunctionReturn((PetscMPIInt)ierr);
393480cf27aSJed Brown   ierr = PetscFree(count_val);if (ierr) PetscFunctionReturn((PetscMPIInt)ierr);
394480cf27aSJed Brown   PetscFunctionReturn(MPI_SUCCESS);
395480cf27aSJed Brown }
396480cf27aSJed Brown 
397480cf27aSJed Brown #undef __FUNCT__
398da3039f7SJed Brown #define __FUNCT__ "Petsc_DelComm_Outer"
399480cf27aSJed Brown /*
400da3039f7SJed Brown   This is invoked on the outer comm as a result of either PetscCommDestroy() (via MPI_Attr_delete) or when the user
401da3039f7SJed Brown   calls MPI_Comm_free().
402da3039f7SJed Brown 
403da3039f7SJed Brown   This is the only entry point for breaking the links between inner and outer comms.
404480cf27aSJed Brown 
405ff0e51ddSBarry Smith   This is called by MPI, not by users. This is called when MPI_Comm_free() is called on the communicator.
406480cf27aSJed Brown 
407480cf27aSJed Brown   Note: this is declared extern "C" because it is passed to MPI_Keyval_create()
408480cf27aSJed Brown 
409480cf27aSJed Brown */
410da3039f7SJed Brown PETSC_EXTERN PetscMPIInt MPIAPI Petsc_DelComm_Outer(MPI_Comm comm,PetscMPIInt keyval,void *attr_val,void *extra_state)
411480cf27aSJed Brown {
412480cf27aSJed Brown   PetscErrorCode ierr;
413b89831e5SBarry Smith   PetscMPIInt    flg;
414265f3f35SJed Brown   union {MPI_Comm comm; void *ptr;} icomm,ocomm;
415480cf27aSJed Brown 
416480cf27aSJed Brown   PetscFunctionBegin;
417da3039f7SJed Brown   if (keyval != Petsc_InnerComm_keyval) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_CORRUPT,"Unexpected keyval");
418ec4fadc2SJed Brown   icomm.ptr = attr_val;
419da3039f7SJed Brown 
420265f3f35SJed Brown   ierr = MPI_Attr_get(icomm.comm,Petsc_OuterComm_keyval,&ocomm,&flg);CHKERRQ(ierr);
421b3ef52cdSBarry Smith   if (!flg) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_CORRUPT,"Inner MPI_Comm does not have expected reference to outer comm");
422da3039f7SJed Brown   if (ocomm.comm != comm) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_CORRUPT,"Inner MPI_Comm has reference to non-matching outer comm");
423da3039f7SJed Brown   ierr = MPI_Attr_delete(icomm.comm,Petsc_OuterComm_keyval);CHKERRQ(ierr); /* Calls Petsc_DelComm_Inner */
424da3039f7SJed 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);
425da3039f7SJed Brown   PetscFunctionReturn(MPI_SUCCESS);
426b89831e5SBarry Smith }
427da3039f7SJed Brown 
428da3039f7SJed Brown #undef __FUNCT__
429da3039f7SJed Brown #define __FUNCT__ "Petsc_DelComm_Inner"
430da3039f7SJed Brown /*
431da3039f7SJed Brown  * This is invoked on the inner comm when Petsc_DelComm_Outer calls MPI_Attr_delete.  It should not be reached any other way.
432da3039f7SJed Brown  */
433da3039f7SJed Brown PETSC_EXTERN PetscMPIInt MPIAPI Petsc_DelComm_Inner(MPI_Comm comm,PetscMPIInt keyval,void *attr_val,void *extra_state)
434da3039f7SJed Brown {
435da3039f7SJed Brown   PetscErrorCode ierr;
436da3039f7SJed Brown 
437da3039f7SJed Brown   PetscFunctionBegin;
438da3039f7SJed Brown   ierr = PetscInfo1(0,"Removing reference to PETSc communicator embedded in a user MPI_Comm %ld\n",(long)comm);if (ierr) PetscFunctionReturn((PetscMPIInt)ierr);
439480cf27aSJed Brown   PetscFunctionReturn(MPI_SUCCESS);
440480cf27aSJed Brown }
441480cf27aSJed Brown 
442951e3c8eSBarry Smith #if defined(PETSC_USE_PETSC_MPI_EXTERNAL32)
443e39fd77fSBarry Smith #if !defined(PETSC_WORDS_BIGENDIAN)
4448cc058d9SJed Brown PETSC_EXTERN PetscMPIInt PetscDataRep_extent_fn(MPI_Datatype,MPI_Aint*,void*);
4458cc058d9SJed Brown PETSC_EXTERN PetscMPIInt PetscDataRep_read_conv_fn(void*, MPI_Datatype,PetscMPIInt,void*,MPI_Offset,void*);
4468cc058d9SJed Brown PETSC_EXTERN PetscMPIInt PetscDataRep_write_conv_fn(void*, MPI_Datatype,PetscMPIInt,void*,MPI_Offset,void*);
447e39fd77fSBarry Smith #endif
448951e3c8eSBarry Smith #endif
449e39fd77fSBarry Smith 
4506ae9a8a6SBarry Smith int  PetscGlobalArgc   = 0;
4516ae9a8a6SBarry Smith char **PetscGlobalArgs = 0;
452dff31646SBarry Smith PetscSegBuffer PetscCitationsList;
453e5c89e4eSSatish Balay 
454e5c89e4eSSatish Balay #undef __FUNCT__
455051e4cf2SJed Brown #define __FUNCT__ "PetscCitationsInitialize"
456051e4cf2SJed Brown PetscErrorCode PetscCitationsInitialize()
457051e4cf2SJed Brown {
458051e4cf2SJed Brown   PetscErrorCode ierr;
459051e4cf2SJed Brown 
460051e4cf2SJed Brown   PetscFunctionBegin;
461051e4cf2SJed Brown   ierr = PetscSegBufferCreate(1,10000,&PetscCitationsList);CHKERRQ(ierr);
462fa9c09a1SSatish Balay   ierr = PetscCitationsRegister("@TechReport{petsc-user-ref,\n  Author = {Satish Balay and Shrirang Abhyankar and Mark F. Adams and Jed Brown and Peter Brune\n            and Kris Buschelman and Victor Eijkhout and William D. Gropp\n            and Dinesh Kaushik and Matthew G. Knepley\n            and Lois Curfman McInnes and Karl Rupp and Barry F. Smith\n            and Hong Zhang},\n  Title = {{PETS}c Users Manual},\n  Number = {ANL-95/11 - Revision 3.5},\n  Institution = {Argonne National Laboratory},\n  Year = {2014}\n}\n",NULL);CHKERRQ(ierr);
463051e4cf2SJed 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);
464051e4cf2SJed Brown   PetscFunctionReturn(0);
465051e4cf2SJed Brown }
466e5c89e4eSSatish Balay 
467e5c89e4eSSatish Balay #undef __FUNCT__
468e5c89e4eSSatish Balay #define __FUNCT__ "PetscGetArgs"
469e5c89e4eSSatish Balay /*@C
470e5c89e4eSSatish Balay    PetscGetArgs - Allows you to access the raw command line arguments anywhere
471e5c89e4eSSatish Balay      after PetscInitialize() is called but before PetscFinalize().
472e5c89e4eSSatish Balay 
473e5c89e4eSSatish Balay    Not Collective
474e5c89e4eSSatish Balay 
475e5c89e4eSSatish Balay    Output Parameters:
476e5c89e4eSSatish Balay +  argc - count of number of command line arguments
477e5c89e4eSSatish Balay -  args - the command line arguments
478e5c89e4eSSatish Balay 
479e5c89e4eSSatish Balay    Level: intermediate
480e5c89e4eSSatish Balay 
481e5c89e4eSSatish Balay    Notes:
482e5c89e4eSSatish Balay       This is usually used to pass the command line arguments into other libraries
483e5c89e4eSSatish Balay    that are called internally deep in PETSc or the application.
484e5c89e4eSSatish Balay 
485f177e3b1SBarry Smith       The first argument contains the program name as is normal for C arguments.
486f177e3b1SBarry Smith 
487e5c89e4eSSatish Balay    Concepts: command line arguments
488e5c89e4eSSatish Balay 
489793721a6SBarry Smith .seealso: PetscFinalize(), PetscInitializeFortran(), PetscGetArguments()
490e5c89e4eSSatish Balay 
491e5c89e4eSSatish Balay @*/
4927087cfbeSBarry Smith PetscErrorCode  PetscGetArgs(int *argc,char ***args)
493e5c89e4eSSatish Balay {
494e5c89e4eSSatish Balay   PetscFunctionBegin;
49517186662SBarry Smith   if (!PetscInitializeCalled && PetscFinalizeCalled) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ORDER,"You must call after PetscInitialize() but before PetscFinalize()");
496e5c89e4eSSatish Balay   *argc = PetscGlobalArgc;
497e5c89e4eSSatish Balay   *args = PetscGlobalArgs;
498e5c89e4eSSatish Balay   PetscFunctionReturn(0);
499e5c89e4eSSatish Balay }
500e5c89e4eSSatish Balay 
501e5c89e4eSSatish Balay #undef __FUNCT__
502793721a6SBarry Smith #define __FUNCT__ "PetscGetArguments"
503793721a6SBarry Smith /*@C
504793721a6SBarry Smith    PetscGetArguments - Allows you to access the  command line arguments anywhere
505793721a6SBarry Smith      after PetscInitialize() is called but before PetscFinalize().
506793721a6SBarry Smith 
507793721a6SBarry Smith    Not Collective
508793721a6SBarry Smith 
509793721a6SBarry Smith    Output Parameters:
510793721a6SBarry Smith .  args - the command line arguments
511793721a6SBarry Smith 
512793721a6SBarry Smith    Level: intermediate
513793721a6SBarry Smith 
514793721a6SBarry Smith    Notes:
515793721a6SBarry Smith       This does NOT start with the program name and IS null terminated (final arg is void)
516793721a6SBarry Smith 
517793721a6SBarry Smith    Concepts: command line arguments
518793721a6SBarry Smith 
519793721a6SBarry Smith .seealso: PetscFinalize(), PetscInitializeFortran(), PetscGetArgs(), PetscFreeArguments()
520793721a6SBarry Smith 
521793721a6SBarry Smith @*/
5227087cfbeSBarry Smith PetscErrorCode  PetscGetArguments(char ***args)
523793721a6SBarry Smith {
524793721a6SBarry Smith   PetscInt       i,argc = PetscGlobalArgc;
525793721a6SBarry Smith   PetscErrorCode ierr;
526793721a6SBarry Smith 
527793721a6SBarry Smith   PetscFunctionBegin;
52817186662SBarry Smith   if (!PetscInitializeCalled && PetscFinalizeCalled) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ORDER,"You must call after PetscInitialize() but before PetscFinalize()");
529717030eeSLisandro Dalcin   if (!argc) {*args = 0; PetscFunctionReturn(0);}
530785e854fSJed Brown   ierr = PetscMalloc1(argc,args);CHKERRQ(ierr);
531793721a6SBarry Smith   for (i=0; i<argc-1; i++) {
532793721a6SBarry Smith     ierr = PetscStrallocpy(PetscGlobalArgs[i+1],&(*args)[i]);CHKERRQ(ierr);
533793721a6SBarry Smith   }
534793721a6SBarry Smith   (*args)[argc-1] = 0;
535793721a6SBarry Smith   PetscFunctionReturn(0);
536793721a6SBarry Smith }
537793721a6SBarry Smith 
538793721a6SBarry Smith #undef __FUNCT__
539793721a6SBarry Smith #define __FUNCT__ "PetscFreeArguments"
540793721a6SBarry Smith /*@C
541793721a6SBarry Smith    PetscFreeArguments - Frees the memory obtained with PetscGetArguments()
542793721a6SBarry Smith 
543793721a6SBarry Smith    Not Collective
544793721a6SBarry Smith 
545793721a6SBarry Smith    Output Parameters:
546793721a6SBarry Smith .  args - the command line arguments
547793721a6SBarry Smith 
548793721a6SBarry Smith    Level: intermediate
549793721a6SBarry Smith 
550793721a6SBarry Smith    Concepts: command line arguments
551793721a6SBarry Smith 
552793721a6SBarry Smith .seealso: PetscFinalize(), PetscInitializeFortran(), PetscGetArgs(), PetscGetArguments()
553793721a6SBarry Smith 
554793721a6SBarry Smith @*/
5557087cfbeSBarry Smith PetscErrorCode  PetscFreeArguments(char **args)
556793721a6SBarry Smith {
557793721a6SBarry Smith   PetscInt       i = 0;
558793721a6SBarry Smith   PetscErrorCode ierr;
559793721a6SBarry Smith 
560793721a6SBarry Smith   PetscFunctionBegin;
561a297a907SKarl Rupp   if (!args) PetscFunctionReturn(0);
562793721a6SBarry Smith   while (args[i]) {
563793721a6SBarry Smith     ierr = PetscFree(args[i]);CHKERRQ(ierr);
564793721a6SBarry Smith     i++;
565793721a6SBarry Smith   }
566793721a6SBarry Smith   ierr = PetscFree(args);CHKERRQ(ierr);
567793721a6SBarry Smith   PetscFunctionReturn(0);
568793721a6SBarry Smith }
569793721a6SBarry Smith 
57011525c0dSBarry Smith #if defined(PETSC_HAVE_SAWS)
57130befbd2SBarry Smith #include <petscconfiginfo.h>
57230befbd2SBarry Smith 
57311525c0dSBarry Smith #undef __FUNCT__
57411525c0dSBarry Smith #define __FUNCT__ "PetscInitializeSAWs"
57511525c0dSBarry Smith PetscErrorCode  PetscInitializeSAWs(const char help[])
57611525c0dSBarry Smith {
57711525c0dSBarry Smith   if (!PetscGlobalRank) {
57830befbd2SBarry Smith     char           cert[PETSC_MAX_PATH_LEN],root[PETSC_MAX_PATH_LEN],*intro,programname[64],*appline,*options,version[64];
57911525c0dSBarry Smith     int            port;
58011525c0dSBarry Smith     PetscBool      flg,rootlocal = PETSC_FALSE,flg2;
58111525c0dSBarry Smith     size_t         applinelen,introlen;
58211525c0dSBarry Smith     PetscErrorCode ierr;
58311525c0dSBarry Smith 
58411525c0dSBarry Smith     ierr = PetscOptionsHasName(NULL,"-saws_log",&flg);CHKERRQ(ierr);
58511525c0dSBarry Smith     if (flg) {
58611525c0dSBarry Smith       char  sawslog[PETSC_MAX_PATH_LEN];
58711525c0dSBarry Smith 
58811525c0dSBarry Smith       ierr = PetscOptionsGetString(NULL,"-saws_log",sawslog,PETSC_MAX_PATH_LEN,NULL);CHKERRQ(ierr);
58911525c0dSBarry Smith       if (sawslog[0]) {
59011525c0dSBarry Smith         PetscStackCallSAWs(SAWs_Set_Use_Logfile,(sawslog));
59111525c0dSBarry Smith       } else {
59211525c0dSBarry Smith         PetscStackCallSAWs(SAWs_Set_Use_Logfile,(NULL));
59311525c0dSBarry Smith       }
59411525c0dSBarry Smith     }
59511525c0dSBarry Smith     ierr = PetscOptionsGetString(NULL,"-saws_https",cert,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr);
59611525c0dSBarry Smith     if (flg) {
59711525c0dSBarry Smith       PetscStackCallSAWs(SAWs_Set_Use_HTTPS,(cert));
59811525c0dSBarry Smith     }
59911525c0dSBarry Smith     ierr = PetscOptionsGetInt(NULL,"-saws_port",&port,&flg);CHKERRQ(ierr);
60011525c0dSBarry Smith     if (flg) {
60111525c0dSBarry Smith       PetscStackCallSAWs(SAWs_Set_Port,(port));
60211525c0dSBarry Smith     }
60311525c0dSBarry Smith     ierr = PetscOptionsGetString(NULL,"-saws_root",root,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr);
60411525c0dSBarry Smith     if (flg) {
60511525c0dSBarry Smith       PetscStackCallSAWs(SAWs_Set_Document_Root,(root));CHKERRQ(ierr);
60611525c0dSBarry Smith       ierr = PetscStrcmp(root,".",&rootlocal);CHKERRQ(ierr);
60711525c0dSBarry Smith     }
60811525c0dSBarry Smith     ierr = PetscOptionsHasName(NULL,"-saws_local",&flg2);CHKERRQ(ierr);
60911525c0dSBarry Smith     if (flg2) {
61011525c0dSBarry Smith       char jsdir[PETSC_MAX_PATH_LEN];
61111525c0dSBarry Smith       if (!flg) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SUP,"-saws_local option requires -saws_root option");
61211525c0dSBarry Smith       ierr = PetscSNPrintf(jsdir,PETSC_MAX_PATH_LEN,"%s/js",root);CHKERRQ(ierr);
61311525c0dSBarry Smith       ierr = PetscTestDirectory(jsdir,'r',&flg);CHKERRQ(ierr);
61411525c0dSBarry Smith       if (!flg) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_FILE_READ,"-saws_local option requires js directory in root directory");
61543da4ab2SBarry Smith       PetscStackCallSAWs(SAWs_Push_Local_Header,());CHKERRQ(ierr);
61611525c0dSBarry Smith     }
61711525c0dSBarry Smith     ierr = PetscGetProgramName(programname,64);CHKERRQ(ierr);
61811525c0dSBarry Smith     ierr = PetscStrlen(help,&applinelen);CHKERRQ(ierr);
61911525c0dSBarry Smith     introlen   = 4096 + applinelen;
62011525c0dSBarry Smith     applinelen += 256;
62111525c0dSBarry Smith     ierr = PetscMalloc(applinelen,&appline);CHKERRQ(ierr);
62211525c0dSBarry Smith     ierr = PetscMalloc(introlen,&intro);CHKERRQ(ierr);
62311525c0dSBarry Smith 
62411525c0dSBarry Smith     if (rootlocal) {
62511525c0dSBarry Smith       ierr = PetscSNPrintf(appline,applinelen,"%s.c.html",programname);CHKERRQ(ierr);
62611525c0dSBarry Smith       ierr = PetscTestFile(appline,'r',&rootlocal);CHKERRQ(ierr);
62711525c0dSBarry Smith     }
62830befbd2SBarry Smith     ierr = PetscOptionsGetAll(&options);CHKERRQ(ierr);
62911525c0dSBarry Smith     if (rootlocal && help) {
63030befbd2SBarry 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);
63111525c0dSBarry Smith     } else if (help) {
63230befbd2SBarry Smith       ierr = PetscSNPrintf(appline,applinelen,"<center>Running %s %s</center><br><center><pre>%s</pre></center><br>\n",programname,options,help);
63311525c0dSBarry Smith     } else {
63430befbd2SBarry Smith       ierr = PetscSNPrintf(appline,applinelen,"<center> Running %s %s</center><br>\n",programname,options);
63511525c0dSBarry Smith     }
636b0bb5815SBarry Smith     ierr = PetscFree(options);CHKERRQ(ierr);
63730befbd2SBarry Smith     ierr = PetscGetVersion(version,sizeof(version));CHKERRQ(ierr);
63811525c0dSBarry Smith     ierr = PetscSNPrintf(intro,introlen,"<body>\n"
63911525c0dSBarry 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"
640df62c222SBarry Smith                                     "<center>This is the default PETSc application dashboard, from it you can access any published PETSc objects or logging data</center><br><center>%s configured with %s</center><br>\n"
641df62c222SBarry Smith                                     "%s",version,petscconfigureoptions,appline);
64243da4ab2SBarry Smith     PetscStackCallSAWs(SAWs_Push_Body,("index.html",0,intro));
64311525c0dSBarry Smith     ierr = PetscFree(intro);CHKERRQ(ierr);
64411525c0dSBarry Smith     ierr = PetscFree(appline);CHKERRQ(ierr);
64511525c0dSBarry Smith     PetscStackCallSAWs(SAWs_Initialize,());
64611525c0dSBarry Smith     ierr = PetscCitationsRegister("@TechReport{ saws,"
64711525c0dSBarry Smith                                   "Author = {Matt Otten and Jed Brown and Barry Smith},"
64811525c0dSBarry Smith                                   "Title  = {Scientific Application Web Server (SAWs) Users Manual},"
64911525c0dSBarry Smith                                   "Institution = {Argonne National Laboratory},"
65011525c0dSBarry Smith                                   "Year   = 2013}",NULL);CHKERRQ(ierr);
65111525c0dSBarry Smith   }
65211525c0dSBarry Smith   PetscFunctionReturn(0);
65311525c0dSBarry Smith }
65411525c0dSBarry Smith #endif
65511525c0dSBarry Smith 
656793721a6SBarry Smith #undef __FUNCT__
657e5c89e4eSSatish Balay #define __FUNCT__ "PetscInitialize"
658e5c89e4eSSatish Balay /*@C
659e5c89e4eSSatish Balay    PetscInitialize - Initializes the PETSc database and MPI.
660e5c89e4eSSatish Balay    PetscInitialize() calls MPI_Init() if that has yet to be called,
661e5c89e4eSSatish Balay    so this routine should always be called near the beginning of
662e5c89e4eSSatish Balay    your program -- usually the very first line!
663e5c89e4eSSatish Balay 
664e5c89e4eSSatish Balay    Collective on MPI_COMM_WORLD or PETSC_COMM_WORLD if it has been set
665e5c89e4eSSatish Balay 
666e5c89e4eSSatish Balay    Input Parameters:
667e5c89e4eSSatish Balay +  argc - count of number of command line arguments
668e5c89e4eSSatish Balay .  args - the command line arguments
6690298fd71SBarry Smith .  file - [optional] PETSc database file, also checks ~username/.petscrc and .petscrc use NULL to not check for
670fc2bca9aSBarry Smith           code specific file. Use -skip_petscrc in the code specific file to skip the .petscrc files
6710298fd71SBarry Smith -  help - [optional] Help message to print, use NULL for no message
672e5c89e4eSSatish Balay 
67305827820SBarry Smith    If you wish PETSc code to run ONLY on a subcommunicator of MPI_COMM_WORLD, create that
67405827820SBarry Smith    communicator first and assign it to PETSC_COMM_WORLD BEFORE calling PetscInitialize(). Thus if you are running a
67505827820SBarry Smith    four process job and two processes will run PETSc and have PetscInitialize() and PetscFinalize() and two process will not,
67605827820SBarry Smith    then do this. If ALL processes in the job are using PetscInitialize() and PetscFinalize() then you don't need to do this, even
67705827820SBarry Smith    if different subcommunicators of the job are doing different things with PETSc.
678e5c89e4eSSatish Balay 
679e5c89e4eSSatish Balay    Options Database Keys:
680e5c89e4eSSatish Balay +  -start_in_debugger [noxterm,dbx,xdb,gdb,...] - Starts program in debugger
681e5c89e4eSSatish Balay .  -on_error_attach_debugger [noxterm,dbx,xdb,gdb,...] - Starts debugger when error detected
682e5c89e4eSSatish Balay .  -on_error_emacs <machinename> causes emacsclient to jump to error file
683b52f573bSBarry Smith .  -on_error_abort calls abort() when error detected (no traceback)
684e8fb0fc0SBarry Smith .  -on_error_mpiabort calls MPI_abort() when error detected
685e8fb0fc0SBarry Smith .  -error_output_stderr prints error messages to stderr instead of the default stdout
686e8fb0fc0SBarry Smith .  -error_output_none does not print the error messages (but handles errors in the same way as if this was not called)
687e5c89e4eSSatish Balay .  -debugger_nodes [node1,node2,...] - Indicates nodes to start in debugger
688e5c89e4eSSatish Balay .  -debugger_pause [sleeptime] (in seconds) - Pauses debugger
689e5c89e4eSSatish Balay .  -stop_for_debugger - Print message on how to attach debugger manually to
690e5c89e4eSSatish Balay                         process and wait (-debugger_pause) seconds for attachment
6912fb0ec9aSBarry Smith .  -malloc - Indicates use of PETSc error-checking malloc (on by default for debug version of libraries)
692e5c89e4eSSatish Balay .  -malloc no - Indicates not to use error-checking malloc
6932fb0ec9aSBarry Smith .  -malloc_debug - check for memory corruption at EVERY malloc or free
694aee23540SBarry Smith .  -malloc_dump - prints a list of all unfreed memory at the end of the run
695dc92acbaSJed Brown .  -malloc_test - like -malloc_dump -malloc_debug, but only active for debugging builds
696e5c89e4eSSatish Balay .  -fp_trap - Stops on floating point exceptions (Note that on the
697e5c89e4eSSatish Balay               IBM RS6000 this slows code by at least a factor of 10.)
698e5c89e4eSSatish Balay .  -no_signal_handler - Indicates not to trap error signals
699e5c89e4eSSatish Balay .  -shared_tmp - indicates /tmp directory is shared by all processors
700e5c89e4eSSatish Balay .  -not_shared_tmp - each processor has own /tmp
701e5c89e4eSSatish Balay .  -tmp - alternative name of /tmp directory
702e5c89e4eSSatish Balay .  -get_total_flops - returns total flops done by all processors
703142c234bSBarry Smith -  -memory_info - Print memory usage at end of run
704e5c89e4eSSatish Balay 
705e5c89e4eSSatish Balay    Options Database Keys for Profiling:
706a7f22e61SSatish Balay    See Users-Manual: ch_profiling for details.
707495fc317SBarry Smith +  -info <optional filename> - Prints verbose information to the screen
708495fc317SBarry Smith .  -info_exclude <null,vec,mat,pc,ksp,snes,ts> - Excludes some of the verbose messages
709495fc317SBarry Smith .  -log_sync - Log the synchronization in scatters, inner products and norms
710495fc317SBarry Smith .  -log_trace [filename] - Print traces of all PETSc calls to the screen (useful to determine where a program
711e5c89e4eSSatish Balay         hangs without running in the debugger).  See PetscLogTraceBegin().
712495fc317SBarry Smith .  -log_summary [filename] - Prints summary of flop and timing information to screen. If the filename is specified the
713495fc317SBarry Smith         summary is written to the file.  See PetscLogView().
714495fc317SBarry Smith .  -log_all [filename] - Logs extensive profiling information  See PetscLogDump().
715495fc317SBarry Smith .  -log [filename] - Logs basic profiline information  See PetscLogDump().
716495fc317SBarry Smith -  -log_mpe [filename] - Creates a logfile viewable by the utility Jumpshot (in MPICH distribution)
717495fc317SBarry Smith 
718495fc317SBarry Smith     Only one of -log_trace, -log_summary, -log_all, -log, or -log_mpe may be used at a time
719e5c89e4eSSatish Balay 
720e5c89e4eSSatish Balay    Environmental Variables:
721e5c89e4eSSatish Balay +   PETSC_TMP - alternative tmp directory
722e5c89e4eSSatish Balay .   PETSC_SHARED_TMP - tmp is shared by all processes
723e5c89e4eSSatish Balay .   PETSC_NOT_SHARED_TMP - each process has its own private tmp
724e5c89e4eSSatish Balay .   PETSC_VIEWER_SOCKET_PORT - socket number to use for socket viewer
725e5c89e4eSSatish Balay -   PETSC_VIEWER_SOCKET_MACHINE - machine to use for socket viewer to connect to
726e5c89e4eSSatish Balay 
727e5c89e4eSSatish Balay 
728e5c89e4eSSatish Balay    Level: beginner
729e5c89e4eSSatish Balay 
730e5c89e4eSSatish Balay    Notes:
731e5c89e4eSSatish Balay    If for some reason you must call MPI_Init() separately, call
732e5c89e4eSSatish Balay    it before PetscInitialize().
733e5c89e4eSSatish Balay 
734e5c89e4eSSatish Balay    Fortran Version:
735e5c89e4eSSatish Balay    In Fortran this routine has the format
736e5c89e4eSSatish Balay $       call PetscInitialize(file,ierr)
737e5c89e4eSSatish Balay 
738e5c89e4eSSatish Balay +   ierr - error return code
7390298fd71SBarry Smith -  file - [optional] PETSc database file, also checks ~username/.petscrc and .petscrc use NULL_CHARACTER to not check for
740fc2bca9aSBarry Smith           code specific file. Use -skip_petscrc in the code specific file to skip the .petscrc files
741e5c89e4eSSatish Balay 
742e5c89e4eSSatish Balay    Important Fortran Note:
7430298fd71SBarry Smith    In Fortran, you MUST use NULL_CHARACTER to indicate a
7440298fd71SBarry Smith    null character string; you CANNOT just use NULL as
745a7f22e61SSatish Balay    in the C version. See Users-Manual: ch_fortran for details.
746e5c89e4eSSatish Balay 
74701cb0274SBarry Smith    If your main program is C but you call Fortran code that also uses PETSc you need to call PetscInitializeFortran() soon after
74801cb0274SBarry Smith    calling PetscInitialize().
749e5c89e4eSSatish Balay 
750e5c89e4eSSatish Balay    Concepts: initializing PETSc
751e5c89e4eSSatish Balay 
75201cb0274SBarry Smith .seealso: PetscFinalize(), PetscInitializeFortran(), PetscGetArgs(), PetscInitializeNoArguments()
753e5c89e4eSSatish Balay 
754e5c89e4eSSatish Balay @*/
7557087cfbeSBarry Smith PetscErrorCode  PetscInitialize(int *argc,char ***args,const char file[],const char help[])
756e5c89e4eSSatish Balay {
757e5c89e4eSSatish Balay   PetscErrorCode ierr;
7584bb5149bSJed Brown   PetscMPIInt    flag, size;
759ace3abfcSBarry Smith   PetscBool      flg;
760e5c89e4eSSatish Balay   char           hostname[256];
761e5c89e4eSSatish Balay 
762e5c89e4eSSatish Balay   PetscFunctionBegin;
763e5c89e4eSSatish Balay   if (PetscInitializeCalled) PetscFunctionReturn(0);
764e5c89e4eSSatish Balay 
765ae9b4142SLisandro Dalcin   /* these must be initialized in a routine, not as a constant declaration*/
766d89683f4Sbcordonn   PETSC_STDOUT = stdout;
767ae9b4142SLisandro Dalcin   PETSC_STDERR = stderr;
768e5c89e4eSSatish Balay 
7690c30907bSSatish Balay   /* on Windows - set printf to default to printing 2 digit exponents */
7700c30907bSSatish Balay #if defined(PETSC_HAVE__SET_OUTPUT_FORMAT)
7710c30907bSSatish Balay   _set_output_format(_TWO_DIGIT_EXPONENT);
7720c30907bSSatish Balay #endif
7730c30907bSSatish Balay 
774e5c89e4eSSatish Balay   ierr = PetscOptionsCreate();CHKERRQ(ierr);
775e5c89e4eSSatish Balay 
776e5c89e4eSSatish Balay   /*
777e5c89e4eSSatish Balay      We initialize the program name here (before MPI_Init()) because MPICH has a bug in
778e5c89e4eSSatish Balay      it that it sets args[0] on all processors to be args[0] on the first processor.
779e5c89e4eSSatish Balay   */
780e5c89e4eSSatish Balay   if (argc && *argc) {
781e5c89e4eSSatish Balay     ierr = PetscSetProgramName(**args);CHKERRQ(ierr);
782e5c89e4eSSatish Balay   } else {
783e5c89e4eSSatish Balay     ierr = PetscSetProgramName("Unknown Name");CHKERRQ(ierr);
784e5c89e4eSSatish Balay   }
785e5c89e4eSSatish Balay 
786e5c89e4eSSatish Balay   ierr = MPI_Initialized(&flag);CHKERRQ(ierr);
787e5c89e4eSSatish Balay   if (!flag) {
788e32f2f54SBarry 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");
7895e765c61SJed Brown #if defined(PETSC_HAVE_MPI_INIT_THREAD)
7905e765c61SJed Brown     {
7915e765c61SJed Brown       PetscMPIInt provided;
7925e765c61SJed Brown       ierr = MPI_Init_thread(argc,args,MPI_THREAD_FUNNELED,&provided);CHKERRQ(ierr);
7935e765c61SJed Brown     }
7945e765c61SJed Brown #else
795e5c89e4eSSatish Balay     ierr = MPI_Init(argc,args);CHKERRQ(ierr);
7965e765c61SJed Brown #endif
797e5c89e4eSSatish Balay     PetscBeganMPI = PETSC_TRUE;
798e5c89e4eSSatish Balay   }
799e5c89e4eSSatish Balay   if (argc && args) {
800e5c89e4eSSatish Balay     PetscGlobalArgc = *argc;
801e5c89e4eSSatish Balay     PetscGlobalArgs = *args;
802e5c89e4eSSatish Balay   }
803e5c89e4eSSatish Balay   PetscFinalizeCalled = PETSC_FALSE;
804e5c89e4eSSatish Balay 
805a297a907SKarl Rupp   if (PETSC_COMM_WORLD == MPI_COMM_NULL) PETSC_COMM_WORLD = MPI_COMM_WORLD;
806d54338ecSKarl Rupp   ierr = MPI_Comm_set_errhandler(PETSC_COMM_WORLD,MPI_ERRORS_RETURN);CHKERRQ(ierr);
807e5c89e4eSSatish Balay 
808e5c89e4eSSatish Balay   /* Done after init due to a bug in MPICH-GM? */
809e5c89e4eSSatish Balay   ierr = PetscErrorPrintfInitialize();CHKERRQ(ierr);
810e5c89e4eSSatish Balay 
811e5c89e4eSSatish Balay   ierr = MPI_Comm_rank(MPI_COMM_WORLD,&PetscGlobalRank);CHKERRQ(ierr);
812e5c89e4eSSatish Balay   ierr = MPI_Comm_size(MPI_COMM_WORLD,&PetscGlobalSize);CHKERRQ(ierr);
813e5c89e4eSSatish Balay 
8148ad47952SJed Brown   MPIU_BOOL = MPI_INT;
8158ad47952SJed Brown   MPIU_ENUM = MPI_INT;
8168ad47952SJed Brown 
817e5c89e4eSSatish Balay   /*
818e5c89e4eSSatish Balay      Initialized the global complex variable; this is because with
819e5c89e4eSSatish Balay      shared libraries the constructors for global variables
820e5c89e4eSSatish Balay      are not called; at least on IRIX.
821e5c89e4eSSatish Balay   */
822886cfec0SSatish Balay #if defined(PETSC_HAVE_COMPLEX)
823e5c89e4eSSatish Balay   {
824a24ee22aSSatish Balay #if defined(PETSC_CLANGUAGE_CXX)
82550f81f78SJed Brown     PetscComplex ic(0.0,1.0);
826e5c89e4eSSatish Balay     PETSC_i = ic;
827a24ee22aSSatish Balay #elif defined(PETSC_CLANGUAGE_C)
82850f81f78SJed Brown     PETSC_i = _Complex_I;
829b7940d39SSatish Balay #endif
830762437b8SSatish Balay   }
831762437b8SSatish Balay 
8322c876bd9SBarry Smith #if !defined(PETSC_HAVE_MPI_C_DOUBLE_COMPLEX)
833e69cd0e6SSatish Balay   ierr = MPI_Type_contiguous(2,MPI_DOUBLE,&MPIU_C_DOUBLE_COMPLEX);CHKERRQ(ierr);
834500d8756SSatish Balay   ierr = MPI_Type_commit(&MPIU_C_DOUBLE_COMPLEX);CHKERRQ(ierr);
835500d8756SSatish Balay   ierr = MPI_Type_contiguous(2,MPI_FLOAT,&MPIU_C_COMPLEX);CHKERRQ(ierr);
836500d8756SSatish Balay   ierr = MPI_Type_commit(&MPIU_C_COMPLEX);CHKERRQ(ierr);
8372c876bd9SBarry Smith #endif
838886cfec0SSatish Balay #endif /* PETSC_HAVE_COMPLEX */
839e5c89e4eSSatish Balay 
840e5c89e4eSSatish Balay   /*
841e5c89e4eSSatish Balay      Create the PETSc MPI reduction operator that sums of the first
842e5c89e4eSSatish Balay      half of the entries and maxes the second half.
843e5c89e4eSSatish Balay   */
844e5c89e4eSSatish Balay   ierr = MPI_Op_create(PetscMaxSum_Local,1,&PetscMaxSum_Op);CHKERRQ(ierr);
845e5c89e4eSSatish Balay 
846ce63c4c1SBarry Smith #if defined(PETSC_USE_REAL___FLOAT128)
847c90a1750SBarry Smith   ierr = MPI_Type_contiguous(2,MPI_DOUBLE,&MPIU___FLOAT128);CHKERRQ(ierr);
848c90a1750SBarry Smith   ierr = MPI_Type_commit(&MPIU___FLOAT128);CHKERRQ(ierr);
8497c2de775SJed Brown #if defined(PETSC_HAVE_COMPLEX)
8508c764dc5SJose Roman   ierr = MPI_Type_contiguous(4,MPI_DOUBLE,&MPIU___COMPLEX128);CHKERRQ(ierr);
8518c764dc5SJose Roman   ierr = MPI_Type_commit(&MPIU___COMPLEX128);CHKERRQ(ierr);
8528c764dc5SJose Roman #endif
853d9822059SBarry Smith   ierr = MPI_Op_create(PetscMax_Local,1,&MPIU_MAX);CHKERRQ(ierr);
854d9822059SBarry Smith   ierr = MPI_Op_create(PetscMin_Local,1,&MPIU_MIN);CHKERRQ(ierr);
855c90a1750SBarry Smith #endif
856c90a1750SBarry Smith 
8577c2de775SJed Brown #if (defined(PETSC_HAVE_COMPLEX) && !defined(PETSC_HAVE_MPI_C_DOUBLE_COMPLEX)) || defined(PETSC_USE_REAL___FLOAT128)
858cca4cb22SSatish Balay   ierr = MPI_Op_create(PetscSum_Local,1,&MPIU_SUM);CHKERRQ(ierr);
859cca4cb22SSatish Balay #endif
860cca4cb22SSatish Balay 
861e5c89e4eSSatish Balay   ierr = MPI_Type_contiguous(2,MPIU_SCALAR,&MPIU_2SCALAR);CHKERRQ(ierr);
862e5c89e4eSSatish Balay   ierr = MPI_Type_commit(&MPIU_2SCALAR);CHKERRQ(ierr);
863e5c89e4eSSatish Balay   ierr = MPI_Op_create(PetscADMax_Local,1,&PetscADMax_Op);CHKERRQ(ierr);
864e5c89e4eSSatish Balay   ierr = MPI_Op_create(PetscADMin_Local,1,&PetscADMin_Op);CHKERRQ(ierr);
865e5c89e4eSSatish Balay 
86644041f26SJed Brown #if defined(PETSC_USE_64BIT_INDICES) || !defined(MPI_2INT)
867e5c89e4eSSatish Balay   ierr = MPI_Type_contiguous(2,MPIU_INT,&MPIU_2INT);CHKERRQ(ierr);
868e5c89e4eSSatish Balay   ierr = MPI_Type_commit(&MPIU_2INT);CHKERRQ(ierr);
86944041f26SJed Brown #endif
870e5c89e4eSSatish Balay 
871ec957eceSBarry Smith 
872e5c89e4eSSatish Balay   /*
873480cf27aSJed Brown      Attributes to be set on PETSc communicators
874480cf27aSJed Brown   */
875480cf27aSJed Brown   ierr = MPI_Keyval_create(MPI_NULL_COPY_FN,Petsc_DelCounter,&Petsc_Counter_keyval,(void*)0);CHKERRQ(ierr);
876da3039f7SJed Brown   ierr = MPI_Keyval_create(MPI_NULL_COPY_FN,Petsc_DelComm_Outer,&Petsc_InnerComm_keyval,(void*)0);CHKERRQ(ierr);
877da3039f7SJed Brown   ierr = MPI_Keyval_create(MPI_NULL_COPY_FN,Petsc_DelComm_Inner,&Petsc_OuterComm_keyval,(void*)0);CHKERRQ(ierr);
878480cf27aSJed Brown 
879480cf27aSJed Brown   /*
880e8fb0fc0SBarry Smith      Build the options database
881e5c89e4eSSatish Balay   */
882e5c89e4eSSatish Balay   ierr = PetscOptionsInsert(argc,args,file);CHKERRQ(ierr);
883e5c89e4eSSatish Balay 
8846dc8fec2Sbcordonn 
885e5c89e4eSSatish Balay   /*
886e5c89e4eSSatish Balay      Print main application help message
887e5c89e4eSSatish Balay   */
8880298fd71SBarry Smith   ierr = PetscOptionsHasName(NULL,"-help",&flg);CHKERRQ(ierr);
889e5c89e4eSSatish Balay   if (help && flg) {
890e5c89e4eSSatish Balay     ierr = PetscPrintf(PETSC_COMM_WORLD,help);CHKERRQ(ierr);
891e5c89e4eSSatish Balay   }
892e5c89e4eSSatish Balay   ierr = PetscOptionsCheckInitial_Private();CHKERRQ(ierr);
893e5c89e4eSSatish Balay 
894d45a07a7SBarry Smith   ierr = PetscCitationsInitialize();CHKERRQ(ierr);
895d45a07a7SBarry Smith 
896e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS)
89711525c0dSBarry Smith   ierr = PetscInitializeSAWs(help);CHKERRQ(ierr);
898f4202a44SBarry Smith #endif
899f4202a44SBarry Smith 
900e5c89e4eSSatish Balay   /* SHOULD PUT IN GUARDS: Make sure logging is initialized, even if we do not print it out */
901a9f03627SSatish Balay #if defined(PETSC_USE_LOG)
902e5c89e4eSSatish Balay   ierr = PetscLogBegin_Private();CHKERRQ(ierr);
903a9f03627SSatish Balay #endif
904e5c89e4eSSatish Balay 
905e5c89e4eSSatish Balay   /*
906e5c89e4eSSatish Balay      Load the dynamic libraries (on machines that support them), this registers all
907e5c89e4eSSatish Balay      the solvers etc. (On non-dynamic machines this initializes the PetscDraw and PetscViewer classes)
908e5c89e4eSSatish Balay   */
909e5c89e4eSSatish Balay   ierr = PetscInitialize_DynamicLibraries();CHKERRQ(ierr);
910e5c89e4eSSatish Balay 
911e5c89e4eSSatish Balay   ierr = MPI_Comm_size(PETSC_COMM_WORLD,&size);CHKERRQ(ierr);
912ae15b995SBarry Smith   ierr = PetscInfo1(0,"PETSc successfully started: number of processors = %d\n",size);CHKERRQ(ierr);
913e5c89e4eSSatish Balay   ierr = PetscGetHostName(hostname,256);CHKERRQ(ierr);
914ae15b995SBarry Smith   ierr = PetscInfo1(0,"Running on machine: %s\n",hostname);CHKERRQ(ierr);
915e5c89e4eSSatish Balay 
91667234432SDmitry Karpeev   /* Ensure that threadcomm-related keyval exists, so that PetscOptionsSetFromOptions can use PetscCommDuplicate. */
91767234432SDmitry Karpeev   ierr = PetscThreadCommInitializePackage();CHKERRQ(ierr);
91867234432SDmitry Karpeev 
919e5c89e4eSSatish Balay   ierr = PetscOptionsCheckInitial_Components();CHKERRQ(ierr);
920ef6c6fedSBoyana Norris   /* Check the options database for options related to the options database itself */
921ef6c6fedSBoyana Norris   ierr = PetscOptionsSetFromOptions();CHKERRQ(ierr);
922ef6c6fedSBoyana Norris 
923951e3c8eSBarry Smith #if defined(PETSC_USE_PETSC_MPI_EXTERNAL32)
924e39fd77fSBarry Smith   /*
925e39fd77fSBarry Smith       Tell MPI about our own data representation converter, this would/should be used if extern32 is not supported by the MPI
926e39fd77fSBarry Smith 
927e39fd77fSBarry Smith       Currently not used because it is not supported by MPICH.
928e39fd77fSBarry Smith   */
929e39fd77fSBarry Smith #if !defined(PETSC_WORDS_BIGENDIAN)
9300298fd71SBarry Smith   ierr = MPI_Register_datarep((char*)"petsc",PetscDataRep_read_conv_fn,PetscDataRep_write_conv_fn,PetscDataRep_extent_fn,NULL);CHKERRQ(ierr);
931e39fd77fSBarry Smith #endif
932951e3c8eSBarry Smith #endif
933e39fd77fSBarry Smith 
93435d88935SVictor Minden #if defined(PETSC_HAVE_CUDA)
93520e2c332SMatthew G. Knepley   flg  = PETSC_TRUE;
93620e2c332SMatthew G. Knepley   ierr = PetscOptionsGetBool(NULL,"-cublas",&flg,NULL);CHKERRQ(ierr);
93720e2c332SMatthew G. Knepley   if (flg) {
9384bb5149bSJed Brown     PetscMPIInt p;
939663ba86aSMatthew G Knepley     for (p = 0; p < PetscGlobalSize; ++p) {
940a297a907SKarl Rupp       if (p == PetscGlobalRank) cublasInit();
941663ba86aSMatthew G Knepley       ierr = MPI_Barrier(PETSC_COMM_WORLD);CHKERRQ(ierr);
942663ba86aSMatthew G Knepley     }
9434bb5149bSJed Brown   }
9443e39abd9SVictor Minden #endif
94592e62aa6SBarry Smith 
9460298fd71SBarry Smith   ierr = PetscOptionsHasName(NULL,"-python",&flg);CHKERRQ(ierr);
9479ac80d5eSLisandro Dalcin   if (flg) {
9489ac80d5eSLisandro Dalcin     PetscInitializeCalled = PETSC_TRUE;
9490298fd71SBarry Smith     ierr = PetscPythonInitialize(NULL,NULL);CHKERRQ(ierr);
9509ac80d5eSLisandro Dalcin   }
9519ac80d5eSLisandro Dalcin 
95241c0b4b3SShri Abhyankar   /*
95341c0b4b3SShri Abhyankar       Setup building of stack frames for all function calls
95441c0b4b3SShri Abhyankar   */
95576386721SLisandro Dalcin   PetscThreadLocalRegister((PetscThreadKey*)&petscstack); /* Creates pthread_key */
956e1167bb9SShri Abhyankar #if defined(PETSC_USE_DEBUG)
957e1167bb9SShri Abhyankar   ierr = PetscStackCreate();CHKERRQ(ierr);
958e1167bb9SShri Abhyankar #endif
959e1167bb9SShri Abhyankar 
9602d53ad75SBarry Smith #if defined(PETSC_SERIALIZE_FUNCTIONS)
9612d53ad75SBarry Smith   ierr = PetscFPTCreate(10000);CHKERRQ(ierr);
9622d53ad75SBarry Smith #endif
9632d53ad75SBarry Smith 
964dff31646SBarry Smith 
965301d30feSBarry Smith   /*
966301d30feSBarry Smith       Once we are completedly initialized then we can set this variables
967301d30feSBarry Smith   */
968301d30feSBarry Smith   PetscInitializeCalled = PETSC_TRUE;
969301d30feSBarry Smith   PetscFunctionReturn(0);
970e5c89e4eSSatish Balay }
971e5c89e4eSSatish Balay 
9724097062eSBarry Smith #if defined(PETSC_USE_LOG)
9732eff7a51SBarry Smith extern PetscObject *PetscObjects;
9742eff7a51SBarry Smith extern PetscInt    PetscObjectsCounts, PetscObjectsMaxCounts;
9754097062eSBarry Smith #endif
976e5c89e4eSSatish Balay 
977e5c89e4eSSatish Balay #undef __FUNCT__
978e5c89e4eSSatish Balay #define __FUNCT__ "PetscFinalize"
979e5c89e4eSSatish Balay /*@C
980e5c89e4eSSatish Balay    PetscFinalize - Checks for options to be called at the conclusion
981e5c89e4eSSatish Balay    of the program. MPI_Finalize() is called only if the user had not
982e5c89e4eSSatish Balay    called MPI_Init() before calling PetscInitialize().
983e5c89e4eSSatish Balay 
984e5c89e4eSSatish Balay    Collective on PETSC_COMM_WORLD
985e5c89e4eSSatish Balay 
986e5c89e4eSSatish Balay    Options Database Keys:
98788c29154SBarry Smith +  -options_table - Calls PetscOptionsView()
988e5c89e4eSSatish Balay .  -options_left - Prints unused options that remain in the database
9897eb1d149SBarry 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
990e5c89e4eSSatish Balay .  -mpidump - Calls PetscMPIDump()
991e5c89e4eSSatish Balay .  -malloc_dump - Calls PetscMallocDump()
992e5c89e4eSSatish Balay .  -malloc_info - Prints total memory usage
993e5c89e4eSSatish Balay -  -malloc_log - Prints summary of memory usage
994e5c89e4eSSatish Balay 
995e5c89e4eSSatish Balay    Level: beginner
996e5c89e4eSSatish Balay 
997e5c89e4eSSatish Balay    Note:
998e5c89e4eSSatish Balay    See PetscInitialize() for more general runtime options.
999e5c89e4eSSatish Balay 
100088c29154SBarry Smith .seealso: PetscInitialize(), PetscOptionsView(), PetscMallocDump(), PetscMPIDump(), PetscEnd()
1001e5c89e4eSSatish Balay @*/
10027087cfbeSBarry Smith PetscErrorCode  PetscFinalize(void)
1003e5c89e4eSSatish Balay {
1004e5c89e4eSSatish Balay   PetscErrorCode ierr;
10054bb5149bSJed Brown   PetscMPIInt    rank;
1006a8d2bbe5SBarry Smith   PetscInt       nopt;
10072bf49c77SBarry Smith   PetscBool      flg1 = PETSC_FALSE,flg2 = PETSC_FALSE,flg3 = PETSC_FALSE;
1008dff31646SBarry Smith   PetscBool      flg;
100910463e74SBarry Smith #if defined(PETSC_USE_LOG)
101010463e74SBarry Smith   char           mname[PETSC_MAX_PATH_LEN];
101110463e74SBarry Smith #endif
1012e5c89e4eSSatish Balay 
1013e5c89e4eSSatish Balay   PetscFunctionBegin;
1014e5c89e4eSSatish Balay   if (!PetscInitializeCalled) {
10154b09e917SBarry Smith     printf("PetscInitialize() must be called before PetscFinalize()\n");
10164b09e917SBarry Smith     PetscFunctionReturn(PETSC_ERR_ARG_WRONGSTATE);
1017e5c89e4eSSatish Balay   }
10180298fd71SBarry Smith   ierr = PetscInfo(NULL,"PetscFinalize() called\n");CHKERRQ(ierr);
1019b022a5c1SBarry Smith 
10201f817a21SBarry Smith   ierr = MPI_Comm_rank(PETSC_COMM_WORLD,&rank);CHKERRQ(ierr);
10211f817a21SBarry Smith 
10221f817a21SBarry Smith   ierr = PetscOptionsHasName(NULL,"-citations",&flg);CHKERRQ(ierr);
1023dff31646SBarry Smith   if (flg) {
10241f817a21SBarry Smith     char  *cits, filename[PETSC_MAX_PATH_LEN];
10251f817a21SBarry Smith     FILE  *fd = PETSC_STDOUT;
10261f817a21SBarry Smith 
10271f817a21SBarry Smith     ierr = PetscOptionsGetString(NULL,"-citations",filename,PETSC_MAX_PATH_LEN,NULL);CHKERRQ(ierr);
10281f817a21SBarry Smith     if (filename[0]) {
10291f817a21SBarry Smith       ierr = PetscFOpen(PETSC_COMM_WORLD,filename,"w",&fd);CHKERRQ(ierr);
10301f817a21SBarry Smith     }
1031dff31646SBarry Smith     ierr = PetscSegBufferGet(PetscCitationsList,1,&cits);CHKERRQ(ierr);
1032dff31646SBarry Smith     cits[0] = 0;
1033dff31646SBarry Smith     ierr = PetscSegBufferExtractAlloc(PetscCitationsList,&cits);CHKERRQ(ierr);
10341f817a21SBarry Smith     ierr = PetscFPrintf(PETSC_COMM_WORLD,fd,"If you publish results based on this computation please cite the following:\n");CHKERRQ(ierr);
10351f817a21SBarry Smith     ierr = PetscFPrintf(PETSC_COMM_WORLD,fd,"===========================================================================\n");CHKERRQ(ierr);
10361f817a21SBarry Smith     ierr = PetscFPrintf(PETSC_COMM_WORLD,fd,"%s",cits);CHKERRQ(ierr);
10371f817a21SBarry Smith     ierr = PetscFPrintf(PETSC_COMM_WORLD,fd,"===========================================================================\n");CHKERRQ(ierr);
10381f817a21SBarry Smith     ierr = PetscFClose(PETSC_COMM_WORLD,fd);CHKERRQ(ierr);
1039dff31646SBarry Smith     ierr = PetscFree(cits);CHKERRQ(ierr);
1040dff31646SBarry Smith   }
1041dff31646SBarry Smith   ierr = PetscSegBufferDestroy(&PetscCitationsList);CHKERRQ(ierr);
1042dff31646SBarry Smith 
1043c2a97968SBarry Smith #if defined(PETSC_HAVE_SSL) && defined(PETSC_USE_SOCKET_VIEWER)
104404102261SBarry Smith   /* TextBelt is run for testing purposes only, please do not use this feature often */
104504102261SBarry Smith   {
104604102261SBarry Smith     PetscInt nmax = 2;
104704102261SBarry Smith     char     **buffs;
104804102261SBarry Smith     ierr = PetscMalloc1(2,&buffs);CHKERRQ(ierr);
104904102261SBarry Smith     ierr = PetscOptionsGetStringArray(NULL,"-textbelt",buffs,&nmax,&flg1);CHKERRQ(ierr);
105004102261SBarry Smith     if (flg1) {
105104102261SBarry Smith       if (!nmax) SETERRQ(PETSC_COMM_WORLD,PETSC_ERR_USER,"-textbelt requires either the phone number or number,\"message\"");
105204102261SBarry Smith       if (nmax == 1) {
105304102261SBarry Smith         ierr = PetscMalloc1(128,&buffs[1]);CHKERRQ(ierr);
105404102261SBarry Smith         ierr = PetscGetProgramName(buffs[1],32);CHKERRQ(ierr);
105504102261SBarry Smith         ierr = PetscStrcat(buffs[1]," has completed");CHKERRQ(ierr);
105604102261SBarry Smith       }
105704102261SBarry Smith       ierr = PetscTextBelt(PETSC_COMM_WORLD,buffs[0],buffs[1],NULL);CHKERRQ(ierr);
105804102261SBarry Smith       ierr = PetscFree(buffs[0]);CHKERRQ(ierr);
105904102261SBarry Smith       ierr = PetscFree(buffs[1]);CHKERRQ(ierr);
106004102261SBarry Smith     }
106104102261SBarry Smith     ierr = PetscFree(buffs);CHKERRQ(ierr);
106204102261SBarry Smith   }
106304102261SBarry Smith #endif
106467234432SDmitry Karpeev   /*
106567234432SDmitry Karpeev     It should be safe to cancel the options monitors, since we don't expect to be setting options
106667234432SDmitry Karpeev     here (at least that are worth monitoring).  Monitors ought to be released so that they release
106767234432SDmitry Karpeev     whatever memory was allocated there before -malloc_dump reports unfreed memory.
106867234432SDmitry Karpeev   */
106967234432SDmitry Karpeev   ierr = PetscOptionsMonitorCancel();CHKERRQ(ierr);
107004102261SBarry Smith 
10712d53ad75SBarry Smith #if defined(PETSC_SERIALIZE_FUNCTIONS)
10722d53ad75SBarry Smith   ierr = PetscFPTDestroy();CHKERRQ(ierr);
10732d53ad75SBarry Smith #endif
10742d53ad75SBarry Smith 
10752d53ad75SBarry Smith 
1076e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS)
1077dff31646SBarry Smith   flg = PETSC_FALSE;
1078e78c4b8cSBarry Smith   ierr = PetscOptionsGetBool(NULL,"-saw_options",&flg,NULL);CHKERRQ(ierr);
1079d5649816SBarry Smith   if (flg) {
1080e04113cfSBarry Smith     ierr = PetscOptionsSAWsDestroy();CHKERRQ(ierr);
1081d5649816SBarry Smith   }
1082d5649816SBarry Smith #endif
1083d5649816SBarry Smith 
1084681455b2SBarry Smith #if defined(PETSC_HAVE_X)
1085681455b2SBarry Smith   flg1 = PETSC_FALSE;
1086681455b2SBarry Smith   ierr = PetscOptionsGetBool(NULL,"-x_virtual",&flg1,NULL);CHKERRQ(ierr);
1087681455b2SBarry Smith   if (flg1) {
1088681455b2SBarry Smith     /*  this is a crude hack, but better than nothing */
1089681455b2SBarry Smith     ierr = PetscPOpen(PETSC_COMM_WORLD,NULL,"pkill -9 Xvfb","r",NULL);CHKERRQ(ierr);
1090681455b2SBarry Smith   }
1091681455b2SBarry Smith #endif
1092681455b2SBarry Smith 
10930298fd71SBarry Smith   ierr = PetscOptionsGetBool(NULL,"-malloc_info",&flg2,NULL);CHKERRQ(ierr);
1094e5c89e4eSSatish Balay   if (!flg2) {
109590d69ab7SBarry Smith     flg2 = PETSC_FALSE;
10960298fd71SBarry Smith     ierr = PetscOptionsGetBool(NULL,"-memory_info",&flg2,NULL);CHKERRQ(ierr);
1097e5c89e4eSSatish Balay   }
1098e5c89e4eSSatish Balay   if (flg2) {
1099e5c89e4eSSatish Balay     ierr = PetscMemoryShowUsage(PETSC_VIEWER_STDOUT_WORLD,"Summary of Memory Usage in PETSc\n");CHKERRQ(ierr);
1100e5c89e4eSSatish Balay   }
1101e5c89e4eSSatish Balay 
1102e5c89e4eSSatish Balay #if defined(PETSC_USE_LOG)
110390d69ab7SBarry Smith   flg1 = PETSC_FALSE;
11040298fd71SBarry Smith   ierr = PetscOptionsGetBool(NULL,"-get_total_flops",&flg1,NULL);CHKERRQ(ierr);
1105e5c89e4eSSatish Balay   if (flg1) {
1106e5c89e4eSSatish Balay     PetscLogDouble flops = 0;
1107205a32c2SJed Brown     ierr = MPI_Reduce(&petsc_TotalFlops,&flops,1,MPI_DOUBLE,MPI_SUM,0,PETSC_COMM_WORLD);CHKERRQ(ierr);
1108e5c89e4eSSatish Balay     ierr = PetscPrintf(PETSC_COMM_WORLD,"Total flops over all processors %g\n",flops);CHKERRQ(ierr);
1109e5c89e4eSSatish Balay   }
1110e5c89e4eSSatish Balay #endif
1111e5c89e4eSSatish Balay 
1112e5c89e4eSSatish Balay 
1113e5c89e4eSSatish Balay #if defined(PETSC_USE_LOG)
1114e5c89e4eSSatish Balay #if defined(PETSC_HAVE_MPE)
1115e5c89e4eSSatish Balay   mname[0] = 0;
1116a297a907SKarl Rupp 
11170298fd71SBarry Smith   ierr = PetscOptionsGetString(NULL,"-log_mpe",mname,PETSC_MAX_PATH_LEN,&flg1);CHKERRQ(ierr);
1118e5c89e4eSSatish Balay   if (flg1) {
1119e5c89e4eSSatish Balay     if (mname[0]) {ierr = PetscLogMPEDump(mname);CHKERRQ(ierr);}
1120e5c89e4eSSatish Balay     else          {ierr = PetscLogMPEDump(0);CHKERRQ(ierr);}
1121e5c89e4eSSatish Balay   }
1122e5c89e4eSSatish Balay #endif
1123e5c89e4eSSatish Balay   mname[0] = 0;
1124a297a907SKarl Rupp 
1125f14045dbSBarry Smith   ierr = PetscLogViewFromOptions();CHKERRQ(ierr);
11260298fd71SBarry Smith   ierr = PetscOptionsGetString(NULL,"-log_summary",mname,PETSC_MAX_PATH_LEN,&flg1);CHKERRQ(ierr);
1127e5c89e4eSSatish Balay   if (flg1) {
112891eabc43SBarry Smith     PetscViewer viewer;
112991eabc43SBarry Smith     if (mname[0]) {
113091eabc43SBarry Smith       ierr = PetscViewerASCIIOpen(PETSC_COMM_WORLD,mname,&viewer);CHKERRQ(ierr);
113191eabc43SBarry Smith       ierr = PetscLogView(viewer);CHKERRQ(ierr);
11326bf464f9SBarry Smith       ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr);
113333f85c2fSBarry Smith     } else {
113433f85c2fSBarry Smith       viewer = PETSC_VIEWER_STDOUT_WORLD;
113533f85c2fSBarry Smith       ierr   = PetscLogView(viewer);CHKERRQ(ierr);
113633f85c2fSBarry Smith     }
1137e5c89e4eSSatish Balay   }
1138e5c89e4eSSatish Balay   mname[0] = 0;
1139a297a907SKarl Rupp 
11400298fd71SBarry Smith   ierr = PetscOptionsGetString(NULL,"-log_all",mname,PETSC_MAX_PATH_LEN,&flg1);CHKERRQ(ierr);
11410298fd71SBarry Smith   ierr = PetscOptionsGetString(NULL,"-log",mname,PETSC_MAX_PATH_LEN,&flg2);CHKERRQ(ierr);
1142e5c89e4eSSatish Balay   if (flg1 || flg2) {
1143e5c89e4eSSatish Balay     if (mname[0]) PetscLogDump(mname);
1144e5c89e4eSSatish Balay     else          PetscLogDump(0);
1145e5c89e4eSSatish Balay   }
1146e5c89e4eSSatish Balay #endif
114710463e74SBarry Smith 
1148b58ca069SBarry Smith   /*
1149b58ca069SBarry Smith      Free all objects registered with PetscObjectRegisterDestroy() such as PETSC_VIEWER_XXX_().
1150b58ca069SBarry Smith   */
1151b58ca069SBarry Smith   ierr = PetscObjectRegisterDestroyAll();CHKERRQ(ierr);
1152b58ca069SBarry Smith 
115333f85c2fSBarry Smith   ierr = PetscStackDestroy();CHKERRQ(ierr);
115476386721SLisandro Dalcin   PetscThreadLocalDestroy((PetscThreadKey)petscstack); /* Deletes pthread_key */
115510463e74SBarry Smith 
115690d69ab7SBarry Smith   flg1 = PETSC_FALSE;
11570298fd71SBarry Smith   ierr = PetscOptionsGetBool(NULL,"-no_signal_handler",&flg1,NULL);CHKERRQ(ierr);
1158e5c89e4eSSatish Balay   if (!flg1) { ierr = PetscPopSignalHandler();CHKERRQ(ierr);}
115990d69ab7SBarry Smith   flg1 = PETSC_FALSE;
11600298fd71SBarry Smith   ierr = PetscOptionsGetBool(NULL,"-mpidump",&flg1,NULL);CHKERRQ(ierr);
1161e5c89e4eSSatish Balay   if (flg1) {
1162e5c89e4eSSatish Balay     ierr = PetscMPIDump(stdout);CHKERRQ(ierr);
1163e5c89e4eSSatish Balay   }
116490d69ab7SBarry Smith   flg1 = PETSC_FALSE;
116590d69ab7SBarry Smith   flg2 = PETSC_FALSE;
11668bb29257SSatish Balay   /* preemptive call to avoid listing this option in options table as unused */
11670298fd71SBarry Smith   ierr = PetscOptionsHasName(NULL,"-malloc_dump",&flg1);CHKERRQ(ierr);
11680298fd71SBarry Smith   ierr = PetscOptionsHasName(NULL,"-objects_dump",&flg1);CHKERRQ(ierr);
1169662a7babSBarry Smith   ierr = PetscOptionsGetBool(NULL,"-options_view",&flg2,NULL);CHKERRQ(ierr);
1170e4c476e2SSatish Balay 
1171e5c89e4eSSatish Balay   if (flg2) {
1172be56827dSJed Brown     PetscViewer viewer;
117302ba9f54SBarry Smith     ierr = PetscViewerCreate(PETSC_COMM_WORLD,&viewer);CHKERRQ(ierr);
117402ba9f54SBarry Smith     ierr = PetscViewerSetType(viewer,PETSCVIEWERASCII);CHKERRQ(ierr);
1175be56827dSJed Brown     ierr = PetscOptionsView(viewer);CHKERRQ(ierr);
1176be56827dSJed Brown     ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr);
1177e5c89e4eSSatish Balay   }
1178e5c89e4eSSatish Balay 
1179e5c89e4eSSatish Balay   /* to prevent PETSc -options_left from warning */
11800298fd71SBarry Smith   ierr = PetscOptionsHasName(NULL,"-nox",&flg1);CHKERRQ(ierr);
11810298fd71SBarry Smith   ierr = PetscOptionsHasName(NULL,"-nox_warning",&flg1);CHKERRQ(ierr);
1182e5c89e4eSSatish Balay 
118333fc4174SSatish Balay   flg3 = PETSC_FALSE; /* default value is required */
11840298fd71SBarry Smith   ierr = PetscOptionsGetBool(NULL,"-options_left",&flg3,&flg1);CHKERRQ(ierr);
1185e5c89e4eSSatish Balay   ierr = PetscOptionsAllUsed(&nopt);CHKERRQ(ierr);
1186e5c89e4eSSatish Balay   if (flg3) {
1187e5c89e4eSSatish Balay     if (!flg2) { /* have not yet printed the options */
1188be56827dSJed Brown       PetscViewer viewer;
118902ba9f54SBarry Smith       ierr = PetscViewerCreate(PETSC_COMM_WORLD,&viewer);CHKERRQ(ierr);
119002ba9f54SBarry Smith       ierr = PetscViewerSetType(viewer,PETSCVIEWERASCII);CHKERRQ(ierr);
1191be56827dSJed Brown       ierr = PetscOptionsView(viewer);CHKERRQ(ierr);
1192be56827dSJed Brown       ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr);
1193e5c89e4eSSatish Balay     }
1194e5c89e4eSSatish Balay     if (!nopt) {
1195e5c89e4eSSatish Balay       ierr = PetscPrintf(PETSC_COMM_WORLD,"There are no unused options.\n");CHKERRQ(ierr);
1196e5c89e4eSSatish Balay     } else if (nopt == 1) {
1197e5c89e4eSSatish Balay       ierr = PetscPrintf(PETSC_COMM_WORLD,"There is one unused database option. It is:\n");CHKERRQ(ierr);
1198e5c89e4eSSatish Balay     } else {
11997582186dSLisandro Dalcin       ierr = PetscPrintf(PETSC_COMM_WORLD,"There are %D unused database options. They are:\n",nopt);CHKERRQ(ierr);
1200e5c89e4eSSatish Balay     }
1201df12ba86SBarry Smith   }
1202e5c89e4eSSatish Balay #if defined(PETSC_USE_DEBUG)
1203da8b8a77SBarry Smith   if (nopt && !flg3 && !flg1) {
1204e5c89e4eSSatish Balay     ierr = PetscPrintf(PETSC_COMM_WORLD,"WARNING! There are options you set that were not used!\n");CHKERRQ(ierr);
1205e5c89e4eSSatish Balay     ierr = PetscPrintf(PETSC_COMM_WORLD,"WARNING! could be spelling mistake, etc!\n");CHKERRQ(ierr);
1206e5c89e4eSSatish Balay     ierr = PetscOptionsLeft();CHKERRQ(ierr);
1207e5c89e4eSSatish Balay   } else if (nopt && flg3) {
1208e5c89e4eSSatish Balay #else
1209e5c89e4eSSatish Balay   if (nopt && flg3) {
1210e5c89e4eSSatish Balay #endif
1211e5c89e4eSSatish Balay     ierr = PetscOptionsLeft();CHKERRQ(ierr);
1212e5c89e4eSSatish Balay   }
1213e5c89e4eSSatish Balay 
1214e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS)
1215d45a07a7SBarry Smith   if (!PetscGlobalRank) {
121687f587eeSBarry Smith     ierr = PetscStackSAWsViewOff();CHKERRQ(ierr);
121716ad0300SBarry Smith     PetscStackCallSAWs(SAWs_Finalize,());
1218d45a07a7SBarry Smith   }
1219ec957eceSBarry Smith #endif
1220ec957eceSBarry Smith 
1221eea2bdeeSJed Brown   {
1222eea2bdeeSJed Brown     PetscThreadComm tcomm_world;
1223eea2bdeeSJed Brown     ierr = PetscGetThreadCommWorld(&tcomm_world);CHKERRQ(ierr);
1224eea2bdeeSJed Brown     /* Free global thread communicator */
1225eea2bdeeSJed Brown     ierr = PetscThreadCommDestroy(&tcomm_world);CHKERRQ(ierr);
1226eea2bdeeSJed Brown   }
1227eea2bdeeSJed Brown 
12284097062eSBarry Smith #if defined(PETSC_USE_LOG)
122910463e74SBarry Smith   /*
1230dbc8283eSBarry Smith        List all objects the user may have forgot to free
12312eff7a51SBarry Smith   */
12320298fd71SBarry Smith   ierr = PetscOptionsHasName(NULL,"-objects_dump",&flg1);CHKERRQ(ierr);
1233a64a8e02SBarry Smith   if (flg1) {
1234a64a8e02SBarry Smith     MPI_Comm local_comm;
12357eb1d149SBarry Smith     char     string[64];
1236a64a8e02SBarry Smith 
12370298fd71SBarry Smith     ierr = PetscOptionsGetString(NULL,"-objects_dump",string,64,NULL);CHKERRQ(ierr);
1238a64a8e02SBarry Smith     ierr = MPI_Comm_dup(MPI_COMM_WORLD,&local_comm);CHKERRQ(ierr);
1239a64a8e02SBarry Smith     ierr = PetscSequentialPhaseBegin_Private(local_comm,1);CHKERRQ(ierr);
12407eb1d149SBarry Smith     ierr = PetscObjectsDump(stdout,(string[0] == 'a') ? PETSC_TRUE : PETSC_FALSE);CHKERRQ(ierr);
1241a64a8e02SBarry Smith     ierr = PetscSequentialPhaseEnd_Private(local_comm,1);CHKERRQ(ierr);
1242a64a8e02SBarry Smith     ierr = MPI_Comm_free(&local_comm);CHKERRQ(ierr);
12430a1571b3SBarry Smith   }
12444097062eSBarry Smith #endif
12454097062eSBarry Smith 
12464097062eSBarry Smith #if defined(PETSC_USE_LOG)
1247dbc8283eSBarry Smith   PetscObjectsCounts    = 0;
1248dbc8283eSBarry Smith   PetscObjectsMaxCounts = 0;
1249a297a907SKarl Rupp   ierr = PetscFree(PetscObjects);CHKERRQ(ierr);
12504097062eSBarry Smith #endif
12512eff7a51SBarry Smith 
125233f85c2fSBarry Smith #if defined(PETSC_USE_LOG)
125333f85c2fSBarry Smith   ierr = PetscLogDestroy();CHKERRQ(ierr);
125433f85c2fSBarry Smith #endif
125533f85c2fSBarry Smith 
125633f85c2fSBarry Smith   /*
125733f85c2fSBarry Smith      Destroy any packages that registered a finalize
125833f85c2fSBarry Smith   */
125933f85c2fSBarry Smith   ierr = PetscRegisterFinalizeAll();CHKERRQ(ierr);
126033f85c2fSBarry Smith 
126133f85c2fSBarry Smith   /*
126210463e74SBarry Smith      Destroy all the function registration lists created
126310463e74SBarry Smith   */
126410463e74SBarry Smith   ierr = PetscFinalize_DynamicLibraries();CHKERRQ(ierr);
126510463e74SBarry Smith 
126648dd1dffSBarry Smith   /*
126748dd1dffSBarry Smith      Print PetscFunctionLists that have not been properly freed
126848dd1dffSBarry Smith 
126937e93019SBarry Smith   ierr = PetscFunctionListPrintAll();CHKERRQ(ierr);
127048dd1dffSBarry Smith   */
127137e93019SBarry Smith 
12724028d114SSatish Balay   if (petsc_history) {
1273f3dea69dSBarry Smith     ierr = PetscCloseHistoryFile(&petsc_history);CHKERRQ(ierr);
1274e5c89e4eSSatish Balay     petsc_history = 0;
1275e5c89e4eSSatish Balay   }
1276e5c89e4eSSatish Balay 
12770298fd71SBarry Smith   ierr = PetscInfoAllow(PETSC_FALSE,NULL);CHKERRQ(ierr);
1278e5c89e4eSSatish Balay 
12798bb29257SSatish Balay   {
1280e5c89e4eSSatish Balay     char fname[PETSC_MAX_PATH_LEN];
1281e5c89e4eSSatish Balay     FILE *fd;
1282ed9cf6e9SBarry Smith     int  err;
1283e5c89e4eSSatish Balay 
1284e5c89e4eSSatish Balay     fname[0] = 0;
1285a297a907SKarl Rupp 
12860298fd71SBarry Smith     ierr = PetscOptionsGetString(NULL,"-malloc_dump",fname,250,&flg1);CHKERRQ(ierr);
1287dc92acbaSJed Brown     flg2 = PETSC_FALSE;
12880298fd71SBarry Smith     ierr = PetscOptionsGetBool(NULL,"-malloc_test",&flg2,NULL);CHKERRQ(ierr);
12898bf1f09cSShri Abhyankar #if defined(PETSC_USE_DEBUG)
1290dc92acbaSJed Brown     if (PETSC_RUNNING_ON_VALGRIND) flg2 = PETSC_FALSE;
1291dc92acbaSJed Brown #else
1292dc92acbaSJed Brown     flg2 = PETSC_FALSE;         /* Skip reporting for optimized builds regardless of -malloc_test */
1293dc92acbaSJed Brown #endif
1294e5c89e4eSSatish Balay     if (flg1 && fname[0]) {
1295e5c89e4eSSatish Balay       char sname[PETSC_MAX_PATH_LEN];
1296e5c89e4eSSatish Balay 
1297e5c89e4eSSatish Balay       sprintf(sname,"%s_%d",fname,rank);
1298e32f2f54SBarry Smith       fd   = fopen(sname,"w"); if (!fd) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_FILE_OPEN,"Cannot open log file: %s",sname);
1299e5c89e4eSSatish Balay       ierr = PetscMallocDump(fd);CHKERRQ(ierr);
1300ed9cf6e9SBarry Smith       err  = fclose(fd);
1301e32f2f54SBarry Smith       if (err) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SYS,"fclose() failed on file");
1302dc92acbaSJed Brown     } else if (flg1 || flg2) {
1303e5c89e4eSSatish Balay       MPI_Comm local_comm;
1304e5c89e4eSSatish Balay 
1305e5c89e4eSSatish Balay       ierr = MPI_Comm_dup(MPI_COMM_WORLD,&local_comm);CHKERRQ(ierr);
1306e5c89e4eSSatish Balay       ierr = PetscSequentialPhaseBegin_Private(local_comm,1);CHKERRQ(ierr);
1307e5c89e4eSSatish Balay       ierr = PetscMallocDump(stdout);CHKERRQ(ierr);
1308e5c89e4eSSatish Balay       ierr = PetscSequentialPhaseEnd_Private(local_comm,1);CHKERRQ(ierr);
1309e5c89e4eSSatish Balay       ierr = MPI_Comm_free(&local_comm);CHKERRQ(ierr);
1310e5c89e4eSSatish Balay     }
1311e5c89e4eSSatish Balay   }
1312a64a8e02SBarry Smith 
13138bb29257SSatish Balay   {
1314e5c89e4eSSatish Balay     char fname[PETSC_MAX_PATH_LEN];
13150298fd71SBarry Smith     FILE *fd = NULL;
1316e5c89e4eSSatish Balay 
1317e5c89e4eSSatish Balay     fname[0] = 0;
1318a297a907SKarl Rupp 
13190298fd71SBarry Smith     ierr = PetscOptionsGetString(NULL,"-malloc_log",fname,250,&flg1);CHKERRQ(ierr);
13200298fd71SBarry Smith     ierr = PetscOptionsHasName(NULL,"-malloc_log_threshold",&flg2);CHKERRQ(ierr);
1321e5c89e4eSSatish Balay     if (flg1 && fname[0]) {
1322ed9cf6e9SBarry Smith       int err;
1323e5c89e4eSSatish Balay 
1324574034a9SJed Brown       if (!rank) {
1325574034a9SJed Brown         fd = fopen(fname,"w");
1326574034a9SJed Brown         if (!fd) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_FILE_OPEN,"Cannot open log file: %s",fname);
1327574034a9SJed Brown       }
1328e5c89e4eSSatish Balay       ierr = PetscMallocDumpLog(fd);CHKERRQ(ierr);
1329574034a9SJed Brown       if (fd) {
1330ed9cf6e9SBarry Smith         err = fclose(fd);
1331e32f2f54SBarry Smith         if (err) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SYS,"fclose() failed on file");
1332574034a9SJed Brown       }
1333574034a9SJed Brown     } else if (flg1 || flg2) {
1334e5c89e4eSSatish Balay       ierr = PetscMallocDumpLog(stdout);CHKERRQ(ierr);
1335e5c89e4eSSatish Balay     }
1336e5c89e4eSSatish Balay   }
133720e2c332SMatthew G. Knepley 
133820e2c332SMatthew G. Knepley #if defined(PETSC_HAVE_CUDA)
133920e2c332SMatthew G. Knepley   flg  = PETSC_TRUE;
134020e2c332SMatthew G. Knepley   ierr = PetscOptionsGetBool(NULL,"-cublas",&flg,NULL);CHKERRQ(ierr);
134120e2c332SMatthew G. Knepley   if (flg) {
134220e2c332SMatthew G. Knepley     PetscInt p;
134320e2c332SMatthew G. Knepley     for (p = 0; p < PetscGlobalSize; ++p) {
134420e2c332SMatthew G. Knepley       if (p == PetscGlobalRank) cublasShutdown();
134520e2c332SMatthew G. Knepley       ierr = MPI_Barrier(PETSC_COMM_WORLD);CHKERRQ(ierr);
134620e2c332SMatthew G. Knepley     }
134720e2c332SMatthew G. Knepley   }
134820e2c332SMatthew G. Knepley #endif
134920e2c332SMatthew G. Knepley 
1350e5c89e4eSSatish Balay   /* Can be destroyed only after all the options are used */
1351e5c89e4eSSatish Balay   ierr = PetscOptionsDestroy();CHKERRQ(ierr);
1352e5c89e4eSSatish Balay 
1353e5c89e4eSSatish Balay   PetscGlobalArgc = 0;
1354e5c89e4eSSatish Balay   PetscGlobalArgs = 0;
1355e5c89e4eSSatish Balay 
1356ce63c4c1SBarry Smith #if defined(PETSC_USE_REAL___FLOAT128)
1357c90a1750SBarry Smith   ierr = MPI_Type_free(&MPIU___FLOAT128);CHKERRQ(ierr);
13587c2de775SJed Brown #if defined(PETSC_HAVE_COMPLEX)
13598c764dc5SJose Roman   ierr = MPI_Type_free(&MPIU___COMPLEX128);CHKERRQ(ierr);
13608c764dc5SJose Roman #endif
1361d9822059SBarry Smith   ierr = MPI_Op_free(&MPIU_MAX);CHKERRQ(ierr);
1362d9822059SBarry Smith   ierr = MPI_Op_free(&MPIU_MIN);CHKERRQ(ierr);
1363c90a1750SBarry Smith #endif
1364c90a1750SBarry Smith 
13657c2de775SJed Brown #if defined(PETSC_HAVE_COMPLEX)
13662c876bd9SBarry Smith #if !defined(PETSC_HAVE_MPI_C_DOUBLE_COMPLEX)
1367500d8756SSatish Balay   ierr = MPI_Type_free(&MPIU_C_DOUBLE_COMPLEX);CHKERRQ(ierr);
1368500d8756SSatish Balay   ierr = MPI_Type_free(&MPIU_C_COMPLEX);CHKERRQ(ierr);
13692c876bd9SBarry Smith #endif
1370e5c89e4eSSatish Balay #endif
1371cca4cb22SSatish Balay 
13727c2de775SJed Brown #if (defined(PETSC_HAVE_COMPLEX) && !defined(PETSC_HAVE_MPI_C_DOUBLE_COMPLEX)) || defined(PETSC_USE_REAL___FLOAT128)
1373cca4cb22SSatish Balay   ierr = MPI_Op_free(&MPIU_SUM);CHKERRQ(ierr);
1374cca4cb22SSatish Balay #endif
1375cca4cb22SSatish Balay 
1376e5c89e4eSSatish Balay   ierr = MPI_Type_free(&MPIU_2SCALAR);CHKERRQ(ierr);
137744041f26SJed Brown #if defined(PETSC_USE_64BIT_INDICES) || !defined(MPI_2INT)
1378e5c89e4eSSatish Balay   ierr = MPI_Type_free(&MPIU_2INT);CHKERRQ(ierr);
137944041f26SJed Brown #endif
1380e5c89e4eSSatish Balay   ierr = MPI_Op_free(&PetscMaxSum_Op);CHKERRQ(ierr);
1381e5c89e4eSSatish Balay   ierr = MPI_Op_free(&PetscADMax_Op);CHKERRQ(ierr);
1382e5c89e4eSSatish Balay   ierr = MPI_Op_free(&PetscADMin_Op);CHKERRQ(ierr);
1383e5c89e4eSSatish Balay 
1384dbc8283eSBarry Smith   /*
1385efb80d3cSBarry Smith      Destroy any known inner MPI_Comm's and attributes pointing to them
1386efb80d3cSBarry Smith      Note this will not destroy any new communicators the user has created.
1387efb80d3cSBarry Smith 
1388efb80d3cSBarry Smith      If all PETSc objects were not destroyed those left over objects will have hanging references to
1389efb80d3cSBarry Smith      the MPI_Comms that were freed; but that is ok because those PETSc objects will never be used again
1390dbc8283eSBarry Smith  */
1391b770b1f6SSatish Balay   {
1392dbc8283eSBarry Smith     PetscCommCounter *counter;
1393dbc8283eSBarry Smith     PetscMPIInt      flg;
1394dbc8283eSBarry Smith     MPI_Comm         icomm;
1395265f3f35SJed Brown     union {MPI_Comm comm; void *ptr;} ucomm;
1396265f3f35SJed Brown     ierr = MPI_Attr_get(PETSC_COMM_SELF,Petsc_InnerComm_keyval,&ucomm,&flg);CHKERRQ(ierr);
1397dbc8283eSBarry Smith     if (flg) {
1398265f3f35SJed Brown       icomm = ucomm.comm;
1399dbc8283eSBarry Smith       ierr = MPI_Attr_get(icomm,Petsc_Counter_keyval,&counter,&flg);CHKERRQ(ierr);
1400dbc8283eSBarry 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");
1401dbc8283eSBarry Smith 
1402dbc8283eSBarry Smith       ierr = MPI_Attr_delete(PETSC_COMM_SELF,Petsc_InnerComm_keyval);CHKERRQ(ierr);
1403efb80d3cSBarry Smith       ierr = MPI_Attr_delete(icomm,Petsc_Counter_keyval);CHKERRQ(ierr);
1404efb80d3cSBarry Smith       ierr = MPI_Comm_free(&icomm);CHKERRQ(ierr);
1405dbc8283eSBarry Smith     }
1406265f3f35SJed Brown     ierr = MPI_Attr_get(PETSC_COMM_WORLD,Petsc_InnerComm_keyval,&ucomm,&flg);CHKERRQ(ierr);
1407dbc8283eSBarry Smith     if (flg) {
1408265f3f35SJed Brown       icomm = ucomm.comm;
1409dbc8283eSBarry Smith       ierr = MPI_Attr_get(icomm,Petsc_Counter_keyval,&counter,&flg);CHKERRQ(ierr);
1410dbc8283eSBarry 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");
1411dbc8283eSBarry Smith 
1412dbc8283eSBarry Smith       ierr = MPI_Attr_delete(PETSC_COMM_WORLD,Petsc_InnerComm_keyval);CHKERRQ(ierr);
1413efb80d3cSBarry Smith       ierr = MPI_Attr_delete(icomm,Petsc_Counter_keyval);CHKERRQ(ierr);
1414efb80d3cSBarry Smith       ierr = MPI_Comm_free(&icomm);CHKERRQ(ierr);
1415dbc8283eSBarry Smith     }
1416b770b1f6SSatish Balay   }
1417dbc8283eSBarry Smith 
1418480cf27aSJed Brown   ierr = MPI_Keyval_free(&Petsc_Counter_keyval);CHKERRQ(ierr);
1419480cf27aSJed Brown   ierr = MPI_Keyval_free(&Petsc_InnerComm_keyval);CHKERRQ(ierr);
1420480cf27aSJed Brown   ierr = MPI_Keyval_free(&Petsc_OuterComm_keyval);CHKERRQ(ierr);
1421480cf27aSJed Brown 
1422e5c89e4eSSatish Balay   if (PetscBeganMPI) {
142399608316SBarry Smith #if defined(PETSC_HAVE_MPI_FINALIZED)
142499b1327fSBarry Smith     PetscMPIInt flag;
142599b1327fSBarry Smith     ierr = MPI_Finalized(&flag);CHKERRQ(ierr);
1426e32f2f54SBarry Smith     if (flag) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_LIB,"MPI_Finalize() has already been called, even though MPI_Init() was called by PetscInitialize()");
142799608316SBarry Smith #endif
1428e5c89e4eSSatish Balay     ierr = MPI_Finalize();CHKERRQ(ierr);
1429e5c89e4eSSatish Balay   }
1430e5c89e4eSSatish Balay /*
1431e5c89e4eSSatish Balay 
1432e5c89e4eSSatish Balay      Note: In certain cases PETSC_COMM_WORLD is never MPI_Comm_free()ed because
1433e5c89e4eSSatish Balay    the communicator has some outstanding requests on it. Specifically if the
1434e5c89e4eSSatish Balay    flag PETSC_HAVE_BROKEN_REQUEST_FREE is set (for IBM MPI implementation). See
1435e5c89e4eSSatish Balay    src/vec/utils/vpscat.c. Due to this the memory allocated in PetscCommDuplicate()
1436e5c89e4eSSatish Balay    is never freed as it should be. Thus one may obtain messages of the form
14370e5e90baSSatish Balay    [ 1] 8 bytes PetscCommDuplicate() line 645 in src/sys/mpiu.c indicating the
1438e5c89e4eSSatish Balay    memory was not freed.
1439e5c89e4eSSatish Balay 
1440e5c89e4eSSatish Balay */
14411d1a0024SBarry Smith   ierr = PetscMallocClear();CHKERRQ(ierr);
1442a297a907SKarl Rupp 
1443e5c89e4eSSatish Balay   PetscInitializeCalled = PETSC_FALSE;
1444e5c89e4eSSatish Balay   PetscFinalizeCalled   = PETSC_TRUE;
1445e5c89e4eSSatish Balay   PetscFunctionReturn(ierr);
1446e5c89e4eSSatish Balay }
1447e5c89e4eSSatish Balay 
144843db4dbbSBarry Smith #if defined(PETSC_MISSING_LAPACK_lsame_)
14498cc058d9SJed Brown PETSC_EXTERN int lsame_(char *a,char *b)
145043db4dbbSBarry Smith {
145143db4dbbSBarry Smith   if (*a == *b) return 1;
145243db4dbbSBarry Smith   if (*a + 32 == *b) return 1;
145343db4dbbSBarry Smith   if (*a - 32 == *b) return 1;
145443db4dbbSBarry Smith   return 0;
145543db4dbbSBarry Smith }
1456a70650f6SBarry Smith #endif
145743db4dbbSBarry Smith 
145843db4dbbSBarry Smith #if defined(PETSC_MISSING_LAPACK_lsame)
14598cc058d9SJed Brown PETSC_EXTERN int lsame(char *a,char *b)
146043db4dbbSBarry Smith {
146143db4dbbSBarry Smith   if (*a == *b) return 1;
146243db4dbbSBarry Smith   if (*a + 32 == *b) return 1;
146343db4dbbSBarry Smith   if (*a - 32 == *b) return 1;
146443db4dbbSBarry Smith   return 0;
146543db4dbbSBarry Smith }
146643db4dbbSBarry Smith #endif
1467