wiki:Tags/196/ExternalisationParameters/UsersGuide

Version 1 (modified by dsolyga, 13 years ago) (diff)

--

How to use this version of ORCHIDEE

This page is a copy of the file you could find in the folder Doc_externalised_version/ when you download ORCHIDEE_EXT.

Global specifications

The file « orchidee.def » contains the options and parameters that you can modify for any job. You will find it in the folder :

config/ORCHIDEE_OL/Job_Name/PARAM

where Job_Name designs your own job.

Each parameter externalized in ORCHIDEE is defined by a key word. This key word is written in capital letters in the « orchidee.def ». You will find some comments (lines beginning by #) for the parameters externalized in the AR5 version. For a scalar parameter, you should indicate the key word in capital letters and the new value. For example, open « orchidee.def » in the folder :

.../modipsl/config/ORCHIDEE_OL/Job_Name/PARAM/ 

and set exactly :

HCRIT_LITTER = 0.075

(the standard value for this parameter is 0.08)

Specifc requirements for PFTs parameters

Unlike the other versions of ORCHIDEE, the number of PFTs is not fixed to 13 in the ORCHIDEE externalised version. You have the possibility to change the parameter representing the number of PFTs 'NVM'. You can easily modify the values of the parameters associated to each PFT (88 in this version). You know that the PFTs are described by a set of common parameters of which values were fixed in the previous versions of ORCHIDEE.

In this ORCHIDEE externalised version, you can choose and change the values of parameters for each PFT. It is possible by using an object called metaclass (=MTC). Each PFT is associated to a MTC. Here we give the list of the MTCs :

  1. bare ground
  1. tropical broad-leaved evergreen

  1. tropical broad-leaved raingreen
  1. temperate needleleaf evergreen
  1. temperate broad-leaved evergreen
  1. temperate broad-leaved summergreen
  1. boreal needleleaf evergreen
  1. boreal broad-leaved summergreen
  1. boreal needleleaf summergreen
  1. C3 grass
  1. C4 grass
  1. C3 agriculture
  1. C4 agriculture

As you notice, the list of the MTCs matches exactly the list of PFTs in the ORCHIDEE AR5 version. Each PFT is associated to one MTC, corresponding to the usual PFTs in the previous versions. Each MTC is described by the same parameters than the PFTs. The values of the MTC-parameters are fixed and are the default values of the system. By consequence, we implemented 13 MTCs in the code of the externalised version.

All you have to do is to associate a PFT to a MTC. When you link a PFT to a MTC, the PFT parameters will take automatically the default values given for the corresponding MTC. With this technique, you can modify the values and the parameters of interest for you. In practice, go the folder :

modipsl/config/ORCHIDEE_OL/Job_Name/PARAM/

and open « orchidee.def ». In the first step, specify your number of PFTs (called NVM) like this :

NVM = 13

In the second step, you will declare the array PFT_TO_MTC. You have two ways for declaring an array in "orchidee.def":

1 .Either you can declare directly like this :

 PFT_TO_MTC = 1, 2, 3, 4, 5, 6, 7, 8, 9, 10 , 11, 12 , 13
  1. Or component by component :
PFT_TO_MTC__01 = 1
PFT_TO_MTC__02 = 2
PFT_TO_MTC__03 = 3
PFT_TO_MTC__04 = 4
PFT_TO_MTC__05 = 5
PFT_TO_MTC__06 = 6
PFT_TO_MTC__07 = 7
PFT_TO_MTC__08 = 8
PFT_TO_MTC__09 = 9
PFT_TO_MTC__10 = 10
PFT_TO_MTC__11 = 11
PFT_TO_MTC__12 = 12
PFT_TO_MTC__13 = 13

In both cases, you have to declare ALL the NVM values taken by PFT_TO_MTC you intend to use for your job.
In this example, we associate each PFT to one MTC corresponding to the PFTs of the AR5 configuration of ORCHIDEE.

Actually, if you only want to use ORCHIDEE to its configuration standard and ONLY in this case, you don't need to fill PFT_TO_MTC because we implemented an default array for the case NVM =13.

Syntax advice : for the second method, there is a double underscore symbol between the name and the component of the vector

(PFT_TO_MTC__01)

« orchidee.def » recognize also the type of the parameter : for a real put 1. (like in fortran), for an integer 1, for a logical TRUE or FALSE. Look at « sechiba_parameters_default_values.txt » and « stomate_parameters_default_values.txt » in order to know the type of the parameter. Except PFT_TO_MTC, the other parameters are optional. If you want ORCHIDEE not to read some values, put a comment by using the character # at the beginning of the line.

Examples

Other aspects

How can you control your values after your job

Some rules to respect for this version