xref: /petsc/src/sys/fileio/mprint.c (revision 354e5084327dddaa65e4f3dd3c556dc64b5a8b60)
1e5c89e4eSSatish Balay /*
2e5c89e4eSSatish Balay       Utilites routines to add simple ASCII IO capability.
3e5c89e4eSSatish Balay */
4c6db04a5SJed Brown #include <../src/sys/fileio/mprint.h>
579c0e996SJed 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 
28*354e5084SJose Roman /*
29*354e5084SJose Roman      Return the maximum expected new size of the format
30*354e5084SJose Roman */
31*354e5084SJose Roman #define PETSC_MAX_LENGTH_FORMAT(l) (l+l/8)
32*354e5084SJose Roman 
33e5c89e4eSSatish Balay #undef __FUNCT__
34e5c89e4eSSatish Balay #define __FUNCT__ "PetscFormatConvert"
35c9a19010SBarry Smith /*@C
36c9a19010SBarry Smith      PetscFormatConvert - Takes a PETSc format string and converts it to a reqular C format string
37c9a19010SBarry Smith 
38c9a19010SBarry Smith    Input Parameters:
39c9a19010SBarry Smith +   format - the PETSc format string
40c9a19010SBarry Smith .   newformat - the location to put the standard C format string values
41c9a19010SBarry Smith -   size - the length of newformat
42c9a19010SBarry Smith 
43c9a19010SBarry 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
44c9a19010SBarry Smith 
45c9a19010SBarry Smith  Level: developer
46c9a19010SBarry Smith 
47c9a19010SBarry Smith @*/
487087cfbeSBarry Smith PetscErrorCode  PetscFormatConvert(const char *format,char *newformat,size_t size)
49e5c89e4eSSatish Balay {
50e5c89e4eSSatish Balay   PetscInt i = 0,j = 0;
51e5c89e4eSSatish Balay 
527bc47156SJose Roman   while (format[i] && j < (PetscInt)size-1) {
537bc47156SJose Roman     if (format[i] == '%' && format[i+1] != '%') {
547bc47156SJose Roman       /* Find the letter */
557bc47156SJose Roman       for ( ; format[i] && format[i] <= '9'; i++) newformat[j++] = format[i];
567bc47156SJose Roman       switch (format[i]) {
577bc47156SJose Roman       case 'D':
586de02169SBarry Smith #if !defined(PETSC_USE_64BIT_INDICES)
59e5c89e4eSSatish Balay         newformat[j++] = 'd';
60e5c89e4eSSatish Balay #else
61e5c89e4eSSatish Balay         newformat[j++] = 'l';
62e5c89e4eSSatish Balay         newformat[j++] = 'l';
63e5c89e4eSSatish Balay         newformat[j++] = 'd';
64e5c89e4eSSatish Balay #endif
657bc47156SJose Roman         break;
667bc47156SJose Roman       case 'G':
67ce63c4c1SBarry Smith #if defined(PETSC_USE_REAL_DOUBLE) || defined(PETSC_USE_REAL_SINGLE)
68a83599f4SBarry Smith         newformat[j++] = 'g';
69ce63c4c1SBarry Smith #elif defined(PETSC_USE_REAL_LONG_DOUBLE)
70a83599f4SBarry Smith         newformat[j++] = 'L';
71a83599f4SBarry Smith         newformat[j++] = 'g';
72ce63c4c1SBarry Smith #elif defined(PETSC_USE_REAL___FLOAT128)
73d9822059SBarry Smith         newformat[j++] = 'Q';
7457ddf7daSJose Roman         newformat[j++] = 'g';
75a83599f4SBarry Smith #endif
767bc47156SJose Roman         break;
77121a09c4SJose Roman       case 'F':
78121a09c4SJose Roman #if defined(PETSC_USE_REAL_DOUBLE) || defined(PETSC_USE_REAL_SINGLE)
79121a09c4SJose Roman         newformat[j++] = 'f';
80121a09c4SJose Roman #elif defined(PETSC_USE_REAL_LONG_DOUBLE)
81121a09c4SJose Roman         newformat[j++] = 'L';
82121a09c4SJose Roman         newformat[j++] = 'f';
83121a09c4SJose Roman #elif defined(PETSC_USE_REAL___FLOAT128)
84121a09c4SJose Roman         newformat[j++] = 'Q';
85121a09c4SJose Roman         newformat[j++] = 'f';
86121a09c4SJose Roman #endif
87121a09c4SJose Roman         break;
887bc47156SJose Roman       default:
897bc47156SJose Roman         newformat[j++] = format[i];
907bc47156SJose Roman         break;
917bc47156SJose Roman       }
927bc47156SJose Roman       i++;
93e5c89e4eSSatish Balay     } else {
94e5c89e4eSSatish Balay       newformat[j++] = format[i++];
95e5c89e4eSSatish Balay     }
96e5c89e4eSSatish Balay   }
97e5c89e4eSSatish Balay   newformat[j] = 0;
98e5c89e4eSSatish Balay   return 0;
99e5c89e4eSSatish Balay }
100e5c89e4eSSatish Balay 
101e5c89e4eSSatish Balay #undef __FUNCT__
102e5c89e4eSSatish Balay #define __FUNCT__ "PetscVSNPrintf"
103c9a19010SBarry Smith /*@C
104c9a19010SBarry Smith      PetscVSNPrintf - The PETSc version of vsnprintf(). Converts a PETSc format string into a standard C format string and then puts all the
105c9a19010SBarry Smith        function arguments into a string using the format statement.
106c9a19010SBarry Smith 
107c9a19010SBarry Smith    Input Parameters:
108c9a19010SBarry Smith +   str - location to put result
109c9a19010SBarry Smith .   len - the amount of space in str
110c9a19010SBarry Smith +   format - the PETSc format string
111c9a19010SBarry Smith -   fullLength - the amount of space in str actually used.
112c9a19010SBarry Smith 
113c9a19010SBarry Smith     Note:  No error handling because may be called by error handler
114c9a19010SBarry Smith 
115c9a19010SBarry Smith  Level: developer
116c9a19010SBarry Smith 
117c9a19010SBarry Smith @*/
1187087cfbeSBarry Smith PetscErrorCode  PetscVSNPrintf(char *str,size_t len,const char *format,size_t *fullLength,va_list Argp)
119e5c89e4eSSatish Balay {
120e5c89e4eSSatish Balay   /* no malloc since may be called by error handler */
121e2135aedSMatthew Knepley   char          *newformat;
122e2135aedSMatthew Knepley   char           formatbuf[8*1024];
1231a96acb8SJed Brown   size_t         oldLength,length;
1241a96acb8SJed Brown   int            fullLengthInt;
1251a15ef5dSMatthew Knepley   PetscErrorCode ierr;
126e5c89e4eSSatish Balay 
127e2135aedSMatthew Knepley   ierr = PetscStrlen(format, &oldLength);CHKERRQ(ierr);
128e2135aedSMatthew Knepley   if (oldLength < 8*1024) {
129e2135aedSMatthew Knepley     newformat = formatbuf;
130*354e5084SJose Roman     oldLength = 8*1024-1;
131e2135aedSMatthew Knepley   } else {
132*354e5084SJose Roman     oldLength = PETSC_MAX_LENGTH_FORMAT(oldLength);
133*354e5084SJose Roman     ierr = PetscMalloc(oldLength * sizeof(char), &newformat);CHKERRQ(ierr);
134e2135aedSMatthew Knepley   }
135*354e5084SJose Roman   PetscFormatConvert(format,newformat,oldLength);
1361a15ef5dSMatthew Knepley   ierr = PetscStrlen(newformat, &length);CHKERRQ(ierr);
1372d609e63SMatthew Knepley #if 0
1381a15ef5dSMatthew Knepley   if (length > len) {
1391a15ef5dSMatthew Knepley     newformat[len] = '\0';
1401a15ef5dSMatthew Knepley   }
1412d609e63SMatthew Knepley #endif
1425a058713SBarry Smith #if defined(PETSC_HAVE_VSNPRINTF_CHAR)
14342c7c0bfSJed Brown   fullLengthInt = vsnprintf(str,len,newformat,(char *)Argp);
14489b07760SSatish Balay #elif defined(PETSC_HAVE_VSNPRINTF)
14542c7c0bfSJed Brown   fullLengthInt = vsnprintf(str,len,newformat,Argp);
146141c0d65SSatish Balay #elif defined(PETSC_HAVE__VSNPRINTF)
14742c7c0bfSJed Brown   fullLengthInt = _vsnprintf(str,len,newformat,Argp);
148e5c89e4eSSatish Balay #else
14989b07760SSatish Balay #error "vsnprintf not found"
150e5c89e4eSSatish Balay #endif
15142c7c0bfSJed Brown   if (fullLengthInt < 0) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SYS,"vsnprintf() failed");
15242c7c0bfSJed Brown   *fullLength = (size_t)fullLengthInt;
153e2135aedSMatthew Knepley   if (oldLength >= 8*1024) {
154e2135aedSMatthew Knepley     ierr = PetscFree(newformat);CHKERRQ(ierr);
155e2135aedSMatthew Knepley   }
156e5c89e4eSSatish Balay   return 0;
157e5c89e4eSSatish Balay }
158e5c89e4eSSatish Balay 
159e5c89e4eSSatish Balay #undef __FUNCT__
1607ead4f01Sbcordonn #define __FUNCT__ "PetscZopeLog"
1617087cfbeSBarry Smith PetscErrorCode  PetscZopeLog(const char *format,va_list Argp)
1629c4c166aSBarry Smith {
1637ead4f01Sbcordonn   /* no malloc since may be called by error handler */
1647ead4f01Sbcordonn   char        newformat[8*1024];
1657ead4f01Sbcordonn   char        log[8*1024];
1667ead4f01Sbcordonn   char        logstart[] = " <<<log>>>";
167c9a19010SBarry Smith   size_t      len,formatlen;
1689c4c166aSBarry Smith 
1697ead4f01Sbcordonn   PetscFormatConvert(format,newformat,8*1024);
1707ead4f01Sbcordonn   PetscStrlen(logstart, &len);
1717ead4f01Sbcordonn   PetscMemcpy(log, logstart, len);
1727ead4f01Sbcordonn   PetscStrlen(newformat, &formatlen);
1737ead4f01Sbcordonn   PetscMemcpy(&(log[len]), newformat, formatlen);
1749c4c166aSBarry Smith   if (PETSC_ZOPEFD){
1755a058713SBarry Smith #if defined(PETSC_HAVE_VFPRINTF_CHAR)
1767ead4f01Sbcordonn     vfprintf(PETSC_ZOPEFD,log,(char *)Argp);
1777ead4f01Sbcordonn #else
1787ead4f01Sbcordonn     vfprintf(PETSC_ZOPEFD,log,Argp);
1797ead4f01Sbcordonn #endif
1805a058713SBarry Smith     fflush(PETSC_ZOPEFD);
1817ead4f01Sbcordonn   }
1827ead4f01Sbcordonn   return 0;
1837ead4f01Sbcordonn }
1847ead4f01Sbcordonn 
1857ead4f01Sbcordonn #undef __FUNCT__
186c9a19010SBarry Smith #define __FUNCT__ "PetscVFPrintfDefault"
187c9a19010SBarry Smith /*@C
188c9a19010SBarry Smith      PetscVFPrintf -  All PETSc standard out and error messages are sent through this function; so, in theory, this can
189e5c89e4eSSatish Balay         can be replaced with something that does not simply write to a file.
190e5c89e4eSSatish Balay 
191c9a19010SBarry Smith       To use, write your own function for example,
192c9a19010SBarry Smith $PetscErrorCode mypetscvfprintf(FILE *fd,const char format[],va_list Argp)
193c9a19010SBarry Smith ${
194c9a19010SBarry Smith $  PetscErrorCode ierr;
195c9a19010SBarry Smith $
196c9a19010SBarry Smith $  PetscFunctionBegin;
197c9a19010SBarry Smith $   if (fd != stdout && fd != stderr) {  handle regular files
198c9a19010SBarry Smith $      ierr = PetscVFPrintfDefault(fd,format,Argp); CHKERR(ierr);
199c9a19010SBarry Smith $  } else {
200c9a19010SBarry Smith $     char   buff[BIG];
201c9a19010SBarry Smith $     size_t length;
202c9a19010SBarry Smith $     ierr = PetscVSNPrintf(buff,BIG,format,&length,Argp);CHKERRQ(ierr);
203c9a19010SBarry Smith $     now send buff to whatever stream or whatever you want
204c9a19010SBarry Smith $ }
205c9a19010SBarry Smith $ PetscFunctionReturn(0);
206c9a19010SBarry Smith $}
207c9a19010SBarry Smith then before the call to PetscInitialize() do the assignment
208c9a19010SBarry Smith $    PetscVFPrintf = mypetscvfprintf;
209c9a19010SBarry Smith 
210c9a19010SBarry Smith       Notes: For error messages this may be called by any process, for regular standard out it is
211e5c89e4eSSatish Balay           called only by process 0 of a given communicator
212e5c89e4eSSatish Balay 
213e5c89e4eSSatish Balay       No error handling because may be called by error handler
214c9a19010SBarry Smith 
215c9a19010SBarry Smith   Level:  developer
216c9a19010SBarry Smith 
217c9a19010SBarry Smith .seealso: PetscVSNPrintf(), PetscErrorPrintf()
218c9a19010SBarry Smith 
219c9a19010SBarry Smith @*/
2207087cfbeSBarry Smith PetscErrorCode  PetscVFPrintfDefault(FILE *fd,const char *format,va_list Argp)
221e5c89e4eSSatish Balay {
222e2135aedSMatthew Knepley   /* no malloc since may be called by error handler (assume no long messages in errors) */
223e2135aedSMatthew Knepley   char        *newformat;
224e2135aedSMatthew Knepley   char         formatbuf[8*1024];
225e2135aedSMatthew Knepley   size_t       oldLength;
2261179db26SBarry Smith 
227e2135aedSMatthew Knepley   PetscStrlen(format, &oldLength);
228e2135aedSMatthew Knepley   if (oldLength < 8*1024) {
229e2135aedSMatthew Knepley     newformat = formatbuf;
230*354e5084SJose Roman     oldLength = 8*1024-1;
231e2135aedSMatthew Knepley   } else {
232*354e5084SJose Roman     oldLength = PETSC_MAX_LENGTH_FORMAT(oldLength);
233*354e5084SJose Roman     (void)PetscMalloc(oldLength * sizeof(char), &newformat);
234e2135aedSMatthew Knepley   }
235*354e5084SJose Roman   PetscFormatConvert(format,newformat,oldLength);
236d8c6e182Sbcordonn 
2375a058713SBarry Smith #if defined(PETSC_HAVE_VFPRINTF_CHAR)
238e5c89e4eSSatish Balay   vfprintf(fd,newformat,(char *)Argp);
239e5c89e4eSSatish Balay #else
240e5c89e4eSSatish Balay   vfprintf(fd,newformat,Argp);
241e5c89e4eSSatish Balay #endif
2425a058713SBarry Smith   fflush(fd);
243e2135aedSMatthew Knepley   if (oldLength >= 8*1024) {
2449a2231e1SJed Brown     (void)PetscFree(newformat);
245e2135aedSMatthew Knepley   }
246e5c89e4eSSatish Balay   return 0;
247e5c89e4eSSatish Balay }
248e5c89e4eSSatish Balay 
2495b5bc046SBarry Smith #undef __FUNCT__
2505b5bc046SBarry Smith #define __FUNCT__ "PetscSNPrintf"
2515b5bc046SBarry Smith /*@C
2525b5bc046SBarry Smith     PetscSNPrintf - Prints to a string of given length
2535b5bc046SBarry Smith 
2545b5bc046SBarry Smith     Not Collective
2555b5bc046SBarry Smith 
2565b5bc046SBarry Smith     Input Parameters:
2575b5bc046SBarry Smith +   str - the string to print to
2585b5bc046SBarry Smith .   len - the length of str
2595b5bc046SBarry Smith .   format - the usual printf() format string
2605b5bc046SBarry Smith -   any arguments
2615b5bc046SBarry Smith 
2625b5bc046SBarry Smith    Level: intermediate
2635b5bc046SBarry Smith 
2645b5bc046SBarry Smith .seealso: PetscSynchronizedFlush(), PetscSynchronizedFPrintf(), PetscFPrintf(), PetscVSNPrintf(),
2655b5bc046SBarry Smith           PetscPrintf(), PetscViewerASCIIPrintf(), PetscViewerASCIISynchronizedPrintf()
2665b5bc046SBarry Smith @*/
2677087cfbeSBarry Smith PetscErrorCode  PetscSNPrintf(char *str,size_t len,const char format[],...)
2685b5bc046SBarry Smith {
2695b5bc046SBarry Smith   PetscErrorCode ierr;
270c9a19010SBarry Smith   size_t         fullLength;
2715b5bc046SBarry Smith   va_list        Argp;
2725b5bc046SBarry Smith 
2735b5bc046SBarry Smith   PetscFunctionBegin;
2745b5bc046SBarry Smith   va_start(Argp,format);
2752d609e63SMatthew Knepley   ierr = PetscVSNPrintf(str,len,format,&fullLength,Argp);CHKERRQ(ierr);
2765b5bc046SBarry Smith   PetscFunctionReturn(0);
2775b5bc046SBarry Smith }
2785b5bc046SBarry Smith 
279257d2499SJed Brown #undef __FUNCT__
280257d2499SJed Brown #define __FUNCT__ "PetscSNPrintfCount"
281257d2499SJed Brown /*@C
282257d2499SJed Brown     PetscSNPrintfCount - Prints to a string of given length, returns count
283257d2499SJed Brown 
284257d2499SJed Brown     Not Collective
285257d2499SJed Brown 
286257d2499SJed Brown     Input Parameters:
287257d2499SJed Brown +   str - the string to print to
288257d2499SJed Brown .   len - the length of str
289257d2499SJed Brown .   format - the usual printf() format string
290257d2499SJed Brown .   countused - number of characters used
291257d2499SJed Brown -   any arguments
292257d2499SJed Brown 
293257d2499SJed Brown    Level: intermediate
294257d2499SJed Brown 
295257d2499SJed Brown .seealso: PetscSynchronizedFlush(), PetscSynchronizedFPrintf(), PetscFPrintf(), PetscVSNPrintf(),
296257d2499SJed Brown           PetscPrintf(), PetscViewerASCIIPrintf(), PetscViewerASCIISynchronizedPrintf(), PetscSNPrintf()
297257d2499SJed Brown @*/
298257d2499SJed Brown PetscErrorCode  PetscSNPrintfCount(char *str,size_t len,const char format[],size_t *countused,...)
299257d2499SJed Brown {
300257d2499SJed Brown   PetscErrorCode ierr;
301257d2499SJed Brown   va_list        Argp;
302257d2499SJed Brown 
303257d2499SJed Brown   PetscFunctionBegin;
304257d2499SJed Brown   va_start(Argp,countused);
305257d2499SJed Brown   ierr = PetscVSNPrintf(str,len,format,countused,Argp);CHKERRQ(ierr);
306257d2499SJed Brown   PetscFunctionReturn(0);
307257d2499SJed Brown }
308257d2499SJed Brown 
309e5c89e4eSSatish Balay /* ----------------------------------------------------------------------- */
310e5c89e4eSSatish Balay 
311e5c89e4eSSatish Balay PrintfQueue queue       = 0,queuebase = 0;
312e5c89e4eSSatish Balay int         queuelength = 0;
313e5c89e4eSSatish Balay FILE        *queuefile  = PETSC_NULL;
314e5c89e4eSSatish Balay 
315e5c89e4eSSatish Balay #undef __FUNCT__
316e5c89e4eSSatish Balay #define __FUNCT__ "PetscSynchronizedPrintf"
317e5c89e4eSSatish Balay /*@C
318e5c89e4eSSatish Balay     PetscSynchronizedPrintf - Prints synchronized output from several processors.
319e5c89e4eSSatish Balay     Output of the first processor is followed by that of the second, etc.
320e5c89e4eSSatish Balay 
321e5c89e4eSSatish Balay     Not Collective
322e5c89e4eSSatish Balay 
323e5c89e4eSSatish Balay     Input Parameters:
324e5c89e4eSSatish Balay +   comm - the communicator
325e5c89e4eSSatish Balay -   format - the usual printf() format string
326e5c89e4eSSatish Balay 
327e5c89e4eSSatish Balay    Level: intermediate
328e5c89e4eSSatish Balay 
329e5c89e4eSSatish Balay     Notes:
330e5c89e4eSSatish Balay     REQUIRES a intervening call to PetscSynchronizedFlush() for the information
331e5c89e4eSSatish Balay     from all the processors to be printed.
332e5c89e4eSSatish Balay 
333e5c89e4eSSatish Balay     Fortran Note:
334d60d70ccSBarry Smith     The call sequence is PetscSynchronizedPrintf(MPI_Comm, character(*), PetscErrorCode ierr) from Fortran.
335e5c89e4eSSatish Balay     That is, you can only pass a single character string from Fortran.
336e5c89e4eSSatish Balay 
337e5c89e4eSSatish Balay .seealso: PetscSynchronizedFlush(), PetscSynchronizedFPrintf(), PetscFPrintf(),
338e5c89e4eSSatish Balay           PetscPrintf(), PetscViewerASCIIPrintf(), PetscViewerASCIISynchronizedPrintf()
339e5c89e4eSSatish Balay @*/
3407087cfbeSBarry Smith PetscErrorCode  PetscSynchronizedPrintf(MPI_Comm comm,const char format[],...)
341e5c89e4eSSatish Balay {
342e5c89e4eSSatish Balay   PetscErrorCode ierr;
343e5c89e4eSSatish Balay   PetscMPIInt    rank;
344e5c89e4eSSatish Balay 
345e5c89e4eSSatish Balay   PetscFunctionBegin;
346e5c89e4eSSatish Balay   ierr = MPI_Comm_rank(comm,&rank);CHKERRQ(ierr);
347e5c89e4eSSatish Balay 
348e5c89e4eSSatish Balay   /* First processor prints immediately to stdout */
349e5c89e4eSSatish Balay   if (!rank) {
350e5c89e4eSSatish Balay     va_list Argp;
351e5c89e4eSSatish Balay     va_start(Argp,format);
3521179db26SBarry Smith     ierr = (*PetscVFPrintf)(PETSC_STDOUT,format,Argp);CHKERRQ(ierr);
353e5c89e4eSSatish Balay     if (petsc_history) {
354cdc7d174SSatish Balay       va_start(Argp,format);
3551179db26SBarry Smith       ierr = (*PetscVFPrintf)(petsc_history,format,Argp);CHKERRQ(ierr);
356e5c89e4eSSatish Balay     }
357e5c89e4eSSatish Balay     va_end(Argp);
358e5c89e4eSSatish Balay   } else { /* other processors add to local queue */
359e5c89e4eSSatish Balay     va_list     Argp;
360e5c89e4eSSatish Balay     PrintfQueue next;
361c9a19010SBarry Smith     size_t      fullLength = 8191;
362e5c89e4eSSatish Balay 
363e5c89e4eSSatish Balay     ierr = PetscNew(struct _PrintfQueue,&next);CHKERRQ(ierr);
364e5c89e4eSSatish Balay     if (queue) {queue->next = next; queue = next; queue->next = 0;}
365e5c89e4eSSatish Balay     else       {queuebase   = queue = next;}
366e5c89e4eSSatish Balay     queuelength++;
3672d609e63SMatthew Knepley     next->size = -1;
3689ad23270SJed Brown     while((PetscInt)fullLength >= next->size) {
3692d609e63SMatthew Knepley       next->size = fullLength+1;
3702d609e63SMatthew Knepley       ierr = PetscMalloc(next->size * sizeof(char), &next->string);CHKERRQ(ierr);
371e5c89e4eSSatish Balay       va_start(Argp,format);
3722d609e63SMatthew Knepley       ierr = PetscMemzero(next->string,next->size);CHKERRQ(ierr);
3732d609e63SMatthew Knepley       ierr = PetscVSNPrintf(next->string,next->size,format, &fullLength,Argp);CHKERRQ(ierr);
374e5c89e4eSSatish Balay       va_end(Argp);
375e5c89e4eSSatish Balay     }
3762d609e63SMatthew Knepley   }
377e5c89e4eSSatish Balay 
378e5c89e4eSSatish Balay   PetscFunctionReturn(0);
379e5c89e4eSSatish Balay }
380e5c89e4eSSatish Balay 
381e5c89e4eSSatish Balay #undef __FUNCT__
382e5c89e4eSSatish Balay #define __FUNCT__ "PetscSynchronizedFPrintf"
383e5c89e4eSSatish Balay /*@C
384e5c89e4eSSatish Balay     PetscSynchronizedFPrintf - Prints synchronized output to the specified file from
385e5c89e4eSSatish Balay     several processors.  Output of the first processor is followed by that of the
386e5c89e4eSSatish Balay     second, etc.
387e5c89e4eSSatish Balay 
388e5c89e4eSSatish Balay     Not Collective
389e5c89e4eSSatish Balay 
390e5c89e4eSSatish Balay     Input Parameters:
391e5c89e4eSSatish Balay +   comm - the communicator
392e5c89e4eSSatish Balay .   fd - the file pointer
393e5c89e4eSSatish Balay -   format - the usual printf() format string
394e5c89e4eSSatish Balay 
395e5c89e4eSSatish Balay     Level: intermediate
396e5c89e4eSSatish Balay 
397e5c89e4eSSatish Balay     Notes:
398e5c89e4eSSatish Balay     REQUIRES a intervening call to PetscSynchronizedFlush() for the information
399e5c89e4eSSatish Balay     from all the processors to be printed.
400e5c89e4eSSatish Balay 
401e5c89e4eSSatish Balay .seealso: PetscSynchronizedPrintf(), PetscSynchronizedFlush(), PetscFPrintf(),
402e5c89e4eSSatish Balay           PetscFOpen(), PetscViewerASCIISynchronizedPrintf(), PetscViewerASCIIPrintf()
403e5c89e4eSSatish Balay 
404e5c89e4eSSatish Balay @*/
4057087cfbeSBarry Smith PetscErrorCode  PetscSynchronizedFPrintf(MPI_Comm comm,FILE* fp,const char format[],...)
406e5c89e4eSSatish Balay {
407e5c89e4eSSatish Balay   PetscErrorCode ierr;
408e5c89e4eSSatish Balay   PetscMPIInt    rank;
409e5c89e4eSSatish Balay 
410e5c89e4eSSatish Balay   PetscFunctionBegin;
411e5c89e4eSSatish Balay   ierr = MPI_Comm_rank(comm,&rank);CHKERRQ(ierr);
412e5c89e4eSSatish Balay 
413e5c89e4eSSatish Balay   /* First processor prints immediately to fp */
414e5c89e4eSSatish Balay   if (!rank) {
415e5c89e4eSSatish Balay     va_list Argp;
416e5c89e4eSSatish Balay     va_start(Argp,format);
4171179db26SBarry Smith     ierr = (*PetscVFPrintf)(fp,format,Argp);CHKERRQ(ierr);
418e5c89e4eSSatish Balay     queuefile = fp;
419cdc7d174SSatish Balay     if (petsc_history && (fp !=petsc_history)) {
420cdc7d174SSatish Balay       va_start(Argp,format);
4211179db26SBarry Smith       ierr = (*PetscVFPrintf)(petsc_history,format,Argp);CHKERRQ(ierr);
422e5c89e4eSSatish Balay     }
423e5c89e4eSSatish Balay     va_end(Argp);
424e5c89e4eSSatish Balay   } else { /* other processors add to local queue */
425e5c89e4eSSatish Balay     va_list     Argp;
426e5c89e4eSSatish Balay     PrintfQueue next;
427c9a19010SBarry Smith     size_t      fullLength = 8191;
428e5c89e4eSSatish Balay     ierr = PetscNew(struct _PrintfQueue,&next);CHKERRQ(ierr);
429e5c89e4eSSatish Balay     if (queue) {queue->next = next; queue = next; queue->next = 0;}
430e5c89e4eSSatish Balay     else       {queuebase   = queue = next;}
431e5c89e4eSSatish Balay     queuelength++;
4322d609e63SMatthew Knepley     next->size = -1;
4339ad23270SJed Brown     while((PetscInt)fullLength >= next->size) {
4342d609e63SMatthew Knepley       next->size = fullLength+1;
4352d609e63SMatthew Knepley       ierr = PetscMalloc(next->size * sizeof(char), &next->string);CHKERRQ(ierr);
436e5c89e4eSSatish Balay       va_start(Argp,format);
4372d609e63SMatthew Knepley       ierr = PetscMemzero(next->string,next->size);CHKERRQ(ierr);
4382d609e63SMatthew Knepley       ierr = PetscVSNPrintf(next->string,next->size,format,&fullLength,Argp);CHKERRQ(ierr);
439e5c89e4eSSatish Balay       va_end(Argp);
440e5c89e4eSSatish Balay     }
4412d609e63SMatthew Knepley   }
442e5c89e4eSSatish Balay   PetscFunctionReturn(0);
443e5c89e4eSSatish Balay }
444e5c89e4eSSatish Balay 
445e5c89e4eSSatish Balay #undef __FUNCT__
446e5c89e4eSSatish Balay #define __FUNCT__ "PetscSynchronizedFlush"
447e30d2299SSatish Balay /*@
448e5c89e4eSSatish Balay     PetscSynchronizedFlush - Flushes to the screen output from all processors
449e5c89e4eSSatish Balay     involved in previous PetscSynchronizedPrintf() calls.
450e5c89e4eSSatish Balay 
451e5c89e4eSSatish Balay     Collective on MPI_Comm
452e5c89e4eSSatish Balay 
453e5c89e4eSSatish Balay     Input Parameters:
454e5c89e4eSSatish Balay .   comm - the communicator
455e5c89e4eSSatish Balay 
456e5c89e4eSSatish Balay     Level: intermediate
457e5c89e4eSSatish Balay 
458e5c89e4eSSatish Balay     Notes:
459e5c89e4eSSatish Balay     Usage of PetscSynchronizedPrintf() and PetscSynchronizedFPrintf() with
460e5c89e4eSSatish Balay     different MPI communicators REQUIRES an intervening call to PetscSynchronizedFlush().
461e5c89e4eSSatish Balay 
462e5c89e4eSSatish Balay .seealso: PetscSynchronizedPrintf(), PetscFPrintf(), PetscPrintf(), PetscViewerASCIIPrintf(),
463e5c89e4eSSatish Balay           PetscViewerASCIISynchronizedPrintf()
464e5c89e4eSSatish Balay @*/
4657087cfbeSBarry Smith PetscErrorCode  PetscSynchronizedFlush(MPI_Comm comm)
466e5c89e4eSSatish Balay {
467e5c89e4eSSatish Balay   PetscErrorCode ierr;
468bf3b0749SBarry Smith   PetscMPIInt    rank,size,tag,i,j,n,dummy = 0;
4692d609e63SMatthew Knepley   char          *message;
470e5c89e4eSSatish Balay   MPI_Status     status;
471e5c89e4eSSatish Balay   FILE           *fd;
472e5c89e4eSSatish Balay 
473e5c89e4eSSatish Balay   PetscFunctionBegin;
474e5c89e4eSSatish Balay   ierr = PetscCommDuplicate(comm,&comm,&tag);CHKERRQ(ierr);
475e5c89e4eSSatish Balay   ierr = MPI_Comm_rank(comm,&rank);CHKERRQ(ierr);
476e5c89e4eSSatish Balay   ierr = MPI_Comm_size(comm,&size);CHKERRQ(ierr);
477e5c89e4eSSatish Balay 
478e5c89e4eSSatish Balay   /* First processor waits for messages from all other processors */
479e5c89e4eSSatish Balay   if (!rank) {
480e5c89e4eSSatish Balay     if (queuefile) {
481e5c89e4eSSatish Balay       fd = queuefile;
482e5c89e4eSSatish Balay     } else {
483e5c89e4eSSatish Balay       fd = PETSC_STDOUT;
484e5c89e4eSSatish Balay     }
485e5c89e4eSSatish Balay     for (i=1; i<size; i++) {
4869f73f8ecSBarry Smith       /* to prevent a flood of messages to process zero, request each message separately */
4879f73f8ecSBarry Smith       ierr = MPI_Send(&dummy,1,MPI_INT,i,tag,comm);CHKERRQ(ierr);
488e5c89e4eSSatish Balay       ierr = MPI_Recv(&n,1,MPI_INT,i,tag,comm,&status);CHKERRQ(ierr);
489e5c89e4eSSatish Balay       for (j=0; j<n; j++) {
4909f73f8ecSBarry Smith         PetscMPIInt size;
4912d609e63SMatthew Knepley 
4922d609e63SMatthew Knepley         ierr = MPI_Recv(&size,1,MPI_INT,i,tag,comm,&status);CHKERRQ(ierr);
4932d609e63SMatthew Knepley         ierr = PetscMalloc(size * sizeof(char), &message);CHKERRQ(ierr);
4942d609e63SMatthew Knepley         ierr = MPI_Recv(message,size,MPI_CHAR,i,tag,comm,&status);CHKERRQ(ierr);
495e5c89e4eSSatish Balay         ierr = PetscFPrintf(comm,fd,"%s",message);
4962d609e63SMatthew Knepley         ierr = PetscFree(message);CHKERRQ(ierr);
497e5c89e4eSSatish Balay       }
498e5c89e4eSSatish Balay     }
499e5c89e4eSSatish Balay     queuefile = PETSC_NULL;
500e5c89e4eSSatish Balay   } else { /* other processors send queue to processor 0 */
501e5c89e4eSSatish Balay     PrintfQueue next = queuebase,previous;
502e5c89e4eSSatish Balay 
503b3ef9d35SBarry Smith     ierr = MPI_Recv(&dummy,1,MPI_INT,0,tag,comm,&status);CHKERRQ(ierr);
504e5c89e4eSSatish Balay     ierr = MPI_Send(&queuelength,1,MPI_INT,0,tag,comm);CHKERRQ(ierr);
505e5c89e4eSSatish Balay     for (i=0; i<queuelength; i++) {
5062d609e63SMatthew Knepley       ierr     = MPI_Send(&next->size,1,MPI_INT,0,tag,comm);CHKERRQ(ierr);
5072d609e63SMatthew Knepley       ierr     = MPI_Send(next->string,next->size,MPI_CHAR,0,tag,comm);CHKERRQ(ierr);
508e5c89e4eSSatish Balay       previous = next;
509e5c89e4eSSatish Balay       next     = next->next;
5102d609e63SMatthew Knepley       ierr     = PetscFree(previous->string);CHKERRQ(ierr);
511e5c89e4eSSatish Balay       ierr     = PetscFree(previous);CHKERRQ(ierr);
512e5c89e4eSSatish Balay     }
513e5c89e4eSSatish Balay     queue       = 0;
514e5c89e4eSSatish Balay     queuelength = 0;
515e5c89e4eSSatish Balay   }
516e5c89e4eSSatish Balay   ierr = PetscCommDestroy(&comm);CHKERRQ(ierr);
517e5c89e4eSSatish Balay   PetscFunctionReturn(0);
518e5c89e4eSSatish Balay }
519e5c89e4eSSatish Balay 
520e5c89e4eSSatish Balay /* ---------------------------------------------------------------------------------------*/
521e5c89e4eSSatish Balay 
522e5c89e4eSSatish Balay #undef __FUNCT__
523e5c89e4eSSatish Balay #define __FUNCT__ "PetscFPrintf"
524e5c89e4eSSatish Balay /*@C
525e5c89e4eSSatish Balay     PetscFPrintf - Prints to a file, only from the first
526e5c89e4eSSatish Balay     processor in the communicator.
527e5c89e4eSSatish Balay 
528e5c89e4eSSatish Balay     Not Collective
529e5c89e4eSSatish Balay 
530e5c89e4eSSatish Balay     Input Parameters:
531e5c89e4eSSatish Balay +   comm - the communicator
532e5c89e4eSSatish Balay .   fd - the file pointer
533e5c89e4eSSatish Balay -   format - the usual printf() format string
534e5c89e4eSSatish Balay 
535e5c89e4eSSatish Balay     Level: intermediate
536e5c89e4eSSatish Balay 
537e5c89e4eSSatish Balay     Fortran Note:
538e5c89e4eSSatish Balay     This routine is not supported in Fortran.
539e5c89e4eSSatish Balay 
540e5c89e4eSSatish Balay    Concepts: printing^in parallel
541e5c89e4eSSatish Balay    Concepts: printf^in parallel
542e5c89e4eSSatish Balay 
543e5c89e4eSSatish Balay .seealso: PetscPrintf(), PetscSynchronizedPrintf(), PetscViewerASCIIPrintf(),
544e5c89e4eSSatish Balay           PetscViewerASCIISynchronizedPrintf(), PetscSynchronizedFlush()
545e5c89e4eSSatish Balay @*/
5467087cfbeSBarry Smith PetscErrorCode  PetscFPrintf(MPI_Comm comm,FILE* fd,const char format[],...)
547e5c89e4eSSatish Balay {
548e5c89e4eSSatish Balay   PetscErrorCode ierr;
549e5c89e4eSSatish Balay   PetscMPIInt    rank;
550e5c89e4eSSatish Balay 
551e5c89e4eSSatish Balay   PetscFunctionBegin;
552e5c89e4eSSatish Balay   ierr = MPI_Comm_rank(comm,&rank);CHKERRQ(ierr);
553e5c89e4eSSatish Balay   if (!rank) {
554e5c89e4eSSatish Balay     va_list Argp;
555e5c89e4eSSatish Balay     va_start(Argp,format);
5561179db26SBarry Smith     ierr = (*PetscVFPrintf)(fd,format,Argp);CHKERRQ(ierr);
557cdc7d174SSatish Balay     if (petsc_history && (fd !=petsc_history)) {
558cdc7d174SSatish Balay       va_start(Argp,format);
5591179db26SBarry Smith       ierr = (*PetscVFPrintf)(petsc_history,format,Argp);CHKERRQ(ierr);
560e5c89e4eSSatish Balay       }
561e5c89e4eSSatish Balay     va_end(Argp);
562e5c89e4eSSatish Balay   }
563e5c89e4eSSatish Balay   PetscFunctionReturn(0);
564e5c89e4eSSatish Balay }
565e5c89e4eSSatish Balay 
566e5c89e4eSSatish Balay #undef __FUNCT__
567e5c89e4eSSatish Balay #define __FUNCT__ "PetscPrintf"
568e5c89e4eSSatish Balay /*@C
569e5c89e4eSSatish Balay     PetscPrintf - Prints to standard out, only from the first
570e5c89e4eSSatish Balay     processor in the communicator.
571e5c89e4eSSatish Balay 
572e5c89e4eSSatish Balay     Not Collective
573e5c89e4eSSatish Balay 
574e5c89e4eSSatish Balay     Input Parameters:
575e5c89e4eSSatish Balay +   comm - the communicator
576e5c89e4eSSatish Balay -   format - the usual printf() format string
577e5c89e4eSSatish Balay 
578e5c89e4eSSatish Balay    Level: intermediate
579e5c89e4eSSatish Balay 
580e5c89e4eSSatish Balay     Fortran Note:
581d60d70ccSBarry Smith     The call sequence is PetscPrintf(MPI_Comm, character(*), PetscErrorCode ierr) from Fortran.
582e5c89e4eSSatish Balay     That is, you can only pass a single character string from Fortran.
583e5c89e4eSSatish Balay 
5848884cb1fSJed Brown    Notes: The %A format specifier is special.  It assumes an argument of type PetscReal
5858884cb1fSJed Brown           and is replaced with %G unless the absolute value is < 1.e-12 when it is replaced
5868884cb1fSJed Brown           with "< 1.e-12" (1.e-6 for single precision).
587e5c89e4eSSatish Balay 
588e5c89e4eSSatish Balay    Concepts: printing^in parallel
589e5c89e4eSSatish Balay    Concepts: printf^in parallel
590e5c89e4eSSatish Balay 
591e5c89e4eSSatish Balay .seealso: PetscFPrintf(), PetscSynchronizedPrintf()
592e5c89e4eSSatish Balay @*/
5937087cfbeSBarry Smith PetscErrorCode  PetscPrintf(MPI_Comm comm,const char format[],...)
594e5c89e4eSSatish Balay {
595e5c89e4eSSatish Balay   PetscErrorCode ierr;
596e5c89e4eSSatish Balay   PetscMPIInt    rank;
597e5c89e4eSSatish Balay   size_t         len;
598e5c89e4eSSatish Balay   char           *nformat,*sub1,*sub2;
599e5c89e4eSSatish Balay   PetscReal      value;
600e5c89e4eSSatish Balay 
601e5c89e4eSSatish Balay   PetscFunctionBegin;
602e5c89e4eSSatish Balay   if (!comm) comm = PETSC_COMM_WORLD;
603e5c89e4eSSatish Balay   ierr = MPI_Comm_rank(comm,&rank);CHKERRQ(ierr);
604e5c89e4eSSatish Balay   if (!rank) {
605e5c89e4eSSatish Balay     va_list Argp;
606e5c89e4eSSatish Balay     va_start(Argp,format);
607e5c89e4eSSatish Balay 
608e5c89e4eSSatish Balay     ierr = PetscStrstr(format,"%A",&sub1);CHKERRQ(ierr);
609e5c89e4eSSatish Balay     if (sub1) {
610e5c89e4eSSatish Balay       ierr = PetscStrstr(format,"%",&sub2);CHKERRQ(ierr);
611e32f2f54SBarry Smith       if (sub1 != sub2) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"%%A format must be first in format string");
612e5c89e4eSSatish Balay       ierr    = PetscStrlen(format,&len);CHKERRQ(ierr);
613e5c89e4eSSatish Balay       ierr    = PetscMalloc((len+16)*sizeof(char),&nformat);CHKERRQ(ierr);
614e5c89e4eSSatish Balay       ierr    = PetscStrcpy(nformat,format);CHKERRQ(ierr);
615e5c89e4eSSatish Balay       ierr    = PetscStrstr(nformat,"%",&sub2);CHKERRQ(ierr);
616e5c89e4eSSatish Balay       sub2[0] = 0;
61792eff512SVictor Minden       value   = va_arg(Argp,double);
618ce63c4c1SBarry Smith #if defined(PETSC_USE_REAL_SINGLE)
6198884cb1fSJed Brown       if (PetscAbsReal(value) < 1.e-6) {
6208884cb1fSJed Brown         ierr    = PetscStrcat(nformat,"< 1.e-6");CHKERRQ(ierr);
6218884cb1fSJed Brown #else
622e5c89e4eSSatish Balay       if (PetscAbsReal(value) < 1.e-12) {
623e5c89e4eSSatish Balay         ierr    = PetscStrcat(nformat,"< 1.e-12");CHKERRQ(ierr);
6248884cb1fSJed Brown #endif
625e5c89e4eSSatish Balay       } else {
6268884cb1fSJed Brown         ierr    = PetscStrcat(nformat,"%G");CHKERRQ(ierr);
627e5c89e4eSSatish Balay         va_end(Argp);
628e5c89e4eSSatish Balay         va_start(Argp,format);
629e5c89e4eSSatish Balay       }
630e5c89e4eSSatish Balay       ierr    = PetscStrcat(nformat,sub1+2);CHKERRQ(ierr);
631e5c89e4eSSatish Balay     } else {
632e5c89e4eSSatish Balay       nformat = (char*)format;
633e5c89e4eSSatish Balay     }
6341179db26SBarry Smith     ierr = (*PetscVFPrintf)(PETSC_STDOUT,nformat,Argp);CHKERRQ(ierr);
635e5c89e4eSSatish Balay     if (petsc_history) {
636cdc7d174SSatish Balay       va_start(Argp,format);
6371179db26SBarry Smith       ierr = (*PetscVFPrintf)(petsc_history,nformat,Argp);CHKERRQ(ierr);
638e5c89e4eSSatish Balay     }
639e5c89e4eSSatish Balay     va_end(Argp);
640e5c89e4eSSatish Balay     if (sub1) {ierr = PetscFree(nformat);CHKERRQ(ierr);}
641e5c89e4eSSatish Balay   }
642e5c89e4eSSatish Balay   PetscFunctionReturn(0);
643e5c89e4eSSatish Balay }
644e5c89e4eSSatish Balay 
645e5c89e4eSSatish Balay /* ---------------------------------------------------------------------------------------*/
646e5c89e4eSSatish Balay #undef __FUNCT__
647e5c89e4eSSatish Balay #define __FUNCT__ "PetscHelpPrintfDefault"
648c9a19010SBarry Smith /*@C
649c9a19010SBarry Smith      PetscHelpPrintf -  All PETSc help messages are passing through this function. You can change how help messages are printed by
650c9a19010SBarry Smith         replacinng it  with something that does not simply write to a stdout.
651c9a19010SBarry Smith 
652c9a19010SBarry Smith       To use, write your own function for example,
653c9a19010SBarry Smith $PetscErrorCode mypetschelpprintf(MPI_Comm comm,const char format[],....)
654c9a19010SBarry Smith ${
655c9a19010SBarry Smith $ PetscFunctionReturn(0);
656c9a19010SBarry Smith $}
657c9a19010SBarry Smith then before the call to PetscInitialize() do the assignment
658c9a19010SBarry Smith $    PetscHelpPrintf = mypetschelpprintf;
659c9a19010SBarry Smith 
660c9a19010SBarry Smith   Note: the default routine used is called PetscHelpPrintfDefault().
661c9a19010SBarry Smith 
662c9a19010SBarry Smith   Level:  developer
663c9a19010SBarry Smith 
664c9a19010SBarry Smith .seealso: PetscVSNPrintf(), PetscVFPrintf(), PetscErrorPrintf()
665c9a19010SBarry Smith @*/
6667087cfbeSBarry Smith PetscErrorCode  PetscHelpPrintfDefault(MPI_Comm comm,const char format[],...)
667e5c89e4eSSatish Balay {
668e5c89e4eSSatish Balay   PetscErrorCode ierr;
669e5c89e4eSSatish Balay   PetscMPIInt    rank;
670e5c89e4eSSatish Balay 
671e5c89e4eSSatish Balay   PetscFunctionBegin;
672e5c89e4eSSatish Balay   if (!comm) comm = PETSC_COMM_WORLD;
673e5c89e4eSSatish Balay   ierr = MPI_Comm_rank(comm,&rank);CHKERRQ(ierr);
674e5c89e4eSSatish Balay   if (!rank) {
675e5c89e4eSSatish Balay     va_list Argp;
676e5c89e4eSSatish Balay     va_start(Argp,format);
6771179db26SBarry Smith     ierr = (*PetscVFPrintf)(PETSC_STDOUT,format,Argp);CHKERRQ(ierr);
678e5c89e4eSSatish Balay     if (petsc_history) {
679cdc7d174SSatish Balay       va_start(Argp,format);
6801179db26SBarry Smith       ierr = (*PetscVFPrintf)(petsc_history,format,Argp);CHKERRQ(ierr);
681e5c89e4eSSatish Balay     }
682e5c89e4eSSatish Balay     va_end(Argp);
683e5c89e4eSSatish Balay   }
684e5c89e4eSSatish Balay   PetscFunctionReturn(0);
685e5c89e4eSSatish Balay }
686e5c89e4eSSatish Balay 
687e5c89e4eSSatish Balay /* ---------------------------------------------------------------------------------------*/
688e5c89e4eSSatish Balay 
689e5c89e4eSSatish Balay 
690e5c89e4eSSatish Balay #undef __FUNCT__
691e5c89e4eSSatish Balay #define __FUNCT__ "PetscSynchronizedFGets"
692e5c89e4eSSatish Balay /*@C
693e5c89e4eSSatish Balay     PetscSynchronizedFGets - Several processors all get the same line from a file.
694e5c89e4eSSatish Balay 
695e5c89e4eSSatish Balay     Collective on MPI_Comm
696e5c89e4eSSatish Balay 
697e5c89e4eSSatish Balay     Input Parameters:
698e5c89e4eSSatish Balay +   comm - the communicator
699e5c89e4eSSatish Balay .   fd - the file pointer
700e5c89e4eSSatish Balay -   len - the length of the output buffer
701e5c89e4eSSatish Balay 
702e5c89e4eSSatish Balay     Output Parameter:
703e5c89e4eSSatish Balay .   string - the line read from the file
704e5c89e4eSSatish Balay 
705e5c89e4eSSatish Balay     Level: intermediate
706e5c89e4eSSatish Balay 
707e5c89e4eSSatish Balay .seealso: PetscSynchronizedPrintf(), PetscSynchronizedFlush(),
708e5c89e4eSSatish Balay           PetscFOpen(), PetscViewerASCIISynchronizedPrintf(), PetscViewerASCIIPrintf()
709e5c89e4eSSatish Balay 
710e5c89e4eSSatish Balay @*/
7117087cfbeSBarry Smith PetscErrorCode  PetscSynchronizedFGets(MPI_Comm comm,FILE* fp,size_t len,char string[])
712e5c89e4eSSatish Balay {
713e5c89e4eSSatish Balay   PetscErrorCode ierr;
714e5c89e4eSSatish Balay   PetscMPIInt    rank;
715e5c89e4eSSatish Balay 
716e5c89e4eSSatish Balay   PetscFunctionBegin;
717e5c89e4eSSatish Balay   ierr = MPI_Comm_rank(comm,&rank);CHKERRQ(ierr);
718e5c89e4eSSatish Balay 
719e5c89e4eSSatish Balay   if (!rank) {
720047b9c12SMatthew G Knepley     char *ptr = fgets(string, len, fp);
721047b9c12SMatthew G Knepley 
722047b9c12SMatthew G Knepley     if (!ptr) {
723047b9c12SMatthew G Knepley       if (feof(fp)) {
724047b9c12SMatthew G Knepley         len = 0;
7254c2b986eSBarry Smith       } else SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_FILE_READ, "Error reading from file: %d", errno);
726047b9c12SMatthew G Knepley     }
727e5c89e4eSSatish Balay   }
728e5c89e4eSSatish Balay   ierr = MPI_Bcast(string,len,MPI_BYTE,0,comm);CHKERRQ(ierr);
729e5c89e4eSSatish Balay   PetscFunctionReturn(0);
730e5c89e4eSSatish Balay }
731238ccf28SShri Abhyankar 
732238ccf28SShri Abhyankar #if defined(PETSC_HAVE_MATLAB_ENGINE)
733c6db04a5SJed Brown #include <mex.h>
734238ccf28SShri Abhyankar #undef __FUNCT__
735238ccf28SShri Abhyankar #define __FUNCT__ "PetscVFPrintf_Matlab"
7367087cfbeSBarry Smith PetscErrorCode  PetscVFPrintf_Matlab(FILE *fd,const char format[],va_list Argp)
737238ccf28SShri Abhyankar {
738238ccf28SShri Abhyankar   PetscErrorCode ierr;
739238ccf28SShri Abhyankar 
740238ccf28SShri Abhyankar   PetscFunctionBegin;
741238ccf28SShri Abhyankar   if (fd != stdout && fd != stderr) { /* handle regular files */
742238ccf28SShri Abhyankar     ierr = PetscVFPrintfDefault(fd,format,Argp); CHKERRQ(ierr);
743238ccf28SShri Abhyankar   } else {
744238ccf28SShri Abhyankar     size_t len=8*1024,length;
745238ccf28SShri Abhyankar     char   buf[len];
746238ccf28SShri Abhyankar 
747238ccf28SShri Abhyankar     ierr = PetscVSNPrintf(buf,len,format,&length,Argp);CHKERRQ(ierr);
748df413903SBarry Smith     mexPrintf("%s",buf);
749238ccf28SShri Abhyankar  }
750238ccf28SShri Abhyankar  PetscFunctionReturn(0);
751238ccf28SShri Abhyankar }
752238ccf28SShri Abhyankar #endif
753