fv_restart_mod Module Reference

Functions/Subroutines
subroutine, public	fv_restart_init ()
subroutine, public	fv_restart (fv_domain, Atm, dt_atmos, seconds, days, cold_start, grid_type, grids_on_this_pe)
	The subroutine 'fv_restart' initializes the model state, including prognaostic variables and several auxiliary pressure variables. More...
subroutine, public	setup_nested_boundary_halo (Atm, proc_in)
subroutine	fill_nested_grid_topo_halo (Atm, proc_in)
subroutine	fill_nested_grid_topo (Atm, proc_in)
	The subroutine 'fill_nested_grid_topo' fills the nested grid with topo to enable boundary smoothing. More...
subroutine	fill_nested_grid_data (Atm, proc_in)
subroutine	fill_nested_grid_data_end (Atm, proc_in)
	The subroutine ' fill_nested_grid_data_end' actually sets up the coarse-grid TOPOGRAPHY. More...
subroutine, public	fv_write_restart (Atm, grids_on_this_pe, timestamp)
	The subroutine 'fv_write_restart' writes restart files to disk. More...
subroutine, public	fv_restart_end (Atm, grids_on_this_pe)
	The subroutine 'fv_restart_end' writes ending restart files, terminates I/O, and prints out diagnostics including global totals and checksums. More...
subroutine, public	d2c_setup (u, v, ua, va, uc, vc, dord4, isd, ied, jsd, jed, is, ie, js, je, npx, npy, grid_type, nested, se_corner, sw_corner, ne_corner, nw_corner, rsin_u, rsin_v, cosa_s, rsin2, regional)
subroutine, public	d2a_setup (u, v, ua, va, dord4, isd, ied, jsd, jed, is, ie, js, je, npx, npy, grid_type, nested, cosa_s, rsin2, regional)
subroutine	pmaxmn_g (qname, q, is, ie, js, je, km, fac, area, domain)
	The subroutine 'pmaxn_g' writes domain max, min, and averages quantities. More...

Variables
real(kind=r_grid), parameter	cnst_0p20 =0.20d0
logical	module_is_initialized = .FALSE.

Function/Subroutine Documentation

d2a_setup()

subroutine, public fv_restart_mod::d2a_setup	(	real, dimension(isd:ied,jsd:jed+1), intent(in)	u,
		real, dimension(isd:ied+1,jsd:jed), intent(in)	v,
		real, dimension(isd:ied ,jsd:jed ), intent(out)	ua,
		real, dimension(isd:ied ,jsd:jed ), intent(out)	va,
		logical, intent(in)	dord4,
		integer, intent(in)	isd,
		integer, intent(in)	ied,
		integer, intent(in)	jsd,
		integer, intent(in)	jed,
		integer, intent(in)	is,
		integer, intent(in)	ie,
		integer, intent(in)	js,
		integer, intent(in)	je,
		integer, intent(in)	npx,
		integer, intent(in)	npy,
		integer, intent(in)	grid_type,
		logical, intent(in)	nested,
		real, dimension(isd:ied,jsd:jed), intent(in)	cosa_s,
		real, dimension(isd:ied,jsd:jed), intent(in)	rsin2,
		logical, intent(in)	regional
	)

Definition at line 1826 of file fv_restart.F90.

d2c_setup()

subroutine, public fv_restart_mod::d2c_setup	(	real, dimension(isd:ied,jsd:jed+1), intent(in)	u,
		real, dimension(isd:ied+1,jsd:jed), intent(in)	v,
		real, dimension(isd:ied ,jsd:jed ), intent(out)	ua,
		real, dimension(isd:ied ,jsd:jed ), intent(out)	va,
		real, dimension(isd:ied+1,jsd:jed ), intent(out)	uc,
		real, dimension(isd:ied ,jsd:jed+1), intent(out)	vc,
		logical, intent(in)	dord4,
		integer, intent(in)	isd,
		integer, intent(in)	ied,
		integer, intent(in)	jsd,
		integer, intent(in)	jed,
		integer, intent(in)	is,
		integer, intent(in)	ie,
		integer, intent(in)	js,
		integer, intent(in)	je,
		integer, intent(in)	npx,
		integer, intent(in)	npy,
		integer, intent(in)	grid_type,
		logical, intent(in)	nested,
		logical, intent(in)	se_corner,
		logical, intent(in)	sw_corner,
		logical, intent(in)	ne_corner,
		logical, intent(in)	nw_corner,
		real, dimension(isd:ied+1,jsd:jed), intent(in)	rsin_u,
		real, dimension(isd:ied,jsd:jed+1), intent(in)	rsin_v,
		real, dimension(isd:ied,jsd:jed), intent(in)	cosa_s,
		real, dimension(isd:ied,jsd:jed), intent(in)	rsin2,
		logical, intent(in)	regional
	)

