ptfkit.pidgeon1972

def calc_ptf_pidgeon1972_awc(
    *,
    clay: float | ArrayLike,
    organic_matter: float | ArrayLike,
    out: NDArray[floating] | None = None,
) -> floating | NDArray[floating]:
    r"""Estimate available water capacity from clay and organic matter.

    Arguments:
        clay: Clay measured by particle-size method 1. (%)
        organic_matter: Organic matter content. (%)
        out: Optional output arrays for in-place calculation.

    Returns:
        available_water_capacity: Available water capacity. (mm/m)

    Models:
        $h(\theta)$: Available-water estimate

    Notes:
        Prediction target: Available water capacity

    """
    return _call(
        _calc_ptf_pidgeon1972_awc,
        clay,
        organic_matter,
        out=out,
    )

def calc_ptf_pidgeon1972_awc_coarse_sand(
    *,
    coarse_sand: float | ArrayLike,
    out: NDArray[floating] | None = None,
) -> floating | NDArray[floating]:
    r"""Estimate available water capacity from coarse sand.

    Arguments:
        coarse_sand: Coarse sand measured by particle-size method 1. (%)
        out: Optional output arrays for in-place calculation.

    Returns:
        available_water_capacity: Available water capacity. (mm/m)

    Models:
        $h(\theta)$: Available-water estimate

    Notes:
        Prediction target: Available water capacity

    """
    return _call(
        _calc_ptf_pidgeon1972_awc_coarse_sand,
        coarse_sand,
        out=out,
    )

def calc_ptf_pidgeon1972_awc_fine_sand(
    *,
    fine_sand: float | ArrayLike,
    out: NDArray[floating] | None = None,
) -> floating | NDArray[floating]:
    r"""Estimate available water capacity from fine sand.

    Arguments:
        fine_sand: Fine sand measured by particle-size method 1. (%)
        out: Optional output arrays for in-place calculation.

    Returns:
        available_water_capacity: Available water capacity. (mm/m)

    Models:
        $h(\theta)$: Available-water estimate

    Notes:
        Prediction target: Available water capacity

    """
    return _call(
        _calc_ptf_pidgeon1972_awc_fine_sand,
        fine_sand,
        out=out,
    )

def calc_ptf_pidgeon1972_awc_sand_organic_matter(
    *,
    sand: float | ArrayLike,
    organic_matter: float | ArrayLike,
    out: NDArray[floating] | None = None,
) -> floating | NDArray[floating]:
    r"""Estimate available water capacity from sand and organic matter.

    Arguments:
        sand: Sand measured by particle-size method 2. (%)
        organic_matter: Organic matter content. (%)
        out: Optional output arrays for in-place calculation.

    Returns:
        available_water_capacity: Available water capacity. (mm/m)

    Models:
        $h(\theta)$: Available-water estimate

    Notes:
        Prediction target: Available water capacity

    """
    return _call(
        _calc_ptf_pidgeon1972_awc_sand_organic_matter,
        sand,
        organic_matter,
        out=out,
    )

def calc_ptf_pidgeon1972_awc_very_fine_sand(
    *,
    very_fine_sand: float | ArrayLike,
    out: NDArray[floating] | None = None,
) -> floating | NDArray[floating]:
    r"""Estimate available water capacity from very fine sand.

    Arguments:
        very_fine_sand: Very fine sand measured by particle-size method 1. (%)
        out: Optional output arrays for in-place calculation.

    Returns:
        available_water_capacity: Available water capacity. (mm/m)

    Models:
        $h(\theta)$: Available-water estimate

    Notes:
        Prediction target: Available water capacity

    """
    return _call(
        _calc_ptf_pidgeon1972_awc_very_fine_sand,
        very_fine_sand,
        out=out,
    )

def calc_ptf_pidgeon1972_eawc(
    *,
    silt: float | ArrayLike,
    clay: float | ArrayLike,
    organic_matter: float | ArrayLike,
    out: NDArray[floating] | None = None,
) -> floating | NDArray[floating]:
    r"""Estimate extended available water capacity from silt, clay, and organic matter.

    Arguments:
        silt: Silt measured by particle-size method 2. (%)
        clay: Clay measured by particle-size method 2. (%)
        organic_matter: Organic matter content. (%)
        out: Optional output arrays for in-place calculation.

    Returns:
        extended_available_water_capacity: Extended available water capacity. (mm/m)

    Models:
        $h(\theta)$: Available-water estimate

    Notes:
        Prediction target: Extended available water capacity

    """
    return _call(
        _calc_ptf_pidgeon1972_eawc,
        silt,
        clay,
        organic_matter,
        out=out,
    )

