lanl/singularity-eos

Fix bulk modulus formula in API documentation

オープン

#276 opened on 2023/07/18

GitHub で見る
 (0 件のコメント) (0 件のリアクション) (0 人の担当者)C++ (21 件のフォーク)auto 404
documentationgood first issue

Repository metrics

Stars
 (36 個のスター)
PR merge metrics
 (PR metrics pending)

説明

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

コントリビューターガイド

調査方針
問題にリンクされたAPIドキュメントに対応するドキュメントソースファイルを見つけてください。体積弾性率の式を見つけ、不足している密度項を追加してください。また、体積弾性率の単位が圧力であることを明確にするために説明を更新してください。その後、プルリクエストを作成してください。
技術スタック
なし
領域
documentation
Issue 種別
ドキュメント
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
1
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1時間未満
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
新着
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
明確
前提条件
Git
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
90