treble_tsdk.core.mesh_obj¶

Classes

`MeshObject`
`MeshStatisticsParameter`	An enumeration.
`SimulationMeshInfoCollection`

class treble_tsdk.core.mesh_obj.MeshObject¶

__init__(mesh_info: MeshInfoDto, simulation: Simulation = None)¶

as_tree()¶

download_mesh_file(destination_file: str | Path)¶

get_model_layer_names() → list[str]¶

is_meshing_completed() → bool¶: Returns True if meshing process is finished, regardless of success or failure. See was_meshing_successful().

plot(layer_names: list[str] | None = None, smallest_element_length_threshold: float | None = None, n_small_elements: int = 100)¶

Use the plot module to plot the simulation mesh, plotting the surface mesh of the model.

Parameters:

layer_names – Optional parameter to plot only the surface mesh of selected layers.
smallest_element_length_threshold – Optional parameter to plot volume elements smaller than the given characteristic length (see ).
n_small_elements – Optional parameter for limiting the number of small elements plotted.

was_meshing_successful() → bool | None¶: Returns True if meshing process was successful, False if it failed, and None if it is still in progress.

class treble_tsdk.core.mesh_obj.MeshStatisticsParameter¶

An enumeration.

char_length = 'charlength'¶

edge_length = 'edgelength'¶

class treble_tsdk.core.mesh_obj.SimulationMeshInfoCollection¶

__init__(simulationMeshInfos: SimulationMeshInfoDto, simulation: Simulation = None)¶

as_live_mesher_progress()¶

as_table()¶

download_mesh_files(destination_folder: str | Path)¶

get_all_mesh_efficiency_percentages() → list[float]¶

Returns a list of all mesh efficiency percentages in the collection.

Returns list[float]:: A list of mesh efficiency percentages for all meshes in the collection. Only includes meshes that have completed meshing successfully and have a valid efficiency percentage.

get_lowest_mesh_efficiency_percentage() → float | None¶

Returns the lowest mesh efficiency percentage of all the meshes in the collection.

Returns float | None:: The lowest mesh efficiency percentage, or None if no valid percentages are available.

is_meshing_completed() → bool | None¶

plot(source: SourceDto | None = None, layer_names: list[str] | None = None, smallest_element_length_threshold: float | None = None, n_small_elements: int = 100)¶

Plots the surface mesh of the tetrahedral computational mesh

Parameters:

mesh_label (str) – label of, defaults to None
layer_names – Optional parameter to plot only the surface mesh of selected layers.
smallest_element_length_threshold – Optional parameter to plot volume elements smaller than the given characteristic length (see ).
n_small_elements – Optional parameter for limiting the number of small elements plotted.