Skip to content

ptfkit.varallyai1982

ptfkit.varallyai1982

Varallyai et al. (1982), water-retention parameter regressions for Hungarian soils.

Reference

Varallyai, D., Raikai, K., Mironenko, Ye. V., Pachepskiy, Ya. A., & Scherbakov, R. A. (1982). A mathematical description of basic water-physical soil characteristics. Pochvovedenie, (4), 77-89.

Territory

Hungary, mainly the Hungarian Plain

Dataset

Undisturbed samples from 559 genetic horizons in 160 soil profiles; the meadow-series regressions used 68 samples and the chernozem comparison used 108 samples.

CLASS DESCRIPTION
Varallyai1982Parameters

Results returned by the matching PTF.

FUNCTION DESCRIPTION
calc_ptf_varallyai1982_chernozem_a

Estimate equation (9) water-retention parameters for chernozem A horizons.

calc_ptf_varallyai1982_chernozem_b

Estimate equation (9) water-retention parameters for chernozem B horizons.

calc_ptf_varallyai1982_chernozem_c

Estimate equation (9) water-retention parameters for chernozem C horizons.

calc_ptf_varallyai1982_meadow

Estimate equation (9) water-retention parameters for meadow-series soils.

Varallyai1982Parameters

Bases: NamedTuple, Generic[T]

Results returned by the matching PTF.

ATTRIBUTE DESCRIPTION
theta_0

Upper-asymptote water content parameter of equation (9). (vol.%)

TYPE: T

m

Shape parameter of equation (9). (dimensionless)

TYPE: T

pf_star

Base-10 logarithm of the equation (9) suction-scale parameter psi_*, with suction expressed in centimetres of water. (dimensionless)

TYPE: T

Source code in ptfkit/varallyai1982.py
43
44
45
46
47
48
49
50
51
52
53
54
55
56
class Varallyai1982Parameters(NamedTuple, Generic[T]):
    """Results returned by the matching PTF.

    Attributes:
        theta_0: Upper-asymptote water content parameter of equation (9). (vol.%)
        m: Shape parameter of equation (9). (dimensionless)
        pf_star: Base-10 logarithm of the equation (9) suction-scale parameter psi_*, with suction
            expressed in centimetres of water. (dimensionless)

    """

    theta_0: T
    m: T
    pf_star: T

calc_ptf_varallyai1982_chernozem_a

calc_ptf_varallyai1982_chernozem_a(*, bulk_density: float, fine_fraction: float) -> Varallyai1982Parameters[floating]
calc_ptf_varallyai1982_chernozem_a(*, bulk_density: ArrayLike, fine_fraction: ArrayLike, out: Varallyai1982Parameters[NDArray[floating]] | None = None) -> Varallyai1982Parameters[NDArray[floating]]

Estimate equation (9) water-retention parameters for chernozem A horizons.

PARAMETER DESCRIPTION
bulk_density

Undisturbed-soil bulk density. (g/cm^3)

TYPE: float | ArrayLike

fine_fraction

Fine-particle mass fraction reported as particles smaller than 0.002 mm. (fraction)

TYPE: float | ArrayLike

out

Optional output arrays for in-place calculation.

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

RETURNS DESCRIPTION
Varallyai1982Parameters

Results grouped by result attributes.

TYPE: Varallyai1982Parameters[floating] | Varallyai1982Parameters[NDArray[floating]]

Territory

Hungary, mainly the Hungarian Plain

Models

\(h(\theta)\): theta = theta_0 / (1 + (psi / psi_*)^m)

Notes

Prediction target: Parameters of the equation (9) water-retention model for chernozem A horizons. Equation (15) applies to chernozem A horizons. The source reports 95% relative errors of 10% for theta_0, 29% for m, and 18% for pF_*.

Warning

Use is described as approximate by the source. The source does not report exact calibration ranges; avoid extrapolation beyond comparable Hungarian chernozem A horizons.

