Changes between Version 1 and Version 2 of Tags/196/ExternalisationParameters/UsersGuide

Timestamp:

2011-03-18T15:34:52+01:00 (13 years ago)

Author:

dsolyga

Comment:

--

Tags/196/ExternalisationParameters/UsersGuide

@@ -7 +7 @@
 
 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
@@ -118 +118 @@
 === Examples ===
 
+1)Change the value for an already-existing PFT-parameter :
+
+{{{
+LAI_MAX__10 = 3.5 
+}}}
+
+2)Create a new pft that differs only by one parameter value. For that, follow these two steps :
+a)  Associate your new PFT to one MTC using the array called PFT_TO_MTC. If you want your 14th PFT to possess the carateristics of the C3   grass , set exactly  in     « orchidee.def » :
+
+
+{{{
+NVM =14
+
+PFT_TO_MTC__14 =10
+}}}
+ (the 10th MTC is C3 grass according to the previous array)
+
+At this point, your new pft will share automatically all the standard values taken by the parameters of the C3 grass.
+
+
+b)  Now, your new PFT is not exactly the C3 grass. It differs from the C3 grass by one value.   For example, let's suppose that the LAI_MAX parameter for your PFT is different from the        standard value. All you have to do is to set in the « orchidee.def »:
+
+{{{
+LAI_MAX__14 = 3.5
+}}}
+
+
+These two examples are not similar : in the first case, you change the '''LAI_MAX''' value from the default one for the PFT 10 (C3 grass). In the second case, you introduce a  new specie of C3 grass (PFT 14).[[BR]]
+
+You have just seen an example with one parameter.  You are not limited to one : you can change the values for any given set of parameters.You can also change NVM in the other way ; you could set NVM less than 13 and considering only a given number of MTCs (4 or 5 for example)[[BR]]
+
+Let's suppose you only want temperate  vegetation and natural grass for your job. All you have to do is to set :
+
+{{{
+NVM = 6
+
+PFT_TO_MTC__01  =  1
+PFT_TO_MTC__02  =  4
+PFT_TO_MTC__03  =  5
+PFT_TO_MTC__04  =  6
+PFT_TO_MTC__05  = 10
+PFT_TO_MTC__06  = 11
+}}}
+
+'''NB: Concerning the other arrays parameters'''[[BR]]
+
+For the other arrays parameters, you have to set directly the new values. 
+
+For example, let's consider the parameter called albsoil_vis. His key word is ALBSOIL_VIS and it is of dimension 9, corresponding to the dimensioning parameter for the soil color numbers and their albedo. Its standard values are : 
+{{{
+albsoil_vis = (/0.18,  0.16,  0.16,  0.15,  0.12,  0.105,  0.09,  0.075,  0.25/)
+}}}
+
+If you want to change the third value, set in « orchidee.def » :
+{{{
+ALBSOIL_VIS__03 = 0.25
+}}}
+
+
+(for example). You could change the values of the third, sixth and ninth components. Just set :
+
+{{{
+ALBSOIL_VIS__03  =  0.25
+ALBSOIL_VIS__06  =  0.120
+ALBSOIL_VIS__09  =  0.27
+}}}
+
+This last example is available for all parameters-arrays (PFT or others), except PFT_TO_MTC.
+
+'''Warning ''': all parameters depend on the differents flags of ORCHIDEE like river_routing, ok_co2, ok_stomate, etc.... For example, the parameters used by stomate will be read only if the option STOMATE_OK_STOMATE is set to TRUE in « orchidee.def ». You will find the list of the flags and the corresponding parameters in « sechiba_parameters_default_values.txt » and « stomate_parameters_default_values.txt ».
+
+
+
+== How can you control your values after your job ==
+
+If you want to see if ORCHIDEE takes into account your modifications, you must go in a first step to the following folder : 
+
+
+{{{
+...../IGCM_OUT/OL2/JOB_JobName/OOL/Debug/
+}}}
+
+You will find three types of files (this is a my own example, replace SECHSTOM by the name of your job) : 
+{{{
+SECHSTOM_19820101_19820131_out_orchidee_ol 
+SECHSTOM_19820101_19820131_run.def 
+SECHSTOM_19820101_19820131_used_run.def
+.....
+}}}
+
+The file « SECHSTOM_19820101_19820131_run.def  » is a copy of your initial « orchidee.def ».
+In this one, you could find of course the values you imposed.[[BR]]
+
+The file  « SECHSTOM_19820101_19820131_used_run.def » contains the list of all the parameters read by the driver in « orchidee.def ». For the scalar parameters read by ORCHIDEE,  you will find  this comment for example in « SECHSTOM_19820101_19820131_used_run.def » :
+{{{
+# Values of LIMIT_NORTH comes from run.def
+}}}
+
+Thanks to that coment, you know that the LIMIT_NORTH  parameter has been imposed by the user.
+Unfortunately, in  the case of the arrays, it will give you only the values which were default or imposed. For example, you could find : 
+{{{
+# Values of LAI_MAX are all defaults.
+}}}
+
+or :
+{{{
+# Values of ALBSOIL_VIS are a mix of run.def and defaults
+}}}
+
+but it won't tell you which value is default or not.  Normally, it  would be sufficient to  know   if ORCHIDEE has correctly read your « orchidee.def ».     
+
+
+The file « SECHSTOM_19820101_19820131_out_orchidee_ol  » will list only the default values :
+
+{{{
+USING DEFAULTS : ALBSOIL_VIS__00001 =  0.180000000000000     
+USING DEFAULTS : ALBSOIL_VIS__00002 =  0.160000000000000          
+USING DEFAULTS : ALBSOIL_VIS__00004 =  0.150000000000000     
+USING DEFAULTS : ALBSOIL_VIS__00005 =  0.120000000000000  
+}}}
+
+You notice that ALBSOIL_VIS__03 is missing.  Comparing the files  « SECHSTOM_19820101_19820131_used_run.def »  and
+« SECHSTOM_19820101_19820131_run.def  » to be absolutely sure to know whether ORCHIDEE has taken into account your new values.  
+
+
+== Some rules to respect for this version ==
+
+
+There are few rules you have to respect for the moment (discussions are needed with the people involved to solve these restrictions) :
+
+-'''First rule''': Except if you use the standard configuration of ORCHIDEE, you always have to fill the array PFT_TO_MTC in « orchidee.def ».
+
+It is very important because without it, the code won't be able to make the link between PFT and MTC.
+The dimension of PFT_TO_MTC is NVM. Even the parameter NVM is optional : if you don't set it, NVM will take the default value 13. 
+
+So if you have
+more PFTs, ORCHIDEE will only read the first 13 values of your correspondence table. This rule is also applied to the four following parameters when you 
+activate IMPOSE_VEG :
+
+{{{
+SECHIBA_VEG
+SECHIBA_VEGMAX
+SECHIBA_LAI
+SLOWPROC_HEIGHT
+}}}
+The sum of the elements of SECHIBA_VEG and SECHIBA_VEGMAX must be equal to 1.
+
+
+
+-'''Second rule :''' You have to generate yourself or to provide your veget map with the good number of PFTs for using the "externalized" version. Soon
+a python script will be provided for generating a veget map. This veget map is based on the Olson classification. With the script, you will be able to choose the number of PFTs of your map. A page on the wiki will be created.
+
+If you don't want to use a new map, you can set the flag IMPOSE_VEG to TRUE. In this case, you will work without a veget map. Be sure to have filled PFT_TO_MTC.
+
+-'''Third rule :'''the first PFT has to be associated to the first MTC :
+{{{
+ie PFT_TO_MTC__01 = 1
+}}}
+Moreover, you can't have two PFTs corresponding to the bare soil . To sum up, the only PFT associated to the bare soil (the first MTC) '''has to be''' the first PFT.
+
+
+
 == Other aspects ==
 
@@ -124 +286 @@
 
 
-== How can you control your values after your job ==
-
-
-== Some rules to respect for this version ==
+
+
+