land_iau_mod Module Reference

TODO: replace with appropriate licence for CCPP. More...

Data Types
type	land_iau_control_type
type	land_iau_external_data_type
type	land_iau_state_type

Functions/Subroutines
subroutine, public	land_iau_mod_set_control (land_iau_control, fn_nml, input_nml_file, me, mpi_root, isc, jsc, nx, ny, tile_num, nblks, blksz, lsoil, lsnow_lsm, dtp, fhour, errmsg, errflg)
subroutine, public	land_iau_mod_init (land_iau_control, land_iau_data, land_iau_state, errmsg, errflg)
subroutine, public	land_iau_mod_final (land_iau_control, land_iau_data, land_iau_state, errmsg, errflg)
subroutine, public	land_iau_mod_getiauforcing (land_iau_control, land_iau_data, land_iau_state, errmsg, errflg)
subroutine, public	calculate_landinc_mask (swe, vtype, stype, lensfc, veg_type_landice, mask)
	Calculate soil mask for land on model grid. Output is 1 - soil, 2 - snow-covered, 0 - land ice, -1 not land.

Detailed Description

TODO: replace with appropriate licence for CCPP.

Land IAU (Incremental Analysis Update) module, for the NoahMP soil/snow temperature (can be extended to include soil moisture)

• reads settings from namelist file (which indicates if IAU increments are available or not)
  • reads in DA increments from GSI/JEDI DA at the start of (the DA) cycle
  • maps increments to FV3 grid points belonging to mpi process
  • interpolates temporally (with filter-weights if required by configuration)
  • updates states with the interpolated increments March, 2024: Tseganeh Z. Gichamo, (EMC) based on the FV3 IAU mod by Xi.Chen xi.ch.nosp@m.en@n.nosp@m.oaa.g.nosp@m.ov and Philip Pegion, PSL phili.nosp@m.p.pe.nosp@m.gion@.nosp@m.noaa.nosp@m..gov

Argument table <br>

Function/Subroutine Documentation

calculate_landinc_mask()

subroutine, public land_iau_mod::calculate_landinc_mask	(	real(kind=kind_phys), dimension(lensfc), intent(in)	swe,
		integer, dimension(lensfc), intent(in)	vtype,
		integer, dimension(lensfc), intent(in)	stype,
		integer, intent(in)	lensfc,
		integer, intent(in)	veg_type_landice,
		integer, dimension(lensfc), intent(out)	mask
	)

Calculate soil mask for land on model grid. Output is 1 - soil, 2 - snow-covered, 0 - land ice, -1 not land.

Parameters

[in]	lensfc	Number of land points for this tile
[in]	veg_type_landice	Value of vegetion class that indicates land-ice
[in]	stype	Soil type
[in]	swe	Model snow water equivalent
[in]	vtype	Model vegetation type
[out]	mask	Land mask for increments

Author

Clara Draper

Date

March 2021

Author

Yuan Xue: introduce stype to make the mask calculation more generic

Definition at line 651 of file lnd_iau_mod.F90.

land_iau_mod_final()

subroutine, public land_iau_mod::land_iau_mod_final	(	type(land_iau_control_type), intent(in)	land_iau_control,
		type(land_iau_external_data_type), intent(inout)	land_iau_data,
		type(land_iau_state_type), intent(inout)	land_iau_state,
		character(len=*), intent(out)	errmsg,
		integer, intent(out)	errflg
	)

Definition at line 366 of file lnd_iau_mod.F90.

land_iau_mod_getiauforcing()

subroutine, public land_iau_mod::land_iau_mod_getiauforcing	(	type(land_iau_control_type), intent(inout)	land_iau_control,
		type(land_iau_external_data_type), intent(inout)	land_iau_data,
		type(land_iau_state_type), intent(in)	land_iau_state,
		character(len=*), intent(out)	errmsg,
		integer, intent(out)	errflg
	)

Definition at line 388 of file lnd_iau_mod.F90.

land_iau_mod_init()

subroutine, public land_iau_mod::land_iau_mod_init	(	type (land_iau_control_type), intent(inout)	land_iau_control,
		type (land_iau_external_data_type), intent(inout)	land_iau_data,
		type(land_iau_state_type), intent(inout)	land_iau_state,
		character(len=*), intent(out)	errmsg,
		integer, intent(out)	errflg
	)

Definition at line 235 of file lnd_iau_mod.F90.

land_iau_mod_set_control()

subroutine, public land_iau_mod::land_iau_mod_set_control	(	type (land_iau_control_type), intent(inout)	land_iau_control,
		character(*), intent(in)	fn_nml,
		character(len=:), dimension(:), intent(in), pointer	input_nml_file,
		integer, intent(in)	me,
		integer, intent(in)	mpi_root,
		integer, intent(in)	isc,
		integer, intent(in)	jsc,
		integer, intent(in)	nx,
		integer, intent(in)	ny,
		integer, intent(in)	tile_num,
		integer, intent(in)	nblks,
		integer, dimension(:), intent(in)	blksz,
		integer, intent(in)	lsoil,
		integer, intent(in)	lsnow_lsm,
		real(kind=kind_phys), intent(in)	dtp,
		real(kind=kind_phys), intent(in)	fhour,
		character(len=*), intent(out)	errmsg,
		integer, intent(out)	errflg
	)

Parameters

[in]	fn_nml	namelist filename for surface data cycling
[in]	mpi_root	MPI rank of master atmosphere processor
[in]	dtp	physics timestep in seconds
[in]	fhour	current forecast hour

land iau setting read from namelist

Definition at line 101 of file lnd_iau_mod.F90.