lanl/singularity-eos

Fix bulk modulus formula in API documentation

Aberta

#276 aberto em 18 de jul. de 2023

Ver no GitHub
 (0 comentário) (0 reação) (0 responsável)C++ (21 forks)auto 404
documentationgood first issue

Métricas do repositório

Stars
 (36 estrelas)
Métricas de merge de PR
 (Métricas PR pendentes)

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

Guia do colaborador

Direção de pesquisa
Encontre o arquivo fonte da documentação correspondente aos links da API no problema. Localize a fórmula do módulo de bulk e adicione o termo de densidade ausente. Atualize também a descrição para esclarecer que as unidades do módulo de bulk são pressão. Em seguida, abra um pull request.
Pilha de tecnologia
None
Domain
documentation
Tipo Issue
Documentação
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
1
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
Menos de 1 hora
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Recente
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
Git
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
90