PrincetonUniversity / SPEC

The Stepped-Pressure Equilibrium Code, an advanced MRxMHD equilibrium solver.
https://princetonuniversity.github.io/SPEC/
GNU General Public License v3.0
25 stars 6 forks source link

InputFiles #25

Closed jloizu closed 6 years ago

jloizu commented 6 years ago

I have created a folder InputFiles/TestCases and have added two cases that I have been using to test the code. I propose, inspired by Stuart's suggestion, to follow this convention for any input file uploaded in that folder:

Two files per input shall be always imported and named as: GxVyLzFu.nnn.sp GxVyLzFu.nnn.info where the .sp is the actual input file and the .info is a text file with a sentence or two describing the purpose of this input, and with x=1,2,3 for the geometry used (slab, cylindrical,toroidal) y=number of volumes z=0,1,2... for Lconstraint (fixed mu, fixed iota, fixed helicity...) u=i,r for fixed-boundar (i) or free-boundary (r) nnn=001,002,etc. to number the files if there is more than one with this G,V,L,F properties.

Please let me know if that works for you.

lazersos commented 6 years ago

I would propose the following modification to the naming convention: GxVyyLzFu.nnn.sp This way the number of volumes can exceed 9 and the files will still display nicely when listed.

jloizu commented 6 years ago

Good point. How about when we use more than 99? Probably not often, but it happened already. Shall we stick to Vyy or Vyyy?

jloizu commented 6 years ago

Lack of further feedback made me decide by myself. We shall adopt the convention:

GxVyyLzFu.nnn.sp GxVyyLzFu.nnn.info