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*/ 6022afb99SBarry Smith #include <petscvalgrind.h> 7665c2dedSJed Brown #include <petscviewer.h> 8a0e72f99SJunchao Zhang 9a0e72f99SJunchao Zhang #if defined(PETSC_HAVE_CUDA) 10a0e72f99SJunchao Zhang #include <petsccublas.h> 11a0e72f99SJunchao Zhang #endif 12a0e72f99SJunchao Zhang 13a0e72f99SJunchao Zhang #if defined(PETSC_HAVE_HIP) 14a0e72f99SJunchao Zhang #include <petschipblas.h> 15a0e72f99SJunchao Zhang #endif 16a0e72f99SJunchao Zhang 1756883f60SBarry Smith #if defined(PETSC_USE_GCOV) 1856883f60SBarry Smith EXTERN_C_BEGIN 1956883f60SBarry Smith void __gcov_flush(void); 2056883f60SBarry Smith EXTERN_C_END 2156883f60SBarry Smith #endif 228101f56cSMatthew Knepley 23a9f03627SSatish Balay #if defined(PETSC_USE_LOG) 2495c0884eSLisandro Dalcin PETSC_INTERN PetscErrorCode PetscLogFinalize(void); 25a9f03627SSatish Balay #endif 26f2d66bcaSShri Abhyankar 272d53ad75SBarry Smith #if defined(PETSC_SERIALIZE_FUNCTIONS) 2895c0884eSLisandro Dalcin PETSC_INTERN PetscFPT PetscFPTData; 292d53ad75SBarry Smith PetscFPT PetscFPTData = 0; 302d53ad75SBarry Smith #endif 312d53ad75SBarry Smith 32a6790183SBarry Smith #if defined(PETSC_HAVE_SAWS) 3316ad0300SBarry Smith #include <petscviewersaws.h> 34a6790183SBarry Smith #endif 35eb02082bSJunchao Zhang 36e5c89e4eSSatish Balay /* -----------------------------------------------------------------------------------------*/ 37e5c89e4eSSatish Balay 3895c0884eSLisandro Dalcin PETSC_INTERN FILE *petsc_history; 39e5c89e4eSSatish Balay 4095c0884eSLisandro Dalcin PETSC_INTERN PetscErrorCode PetscInitialize_DynamicLibraries(void); 4195c0884eSLisandro Dalcin PETSC_INTERN PetscErrorCode PetscFinalize_DynamicLibraries(void); 4295c0884eSLisandro Dalcin PETSC_INTERN PetscErrorCode PetscFunctionListPrintAll(void); 4395c0884eSLisandro Dalcin PETSC_INTERN PetscErrorCode PetscSequentialPhaseBegin_Private(MPI_Comm,int); 4495c0884eSLisandro Dalcin PETSC_INTERN PetscErrorCode PetscSequentialPhaseEnd_Private(MPI_Comm,int); 4595c0884eSLisandro Dalcin PETSC_INTERN PetscErrorCode PetscCloseHistoryFile(FILE**); 460069ddf5SShri Abhyankar 476de5d289SStefano Zampini /* user may set these BEFORE calling PetscInitialize() */ 48e8373e55SMatthew Knepley MPI_Comm PETSC_COMM_WORLD = MPI_COMM_NULL; 496de5d289SStefano Zampini #if defined(PETSC_HAVE_MPI_INIT_THREAD) 506de5d289SStefano Zampini PetscMPIInt PETSC_MPI_THREAD_REQUIRED = MPI_THREAD_FUNNELED; 516de5d289SStefano Zampini #else 526de5d289SStefano Zampini PetscMPIInt PETSC_MPI_THREAD_REQUIRED = 0; 536de5d289SStefano Zampini #endif 54e5c89e4eSSatish Balay 55480cf27aSJed Brown PetscMPIInt Petsc_Counter_keyval = MPI_KEYVAL_INVALID; 56480cf27aSJed Brown PetscMPIInt Petsc_InnerComm_keyval = MPI_KEYVAL_INVALID; 57480cf27aSJed Brown PetscMPIInt Petsc_OuterComm_keyval = MPI_KEYVAL_INVALID; 585f7487a0SJunchao Zhang PetscMPIInt Petsc_ShmComm_keyval = MPI_KEYVAL_INVALID; 59480cf27aSJed Brown 60e5c89e4eSSatish Balay /* 61e5c89e4eSSatish Balay Declare and set all the string names of the PETSc enums 62e5c89e4eSSatish Balay */ 6302c9f0b5SLisandro Dalcin const char *const PetscBools[] = {"FALSE","TRUE","PetscBool","PETSC_",NULL}; 6402c9f0b5SLisandro Dalcin const char *const PetscCopyModes[] = {"COPY_VALUES","OWN_POINTER","USE_POINTER","PetscCopyMode","PETSC_",NULL}; 65e5c89e4eSSatish Balay 66ace3abfcSBarry Smith PetscBool PetscPreLoadingUsed = PETSC_FALSE; 67ace3abfcSBarry Smith PetscBool PetscPreLoadingOn = PETSC_FALSE; 680f8e0872SSatish Balay 69a2f94806SJed Brown PetscInt PetscHotRegionDepth; 70a2f94806SJed Brown 71b22622e2STadeu Manoel #if defined(PETSC_HAVE_THREADSAFETY) 72b22622e2STadeu Manoel PetscSpinlock PetscViewerASCIISpinLockOpen; 73b22622e2STadeu Manoel PetscSpinlock PetscViewerASCIISpinLockStdout; 74b22622e2STadeu Manoel PetscSpinlock PetscViewerASCIISpinLockStderr; 75b22622e2STadeu Manoel PetscSpinlock PetscCommSpinLock; 76b22622e2STadeu Manoel #endif 77b22622e2STadeu Manoel 78e5c89e4eSSatish Balay /* 79945d1669SBarry Smith PetscInitializeNoPointers - Calls PetscInitialize() from C/C++ without the pointers to argc and args 8072a42c3cSBarry Smith 8172a42c3cSBarry Smith Collective 8272a42c3cSBarry Smith 8372a42c3cSBarry Smith Level: advanced 8472a42c3cSBarry Smith 8595452b02SPatrick Sanan Notes: 86a56f64adSBarry Smith this is called only by the PETSc Julia interface. Even though it might start MPI it sets the flag to 870f11a792SBarry Smith indicate that it did NOT start MPI so that the PetscFinalize() does not end MPI, thus allowing PetscInitialize() to 88a56f64adSBarry Smith be called multiple times from Julia without the problem of trying to initialize MPI more than once. 890f11a792SBarry Smith 90a56f64adSBarry Smith Developer Note: Turns off PETSc signal handling to allow Julia to manage signals 911ea5a559SBarry Smith 9272a42c3cSBarry Smith .seealso: PetscInitialize(), PetscInitializeFortran(), PetscInitializeNoArguments() 930f11a792SBarry Smith */ 94945d1669SBarry Smith PetscErrorCode PetscInitializeNoPointers(int argc,char **args,const char *filename,const char *help) 9572a42c3cSBarry Smith { 9672a42c3cSBarry Smith PetscErrorCode ierr; 9772a42c3cSBarry Smith int myargc = argc; 9872a42c3cSBarry Smith char **myargs = args; 9972a42c3cSBarry Smith 10072a42c3cSBarry Smith PetscFunctionBegin; 101c52ac268SRichard Tran Mills ierr = PetscInitialize(&myargc,&myargs,filename,help);if (ierr) return ierr; 1021ea5a559SBarry Smith ierr = PetscPopSignalHandler();CHKERRQ(ierr); 103df413903SBarry Smith PetscBeganMPI = PETSC_FALSE; 10472a42c3cSBarry Smith PetscFunctionReturn(ierr); 10572a42c3cSBarry Smith } 10672a42c3cSBarry Smith 107f0865b08SBarry Smith /* 108a56f64adSBarry Smith Used by Julia interface to get communicator 109f0865b08SBarry Smith */ 110945d1669SBarry Smith PetscErrorCode PetscGetPETSC_COMM_SELF(MPI_Comm *comm) 111f0865b08SBarry Smith { 112f0865b08SBarry Smith PetscFunctionBegin; 113f0865b08SBarry Smith *comm = PETSC_COMM_SELF; 114f0865b08SBarry Smith PetscFunctionReturn(0); 115f0865b08SBarry Smith } 116f0865b08SBarry Smith 117e5c89e4eSSatish Balay /*@C 118e5c89e4eSSatish Balay PetscInitializeNoArguments - Calls PetscInitialize() from C/C++ without 119e5c89e4eSSatish Balay the command line arguments. 120e5c89e4eSSatish Balay 121e5c89e4eSSatish Balay Collective 122e5c89e4eSSatish Balay 123e5c89e4eSSatish Balay Level: advanced 124e5c89e4eSSatish Balay 125e5c89e4eSSatish Balay .seealso: PetscInitialize(), PetscInitializeFortran() 126e5c89e4eSSatish Balay @*/ 1277087cfbeSBarry Smith PetscErrorCode PetscInitializeNoArguments(void) 128e5c89e4eSSatish Balay { 129e5c89e4eSSatish Balay PetscErrorCode ierr; 130e5c89e4eSSatish Balay int argc = 0; 13102c9f0b5SLisandro Dalcin char **args = NULL; 132e5c89e4eSSatish Balay 133e5c89e4eSSatish Balay PetscFunctionBegin; 1340298fd71SBarry Smith ierr = PetscInitialize(&argc,&args,NULL,NULL); 135e5c89e4eSSatish Balay PetscFunctionReturn(ierr); 136e5c89e4eSSatish Balay } 137e5c89e4eSSatish Balay 138e5c89e4eSSatish Balay /*@ 139e5c89e4eSSatish Balay PetscInitialized - Determine whether PETSc is initialized. 140e5c89e4eSSatish Balay 14193b6d2d1SJed Brown Level: beginner 142e5c89e4eSSatish Balay 143e5c89e4eSSatish Balay .seealso: PetscInitialize(), PetscInitializeNoArguments(), PetscInitializeFortran() 144e5c89e4eSSatish Balay @*/ 1457087cfbeSBarry Smith PetscErrorCode PetscInitialized(PetscBool *isInitialized) 146e5c89e4eSSatish Balay { 147e5c89e4eSSatish Balay *isInitialized = PetscInitializeCalled; 14893b6d2d1SJed Brown return 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 156e5c89e4eSSatish Balay .seealso: PetscInitialize(), PetscInitializeNoArguments(), PetscInitializeFortran() 157e5c89e4eSSatish Balay @*/ 1587087cfbeSBarry Smith PetscErrorCode PetscFinalized(PetscBool *isFinalized) 159e5c89e4eSSatish Balay { 160e5c89e4eSSatish Balay *isFinalized = PetscFinalizeCalled; 16193b6d2d1SJed Brown return 0; 162e5c89e4eSSatish Balay } 163e5c89e4eSSatish Balay 16457171095SVaclav Hapla PETSC_INTERN PetscErrorCode PetscOptionsCheckInitial_Private(const char []); 165e5c89e4eSSatish Balay 166e5c89e4eSSatish Balay /* 167e5c89e4eSSatish Balay This function is the MPI reduction operation used to compute the sum of the 168e5c89e4eSSatish Balay first half of the datatype and the max of the second half. 169e5c89e4eSSatish Balay */ 170367daffbSBarry Smith MPI_Op MPIU_MAXSUM_OP = 0; 171e5c89e4eSSatish Balay 172367daffbSBarry Smith PETSC_INTERN void MPIAPI MPIU_MaxSum_Local(void *in,void *out,int *cnt,MPI_Datatype *datatype) 173e5c89e4eSSatish Balay { 174e5c89e4eSSatish Balay PetscInt *xin = (PetscInt*)in,*xout = (PetscInt*)out,i,count = *cnt; 175e5c89e4eSSatish Balay 176e5c89e4eSSatish Balay PetscFunctionBegin; 177e5c89e4eSSatish Balay if (*datatype != MPIU_2INT) { 178e5c89e4eSSatish Balay (*PetscErrorPrintf)("Can only handle MPIU_2INT data types"); 17941e02c4dSJunchao Zhang PETSCABORT(MPI_COMM_SELF,PETSC_ERR_ARG_WRONG); 180e5c89e4eSSatish Balay } 181e5c89e4eSSatish Balay 182e5c89e4eSSatish Balay for (i=0; i<count; i++) { 183e5c89e4eSSatish Balay xout[2*i] = PetscMax(xout[2*i],xin[2*i]); 184e5c89e4eSSatish Balay xout[2*i+1] += xin[2*i+1]; 185e5c89e4eSSatish Balay } 186812af9f3SBarry Smith PetscFunctionReturnVoid(); 187e5c89e4eSSatish Balay } 188e5c89e4eSSatish Balay 189e5c89e4eSSatish Balay /* 190e5c89e4eSSatish Balay Returns the max of the first entry owned by this processor and the 191e5c89e4eSSatish Balay sum of the second entry. 192b693b147SBarry Smith 19376f543a4SJed Brown The reason sizes[2*i] contains lengths sizes[2*i+1] contains flag of 1 if length is nonzero 194367daffbSBarry Smith is so that the MPIU_MAXSUM_OP() can set TWO values, if we passed in only sizes[i] with lengths 195b693b147SBarry Smith there would be no place to store the both needed results. 196e5c89e4eSSatish Balay */ 19776ec1555SBarry Smith PetscErrorCode PetscMaxSum(MPI_Comm comm,const PetscInt sizes[],PetscInt *max,PetscInt *sum) 198e5c89e4eSSatish Balay { 199e5c89e4eSSatish Balay PetscErrorCode ierr; 200e5c89e4eSSatish Balay 201e5c89e4eSSatish Balay PetscFunctionBegin; 202d6e4c47cSJed Brown #if defined(PETSC_HAVE_MPI_REDUCE_SCATTER_BLOCK) 203d6e4c47cSJed Brown { 204d6e4c47cSJed Brown struct {PetscInt max,sum;} work; 205ffc4695bSBarry Smith ierr = MPI_Reduce_scatter_block((void*)sizes,&work,1,MPIU_2INT,MPIU_MAXSUM_OP,comm);CHKERRMPI(ierr); 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; 213ffc4695bSBarry Smith ierr = MPI_Comm_size(comm,&size);CHKERRMPI(ierr); 214ffc4695bSBarry Smith ierr = MPI_Comm_rank(comm,&rank);CHKERRMPI(ierr); 215785e854fSJed Brown ierr = PetscMalloc1(size,&work);CHKERRQ(ierr); 216367daffbSBarry Smith ierr = MPIU_Allreduce((void*)sizes,work,size,MPIU_2INT,MPIU_MAXSUM_OP,comm);CHKERRQ(ierr); 2176ac3741eSJed Brown *max = work[rank].max; 2186ac3741eSJed Brown *sum = work[rank].sum; 219e5c89e4eSSatish Balay ierr = PetscFree(work);CHKERRQ(ierr); 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 2308cc058d9SJed Brown PETSC_EXTERN void 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) 240de272c7aSSatish Balay else if (*datatype == MPI_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 2578cc058d9SJed Brown PETSC_EXTERN void 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 2818cc058d9SJed Brown PETSC_EXTERN void 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 { 316480cf27aSJed Brown PetscErrorCode ierr; 31705342407SJunchao Zhang PetscCommCounter *counter=(PetscCommCounter*)count_val; 318480cf27aSJed Brown 319480cf27aSJed Brown PetscFunctionBegin; 32002c9f0b5SLisandro Dalcin ierr = PetscInfo1(NULL,"Deleting counter data in an MPI_Comm %ld\n",(long)comm);CHKERRMPI(ierr); 32105342407SJunchao Zhang ierr = PetscFree(counter->iflags);CHKERRMPI(ierr); 32205342407SJunchao Zhang ierr = PetscFree(counter);CHKERRMPI(ierr); 323480cf27aSJed Brown PetscFunctionReturn(MPI_SUCCESS); 324480cf27aSJed Brown } 325480cf27aSJed Brown 326480cf27aSJed Brown /* 32747435625SJed Brown This is invoked on the outer comm as a result of either PetscCommDestroy() (via MPI_Comm_delete_attr) or when the user 328da3039f7SJed Brown calls MPI_Comm_free(). 329da3039f7SJed Brown 330da3039f7SJed Brown This is the only entry point for breaking the links between inner and outer comms. 331480cf27aSJed Brown 332ff0e51ddSBarry Smith This is called by MPI, not by users. This is called when MPI_Comm_free() is called on the communicator. 333480cf27aSJed Brown 33412801b39SBarry Smith Note: this is declared extern "C" because it is passed to MPI_Comm_create_keyval() 335480cf27aSJed Brown 336480cf27aSJed Brown */ 33733779a13SJunchao Zhang PETSC_EXTERN PetscMPIInt MPIAPI Petsc_InnerComm_Attr_Delete_Fn(MPI_Comm comm,PetscMPIInt keyval,void *attr_val,void *extra_state) 338480cf27aSJed Brown { 339480cf27aSJed Brown PetscErrorCode ierr; 34033779a13SJunchao Zhang union {MPI_Comm comm; void *ptr;} icomm; 341480cf27aSJed Brown 342480cf27aSJed Brown PetscFunctionBegin; 34312801b39SBarry Smith if (keyval != Petsc_InnerComm_keyval) SETERRMPI(PETSC_COMM_SELF,PETSC_ERR_ARG_CORRUPT,"Unexpected keyval"); 344ec4fadc2SJed Brown icomm.ptr = attr_val; 34576bd3646SJed Brown if (PetscDefined(USE_DEBUG)) { 34633779a13SJunchao Zhang /* Error out if the inner/outer comms are not correctly linked through their Outer/InnterComm attributes */ 34733779a13SJunchao Zhang PetscMPIInt flg; 34833779a13SJunchao Zhang union {MPI_Comm comm; void *ptr;} ocomm; 34947435625SJed Brown ierr = MPI_Comm_get_attr(icomm.comm,Petsc_OuterComm_keyval,&ocomm,&flg);CHKERRMPI(ierr); 35033779a13SJunchao Zhang if (!flg) SETERRMPI(PETSC_COMM_SELF,PETSC_ERR_ARG_CORRUPT,"Inner comm does not have OuterComm attribute"); 35133779a13SJunchao 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"); 35233779a13SJunchao Zhang } 35347435625SJed Brown ierr = MPI_Comm_delete_attr(icomm.comm,Petsc_OuterComm_keyval);CHKERRMPI(ierr); 35433779a13SJunchao Zhang ierr = PetscInfo2(NULL,"User MPI_Comm %ld is being unlinked from inner PETSc comm %ld\n",(long)comm,(long)icomm.comm);CHKERRMPI(ierr); 355da3039f7SJed Brown PetscFunctionReturn(MPI_SUCCESS); 356b89831e5SBarry Smith } 357da3039f7SJed Brown 358da3039f7SJed Brown /* 35933779a13SJunchao 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. 360da3039f7SJed Brown */ 36133779a13SJunchao Zhang PETSC_EXTERN PetscMPIInt MPIAPI Petsc_OuterComm_Attr_Delete_Fn(MPI_Comm comm,PetscMPIInt keyval,void *attr_val,void *extra_state) 362da3039f7SJed Brown { 363da3039f7SJed Brown PetscErrorCode ierr; 364da3039f7SJed Brown 365da3039f7SJed Brown PetscFunctionBegin; 36602c9f0b5SLisandro Dalcin ierr = PetscInfo1(NULL,"Removing reference to PETSc communicator embedded in a user MPI_Comm %ld\n",(long)comm);CHKERRMPI(ierr); 367480cf27aSJed Brown PetscFunctionReturn(MPI_SUCCESS); 368480cf27aSJed Brown } 369480cf27aSJed Brown 37033779a13SJunchao Zhang PETSC_EXTERN PetscMPIInt MPIAPI Petsc_ShmComm_Attr_Delete_Fn(MPI_Comm,PetscMPIInt,void *,void *); 37142218b76SBarry Smith 372951e3c8eSBarry Smith #if defined(PETSC_USE_PETSC_MPI_EXTERNAL32) 3738cc058d9SJed Brown PETSC_EXTERN PetscMPIInt PetscDataRep_extent_fn(MPI_Datatype,MPI_Aint*,void*); 3748cc058d9SJed Brown PETSC_EXTERN PetscMPIInt PetscDataRep_read_conv_fn(void*, MPI_Datatype,PetscMPIInt,void*,MPI_Offset,void*); 3758cc058d9SJed Brown PETSC_EXTERN PetscMPIInt PetscDataRep_write_conv_fn(void*, MPI_Datatype,PetscMPIInt,void*,MPI_Offset,void*); 376e39fd77fSBarry Smith #endif 377e39fd77fSBarry Smith 3780f9be574SPeter Hill PetscMPIInt PETSC_MPI_ERROR_CLASS=MPI_ERR_LASTCODE,PETSC_MPI_ERROR_CODE; 37912801b39SBarry Smith 380eb27c7c8SSatish Balay PETSC_INTERN int PetscGlobalArgc; 381eb27c7c8SSatish Balay PETSC_INTERN char **PetscGlobalArgs; 3826ae9a8a6SBarry Smith int PetscGlobalArgc = 0; 38302c9f0b5SLisandro Dalcin char **PetscGlobalArgs = NULL; 384dff31646SBarry Smith PetscSegBuffer PetscCitationsList; 385e5c89e4eSSatish Balay 386dd63322aSSatish Balay PetscErrorCode PetscCitationsInitialize(void) 387051e4cf2SJed Brown { 388051e4cf2SJed Brown PetscErrorCode ierr; 389051e4cf2SJed Brown 390051e4cf2SJed Brown PetscFunctionBegin; 391051e4cf2SJed Brown ierr = PetscSegBufferCreate(1,10000,&PetscCitationsList);CHKERRQ(ierr); 392a1601671SBarry Smith ierr = PetscCitationsRegister("@TechReport{petsc-user-ref,\n Author = {Satish Balay and Shrirang Abhyankar and Mark F. Adams and Jed Brown \n and Peter Brune and Kris Buschelman and Lisandro Dalcin and\n Victor Eijkhout and William D. Gropp and Dmitry Karpeyev and\n Dinesh Kaushik and Matthew G. Knepley and Dave A. May and Lois Curfman McInnes\n and Richard Tran Mills and Todd Munson and Karl Rupp and Patrick Sanan\n and Barry F. Smith and Stefano Zampini and Hong Zhang and Hong Zhang},\n Title = {{PETS}c Users Manual},\n Number = {ANL-95/11 - Revision 3.11},\n Institution = {Argonne National Laboratory},\n Year = {2019}\n}\n",NULL);CHKERRQ(ierr); 393051e4cf2SJed Brown ierr = PetscCitationsRegister("@InProceedings{petsc-efficient,\n Author = {Satish Balay and William D. Gropp and Lois Curfman McInnes and Barry F. Smith},\n Title = {Efficient Management of Parallelism in Object Oriented Numerical Software Libraries},\n Booktitle = {Modern Software Tools in Scientific Computing},\n Editor = {E. Arge and A. M. Bruaset and H. P. Langtangen},\n Pages = {163--202},\n Publisher = {Birkh{\\\"{a}}user Press},\n Year = {1997}\n}\n",NULL);CHKERRQ(ierr); 394051e4cf2SJed Brown PetscFunctionReturn(0); 395051e4cf2SJed Brown } 396e5c89e4eSSatish Balay 3972d747510SLisandro Dalcin static char programname[PETSC_MAX_PATH_LEN] = ""; /* HP includes entire path in name */ 3982d747510SLisandro Dalcin 3992d747510SLisandro Dalcin PetscErrorCode PetscSetProgramName(const char name[]) 4002d747510SLisandro Dalcin { 4012d747510SLisandro Dalcin PetscErrorCode ierr; 4022d747510SLisandro Dalcin 4032d747510SLisandro Dalcin PetscFunctionBegin; 404589a23caSBarry Smith ierr = PetscStrncpy(programname,name,sizeof(programname));CHKERRQ(ierr); 4052d747510SLisandro Dalcin PetscFunctionReturn(0); 4062d747510SLisandro Dalcin } 4072d747510SLisandro Dalcin 4082d747510SLisandro Dalcin /*@C 4092d747510SLisandro Dalcin PetscGetProgramName - Gets the name of the running program. 4102d747510SLisandro Dalcin 4112d747510SLisandro Dalcin Not Collective 4122d747510SLisandro Dalcin 4132d747510SLisandro Dalcin Input Parameter: 4142d747510SLisandro Dalcin . len - length of the string name 4152d747510SLisandro Dalcin 4162d747510SLisandro Dalcin Output Parameter: 4172d747510SLisandro Dalcin . name - the name of the running program 4182d747510SLisandro Dalcin 4192d747510SLisandro Dalcin Level: advanced 4202d747510SLisandro Dalcin 4212d747510SLisandro Dalcin Notes: 4222d747510SLisandro Dalcin The name of the program is copied into the user-provided character 4232d747510SLisandro Dalcin array of length len. On some machines the program name includes 4242d747510SLisandro Dalcin its entire path, so one should generally set len >= PETSC_MAX_PATH_LEN. 4252d747510SLisandro Dalcin @*/ 4262d747510SLisandro Dalcin PetscErrorCode PetscGetProgramName(char name[],size_t len) 4272d747510SLisandro Dalcin { 4282d747510SLisandro Dalcin PetscErrorCode ierr; 4292d747510SLisandro Dalcin 4302d747510SLisandro Dalcin PetscFunctionBegin; 4312d747510SLisandro Dalcin ierr = PetscStrncpy(name,programname,len);CHKERRQ(ierr); 4322d747510SLisandro Dalcin PetscFunctionReturn(0); 4332d747510SLisandro Dalcin } 4342d747510SLisandro Dalcin 435e5c89e4eSSatish Balay /*@C 436e5c89e4eSSatish Balay PetscGetArgs - Allows you to access the raw command line arguments anywhere 437e5c89e4eSSatish Balay after PetscInitialize() is called but before PetscFinalize(). 438e5c89e4eSSatish Balay 439e5c89e4eSSatish Balay Not Collective 440e5c89e4eSSatish Balay 441e5c89e4eSSatish Balay Output Parameters: 442e5c89e4eSSatish Balay + argc - count of number of command line arguments 443e5c89e4eSSatish Balay - args - the command line arguments 444e5c89e4eSSatish Balay 445e5c89e4eSSatish Balay Level: intermediate 446e5c89e4eSSatish Balay 447e5c89e4eSSatish Balay Notes: 448e5c89e4eSSatish Balay This is usually used to pass the command line arguments into other libraries 449e5c89e4eSSatish Balay that are called internally deep in PETSc or the application. 450e5c89e4eSSatish Balay 451f177e3b1SBarry Smith The first argument contains the program name as is normal for C arguments. 452f177e3b1SBarry Smith 453793721a6SBarry Smith .seealso: PetscFinalize(), PetscInitializeFortran(), PetscGetArguments() 454e5c89e4eSSatish Balay 455e5c89e4eSSatish Balay @*/ 4567087cfbeSBarry Smith PetscErrorCode PetscGetArgs(int *argc,char ***args) 457e5c89e4eSSatish Balay { 458e5c89e4eSSatish Balay PetscFunctionBegin; 45917186662SBarry Smith if (!PetscInitializeCalled && PetscFinalizeCalled) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ORDER,"You must call after PetscInitialize() but before PetscFinalize()"); 460e5c89e4eSSatish Balay *argc = PetscGlobalArgc; 461e5c89e4eSSatish Balay *args = PetscGlobalArgs; 462e5c89e4eSSatish Balay PetscFunctionReturn(0); 463e5c89e4eSSatish Balay } 464e5c89e4eSSatish Balay 465793721a6SBarry Smith /*@C 466793721a6SBarry Smith PetscGetArguments - Allows you to access the command line arguments anywhere 467793721a6SBarry Smith after PetscInitialize() is called but before PetscFinalize(). 468793721a6SBarry Smith 469793721a6SBarry Smith Not Collective 470793721a6SBarry Smith 471793721a6SBarry Smith Output Parameters: 472793721a6SBarry Smith . args - the command line arguments 473793721a6SBarry Smith 474793721a6SBarry Smith Level: intermediate 475793721a6SBarry Smith 476793721a6SBarry Smith Notes: 477793721a6SBarry Smith This does NOT start with the program name and IS null terminated (final arg is void) 478793721a6SBarry Smith 479793721a6SBarry Smith .seealso: PetscFinalize(), PetscInitializeFortran(), PetscGetArgs(), PetscFreeArguments() 480793721a6SBarry Smith 481793721a6SBarry Smith @*/ 4827087cfbeSBarry Smith PetscErrorCode PetscGetArguments(char ***args) 483793721a6SBarry Smith { 484793721a6SBarry Smith PetscInt i,argc = PetscGlobalArgc; 485793721a6SBarry Smith PetscErrorCode ierr; 486793721a6SBarry Smith 487793721a6SBarry Smith PetscFunctionBegin; 48817186662SBarry Smith if (!PetscInitializeCalled && PetscFinalizeCalled) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ORDER,"You must call after PetscInitialize() but before PetscFinalize()"); 4892d747510SLisandro Dalcin if (!argc) {*args = NULL; PetscFunctionReturn(0);} 490785e854fSJed Brown ierr = PetscMalloc1(argc,args);CHKERRQ(ierr); 491793721a6SBarry Smith for (i=0; i<argc-1; i++) { 492793721a6SBarry Smith ierr = PetscStrallocpy(PetscGlobalArgs[i+1],&(*args)[i]);CHKERRQ(ierr); 493793721a6SBarry Smith } 4942d747510SLisandro Dalcin (*args)[argc-1] = NULL; 495793721a6SBarry Smith PetscFunctionReturn(0); 496793721a6SBarry Smith } 497793721a6SBarry Smith 498793721a6SBarry Smith /*@C 499793721a6SBarry Smith PetscFreeArguments - Frees the memory obtained with PetscGetArguments() 500793721a6SBarry Smith 501793721a6SBarry Smith Not Collective 502793721a6SBarry Smith 503793721a6SBarry Smith Output Parameters: 504793721a6SBarry Smith . args - the command line arguments 505793721a6SBarry Smith 506793721a6SBarry Smith Level: intermediate 507793721a6SBarry Smith 508793721a6SBarry Smith .seealso: PetscFinalize(), PetscInitializeFortran(), PetscGetArgs(), PetscGetArguments() 509793721a6SBarry Smith 510793721a6SBarry Smith @*/ 5117087cfbeSBarry Smith PetscErrorCode PetscFreeArguments(char **args) 512793721a6SBarry Smith { 513793721a6SBarry Smith PetscInt i = 0; 514793721a6SBarry Smith PetscErrorCode ierr; 515793721a6SBarry Smith 516793721a6SBarry Smith PetscFunctionBegin; 517a297a907SKarl Rupp if (!args) PetscFunctionReturn(0); 518793721a6SBarry Smith while (args[i]) { 519793721a6SBarry Smith ierr = PetscFree(args[i]);CHKERRQ(ierr); 520793721a6SBarry Smith i++; 521793721a6SBarry Smith } 522793721a6SBarry Smith ierr = PetscFree(args);CHKERRQ(ierr); 523793721a6SBarry Smith PetscFunctionReturn(0); 524793721a6SBarry Smith } 525793721a6SBarry Smith 52611525c0dSBarry Smith #if defined(PETSC_HAVE_SAWS) 52730befbd2SBarry Smith #include <petscconfiginfo.h> 52830befbd2SBarry Smith 52995c0884eSLisandro Dalcin PETSC_INTERN PetscErrorCode PetscInitializeSAWs(const char help[]) 53011525c0dSBarry Smith { 53111525c0dSBarry Smith if (!PetscGlobalRank) { 53230befbd2SBarry Smith char cert[PETSC_MAX_PATH_LEN],root[PETSC_MAX_PATH_LEN],*intro,programname[64],*appline,*options,version[64]; 53311525c0dSBarry Smith int port; 534ffbd1cfbSBarry Smith PetscBool flg,rootlocal = PETSC_FALSE,flg2,selectport = PETSC_FALSE; 53511525c0dSBarry Smith size_t applinelen,introlen; 53611525c0dSBarry Smith PetscErrorCode ierr; 537ffbd1cfbSBarry Smith char sawsurl[256]; 53811525c0dSBarry Smith 539c5929fdfSBarry Smith ierr = PetscOptionsHasName(NULL,NULL,"-saws_log",&flg);CHKERRQ(ierr); 54011525c0dSBarry Smith if (flg) { 54111525c0dSBarry Smith char sawslog[PETSC_MAX_PATH_LEN]; 54211525c0dSBarry Smith 543589a23caSBarry Smith ierr = PetscOptionsGetString(NULL,NULL,"-saws_log",sawslog,sizeof(sawslog),NULL);CHKERRQ(ierr); 54411525c0dSBarry Smith if (sawslog[0]) { 54511525c0dSBarry Smith PetscStackCallSAWs(SAWs_Set_Use_Logfile,(sawslog)); 54611525c0dSBarry Smith } else { 54711525c0dSBarry Smith PetscStackCallSAWs(SAWs_Set_Use_Logfile,(NULL)); 54811525c0dSBarry Smith } 54911525c0dSBarry Smith } 550589a23caSBarry Smith ierr = PetscOptionsGetString(NULL,NULL,"-saws_https",cert,sizeof(cert),&flg);CHKERRQ(ierr); 55111525c0dSBarry Smith if (flg) { 55211525c0dSBarry Smith PetscStackCallSAWs(SAWs_Set_Use_HTTPS,(cert)); 55311525c0dSBarry Smith } 554c5929fdfSBarry Smith ierr = PetscOptionsGetBool(NULL,NULL,"-saws_port_auto_select",&selectport,NULL);CHKERRQ(ierr); 555ffbd1cfbSBarry Smith if (selectport) { 556ffbd1cfbSBarry Smith PetscStackCallSAWs(SAWs_Get_Available_Port,(&port)); 557ffbd1cfbSBarry Smith PetscStackCallSAWs(SAWs_Set_Port,(port)); 558ffbd1cfbSBarry Smith } else { 559c5929fdfSBarry Smith ierr = PetscOptionsGetInt(NULL,NULL,"-saws_port",&port,&flg);CHKERRQ(ierr); 56011525c0dSBarry Smith if (flg) { 56111525c0dSBarry Smith PetscStackCallSAWs(SAWs_Set_Port,(port)); 56211525c0dSBarry Smith } 563ffbd1cfbSBarry Smith } 564589a23caSBarry Smith ierr = PetscOptionsGetString(NULL,NULL,"-saws_root",root,sizeof(root),&flg);CHKERRQ(ierr); 56511525c0dSBarry Smith if (flg) { 56611525c0dSBarry Smith PetscStackCallSAWs(SAWs_Set_Document_Root,(root));CHKERRQ(ierr); 56711525c0dSBarry Smith ierr = PetscStrcmp(root,".",&rootlocal);CHKERRQ(ierr); 5689c1e0ce8SBarry Smith } else { 569c5929fdfSBarry Smith ierr = PetscOptionsHasName(NULL,NULL,"-saws_options",&flg);CHKERRQ(ierr); 5709c1e0ce8SBarry Smith if (flg) { 571589a23caSBarry Smith ierr = PetscStrreplace(PETSC_COMM_WORLD,"${PETSC_DIR}/share/petsc/saws",root,sizeof(root));CHKERRQ(ierr); 5729c1e0ce8SBarry Smith PetscStackCallSAWs(SAWs_Set_Document_Root,(root));CHKERRQ(ierr); 5739c1e0ce8SBarry Smith } 57411525c0dSBarry Smith } 575c5929fdfSBarry Smith ierr = PetscOptionsHasName(NULL,NULL,"-saws_local",&flg2);CHKERRQ(ierr); 57611525c0dSBarry Smith if (flg2) { 57711525c0dSBarry Smith char jsdir[PETSC_MAX_PATH_LEN]; 57811525c0dSBarry Smith if (!flg) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SUP,"-saws_local option requires -saws_root option"); 579589a23caSBarry Smith ierr = PetscSNPrintf(jsdir,sizeof(jsdir),"%s/js",root);CHKERRQ(ierr); 58011525c0dSBarry Smith ierr = PetscTestDirectory(jsdir,'r',&flg);CHKERRQ(ierr); 58111525c0dSBarry Smith if (!flg) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_FILE_READ,"-saws_local option requires js directory in root directory"); 58243da4ab2SBarry Smith PetscStackCallSAWs(SAWs_Push_Local_Header,());CHKERRQ(ierr); 58311525c0dSBarry Smith } 584589a23caSBarry Smith ierr = PetscGetProgramName(programname,sizeof(programname));CHKERRQ(ierr); 58511525c0dSBarry Smith ierr = PetscStrlen(help,&applinelen);CHKERRQ(ierr); 58611525c0dSBarry Smith introlen = 4096 + applinelen; 58730a8c9c0SSurtai Han applinelen += 1024; 58811525c0dSBarry Smith ierr = PetscMalloc(applinelen,&appline);CHKERRQ(ierr); 58911525c0dSBarry Smith ierr = PetscMalloc(introlen,&intro);CHKERRQ(ierr); 59011525c0dSBarry Smith 59111525c0dSBarry Smith if (rootlocal) { 59211525c0dSBarry Smith ierr = PetscSNPrintf(appline,applinelen,"%s.c.html",programname);CHKERRQ(ierr); 59311525c0dSBarry Smith ierr = PetscTestFile(appline,'r',&rootlocal);CHKERRQ(ierr); 59411525c0dSBarry Smith } 59576a34f28SBarry Smith ierr = PetscOptionsGetAll(NULL,&options);CHKERRQ(ierr); 59611525c0dSBarry Smith if (rootlocal && help) { 597928bb9adSStefano Zampini ierr = PetscSNPrintf(appline,applinelen,"<center> Running <a href=\"%s.c.html\">%s</a> %s</center><br><center><pre>%s</pre></center><br>\n",programname,programname,options,help);CHKERRQ(ierr); 59811525c0dSBarry Smith } else if (help) { 599928bb9adSStefano Zampini ierr = PetscSNPrintf(appline,applinelen,"<center>Running %s %s</center><br><center><pre>%s</pre></center><br>",programname,options,help);CHKERRQ(ierr); 60011525c0dSBarry Smith } else { 601928bb9adSStefano Zampini ierr = PetscSNPrintf(appline,applinelen,"<center> Running %s %s</center><br>\n",programname,options);CHKERRQ(ierr); 60211525c0dSBarry Smith } 603b0bb5815SBarry Smith ierr = PetscFree(options);CHKERRQ(ierr); 60430befbd2SBarry Smith ierr = PetscGetVersion(version,sizeof(version));CHKERRQ(ierr); 60511525c0dSBarry Smith ierr = PetscSNPrintf(intro,introlen,"<body>\n" 606a8d69d7bSBarry Smith "<center><h2> <a href=\"https://www.mcs.anl.gov/petsc\">PETSc</a> Application Web server powered by <a href=\"https://bitbucket.org/saws/saws\">SAWs</a> </h2></center>\n" 607df62c222SBarry 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" 608928bb9adSStefano Zampini "%s",version,petscconfigureoptions,appline);CHKERRQ(ierr); 60943da4ab2SBarry Smith PetscStackCallSAWs(SAWs_Push_Body,("index.html",0,intro)); 61011525c0dSBarry Smith ierr = PetscFree(intro);CHKERRQ(ierr); 61111525c0dSBarry Smith ierr = PetscFree(appline);CHKERRQ(ierr); 612ffbd1cfbSBarry Smith if (selectport) { 613aa573868SBarry Smith PetscBool silent; 6147d812c46SBarry Smith 6157d812c46SBarry Smith ierr = SAWs_Initialize(); 6167d812c46SBarry Smith /* another process may have grabbed the port so keep trying */ 6177d812c46SBarry Smith while (ierr) { 6187d812c46SBarry Smith PetscStackCallSAWs(SAWs_Get_Available_Port,(&port)); 6197d812c46SBarry Smith PetscStackCallSAWs(SAWs_Set_Port,(port)); 6207d812c46SBarry Smith ierr = SAWs_Initialize(); 6217d812c46SBarry Smith } 6227d812c46SBarry Smith 623aa573868SBarry Smith ierr = PetscOptionsGetBool(NULL,NULL,"-saws_port_auto_select_silent",&silent,NULL);CHKERRQ(ierr); 624aa573868SBarry Smith if (!silent) { 625ffbd1cfbSBarry Smith PetscStackCallSAWs(SAWs_Get_FullURL,(sizeof(sawsurl),sawsurl)); 626ffbd1cfbSBarry Smith ierr = PetscPrintf(PETSC_COMM_WORLD,"Point your browser to %s for SAWs\n",sawsurl);CHKERRQ(ierr); 627ffbd1cfbSBarry Smith } 6287d812c46SBarry Smith } else { 6297d812c46SBarry Smith PetscStackCallSAWs(SAWs_Initialize,()); 630aa573868SBarry Smith } 6310af79b04SBarry Smith ierr = PetscCitationsRegister("@TechReport{ saws,\n" 6320af79b04SBarry Smith " Author = {Matt Otten and Jed Brown and Barry Smith},\n" 6330af79b04SBarry Smith " Title = {Scientific Application Web Server (SAWs) Users Manual},\n" 6340af79b04SBarry Smith " Institution = {Argonne National Laboratory},\n" 6350af79b04SBarry Smith " Year = 2013\n}\n",NULL);CHKERRQ(ierr); 63611525c0dSBarry Smith } 63711525c0dSBarry Smith PetscFunctionReturn(0); 63811525c0dSBarry Smith } 63911525c0dSBarry Smith #endif 64011525c0dSBarry Smith 6414dfee713SSatish Balay /* Things must be done before MPI_Init() when MPI is not yet initialized, and can be shared between C init and Fortran init */ 6424dfee713SSatish Balay PETSC_INTERN PetscErrorCode PetscPreMPIInit_Private(void) 6434dfee713SSatish Balay { 6444dfee713SSatish Balay PetscFunctionBegin; 6454dfee713SSatish Balay #if defined(PETSC_HAVE_HWLOC_SOLARIS_BUG) 6464dfee713SSatish Balay /* see MPI.py for details on this bug */ 6474dfee713SSatish Balay (void) setenv("HWLOC_COMPONENTS","-x86",1); 6484dfee713SSatish Balay #endif 6494dfee713SSatish Balay PetscFunctionReturn(0); 6504dfee713SSatish Balay } 6514dfee713SSatish Balay 652a56f64adSBarry Smith #if defined(PETSC_HAVE_ADIOS) 653a56f64adSBarry Smith #include <adios.h> 65422580e64SBarry Smith #include <adios_read.h> 6557b56e58cSSatish Balay int64_t Petsc_adios_group; 656a56f64adSBarry Smith #endif 65755d657eeSBarry Smith #if defined(PETSC_HAVE_ADIOS2) 65855d657eeSBarry Smith #include <adios2_c.h> 65955d657eeSBarry Smith #endif 660cd1b99a6SBarry Smith #if defined(PETSC_HAVE_OPENMP) 661cd1b99a6SBarry Smith #include <omp.h> 662f90b075cSBarry Smith PetscInt PetscNumOMPThreads; 663cd1b99a6SBarry Smith #endif 664a56f64adSBarry Smith 665bc8a24ecSBarry Smith #if defined(PETSC_HAVE_DLFCN_H) 666bc8a24ecSBarry Smith #include <dlfcn.h> 667bc8a24ecSBarry Smith #endif 668bc8a24ecSBarry Smith 669e5c89e4eSSatish Balay /*@C 670e5c89e4eSSatish Balay PetscInitialize - Initializes the PETSc database and MPI. 671e5c89e4eSSatish Balay PetscInitialize() calls MPI_Init() if that has yet to be called, 672e5c89e4eSSatish Balay so this routine should always be called near the beginning of 673e5c89e4eSSatish Balay your program -- usually the very first line! 674e5c89e4eSSatish Balay 675e5c89e4eSSatish Balay Collective on MPI_COMM_WORLD or PETSC_COMM_WORLD if it has been set 676e5c89e4eSSatish Balay 677e5c89e4eSSatish Balay Input Parameters: 678e5c89e4eSSatish Balay + argc - count of number of command line arguments 679e5c89e4eSSatish Balay . args - the command line arguments 680be10d61cSLisandro Dalcin . file - [optional] PETSc database file, append ":yaml" to filename to specify YAML options format. 681be10d61cSLisandro Dalcin Use NULL or empty string to not check for code specific file. 682be10d61cSLisandro Dalcin Also checks ~/.petscrc, .petscrc and petscrc. 683c5b5d8d5SVaclav Hapla Use -skip_petscrc in the code specific file (or command line) to skip ~/.petscrc, .petscrc and petscrc files. 6840298fd71SBarry Smith - help - [optional] Help message to print, use NULL for no message 685e5c89e4eSSatish Balay 68605827820SBarry Smith If you wish PETSc code to run ONLY on a subcommunicator of MPI_COMM_WORLD, create that 68705827820SBarry Smith communicator first and assign it to PETSC_COMM_WORLD BEFORE calling PetscInitialize(). Thus if you are running a 68805827820SBarry Smith four process job and two processes will run PETSc and have PetscInitialize() and PetscFinalize() and two process will not, 68905827820SBarry Smith then do this. If ALL processes in the job are using PetscInitialize() and PetscFinalize() then you don't need to do this, even 69005827820SBarry Smith if different subcommunicators of the job are doing different things with PETSc. 691e5c89e4eSSatish Balay 692e5c89e4eSSatish Balay Options Database Keys: 6937ca660e7SBarry Smith + -help [intro] - prints help method for each option; if intro is given the program stops after printing the introductory help message 6947ca660e7SBarry Smith . -start_in_debugger [noxterm,dbx,xdb,gdb,...] - Starts program in debugger 695e5c89e4eSSatish Balay . -on_error_attach_debugger [noxterm,dbx,xdb,gdb,...] - Starts debugger when error detected 6968a690491SBarry Smith . -on_error_emacs <machinename> - causes emacsclient to jump to error file 6978a690491SBarry Smith . -on_error_abort - calls abort() when error detected (no traceback) 6988a690491SBarry Smith . -on_error_mpiabort - calls MPI_abort() when error detected 6998a690491SBarry Smith . -error_output_stderr - prints error messages to stderr instead of the default stdout 7008a690491SBarry Smith . -error_output_none - does not print the error messages (but handles errors in the same way as if this was not called) 701bf4d2887SBarry Smith . -debugger_ranks [rank1,rank2,...] - Indicates ranks to start in debugger 702e5c89e4eSSatish Balay . -debugger_pause [sleeptime] (in seconds) - Pauses debugger 703e5c89e4eSSatish Balay . -stop_for_debugger - Print message on how to attach debugger manually to 704e5c89e4eSSatish Balay process and wait (-debugger_pause) seconds for attachment 70579dccf82SBarry Smith . -malloc - Indicates use of PETSc error-checking malloc (on by default for debug version of libraries) (deprecated, use -malloc_debug) 70679dccf82SBarry Smith . -malloc no - Indicates not to use error-checking malloc (deprecated, use -malloc_debug no) 70779dccf82SBarry Smith . -malloc_debug - check for memory corruption at EVERY malloc or free, see PetscMallocSetDebug() 708aee23540SBarry Smith . -malloc_dump - prints a list of all unfreed memory at the end of the run 70992f119d6SBarry 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 71092f119d6SBarry Smith . -malloc_view - show a list of all allocated memory during PetscFinalize() 71192f119d6SBarry Smith . -malloc_view_threshold <t> - only list memory allocations of size greater than t with -malloc_view 712608c71bfSMatthew G. Knepley . -malloc_requested_size - malloc logging will record the requested size rather than size after alignment 71392f119d6SBarry Smith . -fp_trap - Stops on floating point exceptions 714e5c89e4eSSatish Balay . -no_signal_handler - Indicates not to trap error signals 715e5c89e4eSSatish Balay . -shared_tmp - indicates /tmp directory is shared by all processors 716e5c89e4eSSatish Balay . -not_shared_tmp - each processor has own /tmp 717e5c89e4eSSatish Balay . -tmp - alternative name of /tmp directory 718e5c89e4eSSatish Balay . -get_total_flops - returns total flops done by all processors 7190841954dSBarry Smith - -memory_view - Print memory usage at end of run 720e5c89e4eSSatish Balay 721c5b5d8d5SVaclav Hapla Options Database Keys for Option Database: 722c5b5d8d5SVaclav Hapla + -skip_petscrc - skip the default option files ~/.petscrc, .petscrc, petscrc 723c5b5d8d5SVaclav Hapla . -options_monitor - monitor all set options to standard output for the whole program run 724c5b5d8d5SVaclav Hapla - -options_monitor_cancel - cancel options monitoring hard-wired using PetscOptionsMonitorSet() 725c5b5d8d5SVaclav Hapla 726c5b5d8d5SVaclav Hapla Options -options_monitor_{all,cancel} are 727c5b5d8d5SVaclav Hapla position-independent and apply to all options set since the PETSc start. 728c5b5d8d5SVaclav Hapla They can be used also in option files. 729c5b5d8d5SVaclav Hapla 730c5b5d8d5SVaclav Hapla See PetscOptionsMonitorSet() to do monitoring programmatically. 731c5b5d8d5SVaclav Hapla 732e5c89e4eSSatish Balay Options Database Keys for Profiling: 733a7f22e61SSatish Balay See Users-Manual: ch_profiling for details. 734fe9b927eSVaclav Hapla + -info [filename][:[~]<list,of,classnames>[:[~]self]] - Prints verbose information. See PetscInfo(). 735217044c2SLisandro Dalcin . -log_sync - Enable barrier synchronization for all events. This option is useful to debug imbalance within each event, 736217044c2SLisandro Dalcin however it slows things down and gives a distorted view of the overall runtime. 737495fc317SBarry Smith . -log_trace [filename] - Print traces of all PETSc calls to the screen (useful to determine where a program 738e5c89e4eSSatish Balay hangs without running in the debugger). See PetscLogTraceBegin(). 7399a9a5d4cSBarry Smith . -log_view [:filename:format] - Prints summary of flop and timing information to screen or file, see PetscLogView(). 74079dccf82SBarry Smith . -log_view_memory - Includes in the summary from -log_view the memory used in each method, see PetscLogView(). 7419a9a5d4cSBarry Smith . -log_summary [filename] - (Deprecated, use -log_view) Prints summary of flop and timing information to screen. If the filename is specified the 742495fc317SBarry Smith summary is written to the file. See PetscLogView(). 743f5d6ab90SLisandro Dalcin . -log_exclude: <vec,mat,pc,ksp,snes> - excludes subset of object classes from logging 744495fc317SBarry Smith . -log_all [filename] - Logs extensive profiling information See PetscLogDump(). 745495fc317SBarry Smith . -log [filename] - Logs basic profiline information See PetscLogDump(). 746c2f74817SBarry Smith . -log_mpe [filename] - Creates a logfile viewable by the utility Jumpshot (in MPICH distribution) 74787c3beb6SLisandro Dalcin . -viewfromoptions on,off - Enable or disable XXXSetFromOptions() calls, for applications with many small solves turn this off 748c2f74817SBarry Smith - -check_pointer_intensity 0,1,2 - if pointers are checked for validity (debug version only), using 0 will result in faster code 749495fc317SBarry Smith 750609bdbeeSBarry Smith Only one of -log_trace, -log_view, -log_view, -log_all, -log, or -log_mpe may be used at a time 751e5c89e4eSSatish Balay 752ffbd1cfbSBarry Smith Options Database Keys for SAWs: 753ffbd1cfbSBarry Smith + -saws_port <portnumber> - port number to publish SAWs data, default is 8080 754ffbd1cfbSBarry 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 755ffbd1cfbSBarry Smith this is useful when you are running many jobs that utilize SAWs at the same time 756ffbd1cfbSBarry Smith . -saws_log <filename> - save a log of all SAWs communication 757ffbd1cfbSBarry Smith . -saws_https <certificate file> - have SAWs use HTTPS instead of HTTP 758ffbd1cfbSBarry Smith - -saws_root <directory> - allow SAWs to have access to the given directory to search for requested resources and files 759ffbd1cfbSBarry Smith 760e5c89e4eSSatish Balay Environmental Variables: 761e5c89e4eSSatish Balay + PETSC_TMP - alternative tmp directory 762e5c89e4eSSatish Balay . PETSC_SHARED_TMP - tmp is shared by all processes 763e5c89e4eSSatish Balay . PETSC_NOT_SHARED_TMP - each process has its own private tmp 7644a971ea4SToby Isaac . PETSC_OPTIONS - a string containing additional options for petsc in the form of command line "-key value" pairs 7654a971ea4SToby Isaac . PETSC_OPTIONS_YAML - (requires configuring PETSc to use libyaml) a string containing additional options for petsc in the form of a YAML document 766e5c89e4eSSatish Balay . PETSC_VIEWER_SOCKET_PORT - socket number to use for socket viewer 767e5c89e4eSSatish Balay - PETSC_VIEWER_SOCKET_MACHINE - machine to use for socket viewer to connect to 768e5c89e4eSSatish Balay 769e5c89e4eSSatish Balay 770e5c89e4eSSatish Balay Level: beginner 771e5c89e4eSSatish Balay 772e5c89e4eSSatish Balay Notes: 773e5c89e4eSSatish Balay If for some reason you must call MPI_Init() separately, call 774e5c89e4eSSatish Balay it before PetscInitialize(). 775e5c89e4eSSatish Balay 776e5c89e4eSSatish Balay Fortran Version: 777e5c89e4eSSatish Balay In Fortran this routine has the format 778e5c89e4eSSatish Balay $ call PetscInitialize(file,ierr) 779e5c89e4eSSatish Balay 780e5c89e4eSSatish Balay + ierr - error return code 781c5b5d8d5SVaclav Hapla - file - [optional] PETSc database file, also checks ~/.petscrc, .petscrc and petscrc. 782c5b5d8d5SVaclav Hapla Use PETSC_NULL_CHARACTER to not check for code specific file. 783c5b5d8d5SVaclav Hapla Use -skip_petscrc in the code specific file (or command line) to skip ~/.petscrc, .petscrc and petscrc files. 784e5c89e4eSSatish Balay 785e5c89e4eSSatish Balay Important Fortran Note: 7860eb4c9c0SBarry Smith In Fortran, you MUST use PETSC_NULL_CHARACTER to indicate a 7870298fd71SBarry Smith null character string; you CANNOT just use NULL as 788a7f22e61SSatish Balay in the C version. See Users-Manual: ch_fortran for details. 789e5c89e4eSSatish Balay 79001cb0274SBarry Smith If your main program is C but you call Fortran code that also uses PETSc you need to call PetscInitializeFortran() soon after 79101cb0274SBarry Smith calling PetscInitialize(). 792e5c89e4eSSatish Balay 79301cb0274SBarry Smith .seealso: PetscFinalize(), PetscInitializeFortran(), PetscGetArgs(), PetscInitializeNoArguments() 794e5c89e4eSSatish Balay 795e5c89e4eSSatish Balay @*/ 7967087cfbeSBarry Smith PetscErrorCode PetscInitialize(int *argc,char ***args,const char file[],const char help[]) 797e5c89e4eSSatish Balay { 798e5c89e4eSSatish Balay PetscErrorCode ierr; 7994bb5149bSJed Brown PetscMPIInt flag, size; 80019c5658aSBarry Smith PetscBool flg = PETSC_TRUE; 801e5c89e4eSSatish Balay char hostname[256]; 802e5c89e4eSSatish Balay 803e5c89e4eSSatish Balay PetscFunctionBegin; 804e5c89e4eSSatish Balay if (PetscInitializeCalled) PetscFunctionReturn(0); 8053d96e996SBarry Smith /* 8063d96e996SBarry Smith The checking over compatible runtime libraries is complicated by the MPI ABI initiative 8073d96e996SBarry Smith https://wiki.mpich.org/mpich/index.php/ABI_Compatibility_Initiative which started with 8083d96e996SBarry Smith MPICH v3.1 (Released Feburary 2014) 8093d96e996SBarry Smith IBM MPI v2.1 (December 2014) 810110fc3b0SBarry Smith Intel MPI Library v5.0 (2014) 8113d96e996SBarry Smith Cray MPT v7.0.0 (June 2014) 8123d96e996SBarry Smith As of July 31, 2017 the ABI number still appears to be 12, that is all of the versions 8133d96e996SBarry Smith listed above and since that time are compatible. 8143d96e996SBarry Smith 8153d96e996SBarry Smith Unfortunately the MPI ABI initiative has not defined a way to determine the ABI number 8163d96e996SBarry Smith at compile time or runtime. Thus we will need to systematically track the allowed versions 8173d96e996SBarry Smith and how they are represented in the mpi.h and MPI_Get_library_version() output in order 8183d96e996SBarry Smith to perform the checking. 8193d96e996SBarry Smith 8203d96e996SBarry Smith Currently we only check for pre MPI ABI versions (and packages that do not follow the MPI ABI). 8213d96e996SBarry Smith 8223d96e996SBarry Smith Questions: 8233d96e996SBarry Smith 8243d96e996SBarry Smith Should the checks for ABI incompatibility be only on the major version number below? 8253d96e996SBarry Smith Presumably the output to stderr will be removed before a release. 8263d96e996SBarry Smith */ 8273d96e996SBarry Smith 82819c5658aSBarry Smith #if defined(PETSC_HAVE_MPI_GET_LIBRARY_VERSION) 82919c5658aSBarry Smith { 83019c5658aSBarry Smith char mpilibraryversion[MPI_MAX_LIBRARY_VERSION_STRING]; 83119c5658aSBarry Smith PetscMPIInt mpilibraryversionlength; 83219c5658aSBarry Smith ierr = MPI_Get_library_version(mpilibraryversion,&mpilibraryversionlength);if (ierr) return ierr; 8333d96e996SBarry Smith /* check for MPICH versions before MPI ABI initiative */ 83419c5658aSBarry Smith #if defined(MPICH_VERSION) 8353d96e996SBarry Smith #if MPICH_NUMVERSION < 30100000 83619c5658aSBarry Smith { 83719c5658aSBarry Smith char *ver,*lf; 83819c5658aSBarry Smith flg = PETSC_FALSE; 83919c5658aSBarry Smith ierr = PetscStrstr(mpilibraryversion,"MPICH Version:",&ver);if (ierr) return ierr; 84019c5658aSBarry Smith if (ver) { 84119c5658aSBarry Smith ierr = PetscStrchr(ver,'\n',&lf);if (ierr) return ierr; 84219c5658aSBarry Smith if (lf) { 84319c5658aSBarry Smith *lf = 0; 84419c5658aSBarry Smith ierr = PetscStrendswith(ver,MPICH_VERSION,&flg);if (ierr) return ierr; 84519c5658aSBarry Smith } 84619c5658aSBarry Smith } 84719c5658aSBarry Smith if (!flg) { 84819c5658aSBarry Smith fprintf(stderr,"PETSc Error --- MPICH library version \n%s does not match what PETSc was compiled with %s, aborting\n",mpilibraryversion,MPICH_VERSION); 8493d96e996SBarry Smith return PETSC_ERR_MPI_LIB_INCOMP; 85019c5658aSBarry Smith } 85119c5658aSBarry Smith } 8523d96e996SBarry Smith #endif 8533d96e996SBarry Smith /* check for OpenMPI version, it is not part of the MPI ABI initiative (is it part of another initiative that needs to be handled?) */ 85419c5658aSBarry Smith #elif defined(OMPI_MAJOR_VERSION) 85519c5658aSBarry Smith { 85616dc8964SSatish Balay char *ver,bs[MPI_MAX_LIBRARY_VERSION_STRING],*bsf; 85719c5658aSBarry Smith flg = PETSC_FALSE; 85816dc8964SSatish Balay #define PSTRSZ 2 85916dc8964SSatish Balay char ompistr1[PSTRSZ][MPI_MAX_LIBRARY_VERSION_STRING] = {"Open MPI","FUJITSU MPI"}; 86016dc8964SSatish Balay char ompistr2[PSTRSZ][MPI_MAX_LIBRARY_VERSION_STRING] = {"v","Library "}; 86116dc8964SSatish Balay int i; 86216dc8964SSatish Balay for (i=0; i<PSTRSZ; i++) { 86316dc8964SSatish Balay ierr = PetscStrstr(mpilibraryversion,ompistr1[i],&ver);if (ierr) return ierr; 86419c5658aSBarry Smith if (ver) { 86516dc8964SSatish Balay PetscSNPrintf(bs,MPI_MAX_LIBRARY_VERSION_STRING,"%s%d.%d",ompistr2[i],OMPI_MAJOR_VERSION,OMPI_MINOR_VERSION); 86619c5658aSBarry Smith ierr = PetscStrstr(ver,bs,&bsf);if (ierr) return ierr; 86719c5658aSBarry Smith if (bsf) flg = PETSC_TRUE; 86816dc8964SSatish Balay break; 86916dc8964SSatish Balay } 87019c5658aSBarry Smith } 87119c5658aSBarry Smith if (!flg) { 87219c5658aSBarry Smith fprintf(stderr,"PETSc Error --- Open MPI library version \n%s does not match what PETSc was compiled with %d.%d, aborting\n",mpilibraryversion,OMPI_MAJOR_VERSION,OMPI_MINOR_VERSION); 8733d96e996SBarry Smith return PETSC_ERR_MPI_LIB_INCOMP; 87419c5658aSBarry Smith } 87519c5658aSBarry Smith } 87619c5658aSBarry Smith #endif 87719c5658aSBarry Smith } 87819c5658aSBarry Smith #endif 87919c5658aSBarry Smith 880bc8a24ecSBarry Smith #if defined(PETSC_HAVE_DLSYM) 881bc8a24ecSBarry Smith { 882bc8a24ecSBarry Smith PetscInt cnt = 0; 883bc8a24ecSBarry Smith /* 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 */ 884bc8a24ecSBarry Smith if (dlsym(RTLD_DEFAULT,"ompi_mpi_init")) cnt++; 885bc8a24ecSBarry Smith if (dlsym(RTLD_DEFAULT,"MPL_exit")) cnt++; 886bc8a24ecSBarry Smith if (cnt > 1) { 887bc8a24ecSBarry Smith fprintf(stderr,"PETSc Error --- Application was linked against both OpenMPI and MPICH based MPI libraries and will not run correctly\n"); 888bc8a24ecSBarry Smith return PETSC_ERR_MPI_LIB_INCOMP; 889bc8a24ecSBarry Smith } 890bc8a24ecSBarry Smith } 891bc8a24ecSBarry Smith #endif 892bc8a24ecSBarry Smith 893ae9b4142SLisandro Dalcin /* these must be initialized in a routine, not as a constant declaration*/ 894d89683f4Sbcordonn PETSC_STDOUT = stdout; 895ae9b4142SLisandro Dalcin PETSC_STDERR = stderr; 896e5c89e4eSSatish Balay 8978ad20175SVaclav Hapla /*CHKERRQ can be used from now */ 8988ad20175SVaclav Hapla PetscErrorHandlingInitialized = PETSC_TRUE; 8998ad20175SVaclav Hapla 9000c30907bSSatish Balay /* on Windows - set printf to default to printing 2 digit exponents */ 9010c30907bSSatish Balay #if defined(PETSC_HAVE__SET_OUTPUT_FORMAT) 9020c30907bSSatish Balay _set_output_format(_TWO_DIGIT_EXPONENT); 9030c30907bSSatish Balay #endif 9040c30907bSSatish Balay 9054416b707SBarry Smith ierr = PetscOptionsCreateDefault();CHKERRQ(ierr); 906e5c89e4eSSatish Balay 907e5c89e4eSSatish Balay /* 908e5c89e4eSSatish Balay We initialize the program name here (before MPI_Init()) because MPICH has a bug in 909e5c89e4eSSatish Balay it that it sets args[0] on all processors to be args[0] on the first processor. 910e5c89e4eSSatish Balay */ 911e5c89e4eSSatish Balay if (argc && *argc) { 912e5c89e4eSSatish Balay ierr = PetscSetProgramName(**args);CHKERRQ(ierr); 913e5c89e4eSSatish Balay } else { 914e5c89e4eSSatish Balay ierr = PetscSetProgramName("Unknown Name");CHKERRQ(ierr); 915e5c89e4eSSatish Balay } 916e5c89e4eSSatish Balay 917ffc4695bSBarry Smith ierr = MPI_Initialized(&flag);CHKERRMPI(ierr); 918e5c89e4eSSatish Balay if (!flag) { 919e32f2f54SBarry Smith if (PETSC_COMM_WORLD != MPI_COMM_NULL) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SUP,"You cannot set PETSC_COMM_WORLD if you have not initialized MPI first"); 9204dfee713SSatish Balay ierr = PetscPreMPIInit_Private();CHKERRQ(ierr); 9215e765c61SJed Brown #if defined(PETSC_HAVE_MPI_INIT_THREAD) 9225e765c61SJed Brown { 9235e765c61SJed Brown PetscMPIInt provided; 924ffc4695bSBarry Smith ierr = MPI_Init_thread(argc,args,PETSC_MPI_THREAD_REQUIRED,&provided);CHKERRMPI(ierr); 9255e765c61SJed Brown } 9265e765c61SJed Brown #else 927ffc4695bSBarry Smith ierr = MPI_Init(argc,args);CHKERRMPI(ierr); 9285e765c61SJed Brown #endif 929e5c89e4eSSatish Balay PetscBeganMPI = PETSC_TRUE; 930e5c89e4eSSatish Balay } 9314dfee713SSatish Balay 932e5c89e4eSSatish Balay if (argc && args) { 933e5c89e4eSSatish Balay PetscGlobalArgc = *argc; 934e5c89e4eSSatish Balay PetscGlobalArgs = *args; 935e5c89e4eSSatish Balay } 936e5c89e4eSSatish Balay PetscFinalizeCalled = PETSC_FALSE; 9375ad9ad5bSBarry Smith ierr = PetscSpinlockCreate(&PetscViewerASCIISpinLockOpen);CHKERRQ(ierr); 9385ad9ad5bSBarry Smith ierr = PetscSpinlockCreate(&PetscViewerASCIISpinLockStdout);CHKERRQ(ierr); 9395ad9ad5bSBarry Smith ierr = PetscSpinlockCreate(&PetscViewerASCIISpinLockStderr);CHKERRQ(ierr); 940ef19f930SBarry Smith ierr = PetscSpinlockCreate(&PetscCommSpinLock);CHKERRQ(ierr); 941e5c89e4eSSatish Balay 942a297a907SKarl Rupp if (PETSC_COMM_WORLD == MPI_COMM_NULL) PETSC_COMM_WORLD = MPI_COMM_WORLD; 943ffc4695bSBarry Smith ierr = MPI_Comm_set_errhandler(PETSC_COMM_WORLD,MPI_ERRORS_RETURN);CHKERRMPI(ierr); 944e5c89e4eSSatish Balay 9450f9be574SPeter Hill if (PETSC_MPI_ERROR_CLASS == MPI_ERR_LASTCODE) { 946ffc4695bSBarry Smith ierr = MPI_Add_error_class(&PETSC_MPI_ERROR_CLASS);CHKERRMPI(ierr); 947ffc4695bSBarry Smith ierr = MPI_Add_error_code(PETSC_MPI_ERROR_CLASS,&PETSC_MPI_ERROR_CODE);CHKERRMPI(ierr); 9480f9be574SPeter Hill } 94912801b39SBarry Smith 950e5c89e4eSSatish Balay /* Done after init due to a bug in MPICH-GM? */ 951e5c89e4eSSatish Balay ierr = PetscErrorPrintfInitialize();CHKERRQ(ierr); 952e5c89e4eSSatish Balay 953ffc4695bSBarry Smith ierr = MPI_Comm_rank(MPI_COMM_WORLD,&PetscGlobalRank);CHKERRMPI(ierr); 954ffc4695bSBarry Smith ierr = MPI_Comm_size(MPI_COMM_WORLD,&PetscGlobalSize);CHKERRMPI(ierr); 955e5c89e4eSSatish Balay 9568ad47952SJed Brown MPIU_BOOL = MPI_INT; 9578ad47952SJed Brown MPIU_ENUM = MPI_INT; 9587cdaf61dSJed Brown MPIU_FORTRANADDR = (sizeof(void*) == sizeof(int)) ? MPI_INT : MPIU_INT64; 959e316c87fSJed Brown if (sizeof(size_t) == sizeof(unsigned)) MPIU_SIZE_T = MPI_UNSIGNED; 960e316c87fSJed Brown else if (sizeof(size_t) == sizeof(unsigned long)) MPIU_SIZE_T = MPI_UNSIGNED_LONG; 961e316c87fSJed Brown #if defined(PETSC_SIZEOF_LONG_LONG) 962e316c87fSJed Brown else if (sizeof(size_t) == sizeof(unsigned long long)) MPIU_SIZE_T = MPI_UNSIGNED_LONG_LONG; 963e316c87fSJed Brown #endif 964e316c87fSJed Brown else {(*PetscErrorPrintf)("PetscInitialize: Could not find MPI type for size_t\n"); return PETSC_ERR_SUP_SYS;} 9658ad47952SJed Brown 966e5c89e4eSSatish Balay /* 967e5c89e4eSSatish Balay Initialized the global complex variable; this is because with 968e5c89e4eSSatish Balay shared libraries the constructors for global variables 969e5c89e4eSSatish Balay are not called; at least on IRIX. 970e5c89e4eSSatish Balay */ 971886cfec0SSatish Balay #if defined(PETSC_HAVE_COMPLEX) 972e5c89e4eSSatish Balay { 9737a19d461SSatish Balay #if defined(PETSC_CLANGUAGE_CXX) 97450f81f78SJed Brown PetscComplex ic(0.0,1.0); 975e5c89e4eSSatish Balay PETSC_i = ic; 976252ecd31SSatish Balay #else 97750f81f78SJed Brown PETSC_i = _Complex_I; 978b7940d39SSatish Balay #endif 979762437b8SSatish Balay } 980886cfec0SSatish Balay #endif /* PETSC_HAVE_COMPLEX */ 981e5c89e4eSSatish Balay 982e5c89e4eSSatish Balay /* 983e5c89e4eSSatish Balay Create the PETSc MPI reduction operator that sums of the first 984e5c89e4eSSatish Balay half of the entries and maxes the second half. 985e5c89e4eSSatish Balay */ 986ffc4695bSBarry Smith ierr = MPI_Op_create(MPIU_MaxSum_Local,1,&MPIU_MAXSUM_OP);CHKERRMPI(ierr); 987e5c89e4eSSatish Balay 988ce63c4c1SBarry Smith #if defined(PETSC_USE_REAL___FLOAT128) 989ffc4695bSBarry Smith ierr = MPI_Type_contiguous(2,MPI_DOUBLE,&MPIU___FLOAT128);CHKERRMPI(ierr); 990ffc4695bSBarry Smith ierr = MPI_Type_commit(&MPIU___FLOAT128);CHKERRMPI(ierr); 9917c2de775SJed Brown #if defined(PETSC_HAVE_COMPLEX) 992ffc4695bSBarry Smith ierr = MPI_Type_contiguous(4,MPI_DOUBLE,&MPIU___COMPLEX128);CHKERRMPI(ierr); 993ffc4695bSBarry Smith ierr = MPI_Type_commit(&MPIU___COMPLEX128);CHKERRMPI(ierr); 9948c764dc5SJose Roman #endif 995ffc4695bSBarry Smith ierr = MPI_Op_create(PetscMax_Local,1,&MPIU_MAX);CHKERRMPI(ierr); 996ffc4695bSBarry Smith ierr = MPI_Op_create(PetscMin_Local,1,&MPIU_MIN);CHKERRMPI(ierr); 997570b7f6dSBarry Smith #elif defined(PETSC_USE_REAL___FP16) 998ffc4695bSBarry Smith ierr = MPI_Type_contiguous(2,MPI_CHAR,&MPIU___FP16);CHKERRMPI(ierr); 999ffc4695bSBarry Smith ierr = MPI_Type_commit(&MPIU___FP16);CHKERRMPI(ierr); 1000ffc4695bSBarry Smith ierr = MPI_Op_create(PetscMax_Local,1,&MPIU_MAX);CHKERRMPI(ierr); 1001ffc4695bSBarry Smith ierr = MPI_Op_create(PetscMin_Local,1,&MPIU_MIN);CHKERRMPI(ierr); 1002c90a1750SBarry Smith #endif 1003c90a1750SBarry Smith 1004de272c7aSSatish Balay #if defined(PETSC_USE_REAL___FLOAT128) || defined(PETSC_USE_REAL___FP16) 1005ffc4695bSBarry Smith ierr = MPI_Op_create(PetscSum_Local,1,&MPIU_SUM);CHKERRMPI(ierr); 1006cca4cb22SSatish Balay #endif 1007cca4cb22SSatish Balay 1008ffc4695bSBarry Smith ierr = MPI_Type_contiguous(2,MPIU_SCALAR,&MPIU_2SCALAR);CHKERRMPI(ierr); 1009ffc4695bSBarry Smith ierr = MPI_Type_commit(&MPIU_2SCALAR);CHKERRMPI(ierr); 1010e5c89e4eSSatish Balay 101140df0d72SSatish Balay #if defined(PETSC_USE_64BIT_INDICES) 1012ffc4695bSBarry Smith ierr = MPI_Type_contiguous(2,MPIU_INT,&MPIU_2INT);CHKERRMPI(ierr); 1013ffc4695bSBarry Smith ierr = MPI_Type_commit(&MPIU_2INT);CHKERRMPI(ierr); 101444041f26SJed Brown #endif 1015e5c89e4eSSatish Balay 1016e5c89e4eSSatish Balay /* 1017480cf27aSJed Brown Attributes to be set on PETSc communicators 1018480cf27aSJed Brown */ 1019ffc4695bSBarry Smith ierr = MPI_Comm_create_keyval(MPI_COMM_NULL_COPY_FN,Petsc_Counter_Attr_Delete_Fn,&Petsc_Counter_keyval,(void*)0);CHKERRMPI(ierr); 1020ffc4695bSBarry Smith ierr = MPI_Comm_create_keyval(MPI_COMM_NULL_COPY_FN,Petsc_InnerComm_Attr_Delete_Fn,&Petsc_InnerComm_keyval,(void*)0);CHKERRMPI(ierr); 1021ffc4695bSBarry Smith ierr = MPI_Comm_create_keyval(MPI_COMM_NULL_COPY_FN,Petsc_OuterComm_Attr_Delete_Fn,&Petsc_OuterComm_keyval,(void*)0);CHKERRMPI(ierr); 1022ffc4695bSBarry Smith ierr = MPI_Comm_create_keyval(MPI_COMM_NULL_COPY_FN,Petsc_ShmComm_Attr_Delete_Fn,&Petsc_ShmComm_keyval,(void*)0);CHKERRMPI(ierr); 1023480cf27aSJed Brown 1024480cf27aSJed Brown /* 1025e8fb0fc0SBarry Smith Build the options database 1026e5c89e4eSSatish Balay */ 1027c5929fdfSBarry Smith ierr = PetscOptionsInsert(NULL,argc,args,file);CHKERRQ(ierr); 1028e5c89e4eSSatish Balay 1029703f3eceSBarry Smith /* call a second time so it can look in the options database */ 1030703f3eceSBarry Smith ierr = PetscErrorPrintfInitialize();CHKERRQ(ierr); 10316dc8fec2Sbcordonn 1032e5c89e4eSSatish Balay /* 103357171095SVaclav Hapla Check system options and print help 1034e5c89e4eSSatish Balay */ 103557171095SVaclav Hapla ierr = PetscOptionsCheckInitial_Private(help);CHKERRQ(ierr); 1036e5c89e4eSSatish Balay 1037d45a07a7SBarry Smith ierr = PetscCitationsInitialize();CHKERRQ(ierr); 1038d45a07a7SBarry Smith 1039e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS) 104011525c0dSBarry Smith ierr = PetscInitializeSAWs(help);CHKERRQ(ierr); 1041f4202a44SBarry Smith #endif 1042f4202a44SBarry Smith 1043e5c89e4eSSatish Balay /* 1044e5c89e4eSSatish Balay Load the dynamic libraries (on machines that support them), this registers all 1045e5c89e4eSSatish Balay the solvers etc. (On non-dynamic machines this initializes the PetscDraw and PetscViewer classes) 1046e5c89e4eSSatish Balay */ 1047e5c89e4eSSatish Balay ierr = PetscInitialize_DynamicLibraries();CHKERRQ(ierr); 1048e5c89e4eSSatish Balay 1049ffc4695bSBarry Smith ierr = MPI_Comm_size(PETSC_COMM_WORLD,&size);CHKERRMPI(ierr); 105002c9f0b5SLisandro Dalcin ierr = PetscInfo1(NULL,"PETSc successfully started: number of processors = %d\n",size);CHKERRQ(ierr); 1051e5c89e4eSSatish Balay ierr = PetscGetHostName(hostname,256);CHKERRQ(ierr); 105202c9f0b5SLisandro Dalcin ierr = PetscInfo1(NULL,"Running on machine: %s\n",hostname);CHKERRQ(ierr); 1053cd1b99a6SBarry Smith #if defined(PETSC_HAVE_OPENMP) 1054101491d0SBarry Smith { 1055101491d0SBarry Smith PetscBool omp_view_flag; 1056cd1b99a6SBarry Smith char *threads = getenv("OMP_NUM_THREADS"); 1057e5c89e4eSSatish Balay 1058cd1b99a6SBarry Smith if (threads) { 105902c9f0b5SLisandro Dalcin ierr = PetscInfo1(NULL,"Number of OpenMP threads %s (given by OMP_NUM_THREADS)\n",threads);CHKERRQ(ierr); 1060f90b075cSBarry Smith (void) sscanf(threads, "%" PetscInt_FMT,&PetscNumOMPThreads); 1061cd1b99a6SBarry Smith } else { 1062cd1b99a6SBarry Smith #define NMAX 10000 1063101491d0SBarry Smith int i; 1064cd1b99a6SBarry Smith PetscScalar *x; 1065cd1b99a6SBarry Smith ierr = PetscMalloc1(NMAX,&x);CHKERRQ(ierr); 1066cd1b99a6SBarry Smith #pragma omp parallel for 1067cd1b99a6SBarry Smith for (i=0; i<NMAX; i++) { 1068cd1b99a6SBarry Smith x[i] = 0.0; 1069f90b075cSBarry Smith PetscNumOMPThreads = (PetscInt) omp_get_num_threads(); 1070cd1b99a6SBarry Smith } 1071cd1b99a6SBarry Smith ierr = PetscFree(x);CHKERRQ(ierr); 107202c9f0b5SLisandro Dalcin ierr = PetscInfo1(NULL,"Number of OpenMP threads %D (number not set with OMP_NUM_THREADS, chosen by system)\n",PetscNumOMPThreads);CHKERRQ(ierr); 1073101491d0SBarry Smith } 1074101491d0SBarry Smith ierr = PetscOptionsBegin(PETSC_COMM_WORLD,NULL,"OpenMP options","Sys");CHKERRQ(ierr); 1075f90b075cSBarry Smith ierr = PetscOptionsInt("-omp_num_threads","Number of OpenMP threads to use (can also use environmental variable OMP_NUM_THREADS","None",PetscNumOMPThreads,&PetscNumOMPThreads,&flg);CHKERRQ(ierr); 1076101491d0SBarry Smith ierr = PetscOptionsName("-omp_view","Display OpenMP number of threads",NULL,&omp_view_flag);CHKERRQ(ierr); 1077101491d0SBarry Smith ierr = PetscOptionsEnd();CHKERRQ(ierr); 1078101491d0SBarry Smith if (flg) { 107902c9f0b5SLisandro Dalcin ierr = PetscInfo1(NULL,"Number of OpenMP theads %D (given by -omp_num_threads)\n",PetscNumOMPThreads);CHKERRQ(ierr); 1080f90b075cSBarry Smith omp_set_num_threads((int)PetscNumOMPThreads); 1081101491d0SBarry Smith } 1082101491d0SBarry Smith if (omp_view_flag) { 1083f90b075cSBarry Smith ierr = PetscPrintf(PETSC_COMM_WORLD,"OpenMP: number of threads %D\n",PetscNumOMPThreads);CHKERRQ(ierr); 1084cd1b99a6SBarry Smith } 1085cd1b99a6SBarry Smith } 1086cd1b99a6SBarry Smith #endif 1087ef6c6fedSBoyana Norris 1088951e3c8eSBarry Smith #if defined(PETSC_USE_PETSC_MPI_EXTERNAL32) 1089e39fd77fSBarry Smith /* 1090e39fd77fSBarry Smith Tell MPI about our own data representation converter, this would/should be used if extern32 is not supported by the MPI 1091e39fd77fSBarry Smith 1092e39fd77fSBarry Smith Currently not used because it is not supported by MPICH. 1093e39fd77fSBarry Smith */ 109430815ce0SLisandro Dalcin if (!PetscBinaryBigEndian()) { 1095ffc4695bSBarry Smith ierr = MPI_Register_datarep((char*)"petsc",PetscDataRep_read_conv_fn,PetscDataRep_write_conv_fn,PetscDataRep_extent_fn,NULL);CHKERRMPI(ierr); 109630815ce0SLisandro Dalcin } 1097951e3c8eSBarry Smith #endif 1098e39fd77fSBarry Smith 109941c0b4b3SShri Abhyankar /* 110041c0b4b3SShri Abhyankar Setup building of stack frames for all function calls 110141c0b4b3SShri Abhyankar */ 1102ef19f930SBarry Smith #if defined(PETSC_USE_DEBUG) && !defined(PETSC_HAVE_THREADSAFETY) 1103e1167bb9SShri Abhyankar ierr = PetscStackCreate();CHKERRQ(ierr); 1104e1167bb9SShri Abhyankar #endif 1105e1167bb9SShri Abhyankar 11062d53ad75SBarry Smith #if defined(PETSC_SERIALIZE_FUNCTIONS) 11072d53ad75SBarry Smith ierr = PetscFPTCreate(10000);CHKERRQ(ierr); 11082d53ad75SBarry Smith #endif 11092d53ad75SBarry Smith 11105e71baefSBarry Smith #if defined(PETSC_HAVE_HWLOC) 111187c3beb6SLisandro Dalcin { 111287c3beb6SLisandro Dalcin PetscViewer viewer; 111322e7e69cSBarry Smith ierr = PetscOptionsGetViewer(PETSC_COMM_WORLD,NULL,NULL,"-process_view",&viewer,NULL,&flg);CHKERRQ(ierr); 11145e71baefSBarry Smith if (flg) { 11155e71baefSBarry Smith ierr = PetscProcessPlacementView(viewer);CHKERRQ(ierr); 111687c3beb6SLisandro Dalcin ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr); 111787c3beb6SLisandro Dalcin } 11185e71baefSBarry Smith } 11195e71baefSBarry Smith #endif 1120dff31646SBarry Smith 112187c3beb6SLisandro Dalcin flg = PETSC_TRUE; 112287c3beb6SLisandro Dalcin ierr = PetscOptionsGetBool(NULL,NULL,"-viewfromoptions",&flg,NULL);CHKERRQ(ierr); 112387c3beb6SLisandro Dalcin if (!flg) {ierr = PetscOptionsPushGetViewerOff(PETSC_TRUE);CHKERRQ(ierr);} 112487c3beb6SLisandro Dalcin 1125a56f64adSBarry Smith #if defined(PETSC_HAVE_ADIOS) 1126a56f64adSBarry Smith ierr = adios_init_noxml(PETSC_COMM_WORLD);CHKERRQ(ierr); 11277b56e58cSSatish Balay ierr = adios_declare_group(&Petsc_adios_group,"PETSc","",adios_stat_default);CHKERRQ(ierr); 1128a56f64adSBarry Smith ierr = adios_select_method(Petsc_adios_group,"MPI","","");CHKERRQ(ierr); 11299fc7e16cSBarry Smith ierr = adios_read_init_method(ADIOS_READ_METHOD_BP,PETSC_COMM_WORLD,"");CHKERRQ(ierr); 1130a56f64adSBarry Smith #endif 113155d657eeSBarry Smith #if defined(PETSC_HAVE_ADIOS2) 113255d657eeSBarry Smith #endif 1133a56f64adSBarry Smith 1134301d30feSBarry Smith /* 113557171095SVaclav Hapla Set flag that we are completely initialized 1136301d30feSBarry Smith */ 1137301d30feSBarry Smith PetscInitializeCalled = PETSC_TRUE; 11382db0e300SLisandro Dalcin 11392db0e300SLisandro Dalcin ierr = PetscOptionsHasName(NULL,NULL,"-python",&flg);CHKERRQ(ierr); 11402db0e300SLisandro Dalcin if (flg) {ierr = PetscPythonInitialize(NULL,NULL);CHKERRQ(ierr);} 1141301d30feSBarry Smith PetscFunctionReturn(0); 1142e5c89e4eSSatish Balay } 1143e5c89e4eSSatish Balay 11444097062eSBarry Smith #if defined(PETSC_USE_LOG) 114595c0884eSLisandro Dalcin PETSC_INTERN PetscObject *PetscObjects; 1146ecfe9a72SLisandro Dalcin PETSC_INTERN PetscInt PetscObjectsCounts; 1147ecfe9a72SLisandro Dalcin PETSC_INTERN PetscInt PetscObjectsMaxCounts; 114895c0884eSLisandro Dalcin PETSC_INTERN PetscBool PetscObjectsLog; 11494097062eSBarry Smith #endif 1150e5c89e4eSSatish Balay 1151008a6e76SBarry Smith /* 1152008a6e76SBarry Smith Frees all the MPI types and operations that PETSc may have created 1153008a6e76SBarry Smith */ 1154008a6e76SBarry Smith PetscErrorCode PetscFreeMPIResources(void) 1155008a6e76SBarry Smith { 1156008a6e76SBarry Smith PetscErrorCode ierr; 1157008a6e76SBarry Smith 1158008a6e76SBarry Smith PetscFunctionBegin; 1159008a6e76SBarry Smith #if defined(PETSC_USE_REAL___FLOAT128) 1160ffc4695bSBarry Smith ierr = MPI_Type_free(&MPIU___FLOAT128);CHKERRMPI(ierr); 1161008a6e76SBarry Smith #if defined(PETSC_HAVE_COMPLEX) 1162ffc4695bSBarry Smith ierr = MPI_Type_free(&MPIU___COMPLEX128);CHKERRMPI(ierr); 1163008a6e76SBarry Smith #endif 1164ffc4695bSBarry Smith ierr = MPI_Op_free(&MPIU_MAX);CHKERRMPI(ierr); 1165ffc4695bSBarry Smith ierr = MPI_Op_free(&MPIU_MIN);CHKERRMPI(ierr); 1166008a6e76SBarry Smith #elif defined(PETSC_USE_REAL___FP16) 1167ffc4695bSBarry Smith ierr = MPI_Type_free(&MPIU___FP16);CHKERRMPI(ierr); 1168ffc4695bSBarry Smith ierr = MPI_Op_free(&MPIU_MAX);CHKERRMPI(ierr); 1169ffc4695bSBarry Smith ierr = MPI_Op_free(&MPIU_MIN);CHKERRMPI(ierr); 1170008a6e76SBarry Smith #endif 1171008a6e76SBarry Smith 1172de272c7aSSatish Balay #if defined(PETSC_USE_REAL___FLOAT128) || defined(PETSC_USE_REAL___FP16) 1173ffc4695bSBarry Smith ierr = MPI_Op_free(&MPIU_SUM);CHKERRMPI(ierr); 1174008a6e76SBarry Smith #endif 1175008a6e76SBarry Smith 1176ffc4695bSBarry Smith ierr = MPI_Type_free(&MPIU_2SCALAR);CHKERRMPI(ierr); 117740df0d72SSatish Balay #if defined(PETSC_USE_64BIT_INDICES) 1178ffc4695bSBarry Smith ierr = MPI_Type_free(&MPIU_2INT);CHKERRMPI(ierr); 1179008a6e76SBarry Smith #endif 1180ffc4695bSBarry Smith ierr = MPI_Op_free(&MPIU_MAXSUM_OP);CHKERRMPI(ierr); 1181008a6e76SBarry Smith PetscFunctionReturn(0); 1182008a6e76SBarry Smith } 1183008a6e76SBarry Smith 1184e5c89e4eSSatish Balay /*@C 1185e5c89e4eSSatish Balay PetscFinalize - Checks for options to be called at the conclusion 1186e5c89e4eSSatish Balay of the program. MPI_Finalize() is called only if the user had not 1187e5c89e4eSSatish Balay called MPI_Init() before calling PetscInitialize(). 1188e5c89e4eSSatish Balay 1189e5c89e4eSSatish Balay Collective on PETSC_COMM_WORLD 1190e5c89e4eSSatish Balay 1191e5c89e4eSSatish Balay Options Database Keys: 119226a7e8d4SBarry Smith + -options_view - Calls PetscOptionsView() 1193e5c89e4eSSatish Balay . -options_left - Prints unused options that remain in the database 11947eb1d149SBarry 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 1195e5c89e4eSSatish Balay . -mpidump - Calls PetscMPIDump() 119692f119d6SBarry Smith . -malloc_dump <optional filename> - Calls PetscMallocDump(), displays all memory allocated that has not been freed 1197e5c89e4eSSatish Balay . -malloc_info - Prints total memory usage 119892f119d6SBarry Smith - -malloc_view <optional filename> - Prints list of all memory allocated and where 1199e5c89e4eSSatish Balay 1200e5c89e4eSSatish Balay Level: beginner 1201e5c89e4eSSatish Balay 1202e5c89e4eSSatish Balay Note: 1203e5c89e4eSSatish Balay See PetscInitialize() for more general runtime options. 1204e5c89e4eSSatish Balay 120588c29154SBarry Smith .seealso: PetscInitialize(), PetscOptionsView(), PetscMallocDump(), PetscMPIDump(), PetscEnd() 1206e5c89e4eSSatish Balay @*/ 12077087cfbeSBarry Smith PetscErrorCode PetscFinalize(void) 1208e5c89e4eSSatish Balay { 1209e5c89e4eSSatish Balay PetscErrorCode ierr; 12104bb5149bSJed Brown PetscMPIInt rank; 1211a8d2bbe5SBarry Smith PetscInt nopt; 12122bf49c77SBarry Smith PetscBool flg1 = PETSC_FALSE,flg2 = PETSC_FALSE,flg3 = PETSC_FALSE; 1213dff31646SBarry Smith PetscBool flg; 121410463e74SBarry Smith #if defined(PETSC_USE_LOG) 121510463e74SBarry Smith char mname[PETSC_MAX_PATH_LEN]; 121610463e74SBarry Smith #endif 1217e5c89e4eSSatish Balay 1218e5c89e4eSSatish Balay if (!PetscInitializeCalled) { 12194b09e917SBarry Smith printf("PetscInitialize() must be called before PetscFinalize()\n"); 12203cbbc5ffSBarry Smith return(PETSC_ERR_ARG_WRONGSTATE); 1221e5c89e4eSSatish Balay } 12223cbbc5ffSBarry Smith PetscFunctionBegin; 12230298fd71SBarry Smith ierr = PetscInfo(NULL,"PetscFinalize() called\n");CHKERRQ(ierr); 1224b022a5c1SBarry Smith 1225ffc4695bSBarry Smith ierr = MPI_Comm_rank(PETSC_COMM_WORLD,&rank);CHKERRMPI(ierr); 1226a56f64adSBarry Smith #if defined(PETSC_HAVE_ADIOS) 122722580e64SBarry Smith ierr = adios_read_finalize_method(ADIOS_READ_METHOD_BP_AGGREGATE);CHKERRQ(ierr); 1228a56f64adSBarry Smith ierr = adios_finalize(rank);CHKERRQ(ierr); 1229a56f64adSBarry Smith #endif 123055d657eeSBarry Smith #if defined(PETSC_HAVE_ADIOS2) 123155d657eeSBarry Smith #endif 1232c5929fdfSBarry Smith ierr = PetscOptionsHasName(NULL,NULL,"-citations",&flg);CHKERRQ(ierr); 1233dff31646SBarry Smith if (flg) { 12341f817a21SBarry Smith char *cits, filename[PETSC_MAX_PATH_LEN]; 12351f817a21SBarry Smith FILE *fd = PETSC_STDOUT; 12361f817a21SBarry Smith 1237589a23caSBarry Smith ierr = PetscOptionsGetString(NULL,NULL,"-citations",filename,sizeof(filename),NULL);CHKERRQ(ierr); 12381f817a21SBarry Smith if (filename[0]) { 12391f817a21SBarry Smith ierr = PetscFOpen(PETSC_COMM_WORLD,filename,"w",&fd);CHKERRQ(ierr); 12401f817a21SBarry Smith } 1241dff31646SBarry Smith ierr = PetscSegBufferGet(PetscCitationsList,1,&cits);CHKERRQ(ierr); 1242dff31646SBarry Smith cits[0] = 0; 1243dff31646SBarry Smith ierr = PetscSegBufferExtractAlloc(PetscCitationsList,&cits);CHKERRQ(ierr); 12441f817a21SBarry Smith ierr = PetscFPrintf(PETSC_COMM_WORLD,fd,"If you publish results based on this computation please cite the following:\n");CHKERRQ(ierr); 12451f817a21SBarry Smith ierr = PetscFPrintf(PETSC_COMM_WORLD,fd,"===========================================================================\n");CHKERRQ(ierr); 12461f817a21SBarry Smith ierr = PetscFPrintf(PETSC_COMM_WORLD,fd,"%s",cits);CHKERRQ(ierr); 12471f817a21SBarry Smith ierr = PetscFPrintf(PETSC_COMM_WORLD,fd,"===========================================================================\n");CHKERRQ(ierr); 12481f817a21SBarry Smith ierr = PetscFClose(PETSC_COMM_WORLD,fd);CHKERRQ(ierr); 1249dff31646SBarry Smith ierr = PetscFree(cits);CHKERRQ(ierr); 1250dff31646SBarry Smith } 1251dff31646SBarry Smith ierr = PetscSegBufferDestroy(&PetscCitationsList);CHKERRQ(ierr); 1252dff31646SBarry Smith 1253c2a97968SBarry Smith #if defined(PETSC_HAVE_SSL) && defined(PETSC_USE_SOCKET_VIEWER) 125404102261SBarry Smith /* TextBelt is run for testing purposes only, please do not use this feature often */ 125504102261SBarry Smith { 125604102261SBarry Smith PetscInt nmax = 2; 125704102261SBarry Smith char **buffs; 125804102261SBarry Smith ierr = PetscMalloc1(2,&buffs);CHKERRQ(ierr); 1259c5929fdfSBarry Smith ierr = PetscOptionsGetStringArray(NULL,NULL,"-textbelt",buffs,&nmax,&flg1);CHKERRQ(ierr); 126004102261SBarry Smith if (flg1) { 126104102261SBarry Smith if (!nmax) SETERRQ(PETSC_COMM_WORLD,PETSC_ERR_USER,"-textbelt requires either the phone number or number,\"message\""); 126204102261SBarry Smith if (nmax == 1) { 126304102261SBarry Smith ierr = PetscMalloc1(128,&buffs[1]);CHKERRQ(ierr); 126404102261SBarry Smith ierr = PetscGetProgramName(buffs[1],32);CHKERRQ(ierr); 126504102261SBarry Smith ierr = PetscStrcat(buffs[1]," has completed");CHKERRQ(ierr); 126604102261SBarry Smith } 126704102261SBarry Smith ierr = PetscTextBelt(PETSC_COMM_WORLD,buffs[0],buffs[1],NULL);CHKERRQ(ierr); 126804102261SBarry Smith ierr = PetscFree(buffs[0]);CHKERRQ(ierr); 126904102261SBarry Smith ierr = PetscFree(buffs[1]);CHKERRQ(ierr); 127004102261SBarry Smith } 127104102261SBarry Smith ierr = PetscFree(buffs);CHKERRQ(ierr); 127204102261SBarry Smith } 1273763ec7b1SBarry Smith { 1274763ec7b1SBarry Smith PetscInt nmax = 2; 1275763ec7b1SBarry Smith char **buffs; 1276763ec7b1SBarry Smith ierr = PetscMalloc1(2,&buffs);CHKERRQ(ierr); 1277763ec7b1SBarry Smith ierr = PetscOptionsGetStringArray(NULL,NULL,"-tellmycell",buffs,&nmax,&flg1);CHKERRQ(ierr); 1278763ec7b1SBarry Smith if (flg1) { 1279763ec7b1SBarry Smith if (!nmax) SETERRQ(PETSC_COMM_WORLD,PETSC_ERR_USER,"-tellmycell requires either the phone number or number,\"message\""); 1280763ec7b1SBarry Smith if (nmax == 1) { 1281763ec7b1SBarry Smith ierr = PetscMalloc1(128,&buffs[1]);CHKERRQ(ierr); 1282763ec7b1SBarry Smith ierr = PetscGetProgramName(buffs[1],32);CHKERRQ(ierr); 1283763ec7b1SBarry Smith ierr = PetscStrcat(buffs[1]," has completed");CHKERRQ(ierr); 1284763ec7b1SBarry Smith } 1285763ec7b1SBarry Smith ierr = PetscTellMyCell(PETSC_COMM_WORLD,buffs[0],buffs[1],NULL);CHKERRQ(ierr); 1286763ec7b1SBarry Smith ierr = PetscFree(buffs[0]);CHKERRQ(ierr); 1287763ec7b1SBarry Smith ierr = PetscFree(buffs[1]);CHKERRQ(ierr); 1288763ec7b1SBarry Smith } 1289763ec7b1SBarry Smith ierr = PetscFree(buffs);CHKERRQ(ierr); 1290763ec7b1SBarry Smith } 129104102261SBarry Smith #endif 129204102261SBarry Smith 12932d53ad75SBarry Smith #if defined(PETSC_SERIALIZE_FUNCTIONS) 12942d53ad75SBarry Smith ierr = PetscFPTDestroy();CHKERRQ(ierr); 12952d53ad75SBarry Smith #endif 12962d53ad75SBarry Smith 1297e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS) 1298dff31646SBarry Smith flg = PETSC_FALSE; 1299c5929fdfSBarry Smith ierr = PetscOptionsGetBool(NULL,NULL,"-saw_options",&flg,NULL);CHKERRQ(ierr); 1300d5649816SBarry Smith if (flg) { 1301e04113cfSBarry Smith ierr = PetscOptionsSAWsDestroy();CHKERRQ(ierr); 1302d5649816SBarry Smith } 1303d5649816SBarry Smith #endif 1304d5649816SBarry Smith 1305681455b2SBarry Smith #if defined(PETSC_HAVE_X) 1306681455b2SBarry Smith flg1 = PETSC_FALSE; 1307c5929fdfSBarry Smith ierr = PetscOptionsGetBool(NULL,NULL,"-x_virtual",&flg1,NULL);CHKERRQ(ierr); 1308681455b2SBarry Smith if (flg1) { 1309681455b2SBarry Smith /* this is a crude hack, but better than nothing */ 1310681455b2SBarry Smith ierr = PetscPOpen(PETSC_COMM_WORLD,NULL,"pkill -9 Xvfb","r",NULL);CHKERRQ(ierr); 1311681455b2SBarry Smith } 1312681455b2SBarry Smith #endif 1313681455b2SBarry Smith 131467584ceeSBarry Smith #if !defined(PETSC_HAVE_THREADSAFETY) 1315c5929fdfSBarry Smith ierr = PetscOptionsGetBool(NULL,NULL,"-malloc_info",&flg2,NULL);CHKERRQ(ierr); 1316e5c89e4eSSatish Balay if (!flg2) { 131790d69ab7SBarry Smith flg2 = PETSC_FALSE; 1318c5929fdfSBarry Smith ierr = PetscOptionsGetBool(NULL,NULL,"-memory_view",&flg2,NULL);CHKERRQ(ierr); 1319e5c89e4eSSatish Balay } 1320e5c89e4eSSatish Balay if (flg2) { 13210841954dSBarry Smith ierr = PetscMemoryView(PETSC_VIEWER_STDOUT_WORLD,"Summary of Memory Usage in PETSc\n");CHKERRQ(ierr); 1322e5c89e4eSSatish Balay } 132367584ceeSBarry Smith #endif 1324e5c89e4eSSatish Balay 1325e5c89e4eSSatish Balay #if defined(PETSC_USE_LOG) 132690d69ab7SBarry Smith flg1 = PETSC_FALSE; 1327c5929fdfSBarry Smith ierr = PetscOptionsGetBool(NULL,NULL,"-get_total_flops",&flg1,NULL);CHKERRQ(ierr); 1328e5c89e4eSSatish Balay if (flg1) { 1329e5c89e4eSSatish Balay PetscLogDouble flops = 0; 1330ffc4695bSBarry Smith ierr = MPI_Reduce(&petsc_TotalFlops,&flops,1,MPI_DOUBLE,MPI_SUM,0,PETSC_COMM_WORLD);CHKERRMPI(ierr); 1331e5c89e4eSSatish Balay ierr = PetscPrintf(PETSC_COMM_WORLD,"Total flops over all processors %g\n",flops);CHKERRQ(ierr); 1332e5c89e4eSSatish Balay } 1333e5c89e4eSSatish Balay #endif 1334e5c89e4eSSatish Balay 1335e5c89e4eSSatish Balay 1336e5c89e4eSSatish Balay #if defined(PETSC_USE_LOG) 1337e5c89e4eSSatish Balay #if defined(PETSC_HAVE_MPE) 1338e5c89e4eSSatish Balay mname[0] = 0; 1339589a23caSBarry Smith ierr = PetscOptionsGetString(NULL,NULL,"-log_mpe",mname,sizeof(mname),&flg1);CHKERRQ(ierr); 1340e5c89e4eSSatish Balay if (flg1) { 1341e5c89e4eSSatish Balay if (mname[0]) {ierr = PetscLogMPEDump(mname);CHKERRQ(ierr);} 1342e5c89e4eSSatish Balay else {ierr = PetscLogMPEDump(0);CHKERRQ(ierr);} 1343e5c89e4eSSatish Balay } 1344e5c89e4eSSatish Balay #endif 1345356e5837SBarry Smith #endif 1346a297a907SKarl Rupp 1347dd710f27SBarry Smith /* 1348dd710f27SBarry Smith Free all objects registered with PetscObjectRegisterDestroy() such as PETSC_VIEWER_XXX_(). 1349dd710f27SBarry Smith */ 1350dd710f27SBarry Smith ierr = PetscObjectRegisterDestroyAll();CHKERRQ(ierr); 1351dd710f27SBarry Smith 1352356e5837SBarry Smith #if defined(PETSC_USE_LOG) 135387c3beb6SLisandro Dalcin ierr = PetscOptionsPushGetViewerOff(PETSC_FALSE);CHKERRQ(ierr); 1354f14045dbSBarry Smith ierr = PetscLogViewFromOptions();CHKERRQ(ierr); 135587c3beb6SLisandro Dalcin ierr = PetscOptionsPopGetViewerOff();CHKERRQ(ierr); 135687c3beb6SLisandro Dalcin 1357356e5837SBarry Smith mname[0] = 0; 1358589a23caSBarry Smith ierr = PetscOptionsGetString(NULL,NULL,"-log_summary",mname,sizeof(mname),&flg1);CHKERRQ(ierr); 1359e5c89e4eSSatish Balay if (flg1) { 136091eabc43SBarry Smith PetscViewer viewer; 136120a8bfc3SBarry Smith ierr = (*PetscHelpPrintf)(PETSC_COMM_WORLD,"\n\n WARNING: -log_summary is being deprecated; switch to -log_view\n\n\n");CHKERRQ(ierr); 136291eabc43SBarry Smith if (mname[0]) { 136391eabc43SBarry Smith ierr = PetscViewerASCIIOpen(PETSC_COMM_WORLD,mname,&viewer);CHKERRQ(ierr); 136491eabc43SBarry Smith ierr = PetscLogView(viewer);CHKERRQ(ierr); 13656bf464f9SBarry Smith ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr); 136633f85c2fSBarry Smith } else { 136733f85c2fSBarry Smith viewer = PETSC_VIEWER_STDOUT_WORLD; 13689a9a5d4cSBarry Smith ierr = PetscViewerPushFormat(viewer,PETSC_VIEWER_DEFAULT);CHKERRQ(ierr); 136933f85c2fSBarry Smith ierr = PetscLogView(viewer);CHKERRQ(ierr); 13709a9a5d4cSBarry Smith ierr = PetscViewerPopFormat(viewer);CHKERRQ(ierr); 137133f85c2fSBarry Smith } 1372e5c89e4eSSatish Balay } 1373a297a907SKarl Rupp 1374dd710f27SBarry Smith /* 1375dd710f27SBarry Smith Free any objects created by the last block of code. 1376dd710f27SBarry Smith */ 1377dd710f27SBarry Smith ierr = PetscObjectRegisterDestroyAll();CHKERRQ(ierr); 1378dd710f27SBarry Smith 1379dd710f27SBarry Smith mname[0] = 0; 1380589a23caSBarry Smith ierr = PetscOptionsGetString(NULL,NULL,"-log_all",mname,sizeof(mname),&flg1);CHKERRQ(ierr); 1381589a23caSBarry Smith ierr = PetscOptionsGetString(NULL,NULL,"-log",mname,sizeof(mname),&flg2);CHKERRQ(ierr); 13827ff663adSLisandro Dalcin if (flg1 || flg2) {ierr = PetscLogDump(mname);CHKERRQ(ierr);} 1383e5c89e4eSSatish Balay #endif 138410463e74SBarry Smith 138533f85c2fSBarry Smith ierr = PetscStackDestroy();CHKERRQ(ierr); 138610463e74SBarry Smith 138790d69ab7SBarry Smith flg1 = PETSC_FALSE; 1388c5929fdfSBarry Smith ierr = PetscOptionsGetBool(NULL,NULL,"-no_signal_handler",&flg1,NULL);CHKERRQ(ierr); 1389e5c89e4eSSatish Balay if (!flg1) { ierr = PetscPopSignalHandler();CHKERRQ(ierr);} 139090d69ab7SBarry Smith flg1 = PETSC_FALSE; 1391c5929fdfSBarry Smith ierr = PetscOptionsGetBool(NULL,NULL,"-mpidump",&flg1,NULL);CHKERRQ(ierr); 1392e5c89e4eSSatish Balay if (flg1) { 1393e5c89e4eSSatish Balay ierr = PetscMPIDump(stdout);CHKERRQ(ierr); 1394e5c89e4eSSatish Balay } 139590d69ab7SBarry Smith flg1 = PETSC_FALSE; 139690d69ab7SBarry Smith flg2 = PETSC_FALSE; 13978bb29257SSatish Balay /* preemptive call to avoid listing this option in options table as unused */ 1398c5929fdfSBarry Smith ierr = PetscOptionsHasName(NULL,NULL,"-malloc_dump",&flg1);CHKERRQ(ierr); 1399c5929fdfSBarry Smith ierr = PetscOptionsHasName(NULL,NULL,"-objects_dump",&flg1);CHKERRQ(ierr); 1400c5929fdfSBarry Smith ierr = PetscOptionsGetBool(NULL,NULL,"-options_view",&flg2,NULL);CHKERRQ(ierr); 1401e4c476e2SSatish Balay 1402e5c89e4eSSatish Balay if (flg2) { 1403be56827dSJed Brown PetscViewer viewer; 140402ba9f54SBarry Smith ierr = PetscViewerCreate(PETSC_COMM_WORLD,&viewer);CHKERRQ(ierr); 140502ba9f54SBarry Smith ierr = PetscViewerSetType(viewer,PETSCVIEWERASCII);CHKERRQ(ierr); 1406c5929fdfSBarry Smith ierr = PetscOptionsView(NULL,viewer);CHKERRQ(ierr); 1407be56827dSJed Brown ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr); 1408e5c89e4eSSatish Balay } 1409e5c89e4eSSatish Balay 1410e5c89e4eSSatish Balay /* to prevent PETSc -options_left from warning */ 1411c5929fdfSBarry Smith ierr = PetscOptionsHasName(NULL,NULL,"-nox",&flg1);CHKERRQ(ierr); 1412c5929fdfSBarry Smith ierr = PetscOptionsHasName(NULL,NULL,"-nox_warning",&flg1);CHKERRQ(ierr); 1413e5c89e4eSSatish Balay 141433fc4174SSatish Balay flg3 = PETSC_FALSE; /* default value is required */ 1415c5929fdfSBarry Smith ierr = PetscOptionsGetBool(NULL,NULL,"-options_left",&flg3,&flg1);CHKERRQ(ierr); 14169245e749SBarry Smith if (PetscUnlikelyDebug(!flg1)) flg3 = PETSC_TRUE; 1417e5c89e4eSSatish Balay if (flg3) { 14183de2bfdfSBarry Smith if (!flg2 && flg1) { /* have not yet printed the options */ 1419be56827dSJed Brown PetscViewer viewer; 142002ba9f54SBarry Smith ierr = PetscViewerCreate(PETSC_COMM_WORLD,&viewer);CHKERRQ(ierr); 142102ba9f54SBarry Smith ierr = PetscViewerSetType(viewer,PETSCVIEWERASCII);CHKERRQ(ierr); 1422c5929fdfSBarry Smith ierr = PetscOptionsView(NULL,viewer);CHKERRQ(ierr); 1423be56827dSJed Brown ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr); 1424e5c89e4eSSatish Balay } 14253de2bfdfSBarry Smith ierr = PetscOptionsAllUsed(NULL,&nopt);CHKERRQ(ierr); 14263de2bfdfSBarry Smith if (nopt) { 14273de2bfdfSBarry Smith ierr = PetscPrintf(PETSC_COMM_WORLD,"WARNING! There are options you set that were not used!\n");CHKERRQ(ierr); 14283de2bfdfSBarry Smith ierr = PetscPrintf(PETSC_COMM_WORLD,"WARNING! could be spelling mistake, etc!\n");CHKERRQ(ierr); 14293de2bfdfSBarry Smith if (nopt == 1) { 1430e5c89e4eSSatish Balay ierr = PetscPrintf(PETSC_COMM_WORLD,"There is one unused database option. It is:\n");CHKERRQ(ierr); 1431e5c89e4eSSatish Balay } else { 14327582186dSLisandro Dalcin ierr = PetscPrintf(PETSC_COMM_WORLD,"There are %D unused database options. They are:\n",nopt);CHKERRQ(ierr); 1433e5c89e4eSSatish Balay } 14343de2bfdfSBarry Smith } else if (flg3 && flg1) { 14353de2bfdfSBarry Smith ierr = PetscPrintf(PETSC_COMM_WORLD,"There are no unused options.\n");CHKERRQ(ierr); 1436df12ba86SBarry Smith } 1437c5929fdfSBarry Smith ierr = PetscOptionsLeft(NULL);CHKERRQ(ierr); 1438e5c89e4eSSatish Balay } 1439e5c89e4eSSatish Balay 1440e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS) 1441d45a07a7SBarry Smith if (!PetscGlobalRank) { 144287f587eeSBarry Smith ierr = PetscStackSAWsViewOff();CHKERRQ(ierr); 144316ad0300SBarry Smith PetscStackCallSAWs(SAWs_Finalize,()); 1444d45a07a7SBarry Smith } 1445ec957eceSBarry Smith #endif 1446ec957eceSBarry Smith 14474097062eSBarry Smith #if defined(PETSC_USE_LOG) 144810463e74SBarry Smith /* 1449dbc8283eSBarry Smith List all objects the user may have forgot to free 14502eff7a51SBarry Smith */ 145105df10baSBarry Smith if (PetscObjectsLog) { 1452c5929fdfSBarry Smith ierr = PetscOptionsHasName(NULL,NULL,"-objects_dump",&flg1);CHKERRQ(ierr); 1453a64a8e02SBarry Smith if (flg1) { 1454a64a8e02SBarry Smith MPI_Comm local_comm; 14557eb1d149SBarry Smith char string[64]; 1456a64a8e02SBarry Smith 1457589a23caSBarry Smith ierr = PetscOptionsGetString(NULL,NULL,"-objects_dump",string,sizeof(string),NULL);CHKERRQ(ierr); 1458ffc4695bSBarry Smith ierr = MPI_Comm_dup(MPI_COMM_WORLD,&local_comm);CHKERRMPI(ierr); 1459a64a8e02SBarry Smith ierr = PetscSequentialPhaseBegin_Private(local_comm,1);CHKERRQ(ierr); 14607eb1d149SBarry Smith ierr = PetscObjectsDump(stdout,(string[0] == 'a') ? PETSC_TRUE : PETSC_FALSE);CHKERRQ(ierr); 1461a64a8e02SBarry Smith ierr = PetscSequentialPhaseEnd_Private(local_comm,1);CHKERRQ(ierr); 1462ffc4695bSBarry Smith ierr = MPI_Comm_free(&local_comm);CHKERRMPI(ierr); 14630a1571b3SBarry Smith } 146405df10baSBarry Smith } 14654097062eSBarry Smith #endif 14664097062eSBarry Smith 14674097062eSBarry Smith #if defined(PETSC_USE_LOG) 1468dbc8283eSBarry Smith PetscObjectsCounts = 0; 1469dbc8283eSBarry Smith PetscObjectsMaxCounts = 0; 1470a297a907SKarl Rupp ierr = PetscFree(PetscObjects);CHKERRQ(ierr); 14714097062eSBarry Smith #endif 14722eff7a51SBarry Smith 147333f85c2fSBarry Smith /* 147433f85c2fSBarry Smith Destroy any packages that registered a finalize 147533f85c2fSBarry Smith */ 147633f85c2fSBarry Smith ierr = PetscRegisterFinalizeAll();CHKERRQ(ierr); 147733f85c2fSBarry Smith 1478101409b8SToby Isaac #if defined(PETSC_USE_LOG) 1479fa2bb9feSLisandro Dalcin ierr = PetscLogFinalize();CHKERRQ(ierr); 1480101409b8SToby Isaac #endif 1481101409b8SToby Isaac 148233f85c2fSBarry Smith /* 148348dd1dffSBarry Smith Print PetscFunctionLists that have not been properly freed 148448dd1dffSBarry Smith 148537e93019SBarry Smith ierr = PetscFunctionListPrintAll();CHKERRQ(ierr); 148648dd1dffSBarry Smith */ 148737e93019SBarry Smith 14884028d114SSatish Balay if (petsc_history) { 1489f3dea69dSBarry Smith ierr = PetscCloseHistoryFile(&petsc_history);CHKERRQ(ierr); 149002c9f0b5SLisandro Dalcin petsc_history = NULL; 1491e5c89e4eSSatish Balay } 14929de0f6ecSBarry Smith ierr = PetscOptionsHelpPrintedDestroy(&PetscOptionsHelpPrintedSingleton);CHKERRQ(ierr); 1493e94e781bSJacob Faibussowitsch ierr = PetscInfoDestroy();CHKERRQ(ierr); 1494e5c89e4eSSatish Balay 149567584ceeSBarry Smith #if !defined(PETSC_HAVE_THREADSAFETY) 149692f119d6SBarry Smith if (!(PETSC_RUNNING_ON_VALGRIND)) { 1497e5c89e4eSSatish Balay char fname[PETSC_MAX_PATH_LEN]; 149892f119d6SBarry Smith char sname[PETSC_MAX_PATH_LEN]; 1499e5c89e4eSSatish Balay FILE *fd; 1500ed9cf6e9SBarry Smith int err; 1501e5c89e4eSSatish Balay 1502dc92acbaSJed Brown flg2 = PETSC_FALSE; 150392f119d6SBarry Smith flg3 = PETSC_FALSE; 1504cf9c20a2SJed Brown if (PetscDefined(USE_DEBUG)) {ierr = PetscOptionsGetBool(NULL,NULL,"-malloc_test",&flg2,NULL);CHKERRQ(ierr);} 150592f119d6SBarry Smith ierr = PetscOptionsGetBool(NULL,NULL,"-malloc_debug",&flg3,NULL);CHKERRQ(ierr); 150692f119d6SBarry Smith fname[0] = 0; 1507589a23caSBarry Smith ierr = PetscOptionsGetString(NULL,NULL,"-malloc_dump",fname,sizeof(fname),&flg1);CHKERRQ(ierr); 1508e5c89e4eSSatish Balay if (flg1 && fname[0]) { 1509e5c89e4eSSatish Balay 1510589a23caSBarry Smith PetscSNPrintf(sname,sizeof(sname),"%s_%d",fname,rank); 1511e32f2f54SBarry Smith fd = fopen(sname,"w"); if (!fd) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_FILE_OPEN,"Cannot open log file: %s",sname); 1512e5c89e4eSSatish Balay ierr = PetscMallocDump(fd);CHKERRQ(ierr); 1513ed9cf6e9SBarry Smith err = fclose(fd); 1514e32f2f54SBarry Smith if (err) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SYS,"fclose() failed on file"); 151592f119d6SBarry Smith } else if (flg1 || flg2 || flg3) { 1516e5c89e4eSSatish Balay MPI_Comm local_comm; 1517e5c89e4eSSatish Balay 1518ffc4695bSBarry Smith ierr = MPI_Comm_dup(MPI_COMM_WORLD,&local_comm);CHKERRMPI(ierr); 1519e5c89e4eSSatish Balay ierr = PetscSequentialPhaseBegin_Private(local_comm,1);CHKERRQ(ierr); 1520e5c89e4eSSatish Balay ierr = PetscMallocDump(stdout);CHKERRQ(ierr); 1521e5c89e4eSSatish Balay ierr = PetscSequentialPhaseEnd_Private(local_comm,1);CHKERRQ(ierr); 1522ffc4695bSBarry Smith ierr = MPI_Comm_free(&local_comm);CHKERRMPI(ierr); 1523e5c89e4eSSatish Balay } 1524e5c89e4eSSatish Balay fname[0] = 0; 1525589a23caSBarry Smith ierr = PetscOptionsGetString(NULL,NULL,"-malloc_view",fname,sizeof(fname),&flg1);CHKERRQ(ierr); 1526e5c89e4eSSatish Balay if (flg1 && fname[0]) { 1527e5c89e4eSSatish Balay 1528589a23caSBarry Smith PetscSNPrintf(sname,sizeof(sname),"%s_%d",fname,rank); 152992f119d6SBarry Smith fd = fopen(sname,"w"); if (!fd) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_FILE_OPEN,"Cannot open log file: %s",sname); 153092f119d6SBarry Smith ierr = PetscMallocView(fd);CHKERRQ(ierr); 1531ed9cf6e9SBarry Smith err = fclose(fd); 1532e32f2f54SBarry Smith if (err) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SYS,"fclose() failed on file"); 153392f119d6SBarry Smith } else if (flg1) { 153492f119d6SBarry Smith MPI_Comm local_comm; 153592f119d6SBarry Smith 1536ffc4695bSBarry Smith ierr = MPI_Comm_dup(MPI_COMM_WORLD,&local_comm);CHKERRMPI(ierr); 153792f119d6SBarry Smith ierr = PetscSequentialPhaseBegin_Private(local_comm,1);CHKERRQ(ierr); 153892f119d6SBarry Smith ierr = PetscMallocView(stdout);CHKERRQ(ierr); 153992f119d6SBarry Smith ierr = PetscSequentialPhaseEnd_Private(local_comm,1);CHKERRQ(ierr); 1540ffc4695bSBarry Smith ierr = MPI_Comm_free(&local_comm);CHKERRMPI(ierr); 1541e5c89e4eSSatish Balay } 1542e5c89e4eSSatish Balay } 154367584ceeSBarry Smith #endif 154420e2c332SMatthew G. Knepley 15455486ca60SMatthew G. Knepley /* 15465486ca60SMatthew G. Knepley Close any open dynamic libraries 15475486ca60SMatthew G. Knepley */ 15485486ca60SMatthew G. Knepley ierr = PetscFinalize_DynamicLibraries();CHKERRQ(ierr); 15495486ca60SMatthew G. Knepley 1550e5c89e4eSSatish Balay /* Can be destroyed only after all the options are used */ 15514416b707SBarry Smith ierr = PetscOptionsDestroyDefault();CHKERRQ(ierr); 1552e5c89e4eSSatish Balay 1553e5c89e4eSSatish Balay PetscGlobalArgc = 0; 155402c9f0b5SLisandro Dalcin PetscGlobalArgs = NULL; 1555e5c89e4eSSatish Balay 1556c2b86a48SJunchao Zhang #if defined(PETSC_HAVE_KOKKOS) 1557c2b86a48SJunchao Zhang if (PetscBeganKokkos) { 1558c2b86a48SJunchao Zhang ierr = PetscKokkosFinalize_Private();CHKERRQ(ierr); 1559c2b86a48SJunchao Zhang PetscBeganKokkos = PETSC_FALSE; 156045639126SStefano Zampini PetscKokkosInitialized = PETSC_FALSE; 1561c2b86a48SJunchao Zhang } 1562c2b86a48SJunchao Zhang #endif 1563c2b86a48SJunchao Zhang 1564*71438e86SJunchao Zhang #if defined(PETSC_HAVE_NVSHMEM) 1565*71438e86SJunchao Zhang if (PetscBeganNvshmem) { 1566*71438e86SJunchao Zhang ierr = PetscNvshmemFinalize();CHKERRQ(ierr); 1567*71438e86SJunchao Zhang PetscBeganNvshmem = PETSC_FALSE; 1568*71438e86SJunchao Zhang } 1569*71438e86SJunchao Zhang #endif 1570a0e72f99SJunchao Zhang 1571a0e72f99SJunchao Zhang #if defined(PETSC_HAVE_CUDA) 1572a0e72f99SJunchao Zhang if (PetscDefaultCudaStream) {cudaError_t cerr = cudaStreamDestroy(PetscDefaultCudaStream);CHKERRCUDA(cerr);} 1573a0e72f99SJunchao Zhang #endif 1574a0e72f99SJunchao Zhang 1575a0e72f99SJunchao Zhang #if defined(PETSC_HAVE_HIP) 1576a0e72f99SJunchao Zhang if (PetscDefaultHipStream) {hipError_t cerr = hipStreamDestroy(PetscDefaultHipStream);CHKERRHIP(cerr);} 1577a0e72f99SJunchao Zhang #endif 1578a0e72f99SJunchao Zhang 1579008a6e76SBarry Smith ierr = PetscFreeMPIResources();CHKERRQ(ierr); 1580e5c89e4eSSatish Balay 1581dbc8283eSBarry Smith /* 1582efb80d3cSBarry Smith Destroy any known inner MPI_Comm's and attributes pointing to them 1583efb80d3cSBarry Smith Note this will not destroy any new communicators the user has created. 1584efb80d3cSBarry Smith 1585efb80d3cSBarry Smith If all PETSc objects were not destroyed those left over objects will have hanging references to 1586efb80d3cSBarry Smith the MPI_Comms that were freed; but that is ok because those PETSc objects will never be used again 1587dbc8283eSBarry Smith */ 1588b770b1f6SSatish Balay { 1589dbc8283eSBarry Smith PetscCommCounter *counter; 1590dbc8283eSBarry Smith PetscMPIInt flg; 1591dbc8283eSBarry Smith MPI_Comm icomm; 1592265f3f35SJed Brown union {MPI_Comm comm; void *ptr;} ucomm; 1593ffc4695bSBarry Smith ierr = MPI_Comm_get_attr(PETSC_COMM_SELF,Petsc_InnerComm_keyval,&ucomm,&flg);CHKERRMPI(ierr); 1594dbc8283eSBarry Smith if (flg) { 1595265f3f35SJed Brown icomm = ucomm.comm; 1596ffc4695bSBarry Smith ierr = MPI_Comm_get_attr(icomm,Petsc_Counter_keyval,&counter,&flg);CHKERRMPI(ierr); 1597dbc8283eSBarry Smith if (!flg) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_CORRUPT,"Inner MPI_Comm does not have expected tag/name counter, problem with corrupted memory"); 1598dbc8283eSBarry Smith 1599ffc4695bSBarry Smith ierr = MPI_Comm_delete_attr(PETSC_COMM_SELF,Petsc_InnerComm_keyval);CHKERRMPI(ierr); 1600ffc4695bSBarry Smith ierr = MPI_Comm_delete_attr(icomm,Petsc_Counter_keyval);CHKERRMPI(ierr); 1601ffc4695bSBarry Smith ierr = MPI_Comm_free(&icomm);CHKERRMPI(ierr); 1602dbc8283eSBarry Smith } 1603ffc4695bSBarry Smith ierr = MPI_Comm_get_attr(PETSC_COMM_WORLD,Petsc_InnerComm_keyval,&ucomm,&flg);CHKERRMPI(ierr); 1604dbc8283eSBarry Smith if (flg) { 1605265f3f35SJed Brown icomm = ucomm.comm; 1606ffc4695bSBarry Smith ierr = MPI_Comm_get_attr(icomm,Petsc_Counter_keyval,&counter,&flg);CHKERRMPI(ierr); 1607dbc8283eSBarry Smith if (!flg) SETERRQ(PETSC_COMM_WORLD,PETSC_ERR_ARG_CORRUPT,"Inner MPI_Comm does not have expected tag/name counter, problem with corrupted memory"); 1608dbc8283eSBarry Smith 1609ffc4695bSBarry Smith ierr = MPI_Comm_delete_attr(PETSC_COMM_WORLD,Petsc_InnerComm_keyval);CHKERRMPI(ierr); 1610ffc4695bSBarry Smith ierr = MPI_Comm_delete_attr(icomm,Petsc_Counter_keyval);CHKERRMPI(ierr); 1611ffc4695bSBarry Smith ierr = MPI_Comm_free(&icomm);CHKERRMPI(ierr); 1612dbc8283eSBarry Smith } 1613b770b1f6SSatish Balay } 1614dbc8283eSBarry Smith 1615ffc4695bSBarry Smith ierr = MPI_Comm_free_keyval(&Petsc_Counter_keyval);CHKERRMPI(ierr); 1616ffc4695bSBarry Smith ierr = MPI_Comm_free_keyval(&Petsc_InnerComm_keyval);CHKERRMPI(ierr); 1617ffc4695bSBarry Smith ierr = MPI_Comm_free_keyval(&Petsc_OuterComm_keyval);CHKERRMPI(ierr); 1618ffc4695bSBarry Smith ierr = MPI_Comm_free_keyval(&Petsc_ShmComm_keyval);CHKERRMPI(ierr); 1619480cf27aSJed Brown 16205ad9ad5bSBarry Smith ierr = PetscSpinlockDestroy(&PetscViewerASCIISpinLockOpen);CHKERRQ(ierr); 16215ad9ad5bSBarry Smith ierr = PetscSpinlockDestroy(&PetscViewerASCIISpinLockStdout);CHKERRQ(ierr); 16225ad9ad5bSBarry Smith ierr = PetscSpinlockDestroy(&PetscViewerASCIISpinLockStderr);CHKERRQ(ierr); 1623ef19f930SBarry Smith ierr = PetscSpinlockDestroy(&PetscCommSpinLock);CHKERRQ(ierr); 1624ef19f930SBarry Smith 1625e5c89e4eSSatish Balay if (PetscBeganMPI) { 162699608316SBarry Smith #if defined(PETSC_HAVE_MPI_FINALIZED) 162799b1327fSBarry Smith PetscMPIInt flag; 1628ffc4695bSBarry Smith ierr = MPI_Finalized(&flag);CHKERRMPI(ierr); 1629e32f2f54SBarry Smith if (flag) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_LIB,"MPI_Finalize() has already been called, even though MPI_Init() was called by PetscInitialize()"); 163099608316SBarry Smith #endif 1631ffc4695bSBarry Smith ierr = MPI_Finalize();CHKERRMPI(ierr); 1632e5c89e4eSSatish Balay } 1633e5c89e4eSSatish Balay /* 1634e5c89e4eSSatish Balay 1635e5c89e4eSSatish Balay Note: In certain cases PETSC_COMM_WORLD is never MPI_Comm_free()ed because 1636e5c89e4eSSatish Balay the communicator has some outstanding requests on it. Specifically if the 1637e5c89e4eSSatish Balay flag PETSC_HAVE_BROKEN_REQUEST_FREE is set (for IBM MPI implementation). See 1638e5c89e4eSSatish Balay src/vec/utils/vpscat.c. Due to this the memory allocated in PetscCommDuplicate() 1639e5c89e4eSSatish Balay is never freed as it should be. Thus one may obtain messages of the form 16400e5e90baSSatish Balay [ 1] 8 bytes PetscCommDuplicate() line 645 in src/sys/mpiu.c indicating the 1641e5c89e4eSSatish Balay memory was not freed. 1642e5c89e4eSSatish Balay 1643e5c89e4eSSatish Balay */ 16441d1a0024SBarry Smith ierr = PetscMallocClear();CHKERRQ(ierr); 1645a297a907SKarl Rupp 16468ad20175SVaclav Hapla PetscErrorHandlingInitialized = PETSC_FALSE; 1647e5c89e4eSSatish Balay PetscInitializeCalled = PETSC_FALSE; 1648e5c89e4eSSatish Balay PetscFinalizeCalled = PETSC_TRUE; 164956883f60SBarry Smith #if defined(PETSC_USE_GCOV) 165056883f60SBarry Smith /* 165156883f60SBarry Smith flush gcov, otherwise during CI the flushing continues into the next pipeline resulting in git not being able to delete directories since the 165256883f60SBarry Smith gcov files are still being added to the directories as git tries to remove the directories. 165356883f60SBarry Smith */ 165456883f60SBarry Smith __gcov_flush(); 165556883f60SBarry Smith #endif 16563db9a53dSBarry Smith PetscFunctionReturn(0); 1657e5c89e4eSSatish Balay } 1658e5c89e4eSSatish Balay 165943db4dbbSBarry Smith #if defined(PETSC_MISSING_LAPACK_lsame_) 16608cc058d9SJed Brown PETSC_EXTERN int lsame_(char *a,char *b) 166143db4dbbSBarry Smith { 166243db4dbbSBarry Smith if (*a == *b) return 1; 166343db4dbbSBarry Smith if (*a + 32 == *b) return 1; 166443db4dbbSBarry Smith if (*a - 32 == *b) return 1; 166543db4dbbSBarry Smith return 0; 166643db4dbbSBarry Smith } 1667a70650f6SBarry Smith #endif 166843db4dbbSBarry Smith 166943db4dbbSBarry Smith #if defined(PETSC_MISSING_LAPACK_lsame) 16708cc058d9SJed Brown PETSC_EXTERN int lsame(char *a,char *b) 167143db4dbbSBarry Smith { 167243db4dbbSBarry Smith if (*a == *b) return 1; 167343db4dbbSBarry Smith if (*a + 32 == *b) return 1; 167443db4dbbSBarry Smith if (*a - 32 == *b) return 1; 167543db4dbbSBarry Smith return 0; 167643db4dbbSBarry Smith } 167743db4dbbSBarry Smith #endif 1678