Skip to content

Group canopy_options

Modules > canopy_options

Configuration options and user-settable parameters for canopy model.

Public Attributes

Type Name
integer canopy_canopts_mod::aq_opt
Air quality stress index option.
real(rk) canopy_canopts_mod::bio_cce
MEGAN biogenic emission canopy environment coefficient.
integer canopy_canopts_mod::biospec_opt
Biogenic species output option.
integer canopy_canopts_mod::biovert_opt
MEGAN vertical integration option.
real(rk) canopy_canopts_mod::can_cfset
Default canopy vegetation fraction.
real(rk) canopy_canopts_mod::can_chset
Default canopy vegetation height.
real(rk) canopy_canopts_mod::can_laiset
Default canopy LAI.
integer canopy_canopts_mod::can_opt
Canopy data source option.
real(rk) canopy_canopts_mod::cf_thresh
Canopy fraction threshold.
real(rk) canopy_canopts_mod::ch_thresh
Canopy height threshold.
integer canopy_canopts_mod::chemmechgas_opt
Chemical mechanism option.
integer canopy_canopts_mod::chemmechgas_tot
Total chemical mechanism species.
integer canopy_canopts_mod::co2_opt
CO₂ inhibition option for isoprene.
real(rk) canopy_canopts_mod::co2_set
Atmospheric CO₂ concentration.
real(rk) canopy_canopts_mod::crop_cfset
Default crop vegetation fraction.
real(rk) canopy_canopts_mod::crop_chset
Default crop height.
real(rk) canopy_canopts_mod::crop_laiset
Default crop LAI.
integer canopy_canopts_mod::crop_opt
Crop vegetation option.
integer canopy_canopts_mod::ddepspecgas_opt
Dry deposition species output option.
integer canopy_canopts_mod::dx_opt
Grid resolution option.
real(rk) canopy_canopts_mod::dx_set
User set grid cell resolution.
integer canopy_canopts_mod::flameh_cal
FRP to flame height relationship.
integer canopy_canopts_mod::flameh_opt
Flame height calculation option.
real(rk) canopy_canopts_mod::flameh_set
User set flame height.
real(rk) canopy_canopts_mod::frp_fac
FRP tuning factor.
real(rk) canopy_canopts_mod::gamma_set
Reaction probability for building surfaces.
integer canopy_canopts_mod::hist_opt
Historical averaging option.
integer canopy_canopts_mod::href_opt
Reference height option.
real(rk) canopy_canopts_mod::href_set
Set reference height above canopy.
integer canopy_canopts_mod::ht_opt
High temperature stress index option.
integer canopy_canopts_mod::hw_opt
High wind stress index option.
real(rk) canopy_canopts_mod::hyblev1
First hybrid model layer height.
real(rk) canopy_canopts_mod::icec_set
Ice cover threshold.
logical canopy_canopts_mod::ifcanbio
Canopy biogenic emissions option.
logical canopy_canopts_mod::ifcanddepgas
Canopy gas dry deposition option.
logical canopy_canopts_mod::ifcaneddy
Canopy eddy Kz option.
logical canopy_canopts_mod::ifcanphot
Canopy photolysis attenuation option.
logical canopy_canopts_mod::ifcanwaf
Canopy WAF option.
logical canopy_canopts_mod::ifcanwind
Canopy wind option.
integer canopy_canopts_mod::infmt_opt
Input file format option.
real(rk) canopy_canopts_mod::lai_thresh
LAI threshold for canopy conditions.
integer canopy_canopts_mod::lai_tstep
LAI timestep.
real(rk) canopy_canopts_mod::lambdars
Roughness sublayer influence parameter.
integer canopy_canopts_mod::leafage_opt
Leaf age factor option.
real(rk) canopy_canopts_mod::lifetime
Above-canopy BVOC lifetime.
integer canopy_canopts_mod::loss_ind
Loss factor application index.
integer canopy_canopts_mod::loss_opt
Canopy loss ratios option.
real(rk) canopy_canopts_mod::loss_set
Constant canopy loss factor.
integer canopy_canopts_mod::lt_opt
Low temperature stress index option.
integer canopy_canopts_mod::lu_opt
Land use mapping option.
integer canopy_canopts_mod::pai_opt
PAI calculation option.
real(rk) canopy_canopts_mod::pai_set
Set PAI value.
integer canopy_canopts_mod::pavd_opt
3D GEDI PAVD profiles option
real(rk) canopy_canopts_mod::pavd_set
GEDI PAVD latitude threshold.
real(rk) canopy_canopts_mod::ramin_set
Minimum aerodynamic resistance.
integer canopy_canopts_mod::rsl_opt
Roughness sublayer option.
real(rk) canopy_canopts_mod::snowc_set
Snow cover threshold.
integer canopy_canopts_mod::soilcat_opt
Soil category option.
real(rk) canopy_canopts_mod::soild1
Soil layer 1 depth.
real(rk) canopy_canopts_mod::soild2
Soil layer 2 depth.
real(rk) canopy_canopts_mod::soild3
Soil layer 3 depth.
real(rk) canopy_canopts_mod::soild4
Soil layer 4 depth.
integer canopy_canopts_mod::soim_opt
Soil moisture factor option.
real(rk) canopy_canopts_mod::ssg_cfset
Default shrub/savanna/grassland vegetation fraction.
real(rk) canopy_canopts_mod::ssg_chset
Default shrub/savanna/grassland height.
real(rk) canopy_canopts_mod::ssg_laiset
Default shrub/savanna/grassland LAI.
integer canopy_canopts_mod::ssg_opt
Shrubs/savanna/grassland vegetation option.
integer canopy_canopts_mod::var3d_opt
3D variable input option
integer canopy_canopts_mod::var3d_set
Number of 3D levels in input file.
real(rk) canopy_canopts_mod::w126_set
Ozone W126 value.
integer canopy_canopts_mod::z0_opt
Surface roughness option.
real(rk) canopy_canopts_mod::z0ghc
Ground roughness to canopy height ratio.

