df_state variables

Tip

  1. Need help? Please let us know in the SUEWS Community.

  2. Please report issues with the manual on GitHub Issues (or use Report Issue for This Page for page-specific feedback).

  3. Please cite SUEWS with proper information from our Zenodo page.

orphan:

df_state variables#

Warning

DEVELOPER REFERENCE ONLY: This page documents internal df_state variables used by the SuPy Python API for developers.

For SUEWS users: Please refer to the YAML Configuration Format for user-facing parameter documentation.

These variables are automatically managed by SuPy and should not be modified directly unless you are developing or debugging the model internals.

Note

Data structure of df_state is explained here.

aerodynamicresistancemethod#
Description:

Internal use. Please DO NOT modify

Dimensionality:

0

Dimensionality Remarks:

Scalar

SUEWS-related variables:

None

ah_min#
Description:

Minimum QF values.

Dimensionality:

(2,)

Dimensionality Remarks:

2: {Weekday, Weekend}

SUEWS-related variables:

AHMin_WD, AHMin_WE

ah_slope_cooling#
Description:

Cooling slope of QF calculation.

Dimensionality:

(2,)

Dimensionality Remarks:

2: {Weekday, Weekend}

SUEWS-related variables:

AHSlope_Cooling_WD, AHSlope_Cooling_WE

ah_slope_heating#
Description:

Heating slope of QF calculation.

Dimensionality:

(2,)

Dimensionality Remarks:

2: {Weekday, Weekend}

SUEWS-related variables:

AHSlope_Heating_WD, AHSlope_Heating_WE

ahprof_24hr#
Description:

Hourly profile values used in energy use calculation.

Dimensionality:

(24, 2)

Dimensionality Remarks:

24: hours of a day

2: {Weekday, Weekend}

SUEWS-related variables:

EnergyUseProfWD, EnergyUseProfWE

air_ext_lw#
Description:

Internal use. Please DO NOT modify

Dimensionality:

0

Dimensionality Remarks:

Scalar

SUEWS-related variables:

None

air_ext_sw#
Description:

Internal use. Please DO NOT modify

Dimensionality:

0

Dimensionality Remarks:

Scalar

SUEWS-related variables:

None

air_ssa_lw#
Description:

Internal use. Please DO NOT modify

Dimensionality:

0

Dimensionality Remarks:

Scalar

SUEWS-related variables:

None

air_ssa_sw#
Description:

Internal use. Please DO NOT modify

Dimensionality:

0

Dimensionality Remarks:

Scalar

SUEWS-related variables:

None

alb#
Description:

Effective surface albedo (middle of the day value) for summertime.

Dimensionality:

(7,)

Dimensionality Remarks:

7: { Paved, Bldgs, EveTr, DecTr, Grass, BSoil, Water}

SUEWS-related variables:

AlbedoMax

albdectr_id#
Description:

Albedo of deciduous surface DecTr on day 0 of run

Dimensionality:

0

Dimensionality Remarks:

Scalar

SUEWS-related variables:

albDecTr0

albevetr_id#
Description:

Albedo of evergreen surface EveTr on day 0 of run

Dimensionality:

0

Dimensionality Remarks:

Scalar

SUEWS-related variables:

albEveTr0

albgrass_id#
Description:

Albedo of grass surface Grass on day 0 of run

Dimensionality:

0

Dimensionality Remarks:

Scalar

SUEWS-related variables:

albGrass0

albmax_dectr#
Description:

Effective surface albedo (middle of the day value) for summertime.

Dimensionality:

0

Dimensionality Remarks:

Scalar

SUEWS-related variables:

AlbedoMax

albmax_evetr#
Description:

Effective surface albedo (middle of the day value) for summertime.

Dimensionality:

0

Dimensionality Remarks:

Scalar

SUEWS-related variables:

AlbedoMax

albmax_grass#
Description:

Effective surface albedo (middle of the day value) for summertime.

Dimensionality:

0

Dimensionality Remarks:

Scalar

SUEWS-related variables:

AlbedoMax

albmin_dectr#
Description:

Effective surface albedo (middle of the day value) for wintertime (not including snow).

Dimensionality:

0

Dimensionality Remarks:

Scalar

SUEWS-related variables:

AlbedoMin

albmin_evetr#
Description:

Effective surface albedo (middle of the day value) for wintertime (not including snow).

Dimensionality:

0

Dimensionality Remarks:

Scalar

SUEWS-related variables:

AlbedoMin

albmin_grass#
Description:

Effective surface albedo (middle of the day value) for wintertime (not including snow).

Dimensionality:

0

Dimensionality Remarks:

Scalar

SUEWS-related variables:

AlbedoMin

alpha_bioco2#
Description:

The mean apparent ecosystem quantum. Represents the initial slope of the light-response curve.

Dimensionality:

(3,)

Dimensionality Remarks:

3: { EveTr, DecTr, Grass}

SUEWS-related variables:

alpha

alpha_enh_bioco2#
Description:

Part of the alpha coefficient related to the fraction of vegetation.

Dimensionality:

(3,)

Dimensionality Remarks:

3: { EveTr, DecTr, Grass}

SUEWS-related variables:

alpha_enh

alt#
Description:

Altitude of grids [m].

Dimensionality:

0

Dimensionality Remarks:

Scalar

SUEWS-related variables:

Alt

baset#
Description:

Base Temperature for initiating growing degree days (GDD) for leaf growth. [°C]

Dimensionality:

(3,)

Dimensionality Remarks:

3: { EveTr, DecTr, Grass}

SUEWS-related variables:

BaseT

baset_cooling#
Description:

Critical cooling temperature.

Dimensionality:

(2,)

Dimensionality Remarks:

2: {Weekday, Weekend}

SUEWS-related variables:

TCritic_Cooling_WD, TCritic_Cooling_WE

baset_hc#
Description:

Base temperature for heating degree days [°C]

Dimensionality:

0

Dimensionality Remarks:

Scalar

SUEWS-related variables:

BaseT_HC

baset_heating#
Description:

Critical heating temperature.

Dimensionality:

(2,)

Dimensionality Remarks:

2: {Weekday, Weekend}

SUEWS-related variables:

TCritic_Heating_WD, TCritic_Heating_WE

basete#
Description:

Base temperature for initiating sensesance degree days (SDD) for leaf off. [°C]

Dimensionality:

(3,)

Dimensionality Remarks:

3: { EveTr, DecTr, Grass}

SUEWS-related variables:

BaseTe

basetmethod#
Description:

Determines method for base temperature used in HDD/CDD calculations.

Dimensionality:

0

Dimensionality Remarks:

Scalar

SUEWS-related variables:

BaseTMethod

beta_bioco2#
Description:

The light-saturated gross photosynthesis of the canopy. [umol m-2 s-1 ]

Dimensionality:

(3,)

Dimensionality Remarks:

3: { EveTr, DecTr, Grass}

SUEWS-related variables:

beta

beta_enh_bioco2#
Description:

Part of the beta coefficient related to the fraction of vegetation.

Dimensionality:

(3,)

Dimensionality Remarks:

3: { EveTr, DecTr, Grass}

SUEWS-related variables:

beta_enh

bldgh#
Description:

Mean building height [m]

Dimensionality:

0

Dimensionality Remarks:

Scalar

SUEWS-related variables:

H_Bldgs

capmax_dec#
Description:

Maximum water storage capacity for upper surfaces (i.e. canopy)

Dimensionality:

0

Dimensionality Remarks:

Scalar

SUEWS-related variables:

StorageMax

capmin_dec#
Description:

Minimum water storage capacity for upper surfaces (i.e. canopy).

Dimensionality:

0

Dimensionality Remarks:

Scalar

SUEWS-related variables:

StorageMin

chanohm#
Description:

Bulk transfer coefficient for this surface to use in AnOHM [-]

Dimensionality:

(7,)

Dimensionality Remarks:

7: { Paved, Bldgs, EveTr, DecTr, Grass, BSoil, Water}

SUEWS-related variables:

AnOHM_Ch

co2pointsource#
Description:

CO2 emission factor [kg km-1]

Dimensionality:

0

Dimensionality Remarks:

Scalar

SUEWS-related variables:

CO2PointSource

cpanohm#
Description:

Volumetric heat capacity for this surface to use in AnOHM [J m-3]

Dimensionality:

(7,)

Dimensionality Remarks:

7: { Paved, Bldgs, EveTr, DecTr, Grass, BSoil, Water}

SUEWS-related variables:

AnOHM_Cp

crwmax#
Description:

Maximum water holding capacity of snow [mm]

Dimensionality:

0

Dimensionality Remarks:

Scalar

SUEWS-related variables:

CRWMax

crwmin#
Description:

Minimum water holding capacity of snow [mm]

Dimensionality:

0

Dimensionality Remarks:

Scalar

SUEWS-related variables:

CRWMin

daywat#
Description:

Irrigation flag: 1 for on and 0 for off.

Dimensionality:

(7,)

Dimensionality Remarks:

7: {Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday}

SUEWS-related variables:

DayWat(1), DayWat(2), DayWat(3), DayWat(4), DayWat(5), DayWat(6), DayWat(7)

daywatper#
Description:

Fraction of properties using irrigation for each day of a week.

Dimensionality:

(7,)

Dimensionality Remarks:

7: {Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday}

SUEWS-related variables:

DayWatPer(1), DayWatPer(2), DayWatPer(3), DayWatPer(4), DayWatPer(5), DayWatPer(6), DayWatPer(7)

decidcap_id#
Description:

Storage capacity of deciduous surface DecTr on day 0 of run.

Dimensionality:

0

Dimensionality Remarks:

Scalar

SUEWS-related variables:

decidCap0

dectreeh#
Description:

Mean height of deciduous trees [m]

Dimensionality:

0

Dimensionality Remarks:

Scalar

SUEWS-related variables:

H_DecTr

diagmethod#
Description:

Defines how near surface diagnostics are calculated.

Dimensionality:

0

Dimensionality Remarks:

Scalar

SUEWS-related variables:

DiagMethod

diagnose#
Description:

Internal use. Please DO NOT modify

Dimensionality:

0

Dimensionality Remarks:

Scalar

SUEWS-related variables:

None

diagqn#
Description:

Internal use. Please DO NOT modify

Dimensionality:

0

Dimensionality Remarks:

Scalar

SUEWS-related variables:

None

diagqs#
Description:

Internal use. Please DO NOT modify

Dimensionality:

0

Dimensionality Remarks:

Scalar

SUEWS-related variables:

None

drainrt#
Description:

Drainage rate of bucket for LUMPS [mm h-1]

Dimensionality:

0

Dimensionality Remarks:

Scalar

SUEWS-related variables:

LUMPS_DrRate

ef_umolco2perj#
Description:

Emission factor for fuels used for building heating.

Dimensionality:

0

Dimensionality Remarks:

Scalar

SUEWS-related variables:

EF_umolCO2perJ

emis#
Description:

Effective surface emissivity.

Dimensionality:

(7,)

Dimensionality Remarks:

7: { Paved, Bldgs, EveTr, DecTr, Grass, BSoil, Water}

SUEWS-related variables:

Emissivity

emissionsmethod#
Description:

Determines method for QF calculation.

Dimensionality:

0

Dimensionality Remarks:

Scalar

SUEWS-related variables:

EmissionsMethod

enddls#
Description:

End of the day light savings [DOY]

Dimensionality:

0

Dimensionality Remarks:

Scalar

SUEWS-related variables:

EndDLS

enef_v_jkm#
Description:

Emission factor for heat [J k m-1 ].

Dimensionality:

0

Dimensionality Remarks:

Scalar

SUEWS-related variables:

EnEF_v_Jkm

evapmethod#
Description:

Internal use. Please DO NOT modify

Dimensionality:

0

Dimensionality Remarks:

Scalar

SUEWS-related variables:

None

evetreeh#
Description:

Mean height of evergreen trees [m]

Dimensionality:

0

Dimensionality Remarks:

Scalar

SUEWS-related variables:

H_EveTr

faibldg#
Description:

Frontal area index for buildings [-]

Dimensionality:

0

Dimensionality Remarks:

Scalar

SUEWS-related variables:

FAI_Bldgs

faidectree#
Description:

Frontal area index for deciduous trees [-]

Dimensionality:

0

Dimensionality Remarks:

Scalar

SUEWS-related variables:

FAI_DecTr

faievetree#
Description:

Frontal area index for evergreen trees [-]

Dimensionality:

0

Dimensionality Remarks:

Scalar

SUEWS-related variables:

FAI_EveTr

faut#
Description:

Fraction of irrigated area that is irrigated using automated systems

Dimensionality:

0

Dimensionality Remarks:

Scalar

SUEWS-related variables:

Faut

fcef_v_kgkm#
Description:

CO2 emission factor for weekdays [kg km-1];;CO2 emission factor for weekends [kg km-1]

Dimensionality:

(2,)

Dimensionality Remarks:

2: {Weekday, Weekend}

SUEWS-related variables:

FcEF_v_kgkmWD, FcEF_v_kgkmWE

flowchange#
Description:

Difference in input and output flows for water surface [mm h-1]

Dimensionality:

0

Dimensionality Remarks:

Scalar

SUEWS-related variables:

FlowChange

frfossilfuel_heat#
Description:

Fraction of fossil fuels used for building heating [-]

Dimensionality:

0

Dimensionality Remarks:

Scalar

SUEWS-related variables:

FrFossilFuel_Heat

frfossilfuel_nonheat#
Description:

Fraction of fossil fuels used for building energy use [-]

Dimensionality:

0

Dimensionality Remarks:

Scalar

SUEWS-related variables:

FrFossilFuel_NonHeat

g1#
Description:

Related to maximum surface conductance [mm s-1]

Dimensionality:

0

Dimensionality Remarks:

Scalar

SUEWS-related variables:

G1

g2#
Description:

Related to Kdown dependence [W m-2]

Dimensionality:

0

Dimensionality Remarks:

Scalar

SUEWS-related variables:

G2

g3#
Description:

Related to VPD dependence [units depend on gsModel]

Dimensionality:

0

Dimensionality Remarks:

Scalar

SUEWS-related variables:

G3

g4#
Description:

Related to VPD dependence [units depend on gsModel]

Dimensionality:

0

Dimensionality Remarks:

Scalar

SUEWS-related variables:

G4

g5#
Description:

Related to temperature dependence [°C]

Dimensionality:

0

Dimensionality Remarks:

Scalar

SUEWS-related variables:

G5

g6#
Description:

Related to soil moisture dependence [mm-1]

Dimensionality:

0

Dimensionality Remarks:

Scalar

SUEWS-related variables:

G6

gddfull#
Description:

The growing degree days (GDD) needed for full capacity of the leaf area index (LAI) [°C].

Dimensionality:

(3,)

Dimensionality Remarks:

3: { EveTr, DecTr, Grass}

SUEWS-related variables:

GDDFull

ground_albedo_dir_mult_fact#
Description:

Internal use. Please DO NOT modify

Dimensionality:

0

Dimensionality Remarks:

Scalar

SUEWS-related variables:

None

gsmodel#
Description:

Formulation choice for conductance calculation.

Dimensionality:

0

Dimensionality Remarks:

Scalar

SUEWS-related variables:

gsModel

h_maintain#
Description:

water depth to maintain used in automatic irrigation (e.g., ponding water due to flooding irrigation in rice crop-field) [mm].

Dimensionality:

0

Dimensionality Remarks:

Scalar

SUEWS-related variables:

H_maintain

humactivity_24hr#
Description:

Hourly profile values used in human activity calculation.

Dimensionality:

(24, 2)

Dimensionality Remarks:

24: hours of a day

2: {Weekday, Weekend}

SUEWS-related variables:

ActivityProfWD, ActivityProfWE

ie_a#
Description:

Coefficient for automatic irrigation model.

Dimensionality:

(3,)

Dimensionality Remarks:

3: { EveTr, DecTr, Grass}

SUEWS-related variables:

Ie_a1, Ie_a2, Ie_a3

ie_end#
Description:

Day when irrigation ends [DOY]

Dimensionality:

0

Dimensionality Remarks:

Scalar

SUEWS-related variables:

Ie_end

ie_m#
Description:

Coefficient for manual irrigation model.

Dimensionality:

(3,)

Dimensionality Remarks:

3: { EveTr, DecTr, Grass}

SUEWS-related variables:

Ie_m1, Ie_m2, Ie_m3

ie_start#
Description:

Day when irrigation starts [DOY]

Dimensionality:

0

Dimensionality Remarks:

Scalar

SUEWS-related variables:

Ie_start

internalwateruse_h#
Description:

Internal water use [mm h-1]

Dimensionality:

0

Dimensionality Remarks:

Scalar

SUEWS-related variables:

InternalWaterUse

irrfracbldgs#
Description:

Fraction of Bldgs that is irrigated [-]

Dimensionality:

0

Dimensionality Remarks:

Scalar

SUEWS-related variables:

IrrFr_Bldgs

irrfracbsoil#
Description:

Fraction of BSoil that is irrigated [-]

Dimensionality:

0

Dimensionality Remarks:

Scalar

SUEWS-related variables:

IrrFr_BSoil

irrfracdectr#
Description:

Fraction of DecTr that is irrigated [-]

Dimensionality:

0

Dimensionality Remarks:

Scalar

SUEWS-related variables:

IrrFr_DecTr

irrfracevetr#
Description:

Fraction of EveTr that is irrigated [-]

Dimensionality:

0

Dimensionality Remarks:

Scalar

SUEWS-related variables:

IrrFr_EveTr

irrfracgrass#
Description:

Fraction of Grass that is irrigated [-]

Dimensionality:

0

Dimensionality Remarks:

Scalar

SUEWS-related variables:

IrrFr_Grass

irrfracpaved#
Description:

Fraction of Paved that is irrigated [-]

Dimensionality:

0

Dimensionality Remarks:

Scalar

SUEWS-related variables:

IrrFr_Paved

irrfracwater#
Description:

Fraction of Water that is irrigated [-]

Dimensionality:

0

Dimensionality Remarks:

Scalar

SUEWS-related variables:

IrrFr_Water

kkanohm#
Description:

Thermal conductivity for this surface to use in AnOHM [W m K-1]

Dimensionality:

(7,)

Dimensionality Remarks:

7: { Paved, Bldgs, EveTr, DecTr, Grass, BSoil, Water}

SUEWS-related variables:

AnOHM_Kk

kmax#
Description:

Maximum incoming shortwave radiation [W m-2]

Dimensionality:

0

Dimensionality Remarks:

Scalar

SUEWS-related variables:

Kmax

lai_id#
Description:

Initial LAI values.

Dimensionality:

(3,)

Dimensionality Remarks:

3: { EveTr, DecTr, Grass}

SUEWS-related variables:

LAIinitialDecTr, LAIinitialEveTr, LAIinitialGrass

laicalcyes#
Description:

Internal use. Please DO NOT modify

Dimensionality:

0

Dimensionality Remarks:

Scalar

SUEWS-related variables:

None

laimax#
Description:

full leaf-on summertime value

Dimensionality:

(3,)

Dimensionality Remarks:

3: { EveTr, DecTr, Grass}

SUEWS-related variables:

LAIMax

laimin#
Description:

leaf-off wintertime value

Dimensionality:

(3,)

Dimensionality Remarks:

3: { EveTr, DecTr, Grass}

SUEWS-related variables:

LAIMin

laipower#
Description:

parameters required by LAI calculation.

Dimensionality:

(4, 3)

Dimensionality Remarks:

4: {LeafGrowthPower1, LeafGrowthPower2, LeafOffPower1, LeafOffPower2}

3: { EveTr, DecTr, Grass}

SUEWS-related variables:

LeafGrowthPower1, LeafGrowthPower2, LeafOffPower1, LeafOffPower2

laitype#
Description:

LAI calculation choice.

Dimensionality:

(3,)

Dimensionality Remarks:

3: { EveTr, DecTr, Grass}

SUEWS-related variables:

LAIEq

lat#
Description:

Latitude [deg].

Dimensionality:

0

Dimensionality Remarks:

Scalar

SUEWS-related variables:

lat

lng#
Description:

longitude [deg]

Dimensionality:

0

Dimensionality Remarks:

Scalar

SUEWS-related variables:

lng

maxconductance#
Description:

The maximum conductance of each vegetation or surface type. [mm s-1]

Dimensionality:

(3,)

Dimensionality Remarks:

3: { EveTr, DecTr, Grass}

SUEWS-related variables:

MaxConductance

maxfcmetab#
Description:

Maximum (day) CO2 from human metabolism. [W m-2]

Dimensionality:

0

Dimensionality Remarks:

Scalar

SUEWS-related variables:

MaxFCMetab

maxqfmetab#
Description:

Maximum value for human heat emission. [W m-2]

Dimensionality:

0

Dimensionality Remarks:

Scalar

SUEWS-related variables:

MaxQFMetab

min_res_bioco2#
Description:

Minimum soil respiration rate (for cold-temperature limit) [umol m-2 s-1].

Dimensionality:

(3,)

Dimensionality Remarks:

3: { EveTr, DecTr, Grass}

SUEWS-related variables:

min_respi

minfcmetab#
Description:

Minimum (night) CO2 from human metabolism. [W m-2]

Dimensionality:

0

Dimensionality Remarks:

Scalar

SUEWS-related variables:

MinFCMetab

minqfmetab#
Description:

Minimum value for human heat emission. [W m-2]

Dimensionality:

0

Dimensionality Remarks:

Scalar

SUEWS-related variables:

MinQFMetab

n_stream_lw_urban#
Description:

Internal use. Please DO NOT modify

Dimensionality:

0

Dimensionality Remarks:

Scalar

SUEWS-related variables:

None

n_stream_sw_urban#
Description:

Internal use. Please DO NOT modify

Dimensionality:

0

Dimensionality Remarks:

Scalar

SUEWS-related variables:

None

n_vegetation_region_urban#
Description:

Internal use. Please DO NOT modify

Dimensionality:

0

Dimensionality Remarks:

Scalar

SUEWS-related variables:

None

narp_emis_snow#
Description:

Effective surface emissivity.

Dimensionality:

0

Dimensionality Remarks:

Scalar

SUEWS-related variables:

Emissivity

narp_trans_site#
Description:

Atmospheric transmissivity for NARP [-]

Dimensionality:

0

Dimensionality Remarks:

Scalar

SUEWS-related variables:

NARP_Trans

netradiationmethod#
Description:

Determines method for calculation of radiation fluxes.

Dimensionality:

0

Dimensionality Remarks:

Scalar

SUEWS-related variables:

NetRadiationMethod

ohm_coef#
Description:

Coefficients for OHM calculation.

Dimensionality:

(8, 4, 3)

Dimensionality Remarks:

8: { Paved, Bldgs, EveTr, DecTr, Grass, BSoil, Water, one extra land cover type (currently NOT used)}

4: {SummerWet, SummerDry, WinterWet, WinterDry}

3: {a1, a2, a3}

SUEWS-related variables:

a1, a2, a3

ohm_threshsw#
Description:

Temperature threshold determining whether summer/winter OHM coefficients are applied [°C]

Dimensionality:

(8,)

Dimensionality Remarks:

8: { Paved, Bldgs, EveTr, DecTr, Grass, BSoil, Water, one extra land cover type (currently NOT used)}

SUEWS-related variables:

OHMThresh_SW

ohm_threshwd#
Description:

Soil moisture threshold determining whether wet/dry OHM coefficients are applied [-]

Dimensionality:

(8,)

Dimensionality Remarks:

8: { Paved, Bldgs, EveTr, DecTr, Grass, BSoil, Water, one extra land cover type (currently NOT used)}

SUEWS-related variables:

OHMThresh_WD

ohmincqf#
Description:

Determines whether the storage heat flux calculation uses Q\ * or ( Q\ * +QF).

Dimensionality:

0

Dimensionality Remarks:

Scalar

SUEWS-related variables:

OHMIncQF

pipecapacity#
Description:

Storage capacity of pipes [mm]

Dimensionality:

0

Dimensionality Remarks:

Scalar

SUEWS-related variables:

PipeCapacity

popdensdaytime#
Description:

Daytime population density (i.e. workers, tourists) [people ha-1]

Dimensionality:

(2,)

Dimensionality Remarks:

2: {Weekday, Weekend}

SUEWS-related variables:

PopDensDay

popdensnighttime#
Description:

Night-time population density (i.e. residents) [people ha-1]

Dimensionality:

0

Dimensionality Remarks:

Scalar

SUEWS-related variables:

PopDensNight

popprof_24hr#
Description:

Hourly profile values used in dynamic population estimation.

Dimensionality:

(24, 2)

Dimensionality Remarks:

24: hours of a day

2: {Weekday, Weekend}

SUEWS-related variables:

PopProfWD, PopProfWE

pormax_dec#
Description:

full leaf-on summertime value Used only for DecTr (can affect roughness calculation)

Dimensionality:

0

Dimensionality Remarks:

Scalar

SUEWS-related variables:

PorosityMax

pormin_dec#
Description:

leaf-off wintertime value Used only for DecTr (can affect roughness calculation)

Dimensionality:

0

Dimensionality Remarks:

Scalar

SUEWS-related variables:

PorosityMin

porosity_id#
Description:

Porosity of deciduous vegetation on day 0 of run.

Dimensionality:

0

Dimensionality Remarks:

Scalar

SUEWS-related variables:

porosity0

preciplimit#
Description:

Temperature limit when precipitation falls as snow [°C]

Dimensionality:

0

Dimensionality Remarks:

Scalar

SUEWS-related variables:

PrecipLimSnow

preciplimitalb#
Description:

Limit for hourly precipitation when the ground is fully covered with snow [mm]

Dimensionality:

0

Dimensionality Remarks:

Scalar

SUEWS-related variables:

PrecipLimAlb

qf0_beu#
Description:

Building energy use [W m-2]

Dimensionality:

(2,)

Dimensionality Remarks:

2: {Weekday, Weekend}

SUEWS-related variables:

QF0_BEU_WD, QF0_BEU_WE

qf_a#
Description:

Base value for QF calculation.

Dimensionality:

(2,)

Dimensionality Remarks:

2: {Weekday, Weekend}

SUEWS-related variables:

QF_A_WD, QF_A_WE

qf_b#
Description:

Parameter related to heating degree days.

Dimensionality:

(2,)

Dimensionality Remarks:

2: {Weekday, Weekend}

SUEWS-related variables:

QF_B_WD, QF_B_WE

qf_c#
Description:

Parameter related to heating degree days.

Dimensionality:

(2,)

Dimensionality Remarks:

2: {Weekday, Weekend}

SUEWS-related variables:

QF_C_WD, QF_C_WE

