Skip to content

v2.0.0

Compare
Choose a tag to compare
@neutrinoceros neutrinoceros released this 17 Apr 11:40
· 567 commits to main since this release

What's Changed

The format enforced by inifix-format was changed to improve compacity and readability. The new format is designed to be closer to manual formatting that is actually perfomed by Idefix users and contributors.

This is considered a major version change because the new formatter, by design, is no configurable, and in particular doesn't support the --name-column-size flag implemented in inifix 1.2

The API is otherwize identical to version 1.2.1

Format differences

Values and comments are aligned in columns and by section. In previous versions they were aligned globally, with hard coded column widths, resulting in much more space being wasted.
The new format is intended to be more legible and closer to what Idefix users actually do manually.
Here's a small example of the previous format compared with the new one

inifix 1.2.1

[Grid]
X1-grid              1  0.3  32  u  3.0
X2-grid              1  1.15  32  u  3.141592653589793                          # leave out the pole
X3-grid              1  -3.141592653589  32  u  3.141592653589793               # full azimuthal domain

[TimeIntegrator]
CFL                  0.5                                                        # loose CFL
tstop                1.e-4                                                      # short run
first_dt             1.e-4
nstages              2

[Hydro]
solver               hllc
gravPotential        userdef
csiso                userdef
viscosity            rkl  userdef
fargo                userdef

[Boundary]
X1-beg               userdef
X1-end               userdef
X2-beg               userdef
X2-end               userdef
X3-beg               periodic
X3-end               periodic

inifix 2.0.0

[Grid]
X1-grid    1  0.3              32  u  3.0
X2-grid    1  1.15             32  u  3.141592653589793    # leave out the pole
X3-grid    1  -3.141592653589  32  u  3.141592653589793    # full azimuthal domain

[TimeIntegrator]
CFL         0.5      # loose CFL
tstop       1.e-4    # short run
first_dt    1.e-4
nstages     2

[Hydro]
solver           hllc
gravPotential    userdef
csiso            userdef
viscosity        rkl      userdef
fargo            userdef

[Boundary]
X1-beg    userdef
X1-end    userdef
X2-beg    userdef
X2-end    userdef
X3-beg    periodic
X3-end    periodic

Full Changelog: v1.2.1...v2.0.0