Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

IMP: Standarize naming convention and function signatures #75

Open
fedebenelli opened this issue Jun 24, 2024 · 2 comments
Open

IMP: Standarize naming convention and function signatures #75

fedebenelli opened this issue Jun 24, 2024 · 2 comments
Assignees

Comments

@fedebenelli
Copy link
Member

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 SalvadorBrandolin self-assigned this Jul 12, 2024
@SalvadorBrandolin
Copy link
Member

SalvadorBrandolin commented Jul 12, 2024

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

  1. n V T P
  2. n v t p

@fedebenelli
Copy link
Member Author

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants