Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Added a note about LAMN/LAMX and PAI for grass vegetation canopy type (4), based on feedback from Fuad

Overview

Excerpt

MESH_parameters_CLASS.ini stores values for the parameters that are needed to run the CLASS portion of MESH. It is very similar to the CLASS_benchmark.ini file used by the CLASS Stand-Alone Driver.

The first four lines of this file contain header information. The next 15 lines are repeated for each GRU and contain parameter and initialization values for each of these GRUs. The last line to be read from the file contains the start of the meteorological input files.


Consult the Parameters Selection page for more information about specific parameters and recommended parameter values.

This page contains the following sections:

Table of Contents
outlinetrue


Sample File

Download a sample MESH_parameters_CLASS.ini file.

Panel
bgColor#F0F8FF
languagetext
langhtml
titleSample: MESH_parameters_CLASS.ini
  TestFile                                                                01 TITLE
M.A. Mekonnen 02 NAME
NWRI in Saskatoon 03 PLACE
51.53 -106.25 40.00 40.00 50.00 -1.0 1 2 2 04 DEGLAT/DEGLON/ZRFM/ZRFH/ZBLD/GC/ILW/NL/NM
0.000 0.000 0.000 1.000 0.000 0.000 0.000 0.000 3.500 05 5xFCAN/4xLAMX
0.000 0.000 0.000 -2.500 0.000 0.000 0.000 0.000 3.500 06 5xLNZ0/4xLAMN
0.000 0.000 0.000 0.055 0.000 0.000 0.000 0.000 2.000 07 5xALVC/4xCMAS
0.000 0.000 0.000 0.325 0.000 0.000 0.000 0.000 1.200 08 5xALIC/4xROOT
0.000 0.000 0.000 100.000 0.000 0.000 0.000 30.000 09 4xRSMN/4xQA50
0.000 0.000 0.000 0.500 0.000 0.000 0.000 1.000 10 4xVPDA/4xVPDB
0.000 0.000 0.000 100.000 0.000 0.000 0.000 5.000 11 4xPSGA/4xPSGB
1.000 4.100 1.000 50.0000 12 DRN/SDEP/FARE/DD
0.0300 0.010 0.020 0.00150 1 13 XSLP/XDRAINH/MANN/KSAT/MID
70.00 70.00 70.00 14 3xSAND
30.00 30.00 30.00 15 3xCLAY
0.00 0.00 0.00 16 3xORGM
5.00 5.00 5.00 5.00 0.00 5.00 17 3xTBAR/TCAN/TSNO/TPND
0.200 0.200 0.200 0.000 0.000 0.000 0.000 18 3xTHLQ/3xTHIC/ZPND
0.0000 0.0000 0.00 0.200 100.000 1.000 19 RCAN/SCAN/SNO/ALBS/RHOS/GRO
0.000 0.000 1.000 0.000 0.000 0.000 0.000 4.000 0.000 05 5xFCAN/4xLAMX
0.000 0.000 -2.500 0.000 0.000 0.000 0.000 0.000 0.000 06 5xLNZ0/4xLAMN
0.000 0.000 0.060 0.000 0.000 0.000 0.000 3.000 0.000 07 5xALVC/4xCMAS
0.000 0.000 0.360 0.000 0.000 0.000 0.000 1.500 0.000 08 5xALIC/4xROOT
0.000 0.000 85.000 0.000 0.000 0.000 30.000 0.000 09 4xRSMN/4xQA50
0.000 0.000 0.500 0.000 0.000 0.000 1.000 0.000 10 4xVPDA/4xVPDB
0.000 0.000 100.000 0.000 0.000 0.000 5.000 0.000 11 4xPSGA/4xPSGB
1.000 4.100 1.000 50.0000 12 DRN/SDEP/FARE/DD
0.0300 0.010 0.020 0.00150 2 13 XSLP/XDRAINH/MANN/KSAT/MID
70.00 70.00 70.00 14 3xSAND
30.00 30.00 30.00 15 3xCLAY
1.00 1.00 0.47 16 3xORGM
5.00 2.00 0.00 5.00 0.00 5.00 17 3xTBAR/TCAN/TSNO/TPND
0.200 0.200 0.200 0.000 0.000 0.000 0.000 18 3xTHLQ/3xTHIC/ZPND
0.0000 0.0000 0.00 0.200 100.000 1.000 19 RCAN/SCAN/SNO/ALBS/RHOS/GRO
243 365 243 365 0 0 20 (not used, but 4x integer values are required)
2005 2005 2005 2005 0 0 21 (not used, but 4x integer values are required)
0 0 243 2005 22 IHOUR/IMINS/IJDAY/IYEAR
123456789*123456789*123456789*123456789*123456789*123456789*123456789*12



