Improved comments for multi-ion MHD equation (2D) and renamed source_…

…terms_standard to source_terms_lorentz
trixi-framework · Dec 6, 2024 · 8c1ab2f · 8c1ab2f
1 parent ac54ebd
commit 8c1ab2f
Show file tree

Hide file tree

Showing 10 changed files with 143 additions and 112 deletions.
diff --git a/examples/tree_1d_dgsem/elixir_mhdmultiion_ec.jl b/examples/tree_1d_dgsem/elixir_mhdmultiion_ec.jl
@@ -20,7 +20,7 @@ mesh = TreeMesh(coordinates_min, coordinates_max,
                 n_cells_max = 10_000)
 
 semi = SemidiscretizationHyperbolic(mesh, equations, initial_condition, solver,
-                                    source_terms = source_terms_standard)
+                                    source_terms = source_terms_lorentz)
 
 ###############################################################################
 # ODE solvers, callbacks etc.

diff --git a/examples/tree_1d_dgsem/elixir_mhdmultiion_ec_onespecies.jl b/examples/tree_1d_dgsem/elixir_mhdmultiion_ec_onespecies.jl
@@ -23,7 +23,7 @@ semi = SemidiscretizationHyperbolic(mesh, equations, initial_condition, solver)
 
 # In the one-species case, the source terms are not really needed, but this variant produces the same results:
 # semi = SemidiscretizationHyperbolic(mesh, equations, initial_condition, solver,
-#                                     source_terms=source_terms_standard) 
+#                                     source_terms=source_terms_lorentz) 
 
 ###############################################################################
 # ODE solvers, callbacks etc.

diff --git a/examples/tree_1d_dgsem/elixir_mhdmultiion_es.jl b/examples/tree_1d_dgsem/elixir_mhdmultiion_es.jl
@@ -20,7 +20,7 @@ mesh = TreeMesh(coordinates_min, coordinates_max,
                 n_cells_max = 10_000)
 
 semi = SemidiscretizationHyperbolic(mesh, equations, initial_condition, solver,
-                                    source_terms = source_terms_standard)
+                                    source_terms = source_terms_lorentz)
 
 ###############################################################################
 # ODE solvers, callbacks etc.

diff --git a/examples/tree_1d_dgsem/elixir_mhdmultiion_es_shock_capturing.jl b/examples/tree_1d_dgsem/elixir_mhdmultiion_es_shock_capturing.jl
@@ -31,7 +31,7 @@ mesh = TreeMesh(coordinates_min, coordinates_max,
                 n_cells_max = 10_000)
 
 semi = SemidiscretizationHyperbolic(mesh, equations, initial_condition, solver,
-                                    source_terms = source_terms_standard)
+                                    source_terms = source_terms_lorentz)
 
 ###############################################################################
 # ODE solvers, callbacks etc.

diff --git a/examples/tree_2d_dgsem/elixir_mhdmultiion_ec.jl b/examples/tree_2d_dgsem/elixir_mhdmultiion_ec.jl
@@ -21,7 +21,7 @@ mesh = TreeMesh(coordinates_min, coordinates_max,
                 n_cells_max = 10_000)
 
 semi = SemidiscretizationHyperbolic(mesh, equations, initial_condition, solver,
-                                    source_terms = source_terms_standard)
+                                    source_terms = source_terms_lorentz)
 
 ###############################################################################
 # ODE solvers, callbacks etc.

diff --git a/examples/tree_2d_dgsem/elixir_mhdmultiion_es.jl b/examples/tree_2d_dgsem/elixir_mhdmultiion_es.jl
@@ -21,7 +21,7 @@ mesh = TreeMesh(coordinates_min, coordinates_max,
                 n_cells_max = 10_000)
 
 semi = SemidiscretizationHyperbolic(mesh, equations, initial_condition, solver,
-                                    source_terms = source_terms_standard)
+                                    source_terms = source_terms_lorentz)
 
 ###############################################################################
 # ODE solvers, callbacks etc.

diff --git a/src/Trixi.jl b/src/Trixi.jl
@@ -217,7 +217,7 @@ export boundary_condition_do_nothing,
        BoundaryConditionCoupled
 
 export initial_condition_convergence_test, source_terms_convergence_test,
-       source_terms_standard
+source_terms_lorentz
 export source_terms_harmonic
 export initial_condition_poisson_nonperiodic, source_terms_poisson_nonperiodic,
        boundary_condition_poisson_nonperiodic

diff --git a/src/callbacks_step/glm_speed.jl b/src/callbacks_step/glm_speed.jl
@@ -9,7 +9,8 @@
     GlmSpeedCallback(; glm_scale=0.5, cfl, semi_indices=())
 
 Update the divergence cleaning wave speed `c_h` according to the time step
-computed in [`StepsizeCallback`](@ref) for the ideal GLM-MHD equations.
+computed in [`StepsizeCallback`](@ref) for the ideal GLM-MHD equations, the multi-component
+GLM-MHD equations, and the multi-ion GLM-MHD equations.
 The `cfl` number should be set to the same value as for the time step size calculation. The
 `glm_scale` ensures that the GLM wave speed is lower than the fastest physical waves in the MHD
 solution and should thus be set to a value within the interval [0,1]. Note that `glm_scale = 0`

diff --git a/src/equations/ideal_glm_mhd_multiion_2d.jl b/src/equations/ideal_glm_mhd_multiion_2d.jl
diff --git a/src/equations/ideal_mhd_multiion_1d.jl b/src/equations/ideal_mhd_multiion_1d.jl
@@ -179,7 +179,7 @@ end
 """
 Standard source terms of the multi-ion MHD equations
 """
-function source_terms_standard(u, x, t, equations::IdealMhdMultiIonEquations1D)
+function source_terms_lorentz(u, x, t, equations::IdealMhdMultiIonEquations1D)
     @unpack charge_to_mass = equations
     B1, B2, B3 = magnetic_field(u, equations)
     v1_plus, v2_plus, v3_plus, vk1_plus, vk2_plus, vk3_plus = charge_averaged_velocities(u,