Skip to content

incorrect inline docs for eos_poly_piece::csnd_from_gm1 #35

@rhaas80

Description

@rhaas80

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.

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentation

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions