emout.core.relocation package¶

Submodules¶

Relocate EMSES electric-field components to cell centres.

emout.core.relocation.electric.relocated_electric_field(ef, axis, btype)[source]¶

Relocate the electric field to cell-centre positions.

Parameters:

ef (np.ndarray) – Electric field array.
axis (int) – Target axis.
btype (Literal["periodic", "dirichlet", "neumann"]) – Boundary condition type.

Returns:

Relocated electric field array.

Return type:

np.ndarray

Relocate EMSES magnetic-field components to cell centres.

emout.core.relocation.magnetic.relocated_magnetic_field(bf, axis, btypes)[source]¶

Relocate the magnetic field to cell-centre positions.

Parameters:

bf (np.array) – Magnetic field array.
axis (int) – Target axis.
btypes (Tuple[Btype, Btype]) – Boundary conditions for the two directions orthogonal to axis ("periodic" / "dirichlet" / "neumann").

Returns:

Relocated magnetic field array.

Return type:

np.ndarray

Field relocation (staggered-grid interpolation) for EMSES output.

Provides relocated_electric_field() and relocated_magnetic_field() to interpolate E and B fields from their native staggered positions to cell centres.