When running a convergence_test one often wants to put the results in a table that can be copy-pasted to a LaTeX document, e.g., for a paper, which means one probably wants to use PrettyTables.jl. However, with the current definition of convergence_test this is not so convenient because it only prints the full results (nicely formatted) to the screen, but only returns the eoc_values and not the errors itself, see
This means it is not so easy to simply run
convergence_test and use the return values to create a table with PrettyTables.jl, which also contains error values. I see in repro repos (e.g.
here) that
convergence_test is not used, but rather an own convergence test is reimplemented. However, I do not want to reinvent the wheel all the time and would much rather like to reuse the functionality already defined in Trixi.jl. I would therefore either like
convergence_test to also return
errorsmatrix (like we already do, e.g., in DispersiveShallowWater.jl
here) or maybe even better create an interface to PrettyTables.jl as an extension. Of course the first solution would be breaking. How do you feel about that?
When running a
convergence_testone often wants to put the results in a table that can be copy-pasted to a LaTeX document, e.g., for a paper, which means one probably wants to use PrettyTables.jl. However, with the current definition ofconvergence_testthis is not so convenient because it only prints the full results (nicely formatted) to the screen, but only returns theeoc_valuesand not the errors itself, seeTrixi.jl/src/auxiliary/special_elixirs.jl
Line 126 in 97bdb80
This means it is not so easy to simply run
convergence_testand use the return values to create a table with PrettyTables.jl, which also contains error values. I see in repro repos (e.g. here) thatconvergence_testis not used, but rather an own convergence test is reimplemented. However, I do not want to reinvent the wheel all the time and would much rather like to reuse the functionality already defined in Trixi.jl. I would therefore either likeconvergence_testto also returnerrorsmatrix(like we already do, e.g., in DispersiveShallowWater.jl here) or maybe even better create an interface to PrettyTables.jl as an extension. Of course the first solution would be breaking. How do you feel about that?