source: CONFIG/UNIFORM/v6/IPSLCM6/GENERAL/DRIVER/opa9.driver @ 3908

Last change on this file since 3908 was 3908, checked in by cetlod, 3 years ago

Generalization of Reproducibiliy_After_Restart option for monthly and daily runs

File size: 11.9 KB
Line 
1#!/bin/ksh
2#-----------------------------------------------------------------
3function OCE_Initialize
4{
5    IGCM_debug_PushStack "OCE_Initialize"
6
7    JOB_NAME=${config_UserChoices_JobName}
8
9    RESOL_OCE_ICE=$( echo ${RESOL} | awk "-Fx" '{print $1}' )
10    case ${RESOL_OCE_ICE} in
11        ( *LIM2* ) SEAICE_MODEL=LIM2 ;  LIM_VERSION=2 ;;
12        ( *LIM3* ) SEAICE_MODEL=LIM3 ;  LIM_VERSION=3 ;;
13        ( *CICE* ) SEAICE_MODEL=CICE                  ;;
14        ( *      ) SEAICE_MODEL=UNKNOWN               ;;
15    esac
16    RESOL_OCE=$( echo ${RESOL_OCE_ICE} | sed "s/${SEAICE_MODEL}//" )
17
18    IGCM_debug_Print 1 "RESOL          : ${RESOL}"
19    IGCM_debug_Print 1 "RESOL_OCE_ICE  : ${RESOL_OCE_ICE}"
20    IGCM_debug_Print 1 "SEAICE_MODEL   : ${SEAICE_MODEL}"
21    IGCM_debug_Print 1 "LIM_VERSION    : ${LIM_VERSION}"
22    IGCM_debug_Print 1 "RESOL_OCE      : ${RESOL_OCE}"
23
24    # Local function to find namelists parameters
25    #supergrep () { grep "^ *$1 *=" $2 | sed -e "s% *\!.*%%" ; }
26    supergrep () { grep "^ *$1 *=" $2 | sed -e "s% *\!.*%%" -e "s%^ *$1 *=%%" ; }
27    ##--Variables used by OPA --
28    NAMELIST_OPA_CFG=${SUBMIT_DIR}/PARAM/namelist_${RESOL_OCE}_cfg
29    IGCM_debug_Print 1 "namelist_cfg : ${NAMELIST_OPA_CFG}"
30    if [ ! -r ${NAMELIST_OPA_CFG} ] ; then
31        IGCM_debug_Exit "${NAMELIST_OPA_CFG} not found"
32        IGCM_debug_Verif_Exit
33    fi
34    OPA_RDT=$(       supergrep rn_rdt        ${NAMELIST_OPA_CFG} )
35    OPA_NN_FSBC=$(   supergrep nn_fsbc       ${NAMELIST_OPA_CFG} )
36    #
37    # OPA_RDT=$(       supergrep rn_rdt        namelist_cfg )
38    # OPA_NN_FSBC=$(   supergrep nn_fsbc       namelist_cfg )
39    (( OPA_NPDT_DAY   =  86400 / OPA_RDT        ))
40    (( OPA_NPDT_YEAR  =  OPA_NPDT_DAY * 365     ))
41    (( OPA_RDT_SBC    =  OPA_RDT * OPA_NN_FSBC ))
42 
43    # Period Length In Days between DateBegin and first day of calendar 0001 01 01
44    # /!\ Needed by OPA namelist to compute file names /!\
45    (( DaysSinceJC = $( IGCM_date_DaysSinceJC ${DateBegin} ) + 1 ))
46
47    IGCM_debug_Print 1 " "
48    IGCM_debug_Print 1 "OPA_RDT        ${OPA_RDT}"
49    IGCM_debug_Print 1 "OPA_NN_FSBC    ${OPA_NN_FSBC}"
50    IGCM_debug_Print 1 "OPA_RDT_SBC    ${OPA_RDT_SBC}"
51    IGCM_debug_Print 1 "OPA_NPDT_DAY   ${OPA_NPDT_DAY}"
52    IGCM_debug_Print 1 "OPA_NPDT_YEAR  ${OPA_NPDT_YEAR}"
53    IGCM_debug_Print 1 "DaysSinceJC    ${DaysSinceJC}"
54
55    ## Check that nn_fsbc is correct compare to coupling frequency
56    FreqCoupling=${oasis_UserChoices_FreqCoupling:-86400}
57   
58    ## This informations are used for diaptr, trends and diagap files
59    ## only the first frequency is used for this files
60   
61    IGCM_debug_Print 1 "FreqCoupling    ${FreqCoupling}"
62    IGCM_debug_Print 1 "OPA_NN_FSBC    ${OPA_NN_FSBC}"
63    IGCM_debug_Print 1 "OPA_RDT        ${OPA_RDT}"
64    IGCM_debug_Print 1 "OPA_RDT_SBC    ${OPA_RDT_SBC}"
65   
66    if [[ ${OPA_RDT_SBC} -gt ${FreqCoupling} ]] ; then
67        IGCM_debug_Exit "OPA_RDT_SBC=${OPA_RDT_SBC} is greater than FreqCoupling=${FreqCoupling}"
68        IGCM_debug_Verif_Exit
69    fi
70
71    IGCM_debug_PopStack "OCE_Initialize"
72   
73}
74
75#-----------------------------------------------------------------
76function OCE_Update
77{
78    IGCM_debug_PushStack "OCE_Update"
79 
80    ##--Write Frequency for iomput
81    ## Differents frequencies are allowed for OCE files
82
83    V1D_ENABLE=".FALSE."
84    V5D_ENABLE=".FALSE."
85    V1M_ENABLE=".FALSE."
86    V1Y_ENABLE=".FALSE."
87
88    for frequency in ${config_OCE_WriteFrequency} ; do
89        case ${frequency} in
90            ( 1D|1d ) V1D_ENABLE=".TRUE." ;;
91            ( 5D|5d ) V5D_ENABLE=".TRUE." ;;
92            ( 1M|1m ) V1M_ENABLE=".TRUE." ;;
93            ( *[yY] ) V1Y_ENABLE=".TRUE." ;;
94        esac
95    done
96
97    # Period Length In Days between DateBegin and first day of calendar 0001 01 01
98    # Needed by OPA namelist to compute correct file names
99    (( PeriodDaysSinceJC =  $( IGCM_date_DaysSinceJC ${PeriodDateBegin} ) + 1  ))
100
101    ##-- Number of time steps updated : the first, the last and the number of time steps
102    (( OPA_NIT000 = ( PeriodDaysSinceJC - DaysSinceJC ) * OPA_NPDT_DAY + 1 ))
103    (( OPA_NPDT   = PeriodLengthInDays * OPA_NPDT_DAY ))
104    (( OPA_NITEND = OPA_NIT000 + OPA_NPDT - 1))
105
106    ##-- We force one restart file at the end of the trunk
107    OPA_NSTOCK="${OPA_NITEND}"
108
109
110    ##-- Additionnal Restart Option to force reproducibility ; force kt to kt red in restart file
111    ## ${opa9_UserChoices_Reproducibility_after_restart}
112
113    IGCM_card_DefineVariableFromOption ${SUBMIT_DIR}/COMP/opa9.card UserChoices Reproducibility_after_restart
114
115   ##-- Restart configuration
116    if ( [ "${opa9_UserChoices_Reproducibility_after_restart}" = "y" ] ) ; then
117      OPA_LRSTAR=.TRUE.
118      OPA_NRSTDT=2
119      #echo "OPA RESTART"
120      IGCM_debug_Print 1 'WARNING : dangerous option for NEMO opa9 pisces lim3'
121      IGCM_debug_Print 1 'Reproducibility_after_Restart forced ie kt forced to kt red in restart file : ' ${opa9_UserChoices_Reproducibility_after_restart}
122
123    elif ( [ "${CumulPeriod}" -eq 1 ] && [ "${config_OCE_Restart}" = "n" ] ) ; then
124      OPA_LRSTAR=.FALSE.
125      OPA_NRSTDT=0
126      #echo "NO OPA RESTART"
127    elif ( [ "${CumulPeriod}" -eq 1 ] && [ "${config_OCE_Restart}" = "y" ] ) ; then
128      OPA_LRSTAR=.TRUE.
129      OPA_NRSTDT=0
130      #echo "OPA RESTART"
131    else
132      OPA_LRSTAR=.TRUE.
133      OPA_NRSTDT=2
134      #echo "OPA RESTART"
135    fi
136
137    if ( [ "${CumulPeriod}" -eq 1 ] && [ "${opa9_UserChoices_Restart_TS_only}" = "y" ] ) ; then
138      OPA_LRSTAR_TS=.TRUE.
139    else
140      OPA_LRSTAR_TS=.FALSE.
141    fi
142
143    ##-- Meshmask option. Forced only once.
144    IGCM_card_DefineVariableFromOption ${SUBMIT_DIR}/COMP/opa9.card UserChoices mesh_mask
145
146    OPA_NMSH=0
147    if [ "${opa9_UserChoices_mesh_mask}" = "y" ]; then
148        OPA_NMSH=1
149        IGCM_card_WriteOption ${SUBMIT_DIR}/COMP/opa9.card UserChoices mesh_mask "n"
150    fi
151
152    # nleapy configuration
153    case ${config_UserChoices_CalendarType} in
154        ( leap|gregorian) OPA_NLEAPY=1  ;;
155        ( noleap        ) OPA_NLEAPY=0  ;;
156        ( 360d          ) OPA_NLEAPY=30 ;;
157        ( *             ) OPA_NLEAPY=30 ;;
158    esac
159
160    if ( [ "${opa9_UserChoices_Reproducibility_after_restart}" = "y" ] ) ; then
161      ##-- choose the right restart file
162      NEMO_RESTART_FILE=restartopa.nc
163      [ -f restartopa_0000.nc ] && NEMO_RESTART_FILE=restartopa_0000.nc
164      ##-- Getting from restart file the last time step of the run at which we want to re-start
165      NEMO_KT_FROM_RESTART=$(ncdump -v kt ${NEMO_RESTART_FILE}|grep 'kt ='|awk '{print $3}' )
166
167      if ( [ "${CumulPeriod}" -eq 1 ] ) ; then
168        ## Force the date in the restart file to be the last day before the begining of the new run
169        dateendprevious=$( IGCM_date_AddDaysToGregorianDate ${DateBegin} -1 )
170        IGCM_debug_Print 1 "Previous Date  ${dateendprevious}"
171        IGCM_debug_Print 1 "cmd done to modify NEMO restartfile:   ncap2 -s ndastp=${dateendprevious} ${NEMO_RESTART_FILE}  tmp.nc"
172        if [ -f restartopa_0000.nc ] ; then
173           typeset -Z4 ncpu=0
174           while [ $ncpu -lt ${OCE_PROC_MPI} ] ; do
175              ncap2 -s "ndastp=${dateendprevious}" restartopa_${ncpu}.nc  tmp.nc
176              mv tmp.nc restartopa_${ncpu}.nc
177              (( ncpu = ncpu + 1 ))
178           done
179        else
180           ncap2 -s "ndastp=${dateendprevious}" ${NEMO_RESTART_FILE}  tmp.nc
181           mv tmp.nc ${NEMO_RESTART_FILE}
182        fi
183        ##-- Getting from restart file the "new" restart date of run at which we want to re-start
184        NEMO_NDASTP_FROM_RESTART=$(ncdump -v ndastp ${NEMO_RESTART_FILE}|grep 'ndastp ='|awk '{print $3}' )
185        IGCM_debug_Print 1 "NEMO_NDASTP (from Restart) for 1st Period       : ${NEMO_NDASTP_FROM_RESTART}"
186
187        IGCM_date_GetYearMonthDay ${PeriodDateBegin} Verif_repro_year Verif_repro_month Verif_repro_day
188
189        if [ X${Verif_repro_month}${Verif_repro_day} != X"0101" ] ; then
190          IGCM_debug_Exit " PeriodDateBegin = ${PeriodDateBegin}is uncompatible with Reproducibility_after_Restart=y, please start on 0101"
191        fi
192
193      fi
194
195      (( NEMO_NIT000 = NEMO_KT_FROM_RESTART + 1 ))
196      (( NEMO_NITEND = NEMO_KT_FROM_RESTART + OPA_NITEND - OPA_NIT000 + 1 ))
197      IGCM_debug_Print 1 "NEMO_NIT000 (from Restart)        : ${NEMO_NIT000}"
198      IGCM_debug_Print 1 "NEMO_NITEND (from Restart + ... ) : ${NEMO_NITEND}"
199      ##-- We force one restart file at the end of the trunk
200      OPA_NSTOCK="${NEMO_NITEND}"
201      OPA_NIT000="${NEMO_NIT000}"
202      OPA_NITEND="${NEMO_NITEND}"
203    fi
204
205    typeset -r PRECIS=8
206    NEMO_END=$( echo $( awk "BEGIN { printf \"%0${PRECIS}d\",${OPA_NITEND} }" ) ) 
207
208    IGCM_comp_modifyNamelist blocker    namelist_cfg cn_exp       ${config_UserChoices_JobName}
209    IGCM_comp_modifyNamelist blocker    namelist_cfg nn_it000     ${OPA_NIT000}
210    IGCM_comp_modifyNamelist blocker    namelist_cfg nn_itend     ${OPA_NITEND}
211    IGCM_comp_modifyNamelist blocker    namelist_cfg ln_rstart    ${OPA_LRSTAR}
212    IGCM_comp_modifyNamelist blocker    namelist_cfg ln_rstart_ts ${OPA_LRSTAR_TS}
213    IGCM_comp_modifyNamelist blocker    namelist_cfg nn_stock     ${OPA_NSTOCK}
214    IGCM_comp_modifyNamelist blocker    namelist_cfg nn_rstctl    ${OPA_NRSTDT}
215    IGCM_comp_modifyNamelist blocker    namelist_cfg nn_date0     ${PeriodDateBegin}
216    IGCM_comp_modifyNamelist nonblocker namelist_cfg nn_msh       ${OPA_NMSH}
217    IGCM_comp_modifyNamelist nonblocker namelist_cfg nn_rnf_depth_file  ${OPA_NMSH}
218    IGCM_comp_modifyNamelist blocker    namelist_cfg nn_leapy     ${OPA_NLEAPY}
219   
220    # Update iodef.xml
221
222    IGCM_debug_Print 1 'Informations into iodef.xml : V1D_ENABLE V5D_ENABLE V1M_ENABLE V1Y_ENABLE '
223    IGCM_debug_Print 1 ${V1D_ENABLE}  ${V5D_ENABLE} ${V1M_ENABLE} ${V1Y_ENABLE}
224
225    IGCM_comp_modifyXmlFile nonblocker file_def_nemo-opa.xml 1d_opa enabled ${V1D_ENABLE}
226    IGCM_comp_modifyXmlFile nonblocker file_def_nemo-opa.xml 5d_opa enabled ${V5D_ENABLE}
227    IGCM_comp_modifyXmlFile nonblocker file_def_nemo-opa.xml 1m_opa enabled ${V1M_ENABLE}
228    IGCM_comp_modifyXmlFile nonblocker file_def_nemo-opa.xml 1y_opa enabled ${V1Y_ENABLE}
229
230    IGCM_comp_modifyXmlFile nonblocker file_def_nemo-opa.xml 1d_opa output_level ${opa9_UserChoices_OutputLevel}
231    IGCM_comp_modifyXmlFile nonblocker file_def_nemo-opa.xml 5d_opa output_level ${opa9_UserChoices_OutputLevel}
232    IGCM_comp_modifyXmlFile nonblocker file_def_nemo-opa.xml 1m_opa output_level ${opa9_UserChoices_OutputLevel}
233    IGCM_comp_modifyXmlFile nonblocker file_def_nemo-opa.xml 1y_opa output_level ${opa9_UserChoices_OutputLevel}
234
235
236    IGCM_comp_modifyXmlFile force context_nemo.xml ref_year NONE ${InitYear} 
237       
238 
239    # for MPP and switch to different number of procs for NEMO.  We need to suppres restartopa the second period, if restartopa_0000 exist
240    # same thing for restart_trc and restart_ice_in
241
242    for restartfilenemo in restartopa restart_trc restart_ice_in ; do
243      [ -f ${restartfilenemo}.nc ] && [ -f ${restartfilenemo}_0000.nc ] && IGCM_sys_Rm -f ${restartfilenemo}.nc
244    done
245
246    # Add include of nemo context in iodef.xml
247    # In iodef.xml add on next line after "COMPONENT CONTEXT"
248    #  <context id="nemo" src="./context_nemo.xml"/>
249    echo '<context id="nemo" src="./context_nemo.xml"/>' > add.tmp
250    if [ X"$( echo ${config_UserChoices_ExpType} | grep CMIP6 )" != "X" ] ; then
251        echo '<context id="nemo" src="./ping_nemo.xml"/>' >> add.tmp
252        echo '<context id="nemo" src="./dr2xml_opa9.xml"/>' >> add.tmp
253    fi
254    cp iodef.xml iodef.xml.tmp
255    sed -e "/COMPONENT CONTEXT/r add.tmp" \
256        iodef.xml.tmp > iodef.xml
257    rm iodef.xml.tmp add.tmp
258
259    #Long Name as global attribute (if LongName is not empty)
260    if [ ! "X${config_UserChoices_LongName}" = "X" ] ; then
261        listfile=$(ls file_def_nemo*.xml)
262        echo "<variable id=\"LongName\" type=\"string\">${config_UserChoices_LongName}</variable>" > add.tmp
263        for file in ${listfile}
264        do
265            cp ${file} ${file}.tmp
266            sed -e "/<file id/r add.tmp" \
267                ${file}.tmp > ${file}
268            rm ${file}.tmp
269        done
270        rm add.tmp
271    fi
272
273    IGCM_debug_PopStack "OCE_Update"
274}
275
276#-----------------------------------
277function OCE_Finalize
278{
279    IGCM_debug_PushStack "OCE_Finalize"
280
281    IGCM_debug_Print 1 FINALIZE OCE !!!
282
283    IGCM_debug_PopStack "OCE_Finalize"
284}
Note: See TracBrowser for help on using the repository browser.