= Implemented Modules and Associated !Keywords/Flags =

In the latest MICT version you can find the following modules. Each flag list of each module needs to be checked. This is an axproximation and it might have errors.


== Spitfire ==
Introduced in MICT v6. Available flags for input data files

||= DEPENDENCIES =||= Keyword =||= Description =||
||                  ||FIRE_DISABLE        || Allow deforestation fire to be simulated when set (src_parameters/constantes.f90)|| 
||NOT FIRE_DISABLE  ||ALLOW_DEFOREST_FIRE || Activate deforestation fire module when being TRUE (src_parameters/constantes.f90)||
||                  ||LIGHTNING_FILE   || Read the ligntning map ||
||READ_OBSERVED_BA  ||BA_FILE          || Read the population density map ||
||READ_CF_COARSE    || CF_COARSE_FILE  || Read the population density map ||
||READ_CF_FINE      ||CF_FINE_FILE     || Read the population density map ||
||READ_RATIO        ||RATIO_FILE       || Read a map of ratios used to scale simulated burned area, default to 1 ||
||READ_RATIO_FLAG   ||RATIO_FLAG_FILE  || Read the population density map ||
||READ_POPDENS      ||POPDENS_FILE     || Read the population density map ||
||READ_HUMIGN       ||HUMIGN_FILE      || Read the population density map ||
||                      || READ_OBSERVED_BA || Read the observed burned_area flag ||
||                      || READ_CF_COARSE   || Read the observed burned_area flag ||
||                      || READ_CF_FINE     || Read the observed burned_area flag ||
||                      || READ_RATIO       || Read the observed burned_area flag ||
||                      || READ_RATIO_FLAG  || Read the observed burned_area flag ||
||                      || READ_POPDENS     || Read the popdens flag ||
||                      || READ_HUMIGN      || Read the human ignition parameter flag ||

== Grassland management ==
Introduced in MICT v5. Available flags:

||= Depedencies =||= Keyword =||= Description =||
|| ||ENABLE_GRAZING          || Enable module for grazing (animals or not)||
|| ||IS_GRASSLAND_MANAG`__`XX  ||Is the vegetation type a managed grassland ?||
|| ||IS_GRASSLAND_GRAZED`__`XX ||Is the vegetation type a managed grassland ?||
|| ||IS_GRASSLAND_CUT`__`XX    ||Is the vegetation type a cut grassland for management adaptation?||
|| ||IS_GRASSLAND_GRAZED     ||Is the vegetation type a grazed grassland for management adaptation?||
|| ||SLA_MAX                 ||minimum gdd to allow senescence of crops. Maximum specific leaf area (m2/gC) ||
|| ||SLA_MIN                  ||minimum specific leaf area (m2/gC) ||
||-||-||-||
|| || F_SATURANT || || ||
|| || F_NONLIMITANT || ||
|| || F_AUTOGESTION || ||
|| || F_COMPLEMENTATION || ||
|| || F_FERTILIZATION || ||
|| || NB_YEAR_MANAGEMENT || ||
|| || F_POSTAUTO || ||
|| || N_EFFECT || ||
|| || FILE_PARAM_INIT || ||
|| F_AUTOGESTION || NB_CUT_YEAR || ||
|| || F_MANAGEMENT_MAP || ||
|| || F_DEPOSITION_MAP || ||
|| || F_GRAZING_MAP || ||
|| ||GRAZING_MAP || Read the general animal_density map ||
|| F_MANAGEMENT_MAP || MANAGEMENT_MAP || ||
|| F_MANAGEMENT_MAP || MANAGEMENT_INTENSITY || ||
|| F_MANAGEMENT_MAP || MANAGEMENT_START || ||
|| F_MANAGEMENT_MAP || FERTILITY_MAP || ||
|| F_MANAGEMENT_MAP || DEPOSITION_MAP || ||
|| F_MANAGEMENT_MAP || DEPOSITION_START || ||
|| F_MANAGEMENT_MAP || GRAZING_MAP || ||

== DGVM ==

Introduced in MICT v4bis **TO CHECK**

||= Keyword =||= Description =||
|| STOMATE_OK_DGVM || Active module (y/n) ||

== Multilayer hidrology ==

||= Dependencies =||= Keyword =||= Description =||= Default =|| 
||                                   || HYDROL_CWRR || Enable/disable module (y/n) || N ||
||                                   || HYDROL_SOIL_DEPTH || Total depth of soil reservoir ||
||OK_SECHIBA and .NOT.(HYDROL_CWRR) || HYDROL_OK_HDIFF || do horizontal diffusion?  || N ||
||HYDROL_OK_HDIFF                   || HYDROL_TAU_HDIFF || time scale (s) for horizontal diffusion of water ||
||HYDROL_CWRR || CHECK_CWRR || Should we check detailed CWRR water balance ? ||
||HYDROL_CWRR || DO_PONDS || Should we include ponds ||
||HYDROL_CWRR || CWRR_N_VANGENUCHTEN || Van genuchten coefficient n ||
||HYDROL_CWRR || CWRR_A_VANGENUCHTEN || Van genuchten coefficient a ||
||HYDROL_CWRR || VWC_RESIDUAL || Residual soil water content ||
||HYDROL_CWRR || VWC_SAT || Saturated soil water content ||
||HYDROL_CWRR || CWRR_KS || Hydraulic conductivity Saturation ||
||HYDROL_CWRR || WETNESS_TRANSPIR_MAX || Soil moisture above which transpir is max ||
||HYDROL_CWRR || VWC_FC || Volumetric water content field capacity ||
||HYDROL_CWRR || VWC_WP || Volumetric water content Wilting pt ||
||HYDROL_CWRR || VWC_MIN_FOR_WET_ALB || Vol. wat. cont. above which albedo is cst ||
||HYDROL_CWRR || VWC_MAX_FOR_DRY_ALB || Vol. wat. cont. below which albedo is cst ||
||HYDROL_CWRR || CWRR_NKS_N0 || fitted value for relation log((n-n0)/(n_ref-n0)) = nk_rel * log(k/k_ref) ||
||HYDROL_CWRR || CWRR_NKS_POWER || fitted value for relation log((n-n0)/(n_ref-n0)) = nk_rel * log(k/k_ref) ||
||HYDROL_CWRR || CWRR_AKS_A0 || fitted value for relation log((a-a0)/(a_ref-a0)) = ak_rel * log(k/k_ref) ||
||HYDROL_CWRR || CWRR_AKS_POWER || fitted value for relation log((a-a0)/(a_ref-a0)) = ak_rel * log(k/k_ref) ||
||HYDROL_CWRR || KFACT_DECAY_RATE || Factor for Ks decay with depth ||
||HYDROL_CWRR || KFACT_STARTING_DEPTH || Depth for compacted value of Ks ||
||HYDROL_CWRR || KFACT_MAX || Maximum Factor for Ks increase due to vegetation ||

== Land Use Change (LUC) ==

||= Keyword =||= Description =||
|| MAP_PFT_FORMAT || Read a land use vegetation map on PFT format. Before LAND_USE ||
|| COEFF_LCCHANGE_1 || ||
|| COEFF_LCCHANGE_10 || ||
|| COEFF_LCCHANGE_100 || ||

== Soil freezing ==

||= DEPENDENCIES =||= Keyword =||= Description =||
|| || OK_FREEZE || Activate the complet soil freezing scheme. This flag controls the default values for several flags controling the different soil freezing processes.  ||
||- ||- ||- ||
|| Set default to OK_FREEZE || OK_ECORR || Energy conservation : Correction to make sure that the same latent heat is released and consumed during freezing and thawing ||
|| Set default to OK_FREEZE || READ_REFTEMP || Initialize soil temperature using climatological temperature (y/n) ||
|| Set default to OK_FREEZE || OK_FREEZE_THERMIX || Activate thermal part of the soil freezing scheme (y/n) ||
|| Set default to OK_FREEZE || OK_FREEZE_CWRR || CWRR freezing scheme scheme by I. Gouttevin.  ||
|| || READ_PERMAFROST_MAP || Read information about ice content, overburden and permafrost type from IPA map (y/N) ||
||READ_PERMAFROST_MAP || PERMAFROST_MAP_FILE || Permafrost input data file path ||
||  || PROS || Soil porosity ||
||  || FR_DT || Freezing window ||
||-  || Related to soil freezing in diffuco module  ||-  ||
|| Set default to OK_FREEZE || OK_SNOWFACT || Activates the smoothering of landscapes by snow ||
||-  || Related to soil freezing in hydrol module  ||-  ||
|| Set default to OK_FREEZE || OK_FREEZE_CWRR || CWRR freezing scheme scheme by I. Gouttevin.  ||
|| HYDROL_CWRR AND OK_FREEZE_CWRR || OK_THERMODYNAMICAL_FREEZING || Calculate frozen fraction thermodynamically ||

== Permafrost carbon ==

||=Dependencies=||= Keyword =||= Description =||
||       || OK_PC || Enable/disable module (y/n) ||
|| OK_PC || organic_layer_thickness  || The thickness of organic layer (n) ||
|| OK_PC || OK_METHANE || Is Methanogenesis and -trophy taken into account?(n) ||
|| OK_PC || HEAT_CO2_ACT ||  specific heat of soil organic matter oxidation for active carbon (J/kg carbon)(40.e06) ||
|| OK_PC || HEAT_CO2_SLO ||  30.e06 ||
|| OK_PC || HEAT_CO2_PAS ||  10.e06 ||
|| OK_PC || TAU_CH4_TROPH ||  43200 ||
|| OK_PC || TAU_CH4_GEN_RATIO ||  9.0 ||
|| OK_PC || O2_SEUIL_MGEN  || 3.0 ||
|| OK_PC || HEAT_CH4_GEN  || 0 ||
|| OK_PC || HEAT_CH4_TROPH  || 0 ||
|| OK_PC || frozen_respiration_func || 3 ||
|| OK_PC || O2_LIMIT || y ||
|| OK_PC || NO_PFROST_DECOMP ||  n ||
|| OK_PC || cryoturbate || y ||
|| OK_PC || cryoturbation_diff_k ||  0.01 ||
|| OK_PC || MG_useallCpools  || y ||
|| OK_PC || max_shum_value  || 1  ||
|| OK_PC || reset_yedoma_carbon || n ||
|| OK_PC || yedoma_map_filename || yedoma_map.nc ||
|| OK_PC || yedoma_depth || 20 ||
|| OK_PC || deepC_a_init || 1790.1 ||
|| OK_PC || deepC_s_init || 14360.8 ||
|| OK_PC || deepC_p_init || 1436 ||
|| OK_PC || newaltcalc || n ||
|| OK_PC || COND_FACT || 1 ||
|| OK_PC || new_carbinput_intdepzlit || Not described (n) ||
|| OK_PC || correct_carboninput_vertprof || Not described (n) ||
||  -    || -                            || - ||
|| OK_PC || use_new_cryoturbation || Not described (n) ||
|| OK_PC || cryoturbation_method || Not described (1) ||
|| OK_PC || max_cryoturb_alt || Not described (1) ||
|| OK_PC || reset_fixed_cryoturbation_depth || Not described (n) ||
|| OK_PC || use_fixed_cryoturbation_depth || Not described (n) ||

== Multilayer snow ==

||= Keyword =||= Description =||
|| OK_EXPLICITSNOW || Activate explict snow scheme (y/N) ||
 

== Routing ==

HYDROL_CWRR changes default values

||=Dependencies=||= Keyword =||= Description =||
||              || RIVER_ROUTING || Enable/disable module (y/n). Decides if we route the water or not ||
||RIVER_ROUTING || DO_IRRIGATION || Should we compute an irrigation flux ||
||RIVER_ROUTING || DT_ROUTING || Time step of the routing scheme ||
||RIVER_ROUTING || ROUTING_RIVERS || Number of rivers ||
||RIVER_ROUTING || DO_FLOODINFILT || Should floodplains reinfiltrate into the soil ||
||RIVER_ROUTING || DO_PONDS || Should we include ponds ||
||RIVER_ROUTING || SLOW_TCST || Time constant for the slow reservoir ||
||RIVER_ROUTING || FAST_TCST || Time constant for the fast reservoir ||
||RIVER_ROUTING || STREAM_TCST || Time constant for the flood reservoir ||
||RIVER_ROUTING || FLOOD_TCST || Fraction of the river that flows back to swamps ||
||RIVER_ROUTING || SWAMP_CST || Parameter to fix the shape of the floodplain ||
||RIVER_ROUTING || FLOOD_BETA || Parameter to fix the shape of the floodplain ||
||RIVER_ROUTING || POND_BETAP || Ratio of the basin surface intercepted by ponds and the maximum surface of ponds ||


=== Foodplains ===

||=Dependencies=||= Keyword =||= Description =||
|| RIVER_ROUTING || DO_FLOODPLAINS || Enable/disable module (y/n) ||
|| DO_FLOODPLAINS or DO_IRRIGATION || IRRIGATION_FILE || Name of file which contains the map of irrigated areas ||
|| DO_FLOODPLAINS or DO_PONDS || FLOOD_CRI || Potential height for which all the basin is flooded ||
|| DO_FLOODPLAINS or DO_PONDS || POND_CRI || Potential height for which all the basin is a pond ||

=== Swamps ===

||=Dependencies=||= Keyword =||= Description =||
|| RIVER_ROUTING || DO_SWAMPS || Enable/disable module (y/n) ||

== Wetlands ==

||=Dependencies=||= Keyword =||= Description =||
||            || CH4_CALCUL || Enable/disable module (y/n) ||
|| CH4_CALCUL || CH4atmo_CONC ||Not described ||
|| CH4_CALCUL || CH4_WTD1 || Not described ||
|| CH4_CALCUL || CH4_WTD2 || Not described ||
|| CH4_CALCUL || CH4_WTD3 || Not described ||
|| CH4_CALCUL || CH4_WTD4 || Not described ||
|| CH4_CALCUL || NVERT || nb of vertical layers for CH4 diffusion ||
|| CH4_CALCUL || NS || ... ||
|| CH4_CALCUL || NDAY || ... ||
|| CH4_CALCUL || H || ... ||
|| CH4_CALCUL || RK || ... ||
|| CH4_CALCUL || DIFFAIR || ... ||
|| CH4_CALCUL || POX || ... ||
|| CH4_CALCUL || DVEG || ... ||
|| CH4_CALCUL || RKM || ... ||
|| CH4_CALCUL || XVMAX || ... ||
|| CH4_CALCUL || OXQ10 || ... ||
|| CH4_CALCUL || SCMAX || ... ||
|| CH4_CALCUL || SR0PL || ... ||
|| CH4_CALCUL || PWATER_WET1 || ... ||
|| CH4_CALCUL || PWATER_WET2 || ... ||
|| CH4_CALCUL || PWATER_WET3 || ... ||
|| CH4_CALCUL || PWATER_WET4 || ... ||
|| CH4_CALCUL || RPV || ... ||
|| CH4_CALCUL || IOTHER || ... ||
|| CH4_CALCUL || RQ10 || ... ||
|| CH4_CALCUL || ALPHA_CH4 || ... ||

== Topmodel ==

||=Dependencies=||= Keyword =||= Description =||
||                                || TOPM_CALCUL || Enable/disable module (y/n) ||
|| TOPM_CALCUL and NOT IMPOSE_VEG || TOPMODEL_PARAMETERS_FILE || /home/satellites1/speng/ORCHIDEE/INPUT/TOPMODEL_param_1deg.nc ||

== CO2 variation ==

Define with value 

||= Keyword =||= Description =||
|| FORCE_CO2_VEG || Flag to force the value of atmospheric CO2 for vegetation ||
|| ATM_CO2 || Default value 280.0. You can find at /home/orchideeshare/igcmg/IGCM/BC/SRF/OL2/CO2_1860_2012_TRENDY2.txt a set of values used with modipsl ||

== Analytic spinup ==

Not working with carbon parmafrost, for the moment use the forcesoil method in order to add carbon in the soil.

||=Dependencies=||= Keyword =||= Description =||
||                 || SPINUP_ANALYTIC || Enable/disable module(y/N) ||
|| SPINUP_ANALYTIC || SPINUP_PERIOD || Period to calulcate equilibrium during spinup analytic ||
|| SPINUP_ANALYTIC || EPS_CARBON || Allowed error on carbon stock ||

=== Forcesoil ===

||=Dependencies=||= Keyword =||= Description =||
|| STOMATE_CFORCING_NAME || FORCESOIL_STEP_PER_YEAR || Number of time steps per year for carbon spinup (default 12) ||
|| STOMATE_CFORCING_NAME || FORCESOIL_NB_YEAR || Number of years saved for carbon spinup. (default 1) ||

== Spredprec ==

Spred precipiation over a period time. Use default.

Check out:
* ticket:177

||= Keyword =||= Description =||
|| SPRED_PREC || Spread the precipitation (1) ||

== CO2 downregulation ==

Use default.
||= Keyword =||= Description =||
|| DOWNREGULATION_CO2 || Enable/disable module (y/n) ||
|| DOWNREGULATION_CO2_BASELEVEL || CO2 baselevel ||
|| DOWNREGULATION_CO2_COEFF || coefficient for CO2 downregulation (unitless) ||

= Notes =

 VEGET_UPDATE= 0Y::
  To use on crops. First map read.

 VEGET_UPDATE= 1Y::
  On active le LUC, on lit la carte de vegétation seulement pour prendre en compte les crops qui évoluent alors ; le DGVM continue de gérer les PFTs naturels en fonction des conditions climatiques (enfin c'est ce que j'ai compris).


Il ne faut surtout pas mettre IMPOSE_VEG= y puisque si on impose la végétation elle ne va pas pouvoir évoluer en fonction du climat (je n'ai pas testé mais ce fonctionnement semble absurde, il faudrait arrêter avec un message d'erreur).