1 /* Copyright (c) 2004-2021. The SimGrid Team. All rights reserved. */
3 /* This program is free software; you can redistribute it and/or modify it
4 * under the terms of the license (GNU LGPL) which comes with this package. */
9 #include "simgrid/forward.h"
11 /*** SURF Globals **************************/
13 /** @ingroup SURF_simulation
14 * @brief Initialize SURF
15 * @param argc argument number
16 * @param argv arguments
18 * This function has to be called to initialize the common structures. Then you will have to create the environment by
19 * calling e.g. surf_host_model_init_CM02()
21 * @see surf_host_model_init_CM02(), surf_host_model_init_compound(), surf_exit()
23 XBT_PUBLIC void surf_init(int* argc, char** argv); /* initialize common structures */
25 /** @ingroup SURF_simulation
26 * @brief Finish simulation initialization
28 * This function must be called before the first call to surf_solve()
30 XBT_PUBLIC void surf_presolve();
32 /** @ingroup SURF_simulation
33 * @brief Performs a part of the simulation
34 * @param max_date Maximum date to update the simulation to, or -1
35 * @return the elapsed time, or -1.0 if no event could be executed
37 * This function execute all possible events, update the action states and returns the time elapsed.
38 * When you call execute or communicate on a model, the corresponding actions are not executed immediately but only
39 * when you call surf_solve.
40 * Note that the returned elapsed time can be zero.
42 XBT_PUBLIC double surf_solve(double max_date);
44 /** @ingroup SURF_simulation
45 * @brief Return the current time
47 * Return the current time in millisecond.
49 XBT_PUBLIC double surf_get_clock();
51 /** @ingroup SURF_simulation
58 XBT_PUBLIC void surf_exit();
60 /* surf parse file related (public because called from a test suite) */
61 XBT_PUBLIC void parse_platform_file(const std::string& file);