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 18aaf3846cSSatish Balay #if defined(PETSC_HAVE___GCOV_DUMP) 19aaf3846cSSatish Balay #define __gcov_flush(x) __gcov_dump(x) 20aaf3846cSSatish Balay #endif 2156883f60SBarry Smith void __gcov_flush(void); 2256883f60SBarry Smith EXTERN_C_END 2356883f60SBarry Smith #endif 248101f56cSMatthew Knepley 252d53ad75SBarry Smith #if defined(PETSC_SERIALIZE_FUNCTIONS) 2695c0884eSLisandro Dalcin PETSC_INTERN PetscFPT PetscFPTData; 272d53ad75SBarry Smith PetscFPT PetscFPTData = 0; 282d53ad75SBarry Smith #endif 292d53ad75SBarry Smith 3027104ee2SJacob Faibussowitsch #if PetscDefined(HAVE_SAWS) 3116ad0300SBarry Smith #include <petscviewersaws.h> 32a6790183SBarry Smith #endif 33eb02082bSJunchao Zhang 34e5c89e4eSSatish Balay /* -----------------------------------------------------------------------------------------*/ 35e5c89e4eSSatish Balay 3695c0884eSLisandro Dalcin PETSC_INTERN FILE *petsc_history; 37e5c89e4eSSatish Balay 3895c0884eSLisandro Dalcin PETSC_INTERN PetscErrorCode PetscInitialize_DynamicLibraries(void); 3995c0884eSLisandro Dalcin PETSC_INTERN PetscErrorCode PetscFinalize_DynamicLibraries(void); 4095c0884eSLisandro Dalcin PETSC_INTERN PetscErrorCode PetscSequentialPhaseBegin_Private(MPI_Comm,int); 4195c0884eSLisandro Dalcin PETSC_INTERN PetscErrorCode PetscSequentialPhaseEnd_Private(MPI_Comm,int); 4295c0884eSLisandro Dalcin PETSC_INTERN PetscErrorCode PetscCloseHistoryFile(FILE**); 430069ddf5SShri Abhyankar 446de5d289SStefano Zampini /* user may set these BEFORE calling PetscInitialize() */ 45e8373e55SMatthew Knepley MPI_Comm PETSC_COMM_WORLD = MPI_COMM_NULL; 4627104ee2SJacob Faibussowitsch #if PetscDefined(HAVE_MPI_INIT_THREAD) 476de5d289SStefano Zampini PetscMPIInt PETSC_MPI_THREAD_REQUIRED = MPI_THREAD_FUNNELED; 486de5d289SStefano Zampini #else 496de5d289SStefano Zampini PetscMPIInt PETSC_MPI_THREAD_REQUIRED = 0; 506de5d289SStefano Zampini #endif 51e5c89e4eSSatish Balay 52480cf27aSJed Brown PetscMPIInt Petsc_Counter_keyval = MPI_KEYVAL_INVALID; 53480cf27aSJed Brown PetscMPIInt Petsc_InnerComm_keyval = MPI_KEYVAL_INVALID; 54480cf27aSJed Brown PetscMPIInt Petsc_OuterComm_keyval = MPI_KEYVAL_INVALID; 555f7487a0SJunchao Zhang PetscMPIInt Petsc_ShmComm_keyval = MPI_KEYVAL_INVALID; 56480cf27aSJed Brown 57e5c89e4eSSatish Balay /* 58e5c89e4eSSatish Balay Declare and set all the string names of the PETSc enums 59e5c89e4eSSatish Balay */ 6002c9f0b5SLisandro Dalcin const char *const PetscBools[] = {"FALSE","TRUE","PetscBool","PETSC_",NULL}; 6102c9f0b5SLisandro Dalcin const char *const PetscCopyModes[] = {"COPY_VALUES","OWN_POINTER","USE_POINTER","PetscCopyMode","PETSC_",NULL}; 62e5c89e4eSSatish Balay 63ace3abfcSBarry Smith PetscBool PetscPreLoadingUsed = PETSC_FALSE; 64ace3abfcSBarry Smith PetscBool PetscPreLoadingOn = PETSC_FALSE; 650f8e0872SSatish Balay 66a2f94806SJed Brown PetscInt PetscHotRegionDepth; 67a2f94806SJed Brown 686edef35eSSatish Balay PetscBool PETSC_RUNNING_ON_VALGRIND = PETSC_FALSE; 696edef35eSSatish Balay 70b22622e2STadeu Manoel #if defined(PETSC_HAVE_THREADSAFETY) 71b22622e2STadeu Manoel PetscSpinlock PetscViewerASCIISpinLockOpen; 72b22622e2STadeu Manoel PetscSpinlock PetscViewerASCIISpinLockStdout; 73b22622e2STadeu Manoel PetscSpinlock PetscViewerASCIISpinLockStderr; 74b22622e2STadeu Manoel PetscSpinlock PetscCommSpinLock; 75b22622e2STadeu Manoel #endif 76b22622e2STadeu Manoel 77e5c89e4eSSatish Balay /* 78945d1669SBarry Smith PetscInitializeNoPointers - Calls PetscInitialize() from C/C++ without the pointers to argc and args 7972a42c3cSBarry Smith 8072a42c3cSBarry Smith Collective 8172a42c3cSBarry Smith 8272a42c3cSBarry Smith Level: advanced 8372a42c3cSBarry Smith 8495452b02SPatrick Sanan Notes: 85a56f64adSBarry Smith this is called only by the PETSc Julia interface. Even though it might start MPI it sets the flag to 860f11a792SBarry Smith indicate that it did NOT start MPI so that the PetscFinalize() does not end MPI, thus allowing PetscInitialize() to 87a56f64adSBarry Smith be called multiple times from Julia without the problem of trying to initialize MPI more than once. 880f11a792SBarry Smith 89a56f64adSBarry Smith Developer Note: Turns off PETSc signal handling to allow Julia to manage signals 901ea5a559SBarry Smith 91db781477SPatrick Sanan .seealso: `PetscInitialize()`, `PetscInitializeFortran()`, `PetscInitializeNoArguments()` 920f11a792SBarry Smith */ 93945d1669SBarry Smith PetscErrorCode PetscInitializeNoPointers(int argc,char **args,const char *filename,const char *help) 9472a42c3cSBarry Smith { 9572a42c3cSBarry Smith int myargc = argc; 9672a42c3cSBarry Smith char **myargs = args; 9772a42c3cSBarry Smith 9872a42c3cSBarry Smith PetscFunctionBegin; 999566063dSJacob Faibussowitsch PetscCall(PetscInitialize(&myargc,&myargs,filename,help)); 1009566063dSJacob Faibussowitsch PetscCall(PetscPopSignalHandler()); 101df413903SBarry Smith PetscBeganMPI = PETSC_FALSE; 10227104ee2SJacob Faibussowitsch PetscFunctionReturn(0); 10372a42c3cSBarry Smith } 10472a42c3cSBarry Smith 105f0865b08SBarry Smith /* 106a56f64adSBarry Smith Used by Julia interface to get communicator 107f0865b08SBarry Smith */ 108945d1669SBarry Smith PetscErrorCode PetscGetPETSC_COMM_SELF(MPI_Comm *comm) 109f0865b08SBarry Smith { 110f0865b08SBarry Smith PetscFunctionBegin; 11127104ee2SJacob Faibussowitsch if (PetscInitializeCalled) PetscValidPointer(comm,1); 112f0865b08SBarry Smith *comm = PETSC_COMM_SELF; 113f0865b08SBarry Smith PetscFunctionReturn(0); 114f0865b08SBarry Smith } 115f0865b08SBarry Smith 116e5c89e4eSSatish Balay /*@C 117e5c89e4eSSatish Balay PetscInitializeNoArguments - Calls PetscInitialize() from C/C++ without 118e5c89e4eSSatish Balay the command line arguments. 119e5c89e4eSSatish Balay 120e5c89e4eSSatish Balay Collective 121e5c89e4eSSatish Balay 122e5c89e4eSSatish Balay Level: advanced 123e5c89e4eSSatish Balay 124db781477SPatrick Sanan .seealso: `PetscInitialize()`, `PetscInitializeFortran()` 125e5c89e4eSSatish Balay @*/ 1267087cfbeSBarry Smith PetscErrorCode PetscInitializeNoArguments(void) 127e5c89e4eSSatish Balay { 128e5c89e4eSSatish Balay int argc = 0; 12902c9f0b5SLisandro Dalcin char **args = NULL; 130e5c89e4eSSatish Balay 131e5c89e4eSSatish Balay PetscFunctionBegin; 1329566063dSJacob Faibussowitsch PetscCall(PetscInitialize(&argc,&args,NULL,NULL)); 13339a651e2SJacob Faibussowitsch PetscFunctionReturn(0); 134e5c89e4eSSatish Balay } 135e5c89e4eSSatish Balay 136e5c89e4eSSatish Balay /*@ 137e5c89e4eSSatish Balay PetscInitialized - Determine whether PETSc is initialized. 138e5c89e4eSSatish Balay 13993b6d2d1SJed Brown Level: beginner 140e5c89e4eSSatish Balay 141db781477SPatrick Sanan .seealso: `PetscInitialize()`, `PetscInitializeNoArguments()`, `PetscInitializeFortran()` 142e5c89e4eSSatish Balay @*/ 1437087cfbeSBarry Smith PetscErrorCode PetscInitialized(PetscBool *isInitialized) 144e5c89e4eSSatish Balay { 14527104ee2SJacob Faibussowitsch PetscFunctionBegin; 14627104ee2SJacob Faibussowitsch if (PetscInitializeCalled) PetscValidBoolPointer(isInitialized,1); 147e5c89e4eSSatish Balay *isInitialized = PetscInitializeCalled; 14827104ee2SJacob Faibussowitsch PetscFunctionReturn(0); 149e5c89e4eSSatish Balay } 150e5c89e4eSSatish Balay 151e5c89e4eSSatish Balay /*@ 152e5c89e4eSSatish Balay PetscFinalized - Determine whether PetscFinalize() has been called yet 153e5c89e4eSSatish Balay 154e5c89e4eSSatish Balay Level: developer 155e5c89e4eSSatish Balay 156db781477SPatrick Sanan .seealso: `PetscInitialize()`, `PetscInitializeNoArguments()`, `PetscInitializeFortran()` 157e5c89e4eSSatish Balay @*/ 1587087cfbeSBarry Smith PetscErrorCode PetscFinalized(PetscBool *isFinalized) 159e5c89e4eSSatish Balay { 16027104ee2SJacob Faibussowitsch PetscFunctionBegin; 16127104ee2SJacob Faibussowitsch if (!PetscFinalizeCalled) PetscValidBoolPointer(isFinalized,1); 162e5c89e4eSSatish Balay *isFinalized = PetscFinalizeCalled; 16327104ee2SJacob Faibussowitsch PetscFunctionReturn(0); 164e5c89e4eSSatish Balay } 165e5c89e4eSSatish Balay 16657171095SVaclav Hapla PETSC_INTERN PetscErrorCode PetscOptionsCheckInitial_Private(const char []); 167e5c89e4eSSatish Balay 168e5c89e4eSSatish Balay /* 169e5c89e4eSSatish Balay This function is the MPI reduction operation used to compute the sum of the 170e5c89e4eSSatish Balay first half of the datatype and the max of the second half. 171e5c89e4eSSatish Balay */ 172367daffbSBarry Smith MPI_Op MPIU_MAXSUM_OP = 0; 173e5c89e4eSSatish Balay 174367daffbSBarry Smith PETSC_INTERN void MPIAPI MPIU_MaxSum_Local(void *in,void *out,int *cnt,MPI_Datatype *datatype) 175e5c89e4eSSatish Balay { 176e5c89e4eSSatish Balay PetscInt *xin = (PetscInt*)in,*xout = (PetscInt*)out,i,count = *cnt; 177e5c89e4eSSatish Balay 178e5c89e4eSSatish Balay PetscFunctionBegin; 179e5c89e4eSSatish Balay if (*datatype != MPIU_2INT) { 180e5c89e4eSSatish Balay (*PetscErrorPrintf)("Can only handle MPIU_2INT data types"); 18141e02c4dSJunchao Zhang PETSCABORT(MPI_COMM_SELF,PETSC_ERR_ARG_WRONG); 182e5c89e4eSSatish Balay } 183e5c89e4eSSatish Balay 184e5c89e4eSSatish Balay for (i=0; i<count; i++) { 185e5c89e4eSSatish Balay xout[2*i] = PetscMax(xout[2*i],xin[2*i]); 186e5c89e4eSSatish Balay xout[2*i+1] += xin[2*i+1]; 187e5c89e4eSSatish Balay } 188812af9f3SBarry Smith PetscFunctionReturnVoid(); 189e5c89e4eSSatish Balay } 190e5c89e4eSSatish Balay 191e5c89e4eSSatish Balay /* 192e5c89e4eSSatish Balay Returns the max of the first entry owned by this processor and the 193e5c89e4eSSatish Balay sum of the second entry. 194b693b147SBarry Smith 19576f543a4SJed Brown The reason sizes[2*i] contains lengths sizes[2*i+1] contains flag of 1 if length is nonzero 196367daffbSBarry Smith is so that the MPIU_MAXSUM_OP() can set TWO values, if we passed in only sizes[i] with lengths 197b693b147SBarry Smith there would be no place to store the both needed results. 198e5c89e4eSSatish Balay */ 19976ec1555SBarry Smith PetscErrorCode PetscMaxSum(MPI_Comm comm,const PetscInt sizes[],PetscInt *max,PetscInt *sum) 200e5c89e4eSSatish Balay { 201e5c89e4eSSatish Balay PetscFunctionBegin; 202d6e4c47cSJed Brown #if defined(PETSC_HAVE_MPI_REDUCE_SCATTER_BLOCK) 203d6e4c47cSJed Brown { 204d6e4c47cSJed Brown struct {PetscInt max,sum;} work; 2059566063dSJacob Faibussowitsch PetscCallMPI(MPI_Reduce_scatter_block((void*)sizes,&work,1,MPIU_2INT,MPIU_MAXSUM_OP,comm)); 206d6e4c47cSJed Brown *max = work.max; 207d6e4c47cSJed Brown *sum = work.sum; 208d6e4c47cSJed Brown } 209d6e4c47cSJed Brown #else 210d6e4c47cSJed Brown { 211d6e4c47cSJed Brown PetscMPIInt size,rank; 212d6e4c47cSJed Brown struct {PetscInt max,sum;} *work; 2139566063dSJacob Faibussowitsch PetscCallMPI(MPI_Comm_size(comm,&size)); 2149566063dSJacob Faibussowitsch PetscCallMPI(MPI_Comm_rank(comm,&rank)); 2159566063dSJacob Faibussowitsch PetscCall(PetscMalloc1(size,&work)); 2161c2dc1cbSBarry Smith PetscCall(MPIU_Allreduce((void*)sizes,work,size,MPIU_2INT,MPIU_MAXSUM_OP,comm)); 2176ac3741eSJed Brown *max = work[rank].max; 2186ac3741eSJed Brown *sum = work[rank].sum; 2199566063dSJacob Faibussowitsch PetscCall(PetscFree(work)); 220d6e4c47cSJed Brown } 221d6e4c47cSJed Brown #endif 222e5c89e4eSSatish Balay PetscFunctionReturn(0); 223e5c89e4eSSatish Balay } 224e5c89e4eSSatish Balay 225e5c89e4eSSatish Balay /* ----------------------------------------------------------------------------*/ 226e5c89e4eSSatish Balay 227de272c7aSSatish Balay #if defined(PETSC_USE_REAL___FLOAT128) || defined(PETSC_USE_REAL___FP16) 22806a205a8SBarry Smith MPI_Op MPIU_SUM = 0; 229e5c89e4eSSatish Balay 230092991acSStefano Zampini PETSC_EXTERN void MPIAPI PetscSum_Local(void *in,void *out,PetscMPIInt *cnt,MPI_Datatype *datatype) 231e5c89e4eSSatish Balay { 232e5c89e4eSSatish Balay PetscInt i,count = *cnt; 233e5c89e4eSSatish Balay 234e5c89e4eSSatish Balay PetscFunctionBegin; 2357c2de775SJed Brown if (*datatype == MPIU_REAL) { 236e2e03761SBarry Smith PetscReal *xin = (PetscReal*)in,*xout = (PetscReal*)out; 237a297a907SKarl Rupp for (i=0; i<count; i++) xout[i] += xin[i]; 2387c2de775SJed Brown } 2397c2de775SJed Brown #if defined(PETSC_HAVE_COMPLEX) 240c5481aeeSJose E. Roman else if (*datatype == MPIU_COMPLEX) { 2417c2de775SJed Brown PetscComplex *xin = (PetscComplex*)in,*xout = (PetscComplex*)out; 242a297a907SKarl Rupp for (i=0; i<count; i++) xout[i] += xin[i]; 2437c2de775SJed Brown } 2447c2de775SJed Brown #endif 2457c2de775SJed Brown else { 2467c2de775SJed Brown (*PetscErrorPrintf)("Can only handle MPIU_REAL or MPIU_COMPLEX data types"); 24741e02c4dSJunchao Zhang PETSCABORT(MPI_COMM_SELF,PETSC_ERR_ARG_WRONG); 248e2e03761SBarry Smith } 249812af9f3SBarry Smith PetscFunctionReturnVoid(); 250e5c89e4eSSatish Balay } 251e5c89e4eSSatish Balay #endif 252e5c89e4eSSatish Balay 253570b7f6dSBarry Smith #if defined(PETSC_USE_REAL___FLOAT128) || defined(PETSC_USE_REAL___FP16) 254d9822059SBarry Smith MPI_Op MPIU_MAX = 0; 255d9822059SBarry Smith MPI_Op MPIU_MIN = 0; 256d9822059SBarry Smith 257092991acSStefano Zampini PETSC_EXTERN void MPIAPI PetscMax_Local(void *in,void *out,PetscMPIInt *cnt,MPI_Datatype *datatype) 258d9822059SBarry Smith { 259d9822059SBarry Smith PetscInt i,count = *cnt; 260d9822059SBarry Smith 261d9822059SBarry Smith PetscFunctionBegin; 2627c2de775SJed Brown if (*datatype == MPIU_REAL) { 2638c764dc5SJose Roman PetscReal *xin = (PetscReal*)in,*xout = (PetscReal*)out; 264a297a907SKarl Rupp for (i=0; i<count; i++) xout[i] = PetscMax(xout[i],xin[i]); 2657c2de775SJed Brown } 2667c2de775SJed Brown #if defined(PETSC_HAVE_COMPLEX) 2677c2de775SJed Brown else if (*datatype == MPIU_COMPLEX) { 2687c2de775SJed Brown PetscComplex *xin = (PetscComplex*)in,*xout = (PetscComplex*)out; 2697c2de775SJed Brown for (i=0; i<count; i++) { 2707c2de775SJed Brown xout[i] = PetscRealPartComplex(xout[i])<PetscRealPartComplex(xin[i]) ? xin[i] : xout[i]; 2717c2de775SJed Brown } 2727c2de775SJed Brown } 2737c2de775SJed Brown #endif 2747c2de775SJed Brown else { 2757c2de775SJed Brown (*PetscErrorPrintf)("Can only handle MPIU_REAL or MPIU_COMPLEX data types"); 27641e02c4dSJunchao Zhang PETSCABORT(MPI_COMM_SELF,PETSC_ERR_ARG_WRONG); 2778c764dc5SJose Roman } 278d9822059SBarry Smith PetscFunctionReturnVoid(); 279d9822059SBarry Smith } 280d9822059SBarry Smith 281092991acSStefano Zampini PETSC_EXTERN void MPIAPI PetscMin_Local(void *in,void *out,PetscMPIInt *cnt,MPI_Datatype *datatype) 282d9822059SBarry Smith { 283d9822059SBarry Smith PetscInt i,count = *cnt; 284d9822059SBarry Smith 285d9822059SBarry Smith PetscFunctionBegin; 2867c2de775SJed Brown if (*datatype == MPIU_REAL) { 2878c764dc5SJose Roman PetscReal *xin = (PetscReal*)in,*xout = (PetscReal*)out; 288a297a907SKarl Rupp for (i=0; i<count; i++) xout[i] = PetscMin(xout[i],xin[i]); 2897c2de775SJed Brown } 2907c2de775SJed Brown #if defined(PETSC_HAVE_COMPLEX) 2917c2de775SJed Brown else if (*datatype == MPIU_COMPLEX) { 2927c2de775SJed Brown PetscComplex *xin = (PetscComplex*)in,*xout = (PetscComplex*)out; 2937c2de775SJed Brown for (i=0; i<count; i++) { 2947c2de775SJed Brown xout[i] = PetscRealPartComplex(xout[i])>PetscRealPartComplex(xin[i]) ? xin[i] : xout[i]; 2957c2de775SJed Brown } 2967c2de775SJed Brown } 2977c2de775SJed Brown #endif 2987c2de775SJed Brown else { 2998c764dc5SJose Roman (*PetscErrorPrintf)("Can only handle MPIU_REAL or MPIU_SCALAR data (i.e. double or complex) types"); 30041e02c4dSJunchao Zhang PETSCABORT(MPI_COMM_SELF,PETSC_ERR_ARG_WRONG); 3018c764dc5SJose Roman } 302d9822059SBarry Smith PetscFunctionReturnVoid(); 303d9822059SBarry Smith } 304d9822059SBarry Smith #endif 305d9822059SBarry Smith 306480cf27aSJed Brown /* 307480cf27aSJed Brown Private routine to delete internal tag/name counter storage when a communicator is freed. 308480cf27aSJed Brown 309ff0e51ddSBarry 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. 310480cf27aSJed Brown 31112801b39SBarry Smith Note: this is declared extern "C" because it is passed to MPI_Comm_create_keyval() 312480cf27aSJed Brown 313480cf27aSJed Brown */ 31433779a13SJunchao Zhang PETSC_EXTERN PetscMPIInt MPIAPI Petsc_Counter_Attr_Delete_Fn(MPI_Comm comm,PetscMPIInt keyval,void *count_val,void *extra_state) 315480cf27aSJed Brown { 31605342407SJunchao Zhang PetscCommCounter *counter=(PetscCommCounter*)count_val; 31757f21012SBarry Smith struct PetscCommStash *comms = counter->comms, *pcomm; 318480cf27aSJed Brown 319480cf27aSJed Brown PetscFunctionBegin; 3209566063dSJacob Faibussowitsch PetscCallMPI(PetscInfo(NULL,"Deleting counter data in an MPI_Comm %ld\n",(long)comm)); 3219566063dSJacob Faibussowitsch PetscCallMPI(PetscFree(counter->iflags)); 32257f21012SBarry Smith while (comms) { 3239566063dSJacob Faibussowitsch PetscCallMPI(MPI_Comm_free(&comms->comm)); 32457f21012SBarry Smith pcomm = comms; 32557f21012SBarry Smith comms = comms->next; 3269566063dSJacob Faibussowitsch PetscCall(PetscFree(pcomm)); 32757f21012SBarry Smith } 3289566063dSJacob Faibussowitsch PetscCallMPI(PetscFree(counter)); 329480cf27aSJed Brown PetscFunctionReturn(MPI_SUCCESS); 330480cf27aSJed Brown } 331480cf27aSJed Brown 332480cf27aSJed Brown /* 33347435625SJed Brown This is invoked on the outer comm as a result of either PetscCommDestroy() (via MPI_Comm_delete_attr) or when the user 334da3039f7SJed Brown calls MPI_Comm_free(). 335da3039f7SJed Brown 336da3039f7SJed Brown This is the only entry point for breaking the links between inner and outer comms. 337480cf27aSJed Brown 338ff0e51ddSBarry Smith This is called by MPI, not by users. This is called when MPI_Comm_free() is called on the communicator. 339480cf27aSJed Brown 34012801b39SBarry Smith Note: this is declared extern "C" because it is passed to MPI_Comm_create_keyval() 341480cf27aSJed Brown 342480cf27aSJed Brown */ 34333779a13SJunchao Zhang PETSC_EXTERN PetscMPIInt MPIAPI Petsc_InnerComm_Attr_Delete_Fn(MPI_Comm comm,PetscMPIInt keyval,void *attr_val,void *extra_state) 344480cf27aSJed Brown { 34533779a13SJunchao Zhang union {MPI_Comm comm; void *ptr;} icomm; 346480cf27aSJed Brown 347480cf27aSJed Brown PetscFunctionBegin; 34812801b39SBarry Smith if (keyval != Petsc_InnerComm_keyval) SETERRMPI(PETSC_COMM_SELF,PETSC_ERR_ARG_CORRUPT,"Unexpected keyval"); 349ec4fadc2SJed Brown icomm.ptr = attr_val; 35076bd3646SJed Brown if (PetscDefined(USE_DEBUG)) { 35133779a13SJunchao Zhang /* Error out if the inner/outer comms are not correctly linked through their Outer/InnterComm attributes */ 35233779a13SJunchao Zhang PetscMPIInt flg; 35333779a13SJunchao Zhang union {MPI_Comm comm; void *ptr;} ocomm; 3549566063dSJacob Faibussowitsch PetscCallMPI(MPI_Comm_get_attr(icomm.comm,Petsc_OuterComm_keyval,&ocomm,&flg)); 35533779a13SJunchao Zhang if (!flg) SETERRMPI(PETSC_COMM_SELF,PETSC_ERR_ARG_CORRUPT,"Inner comm does not have OuterComm attribute"); 35633779a13SJunchao 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"); 35733779a13SJunchao Zhang } 3589566063dSJacob Faibussowitsch PetscCallMPI(MPI_Comm_delete_attr(icomm.comm,Petsc_OuterComm_keyval)); 3599566063dSJacob Faibussowitsch PetscCallMPI(PetscInfo(NULL,"User MPI_Comm %ld is being unlinked from inner PETSc comm %ld\n",(long)comm,(long)icomm.comm)); 360da3039f7SJed Brown PetscFunctionReturn(MPI_SUCCESS); 361b89831e5SBarry Smith } 362da3039f7SJed Brown 363da3039f7SJed Brown /* 36433779a13SJunchao 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. 365da3039f7SJed Brown */ 36633779a13SJunchao Zhang PETSC_EXTERN PetscMPIInt MPIAPI Petsc_OuterComm_Attr_Delete_Fn(MPI_Comm comm,PetscMPIInt keyval,void *attr_val,void *extra_state) 367da3039f7SJed Brown { 368da3039f7SJed Brown PetscFunctionBegin; 3699566063dSJacob Faibussowitsch PetscCallMPI(PetscInfo(NULL,"Removing reference to PETSc communicator embedded in a user MPI_Comm %ld\n",(long)comm)); 370480cf27aSJed Brown PetscFunctionReturn(MPI_SUCCESS); 371480cf27aSJed Brown } 372480cf27aSJed Brown 37333779a13SJunchao Zhang PETSC_EXTERN PetscMPIInt MPIAPI Petsc_ShmComm_Attr_Delete_Fn(MPI_Comm,PetscMPIInt,void *,void *); 37442218b76SBarry Smith 375951e3c8eSBarry Smith #if defined(PETSC_USE_PETSC_MPI_EXTERNAL32) 3768cc058d9SJed Brown PETSC_EXTERN PetscMPIInt PetscDataRep_extent_fn(MPI_Datatype,MPI_Aint*,void*); 3778cc058d9SJed Brown PETSC_EXTERN PetscMPIInt PetscDataRep_read_conv_fn(void*, MPI_Datatype,PetscMPIInt,void*,MPI_Offset,void*); 3788cc058d9SJed Brown PETSC_EXTERN PetscMPIInt PetscDataRep_write_conv_fn(void*, MPI_Datatype,PetscMPIInt,void*,MPI_Offset,void*); 379e39fd77fSBarry Smith #endif 380e39fd77fSBarry Smith 3810f9be574SPeter Hill PetscMPIInt PETSC_MPI_ERROR_CLASS=MPI_ERR_LASTCODE,PETSC_MPI_ERROR_CODE; 38212801b39SBarry Smith 383eb27c7c8SSatish Balay PETSC_INTERN int PetscGlobalArgc; 384eb27c7c8SSatish Balay PETSC_INTERN char **PetscGlobalArgs; 3856ae9a8a6SBarry Smith int PetscGlobalArgc = 0; 38602c9f0b5SLisandro Dalcin char **PetscGlobalArgs = NULL; 387dff31646SBarry Smith PetscSegBuffer PetscCitationsList; 388e5c89e4eSSatish Balay 389dd63322aSSatish Balay PetscErrorCode PetscCitationsInitialize(void) 390051e4cf2SJed Brown { 391051e4cf2SJed Brown PetscFunctionBegin; 3929566063dSJacob Faibussowitsch PetscCall(PetscSegBufferCreate(1,10000,&PetscCitationsList)); 39330c35bf2SSatish Balay 39430c35bf2SSatish Balay PetscCall(PetscCitationsRegister("@TechReport{petsc-user-ref,\n\ 39530c35bf2SSatish Balay Author = {Satish Balay and Shrirang Abhyankar and Mark~F. Adams and Steven Benson and Jed Brown\n\ 39630c35bf2SSatish Balay and Peter Brune and Kris Buschelman and Emil Constantinescu and Lisandro Dalcin and Alp Dener\n\ 39730c35bf2SSatish Balay and Victor Eijkhout and William~D. Gropp and V\'{a}clav Hapla and Tobin Isaac and Pierre Jolivet\n\ 39830c35bf2SSatish Balay and Dmitry Karpeev and Dinesh Kaushik and Matthew~G. Knepley and Fande Kong and Scott Kruger\n\ 39930c35bf2SSatish Balay and Dave~A. May and Lois Curfman McInnes and Richard Tran Mills and Lawrence Mitchell and Todd Munson\n\ 40030c35bf2SSatish Balay and Jose~E. Roman and Karl Rupp and Patrick Sanan and Jason Sarich and Barry~F. Smith\n\ 40130c35bf2SSatish Balay and Stefano Zampini and Hong Zhang and Hong Zhang and Junchao Zhang},\n\ 40230c35bf2SSatish Balay Title = {{PETSc/TAO} Users Manual},\n\ 40330c35bf2SSatish Balay Number = {ANL-21/39 - Revision 3.17},\n\ 40430c35bf2SSatish Balay Institution = {Argonne National Laboratory},\n\ 40530c35bf2SSatish Balay Year = {2022}\n}\n",NULL)); 40630c35bf2SSatish Balay 40730c35bf2SSatish Balay PetscCall(PetscCitationsRegister("@InProceedings{petsc-efficient,\n\ 40830c35bf2SSatish Balay Author = {Satish Balay and William D. Gropp and Lois Curfman McInnes and Barry F. Smith},\n\ 40930c35bf2SSatish Balay Title = {Efficient Management of Parallelism in Object Oriented Numerical Software Libraries},\n\ 41030c35bf2SSatish Balay Booktitle = {Modern Software Tools in Scientific Computing},\n\ 41130c35bf2SSatish Balay Editor = {E. Arge and A. M. Bruaset and H. P. Langtangen},\n\ 41230c35bf2SSatish Balay Pages = {163--202},\n\ 41330c35bf2SSatish Balay Publisher = {Birkh{\\\"{a}}user Press},\n\ 41430c35bf2SSatish Balay Year = {1997}\n}\n",NULL)); 41530c35bf2SSatish Balay 416051e4cf2SJed Brown PetscFunctionReturn(0); 417051e4cf2SJed Brown } 418e5c89e4eSSatish Balay 4192d747510SLisandro Dalcin static char programname[PETSC_MAX_PATH_LEN] = ""; /* HP includes entire path in name */ 4202d747510SLisandro Dalcin 4212d747510SLisandro Dalcin PetscErrorCode PetscSetProgramName(const char name[]) 4222d747510SLisandro Dalcin { 4232d747510SLisandro Dalcin PetscFunctionBegin; 4249566063dSJacob Faibussowitsch PetscCall(PetscStrncpy(programname,name,sizeof(programname))); 4252d747510SLisandro Dalcin PetscFunctionReturn(0); 4262d747510SLisandro Dalcin } 4272d747510SLisandro Dalcin 4282d747510SLisandro Dalcin /*@C 4292d747510SLisandro Dalcin PetscGetProgramName - Gets the name of the running program. 4302d747510SLisandro Dalcin 4312d747510SLisandro Dalcin Not Collective 4322d747510SLisandro Dalcin 4332d747510SLisandro Dalcin Input Parameter: 4342d747510SLisandro Dalcin . len - length of the string name 4352d747510SLisandro Dalcin 4362d747510SLisandro Dalcin Output Parameter: 4372d747510SLisandro Dalcin . name - the name of the running program 4382d747510SLisandro Dalcin 4392d747510SLisandro Dalcin Level: advanced 4402d747510SLisandro Dalcin 4412d747510SLisandro Dalcin Notes: 4422d747510SLisandro Dalcin The name of the program is copied into the user-provided character 4432d747510SLisandro Dalcin array of length len. On some machines the program name includes 4442d747510SLisandro Dalcin its entire path, so one should generally set len >= PETSC_MAX_PATH_LEN. 4452d747510SLisandro Dalcin @*/ 4462d747510SLisandro Dalcin PetscErrorCode PetscGetProgramName(char name[],size_t len) 4472d747510SLisandro Dalcin { 4482d747510SLisandro Dalcin PetscFunctionBegin; 4499566063dSJacob Faibussowitsch PetscCall(PetscStrncpy(name,programname,len)); 4502d747510SLisandro Dalcin PetscFunctionReturn(0); 4512d747510SLisandro Dalcin } 4522d747510SLisandro Dalcin 453e5c89e4eSSatish Balay /*@C 454e5c89e4eSSatish Balay PetscGetArgs - Allows you to access the raw command line arguments anywhere 455e5c89e4eSSatish Balay after PetscInitialize() is called but before PetscFinalize(). 456e5c89e4eSSatish Balay 457e5c89e4eSSatish Balay Not Collective 458e5c89e4eSSatish Balay 459e5c89e4eSSatish Balay Output Parameters: 460e5c89e4eSSatish Balay + argc - count of number of command line arguments 461e5c89e4eSSatish Balay - args - the command line arguments 462e5c89e4eSSatish Balay 463e5c89e4eSSatish Balay Level: intermediate 464e5c89e4eSSatish Balay 465e5c89e4eSSatish Balay Notes: 466e5c89e4eSSatish Balay This is usually used to pass the command line arguments into other libraries 467e5c89e4eSSatish Balay that are called internally deep in PETSc or the application. 468e5c89e4eSSatish Balay 469f177e3b1SBarry Smith The first argument contains the program name as is normal for C arguments. 470f177e3b1SBarry Smith 471db781477SPatrick Sanan .seealso: `PetscFinalize()`, `PetscInitializeFortran()`, `PetscGetArguments()` 472e5c89e4eSSatish Balay 473e5c89e4eSSatish Balay @*/ 4747087cfbeSBarry Smith PetscErrorCode PetscGetArgs(int *argc,char ***args) 475e5c89e4eSSatish Balay { 476e5c89e4eSSatish Balay PetscFunctionBegin; 47739a651e2SJacob Faibussowitsch PetscCheck(PetscInitializeCalled || !PetscFinalizeCalled,PETSC_COMM_SELF,PETSC_ERR_ORDER,"You must call after PetscInitialize() but before PetscFinalize()"); 478e5c89e4eSSatish Balay *argc = PetscGlobalArgc; 479e5c89e4eSSatish Balay *args = PetscGlobalArgs; 480e5c89e4eSSatish Balay PetscFunctionReturn(0); 481e5c89e4eSSatish Balay } 482e5c89e4eSSatish Balay 483793721a6SBarry Smith /*@C 484793721a6SBarry Smith PetscGetArguments - Allows you to access the command line arguments anywhere 485793721a6SBarry Smith after PetscInitialize() is called but before PetscFinalize(). 486793721a6SBarry Smith 487793721a6SBarry Smith Not Collective 488793721a6SBarry Smith 489793721a6SBarry Smith Output Parameters: 490793721a6SBarry Smith . args - the command line arguments 491793721a6SBarry Smith 492793721a6SBarry Smith Level: intermediate 493793721a6SBarry Smith 494793721a6SBarry Smith Notes: 495793721a6SBarry Smith This does NOT start with the program name and IS null terminated (final arg is void) 496793721a6SBarry Smith 497db781477SPatrick Sanan .seealso: `PetscFinalize()`, `PetscInitializeFortran()`, `PetscGetArgs()`, `PetscFreeArguments()` 498793721a6SBarry Smith 499793721a6SBarry Smith @*/ 5007087cfbeSBarry Smith PetscErrorCode PetscGetArguments(char ***args) 501793721a6SBarry Smith { 502793721a6SBarry Smith PetscInt i,argc = PetscGlobalArgc; 503793721a6SBarry Smith 504793721a6SBarry Smith PetscFunctionBegin; 50539a651e2SJacob Faibussowitsch PetscCheck(PetscInitializeCalled || !PetscFinalizeCalled,PETSC_COMM_SELF,PETSC_ERR_ORDER,"You must call after PetscInitialize() but before PetscFinalize()"); 5062d747510SLisandro Dalcin if (!argc) {*args = NULL; PetscFunctionReturn(0);} 5079566063dSJacob Faibussowitsch PetscCall(PetscMalloc1(argc,args)); 5089566063dSJacob Faibussowitsch for (i=0; i<argc-1; i++) PetscCall(PetscStrallocpy(PetscGlobalArgs[i+1],&(*args)[i])); 5092d747510SLisandro Dalcin (*args)[argc-1] = NULL; 510793721a6SBarry Smith PetscFunctionReturn(0); 511793721a6SBarry Smith } 512793721a6SBarry Smith 513793721a6SBarry Smith /*@C 514793721a6SBarry Smith PetscFreeArguments - Frees the memory obtained with PetscGetArguments() 515793721a6SBarry Smith 516793721a6SBarry Smith Not Collective 517793721a6SBarry Smith 518793721a6SBarry Smith Output Parameters: 519793721a6SBarry Smith . args - the command line arguments 520793721a6SBarry Smith 521793721a6SBarry Smith Level: intermediate 522793721a6SBarry Smith 523db781477SPatrick Sanan .seealso: `PetscFinalize()`, `PetscInitializeFortran()`, `PetscGetArgs()`, `PetscGetArguments()` 524793721a6SBarry Smith 525793721a6SBarry Smith @*/ 5267087cfbeSBarry Smith PetscErrorCode PetscFreeArguments(char **args) 527793721a6SBarry Smith { 52839a651e2SJacob Faibussowitsch PetscFunctionBegin; 52939a651e2SJacob Faibussowitsch if (args) { 530793721a6SBarry Smith PetscInt i = 0; 531793721a6SBarry Smith 5329566063dSJacob Faibussowitsch while (args[i]) PetscCall(PetscFree(args[i++])); 5339566063dSJacob Faibussowitsch PetscCall(PetscFree(args)); 53439a651e2SJacob Faibussowitsch } 535793721a6SBarry Smith PetscFunctionReturn(0); 536793721a6SBarry Smith } 537793721a6SBarry Smith 53827104ee2SJacob Faibussowitsch #if PetscDefined(HAVE_SAWS) 53930befbd2SBarry Smith #include <petscconfiginfo.h> 54030befbd2SBarry Smith 54195c0884eSLisandro Dalcin PETSC_INTERN PetscErrorCode PetscInitializeSAWs(const char help[]) 54211525c0dSBarry Smith { 54327104ee2SJacob Faibussowitsch PetscFunctionBegin; 54411525c0dSBarry Smith if (!PetscGlobalRank) { 54530befbd2SBarry Smith char cert[PETSC_MAX_PATH_LEN],root[PETSC_MAX_PATH_LEN],*intro,programname[64],*appline,*options,version[64]; 54611525c0dSBarry Smith int port; 547ffbd1cfbSBarry Smith PetscBool flg,rootlocal = PETSC_FALSE,flg2,selectport = PETSC_FALSE; 54811525c0dSBarry Smith size_t applinelen,introlen; 549ffbd1cfbSBarry Smith char sawsurl[256]; 55011525c0dSBarry Smith 5519566063dSJacob Faibussowitsch PetscCall(PetscOptionsHasName(NULL,NULL,"-saws_log",&flg)); 55211525c0dSBarry Smith if (flg) { 55311525c0dSBarry Smith char sawslog[PETSC_MAX_PATH_LEN]; 55411525c0dSBarry Smith 5559566063dSJacob Faibussowitsch PetscCall(PetscOptionsGetString(NULL,NULL,"-saws_log",sawslog,sizeof(sawslog),NULL)); 55611525c0dSBarry Smith if (sawslog[0]) { 557792fecdfSBarry Smith PetscCallSAWs(SAWs_Set_Use_Logfile,(sawslog)); 55811525c0dSBarry Smith } else { 559792fecdfSBarry Smith PetscCallSAWs(SAWs_Set_Use_Logfile,(NULL)); 56011525c0dSBarry Smith } 56111525c0dSBarry Smith } 5629566063dSJacob Faibussowitsch PetscCall(PetscOptionsGetString(NULL,NULL,"-saws_https",cert,sizeof(cert),&flg)); 56311525c0dSBarry Smith if (flg) { 564792fecdfSBarry Smith PetscCallSAWs(SAWs_Set_Use_HTTPS,(cert)); 56511525c0dSBarry Smith } 5669566063dSJacob Faibussowitsch PetscCall(PetscOptionsGetBool(NULL,NULL,"-saws_port_auto_select",&selectport,NULL)); 567ffbd1cfbSBarry Smith if (selectport) { 568792fecdfSBarry Smith PetscCallSAWs(SAWs_Get_Available_Port,(&port)); 569792fecdfSBarry Smith PetscCallSAWs(SAWs_Set_Port,(port)); 570ffbd1cfbSBarry Smith } else { 5719566063dSJacob Faibussowitsch PetscCall(PetscOptionsGetInt(NULL,NULL,"-saws_port",&port,&flg)); 57211525c0dSBarry Smith if (flg) { 573792fecdfSBarry Smith PetscCallSAWs(SAWs_Set_Port,(port)); 57411525c0dSBarry Smith } 575ffbd1cfbSBarry Smith } 5769566063dSJacob Faibussowitsch PetscCall(PetscOptionsGetString(NULL,NULL,"-saws_root",root,sizeof(root),&flg)); 57711525c0dSBarry Smith if (flg) { 578792fecdfSBarry Smith PetscCallSAWs(SAWs_Set_Document_Root,(root)); 5799566063dSJacob Faibussowitsch PetscCall(PetscStrcmp(root,".",&rootlocal)); 5809c1e0ce8SBarry Smith } else { 5819566063dSJacob Faibussowitsch PetscCall(PetscOptionsHasName(NULL,NULL,"-saws_options",&flg)); 5829c1e0ce8SBarry Smith if (flg) { 5839566063dSJacob Faibussowitsch PetscCall(PetscStrreplace(PETSC_COMM_WORLD,"${PETSC_DIR}/share/petsc/saws",root,sizeof(root))); 584792fecdfSBarry Smith PetscCallSAWs(SAWs_Set_Document_Root,(root)); 5859c1e0ce8SBarry Smith } 58611525c0dSBarry Smith } 5879566063dSJacob Faibussowitsch PetscCall(PetscOptionsHasName(NULL,NULL,"-saws_local",&flg2)); 58811525c0dSBarry Smith if (flg2) { 58911525c0dSBarry Smith char jsdir[PETSC_MAX_PATH_LEN]; 59028b400f6SJacob Faibussowitsch PetscCheck(flg,PETSC_COMM_SELF,PETSC_ERR_SUP,"-saws_local option requires -saws_root option"); 5919566063dSJacob Faibussowitsch PetscCall(PetscSNPrintf(jsdir,sizeof(jsdir),"%s/js",root)); 5929566063dSJacob Faibussowitsch PetscCall(PetscTestDirectory(jsdir,'r',&flg)); 59328b400f6SJacob Faibussowitsch PetscCheck(flg,PETSC_COMM_SELF,PETSC_ERR_FILE_READ,"-saws_local option requires js directory in root directory"); 594792fecdfSBarry Smith PetscCallSAWs(SAWs_Push_Local_Header,()); 59511525c0dSBarry Smith } 5969566063dSJacob Faibussowitsch PetscCall(PetscGetProgramName(programname,sizeof(programname))); 5979566063dSJacob Faibussowitsch PetscCall(PetscStrlen(help,&applinelen)); 59811525c0dSBarry Smith introlen = 4096 + applinelen; 59930a8c9c0SSurtai Han applinelen += 1024; 6009566063dSJacob Faibussowitsch PetscCall(PetscMalloc(applinelen,&appline)); 6019566063dSJacob Faibussowitsch PetscCall(PetscMalloc(introlen,&intro)); 60211525c0dSBarry Smith 60311525c0dSBarry Smith if (rootlocal) { 6049566063dSJacob Faibussowitsch PetscCall(PetscSNPrintf(appline,applinelen,"%s.c.html",programname)); 6059566063dSJacob Faibussowitsch PetscCall(PetscTestFile(appline,'r',&rootlocal)); 60611525c0dSBarry Smith } 6079566063dSJacob Faibussowitsch PetscCall(PetscOptionsGetAll(NULL,&options)); 60811525c0dSBarry Smith if (rootlocal && help) { 6099566063dSJacob 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)); 61011525c0dSBarry Smith } else if (help) { 6119566063dSJacob Faibussowitsch PetscCall(PetscSNPrintf(appline,applinelen,"<center>Running %s %s</center><br><center><pre>%s</pre></center><br>",programname,options,help)); 61211525c0dSBarry Smith } else { 6139566063dSJacob Faibussowitsch PetscCall(PetscSNPrintf(appline,applinelen,"<center> Running %s %s</center><br>\n",programname,options)); 61411525c0dSBarry Smith } 6159566063dSJacob Faibussowitsch PetscCall(PetscFree(options)); 6169566063dSJacob Faibussowitsch PetscCall(PetscGetVersion(version,sizeof(version))); 6179566063dSJacob Faibussowitsch PetscCall(PetscSNPrintf(intro,introlen,"<body>\n" 618a17b96a8SKyle 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" 619df62c222SBarry 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" 6205f80ce2aSJacob Faibussowitsch "%s",version,petscconfigureoptions,appline)); 621792fecdfSBarry Smith PetscCallSAWs(SAWs_Push_Body,("index.html",0,intro)); 6229566063dSJacob Faibussowitsch PetscCall(PetscFree(intro)); 6239566063dSJacob Faibussowitsch PetscCall(PetscFree(appline)); 624ffbd1cfbSBarry Smith if (selectport) { 625aa573868SBarry Smith PetscBool silent; 6267d812c46SBarry Smith 6277d812c46SBarry Smith /* another process may have grabbed the port so keep trying */ 62839a651e2SJacob Faibussowitsch while (SAWs_Initialize()) { 629792fecdfSBarry Smith PetscCallSAWs(SAWs_Get_Available_Port,(&port)); 630792fecdfSBarry Smith PetscCallSAWs(SAWs_Set_Port,(port)); 6317d812c46SBarry Smith } 6327d812c46SBarry Smith 6339566063dSJacob Faibussowitsch PetscCall(PetscOptionsGetBool(NULL,NULL,"-saws_port_auto_select_silent",&silent,NULL)); 634aa573868SBarry Smith if (!silent) { 635792fecdfSBarry Smith PetscCallSAWs(SAWs_Get_FullURL,(sizeof(sawsurl),sawsurl)); 6369566063dSJacob Faibussowitsch PetscCall(PetscPrintf(PETSC_COMM_WORLD,"Point your browser to %s for SAWs\n",sawsurl)); 637ffbd1cfbSBarry Smith } 6387d812c46SBarry Smith } else { 639792fecdfSBarry Smith PetscCallSAWs(SAWs_Initialize,()); 640aa573868SBarry Smith } 6419566063dSJacob Faibussowitsch PetscCall(PetscCitationsRegister("@TechReport{ saws,\n" 6420af79b04SBarry Smith " Author = {Matt Otten and Jed Brown and Barry Smith},\n" 6430af79b04SBarry Smith " Title = {Scientific Application Web Server (SAWs) Users Manual},\n" 6440af79b04SBarry Smith " Institution = {Argonne National Laboratory},\n" 6455f80ce2aSJacob Faibussowitsch " Year = 2013\n}\n",NULL)); 64611525c0dSBarry Smith } 64711525c0dSBarry Smith PetscFunctionReturn(0); 64811525c0dSBarry Smith } 64911525c0dSBarry Smith #endif 65011525c0dSBarry Smith 6514dfee713SSatish Balay /* Things must be done before MPI_Init() when MPI is not yet initialized, and can be shared between C init and Fortran init */ 6524dfee713SSatish Balay PETSC_INTERN PetscErrorCode PetscPreMPIInit_Private(void) 6534dfee713SSatish Balay { 6544dfee713SSatish Balay PetscFunctionBegin; 6554dfee713SSatish Balay #if defined(PETSC_HAVE_HWLOC_SOLARIS_BUG) 6564dfee713SSatish Balay /* see MPI.py for details on this bug */ 6574dfee713SSatish Balay (void) setenv("HWLOC_COMPONENTS","-x86",1); 6584dfee713SSatish Balay #endif 6594dfee713SSatish Balay PetscFunctionReturn(0); 6604dfee713SSatish Balay } 6614dfee713SSatish Balay 662a4af0ceeSJacob Faibussowitsch #if PetscDefined(HAVE_ADIOS) 663a56f64adSBarry Smith #include <adios.h> 66422580e64SBarry Smith #include <adios_read.h> 6657b56e58cSSatish Balay int64_t Petsc_adios_group; 666a56f64adSBarry Smith #endif 667a4af0ceeSJacob Faibussowitsch #if PetscDefined(HAVE_OPENMP) 668cd1b99a6SBarry Smith #include <omp.h> 669f90b075cSBarry Smith PetscInt PetscNumOMPThreads; 670cd1b99a6SBarry Smith #endif 671a56f64adSBarry Smith 672a4af0ceeSJacob Faibussowitsch #if PetscDefined(HAVE_DEVICE) 673a4af0ceeSJacob Faibussowitsch #include <petsc/private/deviceimpl.h> 674a4af0ceeSJacob Faibussowitsch # if PetscDefined(HAVE_CUDA) 675a4af0ceeSJacob Faibussowitsch // REMOVE ME 676a4af0ceeSJacob Faibussowitsch cudaStream_t PetscDefaultCudaStream = NULL; 677a4af0ceeSJacob Faibussowitsch # endif 678a4af0ceeSJacob Faibussowitsch # if PetscDefined(HAVE_HIP) 679a4af0ceeSJacob Faibussowitsch // REMOVE ME 680a4af0ceeSJacob Faibussowitsch hipStream_t PetscDefaultHipStream = NULL; 681a4af0ceeSJacob Faibussowitsch # endif 682a4af0ceeSJacob Faibussowitsch #endif 683a4af0ceeSJacob Faibussowitsch 68427104ee2SJacob Faibussowitsch #if PetscDefined(HAVE_DLFCN_H) 685bc8a24ecSBarry Smith #include <dlfcn.h> 686bc8a24ecSBarry Smith #endif 687a4af0ceeSJacob Faibussowitsch #if PetscDefined(USE_LOG) 688a4af0ceeSJacob Faibussowitsch PETSC_INTERN PetscErrorCode PetscLogInitialize(void); 689a4af0ceeSJacob Faibussowitsch #endif 690a4af0ceeSJacob Faibussowitsch #if PetscDefined(HAVE_VIENNACL) 691a4af0ceeSJacob Faibussowitsch PETSC_EXTERN PetscErrorCode PetscViennaCLInit(); 692a4af0ceeSJacob Faibussowitsch PetscBool PetscViennaCLSynchronize = PETSC_FALSE; 693a4af0ceeSJacob Faibussowitsch #endif 694bc8a24ecSBarry Smith 695*660278c0SBarry Smith PetscBool PetscCIEnabled = PETSC_FALSE, PetscCIEnabledPortableErrorOutput = PETSC_FALSE; 696*660278c0SBarry Smith 69785649d77SJunchao Zhang /* 69885649d77SJunchao Zhang PetscInitialize_Common - shared code between C and Fortran initialization 69985649d77SJunchao Zhang 70085649d77SJunchao Zhang prog: program name 70102101c96SSatish Balay file: optional PETSc database file name. Might be in Fortran string format when 'ftn' is true 70285649d77SJunchao Zhang help: program help message 70302101c96SSatish Balay ftn: is it called from Fortran initilization (petscinitializef_)? 70485649d77SJunchao Zhang readarguments,len: used when fortran is true 70585649d77SJunchao Zhang */ 70602101c96SSatish Balay PETSC_INTERN PetscErrorCode PetscInitialize_Common(const char* prog,const char* file,const char *help,PetscBool ftn,PetscBool readarguments,PetscInt len) 70785649d77SJunchao Zhang { 70885649d77SJunchao Zhang PetscMPIInt size; 70985649d77SJunchao Zhang PetscBool flg = PETSC_TRUE; 71085649d77SJunchao Zhang char hostname[256]; 71185649d77SJunchao Zhang 71227104ee2SJacob Faibussowitsch PetscFunctionBegin; 71327104ee2SJacob Faibussowitsch if (PetscInitializeCalled) PetscFunctionReturn(0); 71439a651e2SJacob Faibussowitsch /* these must be initialized in a routine, not as a constant declaration */ 71539a651e2SJacob Faibussowitsch PETSC_STDOUT = stdout; 71639a651e2SJacob Faibussowitsch PETSC_STDERR = stderr; 71739a651e2SJacob Faibussowitsch 7189566063dSJacob Faibussowitsch /* PetscCall can be used from now */ 71939a651e2SJacob Faibussowitsch PetscErrorHandlingInitialized = PETSC_TRUE; 72039a651e2SJacob Faibussowitsch 72185649d77SJunchao Zhang /* 72285649d77SJunchao Zhang The checking over compatible runtime libraries is complicated by the MPI ABI initiative 72385649d77SJunchao Zhang https://wiki.mpich.org/mpich/index.php/ABI_Compatibility_Initiative which started with 72485649d77SJunchao Zhang MPICH v3.1 (Released February 2014) 72585649d77SJunchao Zhang IBM MPI v2.1 (December 2014) 72685649d77SJunchao Zhang Intel MPI Library v5.0 (2014) 72785649d77SJunchao Zhang Cray MPT v7.0.0 (June 2014) 72885649d77SJunchao Zhang As of July 31, 2017 the ABI number still appears to be 12, that is all of the versions 72985649d77SJunchao Zhang listed above and since that time are compatible. 73085649d77SJunchao Zhang 73185649d77SJunchao Zhang Unfortunately the MPI ABI initiative has not defined a way to determine the ABI number 73285649d77SJunchao Zhang at compile time or runtime. Thus we will need to systematically track the allowed versions 73385649d77SJunchao Zhang and how they are represented in the mpi.h and MPI_Get_library_version() output in order 73485649d77SJunchao Zhang to perform the checking. 73585649d77SJunchao Zhang 73685649d77SJunchao Zhang Currently we only check for pre MPI ABI versions (and packages that do not follow the MPI ABI). 73785649d77SJunchao Zhang 73885649d77SJunchao Zhang Questions: 73985649d77SJunchao Zhang 74085649d77SJunchao Zhang Should the checks for ABI incompatibility be only on the major version number below? 74185649d77SJunchao Zhang Presumably the output to stderr will be removed before a release. 74285649d77SJunchao Zhang */ 74385649d77SJunchao Zhang 74485649d77SJunchao Zhang #if defined(PETSC_HAVE_MPI_GET_LIBRARY_VERSION) 74585649d77SJunchao Zhang { 74685649d77SJunchao Zhang char mpilibraryversion[MPI_MAX_LIBRARY_VERSION_STRING]; 74785649d77SJunchao Zhang PetscMPIInt mpilibraryversionlength; 74839a651e2SJacob Faibussowitsch 7499566063dSJacob Faibussowitsch PetscCallMPI(MPI_Get_library_version(mpilibraryversion,&mpilibraryversionlength)); 75085649d77SJunchao Zhang /* check for MPICH versions before MPI ABI initiative */ 75185649d77SJunchao Zhang #if defined(MPICH_VERSION) 75285649d77SJunchao Zhang #if MPICH_NUMVERSION < 30100000 75385649d77SJunchao Zhang { 75485649d77SJunchao Zhang char *ver,*lf; 75585649d77SJunchao Zhang PetscBool flg = PETSC_FALSE; 75639a651e2SJacob Faibussowitsch 7579566063dSJacob Faibussowitsch PetscCall(PetscStrstr(mpilibraryversion,"MPICH Version:",&ver)); 75839a651e2SJacob Faibussowitsch if (ver) { 7599566063dSJacob Faibussowitsch PetscCall(PetscStrchr(ver,'\n',&lf)); 76039a651e2SJacob Faibussowitsch if (lf) { 76185649d77SJunchao Zhang *lf = 0; 7629566063dSJacob Faibussowitsch PetscCall(PetscStrendswith(ver,MPICH_VERSION,&flg)); 76385649d77SJunchao Zhang } 76485649d77SJunchao Zhang } 76585649d77SJunchao Zhang if (!flg) { 766d5b396e8SSatish Balay PetscCall(PetscInfo(NULL,"PETSc warning --- MPICH library version \n%s does not match what PETSc was compiled with %s.\n",mpilibraryversion,MPICH_VERSION)); 76785649d77SJunchao Zhang flg = PETSC_TRUE; 76885649d77SJunchao Zhang } 76985649d77SJunchao Zhang } 77085649d77SJunchao Zhang #endif 77185649d77SJunchao 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?) */ 77285649d77SJunchao Zhang #elif defined(OMPI_MAJOR_VERSION) 77385649d77SJunchao Zhang { 77485649d77SJunchao Zhang char *ver,bs[MPI_MAX_LIBRARY_VERSION_STRING],*bsf; 77585649d77SJunchao Zhang PetscBool flg = PETSC_FALSE; 77685649d77SJunchao Zhang #define PSTRSZ 2 77785649d77SJunchao Zhang char ompistr1[PSTRSZ][MPI_MAX_LIBRARY_VERSION_STRING] = {"Open MPI","FUJITSU MPI"}; 77885649d77SJunchao Zhang char ompistr2[PSTRSZ][MPI_MAX_LIBRARY_VERSION_STRING] = {"v","Library "}; 77985649d77SJunchao Zhang int i; 78085649d77SJunchao Zhang for (i=0; i<PSTRSZ; i++) { 7819566063dSJacob Faibussowitsch PetscCall(PetscStrstr(mpilibraryversion,ompistr1[i],&ver)); 78239a651e2SJacob Faibussowitsch if (ver) { 7839566063dSJacob Faibussowitsch PetscCall(PetscSNPrintf(bs,MPI_MAX_LIBRARY_VERSION_STRING,"%s%d.%d",ompistr2[i],OMPI_MAJOR_VERSION,OMPI_MINOR_VERSION)); 7849566063dSJacob Faibussowitsch PetscCall(PetscStrstr(ver,bs,&bsf)); 78539a651e2SJacob Faibussowitsch if (bsf) flg = PETSC_TRUE; 78685649d77SJunchao Zhang break; 78785649d77SJunchao Zhang } 78885649d77SJunchao Zhang } 78985649d77SJunchao Zhang if (!flg) { 7907d3de750SJacob 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); 79185649d77SJunchao Zhang flg = PETSC_TRUE; 79285649d77SJunchao Zhang } 79385649d77SJunchao Zhang } 79485649d77SJunchao Zhang #endif 79585649d77SJunchao Zhang } 79685649d77SJunchao Zhang #endif 79785649d77SJunchao Zhang 7986f5d4113SSatish Balay #if PetscDefined(HAVE_DLSYM) && defined(__USE_GNU) 79985649d77SJunchao 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 */ 80039a651e2SJacob 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"); 80185649d77SJunchao Zhang #endif 80285649d77SJunchao Zhang 80385649d77SJunchao Zhang /* on Windows - set printf to default to printing 2 digit exponents */ 80485649d77SJunchao Zhang #if defined(PETSC_HAVE__SET_OUTPUT_FORMAT) 80585649d77SJunchao Zhang _set_output_format(_TWO_DIGIT_EXPONENT); 80685649d77SJunchao Zhang #endif 80785649d77SJunchao Zhang 8089566063dSJacob Faibussowitsch PetscCall(PetscOptionsCreateDefault()); 80985649d77SJunchao Zhang 81085649d77SJunchao Zhang PetscFinalizeCalled = PETSC_FALSE; 81185649d77SJunchao Zhang 8129566063dSJacob Faibussowitsch PetscCall(PetscSetProgramName(prog)); 8139566063dSJacob Faibussowitsch PetscCall(PetscSpinlockCreate(&PetscViewerASCIISpinLockOpen)); 8149566063dSJacob Faibussowitsch PetscCall(PetscSpinlockCreate(&PetscViewerASCIISpinLockStdout)); 8159566063dSJacob Faibussowitsch PetscCall(PetscSpinlockCreate(&PetscViewerASCIISpinLockStderr)); 8169566063dSJacob Faibussowitsch PetscCall(PetscSpinlockCreate(&PetscCommSpinLock)); 81785649d77SJunchao Zhang 81885649d77SJunchao Zhang if (PETSC_COMM_WORLD == MPI_COMM_NULL) PETSC_COMM_WORLD = MPI_COMM_WORLD; 8199566063dSJacob Faibussowitsch PetscCallMPI(MPI_Comm_set_errhandler(PETSC_COMM_WORLD,MPI_ERRORS_RETURN)); 82085649d77SJunchao Zhang 82185649d77SJunchao Zhang if (PETSC_MPI_ERROR_CLASS == MPI_ERR_LASTCODE) { 8229566063dSJacob Faibussowitsch PetscCallMPI(MPI_Add_error_class(&PETSC_MPI_ERROR_CLASS)); 8239566063dSJacob Faibussowitsch PetscCallMPI(MPI_Add_error_code(PETSC_MPI_ERROR_CLASS,&PETSC_MPI_ERROR_CODE)); 82485649d77SJunchao Zhang } 82585649d77SJunchao Zhang 82685649d77SJunchao Zhang /* Done after init due to a bug in MPICH-GM? */ 8279566063dSJacob Faibussowitsch PetscCall(PetscErrorPrintfInitialize()); 82885649d77SJunchao Zhang 8299566063dSJacob Faibussowitsch PetscCallMPI(MPI_Comm_rank(MPI_COMM_WORLD,&PetscGlobalRank)); 8309566063dSJacob Faibussowitsch PetscCallMPI(MPI_Comm_size(MPI_COMM_WORLD,&PetscGlobalSize)); 83185649d77SJunchao Zhang 83285649d77SJunchao Zhang MPIU_BOOL = MPI_INT; 83385649d77SJunchao Zhang MPIU_ENUM = MPI_INT; 83485649d77SJunchao Zhang MPIU_FORTRANADDR = (sizeof(void*) == sizeof(int)) ? MPI_INT : MPIU_INT64; 83585649d77SJunchao Zhang if (sizeof(size_t) == sizeof(unsigned)) MPIU_SIZE_T = MPI_UNSIGNED; 83685649d77SJunchao Zhang else if (sizeof(size_t) == sizeof(unsigned long)) MPIU_SIZE_T = MPI_UNSIGNED_LONG; 83785649d77SJunchao Zhang #if defined(PETSC_SIZEOF_LONG_LONG) 83885649d77SJunchao Zhang else if (sizeof(size_t) == sizeof(unsigned long long)) MPIU_SIZE_T = MPI_UNSIGNED_LONG_LONG; 83985649d77SJunchao Zhang #endif 84039a651e2SJacob Faibussowitsch else SETERRQ(PETSC_COMM_WORLD,PETSC_ERR_SUP_SYS,"Could not find MPI type for size_t"); 84185649d77SJunchao Zhang 84285649d77SJunchao Zhang /* 84385649d77SJunchao Zhang Initialized the global complex variable; this is because with 84485649d77SJunchao Zhang shared libraries the constructors for global variables 84585649d77SJunchao Zhang are not called; at least on IRIX. 84685649d77SJunchao Zhang */ 84785649d77SJunchao Zhang #if defined(PETSC_HAVE_COMPLEX) 84885649d77SJunchao Zhang { 84985649d77SJunchao Zhang #if defined(PETSC_CLANGUAGE_CXX) && !defined(PETSC_USE_REAL___FLOAT128) 85085649d77SJunchao Zhang PetscComplex ic(0.0,1.0); 85185649d77SJunchao Zhang PETSC_i = ic; 85285649d77SJunchao Zhang #else 85385649d77SJunchao Zhang PETSC_i = _Complex_I; 85485649d77SJunchao Zhang #endif 85585649d77SJunchao Zhang } 85685649d77SJunchao Zhang #endif /* PETSC_HAVE_COMPLEX */ 85785649d77SJunchao Zhang 85885649d77SJunchao Zhang /* 85985649d77SJunchao Zhang Create the PETSc MPI reduction operator that sums of the first 86085649d77SJunchao Zhang half of the entries and maxes the second half. 86185649d77SJunchao Zhang */ 8629566063dSJacob Faibussowitsch PetscCallMPI(MPI_Op_create(MPIU_MaxSum_Local,1,&MPIU_MAXSUM_OP)); 86385649d77SJunchao Zhang 86485649d77SJunchao Zhang #if defined(PETSC_USE_REAL___FLOAT128) 8659566063dSJacob Faibussowitsch PetscCallMPI(MPI_Type_contiguous(2,MPI_DOUBLE,&MPIU___FLOAT128)); 8669566063dSJacob Faibussowitsch PetscCallMPI(MPI_Type_commit(&MPIU___FLOAT128)); 86785649d77SJunchao Zhang #if defined(PETSC_HAVE_COMPLEX) 8689566063dSJacob Faibussowitsch PetscCallMPI(MPI_Type_contiguous(4,MPI_DOUBLE,&MPIU___COMPLEX128)); 8699566063dSJacob Faibussowitsch PetscCallMPI(MPI_Type_commit(&MPIU___COMPLEX128)); 87085649d77SJunchao Zhang #endif 8719566063dSJacob Faibussowitsch PetscCallMPI(MPI_Op_create(PetscMax_Local,1,&MPIU_MAX)); 8729566063dSJacob Faibussowitsch PetscCallMPI(MPI_Op_create(PetscMin_Local,1,&MPIU_MIN)); 87385649d77SJunchao Zhang #elif defined(PETSC_USE_REAL___FP16) 8749566063dSJacob Faibussowitsch PetscCallMPI(MPI_Type_contiguous(2,MPI_CHAR,&MPIU___FP16)); 8759566063dSJacob Faibussowitsch PetscCallMPI(MPI_Type_commit(&MPIU___FP16)); 8769566063dSJacob Faibussowitsch PetscCallMPI(MPI_Op_create(PetscMax_Local,1,&MPIU_MAX)); 8779566063dSJacob Faibussowitsch PetscCallMPI(MPI_Op_create(PetscMin_Local,1,&MPIU_MIN)); 87885649d77SJunchao Zhang #endif 87985649d77SJunchao Zhang 88085649d77SJunchao Zhang #if defined(PETSC_USE_REAL___FLOAT128) || defined(PETSC_USE_REAL___FP16) 8819566063dSJacob Faibussowitsch PetscCallMPI(MPI_Op_create(PetscSum_Local,1,&MPIU_SUM)); 88285649d77SJunchao Zhang #endif 88385649d77SJunchao Zhang 8849566063dSJacob Faibussowitsch PetscCallMPI(MPI_Type_contiguous(2,MPIU_SCALAR,&MPIU_2SCALAR)); 8859566063dSJacob Faibussowitsch PetscCallMPI(MPI_Type_commit(&MPIU_2SCALAR)); 88685649d77SJunchao Zhang 88785649d77SJunchao Zhang /* create datatypes used by MPIU_MAXLOC, MPIU_MINLOC and PetscSplitReduction_Op */ 88885649d77SJunchao Zhang #if !defined(PETSC_HAVE_MPIUNI) 88985649d77SJunchao Zhang { 89085649d77SJunchao Zhang struct PetscRealInt { PetscReal v; PetscInt i; }; 89185649d77SJunchao Zhang PetscMPIInt blockSizes[2] = {1,1}; 89285649d77SJunchao Zhang MPI_Aint blockOffsets[2] = {offsetof(struct PetscRealInt,v),offsetof(struct PetscRealInt,i)}; 89385649d77SJunchao Zhang MPI_Datatype blockTypes[2] = {MPIU_REAL,MPIU_INT}, tmpStruct; 89485649d77SJunchao Zhang 8959566063dSJacob Faibussowitsch PetscCallMPI(MPI_Type_create_struct(2,blockSizes,blockOffsets,blockTypes,&tmpStruct)); 8969566063dSJacob Faibussowitsch PetscCallMPI(MPI_Type_create_resized(tmpStruct,0,sizeof(struct PetscRealInt),&MPIU_REAL_INT)); 8979566063dSJacob Faibussowitsch PetscCallMPI(MPI_Type_free(&tmpStruct)); 8989566063dSJacob Faibussowitsch PetscCallMPI(MPI_Type_commit(&MPIU_REAL_INT)); 89985649d77SJunchao Zhang } 90085649d77SJunchao Zhang { 90185649d77SJunchao Zhang struct PetscScalarInt { PetscScalar v; PetscInt i; }; 90285649d77SJunchao Zhang PetscMPIInt blockSizes[2] = {1,1}; 90385649d77SJunchao Zhang MPI_Aint blockOffsets[2] = {offsetof(struct PetscScalarInt,v),offsetof(struct PetscScalarInt,i)}; 90485649d77SJunchao Zhang MPI_Datatype blockTypes[2] = {MPIU_SCALAR,MPIU_INT}, tmpStruct; 90585649d77SJunchao Zhang 9069566063dSJacob Faibussowitsch PetscCallMPI(MPI_Type_create_struct(2,blockSizes,blockOffsets,blockTypes,&tmpStruct)); 9079566063dSJacob Faibussowitsch PetscCallMPI(MPI_Type_create_resized(tmpStruct,0,sizeof(struct PetscScalarInt),&MPIU_SCALAR_INT)); 9089566063dSJacob Faibussowitsch PetscCallMPI(MPI_Type_free(&tmpStruct)); 9099566063dSJacob Faibussowitsch PetscCallMPI(MPI_Type_commit(&MPIU_SCALAR_INT)); 91085649d77SJunchao Zhang } 91185649d77SJunchao Zhang #endif 91285649d77SJunchao Zhang 91385649d77SJunchao Zhang #if defined(PETSC_USE_64BIT_INDICES) 9149566063dSJacob Faibussowitsch PetscCallMPI(MPI_Type_contiguous(2,MPIU_INT,&MPIU_2INT)); 9159566063dSJacob Faibussowitsch PetscCallMPI(MPI_Type_commit(&MPIU_2INT)); 91685649d77SJunchao Zhang #endif 9179566063dSJacob Faibussowitsch PetscCallMPI(MPI_Type_contiguous(4,MPI_INT,&MPI_4INT)); 9189566063dSJacob Faibussowitsch PetscCallMPI(MPI_Type_commit(&MPI_4INT)); 9199566063dSJacob Faibussowitsch PetscCallMPI(MPI_Type_contiguous(4,MPIU_INT,&MPIU_4INT)); 9209566063dSJacob Faibussowitsch PetscCallMPI(MPI_Type_commit(&MPIU_4INT)); 92185649d77SJunchao Zhang 92285649d77SJunchao Zhang /* 92385649d77SJunchao Zhang Attributes to be set on PETSc communicators 92485649d77SJunchao Zhang */ 9259566063dSJacob Faibussowitsch PetscCallMPI(MPI_Comm_create_keyval(MPI_COMM_NULL_COPY_FN,Petsc_Counter_Attr_Delete_Fn,&Petsc_Counter_keyval,(void*)0)); 9269566063dSJacob Faibussowitsch PetscCallMPI(MPI_Comm_create_keyval(MPI_COMM_NULL_COPY_FN,Petsc_InnerComm_Attr_Delete_Fn,&Petsc_InnerComm_keyval,(void*)0)); 9279566063dSJacob Faibussowitsch PetscCallMPI(MPI_Comm_create_keyval(MPI_COMM_NULL_COPY_FN,Petsc_OuterComm_Attr_Delete_Fn,&Petsc_OuterComm_keyval,(void*)0)); 9289566063dSJacob Faibussowitsch PetscCallMPI(MPI_Comm_create_keyval(MPI_COMM_NULL_COPY_FN,Petsc_ShmComm_Attr_Delete_Fn,&Petsc_ShmComm_keyval,(void*)0)); 92985649d77SJunchao Zhang 93085649d77SJunchao Zhang #if defined(PETSC_HAVE_FORTRAN) 9319566063dSJacob Faibussowitsch if (ftn) PetscCall(PetscInitFortran_Private(readarguments,file,len)); 93285649d77SJunchao Zhang else 93385649d77SJunchao Zhang #endif 9349566063dSJacob Faibussowitsch PetscCall(PetscOptionsInsert(NULL,&PetscGlobalArgc,&PetscGlobalArgs,file)); 93585649d77SJunchao Zhang 93685649d77SJunchao Zhang /* call a second time so it can look in the options database */ 9379566063dSJacob Faibussowitsch PetscCall(PetscErrorPrintfInitialize()); 93885649d77SJunchao Zhang 93985649d77SJunchao Zhang /* 94085649d77SJunchao Zhang Check system options and print help 94185649d77SJunchao Zhang */ 9429566063dSJacob Faibussowitsch PetscCall(PetscOptionsCheckInitial_Private(help)); 94385649d77SJunchao Zhang 944a4af0ceeSJacob Faibussowitsch /* 945a4af0ceeSJacob Faibussowitsch Initialize PetscDevice and PetscDeviceContext 946a4af0ceeSJacob Faibussowitsch 947a4af0ceeSJacob Faibussowitsch Note to any future devs thinking of moving this, proper initialization requires: 948a4af0ceeSJacob Faibussowitsch 1. MPI initialized 949a4af0ceeSJacob Faibussowitsch 2. Options DB initialized 950a4af0ceeSJacob Faibussowitsch 3. Petsc error handling initialized, specifically signal handlers. This expects to set up its own SIGSEV handler via 951a4af0ceeSJacob Faibussowitsch the push/pop interface. 952a4af0ceeSJacob Faibussowitsch */ 953a2158755SJunchao Zhang #if (PetscDefined(HAVE_CUDA) || PetscDefined(HAVE_HIP) || PetscDefined(HAVE_SYCL)) 9549566063dSJacob Faibussowitsch PetscCall(PetscDeviceInitializeFromOptions_Internal(PETSC_COMM_WORLD)); 955a4af0ceeSJacob Faibussowitsch #endif 956a4af0ceeSJacob Faibussowitsch 957a4af0ceeSJacob Faibussowitsch #if PetscDefined(HAVE_VIENNACL) 958a4af0ceeSJacob Faibussowitsch flg = PETSC_FALSE; 9599566063dSJacob Faibussowitsch PetscCall(PetscOptionsHasName(NULL,NULL,"-log_summary",&flg)); 9609566063dSJacob Faibussowitsch if (!flg) PetscCall(PetscOptionsHasName(NULL,NULL,"-log_view",&flg)); 9619566063dSJacob Faibussowitsch if (!flg) PetscCall(PetscOptionsGetBool(NULL,NULL,"-viennacl_synchronize",&flg,NULL)); 962a4af0ceeSJacob Faibussowitsch PetscViennaCLSynchronize = flg; 9639566063dSJacob Faibussowitsch PetscCall(PetscViennaCLInit()); 964a4af0ceeSJacob Faibussowitsch #endif 965a4af0ceeSJacob Faibussowitsch 966a4af0ceeSJacob Faibussowitsch /* 967a4af0ceeSJacob Faibussowitsch Creates the logging data structures; this is enabled even if logging is not turned on 968a4af0ceeSJacob Faibussowitsch This is the last thing we do before returning to the user code to prevent having the 969a4af0ceeSJacob Faibussowitsch logging numbers contaminated by any startup time associated with MPI 970a4af0ceeSJacob Faibussowitsch */ 971a4af0ceeSJacob Faibussowitsch #if defined(PETSC_USE_LOG) 9729566063dSJacob Faibussowitsch PetscCall(PetscLogInitialize()); 973a4af0ceeSJacob Faibussowitsch #endif 974a4af0ceeSJacob Faibussowitsch 9759566063dSJacob Faibussowitsch PetscCall(PetscCitationsInitialize()); 97685649d77SJunchao Zhang 97785649d77SJunchao Zhang #if defined(PETSC_HAVE_SAWS) 9789566063dSJacob Faibussowitsch PetscCall(PetscInitializeSAWs(ftn ? NULL : help)); 97927104ee2SJacob Faibussowitsch flg = PETSC_FALSE; 9809566063dSJacob Faibussowitsch PetscCall(PetscOptionsHasName(NULL,NULL,"-stack_view",&flg)); 9819566063dSJacob Faibussowitsch if (flg) PetscCall(PetscStackViewSAWs()); 98285649d77SJunchao Zhang #endif 98385649d77SJunchao Zhang 98485649d77SJunchao Zhang /* 98585649d77SJunchao Zhang Load the dynamic libraries (on machines that support them), this registers all 98685649d77SJunchao Zhang the solvers etc. (On non-dynamic machines this initializes the PetscDraw and PetscViewer classes) 98785649d77SJunchao Zhang */ 9889566063dSJacob Faibussowitsch PetscCall(PetscInitialize_DynamicLibraries()); 98985649d77SJunchao Zhang 9909566063dSJacob Faibussowitsch PetscCallMPI(MPI_Comm_size(PETSC_COMM_WORLD,&size)); 9919566063dSJacob Faibussowitsch PetscCall(PetscInfo(NULL,"PETSc successfully started: number of processors = %d\n",size)); 9929566063dSJacob Faibussowitsch PetscCall(PetscGetHostName(hostname,256)); 9939566063dSJacob Faibussowitsch PetscCall(PetscInfo(NULL,"Running on machine: %s\n",hostname)); 99485649d77SJunchao Zhang #if defined(PETSC_HAVE_OPENMP) 99585649d77SJunchao Zhang { 99685649d77SJunchao Zhang PetscBool omp_view_flag; 99785649d77SJunchao Zhang char *threads = getenv("OMP_NUM_THREADS"); 99885649d77SJunchao Zhang 99985649d77SJunchao Zhang if (threads) { 10009566063dSJacob Faibussowitsch PetscCall(PetscInfo(NULL,"Number of OpenMP threads %s (as given by OMP_NUM_THREADS)\n",threads)); 100185649d77SJunchao Zhang (void) sscanf(threads, "%" PetscInt_FMT,&PetscNumOMPThreads); 100285649d77SJunchao Zhang } else { 10032f840973SStefano Zampini PetscNumOMPThreads = (PetscInt) omp_get_max_threads(); 10049566063dSJacob Faibussowitsch PetscCall(PetscInfo(NULL,"Number of OpenMP threads %" PetscInt_FMT " (as given by omp_get_max_threads())\n",PetscNumOMPThreads)); 100585649d77SJunchao Zhang } 1006d0609cedSBarry Smith PetscOptionsBegin(PETSC_COMM_WORLD,NULL,"OpenMP options","Sys"); 10079566063dSJacob Faibussowitsch PetscCall(PetscOptionsInt("-omp_num_threads","Number of OpenMP threads to use (can also use environmental variable OMP_NUM_THREADS","None",PetscNumOMPThreads,&PetscNumOMPThreads,&flg)); 10089566063dSJacob Faibussowitsch PetscCall(PetscOptionsName("-omp_view","Display OpenMP number of threads",NULL,&omp_view_flag)); 1009d0609cedSBarry Smith PetscOptionsEnd(); 101085649d77SJunchao Zhang if (flg) { 10119566063dSJacob Faibussowitsch PetscCall(PetscInfo(NULL,"Number of OpenMP theads %" PetscInt_FMT " (given by -omp_num_threads)\n",PetscNumOMPThreads)); 101285649d77SJunchao Zhang omp_set_num_threads((int)PetscNumOMPThreads); 101385649d77SJunchao Zhang } 101485649d77SJunchao Zhang if (omp_view_flag) { 10159566063dSJacob Faibussowitsch PetscCall(PetscPrintf(PETSC_COMM_WORLD,"OpenMP: number of threads %" PetscInt_FMT "\n",PetscNumOMPThreads)); 101685649d77SJunchao Zhang } 101785649d77SJunchao Zhang } 101885649d77SJunchao Zhang #endif 101985649d77SJunchao Zhang 102085649d77SJunchao Zhang #if defined(PETSC_USE_PETSC_MPI_EXTERNAL32) 102185649d77SJunchao Zhang /* 102285649d77SJunchao Zhang Tell MPI about our own data representation converter, this would/should be used if extern32 is not supported by the MPI 102385649d77SJunchao Zhang 102485649d77SJunchao Zhang Currently not used because it is not supported by MPICH. 102585649d77SJunchao Zhang */ 10269566063dSJacob Faibussowitsch if (!PetscBinaryBigEndian()) PetscCallMPI(MPI_Register_datarep((char*)"petsc",PetscDataRep_read_conv_fn,PetscDataRep_write_conv_fn,PetscDataRep_extent_fn,NULL)); 102785649d77SJunchao Zhang #endif 102885649d77SJunchao Zhang 102985649d77SJunchao Zhang #if defined(PETSC_SERIALIZE_FUNCTIONS) 10309566063dSJacob Faibussowitsch PetscCall(PetscFPTCreate(10000)); 103185649d77SJunchao Zhang #endif 103285649d77SJunchao Zhang 103385649d77SJunchao Zhang #if defined(PETSC_HAVE_HWLOC) 103485649d77SJunchao Zhang { 103585649d77SJunchao Zhang PetscViewer viewer; 10369566063dSJacob Faibussowitsch PetscCall(PetscOptionsGetViewer(PETSC_COMM_WORLD,NULL,NULL,"-process_view",&viewer,NULL,&flg)); 103785649d77SJunchao Zhang if (flg) { 10389566063dSJacob Faibussowitsch PetscCall(PetscProcessPlacementView(viewer)); 10399566063dSJacob Faibussowitsch PetscCall(PetscViewerDestroy(&viewer)); 104085649d77SJunchao Zhang } 104185649d77SJunchao Zhang } 104285649d77SJunchao Zhang #endif 104385649d77SJunchao Zhang 104485649d77SJunchao Zhang flg = PETSC_TRUE; 10459566063dSJacob Faibussowitsch PetscCall(PetscOptionsGetBool(NULL,NULL,"-viewfromoptions",&flg,NULL)); 10469566063dSJacob Faibussowitsch if (!flg) PetscCall(PetscOptionsPushGetViewerOff(PETSC_TRUE)); 104785649d77SJunchao Zhang 104885649d77SJunchao Zhang #if defined(PETSC_HAVE_ADIOS) 10499566063dSJacob Faibussowitsch PetscCall(adios_init_noxml(PETSC_COMM_WORLD)); 10509566063dSJacob Faibussowitsch PetscCall(adios_declare_group(&Petsc_adios_group,"PETSc","",adios_stat_default)); 10519566063dSJacob Faibussowitsch PetscCall(adios_select_method(Petsc_adios_group,"MPI","","")); 10529566063dSJacob Faibussowitsch PetscCall(adios_read_init_method(ADIOS_READ_METHOD_BP,PETSC_COMM_WORLD,"")); 105385649d77SJunchao Zhang #endif 105485649d77SJunchao Zhang 105585649d77SJunchao Zhang #if defined(__VALGRIND_H) 105685649d77SJunchao Zhang PETSC_RUNNING_ON_VALGRIND = RUNNING_ON_VALGRIND? PETSC_TRUE: PETSC_FALSE; 105785649d77SJunchao Zhang #if defined(PETSC_USING_DARWIN) && defined(PETSC_BLASLAPACK_SDOT_RETURNS_DOUBLE) 10589566063dSJacob 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")); 105985649d77SJunchao Zhang #endif 106085649d77SJunchao Zhang #endif 106185649d77SJunchao Zhang /* 106285649d77SJunchao Zhang Set flag that we are completely initialized 106385649d77SJunchao Zhang */ 106485649d77SJunchao Zhang PetscInitializeCalled = PETSC_TRUE; 106585649d77SJunchao Zhang 10669566063dSJacob Faibussowitsch PetscCall(PetscOptionsHasName(NULL,NULL,"-python",&flg)); 10679566063dSJacob Faibussowitsch if (flg) PetscCall(PetscPythonInitialize(NULL,NULL)); 1068f1f2ae84SBarry Smith 1069f1f2ae84SBarry Smith PetscCall(PetscOptionsHasName(NULL,NULL,"-mpi_linear_solver_server",&flg)); 1070f1f2ae84SBarry Smith if (PetscDefined(USE_SINGLE_LIBRARY) && flg) PetscCall(PCMPIServerBegin()); 1071f1f2ae84SBarry Smith else PetscCheck(!flg,PETSC_COMM_WORLD,PETSC_ERR_SUP,"PETSc configured using -with-single-library=0; -mpi_linear_solver_server not supported in that case"); 107227104ee2SJacob Faibussowitsch PetscFunctionReturn(0); 107385649d77SJunchao Zhang } 107485649d77SJunchao Zhang 1075e5c89e4eSSatish Balay /*@C 1076e5c89e4eSSatish Balay PetscInitialize - Initializes the PETSc database and MPI. 1077e5c89e4eSSatish Balay PetscInitialize() calls MPI_Init() if that has yet to be called, 1078e5c89e4eSSatish Balay so this routine should always be called near the beginning of 1079e5c89e4eSSatish Balay your program -- usually the very first line! 1080e5c89e4eSSatish Balay 1081e5c89e4eSSatish Balay Collective on MPI_COMM_WORLD or PETSC_COMM_WORLD if it has been set 1082e5c89e4eSSatish Balay 1083e5c89e4eSSatish Balay Input Parameters: 1084e5c89e4eSSatish Balay + argc - count of number of command line arguments 1085e5c89e4eSSatish Balay . args - the command line arguments 1086be10d61cSLisandro Dalcin . file - [optional] PETSc database file, append ":yaml" to filename to specify YAML options format. 1087be10d61cSLisandro Dalcin Use NULL or empty string to not check for code specific file. 1088be10d61cSLisandro Dalcin Also checks ~/.petscrc, .petscrc and petscrc. 1089c5b5d8d5SVaclav Hapla Use -skip_petscrc in the code specific file (or command line) to skip ~/.petscrc, .petscrc and petscrc files. 10900298fd71SBarry Smith - help - [optional] Help message to print, use NULL for no message 1091e5c89e4eSSatish Balay 109205827820SBarry Smith If you wish PETSc code to run ONLY on a subcommunicator of MPI_COMM_WORLD, create that 109305827820SBarry Smith communicator first and assign it to PETSC_COMM_WORLD BEFORE calling PetscInitialize(). Thus if you are running a 109405827820SBarry Smith four process job and two processes will run PETSc and have PetscInitialize() and PetscFinalize() and two process will not, 109505827820SBarry Smith then do this. If ALL processes in the job are using PetscInitialize() and PetscFinalize() then you don't need to do this, even 109605827820SBarry Smith if different subcommunicators of the job are doing different things with PETSc. 1097e5c89e4eSSatish Balay 1098e5c89e4eSSatish Balay Options Database Keys: 10997ca660e7SBarry Smith + -help [intro] - prints help method for each option; if intro is given the program stops after printing the introductory help message 11007ca660e7SBarry Smith . -start_in_debugger [noxterm,dbx,xdb,gdb,...] - Starts program in debugger 1101e5c89e4eSSatish Balay . -on_error_attach_debugger [noxterm,dbx,xdb,gdb,...] - Starts debugger when error detected 11028a690491SBarry Smith . -on_error_emacs <machinename> - causes emacsclient to jump to error file 11038a690491SBarry Smith . -on_error_abort - calls abort() when error detected (no traceback) 11048a690491SBarry Smith . -on_error_mpiabort - calls MPI_abort() when error detected 11051af3601dSBarry Smith . -error_output_stdout - prints PETSc error messages to stdout instead of the default stderr 11068a690491SBarry Smith . -error_output_none - does not print the error messages (but handles errors in the same way as if this was not called) 1107bf4d2887SBarry Smith . -debugger_ranks [rank1,rank2,...] - Indicates ranks to start in debugger 1108e5c89e4eSSatish Balay . -debugger_pause [sleeptime] (in seconds) - Pauses debugger 1109e5c89e4eSSatish Balay . -stop_for_debugger - Print message on how to attach debugger manually to 1110e5c89e4eSSatish Balay process and wait (-debugger_pause) seconds for attachment 111179dccf82SBarry Smith . -malloc - Indicates use of PETSc error-checking malloc (on by default for debug version of libraries) (deprecated, use -malloc_debug) 111279dccf82SBarry Smith . -malloc no - Indicates not to use error-checking malloc (deprecated, use -malloc_debug no) 111379dccf82SBarry Smith . -malloc_debug - check for memory corruption at EVERY malloc or free, see PetscMallocSetDebug() 1114aee23540SBarry Smith . -malloc_dump - prints a list of all unfreed memory at the end of the run 111592f119d6SBarry 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 111692f119d6SBarry Smith . -malloc_view - show a list of all allocated memory during PetscFinalize() 111792f119d6SBarry Smith . -malloc_view_threshold <t> - only list memory allocations of size greater than t with -malloc_view 1118608c71bfSMatthew G. Knepley . -malloc_requested_size - malloc logging will record the requested size rather than size after alignment 111992f119d6SBarry Smith . -fp_trap - Stops on floating point exceptions 1120e5c89e4eSSatish Balay . -no_signal_handler - Indicates not to trap error signals 1121e5c89e4eSSatish Balay . -shared_tmp - indicates /tmp directory is shared by all processors 1122e5c89e4eSSatish Balay . -not_shared_tmp - each processor has own /tmp 1123e5c89e4eSSatish Balay . -tmp - alternative name of /tmp directory 1124e5c89e4eSSatish Balay . -get_total_flops - returns total flops done by all processors 11250841954dSBarry Smith - -memory_view - Print memory usage at end of run 1126e5c89e4eSSatish Balay 1127c5b5d8d5SVaclav Hapla Options Database Keys for Option Database: 1128c5b5d8d5SVaclav Hapla + -skip_petscrc - skip the default option files ~/.petscrc, .petscrc, petscrc 1129c5b5d8d5SVaclav Hapla . -options_monitor - monitor all set options to standard output for the whole program run 1130c5b5d8d5SVaclav Hapla - -options_monitor_cancel - cancel options monitoring hard-wired using PetscOptionsMonitorSet() 1131c5b5d8d5SVaclav Hapla 1132c5b5d8d5SVaclav Hapla Options -options_monitor_{all,cancel} are 1133c5b5d8d5SVaclav Hapla position-independent and apply to all options set since the PETSc start. 1134c5b5d8d5SVaclav Hapla They can be used also in option files. 1135c5b5d8d5SVaclav Hapla 1136c5b5d8d5SVaclav Hapla See PetscOptionsMonitorSet() to do monitoring programmatically. 1137c5b5d8d5SVaclav Hapla 1138e5c89e4eSSatish Balay Options Database Keys for Profiling: 1139a7f22e61SSatish Balay See Users-Manual: ch_profiling for details. 1140fe9b927eSVaclav Hapla + -info [filename][:[~]<list,of,classnames>[:[~]self]] - Prints verbose information. See PetscInfo(). 1141217044c2SLisandro Dalcin . -log_sync - Enable barrier synchronization for all events. This option is useful to debug imbalance within each event, 1142217044c2SLisandro Dalcin however it slows things down and gives a distorted view of the overall runtime. 1143495fc317SBarry Smith . -log_trace [filename] - Print traces of all PETSc calls to the screen (useful to determine where a program 1144e5c89e4eSSatish Balay hangs without running in the debugger). See PetscLogTraceBegin(). 11459a9a5d4cSBarry Smith . -log_view [:filename:format] - Prints summary of flop and timing information to screen or file, see PetscLogView(). 1146156b51fbSBarry Smith . -log_view_memory - Includes in the summary from -log_view the memory used in each event, see PetscLogView(). 1147156b51fbSBarry Smith . -log_view_gpu_time - Includes in the summary from -log_view the time used in each GPU kernel, see PetscLogView(). 11489a9a5d4cSBarry Smith . -log_summary [filename] - (Deprecated, use -log_view) Prints summary of flop and timing information to screen. If the filename is specified the 1149495fc317SBarry Smith summary is written to the file. See PetscLogView(). 1150f5d6ab90SLisandro Dalcin . -log_exclude: <vec,mat,pc,ksp,snes> - excludes subset of object classes from logging 1151495fc317SBarry Smith . -log_all [filename] - Logs extensive profiling information See PetscLogDump(). 1152495fc317SBarry Smith . -log [filename] - Logs basic profiline information See PetscLogDump(). 1153c2f74817SBarry Smith . -log_mpe [filename] - Creates a logfile viewable by the utility Jumpshot (in MPICH distribution) 115487c3beb6SLisandro Dalcin . -viewfromoptions on,off - Enable or disable XXXSetFromOptions() calls, for applications with many small solves turn this off 1155c2f74817SBarry Smith - -check_pointer_intensity 0,1,2 - if pointers are checked for validity (debug version only), using 0 will result in faster code 1156495fc317SBarry Smith 11576a77f485SPierre Jolivet Only one of -log_trace, -log_view, -log_all, -log, or -log_mpe may be used at a time 1158e5c89e4eSSatish Balay 1159ffbd1cfbSBarry Smith Options Database Keys for SAWs: 1160ffbd1cfbSBarry Smith + -saws_port <portnumber> - port number to publish SAWs data, default is 8080 1161ffbd1cfbSBarry 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 1162ffbd1cfbSBarry Smith this is useful when you are running many jobs that utilize SAWs at the same time 1163ffbd1cfbSBarry Smith . -saws_log <filename> - save a log of all SAWs communication 1164ffbd1cfbSBarry Smith . -saws_https <certificate file> - have SAWs use HTTPS instead of HTTP 1165ffbd1cfbSBarry Smith - -saws_root <directory> - allow SAWs to have access to the given directory to search for requested resources and files 1166ffbd1cfbSBarry Smith 1167e5c89e4eSSatish Balay Environmental Variables: 1168e5c89e4eSSatish Balay + PETSC_TMP - alternative tmp directory 1169e5c89e4eSSatish Balay . PETSC_SHARED_TMP - tmp is shared by all processes 1170e5c89e4eSSatish Balay . PETSC_NOT_SHARED_TMP - each process has its own private tmp 11714a971ea4SToby Isaac . PETSC_OPTIONS - a string containing additional options for petsc in the form of command line "-key value" pairs 11724a971ea4SToby Isaac . PETSC_OPTIONS_YAML - (requires configuring PETSc to use libyaml) a string containing additional options for petsc in the form of a YAML document 1173e5c89e4eSSatish Balay . PETSC_VIEWER_SOCKET_PORT - socket number to use for socket viewer 1174e5c89e4eSSatish Balay - PETSC_VIEWER_SOCKET_MACHINE - machine to use for socket viewer to connect to 1175e5c89e4eSSatish Balay 1176e5c89e4eSSatish Balay Level: beginner 1177e5c89e4eSSatish Balay 1178e5c89e4eSSatish Balay Notes: 1179e5c89e4eSSatish Balay If for some reason you must call MPI_Init() separately, call 1180e5c89e4eSSatish Balay it before PetscInitialize(). 1181e5c89e4eSSatish Balay 1182e5c89e4eSSatish Balay Fortran Version: 1183e5c89e4eSSatish Balay In Fortran this routine has the format 1184e5c89e4eSSatish Balay $ call PetscInitialize(file,ierr) 1185e5c89e4eSSatish Balay 1186e5c89e4eSSatish Balay + ierr - error return code 1187c5b5d8d5SVaclav Hapla - file - [optional] PETSc database file, also checks ~/.petscrc, .petscrc and petscrc. 1188c5b5d8d5SVaclav Hapla Use PETSC_NULL_CHARACTER to not check for code specific file. 1189c5b5d8d5SVaclav Hapla Use -skip_petscrc in the code specific file (or command line) to skip ~/.petscrc, .petscrc and petscrc files. 1190e5c89e4eSSatish Balay 1191e5c89e4eSSatish Balay Important Fortran Note: 11920eb4c9c0SBarry Smith In Fortran, you MUST use PETSC_NULL_CHARACTER to indicate a 11930298fd71SBarry Smith null character string; you CANNOT just use NULL as 1194a7f22e61SSatish Balay in the C version. See Users-Manual: ch_fortran for details. 1195e5c89e4eSSatish Balay 119601cb0274SBarry Smith If your main program is C but you call Fortran code that also uses PETSc you need to call PetscInitializeFortran() soon after 119701cb0274SBarry Smith calling PetscInitialize(). 1198e5c89e4eSSatish Balay 1199db781477SPatrick Sanan .seealso: `PetscFinalize()`, `PetscInitializeFortran()`, `PetscGetArgs()`, `PetscInitializeNoArguments()`, `PetscLogGpuTime()` 1200e5c89e4eSSatish Balay 1201e5c89e4eSSatish Balay @*/ 12027087cfbeSBarry Smith PetscErrorCode PetscInitialize(int *argc,char ***args,const char file[],const char help[]) 1203e5c89e4eSSatish Balay { 120485649d77SJunchao Zhang PetscMPIInt flag; 120585649d77SJunchao Zhang const char *prog = "Unknown Name"; 1206e5c89e4eSSatish Balay 120727104ee2SJacob Faibussowitsch PetscFunctionBegin; 120827104ee2SJacob Faibussowitsch if (PetscInitializeCalled) PetscFunctionReturn(0); 12099566063dSJacob Faibussowitsch PetscCallMPI(MPI_Initialized(&flag)); 1210e5c89e4eSSatish Balay if (!flag) { 121139a651e2SJacob 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"); 12129566063dSJacob Faibussowitsch PetscCall(PetscPreMPIInit_Private()); 12135e765c61SJed Brown #if defined(PETSC_HAVE_MPI_INIT_THREAD) 12145e765c61SJed Brown { 121539a651e2SJacob Faibussowitsch PetscMPIInt PETSC_UNUSED provided; 12169566063dSJacob Faibussowitsch PetscCallMPI(MPI_Init_thread(argc,args,PETSC_MPI_THREAD_REQUIRED,&provided)); 12175e765c61SJed Brown } 12185e765c61SJed Brown #else 12199566063dSJacob Faibussowitsch PetscCallMPI(MPI_Init(argc,args)); 12205e765c61SJed Brown #endif 1221e5c89e4eSSatish Balay PetscBeganMPI = PETSC_TRUE; 1222e5c89e4eSSatish Balay } 12234dfee713SSatish Balay 122485649d77SJunchao Zhang if (argc && *argc) prog = **args; 1225e5c89e4eSSatish Balay if (argc && args) { 1226e5c89e4eSSatish Balay PetscGlobalArgc = *argc; 1227e5c89e4eSSatish Balay PetscGlobalArgs = *args; 1228e5c89e4eSSatish Balay } 12299566063dSJacob Faibussowitsch PetscCall(PetscInitialize_Common(prog,file,help,PETSC_FALSE/*C*/,PETSC_FALSE,0)); 123027104ee2SJacob Faibussowitsch PetscFunctionReturn(0); 1231e5c89e4eSSatish Balay } 1232e5c89e4eSSatish Balay 1233a4af0ceeSJacob Faibussowitsch #if PetscDefined(USE_LOG) 123495c0884eSLisandro Dalcin PETSC_INTERN PetscObject *PetscObjects; 1235ecfe9a72SLisandro Dalcin PETSC_INTERN PetscInt PetscObjectsCounts; 1236ecfe9a72SLisandro Dalcin PETSC_INTERN PetscInt PetscObjectsMaxCounts; 123795c0884eSLisandro Dalcin PETSC_INTERN PetscBool PetscObjectsLog; 12384097062eSBarry Smith #endif 1239e5c89e4eSSatish Balay 1240008a6e76SBarry Smith /* 1241008a6e76SBarry Smith Frees all the MPI types and operations that PETSc may have created 1242008a6e76SBarry Smith */ 1243008a6e76SBarry Smith PetscErrorCode PetscFreeMPIResources(void) 1244008a6e76SBarry Smith { 1245008a6e76SBarry Smith PetscFunctionBegin; 1246008a6e76SBarry Smith #if defined(PETSC_USE_REAL___FLOAT128) 12479566063dSJacob Faibussowitsch PetscCallMPI(MPI_Type_free(&MPIU___FLOAT128)); 1248008a6e76SBarry Smith #if defined(PETSC_HAVE_COMPLEX) 12499566063dSJacob Faibussowitsch PetscCallMPI(MPI_Type_free(&MPIU___COMPLEX128)); 1250008a6e76SBarry Smith #endif 12519566063dSJacob Faibussowitsch PetscCallMPI(MPI_Op_free(&MPIU_MAX)); 12529566063dSJacob Faibussowitsch PetscCallMPI(MPI_Op_free(&MPIU_MIN)); 1253008a6e76SBarry Smith #elif defined(PETSC_USE_REAL___FP16) 12549566063dSJacob Faibussowitsch PetscCallMPI(MPI_Type_free(&MPIU___FP16)); 12559566063dSJacob Faibussowitsch PetscCallMPI(MPI_Op_free(&MPIU_MAX)); 12569566063dSJacob Faibussowitsch PetscCallMPI(MPI_Op_free(&MPIU_MIN)); 1257008a6e76SBarry Smith #endif 1258008a6e76SBarry Smith 1259de272c7aSSatish Balay #if defined(PETSC_USE_REAL___FLOAT128) || defined(PETSC_USE_REAL___FP16) 12609566063dSJacob Faibussowitsch PetscCallMPI(MPI_Op_free(&MPIU_SUM)); 1261008a6e76SBarry Smith #endif 1262008a6e76SBarry Smith 12639566063dSJacob Faibussowitsch PetscCallMPI(MPI_Type_free(&MPIU_2SCALAR)); 12649566063dSJacob Faibussowitsch PetscCallMPI(MPI_Type_free(&MPIU_REAL_INT)); 12659566063dSJacob Faibussowitsch PetscCallMPI(MPI_Type_free(&MPIU_SCALAR_INT)); 126640df0d72SSatish Balay #if defined(PETSC_USE_64BIT_INDICES) 12679566063dSJacob Faibussowitsch PetscCallMPI(MPI_Type_free(&MPIU_2INT)); 1268008a6e76SBarry Smith #endif 12699566063dSJacob Faibussowitsch PetscCallMPI(MPI_Type_free(&MPI_4INT)); 12709566063dSJacob Faibussowitsch PetscCallMPI(MPI_Type_free(&MPIU_4INT)); 12719566063dSJacob Faibussowitsch PetscCallMPI(MPI_Op_free(&MPIU_MAXSUM_OP)); 1272008a6e76SBarry Smith PetscFunctionReturn(0); 1273008a6e76SBarry Smith } 1274008a6e76SBarry Smith 1275a4af0ceeSJacob Faibussowitsch #if PetscDefined(USE_LOG) 1276a4af0ceeSJacob Faibussowitsch PETSC_INTERN PetscErrorCode PetscLogFinalize(void); 1277a4af0ceeSJacob Faibussowitsch #endif 1278a4af0ceeSJacob Faibussowitsch 1279e5c89e4eSSatish Balay /*@C 1280e5c89e4eSSatish Balay PetscFinalize - Checks for options to be called at the conclusion 1281e5c89e4eSSatish Balay of the program. MPI_Finalize() is called only if the user had not 1282e5c89e4eSSatish Balay called MPI_Init() before calling PetscInitialize(). 1283e5c89e4eSSatish Balay 1284e5c89e4eSSatish Balay Collective on PETSC_COMM_WORLD 1285e5c89e4eSSatish Balay 1286e5c89e4eSSatish Balay Options Database Keys: 128726a7e8d4SBarry Smith + -options_view - Calls PetscOptionsView() 1288e5c89e4eSSatish Balay . -options_left - Prints unused options that remain in the database 12897eb1d149SBarry 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 1290e5c89e4eSSatish Balay . -mpidump - Calls PetscMPIDump() 129192f119d6SBarry Smith . -malloc_dump <optional filename> - Calls PetscMallocDump(), displays all memory allocated that has not been freed 1292e5c89e4eSSatish Balay . -malloc_info - Prints total memory usage 129392f119d6SBarry Smith - -malloc_view <optional filename> - Prints list of all memory allocated and where 1294e5c89e4eSSatish Balay 1295e5c89e4eSSatish Balay Level: beginner 1296e5c89e4eSSatish Balay 1297e5c89e4eSSatish Balay Note: 1298e5c89e4eSSatish Balay See PetscInitialize() for more general runtime options. 1299e5c89e4eSSatish Balay 1300db781477SPatrick Sanan .seealso: `PetscInitialize()`, `PetscOptionsView()`, `PetscMallocDump()`, `PetscMPIDump()`, `PetscEnd()` 1301e5c89e4eSSatish Balay @*/ 13027087cfbeSBarry Smith PetscErrorCode PetscFinalize(void) 1303e5c89e4eSSatish Balay { 13044bb5149bSJed Brown PetscMPIInt rank; 1305a8d2bbe5SBarry Smith PetscInt nopt; 13062bf49c77SBarry Smith PetscBool flg1 = PETSC_FALSE,flg2 = PETSC_FALSE,flg3 = PETSC_FALSE; 1307dff31646SBarry Smith PetscBool flg; 130810463e74SBarry Smith #if defined(PETSC_USE_LOG) 130910463e74SBarry Smith char mname[PETSC_MAX_PATH_LEN]; 131010463e74SBarry Smith #endif 1311e5c89e4eSSatish Balay 13123cbbc5ffSBarry Smith PetscFunctionBegin; 131339a651e2SJacob Faibussowitsch PetscCheck(PetscInitializeCalled,PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"PetscInitialize() must be called before PetscFinalize()"); 13149566063dSJacob Faibussowitsch PetscCall(PetscInfo(NULL,"PetscFinalize() called\n")); 1315b022a5c1SBarry Smith 1316f1f2ae84SBarry Smith PetscCall(PetscOptionsHasName(NULL,NULL,"-mpi_linear_solver_server",&flg)); 1317f1f2ae84SBarry Smith if (PetscDefined(USE_SINGLE_LIBRARY) && flg) PetscCall(PCMPIServerEnd()); 1318f1f2ae84SBarry Smith 13199566063dSJacob Faibussowitsch PetscCallMPI(MPI_Comm_rank(PETSC_COMM_WORLD,&rank)); 1320a56f64adSBarry Smith #if defined(PETSC_HAVE_ADIOS) 13219566063dSJacob Faibussowitsch PetscCall(adios_read_finalize_method(ADIOS_READ_METHOD_BP_AGGREGATE)); 13229566063dSJacob Faibussowitsch PetscCall(adios_finalize(rank)); 1323a56f64adSBarry Smith #endif 13249566063dSJacob Faibussowitsch PetscCall(PetscOptionsHasName(NULL,NULL,"-citations",&flg)); 1325dff31646SBarry Smith if (flg) { 13261f817a21SBarry Smith char *cits, filename[PETSC_MAX_PATH_LEN]; 13271f817a21SBarry Smith FILE *fd = PETSC_STDOUT; 13281f817a21SBarry Smith 13299566063dSJacob Faibussowitsch PetscCall(PetscOptionsGetString(NULL,NULL,"-citations",filename,sizeof(filename),NULL)); 13301f817a21SBarry Smith if (filename[0]) { 13319566063dSJacob Faibussowitsch PetscCall(PetscFOpen(PETSC_COMM_WORLD,filename,"w",&fd)); 13321f817a21SBarry Smith } 13339566063dSJacob Faibussowitsch PetscCall(PetscSegBufferGet(PetscCitationsList,1,&cits)); 1334dff31646SBarry Smith cits[0] = 0; 13359566063dSJacob Faibussowitsch PetscCall(PetscSegBufferExtractAlloc(PetscCitationsList,&cits)); 13369566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(PETSC_COMM_WORLD,fd,"If you publish results based on this computation please cite the following:\n")); 13379566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(PETSC_COMM_WORLD,fd,"===========================================================================\n")); 13389566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(PETSC_COMM_WORLD,fd,"%s",cits)); 13399566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(PETSC_COMM_WORLD,fd,"===========================================================================\n")); 13409566063dSJacob Faibussowitsch PetscCall(PetscFClose(PETSC_COMM_WORLD,fd)); 13419566063dSJacob Faibussowitsch PetscCall(PetscFree(cits)); 1342dff31646SBarry Smith } 13439566063dSJacob Faibussowitsch PetscCall(PetscSegBufferDestroy(&PetscCitationsList)); 1344dff31646SBarry Smith 1345c2a97968SBarry Smith #if defined(PETSC_HAVE_SSL) && defined(PETSC_USE_SOCKET_VIEWER) 134604102261SBarry Smith /* TextBelt is run for testing purposes only, please do not use this feature often */ 134704102261SBarry Smith { 134804102261SBarry Smith PetscInt nmax = 2; 134904102261SBarry Smith char **buffs; 13509566063dSJacob Faibussowitsch PetscCall(PetscMalloc1(2,&buffs)); 13519566063dSJacob Faibussowitsch PetscCall(PetscOptionsGetStringArray(NULL,NULL,"-textbelt",buffs,&nmax,&flg1)); 135204102261SBarry Smith if (flg1) { 135328b400f6SJacob Faibussowitsch PetscCheck(nmax,PETSC_COMM_WORLD,PETSC_ERR_USER,"-textbelt requires either the phone number or number,\"message\""); 135404102261SBarry Smith if (nmax == 1) { 13559566063dSJacob Faibussowitsch PetscCall(PetscMalloc1(128,&buffs[1])); 13569566063dSJacob Faibussowitsch PetscCall(PetscGetProgramName(buffs[1],32)); 13579566063dSJacob Faibussowitsch PetscCall(PetscStrcat(buffs[1]," has completed")); 135804102261SBarry Smith } 13599566063dSJacob Faibussowitsch PetscCall(PetscTextBelt(PETSC_COMM_WORLD,buffs[0],buffs[1],NULL)); 13609566063dSJacob Faibussowitsch PetscCall(PetscFree(buffs[0])); 13619566063dSJacob Faibussowitsch PetscCall(PetscFree(buffs[1])); 136204102261SBarry Smith } 13639566063dSJacob Faibussowitsch PetscCall(PetscFree(buffs)); 136404102261SBarry Smith } 1365763ec7b1SBarry Smith { 1366763ec7b1SBarry Smith PetscInt nmax = 2; 1367763ec7b1SBarry Smith char **buffs; 13689566063dSJacob Faibussowitsch PetscCall(PetscMalloc1(2,&buffs)); 13699566063dSJacob Faibussowitsch PetscCall(PetscOptionsGetStringArray(NULL,NULL,"-tellmycell",buffs,&nmax,&flg1)); 1370763ec7b1SBarry Smith if (flg1) { 137128b400f6SJacob Faibussowitsch PetscCheck(nmax,PETSC_COMM_WORLD,PETSC_ERR_USER,"-tellmycell requires either the phone number or number,\"message\""); 1372763ec7b1SBarry Smith if (nmax == 1) { 13739566063dSJacob Faibussowitsch PetscCall(PetscMalloc1(128,&buffs[1])); 13749566063dSJacob Faibussowitsch PetscCall(PetscGetProgramName(buffs[1],32)); 13759566063dSJacob Faibussowitsch PetscCall(PetscStrcat(buffs[1]," has completed")); 1376763ec7b1SBarry Smith } 13779566063dSJacob Faibussowitsch PetscCall(PetscTellMyCell(PETSC_COMM_WORLD,buffs[0],buffs[1],NULL)); 13789566063dSJacob Faibussowitsch PetscCall(PetscFree(buffs[0])); 13799566063dSJacob Faibussowitsch PetscCall(PetscFree(buffs[1])); 1380763ec7b1SBarry Smith } 13819566063dSJacob Faibussowitsch PetscCall(PetscFree(buffs)); 1382763ec7b1SBarry Smith } 138304102261SBarry Smith #endif 138404102261SBarry Smith 13852d53ad75SBarry Smith #if defined(PETSC_SERIALIZE_FUNCTIONS) 13869566063dSJacob Faibussowitsch PetscCall(PetscFPTDestroy()); 13872d53ad75SBarry Smith #endif 13882d53ad75SBarry Smith 1389e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS) 1390dff31646SBarry Smith flg = PETSC_FALSE; 13919566063dSJacob Faibussowitsch PetscCall(PetscOptionsGetBool(NULL,NULL,"-saw_options",&flg,NULL)); 13921baa6e33SBarry Smith if (flg) PetscCall(PetscOptionsSAWsDestroy()); 1393d5649816SBarry Smith #endif 1394d5649816SBarry Smith 1395681455b2SBarry Smith #if defined(PETSC_HAVE_X) 1396681455b2SBarry Smith flg1 = PETSC_FALSE; 13979566063dSJacob Faibussowitsch PetscCall(PetscOptionsGetBool(NULL,NULL,"-x_virtual",&flg1,NULL)); 1398681455b2SBarry Smith if (flg1) { 1399681455b2SBarry Smith /* this is a crude hack, but better than nothing */ 14009566063dSJacob Faibussowitsch PetscCall(PetscPOpen(PETSC_COMM_WORLD,NULL,"pkill -9 Xvfb","r",NULL)); 1401681455b2SBarry Smith } 1402681455b2SBarry Smith #endif 1403681455b2SBarry Smith 140467584ceeSBarry Smith #if !defined(PETSC_HAVE_THREADSAFETY) 14059566063dSJacob Faibussowitsch PetscCall(PetscOptionsGetBool(NULL,NULL,"-malloc_info",&flg2,NULL)); 1406e5c89e4eSSatish Balay if (!flg2) { 140790d69ab7SBarry Smith flg2 = PETSC_FALSE; 14089566063dSJacob Faibussowitsch PetscCall(PetscOptionsGetBool(NULL,NULL,"-memory_view",&flg2,NULL)); 1409e5c89e4eSSatish Balay } 1410e5c89e4eSSatish Balay if (flg2) { 14119566063dSJacob Faibussowitsch PetscCall(PetscMemoryView(PETSC_VIEWER_STDOUT_WORLD,"Summary of Memory Usage in PETSc\n")); 1412e5c89e4eSSatish Balay } 141367584ceeSBarry Smith #endif 1414e5c89e4eSSatish Balay 1415e5c89e4eSSatish Balay #if defined(PETSC_USE_LOG) 141690d69ab7SBarry Smith flg1 = PETSC_FALSE; 14179566063dSJacob Faibussowitsch PetscCall(PetscOptionsGetBool(NULL,NULL,"-get_total_flops",&flg1,NULL)); 1418e5c89e4eSSatish Balay if (flg1) { 1419e5c89e4eSSatish Balay PetscLogDouble flops = 0; 14209566063dSJacob Faibussowitsch PetscCallMPI(MPI_Reduce(&petsc_TotalFlops,&flops,1,MPI_DOUBLE,MPI_SUM,0,PETSC_COMM_WORLD)); 14219566063dSJacob Faibussowitsch PetscCall(PetscPrintf(PETSC_COMM_WORLD,"Total flops over all processors %g\n",flops)); 1422e5c89e4eSSatish Balay } 1423e5c89e4eSSatish Balay #endif 1424e5c89e4eSSatish Balay 1425e5c89e4eSSatish Balay #if defined(PETSC_USE_LOG) 1426e5c89e4eSSatish Balay #if defined(PETSC_HAVE_MPE) 1427e5c89e4eSSatish Balay mname[0] = 0; 14289566063dSJacob Faibussowitsch PetscCall(PetscOptionsGetString(NULL,NULL,"-log_mpe",mname,sizeof(mname),&flg1)); 1429e5c89e4eSSatish Balay if (flg1) { 14309566063dSJacob Faibussowitsch if (mname[0]) PetscCall(PetscLogMPEDump(mname)); 14319566063dSJacob Faibussowitsch else PetscCall(PetscLogMPEDump(0)); 1432e5c89e4eSSatish Balay } 1433e5c89e4eSSatish Balay #endif 1434356e5837SBarry Smith #endif 1435a297a907SKarl Rupp 1436dd710f27SBarry Smith /* 1437dd710f27SBarry Smith Free all objects registered with PetscObjectRegisterDestroy() such as PETSC_VIEWER_XXX_(). 1438dd710f27SBarry Smith */ 14399566063dSJacob Faibussowitsch PetscCall(PetscObjectRegisterDestroyAll()); 1440dd710f27SBarry Smith 1441356e5837SBarry Smith #if defined(PETSC_USE_LOG) 14429566063dSJacob Faibussowitsch PetscCall(PetscOptionsPushGetViewerOff(PETSC_FALSE)); 14439566063dSJacob Faibussowitsch PetscCall(PetscLogViewFromOptions()); 14449566063dSJacob Faibussowitsch PetscCall(PetscOptionsPopGetViewerOff()); 144587c3beb6SLisandro Dalcin 1446356e5837SBarry Smith mname[0] = 0; 14479566063dSJacob Faibussowitsch PetscCall(PetscOptionsGetString(NULL,NULL,"-log_summary",mname,sizeof(mname),&flg1)); 1448e5c89e4eSSatish Balay if (flg1) { 144991eabc43SBarry Smith PetscViewer viewer; 14509566063dSJacob Faibussowitsch PetscCall((*PetscHelpPrintf)(PETSC_COMM_WORLD,"\n\n WARNING: -log_summary is being deprecated; switch to -log_view\n\n\n")); 145191eabc43SBarry Smith if (mname[0]) { 14529566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIIOpen(PETSC_COMM_WORLD,mname,&viewer)); 14539566063dSJacob Faibussowitsch PetscCall(PetscLogView(viewer)); 14549566063dSJacob Faibussowitsch PetscCall(PetscViewerDestroy(&viewer)); 145533f85c2fSBarry Smith } else { 145633f85c2fSBarry Smith viewer = PETSC_VIEWER_STDOUT_WORLD; 14579566063dSJacob Faibussowitsch PetscCall(PetscViewerPushFormat(viewer,PETSC_VIEWER_DEFAULT)); 14589566063dSJacob Faibussowitsch PetscCall(PetscLogView(viewer)); 14599566063dSJacob Faibussowitsch PetscCall(PetscViewerPopFormat(viewer)); 146033f85c2fSBarry Smith } 1461e5c89e4eSSatish Balay } 1462a297a907SKarl Rupp 1463dd710f27SBarry Smith /* 1464dd710f27SBarry Smith Free any objects created by the last block of code. 1465dd710f27SBarry Smith */ 14669566063dSJacob Faibussowitsch PetscCall(PetscObjectRegisterDestroyAll()); 1467dd710f27SBarry Smith 1468dd710f27SBarry Smith mname[0] = 0; 14699566063dSJacob Faibussowitsch PetscCall(PetscOptionsGetString(NULL,NULL,"-log_all",mname,sizeof(mname),&flg1)); 14709566063dSJacob Faibussowitsch PetscCall(PetscOptionsGetString(NULL,NULL,"-log",mname,sizeof(mname),&flg2)); 14719566063dSJacob Faibussowitsch if (flg1 || flg2) PetscCall(PetscLogDump(mname)); 1472e5c89e4eSSatish Balay #endif 147310463e74SBarry Smith 147490d69ab7SBarry Smith flg1 = PETSC_FALSE; 14759566063dSJacob Faibussowitsch PetscCall(PetscOptionsGetBool(NULL,NULL,"-no_signal_handler",&flg1,NULL)); 14769566063dSJacob Faibussowitsch if (!flg1) PetscCall(PetscPopSignalHandler()); 147790d69ab7SBarry Smith flg1 = PETSC_FALSE; 14789566063dSJacob Faibussowitsch PetscCall(PetscOptionsGetBool(NULL,NULL,"-mpidump",&flg1,NULL)); 14791baa6e33SBarry Smith if (flg1) PetscCall(PetscMPIDump(stdout)); 148090d69ab7SBarry Smith flg1 = PETSC_FALSE; 148190d69ab7SBarry Smith flg2 = PETSC_FALSE; 14828bb29257SSatish Balay /* preemptive call to avoid listing this option in options table as unused */ 14839566063dSJacob Faibussowitsch PetscCall(PetscOptionsHasName(NULL,NULL,"-malloc_dump",&flg1)); 14849566063dSJacob Faibussowitsch PetscCall(PetscOptionsHasName(NULL,NULL,"-objects_dump",&flg1)); 14859566063dSJacob Faibussowitsch PetscCall(PetscOptionsGetBool(NULL,NULL,"-options_view",&flg2,NULL)); 1486e4c476e2SSatish Balay 1487e5c89e4eSSatish Balay if (flg2) { 1488be56827dSJed Brown PetscViewer viewer; 14899566063dSJacob Faibussowitsch PetscCall(PetscViewerCreate(PETSC_COMM_WORLD,&viewer)); 14909566063dSJacob Faibussowitsch PetscCall(PetscViewerSetType(viewer,PETSCVIEWERASCII)); 14919566063dSJacob Faibussowitsch PetscCall(PetscOptionsView(NULL,viewer)); 14929566063dSJacob Faibussowitsch PetscCall(PetscViewerDestroy(&viewer)); 1493e5c89e4eSSatish Balay } 1494e5c89e4eSSatish Balay 1495e5c89e4eSSatish Balay /* to prevent PETSc -options_left from warning */ 14969566063dSJacob Faibussowitsch PetscCall(PetscOptionsHasName(NULL,NULL,"-nox",&flg1)); 14979566063dSJacob Faibussowitsch PetscCall(PetscOptionsHasName(NULL,NULL,"-nox_warning",&flg1)); 1498e5c89e4eSSatish Balay 149933fc4174SSatish Balay flg3 = PETSC_FALSE; /* default value is required */ 15009566063dSJacob Faibussowitsch PetscCall(PetscOptionsGetBool(NULL,NULL,"-options_left",&flg3,&flg1)); 15019245e749SBarry Smith if (PetscUnlikelyDebug(!flg1)) flg3 = PETSC_TRUE; 1502e5c89e4eSSatish Balay if (flg3) { 15033de2bfdfSBarry Smith if (!flg2 && flg1) { /* have not yet printed the options */ 1504be56827dSJed Brown PetscViewer viewer; 15059566063dSJacob Faibussowitsch PetscCall(PetscViewerCreate(PETSC_COMM_WORLD,&viewer)); 15069566063dSJacob Faibussowitsch PetscCall(PetscViewerSetType(viewer,PETSCVIEWERASCII)); 15079566063dSJacob Faibussowitsch PetscCall(PetscOptionsView(NULL,viewer)); 15089566063dSJacob Faibussowitsch PetscCall(PetscViewerDestroy(&viewer)); 1509e5c89e4eSSatish Balay } 15109566063dSJacob Faibussowitsch PetscCall(PetscOptionsAllUsed(NULL,&nopt)); 15113de2bfdfSBarry Smith if (nopt) { 15129566063dSJacob Faibussowitsch PetscCall(PetscPrintf(PETSC_COMM_WORLD,"WARNING! There are options you set that were not used!\n")); 15139566063dSJacob Faibussowitsch PetscCall(PetscPrintf(PETSC_COMM_WORLD,"WARNING! could be spelling mistake, etc!\n")); 15143de2bfdfSBarry Smith if (nopt == 1) { 15159566063dSJacob Faibussowitsch PetscCall(PetscPrintf(PETSC_COMM_WORLD,"There is one unused database option. It is:\n")); 1516e5c89e4eSSatish Balay } else { 15179566063dSJacob Faibussowitsch PetscCall(PetscPrintf(PETSC_COMM_WORLD,"There are %" PetscInt_FMT " unused database options. They are:\n",nopt)); 1518e5c89e4eSSatish Balay } 15193de2bfdfSBarry Smith } else if (flg3 && flg1) { 15209566063dSJacob Faibussowitsch PetscCall(PetscPrintf(PETSC_COMM_WORLD,"There are no unused options.\n")); 1521df12ba86SBarry Smith } 15229566063dSJacob Faibussowitsch PetscCall(PetscOptionsLeft(NULL)); 1523e5c89e4eSSatish Balay } 1524e5c89e4eSSatish Balay 1525e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS) 1526d45a07a7SBarry Smith if (!PetscGlobalRank) { 15279566063dSJacob Faibussowitsch PetscCall(PetscStackSAWsViewOff()); 1528792fecdfSBarry Smith PetscCallSAWs(SAWs_Finalize,()); 1529d45a07a7SBarry Smith } 1530ec957eceSBarry Smith #endif 1531ec957eceSBarry Smith 15324097062eSBarry Smith #if defined(PETSC_USE_LOG) 153310463e74SBarry Smith /* 1534dbc8283eSBarry Smith List all objects the user may have forgot to free 15352eff7a51SBarry Smith */ 153605df10baSBarry Smith if (PetscObjectsLog) { 15379566063dSJacob Faibussowitsch PetscCall(PetscOptionsHasName(NULL,NULL,"-objects_dump",&flg1)); 1538a64a8e02SBarry Smith if (flg1) { 1539a64a8e02SBarry Smith MPI_Comm local_comm; 15407eb1d149SBarry Smith char string[64]; 1541a64a8e02SBarry Smith 15429566063dSJacob Faibussowitsch PetscCall(PetscOptionsGetString(NULL,NULL,"-objects_dump",string,sizeof(string),NULL)); 15439566063dSJacob Faibussowitsch PetscCallMPI(MPI_Comm_dup(MPI_COMM_WORLD,&local_comm)); 15449566063dSJacob Faibussowitsch PetscCall(PetscSequentialPhaseBegin_Private(local_comm,1)); 15459566063dSJacob Faibussowitsch PetscCall(PetscObjectsDump(stdout,(string[0] == 'a') ? PETSC_TRUE : PETSC_FALSE)); 15469566063dSJacob Faibussowitsch PetscCall(PetscSequentialPhaseEnd_Private(local_comm,1)); 15479566063dSJacob Faibussowitsch PetscCallMPI(MPI_Comm_free(&local_comm)); 15480a1571b3SBarry Smith } 154905df10baSBarry Smith } 15504097062eSBarry Smith #endif 15514097062eSBarry Smith 15524097062eSBarry Smith #if defined(PETSC_USE_LOG) 1553dbc8283eSBarry Smith PetscObjectsCounts = 0; 1554dbc8283eSBarry Smith PetscObjectsMaxCounts = 0; 15559566063dSJacob Faibussowitsch PetscCall(PetscFree(PetscObjects)); 15564097062eSBarry Smith #endif 15572eff7a51SBarry Smith 155833f85c2fSBarry Smith /* 155933f85c2fSBarry Smith Destroy any packages that registered a finalize 156033f85c2fSBarry Smith */ 15619566063dSJacob Faibussowitsch PetscCall(PetscRegisterFinalizeAll()); 156233f85c2fSBarry Smith 1563101409b8SToby Isaac #if defined(PETSC_USE_LOG) 15649566063dSJacob Faibussowitsch PetscCall(PetscLogFinalize()); 1565101409b8SToby Isaac #endif 1566101409b8SToby Isaac 156733f85c2fSBarry Smith /* 156848dd1dffSBarry Smith Print PetscFunctionLists that have not been properly freed 156948dd1dffSBarry Smith */ 15702e956fe4SStefano Zampini if (PetscPrintFunctionList) PetscCall(PetscFunctionListPrintAll()); 157137e93019SBarry Smith 15724028d114SSatish Balay if (petsc_history) { 15739566063dSJacob Faibussowitsch PetscCall(PetscCloseHistoryFile(&petsc_history)); 157402c9f0b5SLisandro Dalcin petsc_history = NULL; 1575e5c89e4eSSatish Balay } 15769566063dSJacob Faibussowitsch PetscCall(PetscOptionsHelpPrintedDestroy(&PetscOptionsHelpPrintedSingleton)); 15779566063dSJacob Faibussowitsch PetscCall(PetscInfoDestroy()); 1578e5c89e4eSSatish Balay 157967584ceeSBarry Smith #if !defined(PETSC_HAVE_THREADSAFETY) 158092f119d6SBarry Smith if (!(PETSC_RUNNING_ON_VALGRIND)) { 1581e5c89e4eSSatish Balay char fname[PETSC_MAX_PATH_LEN]; 158292f119d6SBarry Smith char sname[PETSC_MAX_PATH_LEN]; 1583e5c89e4eSSatish Balay FILE *fd; 1584ed9cf6e9SBarry Smith int err; 1585e5c89e4eSSatish Balay 1586dc92acbaSJed Brown flg2 = PETSC_FALSE; 158792f119d6SBarry Smith flg3 = PETSC_FALSE; 15889566063dSJacob Faibussowitsch if (PetscDefined(USE_DEBUG)) PetscCall(PetscOptionsGetBool(NULL,NULL,"-malloc_test",&flg2,NULL)); 15899566063dSJacob Faibussowitsch PetscCall(PetscOptionsGetBool(NULL,NULL,"-malloc_debug",&flg3,NULL)); 159092f119d6SBarry Smith fname[0] = 0; 15919566063dSJacob Faibussowitsch PetscCall(PetscOptionsGetString(NULL,NULL,"-malloc_dump",fname,sizeof(fname),&flg1)); 1592e5c89e4eSSatish Balay if (flg1 && fname[0]) { 1593e5c89e4eSSatish Balay 1594589a23caSBarry Smith PetscSNPrintf(sname,sizeof(sname),"%s_%d",fname,rank); 159528b400f6SJacob Faibussowitsch fd = fopen(sname,"w"); PetscCheck(fd,PETSC_COMM_SELF,PETSC_ERR_FILE_OPEN,"Cannot open log file: %s",sname); 15969566063dSJacob Faibussowitsch PetscCall(PetscMallocDump(fd)); 1597ed9cf6e9SBarry Smith err = fclose(fd); 159828b400f6SJacob Faibussowitsch PetscCheck(!err,PETSC_COMM_SELF,PETSC_ERR_SYS,"fclose() failed on file"); 159992f119d6SBarry Smith } else if (flg1 || flg2 || flg3) { 1600e5c89e4eSSatish Balay MPI_Comm local_comm; 1601e5c89e4eSSatish Balay 16029566063dSJacob Faibussowitsch PetscCallMPI(MPI_Comm_dup(MPI_COMM_WORLD,&local_comm)); 16039566063dSJacob Faibussowitsch PetscCall(PetscSequentialPhaseBegin_Private(local_comm,1)); 16049566063dSJacob Faibussowitsch PetscCall(PetscMallocDump(stdout)); 16059566063dSJacob Faibussowitsch PetscCall(PetscSequentialPhaseEnd_Private(local_comm,1)); 16069566063dSJacob Faibussowitsch PetscCallMPI(MPI_Comm_free(&local_comm)); 1607e5c89e4eSSatish Balay } 1608e5c89e4eSSatish Balay fname[0] = 0; 16099566063dSJacob Faibussowitsch PetscCall(PetscOptionsGetString(NULL,NULL,"-malloc_view",fname,sizeof(fname),&flg1)); 1610e5c89e4eSSatish Balay if (flg1 && fname[0]) { 1611e5c89e4eSSatish Balay 1612589a23caSBarry Smith PetscSNPrintf(sname,sizeof(sname),"%s_%d",fname,rank); 161328b400f6SJacob Faibussowitsch fd = fopen(sname,"w"); PetscCheck(fd,PETSC_COMM_SELF,PETSC_ERR_FILE_OPEN,"Cannot open log file: %s",sname); 16149566063dSJacob Faibussowitsch PetscCall(PetscMallocView(fd)); 1615ed9cf6e9SBarry Smith err = fclose(fd); 161628b400f6SJacob Faibussowitsch PetscCheck(!err,PETSC_COMM_SELF,PETSC_ERR_SYS,"fclose() failed on file"); 161792f119d6SBarry Smith } else if (flg1) { 161892f119d6SBarry Smith MPI_Comm local_comm; 161992f119d6SBarry Smith 16209566063dSJacob Faibussowitsch PetscCallMPI(MPI_Comm_dup(MPI_COMM_WORLD,&local_comm)); 16219566063dSJacob Faibussowitsch PetscCall(PetscSequentialPhaseBegin_Private(local_comm,1)); 16229566063dSJacob Faibussowitsch PetscCall(PetscMallocView(stdout)); 16239566063dSJacob Faibussowitsch PetscCall(PetscSequentialPhaseEnd_Private(local_comm,1)); 16249566063dSJacob Faibussowitsch PetscCallMPI(MPI_Comm_free(&local_comm)); 1625e5c89e4eSSatish Balay } 1626e5c89e4eSSatish Balay } 162767584ceeSBarry Smith #endif 162820e2c332SMatthew G. Knepley 16295486ca60SMatthew G. Knepley /* 16305486ca60SMatthew G. Knepley Close any open dynamic libraries 16315486ca60SMatthew G. Knepley */ 16329566063dSJacob Faibussowitsch PetscCall(PetscFinalize_DynamicLibraries()); 16335486ca60SMatthew G. Knepley 1634e5c89e4eSSatish Balay /* Can be destroyed only after all the options are used */ 16359566063dSJacob Faibussowitsch PetscCall(PetscOptionsDestroyDefault()); 1636e5c89e4eSSatish Balay 1637e5c89e4eSSatish Balay PetscGlobalArgc = 0; 163802c9f0b5SLisandro Dalcin PetscGlobalArgs = NULL; 1639e5c89e4eSSatish Balay 1640c2b86a48SJunchao Zhang #if defined(PETSC_HAVE_KOKKOS) 1641c2b86a48SJunchao Zhang if (PetscBeganKokkos) { 16429566063dSJacob Faibussowitsch PetscCall(PetscKokkosFinalize_Private()); 1643c2b86a48SJunchao Zhang PetscBeganKokkos = PETSC_FALSE; 164445639126SStefano Zampini PetscKokkosInitialized = PETSC_FALSE; 1645c2b86a48SJunchao Zhang } 1646c2b86a48SJunchao Zhang #endif 1647c2b86a48SJunchao Zhang 164871438e86SJunchao Zhang #if defined(PETSC_HAVE_NVSHMEM) 164971438e86SJunchao Zhang if (PetscBeganNvshmem) { 16509566063dSJacob Faibussowitsch PetscCall(PetscNvshmemFinalize()); 165171438e86SJunchao Zhang PetscBeganNvshmem = PETSC_FALSE; 165271438e86SJunchao Zhang } 165371438e86SJunchao Zhang #endif 1654a0e72f99SJunchao Zhang 16559566063dSJacob Faibussowitsch PetscCall(PetscFreeMPIResources()); 1656e5c89e4eSSatish Balay 1657dbc8283eSBarry Smith /* 1658efb80d3cSBarry Smith Destroy any known inner MPI_Comm's and attributes pointing to them 1659efb80d3cSBarry Smith Note this will not destroy any new communicators the user has created. 1660efb80d3cSBarry Smith 1661efb80d3cSBarry Smith If all PETSc objects were not destroyed those left over objects will have hanging references to 1662efb80d3cSBarry Smith the MPI_Comms that were freed; but that is ok because those PETSc objects will never be used again 1663dbc8283eSBarry Smith */ 1664b770b1f6SSatish Balay { 1665dbc8283eSBarry Smith PetscCommCounter *counter; 1666dbc8283eSBarry Smith PetscMPIInt flg; 1667dbc8283eSBarry Smith MPI_Comm icomm; 1668265f3f35SJed Brown union {MPI_Comm comm; void *ptr;} ucomm; 16699566063dSJacob Faibussowitsch PetscCallMPI(MPI_Comm_get_attr(PETSC_COMM_SELF,Petsc_InnerComm_keyval,&ucomm,&flg)); 1670dbc8283eSBarry Smith if (flg) { 1671265f3f35SJed Brown icomm = ucomm.comm; 16729566063dSJacob Faibussowitsch PetscCallMPI(MPI_Comm_get_attr(icomm,Petsc_Counter_keyval,&counter,&flg)); 167328b400f6SJacob Faibussowitsch PetscCheck(flg,PETSC_COMM_SELF,PETSC_ERR_ARG_CORRUPT,"Inner MPI_Comm does not have expected tag/name counter, problem with corrupted memory"); 1674dbc8283eSBarry Smith 16759566063dSJacob Faibussowitsch PetscCallMPI(MPI_Comm_delete_attr(PETSC_COMM_SELF,Petsc_InnerComm_keyval)); 16769566063dSJacob Faibussowitsch PetscCallMPI(MPI_Comm_delete_attr(icomm,Petsc_Counter_keyval)); 16779566063dSJacob Faibussowitsch PetscCallMPI(MPI_Comm_free(&icomm)); 1678dbc8283eSBarry Smith } 16799566063dSJacob Faibussowitsch PetscCallMPI(MPI_Comm_get_attr(PETSC_COMM_WORLD,Petsc_InnerComm_keyval,&ucomm,&flg)); 1680dbc8283eSBarry Smith if (flg) { 1681265f3f35SJed Brown icomm = ucomm.comm; 16829566063dSJacob Faibussowitsch PetscCallMPI(MPI_Comm_get_attr(icomm,Petsc_Counter_keyval,&counter,&flg)); 168328b400f6SJacob Faibussowitsch PetscCheck(flg,PETSC_COMM_WORLD,PETSC_ERR_ARG_CORRUPT,"Inner MPI_Comm does not have expected tag/name counter, problem with corrupted memory"); 1684dbc8283eSBarry Smith 16859566063dSJacob Faibussowitsch PetscCallMPI(MPI_Comm_delete_attr(PETSC_COMM_WORLD,Petsc_InnerComm_keyval)); 16869566063dSJacob Faibussowitsch PetscCallMPI(MPI_Comm_delete_attr(icomm,Petsc_Counter_keyval)); 16879566063dSJacob Faibussowitsch PetscCallMPI(MPI_Comm_free(&icomm)); 1688dbc8283eSBarry Smith } 1689b770b1f6SSatish Balay } 1690dbc8283eSBarry Smith 16919566063dSJacob Faibussowitsch PetscCallMPI(MPI_Comm_free_keyval(&Petsc_Counter_keyval)); 16929566063dSJacob Faibussowitsch PetscCallMPI(MPI_Comm_free_keyval(&Petsc_InnerComm_keyval)); 16939566063dSJacob Faibussowitsch PetscCallMPI(MPI_Comm_free_keyval(&Petsc_OuterComm_keyval)); 16949566063dSJacob Faibussowitsch PetscCallMPI(MPI_Comm_free_keyval(&Petsc_ShmComm_keyval)); 1695480cf27aSJed Brown 16969566063dSJacob Faibussowitsch PetscCall(PetscSpinlockDestroy(&PetscViewerASCIISpinLockOpen)); 16979566063dSJacob Faibussowitsch PetscCall(PetscSpinlockDestroy(&PetscViewerASCIISpinLockStdout)); 16989566063dSJacob Faibussowitsch PetscCall(PetscSpinlockDestroy(&PetscViewerASCIISpinLockStderr)); 16999566063dSJacob Faibussowitsch PetscCall(PetscSpinlockDestroy(&PetscCommSpinLock)); 1700ef19f930SBarry Smith 1701e5c89e4eSSatish Balay if (PetscBeganMPI) { 170299b1327fSBarry Smith PetscMPIInt flag; 17039566063dSJacob Faibussowitsch PetscCallMPI(MPI_Finalized(&flag)); 170439a651e2SJacob Faibussowitsch PetscCheck(!flag,PETSC_COMM_SELF,PETSC_ERR_LIB,"MPI_Finalize() has already been called, even though MPI_Init() was called by PetscInitialize()"); 170539a651e2SJacob Faibussowitsch /* wait until the very last moment to disable error handling */ 170639a651e2SJacob Faibussowitsch PetscErrorHandlingInitialized = PETSC_FALSE; 17079566063dSJacob Faibussowitsch PetscCallMPI(MPI_Finalize()); 170839a651e2SJacob Faibussowitsch } else PetscErrorHandlingInitialized = PETSC_FALSE; 170939a651e2SJacob Faibussowitsch 1710e5c89e4eSSatish Balay /* 1711e5c89e4eSSatish Balay 1712e5c89e4eSSatish Balay Note: In certain cases PETSC_COMM_WORLD is never MPI_Comm_free()ed because 1713e5c89e4eSSatish Balay the communicator has some outstanding requests on it. Specifically if the 1714e5c89e4eSSatish Balay flag PETSC_HAVE_BROKEN_REQUEST_FREE is set (for IBM MPI implementation). See 1715e5c89e4eSSatish Balay src/vec/utils/vpscat.c. Due to this the memory allocated in PetscCommDuplicate() 1716e5c89e4eSSatish Balay is never freed as it should be. Thus one may obtain messages of the form 17170e5e90baSSatish Balay [ 1] 8 bytes PetscCommDuplicate() line 645 in src/sys/mpiu.c indicating the 1718e5c89e4eSSatish Balay memory was not freed. 1719e5c89e4eSSatish Balay 1720e5c89e4eSSatish Balay */ 17219566063dSJacob Faibussowitsch PetscCall(PetscMallocClear()); 17229566063dSJacob Faibussowitsch PetscCall(PetscStackReset()); 1723a297a907SKarl Rupp 1724e5c89e4eSSatish Balay PetscInitializeCalled = PETSC_FALSE; 1725e5c89e4eSSatish Balay PetscFinalizeCalled = PETSC_TRUE; 172656883f60SBarry Smith #if defined(PETSC_USE_GCOV) 172756883f60SBarry Smith /* 172856883f60SBarry Smith flush gcov, otherwise during CI the flushing continues into the next pipeline resulting in git not being able to delete directories since the 172956883f60SBarry Smith gcov files are still being added to the directories as git tries to remove the directories. 173056883f60SBarry Smith */ 173156883f60SBarry Smith __gcov_flush(); 173256883f60SBarry Smith #endif 17331724198aSStefano Zampini /* To match PetscFunctionBegin() at the beginning of this function */ 17341724198aSStefano Zampini PetscStackClearTop; 173527104ee2SJacob Faibussowitsch return 0; 1736e5c89e4eSSatish Balay } 1737e5c89e4eSSatish Balay 173843db4dbbSBarry Smith #if defined(PETSC_MISSING_LAPACK_lsame_) 17398cc058d9SJed Brown PETSC_EXTERN int lsame_(char *a,char *b) 174043db4dbbSBarry Smith { 174143db4dbbSBarry Smith if (*a == *b) return 1; 174243db4dbbSBarry Smith if (*a + 32 == *b) return 1; 174343db4dbbSBarry Smith if (*a - 32 == *b) return 1; 174443db4dbbSBarry Smith return 0; 174543db4dbbSBarry Smith } 1746a70650f6SBarry Smith #endif 174743db4dbbSBarry Smith 174843db4dbbSBarry Smith #if defined(PETSC_MISSING_LAPACK_lsame) 17498cc058d9SJed Brown PETSC_EXTERN int lsame(char *a,char *b) 175043db4dbbSBarry Smith { 175143db4dbbSBarry Smith if (*a == *b) return 1; 175243db4dbbSBarry Smith if (*a + 32 == *b) return 1; 175343db4dbbSBarry Smith if (*a - 32 == *b) return 1; 175443db4dbbSBarry Smith return 0; 175543db4dbbSBarry Smith } 175643db4dbbSBarry Smith #endif 1757