cherab.nagdis.machine.load_pfc_mesh¶

cherab.nagdis.machine.load_pfc_mesh(world: World, custom_components: dict[str, tuple[str, type[Material], float | None]] | None = None, reflection: bool = True, is_fine_mesh: 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:

world: World¶

The world scenegraph to which the meshes will be added.

custom_components: dict[str, tuple[str, type[Material], float | None]] | None = None¶

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

reflection: bool = True¶

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

is_fine_mesh: bool = True¶

Whether or not to use fine mesh for the vacuum vessel, by default True.

quiet: bool = False¶

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
from cherab.nagdis.machine import load_pfc_mesh

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