Skip to content

getting_started.md

Latest commit

 

History

History
56 lines (42 loc) · 2.91 KB

getting_started.md

File metadata and controls

56 lines (42 loc) · 2.91 KB

[Getting Started](@id getting_started)

If you have not installed TrixiParticles.jl yet, please follow the instructions in [Installation](@ref installation).

This page provides a short introduction. For a broader introduction, take a look at our Tutorials.

Running an Example

The easiest way to start is to run one of the 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 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: plot_hydrostatic_water_column

For more information about visualization, see Visualization.

Running Other Examples

You can find more predefined examples under Examples. Run them 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 file itself.

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

This, for example, changes the fluid size from (0.9, 1.0) to (1.0, 0.5).

To understand why, take a look at the file hydrostatic_water_column_2d.jl in the fluid subdirectory of the examples directory, which is the file 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 Your First Simulation from Scratch

See Set up your first simulation.

An overview of the available tutorials is available under Tutorials.