ptfkit.tiwary2014

ptfkit.tiwary2014 ¶

Tiwary et al. (2014), hydraulic PTFs for two major soil regions of India.

Reference

Tiwary, P., Patil, N. G., Bhattacharyya, T., Chandran, P., Ray, S. K., Karthikeyan, K., ... & Thakre, S. (2014). Pedotransfer functions: a tool for estimating hydraulic properties of two major soil types of India. Current Science, 1431-1439.

Territory: Indo-Gangetic Plains and black soil region of India
Dataset: 209 layers from 30 Indo-Gangetic Plains profiles and 275 layers from 62 black-soil profiles; equation-specific subsets are described below.

CLASS	DESCRIPTION
`Tiwary2014PTFResult`	Results returned by the matching PTF.

FUNCTION	DESCRIPTION
`calc_ptf_tiwary2014_bsr`	Estimate water retention and saturated conductivity for the black soil region.
`calc_ptf_tiwary2014_igp`	Estimate saturated conductivity for Indo-Gangetic Plains soils.

Tiwary2014PTFResult ¶

Bases: NamedTuple, Generic[T]

Results returned by the matching PTF.

ATTRIBUTE	DESCRIPTION
`w_33`	Gravimetric water content at 33 kPa. (%) TYPE: `T`
`w_100`	Gravimetric water content at 100 kPa. (%) TYPE: `T`
`w_1500`	Gravimetric water content at 1500 kPa. (%) TYPE: `T`
`k_sat`	Saturated hydraulic conductivity converted from mm/h. (m/s) TYPE: `T`

Source code in ptfkit/tiwary2014.py

class Tiwary2014PTFResult(NamedTuple, Generic[T]):
    """Results returned by the matching PTF.

    Attributes:
        w_33: Gravimetric water content at 33 kPa. (%)
        w_100: Gravimetric water content at 100 kPa. (%)
        w_1500: Gravimetric water content at 1500 kPa. (%)
        k_sat: Saturated hydraulic conductivity converted from mm/h. (m/s)

    """

    w_33: T
    w_100: T
    w_1500: T
    k_sat: T

calc_ptf_tiwary2014_bsr ¶

calc_ptf_tiwary2014_bsr(*, clay: float, ph: float, cation_exchange_capacity: float, esp: float, emp: float, excm: float) -> Tiwary2014PTFResult[floating]

calc_ptf_tiwary2014_bsr(*, clay: ArrayLike, ph: ArrayLike, cation_exchange_capacity: ArrayLike, esp: ArrayLike, emp: ArrayLike, excm: ArrayLike, out: Tiwary2014PTFResult[NDArray[floating]] | None = None) -> Tiwary2014PTFResult[NDArray[floating]]

Estimate water retention and saturated conductivity for the black soil region.

PARAMETER	DESCRIPTION
`clay`	Clay content. (%) TYPE: `float \| ArrayLike`
`ph`	Soil pH. (dimensionless) TYPE: `float \| ArrayLike`
`cation_exchange_capacity`	Cation exchange capacity. (cmol(c)/kg) TYPE: `float \| ArrayLike`
`esp`	Exchangeable sodium percentage. (%) TYPE: `float \| ArrayLike`
`emp`	Exchangeable magnesium percentage. (%) TYPE: `float \| ArrayLike`
`excm`	Exchangeable calcium-to-magnesium ratio. (dimensionless) TYPE: `float \| ArrayLike`
`out`	Optional output arrays for in-place calculation. TYPE: `Tiwary2014PTFResult[NDArray[floating]] \| None` DEFAULT: `None`

RETURNS	DESCRIPTION
`Tiwary2014PTFResult`	Results grouped by result attributes. TYPE: `Tiwary2014PTFResult[floating] \| Tiwary2014PTFResult[NDArray[floating]]`

Models

\(h(\theta)\): Point water-retention estimates \(k(h)\): Saturated hydraulic conductivity

Notes

Prediction target: Gravimetric water contents at 33, 100, and 1500 kPa and saturated hydraulic conductivity. Water-retention equations used 75 layers from 14 profiles; equation 10 used 200 layers from 46 profiles.

Source code in ptfkit/tiwary2014.py

