/[escript]/trunk/doc/user/escript.tex
ViewVC logotype

Diff of /trunk/doc/user/escript.tex

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 2317 by gross, Thu Mar 19 01:22:15 2009 UTC revision 2318 by gross, Thu Mar 19 03:18:11 2009 UTC
# Line 352  Otherwise \False is returned. Line 352  Otherwise \False is returned.
352  (python str() function) returns string representation of the \Domain.  (python str() function) returns string representation of the \Domain.
353  \end{methoddesc}  \end{methoddesc}
354    
355  \begin{methoddesc}[Domain]{onMasterProcessor}{}  \begin{methoddesc}[Domain]{onMasterProcessor)}{}
356   returns \True if executed on the MPI master processor, \False otherwise.  returns \True if the processor is the master processor within
357  This can be used in conjunction with MPIBarrier to ensure commands only run once.  the \MPI processor group used by the \Domain. This is the processor with rank 0.
358  \end{methoddesc}  If \MPI support is not enabled the return value is always \True.
   
 \begin{methoddesc}[Domain]{MPIBarrier}{}  
  executes an MPIBarrier command. If MPI support is not enabled, this command does nothing.  
 \end{methoddesc}  
   
 \begin{methoddesc}[Domain]{MPIBarrier}{}  
  executes an MPIBarrier command. If MPI support is not enabled, this command does nothing.  
359  \end{methoddesc}  \end{methoddesc}
360    
361  \begin{methoddesc}[Domain]{getMPISize}{}  \begin{methoddesc}[Domain]{getMPISize}{}
362   returns the number of MPI processors used for this domain.   returns the number of \MPI processors used for this \Domain. If \MPI support is not enabled
363    1 is returned.
364  \end{methoddesc}  \end{methoddesc}
365    
366  \begin{methoddesc}[Domain]{getMPIRank}{}  \begin{methoddesc}[Domain]{getMPIRank}{}
367   returns the rank of the processor executing the statement.   returns the rank of the processor executing the statement
368    within the  \MPI processor group used by the \Domain.
369    If \MPI support is not enabled 0 is returned.
370    \end{methoddesc}
371    
372    \begin{methoddesc}[Domain]{MPIBarrier}{}
373    executes barrier synchronization within
374    the \MPI processor group used by the \Domain.
375    If \MPI support is not enabled, this command does nothing.
376  \end{methoddesc}  \end{methoddesc}
377    
378  \subsection{\FunctionSpace class}  \subsection{\FunctionSpace class}
# Line 1124  saves the object to a matrix market form Line 1126  saves the object to a matrix market form
1126  \index{Matrix Market}  \index{Matrix Market}
1127  \end{methoddesc}  \end{methoddesc}
1128    
1129    \section{Utilities}
1130    \begin{funcdesc}{setEscriptParamInt}{name,value}
1131    assignes the ineger value \var{value} to the parameter \var{name}.
1132    If \var{name}="TOO_MANY_LINES" convertion of any \Data object to a string is switching to a
1133    condensed format if more than \var{value} lines would be created.
1134    \end{funcdesc}
1135    
1136    \begin{funcdesc}{getEscriptParamInt}{name}
1137    returns the current value of integer parameter \var{name}.
1138    \end{funcdesc}
1139    
1140    \begin{funcdesc}{listEscriptParams}{a}
1141    returns a list of valid parameters and their description.
1142    \end{funcdesc}
1143    
1144    \begin{funcdesc}{getMPISizeWorld}{}
1145    returns the number of \MPI processors in use in the \env{MPI_COMM_WORLD} processor group.
1146    If \MPI is not used 1 is returend.
1147    \end{funcdesc}
1148    \begin{funcdesc}{getMPIRankWorld}{}
1149    returns the rank of the process within the \env{MPI_COMM_WORLD} processor group.
1150    If \MPI is not used 0 is returend.
1151    \end{funcdesc}
1152    \begin{funcdesc}{MPIBarrierWorld}{}
1153    performs a barrier synchronization across all processors within \env{MPI_COMM_WORLD}
1154    processor group.
1155    \end{funcdesc}
1156    \begin{funcdesc}{getMPIWorldMax}{a}
1157    returns the maximum value of the interger \var{a} across all
1158    processors within \env{MPI_COMM_WORLD}.
1159    \end{funcdesc}

Legend:
Removed from v.2317  
changed lines
  Added in v.2318

  ViewVC Help
Powered by ViewVC 1.1.26