xref: /honee/CHANGELOG.md (revision c7435f2c32d2228fd264680145b88395a0d48886)
1# Changelog/Release Notes
2
3On this page we provide a summary of the main API changes, new features and examples for each release of HONEE.
4
5(main)=
6
7## Current `main` branch
8
9### New features
10
11- For strong STG, element size is calculated from cell-to-face basis. `-stg_dx` no longer needed in that case.
12- Add projection of the divergence of diffusive flux for Navier-Stokes equations, see !27
13- Add sine and square wave initial conditions for advection-diffusion example, see !38
14- Add diffusion component of stabilization tau formulation for advection-diffusion, see !42
15- Add projection of the divergence of diffusive flux for advection-diffusion equations, see !43
16- Add boundary layer IC and wind type to advection-diffusion equations, see !46
17- Add `-bl_height_factor` option for boundary layer IC in advection-diffusion equations, see !70
18- Add `-ts_monitor_total_kinetic_energy`
19- Add `-honee_check_step_interval` to verify solution validity during simulation
20- Add `-honee_max_wall_time_{duration,buffer,interval}` for stopping a simulation based on expired wall clock time
21- Add initial condition loading from CGNS files. Requires PETSc to be built with CGNS with parallel support (e.g. with MPI).
22- Add `-ts_monitor_cfl` for CFL statistics monitoring
23- Add `HONEE_StrongBCInsert` and `HONEE_StrongBCCeed` log events
24- Add `-ksp_post_solve_residual` to print KSP residual summary information (can be done for `-mass` as well)
25- Enable projection of the divergence of diffusive flux for explicit Navier-Stokes
26- Add `-mass_ksp_view_pre_ts_solve` to view the mass KSP once before `TSSolve()` is run
27- Spanwise statistics writes a logging message when a file is written, which includes post-processing information (e.g. time span for the statistics)
28- Add `-ts_eval_solutions_view` to output solutions gathered via `-ts_eval_times`
29
30### Internal
31- Add `HoneeLoadInitialCondition()` to consolidate initial condition logic
32
33### Breaking changes
34- Deprecate `-continue` and `-continue_time_filename`. Continuing from file controlled by `-continue_filename`
35- Change `-checkpoint_interval` default value from `10` to `0` (CGNS is the standard restart file format now)
36- Update definition of `PetscOptionsItems` to reflect new status as pointer-to-struct rather than just struct. Requires latest PETSc.
37