diff --git a/src/starformation/none/starformation.h b/src/starformation/none/starformation.h index a8349862d32ee614d490a58495491ee9ef9b2359..e0cdd546b0b69365d8e0dffdf2dce89c4c86b380 100644 --- a/src/starformation/none/starformation.h +++ b/src/starformation/none/starformation.h @@ -39,6 +39,7 @@ struct star_formation {}; /** * @brief Calculates if the gas particle gets converted * The gas will never be converted in none, so always returns 0. + * So this code does not produce star formation. * * @param the #engine * @param starform the star formation law properties to use. @@ -62,7 +63,8 @@ INLINE static int star_formation_convert_to_star( } /** - * @brief Calculate if the gas particle is converted + * @brief Calculate if the gas particle is converted, which + * should never happen in this model * * @param starform the star formation struct * @param p the gas particles with their properties diff --git a/src/starformation/schaye08/starformation.h b/src/starformation/schaye08/starformation.h index d46f93469f5050784f4d1925edf0520b19956e0f..1c7ab1b6ea23b6dfad626cf053388e55714e565f 100644 --- a/src/starformation/schaye08/starformation.h +++ b/src/starformation/schaye08/starformation.h @@ -40,7 +40,7 @@ /* Starformation struct */ struct star_formation { - /*! Normalization of the KS star formation law */ + /*! Normalization of the KS star formation law (internal units) */ double KS_normalization; /*! Normalization of the KS star formation law in user units */ @@ -52,10 +52,10 @@ struct star_formation { /*! Slope of the high density KS law */ double KS_high_den_power_law; - /*! KS law High density threshold */ + /*! KS law High density threshold (internal units) */ double KS_high_den_thresh; - /*! KS high density normalization */ + /*! KS high density normalization (internal units) */ double KS_high_den_normalization; /*! Critical overdensity */ @@ -70,25 +70,25 @@ struct star_formation { /*! Star formation law slope */ double SF_power_law; - /*! star formation normalization of schaye+08 */ + /*! star formation normalization of schaye+08 (internal units) */ double SF_normalization; /*! star formation high density slope */ double SF_high_den_power_law; - /*! Star formation high density normalization */ + /*! Star formation high density normalization (internal units) */ double SF_high_den_normalization; /*! Inverse of RAND_MAX */ double inv_RAND_MAX; - /*! Density threshold to form stars */ + /*! Density threshold to form stars (internal units) */ double density_threshold; /*! Density threshold to form stars in user units */ float density_threshold_HpCM3; - /*! Maximum density threshold to form stars */ + /*! Maximum density threshold to form stars (internal units) */ double density_threshold_max; /*! Maximum density threshold to form stars in user units */ @@ -100,7 +100,7 @@ struct star_formation { /*! one over the scaling metallicity */ double Z0_inv; - /*! critical density Metallicity power law */ + /*! critical density Metallicity power law (internal units) */ double n_Z0; /*! Polytropic index */ @@ -112,7 +112,7 @@ struct star_formation { /*! EOS Temperature norm */ double EOS_temperature_norm; - /*! EOS density norm */ + /*! EOS density norm (internal units) */ double EOS_density_norm; /*! EOS density norm in user units */