xref: /petsc/src/sys/objects/pinit.c (revision d6e4c47c23554f15b8192a2d50851d463e05f77d)
17d0a6c19SBarry Smith 
2e5c89e4eSSatish Balay /*
3e5c89e4eSSatish Balay    This file defines the initialization of PETSc, including PetscInitialize()
4e5c89e4eSSatish Balay */
550f81f78SJed Brown #define PETSC_DESIRE_COMPLEX
6afcb2eb5SJed Brown #include <petsc-private/petscimpl.h>        /*I  "petscsys.h"   I*/
7665c2dedSJed Brown #include <petscviewer.h>
88101f56cSMatthew Knepley 
9663ba86aSMatthew G Knepley #if defined(PETSC_HAVE_CUDA)
102f947c57SVictor Minden #include <cublas.h>
117a025f21SVictor Minden #endif
127a025f21SVictor Minden 
13bd8b14e7SShri Abhyankar #include <petscthreadcomm.h>
14bd8b14e7SShri Abhyankar 
15a9f03627SSatish Balay #if defined(PETSC_USE_LOG)
1609573ac7SBarry Smith extern PetscErrorCode PetscLogBegin_Private(void);
17a9f03627SSatish Balay #endif
1885afcc9aSBarry Smith extern PetscBool PetscHMPIWorker;
19f2d66bcaSShri Abhyankar 
202d53ad75SBarry Smith #if defined(PETSC_SERIALIZE_FUNCTIONS)
212d53ad75SBarry Smith PetscFPT PetscFPTData = 0;
222d53ad75SBarry Smith #endif
232d53ad75SBarry Smith 
24a6790183SBarry Smith #if defined(PETSC_HAVE_SAWS)
2516ad0300SBarry Smith #include <petscviewersaws.h>
26a6790183SBarry Smith #endif
27e5c89e4eSSatish Balay /* -----------------------------------------------------------------------------------------*/
28e5c89e4eSSatish Balay 
29e5c89e4eSSatish Balay extern FILE *petsc_history;
30e5c89e4eSSatish Balay 
3109573ac7SBarry Smith extern PetscErrorCode PetscInitialize_DynamicLibraries(void);
3209573ac7SBarry Smith extern PetscErrorCode PetscFinalize_DynamicLibraries(void);
3337e93019SBarry Smith extern PetscErrorCode PetscFunctionListPrintAll(void);
3409573ac7SBarry Smith extern PetscErrorCode PetscSequentialPhaseBegin_Private(MPI_Comm,int);
3509573ac7SBarry Smith extern PetscErrorCode PetscSequentialPhaseEnd_Private(MPI_Comm,int);
3609573ac7SBarry Smith extern PetscErrorCode PetscCloseHistoryFile(FILE**);
370069ddf5SShri Abhyankar 
38e5c89e4eSSatish Balay /* user may set this BEFORE calling PetscInitialize() */
39e8373e55SMatthew Knepley MPI_Comm PETSC_COMM_WORLD = MPI_COMM_NULL;
40e5c89e4eSSatish Balay 
41480cf27aSJed Brown PetscMPIInt Petsc_Counter_keyval   = MPI_KEYVAL_INVALID;
42480cf27aSJed Brown PetscMPIInt Petsc_InnerComm_keyval = MPI_KEYVAL_INVALID;
43480cf27aSJed Brown PetscMPIInt Petsc_OuterComm_keyval = MPI_KEYVAL_INVALID;
44480cf27aSJed Brown 
45e5c89e4eSSatish Balay /*
46e5c89e4eSSatish Balay      Declare and set all the string names of the PETSc enums
47e5c89e4eSSatish Balay */
486a6fc655SJed Brown const char *const PetscBools[]     = {"FALSE","TRUE","PetscBool","PETSC_",0};
496a6fc655SJed Brown const char *const PetscCopyModes[] = {"COPY_VALUES","OWN_POINTER","USE_POINTER","PetscCopyMode","PETSC_",0};
506a6fc655SJed Brown const char *const PetscDataTypes[] = {"INT","DOUBLE","COMPLEX","LONG","SHORT","FLOAT",
512d53ad75SBarry Smith                                       "CHAR","LOGICAL","ENUM","BOOL","LONGDOUBLE","OBJECT","FUNCTION","PetscDataType","PETSC_",0};
52e5c89e4eSSatish Balay 
53ace3abfcSBarry Smith PetscBool PetscPreLoadingUsed = PETSC_FALSE;
54ace3abfcSBarry Smith PetscBool PetscPreLoadingOn   = PETSC_FALSE;
550f8e0872SSatish Balay 
56a2f94806SJed Brown PetscInt PetscHotRegionDepth;
57a2f94806SJed Brown 
58e5c89e4eSSatish Balay /*
59e5c89e4eSSatish Balay        Checks the options database for initializations related to the
60e5c89e4eSSatish Balay     PETSc components
61e5c89e4eSSatish Balay */
62e5c89e4eSSatish Balay #undef __FUNCT__
63e5c89e4eSSatish Balay #define __FUNCT__ "PetscOptionsCheckInitial_Components"
647087cfbeSBarry Smith PetscErrorCode  PetscOptionsCheckInitial_Components(void)
65e5c89e4eSSatish Balay {
66ace3abfcSBarry Smith   PetscBool      flg1;
67e5c89e4eSSatish Balay   PetscErrorCode ierr;
68e5c89e4eSSatish Balay 
69e5c89e4eSSatish Balay   PetscFunctionBegin;
700298fd71SBarry Smith   ierr = PetscOptionsHasName(NULL,"-help",&flg1);CHKERRQ(ierr);
71e5c89e4eSSatish Balay   if (flg1) {
72e5c89e4eSSatish Balay #if defined(PETSC_USE_LOG)
73e8e7597cSSatish Balay     MPI_Comm comm = PETSC_COMM_WORLD;
74e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm,"------Additional PETSc component options--------\n");CHKERRQ(ierr);
75e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm," -log_summary_exclude: <vec,mat,pc.ksp,snes>\n");CHKERRQ(ierr);
766cf91177SBarry Smith     ierr = (*PetscHelpPrintf)(comm," -info_exclude: <null,vec,mat,pc,ksp,snes,ts>\n");CHKERRQ(ierr);
77e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm,"-----------------------------------------------\n");CHKERRQ(ierr);
78e5c89e4eSSatish Balay #endif
79e5c89e4eSSatish Balay   }
80e5c89e4eSSatish Balay   PetscFunctionReturn(0);
81e5c89e4eSSatish Balay }
82e5c89e4eSSatish Balay 
83e5c89e4eSSatish Balay #undef __FUNCT__
84945d1669SBarry Smith #define __FUNCT__ "PetscInitializeNoPointers"
850f11a792SBarry Smith /*
86945d1669SBarry Smith       PetscInitializeNoPointers - Calls PetscInitialize() from C/C++ without the pointers to argc and args
8772a42c3cSBarry Smith 
8872a42c3cSBarry Smith    Collective
8972a42c3cSBarry Smith 
9072a42c3cSBarry Smith    Level: advanced
9172a42c3cSBarry Smith 
92945d1669SBarry Smith     Notes: this is called only by the PETSc MATLAB and Julia interface. Even though it might start MPI it sets the flag to
930f11a792SBarry Smith      indicate that it did NOT start MPI so that the PetscFinalize() does not end MPI, thus allowing PetscInitialize() to
94945d1669SBarry Smith      be called multiple times from MATLAB and Julia without the problem of trying to initialize MPI more than once.
950f11a792SBarry Smith 
961ea5a559SBarry Smith      Turns off PETSc signal handling because that can interact with MATLAB's signal handling causing random crashes.
971ea5a559SBarry Smith 
9872a42c3cSBarry Smith .seealso: PetscInitialize(), PetscInitializeFortran(), PetscInitializeNoArguments()
990f11a792SBarry Smith */
100945d1669SBarry Smith PetscErrorCode  PetscInitializeNoPointers(int argc,char **args,const char *filename,const char *help)
10172a42c3cSBarry Smith {
10272a42c3cSBarry Smith   PetscErrorCode ierr;
10372a42c3cSBarry Smith   int            myargc   = argc;
10472a42c3cSBarry Smith   char           **myargs = args;
10572a42c3cSBarry Smith 
10672a42c3cSBarry Smith   PetscFunctionBegin;
1073bf036e2SBarry Smith   ierr = PetscInitialize(&myargc,&myargs,filename,help);CHKERRQ(ierr);
1081ea5a559SBarry Smith   ierr = PetscPopSignalHandler();CHKERRQ(ierr);
109df413903SBarry Smith   PetscBeganMPI = PETSC_FALSE;
11072a42c3cSBarry Smith   PetscFunctionReturn(ierr);
11172a42c3cSBarry Smith }
11272a42c3cSBarry Smith 
11372a42c3cSBarry Smith #undef __FUNCT__
114945d1669SBarry Smith #define __FUNCT__ "PetscGetPETSC_COMM_SELF"
115f0865b08SBarry Smith /*
116945d1669SBarry Smith       Used by MATLAB and Julia interface to get communicator
117f0865b08SBarry Smith */
118945d1669SBarry Smith PetscErrorCode  PetscGetPETSC_COMM_SELF(MPI_Comm *comm)
119f0865b08SBarry Smith {
120f0865b08SBarry Smith   PetscFunctionBegin;
121f0865b08SBarry Smith   *comm = PETSC_COMM_SELF;
122f0865b08SBarry Smith   PetscFunctionReturn(0);
123f0865b08SBarry Smith }
124f0865b08SBarry Smith 
125f0865b08SBarry Smith #undef __FUNCT__
126e5c89e4eSSatish Balay #define __FUNCT__ "PetscInitializeNoArguments"
127e5c89e4eSSatish Balay /*@C
128e5c89e4eSSatish Balay       PetscInitializeNoArguments - Calls PetscInitialize() from C/C++ without
129e5c89e4eSSatish Balay         the command line arguments.
130e5c89e4eSSatish Balay 
131e5c89e4eSSatish Balay    Collective
132e5c89e4eSSatish Balay 
133e5c89e4eSSatish Balay    Level: advanced
134e5c89e4eSSatish Balay 
135e5c89e4eSSatish Balay .seealso: PetscInitialize(), PetscInitializeFortran()
136e5c89e4eSSatish Balay @*/
1377087cfbeSBarry Smith PetscErrorCode  PetscInitializeNoArguments(void)
138e5c89e4eSSatish Balay {
139e5c89e4eSSatish Balay   PetscErrorCode ierr;
140e5c89e4eSSatish Balay   int            argc   = 0;
141e5c89e4eSSatish Balay   char           **args = 0;
142e5c89e4eSSatish Balay 
143e5c89e4eSSatish Balay   PetscFunctionBegin;
1440298fd71SBarry Smith   ierr = PetscInitialize(&argc,&args,NULL,NULL);
145e5c89e4eSSatish Balay   PetscFunctionReturn(ierr);
146e5c89e4eSSatish Balay }
147e5c89e4eSSatish Balay 
148e5c89e4eSSatish Balay #undef __FUNCT__
149e5c89e4eSSatish Balay #define __FUNCT__ "PetscInitialized"
150e5c89e4eSSatish Balay /*@
151e5c89e4eSSatish Balay       PetscInitialized - Determine whether PETSc is initialized.
152e5c89e4eSSatish Balay 
15393b6d2d1SJed Brown    Level: beginner
154e5c89e4eSSatish Balay 
155e5c89e4eSSatish Balay .seealso: PetscInitialize(), PetscInitializeNoArguments(), PetscInitializeFortran()
156e5c89e4eSSatish Balay @*/
1577087cfbeSBarry Smith PetscErrorCode PetscInitialized(PetscBool  *isInitialized)
158e5c89e4eSSatish Balay {
159e5c89e4eSSatish Balay   *isInitialized = PetscInitializeCalled;
16093b6d2d1SJed Brown   return 0;
161e5c89e4eSSatish Balay }
162e5c89e4eSSatish Balay 
163e5c89e4eSSatish Balay #undef __FUNCT__
164e5c89e4eSSatish Balay #define __FUNCT__ "PetscFinalized"
165e5c89e4eSSatish Balay /*@
166e5c89e4eSSatish Balay       PetscFinalized - Determine whether PetscFinalize() has been called yet
167e5c89e4eSSatish Balay 
168e5c89e4eSSatish Balay    Level: developer
169e5c89e4eSSatish Balay 
170e5c89e4eSSatish Balay .seealso: PetscInitialize(), PetscInitializeNoArguments(), PetscInitializeFortran()
171e5c89e4eSSatish Balay @*/
1727087cfbeSBarry Smith PetscErrorCode  PetscFinalized(PetscBool  *isFinalized)
173e5c89e4eSSatish Balay {
174e5c89e4eSSatish Balay   *isFinalized = PetscFinalizeCalled;
17593b6d2d1SJed Brown   return 0;
176e5c89e4eSSatish Balay }
177e5c89e4eSSatish Balay 
17809573ac7SBarry Smith extern PetscErrorCode PetscOptionsCheckInitial_Private(void);
179e5c89e4eSSatish Balay 
180e5c89e4eSSatish Balay /*
181e5c89e4eSSatish Balay        This function is the MPI reduction operation used to compute the sum of the
182e5c89e4eSSatish Balay    first half of the datatype and the max of the second half.
183e5c89e4eSSatish Balay */
184e5c89e4eSSatish Balay MPI_Op PetscMaxSum_Op = 0;
185e5c89e4eSSatish Balay 
186e5c89e4eSSatish Balay #undef __FUNCT__
187e5c89e4eSSatish Balay #define __FUNCT__ "PetscMaxSum_Local"
1888cc058d9SJed Brown PETSC_EXTERN void MPIAPI PetscMaxSum_Local(void *in,void *out,int *cnt,MPI_Datatype *datatype)
189e5c89e4eSSatish Balay {
190e5c89e4eSSatish Balay   PetscInt *xin = (PetscInt*)in,*xout = (PetscInt*)out,i,count = *cnt;
191e5c89e4eSSatish Balay 
192e5c89e4eSSatish Balay   PetscFunctionBegin;
193e5c89e4eSSatish Balay   if (*datatype != MPIU_2INT) {
194e5c89e4eSSatish Balay     (*PetscErrorPrintf)("Can only handle MPIU_2INT data types");
195e5c89e4eSSatish Balay     MPI_Abort(MPI_COMM_WORLD,1);
196e5c89e4eSSatish Balay   }
197e5c89e4eSSatish Balay 
198e5c89e4eSSatish Balay   for (i=0; i<count; i++) {
199e5c89e4eSSatish Balay     xout[2*i]    = PetscMax(xout[2*i],xin[2*i]);
200e5c89e4eSSatish Balay     xout[2*i+1] += xin[2*i+1];
201e5c89e4eSSatish Balay   }
202812af9f3SBarry Smith   PetscFunctionReturnVoid();
203e5c89e4eSSatish Balay }
204e5c89e4eSSatish Balay 
205e5c89e4eSSatish Balay /*
206e5c89e4eSSatish Balay     Returns the max of the first entry owned by this processor and the
207e5c89e4eSSatish Balay sum of the second entry.
208b693b147SBarry Smith 
209b693b147SBarry Smith     The reason nprocs[2*i] contains lengths nprocs[2*i+1] contains flag of 1 if length is nonzero
210b693b147SBarry Smith is so that the PetscMaxSum_Op() can set TWO values, if we passed in only nprocs[i] with lengths
211b693b147SBarry Smith there would be no place to store the both needed results.
212e5c89e4eSSatish Balay */
213e5c89e4eSSatish Balay #undef __FUNCT__
214e5c89e4eSSatish Balay #define __FUNCT__ "PetscMaxSum"
2157087cfbeSBarry Smith PetscErrorCode  PetscMaxSum(MPI_Comm comm,const PetscInt nprocs[],PetscInt *max,PetscInt *sum)
216e5c89e4eSSatish Balay {
217e5c89e4eSSatish Balay   PetscErrorCode ierr;
218e5c89e4eSSatish Balay 
219e5c89e4eSSatish Balay   PetscFunctionBegin;
220*d6e4c47cSJed Brown #if defined(PETSC_HAVE_MPI_REDUCE_SCATTER_BLOCK)
221*d6e4c47cSJed Brown   {
222*d6e4c47cSJed Brown     struct {PetscInt max,sum;} work;
223*d6e4c47cSJed Brown     ierr = MPI_Reduce_scatter_block((void*)nprocs,&work,1,MPIU_2INT,PetscMaxSum_Op,comm);CHKERRQ(ierr);
224*d6e4c47cSJed Brown     *max = work.max;
225*d6e4c47cSJed Brown     *sum = work.sum;
226*d6e4c47cSJed Brown   }
227*d6e4c47cSJed Brown #else
228*d6e4c47cSJed Brown   {
229*d6e4c47cSJed Brown     PetscMPIInt    size,rank;
230*d6e4c47cSJed Brown     struct {PetscInt max,sum;} *work;
231e5c89e4eSSatish Balay     ierr = MPI_Comm_size(comm,&size);CHKERRQ(ierr);
232e5c89e4eSSatish Balay     ierr = MPI_Comm_rank(comm,&rank);CHKERRQ(ierr);
233785e854fSJed Brown     ierr = PetscMalloc1(size,&work);CHKERRQ(ierr);
234e5c89e4eSSatish Balay     ierr = MPI_Allreduce((void*)nprocs,work,size,MPIU_2INT,PetscMaxSum_Op,comm);CHKERRQ(ierr);
2356ac3741eSJed Brown     *max = work[rank].max;
2366ac3741eSJed Brown     *sum = work[rank].sum;
237e5c89e4eSSatish Balay     ierr = PetscFree(work);CHKERRQ(ierr);
238*d6e4c47cSJed Brown   }
239*d6e4c47cSJed Brown #endif
240e5c89e4eSSatish Balay   PetscFunctionReturn(0);
241e5c89e4eSSatish Balay }
242e5c89e4eSSatish Balay 
243e5c89e4eSSatish Balay /* ----------------------------------------------------------------------------*/
2447087cfbeSBarry Smith MPI_Op  PetscADMax_Op = 0;
245e5c89e4eSSatish Balay 
246e5c89e4eSSatish Balay #undef __FUNCT__
247e5c89e4eSSatish Balay #define __FUNCT__ "PetscADMax_Local"
2488cc058d9SJed Brown PETSC_EXTERN void MPIAPI PetscADMax_Local(void *in,void *out,PetscMPIInt *cnt,MPI_Datatype *datatype)
249e5c89e4eSSatish Balay {
250e5c89e4eSSatish Balay   PetscScalar *xin = (PetscScalar*)in,*xout = (PetscScalar*)out;
251e5c89e4eSSatish Balay   PetscInt    i,count = *cnt;
252e5c89e4eSSatish Balay 
253e5c89e4eSSatish Balay   PetscFunctionBegin;
254e5c89e4eSSatish Balay   if (*datatype != MPIU_2SCALAR) {
255e5c89e4eSSatish Balay     (*PetscErrorPrintf)("Can only handle MPIU_2SCALAR data (i.e. double or complex) types");
256e5c89e4eSSatish Balay     MPI_Abort(MPI_COMM_WORLD,1);
257e5c89e4eSSatish Balay   }
258e5c89e4eSSatish Balay 
259e5c89e4eSSatish Balay   for (i=0; i<count; i++) {
260e5c89e4eSSatish Balay     if (PetscRealPart(xout[2*i]) < PetscRealPart(xin[2*i])) {
261e5c89e4eSSatish Balay       xout[2*i]   = xin[2*i];
262e5c89e4eSSatish Balay       xout[2*i+1] = xin[2*i+1];
263e5c89e4eSSatish Balay     }
264e5c89e4eSSatish Balay   }
265812af9f3SBarry Smith   PetscFunctionReturnVoid();
266e5c89e4eSSatish Balay }
267e5c89e4eSSatish Balay 
2687087cfbeSBarry Smith MPI_Op PetscADMin_Op = 0;
269e5c89e4eSSatish Balay 
270e5c89e4eSSatish Balay #undef __FUNCT__
271e5c89e4eSSatish Balay #define __FUNCT__ "PetscADMin_Local"
2728cc058d9SJed Brown PETSC_EXTERN void MPIAPI PetscADMin_Local(void *in,void *out,PetscMPIInt *cnt,MPI_Datatype *datatype)
273e5c89e4eSSatish Balay {
274e5c89e4eSSatish Balay   PetscScalar *xin = (PetscScalar*)in,*xout = (PetscScalar*)out;
275e5c89e4eSSatish Balay   PetscInt    i,count = *cnt;
276e5c89e4eSSatish Balay 
277e5c89e4eSSatish Balay   PetscFunctionBegin;
278e5c89e4eSSatish Balay   if (*datatype != MPIU_2SCALAR) {
279e5c89e4eSSatish Balay     (*PetscErrorPrintf)("Can only handle MPIU_2SCALAR data (i.e. double or complex) types");
280e5c89e4eSSatish Balay     MPI_Abort(MPI_COMM_WORLD,1);
281e5c89e4eSSatish Balay   }
282e5c89e4eSSatish Balay 
283e5c89e4eSSatish Balay   for (i=0; i<count; i++) {
284e5c89e4eSSatish Balay     if (PetscRealPart(xout[2*i]) > PetscRealPart(xin[2*i])) {
285e5c89e4eSSatish Balay       xout[2*i]   = xin[2*i];
286e5c89e4eSSatish Balay       xout[2*i+1] = xin[2*i+1];
287e5c89e4eSSatish Balay     }
288e5c89e4eSSatish Balay   }
289812af9f3SBarry Smith   PetscFunctionReturnVoid();
290e5c89e4eSSatish Balay }
291e5c89e4eSSatish Balay /* ---------------------------------------------------------------------------------------*/
292e5c89e4eSSatish Balay 
2937c2de775SJed Brown #if (defined(PETSC_HAVE_COMPLEX) && !defined(PETSC_HAVE_MPI_C_DOUBLE_COMPLEX)) || defined(PETSC_USE_REAL___FLOAT128)
29406a205a8SBarry Smith MPI_Op MPIU_SUM = 0;
295e5c89e4eSSatish Balay 
296e5c89e4eSSatish Balay #undef __FUNCT__
297e5c89e4eSSatish Balay #define __FUNCT__ "PetscSum_Local"
2988cc058d9SJed Brown PETSC_EXTERN void PetscSum_Local(void *in,void *out,PetscMPIInt *cnt,MPI_Datatype *datatype)
299e5c89e4eSSatish Balay {
300e5c89e4eSSatish Balay   PetscInt i,count = *cnt;
301e5c89e4eSSatish Balay 
302e5c89e4eSSatish Balay   PetscFunctionBegin;
3037c2de775SJed Brown   if (*datatype == MPIU_REAL) {
304e2e03761SBarry Smith     PetscReal *xin = (PetscReal*)in,*xout = (PetscReal*)out;
305a297a907SKarl Rupp     for (i=0; i<count; i++) xout[i] += xin[i];
3067c2de775SJed Brown   }
3077c2de775SJed Brown #if defined(PETSC_HAVE_COMPLEX)
3087c2de775SJed Brown   else if (*datatype == MPIU_COMPLEX) {
3097c2de775SJed Brown     PetscComplex *xin = (PetscComplex*)in,*xout = (PetscComplex*)out;
310a297a907SKarl Rupp     for (i=0; i<count; i++) xout[i] += xin[i];
3117c2de775SJed Brown   }
3127c2de775SJed Brown #endif
3137c2de775SJed Brown   else {
3147c2de775SJed Brown     (*PetscErrorPrintf)("Can only handle MPIU_REAL or MPIU_COMPLEX data types");
315e2e03761SBarry Smith     MPI_Abort(MPI_COMM_WORLD,1);
316e2e03761SBarry Smith   }
317812af9f3SBarry Smith   PetscFunctionReturnVoid();
318e5c89e4eSSatish Balay }
319e5c89e4eSSatish Balay #endif
320e5c89e4eSSatish Balay 
321ce63c4c1SBarry Smith #if defined(PETSC_USE_REAL___FLOAT128)
322d9822059SBarry Smith MPI_Op MPIU_MAX = 0;
323d9822059SBarry Smith MPI_Op MPIU_MIN = 0;
324d9822059SBarry Smith 
325d9822059SBarry Smith #undef __FUNCT__
326d9822059SBarry Smith #define __FUNCT__ "PetscMax_Local"
3278cc058d9SJed Brown PETSC_EXTERN void PetscMax_Local(void *in,void *out,PetscMPIInt *cnt,MPI_Datatype *datatype)
328d9822059SBarry Smith {
329d9822059SBarry Smith   PetscInt i,count = *cnt;
330d9822059SBarry Smith 
331d9822059SBarry Smith   PetscFunctionBegin;
3327c2de775SJed Brown   if (*datatype == MPIU_REAL) {
3338c764dc5SJose Roman     PetscReal *xin = (PetscReal*)in,*xout = (PetscReal*)out;
334a297a907SKarl Rupp     for (i=0; i<count; i++) xout[i] = PetscMax(xout[i],xin[i]);
3357c2de775SJed Brown   }
3367c2de775SJed Brown #if defined(PETSC_HAVE_COMPLEX)
3377c2de775SJed Brown   else if (*datatype == MPIU_COMPLEX) {
3387c2de775SJed Brown     PetscComplex *xin = (PetscComplex*)in,*xout = (PetscComplex*)out;
3397c2de775SJed Brown     for (i=0; i<count; i++) {
3407c2de775SJed Brown       xout[i] = PetscRealPartComplex(xout[i])<PetscRealPartComplex(xin[i]) ? xin[i] : xout[i];
3417c2de775SJed Brown     }
3427c2de775SJed Brown   }
3437c2de775SJed Brown #endif
3447c2de775SJed Brown   else {
3457c2de775SJed Brown     (*PetscErrorPrintf)("Can only handle MPIU_REAL or MPIU_COMPLEX data types");
3468c764dc5SJose Roman     MPI_Abort(MPI_COMM_WORLD,1);
3478c764dc5SJose Roman   }
348d9822059SBarry Smith   PetscFunctionReturnVoid();
349d9822059SBarry Smith }
350d9822059SBarry Smith 
351d9822059SBarry Smith #undef __FUNCT__
352d9822059SBarry Smith #define __FUNCT__ "PetscMin_Local"
3538cc058d9SJed Brown PETSC_EXTERN void PetscMin_Local(void *in,void *out,PetscMPIInt *cnt,MPI_Datatype *datatype)
354d9822059SBarry Smith {
355d9822059SBarry Smith   PetscInt    i,count = *cnt;
356d9822059SBarry Smith 
357d9822059SBarry Smith   PetscFunctionBegin;
3587c2de775SJed Brown   if (*datatype == MPIU_REAL) {
3598c764dc5SJose Roman     PetscReal *xin = (PetscReal*)in,*xout = (PetscReal*)out;
360a297a907SKarl Rupp     for (i=0; i<count; i++) xout[i] = PetscMin(xout[i],xin[i]);
3617c2de775SJed Brown   }
3627c2de775SJed Brown #if defined(PETSC_HAVE_COMPLEX)
3637c2de775SJed Brown   else if (*datatype == MPIU_COMPLEX) {
3647c2de775SJed Brown     PetscComplex *xin = (PetscComplex*)in,*xout = (PetscComplex*)out;
3657c2de775SJed Brown     for (i=0; i<count; i++) {
3667c2de775SJed Brown       xout[i] = PetscRealPartComplex(xout[i])>PetscRealPartComplex(xin[i]) ? xin[i] : xout[i];
3677c2de775SJed Brown     }
3687c2de775SJed Brown   }
3697c2de775SJed Brown #endif
3707c2de775SJed Brown   else {
3718c764dc5SJose Roman     (*PetscErrorPrintf)("Can only handle MPIU_REAL or MPIU_SCALAR data (i.e. double or complex) types");
3728c764dc5SJose Roman     MPI_Abort(MPI_COMM_WORLD,1);
3738c764dc5SJose Roman   }
374d9822059SBarry Smith   PetscFunctionReturnVoid();
375d9822059SBarry Smith }
376d9822059SBarry Smith #endif
377d9822059SBarry Smith 
378480cf27aSJed Brown #undef __FUNCT__
379480cf27aSJed Brown #define __FUNCT__ "Petsc_DelCounter"
380480cf27aSJed Brown /*
381480cf27aSJed Brown    Private routine to delete internal tag/name counter storage when a communicator is freed.
382480cf27aSJed Brown 
383ff0e51ddSBarry 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.
384480cf27aSJed Brown 
385480cf27aSJed Brown    Note: this is declared extern "C" because it is passed to MPI_Keyval_create()
386480cf27aSJed Brown 
387480cf27aSJed Brown */
3888cc058d9SJed Brown PETSC_EXTERN PetscMPIInt MPIAPI Petsc_DelCounter(MPI_Comm comm,PetscMPIInt keyval,void *count_val,void *extra_state)
389480cf27aSJed Brown {
390480cf27aSJed Brown   PetscErrorCode ierr;
391480cf27aSJed Brown 
392480cf27aSJed Brown   PetscFunctionBegin;
393480cf27aSJed Brown   ierr = PetscInfo1(0,"Deleting counter data in an MPI_Comm %ld\n",(long)comm);if (ierr) PetscFunctionReturn((PetscMPIInt)ierr);
394480cf27aSJed Brown   ierr = PetscFree(count_val);if (ierr) PetscFunctionReturn((PetscMPIInt)ierr);
395480cf27aSJed Brown   PetscFunctionReturn(MPI_SUCCESS);
396480cf27aSJed Brown }
397480cf27aSJed Brown 
398480cf27aSJed Brown #undef __FUNCT__
399da3039f7SJed Brown #define __FUNCT__ "Petsc_DelComm_Outer"
400480cf27aSJed Brown /*
401da3039f7SJed Brown   This is invoked on the outer comm as a result of either PetscCommDestroy() (via MPI_Attr_delete) or when the user
402da3039f7SJed Brown   calls MPI_Comm_free().
403da3039f7SJed Brown 
404da3039f7SJed Brown   This is the only entry point for breaking the links between inner and outer comms.
405480cf27aSJed Brown 
406ff0e51ddSBarry Smith   This is called by MPI, not by users. This is called when MPI_Comm_free() is called on the communicator.
407480cf27aSJed Brown 
408480cf27aSJed Brown   Note: this is declared extern "C" because it is passed to MPI_Keyval_create()
409480cf27aSJed Brown 
410480cf27aSJed Brown */
411da3039f7SJed Brown PETSC_EXTERN PetscMPIInt MPIAPI Petsc_DelComm_Outer(MPI_Comm comm,PetscMPIInt keyval,void *attr_val,void *extra_state)
412480cf27aSJed Brown {
413480cf27aSJed Brown   PetscErrorCode ierr;
414b89831e5SBarry Smith   PetscMPIInt    flg;
415265f3f35SJed Brown   union {MPI_Comm comm; void *ptr;} icomm,ocomm;
416480cf27aSJed Brown 
417480cf27aSJed Brown   PetscFunctionBegin;
418da3039f7SJed Brown   if (keyval != Petsc_InnerComm_keyval) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_CORRUPT,"Unexpected keyval");
419ec4fadc2SJed Brown   icomm.ptr = attr_val;
420da3039f7SJed Brown 
421265f3f35SJed Brown   ierr = MPI_Attr_get(icomm.comm,Petsc_OuterComm_keyval,&ocomm,&flg);CHKERRQ(ierr);
422b3ef52cdSBarry Smith   if (!flg) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_CORRUPT,"Inner MPI_Comm does not have expected reference to outer comm");
423da3039f7SJed Brown   if (ocomm.comm != comm) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_CORRUPT,"Inner MPI_Comm has reference to non-matching outer comm");
424da3039f7SJed Brown   ierr = MPI_Attr_delete(icomm.comm,Petsc_OuterComm_keyval);CHKERRQ(ierr); /* Calls Petsc_DelComm_Inner */
425da3039f7SJed 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);
426da3039f7SJed Brown   PetscFunctionReturn(MPI_SUCCESS);
427b89831e5SBarry Smith }
428da3039f7SJed Brown 
429da3039f7SJed Brown #undef __FUNCT__
430da3039f7SJed Brown #define __FUNCT__ "Petsc_DelComm_Inner"
431da3039f7SJed Brown /*
432da3039f7SJed Brown  * This is invoked on the inner comm when Petsc_DelComm_Outer calls MPI_Attr_delete.  It should not be reached any other way.
433da3039f7SJed Brown  */
434da3039f7SJed Brown PETSC_EXTERN PetscMPIInt MPIAPI Petsc_DelComm_Inner(MPI_Comm comm,PetscMPIInt keyval,void *attr_val,void *extra_state)
435da3039f7SJed Brown {
436da3039f7SJed Brown   PetscErrorCode ierr;
437da3039f7SJed Brown 
438da3039f7SJed Brown   PetscFunctionBegin;
439da3039f7SJed Brown   ierr = PetscInfo1(0,"Removing reference to PETSc communicator embedded in a user MPI_Comm %ld\n",(long)comm);if (ierr) PetscFunctionReturn((PetscMPIInt)ierr);
440480cf27aSJed Brown   PetscFunctionReturn(MPI_SUCCESS);
441480cf27aSJed Brown }
442480cf27aSJed Brown 
443951e3c8eSBarry Smith #if defined(PETSC_USE_PETSC_MPI_EXTERNAL32)
444e39fd77fSBarry Smith #if !defined(PETSC_WORDS_BIGENDIAN)
4458cc058d9SJed Brown PETSC_EXTERN PetscMPIInt PetscDataRep_extent_fn(MPI_Datatype,MPI_Aint*,void*);
4468cc058d9SJed Brown PETSC_EXTERN PetscMPIInt PetscDataRep_read_conv_fn(void*, MPI_Datatype,PetscMPIInt,void*,MPI_Offset,void*);
4478cc058d9SJed Brown PETSC_EXTERN PetscMPIInt PetscDataRep_write_conv_fn(void*, MPI_Datatype,PetscMPIInt,void*,MPI_Offset,void*);
448e39fd77fSBarry Smith #endif
449951e3c8eSBarry Smith #endif
450e39fd77fSBarry Smith 
4516ae9a8a6SBarry Smith int  PetscGlobalArgc   = 0;
4526ae9a8a6SBarry Smith char **PetscGlobalArgs = 0;
453dff31646SBarry Smith PetscSegBuffer PetscCitationsList;
454e5c89e4eSSatish Balay 
455e5c89e4eSSatish Balay #undef __FUNCT__
456051e4cf2SJed Brown #define __FUNCT__ "PetscCitationsInitialize"
457051e4cf2SJed Brown PetscErrorCode PetscCitationsInitialize()
458051e4cf2SJed Brown {
459051e4cf2SJed Brown   PetscErrorCode ierr;
460051e4cf2SJed Brown 
461051e4cf2SJed Brown   PetscFunctionBegin;
462051e4cf2SJed Brown   ierr = PetscSegBufferCreate(1,10000,&PetscCitationsList);CHKERRQ(ierr);
463051e4cf2SJed 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);
464051e4cf2SJed 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);
465051e4cf2SJed Brown   PetscFunctionReturn(0);
466051e4cf2SJed Brown }
467e5c89e4eSSatish Balay 
468e5c89e4eSSatish Balay #undef __FUNCT__
469e5c89e4eSSatish Balay #define __FUNCT__ "PetscGetArgs"
470e5c89e4eSSatish Balay /*@C
471e5c89e4eSSatish Balay    PetscGetArgs - Allows you to access the raw command line arguments anywhere
472e5c89e4eSSatish Balay      after PetscInitialize() is called but before PetscFinalize().
473e5c89e4eSSatish Balay 
474e5c89e4eSSatish Balay    Not Collective
475e5c89e4eSSatish Balay 
476e5c89e4eSSatish Balay    Output Parameters:
477e5c89e4eSSatish Balay +  argc - count of number of command line arguments
478e5c89e4eSSatish Balay -  args - the command line arguments
479e5c89e4eSSatish Balay 
480e5c89e4eSSatish Balay    Level: intermediate
481e5c89e4eSSatish Balay 
482e5c89e4eSSatish Balay    Notes:
483e5c89e4eSSatish Balay       This is usually used to pass the command line arguments into other libraries
484e5c89e4eSSatish Balay    that are called internally deep in PETSc or the application.
485e5c89e4eSSatish Balay 
486f177e3b1SBarry Smith       The first argument contains the program name as is normal for C arguments.
487f177e3b1SBarry Smith 
488e5c89e4eSSatish Balay    Concepts: command line arguments
489e5c89e4eSSatish Balay 
490793721a6SBarry Smith .seealso: PetscFinalize(), PetscInitializeFortran(), PetscGetArguments()
491e5c89e4eSSatish Balay 
492e5c89e4eSSatish Balay @*/
4937087cfbeSBarry Smith PetscErrorCode  PetscGetArgs(int *argc,char ***args)
494e5c89e4eSSatish Balay {
495e5c89e4eSSatish Balay   PetscFunctionBegin;
49617186662SBarry Smith   if (!PetscInitializeCalled && PetscFinalizeCalled) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ORDER,"You must call after PetscInitialize() but before PetscFinalize()");
497e5c89e4eSSatish Balay   *argc = PetscGlobalArgc;
498e5c89e4eSSatish Balay   *args = PetscGlobalArgs;
499e5c89e4eSSatish Balay   PetscFunctionReturn(0);
500e5c89e4eSSatish Balay }
501e5c89e4eSSatish Balay 
502e5c89e4eSSatish Balay #undef __FUNCT__
503793721a6SBarry Smith #define __FUNCT__ "PetscGetArguments"
504793721a6SBarry Smith /*@C
505793721a6SBarry Smith    PetscGetArguments - Allows you to access the  command line arguments anywhere
506793721a6SBarry Smith      after PetscInitialize() is called but before PetscFinalize().
507793721a6SBarry Smith 
508793721a6SBarry Smith    Not Collective
509793721a6SBarry Smith 
510793721a6SBarry Smith    Output Parameters:
511793721a6SBarry Smith .  args - the command line arguments
512793721a6SBarry Smith 
513793721a6SBarry Smith    Level: intermediate
514793721a6SBarry Smith 
515793721a6SBarry Smith    Notes:
516793721a6SBarry Smith       This does NOT start with the program name and IS null terminated (final arg is void)
517793721a6SBarry Smith 
518793721a6SBarry Smith    Concepts: command line arguments
519793721a6SBarry Smith 
520793721a6SBarry Smith .seealso: PetscFinalize(), PetscInitializeFortran(), PetscGetArgs(), PetscFreeArguments()
521793721a6SBarry Smith 
522793721a6SBarry Smith @*/
5237087cfbeSBarry Smith PetscErrorCode  PetscGetArguments(char ***args)
524793721a6SBarry Smith {
525793721a6SBarry Smith   PetscInt       i,argc = PetscGlobalArgc;
526793721a6SBarry Smith   PetscErrorCode ierr;
527793721a6SBarry Smith 
528793721a6SBarry Smith   PetscFunctionBegin;
52917186662SBarry Smith   if (!PetscInitializeCalled && PetscFinalizeCalled) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ORDER,"You must call after PetscInitialize() but before PetscFinalize()");
530717030eeSLisandro Dalcin   if (!argc) {*args = 0; PetscFunctionReturn(0);}
531785e854fSJed Brown   ierr = PetscMalloc1(argc,args);CHKERRQ(ierr);
532793721a6SBarry Smith   for (i=0; i<argc-1; i++) {
533793721a6SBarry Smith     ierr = PetscStrallocpy(PetscGlobalArgs[i+1],&(*args)[i]);CHKERRQ(ierr);
534793721a6SBarry Smith   }
535793721a6SBarry Smith   (*args)[argc-1] = 0;
536793721a6SBarry Smith   PetscFunctionReturn(0);
537793721a6SBarry Smith }
538793721a6SBarry Smith 
539793721a6SBarry Smith #undef __FUNCT__
540793721a6SBarry Smith #define __FUNCT__ "PetscFreeArguments"
541793721a6SBarry Smith /*@C
542793721a6SBarry Smith    PetscFreeArguments - Frees the memory obtained with PetscGetArguments()
543793721a6SBarry Smith 
544793721a6SBarry Smith    Not Collective
545793721a6SBarry Smith 
546793721a6SBarry Smith    Output Parameters:
547793721a6SBarry Smith .  args - the command line arguments
548793721a6SBarry Smith 
549793721a6SBarry Smith    Level: intermediate
550793721a6SBarry Smith 
551793721a6SBarry Smith    Concepts: command line arguments
552793721a6SBarry Smith 
553793721a6SBarry Smith .seealso: PetscFinalize(), PetscInitializeFortran(), PetscGetArgs(), PetscGetArguments()
554793721a6SBarry Smith 
555793721a6SBarry Smith @*/
5567087cfbeSBarry Smith PetscErrorCode  PetscFreeArguments(char **args)
557793721a6SBarry Smith {
558793721a6SBarry Smith   PetscInt       i = 0;
559793721a6SBarry Smith   PetscErrorCode ierr;
560793721a6SBarry Smith 
561793721a6SBarry Smith   PetscFunctionBegin;
562a297a907SKarl Rupp   if (!args) PetscFunctionReturn(0);
563793721a6SBarry Smith   while (args[i]) {
564793721a6SBarry Smith     ierr = PetscFree(args[i]);CHKERRQ(ierr);
565793721a6SBarry Smith     i++;
566793721a6SBarry Smith   }
567793721a6SBarry Smith   ierr = PetscFree(args);CHKERRQ(ierr);
568793721a6SBarry Smith   PetscFunctionReturn(0);
569793721a6SBarry Smith }
570793721a6SBarry Smith 
57111525c0dSBarry Smith #if defined(PETSC_HAVE_SAWS)
57230befbd2SBarry Smith #include <petscconfiginfo.h>
57330befbd2SBarry Smith 
57411525c0dSBarry Smith #undef __FUNCT__
57511525c0dSBarry Smith #define __FUNCT__ "PetscInitializeSAWs"
57611525c0dSBarry Smith PetscErrorCode  PetscInitializeSAWs(const char help[])
57711525c0dSBarry Smith {
57811525c0dSBarry Smith   if (!PetscGlobalRank) {
57930befbd2SBarry Smith     char           cert[PETSC_MAX_PATH_LEN],root[PETSC_MAX_PATH_LEN],*intro,programname[64],*appline,*options,version[64];
58011525c0dSBarry Smith     int            port;
58111525c0dSBarry Smith     PetscBool      flg,rootlocal = PETSC_FALSE,flg2;
58211525c0dSBarry Smith     size_t         applinelen,introlen;
58311525c0dSBarry Smith     PetscErrorCode ierr;
58411525c0dSBarry Smith 
58511525c0dSBarry Smith     ierr = PetscOptionsHasName(NULL,"-saws_log",&flg);CHKERRQ(ierr);
58611525c0dSBarry Smith     if (flg) {
58711525c0dSBarry Smith       char  sawslog[PETSC_MAX_PATH_LEN];
58811525c0dSBarry Smith 
58911525c0dSBarry Smith       ierr = PetscOptionsGetString(NULL,"-saws_log",sawslog,PETSC_MAX_PATH_LEN,NULL);CHKERRQ(ierr);
59011525c0dSBarry Smith       if (sawslog[0]) {
59111525c0dSBarry Smith         PetscStackCallSAWs(SAWs_Set_Use_Logfile,(sawslog));
59211525c0dSBarry Smith       } else {
59311525c0dSBarry Smith         PetscStackCallSAWs(SAWs_Set_Use_Logfile,(NULL));
59411525c0dSBarry Smith       }
59511525c0dSBarry Smith     }
59611525c0dSBarry Smith     ierr = PetscOptionsGetString(NULL,"-saws_https",cert,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr);
59711525c0dSBarry Smith     if (flg) {
59811525c0dSBarry Smith       PetscStackCallSAWs(SAWs_Set_Use_HTTPS,(cert));
59911525c0dSBarry Smith     }
60011525c0dSBarry Smith     ierr = PetscOptionsGetInt(NULL,"-saws_port",&port,&flg);CHKERRQ(ierr);
60111525c0dSBarry Smith     if (flg) {
60211525c0dSBarry Smith       PetscStackCallSAWs(SAWs_Set_Port,(port));
60311525c0dSBarry Smith     }
60411525c0dSBarry Smith     ierr = PetscOptionsGetString(NULL,"-saws_root",root,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr);
60511525c0dSBarry Smith     if (flg) {
60611525c0dSBarry Smith       PetscStackCallSAWs(SAWs_Set_Document_Root,(root));CHKERRQ(ierr);
60711525c0dSBarry Smith       ierr = PetscStrcmp(root,".",&rootlocal);CHKERRQ(ierr);
60811525c0dSBarry Smith     }
60911525c0dSBarry Smith     ierr = PetscOptionsHasName(NULL,"-saws_local",&flg2);CHKERRQ(ierr);
61011525c0dSBarry Smith     if (flg2) {
61111525c0dSBarry Smith       char jsdir[PETSC_MAX_PATH_LEN];
61211525c0dSBarry Smith       if (!flg) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SUP,"-saws_local option requires -saws_root option");
61311525c0dSBarry Smith       ierr = PetscSNPrintf(jsdir,PETSC_MAX_PATH_LEN,"%s/js",root);CHKERRQ(ierr);
61411525c0dSBarry Smith       ierr = PetscTestDirectory(jsdir,'r',&flg);CHKERRQ(ierr);
61511525c0dSBarry Smith       if (!flg) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_FILE_READ,"-saws_local option requires js directory in root directory");
61611525c0dSBarry Smith       PetscStackCallSAWs(SAWs_Set_Local_JSHeader,());CHKERRQ(ierr);
61711525c0dSBarry Smith     }
61811525c0dSBarry Smith     ierr = PetscGetProgramName(programname,64);CHKERRQ(ierr);
61911525c0dSBarry Smith     ierr = PetscStrlen(help,&applinelen);CHKERRQ(ierr);
62011525c0dSBarry Smith     introlen   = 4096 + applinelen;
62111525c0dSBarry Smith     applinelen += 256;
62211525c0dSBarry Smith     ierr = PetscMalloc(applinelen,&appline);CHKERRQ(ierr);
62311525c0dSBarry Smith     ierr = PetscMalloc(introlen,&intro);CHKERRQ(ierr);
62411525c0dSBarry Smith 
62511525c0dSBarry Smith     if (rootlocal) {
62611525c0dSBarry Smith       ierr = PetscSNPrintf(appline,applinelen,"%s.c.html",programname);CHKERRQ(ierr);
62711525c0dSBarry Smith       ierr = PetscTestFile(appline,'r',&rootlocal);CHKERRQ(ierr);
62811525c0dSBarry Smith     }
62930befbd2SBarry Smith     ierr = PetscOptionsGetAll(&options);CHKERRQ(ierr);
63011525c0dSBarry Smith     if (rootlocal && help) {
63130befbd2SBarry 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);
63211525c0dSBarry Smith     } else if (help) {
63330befbd2SBarry Smith       ierr = PetscSNPrintf(appline,applinelen,"<center>Running %s %s</center><br><center><pre>%s</pre></center><br>\n",programname,options,help);
63411525c0dSBarry Smith     } else {
63530befbd2SBarry Smith       ierr = PetscSNPrintf(appline,applinelen,"<center> Running %s %s</center><br>\n",programname,options);
63611525c0dSBarry Smith     }
637b0bb5815SBarry Smith     ierr = PetscFree(options);CHKERRQ(ierr);
63830befbd2SBarry Smith     ierr = PetscGetVersion(version,sizeof(version));CHKERRQ(ierr);
63911525c0dSBarry Smith     ierr = PetscSNPrintf(intro,introlen,"<body>\n"
64011525c0dSBarry 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"
64130befbd2SBarry Smith                                     "<center>This is the default PETSc application dashboard, from it you can access any published PETSc objects or logging data</center><br><center>%s configured at %s with %s</center><br>\n"
64230befbd2SBarry Smith                          "%s",version,petscconfigureruntime,petscconfigureoptions,appline);
64311525c0dSBarry Smith     PetscStackCallSAWs(SAWs_Set_Body,("index.html",0,intro));
64411525c0dSBarry Smith     ierr = PetscFree(intro);CHKERRQ(ierr);
64511525c0dSBarry Smith     ierr = PetscFree(appline);CHKERRQ(ierr);
64611525c0dSBarry Smith     PetscStackCallSAWs(SAWs_Initialize,());
64711525c0dSBarry Smith     ierr = PetscCitationsRegister("@TechReport{ saws,"
64811525c0dSBarry Smith                                   "Author = {Matt Otten and Jed Brown and Barry Smith},"
64911525c0dSBarry Smith                                   "Title  = {Scientific Application Web Server (SAWs) Users Manual},"
65011525c0dSBarry Smith                                   "Institution = {Argonne National Laboratory},"
65111525c0dSBarry Smith                                   "Year   = 2013}",NULL);CHKERRQ(ierr);
65211525c0dSBarry Smith   }
65311525c0dSBarry Smith   PetscFunctionReturn(0);
65411525c0dSBarry Smith }
65511525c0dSBarry Smith #endif
65611525c0dSBarry Smith 
657793721a6SBarry Smith #undef __FUNCT__
658e5c89e4eSSatish Balay #define __FUNCT__ "PetscInitialize"
659e5c89e4eSSatish Balay /*@C
660e5c89e4eSSatish Balay    PetscInitialize - Initializes the PETSc database and MPI.
661e5c89e4eSSatish Balay    PetscInitialize() calls MPI_Init() if that has yet to be called,
662e5c89e4eSSatish Balay    so this routine should always be called near the beginning of
663e5c89e4eSSatish Balay    your program -- usually the very first line!
664e5c89e4eSSatish Balay 
665e5c89e4eSSatish Balay    Collective on MPI_COMM_WORLD or PETSC_COMM_WORLD if it has been set
666e5c89e4eSSatish Balay 
667e5c89e4eSSatish Balay    Input Parameters:
668e5c89e4eSSatish Balay +  argc - count of number of command line arguments
669e5c89e4eSSatish Balay .  args - the command line arguments
6700298fd71SBarry Smith .  file - [optional] PETSc database file, also checks ~username/.petscrc and .petscrc use NULL to not check for
671fc2bca9aSBarry Smith           code specific file. Use -skip_petscrc in the code specific file to skip the .petscrc files
6720298fd71SBarry Smith -  help - [optional] Help message to print, use NULL for no message
673e5c89e4eSSatish Balay 
67405827820SBarry Smith    If you wish PETSc code to run ONLY on a subcommunicator of MPI_COMM_WORLD, create that
67505827820SBarry Smith    communicator first and assign it to PETSC_COMM_WORLD BEFORE calling PetscInitialize(). Thus if you are running a
67605827820SBarry Smith    four process job and two processes will run PETSc and have PetscInitialize() and PetscFinalize() and two process will not,
67705827820SBarry Smith    then do this. If ALL processes in the job are using PetscInitialize() and PetscFinalize() then you don't need to do this, even
67805827820SBarry Smith    if different subcommunicators of the job are doing different things with PETSc.
679e5c89e4eSSatish Balay 
680e5c89e4eSSatish Balay    Options Database Keys:
681e5c89e4eSSatish Balay +  -start_in_debugger [noxterm,dbx,xdb,gdb,...] - Starts program in debugger
682e5c89e4eSSatish Balay .  -on_error_attach_debugger [noxterm,dbx,xdb,gdb,...] - Starts debugger when error detected
683e5c89e4eSSatish Balay .  -on_error_emacs <machinename> causes emacsclient to jump to error file
684b52f573bSBarry Smith .  -on_error_abort calls abort() when error detected (no traceback)
685e8fb0fc0SBarry Smith .  -on_error_mpiabort calls MPI_abort() when error detected
686e8fb0fc0SBarry Smith .  -error_output_stderr prints error messages to stderr instead of the default stdout
687e8fb0fc0SBarry Smith .  -error_output_none does not print the error messages (but handles errors in the same way as if this was not called)
688e5c89e4eSSatish Balay .  -debugger_nodes [node1,node2,...] - Indicates nodes to start in debugger
689e5c89e4eSSatish Balay .  -debugger_pause [sleeptime] (in seconds) - Pauses debugger
690e5c89e4eSSatish Balay .  -stop_for_debugger - Print message on how to attach debugger manually to
691e5c89e4eSSatish Balay                         process and wait (-debugger_pause) seconds for attachment
6922fb0ec9aSBarry Smith .  -malloc - Indicates use of PETSc error-checking malloc (on by default for debug version of libraries)
693e5c89e4eSSatish Balay .  -malloc no - Indicates not to use error-checking malloc
6942fb0ec9aSBarry Smith .  -malloc_debug - check for memory corruption at EVERY malloc or free
695aee23540SBarry Smith .  -malloc_dump - prints a list of all unfreed memory at the end of the run
696dc92acbaSJed Brown .  -malloc_test - like -malloc_dump -malloc_debug, but only active for debugging builds
697e5c89e4eSSatish Balay .  -fp_trap - Stops on floating point exceptions (Note that on the
698e5c89e4eSSatish Balay               IBM RS6000 this slows code by at least a factor of 10.)
699e5c89e4eSSatish Balay .  -no_signal_handler - Indicates not to trap error signals
700e5c89e4eSSatish Balay .  -shared_tmp - indicates /tmp directory is shared by all processors
701e5c89e4eSSatish Balay .  -not_shared_tmp - each processor has own /tmp
702e5c89e4eSSatish Balay .  -tmp - alternative name of /tmp directory
703e5c89e4eSSatish Balay .  -get_total_flops - returns total flops done by all processors
704142c234bSBarry Smith -  -memory_info - Print memory usage at end of run
705e5c89e4eSSatish Balay 
706e5c89e4eSSatish Balay    Options Database Keys for Profiling:
7070598bfebSBarry Smith    See the <a href="../../docs/manual.pdf#nameddest=ch_profiling">profiling chapter of the users manual</a> for details.
708495fc317SBarry Smith +  -info <optional filename> - Prints verbose information to the screen
709495fc317SBarry Smith .  -info_exclude <null,vec,mat,pc,ksp,snes,ts> - Excludes some of the verbose messages
710495fc317SBarry Smith .  -log_sync - Log the synchronization in scatters, inner products and norms
711495fc317SBarry Smith .  -log_trace [filename] - Print traces of all PETSc calls to the screen (useful to determine where a program
712e5c89e4eSSatish Balay         hangs without running in the debugger).  See PetscLogTraceBegin().
713495fc317SBarry Smith .  -log_summary [filename] - Prints summary of flop and timing information to screen. If the filename is specified the
714495fc317SBarry Smith         summary is written to the file.  See PetscLogView().
715495fc317SBarry Smith .  -log_summary_python [filename] - Prints data on of flop and timing usage to a file or screen. See PetscLogPrintSViewPython().
716495fc317SBarry Smith .  -log_all [filename] - Logs extensive profiling information  See PetscLogDump().
717495fc317SBarry Smith .  -log [filename] - Logs basic profiline information  See PetscLogDump().
718495fc317SBarry Smith -  -log_mpe [filename] - Creates a logfile viewable by the utility Jumpshot (in MPICH distribution)
719495fc317SBarry Smith 
720495fc317SBarry Smith     Only one of -log_trace, -log_summary, -log_all, -log, or -log_mpe may be used at a time
721e5c89e4eSSatish Balay 
722e5c89e4eSSatish Balay    Environmental Variables:
723e5c89e4eSSatish Balay +   PETSC_TMP - alternative tmp directory
724e5c89e4eSSatish Balay .   PETSC_SHARED_TMP - tmp is shared by all processes
725e5c89e4eSSatish Balay .   PETSC_NOT_SHARED_TMP - each process has its own private tmp
726e5c89e4eSSatish Balay .   PETSC_VIEWER_SOCKET_PORT - socket number to use for socket viewer
727e5c89e4eSSatish Balay -   PETSC_VIEWER_SOCKET_MACHINE - machine to use for socket viewer to connect to
728e5c89e4eSSatish Balay 
729e5c89e4eSSatish Balay 
730e5c89e4eSSatish Balay    Level: beginner
731e5c89e4eSSatish Balay 
732e5c89e4eSSatish Balay    Notes:
733e5c89e4eSSatish Balay    If for some reason you must call MPI_Init() separately, call
734e5c89e4eSSatish Balay    it before PetscInitialize().
735e5c89e4eSSatish Balay 
736e5c89e4eSSatish Balay    Fortran Version:
737e5c89e4eSSatish Balay    In Fortran this routine has the format
738e5c89e4eSSatish Balay $       call PetscInitialize(file,ierr)
739e5c89e4eSSatish Balay 
740e5c89e4eSSatish Balay +   ierr - error return code
7410298fd71SBarry Smith -  file - [optional] PETSc database file, also checks ~username/.petscrc and .petscrc use NULL_CHARACTER to not check for
742fc2bca9aSBarry Smith           code specific file. Use -skip_petscrc in the code specific file to skip the .petscrc files
743e5c89e4eSSatish Balay 
744e5c89e4eSSatish Balay    Important Fortran Note:
7450298fd71SBarry Smith    In Fortran, you MUST use NULL_CHARACTER to indicate a
7460298fd71SBarry Smith    null character string; you CANNOT just use NULL as
7470598bfebSBarry Smith    in the C version. See the <a href="../../docs/manual.pdf">users manual</a> for details.
748e5c89e4eSSatish Balay 
74901cb0274SBarry Smith    If your main program is C but you call Fortran code that also uses PETSc you need to call PetscInitializeFortran() soon after
75001cb0274SBarry Smith    calling PetscInitialize().
751e5c89e4eSSatish Balay 
752e5c89e4eSSatish Balay    Concepts: initializing PETSc
753e5c89e4eSSatish Balay 
75401cb0274SBarry Smith .seealso: PetscFinalize(), PetscInitializeFortran(), PetscGetArgs(), PetscInitializeNoArguments()
755e5c89e4eSSatish Balay 
756e5c89e4eSSatish Balay @*/
7577087cfbeSBarry Smith PetscErrorCode  PetscInitialize(int *argc,char ***args,const char file[],const char help[])
758e5c89e4eSSatish Balay {
759e5c89e4eSSatish Balay   PetscErrorCode ierr;
7604bb5149bSJed Brown   PetscMPIInt    flag, size;
761aa5bb8c0SSatish Balay   PetscInt       nodesize;
762ace3abfcSBarry Smith   PetscBool      flg;
763e5c89e4eSSatish Balay   char           hostname[256];
764e5c89e4eSSatish Balay 
765e5c89e4eSSatish Balay   PetscFunctionBegin;
766e5c89e4eSSatish Balay   if (PetscInitializeCalled) PetscFunctionReturn(0);
767e5c89e4eSSatish Balay 
768ae9b4142SLisandro Dalcin   /* these must be initialized in a routine, not as a constant declaration*/
769d89683f4Sbcordonn   PETSC_STDOUT = stdout;
770ae9b4142SLisandro Dalcin   PETSC_STDERR = stderr;
771e5c89e4eSSatish Balay 
772e5c89e4eSSatish Balay   ierr = PetscOptionsCreate();CHKERRQ(ierr);
773e5c89e4eSSatish Balay 
774e5c89e4eSSatish Balay   /*
775e5c89e4eSSatish Balay      We initialize the program name here (before MPI_Init()) because MPICH has a bug in
776e5c89e4eSSatish Balay      it that it sets args[0] on all processors to be args[0] on the first processor.
777e5c89e4eSSatish Balay   */
778e5c89e4eSSatish Balay   if (argc && *argc) {
779e5c89e4eSSatish Balay     ierr = PetscSetProgramName(**args);CHKERRQ(ierr);
780e5c89e4eSSatish Balay   } else {
781e5c89e4eSSatish Balay     ierr = PetscSetProgramName("Unknown Name");CHKERRQ(ierr);
782e5c89e4eSSatish Balay   }
783e5c89e4eSSatish Balay 
784e5c89e4eSSatish Balay   ierr = MPI_Initialized(&flag);CHKERRQ(ierr);
785e5c89e4eSSatish Balay   if (!flag) {
786e32f2f54SBarry Smith     if (PETSC_COMM_WORLD != MPI_COMM_NULL) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SUP,"You cannot set PETSC_COMM_WORLD if you have not initialized MPI first");
7875e765c61SJed Brown #if defined(PETSC_HAVE_MPI_INIT_THREAD)
7885e765c61SJed Brown     {
7895e765c61SJed Brown       PetscMPIInt provided;
7905e765c61SJed Brown       ierr = MPI_Init_thread(argc,args,MPI_THREAD_FUNNELED,&provided);CHKERRQ(ierr);
7915e765c61SJed Brown     }
7925e765c61SJed Brown #else
793e5c89e4eSSatish Balay     ierr = MPI_Init(argc,args);CHKERRQ(ierr);
7945e765c61SJed Brown #endif
795e5c89e4eSSatish Balay     PetscBeganMPI = PETSC_TRUE;
796e5c89e4eSSatish Balay   }
797e5c89e4eSSatish Balay   if (argc && args) {
798e5c89e4eSSatish Balay     PetscGlobalArgc = *argc;
799e5c89e4eSSatish Balay     PetscGlobalArgs = *args;
800e5c89e4eSSatish Balay   }
801e5c89e4eSSatish Balay   PetscFinalizeCalled = PETSC_FALSE;
802e5c89e4eSSatish Balay 
803a297a907SKarl Rupp   if (PETSC_COMM_WORLD == MPI_COMM_NULL) PETSC_COMM_WORLD = MPI_COMM_WORLD;
804d54338ecSKarl Rupp   ierr = MPI_Comm_set_errhandler(PETSC_COMM_WORLD,MPI_ERRORS_RETURN);CHKERRQ(ierr);
805e5c89e4eSSatish Balay 
806e5c89e4eSSatish Balay   /* Done after init due to a bug in MPICH-GM? */
807e5c89e4eSSatish Balay   ierr = PetscErrorPrintfInitialize();CHKERRQ(ierr);
808e5c89e4eSSatish Balay 
809e5c89e4eSSatish Balay   ierr = MPI_Comm_rank(MPI_COMM_WORLD,&PetscGlobalRank);CHKERRQ(ierr);
810e5c89e4eSSatish Balay   ierr = MPI_Comm_size(MPI_COMM_WORLD,&PetscGlobalSize);CHKERRQ(ierr);
811e5c89e4eSSatish Balay 
8128ad47952SJed Brown   MPIU_BOOL = MPI_INT;
8138ad47952SJed Brown   MPIU_ENUM = MPI_INT;
8148ad47952SJed Brown 
815e5c89e4eSSatish Balay   /*
816e5c89e4eSSatish Balay      Initialized the global complex variable; this is because with
817e5c89e4eSSatish Balay      shared libraries the constructors for global variables
818e5c89e4eSSatish Balay      are not called; at least on IRIX.
819e5c89e4eSSatish Balay   */
820886cfec0SSatish Balay #if defined(PETSC_HAVE_COMPLEX)
821e5c89e4eSSatish Balay   {
822a24ee22aSSatish Balay #if defined(PETSC_CLANGUAGE_CXX)
82350f81f78SJed Brown     PetscComplex ic(0.0,1.0);
824e5c89e4eSSatish Balay     PETSC_i = ic;
825a24ee22aSSatish Balay #elif defined(PETSC_CLANGUAGE_C)
82650f81f78SJed Brown     PETSC_i = _Complex_I;
827b7940d39SSatish Balay #endif
828762437b8SSatish Balay   }
829762437b8SSatish Balay 
8302c876bd9SBarry Smith #if !defined(PETSC_HAVE_MPI_C_DOUBLE_COMPLEX)
831e69cd0e6SSatish Balay   ierr = MPI_Type_contiguous(2,MPI_DOUBLE,&MPIU_C_DOUBLE_COMPLEX);CHKERRQ(ierr);
832500d8756SSatish Balay   ierr = MPI_Type_commit(&MPIU_C_DOUBLE_COMPLEX);CHKERRQ(ierr);
833500d8756SSatish Balay   ierr = MPI_Type_contiguous(2,MPI_FLOAT,&MPIU_C_COMPLEX);CHKERRQ(ierr);
834500d8756SSatish Balay   ierr = MPI_Type_commit(&MPIU_C_COMPLEX);CHKERRQ(ierr);
8352c876bd9SBarry Smith #endif
836886cfec0SSatish Balay #endif /* PETSC_HAVE_COMPLEX */
837e5c89e4eSSatish Balay 
838e5c89e4eSSatish Balay   /*
839e5c89e4eSSatish Balay      Create the PETSc MPI reduction operator that sums of the first
840e5c89e4eSSatish Balay      half of the entries and maxes the second half.
841e5c89e4eSSatish Balay   */
842e5c89e4eSSatish Balay   ierr = MPI_Op_create(PetscMaxSum_Local,1,&PetscMaxSum_Op);CHKERRQ(ierr);
843e5c89e4eSSatish Balay 
844ce63c4c1SBarry Smith #if defined(PETSC_USE_REAL___FLOAT128)
845c90a1750SBarry Smith   ierr = MPI_Type_contiguous(2,MPI_DOUBLE,&MPIU___FLOAT128);CHKERRQ(ierr);
846c90a1750SBarry Smith   ierr = MPI_Type_commit(&MPIU___FLOAT128);CHKERRQ(ierr);
8477c2de775SJed Brown #if defined(PETSC_HAVE_COMPLEX)
8488c764dc5SJose Roman   ierr = MPI_Type_contiguous(4,MPI_DOUBLE,&MPIU___COMPLEX128);CHKERRQ(ierr);
8498c764dc5SJose Roman   ierr = MPI_Type_commit(&MPIU___COMPLEX128);CHKERRQ(ierr);
8508c764dc5SJose Roman #endif
851d9822059SBarry Smith   ierr = MPI_Op_create(PetscMax_Local,1,&MPIU_MAX);CHKERRQ(ierr);
852d9822059SBarry Smith   ierr = MPI_Op_create(PetscMin_Local,1,&MPIU_MIN);CHKERRQ(ierr);
853c90a1750SBarry Smith #endif
854c90a1750SBarry Smith 
8557c2de775SJed Brown #if (defined(PETSC_HAVE_COMPLEX) && !defined(PETSC_HAVE_MPI_C_DOUBLE_COMPLEX)) || defined(PETSC_USE_REAL___FLOAT128)
856cca4cb22SSatish Balay   ierr = MPI_Op_create(PetscSum_Local,1,&MPIU_SUM);CHKERRQ(ierr);
857cca4cb22SSatish Balay #endif
858cca4cb22SSatish Balay 
859e5c89e4eSSatish Balay   ierr = MPI_Type_contiguous(2,MPIU_SCALAR,&MPIU_2SCALAR);CHKERRQ(ierr);
860e5c89e4eSSatish Balay   ierr = MPI_Type_commit(&MPIU_2SCALAR);CHKERRQ(ierr);
861e5c89e4eSSatish Balay   ierr = MPI_Op_create(PetscADMax_Local,1,&PetscADMax_Op);CHKERRQ(ierr);
862e5c89e4eSSatish Balay   ierr = MPI_Op_create(PetscADMin_Local,1,&PetscADMin_Op);CHKERRQ(ierr);
863e5c89e4eSSatish Balay 
86444041f26SJed Brown #if defined(PETSC_USE_64BIT_INDICES) || !defined(MPI_2INT)
865e5c89e4eSSatish Balay   ierr = MPI_Type_contiguous(2,MPIU_INT,&MPIU_2INT);CHKERRQ(ierr);
866e5c89e4eSSatish Balay   ierr = MPI_Type_commit(&MPIU_2INT);CHKERRQ(ierr);
86744041f26SJed Brown #endif
868e5c89e4eSSatish Balay 
869ec957eceSBarry Smith 
870e5c89e4eSSatish Balay   /*
871480cf27aSJed Brown      Attributes to be set on PETSc communicators
872480cf27aSJed Brown   */
873480cf27aSJed Brown   ierr = MPI_Keyval_create(MPI_NULL_COPY_FN,Petsc_DelCounter,&Petsc_Counter_keyval,(void*)0);CHKERRQ(ierr);
874da3039f7SJed Brown   ierr = MPI_Keyval_create(MPI_NULL_COPY_FN,Petsc_DelComm_Outer,&Petsc_InnerComm_keyval,(void*)0);CHKERRQ(ierr);
875da3039f7SJed Brown   ierr = MPI_Keyval_create(MPI_NULL_COPY_FN,Petsc_DelComm_Inner,&Petsc_OuterComm_keyval,(void*)0);CHKERRQ(ierr);
876480cf27aSJed Brown 
877480cf27aSJed Brown   /*
878e8fb0fc0SBarry Smith      Build the options database
879e5c89e4eSSatish Balay   */
880e5c89e4eSSatish Balay   ierr = PetscOptionsInsert(argc,args,file);CHKERRQ(ierr);
881e5c89e4eSSatish Balay 
8826dc8fec2Sbcordonn 
883e5c89e4eSSatish Balay   /*
884e5c89e4eSSatish Balay      Print main application help message
885e5c89e4eSSatish Balay   */
8860298fd71SBarry Smith   ierr = PetscOptionsHasName(NULL,"-help",&flg);CHKERRQ(ierr);
887e5c89e4eSSatish Balay   if (help && flg) {
888e5c89e4eSSatish Balay     ierr = PetscPrintf(PETSC_COMM_WORLD,help);CHKERRQ(ierr);
889e5c89e4eSSatish Balay   }
890e5c89e4eSSatish Balay   ierr = PetscOptionsCheckInitial_Private();CHKERRQ(ierr);
891e5c89e4eSSatish Balay 
892d45a07a7SBarry Smith   ierr = PetscCitationsInitialize();CHKERRQ(ierr);
893d45a07a7SBarry Smith 
894e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS)
89511525c0dSBarry Smith   ierr = PetscInitializeSAWs(help);CHKERRQ(ierr);
896f4202a44SBarry Smith #endif
897f4202a44SBarry Smith 
898e5c89e4eSSatish Balay   /* SHOULD PUT IN GUARDS: Make sure logging is initialized, even if we do not print it out */
899a9f03627SSatish Balay #if defined(PETSC_USE_LOG)
900e5c89e4eSSatish Balay   ierr = PetscLogBegin_Private();CHKERRQ(ierr);
901a9f03627SSatish Balay #endif
902e5c89e4eSSatish Balay 
903e5c89e4eSSatish Balay   /*
904e5c89e4eSSatish Balay      Load the dynamic libraries (on machines that support them), this registers all
905e5c89e4eSSatish Balay      the solvers etc. (On non-dynamic machines this initializes the PetscDraw and PetscViewer classes)
906e5c89e4eSSatish Balay   */
907e5c89e4eSSatish Balay   ierr = PetscInitialize_DynamicLibraries();CHKERRQ(ierr);
908e5c89e4eSSatish Balay 
909e5c89e4eSSatish Balay   ierr = MPI_Comm_size(PETSC_COMM_WORLD,&size);CHKERRQ(ierr);
910ae15b995SBarry Smith   ierr = PetscInfo1(0,"PETSc successfully started: number of processors = %d\n",size);CHKERRQ(ierr);
911e5c89e4eSSatish Balay   ierr = PetscGetHostName(hostname,256);CHKERRQ(ierr);
912ae15b995SBarry Smith   ierr = PetscInfo1(0,"Running on machine: %s\n",hostname);CHKERRQ(ierr);
913e5c89e4eSSatish Balay 
914e5c89e4eSSatish Balay   ierr = PetscOptionsCheckInitial_Components();CHKERRQ(ierr);
915ef6c6fedSBoyana Norris   /* Check the options database for options related to the options database itself */
916ef6c6fedSBoyana Norris   ierr = PetscOptionsSetFromOptions();CHKERRQ(ierr);
917ef6c6fedSBoyana Norris 
918951e3c8eSBarry Smith #if defined(PETSC_USE_PETSC_MPI_EXTERNAL32)
919e39fd77fSBarry Smith   /*
920e39fd77fSBarry Smith       Tell MPI about our own data representation converter, this would/should be used if extern32 is not supported by the MPI
921e39fd77fSBarry Smith 
922e39fd77fSBarry Smith       Currently not used because it is not supported by MPICH.
923e39fd77fSBarry Smith   */
924e39fd77fSBarry Smith #if !defined(PETSC_WORDS_BIGENDIAN)
9250298fd71SBarry Smith   ierr = MPI_Register_datarep((char*)"petsc",PetscDataRep_read_conv_fn,PetscDataRep_write_conv_fn,PetscDataRep_extent_fn,NULL);CHKERRQ(ierr);
926e39fd77fSBarry Smith #endif
927951e3c8eSBarry Smith #endif
928e39fd77fSBarry Smith 
9290298fd71SBarry Smith   ierr = PetscOptionsGetInt(NULL,"-hmpi_spawn_size",&nodesize,&flg);CHKERRQ(ierr);
930793721a6SBarry Smith   if (flg) {
93123464e94SBarry Smith #if defined(PETSC_HAVE_MPI_COMM_SPAWN)
93285afcc9aSBarry Smith     ierr = PetscHMPISpawn((PetscMPIInt) nodesize);CHKERRQ(ierr); /* worker nodes never return from here; they go directly to PetscEnd() */
93323464e94SBarry Smith #else
93485afcc9aSBarry Smith     SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SUP,"PETSc built without MPI 2 (MPI_Comm_spawn) support, use -hmpi_merge_size instead");
93523464e94SBarry Smith #endif
936793721a6SBarry Smith   } else {
9370298fd71SBarry Smith     ierr = PetscOptionsGetInt(NULL,"-hmpi_merge_size",&nodesize,&flg);CHKERRQ(ierr);
9388002f1cdSBarry Smith     if (flg) {
9390298fd71SBarry Smith       ierr = PetscHMPIMerge((PetscMPIInt) nodesize,NULL,NULL);CHKERRQ(ierr);
94085afcc9aSBarry Smith       if (PetscHMPIWorker) { /* if worker then never enter user code */
941bad7cb1dSBarry Smith         PetscInitializeCalled = PETSC_TRUE;
9423bf036e2SBarry Smith         PetscEnd();
9439505b675SBarry Smith       }
9448002f1cdSBarry Smith     }
945793721a6SBarry Smith   }
946e5c89e4eSSatish Balay 
94735d88935SVictor Minden #if defined(PETSC_HAVE_CUDA)
94820e2c332SMatthew G. Knepley   flg  = PETSC_TRUE;
94920e2c332SMatthew G. Knepley   ierr = PetscOptionsGetBool(NULL,"-cublas",&flg,NULL);CHKERRQ(ierr);
95020e2c332SMatthew G. Knepley   if (flg) {
9514bb5149bSJed Brown     PetscMPIInt p;
952663ba86aSMatthew G Knepley     for (p = 0; p < PetscGlobalSize; ++p) {
953a297a907SKarl Rupp       if (p == PetscGlobalRank) cublasInit();
954663ba86aSMatthew G Knepley       ierr = MPI_Barrier(PETSC_COMM_WORLD);CHKERRQ(ierr);
955663ba86aSMatthew G Knepley     }
9564bb5149bSJed Brown   }
9573e39abd9SVictor Minden #endif
95892e62aa6SBarry Smith 
9590298fd71SBarry Smith   ierr = PetscOptionsHasName(NULL,"-python",&flg);CHKERRQ(ierr);
9609ac80d5eSLisandro Dalcin   if (flg) {
9619ac80d5eSLisandro Dalcin     PetscInitializeCalled = PETSC_TRUE;
9620298fd71SBarry Smith     ierr = PetscPythonInitialize(NULL,NULL);CHKERRQ(ierr);
9639ac80d5eSLisandro Dalcin   }
9649ac80d5eSLisandro Dalcin 
965607a6623SBarry Smith   ierr = PetscThreadCommInitializePackage();CHKERRQ(ierr);
966bd8b14e7SShri Abhyankar 
96741c0b4b3SShri Abhyankar   /*
96841c0b4b3SShri Abhyankar       Setup building of stack frames for all function calls
96941c0b4b3SShri Abhyankar   */
97076386721SLisandro Dalcin   PetscThreadLocalRegister((PetscThreadKey*)&petscstack); /* Creates pthread_key */
971e1167bb9SShri Abhyankar #if defined(PETSC_USE_DEBUG)
972e1167bb9SShri Abhyankar   ierr = PetscStackCreate();CHKERRQ(ierr);
973e1167bb9SShri Abhyankar #endif
974e1167bb9SShri Abhyankar 
9752d53ad75SBarry Smith #if defined(PETSC_SERIALIZE_FUNCTIONS)
9762d53ad75SBarry Smith   ierr = PetscFPTCreate(10000);CHKERRQ(ierr);
9772d53ad75SBarry Smith #endif
9782d53ad75SBarry Smith 
979dff31646SBarry Smith 
980301d30feSBarry Smith   /*
981301d30feSBarry Smith       Once we are completedly initialized then we can set this variables
982301d30feSBarry Smith   */
983301d30feSBarry Smith   PetscInitializeCalled = PETSC_TRUE;
984301d30feSBarry Smith   PetscFunctionReturn(0);
985e5c89e4eSSatish Balay }
986e5c89e4eSSatish Balay 
9874097062eSBarry Smith #if defined(PETSC_USE_LOG)
9882eff7a51SBarry Smith extern PetscObject *PetscObjects;
9892eff7a51SBarry Smith extern PetscInt    PetscObjectsCounts, PetscObjectsMaxCounts;
9904097062eSBarry Smith #endif
991e5c89e4eSSatish Balay 
992e5c89e4eSSatish Balay #undef __FUNCT__
993e5c89e4eSSatish Balay #define __FUNCT__ "PetscFinalize"
994e5c89e4eSSatish Balay /*@C
995e5c89e4eSSatish Balay    PetscFinalize - Checks for options to be called at the conclusion
996e5c89e4eSSatish Balay    of the program. MPI_Finalize() is called only if the user had not
997e5c89e4eSSatish Balay    called MPI_Init() before calling PetscInitialize().
998e5c89e4eSSatish Balay 
999e5c89e4eSSatish Balay    Collective on PETSC_COMM_WORLD
1000e5c89e4eSSatish Balay 
1001e5c89e4eSSatish Balay    Options Database Keys:
100288c29154SBarry Smith +  -options_table - Calls PetscOptionsView()
1003e5c89e4eSSatish Balay .  -options_left - Prints unused options that remain in the database
10047eb1d149SBarry 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
1005e5c89e4eSSatish Balay .  -mpidump - Calls PetscMPIDump()
1006e5c89e4eSSatish Balay .  -malloc_dump - Calls PetscMallocDump()
1007e5c89e4eSSatish Balay .  -malloc_info - Prints total memory usage
1008e5c89e4eSSatish Balay -  -malloc_log - Prints summary of memory usage
1009e5c89e4eSSatish Balay 
1010e5c89e4eSSatish Balay    Level: beginner
1011e5c89e4eSSatish Balay 
1012e5c89e4eSSatish Balay    Note:
1013e5c89e4eSSatish Balay    See PetscInitialize() for more general runtime options.
1014e5c89e4eSSatish Balay 
101588c29154SBarry Smith .seealso: PetscInitialize(), PetscOptionsView(), PetscMallocDump(), PetscMPIDump(), PetscEnd()
1016e5c89e4eSSatish Balay @*/
10177087cfbeSBarry Smith PetscErrorCode  PetscFinalize(void)
1018e5c89e4eSSatish Balay {
1019e5c89e4eSSatish Balay   PetscErrorCode ierr;
10204bb5149bSJed Brown   PetscMPIInt    rank;
1021a8d2bbe5SBarry Smith   PetscInt       nopt;
10222bf49c77SBarry Smith   PetscBool      flg1 = PETSC_FALSE,flg2 = PETSC_FALSE,flg3 = PETSC_FALSE;
1023dff31646SBarry Smith   PetscBool      flg;
102410463e74SBarry Smith #if defined(PETSC_USE_LOG)
102510463e74SBarry Smith   char           mname[PETSC_MAX_PATH_LEN];
102610463e74SBarry Smith #endif
1027e5c89e4eSSatish Balay 
1028e5c89e4eSSatish Balay   PetscFunctionBegin;
1029e5c89e4eSSatish Balay   if (!PetscInitializeCalled) {
10304b09e917SBarry Smith     printf("PetscInitialize() must be called before PetscFinalize()\n");
10314b09e917SBarry Smith     PetscFunctionReturn(PETSC_ERR_ARG_WRONGSTATE);
1032e5c89e4eSSatish Balay   }
10330298fd71SBarry Smith   ierr = PetscInfo(NULL,"PetscFinalize() called\n");CHKERRQ(ierr);
1034b022a5c1SBarry Smith 
10351f817a21SBarry Smith   ierr = MPI_Comm_rank(PETSC_COMM_WORLD,&rank);CHKERRQ(ierr);
10361f817a21SBarry Smith 
10371f817a21SBarry Smith   ierr = PetscOptionsHasName(NULL,"-citations",&flg);CHKERRQ(ierr);
1038dff31646SBarry Smith   if (flg) {
10391f817a21SBarry Smith     char  *cits, filename[PETSC_MAX_PATH_LEN];
10401f817a21SBarry Smith     FILE  *fd = PETSC_STDOUT;
10411f817a21SBarry Smith 
10421f817a21SBarry Smith     ierr = PetscOptionsGetString(NULL,"-citations",filename,PETSC_MAX_PATH_LEN,NULL);CHKERRQ(ierr);
10431f817a21SBarry Smith     if (filename[0]) {
10441f817a21SBarry Smith       ierr = PetscFOpen(PETSC_COMM_WORLD,filename,"w",&fd);CHKERRQ(ierr);
10451f817a21SBarry Smith     }
1046dff31646SBarry Smith     ierr = PetscSegBufferGet(PetscCitationsList,1,&cits);CHKERRQ(ierr);
1047dff31646SBarry Smith     cits[0] = 0;
1048dff31646SBarry Smith     ierr = PetscSegBufferExtractAlloc(PetscCitationsList,&cits);CHKERRQ(ierr);
10491f817a21SBarry Smith     ierr = PetscFPrintf(PETSC_COMM_WORLD,fd,"If you publish results based on this computation please cite the following:\n");CHKERRQ(ierr);
10501f817a21SBarry Smith     ierr = PetscFPrintf(PETSC_COMM_WORLD,fd,"===========================================================================\n");CHKERRQ(ierr);
10511f817a21SBarry Smith     ierr = PetscFPrintf(PETSC_COMM_WORLD,fd,"%s",cits);CHKERRQ(ierr);
10521f817a21SBarry Smith     ierr = PetscFPrintf(PETSC_COMM_WORLD,fd,"===========================================================================\n");CHKERRQ(ierr);
10531f817a21SBarry Smith     ierr = PetscFClose(PETSC_COMM_WORLD,fd);CHKERRQ(ierr);
1054dff31646SBarry Smith     ierr = PetscFree(cits);CHKERRQ(ierr);
1055dff31646SBarry Smith   }
1056dff31646SBarry Smith   ierr = PetscSegBufferDestroy(&PetscCitationsList);CHKERRQ(ierr);
1057dff31646SBarry Smith 
10582d53ad75SBarry Smith #if defined(PETSC_SERIALIZE_FUNCTIONS)
10592d53ad75SBarry Smith   ierr = PetscFPTDestroy();CHKERRQ(ierr);
10602d53ad75SBarry Smith #endif
10612d53ad75SBarry Smith 
10622d53ad75SBarry Smith 
1063e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS)
1064dff31646SBarry Smith   flg = PETSC_FALSE;
1065e78c4b8cSBarry Smith   ierr = PetscOptionsGetBool(NULL,"-saw_options",&flg,NULL);CHKERRQ(ierr);
1066d5649816SBarry Smith   if (flg) {
1067e04113cfSBarry Smith     ierr = PetscOptionsSAWsDestroy();CHKERRQ(ierr);
1068d5649816SBarry Smith   }
1069d5649816SBarry Smith #endif
1070d5649816SBarry Smith 
1071681455b2SBarry Smith #if defined(PETSC_HAVE_X)
1072681455b2SBarry Smith   flg1 = PETSC_FALSE;
1073681455b2SBarry Smith   ierr = PetscOptionsGetBool(NULL,"-x_virtual",&flg1,NULL);CHKERRQ(ierr);
1074681455b2SBarry Smith   if (flg1) {
1075681455b2SBarry Smith     /*  this is a crude hack, but better than nothing */
1076681455b2SBarry Smith     ierr = PetscPOpen(PETSC_COMM_WORLD,NULL,"pkill -9 Xvfb","r",NULL);CHKERRQ(ierr);
1077681455b2SBarry Smith   }
1078681455b2SBarry Smith #endif
1079681455b2SBarry Smith 
108085afcc9aSBarry Smith   ierr = PetscHMPIFinalize();CHKERRQ(ierr);
1081d3f95da6SShri Abhyankar 
10820298fd71SBarry Smith   ierr = PetscOptionsGetBool(NULL,"-malloc_info",&flg2,NULL);CHKERRQ(ierr);
1083e5c89e4eSSatish Balay   if (!flg2) {
108490d69ab7SBarry Smith     flg2 = PETSC_FALSE;
10850298fd71SBarry Smith     ierr = PetscOptionsGetBool(NULL,"-memory_info",&flg2,NULL);CHKERRQ(ierr);
1086e5c89e4eSSatish Balay   }
1087e5c89e4eSSatish Balay   if (flg2) {
1088e5c89e4eSSatish Balay     ierr = PetscMemoryShowUsage(PETSC_VIEWER_STDOUT_WORLD,"Summary of Memory Usage in PETSc\n");CHKERRQ(ierr);
1089e5c89e4eSSatish Balay   }
1090e5c89e4eSSatish Balay 
1091e5c89e4eSSatish Balay #if defined(PETSC_USE_LOG)
109290d69ab7SBarry Smith   flg1 = PETSC_FALSE;
10930298fd71SBarry Smith   ierr = PetscOptionsGetBool(NULL,"-get_total_flops",&flg1,NULL);CHKERRQ(ierr);
1094e5c89e4eSSatish Balay   if (flg1) {
1095e5c89e4eSSatish Balay     PetscLogDouble flops = 0;
1096205a32c2SJed Brown     ierr = MPI_Reduce(&petsc_TotalFlops,&flops,1,MPI_DOUBLE,MPI_SUM,0,PETSC_COMM_WORLD);CHKERRQ(ierr);
1097e5c89e4eSSatish Balay     ierr = PetscPrintf(PETSC_COMM_WORLD,"Total flops over all processors %g\n",flops);CHKERRQ(ierr);
1098e5c89e4eSSatish Balay   }
1099e5c89e4eSSatish Balay #endif
1100e5c89e4eSSatish Balay 
1101e5c89e4eSSatish Balay 
1102e5c89e4eSSatish Balay #if defined(PETSC_USE_LOG)
1103e5c89e4eSSatish Balay #if defined(PETSC_HAVE_MPE)
1104e5c89e4eSSatish Balay   mname[0] = 0;
1105a297a907SKarl Rupp 
11060298fd71SBarry Smith   ierr = PetscOptionsGetString(NULL,"-log_mpe",mname,PETSC_MAX_PATH_LEN,&flg1);CHKERRQ(ierr);
1107e5c89e4eSSatish Balay   if (flg1) {
1108e5c89e4eSSatish Balay     if (mname[0]) {ierr = PetscLogMPEDump(mname);CHKERRQ(ierr);}
1109e5c89e4eSSatish Balay     else          {ierr = PetscLogMPEDump(0);CHKERRQ(ierr);}
1110e5c89e4eSSatish Balay   }
1111e5c89e4eSSatish Balay #endif
1112e5c89e4eSSatish Balay   mname[0] = 0;
1113a297a907SKarl Rupp 
11140298fd71SBarry Smith   ierr = PetscOptionsGetString(NULL,"-log_summary",mname,PETSC_MAX_PATH_LEN,&flg1);CHKERRQ(ierr);
1115e5c89e4eSSatish Balay   if (flg1) {
111691eabc43SBarry Smith     PetscViewer viewer;
111791eabc43SBarry Smith     if (mname[0]) {
111891eabc43SBarry Smith       ierr = PetscViewerASCIIOpen(PETSC_COMM_WORLD,mname,&viewer);CHKERRQ(ierr);
111991eabc43SBarry Smith       ierr = PetscLogView(viewer);CHKERRQ(ierr);
11206bf464f9SBarry Smith       ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr);
112133f85c2fSBarry Smith     } else {
112233f85c2fSBarry Smith       viewer = PETSC_VIEWER_STDOUT_WORLD;
112333f85c2fSBarry Smith       ierr   = PetscLogView(viewer);CHKERRQ(ierr);
112433f85c2fSBarry Smith     }
1125e5c89e4eSSatish Balay   }
1126e5c89e4eSSatish Balay 
1127ff5bc46bSBarry Smith   mname[0] = 0;
1128a297a907SKarl Rupp 
11290298fd71SBarry Smith   ierr = PetscOptionsGetString(NULL,"-log_summary_python",mname,PETSC_MAX_PATH_LEN,&flg1);CHKERRQ(ierr);
1130ff5bc46bSBarry Smith   if (flg1) {
1131ff5bc46bSBarry Smith     PetscViewer viewer;
1132ff5bc46bSBarry Smith     if (mname[0]) {
1133ff5bc46bSBarry Smith       ierr = PetscViewerASCIIOpen(PETSC_COMM_WORLD,mname,&viewer);CHKERRQ(ierr);
113491eabc43SBarry Smith       ierr = PetscLogViewPython(viewer);CHKERRQ(ierr);
11356bf464f9SBarry Smith       ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr);
113633f85c2fSBarry Smith     } else {
113733f85c2fSBarry Smith       viewer = PETSC_VIEWER_STDOUT_WORLD;
113833f85c2fSBarry Smith       ierr   = PetscLogViewPython(viewer);CHKERRQ(ierr);
113933f85c2fSBarry Smith     }
1140ff5bc46bSBarry Smith   }
1141ff5bc46bSBarry Smith 
11420298fd71SBarry Smith   ierr = PetscOptionsGetString(NULL,"-log_detailed",mname,PETSC_MAX_PATH_LEN,&flg1);CHKERRQ(ierr);
114378392ef1SBarry Smith   if (flg1) {
114478392ef1SBarry Smith     if (mname[0])  {ierr = PetscLogPrintDetailed(PETSC_COMM_WORLD,mname);CHKERRQ(ierr);}
114578392ef1SBarry Smith     else           {ierr = PetscLogPrintDetailed(PETSC_COMM_WORLD,0);CHKERRQ(ierr);}
114678392ef1SBarry Smith   }
114778392ef1SBarry Smith 
1148e5c89e4eSSatish Balay   mname[0] = 0;
1149a297a907SKarl Rupp 
11500298fd71SBarry Smith   ierr = PetscOptionsGetString(NULL,"-log_all",mname,PETSC_MAX_PATH_LEN,&flg1);CHKERRQ(ierr);
11510298fd71SBarry Smith   ierr = PetscOptionsGetString(NULL,"-log",mname,PETSC_MAX_PATH_LEN,&flg2);CHKERRQ(ierr);
1152e5c89e4eSSatish Balay   if (flg1 || flg2) {
1153e5c89e4eSSatish Balay     if (mname[0]) PetscLogDump(mname);
1154e5c89e4eSSatish Balay     else          PetscLogDump(0);
1155e5c89e4eSSatish Balay   }
1156e5c89e4eSSatish Balay #endif
115710463e74SBarry Smith 
1158b58ca069SBarry Smith   /*
1159b58ca069SBarry Smith      Free all objects registered with PetscObjectRegisterDestroy() such as PETSC_VIEWER_XXX_().
1160b58ca069SBarry Smith   */
1161b58ca069SBarry Smith   ierr = PetscObjectRegisterDestroyAll();CHKERRQ(ierr);
1162b58ca069SBarry Smith 
116333f85c2fSBarry Smith   ierr = PetscStackDestroy();CHKERRQ(ierr);
116476386721SLisandro Dalcin   PetscThreadLocalDestroy((PetscThreadKey)petscstack); /* Deletes pthread_key */
116510463e74SBarry Smith 
116690d69ab7SBarry Smith   flg1 = PETSC_FALSE;
11670298fd71SBarry Smith   ierr = PetscOptionsGetBool(NULL,"-no_signal_handler",&flg1,NULL);CHKERRQ(ierr);
1168e5c89e4eSSatish Balay   if (!flg1) { ierr = PetscPopSignalHandler();CHKERRQ(ierr);}
116990d69ab7SBarry Smith   flg1 = PETSC_FALSE;
11700298fd71SBarry Smith   ierr = PetscOptionsGetBool(NULL,"-mpidump",&flg1,NULL);CHKERRQ(ierr);
1171e5c89e4eSSatish Balay   if (flg1) {
1172e5c89e4eSSatish Balay     ierr = PetscMPIDump(stdout);CHKERRQ(ierr);
1173e5c89e4eSSatish Balay   }
117490d69ab7SBarry Smith   flg1 = PETSC_FALSE;
117590d69ab7SBarry Smith   flg2 = PETSC_FALSE;
11768bb29257SSatish Balay   /* preemptive call to avoid listing this option in options table as unused */
11770298fd71SBarry Smith   ierr = PetscOptionsHasName(NULL,"-malloc_dump",&flg1);CHKERRQ(ierr);
11780298fd71SBarry Smith   ierr = PetscOptionsHasName(NULL,"-objects_dump",&flg1);CHKERRQ(ierr);
11790298fd71SBarry Smith   ierr = PetscOptionsGetBool(NULL,"-options_table",&flg2,NULL);CHKERRQ(ierr);
1180e4c476e2SSatish Balay 
1181e5c89e4eSSatish Balay   if (flg2) {
1182be56827dSJed Brown     PetscViewer viewer;
1183be56827dSJed Brown     ierr = PetscViewerASCIIGetStdout(PETSC_COMM_WORLD,&viewer);CHKERRQ(ierr);
1184be56827dSJed Brown     ierr = PetscOptionsView(viewer);CHKERRQ(ierr);
1185be56827dSJed Brown     ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr);
1186e5c89e4eSSatish Balay   }
1187e5c89e4eSSatish Balay 
1188e5c89e4eSSatish Balay   /* to prevent PETSc -options_left from warning */
11890298fd71SBarry Smith   ierr = PetscOptionsHasName(NULL,"-nox",&flg1);CHKERRQ(ierr);
11900298fd71SBarry Smith   ierr = PetscOptionsHasName(NULL,"-nox_warning",&flg1);CHKERRQ(ierr);
1191e5c89e4eSSatish Balay 
119285afcc9aSBarry Smith   if (!PetscHMPIWorker) { /* worker processes skip this because they do not usually process options */
119333fc4174SSatish Balay     flg3 = PETSC_FALSE; /* default value is required */
11940298fd71SBarry Smith     ierr = PetscOptionsGetBool(NULL,"-options_left",&flg3,&flg1);CHKERRQ(ierr);
1195e5c89e4eSSatish Balay     ierr = PetscOptionsAllUsed(&nopt);CHKERRQ(ierr);
1196e5c89e4eSSatish Balay     if (flg3) {
1197e5c89e4eSSatish Balay       if (!flg2) { /* have not yet printed the options */
1198be56827dSJed Brown         PetscViewer viewer;
1199be56827dSJed Brown         ierr = PetscViewerASCIIGetStdout(PETSC_COMM_WORLD,&viewer);CHKERRQ(ierr);
1200be56827dSJed Brown         ierr = PetscOptionsView(viewer);CHKERRQ(ierr);
1201be56827dSJed Brown         ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr);
1202e5c89e4eSSatish Balay       }
1203e5c89e4eSSatish Balay       if (!nopt) {
1204e5c89e4eSSatish Balay         ierr = PetscPrintf(PETSC_COMM_WORLD,"There are no unused options.\n");CHKERRQ(ierr);
1205e5c89e4eSSatish Balay       } else if (nopt == 1) {
1206e5c89e4eSSatish Balay         ierr = PetscPrintf(PETSC_COMM_WORLD,"There is one unused database option. It is:\n");CHKERRQ(ierr);
1207e5c89e4eSSatish Balay       } else {
12087582186dSLisandro Dalcin         ierr = PetscPrintf(PETSC_COMM_WORLD,"There are %D unused database options. They are:\n",nopt);CHKERRQ(ierr);
1209e5c89e4eSSatish Balay       }
1210e5c89e4eSSatish Balay     }
1211e5c89e4eSSatish Balay #if defined(PETSC_USE_DEBUG)
1212da8b8a77SBarry Smith     if (nopt && !flg3 && !flg1) {
1213e5c89e4eSSatish Balay       ierr = PetscPrintf(PETSC_COMM_WORLD,"WARNING! There are options you set that were not used!\n");CHKERRQ(ierr);
1214e5c89e4eSSatish Balay       ierr = PetscPrintf(PETSC_COMM_WORLD,"WARNING! could be spelling mistake, etc!\n");CHKERRQ(ierr);
1215e5c89e4eSSatish Balay       ierr = PetscOptionsLeft();CHKERRQ(ierr);
1216e5c89e4eSSatish Balay     } else if (nopt && flg3) {
1217e5c89e4eSSatish Balay #else
1218e5c89e4eSSatish Balay     if (nopt && flg3) {
1219e5c89e4eSSatish Balay #endif
1220e5c89e4eSSatish Balay       ierr = PetscOptionsLeft();CHKERRQ(ierr);
1221e5c89e4eSSatish Balay     }
1222931f367cSBarry Smith   }
1223e5c89e4eSSatish Balay 
1224e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS)
1225d45a07a7SBarry Smith   if (!PetscGlobalRank) {
122687f587eeSBarry Smith     ierr = PetscStackSAWsViewOff();CHKERRQ(ierr);
122716ad0300SBarry Smith     PetscStackCallSAWs(SAWs_Finalize,());
1228d45a07a7SBarry Smith   }
1229ec957eceSBarry Smith #endif
1230ec957eceSBarry Smith 
1231eea2bdeeSJed Brown   {
1232eea2bdeeSJed Brown     PetscThreadComm tcomm_world;
1233eea2bdeeSJed Brown     ierr = PetscGetThreadCommWorld(&tcomm_world);CHKERRQ(ierr);
1234eea2bdeeSJed Brown     /* Free global thread communicator */
1235eea2bdeeSJed Brown     ierr = PetscThreadCommDestroy(&tcomm_world);CHKERRQ(ierr);
1236eea2bdeeSJed Brown   }
1237eea2bdeeSJed Brown 
12384097062eSBarry Smith #if defined(PETSC_USE_LOG)
123910463e74SBarry Smith   /*
1240dbc8283eSBarry Smith        List all objects the user may have forgot to free
12412eff7a51SBarry Smith   */
12420298fd71SBarry Smith   ierr = PetscOptionsHasName(NULL,"-objects_dump",&flg1);CHKERRQ(ierr);
1243a64a8e02SBarry Smith   if (flg1) {
1244a64a8e02SBarry Smith     MPI_Comm local_comm;
12457eb1d149SBarry Smith     char     string[64];
1246a64a8e02SBarry Smith 
12470298fd71SBarry Smith     ierr = PetscOptionsGetString(NULL,"-objects_dump",string,64,NULL);CHKERRQ(ierr);
1248a64a8e02SBarry Smith     ierr = MPI_Comm_dup(MPI_COMM_WORLD,&local_comm);CHKERRQ(ierr);
1249a64a8e02SBarry Smith     ierr = PetscSequentialPhaseBegin_Private(local_comm,1);CHKERRQ(ierr);
12507eb1d149SBarry Smith     ierr = PetscObjectsDump(stdout,(string[0] == 'a') ? PETSC_TRUE : PETSC_FALSE);CHKERRQ(ierr);
1251a64a8e02SBarry Smith     ierr = PetscSequentialPhaseEnd_Private(local_comm,1);CHKERRQ(ierr);
1252a64a8e02SBarry Smith     ierr = MPI_Comm_free(&local_comm);CHKERRQ(ierr);
12530a1571b3SBarry Smith   }
12544097062eSBarry Smith #endif
12554097062eSBarry Smith 
12564097062eSBarry Smith #if defined(PETSC_USE_LOG)
1257dbc8283eSBarry Smith   PetscObjectsCounts    = 0;
1258dbc8283eSBarry Smith   PetscObjectsMaxCounts = 0;
1259a297a907SKarl Rupp   ierr = PetscFree(PetscObjects);CHKERRQ(ierr);
12604097062eSBarry Smith #endif
12612eff7a51SBarry Smith 
126233f85c2fSBarry Smith #if defined(PETSC_USE_LOG)
126333f85c2fSBarry Smith   ierr = PetscLogDestroy();CHKERRQ(ierr);
126433f85c2fSBarry Smith #endif
126533f85c2fSBarry Smith 
126633f85c2fSBarry Smith   /*
126733f85c2fSBarry Smith      Destroy any packages that registered a finalize
126833f85c2fSBarry Smith   */
126933f85c2fSBarry Smith   ierr = PetscRegisterFinalizeAll();CHKERRQ(ierr);
127033f85c2fSBarry Smith 
127133f85c2fSBarry Smith   /*
127210463e74SBarry Smith      Destroy all the function registration lists created
127310463e74SBarry Smith   */
127410463e74SBarry Smith   ierr = PetscFinalize_DynamicLibraries();CHKERRQ(ierr);
127510463e74SBarry Smith 
127648dd1dffSBarry Smith   /*
127748dd1dffSBarry Smith      Print PetscFunctionLists that have not been properly freed
127848dd1dffSBarry Smith 
127937e93019SBarry Smith   ierr = PetscFunctionListPrintAll();CHKERRQ(ierr);
128048dd1dffSBarry Smith   */
128137e93019SBarry Smith 
12824028d114SSatish Balay   if (petsc_history) {
1283f3dea69dSBarry Smith     ierr = PetscCloseHistoryFile(&petsc_history);CHKERRQ(ierr);
1284e5c89e4eSSatish Balay     petsc_history = 0;
1285e5c89e4eSSatish Balay   }
1286e5c89e4eSSatish Balay 
12870298fd71SBarry Smith   ierr = PetscInfoAllow(PETSC_FALSE,NULL);CHKERRQ(ierr);
1288e5c89e4eSSatish Balay 
12898bb29257SSatish Balay   {
1290e5c89e4eSSatish Balay     char fname[PETSC_MAX_PATH_LEN];
1291e5c89e4eSSatish Balay     FILE *fd;
1292ed9cf6e9SBarry Smith     int  err;
1293e5c89e4eSSatish Balay 
1294e5c89e4eSSatish Balay     fname[0] = 0;
1295a297a907SKarl Rupp 
12960298fd71SBarry Smith     ierr = PetscOptionsGetString(NULL,"-malloc_dump",fname,250,&flg1);CHKERRQ(ierr);
1297dc92acbaSJed Brown     flg2 = PETSC_FALSE;
12980298fd71SBarry Smith     ierr = PetscOptionsGetBool(NULL,"-malloc_test",&flg2,NULL);CHKERRQ(ierr);
12998bf1f09cSShri Abhyankar #if defined(PETSC_USE_DEBUG)
1300dc92acbaSJed Brown     if (PETSC_RUNNING_ON_VALGRIND) flg2 = PETSC_FALSE;
1301dc92acbaSJed Brown #else
1302dc92acbaSJed Brown     flg2 = PETSC_FALSE;         /* Skip reporting for optimized builds regardless of -malloc_test */
1303dc92acbaSJed Brown #endif
1304e5c89e4eSSatish Balay     if (flg1 && fname[0]) {
1305e5c89e4eSSatish Balay       char sname[PETSC_MAX_PATH_LEN];
1306e5c89e4eSSatish Balay 
1307e5c89e4eSSatish Balay       sprintf(sname,"%s_%d",fname,rank);
1308e32f2f54SBarry Smith       fd   = fopen(sname,"w"); if (!fd) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_FILE_OPEN,"Cannot open log file: %s",sname);
1309e5c89e4eSSatish Balay       ierr = PetscMallocDump(fd);CHKERRQ(ierr);
1310ed9cf6e9SBarry Smith       err  = fclose(fd);
1311e32f2f54SBarry Smith       if (err) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SYS,"fclose() failed on file");
1312dc92acbaSJed Brown     } else if (flg1 || flg2) {
1313e5c89e4eSSatish Balay       MPI_Comm local_comm;
1314e5c89e4eSSatish Balay 
1315e5c89e4eSSatish Balay       ierr = MPI_Comm_dup(MPI_COMM_WORLD,&local_comm);CHKERRQ(ierr);
1316e5c89e4eSSatish Balay       ierr = PetscSequentialPhaseBegin_Private(local_comm,1);CHKERRQ(ierr);
1317e5c89e4eSSatish Balay       ierr = PetscMallocDump(stdout);CHKERRQ(ierr);
1318e5c89e4eSSatish Balay       ierr = PetscSequentialPhaseEnd_Private(local_comm,1);CHKERRQ(ierr);
1319e5c89e4eSSatish Balay       ierr = MPI_Comm_free(&local_comm);CHKERRQ(ierr);
1320e5c89e4eSSatish Balay     }
1321e5c89e4eSSatish Balay   }
1322a64a8e02SBarry Smith 
13238bb29257SSatish Balay   {
1324e5c89e4eSSatish Balay     char fname[PETSC_MAX_PATH_LEN];
13250298fd71SBarry Smith     FILE *fd = NULL;
1326e5c89e4eSSatish Balay 
1327e5c89e4eSSatish Balay     fname[0] = 0;
1328a297a907SKarl Rupp 
13290298fd71SBarry Smith     ierr = PetscOptionsGetString(NULL,"-malloc_log",fname,250,&flg1);CHKERRQ(ierr);
13300298fd71SBarry Smith     ierr = PetscOptionsHasName(NULL,"-malloc_log_threshold",&flg2);CHKERRQ(ierr);
1331e5c89e4eSSatish Balay     if (flg1 && fname[0]) {
1332ed9cf6e9SBarry Smith       int err;
1333e5c89e4eSSatish Balay 
1334574034a9SJed Brown       if (!rank) {
1335574034a9SJed Brown         fd = fopen(fname,"w");
1336574034a9SJed Brown         if (!fd) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_FILE_OPEN,"Cannot open log file: %s",fname);
1337574034a9SJed Brown       }
1338e5c89e4eSSatish Balay       ierr = PetscMallocDumpLog(fd);CHKERRQ(ierr);
1339574034a9SJed Brown       if (fd) {
1340ed9cf6e9SBarry Smith         err = fclose(fd);
1341e32f2f54SBarry Smith         if (err) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SYS,"fclose() failed on file");
1342574034a9SJed Brown       }
1343574034a9SJed Brown     } else if (flg1 || flg2) {
1344e5c89e4eSSatish Balay       ierr = PetscMallocDumpLog(stdout);CHKERRQ(ierr);
1345e5c89e4eSSatish Balay     }
1346e5c89e4eSSatish Balay   }
134720e2c332SMatthew G. Knepley 
134820e2c332SMatthew G. Knepley #if defined(PETSC_HAVE_CUDA)
134920e2c332SMatthew G. Knepley   flg  = PETSC_TRUE;
135020e2c332SMatthew G. Knepley   ierr = PetscOptionsGetBool(NULL,"-cublas",&flg,NULL);CHKERRQ(ierr);
135120e2c332SMatthew G. Knepley   if (flg) {
135220e2c332SMatthew G. Knepley     PetscInt p;
135320e2c332SMatthew G. Knepley     for (p = 0; p < PetscGlobalSize; ++p) {
135420e2c332SMatthew G. Knepley       if (p == PetscGlobalRank) cublasShutdown();
135520e2c332SMatthew G. Knepley       ierr = MPI_Barrier(PETSC_COMM_WORLD);CHKERRQ(ierr);
135620e2c332SMatthew G. Knepley     }
135720e2c332SMatthew G. Knepley   }
135820e2c332SMatthew G. Knepley #endif
135920e2c332SMatthew G. Knepley 
1360e5c89e4eSSatish Balay   /* Can be destroyed only after all the options are used */
1361e5c89e4eSSatish Balay   ierr = PetscOptionsDestroy();CHKERRQ(ierr);
1362e5c89e4eSSatish Balay 
1363e5c89e4eSSatish Balay   PetscGlobalArgc = 0;
1364e5c89e4eSSatish Balay   PetscGlobalArgs = 0;
1365e5c89e4eSSatish Balay 
1366ce63c4c1SBarry Smith #if defined(PETSC_USE_REAL___FLOAT128)
1367c90a1750SBarry Smith   ierr = MPI_Type_free(&MPIU___FLOAT128);CHKERRQ(ierr);
13687c2de775SJed Brown #if defined(PETSC_HAVE_COMPLEX)
13698c764dc5SJose Roman   ierr = MPI_Type_free(&MPIU___COMPLEX128);CHKERRQ(ierr);
13708c764dc5SJose Roman #endif
1371d9822059SBarry Smith   ierr = MPI_Op_free(&MPIU_MAX);CHKERRQ(ierr);
1372d9822059SBarry Smith   ierr = MPI_Op_free(&MPIU_MIN);CHKERRQ(ierr);
1373c90a1750SBarry Smith #endif
1374c90a1750SBarry Smith 
13757c2de775SJed Brown #if defined(PETSC_HAVE_COMPLEX)
13762c876bd9SBarry Smith #if !defined(PETSC_HAVE_MPI_C_DOUBLE_COMPLEX)
1377500d8756SSatish Balay   ierr = MPI_Type_free(&MPIU_C_DOUBLE_COMPLEX);CHKERRQ(ierr);
1378500d8756SSatish Balay   ierr = MPI_Type_free(&MPIU_C_COMPLEX);CHKERRQ(ierr);
13792c876bd9SBarry Smith #endif
1380e5c89e4eSSatish Balay #endif
1381cca4cb22SSatish Balay 
13827c2de775SJed Brown #if (defined(PETSC_HAVE_COMPLEX) && !defined(PETSC_HAVE_MPI_C_DOUBLE_COMPLEX)) || defined(PETSC_USE_REAL___FLOAT128)
1383cca4cb22SSatish Balay   ierr = MPI_Op_free(&MPIU_SUM);CHKERRQ(ierr);
1384cca4cb22SSatish Balay #endif
1385cca4cb22SSatish Balay 
1386e5c89e4eSSatish Balay   ierr = MPI_Type_free(&MPIU_2SCALAR);CHKERRQ(ierr);
138744041f26SJed Brown #if defined(PETSC_USE_64BIT_INDICES) || !defined(MPI_2INT)
1388e5c89e4eSSatish Balay   ierr = MPI_Type_free(&MPIU_2INT);CHKERRQ(ierr);
138944041f26SJed Brown #endif
1390e5c89e4eSSatish Balay   ierr = MPI_Op_free(&PetscMaxSum_Op);CHKERRQ(ierr);
1391e5c89e4eSSatish Balay   ierr = MPI_Op_free(&PetscADMax_Op);CHKERRQ(ierr);
1392e5c89e4eSSatish Balay   ierr = MPI_Op_free(&PetscADMin_Op);CHKERRQ(ierr);
1393e5c89e4eSSatish Balay 
1394dbc8283eSBarry Smith   /*
1395efb80d3cSBarry Smith      Destroy any known inner MPI_Comm's and attributes pointing to them
1396efb80d3cSBarry Smith      Note this will not destroy any new communicators the user has created.
1397efb80d3cSBarry Smith 
1398efb80d3cSBarry Smith      If all PETSc objects were not destroyed those left over objects will have hanging references to
1399efb80d3cSBarry Smith      the MPI_Comms that were freed; but that is ok because those PETSc objects will never be used again
1400dbc8283eSBarry Smith  */
1401b770b1f6SSatish Balay   {
1402dbc8283eSBarry Smith     PetscCommCounter *counter;
1403dbc8283eSBarry Smith     PetscMPIInt      flg;
1404dbc8283eSBarry Smith     MPI_Comm         icomm;
1405265f3f35SJed Brown     union {MPI_Comm comm; void *ptr;} ucomm;
1406265f3f35SJed Brown     ierr = MPI_Attr_get(PETSC_COMM_SELF,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_SELF,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_SELF,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     }
1416265f3f35SJed Brown     ierr = MPI_Attr_get(PETSC_COMM_WORLD,Petsc_InnerComm_keyval,&ucomm,&flg);CHKERRQ(ierr);
1417dbc8283eSBarry Smith     if (flg) {
1418265f3f35SJed Brown       icomm = ucomm.comm;
1419dbc8283eSBarry Smith       ierr = MPI_Attr_get(icomm,Petsc_Counter_keyval,&counter,&flg);CHKERRQ(ierr);
1420dbc8283eSBarry 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");
1421dbc8283eSBarry Smith 
1422dbc8283eSBarry Smith       ierr = MPI_Attr_delete(PETSC_COMM_WORLD,Petsc_InnerComm_keyval);CHKERRQ(ierr);
1423efb80d3cSBarry Smith       ierr = MPI_Attr_delete(icomm,Petsc_Counter_keyval);CHKERRQ(ierr);
1424efb80d3cSBarry Smith       ierr = MPI_Comm_free(&icomm);CHKERRQ(ierr);
1425dbc8283eSBarry Smith     }
1426b770b1f6SSatish Balay   }
1427dbc8283eSBarry Smith 
1428480cf27aSJed Brown   ierr = MPI_Keyval_free(&Petsc_Counter_keyval);CHKERRQ(ierr);
1429480cf27aSJed Brown   ierr = MPI_Keyval_free(&Petsc_InnerComm_keyval);CHKERRQ(ierr);
1430480cf27aSJed Brown   ierr = MPI_Keyval_free(&Petsc_OuterComm_keyval);CHKERRQ(ierr);
1431480cf27aSJed Brown 
1432e5c89e4eSSatish Balay   if (PetscBeganMPI) {
143399608316SBarry Smith #if defined(PETSC_HAVE_MPI_FINALIZED)
143499b1327fSBarry Smith     PetscMPIInt flag;
143599b1327fSBarry Smith     ierr = MPI_Finalized(&flag);CHKERRQ(ierr);
1436e32f2f54SBarry Smith     if (flag) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_LIB,"MPI_Finalize() has already been called, even though MPI_Init() was called by PetscInitialize()");
143799608316SBarry Smith #endif
1438e5c89e4eSSatish Balay     ierr = MPI_Finalize();CHKERRQ(ierr);
1439e5c89e4eSSatish Balay   }
1440e5c89e4eSSatish Balay /*
1441e5c89e4eSSatish Balay 
1442e5c89e4eSSatish Balay      Note: In certain cases PETSC_COMM_WORLD is never MPI_Comm_free()ed because
1443e5c89e4eSSatish Balay    the communicator has some outstanding requests on it. Specifically if the
1444e5c89e4eSSatish Balay    flag PETSC_HAVE_BROKEN_REQUEST_FREE is set (for IBM MPI implementation). See
1445e5c89e4eSSatish Balay    src/vec/utils/vpscat.c. Due to this the memory allocated in PetscCommDuplicate()
1446e5c89e4eSSatish Balay    is never freed as it should be. Thus one may obtain messages of the form
14470e5e90baSSatish Balay    [ 1] 8 bytes PetscCommDuplicate() line 645 in src/sys/mpiu.c indicating the
1448e5c89e4eSSatish Balay    memory was not freed.
1449e5c89e4eSSatish Balay 
1450e5c89e4eSSatish Balay */
14511d1a0024SBarry Smith   ierr = PetscMallocClear();CHKERRQ(ierr);
1452a297a907SKarl Rupp 
1453e5c89e4eSSatish Balay   PetscInitializeCalled = PETSC_FALSE;
1454e5c89e4eSSatish Balay   PetscFinalizeCalled   = PETSC_TRUE;
1455e5c89e4eSSatish Balay   PetscFunctionReturn(ierr);
1456e5c89e4eSSatish Balay }
1457e5c89e4eSSatish Balay 
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 }
1466a70650f6SBarry Smith #endif
146743db4dbbSBarry Smith 
146843db4dbbSBarry Smith #if defined(PETSC_MISSING_LAPACK_lsame)
14698cc058d9SJed Brown PETSC_EXTERN int lsame(char *a,char *b)
147043db4dbbSBarry Smith {
147143db4dbbSBarry Smith   if (*a == *b) return 1;
147243db4dbbSBarry Smith   if (*a + 32 == *b) return 1;
147343db4dbbSBarry Smith   if (*a - 32 == *b) return 1;
147443db4dbbSBarry Smith   return 0;
147543db4dbbSBarry Smith }
147643db4dbbSBarry Smith #endif
1477