Changes between Version 45 and Version 46 of Doc/Config/LMDZORINCA

Timestamp:

02/15/24 17:11:30 (4 months ago)

Author:

klaurent

Comment:

--

Doc/Config/LMDZORINCA

@@ -241 +241 @@
 Do not forget to install a new Job (command ins_job) in order to take into account these modifications.
 
+## How to add a parameter in the inca.card and use it in the code ##
+If you want to add a parameter in COMP/inca.card, you have to add lines at two different places.
+
+1. In your configuration repository (for example, modipsl/config/LMDZORINCA/)
+  a. First, change the driver file (GENERAL/DRIVER/inca.driver ou name_of_your_simulation/DRIVER/inca.driver) by adding these lines in the group {{{function CHM_Update}}}:
+{{{
+    if [ ! X${inca_UserChoices_NameOfParameter} = X ] ; then
+        IGCM_comp_modifyDefFile nonblocker inca.def  NameOfParameter ${inca_UserChoices_NameOfParameter}
+    else
+        IGCM_comp_modifyDefFile nonblocker inca.def  NameOfParameter DEFAULT
+    fi
+}}}
+  b. Then, you can add the parameter in the PARAM/inca.def: 
+{{{
+NameOfParameter=_AUTO_: DEFAULT =1.0
+}}}
+  c. Finally, you can add it in the file COMP/inca.card:
+{{{
+NameOfParameter=1.2
+}}}
+
+2. In the source code of INCA (modipsl/modeles/INCA/src)
+  a. In INCA_MOD/param_chem_mod.F90, add two lines at the end as follow:
+{{{
+  REAL, SAVE :: NameOfParameter    !! add a comment if needed
+!$OMP THREADPRIVATE(NameOfParameter) 
+}}}
+  b. In INCA_SRC/conf_chem.F90, add these lines:
+    * In the beginning:
+{{{
+  REAL :: NameOfParameter_omp
+}}}
+    * In the {{{!$OMP MASTER}}} part
+{{{
+  ! default value for NameOfParameter
+  NameOfParameter_omp=1.0
+  ! reading in inca.def if define
+  CALL getin('NameOfParameter', NameOfParameter_omp)
+}}}
+    * After the {{{!$OMP BARRIER}}} line
+{{{
+  CALL bcast(NameOfParameter_omp)
+  NameOfParameter = NameOfParameter_omp
+}}}
+  c. Now, you can use your parameter in the code. Make sure that the module {{{PARAM_CHEM}}} is used at the beginning of your subroutine.