emcsfc_snow2mdl  1.13.0
program_setup Module Reference

This module reads in data from the program's configuration namelist. More...

Functions/Subroutines

subroutine, public read_config_nml
 Read namelist control. More...
 

Variables

character *200, public afwa_lsmask_nh_file
 path/name afwa n hemis land/sea mask More...
 
character *200, public afwa_lsmask_sh_file
 path/name afwa s hemis land/sea mask More...
 
character *200, public afwa_snow_global_file
 global afwa snow file. More...
 
character *200, public afwa_snow_nh_file
 path/name afwa n hemis snow depth More...
 
character *200, public afwa_snow_sh_file
 path/name afwa s hemis snow depth More...
 
character *200, public autosnow_file
 path/name s hemis autosnow file More...
 
character *200, public climo_qc_file
 Climatological snow cover file. More...
 
character *200, public gfs_lpl_file
 GFS gaussian thinned (reduced) grid definition file. More...
 
integer, public grib_century
 date of the final merged snow product that will be placed in grib header. More...
 
integer, public grib_day
 date of the final merged snow product that will be placed in grib header. More...
 
integer, public grib_hour
 date of the final merged snow product that will be placed in grib header. More...
 
integer, public grib_month
 date of the final merged snow product that will be placed in grib header. More...
 
integer, public grib_year
 date of the final merged snow product that will be placed in grib header. More...
 
real, public lat_threshold
 equatorward of this latitude, model points with undefined cover or depth (because the interpolation routines could not find valid snow data) are set to a default value of zero. More...
 
real, public min_snow_depth
 minimum snow depth in meters at model points with coverage exceeding threshold. More...
 
character *200, public model_lat_file
 path/name lats on the model grid More...
 
character *200, public model_lon_file
 path/name lons on the model grid More...
 
character *200, public model_lsmask_file
 path/name nesdis/ims land mask More...
 
character *200, public model_snow_file
 path/name nesdis/ims snow cover More...
 
character *200, public nesdis_lsmask_file
 nesdis/ims land mask file More...
 
character *200, public nesdis_snow_file
 nesdis/ims snow file More...
 
logical, public output_grib2
 when true, output model snow analysis is grib 2. More...
 
real, public snow_cvr_threshold
 if percent coverage according to nesdis/ims or autosnow exceeds this value, then non-zero snow depth is assigned. More...
 

Detailed Description

This module reads in data from the program's configuration namelist.

program history log:

  • 2005-DEC-16 gayno - initial version
  • 2008-Feb-01 gayno - added autosnow data
  • 2014-Sep-30 gayno - added 'output_grib2' flag
Author
George Gayno org: w/np2
Date
2005-DEC-16

Function/Subroutine Documentation

◆ read_config_nml()

subroutine, public program_setup::read_config_nml ( )

Read namelist control.

Note
This subroutine reads the program's configuration namelist that contains the the paths/filenames for input and output, and other program control flags.

program history log: 2005-dec-16 gayno - initial version 2008-feb-01 gayno - added read of autosnow path/file 2014-sep-30 gayno - added read of 'output_grib2' flag.

files: input:

  • program configuration namelist, fort.41

condition codes: all fatal

  • 77 - bad open on configuration namelist
  • 78 - bad read on configuration namelist
Author
George Gayno org: w/np2
Date
2005-Dec-16

Definition at line 81 of file program_setup.F90.

References afwa_lsmask_nh_file, afwa_lsmask_sh_file, afwa_snow_global_file, afwa_snow_nh_file, afwa_snow_sh_file, autosnow_file, climo_qc_file, gfs_lpl_file, grib_century, grib_day, grib_hour, grib_month, grib_year, lat_threshold, min_snow_depth, model_lat_file, model_lon_file, model_lsmask_file, model_snow_file, nesdis_lsmask_file, nesdis_snow_file, output_grib2, and snow_cvr_threshold.

Referenced by driver().

Variable Documentation

◆ afwa_lsmask_nh_file

character*200, public program_setup::afwa_lsmask_nh_file

path/name afwa n hemis land/sea mask

Definition at line 24 of file program_setup.F90.

Referenced by read_config_nml(), and snowdat::readafwa().

◆ afwa_lsmask_sh_file

character*200, public program_setup::afwa_lsmask_sh_file

path/name afwa s hemis land/sea mask

Definition at line 25 of file program_setup.F90.

Referenced by read_config_nml(), and snowdat::readafwa().

◆ afwa_snow_global_file

character*200, public program_setup::afwa_snow_global_file

global afwa snow file.

Definition at line 21 of file program_setup.F90.

Referenced by read_config_nml(), and snowdat::readafwa().

◆ afwa_snow_nh_file

character*200, public program_setup::afwa_snow_nh_file

path/name afwa n hemis snow depth

Definition at line 22 of file program_setup.F90.

Referenced by read_config_nml(), and snowdat::readafwa().

◆ afwa_snow_sh_file

character*200, public program_setup::afwa_snow_sh_file

