chgres_cube  1.13.0
All Data Structures Namespaces Files Functions Variables Pages
sfc_input_data.F90 File Reference

Read atmospheric and surface data from GRIB2, NEMSIO and NetCDF files. More...

Go to the source code of this file.

Functions/Subroutines

subroutine, public sfc_input_data::cleanup_input_sfc_data
 Free up memory associated with sfc data. More...
 
subroutine, public sfc_input_data::init_sfc_esmf_fields
 Create surface input grid esmf fields. More...
 
subroutine sfc_input_data::read_fv3_grid_data_netcdf (FIELD, TILE_NUM, IMO, JMO, LMO, SFCDATA, SFCDATA_3D)
 Read a record from a netcdf file. More...
 
subroutine sfc_input_data::read_grib_soil (vname, vname_file, lugb, pdt_num, dummy3d)
 Read soil temperature and soil moisture fields from a GRIB2 file. More...
 
subroutine, public sfc_input_data::read_input_sfc_data (localpet)
 Driver to read input grid surface data. More...
 
subroutine sfc_input_data::read_input_sfc_grib2_file (localpet)
 Read input grid surface data from a grib2 file. More...
 
subroutine sfc_input_data::read_input_sfc_netcdf_file (localpet)
 Read input grid surface data from tiled 'history' files (netcdf) or gaussian netcdf files. More...
 
subroutine sfc_input_data::read_input_sfc_restart_file (localpet)
 Read input grid surface data from fv3 tiled warm 'restart' files. More...
 

Variables

type(esmf_field), public sfc_input_data::canopy_mc_input_grid
 canopy moist content More...
 
type(esmf_field), public sfc_input_data::f10m_input_grid
 log((z0+10)*1/z0) More...
 
type(esmf_field), public sfc_input_data::ffmm_input_grid
 log((z0+z1)*1/z0) See sfc_diff.f for details. More...
 
real sfc_input_data::icet_default = 265.0
 Default value of soil and skin temperature (K) over ice. More...
 
type(esmf_field), public sfc_input_data::lai_input_grid
 leaf area index More...
 
type(esmf_field), public sfc_input_data::landsea_mask_input_grid
 land sea mask; 0-water, 1-land, 2-ice More...
 
integer, public sfc_input_data::lsoil_input =4
 number of soil layers, no longer hardwired to allow for 7 layers of soil for the RUC LSM More...
 
type(esmf_field), public sfc_input_data::max_veg_greenness_input_grid
 shdmax More...
 
type(esmf_field), public sfc_input_data::min_veg_greenness_input_grid
 shdmin More...
 
type(esmf_field), public sfc_input_data::q2m_input_grid
 2-m spec hum More...
 
type(esmf_field), public sfc_input_data::seaice_depth_input_grid
 sea ice depth More...
 
type(esmf_field), public sfc_input_data::seaice_fract_input_grid
 sea ice fraction More...
 
type(esmf_field), public sfc_input_data::seaice_skin_temp_input_grid
 sea ice skin temp More...
 
type(esmf_field), public sfc_input_data::skin_temp_input_grid
 skin temp/sst More...
 
type(esmf_field), public sfc_input_data::snow_depth_input_grid
 snow dpeth More...
 
type(esmf_field), public sfc_input_data::snow_liq_equiv_input_grid
 snow liq equiv depth More...
 
type(esmf_field), public sfc_input_data::soil_temp_input_grid
 3-d soil temp More...
 
type(esmf_field), public sfc_input_data::soil_type_input_grid
 soil type More...
 
type(esmf_field), public sfc_input_data::soilm_liq_input_grid
 3-d liquid soil moisture More...
 
type(esmf_field), public sfc_input_data::soilm_tot_input_grid
 3-d total soil moisture More...
 
type(esmf_field), public sfc_input_data::srflag_input_grid
 snow/rain flag More...
 
type(esmf_field), public sfc_input_data::t2m_input_grid
 2-m temperature More...
 
type(esmf_field), public sfc_input_data::tprcp_input_grid
 precip More...
 
type(esmf_field), public sfc_input_data::ustar_input_grid
 fric velocity More...
 
type(esmf_field), public sfc_input_data::veg_greenness_input_grid
 vegetation fraction More...
 
type(esmf_field), public sfc_input_data::veg_type_input_grid
 vegetation type More...
 
integer, public sfc_input_data::veg_type_landice_input = 15
 NOAH land ice option defined at this veg type. More...
 
type(esmf_field), public sfc_input_data::z0_input_grid
 roughness length More...
 

Detailed Description

Read atmospheric and surface data from GRIB2, NEMSIO and NetCDF files.

Author
George Gayno NCEP/EMC

Definition in file sfc_input_data.F90.

Function/Subroutine Documentation

◆ cleanup_input_sfc_data()

subroutine, public sfc_input_data::cleanup_input_sfc_data ( )

Free up memory associated with sfc data.

Author
George Gayno NCEP/EMC

Definition at line 3317 of file sfc_input_data.F90.

