Explain parameters of ParametersEulerGravity

[DanielDoehring]

I consider it relevant to document the behaviour of n_iterations_max in the docstring since

Trixi.jl/src/semidiscretization/semidiscretization_euler_gravity.jl

Lines 304 to 310 in 0d86176

	if n_iterations_max > 0 && iter >= n_iterations_max
	@warn "Max iterations reached: Gravity solver failed to converge!" residual=maximum(abs,
	@views du_gravity[1,
	..,
	:]) tau=tau dtau=dtau
	finalstep = true
	end

In the same go, the other parameters received some more detailed description. I think it is also safe to export the other optimized methods as they are tested:

Trixi.jl/test/test_paper_self_gravitating_gas_dynamics.jl

Lines 162 to 212 in 0d86176

	@trixi_testset "elixir_eulergravity_convergence.jl with 1st order RK3S*" begin
	@test_trixi_include(joinpath(EXAMPLES_DIR, "elixir_eulergravity_convergence.jl"),
	l2=[
	0.00024871265138959434,
	0.000337007710281087,
	0.0003370077102811394,
	0.0007231525515231289
	],
	linf=[
	0.0015813032941613958,
	0.002049428843978518,
	0.0020494288439798503,
	0.004793821198143977
	],
	tspan=(0.0, 0.1),
	timestep_gravity=Trixi.timestep_gravity_erk51_3Sstar!)
	# Ensure that we do not have excessive memory allocations
	# (e.g., from type instabilities)
	let
	t = sol.t[end]
	u_ode = sol.u[end]
	du_ode = similar(u_ode)
	@test (@allocated Trixi.rhs!(du_ode, u_ode, semi, t)) < 1000
	end
	end
	@trixi_testset "elixir_eulergravity_convergence.jl with 3rd order RK3S*" begin
	@test_trixi_include(joinpath(EXAMPLES_DIR, "elixir_eulergravity_convergence.jl"),
	l2=[
	0.0002487126513894034,
	0.00033700771023049785,
	0.00033700771023048245,
	0.0007231525514158737
	],
	linf=[
	0.0015813032943847727,
	0.002049428842844314,
	0.0020494288428452023,
	0.004793821195971937
	],
	tspan=(0.0, 0.1),
	timestep_gravity=Trixi.timestep_gravity_erk53_3Sstar!)
	# Ensure that we do not have excessive memory allocations
	# (e.g., from type instabilities)
	let
	t = sol.t[end]
	u_ode = sol.u[end]
	du_ode = similar(u_ode)
	@test (@allocated Trixi.rhs!(du_ode, u_ode, semi, t)) < 1000
	end
	end

[github-actions]

Review checklist

This 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

• The PR has a single goal that is clear from the PR title and/or description.
• All code changes represent a single set of modifications that logically belong together.
• No more than 500 lines of code are changed or there is no obvious way to split the PR into multiple PRs.

Code quality

• The code can be understood easily.
• Newly introduced names for variables etc. are self-descriptive and consistent with existing naming conventions.
• There are no redundancies that can be removed by simple modularization/refactoring.
• There are no leftover debug statements or commented code sections.
• The code adheres to our conventions and style guide, and to the Julia guidelines.

Documentation

• New functions and types are documented with a docstring or top-level comment.
• Relevant publications are referenced in docstrings (see example for formatting).
• Inline comments are used to document longer or unusual code sections.
• Comments describe intent ("why?") and not just functionality ("what?").
• If the PR introduces a significant change or new feature, it is documented in NEWS.md with its PR number.

Testing

• The PR passes all tests.
• New or modified lines of code are covered by tests.
• New or modified tests run in less then 10 seconds.

Performance

• There are no type instabilities or memory allocations in performance-critical parts.
• If the PR intent is to improve performance, before/after time measurements are posted in the PR.

Verification

• The correctness of the code was verified using appropriate tests.
• If new equations/methods are added, a convergence test has been run and the results
  are posted in the PR.

Created with ❤️ by the Trixi.jl community.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 96.42%. Comparing base (8592c0e) to head (c078a1c).
Report is 1 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #2223   +/-   ##
=======================================
  Coverage   96.42%   96.42%           
=======================================
  Files         486      486           
  Lines       39164    39164           
=======================================
  Hits        37761    37761           
  Misses       1403     1403           

Flag	Coverage Δ
unittests	96.42% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[ranocha]

Thanks

[ranocha]

Let's see whether CI passes this time 🤞