Commit 187fd16e authored by Matthieu Schaller's avatar Matthieu Schaller
Browse files

Small tweaks to the Doxygen documentation of the SF module.

parent 43be4281
......@@ -773,7 +773,7 @@ INPUT += @top_srcdir@/src/cooling/Compton
INPUT += @top_srcdir@/src/cooling/EAGLE
INPUT += @top_srcdir@/src/chemistry/EAGLE
INPUT += @top_srcdir@/src/entropy_floor/EAGLE
INPUT += @top_srcdir@/src/starformation/schaye08
INPUT += @top_srcdir@/src/star_formation/EAGLE
INPUT += @top_srcdir@/src/tracers/EAGLE
# This tag can be used to specify the character encoding of the source files
......
......@@ -1156,7 +1156,7 @@ void prepare_file(struct engine* e, const char* baseName, long long N_total[6],
num_fields += tracers_write_particles(parts, xparts, list + num_fields,
with_cosmology);
num_fields += star_formation_write_particles(
parts, xparts, list + num_fields, with_cosmology);
parts, xparts, list + num_fields);
if (with_stf) {
num_fields +=
velociraptor_write_parts(parts, xparts, list + num_fields);
......@@ -1479,7 +1479,7 @@ void write_output_parallel(struct engine* e, const char* baseName,
num_fields += tracers_write_particles(
parts, xparts, list + num_fields, with_cosmology);
num_fields += star_formation_write_particles(
parts, xparts, list + num_fields, with_cosmology);
parts, xparts, list + num_fields);
} else {
......@@ -1515,7 +1515,7 @@ void write_output_parallel(struct engine* e, const char* baseName,
num_fields += tracers_write_particles(
parts_written, xparts_written, list + num_fields, with_cosmology);
num_fields += star_formation_write_particles(
parts_written, xparts_written, list + num_fields, with_cosmology);
parts_written, xparts_written, list + num_fields);
}
} break;
......
......@@ -1124,7 +1124,7 @@ void write_output_serial(struct engine* e, const char* baseName,
num_fields += tracers_write_particles(
parts, xparts, list + num_fields, with_cosmology);
num_fields += star_formation_write_particles(
parts, xparts, list + num_fields, with_cosmology);
parts, xparts, list + num_fields);
} else {
......@@ -1161,8 +1161,8 @@ void write_output_serial(struct engine* e, const char* baseName,
tracers_write_particles(parts_written, xparts_written,
list + num_fields, with_cosmology);
num_fields += star_formation_write_particles(
parts_written, xparts_written, list + num_fields,
with_cosmology);
parts_written, xparts_written, list + num_fields);
}
} break;
......
......@@ -927,7 +927,8 @@ void write_output_single(struct engine* e, const char* baseName,
num_fields += tracers_write_particles(
parts, xparts, list + num_fields, with_cosmology);
num_fields += star_formation_write_particles(
parts, xparts, list + num_fields, with_cosmology);
parts, xparts, list + num_fields);
} else {
......@@ -963,7 +964,7 @@ void write_output_single(struct engine* e, const char* baseName,
num_fields += tracers_write_particles(
parts_written, xparts_written, list + num_fields, with_cosmology);
num_fields += star_formation_write_particles(
parts_written, xparts_written, list + num_fields, with_cosmology);
parts_written, xparts_written, list + num_fields);
}
} break;
......
......@@ -16,11 +16,11 @@
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
******************************************************************************/
#ifndef SWIFT_STARFORMATION_H
#define SWIFT_STARFORMATION_H
#ifndef SWIFT_STAR_FORMATION_H
#define SWIFT_STAR_FORMATION_H
/**
* @file src/starformation.h
* @file src/star_formation.h
* @brief Branches between the different star formation recipies.
*/
......@@ -52,4 +52,4 @@ void starformation_struct_dump(const struct star_formation* starform,
void starformation_struct_restore(const struct star_formation* starform,
FILE* stream);
#endif /* SWIFT_STARFORMATION_H */
#endif /* SWIFT_STAR_FORMATION_H */
......@@ -19,9 +19,6 @@
#ifndef SWIFT_EAGLE_STAR_FORMATION_H
#define SWIFT_EAGLE_STAR_FORMATION_H
/* Some standard headers */
#include <stdlib.h>
/* Local includes */
#include "adiabatic_index.h"
#include "cooling.h"
......@@ -36,8 +33,8 @@
#include "units.h"
/**
* @file src/starformation/schaye08/starformation.h
* @brief Entropy floor used in the EAGLE model
* @file src/star_formation/EAGLE/star_formation.h
* @brief Star formation model used in the EAGLE model
*/
/**
......
......@@ -35,8 +35,7 @@
* @return Returns the number of fields to write.
*/
__attribute__((always_inline)) INLINE static int star_formation_write_particles(
const struct part* parts, const struct xpart* xparts, struct io_props* list,
const int with_cosmology) {
const struct part* parts, const struct xpart* xparts, struct io_props* list) {
list[0] =
io_make_output_field("SFR", FLOAT, 1, UNIT_CONV_SFR, xparts, sf_data.SFR);
......
......@@ -20,7 +20,8 @@
#define SWIFT_EAGLE_STAR_FORMATION_STRUCT_H
/**
* @brief Properties of the tracers stored in the extended particle data.
* @brief Star-formation-related properties stored in the extended particle
* data.
*/
struct star_formation_xpart_data {
......
......@@ -35,8 +35,7 @@
* @return Returns the number of fields to write.
*/
__attribute__((always_inline)) INLINE static int star_formation_write_particles(
const struct part* parts, const struct xpart* xparts, struct io_props* list,
const int with_cosmology) {
const struct part* parts, const struct xpart* xparts, struct io_props* list) {
return 0;
}
......
......@@ -20,8 +20,8 @@
#define SWIFT_STAR_FORMATION_IO_H
/**
* @file src/sftracers_io.h
* @brief Branches between the different particle data star formation tracers
* @file src/star_formation_io.h
* @brief Branches between the i/o routines for the SF code.
*/
/* Config parameters. */
......
......@@ -20,8 +20,8 @@
#define SWIFT_STAR_FORMATION_STRUCT_H
/**
* @file src/tracers_struct.h
* @brief Branches between the different particle data tracers
* @file src/star_formation_struct.h
* @brief Branches between the different particle data SF tracers
*/
/* Config parameters. */
......
Supports Markdown
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