Skip to content
Snippets Groups Projects
Commit e4ec5948 authored by Matthieu Schaller's avatar Matthieu Schaller
Browse files

Merge branch 'darwin/sink_update_function_doc' into 'master' 

Sink : Update functions documentation

See merge request !1970
parents 3d13c29e 081fa376
Branches
Tags
10 merge requests!2165Merge master,!2060Skip when not in a git repo,!1998Augment the i/o meta-data to inform whether fields are stored in physical and...,!1997Yet another master into zoom buffer branch merge (with formatting all done!),!1994Draft: Testing master -> zoom merge,!1991looking fix GCC 14,!1990Update looking for gcc 14,!1987Update zoom_merge with master updates (after wrangling immense conflicts),!1982Update zoom merge branch with latest master developments,!1970Sink : Update functions documentation
Hide whitespace changes
Inline Side-by-side
src/sink/Default/sink.h
+ 37
− 28
View file @ e4ec5948
......@@ -59,6 +59,7 @@ INLINE static void sink_update_target_mass(struct sink* sink,
*
* @param sp The particle to act upon
* @param sink_props The properties of the sink particles scheme.
* @param e The #engine
*/
__attribute__((always_inline)) INLINE static void sink_first_init_sink(
struct sink* sp, const struct sink_props* sink_props,
......@@ -67,7 +68,8 @@ __attribute__((always_inline)) INLINE static void sink_first_init_sink(
/**
* @brief Prepares a particle for the sink calculation.
*
* @param p The particle to act upon
* @param p The #part to act upon.
* @param sink_props The properties of the sink particles scheme.
*/
__attribute__((always_inline)) INLINE static void sink_init_part(
struct part* restrict p, const struct sink_props* sink_props) {}
......@@ -75,7 +77,7 @@ __attribute__((always_inline)) INLINE static void sink_init_part(
/**
* @brief Prepares a sink-particle for its interactions
*
* @param sp The particle to act upon
* @param sp The #sink particle to act upon.
*/
__attribute__((always_inline)) INLINE static void sink_init_sink(
struct sink* sp) {}
......@@ -83,7 +85,7 @@ __attribute__((always_inline)) INLINE static void sink_init_sink(
/**
* @brief Predict additional particle fields forward in time when drifting
*
* @param sp The particle
* @param sp The #sink.
* @param dt_drift The drift time-step for positions.
*/
__attribute__((always_inline)) INLINE static void sink_predict_extra(
......@@ -93,7 +95,7 @@ __attribute__((always_inline)) INLINE static void sink_predict_extra(
* @brief Sets the values to be predicted in the drifts to their values at a
* kick time
*
* @param sp The particle.
* @param sp The #sink particle.
*/
__attribute__((always_inline)) INLINE static void sink_reset_predicted_values(
struct sink* restrict sp) {}
......@@ -101,7 +103,7 @@ __attribute__((always_inline)) INLINE static void sink_reset_predicted_values(
/**
* @brief Kick the additional variables
*
* @param sp The particle to act upon
* @param sp The #sink particle to act upon
* @param dt The time-step for this kick
*/
__attribute__((always_inline)) INLINE static void sink_kick_extra(
......@@ -114,14 +116,15 @@ __attribute__((always_inline)) INLINE static void sink_kick_extra(
* Return 0 if no sink formation should occur.
* Note: called in runner_do_sink_formation
*
* @param sink_props the sink properties to use.
* @param p the gas particles.
* @param xp the additional properties of the gas particles.
* @param sink_props the sink properties to use.
* @param phys_const the physical constants in internal units.
* @param cosmo the cosmological parameters and properties.
* @param hydro_props The properties of the hydro scheme.
* @param us The internal system of units.
* @param cooling The cooling data struct.
* @param entropy_floor The entropy_floor properties.
*
*/
INLINE static int sink_is_forming(
......@@ -164,14 +167,17 @@ INLINE static int sink_should_convert_to_sink(
*
* Nothing to do here.
*
* @param e The #engine
* @param p the gas particles.
* @param xp the additional properties of the gas particles.
* @param sink the new created sink particle with its properties.
* @param sink_props the sink properties to use.
* @param phys_const the physical constants in internal units.
* @param p The gas particles.
* @param xp The additional properties of the gas particles.
* @param sink the new created #sink particle.
* @param e The #engine.
* @param sink_props The sink properties to use.
* @param cosmo the cosmological parameters and properties.
* @param with_cosmology if we run with cosmology.
* @param phys_const The physical constants in internal units.
* @param hydro_props The hydro properties to use.
* @param us The internal unit system.
* @param cooling The cooling function to use.
*/
INLINE static void sink_copy_properties(
const struct part* p, const struct xpart* xp, struct sink* sink,
......@@ -202,9 +208,6 @@ __attribute__((always_inline)) INLINE static void sink_swallow_part(
* @param spi The #sink to update.
* @param spj The #sink that is swallowed.
* @param cosmo The current cosmological model.
* @param time Time since the start of the simulation (non-cosmo mode).
* @param with_cosmology Are we running with cosmology?
* @param props The properties of the black hole scheme.
*/
__attribute__((always_inline)) INLINE static void sink_swallow_sink(
struct sink* spi, const struct sink* spj, const struct cosmology* cosmo) {}
......@@ -214,12 +217,12 @@ __attribute__((always_inline)) INLINE static void sink_swallow_sink(
*
* Nothing to do here.
*
* @param e The #engine
* @param sink the sink particle.
* @param sink_props the sink properties to use.
* @param phys_const the physical constants in internal units.
* @param cosmo the cosmological parameters and properties.
* @param with_cosmology if we run with cosmology.
* @param e The #engine
* @param sink_props The sink properties to use.
* @param cosmo The cosmological parameters and properties.
* @param with_cosmology If we run with cosmology.
* @param phys_const The physical constants in internal units.
* @param us The internal unit system.
*/
INLINE static int sink_spawn_star(struct sink* sink, const struct engine* e,
......@@ -237,13 +240,13 @@ INLINE static int sink_spawn_star(struct sink* sink, const struct engine* e,
*
* Nothing to do here.
*
* @param e The #engine
* @param sink the sink particle.
* @param sink The #sink particle.
* @param sp The star particle.
* @param sink_props the sink properties to use.
* @param phys_const the physical constants in internal units.
* @param cosmo the cosmological parameters and properties.
* @param with_cosmology if we run with cosmology.
* @param e The #engine
* @param sink_props The sink properties to use.
* @param cosmo The cosmological parameters and properties.
* @param with_cosmology If we run with cosmology.
* @param phys_const The physical constants in internal units.
* @param us The internal unit system.
*/
INLINE static void sink_copy_properties_to_star(
......@@ -267,12 +270,15 @@ __attribute__((always_inline)) INLINE static void sink_store_potential_in_part(
* kinetic energy, potential energy, etc. This function works on the
* neighbouring gas particles.
*
* Nothing to do here.
*
* @param e The #engine.
* @param c The #cell.
* @param p The #part for which we compute the quantities.
* @param xp The #xpart data of the particle #p.
* @param pi A neighbouring #part of #p.
* @param xpi The #xpart data of the particle #pi.
* @param cosmo The cosmological parameters and properties.
* @param sink_props The sink properties to use.
*/
INLINE static void sink_prepare_part_sink_formation_gas_criteria(
struct engine* e, struct part* restrict p, struct xpart* restrict xp,
......@@ -283,11 +289,14 @@ INLINE static void sink_prepare_part_sink_formation_gas_criteria(
* @brief Compute all quantities required for the formation of a sink. This
* function works on the neighbouring sink particles.
*
* Nothing to do here.
*
* @param e The #engine.
* @param c The #cell.
* @param p The #part for which we compute the quantities.
* @param xp The #xpart data of the particle #p.
* @param si A neighbouring #sink of #p.
* @param cosmo The cosmological parameters and properties.
* @param sink_props The sink properties to use.
*/
INLINE static void sink_prepare_part_sink_formation_sink_criteria(
struct engine* e, struct part* restrict p, struct xpart* restrict xp,
......
src/sink/GEAR/sink.h
+ 42
− 30
View file @ e4ec5948
......@@ -45,18 +45,19 @@ __attribute__((always_inline)) INLINE static float sink_compute_timestep(
/**
* @brief Update the target mass of the sink particle.
*
* @param e The #engine
* @param sink the sink particle.
* @param sink_props the sink properties to use.
* @param phys_const the physical constants in internal units.
* @param cosmo the cosmological parameters and properties.
* @param e The #engine
* @param star_counter The star loop counter.
*/
INLINE static void sink_update_target_mass(struct sink* sink,
const struct sink_props* sink_props,
const struct engine* e, int rloop) {
const struct engine* e,
int star_counter) {
float random_number = random_unit_interval_part_ID_and_index(
sink->id, rloop, e->ti_current, random_number_sink_formation);
sink->id, star_counter, e->ti_current, random_number_sink_formation);
const struct feedback_props* feedback_props = e->feedback_props;
......@@ -86,7 +87,8 @@ INLINE static void sink_update_target_mass(struct sink* sink,
} else {
// we are dealing with the discrete part of the IMF
random_number = random_unit_interval_part_ID_and_index(
sink->id, rloop + 1, e->ti_current, random_number_sink_formation);
sink->id, star_counter + 1, e->ti_current,
random_number_sink_formation);
double m = initial_mass_function_sample_power_law(
minimal_discrete_mass, imf->mass_max, imf->exp[imf->n_parts - 1],
random_number);
......@@ -101,8 +103,9 @@ INLINE static void sink_update_target_mass(struct sink* sink,
* This function is called only once just after the ICs have been
* read in to do some conversions.
*
* @param sp The particle to act upon
* @param sp The #sink particle to act upon.
* @param sink_props The properties of the sink particles scheme.
* @param e The #engine
*/
__attribute__((always_inline)) INLINE static void sink_first_init_sink(
struct sink* sp, const struct sink_props* sink_props,
......@@ -132,7 +135,8 @@ __attribute__((always_inline)) INLINE static void sink_first_init_sink(
* @brief Initialisation of particle data before the hydro density loop.
* Note: during initalisation (space_init)
*
* @param p The particle to act upon
* @param p The #part to act upon.
* @param sink_props The properties of the sink particles scheme.
*/
__attribute__((always_inline)) INLINE static void sink_init_part(
struct part* restrict p, const struct sink_props* sink_props) {
......@@ -165,7 +169,7 @@ __attribute__((always_inline)) INLINE static void sink_init_part(
* @brief Initialisation of sink particle data before sink loops.
* Note: during initalisation (space_init_sinks)
*
* @param sp The particle to act upon
* @param sp The #sink particle to act upon.
*/
__attribute__((always_inline)) INLINE static void sink_init_sink(
struct sink* sp) {
......@@ -187,7 +191,7 @@ __attribute__((always_inline)) INLINE static void sink_init_sink(
/**
* @brief Predict additional particle fields forward in time when drifting
*
* @param sp The particle
* @param sp The #sink.
* @param dt_drift The drift time-step for positions.
*/
__attribute__((always_inline)) INLINE static void sink_predict_extra(
......@@ -197,7 +201,7 @@ __attribute__((always_inline)) INLINE static void sink_predict_extra(
* @brief Sets the values to be predicted in the drifts to their values at a
* kick time
*
* @param sp The particle.
* @param sp The #sink particle.
*/
__attribute__((always_inline)) INLINE static void sink_reset_predicted_values(
struct sink* restrict sp) {}
......@@ -205,7 +209,7 @@ __attribute__((always_inline)) INLINE static void sink_reset_predicted_values(
/**
* @brief Kick the additional variables
*
* @param sp The particle to act upon
* @param sp The #sink particle to act upon
* @param dt The time-step for this kick
*/
__attribute__((always_inline)) INLINE static void sink_kick_extra(
......@@ -217,7 +221,7 @@ __attribute__((always_inline)) INLINE static void sink_kick_extra(
* Note: This function must be used after having computed the rotational energy
* per components, i.e. after sink_prepare_part_sink_formation().
*
* @param p the gas particle.
* @param p The gas particle.
*
*/
INLINE static double sink_compute_neighbour_rotation_energy_magnitude(
......@@ -233,7 +237,7 @@ INLINE static double sink_compute_neighbour_rotation_energy_magnitude(
/**
* @brief Retrieve the physical velocity divergence from the gas particle.
*
* @param p the gas particles.
* @param p The gas particles.
*
*/
INLINE static float sink_get_physical_div_v_from_part(
......@@ -277,14 +281,15 @@ INLINE static float sink_get_physical_div_v_from_part(
* Return 0 if no sink formation should occur.
* Note: called in runner_do_sink_formation
*
* @param sink_props the sink properties to use.
* @param p the gas particles.
* @param xp the additional properties of the gas particles.
* @param sink_props the sink properties to use.
* @param phys_const the physical constants in internal units.
* @param cosmo the cosmological parameters and properties.
* @param hydro_props The properties of the hydro scheme.
* @param us The internal system of units.
* @param cooling The cooling data struct.
* @param entropy_floor The entropy_floor properties.
*
*/
INLINE static int sink_is_forming(
......@@ -601,12 +606,12 @@ __attribute__((always_inline)) INLINE static void sink_swallow_sink(
/**
* @brief Should the sink spawn a star particle?
*
* @param e The #engine
* @param sink the sink particle.
* @param sink_props the sink properties to use.
* @param phys_const the physical constants in internal units.
* @param cosmo the cosmological parameters and properties.
* @param with_cosmology if we run with cosmology.
* @param e The #engine
* @param sink_props The sink properties to use.
* @param cosmo The cosmological parameters and properties.
* @param with_cosmology If we run with cosmology.
* @param phys_const The physical constants in internal units.
* @param us The internal unit system.
*/
INLINE static int sink_spawn_star(struct sink* sink, const struct engine* e,
......@@ -626,8 +631,7 @@ INLINE static int sink_spawn_star(struct sink* sink, const struct engine* e,
* @brief Separate the #spart and #part by randomly moving both of them.
*
* @param e The #engine.
* @param p The #part generating a star.
* @param xp The #xpart generating a star.
* @param si The #sink generating a star.
* @param sp The new #spart.
*/
INLINE static void sink_star_formation_separate_particles(
......@@ -684,16 +688,18 @@ INLINE static void sink_star_formation_separate_particles(
}
/**
* @brief Copy the properties of the sink particle towards the new star.
* @brief Copy the properties of the sink particle towards the new star. Also,
* give the stars some properties such as position and velocity.
*
* This function also needs to update the sink particle.
*
* @param e The #engine
* @param sink the sink particle.
* @param sink The #sink particle.
* @param sp The star particle.
* @param sink_props the sink properties to use.
* @param phys_const the physical constants in internal units.
* @param cosmo the cosmological parameters and properties.
* @param with_cosmology if we run with cosmology.
* @param e The #engine
* @param sink_props The sink properties to use.
* @param cosmo The cosmological parameters and properties.
* @param with_cosmology If we run with cosmology.
* @param phys_const The physical constants in internal units.
* @param us The internal unit system.
*/
INLINE static void sink_copy_properties_to_star(
......@@ -753,11 +759,12 @@ __attribute__((always_inline)) INLINE static void sink_store_potential_in_part(
* neighbouring gas particles.
*
* @param e The #engine.
* @param c The #cell.
* @param p The #part for which we compute the quantities.
* @param xp The #xpart data of the particle #p.
* @param pi A neighbouring #part of #p.
* @param xpi The #xpart data of the particle #pi.
* @param cosmo The cosmological parameters and properties.
* @param sink_props The sink properties to use.
*/
INLINE static void sink_prepare_part_sink_formation_gas_criteria(
struct engine* e, struct part* restrict p, struct xpart* restrict xp,
......@@ -863,6 +870,10 @@ INLINE static void sink_prepare_part_sink_formation_gas_criteria(
p->sink_data.E_rot_neighbours[2] +=
0.5 * mi * specific_angular_momentum[2] * specific_angular_momentum[2] /
sqrtf(dx_physical[0] * dx_physical[0] + dx_physical[1] * dx_physical[1]);
/* Shall we reset the values of the energies for the next timestep? No, it is
done in cell_drift.c and space_init.c, for active particles. The
potential is set in runner_others.c->runner_do_end_grav_force() */
}
/**
......@@ -870,10 +881,11 @@ INLINE static void sink_prepare_part_sink_formation_gas_criteria(
* function works on the neighbouring sink particles.
*
* @param e The #engine.
* @param c The #cell.
* @param p The #part for which we compute the quantities.
* @param xp The #xpart data of the particle #p.
* @param si A neighbouring #sink of #p.
* @param cosmo The cosmological parameters and properties.
* @param sink_props The sink properties to use.
*/
INLINE static void sink_prepare_part_sink_formation_sink_criteria(
struct engine* e, struct part* restrict p, struct xpart* restrict xp,
......
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment