ptfkit.beniaich2023

def calc_ptf_beniaich2023_mlr1(
    *,
    silt: float | ArrayLike,
    sand: float | ArrayLike,
    soil_organic_matter: float | ArrayLike,
    out: Beniaich2023PTFResult[NDArray[floating]] | None = None,
) -> Beniaich2023PTFResult[floating] | Beniaich2023PTFResult[NDArray[floating]]:
    r"""Estimate three gravimetric water contents from silt, sand, and organic matter.

    Arguments:
        silt: Silt content by mass. (%)
        sand: Sand content by mass. (%)
        soil_organic_matter: Soil organic matter content by mass. (%)
        out: Optional output arrays for in-place calculation.

    Returns:
        Beniaich2023PTFResult: Results grouped by result attributes.

    Models:
        $h(\theta)$: Three point estimates

    Notes:
        Prediction target: Gravimetric water content at saturation, -33 kPa, and -1,500 kPa.
        Source regressions operate in percentage points; outputs are divided by 100 to return g/g.

    Warning:
        Developed from Moroccan agricultural topsoils and not independently validated outside the
            source territory.

    """
    values = _call(
        _calc_ptf_beniaich2023_mlr1,
        silt,
        sand,
        soil_organic_matter,
        out=out,
    )

    return Beniaich2023PTFResult(*values)

def calc_ptf_beniaich2023_mlr2(
    *,
    sand: float | ArrayLike,
    soil_organic_matter: float | ArrayLike,
    out: Beniaich2023PTFResult[NDArray[floating]] | None = None,
) -> Beniaich2023PTFResult[floating] | Beniaich2023PTFResult[NDArray[floating]]:
    r"""Estimate three gravimetric water contents from sand and organic matter.

    Arguments:
        sand: Sand content by mass. (%)
        soil_organic_matter: Soil organic matter content by mass. (%)
        out: Optional output arrays for in-place calculation.

    Returns:
        Beniaich2023PTFResult: Results grouped by result attributes.

    Models:
        $h(\theta)$: Three point estimates

    Notes:
        Prediction target: Gravimetric water content at saturation, -33 kPa, and -1,500 kPa.
        Source regressions operate in percentage points; outputs are divided by 100 to return g/g.

    Warning:
        Developed from Moroccan agricultural topsoils and not independently validated outside the
            source territory.

    """
    values = _call(
        _calc_ptf_beniaich2023_mlr2,
        sand,
        soil_organic_matter,
        out=out,
    )

    return Beniaich2023PTFResult(*values)

def calc_ptf_beniaich2023_mlr3(
    *,
    silt: float | ArrayLike,
    soil_organic_matter: float | ArrayLike,
    out: Beniaich2023PTFResult[NDArray[floating]] | None = None,
) -> Beniaich2023PTFResult[floating] | Beniaich2023PTFResult[NDArray[floating]]:
    r"""Estimate three gravimetric water contents from silt and organic matter.

    Arguments:
        silt: Silt content by mass. (%)
        soil_organic_matter: Soil organic matter content by mass. (%)
        out: Optional output arrays for in-place calculation.

    Returns:
        Beniaich2023PTFResult: Results grouped by result attributes.

    Models:
        $h(\theta)$: Three point estimates

    Notes:
        Prediction target: Gravimetric water content at saturation, -33 kPa, and -1,500 kPa.
        Source regressions operate in percentage points; outputs are divided by 100 to return g/g.

    Warning:
        Developed from Moroccan agricultural topsoils and not independently validated outside the
            source territory.

    """
    values = _call(
        _calc_ptf_beniaich2023_mlr3,
        silt,
        soil_organic_matter,
        out=out,
    )

    return Beniaich2023PTFResult(*values)

