mosaic2_mod

Implements some utility routines to read mosaic information. More...

Data Types
interface	calc_mosaic_grid_area
interface	calc_mosaic_grid_great_circle_area
interface	get_mosaic_xgrid
interface	is_inside_polygon

Functions/Subroutines
	calc_mosaic_grid_area_r4
	calc_mosaic_grid_area_r8
	calc_mosaic_grid_great_circle_area_r4
	calc_mosaic_grid_great_circle_area_r8
subroutine, public	get_mosaic_contact (fileobj, tile1, tile2, istart1, iend1, jstart1, jend1, istart2, iend2, jstart2, jend2)
	Get contact information from mosaic_file Example usage: call get_mosaic_contact(mosaic_file, tile1, tile2, istart1, iend1, jstart1, jend1, istart2, iend2, jstart2, jend2) More...
subroutine, public	get_mosaic_grid_sizes (fileobj, nx, ny)
	Get grid size of each tile from mosaic_file. More...
integer function, public	get_mosaic_ncontacts (fileobj)
	Get number of contacts in the mosaic_file. More...
integer function, public	get_mosaic_ntiles (fileobj)
	Get number of tiles in the mosaic_file. More...
subroutine, public	get_mosaic_tile_grid (grid_file, fileobj, domain, tile_count)
	Gets the name of a mosaic tile grid file. More...
	get_mosaic_xgrid_r4
	get_mosaic_xgrid_r8
integer function, public	get_mosaic_xgrid_size (fileobj)
	return exchange grid size of mosaic xgrid file. More...
	is_inside_polygon_r4
	is_inside_polygon_r8
subroutine	mosaic_init ()
	Initialize the mosaic_mod. Initialization routine for the mosaic module. It writes the version information to the log file. Example usage: call mosaic_init ( )
integer function	parse_string (string, set, sval)
integer function	transfer_to_model_index (istart, iend, refine_ratio)

Variables
character(len= *), parameter	all
integer, parameter	direction
character(len= *), parameter	directory
character(len= *), parameter	files
character(len= *), parameter	for
character(len= *), parameter	grid
integer, parameter	in
integer, parameter	max_name = 256
integer, parameter	model
logical	module_is_initialized = .true.
character(len= *), parameter	root
integer, parameter	size
integer, parameter	supergrid
integer, parameter	x_refine = 2
integer, parameter	y
integer, parameter	y_refine = 2

Detailed Description

Implements some utility routines to read mosaic information.

Author

Zhi Liang

Implements some utility routines to read mosaic information. The information includes number of tiles and contacts in the mosaic, mosaic grid resolution of each tile, mosaic contact information, mosaic exchange grid information. Each routine will call a C-version routine to get these information.

---

Data Type Documentation

mosaic2_mod::calc_mosaic_grid_area

interface mosaic2_mod::calc_mosaic_grid_area

Definition at line 74 of file mosaic2.F90.

Private Member Functions
	calc_mosaic_grid_area_r4
	calc_mosaic_grid_area_r8

mosaic2_mod::calc_mosaic_grid_great_circle_area

interface mosaic2_mod::calc_mosaic_grid_great_circle_area

Definition at line 79 of file mosaic2.F90.

Private Member Functions
	calc_mosaic_grid_great_circle_area_r4
	calc_mosaic_grid_great_circle_area_r8

mosaic2_mod::get_mosaic_xgrid

interface mosaic2_mod::get_mosaic_xgrid

Definition at line 69 of file mosaic2.F90.

Private Member Functions
	get_mosaic_xgrid_r4
	get_mosaic_xgrid_r8

mosaic2_mod::is_inside_polygon

interface mosaic2_mod::is_inside_polygon

Definition at line 84 of file mosaic2.F90.

Private Member Functions
	is_inside_polygon_r4
	is_inside_polygon_r8

Function/Subroutine Documentation

get_mosaic_contact()

