minor revisions of initialization text
authorPritish Jetley <pjetley2@illinois.edu>
Wed, 8 Aug 2012 17:19:17 +0000 (13:19 -0400)
committerPritish Jetley <pjetley2@illinois.edu>
Wed, 8 Aug 2012 17:19:17 +0000 (13:19 -0400)
doc/charm++/othercalls.tex
doc/charm++/startuporder.tex

index 15d561fbd525cdb412d8f8ce61a6b0aecd55313d..20764919750f1738c7fcbb48ddba50007272a9b9 100644 (file)
@@ -5,7 +5,7 @@
 Some registration routines need be executed exactly once
 before the computation begins. You may choose to 
 declare a regular  \CC\ subroutine \kw{initnode} in the .ci file
-to ask \charmpp to execute the routine exactly once on {\em every node} 
+to ask \charmpp{} to execute the routine exactly once on {\em every logical node} 
 before the computation begins, or to declare a regular  \CC\ subroutine 
 \kw{initproc} to be executed exactly once on {\em every processor}.
 
@@ -22,17 +22,21 @@ module foo \{
 \end{alltt}
 
 This code will execute the routines \uw{fooNodeInit} and static 
-\uw{bar::barNodeInit} once on every node and \uw{fooProcInit}
+\uw{bar::barNodeInit} once on every logical node and \uw{fooProcInit}
 and \uw{bar::barProcInit} on every processor before the main computation 
 starts.
 Initnode calls are always executed before initproc calls.
-Both init calls (declared as static member function) can be used in chare
-group or chare arrays.
+Both init calls (declared as static member functions) can be used in chares
+chare arrays and groups.
 
-Note that these routines should only do registration, not computation since
-Charm run-time initialization does not start yet ---
-use a mainchare instead, which gets executed on only processor 0,
-to begin the computation.  Initcall routines are typically
-used to do special registrations and global variable setup
-before the computation actually begins.
+Note that these routines should only implement registration and startup functionality, 
+and not parallel computation, since
+the \charmpp{} run time system will not have started up fully when they are invoked. 
+%does not start yet ---
+In order to begin the parallel computation, you should 
+use a mainchare instead, which gets executed on only PE 0.
+%to begin the computation.  
+%Initcall routines are typically
+%used to do special registrations and global variable setup
+%before the computation actually begins.
 
index 27b60aff30edb0ac70eb3b85cefe9f6ccfc8045a..49878fa4bf785109c656bb08fb4d51112297e2af 100644 (file)
@@ -7,12 +7,13 @@
 %what assumptions can user program make about entity availability:
 %ie groups are available in any chare array constructor, but not vice versa etc.
 
-The \charmpp{} program starts with the following sequence:
+%A \charmpp{} program starts with the following sequence:
+At startup, every \charmpp{} program performs the following actions, in sequence:
 \begin{enumerate}
-\item Modules Registration: the modules are registered in the same order with
-their specified order at the linking stage of the program compilation.
-For example, if "-module A -module B" is specified for \charmpp{} program
-linking, then module A is registered before module B at runtime.
+\item Module Registration: all modules given in the \kw{.ci} files are registered in the order
+of their specification in the linking stage of program compilation.
+For example, if you specified "{\tt -module A -module B}" while linking your \charmpp{} program,
+then module {\tt A} is registered before module {\tt B} at runtime.
 
 \item \kw{initnode},\kw{initproc} Calls: all those calls are invoked before the
 creation of other \charmpp{} data structures and the invocation of every