CCPP SciDoc  v6.0.0
Common Community Physics Package Developed at DTC
GFS Unified Gravity Wave Physics Module

This is the CCPP entry points for unified GWP scheme v0. More...

Functions/Subroutines

subroutine, public unified_ugwp::unified_ugwp_init (me, master, nlunit, input_nml_file, logunit, fn_nml2, jdat, lonr, latr, levs, ak, bk, dtp, cdmbgwd, cgwf, con_pi, con_rerth, pa_rf_in, tau_rf_in, con_p0, do_ugwp, do_ugwp_v0, do_ugwp_v0_orog_only, do_ugwp_v0_nst_only, do_gsl_drag_ls_bl, do_gsl_drag_ss, do_gsl_drag_tofd, gwd_opt, errmsg, errflg)
 
subroutine, public unified_ugwp::unified_ugwp_finalize (do_ugwp_v0, do_ugwp_v0_nst_only, errmsg, errflg)
 The subroutine finalizes the GFS UGWP. More...
 
subroutine, public unified_ugwp::unified_ugwp_run (me, master, im, levs, ntrac, dtp, fhzero, kdt, lonr, oro, oro_uf, hprime, nmtvr, oc, theta, sigma, gamma, elvmax, clx, oa4, varss, oc1ss, oa4ss, ol4ss, dx, dusfc_ls, dvsfc_ls, dusfc_bl, dvsfc_bl, dusfc_ss, dvsfc_ss, dusfc_fd, dvsfc_fd, dtaux2d_ls, dtauy2d_ls, dtaux2d_bl, dtauy2d_bl, dtaux2d_ss, dtauy2d_ss, dtaux2d_fd, dtauy2d_fd, br1, hpbl, slmsk, do_tofd, ldiag_ugwp, cdmbgwd, jdat, xlat, xlat_d, sinlat, coslat, area, ugrs, vgrs, tgrs, q1, prsi, prsl, prslk, phii, phil, del, kpbl, dusfcg, dvsfcg, gw_dudt, gw_dvdt, gw_dtdt, gw_kdis, tau_tofd, tau_mtb, tau_ogw, tau_ngw, zmtb, zlwb, zogw, dudt_mtb, dudt_tms, du3dt_mtb, du3dt_ogw, du3dt_tms, dudt, dvdt, dtdt, rdxzb, con_g, con_omega, con_pi, con_cp, con_rd, con_rv, con_rerth, con_fvirt, rain, ntke, q_tke, dqdt_tke, lprnt, ipr, dtend, dtidx, index_of_temperature, index_of_x_wind, index_of_y_wind, index_of_process_orographic_gwd, index_of_process_nonorographic_gwd, ldiag3d, lssav, flag_for_gwd_generic_tend, do_ugwp_v0, do_ugwp_v0_orog_only, do_ugwp_v0_nst_only, do_gsl_drag_ls_bl, do_gsl_drag_ss, do_gsl_drag_tofd, gwd_opt, spp_wts_gwd, spp_gwd, errmsg, errflg)
 This subroutine executes the CIRES UGWP Version 0. More...
 

Detailed Description

The subroutine initializes the unified UGWP.

Argument Table

unified_ugwp_init argument table
local_namestandard_namelong_nameunitstypedimensionskindintent
mempi_rankMPI rank of current processindexinteger()in
mastermpi_rootMPI rank of master processindexinteger()in
nlunitiounit_of_namelistfortran unit number for opening namelist filenoneinteger()in
input_nml_filefilename_of_internal_namelistcharacter string to store full namelist contentsnonecharacter(ccpp_constant_one:number_of_lines_in_internal_namelist)len=*in
logunitiounit_of_logfortran unit number for writing logfilenoneinteger()in
fn_nml2filename_of_namelistnamelist filename for ugwpnonecharacter()len=*in
jdatdate_and_time_of_forecast_in_united_states_ordercurrent forecast date and timenoneinteger(ccpp_constant_one:8)in
lonrnumber_of_equatorial_longitude_pointsnumber of global points in x-dir (i) along the equatorcountinteger()in
latrnumber_of_latitude_pointsnumber of global points in y-dir (j) along the meridiancountinteger()in
levsvertical_layer_dimensionnumber of vertical levelscountinteger()in
aksigma_pressure_hybrid_coordinate_a_coefficienta parameter for sigma pressure level calculationsPareal(ccpp_constant_one:vertical_interface_dimension)kind_physin
bksigma_pressure_hybrid_coordinate_b_coefficientb parameter for sigma pressure level calculationsnonereal(ccpp_constant_one:vertical_interface_dimension)kind_physin
dtptimestep_for_physicsphysics timestepsreal()kind_physin
cdmbgwdmultiplicative_tunable_parameters_for_mountain_blocking_and_orographic_gravity_wave_dragmultiplication factors for cdmb and gwdnonereal(ccpp_constant_one:4)kind_physin
cgwftunable_parameters_for_convective_gravity_wave_dragmultiplication factor for convective GWDnonereal(ccpp_constant_one:2)kind_physin
con_pipiratio of a circle's circumference to its diameternonereal()kind_physin
con_rerthradius_of_earthradius of earthmreal()kind_physin
pa_rf_inair_pressure_at_bottom_extent_of_rayleigh_dampingpressure level from which Rayleigh Damping is appliedPareal()kind_physin
tau_rf_intimescale_for_rayleigh_dampingtime scale for Rayleigh damping in daysdreal()kind_physin
con_p0standard_atmospheric_pressurestandard atmospheric pressurePareal()kind_physin
do_ugwpflag_for_unified_gravity_wave_physics_gravity_wave_drag_schemeflag to activate CIRES UGWPflaglogical()in
do_ugwp_v0flag_for_ugwp_version_0flag to activate ver 0 CIRES UGWPflaglogical()in
do_ugwp_v0_orog_onlyflag_for_ugwp_version_0_orographic_gwdflag to activate ver 0 CIRES UGWP - orographic GWD onlyflaglogical()in
do_ugwp_v0_nst_onlyflag_for_ugwp_version_0_nonorographic_gwdflag to activate ver 0 CIRES UGWP - non-stationary GWD onlyflaglogical()in
do_gsl_drag_ls_blflag_for_gsl_drag_suite_large_scale_orographic_and_blocking_dragflag to activate GSL drag suite - large-scale GWD and blockingflaglogical()in
do_gsl_drag_ssflag_for_gsl_drag_suite_small_scale_orographic_dragflag to activate GSL drag suite - small-scale GWDflaglogical()in
do_gsl_drag_tofdflag_for_gsl_drag_suite_turbulent_orographic_form_dragflag to activate GSL drag suite - turb orog form dragflaglogical()in
gwd_optcontrol_for_drag_suite_gravity_wave_dragflag to choose gwd schemeflaginteger()in
errmsgccpp_error_messageerror message for error handling in CCPPnonecharacter()len=*out
errflgccpp_error_codeerror code for error handling in CCPP1integer()out