subroutine, public mosaic2_mod::get_mosaic_contact	(	type(fmsnetcdffile_t), intent(in)	fileobj,
		integer, dimension(:), intent(inout)	tile1,
		integer, dimension(:), intent(inout)	tile2,
		integer, dimension(:), intent(inout)	istart1,
		integer, dimension(:), intent(inout)	iend1,
		integer, dimension(:), intent(inout)	jstart1,
		integer, dimension(:), intent(inout)	jend1,
		integer, dimension(:), intent(inout)	istart2,
		integer, dimension(:), intent(inout)	iend2,
		integer, dimension(:), intent(inout)	jstart2,
		integer, dimension(:), intent(inout)	jend2
	)

Get contact information from mosaic_file
Example usage: call get_mosaic_contact(mosaic_file, tile1, tile2, istart1, iend1, jstart1, jend1, istart2, iend2, jstart2, jend2)

Parameters

	fileobj	mosaic file object
[in,out]	tile1	list of tile numbers in tile 1 of each contact
[in,out]	tile2	list of tile numbers in tile 2 of each contact
[in,out]	istart1	list of starting i-index in tile 1 of each contact
[in,out]	iend1	list of ending i-index in tile 1 of each contact
[in,out]	jstart1	list of starting j-index in tile 1 of each contact
[in,out]	jend1	list of ending j-index in tile 1 of each contact
[in,out]	istart2	list of starting i-index in tile 2 of each contact
[in,out]	iend2	list of ending i-index in tile 2 of each contact
[in,out]	jstart2	list of starting j-index in tile 2 of each contact
[in,out]	jend2	list of ending j-index in tile 2 of each contact

Definition at line 221 of file mosaic2.F90.

get_mosaic_grid_sizes()

subroutine, public mosaic2_mod::get_mosaic_grid_sizes	(	type(fmsnetcdffile_t), intent(in)	fileobj,
		integer, dimension(:), intent(inout)	nx,
		integer, dimension(:), intent(inout)	ny
	)

Get grid size of each tile from mosaic_file.

Parameters

	fileobj	mosaic file object
[in,out]	nx	List of grid size in x-direction of each tile
[in,out]	ny	List of grid size in y-direction of each tile Example usage: call get_mosaic_grid_sizes(mosaic_file, nx, ny)

Definition at line 172 of file mosaic2.F90.

get_mosaic_ncontacts()

integer function, public mosaic2_mod::get_mosaic_ncontacts

(

type(fmsnetcdffile_t), intent(in)

fileobj

)

Get number of contacts in the mosaic_file.

Parameters

fileobj

mosaic file object

Returns

number of contacts in a given file
Example usage: ntiles = get_mosaic_ncontacts( mosaic_file)

Definition at line 150 of file mosaic2.F90.

get_mosaic_ntiles()

integer function, public mosaic2_mod::get_mosaic_ntiles

(

type(fmsnetcdffile_t), intent(in)

fileobj

)

Get number of tiles in the mosaic_file.

Parameters

fileobj

mosaic file object

Returns

Number of tiles in given file
Example usage: ntiles = get_mosaic_ntiles( mosaic_file)

Definition at line 134 of file mosaic2.F90.

get_mosaic_tile_grid()

subroutine, public mosaic2_mod::get_mosaic_tile_grid	(	character(len=*), intent(out)	grid_file,
		type(fmsnetcdffile_t), intent(in)	fileobj,
		type(domain2d), intent(in)	domain,
		integer, intent(in), optional	tile_count
	)

Gets the name of a mosaic tile grid file.

Parameters

[out]	grid_file	name of grid file
	fileobj	mosaic file object
	domain	current domain
	tile_count	optional count of tiles

Definition at line 428 of file mosaic2.F90.

get_mosaic_xgrid_size()

integer function, public mosaic2_mod::get_mosaic_xgrid_size

(

type(fmsnetcdffile_t), intent(in)

fileobj

)

return exchange grid size of mosaic xgrid file.

Example usage: nxgrid = get_mosaic_xgrid_size(xgrid_file)

Definition at line 118 of file mosaic2.F90.