Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Updated info for r1680 and later

...

Configuration

Note
Options with an equal signs sign (e.g., "hf=M") must be provided as a single word in the format "<option_name>=<value>" with no whitespace, such as tabs or spaces, separating the option name, equal sign, and value.

...

OptionDescriptionSupported Since
r2cSpecifies the input files are in r2c format.r1637
csvSpecifies the input files are in CSV format.r1637
seqSpecifies the input files are in binary sequential (seq) format.r1637
metSpecifies that the input file is a CLASS MET format forcing file.r1090
ncSpecifies the input files are in netCDF format.r1637

...

OptionDescriptionSupported Since
fname=<filename>Overrides the default "basin_name" filename (without file extension).r1637
fpath=<path>Overrides the derived filename, file extension, and path. "<path>" must include the full path to the file, including file extension.r1637
name_var=<name>Name of the variable. Only used for input files in netCDF format.r1637
name_lat=<latitude>Name of the variable corresponding to the latitude/y dimension. Only used for input files in netCDF format.r1637
name_lon=<longitude>Name of the variable corresponding to the longitude/x dimension. Only used for input files in netCDF format.r1637
name_time=<time>Name of the variable corresponding to the time/t dimension. Only used for input files in netCDF format.r1637

Time-stepping options

OptionDescriptionSupported Since
hf=M<M>Frame length/file time-stepping, where "<M>" specifies the length of the frame in minutes.r1637
start_date=YYYYMMDDHHMM<YYYYMMDDHHMM>

First date of record in 4-digit year, 2-digit month, 2-digit day of month, 2-digit hour, 2-digit minutes format. Provided a partial date, the following are assumed:

  • start_date=YYYY<YYYY>: 01/01 00:00 of the specified year
  • start_date=YYYYMM<YYYYMM>: Day 1 00:00 in the specified month of the specified year
  • start_date=YYYYMMDD<YYYYMMDD>: 00:00 in the specified date
  • start_date=YYYYMMDDHH<YYYYMMDDHH>: 0 minutes of the specified hour in the specified date
r1637
time_shift=H<H>Time-shift to apply to time-stamps, where "<H>" specifies the offset to apply to the start date in hours. Only supported for input files in netCDF format.r1637

Transformation options

Note
The transformation options are recognized but not implemented, and will have no effect for any supported input file format.
OptionDescriptionSupported Since
cm=M<M>

Multiplicative factor, where:

Math
"data" = "(driving data input)"*M
r1637
ca=A<A>

Additive factor, where:

Math
"data" = "(driving data input)" + A
r1637

Other options

OptionDescriptionSupported Since
nts=N<N>Number The number of records N "<N>" to read in to memory from file.r1637
rr_srRead extra columns for liquid precipitation and solid precipitation from the CLASS MET format forcing file. Only used for input files in the CLASS MET format.r1610
no_climDeactivate the default climate variables.r1637

Overrides

Info
The override flags can be used alone, without any instance of "BASINFORCINGFLAG", as seen in most existing model setups and configurations. In this case, the override flags for each of the respective 7 meteorological driving variables must be listed in MESH_input_run_options.ini if running a land surface scheme. More information is provided here.
The
Warning
Note

In versions of MESH prior to r1680, the override control flags do not support the file format "word" options, such as "r2c", "csv", etc.. The first option to follow the flag must be the numeric code of the input file format. See this page for the numeric options.

The word options can be used for the override control flags with any version of MESH r1680 and later.

General options set with the BASINFORCINGFLAG control flag can be overwritten for specific files and variables using the following flags:

FlagDescriptionSupported Since
BASINSHORTWAVEFLAGOverride for incoming shortwave radiation.1.2.000
BASINLONGWAVEFLAGOverride for incoming longwave radiation.
BASINRAINFLAGOverride for total precipitation rate at the surface.
BASINTEMPERATUREFLAGOverride for air temperature at the specified reference height.
BASINWINDFLAGOverride for wind speed at the specified reference height.
BASINWINDDIRFLAGOverride for wind direction at the specified reference height.r1680
BASINPRESFLAGOverride for barometric pressure at the surface.1.2.000
BASINHUMIDITYFLAGOverride for specific humidity at the specified reference height.
BASINRUNOFFFLAGOverride for runoff.r1680
BASINRECHARGEFLAGOverride for recharge.

All of the flags , with the exception of "BASINRUNOFFFLAG" and "BASINRECHARGEFLAG" support this subset of the general options:

Tip
The override control flags support exactly the same options as BASINFORCINGFLAG in MESH versions r1680 and later.
OptionDescriptionSupported Since
hf=H<M>Frame length/file time-stepping, where "<M>" specifies the length of the frame in minutes.r750
nts=N<N>Number The number of records N "<N>" to read in to memory from file.r833
fname=<filename>Overrides the default "basin_name" filename (without file extension).r1630

fpath=<path>

Overrides the derived filename, file extension, and path. "<path>" must include the full path to the file, including file extension.r1630
name_var=<name>Name of the variable. Only used for input files in netCDF format.r1630
name_lat=<latitude>Name of the variable corresponding to the latitude/y dimension. Only used for input files in netCDF format.r1630
name_lon=<longitude>Name of the variable corresponding to the longitude/x dimension. Only used for input files in netCDF format.r1630
name_time=<time>Name of the variable corresponding to the time/t dimension. Only used for input files in netCDF format.r1630
cm=M<M>Multiplicative factor (recognized, but not used).r1630
ca=A<A>Additive factor (recognized, but not used).r1630
time_shift=H<H>Time-shift to apply to time-stamps, where "<H>" specifies the offset to apply to the start date in hours. Only supported for input files in netCDF format.r1630

Behaviour without BASINFORCINGFLAG

...