type_geom Module Reference

Generic ranks, dimensions and types. More...

Data Types
type	geom_type

Functions/Subroutines
subroutine	geom_partial_dealloc (geom)
	Release memory (partial) More...
subroutine	geom_dealloc (geom)
	Release memory. More...
subroutine	geom_setup (geom, mpl, rng, nam, afunctionspace, fieldset)
	Setup geometry. More...
subroutine	geom_from_atlas (geom, mpl, afunctionspace, fieldset)
	Set geometry from fieldset. More...
subroutine	geom_setup_universe (geom, mpl, rng, nam)
	Setup universe. More...
subroutine	geom_setup_c0 (geom, mpl)
	Setup subset Sc0. More...
subroutine	geom_setup_independent_levels (geom, mpl)
	Setup independent levels. More...
subroutine	geom_setup_mask_distance (geom, mpl, nam)
	Setup minimum distance to mask. More...
subroutine	geom_setup_mask_check (geom, mpl, nam)
	Setup mask checking tool. More...
subroutine	geom_index_from_lonlat (geom, mpl, nam, lon, lat, il0, iproc, ic0a, gmask)
	Get nearest neighbor index from longitude/latitude/level. More...
subroutine	geom_setup_dirac (geom, mpl, nam)
	Setup dirac indices. More...
subroutine	geom_check_arc (geom, mpl, il0, lon_s, lat_s, lon_e, lat_e, valid)
	Check if an arc is crossing boundaries. More...
subroutine	geom_copy_c0a_to_mga_int_single (geom, mpl, fld_c0a, fld_mga)
	Copy from subset Sc0 to model grid, halo A, single field. More...
subroutine	geom_copy_c0a_to_mga_int_all (geom, mpl, nam, fld_c0a, fld_mga)
	Copy from subset Sc0 to model grid, halo A, all fields. More...
subroutine	geom_copy_mga_to_c0a_int_single (geom, mpl, fld_mga, fld_c0a)
	Copy from model grid to subset Sc0, halo A, single field. More...
subroutine	geom_copy_mga_to_c0a_int_all (geom, mpl, nam, fld_c0a, fld_mga)
	Copy from model grid to subset Sc0, halo A, all fields. More...
subroutine	geom_copy_c0a_to_mga_real_single (geom, mpl, fld_c0a, fld_mga)
	Copy from subset Sc0 to model grid, halo A, single field. More...
subroutine	geom_copy_c0a_to_mga_real_all (geom, mpl, nam, fld_c0a, fld_mga)
	Copy from subset Sc0 to model grid, halo A, all fields. More...
subroutine	geom_copy_mga_to_c0a_real_single (geom, mpl, fld_mga, fld_c0a)
	Copy from model grid to subset Sc0, halo A, single field. More...
subroutine	geom_copy_mga_to_c0a_real_all (geom, mpl, nam, fld_c0a, fld_mga)
	Copy from model grid to subset Sc0, halo A, all fields. More...
subroutine	geom_copy_c0a_to_mga_logical_single (geom, mpl, fld_c0a, fld_mga)
	Copy from subset Sc0 to model grid, halo A, single field. More...
subroutine	geom_copy_c0a_to_mga_logical_all (geom, mpl, nam, fld_c0a, fld_mga)
	Copy from subset Sc0 to model grid, halo A, all fields. More...
subroutine	geom_copy_mga_to_c0a_logical_single (geom, mpl, fld_mga, fld_c0a)
	Copy from model grid to subset Sc0, halo A, single field. More...
subroutine	geom_copy_mga_to_c0a_logical_all (geom, mpl, nam, fld_c0a, fld_mga)
	Copy from model grid to subset Sc0, halo A, all fields. More...
subroutine	geom_fieldset_to_c0 (geom, mpl, nam, fieldset, fld_c0a)
	Fieldset to Fortran array on subset Sc0. More...
