create_restart.f90 File Reference

This program creates restart file. More...

Functions/Subroutines
program	create_restart
type(tvar) function	create_restart_matrix (td_var, td_coord, id_nlevel, id_xghost)
	This function create variable, filled with matrix value. More...
subroutine	create_restart_mask (td_var, td_mask)
	This subroutine use mask to filled land point with _FillValue. More...
subroutine	create_restart_interp (td_var, id_rho, id_offset, id_iext, id_jext)
	This subroutine interpolate variable. More...
subroutine	create_restart_check_depth (td_mpp, td_depth)
	This subroutine get depth variable value in an open mpp structure and check if agree with already input depth variable. More...
subroutine	create_restart_check_time (td_mpp, td_time)
	This subroutine get date and time in an open mpp structure and check if agree with date and time already read. More...

Detailed Description

This program creates restart file.

method

Variables could be extracted from fine grid file, interpolated from coarse grid file or restart file. Variables could also be manually written.
Then they are split over new layout.

Note

method could be different for each variable.

how to

to create restart file:

./SIREN/bin/create_restart create_restart.nam

Note

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

create_restart.nam contains 9 namelists:

• logger namelist (namlog)
• config namelist (namcfg)
• coarse grid namelist (namcrs)
• fine grid namelist (namfin)
• vertical grid namelist (namzgr)
• partial step namelist (namzps)
• 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)

fine grid namelist (namfin):

• cn_coord1 : coordinate file
• cn_bathy1 : bathymetry file
• in_perio1 : NEMO periodicity index

vertical grid namelist (namzgr):

• dn_pp_to_be_computed :
• dn_ppsur : coefficient to compute vertical grid
• dn_ppa0 : coefficient to compute vertical grid
• dn_ppa1 : coefficient to compute vertical grid
• dn_ppa2 : double tanh function parameter
• dn_ppkth : coefficient to compute vertical grid
• dn_ppkth2 : double tanh function parameter
• dn_ppacr : coefficient to compute vertical grid
• dn_ppacr2 : double tanh function parameter
• dn_ppdzmin : minimum vertical spacing
• dn_pphmax : maximum depth
• in_nlevel : number of vertical level

partial step namelist (namzps):

• dn_e3zps_min : minimum thickness of partial step level (meters)
• dn_e3zps_rat : minimum thickness ratio of partial step level

variable namelist (namvar):

• cn_varfile : list of variable, and associated file
  cn_varfile is the path and filename of the file where find variable.
  

  Note

  cn_varfile could be a matrix of value, if you want to filled manually variable value.
  the variable array of value is split into equal subdomain.
  Each subdomain is filled with the corresponding value of the matrix.
  separators used to defined matrix are:

  • ',' for line
  • '/' for row
  • '\' for level
    Example:
    3,2,3/1,4,5 =>

  Examples:

  • 'votemper:gridT.nc', 'vozocrtx:gridU.nc'
  • 'votemper:10\25', 'vozocrtx:gridU.nc'

  to get all variable from one file:

  • 'all:restart.dimg'

• 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
  • flt = filter method
  • min = minimum value
  • max = maximum value
  • unt = new units
  • unf = unit scale factor (linked to new units)

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

  informations about available method could be find in interp, extrap and filter.
  Example: 'votemper: int=linear; flt=hann; ext=dist_weight', 'vosaline: int=cubic'

  Note

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

nesting namelist (namnst):

• in_rhoi : refinement factor in i-direction
• in_rhoj : refinement factor in j-direction

  Note

  coarse grid indices will be computed from fine grid coordinate file.

output namelist (namout):

• cn_fileout : output file
• ln_extrap : extrapolate land point or not
• in_niproc : number of processor in i-direction
• in_njproc : number of processor in j-direction
• in_nproc : total number of processor to be used
• cn_type : output format ('dimg', 'cdf')

Author

J.Paul

Function/Subroutine Documentation

program create_restart

(

)

Date

November, 2013 - Initial Version

September, 2014

• add header for user
• offset computed considering grid point
• add attributes in output variable

June, 2015

• extrapolate all land points, and add ln_extrap in namelist.
• allow to change unit.

September, 2015

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

October, 2016

• dimension to be used select from configuration file

Note

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

subroutine create_restart::create_restart_check_depth	(	type(tmpp), intent(in)	td_mpp,
		type(tvar), intent(inout)	td_depth
	)

This subroutine get depth variable value in an open mpp structure and check if agree with already input depth variable.

Author

J.Paul

Date

November, 2014 - Initial Version

Parameters

[in]	td_mpp	mpp structure
[in,out]	td_depth	depth variable structure

subroutine create_restart::create_restart_check_time	(	type(tmpp), intent(in)	td_mpp,
		type(tvar), intent(inout)	td_time
	)

This subroutine get date and time in an open mpp structure and check if agree with date and time already read.

Author

J.Paul

Date

November, 2014 - Initial Version

Parameters

[in]	td_mpp	mpp structure
[in,out]	td_time	time variable structure

subroutine create_restart::create_restart_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.

Author

J.Paul

Date

November, 2013 - Initial Version

June, 2015

• do not use level anymore (for extrapolation)

Parameters

[in,out]	td_var	variable structure
[in]	id_rho	array of refinment factor
[in]	id_offset	array of offset between fine and coarse grid
[in]	id_iext	i-direction size of extra bands (default=im_minext)
[in]	id_jext	j-direction size of extra bands (default=im_minext)

subroutine create_restart::create_restart_mask	(	type(tvar), intent(inout)	td_var,
		type(tvar), dimension(:), intent(in)	td_mask
	)

This subroutine use mask to filled land point with _FillValue.

Author

J.Paul

Date

November, 2013 - Initial Version

Parameters

[in,out]	td_var	variable structure
[in]	td_mask	mask variable structure

type(tvar) function create_restart::create_restart_matrix	(	type(tvar), intent(in)	td_var,
		type(tmpp), intent(in)	td_coord,
		integer(i4), intent(in)	id_nlevel,
		integer(i4), dimension(:,:), intent(in)	id_xghost
	)

This function create variable, filled with matrix value.

A variable is create with the same name that the input variable, and with dimension of the coordinate file.
Then the variable array of value is split into equal subdomain. Each subdomain is filled with the associated value of the matrix.

Author

J.Paul

Date

November, 2013 - Initial Version

June, 2015

• do not use level anymore

Parameters

[in]	td_var	variable structure
[in]	td_coord	coordinate file structure
[in]	id_nlevel	number of vertical level
[in]	id_xghost	ghost cell array

Returns

variable structure