lanl/singularity-eos

Fix bulk modulus formula in API documentation

Offen

#276 geöffnet am 18.07.2023

Auf GitHub ansehen
 (0 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)C++ (21 Forks)auto 404
documentationgood first issue

Repository-Metriken

Stars
 (36 Sterne)
PR-Merge-Metriken
 (PR-Metriken ausstehend)

Beschreibung

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-Richtung
Finden Sie die Quelldatei der Dokumentation, die der in der Ausgabe verlinkten API Dokumentation entspricht. Finden Sie die Formel für den Kompressionsmodul und fügen Sie den fehlenden Dichteterm hinzu. Aktualisieren Sie auch die Beschreibung, um zu verdeutlichen, dass die Einheiten des Kompressionsmoduls Druck sind. Öffnen Sie dann einen Pull Request.
Tech Stack
Keine
Domain
documentation
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
1
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
Unter 1 Stunde
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Frisch
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
Git
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
90