subroutine	geom_c0_to_fieldset (geom, mpl, nam, fld_c0a, fieldset)
	Fortran array on subset Sc0 to fieldset. More...
subroutine	geom_rand_point (geom, mpl, rng, nam, il0, iproc, ic0a, nr)
	Select random valid point on the horizontal grid. More...
integer function	geom_mg_to_proc (geom, img)
	Conversion from global to processor on model grid. More...
integer function	geom_c0_to_c0a (geom, ic0)
	Conversion from global to halo A on subset Sc0. More...
integer function	geom_c0_to_proc (geom, ic0)
	Conversion from global to processor on subset Sc0. More...
integer function	geom_c0_to_c0u (geom, ic0)
	Conversion from global to universe on subset Sc0. More...

Detailed Description

Generic ranks, dimensions and types.

Subroutines/functions list Instrumentation functions Geometry derived type

Function/Subroutine Documentation

geom_c0_to_c0a()

integer function type_geom::geom_c0_to_c0a ( class(geom_type), intent(in)  geom, integer, intent(in)  ic0  )

private

Conversion from global to halo A on subset Sc0.

Parameters

[in]	geom	Geometry
[in]	ic0	Global index

Definition at line 2274 of file type_geom.F90.

geom_c0_to_c0u()

integer function type_geom::geom_c0_to_c0u ( class(geom_type), intent(in)  geom, integer, intent(in)  ic0  )

private

Conversion from global to universe on subset Sc0.

Parameters

[in]	geom	Geometry
[in]	ic0	Global index

Definition at line 2332 of file type_geom.F90.

geom_c0_to_fieldset()

subroutine type_geom::geom_c0_to_fieldset ( class(geom_type), intent(in)  geom, type(mpl_type), intent(inout)  mpl, type(nam_type), intent(in)  nam, real(kind_real), dimension(geom%nc0a,geom%nl0,nam%nv), intent(in)  fld_c0a, type(fieldset_type), intent(inout)  fieldset  )

private

Fortran array on subset Sc0 to fieldset.

Parameters

[in]	geom	Geometry
[in,out]	mpl	MPI data
[in]	nam	Namelist
[in]	fld_c0a	Field on subset Sc0, halo A

Definition at line 2139 of file type_geom.F90.

geom_c0_to_proc()

integer function type_geom::geom_c0_to_proc ( class(geom_type), intent(in)  geom, integer, intent(in)  ic0  )

private

Conversion from global to processor on subset Sc0.

Parameters

[in]	geom	Geometry
[in]	ic0	Global index

Definition at line 2303 of file type_geom.F90.

geom_check_arc()

subroutine type_geom::geom_check_arc ( class(geom_type), intent(in)  geom, type(mpl_type), intent(inout)  mpl, integer, intent(in)  il0, real(kind_real), intent(in)  lon_s, real(kind_real), intent(in)  lat_s, real(kind_real), intent(in)  lon_e, real(kind_real), intent(in)  lat_e, logical, intent(out)  valid  )

private

Check if an arc is crossing boundaries.

Parameters

[in]	geom	Geometry
[in,out]	mpl	MPI data
[in]	il0	Level
[in]	lon_s	First point longitude
[in]	lat_s	First point latitude
[in]	lon_e	Second point longitude
[in]	lat_e	Second point latitude
[out]	valid	True for valid arcs

Definition at line 1557 of file type_geom.F90.

geom_copy_c0a_to_mga_int_all()

subroutine type_geom::geom_copy_c0a_to_mga_int_all ( class(geom_type), intent(in)  geom, type(mpl_type), intent(inout)  mpl, type(nam_type), intent(in)  nam, integer(kind_int), dimension(geom%nc0a,geom%nl0,nam%nv), intent(in)  fld_c0a, integer(kind_int), dimension(geom%nmga,geom%nl0,nam%nv), intent(out)  fld_mga  )

private

Copy from subset Sc0 to model grid, halo A, all fields.

Parameters

[in]	geom	Geometry
[in,out]	mpl	MPI data
[in]	nam	Namelist
[in]	fld_c0a	Field on subset Sc0, halo A
[out]	fld_mga	Field on model grid, halo A

Definition at line 1669 of file type_geom.F90.

Here is the caller graph for this function:

geom_copy_c0a_to_mga_int_single()

subroutine type_geom::geom_copy_c0a_to_mga_int_single ( class(geom_type), intent(in)  geom, type(mpl_type), intent(inout)  mpl, integer(kind_int), dimension(geom%nc0a,geom%nl0), intent(in)  fld_c0a, integer(kind_int), dimension(geom%nmga,geom%nl0), intent(out)  fld_mga  )

private

Copy from subset Sc0 to model grid, halo A, single field.

Parameters

[in]	geom	Geometry
[in,out]	mpl	MPI data
[in]	fld_c0a	Field on subset Sc0, halo A
[out]	fld_mga	Field on model grid, halo A

Definition at line 1621 of file type_geom.F90.

Here is the caller graph for this function:

geom_copy_c0a_to_mga_logical_all()

subroutine type_geom::geom_copy_c0a_to_mga_logical_all ( class(geom_type), intent(in)  geom, type(mpl_type), intent(inout)  mpl, type(nam_type), intent(in)  nam, logical, dimension(geom%nc0a,geom%nl0,nam%nv), intent(in)  fld_c0a, logical, dimension(geom%nmga,geom%nl0,nam%nv), intent(out)  fld_mga  )

private

Copy from subset Sc0 to model grid, halo A, all fields.

Parameters

[in]	geom	Geometry
[in,out]	mpl	MPI data
[in]	nam	Namelist
[in]	fld_c0a	Field on subset Sc0, halo A
[out]	fld_mga	Field on model grid, halo A

Definition at line 1983 of file type_geom.F90.

Here is the caller graph for this function:

geom_copy_c0a_to_mga_logical_single()

subroutine type_geom::geom_copy_c0a_to_mga_logical_single ( class(geom_type), intent(in)  geom, type(mpl_type), intent(inout)  mpl, logical, dimension(geom%nc0a,geom%nl0), intent(in)  fld_c0a, logical, dimension(geom%nmga,geom%nl0), intent(out)  fld_mga  )

private

Copy from subset Sc0 to model grid, halo A, single field.

Parameters

[in]	geom	Geometry
[in,out]	mpl	MPI data
[in]	fld_c0a	Field on subset Sc0, halo A
[out]	fld_mga	Field on model grid, halo A

Definition at line 1935 of file type_geom.F90.

Here is the caller graph for this function:

geom_copy_c0a_to_mga_real_all()

subroutine type_geom::geom_copy_c0a_to_mga_real_all ( class(geom_type), intent(in)  geom, type(mpl_type), intent(inout)  mpl, type(nam_type), intent(in)  nam, real(kind_real), dimension(geom%nc0a,geom%nl0,nam%nv), intent(in)  fld_c0a, real(kind_real), dimension(geom%nmga,geom%nl0,nam%nv), intent(out)  fld_mga  )

private

Copy from subset Sc0 to model grid, halo A, all fields.

Parameters

[in]	geom	Geometry
[in,out]	mpl	MPI data
[in]	nam	Namelist
[in]	fld_c0a	Field on subset Sc0, halo A
[out]	fld_mga	Field on model grid, halo A

Definition at line 1826 of file type_geom.F90.

Here is the caller graph for this function:

geom_copy_c0a_to_mga_real_single()

subroutine type_geom::geom_copy_c0a_to_mga_real_single ( class(geom_type), intent(in)  geom, type(mpl_type), intent(inout)  mpl, real(kind_real), dimension(geom%nc0a,geom%nl0), intent(in)  fld_c0a, real(kind_real), dimension(geom%nmga,geom%nl0), intent(out)  fld_mga  )

private

Copy from subset Sc0 to model grid, halo A, single field.

