From 86db905578d599a4c953b32f4ba33ec55bccd1af Mon Sep 17 00:00:00 2001 From: Matthieu Schaller <schaller@strw.leidenuniv.nl> Date: Sat, 26 Oct 2019 15:25:29 +0200 Subject: [PATCH] Document the new function in space.c --- examples/main_fof.c | 3 +-- src/space.c | 7 +++++++ 2 files changed, 8 insertions(+), 2 deletions(-) diff --git a/examples/main_fof.c b/examples/main_fof.c index 98058e5c1a..e4b1318743 100644 --- a/examples/main_fof.c +++ b/examples/main_fof.c @@ -511,8 +511,7 @@ int main(int argc, char *argv[]) { space_init(&s, params, &cosmo, dim, parts, gparts, sparts, bparts, Ngas, Ngpart, Nspart, Nbpart, periodic, replicate, /*generate_gas_in_ics=*/0, /*hydro=*/N_total[0] > 0, /*gravity=*/1, - /*with_star_formation=*/0, with_DM_background_particles, - /*with_dithering=*/0, /*dithering_ratio=*/0., talking, + /*with_star_formation=*/0, with_DM_background_particles, talking, /*dry_run=*/0); if (myrank == 0) { diff --git a/src/space.c b/src/space.c index 55e1f65592..d515d7ac55 100644 --- a/src/space.c +++ b/src/space.c @@ -1141,6 +1141,13 @@ void space_allocate_extras(struct space *s, int verbose) { free(local_cells); } +/** + * @brief Compute a new dithering vector to apply to all the particles + * in the simulation. + * + * @param s The #space. + * @param verbose Are we talkative? + */ void space_dither(struct space *s, int verbose) { /* Store the old dithering vector */ -- GitLab