first draft IMEX JinXin #1963
Open
first draft IMEX JinXin #1963
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Review checklistThis checklist is meant to assist creators of PRs (to let them know what reviewers will typically look for) and reviewers (to guide them in a structured review process). Items do not need to be checked explicitly for a PR to be eligible for merging. Purpose and scope
Code quality
Documentation
Testing
Performance
Verification
Created with ❤️ by the Trixi.jl community. |
|
There was a missing sign on my implementation, now the code seems to run well. I'm gonna make further test, clean up everything and improve the implementation where is possible. |
|
Could you please run the code formatter as described in https://trixi-framework.github.io/Trixi.jl/stable/styleguide/? |
Done! |
ranocha
reviewed
Jun 13, 2024
Comment on lines
+8
to
+10
| # Abstract base type for time integration schemes of explicit strong stability-preserving (SSP) | ||
| # Runge-Kutta (RK) methods. They are high-order time discretizations that guarantee the TVD property. | ||
| abstract type SimpleAlgorithmIMEX end |
Comment on lines
+219
to
+220
| mesh, equations, solver, cache = Trixi.mesh_equations_solver_cache(semi) | ||
| relaxation_rate = equations.eps_relaxation |
There was a problem hiding this comment.
Ideally, we should have two options for this type of integrator:
- If Jin-Xin relaxation equations are used, do the IMEX stuff
- Otherwise, just apply the explicit method
We may not need to implement this right now but should keep a TODO note
Comment on lines
+442
to
+444
| for var in (nvars_base + 1):(nvars_base * 3) | ||
| u_wrap[var, i, j, element] *= factor | ||
| end |
There was a problem hiding this comment.
This function is called set_to_zero! but also multiplies the other variables by some factor. Is this desired? If so, can we rename the function accordingly?
Comment on lines
+450
to
+464
| function set_cons_var_to_zero!(u, semi, solver, cache, equations, mesh::TreeMesh1D) | ||
| u_wrap = Trixi.wrap_array(u, semi) | ||
| nvars_base = nvariables(equations.equations_base) | ||
| @unpack inverse_jacobian = cache.elements | ||
| for element in eachelement(solver, cache) | ||
| factor = inverse_jacobian[element] | ||
| factor = 1.0 | ||
| for i in eachnode(solver) | ||
| for var in 1:nvars_base | ||
| u_wrap[var, i, element] = 0.0 | ||
| end | ||
| for var in (nvars_base + 1):(nvars_base * 2) | ||
| u_wrap[var, i, element] *= factor | ||
| end | ||
| end |
Comment on lines
+649
to
+658
| get_tmp_cache(integrator::SimpleIntegratorIMEX) = (integrator.r0,) | ||
| get_tmp_cache(integrator::SimpleIntegratorIMEX) = (integrator.fu1,) | ||
| get_tmp_cache(integrator::SimpleIntegratorIMEX) = (integrator.fu2,) | ||
| get_tmp_cache(integrator::SimpleIntegratorIMEX) = (integrator.fu3,) | ||
| get_tmp_cache(integrator::SimpleIntegratorIMEX) = (integrator.du1,) | ||
| get_tmp_cache(integrator::SimpleIntegratorIMEX) = (integrator.du2,) | ||
| get_tmp_cache(integrator::SimpleIntegratorIMEX) = (integrator.du3,) | ||
| get_tmp_cache(integrator::SimpleIntegratorIMEX) = (integrator.u1,) | ||
| get_tmp_cache(integrator::SimpleIntegratorIMEX) = (integrator.u2,) | ||
| get_tmp_cache(integrator::SimpleIntegratorIMEX) = (integrator.u3,) |
There was a problem hiding this comment.
Only one of these functions survives - so we should have only one version
Comment on lines
+678
to
+684
| """ | ||
| modify_dt_for_tstops!(integrator::SimpleIntegratorSSP) | ||
| Modify the time-step size to match the time stops specified in integrator.opts.tstops. | ||
| To avoid adding OrdinaryDiffEq to Trixi's dependencies, this routine is a copy of | ||
| https://github.com/SciML/OrdinaryDiffEq.jl/blob/d76335281c540ee5a6d1bd8bb634713e004f62ee/src/integrators/integrator_utils.jl#L38-L54 | ||
| """ | ||
| function modify_dt_for_tstops!(integrator::SimpleIntegratorIMEX) |
There was a problem hiding this comment.
Suggested change
| """ | |
| modify_dt_for_tstops!(integrator::SimpleIntegratorSSP) | |
| Modify the time-step size to match the time stops specified in integrator.opts.tstops. | |
| To avoid adding OrdinaryDiffEq to Trixi's dependencies, this routine is a copy of | |
| https://github.com/SciML/OrdinaryDiffEq.jl/blob/d76335281c540ee5a6d1bd8bb634713e004f62ee/src/integrators/integrator_utils.jl#L38-L54 | |
| """ | |
| function modify_dt_for_tstops!(integrator::SimpleIntegratorIMEX) |
Comment on lines
+714
to
+727
| function Base.resize!(semi::AbstractSemidiscretization, new_size) | ||
| resize!(semi, semi.solver.volume_integral, new_size) | ||
| end | ||
|
|
||
| Base.resize!(semi, volume_integral::AbstractVolumeIntegral, new_size) = nothing | ||
|
|
||
| function Base.resize!(semi, volume_integral::VolumeIntegralSubcellLimiting, new_size) | ||
| # Resize container antidiffusive_fluxes | ||
| resize!(semi.cache.antidiffusive_fluxes, new_size) | ||
|
|
||
| # Resize container subcell_limiter_coefficients | ||
| @unpack limiter = volume_integral | ||
| resize!(limiter.cache.subcell_limiter_coefficients, new_size) | ||
| end |
There was a problem hiding this comment.
I think this is not needed here, is it?
|
Looks like you used another version of the JuliaFormatter for formatting resulting in many unrelated changes, see also #1976. Can you rerun the formatter with the other version, please? |
Co-authored-by: Hendrik Ranocha <[email protected]>
Co-authored-by: Hendrik Ranocha <[email protected]>
Co-authored-by: Hendrik Ranocha <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I made a first dirty and "straightforward" draft, but as I anticipated it might have some bugs. I still didn't generalize to keep it simple until I'm sure it will work. I broke it down to the simplest way to make it work, but I couldn't find any major mistakes.