Commit 35ce681b authored by Matthieu Schaller's avatar Matthieu Schaller
Browse files

Post-merge fixes and doxygen documentation upgrades.

parent aab167b7
......@@ -772,6 +772,8 @@ INPUT += @top_srcdir@/src/cooling/const_lambda
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/tracers/EAGLE
# This tag can be used to specify the character encoding of the source files
......
......@@ -894,7 +894,8 @@ int main(int argc, char *argv[]) {
/* Initialise the star formation law and its properties */
if (with_star_formation)
starformation_init(params, &prog_const, &us, &hydro_properties, &starform);
starformation_init(params, &prog_const, &us, &hydro_properties,
&starform);
if (myrank == 0) starformation_print(&starform);
/* Initialise the chemistry */
......
......@@ -4057,11 +4057,13 @@ void engine_unpin(void) {
* @param physical_constants The #phys_const used for this run.
* @param cosmo The #cosmology used for this run.
* @param hydro The #hydro_props used for this run.
* @param entropy_floor The #entropy_floor_properties for this run.
* @param gravity The #gravity_props used for this run.
* @param stars The #stars_props used for this run.
* @param mesh The #pm_mesh used for the long-range periodic forces.
* @param potential The properties of the external potential.
* @param cooling_func The properties of the cooling function.
* @param starform The #star_formation model of this run.
* @param chemistry The chemistry information.
*/
void engine_init(struct engine *e, struct space *s, struct swift_params *params,
......
......@@ -1327,8 +1327,10 @@ void engine_link_gravity_tasks(struct engine *e) {
* @param density The density task to link.
* @param gradient The gradient task to link.
* @param force The force task to link.
* @param limiter The limiter task to link.
* @param c The cell.
* @param with_cooling Do we have a cooling task ?
* @param with_limiter Do we have a time-step limiter ?
*/
static inline void engine_make_hydro_loops_dependencies(
struct scheduler *sched, struct task *density, struct task *gradient,
......
......@@ -139,7 +139,8 @@ static INLINE float entropy_floor(
*
* @param params The YAML parameter file.
* @param us The system of units used internally.
* @param phys_cont The physical constants.
* @param phys_const The physical constants.
* @param hydro_props The propoerties of the hydro scheme.
* @param props The entropy floor properties to fill.
*/
static INLINE void entropy_floor_init(struct entropy_floor_properties *props,
......
......@@ -335,8 +335,9 @@ hydro_set_physical_internal_energy_dt(struct part *restrict p,
* @brief Sets the physical entropy of a particle
*
* @param p The particle of interest.
* @param xp The extended particle data.
* @param cosmo Cosmology data structure
* @param s The physical entropy
* @param entropy The physical entropy
*/
__attribute__((always_inline)) INLINE static void hydro_set_physical_entropy(
struct part *p, struct xpart *xp, const struct cosmology *cosmo,
......
......@@ -33,16 +33,17 @@
* @param parameter_file The parsed parameter file
* @param phys_const Physical constants in internal units
* @param us the current internal system of units
* @param s the #space we run in.
* @param hydro_props The propoerties of the hydro scheme.
* @param starform the properties of the star formation law
*/
void starformation_init(struct swift_params* parameter_file,
const struct phys_const* phys_const,
const struct unit_system* us,
const struct hydro_props *hydro_props,
const struct hydro_props* hydro_props,
struct star_formation* starform) {
starformation_init_backend(parameter_file, phys_const, us, hydro_props, starform);
starformation_init_backend(parameter_file, phys_const, us, hydro_props,
starform);
}
/**
......@@ -73,7 +74,7 @@ void starformation_struct_dump(const struct star_formation* starform,
* bytes.
*
* @param starform the star formation struct
* @param streeam the file stream
* @param stream the file stream
*/
void starformation_struct_restore(const struct star_formation* starform,
FILE* stream) {
......
......@@ -35,7 +35,14 @@
#include "stars.h"
#include "units.h"
/* Starformation struct */
/**
* @file src/starformation/schaye08/starformation.h
* @brief Entropy floor used in the EAGLE model
*/
/**
* @brief Properties of the EAGLE star formation model.
*/
struct star_formation {
/*! Normalization of the KS star formation law (internal units) */
......@@ -194,7 +201,7 @@ INLINE static int star_formation_potential_to_become_star(
/**
* @brief Calculates if the gas particle gets converted
*
* @param the #engine
* @param e the #engine
* @param starform the star formation law properties to use.
* @param p the gas particles.
* @param xp the additional properties of the gas particles.
......@@ -203,6 +210,8 @@ INLINE static int star_formation_potential_to_become_star(
* @param hydro_props The properties of the hydro scheme.
* @param us The internal system of units.
* @param cooling The cooling data struct.
* @param dt_star The time-step of this particle.
* @param with_cosmology Are we running with cosmology on?
*/
INLINE static int star_formation_convert_to_star(
const struct engine* e, const struct star_formation* starform,
......@@ -325,10 +334,10 @@ INLINE static void star_formation_copy_properties(
*
* @param parameter_file The parsed parameter file
* @param phys_const Physical constants in internal units
* @param us The current internal system of units
* @param us The current internal system of units.
* @param hydro_props The propertis of the hydro model.
* @param starform the star formation law properties to initialize
*
* */
*/
INLINE static void starformation_init_backend(
struct swift_params* parameter_file, const struct phys_const* phys_const,
const struct unit_system* us, const struct hydro_props* hydro_props,
......@@ -425,9 +434,9 @@ INLINE static void starformation_init_backend(
const float mean_molecular_weight = hydro_props->mu_neutral;
/* Calculate the EOS pressure normalization */
starform->EOS_pressure_norm = starform->EOS_density_norm *
starform->EOS_temperature_norm *
phys_const->const_boltzmann_k / mean_molecular_weight / X_H;
starform->EOS_pressure_norm =
starform->EOS_density_norm * starform->EOS_temperature_norm *
phys_const->const_boltzmann_k / mean_molecular_weight / X_H;
const double EOS_high_den_pressure =
starform->EOS_pressure_norm *
......
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