pencil.visu.box3d

Contains the classes and methods to read the slice files, generate box plot and an animation with the simulation box.

Classes

Box plotting class in 3d.

Functions

box3d([slices])

Plot the given slices as a 3d box.

Module Contents

pencil.visu.box3d.box3d(slices=None)

Plot the given slices as a 3d box.

call signature:

box3d()

Keyword arguments:

slices:: A list of 3 or 4 slices, i.e. 2d arrays of shape [m, n]. The first slices is the top, then left, right and bottom.

class pencil.visu.box3d.Box3d

Bases: object

Box plotting class in 3d.

Fill members with default values.

slices = None

axes = True

font_size = 24

font_family = 'arial'

title = ''

colorbar = True

colormap = 'binary'

colorbar_label = 'u_x'

xlabel = '$x$'

ylabel = '$y$'

zlabel = '$z$'

vmin = None

vmax = None

plot(): Plot the 3d box.