Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions codegen/src/corpus_report.rs
Original file line number Diff line number Diff line change
Expand Up @@ -852,8 +852,8 @@ functions:
crate::compile::functions(entries.clone()).expect("repository specifications compile");

let report = Report::from_entries(&entries);
assert_eq!(report.verification.cases_total, 136);
assert_eq!(report.verification.by_kind["calculated"], 125);
assert_eq!(report.verification.cases_total, 138);
assert_eq!(report.verification.by_kind["calculated"], 127);
assert_eq!(report.verification.by_kind["published"], 11);
assert_eq!(report.sources.specification_files, entries.len());
assert_eq!(
Expand Down
1 change: 1 addition & 0 deletions docs/src/ptf-catalog/sources/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ Each page describes the source, scope, inputs, outputs, status, and limitations
| [Jabro (1992), United States.](./jabro1992.md) | USA | 1 |
| [Li et al. (2007), Fengqiu County, North China Plain, China.](./li2007.md) | Fengqiu County soils in the North China Plain, China | 1 |
| [Mayr and Jarvis (1999) modified Brooks-Corey water-retention parameter PTFs.](./mayr1999.md) | England and Wales | 1 |
| [Gravimetric field capacity and permanent wilting point for South African soils.](./myeni2021.md) | South Africa. | 2 |
| [Oosterveld and Chang (1980), soil-moisture retention from texture and depth.](./oosterveld1980.md) | Southern Alberta, Canada | 5 |
| [Pidgeon (1972), available-water regressions for ferrallitic soils in Uganda.](./pidgeon1972.md) | Non-alluvial ferrallitic soils in Uganda, predominantly kaolinitic and possibly illitic | 17 |
| [Puckett et al. (1985), Alabama Lower Coastal Plain Ultisols.](./puckett1985.md) | Lower Coastal Plain of Alabama, USA | 1 |
Expand Down
98 changes: 98 additions & 0 deletions docs/src/ptf-catalog/sources/myeni2021.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,98 @@
---
# @generated by ptfkit-codegen; DO NOT EDIT.

title: PTF source myeni2021
nav-title: myeni2021
---

# Gravimetric field capacity and permanent wilting point for South African soils.

## Source

Myeni, L., Mdlambuzi, T., Paterson, D. G., De Nysschen, G., & Moeletsi, M. E. (2021). Development and evaluation of pedotransfer functions to estimate soil moisture content at field capacity and permanent wilting point for South African soils. Water, 13(19), 2639. https://doi.org/10.3390/w13192639

[DOI: 10.3390/w13192639](https://doi.org/10.3390/w13192639)

## Scope

**Territory:** South Africa.

**Dataset:** ARC national soil database: 6307 soil horizons retained after quality control, with 3171 development horizons and 3136 validation horizons. Horizons were grouped regardless of depth, soil type, textural class, geographic location and climate, then randomly split per granulometric range (Sections 2.1-2.2; Tables 2-3).

## Functions

### `calc_ptf_myeni2021_fc`

Estimate gravimetric field capacity from clay, silt and soil organic carbon.

**Status:** `implemented`

**Prediction target:** Gravimetric soil moisture content at field capacity (-33 kPa).

#### Inputs

| Name | Type | Unit | Domain | Description |
| --- | --- | --- | --- | --- |
| `clay` | `number` | % | Development dataset range: 1.00-83.00% (Table 3). | Clay content by weight, particle diameter below 0.002 mm. |
| `silt` | `number` | % | Development dataset range: 1.00-64.00% (Table 3). | Silt content by weight, particle diameter 0.002-0.05 mm. |
| `soc` | `number` | % | Development dataset range: 0.01-9.36% (Table 3). | Soil organic carbon content by weight, measured by the Walkley-Black method. |

#### Outputs

| Name | Unit | Domain | Description |
| --- | --- | --- | --- |
| `fc` | kg kg⁻¹ | Observed development dataset range: 0.01-0.50 kg/kg (Table 3). | Gravimetric soil moisture content at field capacity (-33 kPa). |

!!! note

Table 5 gives the stepwise multiple linear regression for FC.

!!! note

Inputs are weight percentages; output is gravimetric water content.

!!! warning

Apply with caution outside South Africa, even under similar soil and climatic conditions.

!!! warning

Disturbed samples were used; soil structure is not explicitly represented.

### `calc_ptf_myeni2021_pwp`

Estimate gravimetric permanent wilting point from clay, silt and soil organic carbon.

**Status:** `implemented`

**Prediction target:** Gravimetric soil moisture content at permanent wilting point (-1500 kPa).

#### Inputs

| Name | Type | Unit | Domain | Description |
| --- | --- | --- | --- | --- |
| `clay` | `number` | % | Development dataset range: 1.00-83.00% (Table 3). | Clay content by weight, particle diameter below 0.002 mm. |
| `silt` | `number` | % | Development dataset range: 1.00-64.00% (Table 3). | Silt content by weight, particle diameter 0.002-0.05 mm. |
| `soc` | `number` | % | Development dataset range: 0.01-9.36% (Table 3). | Soil organic carbon content by weight, measured by the Walkley-Black method. |

#### Outputs

| Name | Unit | Domain | Description |
| --- | --- | --- | --- |
| `pwp` | kg kg⁻¹ | Observed development dataset range: 0.00-0.31 kg/kg (Table 3). | Gravimetric soil moisture content at permanent wilting point (-1500 kPa). |

!!! note

Table 5 gives the stepwise multiple linear regression for PWP without an additive constant.

!!! note

Inputs are weight percentages; output is gravimetric water content.

!!! warning

Apply with caution outside South Africa, even under similar soil and climatic conditions.

!!! warning

Disturbed samples were used; soil structure is not explicitly represented.
2 changes: 2 additions & 0 deletions docs/src/reference/c/functions.md
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,8 @@ title: C function index
| [`calc_ptf_jabro1992`](headers/jabro1992.md#function-calc_ptf_jabro1992) | Estimate saturated hydraulic conductivity from silt, clay, and bulk density. | [`<ptfkit/jabro1992.h>`](headers/jabro1992.md) |
| [`calc_ptf_li2007`](headers/li2007.md#function-calc_ptf_li2007) | Estimate van Genuchten parameters and saturated hydraulic conductivity for Fengqiu County soils. | [`<ptfkit/li2007.h>`](headers/li2007.md) |
| [`calc_ptf_mayr1999`](headers/mayr1999.md#function-calc_ptf_mayr1999) | Estimate modified Brooks-Corey a, b, and saturated water content from texture, bulk density, and organic carbon. | [`<ptfkit/mayr1999.h>`](headers/mayr1999.md) |
| [`calc_ptf_myeni2021_fc`](headers/myeni2021.md#function-calc_ptf_myeni2021_fc) | Estimate gravimetric field capacity from clay, silt and soil organic carbon. | [`<ptfkit/myeni2021.h>`](headers/myeni2021.md) |
| [`calc_ptf_myeni2021_pwp`](headers/myeni2021.md#function-calc_ptf_myeni2021_pwp) | Estimate gravimetric permanent wilting point from clay, silt and soil organic carbon. | [`<ptfkit/myeni2021.h>`](headers/myeni2021.md) |
| [`calc_ptf_oosterveld1980_available_water`](headers/oosterveld1980.md#function-calc_ptf_oosterveld1980_available_water) | Estimate available gravimetric soil moisture between field capacity and wilting point. | [`<ptfkit/oosterveld1980.h>`](headers/oosterveld1980.md) |
| [`calc_ptf_oosterveld1980_field_capacity`](headers/oosterveld1980.md#function-calc_ptf_oosterveld1980_field_capacity) | Estimate gravimetric soil-moisture content at field capacity. | [`<ptfkit/oosterveld1980.h>`](headers/oosterveld1980.md) |
| [`calc_ptf_oosterveld1980_field_capacity_tension`](headers/oosterveld1980.md#function-calc_ptf_oosterveld1980_field_capacity_tension) | Estimate field-capacity tension from clay content. | [`<ptfkit/oosterveld1980.h>`](headers/oosterveld1980.md) |
Expand Down
101 changes: 101 additions & 0 deletions docs/src/reference/c/headers/myeni2021.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,101 @@
---
title: "myeni2021.h"
---

<!-- @generated by ptfkit-codegen; DO NOT EDIT. -->

# `<ptfkit/myeni2021.h>`

```c
#include <ptfkit/myeni2021.h>
```

Gravimetric field capacity and permanent wilting point for South African soils.

## Source

Myeni, L., Mdlambuzi, T., Paterson, D. G., De Nysschen, G., & Moeletsi, M. E. (2021). Development and evaluation of pedotransfer functions to estimate soil moisture content at field capacity and permanent wilting point for South African soils. Water, 13(19), 2639. https://doi.org/10.3390/w13192639

[DOI: 10.3390/w13192639](https://doi.org/10.3390/w13192639)

## Scope

**Territory:** South Africa.

**Dataset:** ARC national soil database: 6307 soil horizons retained after quality control, with 3171 development horizons and 3136 validation horizons. Horizons were grouped regardless of depth, soil type, textural class, geographic location and climate, then randomly split per granulometric range (Sections 2.1-2.2; Tables 2-3).

[PTF catalog page](../../../ptf-catalog/sources/myeni2021.md)

## Functions

### `calc_ptf_myeni2021_fc` {#function-calc_ptf_myeni2021_fc}

Estimate gravimetric field capacity from clay, silt and soil organic carbon.

```c
static inline double calc_ptf_myeni2021_fc(double clay, double silt, double soc);
```

#### Parameters

| Name | Direction | Description |
| --- | --- | --- |
| `clay` | in | Clay content by weight, particle diameter below 0.002 mm. (%) |
| `silt` | in | Silt content by weight, particle diameter 0.002-0.05 mm. (%) |
| `soc` | in | Soil organic carbon content by weight, measured by the Walkley-Black method. (%) |

#### Returns

Gravimetric soil moisture content at field capacity (-33 kPa). (kg kg⁻¹)

!!! note

Table 5 gives the stepwise multiple linear regression for FC.

!!! note

Inputs are weight percentages; output is gravimetric water content.

!!! warning

Apply with caution outside South Africa, even under similar soil and climatic conditions.

!!! warning

Disturbed samples were used; soil structure is not explicitly represented.

### `calc_ptf_myeni2021_pwp` {#function-calc_ptf_myeni2021_pwp}

Estimate gravimetric permanent wilting point from clay, silt and soil organic carbon.

```c
static inline double calc_ptf_myeni2021_pwp(double clay, double silt, double soc);
```

#### Parameters

| Name | Direction | Description |
| --- | --- | --- |
| `clay` | in | Clay content by weight, particle diameter below 0.002 mm. (%) |
| `silt` | in | Silt content by weight, particle diameter 0.002-0.05 mm. (%) |
| `soc` | in | Soil organic carbon content by weight, measured by the Walkley-Black method. (%) |

#### Returns

Gravimetric soil moisture content at permanent wilting point (-1500 kPa). (kg kg⁻¹)

!!! note

Table 5 gives the stepwise multiple linear regression for PWP without an additive constant.

!!! note

Inputs are weight percentages; output is gravimetric water content.

!!! warning

Apply with caution outside South Africa, even under similar soil and climatic conditions.

!!! warning

Disturbed samples were used; soil structure is not explicitly represented.
1 change: 1 addition & 0 deletions docs/src/reference/c/headers/ptfkit.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ This umbrella header aggregates every public ptfkit source header. Include an in
- [`<ptfkit/jabro1992.h>`](jabro1992.md) — Jabro (1992), United States.
- [`<ptfkit/li2007.h>`](li2007.md) — Li et al. (2007), Fengqiu County, North China Plain, China.
- [`<ptfkit/mayr1999.h>`](mayr1999.md) — Mayr and Jarvis (1999) modified Brooks-Corey water-retention parameter PTFs.
- [`<ptfkit/myeni2021.h>`](myeni2021.md) — Gravimetric field capacity and permanent wilting point for South African soils.
- [`<ptfkit/oosterveld1980.h>`](oosterveld1980.md) — Oosterveld and Chang (1980), soil-moisture retention from texture and depth.
- [`<ptfkit/pidgeon1972.h>`](pidgeon1972.md) — Pidgeon (1972), available-water regressions for ferrallitic soils in Uganda.
- [`<ptfkit/puckett1985.h>`](puckett1985.md) — Puckett et al. (1985), Alabama Lower Coastal Plain Ultisols.
Expand Down
1 change: 1 addition & 0 deletions docs/src/reference/c/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ ptfkit's C API is organized around installed headers.
- [`<ptfkit/jabro1992.h>`](headers/jabro1992.md) — Jabro (1992), United States.
- [`<ptfkit/li2007.h>`](headers/li2007.md) — Li et al. (2007), Fengqiu County, North China Plain, China.
- [`<ptfkit/mayr1999.h>`](headers/mayr1999.md) — Mayr and Jarvis (1999) modified Brooks-Corey water-retention parameter PTFs.
- [`<ptfkit/myeni2021.h>`](headers/myeni2021.md) — Gravimetric field capacity and permanent wilting point for South African soils.
- [`<ptfkit/oosterveld1980.h>`](headers/oosterveld1980.md) — Oosterveld and Chang (1980), soil-moisture retention from texture and depth.
- [`<ptfkit/pidgeon1972.h>`](headers/pidgeon1972.md) — Pidgeon (1972), available-water regressions for ferrallitic soils in Uganda.
- [`<ptfkit/puckett1985.h>`](headers/puckett1985.md) — Puckett et al. (1985), Alabama Lower Coastal Plain Ultisols.
Expand Down
2 changes: 2 additions & 0 deletions docs/src/reference/cpp/functions.md
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,8 @@ title: C++ function index
| [`ptfkit::jabro1992::calc_ptf_jabro1992`](modules/jabro1992.md#function-calc_ptf_jabro1992) | Estimate saturated hydraulic conductivity from silt, clay, and bulk density. | [`ptfkit.jabro1992`](modules/jabro1992.md) |
| [`ptfkit::li2007::calc_ptf_li2007`](modules/li2007.md#function-calc_ptf_li2007) | Estimate van Genuchten parameters and saturated hydraulic conductivity for Fengqiu County soils. | [`ptfkit.li2007`](modules/li2007.md) |
| [`ptfkit::mayr1999::calc_ptf_mayr1999`](modules/mayr1999.md#function-calc_ptf_mayr1999) | Estimate modified Brooks-Corey a, b, and saturated water content from texture, bulk density, and organic carbon. | [`ptfkit.mayr1999`](modules/mayr1999.md) |
| [`ptfkit::myeni2021::calc_ptf_myeni2021_fc`](modules/myeni2021.md#function-calc_ptf_myeni2021_fc) | Estimate gravimetric field capacity from clay, silt and soil organic carbon. | [`ptfkit.myeni2021`](modules/myeni2021.md) |
| [`ptfkit::myeni2021::calc_ptf_myeni2021_pwp`](modules/myeni2021.md#function-calc_ptf_myeni2021_pwp) | Estimate gravimetric permanent wilting point from clay, silt and soil organic carbon. | [`ptfkit.myeni2021`](modules/myeni2021.md) |
| [`ptfkit::oosterveld1980::calc_ptf_oosterveld1980_available_water`](modules/oosterveld1980.md#function-calc_ptf_oosterveld1980_available_water) | Estimate available gravimetric soil moisture between field capacity and wilting point. | [`ptfkit.oosterveld1980`](modules/oosterveld1980.md) |
| [`ptfkit::oosterveld1980::calc_ptf_oosterveld1980_field_capacity`](modules/oosterveld1980.md#function-calc_ptf_oosterveld1980_field_capacity) | Estimate gravimetric soil-moisture content at field capacity. | [`ptfkit.oosterveld1980`](modules/oosterveld1980.md) |
| [`ptfkit::oosterveld1980::calc_ptf_oosterveld1980_field_capacity_tension`](modules/oosterveld1980.md#function-calc_ptf_oosterveld1980_field_capacity_tension) | Estimate field-capacity tension from clay content. | [`ptfkit.oosterveld1980`](modules/oosterveld1980.md) |
Expand Down
1 change: 1 addition & 0 deletions docs/src/reference/cpp/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ ptfkit's C++ API is organized around C++23 modules.
- [`ptfkit.jabro1992`](modules/jabro1992.md) — Jabro (1992), United States.
- [`ptfkit.li2007`](modules/li2007.md) — Li et al. (2007), Fengqiu County, North China Plain, China.
- [`ptfkit.mayr1999`](modules/mayr1999.md) — Mayr and Jarvis (1999) modified Brooks-Corey water-retention parameter PTFs.
- [`ptfkit.myeni2021`](modules/myeni2021.md) — Gravimetric field capacity and permanent wilting point for South African soils.
- [`ptfkit.oosterveld1980`](modules/oosterveld1980.md) — Oosterveld and Chang (1980), soil-moisture retention from texture and depth.
- [`ptfkit.pidgeon1972`](modules/pidgeon1972.md) — Pidgeon (1972), available-water regressions for ferrallitic soils in Uganda.
- [`ptfkit.puckett1985`](modules/puckett1985.md) — Puckett et al. (1985), Alabama Lower Coastal Plain Ultisols.
Expand Down
106 changes: 106 additions & 0 deletions docs/src/reference/cpp/modules/myeni2021.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,106 @@
---
# @generated by ptfkit-codegen; DO NOT EDIT.

title: C++ module ptfkit.myeni2021
nav-title: ptfkit.myeni2021
---

# `ptfkit.myeni2021`

```cpp
import ptfkit.myeni2021;
```

**Exported namespace:** `ptfkit::myeni2021`

Gravimetric field capacity and permanent wilting point for South African soils.

## Source

Myeni, L., Mdlambuzi, T., Paterson, D. G., De Nysschen, G., & Moeletsi, M. E. (2021). Development and evaluation of pedotransfer functions to estimate soil moisture content at field capacity and permanent wilting point for South African soils. Water, 13(19), 2639. https://doi.org/10.3390/w13192639

[DOI: 10.3390/w13192639](https://doi.org/10.3390/w13192639)

## Scope

**Territory:** South Africa.

**Dataset:** ARC national soil database: 6307 soil horizons retained after quality control, with 3171 development horizons and 3136 validation horizons. Horizons were grouped regardless of depth, soil type, textural class, geographic location and climate, then randomly split per granulometric range (Sections 2.1-2.2; Tables 2-3).

[PTF catalog page](../../../ptf-catalog/sources/myeni2021.md)

## Functions

### `calc_ptf_myeni2021_fc` {#function-calc_ptf_myeni2021_fc}

Estimate gravimetric field capacity from clay, silt and soil organic carbon.

```cpp
[[nodiscard]]
inline double calc_ptf_myeni2021_fc(double clay, double silt, double soc)
```

#### Parameters

| Name | Description |
| --- | --- |
| `clay` | Clay content by weight, particle diameter below 0.002 mm. (%) |
| `silt` | Silt content by weight, particle diameter 0.002-0.05 mm. (%) |
| `soc` | Soil organic carbon content by weight, measured by the Walkley-Black method. (%) |

#### Returns

Gravimetric soil moisture content at field capacity (-33 kPa). (kg kg⁻¹)

!!! note

Table 5 gives the stepwise multiple linear regression for FC.

!!! note

Inputs are weight percentages; output is gravimetric water content.

!!! warning

Apply with caution outside South Africa, even under similar soil and climatic conditions.

!!! warning

Disturbed samples were used; soil structure is not explicitly represented.

### `calc_ptf_myeni2021_pwp` {#function-calc_ptf_myeni2021_pwp}

Estimate gravimetric permanent wilting point from clay, silt and soil organic carbon.

```cpp
[[nodiscard]]
inline double calc_ptf_myeni2021_pwp(double clay, double silt, double soc)
```

#### Parameters

| Name | Description |
| --- | --- |
| `clay` | Clay content by weight, particle diameter below 0.002 mm. (%) |
| `silt` | Silt content by weight, particle diameter 0.002-0.05 mm. (%) |
| `soc` | Soil organic carbon content by weight, measured by the Walkley-Black method. (%) |

#### Returns

Gravimetric soil moisture content at permanent wilting point (-1500 kPa). (kg kg⁻¹)

!!! note

Table 5 gives the stepwise multiple linear regression for PWP without an additive constant.

!!! note

Inputs are weight percentages; output is gravimetric water content.

!!! warning

Apply with caution outside South Africa, even under similar soil and climatic conditions.

!!! warning

Disturbed samples were used; soil structure is not explicitly represented.
1 change: 1 addition & 0 deletions docs/src/reference/cpp/modules/ptfkit.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ This umbrella module re-exports every public ptfkit source module. Import an ind
- [`ptfkit.jabro1992`](jabro1992.md) — Jabro (1992), United States.
- [`ptfkit.li2007`](li2007.md) — Li et al. (2007), Fengqiu County, North China Plain, China.
- [`ptfkit.mayr1999`](mayr1999.md) — Mayr and Jarvis (1999) modified Brooks-Corey water-retention parameter PTFs.
- [`ptfkit.myeni2021`](myeni2021.md) — Gravimetric field capacity and permanent wilting point for South African soils.
- [`ptfkit.oosterveld1980`](oosterveld1980.md) — Oosterveld and Chang (1980), soil-moisture retention from texture and depth.
- [`ptfkit.pidgeon1972`](pidgeon1972.md) — Pidgeon (1972), available-water regressions for ferrallitic soils in Uganda.
- [`ptfkit.puckett1985`](puckett1985.md) — Puckett et al. (1985), Alabama Lower Coastal Plain Ultisols.
Expand Down
1 change: 1 addition & 0 deletions docs/src/reference/python/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ ptfkit's Python API is organized around public source modules.
- [`ptfkit.jabro1992`](jabro1992.md) — Jabro (1992), United States.
- [`ptfkit.li2007`](li2007.md) — Li et al. (2007), Fengqiu County, North China Plain, China.
- [`ptfkit.mayr1999`](mayr1999.md) — Mayr and Jarvis (1999) modified Brooks-Corey water-retention parameter PTFs.
- [`ptfkit.myeni2021`](myeni2021.md) — Gravimetric field capacity and permanent wilting point for South African soils.
- [`ptfkit.oosterveld1980`](oosterveld1980.md) — Oosterveld and Chang (1980), soil-moisture retention from texture and depth.
- [`ptfkit.pidgeon1972`](pidgeon1972.md) — Pidgeon (1972), available-water regressions for ferrallitic soils in Uganda.
- [`ptfkit.puckett1985`](puckett1985.md) — Puckett et al. (1985), Alabama Lower Coastal Plain Ultisols.
Expand Down
8 changes: 8 additions & 0 deletions docs/src/reference/python/myeni2021.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
# @generated by ptfkit-codegen; DO NOT EDIT.

title: Python module ptfkit.myeni2021
nav-title: ptfkit.myeni2021
---

::: ptfkit.myeni2021
Loading