renamed ParaviewCatalyst to ParaViewCatalyst

benegee · Dec 13, 2024 · 098e2bc · 098e2bc
1 parent 246139e
commit 098e2bc
Show file tree

Hide file tree

Showing 14 changed files with 58 additions and 58 deletions.
diff --git a/docs/src/visualization.md b/docs/src/visualization.md
@@ -400,10 +400,10 @@ below:
 ```
 
 ### Visualizing results during a simulation using Paraview Catalyst
-With a Paraview Installation containing the Catalyst Library, you can use the ParaviewCatalystCallback to visualise your results in Paraview during the simulation.
+With a Paraview Installation containing the Catalyst Library, you can use the ParaViewCatalystCallback to visualise your results in Paraview during the simulation.
 
 ```julia
-    ParaviewCatalystCallback(; interval=0, nvisnodes = nothing, catalyst_pipeline = nothing)
+    ParaViewCatalystCallback(; interval=0, nvisnodes = nothing, catalyst_pipeline = nothing)
 ```
 + `interval` determines the amount of timesteps between calls of this callback
 + `nvisnodes` determines the number of visualization nodes. 
@@ -412,7 +412,7 @@ With a Paraview Installation containing the Catalyst Library, you can use the Pa
     + For example in a 3D Plot each cell has a nxnxn array of visualization nodes
 + `catalyst_pipeline` a path to the catalyst pipeline if the default should not be used
   + The starting view shown by Paraview is determined by a python pipeline
-  + ParaviewCatalyst.jl includes a standard `catalyst_pipeline.py`
+  + ParaViewCatalyst.jl includes a standard `catalyst_pipeline.py`
   + In principle your current view in Paraview can be exported as a pipeline using File->Save Catalyst State...
   but in practice the resulting pipelines did not work in our testing.
   ```python
@@ -426,14 +426,14 @@ With a Paraview Installation containing the Catalyst Library, you can use the Pa
   a block like this needed to replace the bottom of the exported pipeline, to get it working for us
 
 
-To be able to use the ParaviewCatalystCallback you need
+To be able to use the ParaViewCatalystCallback you need
 + A Paraview Installation containing the Catalyst Library
-+ The ParaviewCatalyst.jl Julia package
++ The ParaViewCatalyst.jl Julia package
 + The PARAVIEW_CATALYST_PATH Environment Variable set to the location of the Catalyst Library contained in Paraview
 
-To use the ParaviewCatalystCallback you have to
-+ Include ParaviewCatalyst.jl in your julia Script via `using ParaviewCatalyst`
-+ Create a ParaviewCatalystCallback and add it to your Callbackset
+To use the ParaViewCatalystCallback you have to
++ Include ParaViewCatalyst.jl in your julia Script via `using ParaViewCatalyst`
++ Create a ParaViewCatalystCallback and add it to your Callbackset
 + Before running the script:
   + Open Paraview and press Catalyst->Connect... and use the standard Port of 22222 (if not specified otherwise in the pipeline)
   + Press Catalyst->Pause Simulation

diff --git a/examples/p4est_2d_dgsem/elixir_advection_basic_catalyst.jl b/examples/p4est_2d_dgsem/elixir_advection_basic_catalyst.jl
@@ -3,7 +3,7 @@
 
 using OrdinaryDiffEq
 using Trixi
-using ParaviewCatalyst
+using ParaViewCatalyst
 
 ###############################################################################
 # semidiscretization of the linear advection equation