def calc_ptf_beniaich2023_mlr4(
    *,
    clay: float | ArrayLike,
    soil_organic_matter: float | ArrayLike,
    out: Beniaich2023PTFResult[NDArray[floating]] | None = None,
) -> Beniaich2023PTFResult[floating] | Beniaich2023PTFResult[NDArray[floating]]:
    r"""Estimate three gravimetric water contents from clay and organic matter.

    Arguments:
        clay: Clay content by mass. (%)
        soil_organic_matter: Soil organic matter content by mass. (%)
        out: Optional output arrays for in-place calculation.

    Returns:
        Beniaich2023PTFResult: Results grouped by result attributes.

    Models:
        $h(\theta)$: Three point estimates

    Notes:
        Prediction target: Gravimetric water content at saturation, -33 kPa, and -1,500 kPa.
        Source regressions operate in percentage points; outputs are divided by 100 to return g/g.

    Warning:
        Developed from Moroccan agricultural topsoils and not independently validated outside the
            source territory.

    """
    values = _call(
        _calc_ptf_beniaich2023_mlr4,
        clay,
        soil_organic_matter,
        out=out,
    )

    return Beniaich2023PTFResult(*values)

def calc_ptf_beniaich2023_mlr5(
    *,
    clay: float | ArrayLike,
    silt: float | ArrayLike,
    soil_organic_matter: float | ArrayLike,
    out: Beniaich2023PTFResult[NDArray[floating]] | None = None,
) -> Beniaich2023PTFResult[floating] | Beniaich2023PTFResult[NDArray[floating]]:
    r"""Estimate three gravimetric water contents from clay, silt, and organic matter.

    Arguments:
        clay: Clay content by mass. (%)
        silt: Silt content by mass. (%)
        soil_organic_matter: Soil organic matter content by mass. (%)
        out: Optional output arrays for in-place calculation.

    Returns:
        Beniaich2023PTFResult: Results grouped by result attributes.

    Models:
        $h(\theta)$: Three point estimates

    Notes:
        Prediction target: Gravimetric water content at saturation, -33 kPa, and -1,500 kPa.
        Source regressions operate in percentage points; outputs are divided by 100 to return g/g.

    Warning:
        Developed from Moroccan agricultural topsoils and not independently validated outside the
            source territory.

    """
    values = _call(
        _calc_ptf_beniaich2023_mlr5,
        clay,
        silt,
        soil_organic_matter,
        out=out,
    )

    return Beniaich2023PTFResult(*values)

def calc_ptf_beniaich2023_slr1(
    *,
    clay: float | ArrayLike,
    out: Beniaich2023PTFResult[NDArray[floating]] | None = None,
) -> Beniaich2023PTFResult[floating] | Beniaich2023PTFResult[NDArray[floating]]:
    r"""Estimate three gravimetric water contents from clay.

    Arguments:
        clay: Clay content by mass. (%)
        out: Optional output arrays for in-place calculation.

    Returns:
        Beniaich2023PTFResult: Results grouped by result attributes.

    Models:
        $h(\theta)$: Three point estimates

    Notes:
        Prediction target: Gravimetric water content at saturation, -33 kPa, and -1,500 kPa.
        Source regressions operate in percentage points; outputs are divided by 100 to return g/g.

    Warning:
        Developed from Moroccan agricultural topsoils and not independently validated outside the
            source territory.

    """
    values = _call(
        _calc_ptf_beniaich2023_slr1,
        clay,
        out=out,
    )

    return Beniaich2023PTFResult(*values)

def calc_ptf_beniaich2023_slr2(
    *,
    silt: float | ArrayLike,
    out: Beniaich2023PTFResult[NDArray[floating]] | None = None,
) -> Beniaich2023PTFResult[floating] | Beniaich2023PTFResult[NDArray[floating]]:
    r"""Estimate three gravimetric water contents from silt.

    Arguments:
        silt: Silt content by mass. (%)
        out: Optional output arrays for in-place calculation.

    Returns:
        Beniaich2023PTFResult: Results grouped by result attributes.

    Models:
        $h(\theta)$: Three point estimates

    Notes:
        Prediction target: Gravimetric water content at saturation, -33 kPa, and -1,500 kPa.
        Source regressions operate in percentage points; outputs are divided by 100 to return g/g.

    Warning:
        Developed from Moroccan agricultural topsoils and not independently validated outside the
            source territory.

    """
    values = _call(
        _calc_ptf_beniaich2023_slr2,
        silt,
        out=out,
    )

    return Beniaich2023PTFResult(*values)