Parameters

[in]	geom	Geometry
[in,out]	mpl	MPI data
[in]	fld_c0a	Field on subset Sc0, halo A
[out]	fld_mga	Field on model grid, halo A

Definition at line 1778 of file type_geom.F90.

Here is the caller graph for this function:

geom_copy_mga_to_c0a_int_all()

subroutine type_geom::geom_copy_mga_to_c0a_int_all ( class(geom_type), intent(in)  geom, type(mpl_type), intent(inout)  mpl, type(nam_type), intent(in)  nam, integer(kind_int), dimension(geom%nc0a,geom%nl0,nam%nv), intent(out)  fld_c0a, integer(kind_int), dimension(geom%nmga,geom%nl0,nam%nv), intent(in)  fld_mga  )

private

Copy from model grid to subset Sc0, halo A, all fields.

Parameters

[in]	geom	Geometry
[in,out]	mpl	MPI data
[in]	nam	Namelist
[in]	fld_mga	Field on model grid, halo A
[out]	fld_c0a	Field on subset Sc0, halo A

Definition at line 1745 of file type_geom.F90.

Here is the caller graph for this function:

geom_copy_mga_to_c0a_int_single()

subroutine type_geom::geom_copy_mga_to_c0a_int_single ( class(geom_type), intent(in)  geom, type(mpl_type), intent(inout)  mpl, integer(kind_int), dimension(geom%nmga,geom%nl0), intent(in)  fld_mga, integer(kind_int), dimension(geom%nc0a,geom%nl0), intent(out)  fld_c0a  )

private

Copy from model grid to subset Sc0, halo A, single field.

Parameters

[in]	geom	Geometry
[in,out]	mpl	MPI data
[in]	fld_mga	Field on model grid, halo A
[out]	fld_c0a	Field on subset Sc0, halo A

Definition at line 1702 of file type_geom.F90.

Here is the caller graph for this function:

geom_copy_mga_to_c0a_logical_all()

subroutine type_geom::geom_copy_mga_to_c0a_logical_all ( class(geom_type), intent(in)  geom, type(mpl_type), intent(inout)  mpl, type(nam_type), intent(in)  nam, logical, dimension(geom%nc0a,geom%nl0,nam%nv), intent(out)  fld_c0a, logical, dimension(geom%nmga,geom%nl0,nam%nv), intent(in)  fld_mga  )

private

Copy from model grid to subset Sc0, halo A, all fields.

Parameters

[in]	geom	Geometry
[in,out]	mpl	MPI data
[in]	nam	Namelist
[in]	fld_mga	Field on model grid, halo A
[out]	fld_c0a	Field on subset Sc0, halo A

Definition at line 2059 of file type_geom.F90.

Here is the caller graph for this function:

geom_copy_mga_to_c0a_logical_single()

subroutine type_geom::geom_copy_mga_to_c0a_logical_single ( class(geom_type), intent(in)  geom, type(mpl_type), intent(inout)  mpl, logical, dimension(geom%nmga,geom%nl0), intent(in)  fld_mga, logical, dimension(geom%nc0a,geom%nl0), intent(out)  fld_c0a  )

private

Copy from model grid to subset Sc0, halo A, single field.

Parameters

[in]	geom	Geometry
[in,out]	mpl	MPI data
[in]	fld_mga	Field on model grid, halo A
[out]	fld_c0a	Field on subset Sc0, halo A

Definition at line 2016 of file type_geom.F90.

Here is the caller graph for this function:

geom_copy_mga_to_c0a_real_all()

subroutine type_geom::geom_copy_mga_to_c0a_real_all ( class(geom_type), intent(in)  geom, type(mpl_type), intent(inout)  mpl, type(nam_type), intent(in)  nam, real(kind_real), dimension(geom%nc0a,geom%nl0,nam%nv), intent(out)  fld_c0a, real(kind_real), dimension(geom%nmga,geom%nl0,nam%nv), intent(in)  fld_mga  )

