PyDPF-Post refactoring: plotting

[GuillemBarroso]

Discussion on plotting command.

Some thoughts about how the users will interact with the command plot(). Of course, everything here is to be discussed.

Static simulation

Plot with default values

# Plot with default values
simulation.displacement.plot()

3D plot of the requested field on the entire domain.

Plot points

# Plot only selecting certain points
simulation.displacement(select=my_points).plot()

plot colored spheres in the requested nodes with the mesh in the background. Interpolate values if they are not in the solution file.

Plot lines

simulation.displacement(select=my_lines).plot()

3D plot of the line (colored by field) and mesh in background.

If graph=True (default = False):

simulation.displacement(select=my_lines).plot(graph=True)

plot 2D plot with line length (x-axis) and field (y-axis). If several lines are requested, plot them on the same figure. Additional parameter individual_figures can be passed to plot them in separated figures.

Plot planes:

simulation.displacement(select=my_planes).plot()

2D plot of the requested plane. If several planes requested, plot them in separated figures.

If we want a 3D plot of the mesh cutted by the plane, do:

my_intersection = intersect(mesh, my_plane, "+")
simulation.displacement(select=my_intersection).plot()

where "+" or "-" denotes the side of the mesh taken. Should we add a keyword for this? side? volume_side? take_side?

Define interactions

How to define Intersections should go to a different discussion maybe... but I'd like to have something like:

my_line = intersection(plane1, plane2)
my_surface = union(plane1, "-", plane2, '+') # this object is going to be a Collection of geometries
simulation.displacement(select=my_line).plot() # since this is a line, follow plotting lines behavior
simulation.displacement(select=my_surface).plot() # this is a surface, not a plane. Hence, it cannot be plotted in 2D, just 3D

Transient simulation

By default, plot the last time step of the simulation.

Timesteps can be requested by ID o by time.

If a requested timestep is not found in the solution, the default behavior is to find the closest timestep to the requested one. Output an info messing exlaining that the plotted timestep is different than the one requested. If interpolate=True force interpolation of the requested timestep.

Plot points:

Only selecting some points

simulation.displacement(select=my_points).plot()

Same than for static simulation, but now plotting last timestep by default. Here graph=True can be passed to plot a 2D plot (graph plot) with time (x-axis) and field (y-axis). One curve per point if several points are requested.

Selecting points and time

points = Points([x1,y1,z1], [x2, y2, z2], ...)
my_selection = select(nodes = points, time=[-1]) # select defined points for the last timestep
simulation.displacement(select=my_selection).plot()

3D plot with the mesh on the background with colored spheres in the required nodes. Size of the sphere depending on the size of the elements.

Selecting points and named spaces or qualifiers

points = Points([x1,y1,z1], [x2, y2, z2], ...)
my_selection = select(nodes = points, time=[-1], named_spaces=["my_named_space"])
simulation.displacement(select=my_selection).plot()

Same as selecting points but excluding the ones outside of the selected named spaces or qualifiers.

Plot lines

Only selecting lines

simulation.displacement(select=my_lines).plot()

3D plots a line with the mesh in the background for the last time step. By default graph=False. If set to true:

simulation.displacement(select=my_lines).plot(graph=True)

plots a 2D graph: line length (x-axis) vs field (y-axis). If several lines are requested, plot them on the same figure. Additional parameter individual_figures can be passed to plot them in separated figures.

Selecting lines and time

Same than before but for the required time step. If more time-steps are inputed, plot several figures?
If graph=True and more than one time-step is requested, plot several curves in the same 2D figure.

Selecting lines and named spaces or qualifiers:

Same but only show the part of the lines that are inside the named spaces or qualifiers.

Plot planes:

Only selecting planes:

simulation.displacement(select=my_planes).plot()

2D contour plot of the field in that plane for the last timestep. One figure per plane requested.

To get a 3D plot with the mesh cutted by the plane:

my_intersection = intersect(mesh, my_plane, "+")
simulation.displacement(select=my_intersection).plot()

Selecting planes and timestep:

Same but for the requested timestep. If more than 1 timestep is requested, plot 1 figure per timestep.

Selecting planes and named spaces and/or qualifiers:

Same but only show the part of the plane inside the named space or qualifiers.

Harmonic problem

Same than transient but, by default, plot the first mode.