Source code in ptfkit/varallyai1982.py
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
def calc_ptf_varallyai1982_chernozem_a(
    *,
    bulk_density: float | ArrayLike,
    fine_fraction: float | ArrayLike,
    out: Varallyai1982Parameters[NDArray[floating]] | None = None,
) -> Varallyai1982Parameters[floating] | Varallyai1982Parameters[NDArray[floating]]:
    r"""Estimate equation (9) water-retention parameters for chernozem A horizons.

    Arguments:
        bulk_density: Undisturbed-soil bulk density. (g/cm^3)
        fine_fraction: Fine-particle mass fraction reported as particles smaller than 0.002 mm.
            (fraction)
        out: Optional output arrays for in-place calculation.

    Returns:
        Varallyai1982Parameters: Results grouped by result attributes.

    Territory:
        Hungary, mainly the Hungarian Plain

    Models:
        $h(\theta)$: theta = theta_0 / (1 + (psi / psi_*)^m)

    Notes:
        Prediction target: Parameters of the equation (9) water-retention model for chernozem A
            horizons.
        Equation (15) applies to chernozem A horizons.
        The source reports 95% relative errors of 10% for theta_0, 29% for m, and 18% for pF_*.

    Warning:
        Use is described as approximate by the source.
        The source does not report exact calibration ranges; avoid extrapolation beyond comparable
            Hungarian chernozem A horizons.

    """
    values = _call(
        _calc_ptf_varallyai1982_chernozem_a,
        bulk_density,
        fine_fraction,
        out=out,
    )

    return Varallyai1982Parameters(*values)

calc_ptf_varallyai1982_chernozem_b

calc_ptf_varallyai1982_chernozem_b(*, bulk_density: float, fine_fraction: float) -> Varallyai1982Parameters[floating]
calc_ptf_varallyai1982_chernozem_b(*, bulk_density: ArrayLike, fine_fraction: ArrayLike, out: Varallyai1982Parameters[NDArray[floating]] | None = None) -> Varallyai1982Parameters[NDArray[floating]]

Estimate equation (9) water-retention parameters for chernozem B horizons.

PARAMETER DESCRIPTION
bulk_density

Undisturbed-soil bulk density. (g/cm^3)

TYPE: float | ArrayLike

fine_fraction

Fine-particle mass fraction reported as particles smaller than 0.002 mm. (fraction)

TYPE: float | ArrayLike

out

Optional output arrays for in-place calculation.

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

RETURNS DESCRIPTION
Varallyai1982Parameters

Results grouped by result attributes.

TYPE: Varallyai1982Parameters[floating] | Varallyai1982Parameters[NDArray[floating]]

Territory

Hungary, mainly the Hungarian Plain

Models

\(h(\theta)\): theta = theta_0 / (1 + (psi / psi_*)^m)

Notes

Prediction target: Parameters of the equation (9) water-retention model for chernozem B horizons. Equation (16) applies to chernozem B horizons. The source reports 95% relative errors of 11% for theta_0, 34% for m, and 18% for pF_*.

Warning

Use is described as approximate by the source. The source does not report exact calibration ranges; avoid extrapolation beyond comparable Hungarian chernozem B horizons.