private

Copy from model grid to subset Sc0, halo A, all fields.

Parameters

[in]	geom	Geometry
[in,out]	mpl	MPI data
[in]	nam	Namelist
[in]	fld_mga	Field on model grid, halo A
[out]	fld_c0a	Field on subset Sc0, halo A

Definition at line 1902 of file type_geom.F90.

Here is the caller graph for this function:

geom_copy_mga_to_c0a_real_single()

subroutine type_geom::geom_copy_mga_to_c0a_real_single ( class(geom_type), intent(in)  geom, type(mpl_type), intent(inout)  mpl, real(kind_real), dimension(geom%nmga,geom%nl0), intent(in)  fld_mga, real(kind_real), dimension(geom%nc0a,geom%nl0), intent(out)  fld_c0a  )

private

Copy from model grid to subset Sc0, halo A, single field.

Parameters

[in]	geom	Geometry
[in,out]	mpl	MPI data
[in]	fld_mga	Field on model grid, halo A
[out]	fld_c0a	Field on subset Sc0, halo A

Definition at line 1859 of file type_geom.F90.

Here is the caller graph for this function:

geom_dealloc()

subroutine type_geom::geom_dealloc ( class(geom_type), intent(inout)  geom )

private

Release memory.

Parameters

[in,out]

geom

Geometry

Definition at line 321 of file type_geom.F90.

geom_fieldset_to_c0()

subroutine type_geom::geom_fieldset_to_c0 ( class(geom_type), intent(in)  geom, type(mpl_type), intent(inout)  mpl, type(nam_type), intent(in)  nam, type(fieldset_type), intent(in)  fieldset, real(kind_real), dimension(geom%nc0a,geom%nl0,nam%nv), intent(out)  fld_c0a  )

private

Fieldset to Fortran array on subset Sc0.

Parameters

[in]	geom	Geometry
[in,out]	mpl	MPI data
[in]	nam	Namelist
[out]	fld_c0a	Field on subset Sc0, halo A

Definition at line 2093 of file type_geom.F90.

geom_from_atlas()

subroutine type_geom::geom_from_atlas ( class(geom_type), intent(inout)  geom, type(mpl_type), intent(inout)  mpl, type(atlas_functionspace), intent(in)  afunctionspace, type(fieldset_type), intent(in), optional  fieldset  )

private

Set geometry from fieldset.

Parameters

[in,out]	geom	Geometry
[in,out]	mpl	MPI data
[in]	afunctionspace	ATLAS function space

Definition at line 481 of file type_geom.F90.

geom_index_from_lonlat()

subroutine type_geom::geom_index_from_lonlat ( class(geom_type), intent(in)  geom, type(mpl_type), intent(inout)  mpl, type(nam_type), intent(in)  nam, real(kind_real), intent(in)  lon, real(kind_real), intent(in)  lat, integer, intent(in)  il0, integer, intent(out)  iproc, integer, intent(out)  ic0a, logical, intent(out)  gmask  )

private

Get nearest neighbor index from longitude/latitude/level.

Parameters

[in]	geom	Geometry
[in,out]	mpl	MPI data
[in]	nam	Namelist
[in]	lon	Longitude
[in]	lat	Latitude
[in]	il0	Level index
[out]	iproc	Task index
[out]	ic0a	Local index
[out]	gmask	Local mask

Definition at line 1400 of file type_geom.F90.

geom_mg_to_proc()

integer function type_geom::geom_mg_to_proc ( class(geom_type), intent(in)  geom, integer, intent(in)  img  )

private

Conversion from global to processor on model grid.

Parameters

[in]	geom	Geometry
[in]	img	Global index

Definition at line 2240 of file type_geom.F90.

geom_partial_dealloc()

subroutine type_geom::geom_partial_dealloc ( class(geom_type), intent(inout)  geom )

private

Release memory (partial)

Parameters

[in,out]

