6.12. ancillaries.nml

This file sets up spatially varying ancillary values. It contains eight namelists - JULES_FRAC, JULES_SOIL_PROPS, JULES_TOP, JULES_AGRIC, JULES_CROP_PROPS, JULES_CO2, JULES_IRRIG and JULES_RIVERS_PROPS.

6.12.1. JULES_FRAC namelist members

This namelist specifies the fraction of the land area in each gridbox that is covered by each of the surface types. If l_veg_compete = TRUE, then the fraction of each surface type is modelled and the initial state should be specified in JULES_INITIAL. In all other cases, it must be read here.

Note that all land points must be either soil points (indicated by values > 0 of the saturated soil moisture content), or land ice points (indicated by the fractional coverage of the ice surface type - if used - being one). The fractional cover of the ice surface type in each gridbox must be either zero or one - there cannot be partial coverage of ice within a gridbox.

If using either URBAN-2T or MORUSES then the total urban fraction should be entered in the urban_canyon or urban tile, whichever is specified. This is partitioned into canyon and roof fractions using the canyon fraction (W/R). The canyon fraction is set in urban.nml and can either be prescribed by the user or calculated by an empirical formula.

JULES_FRAC::file

Type:character Default:None

The name of the file to read surface type fractional coverage data from.

JULES_FRAC::frac_name

Type:character Default:None

The name of the variable containing the surface type fractional coverage data.

Note

This is only used for NetCDF files. For ASCII files, the surface type fractional coverage data is expected to be the first (ideally only) variable in the file.

In the file, the variable must have a single levels dimension of size ntype called type_dim_name, and should not have a time dimension.

6.12.2. JULES_SOIL_PROPS namelist members

This namelist specifies how spatially varying soil properties should be set.

JULES_SOIL_PROPS::const_z

Type:logical Default:F

Switch indicating if soil properties are to be uniform with depth.

TRUE

Soil characteristics do not vary with depth.

FALSE

Soil characteristics vary with depth.

JULES_SOIL_PROPS::file

Type:character Default:None

The file to read soil properties from.

If use_file is FALSE for every variable, this will not be used.

This file name can use variable name templating.

JULES_SOIL_PROPS::nvars

Type:integer Permitted:>= 0 Default:0

The number of soil property variables that will be provided. At present, all variables are required for all runs.

JULES_SOIL_PROPS::var

Type:character(nvars) Default:None

List of soil variable names as recognised by JULES (see List of soil parameters). Names are case sensitive.

Note

For ASCII files, variable names must be in the order they appear in the file.

JULES_SOIL_PROPS::use_file

Type:logical(nvars) Default:T

For each JULES variable specified in var, this indicates if it should be read from the specified file or whether a constant value is to be used.

TRUE

The variable will be read from the file.

FALSE

The variable will be set to a constant value everywhere using const_val below.

JULES_SOIL_PROPS::var_name

Type:character(nvars) Default:None

For each JULES variable specified in var where use_file = TRUE, this is the name of the variable in the file containing the data.

This is not used for variables where use_file = FALSE, but a placeholder must still be given.

Note

For ASCII files, this is not used - only the order in the file matters, as described above.

JULES_SOIL_PROPS::tpl_name

Type:character(nvars) Default:None

For each JULES variable specified in var, this is the string to substitute into the file name in place of the variable name substitution string.

If the file name does not use variable name templating, this is not used.

JULES_SOIL_PROPS::const_val

Type:real(nvars) Default:None

For each JULES variable specified in var where use_file = FALSE, this is a constant value that the variable will be set to at every point in every layer.

This is not used for variables where use_file = TRUE, but a placeholder must still be given.

6.12.2.1. List of soil parameters

If const_z = FALSE, variables read from file must have a single levels dimension of size sm_levels called soil_dim_name.

If const_z = TRUE, variables read from file must have no levels dimensions.

In both cases, the variables must have no time dimension. Some examples of the setup of soil properties can be found in the examples directory.

Name	Description
albsoil	Soil albedo. A single (averaged) waveband is used.
b	Exponent in soil hydraulic characteristics.
hcap	Dry heat capacity (J m-3 K-1).
hcon	Dry thermal conductivity (W m-1 K-1).
satcon	Hydraulic conductivity at saturation (kg m-2 s-1).
sathh	If l_vg_soil = TRUE (using van Genuchten model), sathh = 1 / α (m-1), where α is a parameter of the van Genuchten model. If l_vg_soil = FALSE (using Brooks and Corey model), sathh is the absolute value of the soil matric suction at saturation (m). The suction at saturation is generally less than zero, but JULES uses the absolute value.
sm_crit	Volumetric soil moisture content at the critical point (m3 water per m3 soil). The critical point is that at which soil moisture stress starts to restrict transpiration.
sm_sat	Volumetric soil moisture content at saturation (m3 water per m3 soil). Note This field is used to distinguish between soil points and land ice points. sm_sat > 0 indicates a soil point.
sm_wilt	Volumetric soil moisture content at the wilting point (m3 water per m3 soil). The wilting point is that at which soil moisture stress completely prevents transpiration.

6.12.3. JULES_TOP namelist members

This namelist reads spatially varying parameter values for the TOPMODEL-type parameterisation of runoff. The values are only used if l_top = TRUE. The description below is very brief. For further details, see the references under l_top.

JULES_TOP::file

Type:character Default:None

The file to read TOPMODEL properties from.

If use_file is FALSE for every variable, this will not be used.

This file name can use variable name templating.

JULES_TOP::nvars

Type:integer Permitted:>= 0 Default:0

The number of TOPMODEL property variables that will be provided. At present, all variables are required for runs using TOPMODEL.

JULES_TOP::var

Type:character(nvars) Default:None

List of TOPMODEL variable names as recognised by JULES (see List of TOPMODEL parameters). Names are case sensitive.

Note

For ASCII files, variable names must be in the order they appear in the file.

JULES_TOP::use_file

Type:logical(nvars) Default:T

For each JULES variable specified in var, this indicates if it should be read from the specified file or whether a constant value is to be used.

TRUE

The variable will be read from the file.

FALSE

The variable will be set to a constant value everywhere using const_val below.

JULES_TOP::var_name

Type:character(nvars) Default:None

For each JULES variable specified in var where use_file = TRUE, this is the name of the variable in the file containing the data.

This is not used for variables where use_file = FALSE, but a placeholder must still be given.

Note

For ASCII files, this is not used - only the order in the file matters, as described above.

JULES_TOP::tpl_name

Type:character(nvars) Default:None

For each JULES variable specified in var, this is the string to substitute into the file name in place of the variable name substitution string.

If the file name does not use variable name templating, this is not used.

JULES_TOP::const_val

Type:real(nvars) Default:None

For each JULES variable specified in var where use_file = FALSE, this is a constant value that the variable will be set to at every point in every layer.

This is not used for variables where use_file = TRUE, but a placeholder must still be given.

6.12.3.1. List of TOPMODEL parameters

All of the TOPMODEL variables listed below are expected to have no levels dimensions and no time dimension.

Name	Description
fexp	Decay factor describing how the saturated hydraulic conductivity decreases with depth below the standard soil column (m-1).
ti_mean	Mean value of the topographic index in each gridbox.
ti_sig	Standard deviation of the topographic index in each gridbox.

6.12.4. JULES_AGRIC namelist members

If the TRIFFID vegetation model is used, the fractional area of agricultural land in each gridbox is specified using this namelist. Otherwise, the values in this namelist are not used.

JULES_AGRIC::zero_agric

Type:logical Default:T

Switch used to simplify the initialisation of agricultural fraction.

TRUE

Set agricultural fraction at all points to zero.

FALSE

Set agricultural fraction using specified data.

Used if zero_agric = FALSE and the input grid consists of a single location

JULES_AGRIC::frac_agr

Type:real Default:None

The agricultural fraction for the single location.

Used if zero_agric = FALSE and the input grid consists of more than one location

JULES_AGRIC::file

Type:character Default:None

The name of the file to read agricultural fraction data from.

JULES_AGRIC::agric_name

Type:character Default:None

The name of the variable containing the agricultural fraction data.

In the file, the variable must have no levels dimensions and no time dimension.

6.12.5. JULES_CROP_PROPS namelist members

JULES_CROP_PROPS::file

Type:character Default:None

The file from which crop properties are read.

If use_file is FALSE for every variable, this will not be used.

This file name can use variable name templating.

JULES_CROP_PROPS::nvars

Type:integer Permitted:>= 0 Default:0

The number of crop property variables that will be provided.

JULES_CROP_PROPS::var

Type:character(nvars) Default:None

List of variable names for spatially-varying crop properties as recognised by JULES (see List of spatially-varying crop properties). Names are case sensitive.

Note

For ASCII files, variable names must be in the order they appear in the file.

JULES_CROP_PROPS::use_file

Type:logical(nvars) Default:T

