source: CONFIG/UNIFORM/v7/IPSLCM7/GENERAL/DRIVER/orchidee.driver @ 6667

#!/bin/ksh
## Driver for the component SRF corresponding to the sechiba part of ORCHIDEE
#-----------------------------------------------------------------
function SRF_Initialize
{
    IGCM_debug_PushStack "SRF_Initialize"

    ##- Define variable DefSuffix set in orchidee.card
    ##  This variable is used in orchidee.card to choose
    ##  parameter file(orchidee.def_DefSuffix).
    if [ ! X${orchidee_UserChoices_DefSuffix} = X ] ; then
        DefSuffix=${orchidee_UserChoices_DefSuffix}
    else
        DefSuffix=15pft.1ac
    fi

    # Define the resolution only if the composant ICO for DYNAMICO is set in config.card
    if [ ! X${config_ListOfComponents_ICO} = X ] ; then
        RESOL_SRF="nbp${RESOL_NBP}"
    fi


    IGCM_debug_PopStack "SRF_Initialize"
}

#-----------------------------------------------------------------
function SRF_Update
{
    IGCM_debug_PushStack "SRF_Update"

    ## 1. Modifications in orchidee.def parameter file

    # Activate STOMATE if the compontent SBG=stomate is set in config.card
    if [ X${config_ListOfComponents_SBG} = Xstomate ] ; then
        # Activate stomate in orchidee.def
        IGCM_comp_modifyDefFile blocker orchidee.def STOMATE_OK_STOMATE y
    else
        # Deactivate stomate in orchidee.def
        IGCM_comp_modifyDefFile blocker orchidee.def STOMATE_OK_STOMATE n
        # Deactivate output files for stomate
        IGCM_comp_modifyXmlFile nonblocker file_def_orchidee.xml stomate1 enabled .FALSE.
        IGCM_comp_modifyXmlFile nonblocker file_def_orchidee.xml stomate1 output_level 0
        IGCM_comp_modifyXmlFile nonblocker file_def_orchidee.xml stomate1 output_freq 1mo
        IGCM_comp_modifyXmlFile nonblocker file_def_orchidee.xml stomate2 enabled .FALSE.
        IGCM_comp_modifyXmlFile nonblocker file_def_orchidee.xml stomate2 output_level 0
        IGCM_comp_modifyXmlFile nonblocker file_def_orchidee.xml stomate2 output_freq 1mo
        IGCM_comp_modifyXmlFile nonblocker file_def_orchidee.xml stomate3 enabled .FALSE.
        IGCM_comp_modifyXmlFile nonblocker file_def_orchidee.xml stomate3 output_level 0
        IGCM_comp_modifyXmlFile nonblocker file_def_orchidee.xml stomate3 output_freq 1mo
        IGCM_comp_modifyXmlFile nonblocker file_def_orchidee.xml stomate4 enabled .FALSE.
        IGCM_comp_modifyXmlFile nonblocker file_def_orchidee.xml stomate4 output_level 0
        IGCM_comp_modifyXmlFile nonblocker file_def_orchidee.xml stomate4 output_freq 1mo
    fi

    # Define in orchidee.def if restart file should be used
    if ( [ ${CumulPeriod} -ne 1 ] || [ "${config_SRF_Restart}" != "n" ] ) ; then
        IGCM_comp_modifyDefFile blocker orchidee.def SECHIBA_restart_in sechiba_rest_in.nc
    else
        IGCM_comp_modifyDefFile blocker orchidee.def SECHIBA_restart_in NONE
    fi

    # Set VEGET_UPDATE=1Y in orchidee.def if VEGET_UPDATE_at_start=y in orchidee.card and if it is the first cumul periond (start of new simulation)
    if [ X${orchidee_UserChoices_VEGET_UPDATE_at_start} = Xy ] && [ ${CumulPeriod} -eq 1 ] ; then
        IGCM_comp_modifyDefFile nonblocker orchidee.def VEGET_UPDATE   1Y
    fi

    # Modify in orchidee.def VEGET_UPDATE if it is set in orchidee.card section UserChoices
    # Note: if the variable has been set by VEGET_UPDATE_at_start, this section will not overwrite it.
    if [ ! X${orchidee_UserChoices_VEGET_UPDATE} = X ] ; then
        IGCM_comp_modifyDefFile nonblocker orchidee.def VEGET_UPDATE   ${orchidee_UserChoices_VEGET_UPDATE}
    else
        IGCM_comp_modifyDefFile nonblocker orchidee.def VEGET_UPDATE 0Y
    fi


    # Set parameters related to ROUTING in orchidee.def
    if [ X${orchidee_UserChoices_ROUTING} = X ] || [ X${orchidee_UserChoices_ROUTING} = Xstandard ]; then
        # Nothing is set or ROUTING=standard in orchidee.def, default option
        IGCM_comp_modifyDefFile nonblocker orchidee.def RIVER_ROUTING y
        IGCM_comp_modifyDefFile nonblocker orchidee.def ROUTING_METHOD  standard
    elif [ X${orchidee_UserChoices_ROUTING} = Xsimple ]; then
        # ROUTING=simple is set in orchidee.card
        IGCM_comp_modifyDefFile nonblocker orchidee.def RIVER_ROUTING y
        IGCM_comp_modifyDefFile nonblocker orchidee.def ROUTING_METHOD  simple
    elif [ X${orchidee_UserChoices_ROUTING} = Xhighres ]; then
        # ROUTING=highres is set in orchidee.card
        IGCM_comp_modifyDefFile nonblocker orchidee.def RIVER_ROUTING y
        IGCM_comp_modifyDefFile nonblocker orchidee.def ROUTING_METHOD  highres
    else
        # ROUTING=off, routing will be deactivated
        IGCM_comp_modifyDefFile nonblocker orchidee.def RIVER_ROUTING n
        IGCM_comp_modifyDefFile nonblocker orchidee.def ROUTING_METHOD  standard
    fi

    if [ X${orchidee_UserChoices_AtmCo2} != X ] ; then
       ##-- CO2 forcing : update CO2 value in orchidee.def with the value defined in orchidee.card
       ATM_CO2=${orchidee_UserChoices_AtmCo2}
       echo '(ORCHIDEE) FORCE_CO2_VEG = y'
       echo '(ORCHIDEE) ATM_CO2='${ATM_CO2}
       IGCM_comp_modifyDefFile nonblocker orchidee.def FORCE_CO2_VEG y
       IGCM_comp_modifyDefFile nonblocker orchidee.def ATM_CO2 ${ATM_CO2}
    else
       IGCM_comp_modifyDefFile nonblocker orchidee.def FORCE_CO2_VEG DEFAULT
       IGCM_comp_modifyDefFile nonblocker orchidee.def ATM_CO2 DEFAULT
    fi

    # Set DO_WOOD_HARVEST in orchidee.def acording to value set in orchidee.card section UserChoices
    # If DO_WOOD_HARVEST is not definded in orchidee.card, set default value y
    if [ ! X${orchidee_UserChoices_DO_WOOD_HARVEST} = X ] ; then
       IGCM_comp_modifyDefFile nonblocker orchidee.def DO_WOOD_HARVEST   ${orchidee_UserChoices_DO_WOOD_HARVEST}
    else
       IGCM_comp_modifyDefFile nonblocker orchidee.def DO_WOOD_HARVEST   DEFAULT
    fi

    # Set LAI_MAP in orchidee.def acording to value set in orchidee.card section UserChoices
    # If LAI_MAP is not definded in orchidee.card, set default value n
    # Note: this option is only read by ORCHIDEE if starting without restart files
    if [ ! X${orchidee_UserChoices_LAI_MAP} = X ] ; then
        IGCM_comp_modifyDefFile nonblocker orchidee.def LAI_MAP   ${orchidee_UserChoices_LAI_MAP}
    else
        IGCM_comp_modifyDefFile nonblocker orchidee.def LAI_MAP   DEFAULT
    fi


    # Activate creation of river description file only for the first period
    if [ ${CumulPeriod} -eq 1 ] ; then
        IGCM_comp_modifyDefFile nonblocker orchidee.def RIVER_DESC y
    else
        IGCM_comp_modifyDefFile nonblocker orchidee.def RIVER_DESC n
    fi

    # Activate calcul of chemistry BVOC
    if [ ! X${orchidee_UserChoices_CHEMISTRY_BVOC} = X ] ; then
        IGCM_comp_modifyDefFile nonblocker orchidee.def CHEMISTRY_BVOC ${orchidee_UserChoices_CHEMISTRY_BVOC}
    else
        IGCM_comp_modifyDefFile nonblocker orchidee.def CHEMISTRY_BVOC n
    fi

    ## 2. Mangement of output and modifications of related xml files
    # Modify file_def_orchidee.xml file using settings from orchidee.card
    # We here suppose that for each file, in orchidee.card UserChoices section, if the parameter 
    # output_level_filename is set, then also output_freq_filename must be set. The existance of output_freq_filename will not be checked. 
    # If output_level_filename=NONE or if it is not set, the corresponding file will be deactivated.
    # Settings in config.card WriteFrequency are not used any more.
    
    if [ X${orchidee_UserChoices_output_level_sechiba_history} = X ] || [ X${orchidee_UserChoices_output_level_sechiba_history} = XNONE ] ; then
        # output_level_sechiba_history is not set in orchidee.card or it is set to NONE.
        # Deactivate the file.
        IGCM_comp_modifyXmlFile nonblocker file_def_orchidee.xml sechiba1 enabled .FALSE.
        IGCM_comp_modifyXmlFile nonblocker file_def_orchidee.xml sechiba1 output_level 0
        IGCM_comp_modifyXmlFile nonblocker file_def_orchidee.xml sechiba1 output_freq 1mo
    else
        IGCM_comp_modifyXmlFile nonblocker file_def_orchidee.xml sechiba1 enabled      .TRUE.
        IGCM_comp_modifyXmlFile nonblocker file_def_orchidee.xml sechiba1 output_level ${orchidee_UserChoices_output_level_sechiba_history}
        IGCM_comp_modifyXmlFile nonblocker file_def_orchidee.xml sechiba1 output_freq  ${orchidee_UserChoices_output_freq_sechiba_history}
        if [ ! "X${config_ListOfComponents_ICO}" = "X" ] ; then   
           IGCM_comp_modifyXmlFile force      file_def_orchidee.xml groupremap_sechiba1 group_ref remap_${orchidee_UserChoices_output_freq_sechiba_history}
        fi
    fi
    
    if [ X${orchidee_UserChoices_output_level_sechiba_out_2} = X ] || [ X${orchidee_UserChoices_output_level_sechiba_out_2} = XNONE ] ; then
        # output_level_sechiba_out_2 is not set in orchidee.card or it is set to NONE.
        # Deactivate the file.
        IGCM_comp_modifyXmlFile nonblocker file_def_orchidee.xml sechiba2 enabled .FALSE.
        IGCM_comp_modifyXmlFile nonblocker file_def_orchidee.xml sechiba2 output_level 0
        IGCM_comp_modifyXmlFile nonblocker file_def_orchidee.xml sechiba2 output_freq 1mo
    else
        IGCM_comp_modifyXmlFile nonblocker file_def_orchidee.xml sechiba2 enabled      .TRUE.
        IGCM_comp_modifyXmlFile nonblocker file_def_orchidee.xml sechiba2 output_level ${orchidee_UserChoices_output_level_sechiba_out_2}
        IGCM_comp_modifyXmlFile nonblocker file_def_orchidee.xml sechiba2 output_freq  ${orchidee_UserChoices_output_freq_sechiba_out_2}
        if [ ! "X${config_ListOfComponents_ICO}" = "X" ] ; then   
           IGCM_comp_modifyXmlFile force      file_def_orchidee.xml groupremap_sechiba2 group_ref remap_${orchidee_UserChoices_output_freq_sechiba_out_2}               
        fi
    fi
    
    if [ X${orchidee_UserChoices_output_level_sechiba_history_4dim} = X ] || [ X${orchidee_UserChoices_output_level_sechiba_history_4dim} = XNONE ] ; then
        # output_level_sechiba_history_4dim is not set in orchidee.card or it is set to NONE.
        # Deactivate the file.
        IGCM_comp_modifyXmlFile nonblocker file_def_orchidee.xml sechiba3 enabled .FALSE.
        IGCM_comp_modifyXmlFile nonblocker file_def_orchidee.xml sechiba3 output_level 0
        IGCM_comp_modifyXmlFile nonblocker file_def_orchidee.xml sechiba3 output_freq 1mo
    else
        IGCM_comp_modifyXmlFile nonblocker file_def_orchidee.xml sechiba3 enabled      .TRUE.
        IGCM_comp_modifyXmlFile nonblocker file_def_orchidee.xml sechiba3 output_level ${orchidee_UserChoices_output_level_sechiba_history_4dim}
        IGCM_comp_modifyXmlFile nonblocker file_def_orchidee.xml sechiba3 output_freq  ${orchidee_UserChoices_output_freq_sechiba_history_4dim}
        if [ ! "X${config_ListOfComponents_ICO}" = "X" ] ; then   
           IGCM_comp_modifyXmlFile force      file_def_orchidee.xml groupremap_sechiba3 group_ref remap_${orchidee_UserChoices_output_freq_sechiba_history_4dim}                
        fi
    fi
        
    if [ ! "X${config_ListOfComponents_ICO}" = "X" ] ; then   
       # Desactivate orchidee variables which are not correct in ICOLMDZOR configuration
       IGCM_comp_modifyXmlFile force field_def_orchidee.xml RESOLUTION_X enabled .FALSE.
       IGCM_comp_modifyXmlFile force field_def_orchidee.xml RESOLUTION_Y enabled .FALSE.
       IGCM_comp_modifyXmlFile force field_def_orchidee.xml CONTFRAC_STOMATE enabled .FALSE.
    fi


    # Add include of orchidee context in iodef.xml
    # In iodef.xml add on the next line after "COMPONENT CONTEXT"
    echo '<context id="orchidee" src="./context_orchidee.xml"/>' > add.tmp
    # Add inclusion of file context_input_orchidee.xml if this file exists
    if [ -f context_input_orchidee.xml ] ; then
        echo '<context id="orchidee" src="./context_input_orchidee.xml"/>' >> add.tmp
    fi

    # Add inclusion of file context_routing_orchidee.xml if this file exists
    if [ -f context_routing_orchidee.xml ] ; then
        echo '<context id="orchidee" src="./context_routing_orchidee.xml"/>' >> add.tmp
    fi

    # Include xml files for output configuration if running with workflow CMIP6
    if ( [ X"$( echo ${config_UserChoices_ExpType} | grep CMIP6 )" != "X" ] || [ X${config_Post_dr2xmlIPSL} = XTRUE ] ) ; then
          echo '<context id="orchidee" src="./ping_orchidee.xml"/>' >> add.tmp
          echo '<context id="orchidee" src="./dr2xml_orchidee.xml"/>' >> add.tmp
    fi
    cp iodef.xml iodef.xml.tmp
    sed -e "/COMPONENT CONTEXT/r add.tmp" iodef.xml.tmp > iodef.xml
    rm iodef.xml.tmp add.tmp

    # Add LongName as global attribute in XIOS output files (if LongName is not empty)
    if [ ! "X${config_UserChoices_LongName}" = "X" ] ; then
        listfile=$(ls file_def*orchidee.xml)
        echo "<variable id=\"LongName\" type=\"string\">${config_UserChoices_LongName}</variable>" > add.tmp
        for file in ${listfile}
        do
            cp ${file} ${file}.tmp
            sed -e "/<file id/r add.tmp" \
                ${file}.tmp > ${file}
            rm ${file}.tmp 
        done 
        rm add.tmp
    fi


    # Compression level (if CompressionLevel is not empty)
    if [ ! "X${config_UserChoices_CompressionLevel}" = "X" ] ; then
        echo "NetCDF output files compression level is " ${config_UserChoices_CompressionLevel}
        listfile=$(ls file_def*orchidee.xml)
        for file in ${listfile} ; do
            sed -i -e "s/\(compression_level=\"\)[^\"]*\(\"\)/\1${config_UserChoices_CompressionLevel}\2/" ${file}
        done
    fi


    # Set interpolated output grid depending on resoultion, only if ICO component is set in config.card
    if [ ! "X${config_ListOfComponents_ICO}" = "X" ] ; then   
        if [ ${RESOL_NBP} == 40  ] ; then
            valuei=144
            valuej=143
        elif [ ${RESOL_NBP} == 80  ] ; then
            valuei=360
            valuej=180
        elif [ ${RESOL_NBP} == 160  ] ; then
            valuei=720
            valuej=360
        elif [ ${RESOL_NBP} == 320  ] ; then
            valuei=1440
            valuej=720
        else
            IGCM_debug_Exit "RESOL_NBP=${RESOL_NBP} is not yet implemented in drivers"
            IGCM_debug_Verif_Exit
        fi
        
        IGCM_debug_Print 1 "Modify output grid parameters for current resolution in context_orchidee.xml"
        cp context_orchidee.xml context_orchidee.xml.init
        sed -e "s/ni_glo.*=.*\"144\"/ni_glo=\"${valuei}\"/" \
            -e "s/nj_glo.*=.*\"143\"/nj_glo=\"${valuej}\"/" \
            context_orchidee.xml.init > context_orchidee.xml
        
    fi

    # Set the appropriate monitoring file depending on grid and resolution if ICO component
    if [ ${CumulPeriod} -eq 1 ] ; then
       if [ ! X${config_ListOfComponents_ICO} = X ] ; then
          IGCM_sys_Cp ${SUBMIT_DIR}/POST/monitoring01_orchidee_${ResolAtm}.cfg  ${SUBMIT_DIR}/POST/monitoring01_orchidee.cfg
       else
          IGCM_sys_Cp ${SUBMIT_DIR}/POST/monitoring01_orchidee_REG.cfg  ${SUBMIT_DIR}/POST/monitoring01_orchidee.cfg
       fi
    fi

    IGCM_debug_PopStack "SRF_Update"
}

#-----------------------------------------------------------------
function SRF_Finalize
{
    IGCM_debug_PushStack "SRF_Finalize"

    IGCM_debug_PopStack "SRF_Finalize"
}