source: CONFIG/UNIFORM/v6/LMDZOR_v6/GENERAL/DRIVER/orchidee.driver @ 3047

Last change on this file since 3047 was 3047, checked in by jgipsl, 5 years ago

Enhancement on the use of WriteFrequency? for sechiba component. This variable can now activate and set the frequency for 2 files. Following is now possible and will give sechiba_history.nc with monthly frequency and sechiba_out_2.nc with daily frequency : [SRF] WriteFrequency?="1M 1D"

Note: to change the frequency of the 2nd file, it is needed rev 3946 or later of ORCHIDEE/trunk. Otherwise the freq will be 10800s.

File size: 5.9 KB
Line 
1#!/bin/ksh
2## Driver for the component SRF corresponding to the sechiba part of ORCHIDEE
3#-----------------------------------------------------------------
4function SRF_Initialize
5{
6    IGCM_debug_PushStack "SRF_Initialize"
7
8    ##- Define variable DefSuffix set in orchidee.card
9    ##  This variable is used in orchidee.card to choose
10    ##  parameter file(orchidee.def_DefSuffix).
11    if [ ! X${orchidee_UserChoices_DefSuffix} = X ] ; then
12        DefSuffix=${orchidee_UserChoices_DefSuffix}
13    else
14        DefSuffix=Choi
15    fi
16
17    IGCM_debug_PopStack "SRF_Initialize"
18}
19
20#-----------------------------------------------------------------
21function SRF_Update
22{
23    IGCM_debug_PushStack "SRF_Update"
24
25    ## 1. Modifications in orchidee.def parameter file
26
27    # Activate STOMATE if the compontent SBG=stomate is set in config.card
28    if [ X${config_ListOfComponents_SBG} = Xstomate ] ; then
29        # Activate stomate in orchidee.def
30        IGCM_comp_modifyDefFile blocker orchidee.def STOMATE_OK_STOMATE y
31    else
32        # Deactivate stomate in orchidee.def
33        IGCM_comp_modifyDefFile blocker orchidee.def STOMATE_OK_STOMATE n
34        # Deactivate output files for stomate
35        IGCM_comp_modifyXmlFile nonblocker file_def_orchidee.xml stomate1 enabled .FALSE.
36        IGCM_comp_modifyXmlFile nonblocker file_def_orchidee.xml stomate1 output_freq 1mo
37        IGCM_comp_modifyXmlFile nonblocker file_def_orchidee.xml stomate2 enabled .FALSE.
38        IGCM_comp_modifyXmlFile nonblocker file_def_orchidee.xml stomate2 output_freq 1mo
39    fi
40
41    # Define in orchidee.def if restart file should be used
42    if ( [ ${CumulPeriod} -ne 1 ] || [ "${config_SRF_Restart}" != "n" ] ) ; then
43        IGCM_comp_modifyDefFile blocker orchidee.def SECHIBA_restart_in sechiba_rest_in.nc
44    else
45        IGCM_comp_modifyDefFile blocker orchidee.def SECHIBA_restart_in NONE
46    fi
47
48    # Modify in orchidee.def VEGET_UPDATE if it is set in orchidee.card section UserChoices
49    if [ ! X${orchidee_UserChoices_VEGET_UPDATE} = X ] ; then
50        IGCM_comp_modifyDefFile nonblocker orchidee.def VEGET_UPDATE   ${orchidee_UserChoices_VEGET_UPDATE}
51    else
52        IGCM_comp_modifyDefFile nonblocker orchidee.def VEGET_UPDATE 0Y
53    fi
54
55    # Activate creation of river description file only for the first period
56    if [ ${CumulPeriod} -eq 1 ] ; then
57        IGCM_comp_modifyDefFile nonblocker orchidee.def RIVER_DESC y
58    else
59        IGCM_comp_modifyDefFile nonblocker orchidee.def RIVER_DESC n
60    fi
61
62
63    ## 2. Mangement of output and modifications of related xml files
64
65    # Set default values for sechiba1_enabled and sechiba1_freq.
66    # These variables are used only to modify file_def_orchidee.xml
67    sechiba1_enabled=.FALSE.
68    sechiba2_enabled=.FALSE.
69    sechiba1_freq=0s
70    sechiba2_freq=0s
71
72
73    # Get WriteFrenquecy for SRF (SECHIBA) from config.card
74    # 1 or 2 frequencies can be set in WriteFrenquecy for SRF
75    # The first frequency will always be used for the sechiba_history file and the
76    # second frequency will be used for the sechiba_out_2.nc file.
77    # The files are activated only if its corresponding frequency is set in WriteFrequency
78    ifreq=0
79    for frequency in ${config_SRF_WriteFrequency} ; do
80        case ${frequency} in
81            *Y|*y) 
82                NbYears=$( echo ${frequency} | awk -F '[yY]' '{print $1}' )
83                NbDaysYear=$( IGCM_date_DaysInYear ${year} )
84                file_enabled=.TRUE.
85                file_freq=${NbYears}y ;;
86            *M|*m)
87                NbMonths=$( echo ${frequency} | awk -F '[mM]' '{print $1}' )
88                file_enabled=.TRUE.
89                file_freq=${NbMonths}mo ;;
90            *D|*d)
91                NbDays=$( echo ${frequency} | awk -F '[dD]' '{print $1}' )
92                file_enabled=.TRUE.
93                file_freq=${NbDays}d ;;
94            *s)
95                WriteInSeconds=$( echo ${frequency} | awk -F '[s]' '{print $1}' )
96                file_enabled=.TRUE.
97                file_freq=${WriteInSeconds}s ;;
98            HF|hf) 
99                file_enabled=.TRUE.
100                file_freq=10800s ;;
101            *) 
102                IGCM_debug_Exit "SRF_Update " ${frequency} " invalid WriteFrequency : choose in xY, xM, xD, xs and HF" 
103                IGCM_debug_Verif_Exit ;;
104        esac
105
106        (( ifreq = ifreq + 1 ))
107        case ${ifreq} in
108            1)
109                sechiba1_enabled=${file_enabled}
110                sechiba1_freq=${file_freq} ;;
111            2)
112                sechiba2_enabled=${file_enabled}
113                sechiba2_freq=${file_freq} ;;
114        *)
115                IGCM_debug_Exit "SRF_Update: It is not possible to set more than 2 output files for sechiba from config.card"
116                IGCM_debug_Exit "You must correct WriteFrequancy in SRF secion in config.card."
117                IGCM_debug_Exit "Adapt file_def_orchidee.xml directly if you want more output files"
118                IGCM_debug_Verif_Exit ;;
119        esac
120    done
121
122
123    # Modify file_def_orchidee.xml file
124    IGCM_comp_modifyXmlFile nonblocker file_def_orchidee.xml sechiba1 enabled ${sechiba1_enabled}
125    IGCM_comp_modifyXmlFile nonblocker file_def_orchidee.xml sechiba1 output_freq ${sechiba1_freq}
126    IGCM_comp_modifyXmlFile nonblocker file_def_orchidee.xml sechiba2 enabled ${sechiba2_enabled}
127    IGCM_comp_modifyXmlFile nonblocker file_def_orchidee.xml sechiba2 output_freq ${sechiba2_freq}
128   
129
130    # Add include of orchidee context in iodef.xml
131    # In iodef.xml add on next line after "COMPONENT CONTEXT"
132    #  <context id="orchidee" src="./context_orchidee.xml"/>
133    echo '<context id="orchidee" src="./context_orchidee.xml"/>' > add.tmp
134    cp iodef.xml iodef.xml.tmp
135    sed -e "/COMPONENT CONTEXT/r add.tmp" iodef.xml.tmp > iodef.xml
136    rm iodef.xml.tmp add.tmp
137
138    # Add LongName as global attribute in XIOS output files (if LongName is not empty)
139    if [ ! "X${config_UserChoices_LongName}" = "X" ] ; then
140        listfile=$(ls file_def*orchidee.xml)
141        echo "<variable id=\"LongName\" type=\"string\">${config_UserChoices_LongName}</variable>" > add.tmp
142        for file in ${listfile}
143        do
144            cp ${file} ${file}.tmp
145            sed -e "/<file id/r add.tmp" \
146                ${file}.tmp > ${file}
147            rm ${file}.tmp
148        done
149        rm add.tmp
150    fi
151
152
153    IGCM_debug_PopStack "SRF_Update"
154}
155
156#-----------------------------------------------------------------
157function SRF_Finalize
158{
159    IGCM_debug_PushStack "SRF_Finalize"
160
161    IGCM_debug_PopStack "SRF_Finalize"
162}
Note: See TracBrowser for help on using the repository browser.