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) 14*896238b9SBarry 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 206b693b147SBarry Smith The reason nprocs[2*i] contains lengths nprocs[2*i+1] contains flag of 1 if length is nonzero 207b693b147SBarry Smith is so that the PetscMaxSum_Op() can set TWO values, if we passed in only nprocs[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 PetscMPIInt size,rank; 2156ac3741eSJed Brown struct {PetscInt max,sum;} *work; 216e5c89e4eSSatish Balay PetscErrorCode ierr; 217e5c89e4eSSatish Balay 218e5c89e4eSSatish Balay PetscFunctionBegin; 219e5c89e4eSSatish Balay ierr = MPI_Comm_size(comm,&size);CHKERRQ(ierr); 220e5c89e4eSSatish Balay ierr = MPI_Comm_rank(comm,&rank);CHKERRQ(ierr); 221785e854fSJed Brown ierr = PetscMalloc1(size,&work);CHKERRQ(ierr); 22276ec1555SBarry Smith ierr = MPI_Allreduce((void*)sizes,work,size,MPIU_2INT,PetscMaxSum_Op,comm);CHKERRQ(ierr); 2236ac3741eSJed Brown *max = work[rank].max; 2246ac3741eSJed Brown *sum = work[rank].sum; 225e5c89e4eSSatish Balay ierr = PetscFree(work);CHKERRQ(ierr); 226e5c89e4eSSatish Balay PetscFunctionReturn(0); 227e5c89e4eSSatish Balay } 228e5c89e4eSSatish Balay 229e5c89e4eSSatish Balay /* ----------------------------------------------------------------------------*/ 230e5c89e4eSSatish Balay 2317c2de775SJed Brown #if (defined(PETSC_HAVE_COMPLEX) && !defined(PETSC_HAVE_MPI_C_DOUBLE_COMPLEX)) || defined(PETSC_USE_REAL___FLOAT128) 23206a205a8SBarry Smith MPI_Op MPIU_SUM = 0; 233e5c89e4eSSatish Balay 234e5c89e4eSSatish Balay #undef __FUNCT__ 235e5c89e4eSSatish Balay #define __FUNCT__ "PetscSum_Local" 2368cc058d9SJed Brown PETSC_EXTERN void PetscSum_Local(void *in,void *out,PetscMPIInt *cnt,MPI_Datatype *datatype) 237e5c89e4eSSatish Balay { 238e5c89e4eSSatish Balay PetscInt i,count = *cnt; 239e5c89e4eSSatish Balay 240e5c89e4eSSatish Balay PetscFunctionBegin; 2417c2de775SJed Brown if (*datatype == MPIU_REAL) { 242e2e03761SBarry Smith PetscReal *xin = (PetscReal*)in,*xout = (PetscReal*)out; 243a297a907SKarl Rupp for (i=0; i<count; i++) xout[i] += xin[i]; 2447c2de775SJed Brown } 2457c2de775SJed Brown #if defined(PETSC_HAVE_COMPLEX) 2467c2de775SJed Brown else if (*datatype == MPIU_COMPLEX) { 2477c2de775SJed Brown PetscComplex *xin = (PetscComplex*)in,*xout = (PetscComplex*)out; 248a297a907SKarl Rupp for (i=0; i<count; i++) xout[i] += xin[i]; 2497c2de775SJed Brown } 2507c2de775SJed Brown #endif 2517c2de775SJed Brown else { 2527c2de775SJed Brown (*PetscErrorPrintf)("Can only handle MPIU_REAL or MPIU_COMPLEX data types"); 253e2e03761SBarry Smith MPI_Abort(MPI_COMM_WORLD,1); 254e2e03761SBarry Smith } 255812af9f3SBarry Smith PetscFunctionReturnVoid(); 256e5c89e4eSSatish Balay } 257e5c89e4eSSatish Balay #endif 258e5c89e4eSSatish Balay 259ce63c4c1SBarry Smith #if defined(PETSC_USE_REAL___FLOAT128) 260d9822059SBarry Smith MPI_Op MPIU_MAX = 0; 261d9822059SBarry Smith MPI_Op MPIU_MIN = 0; 262d9822059SBarry Smith 263d9822059SBarry Smith #undef __FUNCT__ 264d9822059SBarry Smith #define __FUNCT__ "PetscMax_Local" 2658cc058d9SJed Brown PETSC_EXTERN void PetscMax_Local(void *in,void *out,PetscMPIInt *cnt,MPI_Datatype *datatype) 266d9822059SBarry Smith { 267d9822059SBarry Smith PetscInt i,count = *cnt; 268d9822059SBarry Smith 269d9822059SBarry Smith PetscFunctionBegin; 2707c2de775SJed Brown if (*datatype == MPIU_REAL) { 2718c764dc5SJose Roman PetscReal *xin = (PetscReal*)in,*xout = (PetscReal*)out; 272a297a907SKarl Rupp for (i=0; i<count; i++) xout[i] = PetscMax(xout[i],xin[i]); 2737c2de775SJed Brown } 2747c2de775SJed Brown #if defined(PETSC_HAVE_COMPLEX) 2757c2de775SJed Brown else if (*datatype == MPIU_COMPLEX) { 2767c2de775SJed Brown PetscComplex *xin = (PetscComplex*)in,*xout = (PetscComplex*)out; 2777c2de775SJed Brown for (i=0; i<count; i++) { 2787c2de775SJed Brown xout[i] = PetscRealPartComplex(xout[i])<PetscRealPartComplex(xin[i]) ? xin[i] : xout[i]; 2797c2de775SJed Brown } 2807c2de775SJed Brown } 2817c2de775SJed Brown #endif 2827c2de775SJed Brown else { 2837c2de775SJed Brown (*PetscErrorPrintf)("Can only handle MPIU_REAL or MPIU_COMPLEX data types"); 2848c764dc5SJose Roman MPI_Abort(MPI_COMM_WORLD,1); 2858c764dc5SJose Roman } 286d9822059SBarry Smith PetscFunctionReturnVoid(); 287d9822059SBarry Smith } 288d9822059SBarry Smith 289d9822059SBarry Smith #undef __FUNCT__ 290d9822059SBarry Smith #define __FUNCT__ "PetscMin_Local" 2918cc058d9SJed Brown PETSC_EXTERN void PetscMin_Local(void *in,void *out,PetscMPIInt *cnt,MPI_Datatype *datatype) 292d9822059SBarry Smith { 293d9822059SBarry Smith PetscInt i,count = *cnt; 294d9822059SBarry Smith 295d9822059SBarry Smith PetscFunctionBegin; 2967c2de775SJed Brown if (*datatype == MPIU_REAL) { 2978c764dc5SJose Roman PetscReal *xin = (PetscReal*)in,*xout = (PetscReal*)out; 298a297a907SKarl Rupp for (i=0; i<count; i++) xout[i] = PetscMin(xout[i],xin[i]); 2997c2de775SJed Brown } 3007c2de775SJed Brown #if defined(PETSC_HAVE_COMPLEX) 3017c2de775SJed Brown else if (*datatype == MPIU_COMPLEX) { 3027c2de775SJed Brown PetscComplex *xin = (PetscComplex*)in,*xout = (PetscComplex*)out; 3037c2de775SJed Brown for (i=0; i<count; i++) { 3047c2de775SJed Brown xout[i] = PetscRealPartComplex(xout[i])>PetscRealPartComplex(xin[i]) ? xin[i] : xout[i]; 3057c2de775SJed Brown } 3067c2de775SJed Brown } 3077c2de775SJed Brown #endif 3087c2de775SJed Brown else { 3098c764dc5SJose Roman (*PetscErrorPrintf)("Can only handle MPIU_REAL or MPIU_SCALAR data (i.e. double or complex) types"); 3108c764dc5SJose Roman MPI_Abort(MPI_COMM_WORLD,1); 3118c764dc5SJose Roman } 312d9822059SBarry Smith PetscFunctionReturnVoid(); 313d9822059SBarry Smith } 314d9822059SBarry Smith #endif 315d9822059SBarry Smith 316480cf27aSJed Brown #undef __FUNCT__ 317480cf27aSJed Brown #define __FUNCT__ "Petsc_DelCounter" 318480cf27aSJed Brown /* 319480cf27aSJed Brown Private routine to delete internal tag/name counter storage when a communicator is freed. 320480cf27aSJed Brown 321ff0e51ddSBarry 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. 322480cf27aSJed Brown 323480cf27aSJed Brown Note: this is declared extern "C" because it is passed to MPI_Keyval_create() 324480cf27aSJed Brown 325480cf27aSJed Brown */ 3268cc058d9SJed Brown PETSC_EXTERN PetscMPIInt MPIAPI Petsc_DelCounter(MPI_Comm comm,PetscMPIInt keyval,void *count_val,void *extra_state) 327480cf27aSJed Brown { 328480cf27aSJed Brown PetscErrorCode ierr; 329480cf27aSJed Brown 330480cf27aSJed Brown PetscFunctionBegin; 331480cf27aSJed Brown ierr = PetscInfo1(0,"Deleting counter data in an MPI_Comm %ld\n",(long)comm);if (ierr) PetscFunctionReturn((PetscMPIInt)ierr); 332480cf27aSJed Brown ierr = PetscFree(count_val);if (ierr) PetscFunctionReturn((PetscMPIInt)ierr); 333480cf27aSJed Brown PetscFunctionReturn(MPI_SUCCESS); 334480cf27aSJed Brown } 335480cf27aSJed Brown 336480cf27aSJed Brown #undef __FUNCT__ 337da3039f7SJed Brown #define __FUNCT__ "Petsc_DelComm_Outer" 338480cf27aSJed Brown /* 339da3039f7SJed Brown This is invoked on the outer comm as a result of either PetscCommDestroy() (via MPI_Attr_delete) or when the user 340da3039f7SJed Brown calls MPI_Comm_free(). 341da3039f7SJed Brown 342da3039f7SJed Brown This is the only entry point for breaking the links between inner and outer comms. 343480cf27aSJed Brown 344ff0e51ddSBarry Smith This is called by MPI, not by users. This is called when MPI_Comm_free() is called on the communicator. 345480cf27aSJed Brown 346480cf27aSJed Brown Note: this is declared extern "C" because it is passed to MPI_Keyval_create() 347480cf27aSJed Brown 348480cf27aSJed Brown */ 349da3039f7SJed Brown PETSC_EXTERN PetscMPIInt MPIAPI Petsc_DelComm_Outer(MPI_Comm comm,PetscMPIInt keyval,void *attr_val,void *extra_state) 350480cf27aSJed Brown { 351480cf27aSJed Brown PetscErrorCode ierr; 352b89831e5SBarry Smith PetscMPIInt flg; 353265f3f35SJed Brown union {MPI_Comm comm; void *ptr;} icomm,ocomm; 354480cf27aSJed Brown 355480cf27aSJed Brown PetscFunctionBegin; 356da3039f7SJed Brown if (keyval != Petsc_InnerComm_keyval) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_CORRUPT,"Unexpected keyval"); 357ec4fadc2SJed Brown icomm.ptr = attr_val; 358da3039f7SJed Brown 359265f3f35SJed Brown ierr = MPI_Attr_get(icomm.comm,Petsc_OuterComm_keyval,&ocomm,&flg);CHKERRQ(ierr); 360b3ef52cdSBarry Smith if (!flg) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_CORRUPT,"Inner MPI_Comm does not have expected reference to outer comm"); 361da3039f7SJed Brown if (ocomm.comm != comm) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_CORRUPT,"Inner MPI_Comm has reference to non-matching outer comm"); 362da3039f7SJed Brown ierr = MPI_Attr_delete(icomm.comm,Petsc_OuterComm_keyval);CHKERRQ(ierr); /* Calls Petsc_DelComm_Inner */ 363da3039f7SJed 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); 364da3039f7SJed Brown PetscFunctionReturn(MPI_SUCCESS); 365b89831e5SBarry Smith } 366da3039f7SJed Brown 367da3039f7SJed Brown #undef __FUNCT__ 368da3039f7SJed Brown #define __FUNCT__ "Petsc_DelComm_Inner" 369da3039f7SJed Brown /* 370da3039f7SJed Brown * This is invoked on the inner comm when Petsc_DelComm_Outer calls MPI_Attr_delete. It should not be reached any other way. 371da3039f7SJed Brown */ 372da3039f7SJed Brown PETSC_EXTERN PetscMPIInt MPIAPI Petsc_DelComm_Inner(MPI_Comm comm,PetscMPIInt keyval,void *attr_val,void *extra_state) 373da3039f7SJed Brown { 374da3039f7SJed Brown PetscErrorCode ierr; 375da3039f7SJed Brown 376da3039f7SJed Brown PetscFunctionBegin; 377da3039f7SJed Brown ierr = PetscInfo1(0,"Removing reference to PETSc communicator embedded in a user MPI_Comm %ld\n",(long)comm);if (ierr) PetscFunctionReturn((PetscMPIInt)ierr); 378480cf27aSJed Brown PetscFunctionReturn(MPI_SUCCESS); 379480cf27aSJed Brown } 380480cf27aSJed Brown 381951e3c8eSBarry Smith #if defined(PETSC_USE_PETSC_MPI_EXTERNAL32) 382e39fd77fSBarry Smith #if !defined(PETSC_WORDS_BIGENDIAN) 3838cc058d9SJed Brown PETSC_EXTERN PetscMPIInt PetscDataRep_extent_fn(MPI_Datatype,MPI_Aint*,void*); 3848cc058d9SJed Brown PETSC_EXTERN PetscMPIInt PetscDataRep_read_conv_fn(void*, MPI_Datatype,PetscMPIInt,void*,MPI_Offset,void*); 3858cc058d9SJed Brown PETSC_EXTERN PetscMPIInt PetscDataRep_write_conv_fn(void*, MPI_Datatype,PetscMPIInt,void*,MPI_Offset,void*); 386e39fd77fSBarry Smith #endif 387951e3c8eSBarry Smith #endif 388e39fd77fSBarry Smith 3896ae9a8a6SBarry Smith int PetscGlobalArgc = 0; 3906ae9a8a6SBarry Smith char **PetscGlobalArgs = 0; 391dff31646SBarry Smith PetscSegBuffer PetscCitationsList; 392e5c89e4eSSatish Balay 393e5c89e4eSSatish Balay #undef __FUNCT__ 394051e4cf2SJed Brown #define __FUNCT__ "PetscCitationsInitialize" 395051e4cf2SJed Brown PetscErrorCode PetscCitationsInitialize() 396051e4cf2SJed Brown { 397051e4cf2SJed Brown PetscErrorCode ierr; 398051e4cf2SJed Brown 399051e4cf2SJed Brown PetscFunctionBegin; 400051e4cf2SJed Brown ierr = PetscSegBufferCreate(1,10000,&PetscCitationsList);CHKERRQ(ierr); 401840b20a7SSatish 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); 402051e4cf2SJed 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); 403051e4cf2SJed Brown PetscFunctionReturn(0); 404051e4cf2SJed Brown } 405e5c89e4eSSatish Balay 406e5c89e4eSSatish Balay #undef __FUNCT__ 407e5c89e4eSSatish Balay #define __FUNCT__ "PetscGetArgs" 408e5c89e4eSSatish Balay /*@C 409e5c89e4eSSatish Balay PetscGetArgs - Allows you to access the raw command line arguments anywhere 410e5c89e4eSSatish Balay after PetscInitialize() is called but before PetscFinalize(). 411e5c89e4eSSatish Balay 412e5c89e4eSSatish Balay Not Collective 413e5c89e4eSSatish Balay 414e5c89e4eSSatish Balay Output Parameters: 415e5c89e4eSSatish Balay + argc - count of number of command line arguments 416e5c89e4eSSatish Balay - args - the command line arguments 417e5c89e4eSSatish Balay 418e5c89e4eSSatish Balay Level: intermediate 419e5c89e4eSSatish Balay 420e5c89e4eSSatish Balay Notes: 421e5c89e4eSSatish Balay This is usually used to pass the command line arguments into other libraries 422e5c89e4eSSatish Balay that are called internally deep in PETSc or the application. 423e5c89e4eSSatish Balay 424f177e3b1SBarry Smith The first argument contains the program name as is normal for C arguments. 425f177e3b1SBarry Smith 426e5c89e4eSSatish Balay Concepts: command line arguments 427e5c89e4eSSatish Balay 428793721a6SBarry Smith .seealso: PetscFinalize(), PetscInitializeFortran(), PetscGetArguments() 429e5c89e4eSSatish Balay 430e5c89e4eSSatish Balay @*/ 4317087cfbeSBarry Smith PetscErrorCode PetscGetArgs(int *argc,char ***args) 432e5c89e4eSSatish Balay { 433e5c89e4eSSatish Balay PetscFunctionBegin; 43417186662SBarry Smith if (!PetscInitializeCalled && PetscFinalizeCalled) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ORDER,"You must call after PetscInitialize() but before PetscFinalize()"); 435e5c89e4eSSatish Balay *argc = PetscGlobalArgc; 436e5c89e4eSSatish Balay *args = PetscGlobalArgs; 437e5c89e4eSSatish Balay PetscFunctionReturn(0); 438e5c89e4eSSatish Balay } 439e5c89e4eSSatish Balay 440e5c89e4eSSatish Balay #undef __FUNCT__ 441793721a6SBarry Smith #define __FUNCT__ "PetscGetArguments" 442793721a6SBarry Smith /*@C 443793721a6SBarry Smith PetscGetArguments - Allows you to access the command line arguments anywhere 444793721a6SBarry Smith after PetscInitialize() is called but before PetscFinalize(). 445793721a6SBarry Smith 446793721a6SBarry Smith Not Collective 447793721a6SBarry Smith 448793721a6SBarry Smith Output Parameters: 449793721a6SBarry Smith . args - the command line arguments 450793721a6SBarry Smith 451793721a6SBarry Smith Level: intermediate 452793721a6SBarry Smith 453793721a6SBarry Smith Notes: 454793721a6SBarry Smith This does NOT start with the program name and IS null terminated (final arg is void) 455793721a6SBarry Smith 456793721a6SBarry Smith Concepts: command line arguments 457793721a6SBarry Smith 458793721a6SBarry Smith .seealso: PetscFinalize(), PetscInitializeFortran(), PetscGetArgs(), PetscFreeArguments() 459793721a6SBarry Smith 460793721a6SBarry Smith @*/ 4617087cfbeSBarry Smith PetscErrorCode PetscGetArguments(char ***args) 462793721a6SBarry Smith { 463793721a6SBarry Smith PetscInt i,argc = PetscGlobalArgc; 464793721a6SBarry Smith PetscErrorCode ierr; 465793721a6SBarry Smith 466793721a6SBarry Smith PetscFunctionBegin; 46717186662SBarry Smith if (!PetscInitializeCalled && PetscFinalizeCalled) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ORDER,"You must call after PetscInitialize() but before PetscFinalize()"); 468717030eeSLisandro Dalcin if (!argc) {*args = 0; PetscFunctionReturn(0);} 469785e854fSJed Brown ierr = PetscMalloc1(argc,args);CHKERRQ(ierr); 470793721a6SBarry Smith for (i=0; i<argc-1; i++) { 471793721a6SBarry Smith ierr = PetscStrallocpy(PetscGlobalArgs[i+1],&(*args)[i]);CHKERRQ(ierr); 472793721a6SBarry Smith } 473793721a6SBarry Smith (*args)[argc-1] = 0; 474793721a6SBarry Smith PetscFunctionReturn(0); 475793721a6SBarry Smith } 476793721a6SBarry Smith 477793721a6SBarry Smith #undef __FUNCT__ 478793721a6SBarry Smith #define __FUNCT__ "PetscFreeArguments" 479793721a6SBarry Smith /*@C 480793721a6SBarry Smith PetscFreeArguments - Frees the memory obtained with PetscGetArguments() 481793721a6SBarry Smith 482793721a6SBarry Smith Not Collective 483793721a6SBarry Smith 484793721a6SBarry Smith Output Parameters: 485793721a6SBarry Smith . args - the command line arguments 486793721a6SBarry Smith 487793721a6SBarry Smith Level: intermediate 488793721a6SBarry Smith 489793721a6SBarry Smith Concepts: command line arguments 490793721a6SBarry Smith 491793721a6SBarry Smith .seealso: PetscFinalize(), PetscInitializeFortran(), PetscGetArgs(), PetscGetArguments() 492793721a6SBarry Smith 493793721a6SBarry Smith @*/ 4947087cfbeSBarry Smith PetscErrorCode PetscFreeArguments(char **args) 495793721a6SBarry Smith { 496793721a6SBarry Smith PetscInt i = 0; 497793721a6SBarry Smith PetscErrorCode ierr; 498793721a6SBarry Smith 499793721a6SBarry Smith PetscFunctionBegin; 500a297a907SKarl Rupp if (!args) PetscFunctionReturn(0); 501793721a6SBarry Smith while (args[i]) { 502793721a6SBarry Smith ierr = PetscFree(args[i]);CHKERRQ(ierr); 503793721a6SBarry Smith i++; 504793721a6SBarry Smith } 505793721a6SBarry Smith ierr = PetscFree(args);CHKERRQ(ierr); 506793721a6SBarry Smith PetscFunctionReturn(0); 507793721a6SBarry Smith } 508793721a6SBarry Smith 50911525c0dSBarry Smith #if defined(PETSC_HAVE_SAWS) 51030befbd2SBarry Smith #include <petscconfiginfo.h> 51130befbd2SBarry Smith 51211525c0dSBarry Smith #undef __FUNCT__ 51311525c0dSBarry Smith #define __FUNCT__ "PetscInitializeSAWs" 51411525c0dSBarry Smith PetscErrorCode PetscInitializeSAWs(const char help[]) 51511525c0dSBarry Smith { 51611525c0dSBarry Smith if (!PetscGlobalRank) { 51730befbd2SBarry Smith char cert[PETSC_MAX_PATH_LEN],root[PETSC_MAX_PATH_LEN],*intro,programname[64],*appline,*options,version[64]; 51811525c0dSBarry Smith int port; 51911525c0dSBarry Smith PetscBool flg,rootlocal = PETSC_FALSE,flg2; 52011525c0dSBarry Smith size_t applinelen,introlen; 52111525c0dSBarry Smith PetscErrorCode ierr; 5226d95c8afSBarry Smith /* char sawsurl[256]; */ 52311525c0dSBarry Smith 52411525c0dSBarry Smith ierr = PetscOptionsHasName(NULL,"-saws_log",&flg);CHKERRQ(ierr); 52511525c0dSBarry Smith if (flg) { 52611525c0dSBarry Smith char sawslog[PETSC_MAX_PATH_LEN]; 52711525c0dSBarry Smith 52811525c0dSBarry Smith ierr = PetscOptionsGetString(NULL,"-saws_log",sawslog,PETSC_MAX_PATH_LEN,NULL);CHKERRQ(ierr); 52911525c0dSBarry Smith if (sawslog[0]) { 53011525c0dSBarry Smith PetscStackCallSAWs(SAWs_Set_Use_Logfile,(sawslog)); 53111525c0dSBarry Smith } else { 53211525c0dSBarry Smith PetscStackCallSAWs(SAWs_Set_Use_Logfile,(NULL)); 53311525c0dSBarry Smith } 53411525c0dSBarry Smith } 53511525c0dSBarry Smith ierr = PetscOptionsGetString(NULL,"-saws_https",cert,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr); 53611525c0dSBarry Smith if (flg) { 53711525c0dSBarry Smith PetscStackCallSAWs(SAWs_Set_Use_HTTPS,(cert)); 53811525c0dSBarry Smith } 53911525c0dSBarry Smith ierr = PetscOptionsGetInt(NULL,"-saws_port",&port,&flg);CHKERRQ(ierr); 54011525c0dSBarry Smith if (flg) { 54111525c0dSBarry Smith PetscStackCallSAWs(SAWs_Set_Port,(port)); 54211525c0dSBarry Smith } 54311525c0dSBarry Smith ierr = PetscOptionsGetString(NULL,"-saws_root",root,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr); 54411525c0dSBarry Smith if (flg) { 54511525c0dSBarry Smith PetscStackCallSAWs(SAWs_Set_Document_Root,(root));CHKERRQ(ierr); 54611525c0dSBarry Smith ierr = PetscStrcmp(root,".",&rootlocal);CHKERRQ(ierr); 5479c1e0ce8SBarry Smith } else { 5489c1e0ce8SBarry Smith ierr = PetscOptionsHasName(NULL,"-saws_options",&flg);CHKERRQ(ierr); 5499c1e0ce8SBarry Smith if (flg) { 5503c01dfcfSBarry Smith ierr = PetscStrreplace(PETSC_COMM_WORLD,"${PETSC_DIR}/share/petsc/saws",root,PETSC_MAX_PATH_LEN);CHKERRQ(ierr); 5519c1e0ce8SBarry Smith PetscStackCallSAWs(SAWs_Set_Document_Root,(root));CHKERRQ(ierr); 5529c1e0ce8SBarry Smith } 55311525c0dSBarry Smith } 55411525c0dSBarry Smith ierr = PetscOptionsHasName(NULL,"-saws_local",&flg2);CHKERRQ(ierr); 55511525c0dSBarry Smith if (flg2) { 55611525c0dSBarry Smith char jsdir[PETSC_MAX_PATH_LEN]; 55711525c0dSBarry Smith if (!flg) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SUP,"-saws_local option requires -saws_root option"); 55811525c0dSBarry Smith ierr = PetscSNPrintf(jsdir,PETSC_MAX_PATH_LEN,"%s/js",root);CHKERRQ(ierr); 55911525c0dSBarry Smith ierr = PetscTestDirectory(jsdir,'r',&flg);CHKERRQ(ierr); 56011525c0dSBarry Smith if (!flg) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_FILE_READ,"-saws_local option requires js directory in root directory"); 56143da4ab2SBarry Smith PetscStackCallSAWs(SAWs_Push_Local_Header,());CHKERRQ(ierr); 56211525c0dSBarry Smith } 56311525c0dSBarry Smith ierr = PetscGetProgramName(programname,64);CHKERRQ(ierr); 56411525c0dSBarry Smith ierr = PetscStrlen(help,&applinelen);CHKERRQ(ierr); 56511525c0dSBarry Smith introlen = 4096 + applinelen; 56630a8c9c0SSurtai Han applinelen += 1024; 56711525c0dSBarry Smith ierr = PetscMalloc(applinelen,&appline);CHKERRQ(ierr); 56811525c0dSBarry Smith ierr = PetscMalloc(introlen,&intro);CHKERRQ(ierr); 56911525c0dSBarry Smith 57011525c0dSBarry Smith if (rootlocal) { 57111525c0dSBarry Smith ierr = PetscSNPrintf(appline,applinelen,"%s.c.html",programname);CHKERRQ(ierr); 57211525c0dSBarry Smith ierr = PetscTestFile(appline,'r',&rootlocal);CHKERRQ(ierr); 57311525c0dSBarry Smith } 57430befbd2SBarry Smith ierr = PetscOptionsGetAll(&options);CHKERRQ(ierr); 57511525c0dSBarry Smith if (rootlocal && help) { 57630befbd2SBarry 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); 57711525c0dSBarry Smith } else if (help) { 57830a8c9c0SSurtai Han ierr = PetscSNPrintf(appline,applinelen,"<center>Running %s %s</center><br><center><pre>%s</pre></center><br>",programname,options,help); 57911525c0dSBarry Smith } else { 58030befbd2SBarry Smith ierr = PetscSNPrintf(appline,applinelen,"<center> Running %s %s</center><br>\n",programname,options); 58111525c0dSBarry Smith } 582b0bb5815SBarry Smith ierr = PetscFree(options);CHKERRQ(ierr); 58330befbd2SBarry Smith ierr = PetscGetVersion(version,sizeof(version));CHKERRQ(ierr); 58411525c0dSBarry Smith ierr = PetscSNPrintf(intro,introlen,"<body>\n" 58511525c0dSBarry 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" 586df62c222SBarry 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" 587df62c222SBarry Smith "%s",version,petscconfigureoptions,appline); 58843da4ab2SBarry Smith PetscStackCallSAWs(SAWs_Push_Body,("index.html",0,intro)); 58911525c0dSBarry Smith ierr = PetscFree(intro);CHKERRQ(ierr); 59011525c0dSBarry Smith ierr = PetscFree(appline);CHKERRQ(ierr); 59111525c0dSBarry Smith PetscStackCallSAWs(SAWs_Initialize,()); 5926d95c8afSBarry Smith /* PetscStackCallSAWs(SAWs_Get_FullURL,(sizeof(sawsurl),sawsurl)); 5936d95c8afSBarry Smith ierr = PetscPrintf(PETSC_COMM_WORLD,"Point your browser to %s for SAWs\n",sawsurl);CHKERRQ(ierr); */ 5940af79b04SBarry Smith ierr = PetscCitationsRegister("@TechReport{ saws,\n" 5950af79b04SBarry Smith " Author = {Matt Otten and Jed Brown and Barry Smith},\n" 5960af79b04SBarry Smith " Title = {Scientific Application Web Server (SAWs) Users Manual},\n" 5970af79b04SBarry Smith " Institution = {Argonne National Laboratory},\n" 5980af79b04SBarry Smith " Year = 2013\n}\n",NULL);CHKERRQ(ierr); 59911525c0dSBarry Smith } 60011525c0dSBarry Smith PetscFunctionReturn(0); 60111525c0dSBarry Smith } 60211525c0dSBarry Smith #endif 60311525c0dSBarry Smith 604793721a6SBarry Smith #undef __FUNCT__ 605e5c89e4eSSatish Balay #define __FUNCT__ "PetscInitialize" 606e5c89e4eSSatish Balay /*@C 607e5c89e4eSSatish Balay PetscInitialize - Initializes the PETSc database and MPI. 608e5c89e4eSSatish Balay PetscInitialize() calls MPI_Init() if that has yet to be called, 609e5c89e4eSSatish Balay so this routine should always be called near the beginning of 610e5c89e4eSSatish Balay your program -- usually the very first line! 611e5c89e4eSSatish Balay 612e5c89e4eSSatish Balay Collective on MPI_COMM_WORLD or PETSC_COMM_WORLD if it has been set 613e5c89e4eSSatish Balay 614e5c89e4eSSatish Balay Input Parameters: 615e5c89e4eSSatish Balay + argc - count of number of command line arguments 616e5c89e4eSSatish Balay . args - the command line arguments 6170298fd71SBarry Smith . file - [optional] PETSc database file, also checks ~username/.petscrc and .petscrc use NULL to not check for 618fc2bca9aSBarry Smith code specific file. Use -skip_petscrc in the code specific file to skip the .petscrc files 6190298fd71SBarry Smith - help - [optional] Help message to print, use NULL for no message 620e5c89e4eSSatish Balay 62105827820SBarry Smith If you wish PETSc code to run ONLY on a subcommunicator of MPI_COMM_WORLD, create that 62205827820SBarry Smith communicator first and assign it to PETSC_COMM_WORLD BEFORE calling PetscInitialize(). Thus if you are running a 62305827820SBarry Smith four process job and two processes will run PETSc and have PetscInitialize() and PetscFinalize() and two process will not, 62405827820SBarry Smith then do this. If ALL processes in the job are using PetscInitialize() and PetscFinalize() then you don't need to do this, even 62505827820SBarry Smith if different subcommunicators of the job are doing different things with PETSc. 626e5c89e4eSSatish Balay 627e5c89e4eSSatish Balay Options Database Keys: 628e5c89e4eSSatish Balay + -start_in_debugger [noxterm,dbx,xdb,gdb,...] - Starts program in debugger 629e5c89e4eSSatish Balay . -on_error_attach_debugger [noxterm,dbx,xdb,gdb,...] - Starts debugger when error detected 630e5c89e4eSSatish Balay . -on_error_emacs <machinename> causes emacsclient to jump to error file 631b52f573bSBarry Smith . -on_error_abort calls abort() when error detected (no traceback) 632e8fb0fc0SBarry Smith . -on_error_mpiabort calls MPI_abort() when error detected 633e8fb0fc0SBarry Smith . -error_output_stderr prints error messages to stderr instead of the default stdout 634e8fb0fc0SBarry Smith . -error_output_none does not print the error messages (but handles errors in the same way as if this was not called) 635e5c89e4eSSatish Balay . -debugger_nodes [node1,node2,...] - Indicates nodes to start in debugger 636e5c89e4eSSatish Balay . -debugger_pause [sleeptime] (in seconds) - Pauses debugger 637e5c89e4eSSatish Balay . -stop_for_debugger - Print message on how to attach debugger manually to 638e5c89e4eSSatish Balay process and wait (-debugger_pause) seconds for attachment 6392fb0ec9aSBarry Smith . -malloc - Indicates use of PETSc error-checking malloc (on by default for debug version of libraries) 640e5c89e4eSSatish Balay . -malloc no - Indicates not to use error-checking malloc 6412fb0ec9aSBarry Smith . -malloc_debug - check for memory corruption at EVERY malloc or free 642aee23540SBarry Smith . -malloc_dump - prints a list of all unfreed memory at the end of the run 643dc92acbaSJed Brown . -malloc_test - like -malloc_dump -malloc_debug, but only active for debugging builds 644e5c89e4eSSatish Balay . -fp_trap - Stops on floating point exceptions (Note that on the 645e5c89e4eSSatish Balay IBM RS6000 this slows code by at least a factor of 10.) 646e5c89e4eSSatish Balay . -no_signal_handler - Indicates not to trap error signals 647e5c89e4eSSatish Balay . -shared_tmp - indicates /tmp directory is shared by all processors 648e5c89e4eSSatish Balay . -not_shared_tmp - each processor has own /tmp 649e5c89e4eSSatish Balay . -tmp - alternative name of /tmp directory 650e5c89e4eSSatish Balay . -get_total_flops - returns total flops done by all processors 651142c234bSBarry Smith - -memory_info - Print memory usage at end of run 652e5c89e4eSSatish Balay 653e5c89e4eSSatish Balay Options Database Keys for Profiling: 654a7f22e61SSatish Balay See Users-Manual: ch_profiling for details. 655495fc317SBarry Smith + -info <optional filename> - Prints verbose information to the screen 656495fc317SBarry Smith . -info_exclude <null,vec,mat,pc,ksp,snes,ts> - Excludes some of the verbose messages 657495fc317SBarry Smith . -log_sync - Log the synchronization in scatters, inner products and norms 658495fc317SBarry Smith . -log_trace [filename] - Print traces of all PETSc calls to the screen (useful to determine where a program 659e5c89e4eSSatish Balay hangs without running in the debugger). See PetscLogTraceBegin(). 660495fc317SBarry Smith . -log_summary [filename] - Prints summary of flop and timing information to screen. If the filename is specified the 661495fc317SBarry Smith summary is written to the file. See PetscLogView(). 662495fc317SBarry Smith . -log_all [filename] - Logs extensive profiling information See PetscLogDump(). 663495fc317SBarry Smith . -log [filename] - Logs basic profiline information See PetscLogDump(). 664495fc317SBarry Smith - -log_mpe [filename] - Creates a logfile viewable by the utility Jumpshot (in MPICH distribution) 665495fc317SBarry Smith 666495fc317SBarry Smith Only one of -log_trace, -log_summary, -log_all, -log, or -log_mpe may be used at a time 667e5c89e4eSSatish Balay 668e5c89e4eSSatish Balay Environmental Variables: 669e5c89e4eSSatish Balay + PETSC_TMP - alternative tmp directory 670e5c89e4eSSatish Balay . PETSC_SHARED_TMP - tmp is shared by all processes 671e5c89e4eSSatish Balay . PETSC_NOT_SHARED_TMP - each process has its own private tmp 672e5c89e4eSSatish Balay . PETSC_VIEWER_SOCKET_PORT - socket number to use for socket viewer 673e5c89e4eSSatish Balay - PETSC_VIEWER_SOCKET_MACHINE - machine to use for socket viewer to connect to 674e5c89e4eSSatish Balay 675e5c89e4eSSatish Balay 676e5c89e4eSSatish Balay Level: beginner 677e5c89e4eSSatish Balay 678e5c89e4eSSatish Balay Notes: 679e5c89e4eSSatish Balay If for some reason you must call MPI_Init() separately, call 680e5c89e4eSSatish Balay it before PetscInitialize(). 681e5c89e4eSSatish Balay 682e5c89e4eSSatish Balay Fortran Version: 683e5c89e4eSSatish Balay In Fortran this routine has the format 684e5c89e4eSSatish Balay $ call PetscInitialize(file,ierr) 685e5c89e4eSSatish Balay 686e5c89e4eSSatish Balay + ierr - error return code 6870eb4c9c0SBarry Smith - file - [optional] PETSc database file, also checks ~username/.petscrc and .petscrc use PETSC_NULL_CHARACTER to not check for 688fc2bca9aSBarry Smith code specific file. Use -skip_petscrc in the code specific file to skip the .petscrc files 689e5c89e4eSSatish Balay 690e5c89e4eSSatish Balay Important Fortran Note: 6910eb4c9c0SBarry Smith In Fortran, you MUST use PETSC_NULL_CHARACTER to indicate a 6920298fd71SBarry Smith null character string; you CANNOT just use NULL as 693a7f22e61SSatish Balay in the C version. See Users-Manual: ch_fortran for details. 694e5c89e4eSSatish Balay 69501cb0274SBarry Smith If your main program is C but you call Fortran code that also uses PETSc you need to call PetscInitializeFortran() soon after 69601cb0274SBarry Smith calling PetscInitialize(). 697e5c89e4eSSatish Balay 698e5c89e4eSSatish Balay Concepts: initializing PETSc 699e5c89e4eSSatish Balay 70001cb0274SBarry Smith .seealso: PetscFinalize(), PetscInitializeFortran(), PetscGetArgs(), PetscInitializeNoArguments() 701e5c89e4eSSatish Balay 702e5c89e4eSSatish Balay @*/ 7037087cfbeSBarry Smith PetscErrorCode PetscInitialize(int *argc,char ***args,const char file[],const char help[]) 704e5c89e4eSSatish Balay { 705e5c89e4eSSatish Balay PetscErrorCode ierr; 7064bb5149bSJed Brown PetscMPIInt flag, size; 707ace3abfcSBarry Smith PetscBool flg; 708e5c89e4eSSatish Balay char hostname[256]; 709e5c89e4eSSatish Balay 710e5c89e4eSSatish Balay PetscFunctionBegin; 711e5c89e4eSSatish Balay if (PetscInitializeCalled) PetscFunctionReturn(0); 712e5c89e4eSSatish Balay 713ae9b4142SLisandro Dalcin /* these must be initialized in a routine, not as a constant declaration*/ 714d89683f4Sbcordonn PETSC_STDOUT = stdout; 715ae9b4142SLisandro Dalcin PETSC_STDERR = stderr; 716e5c89e4eSSatish Balay 7170c30907bSSatish Balay /* on Windows - set printf to default to printing 2 digit exponents */ 7180c30907bSSatish Balay #if defined(PETSC_HAVE__SET_OUTPUT_FORMAT) 7190c30907bSSatish Balay _set_output_format(_TWO_DIGIT_EXPONENT); 7200c30907bSSatish Balay #endif 7210c30907bSSatish Balay 722e5c89e4eSSatish Balay ierr = PetscOptionsCreate();CHKERRQ(ierr); 723e5c89e4eSSatish Balay 724e5c89e4eSSatish Balay /* 725e5c89e4eSSatish Balay We initialize the program name here (before MPI_Init()) because MPICH has a bug in 726e5c89e4eSSatish Balay it that it sets args[0] on all processors to be args[0] on the first processor. 727e5c89e4eSSatish Balay */ 728e5c89e4eSSatish Balay if (argc && *argc) { 729e5c89e4eSSatish Balay ierr = PetscSetProgramName(**args);CHKERRQ(ierr); 730e5c89e4eSSatish Balay } else { 731e5c89e4eSSatish Balay ierr = PetscSetProgramName("Unknown Name");CHKERRQ(ierr); 732e5c89e4eSSatish Balay } 733e5c89e4eSSatish Balay 734e5c89e4eSSatish Balay ierr = MPI_Initialized(&flag);CHKERRQ(ierr); 735e5c89e4eSSatish Balay if (!flag) { 736e32f2f54SBarry 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"); 7375e765c61SJed Brown #if defined(PETSC_HAVE_MPI_INIT_THREAD) 7385e765c61SJed Brown { 7395e765c61SJed Brown PetscMPIInt provided; 7405e765c61SJed Brown ierr = MPI_Init_thread(argc,args,MPI_THREAD_FUNNELED,&provided);CHKERRQ(ierr); 7415e765c61SJed Brown } 7425e765c61SJed Brown #else 743e5c89e4eSSatish Balay ierr = MPI_Init(argc,args);CHKERRQ(ierr); 7445e765c61SJed Brown #endif 745e5c89e4eSSatish Balay PetscBeganMPI = PETSC_TRUE; 746e5c89e4eSSatish Balay } 747e5c89e4eSSatish Balay if (argc && args) { 748e5c89e4eSSatish Balay PetscGlobalArgc = *argc; 749e5c89e4eSSatish Balay PetscGlobalArgs = *args; 750e5c89e4eSSatish Balay } 751e5c89e4eSSatish Balay PetscFinalizeCalled = PETSC_FALSE; 752e5c89e4eSSatish Balay 753a297a907SKarl Rupp if (PETSC_COMM_WORLD == MPI_COMM_NULL) PETSC_COMM_WORLD = MPI_COMM_WORLD; 754d54338ecSKarl Rupp ierr = MPI_Comm_set_errhandler(PETSC_COMM_WORLD,MPI_ERRORS_RETURN);CHKERRQ(ierr); 755e5c89e4eSSatish Balay 756e5c89e4eSSatish Balay /* Done after init due to a bug in MPICH-GM? */ 757e5c89e4eSSatish Balay ierr = PetscErrorPrintfInitialize();CHKERRQ(ierr); 758e5c89e4eSSatish Balay 759e5c89e4eSSatish Balay ierr = MPI_Comm_rank(MPI_COMM_WORLD,&PetscGlobalRank);CHKERRQ(ierr); 760e5c89e4eSSatish Balay ierr = MPI_Comm_size(MPI_COMM_WORLD,&PetscGlobalSize);CHKERRQ(ierr); 761e5c89e4eSSatish Balay 7628ad47952SJed Brown MPIU_BOOL = MPI_INT; 7638ad47952SJed Brown MPIU_ENUM = MPI_INT; 7648ad47952SJed Brown 765e5c89e4eSSatish Balay /* 766e5c89e4eSSatish Balay Initialized the global complex variable; this is because with 767e5c89e4eSSatish Balay shared libraries the constructors for global variables 768e5c89e4eSSatish Balay are not called; at least on IRIX. 769e5c89e4eSSatish Balay */ 770886cfec0SSatish Balay #if defined(PETSC_HAVE_COMPLEX) 771e5c89e4eSSatish Balay { 772a24ee22aSSatish Balay #if defined(PETSC_CLANGUAGE_CXX) 77350f81f78SJed Brown PetscComplex ic(0.0,1.0); 774e5c89e4eSSatish Balay PETSC_i = ic; 775a24ee22aSSatish Balay #elif defined(PETSC_CLANGUAGE_C) 77650f81f78SJed Brown PETSC_i = _Complex_I; 777b7940d39SSatish Balay #endif 778762437b8SSatish Balay } 779762437b8SSatish Balay 7802c876bd9SBarry Smith #if !defined(PETSC_HAVE_MPI_C_DOUBLE_COMPLEX) 781e69cd0e6SSatish Balay ierr = MPI_Type_contiguous(2,MPI_DOUBLE,&MPIU_C_DOUBLE_COMPLEX);CHKERRQ(ierr); 782500d8756SSatish Balay ierr = MPI_Type_commit(&MPIU_C_DOUBLE_COMPLEX);CHKERRQ(ierr); 783500d8756SSatish Balay ierr = MPI_Type_contiguous(2,MPI_FLOAT,&MPIU_C_COMPLEX);CHKERRQ(ierr); 784500d8756SSatish Balay ierr = MPI_Type_commit(&MPIU_C_COMPLEX);CHKERRQ(ierr); 7852c876bd9SBarry Smith #endif 786886cfec0SSatish Balay #endif /* PETSC_HAVE_COMPLEX */ 787e5c89e4eSSatish Balay 788e5c89e4eSSatish Balay /* 789e5c89e4eSSatish Balay Create the PETSc MPI reduction operator that sums of the first 790e5c89e4eSSatish Balay half of the entries and maxes the second half. 791e5c89e4eSSatish Balay */ 792e5c89e4eSSatish Balay ierr = MPI_Op_create(PetscMaxSum_Local,1,&PetscMaxSum_Op);CHKERRQ(ierr); 793e5c89e4eSSatish Balay 794ce63c4c1SBarry Smith #if defined(PETSC_USE_REAL___FLOAT128) 795c90a1750SBarry Smith ierr = MPI_Type_contiguous(2,MPI_DOUBLE,&MPIU___FLOAT128);CHKERRQ(ierr); 796c90a1750SBarry Smith ierr = MPI_Type_commit(&MPIU___FLOAT128);CHKERRQ(ierr); 7977c2de775SJed Brown #if defined(PETSC_HAVE_COMPLEX) 7988c764dc5SJose Roman ierr = MPI_Type_contiguous(4,MPI_DOUBLE,&MPIU___COMPLEX128);CHKERRQ(ierr); 7998c764dc5SJose Roman ierr = MPI_Type_commit(&MPIU___COMPLEX128);CHKERRQ(ierr); 8008c764dc5SJose Roman #endif 801d9822059SBarry Smith ierr = MPI_Op_create(PetscMax_Local,1,&MPIU_MAX);CHKERRQ(ierr); 802d9822059SBarry Smith ierr = MPI_Op_create(PetscMin_Local,1,&MPIU_MIN);CHKERRQ(ierr); 803c90a1750SBarry Smith #endif 804c90a1750SBarry Smith 8057c2de775SJed Brown #if (defined(PETSC_HAVE_COMPLEX) && !defined(PETSC_HAVE_MPI_C_DOUBLE_COMPLEX)) || defined(PETSC_USE_REAL___FLOAT128) 806cca4cb22SSatish Balay ierr = MPI_Op_create(PetscSum_Local,1,&MPIU_SUM);CHKERRQ(ierr); 807cca4cb22SSatish Balay #endif 808cca4cb22SSatish Balay 809e5c89e4eSSatish Balay ierr = MPI_Type_contiguous(2,MPIU_SCALAR,&MPIU_2SCALAR);CHKERRQ(ierr); 810e5c89e4eSSatish Balay ierr = MPI_Type_commit(&MPIU_2SCALAR);CHKERRQ(ierr); 811e5c89e4eSSatish Balay 81244041f26SJed Brown #if defined(PETSC_USE_64BIT_INDICES) || !defined(MPI_2INT) 813e5c89e4eSSatish Balay ierr = MPI_Type_contiguous(2,MPIU_INT,&MPIU_2INT);CHKERRQ(ierr); 814e5c89e4eSSatish Balay ierr = MPI_Type_commit(&MPIU_2INT);CHKERRQ(ierr); 81544041f26SJed Brown #endif 816e5c89e4eSSatish Balay 817ec957eceSBarry Smith 818e5c89e4eSSatish Balay /* 819480cf27aSJed Brown Attributes to be set on PETSc communicators 820480cf27aSJed Brown */ 821480cf27aSJed Brown ierr = MPI_Keyval_create(MPI_NULL_COPY_FN,Petsc_DelCounter,&Petsc_Counter_keyval,(void*)0);CHKERRQ(ierr); 822da3039f7SJed Brown ierr = MPI_Keyval_create(MPI_NULL_COPY_FN,Petsc_DelComm_Outer,&Petsc_InnerComm_keyval,(void*)0);CHKERRQ(ierr); 823da3039f7SJed Brown ierr = MPI_Keyval_create(MPI_NULL_COPY_FN,Petsc_DelComm_Inner,&Petsc_OuterComm_keyval,(void*)0);CHKERRQ(ierr); 824480cf27aSJed Brown 825480cf27aSJed Brown /* 826e8fb0fc0SBarry Smith Build the options database 827e5c89e4eSSatish Balay */ 828e5c89e4eSSatish Balay ierr = PetscOptionsInsert(argc,args,file);CHKERRQ(ierr); 829e5c89e4eSSatish Balay 8306dc8fec2Sbcordonn 831e5c89e4eSSatish Balay /* 832e5c89e4eSSatish Balay Print main application help message 833e5c89e4eSSatish Balay */ 8340298fd71SBarry Smith ierr = PetscOptionsHasName(NULL,"-help",&flg);CHKERRQ(ierr); 835e5c89e4eSSatish Balay if (help && flg) { 836e5c89e4eSSatish Balay ierr = PetscPrintf(PETSC_COMM_WORLD,help);CHKERRQ(ierr); 837e5c89e4eSSatish Balay } 838e5c89e4eSSatish Balay ierr = PetscOptionsCheckInitial_Private();CHKERRQ(ierr); 839e5c89e4eSSatish Balay 840d45a07a7SBarry Smith ierr = PetscCitationsInitialize();CHKERRQ(ierr); 841d45a07a7SBarry Smith 842e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS) 84311525c0dSBarry Smith ierr = PetscInitializeSAWs(help);CHKERRQ(ierr); 844f4202a44SBarry Smith #endif 845f4202a44SBarry Smith 846*896238b9SBarry Smith /* Creates the logging data structures; this is enabled even if logging is not turned on */ 847a9f03627SSatish Balay #if defined(PETSC_USE_LOG) 848*896238b9SBarry Smith ierr = PetscLogInitialize();CHKERRQ(ierr); 849a9f03627SSatish Balay #endif 850e5c89e4eSSatish Balay 851e5c89e4eSSatish Balay /* 852e5c89e4eSSatish Balay Load the dynamic libraries (on machines that support them), this registers all 853e5c89e4eSSatish Balay the solvers etc. (On non-dynamic machines this initializes the PetscDraw and PetscViewer classes) 854e5c89e4eSSatish Balay */ 855e5c89e4eSSatish Balay ierr = PetscInitialize_DynamicLibraries();CHKERRQ(ierr); 856e5c89e4eSSatish Balay 857e5c89e4eSSatish Balay ierr = MPI_Comm_size(PETSC_COMM_WORLD,&size);CHKERRQ(ierr); 858ae15b995SBarry Smith ierr = PetscInfo1(0,"PETSc successfully started: number of processors = %d\n",size);CHKERRQ(ierr); 859e5c89e4eSSatish Balay ierr = PetscGetHostName(hostname,256);CHKERRQ(ierr); 860ae15b995SBarry Smith ierr = PetscInfo1(0,"Running on machine: %s\n",hostname);CHKERRQ(ierr); 861e5c89e4eSSatish Balay 862e5c89e4eSSatish Balay ierr = PetscOptionsCheckInitial_Components();CHKERRQ(ierr); 863ef6c6fedSBoyana Norris /* Check the options database for options related to the options database itself */ 864ef6c6fedSBoyana Norris ierr = PetscOptionsSetFromOptions();CHKERRQ(ierr); 865ef6c6fedSBoyana Norris 866951e3c8eSBarry Smith #if defined(PETSC_USE_PETSC_MPI_EXTERNAL32) 867e39fd77fSBarry Smith /* 868e39fd77fSBarry Smith Tell MPI about our own data representation converter, this would/should be used if extern32 is not supported by the MPI 869e39fd77fSBarry Smith 870e39fd77fSBarry Smith Currently not used because it is not supported by MPICH. 871e39fd77fSBarry Smith */ 872e39fd77fSBarry Smith #if !defined(PETSC_WORDS_BIGENDIAN) 8730298fd71SBarry Smith ierr = MPI_Register_datarep((char*)"petsc",PetscDataRep_read_conv_fn,PetscDataRep_write_conv_fn,PetscDataRep_extent_fn,NULL);CHKERRQ(ierr); 874e39fd77fSBarry Smith #endif 875951e3c8eSBarry Smith #endif 876e39fd77fSBarry Smith 87735d88935SVictor Minden #if defined(PETSC_HAVE_CUDA) 87820e2c332SMatthew G. Knepley flg = PETSC_TRUE; 87920e2c332SMatthew G. Knepley ierr = PetscOptionsGetBool(NULL,"-cublas",&flg,NULL);CHKERRQ(ierr); 88020e2c332SMatthew G. Knepley if (flg) { 8814bb5149bSJed Brown PetscMPIInt p; 882663ba86aSMatthew G Knepley for (p = 0; p < PetscGlobalSize; ++p) { 883a297a907SKarl Rupp if (p == PetscGlobalRank) cublasInit(); 884663ba86aSMatthew G Knepley ierr = MPI_Barrier(PETSC_COMM_WORLD);CHKERRQ(ierr); 885663ba86aSMatthew G Knepley } 8864bb5149bSJed Brown } 8873e39abd9SVictor Minden #endif 88892e62aa6SBarry Smith 8890298fd71SBarry Smith ierr = PetscOptionsHasName(NULL,"-python",&flg);CHKERRQ(ierr); 8909ac80d5eSLisandro Dalcin if (flg) { 8919ac80d5eSLisandro Dalcin PetscInitializeCalled = PETSC_TRUE; 8920298fd71SBarry Smith ierr = PetscPythonInitialize(NULL,NULL);CHKERRQ(ierr); 8939ac80d5eSLisandro Dalcin } 8949ac80d5eSLisandro Dalcin 89541c0b4b3SShri Abhyankar /* 89641c0b4b3SShri Abhyankar Setup building of stack frames for all function calls 89741c0b4b3SShri Abhyankar */ 898e1167bb9SShri Abhyankar #if defined(PETSC_USE_DEBUG) 899e1167bb9SShri Abhyankar ierr = PetscStackCreate();CHKERRQ(ierr); 900e1167bb9SShri Abhyankar #endif 901e1167bb9SShri Abhyankar 9022d53ad75SBarry Smith #if defined(PETSC_SERIALIZE_FUNCTIONS) 9032d53ad75SBarry Smith ierr = PetscFPTCreate(10000);CHKERRQ(ierr); 9042d53ad75SBarry Smith #endif 9052d53ad75SBarry Smith 906dff31646SBarry Smith 907301d30feSBarry Smith /* 908301d30feSBarry Smith Once we are completedly initialized then we can set this variables 909301d30feSBarry Smith */ 910301d30feSBarry Smith PetscInitializeCalled = PETSC_TRUE; 911301d30feSBarry Smith PetscFunctionReturn(0); 912e5c89e4eSSatish Balay } 913e5c89e4eSSatish Balay 9144097062eSBarry Smith #if defined(PETSC_USE_LOG) 9152eff7a51SBarry Smith extern PetscObject *PetscObjects; 9162eff7a51SBarry Smith extern PetscInt PetscObjectsCounts, PetscObjectsMaxCounts; 91705df10baSBarry Smith extern PetscBool PetscObjectsLog; 9184097062eSBarry Smith #endif 919e5c89e4eSSatish Balay 920e5c89e4eSSatish Balay #undef __FUNCT__ 921e5c89e4eSSatish Balay #define __FUNCT__ "PetscFinalize" 922e5c89e4eSSatish Balay /*@C 923e5c89e4eSSatish Balay PetscFinalize - Checks for options to be called at the conclusion 924e5c89e4eSSatish Balay of the program. MPI_Finalize() is called only if the user had not 925e5c89e4eSSatish Balay called MPI_Init() before calling PetscInitialize(). 926e5c89e4eSSatish Balay 927e5c89e4eSSatish Balay Collective on PETSC_COMM_WORLD 928e5c89e4eSSatish Balay 929e5c89e4eSSatish Balay Options Database Keys: 93088c29154SBarry Smith + -options_table - Calls PetscOptionsView() 931e5c89e4eSSatish Balay . -options_left - Prints unused options that remain in the database 9327eb1d149SBarry 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 933e5c89e4eSSatish Balay . -mpidump - Calls PetscMPIDump() 934e5c89e4eSSatish Balay . -malloc_dump - Calls PetscMallocDump() 935e5c89e4eSSatish Balay . -malloc_info - Prints total memory usage 936e5c89e4eSSatish Balay - -malloc_log - Prints summary of memory usage 937e5c89e4eSSatish Balay 938e5c89e4eSSatish Balay Level: beginner 939e5c89e4eSSatish Balay 940e5c89e4eSSatish Balay Note: 941e5c89e4eSSatish Balay See PetscInitialize() for more general runtime options. 942e5c89e4eSSatish Balay 94388c29154SBarry Smith .seealso: PetscInitialize(), PetscOptionsView(), PetscMallocDump(), PetscMPIDump(), PetscEnd() 944e5c89e4eSSatish Balay @*/ 9457087cfbeSBarry Smith PetscErrorCode PetscFinalize(void) 946e5c89e4eSSatish Balay { 947e5c89e4eSSatish Balay PetscErrorCode ierr; 9484bb5149bSJed Brown PetscMPIInt rank; 949a8d2bbe5SBarry Smith PetscInt nopt; 9502bf49c77SBarry Smith PetscBool flg1 = PETSC_FALSE,flg2 = PETSC_FALSE,flg3 = PETSC_FALSE; 951dff31646SBarry Smith PetscBool flg; 95210463e74SBarry Smith #if defined(PETSC_USE_LOG) 95310463e74SBarry Smith char mname[PETSC_MAX_PATH_LEN]; 95410463e74SBarry Smith #endif 955e5c89e4eSSatish Balay 956e5c89e4eSSatish Balay PetscFunctionBegin; 957e5c89e4eSSatish Balay if (!PetscInitializeCalled) { 9584b09e917SBarry Smith printf("PetscInitialize() must be called before PetscFinalize()\n"); 9594b09e917SBarry Smith PetscFunctionReturn(PETSC_ERR_ARG_WRONGSTATE); 960e5c89e4eSSatish Balay } 9610298fd71SBarry Smith ierr = PetscInfo(NULL,"PetscFinalize() called\n");CHKERRQ(ierr); 962b022a5c1SBarry Smith 9631f817a21SBarry Smith ierr = MPI_Comm_rank(PETSC_COMM_WORLD,&rank);CHKERRQ(ierr); 9641f817a21SBarry Smith 9651f817a21SBarry Smith ierr = PetscOptionsHasName(NULL,"-citations",&flg);CHKERRQ(ierr); 966dff31646SBarry Smith if (flg) { 9671f817a21SBarry Smith char *cits, filename[PETSC_MAX_PATH_LEN]; 9681f817a21SBarry Smith FILE *fd = PETSC_STDOUT; 9691f817a21SBarry Smith 9701f817a21SBarry Smith ierr = PetscOptionsGetString(NULL,"-citations",filename,PETSC_MAX_PATH_LEN,NULL);CHKERRQ(ierr); 9711f817a21SBarry Smith if (filename[0]) { 9721f817a21SBarry Smith ierr = PetscFOpen(PETSC_COMM_WORLD,filename,"w",&fd);CHKERRQ(ierr); 9731f817a21SBarry Smith } 974dff31646SBarry Smith ierr = PetscSegBufferGet(PetscCitationsList,1,&cits);CHKERRQ(ierr); 975dff31646SBarry Smith cits[0] = 0; 976dff31646SBarry Smith ierr = PetscSegBufferExtractAlloc(PetscCitationsList,&cits);CHKERRQ(ierr); 9771f817a21SBarry Smith ierr = PetscFPrintf(PETSC_COMM_WORLD,fd,"If you publish results based on this computation please cite the following:\n");CHKERRQ(ierr); 9781f817a21SBarry Smith ierr = PetscFPrintf(PETSC_COMM_WORLD,fd,"===========================================================================\n");CHKERRQ(ierr); 9791f817a21SBarry Smith ierr = PetscFPrintf(PETSC_COMM_WORLD,fd,"%s",cits);CHKERRQ(ierr); 9801f817a21SBarry Smith ierr = PetscFPrintf(PETSC_COMM_WORLD,fd,"===========================================================================\n");CHKERRQ(ierr); 9811f817a21SBarry Smith ierr = PetscFClose(PETSC_COMM_WORLD,fd);CHKERRQ(ierr); 982dff31646SBarry Smith ierr = PetscFree(cits);CHKERRQ(ierr); 983dff31646SBarry Smith } 984dff31646SBarry Smith ierr = PetscSegBufferDestroy(&PetscCitationsList);CHKERRQ(ierr); 985dff31646SBarry Smith 986c2a97968SBarry Smith #if defined(PETSC_HAVE_SSL) && defined(PETSC_USE_SOCKET_VIEWER) 98704102261SBarry Smith /* TextBelt is run for testing purposes only, please do not use this feature often */ 98804102261SBarry Smith { 98904102261SBarry Smith PetscInt nmax = 2; 99004102261SBarry Smith char **buffs; 99104102261SBarry Smith ierr = PetscMalloc1(2,&buffs);CHKERRQ(ierr); 99204102261SBarry Smith ierr = PetscOptionsGetStringArray(NULL,"-textbelt",buffs,&nmax,&flg1);CHKERRQ(ierr); 99304102261SBarry Smith if (flg1) { 99404102261SBarry Smith if (!nmax) SETERRQ(PETSC_COMM_WORLD,PETSC_ERR_USER,"-textbelt requires either the phone number or number,\"message\""); 99504102261SBarry Smith if (nmax == 1) { 99604102261SBarry Smith ierr = PetscMalloc1(128,&buffs[1]);CHKERRQ(ierr); 99704102261SBarry Smith ierr = PetscGetProgramName(buffs[1],32);CHKERRQ(ierr); 99804102261SBarry Smith ierr = PetscStrcat(buffs[1]," has completed");CHKERRQ(ierr); 99904102261SBarry Smith } 100004102261SBarry Smith ierr = PetscTextBelt(PETSC_COMM_WORLD,buffs[0],buffs[1],NULL);CHKERRQ(ierr); 100104102261SBarry Smith ierr = PetscFree(buffs[0]);CHKERRQ(ierr); 100204102261SBarry Smith ierr = PetscFree(buffs[1]);CHKERRQ(ierr); 100304102261SBarry Smith } 100404102261SBarry Smith ierr = PetscFree(buffs);CHKERRQ(ierr); 100504102261SBarry Smith } 100604102261SBarry Smith #endif 100767234432SDmitry Karpeev /* 100867234432SDmitry Karpeev It should be safe to cancel the options monitors, since we don't expect to be setting options 100967234432SDmitry Karpeev here (at least that are worth monitoring). Monitors ought to be released so that they release 101067234432SDmitry Karpeev whatever memory was allocated there before -malloc_dump reports unfreed memory. 101167234432SDmitry Karpeev */ 101267234432SDmitry Karpeev ierr = PetscOptionsMonitorCancel();CHKERRQ(ierr); 101304102261SBarry Smith 10142d53ad75SBarry Smith #if defined(PETSC_SERIALIZE_FUNCTIONS) 10152d53ad75SBarry Smith ierr = PetscFPTDestroy();CHKERRQ(ierr); 10162d53ad75SBarry Smith #endif 10172d53ad75SBarry Smith 10182d53ad75SBarry Smith 1019e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS) 1020dff31646SBarry Smith flg = PETSC_FALSE; 1021e78c4b8cSBarry Smith ierr = PetscOptionsGetBool(NULL,"-saw_options",&flg,NULL);CHKERRQ(ierr); 1022d5649816SBarry Smith if (flg) { 1023e04113cfSBarry Smith ierr = PetscOptionsSAWsDestroy();CHKERRQ(ierr); 1024d5649816SBarry Smith } 1025d5649816SBarry Smith #endif 1026d5649816SBarry Smith 1027681455b2SBarry Smith #if defined(PETSC_HAVE_X) 1028681455b2SBarry Smith flg1 = PETSC_FALSE; 1029681455b2SBarry Smith ierr = PetscOptionsGetBool(NULL,"-x_virtual",&flg1,NULL);CHKERRQ(ierr); 1030681455b2SBarry Smith if (flg1) { 1031681455b2SBarry Smith /* this is a crude hack, but better than nothing */ 1032681455b2SBarry Smith ierr = PetscPOpen(PETSC_COMM_WORLD,NULL,"pkill -9 Xvfb","r",NULL);CHKERRQ(ierr); 1033681455b2SBarry Smith } 1034681455b2SBarry Smith #endif 1035681455b2SBarry Smith 103667584ceeSBarry Smith #if !defined(PETSC_HAVE_THREADSAFETY) 10370298fd71SBarry Smith ierr = PetscOptionsGetBool(NULL,"-malloc_info",&flg2,NULL);CHKERRQ(ierr); 1038e5c89e4eSSatish Balay if (!flg2) { 103990d69ab7SBarry Smith flg2 = PETSC_FALSE; 10400298fd71SBarry Smith ierr = PetscOptionsGetBool(NULL,"-memory_info",&flg2,NULL);CHKERRQ(ierr); 1041e5c89e4eSSatish Balay } 1042e5c89e4eSSatish Balay if (flg2) { 1043e5c89e4eSSatish Balay ierr = PetscMemoryShowUsage(PETSC_VIEWER_STDOUT_WORLD,"Summary of Memory Usage in PETSc\n");CHKERRQ(ierr); 1044e5c89e4eSSatish Balay } 104567584ceeSBarry Smith #endif 1046e5c89e4eSSatish Balay 1047e5c89e4eSSatish Balay #if defined(PETSC_USE_LOG) 104890d69ab7SBarry Smith flg1 = PETSC_FALSE; 10490298fd71SBarry Smith ierr = PetscOptionsGetBool(NULL,"-get_total_flops",&flg1,NULL);CHKERRQ(ierr); 1050e5c89e4eSSatish Balay if (flg1) { 1051e5c89e4eSSatish Balay PetscLogDouble flops = 0; 1052205a32c2SJed Brown ierr = MPI_Reduce(&petsc_TotalFlops,&flops,1,MPI_DOUBLE,MPI_SUM,0,PETSC_COMM_WORLD);CHKERRQ(ierr); 1053e5c89e4eSSatish Balay ierr = PetscPrintf(PETSC_COMM_WORLD,"Total flops over all processors %g\n",flops);CHKERRQ(ierr); 1054e5c89e4eSSatish Balay } 1055e5c89e4eSSatish Balay #endif 1056e5c89e4eSSatish Balay 1057e5c89e4eSSatish Balay 1058e5c89e4eSSatish Balay #if defined(PETSC_USE_LOG) 1059e5c89e4eSSatish Balay #if defined(PETSC_HAVE_MPE) 1060e5c89e4eSSatish Balay mname[0] = 0; 1061a297a907SKarl Rupp 10620298fd71SBarry Smith ierr = PetscOptionsGetString(NULL,"-log_mpe",mname,PETSC_MAX_PATH_LEN,&flg1);CHKERRQ(ierr); 1063e5c89e4eSSatish Balay if (flg1) { 1064e5c89e4eSSatish Balay if (mname[0]) {ierr = PetscLogMPEDump(mname);CHKERRQ(ierr);} 1065e5c89e4eSSatish Balay else {ierr = PetscLogMPEDump(0);CHKERRQ(ierr);} 1066e5c89e4eSSatish Balay } 1067e5c89e4eSSatish Balay #endif 1068e5c89e4eSSatish Balay mname[0] = 0; 1069a297a907SKarl Rupp 1070f14045dbSBarry Smith ierr = PetscLogViewFromOptions();CHKERRQ(ierr); 10710298fd71SBarry Smith ierr = PetscOptionsGetString(NULL,"-log_summary",mname,PETSC_MAX_PATH_LEN,&flg1);CHKERRQ(ierr); 1072e5c89e4eSSatish Balay if (flg1) { 107391eabc43SBarry Smith PetscViewer viewer; 107491eabc43SBarry Smith if (mname[0]) { 107591eabc43SBarry Smith ierr = PetscViewerASCIIOpen(PETSC_COMM_WORLD,mname,&viewer);CHKERRQ(ierr); 107691eabc43SBarry Smith ierr = PetscLogView(viewer);CHKERRQ(ierr); 10776bf464f9SBarry Smith ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr); 107833f85c2fSBarry Smith } else { 107933f85c2fSBarry Smith viewer = PETSC_VIEWER_STDOUT_WORLD; 108033f85c2fSBarry Smith ierr = PetscLogView(viewer);CHKERRQ(ierr); 108133f85c2fSBarry Smith } 1082e5c89e4eSSatish Balay } 1083e5c89e4eSSatish Balay mname[0] = 0; 1084a297a907SKarl Rupp 10850298fd71SBarry Smith ierr = PetscOptionsGetString(NULL,"-log_all",mname,PETSC_MAX_PATH_LEN,&flg1);CHKERRQ(ierr); 10860298fd71SBarry Smith ierr = PetscOptionsGetString(NULL,"-log",mname,PETSC_MAX_PATH_LEN,&flg2);CHKERRQ(ierr); 1087e5c89e4eSSatish Balay if (flg1 || flg2) { 1088e5c89e4eSSatish Balay if (mname[0]) PetscLogDump(mname); 1089e5c89e4eSSatish Balay else PetscLogDump(0); 1090e5c89e4eSSatish Balay } 1091e5c89e4eSSatish Balay #endif 109210463e74SBarry Smith 1093b58ca069SBarry Smith /* 1094b58ca069SBarry Smith Free all objects registered with PetscObjectRegisterDestroy() such as PETSC_VIEWER_XXX_(). 1095b58ca069SBarry Smith */ 1096b58ca069SBarry Smith ierr = PetscObjectRegisterDestroyAll();CHKERRQ(ierr); 1097b58ca069SBarry Smith 109833f85c2fSBarry Smith ierr = PetscStackDestroy();CHKERRQ(ierr); 109910463e74SBarry Smith 110090d69ab7SBarry Smith flg1 = PETSC_FALSE; 11010298fd71SBarry Smith ierr = PetscOptionsGetBool(NULL,"-no_signal_handler",&flg1,NULL);CHKERRQ(ierr); 1102e5c89e4eSSatish Balay if (!flg1) { ierr = PetscPopSignalHandler();CHKERRQ(ierr);} 110390d69ab7SBarry Smith flg1 = PETSC_FALSE; 11040298fd71SBarry Smith ierr = PetscOptionsGetBool(NULL,"-mpidump",&flg1,NULL);CHKERRQ(ierr); 1105e5c89e4eSSatish Balay if (flg1) { 1106e5c89e4eSSatish Balay ierr = PetscMPIDump(stdout);CHKERRQ(ierr); 1107e5c89e4eSSatish Balay } 110890d69ab7SBarry Smith flg1 = PETSC_FALSE; 110990d69ab7SBarry Smith flg2 = PETSC_FALSE; 11108bb29257SSatish Balay /* preemptive call to avoid listing this option in options table as unused */ 11110298fd71SBarry Smith ierr = PetscOptionsHasName(NULL,"-malloc_dump",&flg1);CHKERRQ(ierr); 11120298fd71SBarry Smith ierr = PetscOptionsHasName(NULL,"-objects_dump",&flg1);CHKERRQ(ierr); 1113662a7babSBarry Smith ierr = PetscOptionsGetBool(NULL,"-options_view",&flg2,NULL);CHKERRQ(ierr); 1114e4c476e2SSatish Balay 1115e5c89e4eSSatish Balay if (flg2) { 1116be56827dSJed Brown PetscViewer viewer; 111702ba9f54SBarry Smith ierr = PetscViewerCreate(PETSC_COMM_WORLD,&viewer);CHKERRQ(ierr); 111802ba9f54SBarry Smith ierr = PetscViewerSetType(viewer,PETSCVIEWERASCII);CHKERRQ(ierr); 1119be56827dSJed Brown ierr = PetscOptionsView(viewer);CHKERRQ(ierr); 1120be56827dSJed Brown ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr); 1121e5c89e4eSSatish Balay } 1122e5c89e4eSSatish Balay 1123e5c89e4eSSatish Balay /* to prevent PETSc -options_left from warning */ 11240298fd71SBarry Smith ierr = PetscOptionsHasName(NULL,"-nox",&flg1);CHKERRQ(ierr); 11250298fd71SBarry Smith ierr = PetscOptionsHasName(NULL,"-nox_warning",&flg1);CHKERRQ(ierr); 1126e5c89e4eSSatish Balay 112733fc4174SSatish Balay flg3 = PETSC_FALSE; /* default value is required */ 11280298fd71SBarry Smith ierr = PetscOptionsGetBool(NULL,"-options_left",&flg3,&flg1);CHKERRQ(ierr); 1129e5c89e4eSSatish Balay ierr = PetscOptionsAllUsed(&nopt);CHKERRQ(ierr); 1130e5c89e4eSSatish Balay if (flg3) { 1131e5c89e4eSSatish Balay if (!flg2) { /* have not yet printed the options */ 1132be56827dSJed Brown PetscViewer viewer; 113302ba9f54SBarry Smith ierr = PetscViewerCreate(PETSC_COMM_WORLD,&viewer);CHKERRQ(ierr); 113402ba9f54SBarry Smith ierr = PetscViewerSetType(viewer,PETSCVIEWERASCII);CHKERRQ(ierr); 1135be56827dSJed Brown ierr = PetscOptionsView(viewer);CHKERRQ(ierr); 1136be56827dSJed Brown ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr); 1137e5c89e4eSSatish Balay } 1138e5c89e4eSSatish Balay if (!nopt) { 1139e5c89e4eSSatish Balay ierr = PetscPrintf(PETSC_COMM_WORLD,"There are no unused options.\n");CHKERRQ(ierr); 1140e5c89e4eSSatish Balay } else if (nopt == 1) { 1141e5c89e4eSSatish Balay ierr = PetscPrintf(PETSC_COMM_WORLD,"There is one unused database option. It is:\n");CHKERRQ(ierr); 1142e5c89e4eSSatish Balay } else { 11437582186dSLisandro Dalcin ierr = PetscPrintf(PETSC_COMM_WORLD,"There are %D unused database options. They are:\n",nopt);CHKERRQ(ierr); 1144e5c89e4eSSatish Balay } 1145df12ba86SBarry Smith } 1146e5c89e4eSSatish Balay #if defined(PETSC_USE_DEBUG) 1147da8b8a77SBarry Smith if (nopt && !flg3 && !flg1) { 1148e5c89e4eSSatish Balay ierr = PetscPrintf(PETSC_COMM_WORLD,"WARNING! There are options you set that were not used!\n");CHKERRQ(ierr); 1149e5c89e4eSSatish Balay ierr = PetscPrintf(PETSC_COMM_WORLD,"WARNING! could be spelling mistake, etc!\n");CHKERRQ(ierr); 1150e5c89e4eSSatish Balay ierr = PetscOptionsLeft();CHKERRQ(ierr); 1151e5c89e4eSSatish Balay } else if (nopt && flg3) { 1152e5c89e4eSSatish Balay #else 1153e5c89e4eSSatish Balay if (nopt && flg3) { 1154e5c89e4eSSatish Balay #endif 1155e5c89e4eSSatish Balay ierr = PetscOptionsLeft();CHKERRQ(ierr); 1156e5c89e4eSSatish Balay } 1157e5c89e4eSSatish Balay 1158e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS) 1159d45a07a7SBarry Smith if (!PetscGlobalRank) { 116087f587eeSBarry Smith ierr = PetscStackSAWsViewOff();CHKERRQ(ierr); 116116ad0300SBarry Smith PetscStackCallSAWs(SAWs_Finalize,()); 1162d45a07a7SBarry Smith } 1163ec957eceSBarry Smith #endif 1164ec957eceSBarry Smith 11654097062eSBarry Smith #if defined(PETSC_USE_LOG) 116610463e74SBarry Smith /* 1167dbc8283eSBarry Smith List all objects the user may have forgot to free 11682eff7a51SBarry Smith */ 116905df10baSBarry Smith if (PetscObjectsLog) { 11700298fd71SBarry Smith ierr = PetscOptionsHasName(NULL,"-objects_dump",&flg1);CHKERRQ(ierr); 1171a64a8e02SBarry Smith if (flg1) { 1172a64a8e02SBarry Smith MPI_Comm local_comm; 11737eb1d149SBarry Smith char string[64]; 1174a64a8e02SBarry Smith 11750298fd71SBarry Smith ierr = PetscOptionsGetString(NULL,"-objects_dump",string,64,NULL);CHKERRQ(ierr); 1176a64a8e02SBarry Smith ierr = MPI_Comm_dup(MPI_COMM_WORLD,&local_comm);CHKERRQ(ierr); 1177a64a8e02SBarry Smith ierr = PetscSequentialPhaseBegin_Private(local_comm,1);CHKERRQ(ierr); 11787eb1d149SBarry Smith ierr = PetscObjectsDump(stdout,(string[0] == 'a') ? PETSC_TRUE : PETSC_FALSE);CHKERRQ(ierr); 1179a64a8e02SBarry Smith ierr = PetscSequentialPhaseEnd_Private(local_comm,1);CHKERRQ(ierr); 1180a64a8e02SBarry Smith ierr = MPI_Comm_free(&local_comm);CHKERRQ(ierr); 11810a1571b3SBarry Smith } 118205df10baSBarry Smith } 11834097062eSBarry Smith #endif 11844097062eSBarry Smith 11854097062eSBarry Smith #if defined(PETSC_USE_LOG) 1186dbc8283eSBarry Smith PetscObjectsCounts = 0; 1187dbc8283eSBarry Smith PetscObjectsMaxCounts = 0; 1188a297a907SKarl Rupp ierr = PetscFree(PetscObjects);CHKERRQ(ierr); 11894097062eSBarry Smith #endif 11902eff7a51SBarry Smith 119133f85c2fSBarry Smith #if defined(PETSC_USE_LOG) 119233f85c2fSBarry Smith ierr = PetscLogDestroy();CHKERRQ(ierr); 119333f85c2fSBarry Smith #endif 119433f85c2fSBarry Smith 119533f85c2fSBarry Smith /* 119622b6d1caSBarry Smith Close any open dynamic libraries 119722b6d1caSBarry Smith */ 119822b6d1caSBarry Smith ierr = PetscFinalize_DynamicLibraries();CHKERRQ(ierr); 119922b6d1caSBarry Smith 120022b6d1caSBarry Smith /* 120133f85c2fSBarry Smith Destroy any packages that registered a finalize 120233f85c2fSBarry Smith */ 120333f85c2fSBarry Smith ierr = PetscRegisterFinalizeAll();CHKERRQ(ierr); 120433f85c2fSBarry Smith 120533f85c2fSBarry Smith /* 120648dd1dffSBarry Smith Print PetscFunctionLists that have not been properly freed 120748dd1dffSBarry Smith 120837e93019SBarry Smith ierr = PetscFunctionListPrintAll();CHKERRQ(ierr); 120948dd1dffSBarry Smith */ 121037e93019SBarry Smith 12114028d114SSatish Balay if (petsc_history) { 1212f3dea69dSBarry Smith ierr = PetscCloseHistoryFile(&petsc_history);CHKERRQ(ierr); 1213e5c89e4eSSatish Balay petsc_history = 0; 1214e5c89e4eSSatish Balay } 1215e5c89e4eSSatish Balay 12160298fd71SBarry Smith ierr = PetscInfoAllow(PETSC_FALSE,NULL);CHKERRQ(ierr); 1217e5c89e4eSSatish Balay 121867584ceeSBarry Smith #if !defined(PETSC_HAVE_THREADSAFETY) 12198bb29257SSatish Balay { 1220e5c89e4eSSatish Balay char fname[PETSC_MAX_PATH_LEN]; 1221e5c89e4eSSatish Balay FILE *fd; 1222ed9cf6e9SBarry Smith int err; 1223e5c89e4eSSatish Balay 1224e5c89e4eSSatish Balay fname[0] = 0; 1225a297a907SKarl Rupp 12260298fd71SBarry Smith ierr = PetscOptionsGetString(NULL,"-malloc_dump",fname,250,&flg1);CHKERRQ(ierr); 1227dc92acbaSJed Brown flg2 = PETSC_FALSE; 12280298fd71SBarry Smith ierr = PetscOptionsGetBool(NULL,"-malloc_test",&flg2,NULL);CHKERRQ(ierr); 12298bf1f09cSShri Abhyankar #if defined(PETSC_USE_DEBUG) 1230dc92acbaSJed Brown if (PETSC_RUNNING_ON_VALGRIND) flg2 = PETSC_FALSE; 1231dc92acbaSJed Brown #else 1232dc92acbaSJed Brown flg2 = PETSC_FALSE; /* Skip reporting for optimized builds regardless of -malloc_test */ 1233dc92acbaSJed Brown #endif 1234e5c89e4eSSatish Balay if (flg1 && fname[0]) { 1235e5c89e4eSSatish Balay char sname[PETSC_MAX_PATH_LEN]; 1236e5c89e4eSSatish Balay 1237e5c89e4eSSatish Balay sprintf(sname,"%s_%d",fname,rank); 1238e32f2f54SBarry Smith fd = fopen(sname,"w"); if (!fd) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_FILE_OPEN,"Cannot open log file: %s",sname); 1239e5c89e4eSSatish Balay ierr = PetscMallocDump(fd);CHKERRQ(ierr); 1240ed9cf6e9SBarry Smith err = fclose(fd); 1241e32f2f54SBarry Smith if (err) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SYS,"fclose() failed on file"); 1242dc92acbaSJed Brown } else if (flg1 || flg2) { 1243e5c89e4eSSatish Balay MPI_Comm local_comm; 1244e5c89e4eSSatish Balay 1245e5c89e4eSSatish Balay ierr = MPI_Comm_dup(MPI_COMM_WORLD,&local_comm);CHKERRQ(ierr); 1246e5c89e4eSSatish Balay ierr = PetscSequentialPhaseBegin_Private(local_comm,1);CHKERRQ(ierr); 1247e5c89e4eSSatish Balay ierr = PetscMallocDump(stdout);CHKERRQ(ierr); 1248e5c89e4eSSatish Balay ierr = PetscSequentialPhaseEnd_Private(local_comm,1);CHKERRQ(ierr); 1249e5c89e4eSSatish Balay ierr = MPI_Comm_free(&local_comm);CHKERRQ(ierr); 1250e5c89e4eSSatish Balay } 1251e5c89e4eSSatish Balay } 1252a64a8e02SBarry Smith 12538bb29257SSatish Balay { 1254e5c89e4eSSatish Balay char fname[PETSC_MAX_PATH_LEN]; 12550298fd71SBarry Smith FILE *fd = NULL; 1256e5c89e4eSSatish Balay 1257e5c89e4eSSatish Balay fname[0] = 0; 1258a297a907SKarl Rupp 12590298fd71SBarry Smith ierr = PetscOptionsGetString(NULL,"-malloc_log",fname,250,&flg1);CHKERRQ(ierr); 12600298fd71SBarry Smith ierr = PetscOptionsHasName(NULL,"-malloc_log_threshold",&flg2);CHKERRQ(ierr); 1261e5c89e4eSSatish Balay if (flg1 && fname[0]) { 1262ed9cf6e9SBarry Smith int err; 1263e5c89e4eSSatish Balay 1264574034a9SJed Brown if (!rank) { 1265574034a9SJed Brown fd = fopen(fname,"w"); 1266574034a9SJed Brown if (!fd) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_FILE_OPEN,"Cannot open log file: %s",fname); 1267574034a9SJed Brown } 1268e5c89e4eSSatish Balay ierr = PetscMallocDumpLog(fd);CHKERRQ(ierr); 1269574034a9SJed Brown if (fd) { 1270ed9cf6e9SBarry Smith err = fclose(fd); 1271e32f2f54SBarry Smith if (err) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SYS,"fclose() failed on file"); 1272574034a9SJed Brown } 1273574034a9SJed Brown } else if (flg1 || flg2) { 1274e5c89e4eSSatish Balay ierr = PetscMallocDumpLog(stdout);CHKERRQ(ierr); 1275e5c89e4eSSatish Balay } 1276e5c89e4eSSatish Balay } 127767584ceeSBarry Smith #endif 127820e2c332SMatthew G. Knepley 127920e2c332SMatthew G. Knepley #if defined(PETSC_HAVE_CUDA) 128020e2c332SMatthew G. Knepley flg = PETSC_TRUE; 128120e2c332SMatthew G. Knepley ierr = PetscOptionsGetBool(NULL,"-cublas",&flg,NULL);CHKERRQ(ierr); 128220e2c332SMatthew G. Knepley if (flg) { 128320e2c332SMatthew G. Knepley PetscInt p; 128420e2c332SMatthew G. Knepley for (p = 0; p < PetscGlobalSize; ++p) { 128520e2c332SMatthew G. Knepley if (p == PetscGlobalRank) cublasShutdown(); 128620e2c332SMatthew G. Knepley ierr = MPI_Barrier(PETSC_COMM_WORLD);CHKERRQ(ierr); 128720e2c332SMatthew G. Knepley } 128820e2c332SMatthew G. Knepley } 128920e2c332SMatthew G. Knepley #endif 129020e2c332SMatthew G. Knepley 1291e5c89e4eSSatish Balay /* Can be destroyed only after all the options are used */ 1292e5c89e4eSSatish Balay ierr = PetscOptionsDestroy();CHKERRQ(ierr); 1293e5c89e4eSSatish Balay 1294e5c89e4eSSatish Balay PetscGlobalArgc = 0; 1295e5c89e4eSSatish Balay PetscGlobalArgs = 0; 1296e5c89e4eSSatish Balay 1297ce63c4c1SBarry Smith #if defined(PETSC_USE_REAL___FLOAT128) 1298c90a1750SBarry Smith ierr = MPI_Type_free(&MPIU___FLOAT128);CHKERRQ(ierr); 12997c2de775SJed Brown #if defined(PETSC_HAVE_COMPLEX) 13008c764dc5SJose Roman ierr = MPI_Type_free(&MPIU___COMPLEX128);CHKERRQ(ierr); 13018c764dc5SJose Roman #endif 1302d9822059SBarry Smith ierr = MPI_Op_free(&MPIU_MAX);CHKERRQ(ierr); 1303d9822059SBarry Smith ierr = MPI_Op_free(&MPIU_MIN);CHKERRQ(ierr); 1304c90a1750SBarry Smith #endif 1305c90a1750SBarry Smith 13067c2de775SJed Brown #if defined(PETSC_HAVE_COMPLEX) 13072c876bd9SBarry Smith #if !defined(PETSC_HAVE_MPI_C_DOUBLE_COMPLEX) 1308500d8756SSatish Balay ierr = MPI_Type_free(&MPIU_C_DOUBLE_COMPLEX);CHKERRQ(ierr); 1309500d8756SSatish Balay ierr = MPI_Type_free(&MPIU_C_COMPLEX);CHKERRQ(ierr); 13102c876bd9SBarry Smith #endif 1311e5c89e4eSSatish Balay #endif 1312cca4cb22SSatish Balay 13137c2de775SJed Brown #if (defined(PETSC_HAVE_COMPLEX) && !defined(PETSC_HAVE_MPI_C_DOUBLE_COMPLEX)) || defined(PETSC_USE_REAL___FLOAT128) 1314cca4cb22SSatish Balay ierr = MPI_Op_free(&MPIU_SUM);CHKERRQ(ierr); 1315cca4cb22SSatish Balay #endif 1316cca4cb22SSatish Balay 1317e5c89e4eSSatish Balay ierr = MPI_Type_free(&MPIU_2SCALAR);CHKERRQ(ierr); 131844041f26SJed Brown #if defined(PETSC_USE_64BIT_INDICES) || !defined(MPI_2INT) 1319e5c89e4eSSatish Balay ierr = MPI_Type_free(&MPIU_2INT);CHKERRQ(ierr); 132044041f26SJed Brown #endif 1321e5c89e4eSSatish Balay ierr = MPI_Op_free(&PetscMaxSum_Op);CHKERRQ(ierr); 1322e5c89e4eSSatish Balay 1323dbc8283eSBarry Smith /* 1324efb80d3cSBarry Smith Destroy any known inner MPI_Comm's and attributes pointing to them 1325efb80d3cSBarry Smith Note this will not destroy any new communicators the user has created. 1326efb80d3cSBarry Smith 1327efb80d3cSBarry Smith If all PETSc objects were not destroyed those left over objects will have hanging references to 1328efb80d3cSBarry Smith the MPI_Comms that were freed; but that is ok because those PETSc objects will never be used again 1329dbc8283eSBarry Smith */ 1330b770b1f6SSatish Balay { 1331dbc8283eSBarry Smith PetscCommCounter *counter; 1332dbc8283eSBarry Smith PetscMPIInt flg; 1333dbc8283eSBarry Smith MPI_Comm icomm; 1334265f3f35SJed Brown union {MPI_Comm comm; void *ptr;} ucomm; 1335265f3f35SJed Brown ierr = MPI_Attr_get(PETSC_COMM_SELF,Petsc_InnerComm_keyval,&ucomm,&flg);CHKERRQ(ierr); 1336dbc8283eSBarry Smith if (flg) { 1337265f3f35SJed Brown icomm = ucomm.comm; 1338dbc8283eSBarry Smith ierr = MPI_Attr_get(icomm,Petsc_Counter_keyval,&counter,&flg);CHKERRQ(ierr); 1339dbc8283eSBarry 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"); 1340dbc8283eSBarry Smith 1341dbc8283eSBarry Smith ierr = MPI_Attr_delete(PETSC_COMM_SELF,Petsc_InnerComm_keyval);CHKERRQ(ierr); 1342efb80d3cSBarry Smith ierr = MPI_Attr_delete(icomm,Petsc_Counter_keyval);CHKERRQ(ierr); 1343efb80d3cSBarry Smith ierr = MPI_Comm_free(&icomm);CHKERRQ(ierr); 1344dbc8283eSBarry Smith } 1345265f3f35SJed Brown ierr = MPI_Attr_get(PETSC_COMM_WORLD,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_WORLD,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_WORLD,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 } 1355b770b1f6SSatish Balay } 1356dbc8283eSBarry Smith 1357480cf27aSJed Brown ierr = MPI_Keyval_free(&Petsc_Counter_keyval);CHKERRQ(ierr); 1358480cf27aSJed Brown ierr = MPI_Keyval_free(&Petsc_InnerComm_keyval);CHKERRQ(ierr); 1359480cf27aSJed Brown ierr = MPI_Keyval_free(&Petsc_OuterComm_keyval);CHKERRQ(ierr); 1360480cf27aSJed Brown 1361e5c89e4eSSatish Balay if (PetscBeganMPI) { 136299608316SBarry Smith #if defined(PETSC_HAVE_MPI_FINALIZED) 136399b1327fSBarry Smith PetscMPIInt flag; 136499b1327fSBarry Smith ierr = MPI_Finalized(&flag);CHKERRQ(ierr); 1365e32f2f54SBarry Smith if (flag) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_LIB,"MPI_Finalize() has already been called, even though MPI_Init() was called by PetscInitialize()"); 136699608316SBarry Smith #endif 1367e5c89e4eSSatish Balay ierr = MPI_Finalize();CHKERRQ(ierr); 1368e5c89e4eSSatish Balay } 1369e5c89e4eSSatish Balay /* 1370e5c89e4eSSatish Balay 1371e5c89e4eSSatish Balay Note: In certain cases PETSC_COMM_WORLD is never MPI_Comm_free()ed because 1372e5c89e4eSSatish Balay the communicator has some outstanding requests on it. Specifically if the 1373e5c89e4eSSatish Balay flag PETSC_HAVE_BROKEN_REQUEST_FREE is set (for IBM MPI implementation). See 1374e5c89e4eSSatish Balay src/vec/utils/vpscat.c. Due to this the memory allocated in PetscCommDuplicate() 1375e5c89e4eSSatish Balay is never freed as it should be. Thus one may obtain messages of the form 13760e5e90baSSatish Balay [ 1] 8 bytes PetscCommDuplicate() line 645 in src/sys/mpiu.c indicating the 1377e5c89e4eSSatish Balay memory was not freed. 1378e5c89e4eSSatish Balay 1379e5c89e4eSSatish Balay */ 13801d1a0024SBarry Smith ierr = PetscMallocClear();CHKERRQ(ierr); 1381a297a907SKarl Rupp 1382e5c89e4eSSatish Balay PetscInitializeCalled = PETSC_FALSE; 1383e5c89e4eSSatish Balay PetscFinalizeCalled = PETSC_TRUE; 1384e5c89e4eSSatish Balay PetscFunctionReturn(ierr); 1385e5c89e4eSSatish Balay } 1386e5c89e4eSSatish Balay 138743db4dbbSBarry Smith #if defined(PETSC_MISSING_LAPACK_lsame_) 13888cc058d9SJed Brown PETSC_EXTERN int lsame_(char *a,char *b) 138943db4dbbSBarry Smith { 139043db4dbbSBarry Smith if (*a == *b) return 1; 139143db4dbbSBarry Smith if (*a + 32 == *b) return 1; 139243db4dbbSBarry Smith if (*a - 32 == *b) return 1; 139343db4dbbSBarry Smith return 0; 139443db4dbbSBarry Smith } 1395a70650f6SBarry Smith #endif 139643db4dbbSBarry Smith 139743db4dbbSBarry Smith #if defined(PETSC_MISSING_LAPACK_lsame) 13988cc058d9SJed Brown PETSC_EXTERN int lsame(char *a,char *b) 139943db4dbbSBarry Smith { 140043db4dbbSBarry Smith if (*a == *b) return 1; 140143db4dbbSBarry Smith if (*a + 32 == *b) return 1; 140243db4dbbSBarry Smith if (*a - 32 == *b) return 1; 140343db4dbbSBarry Smith return 0; 140443db4dbbSBarry Smith } 140543db4dbbSBarry Smith #endif 1406