radmeltfact#
Description:

Hourly radiation melt factor of snow [mm W-1 h-1]

Dimensionality:

0

Dimensionality Remarks:

Scalar

SUEWS-related variables:

RadMeltFactor

raincover#
Description:

Limit when surface totally covered with water for LUMPS [mm]

Dimensionality:

0

Dimensionality Remarks:

Scalar

SUEWS-related variables:

LUMPS_Cover

rainmaxres#
Description:

Maximum water bucket reservoir [mm] Used for LUMPS surface wetness control.

Dimensionality:

0

Dimensionality Remarks:

Scalar

SUEWS-related variables:

LUMPS_MaxRes

resp_a#
Description:

Respiration coefficient a.

Dimensionality:

(3,)

Dimensionality Remarks:

3: { EveTr, DecTr, Grass}

SUEWS-related variables:

resp_a

resp_b#
Description:

Respiration coefficient b - related to air temperature dependency.

Dimensionality:

(3,)

Dimensionality Remarks:

3: { EveTr, DecTr, Grass}

SUEWS-related variables:

resp_b

roughlenheatmethod#
Description:

Determines method for calculating roughness length for heat.

Dimensionality:

0

Dimensionality Remarks:

Scalar

SUEWS-related variables:

RoughLenHeatMethod

roughlenmommethod#
Description:

Determines how aerodynamic roughness length (z0m) and zero displacement height (zdm) are calculated.

Dimensionality:

0

Dimensionality Remarks:

Scalar

SUEWS-related variables:

RoughLenMomMethod

runofftowater#
Description:

Fraction of above-ground runoff flowing to water surface during flooding [-]

Dimensionality:

0

Dimensionality Remarks:

Scalar

SUEWS-related variables:

RunoffToWater

s1#
Description:

A parameter related to soil moisture dependence [-]

Dimensionality:

0

Dimensionality Remarks:

Scalar

SUEWS-related variables:

S1

s2#
Description:

A parameter related to soil moisture dependence [mm]

Dimensionality:

0

Dimensionality Remarks:

Scalar

SUEWS-related variables:

S2

sathydraulicconduct#
Description:

Hydraulic conductivity for saturated soil [mm s-1]

Dimensionality:

(7,)

Dimensionality Remarks:

7: { Paved, Bldgs, EveTr, DecTr, Grass, BSoil, Water}

SUEWS-related variables:

SatHydraulicCond

sddfull#
Description:

The sensesence degree days (SDD) needed to initiate leaf off. [°C]

Dimensionality:

(3,)

Dimensionality Remarks:

3: { EveTr, DecTr, Grass}

SUEWS-related variables:

SDDFull

sfr_surf#
Description:

Surface cover fractions.

Dimensionality:

(7,)

Dimensionality Remarks:

7: { Paved, Bldgs, EveTr, DecTr, Grass, BSoil, Water}

SUEWS-related variables:

Fr_Bldgs, Fr_Bsoil, Fr_DecTr, Fr_EveTr, Fr_Grass, Fr_Paved, Fr_Water

smdmethod#
Description:

Determines method for calculating soil moisture deficit (SMD).

Dimensionality:

0

Dimensionality Remarks:

Scalar

SUEWS-related variables:

SMDMethod

snowalb#
Description:

Initial snow albedo

Dimensionality:

0

Dimensionality Remarks:

Scalar

SUEWS-related variables:

SnowAlb0

snowalbmax#
Description:

Effective surface albedo (middle of the day value) for summertime.

Dimensionality:

0

Dimensionality Remarks:

Scalar

SUEWS-related variables:

AlbedoMax

snowalbmin#
Description:

Effective surface albedo (middle of the day value) for wintertime (not including snow).

Dimensionality:

0

Dimensionality Remarks:

Scalar

SUEWS-related variables:

AlbedoMin

snowdens#
Description:

Initial snow density of each land cover.

Dimensionality:

(7,)

Dimensionality Remarks:

7: { Paved, Bldgs, EveTr, DecTr, Grass, BSoil, Water}

SUEWS-related variables:

SnowDensBldgs, SnowDensPaved, SnowDensDecTr, SnowDensEveTr, SnowDensGrass, SnowDensBSoil, SnowDensWater

snowdensmax#
Description:

Maximum snow density [kg m-3]

Dimensionality:

0

Dimensionality Remarks:

Scalar

SUEWS-related variables:

SnowDensMax

snowdensmin#
Description:

Fresh snow density [kg m-3]

Dimensionality:

0

Dimensionality Remarks:

Scalar

SUEWS-related variables:

SnowDensMin

snowfrac#
Description:

Initial plan area fraction of snow on each land cover`

Dimensionality:

(7,)

Dimensionality Remarks:

7: { Paved, Bldgs, EveTr, DecTr, Grass, BSoil, Water}

SUEWS-related variables:

SnowFracBldgs, SnowFracPaved, SnowFracDecTr, SnowFracEveTr, SnowFracGrass, SnowFracBSoil, SnowFracWater

snowlimbldg#
Description:

Limit of the snow water equivalent for snow removal from roads and roofs [mm]

Dimensionality:

0

Dimensionality Remarks:

Scalar

SUEWS-related variables:

SnowLimRemove

snowlimpaved#
Description:

Limit of the snow water equivalent for snow removal from roads and roofs [mm]

Dimensionality:

0

Dimensionality Remarks:

Scalar

SUEWS-related variables:

SnowLimRemove

snowpack#
Description:

Initial snow water equivalent on each land cover

Dimensionality:

(7,)

Dimensionality Remarks:

7: { Paved, Bldgs, EveTr, DecTr, Grass, BSoil, Water}

SUEWS-related variables:

SnowPackBldgs, SnowPackPaved, SnowPackDecTr, SnowPackEveTr, SnowPackGrass, SnowPackBSoil, SnowPackWater

snowpacklimit#
Description:

Limit for the snow water equivalent when snow cover starts to be patchy [mm]

Dimensionality:

(7,)

Dimensionality Remarks:

7: { Paved, Bldgs, EveTr, DecTr, Grass, BSoil, Water}

SUEWS-related variables:

SnowLimPatch

snowprof_24hr#
Description:

Hourly profile values used in snow clearing.

Dimensionality:

(24, 2)

Dimensionality Remarks:

24: hours of a day

2: {Weekday, Weekend}

SUEWS-related variables:

SnowClearingProfWD, SnowClearingProfWE

snowuse#
Description:

Determines whether the snow part of the model runs.

Dimensionality:

0

Dimensionality Remarks:

Scalar

SUEWS-related variables:

SnowUse

snowwater#
Description:

Initial amount of liquid water in the snow on each land cover

Dimensionality:

(7,)

Dimensionality Remarks:

7: { Paved, Bldgs, EveTr, DecTr, Grass, BSoil, Water}

SUEWS-related variables:

SnowWaterBldgsState, SnowWaterPavedState, SnowWaterDecTrState, SnowWaterEveTrState, SnowWaterGrassState, SnowWaterBSoilState, SnowWaterWaterState

soildepth#
Description:

Depth of soil beneath the surface [mm]

Dimensionality:

(7,)

Dimensionality Remarks:

7: { Paved, Bldgs, EveTr, DecTr, Grass, BSoil, Water}

SUEWS-related variables:

SoilDepth

soilstore_surf#
Description:

Initial water stored in soil beneath Bldgs surface [mm];;Initial water stored in soil beneath Paved surface [mm];;Initial water stored in soil beneath DecTr surface [mm];;Initial water stored in soil beneath EveTr surface [mm];;Initial water stored in soil beneath Grass surface [mm];;Initial water stored in soil beneath BSoil surface [mm]

Dimensionality:

(7,)

Dimensionality Remarks:

7: { Paved, Bldgs, EveTr, DecTr, Grass, BSoil, Water}

SUEWS-related variables:

SoilstoreBldgsState, SoilstorePavedState, SoilstoreDecTrState, SoilstoreEveTrState, SoilstoreGrassState, SoilstoreBSoilState

soilstorecap_surf#
Description:

Limit value for SoilDepth [mm]

Dimensionality:

(7,)

Dimensionality Remarks:

7: { Paved, Bldgs, EveTr, DecTr, Grass, BSoil, Water}

SUEWS-related variables:

SoilStoreCap

stabilitymethod#
Description:

Defines which atmospheric stability functions are used.

Dimensionality:

0

Dimensionality Remarks:

Scalar

SUEWS-related variables:

StabilityMethod

startdls#
Description:

Start of the day light savings [DOY]

Dimensionality:

0

Dimensionality Remarks:

Scalar

SUEWS-related variables:

StartDLS

state_surf#
Description:

Initial wetness condition on Bldgs;;Initial wetness condition on Paved;;Initial wetness condition on DecTr;;Initial wetness condition on EveTr;;Initial wetness condition on Grass;;Initial wetness condition on BSoil;;Initial wetness condition on Water

Dimensionality:

(7,)

Dimensionality Remarks:

7: { Paved, Bldgs, EveTr, DecTr, Grass, BSoil, Water}

SUEWS-related variables:

BldgsState, PavedState, DecTrState, EveTrState, GrassState, BSoilState, WaterState

statelimit_surf#
Description:

Upper limit to the surface state. [mm]

Dimensionality:

(7,)

Dimensionality Remarks:

7: { Paved, Bldgs, EveTr, DecTr, Grass, BSoil, Water}

SUEWS-related variables:

StateLimit

storageheatmethod#
Description:

Determines method for calculating storage heat flux ΔQS.

Dimensionality:

0

Dimensionality Remarks:

Scalar

SUEWS-related variables:

StorageHeatMethod

storedrainprm#
Description:

Coefficients used in drainage calculation.

Dimensionality:

(6, 7)

Dimensionality Remarks:

6: { StorageMin, DrainageEq, DrainageCoef1, DrainageCoef2, StorageMax, current storage}

7: { Paved, Bldgs, EveTr, DecTr, Grass, BSoil, Water}

SUEWS-related variables:

DrainageCoef1, DrainageCoef2, DrainageEq, StorageMax, StorageMin

surfacearea#
Description:

Area of the grid [m2].

Dimensionality:

0

Dimensionality Remarks:

Scalar

SUEWS-related variables:

SurfaceArea - note the unit in SUEWS SiteSelect.txt is ha

sw_dn_direct_frac#
Description:

Internal use. Please DO NOT modify

Dimensionality:

0

Dimensionality Remarks:

Scalar

SUEWS-related variables:

None

tau_a#
Description:

Time constant for snow albedo aging in cold snow [-]

Dimensionality:

0

Dimensionality Remarks:

Scalar

SUEWS-related variables:

tau_a

tau_f#
Description:

Time constant for snow albedo aging in melting snow [-]

Dimensionality:

0

Dimensionality Remarks:

Scalar

SUEWS-related variables:

tau_f

tau_r#
Description:

Time constant for snow density ageing [-]

Dimensionality:

0

Dimensionality Remarks:

Scalar

SUEWS-related variables:

tau_r

tempmeltfact#
Description:

Hourly temperature melt factor of snow [mm K-1 h-1]

Dimensionality:

0

Dimensionality Remarks:

Scalar

SUEWS-related variables:

TempMeltFactor

th#
Description:

Upper air temperature limit [°C]

Dimensionality:

0

Dimensionality Remarks:

Scalar

SUEWS-related variables:

TH

theta_bioco2#
Description:

The convexity of the curve at light saturation.

Dimensionality:

(3,)

Dimensionality Remarks:

3: { EveTr, DecTr, Grass}

SUEWS-related variables:

theta

timezone#
Description:

Time zone [h] for site relative to UTC (east is positive). This should be set according to the times given in the meteorological forcing file(s).

Dimensionality:

0

Dimensionality Remarks:

Scalar

SUEWS-related variables:

Timezone

tl#
Description:

Lower air temperature limit [°C]

Dimensionality:

0

Dimensionality Remarks:

Scalar

SUEWS-related variables:

TL

trafficrate#
Description:

Traffic rate used for CO2 flux calculation.

Dimensionality:

(2,)

Dimensionality Remarks:

2: {Weekday, Weekend}

SUEWS-related variables:

TrafficRate_WD, TrafficRate_WE

trafficunits#
Description:

Units for the traffic rate for the study area. Not used in v2018a.

Dimensionality:

0

Dimensionality Remarks:

Scalar

SUEWS-related variables:

TrafficUnits

traffprof_24hr#
Description:

Hourly profile values used in traffic activity calculation.

Dimensionality:

(24, 2)

Dimensionality Remarks:

24: hours of a day

2: {Weekday, Weekend}

SUEWS-related variables:

TraffProfWD, TraffProfWE

tstep#
Description:

Specifies the model time step [s].

Dimensionality:

0

Dimensionality Remarks:

Scalar

SUEWS-related variables:

Tstep

use_sw_direct_albedo#
Description:

Internal use. Please DO NOT modify

Dimensionality:

0

Dimensionality Remarks:

Scalar

SUEWS-related variables:

None

veg_contact_fraction_const#
Description:

Internal use. Please DO NOT modify

Dimensionality:

0

Dimensionality Remarks:

Scalar

SUEWS-related variables:

None

veg_fsd_const#
Description:

Internal use. Please DO NOT modify

Dimensionality:

0

Dimensionality Remarks:

Scalar

SUEWS-related variables:

None

veg_ssa_lw#
Description:

Internal use. Please DO NOT modify

Dimensionality:

0

Dimensionality Remarks:

Scalar

SUEWS-related variables:

None

veg_ssa_sw#
Description:

Internal use. Please DO NOT modify

Dimensionality:

0

Dimensionality Remarks:

Scalar

SUEWS-related variables:

None

veg_type#
Description:

Internal use. Please DO NOT modify

Dimensionality:

0

Dimensionality Remarks:

Scalar

SUEWS-related variables:

None

waterdist#
Description:

Fraction of water redistribution

Dimensionality:

(8, 6)

Dimensionality Remarks:

8: { Paved, Bldgs, EveTr, DecTr, Grass, BSoil, Water, one extra land cover type (currently NOT used)}

6: { Paved, Bldgs, EveTr, DecTr, Grass, BSoil}

SUEWS-related variables:

ToBSoil, ToBldgs, ToDecTr, ToEveTr, ToGrass, ToPaved, ToRunoff, ToSoilStore, ToWater

waterusemethod#
Description:

Defines how external water use is calculated.

Dimensionality:

0

Dimensionality Remarks:

Scalar

SUEWS-related variables:

WaterUseMethod

wetthresh_surf#
Description:

Depth of water which determines whether evaporation occurs from a partially wet or completely wet surface [mm].

Dimensionality:

(7,)

Dimensionality Remarks:

7: { Paved, Bldgs, EveTr, DecTr, Grass, BSoil, Water}

SUEWS-related variables:

WetThreshold

wuprofa_24hr#
Description:

Hourly profile values used in automatic irrigation.

Dimensionality:

(24, 2)

Dimensionality Remarks:

24: hours of a day

2: {Weekday, Weekend}

SUEWS-related variables:

WaterUseProfAutoWD, WaterUseProfAutoWE

wuprofm_24hr#
Description:

Hourly profile values used in manual irrigation.

Dimensionality:

(24, 2)

Dimensionality Remarks:

24: hours of a day

2: {Weekday, Weekend}

SUEWS-related variables:

WaterUseProfManuWD, WaterUseProfManuWE

z#
Description:

Measurement height [m] for all atmospheric forcing variables set in SSss_YYYY_data_tt.txt.

Dimensionality:

0

Dimensionality Remarks:

Scalar

SUEWS-related variables:

z

z0m_in#
Description:

Roughness length for momentum [m]

Dimensionality:

0

Dimensionality Remarks:

Scalar

SUEWS-related variables:

z0

zdm_in#
Description:

Zero-plane displacement [m]

Dimensionality:

0

Dimensionality Remarks:

Scalar

SUEWS-related variables:

zd

By SUEWS dev team led by Prof Sue Grimmond

© Copyright 2018 – 2026.

Last updated on 2025-12-05.

Version: 2026.3.10.dev13 | Commit: e27bd4b | Brand