Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/Project.toml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
DocumenterCitations = "daee34ce-89f3-4625-b898-19384cb65244"
DocumenterMermaid = "a078cd44-4d9c-4618-b545-3ab9d77f9177"
Literate = "98b081ad-f1c9-55d3-8b20-4c87d4299306"
OrdinaryDiffEq = "1dea7af3-3e70-54e6-95c3-0bf5283fa5ed"
OrdinaryDiffEqLowStorageRK = "b0944070-b475-4768-8dec-fb6eb410534d"
Plots = "91a5bcdd-55d7-5caf-9e0b-520d859cae80"

[compat]
Expand All @@ -15,5 +15,5 @@ Documenter = "1"
DocumenterCitations = "1"
DocumenterMermaid = "0.2"
Literate = "2"
OrdinaryDiffEq = "6"
OrdinaryDiffEqLowStorageRK = "1"
Plots = "1"
2 changes: 1 addition & 1 deletion docs/literate/src/tut_custom_kernel.jl
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
# [OrdinaryDiffEq.jl](https://github.com/SciML/OrdinaryDiffEq.jl), which we will
# use at the very end for the time integration.
using TrixiParticles
using OrdinaryDiffEq
using OrdinaryDiffEqLowStorageRK

# ## Load a simulation file

Expand Down
2 changes: 1 addition & 1 deletion docs/literate/src/tut_packing.jl
Original file line number Diff line number Diff line change
Expand Up @@ -131,7 +131,7 @@ plot!(geometry, linestyle=:dash, label=nothing, showaxis=false, color=:black,
# the packing process.

# We first need to import [OrdinaryDiffEq.jl](https://github.com/SciML/OrdinaryDiffEq.jl).
using OrdinaryDiffEq
using OrdinaryDiffEqLowStorageRK

# Next, we set a background pressure. This can be chosen arbitrarily.
# A higher value results in smaller time steps, but the final packed state
Expand Down
2 changes: 1 addition & 1 deletion docs/literate/src/tut_rigid_body_fsi.jl
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
# 4. Using a different geometry.

using TrixiParticles
using OrdinaryDiffEq
using OrdinaryDiffEqLowStorageRK
using Plots

# ## Resolution and basic setup
Expand Down
2 changes: 1 addition & 1 deletion docs/literate/src/tut_setup.jl
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
# [OrdinaryDiffEq.jl](https://github.com/SciML/OrdinaryDiffEq.jl), which we will
# use at the very end for the time integration.
using TrixiParticles
using OrdinaryDiffEq
using OrdinaryDiffEqLowStorageRK

# ## Resolution

Expand Down
14 changes: 9 additions & 5 deletions docs/src/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,14 @@ with Julia v1.10 and newer. We recommend using the latest stable release of Juli
## For users
TrixiParticles.jl is a registered Julia package.
You can install TrixiParticles.jl,
[OrdinaryDiffEq.jl](https://github.com/SciML/OrdinaryDiffEq.jl) (used for time integration)
time integration sub-packages of [OrdinaryDiffEq.jl](https://github.com/SciML/OrdinaryDiffEq.jl)
(e.g., `OrdinaryDiffEqLowStorageRK.jl`)
and [Plots.jl](https://github.com/JuliaPlots/Plots.jl) by executing the following commands
in the Julia REPL:
```julia
julia> using Pkg

julia> Pkg.add(["TrixiParticles", "OrdinaryDiffEq", "Plots"])
julia> Pkg.add(["TrixiParticles", "OrdinaryDiffEqLowStorageRK", "Plots"])
```

## [For developers](@id for-developers)
Expand All @@ -25,7 +26,7 @@ git clone git@github.com:trixi-framework/TrixiParticles.jl.git
cd TrixiParticles.jl
mkdir run
julia --project=run -e 'using Pkg; Pkg.develop(PackageSpec(path="."))' # Add TrixiParticles.jl to `run` project
julia --project=run -e 'using Pkg; Pkg.add(["OrdinaryDiffEq", "Plots"])' # Add additional packages
julia --project=run -e 'using Pkg; Pkg.add(["OrdinaryDiffEqLowStorageRK", "Plots"])' # Add additional packages
```

If you installed TrixiParticles.jl this way, you always have to start Julia with the
Expand All @@ -36,11 +37,14 @@ julia --project=run
from the TrixiParticles.jl root directory.

The advantage of using a separate `run` directory is that you can also add other
related packages (e.g., OrdinaryDiffEq.jl, see above) to the project in the `run` folder
related packages (e.g., time integration sub-packages of OrdinaryDiffEq.jl, see above)
to the project in the `run` folder
and always have a reproducible environment at hand to share with others.

## Optional software/packages
- [OrdinaryDiffEq.jl](https://github.com/SciML/OrdinaryDiffEq.jl) -- A Julia package of ordinary differential equation solvers that is used in the examples
- [OrdinaryDiffEq.jl](https://github.com/SciML/OrdinaryDiffEq.jl) sub-packages
(e.g., `OrdinaryDiffEqLowStorageRK.jl`) -- Julia packages of ordinary differential
equation solvers that are used in the examples
- [Plots.jl](https://github.com/JuliaPlots/Plots.jl) -- Julia Plotting library that is used in some examples
- [PythonPlot.jl](https://github.com/JuliaPy/PythonPlot.jl) -- Plotting library that can be used instead of Plots.jl
- [ParaView](https://www.paraview.org/) -- Software that can be used for visualization of results
Expand Down
2 changes: 1 addition & 1 deletion docs/src/time_integration.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ After obtaining an `ODEProblem` from [`semidiscretize`](@ref), let us call it `o
we can pass it to the function `solve` of OrdinaryDiffEq.jl.
For most schemes, we do the following:
```julia
using OrdinaryDiffEq
using OrdinaryDiffEqLowStorageRK
sol = solve(ode, Euler(),
dt=1.0,
save_everystep=false, callback=callbacks);
Expand Down
2 changes: 1 addition & 1 deletion examples/dem/collapsing_sand_pile_3d.jl
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
# ==========================================================================================

using TrixiParticles
using OrdinaryDiffEq
using OrdinaryDiffEqLowStorageRK

# Physical parameters
gravity = -9.81
Expand Down
2 changes: 1 addition & 1 deletion examples/dem/rectangular_tank_2d.jl
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
# ==========================================================================================

using TrixiParticles
using OrdinaryDiffEq
using OrdinaryDiffEqLowStorageRK

gravity = -9.81

Expand Down
2 changes: 1 addition & 1 deletion examples/fluid/accelerated_tank_2d.jl
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
# ==========================================================================================

using TrixiParticles
using OrdinaryDiffEq
using OrdinaryDiffEqLowStorageRK

# Resolution
fluid_particle_spacing = 0.05
Expand Down
2 changes: 1 addition & 1 deletion examples/fluid/dam_break_2d.jl
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
# ==========================================================================================

using TrixiParticles
using OrdinaryDiffEq
using OrdinaryDiffEqLowStorageRK

# Size parameters
H = 0.6
Expand Down
2 changes: 1 addition & 1 deletion examples/fluid/dam_break_2phase_2d.jl
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
# ==========================================================================================

using TrixiParticles
using OrdinaryDiffEq
using OrdinaryDiffEqLowStorageRK

# Size parameters
H = 0.6
Expand Down
2 changes: 1 addition & 1 deletion examples/fluid/dam_break_3d.jl
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
# ==========================================================================================

using TrixiParticles
using OrdinaryDiffEq
using OrdinaryDiffEqLowStorageRK

# ==========================================================================================
# ==== Resolution
Expand Down
2 changes: 1 addition & 1 deletion examples/fluid/dam_break_oil_film_2d.jl
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
# ==========================================================================================

using TrixiParticles
using OrdinaryDiffEq
using OrdinaryDiffEqLowStorageRK

# Size parameters
H = 0.6
Expand Down
2 changes: 1 addition & 1 deletion examples/fluid/falling_water_column_2d.jl
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
# ==========================================================================================

using TrixiParticles
using OrdinaryDiffEq
using OrdinaryDiffEqLowStorageRK

# ==========================================================================================
# ==== Resolution
Expand Down
2 changes: 1 addition & 1 deletion examples/fluid/falling_water_spheres_2d.jl
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
# ==========================================================================================

using TrixiParticles
using OrdinaryDiffEq
using OrdinaryDiffEqLowStorageRK

# ==========================================================================================
# ==== Resolution
Expand Down
2 changes: 1 addition & 1 deletion examples/fluid/falling_water_spheres_3d.jl
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
# ==========================================================================================

using TrixiParticles
using OrdinaryDiffEq
using OrdinaryDiffEqLowStorageRK

# ==========================================================================================
# ==== Resolution
Expand Down
2 changes: 1 addition & 1 deletion examples/fluid/hydrostatic_water_column_2d.jl
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
# ==========================================================================================

using TrixiParticles
using OrdinaryDiffEq
using OrdinaryDiffEqLowStorageRK

# ==========================================================================================
# ==== Resolution
Expand Down
2 changes: 1 addition & 1 deletion examples/fluid/lid_driven_cavity_2d.jl
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
# ==========================================================================================

using TrixiParticles
using OrdinaryDiffEq
using OrdinaryDiffEqLowStorageRK

# ==========================================================================================
# ==== Resolution
Expand Down
2 changes: 1 addition & 1 deletion examples/fluid/moving_wall_2d.jl
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
# ==========================================================================================

using TrixiParticles
using OrdinaryDiffEq
using OrdinaryDiffEqLowStorageRK

# ==========================================================================================
# ==== Resolution
Expand Down
2 changes: 1 addition & 1 deletion examples/fluid/oscillating_drop_2d.jl
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
# ==========================================================================================

using TrixiParticles
using OrdinaryDiffEq
using OrdinaryDiffEqLowStorageRK

# ==========================================================================================
# ==== Resolution
Expand Down
2 changes: 1 addition & 1 deletion examples/fluid/periodic_array_of_cylinders_2d.jl
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
# ==========================================================================================

using TrixiParticles
using OrdinaryDiffEq
using OrdinaryDiffEqLowStorageRK

# ==========================================================================================
# ==== Resolution
Expand Down
2 changes: 1 addition & 1 deletion examples/fluid/periodic_channel_2d.jl
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
# ==========================================================================================

using TrixiParticles
using OrdinaryDiffEq
using OrdinaryDiffEqLowStorageRK

# ==========================================================================================
# ==== Resolution
Expand Down
2 changes: 1 addition & 1 deletion examples/fluid/pipe_flow_2d.jl
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
# ==========================================================================================

using TrixiParticles
using OrdinaryDiffEq
using OrdinaryDiffEqLowStorageRK

# ==========================================================================================
# ==== Resolution
Expand Down
2 changes: 1 addition & 1 deletion examples/fluid/poiseuille_flow_2d.jl
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
# ==========================================================================================

using TrixiParticles
using OrdinaryDiffEq
using OrdinaryDiffEqLowStorageRK

# ==========================================================================================
# ==== Resolution
Expand Down
2 changes: 1 addition & 1 deletion examples/fluid/poiseuille_flow_3d.jl
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
# including open boundary conditions.
# ==========================================================================================
using TrixiParticles
using OrdinaryDiffEq
using OrdinaryDiffEqLowStorageRK

# ==========================================================================================
# ==== Resolution
Expand Down
2 changes: 1 addition & 1 deletion examples/fluid/sphere_surface_tension_2d.jl
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
# ==========================================================================================

using TrixiParticles
using OrdinaryDiffEq
using OrdinaryDiffEqLowStorageRK

fluid_density = 1000.0

Expand Down
2 changes: 1 addition & 1 deletion examples/fluid/sphere_surface_tension_3d.jl
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
# ==========================================================================================

using TrixiParticles
using OrdinaryDiffEq
using OrdinaryDiffEqLowStorageRK

fluid_density = 1000.0

Expand Down
2 changes: 1 addition & 1 deletion examples/fluid/sphere_surface_tension_wall_2d.jl
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
# ==========================================================================================

using TrixiParticles
using OrdinaryDiffEq
using OrdinaryDiffEqLowStorageRK

# ==========================================================================================
# ==== Resolution
Expand Down
2 changes: 1 addition & 1 deletion examples/fluid/taylor_green_vortex_2d.jl
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
# ==========================================================================================

using TrixiParticles
using OrdinaryDiffEq
using OrdinaryDiffEqLowStorageRK

# ==========================================================================================
# ==== Resolution
Expand Down
2 changes: 1 addition & 1 deletion examples/fsi/dam_break_gate_2d.jl
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
# ==========================================================================================

using TrixiParticles
using OrdinaryDiffEq
using OrdinaryDiffEqLowStorageRK

# ==========================================================================================
# ==== Resolution
Expand Down
2 changes: 1 addition & 1 deletion examples/fsi/dam_break_plate_2d.jl
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
# ==========================================================================================

using TrixiParticles
using OrdinaryDiffEq
using OrdinaryDiffEqLowStorageRK

# ==========================================================================================
# ==== Resolution
Expand Down
2 changes: 1 addition & 1 deletion examples/fsi/falling_rigid_spheres_2d.jl
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
# ==========================================================================================

using TrixiParticles
using OrdinaryDiffEq
using OrdinaryDiffEqLowStorageRK

# ==========================================================================================
# ==== Resolution
Expand Down
2 changes: 1 addition & 1 deletion examples/fsi/falling_rotating_rigid_squares_2d.jl
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
# ==========================================================================================

using TrixiParticles
using OrdinaryDiffEq
using OrdinaryDiffEqLowStorageRK

# ==========================================================================================
# ==== Resolution
Expand Down
2 changes: 1 addition & 1 deletion examples/fsi/falling_rotating_rigid_squares_w_buoys_2d.jl
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
# ==========================================================================================

using TrixiParticles
using OrdinaryDiffEq
using OrdinaryDiffEqLowStorageRK

tspan = (0.0, 2.0)

Expand Down
2 changes: 1 addition & 1 deletion examples/fsi/falling_spheres_2d.jl
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
# ==========================================================================================

using TrixiParticles
using OrdinaryDiffEq
using OrdinaryDiffEqLowStorageRK

# ==========================================================================================
# ==== Resolution
Expand Down
2 changes: 1 addition & 1 deletion examples/fsi/falling_water_column_2d.jl
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
# ==========================================================================================

using TrixiParticles
using OrdinaryDiffEq
using OrdinaryDiffEqLowStorageRK

# ==========================================================================================
# ==== Resolution
Expand Down
2 changes: 1 addition & 1 deletion examples/fsi/hydrostatic_water_column_2d.jl
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
# ==========================================================================================

using TrixiParticles
using OrdinaryDiffEq
using OrdinaryDiffEqLowStorageRK
using JSON

# ==========================================================================================
Expand Down
2 changes: 1 addition & 1 deletion examples/n_body/n_body_solar_system.jl
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
# ==========================================================================================

using TrixiParticles
using OrdinaryDiffEq
using OrdinaryDiffEqLowStorageRK
using Printf

include("n_body_system.jl")
Expand Down
Loading