Source code in ptfkit/varallyai1982.py
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
def calc_ptf_varallyai1982_chernozem_b(
    *,
    bulk_density: float | ArrayLike,
    fine_fraction: float | ArrayLike,
    out: Varallyai1982Parameters[NDArray[floating]] | None = None,
) -> Varallyai1982Parameters[floating] | Varallyai1982Parameters[NDArray[floating]]:
    r"""Estimate equation (9) water-retention parameters for chernozem B horizons.

    Arguments:
        bulk_density: Undisturbed-soil bulk density. (g/cm^3)
        fine_fraction: Fine-particle mass fraction reported as particles smaller than 0.002 mm.
            (fraction)
        out: Optional output arrays for in-place calculation.

    Returns:
        Varallyai1982Parameters: Results grouped by result attributes.

    Territory:
        Hungary, mainly the Hungarian Plain

    Models:
        $h(\theta)$: theta = theta_0 / (1 + (psi / psi_*)^m)

    Notes:
        Prediction target: Parameters of the equation (9) water-retention model for chernozem B
            horizons.
        Equation (16) applies to chernozem B horizons.
        The source reports 95% relative errors of 11% for theta_0, 34% for m, and 18% for pF_*.

    Warning:
        Use is described as approximate by the source.
        The source does not report exact calibration ranges; avoid extrapolation beyond comparable
            Hungarian chernozem B horizons.

    """
    values = _call(
        _calc_ptf_varallyai1982_chernozem_b,
        bulk_density,
        fine_fraction,
        out=out,
    )

    return Varallyai1982Parameters(*values)

calc_ptf_varallyai1982_chernozem_c

calc_ptf_varallyai1982_chernozem_c(*, bulk_density: float, fine_fraction: float) -> Varallyai1982Parameters[floating]
calc_ptf_varallyai1982_chernozem_c(*, bulk_density: ArrayLike, fine_fraction: ArrayLike, out: Varallyai1982Parameters[NDArray[floating]] | None = None) -> Varallyai1982Parameters[NDArray[floating]]

Estimate equation (9) water-retention parameters for chernozem C horizons.

PARAMETER DESCRIPTION
bulk_density

Undisturbed-soil bulk density. (g/cm^3)

TYPE: float | ArrayLike

fine_fraction

Fine-particle mass fraction reported as particles smaller than 0.002 mm. (fraction)

TYPE: float | ArrayLike

out

Optional output arrays for in-place calculation.

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

RETURNS DESCRIPTION
Varallyai1982Parameters

Results grouped by result attributes.

TYPE: Varallyai1982Parameters[floating] | Varallyai1982Parameters[NDArray[floating]]

Territory

Hungary, mainly the Hungarian Plain

Models

\(h(\theta)\): theta = theta_0 / (1 + (psi / psi_*)^m)

Notes

Prediction target: Parameters of the equation (9) water-retention model for chernozem C horizons. Equation (17) applies to chernozem C horizons. The source reports 95% relative errors of 7% for theta_0, 22% for m, and 11% for pF_*.

Warning

Use is described as approximate by the source. The source does not report exact calibration ranges; avoid extrapolation beyond comparable Hungarian chernozem C horizons.

Source code in ptfkit/varallyai1982.py
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
def calc_ptf_varallyai1982_chernozem_c(
    *,
    bulk_density: float | ArrayLike,
    fine_fraction: float | ArrayLike,
    out: Varallyai1982Parameters[NDArray[floating]] | None = None,
) -> Varallyai1982Parameters[floating] | Varallyai1982Parameters[NDArray[floating]]:
    r"""Estimate equation (9) water-retention parameters for chernozem C horizons.

    Arguments:
        bulk_density: Undisturbed-soil bulk density. (g/cm^3)
        fine_fraction: Fine-particle mass fraction reported as particles smaller than 0.002 mm.
            (fraction)
        out: Optional output arrays for in-place calculation.

    Returns:
        Varallyai1982Parameters: Results grouped by result attributes.

    Territory:
        Hungary, mainly the Hungarian Plain

    Models:
        $h(\theta)$: theta = theta_0 / (1 + (psi / psi_*)^m)

    Notes:
        Prediction target: Parameters of the equation (9) water-retention model for chernozem C
            horizons.
        Equation (17) applies to chernozem C horizons.
        The source reports 95% relative errors of 7% for theta_0, 22% for m, and 11% for pF_*.

    Warning:
        Use is described as approximate by the source.
        The source does not report exact calibration ranges; avoid extrapolation beyond comparable
            Hungarian chernozem C horizons.

    """
    values = _call(
        _calc_ptf_varallyai1982_chernozem_c,
        bulk_density,
        fine_fraction,
        out=out,
    )

    return Varallyai1982Parameters(*values)

