foam_graph.visualization package

Submodules

foam_graph.visualization.graph_3d_plotting module

foam_graph.visualization.graph_3d_plotting.plot_3d_graph(graph: torch_geometric.data.data.Data, field_name: Optional[str] = None, field_component: int = 0)

Plots a 3D graph.

Parameters

• graph (Data) – Graph to be plotted.

• field_name (Optional[str], optional) – Graph attribute used for coloring. Defaults to None.

• field_component (int, optional) – Component of graph attribute used for coloring. Defaults to 0.

foam_graph.visualization.graph_plotting module

foam_graph.visualization.graph_plotting.plot_graph(graph: torch_geometric.data.data.Data, field_name: Optional[str] = None, field_component: int = 0, ax: Optional[matplotlib.axes._axes.Axes] = None, plot_colorbar: bool = False)

Plots a 2D graph.

Parameters

• graph (Data) – Graph to be plotted.

• field_name (Optional[str], optional) – Graph attribute used for coloring. Defaults to None.

• field_component (int, optional) – Component of graph attribute used for coloring. Defaults to 0.

• ax (Optional[plt.Axes], optional) – Axis to plot. Defaults to None.

• plot_colorbar (bool, optional) – Flag for including a colorbar. Defaults to False.

foam_graph.visualization.graph_plotting.plot_graph_contour(graph: torch_geometric.data.data.Data, field_name: Optional[str] = None, field_component: int = 0, ax: Optional[matplotlib.axes._axes.Axes] = None, plot_colorbar: bool = False, internal_nodes_mask: Optional[Union[torch.Tensor, numpy.ndarray]] = None)

Plots a 2D graph with a triangulated filled countour.

Parameters

• graph (Data) – Graph to be plotted.

• field_name (Optional[str], optional) – Graph attribute used for coloring. Defaults to None.

• field_component (int, optional) – Component of graph attribute used for coloring. Defaults to 0.

• ax (Optional[plt.Axes], optional) – Axis to plot. Defaults to None.

• internal_nodes_mask (Optional[torch.Tensor], optional) – Tensor of zeros and ones, where ones indicate nodes inside the domain. Defaults to None.

Module contents

foam_graph.visualization.plot_3d_graph(graph: torch_geometric.data.data.Data, field_name: Optional[str] = None, field_component: int = 0)

Plots a 3D graph.

Parameters

• graph (Data) – Graph to be plotted.

• field_name (Optional[str], optional) – Graph attribute used for coloring. Defaults to None.

• field_component (int, optional) – Component of graph attribute used for coloring. Defaults to 0.

foam_graph.visualization.plot_graph(graph: torch_geometric.data.data.Data, field_name: Optional[str] = None, field_component: int = 0, ax: Optional[matplotlib.axes._axes.Axes] = None, plot_colorbar: bool = False)

Plots a 2D graph.

Parameters

• graph (Data) – Graph to be plotted.

• field_name (Optional[str], optional) – Graph attribute used for coloring. Defaults to None.

• field_component (int, optional) – Component of graph attribute used for coloring. Defaults to 0.

• ax (Optional[plt.Axes], optional) – Axis to plot. Defaults to None.

• plot_colorbar (bool, optional) – Flag for including a colorbar. Defaults to False.

foam_graph.visualization.plot_graph_contour(graph: torch_geometric.data.data.Data, field_name: Optional[str] = None, field_component: int = 0, ax: Optional[matplotlib.axes._axes.Axes] = None, plot_colorbar: bool = False, internal_nodes_mask: Optional[Union[torch.Tensor, numpy.ndarray]] = None)

Plots a 2D graph with a triangulated filled countour.

Parameters

• graph (Data) – Graph to be plotted.

• field_name (Optional[str], optional) – Graph attribute used for coloring. Defaults to None.

• field_component (int, optional) – Component of graph attribute used for coloring. Defaults to 0.

• ax (Optional[plt.Axes], optional) – Axis to plot. Defaults to None.

• internal_nodes_mask (Optional[torch.Tensor], optional) – Tensor of zeros and ones, where ones indicate nodes inside the domain. Defaults to None.