xref: /petsc/src/sys/objects/pinit.c (revision 39a651e27bfa10b9060071f09b59ca0e2afa5359)
1bc8a24ecSBarry Smith #define PETSC_DESIRE_FEATURE_TEST_MACROS
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*/
6665c2dedSJed Brown #include <petscviewer.h>
7a0e72f99SJunchao Zhang 
86edef35eSSatish Balay #if !defined(PETSC_HAVE_WINDOWS_COMPILERS)
96edef35eSSatish Balay #include <petsc/private/valgrind/valgrind.h>
106edef35eSSatish Balay #endif
116edef35eSSatish Balay 
1285649d77SJunchao Zhang #if defined(PETSC_HAVE_FORTRAN)
1385649d77SJunchao Zhang #include <petsc/private/fortranimpl.h>
1485649d77SJunchao Zhang #endif
1585649d77SJunchao Zhang 
1656883f60SBarry Smith #if defined(PETSC_USE_GCOV)
1756883f60SBarry Smith EXTERN_C_BEGIN
1856883f60SBarry Smith void  __gcov_flush(void);
1956883f60SBarry Smith EXTERN_C_END
2056883f60SBarry Smith #endif
218101f56cSMatthew Knepley 
222d53ad75SBarry Smith #if defined(PETSC_SERIALIZE_FUNCTIONS)
2395c0884eSLisandro Dalcin PETSC_INTERN PetscFPT PetscFPTData;
242d53ad75SBarry Smith PetscFPT PetscFPTData = 0;
252d53ad75SBarry Smith #endif
262d53ad75SBarry Smith 
2727104ee2SJacob Faibussowitsch #if PetscDefined(HAVE_SAWS)
2816ad0300SBarry Smith #include <petscviewersaws.h>
29a6790183SBarry Smith #endif
30eb02082bSJunchao Zhang 
31e5c89e4eSSatish Balay /* -----------------------------------------------------------------------------------------*/
32e5c89e4eSSatish Balay 
3395c0884eSLisandro Dalcin PETSC_INTERN FILE *petsc_history;
34e5c89e4eSSatish Balay 
3595c0884eSLisandro Dalcin PETSC_INTERN PetscErrorCode PetscInitialize_DynamicLibraries(void);
3695c0884eSLisandro Dalcin PETSC_INTERN PetscErrorCode PetscFinalize_DynamicLibraries(void);
3795c0884eSLisandro Dalcin PETSC_INTERN PetscErrorCode PetscFunctionListPrintAll(void);
3895c0884eSLisandro Dalcin PETSC_INTERN PetscErrorCode PetscSequentialPhaseBegin_Private(MPI_Comm,int);
3995c0884eSLisandro Dalcin PETSC_INTERN PetscErrorCode PetscSequentialPhaseEnd_Private(MPI_Comm,int);
4095c0884eSLisandro Dalcin PETSC_INTERN PetscErrorCode PetscCloseHistoryFile(FILE**);
410069ddf5SShri Abhyankar 
426de5d289SStefano Zampini /* user may set these BEFORE calling PetscInitialize() */
43e8373e55SMatthew Knepley MPI_Comm PETSC_COMM_WORLD = MPI_COMM_NULL;
4427104ee2SJacob Faibussowitsch #if PetscDefined(HAVE_MPI_INIT_THREAD)
456de5d289SStefano Zampini PetscMPIInt PETSC_MPI_THREAD_REQUIRED = MPI_THREAD_FUNNELED;
466de5d289SStefano Zampini #else
476de5d289SStefano Zampini PetscMPIInt PETSC_MPI_THREAD_REQUIRED = 0;
486de5d289SStefano Zampini #endif
49e5c89e4eSSatish Balay 
50480cf27aSJed Brown PetscMPIInt Petsc_Counter_keyval   = MPI_KEYVAL_INVALID;
51480cf27aSJed Brown PetscMPIInt Petsc_InnerComm_keyval = MPI_KEYVAL_INVALID;
52480cf27aSJed Brown PetscMPIInt Petsc_OuterComm_keyval = MPI_KEYVAL_INVALID;
535f7487a0SJunchao Zhang PetscMPIInt Petsc_ShmComm_keyval   = MPI_KEYVAL_INVALID;
54480cf27aSJed Brown 
55e5c89e4eSSatish Balay /*
56e5c89e4eSSatish Balay      Declare and set all the string names of the PETSc enums
57e5c89e4eSSatish Balay */
5802c9f0b5SLisandro Dalcin const char *const PetscBools[]     = {"FALSE","TRUE","PetscBool","PETSC_",NULL};
5902c9f0b5SLisandro Dalcin const char *const PetscCopyModes[] = {"COPY_VALUES","OWN_POINTER","USE_POINTER","PetscCopyMode","PETSC_",NULL};
60e5c89e4eSSatish Balay 
61ace3abfcSBarry Smith PetscBool PetscPreLoadingUsed = PETSC_FALSE;
62ace3abfcSBarry Smith PetscBool PetscPreLoadingOn   = PETSC_FALSE;
630f8e0872SSatish Balay 
64a2f94806SJed Brown PetscInt PetscHotRegionDepth;
65a2f94806SJed Brown 
666edef35eSSatish Balay PetscBool PETSC_RUNNING_ON_VALGRIND = PETSC_FALSE;
676edef35eSSatish Balay 
68b22622e2STadeu Manoel #if defined(PETSC_HAVE_THREADSAFETY)
69b22622e2STadeu Manoel PetscSpinlock PetscViewerASCIISpinLockOpen;
70b22622e2STadeu Manoel PetscSpinlock PetscViewerASCIISpinLockStdout;
71b22622e2STadeu Manoel PetscSpinlock PetscViewerASCIISpinLockStderr;
72b22622e2STadeu Manoel PetscSpinlock PetscCommSpinLock;
73b22622e2STadeu Manoel #endif
74b22622e2STadeu Manoel 
75e5c89e4eSSatish Balay /*
76945d1669SBarry Smith       PetscInitializeNoPointers - Calls PetscInitialize() from C/C++ without the pointers to argc and args
7772a42c3cSBarry Smith 
7872a42c3cSBarry Smith    Collective
7972a42c3cSBarry Smith 
8072a42c3cSBarry Smith    Level: advanced
8172a42c3cSBarry Smith 
8295452b02SPatrick Sanan     Notes:
83a56f64adSBarry Smith     this is called only by the PETSc Julia interface. Even though it might start MPI it sets the flag to
840f11a792SBarry Smith      indicate that it did NOT start MPI so that the PetscFinalize() does not end MPI, thus allowing PetscInitialize() to
85a56f64adSBarry Smith      be called multiple times from Julia without the problem of trying to initialize MPI more than once.
860f11a792SBarry Smith 
87a56f64adSBarry Smith      Developer Note: Turns off PETSc signal handling to allow Julia to manage signals
881ea5a559SBarry Smith 
8972a42c3cSBarry Smith .seealso: PetscInitialize(), PetscInitializeFortran(), PetscInitializeNoArguments()
900f11a792SBarry Smith */
91945d1669SBarry Smith PetscErrorCode  PetscInitializeNoPointers(int argc,char **args,const char *filename,const char *help)
9272a42c3cSBarry Smith {
9372a42c3cSBarry Smith   int    myargc = argc;
9472a42c3cSBarry Smith   char **myargs = args;
9572a42c3cSBarry Smith 
9672a42c3cSBarry Smith   PetscFunctionBegin;
97*39a651e2SJacob Faibussowitsch   CHKERRQ(PetscInitialize(&myargc,&myargs,filename,help));
985f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscPopSignalHandler());
99df413903SBarry Smith   PetscBeganMPI = PETSC_FALSE;
10027104ee2SJacob Faibussowitsch   PetscFunctionReturn(0);
10172a42c3cSBarry Smith }
10272a42c3cSBarry Smith 
103f0865b08SBarry Smith /*
104a56f64adSBarry Smith       Used by Julia interface to get communicator
105f0865b08SBarry Smith */
106945d1669SBarry Smith PetscErrorCode  PetscGetPETSC_COMM_SELF(MPI_Comm *comm)
107f0865b08SBarry Smith {
108f0865b08SBarry Smith   PetscFunctionBegin;
10927104ee2SJacob Faibussowitsch   if (PetscInitializeCalled) PetscValidPointer(comm,1);
110f0865b08SBarry Smith   *comm = PETSC_COMM_SELF;
111f0865b08SBarry Smith   PetscFunctionReturn(0);
112f0865b08SBarry Smith }
113f0865b08SBarry Smith 
114e5c89e4eSSatish Balay /*@C
115e5c89e4eSSatish Balay       PetscInitializeNoArguments - Calls PetscInitialize() from C/C++ without
116e5c89e4eSSatish Balay         the command line arguments.
117e5c89e4eSSatish Balay 
118e5c89e4eSSatish Balay    Collective
119e5c89e4eSSatish Balay 
120e5c89e4eSSatish Balay    Level: advanced
121e5c89e4eSSatish Balay 
122e5c89e4eSSatish Balay .seealso: PetscInitialize(), PetscInitializeFortran()
123e5c89e4eSSatish Balay @*/
1247087cfbeSBarry Smith PetscErrorCode  PetscInitializeNoArguments(void)
125e5c89e4eSSatish Balay {
126e5c89e4eSSatish Balay   int    argc = 0;
12702c9f0b5SLisandro Dalcin   char **args = NULL;
128e5c89e4eSSatish Balay 
129e5c89e4eSSatish Balay   PetscFunctionBegin;
130*39a651e2SJacob Faibussowitsch   CHKERRQ(PetscInitialize(&argc,&args,NULL,NULL));
131*39a651e2SJacob Faibussowitsch   PetscFunctionReturn(0);
132e5c89e4eSSatish Balay }
133e5c89e4eSSatish Balay 
134e5c89e4eSSatish Balay /*@
135e5c89e4eSSatish Balay       PetscInitialized - Determine whether PETSc is initialized.
136e5c89e4eSSatish Balay 
13793b6d2d1SJed Brown    Level: beginner
138e5c89e4eSSatish Balay 
139e5c89e4eSSatish Balay .seealso: PetscInitialize(), PetscInitializeNoArguments(), PetscInitializeFortran()
140e5c89e4eSSatish Balay @*/
1417087cfbeSBarry Smith PetscErrorCode PetscInitialized(PetscBool *isInitialized)
142e5c89e4eSSatish Balay {
14327104ee2SJacob Faibussowitsch   PetscFunctionBegin;
14427104ee2SJacob Faibussowitsch   if (PetscInitializeCalled) PetscValidBoolPointer(isInitialized,1);
145e5c89e4eSSatish Balay   *isInitialized = PetscInitializeCalled;
14627104ee2SJacob Faibussowitsch   PetscFunctionReturn(0);
147e5c89e4eSSatish Balay }
148e5c89e4eSSatish Balay 
149e5c89e4eSSatish Balay /*@
150e5c89e4eSSatish Balay       PetscFinalized - Determine whether PetscFinalize() has been called yet
151e5c89e4eSSatish Balay 
152e5c89e4eSSatish Balay    Level: developer
153e5c89e4eSSatish Balay 
154e5c89e4eSSatish Balay .seealso: PetscInitialize(), PetscInitializeNoArguments(), PetscInitializeFortran()
155e5c89e4eSSatish Balay @*/
1567087cfbeSBarry Smith PetscErrorCode  PetscFinalized(PetscBool  *isFinalized)
157e5c89e4eSSatish Balay {
15827104ee2SJacob Faibussowitsch   PetscFunctionBegin;
15927104ee2SJacob Faibussowitsch   if (!PetscFinalizeCalled) PetscValidBoolPointer(isFinalized,1);
160e5c89e4eSSatish Balay   *isFinalized = PetscFinalizeCalled;
16127104ee2SJacob Faibussowitsch   PetscFunctionReturn(0);
162e5c89e4eSSatish Balay }
163e5c89e4eSSatish Balay 
16457171095SVaclav Hapla PETSC_INTERN PetscErrorCode PetscOptionsCheckInitial_Private(const char []);
165e5c89e4eSSatish Balay 
166e5c89e4eSSatish Balay /*
167e5c89e4eSSatish Balay        This function is the MPI reduction operation used to compute the sum of the
168e5c89e4eSSatish Balay    first half of the datatype and the max of the second half.
169e5c89e4eSSatish Balay */
170367daffbSBarry Smith MPI_Op MPIU_MAXSUM_OP = 0;
171e5c89e4eSSatish Balay 
172367daffbSBarry Smith PETSC_INTERN void MPIAPI MPIU_MaxSum_Local(void *in,void *out,int *cnt,MPI_Datatype *datatype)
173e5c89e4eSSatish Balay {
174e5c89e4eSSatish Balay   PetscInt *xin = (PetscInt*)in,*xout = (PetscInt*)out,i,count = *cnt;
175e5c89e4eSSatish Balay 
176e5c89e4eSSatish Balay   PetscFunctionBegin;
177e5c89e4eSSatish Balay   if (*datatype != MPIU_2INT) {
178e5c89e4eSSatish Balay     (*PetscErrorPrintf)("Can only handle MPIU_2INT data types");
17941e02c4dSJunchao Zhang     PETSCABORT(MPI_COMM_SELF,PETSC_ERR_ARG_WRONG);
180e5c89e4eSSatish Balay   }
181e5c89e4eSSatish Balay 
182e5c89e4eSSatish Balay   for (i=0; i<count; i++) {
183e5c89e4eSSatish Balay     xout[2*i]    = PetscMax(xout[2*i],xin[2*i]);
184e5c89e4eSSatish Balay     xout[2*i+1] += xin[2*i+1];
185e5c89e4eSSatish Balay   }
186812af9f3SBarry Smith   PetscFunctionReturnVoid();
187e5c89e4eSSatish Balay }
188e5c89e4eSSatish Balay 
189e5c89e4eSSatish Balay /*
190e5c89e4eSSatish Balay     Returns the max of the first entry owned by this processor and the
191e5c89e4eSSatish Balay sum of the second entry.
192b693b147SBarry Smith 
19376f543a4SJed Brown     The reason sizes[2*i] contains lengths sizes[2*i+1] contains flag of 1 if length is nonzero
194367daffbSBarry Smith is so that the MPIU_MAXSUM_OP() can set TWO values, if we passed in only sizes[i] with lengths
195b693b147SBarry Smith there would be no place to store the both needed results.
196e5c89e4eSSatish Balay */
19776ec1555SBarry Smith PetscErrorCode  PetscMaxSum(MPI_Comm comm,const PetscInt sizes[],PetscInt *max,PetscInt *sum)
198e5c89e4eSSatish Balay {
199e5c89e4eSSatish Balay   PetscFunctionBegin;
200d6e4c47cSJed Brown #if defined(PETSC_HAVE_MPI_REDUCE_SCATTER_BLOCK)
201d6e4c47cSJed Brown   {
202d6e4c47cSJed Brown     struct {PetscInt max,sum;} work;
2035f80ce2aSJacob Faibussowitsch     CHKERRMPI(MPI_Reduce_scatter_block((void*)sizes,&work,1,MPIU_2INT,MPIU_MAXSUM_OP,comm));
204d6e4c47cSJed Brown     *max = work.max;
205d6e4c47cSJed Brown     *sum = work.sum;
206d6e4c47cSJed Brown   }
207d6e4c47cSJed Brown #else
208d6e4c47cSJed Brown   {
209d6e4c47cSJed Brown     PetscMPIInt    size,rank;
210d6e4c47cSJed Brown     struct {PetscInt max,sum;} *work;
2115f80ce2aSJacob Faibussowitsch     CHKERRMPI(MPI_Comm_size(comm,&size));
2125f80ce2aSJacob Faibussowitsch     CHKERRMPI(MPI_Comm_rank(comm,&rank));
2135f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscMalloc1(size,&work));
2145f80ce2aSJacob Faibussowitsch     CHKERRMPI(MPIU_Allreduce((void*)sizes,work,size,MPIU_2INT,MPIU_MAXSUM_OP,comm));
2156ac3741eSJed Brown     *max = work[rank].max;
2166ac3741eSJed Brown     *sum = work[rank].sum;
2175f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscFree(work));
218d6e4c47cSJed Brown   }
219d6e4c47cSJed Brown #endif
220e5c89e4eSSatish Balay   PetscFunctionReturn(0);
221e5c89e4eSSatish Balay }
222e5c89e4eSSatish Balay 
223e5c89e4eSSatish Balay /* ----------------------------------------------------------------------------*/
224e5c89e4eSSatish Balay 
225de272c7aSSatish Balay #if defined(PETSC_USE_REAL___FLOAT128) || defined(PETSC_USE_REAL___FP16)
22606a205a8SBarry Smith MPI_Op MPIU_SUM = 0;
227e5c89e4eSSatish Balay 
228092991acSStefano Zampini PETSC_EXTERN void MPIAPI PetscSum_Local(void *in,void *out,PetscMPIInt *cnt,MPI_Datatype *datatype)
229e5c89e4eSSatish Balay {
230e5c89e4eSSatish Balay   PetscInt i,count = *cnt;
231e5c89e4eSSatish Balay 
232e5c89e4eSSatish Balay   PetscFunctionBegin;
2337c2de775SJed Brown   if (*datatype == MPIU_REAL) {
234e2e03761SBarry Smith     PetscReal *xin = (PetscReal*)in,*xout = (PetscReal*)out;
235a297a907SKarl Rupp     for (i=0; i<count; i++) xout[i] += xin[i];
2367c2de775SJed Brown   }
2377c2de775SJed Brown #if defined(PETSC_HAVE_COMPLEX)
238c5481aeeSJose E. Roman   else if (*datatype == MPIU_COMPLEX) {
2397c2de775SJed Brown     PetscComplex *xin = (PetscComplex*)in,*xout = (PetscComplex*)out;
240a297a907SKarl Rupp     for (i=0; i<count; i++) xout[i] += xin[i];
2417c2de775SJed Brown   }
2427c2de775SJed Brown #endif
2437c2de775SJed Brown   else {
2447c2de775SJed Brown     (*PetscErrorPrintf)("Can only handle MPIU_REAL or MPIU_COMPLEX data types");
24541e02c4dSJunchao Zhang     PETSCABORT(MPI_COMM_SELF,PETSC_ERR_ARG_WRONG);
246e2e03761SBarry Smith   }
247812af9f3SBarry Smith   PetscFunctionReturnVoid();
248e5c89e4eSSatish Balay }
249e5c89e4eSSatish Balay #endif
250e5c89e4eSSatish Balay 
251570b7f6dSBarry Smith #if defined(PETSC_USE_REAL___FLOAT128) || defined(PETSC_USE_REAL___FP16)
252d9822059SBarry Smith MPI_Op MPIU_MAX = 0;
253d9822059SBarry Smith MPI_Op MPIU_MIN = 0;
254d9822059SBarry Smith 
255092991acSStefano Zampini PETSC_EXTERN void MPIAPI PetscMax_Local(void *in,void *out,PetscMPIInt *cnt,MPI_Datatype *datatype)
256d9822059SBarry Smith {
257d9822059SBarry Smith   PetscInt i,count = *cnt;
258d9822059SBarry Smith 
259d9822059SBarry Smith   PetscFunctionBegin;
2607c2de775SJed Brown   if (*datatype == MPIU_REAL) {
2618c764dc5SJose Roman     PetscReal *xin = (PetscReal*)in,*xout = (PetscReal*)out;
262a297a907SKarl Rupp     for (i=0; i<count; i++) xout[i] = PetscMax(xout[i],xin[i]);
2637c2de775SJed Brown   }
2647c2de775SJed Brown #if defined(PETSC_HAVE_COMPLEX)
2657c2de775SJed Brown   else if (*datatype == MPIU_COMPLEX) {
2667c2de775SJed Brown     PetscComplex *xin = (PetscComplex*)in,*xout = (PetscComplex*)out;
2677c2de775SJed Brown     for (i=0; i<count; i++) {
2687c2de775SJed Brown       xout[i] = PetscRealPartComplex(xout[i])<PetscRealPartComplex(xin[i]) ? xin[i] : xout[i];
2697c2de775SJed Brown     }
2707c2de775SJed Brown   }
2717c2de775SJed Brown #endif
2727c2de775SJed Brown   else {
2737c2de775SJed Brown     (*PetscErrorPrintf)("Can only handle MPIU_REAL or MPIU_COMPLEX data types");
27441e02c4dSJunchao Zhang     PETSCABORT(MPI_COMM_SELF,PETSC_ERR_ARG_WRONG);
2758c764dc5SJose Roman   }
276d9822059SBarry Smith   PetscFunctionReturnVoid();
277d9822059SBarry Smith }
278d9822059SBarry Smith 
279092991acSStefano Zampini PETSC_EXTERN void MPIAPI PetscMin_Local(void *in,void *out,PetscMPIInt *cnt,MPI_Datatype *datatype)
280d9822059SBarry Smith {
281d9822059SBarry Smith   PetscInt    i,count = *cnt;
282d9822059SBarry Smith 
283d9822059SBarry Smith   PetscFunctionBegin;
2847c2de775SJed Brown   if (*datatype == MPIU_REAL) {
2858c764dc5SJose Roman     PetscReal *xin = (PetscReal*)in,*xout = (PetscReal*)out;
286a297a907SKarl Rupp     for (i=0; i<count; i++) xout[i] = PetscMin(xout[i],xin[i]);
2877c2de775SJed Brown   }
2887c2de775SJed Brown #if defined(PETSC_HAVE_COMPLEX)
2897c2de775SJed Brown   else if (*datatype == MPIU_COMPLEX) {
2907c2de775SJed Brown     PetscComplex *xin = (PetscComplex*)in,*xout = (PetscComplex*)out;
2917c2de775SJed Brown     for (i=0; i<count; i++) {
2927c2de775SJed Brown       xout[i] = PetscRealPartComplex(xout[i])>PetscRealPartComplex(xin[i]) ? xin[i] : xout[i];
2937c2de775SJed Brown     }
2947c2de775SJed Brown   }
2957c2de775SJed Brown #endif
2967c2de775SJed Brown   else {
2978c764dc5SJose Roman     (*PetscErrorPrintf)("Can only handle MPIU_REAL or MPIU_SCALAR data (i.e. double or complex) types");
29841e02c4dSJunchao Zhang     PETSCABORT(MPI_COMM_SELF,PETSC_ERR_ARG_WRONG);
2998c764dc5SJose Roman   }
300d9822059SBarry Smith   PetscFunctionReturnVoid();
301d9822059SBarry Smith }
302d9822059SBarry Smith #endif
303d9822059SBarry Smith 
304480cf27aSJed Brown /*
305480cf27aSJed Brown    Private routine to delete internal tag/name counter storage when a communicator is freed.
306480cf27aSJed Brown 
307ff0e51ddSBarry 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.
308480cf27aSJed Brown 
30912801b39SBarry Smith    Note: this is declared extern "C" because it is passed to MPI_Comm_create_keyval()
310480cf27aSJed Brown 
311480cf27aSJed Brown */
31233779a13SJunchao Zhang PETSC_EXTERN PetscMPIInt MPIAPI Petsc_Counter_Attr_Delete_Fn(MPI_Comm comm,PetscMPIInt keyval,void *count_val,void *extra_state)
313480cf27aSJed Brown {
31405342407SJunchao Zhang   PetscCommCounter      *counter=(PetscCommCounter*)count_val;
31557f21012SBarry Smith   struct PetscCommStash *comms = counter->comms, *pcomm;
316480cf27aSJed Brown 
317480cf27aSJed Brown   PetscFunctionBegin;
3185f80ce2aSJacob Faibussowitsch   CHKERRMPI(PetscInfo(NULL,"Deleting counter data in an MPI_Comm %ld\n",(long)comm));
3195f80ce2aSJacob Faibussowitsch   CHKERRMPI(PetscFree(counter->iflags));
32057f21012SBarry Smith   while (comms) {
3215f80ce2aSJacob Faibussowitsch     CHKERRMPI(MPI_Comm_free(&comms->comm));
32257f21012SBarry Smith     pcomm = comms;
32357f21012SBarry Smith     comms = comms->next;
3245f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscFree(pcomm));
32557f21012SBarry Smith   }
3265f80ce2aSJacob Faibussowitsch   CHKERRMPI(PetscFree(counter));
327480cf27aSJed Brown   PetscFunctionReturn(MPI_SUCCESS);
328480cf27aSJed Brown }
329480cf27aSJed Brown 
330480cf27aSJed Brown /*
33147435625SJed Brown   This is invoked on the outer comm as a result of either PetscCommDestroy() (via MPI_Comm_delete_attr) or when the user
332da3039f7SJed Brown   calls MPI_Comm_free().
333da3039f7SJed Brown 
334da3039f7SJed Brown   This is the only entry point for breaking the links between inner and outer comms.
335480cf27aSJed Brown 
336ff0e51ddSBarry Smith   This is called by MPI, not by users. This is called when MPI_Comm_free() is called on the communicator.
337480cf27aSJed Brown 
33812801b39SBarry Smith   Note: this is declared extern "C" because it is passed to MPI_Comm_create_keyval()
339480cf27aSJed Brown 
340480cf27aSJed Brown */
34133779a13SJunchao Zhang PETSC_EXTERN PetscMPIInt MPIAPI Petsc_InnerComm_Attr_Delete_Fn(MPI_Comm comm,PetscMPIInt keyval,void *attr_val,void *extra_state)
342480cf27aSJed Brown {
34333779a13SJunchao Zhang   union {MPI_Comm comm; void *ptr;} icomm;
344480cf27aSJed Brown 
345480cf27aSJed Brown   PetscFunctionBegin;
34612801b39SBarry Smith   if (keyval != Petsc_InnerComm_keyval) SETERRMPI(PETSC_COMM_SELF,PETSC_ERR_ARG_CORRUPT,"Unexpected keyval");
347ec4fadc2SJed Brown   icomm.ptr = attr_val;
34876bd3646SJed Brown   if (PetscDefined(USE_DEBUG)) {
34933779a13SJunchao Zhang     /* Error out if the inner/outer comms are not correctly linked through their Outer/InnterComm attributes */
35033779a13SJunchao Zhang     PetscMPIInt flg;
35133779a13SJunchao Zhang     union {MPI_Comm comm; void *ptr;} ocomm;
3525f80ce2aSJacob Faibussowitsch     CHKERRMPI(MPI_Comm_get_attr(icomm.comm,Petsc_OuterComm_keyval,&ocomm,&flg));
35333779a13SJunchao Zhang     if (!flg) SETERRMPI(PETSC_COMM_SELF,PETSC_ERR_ARG_CORRUPT,"Inner comm does not have OuterComm attribute");
35433779a13SJunchao Zhang     if (ocomm.comm != comm) SETERRMPI(PETSC_COMM_SELF,PETSC_ERR_ARG_CORRUPT,"Inner comm's OuterComm attribute does not point to outer PETSc comm");
35533779a13SJunchao Zhang   }
3565f80ce2aSJacob Faibussowitsch   CHKERRMPI(MPI_Comm_delete_attr(icomm.comm,Petsc_OuterComm_keyval));
3575f80ce2aSJacob Faibussowitsch   CHKERRMPI(PetscInfo(NULL,"User MPI_Comm %ld is being unlinked from inner PETSc comm %ld\n",(long)comm,(long)icomm.comm));
358da3039f7SJed Brown   PetscFunctionReturn(MPI_SUCCESS);
359b89831e5SBarry Smith }
360da3039f7SJed Brown 
361da3039f7SJed Brown /*
36233779a13SJunchao Zhang  * This is invoked on the inner comm when Petsc_InnerComm_Attr_Delete_Fn calls MPI_Comm_delete_attr().  It should not be reached any other way.
363da3039f7SJed Brown  */
36433779a13SJunchao Zhang PETSC_EXTERN PetscMPIInt MPIAPI Petsc_OuterComm_Attr_Delete_Fn(MPI_Comm comm,PetscMPIInt keyval,void *attr_val,void *extra_state)
365da3039f7SJed Brown {
366da3039f7SJed Brown   PetscFunctionBegin;
3675f80ce2aSJacob Faibussowitsch   CHKERRMPI(PetscInfo(NULL,"Removing reference to PETSc communicator embedded in a user MPI_Comm %ld\n",(long)comm));
368480cf27aSJed Brown   PetscFunctionReturn(MPI_SUCCESS);
369480cf27aSJed Brown }
370480cf27aSJed Brown 
37133779a13SJunchao Zhang PETSC_EXTERN PetscMPIInt MPIAPI Petsc_ShmComm_Attr_Delete_Fn(MPI_Comm,PetscMPIInt,void *,void *);
37242218b76SBarry Smith 
373951e3c8eSBarry Smith #if defined(PETSC_USE_PETSC_MPI_EXTERNAL32)
3748cc058d9SJed Brown PETSC_EXTERN PetscMPIInt PetscDataRep_extent_fn(MPI_Datatype,MPI_Aint*,void*);
3758cc058d9SJed Brown PETSC_EXTERN PetscMPIInt PetscDataRep_read_conv_fn(void*, MPI_Datatype,PetscMPIInt,void*,MPI_Offset,void*);
3768cc058d9SJed Brown PETSC_EXTERN PetscMPIInt PetscDataRep_write_conv_fn(void*, MPI_Datatype,PetscMPIInt,void*,MPI_Offset,void*);
377e39fd77fSBarry Smith #endif
378e39fd77fSBarry Smith 
3790f9be574SPeter Hill PetscMPIInt PETSC_MPI_ERROR_CLASS=MPI_ERR_LASTCODE,PETSC_MPI_ERROR_CODE;
38012801b39SBarry Smith 
381eb27c7c8SSatish Balay PETSC_INTERN int  PetscGlobalArgc;
382eb27c7c8SSatish Balay PETSC_INTERN char **PetscGlobalArgs;
3836ae9a8a6SBarry Smith int  PetscGlobalArgc   = 0;
38402c9f0b5SLisandro Dalcin char **PetscGlobalArgs = NULL;
385dff31646SBarry Smith PetscSegBuffer PetscCitationsList;
386e5c89e4eSSatish Balay 
387dd63322aSSatish Balay PetscErrorCode PetscCitationsInitialize(void)
388051e4cf2SJed Brown {
389051e4cf2SJed Brown   PetscFunctionBegin;
3905f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscSegBufferCreate(1,10000,&PetscCitationsList));
3915f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscCitationsRegister("@TechReport{petsc-user-ref,\n  Author = {Satish Balay and Shrirang Abhyankar and Mark F. Adams and Jed Brown \n            and Peter Brune and Kris Buschelman and Lisandro Dalcin and\n            Victor Eijkhout and William D. Gropp and Dmitry Karpeyev and\n            Dinesh Kaushik and Matthew G. Knepley and Dave A. May and Lois Curfman McInnes\n            and Richard Tran Mills and Todd Munson and Karl Rupp and Patrick Sanan\n            and Barry F. Smith and Stefano Zampini and Hong Zhang and Hong Zhang},\n  Title = {{PETS}c Users Manual},\n  Number = {ANL-95/11 - Revision 3.11},\n  Institution = {Argonne National Laboratory},\n  Year = {2019}\n}\n",NULL));
3925f80ce2aSJacob Faibussowitsch   CHKERRQ(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));
393051e4cf2SJed Brown   PetscFunctionReturn(0);
394051e4cf2SJed Brown }
395e5c89e4eSSatish Balay 
3962d747510SLisandro Dalcin static char programname[PETSC_MAX_PATH_LEN] = ""; /* HP includes entire path in name */
3972d747510SLisandro Dalcin 
3982d747510SLisandro Dalcin PetscErrorCode  PetscSetProgramName(const char name[])
3992d747510SLisandro Dalcin {
4002d747510SLisandro Dalcin   PetscFunctionBegin;
4015f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscStrncpy(programname,name,sizeof(programname)));
4022d747510SLisandro Dalcin   PetscFunctionReturn(0);
4032d747510SLisandro Dalcin }
4042d747510SLisandro Dalcin 
4052d747510SLisandro Dalcin /*@C
4062d747510SLisandro Dalcin     PetscGetProgramName - Gets the name of the running program.
4072d747510SLisandro Dalcin 
4082d747510SLisandro Dalcin     Not Collective
4092d747510SLisandro Dalcin 
4102d747510SLisandro Dalcin     Input Parameter:
4112d747510SLisandro Dalcin .   len - length of the string name
4122d747510SLisandro Dalcin 
4132d747510SLisandro Dalcin     Output Parameter:
4142d747510SLisandro Dalcin .   name - the name of the running program
4152d747510SLisandro Dalcin 
4162d747510SLisandro Dalcin    Level: advanced
4172d747510SLisandro Dalcin 
4182d747510SLisandro Dalcin     Notes:
4192d747510SLisandro Dalcin     The name of the program is copied into the user-provided character
4202d747510SLisandro Dalcin     array of length len.  On some machines the program name includes
4212d747510SLisandro Dalcin     its entire path, so one should generally set len >= PETSC_MAX_PATH_LEN.
4222d747510SLisandro Dalcin @*/
4232d747510SLisandro Dalcin PetscErrorCode  PetscGetProgramName(char name[],size_t len)
4242d747510SLisandro Dalcin {
4252d747510SLisandro Dalcin   PetscFunctionBegin;
4265f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscStrncpy(name,programname,len));
4272d747510SLisandro Dalcin   PetscFunctionReturn(0);
4282d747510SLisandro Dalcin }
4292d747510SLisandro Dalcin 
430e5c89e4eSSatish Balay /*@C
431e5c89e4eSSatish Balay    PetscGetArgs - Allows you to access the raw command line arguments anywhere
432e5c89e4eSSatish Balay      after PetscInitialize() is called but before PetscFinalize().
433e5c89e4eSSatish Balay 
434e5c89e4eSSatish Balay    Not Collective
435e5c89e4eSSatish Balay 
436e5c89e4eSSatish Balay    Output Parameters:
437e5c89e4eSSatish Balay +  argc - count of number of command line arguments
438e5c89e4eSSatish Balay -  args - the command line arguments
439e5c89e4eSSatish Balay 
440e5c89e4eSSatish Balay    Level: intermediate
441e5c89e4eSSatish Balay 
442e5c89e4eSSatish Balay    Notes:
443e5c89e4eSSatish Balay       This is usually used to pass the command line arguments into other libraries
444e5c89e4eSSatish Balay    that are called internally deep in PETSc or the application.
445e5c89e4eSSatish Balay 
446f177e3b1SBarry Smith       The first argument contains the program name as is normal for C arguments.
447f177e3b1SBarry Smith 
448793721a6SBarry Smith .seealso: PetscFinalize(), PetscInitializeFortran(), PetscGetArguments()
449e5c89e4eSSatish Balay 
450e5c89e4eSSatish Balay @*/
4517087cfbeSBarry Smith PetscErrorCode  PetscGetArgs(int *argc,char ***args)
452e5c89e4eSSatish Balay {
453e5c89e4eSSatish Balay   PetscFunctionBegin;
454*39a651e2SJacob Faibussowitsch   PetscCheck(PetscInitializeCalled || !PetscFinalizeCalled,PETSC_COMM_SELF,PETSC_ERR_ORDER,"You must call after PetscInitialize() but before PetscFinalize()");
455e5c89e4eSSatish Balay   *argc = PetscGlobalArgc;
456e5c89e4eSSatish Balay   *args = PetscGlobalArgs;
457e5c89e4eSSatish Balay   PetscFunctionReturn(0);
458e5c89e4eSSatish Balay }
459e5c89e4eSSatish Balay 
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 .seealso: PetscFinalize(), PetscInitializeFortran(), PetscGetArgs(), PetscFreeArguments()
475793721a6SBarry Smith 
476793721a6SBarry Smith @*/
4777087cfbeSBarry Smith PetscErrorCode  PetscGetArguments(char ***args)
478793721a6SBarry Smith {
479793721a6SBarry Smith   PetscInt i,argc = PetscGlobalArgc;
480793721a6SBarry Smith 
481793721a6SBarry Smith   PetscFunctionBegin;
482*39a651e2SJacob Faibussowitsch   PetscCheck(PetscInitializeCalled || !PetscFinalizeCalled,PETSC_COMM_SELF,PETSC_ERR_ORDER,"You must call after PetscInitialize() but before PetscFinalize()");
4832d747510SLisandro Dalcin   if (!argc) {*args = NULL; PetscFunctionReturn(0);}
4845f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscMalloc1(argc,args));
485*39a651e2SJacob Faibussowitsch   for (i=0; i<argc-1; i++) CHKERRQ(PetscStrallocpy(PetscGlobalArgs[i+1],&(*args)[i]));
4862d747510SLisandro Dalcin   (*args)[argc-1] = NULL;
487793721a6SBarry Smith   PetscFunctionReturn(0);
488793721a6SBarry Smith }
489793721a6SBarry Smith 
490793721a6SBarry Smith /*@C
491793721a6SBarry Smith    PetscFreeArguments - Frees the memory obtained with PetscGetArguments()
492793721a6SBarry Smith 
493793721a6SBarry Smith    Not Collective
494793721a6SBarry Smith 
495793721a6SBarry Smith    Output Parameters:
496793721a6SBarry Smith .  args - the command line arguments
497793721a6SBarry Smith 
498793721a6SBarry Smith    Level: intermediate
499793721a6SBarry Smith 
500793721a6SBarry Smith .seealso: PetscFinalize(), PetscInitializeFortran(), PetscGetArgs(), PetscGetArguments()
501793721a6SBarry Smith 
502793721a6SBarry Smith @*/
5037087cfbeSBarry Smith PetscErrorCode  PetscFreeArguments(char **args)
504793721a6SBarry Smith {
505*39a651e2SJacob Faibussowitsch   PetscFunctionBegin;
506*39a651e2SJacob Faibussowitsch   if (args) {
507793721a6SBarry Smith     PetscInt i = 0;
508793721a6SBarry Smith 
509*39a651e2SJacob Faibussowitsch     while (args[i]) CHKERRQ(PetscFree(args[i++]));
5105f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscFree(args));
511*39a651e2SJacob Faibussowitsch   }
512793721a6SBarry Smith   PetscFunctionReturn(0);
513793721a6SBarry Smith }
514793721a6SBarry Smith 
51527104ee2SJacob Faibussowitsch #if PetscDefined(HAVE_SAWS)
51630befbd2SBarry Smith #include <petscconfiginfo.h>
51730befbd2SBarry Smith 
51895c0884eSLisandro Dalcin PETSC_INTERN PetscErrorCode PetscInitializeSAWs(const char help[])
51911525c0dSBarry Smith {
52027104ee2SJacob Faibussowitsch   PetscFunctionBegin;
52111525c0dSBarry Smith   if (!PetscGlobalRank) {
52230befbd2SBarry Smith     char      cert[PETSC_MAX_PATH_LEN],root[PETSC_MAX_PATH_LEN],*intro,programname[64],*appline,*options,version[64];
52311525c0dSBarry Smith     int       port;
524ffbd1cfbSBarry Smith     PetscBool flg,rootlocal = PETSC_FALSE,flg2,selectport = PETSC_FALSE;
52511525c0dSBarry Smith     size_t    applinelen,introlen;
526ffbd1cfbSBarry Smith     char      sawsurl[256];
52711525c0dSBarry Smith 
5285f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscOptionsHasName(NULL,NULL,"-saws_log",&flg));
52911525c0dSBarry Smith     if (flg) {
53011525c0dSBarry Smith       char  sawslog[PETSC_MAX_PATH_LEN];
53111525c0dSBarry Smith 
5325f80ce2aSJacob Faibussowitsch       CHKERRQ(PetscOptionsGetString(NULL,NULL,"-saws_log",sawslog,sizeof(sawslog),NULL));
53311525c0dSBarry Smith       if (sawslog[0]) {
53411525c0dSBarry Smith         PetscStackCallSAWs(SAWs_Set_Use_Logfile,(sawslog));
53511525c0dSBarry Smith       } else {
53611525c0dSBarry Smith         PetscStackCallSAWs(SAWs_Set_Use_Logfile,(NULL));
53711525c0dSBarry Smith       }
53811525c0dSBarry Smith     }
5395f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscOptionsGetString(NULL,NULL,"-saws_https",cert,sizeof(cert),&flg));
54011525c0dSBarry Smith     if (flg) {
54111525c0dSBarry Smith       PetscStackCallSAWs(SAWs_Set_Use_HTTPS,(cert));
54211525c0dSBarry Smith     }
5435f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscOptionsGetBool(NULL,NULL,"-saws_port_auto_select",&selectport,NULL));
544ffbd1cfbSBarry Smith     if (selectport) {
545ffbd1cfbSBarry Smith         PetscStackCallSAWs(SAWs_Get_Available_Port,(&port));
546ffbd1cfbSBarry Smith         PetscStackCallSAWs(SAWs_Set_Port,(port));
547ffbd1cfbSBarry Smith     } else {
5485f80ce2aSJacob Faibussowitsch       CHKERRQ(PetscOptionsGetInt(NULL,NULL,"-saws_port",&port,&flg));
54911525c0dSBarry Smith       if (flg) {
55011525c0dSBarry Smith         PetscStackCallSAWs(SAWs_Set_Port,(port));
55111525c0dSBarry Smith       }
552ffbd1cfbSBarry Smith     }
5535f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscOptionsGetString(NULL,NULL,"-saws_root",root,sizeof(root),&flg));
55411525c0dSBarry Smith     if (flg) {
5552f613bf5SBarry Smith       PetscStackCallSAWs(SAWs_Set_Document_Root,(root));
5565f80ce2aSJacob Faibussowitsch       CHKERRQ(PetscStrcmp(root,".",&rootlocal));
5579c1e0ce8SBarry Smith     } else {
5585f80ce2aSJacob Faibussowitsch       CHKERRQ(PetscOptionsHasName(NULL,NULL,"-saws_options",&flg));
5599c1e0ce8SBarry Smith       if (flg) {
5605f80ce2aSJacob Faibussowitsch         CHKERRQ(PetscStrreplace(PETSC_COMM_WORLD,"${PETSC_DIR}/share/petsc/saws",root,sizeof(root)));
5612f613bf5SBarry Smith         PetscStackCallSAWs(SAWs_Set_Document_Root,(root));
5629c1e0ce8SBarry Smith       }
56311525c0dSBarry Smith     }
5645f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscOptionsHasName(NULL,NULL,"-saws_local",&flg2));
56511525c0dSBarry Smith     if (flg2) {
56611525c0dSBarry Smith       char jsdir[PETSC_MAX_PATH_LEN];
56728b400f6SJacob Faibussowitsch       PetscCheck(flg,PETSC_COMM_SELF,PETSC_ERR_SUP,"-saws_local option requires -saws_root option");
5685f80ce2aSJacob Faibussowitsch       CHKERRQ(PetscSNPrintf(jsdir,sizeof(jsdir),"%s/js",root));
5695f80ce2aSJacob Faibussowitsch       CHKERRQ(PetscTestDirectory(jsdir,'r',&flg));
57028b400f6SJacob Faibussowitsch       PetscCheck(flg,PETSC_COMM_SELF,PETSC_ERR_FILE_READ,"-saws_local option requires js directory in root directory");
5712f613bf5SBarry Smith       PetscStackCallSAWs(SAWs_Push_Local_Header,());
57211525c0dSBarry Smith     }
5735f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscGetProgramName(programname,sizeof(programname)));
5745f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscStrlen(help,&applinelen));
57511525c0dSBarry Smith     introlen   = 4096 + applinelen;
57630a8c9c0SSurtai Han     applinelen += 1024;
5775f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscMalloc(applinelen,&appline));
5785f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscMalloc(introlen,&intro));
57911525c0dSBarry Smith 
58011525c0dSBarry Smith     if (rootlocal) {
5815f80ce2aSJacob Faibussowitsch       CHKERRQ(PetscSNPrintf(appline,applinelen,"%s.c.html",programname));
5825f80ce2aSJacob Faibussowitsch       CHKERRQ(PetscTestFile(appline,'r',&rootlocal));
58311525c0dSBarry Smith     }
5845f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscOptionsGetAll(NULL,&options));
58511525c0dSBarry Smith     if (rootlocal && help) {
5865f80ce2aSJacob Faibussowitsch       CHKERRQ(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));
58711525c0dSBarry Smith     } else if (help) {
5885f80ce2aSJacob Faibussowitsch       CHKERRQ(PetscSNPrintf(appline,applinelen,"<center>Running %s %s</center><br><center><pre>%s</pre></center><br>",programname,options,help));
58911525c0dSBarry Smith     } else {
5905f80ce2aSJacob Faibussowitsch       CHKERRQ(PetscSNPrintf(appline,applinelen,"<center> Running %s %s</center><br>\n",programname,options));
59111525c0dSBarry Smith     }
5925f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscFree(options));
5935f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscGetVersion(version,sizeof(version)));
5945f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscSNPrintf(intro,introlen,"<body>\n"
595a17b96a8SKyle Gerard Felker                           "<center><h2> <a href=\"https://petsc.org/\">PETSc</a> Application Web server powered by <a href=\"https://bitbucket.org/saws/saws\">SAWs</a> </h2></center>\n"
596df62c222SBarry 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"
5975f80ce2aSJacob Faibussowitsch                           "%s",version,petscconfigureoptions,appline));
59843da4ab2SBarry Smith     PetscStackCallSAWs(SAWs_Push_Body,("index.html",0,intro));
5995f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscFree(intro));
6005f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscFree(appline));
601ffbd1cfbSBarry Smith     if (selectport) {
602aa573868SBarry Smith       PetscBool silent;
6037d812c46SBarry Smith 
6047d812c46SBarry Smith       /* another process may have grabbed the port so keep trying */
605*39a651e2SJacob Faibussowitsch       while (SAWs_Initialize()) {
6067d812c46SBarry Smith         PetscStackCallSAWs(SAWs_Get_Available_Port,(&port));
6077d812c46SBarry Smith         PetscStackCallSAWs(SAWs_Set_Port,(port));
6087d812c46SBarry Smith       }
6097d812c46SBarry Smith 
6105f80ce2aSJacob Faibussowitsch       CHKERRQ(PetscOptionsGetBool(NULL,NULL,"-saws_port_auto_select_silent",&silent,NULL));
611aa573868SBarry Smith       if (!silent) {
612ffbd1cfbSBarry Smith         PetscStackCallSAWs(SAWs_Get_FullURL,(sizeof(sawsurl),sawsurl));
6135f80ce2aSJacob Faibussowitsch         CHKERRQ(PetscPrintf(PETSC_COMM_WORLD,"Point your browser to %s for SAWs\n",sawsurl));
614ffbd1cfbSBarry Smith       }
6157d812c46SBarry Smith     } else {
6167d812c46SBarry Smith       PetscStackCallSAWs(SAWs_Initialize,());
617aa573868SBarry Smith     }
6185f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscCitationsRegister("@TechReport{ saws,\n"
6190af79b04SBarry Smith                                    "  Author = {Matt Otten and Jed Brown and Barry Smith},\n"
6200af79b04SBarry Smith                                    "  Title  = {Scientific Application Web Server (SAWs) Users Manual},\n"
6210af79b04SBarry Smith                                    "  Institution = {Argonne National Laboratory},\n"
6225f80ce2aSJacob Faibussowitsch                                    "  Year   = 2013\n}\n",NULL));
62311525c0dSBarry Smith   }
62411525c0dSBarry Smith   PetscFunctionReturn(0);
62511525c0dSBarry Smith }
62611525c0dSBarry Smith #endif
62711525c0dSBarry Smith 
6284dfee713SSatish Balay /* Things must be done before MPI_Init() when MPI is not yet initialized, and can be shared between C init and Fortran init */
6294dfee713SSatish Balay PETSC_INTERN PetscErrorCode PetscPreMPIInit_Private(void)
6304dfee713SSatish Balay {
6314dfee713SSatish Balay   PetscFunctionBegin;
6324dfee713SSatish Balay #if defined(PETSC_HAVE_HWLOC_SOLARIS_BUG)
6334dfee713SSatish Balay   /* see MPI.py for details on this bug */
6344dfee713SSatish Balay   (void) setenv("HWLOC_COMPONENTS","-x86",1);
6354dfee713SSatish Balay #endif
6364dfee713SSatish Balay   PetscFunctionReturn(0);
6374dfee713SSatish Balay }
6384dfee713SSatish Balay 
639a4af0ceeSJacob Faibussowitsch #if PetscDefined(HAVE_ADIOS)
640a56f64adSBarry Smith #include <adios.h>
64122580e64SBarry Smith #include <adios_read.h>
6427b56e58cSSatish Balay int64_t Petsc_adios_group;
643a56f64adSBarry Smith #endif
644a4af0ceeSJacob Faibussowitsch #if PetscDefined(HAVE_OPENMP)
645cd1b99a6SBarry Smith #include <omp.h>
646f90b075cSBarry Smith PetscInt PetscNumOMPThreads;
647cd1b99a6SBarry Smith #endif
648a56f64adSBarry Smith 
649a4af0ceeSJacob Faibussowitsch #if PetscDefined(HAVE_DEVICE)
650a4af0ceeSJacob Faibussowitsch #include <petsc/private/deviceimpl.h>
651a4af0ceeSJacob Faibussowitsch #  if PetscDefined(HAVE_CUDA)
652a4af0ceeSJacob Faibussowitsch // REMOVE ME
653a4af0ceeSJacob Faibussowitsch cudaStream_t PetscDefaultCudaStream = NULL;
654a4af0ceeSJacob Faibussowitsch #  endif
655a4af0ceeSJacob Faibussowitsch #  if PetscDefined(HAVE_HIP)
656a4af0ceeSJacob Faibussowitsch // REMOVE ME
657a4af0ceeSJacob Faibussowitsch hipStream_t PetscDefaultHipStream = NULL;
658a4af0ceeSJacob Faibussowitsch #  endif
659a4af0ceeSJacob Faibussowitsch #endif
660a4af0ceeSJacob Faibussowitsch 
66127104ee2SJacob Faibussowitsch #if PetscDefined(HAVE_DLFCN_H)
662bc8a24ecSBarry Smith #include <dlfcn.h>
663bc8a24ecSBarry Smith #endif
664a4af0ceeSJacob Faibussowitsch #if PetscDefined(USE_LOG)
665a4af0ceeSJacob Faibussowitsch PETSC_INTERN PetscErrorCode PetscLogInitialize(void);
666a4af0ceeSJacob Faibussowitsch #endif
667a4af0ceeSJacob Faibussowitsch #if PetscDefined(HAVE_VIENNACL)
668a4af0ceeSJacob Faibussowitsch PETSC_EXTERN PetscErrorCode PetscViennaCLInit();
669a4af0ceeSJacob Faibussowitsch PetscBool PetscViennaCLSynchronize = PETSC_FALSE;
670a4af0ceeSJacob Faibussowitsch #endif
671bc8a24ecSBarry Smith 
67285649d77SJunchao Zhang /*
67385649d77SJunchao Zhang   PetscInitialize_Common  - shared code between C and Fortran initialization
67485649d77SJunchao Zhang 
67585649d77SJunchao Zhang   prog:     program name
67602101c96SSatish Balay   file:     optional PETSc database file name. Might be in Fortran string format when 'ftn' is true
67785649d77SJunchao Zhang   help:     program help message
67802101c96SSatish Balay   ftn:      is it called from Fortran initilization (petscinitializef_)?
67985649d77SJunchao Zhang   readarguments,len: used when fortran is true
68085649d77SJunchao Zhang */
68102101c96SSatish Balay PETSC_INTERN PetscErrorCode PetscInitialize_Common(const char* prog,const char* file,const char *help,PetscBool ftn,PetscBool readarguments,PetscInt len)
68285649d77SJunchao Zhang {
68385649d77SJunchao Zhang   PetscMPIInt size;
68485649d77SJunchao Zhang   PetscBool   flg = PETSC_TRUE;
68585649d77SJunchao Zhang   char        hostname[256];
68685649d77SJunchao Zhang 
68727104ee2SJacob Faibussowitsch   PetscFunctionBegin;
68827104ee2SJacob Faibussowitsch   if (PetscInitializeCalled) PetscFunctionReturn(0);
689*39a651e2SJacob Faibussowitsch   /* these must be initialized in a routine, not as a constant declaration */
690*39a651e2SJacob Faibussowitsch   PETSC_STDOUT = stdout;
691*39a651e2SJacob Faibussowitsch   PETSC_STDERR = stderr;
692*39a651e2SJacob Faibussowitsch 
693*39a651e2SJacob Faibussowitsch   /* CHKERRQ can be used from now */
694*39a651e2SJacob Faibussowitsch   PetscErrorHandlingInitialized = PETSC_TRUE;
695*39a651e2SJacob Faibussowitsch 
69685649d77SJunchao Zhang   /*
69785649d77SJunchao Zhang       The checking over compatible runtime libraries is complicated by the MPI ABI initiative
69885649d77SJunchao Zhang       https://wiki.mpich.org/mpich/index.php/ABI_Compatibility_Initiative which started with
69985649d77SJunchao Zhang         MPICH v3.1 (Released February 2014)
70085649d77SJunchao Zhang         IBM MPI v2.1 (December 2014)
70185649d77SJunchao Zhang         Intel MPI Library v5.0 (2014)
70285649d77SJunchao Zhang         Cray MPT v7.0.0 (June 2014)
70385649d77SJunchao Zhang       As of July 31, 2017 the ABI number still appears to be 12, that is all of the versions
70485649d77SJunchao Zhang       listed above and since that time are compatible.
70585649d77SJunchao Zhang 
70685649d77SJunchao Zhang       Unfortunately the MPI ABI initiative has not defined a way to determine the ABI number
70785649d77SJunchao Zhang       at compile time or runtime. Thus we will need to systematically track the allowed versions
70885649d77SJunchao Zhang       and how they are represented in the mpi.h and MPI_Get_library_version() output in order
70985649d77SJunchao Zhang       to perform the checking.
71085649d77SJunchao Zhang 
71185649d77SJunchao Zhang       Currently we only check for pre MPI ABI versions (and packages that do not follow the MPI ABI).
71285649d77SJunchao Zhang 
71385649d77SJunchao Zhang       Questions:
71485649d77SJunchao Zhang 
71585649d77SJunchao Zhang         Should the checks for ABI incompatibility be only on the major version number below?
71685649d77SJunchao Zhang         Presumably the output to stderr will be removed before a release.
71785649d77SJunchao Zhang   */
71885649d77SJunchao Zhang 
71985649d77SJunchao Zhang #if defined(PETSC_HAVE_MPI_GET_LIBRARY_VERSION)
72085649d77SJunchao Zhang   {
72185649d77SJunchao Zhang     char        mpilibraryversion[MPI_MAX_LIBRARY_VERSION_STRING];
72285649d77SJunchao Zhang     PetscMPIInt mpilibraryversionlength;
723*39a651e2SJacob Faibussowitsch 
724*39a651e2SJacob Faibussowitsch     CHKERRMPI(MPI_Get_library_version(mpilibraryversion,&mpilibraryversionlength));
72585649d77SJunchao Zhang     /* check for MPICH versions before MPI ABI initiative */
72685649d77SJunchao Zhang #if defined(MPICH_VERSION)
72785649d77SJunchao Zhang #if MPICH_NUMVERSION < 30100000
72885649d77SJunchao Zhang     {
72985649d77SJunchao Zhang       char      *ver,*lf;
73085649d77SJunchao Zhang       PetscBool flg = PETSC_FALSE;
731*39a651e2SJacob Faibussowitsch 
732*39a651e2SJacob Faibussowitsch       CHKERRQ(PetscStrstr(mpilibraryversion,"MPICH Version:",&ver));
733*39a651e2SJacob Faibussowitsch       if (ver) {
734*39a651e2SJacob Faibussowitsch         CHKERRQ(PetscStrchr(ver,'\n',&lf));
735*39a651e2SJacob Faibussowitsch         if (lf) {
73685649d77SJunchao Zhang           *lf = 0;
737*39a651e2SJacob Faibussowitsch           CHKERRQ(PetscStrendswith(ver,MPICH_VERSION,&flg));
73885649d77SJunchao Zhang         }
73985649d77SJunchao Zhang       }
74085649d77SJunchao Zhang       if (!flg) {
741*39a651e2SJacob Faibussowitsch         CHKERRQ(PetscInfo(NULL,"PETSc warning --- MPICH library version \n%s does not match what PETSc was compiled with %s.\n",mpilibraryversion,MPICH_VESION));
74285649d77SJunchao Zhang         flg = PETSC_TRUE;
74385649d77SJunchao Zhang       }
74485649d77SJunchao Zhang     }
74585649d77SJunchao Zhang #endif
74685649d77SJunchao Zhang     /* check for OpenMPI version, it is not part of the MPI ABI initiative (is it part of another initiative that needs to be handled?) */
74785649d77SJunchao Zhang #elif defined(OMPI_MAJOR_VERSION)
74885649d77SJunchao Zhang     {
74985649d77SJunchao Zhang       char *ver,bs[MPI_MAX_LIBRARY_VERSION_STRING],*bsf;
75085649d77SJunchao Zhang       PetscBool flg = PETSC_FALSE;
75185649d77SJunchao Zhang #define PSTRSZ 2
75285649d77SJunchao Zhang       char ompistr1[PSTRSZ][MPI_MAX_LIBRARY_VERSION_STRING] = {"Open MPI","FUJITSU MPI"};
75385649d77SJunchao Zhang       char ompistr2[PSTRSZ][MPI_MAX_LIBRARY_VERSION_STRING] = {"v","Library "};
75485649d77SJunchao Zhang       int i;
75585649d77SJunchao Zhang       for (i=0; i<PSTRSZ; i++) {
756*39a651e2SJacob Faibussowitsch         CHKERRQ(PetscStrstr(mpilibraryversion,ompistr1[i],&ver));
757*39a651e2SJacob Faibussowitsch         if (ver) {
758*39a651e2SJacob Faibussowitsch           CHKERRQ(PetscSNPrintf(bs,MPI_MAX_LIBRARY_VERSION_STRING,"%s%d.%d",ompistr2[i],OMPI_MAJOR_VERSION,OMPI_MINOR_VERSION));
759*39a651e2SJacob Faibussowitsch           CHKERRQ(PetscStrstr(ver,bs,&bsf));
760*39a651e2SJacob Faibussowitsch           if (bsf) flg = PETSC_TRUE;
76185649d77SJunchao Zhang           break;
76285649d77SJunchao Zhang         }
76385649d77SJunchao Zhang       }
76485649d77SJunchao Zhang       if (!flg) {
7657d3de750SJacob Faibussowitsch         PetscInfo(NULL,"PETSc warning --- Open MPI library version \n%s does not match what PETSc was compiled with %d.%d.\n",mpilibraryversion,OMPI_MAJOR_VERSION,OMPI_MINOR_VERSION);
76685649d77SJunchao Zhang         flg = PETSC_TRUE;
76785649d77SJunchao Zhang       }
76885649d77SJunchao Zhang     }
76985649d77SJunchao Zhang #endif
77085649d77SJunchao Zhang   }
77185649d77SJunchao Zhang #endif
77285649d77SJunchao Zhang 
773*39a651e2SJacob Faibussowitsch #if PetscDefined(HAVE_DLSYM)
77485649d77SJunchao Zhang   /* These symbols are currently in the OpenMPI and MPICH libraries; they may not always be, in that case the test will simply not detect the problem */
775*39a651e2SJacob Faibussowitsch   PetscCheck(!dlsym(RTLD_DEFAULT,"ompi_mpi_init") || !dlsym(RTLD_DEFAULT,"MPID_Abort"),PETSC_COMM_SELF,PETSC_ERR_MPI_LIB_INCOMP,"Application was linked against both OpenMPI and MPICH based MPI libraries and will not run correctly");
77685649d77SJunchao Zhang #endif
77785649d77SJunchao Zhang 
77885649d77SJunchao Zhang   /* on Windows - set printf to default to printing 2 digit exponents */
77985649d77SJunchao Zhang #if defined(PETSC_HAVE__SET_OUTPUT_FORMAT)
78085649d77SJunchao Zhang   _set_output_format(_TWO_DIGIT_EXPONENT);
78185649d77SJunchao Zhang #endif
78285649d77SJunchao Zhang 
7835f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscOptionsCreateDefault());
78485649d77SJunchao Zhang 
78585649d77SJunchao Zhang   PetscFinalizeCalled = PETSC_FALSE;
78685649d77SJunchao Zhang 
7875f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscSetProgramName(prog));
7885f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscSpinlockCreate(&PetscViewerASCIISpinLockOpen));
7895f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscSpinlockCreate(&PetscViewerASCIISpinLockStdout));
7905f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscSpinlockCreate(&PetscViewerASCIISpinLockStderr));
7915f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscSpinlockCreate(&PetscCommSpinLock));
79285649d77SJunchao Zhang 
79385649d77SJunchao Zhang   if (PETSC_COMM_WORLD == MPI_COMM_NULL) PETSC_COMM_WORLD = MPI_COMM_WORLD;
7945f80ce2aSJacob Faibussowitsch   CHKERRMPI(MPI_Comm_set_errhandler(PETSC_COMM_WORLD,MPI_ERRORS_RETURN));
79585649d77SJunchao Zhang 
79685649d77SJunchao Zhang   if (PETSC_MPI_ERROR_CLASS == MPI_ERR_LASTCODE) {
7975f80ce2aSJacob Faibussowitsch     CHKERRMPI(MPI_Add_error_class(&PETSC_MPI_ERROR_CLASS));
7985f80ce2aSJacob Faibussowitsch     CHKERRMPI(MPI_Add_error_code(PETSC_MPI_ERROR_CLASS,&PETSC_MPI_ERROR_CODE));
79985649d77SJunchao Zhang   }
80085649d77SJunchao Zhang 
80185649d77SJunchao Zhang   /* Done after init due to a bug in MPICH-GM? */
8025f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscErrorPrintfInitialize());
80385649d77SJunchao Zhang 
8045f80ce2aSJacob Faibussowitsch   CHKERRMPI(MPI_Comm_rank(MPI_COMM_WORLD,&PetscGlobalRank));
8055f80ce2aSJacob Faibussowitsch   CHKERRMPI(MPI_Comm_size(MPI_COMM_WORLD,&PetscGlobalSize));
80685649d77SJunchao Zhang 
80785649d77SJunchao Zhang   MPIU_BOOL = MPI_INT;
80885649d77SJunchao Zhang   MPIU_ENUM = MPI_INT;
80985649d77SJunchao Zhang   MPIU_FORTRANADDR = (sizeof(void*) == sizeof(int)) ? MPI_INT : MPIU_INT64;
81085649d77SJunchao Zhang   if (sizeof(size_t) == sizeof(unsigned)) MPIU_SIZE_T = MPI_UNSIGNED;
81185649d77SJunchao Zhang   else if (sizeof(size_t) == sizeof(unsigned long)) MPIU_SIZE_T = MPI_UNSIGNED_LONG;
81285649d77SJunchao Zhang #if defined(PETSC_SIZEOF_LONG_LONG)
81385649d77SJunchao Zhang   else if (sizeof(size_t) == sizeof(unsigned long long)) MPIU_SIZE_T = MPI_UNSIGNED_LONG_LONG;
81485649d77SJunchao Zhang #endif
815*39a651e2SJacob Faibussowitsch   else SETERRQ(PETSC_COMM_WORLD,PETSC_ERR_SUP_SYS,"Could not find MPI type for size_t");
81685649d77SJunchao Zhang 
81785649d77SJunchao Zhang   /*
81885649d77SJunchao Zhang      Initialized the global complex variable; this is because with
81985649d77SJunchao Zhang      shared libraries the constructors for global variables
82085649d77SJunchao Zhang      are not called; at least on IRIX.
82185649d77SJunchao Zhang   */
82285649d77SJunchao Zhang #if defined(PETSC_HAVE_COMPLEX)
82385649d77SJunchao Zhang   {
82485649d77SJunchao Zhang #if defined(PETSC_CLANGUAGE_CXX) && !defined(PETSC_USE_REAL___FLOAT128)
82585649d77SJunchao Zhang     PetscComplex ic(0.0,1.0);
82685649d77SJunchao Zhang     PETSC_i = ic;
82785649d77SJunchao Zhang #else
82885649d77SJunchao Zhang     PETSC_i = _Complex_I;
82985649d77SJunchao Zhang #endif
83085649d77SJunchao Zhang   }
83185649d77SJunchao Zhang #endif /* PETSC_HAVE_COMPLEX */
83285649d77SJunchao Zhang 
83385649d77SJunchao Zhang   /*
83485649d77SJunchao Zhang      Create the PETSc MPI reduction operator that sums of the first
83585649d77SJunchao Zhang      half of the entries and maxes the second half.
83685649d77SJunchao Zhang   */
8375f80ce2aSJacob Faibussowitsch   CHKERRMPI(MPI_Op_create(MPIU_MaxSum_Local,1,&MPIU_MAXSUM_OP));
83885649d77SJunchao Zhang 
83985649d77SJunchao Zhang #if defined(PETSC_USE_REAL___FLOAT128)
8405f80ce2aSJacob Faibussowitsch   CHKERRMPI(MPI_Type_contiguous(2,MPI_DOUBLE,&MPIU___FLOAT128));
8415f80ce2aSJacob Faibussowitsch   CHKERRMPI(MPI_Type_commit(&MPIU___FLOAT128));
84285649d77SJunchao Zhang #if defined(PETSC_HAVE_COMPLEX)
8435f80ce2aSJacob Faibussowitsch   CHKERRMPI(MPI_Type_contiguous(4,MPI_DOUBLE,&MPIU___COMPLEX128));
8445f80ce2aSJacob Faibussowitsch   CHKERRMPI(MPI_Type_commit(&MPIU___COMPLEX128));
84585649d77SJunchao Zhang #endif
8465f80ce2aSJacob Faibussowitsch   CHKERRMPI(MPI_Op_create(PetscMax_Local,1,&MPIU_MAX));
8475f80ce2aSJacob Faibussowitsch   CHKERRMPI(MPI_Op_create(PetscMin_Local,1,&MPIU_MIN));
84885649d77SJunchao Zhang #elif defined(PETSC_USE_REAL___FP16)
8495f80ce2aSJacob Faibussowitsch   CHKERRMPI(MPI_Type_contiguous(2,MPI_CHAR,&MPIU___FP16));
8505f80ce2aSJacob Faibussowitsch   CHKERRMPI(MPI_Type_commit(&MPIU___FP16));
8515f80ce2aSJacob Faibussowitsch   CHKERRMPI(MPI_Op_create(PetscMax_Local,1,&MPIU_MAX));
8525f80ce2aSJacob Faibussowitsch   CHKERRMPI(MPI_Op_create(PetscMin_Local,1,&MPIU_MIN));
85385649d77SJunchao Zhang #endif
85485649d77SJunchao Zhang 
85585649d77SJunchao Zhang #if defined(PETSC_USE_REAL___FLOAT128) || defined(PETSC_USE_REAL___FP16)
8565f80ce2aSJacob Faibussowitsch   CHKERRMPI(MPI_Op_create(PetscSum_Local,1,&MPIU_SUM));
85785649d77SJunchao Zhang #endif
85885649d77SJunchao Zhang 
8595f80ce2aSJacob Faibussowitsch   CHKERRMPI(MPI_Type_contiguous(2,MPIU_SCALAR,&MPIU_2SCALAR));
8605f80ce2aSJacob Faibussowitsch   CHKERRMPI(MPI_Type_commit(&MPIU_2SCALAR));
86185649d77SJunchao Zhang 
86285649d77SJunchao Zhang   /* create datatypes used by MPIU_MAXLOC, MPIU_MINLOC and PetscSplitReduction_Op */
86385649d77SJunchao Zhang #if !defined(PETSC_HAVE_MPIUNI)
86485649d77SJunchao Zhang   {
86585649d77SJunchao Zhang     struct PetscRealInt { PetscReal v; PetscInt i; };
86685649d77SJunchao Zhang     PetscMPIInt  blockSizes[2] = {1,1};
86785649d77SJunchao Zhang     MPI_Aint     blockOffsets[2] = {offsetof(struct PetscRealInt,v),offsetof(struct PetscRealInt,i)};
86885649d77SJunchao Zhang     MPI_Datatype blockTypes[2] = {MPIU_REAL,MPIU_INT}, tmpStruct;
86985649d77SJunchao Zhang 
8705f80ce2aSJacob Faibussowitsch     CHKERRMPI(MPI_Type_create_struct(2,blockSizes,blockOffsets,blockTypes,&tmpStruct));
8715f80ce2aSJacob Faibussowitsch     CHKERRMPI(MPI_Type_create_resized(tmpStruct,0,sizeof(struct PetscRealInt),&MPIU_REAL_INT));
8725f80ce2aSJacob Faibussowitsch     CHKERRMPI(MPI_Type_free(&tmpStruct));
8735f80ce2aSJacob Faibussowitsch     CHKERRMPI(MPI_Type_commit(&MPIU_REAL_INT));
87485649d77SJunchao Zhang   }
87585649d77SJunchao Zhang   {
87685649d77SJunchao Zhang     struct PetscScalarInt { PetscScalar v; PetscInt i; };
87785649d77SJunchao Zhang     PetscMPIInt  blockSizes[2] = {1,1};
87885649d77SJunchao Zhang     MPI_Aint     blockOffsets[2] = {offsetof(struct PetscScalarInt,v),offsetof(struct PetscScalarInt,i)};
87985649d77SJunchao Zhang     MPI_Datatype blockTypes[2] = {MPIU_SCALAR,MPIU_INT}, tmpStruct;
88085649d77SJunchao Zhang 
8815f80ce2aSJacob Faibussowitsch     CHKERRMPI(MPI_Type_create_struct(2,blockSizes,blockOffsets,blockTypes,&tmpStruct));
8825f80ce2aSJacob Faibussowitsch     CHKERRMPI(MPI_Type_create_resized(tmpStruct,0,sizeof(struct PetscScalarInt),&MPIU_SCALAR_INT));
8835f80ce2aSJacob Faibussowitsch     CHKERRMPI(MPI_Type_free(&tmpStruct));
8845f80ce2aSJacob Faibussowitsch     CHKERRMPI(MPI_Type_commit(&MPIU_SCALAR_INT));
88585649d77SJunchao Zhang   }
88685649d77SJunchao Zhang #endif
88785649d77SJunchao Zhang 
88885649d77SJunchao Zhang #if defined(PETSC_USE_64BIT_INDICES)
8895f80ce2aSJacob Faibussowitsch   CHKERRMPI(MPI_Type_contiguous(2,MPIU_INT,&MPIU_2INT));
8905f80ce2aSJacob Faibussowitsch   CHKERRMPI(MPI_Type_commit(&MPIU_2INT));
89185649d77SJunchao Zhang #endif
8925f80ce2aSJacob Faibussowitsch   CHKERRMPI(MPI_Type_contiguous(4,MPI_INT,&MPI_4INT));
8935f80ce2aSJacob Faibussowitsch   CHKERRMPI(MPI_Type_commit(&MPI_4INT));
8945f80ce2aSJacob Faibussowitsch   CHKERRMPI(MPI_Type_contiguous(4,MPIU_INT,&MPIU_4INT));
8955f80ce2aSJacob Faibussowitsch   CHKERRMPI(MPI_Type_commit(&MPIU_4INT));
89685649d77SJunchao Zhang 
89785649d77SJunchao Zhang   /*
89885649d77SJunchao Zhang      Attributes to be set on PETSc communicators
89985649d77SJunchao Zhang   */
9005f80ce2aSJacob Faibussowitsch   CHKERRMPI(MPI_Comm_create_keyval(MPI_COMM_NULL_COPY_FN,Petsc_Counter_Attr_Delete_Fn,&Petsc_Counter_keyval,(void*)0));
9015f80ce2aSJacob Faibussowitsch   CHKERRMPI(MPI_Comm_create_keyval(MPI_COMM_NULL_COPY_FN,Petsc_InnerComm_Attr_Delete_Fn,&Petsc_InnerComm_keyval,(void*)0));
9025f80ce2aSJacob Faibussowitsch   CHKERRMPI(MPI_Comm_create_keyval(MPI_COMM_NULL_COPY_FN,Petsc_OuterComm_Attr_Delete_Fn,&Petsc_OuterComm_keyval,(void*)0));
9035f80ce2aSJacob Faibussowitsch   CHKERRMPI(MPI_Comm_create_keyval(MPI_COMM_NULL_COPY_FN,Petsc_ShmComm_Attr_Delete_Fn,&Petsc_ShmComm_keyval,(void*)0));
90485649d77SJunchao Zhang 
90585649d77SJunchao Zhang #if defined(PETSC_HAVE_FORTRAN)
9065f80ce2aSJacob Faibussowitsch   if (ftn) CHKERRQ(PetscInitFortran_Private(readarguments,file,len));
90785649d77SJunchao Zhang   else
90885649d77SJunchao Zhang #endif
9095f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscOptionsInsert(NULL,&PetscGlobalArgc,&PetscGlobalArgs,file));
91085649d77SJunchao Zhang 
91185649d77SJunchao Zhang   /* call a second time so it can look in the options database */
9125f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscErrorPrintfInitialize());
91385649d77SJunchao Zhang 
91485649d77SJunchao Zhang   /*
91585649d77SJunchao Zhang      Check system options and print help
91685649d77SJunchao Zhang   */
9175f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscOptionsCheckInitial_Private(help));
91885649d77SJunchao Zhang 
919a4af0ceeSJacob Faibussowitsch   /*
920a4af0ceeSJacob Faibussowitsch    Initialize PetscDevice and PetscDeviceContext
921a4af0ceeSJacob Faibussowitsch 
922a4af0ceeSJacob Faibussowitsch    Note to any future devs thinking of moving this, proper initialization requires:
923a4af0ceeSJacob Faibussowitsch    1. MPI initialized
924a4af0ceeSJacob Faibussowitsch    2. Options DB initialized
925a4af0ceeSJacob Faibussowitsch    3. Petsc error handling initialized, specifically signal handlers. This expects to set up its own SIGSEV handler via
926a4af0ceeSJacob Faibussowitsch       the push/pop interface.
927a4af0ceeSJacob Faibussowitsch   */
928a2158755SJunchao Zhang #if (PetscDefined(HAVE_CUDA) || PetscDefined(HAVE_HIP) || PetscDefined(HAVE_SYCL))
9295f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscDeviceInitializeFromOptions_Internal(PETSC_COMM_WORLD));
930a4af0ceeSJacob Faibussowitsch #endif
931a4af0ceeSJacob Faibussowitsch 
932a4af0ceeSJacob Faibussowitsch #if PetscDefined(HAVE_VIENNACL)
933a4af0ceeSJacob Faibussowitsch   flg = PETSC_FALSE;
9345f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscOptionsHasName(NULL,NULL,"-log_summary",&flg));
9355f80ce2aSJacob Faibussowitsch   if (!flg) CHKERRQ(PetscOptionsHasName(NULL,NULL,"-log_view",&flg));
9365f80ce2aSJacob Faibussowitsch   if (!flg) CHKERRQ(PetscOptionsGetBool(NULL,NULL,"-viennacl_synchronize",&flg,NULL));
937a4af0ceeSJacob Faibussowitsch   PetscViennaCLSynchronize = flg;
9385f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscViennaCLInit());
939a4af0ceeSJacob Faibussowitsch #endif
940a4af0ceeSJacob Faibussowitsch 
941a4af0ceeSJacob Faibussowitsch   /*
942a4af0ceeSJacob Faibussowitsch      Creates the logging data structures; this is enabled even if logging is not turned on
943a4af0ceeSJacob Faibussowitsch      This is the last thing we do before returning to the user code to prevent having the
944a4af0ceeSJacob Faibussowitsch      logging numbers contaminated by any startup time associated with MPI
945a4af0ceeSJacob Faibussowitsch   */
946a4af0ceeSJacob Faibussowitsch #if defined(PETSC_USE_LOG)
9475f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscLogInitialize());
948a4af0ceeSJacob Faibussowitsch #endif
949a4af0ceeSJacob Faibussowitsch 
9505f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscCitationsInitialize());
95185649d77SJunchao Zhang 
95285649d77SJunchao Zhang #if defined(PETSC_HAVE_SAWS)
9535f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscInitializeSAWs(ftn ? NULL : help));
95427104ee2SJacob Faibussowitsch   flg = PETSC_FALSE;
9555f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscOptionsHasName(NULL,NULL,"-stack_view",&flg));
9565f80ce2aSJacob Faibussowitsch   if (flg) CHKERRQ(PetscStackViewSAWs());
95785649d77SJunchao Zhang #endif
95885649d77SJunchao Zhang 
95985649d77SJunchao Zhang   /*
96085649d77SJunchao Zhang      Load the dynamic libraries (on machines that support them), this registers all
96185649d77SJunchao Zhang      the solvers etc. (On non-dynamic machines this initializes the PetscDraw and PetscViewer classes)
96285649d77SJunchao Zhang   */
9635f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscInitialize_DynamicLibraries());
96485649d77SJunchao Zhang 
9655f80ce2aSJacob Faibussowitsch   CHKERRMPI(MPI_Comm_size(PETSC_COMM_WORLD,&size));
9665f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscInfo(NULL,"PETSc successfully started: number of processors = %d\n",size));
9675f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscGetHostName(hostname,256));
9685f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscInfo(NULL,"Running on machine: %s\n",hostname));
96985649d77SJunchao Zhang #if defined(PETSC_HAVE_OPENMP)
97085649d77SJunchao Zhang   {
97185649d77SJunchao Zhang     PetscBool       omp_view_flag;
97285649d77SJunchao Zhang     char           *threads = getenv("OMP_NUM_THREADS");
9735f80ce2aSJacob Faibussowitsch     PetscErrorCode  ierr;
97485649d77SJunchao Zhang 
97585649d77SJunchao Zhang     if (threads) {
9765f80ce2aSJacob Faibussowitsch       CHKERRQ(PetscInfo(NULL,"Number of OpenMP threads %s (as given by OMP_NUM_THREADS)\n",threads));
97785649d77SJunchao Zhang       (void) sscanf(threads, "%" PetscInt_FMT,&PetscNumOMPThreads);
97885649d77SJunchao Zhang     } else {
9792f840973SStefano Zampini       PetscNumOMPThreads = (PetscInt) omp_get_max_threads();
9805f80ce2aSJacob Faibussowitsch       CHKERRQ(PetscInfo(NULL,"Number of OpenMP threads %" PetscInt_FMT " (as given by omp_get_max_threads())\n",PetscNumOMPThreads));
98185649d77SJunchao Zhang     }
98285649d77SJunchao Zhang     ierr = PetscOptionsBegin(PETSC_COMM_WORLD,NULL,"OpenMP options","Sys");CHKERRQ(ierr);
9835f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscOptionsInt("-omp_num_threads","Number of OpenMP threads to use (can also use environmental variable OMP_NUM_THREADS","None",PetscNumOMPThreads,&PetscNumOMPThreads,&flg));
9845f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscOptionsName("-omp_view","Display OpenMP number of threads",NULL,&omp_view_flag));
98585649d77SJunchao Zhang     ierr = PetscOptionsEnd();CHKERRQ(ierr);
98685649d77SJunchao Zhang     if (flg) {
9875f80ce2aSJacob Faibussowitsch       CHKERRQ(PetscInfo(NULL,"Number of OpenMP theads %" PetscInt_FMT " (given by -omp_num_threads)\n",PetscNumOMPThreads));
98885649d77SJunchao Zhang       omp_set_num_threads((int)PetscNumOMPThreads);
98985649d77SJunchao Zhang     }
99085649d77SJunchao Zhang     if (omp_view_flag) {
9915f80ce2aSJacob Faibussowitsch       CHKERRQ(PetscPrintf(PETSC_COMM_WORLD,"OpenMP: number of threads %" PetscInt_FMT "\n",PetscNumOMPThreads));
99285649d77SJunchao Zhang     }
99385649d77SJunchao Zhang   }
99485649d77SJunchao Zhang #endif
99585649d77SJunchao Zhang 
99685649d77SJunchao Zhang #if defined(PETSC_USE_PETSC_MPI_EXTERNAL32)
99785649d77SJunchao Zhang   /*
99885649d77SJunchao Zhang       Tell MPI about our own data representation converter, this would/should be used if extern32 is not supported by the MPI
99985649d77SJunchao Zhang 
100085649d77SJunchao Zhang       Currently not used because it is not supported by MPICH.
100185649d77SJunchao Zhang   */
10025f80ce2aSJacob Faibussowitsch   if (!PetscBinaryBigEndian()) CHKERRMPI(MPI_Register_datarep((char*)"petsc",PetscDataRep_read_conv_fn,PetscDataRep_write_conv_fn,PetscDataRep_extent_fn,NULL));
100385649d77SJunchao Zhang #endif
100485649d77SJunchao Zhang 
100585649d77SJunchao Zhang #if defined(PETSC_SERIALIZE_FUNCTIONS)
10065f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscFPTCreate(10000));
100785649d77SJunchao Zhang #endif
100885649d77SJunchao Zhang 
100985649d77SJunchao Zhang #if defined(PETSC_HAVE_HWLOC)
101085649d77SJunchao Zhang   {
101185649d77SJunchao Zhang     PetscViewer viewer;
10125f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscOptionsGetViewer(PETSC_COMM_WORLD,NULL,NULL,"-process_view",&viewer,NULL,&flg));
101385649d77SJunchao Zhang     if (flg) {
10145f80ce2aSJacob Faibussowitsch       CHKERRQ(PetscProcessPlacementView(viewer));
10155f80ce2aSJacob Faibussowitsch       CHKERRQ(PetscViewerDestroy(&viewer));
101685649d77SJunchao Zhang     }
101785649d77SJunchao Zhang   }
101885649d77SJunchao Zhang #endif
101985649d77SJunchao Zhang 
102085649d77SJunchao Zhang   flg  = PETSC_TRUE;
10215f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscOptionsGetBool(NULL,NULL,"-viewfromoptions",&flg,NULL));
10225f80ce2aSJacob Faibussowitsch   if (!flg) CHKERRQ(PetscOptionsPushGetViewerOff(PETSC_TRUE));
102385649d77SJunchao Zhang 
102485649d77SJunchao Zhang #if defined(PETSC_HAVE_ADIOS)
10255f80ce2aSJacob Faibussowitsch   CHKERRQ(adios_init_noxml(PETSC_COMM_WORLD));
10265f80ce2aSJacob Faibussowitsch   CHKERRQ(adios_declare_group(&Petsc_adios_group,"PETSc","",adios_stat_default));
10275f80ce2aSJacob Faibussowitsch   CHKERRQ(adios_select_method(Petsc_adios_group,"MPI","",""));
10285f80ce2aSJacob Faibussowitsch   CHKERRQ(adios_read_init_method(ADIOS_READ_METHOD_BP,PETSC_COMM_WORLD,""));
102985649d77SJunchao Zhang #endif
103085649d77SJunchao Zhang 
103185649d77SJunchao Zhang #if defined(__VALGRIND_H)
103285649d77SJunchao Zhang   PETSC_RUNNING_ON_VALGRIND = RUNNING_ON_VALGRIND? PETSC_TRUE: PETSC_FALSE;
103385649d77SJunchao Zhang #if defined(PETSC_USING_DARWIN) && defined(PETSC_BLASLAPACK_SDOT_RETURNS_DOUBLE)
10345f80ce2aSJacob Faibussowitsch   if (PETSC_RUNNING_ON_VALGRIND) CHKERRQ(PetscPrintf(PETSC_COMM_WORLD,"WARNING: Running valgrind with the MacOS native BLAS and LAPACK can fail. If it fails suggest configuring with --download-fblaslapack or --download-f2cblaslapack"));
103585649d77SJunchao Zhang #endif
103685649d77SJunchao Zhang #endif
103785649d77SJunchao Zhang   /*
103885649d77SJunchao Zhang       Set flag that we are completely initialized
103985649d77SJunchao Zhang   */
104085649d77SJunchao Zhang   PetscInitializeCalled = PETSC_TRUE;
104185649d77SJunchao Zhang 
10425f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscOptionsHasName(NULL,NULL,"-python",&flg));
10435f80ce2aSJacob Faibussowitsch   if (flg) CHKERRQ(PetscPythonInitialize(NULL,NULL));
104427104ee2SJacob Faibussowitsch   PetscFunctionReturn(0);
104585649d77SJunchao Zhang }
104685649d77SJunchao Zhang 
1047e5c89e4eSSatish Balay /*@C
1048e5c89e4eSSatish Balay    PetscInitialize - Initializes the PETSc database and MPI.
1049e5c89e4eSSatish Balay    PetscInitialize() calls MPI_Init() if that has yet to be called,
1050e5c89e4eSSatish Balay    so this routine should always be called near the beginning of
1051e5c89e4eSSatish Balay    your program -- usually the very first line!
1052e5c89e4eSSatish Balay 
1053e5c89e4eSSatish Balay    Collective on MPI_COMM_WORLD or PETSC_COMM_WORLD if it has been set
1054e5c89e4eSSatish Balay 
1055e5c89e4eSSatish Balay    Input Parameters:
1056e5c89e4eSSatish Balay +  argc - count of number of command line arguments
1057e5c89e4eSSatish Balay .  args - the command line arguments
1058be10d61cSLisandro Dalcin .  file - [optional] PETSc database file, append ":yaml" to filename to specify YAML options format.
1059be10d61cSLisandro Dalcin           Use NULL or empty string to not check for code specific file.
1060be10d61cSLisandro Dalcin           Also checks ~/.petscrc, .petscrc and petscrc.
1061c5b5d8d5SVaclav Hapla           Use -skip_petscrc in the code specific file (or command line) to skip ~/.petscrc, .petscrc and petscrc files.
10620298fd71SBarry Smith -  help - [optional] Help message to print, use NULL for no message
1063e5c89e4eSSatish Balay 
106405827820SBarry Smith    If you wish PETSc code to run ONLY on a subcommunicator of MPI_COMM_WORLD, create that
106505827820SBarry Smith    communicator first and assign it to PETSC_COMM_WORLD BEFORE calling PetscInitialize(). Thus if you are running a
106605827820SBarry Smith    four process job and two processes will run PETSc and have PetscInitialize() and PetscFinalize() and two process will not,
106705827820SBarry Smith    then do this. If ALL processes in the job are using PetscInitialize() and PetscFinalize() then you don't need to do this, even
106805827820SBarry Smith    if different subcommunicators of the job are doing different things with PETSc.
1069e5c89e4eSSatish Balay 
1070e5c89e4eSSatish Balay    Options Database Keys:
10717ca660e7SBarry Smith +  -help [intro] - prints help method for each option; if intro is given the program stops after printing the introductory help message
10727ca660e7SBarry Smith .  -start_in_debugger [noxterm,dbx,xdb,gdb,...] - Starts program in debugger
1073e5c89e4eSSatish Balay .  -on_error_attach_debugger [noxterm,dbx,xdb,gdb,...] - Starts debugger when error detected
10748a690491SBarry Smith .  -on_error_emacs <machinename> - causes emacsclient to jump to error file
10758a690491SBarry Smith .  -on_error_abort - calls abort() when error detected (no traceback)
10768a690491SBarry Smith .  -on_error_mpiabort - calls MPI_abort() when error detected
10778a690491SBarry Smith .  -error_output_stderr - prints error messages to stderr instead of the default stdout
10788a690491SBarry Smith .  -error_output_none - does not print the error messages (but handles errors in the same way as if this was not called)
1079bf4d2887SBarry Smith .  -debugger_ranks [rank1,rank2,...] - Indicates ranks to start in debugger
1080e5c89e4eSSatish Balay .  -debugger_pause [sleeptime] (in seconds) - Pauses debugger
1081e5c89e4eSSatish Balay .  -stop_for_debugger - Print message on how to attach debugger manually to
1082e5c89e4eSSatish Balay                         process and wait (-debugger_pause) seconds for attachment
108379dccf82SBarry Smith .  -malloc - Indicates use of PETSc error-checking malloc (on by default for debug version of libraries) (deprecated, use -malloc_debug)
108479dccf82SBarry Smith .  -malloc no - Indicates not to use error-checking malloc (deprecated, use -malloc_debug no)
108579dccf82SBarry Smith .  -malloc_debug - check for memory corruption at EVERY malloc or free, see PetscMallocSetDebug()
1086aee23540SBarry Smith .  -malloc_dump - prints a list of all unfreed memory at the end of the run
108792f119d6SBarry Smith .  -malloc_test - like -malloc_dump -malloc_debug, but only active for debugging builds, ignored in optimized build. May want to set in PETSC_OPTIONS environmental variable
108892f119d6SBarry Smith .  -malloc_view - show a list of all allocated memory during PetscFinalize()
108992f119d6SBarry Smith .  -malloc_view_threshold <t> - only list memory allocations of size greater than t with -malloc_view
1090608c71bfSMatthew G. Knepley .  -malloc_requested_size - malloc logging will record the requested size rather than size after alignment
109192f119d6SBarry Smith .  -fp_trap - Stops on floating point exceptions
1092e5c89e4eSSatish Balay .  -no_signal_handler - Indicates not to trap error signals
1093e5c89e4eSSatish Balay .  -shared_tmp - indicates /tmp directory is shared by all processors
1094e5c89e4eSSatish Balay .  -not_shared_tmp - each processor has own /tmp
1095e5c89e4eSSatish Balay .  -tmp - alternative name of /tmp directory
1096e5c89e4eSSatish Balay .  -get_total_flops - returns total flops done by all processors
10970841954dSBarry Smith -  -memory_view - Print memory usage at end of run
1098e5c89e4eSSatish Balay 
1099c5b5d8d5SVaclav Hapla    Options Database Keys for Option Database:
1100c5b5d8d5SVaclav Hapla +  -skip_petscrc - skip the default option files ~/.petscrc, .petscrc, petscrc
1101c5b5d8d5SVaclav Hapla .  -options_monitor - monitor all set options to standard output for the whole program run
1102c5b5d8d5SVaclav Hapla -  -options_monitor_cancel - cancel options monitoring hard-wired using PetscOptionsMonitorSet()
1103c5b5d8d5SVaclav Hapla 
1104c5b5d8d5SVaclav Hapla    Options -options_monitor_{all,cancel} are
1105c5b5d8d5SVaclav Hapla    position-independent and apply to all options set since the PETSc start.
1106c5b5d8d5SVaclav Hapla    They can be used also in option files.
1107c5b5d8d5SVaclav Hapla 
1108c5b5d8d5SVaclav Hapla    See PetscOptionsMonitorSet() to do monitoring programmatically.
1109c5b5d8d5SVaclav Hapla 
1110e5c89e4eSSatish Balay    Options Database Keys for Profiling:
1111a7f22e61SSatish Balay    See Users-Manual: ch_profiling for details.
1112fe9b927eSVaclav Hapla +  -info [filename][:[~]<list,of,classnames>[:[~]self]] - Prints verbose information. See PetscInfo().
1113217044c2SLisandro Dalcin .  -log_sync - Enable barrier synchronization for all events. This option is useful to debug imbalance within each event,
1114217044c2SLisandro Dalcin         however it slows things down and gives a distorted view of the overall runtime.
1115495fc317SBarry Smith .  -log_trace [filename] - Print traces of all PETSc calls to the screen (useful to determine where a program
1116e5c89e4eSSatish Balay         hangs without running in the debugger).  See PetscLogTraceBegin().
11179a9a5d4cSBarry Smith .  -log_view [:filename:format] - Prints summary of flop and timing information to screen or file, see PetscLogView().
111879dccf82SBarry Smith .  -log_view_memory - Includes in the summary from -log_view the memory used in each method, see PetscLogView().
11199a9a5d4cSBarry Smith .  -log_summary [filename] - (Deprecated, use -log_view) Prints summary of flop and timing information to screen. If the filename is specified the
1120495fc317SBarry Smith         summary is written to the file.  See PetscLogView().
1121f5d6ab90SLisandro Dalcin .  -log_exclude: <vec,mat,pc,ksp,snes> - excludes subset of object classes from logging
1122495fc317SBarry Smith .  -log_all [filename] - Logs extensive profiling information  See PetscLogDump().
1123495fc317SBarry Smith .  -log [filename] - Logs basic profiline information  See PetscLogDump().
1124c2f74817SBarry Smith .  -log_mpe [filename] - Creates a logfile viewable by the utility Jumpshot (in MPICH distribution)
112587c3beb6SLisandro Dalcin .  -viewfromoptions on,off - Enable or disable XXXSetFromOptions() calls, for applications with many small solves turn this off
1126c2f74817SBarry Smith -  -check_pointer_intensity 0,1,2 - if pointers are checked for validity (debug version only), using 0 will result in faster code
1127495fc317SBarry Smith 
1128609bdbeeSBarry Smith     Only one of -log_trace, -log_view, -log_view, -log_all, -log, or -log_mpe may be used at a time
1129e5c89e4eSSatish Balay 
1130ffbd1cfbSBarry Smith    Options Database Keys for SAWs:
1131ffbd1cfbSBarry Smith +  -saws_port <portnumber> - port number to publish SAWs data, default is 8080
1132ffbd1cfbSBarry 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
1133ffbd1cfbSBarry Smith                             this is useful when you are running many jobs that utilize SAWs at the same time
1134ffbd1cfbSBarry Smith .  -saws_log <filename> - save a log of all SAWs communication
1135ffbd1cfbSBarry Smith .  -saws_https <certificate file> - have SAWs use HTTPS instead of HTTP
1136ffbd1cfbSBarry Smith -  -saws_root <directory> - allow SAWs to have access to the given directory to search for requested resources and files
1137ffbd1cfbSBarry Smith 
1138e5c89e4eSSatish Balay    Environmental Variables:
1139e5c89e4eSSatish Balay +   PETSC_TMP - alternative tmp directory
1140e5c89e4eSSatish Balay .   PETSC_SHARED_TMP - tmp is shared by all processes
1141e5c89e4eSSatish Balay .   PETSC_NOT_SHARED_TMP - each process has its own private tmp
11424a971ea4SToby Isaac .   PETSC_OPTIONS - a string containing additional options for petsc in the form of command line "-key value" pairs
11434a971ea4SToby Isaac .   PETSC_OPTIONS_YAML - (requires configuring PETSc to use libyaml) a string containing additional options for petsc in the form of a YAML document
1144e5c89e4eSSatish Balay .   PETSC_VIEWER_SOCKET_PORT - socket number to use for socket viewer
1145e5c89e4eSSatish Balay -   PETSC_VIEWER_SOCKET_MACHINE - machine to use for socket viewer to connect to
1146e5c89e4eSSatish Balay 
1147e5c89e4eSSatish Balay    Level: beginner
1148e5c89e4eSSatish Balay 
1149e5c89e4eSSatish Balay    Notes:
1150e5c89e4eSSatish Balay    If for some reason you must call MPI_Init() separately, call
1151e5c89e4eSSatish Balay    it before PetscInitialize().
1152e5c89e4eSSatish Balay 
1153e5c89e4eSSatish Balay    Fortran Version:
1154e5c89e4eSSatish Balay    In Fortran this routine has the format
1155e5c89e4eSSatish Balay $       call PetscInitialize(file,ierr)
1156e5c89e4eSSatish Balay 
1157e5c89e4eSSatish Balay +  ierr - error return code
1158c5b5d8d5SVaclav Hapla -  file - [optional] PETSc database file, also checks ~/.petscrc, .petscrc and petscrc.
1159c5b5d8d5SVaclav Hapla           Use PETSC_NULL_CHARACTER to not check for code specific file.
1160c5b5d8d5SVaclav Hapla           Use -skip_petscrc in the code specific file (or command line) to skip ~/.petscrc, .petscrc and petscrc files.
1161e5c89e4eSSatish Balay 
1162e5c89e4eSSatish Balay    Important Fortran Note:
11630eb4c9c0SBarry Smith    In Fortran, you MUST use PETSC_NULL_CHARACTER to indicate a
11640298fd71SBarry Smith    null character string; you CANNOT just use NULL as
1165a7f22e61SSatish Balay    in the C version. See Users-Manual: ch_fortran for details.
1166e5c89e4eSSatish Balay 
116701cb0274SBarry Smith    If your main program is C but you call Fortran code that also uses PETSc you need to call PetscInitializeFortran() soon after
116801cb0274SBarry Smith    calling PetscInitialize().
1169e5c89e4eSSatish Balay 
117001cb0274SBarry Smith .seealso: PetscFinalize(), PetscInitializeFortran(), PetscGetArgs(), PetscInitializeNoArguments()
1171e5c89e4eSSatish Balay 
1172e5c89e4eSSatish Balay @*/
11737087cfbeSBarry Smith PetscErrorCode  PetscInitialize(int *argc,char ***args,const char file[],const char help[])
1174e5c89e4eSSatish Balay {
117585649d77SJunchao Zhang   PetscMPIInt  flag;
117685649d77SJunchao Zhang   const char  *prog = "Unknown Name";
1177e5c89e4eSSatish Balay 
117827104ee2SJacob Faibussowitsch   PetscFunctionBegin;
117927104ee2SJacob Faibussowitsch   if (PetscInitializeCalled) PetscFunctionReturn(0);
11805f80ce2aSJacob Faibussowitsch   CHKERRMPI(MPI_Initialized(&flag));
1181e5c89e4eSSatish Balay   if (!flag) {
1182*39a651e2SJacob Faibussowitsch     PetscCheck(PETSC_COMM_WORLD == MPI_COMM_NULL,PETSC_COMM_SELF,PETSC_ERR_SUP,"You cannot set PETSC_COMM_WORLD if you have not initialized MPI first");
11835f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscPreMPIInit_Private());
11845e765c61SJed Brown #if defined(PETSC_HAVE_MPI_INIT_THREAD)
11855e765c61SJed Brown     {
1186*39a651e2SJacob Faibussowitsch       PetscMPIInt PETSC_UNUSED provided;
11875f80ce2aSJacob Faibussowitsch       CHKERRMPI(MPI_Init_thread(argc,args,PETSC_MPI_THREAD_REQUIRED,&provided));
11885e765c61SJed Brown     }
11895e765c61SJed Brown #else
11905f80ce2aSJacob Faibussowitsch     CHKERRMPI(MPI_Init(argc,args));
11915e765c61SJed Brown #endif
1192e5c89e4eSSatish Balay     PetscBeganMPI = PETSC_TRUE;
1193e5c89e4eSSatish Balay   }
11944dfee713SSatish Balay 
119585649d77SJunchao Zhang   if (argc && *argc) prog = **args;
1196e5c89e4eSSatish Balay   if (argc && args) {
1197e5c89e4eSSatish Balay     PetscGlobalArgc = *argc;
1198e5c89e4eSSatish Balay     PetscGlobalArgs = *args;
1199e5c89e4eSSatish Balay   }
12005f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscInitialize_Common(prog,file,help,PETSC_FALSE/*C*/,PETSC_FALSE,0));
120127104ee2SJacob Faibussowitsch   PetscFunctionReturn(0);
1202e5c89e4eSSatish Balay }
1203e5c89e4eSSatish Balay 
1204a4af0ceeSJacob Faibussowitsch #if PetscDefined(USE_LOG)
120595c0884eSLisandro Dalcin PETSC_INTERN PetscObject *PetscObjects;
1206ecfe9a72SLisandro Dalcin PETSC_INTERN PetscInt    PetscObjectsCounts;
1207ecfe9a72SLisandro Dalcin PETSC_INTERN PetscInt    PetscObjectsMaxCounts;
120895c0884eSLisandro Dalcin PETSC_INTERN PetscBool   PetscObjectsLog;
12094097062eSBarry Smith #endif
1210e5c89e4eSSatish Balay 
1211008a6e76SBarry Smith /*
1212008a6e76SBarry Smith     Frees all the MPI types and operations that PETSc may have created
1213008a6e76SBarry Smith */
1214008a6e76SBarry Smith PetscErrorCode  PetscFreeMPIResources(void)
1215008a6e76SBarry Smith {
1216008a6e76SBarry Smith   PetscFunctionBegin;
1217008a6e76SBarry Smith #if defined(PETSC_USE_REAL___FLOAT128)
12185f80ce2aSJacob Faibussowitsch   CHKERRMPI(MPI_Type_free(&MPIU___FLOAT128));
1219008a6e76SBarry Smith #if defined(PETSC_HAVE_COMPLEX)
12205f80ce2aSJacob Faibussowitsch   CHKERRMPI(MPI_Type_free(&MPIU___COMPLEX128));
1221008a6e76SBarry Smith #endif
12225f80ce2aSJacob Faibussowitsch   CHKERRMPI(MPI_Op_free(&MPIU_MAX));
12235f80ce2aSJacob Faibussowitsch   CHKERRMPI(MPI_Op_free(&MPIU_MIN));
1224008a6e76SBarry Smith #elif defined(PETSC_USE_REAL___FP16)
12255f80ce2aSJacob Faibussowitsch   CHKERRMPI(MPI_Type_free(&MPIU___FP16));
12265f80ce2aSJacob Faibussowitsch   CHKERRMPI(MPI_Op_free(&MPIU_MAX));
12275f80ce2aSJacob Faibussowitsch   CHKERRMPI(MPI_Op_free(&MPIU_MIN));
1228008a6e76SBarry Smith #endif
1229008a6e76SBarry Smith 
1230de272c7aSSatish Balay #if defined(PETSC_USE_REAL___FLOAT128) || defined(PETSC_USE_REAL___FP16)
12315f80ce2aSJacob Faibussowitsch   CHKERRMPI(MPI_Op_free(&MPIU_SUM));
1232008a6e76SBarry Smith #endif
1233008a6e76SBarry Smith 
12345f80ce2aSJacob Faibussowitsch   CHKERRMPI(MPI_Type_free(&MPIU_2SCALAR));
12355f80ce2aSJacob Faibussowitsch   CHKERRMPI(MPI_Type_free(&MPIU_REAL_INT));
12365f80ce2aSJacob Faibussowitsch   CHKERRMPI(MPI_Type_free(&MPIU_SCALAR_INT));
123740df0d72SSatish Balay #if defined(PETSC_USE_64BIT_INDICES)
12385f80ce2aSJacob Faibussowitsch   CHKERRMPI(MPI_Type_free(&MPIU_2INT));
1239008a6e76SBarry Smith #endif
12405f80ce2aSJacob Faibussowitsch   CHKERRMPI(MPI_Type_free(&MPI_4INT));
12415f80ce2aSJacob Faibussowitsch   CHKERRMPI(MPI_Type_free(&MPIU_4INT));
12425f80ce2aSJacob Faibussowitsch   CHKERRMPI(MPI_Op_free(&MPIU_MAXSUM_OP));
1243008a6e76SBarry Smith   PetscFunctionReturn(0);
1244008a6e76SBarry Smith }
1245008a6e76SBarry Smith 
1246a4af0ceeSJacob Faibussowitsch #if PetscDefined(USE_LOG)
1247a4af0ceeSJacob Faibussowitsch PETSC_INTERN PetscErrorCode PetscLogFinalize(void);
1248a4af0ceeSJacob Faibussowitsch #endif
1249a4af0ceeSJacob Faibussowitsch 
1250e5c89e4eSSatish Balay /*@C
1251e5c89e4eSSatish Balay    PetscFinalize - Checks for options to be called at the conclusion
1252e5c89e4eSSatish Balay    of the program. MPI_Finalize() is called only if the user had not
1253e5c89e4eSSatish Balay    called MPI_Init() before calling PetscInitialize().
1254e5c89e4eSSatish Balay 
1255e5c89e4eSSatish Balay    Collective on PETSC_COMM_WORLD
1256e5c89e4eSSatish Balay 
1257e5c89e4eSSatish Balay    Options Database Keys:
125826a7e8d4SBarry Smith +  -options_view - Calls PetscOptionsView()
1259e5c89e4eSSatish Balay .  -options_left - Prints unused options that remain in the database
12607eb1d149SBarry 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
1261e5c89e4eSSatish Balay .  -mpidump - Calls PetscMPIDump()
126292f119d6SBarry Smith .  -malloc_dump <optional filename> - Calls PetscMallocDump(), displays all memory allocated that has not been freed
1263e5c89e4eSSatish Balay .  -malloc_info - Prints total memory usage
126492f119d6SBarry Smith -  -malloc_view <optional filename> - Prints list of all memory allocated and where
1265e5c89e4eSSatish Balay 
1266e5c89e4eSSatish Balay    Level: beginner
1267e5c89e4eSSatish Balay 
1268e5c89e4eSSatish Balay    Note:
1269e5c89e4eSSatish Balay    See PetscInitialize() for more general runtime options.
1270e5c89e4eSSatish Balay 
127188c29154SBarry Smith .seealso: PetscInitialize(), PetscOptionsView(), PetscMallocDump(), PetscMPIDump(), PetscEnd()
1272e5c89e4eSSatish Balay @*/
12737087cfbeSBarry Smith PetscErrorCode  PetscFinalize(void)
1274e5c89e4eSSatish Balay {
12754bb5149bSJed Brown   PetscMPIInt rank;
1276a8d2bbe5SBarry Smith   PetscInt    nopt;
12772bf49c77SBarry Smith   PetscBool   flg1 = PETSC_FALSE,flg2 = PETSC_FALSE,flg3 = PETSC_FALSE;
1278dff31646SBarry Smith   PetscBool   flg;
127910463e74SBarry Smith #if defined(PETSC_USE_LOG)
128010463e74SBarry Smith   char        mname[PETSC_MAX_PATH_LEN];
128110463e74SBarry Smith #endif
1282e5c89e4eSSatish Balay 
12833cbbc5ffSBarry Smith   PetscFunctionBegin;
1284*39a651e2SJacob Faibussowitsch   PetscCheck(PetscInitializeCalled,PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"PetscInitialize() must be called before PetscFinalize()");
12855f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscInfo(NULL,"PetscFinalize() called\n"));
1286b022a5c1SBarry Smith 
12875f80ce2aSJacob Faibussowitsch   CHKERRMPI(MPI_Comm_rank(PETSC_COMM_WORLD,&rank));
1288a56f64adSBarry Smith #if defined(PETSC_HAVE_ADIOS)
12895f80ce2aSJacob Faibussowitsch   CHKERRQ(adios_read_finalize_method(ADIOS_READ_METHOD_BP_AGGREGATE));
12905f80ce2aSJacob Faibussowitsch   CHKERRQ(adios_finalize(rank));
1291a56f64adSBarry Smith #endif
12925f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscOptionsHasName(NULL,NULL,"-citations",&flg));
1293dff31646SBarry Smith   if (flg) {
12941f817a21SBarry Smith     char  *cits, filename[PETSC_MAX_PATH_LEN];
12951f817a21SBarry Smith     FILE  *fd = PETSC_STDOUT;
12961f817a21SBarry Smith 
12975f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscOptionsGetString(NULL,NULL,"-citations",filename,sizeof(filename),NULL));
12981f817a21SBarry Smith     if (filename[0]) {
12995f80ce2aSJacob Faibussowitsch       CHKERRQ(PetscFOpen(PETSC_COMM_WORLD,filename,"w",&fd));
13001f817a21SBarry Smith     }
13015f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscSegBufferGet(PetscCitationsList,1,&cits));
1302dff31646SBarry Smith     cits[0] = 0;
13035f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscSegBufferExtractAlloc(PetscCitationsList,&cits));
13045f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscFPrintf(PETSC_COMM_WORLD,fd,"If you publish results based on this computation please cite the following:\n"));
13055f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscFPrintf(PETSC_COMM_WORLD,fd,"===========================================================================\n"));
13065f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscFPrintf(PETSC_COMM_WORLD,fd,"%s",cits));
13075f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscFPrintf(PETSC_COMM_WORLD,fd,"===========================================================================\n"));
13085f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscFClose(PETSC_COMM_WORLD,fd));
13095f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscFree(cits));
1310dff31646SBarry Smith   }
13115f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscSegBufferDestroy(&PetscCitationsList));
1312dff31646SBarry Smith 
1313c2a97968SBarry Smith #if defined(PETSC_HAVE_SSL) && defined(PETSC_USE_SOCKET_VIEWER)
131404102261SBarry Smith   /* TextBelt is run for testing purposes only, please do not use this feature often */
131504102261SBarry Smith   {
131604102261SBarry Smith     PetscInt nmax = 2;
131704102261SBarry Smith     char     **buffs;
13185f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscMalloc1(2,&buffs));
13195f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscOptionsGetStringArray(NULL,NULL,"-textbelt",buffs,&nmax,&flg1));
132004102261SBarry Smith     if (flg1) {
132128b400f6SJacob Faibussowitsch       PetscCheck(nmax,PETSC_COMM_WORLD,PETSC_ERR_USER,"-textbelt requires either the phone number or number,\"message\"");
132204102261SBarry Smith       if (nmax == 1) {
13235f80ce2aSJacob Faibussowitsch         CHKERRQ(PetscMalloc1(128,&buffs[1]));
13245f80ce2aSJacob Faibussowitsch         CHKERRQ(PetscGetProgramName(buffs[1],32));
13255f80ce2aSJacob Faibussowitsch         CHKERRQ(PetscStrcat(buffs[1]," has completed"));
132604102261SBarry Smith       }
13275f80ce2aSJacob Faibussowitsch       CHKERRQ(PetscTextBelt(PETSC_COMM_WORLD,buffs[0],buffs[1],NULL));
13285f80ce2aSJacob Faibussowitsch       CHKERRQ(PetscFree(buffs[0]));
13295f80ce2aSJacob Faibussowitsch       CHKERRQ(PetscFree(buffs[1]));
133004102261SBarry Smith     }
13315f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscFree(buffs));
133204102261SBarry Smith   }
1333763ec7b1SBarry Smith   {
1334763ec7b1SBarry Smith     PetscInt nmax = 2;
1335763ec7b1SBarry Smith     char     **buffs;
13365f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscMalloc1(2,&buffs));
13375f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscOptionsGetStringArray(NULL,NULL,"-tellmycell",buffs,&nmax,&flg1));
1338763ec7b1SBarry Smith     if (flg1) {
133928b400f6SJacob Faibussowitsch       PetscCheck(nmax,PETSC_COMM_WORLD,PETSC_ERR_USER,"-tellmycell requires either the phone number or number,\"message\"");
1340763ec7b1SBarry Smith       if (nmax == 1) {
13415f80ce2aSJacob Faibussowitsch         CHKERRQ(PetscMalloc1(128,&buffs[1]));
13425f80ce2aSJacob Faibussowitsch         CHKERRQ(PetscGetProgramName(buffs[1],32));
13435f80ce2aSJacob Faibussowitsch         CHKERRQ(PetscStrcat(buffs[1]," has completed"));
1344763ec7b1SBarry Smith       }
13455f80ce2aSJacob Faibussowitsch       CHKERRQ(PetscTellMyCell(PETSC_COMM_WORLD,buffs[0],buffs[1],NULL));
13465f80ce2aSJacob Faibussowitsch       CHKERRQ(PetscFree(buffs[0]));
13475f80ce2aSJacob Faibussowitsch       CHKERRQ(PetscFree(buffs[1]));
1348763ec7b1SBarry Smith     }
13495f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscFree(buffs));
1350763ec7b1SBarry Smith   }
135104102261SBarry Smith #endif
135204102261SBarry Smith 
13532d53ad75SBarry Smith #if defined(PETSC_SERIALIZE_FUNCTIONS)
13545f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscFPTDestroy());
13552d53ad75SBarry Smith #endif
13562d53ad75SBarry Smith 
1357e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS)
1358dff31646SBarry Smith   flg = PETSC_FALSE;
13595f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscOptionsGetBool(NULL,NULL,"-saw_options",&flg,NULL));
1360d5649816SBarry Smith   if (flg) {
13615f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscOptionsSAWsDestroy());
1362d5649816SBarry Smith   }
1363d5649816SBarry Smith #endif
1364d5649816SBarry Smith 
1365681455b2SBarry Smith #if defined(PETSC_HAVE_X)
1366681455b2SBarry Smith   flg1 = PETSC_FALSE;
13675f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscOptionsGetBool(NULL,NULL,"-x_virtual",&flg1,NULL));
1368681455b2SBarry Smith   if (flg1) {
1369681455b2SBarry Smith     /*  this is a crude hack, but better than nothing */
13705f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscPOpen(PETSC_COMM_WORLD,NULL,"pkill -9 Xvfb","r",NULL));
1371681455b2SBarry Smith   }
1372681455b2SBarry Smith #endif
1373681455b2SBarry Smith 
137467584ceeSBarry Smith #if !defined(PETSC_HAVE_THREADSAFETY)
13755f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscOptionsGetBool(NULL,NULL,"-malloc_info",&flg2,NULL));
1376e5c89e4eSSatish Balay   if (!flg2) {
137790d69ab7SBarry Smith     flg2 = PETSC_FALSE;
13785f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscOptionsGetBool(NULL,NULL,"-memory_view",&flg2,NULL));
1379e5c89e4eSSatish Balay   }
1380e5c89e4eSSatish Balay   if (flg2) {
13815f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscMemoryView(PETSC_VIEWER_STDOUT_WORLD,"Summary of Memory Usage in PETSc\n"));
1382e5c89e4eSSatish Balay   }
138367584ceeSBarry Smith #endif
1384e5c89e4eSSatish Balay 
1385e5c89e4eSSatish Balay #if defined(PETSC_USE_LOG)
138690d69ab7SBarry Smith   flg1 = PETSC_FALSE;
13875f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscOptionsGetBool(NULL,NULL,"-get_total_flops",&flg1,NULL));
1388e5c89e4eSSatish Balay   if (flg1) {
1389e5c89e4eSSatish Balay     PetscLogDouble flops = 0;
13905f80ce2aSJacob Faibussowitsch     CHKERRMPI(MPI_Reduce(&petsc_TotalFlops,&flops,1,MPI_DOUBLE,MPI_SUM,0,PETSC_COMM_WORLD));
13915f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscPrintf(PETSC_COMM_WORLD,"Total flops over all processors %g\n",flops));
1392e5c89e4eSSatish Balay   }
1393e5c89e4eSSatish Balay #endif
1394e5c89e4eSSatish Balay 
1395e5c89e4eSSatish Balay #if defined(PETSC_USE_LOG)
1396e5c89e4eSSatish Balay #if defined(PETSC_HAVE_MPE)
1397e5c89e4eSSatish Balay   mname[0] = 0;
13985f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscOptionsGetString(NULL,NULL,"-log_mpe",mname,sizeof(mname),&flg1));
1399e5c89e4eSSatish Balay   if (flg1) {
14005f80ce2aSJacob Faibussowitsch     if (mname[0]) CHKERRQ(PetscLogMPEDump(mname));
14015f80ce2aSJacob Faibussowitsch     else          CHKERRQ(PetscLogMPEDump(0));
1402e5c89e4eSSatish Balay   }
1403e5c89e4eSSatish Balay #endif
1404356e5837SBarry Smith #endif
1405a297a907SKarl Rupp 
1406dd710f27SBarry Smith   /*
1407dd710f27SBarry Smith      Free all objects registered with PetscObjectRegisterDestroy() such as PETSC_VIEWER_XXX_().
1408dd710f27SBarry Smith   */
14095f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscObjectRegisterDestroyAll());
1410dd710f27SBarry Smith 
1411356e5837SBarry Smith #if defined(PETSC_USE_LOG)
14125f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscOptionsPushGetViewerOff(PETSC_FALSE));
14135f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscLogViewFromOptions());
14145f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscOptionsPopGetViewerOff());
141587c3beb6SLisandro Dalcin 
1416356e5837SBarry Smith   mname[0] = 0;
14175f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscOptionsGetString(NULL,NULL,"-log_summary",mname,sizeof(mname),&flg1));
1418e5c89e4eSSatish Balay   if (flg1) {
141991eabc43SBarry Smith     PetscViewer viewer;
14205f80ce2aSJacob Faibussowitsch     CHKERRQ((*PetscHelpPrintf)(PETSC_COMM_WORLD,"\n\n WARNING:   -log_summary is being deprecated; switch to -log_view\n\n\n"));
142191eabc43SBarry Smith     if (mname[0]) {
14225f80ce2aSJacob Faibussowitsch       CHKERRQ(PetscViewerASCIIOpen(PETSC_COMM_WORLD,mname,&viewer));
14235f80ce2aSJacob Faibussowitsch       CHKERRQ(PetscLogView(viewer));
14245f80ce2aSJacob Faibussowitsch       CHKERRQ(PetscViewerDestroy(&viewer));
142533f85c2fSBarry Smith     } else {
142633f85c2fSBarry Smith       viewer = PETSC_VIEWER_STDOUT_WORLD;
14275f80ce2aSJacob Faibussowitsch       CHKERRQ(PetscViewerPushFormat(viewer,PETSC_VIEWER_DEFAULT));
14285f80ce2aSJacob Faibussowitsch       CHKERRQ(PetscLogView(viewer));
14295f80ce2aSJacob Faibussowitsch       CHKERRQ(PetscViewerPopFormat(viewer));
143033f85c2fSBarry Smith     }
1431e5c89e4eSSatish Balay   }
1432a297a907SKarl Rupp 
1433dd710f27SBarry Smith   /*
1434dd710f27SBarry Smith      Free any objects created by the last block of code.
1435dd710f27SBarry Smith   */
14365f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscObjectRegisterDestroyAll());
1437dd710f27SBarry Smith 
1438dd710f27SBarry Smith   mname[0] = 0;
14395f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscOptionsGetString(NULL,NULL,"-log_all",mname,sizeof(mname),&flg1));
14405f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscOptionsGetString(NULL,NULL,"-log",mname,sizeof(mname),&flg2));
14415f80ce2aSJacob Faibussowitsch   if (flg1 || flg2) CHKERRQ(PetscLogDump(mname));
1442e5c89e4eSSatish Balay #endif
144310463e74SBarry Smith 
144490d69ab7SBarry Smith   flg1 = PETSC_FALSE;
14455f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscOptionsGetBool(NULL,NULL,"-no_signal_handler",&flg1,NULL));
14465f80ce2aSJacob Faibussowitsch   if (!flg1) CHKERRQ(PetscPopSignalHandler());
144790d69ab7SBarry Smith   flg1 = PETSC_FALSE;
14485f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscOptionsGetBool(NULL,NULL,"-mpidump",&flg1,NULL));
1449e5c89e4eSSatish Balay   if (flg1) {
14505f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscMPIDump(stdout));
1451e5c89e4eSSatish Balay   }
145290d69ab7SBarry Smith   flg1 = PETSC_FALSE;
145390d69ab7SBarry Smith   flg2 = PETSC_FALSE;
14548bb29257SSatish Balay   /* preemptive call to avoid listing this option in options table as unused */
14555f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscOptionsHasName(NULL,NULL,"-malloc_dump",&flg1));
14565f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscOptionsHasName(NULL,NULL,"-objects_dump",&flg1));
14575f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscOptionsGetBool(NULL,NULL,"-options_view",&flg2,NULL));
1458e4c476e2SSatish Balay 
1459e5c89e4eSSatish Balay   if (flg2) {
1460be56827dSJed Brown     PetscViewer viewer;
14615f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscViewerCreate(PETSC_COMM_WORLD,&viewer));
14625f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscViewerSetType(viewer,PETSCVIEWERASCII));
14635f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscOptionsView(NULL,viewer));
14645f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscViewerDestroy(&viewer));
1465e5c89e4eSSatish Balay   }
1466e5c89e4eSSatish Balay 
1467e5c89e4eSSatish Balay   /* to prevent PETSc -options_left from warning */
14685f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscOptionsHasName(NULL,NULL,"-nox",&flg1));
14695f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscOptionsHasName(NULL,NULL,"-nox_warning",&flg1));
1470e5c89e4eSSatish Balay 
147133fc4174SSatish Balay   flg3 = PETSC_FALSE; /* default value is required */
14725f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscOptionsGetBool(NULL,NULL,"-options_left",&flg3,&flg1));
14739245e749SBarry Smith   if (PetscUnlikelyDebug(!flg1)) flg3 = PETSC_TRUE;
1474e5c89e4eSSatish Balay   if (flg3) {
14753de2bfdfSBarry Smith     if (!flg2 && flg1) { /* have not yet printed the options */
1476be56827dSJed Brown       PetscViewer viewer;
14775f80ce2aSJacob Faibussowitsch       CHKERRQ(PetscViewerCreate(PETSC_COMM_WORLD,&viewer));
14785f80ce2aSJacob Faibussowitsch       CHKERRQ(PetscViewerSetType(viewer,PETSCVIEWERASCII));
14795f80ce2aSJacob Faibussowitsch       CHKERRQ(PetscOptionsView(NULL,viewer));
14805f80ce2aSJacob Faibussowitsch       CHKERRQ(PetscViewerDestroy(&viewer));
1481e5c89e4eSSatish Balay     }
14825f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscOptionsAllUsed(NULL,&nopt));
14833de2bfdfSBarry Smith     if (nopt) {
14845f80ce2aSJacob Faibussowitsch       CHKERRQ(PetscPrintf(PETSC_COMM_WORLD,"WARNING! There are options you set that were not used!\n"));
14855f80ce2aSJacob Faibussowitsch       CHKERRQ(PetscPrintf(PETSC_COMM_WORLD,"WARNING! could be spelling mistake, etc!\n"));
14863de2bfdfSBarry Smith       if (nopt == 1) {
14875f80ce2aSJacob Faibussowitsch         CHKERRQ(PetscPrintf(PETSC_COMM_WORLD,"There is one unused database option. It is:\n"));
1488e5c89e4eSSatish Balay       } else {
14895f80ce2aSJacob Faibussowitsch         CHKERRQ(PetscPrintf(PETSC_COMM_WORLD,"There are %" PetscInt_FMT " unused database options. They are:\n",nopt));
1490e5c89e4eSSatish Balay       }
14913de2bfdfSBarry Smith     } else if (flg3 && flg1) {
14925f80ce2aSJacob Faibussowitsch       CHKERRQ(PetscPrintf(PETSC_COMM_WORLD,"There are no unused options.\n"));
1493df12ba86SBarry Smith     }
14945f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscOptionsLeft(NULL));
1495e5c89e4eSSatish Balay   }
1496e5c89e4eSSatish Balay 
1497e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS)
1498d45a07a7SBarry Smith   if (!PetscGlobalRank) {
14995f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscStackSAWsViewOff());
150016ad0300SBarry Smith     PetscStackCallSAWs(SAWs_Finalize,());
1501d45a07a7SBarry Smith   }
1502ec957eceSBarry Smith #endif
1503ec957eceSBarry Smith 
15044097062eSBarry Smith #if defined(PETSC_USE_LOG)
150510463e74SBarry Smith   /*
1506dbc8283eSBarry Smith        List all objects the user may have forgot to free
15072eff7a51SBarry Smith   */
150805df10baSBarry Smith   if (PetscObjectsLog) {
15095f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscOptionsHasName(NULL,NULL,"-objects_dump",&flg1));
1510a64a8e02SBarry Smith     if (flg1) {
1511a64a8e02SBarry Smith       MPI_Comm local_comm;
15127eb1d149SBarry Smith       char     string[64];
1513a64a8e02SBarry Smith 
15145f80ce2aSJacob Faibussowitsch       CHKERRQ(PetscOptionsGetString(NULL,NULL,"-objects_dump",string,sizeof(string),NULL));
15155f80ce2aSJacob Faibussowitsch       CHKERRMPI(MPI_Comm_dup(MPI_COMM_WORLD,&local_comm));
15165f80ce2aSJacob Faibussowitsch       CHKERRQ(PetscSequentialPhaseBegin_Private(local_comm,1));
15175f80ce2aSJacob Faibussowitsch       CHKERRQ(PetscObjectsDump(stdout,(string[0] == 'a') ? PETSC_TRUE : PETSC_FALSE));
15185f80ce2aSJacob Faibussowitsch       CHKERRQ(PetscSequentialPhaseEnd_Private(local_comm,1));
15195f80ce2aSJacob Faibussowitsch       CHKERRMPI(MPI_Comm_free(&local_comm));
15200a1571b3SBarry Smith     }
152105df10baSBarry Smith   }
15224097062eSBarry Smith #endif
15234097062eSBarry Smith 
15244097062eSBarry Smith #if defined(PETSC_USE_LOG)
1525dbc8283eSBarry Smith   PetscObjectsCounts    = 0;
1526dbc8283eSBarry Smith   PetscObjectsMaxCounts = 0;
15275f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscFree(PetscObjects));
15284097062eSBarry Smith #endif
15292eff7a51SBarry Smith 
153033f85c2fSBarry Smith   /*
153133f85c2fSBarry Smith      Destroy any packages that registered a finalize
153233f85c2fSBarry Smith   */
15335f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscRegisterFinalizeAll());
153433f85c2fSBarry Smith 
1535101409b8SToby Isaac #if defined(PETSC_USE_LOG)
15365f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscLogFinalize());
1537101409b8SToby Isaac #endif
1538101409b8SToby Isaac 
153933f85c2fSBarry Smith   /*
154048dd1dffSBarry Smith      Print PetscFunctionLists that have not been properly freed
154148dd1dffSBarry Smith 
15425f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscFunctionListPrintAll());
154348dd1dffSBarry Smith   */
154437e93019SBarry Smith 
15454028d114SSatish Balay   if (petsc_history) {
15465f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscCloseHistoryFile(&petsc_history));
154702c9f0b5SLisandro Dalcin     petsc_history = NULL;
1548e5c89e4eSSatish Balay   }
15495f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscOptionsHelpPrintedDestroy(&PetscOptionsHelpPrintedSingleton));
15505f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscInfoDestroy());
1551e5c89e4eSSatish Balay 
155267584ceeSBarry Smith #if !defined(PETSC_HAVE_THREADSAFETY)
155392f119d6SBarry Smith   if (!(PETSC_RUNNING_ON_VALGRIND)) {
1554e5c89e4eSSatish Balay     char fname[PETSC_MAX_PATH_LEN];
155592f119d6SBarry Smith     char sname[PETSC_MAX_PATH_LEN];
1556e5c89e4eSSatish Balay     FILE *fd;
1557ed9cf6e9SBarry Smith     int  err;
1558e5c89e4eSSatish Balay 
1559dc92acbaSJed Brown     flg2 = PETSC_FALSE;
156092f119d6SBarry Smith     flg3 = PETSC_FALSE;
15615f80ce2aSJacob Faibussowitsch     if (PetscDefined(USE_DEBUG)) CHKERRQ(PetscOptionsGetBool(NULL,NULL,"-malloc_test",&flg2,NULL));
15625f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscOptionsGetBool(NULL,NULL,"-malloc_debug",&flg3,NULL));
156392f119d6SBarry Smith     fname[0] = 0;
15645f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscOptionsGetString(NULL,NULL,"-malloc_dump",fname,sizeof(fname),&flg1));
1565e5c89e4eSSatish Balay     if (flg1 && fname[0]) {
1566e5c89e4eSSatish Balay 
1567589a23caSBarry Smith       PetscSNPrintf(sname,sizeof(sname),"%s_%d",fname,rank);
156828b400f6SJacob Faibussowitsch       fd   = fopen(sname,"w"); PetscCheck(fd,PETSC_COMM_SELF,PETSC_ERR_FILE_OPEN,"Cannot open log file: %s",sname);
15695f80ce2aSJacob Faibussowitsch       CHKERRQ(PetscMallocDump(fd));
1570ed9cf6e9SBarry Smith       err  = fclose(fd);
157128b400f6SJacob Faibussowitsch       PetscCheck(!err,PETSC_COMM_SELF,PETSC_ERR_SYS,"fclose() failed on file");
157292f119d6SBarry Smith     } else if (flg1 || flg2 || flg3) {
1573e5c89e4eSSatish Balay       MPI_Comm local_comm;
1574e5c89e4eSSatish Balay 
15755f80ce2aSJacob Faibussowitsch       CHKERRMPI(MPI_Comm_dup(MPI_COMM_WORLD,&local_comm));
15765f80ce2aSJacob Faibussowitsch       CHKERRQ(PetscSequentialPhaseBegin_Private(local_comm,1));
15775f80ce2aSJacob Faibussowitsch       CHKERRQ(PetscMallocDump(stdout));
15785f80ce2aSJacob Faibussowitsch       CHKERRQ(PetscSequentialPhaseEnd_Private(local_comm,1));
15795f80ce2aSJacob Faibussowitsch       CHKERRMPI(MPI_Comm_free(&local_comm));
1580e5c89e4eSSatish Balay     }
1581e5c89e4eSSatish Balay     fname[0] = 0;
15825f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscOptionsGetString(NULL,NULL,"-malloc_view",fname,sizeof(fname),&flg1));
1583e5c89e4eSSatish Balay     if (flg1 && fname[0]) {
1584e5c89e4eSSatish Balay 
1585589a23caSBarry Smith       PetscSNPrintf(sname,sizeof(sname),"%s_%d",fname,rank);
158628b400f6SJacob Faibussowitsch       fd   = fopen(sname,"w"); PetscCheck(fd,PETSC_COMM_SELF,PETSC_ERR_FILE_OPEN,"Cannot open log file: %s",sname);
15875f80ce2aSJacob Faibussowitsch       CHKERRQ(PetscMallocView(fd));
1588ed9cf6e9SBarry Smith       err  = fclose(fd);
158928b400f6SJacob Faibussowitsch       PetscCheck(!err,PETSC_COMM_SELF,PETSC_ERR_SYS,"fclose() failed on file");
159092f119d6SBarry Smith     } else if (flg1) {
159192f119d6SBarry Smith       MPI_Comm local_comm;
159292f119d6SBarry Smith 
15935f80ce2aSJacob Faibussowitsch       CHKERRMPI(MPI_Comm_dup(MPI_COMM_WORLD,&local_comm));
15945f80ce2aSJacob Faibussowitsch       CHKERRQ(PetscSequentialPhaseBegin_Private(local_comm,1));
15955f80ce2aSJacob Faibussowitsch       CHKERRQ(PetscMallocView(stdout));
15965f80ce2aSJacob Faibussowitsch       CHKERRQ(PetscSequentialPhaseEnd_Private(local_comm,1));
15975f80ce2aSJacob Faibussowitsch       CHKERRMPI(MPI_Comm_free(&local_comm));
1598e5c89e4eSSatish Balay     }
1599e5c89e4eSSatish Balay   }
160067584ceeSBarry Smith #endif
160120e2c332SMatthew G. Knepley 
16025486ca60SMatthew G. Knepley   /*
16035486ca60SMatthew G. Knepley      Close any open dynamic libraries
16045486ca60SMatthew G. Knepley   */
16055f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscFinalize_DynamicLibraries());
16065486ca60SMatthew G. Knepley 
1607e5c89e4eSSatish Balay   /* Can be destroyed only after all the options are used */
16085f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscOptionsDestroyDefault());
1609e5c89e4eSSatish Balay 
1610e5c89e4eSSatish Balay   PetscGlobalArgc = 0;
161102c9f0b5SLisandro Dalcin   PetscGlobalArgs = NULL;
1612e5c89e4eSSatish Balay 
1613c2b86a48SJunchao Zhang #if defined(PETSC_HAVE_KOKKOS)
1614c2b86a48SJunchao Zhang   if (PetscBeganKokkos) {
16155f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscKokkosFinalize_Private());
1616c2b86a48SJunchao Zhang     PetscBeganKokkos = PETSC_FALSE;
161745639126SStefano Zampini     PetscKokkosInitialized = PETSC_FALSE;
1618c2b86a48SJunchao Zhang   }
1619c2b86a48SJunchao Zhang #endif
1620c2b86a48SJunchao Zhang 
162171438e86SJunchao Zhang #if defined(PETSC_HAVE_NVSHMEM)
162271438e86SJunchao Zhang   if (PetscBeganNvshmem) {
16235f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscNvshmemFinalize());
162471438e86SJunchao Zhang     PetscBeganNvshmem = PETSC_FALSE;
162571438e86SJunchao Zhang   }
162671438e86SJunchao Zhang #endif
1627a0e72f99SJunchao Zhang 
16285f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscFreeMPIResources());
1629e5c89e4eSSatish Balay 
1630dbc8283eSBarry Smith   /*
1631efb80d3cSBarry Smith      Destroy any known inner MPI_Comm's and attributes pointing to them
1632efb80d3cSBarry Smith      Note this will not destroy any new communicators the user has created.
1633efb80d3cSBarry Smith 
1634efb80d3cSBarry Smith      If all PETSc objects were not destroyed those left over objects will have hanging references to
1635efb80d3cSBarry Smith      the MPI_Comms that were freed; but that is ok because those PETSc objects will never be used again
1636dbc8283eSBarry Smith  */
1637b770b1f6SSatish Balay   {
1638dbc8283eSBarry Smith     PetscCommCounter *counter;
1639dbc8283eSBarry Smith     PetscMPIInt      flg;
1640dbc8283eSBarry Smith     MPI_Comm         icomm;
1641265f3f35SJed Brown     union {MPI_Comm comm; void *ptr;} ucomm;
16425f80ce2aSJacob Faibussowitsch     CHKERRMPI(MPI_Comm_get_attr(PETSC_COMM_SELF,Petsc_InnerComm_keyval,&ucomm,&flg));
1643dbc8283eSBarry Smith     if (flg) {
1644265f3f35SJed Brown       icomm = ucomm.comm;
16455f80ce2aSJacob Faibussowitsch       CHKERRMPI(MPI_Comm_get_attr(icomm,Petsc_Counter_keyval,&counter,&flg));
164628b400f6SJacob Faibussowitsch       PetscCheck(flg,PETSC_COMM_SELF,PETSC_ERR_ARG_CORRUPT,"Inner MPI_Comm does not have expected tag/name counter, problem with corrupted memory");
1647dbc8283eSBarry Smith 
16485f80ce2aSJacob Faibussowitsch       CHKERRMPI(MPI_Comm_delete_attr(PETSC_COMM_SELF,Petsc_InnerComm_keyval));
16495f80ce2aSJacob Faibussowitsch       CHKERRMPI(MPI_Comm_delete_attr(icomm,Petsc_Counter_keyval));
16505f80ce2aSJacob Faibussowitsch       CHKERRMPI(MPI_Comm_free(&icomm));
1651dbc8283eSBarry Smith     }
16525f80ce2aSJacob Faibussowitsch     CHKERRMPI(MPI_Comm_get_attr(PETSC_COMM_WORLD,Petsc_InnerComm_keyval,&ucomm,&flg));
1653dbc8283eSBarry Smith     if (flg) {
1654265f3f35SJed Brown       icomm = ucomm.comm;
16555f80ce2aSJacob Faibussowitsch       CHKERRMPI(MPI_Comm_get_attr(icomm,Petsc_Counter_keyval,&counter,&flg));
165628b400f6SJacob Faibussowitsch       PetscCheck(flg,PETSC_COMM_WORLD,PETSC_ERR_ARG_CORRUPT,"Inner MPI_Comm does not have expected tag/name counter, problem with corrupted memory");
1657dbc8283eSBarry Smith 
16585f80ce2aSJacob Faibussowitsch       CHKERRMPI(MPI_Comm_delete_attr(PETSC_COMM_WORLD,Petsc_InnerComm_keyval));
16595f80ce2aSJacob Faibussowitsch       CHKERRMPI(MPI_Comm_delete_attr(icomm,Petsc_Counter_keyval));
16605f80ce2aSJacob Faibussowitsch       CHKERRMPI(MPI_Comm_free(&icomm));
1661dbc8283eSBarry Smith     }
1662b770b1f6SSatish Balay   }
1663dbc8283eSBarry Smith 
16645f80ce2aSJacob Faibussowitsch   CHKERRMPI(MPI_Comm_free_keyval(&Petsc_Counter_keyval));
16655f80ce2aSJacob Faibussowitsch   CHKERRMPI(MPI_Comm_free_keyval(&Petsc_InnerComm_keyval));
16665f80ce2aSJacob Faibussowitsch   CHKERRMPI(MPI_Comm_free_keyval(&Petsc_OuterComm_keyval));
16675f80ce2aSJacob Faibussowitsch   CHKERRMPI(MPI_Comm_free_keyval(&Petsc_ShmComm_keyval));
1668480cf27aSJed Brown 
16695f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscSpinlockDestroy(&PetscViewerASCIISpinLockOpen));
16705f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscSpinlockDestroy(&PetscViewerASCIISpinLockStdout));
16715f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscSpinlockDestroy(&PetscViewerASCIISpinLockStderr));
16725f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscSpinlockDestroy(&PetscCommSpinLock));
1673ef19f930SBarry Smith 
1674e5c89e4eSSatish Balay   if (PetscBeganMPI) {
167599b1327fSBarry Smith     PetscMPIInt flag;
16765f80ce2aSJacob Faibussowitsch     CHKERRMPI(MPI_Finalized(&flag));
1677*39a651e2SJacob Faibussowitsch     PetscCheck(!flag,PETSC_COMM_SELF,PETSC_ERR_LIB,"MPI_Finalize() has already been called, even though MPI_Init() was called by PetscInitialize()");
1678*39a651e2SJacob Faibussowitsch     /* wait until the very last moment to disable error handling */
1679*39a651e2SJacob Faibussowitsch     PetscErrorHandlingInitialized = PETSC_FALSE;
16805f80ce2aSJacob Faibussowitsch     CHKERRMPI(MPI_Finalize());
1681*39a651e2SJacob Faibussowitsch   } else PetscErrorHandlingInitialized = PETSC_FALSE;
1682*39a651e2SJacob Faibussowitsch 
1683e5c89e4eSSatish Balay /*
1684e5c89e4eSSatish Balay 
1685e5c89e4eSSatish Balay      Note: In certain cases PETSC_COMM_WORLD is never MPI_Comm_free()ed because
1686e5c89e4eSSatish Balay    the communicator has some outstanding requests on it. Specifically if the
1687e5c89e4eSSatish Balay    flag PETSC_HAVE_BROKEN_REQUEST_FREE is set (for IBM MPI implementation). See
1688e5c89e4eSSatish Balay    src/vec/utils/vpscat.c. Due to this the memory allocated in PetscCommDuplicate()
1689e5c89e4eSSatish Balay    is never freed as it should be. Thus one may obtain messages of the form
16900e5e90baSSatish Balay    [ 1] 8 bytes PetscCommDuplicate() line 645 in src/sys/mpiu.c indicating the
1691e5c89e4eSSatish Balay    memory was not freed.
1692e5c89e4eSSatish Balay 
1693e5c89e4eSSatish Balay */
16945f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscMallocClear());
16955f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscStackReset());
1696a297a907SKarl Rupp 
1697e5c89e4eSSatish Balay   PetscInitializeCalled = PETSC_FALSE;
1698e5c89e4eSSatish Balay   PetscFinalizeCalled   = PETSC_TRUE;
169956883f60SBarry Smith #if defined(PETSC_USE_GCOV)
170056883f60SBarry Smith   /*
170156883f60SBarry Smith      flush gcov, otherwise during CI the flushing continues into the next pipeline resulting in git not being able to delete directories since the
170256883f60SBarry Smith      gcov files are still being added to the directories as git tries to remove the directories.
170356883f60SBarry Smith    */
170456883f60SBarry Smith   __gcov_flush();
170556883f60SBarry Smith #endif
17061724198aSStefano Zampini   /* To match PetscFunctionBegin() at the beginning of this function */
17071724198aSStefano Zampini   PetscStackClearTop;
170827104ee2SJacob Faibussowitsch   return 0;
1709e5c89e4eSSatish Balay }
1710e5c89e4eSSatish Balay 
171143db4dbbSBarry Smith #if defined(PETSC_MISSING_LAPACK_lsame_)
17128cc058d9SJed Brown PETSC_EXTERN int lsame_(char *a,char *b)
171343db4dbbSBarry Smith {
171443db4dbbSBarry Smith   if (*a == *b) return 1;
171543db4dbbSBarry Smith   if (*a + 32 == *b) return 1;
171643db4dbbSBarry Smith   if (*a - 32 == *b) return 1;
171743db4dbbSBarry Smith   return 0;
171843db4dbbSBarry Smith }
1719a70650f6SBarry Smith #endif
172043db4dbbSBarry Smith 
172143db4dbbSBarry Smith #if defined(PETSC_MISSING_LAPACK_lsame)
17228cc058d9SJed Brown PETSC_EXTERN int lsame(char *a,char *b)
172343db4dbbSBarry Smith {
172443db4dbbSBarry Smith   if (*a == *b) return 1;
172543db4dbbSBarry Smith   if (*a + 32 == *b) return 1;
172643db4dbbSBarry Smith   if (*a - 32 == *b) return 1;
172743db4dbbSBarry Smith   return 0;
172843db4dbbSBarry Smith }
172943db4dbbSBarry Smith #endif
1730