dycove.sim.vegetation_data.VegCohort

class dycove.sim.vegetation_data.VegCohort(name: str, fraction: ndarray, density: float, diameter: float, height: float, rootlength: float, lifestage: int, lifestage_year: int, potential_mort_flood: ndarray | None = None, potential_mort_desic: ndarray | None = None, potential_mort_uproot: ndarray | None = None, potential_mort_burial: ndarray | None = None, potential_mort_scour: ndarray | None = None, applied_mort_flood: ndarray | None = None, applied_mort_desic: ndarray | None = None, applied_mort_uproot: ndarray | None = None, applied_mort_burial: ndarray | None = None, applied_mort_scour: ndarray | None = None, applied_mort_total: ndarray | None = None)[source]

Represents a vegetation cohort (single colonization event) tracked through time.

A cohort stores plant geometry, density, life-stage progression, and mortality contributions across the model domain.

name

Name of species.

Type:: str

fraction

Vegetation fractional cover per cell (0–1).

Type:: numpy.ndarray

density

Stem density (stems/m²).

Type:: float

diameter, height, rootlength

Plant geometry (m).

Type:: float

lifestage

Current life-stage index (0 .. nls-1).

Type:: int

lifestage_year

Years elapsed in the current life stage.

Type:: int

potential_mort_*

Mortality potential based solely on environmental stress. Represents vulnerability prior to application to vegetated fraction.

Type:: numpy.ndarray

applied_mort_*

Mortality applied to vegetation fraction. Represents actual loss per cell.

Type:: numpy.ndarray

__init__(name: str, fraction: ndarray, density: float, diameter: float, height: float, rootlength: float, lifestage: int, lifestage_year: int, potential_mort_flood: ndarray | None = None, potential_mort_desic: ndarray | None = None, potential_mort_uproot: ndarray | None = None, potential_mort_burial: ndarray | None = None, potential_mort_scour: ndarray | None = None, applied_mort_flood: ndarray | None = None, applied_mort_desic: ndarray | None = None, applied_mort_uproot: ndarray | None = None, applied_mort_burial: ndarray | None = None, applied_mort_scour: ndarray | None = None, applied_mort_total: ndarray | None = None) → None

Methods

__init__(name, fraction, density, diameter, ...)

Attributes

`applied_mort_burial`
`applied_mort_desic`
`applied_mort_flood`
`applied_mort_scour`
`applied_mort_total`
`applied_mort_uproot`
`potential_mort_burial`
`potential_mort_desic`
`potential_mort_flood`
`potential_mort_scour`
`potential_mort_uproot`
`name`
`fraction`
`density`
`diameter`
`height`
`rootlength`
`lifestage`
`lifestage_year`