GitHub

Output Configuration

UltraDark.Output.OutputConfig — Type
struct OutputConfig

struct containing information about what to output.

There are two possible output formats:

  • .npy files that use numpy's format. They can be read with NPZ.
  • HDF5 files that can be read with HDF5.

Each member of summary_statistics should be another struct whose constructor generates summary statistics from t, a, Δt and a grids object. If it is to be used with a PencilGrids object, each field must be concrete and have a binary representation that MPI can handle.

By default, summary_statistics will write only the wall time and simulation time.

Fields

  • directory::String: where to write output

  • output_times::Array{Float64}: times at which to output

  • box::Bool: whether to output boxes

  • slice::Bool: whether to output slices

  • psi::Bool: whether to output ψ

  • rho::Bool: whether to output ρ

  • npy::Bool: write .npy files

  • h5::Bool: write HDF5 files

  • summary_statistics::Tuple: Type of summary statistics to collect

source
UltraDark.Output.OutputConfig — Method
OutputConfig(
    directory,
    output_times;
    box,
    slice,
    psi,
    rho,
    npy,
    h5,
    summary_statistics
) -> OutputConfig

Construct an OutputConfig object

source
UltraDark.Output.output_external_state — Method
output_external_state(
    external_state,
    output_config::OutputConfig,
    step,
    index
)

Output states other than the ψ field.

By default this does nothing. It is most useful if overloaded to dispatch on the type of external_state.

Arguments

external_state

output_config::OutputConfig

step

index index of state in external states

source