17d0a6c19SBarry Smith 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> 88101f56cSMatthew Knepley 9663ba86aSMatthew G Knepley #if defined(PETSC_HAVE_CUDA) 102f947c57SVictor Minden #include <cublas.h> 117a025f21SVictor Minden #endif 127a025f21SVictor Minden 13a9f03627SSatish Balay #if defined(PETSC_USE_LOG) 14896238b9SBarry Smith extern PetscErrorCode PetscLogInitialize(void); 15a9f03627SSatish Balay #endif 16f2d66bcaSShri Abhyankar 172d53ad75SBarry Smith #if defined(PETSC_SERIALIZE_FUNCTIONS) 182d53ad75SBarry Smith PetscFPT PetscFPTData = 0; 192d53ad75SBarry Smith #endif 202d53ad75SBarry Smith 21a6790183SBarry Smith #if defined(PETSC_HAVE_SAWS) 2216ad0300SBarry Smith #include <petscviewersaws.h> 23a6790183SBarry Smith #endif 24e5c89e4eSSatish Balay /* -----------------------------------------------------------------------------------------*/ 25e5c89e4eSSatish Balay 26e5c89e4eSSatish Balay extern FILE *petsc_history; 27e5c89e4eSSatish Balay 2809573ac7SBarry Smith extern PetscErrorCode PetscInitialize_DynamicLibraries(void); 2909573ac7SBarry Smith extern PetscErrorCode PetscFinalize_DynamicLibraries(void); 3037e93019SBarry Smith extern PetscErrorCode PetscFunctionListPrintAll(void); 3109573ac7SBarry Smith extern PetscErrorCode PetscSequentialPhaseBegin_Private(MPI_Comm,int); 3209573ac7SBarry Smith extern PetscErrorCode PetscSequentialPhaseEnd_Private(MPI_Comm,int); 3309573ac7SBarry Smith extern PetscErrorCode PetscCloseHistoryFile(FILE**); 340069ddf5SShri Abhyankar 35e5c89e4eSSatish Balay /* user may set this BEFORE calling PetscInitialize() */ 36e8373e55SMatthew Knepley MPI_Comm PETSC_COMM_WORLD = MPI_COMM_NULL; 37e5c89e4eSSatish Balay 38480cf27aSJed Brown PetscMPIInt Petsc_Counter_keyval = MPI_KEYVAL_INVALID; 39480cf27aSJed Brown PetscMPIInt Petsc_InnerComm_keyval = MPI_KEYVAL_INVALID; 40480cf27aSJed Brown PetscMPIInt Petsc_OuterComm_keyval = MPI_KEYVAL_INVALID; 41480cf27aSJed Brown 42e5c89e4eSSatish Balay /* 43e5c89e4eSSatish Balay Declare and set all the string names of the PETSc enums 44e5c89e4eSSatish Balay */ 456a6fc655SJed Brown const char *const PetscBools[] = {"FALSE","TRUE","PetscBool","PETSC_",0}; 466a6fc655SJed Brown const char *const PetscCopyModes[] = {"COPY_VALUES","OWN_POINTER","USE_POINTER","PetscCopyMode","PETSC_",0}; 476a6fc655SJed Brown const char *const PetscDataTypes[] = {"INT","DOUBLE","COMPLEX","LONG","SHORT","FLOAT", 482d53ad75SBarry Smith "CHAR","LOGICAL","ENUM","BOOL","LONGDOUBLE","OBJECT","FUNCTION","PetscDataType","PETSC_",0}; 49e5c89e4eSSatish Balay 50ace3abfcSBarry Smith PetscBool PetscPreLoadingUsed = PETSC_FALSE; 51ace3abfcSBarry Smith PetscBool PetscPreLoadingOn = PETSC_FALSE; 520f8e0872SSatish Balay 53a2f94806SJed Brown PetscInt PetscHotRegionDepth; 54a2f94806SJed Brown 55e5c89e4eSSatish Balay /* 56e5c89e4eSSatish Balay Checks the options database for initializations related to the 57e5c89e4eSSatish Balay PETSc components 58e5c89e4eSSatish Balay */ 59e5c89e4eSSatish Balay #undef __FUNCT__ 60e5c89e4eSSatish Balay #define __FUNCT__ "PetscOptionsCheckInitial_Components" 617087cfbeSBarry Smith PetscErrorCode PetscOptionsCheckInitial_Components(void) 62e5c89e4eSSatish Balay { 63ace3abfcSBarry Smith PetscBool flg1; 64e5c89e4eSSatish Balay PetscErrorCode ierr; 65e5c89e4eSSatish Balay 66e5c89e4eSSatish Balay PetscFunctionBegin; 670298fd71SBarry Smith ierr = PetscOptionsHasName(NULL,"-help",&flg1);CHKERRQ(ierr); 68e5c89e4eSSatish Balay if (flg1) { 69e5c89e4eSSatish Balay #if defined(PETSC_USE_LOG) 70e8e7597cSSatish Balay MPI_Comm comm = PETSC_COMM_WORLD; 71e5c89e4eSSatish Balay ierr = (*PetscHelpPrintf)(comm,"------Additional PETSc component options--------\n");CHKERRQ(ierr); 72e5c89e4eSSatish Balay ierr = (*PetscHelpPrintf)(comm," -log_summary_exclude: <vec,mat,pc.ksp,snes>\n");CHKERRQ(ierr); 736cf91177SBarry Smith ierr = (*PetscHelpPrintf)(comm," -info_exclude: <null,vec,mat,pc,ksp,snes,ts>\n");CHKERRQ(ierr); 74e5c89e4eSSatish Balay ierr = (*PetscHelpPrintf)(comm,"-----------------------------------------------\n");CHKERRQ(ierr); 75e5c89e4eSSatish Balay #endif 76e5c89e4eSSatish Balay } 77e5c89e4eSSatish Balay PetscFunctionReturn(0); 78e5c89e4eSSatish Balay } 79e5c89e4eSSatish Balay 80e5c89e4eSSatish Balay #undef __FUNCT__ 81945d1669SBarry Smith #define __FUNCT__ "PetscInitializeNoPointers" 820f11a792SBarry Smith /* 83945d1669SBarry Smith PetscInitializeNoPointers - Calls PetscInitialize() from C/C++ without the pointers to argc and args 8472a42c3cSBarry Smith 8572a42c3cSBarry Smith Collective 8672a42c3cSBarry Smith 8772a42c3cSBarry Smith Level: advanced 8872a42c3cSBarry Smith 89945d1669SBarry Smith Notes: this is called only by the PETSc MATLAB and Julia interface. Even though it might start MPI it sets the flag to 900f11a792SBarry Smith indicate that it did NOT start MPI so that the PetscFinalize() does not end MPI, thus allowing PetscInitialize() to 91945d1669SBarry Smith be called multiple times from MATLAB and Julia without the problem of trying to initialize MPI more than once. 920f11a792SBarry Smith 931ea5a559SBarry Smith Turns off PETSc signal handling because that can interact with MATLAB's signal handling causing random crashes. 941ea5a559SBarry Smith 9572a42c3cSBarry Smith .seealso: PetscInitialize(), PetscInitializeFortran(), PetscInitializeNoArguments() 960f11a792SBarry Smith */ 97945d1669SBarry Smith PetscErrorCode PetscInitializeNoPointers(int argc,char **args,const char *filename,const char *help) 9872a42c3cSBarry Smith { 9972a42c3cSBarry Smith PetscErrorCode ierr; 10072a42c3cSBarry Smith int myargc = argc; 10172a42c3cSBarry Smith char **myargs = args; 10272a42c3cSBarry Smith 10372a42c3cSBarry Smith PetscFunctionBegin; 1043bf036e2SBarry Smith ierr = PetscInitialize(&myargc,&myargs,filename,help);CHKERRQ(ierr); 1051ea5a559SBarry Smith ierr = PetscPopSignalHandler();CHKERRQ(ierr); 106df413903SBarry Smith PetscBeganMPI = PETSC_FALSE; 10772a42c3cSBarry Smith PetscFunctionReturn(ierr); 10872a42c3cSBarry Smith } 10972a42c3cSBarry Smith 11072a42c3cSBarry Smith #undef __FUNCT__ 111945d1669SBarry Smith #define __FUNCT__ "PetscGetPETSC_COMM_SELF" 112f0865b08SBarry Smith /* 113945d1669SBarry Smith Used by MATLAB and Julia interface to get communicator 114f0865b08SBarry Smith */ 115945d1669SBarry Smith PetscErrorCode PetscGetPETSC_COMM_SELF(MPI_Comm *comm) 116f0865b08SBarry Smith { 117f0865b08SBarry Smith PetscFunctionBegin; 118f0865b08SBarry Smith *comm = PETSC_COMM_SELF; 119f0865b08SBarry Smith PetscFunctionReturn(0); 120f0865b08SBarry Smith } 121f0865b08SBarry Smith 122f0865b08SBarry Smith #undef __FUNCT__ 123e5c89e4eSSatish Balay #define __FUNCT__ "PetscInitializeNoArguments" 124e5c89e4eSSatish Balay /*@C 125e5c89e4eSSatish Balay PetscInitializeNoArguments - Calls PetscInitialize() from C/C++ without 126e5c89e4eSSatish Balay the command line arguments. 127e5c89e4eSSatish Balay 128e5c89e4eSSatish Balay Collective 129e5c89e4eSSatish Balay 130e5c89e4eSSatish Balay Level: advanced 131e5c89e4eSSatish Balay 132e5c89e4eSSatish Balay .seealso: PetscInitialize(), PetscInitializeFortran() 133e5c89e4eSSatish Balay @*/ 1347087cfbeSBarry Smith PetscErrorCode PetscInitializeNoArguments(void) 135e5c89e4eSSatish Balay { 136e5c89e4eSSatish Balay PetscErrorCode ierr; 137e5c89e4eSSatish Balay int argc = 0; 138e5c89e4eSSatish Balay char **args = 0; 139e5c89e4eSSatish Balay 140e5c89e4eSSatish Balay PetscFunctionBegin; 1410298fd71SBarry Smith ierr = PetscInitialize(&argc,&args,NULL,NULL); 142e5c89e4eSSatish Balay PetscFunctionReturn(ierr); 143e5c89e4eSSatish Balay } 144e5c89e4eSSatish Balay 145e5c89e4eSSatish Balay #undef __FUNCT__ 146e5c89e4eSSatish Balay #define __FUNCT__ "PetscInitialized" 147e5c89e4eSSatish Balay /*@ 148e5c89e4eSSatish Balay PetscInitialized - Determine whether PETSc is initialized. 149e5c89e4eSSatish Balay 15093b6d2d1SJed Brown Level: beginner 151e5c89e4eSSatish Balay 152e5c89e4eSSatish Balay .seealso: PetscInitialize(), PetscInitializeNoArguments(), PetscInitializeFortran() 153e5c89e4eSSatish Balay @*/ 1547087cfbeSBarry Smith PetscErrorCode PetscInitialized(PetscBool *isInitialized) 155e5c89e4eSSatish Balay { 156e5c89e4eSSatish Balay *isInitialized = PetscInitializeCalled; 15793b6d2d1SJed Brown return 0; 158e5c89e4eSSatish Balay } 159e5c89e4eSSatish Balay 160e5c89e4eSSatish Balay #undef __FUNCT__ 161e5c89e4eSSatish Balay #define __FUNCT__ "PetscFinalized" 162e5c89e4eSSatish Balay /*@ 163e5c89e4eSSatish Balay PetscFinalized - Determine whether PetscFinalize() has been called yet 164e5c89e4eSSatish Balay 165e5c89e4eSSatish Balay Level: developer 166e5c89e4eSSatish Balay 167e5c89e4eSSatish Balay .seealso: PetscInitialize(), PetscInitializeNoArguments(), PetscInitializeFortran() 168e5c89e4eSSatish Balay @*/ 1697087cfbeSBarry Smith PetscErrorCode PetscFinalized(PetscBool *isFinalized) 170e5c89e4eSSatish Balay { 171e5c89e4eSSatish Balay *isFinalized = PetscFinalizeCalled; 17293b6d2d1SJed Brown return 0; 173e5c89e4eSSatish Balay } 174e5c89e4eSSatish Balay 17509573ac7SBarry Smith extern PetscErrorCode PetscOptionsCheckInitial_Private(void); 176e5c89e4eSSatish Balay 177e5c89e4eSSatish Balay /* 178e5c89e4eSSatish Balay This function is the MPI reduction operation used to compute the sum of the 179e5c89e4eSSatish Balay first half of the datatype and the max of the second half. 180e5c89e4eSSatish Balay */ 181e5c89e4eSSatish Balay MPI_Op PetscMaxSum_Op = 0; 182e5c89e4eSSatish Balay 183e5c89e4eSSatish Balay #undef __FUNCT__ 184e5c89e4eSSatish Balay #define __FUNCT__ "PetscMaxSum_Local" 1858cc058d9SJed Brown PETSC_EXTERN void MPIAPI PetscMaxSum_Local(void *in,void *out,int *cnt,MPI_Datatype *datatype) 186e5c89e4eSSatish Balay { 187e5c89e4eSSatish Balay PetscInt *xin = (PetscInt*)in,*xout = (PetscInt*)out,i,count = *cnt; 188e5c89e4eSSatish Balay 189e5c89e4eSSatish Balay PetscFunctionBegin; 190e5c89e4eSSatish Balay if (*datatype != MPIU_2INT) { 191e5c89e4eSSatish Balay (*PetscErrorPrintf)("Can only handle MPIU_2INT data types"); 192e5c89e4eSSatish Balay MPI_Abort(MPI_COMM_WORLD,1); 193e5c89e4eSSatish Balay } 194e5c89e4eSSatish Balay 195e5c89e4eSSatish Balay for (i=0; i<count; i++) { 196e5c89e4eSSatish Balay xout[2*i] = PetscMax(xout[2*i],xin[2*i]); 197e5c89e4eSSatish Balay xout[2*i+1] += xin[2*i+1]; 198e5c89e4eSSatish Balay } 199812af9f3SBarry Smith PetscFunctionReturnVoid(); 200e5c89e4eSSatish Balay } 201e5c89e4eSSatish Balay 202e5c89e4eSSatish Balay /* 203e5c89e4eSSatish Balay Returns the max of the first entry owned by this processor and the 204e5c89e4eSSatish Balay sum of the second entry. 205b693b147SBarry Smith 20676f543a4SJed Brown The reason sizes[2*i] contains lengths sizes[2*i+1] contains flag of 1 if length is nonzero 20776f543a4SJed Brown is so that the PetscMaxSum_Op() can set TWO values, if we passed in only sizes[i] with lengths 208b693b147SBarry Smith there would be no place to store the both needed results. 209e5c89e4eSSatish Balay */ 210e5c89e4eSSatish Balay #undef __FUNCT__ 211e5c89e4eSSatish Balay #define __FUNCT__ "PetscMaxSum" 21276ec1555SBarry Smith PetscErrorCode PetscMaxSum(MPI_Comm comm,const PetscInt sizes[],PetscInt *max,PetscInt *sum) 213e5c89e4eSSatish Balay { 214e5c89e4eSSatish Balay PetscErrorCode ierr; 215e5c89e4eSSatish Balay 216e5c89e4eSSatish Balay PetscFunctionBegin; 217d6e4c47cSJed Brown #if defined(PETSC_HAVE_MPI_REDUCE_SCATTER_BLOCK) 218d6e4c47cSJed Brown { 219d6e4c47cSJed Brown struct {PetscInt max,sum;} work; 22076f543a4SJed Brown ierr = MPI_Reduce_scatter_block((void*)sizes,&work,1,MPIU_2INT,PetscMaxSum_Op,comm);CHKERRQ(ierr); 221d6e4c47cSJed Brown *max = work.max; 222d6e4c47cSJed Brown *sum = work.sum; 223d6e4c47cSJed Brown } 224d6e4c47cSJed Brown #else 225d6e4c47cSJed Brown { 226d6e4c47cSJed Brown PetscMPIInt size,rank; 227d6e4c47cSJed Brown struct {PetscInt max,sum;} *work; 228e5c89e4eSSatish Balay ierr = MPI_Comm_size(comm,&size);CHKERRQ(ierr); 229e5c89e4eSSatish Balay ierr = MPI_Comm_rank(comm,&rank);CHKERRQ(ierr); 230785e854fSJed Brown ierr = PetscMalloc1(size,&work);CHKERRQ(ierr); 231b2566f29SBarry Smith ierr = MPIU_Allreduce((void*)sizes,work,size,MPIU_2INT,PetscMaxSum_Op,comm);CHKERRQ(ierr); 2326ac3741eSJed Brown *max = work[rank].max; 2336ac3741eSJed Brown *sum = work[rank].sum; 234e5c89e4eSSatish Balay ierr = PetscFree(work);CHKERRQ(ierr); 235d6e4c47cSJed Brown } 236d6e4c47cSJed Brown #endif 237e5c89e4eSSatish Balay PetscFunctionReturn(0); 238e5c89e4eSSatish Balay } 239e5c89e4eSSatish Balay 240e5c89e4eSSatish Balay /* ----------------------------------------------------------------------------*/ 241e5c89e4eSSatish Balay 2427c2de775SJed Brown #if (defined(PETSC_HAVE_COMPLEX) && !defined(PETSC_HAVE_MPI_C_DOUBLE_COMPLEX)) || defined(PETSC_USE_REAL___FLOAT128) 24306a205a8SBarry Smith MPI_Op MPIU_SUM = 0; 244e5c89e4eSSatish Balay 245e5c89e4eSSatish Balay #undef __FUNCT__ 246e5c89e4eSSatish Balay #define __FUNCT__ "PetscSum_Local" 2478cc058d9SJed Brown PETSC_EXTERN void PetscSum_Local(void *in,void *out,PetscMPIInt *cnt,MPI_Datatype *datatype) 248e5c89e4eSSatish Balay { 249e5c89e4eSSatish Balay PetscInt i,count = *cnt; 250e5c89e4eSSatish Balay 251e5c89e4eSSatish Balay PetscFunctionBegin; 2527c2de775SJed Brown if (*datatype == MPIU_REAL) { 253e2e03761SBarry Smith PetscReal *xin = (PetscReal*)in,*xout = (PetscReal*)out; 254a297a907SKarl Rupp for (i=0; i<count; i++) xout[i] += xin[i]; 2557c2de775SJed Brown } 2567c2de775SJed Brown #if defined(PETSC_HAVE_COMPLEX) 2577c2de775SJed Brown else if (*datatype == MPIU_COMPLEX) { 2587c2de775SJed Brown PetscComplex *xin = (PetscComplex*)in,*xout = (PetscComplex*)out; 259a297a907SKarl Rupp for (i=0; i<count; i++) xout[i] += xin[i]; 2607c2de775SJed Brown } 2617c2de775SJed Brown #endif 2627c2de775SJed Brown else { 2637c2de775SJed Brown (*PetscErrorPrintf)("Can only handle MPIU_REAL or MPIU_COMPLEX data types"); 264e2e03761SBarry Smith MPI_Abort(MPI_COMM_WORLD,1); 265e2e03761SBarry Smith } 266812af9f3SBarry Smith PetscFunctionReturnVoid(); 267e5c89e4eSSatish Balay } 268e5c89e4eSSatish Balay #endif 269e5c89e4eSSatish Balay 270ce63c4c1SBarry Smith #if defined(PETSC_USE_REAL___FLOAT128) 271d9822059SBarry Smith MPI_Op MPIU_MAX = 0; 272d9822059SBarry Smith MPI_Op MPIU_MIN = 0; 273d9822059SBarry Smith 274d9822059SBarry Smith #undef __FUNCT__ 275d9822059SBarry Smith #define __FUNCT__ "PetscMax_Local" 2768cc058d9SJed Brown PETSC_EXTERN void PetscMax_Local(void *in,void *out,PetscMPIInt *cnt,MPI_Datatype *datatype) 277d9822059SBarry Smith { 278d9822059SBarry Smith PetscInt i,count = *cnt; 279d9822059SBarry Smith 280d9822059SBarry Smith PetscFunctionBegin; 2817c2de775SJed Brown if (*datatype == MPIU_REAL) { 2828c764dc5SJose Roman PetscReal *xin = (PetscReal*)in,*xout = (PetscReal*)out; 283a297a907SKarl Rupp for (i=0; i<count; i++) xout[i] = PetscMax(xout[i],xin[i]); 2847c2de775SJed Brown } 2857c2de775SJed Brown #if defined(PETSC_HAVE_COMPLEX) 2867c2de775SJed Brown else if (*datatype == MPIU_COMPLEX) { 2877c2de775SJed Brown PetscComplex *xin = (PetscComplex*)in,*xout = (PetscComplex*)out; 2887c2de775SJed Brown for (i=0; i<count; i++) { 2897c2de775SJed Brown xout[i] = PetscRealPartComplex(xout[i])<PetscRealPartComplex(xin[i]) ? xin[i] : xout[i]; 2907c2de775SJed Brown } 2917c2de775SJed Brown } 2927c2de775SJed Brown #endif 2937c2de775SJed Brown else { 2947c2de775SJed Brown (*PetscErrorPrintf)("Can only handle MPIU_REAL or MPIU_COMPLEX data types"); 2958c764dc5SJose Roman MPI_Abort(MPI_COMM_WORLD,1); 2968c764dc5SJose Roman } 297d9822059SBarry Smith PetscFunctionReturnVoid(); 298d9822059SBarry Smith } 299d9822059SBarry Smith 300d9822059SBarry Smith #undef __FUNCT__ 301d9822059SBarry Smith #define __FUNCT__ "PetscMin_Local" 3028cc058d9SJed Brown PETSC_EXTERN void PetscMin_Local(void *in,void *out,PetscMPIInt *cnt,MPI_Datatype *datatype) 303d9822059SBarry Smith { 304d9822059SBarry Smith PetscInt i,count = *cnt; 305d9822059SBarry Smith 306d9822059SBarry Smith PetscFunctionBegin; 3077c2de775SJed Brown if (*datatype == MPIU_REAL) { 3088c764dc5SJose Roman PetscReal *xin = (PetscReal*)in,*xout = (PetscReal*)out; 309a297a907SKarl Rupp for (i=0; i<count; i++) xout[i] = PetscMin(xout[i],xin[i]); 3107c2de775SJed Brown } 3117c2de775SJed Brown #if defined(PETSC_HAVE_COMPLEX) 3127c2de775SJed Brown else if (*datatype == MPIU_COMPLEX) { 3137c2de775SJed Brown PetscComplex *xin = (PetscComplex*)in,*xout = (PetscComplex*)out; 3147c2de775SJed Brown for (i=0; i<count; i++) { 3157c2de775SJed Brown xout[i] = PetscRealPartComplex(xout[i])>PetscRealPartComplex(xin[i]) ? xin[i] : xout[i]; 3167c2de775SJed Brown } 3177c2de775SJed Brown } 3187c2de775SJed Brown #endif 3197c2de775SJed Brown else { 3208c764dc5SJose Roman (*PetscErrorPrintf)("Can only handle MPIU_REAL or MPIU_SCALAR data (i.e. double or complex) types"); 3218c764dc5SJose Roman MPI_Abort(MPI_COMM_WORLD,1); 3228c764dc5SJose Roman } 323d9822059SBarry Smith PetscFunctionReturnVoid(); 324d9822059SBarry Smith } 325d9822059SBarry Smith #endif 326d9822059SBarry Smith 327480cf27aSJed Brown #undef __FUNCT__ 328480cf27aSJed Brown #define __FUNCT__ "Petsc_DelCounter" 329480cf27aSJed Brown /* 330480cf27aSJed Brown Private routine to delete internal tag/name counter storage when a communicator is freed. 331480cf27aSJed Brown 332ff0e51ddSBarry 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. 333480cf27aSJed Brown 334480cf27aSJed Brown Note: this is declared extern "C" because it is passed to MPI_Keyval_create() 335480cf27aSJed Brown 336480cf27aSJed Brown */ 3378cc058d9SJed Brown PETSC_EXTERN PetscMPIInt MPIAPI Petsc_DelCounter(MPI_Comm comm,PetscMPIInt keyval,void *count_val,void *extra_state) 338480cf27aSJed Brown { 339480cf27aSJed Brown PetscErrorCode ierr; 340480cf27aSJed Brown 341480cf27aSJed Brown PetscFunctionBegin; 342480cf27aSJed Brown ierr = PetscInfo1(0,"Deleting counter data in an MPI_Comm %ld\n",(long)comm);if (ierr) PetscFunctionReturn((PetscMPIInt)ierr); 343480cf27aSJed Brown ierr = PetscFree(count_val);if (ierr) PetscFunctionReturn((PetscMPIInt)ierr); 344480cf27aSJed Brown PetscFunctionReturn(MPI_SUCCESS); 345480cf27aSJed Brown } 346480cf27aSJed Brown 347480cf27aSJed Brown #undef __FUNCT__ 348da3039f7SJed Brown #define __FUNCT__ "Petsc_DelComm_Outer" 349480cf27aSJed Brown /* 350da3039f7SJed Brown This is invoked on the outer comm as a result of either PetscCommDestroy() (via MPI_Attr_delete) or when the user 351da3039f7SJed Brown calls MPI_Comm_free(). 352da3039f7SJed Brown 353da3039f7SJed Brown This is the only entry point for breaking the links between inner and outer comms. 354480cf27aSJed Brown 355ff0e51ddSBarry Smith This is called by MPI, not by users. This is called when MPI_Comm_free() is called on the communicator. 356480cf27aSJed Brown 357480cf27aSJed Brown Note: this is declared extern "C" because it is passed to MPI_Keyval_create() 358480cf27aSJed Brown 359480cf27aSJed Brown */ 360da3039f7SJed Brown PETSC_EXTERN PetscMPIInt MPIAPI Petsc_DelComm_Outer(MPI_Comm comm,PetscMPIInt keyval,void *attr_val,void *extra_state) 361480cf27aSJed Brown { 362480cf27aSJed Brown PetscErrorCode ierr; 363b89831e5SBarry Smith PetscMPIInt flg; 364265f3f35SJed Brown union {MPI_Comm comm; void *ptr;} icomm,ocomm; 365480cf27aSJed Brown 366480cf27aSJed Brown PetscFunctionBegin; 367da3039f7SJed Brown if (keyval != Petsc_InnerComm_keyval) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_CORRUPT,"Unexpected keyval"); 368ec4fadc2SJed Brown icomm.ptr = attr_val; 369da3039f7SJed Brown 370265f3f35SJed Brown ierr = MPI_Attr_get(icomm.comm,Petsc_OuterComm_keyval,&ocomm,&flg);CHKERRQ(ierr); 371b3ef52cdSBarry Smith if (!flg) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_CORRUPT,"Inner MPI_Comm does not have expected reference to outer comm"); 372da3039f7SJed Brown if (ocomm.comm != comm) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_CORRUPT,"Inner MPI_Comm has reference to non-matching outer comm"); 373da3039f7SJed Brown ierr = MPI_Attr_delete(icomm.comm,Petsc_OuterComm_keyval);CHKERRQ(ierr); /* Calls Petsc_DelComm_Inner */ 374da3039f7SJed 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); 375da3039f7SJed Brown PetscFunctionReturn(MPI_SUCCESS); 376b89831e5SBarry Smith } 377da3039f7SJed Brown 378da3039f7SJed Brown #undef __FUNCT__ 379da3039f7SJed Brown #define __FUNCT__ "Petsc_DelComm_Inner" 380da3039f7SJed Brown /* 381da3039f7SJed Brown * This is invoked on the inner comm when Petsc_DelComm_Outer calls MPI_Attr_delete. It should not be reached any other way. 382da3039f7SJed Brown */ 383da3039f7SJed Brown PETSC_EXTERN PetscMPIInt MPIAPI Petsc_DelComm_Inner(MPI_Comm comm,PetscMPIInt keyval,void *attr_val,void *extra_state) 384da3039f7SJed Brown { 385da3039f7SJed Brown PetscErrorCode ierr; 386da3039f7SJed Brown 387da3039f7SJed Brown PetscFunctionBegin; 388da3039f7SJed Brown ierr = PetscInfo1(0,"Removing reference to PETSc communicator embedded in a user MPI_Comm %ld\n",(long)comm);if (ierr) PetscFunctionReturn((PetscMPIInt)ierr); 389480cf27aSJed Brown PetscFunctionReturn(MPI_SUCCESS); 390480cf27aSJed Brown } 391480cf27aSJed Brown 392951e3c8eSBarry Smith #if defined(PETSC_USE_PETSC_MPI_EXTERNAL32) 393e39fd77fSBarry Smith #if !defined(PETSC_WORDS_BIGENDIAN) 3948cc058d9SJed Brown PETSC_EXTERN PetscMPIInt PetscDataRep_extent_fn(MPI_Datatype,MPI_Aint*,void*); 3958cc058d9SJed Brown PETSC_EXTERN PetscMPIInt PetscDataRep_read_conv_fn(void*, MPI_Datatype,PetscMPIInt,void*,MPI_Offset,void*); 3968cc058d9SJed Brown PETSC_EXTERN PetscMPIInt PetscDataRep_write_conv_fn(void*, MPI_Datatype,PetscMPIInt,void*,MPI_Offset,void*); 397e39fd77fSBarry Smith #endif 398951e3c8eSBarry Smith #endif 399e39fd77fSBarry Smith 4006ae9a8a6SBarry Smith int PetscGlobalArgc = 0; 4016ae9a8a6SBarry Smith char **PetscGlobalArgs = 0; 402dff31646SBarry Smith PetscSegBuffer PetscCitationsList; 403e5c89e4eSSatish Balay 404e5c89e4eSSatish Balay #undef __FUNCT__ 405051e4cf2SJed Brown #define __FUNCT__ "PetscCitationsInitialize" 406051e4cf2SJed Brown PetscErrorCode PetscCitationsInitialize() 407051e4cf2SJed Brown { 408051e4cf2SJed Brown PetscErrorCode ierr; 409051e4cf2SJed Brown 410051e4cf2SJed Brown PetscFunctionBegin; 411051e4cf2SJed Brown ierr = PetscSegBufferCreate(1,10000,&PetscCitationsList);CHKERRQ(ierr); 412840b20a7SSatish Balay ierr = PetscCitationsRegister("@TechReport{petsc-user-ref,\n Author = {Satish Balay and Shrirang Abhyankar and Mark F. Adams and Jed Brown and Peter Brune\n and Kris Buschelman and Lisandro Dalcin and Victor Eijkhout and William D. Gropp\n and Dinesh Kaushik and Matthew G. Knepley\n and Lois Curfman McInnes and Karl Rupp and Barry F. Smith\n and Stefano Zampini and Hong Zhang},\n Title = {{PETS}c Users Manual},\n Number = {ANL-95/11 - Revision 3.6},\n Institution = {Argonne National Laboratory},\n Year = {2015}\n}\n",NULL);CHKERRQ(ierr); 413051e4cf2SJed 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); 414051e4cf2SJed Brown PetscFunctionReturn(0); 415051e4cf2SJed Brown } 416e5c89e4eSSatish Balay 417e5c89e4eSSatish Balay #undef __FUNCT__ 418e5c89e4eSSatish Balay #define __FUNCT__ "PetscGetArgs" 419e5c89e4eSSatish Balay /*@C 420e5c89e4eSSatish Balay PetscGetArgs - Allows you to access the raw command line arguments anywhere 421e5c89e4eSSatish Balay after PetscInitialize() is called but before PetscFinalize(). 422e5c89e4eSSatish Balay 423e5c89e4eSSatish Balay Not Collective 424e5c89e4eSSatish Balay 425e5c89e4eSSatish Balay Output Parameters: 426e5c89e4eSSatish Balay + argc - count of number of command line arguments 427e5c89e4eSSatish Balay - args - the command line arguments 428e5c89e4eSSatish Balay 429e5c89e4eSSatish Balay Level: intermediate 430e5c89e4eSSatish Balay 431e5c89e4eSSatish Balay Notes: 432e5c89e4eSSatish Balay This is usually used to pass the command line arguments into other libraries 433e5c89e4eSSatish Balay that are called internally deep in PETSc or the application. 434e5c89e4eSSatish Balay 435f177e3b1SBarry Smith The first argument contains the program name as is normal for C arguments. 436f177e3b1SBarry Smith 437e5c89e4eSSatish Balay Concepts: command line arguments 438e5c89e4eSSatish Balay 439793721a6SBarry Smith .seealso: PetscFinalize(), PetscInitializeFortran(), PetscGetArguments() 440e5c89e4eSSatish Balay 441e5c89e4eSSatish Balay @*/ 4427087cfbeSBarry Smith PetscErrorCode PetscGetArgs(int *argc,char ***args) 443e5c89e4eSSatish Balay { 444e5c89e4eSSatish Balay PetscFunctionBegin; 44517186662SBarry Smith if (!PetscInitializeCalled && PetscFinalizeCalled) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ORDER,"You must call after PetscInitialize() but before PetscFinalize()"); 446e5c89e4eSSatish Balay *argc = PetscGlobalArgc; 447e5c89e4eSSatish Balay *args = PetscGlobalArgs; 448e5c89e4eSSatish Balay PetscFunctionReturn(0); 449e5c89e4eSSatish Balay } 450e5c89e4eSSatish Balay 451e5c89e4eSSatish Balay #undef __FUNCT__ 452793721a6SBarry Smith #define __FUNCT__ "PetscGetArguments" 453793721a6SBarry Smith /*@C 454793721a6SBarry Smith PetscGetArguments - Allows you to access the command line arguments anywhere 455793721a6SBarry Smith after PetscInitialize() is called but before PetscFinalize(). 456793721a6SBarry Smith 457793721a6SBarry Smith Not Collective 458793721a6SBarry Smith 459793721a6SBarry Smith Output Parameters: 460793721a6SBarry Smith . args - the command line arguments 461793721a6SBarry Smith 462793721a6SBarry Smith Level: intermediate 463793721a6SBarry Smith 464793721a6SBarry Smith Notes: 465793721a6SBarry Smith This does NOT start with the program name and IS null terminated (final arg is void) 466793721a6SBarry Smith 467793721a6SBarry Smith Concepts: command line arguments 468793721a6SBarry Smith 469793721a6SBarry Smith .seealso: PetscFinalize(), PetscInitializeFortran(), PetscGetArgs(), PetscFreeArguments() 470793721a6SBarry Smith 471793721a6SBarry Smith @*/ 4727087cfbeSBarry Smith PetscErrorCode PetscGetArguments(char ***args) 473793721a6SBarry Smith { 474793721a6SBarry Smith PetscInt i,argc = PetscGlobalArgc; 475793721a6SBarry Smith PetscErrorCode ierr; 476793721a6SBarry Smith 477793721a6SBarry Smith PetscFunctionBegin; 47817186662SBarry Smith if (!PetscInitializeCalled && PetscFinalizeCalled) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ORDER,"You must call after PetscInitialize() but before PetscFinalize()"); 479717030eeSLisandro Dalcin if (!argc) {*args = 0; PetscFunctionReturn(0);} 480785e854fSJed Brown ierr = PetscMalloc1(argc,args);CHKERRQ(ierr); 481793721a6SBarry Smith for (i=0; i<argc-1; i++) { 482793721a6SBarry Smith ierr = PetscStrallocpy(PetscGlobalArgs[i+1],&(*args)[i]);CHKERRQ(ierr); 483793721a6SBarry Smith } 484793721a6SBarry Smith (*args)[argc-1] = 0; 485793721a6SBarry Smith PetscFunctionReturn(0); 486793721a6SBarry Smith } 487793721a6SBarry Smith 488793721a6SBarry Smith #undef __FUNCT__ 489793721a6SBarry Smith #define __FUNCT__ "PetscFreeArguments" 490793721a6SBarry Smith /*@C 491793721a6SBarry Smith PetscFreeArguments - Frees the memory obtained with PetscGetArguments() 492793721a6SBarry Smith 493793721a6SBarry Smith Not Collective 494793721a6SBarry Smith 495793721a6SBarry Smith Output Parameters: 496793721a6SBarry Smith . args - the command line arguments 497793721a6SBarry Smith 498793721a6SBarry Smith Level: intermediate 499793721a6SBarry Smith 500793721a6SBarry Smith Concepts: command line arguments 501793721a6SBarry Smith 502793721a6SBarry Smith .seealso: PetscFinalize(), PetscInitializeFortran(), PetscGetArgs(), PetscGetArguments() 503793721a6SBarry Smith 504793721a6SBarry Smith @*/ 5057087cfbeSBarry Smith PetscErrorCode PetscFreeArguments(char **args) 506793721a6SBarry Smith { 507793721a6SBarry Smith PetscInt i = 0; 508793721a6SBarry Smith PetscErrorCode ierr; 509793721a6SBarry Smith 510793721a6SBarry Smith PetscFunctionBegin; 511a297a907SKarl Rupp if (!args) PetscFunctionReturn(0); 512793721a6SBarry Smith while (args[i]) { 513793721a6SBarry Smith ierr = PetscFree(args[i]);CHKERRQ(ierr); 514793721a6SBarry Smith i++; 515793721a6SBarry Smith } 516793721a6SBarry Smith ierr = PetscFree(args);CHKERRQ(ierr); 517793721a6SBarry Smith PetscFunctionReturn(0); 518793721a6SBarry Smith } 519793721a6SBarry Smith 52011525c0dSBarry Smith #if defined(PETSC_HAVE_SAWS) 52130befbd2SBarry Smith #include <petscconfiginfo.h> 52230befbd2SBarry Smith 52311525c0dSBarry Smith #undef __FUNCT__ 52411525c0dSBarry Smith #define __FUNCT__ "PetscInitializeSAWs" 52511525c0dSBarry Smith PetscErrorCode PetscInitializeSAWs(const char help[]) 52611525c0dSBarry Smith { 52711525c0dSBarry Smith if (!PetscGlobalRank) { 52830befbd2SBarry Smith char cert[PETSC_MAX_PATH_LEN],root[PETSC_MAX_PATH_LEN],*intro,programname[64],*appline,*options,version[64]; 52911525c0dSBarry Smith int port; 530ffbd1cfbSBarry Smith PetscBool flg,rootlocal = PETSC_FALSE,flg2,selectport = PETSC_FALSE; 53111525c0dSBarry Smith size_t applinelen,introlen; 53211525c0dSBarry Smith PetscErrorCode ierr; 533ffbd1cfbSBarry Smith char sawsurl[256]; 53411525c0dSBarry Smith 53511525c0dSBarry Smith ierr = PetscOptionsHasName(NULL,"-saws_log",&flg);CHKERRQ(ierr); 53611525c0dSBarry Smith if (flg) { 53711525c0dSBarry Smith char sawslog[PETSC_MAX_PATH_LEN]; 53811525c0dSBarry Smith 53911525c0dSBarry Smith ierr = PetscOptionsGetString(NULL,"-saws_log",sawslog,PETSC_MAX_PATH_LEN,NULL);CHKERRQ(ierr); 54011525c0dSBarry Smith if (sawslog[0]) { 54111525c0dSBarry Smith PetscStackCallSAWs(SAWs_Set_Use_Logfile,(sawslog)); 54211525c0dSBarry Smith } else { 54311525c0dSBarry Smith PetscStackCallSAWs(SAWs_Set_Use_Logfile,(NULL)); 54411525c0dSBarry Smith } 54511525c0dSBarry Smith } 54611525c0dSBarry Smith ierr = PetscOptionsGetString(NULL,"-saws_https",cert,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr); 54711525c0dSBarry Smith if (flg) { 54811525c0dSBarry Smith PetscStackCallSAWs(SAWs_Set_Use_HTTPS,(cert)); 54911525c0dSBarry Smith } 550ffbd1cfbSBarry Smith ierr = PetscOptionsGetBool(NULL,"-saws_port_auto_select",&selectport,NULL);CHKERRQ(ierr); 551ffbd1cfbSBarry Smith if (selectport) { 552ffbd1cfbSBarry Smith PetscStackCallSAWs(SAWs_Get_Available_Port,(&port)); 553ffbd1cfbSBarry Smith PetscStackCallSAWs(SAWs_Set_Port,(port)); 554ffbd1cfbSBarry Smith } else { 55511525c0dSBarry Smith ierr = PetscOptionsGetInt(NULL,"-saws_port",&port,&flg);CHKERRQ(ierr); 55611525c0dSBarry Smith if (flg) { 55711525c0dSBarry Smith PetscStackCallSAWs(SAWs_Set_Port,(port)); 55811525c0dSBarry Smith } 559ffbd1cfbSBarry Smith } 56011525c0dSBarry Smith ierr = PetscOptionsGetString(NULL,"-saws_root",root,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr); 56111525c0dSBarry Smith if (flg) { 56211525c0dSBarry Smith PetscStackCallSAWs(SAWs_Set_Document_Root,(root));CHKERRQ(ierr); 56311525c0dSBarry Smith ierr = PetscStrcmp(root,".",&rootlocal);CHKERRQ(ierr); 5649c1e0ce8SBarry Smith } else { 5659c1e0ce8SBarry Smith ierr = PetscOptionsHasName(NULL,"-saws_options",&flg);CHKERRQ(ierr); 5669c1e0ce8SBarry Smith if (flg) { 5673c01dfcfSBarry Smith ierr = PetscStrreplace(PETSC_COMM_WORLD,"${PETSC_DIR}/share/petsc/saws",root,PETSC_MAX_PATH_LEN);CHKERRQ(ierr); 5689c1e0ce8SBarry Smith PetscStackCallSAWs(SAWs_Set_Document_Root,(root));CHKERRQ(ierr); 5699c1e0ce8SBarry Smith } 57011525c0dSBarry Smith } 57111525c0dSBarry Smith ierr = PetscOptionsHasName(NULL,"-saws_local",&flg2);CHKERRQ(ierr); 57211525c0dSBarry Smith if (flg2) { 57311525c0dSBarry Smith char jsdir[PETSC_MAX_PATH_LEN]; 57411525c0dSBarry Smith if (!flg) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SUP,"-saws_local option requires -saws_root option"); 57511525c0dSBarry Smith ierr = PetscSNPrintf(jsdir,PETSC_MAX_PATH_LEN,"%s/js",root);CHKERRQ(ierr); 57611525c0dSBarry Smith ierr = PetscTestDirectory(jsdir,'r',&flg);CHKERRQ(ierr); 57711525c0dSBarry Smith if (!flg) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_FILE_READ,"-saws_local option requires js directory in root directory"); 57843da4ab2SBarry Smith PetscStackCallSAWs(SAWs_Push_Local_Header,());CHKERRQ(ierr); 57911525c0dSBarry Smith } 58011525c0dSBarry Smith ierr = PetscGetProgramName(programname,64);CHKERRQ(ierr); 58111525c0dSBarry Smith ierr = PetscStrlen(help,&applinelen);CHKERRQ(ierr); 58211525c0dSBarry Smith introlen = 4096 + applinelen; 58330a8c9c0SSurtai Han applinelen += 1024; 58411525c0dSBarry Smith ierr = PetscMalloc(applinelen,&appline);CHKERRQ(ierr); 58511525c0dSBarry Smith ierr = PetscMalloc(introlen,&intro);CHKERRQ(ierr); 58611525c0dSBarry Smith 58711525c0dSBarry Smith if (rootlocal) { 58811525c0dSBarry Smith ierr = PetscSNPrintf(appline,applinelen,"%s.c.html",programname);CHKERRQ(ierr); 58911525c0dSBarry Smith ierr = PetscTestFile(appline,'r',&rootlocal);CHKERRQ(ierr); 59011525c0dSBarry Smith } 59130befbd2SBarry Smith ierr = PetscOptionsGetAll(&options);CHKERRQ(ierr); 59211525c0dSBarry Smith if (rootlocal && help) { 59330befbd2SBarry Smith 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); 59411525c0dSBarry Smith } else if (help) { 59530a8c9c0SSurtai Han ierr = PetscSNPrintf(appline,applinelen,"<center>Running %s %s</center><br><center><pre>%s</pre></center><br>",programname,options,help); 59611525c0dSBarry Smith } else { 59730befbd2SBarry Smith ierr = PetscSNPrintf(appline,applinelen,"<center> Running %s %s</center><br>\n",programname,options); 59811525c0dSBarry Smith } 599b0bb5815SBarry Smith ierr = PetscFree(options);CHKERRQ(ierr); 60030befbd2SBarry Smith ierr = PetscGetVersion(version,sizeof(version));CHKERRQ(ierr); 60111525c0dSBarry Smith ierr = PetscSNPrintf(intro,introlen,"<body>\n" 60211525c0dSBarry Smith "<center><h2> <a href=\"http://www.mcs.anl.gov/petsc\">PETSc</a> Application Web server powered by <a href=\"https://bitbucket.org/saws/saws\">SAWs</a> </h2></center>\n" 603df62c222SBarry 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" 604df62c222SBarry Smith "%s",version,petscconfigureoptions,appline); 60543da4ab2SBarry Smith PetscStackCallSAWs(SAWs_Push_Body,("index.html",0,intro)); 60611525c0dSBarry Smith ierr = PetscFree(intro);CHKERRQ(ierr); 60711525c0dSBarry Smith ierr = PetscFree(appline);CHKERRQ(ierr); 60811525c0dSBarry Smith PetscStackCallSAWs(SAWs_Initialize,()); 609ffbd1cfbSBarry Smith if (selectport) { 610ffbd1cfbSBarry Smith PetscStackCallSAWs(SAWs_Get_FullURL,(sizeof(sawsurl),sawsurl)); 611ffbd1cfbSBarry Smith ierr = PetscPrintf(PETSC_COMM_WORLD,"Point your browser to %s for SAWs\n",sawsurl);CHKERRQ(ierr); 612ffbd1cfbSBarry Smith } 6130af79b04SBarry Smith ierr = PetscCitationsRegister("@TechReport{ saws,\n" 6140af79b04SBarry Smith " Author = {Matt Otten and Jed Brown and Barry Smith},\n" 6150af79b04SBarry Smith " Title = {Scientific Application Web Server (SAWs) Users Manual},\n" 6160af79b04SBarry Smith " Institution = {Argonne National Laboratory},\n" 6170af79b04SBarry Smith " Year = 2013\n}\n",NULL);CHKERRQ(ierr); 61811525c0dSBarry Smith } 61911525c0dSBarry Smith PetscFunctionReturn(0); 62011525c0dSBarry Smith } 62111525c0dSBarry Smith #endif 62211525c0dSBarry Smith 623793721a6SBarry Smith #undef __FUNCT__ 624e5c89e4eSSatish Balay #define __FUNCT__ "PetscInitialize" 625e5c89e4eSSatish Balay /*@C 626e5c89e4eSSatish Balay PetscInitialize - Initializes the PETSc database and MPI. 627e5c89e4eSSatish Balay PetscInitialize() calls MPI_Init() if that has yet to be called, 628e5c89e4eSSatish Balay so this routine should always be called near the beginning of 629e5c89e4eSSatish Balay your program -- usually the very first line! 630e5c89e4eSSatish Balay 631e5c89e4eSSatish Balay Collective on MPI_COMM_WORLD or PETSC_COMM_WORLD if it has been set 632e5c89e4eSSatish Balay 633e5c89e4eSSatish Balay Input Parameters: 634e5c89e4eSSatish Balay + argc - count of number of command line arguments 635e5c89e4eSSatish Balay . args - the command line arguments 6360298fd71SBarry Smith . file - [optional] PETSc database file, also checks ~username/.petscrc and .petscrc use NULL to not check for 637fc2bca9aSBarry Smith code specific file. Use -skip_petscrc in the code specific file to skip the .petscrc files 6380298fd71SBarry Smith - help - [optional] Help message to print, use NULL for no message 639e5c89e4eSSatish Balay 64005827820SBarry Smith If you wish PETSc code to run ONLY on a subcommunicator of MPI_COMM_WORLD, create that 64105827820SBarry Smith communicator first and assign it to PETSC_COMM_WORLD BEFORE calling PetscInitialize(). Thus if you are running a 64205827820SBarry Smith four process job and two processes will run PETSc and have PetscInitialize() and PetscFinalize() and two process will not, 64305827820SBarry Smith then do this. If ALL processes in the job are using PetscInitialize() and PetscFinalize() then you don't need to do this, even 64405827820SBarry Smith if different subcommunicators of the job are doing different things with PETSc. 645e5c89e4eSSatish Balay 646e5c89e4eSSatish Balay Options Database Keys: 647e5c89e4eSSatish Balay + -start_in_debugger [noxterm,dbx,xdb,gdb,...] - Starts program in debugger 648e5c89e4eSSatish Balay . -on_error_attach_debugger [noxterm,dbx,xdb,gdb,...] - Starts debugger when error detected 649e5c89e4eSSatish Balay . -on_error_emacs <machinename> causes emacsclient to jump to error file 650b52f573bSBarry Smith . -on_error_abort calls abort() when error detected (no traceback) 651e8fb0fc0SBarry Smith . -on_error_mpiabort calls MPI_abort() when error detected 652e8fb0fc0SBarry Smith . -error_output_stderr prints error messages to stderr instead of the default stdout 653e8fb0fc0SBarry Smith . -error_output_none does not print the error messages (but handles errors in the same way as if this was not called) 654e5c89e4eSSatish Balay . -debugger_nodes [node1,node2,...] - Indicates nodes to start in debugger 655e5c89e4eSSatish Balay . -debugger_pause [sleeptime] (in seconds) - Pauses debugger 656e5c89e4eSSatish Balay . -stop_for_debugger - Print message on how to attach debugger manually to 657e5c89e4eSSatish Balay process and wait (-debugger_pause) seconds for attachment 6582fb0ec9aSBarry Smith . -malloc - Indicates use of PETSc error-checking malloc (on by default for debug version of libraries) 659e5c89e4eSSatish Balay . -malloc no - Indicates not to use error-checking malloc 6602fb0ec9aSBarry Smith . -malloc_debug - check for memory corruption at EVERY malloc or free 661aee23540SBarry Smith . -malloc_dump - prints a list of all unfreed memory at the end of the run 662dc92acbaSJed Brown . -malloc_test - like -malloc_dump -malloc_debug, but only active for debugging builds 663e5c89e4eSSatish Balay . -fp_trap - Stops on floating point exceptions (Note that on the 664e5c89e4eSSatish Balay IBM RS6000 this slows code by at least a factor of 10.) 665e5c89e4eSSatish Balay . -no_signal_handler - Indicates not to trap error signals 666e5c89e4eSSatish Balay . -shared_tmp - indicates /tmp directory is shared by all processors 667e5c89e4eSSatish Balay . -not_shared_tmp - each processor has own /tmp 668e5c89e4eSSatish Balay . -tmp - alternative name of /tmp directory 669e5c89e4eSSatish Balay . -get_total_flops - returns total flops done by all processors 6700841954dSBarry Smith - -memory_view - Print memory usage at end of run 671e5c89e4eSSatish Balay 672e5c89e4eSSatish Balay Options Database Keys for Profiling: 673a7f22e61SSatish Balay See Users-Manual: ch_profiling for details. 674495fc317SBarry Smith + -info <optional filename> - Prints verbose information to the screen 675495fc317SBarry Smith . -info_exclude <null,vec,mat,pc,ksp,snes,ts> - Excludes some of the verbose messages 676495fc317SBarry Smith . -log_sync - Log the synchronization in scatters, inner products and norms 677495fc317SBarry Smith . -log_trace [filename] - Print traces of all PETSc calls to the screen (useful to determine where a program 678e5c89e4eSSatish Balay hangs without running in the debugger). See PetscLogTraceBegin(). 679495fc317SBarry Smith . -log_summary [filename] - Prints summary of flop and timing information to screen. If the filename is specified the 680495fc317SBarry Smith summary is written to the file. See PetscLogView(). 681495fc317SBarry Smith . -log_all [filename] - Logs extensive profiling information See PetscLogDump(). 682495fc317SBarry Smith . -log [filename] - Logs basic profiline information See PetscLogDump(). 683495fc317SBarry Smith - -log_mpe [filename] - Creates a logfile viewable by the utility Jumpshot (in MPICH distribution) 684495fc317SBarry Smith 685495fc317SBarry Smith Only one of -log_trace, -log_summary, -log_all, -log, or -log_mpe may be used at a time 686e5c89e4eSSatish Balay 687ffbd1cfbSBarry Smith Options Database Keys for SAWs: 688ffbd1cfbSBarry Smith + -saws_port <portnumber> - port number to publish SAWs data, default is 8080 689ffbd1cfbSBarry 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 690ffbd1cfbSBarry Smith this is useful when you are running many jobs that utilize SAWs at the same time 691ffbd1cfbSBarry Smith . -saws_log <filename> - save a log of all SAWs communication 692ffbd1cfbSBarry Smith . -saws_https <certificate file> - have SAWs use HTTPS instead of HTTP 693ffbd1cfbSBarry Smith - -saws_root <directory> - allow SAWs to have access to the given directory to search for requested resources and files 694ffbd1cfbSBarry Smith 695e5c89e4eSSatish Balay Environmental Variables: 696e5c89e4eSSatish Balay + PETSC_TMP - alternative tmp directory 697e5c89e4eSSatish Balay . PETSC_SHARED_TMP - tmp is shared by all processes 698e5c89e4eSSatish Balay . PETSC_NOT_SHARED_TMP - each process has its own private tmp 699e5c89e4eSSatish Balay . PETSC_VIEWER_SOCKET_PORT - socket number to use for socket viewer 700e5c89e4eSSatish Balay - PETSC_VIEWER_SOCKET_MACHINE - machine to use for socket viewer to connect to 701e5c89e4eSSatish Balay 702e5c89e4eSSatish Balay 703e5c89e4eSSatish Balay Level: beginner 704e5c89e4eSSatish Balay 705e5c89e4eSSatish Balay Notes: 706e5c89e4eSSatish Balay If for some reason you must call MPI_Init() separately, call 707e5c89e4eSSatish Balay it before PetscInitialize(). 708e5c89e4eSSatish Balay 709e5c89e4eSSatish Balay Fortran Version: 710e5c89e4eSSatish Balay In Fortran this routine has the format 711e5c89e4eSSatish Balay $ call PetscInitialize(file,ierr) 712e5c89e4eSSatish Balay 713e5c89e4eSSatish Balay + ierr - error return code 7140eb4c9c0SBarry Smith - file - [optional] PETSc database file, also checks ~username/.petscrc and .petscrc use PETSC_NULL_CHARACTER to not check for 715fc2bca9aSBarry Smith code specific file. Use -skip_petscrc in the code specific file to skip the .petscrc files 716e5c89e4eSSatish Balay 717e5c89e4eSSatish Balay Important Fortran Note: 7180eb4c9c0SBarry Smith In Fortran, you MUST use PETSC_NULL_CHARACTER to indicate a 7190298fd71SBarry Smith null character string; you CANNOT just use NULL as 720a7f22e61SSatish Balay in the C version. See Users-Manual: ch_fortran for details. 721e5c89e4eSSatish Balay 72201cb0274SBarry Smith If your main program is C but you call Fortran code that also uses PETSc you need to call PetscInitializeFortran() soon after 72301cb0274SBarry Smith calling PetscInitialize(). 724e5c89e4eSSatish Balay 725e5c89e4eSSatish Balay Concepts: initializing PETSc 726e5c89e4eSSatish Balay 72701cb0274SBarry Smith .seealso: PetscFinalize(), PetscInitializeFortran(), PetscGetArgs(), PetscInitializeNoArguments() 728e5c89e4eSSatish Balay 729e5c89e4eSSatish Balay @*/ 7307087cfbeSBarry Smith PetscErrorCode PetscInitialize(int *argc,char ***args,const char file[],const char help[]) 731e5c89e4eSSatish Balay { 732e5c89e4eSSatish Balay PetscErrorCode ierr; 7334bb5149bSJed Brown PetscMPIInt flag, size; 734ace3abfcSBarry Smith PetscBool flg; 735e5c89e4eSSatish Balay char hostname[256]; 736e5c89e4eSSatish Balay 737e5c89e4eSSatish Balay PetscFunctionBegin; 738e5c89e4eSSatish Balay if (PetscInitializeCalled) PetscFunctionReturn(0); 739e5c89e4eSSatish Balay 740ae9b4142SLisandro Dalcin /* these must be initialized in a routine, not as a constant declaration*/ 741d89683f4Sbcordonn PETSC_STDOUT = stdout; 742ae9b4142SLisandro Dalcin PETSC_STDERR = stderr; 743e5c89e4eSSatish Balay 7440c30907bSSatish Balay /* on Windows - set printf to default to printing 2 digit exponents */ 7450c30907bSSatish Balay #if defined(PETSC_HAVE__SET_OUTPUT_FORMAT) 7460c30907bSSatish Balay _set_output_format(_TWO_DIGIT_EXPONENT); 7470c30907bSSatish Balay #endif 7480c30907bSSatish Balay 749e5c89e4eSSatish Balay ierr = PetscOptionsCreate();CHKERRQ(ierr); 750e5c89e4eSSatish Balay 751e5c89e4eSSatish Balay /* 752e5c89e4eSSatish Balay We initialize the program name here (before MPI_Init()) because MPICH has a bug in 753e5c89e4eSSatish Balay it that it sets args[0] on all processors to be args[0] on the first processor. 754e5c89e4eSSatish Balay */ 755e5c89e4eSSatish Balay if (argc && *argc) { 756e5c89e4eSSatish Balay ierr = PetscSetProgramName(**args);CHKERRQ(ierr); 757e5c89e4eSSatish Balay } else { 758e5c89e4eSSatish Balay ierr = PetscSetProgramName("Unknown Name");CHKERRQ(ierr); 759e5c89e4eSSatish Balay } 760e5c89e4eSSatish Balay 761e5c89e4eSSatish Balay ierr = MPI_Initialized(&flag);CHKERRQ(ierr); 762e5c89e4eSSatish Balay if (!flag) { 763e32f2f54SBarry 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"); 7645e765c61SJed Brown #if defined(PETSC_HAVE_MPI_INIT_THREAD) 7655e765c61SJed Brown { 7665e765c61SJed Brown PetscMPIInt provided; 7675e765c61SJed Brown ierr = MPI_Init_thread(argc,args,MPI_THREAD_FUNNELED,&provided);CHKERRQ(ierr); 7685e765c61SJed Brown } 7695e765c61SJed Brown #else 770e5c89e4eSSatish Balay ierr = MPI_Init(argc,args);CHKERRQ(ierr); 7715e765c61SJed Brown #endif 772e5c89e4eSSatish Balay PetscBeganMPI = PETSC_TRUE; 773e5c89e4eSSatish Balay } 774e5c89e4eSSatish Balay if (argc && args) { 775e5c89e4eSSatish Balay PetscGlobalArgc = *argc; 776e5c89e4eSSatish Balay PetscGlobalArgs = *args; 777e5c89e4eSSatish Balay } 778e5c89e4eSSatish Balay PetscFinalizeCalled = PETSC_FALSE; 7795ad9ad5bSBarry Smith ierr = PetscSpinlockCreate(&PetscViewerASCIISpinLockOpen);CHKERRQ(ierr); 7805ad9ad5bSBarry Smith ierr = PetscSpinlockCreate(&PetscViewerASCIISpinLockStdout);CHKERRQ(ierr); 7815ad9ad5bSBarry Smith ierr = PetscSpinlockCreate(&PetscViewerASCIISpinLockStderr);CHKERRQ(ierr); 782ef19f930SBarry Smith ierr = PetscSpinlockCreate(&PetscCommSpinLock);CHKERRQ(ierr); 783e5c89e4eSSatish Balay 784a297a907SKarl Rupp if (PETSC_COMM_WORLD == MPI_COMM_NULL) PETSC_COMM_WORLD = MPI_COMM_WORLD; 785d54338ecSKarl Rupp ierr = MPI_Comm_set_errhandler(PETSC_COMM_WORLD,MPI_ERRORS_RETURN);CHKERRQ(ierr); 786e5c89e4eSSatish Balay 787e5c89e4eSSatish Balay /* Done after init due to a bug in MPICH-GM? */ 788e5c89e4eSSatish Balay ierr = PetscErrorPrintfInitialize();CHKERRQ(ierr); 789e5c89e4eSSatish Balay 790e5c89e4eSSatish Balay ierr = MPI_Comm_rank(MPI_COMM_WORLD,&PetscGlobalRank);CHKERRQ(ierr); 791e5c89e4eSSatish Balay ierr = MPI_Comm_size(MPI_COMM_WORLD,&PetscGlobalSize);CHKERRQ(ierr); 792e5c89e4eSSatish Balay 7938ad47952SJed Brown MPIU_BOOL = MPI_INT; 7948ad47952SJed Brown MPIU_ENUM = MPI_INT; 7958ad47952SJed Brown 796e5c89e4eSSatish Balay /* 797e5c89e4eSSatish Balay Initialized the global complex variable; this is because with 798e5c89e4eSSatish Balay shared libraries the constructors for global variables 799e5c89e4eSSatish Balay are not called; at least on IRIX. 800e5c89e4eSSatish Balay */ 801886cfec0SSatish Balay #if defined(PETSC_HAVE_COMPLEX) 802e5c89e4eSSatish Balay { 803a24ee22aSSatish Balay #if defined(PETSC_CLANGUAGE_CXX) 80450f81f78SJed Brown PetscComplex ic(0.0,1.0); 805e5c89e4eSSatish Balay PETSC_i = ic; 806a24ee22aSSatish Balay #elif defined(PETSC_CLANGUAGE_C) 80750f81f78SJed Brown PETSC_i = _Complex_I; 808b7940d39SSatish Balay #endif 809762437b8SSatish Balay } 810762437b8SSatish Balay 8112c876bd9SBarry Smith #if !defined(PETSC_HAVE_MPI_C_DOUBLE_COMPLEX) 812e69cd0e6SSatish Balay ierr = MPI_Type_contiguous(2,MPI_DOUBLE,&MPIU_C_DOUBLE_COMPLEX);CHKERRQ(ierr); 813500d8756SSatish Balay ierr = MPI_Type_commit(&MPIU_C_DOUBLE_COMPLEX);CHKERRQ(ierr); 814500d8756SSatish Balay ierr = MPI_Type_contiguous(2,MPI_FLOAT,&MPIU_C_COMPLEX);CHKERRQ(ierr); 815500d8756SSatish Balay ierr = MPI_Type_commit(&MPIU_C_COMPLEX);CHKERRQ(ierr); 8162c876bd9SBarry Smith #endif 817886cfec0SSatish Balay #endif /* PETSC_HAVE_COMPLEX */ 818e5c89e4eSSatish Balay 819e5c89e4eSSatish Balay /* 820e5c89e4eSSatish Balay Create the PETSc MPI reduction operator that sums of the first 821e5c89e4eSSatish Balay half of the entries and maxes the second half. 822e5c89e4eSSatish Balay */ 823e5c89e4eSSatish Balay ierr = MPI_Op_create(PetscMaxSum_Local,1,&PetscMaxSum_Op);CHKERRQ(ierr); 824e5c89e4eSSatish Balay 825ce63c4c1SBarry Smith #if defined(PETSC_USE_REAL___FLOAT128) 826c90a1750SBarry Smith ierr = MPI_Type_contiguous(2,MPI_DOUBLE,&MPIU___FLOAT128);CHKERRQ(ierr); 827c90a1750SBarry Smith ierr = MPI_Type_commit(&MPIU___FLOAT128);CHKERRQ(ierr); 8287c2de775SJed Brown #if defined(PETSC_HAVE_COMPLEX) 8298c764dc5SJose Roman ierr = MPI_Type_contiguous(4,MPI_DOUBLE,&MPIU___COMPLEX128);CHKERRQ(ierr); 8308c764dc5SJose Roman ierr = MPI_Type_commit(&MPIU___COMPLEX128);CHKERRQ(ierr); 8318c764dc5SJose Roman #endif 832d9822059SBarry Smith ierr = MPI_Op_create(PetscMax_Local,1,&MPIU_MAX);CHKERRQ(ierr); 833d9822059SBarry Smith ierr = MPI_Op_create(PetscMin_Local,1,&MPIU_MIN);CHKERRQ(ierr); 834c90a1750SBarry Smith #endif 835c90a1750SBarry Smith 8367c2de775SJed Brown #if (defined(PETSC_HAVE_COMPLEX) && !defined(PETSC_HAVE_MPI_C_DOUBLE_COMPLEX)) || defined(PETSC_USE_REAL___FLOAT128) 837cca4cb22SSatish Balay ierr = MPI_Op_create(PetscSum_Local,1,&MPIU_SUM);CHKERRQ(ierr); 838cca4cb22SSatish Balay #endif 839cca4cb22SSatish Balay 840e5c89e4eSSatish Balay ierr = MPI_Type_contiguous(2,MPIU_SCALAR,&MPIU_2SCALAR);CHKERRQ(ierr); 841e5c89e4eSSatish Balay ierr = MPI_Type_commit(&MPIU_2SCALAR);CHKERRQ(ierr); 842e5c89e4eSSatish Balay 84344041f26SJed Brown #if defined(PETSC_USE_64BIT_INDICES) || !defined(MPI_2INT) 844e5c89e4eSSatish Balay ierr = MPI_Type_contiguous(2,MPIU_INT,&MPIU_2INT);CHKERRQ(ierr); 845e5c89e4eSSatish Balay ierr = MPI_Type_commit(&MPIU_2INT);CHKERRQ(ierr); 84644041f26SJed Brown #endif 847e5c89e4eSSatish Balay 848ec957eceSBarry Smith 849e5c89e4eSSatish Balay /* 850480cf27aSJed Brown Attributes to be set on PETSc communicators 851480cf27aSJed Brown */ 852480cf27aSJed Brown ierr = MPI_Keyval_create(MPI_NULL_COPY_FN,Petsc_DelCounter,&Petsc_Counter_keyval,(void*)0);CHKERRQ(ierr); 853da3039f7SJed Brown ierr = MPI_Keyval_create(MPI_NULL_COPY_FN,Petsc_DelComm_Outer,&Petsc_InnerComm_keyval,(void*)0);CHKERRQ(ierr); 854da3039f7SJed Brown ierr = MPI_Keyval_create(MPI_NULL_COPY_FN,Petsc_DelComm_Inner,&Petsc_OuterComm_keyval,(void*)0);CHKERRQ(ierr); 855480cf27aSJed Brown 856480cf27aSJed Brown /* 857e8fb0fc0SBarry Smith Build the options database 858e5c89e4eSSatish Balay */ 859e5c89e4eSSatish Balay ierr = PetscOptionsInsert(argc,args,file);CHKERRQ(ierr); 860e5c89e4eSSatish Balay 8616dc8fec2Sbcordonn 862e5c89e4eSSatish Balay /* 863e5c89e4eSSatish Balay Print main application help message 864e5c89e4eSSatish Balay */ 8650298fd71SBarry Smith ierr = PetscOptionsHasName(NULL,"-help",&flg);CHKERRQ(ierr); 866e5c89e4eSSatish Balay if (help && flg) { 867e5c89e4eSSatish Balay ierr = PetscPrintf(PETSC_COMM_WORLD,help);CHKERRQ(ierr); 868e5c89e4eSSatish Balay } 869e5c89e4eSSatish Balay ierr = PetscOptionsCheckInitial_Private();CHKERRQ(ierr); 870e5c89e4eSSatish Balay 871d45a07a7SBarry Smith ierr = PetscCitationsInitialize();CHKERRQ(ierr); 872d45a07a7SBarry Smith 873e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS) 87411525c0dSBarry Smith ierr = PetscInitializeSAWs(help);CHKERRQ(ierr); 875f4202a44SBarry Smith #endif 876f4202a44SBarry Smith 877896238b9SBarry Smith /* Creates the logging data structures; this is enabled even if logging is not turned on */ 878a9f03627SSatish Balay #if defined(PETSC_USE_LOG) 879896238b9SBarry Smith ierr = PetscLogInitialize();CHKERRQ(ierr); 880a9f03627SSatish Balay #endif 881e5c89e4eSSatish Balay 882e5c89e4eSSatish Balay /* 883e5c89e4eSSatish Balay Load the dynamic libraries (on machines that support them), this registers all 884e5c89e4eSSatish Balay the solvers etc. (On non-dynamic machines this initializes the PetscDraw and PetscViewer classes) 885e5c89e4eSSatish Balay */ 886e5c89e4eSSatish Balay ierr = PetscInitialize_DynamicLibraries();CHKERRQ(ierr); 887e5c89e4eSSatish Balay 888e5c89e4eSSatish Balay ierr = MPI_Comm_size(PETSC_COMM_WORLD,&size);CHKERRQ(ierr); 889ae15b995SBarry Smith ierr = PetscInfo1(0,"PETSc successfully started: number of processors = %d\n",size);CHKERRQ(ierr); 890e5c89e4eSSatish Balay ierr = PetscGetHostName(hostname,256);CHKERRQ(ierr); 891ae15b995SBarry Smith ierr = PetscInfo1(0,"Running on machine: %s\n",hostname);CHKERRQ(ierr); 892e5c89e4eSSatish Balay 893e5c89e4eSSatish Balay ierr = PetscOptionsCheckInitial_Components();CHKERRQ(ierr); 894ef6c6fedSBoyana Norris /* Check the options database for options related to the options database itself */ 895ef6c6fedSBoyana Norris ierr = PetscOptionsSetFromOptions();CHKERRQ(ierr); 896ef6c6fedSBoyana Norris 897951e3c8eSBarry Smith #if defined(PETSC_USE_PETSC_MPI_EXTERNAL32) 898e39fd77fSBarry Smith /* 899e39fd77fSBarry Smith Tell MPI about our own data representation converter, this would/should be used if extern32 is not supported by the MPI 900e39fd77fSBarry Smith 901e39fd77fSBarry Smith Currently not used because it is not supported by MPICH. 902e39fd77fSBarry Smith */ 903e39fd77fSBarry Smith #if !defined(PETSC_WORDS_BIGENDIAN) 9040298fd71SBarry Smith ierr = MPI_Register_datarep((char*)"petsc",PetscDataRep_read_conv_fn,PetscDataRep_write_conv_fn,PetscDataRep_extent_fn,NULL);CHKERRQ(ierr); 905e39fd77fSBarry Smith #endif 906951e3c8eSBarry Smith #endif 907e39fd77fSBarry Smith 90835d88935SVictor Minden #if defined(PETSC_HAVE_CUDA) 90920e2c332SMatthew G. Knepley flg = PETSC_TRUE; 91020e2c332SMatthew G. Knepley ierr = PetscOptionsGetBool(NULL,"-cublas",&flg,NULL);CHKERRQ(ierr); 91120e2c332SMatthew G. Knepley if (flg) { 9124bb5149bSJed Brown PetscMPIInt p; 913663ba86aSMatthew G Knepley for (p = 0; p < PetscGlobalSize; ++p) { 914a297a907SKarl Rupp if (p == PetscGlobalRank) cublasInit(); 915663ba86aSMatthew G Knepley ierr = MPI_Barrier(PETSC_COMM_WORLD);CHKERRQ(ierr); 916663ba86aSMatthew G Knepley } 9174bb5149bSJed Brown } 9183e39abd9SVictor Minden #endif 91992e62aa6SBarry Smith 9200298fd71SBarry Smith ierr = PetscOptionsHasName(NULL,"-python",&flg);CHKERRQ(ierr); 9219ac80d5eSLisandro Dalcin if (flg) { 9229ac80d5eSLisandro Dalcin PetscInitializeCalled = PETSC_TRUE; 9230298fd71SBarry Smith ierr = PetscPythonInitialize(NULL,NULL);CHKERRQ(ierr); 9249ac80d5eSLisandro Dalcin } 9259ac80d5eSLisandro Dalcin 92641c0b4b3SShri Abhyankar /* 92741c0b4b3SShri Abhyankar Setup building of stack frames for all function calls 92841c0b4b3SShri Abhyankar */ 929ef19f930SBarry Smith #if defined(PETSC_USE_DEBUG) && !defined(PETSC_HAVE_THREADSAFETY) 930e1167bb9SShri Abhyankar ierr = PetscStackCreate();CHKERRQ(ierr); 931e1167bb9SShri Abhyankar #endif 932e1167bb9SShri Abhyankar 9332d53ad75SBarry Smith #if defined(PETSC_SERIALIZE_FUNCTIONS) 9342d53ad75SBarry Smith ierr = PetscFPTCreate(10000);CHKERRQ(ierr); 9352d53ad75SBarry Smith #endif 9362d53ad75SBarry Smith 937dff31646SBarry Smith 938301d30feSBarry Smith /* 939301d30feSBarry Smith Once we are completedly initialized then we can set this variables 940301d30feSBarry Smith */ 941301d30feSBarry Smith PetscInitializeCalled = PETSC_TRUE; 942301d30feSBarry Smith PetscFunctionReturn(0); 943e5c89e4eSSatish Balay } 944e5c89e4eSSatish Balay 9454097062eSBarry Smith #if defined(PETSC_USE_LOG) 9462eff7a51SBarry Smith extern PetscObject *PetscObjects; 9472eff7a51SBarry Smith extern PetscInt PetscObjectsCounts, PetscObjectsMaxCounts; 94805df10baSBarry Smith extern PetscBool PetscObjectsLog; 9494097062eSBarry Smith #endif 950e5c89e4eSSatish Balay 951e5c89e4eSSatish Balay #undef __FUNCT__ 952e5c89e4eSSatish Balay #define __FUNCT__ "PetscFinalize" 953e5c89e4eSSatish Balay /*@C 954e5c89e4eSSatish Balay PetscFinalize - Checks for options to be called at the conclusion 955e5c89e4eSSatish Balay of the program. MPI_Finalize() is called only if the user had not 956e5c89e4eSSatish Balay called MPI_Init() before calling PetscInitialize(). 957e5c89e4eSSatish Balay 958e5c89e4eSSatish Balay Collective on PETSC_COMM_WORLD 959e5c89e4eSSatish Balay 960e5c89e4eSSatish Balay Options Database Keys: 96188c29154SBarry Smith + -options_table - Calls PetscOptionsView() 962e5c89e4eSSatish Balay . -options_left - Prints unused options that remain in the database 9637eb1d149SBarry 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 964e5c89e4eSSatish Balay . -mpidump - Calls PetscMPIDump() 965e5c89e4eSSatish Balay . -malloc_dump - Calls PetscMallocDump() 966e5c89e4eSSatish Balay . -malloc_info - Prints total memory usage 967e5c89e4eSSatish Balay - -malloc_log - Prints summary of memory usage 968e5c89e4eSSatish Balay 969e5c89e4eSSatish Balay Level: beginner 970e5c89e4eSSatish Balay 971e5c89e4eSSatish Balay Note: 972e5c89e4eSSatish Balay See PetscInitialize() for more general runtime options. 973e5c89e4eSSatish Balay 97488c29154SBarry Smith .seealso: PetscInitialize(), PetscOptionsView(), PetscMallocDump(), PetscMPIDump(), PetscEnd() 975e5c89e4eSSatish Balay @*/ 9767087cfbeSBarry Smith PetscErrorCode PetscFinalize(void) 977e5c89e4eSSatish Balay { 978e5c89e4eSSatish Balay PetscErrorCode ierr; 9794bb5149bSJed Brown PetscMPIInt rank; 980a8d2bbe5SBarry Smith PetscInt nopt; 9812bf49c77SBarry Smith PetscBool flg1 = PETSC_FALSE,flg2 = PETSC_FALSE,flg3 = PETSC_FALSE; 982dff31646SBarry Smith PetscBool flg; 98310463e74SBarry Smith #if defined(PETSC_USE_LOG) 98410463e74SBarry Smith char mname[PETSC_MAX_PATH_LEN]; 98510463e74SBarry Smith #endif 986e5c89e4eSSatish Balay 987e5c89e4eSSatish Balay PetscFunctionBegin; 988e5c89e4eSSatish Balay if (!PetscInitializeCalled) { 9894b09e917SBarry Smith printf("PetscInitialize() must be called before PetscFinalize()\n"); 9904b09e917SBarry Smith PetscFunctionReturn(PETSC_ERR_ARG_WRONGSTATE); 991e5c89e4eSSatish Balay } 9920298fd71SBarry Smith ierr = PetscInfo(NULL,"PetscFinalize() called\n");CHKERRQ(ierr); 993b022a5c1SBarry Smith 9941f817a21SBarry Smith ierr = MPI_Comm_rank(PETSC_COMM_WORLD,&rank);CHKERRQ(ierr); 9951f817a21SBarry Smith 9961f817a21SBarry Smith ierr = PetscOptionsHasName(NULL,"-citations",&flg);CHKERRQ(ierr); 997dff31646SBarry Smith if (flg) { 9981f817a21SBarry Smith char *cits, filename[PETSC_MAX_PATH_LEN]; 9991f817a21SBarry Smith FILE *fd = PETSC_STDOUT; 10001f817a21SBarry Smith 10011f817a21SBarry Smith ierr = PetscOptionsGetString(NULL,"-citations",filename,PETSC_MAX_PATH_LEN,NULL);CHKERRQ(ierr); 10021f817a21SBarry Smith if (filename[0]) { 10031f817a21SBarry Smith ierr = PetscFOpen(PETSC_COMM_WORLD,filename,"w",&fd);CHKERRQ(ierr); 10041f817a21SBarry Smith } 1005dff31646SBarry Smith ierr = PetscSegBufferGet(PetscCitationsList,1,&cits);CHKERRQ(ierr); 1006dff31646SBarry Smith cits[0] = 0; 1007dff31646SBarry Smith ierr = PetscSegBufferExtractAlloc(PetscCitationsList,&cits);CHKERRQ(ierr); 10081f817a21SBarry Smith ierr = PetscFPrintf(PETSC_COMM_WORLD,fd,"If you publish results based on this computation please cite the following:\n");CHKERRQ(ierr); 10091f817a21SBarry Smith ierr = PetscFPrintf(PETSC_COMM_WORLD,fd,"===========================================================================\n");CHKERRQ(ierr); 10101f817a21SBarry Smith ierr = PetscFPrintf(PETSC_COMM_WORLD,fd,"%s",cits);CHKERRQ(ierr); 10111f817a21SBarry Smith ierr = PetscFPrintf(PETSC_COMM_WORLD,fd,"===========================================================================\n");CHKERRQ(ierr); 10121f817a21SBarry Smith ierr = PetscFClose(PETSC_COMM_WORLD,fd);CHKERRQ(ierr); 1013dff31646SBarry Smith ierr = PetscFree(cits);CHKERRQ(ierr); 1014dff31646SBarry Smith } 1015dff31646SBarry Smith ierr = PetscSegBufferDestroy(&PetscCitationsList);CHKERRQ(ierr); 1016dff31646SBarry Smith 1017c2a97968SBarry Smith #if defined(PETSC_HAVE_SSL) && defined(PETSC_USE_SOCKET_VIEWER) 101804102261SBarry Smith /* TextBelt is run for testing purposes only, please do not use this feature often */ 101904102261SBarry Smith { 102004102261SBarry Smith PetscInt nmax = 2; 102104102261SBarry Smith char **buffs; 102204102261SBarry Smith ierr = PetscMalloc1(2,&buffs);CHKERRQ(ierr); 102304102261SBarry Smith ierr = PetscOptionsGetStringArray(NULL,"-textbelt",buffs,&nmax,&flg1);CHKERRQ(ierr); 102404102261SBarry Smith if (flg1) { 102504102261SBarry Smith if (!nmax) SETERRQ(PETSC_COMM_WORLD,PETSC_ERR_USER,"-textbelt requires either the phone number or number,\"message\""); 102604102261SBarry Smith if (nmax == 1) { 102704102261SBarry Smith ierr = PetscMalloc1(128,&buffs[1]);CHKERRQ(ierr); 102804102261SBarry Smith ierr = PetscGetProgramName(buffs[1],32);CHKERRQ(ierr); 102904102261SBarry Smith ierr = PetscStrcat(buffs[1]," has completed");CHKERRQ(ierr); 103004102261SBarry Smith } 103104102261SBarry Smith ierr = PetscTextBelt(PETSC_COMM_WORLD,buffs[0],buffs[1],NULL);CHKERRQ(ierr); 103204102261SBarry Smith ierr = PetscFree(buffs[0]);CHKERRQ(ierr); 103304102261SBarry Smith ierr = PetscFree(buffs[1]);CHKERRQ(ierr); 103404102261SBarry Smith } 103504102261SBarry Smith ierr = PetscFree(buffs);CHKERRQ(ierr); 103604102261SBarry Smith } 103704102261SBarry Smith #endif 103867234432SDmitry Karpeev /* 103967234432SDmitry Karpeev It should be safe to cancel the options monitors, since we don't expect to be setting options 104067234432SDmitry Karpeev here (at least that are worth monitoring). Monitors ought to be released so that they release 104167234432SDmitry Karpeev whatever memory was allocated there before -malloc_dump reports unfreed memory. 104267234432SDmitry Karpeev */ 104367234432SDmitry Karpeev ierr = PetscOptionsMonitorCancel();CHKERRQ(ierr); 104404102261SBarry Smith 10452d53ad75SBarry Smith #if defined(PETSC_SERIALIZE_FUNCTIONS) 10462d53ad75SBarry Smith ierr = PetscFPTDestroy();CHKERRQ(ierr); 10472d53ad75SBarry Smith #endif 10482d53ad75SBarry Smith 10492d53ad75SBarry Smith 1050e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS) 1051dff31646SBarry Smith flg = PETSC_FALSE; 1052e78c4b8cSBarry Smith ierr = PetscOptionsGetBool(NULL,"-saw_options",&flg,NULL);CHKERRQ(ierr); 1053d5649816SBarry Smith if (flg) { 1054e04113cfSBarry Smith ierr = PetscOptionsSAWsDestroy();CHKERRQ(ierr); 1055d5649816SBarry Smith } 1056d5649816SBarry Smith #endif 1057d5649816SBarry Smith 1058681455b2SBarry Smith #if defined(PETSC_HAVE_X) 1059681455b2SBarry Smith flg1 = PETSC_FALSE; 1060681455b2SBarry Smith ierr = PetscOptionsGetBool(NULL,"-x_virtual",&flg1,NULL);CHKERRQ(ierr); 1061681455b2SBarry Smith if (flg1) { 1062681455b2SBarry Smith /* this is a crude hack, but better than nothing */ 1063681455b2SBarry Smith ierr = PetscPOpen(PETSC_COMM_WORLD,NULL,"pkill -9 Xvfb","r",NULL);CHKERRQ(ierr); 1064681455b2SBarry Smith } 1065681455b2SBarry Smith #endif 1066681455b2SBarry Smith 106767584ceeSBarry Smith #if !defined(PETSC_HAVE_THREADSAFETY) 10680298fd71SBarry Smith ierr = PetscOptionsGetBool(NULL,"-malloc_info",&flg2,NULL);CHKERRQ(ierr); 1069e5c89e4eSSatish Balay if (!flg2) { 107090d69ab7SBarry Smith flg2 = PETSC_FALSE; 10710841954dSBarry Smith ierr = PetscOptionsGetBool(NULL,"-memory_view",&flg2,NULL);CHKERRQ(ierr); 1072e5c89e4eSSatish Balay } 1073e5c89e4eSSatish Balay if (flg2) { 10740841954dSBarry Smith ierr = PetscMemoryView(PETSC_VIEWER_STDOUT_WORLD,"Summary of Memory Usage in PETSc\n");CHKERRQ(ierr); 1075e5c89e4eSSatish Balay } 107667584ceeSBarry Smith #endif 1077e5c89e4eSSatish Balay 1078e5c89e4eSSatish Balay #if defined(PETSC_USE_LOG) 107990d69ab7SBarry Smith flg1 = PETSC_FALSE; 10800298fd71SBarry Smith ierr = PetscOptionsGetBool(NULL,"-get_total_flops",&flg1,NULL);CHKERRQ(ierr); 1081e5c89e4eSSatish Balay if (flg1) { 1082e5c89e4eSSatish Balay PetscLogDouble flops = 0; 1083205a32c2SJed Brown ierr = MPI_Reduce(&petsc_TotalFlops,&flops,1,MPI_DOUBLE,MPI_SUM,0,PETSC_COMM_WORLD);CHKERRQ(ierr); 1084e5c89e4eSSatish Balay ierr = PetscPrintf(PETSC_COMM_WORLD,"Total flops over all processors %g\n",flops);CHKERRQ(ierr); 1085e5c89e4eSSatish Balay } 1086e5c89e4eSSatish Balay #endif 1087e5c89e4eSSatish Balay 1088e5c89e4eSSatish Balay 1089e5c89e4eSSatish Balay #if defined(PETSC_USE_LOG) 1090e5c89e4eSSatish Balay #if defined(PETSC_HAVE_MPE) 1091e5c89e4eSSatish Balay mname[0] = 0; 1092a297a907SKarl Rupp 10930298fd71SBarry Smith ierr = PetscOptionsGetString(NULL,"-log_mpe",mname,PETSC_MAX_PATH_LEN,&flg1);CHKERRQ(ierr); 1094e5c89e4eSSatish Balay if (flg1) { 1095e5c89e4eSSatish Balay if (mname[0]) {ierr = PetscLogMPEDump(mname);CHKERRQ(ierr);} 1096e5c89e4eSSatish Balay else {ierr = PetscLogMPEDump(0);CHKERRQ(ierr);} 1097e5c89e4eSSatish Balay } 1098e5c89e4eSSatish Balay #endif 1099e5c89e4eSSatish Balay mname[0] = 0; 1100a297a907SKarl Rupp 1101f14045dbSBarry Smith ierr = PetscLogViewFromOptions();CHKERRQ(ierr); 11020298fd71SBarry Smith ierr = PetscOptionsGetString(NULL,"-log_summary",mname,PETSC_MAX_PATH_LEN,&flg1);CHKERRQ(ierr); 1103e5c89e4eSSatish Balay if (flg1) { 110491eabc43SBarry Smith PetscViewer viewer; 110591eabc43SBarry Smith if (mname[0]) { 110691eabc43SBarry Smith ierr = PetscViewerASCIIOpen(PETSC_COMM_WORLD,mname,&viewer);CHKERRQ(ierr); 110791eabc43SBarry Smith ierr = PetscLogView(viewer);CHKERRQ(ierr); 11086bf464f9SBarry Smith ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr); 110933f85c2fSBarry Smith } else { 111033f85c2fSBarry Smith viewer = PETSC_VIEWER_STDOUT_WORLD; 111133f85c2fSBarry Smith ierr = PetscLogView(viewer);CHKERRQ(ierr); 111233f85c2fSBarry Smith } 1113e5c89e4eSSatish Balay } 1114e5c89e4eSSatish Balay mname[0] = 0; 1115a297a907SKarl Rupp 11160298fd71SBarry Smith ierr = PetscOptionsGetString(NULL,"-log_all",mname,PETSC_MAX_PATH_LEN,&flg1);CHKERRQ(ierr); 11170298fd71SBarry Smith ierr = PetscOptionsGetString(NULL,"-log",mname,PETSC_MAX_PATH_LEN,&flg2);CHKERRQ(ierr); 1118e5c89e4eSSatish Balay if (flg1 || flg2) { 1119e5c89e4eSSatish Balay if (mname[0]) PetscLogDump(mname); 1120e5c89e4eSSatish Balay else PetscLogDump(0); 1121e5c89e4eSSatish Balay } 1122e5c89e4eSSatish Balay #endif 112310463e74SBarry Smith 1124b58ca069SBarry Smith /* 1125b58ca069SBarry Smith Free all objects registered with PetscObjectRegisterDestroy() such as PETSC_VIEWER_XXX_(). 1126b58ca069SBarry Smith */ 1127b58ca069SBarry Smith ierr = PetscObjectRegisterDestroyAll();CHKERRQ(ierr); 1128b58ca069SBarry Smith 112933f85c2fSBarry Smith ierr = PetscStackDestroy();CHKERRQ(ierr); 113010463e74SBarry Smith 113190d69ab7SBarry Smith flg1 = PETSC_FALSE; 11320298fd71SBarry Smith ierr = PetscOptionsGetBool(NULL,"-no_signal_handler",&flg1,NULL);CHKERRQ(ierr); 1133e5c89e4eSSatish Balay if (!flg1) { ierr = PetscPopSignalHandler();CHKERRQ(ierr);} 113490d69ab7SBarry Smith flg1 = PETSC_FALSE; 11350298fd71SBarry Smith ierr = PetscOptionsGetBool(NULL,"-mpidump",&flg1,NULL);CHKERRQ(ierr); 1136e5c89e4eSSatish Balay if (flg1) { 1137e5c89e4eSSatish Balay ierr = PetscMPIDump(stdout);CHKERRQ(ierr); 1138e5c89e4eSSatish Balay } 113990d69ab7SBarry Smith flg1 = PETSC_FALSE; 114090d69ab7SBarry Smith flg2 = PETSC_FALSE; 11418bb29257SSatish Balay /* preemptive call to avoid listing this option in options table as unused */ 11420298fd71SBarry Smith ierr = PetscOptionsHasName(NULL,"-malloc_dump",&flg1);CHKERRQ(ierr); 11430298fd71SBarry Smith ierr = PetscOptionsHasName(NULL,"-objects_dump",&flg1);CHKERRQ(ierr); 1144662a7babSBarry Smith ierr = PetscOptionsGetBool(NULL,"-options_view",&flg2,NULL);CHKERRQ(ierr); 1145e4c476e2SSatish Balay 1146e5c89e4eSSatish Balay if (flg2) { 1147be56827dSJed Brown PetscViewer viewer; 114802ba9f54SBarry Smith ierr = PetscViewerCreate(PETSC_COMM_WORLD,&viewer);CHKERRQ(ierr); 114902ba9f54SBarry Smith ierr = PetscViewerSetType(viewer,PETSCVIEWERASCII);CHKERRQ(ierr); 1150be56827dSJed Brown ierr = PetscOptionsView(viewer);CHKERRQ(ierr); 1151be56827dSJed Brown ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr); 1152e5c89e4eSSatish Balay } 1153e5c89e4eSSatish Balay 1154e5c89e4eSSatish Balay /* to prevent PETSc -options_left from warning */ 11550298fd71SBarry Smith ierr = PetscOptionsHasName(NULL,"-nox",&flg1);CHKERRQ(ierr); 11560298fd71SBarry Smith ierr = PetscOptionsHasName(NULL,"-nox_warning",&flg1);CHKERRQ(ierr); 1157e5c89e4eSSatish Balay 115833fc4174SSatish Balay flg3 = PETSC_FALSE; /* default value is required */ 11590298fd71SBarry Smith ierr = PetscOptionsGetBool(NULL,"-options_left",&flg3,&flg1);CHKERRQ(ierr); 1160e5c89e4eSSatish Balay ierr = PetscOptionsAllUsed(&nopt);CHKERRQ(ierr); 1161e5c89e4eSSatish Balay if (flg3) { 1162e5c89e4eSSatish Balay if (!flg2) { /* have not yet printed the options */ 1163be56827dSJed Brown PetscViewer viewer; 116402ba9f54SBarry Smith ierr = PetscViewerCreate(PETSC_COMM_WORLD,&viewer);CHKERRQ(ierr); 116502ba9f54SBarry Smith ierr = PetscViewerSetType(viewer,PETSCVIEWERASCII);CHKERRQ(ierr); 1166be56827dSJed Brown ierr = PetscOptionsView(viewer);CHKERRQ(ierr); 1167be56827dSJed Brown ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr); 1168e5c89e4eSSatish Balay } 1169e5c89e4eSSatish Balay if (!nopt) { 1170e5c89e4eSSatish Balay ierr = PetscPrintf(PETSC_COMM_WORLD,"There are no unused options.\n");CHKERRQ(ierr); 1171e5c89e4eSSatish Balay } else if (nopt == 1) { 1172e5c89e4eSSatish Balay ierr = PetscPrintf(PETSC_COMM_WORLD,"There is one unused database option. It is:\n");CHKERRQ(ierr); 1173e5c89e4eSSatish Balay } else { 11747582186dSLisandro Dalcin ierr = PetscPrintf(PETSC_COMM_WORLD,"There are %D unused database options. They are:\n",nopt);CHKERRQ(ierr); 1175e5c89e4eSSatish Balay } 1176df12ba86SBarry Smith } 1177e5c89e4eSSatish Balay #if defined(PETSC_USE_DEBUG) 1178da8b8a77SBarry Smith if (nopt && !flg3 && !flg1) { 1179e5c89e4eSSatish Balay ierr = PetscPrintf(PETSC_COMM_WORLD,"WARNING! There are options you set that were not used!\n");CHKERRQ(ierr); 1180e5c89e4eSSatish Balay ierr = PetscPrintf(PETSC_COMM_WORLD,"WARNING! could be spelling mistake, etc!\n");CHKERRQ(ierr); 1181e5c89e4eSSatish Balay ierr = PetscOptionsLeft();CHKERRQ(ierr); 1182e5c89e4eSSatish Balay } else if (nopt && flg3) { 1183e5c89e4eSSatish Balay #else 1184e5c89e4eSSatish Balay if (nopt && flg3) { 1185e5c89e4eSSatish Balay #endif 1186e5c89e4eSSatish Balay ierr = PetscOptionsLeft();CHKERRQ(ierr); 1187e5c89e4eSSatish Balay } 1188e5c89e4eSSatish Balay 1189e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS) 1190d45a07a7SBarry Smith if (!PetscGlobalRank) { 119187f587eeSBarry Smith ierr = PetscStackSAWsViewOff();CHKERRQ(ierr); 119216ad0300SBarry Smith PetscStackCallSAWs(SAWs_Finalize,()); 1193d45a07a7SBarry Smith } 1194ec957eceSBarry Smith #endif 1195ec957eceSBarry Smith 11964097062eSBarry Smith #if defined(PETSC_USE_LOG) 119710463e74SBarry Smith /* 1198dbc8283eSBarry Smith List all objects the user may have forgot to free 11992eff7a51SBarry Smith */ 120005df10baSBarry Smith if (PetscObjectsLog) { 12010298fd71SBarry Smith ierr = PetscOptionsHasName(NULL,"-objects_dump",&flg1);CHKERRQ(ierr); 1202a64a8e02SBarry Smith if (flg1) { 1203a64a8e02SBarry Smith MPI_Comm local_comm; 12047eb1d149SBarry Smith char string[64]; 1205a64a8e02SBarry Smith 12060298fd71SBarry Smith ierr = PetscOptionsGetString(NULL,"-objects_dump",string,64,NULL);CHKERRQ(ierr); 1207a64a8e02SBarry Smith ierr = MPI_Comm_dup(MPI_COMM_WORLD,&local_comm);CHKERRQ(ierr); 1208a64a8e02SBarry Smith ierr = PetscSequentialPhaseBegin_Private(local_comm,1);CHKERRQ(ierr); 12097eb1d149SBarry Smith ierr = PetscObjectsDump(stdout,(string[0] == 'a') ? PETSC_TRUE : PETSC_FALSE);CHKERRQ(ierr); 1210a64a8e02SBarry Smith ierr = PetscSequentialPhaseEnd_Private(local_comm,1);CHKERRQ(ierr); 1211a64a8e02SBarry Smith ierr = MPI_Comm_free(&local_comm);CHKERRQ(ierr); 12120a1571b3SBarry Smith } 121305df10baSBarry Smith } 12144097062eSBarry Smith #endif 12154097062eSBarry Smith 12164097062eSBarry Smith #if defined(PETSC_USE_LOG) 1217dbc8283eSBarry Smith PetscObjectsCounts = 0; 1218dbc8283eSBarry Smith PetscObjectsMaxCounts = 0; 1219a297a907SKarl Rupp ierr = PetscFree(PetscObjects);CHKERRQ(ierr); 12204097062eSBarry Smith #endif 12212eff7a51SBarry Smith 122233f85c2fSBarry Smith /* 122322b6d1caSBarry Smith Close any open dynamic libraries 122422b6d1caSBarry Smith */ 122522b6d1caSBarry Smith ierr = PetscFinalize_DynamicLibraries();CHKERRQ(ierr); 122622b6d1caSBarry Smith 122722b6d1caSBarry Smith /* 122833f85c2fSBarry Smith Destroy any packages that registered a finalize 122933f85c2fSBarry Smith */ 123033f85c2fSBarry Smith ierr = PetscRegisterFinalizeAll();CHKERRQ(ierr); 123133f85c2fSBarry Smith 1232*101409b8SToby Isaac #if defined(PETSC_USE_LOG) 1233*101409b8SToby Isaac ierr = PetscLogDestroy();CHKERRQ(ierr); 1234*101409b8SToby Isaac #endif 1235*101409b8SToby Isaac 123633f85c2fSBarry Smith /* 123748dd1dffSBarry Smith Print PetscFunctionLists that have not been properly freed 123848dd1dffSBarry Smith 123937e93019SBarry Smith ierr = PetscFunctionListPrintAll();CHKERRQ(ierr); 124048dd1dffSBarry Smith */ 124137e93019SBarry Smith 12424028d114SSatish Balay if (petsc_history) { 1243f3dea69dSBarry Smith ierr = PetscCloseHistoryFile(&petsc_history);CHKERRQ(ierr); 1244e5c89e4eSSatish Balay petsc_history = 0; 1245e5c89e4eSSatish Balay } 1246e5c89e4eSSatish Balay 12470298fd71SBarry Smith ierr = PetscInfoAllow(PETSC_FALSE,NULL);CHKERRQ(ierr); 1248e5c89e4eSSatish Balay 124967584ceeSBarry Smith #if !defined(PETSC_HAVE_THREADSAFETY) 12508bb29257SSatish Balay { 1251e5c89e4eSSatish Balay char fname[PETSC_MAX_PATH_LEN]; 1252e5c89e4eSSatish Balay FILE *fd; 1253ed9cf6e9SBarry Smith int err; 1254e5c89e4eSSatish Balay 1255e5c89e4eSSatish Balay fname[0] = 0; 1256a297a907SKarl Rupp 12570298fd71SBarry Smith ierr = PetscOptionsGetString(NULL,"-malloc_dump",fname,250,&flg1);CHKERRQ(ierr); 1258dc92acbaSJed Brown flg2 = PETSC_FALSE; 12590298fd71SBarry Smith ierr = PetscOptionsGetBool(NULL,"-malloc_test",&flg2,NULL);CHKERRQ(ierr); 12608bf1f09cSShri Abhyankar #if defined(PETSC_USE_DEBUG) 1261dc92acbaSJed Brown if (PETSC_RUNNING_ON_VALGRIND) flg2 = PETSC_FALSE; 1262dc92acbaSJed Brown #else 1263dc92acbaSJed Brown flg2 = PETSC_FALSE; /* Skip reporting for optimized builds regardless of -malloc_test */ 1264dc92acbaSJed Brown #endif 1265e5c89e4eSSatish Balay if (flg1 && fname[0]) { 1266e5c89e4eSSatish Balay char sname[PETSC_MAX_PATH_LEN]; 1267e5c89e4eSSatish Balay 1268e5c89e4eSSatish Balay sprintf(sname,"%s_%d",fname,rank); 1269e32f2f54SBarry Smith fd = fopen(sname,"w"); if (!fd) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_FILE_OPEN,"Cannot open log file: %s",sname); 1270e5c89e4eSSatish Balay ierr = PetscMallocDump(fd);CHKERRQ(ierr); 1271ed9cf6e9SBarry Smith err = fclose(fd); 1272e32f2f54SBarry Smith if (err) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SYS,"fclose() failed on file"); 1273dc92acbaSJed Brown } else if (flg1 || flg2) { 1274e5c89e4eSSatish Balay MPI_Comm local_comm; 1275e5c89e4eSSatish Balay 1276e5c89e4eSSatish Balay ierr = MPI_Comm_dup(MPI_COMM_WORLD,&local_comm);CHKERRQ(ierr); 1277e5c89e4eSSatish Balay ierr = PetscSequentialPhaseBegin_Private(local_comm,1);CHKERRQ(ierr); 1278e5c89e4eSSatish Balay ierr = PetscMallocDump(stdout);CHKERRQ(ierr); 1279e5c89e4eSSatish Balay ierr = PetscSequentialPhaseEnd_Private(local_comm,1);CHKERRQ(ierr); 1280e5c89e4eSSatish Balay ierr = MPI_Comm_free(&local_comm);CHKERRQ(ierr); 1281e5c89e4eSSatish Balay } 1282e5c89e4eSSatish Balay } 1283a64a8e02SBarry Smith 12848bb29257SSatish Balay { 1285e5c89e4eSSatish Balay char fname[PETSC_MAX_PATH_LEN]; 12860298fd71SBarry Smith FILE *fd = NULL; 1287e5c89e4eSSatish Balay 1288e5c89e4eSSatish Balay fname[0] = 0; 1289a297a907SKarl Rupp 12900298fd71SBarry Smith ierr = PetscOptionsGetString(NULL,"-malloc_log",fname,250,&flg1);CHKERRQ(ierr); 12910298fd71SBarry Smith ierr = PetscOptionsHasName(NULL,"-malloc_log_threshold",&flg2);CHKERRQ(ierr); 1292e5c89e4eSSatish Balay if (flg1 && fname[0]) { 1293ed9cf6e9SBarry Smith int err; 1294e5c89e4eSSatish Balay 1295574034a9SJed Brown if (!rank) { 1296574034a9SJed Brown fd = fopen(fname,"w"); 1297574034a9SJed Brown if (!fd) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_FILE_OPEN,"Cannot open log file: %s",fname); 1298574034a9SJed Brown } 1299e5c89e4eSSatish Balay ierr = PetscMallocDumpLog(fd);CHKERRQ(ierr); 1300574034a9SJed Brown if (fd) { 1301ed9cf6e9SBarry Smith err = fclose(fd); 1302e32f2f54SBarry Smith if (err) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SYS,"fclose() failed on file"); 1303574034a9SJed Brown } 1304574034a9SJed Brown } else if (flg1 || flg2) { 1305e5c89e4eSSatish Balay ierr = PetscMallocDumpLog(stdout);CHKERRQ(ierr); 1306e5c89e4eSSatish Balay } 1307e5c89e4eSSatish Balay } 130867584ceeSBarry Smith #endif 130920e2c332SMatthew G. Knepley 131020e2c332SMatthew G. Knepley #if defined(PETSC_HAVE_CUDA) 131120e2c332SMatthew G. Knepley flg = PETSC_TRUE; 131220e2c332SMatthew G. Knepley ierr = PetscOptionsGetBool(NULL,"-cublas",&flg,NULL);CHKERRQ(ierr); 131320e2c332SMatthew G. Knepley if (flg) { 131420e2c332SMatthew G. Knepley PetscInt p; 131520e2c332SMatthew G. Knepley for (p = 0; p < PetscGlobalSize; ++p) { 131620e2c332SMatthew G. Knepley if (p == PetscGlobalRank) cublasShutdown(); 131720e2c332SMatthew G. Knepley ierr = MPI_Barrier(PETSC_COMM_WORLD);CHKERRQ(ierr); 131820e2c332SMatthew G. Knepley } 131920e2c332SMatthew G. Knepley } 132020e2c332SMatthew G. Knepley #endif 132120e2c332SMatthew G. Knepley 1322e5c89e4eSSatish Balay /* Can be destroyed only after all the options are used */ 1323e5c89e4eSSatish Balay ierr = PetscOptionsDestroy();CHKERRQ(ierr); 1324e5c89e4eSSatish Balay 1325e5c89e4eSSatish Balay PetscGlobalArgc = 0; 1326e5c89e4eSSatish Balay PetscGlobalArgs = 0; 1327e5c89e4eSSatish Balay 1328ce63c4c1SBarry Smith #if defined(PETSC_USE_REAL___FLOAT128) 1329c90a1750SBarry Smith ierr = MPI_Type_free(&MPIU___FLOAT128);CHKERRQ(ierr); 13307c2de775SJed Brown #if defined(PETSC_HAVE_COMPLEX) 13318c764dc5SJose Roman ierr = MPI_Type_free(&MPIU___COMPLEX128);CHKERRQ(ierr); 13328c764dc5SJose Roman #endif 1333d9822059SBarry Smith ierr = MPI_Op_free(&MPIU_MAX);CHKERRQ(ierr); 1334d9822059SBarry Smith ierr = MPI_Op_free(&MPIU_MIN);CHKERRQ(ierr); 1335c90a1750SBarry Smith #endif 1336c90a1750SBarry Smith 13377c2de775SJed Brown #if defined(PETSC_HAVE_COMPLEX) 13382c876bd9SBarry Smith #if !defined(PETSC_HAVE_MPI_C_DOUBLE_COMPLEX) 1339500d8756SSatish Balay ierr = MPI_Type_free(&MPIU_C_DOUBLE_COMPLEX);CHKERRQ(ierr); 1340500d8756SSatish Balay ierr = MPI_Type_free(&MPIU_C_COMPLEX);CHKERRQ(ierr); 13412c876bd9SBarry Smith #endif 1342e5c89e4eSSatish Balay #endif 1343cca4cb22SSatish Balay 13447c2de775SJed Brown #if (defined(PETSC_HAVE_COMPLEX) && !defined(PETSC_HAVE_MPI_C_DOUBLE_COMPLEX)) || defined(PETSC_USE_REAL___FLOAT128) 1345cca4cb22SSatish Balay ierr = MPI_Op_free(&MPIU_SUM);CHKERRQ(ierr); 1346cca4cb22SSatish Balay #endif 1347cca4cb22SSatish Balay 1348e5c89e4eSSatish Balay ierr = MPI_Type_free(&MPIU_2SCALAR);CHKERRQ(ierr); 134944041f26SJed Brown #if defined(PETSC_USE_64BIT_INDICES) || !defined(MPI_2INT) 1350e5c89e4eSSatish Balay ierr = MPI_Type_free(&MPIU_2INT);CHKERRQ(ierr); 135144041f26SJed Brown #endif 1352e5c89e4eSSatish Balay ierr = MPI_Op_free(&PetscMaxSum_Op);CHKERRQ(ierr); 1353e5c89e4eSSatish Balay 1354dbc8283eSBarry Smith /* 1355efb80d3cSBarry Smith Destroy any known inner MPI_Comm's and attributes pointing to them 1356efb80d3cSBarry Smith Note this will not destroy any new communicators the user has created. 1357efb80d3cSBarry Smith 1358efb80d3cSBarry Smith If all PETSc objects were not destroyed those left over objects will have hanging references to 1359efb80d3cSBarry Smith the MPI_Comms that were freed; but that is ok because those PETSc objects will never be used again 1360dbc8283eSBarry Smith */ 1361b770b1f6SSatish Balay { 1362dbc8283eSBarry Smith PetscCommCounter *counter; 1363dbc8283eSBarry Smith PetscMPIInt flg; 1364dbc8283eSBarry Smith MPI_Comm icomm; 1365265f3f35SJed Brown union {MPI_Comm comm; void *ptr;} ucomm; 1366265f3f35SJed Brown ierr = MPI_Attr_get(PETSC_COMM_SELF,Petsc_InnerComm_keyval,&ucomm,&flg);CHKERRQ(ierr); 1367dbc8283eSBarry Smith if (flg) { 1368265f3f35SJed Brown icomm = ucomm.comm; 1369dbc8283eSBarry Smith ierr = MPI_Attr_get(icomm,Petsc_Counter_keyval,&counter,&flg);CHKERRQ(ierr); 1370dbc8283eSBarry 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"); 1371dbc8283eSBarry Smith 1372dbc8283eSBarry Smith ierr = MPI_Attr_delete(PETSC_COMM_SELF,Petsc_InnerComm_keyval);CHKERRQ(ierr); 1373efb80d3cSBarry Smith ierr = MPI_Attr_delete(icomm,Petsc_Counter_keyval);CHKERRQ(ierr); 1374efb80d3cSBarry Smith ierr = MPI_Comm_free(&icomm);CHKERRQ(ierr); 1375dbc8283eSBarry Smith } 1376265f3f35SJed Brown ierr = MPI_Attr_get(PETSC_COMM_WORLD,Petsc_InnerComm_keyval,&ucomm,&flg);CHKERRQ(ierr); 1377dbc8283eSBarry Smith if (flg) { 1378265f3f35SJed Brown icomm = ucomm.comm; 1379dbc8283eSBarry Smith ierr = MPI_Attr_get(icomm,Petsc_Counter_keyval,&counter,&flg);CHKERRQ(ierr); 1380dbc8283eSBarry 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"); 1381dbc8283eSBarry Smith 1382dbc8283eSBarry Smith ierr = MPI_Attr_delete(PETSC_COMM_WORLD,Petsc_InnerComm_keyval);CHKERRQ(ierr); 1383efb80d3cSBarry Smith ierr = MPI_Attr_delete(icomm,Petsc_Counter_keyval);CHKERRQ(ierr); 1384efb80d3cSBarry Smith ierr = MPI_Comm_free(&icomm);CHKERRQ(ierr); 1385dbc8283eSBarry Smith } 1386b770b1f6SSatish Balay } 1387dbc8283eSBarry Smith 1388480cf27aSJed Brown ierr = MPI_Keyval_free(&Petsc_Counter_keyval);CHKERRQ(ierr); 1389480cf27aSJed Brown ierr = MPI_Keyval_free(&Petsc_InnerComm_keyval);CHKERRQ(ierr); 1390480cf27aSJed Brown ierr = MPI_Keyval_free(&Petsc_OuterComm_keyval);CHKERRQ(ierr); 1391480cf27aSJed Brown 13925ad9ad5bSBarry Smith ierr = PetscSpinlockDestroy(&PetscViewerASCIISpinLockOpen);CHKERRQ(ierr); 13935ad9ad5bSBarry Smith ierr = PetscSpinlockDestroy(&PetscViewerASCIISpinLockStdout);CHKERRQ(ierr); 13945ad9ad5bSBarry Smith ierr = PetscSpinlockDestroy(&PetscViewerASCIISpinLockStderr);CHKERRQ(ierr); 1395ef19f930SBarry Smith ierr = PetscSpinlockDestroy(&PetscCommSpinLock);CHKERRQ(ierr); 1396ef19f930SBarry Smith 1397e5c89e4eSSatish Balay if (PetscBeganMPI) { 139899608316SBarry Smith #if defined(PETSC_HAVE_MPI_FINALIZED) 139999b1327fSBarry Smith PetscMPIInt flag; 140099b1327fSBarry Smith ierr = MPI_Finalized(&flag);CHKERRQ(ierr); 1401e32f2f54SBarry Smith if (flag) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_LIB,"MPI_Finalize() has already been called, even though MPI_Init() was called by PetscInitialize()"); 140299608316SBarry Smith #endif 1403e5c89e4eSSatish Balay ierr = MPI_Finalize();CHKERRQ(ierr); 1404e5c89e4eSSatish Balay } 1405e5c89e4eSSatish Balay /* 1406e5c89e4eSSatish Balay 1407e5c89e4eSSatish Balay Note: In certain cases PETSC_COMM_WORLD is never MPI_Comm_free()ed because 1408e5c89e4eSSatish Balay the communicator has some outstanding requests on it. Specifically if the 1409e5c89e4eSSatish Balay flag PETSC_HAVE_BROKEN_REQUEST_FREE is set (for IBM MPI implementation). See 1410e5c89e4eSSatish Balay src/vec/utils/vpscat.c. Due to this the memory allocated in PetscCommDuplicate() 1411e5c89e4eSSatish Balay is never freed as it should be. Thus one may obtain messages of the form 14120e5e90baSSatish Balay [ 1] 8 bytes PetscCommDuplicate() line 645 in src/sys/mpiu.c indicating the 1413e5c89e4eSSatish Balay memory was not freed. 1414e5c89e4eSSatish Balay 1415e5c89e4eSSatish Balay */ 14161d1a0024SBarry Smith ierr = PetscMallocClear();CHKERRQ(ierr); 1417a297a907SKarl Rupp 1418e5c89e4eSSatish Balay PetscInitializeCalled = PETSC_FALSE; 1419e5c89e4eSSatish Balay PetscFinalizeCalled = PETSC_TRUE; 1420e5c89e4eSSatish Balay PetscFunctionReturn(ierr); 1421e5c89e4eSSatish Balay } 1422e5c89e4eSSatish Balay 142343db4dbbSBarry Smith #if defined(PETSC_MISSING_LAPACK_lsame_) 14248cc058d9SJed Brown PETSC_EXTERN int lsame_(char *a,char *b) 142543db4dbbSBarry Smith { 142643db4dbbSBarry Smith if (*a == *b) return 1; 142743db4dbbSBarry Smith if (*a + 32 == *b) return 1; 142843db4dbbSBarry Smith if (*a - 32 == *b) return 1; 142943db4dbbSBarry Smith return 0; 143043db4dbbSBarry Smith } 1431a70650f6SBarry Smith #endif 143243db4dbbSBarry Smith 143343db4dbbSBarry Smith #if defined(PETSC_MISSING_LAPACK_lsame) 14348cc058d9SJed Brown PETSC_EXTERN int lsame(char *a,char *b) 143543db4dbbSBarry Smith { 143643db4dbbSBarry Smith if (*a == *b) return 1; 143743db4dbbSBarry Smith if (*a + 32 == *b) return 1; 143843db4dbbSBarry Smith if (*a - 32 == *b) return 1; 143943db4dbbSBarry Smith return 0; 144043db4dbbSBarry Smith } 144143db4dbbSBarry Smith #endif 1442