ptfkit.vereecken1989

def calc_ptf_vereecken1989(
    *,
    sand: float | ArrayLike,
    clay: float | ArrayLike,
    carbon: float | ArrayLike,
    bulk_density: float | ArrayLike,
    out: Vereecken1989PTFResult[NDArray[floating]] | None = None,
) -> Vereecken1989PTFResult[floating] | Vereecken1989PTFResult[NDArray[floating]]:
    r"""Calculate the pedotransfer function.

    Estimate four parameters of the reduced van Genuchten moisture-retention model from broad
    texture fractions, bulk density, and carbon content.

    Arguments:
        sand: Sand content in the 50-2000 micrometre particle-size fraction. (%)
        clay: Clay content in the less-than-2-micrometre particle-size fraction. (%)
        carbon: Carbon content determined by the Walkley-Black method. (%)
        bulk_density: Dry bulk density measured after drying undisturbed 100-cm^3 cores for 24 hours
            at 105 degrees Celsius. (g/cm^3)
        out: Optional output arrays for in-place calculation.

    Returns:
        Vereecken1989PTFResult: Results grouped by result attributes.

    Models:
        $h(\theta)$: van Genuchten moisture-retention model with m = 1

    Notes:
        Prediction target: Residual and saturated volumetric water content and the alpha and n shape
            parameters of the van Genuchten model with m equal to 1.
        Table 7 reports regressions for theta_s, theta_r, log(alpha), and log(n) using broad
            particle-size fractions, carbon content, and bulk density.
        The paper accepts fitted n values below 1 because constraining n above 1 gave poorer
            descriptions for many of the measured curves.

    Warning:
        The bulk-density maximum is reviewed as 1.730 g/cm^3 because the supplied transcription's
            1.230 value is inconsistent with the reported mean.

    """
    values = _call(
        _calc_ptf_vereecken1989,
        sand,
        clay,
        carbon,
        bulk_density,
        out=out,
    )

    return Vereecken1989PTFResult(*values)

def calc_ptf_vereecken1989_detailed(
    *,
    particle_2000_1000: float | ArrayLike,
    particle_1000_500: float | ArrayLike,
    particle_500_200: float | ArrayLike,
    particle_200_100: float | ArrayLike,
    particle_100_50: float | ArrayLike,
    particle_50_20: float | ArrayLike,
    particle_20_10: float | ArrayLike,
    particle_10_2: float | ArrayLike,
    clay: float | ArrayLike,
    geometric_mean_particle_size: float | ArrayLike,
    geometric_standard_deviation: float | ArrayLike,
    carbon: float | ArrayLike,
    bulk_density: float | ArrayLike,
    out: Vereecken1989DetailedPTFResult[NDArray[floating]] | None = None,
) -> Vereecken1989DetailedPTFResult[floating] | Vereecken1989DetailedPTFResult[NDArray[floating]]:
    r"""Calculate the pedotransfer function.

    Estimate van Genuchten parameters from nine particle-size fractions and particle-size
    distribution descriptors.

    Arguments:
        particle_2000_1000: Particle content from 2000 to 1000 micrometres. (%)
        particle_1000_500: Particle content from 1000 to 500 micrometres. (%)
        particle_500_200: Particle content from 500 to 200 micrometres. (%)
        particle_200_100: Particle content from 200 to 100 micrometres. (%)
        particle_100_50: Particle content from 100 to 50 micrometres. (%)
        particle_50_20: Particle content from 50 to 20 micrometres. (%)
        particle_20_10: Particle content from 20 to 10 micrometres. (%)
        particle_10_2: Particle content from 10 to 2 micrometres. (%)
        clay: Particle content below 2 micrometres. (%)
        geometric_mean_particle_size: Geometrical mean particle size calculated using the method
            cited by the paper. (cm)
        geometric_standard_deviation: Geometrical standard deviation of particle size calculated
            using the method cited by the paper. (dimensionless)
        carbon: Carbon content determined by the Walkley-Black method. (%)
        bulk_density: Dry bulk density measured after drying undisturbed 100-cm^3 cores for 24 hours
            at 105 degrees Celsius. (g/cm^3)
        out: Optional output arrays for in-place calculation.

    Returns:
        Vereecken1989DetailedPTFResult: Results grouped by result attributes.

    Models:
        $h(\theta)$: van Genuchten moisture-retention model with m = 1

    Notes:
        Prediction target: Residual and saturated volumetric water content and the alpha and n shape
            parameters of the van Genuchten model with m equal to 1.
        Table 8 reports transformed regressions in original particle-size variables for theta_r,
            log(alpha), and log(n).
        Detailed particle-size information did not substantially improve theta_s; this function
            therefore retains the broad-texture theta_s regression.

    Warning:
        The detailed log(alpha) formula restores the carbon and bulk-density terms shown in Table 7
            but omitted from the supplied Table 8 transcription.
        The bulk-density maximum is reviewed as 1.730 g/cm^3 because the supplied transcription's
            1.230 value is inconsistent with the reported mean.

    """
    values = _call(
        _calc_ptf_vereecken1989_detailed,
        particle_2000_1000,
        particle_1000_500,
        particle_500_200,
        particle_200_100,
        particle_100_50,
        particle_50_20,
        particle_20_10,
        particle_10_2,
        clay,
        geometric_mean_particle_size,
        geometric_standard_deviation,
        carbon,
        bulk_density,
        out=out,
    )

    return Vereecken1989DetailedPTFResult(*values)