← Back to Documentation Home
CCPP SciDoc for Global Workflow v1.0.0  GW v1.0.0
Common Community Physics Package Developed at DTC
Loading...
Searching...
No Matches

◆ canopy_driver_run()

subroutine canopy_driver::canopy_driver_run ( integer, intent(in) im,
integer, intent(in) km,
ntrac,
ntcw,
ntrw )

Argument Table

canopy_driver_run argument table
local_namestandard_namelong_nameunitstypedimensionskindintent
imhorizontal_loop_extenthorizontal loop extentcountinteger()in
kmvertical_layer_dimensionvertical layer dimensioncountinteger()in
ntracnumber_of_vertical_diffusion_tracersnumber of tracers to diffuse verticallycountinteger()in
ntcwindex_for_liquid_cloud_condensate_vertical_diffusion_tracertracer index for cloud condensate (or liquid water)indexinteger()in
ntrwindex_for_rain_water_vertical_diffusion_tracertracer index for rain water in the vertically diffused tracer arrayindexinteger()in
ntiwindex_for_ice_cloud_condensate_vertical_diffusion_tracertracer index for ice water in the vertically diffused tracer arrayindexinteger()in
ntkeindex_for_turbulent_kinetic_energy_vertical_diffusion_tracerindex for turbulent kinetic energy in the vertically diffused tracer arrayindexinteger()in
ntchmnumber_of_chemical_tracersnumber of chemical tracerscountinteger()in
ntchsindex_of_first_chemical_tracer_in_tracer_concentration_arraytracer index for first chemical tracerindexinteger()in
ntcheindex_for_last_chemical_tracertracer index for last chemical tracerindexinteger()in
ntozindex_of_ozone_mixing_ratio_in_tracer_concentration_arraytracer index for ozone mixing ratioindexinteger()in
nto3index_for_ozone_chemical_tracer_in_tracer_concentration_arraytracer index for ozone chemical tracerindexinteger()in
ndtendcumulative_change_of_state_variables_outer_index_maxlast dimension of array of diagnostic tendencies for state variablescountinteger()in
con_rocpratio_of_gas_constant_dry_air_to_specific_heat_of_dry_air_at_constant_pressure(rd/cp)nonereal()kind_physin
gravgravitational_accelerationgravitational accelerationm s-2real()kind_physin
pipiratio of a circle's circumference to its diameternonereal()kind_physin
rdgas_constant_of_dry_airideal gas constant for dry airJ kg-1 K-1real()kind_physin
cpspecific_heat_of_dry_air_at_constant_pressurespecific heat of dry air at constant pressureJ kg-1 K-1real()kind_physin
rvgas_constant_water_vaporideal gas constant for water vaporJ kg-1 K-1real()kind_physin
hvaplatent_heat_of_vaporization_of_water_at_0clatent heat of evaporation/sublimationJ kg-1real()kind_physin
hfuslatent_heat_of_fusion_of_water_at_0clatent heat of fusionJ kg-1real()kind_physin
fvratio_of_vapor_to_dry_air_gas_constants_minus_one(rv/rd) - 1 (rv = ideal gas constant for water vapor)nonereal()kind_physin
epsratio_of_dry_air_to_water_vapor_gas_constantsrd/rvnonereal()kind_physin
epsm1ratio_of_dry_air_to_water_vapor_gas_constants_minus_one(rd/rv) - 1nonereal()kind_physin
dvprocess_split_cumulative_tendency_of_y_windtendency of the y windm s-2real(ccpp_constant_one:horizontal_loop_extent, ccpp_constant_one:vertical_layer_dimension)kind_physinout
duprocess_split_cumulative_tendency_of_x_windtendency of the x windm s-2real(ccpp_constant_one:horizontal_loop_extent, ccpp_constant_one:vertical_layer_dimension)kind_physinout
tdtprocess_split_cumulative_tendency_of_air_temperaturetendency of the temperatureK s-1real(ccpp_constant_one:horizontal_loop_extent, ccpp_constant_one:vertical_layer_dimension)kind_physinout
rtgtendency_of_vertically_diffused_tracer_concentrationtendency of the tracers due to vertical diffusion in PBL schemekg kg-1 s-1real(ccpp_constant_one:horizontal_loop_extent, ccpp_constant_one:vertical_layer_dimension, ccpp_constant_one:number_of_vertical_diffusion_tracers)kind_physinout
u1x_windx component of layer windm s-1real(ccpp_constant_one:horizontal_loop_extent, ccpp_constant_one:vertical_layer_dimension)kind_physin
v1y_windy component of layer windm s-1real(ccpp_constant_one:horizontal_loop_extent, ccpp_constant_one:vertical_layer_dimension)kind_physin
usfcox_ocean_currentzonal current at ocean surfacem s-1real(ccpp_constant_one:horizontal_loop_extent)kind_physin
vsfcoy_ocean_currentmeridional current at ocean surfacem s-1real(ccpp_constant_one:horizontal_loop_extent)kind_physin
use_oceanuvdo_air_sea_flux_computation_over_waterair-sea flux optionflaglogical()in
t1air_temperaturelayer mean air temperatureKreal(ccpp_constant_one:horizontal_loop_extent, ccpp_constant_one:vertical_layer_dimension)kind_physin
q1vertically_diffused_tracer_concentrationtracer concentration diffused by PBL schemekg kg-1real(ccpp_constant_one:horizontal_loop_extent, ccpp_constant_one:vertical_layer_dimension, ccpp_constant_one:number_of_vertical_diffusion_tracers)kind_physin
def_1square_of_vertical_shear_due_to_dynamicssquare of vertical shear calculated from dynamicsm2 s-2real(ccpp_constant_one:horizontal_loop_extent, ccpp_constant_one:vertical_layer_dimension)kind_physin
def_2square_of_horizontal_shear_due_to_dynamicssquare of horizontal shear calculated from dynamicsm2 s-2real(ccpp_constant_one:horizontal_loop_extent, ccpp_constant_one:vertical_layer_dimension)kind_physin
def_3horizontal_transfer_rate_of_tke_due_to_dynamicsrate of horizontal TKE transfer and pressure correlation calculated from dynamicsm2 s-3real(ccpp_constant_one:horizontal_loop_extent, ccpp_constant_one:vertical_layer_dimension)kind_physin
swhtendency_of_air_temperature_due_to_shortwave_heating_on_radiation_timesteptotal sky shortwave heating rateK s-1real(ccpp_constant_one:horizontal_loop_extent, ccpp_constant_one:vertical_layer_dimension)kind_physin
hlwtendency_of_air_temperature_due_to_longwave_heating_on_radiation_timesteptotal sky longwave heating rateK s-1real(ccpp_constant_one:horizontal_loop_extent, ccpp_constant_one:vertical_layer_dimension)kind_physin
xmuzenith_angle_temporal_adjustment_factor_for_shortwave_fluxeszenith angle temporal adjustment factor for shortwavenonereal(ccpp_constant_one:horizontal_loop_extent)kind_physin
gareacell_areaarea of the grid cellm2real(ccpp_constant_one:horizontal_loop_extent)kind_physin
zvfunfunction_of_surface_roughness_length_and_green_vegetation_fractionfunction of surface roughness length and green vegetation fractionnonereal(ccpp_constant_one:horizontal_loop_extent)kind_physin
sigmafbounded_vegetation_area_fractionareal fractional cover of green vegetation bounded on the bottomfracreal(ccpp_constant_one:horizontal_loop_extent)kind_physin
psksurface_dimensionless_exner_functiondimensionless Exner function at the surface interfacenonereal(ccpp_constant_one:horizontal_loop_extent)kind_physin
rbsoilbulk_richardson_number_at_lowest_model_levelbulk Richardson number at the surfacenonereal(ccpp_constant_one:horizontal_loop_extent)kind_physin
zorlsurface_roughness_lengthsurface roughness length in cmcmreal(ccpp_constant_one:horizontal_loop_extent)kind_physin
u10mx_wind_at_10mx component of wind at 10 mm s-1real(ccpp_constant_one:horizontal_loop_extent)kind_physin
v10my_wind_at_10my component of wind at 10 mm s-1real(ccpp_constant_one:horizontal_loop_extent)kind_physin
t2mair_temperature_at_2m2 meter temperatureKreal(ccpp_constant_one:horizontal_loop_extent)kind_physin
q2mspecific_humidity_at_2m2 meter specific humiditykg kg-1real(ccpp_constant_one:horizontal_loop_extent)kind_physin
fmmonin_obukhov_similarity_function_for_momentumMonin-Obukhov similarity function for momentumnonereal(ccpp_constant_one:horizontal_loop_extent)kind_physin
fhmonin_obukhov_similarity_function_for_heatMonin-Obukhov similarity function for heatnonereal(ccpp_constant_one:horizontal_loop_extent)kind_physin
tseasurface_skin_temperaturesurface skin temperatureKreal(ccpp_constant_one:horizontal_loop_extent)kind_physin
heatkinematic_surface_upward_sensible_heat_flux_reduced_by_surface_roughness_and_vegetationkinematic surface upward sensible heat flux reduced by surface roughness and vegetationK m s-1real(ccpp_constant_one:horizontal_loop_extent)kind_physin
evapsurface_upward_specific_humidity_fluxkinematic surface upward latent heat fluxkg kg-1 m s-1real(ccpp_constant_one:horizontal_loop_extent)kind_physin
stresssurface_wind_stresssurface wind stressm2 s-2real(ccpp_constant_one:horizontal_loop_extent)kind_physin
spd1wind_speed_at_lowest_model_layerwind speed at lowest model levelm s-1real(ccpp_constant_one:horizontal_loop_extent)kind_physin
kpblvertical_index_at_top_of_atmosphere_boundary_layerPBL top model level indexindexinteger(ccpp_constant_one:horizontal_loop_extent)in
pgrsurface_air_pressuresurface pressurePareal(ccpp_constant_one:horizontal_loop_extent)kind_physin
prsiair_pressure_at_interfaceair pressure at model layer interfacesPareal(ccpp_constant_one:horizontal_loop_extent, ccpp_constant_one:vertical_interface_dimension)kind_physin
delair_pressure_difference_between_midlayerspres(k) - pres(k+1)Pareal(ccpp_constant_one:horizontal_loop_extent, ccpp_constant_one:vertical_layer_dimension)kind_physin
prslair_pressuremean layer pressurePareal(ccpp_constant_one:horizontal_loop_extent, ccpp_constant_one:vertical_layer_dimension)kind_physin
prslkdimensionless_exner_functionExner function at layersnonereal(ccpp_constant_one:horizontal_loop_extent, ccpp_constant_one:vertical_layer_dimension)kind_physin
phiigeopotential_at_interfacegeopotential at model layer interfacesm2 s-2real(ccpp_constant_one:horizontal_loop_extent, ccpp_constant_one:vertical_interface_dimension)kind_physin
philgeopotentialgeopotential at model layer centersm2 s-2real(ccpp_constant_one:horizontal_loop_extent, ccpp_constant_one:vertical_layer_dimension)kind_physin
delttimestep_for_physicstime step for physicssreal()kind_physin
tte_edmfflag_for_scale_aware_tte_moist_edmf_pblflag for scale-aware TTE moist EDMF PBL schemeflaglogical()in
dspheatflag_tke_dissipation_heatingflag for using TKE dissipation heatingflaglogical()in
sa3dtkedo_scale_aware_3d_tkeflag for scale-aware 3d tke schemeflaglogical()in
dusfcinstantaneous_surface_x_momentum_fluxx momentum fluxPareal(ccpp_constant_one:horizontal_loop_extent)kind_physin
dvsfcinstantaneous_surface_y_momentum_fluxy momentum fluxPareal(ccpp_constant_one:horizontal_loop_extent)kind_physin
dtsfcinstantaneous_surface_upward_sensible_heat_fluxsurface upward sensible heat fluxW m-2real(ccpp_constant_one:horizontal_loop_extent)kind_physin
dqsfcinstantaneous_surface_upward_latent_heat_fluxsurface upward latent heat fluxW m-2real(ccpp_constant_one:horizontal_loop_extent)kind_physin
hpblatmosphere_boundary_layer_thicknessPBL thicknessmreal(ccpp_constant_one:horizontal_loop_extent)kind_physin
tkehvertical_turbulent_kinetic_energy_at_interfacevertical turbulent kinetic energy at model layer interfacesm2 s-2real(ccpp_constant_one:horizontal_loop_extent, ccpp_constant_one:vertical_interface_dimension)kind_physinout
dktatmosphere_heat_diffusivityatmospheric heat diffusivitym2 s-1real(ccpp_constant_one:horizontal_loop_extent, ccpp_constant_one:vertical_layer_dimension)kind_physinout
dkuatmosphere_momentum_diffusivityatmospheric momentum diffusivitym2 s-1real(ccpp_constant_one:horizontal_loop_extent, ccpp_constant_one:vertical_layer_dimension)kind_physinout
dkt_canatmosphere_heat_diffusivity_in_canopyatmospheric heat diffusivity in canopym2 s-1real(ccpp_constant_one:horizontal_loop_extent, ccpp_constant_one:vertical_layer_dimension)kind_physout
dku_canatmosphere_momentum_diffusivity_in_canopyatmospheric momentum diffusivity in canopym2 s-1real(ccpp_constant_one:horizontal_loop_extent, ccpp_constant_one:vertical_layer_dimension)kind_physout
dku3d_hhorizontal_atmosphere_momentum_diffusivity_for_dynamicshorizontal atmospheric momentum diffusivity for dynamicsm2 s-1real(ccpp_constant_one:horizontal_loop_extent, ccpp_constant_one:vertical_layer_dimension)kind_physin
dku3d_ehorizontal_atmosphere_tke_diffusivity_for_dynamicshorizontal atmospheric tke diffusivity for dynamicsm2 s-1real(ccpp_constant_one:horizontal_loop_extent, ccpp_constant_one:vertical_layer_dimension)kind_physin
kinverindex_of_highest_temperature_inversionindex of highest temperature inversionindexinteger(ccpp_constant_one:horizontal_loop_extent)in
xkzm_matmosphere_momentum_diffusivity_due_to_backgroundbackground value of momentum diffusivitym2 s-1real()kind_physin
xkzm_hatmosphere_heat_diffusivity_due_to_backgroundbackground value of heat diffusivitym2 s-1real()kind_physin
xkzm_ssigma_pressure_threshold_at_upper_extent_of_background_diffusionsigma level threshold for background diffusivitynonereal()kind_physin
dspfacmultiplicative_tuning_parameter_for_tke_dissipative_heatingtke dissipative heating factornonereal()kind_physin
bl_upfrupdraft_area_fraction_in_scale_aware_tke_moist_edmf_pbl_schemeupdraft fraction in boundary layer mass flux schemenonereal()kind_physin
bl_dnfrdowndraft_area_fraction_in_scale_aware_tke_moist_edmf_pbl_schemedowndraft fraction in boundary layer mass flux schemenonereal()kind_physin
rlmxmaximum_allowed_mixing_length_in_boundary_layer_mass_flux_schememaximum allowed mixing length in boundary layer mass flux schememreal()kind_physin
elmxmaximum_allowed_dissipation_mixing_length_in_boundary_layer_mass_flux_schememaximum allowed dissipation mixing length in boundary layer mass flux schememreal()kind_physin
do_canopyflag_for_canopy_optionflag for in-canopy eddy diffusivity adjustment optionflaglogical()in
cplaqmflag_for_air_quality_couplingflag controlling cplaqm collection (default off)flaglogical()in
claiecanopy_leaf_area_indexcanopy leaf area indexnonereal(ccpp_constant_one:horizontal_loop_extent)kind_physin
cfchcanopy_forest_heightcanopy forest heightmreal(ccpp_constant_one:horizontal_loop_extent)kind_physin
cfrtcanopy_forest_fractioncanopy forest fractionnonereal(ccpp_constant_one:horizontal_loop_extent)kind_physin
cclucanopy_clumping_indexcanopy clumping indexnonereal(ccpp_constant_one:horizontal_loop_extent)kind_physin
cpopucanopy_population_densitypopulation density used for canopy correctionkm-2real(ccpp_constant_one:horizontal_loop_extent)kind_physin
sfc_rlmchoice_of_near_surface_mixing_length_in_boundary_layer_mass_flux_schemechoice of near surface mixing length in boundary layer mass flux schemenoneinteger()in
tc_pblcontrol_for_tc_applications_in_the_pbl_schemecontrol for TC applications in the PBL schemenoneinteger()in
use_lptcontrol_for_using_lpt_for_tc_applications_in_the_pbl_schemecontrol for using LPT in TC applications in the PBL schemenoneinteger()in
ntqvindex_of_specific_humidity_in_tracer_concentration_arraytracer index for water vapor (specific humidity)indexinteger()in
dtendcumulative_change_of_state_variablesdiagnostic tendencies for state variablesmixedreal(ccpp_constant_one:horizontal_loop_extent, ccpp_constant_one:vertical_layer_dimension, ccpp_constant_one:cumulative_change_of_state_variables_outer_index_max)kind_physinout
dtidxcumulative_change_of_state_variables_outer_indexindex of state-variable and process in last dimension of diagnostic tendencies array AKA cumulative_change_indexindexinteger(ccpp_constant_one:number_of_tracers_plus_one_hundred, ccpp_constant_one:number_of_cumulative_change_processes)in
index_of_temperatureindex_of_temperature_in_cumulative_change_indexindex of temperature in first dimension of array cumulative change indexindexinteger()in
index_of_x_windindex_of_x_wind_in_cumulative_change_indexindex of x-wind in first dimension of array cumulative change indexindexinteger()in
index_of_y_windindex_of_y_wind_in_cumulative_change_indexindex of y-wind in first dimension of array cumulative change indexindexinteger()in
index_of_process_pblindex_of_subgrid_scale_vertical_mixing_process_in_cumulative_change_indexindex of subgrid scale vertical mixing process in second dimension of array cumulative change indexindexinteger()in
gen_tendflag_for_generic_tendency_due_to_planetary_boundary_layertrue if GFS_PBL_generic should calculate tendenciesflaglogical()in
ldiag3dflag_for_diagnostics_3dflag for 3d diagnostic fieldsflaglogical()in
errmsgccpp_error_messageerror message for error handling in CCPPnonecharacter()len=*out
errflgccpp_error_codeerror code for error handling in CCPP1integer()out

Compute preliminary variables from input arguments

  • Compute physical height of the layer centers and interfaces from the geopotential height (zi and zl)
  • Compute horizontal grid size (gdx)
  • Some output variables and logical flags are initialized
  • Compute geopotential physical height of the layer centers and interfaces from the physical height (zi and zl)
  • Apply the tendencies of heat and moisture on canopy layers

References satmedmfvdifq_can_mod::satmedmfvdifq_can().

Here is the call graph for this function: