]> AND Public Git Repository - simgrid.git/blobdiff - doc/doxygen/module-surf.doc
Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Factorize CMakeLists
[simgrid.git] / doc / doxygen / module-surf.doc
index 4cc3c6cae05b033cd65f03281a221b48c0c3a201..1d4aad03fb60f4e81a36f3300f7dd69b2a023f1d 100644 (file)
@@ -1,5 +1,5 @@
 /** @addtogroup SURF_API
-  
+
   @section SURF_doc Surf documentation
    Surf is composed several components:
    - @ref SURF_simulation
@@ -15,7 +15,7 @@
    - @ref SURF_lmm
    - @ref SURF_callbacks
    - @ref plugin_energy
-   
+
 
 */
 
@@ -48,8 +48,8 @@
     #surf_host_model_init_current_default() (which will give you a
     CLM03 model), or similar (see @ref SURF_models).
 
-    To initialize SURF, call #surf_init(). Then
-    #surf_host_model_init_current_default() or #surf_host_model_init_ptask_L07() 
+    To initialize SURF, call
+    #surf_host_model_init_current_default() or #surf_host_model_init_ptask_L07()
     to create the platform.
 
     Then you can access the hosts with the @ref simgrid::s4u::Engine::get_all_hosts.
     a new action that represents the task you have just created.
 
     To execute the actions created with @a execute(), @a communicate() or @a execute_parallel_task(), call
-    surf_solve(). The function surf_solve() is where the simulation takes place. It returns the
+    EngineImpl::solve(). This function is where the simulation takes place. It returns the
     time elapsed to execute the actions. You can know what actions have changed their state thanks
     to the states sets. For example, if your want to know what actions are finished,
     extract them from @a surf_host_model->common_public->states.done_action_set.
-    Depending on these results, you can schedule other tasks and call surf_solve() again.
+    Depending on these results, you can schedule other tasks and call solve() again.
 
     Have a look at the implementation of @ref MSG_API "MSG" and @ref SD_API "Simdag" to see how these module
     interact with SURF. But if you want to create a new API on top of SURF,