For each JULES variable specified in var, this indicates if it should be read from the specified file or whether a constant value is to be used.

TRUE

The variable will be read from the file.

FALSE

The variable will be set to a constant value everywhere using const_val below.

JULES_CROP_PROPS::var_name

Type:character(nvars) Default:None

For each JULES variable specified in var where use_file = TRUE, this is the name of the variable in the file containing the data.

This is not used for variables where use_file = FALSE, but a placeholder must still be given.

Note

For ASCII files, this is not used - only the order in the file matters, as described above.

JULES_CROP_PROPS::tpl_name

Type:character(nvars) Default:None

For each JULES variable specified in var, this is the string to substitute into the file name in place of the variable name substitution string.

If the file name does not use variable name templating, this is not used.

JULES_CROP_PROPS::const_val

Type:real(nvars) Default:None

For each JULES variable specified in var where use_file = FALSE, this is a constant value that the variable will be set to at every point in every layer.

This is not used for variables where use_file = TRUE, but a placeholder must still be given.

6.12.5.1. List of spatially-varying crop properties

All of the crop variables listed below are expected to have a single levels dimension of size ncpft called cpft_dim_name.

Name	Description
cropsowdate	The sowing date for each crop. The sowing date should be a real number, with 0 < nint(sowing_date) < number of days in year. For example, for a 365 day year, sow_date = 1.0 is Jan 1st and sow_date = 365.0 is Dec 31st. If a crop requires two sowing dates per year, it should be treated as two separate crops with identical parameters apart from the sowing date. Note Only required if l_prescsow = TRUE.
cropttveg	Thermal time between emergence and flowering (deg Cd).
cropttrep	Thermal time between flowering and maturity/harvest (deg Cd).

6.12.6. JULES_CO2 namelist members

JULES_CO2::co2_mmr

Type:real Default:5.241e-4

Concentration of atmospheric CO2, expressed as a mass mixing ratio.

6.12.7. JULES_IRRIG namelist members

JULES_IRRIG::frac_irrig_all_tiles

Type:logical Default:None

If T, then irrigation fraction is applied to all tiles, and F, it is applied only to the tiles specified in irrigtiles.

JULES_IRRIG::nirrtile

Type:integer Default:None

The number of tile types to be irrigated. Only used if frac_irrig_all_tiles = F.

JULES_IRRIG::irrigtiles

Type:integer(nirrtile) Default:None

Indices of the tiles to be irrigated. Only used if frac_irrig_all_tiles = F.

JULES_IRRIG::read_file

Type:logical Default:T

Indicates if irrigated fraction is to be read from file.

TRUE

Irrigated fraction is read from the file specified in file.

FALSE

Irrigated fraction is set to the constant value specified in const_frac_irr.

JULES_IRRIG::file

Type:character Default:None

The file from which irrigation fractions are read, including path.

JULES_IRRIG::var_name

Type:character Default:None

The name of the variable containing the irrigated fraction data.

Note

This is only used for NetCDF files. For ASCII files, the irrigated fraction data is expected to be the first (ideally only) variable in the file.

In the file, the variable must have no levels or time dimensions.

JULES_IRRIG::const_frac_irr

Type:real Default:none

The constant irrigated fraction to be applied to all grid points.

6.12.8. JULES_RIVERS_PROPS namelist members

This namelist specifies how spatially varying river routing properties should be set.

Warning

The river routing code in JULES is still in development, and is available in this release to support beta testing activities.

Users should ensure that results are as expected, and provide feedback where deficiencies are identified.

Warning

River routing is not currently available as an option with JULES in parallel mode. If river routing is required, please run JULES in serial mode instead.

Note

The grid on which the river routing will run, and on which river routing ancillaries must be provided, could potentially differ from the input/model grid specified in model_grid.nml.

For the duration of this document, the following nomenclature will be used:

• Model input grid - The full JULES input grid specified in JULES_INPUT_GRID
• River routing grid - The grid on which the river routing will run, and on which river routing ancillaries will be provided

Currently, information about the river routing grid and its relationship to the model input grid is specified in JULES_RIVERS_PROPS.

While the model input can be defined on a 1D grid, the river routing grid must be 2D, as defined through the x and y dimensions of the rivers ancillary file. See x_dim_name and y_dim_name for further details. If a non-regular model and river routing grid is used, both the x and y dimensions and corresponding latitude and longitude values must be specified for each grid point.