Public Attributes Documentation

variable aq_opt

Air quality stress index option.

integer canopy_canopts_mod::aq_opt;

Set default integer for air quality stress index for gamma_aq in biogenic emissions


variable bio_cce

MEGAN biogenic emission canopy environment coefficient.

real(rk) canopy_canopts_mod::bio_cce;

MEGAN biogenic emission canopy environment coefficient

Parameters:

  • units dimensionless

variable biospec_opt

Biogenic species output option.

integer canopy_canopts_mod::biospec_opt;

Set default integer for species output option * 0 = all species (default) * 1 = selected species


variable biovert_opt

MEGAN vertical integration option.

integer canopy_canopts_mod::biovert_opt;

MEGAN vertical integration of emissions option * 0 = off (default) * 1 = on


variable can_cfset

Default canopy vegetation fraction.

real(rk) canopy_canopts_mod::can_cfset;

Set default value for canopy vegfrac used in model

Parameters:

  • units dimensionless fraction
  • default 0.5

variable can_chset

Default canopy vegetation height.

real(rk) canopy_canopts_mod::can_chset;

Set default value for canopy vegtype heights used in model

Parameters:

  • units meters (m)
  • default 1.0 m

variable can_laiset

Default canopy LAI.

real(rk) canopy_canopts_mod::can_laiset;

Set default value for canopy LAI used in model

Parameters:

  • units m²/m²
  • default 0.1

variable can_opt

Canopy data source option.

integer canopy_canopts_mod::can_opt;

Set default integer for canopy option from GEDI or user * 0 = GEDI data (default) * 1 = user-defined values


variable cf_thresh

Canopy fraction threshold.

real(rk) canopy_canopts_mod::cf_thresh;

User set grid cell canopy fraction threshold to apply canopy conditions

Parameters:

  • units dimensionless fraction

variable ch_thresh

Canopy height threshold.

real(rk) canopy_canopts_mod::ch_thresh;

User set grid cell canopy height threshold to apply canopy conditions

Parameters:

  • units meters (m)

variable chemmechgas_opt

Chemical mechanism option.

integer canopy_canopts_mod::chemmechgas_opt;

Set default integer value to select chemical mechanism * 0 = RACM2 (default)


variable chemmechgas_tot

Total chemical mechanism species.

integer canopy_canopts_mod::chemmechgas_tot;

Set default integer value to select chemical mechanism gas species list including transported

Parameters:

  • default 31 for RACM2