def calc_ptf_beniaich2023_slr3(
    *,
    sand: float | ArrayLike,
    out: Beniaich2023PTFResult[NDArray[floating]] | None = None,
) -> Beniaich2023PTFResult[floating] | Beniaich2023PTFResult[NDArray[floating]]:
    r"""Estimate three gravimetric water contents from sand.

    Arguments:
        sand: Sand content by mass. (%)
        out: Optional output arrays for in-place calculation.

    Returns:
        Beniaich2023PTFResult: Results grouped by result attributes.

    Models:
        $h(\theta)$: Three point estimates

    Notes:
        Prediction target: Gravimetric water content at saturation, -33 kPa, and -1,500 kPa.
        Source regressions operate in percentage points; outputs are divided by 100 to return g/g.

    Warning:
        Developed from Moroccan agricultural topsoils and not independently validated outside the
            source territory.

    """
    values = _call(
        _calc_ptf_beniaich2023_slr3,
        sand,
        out=out,
    )

    return Beniaich2023PTFResult(*values)

def calc_ptf_beniaich2023_slr4(
    *,
    clay: float | ArrayLike,
    silt: float | ArrayLike,
    out: Beniaich2023PTFResult[NDArray[floating]] | None = None,
) -> Beniaich2023PTFResult[floating] | Beniaich2023PTFResult[NDArray[floating]]:
    r"""Estimate three gravimetric water contents from clay plus silt.

    Arguments:
        clay: Clay content by mass. (%)
        silt: Silt content by mass. (%)
        out: Optional output arrays for in-place calculation.

    Returns:
        Beniaich2023PTFResult: Results grouped by result attributes.

    Models:
        $h(\theta)$: Three point estimates

    Notes:
        Prediction target: Gravimetric water content at saturation, -33 kPa, and -1,500 kPa.
        Source regressions operate in percentage points; outputs are divided by 100 to return g/g.

    Warning:
        Developed from Moroccan agricultural topsoils and not independently validated outside the
            source territory.

    """
    values = _call(
        _calc_ptf_beniaich2023_slr4,
        clay,
        silt,
        out=out,
    )

    return Beniaich2023PTFResult(*values)

def calc_ptf_beniaich2023_slr5(
    *,
    clay: float | ArrayLike,
    silt: float | ArrayLike,
    out: Beniaich2023PTFResult[NDArray[floating]] | None = None,
) -> Beniaich2023PTFResult[floating] | Beniaich2023PTFResult[NDArray[floating]]:
    r"""Estimate three gravimetric water contents from the clay-to-silt ratio.

    Arguments:
        clay: Clay content by mass. (%)
        silt: Silt content by mass and denominator of the clay-to-silt ratio. (%)
        out: Optional output arrays for in-place calculation.

    Returns:
        Beniaich2023PTFResult: Results grouped by result attributes.

    Models:
        $h(\theta)$: Three point estimates

    Notes:
        Prediction target: Gravimetric water content at saturation, -33 kPa, and -1,500 kPa.
        Source regressions operate in percentage points; outputs are divided by 100 to return g/g.

    Warning:
        Developed from Moroccan agricultural topsoils and not independently validated outside the
            source territory.

    """
    values = _call(
        _calc_ptf_beniaich2023_slr5,
        clay,
        silt,
        out=out,
    )

    return Beniaich2023PTFResult(*values)

def calc_ptf_beniaich2023_slr6(
    *,
    soil_organic_matter: float | ArrayLike,
    out: Beniaich2023PTFResult[NDArray[floating]] | None = None,
) -> Beniaich2023PTFResult[floating] | Beniaich2023PTFResult[NDArray[floating]]:
    r"""Estimate three gravimetric water contents from soil organic matter.

    Arguments:
        soil_organic_matter: Soil organic matter content by mass. (%)
        out: Optional output arrays for in-place calculation.

    Returns:
        Beniaich2023PTFResult: Results grouped by result attributes.

    Models:
        $h(\theta)$: Three point estimates

    Notes:
        Prediction target: Gravimetric water content at saturation, -33 kPa, and -1,500 kPa.
        Source regressions operate in percentage points; outputs are divided by 100 to return g/g.

    Warning:
        Developed from Moroccan agricultural topsoils and not independently validated outside the
            source territory.

    """
    values = _call(
        _calc_ptf_beniaich2023_slr6,
        soil_organic_matter,
        out=out,
    )

    return Beniaich2023PTFResult(*values)