ptfkit.oosterveld1980

def calc_ptf_oosterveld1980_available_water(
    *,
    clay: float | ArrayLike,
    sand: float | ArrayLike,
    mean_depth: float | ArrayLike,
    out: NDArray[floating] | None = None,
) -> floating | NDArray[floating]:
    r"""Estimate available gravimetric soil moisture between field capacity and wilting point.

    Arguments:
        clay: Clay content in percent by weight; the field-capacity tension experiment covered 2% to
            72% clay. (% mass)
        sand: Sand content in percent by weight. (% mass)
        mean_depth: Mean depth of the soil sample. (cm)
        out: Optional output arrays for in-place calculation.

    Returns:
        available_moisture: Predicted field-capacity moisture minus predicted wilting-point
            moisture, in percentage points by weight. (% mass)

    Models:
        $h(\theta)$: Available-moisture point estimate from Equations 3 and 4

    Notes:
        Prediction target: Difference between gravimetric moisture content at field capacity and at
            the 1500 kPa wilting point.
        The paper defines available soil water by subtracting Equation 4 from Equation 3.

    """
    return _call(
        _calc_ptf_oosterveld1980_available_water,
        clay,
        sand,
        mean_depth,
        out=out,
    )

def calc_ptf_oosterveld1980_field_capacity(
    *,
    clay: float | ArrayLike,
    sand: float | ArrayLike,
    mean_depth: float | ArrayLike,
    out: NDArray[floating] | None = None,
) -> floating | NDArray[floating]:
    r"""Estimate gravimetric soil-moisture content at field capacity.

    Arguments:
        clay: Clay content in percent by weight; the field-capacity tension experiment covered 2% to
            72% clay. (% mass)
        sand: Sand content in percent by weight. (% mass)
        mean_depth: Mean depth of the soil sample. (cm)
        out: Optional output arrays for in-place calculation.

    Returns:
        field_capacity_moisture: Predicted soil-moisture content at field capacity in percent by
            weight. (% mass)

    Models:
        $h(\theta)$: Field-capacity point estimate derived from Equations 1 and 2

    Notes:
        Prediction target: Gravimetric soil-moisture content at field capacity.
        Equation 3 is obtained by substituting the Equation 1 field-capacity tension into Equation
            2.

    """
    return _call(
        _calc_ptf_oosterveld1980_field_capacity,
        clay,
        sand,
        mean_depth,
        out=out,
    )

def calc_ptf_oosterveld1980_field_capacity_tension(
    *,
    clay: float | ArrayLike,
    out: NDArray[floating] | None = None,
) -> floating | NDArray[floating]:
    r"""Estimate field-capacity tension from clay content.

    Arguments:
        clay: Clay content in percent by weight; the field-capacity tension experiment covered 2% to
            72% clay. (% mass)
        out: Optional output arrays for in-place calculation.

    Returns:
        field_capacity_tension: Predicted tension corresponding to cylinder-method field capacity.
            (kPa)

    Models:
        $h(\theta)$: Field-capacity tension point estimate

    Notes:
        Prediction target: Tension at which pressure-plate moisture content equals field capacity
            determined by the cylinder method.
        Equation 1 reports r = 0.67 and n = 134.

    """
    return _call(
        _calc_ptf_oosterveld1980_field_capacity_tension,
        clay,
        out=out,
    )

def calc_ptf_oosterveld1980_retention(
    *,
    clay: float | ArrayLike,
    sand: float | ArrayLike,
    mean_depth: float | ArrayLike,
    tension: float | ArrayLike,
    out: NDArray[floating] | None = None,
) -> floating | NDArray[floating]:
    r"""Estimate gravimetric soil-moisture content from texture, depth, and tension.

    Arguments:
        clay: Clay content in percent by weight. (% mass)
        sand: Sand content in percent by weight. (% mass)
        mean_depth: Mean depth of the soil sample. (cm)
        tension: Soil-moisture tension. (kPa)
        out: Optional output arrays for in-place calculation.

    Returns:
        moisture_content: Predicted soil-moisture content in percent by weight. (% mass)

    Models:
        $h(\theta)$: Empirical power-law moisture-retention relation

    Notes:
        Prediction target: Gravimetric soil-moisture content at a specified tension.
        Equation 2 reports r = 0.96 and n = 1,137.

    Warning:
        The paper reports slight inaccuracy at very high clay content and high tension.

    """
    return _call(
        _calc_ptf_oosterveld1980_retention,
        clay,
        sand,
        mean_depth,
        tension,
        out=out,
    )

def calc_ptf_oosterveld1980_wilting_point(
    *,
    clay: float | ArrayLike,
    sand: float | ArrayLike,
    mean_depth: float | ArrayLike,
    out: NDArray[floating] | None = None,
) -> floating | NDArray[floating]:
    r"""Estimate gravimetric soil-moisture content at the 1500 kPa wilting point.

    Arguments:
        clay: Clay content in percent by weight. (% mass)
        sand: Sand content in percent by weight. (% mass)
        mean_depth: Mean depth of the soil sample. (cm)
        out: Optional output arrays for in-place calculation.

    Returns:
        wilting_point_moisture: Predicted soil-moisture content at 1500 kPa in percent by weight. (%
            mass)

    Models:
        $h(\theta)$: Wilting-point estimate at 1500 kPa

    Notes:
        Prediction target: Gravimetric soil-moisture content at 1500 kPa.
        Equation 4 reports r = 0.96 and n = 298.
        The paper takes moisture content at 1500 kPa as the wilting point.

    """
    return _call(
        _calc_ptf_oosterveld1980_wilting_point,
        clay,
        sand,
        mean_depth,
        out=out,
    )