Merge branch 'main' into ExamplesNewtonKrylov

Author: DanielDoehring

docs/src/conventions.md

@@ -76,6 +76,24 @@ set via the keywords
   documented with a docstring (but maybe with comments using `#`).
 
 
+## Structure of the `solver` directory
+
+If some functionality is shared by multiple combinations of meshes/solvers,
+it is defined in the directory of the most basic mesh and solver type.
+An example for this is the `rhs!` function, which lays out the sequence of functions 
+that compose the overall right-hand-side function provided to the ODE integrator.
+Since this general "recipe" can be unified for different meshes of a certain dimension,
+a shared implementation is used to minimize code duplication.
+
+The most basic (in the sense that it is most tested and developed) solver type in Trixi.jl is
+[`DGSEM`](@ref) due to historic reasons and background of the main contributors.
+We consider the [`TreeMesh`](@ref) to be the most basic mesh type since it is Cartesian
+and was the first mesh in Trixi.jl.
+Thus, shared implementations for more advanced meshes such as the [`P4estMesh`](@ref) can be found in
+the `src/solvers/dgsem_tree/` directory, while only necessary specifics are actually placed in
+`src/solvers/dgsem_p4est/`.
+
+
 ## Array types and wrapping
 
 To allow adaptive mesh refinement efficiently when using time integrators from

src/Trixi.jl

@@ -309,7 +309,9 @@ export trixi_include, examples_dir, get_examples, default_example,
 
 export ode_norm, ode_unstable_check
 
-export convergence_test, jacobian_fd, jacobian_ad_forward, linear_structure
+export convergence_test,
+       jacobian_fd, jacobian_ad_forward, jacobian_ad_forward_parabolic,
+       linear_structure
 
 export DGMulti, DGMultiBasis, estimate_dt, DGMultiMesh, GaussSBP
 

src/callbacks_stage/entropy_bounded_limiter.jl

@@ -56,6 +56,8 @@ function (limiter!::EntropyBoundedLimiter)(u_ode, integrator,
         limiter_entropy_bounded!(u, u_prev, limiter!.exp_entropy_decrease_max,
                                  mesh_equations_solver_cache(semi)...)
     end
+
+    return nothing
 end
 
 # Exponentiated entropy change for the thermodynamic entropy (see `entropy_thermodynamic`) 

src/callbacks_stage/positivity_zhang_shu.jl

@@ -36,6 +36,8 @@ function (limiter!::PositivityPreservingLimiterZhangShu)(u_ode, integrator,
         limiter_zhang_shu!(u, limiter!.thresholds, limiter!.variables,
                            mesh_equations_solver_cache(semi)...)
     end
+
+    return nothing
 end
 
 # Iterate over tuples in a type-stable way using "lispy tuple programming",

src/callbacks_step/amr_dg.jl

@@ -89,6 +89,8 @@ function rebalance_solver!(u_ode::AbstractVector,
             MPI.Waitall(requests, MPI.Status)
         end
     end # GC.@preserve old_u_ode
+
+    return nothing
 end
 
 # Construct cache for ControllerThreeLevel and ControllerThreeLevelCombined.

src/callbacks_step/amr_dg1d.jl

@@ -282,5 +282,7 @@ function coarsen_elements!(u::AbstractArray{<:Any, 3}, element_id,
         # Update value
         set_node_vars!(u, acc, equations, dg, i, element_id)
     end
+
+    return nothing
 end
 end # @muladd

src/callbacks_step/amr_dg2d.jl

@@ -74,6 +74,8 @@ function rebalance_solver!(u_ode::AbstractVector, mesh::TreeMesh{2}, equations,
             MPI.Waitall(requests, MPI.Status)
         end
     end # GC.@preserve old_u_ode
+
+    return nothing
 end
 
 # Refine elements in the DG solver based on a list of cell_ids that should be refined.

src/callbacks_step/callbacks_step.jl

@@ -9,7 +9,7 @@
 # that should be saved
 function get_element_variables!(element_variables, u, mesh, equations, solver, cache,
                                 callback; kwargs...)
-    nothing
+    return nothing
 end
 
 @inline function get_element_variables!(element_variables, u_ode,

src/callbacks_step/save_solution.jl

@@ -276,6 +276,8 @@ end
                                                              element_variables,
                                                              solution_callback.node_variables,
                                                              system = system)
+
+    return nothing
 end
 
 @inline function save_solution_file(u_ode, t, dt, iter,
@@ -289,6 +291,8 @@ end
                        solution_callback,
                        element_variables,
                        node_variables; system = system)
+
+    return nothing
 end
 
 # TODO: Taal refactor, move save_mesh_file?

src/callbacks_step/time_series_dg_tree.jl

@@ -114,6 +114,8 @@ function record_state_at_points!(point_data, u, solution_variables,
             end
         end
     end
+
+    return nothing
 end
 
 # Record the solution variables at each given point for the 2D case
@@ -147,6 +149,8 @@ function record_state_at_points!(point_data, u, solution_variables,
             end
         end
     end
+
+    return nothing
 end
 
 # Record the solution variables at each given point for the 3D case
@@ -181,5 +185,7 @@ function record_state_at_points!(point_data, u, solution_variables,
             end
         end
     end
+
+    return nothing
 end
 end # @muladd