Skip to content
GitLab
Projects
Groups
Snippets
/
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in
Toggle navigation
Menu
Open sidebar
SWIFT
SWIFTsim
Commits
d3566eca
Commit
d3566eca
authored
Jul 07, 2020
by
Matthieu Schaller
Browse files
Fixes to the doxygen documentation
parent
5e17b46a
Changes
5
Show whitespace changes
Inline
Side-by-side
doc/Doxyfile.in
View file @
d3566eca
...
...
@@ -770,6 +770,7 @@ INPUT += @top_srcdir@/src/cooling/const_du
INPUT += @top_srcdir@/src/cooling/const_lambda
INPUT += @top_srcdir@/src/cooling/Compton
INPUT += @top_srcdir@/src/cooling/EAGLE
INPUT += @top_srcdir@/src/cooling/COLIBRE
INPUT += @top_srcdir@/src/cooling/grackle
INPUT += @top_srcdir@/src/chemistry/EAGLE
INPUT += @top_srcdir@/src/chemistry/GEAR
...
...
src/cooling/COLIBRE/cooling.c
View file @
d3566eca
...
...
@@ -647,6 +647,7 @@ __attribute__((always_inline)) INLINE float cooling_timestep(
*
* @param phys_const #phys_const data structure.
* @param us The internal system of units.
* @param hydro_props The properties of the hydro scheme.
* @param cosmo #cosmology data structure.
* @param cooling #cooling_function_data struct.
* @param p #part data.
...
...
@@ -935,7 +936,6 @@ float cooling_get_subgrid_density(
* @param us The internal system of units.
* @param cosmo The current cosmological model.
* @param hydro_props the hydro_props struct
* @param starform the star formation law properties to initialize
* @param floor_props Properties of the entropy floor.
* @param cooling The #cooling_function_data used in the run.
* @param p Pointer to the particle data.
...
...
@@ -1044,10 +1044,11 @@ void cooling_Hydrogen_reionization(const struct cooling_function_data *cooling,
/**
* @brief Initialises properties stored in the cooling_function_data struct
*
* @param parameter_file The parsed parameter file
* @param us Internal system of units data structure
* @param phys_const #phys_const data structure
* @param cooling #cooling_function_data struct to initialize
* @param parameter_file The parsed parameter file.
* @param us Internal system of units data structure.
* @param hydro_props the properties of the hydro scheme.
* @param phys_const #phys_const data structure.
* @param cooling #cooling_function_data struct to initialize.
*/
void
cooling_init_backend
(
struct
swift_params
*
parameter_file
,
const
struct
unit_system
*
us
,
...
...
src/cooling/COLIBRE/cooling_rates.h
View file @
d3566eca
...
...
@@ -410,7 +410,6 @@ __attribute__((always_inline)) INLINE static float colibre_convert_temp_to_u(
* @param redshift Current redshift
* @param n_H_cgs Hydrogen number density in cgs
* @param ZZsol Metallicity relative to the solar value from the tables
* @param abundance_ratio Abundance ratio for each element x relative to solar
* @param n_H_index Index along the Hydrogen number density dimension
* @param d_n_H Offset between Hydrogen density and table[n_H_index]
* @param met_index Index along the metallicity dimension
...
...
@@ -458,7 +457,7 @@ INLINE static float colibre_meanparticlemass_temperature(
* @param d_red Offset between redshift and table[red_index]
* @param cooling #cooling_function_data structure
*
* @retur
a
linear electron density in cm-3 (NOT the electron fraction)
* @retur
n
linear electron density in cm-3 (NOT the electron fraction)
*/
INLINE
static
float
colibre_electron_density
(
double
log_u_cgs
,
double
redshift
,
double
n_H_cgs
,
float
ZZsol
,
...
...
@@ -501,7 +500,7 @@ INLINE static float colibre_electron_density(
* @param d_red Offset between redshift and table[red_index]
* @param cooling #cooling_function_data structure
*
* @retur
a
linear electron density in cm-3 (NOT the electron fraction)
* @retur
n
linear electron density in cm-3 (NOT the electron fraction)
*/
INLINE
static
float
colibre_electron_density_temperature
(
double
log_T_cgs
,
double
redshift
,
double
n_H_cgs
,
float
ZZsol
,
...
...
src/cooling/COLIBRE/cooling_tables.c
View file @
d3566eca
...
...
@@ -46,7 +46,6 @@
* of values for temperature, hydrogen number density, metallicity,
* abundance ratios, and elements used to index the cooling tables.
*
* @param fname Filepath for cooling table from which to read header
* @param cooling Cooling data structure
*/
void
read_cooling_header
(
struct
cooling_function_data
*
cooling
)
{
...
...
src/task.c
View file @
d3566eca
...
...
@@ -1097,7 +1097,7 @@ void task_dump_all(struct engine *e, int step) {
*
* @param dumpfile name of the file for the output.
* @param e the #engine
* @param dump_task_threshold Fraction of the step time above whic any task
* @param dump_task
s
_threshold Fraction of the step time above whic any task
* triggers a call to task_dump_all().
* @param header whether to write a header include file.
* @param allranks do the statistics over all ranks, if not just the current
...
...
Write
Preview
Supports
Markdown
0%
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment