From 021e4205ef46eba8a8d5e360ef5ed83f92815d0a Mon Sep 17 00:00:00 2001 From: Hendrik Ranocha Date: Sun, 18 Aug 2024 18:32:16 +0200 Subject: [PATCH] Apply suggestions from code review Co-authored-by: Joshua Lampert <51029046+JoshuaLampert@users.noreply.github.com> --- docs/src/overview.md | 3 ++- src/equations/hyperbolic_serre_green_naghdi_1d.jl | 2 +- 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/docs/src/overview.md b/docs/src/overview.md index 521fa40d..e4d0da43 100644 --- a/docs/src/overview.md +++ b/docs/src/overview.md @@ -146,7 +146,8 @@ always plot to first subplot) and `plot_initial`. You can also provide a `conver of the primitive variables `q` at one node, and the `equations` as input and should return an `SVector` of any length as output. For a user defined conversion function, there should also exist a function `varnames(conversion, equations)` that returns a `Tuple` of the variable names used for labelling. The conversion function can, e.g., be [`prim2cons`](@ref) or [`waterheight_total`](@ref) if one only wants to plot the total water height. The resulting plot will have one subplot for each of the returned -variables of the conversion variable. By default, the conversion function is just [`prim2phys`](@ref), i.e., the identity for most equations. +variables of the conversion variable. By default, the conversion function is just [`prim2phys`](@ref), which computes the physical variables +from the primitive ones, i.e., the identity for most equations. Plotting an animation over time can, e.g., be done by the following command, which uses `step` to plot the solution at a specific time step. diff --git a/src/equations/hyperbolic_serre_green_naghdi_1d.jl b/src/equations/hyperbolic_serre_green_naghdi_1d.jl index 6af893df..eff0810a 100644 --- a/src/equations/hyperbolic_serre_green_naghdi_1d.jl +++ b/src/equations/hyperbolic_serre_green_naghdi_1d.jl @@ -146,7 +146,7 @@ function set_approximation_variables!(q, mesh, return nothing end -# TODO: There is another name clash. For the SerreGreenNaghdiEquations1D, +# TODO: There is name clash. For the SerreGreenNaghdiEquations1D, # the corresponding function is called initial_condition_convergence_test # However, we cannot use that name since it's not an analytical solution. # How shall we handle this?