APIs

Primary data storage type

convertIDLtoVTK(filename; dir=".", gridType=1, verbose=false)

Convert 3D BATSRUS *.out to VTK. If gridType==1, it converts to the rectilinear grid; if gridType==2, it converts to the structured grid. If filename does not end with "out", it tries to find the ".info" and ".tree" file with the same name tag and generates 3D unstructured VTU file.

convertTECtoVTU(head, data, connectivity, filename="out")

Convert unstructured Tecplot data to VTK. Note that if using voxel type data in VTK, the connectivity sequence is different from Tecplot. Note that the 3D connectivity sequence in Tecplot is the same with the hexahedron type in VTK, but different with the voxel type. The 2D connectivity sequence is the same as the quad type, but different with the pixel type. For example, in 3D the index conversion is:

# PLT to VTK voxel index_ = [1 2 4 3 5 6 8 7]
for i = 1:2
   connectivity = swaprows!(connectivity, 4*i-1, 4*i)
end

cutdata(data, var; plotrange=[-Inf,Inf,-Inf,Inf], dir="x", sequence=1)

Get 2D plane cut in orientation dir for var out of 3D box data within plotrange. The returned 2D data lies in the sequence plane from - to + in dir.

cutplot(data, var, ax=nothing; plotrange=[-Inf,Inf,-Inf,Inf], dir="x", sequence=1,
   level=20)

2D plane cut contourf of 3D box data.

Get cell connectivity list.

Return variable data from string var.

getvars(data::Data, Names::Vector) -> Dict

Return variables' data as a dictionary from string vector. See also: getvar.

plotdata(data, func, kwargs)

Plot the variable from SWMF output.

plotdata(data, "p", plotmode="contbar")

plotdata(data, "p", plotmode="grid")

plotdata(data, func, plotmode="trimesh",plotrange=plotrange, plotinterval=0.2)

Input arguments

• data::Data: output data.
• func::String: variables for plotting.
• plotmode::String: (optional) type of plotting ["cont","contbar"]...
• plotrange::Vector: (optional) range of plotting.
• plotinterval: (optional) interval for interpolation.
• level: (optional) level of contour.
• innermask: (optional) Bool for masking a circle at the inner boundary.
• dir: (optional) 2D cut plane orientation from 3D outputs ["x","y","z"].
• sequence: (optional) sequence of plane from - to + in that direction.
• multifigure: (optional) 1 for multifigure display, 0 for subplots.
• verbose: (optional) display additional information.
• density: (optional) density for streamlines.
• stride: (optional) quiver strides in number of cells.

Right now this can only deal with 2D plots or 3D cuts. Full 3D plots may be supported in the future.

plotlogdata(data, head, func; plotmode="line")

Plot information from log file.

Input arguments

• data::Array: output data.
• head::NamedTuple: header info.
• func::String: variables for plotting.
• plotmode::String: type of plotting ["line","scatter"].

readdata(filenameIn; dir=".", npict=1, verbose=false)

Read data from BATSRUS output files. Stores the npict snapshot from an ascii or binary data file into the arrays of coordinates x and data w. Filename can be provided with wildcards.

Examples

data = readdata("1d_raw*")

Return header from info file. Currently only designed for 2D and 3D.

Read information from log file.

readtecdata(filename; verbose=false)

Return header, data and connectivity from BATSRUS Tecplot outputs. Both 2D and 3D binary and ASCII formats are supported.

Examples

filename = "3d_ascii.dat"
head, data, connectivity = readtecdata(filename)

Return BATL tree structure.

showhead(file, filehead)

Displaying file header information.

showhead(data)

showhead(io, data)

Display file information of data.

streamslice(data::Data, var, ax=nothing; plotrange=[-Inf,Inf,-Inf,Inf], dir="x",
   sequence=1; kwargs...)

Plot streamlines on 2D slices of 3D box data. Variable names in var string must be separated with ;.

subsurface(x, y, data, limits)
subsurface(x, y, u, v, limits)

Extract subset of 2D surface dataset. See also: subvolume.

subvolume(x, y, z, data, limits)
subvolume(x, y, z, u, v, w, limits)

Extract subset of 3D dataset in ndgrid format. See also: subsurface.

contour(data, var, levels=0; ax=nothing, plotrange=[-Inf,Inf,-Inf,Inf],
   plotinterval=0.1, innermask=false, kwargs...)

