xref: /petsc/src/sys/objects/pinit.c (revision 82f73ecaae2ba6158892468c437f14f4e82707f0)
17d0a6c19SBarry Smith 
2e5c89e4eSSatish Balay /*
3e5c89e4eSSatish Balay    This file defines the initialization of PETSc, including PetscInitialize()
4e5c89e4eSSatish Balay */
5af0996ceSBarry Smith #include <petsc/private/petscimpl.h>        /*I  "petscsys.h"   I*/
6022afb99SBarry Smith #include <petscvalgrind.h>
7665c2dedSJed Brown #include <petscviewer.h>
88101f56cSMatthew Knepley 
9a9f03627SSatish Balay #if defined(PETSC_USE_LOG)
10896238b9SBarry Smith extern PetscErrorCode PetscLogInitialize(void);
11a9f03627SSatish Balay #endif
12f2d66bcaSShri Abhyankar 
132d53ad75SBarry Smith #if defined(PETSC_SERIALIZE_FUNCTIONS)
142d53ad75SBarry Smith PetscFPT PetscFPTData = 0;
152d53ad75SBarry Smith #endif
162d53ad75SBarry Smith 
17*82f73ecaSAlejandro Lamas Daviña #if defined(PETSC_HAVE_CUDA)
18*82f73ecaSAlejandro Lamas Daviña cublasHandle_t cublasv2handle = NULL;
19*82f73ecaSAlejandro Lamas Daviña #endif
20*82f73ecaSAlejandro Lamas Daviña 
21a6790183SBarry Smith #if defined(PETSC_HAVE_SAWS)
2216ad0300SBarry Smith #include <petscviewersaws.h>
23a6790183SBarry Smith #endif
24e5c89e4eSSatish Balay /* -----------------------------------------------------------------------------------------*/
25e5c89e4eSSatish Balay 
26e5c89e4eSSatish Balay extern FILE *petsc_history;
27e5c89e4eSSatish Balay 
2809573ac7SBarry Smith extern PetscErrorCode PetscInitialize_DynamicLibraries(void);
2909573ac7SBarry Smith extern PetscErrorCode PetscFinalize_DynamicLibraries(void);
3037e93019SBarry Smith extern PetscErrorCode PetscFunctionListPrintAll(void);
3109573ac7SBarry Smith extern PetscErrorCode PetscSequentialPhaseBegin_Private(MPI_Comm,int);
3209573ac7SBarry Smith extern PetscErrorCode PetscSequentialPhaseEnd_Private(MPI_Comm,int);
3309573ac7SBarry Smith extern PetscErrorCode PetscCloseHistoryFile(FILE**);
340069ddf5SShri Abhyankar 
35e5c89e4eSSatish Balay /* user may set this BEFORE calling PetscInitialize() */
36e8373e55SMatthew Knepley MPI_Comm PETSC_COMM_WORLD = MPI_COMM_NULL;
37e5c89e4eSSatish Balay 
38480cf27aSJed Brown PetscMPIInt Petsc_Counter_keyval   = MPI_KEYVAL_INVALID;
39480cf27aSJed Brown PetscMPIInt Petsc_InnerComm_keyval = MPI_KEYVAL_INVALID;
40480cf27aSJed Brown PetscMPIInt Petsc_OuterComm_keyval = MPI_KEYVAL_INVALID;
41480cf27aSJed Brown 
42e5c89e4eSSatish Balay /*
43e5c89e4eSSatish Balay      Declare and set all the string names of the PETSc enums
44e5c89e4eSSatish Balay */
456a6fc655SJed Brown const char *const PetscBools[]     = {"FALSE","TRUE","PetscBool","PETSC_",0};
466a6fc655SJed Brown const char *const PetscCopyModes[] = {"COPY_VALUES","OWN_POINTER","USE_POINTER","PetscCopyMode","PETSC_",0};
476a6fc655SJed Brown const char *const PetscDataTypes[] = {"INT","DOUBLE","COMPLEX","LONG","SHORT","FLOAT",
482d53ad75SBarry Smith                                       "CHAR","LOGICAL","ENUM","BOOL","LONGDOUBLE","OBJECT","FUNCTION","PetscDataType","PETSC_",0};
49e5c89e4eSSatish Balay 
50ace3abfcSBarry Smith PetscBool PetscPreLoadingUsed = PETSC_FALSE;
51ace3abfcSBarry Smith PetscBool PetscPreLoadingOn   = PETSC_FALSE;
520f8e0872SSatish Balay 
53a2f94806SJed Brown PetscInt PetscHotRegionDepth;
54a2f94806SJed Brown 
55e5c89e4eSSatish Balay /*
56e5c89e4eSSatish Balay        Checks the options database for initializations related to the
57e5c89e4eSSatish Balay     PETSc components
58e5c89e4eSSatish Balay */
59e5c89e4eSSatish Balay #undef __FUNCT__
60e5c89e4eSSatish Balay #define __FUNCT__ "PetscOptionsCheckInitial_Components"
617087cfbeSBarry Smith PetscErrorCode  PetscOptionsCheckInitial_Components(void)
62e5c89e4eSSatish Balay {
63ace3abfcSBarry Smith   PetscBool      flg1;
64e5c89e4eSSatish Balay   PetscErrorCode ierr;
65e5c89e4eSSatish Balay 
66e5c89e4eSSatish Balay   PetscFunctionBegin;
67c5929fdfSBarry Smith   ierr = PetscOptionsHasName(NULL,NULL,"-help",&flg1);CHKERRQ(ierr);
68e5c89e4eSSatish Balay   if (flg1) {
69e5c89e4eSSatish Balay #if defined(PETSC_USE_LOG)
70e8e7597cSSatish Balay     MPI_Comm comm = PETSC_COMM_WORLD;
71e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm,"------Additional PETSc component options--------\n");CHKERRQ(ierr);
729a9a5d4cSBarry Smith     ierr = (*PetscHelpPrintf)(comm," -log_summary_exclude: <vec,mat,pc.ksp,snes> (deprecated, use -log_exclude\n");CHKERRQ(ierr);
739a9a5d4cSBarry Smith     ierr = (*PetscHelpPrintf)(comm," -log_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 
20776f543a4SJed Brown     The reason sizes[2*i] contains lengths sizes[2*i+1] contains flag of 1 if length is nonzero
20876f543a4SJed Brown is so that the PetscMaxSum_Op() can set TWO values, if we passed in only sizes[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"
21376ec1555SBarry Smith PetscErrorCode  PetscMaxSum(MPI_Comm comm,const PetscInt sizes[],PetscInt *max,PetscInt *sum)
214e5c89e4eSSatish Balay {
215e5c89e4eSSatish Balay   PetscErrorCode ierr;
216e5c89e4eSSatish Balay 
217e5c89e4eSSatish Balay   PetscFunctionBegin;
218d6e4c47cSJed Brown #if defined(PETSC_HAVE_MPI_REDUCE_SCATTER_BLOCK)
219d6e4c47cSJed Brown   {
220d6e4c47cSJed Brown     struct {PetscInt max,sum;} work;
22176f543a4SJed Brown     ierr = MPI_Reduce_scatter_block((void*)sizes,&work,1,MPIU_2INT,PetscMaxSum_Op,comm);CHKERRQ(ierr);
222d6e4c47cSJed Brown     *max = work.max;
223d6e4c47cSJed Brown     *sum = work.sum;
224d6e4c47cSJed Brown   }
225d6e4c47cSJed Brown #else
226d6e4c47cSJed Brown   {
227d6e4c47cSJed Brown     PetscMPIInt    size,rank;
228d6e4c47cSJed Brown     struct {PetscInt max,sum;} *work;
229e5c89e4eSSatish Balay     ierr = MPI_Comm_size(comm,&size);CHKERRQ(ierr);
230e5c89e4eSSatish Balay     ierr = MPI_Comm_rank(comm,&rank);CHKERRQ(ierr);
231785e854fSJed Brown     ierr = PetscMalloc1(size,&work);CHKERRQ(ierr);
232b2566f29SBarry Smith     ierr = MPIU_Allreduce((void*)sizes,work,size,MPIU_2INT,PetscMaxSum_Op,comm);CHKERRQ(ierr);
2336ac3741eSJed Brown     *max = work[rank].max;
2346ac3741eSJed Brown     *sum = work[rank].sum;
235e5c89e4eSSatish Balay     ierr = PetscFree(work);CHKERRQ(ierr);
236d6e4c47cSJed Brown   }
237d6e4c47cSJed Brown #endif
238e5c89e4eSSatish Balay   PetscFunctionReturn(0);
239e5c89e4eSSatish Balay }
240e5c89e4eSSatish Balay 
241e5c89e4eSSatish Balay /* ----------------------------------------------------------------------------*/
242e5c89e4eSSatish Balay 
2437c2de775SJed Brown #if (defined(PETSC_HAVE_COMPLEX) && !defined(PETSC_HAVE_MPI_C_DOUBLE_COMPLEX)) || defined(PETSC_USE_REAL___FLOAT128)
24406a205a8SBarry Smith MPI_Op MPIU_SUM = 0;
245e5c89e4eSSatish Balay 
246e5c89e4eSSatish Balay #undef __FUNCT__
247e5c89e4eSSatish Balay #define __FUNCT__ "PetscSum_Local"
2488cc058d9SJed Brown PETSC_EXTERN void PetscSum_Local(void *in,void *out,PetscMPIInt *cnt,MPI_Datatype *datatype)
249e5c89e4eSSatish Balay {
250e5c89e4eSSatish Balay   PetscInt i,count = *cnt;
251e5c89e4eSSatish Balay 
252e5c89e4eSSatish Balay   PetscFunctionBegin;
2537c2de775SJed Brown   if (*datatype == MPIU_REAL) {
254e2e03761SBarry Smith     PetscReal *xin = (PetscReal*)in,*xout = (PetscReal*)out;
255a297a907SKarl Rupp     for (i=0; i<count; i++) xout[i] += xin[i];
2567c2de775SJed Brown   }
2577c2de775SJed Brown #if defined(PETSC_HAVE_COMPLEX)
2587c2de775SJed Brown   else if (*datatype == MPIU_COMPLEX) {
2597c2de775SJed Brown     PetscComplex *xin = (PetscComplex*)in,*xout = (PetscComplex*)out;
260a297a907SKarl Rupp     for (i=0; i<count; i++) xout[i] += xin[i];
2617c2de775SJed Brown   }
2627c2de775SJed Brown #endif
2637c2de775SJed Brown   else {
2647c2de775SJed Brown     (*PetscErrorPrintf)("Can only handle MPIU_REAL or MPIU_COMPLEX data types");
265e2e03761SBarry Smith     MPI_Abort(MPI_COMM_WORLD,1);
266e2e03761SBarry Smith   }
267812af9f3SBarry Smith   PetscFunctionReturnVoid();
268e5c89e4eSSatish Balay }
269e5c89e4eSSatish Balay #endif
270e5c89e4eSSatish Balay 
271ce63c4c1SBarry Smith #if defined(PETSC_USE_REAL___FLOAT128)
272d9822059SBarry Smith MPI_Op MPIU_MAX = 0;
273d9822059SBarry Smith MPI_Op MPIU_MIN = 0;
274d9822059SBarry Smith 
275d9822059SBarry Smith #undef __FUNCT__
276d9822059SBarry Smith #define __FUNCT__ "PetscMax_Local"
2778cc058d9SJed Brown PETSC_EXTERN void PetscMax_Local(void *in,void *out,PetscMPIInt *cnt,MPI_Datatype *datatype)
278d9822059SBarry Smith {
279d9822059SBarry Smith   PetscInt i,count = *cnt;
280d9822059SBarry Smith 
281d9822059SBarry Smith   PetscFunctionBegin;
2827c2de775SJed Brown   if (*datatype == MPIU_REAL) {
2838c764dc5SJose Roman     PetscReal *xin = (PetscReal*)in,*xout = (PetscReal*)out;
284a297a907SKarl Rupp     for (i=0; i<count; i++) xout[i] = PetscMax(xout[i],xin[i]);
2857c2de775SJed Brown   }
2867c2de775SJed Brown #if defined(PETSC_HAVE_COMPLEX)
2877c2de775SJed Brown   else if (*datatype == MPIU_COMPLEX) {
2887c2de775SJed Brown     PetscComplex *xin = (PetscComplex*)in,*xout = (PetscComplex*)out;
2897c2de775SJed Brown     for (i=0; i<count; i++) {
2907c2de775SJed Brown       xout[i] = PetscRealPartComplex(xout[i])<PetscRealPartComplex(xin[i]) ? xin[i] : xout[i];
2917c2de775SJed Brown     }
2927c2de775SJed Brown   }
2937c2de775SJed Brown #endif
2947c2de775SJed Brown   else {
2957c2de775SJed Brown     (*PetscErrorPrintf)("Can only handle MPIU_REAL or MPIU_COMPLEX data types");
2968c764dc5SJose Roman     MPI_Abort(MPI_COMM_WORLD,1);
2978c764dc5SJose Roman   }
298d9822059SBarry Smith   PetscFunctionReturnVoid();
299d9822059SBarry Smith }
300d9822059SBarry Smith 
301d9822059SBarry Smith #undef __FUNCT__
302d9822059SBarry Smith #define __FUNCT__ "PetscMin_Local"
3038cc058d9SJed Brown PETSC_EXTERN void PetscMin_Local(void *in,void *out,PetscMPIInt *cnt,MPI_Datatype *datatype)
304d9822059SBarry Smith {
305d9822059SBarry Smith   PetscInt    i,count = *cnt;
306d9822059SBarry Smith 
307d9822059SBarry Smith   PetscFunctionBegin;
3087c2de775SJed Brown   if (*datatype == MPIU_REAL) {
3098c764dc5SJose Roman     PetscReal *xin = (PetscReal*)in,*xout = (PetscReal*)out;
310a297a907SKarl Rupp     for (i=0; i<count; i++) xout[i] = PetscMin(xout[i],xin[i]);
3117c2de775SJed Brown   }
3127c2de775SJed Brown #if defined(PETSC_HAVE_COMPLEX)
3137c2de775SJed Brown   else if (*datatype == MPIU_COMPLEX) {
3147c2de775SJed Brown     PetscComplex *xin = (PetscComplex*)in,*xout = (PetscComplex*)out;
3157c2de775SJed Brown     for (i=0; i<count; i++) {
3167c2de775SJed Brown       xout[i] = PetscRealPartComplex(xout[i])>PetscRealPartComplex(xin[i]) ? xin[i] : xout[i];
3177c2de775SJed Brown     }
3187c2de775SJed Brown   }
3197c2de775SJed Brown #endif
3207c2de775SJed Brown   else {
3218c764dc5SJose Roman     (*PetscErrorPrintf)("Can only handle MPIU_REAL or MPIU_SCALAR data (i.e. double or complex) types");
3228c764dc5SJose Roman     MPI_Abort(MPI_COMM_WORLD,1);
3238c764dc5SJose Roman   }
324d9822059SBarry Smith   PetscFunctionReturnVoid();
325d9822059SBarry Smith }
326d9822059SBarry Smith #endif
327d9822059SBarry Smith 
328480cf27aSJed Brown #undef __FUNCT__
329480cf27aSJed Brown #define __FUNCT__ "Petsc_DelCounter"
330480cf27aSJed Brown /*
331480cf27aSJed Brown    Private routine to delete internal tag/name counter storage when a communicator is freed.
332480cf27aSJed Brown 
333ff0e51ddSBarry 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.
334480cf27aSJed Brown 
335480cf27aSJed Brown    Note: this is declared extern "C" because it is passed to MPI_Keyval_create()
336480cf27aSJed Brown 
337480cf27aSJed Brown */
3388cc058d9SJed Brown PETSC_EXTERN PetscMPIInt MPIAPI Petsc_DelCounter(MPI_Comm comm,PetscMPIInt keyval,void *count_val,void *extra_state)
339480cf27aSJed Brown {
340480cf27aSJed Brown   PetscErrorCode ierr;
341480cf27aSJed Brown 
342480cf27aSJed Brown   PetscFunctionBegin;
343480cf27aSJed Brown   ierr = PetscInfo1(0,"Deleting counter data in an MPI_Comm %ld\n",(long)comm);if (ierr) PetscFunctionReturn((PetscMPIInt)ierr);
344480cf27aSJed Brown   ierr = PetscFree(count_val);if (ierr) PetscFunctionReturn((PetscMPIInt)ierr);
345480cf27aSJed Brown   PetscFunctionReturn(MPI_SUCCESS);
346480cf27aSJed Brown }
347480cf27aSJed Brown 
348480cf27aSJed Brown #undef __FUNCT__
349da3039f7SJed Brown #define __FUNCT__ "Petsc_DelComm_Outer"
350480cf27aSJed Brown /*
351da3039f7SJed Brown   This is invoked on the outer comm as a result of either PetscCommDestroy() (via MPI_Attr_delete) or when the user
352da3039f7SJed Brown   calls MPI_Comm_free().
353da3039f7SJed Brown 
354da3039f7SJed Brown   This is the only entry point for breaking the links between inner and outer comms.
355480cf27aSJed Brown 
356ff0e51ddSBarry Smith   This is called by MPI, not by users. This is called when MPI_Comm_free() is called on the communicator.
357480cf27aSJed Brown 
358480cf27aSJed Brown   Note: this is declared extern "C" because it is passed to MPI_Keyval_create()
359480cf27aSJed Brown 
360480cf27aSJed Brown */
361da3039f7SJed Brown PETSC_EXTERN PetscMPIInt MPIAPI Petsc_DelComm_Outer(MPI_Comm comm,PetscMPIInt keyval,void *attr_val,void *extra_state)
362480cf27aSJed Brown {
363480cf27aSJed Brown   PetscErrorCode ierr;
364b89831e5SBarry Smith   PetscMPIInt    flg;
365265f3f35SJed Brown   union {MPI_Comm comm; void *ptr;} icomm,ocomm;
366480cf27aSJed Brown 
367480cf27aSJed Brown   PetscFunctionBegin;
368da3039f7SJed Brown   if (keyval != Petsc_InnerComm_keyval) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_CORRUPT,"Unexpected keyval");
369ec4fadc2SJed Brown   icomm.ptr = attr_val;
370da3039f7SJed Brown 
371265f3f35SJed Brown   ierr = MPI_Attr_get(icomm.comm,Petsc_OuterComm_keyval,&ocomm,&flg);CHKERRQ(ierr);
372b3ef52cdSBarry Smith   if (!flg) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_CORRUPT,"Inner MPI_Comm does not have expected reference to outer comm");
373da3039f7SJed Brown   if (ocomm.comm != comm) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_CORRUPT,"Inner MPI_Comm has reference to non-matching outer comm");
374da3039f7SJed Brown   ierr = MPI_Attr_delete(icomm.comm,Petsc_OuterComm_keyval);CHKERRQ(ierr); /* Calls Petsc_DelComm_Inner */
375da3039f7SJed 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);
376da3039f7SJed Brown   PetscFunctionReturn(MPI_SUCCESS);
377b89831e5SBarry Smith }
378da3039f7SJed Brown 
379da3039f7SJed Brown #undef __FUNCT__
380da3039f7SJed Brown #define __FUNCT__ "Petsc_DelComm_Inner"
381da3039f7SJed Brown /*
382da3039f7SJed Brown  * This is invoked on the inner comm when Petsc_DelComm_Outer calls MPI_Attr_delete.  It should not be reached any other way.
383da3039f7SJed Brown  */
384da3039f7SJed Brown PETSC_EXTERN PetscMPIInt MPIAPI Petsc_DelComm_Inner(MPI_Comm comm,PetscMPIInt keyval,void *attr_val,void *extra_state)
385da3039f7SJed Brown {
386da3039f7SJed Brown   PetscErrorCode ierr;
387da3039f7SJed Brown 
388da3039f7SJed Brown   PetscFunctionBegin;
389da3039f7SJed Brown   ierr = PetscInfo1(0,"Removing reference to PETSc communicator embedded in a user MPI_Comm %ld\n",(long)comm);if (ierr) PetscFunctionReturn((PetscMPIInt)ierr);
390480cf27aSJed Brown   PetscFunctionReturn(MPI_SUCCESS);
391480cf27aSJed Brown }
392480cf27aSJed Brown 
393951e3c8eSBarry Smith #if defined(PETSC_USE_PETSC_MPI_EXTERNAL32)
394e39fd77fSBarry Smith #if !defined(PETSC_WORDS_BIGENDIAN)
3958cc058d9SJed Brown PETSC_EXTERN PetscMPIInt PetscDataRep_extent_fn(MPI_Datatype,MPI_Aint*,void*);
3968cc058d9SJed Brown PETSC_EXTERN PetscMPIInt PetscDataRep_read_conv_fn(void*, MPI_Datatype,PetscMPIInt,void*,MPI_Offset,void*);
3978cc058d9SJed Brown PETSC_EXTERN PetscMPIInt PetscDataRep_write_conv_fn(void*, MPI_Datatype,PetscMPIInt,void*,MPI_Offset,void*);
398e39fd77fSBarry Smith #endif
399951e3c8eSBarry Smith #endif
400e39fd77fSBarry Smith 
4016ae9a8a6SBarry Smith int  PetscGlobalArgc   = 0;
4026ae9a8a6SBarry Smith char **PetscGlobalArgs = 0;
403dff31646SBarry Smith PetscSegBuffer PetscCitationsList;
404e5c89e4eSSatish Balay 
405e5c89e4eSSatish Balay #undef __FUNCT__
406051e4cf2SJed Brown #define __FUNCT__ "PetscCitationsInitialize"
407051e4cf2SJed Brown PetscErrorCode PetscCitationsInitialize()
408051e4cf2SJed Brown {
409051e4cf2SJed Brown   PetscErrorCode ierr;
410051e4cf2SJed Brown 
411051e4cf2SJed Brown   PetscFunctionBegin;
412051e4cf2SJed Brown   ierr = PetscSegBufferCreate(1,10000,&PetscCitationsList);CHKERRQ(ierr);
413840b20a7SSatish Balay   ierr = PetscCitationsRegister("@TechReport{petsc-user-ref,\n  Author = {Satish Balay and Shrirang Abhyankar and Mark F. Adams and Jed Brown and Peter Brune\n            and Kris Buschelman and Lisandro Dalcin and Victor Eijkhout and William D. Gropp\n            and Dinesh Kaushik and Matthew G. Knepley\n            and Lois Curfman McInnes and Karl Rupp and Barry F. Smith\n            and Stefano Zampini and Hong Zhang},\n  Title = {{PETS}c Users Manual},\n  Number = {ANL-95/11 - Revision 3.6},\n  Institution = {Argonne National Laboratory},\n  Year = {2015}\n}\n",NULL);CHKERRQ(ierr);
414051e4cf2SJed 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);
415051e4cf2SJed Brown   PetscFunctionReturn(0);
416051e4cf2SJed Brown }
417e5c89e4eSSatish Balay 
418e5c89e4eSSatish Balay #undef __FUNCT__
419e5c89e4eSSatish Balay #define __FUNCT__ "PetscGetArgs"
420e5c89e4eSSatish Balay /*@C
421e5c89e4eSSatish Balay    PetscGetArgs - Allows you to access the raw command line arguments anywhere
422e5c89e4eSSatish Balay      after PetscInitialize() is called but before PetscFinalize().
423e5c89e4eSSatish Balay 
424e5c89e4eSSatish Balay    Not Collective
425e5c89e4eSSatish Balay 
426e5c89e4eSSatish Balay    Output Parameters:
427e5c89e4eSSatish Balay +  argc - count of number of command line arguments
428e5c89e4eSSatish Balay -  args - the command line arguments
429e5c89e4eSSatish Balay 
430e5c89e4eSSatish Balay    Level: intermediate
431e5c89e4eSSatish Balay 
432e5c89e4eSSatish Balay    Notes:
433e5c89e4eSSatish Balay       This is usually used to pass the command line arguments into other libraries
434e5c89e4eSSatish Balay    that are called internally deep in PETSc or the application.
435e5c89e4eSSatish Balay 
436f177e3b1SBarry Smith       The first argument contains the program name as is normal for C arguments.
437f177e3b1SBarry Smith 
438e5c89e4eSSatish Balay    Concepts: command line arguments
439e5c89e4eSSatish Balay 
440793721a6SBarry Smith .seealso: PetscFinalize(), PetscInitializeFortran(), PetscGetArguments()
441e5c89e4eSSatish Balay 
442e5c89e4eSSatish Balay @*/
4437087cfbeSBarry Smith PetscErrorCode  PetscGetArgs(int *argc,char ***args)
444e5c89e4eSSatish Balay {
445e5c89e4eSSatish Balay   PetscFunctionBegin;
44617186662SBarry Smith   if (!PetscInitializeCalled && PetscFinalizeCalled) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ORDER,"You must call after PetscInitialize() but before PetscFinalize()");
447e5c89e4eSSatish Balay   *argc = PetscGlobalArgc;
448e5c89e4eSSatish Balay   *args = PetscGlobalArgs;
449e5c89e4eSSatish Balay   PetscFunctionReturn(0);
450e5c89e4eSSatish Balay }
451e5c89e4eSSatish Balay 
452e5c89e4eSSatish Balay #undef __FUNCT__
453793721a6SBarry Smith #define __FUNCT__ "PetscGetArguments"
454793721a6SBarry Smith /*@C
455793721a6SBarry Smith    PetscGetArguments - Allows you to access the  command line arguments anywhere
456793721a6SBarry Smith      after PetscInitialize() is called but before PetscFinalize().
457793721a6SBarry Smith 
458793721a6SBarry Smith    Not Collective
459793721a6SBarry Smith 
460793721a6SBarry Smith    Output Parameters:
461793721a6SBarry Smith .  args - the command line arguments
462793721a6SBarry Smith 
463793721a6SBarry Smith    Level: intermediate
464793721a6SBarry Smith 
465793721a6SBarry Smith    Notes:
466793721a6SBarry Smith       This does NOT start with the program name and IS null terminated (final arg is void)
467793721a6SBarry Smith 
468793721a6SBarry Smith    Concepts: command line arguments
469793721a6SBarry Smith 
470793721a6SBarry Smith .seealso: PetscFinalize(), PetscInitializeFortran(), PetscGetArgs(), PetscFreeArguments()
471793721a6SBarry Smith 
472793721a6SBarry Smith @*/
4737087cfbeSBarry Smith PetscErrorCode  PetscGetArguments(char ***args)
474793721a6SBarry Smith {
475793721a6SBarry Smith   PetscInt       i,argc = PetscGlobalArgc;
476793721a6SBarry Smith   PetscErrorCode ierr;
477793721a6SBarry Smith 
478793721a6SBarry Smith   PetscFunctionBegin;
47917186662SBarry Smith   if (!PetscInitializeCalled && PetscFinalizeCalled) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ORDER,"You must call after PetscInitialize() but before PetscFinalize()");
480717030eeSLisandro Dalcin   if (!argc) {*args = 0; PetscFunctionReturn(0);}
481785e854fSJed Brown   ierr = PetscMalloc1(argc,args);CHKERRQ(ierr);
482793721a6SBarry Smith   for (i=0; i<argc-1; i++) {
483793721a6SBarry Smith     ierr = PetscStrallocpy(PetscGlobalArgs[i+1],&(*args)[i]);CHKERRQ(ierr);
484793721a6SBarry Smith   }
485793721a6SBarry Smith   (*args)[argc-1] = 0;
486793721a6SBarry Smith   PetscFunctionReturn(0);
487793721a6SBarry Smith }
488793721a6SBarry Smith 
489793721a6SBarry Smith #undef __FUNCT__
490793721a6SBarry Smith #define __FUNCT__ "PetscFreeArguments"
491793721a6SBarry Smith /*@C
492793721a6SBarry Smith    PetscFreeArguments - Frees the memory obtained with PetscGetArguments()
493793721a6SBarry Smith 
494793721a6SBarry Smith    Not Collective
495793721a6SBarry Smith 
496793721a6SBarry Smith    Output Parameters:
497793721a6SBarry Smith .  args - the command line arguments
498793721a6SBarry Smith 
499793721a6SBarry Smith    Level: intermediate
500793721a6SBarry Smith 
501793721a6SBarry Smith    Concepts: command line arguments
502793721a6SBarry Smith 
503793721a6SBarry Smith .seealso: PetscFinalize(), PetscInitializeFortran(), PetscGetArgs(), PetscGetArguments()
504793721a6SBarry Smith 
505793721a6SBarry Smith @*/
5067087cfbeSBarry Smith PetscErrorCode  PetscFreeArguments(char **args)
507793721a6SBarry Smith {
508793721a6SBarry Smith   PetscInt       i = 0;
509793721a6SBarry Smith   PetscErrorCode ierr;
510793721a6SBarry Smith 
511793721a6SBarry Smith   PetscFunctionBegin;
512a297a907SKarl Rupp   if (!args) PetscFunctionReturn(0);
513793721a6SBarry Smith   while (args[i]) {
514793721a6SBarry Smith     ierr = PetscFree(args[i]);CHKERRQ(ierr);
515793721a6SBarry Smith     i++;
516793721a6SBarry Smith   }
517793721a6SBarry Smith   ierr = PetscFree(args);CHKERRQ(ierr);
518793721a6SBarry Smith   PetscFunctionReturn(0);
519793721a6SBarry Smith }
520793721a6SBarry Smith 
52111525c0dSBarry Smith #if defined(PETSC_HAVE_SAWS)
52230befbd2SBarry Smith #include <petscconfiginfo.h>
52330befbd2SBarry Smith 
52411525c0dSBarry Smith #undef __FUNCT__
52511525c0dSBarry Smith #define __FUNCT__ "PetscInitializeSAWs"
52611525c0dSBarry Smith PetscErrorCode  PetscInitializeSAWs(const char help[])
52711525c0dSBarry Smith {
52811525c0dSBarry Smith   if (!PetscGlobalRank) {
52930befbd2SBarry Smith     char           cert[PETSC_MAX_PATH_LEN],root[PETSC_MAX_PATH_LEN],*intro,programname[64],*appline,*options,version[64];
53011525c0dSBarry Smith     int            port;
531ffbd1cfbSBarry Smith     PetscBool      flg,rootlocal = PETSC_FALSE,flg2,selectport = PETSC_FALSE;
53211525c0dSBarry Smith     size_t         applinelen,introlen;
53311525c0dSBarry Smith     PetscErrorCode ierr;
534ffbd1cfbSBarry Smith     char           sawsurl[256];
53511525c0dSBarry Smith 
536c5929fdfSBarry Smith     ierr = PetscOptionsHasName(NULL,NULL,"-saws_log",&flg);CHKERRQ(ierr);
53711525c0dSBarry Smith     if (flg) {
53811525c0dSBarry Smith       char  sawslog[PETSC_MAX_PATH_LEN];
53911525c0dSBarry Smith 
540c5929fdfSBarry Smith       ierr = PetscOptionsGetString(NULL,NULL,"-saws_log",sawslog,PETSC_MAX_PATH_LEN,NULL);CHKERRQ(ierr);
54111525c0dSBarry Smith       if (sawslog[0]) {
54211525c0dSBarry Smith         PetscStackCallSAWs(SAWs_Set_Use_Logfile,(sawslog));
54311525c0dSBarry Smith       } else {
54411525c0dSBarry Smith         PetscStackCallSAWs(SAWs_Set_Use_Logfile,(NULL));
54511525c0dSBarry Smith       }
54611525c0dSBarry Smith     }
547c5929fdfSBarry Smith     ierr = PetscOptionsGetString(NULL,NULL,"-saws_https",cert,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr);
54811525c0dSBarry Smith     if (flg) {
54911525c0dSBarry Smith       PetscStackCallSAWs(SAWs_Set_Use_HTTPS,(cert));
55011525c0dSBarry Smith     }
551c5929fdfSBarry Smith     ierr = PetscOptionsGetBool(NULL,NULL,"-saws_port_auto_select",&selectport,NULL);CHKERRQ(ierr);
552ffbd1cfbSBarry Smith     if (selectport) {
553ffbd1cfbSBarry Smith         PetscStackCallSAWs(SAWs_Get_Available_Port,(&port));
554ffbd1cfbSBarry Smith         PetscStackCallSAWs(SAWs_Set_Port,(port));
555ffbd1cfbSBarry Smith     } else {
556c5929fdfSBarry Smith       ierr = PetscOptionsGetInt(NULL,NULL,"-saws_port",&port,&flg);CHKERRQ(ierr);
55711525c0dSBarry Smith       if (flg) {
55811525c0dSBarry Smith         PetscStackCallSAWs(SAWs_Set_Port,(port));
55911525c0dSBarry Smith       }
560ffbd1cfbSBarry Smith     }
561c5929fdfSBarry Smith     ierr = PetscOptionsGetString(NULL,NULL,"-saws_root",root,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr);
56211525c0dSBarry Smith     if (flg) {
56311525c0dSBarry Smith       PetscStackCallSAWs(SAWs_Set_Document_Root,(root));CHKERRQ(ierr);
56411525c0dSBarry Smith       ierr = PetscStrcmp(root,".",&rootlocal);CHKERRQ(ierr);
5659c1e0ce8SBarry Smith     } else {
566c5929fdfSBarry Smith       ierr = PetscOptionsHasName(NULL,NULL,"-saws_options",&flg);CHKERRQ(ierr);
5679c1e0ce8SBarry Smith       if (flg) {
5683c01dfcfSBarry Smith         ierr = PetscStrreplace(PETSC_COMM_WORLD,"${PETSC_DIR}/share/petsc/saws",root,PETSC_MAX_PATH_LEN);CHKERRQ(ierr);
5699c1e0ce8SBarry Smith         PetscStackCallSAWs(SAWs_Set_Document_Root,(root));CHKERRQ(ierr);
5709c1e0ce8SBarry Smith       }
57111525c0dSBarry Smith     }
572c5929fdfSBarry Smith     ierr = PetscOptionsHasName(NULL,NULL,"-saws_local",&flg2);CHKERRQ(ierr);
57311525c0dSBarry Smith     if (flg2) {
57411525c0dSBarry Smith       char jsdir[PETSC_MAX_PATH_LEN];
57511525c0dSBarry Smith       if (!flg) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SUP,"-saws_local option requires -saws_root option");
57611525c0dSBarry Smith       ierr = PetscSNPrintf(jsdir,PETSC_MAX_PATH_LEN,"%s/js",root);CHKERRQ(ierr);
57711525c0dSBarry Smith       ierr = PetscTestDirectory(jsdir,'r',&flg);CHKERRQ(ierr);
57811525c0dSBarry Smith       if (!flg) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_FILE_READ,"-saws_local option requires js directory in root directory");
57943da4ab2SBarry Smith       PetscStackCallSAWs(SAWs_Push_Local_Header,());CHKERRQ(ierr);
58011525c0dSBarry Smith     }
58111525c0dSBarry Smith     ierr = PetscGetProgramName(programname,64);CHKERRQ(ierr);
58211525c0dSBarry Smith     ierr = PetscStrlen(help,&applinelen);CHKERRQ(ierr);
58311525c0dSBarry Smith     introlen   = 4096 + applinelen;
58430a8c9c0SSurtai Han     applinelen += 1024;
58511525c0dSBarry Smith     ierr = PetscMalloc(applinelen,&appline);CHKERRQ(ierr);
58611525c0dSBarry Smith     ierr = PetscMalloc(introlen,&intro);CHKERRQ(ierr);
58711525c0dSBarry Smith 
58811525c0dSBarry Smith     if (rootlocal) {
58911525c0dSBarry Smith       ierr = PetscSNPrintf(appline,applinelen,"%s.c.html",programname);CHKERRQ(ierr);
59011525c0dSBarry Smith       ierr = PetscTestFile(appline,'r',&rootlocal);CHKERRQ(ierr);
59111525c0dSBarry Smith     }
59276a34f28SBarry Smith     ierr = PetscOptionsGetAll(NULL,&options);CHKERRQ(ierr);
59311525c0dSBarry Smith     if (rootlocal && help) {
59430befbd2SBarry 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);
59511525c0dSBarry Smith     } else if (help) {
59630a8c9c0SSurtai Han       ierr = PetscSNPrintf(appline,applinelen,"<center>Running %s %s</center><br><center><pre>%s</pre></center><br>",programname,options,help);
59711525c0dSBarry Smith     } else {
59830befbd2SBarry Smith       ierr = PetscSNPrintf(appline,applinelen,"<center> Running %s %s</center><br>\n",programname,options);
59911525c0dSBarry Smith     }
600b0bb5815SBarry Smith     ierr = PetscFree(options);CHKERRQ(ierr);
60130befbd2SBarry Smith     ierr = PetscGetVersion(version,sizeof(version));CHKERRQ(ierr);
60211525c0dSBarry Smith     ierr = PetscSNPrintf(intro,introlen,"<body>\n"
60311525c0dSBarry 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"
604df62c222SBarry Smith                                     "<center>This is the default PETSc application dashboard, from it you can access any published PETSc objects or logging data</center><br><center>%s configured with %s</center><br>\n"
605df62c222SBarry Smith                                     "%s",version,petscconfigureoptions,appline);
60643da4ab2SBarry Smith     PetscStackCallSAWs(SAWs_Push_Body,("index.html",0,intro));
60711525c0dSBarry Smith     ierr = PetscFree(intro);CHKERRQ(ierr);
60811525c0dSBarry Smith     ierr = PetscFree(appline);CHKERRQ(ierr);
60911525c0dSBarry Smith     PetscStackCallSAWs(SAWs_Initialize,());
610ffbd1cfbSBarry Smith     if (selectport) {
611ffbd1cfbSBarry Smith       PetscStackCallSAWs(SAWs_Get_FullURL,(sizeof(sawsurl),sawsurl));
612ffbd1cfbSBarry Smith       ierr = PetscPrintf(PETSC_COMM_WORLD,"Point your browser to %s for SAWs\n",sawsurl);CHKERRQ(ierr);
613ffbd1cfbSBarry Smith     }
6140af79b04SBarry Smith     ierr = PetscCitationsRegister("@TechReport{ saws,\n"
6150af79b04SBarry Smith                                   "  Author = {Matt Otten and Jed Brown and Barry Smith},\n"
6160af79b04SBarry Smith                                   "  Title  = {Scientific Application Web Server (SAWs) Users Manual},\n"
6170af79b04SBarry Smith                                   "  Institution = {Argonne National Laboratory},\n"
6180af79b04SBarry Smith                                   "  Year   = 2013\n}\n",NULL);CHKERRQ(ierr);
61911525c0dSBarry Smith   }
62011525c0dSBarry Smith   PetscFunctionReturn(0);
62111525c0dSBarry Smith }
62211525c0dSBarry Smith #endif
62311525c0dSBarry Smith 
624793721a6SBarry Smith #undef __FUNCT__
625e5c89e4eSSatish Balay #define __FUNCT__ "PetscInitialize"
626e5c89e4eSSatish Balay /*@C
627e5c89e4eSSatish Balay    PetscInitialize - Initializes the PETSc database and MPI.
628e5c89e4eSSatish Balay    PetscInitialize() calls MPI_Init() if that has yet to be called,
629e5c89e4eSSatish Balay    so this routine should always be called near the beginning of
630e5c89e4eSSatish Balay    your program -- usually the very first line!
631e5c89e4eSSatish Balay 
632e5c89e4eSSatish Balay    Collective on MPI_COMM_WORLD or PETSC_COMM_WORLD if it has been set
633e5c89e4eSSatish Balay 
634e5c89e4eSSatish Balay    Input Parameters:
635e5c89e4eSSatish Balay +  argc - count of number of command line arguments
636e5c89e4eSSatish Balay .  args - the command line arguments
6370298fd71SBarry Smith .  file - [optional] PETSc database file, also checks ~username/.petscrc and .petscrc use NULL to not check for
638fc2bca9aSBarry Smith           code specific file. Use -skip_petscrc in the code specific file to skip the .petscrc files
6390298fd71SBarry Smith -  help - [optional] Help message to print, use NULL for no message
640e5c89e4eSSatish Balay 
64105827820SBarry Smith    If you wish PETSc code to run ONLY on a subcommunicator of MPI_COMM_WORLD, create that
64205827820SBarry Smith    communicator first and assign it to PETSC_COMM_WORLD BEFORE calling PetscInitialize(). Thus if you are running a
64305827820SBarry Smith    four process job and two processes will run PETSc and have PetscInitialize() and PetscFinalize() and two process will not,
64405827820SBarry Smith    then do this. If ALL processes in the job are using PetscInitialize() and PetscFinalize() then you don't need to do this, even
64505827820SBarry Smith    if different subcommunicators of the job are doing different things with PETSc.
646e5c89e4eSSatish Balay 
647e5c89e4eSSatish Balay    Options Database Keys:
648e5c89e4eSSatish Balay +  -start_in_debugger [noxterm,dbx,xdb,gdb,...] - Starts program in debugger
649e5c89e4eSSatish Balay .  -on_error_attach_debugger [noxterm,dbx,xdb,gdb,...] - Starts debugger when error detected
650e5c89e4eSSatish Balay .  -on_error_emacs <machinename> causes emacsclient to jump to error file
651b52f573bSBarry Smith .  -on_error_abort calls abort() when error detected (no traceback)
652e8fb0fc0SBarry Smith .  -on_error_mpiabort calls MPI_abort() when error detected
653e8fb0fc0SBarry Smith .  -error_output_stderr prints error messages to stderr instead of the default stdout
654e8fb0fc0SBarry Smith .  -error_output_none does not print the error messages (but handles errors in the same way as if this was not called)
655e5c89e4eSSatish Balay .  -debugger_nodes [node1,node2,...] - Indicates nodes to start in debugger
656e5c89e4eSSatish Balay .  -debugger_pause [sleeptime] (in seconds) - Pauses debugger
657e5c89e4eSSatish Balay .  -stop_for_debugger - Print message on how to attach debugger manually to
658e5c89e4eSSatish Balay                         process and wait (-debugger_pause) seconds for attachment
6592fb0ec9aSBarry Smith .  -malloc - Indicates use of PETSc error-checking malloc (on by default for debug version of libraries)
660e5c89e4eSSatish Balay .  -malloc no - Indicates not to use error-checking malloc
6612fb0ec9aSBarry Smith .  -malloc_debug - check for memory corruption at EVERY malloc or free
662aee23540SBarry Smith .  -malloc_dump - prints a list of all unfreed memory at the end of the run
663dc92acbaSJed Brown .  -malloc_test - like -malloc_dump -malloc_debug, but only active for debugging builds
664e5c89e4eSSatish Balay .  -fp_trap - Stops on floating point exceptions (Note that on the
665e5c89e4eSSatish Balay               IBM RS6000 this slows code by at least a factor of 10.)
666e5c89e4eSSatish Balay .  -no_signal_handler - Indicates not to trap error signals
667e5c89e4eSSatish Balay .  -shared_tmp - indicates /tmp directory is shared by all processors
668e5c89e4eSSatish Balay .  -not_shared_tmp - each processor has own /tmp
669e5c89e4eSSatish Balay .  -tmp - alternative name of /tmp directory
670e5c89e4eSSatish Balay .  -get_total_flops - returns total flops done by all processors
6710841954dSBarry Smith -  -memory_view - Print memory usage at end of run
672e5c89e4eSSatish Balay 
673e5c89e4eSSatish Balay    Options Database Keys for Profiling:
674a7f22e61SSatish Balay    See Users-Manual: ch_profiling for details.
675495fc317SBarry Smith +  -info <optional filename> - Prints verbose information to the screen
676495fc317SBarry Smith .  -info_exclude <null,vec,mat,pc,ksp,snes,ts> - Excludes some of the verbose messages
677495fc317SBarry Smith .  -log_sync - Log the synchronization in scatters, inner products and norms
678495fc317SBarry Smith .  -log_trace [filename] - Print traces of all PETSc calls to the screen (useful to determine where a program
679e5c89e4eSSatish Balay         hangs without running in the debugger).  See PetscLogTraceBegin().
6809a9a5d4cSBarry Smith .  -log_view [:filename:format] - Prints summary of flop and timing information to screen or file, see PetscLogView().
6819a9a5d4cSBarry Smith .  -log_summary [filename] - (Deprecated, use -log_view) Prints summary of flop and timing information to screen. If the filename is specified the
682495fc317SBarry Smith         summary is written to the file.  See PetscLogView().
6839a9a5d4cSBarry Smith .  -log_exclude: <vec,mat,pc.ksp,snes> - excludes subset of object classes from logging
684495fc317SBarry Smith .  -log_all [filename] - Logs extensive profiling information  See PetscLogDump().
685495fc317SBarry Smith .  -log [filename] - Logs basic profiline information  See PetscLogDump().
686495fc317SBarry Smith -  -log_mpe [filename] - Creates a logfile viewable by the utility Jumpshot (in MPICH distribution)
687495fc317SBarry Smith 
6889a9a5d4cSBarry Smith     Only one of -log_trace, -log_view, -log_summary, -log_all, -log, or -log_mpe may be used at a time
689e5c89e4eSSatish Balay 
690ffbd1cfbSBarry Smith    Options Database Keys for SAWs:
691ffbd1cfbSBarry Smith +  -saws_port <portnumber> - port number to publish SAWs data, default is 8080
692ffbd1cfbSBarry Smith .  -saws_port_auto_select - have SAWs select a new unique port number where it publishes the data, the URL is printed to the screen
693ffbd1cfbSBarry Smith                             this is useful when you are running many jobs that utilize SAWs at the same time
694ffbd1cfbSBarry Smith .  -saws_log <filename> - save a log of all SAWs communication
695ffbd1cfbSBarry Smith .  -saws_https <certificate file> - have SAWs use HTTPS instead of HTTP
696ffbd1cfbSBarry Smith -  -saws_root <directory> - allow SAWs to have access to the given directory to search for requested resources and files
697ffbd1cfbSBarry Smith 
698e5c89e4eSSatish Balay    Environmental Variables:
699e5c89e4eSSatish Balay +   PETSC_TMP - alternative tmp directory
700e5c89e4eSSatish Balay .   PETSC_SHARED_TMP - tmp is shared by all processes
701e5c89e4eSSatish Balay .   PETSC_NOT_SHARED_TMP - each process has its own private tmp
702e5c89e4eSSatish Balay .   PETSC_VIEWER_SOCKET_PORT - socket number to use for socket viewer
703e5c89e4eSSatish Balay -   PETSC_VIEWER_SOCKET_MACHINE - machine to use for socket viewer to connect to
704e5c89e4eSSatish Balay 
705e5c89e4eSSatish Balay 
706e5c89e4eSSatish Balay    Level: beginner
707e5c89e4eSSatish Balay 
708e5c89e4eSSatish Balay    Notes:
709e5c89e4eSSatish Balay    If for some reason you must call MPI_Init() separately, call
710e5c89e4eSSatish Balay    it before PetscInitialize().
711e5c89e4eSSatish Balay 
712e5c89e4eSSatish Balay    Fortran Version:
713e5c89e4eSSatish Balay    In Fortran this routine has the format
714e5c89e4eSSatish Balay $       call PetscInitialize(file,ierr)
715e5c89e4eSSatish Balay 
716e5c89e4eSSatish Balay +   ierr - error return code
7170eb4c9c0SBarry Smith -  file - [optional] PETSc database file, also checks ~username/.petscrc and .petscrc use PETSC_NULL_CHARACTER to not check for
718fc2bca9aSBarry Smith           code specific file. Use -skip_petscrc in the code specific file to skip the .petscrc files
719e5c89e4eSSatish Balay 
720e5c89e4eSSatish Balay    Important Fortran Note:
7210eb4c9c0SBarry Smith    In Fortran, you MUST use PETSC_NULL_CHARACTER to indicate a
7220298fd71SBarry Smith    null character string; you CANNOT just use NULL as
723a7f22e61SSatish Balay    in the C version. See Users-Manual: ch_fortran for details.
724e5c89e4eSSatish Balay 
72501cb0274SBarry Smith    If your main program is C but you call Fortran code that also uses PETSc you need to call PetscInitializeFortran() soon after
72601cb0274SBarry Smith    calling PetscInitialize().
727e5c89e4eSSatish Balay 
728e5c89e4eSSatish Balay    Concepts: initializing PETSc
729e5c89e4eSSatish Balay 
73001cb0274SBarry Smith .seealso: PetscFinalize(), PetscInitializeFortran(), PetscGetArgs(), PetscInitializeNoArguments()
731e5c89e4eSSatish Balay 
732e5c89e4eSSatish Balay @*/
7337087cfbeSBarry Smith PetscErrorCode  PetscInitialize(int *argc,char ***args,const char file[],const char help[])
734e5c89e4eSSatish Balay {
735e5c89e4eSSatish Balay   PetscErrorCode ierr;
7364bb5149bSJed Brown   PetscMPIInt    flag, size;
737ace3abfcSBarry Smith   PetscBool      flg;
738e5c89e4eSSatish Balay   char           hostname[256];
739*82f73ecaSAlejandro Lamas Daviña #if defined(PETSC_HAVE_CUDA)
740*82f73ecaSAlejandro Lamas Daviña   cublasStatus_t cberr;
741*82f73ecaSAlejandro Lamas Daviña #endif
742e5c89e4eSSatish Balay 
743e5c89e4eSSatish Balay   PetscFunctionBegin;
744e5c89e4eSSatish Balay   if (PetscInitializeCalled) PetscFunctionReturn(0);
745e5c89e4eSSatish Balay 
746ae9b4142SLisandro Dalcin   /* these must be initialized in a routine, not as a constant declaration*/
747d89683f4Sbcordonn   PETSC_STDOUT = stdout;
748ae9b4142SLisandro Dalcin   PETSC_STDERR = stderr;
749e5c89e4eSSatish Balay 
7500c30907bSSatish Balay   /* on Windows - set printf to default to printing 2 digit exponents */
7510c30907bSSatish Balay #if defined(PETSC_HAVE__SET_OUTPUT_FORMAT)
7520c30907bSSatish Balay   _set_output_format(_TWO_DIGIT_EXPONENT);
7530c30907bSSatish Balay #endif
7540c30907bSSatish Balay 
7554416b707SBarry Smith   ierr = PetscOptionsCreateDefault();CHKERRQ(ierr);
756e5c89e4eSSatish Balay 
757e5c89e4eSSatish Balay   /*
758e5c89e4eSSatish Balay      We initialize the program name here (before MPI_Init()) because MPICH has a bug in
759e5c89e4eSSatish Balay      it that it sets args[0] on all processors to be args[0] on the first processor.
760e5c89e4eSSatish Balay   */
761e5c89e4eSSatish Balay   if (argc && *argc) {
762e5c89e4eSSatish Balay     ierr = PetscSetProgramName(**args);CHKERRQ(ierr);
763e5c89e4eSSatish Balay   } else {
764e5c89e4eSSatish Balay     ierr = PetscSetProgramName("Unknown Name");CHKERRQ(ierr);
765e5c89e4eSSatish Balay   }
766e5c89e4eSSatish Balay 
767e5c89e4eSSatish Balay   ierr = MPI_Initialized(&flag);CHKERRQ(ierr);
768e5c89e4eSSatish Balay   if (!flag) {
769e32f2f54SBarry 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");
7705e765c61SJed Brown #if defined(PETSC_HAVE_MPI_INIT_THREAD)
7715e765c61SJed Brown     {
7725e765c61SJed Brown       PetscMPIInt provided;
7735e765c61SJed Brown       ierr = MPI_Init_thread(argc,args,MPI_THREAD_FUNNELED,&provided);CHKERRQ(ierr);
7745e765c61SJed Brown     }
7755e765c61SJed Brown #else
776e5c89e4eSSatish Balay     ierr = MPI_Init(argc,args);CHKERRQ(ierr);
7775e765c61SJed Brown #endif
778e5c89e4eSSatish Balay     PetscBeganMPI = PETSC_TRUE;
779e5c89e4eSSatish Balay   }
780e5c89e4eSSatish Balay   if (argc && args) {
781e5c89e4eSSatish Balay     PetscGlobalArgc = *argc;
782e5c89e4eSSatish Balay     PetscGlobalArgs = *args;
783e5c89e4eSSatish Balay   }
784e5c89e4eSSatish Balay   PetscFinalizeCalled = PETSC_FALSE;
7855ad9ad5bSBarry Smith   ierr = PetscSpinlockCreate(&PetscViewerASCIISpinLockOpen);CHKERRQ(ierr);
7865ad9ad5bSBarry Smith   ierr = PetscSpinlockCreate(&PetscViewerASCIISpinLockStdout);CHKERRQ(ierr);
7875ad9ad5bSBarry Smith   ierr = PetscSpinlockCreate(&PetscViewerASCIISpinLockStderr);CHKERRQ(ierr);
788ef19f930SBarry Smith   ierr = PetscSpinlockCreate(&PetscCommSpinLock);CHKERRQ(ierr);
789e5c89e4eSSatish Balay 
790a297a907SKarl Rupp   if (PETSC_COMM_WORLD == MPI_COMM_NULL) PETSC_COMM_WORLD = MPI_COMM_WORLD;
791d54338ecSKarl Rupp   ierr = MPI_Comm_set_errhandler(PETSC_COMM_WORLD,MPI_ERRORS_RETURN);CHKERRQ(ierr);
792e5c89e4eSSatish Balay 
793e5c89e4eSSatish Balay   /* Done after init due to a bug in MPICH-GM? */
794e5c89e4eSSatish Balay   ierr = PetscErrorPrintfInitialize();CHKERRQ(ierr);
795e5c89e4eSSatish Balay 
796e5c89e4eSSatish Balay   ierr = MPI_Comm_rank(MPI_COMM_WORLD,&PetscGlobalRank);CHKERRQ(ierr);
797e5c89e4eSSatish Balay   ierr = MPI_Comm_size(MPI_COMM_WORLD,&PetscGlobalSize);CHKERRQ(ierr);
798e5c89e4eSSatish Balay 
7998ad47952SJed Brown   MPIU_BOOL = MPI_INT;
8008ad47952SJed Brown   MPIU_ENUM = MPI_INT;
8018ad47952SJed Brown 
802e5c89e4eSSatish Balay   /*
803e5c89e4eSSatish Balay      Initialized the global complex variable; this is because with
804e5c89e4eSSatish Balay      shared libraries the constructors for global variables
805e5c89e4eSSatish Balay      are not called; at least on IRIX.
806e5c89e4eSSatish Balay   */
807886cfec0SSatish Balay #if defined(PETSC_HAVE_COMPLEX)
808e5c89e4eSSatish Balay   {
809a24ee22aSSatish Balay #if defined(PETSC_CLANGUAGE_CXX)
81050f81f78SJed Brown     PetscComplex ic(0.0,1.0);
811e5c89e4eSSatish Balay     PETSC_i = ic;
812a24ee22aSSatish Balay #elif defined(PETSC_CLANGUAGE_C)
81350f81f78SJed Brown     PETSC_i = _Complex_I;
814b7940d39SSatish Balay #endif
815762437b8SSatish Balay   }
816762437b8SSatish Balay 
8172c876bd9SBarry Smith #if !defined(PETSC_HAVE_MPI_C_DOUBLE_COMPLEX)
818e69cd0e6SSatish Balay   ierr = MPI_Type_contiguous(2,MPI_DOUBLE,&MPIU_C_DOUBLE_COMPLEX);CHKERRQ(ierr);
819500d8756SSatish Balay   ierr = MPI_Type_commit(&MPIU_C_DOUBLE_COMPLEX);CHKERRQ(ierr);
820500d8756SSatish Balay   ierr = MPI_Type_contiguous(2,MPI_FLOAT,&MPIU_C_COMPLEX);CHKERRQ(ierr);
821500d8756SSatish Balay   ierr = MPI_Type_commit(&MPIU_C_COMPLEX);CHKERRQ(ierr);
8222c876bd9SBarry Smith #endif
823886cfec0SSatish Balay #endif /* PETSC_HAVE_COMPLEX */
824e5c89e4eSSatish Balay 
825e5c89e4eSSatish Balay   /*
826e5c89e4eSSatish Balay      Create the PETSc MPI reduction operator that sums of the first
827e5c89e4eSSatish Balay      half of the entries and maxes the second half.
828e5c89e4eSSatish Balay   */
829e5c89e4eSSatish Balay   ierr = MPI_Op_create(PetscMaxSum_Local,1,&PetscMaxSum_Op);CHKERRQ(ierr);
830e5c89e4eSSatish Balay 
831ce63c4c1SBarry Smith #if defined(PETSC_USE_REAL___FLOAT128)
832c90a1750SBarry Smith   ierr = MPI_Type_contiguous(2,MPI_DOUBLE,&MPIU___FLOAT128);CHKERRQ(ierr);
833c90a1750SBarry Smith   ierr = MPI_Type_commit(&MPIU___FLOAT128);CHKERRQ(ierr);
8347c2de775SJed Brown #if defined(PETSC_HAVE_COMPLEX)
8358c764dc5SJose Roman   ierr = MPI_Type_contiguous(4,MPI_DOUBLE,&MPIU___COMPLEX128);CHKERRQ(ierr);
8368c764dc5SJose Roman   ierr = MPI_Type_commit(&MPIU___COMPLEX128);CHKERRQ(ierr);
8378c764dc5SJose Roman #endif
838d9822059SBarry Smith   ierr = MPI_Op_create(PetscMax_Local,1,&MPIU_MAX);CHKERRQ(ierr);
839d9822059SBarry Smith   ierr = MPI_Op_create(PetscMin_Local,1,&MPIU_MIN);CHKERRQ(ierr);
840c90a1750SBarry Smith #endif
841c90a1750SBarry Smith 
8427c2de775SJed Brown #if (defined(PETSC_HAVE_COMPLEX) && !defined(PETSC_HAVE_MPI_C_DOUBLE_COMPLEX)) || defined(PETSC_USE_REAL___FLOAT128)
843cca4cb22SSatish Balay   ierr = MPI_Op_create(PetscSum_Local,1,&MPIU_SUM);CHKERRQ(ierr);
844cca4cb22SSatish Balay #endif
845cca4cb22SSatish Balay 
846e5c89e4eSSatish Balay   ierr = MPI_Type_contiguous(2,MPIU_SCALAR,&MPIU_2SCALAR);CHKERRQ(ierr);
847e5c89e4eSSatish Balay   ierr = MPI_Type_commit(&MPIU_2SCALAR);CHKERRQ(ierr);
848e5c89e4eSSatish Balay 
84944041f26SJed Brown #if defined(PETSC_USE_64BIT_INDICES) || !defined(MPI_2INT)
850e5c89e4eSSatish Balay   ierr = MPI_Type_contiguous(2,MPIU_INT,&MPIU_2INT);CHKERRQ(ierr);
851e5c89e4eSSatish Balay   ierr = MPI_Type_commit(&MPIU_2INT);CHKERRQ(ierr);
85244041f26SJed Brown #endif
853e5c89e4eSSatish Balay 
854ec957eceSBarry Smith 
855e5c89e4eSSatish Balay   /*
856480cf27aSJed Brown      Attributes to be set on PETSc communicators
857480cf27aSJed Brown   */
858480cf27aSJed Brown   ierr = MPI_Keyval_create(MPI_NULL_COPY_FN,Petsc_DelCounter,&Petsc_Counter_keyval,(void*)0);CHKERRQ(ierr);
859da3039f7SJed Brown   ierr = MPI_Keyval_create(MPI_NULL_COPY_FN,Petsc_DelComm_Outer,&Petsc_InnerComm_keyval,(void*)0);CHKERRQ(ierr);
860da3039f7SJed Brown   ierr = MPI_Keyval_create(MPI_NULL_COPY_FN,Petsc_DelComm_Inner,&Petsc_OuterComm_keyval,(void*)0);CHKERRQ(ierr);
861480cf27aSJed Brown 
862480cf27aSJed Brown   /*
863e8fb0fc0SBarry Smith      Build the options database
864e5c89e4eSSatish Balay   */
865c5929fdfSBarry Smith   ierr = PetscOptionsInsert(NULL,argc,args,file);CHKERRQ(ierr);
866e5c89e4eSSatish Balay 
8676dc8fec2Sbcordonn 
868e5c89e4eSSatish Balay   /*
869e5c89e4eSSatish Balay      Print main application help message
870e5c89e4eSSatish Balay   */
871c5929fdfSBarry Smith   ierr = PetscOptionsHasName(NULL,NULL,"-help",&flg);CHKERRQ(ierr);
872e5c89e4eSSatish Balay   if (help && flg) {
873e5c89e4eSSatish Balay     ierr = PetscPrintf(PETSC_COMM_WORLD,help);CHKERRQ(ierr);
874e5c89e4eSSatish Balay   }
875e5c89e4eSSatish Balay   ierr = PetscOptionsCheckInitial_Private();CHKERRQ(ierr);
876e5c89e4eSSatish Balay 
877d45a07a7SBarry Smith   ierr = PetscCitationsInitialize();CHKERRQ(ierr);
878d45a07a7SBarry Smith 
879e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS)
88011525c0dSBarry Smith   ierr = PetscInitializeSAWs(help);CHKERRQ(ierr);
881f4202a44SBarry Smith #endif
882f4202a44SBarry Smith 
883896238b9SBarry Smith   /* Creates the logging data structures; this is enabled even if logging is not turned on */
884a9f03627SSatish Balay #if defined(PETSC_USE_LOG)
885896238b9SBarry Smith   ierr = PetscLogInitialize();CHKERRQ(ierr);
886a9f03627SSatish Balay #endif
887e5c89e4eSSatish Balay 
888e5c89e4eSSatish Balay   /*
889e5c89e4eSSatish Balay      Load the dynamic libraries (on machines that support them), this registers all
890e5c89e4eSSatish Balay      the solvers etc. (On non-dynamic machines this initializes the PetscDraw and PetscViewer classes)
891e5c89e4eSSatish Balay   */
892e5c89e4eSSatish Balay   ierr = PetscInitialize_DynamicLibraries();CHKERRQ(ierr);
893e5c89e4eSSatish Balay 
894e5c89e4eSSatish Balay   ierr = MPI_Comm_size(PETSC_COMM_WORLD,&size);CHKERRQ(ierr);
895ae15b995SBarry Smith   ierr = PetscInfo1(0,"PETSc successfully started: number of processors = %d\n",size);CHKERRQ(ierr);
896e5c89e4eSSatish Balay   ierr = PetscGetHostName(hostname,256);CHKERRQ(ierr);
897ae15b995SBarry Smith   ierr = PetscInfo1(0,"Running on machine: %s\n",hostname);CHKERRQ(ierr);
898e5c89e4eSSatish Balay 
899e5c89e4eSSatish Balay   ierr = PetscOptionsCheckInitial_Components();CHKERRQ(ierr);
900ef6c6fedSBoyana Norris   /* Check the options database for options related to the options database itself */
901c5929fdfSBarry Smith   ierr = PetscOptionsSetFromOptions(NULL);CHKERRQ(ierr);
902ef6c6fedSBoyana Norris 
903951e3c8eSBarry Smith #if defined(PETSC_USE_PETSC_MPI_EXTERNAL32)
904e39fd77fSBarry Smith   /*
905e39fd77fSBarry Smith       Tell MPI about our own data representation converter, this would/should be used if extern32 is not supported by the MPI
906e39fd77fSBarry Smith 
907e39fd77fSBarry Smith       Currently not used because it is not supported by MPICH.
908e39fd77fSBarry Smith   */
909e39fd77fSBarry Smith #if !defined(PETSC_WORDS_BIGENDIAN)
9100298fd71SBarry Smith   ierr = MPI_Register_datarep((char*)"petsc",PetscDataRep_read_conv_fn,PetscDataRep_write_conv_fn,PetscDataRep_extent_fn,NULL);CHKERRQ(ierr);
911e39fd77fSBarry Smith #endif
912951e3c8eSBarry Smith #endif
913e39fd77fSBarry Smith 
91435d88935SVictor Minden #if defined(PETSC_HAVE_CUDA)
91520e2c332SMatthew G. Knepley   flg  = PETSC_TRUE;
916c5929fdfSBarry Smith   ierr = PetscOptionsGetBool(NULL,NULL,"-cublas",&flg,NULL);CHKERRQ(ierr);
91720e2c332SMatthew G. Knepley   if (flg) {
9184bb5149bSJed Brown     PetscMPIInt p;
919663ba86aSMatthew G Knepley     for (p = 0; p < PetscGlobalSize; ++p) {
920*82f73ecaSAlejandro Lamas Daviña       if (p == PetscGlobalRank) {
921*82f73ecaSAlejandro Lamas Daviña         cberr = cublasCreate(&cublasv2handle);CHKERRCUBLAS(cberr);
922*82f73ecaSAlejandro Lamas Daviña       }
923663ba86aSMatthew G Knepley       ierr = MPI_Barrier(PETSC_COMM_WORLD);CHKERRQ(ierr);
924663ba86aSMatthew G Knepley     }
9254bb5149bSJed Brown   }
9263e39abd9SVictor Minden #endif
92792e62aa6SBarry Smith 
928c5929fdfSBarry Smith   ierr = PetscOptionsHasName(NULL,NULL,"-python",&flg);CHKERRQ(ierr);
9299ac80d5eSLisandro Dalcin   if (flg) {
9309ac80d5eSLisandro Dalcin     PetscInitializeCalled = PETSC_TRUE;
9310298fd71SBarry Smith     ierr = PetscPythonInitialize(NULL,NULL);CHKERRQ(ierr);
9329ac80d5eSLisandro Dalcin   }
9339ac80d5eSLisandro Dalcin 
93441c0b4b3SShri Abhyankar   /*
93541c0b4b3SShri Abhyankar       Setup building of stack frames for all function calls
93641c0b4b3SShri Abhyankar   */
937ef19f930SBarry Smith #if defined(PETSC_USE_DEBUG) && !defined(PETSC_HAVE_THREADSAFETY)
938e1167bb9SShri Abhyankar   ierr = PetscStackCreate();CHKERRQ(ierr);
939e1167bb9SShri Abhyankar #endif
940e1167bb9SShri Abhyankar 
9412d53ad75SBarry Smith #if defined(PETSC_SERIALIZE_FUNCTIONS)
9422d53ad75SBarry Smith   ierr = PetscFPTCreate(10000);CHKERRQ(ierr);
9432d53ad75SBarry Smith #endif
9442d53ad75SBarry Smith 
945dff31646SBarry Smith 
946301d30feSBarry Smith   /*
947301d30feSBarry Smith       Once we are completedly initialized then we can set this variables
948301d30feSBarry Smith   */
949301d30feSBarry Smith   PetscInitializeCalled = PETSC_TRUE;
950301d30feSBarry Smith   PetscFunctionReturn(0);
951e5c89e4eSSatish Balay }
952e5c89e4eSSatish Balay 
9534097062eSBarry Smith #if defined(PETSC_USE_LOG)
9542eff7a51SBarry Smith extern PetscObject *PetscObjects;
9552eff7a51SBarry Smith extern PetscInt    PetscObjectsCounts, PetscObjectsMaxCounts;
95605df10baSBarry Smith extern PetscBool   PetscObjectsLog;
9574097062eSBarry Smith #endif
958e5c89e4eSSatish Balay 
959e5c89e4eSSatish Balay #undef __FUNCT__
960e5c89e4eSSatish Balay #define __FUNCT__ "PetscFinalize"
961e5c89e4eSSatish Balay /*@C
962e5c89e4eSSatish Balay    PetscFinalize - Checks for options to be called at the conclusion
963e5c89e4eSSatish Balay    of the program. MPI_Finalize() is called only if the user had not
964e5c89e4eSSatish Balay    called MPI_Init() before calling PetscInitialize().
965e5c89e4eSSatish Balay 
966e5c89e4eSSatish Balay    Collective on PETSC_COMM_WORLD
967e5c89e4eSSatish Balay 
968e5c89e4eSSatish Balay    Options Database Keys:
96988c29154SBarry Smith +  -options_table - Calls PetscOptionsView()
970e5c89e4eSSatish Balay .  -options_left - Prints unused options that remain in the database
9717eb1d149SBarry 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
972e5c89e4eSSatish Balay .  -mpidump - Calls PetscMPIDump()
973e5c89e4eSSatish Balay .  -malloc_dump - Calls PetscMallocDump()
974e5c89e4eSSatish Balay .  -malloc_info - Prints total memory usage
975e5c89e4eSSatish Balay -  -malloc_log - Prints summary of memory usage
976e5c89e4eSSatish Balay 
977e5c89e4eSSatish Balay    Level: beginner
978e5c89e4eSSatish Balay 
979e5c89e4eSSatish Balay    Note:
980e5c89e4eSSatish Balay    See PetscInitialize() for more general runtime options.
981e5c89e4eSSatish Balay 
98288c29154SBarry Smith .seealso: PetscInitialize(), PetscOptionsView(), PetscMallocDump(), PetscMPIDump(), PetscEnd()
983e5c89e4eSSatish Balay @*/
9847087cfbeSBarry Smith PetscErrorCode  PetscFinalize(void)
985e5c89e4eSSatish Balay {
986e5c89e4eSSatish Balay   PetscErrorCode ierr;
9874bb5149bSJed Brown   PetscMPIInt    rank;
988a8d2bbe5SBarry Smith   PetscInt       nopt;
9892bf49c77SBarry Smith   PetscBool      flg1 = PETSC_FALSE,flg2 = PETSC_FALSE,flg3 = PETSC_FALSE;
990dff31646SBarry Smith   PetscBool      flg;
99110463e74SBarry Smith #if defined(PETSC_USE_LOG)
99210463e74SBarry Smith   char           mname[PETSC_MAX_PATH_LEN];
99310463e74SBarry Smith #endif
994*82f73ecaSAlejandro Lamas Daviña #if defined(PETSC_HAVE_CUDA)
995*82f73ecaSAlejandro Lamas Daviña   cublasStatus_t cberr;
996*82f73ecaSAlejandro Lamas Daviña #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 
1007c5929fdfSBarry Smith   ierr = PetscOptionsHasName(NULL,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 
1012c5929fdfSBarry Smith     ierr = PetscOptionsGetString(NULL,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 
1028c2a97968SBarry Smith #if defined(PETSC_HAVE_SSL) && defined(PETSC_USE_SOCKET_VIEWER)
102904102261SBarry Smith   /* TextBelt is run for testing purposes only, please do not use this feature often */
103004102261SBarry Smith   {
103104102261SBarry Smith     PetscInt nmax = 2;
103204102261SBarry Smith     char     **buffs;
103304102261SBarry Smith     ierr = PetscMalloc1(2,&buffs);CHKERRQ(ierr);
1034c5929fdfSBarry Smith     ierr = PetscOptionsGetStringArray(NULL,NULL,"-textbelt",buffs,&nmax,&flg1);CHKERRQ(ierr);
103504102261SBarry Smith     if (flg1) {
103604102261SBarry Smith       if (!nmax) SETERRQ(PETSC_COMM_WORLD,PETSC_ERR_USER,"-textbelt requires either the phone number or number,\"message\"");
103704102261SBarry Smith       if (nmax == 1) {
103804102261SBarry Smith         ierr = PetscMalloc1(128,&buffs[1]);CHKERRQ(ierr);
103904102261SBarry Smith         ierr = PetscGetProgramName(buffs[1],32);CHKERRQ(ierr);
104004102261SBarry Smith         ierr = PetscStrcat(buffs[1]," has completed");CHKERRQ(ierr);
104104102261SBarry Smith       }
104204102261SBarry Smith       ierr = PetscTextBelt(PETSC_COMM_WORLD,buffs[0],buffs[1],NULL);CHKERRQ(ierr);
104304102261SBarry Smith       ierr = PetscFree(buffs[0]);CHKERRQ(ierr);
104404102261SBarry Smith       ierr = PetscFree(buffs[1]);CHKERRQ(ierr);
104504102261SBarry Smith     }
104604102261SBarry Smith     ierr = PetscFree(buffs);CHKERRQ(ierr);
104704102261SBarry Smith   }
104804102261SBarry Smith #endif
104967234432SDmitry Karpeev   /*
105067234432SDmitry Karpeev     It should be safe to cancel the options monitors, since we don't expect to be setting options
105167234432SDmitry Karpeev     here (at least that are worth monitoring).  Monitors ought to be released so that they release
105267234432SDmitry Karpeev     whatever memory was allocated there before -malloc_dump reports unfreed memory.
105367234432SDmitry Karpeev   */
105467234432SDmitry Karpeev   ierr = PetscOptionsMonitorCancel();CHKERRQ(ierr);
105504102261SBarry Smith 
10562d53ad75SBarry Smith #if defined(PETSC_SERIALIZE_FUNCTIONS)
10572d53ad75SBarry Smith   ierr = PetscFPTDestroy();CHKERRQ(ierr);
10582d53ad75SBarry Smith #endif
10592d53ad75SBarry Smith 
10602d53ad75SBarry Smith 
1061e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS)
1062dff31646SBarry Smith   flg = PETSC_FALSE;
1063c5929fdfSBarry Smith   ierr = PetscOptionsGetBool(NULL,NULL,"-saw_options",&flg,NULL);CHKERRQ(ierr);
1064d5649816SBarry Smith   if (flg) {
1065e04113cfSBarry Smith     ierr = PetscOptionsSAWsDestroy();CHKERRQ(ierr);
1066d5649816SBarry Smith   }
1067d5649816SBarry Smith #endif
1068d5649816SBarry Smith 
1069681455b2SBarry Smith #if defined(PETSC_HAVE_X)
1070681455b2SBarry Smith   flg1 = PETSC_FALSE;
1071c5929fdfSBarry Smith   ierr = PetscOptionsGetBool(NULL,NULL,"-x_virtual",&flg1,NULL);CHKERRQ(ierr);
1072681455b2SBarry Smith   if (flg1) {
1073681455b2SBarry Smith     /*  this is a crude hack, but better than nothing */
1074681455b2SBarry Smith     ierr = PetscPOpen(PETSC_COMM_WORLD,NULL,"pkill -9 Xvfb","r",NULL);CHKERRQ(ierr);
1075681455b2SBarry Smith   }
1076681455b2SBarry Smith #endif
1077681455b2SBarry Smith 
107867584ceeSBarry Smith #if !defined(PETSC_HAVE_THREADSAFETY)
1079c5929fdfSBarry Smith   ierr = PetscOptionsGetBool(NULL,NULL,"-malloc_info",&flg2,NULL);CHKERRQ(ierr);
1080e5c89e4eSSatish Balay   if (!flg2) {
108190d69ab7SBarry Smith     flg2 = PETSC_FALSE;
1082c5929fdfSBarry Smith     ierr = PetscOptionsGetBool(NULL,NULL,"-memory_view",&flg2,NULL);CHKERRQ(ierr);
1083e5c89e4eSSatish Balay   }
1084e5c89e4eSSatish Balay   if (flg2) {
10850841954dSBarry Smith     ierr = PetscMemoryView(PETSC_VIEWER_STDOUT_WORLD,"Summary of Memory Usage in PETSc\n");CHKERRQ(ierr);
1086e5c89e4eSSatish Balay   }
108767584ceeSBarry Smith #endif
1088e5c89e4eSSatish Balay 
1089e5c89e4eSSatish Balay #if defined(PETSC_USE_LOG)
109090d69ab7SBarry Smith   flg1 = PETSC_FALSE;
1091c5929fdfSBarry Smith   ierr = PetscOptionsGetBool(NULL,NULL,"-get_total_flops",&flg1,NULL);CHKERRQ(ierr);
1092e5c89e4eSSatish Balay   if (flg1) {
1093e5c89e4eSSatish Balay     PetscLogDouble flops = 0;
1094205a32c2SJed Brown     ierr = MPI_Reduce(&petsc_TotalFlops,&flops,1,MPI_DOUBLE,MPI_SUM,0,PETSC_COMM_WORLD);CHKERRQ(ierr);
1095e5c89e4eSSatish Balay     ierr = PetscPrintf(PETSC_COMM_WORLD,"Total flops over all processors %g\n",flops);CHKERRQ(ierr);
1096e5c89e4eSSatish Balay   }
1097e5c89e4eSSatish Balay #endif
1098e5c89e4eSSatish Balay 
1099e5c89e4eSSatish Balay 
1100e5c89e4eSSatish Balay #if defined(PETSC_USE_LOG)
1101e5c89e4eSSatish Balay #if defined(PETSC_HAVE_MPE)
1102e5c89e4eSSatish Balay   mname[0] = 0;
1103a297a907SKarl Rupp 
1104c5929fdfSBarry Smith   ierr = PetscOptionsGetString(NULL,NULL,"-log_mpe",mname,PETSC_MAX_PATH_LEN,&flg1);CHKERRQ(ierr);
1105e5c89e4eSSatish Balay   if (flg1) {
1106e5c89e4eSSatish Balay     if (mname[0]) {ierr = PetscLogMPEDump(mname);CHKERRQ(ierr);}
1107e5c89e4eSSatish Balay     else          {ierr = PetscLogMPEDump(0);CHKERRQ(ierr);}
1108e5c89e4eSSatish Balay   }
1109e5c89e4eSSatish Balay #endif
1110e5c89e4eSSatish Balay   mname[0] = 0;
1111a297a907SKarl Rupp 
1112f14045dbSBarry Smith   ierr = PetscLogViewFromOptions();CHKERRQ(ierr);
1113c5929fdfSBarry Smith   ierr = PetscOptionsGetString(NULL,NULL,"-log_summary",mname,PETSC_MAX_PATH_LEN,&flg1);CHKERRQ(ierr);
1114e5c89e4eSSatish Balay   if (flg1) {
111591eabc43SBarry Smith     PetscViewer viewer;
111620a8bfc3SBarry Smith     ierr = (*PetscHelpPrintf)(PETSC_COMM_WORLD,"\n\n WARNING:   -log_summary is being deprecated; switch to -log_view\n\n\n");CHKERRQ(ierr);
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;
11239a9a5d4cSBarry Smith       ierr   = PetscViewerPushFormat(viewer,PETSC_VIEWER_DEFAULT);CHKERRQ(ierr);
112433f85c2fSBarry Smith       ierr   = PetscLogView(viewer);CHKERRQ(ierr);
11259a9a5d4cSBarry Smith       ierr   = PetscViewerPopFormat(viewer);CHKERRQ(ierr);
112633f85c2fSBarry Smith     }
1127e5c89e4eSSatish Balay   }
1128e5c89e4eSSatish Balay   mname[0] = 0;
1129a297a907SKarl Rupp 
1130c5929fdfSBarry Smith   ierr = PetscOptionsGetString(NULL,NULL,"-log_all",mname,PETSC_MAX_PATH_LEN,&flg1);CHKERRQ(ierr);
1131c5929fdfSBarry Smith   ierr = PetscOptionsGetString(NULL,NULL,"-log",mname,PETSC_MAX_PATH_LEN,&flg2);CHKERRQ(ierr);
1132e5c89e4eSSatish Balay   if (flg1 || flg2) {
1133e5c89e4eSSatish Balay     if (mname[0]) PetscLogDump(mname);
1134e5c89e4eSSatish Balay     else          PetscLogDump(0);
1135e5c89e4eSSatish Balay   }
1136e5c89e4eSSatish Balay #endif
113710463e74SBarry Smith 
1138b58ca069SBarry Smith   /*
1139b58ca069SBarry Smith      Free all objects registered with PetscObjectRegisterDestroy() such as PETSC_VIEWER_XXX_().
1140b58ca069SBarry Smith   */
1141b58ca069SBarry Smith   ierr = PetscObjectRegisterDestroyAll();CHKERRQ(ierr);
1142b58ca069SBarry Smith 
114333f85c2fSBarry Smith   ierr = PetscStackDestroy();CHKERRQ(ierr);
114410463e74SBarry Smith 
114590d69ab7SBarry Smith   flg1 = PETSC_FALSE;
1146c5929fdfSBarry Smith   ierr = PetscOptionsGetBool(NULL,NULL,"-no_signal_handler",&flg1,NULL);CHKERRQ(ierr);
1147e5c89e4eSSatish Balay   if (!flg1) { ierr = PetscPopSignalHandler();CHKERRQ(ierr);}
114890d69ab7SBarry Smith   flg1 = PETSC_FALSE;
1149c5929fdfSBarry Smith   ierr = PetscOptionsGetBool(NULL,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 */
1156c5929fdfSBarry Smith   ierr = PetscOptionsHasName(NULL,NULL,"-malloc_dump",&flg1);CHKERRQ(ierr);
1157c5929fdfSBarry Smith   ierr = PetscOptionsHasName(NULL,NULL,"-objects_dump",&flg1);CHKERRQ(ierr);
1158c5929fdfSBarry Smith   ierr = PetscOptionsGetBool(NULL,NULL,"-options_view",&flg2,NULL);CHKERRQ(ierr);
1159e4c476e2SSatish Balay 
1160e5c89e4eSSatish Balay   if (flg2) {
1161be56827dSJed Brown     PetscViewer viewer;
116202ba9f54SBarry Smith     ierr = PetscViewerCreate(PETSC_COMM_WORLD,&viewer);CHKERRQ(ierr);
116302ba9f54SBarry Smith     ierr = PetscViewerSetType(viewer,PETSCVIEWERASCII);CHKERRQ(ierr);
1164c5929fdfSBarry Smith     ierr = PetscOptionsView(NULL,viewer);CHKERRQ(ierr);
1165be56827dSJed Brown     ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr);
1166e5c89e4eSSatish Balay   }
1167e5c89e4eSSatish Balay 
1168e5c89e4eSSatish Balay   /* to prevent PETSc -options_left from warning */
1169c5929fdfSBarry Smith   ierr = PetscOptionsHasName(NULL,NULL,"-nox",&flg1);CHKERRQ(ierr);
1170c5929fdfSBarry Smith   ierr = PetscOptionsHasName(NULL,NULL,"-nox_warning",&flg1);CHKERRQ(ierr);
1171e5c89e4eSSatish Balay 
117233fc4174SSatish Balay   flg3 = PETSC_FALSE; /* default value is required */
1173c5929fdfSBarry Smith   ierr = PetscOptionsGetBool(NULL,NULL,"-options_left",&flg3,&flg1);CHKERRQ(ierr);
1174c5929fdfSBarry Smith   ierr = PetscOptionsAllUsed(NULL,&nopt);CHKERRQ(ierr);
1175e5c89e4eSSatish Balay   if (flg3) {
1176e5c89e4eSSatish Balay     if (!flg2) { /* have not yet printed the options */
1177be56827dSJed Brown       PetscViewer viewer;
117802ba9f54SBarry Smith       ierr = PetscViewerCreate(PETSC_COMM_WORLD,&viewer);CHKERRQ(ierr);
117902ba9f54SBarry Smith       ierr = PetscViewerSetType(viewer,PETSCVIEWERASCII);CHKERRQ(ierr);
1180c5929fdfSBarry Smith       ierr = PetscOptionsView(NULL,viewer);CHKERRQ(ierr);
1181be56827dSJed Brown       ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr);
1182e5c89e4eSSatish Balay     }
1183e5c89e4eSSatish Balay     if (!nopt) {
1184e5c89e4eSSatish Balay       ierr = PetscPrintf(PETSC_COMM_WORLD,"There are no unused options.\n");CHKERRQ(ierr);
1185e5c89e4eSSatish Balay     } else if (nopt == 1) {
1186e5c89e4eSSatish Balay       ierr = PetscPrintf(PETSC_COMM_WORLD,"There is one unused database option. It is:\n");CHKERRQ(ierr);
1187e5c89e4eSSatish Balay     } else {
11887582186dSLisandro Dalcin       ierr = PetscPrintf(PETSC_COMM_WORLD,"There are %D unused database options. They are:\n",nopt);CHKERRQ(ierr);
1189e5c89e4eSSatish Balay     }
1190df12ba86SBarry Smith   }
1191e5c89e4eSSatish Balay #if defined(PETSC_USE_DEBUG)
1192da8b8a77SBarry Smith   if (nopt && !flg3 && !flg1) {
1193e5c89e4eSSatish Balay     ierr = PetscPrintf(PETSC_COMM_WORLD,"WARNING! There are options you set that were not used!\n");CHKERRQ(ierr);
1194e5c89e4eSSatish Balay     ierr = PetscPrintf(PETSC_COMM_WORLD,"WARNING! could be spelling mistake, etc!\n");CHKERRQ(ierr);
1195c5929fdfSBarry Smith     ierr = PetscOptionsLeft(NULL);CHKERRQ(ierr);
1196e5c89e4eSSatish Balay   } else if (nopt && flg3) {
1197e5c89e4eSSatish Balay #else
1198e5c89e4eSSatish Balay   if (nopt && flg3) {
1199e5c89e4eSSatish Balay #endif
1200c5929fdfSBarry Smith     ierr = PetscOptionsLeft(NULL);CHKERRQ(ierr);
1201e5c89e4eSSatish Balay   }
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 
12104097062eSBarry Smith #if defined(PETSC_USE_LOG)
121110463e74SBarry Smith   /*
1212dbc8283eSBarry Smith        List all objects the user may have forgot to free
12132eff7a51SBarry Smith   */
121405df10baSBarry Smith   if (PetscObjectsLog) {
1215c5929fdfSBarry Smith     ierr = PetscOptionsHasName(NULL,NULL,"-objects_dump",&flg1);CHKERRQ(ierr);
1216a64a8e02SBarry Smith     if (flg1) {
1217a64a8e02SBarry Smith       MPI_Comm local_comm;
12187eb1d149SBarry Smith       char     string[64];
1219a64a8e02SBarry Smith 
1220c5929fdfSBarry Smith       ierr = PetscOptionsGetString(NULL,NULL,"-objects_dump",string,64,NULL);CHKERRQ(ierr);
1221a64a8e02SBarry Smith       ierr = MPI_Comm_dup(MPI_COMM_WORLD,&local_comm);CHKERRQ(ierr);
1222a64a8e02SBarry Smith       ierr = PetscSequentialPhaseBegin_Private(local_comm,1);CHKERRQ(ierr);
12237eb1d149SBarry Smith       ierr = PetscObjectsDump(stdout,(string[0] == 'a') ? PETSC_TRUE : PETSC_FALSE);CHKERRQ(ierr);
1224a64a8e02SBarry Smith       ierr = PetscSequentialPhaseEnd_Private(local_comm,1);CHKERRQ(ierr);
1225a64a8e02SBarry Smith       ierr = MPI_Comm_free(&local_comm);CHKERRQ(ierr);
12260a1571b3SBarry Smith     }
122705df10baSBarry Smith   }
12284097062eSBarry Smith #endif
12294097062eSBarry Smith 
12304097062eSBarry Smith #if defined(PETSC_USE_LOG)
1231dbc8283eSBarry Smith   PetscObjectsCounts    = 0;
1232dbc8283eSBarry Smith   PetscObjectsMaxCounts = 0;
1233a297a907SKarl Rupp   ierr = PetscFree(PetscObjects);CHKERRQ(ierr);
12344097062eSBarry Smith #endif
12352eff7a51SBarry Smith 
123633f85c2fSBarry Smith   /*
123722b6d1caSBarry Smith      Close any open dynamic libraries
123822b6d1caSBarry Smith   */
123922b6d1caSBarry Smith   ierr = PetscFinalize_DynamicLibraries();CHKERRQ(ierr);
124022b6d1caSBarry Smith 
124122b6d1caSBarry Smith   /*
124233f85c2fSBarry Smith      Destroy any packages that registered a finalize
124333f85c2fSBarry Smith   */
124433f85c2fSBarry Smith   ierr = PetscRegisterFinalizeAll();CHKERRQ(ierr);
124533f85c2fSBarry Smith 
1246101409b8SToby Isaac #if defined(PETSC_USE_LOG)
1247101409b8SToby Isaac   ierr = PetscLogDestroy();CHKERRQ(ierr);
1248101409b8SToby Isaac #endif
1249101409b8SToby Isaac 
125033f85c2fSBarry Smith   /*
125148dd1dffSBarry Smith      Print PetscFunctionLists that have not been properly freed
125248dd1dffSBarry Smith 
125337e93019SBarry Smith   ierr = PetscFunctionListPrintAll();CHKERRQ(ierr);
125448dd1dffSBarry Smith   */
125537e93019SBarry Smith 
12564028d114SSatish Balay   if (petsc_history) {
1257f3dea69dSBarry Smith     ierr = PetscCloseHistoryFile(&petsc_history);CHKERRQ(ierr);
1258e5c89e4eSSatish Balay     petsc_history = 0;
1259e5c89e4eSSatish Balay   }
1260e5c89e4eSSatish Balay 
12610298fd71SBarry Smith   ierr = PetscInfoAllow(PETSC_FALSE,NULL);CHKERRQ(ierr);
1262e5c89e4eSSatish Balay 
126367584ceeSBarry Smith #if !defined(PETSC_HAVE_THREADSAFETY)
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 
1271c5929fdfSBarry Smith     ierr = PetscOptionsGetString(NULL,NULL,"-malloc_dump",fname,250,&flg1);CHKERRQ(ierr);
1272dc92acbaSJed Brown     flg2 = PETSC_FALSE;
1273c5929fdfSBarry Smith     ierr = PetscOptionsGetBool(NULL,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 
1304c5929fdfSBarry Smith     ierr = PetscOptionsGetString(NULL,NULL,"-malloc_log",fname,250,&flg1);CHKERRQ(ierr);
1305c5929fdfSBarry Smith     ierr = PetscOptionsHasName(NULL,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   }
132267584ceeSBarry Smith #endif
132320e2c332SMatthew G. Knepley 
132420e2c332SMatthew G. Knepley #if defined(PETSC_HAVE_CUDA)
132520e2c332SMatthew G. Knepley   flg  = PETSC_TRUE;
1326c5929fdfSBarry Smith   ierr = PetscOptionsGetBool(NULL,NULL,"-cublas",&flg,NULL);CHKERRQ(ierr);
132720e2c332SMatthew G. Knepley   if (flg) {
132820e2c332SMatthew G. Knepley     PetscInt p;
132920e2c332SMatthew G. Knepley     for (p = 0; p < PetscGlobalSize; ++p) {
1330*82f73ecaSAlejandro Lamas Daviña       if (p == PetscGlobalRank) {
1331*82f73ecaSAlejandro Lamas Daviña         if (cublasv2handle) {
1332*82f73ecaSAlejandro Lamas Daviña           cberr = cublasDestroy(cublasv2handle);CHKERRCUBLAS(cberr);
1333*82f73ecaSAlejandro Lamas Daviña         }
1334*82f73ecaSAlejandro Lamas Daviña       }
133520e2c332SMatthew G. Knepley       ierr = MPI_Barrier(PETSC_COMM_WORLD);CHKERRQ(ierr);
133620e2c332SMatthew G. Knepley     }
133720e2c332SMatthew G. Knepley   }
133820e2c332SMatthew G. Knepley #endif
133920e2c332SMatthew G. Knepley 
1340e5c89e4eSSatish Balay   /* Can be destroyed only after all the options are used */
13414416b707SBarry Smith   ierr = PetscOptionsDestroyDefault();CHKERRQ(ierr);
1342e5c89e4eSSatish Balay 
1343e5c89e4eSSatish Balay   PetscGlobalArgc = 0;
1344e5c89e4eSSatish Balay   PetscGlobalArgs = 0;
1345e5c89e4eSSatish Balay 
1346ce63c4c1SBarry Smith #if defined(PETSC_USE_REAL___FLOAT128)
1347c90a1750SBarry Smith   ierr = MPI_Type_free(&MPIU___FLOAT128);CHKERRQ(ierr);
13487c2de775SJed Brown #if defined(PETSC_HAVE_COMPLEX)
13498c764dc5SJose Roman   ierr = MPI_Type_free(&MPIU___COMPLEX128);CHKERRQ(ierr);
13508c764dc5SJose Roman #endif
1351d9822059SBarry Smith   ierr = MPI_Op_free(&MPIU_MAX);CHKERRQ(ierr);
1352d9822059SBarry Smith   ierr = MPI_Op_free(&MPIU_MIN);CHKERRQ(ierr);
1353c90a1750SBarry Smith #endif
1354c90a1750SBarry Smith 
13557c2de775SJed Brown #if defined(PETSC_HAVE_COMPLEX)
13562c876bd9SBarry Smith #if !defined(PETSC_HAVE_MPI_C_DOUBLE_COMPLEX)
1357500d8756SSatish Balay   ierr = MPI_Type_free(&MPIU_C_DOUBLE_COMPLEX);CHKERRQ(ierr);
1358500d8756SSatish Balay   ierr = MPI_Type_free(&MPIU_C_COMPLEX);CHKERRQ(ierr);
13592c876bd9SBarry Smith #endif
1360e5c89e4eSSatish Balay #endif
1361cca4cb22SSatish Balay 
13627c2de775SJed Brown #if (defined(PETSC_HAVE_COMPLEX) && !defined(PETSC_HAVE_MPI_C_DOUBLE_COMPLEX)) || defined(PETSC_USE_REAL___FLOAT128)
1363cca4cb22SSatish Balay   ierr = MPI_Op_free(&MPIU_SUM);CHKERRQ(ierr);
1364cca4cb22SSatish Balay #endif
1365cca4cb22SSatish Balay 
1366e5c89e4eSSatish Balay   ierr = MPI_Type_free(&MPIU_2SCALAR);CHKERRQ(ierr);
136744041f26SJed Brown #if defined(PETSC_USE_64BIT_INDICES) || !defined(MPI_2INT)
1368e5c89e4eSSatish Balay   ierr = MPI_Type_free(&MPIU_2INT);CHKERRQ(ierr);
136944041f26SJed Brown #endif
1370e5c89e4eSSatish Balay   ierr = MPI_Op_free(&PetscMaxSum_Op);CHKERRQ(ierr);
1371e5c89e4eSSatish Balay 
1372dbc8283eSBarry Smith   /*
1373efb80d3cSBarry Smith      Destroy any known inner MPI_Comm's and attributes pointing to them
1374efb80d3cSBarry Smith      Note this will not destroy any new communicators the user has created.
1375efb80d3cSBarry Smith 
1376efb80d3cSBarry Smith      If all PETSc objects were not destroyed those left over objects will have hanging references to
1377efb80d3cSBarry Smith      the MPI_Comms that were freed; but that is ok because those PETSc objects will never be used again
1378dbc8283eSBarry Smith  */
1379b770b1f6SSatish Balay   {
1380dbc8283eSBarry Smith     PetscCommCounter *counter;
1381dbc8283eSBarry Smith     PetscMPIInt      flg;
1382dbc8283eSBarry Smith     MPI_Comm         icomm;
1383265f3f35SJed Brown     union {MPI_Comm comm; void *ptr;} ucomm;
1384265f3f35SJed Brown     ierr = MPI_Attr_get(PETSC_COMM_SELF,Petsc_InnerComm_keyval,&ucomm,&flg);CHKERRQ(ierr);
1385dbc8283eSBarry Smith     if (flg) {
1386265f3f35SJed Brown       icomm = ucomm.comm;
1387dbc8283eSBarry Smith       ierr = MPI_Attr_get(icomm,Petsc_Counter_keyval,&counter,&flg);CHKERRQ(ierr);
1388dbc8283eSBarry 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");
1389dbc8283eSBarry Smith 
1390dbc8283eSBarry Smith       ierr = MPI_Attr_delete(PETSC_COMM_SELF,Petsc_InnerComm_keyval);CHKERRQ(ierr);
1391efb80d3cSBarry Smith       ierr = MPI_Attr_delete(icomm,Petsc_Counter_keyval);CHKERRQ(ierr);
1392efb80d3cSBarry Smith       ierr = MPI_Comm_free(&icomm);CHKERRQ(ierr);
1393dbc8283eSBarry Smith     }
1394265f3f35SJed Brown     ierr = MPI_Attr_get(PETSC_COMM_WORLD,Petsc_InnerComm_keyval,&ucomm,&flg);CHKERRQ(ierr);
1395dbc8283eSBarry Smith     if (flg) {
1396265f3f35SJed Brown       icomm = ucomm.comm;
1397dbc8283eSBarry Smith       ierr = MPI_Attr_get(icomm,Petsc_Counter_keyval,&counter,&flg);CHKERRQ(ierr);
1398dbc8283eSBarry 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");
1399dbc8283eSBarry Smith 
1400dbc8283eSBarry Smith       ierr = MPI_Attr_delete(PETSC_COMM_WORLD,Petsc_InnerComm_keyval);CHKERRQ(ierr);
1401efb80d3cSBarry Smith       ierr = MPI_Attr_delete(icomm,Petsc_Counter_keyval);CHKERRQ(ierr);
1402efb80d3cSBarry Smith       ierr = MPI_Comm_free(&icomm);CHKERRQ(ierr);
1403dbc8283eSBarry Smith     }
1404b770b1f6SSatish Balay   }
1405dbc8283eSBarry Smith 
1406480cf27aSJed Brown   ierr = MPI_Keyval_free(&Petsc_Counter_keyval);CHKERRQ(ierr);
1407480cf27aSJed Brown   ierr = MPI_Keyval_free(&Petsc_InnerComm_keyval);CHKERRQ(ierr);
1408480cf27aSJed Brown   ierr = MPI_Keyval_free(&Petsc_OuterComm_keyval);CHKERRQ(ierr);
1409480cf27aSJed Brown 
14105ad9ad5bSBarry Smith   ierr = PetscSpinlockDestroy(&PetscViewerASCIISpinLockOpen);CHKERRQ(ierr);
14115ad9ad5bSBarry Smith   ierr = PetscSpinlockDestroy(&PetscViewerASCIISpinLockStdout);CHKERRQ(ierr);
14125ad9ad5bSBarry Smith   ierr = PetscSpinlockDestroy(&PetscViewerASCIISpinLockStderr);CHKERRQ(ierr);
1413ef19f930SBarry Smith   ierr = PetscSpinlockDestroy(&PetscCommSpinLock);CHKERRQ(ierr);
1414ef19f930SBarry Smith 
1415e5c89e4eSSatish Balay   if (PetscBeganMPI) {
141699608316SBarry Smith #if defined(PETSC_HAVE_MPI_FINALIZED)
141799b1327fSBarry Smith     PetscMPIInt flag;
141899b1327fSBarry Smith     ierr = MPI_Finalized(&flag);CHKERRQ(ierr);
1419e32f2f54SBarry Smith     if (flag) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_LIB,"MPI_Finalize() has already been called, even though MPI_Init() was called by PetscInitialize()");
142099608316SBarry Smith #endif
1421e5c89e4eSSatish Balay     ierr = MPI_Finalize();CHKERRQ(ierr);
1422e5c89e4eSSatish Balay   }
1423e5c89e4eSSatish Balay /*
1424e5c89e4eSSatish Balay 
1425e5c89e4eSSatish Balay      Note: In certain cases PETSC_COMM_WORLD is never MPI_Comm_free()ed because
1426e5c89e4eSSatish Balay    the communicator has some outstanding requests on it. Specifically if the
1427e5c89e4eSSatish Balay    flag PETSC_HAVE_BROKEN_REQUEST_FREE is set (for IBM MPI implementation). See
1428e5c89e4eSSatish Balay    src/vec/utils/vpscat.c. Due to this the memory allocated in PetscCommDuplicate()
1429e5c89e4eSSatish Balay    is never freed as it should be. Thus one may obtain messages of the form
14300e5e90baSSatish Balay    [ 1] 8 bytes PetscCommDuplicate() line 645 in src/sys/mpiu.c indicating the
1431e5c89e4eSSatish Balay    memory was not freed.
1432e5c89e4eSSatish Balay 
1433e5c89e4eSSatish Balay */
14341d1a0024SBarry Smith   ierr = PetscMallocClear();CHKERRQ(ierr);
1435a297a907SKarl Rupp 
1436e5c89e4eSSatish Balay   PetscInitializeCalled = PETSC_FALSE;
1437e5c89e4eSSatish Balay   PetscFinalizeCalled   = PETSC_TRUE;
1438e5c89e4eSSatish Balay   PetscFunctionReturn(ierr);
1439e5c89e4eSSatish Balay }
1440e5c89e4eSSatish Balay 
144143db4dbbSBarry Smith #if defined(PETSC_MISSING_LAPACK_lsame_)
14428cc058d9SJed Brown PETSC_EXTERN int lsame_(char *a,char *b)
144343db4dbbSBarry Smith {
144443db4dbbSBarry Smith   if (*a == *b) return 1;
144543db4dbbSBarry Smith   if (*a + 32 == *b) return 1;
144643db4dbbSBarry Smith   if (*a - 32 == *b) return 1;
144743db4dbbSBarry Smith   return 0;
144843db4dbbSBarry Smith }
1449a70650f6SBarry Smith #endif
145043db4dbbSBarry Smith 
145143db4dbbSBarry Smith #if defined(PETSC_MISSING_LAPACK_lsame)
14528cc058d9SJed Brown PETSC_EXTERN int lsame(char *a,char *b)
145343db4dbbSBarry Smith {
145443db4dbbSBarry Smith   if (*a == *b) return 1;
145543db4dbbSBarry Smith   if (*a + 32 == *b) return 1;
145643db4dbbSBarry Smith   if (*a - 32 == *b) return 1;
145743db4dbbSBarry Smith   return 0;
145843db4dbbSBarry Smith }
145943db4dbbSBarry Smith #endif
1460