def plot_contour(
self,
label=None,
index=None,
indices=None,
is_surf=False,
is_radial=False,
is_center=False,
clim=None,
field_name=None,
group_names=None,
save_path=None,
itimefreq=0,
is_show_fig=True,
):
"""Plot the contour of a field on a mesh using pyvista plotter.
Parameters
----------
self : MeshSolution
a MeshSolution object
label : str
a label
index : int
an index
indices : list
list of the points to extract (optional)
is_surf : bool
field over outer surface
is_radial : bool
radial component only
is_center : bool
field at cell-centers
clim : list
a list of 2 elements for the limits of the colorbar
field_name : str
title of the field to display on plot
group_names : list
a list of str corresponding to group name(s)
save_path : str
path to save the figure
itimefreq : int
index of the time step (or frequency) to be plotted
is_show_fig : bool
To call show at the end of the method
Returns
-------
"""
if group_names is not None:
meshsol_grp = self.get_group(group_names)
meshsol_grp.plot_contour(
label=label,
index=index,
indices=indices,
is_surf=is_surf,
is_radial=is_radial,
is_center=is_center,
clim=clim,
field_name=field_name,
group_names=None,
save_path=save_path,
itimefreq=itimefreq,
)
else:
if save_path is None:
try:
import pyvistaqt as pv
is_pyvistaqt = True
except:
import pyvista as pv
is_pyvistaqt = False
else:
import pyvista as pv
is_pyvistaqt = False
# Get the mesh_pv and field
mesh_pv, field, field_name = self.get_mesh_field_pv(
label=label,
index=index,
indices=indices,
is_surf=is_surf,
is_radial=is_radial,
is_center=is_center,
field_name=field_name,
)
# Add field to mesh
if is_surf:
surf = mesh_pv.get_surf(indices=indices)
surf[field_name] = real(field)
mesh_field = surf
else:
mesh_pv[field_name] = real(field)
mesh_field = mesh_pv
# Configure plot
if is_pyvistaqt:
p = pv.BackgroundPlotter()
p.set_background("white")
else:
pv.set_plot_theme("document")
p = pv.Plotter(notebook=False)
sargs = dict(
interactive=True,
title_font_size=20,
label_font_size=16,
font_family="arial",
color="black",
)
p.add_mesh(
mesh_field,
scalars=field_name,
show_edges=False,
cmap=COLOR_MAP,
clim=clim,
scalar_bar_args=sargs,
)
if self.dimension == 2:
p.view_xy()
if save_path is None and is_show_fig:
p.show()
elif save_path is not None:
p.show(interactive=False, screenshot=save_path)
def plot_deflection(
self,
label=None,
index=None,
indices=None,
clim=None,
factor=None,
field_name=None,
ifreq=0,
save_path=None,
title="",
win_title=None,
is_surf=True,
):
"""Plot the operational deflection shape using pyvista plotter.
Parameters
----------
self : MeshSolution
a MeshSolution object
label : str
a label
index : int
an index
indices : list
list of the points to extract (optional)
clim : list
a list of 2 elements for the limits of the colorbar
factor : float
factor to multiply vector field
field_name : str
title of the field to display on plot
ifreq : int
index of the frequency to use for plot (if exists)
Returns
-------
"""
if save_path is None:
try:
import pyvistaqt as pv
is_pyvistaqt = True
except:
import pyvista as pv
is_pyvistaqt = False
else:
import pyvista as pv
is_pyvistaqt = False
if save_path is None:
try:
import pyvistaqt as pv
is_pyvistaqt = True
except:
import pyvista as pv
is_pyvistaqt = False
else:
import pyvista as pv
is_pyvistaqt = False
if title != "" and win_title == "":
win_title = title
elif win_title != "" and title == "":
title = win_title
# Get the mesh
mesh = self.get_mesh(label=label, index=index)
if isinstance(mesh, MeshMat):
mesh_pv = mesh.get_mesh_pv(indices=indices)
mesh = MeshVTK(mesh=mesh_pv, is_pyvista_mesh=True)
# Get the field
field = real(
self.get_field(label=label,
index=index,
indices=indices,
is_surf=is_surf,
is_radial=True))
vect_field = real(self.get_field(label=label, index=index,
indices=indices))
if len(field.shape) == 2:
# Third dimension is frequencies
field = field[:, ifreq]
vect_field = vect_field[:, :, ifreq]
if field_name is None:
if label is not None:
field_name = label
elif self.get_solution(index=index).label is not None:
field_name = self.get_solution(index=index).label
else:
field_name = "Field"
# Compute colorbar boundaries
if clim is None:
clim = [np_min(real(field)), np_max(real(field))]
if (clim[1] - clim[0]) / clim[1] < 0.01:
clim[0] = -clim[1]
# Compute deformation factor
if factor is None:
factor = 1 / (100 * clim[1])
# Extract surface
if is_surf:
surf = mesh.get_surf(indices=indices)
else:
surf = mesh.get_mesh_pv(indices=indices)
# Add field to surf
surf.vectors = real(vect_field) * factor
# Warp by vectors
surf_warp = surf.warp_by_vector()
# Add radial field
surf_warp[field_name] = real(field)
# Configure plot
if is_pyvistaqt:
p = pv.BackgroundPlotter()
p.set_background("white")
else:
pv.set_plot_theme("document")
p = pv.Plotter(notebook=False, title=win_title)
sargs = dict(
interactive=True,
title_font_size=20,
label_font_size=16,
font_family="arial",
color="black",
)
p.add_mesh(
surf_warp,
scalars=field_name,
opacity=1,
show_edges=False,
cmap=COLOR_MAP,
clim=clim,
scalar_bar_args=sargs,
)
p.add_text(title, position="upper_edge")
if self.dimension == 2:
p.view_xy()
if save_path is None:
p.show()
else:
p.show(interactive=False, screenshot=save_path)
def plot_glyph(
self,
label=None,
index=None,
indices=None,
clim=None,
factor=None,
field_name=None,
ifreq=0,
save_path=None,
is_point_arrow=False,
group_names=None,
):
"""Plot the vector field as a glyph (or quiver) over the mesh.
Parameters
----------
self : MeshSolution
a MeshSolution object
label : str
a label
index : int
an index
indices : list
list of the points to extract (optional)
clim : list
a list of 2 elements for the limits of the colorbar
factor : float
factor to multiply vector field
field_name : str
title of the field to display on plot
ifreq : int
index of the frequency to use for plot (if exists)
save_path : str
path to save the plot into an image
is_point_arrow : bool
to plot a nodal field (point-wise solution required)
group_names : [str]
plot is restricted to the group(s) corresponding to this list of group names.
Returns
-------
"""
if group_names is not None:
meshsol_grp = self.get_group(group_names)
meshsol_grp.plot_glyph(
label,
index,
indices,
clim,
factor,
field_name,
ifreq,
save_path,
is_point_arrow,
None,
)
else:
if save_path is None:
try:
import pyvistaqt as pv
is_pyvistaqt = True
except:
import pyvista as pv
is_pyvistaqt = False
else:
import pyvista as pv
is_pyvistaqt = False
# Get the mesh
mesh = self.get_mesh(label=label, index=index)
mesh_pv = mesh.get_mesh_pv(indices=indices)
# Get the vector field
args = dict()
args["freq"] = [0]
args["time"] = [0]
vect_field = real(
self.get_field(label=label,
index=index,
indices=indices,
args=args))
# if len(vect_field.shape) == 3:
# # Third dimension is frequencies
# vect_field = vect_field[:, :, ifreq]
# Compute factor
if factor is None:
factor = 1 / (100 * np_max(vect_field))
if self.dimension == 2:
vect_field = np.hstack(
(vect_field, np.zeros((vect_field.shape[0], 1))))
# Add field to mesh
if is_point_arrow:
mesh_pv.vectors = vect_field * factor
arrows_plt = mesh_pv.arrows
else:
mesh_pv["field"] = vect_field
mesh_cell = mesh_pv.point_data_to_cell_data()
surf = mesh_cell.extract_geometry()
centers2 = surf.cell_centers()
centers2.vectors = surf["field"] * factor
arrows_plt = centers2.arrows
# Configure plot
if is_pyvistaqt:
p = pv.BackgroundPlotter()
p.set_background("white")
else:
pv.set_plot_theme("document")
p = pv.Plotter(notebook=False)
p.add_mesh(mesh_pv,
color="grey",
opacity=0.7,
show_edges=True,
edge_color="white")
p.add_mesh(arrows_plt, color="red")
if self.dimension:
p.view_xy()
if save_path is None:
p.show()
else:
p.show(interactive=False, screenshot=save_path)
def plot_deflection(
self,
*args,
label=None,
index=None,
indices=None,
clim=None,
factor=None,
field_name=None,
group_names=None,
save_path=None,
title="",
win_title=None,
is_surf=True,
is_show_fig=True,
):
"""Plot the operational deflection shape using pyvista plotter.
Parameters
----------
self : MeshSolution
a MeshSolution object
label : str
a label
index : int
an index
indices : list
list of the points to extract (optional)
clim : list
a list of 2 elements for the limits of the colorbar
factor : float
factor to multiply vector field
field_name : str
title of the field to display on plot
is_show_fig : bool
To call show at the end of the method
Returns
-------
"""
if group_names is not None:
meshsol_grp = self.get_group(group_names)
meshsol_grp.plot_deflection(
*args,
label=label,
index=index,
indices=indices,
clim=clim,
factor=factor,
field_name=field_name,
save_path=save_path,
title=title,
win_title=win_title,
is_surf=is_surf,
is_show_fig=is_show_fig,
group_names=None,
)
else:
if save_path is None:
try:
import pyvistaqt as pv
is_pyvistaqt = True
except:
import pyvista as pv
is_pyvistaqt = False
else:
import pyvista as pv
is_pyvistaqt = False
if save_path is None:
try:
import pyvistaqt as pv
is_pyvistaqt = True
except:
import pyvista as pv
is_pyvistaqt = False
else:
import pyvista as pv
is_pyvistaqt = False
if title != "" and win_title == "":
win_title = title
elif win_title != "" and title == "":
title = win_title
# Get mesh and field
mesh_pv, field, field_name = self.get_mesh_field_pv(
*args,
label=label,
index=index,
indices=indices,
field_name=field_name,
is_radial=True,
)
mesh = MeshVTK(mesh=mesh_pv, is_pyvista_mesh=True)
_, vect_field, _ = self.get_mesh_field_pv(
*args,
label=label,
index=index,
indices=indices,
field_name=field_name,
is_radial=False,
)
if field_name is None:
if label is not None:
field_name = label
elif self.get_solution(index=index).label is not None:
field_name = self.get_solution(index=index).label
else:
field_name = "Field"
# Compute colorbar boundaries
if clim is None:
clim = [np_min(real(field)), np_max(real(field))]
if (clim[1] - clim[0]) / clim[1] < 0.01:
clim[0] = -abs(clim[1])
clim[1] = abs(clim[1])
# Compute deformation factor
if factor is None:
# factor = 1 / (100 * clim[1])
factor = 1 / clim[1] * 10
# Add third dimension if needed
solution = self.get_solution(
label=label,
index=index,
)
if solution.dimension == 2:
vect_field = hstack((vect_field, zeros((vect_field.shape[0], 1))))
# Extract surface
if is_surf:
surf = mesh.get_surf(indices=indices)
else:
surf = mesh.get_mesh_pv(indices=indices)
# Add field to surf
surf.vectors = real(vect_field) * factor
# Warp by vectors
surf_warp = surf.warp_by_vector()
# Add radial field
surf_warp[field_name] = real(field)
# Configure plot
if is_pyvistaqt:
p = pv.BackgroundPlotter()
p.set_background("white")
else:
pv.set_plot_theme("document")
p = pv.Plotter(notebook=False, title=win_title)
sargs = dict(
interactive=True,
title_font_size=20,
label_font_size=16,
font_family="arial",
color="black",
)
p.add_mesh(mesh_pv,
color="grey",
opacity=1,
show_edges=True,
edge_color="white")
p.set_position((0.2, 0.2, 0.5))
p.reset_camera()
p.clear()
p.add_mesh(
surf_warp,
scalars=field_name,
opacity=1,
show_edges=False,
cmap=COLOR_MAP,
clim=clim,
scalar_bar_args=sargs,
)
p.add_text(title, position="upper_edge")
p.add_axes()
if self.dimension == 2:
p.view_xy()
if save_path is None and is_show_fig:
p.show()
elif save_path is not None:
p.show(interactive=False, screenshot=save_path)
def plot_mesh(
self,
label=None,
index=None,
indices=None,
save_path=None,
group_names=None,
):
"""Plot the mesh using pyvista plotter.
Parameters
----------
self : MeshSolution
a MeshSolution object
label : str
a label
index : int
an index
indices : list
list of the points to extract (optional)
Returns
-------
"""
if group_names is not None:
meshsol_grp = self.get_group(group_names)
meshsol_grp.plot_mesh(
label,
index,
indices,
save_path,
None,
)
else:
if save_path is None:
try:
import pyvistaqt as pv
is_pyvistaqt = True
except:
import pyvista as pv
is_pyvistaqt = False
else:
import pyvista as pv
is_pyvistaqt = False
print(save_path)
# Get the mesh
mesh_obj = self.get_mesh(label=label, index=index)
if isinstance(mesh_obj, MeshMat):
mesh = mesh_obj.get_mesh_pv(indices=indices)
else:
mesh = mesh_obj.get_mesh(indices=indices)
# Configure plot
if is_pyvistaqt:
p = pv.BackgroundPlotter()
p.set_background("white")
else:
pv.set_plot_theme("document")
p = pv.Plotter(notebook=False)
p.add_mesh(
mesh,
color="grey",
opacity=1,
show_edges=True,
edge_color="white",
line_width=1,
)
if self.dimension == 2:
p.view_xy()
if save_path is None:
p.show()
else:
p.show(interactive=False, screenshot=save_path)
def configure_plot(p, win_title, save_path):
"""Configure a pyvista plot. If the plotter doesn't exist, create one depending on avaialble package.
Parameters
----------
p : pyvista plotter
a pyvista plotter
win_title : str
title of the window
save_path : str
path where to save the plot
"""
if p is None:
# Configure plot
if save_path is None:
try:
import pyvistaqt as pv
is_pyvistaqt = True
except:
import pyvista as pv
is_pyvistaqt = False
else:
import pyvista as pv
is_pyvistaqt = False
if is_pyvistaqt:
p = pv.BackgroundPlotter(title=win_title)
p.set_background("white")
else:
pv.set_plot_theme("document")
p = pv.Plotter(notebook=False, title=win_title)
# isometric view with z towards left
p.view_isometric()
# p.camera_position = [
# p.camera_position[0],
# (
# p.camera_position[1][0],
# p.camera_position[1][2],
# p.camera_position[1][0],
# ),
# (
# p.camera_position[2][1],
# p.camera_position[2][2],
# p.camera_position[2][0],
# ),
# ]
p.add_axes(color="k",
x_color="#da3061",
y_color="#0069a1",
z_color="#bbcf1c")
sargs = dict(
interactive=True,
title_font_size=12,
label_font_size=10,
font_family=FONT_FAMILY_PYVISTA,
color="black",
)
return p, sargs
def plot_glyph(
self,
*args,
label=None,
index=None,
indices=None,
clim=None,
factor=None,
field_name=None,
save_path=None,
is_point_arrow=False,
group_names=None,
is_show_fig=True,
):
"""Plot the vector field as a glyph (or quiver) over the mesh.
Parameters
----------
self : MeshSolution
a MeshSolution object
*args: list of strings
List of axes requested by the user, their units and values (optional)
label : str
a label
index : int
an index
indices : list
list of the points to extract (optional)
clim : list
a list of 2 elements for the limits of the colorbar
factor : float
factor to multiply vector field
field_name : str
title of the field to display on plot
save_path : str
path to save the plot into an image
is_point_arrow : bool
to plot a nodal field (point-wise solution required)
group_names : [str]
plot is restricted to the group(s) corresponding to this list of group names.
Returns
-------
"""
if group_names is not None:
meshsol_grp = self.get_group(group_names)
meshsol_grp.plot_glyph(
*args,
label=label,
index=index,
indices=indices,
clim=clim,
factor=factor,
field_name=field_name,
save_path=save_path,
is_point_arrow=is_point_arrow,
group_names=None,
)
else:
if save_path is None:
try:
import pyvistaqt as pv
is_pyvistaqt = True
except:
import pyvista as pv
is_pyvistaqt = False
else:
import pyvista as pv
is_pyvistaqt = False
# Get the mesh
mesh_pv, field, field_name = self.get_mesh_field_pv(
*args,
label=label,
index=index,
indices=indices,
field_name=field_name,
)
vect_field = real(field)
# Compute factor
if factor is None:
# factor = 1 / (100 * np_max(vect_field))
factor = 1 / np_max(vect_field) * 10
# Add third dimension if needed
solution = self.get_solution(
label=label,
index=index,
)
if solution.dimension == 2:
vect_field = np.hstack(
(vect_field, np.zeros((vect_field.shape[0], 1))))
# Add field to mesh
if is_point_arrow:
mesh_pv.vectors = vect_field * factor
arrows_plt = mesh_pv.arrows
else:
mesh_pv["field"] = vect_field
mesh_cell = mesh_pv.point_data_to_cell_data()
surf = mesh_cell.extract_geometry()
centers2 = surf.cell_centers()
centers2.vectors = surf["field"] * factor
arrows_plt = centers2.arrows
# Configure plot
if is_pyvistaqt:
p = pv.BackgroundPlotter()
p.set_background("white")
else:
pv.set_plot_theme("document")
p = pv.Plotter(notebook=False)
p.add_mesh(mesh_pv,
color="grey",
opacity=0.7,
show_edges=True,
edge_color="white")
p.set_position((0.2, 0.2, 0.5))
p.reset_camera()
p.add_mesh(arrows_plt, color="red")
p.add_axes()
# if self.dimension:
# p.view_xy()
if save_path is None and is_show_fig:
p.show()
else:
p.show(interactive=False, screenshot=save_path)
def plot_mesh(
self,
p=None,
label=None,
index=None,
indices=None,
save_path=None,
group_names=None,
node_label=None,
is_show_axes=False,
is_show_fig=True,
is_show_grid=False,
win_title=None,
):
"""Plot the mesh using pyvista plotter.
Parameters
----------
self : MeshSolution
a MeshSolution object
p : a pyvista(qt) object, optional
a pyvista object which will be used for the plot
label : str
a label
index : int
an index
indices : list
list of the points to extract (optional)
is_show_axes : bool
True to show axes
is_show_fig : bool
To call show at the end of the method
is_show_grid : bool
True to show grid
Returns
-------
"""
if group_names is not None:
meshsol_grp = self.get_group(group_names)
meshsol_grp.plot_mesh(
label=label,
index=index,
indices=indices,
save_path=save_path,
group_names=None,
)
else:
if p is None:
if save_path is None:
try:
import pyvistaqt as pv
is_pyvistaqt = True
except:
import pyvista as pv
is_pyvistaqt = False
else:
import pyvista as pv
is_pyvistaqt = False
print(save_path)
# Configure plot
if is_pyvistaqt:
p = pv.BackgroundPlotter(title=win_title)
p.set_background("white")
else:
pv.set_plot_theme("document")
p = pv.Plotter(notebook=False, title=win_title)
else:
is_show_fig = False
# Get the mesh
mesh_obj = self.get_mesh(label=label, index=index)
if isinstance(mesh_obj, MeshMat):
new_mesh = mesh_obj.copy()
new_mesh.renum()
mesh = new_mesh.get_mesh_pv(indices=indices)
else:
mesh = mesh_obj.get_mesh_pv(indices=indices)
p.add_mesh(
mesh,
color="grey",
opacity=1,
show_edges=True,
edge_color="white",
line_width=1,
)
if is_show_axes:
p.add_axes(color="k",
x_color="#da3061",
y_color="#0069a1",
z_color="#bbcf1c")
if is_show_grid:
p.show_grid()
if self.dimension == 2:
# 2D view
p.view_xy()
else:
# isometric view with z towards left
p.view_isometric()
p.camera_position = [
p.camera_position[0],
(
p.camera_position[1][0],
p.camera_position[1][2],
p.camera_position[1][0],
),
(
p.camera_position[2][1],
p.camera_position[2][2],
p.camera_position[2][0],
),
]
if save_path is None and is_show_fig:
p.show()
elif save_path is not None: # and is_show_fig:
p.show(interactive=False, screenshot=save_path)
return p