Header Information

Header information is stored in the first four lines of the file.

Panel
languagetext
titleSample: Header Information in MESH_parameters_CLASS.ini
  TestFile                                                                01 TITLE
M.A. Mekonnen 02 NAME
NWRI in Saskatoon 03 PLACE
51.53 -106.25 40.00 40.00 50.00 -1.0 1 2 2 04 DEGLAT/DEGLON/ZRFM/ZRFH/ZBLD/GC/ILW/NL/NM
LineColumnsVariableFormatTypeDescriptionUnits
11-6TITLE2x, 6a4 CharCharacters to identify the model run--
21-6NAME2x, 6a4 CharCharacters to identify to researcher by name--
31-6PLACE2x, 6a4 CharCharacters to identify authority or institution of the research or researcher--
41DEGLAT* Real

Latitude of the site or grid-cell in degrees

deg
2DEGLON* RealLongitude of the site or grid-cell in degreesdeg
3ZRFM* RealReference height (measurement height) for wind speedm
4ZRFH* RealReference height (measurement height) for temperature and humiditym
5ZBLD* RealHeight into the atmosphere for aggregating surface roughness (usually in the order of 50-100 m)m
6GC* RealGround cover flag; set to -1.0 if the GRUs in the file represent a "land surface"--
7ILW* Int

Set to 1 (See the note on ILW below)

--
8NL* IntNumber of grid-cells in the basin; this number must match the total number of grid-cells in MESH_drainage_database.r2c, ":TotalNumOfGrids"--
9NM* IntNumber of GRUs in the basin, and represented in the file; this number must match the total number of GRUs not accounting for the extra "dummy" class in MESH_drainage_database.r2c, ((":ClassCount"-1))--

Notes:
Format=* denotes free-formatting; all values are to be separated by one or more spaces.

Info

ILW was used in versions of CLASS prior to 3.4. If ILW was set to 1, the longwave meteorological forcing field represented total incoming radiation (as is the case now). However, ILW could be set to 2 to allow the field to represent net longwave radiation, which overrides the calculation of outgoing longwave radiation in TSOLVE and TSOLVC. ILW has no effect in MESH or in CLASS versions of 3.4 and later.

For compatibility with existing MESH_parameter_CLASS.ini files, the value is still expected and read from the file but stored in a dummy variable. Set ILW to 1.

GRU Parameter Values

Parameter values representative of the GRU are listed in the first 12 lines of the GRU block.

Panel
languagetext
titleSample: GRU Parameters in MESH_parameters_CLASS.ini
   0.000   0.000   0.000   1.000   0.000   0.000   0.000   0.000   3.500  05 5xFCAN/4xLAMX
