Commit 1dc4b908 authored by Matthieu Schaller's avatar Matthieu Schaller
Browse files

Documentation of the new i/o function parameters.

parent 6418b3dc
...@@ -692,6 +692,7 @@ void io_duplicate_hydro_gparts_mapper(void* restrict data, int Ngas, ...@@ -692,6 +692,7 @@ void io_duplicate_hydro_gparts_mapper(void* restrict data, int Ngas,
* This function assumes that the DM particles are all at the start of the * This function assumes that the DM particles are all at the start of the
* gparts array and adds the hydro particles afterwards * gparts array and adds the hydro particles afterwards
* *
* @param tp The current #threadpool.
* @param parts The array of #part freshly read in. * @param parts The array of #part freshly read in.
* @param gparts The array of #gpart freshly read in with all the DM particles * @param gparts The array of #gpart freshly read in with all the DM particles
* at the start * at the start
...@@ -747,6 +748,7 @@ void io_duplicate_hydro_sparts_mapper(void* restrict data, int Nstars, ...@@ -747,6 +748,7 @@ void io_duplicate_hydro_sparts_mapper(void* restrict data, int Nstars,
* This function assumes that the DM particles and gas particles are all at * This function assumes that the DM particles and gas particles are all at
* the start of the gparts array and adds the star particles afterwards * the start of the gparts array and adds the star particles afterwards
* *
* @param tp The current #threadpool.
* @param sparts The array of #spart freshly read in. * @param sparts The array of #spart freshly read in.
* @param gparts The array of #gpart freshly read in with all the DM and gas * @param gparts The array of #gpart freshly read in with all the DM and gas
* particles at the start. * particles at the start.
......
...@@ -530,6 +530,7 @@ void writeArray(struct engine* e, hid_t grp, char* fileName, FILE* xmfFile, ...@@ -530,6 +530,7 @@ void writeArray(struct engine* e, hid_t grp, char* fileName, FILE* xmfFile,
* @param mpi_size The number of MPI ranks * @param mpi_size The number of MPI ranks
* @param comm The MPI communicator * @param comm The MPI communicator
* @param info The MPI information object * @param info The MPI information object
* @param n_threads The number of threads to use for local operations.
* @param dry_run If 1, don't read the particle. Only allocates the arrays. * @param dry_run If 1, don't read the particle. Only allocates the arrays.
* *
*/ */
......
...@@ -380,6 +380,7 @@ void writeArray(const struct engine* e, hid_t grp, char* fileName, ...@@ -380,6 +380,7 @@ void writeArray(const struct engine* e, hid_t grp, char* fileName,
* @param mpi_size The number of MPI ranks * @param mpi_size The number of MPI ranks
* @param comm The MPI communicator * @param comm The MPI communicator
* @param info The MPI information object * @param info The MPI information object
* @param n_threads The number of threads to use for local operations.
* @param dry_run If 1, don't read the particle. Only allocates the arrays. * @param dry_run If 1, don't read the particle. Only allocates the arrays.
* *
* Opens the HDF5 file fileName and reads the particles contained * Opens the HDF5 file fileName and reads the particles contained
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment