lanl/singularity-eos

Fix bulk modulus formula in API documentation

Ouverte

#276 ouverte le 18 juil. 2023

Voir sur GitHub
 (0 commentaire) (0 réaction) (0 personne assignée)C++ (21 forks)auto 404
documentationgood first issue

Métriques du dépôt

Stars
 (36 étoiles)
Métriques de merge PR
 (Métriques PR en attente)

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

Guide contributeur

Direction de recherche
Trouvez le fichier source de la documentation correspondant à la documentation API liée dans le problème. Trouvez la formule du module de compressibilité et ajoutez le terme de densité manquant. Mettez également à jour la description pour clarifier que les unités du module de compressibilité sont la pression. Ensuite, ouvrez une pull request.
Stack technique
Aucun
Domaine
documentation
Type d'issue
Documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
1
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
Moins d'une heure
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Récente
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
Git
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
90