0.000 0.000 0.000 -2.500 0.000 0.000 0.000 0.000 3.500 06 5xLNZ0/4xLAMN
0.000 0.000 0.000 0.055 0.000 0.000 0.000 0.000 2.000 07 5xALVC/4xCMAS
0.000 0.000 0.000 0.325 0.000 0.000 0.000 0.000 1.200 08 5xALIC/4xROOT
0.000 0.000 0.000 100.000 0.000 0.000 0.000 30.000 09 4xRSMN/4xQA50
0.000 0.000 0.000 0.500 0.000 0.000 0.000 1.000 10 4xVPDA/4xVPDB
0.000 0.000 0.000 100.000 0.000 0.000 0.000 5.000 11 4xPSGA/4xPSGB
1.000 4.100 1.000 50.0000 12 DRN/SDEP/FARE/DD
0.0300 0.010 0.020 0.00150 1 13 XSLP/XDRAINH/MANN/KSAT/MID
70.00 70.00 70.00 14 3xSAND
30.00 30.00 30.00 15 3xCLAY
0.00 0.00 0.00 16 3xORGM



Section

Vegetation Parameters

Vegetation parameters are listed in the first seven lines of the GRU block.

Panel
languagetext
titleSample: Vegetation Parameters in MESH_parameters_CLASS.ini
   0.000   0.000   0.000   1.000   0.000   0.000   0.000   0.000   3.500  05 5xFCAN/4xLAMX
0.000 0.000 0.000 -2.500 0.000 0.000 0.000 0.000 3.500 06 5xLNZ0/4xLAMN
0.000 0.000 0.000 0.055 0.000 0.000 0.000 0.000 2.000 07 5xALVC/4xCMAS
0.000 0.000 0.000 0.325 0.000 0.000 0.000 0.000 1.200 08 5xALIC/4xROOT
0.000 0.000 0.000 100.000 0.000 0.000 0.000 30.000 09 4xRSMN/4xQA50
0.000 0.000 0.000 0.500 0.000 0.000 0.000 1.000 10 4xVPDA/4xVPDB
0.000 0.000 0.000 100.000 0.000 0.000 0.000 5.000 11 4xPSGA/4xPSGB


Each of the vegetation parameters contains four or five values that correspond to four pre-defined vegetation categories and one additional type of land cover for barren soils. Only four of the vegetation parameters contain a fifth value for barren soil.

The canopy types are listed below. They are listed in the same order as they are indexed for each of the vegetation parameters. These indices also correspond to the indexing of the vegetation categories in the CLASS Lookup Tables.

CodeCanopy Type
1Needleleaf trees
2Broadleaf trees
3Crops
4Grass
5

Urban, barren land, or impervious areas

Line ColumnsVariable Canopy TypesFormatType DescriptionUnits
51-5FCAN 1-5*Real

Annual maximum fraction of the grid-cell occupied by vegetation category or land cover

--
6-9LAMX 1-4*Real

Annual maximum leaf-area index of the vegetation category

--
61-5LNZ0 1-5*RealNatural logarithm of the roughness length of the vegetation category or land cover--
6-9LAMN 1-4***RealAnnual minimum leaf-area index of the vegetation category
**Note: LAMN has no effect in the CLASS default calculation of plant area index for the grass vegetation canopy type (4). The growth index for grass (GROWG) is constant (1.0) and PAI is always calculated as the maximum leaf-area index (LAMX)
--
71-5ALVC 1-5*RealAverage visible albedo of the vegetation category when fully-leafed or of the land cover--
6-9CMAS 1-4*RealAnnual maximum canopy mass of the vegetation categorykg m-2
81-5ALIC 1-5*RealAverage near-infrared albedo of the vegetation category when fully-leafed or of the land cover--
6-9ROOT 1-4*RealAnnual maximum rooting depth of the vegetation categorym
91-4RSMN 1-4*RealMinimum stomatal resistance of the vegetation categorys m-1
5-8QA50 1-4*RealReference value of shortwave radiation used in the calculation of the stomatal resistance of the vegetation categoryW m-2
101-4VPDA 1-4*RealVapor pressure deficit coefficient 'A' used in the calculation of the stomatal resistance of the vegetation category--
5-8VPDB 1-4*RealVapor pressure deficit coefficient 'B' used in the calculation of the stomatal resistance of the vegetation category--
111-4PSGA 1-4*RealSoil moisture suction coefficient 'A' used in the calculation of the stomatal resistance of the vegetation category--
5-8PSGB 1-4*RealSoil moisture suction coefficient 'B' used in the calculation of the stomatal resistance of the vegetation category--