References program_setup::convert_nst, program_setup::lai_from_climo, program_setup::minmax_vgfrc_from_climo, atm_input_data::terrain_input_grid, and program_setup::vgfrc_from_climo.

◆ init_sfc_esmf_fields()

subroutine, public sfc_input_data::init_sfc_esmf_fields ( )

Create surface input grid esmf fields.

Author
George Gayno NCEP/EMC

Definition at line 2957 of file sfc_input_data.F90.

References model_grid::input_grid, program_setup::lai_from_climo, program_setup::minmax_vgfrc_from_climo, atm_input_data::terrain_input_grid, and program_setup::vgfrc_from_climo.

◆ read_fv3_grid_data_netcdf()

subroutine sfc_input_data::read_fv3_grid_data_netcdf ( character(len=*), intent(in)  FIELD,
integer, intent(in)  TILE_NUM,
integer, intent(in)  IMO,
integer, intent(in)  JMO,
integer, intent(in)  LMO,
real(esmf_kind_r8), dimension(imo,jmo), intent(out), optional  SFCDATA,
real(esmf_kind_r8), dimension(imo,jmo,lmo), intent(out), optional  SFCDATA_3D 
)

Read a record from a netcdf file.

Parameters
[in]fieldname of field to be read
[in]tile_numgrid tile number
[in]imoi-dimension of field
[in]jmoj-dimension of field
[in]lmonumber of vertical levels of field
[out]sfcdata1-d array containing field data
[out]sfcdata_3d3-d array containing field data
Author
George Gayno NCEP/EMC

Definition at line 3171 of file sfc_input_data.F90.

References program_setup::data_dir_input_grid, and program_setup::sfc_files_input_grid.

◆ read_grib_soil()

subroutine sfc_input_data::read_grib_soil ( character(len=20), intent(in)  vname,
character(len=20), intent(in)  vname_file,
integer, intent(in)  lugb,
integer, intent(in)  pdt_num,
real(esmf_kind_r8), dimension(:,:,:), intent(inout)  dummy3d 
)

Read soil temperature and soil moisture fields from a GRIB2 file.

Parameters
[in]vnamevariable name in varmap table
[in]vname_filevariable name in grib2 file
[in]lugblogical unit number for surface grib2 file
[in]pdt_numproduct definition template number.
[in,out]dummy3darray of soil data
Author
George Gayno NCEP/EMC

Definition at line 3216 of file sfc_input_data.F90.

References program_setup::get_var_cond(), model_grid::i_input, model_grid::j_input, and program_setup::read_from_input.

◆ read_input_sfc_data()

subroutine, public sfc_input_data::read_input_sfc_data ( integer, intent(in)  localpet)

Driver to read input grid surface data.

Parameters
[in]localpetESMF local persistent execution thread
Author
George Gayno NCEP/EMC

Definition at line 98 of file sfc_input_data.F90.

References program_setup::data_dir_input_grid, model_grid::i_input, program_setup::input_type, model_grid::j_input, program_setup::sfc_files_input_grid, and atm_input_data::terrain_input_grid.

◆ read_input_sfc_grib2_file()

subroutine sfc_input_data::read_input_sfc_grib2_file ( integer, intent(in)  localpet)

Read input grid surface data from a grib2 file.

Parameters
[in]localpetESMF local persistent execution thread
Author
Larissa Reames

Definition at line 1774 of file sfc_input_data.F90.

References model_grid::input_grid_type, search_util::search(), program_setup::sotyp_from_climo, atm_input_data::terrain_input_grid, and program_setup::vgtyp_from_climo.

◆ read_input_sfc_netcdf_file()

subroutine sfc_input_data::read_input_sfc_netcdf_file ( integer, intent(in)  localpet)

Read input grid surface data from tiled 'history' files (netcdf) or gaussian netcdf files.

Parameters
[in]localpetESMF local persistent execution thread
Author
George Gayno NCEP/EMC

Definition at line 1413 of file sfc_input_data.F90.

References program_setup::data_dir_input_grid, model_grid::i_input, program_setup::input_type, model_grid::j_input, model_grid::num_tiles_input_grid, program_setup::orog_dir_input_grid, program_setup::orog_files_input_grid, program_setup::sfc_files_input_grid, and atm_input_data::terrain_input_grid.

◆ read_input_sfc_restart_file()

subroutine sfc_input_data::read_input_sfc_restart_file ( integer, intent(in)  localpet)

Read input grid surface data from fv3 tiled warm 'restart' files.

Parameters
[in]localpetESMF local persistent execution thread
Author
George Gayno NCEP/EMC

Definition at line 1096 of file sfc_input_data.F90.

References program_setup::data_dir_input_grid, model_grid::i_input, model_grid::j_input, model_grid::num_tiles_input_grid, program_setup::orog_dir_input_grid, program_setup::orog_files_input_grid, program_setup::sfc_files_input_grid, and atm_input_data::terrain_input_grid.

Variable Documentation

◆ canopy_mc_input_grid

type(esmf_field), public sfc_input_data::canopy_mc_input_grid

canopy moist content

