cherab.imas.plasma.load_edge_plasma¶

cherab.imas.plasma.load_edge_plasma(*args, time: float = 0, occurrence: int = 0, grid_ggd: IDSStructure | None = None, grid_subset_id: int | str = 5, b_field: Function2D | None = None, time_threshold: float = inf, split_ion_bundles: bool = True, atomic_data: AtomicData | None = None, parent: _NodeBase | None = None, **kwargs) → PlasmaSource¶

Load edge profiles and create a Plasma object.

Prefer density_thermal over density profile.

The distribution of each species is defined with Maxwellian using its density, temperature, and bulk velocity profiles, which are mapped to GGD grid coordinates.

The plasma geometry is defined as a cylindrical annulus between the inner and outer limits of the grid, and its height is defined as the difference between the maximum and minimum z-coordinates of the grid.

The ion bundle species are split into their constituent charge states using solve_coronal_equilibrium when split_ion_bundles is True and the necessary atomic data is available. Otherwise, ion bundles are ignored with a warning.

Parameters:

*args¶

Arguments passed to the DBEntry constructor.

time: float = 0¶

Time for the edge plasma, by default 0.

occurrence: int = 0¶

Occurrence index of the edge_profiles IDS, by default 0.

grid_ggd: IDSStructure | None = None¶

Alternative grid_ggd structure with the grid description, by default None.

grid_subset_id: int | str = 5¶

Identifier of the grid subset. Either index or name, by default 5 ("Cells").

b_field: Function2D | None = None¶

Alternative 2D interpolator of the magnetic field vector (Br, Bphi, Bz). Default is None. The magnetic field will be loaded from the equilibrium IDS.

time_threshold: float = inf¶

Maximum allowed difference between the requested time and the nearest available time, by default numpy.inf.

split_ion_bundles: bool = True¶

Whether to split ion bundles into their constituent charge states using solve_coronal_equilibrium, by default True.

atomic_data: AtomicData | None = None¶

Atomic data provider class for this plasma, by default None. If None, some species (e.g. ion_bundle) may not be properly loaded.

parent: _NodeBase | None = None¶

Parent node in the Raysect scene graph, by default None. Typically a World instance.

**kwargs¶

Keyword arguments passed to the DBEntry constructor.

Returns:

Plasma – Plasma object with edge profiles.

Raises:

RuntimeError – If the grid_ggd or ggd AOS of the edge_profiles IDS is empty.