load_pfc_mesh#

cherab.lhd.machine.load_pfc_mesh(world: World, custom_components: dict[str, tuple[str, Material, float | None]] | None = None, reflection: bool = True, quiet: bool = False, **kwargs) dict[str, list[Mesh]]Source#

Load plasma facing component meshes.

Each mesh allows the user to use an user-defined material which inherites Material.

Parameters:
worldWorld

The world scenegraph to which the meshes will be added.

custom_componentsdict[str, tuple[str, Material, float | None]], optional

Custom components to load, by default None. The structure of the dictionary is as follows: {"Component Name": ("path", Material class, roughness)}. If the custom component is given, it is merged with the default components.

reflectionbool, optional

Whether or not to consider reflection light, by default True. If False, all of meshes’ material are replaced to AbsorbingSurface.

quietbool, optional

If True, it suppresses the progress table, by default False.

**kwargs

Keyword arguments to pass to fetch_file.

Returns:
dict[str, list[Mesh]]

Containing mesh name and Mesh objects.

Examples

from raysect.optical import World

world = World()
meshes = load_pfc_mesh(world, reflection=True)