Notes:
Values in the "Canopy Types" column correspond to the "Code" of the canopy types listed above.
Format=* denotes free-formatting; all values are to be separated by one or more spaces.

Note
titleUsing FCAN to activate the Canopy Type

FCAN is the first parameter in the section. It controls what canopy types are active. If FCAN > 0.0 for a particular canopy type, then a value must exist in the corresponding index for the other 13 parameters. If a value exists for a particular canopy type, for which FCAN = 0.0, then that value is ignored.

For example, if FCAN(1, 2, 3, 4, 5) = (0.0, 0.0, 1.0, 0.0, 0.0); then ROOT(3) must have a value. However, ROOT(2) can be zero. If ROOT(2) has a value, the value is ignored because FCAN(2) = 0.0.

Note
titleUsing a single Canopy Type per GRU
It is sometimes suggested to parameterize each GRU with only one active land cover. Using this approach, various land covers can instead be parameterized using multiple GRUs. To do this, set FCAN = 1.0 for the desired canopy type and set all other values of FCAN in the GRU to zero.



Section

Surface Parameters

Surface parameters are listed in Lines 8-9 of the GRU block, among the hydraulic parameters.

Panel
languagetext
titleSample: Hydraulic Parameters in MESH_parameters_CLASS.ini
   1.000   4.100   1.000 50.0000                                          12 DRN/SDEP/FARE/DD
0.0300 0.010 0.020 0.00150 1 13 XSLP/XDRAINH/MANN/KSAT/MID
LineColumnVariableFormatTypeDescriptionUnits
123FARE*RealActive fraction of the grid cell; this value is derived from MESH_drainage_database.r2c and can be set to 1.0--
135MID*IntSet the mosaic tile ID > 0--

Notes:
Format=* denotes free-formatting; all values are to be separated by one or more spaces.

Note
titleDepreciation of GRU-based FARE

The value of FARE from this file is no longer used. The value is instead derived from MESH_drainage_database.r2c.

Warning
titleMID or the Mosaic ID

Many users use the mosaic ID as an identifier in a file that contains the parameterizations of multiple GRUs. It helps organize the file and keep track of where one GRU parameterization ends and the next begins. However, the mosaic ID is an active parameter in the model that identifies whether the GRU represents land or water. If the GRU has been parameterized to represent a land cover, then the mosaic ID must be greater than zero. 



Section

Hydraulic Parameters

Hydraulic parameters of the soil are listed in Lines 8-9 of the GRU block.

Panel
languagetext
titleSample: Hydraulic Parameters in MESH_parameters_CLASS.ini
   1.000   4.100   1.000 50.0000                                          12 DRN/SDEP/FARE/DD
0.0300 0.010 0.020 0.00150 1 13 XSLP/XDRAINH/MANN/KSAT/MID
Warning
titleControlling Hydraulic Parameters with IWF

Not all hydraulic parameters are active in certain configurations of the model; for example, those tied to WATROF. Certain hydraulic parameters are tied to the state of the IWF control flag.

LineColumnVariableIWFFormatTypeDescriptionUnits
121DRN, XDRAIN0, 1, 2*Real

Drainage index controls if water is allowed to seep from the bottom of the soil column, analogous to the fractional sizing of a hole at the bottom of a bucket. A value of zero allows no water to seep from the bottom of the soil column, such that water leaves the soil only as interflow, overland flow, or by evapotranspiration. If there is sufficient water in the column, a value of 1.0 additionally allows this water to leave as baseflow (or leakage contributing to baseflow). A fraction between zero and 1.0 can be used to allow only a partial contribution of this water to baseflow.

