eth-vaw-glaciology / course-101-0250-00

ETH course - Solving PDEs in parallel on GPUs
https://pde-on-gpu.vaw.ethz.ch
Other
121 stars 28 forks source link

Scripts should say what they do #15

Open mauro3 opened 1 year ago

mauro3 commented 1 year ago

It would be helpful to add comment lines to each script's top to state:

Bonus points for actually stating the equation.

I realize that some of that is encoded in the file name, but I cannot decode that.

For instance for https://github.com/eth-vaw-glaciology/course-101-0250-00/blob/main/scripts/l2_diffusion_1D.jl:

# Lecture 2.2a Parabolic PDEs - solve diffusion equation with explicit forward Euler step
#
# ∂C/∂t = D ∂²C/∂x²