path/name afwa s hemis snow depth

Definition at line 23 of file program_setup.F90.

Referenced by read_config_nml(), and snowdat::readafwa().

◆ autosnow_file

character*200, public program_setup::autosnow_file

path/name s hemis autosnow file

Definition at line 26 of file program_setup.F90.

Referenced by read_config_nml(), and snowdat::readautosnow().

◆ climo_qc_file

character*200, public program_setup::climo_qc_file

Climatological snow cover file.

Used to quality control snow data.

Definition at line 27 of file program_setup.F90.

Referenced by snowdat::nh_climo_check(), and read_config_nml().

◆ gfs_lpl_file

character*200, public program_setup::gfs_lpl_file

GFS gaussian thinned (reduced) grid definition file.

Contains the number of longitudes (i-points) for each latitude (row).

Definition at line 29 of file program_setup.F90.

Referenced by read_config_nml(), and model_grid::read_mdl_grid_info().

◆ grib_century

integer, public program_setup::grib_century

date of the final merged snow product that will be placed in grib header.

Definition at line 39 of file program_setup.F90.

Referenced by snowdat::nh_climo_check(), read_config_nml(), snow2mdl::write_grib1(), and snow2mdl::write_grib2().

◆ grib_day

integer, public program_setup::grib_day

date of the final merged snow product that will be placed in grib header.

Definition at line 41 of file program_setup.F90.

Referenced by snowdat::nh_climo_check(), read_config_nml(), snow2mdl::write_grib1(), and snow2mdl::write_grib2().

◆ grib_hour

integer, public program_setup::grib_hour

date of the final merged snow product that will be placed in grib header.

Definition at line 42 of file program_setup.F90.

Referenced by read_config_nml(), snow2mdl::write_grib1(), and snow2mdl::write_grib2().

◆ grib_month

integer, public program_setup::grib_month

date of the final merged snow product that will be placed in grib header.

Definition at line 43 of file program_setup.F90.

Referenced by snowdat::nh_climo_check(), read_config_nml(), snow2mdl::write_grib1(), and snow2mdl::write_grib2().

◆ grib_year

integer, public program_setup::grib_year

date of the final merged snow product that will be placed in grib header.

Definition at line 44 of file program_setup.F90.

Referenced by snowdat::nh_climo_check(), read_config_nml(), snow2mdl::write_grib1(), and snow2mdl::write_grib2().

◆ lat_threshold

real, public program_setup::lat_threshold

equatorward of this latitude, model points with undefined cover or depth (because the interpolation routines could not find valid snow data) are set to a default value of zero.

poleward, undefined points are set according to logic in module snow2mdl.

Definition at line 48 of file program_setup.F90.

Referenced by snow2mdl::interp(), and read_config_nml().

◆ min_snow_depth

real, public program_setup::min_snow_depth

minimum snow depth in meters at model points with coverage exceeding threshold.

Definition at line 52 of file program_setup.F90.

Referenced by snow2mdl::interp(), and read_config_nml().

◆ model_lat_file

character*200, public program_setup::model_lat_file

path/name lats on the model grid

Definition at line 32 of file program_setup.F90.

Referenced by read_config_nml(), and model_grid::read_mdl_grid_info().

◆ model_lon_file

character*200, public program_setup::model_lon_file

path/name lons on the model grid

Definition at line 33 of file program_setup.F90.

Referenced by read_config_nml(), and model_grid::read_mdl_grid_info().

◆ model_lsmask_file

character*200, public program_setup::model_lsmask_file

path/name nesdis/ims land mask

Definition at line 34 of file program_setup.F90.

Referenced by read_config_nml(), and model_grid::read_mdl_grid_info().

◆ model_snow_file

character*200, public program_setup::model_snow_file

path/name nesdis/ims snow cover

Definition at line 35 of file program_setup.F90.

Referenced by read_config_nml(), snow2mdl::write_grib1(), and snow2mdl::write_grib2().

◆ nesdis_lsmask_file

character*200, public program_setup::nesdis_lsmask_file

nesdis/ims land mask file

Definition at line 36 of file program_setup.F90.

Referenced by read_config_nml(), and snowdat::readnesdis().

◆ nesdis_snow_file

character*200, public program_setup::nesdis_snow_file

nesdis/ims snow file

Definition at line 37 of file program_setup.F90.

Referenced by read_config_nml(), and snowdat::readnesdis().

◆ output_grib2

logical, public program_setup::output_grib2

when true, output model snow analysis is grib 2.

when false, grib 1.

Definition at line 46 of file program_setup.F90.

Referenced by snow2mdl::interp(), and read_config_nml().

◆ snow_cvr_threshold

real, public program_setup::snow_cvr_threshold

if percent coverage according to nesdis/ims or autosnow exceeds this value, then non-zero snow depth is assigned.

below this threshold, depth is set to zero.

Definition at line 53 of file program_setup.F90.

Referenced by snow2mdl::interp(), and read_config_nml().