variable co2_opt

CO₂ inhibition option for isoprene.

integer canopy_canopts_mod::co2_opt;

Set default integer for CO₂ inhibition option for biogenic isoprene emissions * 0 = Possell & Hewitt (2011) (default) * 1 = alternative method


variable co2_set

Atmospheric CO₂ concentration.

real(rk) canopy_canopts_mod::co2_set;

Set default value for atmospheric CO₂ concentration for co2_opt

Parameters:

  • units ppmv
  • default 400.0 ppmv

variable crop_cfset

Default crop vegetation fraction.

real(rk) canopy_canopts_mod::crop_cfset;

Set default value for crop vegfrac used in model

Parameters:

  • units dimensionless fraction
  • default 0.5

variable crop_chset

Default crop height.

real(rk) canopy_canopts_mod::crop_chset;

Set default value for crop vegtype heights used in model

Parameters:

  • units meters (m)
  • default 3.0 m

variable crop_laiset

Default crop LAI.

real(rk) canopy_canopts_mod::crop_laiset;

Set default value for crop LAI used in model

Parameters:

  • units m²/m²
  • default 0.1

variable crop_opt

Crop vegetation option.

integer canopy_canopts_mod::crop_opt;

Set default integer for crop vegtype option from GEDI or user * 0 = GEDI data (default) * 1 = user-defined values


variable ddepspecgas_opt

Dry deposition species output option.

integer canopy_canopts_mod::ddepspecgas_opt;

Set default integer for species output option * 0 = all species (default) * 1 = selected species


variable dx_opt

Grid resolution option.

integer canopy_canopts_mod::dx_opt;

Integer for dx resolution values used or calculated * 0 = calculated (default) * 1 = use set value


variable dx_set

User set grid cell resolution.

real(rk) canopy_canopts_mod::dx_set;

User Set Grid Cell Resolution

Parameters:

  • units meters (m)

variable flameh_cal

FRP to flame height relationship.

integer canopy_canopts_mod::flameh_cal;

Integer for FRP (Fire Radiative Power) to flame height relationships used * 0 = default relationship * 1 = alternative relationship


variable flameh_opt

Flame height calculation option.

integer canopy_canopts_mod::flameh_opt;

Integer for flame height values used or calculated * 0 = calculated (default) * 1 = use set value


variable flameh_set

User set flame height.

real(rk) canopy_canopts_mod::flameh_set;

User Set Flame Height value

Parameters:

  • units meters (m)

variable frp_fac

FRP tuning factor.

real(rk) canopy_canopts_mod::frp_fac;

FRP tuning factor for flame height calculation

Parameters:

  • default 1.0

variable gamma_set

Reaction probability for building surfaces.

real(rk) canopy_canopts_mod::gamma_set;

Set default reaction probability for gas dry deposition to different building surfaces

Parameters:

  • units dimensionless
  • default 5.0D-5

variable hist_opt

Historical averaging option.

integer canopy_canopts_mod::hist_opt;

Set default integer for using historically averaged leaf temp and PAR for biogenic emissions * 0 = off (default) * 1 = on


variable href_opt

Reference height option.

integer canopy_canopts_mod::href_opt;

Integer for using set href in namelist (=0) or array from file(=1) * 0 = use namelist value (default) * 1 = read from file


variable href_set

Set reference height above canopy.

real(rk) canopy_canopts_mod::href_set;

Reference height above canopy at 10 m

Parameters:

  • units meters (m)
  • default 10.0 m

variable ht_opt

High temperature stress index option.

integer canopy_canopts_mod::ht_opt;

Set default integer for high temperature stress index for gamma_ht in biogenic emissions


variable hw_opt

High wind stress index option.

integer canopy_canopts_mod::hw_opt;

Set default integer for high wind stress index for gamma_hw in biogenic emissions


variable hyblev1

First hybrid model layer height.

real(rk) canopy_canopts_mod::hyblev1;

Set default approximate input height of 1st hybrid model layer above ground (used for temp lapse rate approximation)

Parameters:

  • units meters (m)
  • default 20.0 meters

variable icec_set

Ice cover threshold.

real(rk) canopy_canopts_mod::icec_set;

Set default ice cover percent at grid/point, above which ground or water surface is treated as dominant ice

