Skip to content

Commit

Permalink
Apply suggestions from code review
Browse files Browse the repository at this point in the history
Co-authored-by: Joshua Lampert <[email protected]>
  • Loading branch information
ranocha and JoshuaLampert authored Aug 18, 2024
1 parent 73a39a0 commit 021e420
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 2 deletions.
3 changes: 2 additions & 1 deletion docs/src/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
2 changes: 1 addition & 1 deletion src/equations/hyperbolic_serre_green_naghdi_1d.jl
Original file line number Diff line number Diff line change
Expand Up @@ -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?
Expand Down

0 comments on commit 021e420

Please sign in to comment.