create_coord.f90 File Reference

This program creates fine grid coordinate file. More...

Functions/Subroutines
program	create_coord
integer(i4) function, dimension(2, 2, ip_npoint)	create_coord_get_offset (id_rho)
	This function compute offset over Arakawa grid points, given refinement factor. More...
subroutine	create_coord_interp (td_var, id_rho, id_offset, id_iext, id_jext)
	This subroutine interpolate variable, given refinment factor. More...

Detailed Description

This program creates fine grid coordinate file.

method

All variables from the input coordinates coarse grid file, are extracted and interpolated to create fine grid coordinates files.

Note

interpolation method could be different for each variable.

how to

to create fine grid coordinates files:

./SIREN/bin/create_coord create_coord.nam

Note

you could find a template of the namelist in templates directory.

create_coord.nam contains 6 namelists:

• logger namelist (namlog)
• config namelist (namcfg)
• coarse grid namelist (namcrs)
• variable namelist (namvar)
• nesting namelist (namnst)
• output namelist (namout)

logger namelist (namlog):

• cn_logfile : log filename
• cn_verbosity : verbosity ('trace','debug','info', 'warning','error','fatal','none')
• in_maxerror : maximum number of error allowed

config namelist (namcfg):

• cn_varcfg : variable configuration file (see ./SIREN/cfg/variable.cfg)
• cn_dimcfg : dimension configuration file. define dimensions allowed (see ./SIREN/cfg/dimension.cfg).
• cn_dumcfg : useless (dummy) configuration file, for useless dimension or variable (see ./SIREN/cfg/dummy.cfg).

coarse grid namelist (namcrs):

• cn_coord0 : coordinate file
• in_perio0 : NEMO periodicity index (see Model Boundary Condition in NEMO documentation)

variable namelist (namvar):

• cn_varinfo : list of variable and extra information about request(s) to be used.
  each elements of cn_varinfo is a string character (separated by ',').
  it is composed of the variable name follow by ':', then request(s) to be used on this variable.
  request could be:

  • int = interpolation method

  • ext = extrapolation method

    requests must be separated by ';' .
    order of requests does not matter.
    

  informations about available method could be find in interp, extrap and filter modules.
  

  Example: 'glamt: int=linear; ext=dist_weight', 'e1t: int=cubic/rhoi'
  

  Note

  If you do not specify a method which is required, default one is applied.

nesting namelist (namnst):
you could define sub domain with coarse grid indices or with coordinates.

Note

if coordinates defined, SIREN does not take into account indices.

• in_imin0 : i-direction lower left point indice of coarse grid subdomain to be used
• in_imax0 : i-direction upper right point indice of coarse grid subdomain to be used
• in_jmin0 : j-direction lower left point indice of coarse grid subdomain to be used
• in_jmax0 : j-direction upper right point indice of coarse grid subdomain to be used
• rn_lonmin0 : lower left longitude of coarse grid subdomain to be used
• rn_lonmax0 : upper right longitude of coarse grid subdomain to be used
• rn_latmin0 : lower left latitude of coarse grid subdomain to be used
• rn_latmax0 : upper right latitude of coarse grid subdomain to be used
• in_rhoi : refinement factor in i-direction
• in_rhoj : refinement factor in j-direction
  

• output namelist (namout):
  • cn_fileout : output coordinate file name

Author

J.Paul

Function/Subroutine Documentation

program create_coord

(

)

Date

November, 2013 - Initial Version

September, 2014

• add header for user
• compute offset considering grid point
• add global attributes in output file

September, 2015

• manage useless (dummy) variable, attributes, and dimension

September, 2016

• allow to use coordinate to define subdomain

October, 2016

• dimension to be used select from configuration file

Note

Software governed by the CeCILL licence (NEMOGCM/NEMO_CeCILL.txt)

integer(i4) function, dimension(2,2,ip_npoint) create_coord::create_coord_get_offset

(

integer(i4), dimension(:), intent(in)

id_rho

)

This function compute offset over Arakawa grid points, given refinement factor.

Author

J.Paul

Date

August, 2014 - Initial Version

Parameters

[in]

id_rho

array of refinement factor

Returns

array of offset

subroutine create_coord::create_coord_interp	(	type(tvar), intent(inout)	td_var,
		integer(i4), dimension(:), intent(in)	id_rho,
		integer(i4), dimension(:,:), intent(in)	id_offset,
		integer(i4), intent(in), optional	id_iext,
		integer(i4), intent(in), optional	id_jext
	)

This subroutine interpolate variable, given refinment factor.

Optionaly, you could specify number of points to be extrapolated in i- and j-direction.
variable mask is first computed (using _FillValue) and interpolated.
variable is then extrapolated, and interpolated.
Finally interpolated mask is applied on refined variable.

Author

J.Paul

Date

November, 2013 - Initial Version

Parameters

[in,out]	td_var	variable strcuture
[in]	id_rho	array of refinement factor
[in]	id_offset	offset between fine grid and coarse grid
[in]	id_iext	number of points to be extrapolated in i-direction
[in]	id_jext	number of points to be extrapolated in j-direction

Todo:

check if mask is really needed