lanl/singularity-eos

Fix bulk modulus formula in API documentation

Aperta

#276 aperta il 18 lug 2023

Vedi su GitHub
 (0 commenti) (0 reazioni) (0 assegnatari)C++ (21 fork)auto 404
documentationgood first issue

Metriche repository

Star
 (36 stelle)
Metriche merge PR
 (Metriche PR in attesa)

Descrizione

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

Guida contributor

Direzione di ricerca
Trova il file sorgente della documentazione corrispondente alla documentazione API collegata nell'issue. Trova la formula per il modulo di bulk e aggiungi il termine di densità mancante. Aggiorna anche la descrizione per chiarire che le unità del modulo di bulk sono pressione. Poi apri una pull request.
Tech stack
Nessuno
Dominio
documentation
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
1
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
Meno di 1 ora
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Nuova
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
Git
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
90