Getting started

If you have not installed TrixiParticles.jl, please follow the instructions given here.

In the following sections, we will give a short introduction. For a more thorough discussion, take a look at our Tutorials.

Running an Example

The easiest way to run a simulation is to run one of our predefined example files. We will run the file examples/fluid/hydrostatic_water_column_2d.jl, which simulates a fluid resting in a rectangular tank. Since TrixiParticles.jl uses multithreading, you should start Julia with the flag --threads auto (or, e.g. --threads 4 for 4 threads).

In the Julia REPL, first load the package TrixiParticles.jl.

julia> using TrixiParticles

Then start the simulation by executing

julia> trixi_include(joinpath(examples_dir(), "fluid", "hydrostatic_water_column_2d.jl"))

The easiest way to quickly visualize the result is to use Plots.jl:

julia> using Plots; plot(sol)

This will open a new window with a 2D visualization of the final solution:

For more information about visualization, see Visualization.

Running other Examples

You can find a list of our other predefined examples under Examples. Execute them as follows from the Julia REPL by replacing subfolder and example_name

julia> trixi_include(joinpath(examples_dir(), "subfolder", "example_name.jl"))

Modifying an example

You can pass keyword arguments to the function trixi_include to overwrite assignments in the file.

With trixi_include, we can overwrite variables defined in the example file to run a different simulation without modifying the example file.

julia> trixi_include(joinpath(examples_dir(), "fluid", "hydrostatic_water_column_2d.jl"), initial_fluid_size=(1.0, 0.5))

This for example, will change the fluid size from $(0.9, 1.0)$ to $(1.0, 0.5)$.

To understand why, take a look into the file hydrostatic_water_column_2d.jl in the subfolder fluid inside the examples directory, which is the file that we executed earlier. You can see that the initial size of the fluid is defined in the variable initial_fluid_size, which we could overwrite with the trixi_include call above. Another variable that is worth experimenting with is fluid_particle_spacing, which controls the resolution of the simulation in this case. A lower value will increase the resolution and the runtime.

Set up you first simulation from scratch

See Set up your first simulation.

Find an overview over the available tutorials under Tutorials.