Skip to content

Commit

Permalink
feat: update TopmodelParams
Browse files Browse the repository at this point in the history
  • Loading branch information
aaraney committed Sep 4, 2024
1 parent b262a2f commit e971d46
Showing 1 changed file with 33 additions and 3 deletions.
36 changes: 33 additions & 3 deletions python/ngen_conf/src/ngen/config/topmod.py
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,44 @@

from .bmi_formulation import BMIC


class TopmodParams(BaseModel):
"""Class for validating Topmod Parameters
"""Class for validating Topmod Parameters"""
szm: Optional[float]
"""
Exponential scaling parameter for decline of transmissivity with increase in storage deficit
Unit: meters (m)
"""
sr0: Optional[float]
"""
initial root zone storage deficit
Unit: meters (m)
"""
srmax: Optional[float]
szm: Optional[float]
t0: Optional[float]
"""
Maximum capacity of the root zone (Available water capacity to plants)
Unit: meters (m)
"""
td: Optional[float]
"""
Time delay for recharge to the saturated zone per unit of deficit
Unit: hours (h)
"""
t0: Optional[float]
"""
natural log of downslope transmissivity when the soil is just saturated to the surface (corresponds to transmissivities of 0.000335 and 2980.96 m/h)
Unit: meters per hour (m/h)
"""
chv: Optional[float]
"""
Average channel flow velocity
Unit: meters per hour (m/h)
"""
rv: Optional[float]
"""
Internal overland flow routing velocity
Unit: meters per hour (m/h)
"""

class Topmod(BMIC):
"""A BMIC implementation for the Topmod ngen module
Expand Down

0 comments on commit e971d46

Please sign in to comment.