Definition at line 56 of file sfc_input_data.F90.

◆ f10m_input_grid

type(esmf_field), public sfc_input_data::f10m_input_grid

log((z0+10)*1/z0)

Definition at line 57 of file sfc_input_data.F90.

◆ ffmm_input_grid

type(esmf_field), public sfc_input_data::ffmm_input_grid

log((z0+z1)*1/z0) See sfc_diff.f for details.

Definition at line 58 of file sfc_input_data.F90.

◆ icet_default

real sfc_input_data::icet_default = 265.0

Default value of soil and skin temperature (K) over ice.

Definition at line 54 of file sfc_input_data.F90.

◆ lai_input_grid

type(esmf_field), public sfc_input_data::lai_input_grid

leaf area index

Definition at line 80 of file sfc_input_data.F90.

◆ landsea_mask_input_grid

type(esmf_field), public sfc_input_data::landsea_mask_input_grid

land sea mask; 0-water, 1-land, 2-ice

Definition at line 60 of file sfc_input_data.F90.

◆ lsoil_input

integer, public sfc_input_data::lsoil_input =4

number of soil layers, no longer hardwired to allow for 7 layers of soil for the RUC LSM

Definition at line 84 of file sfc_input_data.F90.

◆ max_veg_greenness_input_grid

type(esmf_field), public sfc_input_data::max_veg_greenness_input_grid

shdmax

Definition at line 81 of file sfc_input_data.F90.

◆ min_veg_greenness_input_grid

type(esmf_field), public sfc_input_data::min_veg_greenness_input_grid

shdmin

Definition at line 82 of file sfc_input_data.F90.

◆ q2m_input_grid

type(esmf_field), public sfc_input_data::q2m_input_grid

2-m spec hum

Definition at line 62 of file sfc_input_data.F90.

◆ seaice_depth_input_grid

type(esmf_field), public sfc_input_data::seaice_depth_input_grid

sea ice depth

Definition at line 63 of file sfc_input_data.F90.

◆ seaice_fract_input_grid

type(esmf_field), public sfc_input_data::seaice_fract_input_grid

sea ice fraction

Definition at line 64 of file sfc_input_data.F90.

◆ seaice_skin_temp_input_grid

type(esmf_field), public sfc_input_data::seaice_skin_temp_input_grid

sea ice skin temp

Definition at line 65 of file sfc_input_data.F90.

◆ skin_temp_input_grid

type(esmf_field), public sfc_input_data::skin_temp_input_grid

skin temp/sst

Definition at line 66 of file sfc_input_data.F90.

◆ snow_depth_input_grid

type(esmf_field), public sfc_input_data::snow_depth_input_grid

snow dpeth

Definition at line 67 of file sfc_input_data.F90.

◆ snow_liq_equiv_input_grid

type(esmf_field), public sfc_input_data::snow_liq_equiv_input_grid

snow liq equiv depth

Definition at line 68 of file sfc_input_data.F90.

◆ soil_temp_input_grid

type(esmf_field), public sfc_input_data::soil_temp_input_grid

3-d soil temp

Definition at line 69 of file sfc_input_data.F90.

◆ soil_type_input_grid

type(esmf_field), public sfc_input_data::soil_type_input_grid

soil type

Definition at line 70 of file sfc_input_data.F90.

◆ soilm_liq_input_grid

type(esmf_field), public sfc_input_data::soilm_liq_input_grid

3-d liquid soil moisture

Definition at line 71 of file sfc_input_data.F90.

◆ soilm_tot_input_grid

type(esmf_field), public sfc_input_data::soilm_tot_input_grid

3-d total soil moisture

Definition at line 72 of file sfc_input_data.F90.

◆ srflag_input_grid

type(esmf_field), public sfc_input_data::srflag_input_grid

snow/rain flag

Definition at line 73 of file sfc_input_data.F90.

◆ t2m_input_grid

type(esmf_field), public sfc_input_data::t2m_input_grid

2-m temperature

Definition at line 74 of file sfc_input_data.F90.

◆ tprcp_input_grid

type(esmf_field), public sfc_input_data::tprcp_input_grid

precip

Definition at line 75 of file sfc_input_data.F90.

◆ ustar_input_grid

type(esmf_field), public sfc_input_data::ustar_input_grid

fric velocity

Definition at line 76 of file sfc_input_data.F90.

◆ veg_greenness_input_grid

type(esmf_field), public sfc_input_data::veg_greenness_input_grid

vegetation fraction

Definition at line 79 of file sfc_input_data.F90.

◆ veg_type_input_grid

type(esmf_field), public sfc_input_data::veg_type_input_grid

vegetation type

Definition at line 77 of file sfc_input_data.F90.

◆ veg_type_landice_input

integer, public sfc_input_data::veg_type_landice_input = 15

NOAH land ice option defined at this veg type.

Default is igbp.

Definition at line 51 of file sfc_input_data.F90.

◆ z0_input_grid

type(esmf_field), public sfc_input_data::z0_input_grid

roughness length

Definition at line 78 of file sfc_input_data.F90.