def calc_ptf_tiwary2014_bsr(
    *,
    clay: float | ArrayLike,
    ph: float | ArrayLike,
    cation_exchange_capacity: float | ArrayLike,
    esp: float | ArrayLike,
    emp: float | ArrayLike,
    excm: float | ArrayLike,
    out: Tiwary2014PTFResult[NDArray[floating]] | None = None,
) -> Tiwary2014PTFResult[floating] | Tiwary2014PTFResult[NDArray[floating]]:
    r"""Estimate water retention and saturated conductivity for the black soil region.

    Arguments:
        clay: Clay content. (%)
        ph: Soil pH. (dimensionless)
        cation_exchange_capacity: Cation exchange capacity. (cmol(c)/kg)
        esp: Exchangeable sodium percentage. (%)
        emp: Exchangeable magnesium percentage. (%)
        excm: Exchangeable calcium-to-magnesium ratio. (dimensionless)
        out: Optional output arrays for in-place calculation.

    Returns:
        Tiwary2014PTFResult: Results grouped by result attributes.

    Models:
        $h(\theta)$: Point water-retention estimates
        $k(h)$: Saturated hydraulic conductivity

    Notes:
        Prediction target: Gravimetric water contents at 33, 100, and 1500 kPa and saturated
            hydraulic conductivity.
        Water-retention equations used 75 layers from 14 profiles; equation 10 used 200 layers from
            46 profiles.

    """
    values = _call(
        _calc_ptf_tiwary2014_bsr,
        clay,
        ph,
        cation_exchange_capacity,
        esp,
        emp,
        excm,
        out=out,
    )

    return Tiwary2014PTFResult(*values)

calc_ptf_tiwary2014_igp ¶

calc_ptf_tiwary2014_igp(*, sand: float, bulk_density: float, esp: float) -> floating

calc_ptf_tiwary2014_igp(*, sand: ArrayLike, bulk_density: ArrayLike, esp: ArrayLike, out: NDArray[floating] | None = None) -> NDArray[floating]

Estimate saturated conductivity for Indo-Gangetic Plains soils.

PARAMETER	DESCRIPTION
`sand`	Sand content. (%) TYPE: `float \| ArrayLike`
`bulk_density`	Bulk density. (Mg/m^3) TYPE: `float \| ArrayLike`
`esp`	Exchangeable sodium percentage. (%) TYPE: `float \| ArrayLike`
`out`	Optional output arrays for in-place calculation. TYPE: `NDArray[floating] \| None` DEFAULT: `None`

RETURNS	DESCRIPTION
`k_sat`	Saturated hydraulic conductivity converted from mm/h. (m/s) TYPE: `floating \| NDArray[floating]`

Models

\(k(h)\): Saturated hydraulic conductivity

Notes

Prediction target: Saturated hydraulic conductivity. Equation 11 was calibrated on 100 layers from 20 Indo-Gangetic Plains profiles.

Warning

The legacy API's three water-retention outputs are intentionally excluded because the source defines them only for BSR soils.

Source code in ptfkit/tiwary2014.py

def calc_ptf_tiwary2014_igp(
    *,
    sand: float | ArrayLike,
    bulk_density: float | ArrayLike,
    esp: float | ArrayLike,
    out: NDArray[floating] | None = None,
) -> floating | NDArray[floating]:
    """Estimate saturated conductivity for Indo-Gangetic Plains soils.

    Arguments:
        sand: Sand content. (%)
        bulk_density: Bulk density. (Mg/m^3)
        esp: Exchangeable sodium percentage. (%)
        out: Optional output arrays for in-place calculation.

    Returns:
        k_sat: Saturated hydraulic conductivity converted from mm/h. (m/s)

    Models:
        $k(h)$: Saturated hydraulic conductivity

    Notes:
        Prediction target: Saturated hydraulic conductivity.
        Equation 11 was calibrated on 100 layers from 20 Indo-Gangetic Plains profiles.

    Warning:
        The legacy API's three water-retention outputs are intentionally excluded because the source
            defines them only for BSR soils.

    """
    return _call(
        _calc_ptf_tiwary2014_igp,
        sand,
        bulk_density,
        esp,
        out=out,
    )