calc_ptf_varallyai1982_meadow

calc_ptf_varallyai1982_meadow(*, bulk_density: float, fine_sand_fraction: float, fine_fraction: float) -> Varallyai1982Parameters[floating]
calc_ptf_varallyai1982_meadow(*, bulk_density: ArrayLike, fine_sand_fraction: ArrayLike, fine_fraction: ArrayLike, out: Varallyai1982Parameters[NDArray[floating]] | None = None) -> Varallyai1982Parameters[NDArray[floating]]

Estimate equation (9) water-retention parameters for meadow-series soils.

PARAMETER DESCRIPTION
bulk_density

Undisturbed-soil bulk density. (g/cm^3)

TYPE: float | ArrayLike

fine_sand_fraction

Mass fraction in the 0.25-0.05 mm particle-size class. (fraction)

TYPE: float | ArrayLike

fine_fraction

Fine-particle mass fraction reported as particles smaller than 0.002 mm. (fraction)

TYPE: float | ArrayLike

out

Optional output arrays for in-place calculation.

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

RETURNS DESCRIPTION
Varallyai1982Parameters

Results grouped by result attributes.

TYPE: Varallyai1982Parameters[floating] | Varallyai1982Parameters[NDArray[floating]]

Territory

Hungary, mainly the Hungarian Plain

Models

\(h(\theta)\): theta = theta_0 / (1 + (psi / psi_*)^m)

Notes

Prediction target: Parameters of the equation (9) water-retention model. Equation (14) was fitted to 68 meadow-series soil samples. S and C are fractions of one, while bulk density is in g/cm^3. The source reports 95% relative errors of 14% for theta_0, 34% for m, and 25% for pF_*.

Warning

Use is described as approximate by the source. The source does not report exact calibration ranges; avoid extrapolation beyond comparable Hungarian meadow-series soils.

Source code in ptfkit/varallyai1982.py
 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
124
125
126
127
128
129
def calc_ptf_varallyai1982_meadow(
    *,
    bulk_density: float | ArrayLike,
    fine_sand_fraction: float | ArrayLike,
    fine_fraction: float | ArrayLike,
    out: Varallyai1982Parameters[NDArray[floating]] | None = None,
) -> Varallyai1982Parameters[floating] | Varallyai1982Parameters[NDArray[floating]]:
    r"""Estimate equation (9) water-retention parameters for meadow-series soils.

    Arguments:
        bulk_density: Undisturbed-soil bulk density. (g/cm^3)
        fine_sand_fraction: Mass fraction in the 0.25-0.05 mm particle-size class. (fraction)
        fine_fraction: Fine-particle mass fraction reported as particles smaller than 0.002 mm.
            (fraction)
        out: Optional output arrays for in-place calculation.

    Returns:
        Varallyai1982Parameters: Results grouped by result attributes.

    Territory:
        Hungary, mainly the Hungarian Plain

    Models:
        $h(\theta)$: theta = theta_0 / (1 + (psi / psi_*)^m)

    Notes:
        Prediction target: Parameters of the equation (9) water-retention model.
        Equation (14) was fitted to 68 meadow-series soil samples.
        S and C are fractions of one, while bulk density is in g/cm^3.
        The source reports 95% relative errors of 14% for theta_0, 34% for m, and 25% for pF_*.

    Warning:
        Use is described as approximate by the source.
        The source does not report exact calibration ranges; avoid extrapolation beyond comparable
            Hungarian meadow-series soils.

    """
    values = _call(
        _calc_ptf_varallyai1982_meadow,
        bulk_density,
        fine_sand_fraction,
        fine_fraction,
        out=out,
    )

    return Varallyai1982Parameters(*values)