WIP: Additional analysis for multi-component Euler systems.

[SimonCan]

This adds analysis options, like enstrophy for the multicomponent Euler scheme.

[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

❌ Patch coverage is 8.43373% with 76 lines in your changes missing coverage. Please review.
✅ Project coverage is 87.08%. Comparing base (96c7aef) to head (df58d7f).

Files with missing lines	Patch %	Lines
src/callbacks_step/analysis_dg2d.jl	9.21%	69 Missing ⚠️
.../equations/compressible_euler_multicomponent_2d.jl	0.00%	7 Missing ⚠️

❗ There is a different number of reports uploaded between BASE (96c7aef) and HEAD (df58d7f). Click for more details.

HEAD has 2 uploads less than BASE

Flag	BASE (96c7aef)	HEAD (df58d7f)
unittests	25	23

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #2414      +/-   ##
==========================================
- Coverage   96.36%   87.08%   -9.27%     
==========================================
  Files         527      527              
  Lines       42559    42629      +70     
==========================================
- Hits        41008    37123    -3885     
- Misses       1551     5506    +3955     

Flag	Coverage Δ
unittests	87.08% <8.43%> (-9.27%)	⬇️

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.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

[DanielDoehring]

Why different signature compared to old and added functions?

[DanielDoehring]

What does that do/why is this needed?

[DanielDoehring]

What is this if-clause?

[github-actions]

[JuliaFormatter] _{reported by reviewdog 🐶}

Suggested change

	gradients_local = Vector([gradients_x[:, i, j, element], gradients_y[:, i, j, element]])
	gradients_local = Vector([
	gradients_x[:, i, j, element],
	gradients_y[:, i, j, element]
	])

[github-actions]

[JuliaFormatter] _{reported by reviewdog 🐶}

Suggested change

	Trixi.calc_surface_integral!(surface_flux_values, u, mesh, equations, dg.surface_integral, dg, cache)
	Trixi.calc_surface_integral!(surface_flux_values, u, mesh, equations,
	dg.surface_integral, dg, cache)

[github-actions]

[JuliaFormatter] _{reported by reviewdog 🐶}

Suggested change

	# # Contract D in the ξ̂ (first spatial) direction
	# gradients[v, :, :, elem] .= D * u[v, :, :, elem]
	# # Average over element.
	# # Contract D in the ξ̂ (first spatial) direction
	# gradients[v, :, :, elem] .= D * u[v, :, :, elem]
	# # Average over element.

[github-actions]

[JuliaFormatter] _{reported by reviewdog 🐶}

Suggested change

	average = sum(gradients[v, :, :, elem]/Np^2)
	average = sum(gradients[v, :, :, elem] / Np^2)

[github-actions]

[JuliaFormatter] _{reported by reviewdog 🐶}

Suggested change

	# # Contract D in the ξ̂ (first spatial) direction
	# gradients[v, :, :, elem] .= u[v, :, :, elem] * D'
	# # Contract D in the ξ̂ (first spatial) direction
	# gradients[v, :, :, elem] .= u[v, :, :, elem] * D'

[github-actions]

[JuliaFormatter] _{reported by reviewdog 🐶}

Suggested change

	average = sum(gradients[v, :, :, elem]/Np^2)
	average = sum(gradients[v, :, :, elem] / Np^2)

[github-actions]

[JuliaFormatter] _{reported by reviewdog 🐶}

Suggested change

	enstrophy, magnetic_field, divergence_cleaning_field, enstrophy_multi_euler, vorticity
	enstrophy, magnetic_field, divergence_cleaning_field, enstrophy_multi_euler,
	vorticity

[github-actions]

[JuliaFormatter] _{reported by reviewdog 🐶}

Suggested change

	equations::CompressibleEulerMulticomponentEquations2D)
	equations::CompressibleEulerMulticomponentEquations2D)