Source code for torx.measure.experimental_quantities_m

"""Common experimental measurements."""
import xarray as xr
from torx import make_xarray
from torx.normalization.normalization_m import Normalization
from torx.autodoc_decorators_m import autodoc_function



@autodoc_function
def ion_saturation_current(
    density: xr.DataArray, sound_speed: xr.DataArray, norm: Normalization
):
    """
    Return the ion saturation current for a Langmuir probe.

    Usually referred to as 'Jsat' or 'Isat'.
    """
    return make_xarray(
        density * sound_speed,
        norm=(norm.c_s0 * norm.elementary_charge * norm.n0).to("kiloampere*meter**-2"),
        name="Ion saturation current",
    )




@autodoc_function
def floating_potential(
    potential: xr.DataArray,
    electron_temp: xr.DataArray,
    norm: Normalization,
    sheath_potential: float = 2.69,
):
    """
    Return the floating potential.

    The potential at which no current will flow into a probe.
    """
    return make_xarray(
        potential - electron_temp * sheath_potential,
        norm=potential.norm,
        name="Sheath potential",
    )