Wrapper over contour in matplotlib.

contourf(data, var, levels=0; ax=nothing, plotrange=[-Inf,Inf,-Inf,Inf],
   plotinterval=0.1, innermask=false, kwargs...)

Wrapper over contourf in matplotlib.

plot(data, var, ax=nothing; kwargs...)

Wrapper over plot in matplotlib.

plot_surface(data, var; plotrange=[-Inf,Inf,-Inf,Inf], plotinterval=0.1,
   innermask=false, kwargs...)

Wrapper over plot_surface in matplotlib.

plot_trisurf(data::Data, var::String, ax=nothing; plotrange=[-Inf,Inf,-Inf,Inf],
   kwargs...)

Wrapper over plot_trisurf in matplotlib.

quiver(data, var, ax=nothing; stride=10, kwargs...)

Wrapper over quiver in matplotlib. Only supports Cartesian grid for now.

scatter(data, var, ax=nothing; kwargs...)

Wrapper over scatter in matplotlib.

streamplot(data, var, ax=nothing; plotrange=[-Inf,Inf,-Inf,Inf], plotinterval=0.1,
   kwargs...)

Wrapper over streamplot in matplotlib. streamplot does not have **kwargs in the API, but it supports density, color, and some other keywords.

tricontourf(data, var, ax=nothing; plotrange=[-Inf,Inf,-Inf,Inf], plotinterval=0.1,
   kwargs...)

Wrapper over tricontourf in matplotlib.

Type for the file information.

BATSRUS output standalone header information.

Create buffer for x and w.

create_pvd(filepattern)

Generate PVD file for a time series collection of VTK data.

Example

create_pvd("*.vtu)

fillCellNeighbors!(batl, iCell_G, DiLevelNei_III, iNodeNei_III, nBlock_P)

Fill neighbor cell indexes for the given block. The faces, edges, and vertices are ordered from left (-) to right (+) in x-y-z sequentially. Vertices: Edges: (10,11 ignored) 7 ––- 8 . –4– .

• . - . 7 . 8 .

5 ––- 6 . . –3– . 12 . . . . . . . . . 3 ––- 4 9 . –2– . . - . - . 5 . 6 1 ––- 2 . –1– . Only tested for 3D.

findgridblock(batl, xyz_D)

Return processor local block index that contains a point. Input location should be given in Cartesian coordinates.

Find neighbors for any node in the tree. Only for Cartesian now.

findtreenode(batl, Coord_D)

Find the node that contains a point. The point coordinates should be given in generalized coordinates normalized by the domain size.

Find variable index in data.

Return sibling index (1-8) for the given block node matrix.

Read ascii format data.

Read binary format data.

Prepare 2D data arrays for passing to plotting functions.

getfilehead(fileID, type) -> NameTuple

Obtain the header information from BATSRUS output file of type linked to fileID.

Input arguments

• fileID::IOStream: file identifier.
• type::String: file type in ["ascii", "real4", "binary", "log"].

Return the size in bytes for one snapshot.

Obtain file type.

Logical shifts as the Fortran instrinsic function.

Generating consistent 2D arrays for passing to plotting functions.

Return global block index for the node.

order_children!(iNode)

Recursively apply Morton ordering for nodes below a root block. Store result into iNodeMortonI and iMortonNodeA using the iMorton index.

order_tree(batl)

Return maximum AMR level in the used block and the Morton curve order. Set iNodeMorton_I indirect index arrays according to

1. root node order
2. Morton ordering for each root node

Set colorbar norm and ticks.

setunits(filehead, type; distance=1.0, mp=1.0, me=1.0)

Set the units for the output files. If type is given as "SI", "CGS", "NORMALIZED", "PIC", "PLANETARY", "SOLAR", set typeunit = type, otherwise try to guess from the fileheader. Based on typeunit set units for distance [xSI], time [tSI], density [rhoSI], pressure [pSI], magnetic field [bSI] and current density [jSI] in SI units. Distance unit [rplanet | rstar], ion and electron mass in [amu] can be set with optional distance, mp and me.

Also calculate convenient constants ti0, cs0 ... for typical formulas. This function is currently not used anywhere!

subdata(data, xind, yind, sz)
subdata(data, xind, yind, zind, sz)

Return the sliced data based on indexes xind and yind of size sz.

Return matrix X with swapped rows i and j.