Commit ce522086 authored by Matthieu Schaller's avatar Matthieu Schaller

Fix many doxygen strings that have been broken in the last few months

parent 5122feb5
......@@ -2278,7 +2278,7 @@ void io_collect_gparts_background_to_write(
* verify that they are valid.
*
* @param output_options The #output_options for this run
* @param with_cosmolgy Ran with cosmology?
* @param with_cosmology Ran with cosmology?
* @param with_fof Are we running with on-the-fly Fof?
* @param with_stf Are we running with on-the-fly structure finder?
*/
......
......@@ -68,7 +68,6 @@
* @param e The #engine we are writing from.
* @param grp The group in which to write.
* @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 props The #io_props of the field to read
......
......@@ -40,6 +40,7 @@
* @param dt_drift The drift time-step.
* @param ti_old Integer start of time-step (for debugging checks).
* @param ti_current Integer end of time-step (for debugging checks).
* @param grav_props The properties of the gravity scheme.
*/
__attribute__((always_inline)) INLINE static void drift_gpart(
struct gpart *restrict gp, double dt_drift, integertime_t ti_old,
......
......@@ -3835,7 +3835,8 @@ static void engine_dumper_init(struct engine *e) {
* @param cooling_func The properties of the cooling function.
* @param starform The #star_formation model of this run.
* @param chemistry The chemistry information.
* @param fof_properties The #fof_props.
* @param fof_properties The #fof_props of this run.
* @param los_properties the #los_props of this run.
*/
void engine_init(struct engine *e, struct space *s, struct swift_params *params,
struct output_options *output_options, long long Ngas,
......
......@@ -1295,53 +1295,50 @@ void feedback_restore_tables(struct feedback_props* fp) {
*
* We simply free all the arrays.
*
* @param feedback_props the feedback data structure.
* @param fp the feedback data structure.
*/
void feedback_clean(struct feedback_props* feedback_props) {
swift_free("imf-tables", feedback_props->imf);
swift_free("imf-tables", feedback_props->imf_mass_bin);
swift_free("imf-tables", feedback_props->imf_mass_bin_log10);
swift_free("feedback-tables", feedback_props->yields_SNIa);
swift_free("feedback-tables", feedback_props->yield_SNIa_IMF_resampled);
swift_free("feedback-tables", feedback_props->yield_AGB.mass);
swift_free("feedback-tables", feedback_props->yield_AGB.metallicity);
swift_free("feedback-tables", feedback_props->yield_AGB.yield);
swift_free("feedback-tables", feedback_props->yield_AGB.yield_IMF_resampled);
swift_free("feedback-tables", feedback_props->yield_AGB.ejecta);
swift_free("feedback-tables", feedback_props->yield_AGB.ejecta_IMF_resampled);
swift_free("feedback-tables", feedback_props->yield_AGB.total_metals);
swift_free("feedback-tables",
feedback_props->yield_AGB.total_metals_IMF_resampled);
swift_free("feedback-tables", feedback_props->yield_SNII.mass);
swift_free("feedback-tables", feedback_props->yield_SNII.metallicity);
swift_free("feedback-tables", feedback_props->yield_SNII.yield);
swift_free("feedback-tables", feedback_props->yield_SNII.yield_IMF_resampled);
swift_free("feedback-tables", feedback_props->yield_SNII.ejecta);
swift_free("feedback-tables",
feedback_props->yield_SNII.ejecta_IMF_resampled);
swift_free("feedback-tables", feedback_props->yield_SNII.total_metals);
swift_free("feedback-tables",
feedback_props->yield_SNII.total_metals_IMF_resampled);
swift_free("feedback-tables", feedback_props->lifetimes.mass);
swift_free("feedback-tables", feedback_props->lifetimes.metallicity);
swift_free("feedback-tables", feedback_props->yield_mass_bins);
void feedback_clean(struct feedback_props* fp) {
swift_free("imf-tables", fp->imf);
swift_free("imf-tables", fp->imf_mass_bin);
swift_free("imf-tables", fp->imf_mass_bin_log10);
swift_free("feedback-tables", fp->yields_SNIa);
swift_free("feedback-tables", fp->yield_SNIa_IMF_resampled);
swift_free("feedback-tables", fp->yield_AGB.mass);
swift_free("feedback-tables", fp->yield_AGB.metallicity);
swift_free("feedback-tables", fp->yield_AGB.yield);
swift_free("feedback-tables", fp->yield_AGB.yield_IMF_resampled);
swift_free("feedback-tables", fp->yield_AGB.ejecta);
swift_free("feedback-tables", fp->yield_AGB.ejecta_IMF_resampled);
swift_free("feedback-tables", fp->yield_AGB.total_metals);
swift_free("feedback-tables", fp->yield_AGB.total_metals_IMF_resampled);
swift_free("feedback-tables", fp->yield_SNII.mass);
swift_free("feedback-tables", fp->yield_SNII.metallicity);
swift_free("feedback-tables", fp->yield_SNII.yield);
swift_free("feedback-tables", fp->yield_SNII.yield_IMF_resampled);
swift_free("feedback-tables", fp->yield_SNII.ejecta);
swift_free("feedback-tables", fp->yield_SNII.ejecta_IMF_resampled);
swift_free("feedback-tables", fp->yield_SNII.total_metals);
swift_free("feedback-tables", fp->yield_SNII.total_metals_IMF_resampled);
swift_free("feedback-tables", fp->lifetimes.mass);
swift_free("feedback-tables", fp->lifetimes.metallicity);
swift_free("feedback-tables", fp->yield_mass_bins);
for (int i = 0; i < eagle_feedback_lifetime_N_metals; i++) {
free(feedback_props->lifetimes.dyingtime[i]);
free(fp->lifetimes.dyingtime[i]);
}
free(feedback_props->lifetimes.dyingtime);
free(fp->lifetimes.dyingtime);
for (int i = 0; i < eagle_feedback_SNIa_N_elements; i++) {
free(feedback_props->SNIa_element_names[i]);
free(fp->SNIa_element_names[i]);
}
free(feedback_props->SNIa_element_names);
free(fp->SNIa_element_names);
for (int i = 0; i < eagle_feedback_SNII_N_elements; i++) {
free(feedback_props->SNII_element_names[i]);
free(fp->SNII_element_names[i]);
}
free(feedback_props->SNII_element_names);
free(fp->SNII_element_names);
for (int i = 0; i < eagle_feedback_AGB_N_elements; i++) {
free(feedback_props->AGB_element_names[i]);
free(fp->AGB_element_names[i]);
}
free(feedback_props->AGB_element_names);
free(fp->AGB_element_names);
}
/**
......
......@@ -280,7 +280,7 @@ __attribute__((always_inline)) INLINE static int feedback_will_do_feedback(
}
}
void feedback_clean(struct feedback_props* feedback_props);
void feedback_clean(struct feedback_props* fp);
void feedback_struct_dump(const struct feedback_props* feedback, FILE* stream);
......
......@@ -178,9 +178,9 @@ __attribute__((always_inline)) INLINE static int feedback_will_do_feedback(
*
* We simply free all the arrays.
*
* @param feedback_props the feedback data structure.
* @param fp the feedback data structure.
*/
static INLINE void feedback_clean(struct feedback_props* feedback_props) {}
static INLINE void feedback_clean(struct feedback_props* fp) {}
/**
* @brief Write a feedback struct to the given FILE as a stream of bytes.
......
......@@ -195,7 +195,10 @@ kernel_long_grav_derivatives(const float r, const float r_s_inv,
* range [0, 5] of r_over_r_s.
* The accuracy is much better in the range [0, 2] (6e-5 and 2e-5 respectively).
*
* @param u The ratio of the distance to the FFT cell scale \f$u = r/r_s\f$.
* @param r_over_r_s The ratio of the distance to the FFT cell scale \f$u =
* r/r_s\f$.
* @param corr_f (return) The correction for the force term.
* @param corr_pot (return) The correction for the potential term.
*/
__attribute__((always_inline, nonnull)) INLINE static void
kernel_long_grav_eval(const float r_over_r_s, float *restrict corr_f,
......
......@@ -186,8 +186,10 @@ void create_sightline(const double Xpos, const double Ypos,
*
* Independent sightlines are made for the XY, YZ and XZ planes.
*
* @param LOS Structure to store sightlines.
* @param Los Structure to store sightlines.
* @param params Sightline parameters.
* @param periodic Is this calculation using periodic BCs.
* @param dim The dimension of the volume along the three axis.
*/
void generate_sightlines(struct line_of_sight *Los,
const struct los_props *params, const int periodic,
......@@ -253,9 +255,10 @@ void generate_sightlines(struct line_of_sight *Los,
}
/**
* @brief Print line_of_sight information.
* @brief Print #line_of_sight information.
*
* @param Los Structure to print.
* @param i The index of the #line_of_sight to dump.
*/
void print_los_info(const struct line_of_sight *Los, const int i) {
......@@ -269,7 +272,7 @@ void print_los_info(const struct line_of_sight *Los, const int i) {
/**
* @brief Writes dataset for a given part attribute.
*
* @param p io_props dataset for this attribute.
* @param props dataset for this attribute.
* @param N number of parts in this line of sight.
* @param j Line of sight ID.
* @param e The engine.
......@@ -467,6 +470,7 @@ void write_los_hdf5_datasets(hid_t grp, const int j, const size_t N,
* @param h_file HDF5 file reference.
* @param e The engine.
* @param LOS_params The line of sight params.
* @param total_num_parts_in_los The total number of particles in all the LoS.
*/
void write_hdf5_header(hid_t h_file, const struct engine *e,
const struct los_props *LOS_params,
......@@ -625,10 +629,18 @@ void los_first_loop_mapper(void *restrict map_data, int count,
*
* @param e The engine.
* @param los The line_of_sight structure.
* @param los_cells_top (return) Array indicating whether this cell is
* intersected.
* @param cells The array of top-level cells.
* @param local_cells_with_particles The list of local non-empty top-level
* cells.
* @param nr_local_cells_with_particles The number of local non-empty top-level
* cells.
*/
void find_intersecting_top_level_cells(
const struct engine *e, struct line_of_sight *los, int *los_cells_top,
const struct cell *cells, const int *local_cells_with_particles,
const struct engine *e, struct line_of_sight *los,
int *restrict los_cells_top, const struct cell *cells,
const int *restrict local_cells_with_particles,
const int nr_local_cells_with_particles) {
/* Keep track of how many top level cells we intersect. */
......@@ -662,11 +674,11 @@ void find_intersecting_top_level_cells(
* 1) Construct N random line of sight positions.
* 2) Loop over each line of sight.
* - 2.1) Find which top level cells sightline intersects.
* - 2.2) Loop over each part in these top level cells to see which intersect
* - 2.2) Loop over each part in these top level cells to see which intersect
* sightline.
* - 2.3) Use this count to construct a LOS parts/xparts array.
* - 2.4) Loop over each part and extract those in sightline to new array.
* - 2.5) Save sightline parts to HDF5 file.
* - 2.3) Use this count to construct a LOS parts/xparts array.
* - 2.4) Loop over each part and extract those in sightline to new array.
* - 2.5) Save sightline parts to HDF5 file.
*
* @param e The engine.
*/
......
......@@ -675,7 +675,7 @@ void pm_mesh_interpolate_forces(const struct pm_mesh* mesh,
}
/**
* @bried Allocates the potential grid to be ready for an FFT calculation
* @brief Allocates the potential grid to be ready for an FFT calculation
*
* @param mesh The #pm_mesh structure.
*/
......
......@@ -2091,7 +2091,7 @@ __attribute__((nonnull)) INLINE static void gravity_M2L_symmetric(
* equivalent.
*
* @param l_b The field tensor to compute.
* @param ga The @gpart sourcing the field.
* @param ga The #gpart sourcing the field.
* @param pos_b The position of field tensor b.
* @param props The #gravity_props of this calculation.
* @param periodic Is the calculation periodic ?
......
......@@ -83,7 +83,7 @@ void output_options_init(struct swift_params* parameter_file, int mpi_rank,
}
/**
* @breif Destroys an output_options instance.
* @brief Destroys an output_options instance.
*
* @param output_options the output_options struct to free the contents of.
**/
......
......@@ -1277,9 +1277,10 @@ void parser_struct_restore(const struct swift_params *params, FILE *stream) {
* If the section could not be found, -1 is returned.
*
* @param params The swift_params struct in which to locate the section.
* @param section_name The section name to locate.
* @param name The section name to locate.
*/
int parser_get_section_id(const struct swift_params *params, const char *name) {
for (int section_id = 0; section_id < params->sectionCount; section_id++) {
/* Get the name of current section, *without* a trailing colon */
char section_name[FIELD_BUFFER_SIZE];
......@@ -1289,4 +1290,4 @@ int parser_get_section_id(const struct swift_params *params, const char *name) {
if (strcmp(section_name, name) == 0) return section_id;
}
return -1;
}
\ No newline at end of file
}
......@@ -158,7 +158,7 @@ void runner_do_grav_down(struct runner *r, struct cell *c, int timer) {
* @param gcount_i The number of particles receiving forces.
* @param gparts_j The particles giving forces (at any level).
* @param gcount_j The number of particles giving forces.
* @param e The @engine structure.
* @param e The #engine structure.
* @param grav_props The properties of the gravity scheme.
* @param cache_i The gravity cache to use to store the results in i.
* @param ci The (leaf-)cell containing the particles i.
......@@ -341,7 +341,7 @@ static INLINE void runner_dopair_grav_pp_full_no_cache(
* @param gparts_j The particles giving forces (at any level).
* @param gcount_j The number of particles giving forces.
* @param dim The size of the computational domain.
* @param e The @engine structure.
* @param e The #engine structure.
* @param grav_props The properties of the gravity scheme.
* @param cache_i The gravity cache to use to store the results in i.
* @param ci The (leaf-)cell containing the particles i.
......
......@@ -156,8 +156,8 @@ static INLINE void tracers_after_feedback(struct xpart *xp) {
* @param with_cosmology Are we running with cosmology?
* @param scale_factor The current scale-factor (if running with cosmo)
* @param time The current time (if running without cosmo)
* @param Amount of energy injected in the feedback event (internal physical
* units)
* @param delta_energy Amount of energy injected in the feedback event
* (internal physical units)
*/
static INLINE void tracers_after_black_holes_feedback(
struct xpart *xp, const int with_cosmology, const float scale_factor,
......
......@@ -60,7 +60,9 @@ float optimized_erfcf(const float x) {
*
* @param a First value
* @param b Second value
* @param s String used to identify this check in messages
* @param rel_tol Relative tolerance
* @param abs_tol Absolute tolerance
* @param x Value for which we tested the function (for error messages)
*/
void check_value(const double a, const double b, const double rel_tol,
const double abs_tol, const double x) {
......
......@@ -30,7 +30,8 @@
*
* @param a First value
* @param b Second value
* @param s String used to identify this check in messages
* @param tol Relative tolerance
* @param x Value for which we tested the function (for error messages)
*/
void check_value(double a, double b, const double tol, const double x) {
if (fabs(a - b) / fabs(a + b) > tol)
......
......@@ -33,6 +33,9 @@ const int num_tests = 1 << 10;
* @param a First value
* @param b Second value
* @param s String used to identify this check in messages
* @param tol Relative tolerance.
* @param r Distance tested (for error messages).
* @param r_s Mesh size tested (for error messages).
*/
void check_value(double a, double b, const char* s, const double tol,
const double r, const double r_s) {
......
......@@ -159,8 +159,9 @@ int main(int argc, char *argv[]) {
/* check output selection */
message("Checking output parameters.");
io_prepare_output_fields(&output_options, /*with_cosmology=*/0, /*with_fof=*/0,
/*with_structure_finding=*/0);
io_prepare_output_fields(&output_options, /*with_cosmology=*/0,
/*with_fof=*/0,
/*with_structure_finding=*/0);
/* write output file */
message("Writing output.");
......
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