PinCFlow

PinCFlow

Main module of PinCFlow.jl.

See also

• PinCFlow.Types

• PinCFlow.Integration

plot_output(
    file::AbstractString,
    data::HDF5.File,
    fields::Vararg{
        Tuple{<:AbstractString, <:Integer, <:Integer, <:Integer, <:Integer},
    };
    number::Integer = 10,
    colormap_name::Symbol = :seismic,
    space_unit::AbstractString = "km",
    time_unit::AbstractString = "h",
)

Create contour plots of the dataset variable in data, display it and save it to file.

Arguments

• file: File to save the plots to.

• data: PinCFlow.jl output data.

• fields: Tuples of a variable name and four indices. The first three indices of each tuple define the planes in which the contours are to be plotted, whereas the fourth is the temporal index.

Keywords

• number: Number of contour levels.

• colormap_name: Colormap of choice.

• label: Colorbar label for the plots.

• space_unit: Unit used for the coordinates. Must be "km" or "m".

• time_unit: Unit used for the time. Must be "d", "h", "min" or "s".

set_visualization_theme!()

Configure Makie to use a customized theme.

symmetric_contours(
    minimum::AbstractFloat,
    maximum::AbstractFloat;
    number::Integer = 10,
    colormap_name::Symbol = :seismic,
)::Tuple{<:LinRange{<:AbstractFloat, <:Integer}, <:Any}

Compute symmetric contours levels and return them and a correspondingly indexed colormap.

Arguments

• minimum: Smallest value to be plotted.

• maximum: Largest value to be plotted.

Keywords

• number: Number of contour levels.

• colormap_name: Name under which the chosen colormap is registered.

@ivy(x::Expr)

Return the expression x with @inbounds and @views in front of it.