Parameters:

  • units percent (%)
  • default 50%

variable ifcanbio

Canopy biogenic emissions option.

logical canopy_canopts_mod::ifcanbio;

Logical canopy biogenic emissions option

Parameters:

  • default .FALSE.

variable ifcanddepgas

Canopy gas dry deposition option.

logical canopy_canopts_mod::ifcanddepgas;

Logical canopy gas dry deposition option

Parameters:

  • default .FALSE.

variable ifcaneddy

Canopy eddy Kz option.

logical canopy_canopts_mod::ifcaneddy;

Logical canopy eddy diffusivity Kz option

Parameters:

  • default .FALSE.

variable ifcanphot

Canopy photolysis attenuation option.

logical canopy_canopts_mod::ifcanphot;

Logical canopy photolysis attenuation option

Parameters:

  • default .FALSE.

variable ifcanwaf

Canopy WAF option.

logical canopy_canopts_mod::ifcanwaf;

Logical canopy WAF (Wind Attenuation Factor) option

Parameters:

  • default .FALSE.

variable ifcanwind

Canopy wind option.

logical canopy_canopts_mod::ifcanwind;

Logical canopy wind option

Parameters:

  • default .FALSE.

variable infmt_opt

Input file format option.

integer canopy_canopts_mod::infmt_opt;

Integer for choosing 1D or 2D input file format * 0 = 2D format (default) * 1 = 1D format


variable lai_thresh

LAI threshold for canopy conditions.

real(rk) canopy_canopts_mod::lai_thresh;

User set grid cell LAI threshold to apply canopy conditions

Parameters:

  • units m²/m²

variable lai_tstep

LAI timestep.

integer canopy_canopts_mod::lai_tstep;

Set default timestep for LAI input

Parameters:

  • units seconds
  • default 86400 (daily), 2592000 for monthly

variable lambdars

Roughness sublayer influence parameter.

real(rk) canopy_canopts_mod::lambdars;

Value representing influence of roughness sublayer

Parameters:

  • units dimensionless

variable leafage_opt

Leaf age factor option.

integer canopy_canopts_mod::leafage_opt;

Set default for Leaf Age factor option for BVOCs * 1 = GAMMA_LEAFAGE = 1 (default)


variable lifetime

Above-canopy BVOC lifetime.

real(rk) canopy_canopts_mod::lifetime;

Set default value for above-canopy BVOC lifetime used with loss_opt=1

Parameters:

  • units seconds (s)
  • default 3600 s

variable loss_ind

Loss factor application index.

integer canopy_canopts_mod::loss_ind;

Set default integer for applying canopy loss factor to all species (=0) or only specific biogenics specie indices (> 0)


variable loss_opt

Canopy loss ratios option.

integer canopy_canopts_mod::loss_opt;

Set default integer for turning on canopy loss ratios for adjusting top of canopy net emissions * 0 = off (default) * 1 = use lifetime-based loss * 2 = use constant loss factor


variable loss_set

Constant canopy loss factor.

real(rk) canopy_canopts_mod::loss_set;

Set default value for constant canopy loss factor applied used with loss_opt=2

Parameters:

  • units dimensionless
  • default 0.96

variable lt_opt

Low temperature stress index option.

integer canopy_canopts_mod::lt_opt;

Set default integer for low temperature stress index for gamma_lt in biogenic emissions


variable lu_opt

Land use mapping option.

integer canopy_canopts_mod::lu_opt;

Integer for LU type from model mapped to Massman et al. * 0 = VIIRS (default) * 1 = other mapping


variable pai_opt

PAI calculation option.

integer canopy_canopts_mod::pai_opt;

Integer for PAI (Plant Area Index) values used or calculated * 0 = calculated from model (default) * 1 = use set value


variable pai_set

Set PAI value.

real(rk) canopy_canopts_mod::pai_set;

Real value for PAI set values used when pai_opt=1

Parameters:

  • units m²/m²
  • default 4.0

variable pavd_opt

3D GEDI PAVD profiles option

integer canopy_canopts_mod::pavd_opt;

Integer for turning on 3D GEDI PAVD profiles read from input file * 0 = off (default) * 1 = on


variable pavd_set

GEDI PAVD latitude threshold.

