xref: /petsc/src/sys/objects/pinit.c (revision 3db9a53df0e435f36d3a20d43c9562cb307a0223)
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 
1782f73ecaSAlejandro Lamas Daviña #if defined(PETSC_HAVE_CUDA)
1882f73ecaSAlejandro Lamas Daviña cublasHandle_t cublasv2handle = NULL;
1982f73ecaSAlejandro Lamas Daviña #endif
2082f73ecaSAlejandro 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 
55b22622e2STadeu Manoel #if defined(PETSC_HAVE_THREADSAFETY)
56b22622e2STadeu Manoel PetscSpinlock PetscViewerASCIISpinLockOpen;
57b22622e2STadeu Manoel PetscSpinlock PetscViewerASCIISpinLockStdout;
58b22622e2STadeu Manoel PetscSpinlock PetscViewerASCIISpinLockStderr;
59b22622e2STadeu Manoel PetscSpinlock PetscCommSpinLock;
60b22622e2STadeu Manoel #endif
61b22622e2STadeu Manoel 
62e5c89e4eSSatish Balay /*
63e5c89e4eSSatish Balay        Checks the options database for initializations related to the
64e5c89e4eSSatish Balay     PETSc components
65e5c89e4eSSatish Balay */
66e5c89e4eSSatish Balay #undef __FUNCT__
67e5c89e4eSSatish Balay #define __FUNCT__ "PetscOptionsCheckInitial_Components"
687087cfbeSBarry Smith PetscErrorCode  PetscOptionsCheckInitial_Components(void)
69e5c89e4eSSatish Balay {
70ace3abfcSBarry Smith   PetscBool      flg1;
71e5c89e4eSSatish Balay   PetscErrorCode ierr;
72e5c89e4eSSatish Balay 
73e5c89e4eSSatish Balay   PetscFunctionBegin;
74c5929fdfSBarry Smith   ierr = PetscOptionsHasName(NULL,NULL,"-help",&flg1);CHKERRQ(ierr);
75e5c89e4eSSatish Balay   if (flg1) {
76e5c89e4eSSatish Balay #if defined(PETSC_USE_LOG)
77e8e7597cSSatish Balay     MPI_Comm comm = PETSC_COMM_WORLD;
78e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm,"------Additional PETSc component options--------\n");CHKERRQ(ierr);
799a9a5d4cSBarry Smith     ierr = (*PetscHelpPrintf)(comm," -log_exclude: <vec,mat,pc.ksp,snes>\n");CHKERRQ(ierr);
806cf91177SBarry Smith     ierr = (*PetscHelpPrintf)(comm," -info_exclude: <null,vec,mat,pc,ksp,snes,ts>\n");CHKERRQ(ierr);
81e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm,"-----------------------------------------------\n");CHKERRQ(ierr);
82e5c89e4eSSatish Balay #endif
83e5c89e4eSSatish Balay   }
84e5c89e4eSSatish Balay   PetscFunctionReturn(0);
85e5c89e4eSSatish Balay }
86e5c89e4eSSatish Balay 
87e5c89e4eSSatish Balay #undef __FUNCT__
88945d1669SBarry Smith #define __FUNCT__ "PetscInitializeNoPointers"
890f11a792SBarry Smith /*
90945d1669SBarry Smith       PetscInitializeNoPointers - Calls PetscInitialize() from C/C++ without the pointers to argc and args
9172a42c3cSBarry Smith 
9272a42c3cSBarry Smith    Collective
9372a42c3cSBarry Smith 
9472a42c3cSBarry Smith    Level: advanced
9572a42c3cSBarry Smith 
96945d1669SBarry Smith     Notes: this is called only by the PETSc MATLAB and Julia interface. Even though it might start MPI it sets the flag to
970f11a792SBarry Smith      indicate that it did NOT start MPI so that the PetscFinalize() does not end MPI, thus allowing PetscInitialize() to
98945d1669SBarry Smith      be called multiple times from MATLAB and Julia without the problem of trying to initialize MPI more than once.
990f11a792SBarry Smith 
1001ea5a559SBarry Smith      Turns off PETSc signal handling because that can interact with MATLAB's signal handling causing random crashes.
1011ea5a559SBarry Smith 
10272a42c3cSBarry Smith .seealso: PetscInitialize(), PetscInitializeFortran(), PetscInitializeNoArguments()
1030f11a792SBarry Smith */
104945d1669SBarry Smith PetscErrorCode  PetscInitializeNoPointers(int argc,char **args,const char *filename,const char *help)
10572a42c3cSBarry Smith {
10672a42c3cSBarry Smith   PetscErrorCode ierr;
10772a42c3cSBarry Smith   int            myargc   = argc;
10872a42c3cSBarry Smith   char           **myargs = args;
10972a42c3cSBarry Smith 
11072a42c3cSBarry Smith   PetscFunctionBegin;
1113bf036e2SBarry Smith   ierr = PetscInitialize(&myargc,&myargs,filename,help);CHKERRQ(ierr);
1121ea5a559SBarry Smith   ierr = PetscPopSignalHandler();CHKERRQ(ierr);
113df413903SBarry Smith   PetscBeganMPI = PETSC_FALSE;
11472a42c3cSBarry Smith   PetscFunctionReturn(ierr);
11572a42c3cSBarry Smith }
11672a42c3cSBarry Smith 
11772a42c3cSBarry Smith #undef __FUNCT__
118945d1669SBarry Smith #define __FUNCT__ "PetscGetPETSC_COMM_SELF"
119f0865b08SBarry Smith /*
120945d1669SBarry Smith       Used by MATLAB and Julia interface to get communicator
121f0865b08SBarry Smith */
122945d1669SBarry Smith PetscErrorCode  PetscGetPETSC_COMM_SELF(MPI_Comm *comm)
123f0865b08SBarry Smith {
124f0865b08SBarry Smith   PetscFunctionBegin;
125f0865b08SBarry Smith   *comm = PETSC_COMM_SELF;
126f0865b08SBarry Smith   PetscFunctionReturn(0);
127f0865b08SBarry Smith }
128f0865b08SBarry Smith 
129f0865b08SBarry Smith #undef __FUNCT__
130e5c89e4eSSatish Balay #define __FUNCT__ "PetscInitializeNoArguments"
131e5c89e4eSSatish Balay /*@C
132e5c89e4eSSatish Balay       PetscInitializeNoArguments - Calls PetscInitialize() from C/C++ without
133e5c89e4eSSatish Balay         the command line arguments.
134e5c89e4eSSatish Balay 
135e5c89e4eSSatish Balay    Collective
136e5c89e4eSSatish Balay 
137e5c89e4eSSatish Balay    Level: advanced
138e5c89e4eSSatish Balay 
139e5c89e4eSSatish Balay .seealso: PetscInitialize(), PetscInitializeFortran()
140e5c89e4eSSatish Balay @*/
1417087cfbeSBarry Smith PetscErrorCode  PetscInitializeNoArguments(void)
142e5c89e4eSSatish Balay {
143e5c89e4eSSatish Balay   PetscErrorCode ierr;
144e5c89e4eSSatish Balay   int            argc   = 0;
145e5c89e4eSSatish Balay   char           **args = 0;
146e5c89e4eSSatish Balay 
147e5c89e4eSSatish Balay   PetscFunctionBegin;
1480298fd71SBarry Smith   ierr = PetscInitialize(&argc,&args,NULL,NULL);
149e5c89e4eSSatish Balay   PetscFunctionReturn(ierr);
150e5c89e4eSSatish Balay }
151e5c89e4eSSatish Balay 
152e5c89e4eSSatish Balay #undef __FUNCT__
153e5c89e4eSSatish Balay #define __FUNCT__ "PetscInitialized"
154e5c89e4eSSatish Balay /*@
155e5c89e4eSSatish Balay       PetscInitialized - Determine whether PETSc is initialized.
156e5c89e4eSSatish Balay 
15793b6d2d1SJed Brown    Level: beginner
158e5c89e4eSSatish Balay 
159e5c89e4eSSatish Balay .seealso: PetscInitialize(), PetscInitializeNoArguments(), PetscInitializeFortran()
160e5c89e4eSSatish Balay @*/
1617087cfbeSBarry Smith PetscErrorCode PetscInitialized(PetscBool  *isInitialized)
162e5c89e4eSSatish Balay {
163e5c89e4eSSatish Balay   *isInitialized = PetscInitializeCalled;
16493b6d2d1SJed Brown   return 0;
165e5c89e4eSSatish Balay }
166e5c89e4eSSatish Balay 
167e5c89e4eSSatish Balay #undef __FUNCT__
168e5c89e4eSSatish Balay #define __FUNCT__ "PetscFinalized"
169e5c89e4eSSatish Balay /*@
170e5c89e4eSSatish Balay       PetscFinalized - Determine whether PetscFinalize() has been called yet
171e5c89e4eSSatish Balay 
172e5c89e4eSSatish Balay    Level: developer
173e5c89e4eSSatish Balay 
174e5c89e4eSSatish Balay .seealso: PetscInitialize(), PetscInitializeNoArguments(), PetscInitializeFortran()
175e5c89e4eSSatish Balay @*/
1767087cfbeSBarry Smith PetscErrorCode  PetscFinalized(PetscBool  *isFinalized)
177e5c89e4eSSatish Balay {
178e5c89e4eSSatish Balay   *isFinalized = PetscFinalizeCalled;
17993b6d2d1SJed Brown   return 0;
180e5c89e4eSSatish Balay }
181e5c89e4eSSatish Balay 
18209573ac7SBarry Smith extern PetscErrorCode PetscOptionsCheckInitial_Private(void);
183e5c89e4eSSatish Balay 
184e5c89e4eSSatish Balay /*
185e5c89e4eSSatish Balay        This function is the MPI reduction operation used to compute the sum of the
186e5c89e4eSSatish Balay    first half of the datatype and the max of the second half.
187e5c89e4eSSatish Balay */
188367daffbSBarry Smith MPI_Op MPIU_MAXSUM_OP = 0;
189e5c89e4eSSatish Balay 
190e5c89e4eSSatish Balay #undef __FUNCT__
191367daffbSBarry Smith #define __FUNCT__ "MPIU_MaxSum_Local"
192367daffbSBarry Smith PETSC_INTERN void MPIAPI MPIU_MaxSum_Local(void *in,void *out,int *cnt,MPI_Datatype *datatype)
193e5c89e4eSSatish Balay {
194e5c89e4eSSatish Balay   PetscInt *xin = (PetscInt*)in,*xout = (PetscInt*)out,i,count = *cnt;
195e5c89e4eSSatish Balay 
196e5c89e4eSSatish Balay   PetscFunctionBegin;
197e5c89e4eSSatish Balay   if (*datatype != MPIU_2INT) {
198e5c89e4eSSatish Balay     (*PetscErrorPrintf)("Can only handle MPIU_2INT data types");
199e5c89e4eSSatish Balay     MPI_Abort(MPI_COMM_WORLD,1);
200e5c89e4eSSatish Balay   }
201e5c89e4eSSatish Balay 
202e5c89e4eSSatish Balay   for (i=0; i<count; i++) {
203e5c89e4eSSatish Balay     xout[2*i]    = PetscMax(xout[2*i],xin[2*i]);
204e5c89e4eSSatish Balay     xout[2*i+1] += xin[2*i+1];
205e5c89e4eSSatish Balay   }
206812af9f3SBarry Smith   PetscFunctionReturnVoid();
207e5c89e4eSSatish Balay }
208e5c89e4eSSatish Balay 
209e5c89e4eSSatish Balay /*
210e5c89e4eSSatish Balay     Returns the max of the first entry owned by this processor and the
211e5c89e4eSSatish Balay sum of the second entry.
212b693b147SBarry Smith 
21376f543a4SJed Brown     The reason sizes[2*i] contains lengths sizes[2*i+1] contains flag of 1 if length is nonzero
214367daffbSBarry Smith is so that the MPIU_MAXSUM_OP() can set TWO values, if we passed in only sizes[i] with lengths
215b693b147SBarry Smith there would be no place to store the both needed results.
216e5c89e4eSSatish Balay */
217e5c89e4eSSatish Balay #undef __FUNCT__
218e5c89e4eSSatish Balay #define __FUNCT__ "PetscMaxSum"
21976ec1555SBarry Smith PetscErrorCode  PetscMaxSum(MPI_Comm comm,const PetscInt sizes[],PetscInt *max,PetscInt *sum)
220e5c89e4eSSatish Balay {
221e5c89e4eSSatish Balay   PetscErrorCode ierr;
222e5c89e4eSSatish Balay 
223e5c89e4eSSatish Balay   PetscFunctionBegin;
224d6e4c47cSJed Brown #if defined(PETSC_HAVE_MPI_REDUCE_SCATTER_BLOCK)
225d6e4c47cSJed Brown   {
226d6e4c47cSJed Brown     struct {PetscInt max,sum;} work;
227367daffbSBarry Smith     ierr = MPI_Reduce_scatter_block((void*)sizes,&work,1,MPIU_2INT,MPIU_MAXSUM_OP,comm);CHKERRQ(ierr);
228d6e4c47cSJed Brown     *max = work.max;
229d6e4c47cSJed Brown     *sum = work.sum;
230d6e4c47cSJed Brown   }
231d6e4c47cSJed Brown #else
232d6e4c47cSJed Brown   {
233d6e4c47cSJed Brown     PetscMPIInt    size,rank;
234d6e4c47cSJed Brown     struct {PetscInt max,sum;} *work;
235e5c89e4eSSatish Balay     ierr = MPI_Comm_size(comm,&size);CHKERRQ(ierr);
236e5c89e4eSSatish Balay     ierr = MPI_Comm_rank(comm,&rank);CHKERRQ(ierr);
237785e854fSJed Brown     ierr = PetscMalloc1(size,&work);CHKERRQ(ierr);
238367daffbSBarry Smith     ierr = MPIU_Allreduce((void*)sizes,work,size,MPIU_2INT,MPIU_MAXSUM_OP,comm);CHKERRQ(ierr);
2396ac3741eSJed Brown     *max = work[rank].max;
2406ac3741eSJed Brown     *sum = work[rank].sum;
241e5c89e4eSSatish Balay     ierr = PetscFree(work);CHKERRQ(ierr);
242d6e4c47cSJed Brown   }
243d6e4c47cSJed Brown #endif
244e5c89e4eSSatish Balay   PetscFunctionReturn(0);
245e5c89e4eSSatish Balay }
246e5c89e4eSSatish Balay 
247e5c89e4eSSatish Balay /* ----------------------------------------------------------------------------*/
248e5c89e4eSSatish Balay 
2497c2de775SJed Brown #if (defined(PETSC_HAVE_COMPLEX) && !defined(PETSC_HAVE_MPI_C_DOUBLE_COMPLEX)) || defined(PETSC_USE_REAL___FLOAT128)
25006a205a8SBarry Smith MPI_Op MPIU_SUM = 0;
251e5c89e4eSSatish Balay 
252e5c89e4eSSatish Balay #undef __FUNCT__
253e5c89e4eSSatish Balay #define __FUNCT__ "PetscSum_Local"
2548cc058d9SJed Brown PETSC_EXTERN void PetscSum_Local(void *in,void *out,PetscMPIInt *cnt,MPI_Datatype *datatype)
255e5c89e4eSSatish Balay {
256e5c89e4eSSatish Balay   PetscInt i,count = *cnt;
257e5c89e4eSSatish Balay 
258e5c89e4eSSatish Balay   PetscFunctionBegin;
2597c2de775SJed Brown   if (*datatype == MPIU_REAL) {
260e2e03761SBarry Smith     PetscReal *xin = (PetscReal*)in,*xout = (PetscReal*)out;
261a297a907SKarl Rupp     for (i=0; i<count; i++) xout[i] += xin[i];
2627c2de775SJed Brown   }
2637c2de775SJed Brown #if defined(PETSC_HAVE_COMPLEX)
2647c2de775SJed Brown   else if (*datatype == MPIU_COMPLEX) {
2657c2de775SJed Brown     PetscComplex *xin = (PetscComplex*)in,*xout = (PetscComplex*)out;
266a297a907SKarl Rupp     for (i=0; i<count; i++) xout[i] += xin[i];
2677c2de775SJed Brown   }
2687c2de775SJed Brown #endif
2697c2de775SJed Brown   else {
2707c2de775SJed Brown     (*PetscErrorPrintf)("Can only handle MPIU_REAL or MPIU_COMPLEX data types");
271e2e03761SBarry Smith     MPI_Abort(MPI_COMM_WORLD,1);
272e2e03761SBarry Smith   }
273812af9f3SBarry Smith   PetscFunctionReturnVoid();
274e5c89e4eSSatish Balay }
275e5c89e4eSSatish Balay #endif
276e5c89e4eSSatish Balay 
277ce63c4c1SBarry Smith #if defined(PETSC_USE_REAL___FLOAT128)
278d9822059SBarry Smith MPI_Op MPIU_MAX = 0;
279d9822059SBarry Smith MPI_Op MPIU_MIN = 0;
280d9822059SBarry Smith 
281d9822059SBarry Smith #undef __FUNCT__
282d9822059SBarry Smith #define __FUNCT__ "PetscMax_Local"
2838cc058d9SJed Brown PETSC_EXTERN void PetscMax_Local(void *in,void *out,PetscMPIInt *cnt,MPI_Datatype *datatype)
284d9822059SBarry Smith {
285d9822059SBarry Smith   PetscInt i,count = *cnt;
286d9822059SBarry Smith 
287d9822059SBarry Smith   PetscFunctionBegin;
2887c2de775SJed Brown   if (*datatype == MPIU_REAL) {
2898c764dc5SJose Roman     PetscReal *xin = (PetscReal*)in,*xout = (PetscReal*)out;
290a297a907SKarl Rupp     for (i=0; i<count; i++) xout[i] = PetscMax(xout[i],xin[i]);
2917c2de775SJed Brown   }
2927c2de775SJed Brown #if defined(PETSC_HAVE_COMPLEX)
2937c2de775SJed Brown   else if (*datatype == MPIU_COMPLEX) {
2947c2de775SJed Brown     PetscComplex *xin = (PetscComplex*)in,*xout = (PetscComplex*)out;
2957c2de775SJed Brown     for (i=0; i<count; i++) {
2967c2de775SJed Brown       xout[i] = PetscRealPartComplex(xout[i])<PetscRealPartComplex(xin[i]) ? xin[i] : xout[i];
2977c2de775SJed Brown     }
2987c2de775SJed Brown   }
2997c2de775SJed Brown #endif
3007c2de775SJed Brown   else {
3017c2de775SJed Brown     (*PetscErrorPrintf)("Can only handle MPIU_REAL or MPIU_COMPLEX data types");
3028c764dc5SJose Roman     MPI_Abort(MPI_COMM_WORLD,1);
3038c764dc5SJose Roman   }
304d9822059SBarry Smith   PetscFunctionReturnVoid();
305d9822059SBarry Smith }
306d9822059SBarry Smith 
307d9822059SBarry Smith #undef __FUNCT__
308d9822059SBarry Smith #define __FUNCT__ "PetscMin_Local"
3098cc058d9SJed Brown PETSC_EXTERN void PetscMin_Local(void *in,void *out,PetscMPIInt *cnt,MPI_Datatype *datatype)
310d9822059SBarry Smith {
311d9822059SBarry Smith   PetscInt    i,count = *cnt;
312d9822059SBarry Smith 
313d9822059SBarry Smith   PetscFunctionBegin;
3147c2de775SJed Brown   if (*datatype == MPIU_REAL) {
3158c764dc5SJose Roman     PetscReal *xin = (PetscReal*)in,*xout = (PetscReal*)out;
316a297a907SKarl Rupp     for (i=0; i<count; i++) xout[i] = PetscMin(xout[i],xin[i]);
3177c2de775SJed Brown   }
3187c2de775SJed Brown #if defined(PETSC_HAVE_COMPLEX)
3197c2de775SJed Brown   else if (*datatype == MPIU_COMPLEX) {
3207c2de775SJed Brown     PetscComplex *xin = (PetscComplex*)in,*xout = (PetscComplex*)out;
3217c2de775SJed Brown     for (i=0; i<count; i++) {
3227c2de775SJed Brown       xout[i] = PetscRealPartComplex(xout[i])>PetscRealPartComplex(xin[i]) ? xin[i] : xout[i];
3237c2de775SJed Brown     }
3247c2de775SJed Brown   }
3257c2de775SJed Brown #endif
3267c2de775SJed Brown   else {
3278c764dc5SJose Roman     (*PetscErrorPrintf)("Can only handle MPIU_REAL or MPIU_SCALAR data (i.e. double or complex) types");
3288c764dc5SJose Roman     MPI_Abort(MPI_COMM_WORLD,1);
3298c764dc5SJose Roman   }
330d9822059SBarry Smith   PetscFunctionReturnVoid();
331d9822059SBarry Smith }
332d9822059SBarry Smith #endif
333d9822059SBarry Smith 
334480cf27aSJed Brown #undef __FUNCT__
335480cf27aSJed Brown #define __FUNCT__ "Petsc_DelCounter"
336480cf27aSJed Brown /*
337480cf27aSJed Brown    Private routine to delete internal tag/name counter storage when a communicator is freed.
338480cf27aSJed Brown 
339ff0e51ddSBarry 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.
340480cf27aSJed Brown 
341480cf27aSJed Brown    Note: this is declared extern "C" because it is passed to MPI_Keyval_create()
342480cf27aSJed Brown 
343480cf27aSJed Brown */
3448cc058d9SJed Brown PETSC_EXTERN PetscMPIInt MPIAPI Petsc_DelCounter(MPI_Comm comm,PetscMPIInt keyval,void *count_val,void *extra_state)
345480cf27aSJed Brown {
346480cf27aSJed Brown   PetscErrorCode ierr;
347480cf27aSJed Brown 
348480cf27aSJed Brown   PetscFunctionBegin;
349480cf27aSJed Brown   ierr = PetscInfo1(0,"Deleting counter data in an MPI_Comm %ld\n",(long)comm);if (ierr) PetscFunctionReturn((PetscMPIInt)ierr);
350480cf27aSJed Brown   ierr = PetscFree(count_val);if (ierr) PetscFunctionReturn((PetscMPIInt)ierr);
351480cf27aSJed Brown   PetscFunctionReturn(MPI_SUCCESS);
352480cf27aSJed Brown }
353480cf27aSJed Brown 
354480cf27aSJed Brown #undef __FUNCT__
355da3039f7SJed Brown #define __FUNCT__ "Petsc_DelComm_Outer"
356480cf27aSJed Brown /*
357da3039f7SJed Brown   This is invoked on the outer comm as a result of either PetscCommDestroy() (via MPI_Attr_delete) or when the user
358da3039f7SJed Brown   calls MPI_Comm_free().
359da3039f7SJed Brown 
360da3039f7SJed Brown   This is the only entry point for breaking the links between inner and outer comms.
361480cf27aSJed Brown 
362ff0e51ddSBarry Smith   This is called by MPI, not by users. This is called when MPI_Comm_free() is called on the communicator.
363480cf27aSJed Brown 
364480cf27aSJed Brown   Note: this is declared extern "C" because it is passed to MPI_Keyval_create()
365480cf27aSJed Brown 
366480cf27aSJed Brown */
367da3039f7SJed Brown PETSC_EXTERN PetscMPIInt MPIAPI Petsc_DelComm_Outer(MPI_Comm comm,PetscMPIInt keyval,void *attr_val,void *extra_state)
368480cf27aSJed Brown {
369480cf27aSJed Brown   PetscErrorCode ierr;
370b89831e5SBarry Smith   PetscMPIInt    flg;
371265f3f35SJed Brown   union {MPI_Comm comm; void *ptr;} icomm,ocomm;
372480cf27aSJed Brown 
373480cf27aSJed Brown   PetscFunctionBegin;
374da3039f7SJed Brown   if (keyval != Petsc_InnerComm_keyval) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_CORRUPT,"Unexpected keyval");
375ec4fadc2SJed Brown   icomm.ptr = attr_val;
376da3039f7SJed Brown 
377265f3f35SJed Brown   ierr = MPI_Attr_get(icomm.comm,Petsc_OuterComm_keyval,&ocomm,&flg);CHKERRQ(ierr);
378b3ef52cdSBarry Smith   if (!flg) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_CORRUPT,"Inner MPI_Comm does not have expected reference to outer comm");
379da3039f7SJed Brown   if (ocomm.comm != comm) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_CORRUPT,"Inner MPI_Comm has reference to non-matching outer comm");
380da3039f7SJed Brown   ierr = MPI_Attr_delete(icomm.comm,Petsc_OuterComm_keyval);CHKERRQ(ierr); /* Calls Petsc_DelComm_Inner */
381da3039f7SJed 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);
382da3039f7SJed Brown   PetscFunctionReturn(MPI_SUCCESS);
383b89831e5SBarry Smith }
384da3039f7SJed Brown 
385da3039f7SJed Brown #undef __FUNCT__
386da3039f7SJed Brown #define __FUNCT__ "Petsc_DelComm_Inner"
387da3039f7SJed Brown /*
388da3039f7SJed Brown  * This is invoked on the inner comm when Petsc_DelComm_Outer calls MPI_Attr_delete.  It should not be reached any other way.
389da3039f7SJed Brown  */
390da3039f7SJed Brown PETSC_EXTERN PetscMPIInt MPIAPI Petsc_DelComm_Inner(MPI_Comm comm,PetscMPIInt keyval,void *attr_val,void *extra_state)
391da3039f7SJed Brown {
392da3039f7SJed Brown   PetscErrorCode ierr;
393da3039f7SJed Brown 
394da3039f7SJed Brown   PetscFunctionBegin;
395da3039f7SJed Brown   ierr = PetscInfo1(0,"Removing reference to PETSc communicator embedded in a user MPI_Comm %ld\n",(long)comm);if (ierr) PetscFunctionReturn((PetscMPIInt)ierr);
396480cf27aSJed Brown   PetscFunctionReturn(MPI_SUCCESS);
397480cf27aSJed Brown }
398480cf27aSJed Brown 
399951e3c8eSBarry Smith #if defined(PETSC_USE_PETSC_MPI_EXTERNAL32)
400e39fd77fSBarry Smith #if !defined(PETSC_WORDS_BIGENDIAN)
4018cc058d9SJed Brown PETSC_EXTERN PetscMPIInt PetscDataRep_extent_fn(MPI_Datatype,MPI_Aint*,void*);
4028cc058d9SJed Brown PETSC_EXTERN PetscMPIInt PetscDataRep_read_conv_fn(void*, MPI_Datatype,PetscMPIInt,void*,MPI_Offset,void*);
4038cc058d9SJed Brown PETSC_EXTERN PetscMPIInt PetscDataRep_write_conv_fn(void*, MPI_Datatype,PetscMPIInt,void*,MPI_Offset,void*);
404e39fd77fSBarry Smith #endif
405951e3c8eSBarry Smith #endif
406e39fd77fSBarry Smith 
4076ae9a8a6SBarry Smith int  PetscGlobalArgc   = 0;
4086ae9a8a6SBarry Smith char **PetscGlobalArgs = 0;
409dff31646SBarry Smith PetscSegBuffer PetscCitationsList;
410e5c89e4eSSatish Balay 
411e5c89e4eSSatish Balay #undef __FUNCT__
412051e4cf2SJed Brown #define __FUNCT__ "PetscCitationsInitialize"
413051e4cf2SJed Brown PetscErrorCode PetscCitationsInitialize()
414051e4cf2SJed Brown {
415051e4cf2SJed Brown   PetscErrorCode ierr;
416051e4cf2SJed Brown 
417051e4cf2SJed Brown   PetscFunctionBegin;
418051e4cf2SJed Brown   ierr = PetscSegBufferCreate(1,10000,&PetscCitationsList);CHKERRQ(ierr);
419ae618e69SSatish 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 and Hong Zhang},\n  Title = {{PETS}c Users Manual},\n  Number = {ANL-95/11 - Revision 3.7},\n  Institution = {Argonne National Laboratory},\n  Year = {2016}\n}\n",NULL);CHKERRQ(ierr);
420051e4cf2SJed 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);
421051e4cf2SJed Brown   PetscFunctionReturn(0);
422051e4cf2SJed Brown }
423e5c89e4eSSatish Balay 
424e5c89e4eSSatish Balay #undef __FUNCT__
425e5c89e4eSSatish Balay #define __FUNCT__ "PetscGetArgs"
426e5c89e4eSSatish Balay /*@C
427e5c89e4eSSatish Balay    PetscGetArgs - Allows you to access the raw command line arguments anywhere
428e5c89e4eSSatish Balay      after PetscInitialize() is called but before PetscFinalize().
429e5c89e4eSSatish Balay 
430e5c89e4eSSatish Balay    Not Collective
431e5c89e4eSSatish Balay 
432e5c89e4eSSatish Balay    Output Parameters:
433e5c89e4eSSatish Balay +  argc - count of number of command line arguments
434e5c89e4eSSatish Balay -  args - the command line arguments
435e5c89e4eSSatish Balay 
436e5c89e4eSSatish Balay    Level: intermediate
437e5c89e4eSSatish Balay 
438e5c89e4eSSatish Balay    Notes:
439e5c89e4eSSatish Balay       This is usually used to pass the command line arguments into other libraries
440e5c89e4eSSatish Balay    that are called internally deep in PETSc or the application.
441e5c89e4eSSatish Balay 
442f177e3b1SBarry Smith       The first argument contains the program name as is normal for C arguments.
443f177e3b1SBarry Smith 
444e5c89e4eSSatish Balay    Concepts: command line arguments
445e5c89e4eSSatish Balay 
446793721a6SBarry Smith .seealso: PetscFinalize(), PetscInitializeFortran(), PetscGetArguments()
447e5c89e4eSSatish Balay 
448e5c89e4eSSatish Balay @*/
4497087cfbeSBarry Smith PetscErrorCode  PetscGetArgs(int *argc,char ***args)
450e5c89e4eSSatish Balay {
451e5c89e4eSSatish Balay   PetscFunctionBegin;
45217186662SBarry Smith   if (!PetscInitializeCalled && PetscFinalizeCalled) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ORDER,"You must call after PetscInitialize() but before PetscFinalize()");
453e5c89e4eSSatish Balay   *argc = PetscGlobalArgc;
454e5c89e4eSSatish Balay   *args = PetscGlobalArgs;
455e5c89e4eSSatish Balay   PetscFunctionReturn(0);
456e5c89e4eSSatish Balay }
457e5c89e4eSSatish Balay 
458e5c89e4eSSatish Balay #undef __FUNCT__
459793721a6SBarry Smith #define __FUNCT__ "PetscGetArguments"
460793721a6SBarry Smith /*@C
461793721a6SBarry Smith    PetscGetArguments - Allows you to access the  command line arguments anywhere
462793721a6SBarry Smith      after PetscInitialize() is called but before PetscFinalize().
463793721a6SBarry Smith 
464793721a6SBarry Smith    Not Collective
465793721a6SBarry Smith 
466793721a6SBarry Smith    Output Parameters:
467793721a6SBarry Smith .  args - the command line arguments
468793721a6SBarry Smith 
469793721a6SBarry Smith    Level: intermediate
470793721a6SBarry Smith 
471793721a6SBarry Smith    Notes:
472793721a6SBarry Smith       This does NOT start with the program name and IS null terminated (final arg is void)
473793721a6SBarry Smith 
474793721a6SBarry Smith    Concepts: command line arguments
475793721a6SBarry Smith 
476793721a6SBarry Smith .seealso: PetscFinalize(), PetscInitializeFortran(), PetscGetArgs(), PetscFreeArguments()
477793721a6SBarry Smith 
478793721a6SBarry Smith @*/
4797087cfbeSBarry Smith PetscErrorCode  PetscGetArguments(char ***args)
480793721a6SBarry Smith {
481793721a6SBarry Smith   PetscInt       i,argc = PetscGlobalArgc;
482793721a6SBarry Smith   PetscErrorCode ierr;
483793721a6SBarry Smith 
484793721a6SBarry Smith   PetscFunctionBegin;
48517186662SBarry Smith   if (!PetscInitializeCalled && PetscFinalizeCalled) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ORDER,"You must call after PetscInitialize() but before PetscFinalize()");
486717030eeSLisandro Dalcin   if (!argc) {*args = 0; PetscFunctionReturn(0);}
487785e854fSJed Brown   ierr = PetscMalloc1(argc,args);CHKERRQ(ierr);
488793721a6SBarry Smith   for (i=0; i<argc-1; i++) {
489793721a6SBarry Smith     ierr = PetscStrallocpy(PetscGlobalArgs[i+1],&(*args)[i]);CHKERRQ(ierr);
490793721a6SBarry Smith   }
491793721a6SBarry Smith   (*args)[argc-1] = 0;
492793721a6SBarry Smith   PetscFunctionReturn(0);
493793721a6SBarry Smith }
494793721a6SBarry Smith 
495793721a6SBarry Smith #undef __FUNCT__
496793721a6SBarry Smith #define __FUNCT__ "PetscFreeArguments"
497793721a6SBarry Smith /*@C
498793721a6SBarry Smith    PetscFreeArguments - Frees the memory obtained with PetscGetArguments()
499793721a6SBarry Smith 
500793721a6SBarry Smith    Not Collective
501793721a6SBarry Smith 
502793721a6SBarry Smith    Output Parameters:
503793721a6SBarry Smith .  args - the command line arguments
504793721a6SBarry Smith 
505793721a6SBarry Smith    Level: intermediate
506793721a6SBarry Smith 
507793721a6SBarry Smith    Concepts: command line arguments
508793721a6SBarry Smith 
509793721a6SBarry Smith .seealso: PetscFinalize(), PetscInitializeFortran(), PetscGetArgs(), PetscGetArguments()
510793721a6SBarry Smith 
511793721a6SBarry Smith @*/
5127087cfbeSBarry Smith PetscErrorCode  PetscFreeArguments(char **args)
513793721a6SBarry Smith {
514793721a6SBarry Smith   PetscInt       i = 0;
515793721a6SBarry Smith   PetscErrorCode ierr;
516793721a6SBarry Smith 
517793721a6SBarry Smith   PetscFunctionBegin;
518a297a907SKarl Rupp   if (!args) PetscFunctionReturn(0);
519793721a6SBarry Smith   while (args[i]) {
520793721a6SBarry Smith     ierr = PetscFree(args[i]);CHKERRQ(ierr);
521793721a6SBarry Smith     i++;
522793721a6SBarry Smith   }
523793721a6SBarry Smith   ierr = PetscFree(args);CHKERRQ(ierr);
524793721a6SBarry Smith   PetscFunctionReturn(0);
525793721a6SBarry Smith }
526793721a6SBarry Smith 
52711525c0dSBarry Smith #if defined(PETSC_HAVE_SAWS)
52830befbd2SBarry Smith #include <petscconfiginfo.h>
52930befbd2SBarry Smith 
53011525c0dSBarry Smith #undef __FUNCT__
53111525c0dSBarry Smith #define __FUNCT__ "PetscInitializeSAWs"
53211525c0dSBarry Smith PetscErrorCode  PetscInitializeSAWs(const char help[])
53311525c0dSBarry Smith {
53411525c0dSBarry Smith   if (!PetscGlobalRank) {
53530befbd2SBarry Smith     char           cert[PETSC_MAX_PATH_LEN],root[PETSC_MAX_PATH_LEN],*intro,programname[64],*appline,*options,version[64];
53611525c0dSBarry Smith     int            port;
537ffbd1cfbSBarry Smith     PetscBool      flg,rootlocal = PETSC_FALSE,flg2,selectport = PETSC_FALSE;
53811525c0dSBarry Smith     size_t         applinelen,introlen;
53911525c0dSBarry Smith     PetscErrorCode ierr;
540ffbd1cfbSBarry Smith     char           sawsurl[256];
54111525c0dSBarry Smith 
542c5929fdfSBarry Smith     ierr = PetscOptionsHasName(NULL,NULL,"-saws_log",&flg);CHKERRQ(ierr);
54311525c0dSBarry Smith     if (flg) {
54411525c0dSBarry Smith       char  sawslog[PETSC_MAX_PATH_LEN];
54511525c0dSBarry Smith 
546c5929fdfSBarry Smith       ierr = PetscOptionsGetString(NULL,NULL,"-saws_log",sawslog,PETSC_MAX_PATH_LEN,NULL);CHKERRQ(ierr);
54711525c0dSBarry Smith       if (sawslog[0]) {
54811525c0dSBarry Smith         PetscStackCallSAWs(SAWs_Set_Use_Logfile,(sawslog));
54911525c0dSBarry Smith       } else {
55011525c0dSBarry Smith         PetscStackCallSAWs(SAWs_Set_Use_Logfile,(NULL));
55111525c0dSBarry Smith       }
55211525c0dSBarry Smith     }
553c5929fdfSBarry Smith     ierr = PetscOptionsGetString(NULL,NULL,"-saws_https",cert,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr);
55411525c0dSBarry Smith     if (flg) {
55511525c0dSBarry Smith       PetscStackCallSAWs(SAWs_Set_Use_HTTPS,(cert));
55611525c0dSBarry Smith     }
557c5929fdfSBarry Smith     ierr = PetscOptionsGetBool(NULL,NULL,"-saws_port_auto_select",&selectport,NULL);CHKERRQ(ierr);
558ffbd1cfbSBarry Smith     if (selectport) {
559ffbd1cfbSBarry Smith         PetscStackCallSAWs(SAWs_Get_Available_Port,(&port));
560ffbd1cfbSBarry Smith         PetscStackCallSAWs(SAWs_Set_Port,(port));
561ffbd1cfbSBarry Smith     } else {
562c5929fdfSBarry Smith       ierr = PetscOptionsGetInt(NULL,NULL,"-saws_port",&port,&flg);CHKERRQ(ierr);
56311525c0dSBarry Smith       if (flg) {
56411525c0dSBarry Smith         PetscStackCallSAWs(SAWs_Set_Port,(port));
56511525c0dSBarry Smith       }
566ffbd1cfbSBarry Smith     }
567c5929fdfSBarry Smith     ierr = PetscOptionsGetString(NULL,NULL,"-saws_root",root,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr);
56811525c0dSBarry Smith     if (flg) {
56911525c0dSBarry Smith       PetscStackCallSAWs(SAWs_Set_Document_Root,(root));CHKERRQ(ierr);
57011525c0dSBarry Smith       ierr = PetscStrcmp(root,".",&rootlocal);CHKERRQ(ierr);
5719c1e0ce8SBarry Smith     } else {
572c5929fdfSBarry Smith       ierr = PetscOptionsHasName(NULL,NULL,"-saws_options",&flg);CHKERRQ(ierr);
5739c1e0ce8SBarry Smith       if (flg) {
5743c01dfcfSBarry Smith         ierr = PetscStrreplace(PETSC_COMM_WORLD,"${PETSC_DIR}/share/petsc/saws",root,PETSC_MAX_PATH_LEN);CHKERRQ(ierr);
5759c1e0ce8SBarry Smith         PetscStackCallSAWs(SAWs_Set_Document_Root,(root));CHKERRQ(ierr);
5769c1e0ce8SBarry Smith       }
57711525c0dSBarry Smith     }
578c5929fdfSBarry Smith     ierr = PetscOptionsHasName(NULL,NULL,"-saws_local",&flg2);CHKERRQ(ierr);
57911525c0dSBarry Smith     if (flg2) {
58011525c0dSBarry Smith       char jsdir[PETSC_MAX_PATH_LEN];
58111525c0dSBarry Smith       if (!flg) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SUP,"-saws_local option requires -saws_root option");
58211525c0dSBarry Smith       ierr = PetscSNPrintf(jsdir,PETSC_MAX_PATH_LEN,"%s/js",root);CHKERRQ(ierr);
58311525c0dSBarry Smith       ierr = PetscTestDirectory(jsdir,'r',&flg);CHKERRQ(ierr);
58411525c0dSBarry Smith       if (!flg) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_FILE_READ,"-saws_local option requires js directory in root directory");
58543da4ab2SBarry Smith       PetscStackCallSAWs(SAWs_Push_Local_Header,());CHKERRQ(ierr);
58611525c0dSBarry Smith     }
58711525c0dSBarry Smith     ierr = PetscGetProgramName(programname,64);CHKERRQ(ierr);
58811525c0dSBarry Smith     ierr = PetscStrlen(help,&applinelen);CHKERRQ(ierr);
58911525c0dSBarry Smith     introlen   = 4096 + applinelen;
59030a8c9c0SSurtai Han     applinelen += 1024;
59111525c0dSBarry Smith     ierr = PetscMalloc(applinelen,&appline);CHKERRQ(ierr);
59211525c0dSBarry Smith     ierr = PetscMalloc(introlen,&intro);CHKERRQ(ierr);
59311525c0dSBarry Smith 
59411525c0dSBarry Smith     if (rootlocal) {
59511525c0dSBarry Smith       ierr = PetscSNPrintf(appline,applinelen,"%s.c.html",programname);CHKERRQ(ierr);
59611525c0dSBarry Smith       ierr = PetscTestFile(appline,'r',&rootlocal);CHKERRQ(ierr);
59711525c0dSBarry Smith     }
59876a34f28SBarry Smith     ierr = PetscOptionsGetAll(NULL,&options);CHKERRQ(ierr);
59911525c0dSBarry Smith     if (rootlocal && help) {
60030befbd2SBarry 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);
60111525c0dSBarry Smith     } else if (help) {
60230a8c9c0SSurtai Han       ierr = PetscSNPrintf(appline,applinelen,"<center>Running %s %s</center><br><center><pre>%s</pre></center><br>",programname,options,help);
60311525c0dSBarry Smith     } else {
60430befbd2SBarry Smith       ierr = PetscSNPrintf(appline,applinelen,"<center> Running %s %s</center><br>\n",programname,options);
60511525c0dSBarry Smith     }
606b0bb5815SBarry Smith     ierr = PetscFree(options);CHKERRQ(ierr);
60730befbd2SBarry Smith     ierr = PetscGetVersion(version,sizeof(version));CHKERRQ(ierr);
60811525c0dSBarry Smith     ierr = PetscSNPrintf(intro,introlen,"<body>\n"
60911525c0dSBarry 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"
610df62c222SBarry 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"
611df62c222SBarry Smith                                     "%s",version,petscconfigureoptions,appline);
61243da4ab2SBarry Smith     PetscStackCallSAWs(SAWs_Push_Body,("index.html",0,intro));
61311525c0dSBarry Smith     ierr = PetscFree(intro);CHKERRQ(ierr);
61411525c0dSBarry Smith     ierr = PetscFree(appline);CHKERRQ(ierr);
61511525c0dSBarry Smith     PetscStackCallSAWs(SAWs_Initialize,());
616ffbd1cfbSBarry Smith     if (selectport) {
617ffbd1cfbSBarry Smith       PetscStackCallSAWs(SAWs_Get_FullURL,(sizeof(sawsurl),sawsurl));
618ffbd1cfbSBarry Smith       ierr = PetscPrintf(PETSC_COMM_WORLD,"Point your browser to %s for SAWs\n",sawsurl);CHKERRQ(ierr);
619ffbd1cfbSBarry Smith     }
6200af79b04SBarry Smith     ierr = PetscCitationsRegister("@TechReport{ saws,\n"
6210af79b04SBarry Smith                                   "  Author = {Matt Otten and Jed Brown and Barry Smith},\n"
6220af79b04SBarry Smith                                   "  Title  = {Scientific Application Web Server (SAWs) Users Manual},\n"
6230af79b04SBarry Smith                                   "  Institution = {Argonne National Laboratory},\n"
6240af79b04SBarry Smith                                   "  Year   = 2013\n}\n",NULL);CHKERRQ(ierr);
62511525c0dSBarry Smith   }
62611525c0dSBarry Smith   PetscFunctionReturn(0);
62711525c0dSBarry Smith }
62811525c0dSBarry Smith #endif
62911525c0dSBarry Smith 
630793721a6SBarry Smith #undef __FUNCT__
631e5c89e4eSSatish Balay #define __FUNCT__ "PetscInitialize"
632e5c89e4eSSatish Balay /*@C
633e5c89e4eSSatish Balay    PetscInitialize - Initializes the PETSc database and MPI.
634e5c89e4eSSatish Balay    PetscInitialize() calls MPI_Init() if that has yet to be called,
635e5c89e4eSSatish Balay    so this routine should always be called near the beginning of
636e5c89e4eSSatish Balay    your program -- usually the very first line!
637e5c89e4eSSatish Balay 
638e5c89e4eSSatish Balay    Collective on MPI_COMM_WORLD or PETSC_COMM_WORLD if it has been set
639e5c89e4eSSatish Balay 
640e5c89e4eSSatish Balay    Input Parameters:
641e5c89e4eSSatish Balay +  argc - count of number of command line arguments
642e5c89e4eSSatish Balay .  args - the command line arguments
6430298fd71SBarry Smith .  file - [optional] PETSc database file, also checks ~username/.petscrc and .petscrc use NULL to not check for
644fc2bca9aSBarry Smith           code specific file. Use -skip_petscrc in the code specific file to skip the .petscrc files
6450298fd71SBarry Smith -  help - [optional] Help message to print, use NULL for no message
646e5c89e4eSSatish Balay 
64705827820SBarry Smith    If you wish PETSc code to run ONLY on a subcommunicator of MPI_COMM_WORLD, create that
64805827820SBarry Smith    communicator first and assign it to PETSC_COMM_WORLD BEFORE calling PetscInitialize(). Thus if you are running a
64905827820SBarry Smith    four process job and two processes will run PETSc and have PetscInitialize() and PetscFinalize() and two process will not,
65005827820SBarry Smith    then do this. If ALL processes in the job are using PetscInitialize() and PetscFinalize() then you don't need to do this, even
65105827820SBarry Smith    if different subcommunicators of the job are doing different things with PETSc.
652e5c89e4eSSatish Balay 
653e5c89e4eSSatish Balay    Options Database Keys:
654e5c89e4eSSatish Balay +  -start_in_debugger [noxterm,dbx,xdb,gdb,...] - Starts program in debugger
655e5c89e4eSSatish Balay .  -on_error_attach_debugger [noxterm,dbx,xdb,gdb,...] - Starts debugger when error detected
656e5c89e4eSSatish Balay .  -on_error_emacs <machinename> causes emacsclient to jump to error file
657b52f573bSBarry Smith .  -on_error_abort calls abort() when error detected (no traceback)
658e8fb0fc0SBarry Smith .  -on_error_mpiabort calls MPI_abort() when error detected
659e8fb0fc0SBarry Smith .  -error_output_stderr prints error messages to stderr instead of the default stdout
660e8fb0fc0SBarry Smith .  -error_output_none does not print the error messages (but handles errors in the same way as if this was not called)
661e5c89e4eSSatish Balay .  -debugger_nodes [node1,node2,...] - Indicates nodes to start in debugger
662e5c89e4eSSatish Balay .  -debugger_pause [sleeptime] (in seconds) - Pauses debugger
663e5c89e4eSSatish Balay .  -stop_for_debugger - Print message on how to attach debugger manually to
664e5c89e4eSSatish Balay                         process and wait (-debugger_pause) seconds for attachment
6652fb0ec9aSBarry Smith .  -malloc - Indicates use of PETSc error-checking malloc (on by default for debug version of libraries)
666e5c89e4eSSatish Balay .  -malloc no - Indicates not to use error-checking malloc
6672fb0ec9aSBarry Smith .  -malloc_debug - check for memory corruption at EVERY malloc or free
668aee23540SBarry Smith .  -malloc_dump - prints a list of all unfreed memory at the end of the run
669dc92acbaSJed Brown .  -malloc_test - like -malloc_dump -malloc_debug, but only active for debugging builds
670e5c89e4eSSatish Balay .  -fp_trap - Stops on floating point exceptions (Note that on the
671e5c89e4eSSatish Balay               IBM RS6000 this slows code by at least a factor of 10.)
672e5c89e4eSSatish Balay .  -no_signal_handler - Indicates not to trap error signals
673e5c89e4eSSatish Balay .  -shared_tmp - indicates /tmp directory is shared by all processors
674e5c89e4eSSatish Balay .  -not_shared_tmp - each processor has own /tmp
675e5c89e4eSSatish Balay .  -tmp - alternative name of /tmp directory
676e5c89e4eSSatish Balay .  -get_total_flops - returns total flops done by all processors
6770841954dSBarry Smith -  -memory_view - Print memory usage at end of run
678e5c89e4eSSatish Balay 
679e5c89e4eSSatish Balay    Options Database Keys for Profiling:
680a7f22e61SSatish Balay    See Users-Manual: ch_profiling for details.
681495fc317SBarry Smith +  -info <optional filename> - Prints verbose information to the screen
682495fc317SBarry Smith .  -info_exclude <null,vec,mat,pc,ksp,snes,ts> - Excludes some of the verbose messages
683495fc317SBarry Smith .  -log_sync - Log the synchronization in scatters, inner products and norms
684495fc317SBarry Smith .  -log_trace [filename] - Print traces of all PETSc calls to the screen (useful to determine where a program
685e5c89e4eSSatish Balay         hangs without running in the debugger).  See PetscLogTraceBegin().
6869a9a5d4cSBarry Smith .  -log_view [:filename:format] - Prints summary of flop and timing information to screen or file, see PetscLogView().
6879a9a5d4cSBarry Smith .  -log_summary [filename] - (Deprecated, use -log_view) Prints summary of flop and timing information to screen. If the filename is specified the
688495fc317SBarry Smith         summary is written to the file.  See PetscLogView().
6899a9a5d4cSBarry Smith .  -log_exclude: <vec,mat,pc.ksp,snes> - excludes subset of object classes from logging
690495fc317SBarry Smith .  -log_all [filename] - Logs extensive profiling information  See PetscLogDump().
691495fc317SBarry Smith .  -log [filename] - Logs basic profiline information  See PetscLogDump().
692495fc317SBarry Smith -  -log_mpe [filename] - Creates a logfile viewable by the utility Jumpshot (in MPICH distribution)
693495fc317SBarry Smith 
6949a9a5d4cSBarry Smith     Only one of -log_trace, -log_view, -log_summary, -log_all, -log, or -log_mpe may be used at a time
695e5c89e4eSSatish Balay 
696ffbd1cfbSBarry Smith    Options Database Keys for SAWs:
697ffbd1cfbSBarry Smith +  -saws_port <portnumber> - port number to publish SAWs data, default is 8080
698ffbd1cfbSBarry 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
699ffbd1cfbSBarry Smith                             this is useful when you are running many jobs that utilize SAWs at the same time
700ffbd1cfbSBarry Smith .  -saws_log <filename> - save a log of all SAWs communication
701ffbd1cfbSBarry Smith .  -saws_https <certificate file> - have SAWs use HTTPS instead of HTTP
702ffbd1cfbSBarry Smith -  -saws_root <directory> - allow SAWs to have access to the given directory to search for requested resources and files
703ffbd1cfbSBarry Smith 
704e5c89e4eSSatish Balay    Environmental Variables:
705e5c89e4eSSatish Balay +   PETSC_TMP - alternative tmp directory
706e5c89e4eSSatish Balay .   PETSC_SHARED_TMP - tmp is shared by all processes
707e5c89e4eSSatish Balay .   PETSC_NOT_SHARED_TMP - each process has its own private tmp
708e5c89e4eSSatish Balay .   PETSC_VIEWER_SOCKET_PORT - socket number to use for socket viewer
709e5c89e4eSSatish Balay -   PETSC_VIEWER_SOCKET_MACHINE - machine to use for socket viewer to connect to
710e5c89e4eSSatish Balay 
711e5c89e4eSSatish Balay 
712e5c89e4eSSatish Balay    Level: beginner
713e5c89e4eSSatish Balay 
714e5c89e4eSSatish Balay    Notes:
715e5c89e4eSSatish Balay    If for some reason you must call MPI_Init() separately, call
716e5c89e4eSSatish Balay    it before PetscInitialize().
717e5c89e4eSSatish Balay 
718e5c89e4eSSatish Balay    Fortran Version:
719e5c89e4eSSatish Balay    In Fortran this routine has the format
720e5c89e4eSSatish Balay $       call PetscInitialize(file,ierr)
721e5c89e4eSSatish Balay 
722e5c89e4eSSatish Balay +   ierr - error return code
7230eb4c9c0SBarry Smith -  file - [optional] PETSc database file, also checks ~username/.petscrc and .petscrc use PETSC_NULL_CHARACTER to not check for
724fc2bca9aSBarry Smith           code specific file. Use -skip_petscrc in the code specific file to skip the .petscrc files
725e5c89e4eSSatish Balay 
726e5c89e4eSSatish Balay    Important Fortran Note:
7270eb4c9c0SBarry Smith    In Fortran, you MUST use PETSC_NULL_CHARACTER to indicate a
7280298fd71SBarry Smith    null character string; you CANNOT just use NULL as
729a7f22e61SSatish Balay    in the C version. See Users-Manual: ch_fortran for details.
730e5c89e4eSSatish Balay 
73101cb0274SBarry Smith    If your main program is C but you call Fortran code that also uses PETSc you need to call PetscInitializeFortran() soon after
73201cb0274SBarry Smith    calling PetscInitialize().
733e5c89e4eSSatish Balay 
734e5c89e4eSSatish Balay    Concepts: initializing PETSc
735e5c89e4eSSatish Balay 
73601cb0274SBarry Smith .seealso: PetscFinalize(), PetscInitializeFortran(), PetscGetArgs(), PetscInitializeNoArguments()
737e5c89e4eSSatish Balay 
738e5c89e4eSSatish Balay @*/
7397087cfbeSBarry Smith PetscErrorCode  PetscInitialize(int *argc,char ***args,const char file[],const char help[])
740e5c89e4eSSatish Balay {
741e5c89e4eSSatish Balay   PetscErrorCode ierr;
7424bb5149bSJed Brown   PetscMPIInt    flag, size;
743ace3abfcSBarry Smith   PetscBool      flg;
744e5c89e4eSSatish Balay   char           hostname[256];
74582f73ecaSAlejandro Lamas Daviña #if defined(PETSC_HAVE_CUDA)
74682f73ecaSAlejandro Lamas Daviña   cublasStatus_t cberr;
74782f73ecaSAlejandro Lamas Daviña #endif
748e5c89e4eSSatish Balay 
749e5c89e4eSSatish Balay   PetscFunctionBegin;
750e5c89e4eSSatish Balay   if (PetscInitializeCalled) PetscFunctionReturn(0);
751e5c89e4eSSatish Balay 
752ae9b4142SLisandro Dalcin   /* these must be initialized in a routine, not as a constant declaration*/
753d89683f4Sbcordonn   PETSC_STDOUT = stdout;
754ae9b4142SLisandro Dalcin   PETSC_STDERR = stderr;
755e5c89e4eSSatish Balay 
7560c30907bSSatish Balay   /* on Windows - set printf to default to printing 2 digit exponents */
7570c30907bSSatish Balay #if defined(PETSC_HAVE__SET_OUTPUT_FORMAT)
7580c30907bSSatish Balay   _set_output_format(_TWO_DIGIT_EXPONENT);
7590c30907bSSatish Balay #endif
7600c30907bSSatish Balay 
7614416b707SBarry Smith   ierr = PetscOptionsCreateDefault();CHKERRQ(ierr);
762e5c89e4eSSatish Balay 
763e5c89e4eSSatish Balay   /*
764e5c89e4eSSatish Balay      We initialize the program name here (before MPI_Init()) because MPICH has a bug in
765e5c89e4eSSatish Balay      it that it sets args[0] on all processors to be args[0] on the first processor.
766e5c89e4eSSatish Balay   */
767e5c89e4eSSatish Balay   if (argc && *argc) {
768e5c89e4eSSatish Balay     ierr = PetscSetProgramName(**args);CHKERRQ(ierr);
769e5c89e4eSSatish Balay   } else {
770e5c89e4eSSatish Balay     ierr = PetscSetProgramName("Unknown Name");CHKERRQ(ierr);
771e5c89e4eSSatish Balay   }
772e5c89e4eSSatish Balay 
773e5c89e4eSSatish Balay   ierr = MPI_Initialized(&flag);CHKERRQ(ierr);
774e5c89e4eSSatish Balay   if (!flag) {
775e32f2f54SBarry Smith     if (PETSC_COMM_WORLD != MPI_COMM_NULL) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SUP,"You cannot set PETSC_COMM_WORLD if you have not initialized MPI first");
7765e765c61SJed Brown #if defined(PETSC_HAVE_MPI_INIT_THREAD)
7775e765c61SJed Brown     {
7785e765c61SJed Brown       PetscMPIInt provided;
7795e765c61SJed Brown       ierr = MPI_Init_thread(argc,args,MPI_THREAD_FUNNELED,&provided);CHKERRQ(ierr);
7805e765c61SJed Brown     }
7815e765c61SJed Brown #else
782e5c89e4eSSatish Balay     ierr = MPI_Init(argc,args);CHKERRQ(ierr);
7835e765c61SJed Brown #endif
784e5c89e4eSSatish Balay     PetscBeganMPI = PETSC_TRUE;
785e5c89e4eSSatish Balay   }
786e5c89e4eSSatish Balay   if (argc && args) {
787e5c89e4eSSatish Balay     PetscGlobalArgc = *argc;
788e5c89e4eSSatish Balay     PetscGlobalArgs = *args;
789e5c89e4eSSatish Balay   }
790e5c89e4eSSatish Balay   PetscFinalizeCalled = PETSC_FALSE;
7915ad9ad5bSBarry Smith   ierr = PetscSpinlockCreate(&PetscViewerASCIISpinLockOpen);CHKERRQ(ierr);
7925ad9ad5bSBarry Smith   ierr = PetscSpinlockCreate(&PetscViewerASCIISpinLockStdout);CHKERRQ(ierr);
7935ad9ad5bSBarry Smith   ierr = PetscSpinlockCreate(&PetscViewerASCIISpinLockStderr);CHKERRQ(ierr);
794ef19f930SBarry Smith   ierr = PetscSpinlockCreate(&PetscCommSpinLock);CHKERRQ(ierr);
795e5c89e4eSSatish Balay 
796a297a907SKarl Rupp   if (PETSC_COMM_WORLD == MPI_COMM_NULL) PETSC_COMM_WORLD = MPI_COMM_WORLD;
797d54338ecSKarl Rupp   ierr = MPI_Comm_set_errhandler(PETSC_COMM_WORLD,MPI_ERRORS_RETURN);CHKERRQ(ierr);
798e5c89e4eSSatish Balay 
799e5c89e4eSSatish Balay   /* Done after init due to a bug in MPICH-GM? */
800e5c89e4eSSatish Balay   ierr = PetscErrorPrintfInitialize();CHKERRQ(ierr);
801e5c89e4eSSatish Balay 
802e5c89e4eSSatish Balay   ierr = MPI_Comm_rank(MPI_COMM_WORLD,&PetscGlobalRank);CHKERRQ(ierr);
803e5c89e4eSSatish Balay   ierr = MPI_Comm_size(MPI_COMM_WORLD,&PetscGlobalSize);CHKERRQ(ierr);
804e5c89e4eSSatish Balay 
8058ad47952SJed Brown   MPIU_BOOL = MPI_INT;
8068ad47952SJed Brown   MPIU_ENUM = MPI_INT;
8078ad47952SJed Brown 
808e5c89e4eSSatish Balay   /*
809e5c89e4eSSatish Balay      Initialized the global complex variable; this is because with
810e5c89e4eSSatish Balay      shared libraries the constructors for global variables
811e5c89e4eSSatish Balay      are not called; at least on IRIX.
812e5c89e4eSSatish Balay   */
813886cfec0SSatish Balay #if defined(PETSC_HAVE_COMPLEX)
814e5c89e4eSSatish Balay   {
815a24ee22aSSatish Balay #if defined(PETSC_CLANGUAGE_CXX)
81650f81f78SJed Brown     PetscComplex ic(0.0,1.0);
817e5c89e4eSSatish Balay     PETSC_i = ic;
818a24ee22aSSatish Balay #elif defined(PETSC_CLANGUAGE_C)
81950f81f78SJed Brown     PETSC_i = _Complex_I;
820b7940d39SSatish Balay #endif
821762437b8SSatish Balay   }
822762437b8SSatish Balay 
8232c876bd9SBarry Smith #if !defined(PETSC_HAVE_MPI_C_DOUBLE_COMPLEX)
824e69cd0e6SSatish Balay   ierr = MPI_Type_contiguous(2,MPI_DOUBLE,&MPIU_C_DOUBLE_COMPLEX);CHKERRQ(ierr);
825500d8756SSatish Balay   ierr = MPI_Type_commit(&MPIU_C_DOUBLE_COMPLEX);CHKERRQ(ierr);
826500d8756SSatish Balay   ierr = MPI_Type_contiguous(2,MPI_FLOAT,&MPIU_C_COMPLEX);CHKERRQ(ierr);
827500d8756SSatish Balay   ierr = MPI_Type_commit(&MPIU_C_COMPLEX);CHKERRQ(ierr);
8282c876bd9SBarry Smith #endif
829886cfec0SSatish Balay #endif /* PETSC_HAVE_COMPLEX */
830e5c89e4eSSatish Balay 
831e5c89e4eSSatish Balay   /*
832e5c89e4eSSatish Balay      Create the PETSc MPI reduction operator that sums of the first
833e5c89e4eSSatish Balay      half of the entries and maxes the second half.
834e5c89e4eSSatish Balay   */
835367daffbSBarry Smith   ierr = MPI_Op_create(MPIU_MaxSum_Local,1,&MPIU_MAXSUM_OP);CHKERRQ(ierr);
836e5c89e4eSSatish Balay 
837ce63c4c1SBarry Smith #if defined(PETSC_USE_REAL___FLOAT128)
838c90a1750SBarry Smith   ierr = MPI_Type_contiguous(2,MPI_DOUBLE,&MPIU___FLOAT128);CHKERRQ(ierr);
839c90a1750SBarry Smith   ierr = MPI_Type_commit(&MPIU___FLOAT128);CHKERRQ(ierr);
8407c2de775SJed Brown #if defined(PETSC_HAVE_COMPLEX)
8418c764dc5SJose Roman   ierr = MPI_Type_contiguous(4,MPI_DOUBLE,&MPIU___COMPLEX128);CHKERRQ(ierr);
8428c764dc5SJose Roman   ierr = MPI_Type_commit(&MPIU___COMPLEX128);CHKERRQ(ierr);
8438c764dc5SJose Roman #endif
844d9822059SBarry Smith   ierr = MPI_Op_create(PetscMax_Local,1,&MPIU_MAX);CHKERRQ(ierr);
845d9822059SBarry Smith   ierr = MPI_Op_create(PetscMin_Local,1,&MPIU_MIN);CHKERRQ(ierr);
846c90a1750SBarry Smith #endif
847c90a1750SBarry Smith 
8487c2de775SJed Brown #if (defined(PETSC_HAVE_COMPLEX) && !defined(PETSC_HAVE_MPI_C_DOUBLE_COMPLEX)) || defined(PETSC_USE_REAL___FLOAT128)
849cca4cb22SSatish Balay   ierr = MPI_Op_create(PetscSum_Local,1,&MPIU_SUM);CHKERRQ(ierr);
850cca4cb22SSatish Balay #endif
851cca4cb22SSatish Balay 
852e5c89e4eSSatish Balay   ierr = MPI_Type_contiguous(2,MPIU_SCALAR,&MPIU_2SCALAR);CHKERRQ(ierr);
853e5c89e4eSSatish Balay   ierr = MPI_Type_commit(&MPIU_2SCALAR);CHKERRQ(ierr);
854e5c89e4eSSatish Balay 
85544041f26SJed Brown #if defined(PETSC_USE_64BIT_INDICES) || !defined(MPI_2INT)
856e5c89e4eSSatish Balay   ierr = MPI_Type_contiguous(2,MPIU_INT,&MPIU_2INT);CHKERRQ(ierr);
857e5c89e4eSSatish Balay   ierr = MPI_Type_commit(&MPIU_2INT);CHKERRQ(ierr);
85844041f26SJed Brown #endif
859e5c89e4eSSatish Balay 
860ec957eceSBarry Smith 
861e5c89e4eSSatish Balay   /*
862480cf27aSJed Brown      Attributes to be set on PETSc communicators
863480cf27aSJed Brown   */
864480cf27aSJed Brown   ierr = MPI_Keyval_create(MPI_NULL_COPY_FN,Petsc_DelCounter,&Petsc_Counter_keyval,(void*)0);CHKERRQ(ierr);
865da3039f7SJed Brown   ierr = MPI_Keyval_create(MPI_NULL_COPY_FN,Petsc_DelComm_Outer,&Petsc_InnerComm_keyval,(void*)0);CHKERRQ(ierr);
866da3039f7SJed Brown   ierr = MPI_Keyval_create(MPI_NULL_COPY_FN,Petsc_DelComm_Inner,&Petsc_OuterComm_keyval,(void*)0);CHKERRQ(ierr);
867480cf27aSJed Brown 
868480cf27aSJed Brown   /*
869e8fb0fc0SBarry Smith      Build the options database
870e5c89e4eSSatish Balay   */
871c5929fdfSBarry Smith   ierr = PetscOptionsInsert(NULL,argc,args,file);CHKERRQ(ierr);
872e5c89e4eSSatish Balay 
8736dc8fec2Sbcordonn 
874e5c89e4eSSatish Balay   /*
875e5c89e4eSSatish Balay      Print main application help message
876e5c89e4eSSatish Balay   */
877c5929fdfSBarry Smith   ierr = PetscOptionsHasName(NULL,NULL,"-help",&flg);CHKERRQ(ierr);
878e5c89e4eSSatish Balay   if (help && flg) {
879e5c89e4eSSatish Balay     ierr = PetscPrintf(PETSC_COMM_WORLD,help);CHKERRQ(ierr);
880e5c89e4eSSatish Balay   }
881e5c89e4eSSatish Balay   ierr = PetscOptionsCheckInitial_Private();CHKERRQ(ierr);
882e5c89e4eSSatish Balay 
883d45a07a7SBarry Smith   ierr = PetscCitationsInitialize();CHKERRQ(ierr);
884d45a07a7SBarry Smith 
885e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS)
88611525c0dSBarry Smith   ierr = PetscInitializeSAWs(help);CHKERRQ(ierr);
887f4202a44SBarry Smith #endif
888f4202a44SBarry Smith 
889896238b9SBarry Smith   /* Creates the logging data structures; this is enabled even if logging is not turned on */
890a9f03627SSatish Balay #if defined(PETSC_USE_LOG)
891896238b9SBarry Smith   ierr = PetscLogInitialize();CHKERRQ(ierr);
892a9f03627SSatish Balay #endif
893e5c89e4eSSatish Balay 
894e5c89e4eSSatish Balay   /*
895e5c89e4eSSatish Balay      Load the dynamic libraries (on machines that support them), this registers all
896e5c89e4eSSatish Balay      the solvers etc. (On non-dynamic machines this initializes the PetscDraw and PetscViewer classes)
897e5c89e4eSSatish Balay   */
898e5c89e4eSSatish Balay   ierr = PetscInitialize_DynamicLibraries();CHKERRQ(ierr);
899e5c89e4eSSatish Balay 
900e5c89e4eSSatish Balay   ierr = MPI_Comm_size(PETSC_COMM_WORLD,&size);CHKERRQ(ierr);
901ae15b995SBarry Smith   ierr = PetscInfo1(0,"PETSc successfully started: number of processors = %d\n",size);CHKERRQ(ierr);
902e5c89e4eSSatish Balay   ierr = PetscGetHostName(hostname,256);CHKERRQ(ierr);
903ae15b995SBarry Smith   ierr = PetscInfo1(0,"Running on machine: %s\n",hostname);CHKERRQ(ierr);
904e5c89e4eSSatish Balay 
905e5c89e4eSSatish Balay   ierr = PetscOptionsCheckInitial_Components();CHKERRQ(ierr);
906ef6c6fedSBoyana Norris   /* Check the options database for options related to the options database itself */
907c5929fdfSBarry Smith   ierr = PetscOptionsSetFromOptions(NULL);CHKERRQ(ierr);
908ef6c6fedSBoyana Norris 
909951e3c8eSBarry Smith #if defined(PETSC_USE_PETSC_MPI_EXTERNAL32)
910e39fd77fSBarry Smith   /*
911e39fd77fSBarry Smith       Tell MPI about our own data representation converter, this would/should be used if extern32 is not supported by the MPI
912e39fd77fSBarry Smith 
913e39fd77fSBarry Smith       Currently not used because it is not supported by MPICH.
914e39fd77fSBarry Smith   */
915e39fd77fSBarry Smith #if !defined(PETSC_WORDS_BIGENDIAN)
9160298fd71SBarry Smith   ierr = MPI_Register_datarep((char*)"petsc",PetscDataRep_read_conv_fn,PetscDataRep_write_conv_fn,PetscDataRep_extent_fn,NULL);CHKERRQ(ierr);
917e39fd77fSBarry Smith #endif
918951e3c8eSBarry Smith #endif
919e39fd77fSBarry Smith 
92035d88935SVictor Minden #if defined(PETSC_HAVE_CUDA)
92120e2c332SMatthew G. Knepley   flg  = PETSC_TRUE;
922c5929fdfSBarry Smith   ierr = PetscOptionsGetBool(NULL,NULL,"-cublas",&flg,NULL);CHKERRQ(ierr);
92320e2c332SMatthew G. Knepley   if (flg) {
9244bb5149bSJed Brown     PetscMPIInt p;
925663ba86aSMatthew G Knepley     for (p = 0; p < PetscGlobalSize; ++p) {
92682f73ecaSAlejandro Lamas Daviña       if (p == PetscGlobalRank) {
92782f73ecaSAlejandro Lamas Daviña         cberr = cublasCreate(&cublasv2handle);CHKERRCUBLAS(cberr);
92882f73ecaSAlejandro Lamas Daviña       }
929663ba86aSMatthew G Knepley       ierr = MPI_Barrier(PETSC_COMM_WORLD);CHKERRQ(ierr);
930663ba86aSMatthew G Knepley     }
9314bb5149bSJed Brown   }
9323e39abd9SVictor Minden #endif
93392e62aa6SBarry Smith 
934c5929fdfSBarry Smith   ierr = PetscOptionsHasName(NULL,NULL,"-python",&flg);CHKERRQ(ierr);
9359ac80d5eSLisandro Dalcin   if (flg) {
9369ac80d5eSLisandro Dalcin     PetscInitializeCalled = PETSC_TRUE;
9370298fd71SBarry Smith     ierr = PetscPythonInitialize(NULL,NULL);CHKERRQ(ierr);
9389ac80d5eSLisandro Dalcin   }
9399ac80d5eSLisandro Dalcin 
94041c0b4b3SShri Abhyankar   /*
94141c0b4b3SShri Abhyankar       Setup building of stack frames for all function calls
94241c0b4b3SShri Abhyankar   */
943ef19f930SBarry Smith #if defined(PETSC_USE_DEBUG) && !defined(PETSC_HAVE_THREADSAFETY)
944e1167bb9SShri Abhyankar   ierr = PetscStackCreate();CHKERRQ(ierr);
945e1167bb9SShri Abhyankar #endif
946e1167bb9SShri Abhyankar 
9472d53ad75SBarry Smith #if defined(PETSC_SERIALIZE_FUNCTIONS)
9482d53ad75SBarry Smith   ierr = PetscFPTCreate(10000);CHKERRQ(ierr);
9492d53ad75SBarry Smith #endif
9502d53ad75SBarry Smith 
951dff31646SBarry Smith 
952301d30feSBarry Smith   /*
953301d30feSBarry Smith       Once we are completedly initialized then we can set this variables
954301d30feSBarry Smith   */
955301d30feSBarry Smith   PetscInitializeCalled = PETSC_TRUE;
956301d30feSBarry Smith   PetscFunctionReturn(0);
957e5c89e4eSSatish Balay }
958e5c89e4eSSatish Balay 
9594097062eSBarry Smith #if defined(PETSC_USE_LOG)
9602eff7a51SBarry Smith extern PetscObject *PetscObjects;
9612eff7a51SBarry Smith extern PetscInt    PetscObjectsCounts, PetscObjectsMaxCounts;
96205df10baSBarry Smith extern PetscBool   PetscObjectsLog;
9634097062eSBarry Smith #endif
964e5c89e4eSSatish Balay 
965e5c89e4eSSatish Balay #undef __FUNCT__
966e5c89e4eSSatish Balay #define __FUNCT__ "PetscFinalize"
967e5c89e4eSSatish Balay /*@C
968e5c89e4eSSatish Balay    PetscFinalize - Checks for options to be called at the conclusion
969e5c89e4eSSatish Balay    of the program. MPI_Finalize() is called only if the user had not
970e5c89e4eSSatish Balay    called MPI_Init() before calling PetscInitialize().
971e5c89e4eSSatish Balay 
972e5c89e4eSSatish Balay    Collective on PETSC_COMM_WORLD
973e5c89e4eSSatish Balay 
974e5c89e4eSSatish Balay    Options Database Keys:
97588c29154SBarry Smith +  -options_table - Calls PetscOptionsView()
976e5c89e4eSSatish Balay .  -options_left - Prints unused options that remain in the database
9777eb1d149SBarry 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
978e5c89e4eSSatish Balay .  -mpidump - Calls PetscMPIDump()
979e5c89e4eSSatish Balay .  -malloc_dump - Calls PetscMallocDump()
980e5c89e4eSSatish Balay .  -malloc_info - Prints total memory usage
981e5c89e4eSSatish Balay -  -malloc_log - Prints summary of memory usage
982e5c89e4eSSatish Balay 
983e5c89e4eSSatish Balay    Level: beginner
984e5c89e4eSSatish Balay 
985e5c89e4eSSatish Balay    Note:
986e5c89e4eSSatish Balay    See PetscInitialize() for more general runtime options.
987e5c89e4eSSatish Balay 
98888c29154SBarry Smith .seealso: PetscInitialize(), PetscOptionsView(), PetscMallocDump(), PetscMPIDump(), PetscEnd()
989e5c89e4eSSatish Balay @*/
9907087cfbeSBarry Smith PetscErrorCode  PetscFinalize(void)
991e5c89e4eSSatish Balay {
992e5c89e4eSSatish Balay   PetscErrorCode ierr;
9934bb5149bSJed Brown   PetscMPIInt    rank;
994a8d2bbe5SBarry Smith   PetscInt       nopt;
9952bf49c77SBarry Smith   PetscBool      flg1 = PETSC_FALSE,flg2 = PETSC_FALSE,flg3 = PETSC_FALSE;
996dff31646SBarry Smith   PetscBool      flg;
99710463e74SBarry Smith #if defined(PETSC_USE_LOG)
99810463e74SBarry Smith   char           mname[PETSC_MAX_PATH_LEN];
99910463e74SBarry Smith #endif
100082f73ecaSAlejandro Lamas Daviña #if defined(PETSC_HAVE_CUDA)
100182f73ecaSAlejandro Lamas Daviña   cublasStatus_t cberr;
100282f73ecaSAlejandro Lamas Daviña #endif
1003e5c89e4eSSatish Balay 
1004e5c89e4eSSatish Balay   PetscFunctionBegin;
1005e5c89e4eSSatish Balay   if (!PetscInitializeCalled) {
10064b09e917SBarry Smith     printf("PetscInitialize() must be called before PetscFinalize()\n");
10074b09e917SBarry Smith     PetscFunctionReturn(PETSC_ERR_ARG_WRONGSTATE);
1008e5c89e4eSSatish Balay   }
10090298fd71SBarry Smith   ierr = PetscInfo(NULL,"PetscFinalize() called\n");CHKERRQ(ierr);
1010b022a5c1SBarry Smith 
10111f817a21SBarry Smith   ierr = MPI_Comm_rank(PETSC_COMM_WORLD,&rank);CHKERRQ(ierr);
10121f817a21SBarry Smith 
1013c5929fdfSBarry Smith   ierr = PetscOptionsHasName(NULL,NULL,"-citations",&flg);CHKERRQ(ierr);
1014dff31646SBarry Smith   if (flg) {
10151f817a21SBarry Smith     char  *cits, filename[PETSC_MAX_PATH_LEN];
10161f817a21SBarry Smith     FILE  *fd = PETSC_STDOUT;
10171f817a21SBarry Smith 
1018c5929fdfSBarry Smith     ierr = PetscOptionsGetString(NULL,NULL,"-citations",filename,PETSC_MAX_PATH_LEN,NULL);CHKERRQ(ierr);
10191f817a21SBarry Smith     if (filename[0]) {
10201f817a21SBarry Smith       ierr = PetscFOpen(PETSC_COMM_WORLD,filename,"w",&fd);CHKERRQ(ierr);
10211f817a21SBarry Smith     }
1022dff31646SBarry Smith     ierr = PetscSegBufferGet(PetscCitationsList,1,&cits);CHKERRQ(ierr);
1023dff31646SBarry Smith     cits[0] = 0;
1024dff31646SBarry Smith     ierr = PetscSegBufferExtractAlloc(PetscCitationsList,&cits);CHKERRQ(ierr);
10251f817a21SBarry Smith     ierr = PetscFPrintf(PETSC_COMM_WORLD,fd,"If you publish results based on this computation please cite the following:\n");CHKERRQ(ierr);
10261f817a21SBarry Smith     ierr = PetscFPrintf(PETSC_COMM_WORLD,fd,"===========================================================================\n");CHKERRQ(ierr);
10271f817a21SBarry Smith     ierr = PetscFPrintf(PETSC_COMM_WORLD,fd,"%s",cits);CHKERRQ(ierr);
10281f817a21SBarry Smith     ierr = PetscFPrintf(PETSC_COMM_WORLD,fd,"===========================================================================\n");CHKERRQ(ierr);
10291f817a21SBarry Smith     ierr = PetscFClose(PETSC_COMM_WORLD,fd);CHKERRQ(ierr);
1030dff31646SBarry Smith     ierr = PetscFree(cits);CHKERRQ(ierr);
1031dff31646SBarry Smith   }
1032dff31646SBarry Smith   ierr = PetscSegBufferDestroy(&PetscCitationsList);CHKERRQ(ierr);
1033dff31646SBarry Smith 
1034c2a97968SBarry Smith #if defined(PETSC_HAVE_SSL) && defined(PETSC_USE_SOCKET_VIEWER)
103504102261SBarry Smith   /* TextBelt is run for testing purposes only, please do not use this feature often */
103604102261SBarry Smith   {
103704102261SBarry Smith     PetscInt nmax = 2;
103804102261SBarry Smith     char     **buffs;
103904102261SBarry Smith     ierr = PetscMalloc1(2,&buffs);CHKERRQ(ierr);
1040c5929fdfSBarry Smith     ierr = PetscOptionsGetStringArray(NULL,NULL,"-textbelt",buffs,&nmax,&flg1);CHKERRQ(ierr);
104104102261SBarry Smith     if (flg1) {
104204102261SBarry Smith       if (!nmax) SETERRQ(PETSC_COMM_WORLD,PETSC_ERR_USER,"-textbelt requires either the phone number or number,\"message\"");
104304102261SBarry Smith       if (nmax == 1) {
104404102261SBarry Smith         ierr = PetscMalloc1(128,&buffs[1]);CHKERRQ(ierr);
104504102261SBarry Smith         ierr = PetscGetProgramName(buffs[1],32);CHKERRQ(ierr);
104604102261SBarry Smith         ierr = PetscStrcat(buffs[1]," has completed");CHKERRQ(ierr);
104704102261SBarry Smith       }
104804102261SBarry Smith       ierr = PetscTextBelt(PETSC_COMM_WORLD,buffs[0],buffs[1],NULL);CHKERRQ(ierr);
104904102261SBarry Smith       ierr = PetscFree(buffs[0]);CHKERRQ(ierr);
105004102261SBarry Smith       ierr = PetscFree(buffs[1]);CHKERRQ(ierr);
105104102261SBarry Smith     }
105204102261SBarry Smith     ierr = PetscFree(buffs);CHKERRQ(ierr);
105304102261SBarry Smith   }
105404102261SBarry Smith #endif
105567234432SDmitry Karpeev   /*
105667234432SDmitry Karpeev     It should be safe to cancel the options monitors, since we don't expect to be setting options
105767234432SDmitry Karpeev     here (at least that are worth monitoring).  Monitors ought to be released so that they release
105867234432SDmitry Karpeev     whatever memory was allocated there before -malloc_dump reports unfreed memory.
105967234432SDmitry Karpeev   */
106067234432SDmitry Karpeev   ierr = PetscOptionsMonitorCancel();CHKERRQ(ierr);
106104102261SBarry Smith 
10622d53ad75SBarry Smith #if defined(PETSC_SERIALIZE_FUNCTIONS)
10632d53ad75SBarry Smith   ierr = PetscFPTDestroy();CHKERRQ(ierr);
10642d53ad75SBarry Smith #endif
10652d53ad75SBarry Smith 
10662d53ad75SBarry Smith 
1067e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS)
1068dff31646SBarry Smith   flg = PETSC_FALSE;
1069c5929fdfSBarry Smith   ierr = PetscOptionsGetBool(NULL,NULL,"-saw_options",&flg,NULL);CHKERRQ(ierr);
1070d5649816SBarry Smith   if (flg) {
1071e04113cfSBarry Smith     ierr = PetscOptionsSAWsDestroy();CHKERRQ(ierr);
1072d5649816SBarry Smith   }
1073d5649816SBarry Smith #endif
1074d5649816SBarry Smith 
1075681455b2SBarry Smith #if defined(PETSC_HAVE_X)
1076681455b2SBarry Smith   flg1 = PETSC_FALSE;
1077c5929fdfSBarry Smith   ierr = PetscOptionsGetBool(NULL,NULL,"-x_virtual",&flg1,NULL);CHKERRQ(ierr);
1078681455b2SBarry Smith   if (flg1) {
1079681455b2SBarry Smith     /*  this is a crude hack, but better than nothing */
1080681455b2SBarry Smith     ierr = PetscPOpen(PETSC_COMM_WORLD,NULL,"pkill -9 Xvfb","r",NULL);CHKERRQ(ierr);
1081681455b2SBarry Smith   }
1082681455b2SBarry Smith #endif
1083681455b2SBarry Smith 
108467584ceeSBarry Smith #if !defined(PETSC_HAVE_THREADSAFETY)
1085c5929fdfSBarry Smith   ierr = PetscOptionsGetBool(NULL,NULL,"-malloc_info",&flg2,NULL);CHKERRQ(ierr);
1086e5c89e4eSSatish Balay   if (!flg2) {
108790d69ab7SBarry Smith     flg2 = PETSC_FALSE;
1088c5929fdfSBarry Smith     ierr = PetscOptionsGetBool(NULL,NULL,"-memory_view",&flg2,NULL);CHKERRQ(ierr);
1089e5c89e4eSSatish Balay   }
1090e5c89e4eSSatish Balay   if (flg2) {
10910841954dSBarry Smith     ierr = PetscMemoryView(PETSC_VIEWER_STDOUT_WORLD,"Summary of Memory Usage in PETSc\n");CHKERRQ(ierr);
1092e5c89e4eSSatish Balay   }
109367584ceeSBarry Smith #endif
1094e5c89e4eSSatish Balay 
1095e5c89e4eSSatish Balay #if defined(PETSC_USE_LOG)
109690d69ab7SBarry Smith   flg1 = PETSC_FALSE;
1097c5929fdfSBarry Smith   ierr = PetscOptionsGetBool(NULL,NULL,"-get_total_flops",&flg1,NULL);CHKERRQ(ierr);
1098e5c89e4eSSatish Balay   if (flg1) {
1099e5c89e4eSSatish Balay     PetscLogDouble flops = 0;
1100205a32c2SJed Brown     ierr = MPI_Reduce(&petsc_TotalFlops,&flops,1,MPI_DOUBLE,MPI_SUM,0,PETSC_COMM_WORLD);CHKERRQ(ierr);
1101e5c89e4eSSatish Balay     ierr = PetscPrintf(PETSC_COMM_WORLD,"Total flops over all processors %g\n",flops);CHKERRQ(ierr);
1102e5c89e4eSSatish Balay   }
1103e5c89e4eSSatish Balay #endif
1104e5c89e4eSSatish Balay 
1105e5c89e4eSSatish Balay 
1106e5c89e4eSSatish Balay #if defined(PETSC_USE_LOG)
1107e5c89e4eSSatish Balay #if defined(PETSC_HAVE_MPE)
1108e5c89e4eSSatish Balay   mname[0] = 0;
1109a297a907SKarl Rupp 
1110c5929fdfSBarry Smith   ierr = PetscOptionsGetString(NULL,NULL,"-log_mpe",mname,PETSC_MAX_PATH_LEN,&flg1);CHKERRQ(ierr);
1111e5c89e4eSSatish Balay   if (flg1) {
1112e5c89e4eSSatish Balay     if (mname[0]) {ierr = PetscLogMPEDump(mname);CHKERRQ(ierr);}
1113e5c89e4eSSatish Balay     else          {ierr = PetscLogMPEDump(0);CHKERRQ(ierr);}
1114e5c89e4eSSatish Balay   }
1115e5c89e4eSSatish Balay #endif
1116e5c89e4eSSatish Balay   mname[0] = 0;
1117a297a907SKarl Rupp 
1118f14045dbSBarry Smith   ierr = PetscLogViewFromOptions();CHKERRQ(ierr);
1119c5929fdfSBarry Smith   ierr = PetscOptionsGetString(NULL,NULL,"-log_summary",mname,PETSC_MAX_PATH_LEN,&flg1);CHKERRQ(ierr);
1120e5c89e4eSSatish Balay   if (flg1) {
112191eabc43SBarry Smith     PetscViewer viewer;
112220a8bfc3SBarry Smith     ierr = (*PetscHelpPrintf)(PETSC_COMM_WORLD,"\n\n WARNING:   -log_summary is being deprecated; switch to -log_view\n\n\n");CHKERRQ(ierr);
112391eabc43SBarry Smith     if (mname[0]) {
112491eabc43SBarry Smith       ierr = PetscViewerASCIIOpen(PETSC_COMM_WORLD,mname,&viewer);CHKERRQ(ierr);
112591eabc43SBarry Smith       ierr = PetscLogView(viewer);CHKERRQ(ierr);
11266bf464f9SBarry Smith       ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr);
112733f85c2fSBarry Smith     } else {
112833f85c2fSBarry Smith       viewer = PETSC_VIEWER_STDOUT_WORLD;
11299a9a5d4cSBarry Smith       ierr   = PetscViewerPushFormat(viewer,PETSC_VIEWER_DEFAULT);CHKERRQ(ierr);
113033f85c2fSBarry Smith       ierr   = PetscLogView(viewer);CHKERRQ(ierr);
11319a9a5d4cSBarry Smith       ierr   = PetscViewerPopFormat(viewer);CHKERRQ(ierr);
113233f85c2fSBarry Smith     }
1133e5c89e4eSSatish Balay   }
1134e5c89e4eSSatish Balay   mname[0] = 0;
1135a297a907SKarl Rupp 
1136c5929fdfSBarry Smith   ierr = PetscOptionsGetString(NULL,NULL,"-log_all",mname,PETSC_MAX_PATH_LEN,&flg1);CHKERRQ(ierr);
1137c5929fdfSBarry Smith   ierr = PetscOptionsGetString(NULL,NULL,"-log",mname,PETSC_MAX_PATH_LEN,&flg2);CHKERRQ(ierr);
1138e5c89e4eSSatish Balay   if (flg1 || flg2) {
1139e5c89e4eSSatish Balay     if (mname[0]) PetscLogDump(mname);
1140e5c89e4eSSatish Balay     else          PetscLogDump(0);
1141e5c89e4eSSatish Balay   }
1142e5c89e4eSSatish Balay #endif
114310463e74SBarry Smith 
1144b58ca069SBarry Smith   /*
1145b58ca069SBarry Smith      Free all objects registered with PetscObjectRegisterDestroy() such as PETSC_VIEWER_XXX_().
1146b58ca069SBarry Smith   */
1147b58ca069SBarry Smith   ierr = PetscObjectRegisterDestroyAll();CHKERRQ(ierr);
1148b58ca069SBarry Smith 
114933f85c2fSBarry Smith   ierr = PetscStackDestroy();CHKERRQ(ierr);
115010463e74SBarry Smith 
115190d69ab7SBarry Smith   flg1 = PETSC_FALSE;
1152c5929fdfSBarry Smith   ierr = PetscOptionsGetBool(NULL,NULL,"-no_signal_handler",&flg1,NULL);CHKERRQ(ierr);
1153e5c89e4eSSatish Balay   if (!flg1) { ierr = PetscPopSignalHandler();CHKERRQ(ierr);}
115490d69ab7SBarry Smith   flg1 = PETSC_FALSE;
1155c5929fdfSBarry Smith   ierr = PetscOptionsGetBool(NULL,NULL,"-mpidump",&flg1,NULL);CHKERRQ(ierr);
1156e5c89e4eSSatish Balay   if (flg1) {
1157e5c89e4eSSatish Balay     ierr = PetscMPIDump(stdout);CHKERRQ(ierr);
1158e5c89e4eSSatish Balay   }
115990d69ab7SBarry Smith   flg1 = PETSC_FALSE;
116090d69ab7SBarry Smith   flg2 = PETSC_FALSE;
11618bb29257SSatish Balay   /* preemptive call to avoid listing this option in options table as unused */
1162c5929fdfSBarry Smith   ierr = PetscOptionsHasName(NULL,NULL,"-malloc_dump",&flg1);CHKERRQ(ierr);
1163c5929fdfSBarry Smith   ierr = PetscOptionsHasName(NULL,NULL,"-objects_dump",&flg1);CHKERRQ(ierr);
1164c5929fdfSBarry Smith   ierr = PetscOptionsGetBool(NULL,NULL,"-options_view",&flg2,NULL);CHKERRQ(ierr);
1165e4c476e2SSatish Balay 
1166e5c89e4eSSatish Balay   if (flg2) {
1167be56827dSJed Brown     PetscViewer viewer;
116802ba9f54SBarry Smith     ierr = PetscViewerCreate(PETSC_COMM_WORLD,&viewer);CHKERRQ(ierr);
116902ba9f54SBarry Smith     ierr = PetscViewerSetType(viewer,PETSCVIEWERASCII);CHKERRQ(ierr);
1170c5929fdfSBarry Smith     ierr = PetscOptionsView(NULL,viewer);CHKERRQ(ierr);
1171be56827dSJed Brown     ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr);
1172e5c89e4eSSatish Balay   }
1173e5c89e4eSSatish Balay 
1174e5c89e4eSSatish Balay   /* to prevent PETSc -options_left from warning */
1175c5929fdfSBarry Smith   ierr = PetscOptionsHasName(NULL,NULL,"-nox",&flg1);CHKERRQ(ierr);
1176c5929fdfSBarry Smith   ierr = PetscOptionsHasName(NULL,NULL,"-nox_warning",&flg1);CHKERRQ(ierr);
1177e5c89e4eSSatish Balay 
117833fc4174SSatish Balay   flg3 = PETSC_FALSE; /* default value is required */
1179c5929fdfSBarry Smith   ierr = PetscOptionsGetBool(NULL,NULL,"-options_left",&flg3,&flg1);CHKERRQ(ierr);
1180c5929fdfSBarry Smith   ierr = PetscOptionsAllUsed(NULL,&nopt);CHKERRQ(ierr);
1181e5c89e4eSSatish Balay   if (flg3) {
1182e5c89e4eSSatish Balay     if (!flg2) { /* have not yet printed the options */
1183be56827dSJed Brown       PetscViewer viewer;
118402ba9f54SBarry Smith       ierr = PetscViewerCreate(PETSC_COMM_WORLD,&viewer);CHKERRQ(ierr);
118502ba9f54SBarry Smith       ierr = PetscViewerSetType(viewer,PETSCVIEWERASCII);CHKERRQ(ierr);
1186c5929fdfSBarry Smith       ierr = PetscOptionsView(NULL,viewer);CHKERRQ(ierr);
1187be56827dSJed Brown       ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr);
1188e5c89e4eSSatish Balay     }
1189e5c89e4eSSatish Balay     if (!nopt) {
1190e5c89e4eSSatish Balay       ierr = PetscPrintf(PETSC_COMM_WORLD,"There are no unused options.\n");CHKERRQ(ierr);
1191e5c89e4eSSatish Balay     } else if (nopt == 1) {
1192e5c89e4eSSatish Balay       ierr = PetscPrintf(PETSC_COMM_WORLD,"There is one unused database option. It is:\n");CHKERRQ(ierr);
1193e5c89e4eSSatish Balay     } else {
11947582186dSLisandro Dalcin       ierr = PetscPrintf(PETSC_COMM_WORLD,"There are %D unused database options. They are:\n",nopt);CHKERRQ(ierr);
1195e5c89e4eSSatish Balay     }
1196df12ba86SBarry Smith   }
1197e5c89e4eSSatish Balay #if defined(PETSC_USE_DEBUG)
1198da8b8a77SBarry Smith   if (nopt && !flg3 && !flg1) {
1199e5c89e4eSSatish Balay     ierr = PetscPrintf(PETSC_COMM_WORLD,"WARNING! There are options you set that were not used!\n");CHKERRQ(ierr);
1200e5c89e4eSSatish Balay     ierr = PetscPrintf(PETSC_COMM_WORLD,"WARNING! could be spelling mistake, etc!\n");CHKERRQ(ierr);
1201c5929fdfSBarry Smith     ierr = PetscOptionsLeft(NULL);CHKERRQ(ierr);
1202e5c89e4eSSatish Balay   } else if (nopt && flg3) {
1203e5c89e4eSSatish Balay #else
1204e5c89e4eSSatish Balay   if (nopt && flg3) {
1205e5c89e4eSSatish Balay #endif
1206c5929fdfSBarry Smith     ierr = PetscOptionsLeft(NULL);CHKERRQ(ierr);
1207e5c89e4eSSatish Balay   }
1208e5c89e4eSSatish Balay 
1209e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS)
1210d45a07a7SBarry Smith   if (!PetscGlobalRank) {
121187f587eeSBarry Smith     ierr = PetscStackSAWsViewOff();CHKERRQ(ierr);
121216ad0300SBarry Smith     PetscStackCallSAWs(SAWs_Finalize,());
1213d45a07a7SBarry Smith   }
1214ec957eceSBarry Smith #endif
1215ec957eceSBarry Smith 
12164097062eSBarry Smith #if defined(PETSC_USE_LOG)
121710463e74SBarry Smith   /*
1218dbc8283eSBarry Smith        List all objects the user may have forgot to free
12192eff7a51SBarry Smith   */
122005df10baSBarry Smith   if (PetscObjectsLog) {
1221c5929fdfSBarry Smith     ierr = PetscOptionsHasName(NULL,NULL,"-objects_dump",&flg1);CHKERRQ(ierr);
1222a64a8e02SBarry Smith     if (flg1) {
1223a64a8e02SBarry Smith       MPI_Comm local_comm;
12247eb1d149SBarry Smith       char     string[64];
1225a64a8e02SBarry Smith 
1226c5929fdfSBarry Smith       ierr = PetscOptionsGetString(NULL,NULL,"-objects_dump",string,64,NULL);CHKERRQ(ierr);
1227a64a8e02SBarry Smith       ierr = MPI_Comm_dup(MPI_COMM_WORLD,&local_comm);CHKERRQ(ierr);
1228a64a8e02SBarry Smith       ierr = PetscSequentialPhaseBegin_Private(local_comm,1);CHKERRQ(ierr);
12297eb1d149SBarry Smith       ierr = PetscObjectsDump(stdout,(string[0] == 'a') ? PETSC_TRUE : PETSC_FALSE);CHKERRQ(ierr);
1230a64a8e02SBarry Smith       ierr = PetscSequentialPhaseEnd_Private(local_comm,1);CHKERRQ(ierr);
1231a64a8e02SBarry Smith       ierr = MPI_Comm_free(&local_comm);CHKERRQ(ierr);
12320a1571b3SBarry Smith     }
123305df10baSBarry Smith   }
12344097062eSBarry Smith #endif
12354097062eSBarry Smith 
12364097062eSBarry Smith #if defined(PETSC_USE_LOG)
1237dbc8283eSBarry Smith   PetscObjectsCounts    = 0;
1238dbc8283eSBarry Smith   PetscObjectsMaxCounts = 0;
1239a297a907SKarl Rupp   ierr = PetscFree(PetscObjects);CHKERRQ(ierr);
12404097062eSBarry Smith #endif
12412eff7a51SBarry Smith 
124233f85c2fSBarry Smith   /*
124333f85c2fSBarry Smith      Destroy any packages that registered a finalize
124433f85c2fSBarry Smith   */
124533f85c2fSBarry Smith   ierr = PetscRegisterFinalizeAll();CHKERRQ(ierr);
124633f85c2fSBarry Smith 
1247101409b8SToby Isaac #if defined(PETSC_USE_LOG)
1248101409b8SToby Isaac   ierr = PetscLogDestroy();CHKERRQ(ierr);
1249101409b8SToby Isaac #endif
1250101409b8SToby Isaac 
125133f85c2fSBarry Smith   /*
125248dd1dffSBarry Smith      Print PetscFunctionLists that have not been properly freed
125348dd1dffSBarry Smith 
125437e93019SBarry Smith   ierr = PetscFunctionListPrintAll();CHKERRQ(ierr);
125548dd1dffSBarry Smith   */
125637e93019SBarry Smith 
12574028d114SSatish Balay   if (petsc_history) {
1258f3dea69dSBarry Smith     ierr = PetscCloseHistoryFile(&petsc_history);CHKERRQ(ierr);
1259e5c89e4eSSatish Balay     petsc_history = 0;
1260e5c89e4eSSatish Balay   }
12619de0f6ecSBarry Smith   ierr = PetscOptionsHelpPrintedDestroy(&PetscOptionsHelpPrintedSingleton);CHKERRQ(ierr);
1262e5c89e4eSSatish Balay 
12630298fd71SBarry Smith   ierr = PetscInfoAllow(PETSC_FALSE,NULL);CHKERRQ(ierr);
1264e5c89e4eSSatish Balay 
126567584ceeSBarry Smith #if !defined(PETSC_HAVE_THREADSAFETY)
12668bb29257SSatish Balay   {
1267e5c89e4eSSatish Balay     char fname[PETSC_MAX_PATH_LEN];
1268e5c89e4eSSatish Balay     FILE *fd;
1269ed9cf6e9SBarry Smith     int  err;
1270e5c89e4eSSatish Balay 
1271e5c89e4eSSatish Balay     fname[0] = 0;
1272a297a907SKarl Rupp 
1273c5929fdfSBarry Smith     ierr = PetscOptionsGetString(NULL,NULL,"-malloc_dump",fname,250,&flg1);CHKERRQ(ierr);
1274dc92acbaSJed Brown     flg2 = PETSC_FALSE;
1275c5929fdfSBarry Smith     ierr = PetscOptionsGetBool(NULL,NULL,"-malloc_test",&flg2,NULL);CHKERRQ(ierr);
12768bf1f09cSShri Abhyankar #if defined(PETSC_USE_DEBUG)
1277dc92acbaSJed Brown     if (PETSC_RUNNING_ON_VALGRIND) flg2 = PETSC_FALSE;
1278dc92acbaSJed Brown #else
1279dc92acbaSJed Brown     flg2 = PETSC_FALSE;         /* Skip reporting for optimized builds regardless of -malloc_test */
1280dc92acbaSJed Brown #endif
1281e5c89e4eSSatish Balay     if (flg1 && fname[0]) {
1282e5c89e4eSSatish Balay       char sname[PETSC_MAX_PATH_LEN];
1283e5c89e4eSSatish Balay 
1284e5c89e4eSSatish Balay       sprintf(sname,"%s_%d",fname,rank);
1285e32f2f54SBarry Smith       fd   = fopen(sname,"w"); if (!fd) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_FILE_OPEN,"Cannot open log file: %s",sname);
1286e5c89e4eSSatish Balay       ierr = PetscMallocDump(fd);CHKERRQ(ierr);
1287ed9cf6e9SBarry Smith       err  = fclose(fd);
1288e32f2f54SBarry Smith       if (err) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SYS,"fclose() failed on file");
1289dc92acbaSJed Brown     } else if (flg1 || flg2) {
1290e5c89e4eSSatish Balay       MPI_Comm local_comm;
1291e5c89e4eSSatish Balay 
1292e5c89e4eSSatish Balay       ierr = MPI_Comm_dup(MPI_COMM_WORLD,&local_comm);CHKERRQ(ierr);
1293e5c89e4eSSatish Balay       ierr = PetscSequentialPhaseBegin_Private(local_comm,1);CHKERRQ(ierr);
1294e5c89e4eSSatish Balay       ierr = PetscMallocDump(stdout);CHKERRQ(ierr);
1295e5c89e4eSSatish Balay       ierr = PetscSequentialPhaseEnd_Private(local_comm,1);CHKERRQ(ierr);
1296e5c89e4eSSatish Balay       ierr = MPI_Comm_free(&local_comm);CHKERRQ(ierr);
1297e5c89e4eSSatish Balay     }
1298e5c89e4eSSatish Balay   }
1299a64a8e02SBarry Smith 
13008bb29257SSatish Balay   {
1301e5c89e4eSSatish Balay     char fname[PETSC_MAX_PATH_LEN];
13020298fd71SBarry Smith     FILE *fd = NULL;
1303e5c89e4eSSatish Balay 
1304e5c89e4eSSatish Balay     fname[0] = 0;
1305a297a907SKarl Rupp 
1306c5929fdfSBarry Smith     ierr = PetscOptionsGetString(NULL,NULL,"-malloc_log",fname,250,&flg1);CHKERRQ(ierr);
1307c5929fdfSBarry Smith     ierr = PetscOptionsHasName(NULL,NULL,"-malloc_log_threshold",&flg2);CHKERRQ(ierr);
1308e5c89e4eSSatish Balay     if (flg1 && fname[0]) {
1309ed9cf6e9SBarry Smith       int err;
1310e5c89e4eSSatish Balay 
1311574034a9SJed Brown       if (!rank) {
1312574034a9SJed Brown         fd = fopen(fname,"w");
1313574034a9SJed Brown         if (!fd) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_FILE_OPEN,"Cannot open log file: %s",fname);
1314574034a9SJed Brown       }
1315e5c89e4eSSatish Balay       ierr = PetscMallocDumpLog(fd);CHKERRQ(ierr);
1316574034a9SJed Brown       if (fd) {
1317ed9cf6e9SBarry Smith         err = fclose(fd);
1318e32f2f54SBarry Smith         if (err) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SYS,"fclose() failed on file");
1319574034a9SJed Brown       }
1320574034a9SJed Brown     } else if (flg1 || flg2) {
1321e5c89e4eSSatish Balay       ierr = PetscMallocDumpLog(stdout);CHKERRQ(ierr);
1322e5c89e4eSSatish Balay     }
1323e5c89e4eSSatish Balay   }
132467584ceeSBarry Smith #endif
132520e2c332SMatthew G. Knepley 
13265486ca60SMatthew G. Knepley   /*
13275486ca60SMatthew G. Knepley      Close any open dynamic libraries
13285486ca60SMatthew G. Knepley   */
13295486ca60SMatthew G. Knepley   ierr = PetscFinalize_DynamicLibraries();CHKERRQ(ierr);
13305486ca60SMatthew G. Knepley 
133120e2c332SMatthew G. Knepley #if defined(PETSC_HAVE_CUDA)
133220e2c332SMatthew G. Knepley   flg  = PETSC_TRUE;
1333c5929fdfSBarry Smith   ierr = PetscOptionsGetBool(NULL,NULL,"-cublas",&flg,NULL);CHKERRQ(ierr);
133420e2c332SMatthew G. Knepley   if (flg) {
133520e2c332SMatthew G. Knepley     PetscInt p;
133620e2c332SMatthew G. Knepley     for (p = 0; p < PetscGlobalSize; ++p) {
133782f73ecaSAlejandro Lamas Daviña       if (p == PetscGlobalRank) {
133882f73ecaSAlejandro Lamas Daviña         if (cublasv2handle) {
133982f73ecaSAlejandro Lamas Daviña           cberr = cublasDestroy(cublasv2handle);CHKERRCUBLAS(cberr);
134082f73ecaSAlejandro Lamas Daviña         }
134182f73ecaSAlejandro Lamas Daviña       }
134220e2c332SMatthew G. Knepley       ierr = MPI_Barrier(PETSC_COMM_WORLD);CHKERRQ(ierr);
134320e2c332SMatthew G. Knepley     }
134420e2c332SMatthew G. Knepley   }
134520e2c332SMatthew G. Knepley #endif
134620e2c332SMatthew G. Knepley 
1347e5c89e4eSSatish Balay   /* Can be destroyed only after all the options are used */
13484416b707SBarry Smith   ierr = PetscOptionsDestroyDefault();CHKERRQ(ierr);
1349e5c89e4eSSatish Balay 
1350e5c89e4eSSatish Balay   PetscGlobalArgc = 0;
1351e5c89e4eSSatish Balay   PetscGlobalArgs = 0;
1352e5c89e4eSSatish Balay 
1353ce63c4c1SBarry Smith #if defined(PETSC_USE_REAL___FLOAT128)
1354c90a1750SBarry Smith   ierr = MPI_Type_free(&MPIU___FLOAT128);CHKERRQ(ierr);
13557c2de775SJed Brown #if defined(PETSC_HAVE_COMPLEX)
13568c764dc5SJose Roman   ierr = MPI_Type_free(&MPIU___COMPLEX128);CHKERRQ(ierr);
13578c764dc5SJose Roman #endif
1358d9822059SBarry Smith   ierr = MPI_Op_free(&MPIU_MAX);CHKERRQ(ierr);
1359d9822059SBarry Smith   ierr = MPI_Op_free(&MPIU_MIN);CHKERRQ(ierr);
1360c90a1750SBarry Smith #endif
1361c90a1750SBarry Smith 
13627c2de775SJed Brown #if defined(PETSC_HAVE_COMPLEX)
13632c876bd9SBarry Smith #if !defined(PETSC_HAVE_MPI_C_DOUBLE_COMPLEX)
1364500d8756SSatish Balay   ierr = MPI_Type_free(&MPIU_C_DOUBLE_COMPLEX);CHKERRQ(ierr);
1365500d8756SSatish Balay   ierr = MPI_Type_free(&MPIU_C_COMPLEX);CHKERRQ(ierr);
13662c876bd9SBarry Smith #endif
1367e5c89e4eSSatish Balay #endif
1368cca4cb22SSatish Balay 
13697c2de775SJed Brown #if (defined(PETSC_HAVE_COMPLEX) && !defined(PETSC_HAVE_MPI_C_DOUBLE_COMPLEX)) || defined(PETSC_USE_REAL___FLOAT128)
1370cca4cb22SSatish Balay   ierr = MPI_Op_free(&MPIU_SUM);CHKERRQ(ierr);
1371cca4cb22SSatish Balay #endif
1372cca4cb22SSatish Balay 
1373e5c89e4eSSatish Balay   ierr = MPI_Type_free(&MPIU_2SCALAR);CHKERRQ(ierr);
137444041f26SJed Brown #if defined(PETSC_USE_64BIT_INDICES) || !defined(MPI_2INT)
1375e5c89e4eSSatish Balay   ierr = MPI_Type_free(&MPIU_2INT);CHKERRQ(ierr);
137644041f26SJed Brown #endif
1377367daffbSBarry Smith   ierr = MPI_Op_free(&MPIU_MAXSUM_OP);CHKERRQ(ierr);
1378e5c89e4eSSatish Balay 
1379dbc8283eSBarry Smith   /*
1380efb80d3cSBarry Smith      Destroy any known inner MPI_Comm's and attributes pointing to them
1381efb80d3cSBarry Smith      Note this will not destroy any new communicators the user has created.
1382efb80d3cSBarry Smith 
1383efb80d3cSBarry Smith      If all PETSc objects were not destroyed those left over objects will have hanging references to
1384efb80d3cSBarry Smith      the MPI_Comms that were freed; but that is ok because those PETSc objects will never be used again
1385dbc8283eSBarry Smith  */
1386b770b1f6SSatish Balay   {
1387dbc8283eSBarry Smith     PetscCommCounter *counter;
1388dbc8283eSBarry Smith     PetscMPIInt      flg;
1389dbc8283eSBarry Smith     MPI_Comm         icomm;
1390265f3f35SJed Brown     union {MPI_Comm comm; void *ptr;} ucomm;
1391265f3f35SJed Brown     ierr = MPI_Attr_get(PETSC_COMM_SELF,Petsc_InnerComm_keyval,&ucomm,&flg);CHKERRQ(ierr);
1392dbc8283eSBarry Smith     if (flg) {
1393265f3f35SJed Brown       icomm = ucomm.comm;
1394dbc8283eSBarry Smith       ierr = MPI_Attr_get(icomm,Petsc_Counter_keyval,&counter,&flg);CHKERRQ(ierr);
1395dbc8283eSBarry 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");
1396dbc8283eSBarry Smith 
1397dbc8283eSBarry Smith       ierr = MPI_Attr_delete(PETSC_COMM_SELF,Petsc_InnerComm_keyval);CHKERRQ(ierr);
1398efb80d3cSBarry Smith       ierr = MPI_Attr_delete(icomm,Petsc_Counter_keyval);CHKERRQ(ierr);
1399efb80d3cSBarry Smith       ierr = MPI_Comm_free(&icomm);CHKERRQ(ierr);
1400dbc8283eSBarry Smith     }
1401265f3f35SJed Brown     ierr = MPI_Attr_get(PETSC_COMM_WORLD,Petsc_InnerComm_keyval,&ucomm,&flg);CHKERRQ(ierr);
1402dbc8283eSBarry Smith     if (flg) {
1403265f3f35SJed Brown       icomm = ucomm.comm;
1404dbc8283eSBarry Smith       ierr = MPI_Attr_get(icomm,Petsc_Counter_keyval,&counter,&flg);CHKERRQ(ierr);
1405dbc8283eSBarry 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");
1406dbc8283eSBarry Smith 
1407dbc8283eSBarry Smith       ierr = MPI_Attr_delete(PETSC_COMM_WORLD,Petsc_InnerComm_keyval);CHKERRQ(ierr);
1408efb80d3cSBarry Smith       ierr = MPI_Attr_delete(icomm,Petsc_Counter_keyval);CHKERRQ(ierr);
1409efb80d3cSBarry Smith       ierr = MPI_Comm_free(&icomm);CHKERRQ(ierr);
1410dbc8283eSBarry Smith     }
1411b770b1f6SSatish Balay   }
1412dbc8283eSBarry Smith 
1413480cf27aSJed Brown   ierr = MPI_Keyval_free(&Petsc_Counter_keyval);CHKERRQ(ierr);
1414480cf27aSJed Brown   ierr = MPI_Keyval_free(&Petsc_InnerComm_keyval);CHKERRQ(ierr);
1415480cf27aSJed Brown   ierr = MPI_Keyval_free(&Petsc_OuterComm_keyval);CHKERRQ(ierr);
1416480cf27aSJed Brown 
14175ad9ad5bSBarry Smith   ierr = PetscSpinlockDestroy(&PetscViewerASCIISpinLockOpen);CHKERRQ(ierr);
14185ad9ad5bSBarry Smith   ierr = PetscSpinlockDestroy(&PetscViewerASCIISpinLockStdout);CHKERRQ(ierr);
14195ad9ad5bSBarry Smith   ierr = PetscSpinlockDestroy(&PetscViewerASCIISpinLockStderr);CHKERRQ(ierr);
1420ef19f930SBarry Smith   ierr = PetscSpinlockDestroy(&PetscCommSpinLock);CHKERRQ(ierr);
1421ef19f930SBarry Smith 
1422e5c89e4eSSatish Balay   if (PetscBeganMPI) {
142399608316SBarry Smith #if defined(PETSC_HAVE_MPI_FINALIZED)
142499b1327fSBarry Smith     PetscMPIInt flag;
142599b1327fSBarry Smith     ierr = MPI_Finalized(&flag);CHKERRQ(ierr);
1426e32f2f54SBarry Smith     if (flag) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_LIB,"MPI_Finalize() has already been called, even though MPI_Init() was called by PetscInitialize()");
142799608316SBarry Smith #endif
1428e5c89e4eSSatish Balay     ierr = MPI_Finalize();CHKERRQ(ierr);
1429e5c89e4eSSatish Balay   }
1430e5c89e4eSSatish Balay /*
1431e5c89e4eSSatish Balay 
1432e5c89e4eSSatish Balay      Note: In certain cases PETSC_COMM_WORLD is never MPI_Comm_free()ed because
1433e5c89e4eSSatish Balay    the communicator has some outstanding requests on it. Specifically if the
1434e5c89e4eSSatish Balay    flag PETSC_HAVE_BROKEN_REQUEST_FREE is set (for IBM MPI implementation). See
1435e5c89e4eSSatish Balay    src/vec/utils/vpscat.c. Due to this the memory allocated in PetscCommDuplicate()
1436e5c89e4eSSatish Balay    is never freed as it should be. Thus one may obtain messages of the form
14370e5e90baSSatish Balay    [ 1] 8 bytes PetscCommDuplicate() line 645 in src/sys/mpiu.c indicating the
1438e5c89e4eSSatish Balay    memory was not freed.
1439e5c89e4eSSatish Balay 
1440e5c89e4eSSatish Balay */
14411d1a0024SBarry Smith   ierr = PetscMallocClear();CHKERRQ(ierr);
1442a297a907SKarl Rupp 
1443e5c89e4eSSatish Balay   PetscInitializeCalled = PETSC_FALSE;
1444e5c89e4eSSatish Balay   PetscFinalizeCalled   = PETSC_TRUE;
1445*3db9a53dSBarry Smith   PetscFunctionReturn(0);
1446e5c89e4eSSatish Balay }
1447e5c89e4eSSatish Balay 
144843db4dbbSBarry Smith #if defined(PETSC_MISSING_LAPACK_lsame_)
14498cc058d9SJed Brown PETSC_EXTERN int lsame_(char *a,char *b)
145043db4dbbSBarry Smith {
145143db4dbbSBarry Smith   if (*a == *b) return 1;
145243db4dbbSBarry Smith   if (*a + 32 == *b) return 1;
145343db4dbbSBarry Smith   if (*a - 32 == *b) return 1;
145443db4dbbSBarry Smith   return 0;
145543db4dbbSBarry Smith }
1456a70650f6SBarry Smith #endif
145743db4dbbSBarry Smith 
145843db4dbbSBarry Smith #if defined(PETSC_MISSING_LAPACK_lsame)
14598cc058d9SJed Brown PETSC_EXTERN int lsame(char *a,char *b)
146043db4dbbSBarry Smith {
146143db4dbbSBarry Smith   if (*a == *b) return 1;
146243db4dbbSBarry Smith   if (*a + 32 == *b) return 1;
146343db4dbbSBarry Smith   if (*a - 32 == *b) return 1;
146443db4dbbSBarry Smith   return 0;
146543db4dbbSBarry Smith }
146643db4dbbSBarry Smith #endif
1467