Definition at line 1551 of file fv_restart.F90.

fill_nested_grid_data()

subroutine fv_restart_mod::fill_nested_grid_data ( type(fv_atmos_type), dimension(:), intent(inout)  Atm, logical, intent(in), optional  proc_in  )

private

Definition at line 945 of file fv_restart.F90.

fill_nested_grid_data_end()

subroutine fv_restart_mod::fill_nested_grid_data_end ( type(fv_atmos_type), intent(inout)  Atm, logical, intent(in), optional  proc_in  )

private

The subroutine ' fill_nested_grid_data_end' actually sets up the coarse-grid TOPOGRAPHY.

Definition at line 1323 of file fv_restart.F90.

fill_nested_grid_topo()

subroutine fv_restart_mod::fill_nested_grid_topo ( type(fv_atmos_type), intent(inout)  Atm, logical, intent(in), optional  proc_in  )

private

The subroutine 'fill_nested_grid_topo' fills the nested grid with topo to enable boundary smoothing.

Interior topography is then over-written in get_external_ic.

Definition at line 885 of file fv_restart.F90.

fill_nested_grid_topo_halo()

subroutine fv_restart_mod::fill_nested_grid_topo_halo ( type(fv_atmos_type), intent(inout)  Atm, logical, intent(in), optional  proc_in  )

private

Definition at line 864 of file fv_restart.F90.

fv_restart()

subroutine, public fv_restart_mod::fv_restart	(	type(domain2d), intent(inout)	fv_domain,
		type(fv_atmos_type), dimension(:), intent(inout)	Atm,
		real, intent(in)	dt_atmos,
		integer, intent(out)	seconds,
		integer, intent(out)	days,
		logical, intent(inout)	cold_start,
		integer, intent(in)	grid_type,
		logical, dimension(:), intent(inout)	grids_on_this_pe
	)

The subroutine 'fv_restart' initializes the model state, including prognaostic variables and several auxiliary pressure variables.

The modules also writes out restart files at the end of the model run, and prints out diagnostics of the initial state. There are several options to control the initialization process.

Definition at line 196 of file fv_restart.F90.

fv_restart_end()

subroutine, public fv_restart_mod::fv_restart_end	(	type(fv_atmos_type), dimension(:), intent(inout)	Atm,
		logical, dimension(:), intent(inout)	grids_on_this_pe
	)

The subroutine 'fv_restart_end' writes ending restart files, terminates I/O, and prints out diagnostics including global totals and checksums.

Definition at line 1438 of file fv_restart.F90.

fv_restart_init()

subroutine, public fv_restart_mod::fv_restart_init

(

)

Definition at line 186 of file fv_restart.F90.

fv_write_restart()

subroutine, public fv_restart_mod::fv_write_restart	(	type(fv_atmos_type), dimension(:), intent(inout)	Atm,
		logical, dimension(:), intent(in)	grids_on_this_pe,
		character(len=*), intent(in)	timestamp
	)

The subroutine 'fv_write_restart' writes restart files to disk.

This subroutine may be called during an integration to write out intermediate restart files.

Definition at line 1420 of file fv_restart.F90.

pmaxmn_g()

subroutine fv_restart_mod::pmaxmn_g ( character(len=*), intent(in)  qname, real, dimension(is-3:ie+3, js-3:je+3, km), intent(in)  q, integer, intent(in)  is, integer, intent(in)  ie, integer, intent(in)  js, integer, intent(in)  je, integer, intent(in)  km, real, intent(in)  fac, real(kind=r_grid), dimension(is-3:ie+3, js-3:je+3), intent(in)  area, type(domain2d), intent(inout)  domain  )

private

The subroutine 'pmaxn_g' writes domain max, min, and averages quantities.

Definition at line 1959 of file fv_restart.F90.

setup_nested_boundary_halo()

subroutine, public fv_restart_mod::setup_nested_boundary_halo	(	type(fv_atmos_type), intent(inout)	Atm,
		logical, intent(in), optional	proc_in
	)

Definition at line 716 of file fv_restart.F90.

Variable Documentation

cnst_0p20

real(kind=r_grid), parameter fv_restart_mod::cnst_0p20 =0.20d0

private

Definition at line 178 of file fv_restart.F90.

module_is_initialized

logical fv_restart_mod::module_is_initialized = .FALSE.

private

Definition at line 180 of file fv_restart.F90.