17d0a6c19SBarry Smith 2e5c89e4eSSatish Balay /* 3e5c89e4eSSatish Balay This file defines the initialization of PETSc, including PetscInitialize() 4e5c89e4eSSatish Balay */ 550f81f78SJed Brown #define PETSC_DESIRE_COMPLEX 6afcb2eb5SJed Brown #include <petsc-private/petscimpl.h> /*I "petscsys.h" I*/ 7665c2dedSJed Brown #include <petscviewer.h> 88101f56cSMatthew Knepley 9663ba86aSMatthew G Knepley #if defined(PETSC_HAVE_CUDA) 102f947c57SVictor Minden #include <cublas.h> 117a025f21SVictor Minden #endif 127a025f21SVictor Minden 13bd8b14e7SShri Abhyankar #include <petscthreadcomm.h> 14bd8b14e7SShri Abhyankar 15a9f03627SSatish Balay #if defined(PETSC_USE_LOG) 1609573ac7SBarry Smith extern PetscErrorCode PetscLogBegin_Private(void); 17a9f03627SSatish Balay #endif 1885afcc9aSBarry Smith extern PetscBool PetscHMPIWorker; 19f2d66bcaSShri Abhyankar 202d53ad75SBarry Smith #if defined(PETSC_SERIALIZE_FUNCTIONS) 212d53ad75SBarry Smith PetscFPT PetscFPTData = 0; 222d53ad75SBarry Smith #endif 232d53ad75SBarry Smith 24a6790183SBarry Smith #if defined(PETSC_HAVE_SAWS) 25a6790183SBarry Smith #include <SAWs.h> 26a6790183SBarry Smith #endif 27e5c89e4eSSatish Balay /* -----------------------------------------------------------------------------------------*/ 28e5c89e4eSSatish Balay 29e5c89e4eSSatish Balay extern FILE *petsc_history; 30e5c89e4eSSatish Balay 3109573ac7SBarry Smith extern PetscErrorCode PetscInitialize_DynamicLibraries(void); 3209573ac7SBarry Smith extern PetscErrorCode PetscFinalize_DynamicLibraries(void); 3337e93019SBarry Smith extern PetscErrorCode PetscFunctionListPrintAll(void); 3409573ac7SBarry Smith extern PetscErrorCode PetscSequentialPhaseBegin_Private(MPI_Comm,int); 3509573ac7SBarry Smith extern PetscErrorCode PetscSequentialPhaseEnd_Private(MPI_Comm,int); 3609573ac7SBarry Smith extern PetscErrorCode PetscCloseHistoryFile(FILE**); 370069ddf5SShri Abhyankar 38e5c89e4eSSatish Balay /* user may set this BEFORE calling PetscInitialize() */ 39e8373e55SMatthew Knepley MPI_Comm PETSC_COMM_WORLD = MPI_COMM_NULL; 40e5c89e4eSSatish Balay 41480cf27aSJed Brown PetscMPIInt Petsc_Counter_keyval = MPI_KEYVAL_INVALID; 42480cf27aSJed Brown PetscMPIInt Petsc_InnerComm_keyval = MPI_KEYVAL_INVALID; 43480cf27aSJed Brown PetscMPIInt Petsc_OuterComm_keyval = MPI_KEYVAL_INVALID; 44480cf27aSJed Brown 45e5c89e4eSSatish Balay /* 46e5c89e4eSSatish Balay Declare and set all the string names of the PETSc enums 47e5c89e4eSSatish Balay */ 486a6fc655SJed Brown const char *const PetscBools[] = {"FALSE","TRUE","PetscBool","PETSC_",0}; 496a6fc655SJed Brown const char *const PetscCopyModes[] = {"COPY_VALUES","OWN_POINTER","USE_POINTER","PetscCopyMode","PETSC_",0}; 506a6fc655SJed Brown const char *const PetscDataTypes[] = {"INT","DOUBLE","COMPLEX","LONG","SHORT","FLOAT", 512d53ad75SBarry Smith "CHAR","LOGICAL","ENUM","BOOL","LONGDOUBLE","OBJECT","FUNCTION","PetscDataType","PETSC_",0}; 52e5c89e4eSSatish Balay 53ace3abfcSBarry Smith PetscBool PetscPreLoadingUsed = PETSC_FALSE; 54ace3abfcSBarry Smith PetscBool PetscPreLoadingOn = PETSC_FALSE; 550f8e0872SSatish Balay 56e1167bb9SShri Abhyankar /* pthread_key for PetscStack */ 57e1167bb9SShri Abhyankar #if defined(PETSC_HAVE_PTHREADCLASSES) && !defined(PETSC_PTHREAD_LOCAL) 58f5dc6901SShri Abhyankar pthread_key_t petscstack; 59e1167bb9SShri Abhyankar #endif 60e1167bb9SShri Abhyankar 61e5c89e4eSSatish Balay /* 62e5c89e4eSSatish Balay Checks the options database for initializations related to the 63e5c89e4eSSatish Balay PETSc components 64e5c89e4eSSatish Balay */ 65e5c89e4eSSatish Balay #undef __FUNCT__ 66e5c89e4eSSatish Balay #define __FUNCT__ "PetscOptionsCheckInitial_Components" 677087cfbeSBarry Smith PetscErrorCode PetscOptionsCheckInitial_Components(void) 68e5c89e4eSSatish Balay { 69ace3abfcSBarry Smith PetscBool flg1; 70e5c89e4eSSatish Balay PetscErrorCode ierr; 71e5c89e4eSSatish Balay 72e5c89e4eSSatish Balay PetscFunctionBegin; 730298fd71SBarry Smith ierr = PetscOptionsHasName(NULL,"-help",&flg1);CHKERRQ(ierr); 74e5c89e4eSSatish Balay if (flg1) { 75e5c89e4eSSatish Balay #if defined(PETSC_USE_LOG) 76e8e7597cSSatish Balay MPI_Comm comm = PETSC_COMM_WORLD; 77e5c89e4eSSatish Balay ierr = (*PetscHelpPrintf)(comm,"------Additional PETSc component options--------\n");CHKERRQ(ierr); 78e5c89e4eSSatish Balay ierr = (*PetscHelpPrintf)(comm," -log_summary_exclude: <vec,mat,pc.ksp,snes>\n");CHKERRQ(ierr); 796cf91177SBarry Smith ierr = (*PetscHelpPrintf)(comm," -info_exclude: <null,vec,mat,pc,ksp,snes,ts>\n");CHKERRQ(ierr); 80e5c89e4eSSatish Balay ierr = (*PetscHelpPrintf)(comm,"-----------------------------------------------\n");CHKERRQ(ierr); 81e5c89e4eSSatish Balay #endif 82e5c89e4eSSatish Balay } 83e5c89e4eSSatish Balay PetscFunctionReturn(0); 84e5c89e4eSSatish Balay } 85e5c89e4eSSatish Balay 86e5c89e4eSSatish Balay #undef __FUNCT__ 87945d1669SBarry Smith #define __FUNCT__ "PetscInitializeNoPointers" 880f11a792SBarry Smith /* 89945d1669SBarry Smith PetscInitializeNoPointers - Calls PetscInitialize() from C/C++ without the pointers to argc and args 9072a42c3cSBarry Smith 9172a42c3cSBarry Smith Collective 9272a42c3cSBarry Smith 9372a42c3cSBarry Smith Level: advanced 9472a42c3cSBarry Smith 95945d1669SBarry Smith Notes: this is called only by the PETSc MATLAB and Julia interface. Even though it might start MPI it sets the flag to 960f11a792SBarry Smith indicate that it did NOT start MPI so that the PetscFinalize() does not end MPI, thus allowing PetscInitialize() to 97945d1669SBarry Smith be called multiple times from MATLAB and Julia without the problem of trying to initialize MPI more than once. 980f11a792SBarry Smith 991ea5a559SBarry Smith Turns off PETSc signal handling because that can interact with MATLAB's signal handling causing random crashes. 1001ea5a559SBarry Smith 10172a42c3cSBarry Smith .seealso: PetscInitialize(), PetscInitializeFortran(), PetscInitializeNoArguments() 1020f11a792SBarry Smith */ 103945d1669SBarry Smith PetscErrorCode PetscInitializeNoPointers(int argc,char **args,const char *filename,const char *help) 10472a42c3cSBarry Smith { 10572a42c3cSBarry Smith PetscErrorCode ierr; 10672a42c3cSBarry Smith int myargc = argc; 10772a42c3cSBarry Smith char **myargs = args; 10872a42c3cSBarry Smith 10972a42c3cSBarry Smith PetscFunctionBegin; 1103bf036e2SBarry Smith ierr = PetscInitialize(&myargc,&myargs,filename,help);CHKERRQ(ierr); 1111ea5a559SBarry Smith ierr = PetscPopSignalHandler();CHKERRQ(ierr); 112df413903SBarry Smith PetscBeganMPI = PETSC_FALSE; 11372a42c3cSBarry Smith PetscFunctionReturn(ierr); 11472a42c3cSBarry Smith } 11572a42c3cSBarry Smith 11672a42c3cSBarry Smith #undef __FUNCT__ 117945d1669SBarry Smith #define __FUNCT__ "PetscGetPETSC_COMM_SELF" 118f0865b08SBarry Smith /* 119945d1669SBarry Smith Used by MATLAB and Julia interface to get communicator 120f0865b08SBarry Smith */ 121945d1669SBarry Smith PetscErrorCode PetscGetPETSC_COMM_SELF(MPI_Comm *comm) 122f0865b08SBarry Smith { 123f0865b08SBarry Smith PetscFunctionBegin; 124f0865b08SBarry Smith *comm = PETSC_COMM_SELF; 125f0865b08SBarry Smith PetscFunctionReturn(0); 126f0865b08SBarry Smith } 127f0865b08SBarry Smith 128f0865b08SBarry Smith #undef __FUNCT__ 129e5c89e4eSSatish Balay #define __FUNCT__ "PetscInitializeNoArguments" 130e5c89e4eSSatish Balay /*@C 131e5c89e4eSSatish Balay PetscInitializeNoArguments - Calls PetscInitialize() from C/C++ without 132e5c89e4eSSatish Balay the command line arguments. 133e5c89e4eSSatish Balay 134e5c89e4eSSatish Balay Collective 135e5c89e4eSSatish Balay 136e5c89e4eSSatish Balay Level: advanced 137e5c89e4eSSatish Balay 138e5c89e4eSSatish Balay .seealso: PetscInitialize(), PetscInitializeFortran() 139e5c89e4eSSatish Balay @*/ 1407087cfbeSBarry Smith PetscErrorCode PetscInitializeNoArguments(void) 141e5c89e4eSSatish Balay { 142e5c89e4eSSatish Balay PetscErrorCode ierr; 143e5c89e4eSSatish Balay int argc = 0; 144e5c89e4eSSatish Balay char **args = 0; 145e5c89e4eSSatish Balay 146e5c89e4eSSatish Balay PetscFunctionBegin; 1470298fd71SBarry Smith ierr = PetscInitialize(&argc,&args,NULL,NULL); 148e5c89e4eSSatish Balay PetscFunctionReturn(ierr); 149e5c89e4eSSatish Balay } 150e5c89e4eSSatish Balay 151e5c89e4eSSatish Balay #undef __FUNCT__ 152e5c89e4eSSatish Balay #define __FUNCT__ "PetscInitialized" 153e5c89e4eSSatish Balay /*@ 154e5c89e4eSSatish Balay PetscInitialized - Determine whether PETSc is initialized. 155e5c89e4eSSatish Balay 15693b6d2d1SJed Brown Level: beginner 157e5c89e4eSSatish Balay 158e5c89e4eSSatish Balay .seealso: PetscInitialize(), PetscInitializeNoArguments(), PetscInitializeFortran() 159e5c89e4eSSatish Balay @*/ 1607087cfbeSBarry Smith PetscErrorCode PetscInitialized(PetscBool *isInitialized) 161e5c89e4eSSatish Balay { 162e5c89e4eSSatish Balay *isInitialized = PetscInitializeCalled; 16393b6d2d1SJed Brown return 0; 164e5c89e4eSSatish Balay } 165e5c89e4eSSatish Balay 166e5c89e4eSSatish Balay #undef __FUNCT__ 167e5c89e4eSSatish Balay #define __FUNCT__ "PetscFinalized" 168e5c89e4eSSatish Balay /*@ 169e5c89e4eSSatish Balay PetscFinalized - Determine whether PetscFinalize() has been called yet 170e5c89e4eSSatish Balay 171e5c89e4eSSatish Balay Level: developer 172e5c89e4eSSatish Balay 173e5c89e4eSSatish Balay .seealso: PetscInitialize(), PetscInitializeNoArguments(), PetscInitializeFortran() 174e5c89e4eSSatish Balay @*/ 1757087cfbeSBarry Smith PetscErrorCode PetscFinalized(PetscBool *isFinalized) 176e5c89e4eSSatish Balay { 177e5c89e4eSSatish Balay *isFinalized = PetscFinalizeCalled; 17893b6d2d1SJed Brown return 0; 179e5c89e4eSSatish Balay } 180e5c89e4eSSatish Balay 18109573ac7SBarry Smith extern PetscErrorCode PetscOptionsCheckInitial_Private(void); 182e5c89e4eSSatish Balay 183e5c89e4eSSatish Balay /* 184e5c89e4eSSatish Balay This function is the MPI reduction operation used to compute the sum of the 185e5c89e4eSSatish Balay first half of the datatype and the max of the second half. 186e5c89e4eSSatish Balay */ 187e5c89e4eSSatish Balay MPI_Op PetscMaxSum_Op = 0; 188e5c89e4eSSatish Balay 189e5c89e4eSSatish Balay #undef __FUNCT__ 190e5c89e4eSSatish Balay #define __FUNCT__ "PetscMaxSum_Local" 1918cc058d9SJed Brown PETSC_EXTERN void MPIAPI PetscMaxSum_Local(void *in,void *out,int *cnt,MPI_Datatype *datatype) 192e5c89e4eSSatish Balay { 193e5c89e4eSSatish Balay PetscInt *xin = (PetscInt*)in,*xout = (PetscInt*)out,i,count = *cnt; 194e5c89e4eSSatish Balay 195e5c89e4eSSatish Balay PetscFunctionBegin; 196e5c89e4eSSatish Balay if (*datatype != MPIU_2INT) { 197e5c89e4eSSatish Balay (*PetscErrorPrintf)("Can only handle MPIU_2INT data types"); 198e5c89e4eSSatish Balay MPI_Abort(MPI_COMM_WORLD,1); 199e5c89e4eSSatish Balay } 200e5c89e4eSSatish Balay 201e5c89e4eSSatish Balay for (i=0; i<count; i++) { 202e5c89e4eSSatish Balay xout[2*i] = PetscMax(xout[2*i],xin[2*i]); 203e5c89e4eSSatish Balay xout[2*i+1] += xin[2*i+1]; 204e5c89e4eSSatish Balay } 205812af9f3SBarry Smith PetscFunctionReturnVoid(); 206e5c89e4eSSatish Balay } 207e5c89e4eSSatish Balay 208e5c89e4eSSatish Balay /* 209e5c89e4eSSatish Balay Returns the max of the first entry owned by this processor and the 210e5c89e4eSSatish Balay sum of the second entry. 211b693b147SBarry Smith 212b693b147SBarry Smith The reason nprocs[2*i] contains lengths nprocs[2*i+1] contains flag of 1 if length is nonzero 213b693b147SBarry Smith is so that the PetscMaxSum_Op() can set TWO values, if we passed in only nprocs[i] with lengths 214b693b147SBarry Smith there would be no place to store the both needed results. 215e5c89e4eSSatish Balay */ 216e5c89e4eSSatish Balay #undef __FUNCT__ 217e5c89e4eSSatish Balay #define __FUNCT__ "PetscMaxSum" 2187087cfbeSBarry Smith PetscErrorCode PetscMaxSum(MPI_Comm comm,const PetscInt nprocs[],PetscInt *max,PetscInt *sum) 219e5c89e4eSSatish Balay { 220e5c89e4eSSatish Balay PetscMPIInt size,rank; 2216ac3741eSJed Brown struct {PetscInt max,sum;} *work; 222e5c89e4eSSatish Balay PetscErrorCode ierr; 223e5c89e4eSSatish Balay 224e5c89e4eSSatish Balay PetscFunctionBegin; 225e5c89e4eSSatish Balay ierr = MPI_Comm_size(comm,&size);CHKERRQ(ierr); 226e5c89e4eSSatish Balay ierr = MPI_Comm_rank(comm,&rank);CHKERRQ(ierr); 2276ac3741eSJed Brown ierr = PetscMalloc(size*sizeof(*work),&work);CHKERRQ(ierr); 228e5c89e4eSSatish Balay ierr = MPI_Allreduce((void*)nprocs,work,size,MPIU_2INT,PetscMaxSum_Op,comm);CHKERRQ(ierr); 2296ac3741eSJed Brown *max = work[rank].max; 2306ac3741eSJed Brown *sum = work[rank].sum; 231e5c89e4eSSatish Balay ierr = PetscFree(work);CHKERRQ(ierr); 232e5c89e4eSSatish Balay PetscFunctionReturn(0); 233e5c89e4eSSatish Balay } 234e5c89e4eSSatish Balay 235e5c89e4eSSatish Balay /* ----------------------------------------------------------------------------*/ 2367087cfbeSBarry Smith MPI_Op PetscADMax_Op = 0; 237e5c89e4eSSatish Balay 238e5c89e4eSSatish Balay #undef __FUNCT__ 239e5c89e4eSSatish Balay #define __FUNCT__ "PetscADMax_Local" 2408cc058d9SJed Brown PETSC_EXTERN void MPIAPI PetscADMax_Local(void *in,void *out,PetscMPIInt *cnt,MPI_Datatype *datatype) 241e5c89e4eSSatish Balay { 242e5c89e4eSSatish Balay PetscScalar *xin = (PetscScalar*)in,*xout = (PetscScalar*)out; 243e5c89e4eSSatish Balay PetscInt i,count = *cnt; 244e5c89e4eSSatish Balay 245e5c89e4eSSatish Balay PetscFunctionBegin; 246e5c89e4eSSatish Balay if (*datatype != MPIU_2SCALAR) { 247e5c89e4eSSatish Balay (*PetscErrorPrintf)("Can only handle MPIU_2SCALAR data (i.e. double or complex) types"); 248e5c89e4eSSatish Balay MPI_Abort(MPI_COMM_WORLD,1); 249e5c89e4eSSatish Balay } 250e5c89e4eSSatish Balay 251e5c89e4eSSatish Balay for (i=0; i<count; i++) { 252e5c89e4eSSatish Balay if (PetscRealPart(xout[2*i]) < PetscRealPart(xin[2*i])) { 253e5c89e4eSSatish Balay xout[2*i] = xin[2*i]; 254e5c89e4eSSatish Balay xout[2*i+1] = xin[2*i+1]; 255e5c89e4eSSatish Balay } 256e5c89e4eSSatish Balay } 257812af9f3SBarry Smith PetscFunctionReturnVoid(); 258e5c89e4eSSatish Balay } 259e5c89e4eSSatish Balay 2607087cfbeSBarry Smith MPI_Op PetscADMin_Op = 0; 261e5c89e4eSSatish Balay 262e5c89e4eSSatish Balay #undef __FUNCT__ 263e5c89e4eSSatish Balay #define __FUNCT__ "PetscADMin_Local" 2648cc058d9SJed Brown PETSC_EXTERN void MPIAPI PetscADMin_Local(void *in,void *out,PetscMPIInt *cnt,MPI_Datatype *datatype) 265e5c89e4eSSatish Balay { 266e5c89e4eSSatish Balay PetscScalar *xin = (PetscScalar*)in,*xout = (PetscScalar*)out; 267e5c89e4eSSatish Balay PetscInt i,count = *cnt; 268e5c89e4eSSatish Balay 269e5c89e4eSSatish Balay PetscFunctionBegin; 270e5c89e4eSSatish Balay if (*datatype != MPIU_2SCALAR) { 271e5c89e4eSSatish Balay (*PetscErrorPrintf)("Can only handle MPIU_2SCALAR data (i.e. double or complex) types"); 272e5c89e4eSSatish Balay MPI_Abort(MPI_COMM_WORLD,1); 273e5c89e4eSSatish Balay } 274e5c89e4eSSatish Balay 275e5c89e4eSSatish Balay for (i=0; i<count; i++) { 276e5c89e4eSSatish Balay if (PetscRealPart(xout[2*i]) > PetscRealPart(xin[2*i])) { 277e5c89e4eSSatish Balay xout[2*i] = xin[2*i]; 278e5c89e4eSSatish Balay xout[2*i+1] = xin[2*i+1]; 279e5c89e4eSSatish Balay } 280e5c89e4eSSatish Balay } 281812af9f3SBarry Smith PetscFunctionReturnVoid(); 282e5c89e4eSSatish Balay } 283e5c89e4eSSatish Balay /* ---------------------------------------------------------------------------------------*/ 284e5c89e4eSSatish Balay 2857c2de775SJed Brown #if (defined(PETSC_HAVE_COMPLEX) && !defined(PETSC_HAVE_MPI_C_DOUBLE_COMPLEX)) || defined(PETSC_USE_REAL___FLOAT128) 28606a205a8SBarry Smith MPI_Op MPIU_SUM = 0; 287e5c89e4eSSatish Balay 288e5c89e4eSSatish Balay #undef __FUNCT__ 289e5c89e4eSSatish Balay #define __FUNCT__ "PetscSum_Local" 2908cc058d9SJed Brown PETSC_EXTERN void PetscSum_Local(void *in,void *out,PetscMPIInt *cnt,MPI_Datatype *datatype) 291e5c89e4eSSatish Balay { 292e5c89e4eSSatish Balay PetscInt i,count = *cnt; 293e5c89e4eSSatish Balay 294e5c89e4eSSatish Balay PetscFunctionBegin; 2957c2de775SJed Brown if (*datatype == MPIU_REAL) { 296e2e03761SBarry Smith PetscReal *xin = (PetscReal*)in,*xout = (PetscReal*)out; 297a297a907SKarl Rupp for (i=0; i<count; i++) xout[i] += xin[i]; 2987c2de775SJed Brown } 2997c2de775SJed Brown #if defined(PETSC_HAVE_COMPLEX) 3007c2de775SJed Brown else if (*datatype == MPIU_COMPLEX) { 3017c2de775SJed Brown PetscComplex *xin = (PetscComplex*)in,*xout = (PetscComplex*)out; 302a297a907SKarl Rupp for (i=0; i<count; i++) xout[i] += xin[i]; 3037c2de775SJed Brown } 3047c2de775SJed Brown #endif 3057c2de775SJed Brown else { 3067c2de775SJed Brown (*PetscErrorPrintf)("Can only handle MPIU_REAL or MPIU_COMPLEX data types"); 307e2e03761SBarry Smith MPI_Abort(MPI_COMM_WORLD,1); 308e2e03761SBarry Smith } 309812af9f3SBarry Smith PetscFunctionReturnVoid(); 310e5c89e4eSSatish Balay } 311e5c89e4eSSatish Balay #endif 312e5c89e4eSSatish Balay 313ce63c4c1SBarry Smith #if defined(PETSC_USE_REAL___FLOAT128) 314d9822059SBarry Smith MPI_Op MPIU_MAX = 0; 315d9822059SBarry Smith MPI_Op MPIU_MIN = 0; 316d9822059SBarry Smith 317d9822059SBarry Smith #undef __FUNCT__ 318d9822059SBarry Smith #define __FUNCT__ "PetscMax_Local" 3198cc058d9SJed Brown PETSC_EXTERN void PetscMax_Local(void *in,void *out,PetscMPIInt *cnt,MPI_Datatype *datatype) 320d9822059SBarry Smith { 321d9822059SBarry Smith PetscInt i,count = *cnt; 322d9822059SBarry Smith 323d9822059SBarry Smith PetscFunctionBegin; 3247c2de775SJed Brown if (*datatype == MPIU_REAL) { 3258c764dc5SJose Roman PetscReal *xin = (PetscReal*)in,*xout = (PetscReal*)out; 326a297a907SKarl Rupp for (i=0; i<count; i++) xout[i] = PetscMax(xout[i],xin[i]); 3277c2de775SJed Brown } 3287c2de775SJed Brown #if defined(PETSC_HAVE_COMPLEX) 3297c2de775SJed Brown else if (*datatype == MPIU_COMPLEX) { 3307c2de775SJed Brown PetscComplex *xin = (PetscComplex*)in,*xout = (PetscComplex*)out; 3317c2de775SJed Brown for (i=0; i<count; i++) { 3327c2de775SJed Brown xout[i] = PetscRealPartComplex(xout[i])<PetscRealPartComplex(xin[i]) ? xin[i] : xout[i]; 3337c2de775SJed Brown } 3347c2de775SJed Brown } 3357c2de775SJed Brown #endif 3367c2de775SJed Brown else { 3377c2de775SJed Brown (*PetscErrorPrintf)("Can only handle MPIU_REAL or MPIU_COMPLEX data types"); 3388c764dc5SJose Roman MPI_Abort(MPI_COMM_WORLD,1); 3398c764dc5SJose Roman } 340d9822059SBarry Smith PetscFunctionReturnVoid(); 341d9822059SBarry Smith } 342d9822059SBarry Smith 343d9822059SBarry Smith #undef __FUNCT__ 344d9822059SBarry Smith #define __FUNCT__ "PetscMin_Local" 3458cc058d9SJed Brown PETSC_EXTERN void PetscMin_Local(void *in,void *out,PetscMPIInt *cnt,MPI_Datatype *datatype) 346d9822059SBarry Smith { 347d9822059SBarry Smith PetscInt i,count = *cnt; 348d9822059SBarry Smith 349d9822059SBarry Smith PetscFunctionBegin; 3507c2de775SJed Brown if (*datatype == MPIU_REAL) { 3518c764dc5SJose Roman PetscReal *xin = (PetscReal*)in,*xout = (PetscReal*)out; 352a297a907SKarl Rupp for (i=0; i<count; i++) xout[i] = PetscMin(xout[i],xin[i]); 3537c2de775SJed Brown } 3547c2de775SJed Brown #if defined(PETSC_HAVE_COMPLEX) 3557c2de775SJed Brown else if (*datatype == MPIU_COMPLEX) { 3567c2de775SJed Brown PetscComplex *xin = (PetscComplex*)in,*xout = (PetscComplex*)out; 3577c2de775SJed Brown for (i=0; i<count; i++) { 3587c2de775SJed Brown xout[i] = PetscRealPartComplex(xout[i])>PetscRealPartComplex(xin[i]) ? xin[i] : xout[i]; 3597c2de775SJed Brown } 3607c2de775SJed Brown } 3617c2de775SJed Brown #endif 3627c2de775SJed Brown else { 3638c764dc5SJose Roman (*PetscErrorPrintf)("Can only handle MPIU_REAL or MPIU_SCALAR data (i.e. double or complex) types"); 3648c764dc5SJose Roman MPI_Abort(MPI_COMM_WORLD,1); 3658c764dc5SJose Roman } 366d9822059SBarry Smith PetscFunctionReturnVoid(); 367d9822059SBarry Smith } 368d9822059SBarry Smith #endif 369d9822059SBarry Smith 370480cf27aSJed Brown #undef __FUNCT__ 371480cf27aSJed Brown #define __FUNCT__ "Petsc_DelCounter" 372480cf27aSJed Brown /* 373480cf27aSJed Brown Private routine to delete internal tag/name counter storage when a communicator is freed. 374480cf27aSJed Brown 375ff0e51ddSBarry 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. 376480cf27aSJed Brown 377480cf27aSJed Brown Note: this is declared extern "C" because it is passed to MPI_Keyval_create() 378480cf27aSJed Brown 379480cf27aSJed Brown */ 3808cc058d9SJed Brown PETSC_EXTERN PetscMPIInt MPIAPI Petsc_DelCounter(MPI_Comm comm,PetscMPIInt keyval,void *count_val,void *extra_state) 381480cf27aSJed Brown { 382480cf27aSJed Brown PetscErrorCode ierr; 383480cf27aSJed Brown 384480cf27aSJed Brown PetscFunctionBegin; 385480cf27aSJed Brown ierr = PetscInfo1(0,"Deleting counter data in an MPI_Comm %ld\n",(long)comm);if (ierr) PetscFunctionReturn((PetscMPIInt)ierr); 386480cf27aSJed Brown ierr = PetscFree(count_val);if (ierr) PetscFunctionReturn((PetscMPIInt)ierr); 387480cf27aSJed Brown PetscFunctionReturn(MPI_SUCCESS); 388480cf27aSJed Brown } 389480cf27aSJed Brown 390480cf27aSJed Brown #undef __FUNCT__ 391da3039f7SJed Brown #define __FUNCT__ "Petsc_DelComm_Outer" 392480cf27aSJed Brown /* 393da3039f7SJed Brown This is invoked on the outer comm as a result of either PetscCommDestroy() (via MPI_Attr_delete) or when the user 394da3039f7SJed Brown calls MPI_Comm_free(). 395da3039f7SJed Brown 396da3039f7SJed Brown This is the only entry point for breaking the links between inner and outer comms. 397480cf27aSJed Brown 398ff0e51ddSBarry Smith This is called by MPI, not by users. This is called when MPI_Comm_free() is called on the communicator. 399480cf27aSJed Brown 400480cf27aSJed Brown Note: this is declared extern "C" because it is passed to MPI_Keyval_create() 401480cf27aSJed Brown 402480cf27aSJed Brown */ 403da3039f7SJed Brown PETSC_EXTERN PetscMPIInt MPIAPI Petsc_DelComm_Outer(MPI_Comm comm,PetscMPIInt keyval,void *attr_val,void *extra_state) 404480cf27aSJed Brown { 405480cf27aSJed Brown PetscErrorCode ierr; 406b89831e5SBarry Smith PetscMPIInt flg; 407265f3f35SJed Brown union {MPI_Comm comm; void *ptr;} icomm,ocomm; 408480cf27aSJed Brown 409480cf27aSJed Brown PetscFunctionBegin; 410da3039f7SJed Brown if (keyval != Petsc_InnerComm_keyval) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_CORRUPT,"Unexpected keyval"); 411ec4fadc2SJed Brown icomm.ptr = attr_val; 412da3039f7SJed Brown 413265f3f35SJed Brown ierr = MPI_Attr_get(icomm.comm,Petsc_OuterComm_keyval,&ocomm,&flg);CHKERRQ(ierr); 414b3ef52cdSBarry Smith if (!flg) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_CORRUPT,"Inner MPI_Comm does not have expected reference to outer comm"); 415da3039f7SJed Brown if (ocomm.comm != comm) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_CORRUPT,"Inner MPI_Comm has reference to non-matching outer comm"); 416da3039f7SJed Brown ierr = MPI_Attr_delete(icomm.comm,Petsc_OuterComm_keyval);CHKERRQ(ierr); /* Calls Petsc_DelComm_Inner */ 417da3039f7SJed Brown ierr = PetscInfo1(0,"User MPI_Comm %ld is being freed after removing reference from inner PETSc comm to this outer comm\n",(long)comm);if (ierr) PetscFunctionReturn((PetscMPIInt)ierr); 418da3039f7SJed Brown PetscFunctionReturn(MPI_SUCCESS); 419b89831e5SBarry Smith } 420da3039f7SJed Brown 421da3039f7SJed Brown #undef __FUNCT__ 422da3039f7SJed Brown #define __FUNCT__ "Petsc_DelComm_Inner" 423da3039f7SJed Brown /* 424da3039f7SJed Brown * This is invoked on the inner comm when Petsc_DelComm_Outer calls MPI_Attr_delete. It should not be reached any other way. 425da3039f7SJed Brown */ 426da3039f7SJed Brown PETSC_EXTERN PetscMPIInt MPIAPI Petsc_DelComm_Inner(MPI_Comm comm,PetscMPIInt keyval,void *attr_val,void *extra_state) 427da3039f7SJed Brown { 428da3039f7SJed Brown PetscErrorCode ierr; 429da3039f7SJed Brown 430da3039f7SJed Brown PetscFunctionBegin; 431da3039f7SJed Brown ierr = PetscInfo1(0,"Removing reference to PETSc communicator embedded in a user MPI_Comm %ld\n",(long)comm);if (ierr) PetscFunctionReturn((PetscMPIInt)ierr); 432480cf27aSJed Brown PetscFunctionReturn(MPI_SUCCESS); 433480cf27aSJed Brown } 434480cf27aSJed Brown 435951e3c8eSBarry Smith #if defined(PETSC_USE_PETSC_MPI_EXTERNAL32) 436e39fd77fSBarry Smith #if !defined(PETSC_WORDS_BIGENDIAN) 4378cc058d9SJed Brown PETSC_EXTERN PetscMPIInt PetscDataRep_extent_fn(MPI_Datatype,MPI_Aint*,void*); 4388cc058d9SJed Brown PETSC_EXTERN PetscMPIInt PetscDataRep_read_conv_fn(void*, MPI_Datatype,PetscMPIInt,void*,MPI_Offset,void*); 4398cc058d9SJed Brown PETSC_EXTERN PetscMPIInt PetscDataRep_write_conv_fn(void*, MPI_Datatype,PetscMPIInt,void*,MPI_Offset,void*); 440e39fd77fSBarry Smith #endif 441951e3c8eSBarry Smith #endif 442e39fd77fSBarry Smith 4436ae9a8a6SBarry Smith int PetscGlobalArgc = 0; 4446ae9a8a6SBarry Smith char **PetscGlobalArgs = 0; 445dff31646SBarry Smith PetscSegBuffer PetscCitationsList; 446e5c89e4eSSatish Balay 447e5c89e4eSSatish Balay #undef __FUNCT__ 448051e4cf2SJed Brown #define __FUNCT__ "PetscCitationsInitialize" 449051e4cf2SJed Brown PetscErrorCode PetscCitationsInitialize() 450051e4cf2SJed Brown { 451051e4cf2SJed Brown PetscErrorCode ierr; 452051e4cf2SJed Brown 453051e4cf2SJed Brown PetscFunctionBegin; 454051e4cf2SJed Brown ierr = PetscSegBufferCreate(1,10000,&PetscCitationsList);CHKERRQ(ierr); 455051e4cf2SJed Brown ierr = PetscCitationsRegister("@TechReport{petsc-user-ref,\n Author = {Satish Balay and Jed Brown and and Kris Buschelman and Victor Eijkhout\n and William D. Gropp and Dinesh Kaushik and Matthew G. Knepley\n and Lois Curfman McInnes and Barry F. Smith and Hong Zhang},\n Title = {{PETS}c Users Manual},\n Number = {ANL-95/11 - Revision 3.4},\n Institution = {Argonne National Laboratory},\n Year = {2013}\n}\n",NULL);CHKERRQ(ierr); 456051e4cf2SJed 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); 457051e4cf2SJed Brown PetscFunctionReturn(0); 458051e4cf2SJed Brown } 459e5c89e4eSSatish Balay 460e5c89e4eSSatish Balay #undef __FUNCT__ 461e5c89e4eSSatish Balay #define __FUNCT__ "PetscGetArgs" 462e5c89e4eSSatish Balay /*@C 463e5c89e4eSSatish Balay PetscGetArgs - Allows you to access the raw command line arguments anywhere 464e5c89e4eSSatish Balay after PetscInitialize() is called but before PetscFinalize(). 465e5c89e4eSSatish Balay 466e5c89e4eSSatish Balay Not Collective 467e5c89e4eSSatish Balay 468e5c89e4eSSatish Balay Output Parameters: 469e5c89e4eSSatish Balay + argc - count of number of command line arguments 470e5c89e4eSSatish Balay - args - the command line arguments 471e5c89e4eSSatish Balay 472e5c89e4eSSatish Balay Level: intermediate 473e5c89e4eSSatish Balay 474e5c89e4eSSatish Balay Notes: 475e5c89e4eSSatish Balay This is usually used to pass the command line arguments into other libraries 476e5c89e4eSSatish Balay that are called internally deep in PETSc or the application. 477e5c89e4eSSatish Balay 478f177e3b1SBarry Smith The first argument contains the program name as is normal for C arguments. 479f177e3b1SBarry Smith 480e5c89e4eSSatish Balay Concepts: command line arguments 481e5c89e4eSSatish Balay 482793721a6SBarry Smith .seealso: PetscFinalize(), PetscInitializeFortran(), PetscGetArguments() 483e5c89e4eSSatish Balay 484e5c89e4eSSatish Balay @*/ 4857087cfbeSBarry Smith PetscErrorCode PetscGetArgs(int *argc,char ***args) 486e5c89e4eSSatish Balay { 487e5c89e4eSSatish Balay PetscFunctionBegin; 48817186662SBarry Smith if (!PetscInitializeCalled && PetscFinalizeCalled) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ORDER,"You must call after PetscInitialize() but before PetscFinalize()"); 489e5c89e4eSSatish Balay *argc = PetscGlobalArgc; 490e5c89e4eSSatish Balay *args = PetscGlobalArgs; 491e5c89e4eSSatish Balay PetscFunctionReturn(0); 492e5c89e4eSSatish Balay } 493e5c89e4eSSatish Balay 494e5c89e4eSSatish Balay #undef __FUNCT__ 495793721a6SBarry Smith #define __FUNCT__ "PetscGetArguments" 496793721a6SBarry Smith /*@C 497793721a6SBarry Smith PetscGetArguments - Allows you to access the command line arguments anywhere 498793721a6SBarry Smith after PetscInitialize() is called but before PetscFinalize(). 499793721a6SBarry Smith 500793721a6SBarry Smith Not Collective 501793721a6SBarry Smith 502793721a6SBarry Smith Output Parameters: 503793721a6SBarry Smith . args - the command line arguments 504793721a6SBarry Smith 505793721a6SBarry Smith Level: intermediate 506793721a6SBarry Smith 507793721a6SBarry Smith Notes: 508793721a6SBarry Smith This does NOT start with the program name and IS null terminated (final arg is void) 509793721a6SBarry Smith 510793721a6SBarry Smith Concepts: command line arguments 511793721a6SBarry Smith 512793721a6SBarry Smith .seealso: PetscFinalize(), PetscInitializeFortran(), PetscGetArgs(), PetscFreeArguments() 513793721a6SBarry Smith 514793721a6SBarry Smith @*/ 5157087cfbeSBarry Smith PetscErrorCode PetscGetArguments(char ***args) 516793721a6SBarry Smith { 517793721a6SBarry Smith PetscInt i,argc = PetscGlobalArgc; 518793721a6SBarry Smith PetscErrorCode ierr; 519793721a6SBarry Smith 520793721a6SBarry Smith PetscFunctionBegin; 52117186662SBarry Smith if (!PetscInitializeCalled && PetscFinalizeCalled) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ORDER,"You must call after PetscInitialize() but before PetscFinalize()"); 522717030eeSLisandro Dalcin if (!argc) {*args = 0; PetscFunctionReturn(0);} 523793721a6SBarry Smith ierr = PetscMalloc(argc*sizeof(char*),args);CHKERRQ(ierr); 524793721a6SBarry Smith for (i=0; i<argc-1; i++) { 525793721a6SBarry Smith ierr = PetscStrallocpy(PetscGlobalArgs[i+1],&(*args)[i]);CHKERRQ(ierr); 526793721a6SBarry Smith } 527793721a6SBarry Smith (*args)[argc-1] = 0; 528793721a6SBarry Smith PetscFunctionReturn(0); 529793721a6SBarry Smith } 530793721a6SBarry Smith 531793721a6SBarry Smith #undef __FUNCT__ 532793721a6SBarry Smith #define __FUNCT__ "PetscFreeArguments" 533793721a6SBarry Smith /*@C 534793721a6SBarry Smith PetscFreeArguments - Frees the memory obtained with PetscGetArguments() 535793721a6SBarry Smith 536793721a6SBarry Smith Not Collective 537793721a6SBarry Smith 538793721a6SBarry Smith Output Parameters: 539793721a6SBarry Smith . args - the command line arguments 540793721a6SBarry Smith 541793721a6SBarry Smith Level: intermediate 542793721a6SBarry Smith 543793721a6SBarry Smith Concepts: command line arguments 544793721a6SBarry Smith 545793721a6SBarry Smith .seealso: PetscFinalize(), PetscInitializeFortran(), PetscGetArgs(), PetscGetArguments() 546793721a6SBarry Smith 547793721a6SBarry Smith @*/ 5487087cfbeSBarry Smith PetscErrorCode PetscFreeArguments(char **args) 549793721a6SBarry Smith { 550793721a6SBarry Smith PetscInt i = 0; 551793721a6SBarry Smith PetscErrorCode ierr; 552793721a6SBarry Smith 553793721a6SBarry Smith PetscFunctionBegin; 554a297a907SKarl Rupp if (!args) PetscFunctionReturn(0); 555793721a6SBarry Smith while (args[i]) { 556793721a6SBarry Smith ierr = PetscFree(args[i]);CHKERRQ(ierr); 557793721a6SBarry Smith i++; 558793721a6SBarry Smith } 559793721a6SBarry Smith ierr = PetscFree(args);CHKERRQ(ierr); 560793721a6SBarry Smith PetscFunctionReturn(0); 561793721a6SBarry Smith } 562793721a6SBarry Smith 563793721a6SBarry Smith #undef __FUNCT__ 564e5c89e4eSSatish Balay #define __FUNCT__ "PetscInitialize" 565e5c89e4eSSatish Balay /*@C 566e5c89e4eSSatish Balay PetscInitialize - Initializes the PETSc database and MPI. 567e5c89e4eSSatish Balay PetscInitialize() calls MPI_Init() if that has yet to be called, 568e5c89e4eSSatish Balay so this routine should always be called near the beginning of 569e5c89e4eSSatish Balay your program -- usually the very first line! 570e5c89e4eSSatish Balay 571e5c89e4eSSatish Balay Collective on MPI_COMM_WORLD or PETSC_COMM_WORLD if it has been set 572e5c89e4eSSatish Balay 573e5c89e4eSSatish Balay Input Parameters: 574e5c89e4eSSatish Balay + argc - count of number of command line arguments 575e5c89e4eSSatish Balay . args - the command line arguments 5760298fd71SBarry Smith . file - [optional] PETSc database file, also checks ~username/.petscrc and .petscrc use NULL to not check for 577fc2bca9aSBarry Smith code specific file. Use -skip_petscrc in the code specific file to skip the .petscrc files 5780298fd71SBarry Smith - help - [optional] Help message to print, use NULL for no message 579e5c89e4eSSatish Balay 58005827820SBarry Smith If you wish PETSc code to run ONLY on a subcommunicator of MPI_COMM_WORLD, create that 58105827820SBarry Smith communicator first and assign it to PETSC_COMM_WORLD BEFORE calling PetscInitialize(). Thus if you are running a 58205827820SBarry Smith four process job and two processes will run PETSc and have PetscInitialize() and PetscFinalize() and two process will not, 58305827820SBarry Smith then do this. If ALL processes in the job are using PetscInitialize() and PetscFinalize() then you don't need to do this, even 58405827820SBarry Smith if different subcommunicators of the job are doing different things with PETSc. 585e5c89e4eSSatish Balay 586e5c89e4eSSatish Balay Options Database Keys: 587e5c89e4eSSatish Balay + -start_in_debugger [noxterm,dbx,xdb,gdb,...] - Starts program in debugger 588e5c89e4eSSatish Balay . -on_error_attach_debugger [noxterm,dbx,xdb,gdb,...] - Starts debugger when error detected 589e5c89e4eSSatish Balay . -on_error_emacs <machinename> causes emacsclient to jump to error file 590b52f573bSBarry Smith . -on_error_abort calls abort() when error detected (no traceback) 591e8fb0fc0SBarry Smith . -on_error_mpiabort calls MPI_abort() when error detected 592e8fb0fc0SBarry Smith . -error_output_stderr prints error messages to stderr instead of the default stdout 593e8fb0fc0SBarry Smith . -error_output_none does not print the error messages (but handles errors in the same way as if this was not called) 594e5c89e4eSSatish Balay . -debugger_nodes [node1,node2,...] - Indicates nodes to start in debugger 595e5c89e4eSSatish Balay . -debugger_pause [sleeptime] (in seconds) - Pauses debugger 596e5c89e4eSSatish Balay . -stop_for_debugger - Print message on how to attach debugger manually to 597e5c89e4eSSatish Balay process and wait (-debugger_pause) seconds for attachment 5982fb0ec9aSBarry Smith . -malloc - Indicates use of PETSc error-checking malloc (on by default for debug version of libraries) 599e5c89e4eSSatish Balay . -malloc no - Indicates not to use error-checking malloc 6002fb0ec9aSBarry Smith . -malloc_debug - check for memory corruption at EVERY malloc or free 601dc92acbaSJed Brown . -malloc_test - like -malloc_dump -malloc_debug, but only active for debugging builds 602e5c89e4eSSatish Balay . -fp_trap - Stops on floating point exceptions (Note that on the 603e5c89e4eSSatish Balay IBM RS6000 this slows code by at least a factor of 10.) 604e5c89e4eSSatish Balay . -no_signal_handler - Indicates not to trap error signals 605e5c89e4eSSatish Balay . -shared_tmp - indicates /tmp directory is shared by all processors 606e5c89e4eSSatish Balay . -not_shared_tmp - each processor has own /tmp 607e5c89e4eSSatish Balay . -tmp - alternative name of /tmp directory 608e5c89e4eSSatish Balay . -get_total_flops - returns total flops done by all processors 60940ab9619SBarry Smith . -memory_info - Print memory usage at end of run 61040ab9619SBarry Smith - -server <port> - start PETSc webserver (default port is 8080) 611e5c89e4eSSatish Balay 612e5c89e4eSSatish Balay Options Database Keys for Profiling: 6130598bfebSBarry Smith See the <a href="../../docs/manual.pdf#nameddest=ch_profiling">profiling chapter of the users manual</a> for details. 614495fc317SBarry Smith + -info <optional filename> - Prints verbose information to the screen 615495fc317SBarry Smith . -info_exclude <null,vec,mat,pc,ksp,snes,ts> - Excludes some of the verbose messages 616495fc317SBarry Smith . -log_sync - Log the synchronization in scatters, inner products and norms 617495fc317SBarry Smith . -log_trace [filename] - Print traces of all PETSc calls to the screen (useful to determine where a program 618e5c89e4eSSatish Balay hangs without running in the debugger). See PetscLogTraceBegin(). 619495fc317SBarry Smith . -log_summary [filename] - Prints summary of flop and timing information to screen. If the filename is specified the 620495fc317SBarry Smith summary is written to the file. See PetscLogView(). 621495fc317SBarry Smith . -log_summary_python [filename] - Prints data on of flop and timing usage to a file or screen. See PetscLogPrintSViewPython(). 622495fc317SBarry Smith . -log_all [filename] - Logs extensive profiling information See PetscLogDump(). 623495fc317SBarry Smith . -log [filename] - Logs basic profiline information See PetscLogDump(). 624495fc317SBarry Smith - -log_mpe [filename] - Creates a logfile viewable by the utility Jumpshot (in MPICH distribution) 625495fc317SBarry Smith 626495fc317SBarry Smith Only one of -log_trace, -log_summary, -log_all, -log, or -log_mpe may be used at a time 627e5c89e4eSSatish Balay 628e5c89e4eSSatish Balay Environmental Variables: 629e5c89e4eSSatish Balay + PETSC_TMP - alternative tmp directory 630e5c89e4eSSatish Balay . PETSC_SHARED_TMP - tmp is shared by all processes 631e5c89e4eSSatish Balay . PETSC_NOT_SHARED_TMP - each process has its own private tmp 632e5c89e4eSSatish Balay . PETSC_VIEWER_SOCKET_PORT - socket number to use for socket viewer 633e5c89e4eSSatish Balay - PETSC_VIEWER_SOCKET_MACHINE - machine to use for socket viewer to connect to 634e5c89e4eSSatish Balay 635e5c89e4eSSatish Balay 636e5c89e4eSSatish Balay Level: beginner 637e5c89e4eSSatish Balay 638e5c89e4eSSatish Balay Notes: 639e5c89e4eSSatish Balay If for some reason you must call MPI_Init() separately, call 640e5c89e4eSSatish Balay it before PetscInitialize(). 641e5c89e4eSSatish Balay 642e5c89e4eSSatish Balay Fortran Version: 643e5c89e4eSSatish Balay In Fortran this routine has the format 644e5c89e4eSSatish Balay $ call PetscInitialize(file,ierr) 645e5c89e4eSSatish Balay 646e5c89e4eSSatish Balay + ierr - error return code 6470298fd71SBarry Smith - file - [optional] PETSc database file, also checks ~username/.petscrc and .petscrc use NULL_CHARACTER to not check for 648fc2bca9aSBarry Smith code specific file. Use -skip_petscrc in the code specific file to skip the .petscrc files 649e5c89e4eSSatish Balay 650e5c89e4eSSatish Balay Important Fortran Note: 6510298fd71SBarry Smith In Fortran, you MUST use NULL_CHARACTER to indicate a 6520298fd71SBarry Smith null character string; you CANNOT just use NULL as 6530598bfebSBarry Smith in the C version. See the <a href="../../docs/manual.pdf">users manual</a> for details. 654e5c89e4eSSatish Balay 65501cb0274SBarry Smith If your main program is C but you call Fortran code that also uses PETSc you need to call PetscInitializeFortran() soon after 65601cb0274SBarry Smith calling PetscInitialize(). 657e5c89e4eSSatish Balay 658e5c89e4eSSatish Balay Concepts: initializing PETSc 659e5c89e4eSSatish Balay 66001cb0274SBarry Smith .seealso: PetscFinalize(), PetscInitializeFortran(), PetscGetArgs(), PetscInitializeNoArguments() 661e5c89e4eSSatish Balay 662e5c89e4eSSatish Balay @*/ 6637087cfbeSBarry Smith PetscErrorCode PetscInitialize(int *argc,char ***args,const char file[],const char help[]) 664e5c89e4eSSatish Balay { 665e5c89e4eSSatish Balay PetscErrorCode ierr; 6664bb5149bSJed Brown PetscMPIInt flag, size; 667aa5bb8c0SSatish Balay PetscInt nodesize; 668ace3abfcSBarry Smith PetscBool flg; 669e5c89e4eSSatish Balay char hostname[256]; 670e5c89e4eSSatish Balay 671e5c89e4eSSatish Balay PetscFunctionBegin; 672e5c89e4eSSatish Balay if (PetscInitializeCalled) PetscFunctionReturn(0); 673e5c89e4eSSatish Balay 674ae9b4142SLisandro Dalcin /* these must be initialized in a routine, not as a constant declaration*/ 675d89683f4Sbcordonn PETSC_STDOUT = stdout; 676ae9b4142SLisandro Dalcin PETSC_STDERR = stderr; 677e5c89e4eSSatish Balay 678e5c89e4eSSatish Balay ierr = PetscOptionsCreate();CHKERRQ(ierr); 679e5c89e4eSSatish Balay 680e5c89e4eSSatish Balay /* 681e5c89e4eSSatish Balay We initialize the program name here (before MPI_Init()) because MPICH has a bug in 682e5c89e4eSSatish Balay it that it sets args[0] on all processors to be args[0] on the first processor. 683e5c89e4eSSatish Balay */ 684e5c89e4eSSatish Balay if (argc && *argc) { 685e5c89e4eSSatish Balay ierr = PetscSetProgramName(**args);CHKERRQ(ierr); 686e5c89e4eSSatish Balay } else { 687e5c89e4eSSatish Balay ierr = PetscSetProgramName("Unknown Name");CHKERRQ(ierr); 688e5c89e4eSSatish Balay } 689e5c89e4eSSatish Balay 690e5c89e4eSSatish Balay ierr = MPI_Initialized(&flag);CHKERRQ(ierr); 691e5c89e4eSSatish Balay if (!flag) { 692e32f2f54SBarry 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"); 6935e765c61SJed Brown #if defined(PETSC_HAVE_MPI_INIT_THREAD) 6945e765c61SJed Brown { 6955e765c61SJed Brown PetscMPIInt provided; 6965e765c61SJed Brown ierr = MPI_Init_thread(argc,args,MPI_THREAD_FUNNELED,&provided);CHKERRQ(ierr); 6975e765c61SJed Brown } 6985e765c61SJed Brown #else 699e5c89e4eSSatish Balay ierr = MPI_Init(argc,args);CHKERRQ(ierr); 7005e765c61SJed Brown #endif 701e5c89e4eSSatish Balay PetscBeganMPI = PETSC_TRUE; 702e5c89e4eSSatish Balay } 703e5c89e4eSSatish Balay if (argc && args) { 704e5c89e4eSSatish Balay PetscGlobalArgc = *argc; 705e5c89e4eSSatish Balay PetscGlobalArgs = *args; 706e5c89e4eSSatish Balay } 707e5c89e4eSSatish Balay PetscFinalizeCalled = PETSC_FALSE; 708e5c89e4eSSatish Balay 709a297a907SKarl Rupp if (PETSC_COMM_WORLD == MPI_COMM_NULL) PETSC_COMM_WORLD = MPI_COMM_WORLD; 710d54338ecSKarl Rupp ierr = MPI_Comm_set_errhandler(PETSC_COMM_WORLD,MPI_ERRORS_RETURN);CHKERRQ(ierr); 711e5c89e4eSSatish Balay 712e5c89e4eSSatish Balay /* Done after init due to a bug in MPICH-GM? */ 713e5c89e4eSSatish Balay ierr = PetscErrorPrintfInitialize();CHKERRQ(ierr); 714e5c89e4eSSatish Balay 715e5c89e4eSSatish Balay ierr = MPI_Comm_rank(MPI_COMM_WORLD,&PetscGlobalRank);CHKERRQ(ierr); 716e5c89e4eSSatish Balay ierr = MPI_Comm_size(MPI_COMM_WORLD,&PetscGlobalSize);CHKERRQ(ierr); 717e5c89e4eSSatish Balay 7188ad47952SJed Brown MPIU_BOOL = MPI_INT; 7198ad47952SJed Brown MPIU_ENUM = MPI_INT; 7208ad47952SJed Brown 721e5c89e4eSSatish Balay /* 722e5c89e4eSSatish Balay Initialized the global complex variable; this is because with 723e5c89e4eSSatish Balay shared libraries the constructors for global variables 724e5c89e4eSSatish Balay are not called; at least on IRIX. 725e5c89e4eSSatish Balay */ 726886cfec0SSatish Balay #if defined(PETSC_HAVE_COMPLEX) 727e5c89e4eSSatish Balay { 728a24ee22aSSatish Balay #if defined(PETSC_CLANGUAGE_CXX) 72950f81f78SJed Brown PetscComplex ic(0.0,1.0); 730e5c89e4eSSatish Balay PETSC_i = ic; 731a24ee22aSSatish Balay #elif defined(PETSC_CLANGUAGE_C) 73250f81f78SJed Brown PETSC_i = _Complex_I; 733b7940d39SSatish Balay #endif 734762437b8SSatish Balay } 735762437b8SSatish Balay 7362c876bd9SBarry Smith #if !defined(PETSC_HAVE_MPI_C_DOUBLE_COMPLEX) 737e69cd0e6SSatish Balay ierr = MPI_Type_contiguous(2,MPI_DOUBLE,&MPIU_C_DOUBLE_COMPLEX);CHKERRQ(ierr); 738500d8756SSatish Balay ierr = MPI_Type_commit(&MPIU_C_DOUBLE_COMPLEX);CHKERRQ(ierr); 739500d8756SSatish Balay ierr = MPI_Type_contiguous(2,MPI_FLOAT,&MPIU_C_COMPLEX);CHKERRQ(ierr); 740500d8756SSatish Balay ierr = MPI_Type_commit(&MPIU_C_COMPLEX);CHKERRQ(ierr); 7412c876bd9SBarry Smith #endif 742886cfec0SSatish Balay #endif /* PETSC_HAVE_COMPLEX */ 743e5c89e4eSSatish Balay 744e5c89e4eSSatish Balay /* 745e5c89e4eSSatish Balay Create the PETSc MPI reduction operator that sums of the first 746e5c89e4eSSatish Balay half of the entries and maxes the second half. 747e5c89e4eSSatish Balay */ 748e5c89e4eSSatish Balay ierr = MPI_Op_create(PetscMaxSum_Local,1,&PetscMaxSum_Op);CHKERRQ(ierr); 749e5c89e4eSSatish Balay 750ce63c4c1SBarry Smith #if defined(PETSC_USE_REAL___FLOAT128) 751c90a1750SBarry Smith ierr = MPI_Type_contiguous(2,MPI_DOUBLE,&MPIU___FLOAT128);CHKERRQ(ierr); 752c90a1750SBarry Smith ierr = MPI_Type_commit(&MPIU___FLOAT128);CHKERRQ(ierr); 7537c2de775SJed Brown #if defined(PETSC_HAVE_COMPLEX) 7548c764dc5SJose Roman ierr = MPI_Type_contiguous(4,MPI_DOUBLE,&MPIU___COMPLEX128);CHKERRQ(ierr); 7558c764dc5SJose Roman ierr = MPI_Type_commit(&MPIU___COMPLEX128);CHKERRQ(ierr); 7568c764dc5SJose Roman #endif 757d9822059SBarry Smith ierr = MPI_Op_create(PetscMax_Local,1,&MPIU_MAX);CHKERRQ(ierr); 758d9822059SBarry Smith ierr = MPI_Op_create(PetscMin_Local,1,&MPIU_MIN);CHKERRQ(ierr); 759c90a1750SBarry Smith #endif 760c90a1750SBarry Smith 7617c2de775SJed Brown #if (defined(PETSC_HAVE_COMPLEX) && !defined(PETSC_HAVE_MPI_C_DOUBLE_COMPLEX)) || defined(PETSC_USE_REAL___FLOAT128) 762cca4cb22SSatish Balay ierr = MPI_Op_create(PetscSum_Local,1,&MPIU_SUM);CHKERRQ(ierr); 763cca4cb22SSatish Balay #endif 764cca4cb22SSatish Balay 765e5c89e4eSSatish Balay ierr = MPI_Type_contiguous(2,MPIU_SCALAR,&MPIU_2SCALAR);CHKERRQ(ierr); 766e5c89e4eSSatish Balay ierr = MPI_Type_commit(&MPIU_2SCALAR);CHKERRQ(ierr); 767e5c89e4eSSatish Balay ierr = MPI_Op_create(PetscADMax_Local,1,&PetscADMax_Op);CHKERRQ(ierr); 768e5c89e4eSSatish Balay ierr = MPI_Op_create(PetscADMin_Local,1,&PetscADMin_Op);CHKERRQ(ierr); 769e5c89e4eSSatish Balay 77044041f26SJed Brown #if defined(PETSC_USE_64BIT_INDICES) || !defined(MPI_2INT) 771e5c89e4eSSatish Balay ierr = MPI_Type_contiguous(2,MPIU_INT,&MPIU_2INT);CHKERRQ(ierr); 772e5c89e4eSSatish Balay ierr = MPI_Type_commit(&MPIU_2INT);CHKERRQ(ierr); 77344041f26SJed Brown #endif 774e5c89e4eSSatish Balay 775ec957eceSBarry Smith 776e5c89e4eSSatish Balay /* 777480cf27aSJed Brown Attributes to be set on PETSc communicators 778480cf27aSJed Brown */ 779480cf27aSJed Brown ierr = MPI_Keyval_create(MPI_NULL_COPY_FN,Petsc_DelCounter,&Petsc_Counter_keyval,(void*)0);CHKERRQ(ierr); 780da3039f7SJed Brown ierr = MPI_Keyval_create(MPI_NULL_COPY_FN,Petsc_DelComm_Outer,&Petsc_InnerComm_keyval,(void*)0);CHKERRQ(ierr); 781da3039f7SJed Brown ierr = MPI_Keyval_create(MPI_NULL_COPY_FN,Petsc_DelComm_Inner,&Petsc_OuterComm_keyval,(void*)0);CHKERRQ(ierr); 782480cf27aSJed Brown 783480cf27aSJed Brown /* 784e8fb0fc0SBarry Smith Build the options database 785e5c89e4eSSatish Balay */ 786e5c89e4eSSatish Balay ierr = PetscOptionsInsert(argc,args,file);CHKERRQ(ierr); 787e5c89e4eSSatish Balay 7886dc8fec2Sbcordonn 789e5c89e4eSSatish Balay /* 790e5c89e4eSSatish Balay Print main application help message 791e5c89e4eSSatish Balay */ 7920298fd71SBarry Smith ierr = PetscOptionsHasName(NULL,"-help",&flg);CHKERRQ(ierr); 793e5c89e4eSSatish Balay if (help && flg) { 794e5c89e4eSSatish Balay ierr = PetscPrintf(PETSC_COMM_WORLD,help);CHKERRQ(ierr); 795e5c89e4eSSatish Balay } 796e5c89e4eSSatish Balay ierr = PetscOptionsCheckInitial_Private();CHKERRQ(ierr); 797e5c89e4eSSatish Balay 798e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS) 79998eb11daSBarry Smith { 800d36c5c1aSBarry Smith char cert[PETSC_MAX_PATH_LEN],root[PETSC_MAX_PATH_LEN],intro[4024],programname[64],appline[256]; 80198eb11daSBarry Smith int port; 802d36c5c1aSBarry Smith PetscBool rootlocal = PETSC_FALSE; 80398eb11daSBarry Smith 80471244e97SBarry Smith ierr = PetscOptionsHasName(NULL,"-saws_log",&flg);CHKERRQ(ierr); 80571244e97SBarry Smith if (flg) { 80671244e97SBarry Smith char sawslog[PETSC_MAX_PATH_LEN]; 80771244e97SBarry Smith 80871244e97SBarry Smith ierr = PetscOptionsGetString(NULL,"-saws_log",sawslog,PETSC_MAX_PATH_LEN,NULL);CHKERRQ(ierr); 80971244e97SBarry Smith if (sawslog[0]) { 81071244e97SBarry Smith ierr = SAWs_Set_Use_Logfile(sawslog);CHKERRQ(ierr); 81171244e97SBarry Smith } else { 81271244e97SBarry Smith ierr = SAWs_Set_Use_Logfile(NULL);CHKERRQ(ierr); 81371244e97SBarry Smith } 81471244e97SBarry Smith } 81598eb11daSBarry Smith ierr = PetscOptionsGetString(NULL,"-saws_https",cert,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr); 81698eb11daSBarry Smith if (flg) { 81798eb11daSBarry Smith ierr = SAWs_Set_Use_HTTPS(cert);CHKERRQ(ierr); 81898eb11daSBarry Smith } 81998eb11daSBarry Smith ierr = PetscOptionsGetInt(NULL,"-saws_port",&port,&flg);CHKERRQ(ierr); 82098eb11daSBarry Smith if (flg) { 82198eb11daSBarry Smith ierr = SAWs_Set_Port(port);CHKERRQ(ierr); 82298eb11daSBarry Smith } 823a6790183SBarry Smith ierr = PetscOptionsGetString(NULL,"-saws_root",root,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr); 824a6790183SBarry Smith if (flg) { 825a6790183SBarry Smith ierr = SAWs_Set_Document_Root(root);CHKERRQ(ierr); 826d36c5c1aSBarry Smith ierr = PetscStrcmp(root,".",&rootlocal);CHKERRQ(ierr); 827a6790183SBarry Smith } 82893598db9SBarry Smith ierr = PetscGetProgramName(programname,64);CHKERRQ(ierr); 829d36c5c1aSBarry Smith if (rootlocal) { 830d36c5c1aSBarry Smith ierr = PetscSNPrintf(appline,256,"%s.c.html",programname);CHKERRQ(ierr); 831d36c5c1aSBarry Smith ierr = PetscTestFile(appline,'r',&rootlocal);CHKERRQ(ierr); 832d36c5c1aSBarry Smith } 833d36c5c1aSBarry Smith if (rootlocal && help) { 834d36c5c1aSBarry Smith ierr = PetscSNPrintf(appline,256,"<center> Running <a href=\"%s.c.html\">%s</a> which %s </center><br>\n",programname,programname,help); 835d36c5c1aSBarry Smith } else if (help) { 836d36c5c1aSBarry Smith ierr = PetscSNPrintf(appline,256,"<center> Running %s which %s </center><br>\n",programname,help); 837d36c5c1aSBarry Smith } else { 838d36c5c1aSBarry Smith ierr = PetscSNPrintf(appline,256,"<center> Running %s</center><br>\n",programname); 839d36c5c1aSBarry Smith } 840d36c5c1aSBarry Smith 841d36c5c1aSBarry Smith ierr = PetscSNPrintf(intro,4024,"<body>\n" 842d36c5c1aSBarry Smith "<center><h2> PETSc Application Web server powered by <a href=\"https://bitbucket.org/saws/saws\">SAWs</a> </h2></center>\n" 843*1cda70a7SBarry Smith "%s" 844*1cda70a7SBarry Smith "<center>This is the default PETSc application dashboard, from it you can access any published PETSc objects or logging data</center><br>\n",appline); 845*1cda70a7SBarry Smith ierr = SAWs_Set_Default_Body(0,intro); 84698eb11daSBarry Smith ierr = SAWs_Initialize();CHKERRQ(ierr); 84798eb11daSBarry Smith } 84871244e97SBarry Smith 849f4202a44SBarry Smith #endif 850f4202a44SBarry Smith 851e5c89e4eSSatish Balay /* SHOULD PUT IN GUARDS: Make sure logging is initialized, even if we do not print it out */ 852a9f03627SSatish Balay #if defined(PETSC_USE_LOG) 853e5c89e4eSSatish Balay ierr = PetscLogBegin_Private();CHKERRQ(ierr); 854a9f03627SSatish Balay #endif 855e5c89e4eSSatish Balay 856e5c89e4eSSatish Balay /* 857e5c89e4eSSatish Balay Load the dynamic libraries (on machines that support them), this registers all 858e5c89e4eSSatish Balay the solvers etc. (On non-dynamic machines this initializes the PetscDraw and PetscViewer classes) 859e5c89e4eSSatish Balay */ 860e5c89e4eSSatish Balay ierr = PetscInitialize_DynamicLibraries();CHKERRQ(ierr); 861e5c89e4eSSatish Balay 862e5c89e4eSSatish Balay ierr = MPI_Comm_size(PETSC_COMM_WORLD,&size);CHKERRQ(ierr); 863ae15b995SBarry Smith ierr = PetscInfo1(0,"PETSc successfully started: number of processors = %d\n",size);CHKERRQ(ierr); 864e5c89e4eSSatish Balay ierr = PetscGetHostName(hostname,256);CHKERRQ(ierr); 865ae15b995SBarry Smith ierr = PetscInfo1(0,"Running on machine: %s\n",hostname);CHKERRQ(ierr); 866e5c89e4eSSatish Balay 867e5c89e4eSSatish Balay ierr = PetscOptionsCheckInitial_Components();CHKERRQ(ierr); 868ef6c6fedSBoyana Norris /* Check the options database for options related to the options database itself */ 869ef6c6fedSBoyana Norris ierr = PetscOptionsSetFromOptions();CHKERRQ(ierr); 870ef6c6fedSBoyana Norris 871951e3c8eSBarry Smith #if defined(PETSC_USE_PETSC_MPI_EXTERNAL32) 872e39fd77fSBarry Smith /* 873e39fd77fSBarry Smith Tell MPI about our own data representation converter, this would/should be used if extern32 is not supported by the MPI 874e39fd77fSBarry Smith 875e39fd77fSBarry Smith Currently not used because it is not supported by MPICH. 876e39fd77fSBarry Smith */ 877e39fd77fSBarry Smith #if !defined(PETSC_WORDS_BIGENDIAN) 8780298fd71SBarry Smith ierr = MPI_Register_datarep((char*)"petsc",PetscDataRep_read_conv_fn,PetscDataRep_write_conv_fn,PetscDataRep_extent_fn,NULL);CHKERRQ(ierr); 879e39fd77fSBarry Smith #endif 880951e3c8eSBarry Smith #endif 881e39fd77fSBarry Smith 8820298fd71SBarry Smith ierr = PetscOptionsGetInt(NULL,"-hmpi_spawn_size",&nodesize,&flg);CHKERRQ(ierr); 883793721a6SBarry Smith if (flg) { 88423464e94SBarry Smith #if defined(PETSC_HAVE_MPI_COMM_SPAWN) 88585afcc9aSBarry Smith ierr = PetscHMPISpawn((PetscMPIInt) nodesize);CHKERRQ(ierr); /* worker nodes never return from here; they go directly to PetscEnd() */ 88623464e94SBarry Smith #else 88785afcc9aSBarry Smith SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SUP,"PETSc built without MPI 2 (MPI_Comm_spawn) support, use -hmpi_merge_size instead"); 88823464e94SBarry Smith #endif 889793721a6SBarry Smith } else { 8900298fd71SBarry Smith ierr = PetscOptionsGetInt(NULL,"-hmpi_merge_size",&nodesize,&flg);CHKERRQ(ierr); 8918002f1cdSBarry Smith if (flg) { 8920298fd71SBarry Smith ierr = PetscHMPIMerge((PetscMPIInt) nodesize,NULL,NULL);CHKERRQ(ierr); 89385afcc9aSBarry Smith if (PetscHMPIWorker) { /* if worker then never enter user code */ 894bad7cb1dSBarry Smith PetscInitializeCalled = PETSC_TRUE; 8953bf036e2SBarry Smith PetscEnd(); 8969505b675SBarry Smith } 8978002f1cdSBarry Smith } 898793721a6SBarry Smith } 899e5c89e4eSSatish Balay 90035d88935SVictor Minden #if defined(PETSC_HAVE_CUDA) 9014bb5149bSJed Brown { 9024bb5149bSJed Brown PetscMPIInt p; 903663ba86aSMatthew G Knepley for (p = 0; p < PetscGlobalSize; ++p) { 904a297a907SKarl Rupp if (p == PetscGlobalRank) cublasInit(); 905663ba86aSMatthew G Knepley ierr = MPI_Barrier(PETSC_COMM_WORLD);CHKERRQ(ierr); 906663ba86aSMatthew G Knepley } 9074bb5149bSJed Brown } 9083e39abd9SVictor Minden #endif 90992e62aa6SBarry Smith 9100298fd71SBarry Smith ierr = PetscOptionsHasName(NULL,"-python",&flg);CHKERRQ(ierr); 9119ac80d5eSLisandro Dalcin if (flg) { 9129ac80d5eSLisandro Dalcin PetscInitializeCalled = PETSC_TRUE; 9130298fd71SBarry Smith ierr = PetscPythonInitialize(NULL,NULL);CHKERRQ(ierr); 9149ac80d5eSLisandro Dalcin } 9159ac80d5eSLisandro Dalcin 916607a6623SBarry Smith ierr = PetscThreadCommInitializePackage();CHKERRQ(ierr); 917bd8b14e7SShri Abhyankar 91841c0b4b3SShri Abhyankar /* 91941c0b4b3SShri Abhyankar Setup building of stack frames for all function calls 92041c0b4b3SShri Abhyankar */ 921e1167bb9SShri Abhyankar #if defined(PETSC_USE_DEBUG) 922047240e1SBarry Smith PetscThreadLocalRegister((PetscThreadKey*)&petscstack); /* Creates petscstack_key if needed */ 923e1167bb9SShri Abhyankar ierr = PetscStackCreate();CHKERRQ(ierr); 924e1167bb9SShri Abhyankar #endif 925e1167bb9SShri Abhyankar 9262d53ad75SBarry Smith #if defined(PETSC_SERIALIZE_FUNCTIONS) 9272d53ad75SBarry Smith ierr = PetscFPTCreate(10000);CHKERRQ(ierr); 9282d53ad75SBarry Smith #endif 9292d53ad75SBarry Smith 930051e4cf2SJed Brown ierr = PetscCitationsInitialize();CHKERRQ(ierr); 931dff31646SBarry Smith 932301d30feSBarry Smith /* 933301d30feSBarry Smith Once we are completedly initialized then we can set this variables 934301d30feSBarry Smith */ 935301d30feSBarry Smith PetscInitializeCalled = PETSC_TRUE; 936301d30feSBarry Smith PetscFunctionReturn(0); 937e5c89e4eSSatish Balay } 938e5c89e4eSSatish Balay 9392eff7a51SBarry Smith extern PetscObject *PetscObjects; 9402eff7a51SBarry Smith extern PetscInt PetscObjectsCounts, PetscObjectsMaxCounts; 941e5c89e4eSSatish Balay 942e5c89e4eSSatish Balay #undef __FUNCT__ 943e5c89e4eSSatish Balay #define __FUNCT__ "PetscFinalize" 944e5c89e4eSSatish Balay /*@C 945e5c89e4eSSatish Balay PetscFinalize - Checks for options to be called at the conclusion 946e5c89e4eSSatish Balay of the program. MPI_Finalize() is called only if the user had not 947e5c89e4eSSatish Balay called MPI_Init() before calling PetscInitialize(). 948e5c89e4eSSatish Balay 949e5c89e4eSSatish Balay Collective on PETSC_COMM_WORLD 950e5c89e4eSSatish Balay 951e5c89e4eSSatish Balay Options Database Keys: 95288c29154SBarry Smith + -options_table - Calls PetscOptionsView() 953e5c89e4eSSatish Balay . -options_left - Prints unused options that remain in the database 9547eb1d149SBarry 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 955e5c89e4eSSatish Balay . -mpidump - Calls PetscMPIDump() 956e5c89e4eSSatish Balay . -malloc_dump - Calls PetscMallocDump() 957e5c89e4eSSatish Balay . -malloc_info - Prints total memory usage 958e5c89e4eSSatish Balay - -malloc_log - Prints summary of memory usage 959e5c89e4eSSatish Balay 960e5c89e4eSSatish Balay Level: beginner 961e5c89e4eSSatish Balay 962e5c89e4eSSatish Balay Note: 963e5c89e4eSSatish Balay See PetscInitialize() for more general runtime options. 964e5c89e4eSSatish Balay 96588c29154SBarry Smith .seealso: PetscInitialize(), PetscOptionsView(), PetscMallocDump(), PetscMPIDump(), PetscEnd() 966e5c89e4eSSatish Balay @*/ 9677087cfbeSBarry Smith PetscErrorCode PetscFinalize(void) 968e5c89e4eSSatish Balay { 969e5c89e4eSSatish Balay PetscErrorCode ierr; 9704bb5149bSJed Brown PetscMPIInt rank; 971a8d2bbe5SBarry Smith PetscInt nopt; 9722bf49c77SBarry Smith PetscBool flg1 = PETSC_FALSE,flg2 = PETSC_FALSE,flg3 = PETSC_FALSE; 973dff31646SBarry Smith PetscBool flg; 97410463e74SBarry Smith #if defined(PETSC_USE_LOG) 97510463e74SBarry Smith char mname[PETSC_MAX_PATH_LEN]; 97610463e74SBarry Smith #endif 977e5c89e4eSSatish Balay 978e5c89e4eSSatish Balay PetscFunctionBegin; 979e5c89e4eSSatish Balay if (!PetscInitializeCalled) { 9804b09e917SBarry Smith printf("PetscInitialize() must be called before PetscFinalize()\n"); 9814b09e917SBarry Smith PetscFunctionReturn(PETSC_ERR_ARG_WRONGSTATE); 982e5c89e4eSSatish Balay } 9830298fd71SBarry Smith ierr = PetscInfo(NULL,"PetscFinalize() called\n");CHKERRQ(ierr); 984b022a5c1SBarry Smith 9851f817a21SBarry Smith ierr = MPI_Comm_rank(PETSC_COMM_WORLD,&rank);CHKERRQ(ierr); 9861f817a21SBarry Smith 9871f817a21SBarry Smith ierr = PetscOptionsHasName(NULL,"-citations",&flg);CHKERRQ(ierr); 988dff31646SBarry Smith if (flg) { 9891f817a21SBarry Smith char *cits, filename[PETSC_MAX_PATH_LEN]; 9901f817a21SBarry Smith FILE *fd = PETSC_STDOUT; 9911f817a21SBarry Smith 9921f817a21SBarry Smith ierr = PetscOptionsGetString(NULL,"-citations",filename,PETSC_MAX_PATH_LEN,NULL);CHKERRQ(ierr); 9931f817a21SBarry Smith if (filename[0]) { 9941f817a21SBarry Smith ierr = PetscFOpen(PETSC_COMM_WORLD,filename,"w",&fd);CHKERRQ(ierr); 9951f817a21SBarry Smith } 996dff31646SBarry Smith ierr = PetscSegBufferGet(PetscCitationsList,1,&cits);CHKERRQ(ierr); 997dff31646SBarry Smith cits[0] = 0; 998dff31646SBarry Smith ierr = PetscSegBufferExtractAlloc(PetscCitationsList,&cits);CHKERRQ(ierr); 9991f817a21SBarry Smith ierr = PetscFPrintf(PETSC_COMM_WORLD,fd,"If you publish results based on this computation please cite the following:\n");CHKERRQ(ierr); 10001f817a21SBarry Smith ierr = PetscFPrintf(PETSC_COMM_WORLD,fd,"===========================================================================\n");CHKERRQ(ierr); 10011f817a21SBarry Smith ierr = PetscFPrintf(PETSC_COMM_WORLD,fd,"%s",cits);CHKERRQ(ierr); 10021f817a21SBarry Smith ierr = PetscFPrintf(PETSC_COMM_WORLD,fd,"===========================================================================\n");CHKERRQ(ierr); 10031f817a21SBarry Smith ierr = PetscFClose(PETSC_COMM_WORLD,fd);CHKERRQ(ierr); 1004dff31646SBarry Smith ierr = PetscFree(cits);CHKERRQ(ierr); 1005dff31646SBarry Smith } 1006dff31646SBarry Smith ierr = PetscSegBufferDestroy(&PetscCitationsList);CHKERRQ(ierr); 1007dff31646SBarry Smith 10082d53ad75SBarry Smith #if defined(PETSC_SERIALIZE_FUNCTIONS) 10092d53ad75SBarry Smith ierr = PetscFPTDestroy();CHKERRQ(ierr); 10102d53ad75SBarry Smith #endif 10112d53ad75SBarry Smith 10122d53ad75SBarry Smith 1013e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS) 1014dff31646SBarry Smith flg = PETSC_FALSE; 10150298fd71SBarry Smith ierr = PetscOptionsGetBool(NULL,"-options_gui",&flg,NULL);CHKERRQ(ierr); 1016d5649816SBarry Smith if (flg) { 1017e04113cfSBarry Smith ierr = PetscOptionsSAWsDestroy();CHKERRQ(ierr); 1018d5649816SBarry Smith } 1019d5649816SBarry Smith #endif 1020d5649816SBarry Smith 10216d065ec1SBarry Smith #if defined(PETSC_HAVE_SERVER) 10222d139d8fSBarry Smith flg1 = PETSC_FALSE; 10232d139d8fSBarry Smith ierr = PetscOptionsGetBool(NULL,"-server",&flg1,NULL);CHKERRQ(ierr); 10242d139d8fSBarry Smith if (flg1) { 10256d065ec1SBarry Smith /* this is a crude hack, but better than nothing */ 10262d139d8fSBarry Smith ierr = PetscPOpen(PETSC_COMM_WORLD,NULL,"pkill -9 petscwebserver","r",NULL);CHKERRQ(ierr); 10272d139d8fSBarry Smith } 10286d065ec1SBarry Smith #endif 10292d139d8fSBarry Smith 1030681455b2SBarry Smith #if defined(PETSC_HAVE_X) 1031681455b2SBarry Smith flg1 = PETSC_FALSE; 1032681455b2SBarry Smith ierr = PetscOptionsGetBool(NULL,"-x_virtual",&flg1,NULL);CHKERRQ(ierr); 1033681455b2SBarry Smith if (flg1) { 1034681455b2SBarry Smith /* this is a crude hack, but better than nothing */ 1035681455b2SBarry Smith ierr = PetscPOpen(PETSC_COMM_WORLD,NULL,"pkill -9 Xvfb","r",NULL);CHKERRQ(ierr); 1036681455b2SBarry Smith } 1037681455b2SBarry Smith #endif 1038681455b2SBarry Smith 103985afcc9aSBarry Smith ierr = PetscHMPIFinalize();CHKERRQ(ierr); 1040d3f95da6SShri Abhyankar 10410298fd71SBarry Smith ierr = PetscOptionsGetBool(NULL,"-malloc_info",&flg2,NULL);CHKERRQ(ierr); 1042e5c89e4eSSatish Balay if (!flg2) { 104390d69ab7SBarry Smith flg2 = PETSC_FALSE; 10440298fd71SBarry Smith ierr = PetscOptionsGetBool(NULL,"-memory_info",&flg2,NULL);CHKERRQ(ierr); 1045e5c89e4eSSatish Balay } 1046e5c89e4eSSatish Balay if (flg2) { 1047e5c89e4eSSatish Balay ierr = PetscMemoryShowUsage(PETSC_VIEWER_STDOUT_WORLD,"Summary of Memory Usage in PETSc\n");CHKERRQ(ierr); 1048e5c89e4eSSatish Balay } 1049e5c89e4eSSatish Balay 1050e5c89e4eSSatish Balay #if defined(PETSC_USE_LOG) 105190d69ab7SBarry Smith flg1 = PETSC_FALSE; 10520298fd71SBarry Smith ierr = PetscOptionsGetBool(NULL,"-get_total_flops",&flg1,NULL);CHKERRQ(ierr); 1053e5c89e4eSSatish Balay if (flg1) { 1054e5c89e4eSSatish Balay PetscLogDouble flops = 0; 1055205a32c2SJed Brown ierr = MPI_Reduce(&petsc_TotalFlops,&flops,1,MPI_DOUBLE,MPI_SUM,0,PETSC_COMM_WORLD);CHKERRQ(ierr); 1056e5c89e4eSSatish Balay ierr = PetscPrintf(PETSC_COMM_WORLD,"Total flops over all processors %g\n",flops);CHKERRQ(ierr); 1057e5c89e4eSSatish Balay } 1058e5c89e4eSSatish Balay #endif 1059e5c89e4eSSatish Balay 1060e5c89e4eSSatish Balay 1061e5c89e4eSSatish Balay #if defined(PETSC_USE_LOG) 1062e5c89e4eSSatish Balay #if defined(PETSC_HAVE_MPE) 1063e5c89e4eSSatish Balay mname[0] = 0; 1064a297a907SKarl Rupp 10650298fd71SBarry Smith ierr = PetscOptionsGetString(NULL,"-log_mpe",mname,PETSC_MAX_PATH_LEN,&flg1);CHKERRQ(ierr); 1066e5c89e4eSSatish Balay if (flg1) { 1067e5c89e4eSSatish Balay if (mname[0]) {ierr = PetscLogMPEDump(mname);CHKERRQ(ierr);} 1068e5c89e4eSSatish Balay else {ierr = PetscLogMPEDump(0);CHKERRQ(ierr);} 1069e5c89e4eSSatish Balay } 1070e5c89e4eSSatish Balay #endif 1071e5c89e4eSSatish Balay mname[0] = 0; 1072a297a907SKarl Rupp 10730298fd71SBarry Smith ierr = PetscOptionsGetString(NULL,"-log_summary",mname,PETSC_MAX_PATH_LEN,&flg1);CHKERRQ(ierr); 1074e5c89e4eSSatish Balay if (flg1) { 107591eabc43SBarry Smith PetscViewer viewer; 107691eabc43SBarry Smith if (mname[0]) { 107791eabc43SBarry Smith ierr = PetscViewerASCIIOpen(PETSC_COMM_WORLD,mname,&viewer);CHKERRQ(ierr); 107891eabc43SBarry Smith ierr = PetscLogView(viewer);CHKERRQ(ierr); 10796bf464f9SBarry Smith ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr); 108033f85c2fSBarry Smith } else { 108133f85c2fSBarry Smith viewer = PETSC_VIEWER_STDOUT_WORLD; 108233f85c2fSBarry Smith ierr = PetscLogView(viewer);CHKERRQ(ierr); 108333f85c2fSBarry Smith } 1084e5c89e4eSSatish Balay } 1085e5c89e4eSSatish Balay 1086ff5bc46bSBarry Smith mname[0] = 0; 1087a297a907SKarl Rupp 10880298fd71SBarry Smith ierr = PetscOptionsGetString(NULL,"-log_summary_python",mname,PETSC_MAX_PATH_LEN,&flg1);CHKERRQ(ierr); 1089ff5bc46bSBarry Smith if (flg1) { 1090ff5bc46bSBarry Smith PetscViewer viewer; 1091ff5bc46bSBarry Smith if (mname[0]) { 1092ff5bc46bSBarry Smith ierr = PetscViewerASCIIOpen(PETSC_COMM_WORLD,mname,&viewer);CHKERRQ(ierr); 109391eabc43SBarry Smith ierr = PetscLogViewPython(viewer);CHKERRQ(ierr); 10946bf464f9SBarry Smith ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr); 109533f85c2fSBarry Smith } else { 109633f85c2fSBarry Smith viewer = PETSC_VIEWER_STDOUT_WORLD; 109733f85c2fSBarry Smith ierr = PetscLogViewPython(viewer);CHKERRQ(ierr); 109833f85c2fSBarry Smith } 1099ff5bc46bSBarry Smith } 1100ff5bc46bSBarry Smith 11010298fd71SBarry Smith ierr = PetscOptionsGetString(NULL,"-log_detailed",mname,PETSC_MAX_PATH_LEN,&flg1);CHKERRQ(ierr); 110278392ef1SBarry Smith if (flg1) { 110378392ef1SBarry Smith if (mname[0]) {ierr = PetscLogPrintDetailed(PETSC_COMM_WORLD,mname);CHKERRQ(ierr);} 110478392ef1SBarry Smith else {ierr = PetscLogPrintDetailed(PETSC_COMM_WORLD,0);CHKERRQ(ierr);} 110578392ef1SBarry Smith } 110678392ef1SBarry Smith 1107e5c89e4eSSatish Balay mname[0] = 0; 1108a297a907SKarl Rupp 11090298fd71SBarry Smith ierr = PetscOptionsGetString(NULL,"-log_all",mname,PETSC_MAX_PATH_LEN,&flg1);CHKERRQ(ierr); 11100298fd71SBarry Smith ierr = PetscOptionsGetString(NULL,"-log",mname,PETSC_MAX_PATH_LEN,&flg2);CHKERRQ(ierr); 1111e5c89e4eSSatish Balay if (flg1 || flg2) { 1112e5c89e4eSSatish Balay if (mname[0]) PetscLogDump(mname); 1113e5c89e4eSSatish Balay else PetscLogDump(0); 1114e5c89e4eSSatish Balay } 1115e5c89e4eSSatish Balay #endif 111610463e74SBarry Smith 1117b58ca069SBarry Smith /* 1118b58ca069SBarry Smith Free all objects registered with PetscObjectRegisterDestroy() such as PETSC_VIEWER_XXX_(). 1119b58ca069SBarry Smith */ 1120b58ca069SBarry Smith ierr = PetscObjectRegisterDestroyAll();CHKERRQ(ierr); 1121b58ca069SBarry Smith 112233f85c2fSBarry Smith ierr = PetscStackDestroy();CHKERRQ(ierr); 112310463e74SBarry Smith 112490d69ab7SBarry Smith flg1 = PETSC_FALSE; 11250298fd71SBarry Smith ierr = PetscOptionsGetBool(NULL,"-no_signal_handler",&flg1,NULL);CHKERRQ(ierr); 1126e5c89e4eSSatish Balay if (!flg1) { ierr = PetscPopSignalHandler();CHKERRQ(ierr);} 112790d69ab7SBarry Smith flg1 = PETSC_FALSE; 11280298fd71SBarry Smith ierr = PetscOptionsGetBool(NULL,"-mpidump",&flg1,NULL);CHKERRQ(ierr); 1129e5c89e4eSSatish Balay if (flg1) { 1130e5c89e4eSSatish Balay ierr = PetscMPIDump(stdout);CHKERRQ(ierr); 1131e5c89e4eSSatish Balay } 113290d69ab7SBarry Smith flg1 = PETSC_FALSE; 113390d69ab7SBarry Smith flg2 = PETSC_FALSE; 11348bb29257SSatish Balay /* preemptive call to avoid listing this option in options table as unused */ 11350298fd71SBarry Smith ierr = PetscOptionsHasName(NULL,"-malloc_dump",&flg1);CHKERRQ(ierr); 11360298fd71SBarry Smith ierr = PetscOptionsHasName(NULL,"-objects_dump",&flg1);CHKERRQ(ierr); 11370298fd71SBarry Smith ierr = PetscOptionsGetBool(NULL,"-options_table",&flg2,NULL);CHKERRQ(ierr); 1138e4c476e2SSatish Balay 1139e5c89e4eSSatish Balay if (flg2) { 1140be56827dSJed Brown PetscViewer viewer; 1141be56827dSJed Brown ierr = PetscViewerASCIIGetStdout(PETSC_COMM_WORLD,&viewer);CHKERRQ(ierr); 1142be56827dSJed Brown ierr = PetscOptionsView(viewer);CHKERRQ(ierr); 1143be56827dSJed Brown ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr); 1144e5c89e4eSSatish Balay } 1145e5c89e4eSSatish Balay 1146e5c89e4eSSatish Balay /* to prevent PETSc -options_left from warning */ 11470298fd71SBarry Smith ierr = PetscOptionsHasName(NULL,"-nox",&flg1);CHKERRQ(ierr); 11480298fd71SBarry Smith ierr = PetscOptionsHasName(NULL,"-nox_warning",&flg1);CHKERRQ(ierr); 1149e5c89e4eSSatish Balay 115085afcc9aSBarry Smith if (!PetscHMPIWorker) { /* worker processes skip this because they do not usually process options */ 115133fc4174SSatish Balay flg3 = PETSC_FALSE; /* default value is required */ 11520298fd71SBarry Smith ierr = PetscOptionsGetBool(NULL,"-options_left",&flg3,&flg1);CHKERRQ(ierr); 1153e5c89e4eSSatish Balay ierr = PetscOptionsAllUsed(&nopt);CHKERRQ(ierr); 1154e5c89e4eSSatish Balay if (flg3) { 1155e5c89e4eSSatish Balay if (!flg2) { /* have not yet printed the options */ 1156be56827dSJed Brown PetscViewer viewer; 1157be56827dSJed Brown ierr = PetscViewerASCIIGetStdout(PETSC_COMM_WORLD,&viewer);CHKERRQ(ierr); 1158be56827dSJed Brown ierr = PetscOptionsView(viewer);CHKERRQ(ierr); 1159be56827dSJed Brown ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr); 1160e5c89e4eSSatish Balay } 1161e5c89e4eSSatish Balay if (!nopt) { 1162e5c89e4eSSatish Balay ierr = PetscPrintf(PETSC_COMM_WORLD,"There are no unused options.\n");CHKERRQ(ierr); 1163e5c89e4eSSatish Balay } else if (nopt == 1) { 1164e5c89e4eSSatish Balay ierr = PetscPrintf(PETSC_COMM_WORLD,"There is one unused database option. It is:\n");CHKERRQ(ierr); 1165e5c89e4eSSatish Balay } else { 11667582186dSLisandro Dalcin ierr = PetscPrintf(PETSC_COMM_WORLD,"There are %D unused database options. They are:\n",nopt);CHKERRQ(ierr); 1167e5c89e4eSSatish Balay } 1168e5c89e4eSSatish Balay } 1169e5c89e4eSSatish Balay #if defined(PETSC_USE_DEBUG) 1170da8b8a77SBarry Smith if (nopt && !flg3 && !flg1) { 1171e5c89e4eSSatish Balay ierr = PetscPrintf(PETSC_COMM_WORLD,"WARNING! There are options you set that were not used!\n");CHKERRQ(ierr); 1172e5c89e4eSSatish Balay ierr = PetscPrintf(PETSC_COMM_WORLD,"WARNING! could be spelling mistake, etc!\n");CHKERRQ(ierr); 1173e5c89e4eSSatish Balay ierr = PetscOptionsLeft();CHKERRQ(ierr); 1174e5c89e4eSSatish Balay } else if (nopt && flg3) { 1175e5c89e4eSSatish Balay #else 1176e5c89e4eSSatish Balay if (nopt && flg3) { 1177e5c89e4eSSatish Balay #endif 1178e5c89e4eSSatish Balay ierr = PetscOptionsLeft();CHKERRQ(ierr); 1179e5c89e4eSSatish Balay } 1180931f367cSBarry Smith } 1181e5c89e4eSSatish Balay 1182e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS) 118387f587eeSBarry Smith ierr = PetscStackSAWsViewOff();CHKERRQ(ierr); 118437bef686SBarry Smith ierr = SAWs_Finalize();CHKERRQ(ierr); 1185ec957eceSBarry Smith #endif 1186ec957eceSBarry Smith 1187eea2bdeeSJed Brown { 1188eea2bdeeSJed Brown PetscThreadComm tcomm_world; 1189eea2bdeeSJed Brown ierr = PetscGetThreadCommWorld(&tcomm_world);CHKERRQ(ierr); 1190eea2bdeeSJed Brown /* Free global thread communicator */ 1191eea2bdeeSJed Brown ierr = PetscThreadCommDestroy(&tcomm_world);CHKERRQ(ierr); 1192eea2bdeeSJed Brown } 1193eea2bdeeSJed Brown 119410463e74SBarry Smith /* 1195dbc8283eSBarry Smith List all objects the user may have forgot to free 11962eff7a51SBarry Smith */ 11970298fd71SBarry Smith ierr = PetscOptionsHasName(NULL,"-objects_dump",&flg1);CHKERRQ(ierr); 1198a64a8e02SBarry Smith if (flg1) { 1199a64a8e02SBarry Smith MPI_Comm local_comm; 12007eb1d149SBarry Smith char string[64]; 1201a64a8e02SBarry Smith 12020298fd71SBarry Smith ierr = PetscOptionsGetString(NULL,"-objects_dump",string,64,NULL);CHKERRQ(ierr); 1203a64a8e02SBarry Smith ierr = MPI_Comm_dup(MPI_COMM_WORLD,&local_comm);CHKERRQ(ierr); 1204a64a8e02SBarry Smith ierr = PetscSequentialPhaseBegin_Private(local_comm,1);CHKERRQ(ierr); 12057eb1d149SBarry Smith ierr = PetscObjectsDump(stdout,(string[0] == 'a') ? PETSC_TRUE : PETSC_FALSE);CHKERRQ(ierr); 1206a64a8e02SBarry Smith ierr = PetscSequentialPhaseEnd_Private(local_comm,1);CHKERRQ(ierr); 1207a64a8e02SBarry Smith ierr = MPI_Comm_free(&local_comm);CHKERRQ(ierr); 12080a1571b3SBarry Smith } 1209dbc8283eSBarry Smith PetscObjectsCounts = 0; 1210dbc8283eSBarry Smith PetscObjectsMaxCounts = 0; 12112eff7a51SBarry Smith 1212a297a907SKarl Rupp ierr = PetscFree(PetscObjects);CHKERRQ(ierr); 12132eff7a51SBarry Smith 121433f85c2fSBarry Smith #if defined(PETSC_USE_LOG) 121533f85c2fSBarry Smith ierr = PetscLogDestroy();CHKERRQ(ierr); 121633f85c2fSBarry Smith #endif 121733f85c2fSBarry Smith 121833f85c2fSBarry Smith /* 121933f85c2fSBarry Smith Destroy any packages that registered a finalize 122033f85c2fSBarry Smith */ 122133f85c2fSBarry Smith ierr = PetscRegisterFinalizeAll();CHKERRQ(ierr); 122233f85c2fSBarry Smith 122333f85c2fSBarry Smith /* 122410463e74SBarry Smith Destroy all the function registration lists created 122510463e74SBarry Smith */ 122610463e74SBarry Smith ierr = PetscFinalize_DynamicLibraries();CHKERRQ(ierr); 122710463e74SBarry Smith 122848dd1dffSBarry Smith /* 122948dd1dffSBarry Smith Print PetscFunctionLists that have not been properly freed 123048dd1dffSBarry Smith 123137e93019SBarry Smith ierr = PetscFunctionListPrintAll();CHKERRQ(ierr); 123248dd1dffSBarry Smith */ 123337e93019SBarry Smith 12344028d114SSatish Balay if (petsc_history) { 1235f3dea69dSBarry Smith ierr = PetscCloseHistoryFile(&petsc_history);CHKERRQ(ierr); 1236e5c89e4eSSatish Balay petsc_history = 0; 1237e5c89e4eSSatish Balay } 1238e5c89e4eSSatish Balay 12390298fd71SBarry Smith ierr = PetscInfoAllow(PETSC_FALSE,NULL);CHKERRQ(ierr); 1240e5c89e4eSSatish Balay 12418bb29257SSatish Balay { 1242e5c89e4eSSatish Balay char fname[PETSC_MAX_PATH_LEN]; 1243e5c89e4eSSatish Balay FILE *fd; 1244ed9cf6e9SBarry Smith int err; 1245e5c89e4eSSatish Balay 1246e5c89e4eSSatish Balay fname[0] = 0; 1247a297a907SKarl Rupp 12480298fd71SBarry Smith ierr = PetscOptionsGetString(NULL,"-malloc_dump",fname,250,&flg1);CHKERRQ(ierr); 1249dc92acbaSJed Brown flg2 = PETSC_FALSE; 12500298fd71SBarry Smith ierr = PetscOptionsGetBool(NULL,"-malloc_test",&flg2,NULL);CHKERRQ(ierr); 12518bf1f09cSShri Abhyankar #if defined(PETSC_USE_DEBUG) 1252dc92acbaSJed Brown if (PETSC_RUNNING_ON_VALGRIND) flg2 = PETSC_FALSE; 1253dc92acbaSJed Brown #else 1254dc92acbaSJed Brown flg2 = PETSC_FALSE; /* Skip reporting for optimized builds regardless of -malloc_test */ 1255dc92acbaSJed Brown #endif 1256e5c89e4eSSatish Balay if (flg1 && fname[0]) { 1257e5c89e4eSSatish Balay char sname[PETSC_MAX_PATH_LEN]; 1258e5c89e4eSSatish Balay 1259e5c89e4eSSatish Balay sprintf(sname,"%s_%d",fname,rank); 1260e32f2f54SBarry Smith fd = fopen(sname,"w"); if (!fd) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_FILE_OPEN,"Cannot open log file: %s",sname); 1261e5c89e4eSSatish Balay ierr = PetscMallocDump(fd);CHKERRQ(ierr); 1262ed9cf6e9SBarry Smith err = fclose(fd); 1263e32f2f54SBarry Smith if (err) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SYS,"fclose() failed on file"); 1264dc92acbaSJed Brown } else if (flg1 || flg2) { 1265e5c89e4eSSatish Balay MPI_Comm local_comm; 1266e5c89e4eSSatish Balay 1267e5c89e4eSSatish Balay ierr = MPI_Comm_dup(MPI_COMM_WORLD,&local_comm);CHKERRQ(ierr); 1268e5c89e4eSSatish Balay ierr = PetscSequentialPhaseBegin_Private(local_comm,1);CHKERRQ(ierr); 1269e5c89e4eSSatish Balay ierr = PetscMallocDump(stdout);CHKERRQ(ierr); 1270e5c89e4eSSatish Balay ierr = PetscSequentialPhaseEnd_Private(local_comm,1);CHKERRQ(ierr); 1271e5c89e4eSSatish Balay ierr = MPI_Comm_free(&local_comm);CHKERRQ(ierr); 1272e5c89e4eSSatish Balay } 1273e5c89e4eSSatish Balay } 1274a64a8e02SBarry Smith 12758bb29257SSatish Balay { 1276e5c89e4eSSatish Balay char fname[PETSC_MAX_PATH_LEN]; 12770298fd71SBarry Smith FILE *fd = NULL; 1278e5c89e4eSSatish Balay 1279e5c89e4eSSatish Balay fname[0] = 0; 1280a297a907SKarl Rupp 12810298fd71SBarry Smith ierr = PetscOptionsGetString(NULL,"-malloc_log",fname,250,&flg1);CHKERRQ(ierr); 12820298fd71SBarry Smith ierr = PetscOptionsHasName(NULL,"-malloc_log_threshold",&flg2);CHKERRQ(ierr); 1283e5c89e4eSSatish Balay if (flg1 && fname[0]) { 1284ed9cf6e9SBarry Smith int err; 1285e5c89e4eSSatish Balay 1286574034a9SJed Brown if (!rank) { 1287574034a9SJed Brown fd = fopen(fname,"w"); 1288574034a9SJed Brown if (!fd) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_FILE_OPEN,"Cannot open log file: %s",fname); 1289574034a9SJed Brown } 1290e5c89e4eSSatish Balay ierr = PetscMallocDumpLog(fd);CHKERRQ(ierr); 1291574034a9SJed Brown if (fd) { 1292ed9cf6e9SBarry Smith err = fclose(fd); 1293e32f2f54SBarry Smith if (err) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SYS,"fclose() failed on file"); 1294574034a9SJed Brown } 1295574034a9SJed Brown } else if (flg1 || flg2) { 1296e5c89e4eSSatish Balay ierr = PetscMallocDumpLog(stdout);CHKERRQ(ierr); 1297e5c89e4eSSatish Balay } 1298e5c89e4eSSatish Balay } 1299e5c89e4eSSatish Balay /* Can be destroyed only after all the options are used */ 1300e5c89e4eSSatish Balay ierr = PetscOptionsDestroy();CHKERRQ(ierr); 1301e5c89e4eSSatish Balay 1302e5c89e4eSSatish Balay PetscGlobalArgc = 0; 1303e5c89e4eSSatish Balay PetscGlobalArgs = 0; 1304e5c89e4eSSatish Balay 1305ce63c4c1SBarry Smith #if defined(PETSC_USE_REAL___FLOAT128) 1306c90a1750SBarry Smith ierr = MPI_Type_free(&MPIU___FLOAT128);CHKERRQ(ierr); 13077c2de775SJed Brown #if defined(PETSC_HAVE_COMPLEX) 13088c764dc5SJose Roman ierr = MPI_Type_free(&MPIU___COMPLEX128);CHKERRQ(ierr); 13098c764dc5SJose Roman #endif 1310d9822059SBarry Smith ierr = MPI_Op_free(&MPIU_MAX);CHKERRQ(ierr); 1311d9822059SBarry Smith ierr = MPI_Op_free(&MPIU_MIN);CHKERRQ(ierr); 1312c90a1750SBarry Smith #endif 1313c90a1750SBarry Smith 13147c2de775SJed Brown #if defined(PETSC_HAVE_COMPLEX) 13152c876bd9SBarry Smith #if !defined(PETSC_HAVE_MPI_C_DOUBLE_COMPLEX) 1316500d8756SSatish Balay ierr = MPI_Type_free(&MPIU_C_DOUBLE_COMPLEX);CHKERRQ(ierr); 1317500d8756SSatish Balay ierr = MPI_Type_free(&MPIU_C_COMPLEX);CHKERRQ(ierr); 13182c876bd9SBarry Smith #endif 1319e5c89e4eSSatish Balay #endif 1320cca4cb22SSatish Balay 13217c2de775SJed Brown #if (defined(PETSC_HAVE_COMPLEX) && !defined(PETSC_HAVE_MPI_C_DOUBLE_COMPLEX)) || defined(PETSC_USE_REAL___FLOAT128) 1322cca4cb22SSatish Balay ierr = MPI_Op_free(&MPIU_SUM);CHKERRQ(ierr); 1323cca4cb22SSatish Balay #endif 1324cca4cb22SSatish Balay 1325e5c89e4eSSatish Balay ierr = MPI_Type_free(&MPIU_2SCALAR);CHKERRQ(ierr); 132644041f26SJed Brown #if defined(PETSC_USE_64BIT_INDICES) || !defined(MPI_2INT) 1327e5c89e4eSSatish Balay ierr = MPI_Type_free(&MPIU_2INT);CHKERRQ(ierr); 132844041f26SJed Brown #endif 1329e5c89e4eSSatish Balay ierr = MPI_Op_free(&PetscMaxSum_Op);CHKERRQ(ierr); 1330e5c89e4eSSatish Balay ierr = MPI_Op_free(&PetscADMax_Op);CHKERRQ(ierr); 1331e5c89e4eSSatish Balay ierr = MPI_Op_free(&PetscADMin_Op);CHKERRQ(ierr); 1332e5c89e4eSSatish Balay 1333dbc8283eSBarry Smith /* 1334efb80d3cSBarry Smith Destroy any known inner MPI_Comm's and attributes pointing to them 1335efb80d3cSBarry Smith Note this will not destroy any new communicators the user has created. 1336efb80d3cSBarry Smith 1337efb80d3cSBarry Smith If all PETSc objects were not destroyed those left over objects will have hanging references to 1338efb80d3cSBarry Smith the MPI_Comms that were freed; but that is ok because those PETSc objects will never be used again 1339dbc8283eSBarry Smith */ 1340b770b1f6SSatish Balay { 1341dbc8283eSBarry Smith PetscCommCounter *counter; 1342dbc8283eSBarry Smith PetscMPIInt flg; 1343dbc8283eSBarry Smith MPI_Comm icomm; 1344265f3f35SJed Brown union {MPI_Comm comm; void *ptr;} ucomm; 1345265f3f35SJed Brown ierr = MPI_Attr_get(PETSC_COMM_SELF,Petsc_InnerComm_keyval,&ucomm,&flg);CHKERRQ(ierr); 1346dbc8283eSBarry Smith if (flg) { 1347265f3f35SJed Brown icomm = ucomm.comm; 1348dbc8283eSBarry Smith ierr = MPI_Attr_get(icomm,Petsc_Counter_keyval,&counter,&flg);CHKERRQ(ierr); 1349dbc8283eSBarry 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"); 1350dbc8283eSBarry Smith 1351dbc8283eSBarry Smith ierr = MPI_Attr_delete(PETSC_COMM_SELF,Petsc_InnerComm_keyval);CHKERRQ(ierr); 1352efb80d3cSBarry Smith ierr = MPI_Attr_delete(icomm,Petsc_Counter_keyval);CHKERRQ(ierr); 1353efb80d3cSBarry Smith ierr = MPI_Comm_free(&icomm);CHKERRQ(ierr); 1354dbc8283eSBarry Smith } 1355265f3f35SJed Brown ierr = MPI_Attr_get(PETSC_COMM_WORLD,Petsc_InnerComm_keyval,&ucomm,&flg);CHKERRQ(ierr); 1356dbc8283eSBarry Smith if (flg) { 1357265f3f35SJed Brown icomm = ucomm.comm; 1358dbc8283eSBarry Smith ierr = MPI_Attr_get(icomm,Petsc_Counter_keyval,&counter,&flg);CHKERRQ(ierr); 1359dbc8283eSBarry 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"); 1360dbc8283eSBarry Smith 1361dbc8283eSBarry Smith ierr = MPI_Attr_delete(PETSC_COMM_WORLD,Petsc_InnerComm_keyval);CHKERRQ(ierr); 1362efb80d3cSBarry Smith ierr = MPI_Attr_delete(icomm,Petsc_Counter_keyval);CHKERRQ(ierr); 1363efb80d3cSBarry Smith ierr = MPI_Comm_free(&icomm);CHKERRQ(ierr); 1364dbc8283eSBarry Smith } 1365b770b1f6SSatish Balay } 1366dbc8283eSBarry Smith 1367480cf27aSJed Brown ierr = MPI_Keyval_free(&Petsc_Counter_keyval);CHKERRQ(ierr); 1368480cf27aSJed Brown ierr = MPI_Keyval_free(&Petsc_InnerComm_keyval);CHKERRQ(ierr); 1369480cf27aSJed Brown ierr = MPI_Keyval_free(&Petsc_OuterComm_keyval);CHKERRQ(ierr); 1370480cf27aSJed Brown 1371663ba86aSMatthew G Knepley #if defined(PETSC_HAVE_CUDA) 13724bb5149bSJed Brown { 13734bb5149bSJed Brown PetscInt p; 1374663ba86aSMatthew G Knepley for (p = 0; p < PetscGlobalSize; ++p) { 1375a297a907SKarl Rupp if (p == PetscGlobalRank) cublasShutdown(); 1376663ba86aSMatthew G Knepley ierr = MPI_Barrier(PETSC_COMM_WORLD);CHKERRQ(ierr); 1377663ba86aSMatthew G Knepley } 13784bb5149bSJed Brown } 1379663ba86aSMatthew G Knepley #endif 1380663ba86aSMatthew G Knepley 1381e5c89e4eSSatish Balay if (PetscBeganMPI) { 138299608316SBarry Smith #if defined(PETSC_HAVE_MPI_FINALIZED) 138399b1327fSBarry Smith PetscMPIInt flag; 138499b1327fSBarry Smith ierr = MPI_Finalized(&flag);CHKERRQ(ierr); 1385e32f2f54SBarry Smith if (flag) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_LIB,"MPI_Finalize() has already been called, even though MPI_Init() was called by PetscInitialize()"); 138699608316SBarry Smith #endif 1387e5c89e4eSSatish Balay ierr = MPI_Finalize();CHKERRQ(ierr); 1388e5c89e4eSSatish Balay } 1389e5c89e4eSSatish Balay /* 1390e5c89e4eSSatish Balay 1391e5c89e4eSSatish Balay Note: In certain cases PETSC_COMM_WORLD is never MPI_Comm_free()ed because 1392e5c89e4eSSatish Balay the communicator has some outstanding requests on it. Specifically if the 1393e5c89e4eSSatish Balay flag PETSC_HAVE_BROKEN_REQUEST_FREE is set (for IBM MPI implementation). See 1394e5c89e4eSSatish Balay src/vec/utils/vpscat.c. Due to this the memory allocated in PetscCommDuplicate() 1395e5c89e4eSSatish Balay is never freed as it should be. Thus one may obtain messages of the form 13960e5e90baSSatish Balay [ 1] 8 bytes PetscCommDuplicate() line 645 in src/sys/mpiu.c indicating the 1397e5c89e4eSSatish Balay memory was not freed. 1398e5c89e4eSSatish Balay 1399e5c89e4eSSatish Balay */ 14001d1a0024SBarry Smith ierr = PetscMallocClear();CHKERRQ(ierr); 1401a297a907SKarl Rupp 1402e5c89e4eSSatish Balay PetscInitializeCalled = PETSC_FALSE; 1403e5c89e4eSSatish Balay PetscFinalizeCalled = PETSC_TRUE; 1404e5c89e4eSSatish Balay PetscFunctionReturn(ierr); 1405e5c89e4eSSatish Balay } 1406e5c89e4eSSatish Balay 140743db4dbbSBarry Smith #if defined(PETSC_MISSING_LAPACK_lsame_) 14088cc058d9SJed Brown PETSC_EXTERN int lsame_(char *a,char *b) 140943db4dbbSBarry Smith { 141043db4dbbSBarry Smith if (*a == *b) return 1; 141143db4dbbSBarry Smith if (*a + 32 == *b) return 1; 141243db4dbbSBarry Smith if (*a - 32 == *b) return 1; 141343db4dbbSBarry Smith return 0; 141443db4dbbSBarry Smith } 1415a70650f6SBarry Smith #endif 141643db4dbbSBarry Smith 141743db4dbbSBarry Smith #if defined(PETSC_MISSING_LAPACK_lsame) 14188cc058d9SJed Brown PETSC_EXTERN int lsame(char *a,char *b) 141943db4dbbSBarry Smith { 142043db4dbbSBarry Smith if (*a == *b) return 1; 142143db4dbbSBarry Smith if (*a + 32 == *b) return 1; 142243db4dbbSBarry Smith if (*a - 32 == *b) return 1; 142343db4dbbSBarry Smith return 0; 142443db4dbbSBarry Smith } 142543db4dbbSBarry Smith #endif 1426