Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

incorrect inline docs for eos_poly_piece::csnd_from_gm1 #35

Open
rhaas80 opened this issue Jul 9, 2024 · 1 comment
Open

incorrect inline docs for eos_poly_piece::csnd_from_gm1 #35

rhaas80 opened this issue Jul 9, 2024 · 1 comment
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@rhaas80
Copy link
Collaborator

rhaas80 commented Jul 9, 2024

The current (e59d68d) RePrimAnd code for real_t eos_poly_piece::csnd_from_gm1(real_t gm1) const reads:

/**
\return Soundspeed squared \f$ c_s^2 = \frac{g-1-\delta\epsilon}{ng} \f$
*/
real_t eos_poly_piece::csnd_from_gm1(real_t gm1) const
{
  real_t gm1p  = gm1 - dsed;
  return sqrt(gm1p / ( n * (gm1 + 1.0)));
}

so claims to compute "Soundspeed squared" but actually computes sound speed (not squared) as the name would indicate.

@rhaas80 rhaas80 added the documentation Improvements or additions to documentation label Jul 9, 2024
@wokast
Copy link
Owner

wokast commented Jul 10, 2024

Indeed, the function returns the unsquared soundspeed as it is supposed to do. The documentation is wrong. Will be fixed in next service release.

@wokast wokast self-assigned this Jul 10, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants