xref: /petsc/src/sys/objects/pinit.c (revision e78c4b8c781aea498565c18608f67c0793ea250b)
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 
56e5c89e4eSSatish Balay /*
57e5c89e4eSSatish Balay        Checks the options database for initializations related to the
58e5c89e4eSSatish Balay     PETSc components
59e5c89e4eSSatish Balay */
60e5c89e4eSSatish Balay #undef __FUNCT__
61e5c89e4eSSatish Balay #define __FUNCT__ "PetscOptionsCheckInitial_Components"
627087cfbeSBarry Smith PetscErrorCode  PetscOptionsCheckInitial_Components(void)
63e5c89e4eSSatish Balay {
64ace3abfcSBarry Smith   PetscBool      flg1;
65e5c89e4eSSatish Balay   PetscErrorCode ierr;
66e5c89e4eSSatish Balay 
67e5c89e4eSSatish Balay   PetscFunctionBegin;
680298fd71SBarry Smith   ierr = PetscOptionsHasName(NULL,"-help",&flg1);CHKERRQ(ierr);
69e5c89e4eSSatish Balay   if (flg1) {
70e5c89e4eSSatish Balay #if defined(PETSC_USE_LOG)
71e8e7597cSSatish Balay     MPI_Comm comm = PETSC_COMM_WORLD;
72e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm,"------Additional PETSc component options--------\n");CHKERRQ(ierr);
73e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm," -log_summary_exclude: <vec,mat,pc.ksp,snes>\n");CHKERRQ(ierr);
746cf91177SBarry Smith     ierr = (*PetscHelpPrintf)(comm," -info_exclude: <null,vec,mat,pc,ksp,snes,ts>\n");CHKERRQ(ierr);
75e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm,"-----------------------------------------------\n");CHKERRQ(ierr);
76e5c89e4eSSatish Balay #endif
77e5c89e4eSSatish Balay   }
78e5c89e4eSSatish Balay   PetscFunctionReturn(0);
79e5c89e4eSSatish Balay }
80e5c89e4eSSatish Balay 
81e5c89e4eSSatish Balay #undef __FUNCT__
82945d1669SBarry Smith #define __FUNCT__ "PetscInitializeNoPointers"
830f11a792SBarry Smith /*
84945d1669SBarry Smith       PetscInitializeNoPointers - Calls PetscInitialize() from C/C++ without the pointers to argc and args
8572a42c3cSBarry Smith 
8672a42c3cSBarry Smith    Collective
8772a42c3cSBarry Smith 
8872a42c3cSBarry Smith    Level: advanced
8972a42c3cSBarry Smith 
90945d1669SBarry Smith     Notes: this is called only by the PETSc MATLAB and Julia interface. Even though it might start MPI it sets the flag to
910f11a792SBarry Smith      indicate that it did NOT start MPI so that the PetscFinalize() does not end MPI, thus allowing PetscInitialize() to
92945d1669SBarry Smith      be called multiple times from MATLAB and Julia without the problem of trying to initialize MPI more than once.
930f11a792SBarry Smith 
941ea5a559SBarry Smith      Turns off PETSc signal handling because that can interact with MATLAB's signal handling causing random crashes.
951ea5a559SBarry Smith 
9672a42c3cSBarry Smith .seealso: PetscInitialize(), PetscInitializeFortran(), PetscInitializeNoArguments()
970f11a792SBarry Smith */
98945d1669SBarry Smith PetscErrorCode  PetscInitializeNoPointers(int argc,char **args,const char *filename,const char *help)
9972a42c3cSBarry Smith {
10072a42c3cSBarry Smith   PetscErrorCode ierr;
10172a42c3cSBarry Smith   int            myargc   = argc;
10272a42c3cSBarry Smith   char           **myargs = args;
10372a42c3cSBarry Smith 
10472a42c3cSBarry Smith   PetscFunctionBegin;
1053bf036e2SBarry Smith   ierr = PetscInitialize(&myargc,&myargs,filename,help);CHKERRQ(ierr);
1061ea5a559SBarry Smith   ierr = PetscPopSignalHandler();CHKERRQ(ierr);
107df413903SBarry Smith   PetscBeganMPI = PETSC_FALSE;
10872a42c3cSBarry Smith   PetscFunctionReturn(ierr);
10972a42c3cSBarry Smith }
11072a42c3cSBarry Smith 
11172a42c3cSBarry Smith #undef __FUNCT__
112945d1669SBarry Smith #define __FUNCT__ "PetscGetPETSC_COMM_SELF"
113f0865b08SBarry Smith /*
114945d1669SBarry Smith       Used by MATLAB and Julia interface to get communicator
115f0865b08SBarry Smith */
116945d1669SBarry Smith PetscErrorCode  PetscGetPETSC_COMM_SELF(MPI_Comm *comm)
117f0865b08SBarry Smith {
118f0865b08SBarry Smith   PetscFunctionBegin;
119f0865b08SBarry Smith   *comm = PETSC_COMM_SELF;
120f0865b08SBarry Smith   PetscFunctionReturn(0);
121f0865b08SBarry Smith }
122f0865b08SBarry Smith 
123f0865b08SBarry Smith #undef __FUNCT__
124e5c89e4eSSatish Balay #define __FUNCT__ "PetscInitializeNoArguments"
125e5c89e4eSSatish Balay /*@C
126e5c89e4eSSatish Balay       PetscInitializeNoArguments - Calls PetscInitialize() from C/C++ without
127e5c89e4eSSatish Balay         the command line arguments.
128e5c89e4eSSatish Balay 
129e5c89e4eSSatish Balay    Collective
130e5c89e4eSSatish Balay 
131e5c89e4eSSatish Balay    Level: advanced
132e5c89e4eSSatish Balay 
133e5c89e4eSSatish Balay .seealso: PetscInitialize(), PetscInitializeFortran()
134e5c89e4eSSatish Balay @*/
1357087cfbeSBarry Smith PetscErrorCode  PetscInitializeNoArguments(void)
136e5c89e4eSSatish Balay {
137e5c89e4eSSatish Balay   PetscErrorCode ierr;
138e5c89e4eSSatish Balay   int            argc   = 0;
139e5c89e4eSSatish Balay   char           **args = 0;
140e5c89e4eSSatish Balay 
141e5c89e4eSSatish Balay   PetscFunctionBegin;
1420298fd71SBarry Smith   ierr = PetscInitialize(&argc,&args,NULL,NULL);
143e5c89e4eSSatish Balay   PetscFunctionReturn(ierr);
144e5c89e4eSSatish Balay }
145e5c89e4eSSatish Balay 
146e5c89e4eSSatish Balay #undef __FUNCT__
147e5c89e4eSSatish Balay #define __FUNCT__ "PetscInitialized"
148e5c89e4eSSatish Balay /*@
149e5c89e4eSSatish Balay       PetscInitialized - Determine whether PETSc is initialized.
150e5c89e4eSSatish Balay 
15193b6d2d1SJed Brown    Level: beginner
152e5c89e4eSSatish Balay 
153e5c89e4eSSatish Balay .seealso: PetscInitialize(), PetscInitializeNoArguments(), PetscInitializeFortran()
154e5c89e4eSSatish Balay @*/
1557087cfbeSBarry Smith PetscErrorCode PetscInitialized(PetscBool  *isInitialized)
156e5c89e4eSSatish Balay {
157e5c89e4eSSatish Balay   *isInitialized = PetscInitializeCalled;
15893b6d2d1SJed Brown   return 0;
159e5c89e4eSSatish Balay }
160e5c89e4eSSatish Balay 
161e5c89e4eSSatish Balay #undef __FUNCT__
162e5c89e4eSSatish Balay #define __FUNCT__ "PetscFinalized"
163e5c89e4eSSatish Balay /*@
164e5c89e4eSSatish Balay       PetscFinalized - Determine whether PetscFinalize() has been called yet
165e5c89e4eSSatish Balay 
166e5c89e4eSSatish Balay    Level: developer
167e5c89e4eSSatish Balay 
168e5c89e4eSSatish Balay .seealso: PetscInitialize(), PetscInitializeNoArguments(), PetscInitializeFortran()
169e5c89e4eSSatish Balay @*/
1707087cfbeSBarry Smith PetscErrorCode  PetscFinalized(PetscBool  *isFinalized)
171e5c89e4eSSatish Balay {
172e5c89e4eSSatish Balay   *isFinalized = PetscFinalizeCalled;
17393b6d2d1SJed Brown   return 0;
174e5c89e4eSSatish Balay }
175e5c89e4eSSatish Balay 
17609573ac7SBarry Smith extern PetscErrorCode PetscOptionsCheckInitial_Private(void);
177e5c89e4eSSatish Balay 
178e5c89e4eSSatish Balay /*
179e5c89e4eSSatish Balay        This function is the MPI reduction operation used to compute the sum of the
180e5c89e4eSSatish Balay    first half of the datatype and the max of the second half.
181e5c89e4eSSatish Balay */
182e5c89e4eSSatish Balay MPI_Op PetscMaxSum_Op = 0;
183e5c89e4eSSatish Balay 
184e5c89e4eSSatish Balay #undef __FUNCT__
185e5c89e4eSSatish Balay #define __FUNCT__ "PetscMaxSum_Local"
1868cc058d9SJed Brown PETSC_EXTERN void MPIAPI PetscMaxSum_Local(void *in,void *out,int *cnt,MPI_Datatype *datatype)
187e5c89e4eSSatish Balay {
188e5c89e4eSSatish Balay   PetscInt *xin = (PetscInt*)in,*xout = (PetscInt*)out,i,count = *cnt;
189e5c89e4eSSatish Balay 
190e5c89e4eSSatish Balay   PetscFunctionBegin;
191e5c89e4eSSatish Balay   if (*datatype != MPIU_2INT) {
192e5c89e4eSSatish Balay     (*PetscErrorPrintf)("Can only handle MPIU_2INT data types");
193e5c89e4eSSatish Balay     MPI_Abort(MPI_COMM_WORLD,1);
194e5c89e4eSSatish Balay   }
195e5c89e4eSSatish Balay 
196e5c89e4eSSatish Balay   for (i=0; i<count; i++) {
197e5c89e4eSSatish Balay     xout[2*i]    = PetscMax(xout[2*i],xin[2*i]);
198e5c89e4eSSatish Balay     xout[2*i+1] += xin[2*i+1];
199e5c89e4eSSatish Balay   }
200812af9f3SBarry Smith   PetscFunctionReturnVoid();
201e5c89e4eSSatish Balay }
202e5c89e4eSSatish Balay 
203e5c89e4eSSatish Balay /*
204e5c89e4eSSatish Balay     Returns the max of the first entry owned by this processor and the
205e5c89e4eSSatish Balay sum of the second entry.
206b693b147SBarry Smith 
207b693b147SBarry Smith     The reason nprocs[2*i] contains lengths nprocs[2*i+1] contains flag of 1 if length is nonzero
208b693b147SBarry Smith is so that the PetscMaxSum_Op() can set TWO values, if we passed in only nprocs[i] with lengths
209b693b147SBarry Smith there would be no place to store the both needed results.
210e5c89e4eSSatish Balay */
211e5c89e4eSSatish Balay #undef __FUNCT__
212e5c89e4eSSatish Balay #define __FUNCT__ "PetscMaxSum"
2137087cfbeSBarry Smith PetscErrorCode  PetscMaxSum(MPI_Comm comm,const PetscInt nprocs[],PetscInt *max,PetscInt *sum)
214e5c89e4eSSatish Balay {
215e5c89e4eSSatish Balay   PetscMPIInt    size,rank;
2166ac3741eSJed Brown   struct {PetscInt max,sum;} *work;
217e5c89e4eSSatish Balay   PetscErrorCode ierr;
218e5c89e4eSSatish Balay 
219e5c89e4eSSatish Balay   PetscFunctionBegin;
220e5c89e4eSSatish Balay   ierr = MPI_Comm_size(comm,&size);CHKERRQ(ierr);
221e5c89e4eSSatish Balay   ierr = MPI_Comm_rank(comm,&rank);CHKERRQ(ierr);
2226ac3741eSJed Brown   ierr = PetscMalloc(size*sizeof(*work),&work);CHKERRQ(ierr);
223e5c89e4eSSatish Balay   ierr = MPI_Allreduce((void*)nprocs,work,size,MPIU_2INT,PetscMaxSum_Op,comm);CHKERRQ(ierr);
2246ac3741eSJed Brown   *max = work[rank].max;
2256ac3741eSJed Brown   *sum = work[rank].sum;
226e5c89e4eSSatish Balay   ierr = PetscFree(work);CHKERRQ(ierr);
227e5c89e4eSSatish Balay   PetscFunctionReturn(0);
228e5c89e4eSSatish Balay }
229e5c89e4eSSatish Balay 
230e5c89e4eSSatish Balay /* ----------------------------------------------------------------------------*/
2317087cfbeSBarry Smith MPI_Op  PetscADMax_Op = 0;
232e5c89e4eSSatish Balay 
233e5c89e4eSSatish Balay #undef __FUNCT__
234e5c89e4eSSatish Balay #define __FUNCT__ "PetscADMax_Local"
2358cc058d9SJed Brown PETSC_EXTERN void MPIAPI PetscADMax_Local(void *in,void *out,PetscMPIInt *cnt,MPI_Datatype *datatype)
236e5c89e4eSSatish Balay {
237e5c89e4eSSatish Balay   PetscScalar *xin = (PetscScalar*)in,*xout = (PetscScalar*)out;
238e5c89e4eSSatish Balay   PetscInt    i,count = *cnt;
239e5c89e4eSSatish Balay 
240e5c89e4eSSatish Balay   PetscFunctionBegin;
241e5c89e4eSSatish Balay   if (*datatype != MPIU_2SCALAR) {
242e5c89e4eSSatish Balay     (*PetscErrorPrintf)("Can only handle MPIU_2SCALAR data (i.e. double or complex) types");
243e5c89e4eSSatish Balay     MPI_Abort(MPI_COMM_WORLD,1);
244e5c89e4eSSatish Balay   }
245e5c89e4eSSatish Balay 
246e5c89e4eSSatish Balay   for (i=0; i<count; i++) {
247e5c89e4eSSatish Balay     if (PetscRealPart(xout[2*i]) < PetscRealPart(xin[2*i])) {
248e5c89e4eSSatish Balay       xout[2*i]   = xin[2*i];
249e5c89e4eSSatish Balay       xout[2*i+1] = xin[2*i+1];
250e5c89e4eSSatish Balay     }
251e5c89e4eSSatish Balay   }
252812af9f3SBarry Smith   PetscFunctionReturnVoid();
253e5c89e4eSSatish Balay }
254e5c89e4eSSatish Balay 
2557087cfbeSBarry Smith MPI_Op PetscADMin_Op = 0;
256e5c89e4eSSatish Balay 
257e5c89e4eSSatish Balay #undef __FUNCT__
258e5c89e4eSSatish Balay #define __FUNCT__ "PetscADMin_Local"
2598cc058d9SJed Brown PETSC_EXTERN void MPIAPI PetscADMin_Local(void *in,void *out,PetscMPIInt *cnt,MPI_Datatype *datatype)
260e5c89e4eSSatish Balay {
261e5c89e4eSSatish Balay   PetscScalar *xin = (PetscScalar*)in,*xout = (PetscScalar*)out;
262e5c89e4eSSatish Balay   PetscInt    i,count = *cnt;
263e5c89e4eSSatish Balay 
264e5c89e4eSSatish Balay   PetscFunctionBegin;
265e5c89e4eSSatish Balay   if (*datatype != MPIU_2SCALAR) {
266e5c89e4eSSatish Balay     (*PetscErrorPrintf)("Can only handle MPIU_2SCALAR data (i.e. double or complex) types");
267e5c89e4eSSatish Balay     MPI_Abort(MPI_COMM_WORLD,1);
268e5c89e4eSSatish Balay   }
269e5c89e4eSSatish Balay 
270e5c89e4eSSatish Balay   for (i=0; i<count; i++) {
271e5c89e4eSSatish Balay     if (PetscRealPart(xout[2*i]) > PetscRealPart(xin[2*i])) {
272e5c89e4eSSatish Balay       xout[2*i]   = xin[2*i];
273e5c89e4eSSatish Balay       xout[2*i+1] = xin[2*i+1];
274e5c89e4eSSatish Balay     }
275e5c89e4eSSatish Balay   }
276812af9f3SBarry Smith   PetscFunctionReturnVoid();
277e5c89e4eSSatish Balay }
278e5c89e4eSSatish Balay /* ---------------------------------------------------------------------------------------*/
279e5c89e4eSSatish Balay 
2807c2de775SJed Brown #if (defined(PETSC_HAVE_COMPLEX) && !defined(PETSC_HAVE_MPI_C_DOUBLE_COMPLEX)) || defined(PETSC_USE_REAL___FLOAT128)
28106a205a8SBarry Smith MPI_Op MPIU_SUM = 0;
282e5c89e4eSSatish Balay 
283e5c89e4eSSatish Balay #undef __FUNCT__
284e5c89e4eSSatish Balay #define __FUNCT__ "PetscSum_Local"
2858cc058d9SJed Brown PETSC_EXTERN void PetscSum_Local(void *in,void *out,PetscMPIInt *cnt,MPI_Datatype *datatype)
286e5c89e4eSSatish Balay {
287e5c89e4eSSatish Balay   PetscInt i,count = *cnt;
288e5c89e4eSSatish Balay 
289e5c89e4eSSatish Balay   PetscFunctionBegin;
2907c2de775SJed Brown   if (*datatype == MPIU_REAL) {
291e2e03761SBarry Smith     PetscReal *xin = (PetscReal*)in,*xout = (PetscReal*)out;
292a297a907SKarl Rupp     for (i=0; i<count; i++) xout[i] += xin[i];
2937c2de775SJed Brown   }
2947c2de775SJed Brown #if defined(PETSC_HAVE_COMPLEX)
2957c2de775SJed Brown   else if (*datatype == MPIU_COMPLEX) {
2967c2de775SJed Brown     PetscComplex *xin = (PetscComplex*)in,*xout = (PetscComplex*)out;
297a297a907SKarl Rupp     for (i=0; i<count; i++) xout[i] += xin[i];
2987c2de775SJed Brown   }
2997c2de775SJed Brown #endif
3007c2de775SJed Brown   else {
3017c2de775SJed Brown     (*PetscErrorPrintf)("Can only handle MPIU_REAL or MPIU_COMPLEX data types");
302e2e03761SBarry Smith     MPI_Abort(MPI_COMM_WORLD,1);
303e2e03761SBarry Smith   }
304812af9f3SBarry Smith   PetscFunctionReturnVoid();
305e5c89e4eSSatish Balay }
306e5c89e4eSSatish Balay #endif
307e5c89e4eSSatish Balay 
308ce63c4c1SBarry Smith #if defined(PETSC_USE_REAL___FLOAT128)
309d9822059SBarry Smith MPI_Op MPIU_MAX = 0;
310d9822059SBarry Smith MPI_Op MPIU_MIN = 0;
311d9822059SBarry Smith 
312d9822059SBarry Smith #undef __FUNCT__
313d9822059SBarry Smith #define __FUNCT__ "PetscMax_Local"
3148cc058d9SJed Brown PETSC_EXTERN void PetscMax_Local(void *in,void *out,PetscMPIInt *cnt,MPI_Datatype *datatype)
315d9822059SBarry Smith {
316d9822059SBarry Smith   PetscInt i,count = *cnt;
317d9822059SBarry Smith 
318d9822059SBarry Smith   PetscFunctionBegin;
3197c2de775SJed Brown   if (*datatype == MPIU_REAL) {
3208c764dc5SJose Roman     PetscReal *xin = (PetscReal*)in,*xout = (PetscReal*)out;
321a297a907SKarl Rupp     for (i=0; i<count; i++) xout[i] = PetscMax(xout[i],xin[i]);
3227c2de775SJed Brown   }
3237c2de775SJed Brown #if defined(PETSC_HAVE_COMPLEX)
3247c2de775SJed Brown   else if (*datatype == MPIU_COMPLEX) {
3257c2de775SJed Brown     PetscComplex *xin = (PetscComplex*)in,*xout = (PetscComplex*)out;
3267c2de775SJed Brown     for (i=0; i<count; i++) {
3277c2de775SJed Brown       xout[i] = PetscRealPartComplex(xout[i])<PetscRealPartComplex(xin[i]) ? xin[i] : xout[i];
3287c2de775SJed Brown     }
3297c2de775SJed Brown   }
3307c2de775SJed Brown #endif
3317c2de775SJed Brown   else {
3327c2de775SJed Brown     (*PetscErrorPrintf)("Can only handle MPIU_REAL or MPIU_COMPLEX data types");
3338c764dc5SJose Roman     MPI_Abort(MPI_COMM_WORLD,1);
3348c764dc5SJose Roman   }
335d9822059SBarry Smith   PetscFunctionReturnVoid();
336d9822059SBarry Smith }
337d9822059SBarry Smith 
338d9822059SBarry Smith #undef __FUNCT__
339d9822059SBarry Smith #define __FUNCT__ "PetscMin_Local"
3408cc058d9SJed Brown PETSC_EXTERN void PetscMin_Local(void *in,void *out,PetscMPIInt *cnt,MPI_Datatype *datatype)
341d9822059SBarry Smith {
342d9822059SBarry Smith   PetscInt    i,count = *cnt;
343d9822059SBarry Smith 
344d9822059SBarry Smith   PetscFunctionBegin;
3457c2de775SJed Brown   if (*datatype == MPIU_REAL) {
3468c764dc5SJose Roman     PetscReal *xin = (PetscReal*)in,*xout = (PetscReal*)out;
347a297a907SKarl Rupp     for (i=0; i<count; i++) xout[i] = PetscMin(xout[i],xin[i]);
3487c2de775SJed Brown   }
3497c2de775SJed Brown #if defined(PETSC_HAVE_COMPLEX)
3507c2de775SJed Brown   else if (*datatype == MPIU_COMPLEX) {
3517c2de775SJed Brown     PetscComplex *xin = (PetscComplex*)in,*xout = (PetscComplex*)out;
3527c2de775SJed Brown     for (i=0; i<count; i++) {
3537c2de775SJed Brown       xout[i] = PetscRealPartComplex(xout[i])>PetscRealPartComplex(xin[i]) ? xin[i] : xout[i];
3547c2de775SJed Brown     }
3557c2de775SJed Brown   }
3567c2de775SJed Brown #endif
3577c2de775SJed Brown   else {
3588c764dc5SJose Roman     (*PetscErrorPrintf)("Can only handle MPIU_REAL or MPIU_SCALAR data (i.e. double or complex) types");
3598c764dc5SJose Roman     MPI_Abort(MPI_COMM_WORLD,1);
3608c764dc5SJose Roman   }
361d9822059SBarry Smith   PetscFunctionReturnVoid();
362d9822059SBarry Smith }
363d9822059SBarry Smith #endif
364d9822059SBarry Smith 
365480cf27aSJed Brown #undef __FUNCT__
366480cf27aSJed Brown #define __FUNCT__ "Petsc_DelCounter"
367480cf27aSJed Brown /*
368480cf27aSJed Brown    Private routine to delete internal tag/name counter storage when a communicator is freed.
369480cf27aSJed Brown 
370ff0e51ddSBarry 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.
371480cf27aSJed Brown 
372480cf27aSJed Brown    Note: this is declared extern "C" because it is passed to MPI_Keyval_create()
373480cf27aSJed Brown 
374480cf27aSJed Brown */
3758cc058d9SJed Brown PETSC_EXTERN PetscMPIInt MPIAPI Petsc_DelCounter(MPI_Comm comm,PetscMPIInt keyval,void *count_val,void *extra_state)
376480cf27aSJed Brown {
377480cf27aSJed Brown   PetscErrorCode ierr;
378480cf27aSJed Brown 
379480cf27aSJed Brown   PetscFunctionBegin;
380480cf27aSJed Brown   ierr = PetscInfo1(0,"Deleting counter data in an MPI_Comm %ld\n",(long)comm);if (ierr) PetscFunctionReturn((PetscMPIInt)ierr);
381480cf27aSJed Brown   ierr = PetscFree(count_val);if (ierr) PetscFunctionReturn((PetscMPIInt)ierr);
382480cf27aSJed Brown   PetscFunctionReturn(MPI_SUCCESS);
383480cf27aSJed Brown }
384480cf27aSJed Brown 
385480cf27aSJed Brown #undef __FUNCT__
386da3039f7SJed Brown #define __FUNCT__ "Petsc_DelComm_Outer"
387480cf27aSJed Brown /*
388da3039f7SJed Brown   This is invoked on the outer comm as a result of either PetscCommDestroy() (via MPI_Attr_delete) or when the user
389da3039f7SJed Brown   calls MPI_Comm_free().
390da3039f7SJed Brown 
391da3039f7SJed Brown   This is the only entry point for breaking the links between inner and outer comms.
392480cf27aSJed Brown 
393ff0e51ddSBarry Smith   This is called by MPI, not by users. This is called when MPI_Comm_free() is called on the communicator.
394480cf27aSJed Brown 
395480cf27aSJed Brown   Note: this is declared extern "C" because it is passed to MPI_Keyval_create()
396480cf27aSJed Brown 
397480cf27aSJed Brown */
398da3039f7SJed Brown PETSC_EXTERN PetscMPIInt MPIAPI Petsc_DelComm_Outer(MPI_Comm comm,PetscMPIInt keyval,void *attr_val,void *extra_state)
399480cf27aSJed Brown {
400480cf27aSJed Brown   PetscErrorCode ierr;
401b89831e5SBarry Smith   PetscMPIInt    flg;
402265f3f35SJed Brown   union {MPI_Comm comm; void *ptr;} icomm,ocomm;
403480cf27aSJed Brown 
404480cf27aSJed Brown   PetscFunctionBegin;
405da3039f7SJed Brown   if (keyval != Petsc_InnerComm_keyval) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_CORRUPT,"Unexpected keyval");
406ec4fadc2SJed Brown   icomm.ptr = attr_val;
407da3039f7SJed Brown 
408265f3f35SJed Brown   ierr = MPI_Attr_get(icomm.comm,Petsc_OuterComm_keyval,&ocomm,&flg);CHKERRQ(ierr);
409b3ef52cdSBarry Smith   if (!flg) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_CORRUPT,"Inner MPI_Comm does not have expected reference to outer comm");
410da3039f7SJed Brown   if (ocomm.comm != comm) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_CORRUPT,"Inner MPI_Comm has reference to non-matching outer comm");
411da3039f7SJed Brown   ierr = MPI_Attr_delete(icomm.comm,Petsc_OuterComm_keyval);CHKERRQ(ierr); /* Calls Petsc_DelComm_Inner */
412da3039f7SJed 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);
413da3039f7SJed Brown   PetscFunctionReturn(MPI_SUCCESS);
414b89831e5SBarry Smith }
415da3039f7SJed Brown 
416da3039f7SJed Brown #undef __FUNCT__
417da3039f7SJed Brown #define __FUNCT__ "Petsc_DelComm_Inner"
418da3039f7SJed Brown /*
419da3039f7SJed Brown  * This is invoked on the inner comm when Petsc_DelComm_Outer calls MPI_Attr_delete.  It should not be reached any other way.
420da3039f7SJed Brown  */
421da3039f7SJed Brown PETSC_EXTERN PetscMPIInt MPIAPI Petsc_DelComm_Inner(MPI_Comm comm,PetscMPIInt keyval,void *attr_val,void *extra_state)
422da3039f7SJed Brown {
423da3039f7SJed Brown   PetscErrorCode ierr;
424da3039f7SJed Brown 
425da3039f7SJed Brown   PetscFunctionBegin;
426da3039f7SJed Brown   ierr = PetscInfo1(0,"Removing reference to PETSc communicator embedded in a user MPI_Comm %ld\n",(long)comm);if (ierr) PetscFunctionReturn((PetscMPIInt)ierr);
427480cf27aSJed Brown   PetscFunctionReturn(MPI_SUCCESS);
428480cf27aSJed Brown }
429480cf27aSJed Brown 
430951e3c8eSBarry Smith #if defined(PETSC_USE_PETSC_MPI_EXTERNAL32)
431e39fd77fSBarry Smith #if !defined(PETSC_WORDS_BIGENDIAN)
4328cc058d9SJed Brown PETSC_EXTERN PetscMPIInt PetscDataRep_extent_fn(MPI_Datatype,MPI_Aint*,void*);
4338cc058d9SJed Brown PETSC_EXTERN PetscMPIInt PetscDataRep_read_conv_fn(void*, MPI_Datatype,PetscMPIInt,void*,MPI_Offset,void*);
4348cc058d9SJed Brown PETSC_EXTERN PetscMPIInt PetscDataRep_write_conv_fn(void*, MPI_Datatype,PetscMPIInt,void*,MPI_Offset,void*);
435e39fd77fSBarry Smith #endif
436951e3c8eSBarry Smith #endif
437e39fd77fSBarry Smith 
4386ae9a8a6SBarry Smith int  PetscGlobalArgc   = 0;
4396ae9a8a6SBarry Smith char **PetscGlobalArgs = 0;
440dff31646SBarry Smith PetscSegBuffer PetscCitationsList;
441e5c89e4eSSatish Balay 
442e5c89e4eSSatish Balay #undef __FUNCT__
443051e4cf2SJed Brown #define __FUNCT__ "PetscCitationsInitialize"
444051e4cf2SJed Brown PetscErrorCode PetscCitationsInitialize()
445051e4cf2SJed Brown {
446051e4cf2SJed Brown   PetscErrorCode ierr;
447051e4cf2SJed Brown 
448051e4cf2SJed Brown   PetscFunctionBegin;
449051e4cf2SJed Brown   ierr = PetscSegBufferCreate(1,10000,&PetscCitationsList);CHKERRQ(ierr);
450051e4cf2SJed 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);
451051e4cf2SJed 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);
452051e4cf2SJed Brown   PetscFunctionReturn(0);
453051e4cf2SJed Brown }
454e5c89e4eSSatish Balay 
455e5c89e4eSSatish Balay #undef __FUNCT__
456e5c89e4eSSatish Balay #define __FUNCT__ "PetscGetArgs"
457e5c89e4eSSatish Balay /*@C
458e5c89e4eSSatish Balay    PetscGetArgs - Allows you to access the raw command line arguments anywhere
459e5c89e4eSSatish Balay      after PetscInitialize() is called but before PetscFinalize().
460e5c89e4eSSatish Balay 
461e5c89e4eSSatish Balay    Not Collective
462e5c89e4eSSatish Balay 
463e5c89e4eSSatish Balay    Output Parameters:
464e5c89e4eSSatish Balay +  argc - count of number of command line arguments
465e5c89e4eSSatish Balay -  args - the command line arguments
466e5c89e4eSSatish Balay 
467e5c89e4eSSatish Balay    Level: intermediate
468e5c89e4eSSatish Balay 
469e5c89e4eSSatish Balay    Notes:
470e5c89e4eSSatish Balay       This is usually used to pass the command line arguments into other libraries
471e5c89e4eSSatish Balay    that are called internally deep in PETSc or the application.
472e5c89e4eSSatish Balay 
473f177e3b1SBarry Smith       The first argument contains the program name as is normal for C arguments.
474f177e3b1SBarry Smith 
475e5c89e4eSSatish Balay    Concepts: command line arguments
476e5c89e4eSSatish Balay 
477793721a6SBarry Smith .seealso: PetscFinalize(), PetscInitializeFortran(), PetscGetArguments()
478e5c89e4eSSatish Balay 
479e5c89e4eSSatish Balay @*/
4807087cfbeSBarry Smith PetscErrorCode  PetscGetArgs(int *argc,char ***args)
481e5c89e4eSSatish Balay {
482e5c89e4eSSatish Balay   PetscFunctionBegin;
48317186662SBarry Smith   if (!PetscInitializeCalled && PetscFinalizeCalled) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ORDER,"You must call after PetscInitialize() but before PetscFinalize()");
484e5c89e4eSSatish Balay   *argc = PetscGlobalArgc;
485e5c89e4eSSatish Balay   *args = PetscGlobalArgs;
486e5c89e4eSSatish Balay   PetscFunctionReturn(0);
487e5c89e4eSSatish Balay }
488e5c89e4eSSatish Balay 
489e5c89e4eSSatish Balay #undef __FUNCT__
490793721a6SBarry Smith #define __FUNCT__ "PetscGetArguments"
491793721a6SBarry Smith /*@C
492793721a6SBarry Smith    PetscGetArguments - Allows you to access the  command line arguments anywhere
493793721a6SBarry Smith      after PetscInitialize() is called but before PetscFinalize().
494793721a6SBarry Smith 
495793721a6SBarry Smith    Not Collective
496793721a6SBarry Smith 
497793721a6SBarry Smith    Output Parameters:
498793721a6SBarry Smith .  args - the command line arguments
499793721a6SBarry Smith 
500793721a6SBarry Smith    Level: intermediate
501793721a6SBarry Smith 
502793721a6SBarry Smith    Notes:
503793721a6SBarry Smith       This does NOT start with the program name and IS null terminated (final arg is void)
504793721a6SBarry Smith 
505793721a6SBarry Smith    Concepts: command line arguments
506793721a6SBarry Smith 
507793721a6SBarry Smith .seealso: PetscFinalize(), PetscInitializeFortran(), PetscGetArgs(), PetscFreeArguments()
508793721a6SBarry Smith 
509793721a6SBarry Smith @*/
5107087cfbeSBarry Smith PetscErrorCode  PetscGetArguments(char ***args)
511793721a6SBarry Smith {
512793721a6SBarry Smith   PetscInt       i,argc = PetscGlobalArgc;
513793721a6SBarry Smith   PetscErrorCode ierr;
514793721a6SBarry Smith 
515793721a6SBarry Smith   PetscFunctionBegin;
51617186662SBarry Smith   if (!PetscInitializeCalled && PetscFinalizeCalled) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ORDER,"You must call after PetscInitialize() but before PetscFinalize()");
517717030eeSLisandro Dalcin   if (!argc) {*args = 0; PetscFunctionReturn(0);}
518793721a6SBarry Smith   ierr = PetscMalloc(argc*sizeof(char*),args);CHKERRQ(ierr);
519793721a6SBarry Smith   for (i=0; i<argc-1; i++) {
520793721a6SBarry Smith     ierr = PetscStrallocpy(PetscGlobalArgs[i+1],&(*args)[i]);CHKERRQ(ierr);
521793721a6SBarry Smith   }
522793721a6SBarry Smith   (*args)[argc-1] = 0;
523793721a6SBarry Smith   PetscFunctionReturn(0);
524793721a6SBarry Smith }
525793721a6SBarry Smith 
526793721a6SBarry Smith #undef __FUNCT__
527793721a6SBarry Smith #define __FUNCT__ "PetscFreeArguments"
528793721a6SBarry Smith /*@C
529793721a6SBarry Smith    PetscFreeArguments - Frees the memory obtained with PetscGetArguments()
530793721a6SBarry Smith 
531793721a6SBarry Smith    Not Collective
532793721a6SBarry Smith 
533793721a6SBarry Smith    Output Parameters:
534793721a6SBarry Smith .  args - the command line arguments
535793721a6SBarry Smith 
536793721a6SBarry Smith    Level: intermediate
537793721a6SBarry Smith 
538793721a6SBarry Smith    Concepts: command line arguments
539793721a6SBarry Smith 
540793721a6SBarry Smith .seealso: PetscFinalize(), PetscInitializeFortran(), PetscGetArgs(), PetscGetArguments()
541793721a6SBarry Smith 
542793721a6SBarry Smith @*/
5437087cfbeSBarry Smith PetscErrorCode  PetscFreeArguments(char **args)
544793721a6SBarry Smith {
545793721a6SBarry Smith   PetscInt       i = 0;
546793721a6SBarry Smith   PetscErrorCode ierr;
547793721a6SBarry Smith 
548793721a6SBarry Smith   PetscFunctionBegin;
549a297a907SKarl Rupp   if (!args) PetscFunctionReturn(0);
550793721a6SBarry Smith   while (args[i]) {
551793721a6SBarry Smith     ierr = PetscFree(args[i]);CHKERRQ(ierr);
552793721a6SBarry Smith     i++;
553793721a6SBarry Smith   }
554793721a6SBarry Smith   ierr = PetscFree(args);CHKERRQ(ierr);
555793721a6SBarry Smith   PetscFunctionReturn(0);
556793721a6SBarry Smith }
557793721a6SBarry Smith 
558793721a6SBarry Smith #undef __FUNCT__
559e5c89e4eSSatish Balay #define __FUNCT__ "PetscInitialize"
560e5c89e4eSSatish Balay /*@C
561e5c89e4eSSatish Balay    PetscInitialize - Initializes the PETSc database and MPI.
562e5c89e4eSSatish Balay    PetscInitialize() calls MPI_Init() if that has yet to be called,
563e5c89e4eSSatish Balay    so this routine should always be called near the beginning of
564e5c89e4eSSatish Balay    your program -- usually the very first line!
565e5c89e4eSSatish Balay 
566e5c89e4eSSatish Balay    Collective on MPI_COMM_WORLD or PETSC_COMM_WORLD if it has been set
567e5c89e4eSSatish Balay 
568e5c89e4eSSatish Balay    Input Parameters:
569e5c89e4eSSatish Balay +  argc - count of number of command line arguments
570e5c89e4eSSatish Balay .  args - the command line arguments
5710298fd71SBarry Smith .  file - [optional] PETSc database file, also checks ~username/.petscrc and .petscrc use NULL to not check for
572fc2bca9aSBarry Smith           code specific file. Use -skip_petscrc in the code specific file to skip the .petscrc files
5730298fd71SBarry Smith -  help - [optional] Help message to print, use NULL for no message
574e5c89e4eSSatish Balay 
57505827820SBarry Smith    If you wish PETSc code to run ONLY on a subcommunicator of MPI_COMM_WORLD, create that
57605827820SBarry Smith    communicator first and assign it to PETSC_COMM_WORLD BEFORE calling PetscInitialize(). Thus if you are running a
57705827820SBarry Smith    four process job and two processes will run PETSc and have PetscInitialize() and PetscFinalize() and two process will not,
57805827820SBarry Smith    then do this. If ALL processes in the job are using PetscInitialize() and PetscFinalize() then you don't need to do this, even
57905827820SBarry Smith    if different subcommunicators of the job are doing different things with PETSc.
580e5c89e4eSSatish Balay 
581e5c89e4eSSatish Balay    Options Database Keys:
582e5c89e4eSSatish Balay +  -start_in_debugger [noxterm,dbx,xdb,gdb,...] - Starts program in debugger
583e5c89e4eSSatish Balay .  -on_error_attach_debugger [noxterm,dbx,xdb,gdb,...] - Starts debugger when error detected
584e5c89e4eSSatish Balay .  -on_error_emacs <machinename> causes emacsclient to jump to error file
585b52f573bSBarry Smith .  -on_error_abort calls abort() when error detected (no traceback)
586e8fb0fc0SBarry Smith .  -on_error_mpiabort calls MPI_abort() when error detected
587e8fb0fc0SBarry Smith .  -error_output_stderr prints error messages to stderr instead of the default stdout
588e8fb0fc0SBarry Smith .  -error_output_none does not print the error messages (but handles errors in the same way as if this was not called)
589e5c89e4eSSatish Balay .  -debugger_nodes [node1,node2,...] - Indicates nodes to start in debugger
590e5c89e4eSSatish Balay .  -debugger_pause [sleeptime] (in seconds) - Pauses debugger
591e5c89e4eSSatish Balay .  -stop_for_debugger - Print message on how to attach debugger manually to
592e5c89e4eSSatish Balay                         process and wait (-debugger_pause) seconds for attachment
5932fb0ec9aSBarry Smith .  -malloc - Indicates use of PETSc error-checking malloc (on by default for debug version of libraries)
594e5c89e4eSSatish Balay .  -malloc no - Indicates not to use error-checking malloc
5952fb0ec9aSBarry Smith .  -malloc_debug - check for memory corruption at EVERY malloc or free
596aee23540SBarry Smith .  -malloc_dump - prints a list of all unfreed memory at the end of the run
597dc92acbaSJed Brown .  -malloc_test - like -malloc_dump -malloc_debug, but only active for debugging builds
598e5c89e4eSSatish Balay .  -fp_trap - Stops on floating point exceptions (Note that on the
599e5c89e4eSSatish Balay               IBM RS6000 this slows code by at least a factor of 10.)
600e5c89e4eSSatish Balay .  -no_signal_handler - Indicates not to trap error signals
601e5c89e4eSSatish Balay .  -shared_tmp - indicates /tmp directory is shared by all processors
602e5c89e4eSSatish Balay .  -not_shared_tmp - each processor has own /tmp
603e5c89e4eSSatish Balay .  -tmp - alternative name of /tmp directory
604e5c89e4eSSatish Balay .  -get_total_flops - returns total flops done by all processors
60540ab9619SBarry Smith .  -memory_info - Print memory usage at end of run
60640ab9619SBarry Smith -  -server <port> - start PETSc webserver (default port is 8080)
607e5c89e4eSSatish Balay 
608e5c89e4eSSatish Balay    Options Database Keys for Profiling:
6090598bfebSBarry Smith    See the <a href="../../docs/manual.pdf#nameddest=ch_profiling">profiling chapter of the users manual</a> for details.
610495fc317SBarry Smith +  -info <optional filename> - Prints verbose information to the screen
611495fc317SBarry Smith .  -info_exclude <null,vec,mat,pc,ksp,snes,ts> - Excludes some of the verbose messages
612495fc317SBarry Smith .  -log_sync - Log the synchronization in scatters, inner products and norms
613495fc317SBarry Smith .  -log_trace [filename] - Print traces of all PETSc calls to the screen (useful to determine where a program
614e5c89e4eSSatish Balay         hangs without running in the debugger).  See PetscLogTraceBegin().
615495fc317SBarry Smith .  -log_summary [filename] - Prints summary of flop and timing information to screen. If the filename is specified the
616495fc317SBarry Smith         summary is written to the file.  See PetscLogView().
617495fc317SBarry Smith .  -log_summary_python [filename] - Prints data on of flop and timing usage to a file or screen. See PetscLogPrintSViewPython().
618495fc317SBarry Smith .  -log_all [filename] - Logs extensive profiling information  See PetscLogDump().
619495fc317SBarry Smith .  -log [filename] - Logs basic profiline information  See PetscLogDump().
620495fc317SBarry Smith -  -log_mpe [filename] - Creates a logfile viewable by the utility Jumpshot (in MPICH distribution)
621495fc317SBarry Smith 
622495fc317SBarry Smith     Only one of -log_trace, -log_summary, -log_all, -log, or -log_mpe may be used at a time
623e5c89e4eSSatish Balay 
624e5c89e4eSSatish Balay    Environmental Variables:
625e5c89e4eSSatish Balay +   PETSC_TMP - alternative tmp directory
626e5c89e4eSSatish Balay .   PETSC_SHARED_TMP - tmp is shared by all processes
627e5c89e4eSSatish Balay .   PETSC_NOT_SHARED_TMP - each process has its own private tmp
628e5c89e4eSSatish Balay .   PETSC_VIEWER_SOCKET_PORT - socket number to use for socket viewer
629e5c89e4eSSatish Balay -   PETSC_VIEWER_SOCKET_MACHINE - machine to use for socket viewer to connect to
630e5c89e4eSSatish Balay 
631e5c89e4eSSatish Balay 
632e5c89e4eSSatish Balay    Level: beginner
633e5c89e4eSSatish Balay 
634e5c89e4eSSatish Balay    Notes:
635e5c89e4eSSatish Balay    If for some reason you must call MPI_Init() separately, call
636e5c89e4eSSatish Balay    it before PetscInitialize().
637e5c89e4eSSatish Balay 
638e5c89e4eSSatish Balay    Fortran Version:
639e5c89e4eSSatish Balay    In Fortran this routine has the format
640e5c89e4eSSatish Balay $       call PetscInitialize(file,ierr)
641e5c89e4eSSatish Balay 
642e5c89e4eSSatish Balay +   ierr - error return code
6430298fd71SBarry Smith -  file - [optional] PETSc database file, also checks ~username/.petscrc and .petscrc use NULL_CHARACTER to not check for
644fc2bca9aSBarry Smith           code specific file. Use -skip_petscrc in the code specific file to skip the .petscrc files
645e5c89e4eSSatish Balay 
646e5c89e4eSSatish Balay    Important Fortran Note:
6470298fd71SBarry Smith    In Fortran, you MUST use NULL_CHARACTER to indicate a
6480298fd71SBarry Smith    null character string; you CANNOT just use NULL as
6490598bfebSBarry Smith    in the C version. See the <a href="../../docs/manual.pdf">users manual</a> for details.
650e5c89e4eSSatish Balay 
65101cb0274SBarry Smith    If your main program is C but you call Fortran code that also uses PETSc you need to call PetscInitializeFortran() soon after
65201cb0274SBarry Smith    calling PetscInitialize().
653e5c89e4eSSatish Balay 
654e5c89e4eSSatish Balay    Concepts: initializing PETSc
655e5c89e4eSSatish Balay 
65601cb0274SBarry Smith .seealso: PetscFinalize(), PetscInitializeFortran(), PetscGetArgs(), PetscInitializeNoArguments()
657e5c89e4eSSatish Balay 
658e5c89e4eSSatish Balay @*/
6597087cfbeSBarry Smith PetscErrorCode  PetscInitialize(int *argc,char ***args,const char file[],const char help[])
660e5c89e4eSSatish Balay {
661e5c89e4eSSatish Balay   PetscErrorCode ierr;
6624bb5149bSJed Brown   PetscMPIInt    flag, size;
663aa5bb8c0SSatish Balay   PetscInt       nodesize;
664ace3abfcSBarry Smith   PetscBool      flg;
665e5c89e4eSSatish Balay   char           hostname[256];
666e5c89e4eSSatish Balay 
667e5c89e4eSSatish Balay   PetscFunctionBegin;
668e5c89e4eSSatish Balay   if (PetscInitializeCalled) PetscFunctionReturn(0);
669e5c89e4eSSatish Balay 
670ae9b4142SLisandro Dalcin   /* these must be initialized in a routine, not as a constant declaration*/
671d89683f4Sbcordonn   PETSC_STDOUT = stdout;
672ae9b4142SLisandro Dalcin   PETSC_STDERR = stderr;
673e5c89e4eSSatish Balay 
674e5c89e4eSSatish Balay   ierr = PetscOptionsCreate();CHKERRQ(ierr);
675e5c89e4eSSatish Balay 
676e5c89e4eSSatish Balay   /*
677e5c89e4eSSatish Balay      We initialize the program name here (before MPI_Init()) because MPICH has a bug in
678e5c89e4eSSatish Balay      it that it sets args[0] on all processors to be args[0] on the first processor.
679e5c89e4eSSatish Balay   */
680e5c89e4eSSatish Balay   if (argc && *argc) {
681e5c89e4eSSatish Balay     ierr = PetscSetProgramName(**args);CHKERRQ(ierr);
682e5c89e4eSSatish Balay   } else {
683e5c89e4eSSatish Balay     ierr = PetscSetProgramName("Unknown Name");CHKERRQ(ierr);
684e5c89e4eSSatish Balay   }
685e5c89e4eSSatish Balay 
686e5c89e4eSSatish Balay   ierr = MPI_Initialized(&flag);CHKERRQ(ierr);
687e5c89e4eSSatish Balay   if (!flag) {
688e32f2f54SBarry 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");
6895e765c61SJed Brown #if defined(PETSC_HAVE_MPI_INIT_THREAD)
6905e765c61SJed Brown     {
6915e765c61SJed Brown       PetscMPIInt provided;
6925e765c61SJed Brown       ierr = MPI_Init_thread(argc,args,MPI_THREAD_FUNNELED,&provided);CHKERRQ(ierr);
6935e765c61SJed Brown     }
6945e765c61SJed Brown #else
695e5c89e4eSSatish Balay     ierr = MPI_Init(argc,args);CHKERRQ(ierr);
6965e765c61SJed Brown #endif
697e5c89e4eSSatish Balay     PetscBeganMPI = PETSC_TRUE;
698e5c89e4eSSatish Balay   }
699e5c89e4eSSatish Balay   if (argc && args) {
700e5c89e4eSSatish Balay     PetscGlobalArgc = *argc;
701e5c89e4eSSatish Balay     PetscGlobalArgs = *args;
702e5c89e4eSSatish Balay   }
703e5c89e4eSSatish Balay   PetscFinalizeCalled = PETSC_FALSE;
704e5c89e4eSSatish Balay 
705a297a907SKarl Rupp   if (PETSC_COMM_WORLD == MPI_COMM_NULL) PETSC_COMM_WORLD = MPI_COMM_WORLD;
706d54338ecSKarl Rupp   ierr = MPI_Comm_set_errhandler(PETSC_COMM_WORLD,MPI_ERRORS_RETURN);CHKERRQ(ierr);
707e5c89e4eSSatish Balay 
708e5c89e4eSSatish Balay   /* Done after init due to a bug in MPICH-GM? */
709e5c89e4eSSatish Balay   ierr = PetscErrorPrintfInitialize();CHKERRQ(ierr);
710e5c89e4eSSatish Balay 
711e5c89e4eSSatish Balay   ierr = MPI_Comm_rank(MPI_COMM_WORLD,&PetscGlobalRank);CHKERRQ(ierr);
712e5c89e4eSSatish Balay   ierr = MPI_Comm_size(MPI_COMM_WORLD,&PetscGlobalSize);CHKERRQ(ierr);
713e5c89e4eSSatish Balay 
7148ad47952SJed Brown   MPIU_BOOL = MPI_INT;
7158ad47952SJed Brown   MPIU_ENUM = MPI_INT;
7168ad47952SJed Brown 
717e5c89e4eSSatish Balay   /*
718e5c89e4eSSatish Balay      Initialized the global complex variable; this is because with
719e5c89e4eSSatish Balay      shared libraries the constructors for global variables
720e5c89e4eSSatish Balay      are not called; at least on IRIX.
721e5c89e4eSSatish Balay   */
722886cfec0SSatish Balay #if defined(PETSC_HAVE_COMPLEX)
723e5c89e4eSSatish Balay   {
724a24ee22aSSatish Balay #if defined(PETSC_CLANGUAGE_CXX)
72550f81f78SJed Brown     PetscComplex ic(0.0,1.0);
726e5c89e4eSSatish Balay     PETSC_i = ic;
727a24ee22aSSatish Balay #elif defined(PETSC_CLANGUAGE_C)
72850f81f78SJed Brown     PETSC_i = _Complex_I;
729b7940d39SSatish Balay #endif
730762437b8SSatish Balay   }
731762437b8SSatish Balay 
7322c876bd9SBarry Smith #if !defined(PETSC_HAVE_MPI_C_DOUBLE_COMPLEX)
733e69cd0e6SSatish Balay   ierr = MPI_Type_contiguous(2,MPI_DOUBLE,&MPIU_C_DOUBLE_COMPLEX);CHKERRQ(ierr);
734500d8756SSatish Balay   ierr = MPI_Type_commit(&MPIU_C_DOUBLE_COMPLEX);CHKERRQ(ierr);
735500d8756SSatish Balay   ierr = MPI_Type_contiguous(2,MPI_FLOAT,&MPIU_C_COMPLEX);CHKERRQ(ierr);
736500d8756SSatish Balay   ierr = MPI_Type_commit(&MPIU_C_COMPLEX);CHKERRQ(ierr);
7372c876bd9SBarry Smith #endif
738886cfec0SSatish Balay #endif /* PETSC_HAVE_COMPLEX */
739e5c89e4eSSatish Balay 
740e5c89e4eSSatish Balay   /*
741e5c89e4eSSatish Balay      Create the PETSc MPI reduction operator that sums of the first
742e5c89e4eSSatish Balay      half of the entries and maxes the second half.
743e5c89e4eSSatish Balay   */
744e5c89e4eSSatish Balay   ierr = MPI_Op_create(PetscMaxSum_Local,1,&PetscMaxSum_Op);CHKERRQ(ierr);
745e5c89e4eSSatish Balay 
746ce63c4c1SBarry Smith #if defined(PETSC_USE_REAL___FLOAT128)
747c90a1750SBarry Smith   ierr = MPI_Type_contiguous(2,MPI_DOUBLE,&MPIU___FLOAT128);CHKERRQ(ierr);
748c90a1750SBarry Smith   ierr = MPI_Type_commit(&MPIU___FLOAT128);CHKERRQ(ierr);
7497c2de775SJed Brown #if defined(PETSC_HAVE_COMPLEX)
7508c764dc5SJose Roman   ierr = MPI_Type_contiguous(4,MPI_DOUBLE,&MPIU___COMPLEX128);CHKERRQ(ierr);
7518c764dc5SJose Roman   ierr = MPI_Type_commit(&MPIU___COMPLEX128);CHKERRQ(ierr);
7528c764dc5SJose Roman #endif
753d9822059SBarry Smith   ierr = MPI_Op_create(PetscMax_Local,1,&MPIU_MAX);CHKERRQ(ierr);
754d9822059SBarry Smith   ierr = MPI_Op_create(PetscMin_Local,1,&MPIU_MIN);CHKERRQ(ierr);
755c90a1750SBarry Smith #endif
756c90a1750SBarry Smith 
7577c2de775SJed Brown #if (defined(PETSC_HAVE_COMPLEX) && !defined(PETSC_HAVE_MPI_C_DOUBLE_COMPLEX)) || defined(PETSC_USE_REAL___FLOAT128)
758cca4cb22SSatish Balay   ierr = MPI_Op_create(PetscSum_Local,1,&MPIU_SUM);CHKERRQ(ierr);
759cca4cb22SSatish Balay #endif
760cca4cb22SSatish Balay 
761e5c89e4eSSatish Balay   ierr = MPI_Type_contiguous(2,MPIU_SCALAR,&MPIU_2SCALAR);CHKERRQ(ierr);
762e5c89e4eSSatish Balay   ierr = MPI_Type_commit(&MPIU_2SCALAR);CHKERRQ(ierr);
763e5c89e4eSSatish Balay   ierr = MPI_Op_create(PetscADMax_Local,1,&PetscADMax_Op);CHKERRQ(ierr);
764e5c89e4eSSatish Balay   ierr = MPI_Op_create(PetscADMin_Local,1,&PetscADMin_Op);CHKERRQ(ierr);
765e5c89e4eSSatish Balay 
76644041f26SJed Brown #if defined(PETSC_USE_64BIT_INDICES) || !defined(MPI_2INT)
767e5c89e4eSSatish Balay   ierr = MPI_Type_contiguous(2,MPIU_INT,&MPIU_2INT);CHKERRQ(ierr);
768e5c89e4eSSatish Balay   ierr = MPI_Type_commit(&MPIU_2INT);CHKERRQ(ierr);
76944041f26SJed Brown #endif
770e5c89e4eSSatish Balay 
771ec957eceSBarry Smith 
772e5c89e4eSSatish Balay   /*
773480cf27aSJed Brown      Attributes to be set on PETSc communicators
774480cf27aSJed Brown   */
775480cf27aSJed Brown   ierr = MPI_Keyval_create(MPI_NULL_COPY_FN,Petsc_DelCounter,&Petsc_Counter_keyval,(void*)0);CHKERRQ(ierr);
776da3039f7SJed Brown   ierr = MPI_Keyval_create(MPI_NULL_COPY_FN,Petsc_DelComm_Outer,&Petsc_InnerComm_keyval,(void*)0);CHKERRQ(ierr);
777da3039f7SJed Brown   ierr = MPI_Keyval_create(MPI_NULL_COPY_FN,Petsc_DelComm_Inner,&Petsc_OuterComm_keyval,(void*)0);CHKERRQ(ierr);
778480cf27aSJed Brown 
779480cf27aSJed Brown   /*
780e8fb0fc0SBarry Smith      Build the options database
781e5c89e4eSSatish Balay   */
782e5c89e4eSSatish Balay   ierr = PetscOptionsInsert(argc,args,file);CHKERRQ(ierr);
783e5c89e4eSSatish Balay 
7846dc8fec2Sbcordonn 
785e5c89e4eSSatish Balay   /*
786e5c89e4eSSatish Balay      Print main application help message
787e5c89e4eSSatish Balay   */
7880298fd71SBarry Smith   ierr = PetscOptionsHasName(NULL,"-help",&flg);CHKERRQ(ierr);
789e5c89e4eSSatish Balay   if (help && flg) {
790e5c89e4eSSatish Balay     ierr = PetscPrintf(PETSC_COMM_WORLD,help);CHKERRQ(ierr);
791e5c89e4eSSatish Balay   }
792e5c89e4eSSatish Balay   ierr = PetscOptionsCheckInitial_Private();CHKERRQ(ierr);
793e5c89e4eSSatish Balay 
794d45a07a7SBarry Smith   ierr = PetscCitationsInitialize();CHKERRQ(ierr);
795d45a07a7SBarry Smith 
796e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS)
797d45a07a7SBarry Smith   if (!PetscGlobalRank) {
798*e78c4b8cSBarry Smith     char        cert[PETSC_MAX_PATH_LEN],root[PETSC_MAX_PATH_LEN],*intro,programname[64],*appline;
79998eb11daSBarry Smith     int         port;
800bd53e248SBarry Smith     PetscBool   rootlocal = PETSC_FALSE,flg2;
801*e78c4b8cSBarry Smith     size_t      applinelen,introlen;
80298eb11daSBarry Smith 
80371244e97SBarry Smith     ierr = PetscOptionsHasName(NULL,"-saws_log",&flg);CHKERRQ(ierr);
80471244e97SBarry Smith     if (flg) {
80571244e97SBarry Smith       char  sawslog[PETSC_MAX_PATH_LEN];
80671244e97SBarry Smith 
80771244e97SBarry Smith       ierr = PetscOptionsGetString(NULL,"-saws_log",sawslog,PETSC_MAX_PATH_LEN,NULL);CHKERRQ(ierr);
80871244e97SBarry Smith       if (sawslog[0]) {
80916ad0300SBarry Smith         PetscStackCallSAWs(SAWs_Set_Use_Logfile,(sawslog));
81071244e97SBarry Smith       } else {
81116ad0300SBarry Smith         PetscStackCallSAWs(SAWs_Set_Use_Logfile,(NULL));
81271244e97SBarry Smith       }
81371244e97SBarry Smith     }
81498eb11daSBarry Smith     ierr = PetscOptionsGetString(NULL,"-saws_https",cert,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr);
81598eb11daSBarry Smith     if (flg) {
81616ad0300SBarry Smith       PetscStackCallSAWs(SAWs_Set_Use_HTTPS,(cert));
81798eb11daSBarry Smith     }
81898eb11daSBarry Smith     ierr = PetscOptionsGetInt(NULL,"-saws_port",&port,&flg);CHKERRQ(ierr);
81998eb11daSBarry Smith     if (flg) {
82016ad0300SBarry Smith       PetscStackCallSAWs(SAWs_Set_Port,(port));
82198eb11daSBarry Smith     }
822a6790183SBarry Smith     ierr = PetscOptionsGetString(NULL,"-saws_root",root,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr);
823a6790183SBarry Smith     if (flg) {
82416ad0300SBarry Smith       PetscStackCallSAWs(SAWs_Set_Document_Root,(root));CHKERRQ(ierr);
825d36c5c1aSBarry Smith       ierr = PetscStrcmp(root,".",&rootlocal);CHKERRQ(ierr);
826a6790183SBarry Smith     }
827bd53e248SBarry Smith     ierr = PetscOptionsHasName(NULL,"-saws_local",&flg2);CHKERRQ(ierr);
828bd53e248SBarry Smith     if (flg2) {
829bd53e248SBarry Smith       char jsdir[PETSC_MAX_PATH_LEN];
830bd53e248SBarry Smith       if (!flg) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SUP,"-saws_local option requires -saws_root option");
831bd53e248SBarry Smith       ierr = PetscSNPrintf(jsdir,PETSC_MAX_PATH_LEN,"%s/js",root);CHKERRQ(ierr);
832bd53e248SBarry Smith       ierr = PetscTestDirectory(jsdir,'r',&flg);CHKERRQ(ierr);
833bd53e248SBarry Smith       if (!flg) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_FILE_READ,"-saws_local option requires js directory in root directory");
834bd53e248SBarry Smith       PetscStackCallSAWs(SAWs_Set_Local_JSHeader,());CHKERRQ(ierr);
835bd53e248SBarry Smith     }
83693598db9SBarry Smith     ierr = PetscGetProgramName(programname,64);CHKERRQ(ierr);
837*e78c4b8cSBarry Smith     ierr = PetscStrlen(help,&applinelen);CHKERRQ(ierr);
838*e78c4b8cSBarry Smith     introlen   = 4096 + applinelen;
839*e78c4b8cSBarry Smith     applinelen += 256;
840*e78c4b8cSBarry Smith     ierr = PetscMalloc(applinelen,&appline);CHKERRQ(ierr);
841*e78c4b8cSBarry Smith     ierr = PetscMalloc(introlen,&intro);CHKERRQ(ierr);
842*e78c4b8cSBarry Smith 
843d36c5c1aSBarry Smith     if (rootlocal) {
844*e78c4b8cSBarry Smith       ierr = PetscSNPrintf(appline,applinelen,"%s.c.html",programname);CHKERRQ(ierr);
845d36c5c1aSBarry Smith       ierr = PetscTestFile(appline,'r',&rootlocal);CHKERRQ(ierr);
846d36c5c1aSBarry Smith     }
847d36c5c1aSBarry Smith     if (rootlocal && help) {
848*e78c4b8cSBarry Smith       ierr = PetscSNPrintf(appline,applinelen,"<center> Running <a href=\"%s.c.html\">%s</a> which %s </center><br>\n",programname,programname,help);
849d36c5c1aSBarry Smith     } else if (help) {
850*e78c4b8cSBarry Smith       ierr = PetscSNPrintf(appline,applinelen,"<center>Running %s </center><br><pre>%s</pre><br>\n",programname,help);
851d36c5c1aSBarry Smith     } else {
852*e78c4b8cSBarry Smith       ierr = PetscSNPrintf(appline,applinelen,"<center> Running %s</center><br>\n",programname);
853d36c5c1aSBarry Smith     }
854d36c5c1aSBarry Smith 
855*e78c4b8cSBarry Smith     ierr = PetscSNPrintf(intro,introlen,"<body>\n"
856528d9559SBarry 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"
8571cda70a7SBarry Smith                                     "%s"
8581cda70a7SBarry Smith                                     "<center>This is the default PETSc application dashboard, from it you can access any published PETSc objects or logging data</center><br>\n",appline);
85916ad0300SBarry Smith     PetscStackCallSAWs(SAWs_Set_Body,("index.html",0,intro));
860*e78c4b8cSBarry Smith     ierr = PetscFree(intro);CHKERRQ(ierr);
861*e78c4b8cSBarry Smith     ierr = PetscFree(appline);CHKERRQ(ierr);
86216ad0300SBarry Smith     PetscStackCallSAWs(SAWs_Initialize,());
863d45a07a7SBarry Smith     ierr = PetscCitationsRegister("@TechReport{ saws,"
864d45a07a7SBarry Smith                                   "Author = {Matt Otten and Jed Brown and Barry Smith},"
865d45a07a7SBarry Smith                                   "Title  = {Scientific Application Web Server (SAWs) Users Manual},"
866d45a07a7SBarry Smith                                   "Institution = {Argonne National Laboratory},"
867d45a07a7SBarry Smith                                   "Year   = 2013}",NULL);CHKERRQ(ierr);
86898eb11daSBarry Smith   }
86971244e97SBarry Smith 
870f4202a44SBarry Smith #endif
871f4202a44SBarry Smith 
872e5c89e4eSSatish Balay   /* SHOULD PUT IN GUARDS: Make sure logging is initialized, even if we do not print it out */
873a9f03627SSatish Balay #if defined(PETSC_USE_LOG)
874e5c89e4eSSatish Balay   ierr = PetscLogBegin_Private();CHKERRQ(ierr);
875a9f03627SSatish Balay #endif
876e5c89e4eSSatish Balay 
877e5c89e4eSSatish Balay   /*
878e5c89e4eSSatish Balay      Load the dynamic libraries (on machines that support them), this registers all
879e5c89e4eSSatish Balay      the solvers etc. (On non-dynamic machines this initializes the PetscDraw and PetscViewer classes)
880e5c89e4eSSatish Balay   */
881e5c89e4eSSatish Balay   ierr = PetscInitialize_DynamicLibraries();CHKERRQ(ierr);
882e5c89e4eSSatish Balay 
883e5c89e4eSSatish Balay   ierr = MPI_Comm_size(PETSC_COMM_WORLD,&size);CHKERRQ(ierr);
884ae15b995SBarry Smith   ierr = PetscInfo1(0,"PETSc successfully started: number of processors = %d\n",size);CHKERRQ(ierr);
885e5c89e4eSSatish Balay   ierr = PetscGetHostName(hostname,256);CHKERRQ(ierr);
886ae15b995SBarry Smith   ierr = PetscInfo1(0,"Running on machine: %s\n",hostname);CHKERRQ(ierr);
887e5c89e4eSSatish Balay 
888e5c89e4eSSatish Balay   ierr = PetscOptionsCheckInitial_Components();CHKERRQ(ierr);
889ef6c6fedSBoyana Norris   /* Check the options database for options related to the options database itself */
890ef6c6fedSBoyana Norris   ierr = PetscOptionsSetFromOptions();CHKERRQ(ierr);
891ef6c6fedSBoyana Norris 
892951e3c8eSBarry Smith #if defined(PETSC_USE_PETSC_MPI_EXTERNAL32)
893e39fd77fSBarry Smith   /*
894e39fd77fSBarry Smith       Tell MPI about our own data representation converter, this would/should be used if extern32 is not supported by the MPI
895e39fd77fSBarry Smith 
896e39fd77fSBarry Smith       Currently not used because it is not supported by MPICH.
897e39fd77fSBarry Smith   */
898e39fd77fSBarry Smith #if !defined(PETSC_WORDS_BIGENDIAN)
8990298fd71SBarry Smith   ierr = MPI_Register_datarep((char*)"petsc",PetscDataRep_read_conv_fn,PetscDataRep_write_conv_fn,PetscDataRep_extent_fn,NULL);CHKERRQ(ierr);
900e39fd77fSBarry Smith #endif
901951e3c8eSBarry Smith #endif
902e39fd77fSBarry Smith 
9030298fd71SBarry Smith   ierr = PetscOptionsGetInt(NULL,"-hmpi_spawn_size",&nodesize,&flg);CHKERRQ(ierr);
904793721a6SBarry Smith   if (flg) {
90523464e94SBarry Smith #if defined(PETSC_HAVE_MPI_COMM_SPAWN)
90685afcc9aSBarry Smith     ierr = PetscHMPISpawn((PetscMPIInt) nodesize);CHKERRQ(ierr); /* worker nodes never return from here; they go directly to PetscEnd() */
90723464e94SBarry Smith #else
90885afcc9aSBarry Smith     SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SUP,"PETSc built without MPI 2 (MPI_Comm_spawn) support, use -hmpi_merge_size instead");
90923464e94SBarry Smith #endif
910793721a6SBarry Smith   } else {
9110298fd71SBarry Smith     ierr = PetscOptionsGetInt(NULL,"-hmpi_merge_size",&nodesize,&flg);CHKERRQ(ierr);
9128002f1cdSBarry Smith     if (flg) {
9130298fd71SBarry Smith       ierr = PetscHMPIMerge((PetscMPIInt) nodesize,NULL,NULL);CHKERRQ(ierr);
91485afcc9aSBarry Smith       if (PetscHMPIWorker) { /* if worker then never enter user code */
915bad7cb1dSBarry Smith         PetscInitializeCalled = PETSC_TRUE;
9163bf036e2SBarry Smith         PetscEnd();
9179505b675SBarry Smith       }
9188002f1cdSBarry Smith     }
919793721a6SBarry Smith   }
920e5c89e4eSSatish Balay 
92135d88935SVictor Minden #if defined(PETSC_HAVE_CUDA)
9224bb5149bSJed Brown   {
9234bb5149bSJed Brown     PetscMPIInt p;
924663ba86aSMatthew G Knepley     for (p = 0; p < PetscGlobalSize; ++p) {
925a297a907SKarl Rupp       if (p == PetscGlobalRank) cublasInit();
926663ba86aSMatthew G Knepley       ierr = MPI_Barrier(PETSC_COMM_WORLD);CHKERRQ(ierr);
927663ba86aSMatthew G Knepley     }
9284bb5149bSJed Brown   }
9293e39abd9SVictor Minden #endif
93092e62aa6SBarry Smith 
9310298fd71SBarry Smith   ierr = PetscOptionsHasName(NULL,"-python",&flg);CHKERRQ(ierr);
9329ac80d5eSLisandro Dalcin   if (flg) {
9339ac80d5eSLisandro Dalcin     PetscInitializeCalled = PETSC_TRUE;
9340298fd71SBarry Smith     ierr = PetscPythonInitialize(NULL,NULL);CHKERRQ(ierr);
9359ac80d5eSLisandro Dalcin   }
9369ac80d5eSLisandro Dalcin 
937607a6623SBarry Smith   ierr = PetscThreadCommInitializePackage();CHKERRQ(ierr);
938bd8b14e7SShri Abhyankar 
93941c0b4b3SShri Abhyankar   /*
94041c0b4b3SShri Abhyankar       Setup building of stack frames for all function calls
94141c0b4b3SShri Abhyankar   */
94276386721SLisandro Dalcin   PetscThreadLocalRegister((PetscThreadKey*)&petscstack); /* Creates pthread_key */
943e1167bb9SShri Abhyankar #if defined(PETSC_USE_DEBUG)
944e1167bb9SShri Abhyankar   ierr = PetscStackCreate();CHKERRQ(ierr);
945e1167bb9SShri Abhyankar #endif
946e1167bb9SShri Abhyankar 
9472d53ad75SBarry Smith #if defined(PETSC_SERIALIZE_FUNCTIONS)
9482d53ad75SBarry Smith   ierr = PetscFPTCreate(10000);CHKERRQ(ierr);
9492d53ad75SBarry Smith #endif
9502d53ad75SBarry Smith 
951dff31646SBarry Smith 
952301d30feSBarry Smith   /*
953301d30feSBarry Smith       Once we are completedly initialized then we can set this variables
954301d30feSBarry Smith   */
955301d30feSBarry Smith   PetscInitializeCalled = PETSC_TRUE;
956301d30feSBarry Smith   PetscFunctionReturn(0);
957e5c89e4eSSatish Balay }
958e5c89e4eSSatish Balay 
9592eff7a51SBarry Smith extern PetscObject *PetscObjects;
9602eff7a51SBarry Smith extern PetscInt    PetscObjectsCounts, PetscObjectsMaxCounts;
961e5c89e4eSSatish Balay 
962e5c89e4eSSatish Balay #undef __FUNCT__
963e5c89e4eSSatish Balay #define __FUNCT__ "PetscFinalize"
964e5c89e4eSSatish Balay /*@C
965e5c89e4eSSatish Balay    PetscFinalize - Checks for options to be called at the conclusion
966e5c89e4eSSatish Balay    of the program. MPI_Finalize() is called only if the user had not
967e5c89e4eSSatish Balay    called MPI_Init() before calling PetscInitialize().
968e5c89e4eSSatish Balay 
969e5c89e4eSSatish Balay    Collective on PETSC_COMM_WORLD
970e5c89e4eSSatish Balay 
971e5c89e4eSSatish Balay    Options Database Keys:
97288c29154SBarry Smith +  -options_table - Calls PetscOptionsView()
973e5c89e4eSSatish Balay .  -options_left - Prints unused options that remain in the database
9747eb1d149SBarry 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
975e5c89e4eSSatish Balay .  -mpidump - Calls PetscMPIDump()
976e5c89e4eSSatish Balay .  -malloc_dump - Calls PetscMallocDump()
977e5c89e4eSSatish Balay .  -malloc_info - Prints total memory usage
978e5c89e4eSSatish Balay -  -malloc_log - Prints summary of memory usage
979e5c89e4eSSatish Balay 
980e5c89e4eSSatish Balay    Level: beginner
981e5c89e4eSSatish Balay 
982e5c89e4eSSatish Balay    Note:
983e5c89e4eSSatish Balay    See PetscInitialize() for more general runtime options.
984e5c89e4eSSatish Balay 
98588c29154SBarry Smith .seealso: PetscInitialize(), PetscOptionsView(), PetscMallocDump(), PetscMPIDump(), PetscEnd()
986e5c89e4eSSatish Balay @*/
9877087cfbeSBarry Smith PetscErrorCode  PetscFinalize(void)
988e5c89e4eSSatish Balay {
989e5c89e4eSSatish Balay   PetscErrorCode ierr;
9904bb5149bSJed Brown   PetscMPIInt    rank;
991a8d2bbe5SBarry Smith   PetscInt       nopt;
9922bf49c77SBarry Smith   PetscBool      flg1 = PETSC_FALSE,flg2 = PETSC_FALSE,flg3 = PETSC_FALSE;
993dff31646SBarry Smith   PetscBool      flg;
99410463e74SBarry Smith #if defined(PETSC_USE_LOG)
99510463e74SBarry Smith   char           mname[PETSC_MAX_PATH_LEN];
99610463e74SBarry Smith #endif
997e5c89e4eSSatish Balay 
998e5c89e4eSSatish Balay   PetscFunctionBegin;
999e5c89e4eSSatish Balay   if (!PetscInitializeCalled) {
10004b09e917SBarry Smith     printf("PetscInitialize() must be called before PetscFinalize()\n");
10014b09e917SBarry Smith     PetscFunctionReturn(PETSC_ERR_ARG_WRONGSTATE);
1002e5c89e4eSSatish Balay   }
10030298fd71SBarry Smith   ierr = PetscInfo(NULL,"PetscFinalize() called\n");CHKERRQ(ierr);
1004b022a5c1SBarry Smith 
10051f817a21SBarry Smith   ierr = MPI_Comm_rank(PETSC_COMM_WORLD,&rank);CHKERRQ(ierr);
10061f817a21SBarry Smith 
10071f817a21SBarry Smith   ierr = PetscOptionsHasName(NULL,"-citations",&flg);CHKERRQ(ierr);
1008dff31646SBarry Smith   if (flg) {
10091f817a21SBarry Smith     char  *cits, filename[PETSC_MAX_PATH_LEN];
10101f817a21SBarry Smith     FILE  *fd = PETSC_STDOUT;
10111f817a21SBarry Smith 
10121f817a21SBarry Smith     ierr = PetscOptionsGetString(NULL,"-citations",filename,PETSC_MAX_PATH_LEN,NULL);CHKERRQ(ierr);
10131f817a21SBarry Smith     if (filename[0]) {
10141f817a21SBarry Smith       ierr = PetscFOpen(PETSC_COMM_WORLD,filename,"w",&fd);CHKERRQ(ierr);
10151f817a21SBarry Smith     }
1016dff31646SBarry Smith     ierr = PetscSegBufferGet(PetscCitationsList,1,&cits);CHKERRQ(ierr);
1017dff31646SBarry Smith     cits[0] = 0;
1018dff31646SBarry Smith     ierr = PetscSegBufferExtractAlloc(PetscCitationsList,&cits);CHKERRQ(ierr);
10191f817a21SBarry Smith     ierr = PetscFPrintf(PETSC_COMM_WORLD,fd,"If you publish results based on this computation please cite the following:\n");CHKERRQ(ierr);
10201f817a21SBarry Smith     ierr = PetscFPrintf(PETSC_COMM_WORLD,fd,"===========================================================================\n");CHKERRQ(ierr);
10211f817a21SBarry Smith     ierr = PetscFPrintf(PETSC_COMM_WORLD,fd,"%s",cits);CHKERRQ(ierr);
10221f817a21SBarry Smith     ierr = PetscFPrintf(PETSC_COMM_WORLD,fd,"===========================================================================\n");CHKERRQ(ierr);
10231f817a21SBarry Smith     ierr = PetscFClose(PETSC_COMM_WORLD,fd);CHKERRQ(ierr);
1024dff31646SBarry Smith     ierr = PetscFree(cits);CHKERRQ(ierr);
1025dff31646SBarry Smith   }
1026dff31646SBarry Smith   ierr = PetscSegBufferDestroy(&PetscCitationsList);CHKERRQ(ierr);
1027dff31646SBarry Smith 
10282d53ad75SBarry Smith #if defined(PETSC_SERIALIZE_FUNCTIONS)
10292d53ad75SBarry Smith   ierr = PetscFPTDestroy();CHKERRQ(ierr);
10302d53ad75SBarry Smith #endif
10312d53ad75SBarry Smith 
10322d53ad75SBarry Smith 
1033e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS)
1034dff31646SBarry Smith   flg = PETSC_FALSE;
1035*e78c4b8cSBarry Smith   ierr = PetscOptionsGetBool(NULL,"-saw_options",&flg,NULL);CHKERRQ(ierr);
1036d5649816SBarry Smith   if (flg) {
1037e04113cfSBarry Smith     ierr = PetscOptionsSAWsDestroy();CHKERRQ(ierr);
1038d5649816SBarry Smith   }
1039d5649816SBarry Smith #endif
1040d5649816SBarry Smith 
10416d065ec1SBarry Smith #if defined(PETSC_HAVE_SERVER)
10422d139d8fSBarry Smith   flg1 = PETSC_FALSE;
10432d139d8fSBarry Smith   ierr = PetscOptionsGetBool(NULL,"-server",&flg1,NULL);CHKERRQ(ierr);
10442d139d8fSBarry Smith   if (flg1) {
10456d065ec1SBarry Smith     /*  this is a crude hack, but better than nothing */
10462d139d8fSBarry Smith     ierr = PetscPOpen(PETSC_COMM_WORLD,NULL,"pkill -9 petscwebserver","r",NULL);CHKERRQ(ierr);
10472d139d8fSBarry Smith   }
10486d065ec1SBarry Smith #endif
10492d139d8fSBarry Smith 
1050681455b2SBarry Smith #if defined(PETSC_HAVE_X)
1051681455b2SBarry Smith   flg1 = PETSC_FALSE;
1052681455b2SBarry Smith   ierr = PetscOptionsGetBool(NULL,"-x_virtual",&flg1,NULL);CHKERRQ(ierr);
1053681455b2SBarry Smith   if (flg1) {
1054681455b2SBarry Smith     /*  this is a crude hack, but better than nothing */
1055681455b2SBarry Smith     ierr = PetscPOpen(PETSC_COMM_WORLD,NULL,"pkill -9 Xvfb","r",NULL);CHKERRQ(ierr);
1056681455b2SBarry Smith   }
1057681455b2SBarry Smith #endif
1058681455b2SBarry Smith 
105985afcc9aSBarry Smith   ierr = PetscHMPIFinalize();CHKERRQ(ierr);
1060d3f95da6SShri Abhyankar 
10610298fd71SBarry Smith   ierr = PetscOptionsGetBool(NULL,"-malloc_info",&flg2,NULL);CHKERRQ(ierr);
1062e5c89e4eSSatish Balay   if (!flg2) {
106390d69ab7SBarry Smith     flg2 = PETSC_FALSE;
10640298fd71SBarry Smith     ierr = PetscOptionsGetBool(NULL,"-memory_info",&flg2,NULL);CHKERRQ(ierr);
1065e5c89e4eSSatish Balay   }
1066e5c89e4eSSatish Balay   if (flg2) {
1067e5c89e4eSSatish Balay     ierr = PetscMemoryShowUsage(PETSC_VIEWER_STDOUT_WORLD,"Summary of Memory Usage in PETSc\n");CHKERRQ(ierr);
1068e5c89e4eSSatish Balay   }
1069e5c89e4eSSatish Balay 
1070e5c89e4eSSatish Balay #if defined(PETSC_USE_LOG)
107190d69ab7SBarry Smith   flg1 = PETSC_FALSE;
10720298fd71SBarry Smith   ierr = PetscOptionsGetBool(NULL,"-get_total_flops",&flg1,NULL);CHKERRQ(ierr);
1073e5c89e4eSSatish Balay   if (flg1) {
1074e5c89e4eSSatish Balay     PetscLogDouble flops = 0;
1075205a32c2SJed Brown     ierr = MPI_Reduce(&petsc_TotalFlops,&flops,1,MPI_DOUBLE,MPI_SUM,0,PETSC_COMM_WORLD);CHKERRQ(ierr);
1076e5c89e4eSSatish Balay     ierr = PetscPrintf(PETSC_COMM_WORLD,"Total flops over all processors %g\n",flops);CHKERRQ(ierr);
1077e5c89e4eSSatish Balay   }
1078e5c89e4eSSatish Balay #endif
1079e5c89e4eSSatish Balay 
1080e5c89e4eSSatish Balay 
1081e5c89e4eSSatish Balay #if defined(PETSC_USE_LOG)
1082e5c89e4eSSatish Balay #if defined(PETSC_HAVE_MPE)
1083e5c89e4eSSatish Balay   mname[0] = 0;
1084a297a907SKarl Rupp 
10850298fd71SBarry Smith   ierr = PetscOptionsGetString(NULL,"-log_mpe",mname,PETSC_MAX_PATH_LEN,&flg1);CHKERRQ(ierr);
1086e5c89e4eSSatish Balay   if (flg1) {
1087e5c89e4eSSatish Balay     if (mname[0]) {ierr = PetscLogMPEDump(mname);CHKERRQ(ierr);}
1088e5c89e4eSSatish Balay     else          {ierr = PetscLogMPEDump(0);CHKERRQ(ierr);}
1089e5c89e4eSSatish Balay   }
1090e5c89e4eSSatish Balay #endif
1091e5c89e4eSSatish Balay   mname[0] = 0;
1092a297a907SKarl Rupp 
10930298fd71SBarry Smith   ierr = PetscOptionsGetString(NULL,"-log_summary",mname,PETSC_MAX_PATH_LEN,&flg1);CHKERRQ(ierr);
1094e5c89e4eSSatish Balay   if (flg1) {
109591eabc43SBarry Smith     PetscViewer viewer;
109691eabc43SBarry Smith     if (mname[0]) {
109791eabc43SBarry Smith       ierr = PetscViewerASCIIOpen(PETSC_COMM_WORLD,mname,&viewer);CHKERRQ(ierr);
109891eabc43SBarry Smith       ierr = PetscLogView(viewer);CHKERRQ(ierr);
10996bf464f9SBarry Smith       ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr);
110033f85c2fSBarry Smith     } else {
110133f85c2fSBarry Smith       viewer = PETSC_VIEWER_STDOUT_WORLD;
110233f85c2fSBarry Smith       ierr   = PetscLogView(viewer);CHKERRQ(ierr);
110333f85c2fSBarry Smith     }
1104e5c89e4eSSatish Balay   }
1105e5c89e4eSSatish Balay 
1106ff5bc46bSBarry Smith   mname[0] = 0;
1107a297a907SKarl Rupp 
11080298fd71SBarry Smith   ierr = PetscOptionsGetString(NULL,"-log_summary_python",mname,PETSC_MAX_PATH_LEN,&flg1);CHKERRQ(ierr);
1109ff5bc46bSBarry Smith   if (flg1) {
1110ff5bc46bSBarry Smith     PetscViewer viewer;
1111ff5bc46bSBarry Smith     if (mname[0]) {
1112ff5bc46bSBarry Smith       ierr = PetscViewerASCIIOpen(PETSC_COMM_WORLD,mname,&viewer);CHKERRQ(ierr);
111391eabc43SBarry Smith       ierr = PetscLogViewPython(viewer);CHKERRQ(ierr);
11146bf464f9SBarry Smith       ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr);
111533f85c2fSBarry Smith     } else {
111633f85c2fSBarry Smith       viewer = PETSC_VIEWER_STDOUT_WORLD;
111733f85c2fSBarry Smith       ierr   = PetscLogViewPython(viewer);CHKERRQ(ierr);
111833f85c2fSBarry Smith     }
1119ff5bc46bSBarry Smith   }
1120ff5bc46bSBarry Smith 
11210298fd71SBarry Smith   ierr = PetscOptionsGetString(NULL,"-log_detailed",mname,PETSC_MAX_PATH_LEN,&flg1);CHKERRQ(ierr);
112278392ef1SBarry Smith   if (flg1) {
112378392ef1SBarry Smith     if (mname[0])  {ierr = PetscLogPrintDetailed(PETSC_COMM_WORLD,mname);CHKERRQ(ierr);}
112478392ef1SBarry Smith     else           {ierr = PetscLogPrintDetailed(PETSC_COMM_WORLD,0);CHKERRQ(ierr);}
112578392ef1SBarry Smith   }
112678392ef1SBarry Smith 
1127e5c89e4eSSatish Balay   mname[0] = 0;
1128a297a907SKarl Rupp 
11290298fd71SBarry Smith   ierr = PetscOptionsGetString(NULL,"-log_all",mname,PETSC_MAX_PATH_LEN,&flg1);CHKERRQ(ierr);
11300298fd71SBarry Smith   ierr = PetscOptionsGetString(NULL,"-log",mname,PETSC_MAX_PATH_LEN,&flg2);CHKERRQ(ierr);
1131e5c89e4eSSatish Balay   if (flg1 || flg2) {
1132e5c89e4eSSatish Balay     if (mname[0]) PetscLogDump(mname);
1133e5c89e4eSSatish Balay     else          PetscLogDump(0);
1134e5c89e4eSSatish Balay   }
1135e5c89e4eSSatish Balay #endif
113610463e74SBarry Smith 
1137b58ca069SBarry Smith   /*
1138b58ca069SBarry Smith      Free all objects registered with PetscObjectRegisterDestroy() such as PETSC_VIEWER_XXX_().
1139b58ca069SBarry Smith   */
1140b58ca069SBarry Smith   ierr = PetscObjectRegisterDestroyAll();CHKERRQ(ierr);
1141b58ca069SBarry Smith 
114233f85c2fSBarry Smith   ierr = PetscStackDestroy();CHKERRQ(ierr);
114376386721SLisandro Dalcin   PetscThreadLocalDestroy((PetscThreadKey)petscstack); /* Deletes pthread_key */
114410463e74SBarry Smith 
114590d69ab7SBarry Smith   flg1 = PETSC_FALSE;
11460298fd71SBarry Smith   ierr = PetscOptionsGetBool(NULL,"-no_signal_handler",&flg1,NULL);CHKERRQ(ierr);
1147e5c89e4eSSatish Balay   if (!flg1) { ierr = PetscPopSignalHandler();CHKERRQ(ierr);}
114890d69ab7SBarry Smith   flg1 = PETSC_FALSE;
11490298fd71SBarry Smith   ierr = PetscOptionsGetBool(NULL,"-mpidump",&flg1,NULL);CHKERRQ(ierr);
1150e5c89e4eSSatish Balay   if (flg1) {
1151e5c89e4eSSatish Balay     ierr = PetscMPIDump(stdout);CHKERRQ(ierr);
1152e5c89e4eSSatish Balay   }
115390d69ab7SBarry Smith   flg1 = PETSC_FALSE;
115490d69ab7SBarry Smith   flg2 = PETSC_FALSE;
11558bb29257SSatish Balay   /* preemptive call to avoid listing this option in options table as unused */
11560298fd71SBarry Smith   ierr = PetscOptionsHasName(NULL,"-malloc_dump",&flg1);CHKERRQ(ierr);
11570298fd71SBarry Smith   ierr = PetscOptionsHasName(NULL,"-objects_dump",&flg1);CHKERRQ(ierr);
11580298fd71SBarry Smith   ierr = PetscOptionsGetBool(NULL,"-options_table",&flg2,NULL);CHKERRQ(ierr);
1159e4c476e2SSatish Balay 
1160e5c89e4eSSatish Balay   if (flg2) {
1161be56827dSJed Brown     PetscViewer viewer;
1162be56827dSJed Brown     ierr = PetscViewerASCIIGetStdout(PETSC_COMM_WORLD,&viewer);CHKERRQ(ierr);
1163be56827dSJed Brown     ierr = PetscOptionsView(viewer);CHKERRQ(ierr);
1164be56827dSJed Brown     ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr);
1165e5c89e4eSSatish Balay   }
1166e5c89e4eSSatish Balay 
1167e5c89e4eSSatish Balay   /* to prevent PETSc -options_left from warning */
11680298fd71SBarry Smith   ierr = PetscOptionsHasName(NULL,"-nox",&flg1);CHKERRQ(ierr);
11690298fd71SBarry Smith   ierr = PetscOptionsHasName(NULL,"-nox_warning",&flg1);CHKERRQ(ierr);
1170e5c89e4eSSatish Balay 
117185afcc9aSBarry Smith   if (!PetscHMPIWorker) { /* worker processes skip this because they do not usually process options */
117233fc4174SSatish Balay     flg3 = PETSC_FALSE; /* default value is required */
11730298fd71SBarry Smith     ierr = PetscOptionsGetBool(NULL,"-options_left",&flg3,&flg1);CHKERRQ(ierr);
1174e5c89e4eSSatish Balay     ierr = PetscOptionsAllUsed(&nopt);CHKERRQ(ierr);
1175e5c89e4eSSatish Balay     if (flg3) {
1176e5c89e4eSSatish Balay       if (!flg2) { /* have not yet printed the options */
1177be56827dSJed Brown         PetscViewer viewer;
1178be56827dSJed Brown         ierr = PetscViewerASCIIGetStdout(PETSC_COMM_WORLD,&viewer);CHKERRQ(ierr);
1179be56827dSJed Brown         ierr = PetscOptionsView(viewer);CHKERRQ(ierr);
1180be56827dSJed Brown         ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr);
1181e5c89e4eSSatish Balay       }
1182e5c89e4eSSatish Balay       if (!nopt) {
1183e5c89e4eSSatish Balay         ierr = PetscPrintf(PETSC_COMM_WORLD,"There are no unused options.\n");CHKERRQ(ierr);
1184e5c89e4eSSatish Balay       } else if (nopt == 1) {
1185e5c89e4eSSatish Balay         ierr = PetscPrintf(PETSC_COMM_WORLD,"There is one unused database option. It is:\n");CHKERRQ(ierr);
1186e5c89e4eSSatish Balay       } else {
11877582186dSLisandro Dalcin         ierr = PetscPrintf(PETSC_COMM_WORLD,"There are %D unused database options. They are:\n",nopt);CHKERRQ(ierr);
1188e5c89e4eSSatish Balay       }
1189e5c89e4eSSatish Balay     }
1190e5c89e4eSSatish Balay #if defined(PETSC_USE_DEBUG)
1191da8b8a77SBarry Smith     if (nopt && !flg3 && !flg1) {
1192e5c89e4eSSatish Balay       ierr = PetscPrintf(PETSC_COMM_WORLD,"WARNING! There are options you set that were not used!\n");CHKERRQ(ierr);
1193e5c89e4eSSatish Balay       ierr = PetscPrintf(PETSC_COMM_WORLD,"WARNING! could be spelling mistake, etc!\n");CHKERRQ(ierr);
1194e5c89e4eSSatish Balay       ierr = PetscOptionsLeft();CHKERRQ(ierr);
1195e5c89e4eSSatish Balay     } else if (nopt && flg3) {
1196e5c89e4eSSatish Balay #else
1197e5c89e4eSSatish Balay     if (nopt && flg3) {
1198e5c89e4eSSatish Balay #endif
1199e5c89e4eSSatish Balay       ierr = PetscOptionsLeft();CHKERRQ(ierr);
1200e5c89e4eSSatish Balay     }
1201931f367cSBarry Smith   }
1202e5c89e4eSSatish Balay 
1203e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS)
1204d45a07a7SBarry Smith   if (!PetscGlobalRank) {
120587f587eeSBarry Smith     ierr = PetscStackSAWsViewOff();CHKERRQ(ierr);
120616ad0300SBarry Smith     PetscStackCallSAWs(SAWs_Finalize,());
1207d45a07a7SBarry Smith   }
1208ec957eceSBarry Smith #endif
1209ec957eceSBarry Smith 
1210eea2bdeeSJed Brown   {
1211eea2bdeeSJed Brown     PetscThreadComm tcomm_world;
1212eea2bdeeSJed Brown     ierr = PetscGetThreadCommWorld(&tcomm_world);CHKERRQ(ierr);
1213eea2bdeeSJed Brown     /* Free global thread communicator */
1214eea2bdeeSJed Brown     ierr = PetscThreadCommDestroy(&tcomm_world);CHKERRQ(ierr);
1215eea2bdeeSJed Brown   }
1216eea2bdeeSJed Brown 
121710463e74SBarry Smith   /*
1218dbc8283eSBarry Smith        List all objects the user may have forgot to free
12192eff7a51SBarry Smith   */
12200298fd71SBarry Smith   ierr = PetscOptionsHasName(NULL,"-objects_dump",&flg1);CHKERRQ(ierr);
1221a64a8e02SBarry Smith   if (flg1) {
1222a64a8e02SBarry Smith     MPI_Comm local_comm;
12237eb1d149SBarry Smith     char     string[64];
1224a64a8e02SBarry Smith 
12250298fd71SBarry Smith     ierr = PetscOptionsGetString(NULL,"-objects_dump",string,64,NULL);CHKERRQ(ierr);
1226a64a8e02SBarry Smith     ierr = MPI_Comm_dup(MPI_COMM_WORLD,&local_comm);CHKERRQ(ierr);
1227a64a8e02SBarry Smith     ierr = PetscSequentialPhaseBegin_Private(local_comm,1);CHKERRQ(ierr);
12287eb1d149SBarry Smith     ierr = PetscObjectsDump(stdout,(string[0] == 'a') ? PETSC_TRUE : PETSC_FALSE);CHKERRQ(ierr);
1229a64a8e02SBarry Smith     ierr = PetscSequentialPhaseEnd_Private(local_comm,1);CHKERRQ(ierr);
1230a64a8e02SBarry Smith     ierr = MPI_Comm_free(&local_comm);CHKERRQ(ierr);
12310a1571b3SBarry Smith   }
1232dbc8283eSBarry Smith   PetscObjectsCounts    = 0;
1233dbc8283eSBarry Smith   PetscObjectsMaxCounts = 0;
12342eff7a51SBarry Smith 
1235a297a907SKarl Rupp   ierr = PetscFree(PetscObjects);CHKERRQ(ierr);
12362eff7a51SBarry Smith 
123733f85c2fSBarry Smith #if defined(PETSC_USE_LOG)
123833f85c2fSBarry Smith   ierr = PetscLogDestroy();CHKERRQ(ierr);
123933f85c2fSBarry Smith #endif
124033f85c2fSBarry Smith 
124133f85c2fSBarry Smith   /*
124233f85c2fSBarry Smith      Destroy any packages that registered a finalize
124333f85c2fSBarry Smith   */
124433f85c2fSBarry Smith   ierr = PetscRegisterFinalizeAll();CHKERRQ(ierr);
124533f85c2fSBarry Smith 
124633f85c2fSBarry Smith   /*
124710463e74SBarry Smith      Destroy all the function registration lists created
124810463e74SBarry Smith   */
124910463e74SBarry Smith   ierr = PetscFinalize_DynamicLibraries();CHKERRQ(ierr);
125010463e74SBarry Smith 
125148dd1dffSBarry Smith   /*
125248dd1dffSBarry Smith      Print PetscFunctionLists that have not been properly freed
125348dd1dffSBarry Smith 
125437e93019SBarry Smith   ierr = PetscFunctionListPrintAll();CHKERRQ(ierr);
125548dd1dffSBarry Smith   */
125637e93019SBarry Smith 
12574028d114SSatish Balay   if (petsc_history) {
1258f3dea69dSBarry Smith     ierr = PetscCloseHistoryFile(&petsc_history);CHKERRQ(ierr);
1259e5c89e4eSSatish Balay     petsc_history = 0;
1260e5c89e4eSSatish Balay   }
1261e5c89e4eSSatish Balay 
12620298fd71SBarry Smith   ierr = PetscInfoAllow(PETSC_FALSE,NULL);CHKERRQ(ierr);
1263e5c89e4eSSatish Balay 
12648bb29257SSatish Balay   {
1265e5c89e4eSSatish Balay     char fname[PETSC_MAX_PATH_LEN];
1266e5c89e4eSSatish Balay     FILE *fd;
1267ed9cf6e9SBarry Smith     int  err;
1268e5c89e4eSSatish Balay 
1269e5c89e4eSSatish Balay     fname[0] = 0;
1270a297a907SKarl Rupp 
12710298fd71SBarry Smith     ierr = PetscOptionsGetString(NULL,"-malloc_dump",fname,250,&flg1);CHKERRQ(ierr);
1272dc92acbaSJed Brown     flg2 = PETSC_FALSE;
12730298fd71SBarry Smith     ierr = PetscOptionsGetBool(NULL,"-malloc_test",&flg2,NULL);CHKERRQ(ierr);
12748bf1f09cSShri Abhyankar #if defined(PETSC_USE_DEBUG)
1275dc92acbaSJed Brown     if (PETSC_RUNNING_ON_VALGRIND) flg2 = PETSC_FALSE;
1276dc92acbaSJed Brown #else
1277dc92acbaSJed Brown     flg2 = PETSC_FALSE;         /* Skip reporting for optimized builds regardless of -malloc_test */
1278dc92acbaSJed Brown #endif
1279e5c89e4eSSatish Balay     if (flg1 && fname[0]) {
1280e5c89e4eSSatish Balay       char sname[PETSC_MAX_PATH_LEN];
1281e5c89e4eSSatish Balay 
1282e5c89e4eSSatish Balay       sprintf(sname,"%s_%d",fname,rank);
1283e32f2f54SBarry Smith       fd   = fopen(sname,"w"); if (!fd) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_FILE_OPEN,"Cannot open log file: %s",sname);
1284e5c89e4eSSatish Balay       ierr = PetscMallocDump(fd);CHKERRQ(ierr);
1285ed9cf6e9SBarry Smith       err  = fclose(fd);
1286e32f2f54SBarry Smith       if (err) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SYS,"fclose() failed on file");
1287dc92acbaSJed Brown     } else if (flg1 || flg2) {
1288e5c89e4eSSatish Balay       MPI_Comm local_comm;
1289e5c89e4eSSatish Balay 
1290e5c89e4eSSatish Balay       ierr = MPI_Comm_dup(MPI_COMM_WORLD,&local_comm);CHKERRQ(ierr);
1291e5c89e4eSSatish Balay       ierr = PetscSequentialPhaseBegin_Private(local_comm,1);CHKERRQ(ierr);
1292e5c89e4eSSatish Balay       ierr = PetscMallocDump(stdout);CHKERRQ(ierr);
1293e5c89e4eSSatish Balay       ierr = PetscSequentialPhaseEnd_Private(local_comm,1);CHKERRQ(ierr);
1294e5c89e4eSSatish Balay       ierr = MPI_Comm_free(&local_comm);CHKERRQ(ierr);
1295e5c89e4eSSatish Balay     }
1296e5c89e4eSSatish Balay   }
1297a64a8e02SBarry Smith 
12988bb29257SSatish Balay   {
1299e5c89e4eSSatish Balay     char fname[PETSC_MAX_PATH_LEN];
13000298fd71SBarry Smith     FILE *fd = NULL;
1301e5c89e4eSSatish Balay 
1302e5c89e4eSSatish Balay     fname[0] = 0;
1303a297a907SKarl Rupp 
13040298fd71SBarry Smith     ierr = PetscOptionsGetString(NULL,"-malloc_log",fname,250,&flg1);CHKERRQ(ierr);
13050298fd71SBarry Smith     ierr = PetscOptionsHasName(NULL,"-malloc_log_threshold",&flg2);CHKERRQ(ierr);
1306e5c89e4eSSatish Balay     if (flg1 && fname[0]) {
1307ed9cf6e9SBarry Smith       int err;
1308e5c89e4eSSatish Balay 
1309574034a9SJed Brown       if (!rank) {
1310574034a9SJed Brown         fd = fopen(fname,"w");
1311574034a9SJed Brown         if (!fd) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_FILE_OPEN,"Cannot open log file: %s",fname);
1312574034a9SJed Brown       }
1313e5c89e4eSSatish Balay       ierr = PetscMallocDumpLog(fd);CHKERRQ(ierr);
1314574034a9SJed Brown       if (fd) {
1315ed9cf6e9SBarry Smith         err = fclose(fd);
1316e32f2f54SBarry Smith         if (err) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SYS,"fclose() failed on file");
1317574034a9SJed Brown       }
1318574034a9SJed Brown     } else if (flg1 || flg2) {
1319e5c89e4eSSatish Balay       ierr = PetscMallocDumpLog(stdout);CHKERRQ(ierr);
1320e5c89e4eSSatish Balay     }
1321e5c89e4eSSatish Balay   }
1322e5c89e4eSSatish Balay   /* Can be destroyed only after all the options are used */
1323e5c89e4eSSatish Balay   ierr = PetscOptionsDestroy();CHKERRQ(ierr);
1324e5c89e4eSSatish Balay 
1325e5c89e4eSSatish Balay   PetscGlobalArgc = 0;
1326e5c89e4eSSatish Balay   PetscGlobalArgs = 0;
1327e5c89e4eSSatish Balay 
1328ce63c4c1SBarry Smith #if defined(PETSC_USE_REAL___FLOAT128)
1329c90a1750SBarry Smith   ierr = MPI_Type_free(&MPIU___FLOAT128);CHKERRQ(ierr);
13307c2de775SJed Brown #if defined(PETSC_HAVE_COMPLEX)
13318c764dc5SJose Roman   ierr = MPI_Type_free(&MPIU___COMPLEX128);CHKERRQ(ierr);
13328c764dc5SJose Roman #endif
1333d9822059SBarry Smith   ierr = MPI_Op_free(&MPIU_MAX);CHKERRQ(ierr);
1334d9822059SBarry Smith   ierr = MPI_Op_free(&MPIU_MIN);CHKERRQ(ierr);
1335c90a1750SBarry Smith #endif
1336c90a1750SBarry Smith 
13377c2de775SJed Brown #if defined(PETSC_HAVE_COMPLEX)
13382c876bd9SBarry Smith #if !defined(PETSC_HAVE_MPI_C_DOUBLE_COMPLEX)
1339500d8756SSatish Balay   ierr = MPI_Type_free(&MPIU_C_DOUBLE_COMPLEX);CHKERRQ(ierr);
1340500d8756SSatish Balay   ierr = MPI_Type_free(&MPIU_C_COMPLEX);CHKERRQ(ierr);
13412c876bd9SBarry Smith #endif
1342e5c89e4eSSatish Balay #endif
1343cca4cb22SSatish Balay 
13447c2de775SJed Brown #if (defined(PETSC_HAVE_COMPLEX) && !defined(PETSC_HAVE_MPI_C_DOUBLE_COMPLEX)) || defined(PETSC_USE_REAL___FLOAT128)
1345cca4cb22SSatish Balay   ierr = MPI_Op_free(&MPIU_SUM);CHKERRQ(ierr);
1346cca4cb22SSatish Balay #endif
1347cca4cb22SSatish Balay 
1348e5c89e4eSSatish Balay   ierr = MPI_Type_free(&MPIU_2SCALAR);CHKERRQ(ierr);
134944041f26SJed Brown #if defined(PETSC_USE_64BIT_INDICES) || !defined(MPI_2INT)
1350e5c89e4eSSatish Balay   ierr = MPI_Type_free(&MPIU_2INT);CHKERRQ(ierr);
135144041f26SJed Brown #endif
1352e5c89e4eSSatish Balay   ierr = MPI_Op_free(&PetscMaxSum_Op);CHKERRQ(ierr);
1353e5c89e4eSSatish Balay   ierr = MPI_Op_free(&PetscADMax_Op);CHKERRQ(ierr);
1354e5c89e4eSSatish Balay   ierr = MPI_Op_free(&PetscADMin_Op);CHKERRQ(ierr);
1355e5c89e4eSSatish Balay 
1356dbc8283eSBarry Smith   /*
1357efb80d3cSBarry Smith      Destroy any known inner MPI_Comm's and attributes pointing to them
1358efb80d3cSBarry Smith      Note this will not destroy any new communicators the user has created.
1359efb80d3cSBarry Smith 
1360efb80d3cSBarry Smith      If all PETSc objects were not destroyed those left over objects will have hanging references to
1361efb80d3cSBarry Smith      the MPI_Comms that were freed; but that is ok because those PETSc objects will never be used again
1362dbc8283eSBarry Smith  */
1363b770b1f6SSatish Balay   {
1364dbc8283eSBarry Smith     PetscCommCounter *counter;
1365dbc8283eSBarry Smith     PetscMPIInt      flg;
1366dbc8283eSBarry Smith     MPI_Comm         icomm;
1367265f3f35SJed Brown     union {MPI_Comm comm; void *ptr;} ucomm;
1368265f3f35SJed Brown     ierr = MPI_Attr_get(PETSC_COMM_SELF,Petsc_InnerComm_keyval,&ucomm,&flg);CHKERRQ(ierr);
1369dbc8283eSBarry Smith     if (flg) {
1370265f3f35SJed Brown       icomm = ucomm.comm;
1371dbc8283eSBarry Smith       ierr = MPI_Attr_get(icomm,Petsc_Counter_keyval,&counter,&flg);CHKERRQ(ierr);
1372dbc8283eSBarry 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");
1373dbc8283eSBarry Smith 
1374dbc8283eSBarry Smith       ierr = MPI_Attr_delete(PETSC_COMM_SELF,Petsc_InnerComm_keyval);CHKERRQ(ierr);
1375efb80d3cSBarry Smith       ierr = MPI_Attr_delete(icomm,Petsc_Counter_keyval);CHKERRQ(ierr);
1376efb80d3cSBarry Smith       ierr = MPI_Comm_free(&icomm);CHKERRQ(ierr);
1377dbc8283eSBarry Smith     }
1378265f3f35SJed Brown     ierr = MPI_Attr_get(PETSC_COMM_WORLD,Petsc_InnerComm_keyval,&ucomm,&flg);CHKERRQ(ierr);
1379dbc8283eSBarry Smith     if (flg) {
1380265f3f35SJed Brown       icomm = ucomm.comm;
1381dbc8283eSBarry Smith       ierr = MPI_Attr_get(icomm,Petsc_Counter_keyval,&counter,&flg);CHKERRQ(ierr);
1382dbc8283eSBarry 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");
1383dbc8283eSBarry Smith 
1384dbc8283eSBarry Smith       ierr = MPI_Attr_delete(PETSC_COMM_WORLD,Petsc_InnerComm_keyval);CHKERRQ(ierr);
1385efb80d3cSBarry Smith       ierr = MPI_Attr_delete(icomm,Petsc_Counter_keyval);CHKERRQ(ierr);
1386efb80d3cSBarry Smith       ierr = MPI_Comm_free(&icomm);CHKERRQ(ierr);
1387dbc8283eSBarry Smith     }
1388b770b1f6SSatish Balay   }
1389dbc8283eSBarry Smith 
1390480cf27aSJed Brown   ierr = MPI_Keyval_free(&Petsc_Counter_keyval);CHKERRQ(ierr);
1391480cf27aSJed Brown   ierr = MPI_Keyval_free(&Petsc_InnerComm_keyval);CHKERRQ(ierr);
1392480cf27aSJed Brown   ierr = MPI_Keyval_free(&Petsc_OuterComm_keyval);CHKERRQ(ierr);
1393480cf27aSJed Brown 
1394663ba86aSMatthew G Knepley #if defined(PETSC_HAVE_CUDA)
13954bb5149bSJed Brown   {
13964bb5149bSJed Brown     PetscInt p;
1397663ba86aSMatthew G Knepley     for (p = 0; p < PetscGlobalSize; ++p) {
1398a297a907SKarl Rupp       if (p == PetscGlobalRank) cublasShutdown();
1399663ba86aSMatthew G Knepley       ierr = MPI_Barrier(PETSC_COMM_WORLD);CHKERRQ(ierr);
1400663ba86aSMatthew G Knepley     }
14014bb5149bSJed Brown   }
1402663ba86aSMatthew G Knepley #endif
1403663ba86aSMatthew G Knepley 
1404e5c89e4eSSatish Balay   if (PetscBeganMPI) {
140599608316SBarry Smith #if defined(PETSC_HAVE_MPI_FINALIZED)
140699b1327fSBarry Smith     PetscMPIInt flag;
140799b1327fSBarry Smith     ierr = MPI_Finalized(&flag);CHKERRQ(ierr);
1408e32f2f54SBarry Smith     if (flag) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_LIB,"MPI_Finalize() has already been called, even though MPI_Init() was called by PetscInitialize()");
140999608316SBarry Smith #endif
1410e5c89e4eSSatish Balay     ierr = MPI_Finalize();CHKERRQ(ierr);
1411e5c89e4eSSatish Balay   }
1412e5c89e4eSSatish Balay /*
1413e5c89e4eSSatish Balay 
1414e5c89e4eSSatish Balay      Note: In certain cases PETSC_COMM_WORLD is never MPI_Comm_free()ed because
1415e5c89e4eSSatish Balay    the communicator has some outstanding requests on it. Specifically if the
1416e5c89e4eSSatish Balay    flag PETSC_HAVE_BROKEN_REQUEST_FREE is set (for IBM MPI implementation). See
1417e5c89e4eSSatish Balay    src/vec/utils/vpscat.c. Due to this the memory allocated in PetscCommDuplicate()
1418e5c89e4eSSatish Balay    is never freed as it should be. Thus one may obtain messages of the form
14190e5e90baSSatish Balay    [ 1] 8 bytes PetscCommDuplicate() line 645 in src/sys/mpiu.c indicating the
1420e5c89e4eSSatish Balay    memory was not freed.
1421e5c89e4eSSatish Balay 
1422e5c89e4eSSatish Balay */
14231d1a0024SBarry Smith   ierr = PetscMallocClear();CHKERRQ(ierr);
1424a297a907SKarl Rupp 
1425e5c89e4eSSatish Balay   PetscInitializeCalled = PETSC_FALSE;
1426e5c89e4eSSatish Balay   PetscFinalizeCalled   = PETSC_TRUE;
1427e5c89e4eSSatish Balay   PetscFunctionReturn(ierr);
1428e5c89e4eSSatish Balay }
1429e5c89e4eSSatish Balay 
143043db4dbbSBarry Smith #if defined(PETSC_MISSING_LAPACK_lsame_)
14318cc058d9SJed Brown PETSC_EXTERN int lsame_(char *a,char *b)
143243db4dbbSBarry Smith {
143343db4dbbSBarry Smith   if (*a == *b) return 1;
143443db4dbbSBarry Smith   if (*a + 32 == *b) return 1;
143543db4dbbSBarry Smith   if (*a - 32 == *b) return 1;
143643db4dbbSBarry Smith   return 0;
143743db4dbbSBarry Smith }
1438a70650f6SBarry Smith #endif
143943db4dbbSBarry Smith 
144043db4dbbSBarry Smith #if defined(PETSC_MISSING_LAPACK_lsame)
14418cc058d9SJed Brown PETSC_EXTERN int lsame(char *a,char *b)
144243db4dbbSBarry Smith {
144343db4dbbSBarry Smith   if (*a == *b) return 1;
144443db4dbbSBarry Smith   if (*a + 32 == *b) return 1;
144543db4dbbSBarry Smith   if (*a - 32 == *b) return 1;
144643db4dbbSBarry Smith   return 0;
144743db4dbbSBarry Smith }
144843db4dbbSBarry Smith #endif
1449