lanl/singularity-eos

Fix bulk modulus formula in API documentation

Open

#276 opened on Jul 18, 2023

View on GitHub
 (0 comments) (0 reactions) (0 assignees)C++ (21 forks)auto 404
documentationgood first issue

Repository metrics

Stars
 (36 stars)
PR merge metrics
 (PR metrics pending)

Description

https://lanl.github.io/singularity-eos/main/src/using-eos.html#_CPPv4NK33BulkModulusFromDensityTemperatureEK4RealK4RealP4Real

There is a missing density in the formula for the bulk modulus.

Also we should add that the units for the bulk modulus are pressure since mass * length^2 / time^2 isn't an obvious pressure unit.

Thanks to @c0sm0-kramer for pointing it out

Contributor guide

Research direction
Locate the documentation source file corresponding to the API docs linked in the issue. Find the formula for bulk modulus and add the missing density term. Also update the description to clarify that units of bulk modulus are pressure. Then open a pull request.
Tech stack
None
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90