neko icon indicating copy to clipboard operation
neko copied to clipboard

Consistent naming in case file

Open MartinKarp opened this issue 1 year ago • 2 comments

Consistent naming of different components of the case file. Originally raised in PR #1617 where the Krylov solvers are a good example of things that could be improved to comply more with the rest of the file.

Key questions are perhaps to settle on one whitespace character for example.

MartinKarp avatar Nov 27 '24 09:11 MartinKarp

Additionally it might be worth mentioning that the discussion here are not how the keys of the json file should be named, but more how should the options them selves be formatted. Do we want to enforce lowercase, or do we want capitalization similar to how it would be presented in a paper. Below is a list of variants we could consider. My personal favorite is the bottom one, since that is very close to how it would be written in a paper, meaning it might be simpler to parse for a non-expert user.

  • "velocity_solver": { "type": "fusedcoupledcg", ...
  • "velocity_solver": { "type": "fused_coupled_cg", ...
  • "velocity_solver": { "type": "fused-coupled-cg, ...
  • "velocity_solver": { "type": "FusedCoupledCG", ...
  • "velocity_solver": { "type": "Fused_Coupled_CG", ...
  • "velocity_solver": { "type": "Fused-Coupled-CG", ...

timfelle avatar Nov 27 '24 10:11 timfelle

I think we have de facto converged on options 1 and 2 in Tim's list. Where to put a _ is more or less keyword-dependent.

timofeymukha avatar Jan 29 '25 05:01 timofeymukha

I'd say we set _ as the whitespace character. A question is whether we want to proapagate taht to the linear solver naming before v1.0

timofeymukha avatar Jun 03 '25 11:06 timofeymukha