real(rk) canopy_canopts_mod::pavd_set;

Real value for latitude +/- threshold when 3D GEDI PAVD profiles read from input file

Parameters:

  • default 52.0 degrees

variable ramin_set

Minimum aerodynamic resistance.

real(rk) canopy_canopts_mod::ramin_set;

Set default minimum aerodynamic resistance

Parameters:

  • units s/m
  • default 10 s/m

variable rsl_opt

Roughness sublayer option.

integer canopy_canopts_mod::rsl_opt;

RSL option used in model from Rosenzweig et al. 2021 * 0 = off (default) * 1 = on


variable snowc_set

Snow cover threshold.

real(rk) canopy_canopts_mod::snowc_set;

Set default snow cover percent at grid/point, above which ground surface is treated as dominant snow

Parameters:

  • units percent (%)
  • default 50%

variable soilcat_opt

Soil category option.

integer canopy_canopts_mod::soilcat_opt;

Set default integer value to select soil category option * 0 = STATSGO/FAO (default)


variable soild1

Soil layer 1 depth.

real(rk) canopy_canopts_mod::soild1;

User set real value of depth of soil layer 1 centerpoint

Parameters:

  • units centimeters (cm)
  • default 5 cm (based on Noah/Noah-MP)

variable soild2

Soil layer 2 depth.

real(rk) canopy_canopts_mod::soild2;

User set real value of depth of soil layer 2 centerpoint

Parameters:

  • units centimeters (cm)
  • default 25 cm (based on Noah/Noah-MP)

variable soild3

Soil layer 3 depth.

real(rk) canopy_canopts_mod::soild3;

User set real value of depth of soil layer 3 centerpoint

Parameters:

  • units centimeters (cm)
  • default 70 cm (based on Noah/Noah-MP)

variable soild4

Soil layer 4 depth.

real(rk) canopy_canopts_mod::soild4;

User set real value of depth of soil layer 4 centerpoint

Parameters:

  • units centimeters (cm)
  • default 150 cm (based on Noah/Noah-MP)

variable soim_opt

Soil moisture factor option.

integer canopy_canopts_mod::soim_opt;

Set default for Soil Moisture factor option for BVOCs * 1 = GAMMA_SOIM = 1 (default)


variable ssg_cfset

Default shrub/savanna/grassland vegetation fraction.

real(rk) canopy_canopts_mod::ssg_cfset;

Set default value for shrubs/savanna/grassland vegfrac used in model

Parameters:

  • units dimensionless fraction
  • default 0.5

variable ssg_chset

Default shrub/savanna/grassland height.

real(rk) canopy_canopts_mod::ssg_chset;

Set default value for shrubs/savanna/grassland vegtype heights used in model

Parameters:

  • units meters (m)
  • default 1.0 m

variable ssg_laiset

Default shrub/savanna/grassland LAI.

real(rk) canopy_canopts_mod::ssg_laiset;

Set default value for shrubs/savanna/grassland LAI used in model

Parameters:

  • units m²/m²
  • default 0.1

variable ssg_opt

Shrubs/savanna/grassland vegetation option.

integer canopy_canopts_mod::ssg_opt;

Set default integer for shrubs/savanna/grassland vegtype option from GEDI or user * 0 = GEDI data (default) * 1 = user-defined values


variable var3d_opt

3D variable input option

integer canopy_canopts_mod::var3d_opt;

Integer for choosing if 3D variables will be read from file * 0 = off (default) * 1 = on


variable var3d_set

Number of 3D levels in input file.

integer canopy_canopts_mod::var3d_set;

Integer for number of 3D levels in input file, if var3d_opt=1

Parameters:

  • default 14 levels

variable w126_set

Ozone W126 value.

real(rk) canopy_canopts_mod::w126_set;

Set default value for constant ozone W126 value

Parameters:

  • units ppm-hours

variable z0_opt

Surface roughness option.

integer canopy_canopts_mod::z0_opt;

Integer for setting first estimate of z0 * 0 = Z0_MOD (default) * 1 = other method


variable z0ghc

Ground roughness to canopy height ratio.

real(rk) canopy_canopts_mod::z0ghc;

Ratio of ground roughness length to canopy top height

Parameters:

  • units dimensionless