--
2SDEP--*RealPermeable depth of the soil columnm
3FARE--*Real(See the section on Surface Parameters)--
4DD, DDEN1*RealEstimated drainage density of the GRUkm km-2
131XSLP, XSLOPE1*RealEstimated average slope of the GRU (Referred to as Λ in Notes on Interflow)--
2GRKF, XD, XDRAINH1*RealFraction of the saturated surface soil conductivity moving in the horizontal direction--
3MANN, MANNING_N1*RealManning's 'n's m-1/3
4WFCI, KS, KSAT1*RealSaturated surface soil conductivity (Referred to as Ks in Notes on Interflow)m s-1
5MID--*Int(See the section on Surface Parameters)--

Notes:
Values of IWF correspond to the IWF control flag.
Format=* denotes free-formatting; all values are to be separated by one or more spaces.

Note
titleWATROF Variable Names

Multiple variable names are listed if more than one name for the variable exists, either in code, external references, or in other documentation.



Section

Soil Texture Parameters

Soil texture parameters are listed in Lines 10-12 of the GRU block.

Panel
languagetext
titleSample: Soil Texture Parameters in MESH_parameters_CLASS.ini
     70.00     70.00     70.00                                            14 3xSAND (or more)
30.00 30.00 30.00 15 3xCLAY (or more)
0.00 0.00 0.00 16 3xORGM (or more)


Soil texture parameters are used in the derivation of hydraulic parameters to calculate drainage when IWF is 0 or 2. They are also used in this way to calculate the baseflow component of runoff when IWF is 1.

LineColumnVariableFormatTypeDescriptionUnits
141-3+SAND*RealPercent content of sand in the mineral soil%
151-3+CLAY*RealPercent content of clay in the mineral soil%
161-3+ORGM*RealPercent content of organic matter in the mineral soil%

Notes:
+Values for more than three soil layers can exist if the NRSOILAYEREADFLAG control flag has been enabled.
Format=* denotes free-formatting; all values are to be separated by one or more spaces.

Note
titleSum of the SAND, CLAY, and ORGM Components

The components of SAND, CLAY, and ORGM do not necessarily sum to 1.0. The amount leftover from the sum of SAND and CLAY is assumed to be SILT.

Note
titleORGM

ORGM is not a part of the soil triangle. Thus, the sum of SAND, CLAY, and ORGM can be > 1.0 if the soil contains no silt, but contains some organic matter. ORGM should be no more than a few percent.

Note
titleUsing SAND and ORGM for Organic Soils

For completely organic soils, set SAND = -2.0 and CLAY = 0.0. Set ORGM to one of 1.0, 2.0, or 3.0, if the texture of the peat is febric, hemic, or sapric.

Note
titleUsing SAND for Rock Layers

For soil layers that consist of rock, set SAND = -3.0.

Note
titleUsing SAND for Continental Ice Sheets

If the soil layer is part of a continental ice sheet, set SAND = -4.0.



Section

Initial Prognostic Values

Initial values of prognostic variables of the GRU are listed in the last three lines of the GRU block.

Panel
languagetext
titleSample: Initialization of Prognostic Values in MESH_parameters_CLASS.ini
      5.00      5.00      5.00      5.00      0.00      5.00              17 3xTBAR (or more)/TCAN/TSNO/TPND
0.200 0.200 0.200 0.000 0.000 0.000 0.000 18 3xTHLQ (or more)/3xTHIC (or more)/ZPND
0.0000 0.0000 0.00 0.200 100.000 1.000 19 RCAN/SCAN/SNO/ALBS/RHOS/GRO
LineColumnVariableFormatTypeDescriptionUnits
171-3+TBAR*RealTemperature of the soil layerdeg C
4TCAN*RealAir temperature of the canopydeg C
5TSNO*RealTemperature of the snow mass present on the ground surface; 0.0 if no such mass existsdeg C
6TPND*RealTemperature of the liquid water stored on the ground surface; 0.0 if no such storage existsdeg C
181-3+THLQ*RealVolumetric liquid water content stored in the soilm3 m-3
4-6+THIC*RealVolumetric frozen water content stored in the soilm3 m-3
7ZPND*RealDepth of liquid water stored on the ground surfacem
191RCAN*RealLiquid water component of precipitation held on the vegetation canopykg m-2
2SCAN*RealFrozen water component of precipitation held on the vegetation canopykg m-2
3SNO*RealSnow mass present on the ground surfacekg m-2 
4ALBS*RealAlbedo of the snow mass present on the ground surface; 0.0 is no such mass exists--
5RHOS*RealDensity of the snow mass present on the ground surface; 0.0 if no such mass existskg m-3
6GRO*RealSet to 0.0 before leaf-out; 1.0 when fully-leafed; or estimate the growth index with a fraction if in between--