For some applications, the model input and river routing grids may not be coincident. Note that functionality only currently exists to regrid between regular (but non-identical) model input and river routing grids. If a non-regular model input grid is specified, it is assumed that the model input and river routing grids will be coincident.

Members used to define the river routing grid

JULES_RIVERS_PROPS::rivers_reglatlon

Type:logical Default:T

Flag indicating if the river routing grid is regular in latitude and longitude.

TRUE

River routing grid is regular in latitude and longitude.

FALSE

River routing grid is not regular in latitude and longitude (e.g. grid defined relative to a rotated pole, National Grid, etc). Only rivers_type = rfm or rivers_type = um_rfm should be used in this case. Note that the model input and river routing grids must be coincident in this case and rivers_regrid must also be set to false.

JULES_RIVERS_PROPS::x_dim_name

Type:character Default:“”

The name of the x dimension for the river routing grid.

Note

For ASCII files, this can be anything. For NetCDF files, it should the name of the dimension in input file(s).

Warning

Values for the x dimension of the river routing grid will need to be read from the input file to define the grid, so it is assumed that the file contains a variable of the same name. If a non-regular river routing grid is used, a 2D longitude field will also be needed to define the x-location of each grid point, read in via the longitude_2d ancillary field.

JULES_RIVERS_PROPS::y_dim_name

Type:character Default:“”

The name of the y dimension for the river routing grid.

Note

For ASCII files, this can be anything. For NetCDF files, it should the name of the dimension in input file(s).

Warning

Values for the y dimension of the river routing grid will need to be read from the input file to define the grid, so it is assumed that the file contains a variable of the same name. If a non-regular river routing grid is used, a 2D latitude field will also be needed to define the y-location of each grid point, read in via the latitude_2d ancillary field.

JULES_RIVERS_PROPS::nx

Type:integer Permitted:>= 1 Default:0

The size of the x dimension of the river routing grid.

JULES_RIVERS_PROPS::ny

Type:integer Permitted:>= 1 Default:0

The size of the y dimension of the river routing grid.

Members used to define the relationship between the model input grid and the river routing grid

JULES_RIVERS_PROPS::rivers_regrid

Type:logical Default:T

Flag indicating if the model input and river routing grids are identical, i.e. whether regridding of variables to and from the river routing grid is required. Note this is only currently possible if rivers_reglatlon is TRUE.

TRUE

River routing and model input grids differ and regridding is required.

FALSE

River routing and model input grids are identical.

Warning

Currently, regridding between model input and river routing grids must only be used with regular lat/lon model input and river routing grids.

• If a 1D model input grid is specified in JULES_INPUT_GRID, it must be possible to define a 2D regular lat/lon grid containing all the points in the model input grid. This is done using the variables below.

An example with the GSWP2 (land points only) forcing data is given below.

Only used when JULES_INPUT_GRID::grid_is_1d = TRUE

JULES_RIVERS_PROPS::nx_grid

Type:integer Permitted:>= 1 Default:JULES_RIVERS_PROPS::nx

The size of the x dimension of the 2D regular lat/lon grid containing the model input grid.

JULES_RIVERS_PROPS::ny_grid

Type:integer Permitted:>= 1 Default:JULES_RIVERS_PROPS::ny

The size of the y dimension of the 2D regular lat/lon grid containing the model input grid.

JULES_RIVERS_PROPS::reg_lat1

Type:real Default:Latitude of lower-left corner of river routing grid

The latitude of the lower-left corner of the 2D regular lat-lon grid containing the model input grid.

JULES_RIVERS_PROPS::reg_lon1

Type:real Default:Longitude of lower-left corner of river routing grid

The longitude of the lower-left corner of the 2D regular lat/lon grid containing the model input grid.

JULES_RIVERS_PROPS::reg_dlat

Type:real Default:Latitude spacing of river routing grid

The latitude spacing of the 2D regular lat/lon grid containing the model input grid.

JULES_RIVERS_PROPS::reg_dlon

Type:real Default:Longitude spacing of river routing grid

The longitude spacing of the 2D regular lat/lon grid containing the model input grid.

Members used to determine how river routing variables are set

JULES_RIVERS_PROPS::file

Type:character Default:None

The file to read river routing properties from.

If use_file is FALSE for every variable, this will not be used.

This file name can use variable name templating.

JULES_RIVERS_PROPS::nvars

Type:integer Permitted:>= 0 Default:0

The number of river routing property variables that will be provided (see List of rivers properties).

• For RFM, at least direction is currently required
• For TRIP, at least direction and sequence are required

JULES_RIVERS_PROPS::var

Type:character(nvars) Default:None

