Skip to content

Commit e5774f3

Browse files
Alomirdlebauer
andauthored
Updates events.c to add doc comments at top
Co-authored-by: David LeBauer <[email protected]>
1 parent 93adfd1 commit e5774f3

File tree

1 file changed

+22
-0
lines changed

1 file changed

+22
-0
lines changed

events.c

+22
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,27 @@
11
//
22
// events.c
3+
/**
4+
* @file events.c
5+
* @brief Handles reading, parsing, and storing agronomic events for SIPNET simulations.
6+
*
7+
* The `events.in` file specifies agronomic events with the following columns:
8+
* | col | parameter | description | units |
9+
* |-----|-------------|--------------------------------------------|------------------|
10+
* | 1 | loc | spatial location index | |
11+
* | 2 | year | year of start of this timestep | |
12+
* | 3 | day | day of start of this timestep | Day of year |
13+
* | 4 | event_type | type of event | (e.g., "irrig") |
14+
* | 5...n| event_param| parameters specific to the event type | (varies) |
15+
*
16+
*
17+
* Event types include:
18+
* - "irrig": Parameters = [amount added (cm/d), type (0=canopy, 1=soil, 2=flood)]
19+
* - "fert": Parameters = [Org-N (g/m²), Org-C (g/ha), Min-N (g/m²), Min-N2 (g/m²)]
20+
* - "till": Parameters = [SOM decomposition modifier, litter decomposition modifier]
21+
* - "plant": Parameters = [emergence lag (days), C (g/m²), N (g/m²)]]
22+
* - "harv": Parameters = [fraction aboveground removed, fraction belowground removed, ...]
23+
* See test examples in `tests/sipnet/test_events/`.
24+
*/
325
//
426

527
#include "events.h"

0 commit comments

Comments
 (0)