Util
TrixiParticles.examples_dir
— Methodexamples_dir()
Return the directory where the example files provided with TrixiParticles.jl are located. If TrixiParticles is installed as a regular package (with ]add TrixiParticles
), these files are read-only and should not be modified. To find out which files are available, use, e.g., readdir
.
Copied from Trixi.jl.
Examples
readdir(examples_dir())
TrixiParticles.validation_dir
— Methodvalidation_dir()
Return the directory where the validation files provided with TrixiParticles.jl are located. If TrixiParticles is installed as a regular package (with ]add TrixiParticles
), these files are read-only and should not be modified. To find out which files are available, use, e.g., readdir
.
Copied from Trixi.jl.
Examples
readdir(validation_dir())
TrixiParticles.@autoinfiltrate
— Macro@autoinfiltrate
@autoinfiltrate condition::Bool
Invoke the @infiltrate
macro of the package Infiltrator.jl to create a breakpoint for ad-hoc interactive debugging in the REPL. If the optional argument condition
is given, the breakpoint is only enabled if condition
evaluates to true
.
As opposed to using Infiltrator.@infiltrate
directly, this macro does not require Infiltrator.jl to be added as a dependency to TrixiParticles.jl. As a bonus, the macro will also attempt to load the Infiltrator module if it has not yet been loaded manually.
Note: For this macro to work, the Infiltrator.jl package needs to be installed in your current Julia environment stack.
See also: Infiltrator.jl
Please note that this macro is intended for internal use only. It is not part of the public API of TrixiParticles.jl, and it thus can altered (or be removed) at any time without it being considered a breaking change.