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; 979566063dSJacob Faibussowitsch PetscCall(PetscInitialize(&myargc,&myargs,filename,help)); 989566063dSJacob Faibussowitsch PetscCall(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; 1309566063dSJacob Faibussowitsch PetscCall(PetscInitialize(&argc,&args,NULL,NULL)); 13139a651e2SJacob 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; 2039566063dSJacob Faibussowitsch PetscCallMPI(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; 2119566063dSJacob Faibussowitsch PetscCallMPI(MPI_Comm_size(comm,&size)); 2129566063dSJacob Faibussowitsch PetscCallMPI(MPI_Comm_rank(comm,&rank)); 2139566063dSJacob Faibussowitsch PetscCall(PetscMalloc1(size,&work)); 2141c2dc1cbSBarry Smith PetscCall(MPIU_Allreduce((void*)sizes,work,size,MPIU_2INT,MPIU_MAXSUM_OP,comm)); 2156ac3741eSJed Brown *max = work[rank].max; 2166ac3741eSJed Brown *sum = work[rank].sum; 2179566063dSJacob Faibussowitsch PetscCall(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; 3189566063dSJacob Faibussowitsch PetscCallMPI(PetscInfo(NULL,"Deleting counter data in an MPI_Comm %ld\n",(long)comm)); 3199566063dSJacob Faibussowitsch PetscCallMPI(PetscFree(counter->iflags)); 32057f21012SBarry Smith while (comms) { 3219566063dSJacob Faibussowitsch PetscCallMPI(MPI_Comm_free(&comms->comm)); 32257f21012SBarry Smith pcomm = comms; 32357f21012SBarry Smith comms = comms->next; 3249566063dSJacob Faibussowitsch PetscCall(PetscFree(pcomm)); 32557f21012SBarry Smith } 3269566063dSJacob Faibussowitsch PetscCallMPI(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; 3529566063dSJacob Faibussowitsch PetscCallMPI(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 } 3569566063dSJacob Faibussowitsch PetscCallMPI(MPI_Comm_delete_attr(icomm.comm,Petsc_OuterComm_keyval)); 3579566063dSJacob Faibussowitsch PetscCallMPI(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; 3679566063dSJacob Faibussowitsch PetscCallMPI(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; 3909566063dSJacob Faibussowitsch PetscCall(PetscSegBufferCreate(1,10000,&PetscCitationsList)); 391*30c35bf2SSatish Balay 392*30c35bf2SSatish Balay PetscCall(PetscCitationsRegister("@TechReport{petsc-user-ref,\n\ 393*30c35bf2SSatish Balay Author = {Satish Balay and Shrirang Abhyankar and Mark~F. Adams and Steven Benson and Jed Brown\n\ 394*30c35bf2SSatish Balay and Peter Brune and Kris Buschelman and Emil Constantinescu and Lisandro Dalcin and Alp Dener\n\ 395*30c35bf2SSatish Balay and Victor Eijkhout and William~D. Gropp and V\'{a}clav Hapla and Tobin Isaac and Pierre Jolivet\n\ 396*30c35bf2SSatish Balay and Dmitry Karpeev and Dinesh Kaushik and Matthew~G. Knepley and Fande Kong and Scott Kruger\n\ 397*30c35bf2SSatish Balay and Dave~A. May and Lois Curfman McInnes and Richard Tran Mills and Lawrence Mitchell and Todd Munson\n\ 398*30c35bf2SSatish Balay and Jose~E. Roman and Karl Rupp and Patrick Sanan and Jason Sarich and Barry~F. Smith\n\ 399*30c35bf2SSatish Balay and Stefano Zampini and Hong Zhang and Hong Zhang and Junchao Zhang},\n\ 400*30c35bf2SSatish Balay Title = {{PETSc/TAO} Users Manual},\n\ 401*30c35bf2SSatish Balay Number = {ANL-21/39 - Revision 3.17},\n\ 402*30c35bf2SSatish Balay Institution = {Argonne National Laboratory},\n\ 403*30c35bf2SSatish Balay Year = {2022}\n}\n",NULL)); 404*30c35bf2SSatish Balay 405*30c35bf2SSatish Balay PetscCall(PetscCitationsRegister("@InProceedings{petsc-efficient,\n\ 406*30c35bf2SSatish Balay Author = {Satish Balay and William D. Gropp and Lois Curfman McInnes and Barry F. Smith},\n\ 407*30c35bf2SSatish Balay Title = {Efficient Management of Parallelism in Object Oriented Numerical Software Libraries},\n\ 408*30c35bf2SSatish Balay Booktitle = {Modern Software Tools in Scientific Computing},\n\ 409*30c35bf2SSatish Balay Editor = {E. Arge and A. M. Bruaset and H. P. Langtangen},\n\ 410*30c35bf2SSatish Balay Pages = {163--202},\n\ 411*30c35bf2SSatish Balay Publisher = {Birkh{\\\"{a}}user Press},\n\ 412*30c35bf2SSatish Balay Year = {1997}\n}\n",NULL)); 413*30c35bf2SSatish Balay 414051e4cf2SJed Brown PetscFunctionReturn(0); 415051e4cf2SJed Brown } 416e5c89e4eSSatish Balay 4172d747510SLisandro Dalcin static char programname[PETSC_MAX_PATH_LEN] = ""; /* HP includes entire path in name */ 4182d747510SLisandro Dalcin 4192d747510SLisandro Dalcin PetscErrorCode PetscSetProgramName(const char name[]) 4202d747510SLisandro Dalcin { 4212d747510SLisandro Dalcin PetscFunctionBegin; 4229566063dSJacob Faibussowitsch PetscCall(PetscStrncpy(programname,name,sizeof(programname))); 4232d747510SLisandro Dalcin PetscFunctionReturn(0); 4242d747510SLisandro Dalcin } 4252d747510SLisandro Dalcin 4262d747510SLisandro Dalcin /*@C 4272d747510SLisandro Dalcin PetscGetProgramName - Gets the name of the running program. 4282d747510SLisandro Dalcin 4292d747510SLisandro Dalcin Not Collective 4302d747510SLisandro Dalcin 4312d747510SLisandro Dalcin Input Parameter: 4322d747510SLisandro Dalcin . len - length of the string name 4332d747510SLisandro Dalcin 4342d747510SLisandro Dalcin Output Parameter: 4352d747510SLisandro Dalcin . name - the name of the running program 4362d747510SLisandro Dalcin 4372d747510SLisandro Dalcin Level: advanced 4382d747510SLisandro Dalcin 4392d747510SLisandro Dalcin Notes: 4402d747510SLisandro Dalcin The name of the program is copied into the user-provided character 4412d747510SLisandro Dalcin array of length len. On some machines the program name includes 4422d747510SLisandro Dalcin its entire path, so one should generally set len >= PETSC_MAX_PATH_LEN. 4432d747510SLisandro Dalcin @*/ 4442d747510SLisandro Dalcin PetscErrorCode PetscGetProgramName(char name[],size_t len) 4452d747510SLisandro Dalcin { 4462d747510SLisandro Dalcin PetscFunctionBegin; 4479566063dSJacob Faibussowitsch PetscCall(PetscStrncpy(name,programname,len)); 4482d747510SLisandro Dalcin PetscFunctionReturn(0); 4492d747510SLisandro Dalcin } 4502d747510SLisandro Dalcin 451e5c89e4eSSatish Balay /*@C 452e5c89e4eSSatish Balay PetscGetArgs - Allows you to access the raw command line arguments anywhere 453e5c89e4eSSatish Balay after PetscInitialize() is called but before PetscFinalize(). 454e5c89e4eSSatish Balay 455e5c89e4eSSatish Balay Not Collective 456e5c89e4eSSatish Balay 457e5c89e4eSSatish Balay Output Parameters: 458e5c89e4eSSatish Balay + argc - count of number of command line arguments 459e5c89e4eSSatish Balay - args - the command line arguments 460e5c89e4eSSatish Balay 461e5c89e4eSSatish Balay Level: intermediate 462e5c89e4eSSatish Balay 463e5c89e4eSSatish Balay Notes: 464e5c89e4eSSatish Balay This is usually used to pass the command line arguments into other libraries 465e5c89e4eSSatish Balay that are called internally deep in PETSc or the application. 466e5c89e4eSSatish Balay 467f177e3b1SBarry Smith The first argument contains the program name as is normal for C arguments. 468f177e3b1SBarry Smith 469793721a6SBarry Smith .seealso: PetscFinalize(), PetscInitializeFortran(), PetscGetArguments() 470e5c89e4eSSatish Balay 471e5c89e4eSSatish Balay @*/ 4727087cfbeSBarry Smith PetscErrorCode PetscGetArgs(int *argc,char ***args) 473e5c89e4eSSatish Balay { 474e5c89e4eSSatish Balay PetscFunctionBegin; 47539a651e2SJacob Faibussowitsch PetscCheck(PetscInitializeCalled || !PetscFinalizeCalled,PETSC_COMM_SELF,PETSC_ERR_ORDER,"You must call after PetscInitialize() but before PetscFinalize()"); 476e5c89e4eSSatish Balay *argc = PetscGlobalArgc; 477e5c89e4eSSatish Balay *args = PetscGlobalArgs; 478e5c89e4eSSatish Balay PetscFunctionReturn(0); 479e5c89e4eSSatish Balay } 480e5c89e4eSSatish Balay 481793721a6SBarry Smith /*@C 482793721a6SBarry Smith PetscGetArguments - Allows you to access the command line arguments anywhere 483793721a6SBarry Smith after PetscInitialize() is called but before PetscFinalize(). 484793721a6SBarry Smith 485793721a6SBarry Smith Not Collective 486793721a6SBarry Smith 487793721a6SBarry Smith Output Parameters: 488793721a6SBarry Smith . args - the command line arguments 489793721a6SBarry Smith 490793721a6SBarry Smith Level: intermediate 491793721a6SBarry Smith 492793721a6SBarry Smith Notes: 493793721a6SBarry Smith This does NOT start with the program name and IS null terminated (final arg is void) 494793721a6SBarry Smith 495793721a6SBarry Smith .seealso: PetscFinalize(), PetscInitializeFortran(), PetscGetArgs(), PetscFreeArguments() 496793721a6SBarry Smith 497793721a6SBarry Smith @*/ 4987087cfbeSBarry Smith PetscErrorCode PetscGetArguments(char ***args) 499793721a6SBarry Smith { 500793721a6SBarry Smith PetscInt i,argc = PetscGlobalArgc; 501793721a6SBarry Smith 502793721a6SBarry Smith PetscFunctionBegin; 50339a651e2SJacob Faibussowitsch PetscCheck(PetscInitializeCalled || !PetscFinalizeCalled,PETSC_COMM_SELF,PETSC_ERR_ORDER,"You must call after PetscInitialize() but before PetscFinalize()"); 5042d747510SLisandro Dalcin if (!argc) {*args = NULL; PetscFunctionReturn(0);} 5059566063dSJacob Faibussowitsch PetscCall(PetscMalloc1(argc,args)); 5069566063dSJacob Faibussowitsch for (i=0; i<argc-1; i++) PetscCall(PetscStrallocpy(PetscGlobalArgs[i+1],&(*args)[i])); 5072d747510SLisandro Dalcin (*args)[argc-1] = NULL; 508793721a6SBarry Smith PetscFunctionReturn(0); 509793721a6SBarry Smith } 510793721a6SBarry Smith 511793721a6SBarry Smith /*@C 512793721a6SBarry Smith PetscFreeArguments - Frees the memory obtained with PetscGetArguments() 513793721a6SBarry Smith 514793721a6SBarry Smith Not Collective 515793721a6SBarry Smith 516793721a6SBarry Smith Output Parameters: 517793721a6SBarry Smith . args - the command line arguments 518793721a6SBarry Smith 519793721a6SBarry Smith Level: intermediate 520793721a6SBarry Smith 521793721a6SBarry Smith .seealso: PetscFinalize(), PetscInitializeFortran(), PetscGetArgs(), PetscGetArguments() 522793721a6SBarry Smith 523793721a6SBarry Smith @*/ 5247087cfbeSBarry Smith PetscErrorCode PetscFreeArguments(char **args) 525793721a6SBarry Smith { 52639a651e2SJacob Faibussowitsch PetscFunctionBegin; 52739a651e2SJacob Faibussowitsch if (args) { 528793721a6SBarry Smith PetscInt i = 0; 529793721a6SBarry Smith 5309566063dSJacob Faibussowitsch while (args[i]) PetscCall(PetscFree(args[i++])); 5319566063dSJacob Faibussowitsch PetscCall(PetscFree(args)); 53239a651e2SJacob Faibussowitsch } 533793721a6SBarry Smith PetscFunctionReturn(0); 534793721a6SBarry Smith } 535793721a6SBarry Smith 53627104ee2SJacob Faibussowitsch #if PetscDefined(HAVE_SAWS) 53730befbd2SBarry Smith #include <petscconfiginfo.h> 53830befbd2SBarry Smith 53995c0884eSLisandro Dalcin PETSC_INTERN PetscErrorCode PetscInitializeSAWs(const char help[]) 54011525c0dSBarry Smith { 54127104ee2SJacob Faibussowitsch PetscFunctionBegin; 54211525c0dSBarry Smith if (!PetscGlobalRank) { 54330befbd2SBarry Smith char cert[PETSC_MAX_PATH_LEN],root[PETSC_MAX_PATH_LEN],*intro,programname[64],*appline,*options,version[64]; 54411525c0dSBarry Smith int port; 545ffbd1cfbSBarry Smith PetscBool flg,rootlocal = PETSC_FALSE,flg2,selectport = PETSC_FALSE; 54611525c0dSBarry Smith size_t applinelen,introlen; 547ffbd1cfbSBarry Smith char sawsurl[256]; 54811525c0dSBarry Smith 5499566063dSJacob Faibussowitsch PetscCall(PetscOptionsHasName(NULL,NULL,"-saws_log",&flg)); 55011525c0dSBarry Smith if (flg) { 55111525c0dSBarry Smith char sawslog[PETSC_MAX_PATH_LEN]; 55211525c0dSBarry Smith 5539566063dSJacob Faibussowitsch PetscCall(PetscOptionsGetString(NULL,NULL,"-saws_log",sawslog,sizeof(sawslog),NULL)); 55411525c0dSBarry Smith if (sawslog[0]) { 55511525c0dSBarry Smith PetscStackCallSAWs(SAWs_Set_Use_Logfile,(sawslog)); 55611525c0dSBarry Smith } else { 55711525c0dSBarry Smith PetscStackCallSAWs(SAWs_Set_Use_Logfile,(NULL)); 55811525c0dSBarry Smith } 55911525c0dSBarry Smith } 5609566063dSJacob Faibussowitsch PetscCall(PetscOptionsGetString(NULL,NULL,"-saws_https",cert,sizeof(cert),&flg)); 56111525c0dSBarry Smith if (flg) { 56211525c0dSBarry Smith PetscStackCallSAWs(SAWs_Set_Use_HTTPS,(cert)); 56311525c0dSBarry Smith } 5649566063dSJacob Faibussowitsch PetscCall(PetscOptionsGetBool(NULL,NULL,"-saws_port_auto_select",&selectport,NULL)); 565ffbd1cfbSBarry Smith if (selectport) { 566ffbd1cfbSBarry Smith PetscStackCallSAWs(SAWs_Get_Available_Port,(&port)); 567ffbd1cfbSBarry Smith PetscStackCallSAWs(SAWs_Set_Port,(port)); 568ffbd1cfbSBarry Smith } else { 5699566063dSJacob Faibussowitsch PetscCall(PetscOptionsGetInt(NULL,NULL,"-saws_port",&port,&flg)); 57011525c0dSBarry Smith if (flg) { 57111525c0dSBarry Smith PetscStackCallSAWs(SAWs_Set_Port,(port)); 57211525c0dSBarry Smith } 573ffbd1cfbSBarry Smith } 5749566063dSJacob Faibussowitsch PetscCall(PetscOptionsGetString(NULL,NULL,"-saws_root",root,sizeof(root),&flg)); 57511525c0dSBarry Smith if (flg) { 5762f613bf5SBarry Smith PetscStackCallSAWs(SAWs_Set_Document_Root,(root)); 5779566063dSJacob Faibussowitsch PetscCall(PetscStrcmp(root,".",&rootlocal)); 5789c1e0ce8SBarry Smith } else { 5799566063dSJacob Faibussowitsch PetscCall(PetscOptionsHasName(NULL,NULL,"-saws_options",&flg)); 5809c1e0ce8SBarry Smith if (flg) { 5819566063dSJacob Faibussowitsch PetscCall(PetscStrreplace(PETSC_COMM_WORLD,"${PETSC_DIR}/share/petsc/saws",root,sizeof(root))); 5822f613bf5SBarry Smith PetscStackCallSAWs(SAWs_Set_Document_Root,(root)); 5839c1e0ce8SBarry Smith } 58411525c0dSBarry Smith } 5859566063dSJacob Faibussowitsch PetscCall(PetscOptionsHasName(NULL,NULL,"-saws_local",&flg2)); 58611525c0dSBarry Smith if (flg2) { 58711525c0dSBarry Smith char jsdir[PETSC_MAX_PATH_LEN]; 58828b400f6SJacob Faibussowitsch PetscCheck(flg,PETSC_COMM_SELF,PETSC_ERR_SUP,"-saws_local option requires -saws_root option"); 5899566063dSJacob Faibussowitsch PetscCall(PetscSNPrintf(jsdir,sizeof(jsdir),"%s/js",root)); 5909566063dSJacob Faibussowitsch PetscCall(PetscTestDirectory(jsdir,'r',&flg)); 59128b400f6SJacob Faibussowitsch PetscCheck(flg,PETSC_COMM_SELF,PETSC_ERR_FILE_READ,"-saws_local option requires js directory in root directory"); 5922f613bf5SBarry Smith PetscStackCallSAWs(SAWs_Push_Local_Header,()); 59311525c0dSBarry Smith } 5949566063dSJacob Faibussowitsch PetscCall(PetscGetProgramName(programname,sizeof(programname))); 5959566063dSJacob Faibussowitsch PetscCall(PetscStrlen(help,&applinelen)); 59611525c0dSBarry Smith introlen = 4096 + applinelen; 59730a8c9c0SSurtai Han applinelen += 1024; 5989566063dSJacob Faibussowitsch PetscCall(PetscMalloc(applinelen,&appline)); 5999566063dSJacob Faibussowitsch PetscCall(PetscMalloc(introlen,&intro)); 60011525c0dSBarry Smith 60111525c0dSBarry Smith if (rootlocal) { 6029566063dSJacob Faibussowitsch PetscCall(PetscSNPrintf(appline,applinelen,"%s.c.html",programname)); 6039566063dSJacob Faibussowitsch PetscCall(PetscTestFile(appline,'r',&rootlocal)); 60411525c0dSBarry Smith } 6059566063dSJacob Faibussowitsch PetscCall(PetscOptionsGetAll(NULL,&options)); 60611525c0dSBarry Smith if (rootlocal && help) { 6079566063dSJacob Faibussowitsch PetscCall(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)); 60811525c0dSBarry Smith } else if (help) { 6099566063dSJacob Faibussowitsch PetscCall(PetscSNPrintf(appline,applinelen,"<center>Running %s %s</center><br><center><pre>%s</pre></center><br>",programname,options,help)); 61011525c0dSBarry Smith } else { 6119566063dSJacob Faibussowitsch PetscCall(PetscSNPrintf(appline,applinelen,"<center> Running %s %s</center><br>\n",programname,options)); 61211525c0dSBarry Smith } 6139566063dSJacob Faibussowitsch PetscCall(PetscFree(options)); 6149566063dSJacob Faibussowitsch PetscCall(PetscGetVersion(version,sizeof(version))); 6159566063dSJacob Faibussowitsch PetscCall(PetscSNPrintf(intro,introlen,"<body>\n" 616a17b96a8SKyle 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" 617df62c222SBarry 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" 6185f80ce2aSJacob Faibussowitsch "%s",version,petscconfigureoptions,appline)); 61943da4ab2SBarry Smith PetscStackCallSAWs(SAWs_Push_Body,("index.html",0,intro)); 6209566063dSJacob Faibussowitsch PetscCall(PetscFree(intro)); 6219566063dSJacob Faibussowitsch PetscCall(PetscFree(appline)); 622ffbd1cfbSBarry Smith if (selectport) { 623aa573868SBarry Smith PetscBool silent; 6247d812c46SBarry Smith 6257d812c46SBarry Smith /* another process may have grabbed the port so keep trying */ 62639a651e2SJacob Faibussowitsch while (SAWs_Initialize()) { 6277d812c46SBarry Smith PetscStackCallSAWs(SAWs_Get_Available_Port,(&port)); 6287d812c46SBarry Smith PetscStackCallSAWs(SAWs_Set_Port,(port)); 6297d812c46SBarry Smith } 6307d812c46SBarry Smith 6319566063dSJacob Faibussowitsch PetscCall(PetscOptionsGetBool(NULL,NULL,"-saws_port_auto_select_silent",&silent,NULL)); 632aa573868SBarry Smith if (!silent) { 633ffbd1cfbSBarry Smith PetscStackCallSAWs(SAWs_Get_FullURL,(sizeof(sawsurl),sawsurl)); 6349566063dSJacob Faibussowitsch PetscCall(PetscPrintf(PETSC_COMM_WORLD,"Point your browser to %s for SAWs\n",sawsurl)); 635ffbd1cfbSBarry Smith } 6367d812c46SBarry Smith } else { 6377d812c46SBarry Smith PetscStackCallSAWs(SAWs_Initialize,()); 638aa573868SBarry Smith } 6399566063dSJacob Faibussowitsch PetscCall(PetscCitationsRegister("@TechReport{ saws,\n" 6400af79b04SBarry Smith " Author = {Matt Otten and Jed Brown and Barry Smith},\n" 6410af79b04SBarry Smith " Title = {Scientific Application Web Server (SAWs) Users Manual},\n" 6420af79b04SBarry Smith " Institution = {Argonne National Laboratory},\n" 6435f80ce2aSJacob Faibussowitsch " Year = 2013\n}\n",NULL)); 64411525c0dSBarry Smith } 64511525c0dSBarry Smith PetscFunctionReturn(0); 64611525c0dSBarry Smith } 64711525c0dSBarry Smith #endif 64811525c0dSBarry Smith 6494dfee713SSatish Balay /* Things must be done before MPI_Init() when MPI is not yet initialized, and can be shared between C init and Fortran init */ 6504dfee713SSatish Balay PETSC_INTERN PetscErrorCode PetscPreMPIInit_Private(void) 6514dfee713SSatish Balay { 6524dfee713SSatish Balay PetscFunctionBegin; 6534dfee713SSatish Balay #if defined(PETSC_HAVE_HWLOC_SOLARIS_BUG) 6544dfee713SSatish Balay /* see MPI.py for details on this bug */ 6554dfee713SSatish Balay (void) setenv("HWLOC_COMPONENTS","-x86",1); 6564dfee713SSatish Balay #endif 6574dfee713SSatish Balay PetscFunctionReturn(0); 6584dfee713SSatish Balay } 6594dfee713SSatish Balay 660a4af0ceeSJacob Faibussowitsch #if PetscDefined(HAVE_ADIOS) 661a56f64adSBarry Smith #include <adios.h> 66222580e64SBarry Smith #include <adios_read.h> 6637b56e58cSSatish Balay int64_t Petsc_adios_group; 664a56f64adSBarry Smith #endif 665a4af0ceeSJacob Faibussowitsch #if PetscDefined(HAVE_OPENMP) 666cd1b99a6SBarry Smith #include <omp.h> 667f90b075cSBarry Smith PetscInt PetscNumOMPThreads; 668cd1b99a6SBarry Smith #endif 669a56f64adSBarry Smith 670a4af0ceeSJacob Faibussowitsch #if PetscDefined(HAVE_DEVICE) 671a4af0ceeSJacob Faibussowitsch #include <petsc/private/deviceimpl.h> 672a4af0ceeSJacob Faibussowitsch # if PetscDefined(HAVE_CUDA) 673a4af0ceeSJacob Faibussowitsch // REMOVE ME 674a4af0ceeSJacob Faibussowitsch cudaStream_t PetscDefaultCudaStream = NULL; 675a4af0ceeSJacob Faibussowitsch # endif 676a4af0ceeSJacob Faibussowitsch # if PetscDefined(HAVE_HIP) 677a4af0ceeSJacob Faibussowitsch // REMOVE ME 678a4af0ceeSJacob Faibussowitsch hipStream_t PetscDefaultHipStream = NULL; 679a4af0ceeSJacob Faibussowitsch # endif 680a4af0ceeSJacob Faibussowitsch #endif 681a4af0ceeSJacob Faibussowitsch 68227104ee2SJacob Faibussowitsch #if PetscDefined(HAVE_DLFCN_H) 683bc8a24ecSBarry Smith #include <dlfcn.h> 684bc8a24ecSBarry Smith #endif 685a4af0ceeSJacob Faibussowitsch #if PetscDefined(USE_LOG) 686a4af0ceeSJacob Faibussowitsch PETSC_INTERN PetscErrorCode PetscLogInitialize(void); 687a4af0ceeSJacob Faibussowitsch #endif 688a4af0ceeSJacob Faibussowitsch #if PetscDefined(HAVE_VIENNACL) 689a4af0ceeSJacob Faibussowitsch PETSC_EXTERN PetscErrorCode PetscViennaCLInit(); 690a4af0ceeSJacob Faibussowitsch PetscBool PetscViennaCLSynchronize = PETSC_FALSE; 691a4af0ceeSJacob Faibussowitsch #endif 692bc8a24ecSBarry Smith 69385649d77SJunchao Zhang /* 69485649d77SJunchao Zhang PetscInitialize_Common - shared code between C and Fortran initialization 69585649d77SJunchao Zhang 69685649d77SJunchao Zhang prog: program name 69702101c96SSatish Balay file: optional PETSc database file name. Might be in Fortran string format when 'ftn' is true 69885649d77SJunchao Zhang help: program help message 69902101c96SSatish Balay ftn: is it called from Fortran initilization (petscinitializef_)? 70085649d77SJunchao Zhang readarguments,len: used when fortran is true 70185649d77SJunchao Zhang */ 70202101c96SSatish Balay PETSC_INTERN PetscErrorCode PetscInitialize_Common(const char* prog,const char* file,const char *help,PetscBool ftn,PetscBool readarguments,PetscInt len) 70385649d77SJunchao Zhang { 70485649d77SJunchao Zhang PetscMPIInt size; 70585649d77SJunchao Zhang PetscBool flg = PETSC_TRUE; 70685649d77SJunchao Zhang char hostname[256]; 70785649d77SJunchao Zhang 70827104ee2SJacob Faibussowitsch PetscFunctionBegin; 70927104ee2SJacob Faibussowitsch if (PetscInitializeCalled) PetscFunctionReturn(0); 71039a651e2SJacob Faibussowitsch /* these must be initialized in a routine, not as a constant declaration */ 71139a651e2SJacob Faibussowitsch PETSC_STDOUT = stdout; 71239a651e2SJacob Faibussowitsch PETSC_STDERR = stderr; 71339a651e2SJacob Faibussowitsch 7149566063dSJacob Faibussowitsch /* PetscCall can be used from now */ 71539a651e2SJacob Faibussowitsch PetscErrorHandlingInitialized = PETSC_TRUE; 71639a651e2SJacob Faibussowitsch 71785649d77SJunchao Zhang /* 71885649d77SJunchao Zhang The checking over compatible runtime libraries is complicated by the MPI ABI initiative 71985649d77SJunchao Zhang https://wiki.mpich.org/mpich/index.php/ABI_Compatibility_Initiative which started with 72085649d77SJunchao Zhang MPICH v3.1 (Released February 2014) 72185649d77SJunchao Zhang IBM MPI v2.1 (December 2014) 72285649d77SJunchao Zhang Intel MPI Library v5.0 (2014) 72385649d77SJunchao Zhang Cray MPT v7.0.0 (June 2014) 72485649d77SJunchao Zhang As of July 31, 2017 the ABI number still appears to be 12, that is all of the versions 72585649d77SJunchao Zhang listed above and since that time are compatible. 72685649d77SJunchao Zhang 72785649d77SJunchao Zhang Unfortunately the MPI ABI initiative has not defined a way to determine the ABI number 72885649d77SJunchao Zhang at compile time or runtime. Thus we will need to systematically track the allowed versions 72985649d77SJunchao Zhang and how they are represented in the mpi.h and MPI_Get_library_version() output in order 73085649d77SJunchao Zhang to perform the checking. 73185649d77SJunchao Zhang 73285649d77SJunchao Zhang Currently we only check for pre MPI ABI versions (and packages that do not follow the MPI ABI). 73385649d77SJunchao Zhang 73485649d77SJunchao Zhang Questions: 73585649d77SJunchao Zhang 73685649d77SJunchao Zhang Should the checks for ABI incompatibility be only on the major version number below? 73785649d77SJunchao Zhang Presumably the output to stderr will be removed before a release. 73885649d77SJunchao Zhang */ 73985649d77SJunchao Zhang 74085649d77SJunchao Zhang #if defined(PETSC_HAVE_MPI_GET_LIBRARY_VERSION) 74185649d77SJunchao Zhang { 74285649d77SJunchao Zhang char mpilibraryversion[MPI_MAX_LIBRARY_VERSION_STRING]; 74385649d77SJunchao Zhang PetscMPIInt mpilibraryversionlength; 74439a651e2SJacob Faibussowitsch 7459566063dSJacob Faibussowitsch PetscCallMPI(MPI_Get_library_version(mpilibraryversion,&mpilibraryversionlength)); 74685649d77SJunchao Zhang /* check for MPICH versions before MPI ABI initiative */ 74785649d77SJunchao Zhang #if defined(MPICH_VERSION) 74885649d77SJunchao Zhang #if MPICH_NUMVERSION < 30100000 74985649d77SJunchao Zhang { 75085649d77SJunchao Zhang char *ver,*lf; 75185649d77SJunchao Zhang PetscBool flg = PETSC_FALSE; 75239a651e2SJacob Faibussowitsch 7539566063dSJacob Faibussowitsch PetscCall(PetscStrstr(mpilibraryversion,"MPICH Version:",&ver)); 75439a651e2SJacob Faibussowitsch if (ver) { 7559566063dSJacob Faibussowitsch PetscCall(PetscStrchr(ver,'\n',&lf)); 75639a651e2SJacob Faibussowitsch if (lf) { 75785649d77SJunchao Zhang *lf = 0; 7589566063dSJacob Faibussowitsch PetscCall(PetscStrendswith(ver,MPICH_VERSION,&flg)); 75985649d77SJunchao Zhang } 76085649d77SJunchao Zhang } 76185649d77SJunchao Zhang if (!flg) { 7629566063dSJacob Faibussowitsch PetscCall(PetscInfo(NULL,"PETSc warning --- MPICH library version \n%s does not match what PETSc was compiled with %s.\n",mpilibraryversion,MPICH_VESION)); 76385649d77SJunchao Zhang flg = PETSC_TRUE; 76485649d77SJunchao Zhang } 76585649d77SJunchao Zhang } 76685649d77SJunchao Zhang #endif 76785649d77SJunchao 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?) */ 76885649d77SJunchao Zhang #elif defined(OMPI_MAJOR_VERSION) 76985649d77SJunchao Zhang { 77085649d77SJunchao Zhang char *ver,bs[MPI_MAX_LIBRARY_VERSION_STRING],*bsf; 77185649d77SJunchao Zhang PetscBool flg = PETSC_FALSE; 77285649d77SJunchao Zhang #define PSTRSZ 2 77385649d77SJunchao Zhang char ompistr1[PSTRSZ][MPI_MAX_LIBRARY_VERSION_STRING] = {"Open MPI","FUJITSU MPI"}; 77485649d77SJunchao Zhang char ompistr2[PSTRSZ][MPI_MAX_LIBRARY_VERSION_STRING] = {"v","Library "}; 77585649d77SJunchao Zhang int i; 77685649d77SJunchao Zhang for (i=0; i<PSTRSZ; i++) { 7779566063dSJacob Faibussowitsch PetscCall(PetscStrstr(mpilibraryversion,ompistr1[i],&ver)); 77839a651e2SJacob Faibussowitsch if (ver) { 7799566063dSJacob Faibussowitsch PetscCall(PetscSNPrintf(bs,MPI_MAX_LIBRARY_VERSION_STRING,"%s%d.%d",ompistr2[i],OMPI_MAJOR_VERSION,OMPI_MINOR_VERSION)); 7809566063dSJacob Faibussowitsch PetscCall(PetscStrstr(ver,bs,&bsf)); 78139a651e2SJacob Faibussowitsch if (bsf) flg = PETSC_TRUE; 78285649d77SJunchao Zhang break; 78385649d77SJunchao Zhang } 78485649d77SJunchao Zhang } 78585649d77SJunchao Zhang if (!flg) { 7867d3de750SJacob 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); 78785649d77SJunchao Zhang flg = PETSC_TRUE; 78885649d77SJunchao Zhang } 78985649d77SJunchao Zhang } 79085649d77SJunchao Zhang #endif 79185649d77SJunchao Zhang } 79285649d77SJunchao Zhang #endif 79385649d77SJunchao Zhang 79439a651e2SJacob Faibussowitsch #if PetscDefined(HAVE_DLSYM) 79585649d77SJunchao 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 */ 79639a651e2SJacob 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"); 79785649d77SJunchao Zhang #endif 79885649d77SJunchao Zhang 79985649d77SJunchao Zhang /* on Windows - set printf to default to printing 2 digit exponents */ 80085649d77SJunchao Zhang #if defined(PETSC_HAVE__SET_OUTPUT_FORMAT) 80185649d77SJunchao Zhang _set_output_format(_TWO_DIGIT_EXPONENT); 80285649d77SJunchao Zhang #endif 80385649d77SJunchao Zhang 8049566063dSJacob Faibussowitsch PetscCall(PetscOptionsCreateDefault()); 80585649d77SJunchao Zhang 80685649d77SJunchao Zhang PetscFinalizeCalled = PETSC_FALSE; 80785649d77SJunchao Zhang 8089566063dSJacob Faibussowitsch PetscCall(PetscSetProgramName(prog)); 8099566063dSJacob Faibussowitsch PetscCall(PetscSpinlockCreate(&PetscViewerASCIISpinLockOpen)); 8109566063dSJacob Faibussowitsch PetscCall(PetscSpinlockCreate(&PetscViewerASCIISpinLockStdout)); 8119566063dSJacob Faibussowitsch PetscCall(PetscSpinlockCreate(&PetscViewerASCIISpinLockStderr)); 8129566063dSJacob Faibussowitsch PetscCall(PetscSpinlockCreate(&PetscCommSpinLock)); 81385649d77SJunchao Zhang 81485649d77SJunchao Zhang if (PETSC_COMM_WORLD == MPI_COMM_NULL) PETSC_COMM_WORLD = MPI_COMM_WORLD; 8159566063dSJacob Faibussowitsch PetscCallMPI(MPI_Comm_set_errhandler(PETSC_COMM_WORLD,MPI_ERRORS_RETURN)); 81685649d77SJunchao Zhang 81785649d77SJunchao Zhang if (PETSC_MPI_ERROR_CLASS == MPI_ERR_LASTCODE) { 8189566063dSJacob Faibussowitsch PetscCallMPI(MPI_Add_error_class(&PETSC_MPI_ERROR_CLASS)); 8199566063dSJacob Faibussowitsch PetscCallMPI(MPI_Add_error_code(PETSC_MPI_ERROR_CLASS,&PETSC_MPI_ERROR_CODE)); 82085649d77SJunchao Zhang } 82185649d77SJunchao Zhang 82285649d77SJunchao Zhang /* Done after init due to a bug in MPICH-GM? */ 8239566063dSJacob Faibussowitsch PetscCall(PetscErrorPrintfInitialize()); 82485649d77SJunchao Zhang 8259566063dSJacob Faibussowitsch PetscCallMPI(MPI_Comm_rank(MPI_COMM_WORLD,&PetscGlobalRank)); 8269566063dSJacob Faibussowitsch PetscCallMPI(MPI_Comm_size(MPI_COMM_WORLD,&PetscGlobalSize)); 82785649d77SJunchao Zhang 82885649d77SJunchao Zhang MPIU_BOOL = MPI_INT; 82985649d77SJunchao Zhang MPIU_ENUM = MPI_INT; 83085649d77SJunchao Zhang MPIU_FORTRANADDR = (sizeof(void*) == sizeof(int)) ? MPI_INT : MPIU_INT64; 83185649d77SJunchao Zhang if (sizeof(size_t) == sizeof(unsigned)) MPIU_SIZE_T = MPI_UNSIGNED; 83285649d77SJunchao Zhang else if (sizeof(size_t) == sizeof(unsigned long)) MPIU_SIZE_T = MPI_UNSIGNED_LONG; 83385649d77SJunchao Zhang #if defined(PETSC_SIZEOF_LONG_LONG) 83485649d77SJunchao Zhang else if (sizeof(size_t) == sizeof(unsigned long long)) MPIU_SIZE_T = MPI_UNSIGNED_LONG_LONG; 83585649d77SJunchao Zhang #endif 83639a651e2SJacob Faibussowitsch else SETERRQ(PETSC_COMM_WORLD,PETSC_ERR_SUP_SYS,"Could not find MPI type for size_t"); 83785649d77SJunchao Zhang 83885649d77SJunchao Zhang /* 83985649d77SJunchao Zhang Initialized the global complex variable; this is because with 84085649d77SJunchao Zhang shared libraries the constructors for global variables 84185649d77SJunchao Zhang are not called; at least on IRIX. 84285649d77SJunchao Zhang */ 84385649d77SJunchao Zhang #if defined(PETSC_HAVE_COMPLEX) 84485649d77SJunchao Zhang { 84585649d77SJunchao Zhang #if defined(PETSC_CLANGUAGE_CXX) && !defined(PETSC_USE_REAL___FLOAT128) 84685649d77SJunchao Zhang PetscComplex ic(0.0,1.0); 84785649d77SJunchao Zhang PETSC_i = ic; 84885649d77SJunchao Zhang #else 84985649d77SJunchao Zhang PETSC_i = _Complex_I; 85085649d77SJunchao Zhang #endif 85185649d77SJunchao Zhang } 85285649d77SJunchao Zhang #endif /* PETSC_HAVE_COMPLEX */ 85385649d77SJunchao Zhang 85485649d77SJunchao Zhang /* 85585649d77SJunchao Zhang Create the PETSc MPI reduction operator that sums of the first 85685649d77SJunchao Zhang half of the entries and maxes the second half. 85785649d77SJunchao Zhang */ 8589566063dSJacob Faibussowitsch PetscCallMPI(MPI_Op_create(MPIU_MaxSum_Local,1,&MPIU_MAXSUM_OP)); 85985649d77SJunchao Zhang 86085649d77SJunchao Zhang #if defined(PETSC_USE_REAL___FLOAT128) 8619566063dSJacob Faibussowitsch PetscCallMPI(MPI_Type_contiguous(2,MPI_DOUBLE,&MPIU___FLOAT128)); 8629566063dSJacob Faibussowitsch PetscCallMPI(MPI_Type_commit(&MPIU___FLOAT128)); 86385649d77SJunchao Zhang #if defined(PETSC_HAVE_COMPLEX) 8649566063dSJacob Faibussowitsch PetscCallMPI(MPI_Type_contiguous(4,MPI_DOUBLE,&MPIU___COMPLEX128)); 8659566063dSJacob Faibussowitsch PetscCallMPI(MPI_Type_commit(&MPIU___COMPLEX128)); 86685649d77SJunchao Zhang #endif 8679566063dSJacob Faibussowitsch PetscCallMPI(MPI_Op_create(PetscMax_Local,1,&MPIU_MAX)); 8689566063dSJacob Faibussowitsch PetscCallMPI(MPI_Op_create(PetscMin_Local,1,&MPIU_MIN)); 86985649d77SJunchao Zhang #elif defined(PETSC_USE_REAL___FP16) 8709566063dSJacob Faibussowitsch PetscCallMPI(MPI_Type_contiguous(2,MPI_CHAR,&MPIU___FP16)); 8719566063dSJacob Faibussowitsch PetscCallMPI(MPI_Type_commit(&MPIU___FP16)); 8729566063dSJacob Faibussowitsch PetscCallMPI(MPI_Op_create(PetscMax_Local,1,&MPIU_MAX)); 8739566063dSJacob Faibussowitsch PetscCallMPI(MPI_Op_create(PetscMin_Local,1,&MPIU_MIN)); 87485649d77SJunchao Zhang #endif 87585649d77SJunchao Zhang 87685649d77SJunchao Zhang #if defined(PETSC_USE_REAL___FLOAT128) || defined(PETSC_USE_REAL___FP16) 8779566063dSJacob Faibussowitsch PetscCallMPI(MPI_Op_create(PetscSum_Local,1,&MPIU_SUM)); 87885649d77SJunchao Zhang #endif 87985649d77SJunchao Zhang 8809566063dSJacob Faibussowitsch PetscCallMPI(MPI_Type_contiguous(2,MPIU_SCALAR,&MPIU_2SCALAR)); 8819566063dSJacob Faibussowitsch PetscCallMPI(MPI_Type_commit(&MPIU_2SCALAR)); 88285649d77SJunchao Zhang 88385649d77SJunchao Zhang /* create datatypes used by MPIU_MAXLOC, MPIU_MINLOC and PetscSplitReduction_Op */ 88485649d77SJunchao Zhang #if !defined(PETSC_HAVE_MPIUNI) 88585649d77SJunchao Zhang { 88685649d77SJunchao Zhang struct PetscRealInt { PetscReal v; PetscInt i; }; 88785649d77SJunchao Zhang PetscMPIInt blockSizes[2] = {1,1}; 88885649d77SJunchao Zhang MPI_Aint blockOffsets[2] = {offsetof(struct PetscRealInt,v),offsetof(struct PetscRealInt,i)}; 88985649d77SJunchao Zhang MPI_Datatype blockTypes[2] = {MPIU_REAL,MPIU_INT}, tmpStruct; 89085649d77SJunchao Zhang 8919566063dSJacob Faibussowitsch PetscCallMPI(MPI_Type_create_struct(2,blockSizes,blockOffsets,blockTypes,&tmpStruct)); 8929566063dSJacob Faibussowitsch PetscCallMPI(MPI_Type_create_resized(tmpStruct,0,sizeof(struct PetscRealInt),&MPIU_REAL_INT)); 8939566063dSJacob Faibussowitsch PetscCallMPI(MPI_Type_free(&tmpStruct)); 8949566063dSJacob Faibussowitsch PetscCallMPI(MPI_Type_commit(&MPIU_REAL_INT)); 89585649d77SJunchao Zhang } 89685649d77SJunchao Zhang { 89785649d77SJunchao Zhang struct PetscScalarInt { PetscScalar v; PetscInt i; }; 89885649d77SJunchao Zhang PetscMPIInt blockSizes[2] = {1,1}; 89985649d77SJunchao Zhang MPI_Aint blockOffsets[2] = {offsetof(struct PetscScalarInt,v),offsetof(struct PetscScalarInt,i)}; 90085649d77SJunchao Zhang MPI_Datatype blockTypes[2] = {MPIU_SCALAR,MPIU_INT}, tmpStruct; 90185649d77SJunchao Zhang 9029566063dSJacob Faibussowitsch PetscCallMPI(MPI_Type_create_struct(2,blockSizes,blockOffsets,blockTypes,&tmpStruct)); 9039566063dSJacob Faibussowitsch PetscCallMPI(MPI_Type_create_resized(tmpStruct,0,sizeof(struct PetscScalarInt),&MPIU_SCALAR_INT)); 9049566063dSJacob Faibussowitsch PetscCallMPI(MPI_Type_free(&tmpStruct)); 9059566063dSJacob Faibussowitsch PetscCallMPI(MPI_Type_commit(&MPIU_SCALAR_INT)); 90685649d77SJunchao Zhang } 90785649d77SJunchao Zhang #endif 90885649d77SJunchao Zhang 90985649d77SJunchao Zhang #if defined(PETSC_USE_64BIT_INDICES) 9109566063dSJacob Faibussowitsch PetscCallMPI(MPI_Type_contiguous(2,MPIU_INT,&MPIU_2INT)); 9119566063dSJacob Faibussowitsch PetscCallMPI(MPI_Type_commit(&MPIU_2INT)); 91285649d77SJunchao Zhang #endif 9139566063dSJacob Faibussowitsch PetscCallMPI(MPI_Type_contiguous(4,MPI_INT,&MPI_4INT)); 9149566063dSJacob Faibussowitsch PetscCallMPI(MPI_Type_commit(&MPI_4INT)); 9159566063dSJacob Faibussowitsch PetscCallMPI(MPI_Type_contiguous(4,MPIU_INT,&MPIU_4INT)); 9169566063dSJacob Faibussowitsch PetscCallMPI(MPI_Type_commit(&MPIU_4INT)); 91785649d77SJunchao Zhang 91885649d77SJunchao Zhang /* 91985649d77SJunchao Zhang Attributes to be set on PETSc communicators 92085649d77SJunchao Zhang */ 9219566063dSJacob Faibussowitsch PetscCallMPI(MPI_Comm_create_keyval(MPI_COMM_NULL_COPY_FN,Petsc_Counter_Attr_Delete_Fn,&Petsc_Counter_keyval,(void*)0)); 9229566063dSJacob Faibussowitsch PetscCallMPI(MPI_Comm_create_keyval(MPI_COMM_NULL_COPY_FN,Petsc_InnerComm_Attr_Delete_Fn,&Petsc_InnerComm_keyval,(void*)0)); 9239566063dSJacob Faibussowitsch PetscCallMPI(MPI_Comm_create_keyval(MPI_COMM_NULL_COPY_FN,Petsc_OuterComm_Attr_Delete_Fn,&Petsc_OuterComm_keyval,(void*)0)); 9249566063dSJacob Faibussowitsch PetscCallMPI(MPI_Comm_create_keyval(MPI_COMM_NULL_COPY_FN,Petsc_ShmComm_Attr_Delete_Fn,&Petsc_ShmComm_keyval,(void*)0)); 92585649d77SJunchao Zhang 92685649d77SJunchao Zhang #if defined(PETSC_HAVE_FORTRAN) 9279566063dSJacob Faibussowitsch if (ftn) PetscCall(PetscInitFortran_Private(readarguments,file,len)); 92885649d77SJunchao Zhang else 92985649d77SJunchao Zhang #endif 9309566063dSJacob Faibussowitsch PetscCall(PetscOptionsInsert(NULL,&PetscGlobalArgc,&PetscGlobalArgs,file)); 93185649d77SJunchao Zhang 93285649d77SJunchao Zhang /* call a second time so it can look in the options database */ 9339566063dSJacob Faibussowitsch PetscCall(PetscErrorPrintfInitialize()); 93485649d77SJunchao Zhang 93585649d77SJunchao Zhang /* 93685649d77SJunchao Zhang Check system options and print help 93785649d77SJunchao Zhang */ 9389566063dSJacob Faibussowitsch PetscCall(PetscOptionsCheckInitial_Private(help)); 93985649d77SJunchao Zhang 940a4af0ceeSJacob Faibussowitsch /* 941a4af0ceeSJacob Faibussowitsch Initialize PetscDevice and PetscDeviceContext 942a4af0ceeSJacob Faibussowitsch 943a4af0ceeSJacob Faibussowitsch Note to any future devs thinking of moving this, proper initialization requires: 944a4af0ceeSJacob Faibussowitsch 1. MPI initialized 945a4af0ceeSJacob Faibussowitsch 2. Options DB initialized 946a4af0ceeSJacob Faibussowitsch 3. Petsc error handling initialized, specifically signal handlers. This expects to set up its own SIGSEV handler via 947a4af0ceeSJacob Faibussowitsch the push/pop interface. 948a4af0ceeSJacob Faibussowitsch */ 949a2158755SJunchao Zhang #if (PetscDefined(HAVE_CUDA) || PetscDefined(HAVE_HIP) || PetscDefined(HAVE_SYCL)) 9509566063dSJacob Faibussowitsch PetscCall(PetscDeviceInitializeFromOptions_Internal(PETSC_COMM_WORLD)); 951a4af0ceeSJacob Faibussowitsch #endif 952a4af0ceeSJacob Faibussowitsch 953a4af0ceeSJacob Faibussowitsch #if PetscDefined(HAVE_VIENNACL) 954a4af0ceeSJacob Faibussowitsch flg = PETSC_FALSE; 9559566063dSJacob Faibussowitsch PetscCall(PetscOptionsHasName(NULL,NULL,"-log_summary",&flg)); 9569566063dSJacob Faibussowitsch if (!flg) PetscCall(PetscOptionsHasName(NULL,NULL,"-log_view",&flg)); 9579566063dSJacob Faibussowitsch if (!flg) PetscCall(PetscOptionsGetBool(NULL,NULL,"-viennacl_synchronize",&flg,NULL)); 958a4af0ceeSJacob Faibussowitsch PetscViennaCLSynchronize = flg; 9599566063dSJacob Faibussowitsch PetscCall(PetscViennaCLInit()); 960a4af0ceeSJacob Faibussowitsch #endif 961a4af0ceeSJacob Faibussowitsch 962a4af0ceeSJacob Faibussowitsch /* 963a4af0ceeSJacob Faibussowitsch Creates the logging data structures; this is enabled even if logging is not turned on 964a4af0ceeSJacob Faibussowitsch This is the last thing we do before returning to the user code to prevent having the 965a4af0ceeSJacob Faibussowitsch logging numbers contaminated by any startup time associated with MPI 966a4af0ceeSJacob Faibussowitsch */ 967a4af0ceeSJacob Faibussowitsch #if defined(PETSC_USE_LOG) 9689566063dSJacob Faibussowitsch PetscCall(PetscLogInitialize()); 969a4af0ceeSJacob Faibussowitsch #endif 970a4af0ceeSJacob Faibussowitsch 9719566063dSJacob Faibussowitsch PetscCall(PetscCitationsInitialize()); 97285649d77SJunchao Zhang 97385649d77SJunchao Zhang #if defined(PETSC_HAVE_SAWS) 9749566063dSJacob Faibussowitsch PetscCall(PetscInitializeSAWs(ftn ? NULL : help)); 97527104ee2SJacob Faibussowitsch flg = PETSC_FALSE; 9769566063dSJacob Faibussowitsch PetscCall(PetscOptionsHasName(NULL,NULL,"-stack_view",&flg)); 9779566063dSJacob Faibussowitsch if (flg) PetscCall(PetscStackViewSAWs()); 97885649d77SJunchao Zhang #endif 97985649d77SJunchao Zhang 98085649d77SJunchao Zhang /* 98185649d77SJunchao Zhang Load the dynamic libraries (on machines that support them), this registers all 98285649d77SJunchao Zhang the solvers etc. (On non-dynamic machines this initializes the PetscDraw and PetscViewer classes) 98385649d77SJunchao Zhang */ 9849566063dSJacob Faibussowitsch PetscCall(PetscInitialize_DynamicLibraries()); 98585649d77SJunchao Zhang 9869566063dSJacob Faibussowitsch PetscCallMPI(MPI_Comm_size(PETSC_COMM_WORLD,&size)); 9879566063dSJacob Faibussowitsch PetscCall(PetscInfo(NULL,"PETSc successfully started: number of processors = %d\n",size)); 9889566063dSJacob Faibussowitsch PetscCall(PetscGetHostName(hostname,256)); 9899566063dSJacob Faibussowitsch PetscCall(PetscInfo(NULL,"Running on machine: %s\n",hostname)); 99085649d77SJunchao Zhang #if defined(PETSC_HAVE_OPENMP) 99185649d77SJunchao Zhang { 99285649d77SJunchao Zhang PetscBool omp_view_flag; 99385649d77SJunchao Zhang char *threads = getenv("OMP_NUM_THREADS"); 9945f80ce2aSJacob Faibussowitsch PetscErrorCode ierr; 99585649d77SJunchao Zhang 99685649d77SJunchao Zhang if (threads) { 9979566063dSJacob Faibussowitsch PetscCall(PetscInfo(NULL,"Number of OpenMP threads %s (as given by OMP_NUM_THREADS)\n",threads)); 99885649d77SJunchao Zhang (void) sscanf(threads, "%" PetscInt_FMT,&PetscNumOMPThreads); 99985649d77SJunchao Zhang } else { 10002f840973SStefano Zampini PetscNumOMPThreads = (PetscInt) omp_get_max_threads(); 10019566063dSJacob Faibussowitsch PetscCall(PetscInfo(NULL,"Number of OpenMP threads %" PetscInt_FMT " (as given by omp_get_max_threads())\n",PetscNumOMPThreads)); 100285649d77SJunchao Zhang } 10039566063dSJacob Faibussowitsch ierr = PetscOptionsBegin(PETSC_COMM_WORLD,NULL,"OpenMP options","Sys");PetscCall(ierr); 10049566063dSJacob Faibussowitsch PetscCall(PetscOptionsInt("-omp_num_threads","Number of OpenMP threads to use (can also use environmental variable OMP_NUM_THREADS","None",PetscNumOMPThreads,&PetscNumOMPThreads,&flg)); 10059566063dSJacob Faibussowitsch PetscCall(PetscOptionsName("-omp_view","Display OpenMP number of threads",NULL,&omp_view_flag)); 10069566063dSJacob Faibussowitsch ierr = PetscOptionsEnd();PetscCall(ierr); 100785649d77SJunchao Zhang if (flg) { 10089566063dSJacob Faibussowitsch PetscCall(PetscInfo(NULL,"Number of OpenMP theads %" PetscInt_FMT " (given by -omp_num_threads)\n",PetscNumOMPThreads)); 100985649d77SJunchao Zhang omp_set_num_threads((int)PetscNumOMPThreads); 101085649d77SJunchao Zhang } 101185649d77SJunchao Zhang if (omp_view_flag) { 10129566063dSJacob Faibussowitsch PetscCall(PetscPrintf(PETSC_COMM_WORLD,"OpenMP: number of threads %" PetscInt_FMT "\n",PetscNumOMPThreads)); 101385649d77SJunchao Zhang } 101485649d77SJunchao Zhang } 101585649d77SJunchao Zhang #endif 101685649d77SJunchao Zhang 101785649d77SJunchao Zhang #if defined(PETSC_USE_PETSC_MPI_EXTERNAL32) 101885649d77SJunchao Zhang /* 101985649d77SJunchao Zhang Tell MPI about our own data representation converter, this would/should be used if extern32 is not supported by the MPI 102085649d77SJunchao Zhang 102185649d77SJunchao Zhang Currently not used because it is not supported by MPICH. 102285649d77SJunchao Zhang */ 10239566063dSJacob Faibussowitsch if (!PetscBinaryBigEndian()) PetscCallMPI(MPI_Register_datarep((char*)"petsc",PetscDataRep_read_conv_fn,PetscDataRep_write_conv_fn,PetscDataRep_extent_fn,NULL)); 102485649d77SJunchao Zhang #endif 102585649d77SJunchao Zhang 102685649d77SJunchao Zhang #if defined(PETSC_SERIALIZE_FUNCTIONS) 10279566063dSJacob Faibussowitsch PetscCall(PetscFPTCreate(10000)); 102885649d77SJunchao Zhang #endif 102985649d77SJunchao Zhang 103085649d77SJunchao Zhang #if defined(PETSC_HAVE_HWLOC) 103185649d77SJunchao Zhang { 103285649d77SJunchao Zhang PetscViewer viewer; 10339566063dSJacob Faibussowitsch PetscCall(PetscOptionsGetViewer(PETSC_COMM_WORLD,NULL,NULL,"-process_view",&viewer,NULL,&flg)); 103485649d77SJunchao Zhang if (flg) { 10359566063dSJacob Faibussowitsch PetscCall(PetscProcessPlacementView(viewer)); 10369566063dSJacob Faibussowitsch PetscCall(PetscViewerDestroy(&viewer)); 103785649d77SJunchao Zhang } 103885649d77SJunchao Zhang } 103985649d77SJunchao Zhang #endif 104085649d77SJunchao Zhang 104185649d77SJunchao Zhang flg = PETSC_TRUE; 10429566063dSJacob Faibussowitsch PetscCall(PetscOptionsGetBool(NULL,NULL,"-viewfromoptions",&flg,NULL)); 10439566063dSJacob Faibussowitsch if (!flg) PetscCall(PetscOptionsPushGetViewerOff(PETSC_TRUE)); 104485649d77SJunchao Zhang 104585649d77SJunchao Zhang #if defined(PETSC_HAVE_ADIOS) 10469566063dSJacob Faibussowitsch PetscCall(adios_init_noxml(PETSC_COMM_WORLD)); 10479566063dSJacob Faibussowitsch PetscCall(adios_declare_group(&Petsc_adios_group,"PETSc","",adios_stat_default)); 10489566063dSJacob Faibussowitsch PetscCall(adios_select_method(Petsc_adios_group,"MPI","","")); 10499566063dSJacob Faibussowitsch PetscCall(adios_read_init_method(ADIOS_READ_METHOD_BP,PETSC_COMM_WORLD,"")); 105085649d77SJunchao Zhang #endif 105185649d77SJunchao Zhang 105285649d77SJunchao Zhang #if defined(__VALGRIND_H) 105385649d77SJunchao Zhang PETSC_RUNNING_ON_VALGRIND = RUNNING_ON_VALGRIND? PETSC_TRUE: PETSC_FALSE; 105485649d77SJunchao Zhang #if defined(PETSC_USING_DARWIN) && defined(PETSC_BLASLAPACK_SDOT_RETURNS_DOUBLE) 10559566063dSJacob Faibussowitsch if (PETSC_RUNNING_ON_VALGRIND) PetscCall(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")); 105685649d77SJunchao Zhang #endif 105785649d77SJunchao Zhang #endif 105885649d77SJunchao Zhang /* 105985649d77SJunchao Zhang Set flag that we are completely initialized 106085649d77SJunchao Zhang */ 106185649d77SJunchao Zhang PetscInitializeCalled = PETSC_TRUE; 106285649d77SJunchao Zhang 10639566063dSJacob Faibussowitsch PetscCall(PetscOptionsHasName(NULL,NULL,"-python",&flg)); 10649566063dSJacob Faibussowitsch if (flg) PetscCall(PetscPythonInitialize(NULL,NULL)); 106527104ee2SJacob Faibussowitsch PetscFunctionReturn(0); 106685649d77SJunchao Zhang } 106785649d77SJunchao Zhang 1068e5c89e4eSSatish Balay /*@C 1069e5c89e4eSSatish Balay PetscInitialize - Initializes the PETSc database and MPI. 1070e5c89e4eSSatish Balay PetscInitialize() calls MPI_Init() if that has yet to be called, 1071e5c89e4eSSatish Balay so this routine should always be called near the beginning of 1072e5c89e4eSSatish Balay your program -- usually the very first line! 1073e5c89e4eSSatish Balay 1074e5c89e4eSSatish Balay Collective on MPI_COMM_WORLD or PETSC_COMM_WORLD if it has been set 1075e5c89e4eSSatish Balay 1076e5c89e4eSSatish Balay Input Parameters: 1077e5c89e4eSSatish Balay + argc - count of number of command line arguments 1078e5c89e4eSSatish Balay . args - the command line arguments 1079be10d61cSLisandro Dalcin . file - [optional] PETSc database file, append ":yaml" to filename to specify YAML options format. 1080be10d61cSLisandro Dalcin Use NULL or empty string to not check for code specific file. 1081be10d61cSLisandro Dalcin Also checks ~/.petscrc, .petscrc and petscrc. 1082c5b5d8d5SVaclav Hapla Use -skip_petscrc in the code specific file (or command line) to skip ~/.petscrc, .petscrc and petscrc files. 10830298fd71SBarry Smith - help - [optional] Help message to print, use NULL for no message 1084e5c89e4eSSatish Balay 108505827820SBarry Smith If you wish PETSc code to run ONLY on a subcommunicator of MPI_COMM_WORLD, create that 108605827820SBarry Smith communicator first and assign it to PETSC_COMM_WORLD BEFORE calling PetscInitialize(). Thus if you are running a 108705827820SBarry Smith four process job and two processes will run PETSc and have PetscInitialize() and PetscFinalize() and two process will not, 108805827820SBarry Smith then do this. If ALL processes in the job are using PetscInitialize() and PetscFinalize() then you don't need to do this, even 108905827820SBarry Smith if different subcommunicators of the job are doing different things with PETSc. 1090e5c89e4eSSatish Balay 1091e5c89e4eSSatish Balay Options Database Keys: 10927ca660e7SBarry Smith + -help [intro] - prints help method for each option; if intro is given the program stops after printing the introductory help message 10937ca660e7SBarry Smith . -start_in_debugger [noxterm,dbx,xdb,gdb,...] - Starts program in debugger 1094e5c89e4eSSatish Balay . -on_error_attach_debugger [noxterm,dbx,xdb,gdb,...] - Starts debugger when error detected 10958a690491SBarry Smith . -on_error_emacs <machinename> - causes emacsclient to jump to error file 10968a690491SBarry Smith . -on_error_abort - calls abort() when error detected (no traceback) 10978a690491SBarry Smith . -on_error_mpiabort - calls MPI_abort() when error detected 10988a690491SBarry Smith . -error_output_stderr - prints error messages to stderr instead of the default stdout 10998a690491SBarry Smith . -error_output_none - does not print the error messages (but handles errors in the same way as if this was not called) 1100bf4d2887SBarry Smith . -debugger_ranks [rank1,rank2,...] - Indicates ranks to start in debugger 1101e5c89e4eSSatish Balay . -debugger_pause [sleeptime] (in seconds) - Pauses debugger 1102e5c89e4eSSatish Balay . -stop_for_debugger - Print message on how to attach debugger manually to 1103e5c89e4eSSatish Balay process and wait (-debugger_pause) seconds for attachment 110479dccf82SBarry Smith . -malloc - Indicates use of PETSc error-checking malloc (on by default for debug version of libraries) (deprecated, use -malloc_debug) 110579dccf82SBarry Smith . -malloc no - Indicates not to use error-checking malloc (deprecated, use -malloc_debug no) 110679dccf82SBarry Smith . -malloc_debug - check for memory corruption at EVERY malloc or free, see PetscMallocSetDebug() 1107aee23540SBarry Smith . -malloc_dump - prints a list of all unfreed memory at the end of the run 110892f119d6SBarry 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 110992f119d6SBarry Smith . -malloc_view - show a list of all allocated memory during PetscFinalize() 111092f119d6SBarry Smith . -malloc_view_threshold <t> - only list memory allocations of size greater than t with -malloc_view 1111608c71bfSMatthew G. Knepley . -malloc_requested_size - malloc logging will record the requested size rather than size after alignment 111292f119d6SBarry Smith . -fp_trap - Stops on floating point exceptions 1113e5c89e4eSSatish Balay . -no_signal_handler - Indicates not to trap error signals 1114e5c89e4eSSatish Balay . -shared_tmp - indicates /tmp directory is shared by all processors 1115e5c89e4eSSatish Balay . -not_shared_tmp - each processor has own /tmp 1116e5c89e4eSSatish Balay . -tmp - alternative name of /tmp directory 1117e5c89e4eSSatish Balay . -get_total_flops - returns total flops done by all processors 11180841954dSBarry Smith - -memory_view - Print memory usage at end of run 1119e5c89e4eSSatish Balay 1120c5b5d8d5SVaclav Hapla Options Database Keys for Option Database: 1121c5b5d8d5SVaclav Hapla + -skip_petscrc - skip the default option files ~/.petscrc, .petscrc, petscrc 1122c5b5d8d5SVaclav Hapla . -options_monitor - monitor all set options to standard output for the whole program run 1123c5b5d8d5SVaclav Hapla - -options_monitor_cancel - cancel options monitoring hard-wired using PetscOptionsMonitorSet() 1124c5b5d8d5SVaclav Hapla 1125c5b5d8d5SVaclav Hapla Options -options_monitor_{all,cancel} are 1126c5b5d8d5SVaclav Hapla position-independent and apply to all options set since the PETSc start. 1127c5b5d8d5SVaclav Hapla They can be used also in option files. 1128c5b5d8d5SVaclav Hapla 1129c5b5d8d5SVaclav Hapla See PetscOptionsMonitorSet() to do monitoring programmatically. 1130c5b5d8d5SVaclav Hapla 1131e5c89e4eSSatish Balay Options Database Keys for Profiling: 1132a7f22e61SSatish Balay See Users-Manual: ch_profiling for details. 1133fe9b927eSVaclav Hapla + -info [filename][:[~]<list,of,classnames>[:[~]self]] - Prints verbose information. See PetscInfo(). 1134217044c2SLisandro Dalcin . -log_sync - Enable barrier synchronization for all events. This option is useful to debug imbalance within each event, 1135217044c2SLisandro Dalcin however it slows things down and gives a distorted view of the overall runtime. 1136495fc317SBarry Smith . -log_trace [filename] - Print traces of all PETSc calls to the screen (useful to determine where a program 1137e5c89e4eSSatish Balay hangs without running in the debugger). See PetscLogTraceBegin(). 11389a9a5d4cSBarry Smith . -log_view [:filename:format] - Prints summary of flop and timing information to screen or file, see PetscLogView(). 113979dccf82SBarry Smith . -log_view_memory - Includes in the summary from -log_view the memory used in each method, see PetscLogView(). 11409a9a5d4cSBarry Smith . -log_summary [filename] - (Deprecated, use -log_view) Prints summary of flop and timing information to screen. If the filename is specified the 1141495fc317SBarry Smith summary is written to the file. See PetscLogView(). 1142f5d6ab90SLisandro Dalcin . -log_exclude: <vec,mat,pc,ksp,snes> - excludes subset of object classes from logging 1143495fc317SBarry Smith . -log_all [filename] - Logs extensive profiling information See PetscLogDump(). 1144495fc317SBarry Smith . -log [filename] - Logs basic profiline information See PetscLogDump(). 1145c2f74817SBarry Smith . -log_mpe [filename] - Creates a logfile viewable by the utility Jumpshot (in MPICH distribution) 114687c3beb6SLisandro Dalcin . -viewfromoptions on,off - Enable or disable XXXSetFromOptions() calls, for applications with many small solves turn this off 1147c2f74817SBarry Smith - -check_pointer_intensity 0,1,2 - if pointers are checked for validity (debug version only), using 0 will result in faster code 1148495fc317SBarry Smith 11496a77f485SPierre Jolivet Only one of -log_trace, -log_view, -log_all, -log, or -log_mpe may be used at a time 1150e5c89e4eSSatish Balay 1151ffbd1cfbSBarry Smith Options Database Keys for SAWs: 1152ffbd1cfbSBarry Smith + -saws_port <portnumber> - port number to publish SAWs data, default is 8080 1153ffbd1cfbSBarry 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 1154ffbd1cfbSBarry Smith this is useful when you are running many jobs that utilize SAWs at the same time 1155ffbd1cfbSBarry Smith . -saws_log <filename> - save a log of all SAWs communication 1156ffbd1cfbSBarry Smith . -saws_https <certificate file> - have SAWs use HTTPS instead of HTTP 1157ffbd1cfbSBarry Smith - -saws_root <directory> - allow SAWs to have access to the given directory to search for requested resources and files 1158ffbd1cfbSBarry Smith 1159e5c89e4eSSatish Balay Environmental Variables: 1160e5c89e4eSSatish Balay + PETSC_TMP - alternative tmp directory 1161e5c89e4eSSatish Balay . PETSC_SHARED_TMP - tmp is shared by all processes 1162e5c89e4eSSatish Balay . PETSC_NOT_SHARED_TMP - each process has its own private tmp 11634a971ea4SToby Isaac . PETSC_OPTIONS - a string containing additional options for petsc in the form of command line "-key value" pairs 11644a971ea4SToby Isaac . PETSC_OPTIONS_YAML - (requires configuring PETSc to use libyaml) a string containing additional options for petsc in the form of a YAML document 1165e5c89e4eSSatish Balay . PETSC_VIEWER_SOCKET_PORT - socket number to use for socket viewer 1166e5c89e4eSSatish Balay - PETSC_VIEWER_SOCKET_MACHINE - machine to use for socket viewer to connect to 1167e5c89e4eSSatish Balay 1168e5c89e4eSSatish Balay Level: beginner 1169e5c89e4eSSatish Balay 1170e5c89e4eSSatish Balay Notes: 1171e5c89e4eSSatish Balay If for some reason you must call MPI_Init() separately, call 1172e5c89e4eSSatish Balay it before PetscInitialize(). 1173e5c89e4eSSatish Balay 1174e5c89e4eSSatish Balay Fortran Version: 1175e5c89e4eSSatish Balay In Fortran this routine has the format 1176e5c89e4eSSatish Balay $ call PetscInitialize(file,ierr) 1177e5c89e4eSSatish Balay 1178e5c89e4eSSatish Balay + ierr - error return code 1179c5b5d8d5SVaclav Hapla - file - [optional] PETSc database file, also checks ~/.petscrc, .petscrc and petscrc. 1180c5b5d8d5SVaclav Hapla Use PETSC_NULL_CHARACTER to not check for code specific file. 1181c5b5d8d5SVaclav Hapla Use -skip_petscrc in the code specific file (or command line) to skip ~/.petscrc, .petscrc and petscrc files. 1182e5c89e4eSSatish Balay 1183e5c89e4eSSatish Balay Important Fortran Note: 11840eb4c9c0SBarry Smith In Fortran, you MUST use PETSC_NULL_CHARACTER to indicate a 11850298fd71SBarry Smith null character string; you CANNOT just use NULL as 1186a7f22e61SSatish Balay in the C version. See Users-Manual: ch_fortran for details. 1187e5c89e4eSSatish Balay 118801cb0274SBarry Smith If your main program is C but you call Fortran code that also uses PETSc you need to call PetscInitializeFortran() soon after 118901cb0274SBarry Smith calling PetscInitialize(). 1190e5c89e4eSSatish Balay 119101cb0274SBarry Smith .seealso: PetscFinalize(), PetscInitializeFortran(), PetscGetArgs(), PetscInitializeNoArguments() 1192e5c89e4eSSatish Balay 1193e5c89e4eSSatish Balay @*/ 11947087cfbeSBarry Smith PetscErrorCode PetscInitialize(int *argc,char ***args,const char file[],const char help[]) 1195e5c89e4eSSatish Balay { 119685649d77SJunchao Zhang PetscMPIInt flag; 119785649d77SJunchao Zhang const char *prog = "Unknown Name"; 1198e5c89e4eSSatish Balay 119927104ee2SJacob Faibussowitsch PetscFunctionBegin; 120027104ee2SJacob Faibussowitsch if (PetscInitializeCalled) PetscFunctionReturn(0); 12019566063dSJacob Faibussowitsch PetscCallMPI(MPI_Initialized(&flag)); 1202e5c89e4eSSatish Balay if (!flag) { 120339a651e2SJacob 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"); 12049566063dSJacob Faibussowitsch PetscCall(PetscPreMPIInit_Private()); 12055e765c61SJed Brown #if defined(PETSC_HAVE_MPI_INIT_THREAD) 12065e765c61SJed Brown { 120739a651e2SJacob Faibussowitsch PetscMPIInt PETSC_UNUSED provided; 12089566063dSJacob Faibussowitsch PetscCallMPI(MPI_Init_thread(argc,args,PETSC_MPI_THREAD_REQUIRED,&provided)); 12095e765c61SJed Brown } 12105e765c61SJed Brown #else 12119566063dSJacob Faibussowitsch PetscCallMPI(MPI_Init(argc,args)); 12125e765c61SJed Brown #endif 1213e5c89e4eSSatish Balay PetscBeganMPI = PETSC_TRUE; 1214e5c89e4eSSatish Balay } 12154dfee713SSatish Balay 121685649d77SJunchao Zhang if (argc && *argc) prog = **args; 1217e5c89e4eSSatish Balay if (argc && args) { 1218e5c89e4eSSatish Balay PetscGlobalArgc = *argc; 1219e5c89e4eSSatish Balay PetscGlobalArgs = *args; 1220e5c89e4eSSatish Balay } 12219566063dSJacob Faibussowitsch PetscCall(PetscInitialize_Common(prog,file,help,PETSC_FALSE/*C*/,PETSC_FALSE,0)); 122227104ee2SJacob Faibussowitsch PetscFunctionReturn(0); 1223e5c89e4eSSatish Balay } 1224e5c89e4eSSatish Balay 1225a4af0ceeSJacob Faibussowitsch #if PetscDefined(USE_LOG) 122695c0884eSLisandro Dalcin PETSC_INTERN PetscObject *PetscObjects; 1227ecfe9a72SLisandro Dalcin PETSC_INTERN PetscInt PetscObjectsCounts; 1228ecfe9a72SLisandro Dalcin PETSC_INTERN PetscInt PetscObjectsMaxCounts; 122995c0884eSLisandro Dalcin PETSC_INTERN PetscBool PetscObjectsLog; 12304097062eSBarry Smith #endif 1231e5c89e4eSSatish Balay 1232008a6e76SBarry Smith /* 1233008a6e76SBarry Smith Frees all the MPI types and operations that PETSc may have created 1234008a6e76SBarry Smith */ 1235008a6e76SBarry Smith PetscErrorCode PetscFreeMPIResources(void) 1236008a6e76SBarry Smith { 1237008a6e76SBarry Smith PetscFunctionBegin; 1238008a6e76SBarry Smith #if defined(PETSC_USE_REAL___FLOAT128) 12399566063dSJacob Faibussowitsch PetscCallMPI(MPI_Type_free(&MPIU___FLOAT128)); 1240008a6e76SBarry Smith #if defined(PETSC_HAVE_COMPLEX) 12419566063dSJacob Faibussowitsch PetscCallMPI(MPI_Type_free(&MPIU___COMPLEX128)); 1242008a6e76SBarry Smith #endif 12439566063dSJacob Faibussowitsch PetscCallMPI(MPI_Op_free(&MPIU_MAX)); 12449566063dSJacob Faibussowitsch PetscCallMPI(MPI_Op_free(&MPIU_MIN)); 1245008a6e76SBarry Smith #elif defined(PETSC_USE_REAL___FP16) 12469566063dSJacob Faibussowitsch PetscCallMPI(MPI_Type_free(&MPIU___FP16)); 12479566063dSJacob Faibussowitsch PetscCallMPI(MPI_Op_free(&MPIU_MAX)); 12489566063dSJacob Faibussowitsch PetscCallMPI(MPI_Op_free(&MPIU_MIN)); 1249008a6e76SBarry Smith #endif 1250008a6e76SBarry Smith 1251de272c7aSSatish Balay #if defined(PETSC_USE_REAL___FLOAT128) || defined(PETSC_USE_REAL___FP16) 12529566063dSJacob Faibussowitsch PetscCallMPI(MPI_Op_free(&MPIU_SUM)); 1253008a6e76SBarry Smith #endif 1254008a6e76SBarry Smith 12559566063dSJacob Faibussowitsch PetscCallMPI(MPI_Type_free(&MPIU_2SCALAR)); 12569566063dSJacob Faibussowitsch PetscCallMPI(MPI_Type_free(&MPIU_REAL_INT)); 12579566063dSJacob Faibussowitsch PetscCallMPI(MPI_Type_free(&MPIU_SCALAR_INT)); 125840df0d72SSatish Balay #if defined(PETSC_USE_64BIT_INDICES) 12599566063dSJacob Faibussowitsch PetscCallMPI(MPI_Type_free(&MPIU_2INT)); 1260008a6e76SBarry Smith #endif 12619566063dSJacob Faibussowitsch PetscCallMPI(MPI_Type_free(&MPI_4INT)); 12629566063dSJacob Faibussowitsch PetscCallMPI(MPI_Type_free(&MPIU_4INT)); 12639566063dSJacob Faibussowitsch PetscCallMPI(MPI_Op_free(&MPIU_MAXSUM_OP)); 1264008a6e76SBarry Smith PetscFunctionReturn(0); 1265008a6e76SBarry Smith } 1266008a6e76SBarry Smith 1267a4af0ceeSJacob Faibussowitsch #if PetscDefined(USE_LOG) 1268a4af0ceeSJacob Faibussowitsch PETSC_INTERN PetscErrorCode PetscLogFinalize(void); 1269a4af0ceeSJacob Faibussowitsch #endif 1270a4af0ceeSJacob Faibussowitsch 1271e5c89e4eSSatish Balay /*@C 1272e5c89e4eSSatish Balay PetscFinalize - Checks for options to be called at the conclusion 1273e5c89e4eSSatish Balay of the program. MPI_Finalize() is called only if the user had not 1274e5c89e4eSSatish Balay called MPI_Init() before calling PetscInitialize(). 1275e5c89e4eSSatish Balay 1276e5c89e4eSSatish Balay Collective on PETSC_COMM_WORLD 1277e5c89e4eSSatish Balay 1278e5c89e4eSSatish Balay Options Database Keys: 127926a7e8d4SBarry Smith + -options_view - Calls PetscOptionsView() 1280e5c89e4eSSatish Balay . -options_left - Prints unused options that remain in the database 12817eb1d149SBarry 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 1282e5c89e4eSSatish Balay . -mpidump - Calls PetscMPIDump() 128392f119d6SBarry Smith . -malloc_dump <optional filename> - Calls PetscMallocDump(), displays all memory allocated that has not been freed 1284e5c89e4eSSatish Balay . -malloc_info - Prints total memory usage 128592f119d6SBarry Smith - -malloc_view <optional filename> - Prints list of all memory allocated and where 1286e5c89e4eSSatish Balay 1287e5c89e4eSSatish Balay Level: beginner 1288e5c89e4eSSatish Balay 1289e5c89e4eSSatish Balay Note: 1290e5c89e4eSSatish Balay See PetscInitialize() for more general runtime options. 1291e5c89e4eSSatish Balay 129288c29154SBarry Smith .seealso: PetscInitialize(), PetscOptionsView(), PetscMallocDump(), PetscMPIDump(), PetscEnd() 1293e5c89e4eSSatish Balay @*/ 12947087cfbeSBarry Smith PetscErrorCode PetscFinalize(void) 1295e5c89e4eSSatish Balay { 12964bb5149bSJed Brown PetscMPIInt rank; 1297a8d2bbe5SBarry Smith PetscInt nopt; 12982bf49c77SBarry Smith PetscBool flg1 = PETSC_FALSE,flg2 = PETSC_FALSE,flg3 = PETSC_FALSE; 1299dff31646SBarry Smith PetscBool flg; 130010463e74SBarry Smith #if defined(PETSC_USE_LOG) 130110463e74SBarry Smith char mname[PETSC_MAX_PATH_LEN]; 130210463e74SBarry Smith #endif 1303e5c89e4eSSatish Balay 13043cbbc5ffSBarry Smith PetscFunctionBegin; 130539a651e2SJacob Faibussowitsch PetscCheck(PetscInitializeCalled,PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"PetscInitialize() must be called before PetscFinalize()"); 13069566063dSJacob Faibussowitsch PetscCall(PetscInfo(NULL,"PetscFinalize() called\n")); 1307b022a5c1SBarry Smith 13089566063dSJacob Faibussowitsch PetscCallMPI(MPI_Comm_rank(PETSC_COMM_WORLD,&rank)); 1309a56f64adSBarry Smith #if defined(PETSC_HAVE_ADIOS) 13109566063dSJacob Faibussowitsch PetscCall(adios_read_finalize_method(ADIOS_READ_METHOD_BP_AGGREGATE)); 13119566063dSJacob Faibussowitsch PetscCall(adios_finalize(rank)); 1312a56f64adSBarry Smith #endif 13139566063dSJacob Faibussowitsch PetscCall(PetscOptionsHasName(NULL,NULL,"-citations",&flg)); 1314dff31646SBarry Smith if (flg) { 13151f817a21SBarry Smith char *cits, filename[PETSC_MAX_PATH_LEN]; 13161f817a21SBarry Smith FILE *fd = PETSC_STDOUT; 13171f817a21SBarry Smith 13189566063dSJacob Faibussowitsch PetscCall(PetscOptionsGetString(NULL,NULL,"-citations",filename,sizeof(filename),NULL)); 13191f817a21SBarry Smith if (filename[0]) { 13209566063dSJacob Faibussowitsch PetscCall(PetscFOpen(PETSC_COMM_WORLD,filename,"w",&fd)); 13211f817a21SBarry Smith } 13229566063dSJacob Faibussowitsch PetscCall(PetscSegBufferGet(PetscCitationsList,1,&cits)); 1323dff31646SBarry Smith cits[0] = 0; 13249566063dSJacob Faibussowitsch PetscCall(PetscSegBufferExtractAlloc(PetscCitationsList,&cits)); 13259566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(PETSC_COMM_WORLD,fd,"If you publish results based on this computation please cite the following:\n")); 13269566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(PETSC_COMM_WORLD,fd,"===========================================================================\n")); 13279566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(PETSC_COMM_WORLD,fd,"%s",cits)); 13289566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(PETSC_COMM_WORLD,fd,"===========================================================================\n")); 13299566063dSJacob Faibussowitsch PetscCall(PetscFClose(PETSC_COMM_WORLD,fd)); 13309566063dSJacob Faibussowitsch PetscCall(PetscFree(cits)); 1331dff31646SBarry Smith } 13329566063dSJacob Faibussowitsch PetscCall(PetscSegBufferDestroy(&PetscCitationsList)); 1333dff31646SBarry Smith 1334c2a97968SBarry Smith #if defined(PETSC_HAVE_SSL) && defined(PETSC_USE_SOCKET_VIEWER) 133504102261SBarry Smith /* TextBelt is run for testing purposes only, please do not use this feature often */ 133604102261SBarry Smith { 133704102261SBarry Smith PetscInt nmax = 2; 133804102261SBarry Smith char **buffs; 13399566063dSJacob Faibussowitsch PetscCall(PetscMalloc1(2,&buffs)); 13409566063dSJacob Faibussowitsch PetscCall(PetscOptionsGetStringArray(NULL,NULL,"-textbelt",buffs,&nmax,&flg1)); 134104102261SBarry Smith if (flg1) { 134228b400f6SJacob Faibussowitsch PetscCheck(nmax,PETSC_COMM_WORLD,PETSC_ERR_USER,"-textbelt requires either the phone number or number,\"message\""); 134304102261SBarry Smith if (nmax == 1) { 13449566063dSJacob Faibussowitsch PetscCall(PetscMalloc1(128,&buffs[1])); 13459566063dSJacob Faibussowitsch PetscCall(PetscGetProgramName(buffs[1],32)); 13469566063dSJacob Faibussowitsch PetscCall(PetscStrcat(buffs[1]," has completed")); 134704102261SBarry Smith } 13489566063dSJacob Faibussowitsch PetscCall(PetscTextBelt(PETSC_COMM_WORLD,buffs[0],buffs[1],NULL)); 13499566063dSJacob Faibussowitsch PetscCall(PetscFree(buffs[0])); 13509566063dSJacob Faibussowitsch PetscCall(PetscFree(buffs[1])); 135104102261SBarry Smith } 13529566063dSJacob Faibussowitsch PetscCall(PetscFree(buffs)); 135304102261SBarry Smith } 1354763ec7b1SBarry Smith { 1355763ec7b1SBarry Smith PetscInt nmax = 2; 1356763ec7b1SBarry Smith char **buffs; 13579566063dSJacob Faibussowitsch PetscCall(PetscMalloc1(2,&buffs)); 13589566063dSJacob Faibussowitsch PetscCall(PetscOptionsGetStringArray(NULL,NULL,"-tellmycell",buffs,&nmax,&flg1)); 1359763ec7b1SBarry Smith if (flg1) { 136028b400f6SJacob Faibussowitsch PetscCheck(nmax,PETSC_COMM_WORLD,PETSC_ERR_USER,"-tellmycell requires either the phone number or number,\"message\""); 1361763ec7b1SBarry Smith if (nmax == 1) { 13629566063dSJacob Faibussowitsch PetscCall(PetscMalloc1(128,&buffs[1])); 13639566063dSJacob Faibussowitsch PetscCall(PetscGetProgramName(buffs[1],32)); 13649566063dSJacob Faibussowitsch PetscCall(PetscStrcat(buffs[1]," has completed")); 1365763ec7b1SBarry Smith } 13669566063dSJacob Faibussowitsch PetscCall(PetscTellMyCell(PETSC_COMM_WORLD,buffs[0],buffs[1],NULL)); 13679566063dSJacob Faibussowitsch PetscCall(PetscFree(buffs[0])); 13689566063dSJacob Faibussowitsch PetscCall(PetscFree(buffs[1])); 1369763ec7b1SBarry Smith } 13709566063dSJacob Faibussowitsch PetscCall(PetscFree(buffs)); 1371763ec7b1SBarry Smith } 137204102261SBarry Smith #endif 137304102261SBarry Smith 13742d53ad75SBarry Smith #if defined(PETSC_SERIALIZE_FUNCTIONS) 13759566063dSJacob Faibussowitsch PetscCall(PetscFPTDestroy()); 13762d53ad75SBarry Smith #endif 13772d53ad75SBarry Smith 1378e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS) 1379dff31646SBarry Smith flg = PETSC_FALSE; 13809566063dSJacob Faibussowitsch PetscCall(PetscOptionsGetBool(NULL,NULL,"-saw_options",&flg,NULL)); 1381d5649816SBarry Smith if (flg) { 13829566063dSJacob Faibussowitsch PetscCall(PetscOptionsSAWsDestroy()); 1383d5649816SBarry Smith } 1384d5649816SBarry Smith #endif 1385d5649816SBarry Smith 1386681455b2SBarry Smith #if defined(PETSC_HAVE_X) 1387681455b2SBarry Smith flg1 = PETSC_FALSE; 13889566063dSJacob Faibussowitsch PetscCall(PetscOptionsGetBool(NULL,NULL,"-x_virtual",&flg1,NULL)); 1389681455b2SBarry Smith if (flg1) { 1390681455b2SBarry Smith /* this is a crude hack, but better than nothing */ 13919566063dSJacob Faibussowitsch PetscCall(PetscPOpen(PETSC_COMM_WORLD,NULL,"pkill -9 Xvfb","r",NULL)); 1392681455b2SBarry Smith } 1393681455b2SBarry Smith #endif 1394681455b2SBarry Smith 139567584ceeSBarry Smith #if !defined(PETSC_HAVE_THREADSAFETY) 13969566063dSJacob Faibussowitsch PetscCall(PetscOptionsGetBool(NULL,NULL,"-malloc_info",&flg2,NULL)); 1397e5c89e4eSSatish Balay if (!flg2) { 139890d69ab7SBarry Smith flg2 = PETSC_FALSE; 13999566063dSJacob Faibussowitsch PetscCall(PetscOptionsGetBool(NULL,NULL,"-memory_view",&flg2,NULL)); 1400e5c89e4eSSatish Balay } 1401e5c89e4eSSatish Balay if (flg2) { 14029566063dSJacob Faibussowitsch PetscCall(PetscMemoryView(PETSC_VIEWER_STDOUT_WORLD,"Summary of Memory Usage in PETSc\n")); 1403e5c89e4eSSatish Balay } 140467584ceeSBarry Smith #endif 1405e5c89e4eSSatish Balay 1406e5c89e4eSSatish Balay #if defined(PETSC_USE_LOG) 140790d69ab7SBarry Smith flg1 = PETSC_FALSE; 14089566063dSJacob Faibussowitsch PetscCall(PetscOptionsGetBool(NULL,NULL,"-get_total_flops",&flg1,NULL)); 1409e5c89e4eSSatish Balay if (flg1) { 1410e5c89e4eSSatish Balay PetscLogDouble flops = 0; 14119566063dSJacob Faibussowitsch PetscCallMPI(MPI_Reduce(&petsc_TotalFlops,&flops,1,MPI_DOUBLE,MPI_SUM,0,PETSC_COMM_WORLD)); 14129566063dSJacob Faibussowitsch PetscCall(PetscPrintf(PETSC_COMM_WORLD,"Total flops over all processors %g\n",flops)); 1413e5c89e4eSSatish Balay } 1414e5c89e4eSSatish Balay #endif 1415e5c89e4eSSatish Balay 1416e5c89e4eSSatish Balay #if defined(PETSC_USE_LOG) 1417e5c89e4eSSatish Balay #if defined(PETSC_HAVE_MPE) 1418e5c89e4eSSatish Balay mname[0] = 0; 14199566063dSJacob Faibussowitsch PetscCall(PetscOptionsGetString(NULL,NULL,"-log_mpe",mname,sizeof(mname),&flg1)); 1420e5c89e4eSSatish Balay if (flg1) { 14219566063dSJacob Faibussowitsch if (mname[0]) PetscCall(PetscLogMPEDump(mname)); 14229566063dSJacob Faibussowitsch else PetscCall(PetscLogMPEDump(0)); 1423e5c89e4eSSatish Balay } 1424e5c89e4eSSatish Balay #endif 1425356e5837SBarry Smith #endif 1426a297a907SKarl Rupp 1427dd710f27SBarry Smith /* 1428dd710f27SBarry Smith Free all objects registered with PetscObjectRegisterDestroy() such as PETSC_VIEWER_XXX_(). 1429dd710f27SBarry Smith */ 14309566063dSJacob Faibussowitsch PetscCall(PetscObjectRegisterDestroyAll()); 1431dd710f27SBarry Smith 1432356e5837SBarry Smith #if defined(PETSC_USE_LOG) 14339566063dSJacob Faibussowitsch PetscCall(PetscOptionsPushGetViewerOff(PETSC_FALSE)); 14349566063dSJacob Faibussowitsch PetscCall(PetscLogViewFromOptions()); 14359566063dSJacob Faibussowitsch PetscCall(PetscOptionsPopGetViewerOff()); 143687c3beb6SLisandro Dalcin 1437356e5837SBarry Smith mname[0] = 0; 14389566063dSJacob Faibussowitsch PetscCall(PetscOptionsGetString(NULL,NULL,"-log_summary",mname,sizeof(mname),&flg1)); 1439e5c89e4eSSatish Balay if (flg1) { 144091eabc43SBarry Smith PetscViewer viewer; 14419566063dSJacob Faibussowitsch PetscCall((*PetscHelpPrintf)(PETSC_COMM_WORLD,"\n\n WARNING: -log_summary is being deprecated; switch to -log_view\n\n\n")); 144291eabc43SBarry Smith if (mname[0]) { 14439566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIIOpen(PETSC_COMM_WORLD,mname,&viewer)); 14449566063dSJacob Faibussowitsch PetscCall(PetscLogView(viewer)); 14459566063dSJacob Faibussowitsch PetscCall(PetscViewerDestroy(&viewer)); 144633f85c2fSBarry Smith } else { 144733f85c2fSBarry Smith viewer = PETSC_VIEWER_STDOUT_WORLD; 14489566063dSJacob Faibussowitsch PetscCall(PetscViewerPushFormat(viewer,PETSC_VIEWER_DEFAULT)); 14499566063dSJacob Faibussowitsch PetscCall(PetscLogView(viewer)); 14509566063dSJacob Faibussowitsch PetscCall(PetscViewerPopFormat(viewer)); 145133f85c2fSBarry Smith } 1452e5c89e4eSSatish Balay } 1453a297a907SKarl Rupp 1454dd710f27SBarry Smith /* 1455dd710f27SBarry Smith Free any objects created by the last block of code. 1456dd710f27SBarry Smith */ 14579566063dSJacob Faibussowitsch PetscCall(PetscObjectRegisterDestroyAll()); 1458dd710f27SBarry Smith 1459dd710f27SBarry Smith mname[0] = 0; 14609566063dSJacob Faibussowitsch PetscCall(PetscOptionsGetString(NULL,NULL,"-log_all",mname,sizeof(mname),&flg1)); 14619566063dSJacob Faibussowitsch PetscCall(PetscOptionsGetString(NULL,NULL,"-log",mname,sizeof(mname),&flg2)); 14629566063dSJacob Faibussowitsch if (flg1 || flg2) PetscCall(PetscLogDump(mname)); 1463e5c89e4eSSatish Balay #endif 146410463e74SBarry Smith 146590d69ab7SBarry Smith flg1 = PETSC_FALSE; 14669566063dSJacob Faibussowitsch PetscCall(PetscOptionsGetBool(NULL,NULL,"-no_signal_handler",&flg1,NULL)); 14679566063dSJacob Faibussowitsch if (!flg1) PetscCall(PetscPopSignalHandler()); 146890d69ab7SBarry Smith flg1 = PETSC_FALSE; 14699566063dSJacob Faibussowitsch PetscCall(PetscOptionsGetBool(NULL,NULL,"-mpidump",&flg1,NULL)); 1470e5c89e4eSSatish Balay if (flg1) { 14719566063dSJacob Faibussowitsch PetscCall(PetscMPIDump(stdout)); 1472e5c89e4eSSatish Balay } 147390d69ab7SBarry Smith flg1 = PETSC_FALSE; 147490d69ab7SBarry Smith flg2 = PETSC_FALSE; 14758bb29257SSatish Balay /* preemptive call to avoid listing this option in options table as unused */ 14769566063dSJacob Faibussowitsch PetscCall(PetscOptionsHasName(NULL,NULL,"-malloc_dump",&flg1)); 14779566063dSJacob Faibussowitsch PetscCall(PetscOptionsHasName(NULL,NULL,"-objects_dump",&flg1)); 14789566063dSJacob Faibussowitsch PetscCall(PetscOptionsGetBool(NULL,NULL,"-options_view",&flg2,NULL)); 1479e4c476e2SSatish Balay 1480e5c89e4eSSatish Balay if (flg2) { 1481be56827dSJed Brown PetscViewer viewer; 14829566063dSJacob Faibussowitsch PetscCall(PetscViewerCreate(PETSC_COMM_WORLD,&viewer)); 14839566063dSJacob Faibussowitsch PetscCall(PetscViewerSetType(viewer,PETSCVIEWERASCII)); 14849566063dSJacob Faibussowitsch PetscCall(PetscOptionsView(NULL,viewer)); 14859566063dSJacob Faibussowitsch PetscCall(PetscViewerDestroy(&viewer)); 1486e5c89e4eSSatish Balay } 1487e5c89e4eSSatish Balay 1488e5c89e4eSSatish Balay /* to prevent PETSc -options_left from warning */ 14899566063dSJacob Faibussowitsch PetscCall(PetscOptionsHasName(NULL,NULL,"-nox",&flg1)); 14909566063dSJacob Faibussowitsch PetscCall(PetscOptionsHasName(NULL,NULL,"-nox_warning",&flg1)); 1491e5c89e4eSSatish Balay 149233fc4174SSatish Balay flg3 = PETSC_FALSE; /* default value is required */ 14939566063dSJacob Faibussowitsch PetscCall(PetscOptionsGetBool(NULL,NULL,"-options_left",&flg3,&flg1)); 14949245e749SBarry Smith if (PetscUnlikelyDebug(!flg1)) flg3 = PETSC_TRUE; 1495e5c89e4eSSatish Balay if (flg3) { 14963de2bfdfSBarry Smith if (!flg2 && flg1) { /* have not yet printed the options */ 1497be56827dSJed Brown PetscViewer viewer; 14989566063dSJacob Faibussowitsch PetscCall(PetscViewerCreate(PETSC_COMM_WORLD,&viewer)); 14999566063dSJacob Faibussowitsch PetscCall(PetscViewerSetType(viewer,PETSCVIEWERASCII)); 15009566063dSJacob Faibussowitsch PetscCall(PetscOptionsView(NULL,viewer)); 15019566063dSJacob Faibussowitsch PetscCall(PetscViewerDestroy(&viewer)); 1502e5c89e4eSSatish Balay } 15039566063dSJacob Faibussowitsch PetscCall(PetscOptionsAllUsed(NULL,&nopt)); 15043de2bfdfSBarry Smith if (nopt) { 15059566063dSJacob Faibussowitsch PetscCall(PetscPrintf(PETSC_COMM_WORLD,"WARNING! There are options you set that were not used!\n")); 15069566063dSJacob Faibussowitsch PetscCall(PetscPrintf(PETSC_COMM_WORLD,"WARNING! could be spelling mistake, etc!\n")); 15073de2bfdfSBarry Smith if (nopt == 1) { 15089566063dSJacob Faibussowitsch PetscCall(PetscPrintf(PETSC_COMM_WORLD,"There is one unused database option. It is:\n")); 1509e5c89e4eSSatish Balay } else { 15109566063dSJacob Faibussowitsch PetscCall(PetscPrintf(PETSC_COMM_WORLD,"There are %" PetscInt_FMT " unused database options. They are:\n",nopt)); 1511e5c89e4eSSatish Balay } 15123de2bfdfSBarry Smith } else if (flg3 && flg1) { 15139566063dSJacob Faibussowitsch PetscCall(PetscPrintf(PETSC_COMM_WORLD,"There are no unused options.\n")); 1514df12ba86SBarry Smith } 15159566063dSJacob Faibussowitsch PetscCall(PetscOptionsLeft(NULL)); 1516e5c89e4eSSatish Balay } 1517e5c89e4eSSatish Balay 1518e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS) 1519d45a07a7SBarry Smith if (!PetscGlobalRank) { 15209566063dSJacob Faibussowitsch PetscCall(PetscStackSAWsViewOff()); 152116ad0300SBarry Smith PetscStackCallSAWs(SAWs_Finalize,()); 1522d45a07a7SBarry Smith } 1523ec957eceSBarry Smith #endif 1524ec957eceSBarry Smith 15254097062eSBarry Smith #if defined(PETSC_USE_LOG) 152610463e74SBarry Smith /* 1527dbc8283eSBarry Smith List all objects the user may have forgot to free 15282eff7a51SBarry Smith */ 152905df10baSBarry Smith if (PetscObjectsLog) { 15309566063dSJacob Faibussowitsch PetscCall(PetscOptionsHasName(NULL,NULL,"-objects_dump",&flg1)); 1531a64a8e02SBarry Smith if (flg1) { 1532a64a8e02SBarry Smith MPI_Comm local_comm; 15337eb1d149SBarry Smith char string[64]; 1534a64a8e02SBarry Smith 15359566063dSJacob Faibussowitsch PetscCall(PetscOptionsGetString(NULL,NULL,"-objects_dump",string,sizeof(string),NULL)); 15369566063dSJacob Faibussowitsch PetscCallMPI(MPI_Comm_dup(MPI_COMM_WORLD,&local_comm)); 15379566063dSJacob Faibussowitsch PetscCall(PetscSequentialPhaseBegin_Private(local_comm,1)); 15389566063dSJacob Faibussowitsch PetscCall(PetscObjectsDump(stdout,(string[0] == 'a') ? PETSC_TRUE : PETSC_FALSE)); 15399566063dSJacob Faibussowitsch PetscCall(PetscSequentialPhaseEnd_Private(local_comm,1)); 15409566063dSJacob Faibussowitsch PetscCallMPI(MPI_Comm_free(&local_comm)); 15410a1571b3SBarry Smith } 154205df10baSBarry Smith } 15434097062eSBarry Smith #endif 15444097062eSBarry Smith 15454097062eSBarry Smith #if defined(PETSC_USE_LOG) 1546dbc8283eSBarry Smith PetscObjectsCounts = 0; 1547dbc8283eSBarry Smith PetscObjectsMaxCounts = 0; 15489566063dSJacob Faibussowitsch PetscCall(PetscFree(PetscObjects)); 15494097062eSBarry Smith #endif 15502eff7a51SBarry Smith 155133f85c2fSBarry Smith /* 155233f85c2fSBarry Smith Destroy any packages that registered a finalize 155333f85c2fSBarry Smith */ 15549566063dSJacob Faibussowitsch PetscCall(PetscRegisterFinalizeAll()); 155533f85c2fSBarry Smith 1556101409b8SToby Isaac #if defined(PETSC_USE_LOG) 15579566063dSJacob Faibussowitsch PetscCall(PetscLogFinalize()); 1558101409b8SToby Isaac #endif 1559101409b8SToby Isaac 156033f85c2fSBarry Smith /* 156148dd1dffSBarry Smith Print PetscFunctionLists that have not been properly freed 156248dd1dffSBarry Smith 15639566063dSJacob Faibussowitsch PetscCall(PetscFunctionListPrintAll()); 156448dd1dffSBarry Smith */ 156537e93019SBarry Smith 15664028d114SSatish Balay if (petsc_history) { 15679566063dSJacob Faibussowitsch PetscCall(PetscCloseHistoryFile(&petsc_history)); 156802c9f0b5SLisandro Dalcin petsc_history = NULL; 1569e5c89e4eSSatish Balay } 15709566063dSJacob Faibussowitsch PetscCall(PetscOptionsHelpPrintedDestroy(&PetscOptionsHelpPrintedSingleton)); 15719566063dSJacob Faibussowitsch PetscCall(PetscInfoDestroy()); 1572e5c89e4eSSatish Balay 157367584ceeSBarry Smith #if !defined(PETSC_HAVE_THREADSAFETY) 157492f119d6SBarry Smith if (!(PETSC_RUNNING_ON_VALGRIND)) { 1575e5c89e4eSSatish Balay char fname[PETSC_MAX_PATH_LEN]; 157692f119d6SBarry Smith char sname[PETSC_MAX_PATH_LEN]; 1577e5c89e4eSSatish Balay FILE *fd; 1578ed9cf6e9SBarry Smith int err; 1579e5c89e4eSSatish Balay 1580dc92acbaSJed Brown flg2 = PETSC_FALSE; 158192f119d6SBarry Smith flg3 = PETSC_FALSE; 15829566063dSJacob Faibussowitsch if (PetscDefined(USE_DEBUG)) PetscCall(PetscOptionsGetBool(NULL,NULL,"-malloc_test",&flg2,NULL)); 15839566063dSJacob Faibussowitsch PetscCall(PetscOptionsGetBool(NULL,NULL,"-malloc_debug",&flg3,NULL)); 158492f119d6SBarry Smith fname[0] = 0; 15859566063dSJacob Faibussowitsch PetscCall(PetscOptionsGetString(NULL,NULL,"-malloc_dump",fname,sizeof(fname),&flg1)); 1586e5c89e4eSSatish Balay if (flg1 && fname[0]) { 1587e5c89e4eSSatish Balay 1588589a23caSBarry Smith PetscSNPrintf(sname,sizeof(sname),"%s_%d",fname,rank); 158928b400f6SJacob Faibussowitsch fd = fopen(sname,"w"); PetscCheck(fd,PETSC_COMM_SELF,PETSC_ERR_FILE_OPEN,"Cannot open log file: %s",sname); 15909566063dSJacob Faibussowitsch PetscCall(PetscMallocDump(fd)); 1591ed9cf6e9SBarry Smith err = fclose(fd); 159228b400f6SJacob Faibussowitsch PetscCheck(!err,PETSC_COMM_SELF,PETSC_ERR_SYS,"fclose() failed on file"); 159392f119d6SBarry Smith } else if (flg1 || flg2 || flg3) { 1594e5c89e4eSSatish Balay MPI_Comm local_comm; 1595e5c89e4eSSatish Balay 15969566063dSJacob Faibussowitsch PetscCallMPI(MPI_Comm_dup(MPI_COMM_WORLD,&local_comm)); 15979566063dSJacob Faibussowitsch PetscCall(PetscSequentialPhaseBegin_Private(local_comm,1)); 15989566063dSJacob Faibussowitsch PetscCall(PetscMallocDump(stdout)); 15999566063dSJacob Faibussowitsch PetscCall(PetscSequentialPhaseEnd_Private(local_comm,1)); 16009566063dSJacob Faibussowitsch PetscCallMPI(MPI_Comm_free(&local_comm)); 1601e5c89e4eSSatish Balay } 1602e5c89e4eSSatish Balay fname[0] = 0; 16039566063dSJacob Faibussowitsch PetscCall(PetscOptionsGetString(NULL,NULL,"-malloc_view",fname,sizeof(fname),&flg1)); 1604e5c89e4eSSatish Balay if (flg1 && fname[0]) { 1605e5c89e4eSSatish Balay 1606589a23caSBarry Smith PetscSNPrintf(sname,sizeof(sname),"%s_%d",fname,rank); 160728b400f6SJacob Faibussowitsch fd = fopen(sname,"w"); PetscCheck(fd,PETSC_COMM_SELF,PETSC_ERR_FILE_OPEN,"Cannot open log file: %s",sname); 16089566063dSJacob Faibussowitsch PetscCall(PetscMallocView(fd)); 1609ed9cf6e9SBarry Smith err = fclose(fd); 161028b400f6SJacob Faibussowitsch PetscCheck(!err,PETSC_COMM_SELF,PETSC_ERR_SYS,"fclose() failed on file"); 161192f119d6SBarry Smith } else if (flg1) { 161292f119d6SBarry Smith MPI_Comm local_comm; 161392f119d6SBarry Smith 16149566063dSJacob Faibussowitsch PetscCallMPI(MPI_Comm_dup(MPI_COMM_WORLD,&local_comm)); 16159566063dSJacob Faibussowitsch PetscCall(PetscSequentialPhaseBegin_Private(local_comm,1)); 16169566063dSJacob Faibussowitsch PetscCall(PetscMallocView(stdout)); 16179566063dSJacob Faibussowitsch PetscCall(PetscSequentialPhaseEnd_Private(local_comm,1)); 16189566063dSJacob Faibussowitsch PetscCallMPI(MPI_Comm_free(&local_comm)); 1619e5c89e4eSSatish Balay } 1620e5c89e4eSSatish Balay } 162167584ceeSBarry Smith #endif 162220e2c332SMatthew G. Knepley 16235486ca60SMatthew G. Knepley /* 16245486ca60SMatthew G. Knepley Close any open dynamic libraries 16255486ca60SMatthew G. Knepley */ 16269566063dSJacob Faibussowitsch PetscCall(PetscFinalize_DynamicLibraries()); 16275486ca60SMatthew G. Knepley 1628e5c89e4eSSatish Balay /* Can be destroyed only after all the options are used */ 16299566063dSJacob Faibussowitsch PetscCall(PetscOptionsDestroyDefault()); 1630e5c89e4eSSatish Balay 1631e5c89e4eSSatish Balay PetscGlobalArgc = 0; 163202c9f0b5SLisandro Dalcin PetscGlobalArgs = NULL; 1633e5c89e4eSSatish Balay 1634c2b86a48SJunchao Zhang #if defined(PETSC_HAVE_KOKKOS) 1635c2b86a48SJunchao Zhang if (PetscBeganKokkos) { 16369566063dSJacob Faibussowitsch PetscCall(PetscKokkosFinalize_Private()); 1637c2b86a48SJunchao Zhang PetscBeganKokkos = PETSC_FALSE; 163845639126SStefano Zampini PetscKokkosInitialized = PETSC_FALSE; 1639c2b86a48SJunchao Zhang } 1640c2b86a48SJunchao Zhang #endif 1641c2b86a48SJunchao Zhang 164271438e86SJunchao Zhang #if defined(PETSC_HAVE_NVSHMEM) 164371438e86SJunchao Zhang if (PetscBeganNvshmem) { 16449566063dSJacob Faibussowitsch PetscCall(PetscNvshmemFinalize()); 164571438e86SJunchao Zhang PetscBeganNvshmem = PETSC_FALSE; 164671438e86SJunchao Zhang } 164771438e86SJunchao Zhang #endif 1648a0e72f99SJunchao Zhang 16499566063dSJacob Faibussowitsch PetscCall(PetscFreeMPIResources()); 1650e5c89e4eSSatish Balay 1651dbc8283eSBarry Smith /* 1652efb80d3cSBarry Smith Destroy any known inner MPI_Comm's and attributes pointing to them 1653efb80d3cSBarry Smith Note this will not destroy any new communicators the user has created. 1654efb80d3cSBarry Smith 1655efb80d3cSBarry Smith If all PETSc objects were not destroyed those left over objects will have hanging references to 1656efb80d3cSBarry Smith the MPI_Comms that were freed; but that is ok because those PETSc objects will never be used again 1657dbc8283eSBarry Smith */ 1658b770b1f6SSatish Balay { 1659dbc8283eSBarry Smith PetscCommCounter *counter; 1660dbc8283eSBarry Smith PetscMPIInt flg; 1661dbc8283eSBarry Smith MPI_Comm icomm; 1662265f3f35SJed Brown union {MPI_Comm comm; void *ptr;} ucomm; 16639566063dSJacob Faibussowitsch PetscCallMPI(MPI_Comm_get_attr(PETSC_COMM_SELF,Petsc_InnerComm_keyval,&ucomm,&flg)); 1664dbc8283eSBarry Smith if (flg) { 1665265f3f35SJed Brown icomm = ucomm.comm; 16669566063dSJacob Faibussowitsch PetscCallMPI(MPI_Comm_get_attr(icomm,Petsc_Counter_keyval,&counter,&flg)); 166728b400f6SJacob Faibussowitsch PetscCheck(flg,PETSC_COMM_SELF,PETSC_ERR_ARG_CORRUPT,"Inner MPI_Comm does not have expected tag/name counter, problem with corrupted memory"); 1668dbc8283eSBarry Smith 16699566063dSJacob Faibussowitsch PetscCallMPI(MPI_Comm_delete_attr(PETSC_COMM_SELF,Petsc_InnerComm_keyval)); 16709566063dSJacob Faibussowitsch PetscCallMPI(MPI_Comm_delete_attr(icomm,Petsc_Counter_keyval)); 16719566063dSJacob Faibussowitsch PetscCallMPI(MPI_Comm_free(&icomm)); 1672dbc8283eSBarry Smith } 16739566063dSJacob Faibussowitsch PetscCallMPI(MPI_Comm_get_attr(PETSC_COMM_WORLD,Petsc_InnerComm_keyval,&ucomm,&flg)); 1674dbc8283eSBarry Smith if (flg) { 1675265f3f35SJed Brown icomm = ucomm.comm; 16769566063dSJacob Faibussowitsch PetscCallMPI(MPI_Comm_get_attr(icomm,Petsc_Counter_keyval,&counter,&flg)); 167728b400f6SJacob Faibussowitsch PetscCheck(flg,PETSC_COMM_WORLD,PETSC_ERR_ARG_CORRUPT,"Inner MPI_Comm does not have expected tag/name counter, problem with corrupted memory"); 1678dbc8283eSBarry Smith 16799566063dSJacob Faibussowitsch PetscCallMPI(MPI_Comm_delete_attr(PETSC_COMM_WORLD,Petsc_InnerComm_keyval)); 16809566063dSJacob Faibussowitsch PetscCallMPI(MPI_Comm_delete_attr(icomm,Petsc_Counter_keyval)); 16819566063dSJacob Faibussowitsch PetscCallMPI(MPI_Comm_free(&icomm)); 1682dbc8283eSBarry Smith } 1683b770b1f6SSatish Balay } 1684dbc8283eSBarry Smith 16859566063dSJacob Faibussowitsch PetscCallMPI(MPI_Comm_free_keyval(&Petsc_Counter_keyval)); 16869566063dSJacob Faibussowitsch PetscCallMPI(MPI_Comm_free_keyval(&Petsc_InnerComm_keyval)); 16879566063dSJacob Faibussowitsch PetscCallMPI(MPI_Comm_free_keyval(&Petsc_OuterComm_keyval)); 16889566063dSJacob Faibussowitsch PetscCallMPI(MPI_Comm_free_keyval(&Petsc_ShmComm_keyval)); 1689480cf27aSJed Brown 16909566063dSJacob Faibussowitsch PetscCall(PetscSpinlockDestroy(&PetscViewerASCIISpinLockOpen)); 16919566063dSJacob Faibussowitsch PetscCall(PetscSpinlockDestroy(&PetscViewerASCIISpinLockStdout)); 16929566063dSJacob Faibussowitsch PetscCall(PetscSpinlockDestroy(&PetscViewerASCIISpinLockStderr)); 16939566063dSJacob Faibussowitsch PetscCall(PetscSpinlockDestroy(&PetscCommSpinLock)); 1694ef19f930SBarry Smith 1695e5c89e4eSSatish Balay if (PetscBeganMPI) { 169699b1327fSBarry Smith PetscMPIInt flag; 16979566063dSJacob Faibussowitsch PetscCallMPI(MPI_Finalized(&flag)); 169839a651e2SJacob Faibussowitsch PetscCheck(!flag,PETSC_COMM_SELF,PETSC_ERR_LIB,"MPI_Finalize() has already been called, even though MPI_Init() was called by PetscInitialize()"); 169939a651e2SJacob Faibussowitsch /* wait until the very last moment to disable error handling */ 170039a651e2SJacob Faibussowitsch PetscErrorHandlingInitialized = PETSC_FALSE; 17019566063dSJacob Faibussowitsch PetscCallMPI(MPI_Finalize()); 170239a651e2SJacob Faibussowitsch } else PetscErrorHandlingInitialized = PETSC_FALSE; 170339a651e2SJacob Faibussowitsch 1704e5c89e4eSSatish Balay /* 1705e5c89e4eSSatish Balay 1706e5c89e4eSSatish Balay Note: In certain cases PETSC_COMM_WORLD is never MPI_Comm_free()ed because 1707e5c89e4eSSatish Balay the communicator has some outstanding requests on it. Specifically if the 1708e5c89e4eSSatish Balay flag PETSC_HAVE_BROKEN_REQUEST_FREE is set (for IBM MPI implementation). See 1709e5c89e4eSSatish Balay src/vec/utils/vpscat.c. Due to this the memory allocated in PetscCommDuplicate() 1710e5c89e4eSSatish Balay is never freed as it should be. Thus one may obtain messages of the form 17110e5e90baSSatish Balay [ 1] 8 bytes PetscCommDuplicate() line 645 in src/sys/mpiu.c indicating the 1712e5c89e4eSSatish Balay memory was not freed. 1713e5c89e4eSSatish Balay 1714e5c89e4eSSatish Balay */ 17159566063dSJacob Faibussowitsch PetscCall(PetscMallocClear()); 17169566063dSJacob Faibussowitsch PetscCall(PetscStackReset()); 1717a297a907SKarl Rupp 1718e5c89e4eSSatish Balay PetscInitializeCalled = PETSC_FALSE; 1719e5c89e4eSSatish Balay PetscFinalizeCalled = PETSC_TRUE; 172056883f60SBarry Smith #if defined(PETSC_USE_GCOV) 172156883f60SBarry Smith /* 172256883f60SBarry Smith flush gcov, otherwise during CI the flushing continues into the next pipeline resulting in git not being able to delete directories since the 172356883f60SBarry Smith gcov files are still being added to the directories as git tries to remove the directories. 172456883f60SBarry Smith */ 172556883f60SBarry Smith __gcov_flush(); 172656883f60SBarry Smith #endif 17271724198aSStefano Zampini /* To match PetscFunctionBegin() at the beginning of this function */ 17281724198aSStefano Zampini PetscStackClearTop; 172927104ee2SJacob Faibussowitsch return 0; 1730e5c89e4eSSatish Balay } 1731e5c89e4eSSatish Balay 173243db4dbbSBarry Smith #if defined(PETSC_MISSING_LAPACK_lsame_) 17338cc058d9SJed Brown PETSC_EXTERN int lsame_(char *a,char *b) 173443db4dbbSBarry Smith { 173543db4dbbSBarry Smith if (*a == *b) return 1; 173643db4dbbSBarry Smith if (*a + 32 == *b) return 1; 173743db4dbbSBarry Smith if (*a - 32 == *b) return 1; 173843db4dbbSBarry Smith return 0; 173943db4dbbSBarry Smith } 1740a70650f6SBarry Smith #endif 174143db4dbbSBarry Smith 174243db4dbbSBarry Smith #if defined(PETSC_MISSING_LAPACK_lsame) 17438cc058d9SJed Brown PETSC_EXTERN int lsame(char *a,char *b) 174443db4dbbSBarry Smith { 174543db4dbbSBarry Smith if (*a == *b) return 1; 174643db4dbbSBarry Smith if (*a + 32 == *b) return 1; 174743db4dbbSBarry Smith if (*a - 32 == *b) return 1; 174843db4dbbSBarry Smith return 0; 174943db4dbbSBarry Smith } 175043db4dbbSBarry Smith #endif 1751