@@ -48,7 +48,7 @@ save_solution = SaveSolutionCallback(interval = 100,
 # The StepsizeCallback handles the re-calculation of the maximum Δt after each time step
 stepsize_callback = StepsizeCallback(cfl = 1.6)
 
-catalyst_callback = ParaviewCatalystCallback(interval=100)
+catalyst_callback = ParaViewCatalystCallback(interval=100)
 
 # Create a CallbackSet to collect all callbacks such that they can be passed to the ODE solver
 callbacks = CallbackSet(summary_callback, analysis_callback, save_solution,

diff --git a/examples/p4est_3d_dgsem/elixir_advection_cubed_sphere_catalyst.jl b/examples/p4est_3d_dgsem/elixir_advection_cubed_sphere_catalyst.jl
@@ -1,7 +1,7 @@
 
 using OrdinaryDiffEq
 using Trixi
-using ParaviewCatalyst
+using ParaViewCatalyst
 
 ###############################################################################
 # semidiscretization of the linear advection equation
@@ -46,7 +46,7 @@ save_solution = SaveSolutionCallback(interval = 100,
 # The StepsizeCallback handles the re-calculation of the maximum Δt after each time step
 stepsize_callback = StepsizeCallback(cfl = 1.2)
 
-catalyst_callback = ParaviewCatalystCallback(interval=100, interpolation=true)
+catalyst_callback = ParaViewCatalystCallback(interval=100, interpolation=true)
 
 # Create a CallbackSet to collect all callbacks such that they can be passed to the ODE solver
 callbacks = CallbackSet(summary_callback, analysis_callback, save_solution,

diff --git a/examples/p4est_3d_dgsem/elixir_euler_circular_wind_nonconforming_catalyst.jl b/examples/p4est_3d_dgsem/elixir_euler_circular_wind_nonconforming_catalyst.jl
@@ -8,7 +8,7 @@
 using OrdinaryDiffEq
 using Trixi
 using LinearAlgebra
-using ParaviewCatalyst
+using ParaViewCatalyst
 
 ###############################################################################
 # semidiscretization of the compressible Euler equations
@@ -126,7 +126,7 @@ amr_callback = AMRCallback(semi, amr_controller,
                            adapt_initial_condition = true,
                            adapt_initial_condition_only_refine = true)
 
-catalyst_callback = ParaviewCatalystCallback(interval=100)
+catalyst_callback = ParaViewCatalystCallback(interval=100)
 
 callbacks = CallbackSet(summary_callback,
                         analysis_callback,

diff --git a/examples/p4est_3d_dgsem/elixir_euler_source_terms_nonconforming_earth_catalyst.jl b/examples/p4est_3d_dgsem/elixir_euler_source_terms_nonconforming_earth_catalyst.jl
@@ -5,7 +5,7 @@
 using OrdinaryDiffEq
 using Trixi
 using LinearAlgebra
-using ParaviewCatalyst
+using ParaViewCatalyst
 
 ###############################################################################
 # semidiscretization of the compressible Euler equations
@@ -120,7 +120,7 @@ amr_callback = AMRCallback(semi, amr_controller,
                            adapt_initial_condition = true,
                            adapt_initial_condition_only_refine = true)
 
-catalyst_callback = ParaviewCatalystCallback(interval=100)
+catalyst_callback = ParaViewCatalystCallback(interval=100)
 
 callbacks = CallbackSet(summary_callback,
                         analysis_callback,

diff --git a/examples/tree_1d_dgsem/elixir_advection_basic_catalyst.jl b/examples/tree_1d_dgsem/elixir_advection_basic_catalyst.jl
@@ -1,7 +1,7 @@
 
 using OrdinaryDiffEq
 using Trixi
-using ParaviewCatalyst
+using ParaViewCatalyst
 
 ###############################################################################
 # semidiscretization of the linear advection equation
@@ -44,7 +44,7 @@ save_solution = SaveSolutionCallback(interval = 100,
 # The StepsizeCallback handles the re-calculation of the maximum Δt after each time step
 stepsize_callback = StepsizeCallback(cfl = 1.6)
 
-catalyst_callback = ParaviewCatalystCallback(interval=10)
+catalyst_callback = ParaViewCatalystCallback(interval=10)
 
 # Create a CallbackSet to collect all callbacks such that they can be passed to the ODE solver
 callbacks = CallbackSet(summary_callback, analysis_callback, save_solution,

diff --git a/examples/tree_2d_dgsem/elixir_advection_amr_catalyst.jl b/examples/tree_2d_dgsem/elixir_advection_amr_catalyst.jl
@@ -1,7 +1,7 @@
 
 using OrdinaryDiffEq
 using Trixi
-using ParaviewCatalyst
+using ParaViewCatalyst
 
 ###############################################################################
 # semidiscretization of the linear advection equation
@@ -50,7 +50,7 @@ amr_callback = AMRCallback(semi, amr_controller,
 
 stepsize_callback = StepsizeCallback(cfl = 1.6)
 
-catalyst_callback = ParaviewCatalystCallback(interval=10)
+catalyst_callback = ParaViewCatalystCallback(interval=10)
 
 callbacks = CallbackSet(summary_callback,
                         analysis_callback, alive_callback,

diff --git a/examples/tree_2d_dgsem/elixir_advection_basic_catalyst.jl b/examples/tree_2d_dgsem/elixir_advection_basic_catalyst.jl
@@ -1,7 +1,7 @@
 
 using OrdinaryDiffEq
 using Trixi
-using ParaviewCatalyst
+using ParaViewCatalyst
 
 ###############################################################################
 # semidiscretization of the linear advection equation
@@ -44,7 +44,7 @@ save_solution = SaveSolutionCallback(interval = 100,
 # The StepsizeCallback handles the re-calculation of the maximum Δt after each time step
 stepsize_callback = StepsizeCallback(cfl = 1.6)
 
-catalyst_callback = ParaviewCatalystCallback(interval=10)
+catalyst_callback = ParaViewCatalystCallback(interval=10)
 
 # Create a CallbackSet to collect all callbacks such that they can be passed to the ODE solver
 callbacks = CallbackSet(summary_callback, analysis_callback, save_solution,

diff --git a/examples/tree_3d_dgsem/elixir_advection_amr_catalyst.jl b/examples/tree_3d_dgsem/elixir_advection_amr_catalyst.jl
@@ -1,7 +1,7 @@
 
 using OrdinaryDiffEq
 using Trixi
-using ParaviewCatalyst
+using ParaViewCatalyst
 
 ###############################################################################
 # semidiscretization of the linear advection equation
@@ -50,8 +50,8 @@ amr_callback = AMRCallback(semi, amr_controller,
 
 stepsize_callback = StepsizeCallback(cfl = 1.2)
 
-# catalyst_callback = ParaviewCatalystCallback(interval=100)
-catalyst_callback = ParaviewCatalystCallback(interval=100, catalyst_pipeline= joinpath(@__DIR__, "elixir_advection_amr_catalyst_pipeline.py"))
+# catalyst_callback = ParaViewCatalystCallback(interval=100)
+catalyst_callback = ParaViewCatalystCallback(interval=100, catalyst_pipeline= joinpath(@__DIR__, "elixir_advection_amr_catalyst_pipeline.py"))
 
 callbacks = CallbackSet(summary_callback,
                         analysis_callback,

diff --git a/examples/tree_3d_dgsem/elixir_advection_basic_catalyst.jl b/examples/tree_3d_dgsem/elixir_advection_basic_catalyst.jl
@@ -1,7 +1,7 @@
 
 using OrdinaryDiffEq
 using Trixi
-using ParaviewCatalyst
+using ParaViewCatalyst
 
 ###############################################################################
 # semidiscretization of the linear advection equation
@@ -44,7 +44,7 @@ save_solution = SaveSolutionCallback(interval = 100,
 # The StepsizeCallback handles the re-calculation of the maximum Δt after each time step
 stepsize_callback = StepsizeCallback(cfl = 1.2)
 
-catalyst_callback = ParaviewCatalystCallback(interval=10, interpolation=true)
+catalyst_callback = ParaViewCatalystCallback(interval=10, interpolation=true)
 
 # Create a CallbackSet to collect all callbacks such that they can be passed to the ODE solver
 callbacks = CallbackSet(summary_callback, analysis_callback, save_solution,

diff --git a/examples/tree_3d_dgsem/elixir_euler_amr_catalyst.jl b/examples/tree_3d_dgsem/elixir_euler_amr_catalyst.jl
@@ -1,7 +1,7 @@
 
 using OrdinaryDiffEq
 using Trixi
-using ParaviewCatalyst
+using ParaViewCatalyst
 
 ###############################################################################
 # semidiscretization of the compressible Euler equations
@@ -70,7 +70,7 @@ amr_callback = AMRCallback(semi, amr_controller,
 
 stepsize_callback = StepsizeCallback(cfl = 0.9)
 
-catalyst_callback = ParaviewCatalystCallback(interval=100)
+catalyst_callback = ParaViewCatalystCallback(interval=100)
 
 callbacks = CallbackSet(summary_callback,
                         analysis_callback, alive_callback,

diff --git a/examples/tree_3d_dgsem/elixir_euler_amr_visualization_catalyst.jl b/examples/tree_3d_dgsem/elixir_euler_amr_visualization_catalyst.jl
@@ -1,7 +1,7 @@
 
 using OrdinaryDiffEq
 using Trixi
-using ParaviewCatalyst
+using ParaViewCatalyst
 using Plots
 using GLMakie
 
@@ -74,7 +74,7 @@ stepsize_callback = StepsizeCallback(cfl = 0.9)
 
 visualization_callback = VisualizationCallback(interval = 20, clims = (0, 1))
 
-catalyst_callback = ParaviewCatalystCallback(interval=100)
+catalyst_callback = ParaViewCatalystCallback(interval=100)
 
 callbacks = CallbackSet(summary_callback,
                         analysis_callback, alive_callback,

diff --git a/src/Trixi.jl b/src/Trixi.jl
@@ -261,7 +261,7 @@ export SemidiscretizationCoupled
 
 export SummaryCallback, SteadyStateCallback, AnalysisCallback, AliveCallback,
        SaveRestartCallback, SaveSolutionCallback, TimeSeriesCallback, VisualizationCallback,
-       AveragingCallback, ParaviewCatalystCallback,
+       AveragingCallback, ParaViewCatalystCallback,
        AMRCallback, StepsizeCallback,
        GlmSpeedCallback, LBMCollisionCallback, EulerAcousticsCouplingCallback,
        TrivialCallback, AnalysisCallbackCoupled,
@@ -305,10 +305,10 @@ function __init__()
         using .Plots: Plots
     end
 
-    # Enable features that depend on the availability of the ParaviewCatalyst package
+    # Enable features that depend on the availability of the ParaViewCatalyst package
     # TODO: extension?
-    @require ParaviewCatalyst="0fa3a46a-29f8-4c04-a671-08df7e71e505" begin
-        using .ParaviewCatalyst: ParaviewCatalyst
+    @require ParaViewCatalyst="0fa3a46a-29f8-4c04-a671-08df7e71e505" begin
+        using .ParaViewCatalyst: ParaViewCatalyst
     end
 
     @require GLMakie="e9467ef8-e4e7-5192-8a1a-b1aee30e663a" begin