neso_fame.hypnotoad_interface.get_region_flux_surface_boundary_points(region: MeshRegion, system: CoordinateSystem = CoordinateSystem.CYLINDRICAL) → list[Iterator[SliceCoord]]

Get the (ordered) boundary points for flux surface boundaries of a region.

Parameters:
region: MeshRegion

The portion of the mesh for which to return boundaries.

system: CoordinateSystem = CoordinateSystem.CYLINDRICAL

The coordinate system to use. This normally should not be changed. However, if you want to export the poloidal cross-section of the mesh then it can be useful to set this to be Cartesian.

Returns:

  • A list of boundaries. Each boundary is represented by an iterator

  • of SliceCoord objects. If that boundary is not present on the

  • given region object, then the iterator will be empty. The order of

  • the boundaries in the list is

  • #. Centre of the core region

  • #. Inner edge of the plasma (or entire edge, for single-null)

  • #. Outer edge of the plasma

  • #. Internal edge of the upper private flux region

  • #. Internal edge of the lower private flux region

Last update: Nov 07, 2024