def calc_ptf_pidgeon1972_eawc_coarse_sand_organic_matter(
    *,
    coarse_sand: float | ArrayLike,
    organic_matter: float | ArrayLike,
    out: NDArray[floating] | None = None,
) -> floating | NDArray[floating]:
    r"""Estimate extended available water capacity from coarse sand and organic matter.

    Arguments:
        coarse_sand: Coarse sand measured by particle-size method 1. (%)
        organic_matter: Organic matter content. (%)
        out: Optional output arrays for in-place calculation.

    Returns:
        extended_available_water_capacity: Extended available water capacity. (mm/m)

    Models:
        $h(\theta)$: Available-water estimate

    Notes:
        Prediction target: Extended available water capacity

    """
    return _call(
        _calc_ptf_pidgeon1972_eawc_coarse_sand_organic_matter,
        coarse_sand,
        organic_matter,
        out=out,
    )

def calc_ptf_pidgeon1972_eawc_fine_sand_organic_matter(
    *,
    fine_sand: float | ArrayLike,
    organic_matter: float | ArrayLike,
    out: NDArray[floating] | None = None,
) -> floating | NDArray[floating]:
    r"""Estimate extended available water capacity from fine sand and organic matter.

    Arguments:
        fine_sand: Fine sand measured by particle-size method 1. (%)
        organic_matter: Organic matter content. (%)
        out: Optional output arrays for in-place calculation.

    Returns:
        extended_available_water_capacity: Extended available water capacity. (mm/m)

    Models:
        $h(\theta)$: Available-water estimate

    Notes:
        Prediction target: Extended available water capacity

    """
    return _call(
        _calc_ptf_pidgeon1972_eawc_fine_sand_organic_matter,
        fine_sand,
        organic_matter,
        out=out,
    )

def calc_ptf_pidgeon1972_eawc_sand(
    *,
    sand: float | ArrayLike,
    out: NDArray[floating] | None = None,
) -> floating | NDArray[floating]:
    r"""Estimate extended available water capacity from sand.

    Arguments:
        sand: Sand measured by particle-size method 2. (%)
        out: Optional output arrays for in-place calculation.

    Returns:
        extended_available_water_capacity: Extended available water capacity. (mm/m)

    Models:
        $h(\theta)$: Available-water estimate

    Notes:
        Prediction target: Extended available water capacity

    """
    return _call(
        _calc_ptf_pidgeon1972_eawc_sand,
        sand,
        out=out,
    )

def calc_ptf_pidgeon1972_eawc_sand_organic_matter(
    *,
    sand: float | ArrayLike,
    organic_matter: float | ArrayLike,
    out: NDArray[floating] | None = None,
) -> floating | NDArray[floating]:
    r"""Estimate extended available water capacity from sand and organic matter.

    Arguments:
        sand: Sand measured by particle-size method 1. (%)
        organic_matter: Organic matter content. (%)
        out: Optional output arrays for in-place calculation.

    Returns:
        extended_available_water_capacity: Extended available water capacity. (mm/m)

    Models:
        $h(\theta)$: Available-water estimate

    Notes:
        Prediction target: Extended available water capacity

    """
    return _call(
        _calc_ptf_pidgeon1972_eawc_sand_organic_matter,
        sand,
        organic_matter,
        out=out,
    )

def calc_ptf_pidgeon1972_fc(
    *,
    silt: float | ArrayLike,
    clay: float | ArrayLike,
    organic_matter: float | ArrayLike,
    out: NDArray[floating] | None = None,
) -> floating | NDArray[floating]:
    r"""Estimate gravimetric field capacity from silt, clay, and organic matter.

    Arguments:
        silt: Silt measured by particle-size method 2. (%)
        clay: Clay measured by particle-size method 2. (%)
        organic_matter: Organic matter content. (%)
        out: Optional output arrays for in-place calculation.

    Returns:
        field_capacity: Gravimetric field capacity. (% w/w)

    Models:
        $h(\theta)$: Point estimate

    Notes:
        Prediction target: Gravimetric field capacity
        The reviewed organic-matter coefficient is 1.54.

    """
    return _call(
        _calc_ptf_pidgeon1972_fc,
        silt,
        clay,
        organic_matter,
        out=out,
    )

