Skip to content

Commit

Permalink
Added a doxygen comment on a function in C_miscentering.c.
Browse files Browse the repository at this point in the history
  • Loading branch information
tmcclintock committed Jun 8, 2018
1 parent 4944c21 commit 7e5c4c7
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions src/C_miscentering.c
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,18 @@ typedef struct integrand_params{
gsl_function F_radial; // function for the radial part of the miscentering
}integrand_params;

/** @brief The integrand the miescentered profile of a
* single cluster.
*
* The miscentered profile of a single cluster with a
* known offset is calculated by integrating an annulus.
* See McClintock+ (2018) eq. 38.
*
* @param theta The angle the integral is currently on.
* @param params A structure containing the splines and
* other inputs to the integral.
* @return The integrand at theta.
*/
double single_angular_integrand(double theta, void*params){
integrand_params*pars = (integrand_params*)params;
gsl_spline*spline = pars->spline;
Expand Down

0 comments on commit 7e5c4c7

Please sign in to comment.