clawpack / riemann_book

An interactive book about the Riemann problem for hyperbolic PDEs, using Jupyter notebooks.
BSD 3-Clause "New" or "Revised" License
264 stars 95 forks source link

Edits to final chapters #216

Closed rjleveque closed 4 years ago

rjleveque commented 4 years ago

Some edits to Burgers_approximate, Shallow_water_approximate, Euler_approximate, and Euler_compare.

Question: Should we merge Euler_approximate, and Euler_compare into a single notebook? Or split Shallow_water_approximate into two?

At the moment the two are handled differently, since Shallow_water_approximate has both discussion of the single Riemann solution and PyClaw examples using approximate solvers, whereas for Euler we spit them up.

ketch commented 4 years ago

Looks good! When we wrote Euler_compare, we didn't have the PyClaw example at the end of the SW chapter. I don't like splitting the SW example into its own chapter, since it's just the one example without a lot of discussion. Merging the two Euler chapters makes a rather long notebook (due mostly to the long code blocks for the PyClaw simulations) but I think it's not longer than some of the other chapters, so that seems fine.

maojrs commented 4 years ago

I also think it would be fine to join them . However, an alternative idea would be to change the name of Euler_compare to something like Comparison of approximate solvers and move the last example of Shallow_water_approximate into the comparison notebook. This way, we keep a chapter just aimed in the comparison between different solvers, and avoid having a very large Euler_approximate chapter.

rjleveque commented 4 years ago

I like the idea of moving the SWE example to the last chapter so all the PyClaw code is together. I'll try that and see how it looks.

rjleveque commented 4 years ago

I combined the examples and also rearranged the order of the Euler examples and code. I renamed the last notebook to FV_compare

If this looks ok, there are other places this name change needs to be made, in particular in Index.ipynb, make_html.py, and make_pdf.py.

ketch commented 4 years ago

Looks good to me. I would say go ahead and make the name change.

maojrs commented 4 years ago

Randy, I updated the plotting style of the SW example in the FV_compare notebook to match how it looks in the other examples. I also added the momentum in the same plot. I made a pull request to your branch, so if you like how it looks you can just merge it.