add comment for energy_total

trixi-framework · Mar 28, 2024 · d4cfb82 · d4cfb82
1 parent aad0a4f
commit d4cfb82
Showing 1 changed file with 3 additions and 1 deletion.
diff --git a/src/equations/shallow_water_multilayer_1d.jl b/src/equations/shallow_water_multilayer_1d.jl
@@ -502,7 +502,9 @@ end
     energy_total(u, equations)
 end
 
-# Calculate total energy for a conservative state `u`
+# Calculate total energy for a conservative state `u`.
+# The total energy is composed of the kinetic energy, the hydrostatic pressure and the potential
+# energy from the bottom topography and the layer interfaces.
 @inline function Trixi.energy_total(u, equations::ShallowWaterMultiLayerEquations1D)
     h = waterheight(u, equations)
     v = velocity(u, equations)