List of river routing variable names as recognised by JULES (see List of rivers properties). Names are case sensitive.

Note

For ASCII files, variable names must be in the order they appear in the file.

JULES_RIVERS_PROPS::use_file

Type:logical(nvars) Default:T

For each JULES variable specified in var, this indicates if it should be read from the specified file or whether a constant value is to be used.

TRUE

The variable will be read from the file.

FALSE

The variable will be set to a constant value everywhere using const_val below.

JULES_RIVERS_PROPS::var_name

Type:character(nvars) Default:None

For each JULES variable specified in var where use_file = TRUE, this is the name of the variable in the file containing the data.

This is not used for variables where use_file = FALSE, but a placeholder must still be given.

Note

For ASCII files, this is not used - only the order in the file matters, as described above.

JULES_RIVERS_PROPS::tpl_name

Type:character(nvars) Default:None

For each JULES variable specified in var, this is the string to substitute into the file name in place of the variable name substitution string.

If the file name does not use variable name templating, this is not used.

JULES_RIVERS_PROPS::const_val

Type:real(nvars) Default:None

For each JULES variable specified in var where use_file = FALSE, this is a constant value that the variable will be set to at every point.

This is not used for variables where use_file = TRUE, but a placeholder must still be given.

6.12.8.1. Example

The following gives an example of how you would set up the namelists to use routing with the GSWP2 forcing data.

The model input grid is the GSWP2 grid, i.e. a land-points-only, 1D grid where points lie on a 1° x 1° grid. The river routing grid is a 2D 1° x 1° grid.

Since both grids are 1° x 1°, we define the 2D regular lat-lon grid containing the model input grid to be the river routing grid, which means we don’t need any regridding of variables.

&JULES_INPUT_GRID
  grid_is_1d    = T,
  npoints       = 15238,
  grid_dim_name = "land"
  # ...
/

# ...

&JULES_RIVERS_PROPS
  # Define the river routing grid to be a 2D regular lat-lon grid
  rivers_reglatlon = T,
  x_dim_name = "longitude",
  nx         = 360,
  y_dim_name = "latitude",
  ny         = 180,
  
  # Define the 2D regular lat-lon grid containing the model input grid to be a 2D 1\ |deg| x 1\ |deg| grid
  nx_grid  = 360,
  ny_grid  = 180,
  reg_lat1 = -89.5,
  reg_lon1 = -179.5,
  reg_dlat = 1.0,
  reg_dlon = 1.0,
  
  # No regridding required since the river routing grid is the same as the 2D regular lat-lon grid containing the model input grid
  rivers_regrid = F
/

6.12.8.2. List of rivers properties

The following table summarises river routing grid properties required to run RFM or TRIP river routing algorithms, specified from an ancillary file if use_file = TRUE.

Name	Description
area	Drainage area (in number of grid boxes) draining into a given grid box. This does not include the grid point itself, and so an extra point to account for the grid point itself must be added where catchment area calculations are required. This is used if rivers_type = rfm or um_rfm to define river, land and sea points using the a_thresh parameter. If not available, all points with a valid direction value are set to 2 by default (i.e. river points if a global_run, land points if high-res).
direction	Flow direction for each river routing grid box, defining the next grid box into which surface or sub-surface water will be routed. This is specified as an integer according to [1 = N, 2 = NE, 3 = E, 4 = SE, 5 = S, 6 = SW, 7 = W, 8 = NW]. This numbering system is based on the TRIP implementation, and may not be standard. Users should take care to ensure that the input ancillary is defined as required.
sequence	River routing network pathway number. Used by TRIP river routing only (i.e. rivers_type = trip or um_trip). See Oki et al. (1999) for details.
storage	Initial value for river routing grid box water storage (kg m2 s-1). This is optional, and used by TRIP river routing only (i.e. rivers_type = trip or um_trip). If values are unavailable, the storage is initialised to zero by default. See Oki et al. (1999) for details.
latitude_2d	If rivers_reglatlon = FALSE, the unique 2D location of each river grid point must be specified.
longitude_2d	If rivers_reglatlon = FALSE, the unique 2D location of each river grid point must be specified.

See also

References:

• Bell, V.A. et al. (2007) Development of a high resolution grid-based river flow model for use with regional climate model output. Hydrology and Earth System Sciences. 11 532-549
• Oki, T., et al (1999) Assessment of annual runoff from land surface models using Total Runoff Integrating Pathways (TRIP). Journal of the Meteorological Society of Japan. 77 235-255