Notes:
+Values for more than three soil layers can exist if the NRSOILAYEREADFLAG control flag has been enabled.
Format=* denotes free-formatting; all values are to be separated by one or more spaces.

Warning
titleInitialization of Snow Variables

A persistent bias might be observed in the results of the simulation if the prognostic variables for snow have not been properly initialized. To avoid this scenario, the simulation should begin during a period of snow-free conditions, such that SNO, TSNO, ALBS, and RHOS are all set to zero.

Note
titleInitial Frozen and Liquid Water Contents of the Soil

It is best to initialize THLQ and THIC with smaller values. For mineral soils, the minimum value that THLQ can be is 0.04; the minimum value that THIC can be is zero. If SAND = -3.0 or -4.0 (the GRU represents a rock or ice sheet layer), then both THLQ and THIC should be set to zero.

Tip
titleInitializing Storage

If the initialization of these variables results in a very large storage, a spike might be observed in runoff into the first few days of the simulation. Revising the initialization of these variables can resolve this. If this initial spike continues to be observed after revising these variables, the METRICSSPINUP control flag can be used to exclude the first few days of the simulation from the calculation of metrics if autocalibration has been enabled.

Note that long-term biases could be introduced to the simulation if realistic values are not used to initialize the prognostic variables.



Dates

A few dates are listed in the last three lines of the file. Values in the first two of these three lines are not used; however, they are required to exist in the file.

Panel
languagetext
titleSample: Dates in MESH_parameters_CLASS.ini
       243       365       243       365                                  20 (not used, but 4x integer values are required)
2005 2005 2005 2005 21 (not used, but 4x integer values are required)
0 0 243 2005 22 IHOUR/IMINS/IJDAY/IYEAR
Warning
titleMeteorological Start Date

The meteorological start date is the last line of this section. This date must match the date of the first record in all of the meteorological input files.

LineColumnVariableFormatTypeDescriptionUnits
20   1JOUT1*Int(See note); set to any integer number (e.g., 0)--
2JOUT2*Int(See note); set to any integer number (e.g., 0)--
3JAV1*Int(See note); set to any integer number (e.g., 0)--
4JAV2*Int(See note); set to any integer number (e.g., 0)--
21   1KOUT1*Int(See note); set to any integer number (e.g., 0)--
2KOUT2*Int(See note); set to any integer number (e.g., 0)--
3KAV1*Int(See note); set to any integer number (e.g., 0)--
4KAV2*Int(See note); set to any integer number (e.g., 0)--
22   1IHOUR*IntHour of the first record of data in the meteorological input files; 0 is the first hour of the day--
2IMINS*IntTime-step of the first record of data in the meteorological input files; set to 0 for the first half-hour of the hour; set to 30 for the second half-hour of the hour--
3IJDAY*IntDay of year of the first record of data in the meteorological input files; 1 is the first day of the year--
4IYEAR*IntYear of the first record of data in the meteorological input files; the year must be in the full YYYY format--

Notes:
Format=* denotes free-formatting; all values are to be separated by one or more spaces.

Note
titleUnused parameters for CLASS output

JOUT1, JOUT2, JAV1, JAV2, KOUT1, KOUT2, KAV1, and KAV2 are values that are required in the file but are not used. Any integer number can be set as the value for these variables.