geom

Geometry

Definition at line 248 of file type_geom.F90.

geom_rand_point()

subroutine type_geom::geom_rand_point ( class(geom_type), intent(in)  geom, type(mpl_type), intent(inout)  mpl, type(rng_type), intent(inout)  rng, type(nam_type), intent(in)  nam, integer, intent(in)  il0, integer, intent(out)  iproc, integer, intent(out)  ic0a, integer, intent(out), optional  nr  )

private

Select random valid point on the horizontal grid.

Parameters

[in]	geom	Geometry
[in,out]	mpl	MPI data
[in,out]	rng	Random number generator
[in]	nam	Namelist
[in]	il0	Level
[out]	iproc	Processor
[out]	ic0a	Local index
[out]	nr	Number of random tries

Definition at line 2185 of file type_geom.F90.

geom_setup()

subroutine type_geom::geom_setup ( class(geom_type), intent(inout)  geom, type(mpl_type), intent(inout)  mpl, type(rng_type), intent(inout)  rng, type(nam_type), intent(in)  nam, type(atlas_functionspace), intent(in)  afunctionspace, type(fieldset_type), intent(in), optional  fieldset  )

private

Setup geometry.

Parameters

[in,out]	geom	Geometry
[in,out]	mpl	MPI data
[in,out]	rng	Random number generator
[in]	nam	Namelist
[in]	afunctionspace	ATLAS function space
[in]	fieldset	Fieldset containing geometry elements

Definition at line 352 of file type_geom.F90.

geom_setup_c0()

subroutine type_geom::geom_setup_c0 ( class(geom_type), intent(inout)  geom, type(mpl_type), intent(inout)  mpl  )

private

Setup subset Sc0.

Parameters

[in,out]	geom	Geometry
[in,out]	mpl	MPI data

Definition at line 778 of file type_geom.F90.

geom_setup_dirac()

subroutine type_geom::geom_setup_dirac ( class(geom_type), intent(inout)  geom, type(mpl_type), intent(inout)  mpl, type(nam_type), intent(in)  nam  )

private

Setup dirac indices.

Parameters

[in,out]	geom	Geometry
[in,out]	mpl	MPI data
[in]	nam	Namelist

Definition at line 1491 of file type_geom.F90.

geom_setup_independent_levels()

subroutine type_geom::geom_setup_independent_levels ( class(geom_type), intent(inout)  geom, type(mpl_type), intent(inout)  mpl  )

private

Setup independent levels.

Parameters

[in,out]	geom	Geometry
[in,out]	mpl	MPI data

Definition at line 1229 of file type_geom.F90.

geom_setup_mask_check()

subroutine type_geom::geom_setup_mask_check ( class(geom_type), intent(inout)  geom, type(mpl_type), intent(inout)  mpl, type(nam_type), intent(in)  nam  )

private

Setup mask checking tool.

Parameters

[in,out]	geom	Geometry
[in,out]	mpl	MPI data
[in]	nam	Namelist

Definition at line 1327 of file type_geom.F90.

geom_setup_mask_distance()

subroutine type_geom::geom_setup_mask_distance ( class(geom_type), intent(inout)  geom, type(mpl_type), intent(inout)  mpl, type(nam_type), intent(in)  nam  )

private

Setup minimum distance to mask.

Parameters

[in,out]	geom	Geometry
[in,out]	mpl	MPI data
[in]	nam	Namelist

Definition at line 1259 of file type_geom.F90.

geom_setup_universe()

subroutine type_geom::geom_setup_universe ( class(geom_type), intent(inout)  geom, type(mpl_type), intent(inout)  mpl, type(rng_type), intent(inout)  rng, type(nam_type), intent(in)  nam  )

private

Setup universe.

Parameters

[in,out]	geom	Geometry
[in,out]	mpl	MPI data
[in,out]	rng	Random number generator
[in]	nam	Namelist

Definition at line 643 of file type_geom.F90.