|
4 | 4 | #include "logging.h" |
5 | 5 | #include "timer.h" |
6 | 6 |
|
7 | | -//------------------------------------------------------------------------------------------------------- |
8 | | -// Function : yt_commit |
9 | | -// Description : Add local grids, append field list and particle list info to the libyt |
10 | | -// Python module. |
11 | | -// |
12 | | -// Note : 1. Must call yt_get_FieldsPtr (if num_fields>0), yt_get_ParticlesPtr (if |
13 | | -// num_par_types>0), |
14 | | -// yt_get_GridsPtr, which gets data info from user. |
15 | | -// 2. Check the local grids, field list, and particle list. |
16 | | -// 3. Append field_list info and particle_list info to |
17 | | -// libyt.param_yt['field_list'] and |
18 | | -// libyt.param_yt['particle_list']. |
19 | | -// 4. Gather hierarchy in different rank, and check hierarchy in |
20 | | -// check_hierarchy(), excluding |
21 | | -// particles. |
22 | | -// 5. If there is particle, we gather different particle type separately. |
23 | | -// 6. Pass the grids and hierarchy to YT in function append_grid(). |
24 | | -// 7. We assume that one grid contains all the fields belong to that grid. |
25 | | -// 8. Free LibytProcessControl::Get().param_yt_.grids_local, after we have |
26 | | -// passed all grid info and data in. |
27 | | -// 9. TODO: this can be more memory efficient when gathering hierarchy. |
28 | | -// |
29 | | -// Return : YT_SUCCESS or YT_FAIL |
30 | | -//------------------------------------------------------------------------------------------------------- |
| 7 | +/** |
| 8 | + * \defgroup api_yt_commit libyt API: yt_commit |
| 9 | + * \fn int yt_commit() |
| 10 | + * \brief |
| 11 | + * Add local grids, append field list and particle list info to the libyt Python module. |
| 12 | + * \details |
| 13 | + * 1. Must call \ref yt_get_FieldsPtr (if num_fields>0), |
| 14 | + * \ref yt_get_ParticlesPtr (if num_par_types>0), and \ref yt_get_GridsPtr. |
| 15 | + * 2. Call DataStructureAmr to bind info, bind hierarchy, and bind local data to Python. |
| 16 | + * |
| 17 | + * \version 0.1.0 |
| 18 | + * |
| 19 | + * @return \ref YT_SUCCESS or \ref YT_FAIL |
| 20 | + */ |
31 | 21 | int yt_commit() { |
32 | 22 | SET_TIMER(__PRETTY_FUNCTION__); |
33 | 23 |
|
|
0 commit comments