Source code for torx.measure.electric_field_m

"""Functions related to electric fields."""
import xarray as xr
from torx.grid import Grid2D
from torx.equilibrium.equilibrium_m import EquilibriumBaseClass
from torx.autodoc_decorators_m import autodoc_function



@autodoc_function
def electric_field(
    grid: Grid2D,
    es_pot: xr.DataArray
):
    """Return the electric field calculated from the scalar potential."""
    return -grid.perpendicular_gradient(es_pot)




def radial_electric_field(
    grid: Grid2D,
    equi: EquilibriumBaseClass,
    es_pot: xr.DataArray,
):
    """Return the radial electric field calculated from the scalar potential."""
    return -grid.radial_perpendicular_gradient(es_pot, equi)