1e5c89e4eSSatish Balay /* 2e5c89e4eSSatish Balay Utilites routines to add simple ASCII IO capability. 3e5c89e4eSSatish Balay */ 4c6db04a5SJed Brown #include <../src/sys/fileio/mprint.h> 5e5c89e4eSSatish Balay /* 6e5c89e4eSSatish Balay If petsc_history is on, then all Petsc*Printf() results are saved 7e5c89e4eSSatish Balay if the appropriate (usually .petschistory) file. 8e5c89e4eSSatish Balay */ 9e5c89e4eSSatish Balay extern FILE *petsc_history; 10e5c89e4eSSatish Balay /* 11e5c89e4eSSatish Balay Allows one to overwrite where standard out is sent. For example 125106ddf5SBarry Smith PETSC_STDOUT = fopen("/dev/ttyXX","w") will cause all standard out 13e5c89e4eSSatish Balay writes to go to terminal XX; assuming you have write permission there 14e5c89e4eSSatish Balay */ 15e5c89e4eSSatish Balay FILE *PETSC_STDOUT = 0; 16ae9b4142SLisandro Dalcin /* 17ae9b4142SLisandro Dalcin Allows one to overwrite where standard error is sent. For example 18ae9b4142SLisandro Dalcin PETSC_STDERR = fopen("/dev/ttyXX","w") will cause all standard error 19ae9b4142SLisandro Dalcin writes to go to terminal XX; assuming you have write permission there 20ae9b4142SLisandro Dalcin */ 21ae9b4142SLisandro Dalcin FILE *PETSC_STDERR = 0; 22b13499bfSbcordonn /* 23b13499bfSbcordonn Used to output to Zope 24b13499bfSbcordonn */ 25b13499bfSbcordonn FILE *PETSC_ZOPEFD = 0; 26b13499bfSbcordonn 27e5c89e4eSSatish Balay #undef __FUNCT__ 28e5c89e4eSSatish Balay #define __FUNCT__ "PetscFormatConvert" 29c9a19010SBarry Smith /*@C 30c9a19010SBarry Smith PetscFormatConvert - Takes a PETSc format string and converts it to a reqular C format string 31c9a19010SBarry Smith 32c9a19010SBarry Smith Input Parameters: 33c9a19010SBarry Smith + format - the PETSc format string 34c9a19010SBarry Smith . newformat - the location to put the standard C format string values 35c9a19010SBarry Smith - size - the length of newformat 36c9a19010SBarry Smith 37c9a19010SBarry 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 38c9a19010SBarry Smith 39c9a19010SBarry Smith Level: developer 40c9a19010SBarry Smith 41c9a19010SBarry Smith @*/ 427087cfbeSBarry Smith PetscErrorCode PetscFormatConvert(const char *format,char *newformat,size_t size) 43e5c89e4eSSatish Balay { 44e5c89e4eSSatish Balay PetscInt i = 0,j = 0; 45e5c89e4eSSatish Balay 469daa610aSJed Brown while (format[i] && i < (PetscInt)size-1) { 47e5c89e4eSSatish Balay if (format[i] == '%' && format[i+1] == 'D') { 48e5c89e4eSSatish Balay newformat[j++] = '%'; 496de02169SBarry Smith #if !defined(PETSC_USE_64BIT_INDICES) 50e5c89e4eSSatish Balay newformat[j++] = 'd'; 51e5c89e4eSSatish Balay #else 52e5c89e4eSSatish Balay newformat[j++] = 'l'; 53e5c89e4eSSatish Balay newformat[j++] = 'l'; 54e5c89e4eSSatish Balay newformat[j++] = 'd'; 55e5c89e4eSSatish Balay #endif 56e5c89e4eSSatish Balay i += 2; 57e5c89e4eSSatish Balay } else if (format[i] == '%' && format[i+1] >= '1' && format[i+1] <= '9' && format[i+2] == 'D') { 58e5c89e4eSSatish Balay newformat[j++] = '%'; 59e5c89e4eSSatish Balay newformat[j++] = format[i+1]; 606de02169SBarry Smith #if !defined(PETSC_USE_64BIT_INDICES) 61e5c89e4eSSatish Balay newformat[j++] = 'd'; 62e5c89e4eSSatish Balay #else 63e5c89e4eSSatish Balay newformat[j++] = 'l'; 64e5c89e4eSSatish Balay newformat[j++] = 'l'; 65e5c89e4eSSatish Balay newformat[j++] = 'd'; 66e5c89e4eSSatish Balay #endif 67e5c89e4eSSatish Balay i += 3; 68a83599f4SBarry Smith } else if (format[i] == '%' && format[i+1] == 'G') { 69a83599f4SBarry Smith newformat[j++] = '%'; 70*ce63c4c1SBarry Smith #if defined(PETSC_USE_REAL_DOUBLE) || defined(PETSC_USE_REAL_SINGLE) 71a83599f4SBarry Smith newformat[j++] = 'g'; 72*ce63c4c1SBarry Smith #elif defined(PETSC_USE_REAL_LONG_DOUBLE) 73a83599f4SBarry Smith newformat[j++] = 'L'; 74a83599f4SBarry Smith newformat[j++] = 'g'; 75*ce63c4c1SBarry Smith #elif defined(PETSC_USE_REAL___FLOAT128) 76d9822059SBarry Smith newformat[j++] = 'Q'; 77d9822059SBarry Smith newformat[j++] = 'e'; 78a83599f4SBarry Smith #endif 79a83599f4SBarry Smith i += 2; 80e5c89e4eSSatish Balay }else { 81e5c89e4eSSatish Balay newformat[j++] = format[i++]; 82e5c89e4eSSatish Balay } 83e5c89e4eSSatish Balay } 84e5c89e4eSSatish Balay newformat[j] = 0; 85e5c89e4eSSatish Balay return 0; 86e5c89e4eSSatish Balay } 87e5c89e4eSSatish Balay 88e5c89e4eSSatish Balay #undef __FUNCT__ 89e5c89e4eSSatish Balay #define __FUNCT__ "PetscVSNPrintf" 90c9a19010SBarry Smith /*@C 91c9a19010SBarry Smith PetscVSNPrintf - The PETSc version of vsnprintf(). Converts a PETSc format string into a standard C format string and then puts all the 92c9a19010SBarry Smith function arguments into a string using the format statement. 93c9a19010SBarry Smith 94c9a19010SBarry Smith Input Parameters: 95c9a19010SBarry Smith + str - location to put result 96c9a19010SBarry Smith . len - the amount of space in str 97c9a19010SBarry Smith + format - the PETSc format string 98c9a19010SBarry Smith - fullLength - the amount of space in str actually used. 99c9a19010SBarry Smith 100c9a19010SBarry Smith Note: No error handling because may be called by error handler 101c9a19010SBarry Smith 102c9a19010SBarry Smith Level: developer 103c9a19010SBarry Smith 104c9a19010SBarry Smith @*/ 1057087cfbeSBarry Smith PetscErrorCode PetscVSNPrintf(char *str,size_t len,const char *format,size_t *fullLength,va_list Argp) 106e5c89e4eSSatish Balay { 107e5c89e4eSSatish Balay /* no malloc since may be called by error handler */ 108e2135aedSMatthew Knepley char *newformat; 109e2135aedSMatthew Knepley char formatbuf[8*1024]; 110e2135aedSMatthew Knepley size_t oldLength,length; 1111a15ef5dSMatthew Knepley PetscErrorCode ierr; 112e5c89e4eSSatish Balay 113e2135aedSMatthew Knepley ierr = PetscStrlen(format, &oldLength);CHKERRQ(ierr); 114e2135aedSMatthew Knepley if (oldLength < 8*1024) { 115e2135aedSMatthew Knepley newformat = formatbuf; 116e2135aedSMatthew Knepley } else { 117e2135aedSMatthew Knepley ierr = PetscMalloc((oldLength+1) * sizeof(char), &newformat);CHKERRQ(ierr); 118e2135aedSMatthew Knepley } 119e2135aedSMatthew Knepley PetscFormatConvert(format,newformat,oldLength+1); 1201a15ef5dSMatthew Knepley ierr = PetscStrlen(newformat, &length);CHKERRQ(ierr); 1212d609e63SMatthew Knepley #if 0 1221a15ef5dSMatthew Knepley if (length > len) { 1231a15ef5dSMatthew Knepley newformat[len] = '\0'; 1241a15ef5dSMatthew Knepley } 1252d609e63SMatthew Knepley #endif 1265a058713SBarry Smith #if defined(PETSC_HAVE_VSNPRINTF_CHAR) 1272d609e63SMatthew Knepley *fullLength = vsnprintf(str,len,newformat,(char *)Argp); 12889b07760SSatish Balay #elif defined(PETSC_HAVE_VSNPRINTF) 12989b07760SSatish Balay *fullLength = vsnprintf(str,len,newformat,Argp); 130141c0d65SSatish Balay #elif defined(PETSC_HAVE__VSNPRINTF) 131141c0d65SSatish Balay *fullLength = _vsnprintf(str,len,newformat,Argp); 132e5c89e4eSSatish Balay #else 13389b07760SSatish Balay #error "vsnprintf not found" 134e5c89e4eSSatish Balay #endif 135e2135aedSMatthew Knepley if (oldLength >= 8*1024) { 136e2135aedSMatthew Knepley ierr = PetscFree(newformat);CHKERRQ(ierr); 137e2135aedSMatthew Knepley } 138e5c89e4eSSatish Balay return 0; 139e5c89e4eSSatish Balay } 140e5c89e4eSSatish Balay 141e5c89e4eSSatish Balay #undef __FUNCT__ 1427ead4f01Sbcordonn #define __FUNCT__ "PetscZopeLog" 1437087cfbeSBarry Smith PetscErrorCode PetscZopeLog(const char *format,va_list Argp) 1449c4c166aSBarry Smith { 1457ead4f01Sbcordonn /* no malloc since may be called by error handler */ 1467ead4f01Sbcordonn char newformat[8*1024]; 1477ead4f01Sbcordonn char log[8*1024]; 1487ead4f01Sbcordonn char logstart[] = " <<<log>>>"; 149c9a19010SBarry Smith size_t len,formatlen; 1509c4c166aSBarry Smith 1517ead4f01Sbcordonn PetscFormatConvert(format,newformat,8*1024); 1527ead4f01Sbcordonn PetscStrlen(logstart, &len); 1537ead4f01Sbcordonn PetscMemcpy(log, logstart, len); 1547ead4f01Sbcordonn PetscStrlen(newformat, &formatlen); 1557ead4f01Sbcordonn PetscMemcpy(&(log[len]), newformat, formatlen); 1569c4c166aSBarry Smith if (PETSC_ZOPEFD){ 1575a058713SBarry Smith #if defined(PETSC_HAVE_VFPRINTF_CHAR) 1587ead4f01Sbcordonn vfprintf(PETSC_ZOPEFD,log,(char *)Argp); 1597ead4f01Sbcordonn #else 1607ead4f01Sbcordonn vfprintf(PETSC_ZOPEFD,log,Argp); 1617ead4f01Sbcordonn #endif 1625a058713SBarry Smith fflush(PETSC_ZOPEFD); 1637ead4f01Sbcordonn } 1647ead4f01Sbcordonn return 0; 1657ead4f01Sbcordonn } 1667ead4f01Sbcordonn 1677ead4f01Sbcordonn #undef __FUNCT__ 168c9a19010SBarry Smith #define __FUNCT__ "PetscVFPrintfDefault" 169c9a19010SBarry Smith /*@C 170c9a19010SBarry Smith PetscVFPrintf - All PETSc standard out and error messages are sent through this function; so, in theory, this can 171e5c89e4eSSatish Balay can be replaced with something that does not simply write to a file. 172e5c89e4eSSatish Balay 173c9a19010SBarry Smith To use, write your own function for example, 174c9a19010SBarry Smith $PetscErrorCode mypetscvfprintf(FILE *fd,const char format[],va_list Argp) 175c9a19010SBarry Smith ${ 176c9a19010SBarry Smith $ PetscErrorCode ierr; 177c9a19010SBarry Smith $ 178c9a19010SBarry Smith $ PetscFunctionBegin; 179c9a19010SBarry Smith $ if (fd != stdout && fd != stderr) { handle regular files 180c9a19010SBarry Smith $ ierr = PetscVFPrintfDefault(fd,format,Argp); CHKERR(ierr); 181c9a19010SBarry Smith $ } else { 182c9a19010SBarry Smith $ char buff[BIG]; 183c9a19010SBarry Smith $ size_t length; 184c9a19010SBarry Smith $ ierr = PetscVSNPrintf(buff,BIG,format,&length,Argp);CHKERRQ(ierr); 185c9a19010SBarry Smith $ now send buff to whatever stream or whatever you want 186c9a19010SBarry Smith $ } 187c9a19010SBarry Smith $ PetscFunctionReturn(0); 188c9a19010SBarry Smith $} 189c9a19010SBarry Smith then before the call to PetscInitialize() do the assignment 190c9a19010SBarry Smith $ PetscVFPrintf = mypetscvfprintf; 191c9a19010SBarry Smith 192c9a19010SBarry Smith Notes: For error messages this may be called by any process, for regular standard out it is 193e5c89e4eSSatish Balay called only by process 0 of a given communicator 194e5c89e4eSSatish Balay 195e5c89e4eSSatish Balay No error handling because may be called by error handler 196c9a19010SBarry Smith 197c9a19010SBarry Smith Level: developer 198c9a19010SBarry Smith 199c9a19010SBarry Smith .seealso: PetscVSNPrintf(), PetscErrorPrintf() 200c9a19010SBarry Smith 201c9a19010SBarry Smith @*/ 2027087cfbeSBarry Smith PetscErrorCode PetscVFPrintfDefault(FILE *fd,const char *format,va_list Argp) 203e5c89e4eSSatish Balay { 204e2135aedSMatthew Knepley /* no malloc since may be called by error handler (assume no long messages in errors) */ 205e2135aedSMatthew Knepley char *newformat; 206e2135aedSMatthew Knepley char formatbuf[8*1024]; 207e2135aedSMatthew Knepley size_t oldLength; 2081179db26SBarry Smith 209e2135aedSMatthew Knepley PetscStrlen(format, &oldLength); 210e2135aedSMatthew Knepley if (oldLength < 8*1024) { 211e2135aedSMatthew Knepley newformat = formatbuf; 212e2135aedSMatthew Knepley } else { 213fee1560eSJed Brown (void)PetscMalloc((oldLength+1) * sizeof(char), &newformat); 214e2135aedSMatthew Knepley } 215e2135aedSMatthew Knepley PetscFormatConvert(format,newformat,oldLength+1); 216d8c6e182Sbcordonn 2175a058713SBarry Smith #if defined(PETSC_HAVE_VFPRINTF_CHAR) 218e5c89e4eSSatish Balay vfprintf(fd,newformat,(char *)Argp); 219e5c89e4eSSatish Balay #else 220e5c89e4eSSatish Balay vfprintf(fd,newformat,Argp); 221e5c89e4eSSatish Balay #endif 2225a058713SBarry Smith fflush(fd); 223e2135aedSMatthew Knepley if (oldLength >= 8*1024) { 2249a2231e1SJed Brown (void)PetscFree(newformat); 225e2135aedSMatthew Knepley } 226e5c89e4eSSatish Balay return 0; 227e5c89e4eSSatish Balay } 228e5c89e4eSSatish Balay 2295b5bc046SBarry Smith #undef __FUNCT__ 2305b5bc046SBarry Smith #define __FUNCT__ "PetscSNPrintf" 2315b5bc046SBarry Smith /*@C 2325b5bc046SBarry Smith PetscSNPrintf - Prints to a string of given length 2335b5bc046SBarry Smith 2345b5bc046SBarry Smith Not Collective 2355b5bc046SBarry Smith 2365b5bc046SBarry Smith Input Parameters: 2375b5bc046SBarry Smith + str - the string to print to 2385b5bc046SBarry Smith . len - the length of str 2395b5bc046SBarry Smith . format - the usual printf() format string 2405b5bc046SBarry Smith - any arguments 2415b5bc046SBarry Smith 2425b5bc046SBarry Smith Level: intermediate 2435b5bc046SBarry Smith 2445b5bc046SBarry Smith .seealso: PetscSynchronizedFlush(), PetscSynchronizedFPrintf(), PetscFPrintf(), PetscVSNPrintf(), 2455b5bc046SBarry Smith PetscPrintf(), PetscViewerASCIIPrintf(), PetscViewerASCIISynchronizedPrintf() 2465b5bc046SBarry Smith @*/ 2477087cfbeSBarry Smith PetscErrorCode PetscSNPrintf(char *str,size_t len,const char format[],...) 2485b5bc046SBarry Smith { 2495b5bc046SBarry Smith PetscErrorCode ierr; 250c9a19010SBarry Smith size_t fullLength; 2515b5bc046SBarry Smith va_list Argp; 2525b5bc046SBarry Smith 2535b5bc046SBarry Smith PetscFunctionBegin; 2545b5bc046SBarry Smith va_start(Argp,format); 2552d609e63SMatthew Knepley ierr = PetscVSNPrintf(str,len,format,&fullLength,Argp);CHKERRQ(ierr); 2565b5bc046SBarry Smith PetscFunctionReturn(0); 2575b5bc046SBarry Smith } 2585b5bc046SBarry Smith 259e5c89e4eSSatish Balay /* ----------------------------------------------------------------------- */ 260e5c89e4eSSatish Balay 261e5c89e4eSSatish Balay PrintfQueue queue = 0,queuebase = 0; 262e5c89e4eSSatish Balay int queuelength = 0; 263e5c89e4eSSatish Balay FILE *queuefile = PETSC_NULL; 264e5c89e4eSSatish Balay 265e5c89e4eSSatish Balay #undef __FUNCT__ 266e5c89e4eSSatish Balay #define __FUNCT__ "PetscSynchronizedPrintf" 267e5c89e4eSSatish Balay /*@C 268e5c89e4eSSatish Balay PetscSynchronizedPrintf - Prints synchronized output from several processors. 269e5c89e4eSSatish Balay Output of the first processor is followed by that of the second, etc. 270e5c89e4eSSatish Balay 271e5c89e4eSSatish Balay Not Collective 272e5c89e4eSSatish Balay 273e5c89e4eSSatish Balay Input Parameters: 274e5c89e4eSSatish Balay + comm - the communicator 275e5c89e4eSSatish Balay - format - the usual printf() format string 276e5c89e4eSSatish Balay 277e5c89e4eSSatish Balay Level: intermediate 278e5c89e4eSSatish Balay 279e5c89e4eSSatish Balay Notes: 280e5c89e4eSSatish Balay REQUIRES a intervening call to PetscSynchronizedFlush() for the information 281e5c89e4eSSatish Balay from all the processors to be printed. 282e5c89e4eSSatish Balay 283e5c89e4eSSatish Balay Fortran Note: 284d60d70ccSBarry Smith The call sequence is PetscSynchronizedPrintf(MPI_Comm, character(*), PetscErrorCode ierr) from Fortran. 285e5c89e4eSSatish Balay That is, you can only pass a single character string from Fortran. 286e5c89e4eSSatish Balay 287e5c89e4eSSatish Balay .seealso: PetscSynchronizedFlush(), PetscSynchronizedFPrintf(), PetscFPrintf(), 288e5c89e4eSSatish Balay PetscPrintf(), PetscViewerASCIIPrintf(), PetscViewerASCIISynchronizedPrintf() 289e5c89e4eSSatish Balay @*/ 2907087cfbeSBarry Smith PetscErrorCode PetscSynchronizedPrintf(MPI_Comm comm,const char format[],...) 291e5c89e4eSSatish Balay { 292e5c89e4eSSatish Balay PetscErrorCode ierr; 293e5c89e4eSSatish Balay PetscMPIInt rank; 294e5c89e4eSSatish Balay 295e5c89e4eSSatish Balay PetscFunctionBegin; 296e5c89e4eSSatish Balay ierr = MPI_Comm_rank(comm,&rank);CHKERRQ(ierr); 297e5c89e4eSSatish Balay 298e5c89e4eSSatish Balay /* First processor prints immediately to stdout */ 299e5c89e4eSSatish Balay if (!rank) { 300e5c89e4eSSatish Balay va_list Argp; 301e5c89e4eSSatish Balay va_start(Argp,format); 3021179db26SBarry Smith ierr = (*PetscVFPrintf)(PETSC_STDOUT,format,Argp);CHKERRQ(ierr); 303e5c89e4eSSatish Balay if (petsc_history) { 304cdc7d174SSatish Balay va_start(Argp,format); 3051179db26SBarry Smith ierr = (*PetscVFPrintf)(petsc_history,format,Argp);CHKERRQ(ierr); 306e5c89e4eSSatish Balay } 307e5c89e4eSSatish Balay va_end(Argp); 308e5c89e4eSSatish Balay } else { /* other processors add to local queue */ 309e5c89e4eSSatish Balay va_list Argp; 310e5c89e4eSSatish Balay PrintfQueue next; 311c9a19010SBarry Smith size_t fullLength = 8191; 312e5c89e4eSSatish Balay 313e5c89e4eSSatish Balay ierr = PetscNew(struct _PrintfQueue,&next);CHKERRQ(ierr); 314e5c89e4eSSatish Balay if (queue) {queue->next = next; queue = next; queue->next = 0;} 315e5c89e4eSSatish Balay else {queuebase = queue = next;} 316e5c89e4eSSatish Balay queuelength++; 3172d609e63SMatthew Knepley next->size = -1; 3189ad23270SJed Brown while((PetscInt)fullLength >= next->size) { 3192d609e63SMatthew Knepley next->size = fullLength+1; 3202d609e63SMatthew Knepley ierr = PetscMalloc(next->size * sizeof(char), &next->string);CHKERRQ(ierr); 321e5c89e4eSSatish Balay va_start(Argp,format); 3222d609e63SMatthew Knepley ierr = PetscMemzero(next->string,next->size);CHKERRQ(ierr); 3232d609e63SMatthew Knepley ierr = PetscVSNPrintf(next->string,next->size,format, &fullLength,Argp);CHKERRQ(ierr); 324e5c89e4eSSatish Balay va_end(Argp); 325e5c89e4eSSatish Balay } 3262d609e63SMatthew Knepley } 327e5c89e4eSSatish Balay 328e5c89e4eSSatish Balay PetscFunctionReturn(0); 329e5c89e4eSSatish Balay } 330e5c89e4eSSatish Balay 331e5c89e4eSSatish Balay #undef __FUNCT__ 332e5c89e4eSSatish Balay #define __FUNCT__ "PetscSynchronizedFPrintf" 333e5c89e4eSSatish Balay /*@C 334e5c89e4eSSatish Balay PetscSynchronizedFPrintf - Prints synchronized output to the specified file from 335e5c89e4eSSatish Balay several processors. Output of the first processor is followed by that of the 336e5c89e4eSSatish Balay second, etc. 337e5c89e4eSSatish Balay 338e5c89e4eSSatish Balay Not Collective 339e5c89e4eSSatish Balay 340e5c89e4eSSatish Balay Input Parameters: 341e5c89e4eSSatish Balay + comm - the communicator 342e5c89e4eSSatish Balay . fd - the file pointer 343e5c89e4eSSatish Balay - format - the usual printf() format string 344e5c89e4eSSatish Balay 345e5c89e4eSSatish Balay Level: intermediate 346e5c89e4eSSatish Balay 347e5c89e4eSSatish Balay Notes: 348e5c89e4eSSatish Balay REQUIRES a intervening call to PetscSynchronizedFlush() for the information 349e5c89e4eSSatish Balay from all the processors to be printed. 350e5c89e4eSSatish Balay 351e5c89e4eSSatish Balay .seealso: PetscSynchronizedPrintf(), PetscSynchronizedFlush(), PetscFPrintf(), 352e5c89e4eSSatish Balay PetscFOpen(), PetscViewerASCIISynchronizedPrintf(), PetscViewerASCIIPrintf() 353e5c89e4eSSatish Balay 354e5c89e4eSSatish Balay @*/ 3557087cfbeSBarry Smith PetscErrorCode PetscSynchronizedFPrintf(MPI_Comm comm,FILE* fp,const char format[],...) 356e5c89e4eSSatish Balay { 357e5c89e4eSSatish Balay PetscErrorCode ierr; 358e5c89e4eSSatish Balay PetscMPIInt rank; 359e5c89e4eSSatish Balay 360e5c89e4eSSatish Balay PetscFunctionBegin; 361e5c89e4eSSatish Balay ierr = MPI_Comm_rank(comm,&rank);CHKERRQ(ierr); 362e5c89e4eSSatish Balay 363e5c89e4eSSatish Balay /* First processor prints immediately to fp */ 364e5c89e4eSSatish Balay if (!rank) { 365e5c89e4eSSatish Balay va_list Argp; 366e5c89e4eSSatish Balay va_start(Argp,format); 3671179db26SBarry Smith ierr = (*PetscVFPrintf)(fp,format,Argp);CHKERRQ(ierr); 368e5c89e4eSSatish Balay queuefile = fp; 369cdc7d174SSatish Balay if (petsc_history && (fp !=petsc_history)) { 370cdc7d174SSatish Balay va_start(Argp,format); 3711179db26SBarry Smith ierr = (*PetscVFPrintf)(petsc_history,format,Argp);CHKERRQ(ierr); 372e5c89e4eSSatish Balay } 373e5c89e4eSSatish Balay va_end(Argp); 374e5c89e4eSSatish Balay } else { /* other processors add to local queue */ 375e5c89e4eSSatish Balay va_list Argp; 376e5c89e4eSSatish Balay PrintfQueue next; 377c9a19010SBarry Smith size_t fullLength = 8191; 378e5c89e4eSSatish Balay ierr = PetscNew(struct _PrintfQueue,&next);CHKERRQ(ierr); 379e5c89e4eSSatish Balay if (queue) {queue->next = next; queue = next; queue->next = 0;} 380e5c89e4eSSatish Balay else {queuebase = queue = next;} 381e5c89e4eSSatish Balay queuelength++; 3822d609e63SMatthew Knepley next->size = -1; 3839ad23270SJed Brown while((PetscInt)fullLength >= next->size) { 3842d609e63SMatthew Knepley next->size = fullLength+1; 3852d609e63SMatthew Knepley ierr = PetscMalloc(next->size * sizeof(char), &next->string);CHKERRQ(ierr); 386e5c89e4eSSatish Balay va_start(Argp,format); 3872d609e63SMatthew Knepley ierr = PetscMemzero(next->string,next->size);CHKERRQ(ierr); 3882d609e63SMatthew Knepley ierr = PetscVSNPrintf(next->string,next->size,format,&fullLength,Argp);CHKERRQ(ierr); 389e5c89e4eSSatish Balay va_end(Argp); 390e5c89e4eSSatish Balay } 3912d609e63SMatthew Knepley } 392e5c89e4eSSatish Balay PetscFunctionReturn(0); 393e5c89e4eSSatish Balay } 394e5c89e4eSSatish Balay 395e5c89e4eSSatish Balay #undef __FUNCT__ 396e5c89e4eSSatish Balay #define __FUNCT__ "PetscSynchronizedFlush" 397e30d2299SSatish Balay /*@ 398e5c89e4eSSatish Balay PetscSynchronizedFlush - Flushes to the screen output from all processors 399e5c89e4eSSatish Balay involved in previous PetscSynchronizedPrintf() calls. 400e5c89e4eSSatish Balay 401e5c89e4eSSatish Balay Collective on MPI_Comm 402e5c89e4eSSatish Balay 403e5c89e4eSSatish Balay Input Parameters: 404e5c89e4eSSatish Balay . comm - the communicator 405e5c89e4eSSatish Balay 406e5c89e4eSSatish Balay Level: intermediate 407e5c89e4eSSatish Balay 408e5c89e4eSSatish Balay Notes: 409e5c89e4eSSatish Balay Usage of PetscSynchronizedPrintf() and PetscSynchronizedFPrintf() with 410e5c89e4eSSatish Balay different MPI communicators REQUIRES an intervening call to PetscSynchronizedFlush(). 411e5c89e4eSSatish Balay 412e5c89e4eSSatish Balay .seealso: PetscSynchronizedPrintf(), PetscFPrintf(), PetscPrintf(), PetscViewerASCIIPrintf(), 413e5c89e4eSSatish Balay PetscViewerASCIISynchronizedPrintf() 414e5c89e4eSSatish Balay @*/ 4157087cfbeSBarry Smith PetscErrorCode PetscSynchronizedFlush(MPI_Comm comm) 416e5c89e4eSSatish Balay { 417e5c89e4eSSatish Balay PetscErrorCode ierr; 418bf3b0749SBarry Smith PetscMPIInt rank,size,tag,i,j,n,dummy = 0; 4192d609e63SMatthew Knepley char *message; 420e5c89e4eSSatish Balay MPI_Status status; 421e5c89e4eSSatish Balay FILE *fd; 422e5c89e4eSSatish Balay 423e5c89e4eSSatish Balay PetscFunctionBegin; 424e5c89e4eSSatish Balay ierr = PetscCommDuplicate(comm,&comm,&tag);CHKERRQ(ierr); 425e5c89e4eSSatish Balay ierr = MPI_Comm_rank(comm,&rank);CHKERRQ(ierr); 426e5c89e4eSSatish Balay ierr = MPI_Comm_size(comm,&size);CHKERRQ(ierr); 427e5c89e4eSSatish Balay 428e5c89e4eSSatish Balay /* First processor waits for messages from all other processors */ 429e5c89e4eSSatish Balay if (!rank) { 430e5c89e4eSSatish Balay if (queuefile) { 431e5c89e4eSSatish Balay fd = queuefile; 432e5c89e4eSSatish Balay } else { 433e5c89e4eSSatish Balay fd = PETSC_STDOUT; 434e5c89e4eSSatish Balay } 435e5c89e4eSSatish Balay for (i=1; i<size; i++) { 4369f73f8ecSBarry Smith /* to prevent a flood of messages to process zero, request each message separately */ 4379f73f8ecSBarry Smith ierr = MPI_Send(&dummy,1,MPI_INT,i,tag,comm);CHKERRQ(ierr); 438e5c89e4eSSatish Balay ierr = MPI_Recv(&n,1,MPI_INT,i,tag,comm,&status);CHKERRQ(ierr); 439e5c89e4eSSatish Balay for (j=0; j<n; j++) { 4409f73f8ecSBarry Smith PetscMPIInt size; 4412d609e63SMatthew Knepley 4422d609e63SMatthew Knepley ierr = MPI_Recv(&size,1,MPI_INT,i,tag,comm,&status);CHKERRQ(ierr); 4432d609e63SMatthew Knepley ierr = PetscMalloc(size * sizeof(char), &message);CHKERRQ(ierr); 4442d609e63SMatthew Knepley ierr = MPI_Recv(message,size,MPI_CHAR,i,tag,comm,&status);CHKERRQ(ierr); 445e5c89e4eSSatish Balay ierr = PetscFPrintf(comm,fd,"%s",message); 4462d609e63SMatthew Knepley ierr = PetscFree(message);CHKERRQ(ierr); 447e5c89e4eSSatish Balay } 448e5c89e4eSSatish Balay } 449e5c89e4eSSatish Balay queuefile = PETSC_NULL; 450e5c89e4eSSatish Balay } else { /* other processors send queue to processor 0 */ 451e5c89e4eSSatish Balay PrintfQueue next = queuebase,previous; 452e5c89e4eSSatish Balay 453b3ef9d35SBarry Smith ierr = MPI_Recv(&dummy,1,MPI_INT,0,tag,comm,&status);CHKERRQ(ierr); 454e5c89e4eSSatish Balay ierr = MPI_Send(&queuelength,1,MPI_INT,0,tag,comm);CHKERRQ(ierr); 455e5c89e4eSSatish Balay for (i=0; i<queuelength; i++) { 4562d609e63SMatthew Knepley ierr = MPI_Send(&next->size,1,MPI_INT,0,tag,comm);CHKERRQ(ierr); 4572d609e63SMatthew Knepley ierr = MPI_Send(next->string,next->size,MPI_CHAR,0,tag,comm);CHKERRQ(ierr); 458e5c89e4eSSatish Balay previous = next; 459e5c89e4eSSatish Balay next = next->next; 4602d609e63SMatthew Knepley ierr = PetscFree(previous->string);CHKERRQ(ierr); 461e5c89e4eSSatish Balay ierr = PetscFree(previous);CHKERRQ(ierr); 462e5c89e4eSSatish Balay } 463e5c89e4eSSatish Balay queue = 0; 464e5c89e4eSSatish Balay queuelength = 0; 465e5c89e4eSSatish Balay } 466e5c89e4eSSatish Balay ierr = PetscCommDestroy(&comm);CHKERRQ(ierr); 467e5c89e4eSSatish Balay PetscFunctionReturn(0); 468e5c89e4eSSatish Balay } 469e5c89e4eSSatish Balay 470e5c89e4eSSatish Balay /* ---------------------------------------------------------------------------------------*/ 471e5c89e4eSSatish Balay 472e5c89e4eSSatish Balay #undef __FUNCT__ 473e5c89e4eSSatish Balay #define __FUNCT__ "PetscFPrintf" 474e5c89e4eSSatish Balay /*@C 475e5c89e4eSSatish Balay PetscFPrintf - Prints to a file, only from the first 476e5c89e4eSSatish Balay processor in the communicator. 477e5c89e4eSSatish Balay 478e5c89e4eSSatish Balay Not Collective 479e5c89e4eSSatish Balay 480e5c89e4eSSatish Balay Input Parameters: 481e5c89e4eSSatish Balay + comm - the communicator 482e5c89e4eSSatish Balay . fd - the file pointer 483e5c89e4eSSatish Balay - format - the usual printf() format string 484e5c89e4eSSatish Balay 485e5c89e4eSSatish Balay Level: intermediate 486e5c89e4eSSatish Balay 487e5c89e4eSSatish Balay Fortran Note: 488e5c89e4eSSatish Balay This routine is not supported in Fortran. 489e5c89e4eSSatish Balay 490e5c89e4eSSatish Balay Concepts: printing^in parallel 491e5c89e4eSSatish Balay Concepts: printf^in parallel 492e5c89e4eSSatish Balay 493e5c89e4eSSatish Balay .seealso: PetscPrintf(), PetscSynchronizedPrintf(), PetscViewerASCIIPrintf(), 494e5c89e4eSSatish Balay PetscViewerASCIISynchronizedPrintf(), PetscSynchronizedFlush() 495e5c89e4eSSatish Balay @*/ 4967087cfbeSBarry Smith PetscErrorCode PetscFPrintf(MPI_Comm comm,FILE* fd,const char format[],...) 497e5c89e4eSSatish Balay { 498e5c89e4eSSatish Balay PetscErrorCode ierr; 499e5c89e4eSSatish Balay PetscMPIInt rank; 500e5c89e4eSSatish Balay 501e5c89e4eSSatish Balay PetscFunctionBegin; 502e5c89e4eSSatish Balay ierr = MPI_Comm_rank(comm,&rank);CHKERRQ(ierr); 503e5c89e4eSSatish Balay if (!rank) { 504e5c89e4eSSatish Balay va_list Argp; 505e5c89e4eSSatish Balay va_start(Argp,format); 5061179db26SBarry Smith ierr = (*PetscVFPrintf)(fd,format,Argp);CHKERRQ(ierr); 507cdc7d174SSatish Balay if (petsc_history && (fd !=petsc_history)) { 508cdc7d174SSatish Balay va_start(Argp,format); 5091179db26SBarry Smith ierr = (*PetscVFPrintf)(petsc_history,format,Argp);CHKERRQ(ierr); 510e5c89e4eSSatish Balay } 511e5c89e4eSSatish Balay va_end(Argp); 512e5c89e4eSSatish Balay } 513e5c89e4eSSatish Balay PetscFunctionReturn(0); 514e5c89e4eSSatish Balay } 515e5c89e4eSSatish Balay 516e5c89e4eSSatish Balay #undef __FUNCT__ 517e5c89e4eSSatish Balay #define __FUNCT__ "PetscPrintf" 518e5c89e4eSSatish Balay /*@C 519e5c89e4eSSatish Balay PetscPrintf - Prints to standard out, only from the first 520e5c89e4eSSatish Balay processor in the communicator. 521e5c89e4eSSatish Balay 522e5c89e4eSSatish Balay Not Collective 523e5c89e4eSSatish Balay 524e5c89e4eSSatish Balay Input Parameters: 525e5c89e4eSSatish Balay + comm - the communicator 526e5c89e4eSSatish Balay - format - the usual printf() format string 527e5c89e4eSSatish Balay 528e5c89e4eSSatish Balay Level: intermediate 529e5c89e4eSSatish Balay 530e5c89e4eSSatish Balay Fortran Note: 531d60d70ccSBarry Smith The call sequence is PetscPrintf(MPI_Comm, character(*), PetscErrorCode ierr) from Fortran. 532e5c89e4eSSatish Balay That is, you can only pass a single character string from Fortran. 533e5c89e4eSSatish Balay 5348884cb1fSJed Brown Notes: The %A format specifier is special. It assumes an argument of type PetscReal 5358884cb1fSJed Brown and is replaced with %G unless the absolute value is < 1.e-12 when it is replaced 5368884cb1fSJed Brown with "< 1.e-12" (1.e-6 for single precision). 537e5c89e4eSSatish Balay 538e5c89e4eSSatish Balay Concepts: printing^in parallel 539e5c89e4eSSatish Balay Concepts: printf^in parallel 540e5c89e4eSSatish Balay 541e5c89e4eSSatish Balay .seealso: PetscFPrintf(), PetscSynchronizedPrintf() 542e5c89e4eSSatish Balay @*/ 5437087cfbeSBarry Smith PetscErrorCode PetscPrintf(MPI_Comm comm,const char format[],...) 544e5c89e4eSSatish Balay { 545e5c89e4eSSatish Balay PetscErrorCode ierr; 546e5c89e4eSSatish Balay PetscMPIInt rank; 547e5c89e4eSSatish Balay size_t len; 548e5c89e4eSSatish Balay char *nformat,*sub1,*sub2; 549e5c89e4eSSatish Balay PetscReal value; 550e5c89e4eSSatish Balay 551e5c89e4eSSatish Balay PetscFunctionBegin; 552e5c89e4eSSatish Balay if (!comm) comm = PETSC_COMM_WORLD; 553e5c89e4eSSatish Balay ierr = MPI_Comm_rank(comm,&rank);CHKERRQ(ierr); 554e5c89e4eSSatish Balay if (!rank) { 555e5c89e4eSSatish Balay va_list Argp; 556e5c89e4eSSatish Balay va_start(Argp,format); 557e5c89e4eSSatish Balay 558e5c89e4eSSatish Balay ierr = PetscStrstr(format,"%A",&sub1);CHKERRQ(ierr); 559e5c89e4eSSatish Balay if (sub1) { 560e5c89e4eSSatish Balay ierr = PetscStrstr(format,"%",&sub2);CHKERRQ(ierr); 561e32f2f54SBarry Smith if (sub1 != sub2) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"%%A format must be first in format string"); 562e5c89e4eSSatish Balay ierr = PetscStrlen(format,&len);CHKERRQ(ierr); 563e5c89e4eSSatish Balay ierr = PetscMalloc((len+16)*sizeof(char),&nformat);CHKERRQ(ierr); 564e5c89e4eSSatish Balay ierr = PetscStrcpy(nformat,format);CHKERRQ(ierr); 565e5c89e4eSSatish Balay ierr = PetscStrstr(nformat,"%",&sub2);CHKERRQ(ierr); 566e5c89e4eSSatish Balay sub2[0] = 0; 56792eff512SVictor Minden value = va_arg(Argp,double); 568*ce63c4c1SBarry Smith #if defined(PETSC_USE_REAL_SINGLE) 5698884cb1fSJed Brown if (PetscAbsReal(value) < 1.e-6) { 5708884cb1fSJed Brown ierr = PetscStrcat(nformat,"< 1.e-6");CHKERRQ(ierr); 5718884cb1fSJed Brown #else 572e5c89e4eSSatish Balay if (PetscAbsReal(value) < 1.e-12) { 573e5c89e4eSSatish Balay ierr = PetscStrcat(nformat,"< 1.e-12");CHKERRQ(ierr); 5748884cb1fSJed Brown #endif 575e5c89e4eSSatish Balay } else { 5768884cb1fSJed Brown ierr = PetscStrcat(nformat,"%G");CHKERRQ(ierr); 577e5c89e4eSSatish Balay va_end(Argp); 578e5c89e4eSSatish Balay va_start(Argp,format); 579e5c89e4eSSatish Balay } 580e5c89e4eSSatish Balay ierr = PetscStrcat(nformat,sub1+2);CHKERRQ(ierr); 581e5c89e4eSSatish Balay } else { 582e5c89e4eSSatish Balay nformat = (char*)format; 583e5c89e4eSSatish Balay } 5841179db26SBarry Smith ierr = (*PetscVFPrintf)(PETSC_STDOUT,nformat,Argp);CHKERRQ(ierr); 585e5c89e4eSSatish Balay if (petsc_history) { 586cdc7d174SSatish Balay va_start(Argp,format); 5871179db26SBarry Smith ierr = (*PetscVFPrintf)(petsc_history,nformat,Argp);CHKERRQ(ierr); 588e5c89e4eSSatish Balay } 589e5c89e4eSSatish Balay va_end(Argp); 590e5c89e4eSSatish Balay if (sub1) {ierr = PetscFree(nformat);CHKERRQ(ierr);} 591e5c89e4eSSatish Balay } 592e5c89e4eSSatish Balay PetscFunctionReturn(0); 593e5c89e4eSSatish Balay } 594e5c89e4eSSatish Balay 595e5c89e4eSSatish Balay /* ---------------------------------------------------------------------------------------*/ 596e5c89e4eSSatish Balay #undef __FUNCT__ 597e5c89e4eSSatish Balay #define __FUNCT__ "PetscHelpPrintfDefault" 598c9a19010SBarry Smith /*@C 599c9a19010SBarry Smith PetscHelpPrintf - All PETSc help messages are passing through this function. You can change how help messages are printed by 600c9a19010SBarry Smith replacinng it with something that does not simply write to a stdout. 601c9a19010SBarry Smith 602c9a19010SBarry Smith To use, write your own function for example, 603c9a19010SBarry Smith $PetscErrorCode mypetschelpprintf(MPI_Comm comm,const char format[],....) 604c9a19010SBarry Smith ${ 605c9a19010SBarry Smith $ PetscFunctionReturn(0); 606c9a19010SBarry Smith $} 607c9a19010SBarry Smith then before the call to PetscInitialize() do the assignment 608c9a19010SBarry Smith $ PetscHelpPrintf = mypetschelpprintf; 609c9a19010SBarry Smith 610c9a19010SBarry Smith Note: the default routine used is called PetscHelpPrintfDefault(). 611c9a19010SBarry Smith 612c9a19010SBarry Smith Level: developer 613c9a19010SBarry Smith 614c9a19010SBarry Smith .seealso: PetscVSNPrintf(), PetscVFPrintf(), PetscErrorPrintf() 615c9a19010SBarry Smith @*/ 6167087cfbeSBarry Smith PetscErrorCode PetscHelpPrintfDefault(MPI_Comm comm,const char format[],...) 617e5c89e4eSSatish Balay { 618e5c89e4eSSatish Balay PetscErrorCode ierr; 619e5c89e4eSSatish Balay PetscMPIInt rank; 620e5c89e4eSSatish Balay 621e5c89e4eSSatish Balay PetscFunctionBegin; 622e5c89e4eSSatish Balay if (!comm) comm = PETSC_COMM_WORLD; 623e5c89e4eSSatish Balay ierr = MPI_Comm_rank(comm,&rank);CHKERRQ(ierr); 624e5c89e4eSSatish Balay if (!rank) { 625e5c89e4eSSatish Balay va_list Argp; 626e5c89e4eSSatish Balay va_start(Argp,format); 6271179db26SBarry Smith ierr = (*PetscVFPrintf)(PETSC_STDOUT,format,Argp);CHKERRQ(ierr); 628e5c89e4eSSatish Balay if (petsc_history) { 629cdc7d174SSatish Balay va_start(Argp,format); 6301179db26SBarry Smith ierr = (*PetscVFPrintf)(petsc_history,format,Argp);CHKERRQ(ierr); 631e5c89e4eSSatish Balay } 632e5c89e4eSSatish Balay va_end(Argp); 633e5c89e4eSSatish Balay } 634e5c89e4eSSatish Balay PetscFunctionReturn(0); 635e5c89e4eSSatish Balay } 636e5c89e4eSSatish Balay 637e5c89e4eSSatish Balay /* ---------------------------------------------------------------------------------------*/ 638e5c89e4eSSatish Balay 639e5c89e4eSSatish Balay 640e5c89e4eSSatish Balay #undef __FUNCT__ 641e5c89e4eSSatish Balay #define __FUNCT__ "PetscSynchronizedFGets" 642e5c89e4eSSatish Balay /*@C 643e5c89e4eSSatish Balay PetscSynchronizedFGets - Several processors all get the same line from a file. 644e5c89e4eSSatish Balay 645e5c89e4eSSatish Balay Collective on MPI_Comm 646e5c89e4eSSatish Balay 647e5c89e4eSSatish Balay Input Parameters: 648e5c89e4eSSatish Balay + comm - the communicator 649e5c89e4eSSatish Balay . fd - the file pointer 650e5c89e4eSSatish Balay - len - the length of the output buffer 651e5c89e4eSSatish Balay 652e5c89e4eSSatish Balay Output Parameter: 653e5c89e4eSSatish Balay . string - the line read from the file 654e5c89e4eSSatish Balay 655e5c89e4eSSatish Balay Level: intermediate 656e5c89e4eSSatish Balay 657e5c89e4eSSatish Balay .seealso: PetscSynchronizedPrintf(), PetscSynchronizedFlush(), 658e5c89e4eSSatish Balay PetscFOpen(), PetscViewerASCIISynchronizedPrintf(), PetscViewerASCIIPrintf() 659e5c89e4eSSatish Balay 660e5c89e4eSSatish Balay @*/ 6617087cfbeSBarry Smith PetscErrorCode PetscSynchronizedFGets(MPI_Comm comm,FILE* fp,size_t len,char string[]) 662e5c89e4eSSatish Balay { 663e5c89e4eSSatish Balay PetscErrorCode ierr; 664e5c89e4eSSatish Balay PetscMPIInt rank; 665e5c89e4eSSatish Balay 666e5c89e4eSSatish Balay PetscFunctionBegin; 667e5c89e4eSSatish Balay ierr = MPI_Comm_rank(comm,&rank);CHKERRQ(ierr); 668e5c89e4eSSatish Balay 669e5c89e4eSSatish Balay if (!rank) { 67018d3aa3fSBarry Smith (void) fgets(string,len,fp); /* Not very useful error behavior, but what is desired behavior for attempt to read at EOF? */ 671e5c89e4eSSatish Balay } 672e5c89e4eSSatish Balay ierr = MPI_Bcast(string,len,MPI_BYTE,0,comm);CHKERRQ(ierr); 673e5c89e4eSSatish Balay PetscFunctionReturn(0); 674e5c89e4eSSatish Balay } 675238ccf28SShri Abhyankar 676238ccf28SShri Abhyankar #if defined(PETSC_HAVE_MATLAB_ENGINE) 677c6db04a5SJed Brown #include <mex.h> 678238ccf28SShri Abhyankar #undef __FUNCT__ 679238ccf28SShri Abhyankar #define __FUNCT__ "PetscVFPrintf_Matlab" 6807087cfbeSBarry Smith PetscErrorCode PetscVFPrintf_Matlab(FILE *fd,const char format[],va_list Argp) 681238ccf28SShri Abhyankar { 682238ccf28SShri Abhyankar PetscErrorCode ierr; 683238ccf28SShri Abhyankar 684238ccf28SShri Abhyankar PetscFunctionBegin; 685238ccf28SShri Abhyankar if (fd != stdout && fd != stderr) { /* handle regular files */ 686238ccf28SShri Abhyankar ierr = PetscVFPrintfDefault(fd,format,Argp); CHKERRQ(ierr); 687238ccf28SShri Abhyankar } else { 688238ccf28SShri Abhyankar size_t len=8*1024,length; 689238ccf28SShri Abhyankar char buf[len]; 690238ccf28SShri Abhyankar 691238ccf28SShri Abhyankar ierr = PetscVSNPrintf(buf,len,format,&length,Argp);CHKERRQ(ierr); 692df413903SBarry Smith mexPrintf("%s",buf); 693238ccf28SShri Abhyankar } 694238ccf28SShri Abhyankar PetscFunctionReturn(0); 695238ccf28SShri Abhyankar } 696238ccf28SShri Abhyankar #endif 697