Skip to content

ptfkit.li2007

ptfkit.li2007

Li et al. (2007), Fengqiu County, North China Plain, China.

Reference

Li, Y., Chen, D., White, R. E., Zhu, A., & Zhang, J. (2007). Estimating soil hydraulic properties of Fengqiu County soils in the North China Plain using pedo-transfer functions. Geoderma, 138(3-4), 261-271. DOI: 10.1016/j.geoderma.2006.11.018

Territory

Fengqiu County soils in the North China Plain, China

Dataset

63 soil water retention curves and 36 saturated soil hydraulic conductivity samples from seven soil profiles.

CLASS DESCRIPTION
Li2007PTFResult

Results returned by the matching PTF.
FUNCTION DESCRIPTION
calc_ptf_li2007

Calculate the pedotransfer function.

Li2007PTFResult

Bases: NamedTuple, Generic[T]

Results returned by the matching PTF.

ATTRIBUTE DESCRIPTION
theta_s

Saturated water content. (cm^3/cm^3)

TYPE: T

a_vg

Van Genuchten alpha parameter, inversely related to air-entry suction. (cm^-1)

TYPE: T

n_vg

Van Genuchten n parameter that characterizes pore-size distribution. (dimensionless)

TYPE: T

k_sat

Saturated hydraulic conductivity. (m/s)

TYPE: T

Source code in ptfkit/li2007.py 
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
class Li2007PTFResult(NamedTuple, Generic[T]):
    """Results returned by the matching PTF.

    Attributes:
        theta_s: Saturated water content. (cm^3/cm^3)
        a_vg: Van Genuchten alpha parameter, inversely related to air-entry suction. (cm^-1)
        n_vg: Van Genuchten n parameter that characterizes pore-size distribution. (dimensionless)
        k_sat: Saturated hydraulic conductivity. (m/s)

    """

    theta_s: T
    a_vg: T
    n_vg: T
    k_sat: T

calc_ptf_li2007 

calc_ptf_li2007(*, sand: float, silt: float, clay: float, bulk_density: float, soil_organic_matter: float) -> Li2007PTFResult[floating]

calc_ptf_li2007(*, sand: ArrayLike, silt: ArrayLike, clay: ArrayLike, bulk_density: ArrayLike, soil_organic_matter: ArrayLike, out: Li2007PTFResult[NDArray[floating]] | None = None) -> Li2007PTFResult[NDArray[floating]]

Calculate the pedotransfer function.

Estimate van Genuchten parameters and saturated hydraulic conductivity for Fengqiu County soils.

PARAMETER DESCRIPTION
sand

Sand content, 0.02-2 mm. (%)

TYPE: float | ArrayLike

silt

Silt content, 0.02-0.002 mm. (%)

TYPE: float | ArrayLike

clay

Clay content, <0.002 mm. (%)

TYPE: float | ArrayLike

bulk_density

Bulk density. (g/cm^3)

TYPE: float | ArrayLike

soil_organic_matter

Soil organic matter. (%)

TYPE: float | ArrayLike

out

Optional output arrays for in-place calculation.

TYPE: Li2007PTFResult[NDArray[floating]] | None DEFAULT: None

RETURNS DESCRIPTION
Li2007PTFResult

Results grouped by result attributes.

TYPE: Li2007PTFResult[floating] | Li2007PTFResult[NDArray[floating]]

Models

\(h(\theta)\): Van Genuchten model without residual water content term \(k(h)\): Saturated hydraulic conductivity

Notes

Prediction target: Van Genuchten saturated water content, alpha, n, and saturated hydraulic conductivity.

Warning

The formulas use natural logarithms of selected inputs.

Source code in ptfkit/li2007.py 
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
def calc_ptf_li2007(
    *,
    sand: float | ArrayLike,
    silt: float | ArrayLike,
    clay: float | ArrayLike,
    bulk_density: float | ArrayLike,
    soil_organic_matter: float | ArrayLike,
    out: Li2007PTFResult[NDArray[floating]] | None = None,
) -> Li2007PTFResult[floating] | Li2007PTFResult[NDArray[floating]]:
    r"""Calculate the pedotransfer function.

    Estimate van Genuchten parameters and saturated hydraulic conductivity for Fengqiu County soils.

    Arguments:
        sand: Sand content, 0.02-2 mm. (%)
        silt: Silt content, 0.02-0.002 mm. (%)
        clay: Clay content, <0.002 mm. (%)
        bulk_density: Bulk density. (g/cm^3)
        soil_organic_matter: Soil organic matter. (%)
        out: Optional output arrays for in-place calculation.

    Returns:
        Li2007PTFResult: Results grouped by result attributes.

    Models:
        $h(\theta)$: Van Genuchten model without residual water content term
        $k(h)$: Saturated hydraulic conductivity

    Notes:
        Prediction target: Van Genuchten saturated water content, alpha, n, and saturated hydraulic
            conductivity.

    Warning:
        The formulas use natural logarithms of selected inputs.

    """
    values = _call(
        _calc_ptf_li2007,
        sand,
        silt,
        clay,
        bulk_density,
        soil_organic_matter,
        out=out,
    )

    return Li2007PTFResult(*values)