imas_paraview.io.read_ps.PlasmaStateReader

class imas_paraview.io.read_ps.PlasmaStateReader(ids)

Bases: object

__init__(ids)

Initializes plasma state reader and retrieves all filled GGD scalar and vector arrays from the IDS.

Parameters:
ids

The IDS to load GGD arrays from

Methods

__init__(ids)

Initializes plasma state reader and retrieves all filled GGD scalar and vector arrays from the IDS.

load_arrays_from_path(ggd_idx, ...)

Retrieves scalar and vector arrays from the IDS based on the provided time index and array paths, and stores them in the respective lists.

load_paths_from_ids([ggd_idx, return_empty])

Retrieves scalar and vector array paths from the IDS metadata by performing a recursive search through GGD paths.

read_plasma_state(subset_idx, ugrid)

Reads plasma state data arrays from the ggd node in the IDS.

load_arrays_from_path(ggd_idx, scalar_array_paths, vector_array_paths)

Retrieves scalar and vector arrays from the IDS based on the provided time index and array paths, and stores them in the respective lists.

Parameters:
ggd_idx

The time index for which to load GGD arrays

scalar_array_paths

A list of paths of GGD scalar arrays in the IDS

vector_array_paths

A list of paths of GGD vector arrays in the IDS

load_paths_from_ids(ggd_idx=0, return_empty=False)

Retrieves scalar and vector array paths from the IDS metadata by performing a recursive search through GGD paths.

Parameters:
ggd_idx=0

Retrieve filled paths of a specific time step.

return_empty=False

Whether to return the paths of empty GGD arrays. Defaults to False.

Returns:

A list of paths of GGD scalar arrays in the IDS vector_array_paths: A list of paths of GGD vector arrays in the IDS

Return type:

scalar_array_paths

read_plasma_state(subset_idx: int, ugrid: vtkmodules.vtkCommonDataModel.vtkUnstructuredGrid) None

Reads plasma state data arrays from the ggd node in the IDS. These arrays are added as point data or cell data to the unstructured grid.

Parameters:
subset_idx: int

an index into grid_ggd/grid_subset AoS

ugrid: vtkmodules.vtkCommonDataModel.vtkUnstructuredGrid

the unstructured grid instance


Last update: 2026-03-11