Plotting Scalar Arrays

EarthBox.PlotToolsManager.ModelPlots2DManager.plot_scalars — Function
plot_scalars(;
    scalar_name::Union{String, Symbol},
    model_output_path::String,
    dimensions::Tuple{Float64, Float64, Float64, Float64},
    xy_spacing::Tuple{Float64, Float64},
    istart::Int64 = 1,
    iend::Union{Int64, Nothing} = nothing,
    kwargs...
)::Nothing

Arguments

  • scalar_name::Union{String, Symbol}:
    • Name of scalar to plot
  • model_output_path::String:
    • Path to output directory containing model output files
  • dimensions::Tuple{Float64, Float64, Float64, Float64}:
    • Dimensions of plot: (xmin, xmax, ymin, ymax)
  • xyspacing::Tuple{Float64, Float64}:
    • Spacing of ticks for the x and y axes: (xspacing, yspacing)
  • istart::Int64 = 1:
    • Initial starting time step
  • iend::Union{Int64, Nothing} = nothing:
    • Final ending time step

Optional Scalar Plotting Keyword Arguments

  • contour_interval::Float64:
    • Interval for contour lines (defaults based on scalar name)
  • minimum_value::Float64:
    • Minimum value for contour lines (defaults based on scalar name)
  • maximum_value::Float64:
    • Maximum value for contour lines (defaults based on scalar name)
  • plot_contours::Bool:
    • Plot contours (default is false)
  • grid_plot_type::String:
    • Grid plot type: "nomesh" or "mesh" (default is "nomesh")

Optional General Plotting Keyword Arguments

  • nsteps::Int:
    • Number of time steps to plot
  • nskip::Int:
    • Number of time steps to skip
  • istart::Int:
    • Initial starting time step
  • iplot_contour_labels::Int:
    • 0 = off; 1 = plot contour labels
  • color_map::Union{String, Symbol}:
    • color map name for scalar grid plots (see https://docs.makie.org/dev/explanations/colors)
  • figure_dpi::Float64:
    • Dots per square inch for figures
  • figsize::Tuple{Float64, Float64}:
    • Figure size in inches in x-y directions
  • length_units::String:
    • Length units for plots ("km", "m", "cm")
  • time_units::String:
    • Time units for plots ("Myr", "yr", "s")
  • velocity_units::String:
    • Velocity units for plots ("cm/yr", "cm/hr", "m/s", "m/yr", "mm/yr")
  • temperature_units::String:
    • Temperature units for plots ("C", "K")
  • viscosity_units::String:
    • Viscosity units for plots ("Pa.s", "log10(Pa.s)")
  • strainrate_units::String:
    • Strain rate units for plots ("1/s", "log10(1/s)")
  • pressure_units::String:
    • Pressure units for plots ("Pa", "GPa", "MPa")
  • stress_units::String:
    • Stress units for plots ("Pa", "GPa", "MPa")
  • linewidth::Float64:
    • Line width for plots
  • edgecolor::String:
    • Edge color for plots
  • show_nodes::Bool:
    • Show nodes on plots
  • dimensions::Tuple{Float64, Float64, Float64, Float64}:
    • Dimensions of plot: (xmin, xmax, ymin, ymax)
  • dim_close_up::Union{Tuple{Float64, Float64, Float64, Float64}, Nothing}:
    • Dimensions of zoomed in plot: (xmin, xmax, ymin, ymax)
  • xyspacing::Tuple{Float64, Float64}:
    • Spacing of ticks for the x and y axes: (xspacing, yspacing)
  • xy_location_contour_legend::Tuple{Float64, Float64}:
    • Location of low-left-hand corner of contour legend
  • title_fontsize::Int:
    • Font size for title
  • axis_title_fontsize::Int:
    • Font size for axis titles
  • axis_labels_fontsize::Int:
    • Font size for axis labels
  • axis_ticks_fontsize::Int:
    • Font size for axis ticks
  • contour_label_fontsize::Int:
    • Font size for contour labels
  • number_format::String:
    • Number format for contours (e.g. "%6.1f")
  • legend_fontsize::Int:
    • Font size for legend
  • colorbar_ticks_fontsize::Int:
    • Font size for color bar ticks
  • colorbar_labels_fontsize::Int:
    • Font size for color bar labels
  • text_box_font_size::Int:
    • Font size for text box
  • extension::String:
    • Extension for plots (e.g. ".png", ".pdf")

Valid Scalar Names

  • temperature
  • viscosity
  • strainrate
  • pressure
  • normal_stress
  • shear_stress
  • shear_plastic_failure
  • normal_plastic_failure
  • velocity_x
  • velocity_y
  • velocity_mag
  • density
  • thermal_conductivity
source