Surface file parameters¶
This page is generated from the surface variable registry.
All surface variables¶
Variable |
Dimensions |
Units |
Required level |
Contexts |
Description |
|---|---|---|---|---|---|
|
|
|
|
|
Diffuse albedo of impervious road; spectral-dependent surface reflectance for urban impervious surfaces. |
|
|
|
|
|
Direct albedo of impervious road; spectral-dependent surface reflectance for urban impervious surfaces. |
|
|
|
|
|
Diffuse albedo of pervious road; spectral-dependent surface reflectance for urban pervious surfaces. |
|
|
|
|
|
Direct albedo of pervious road; spectral-dependent surface reflectance for urban pervious surfaces. |
|
|
|
|
|
Diffuse albedo of roof; spectral-dependent surface reflectance for urban roof surfaces. |
|
|
|
|
|
Direct albedo of roof; spectral-dependent surface reflectance for urban roof surfaces. |
|
|
|
|
|
Diffuse albedo of wall; spectral-dependent surface reflectance for urban wall surfaces. |
|
|
|
|
|
Direct albedo of wall; spectral-dependent surface reflectance for urban wall surfaces. |
|
|
|
|
|
Apatite phosphorus; soil phosphorus pool in apatite (primary mineral) form; used by phosphorus biogeochemistry when enabled. |
|
|
|
|
|
Area (m2) of each land grid cell; used to weight land-surface properties and to compare with domain/topography. |
|
|
|
|
|
Canyon height to width ratio; urban geometric parameter affecting radiation and wind. |
|
|
|
|
|
Volumetric heat capacity of impervious road; thermal mass property affecting diurnal temperature variations. |
|
|
|
|
|
Volumetric heat capacity of roof; thermal mass property affecting building heat dynamics. |
|
|
|
|
|
Volumetric heat capacity of wall; thermal mass property affecting wall temperature dynamics. |
|
|
|
|
|
VIC Ds parameter for the ARNO curve; fractional saturated area infiltration parameter. |
|
|
|
|
|
VIC Dsmax parameter for the ARNO curve; maximum infiltration rate. |
|
|
|
|
|
EF1 isoprene emission factor for broadleaf tree (BTR); vegetation-dependent emission rate. |
|
|
|
|
|
EF1 isoprene emission factor for crop (CRP); vegetation-dependent emission rate. |
|
|
|
|
|
EF1 isoprene emission factor for deciduous forest (FDT); vegetation-dependent emission rate. |
|
|
|
|
|
EF1 isoprene emission factor for evergreen forest (FET); vegetation-dependent emission rate. |
|
|
|
|
|
EF1 isoprene emission factor for grass (GRS); vegetation-dependent emission rate. |
|
|
|
|
|
EF1 isoprene emission factor for shrub (SHR); vegetation-dependent emission rate. |
|
|
|
|
|
Emissivity of impervious road; controls longwave radiation emission from urban surfaces. |
|
|
|
|
|
Emissivity of pervious road; controls longwave radiation emission from pervious urban surfaces. |
|
|
|
|
|
Emissivity of roof; controls longwave radiation emission from building roof. |
|
|
|
|
|
Emissivity of wall; controls longwave radiation emission from building walls. |
|
|
|
|
|
Maximum gridcell fractional inundated area; controls wetland extent. |
|
|
|
|
|
Fraction of irrigation water applied via ground/sprinkler/drip; complements FSURF. (Requirement: Required when firrig_data is true; optional otherwise) |
|
|
|
|
|
Fraction (0–1) of cropland that is irrigated; read only when irrigation data are enabled (firrig_data). (Requirement: Required when firrig_data is true; optional otherwise) |
|
|
|
|
|
Maximum fractional saturated area; upper bound on inundation fraction. |
|
|
|
|
|
Fraction of irrigation water applied via surface irrigation; required with FIRRIG when irrigation data are used. (Requirement: Required when firrig_data is true; optional otherwise) |
|
|
|
|
|
Glacier mask read from a separate glacier file; ensures that glacier cells are a subset of the land mask. (Requirement: Optional (only used when a glacier mask file is provided)) |
|
|
|
|
|
Integer glacier elevation-class index for each grid cell when using mechanistic glacier (MEC) landunits. (Requirement: Required when glacier MEC landunits are used; optional otherwise) |
|
|
|
|
|
Height of roof; geometric property defining building structure. |
|
|
|
|
|
Labile inorganic phosphorus; soil labile (readily available) phosphorus pool; used by P-cycle parameterizations. |
|
|
|
|
|
Lake depth; average water depth for lake landunit. |
|
|
|
|
|
Fraction of each grid cell that is land (0–1); used to weight surface properties; a missing variable causes a fatal error. |
|
|
|
|
|
Fraction (0–1) of the global gridcell that is land in the PFT landunit; used to weight PFT tiles relative to the gridcell. |
|
|
|
|
|
Binary mask (1 = land, 0 = not-land) defining which grid cells are part of the land model; read from the surface file or domain file. |
|
|
|
|
|
Latitude (degrees) of the centre of each land grid cell. |
|
|
|
|
|
Longitude (degrees) of the centre of each land grid cell; used to compare the surface file with the domain and topography files. |
|
|
|
|
|
Monthly climatology of canopy bottom height (m) for vegetated landunits. |
|
|
|
|
|
Monthly climatology of canopy top height (m) for vegetated landunits. |
|
|
|
|
|
Leaf area index (LAI; m2 leaf per m2 ground) monthly climatology; time is typically 12 months. |
|
|
|
|
|
Stem area index (SAI) monthly climatology; time is typically 12 months. |
|
|
|
|
|
Maximum topounits elevation in each grid cell; a summary statistic reflecting the highest elevation among topounits. (Requirement: Optional (not required, but improves topounit characterization)) |
|
|
|
|
|
Nitrogen fertilizer application for each crop functional type; if absent, values default to zero. (Requirement: Optional (values default to zero when absent)) |
|
|
|
|
|
Number of impervious road layers; structural discretization for temperature calculation. |
|
|
|
|
|
Occluded phosphorus; soil occluded phosphorus pool (sorbed or otherwise inaccessible); part of multi-pool P parameterization. |
|
|
|
|
|
Organic matter density per soil layer; used in biogeochemical and thermal calculations. |
|
|
|
|
|
Coefficient for qflx_surf_lag for finundated; surface runoff delay parameter. |
|
|
|
|
|
Fraction of vegetated area allocated to each crop functional type; code aborts if missing when cft dimension exists. (Requirement: Required when the surface file includes crop functional types (cft_size > 0)) |
|
|
|
|
|
Soil clay percentage by mass (0–100) in each soil layer; controls hydraulic and thermal properties. |
|
|
|
|
|
Percent of grid cell area covered by cropland. |
|
|
|
|
|
Fraction of natural vegetation that is flat-centered polygons. (Requirement: Required when use_polygonal_tundra is true; optional otherwise) |
|
|
|
|
|
Fraction of grid cell area covered by simple glacier landunits within each topounit. (Requirement: Required unless glacier MEC landunits are used; optional when create_glacier_mec_landunit is true) |
|
|
|
|
|
Percent of grid cell area assigned to mechanistic glacier classes (accumulation/ablation, etc.). (Requirement: Required when glacier MEC landunits are created; optional otherwise) |
|
|
|
|
|
Percent gravel content (0–100) in each soil layer; affects soil water storage and hydraulic conductivity. |
|
|
|
|
|
Fraction of natural vegetation landunit that is high-centered polygons (polygonal tundra). (Requirement: Required when use_polygonal_tundra is true; optional otherwise) |
|
|
|
|
|
Percentage of each grid cell area that is lake within each topounit; used for lake landunit weighting. |
|
|
|
|
|
Fraction of natural vegetation that is low-centered polygons. (Requirement: Required when use_polygonal_tundra is true; optional otherwise) |
|
|
|
|
|
Percent of grid cell area covered by natural vegetation (non-crop vegetated landunit). |
|
|
|
|
|
Fraction of vegetated area allocated to each natural plant functional type; code aborts if missing. |
|
|
|
|
|
Soil sand percentage by mass (0–100) in each soil layer; controls hydraulic and thermal properties. |
|
|
|
|
|
Fraction of each grid cell that is urban, for each density class in the multi-density urban scheme. (Requirement: Required when the multi-density urban model is used (nlevurb > 0); optional otherwise) |
|
|
|
|
|
Percentage (0–100) of each grid cell area covered by wetlands within each topounit. |
|
|
|
|
|
Phosphorus fertilizer application for each crop functional type; treated like NFERT. |
|
|
|
|
|
Mask marking land grid cells that contain valid plant functional type (PFT) data; if missing the code stops with an error. |
|
|
|
|
|
Secondary mineral phosphorus; soil secondary mineral phosphorus pool; intermediate in reactivity between apatite and labile pools. |
|
|
|
|
|
sin(slope) * cos(aspect) for each grid cell; used in solar-radiation calculations. (Requirement: Required when TOP solar-radiation is used; optional otherwise) |
|
|
|
|
|
sin(slope) * sin(aspect) for each grid cell; used with SINSL_COSAS. (Requirement: Required when TOP solar-radiation is used; optional otherwise) |
|
|
|
|
|
Sky-view factor (0–1) describing horizon obstruction by surrounding terrain; needed by the TOP solar-radiation scheme. (Requirement: Required when TOP solar-radiation is used; optional otherwise) |
|
|
|
|
|
Mean surface slope (degrees) for each land grid cell; used in topographic and hydrologic parameterizations. |
|
|
|
|
|
Slope at quantiles (minimum and 10 to 100 percentile); topographic distribution parameter. |
|
|
|
|
|
Soil color; categorical index affecting soil albedo parameterization. |
|
|
|
|
|
Soil order; categorical soil classification for pedogenic properties. |
|
|
|
|
|
Standard deviation of elevation (m) used by the TOP solar-radiation parameterization; if STDEV_ELEV is missing the code tries STD_ELEV. (Requirement: Required when TOP solar-radiation is used; optional otherwise) |
|
|
|
|
|
Standard deviation of elevation (m) used by the TOP solar-radiation parameterization; alternative name to STDEV_ELEV. (Requirement: Required when TOP solar-radiation is used; optional otherwise) |
|
|
|
|
|
Terrain configuration parameter used in the TOP scheme to account for terrain-induced shading. (Requirement: Required when TOP solar-radiation is used; optional otherwise) |
|
|
|
|
|
Thickness of roof; structural property affecting heat capacity. |
|
|
|
|
|
Thickness of wall; structural property affecting heat capacity. |
|
|
|
|
|
Thermal conductivity of impervious road; controls heat diffusion through urban surface layers. |
|
|
|
|
|
Thermal conductivity of roof; controls heat transfer through building roof material. |
|
|
|
|
|
Thermal conductivity of wall; controls heat transfer through building wall material. |
|
|
|
|
|
Mean elevation (m) of each land grid cell read from the topography file; required by surfrd_get_topo. |
|
|
|
|
|
Weighted average of topounits elevation in each grid cell; a summary statistic for topounit-based elevation characterization. |
|
|
|
|
|
Elevation (m) of each mechanistic glacier class. (Requirement: Required when glacier MEC landunits are used; optional otherwise) |
|
|
|
|
|
Maximum interior building temperature; upper limit constraint for urban heating/cooling. |
|
|
|
|
|
Minimum interior building temperature; lower limit constraint for urban heating/cooling. |
|
|
|
|
|
Aspect (azimuth) of each topounit; optional and unused by default. |
|
|
|
|
|
Average elevation (m) of each topounit; optional if available. |
|
|
|
|
|
Average elevation (m) of each topounit; optional if available. |
|
|
|
|
|
Fraction of the grid cell’s area represented by each topounit; read only if present. |
|
|
|
|
|
Slope (degrees) of each topounit; not currently used but may improve topographic representation. |
|
|
|
|
|
Integer identifier linking urban grid cells to regional urban morphology datasets. (Requirement: Required when PCT_URBAN is used; optional otherwise) |
|
|
|
|
|
Height of wind in canyon; reference height for urban wind profile. |
|
|
|
|
|
Fraction of roof; weight for urban landunit distribution. |
|
|
|
|
|
Fraction of pervious road; weight for pervious surface distribution. |
|
|
|
|
|
VIC Ws parameter for the ARNO Curve; maximum soil moisture storage. |
|
|
|
|
|
Decay factor for finundated; controls inundated area decay with water table. |
|
|
|
|
|
Agricultural fire peak month; seasonal indicator for fire occurrence. |
|
|
|
|
|
Average depth to bedrock of the subgrid; critical for groundwater dynamics. |
|
|
|
|
|
VIC b parameter for the Variable Infiltration Capacity Curve; infiltration nonlinearity. |
|
|
|
|
|
Fraction of each grid cell that is land (0–1); used to weight surface properties; a missing variable causes a fatal error. |
|
|
|
|
|
GDP (parameter); economic/anthropogenic activity indicator. |
|
|
|
|
|
Binary mask (1 = land, 0 = not-land) defining which grid cells are part of the land model; read from the surface file or domain file. |
|
|
|
|
|
Scalar parameter for rainfall-driven hillslope erosion; controls erosion from precipitation. |
|
|
|
|
|
Scalar parameter for runoff-driven hillslope erosion; controls erosion from surface runoff. |
|
|
|
|
|
Scalar parameter for transport capacity of hillslope overland flow; controls sediment transport capacity. |
|
|
|
|
|
Peatland fraction; fraction of grid cell area classified as peat soils. |
|
|
|
|
|
Number of topounits in each grid cell; if absent, the number of topounits is set to 1. |
|
|
|
|
|
Unstructured grid coordinates (e.g., MPAS x) when using an irregular mesh; the code reads them only if they exist. |
|
|
|
|
|
Unstructured grid coordinates (e.g., MPAS y) when using an irregular mesh; the code reads them only if they exist. |
Variables by context¶
Context: anthropogenic¶
Variable |
Dimensions |
Units |
Required level |
Contexts |
Description |
|---|---|---|---|---|---|
|
|
|
|
|
GDP (parameter); economic/anthropogenic activity indicator. |
Context: biogeochemistry¶
Variable |
Dimensions |
Units |
Required level |
Contexts |
Description |
|---|---|---|---|---|---|
|
|
|
|
|
EF1 isoprene emission factor for broadleaf tree (BTR); vegetation-dependent emission rate. |
|
|
|
|
|
EF1 isoprene emission factor for crop (CRP); vegetation-dependent emission rate. |
|
|
|
|
|
EF1 isoprene emission factor for deciduous forest (FDT); vegetation-dependent emission rate. |
|
|
|
|
|
EF1 isoprene emission factor for evergreen forest (FET); vegetation-dependent emission rate. |
|
|
|
|
|
EF1 isoprene emission factor for grass (GRS); vegetation-dependent emission rate. |
|
|
|
|
|
EF1 isoprene emission factor for shrub (SHR); vegetation-dependent emission rate. |
Context: core¶
Variable |
Dimensions |
Units |
Required level |
Contexts |
Description |
|---|---|---|---|---|---|
|
|
|
|
|
Area (m2) of each land grid cell; used to weight land-surface properties and to compare with domain/topography. |
|
|
|
|
|
Fraction of each grid cell that is land (0–1); used to weight surface properties; a missing variable causes a fatal error. |
|
|
|
|
|
Fraction (0–1) of the global gridcell that is land in the PFT landunit; used to weight PFT tiles relative to the gridcell. |
|
|
|
|
|
Binary mask (1 = land, 0 = not-land) defining which grid cells are part of the land model; read from the surface file or domain file. |
|
|
|
|
|
Latitude (degrees) of the centre of each land grid cell. |
|
|
|
|
|
Longitude (degrees) of the centre of each land grid cell; used to compare the surface file with the domain and topography files. |
|
|
|
|
|
Mask marking land grid cells that contain valid plant functional type (PFT) data; if missing the code stops with an error. |
|
|
|
|
|
Fraction of each grid cell that is land (0–1); used to weight surface properties; a missing variable causes a fatal error. |
|
|
|
|
|
Binary mask (1 = land, 0 = not-land) defining which grid cells are part of the land model; read from the surface file or domain file. |
Context: crops_irrigation¶
Variable |
Dimensions |
Units |
Required level |
Contexts |
Description |
|---|---|---|---|---|---|
|
|
|
|
|
Fraction of irrigation water applied via ground/sprinkler/drip; complements FSURF. (Requirement: Required when firrig_data is true; optional otherwise) |
|
|
|
|
|
Fraction (0–1) of cropland that is irrigated; read only when irrigation data are enabled (firrig_data). (Requirement: Required when firrig_data is true; optional otherwise) |
|
|
|
|
|
Fraction of irrigation water applied via surface irrigation; required with FIRRIG when irrigation data are used. (Requirement: Required when firrig_data is true; optional otherwise) |
|
|
|
|
|
Nitrogen fertilizer application for each crop functional type; if absent, values default to zero. (Requirement: Optional (values default to zero when absent)) |
|
|
|
|
|
Fraction of vegetated area allocated to each crop functional type; code aborts if missing when cft dimension exists. (Requirement: Required when the surface file includes crop functional types (cft_size > 0)) |
|
|
|
|
|
Percent of grid cell area covered by cropland. |
|
|
|
|
|
Phosphorus fertilizer application for each crop functional type; treated like NFERT. |
Context: disturbance¶
Variable |
Dimensions |
Units |
Required level |
Contexts |
Description |
|---|---|---|---|---|---|
|
|
|
|
|
Agricultural fire peak month; seasonal indicator for fire occurrence. |
|
|
|
|
|
Scalar parameter for rainfall-driven hillslope erosion; controls erosion from precipitation. |
|
|
|
|
|
Scalar parameter for runoff-driven hillslope erosion; controls erosion from surface runoff. |
|
|
|
|
|
Scalar parameter for transport capacity of hillslope overland flow; controls sediment transport capacity. |
Context: glaciers¶
Variable |
Dimensions |
Units |
Required level |
Contexts |
Description |
|---|---|---|---|---|---|
|
|
|
|
|
Glacier mask read from a separate glacier file; ensures that glacier cells are a subset of the land mask. (Requirement: Optional (only used when a glacier mask file is provided)) |
|
|
|
|
|
Integer glacier elevation-class index for each grid cell when using mechanistic glacier (MEC) landunits. (Requirement: Required when glacier MEC landunits are used; optional otherwise) |
|
|
|
|
|
Fraction of grid cell area covered by simple glacier landunits within each topounit. (Requirement: Required unless glacier MEC landunits are used; optional when create_glacier_mec_landunit is true) |
|
|
|
|
|
Percent of grid cell area assigned to mechanistic glacier classes (accumulation/ablation, etc.). (Requirement: Required when glacier MEC landunits are created; optional otherwise) |
|
|
|
|
|
Elevation (m) of each mechanistic glacier class. (Requirement: Required when glacier MEC landunits are used; optional otherwise) |
Context: grid_topography¶
Variable |
Dimensions |
Units |
Required level |
Contexts |
Description |
|---|---|---|---|---|---|
|
|
|
|
|
Area (m2) of each land grid cell; used to weight land-surface properties and to compare with domain/topography. |
|
|
|
|
|
Maximum topounits elevation in each grid cell; a summary statistic reflecting the highest elevation among topounits. (Requirement: Optional (not required, but improves topounit characterization)) |
|
|
|
|
|
sin(slope) * cos(aspect) for each grid cell; used in solar-radiation calculations. (Requirement: Required when TOP solar-radiation is used; optional otherwise) |
|
|
|
|
|
sin(slope) * sin(aspect) for each grid cell; used with SINSL_COSAS. (Requirement: Required when TOP solar-radiation is used; optional otherwise) |
|
|
|
|
|
Sky-view factor (0–1) describing horizon obstruction by surrounding terrain; needed by the TOP solar-radiation scheme. (Requirement: Required when TOP solar-radiation is used; optional otherwise) |
|
|
|
|
|
Mean surface slope (degrees) for each land grid cell; used in topographic and hydrologic parameterizations. |
|
|
|
|
|
Slope at quantiles (minimum and 10 to 100 percentile); topographic distribution parameter. |
|
|
|
|
|
Standard deviation of elevation (m) used by the TOP solar-radiation parameterization; if STDEV_ELEV is missing the code tries STD_ELEV. (Requirement: Required when TOP solar-radiation is used; optional otherwise) |
|
|
|
|
|
Standard deviation of elevation (m) used by the TOP solar-radiation parameterization; alternative name to STDEV_ELEV. (Requirement: Required when TOP solar-radiation is used; optional otherwise) |
|
|
|
|
|
Terrain configuration parameter used in the TOP scheme to account for terrain-induced shading. (Requirement: Required when TOP solar-radiation is used; optional otherwise) |
|
|
|
|
|
Mean elevation (m) of each land grid cell read from the topography file; required by surfrd_get_topo. |
|
|
|
|
|
Weighted average of topounits elevation in each grid cell; a summary statistic for topounit-based elevation characterization. |
|
|
|
|
|
Elevation (m) of each mechanistic glacier class. (Requirement: Required when glacier MEC landunits are used; optional otherwise) |
|
|
|
|
|
Aspect (azimuth) of each topounit; optional and unused by default. |
|
|
|
|
|
Average elevation (m) of each topounit; optional if available. |
|
|
|
|
|
Average elevation (m) of each topounit; optional if available. |
|
|
|
|
|
Fraction of the grid cell’s area represented by each topounit; read only if present. |
|
|
|
|
|
Slope (degrees) of each topounit; not currently used but may improve topographic representation. |
|
|
|
|
|
Average depth to bedrock of the subgrid; critical for groundwater dynamics. |
|
|
|
|
|
Scalar parameter for rainfall-driven hillslope erosion; controls erosion from precipitation. |
|
|
|
|
|
Scalar parameter for runoff-driven hillslope erosion; controls erosion from surface runoff. |
|
|
|
|
|
Scalar parameter for transport capacity of hillslope overland flow; controls sediment transport capacity. |
|
|
|
|
|
Number of topounits in each grid cell; if absent, the number of topounits is set to 1. |
Context: hydrology¶
Variable |
Dimensions |
Units |
Required level |
Contexts |
Description |
|---|---|---|---|---|---|
|
|
|
|
|
VIC Ds parameter for the ARNO curve; fractional saturated area infiltration parameter. |
|
|
|
|
|
VIC Dsmax parameter for the ARNO curve; maximum infiltration rate. |
|
|
|
|
|
Maximum gridcell fractional inundated area; controls wetland extent. |
|
|
|
|
|
Maximum fractional saturated area; upper bound on inundation fraction. |
|
|
|
|
|
Lake depth; average water depth for lake landunit. |
|
|
|
|
|
Coefficient for qflx_surf_lag for finundated; surface runoff delay parameter. |
|
|
|
|
|
VIC Ws parameter for the ARNO Curve; maximum soil moisture storage. |
|
|
|
|
|
Decay factor for finundated; controls inundated area decay with water table. |
|
|
|
|
|
VIC b parameter for the Variable Infiltration Capacity Curve; infiltration nonlinearity. |
|
|
|
|
|
Scalar parameter for runoff-driven hillslope erosion; controls erosion from surface runoff. |
|
|
|
|
|
Scalar parameter for transport capacity of hillslope overland flow; controls sediment transport capacity. |
Context: inland_water¶
Variable |
Dimensions |
Units |
Required level |
Contexts |
Description |
|---|---|---|---|---|---|
|
|
|
|
|
Maximum gridcell fractional inundated area; controls wetland extent. |
|
|
|
|
|
Lake depth; average water depth for lake landunit. |
|
|
|
|
|
Percentage of each grid cell area that is lake within each topounit; used for lake landunit weighting. |
|
|
|
|
|
Percentage (0–100) of each grid cell area covered by wetlands within each topounit. |
Context: land_cover¶
Variable |
Dimensions |
Units |
Required level |
Contexts |
Description |
|---|---|---|---|---|---|
|
|
|
|
|
Fraction of each grid cell that is land (0–1); used to weight surface properties; a missing variable causes a fatal error. |
|
|
|
|
|
Fraction (0–1) of the global gridcell that is land in the PFT landunit; used to weight PFT tiles relative to the gridcell. |
|
|
|
|
|
Fraction of vegetated area allocated to each crop functional type; code aborts if missing when cft dimension exists. (Requirement: Required when the surface file includes crop functional types (cft_size > 0)) |
|
|
|
|
|
Percent of grid cell area covered by cropland. |
|
|
|
|
|
Fraction of natural vegetation that is flat-centered polygons. (Requirement: Required when use_polygonal_tundra is true; optional otherwise) |
|
|
|
|
|
Fraction of grid cell area covered by simple glacier landunits within each topounit. (Requirement: Required unless glacier MEC landunits are used; optional when create_glacier_mec_landunit is true) |
|
|
|
|
|
Percent of grid cell area assigned to mechanistic glacier classes (accumulation/ablation, etc.). (Requirement: Required when glacier MEC landunits are created; optional otherwise) |
|
|
|
|
|
Fraction of natural vegetation landunit that is high-centered polygons (polygonal tundra). (Requirement: Required when use_polygonal_tundra is true; optional otherwise) |
|
|
|
|
|
Percentage of each grid cell area that is lake within each topounit; used for lake landunit weighting. |
|
|
|
|
|
Fraction of natural vegetation that is low-centered polygons. (Requirement: Required when use_polygonal_tundra is true; optional otherwise) |
|
|
|
|
|
Percent of grid cell area covered by natural vegetation (non-crop vegetated landunit). |
|
|
|
|
|
Fraction of vegetated area allocated to each natural plant functional type; code aborts if missing. |
|
|
|
|
|
Fraction of each grid cell that is urban, for each density class in the multi-density urban scheme. (Requirement: Required when the multi-density urban model is used (nlevurb > 0); optional otherwise) |
|
|
|
|
|
Percentage (0–100) of each grid cell area covered by wetlands within each topounit. |
|
|
|
|
|
Mask marking land grid cells that contain valid plant functional type (PFT) data; if missing the code stops with an error. |
|
|
|
|
|
Agricultural fire peak month; seasonal indicator for fire occurrence. |
|
|
|
|
|
Fraction of each grid cell that is land (0–1); used to weight surface properties; a missing variable causes a fatal error. |
|
|
|
|
|
Peatland fraction; fraction of grid cell area classified as peat soils. |
Context: phosphorus_cycle¶
Variable |
Dimensions |
Units |
Required level |
Contexts |
Description |
|---|---|---|---|---|---|
|
|
|
|
|
Apatite phosphorus; soil phosphorus pool in apatite (primary mineral) form; used by phosphorus biogeochemistry when enabled. |
|
|
|
|
|
Labile inorganic phosphorus; soil labile (readily available) phosphorus pool; used by P-cycle parameterizations. |
|
|
|
|
|
Occluded phosphorus; soil occluded phosphorus pool (sorbed or otherwise inaccessible); part of multi-pool P parameterization. |
|
|
|
|
|
Phosphorus fertilizer application for each crop functional type; treated like NFERT. |
|
|
|
|
|
Secondary mineral phosphorus; soil secondary mineral phosphorus pool; intermediate in reactivity between apatite and labile pools. |
Context: polygonal_tundra¶
Variable |
Dimensions |
Units |
Required level |
Contexts |
Description |
|---|---|---|---|---|---|
|
|
|
|
|
Fraction of natural vegetation that is flat-centered polygons. (Requirement: Required when use_polygonal_tundra is true; optional otherwise) |
|
|
|
|
|
Fraction of natural vegetation landunit that is high-centered polygons (polygonal tundra). (Requirement: Required when use_polygonal_tundra is true; optional otherwise) |
|
|
|
|
|
Fraction of natural vegetation that is low-centered polygons. (Requirement: Required when use_polygonal_tundra is true; optional otherwise) |
Context: soil_properties¶
Variable |
Dimensions |
Units |
Required level |
Contexts |
Description |
|---|---|---|---|---|---|
|
|
|
|
|
Organic matter density per soil layer; used in biogeochemical and thermal calculations. |
|
|
|
|
|
Soil clay percentage by mass (0–100) in each soil layer; controls hydraulic and thermal properties. |
|
|
|
|
|
Percent gravel content (0–100) in each soil layer; affects soil water storage and hydraulic conductivity. |
|
|
|
|
|
Soil sand percentage by mass (0–100) in each soil layer; controls hydraulic and thermal properties. |
|
|
|
|
|
Soil color; categorical index affecting soil albedo parameterization. |
|
|
|
|
|
Soil order; categorical soil classification for pedogenic properties. |
|
|
|
|
|
Average depth to bedrock of the subgrid; critical for groundwater dynamics. |
|
|
|
|
|
Peatland fraction; fraction of grid cell area classified as peat soils. |
Context: topographic_radiation¶
Variable |
Dimensions |
Units |
Required level |
Contexts |
Description |
|---|---|---|---|---|---|
|
|
|
|
|
sin(slope) * cos(aspect) for each grid cell; used in solar-radiation calculations. (Requirement: Required when TOP solar-radiation is used; optional otherwise) |
|
|
|
|
|
sin(slope) * sin(aspect) for each grid cell; used with SINSL_COSAS. (Requirement: Required when TOP solar-radiation is used; optional otherwise) |
|
|
|
|
|
Sky-view factor (0–1) describing horizon obstruction by surrounding terrain; needed by the TOP solar-radiation scheme. (Requirement: Required when TOP solar-radiation is used; optional otherwise) |
|
|
|
|
|
Standard deviation of elevation (m) used by the TOP solar-radiation parameterization; if STDEV_ELEV is missing the code tries STD_ELEV. (Requirement: Required when TOP solar-radiation is used; optional otherwise) |
|
|
|
|
|
Standard deviation of elevation (m) used by the TOP solar-radiation parameterization; alternative name to STDEV_ELEV. (Requirement: Required when TOP solar-radiation is used; optional otherwise) |
|
|
|
|
|
Terrain configuration parameter used in the TOP scheme to account for terrain-induced shading. (Requirement: Required when TOP solar-radiation is used; optional otherwise) |
Context: topounits¶
Variable |
Dimensions |
Units |
Required level |
Contexts |
Description |
|---|---|---|---|---|---|
|
|
|
|
|
Diffuse albedo of impervious road; spectral-dependent surface reflectance for urban impervious surfaces. |
|
|
|
|
|
Direct albedo of impervious road; spectral-dependent surface reflectance for urban impervious surfaces. |
|
|
|
|
|
Diffuse albedo of pervious road; spectral-dependent surface reflectance for urban pervious surfaces. |
|
|
|
|
|
Direct albedo of pervious road; spectral-dependent surface reflectance for urban pervious surfaces. |
|
|
|
|
|
Diffuse albedo of roof; spectral-dependent surface reflectance for urban roof surfaces. |
|
|
|
|
|
Direct albedo of roof; spectral-dependent surface reflectance for urban roof surfaces. |
|
|
|
|
|
Diffuse albedo of wall; spectral-dependent surface reflectance for urban wall surfaces. |
|
|
|
|
|
Direct albedo of wall; spectral-dependent surface reflectance for urban wall surfaces. |
|
|
|
|
|
Apatite phosphorus; soil phosphorus pool in apatite (primary mineral) form; used by phosphorus biogeochemistry when enabled. |
|
|
|
|
|
Canyon height to width ratio; urban geometric parameter affecting radiation and wind. |
|
|
|
|
|
Volumetric heat capacity of impervious road; thermal mass property affecting diurnal temperature variations. |
|
|
|
|
|
Volumetric heat capacity of roof; thermal mass property affecting building heat dynamics. |
|
|
|
|
|
Volumetric heat capacity of wall; thermal mass property affecting wall temperature dynamics. |
|
|
|
|
|
VIC Ds parameter for the ARNO curve; fractional saturated area infiltration parameter. |
|
|
|
|
|
VIC Dsmax parameter for the ARNO curve; maximum infiltration rate. |
|
|
|
|
|
EF1 isoprene emission factor for broadleaf tree (BTR); vegetation-dependent emission rate. |
|
|
|
|
|
EF1 isoprene emission factor for crop (CRP); vegetation-dependent emission rate. |
|
|
|
|
|
EF1 isoprene emission factor for deciduous forest (FDT); vegetation-dependent emission rate. |
|
|
|
|
|
EF1 isoprene emission factor for evergreen forest (FET); vegetation-dependent emission rate. |
|
|
|
|
|
EF1 isoprene emission factor for grass (GRS); vegetation-dependent emission rate. |
|
|
|
|
|
EF1 isoprene emission factor for shrub (SHR); vegetation-dependent emission rate. |
|
|
|
|
|
Emissivity of impervious road; controls longwave radiation emission from urban surfaces. |
|
|
|
|
|
Emissivity of pervious road; controls longwave radiation emission from pervious urban surfaces. |
|
|
|
|
|
Emissivity of roof; controls longwave radiation emission from building roof. |
|
|
|
|
|
Emissivity of wall; controls longwave radiation emission from building walls. |
|
|
|
|
|
Maximum gridcell fractional inundated area; controls wetland extent. |
|
|
|
|
|
Fraction of irrigation water applied via ground/sprinkler/drip; complements FSURF. (Requirement: Required when firrig_data is true; optional otherwise) |
|
|
|
|
|
Fraction (0–1) of cropland that is irrigated; read only when irrigation data are enabled (firrig_data). (Requirement: Required when firrig_data is true; optional otherwise) |
|
|
|
|
|
Maximum fractional saturated area; upper bound on inundation fraction. |
|
|
|
|
|
Fraction of irrigation water applied via surface irrigation; required with FIRRIG when irrigation data are used. (Requirement: Required when firrig_data is true; optional otherwise) |
|
|
|
|
|
Height of roof; geometric property defining building structure. |
|
|
|
|
|
Labile inorganic phosphorus; soil labile (readily available) phosphorus pool; used by P-cycle parameterizations. |
|
|
|
|
|
Lake depth; average water depth for lake landunit. |
|
|
|
|
|
Monthly climatology of canopy bottom height (m) for vegetated landunits. |
|
|
|
|
|
Monthly climatology of canopy top height (m) for vegetated landunits. |
|
|
|
|
|
Leaf area index (LAI; m2 leaf per m2 ground) monthly climatology; time is typically 12 months. |
|
|
|
|
|
Stem area index (SAI) monthly climatology; time is typically 12 months. |
|
|
|
|
|
Maximum topounits elevation in each grid cell; a summary statistic reflecting the highest elevation among topounits. (Requirement: Optional (not required, but improves topounit characterization)) |
|
|
|
|
|
Nitrogen fertilizer application for each crop functional type; if absent, values default to zero. (Requirement: Optional (values default to zero when absent)) |
|
|
|
|
|
Number of impervious road layers; structural discretization for temperature calculation. |
|
|
|
|
|
Occluded phosphorus; soil occluded phosphorus pool (sorbed or otherwise inaccessible); part of multi-pool P parameterization. |
|
|
|
|
|
Organic matter density per soil layer; used in biogeochemical and thermal calculations. |
|
|
|
|
|
Coefficient for qflx_surf_lag for finundated; surface runoff delay parameter. |
|
|
|
|
|
Fraction of vegetated area allocated to each crop functional type; code aborts if missing when cft dimension exists. (Requirement: Required when the surface file includes crop functional types (cft_size > 0)) |
|
|
|
|
|
Soil clay percentage by mass (0–100) in each soil layer; controls hydraulic and thermal properties. |
|
|
|
|
|
Percent of grid cell area covered by cropland. |
|
|
|
|
|
Fraction of natural vegetation that is flat-centered polygons. (Requirement: Required when use_polygonal_tundra is true; optional otherwise) |
|
|
|
|
|
Fraction of grid cell area covered by simple glacier landunits within each topounit. (Requirement: Required unless glacier MEC landunits are used; optional when create_glacier_mec_landunit is true) |
|
|
|
|
|
Percent of grid cell area assigned to mechanistic glacier classes (accumulation/ablation, etc.). (Requirement: Required when glacier MEC landunits are created; optional otherwise) |
|
|
|
|
|
Percent gravel content (0–100) in each soil layer; affects soil water storage and hydraulic conductivity. |
|
|
|
|
|
Fraction of natural vegetation landunit that is high-centered polygons (polygonal tundra). (Requirement: Required when use_polygonal_tundra is true; optional otherwise) |
|
|
|
|
|
Percentage of each grid cell area that is lake within each topounit; used for lake landunit weighting. |
|
|
|
|
|
Fraction of natural vegetation that is low-centered polygons. (Requirement: Required when use_polygonal_tundra is true; optional otherwise) |
|
|
|
|
|
Percent of grid cell area covered by natural vegetation (non-crop vegetated landunit). |
|
|
|
|
|
Fraction of vegetated area allocated to each natural plant functional type; code aborts if missing. |
|
|
|
|
|
Soil sand percentage by mass (0–100) in each soil layer; controls hydraulic and thermal properties. |
|
|
|
|
|
Fraction of each grid cell that is urban, for each density class in the multi-density urban scheme. (Requirement: Required when the multi-density urban model is used (nlevurb > 0); optional otherwise) |
|
|
|
|
|
Percentage (0–100) of each grid cell area covered by wetlands within each topounit. |
|
|
|
|
|
Phosphorus fertilizer application for each crop functional type; treated like NFERT. |
|
|
|
|
|
Secondary mineral phosphorus; soil secondary mineral phosphorus pool; intermediate in reactivity between apatite and labile pools. |
|
|
|
|
|
Slope at quantiles (minimum and 10 to 100 percentile); topographic distribution parameter. |
|
|
|
|
|
Soil color; categorical index affecting soil albedo parameterization. |
|
|
|
|
|
Soil order; categorical soil classification for pedogenic properties. |
|
|
|
|
|
Thickness of roof; structural property affecting heat capacity. |
|
|
|
|
|
Thickness of wall; structural property affecting heat capacity. |
|
|
|
|
|
Thermal conductivity of impervious road; controls heat diffusion through urban surface layers. |
|
|
|
|
|
Thermal conductivity of roof; controls heat transfer through building roof material. |
|
|
|
|
|
Thermal conductivity of wall; controls heat transfer through building wall material. |
|
|
|
|
|
Weighted average of topounits elevation in each grid cell; a summary statistic for topounit-based elevation characterization. |
|
|
|
|
|
Elevation (m) of each mechanistic glacier class. (Requirement: Required when glacier MEC landunits are used; optional otherwise) |
|
|
|
|
|
Maximum interior building temperature; upper limit constraint for urban heating/cooling. |
|
|
|
|
|
Minimum interior building temperature; lower limit constraint for urban heating/cooling. |
|
|
|
|
|
Aspect (azimuth) of each topounit; optional and unused by default. |
|
|
|
|
|
Average elevation (m) of each topounit; optional if available. |
|
|
|
|
|
Average elevation (m) of each topounit; optional if available. |
|
|
|
|
|
Fraction of the grid cell’s area represented by each topounit; read only if present. |
|
|
|
|
|
Slope (degrees) of each topounit; not currently used but may improve topographic representation. |
|
|
|
|
|
Integer identifier linking urban grid cells to regional urban morphology datasets. (Requirement: Required when PCT_URBAN is used; optional otherwise) |
|
|
|
|
|
Height of wind in canyon; reference height for urban wind profile. |
|
|
|
|
|
Fraction of roof; weight for urban landunit distribution. |
|
|
|
|
|
Fraction of pervious road; weight for pervious surface distribution. |
|
|
|
|
|
VIC Ws parameter for the ARNO Curve; maximum soil moisture storage. |
|
|
|
|
|
Decay factor for finundated; controls inundated area decay with water table. |
|
|
|
|
|
Agricultural fire peak month; seasonal indicator for fire occurrence. |
|
|
|
|
|
Average depth to bedrock of the subgrid; critical for groundwater dynamics. |
|
|
|
|
|
VIC b parameter for the Variable Infiltration Capacity Curve; infiltration nonlinearity. |
|
|
|
|
|
GDP (parameter); economic/anthropogenic activity indicator. |
|
|
|
|
|
Scalar parameter for rainfall-driven hillslope erosion; controls erosion from precipitation. |
|
|
|
|
|
Scalar parameter for runoff-driven hillslope erosion; controls erosion from surface runoff. |
|
|
|
|
|
Scalar parameter for transport capacity of hillslope overland flow; controls sediment transport capacity. |
|
|
|
|
|
Peatland fraction; fraction of grid cell area classified as peat soils. |
|
|
|
|
|
Number of topounits in each grid cell; if absent, the number of topounits is set to 1. |
Context: unstructured_grid¶
Variable |
Dimensions |
Units |
Required level |
Contexts |
Description |
|---|---|---|---|---|---|
|
|
|
|
|
Unstructured grid coordinates (e.g., MPAS x) when using an irregular mesh; the code reads them only if they exist. |
|
|
|
|
|
Unstructured grid coordinates (e.g., MPAS y) when using an irregular mesh; the code reads them only if they exist. |
Context: urban¶
Variable |
Dimensions |
Units |
Required level |
Contexts |
Description |
|---|---|---|---|---|---|
|
|
|
|
|
Diffuse albedo of impervious road; spectral-dependent surface reflectance for urban impervious surfaces. |
|
|
|
|
|
Direct albedo of impervious road; spectral-dependent surface reflectance for urban impervious surfaces. |
|
|
|
|
|
Diffuse albedo of pervious road; spectral-dependent surface reflectance for urban pervious surfaces. |
|
|
|
|
|
Direct albedo of pervious road; spectral-dependent surface reflectance for urban pervious surfaces. |
|
|
|
|
|
Diffuse albedo of roof; spectral-dependent surface reflectance for urban roof surfaces. |
|
|
|
|
|
Direct albedo of roof; spectral-dependent surface reflectance for urban roof surfaces. |
|
|
|
|
|
Diffuse albedo of wall; spectral-dependent surface reflectance for urban wall surfaces. |
|
|
|
|
|
Direct albedo of wall; spectral-dependent surface reflectance for urban wall surfaces. |
|
|
|
|
|
Canyon height to width ratio; urban geometric parameter affecting radiation and wind. |
|
|
|
|
|
Volumetric heat capacity of impervious road; thermal mass property affecting diurnal temperature variations. |
|
|
|
|
|
Volumetric heat capacity of roof; thermal mass property affecting building heat dynamics. |
|
|
|
|
|
Volumetric heat capacity of wall; thermal mass property affecting wall temperature dynamics. |
|
|
|
|
|
Emissivity of impervious road; controls longwave radiation emission from urban surfaces. |
|
|
|
|
|
Emissivity of pervious road; controls longwave radiation emission from pervious urban surfaces. |
|
|
|
|
|
Emissivity of roof; controls longwave radiation emission from building roof. |
|
|
|
|
|
Emissivity of wall; controls longwave radiation emission from building walls. |
|
|
|
|
|
Height of roof; geometric property defining building structure. |
|
|
|
|
|
Number of impervious road layers; structural discretization for temperature calculation. |
|
|
|
|
|
Fraction of each grid cell that is urban, for each density class in the multi-density urban scheme. (Requirement: Required when the multi-density urban model is used (nlevurb > 0); optional otherwise) |
|
|
|
|
|
Thickness of roof; structural property affecting heat capacity. |
|
|
|
|
|
Thickness of wall; structural property affecting heat capacity. |
|
|
|
|
|
Thermal conductivity of impervious road; controls heat diffusion through urban surface layers. |
|
|
|
|
|
Thermal conductivity of roof; controls heat transfer through building roof material. |
|
|
|
|
|
Thermal conductivity of wall; controls heat transfer through building wall material. |
|
|
|
|
|
Maximum interior building temperature; upper limit constraint for urban heating/cooling. |
|
|
|
|
|
Minimum interior building temperature; lower limit constraint for urban heating/cooling. |
|
|
|
|
|
Integer identifier linking urban grid cells to regional urban morphology datasets. (Requirement: Required when PCT_URBAN is used; optional otherwise) |
|
|
|
|
|
Height of wind in canyon; reference height for urban wind profile. |
|
|
|
|
|
Fraction of roof; weight for urban landunit distribution. |
|
|
|
|
|
Fraction of pervious road; weight for pervious surface distribution. |
Context: vegetation_structure¶
Variable |
Dimensions |
Units |
Required level |
Contexts |
Description |
|---|---|---|---|---|---|
|
|
|
|
|
EF1 isoprene emission factor for broadleaf tree (BTR); vegetation-dependent emission rate. |
|
|
|
|
|
EF1 isoprene emission factor for crop (CRP); vegetation-dependent emission rate. |
|
|
|
|
|
EF1 isoprene emission factor for deciduous forest (FDT); vegetation-dependent emission rate. |
|
|
|
|
|
EF1 isoprene emission factor for evergreen forest (FET); vegetation-dependent emission rate. |
|
|
|
|
|
EF1 isoprene emission factor for grass (GRS); vegetation-dependent emission rate. |
|
|
|
|
|
EF1 isoprene emission factor for shrub (SHR); vegetation-dependent emission rate. |
|
|
|
|
|
Monthly climatology of canopy bottom height (m) for vegetated landunits. |
|
|
|
|
|
Monthly climatology of canopy top height (m) for vegetated landunits. |
|
|
|
|
|
Leaf area index (LAI; m2 leaf per m2 ground) monthly climatology; time is typically 12 months. |
|
|
|
|
|
Stem area index (SAI) monthly climatology; time is typically 12 months. |