cherab.imas.ids.common.ggd.load_unstruct_grid_2d_extendedΒΆ

cherab.imas.ids.common.ggd.load_unstruct_grid_2d_extended(grid_ggd: IDSStructure, with_subsets: bool = False, num_toroidal: int = 64) UnstructGrid2DExtendedSourceΒΆ

Load unstructured 2D grid extended in 3D from the grid_ggd structure.

Parameters:
grid_ggd: IDSStructureΒΆ

The grid_ggd structure.

with_subsets: bool = FalseΒΆ

Read grid subset data if True.

num_toroidal: int = 64ΒΆ

Number of toroidal points. If specifying more than 1, the grid will be extended in 3D by repeating the 2D cross-section around the torus with evenly spaced toroidal angles.

Returns:

The unstructured 2D grid extended in 3D.

Return type:

UnstructGrid2DExtended

Raises:

ValueError – If the number of toroidal points is less than 1. If the grid is not an unstructured extended 2D grid.