Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

WIP: In-situ visualization #1: Make Makie available in VisualizationCallback #2195

Closed
wants to merge 1 commit into from
Closed

WIP: In-situ visualization #1: Make Makie available in VisualizationCallback #2195

wants to merge 1 commit into from

Conversation

benegee
Copy link
Contributor

@benegee benegee commented Dec 9, 2024

No description provided.

@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Dec 9, 2024

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.

github-actions[bot]
github-actions bot reviewed Dec 9, 2024
View reviewed changes
src/callbacks_step/visualization.jl
@@ -13,6 +13,7 @@ mutable struct VisualizationCallback{SolutionVariables, VariableNames, PlotDataC
show_mesh::Bool
plot_data_creator::PlotDataCreator
plot_creator::PlotCreator
figure
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[JuliaFormatter] reported by reviewdog 🐶

Suggested change
figure
figure::Any

src/callbacks_step/visualization.jl
@@ -98,7 +99,7 @@
visualization_callback = VisualizationCallback(interval,
solution_variables, variable_names,
show_mesh,
plot_data_creator, plot_creator,
plot_data_creator, plot_creator, nothing,
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[JuliaFormatter] reported by reviewdog 🐶

Suggested change
plot_data_creator, plot_creator, nothing,
plot_data_creator, plot_creator,
nothing,

src/callbacks_step/visualization.jl
@@ -110,8 +111,9 @@
# Requires.jl only when Plots is present.
# In the future, we should update/remove this warning if other plotting packages are
# starting to be used.
if !(:Plots in names(@__MODULE__, all = true))
@warn "Package `Plots` not loaded but required by `VisualizationCallback` to visualize results"
if !(:Plots in names(@__MODULE__, all = true) || :Makie in names(@__MODULE__, all = true))
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[JuliaFormatter] reported by reviewdog 🐶

Suggested change
if !(:Plots in names(@__MODULE__, all = true) || :Makie in names(@__MODULE__, all = true))
if !(:Plots in names(@__MODULE__, all = true) ||
:Makie in names(@__MODULE__, all = true))

src/callbacks_step/visualization.jl
@@ -158,7 +160,7 @@
# Create plot
plot_creator(plot_data, variable_names;
show_mesh = show_mesh, plot_arguments = plot_arguments,
time = integrator.t, timestep = integrator.stats.naccept)
time = integrator.t, timestep = integrator.stats.naccept, figure = figure)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[JuliaFormatter] reported by reviewdog 🐶

Suggested change
time = integrator.t, timestep = integrator.stats.naccept, figure = figure)
time = integrator.t, timestep = integrator.stats.naccept,
figure = figure)

src/callbacks_step/visualization.jl
function show_plot_makie(plot_data, variable_names;
show_mesh = true, plot_arguments = Dict{Symbol, Any}(),
time = nothing, timestep = nothing, figure = nothing)

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[JuliaFormatter] reported by reviewdog 🐶

Suggested change

@benegee benegee changed the title In-situ visualization #1: Make Makie available in VisualizationCallback WIP: In-situ visualization #1: Make Makie available in VisualizationCallback Dec 10, 2024
@benegee benegee closed this Dec 10, 2024
@benegee benegee deleted the bg/makie-visualization-callback branch December 10, 2024 08:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@github-actions github-actions[bot] github-actions[bot] left review comments

@s6nistam s6nistam s6nistam approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@benegee @s6nistam