IMP: Standarize naming convention and function signatures

ipqa-research / yaeos

Thermodynamic Equations of State, Fortran library with both automatic and anallytical derivation capabilities

https://ipqa-research.github.io/yaeos/

Mozilla Public License 2.0

26 stars 3 forks source link

IMP: Standarize naming convention and function signatures #75

Open fedebenelli opened 2 months ago

fedebenelli commented 2 months ago

In some cases derivatives are defined like:

$\frac{dG^E}{dn_i} = $ Gen
$\frac{dD}{dn_i} = $ dDi
$\frac{d^2G^E}{dTn_i} = $ GeTn
$\frac{d^2D}{dTn_i} = $ dDiT

Some standardization for this would be nice. Which should also be added to STYLE_GUIDE.md

This also extends to the use of self or eos or model, and order of variables f(eos, v, T) vs f(eos, T, v) for example

SalvadorBrandolin commented 1 month ago

What do we do with the upper and lower case of variables?

n V T P
n v t p

fedebenelli commented 1 month ago

Being domain-specific variables I would keep them as they are usually viewed in equations. There si the little detail that volume probably should be v instead of V when we talk about molar volume