1965d9f74SJames Wright# Changelog/Release Notes 2965d9f74SJames Wright 3965d9f74SJames WrightOn this page we provide a summary of the main API changes, new features and examples for each release of HONEE. 4965d9f74SJames Wright 5965d9f74SJames Wright(main)= 6965d9f74SJames Wright 7965d9f74SJames Wright## Current `main` branch 8965d9f74SJames Wright 9965d9f74SJames Wright### New features 10195c5d0eSJames Wright 11195c5d0eSJames Wright- For strong STG, element size is calculated from cell-to-face basis. `-stg_dx` no longer needed in that case. 129840ff74SJames Wright- Add projection of the divergence of diffusive flux for Navier-Stokes equations, see !27 13da02a6e7SJames Wright- Add sine and square wave initial conditions for advection-diffusion example, see !38 14fbabb365SJames Wright- Add diffusion component of stabilization tau formulation for advection-diffusion, see !42 15c4f3d9acSJames Wright- Add projection of the divergence of diffusive flux for advection-diffusion equations, see !43 163d1afcc1SJames Wright- Add boundary layer IC and wind type to advection-diffusion equations, see !46 17b4fd18dfSJames Wright- Add `-bl_height_factor` option for boundary layer IC in advection-diffusion equations, see !70 1825125139SJames Wright- Add `-ts_monitor_total_kinetic_energy` 19354560d1SJames Wright- Add `-honee_check_step_interval` to verify solution validity during simulation 20354560d1SJames Wright- Add `-honee_max_wall_time_{duration,buffer,interval}` for stopping a simulation based on expired wall clock time 21eb9b4fe1SJames Wright- Add initial condition loading from CGNS files. Requires PETSc to be built with CGNS with parallel support (e.g. with MPI). 2287fd7f33SJames Wright- Add `-ts_monitor_cfl` for CFL statistics monitoring 23d9e07cc2SJames Wright- Add `HONEE_StrongBCInsert` and `HONEE_StrongBCCeed` log events 2416cb6b6bSJames Wright- Add `-ksp_post_solve_residual` to print KSP residual summary information (can be done for `-mass` as well) 25b3b24828SJames Wright- Enable projection of the divergence of diffusive flux for explicit Navier-Stokes 2671f2ed29SJames Wright- Add `-mass_ksp_view_pre_ts_solve` to view the mass KSP once before `TSSolve()` is run 278fbf1d3fSJames Wright- Spanwise statistics writes a logging message when a file is written, which includes post-processing information (e.g. time span for the statistics) 284e1dcb99SJames Wright- Add `-ts_eval_solutions_view` to output solutions gathered via `-ts_eval_times` 29d9f57b1cSJames Wright- Add `-taylorgreen_background_velocity` to add a background velocity to the initial condition 30a5677b81SMohi- Add `HONEEGetGitVersion()` to access the Git commit and dirty state of the repository at build time. 31a5677b81SMohi- Add `HONEEGetVersion()` to access the semantic version of HONEE at runtime. 32a5677b81SMohi- Add `HoneeGetBuildConfiguration()` function for retrieving build configuration info. 33*d3c60affSJames Wright- Extend `BCDefinition` to handle boundary integral setup (`BCDefinition{Get,Set}DM()`, `BCDefinition{Get,Set}Context()`, `BCDefinitionSetIFunction()`, `BCDefinitionSetIJacobian()`, and `BCDefinitionAddOperators()`) 34d114cdedSJames Wright 35d114cdedSJames Wright### Internal 36d114cdedSJames Wright- Add `HoneeLoadInitialCondition()` to consolidate initial condition logic 3778c5b8e5SJames Wright- Move `Honee` typedef to `include/honee.h` 38*d3c60affSJames Wright- Remove `SimpleBC` struct 39d114cdedSJames Wright 40d114cdedSJames Wright### Breaking changes 41d114cdedSJames Wright- Deprecate `-continue` and `-continue_time_filename`. Continuing from file controlled by `-continue_filename` 42ef55efadSJames Wright- Change `-checkpoint_interval` default value from `10` to `0` (CGNS is the standard restart file format now) 43ddf6e248SJames Wright- Update definition of `PetscOptionsItems` to reflect new status as pointer-to-struct rather than just struct. Requires latest PETSc. 4478c5b8e5SJames Wright- Change `-ts_monitor_turbulence_spanstats_viewer` -> `-ts_monitor_turbulence_spanstats` and a few similar changes, see !108 45