diff --git a/doc/Doxyfile.in b/doc/Doxyfile.in index 0df1f91194b6d1e7e98cb1b75be7d3eaaca7fc32..0193760d3114aecab91f0c2ad27a9c1dd77dec9a 100644 --- a/doc/Doxyfile.in +++ b/doc/Doxyfile.in @@ -1988,6 +1988,9 @@ INCLUDE_FILE_PATTERNS = # This tag requires that the tag ENABLE_PREPROCESSING is set to YES. PREDEFINED = "__attribute__(x)= " +PREDEFINED += HAVE_HDF5 +PREDEFINED += WITH_MPI +PREDEFINED += WITH_VECTORIZATION # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this # tag can be used to specify a list of macro names that should be expanded. The diff --git a/src/collectgroup.c b/src/collectgroup.c index 0b4ddc405772a45a1e444ef48b65fcb7d37a248f..b7e5486b59a2ec5e47b7b864071a2bb1e5ce1850 100644 --- a/src/collectgroup.c +++ b/src/collectgroup.c @@ -170,7 +170,7 @@ static void doreduce1(struct mpicollectgroup1 *mpigrp11, } /** - * @brief MPI reduce operator for #mpicollectgroup structures. + * @brief MPI reduce operator for #mpicollectgroup1 structures. */ static void mpicollectgroup1_reduce(void *in, void *inout, int *len, MPI_Datatype *datatype) { diff --git a/src/serial_io.c b/src/serial_io.c index a7e342f0a90fcf4c57f334526ff91b1923de4585..58237b49c331c34639eb5ae7ce79fd5272f73057 100644 --- a/src/serial_io.c +++ b/src/serial_io.c @@ -59,19 +59,15 @@ * @brief Reads a data array from a given HDF5 group. * * @param grp The group from which to read. - * @param name The name of the array to read. - * @param type The #DATA_TYPE of the attribute. - * @param N The number of particles. - * @param dim The dimension of the data (1 for scalar, 3 for vector) - * @param part_c A (char*) pointer on the first occurrence of the field of - *interest in the parts array - * @param partSize The size in bytes of the particle structure. - * @param importance If COMPULSORY, the data must be present in the IC file. If - *OPTIONAL, the array will be zeroed when the data is not present. + * @param props The #io_props of the field to read + * @param N The number of particles to read on this rank. + * @param N_total The total number of particles on all ranks. + * @param offset The offset position where this rank starts reading. + * @param internal_units The #unit_system used internally + * @param ic_units The #unit_system used in the ICs * * @todo A better version using HDF5 hyper-slabs to read the file directly into - *the part array - * will be written once the structures have been stabilized. + * the part array will be written once the structures have been stabilized. */ void readArray(hid_t grp, const struct io_props props, size_t N, long long N_total, long long offset, @@ -274,16 +270,17 @@ void prepareArray(struct engine* e, hid_t grp, char* fileName, FILE* xmfFile, * @param fileName The name of the file in which the data is written * @param xmfFile The FILE used to write the XMF description * @param partTypeGroupName The name of the group containing the particles in - *the HDF5 file. - * @param name The name of the array to write. - * @param type The #DATA_TYPE of the array. + * the HDF5 file. + * @param props The #io_props of the field to read * @param N The number of particles to write. - * @param dim The dimension of the data (1 for scalar, 3 for vector) - * @param part_c A (char*) pointer on the first occurrence of the field of - *interest in the parts array - * @param partSize The size in bytes of the particle structure. - * @param us The unit_system currently in use - * @param convFactor The UnitConversionFactor for this arrayo + * @param N_total The total number of particles on all ranks. + * @param offset The offset position where this rank starts writing. + * @param mpi_rank The MPI rank of this node + * @param internal_units The #unit_system used internally + * @param snapshot_units The #unit_system used in the snapshots + * + * @todo A better version using HDF5 hyper-slabs to write the file directly from + * the part array will be written once the structures have been stabilized. */ void writeArray(struct engine* e, hid_t grp, char* fileName, FILE* xmfFile, char* partTypeGroupName, const struct io_props props, size_t N, diff --git a/src/single_io.c b/src/single_io.c index 0b091a5997504e5f5a4cc3b8af7ca06c994e993c..2de42f8a170620c983f7992771f2bd03da80b5a7 100644 --- a/src/single_io.c +++ b/src/single_io.c @@ -64,8 +64,7 @@ * @param ic_units The #unit_system used in the ICs * * @todo A better version using HDF5 hyper-slabs to read the file directly into - *the part array - * will be written once the structures have been stabilized. + * the part array will be written once the structures have been stabilized. */ void readArray(hid_t h_grp, const struct io_props prop, size_t N, const struct unit_system* internal_units,