1e5c89e4eSSatish Balay /* 2e5c89e4eSSatish Balay Utilites routines to add simple ASCII IO capability. 3e5c89e4eSSatish Balay */ 4c6db04a5SJed Brown #include <../src/sys/fileio/mprint.h> 5*79c0e996SJed Brown #include <errno.h> 6e5c89e4eSSatish Balay /* 7e5c89e4eSSatish Balay If petsc_history is on, then all Petsc*Printf() results are saved 8e5c89e4eSSatish Balay if the appropriate (usually .petschistory) file. 9e5c89e4eSSatish Balay */ 10e5c89e4eSSatish Balay extern FILE *petsc_history; 11e5c89e4eSSatish Balay /* 12e5c89e4eSSatish Balay Allows one to overwrite where standard out is sent. For example 135106ddf5SBarry Smith PETSC_STDOUT = fopen("/dev/ttyXX","w") will cause all standard out 14e5c89e4eSSatish Balay writes to go to terminal XX; assuming you have write permission there 15e5c89e4eSSatish Balay */ 16e5c89e4eSSatish Balay FILE *PETSC_STDOUT = 0; 17ae9b4142SLisandro Dalcin /* 18ae9b4142SLisandro Dalcin Allows one to overwrite where standard error is sent. For example 19ae9b4142SLisandro Dalcin PETSC_STDERR = fopen("/dev/ttyXX","w") will cause all standard error 20ae9b4142SLisandro Dalcin writes to go to terminal XX; assuming you have write permission there 21ae9b4142SLisandro Dalcin */ 22ae9b4142SLisandro Dalcin FILE *PETSC_STDERR = 0; 23b13499bfSbcordonn /* 24b13499bfSbcordonn Used to output to Zope 25b13499bfSbcordonn */ 26b13499bfSbcordonn FILE *PETSC_ZOPEFD = 0; 27b13499bfSbcordonn 28e5c89e4eSSatish Balay #undef __FUNCT__ 29e5c89e4eSSatish Balay #define __FUNCT__ "PetscFormatConvert" 30c9a19010SBarry Smith /*@C 31c9a19010SBarry Smith PetscFormatConvert - Takes a PETSc format string and converts it to a reqular C format string 32c9a19010SBarry Smith 33c9a19010SBarry Smith Input Parameters: 34c9a19010SBarry Smith + format - the PETSc format string 35c9a19010SBarry Smith . newformat - the location to put the standard C format string values 36c9a19010SBarry Smith - size - the length of newformat 37c9a19010SBarry Smith 38c9a19010SBarry Smith Note: this exists so we can have the same code when PetscInt is either int or long long and PetscScalar is either double or float 39c9a19010SBarry Smith 40c9a19010SBarry Smith Level: developer 41c9a19010SBarry Smith 42c9a19010SBarry Smith @*/ 437087cfbeSBarry Smith PetscErrorCode PetscFormatConvert(const char *format,char *newformat,size_t size) 44e5c89e4eSSatish Balay { 45e5c89e4eSSatish Balay PetscInt i = 0,j = 0; 46e5c89e4eSSatish Balay 479daa610aSJed Brown while (format[i] && i < (PetscInt)size-1) { 48e5c89e4eSSatish Balay if (format[i] == '%' && format[i+1] == 'D') { 49e5c89e4eSSatish Balay newformat[j++] = '%'; 506de02169SBarry Smith #if !defined(PETSC_USE_64BIT_INDICES) 51e5c89e4eSSatish Balay newformat[j++] = 'd'; 52e5c89e4eSSatish Balay #else 53e5c89e4eSSatish Balay newformat[j++] = 'l'; 54e5c89e4eSSatish Balay newformat[j++] = 'l'; 55e5c89e4eSSatish Balay newformat[j++] = 'd'; 56e5c89e4eSSatish Balay #endif 57e5c89e4eSSatish Balay i += 2; 58e5c89e4eSSatish Balay } else if (format[i] == '%' && format[i+1] >= '1' && format[i+1] <= '9' && format[i+2] == 'D') { 59e5c89e4eSSatish Balay newformat[j++] = '%'; 60e5c89e4eSSatish Balay newformat[j++] = format[i+1]; 616de02169SBarry Smith #if !defined(PETSC_USE_64BIT_INDICES) 62e5c89e4eSSatish Balay newformat[j++] = 'd'; 63e5c89e4eSSatish Balay #else 64e5c89e4eSSatish Balay newformat[j++] = 'l'; 65e5c89e4eSSatish Balay newformat[j++] = 'l'; 66e5c89e4eSSatish Balay newformat[j++] = 'd'; 67e5c89e4eSSatish Balay #endif 68e5c89e4eSSatish Balay i += 3; 69a83599f4SBarry Smith } else if (format[i] == '%' && format[i+1] == 'G') { 70a83599f4SBarry Smith newformat[j++] = '%'; 71d9822059SBarry Smith #if defined(PETSC_USE_SCALAR_DOUBLE) || defined(PETSC_USE_SCALAR_SINGLE) 72a83599f4SBarry Smith newformat[j++] = 'g'; 73d9822059SBarry Smith #elif defined(PETSC_USE_SCALAR_LONG_DOUBLE) 74a83599f4SBarry Smith newformat[j++] = 'L'; 75a83599f4SBarry Smith newformat[j++] = 'g'; 76d9822059SBarry Smith #elif defined(PETSC_USE_SCALAR___FLOAT128) 77d9822059SBarry Smith newformat[j++] = 'Q'; 78d9822059SBarry Smith newformat[j++] = 'e'; 79a83599f4SBarry Smith #endif 80a83599f4SBarry Smith i += 2; 81e5c89e4eSSatish Balay }else { 82e5c89e4eSSatish Balay newformat[j++] = format[i++]; 83e5c89e4eSSatish Balay } 84e5c89e4eSSatish Balay } 85e5c89e4eSSatish Balay newformat[j] = 0; 86e5c89e4eSSatish Balay return 0; 87e5c89e4eSSatish Balay } 88e5c89e4eSSatish Balay 89e5c89e4eSSatish Balay #undef __FUNCT__ 90e5c89e4eSSatish Balay #define __FUNCT__ "PetscVSNPrintf" 91c9a19010SBarry Smith /*@C 92c9a19010SBarry Smith PetscVSNPrintf - The PETSc version of vsnprintf(). Converts a PETSc format string into a standard C format string and then puts all the 93c9a19010SBarry Smith function arguments into a string using the format statement. 94c9a19010SBarry Smith 95c9a19010SBarry Smith Input Parameters: 96c9a19010SBarry Smith + str - location to put result 97c9a19010SBarry Smith . len - the amount of space in str 98c9a19010SBarry Smith + format - the PETSc format string 99c9a19010SBarry Smith - fullLength - the amount of space in str actually used. 100c9a19010SBarry Smith 101c9a19010SBarry Smith Note: No error handling because may be called by error handler 102c9a19010SBarry Smith 103c9a19010SBarry Smith Level: developer 104c9a19010SBarry Smith 105c9a19010SBarry Smith @*/ 1067087cfbeSBarry Smith PetscErrorCode PetscVSNPrintf(char *str,size_t len,const char *format,size_t *fullLength,va_list Argp) 107e5c89e4eSSatish Balay { 108e5c89e4eSSatish Balay /* no malloc since may be called by error handler */ 109e2135aedSMatthew Knepley char *newformat; 110e2135aedSMatthew Knepley char formatbuf[8*1024]; 111e2135aedSMatthew Knepley size_t oldLength,length; 1121a15ef5dSMatthew Knepley PetscErrorCode ierr; 113e5c89e4eSSatish Balay 114e2135aedSMatthew Knepley ierr = PetscStrlen(format, &oldLength);CHKERRQ(ierr); 115e2135aedSMatthew Knepley if (oldLength < 8*1024) { 116e2135aedSMatthew Knepley newformat = formatbuf; 117e2135aedSMatthew Knepley } else { 118e2135aedSMatthew Knepley ierr = PetscMalloc((oldLength+1) * sizeof(char), &newformat);CHKERRQ(ierr); 119e2135aedSMatthew Knepley } 120e2135aedSMatthew Knepley PetscFormatConvert(format,newformat,oldLength+1); 1211a15ef5dSMatthew Knepley ierr = PetscStrlen(newformat, &length);CHKERRQ(ierr); 1222d609e63SMatthew Knepley #if 0 1231a15ef5dSMatthew Knepley if (length > len) { 1241a15ef5dSMatthew Knepley newformat[len] = '\0'; 1251a15ef5dSMatthew Knepley } 1262d609e63SMatthew Knepley #endif 1275a058713SBarry Smith #if defined(PETSC_HAVE_VSNPRINTF_CHAR) 1282d609e63SMatthew Knepley *fullLength = vsnprintf(str,len,newformat,(char *)Argp); 12989b07760SSatish Balay #elif defined(PETSC_HAVE_VSNPRINTF) 13089b07760SSatish Balay *fullLength = vsnprintf(str,len,newformat,Argp); 131141c0d65SSatish Balay #elif defined(PETSC_HAVE__VSNPRINTF) 132141c0d65SSatish Balay *fullLength = _vsnprintf(str,len,newformat,Argp); 133e5c89e4eSSatish Balay #else 13489b07760SSatish Balay #error "vsnprintf not found" 135e5c89e4eSSatish Balay #endif 136e2135aedSMatthew Knepley if (oldLength >= 8*1024) { 137e2135aedSMatthew Knepley ierr = PetscFree(newformat);CHKERRQ(ierr); 138e2135aedSMatthew Knepley } 139e5c89e4eSSatish Balay return 0; 140e5c89e4eSSatish Balay } 141e5c89e4eSSatish Balay 142e5c89e4eSSatish Balay #undef __FUNCT__ 1437ead4f01Sbcordonn #define __FUNCT__ "PetscZopeLog" 1447087cfbeSBarry Smith PetscErrorCode PetscZopeLog(const char *format,va_list Argp) 1459c4c166aSBarry Smith { 1467ead4f01Sbcordonn /* no malloc since may be called by error handler */ 1477ead4f01Sbcordonn char newformat[8*1024]; 1487ead4f01Sbcordonn char log[8*1024]; 1497ead4f01Sbcordonn char logstart[] = " <<<log>>>"; 150c9a19010SBarry Smith size_t len,formatlen; 1519c4c166aSBarry Smith 1527ead4f01Sbcordonn PetscFormatConvert(format,newformat,8*1024); 1537ead4f01Sbcordonn PetscStrlen(logstart, &len); 1547ead4f01Sbcordonn PetscMemcpy(log, logstart, len); 1557ead4f01Sbcordonn PetscStrlen(newformat, &formatlen); 1567ead4f01Sbcordonn PetscMemcpy(&(log[len]), newformat, formatlen); 1579c4c166aSBarry Smith if (PETSC_ZOPEFD){ 1585a058713SBarry Smith #if defined(PETSC_HAVE_VFPRINTF_CHAR) 1597ead4f01Sbcordonn vfprintf(PETSC_ZOPEFD,log,(char *)Argp); 1607ead4f01Sbcordonn #else 1617ead4f01Sbcordonn vfprintf(PETSC_ZOPEFD,log,Argp); 1627ead4f01Sbcordonn #endif 1635a058713SBarry Smith fflush(PETSC_ZOPEFD); 1647ead4f01Sbcordonn } 1657ead4f01Sbcordonn return 0; 1667ead4f01Sbcordonn } 1677ead4f01Sbcordonn 1687ead4f01Sbcordonn #undef __FUNCT__ 169c9a19010SBarry Smith #define __FUNCT__ "PetscVFPrintfDefault" 170c9a19010SBarry Smith /*@C 171c9a19010SBarry Smith PetscVFPrintf - All PETSc standard out and error messages are sent through this function; so, in theory, this can 172e5c89e4eSSatish Balay can be replaced with something that does not simply write to a file. 173e5c89e4eSSatish Balay 174c9a19010SBarry Smith To use, write your own function for example, 175c9a19010SBarry Smith $PetscErrorCode mypetscvfprintf(FILE *fd,const char format[],va_list Argp) 176c9a19010SBarry Smith ${ 177c9a19010SBarry Smith $ PetscErrorCode ierr; 178c9a19010SBarry Smith $ 179c9a19010SBarry Smith $ PetscFunctionBegin; 180c9a19010SBarry Smith $ if (fd != stdout && fd != stderr) { handle regular files 181c9a19010SBarry Smith $ ierr = PetscVFPrintfDefault(fd,format,Argp); CHKERR(ierr); 182c9a19010SBarry Smith $ } else { 183c9a19010SBarry Smith $ char buff[BIG]; 184c9a19010SBarry Smith $ size_t length; 185c9a19010SBarry Smith $ ierr = PetscVSNPrintf(buff,BIG,format,&length,Argp);CHKERRQ(ierr); 186c9a19010SBarry Smith $ now send buff to whatever stream or whatever you want 187c9a19010SBarry Smith $ } 188c9a19010SBarry Smith $ PetscFunctionReturn(0); 189c9a19010SBarry Smith $} 190c9a19010SBarry Smith then before the call to PetscInitialize() do the assignment 191c9a19010SBarry Smith $ PetscVFPrintf = mypetscvfprintf; 192c9a19010SBarry Smith 193c9a19010SBarry Smith Notes: For error messages this may be called by any process, for regular standard out it is 194e5c89e4eSSatish Balay called only by process 0 of a given communicator 195e5c89e4eSSatish Balay 196e5c89e4eSSatish Balay No error handling because may be called by error handler 197c9a19010SBarry Smith 198c9a19010SBarry Smith Level: developer 199c9a19010SBarry Smith 200c9a19010SBarry Smith .seealso: PetscVSNPrintf(), PetscErrorPrintf() 201c9a19010SBarry Smith 202c9a19010SBarry Smith @*/ 2037087cfbeSBarry Smith PetscErrorCode PetscVFPrintfDefault(FILE *fd,const char *format,va_list Argp) 204e5c89e4eSSatish Balay { 205e2135aedSMatthew Knepley /* no malloc since may be called by error handler (assume no long messages in errors) */ 206e2135aedSMatthew Knepley char *newformat; 207e2135aedSMatthew Knepley char formatbuf[8*1024]; 208e2135aedSMatthew Knepley size_t oldLength; 2091179db26SBarry Smith 210e2135aedSMatthew Knepley PetscStrlen(format, &oldLength); 211e2135aedSMatthew Knepley if (oldLength < 8*1024) { 212e2135aedSMatthew Knepley newformat = formatbuf; 213e2135aedSMatthew Knepley } else { 214fee1560eSJed Brown (void)PetscMalloc((oldLength+1) * sizeof(char), &newformat); 215e2135aedSMatthew Knepley } 216e2135aedSMatthew Knepley PetscFormatConvert(format,newformat,oldLength+1); 217d8c6e182Sbcordonn 2185a058713SBarry Smith #if defined(PETSC_HAVE_VFPRINTF_CHAR) 219e5c89e4eSSatish Balay vfprintf(fd,newformat,(char *)Argp); 220e5c89e4eSSatish Balay #else 221e5c89e4eSSatish Balay vfprintf(fd,newformat,Argp); 222e5c89e4eSSatish Balay #endif 2235a058713SBarry Smith fflush(fd); 224e2135aedSMatthew Knepley if (oldLength >= 8*1024) { 2259a2231e1SJed Brown (void)PetscFree(newformat); 226e2135aedSMatthew Knepley } 227e5c89e4eSSatish Balay return 0; 228e5c89e4eSSatish Balay } 229e5c89e4eSSatish Balay 2305b5bc046SBarry Smith #undef __FUNCT__ 2315b5bc046SBarry Smith #define __FUNCT__ "PetscSNPrintf" 2325b5bc046SBarry Smith /*@C 2335b5bc046SBarry Smith PetscSNPrintf - Prints to a string of given length 2345b5bc046SBarry Smith 2355b5bc046SBarry Smith Not Collective 2365b5bc046SBarry Smith 2375b5bc046SBarry Smith Input Parameters: 2385b5bc046SBarry Smith + str - the string to print to 2395b5bc046SBarry Smith . len - the length of str 2405b5bc046SBarry Smith . format - the usual printf() format string 2415b5bc046SBarry Smith - any arguments 2425b5bc046SBarry Smith 2435b5bc046SBarry Smith Level: intermediate 2445b5bc046SBarry Smith 2455b5bc046SBarry Smith .seealso: PetscSynchronizedFlush(), PetscSynchronizedFPrintf(), PetscFPrintf(), PetscVSNPrintf(), 2465b5bc046SBarry Smith PetscPrintf(), PetscViewerASCIIPrintf(), PetscViewerASCIISynchronizedPrintf() 2475b5bc046SBarry Smith @*/ 2487087cfbeSBarry Smith PetscErrorCode PetscSNPrintf(char *str,size_t len,const char format[],...) 2495b5bc046SBarry Smith { 2505b5bc046SBarry Smith PetscErrorCode ierr; 251c9a19010SBarry Smith size_t fullLength; 2525b5bc046SBarry Smith va_list Argp; 2535b5bc046SBarry Smith 2545b5bc046SBarry Smith PetscFunctionBegin; 2555b5bc046SBarry Smith va_start(Argp,format); 2562d609e63SMatthew Knepley ierr = PetscVSNPrintf(str,len,format,&fullLength,Argp);CHKERRQ(ierr); 2575b5bc046SBarry Smith PetscFunctionReturn(0); 2585b5bc046SBarry Smith } 2595b5bc046SBarry Smith 260e5c89e4eSSatish Balay /* ----------------------------------------------------------------------- */ 261e5c89e4eSSatish Balay 262e5c89e4eSSatish Balay PrintfQueue queue = 0,queuebase = 0; 263e5c89e4eSSatish Balay int queuelength = 0; 264e5c89e4eSSatish Balay FILE *queuefile = PETSC_NULL; 265e5c89e4eSSatish Balay 266e5c89e4eSSatish Balay #undef __FUNCT__ 267e5c89e4eSSatish Balay #define __FUNCT__ "PetscSynchronizedPrintf" 268e5c89e4eSSatish Balay /*@C 269e5c89e4eSSatish Balay PetscSynchronizedPrintf - Prints synchronized output from several processors. 270e5c89e4eSSatish Balay Output of the first processor is followed by that of the second, etc. 271e5c89e4eSSatish Balay 272e5c89e4eSSatish Balay Not Collective 273e5c89e4eSSatish Balay 274e5c89e4eSSatish Balay Input Parameters: 275e5c89e4eSSatish Balay + comm - the communicator 276e5c89e4eSSatish Balay - format - the usual printf() format string 277e5c89e4eSSatish Balay 278e5c89e4eSSatish Balay Level: intermediate 279e5c89e4eSSatish Balay 280e5c89e4eSSatish Balay Notes: 281e5c89e4eSSatish Balay REQUIRES a intervening call to PetscSynchronizedFlush() for the information 282e5c89e4eSSatish Balay from all the processors to be printed. 283e5c89e4eSSatish Balay 284e5c89e4eSSatish Balay Fortran Note: 285d60d70ccSBarry Smith The call sequence is PetscSynchronizedPrintf(MPI_Comm, character(*), PetscErrorCode ierr) from Fortran. 286e5c89e4eSSatish Balay That is, you can only pass a single character string from Fortran. 287e5c89e4eSSatish Balay 288e5c89e4eSSatish Balay .seealso: PetscSynchronizedFlush(), PetscSynchronizedFPrintf(), PetscFPrintf(), 289e5c89e4eSSatish Balay PetscPrintf(), PetscViewerASCIIPrintf(), PetscViewerASCIISynchronizedPrintf() 290e5c89e4eSSatish Balay @*/ 2917087cfbeSBarry Smith PetscErrorCode PetscSynchronizedPrintf(MPI_Comm comm,const char format[],...) 292e5c89e4eSSatish Balay { 293e5c89e4eSSatish Balay PetscErrorCode ierr; 294e5c89e4eSSatish Balay PetscMPIInt rank; 295e5c89e4eSSatish Balay 296e5c89e4eSSatish Balay PetscFunctionBegin; 297e5c89e4eSSatish Balay ierr = MPI_Comm_rank(comm,&rank);CHKERRQ(ierr); 298e5c89e4eSSatish Balay 299e5c89e4eSSatish Balay /* First processor prints immediately to stdout */ 300e5c89e4eSSatish Balay if (!rank) { 301e5c89e4eSSatish Balay va_list Argp; 302e5c89e4eSSatish Balay va_start(Argp,format); 3031179db26SBarry Smith ierr = (*PetscVFPrintf)(PETSC_STDOUT,format,Argp);CHKERRQ(ierr); 304e5c89e4eSSatish Balay if (petsc_history) { 305cdc7d174SSatish Balay va_start(Argp,format); 3061179db26SBarry Smith ierr = (*PetscVFPrintf)(petsc_history,format,Argp);CHKERRQ(ierr); 307e5c89e4eSSatish Balay } 308e5c89e4eSSatish Balay va_end(Argp); 309e5c89e4eSSatish Balay } else { /* other processors add to local queue */ 310e5c89e4eSSatish Balay va_list Argp; 311e5c89e4eSSatish Balay PrintfQueue next; 312c9a19010SBarry Smith size_t fullLength = 8191; 313e5c89e4eSSatish Balay 314e5c89e4eSSatish Balay ierr = PetscNew(struct _PrintfQueue,&next);CHKERRQ(ierr); 315e5c89e4eSSatish Balay if (queue) {queue->next = next; queue = next; queue->next = 0;} 316e5c89e4eSSatish Balay else {queuebase = queue = next;} 317e5c89e4eSSatish Balay queuelength++; 3182d609e63SMatthew Knepley next->size = -1; 3199ad23270SJed Brown while((PetscInt)fullLength >= next->size) { 3202d609e63SMatthew Knepley next->size = fullLength+1; 3212d609e63SMatthew Knepley ierr = PetscMalloc(next->size * sizeof(char), &next->string);CHKERRQ(ierr); 322e5c89e4eSSatish Balay va_start(Argp,format); 3232d609e63SMatthew Knepley ierr = PetscMemzero(next->string,next->size);CHKERRQ(ierr); 3242d609e63SMatthew Knepley ierr = PetscVSNPrintf(next->string,next->size,format, &fullLength,Argp);CHKERRQ(ierr); 325e5c89e4eSSatish Balay va_end(Argp); 326e5c89e4eSSatish Balay } 3272d609e63SMatthew Knepley } 328e5c89e4eSSatish Balay 329e5c89e4eSSatish Balay PetscFunctionReturn(0); 330e5c89e4eSSatish Balay } 331e5c89e4eSSatish Balay 332e5c89e4eSSatish Balay #undef __FUNCT__ 333e5c89e4eSSatish Balay #define __FUNCT__ "PetscSynchronizedFPrintf" 334e5c89e4eSSatish Balay /*@C 335e5c89e4eSSatish Balay PetscSynchronizedFPrintf - Prints synchronized output to the specified file from 336e5c89e4eSSatish Balay several processors. Output of the first processor is followed by that of the 337e5c89e4eSSatish Balay second, etc. 338e5c89e4eSSatish Balay 339e5c89e4eSSatish Balay Not Collective 340e5c89e4eSSatish Balay 341e5c89e4eSSatish Balay Input Parameters: 342e5c89e4eSSatish Balay + comm - the communicator 343e5c89e4eSSatish Balay . fd - the file pointer 344e5c89e4eSSatish Balay - format - the usual printf() format string 345e5c89e4eSSatish Balay 346e5c89e4eSSatish Balay Level: intermediate 347e5c89e4eSSatish Balay 348e5c89e4eSSatish Balay Notes: 349e5c89e4eSSatish Balay REQUIRES a intervening call to PetscSynchronizedFlush() for the information 350e5c89e4eSSatish Balay from all the processors to be printed. 351e5c89e4eSSatish Balay 352e5c89e4eSSatish Balay .seealso: PetscSynchronizedPrintf(), PetscSynchronizedFlush(), PetscFPrintf(), 353e5c89e4eSSatish Balay PetscFOpen(), PetscViewerASCIISynchronizedPrintf(), PetscViewerASCIIPrintf() 354e5c89e4eSSatish Balay 355e5c89e4eSSatish Balay @*/ 3567087cfbeSBarry Smith PetscErrorCode PetscSynchronizedFPrintf(MPI_Comm comm,FILE* fp,const char format[],...) 357e5c89e4eSSatish Balay { 358e5c89e4eSSatish Balay PetscErrorCode ierr; 359e5c89e4eSSatish Balay PetscMPIInt rank; 360e5c89e4eSSatish Balay 361e5c89e4eSSatish Balay PetscFunctionBegin; 362e5c89e4eSSatish Balay ierr = MPI_Comm_rank(comm,&rank);CHKERRQ(ierr); 363e5c89e4eSSatish Balay 364e5c89e4eSSatish Balay /* First processor prints immediately to fp */ 365e5c89e4eSSatish Balay if (!rank) { 366e5c89e4eSSatish Balay va_list Argp; 367e5c89e4eSSatish Balay va_start(Argp,format); 3681179db26SBarry Smith ierr = (*PetscVFPrintf)(fp,format,Argp);CHKERRQ(ierr); 369e5c89e4eSSatish Balay queuefile = fp; 370cdc7d174SSatish Balay if (petsc_history && (fp !=petsc_history)) { 371cdc7d174SSatish Balay va_start(Argp,format); 3721179db26SBarry Smith ierr = (*PetscVFPrintf)(petsc_history,format,Argp);CHKERRQ(ierr); 373e5c89e4eSSatish Balay } 374e5c89e4eSSatish Balay va_end(Argp); 375e5c89e4eSSatish Balay } else { /* other processors add to local queue */ 376e5c89e4eSSatish Balay va_list Argp; 377e5c89e4eSSatish Balay PrintfQueue next; 378c9a19010SBarry Smith size_t fullLength = 8191; 379e5c89e4eSSatish Balay ierr = PetscNew(struct _PrintfQueue,&next);CHKERRQ(ierr); 380e5c89e4eSSatish Balay if (queue) {queue->next = next; queue = next; queue->next = 0;} 381e5c89e4eSSatish Balay else {queuebase = queue = next;} 382e5c89e4eSSatish Balay queuelength++; 3832d609e63SMatthew Knepley next->size = -1; 3849ad23270SJed Brown while((PetscInt)fullLength >= next->size) { 3852d609e63SMatthew Knepley next->size = fullLength+1; 3862d609e63SMatthew Knepley ierr = PetscMalloc(next->size * sizeof(char), &next->string);CHKERRQ(ierr); 387e5c89e4eSSatish Balay va_start(Argp,format); 3882d609e63SMatthew Knepley ierr = PetscMemzero(next->string,next->size);CHKERRQ(ierr); 3892d609e63SMatthew Knepley ierr = PetscVSNPrintf(next->string,next->size,format,&fullLength,Argp);CHKERRQ(ierr); 390e5c89e4eSSatish Balay va_end(Argp); 391e5c89e4eSSatish Balay } 3922d609e63SMatthew Knepley } 393e5c89e4eSSatish Balay PetscFunctionReturn(0); 394e5c89e4eSSatish Balay } 395e5c89e4eSSatish Balay 396e5c89e4eSSatish Balay #undef __FUNCT__ 397e5c89e4eSSatish Balay #define __FUNCT__ "PetscSynchronizedFlush" 398e30d2299SSatish Balay /*@ 399e5c89e4eSSatish Balay PetscSynchronizedFlush - Flushes to the screen output from all processors 400e5c89e4eSSatish Balay involved in previous PetscSynchronizedPrintf() calls. 401e5c89e4eSSatish Balay 402e5c89e4eSSatish Balay Collective on MPI_Comm 403e5c89e4eSSatish Balay 404e5c89e4eSSatish Balay Input Parameters: 405e5c89e4eSSatish Balay . comm - the communicator 406e5c89e4eSSatish Balay 407e5c89e4eSSatish Balay Level: intermediate 408e5c89e4eSSatish Balay 409e5c89e4eSSatish Balay Notes: 410e5c89e4eSSatish Balay Usage of PetscSynchronizedPrintf() and PetscSynchronizedFPrintf() with 411e5c89e4eSSatish Balay different MPI communicators REQUIRES an intervening call to PetscSynchronizedFlush(). 412e5c89e4eSSatish Balay 413e5c89e4eSSatish Balay .seealso: PetscSynchronizedPrintf(), PetscFPrintf(), PetscPrintf(), PetscViewerASCIIPrintf(), 414e5c89e4eSSatish Balay PetscViewerASCIISynchronizedPrintf() 415e5c89e4eSSatish Balay @*/ 4167087cfbeSBarry Smith PetscErrorCode PetscSynchronizedFlush(MPI_Comm comm) 417e5c89e4eSSatish Balay { 418e5c89e4eSSatish Balay PetscErrorCode ierr; 419bf3b0749SBarry Smith PetscMPIInt rank,size,tag,i,j,n,dummy = 0; 4202d609e63SMatthew Knepley char *message; 421e5c89e4eSSatish Balay MPI_Status status; 422e5c89e4eSSatish Balay FILE *fd; 423e5c89e4eSSatish Balay 424e5c89e4eSSatish Balay PetscFunctionBegin; 425e5c89e4eSSatish Balay ierr = PetscCommDuplicate(comm,&comm,&tag);CHKERRQ(ierr); 426e5c89e4eSSatish Balay ierr = MPI_Comm_rank(comm,&rank);CHKERRQ(ierr); 427e5c89e4eSSatish Balay ierr = MPI_Comm_size(comm,&size);CHKERRQ(ierr); 428e5c89e4eSSatish Balay 429e5c89e4eSSatish Balay /* First processor waits for messages from all other processors */ 430e5c89e4eSSatish Balay if (!rank) { 431e5c89e4eSSatish Balay if (queuefile) { 432e5c89e4eSSatish Balay fd = queuefile; 433e5c89e4eSSatish Balay } else { 434e5c89e4eSSatish Balay fd = PETSC_STDOUT; 435e5c89e4eSSatish Balay } 436e5c89e4eSSatish Balay for (i=1; i<size; i++) { 4379f73f8ecSBarry Smith /* to prevent a flood of messages to process zero, request each message separately */ 4389f73f8ecSBarry Smith ierr = MPI_Send(&dummy,1,MPI_INT,i,tag,comm);CHKERRQ(ierr); 439e5c89e4eSSatish Balay ierr = MPI_Recv(&n,1,MPI_INT,i,tag,comm,&status);CHKERRQ(ierr); 440e5c89e4eSSatish Balay for (j=0; j<n; j++) { 4419f73f8ecSBarry Smith PetscMPIInt size; 4422d609e63SMatthew Knepley 4432d609e63SMatthew Knepley ierr = MPI_Recv(&size,1,MPI_INT,i,tag,comm,&status);CHKERRQ(ierr); 4442d609e63SMatthew Knepley ierr = PetscMalloc(size * sizeof(char), &message);CHKERRQ(ierr); 4452d609e63SMatthew Knepley ierr = MPI_Recv(message,size,MPI_CHAR,i,tag,comm,&status);CHKERRQ(ierr); 446e5c89e4eSSatish Balay ierr = PetscFPrintf(comm,fd,"%s",message); 4472d609e63SMatthew Knepley ierr = PetscFree(message);CHKERRQ(ierr); 448e5c89e4eSSatish Balay } 449e5c89e4eSSatish Balay } 450e5c89e4eSSatish Balay queuefile = PETSC_NULL; 451e5c89e4eSSatish Balay } else { /* other processors send queue to processor 0 */ 452e5c89e4eSSatish Balay PrintfQueue next = queuebase,previous; 453e5c89e4eSSatish Balay 454b3ef9d35SBarry Smith ierr = MPI_Recv(&dummy,1,MPI_INT,0,tag,comm,&status);CHKERRQ(ierr); 455e5c89e4eSSatish Balay ierr = MPI_Send(&queuelength,1,MPI_INT,0,tag,comm);CHKERRQ(ierr); 456e5c89e4eSSatish Balay for (i=0; i<queuelength; i++) { 4572d609e63SMatthew Knepley ierr = MPI_Send(&next->size,1,MPI_INT,0,tag,comm);CHKERRQ(ierr); 4582d609e63SMatthew Knepley ierr = MPI_Send(next->string,next->size,MPI_CHAR,0,tag,comm);CHKERRQ(ierr); 459e5c89e4eSSatish Balay previous = next; 460e5c89e4eSSatish Balay next = next->next; 4612d609e63SMatthew Knepley ierr = PetscFree(previous->string);CHKERRQ(ierr); 462e5c89e4eSSatish Balay ierr = PetscFree(previous);CHKERRQ(ierr); 463e5c89e4eSSatish Balay } 464e5c89e4eSSatish Balay queue = 0; 465e5c89e4eSSatish Balay queuelength = 0; 466e5c89e4eSSatish Balay } 467e5c89e4eSSatish Balay ierr = PetscCommDestroy(&comm);CHKERRQ(ierr); 468e5c89e4eSSatish Balay PetscFunctionReturn(0); 469e5c89e4eSSatish Balay } 470e5c89e4eSSatish Balay 471e5c89e4eSSatish Balay /* ---------------------------------------------------------------------------------------*/ 472e5c89e4eSSatish Balay 473e5c89e4eSSatish Balay #undef __FUNCT__ 474e5c89e4eSSatish Balay #define __FUNCT__ "PetscFPrintf" 475e5c89e4eSSatish Balay /*@C 476e5c89e4eSSatish Balay PetscFPrintf - Prints to a file, only from the first 477e5c89e4eSSatish Balay processor in the communicator. 478e5c89e4eSSatish Balay 479e5c89e4eSSatish Balay Not Collective 480e5c89e4eSSatish Balay 481e5c89e4eSSatish Balay Input Parameters: 482e5c89e4eSSatish Balay + comm - the communicator 483e5c89e4eSSatish Balay . fd - the file pointer 484e5c89e4eSSatish Balay - format - the usual printf() format string 485e5c89e4eSSatish Balay 486e5c89e4eSSatish Balay Level: intermediate 487e5c89e4eSSatish Balay 488e5c89e4eSSatish Balay Fortran Note: 489e5c89e4eSSatish Balay This routine is not supported in Fortran. 490e5c89e4eSSatish Balay 491e5c89e4eSSatish Balay Concepts: printing^in parallel 492e5c89e4eSSatish Balay Concepts: printf^in parallel 493e5c89e4eSSatish Balay 494e5c89e4eSSatish Balay .seealso: PetscPrintf(), PetscSynchronizedPrintf(), PetscViewerASCIIPrintf(), 495e5c89e4eSSatish Balay PetscViewerASCIISynchronizedPrintf(), PetscSynchronizedFlush() 496e5c89e4eSSatish Balay @*/ 4977087cfbeSBarry Smith PetscErrorCode PetscFPrintf(MPI_Comm comm,FILE* fd,const char format[],...) 498e5c89e4eSSatish Balay { 499e5c89e4eSSatish Balay PetscErrorCode ierr; 500e5c89e4eSSatish Balay PetscMPIInt rank; 501e5c89e4eSSatish Balay 502e5c89e4eSSatish Balay PetscFunctionBegin; 503e5c89e4eSSatish Balay ierr = MPI_Comm_rank(comm,&rank);CHKERRQ(ierr); 504e5c89e4eSSatish Balay if (!rank) { 505e5c89e4eSSatish Balay va_list Argp; 506e5c89e4eSSatish Balay va_start(Argp,format); 5071179db26SBarry Smith ierr = (*PetscVFPrintf)(fd,format,Argp);CHKERRQ(ierr); 508cdc7d174SSatish Balay if (petsc_history && (fd !=petsc_history)) { 509cdc7d174SSatish Balay va_start(Argp,format); 5101179db26SBarry Smith ierr = (*PetscVFPrintf)(petsc_history,format,Argp);CHKERRQ(ierr); 511e5c89e4eSSatish Balay } 512e5c89e4eSSatish Balay va_end(Argp); 513e5c89e4eSSatish Balay } 514e5c89e4eSSatish Balay PetscFunctionReturn(0); 515e5c89e4eSSatish Balay } 516e5c89e4eSSatish Balay 517e5c89e4eSSatish Balay #undef __FUNCT__ 518e5c89e4eSSatish Balay #define __FUNCT__ "PetscPrintf" 519e5c89e4eSSatish Balay /*@C 520e5c89e4eSSatish Balay PetscPrintf - Prints to standard out, only from the first 521e5c89e4eSSatish Balay processor in the communicator. 522e5c89e4eSSatish Balay 523e5c89e4eSSatish Balay Not Collective 524e5c89e4eSSatish Balay 525e5c89e4eSSatish Balay Input Parameters: 526e5c89e4eSSatish Balay + comm - the communicator 527e5c89e4eSSatish Balay - format - the usual printf() format string 528e5c89e4eSSatish Balay 529e5c89e4eSSatish Balay Level: intermediate 530e5c89e4eSSatish Balay 531e5c89e4eSSatish Balay Fortran Note: 532d60d70ccSBarry Smith The call sequence is PetscPrintf(MPI_Comm, character(*), PetscErrorCode ierr) from Fortran. 533e5c89e4eSSatish Balay That is, you can only pass a single character string from Fortran. 534e5c89e4eSSatish Balay 5358884cb1fSJed Brown Notes: The %A format specifier is special. It assumes an argument of type PetscReal 5368884cb1fSJed Brown and is replaced with %G unless the absolute value is < 1.e-12 when it is replaced 5378884cb1fSJed Brown with "< 1.e-12" (1.e-6 for single precision). 538e5c89e4eSSatish Balay 539e5c89e4eSSatish Balay Concepts: printing^in parallel 540e5c89e4eSSatish Balay Concepts: printf^in parallel 541e5c89e4eSSatish Balay 542e5c89e4eSSatish Balay .seealso: PetscFPrintf(), PetscSynchronizedPrintf() 543e5c89e4eSSatish Balay @*/ 5447087cfbeSBarry Smith PetscErrorCode PetscPrintf(MPI_Comm comm,const char format[],...) 545e5c89e4eSSatish Balay { 546e5c89e4eSSatish Balay PetscErrorCode ierr; 547e5c89e4eSSatish Balay PetscMPIInt rank; 548e5c89e4eSSatish Balay size_t len; 549e5c89e4eSSatish Balay char *nformat,*sub1,*sub2; 550e5c89e4eSSatish Balay PetscReal value; 551e5c89e4eSSatish Balay 552e5c89e4eSSatish Balay PetscFunctionBegin; 553e5c89e4eSSatish Balay if (!comm) comm = PETSC_COMM_WORLD; 554e5c89e4eSSatish Balay ierr = MPI_Comm_rank(comm,&rank);CHKERRQ(ierr); 555e5c89e4eSSatish Balay if (!rank) { 556e5c89e4eSSatish Balay va_list Argp; 557e5c89e4eSSatish Balay va_start(Argp,format); 558e5c89e4eSSatish Balay 559e5c89e4eSSatish Balay ierr = PetscStrstr(format,"%A",&sub1);CHKERRQ(ierr); 560e5c89e4eSSatish Balay if (sub1) { 561e5c89e4eSSatish Balay ierr = PetscStrstr(format,"%",&sub2);CHKERRQ(ierr); 562e32f2f54SBarry Smith if (sub1 != sub2) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"%%A format must be first in format string"); 563e5c89e4eSSatish Balay ierr = PetscStrlen(format,&len);CHKERRQ(ierr); 564e5c89e4eSSatish Balay ierr = PetscMalloc((len+16)*sizeof(char),&nformat);CHKERRQ(ierr); 565e5c89e4eSSatish Balay ierr = PetscStrcpy(nformat,format);CHKERRQ(ierr); 566e5c89e4eSSatish Balay ierr = PetscStrstr(nformat,"%",&sub2);CHKERRQ(ierr); 567e5c89e4eSSatish Balay sub2[0] = 0; 56892eff512SVictor Minden value = va_arg(Argp,double); 5698884cb1fSJed Brown #if defined(PETSC_USE_SCALAR_SINGLE) 5708884cb1fSJed Brown if (PetscAbsReal(value) < 1.e-6) { 5718884cb1fSJed Brown ierr = PetscStrcat(nformat,"< 1.e-6");CHKERRQ(ierr); 5728884cb1fSJed Brown #else 573e5c89e4eSSatish Balay if (PetscAbsReal(value) < 1.e-12) { 574e5c89e4eSSatish Balay ierr = PetscStrcat(nformat,"< 1.e-12");CHKERRQ(ierr); 5758884cb1fSJed Brown #endif 576e5c89e4eSSatish Balay } else { 5778884cb1fSJed Brown ierr = PetscStrcat(nformat,"%G");CHKERRQ(ierr); 578e5c89e4eSSatish Balay va_end(Argp); 579e5c89e4eSSatish Balay va_start(Argp,format); 580e5c89e4eSSatish Balay } 581e5c89e4eSSatish Balay ierr = PetscStrcat(nformat,sub1+2);CHKERRQ(ierr); 582e5c89e4eSSatish Balay } else { 583e5c89e4eSSatish Balay nformat = (char*)format; 584e5c89e4eSSatish Balay } 5851179db26SBarry Smith ierr = (*PetscVFPrintf)(PETSC_STDOUT,nformat,Argp);CHKERRQ(ierr); 586e5c89e4eSSatish Balay if (petsc_history) { 587cdc7d174SSatish Balay va_start(Argp,format); 5881179db26SBarry Smith ierr = (*PetscVFPrintf)(petsc_history,nformat,Argp);CHKERRQ(ierr); 589e5c89e4eSSatish Balay } 590e5c89e4eSSatish Balay va_end(Argp); 591e5c89e4eSSatish Balay if (sub1) {ierr = PetscFree(nformat);CHKERRQ(ierr);} 592e5c89e4eSSatish Balay } 593e5c89e4eSSatish Balay PetscFunctionReturn(0); 594e5c89e4eSSatish Balay } 595e5c89e4eSSatish Balay 596e5c89e4eSSatish Balay /* ---------------------------------------------------------------------------------------*/ 597e5c89e4eSSatish Balay #undef __FUNCT__ 598e5c89e4eSSatish Balay #define __FUNCT__ "PetscHelpPrintfDefault" 599c9a19010SBarry Smith /*@C 600c9a19010SBarry Smith PetscHelpPrintf - All PETSc help messages are passing through this function. You can change how help messages are printed by 601c9a19010SBarry Smith replacinng it with something that does not simply write to a stdout. 602c9a19010SBarry Smith 603c9a19010SBarry Smith To use, write your own function for example, 604c9a19010SBarry Smith $PetscErrorCode mypetschelpprintf(MPI_Comm comm,const char format[],....) 605c9a19010SBarry Smith ${ 606c9a19010SBarry Smith $ PetscFunctionReturn(0); 607c9a19010SBarry Smith $} 608c9a19010SBarry Smith then before the call to PetscInitialize() do the assignment 609c9a19010SBarry Smith $ PetscHelpPrintf = mypetschelpprintf; 610c9a19010SBarry Smith 611c9a19010SBarry Smith Note: the default routine used is called PetscHelpPrintfDefault(). 612c9a19010SBarry Smith 613c9a19010SBarry Smith Level: developer 614c9a19010SBarry Smith 615c9a19010SBarry Smith .seealso: PetscVSNPrintf(), PetscVFPrintf(), PetscErrorPrintf() 616c9a19010SBarry Smith @*/ 6177087cfbeSBarry Smith PetscErrorCode PetscHelpPrintfDefault(MPI_Comm comm,const char format[],...) 618e5c89e4eSSatish Balay { 619e5c89e4eSSatish Balay PetscErrorCode ierr; 620e5c89e4eSSatish Balay PetscMPIInt rank; 621e5c89e4eSSatish Balay 622e5c89e4eSSatish Balay PetscFunctionBegin; 623e5c89e4eSSatish Balay if (!comm) comm = PETSC_COMM_WORLD; 624e5c89e4eSSatish Balay ierr = MPI_Comm_rank(comm,&rank);CHKERRQ(ierr); 625e5c89e4eSSatish Balay if (!rank) { 626e5c89e4eSSatish Balay va_list Argp; 627e5c89e4eSSatish Balay va_start(Argp,format); 6281179db26SBarry Smith ierr = (*PetscVFPrintf)(PETSC_STDOUT,format,Argp);CHKERRQ(ierr); 629e5c89e4eSSatish Balay if (petsc_history) { 630cdc7d174SSatish Balay va_start(Argp,format); 6311179db26SBarry Smith ierr = (*PetscVFPrintf)(petsc_history,format,Argp);CHKERRQ(ierr); 632e5c89e4eSSatish Balay } 633e5c89e4eSSatish Balay va_end(Argp); 634e5c89e4eSSatish Balay } 635e5c89e4eSSatish Balay PetscFunctionReturn(0); 636e5c89e4eSSatish Balay } 637e5c89e4eSSatish Balay 638e5c89e4eSSatish Balay /* ---------------------------------------------------------------------------------------*/ 639e5c89e4eSSatish Balay 640e5c89e4eSSatish Balay 641e5c89e4eSSatish Balay #undef __FUNCT__ 642e5c89e4eSSatish Balay #define __FUNCT__ "PetscSynchronizedFGets" 643e5c89e4eSSatish Balay /*@C 644e5c89e4eSSatish Balay PetscSynchronizedFGets - Several processors all get the same line from a file. 645e5c89e4eSSatish Balay 646e5c89e4eSSatish Balay Collective on MPI_Comm 647e5c89e4eSSatish Balay 648e5c89e4eSSatish Balay Input Parameters: 649e5c89e4eSSatish Balay + comm - the communicator 650e5c89e4eSSatish Balay . fd - the file pointer 651e5c89e4eSSatish Balay - len - the length of the output buffer 652e5c89e4eSSatish Balay 653e5c89e4eSSatish Balay Output Parameter: 654e5c89e4eSSatish Balay . string - the line read from the file 655e5c89e4eSSatish Balay 656e5c89e4eSSatish Balay Level: intermediate 657e5c89e4eSSatish Balay 658e5c89e4eSSatish Balay .seealso: PetscSynchronizedPrintf(), PetscSynchronizedFlush(), 659e5c89e4eSSatish Balay PetscFOpen(), PetscViewerASCIISynchronizedPrintf(), PetscViewerASCIIPrintf() 660e5c89e4eSSatish Balay 661e5c89e4eSSatish Balay @*/ 6627087cfbeSBarry Smith PetscErrorCode PetscSynchronizedFGets(MPI_Comm comm,FILE* fp,size_t len,char string[]) 663e5c89e4eSSatish Balay { 664e5c89e4eSSatish Balay PetscErrorCode ierr; 665e5c89e4eSSatish Balay PetscMPIInt rank; 666e5c89e4eSSatish Balay 667e5c89e4eSSatish Balay PetscFunctionBegin; 668e5c89e4eSSatish Balay ierr = MPI_Comm_rank(comm,&rank);CHKERRQ(ierr); 669e5c89e4eSSatish Balay 670e5c89e4eSSatish Balay if (!rank) { 671047b9c12SMatthew G Knepley char *ptr = fgets(string, len, fp); 672047b9c12SMatthew G Knepley 673047b9c12SMatthew G Knepley if (!ptr) { 674047b9c12SMatthew G Knepley if (feof(fp)) { 675047b9c12SMatthew G Knepley len = 0; 676047b9c12SMatthew G Knepley } else { 677047b9c12SMatthew G Knepley SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_FILE_READ, "Error reading from file: %d", errno); 678047b9c12SMatthew G Knepley } 679047b9c12SMatthew G Knepley } 680e5c89e4eSSatish Balay } 681e5c89e4eSSatish Balay ierr = MPI_Bcast(string,len,MPI_BYTE,0,comm);CHKERRQ(ierr); 682e5c89e4eSSatish Balay PetscFunctionReturn(0); 683e5c89e4eSSatish Balay } 684238ccf28SShri Abhyankar 685238ccf28SShri Abhyankar #if defined(PETSC_HAVE_MATLAB_ENGINE) 686c6db04a5SJed Brown #include <mex.h> 687238ccf28SShri Abhyankar #undef __FUNCT__ 688238ccf28SShri Abhyankar #define __FUNCT__ "PetscVFPrintf_Matlab" 6897087cfbeSBarry Smith PetscErrorCode PetscVFPrintf_Matlab(FILE *fd,const char format[],va_list Argp) 690238ccf28SShri Abhyankar { 691238ccf28SShri Abhyankar PetscErrorCode ierr; 692238ccf28SShri Abhyankar 693238ccf28SShri Abhyankar PetscFunctionBegin; 694238ccf28SShri Abhyankar if (fd != stdout && fd != stderr) { /* handle regular files */ 695238ccf28SShri Abhyankar ierr = PetscVFPrintfDefault(fd,format,Argp); CHKERRQ(ierr); 696238ccf28SShri Abhyankar } else { 697238ccf28SShri Abhyankar size_t len=8*1024,length; 698238ccf28SShri Abhyankar char buf[len]; 699238ccf28SShri Abhyankar 700238ccf28SShri Abhyankar ierr = PetscVSNPrintf(buf,len,format,&length,Argp);CHKERRQ(ierr); 701df413903SBarry Smith mexPrintf("%s",buf); 702238ccf28SShri Abhyankar } 703238ccf28SShri Abhyankar PetscFunctionReturn(0); 704238ccf28SShri Abhyankar } 705238ccf28SShri Abhyankar #endif 706