fenics_plotly package

Submodules

fenics_plotly.fenics_plotly module

class fenics_plotly.fenics_plotly.FEniCSPlotFig(fig)[source]

Bases: object

add_plot(fig)[source]
save(filename)[source]
show()[source]
fenics_plotly.fenics_plotly.plot(obj, colorscale='inferno', wireframe=True, scatter=False, size=10, norm=False, name='f', color='gray', opacity=1.0, show_grid=False, size_frame=None, background=(242, 242, 242), normalize=False, component=None, showscale=True, show=True, filename=None)[source]

Plot FEnICS object

Parameters

  • obj (Mesh, Function. FunctionoSpace, MeshFunction, DirichleyBC) – FEnicS object to be plotted

  • colorscale (str, optional) – The colorscale, by default “inferno”

  • wireframe (bool, optional) – Whether you want to show the mesh in wirteframe, by default True

  • scatter (bool, optional) – Plot function as scatter plot, by default False

  • size (int, optional) – Size of scatter points, by default 10

  • norm (bool, optional) – For vectors plot the norm as a surface, by default False

  • name (str, optional) – Name to show up in legend, by default “f”

  • color (str, optional) – Color to be plotted on the mesh, by default “gray”

  • opacity (float, optional) – opacity of surface, by default 1.0

  • show_grid (bool, optional) – Show x, y (and z) axis grid, by default False

  • size_frame ([type], optional) – Size of plot, by default None

  • background (tuple, optional) – Background of plot, by default (242, 242, 242)

  • normalize (bool, optional) – For vectors, normalize then to have unit length, by default False

  • component ([type], optional) – Plot a componenent ([“Magnitude”, “x”, “y”, “z”]) for vector, by default None

  • showscale (bool, optional) – Show colorbar, by default True

  • show (bool, optional) – Show figure, by default True

  • filename ([type], optional) – Path to file where you want to save the figure, by default None

Raises

TypeError – If object to be plotted is not recognized.

fenics_plotly.fenics_plotly.savefig(fig, filename, save_config=None)[source]

Save figure to file

Parameters

  • fig (plotly.graph_objects.Figure) – This figure that you want to save

  • filename (Path or str) – Path to the desitnation where you want to save the figure

  • save_config (dict, optional) – Additionsal cofigurations to be assed to plotly.offline.plot, by default None

fenics_plotly.fenics_plotly.set_renderer(renderer)[source]

Module contents

Top-level package for FEniCS-Plotly.

fenics_plotly.plot(obj, colorscale='inferno', wireframe=True, scatter=False, size=10, norm=False, name='f', color='gray', opacity=1.0, show_grid=False, size_frame=None, background=(242, 242, 242), normalize=False, component=None, showscale=True, show=True, filename=None)[source]

Plot FEnICS object

Parameters

  • obj (Mesh, Function. FunctionoSpace, MeshFunction, DirichleyBC) – FEnicS object to be plotted

  • colorscale (str, optional) – The colorscale, by default “inferno”

  • wireframe (bool, optional) – Whether you want to show the mesh in wirteframe, by default True

  • scatter (bool, optional) – Plot function as scatter plot, by default False

  • size (int, optional) – Size of scatter points, by default 10

  • norm (bool, optional) – For vectors plot the norm as a surface, by default False

  • name (str, optional) – Name to show up in legend, by default “f”

  • color (str, optional) – Color to be plotted on the mesh, by default “gray”

  • opacity (float, optional) – opacity of surface, by default 1.0

  • show_grid (bool, optional) – Show x, y (and z) axis grid, by default False

  • size_frame ([type], optional) – Size of plot, by default None

  • background (tuple, optional) – Background of plot, by default (242, 242, 242)

  • normalize (bool, optional) – For vectors, normalize then to have unit length, by default False

  • component ([type], optional) – Plot a componenent ([“Magnitude”, “x”, “y”, “z”]) for vector, by default None

  • showscale (bool, optional) – Show colorbar, by default True

  • show (bool, optional) – Show figure, by default True

  • filename ([type], optional) – Path to file where you want to save the figure, by default None

Raises

TypeError – If object to be plotted is not recognized.

fenics_plotly.set_renderer(renderer)[source]