def calc_ptf_pidgeon1972_fc_sand(
    *,
    sand: float | ArrayLike,
    out: NDArray[floating] | None = None,
) -> floating | NDArray[floating]:
    r"""Estimate gravimetric field capacity from sand.

    Arguments:
        sand: Sand measured by particle-size method 2. (%)
        out: Optional output arrays for in-place calculation.

    Returns:
        field_capacity: Gravimetric field capacity. (% w/w)

    Models:
        $h(\theta)$: Point estimate

    Notes:
        Prediction target: Gravimetric field capacity

    """
    return _call(
        _calc_ptf_pidgeon1972_fc_sand,
        sand,
        out=out,
    )

def calc_ptf_pidgeon1972_fc_sand_organic_matter(
    *,
    sand: float | ArrayLike,
    organic_matter: float | ArrayLike,
    out: NDArray[floating] | None = None,
) -> floating | NDArray[floating]:
    r"""Estimate gravimetric field capacity from sand and organic matter.

    Arguments:
        sand: Sand measured by particle-size method 2. (%)
        organic_matter: Organic matter content. (%)
        out: Optional output arrays for in-place calculation.

    Returns:
        field_capacity: Gravimetric field capacity. (% w/w)

    Models:
        $h(\theta)$: Point estimate

    Notes:
        Prediction target: Gravimetric field capacity

    """
    return _call(
        _calc_ptf_pidgeon1972_fc_sand_organic_matter,
        sand,
        organic_matter,
        out=out,
    )

def calc_ptf_pidgeon1972_fc_vol_sand_organic_matter(
    *,
    sand: float | ArrayLike,
    organic_matter: float | ArrayLike,
    out: NDArray[floating] | None = None,
) -> floating | NDArray[floating]:
    r"""Estimate volumetric field capacity from sand and organic matter.

    Arguments:
        sand: Sand measured by particle-size method 2. (%)
        organic_matter: Organic matter content. (%)
        out: Optional output arrays for in-place calculation.

    Returns:
        field_capacity: Volumetric field capacity. (% v/v)

    Models:
        $h(\theta)$: Point estimate

    Notes:
        Prediction target: Volumetric field capacity

    """
    return _call(
        _calc_ptf_pidgeon1972_fc_vol_sand_organic_matter,
        sand,
        organic_matter,
        out=out,
    )

def calc_ptf_pidgeon1972_pwp(
    *,
    silt: float | ArrayLike,
    clay: float | ArrayLike,
    organic_matter: float | ArrayLike,
    out: NDArray[floating] | None = None,
) -> floating | NDArray[floating]:
    r"""Estimate permanent wilting point from silt, clay, and organic matter.

    Arguments:
        silt: Silt measured by particle-size method 2. (%)
        clay: Clay measured by particle-size method 2. (%)
        organic_matter: Organic matter content. (%)
        out: Optional output arrays for in-place calculation.

    Returns:
        permanent_wilting_point: Permanent wilting point. (% w/w)

    Models:
        $h(\theta)$: Point estimate

    Notes:
        Prediction target: Gravimetric permanent wilting point

    """
    return _call(
        _calc_ptf_pidgeon1972_pwp,
        silt,
        clay,
        organic_matter,
        out=out,
    )

def calc_ptf_pidgeon1972_pwp_sand(
    *,
    sand: float | ArrayLike,
    out: NDArray[floating] | None = None,
) -> floating | NDArray[floating]:
    r"""Estimate permanent wilting point from sand.

    Arguments:
        sand: Sand measured by particle-size method 1. (%)
        out: Optional output arrays for in-place calculation.

    Returns:
        permanent_wilting_point: Permanent wilting point. (% w/w)

    Models:
        $h(\theta)$: Point estimate

    Notes:
        Prediction target: Gravimetric permanent wilting point

    """
    return _call(
        _calc_ptf_pidgeon1972_pwp_sand,
        sand,
        out=out,
    )

def calc_ptf_pidgeon1972_pwp_sand_organic_matter(
    *,
    sand: float | ArrayLike,
    organic_matter: float | ArrayLike,
    out: NDArray[floating] | None = None,
) -> floating | NDArray[floating]:
    r"""Estimate permanent wilting point from sand and organic matter.

    Arguments:
        sand: Sand measured by particle-size method 2. (%)
        organic_matter: Organic matter content. (%)
        out: Optional output arrays for in-place calculation.

    Returns:
        permanent_wilting_point: Permanent wilting point. (% w/w)

    Models:
        $h(\theta)$: Point estimate

    Notes:
        Prediction target: Gravimetric permanent wilting point

    """
    return _call(
        _calc_ptf_pidgeon1972_pwp_sand_organic_matter,
        sand,
        organic_matter,
        out=out,
    )