Changeset 1085

Timestamp:

10/10/14 15:26:31 (10 years ago)

Author:

jgipsl

Message:

Added function IGCM_comp_modifyNamelist
See #222

File:

• trunk/libIGCM/libIGCM_comp/libIGCM_comp.ksh (modified) (1 diff)

trunk/libIGCM/libIGCM_comp/libIGCM_comp.ksh

@@ -1076 +1076 @@
 }
 
+
+#=======================================================================
+function IGCM_comp_modifyNamelist
+{
+#
+# syntax:     IGCM_comp_modifyNamelist  type  filein  key  [value]
+#
+# For example : IGCM_comp_modifyNamelist blocker run.def day_step 1200
+#
+# This function is used to modify a parameter file for a specific variable.
+# The file must be a ".def" file, i.e. with IOIPSL parameter file syntax.
+# This function can be used in the comp.driver files for the components.
+#
+# Arguments:
+# - type   : first argument must be blocker, nonblocker or force
+#            For "blocker" case, the variable must be attributed the keyworld AUTO
+#            otherwise this function will exit.
+#            For "nonblocker" case, the user can remove or modify the variable. For
+#            this case, as long as AUTO is not set, no modification will be done.
+#            For "force" case, the variable will be modified even if it is not set to AUTO
+# - filein : the file in run directory of .def type in which the variable should be set
+# - key    : the variable to modify
+# - value  : the value to set the key equal to, optional. If value is not set or if
+#            value=DEFAULT, then a default value must be given in filein using syntax :
+#            key= AUTO : DEFAULT=def_value
+#
+  IGCM_debug_PushStack "IGCM_comp_modifyNamelist"
+
+  # Set local variables and test the arguments
+  if [ $# = 4 ] ; then
+    # Normal case with 4 arguments
+    type=$1 ; filein=$2 ; key=$3 ; value=$4
+  elif [ $# = 3 ] ; then
+    # Normal case with 3 arguments
+    type=$1 ; filein=$2 ;       key=$3; value="DEFAULT"
+  else
+    IGCM_debug_Exit "IGCM_comp_modifyNamelist: Bad number of arguments."
+    IGCM_debug_PopStack "IGCM_comp_modifyNamelist"
+    return
+  fi
+  IGCM_debug_Print 1 "Entering IGCM_comp_modifyNamelist with arguments: $type $filein $key $value"
+
+
+  # Test if first argument is correct
+  if [ $type != blocker ] && [ $type != nonblocker ] && [ $type != force ] ; then
+    IGCM_debug_Exit "IGCM_comp_modifyNamelist: Error in first argument must be blocker, nonblocker or force"
+    IGCM_debug_PopStack "IGCM_comp_modifyNamelist"
+    return
+  fi
+
+  # Test if the file exist
+  if [ ! -f ${filein} ] ; then
+    IGCM_debug_Exit "IGCM_comp_modifyNamelist: $filein does not exist."
+    IGCM_debug_PopStack "IGCM_comp_modifyNamelist"
+    return
+  fi
+
+  # Read the line with key in the file without the comments
+  pattern=$( grep "^ *$key *=" $filein | sed -e "s% *\!.*%%" )
+  
+  # Verify the existance of the pattern
+  if [ X"$pattern" = X ] ; then
+      # Variable key is not set in filein, stop.
+      IGCM_debug_Exit "IGCM_comp_modifyNamelist : Variable $key is not set in correct file. It should be set in $filein."
+      IGCM_debug_PopStack "IGCM_comp_modifyNamelist"
+      return
+  fi
+  
+  # Check if the variable is set to AUTO in the filein
+  if [ $( echo $pattern | grep AUTO | wc -l ) = 1 ] ; then
+      # Modification will be done for all cases
+      modify=yes
+  else
+      # The variable was not set to AUTO
+      if [ $type = blocker ] ; then
+          # Exit because this is a blocker call
+          IGCM_debug_Exit "IGCM_comp_modifyNamelist : The variable $key cannot be modified. It should be set to AUTO."
+          IGCM_debug_PopStack "IGCM_comp_modifyNamelist"
+          return
+       elif [ $type = nonblocker ] ; then
+          # Do nothing. Suppose that the user did set the variable correct
+          IGCM_debug_Print 1 "IGCM_comp_modifyNamelist: $key is set by the user. Nothing done."
+          modify=no
+       elif [ $type = force ] ; then
+          # Force modification
+          IGCM_debug_Print 1 "IGCM_comp_modifyNamelist : Variabl=$key was not set to AUTO. Modification will be forced."
+          modify=yes
+      fi
+  fi
+
+  # Do the modifcation now
+  if [ $modify = yes ] ; then
+
+      # For option DEFAULT, read default value from file.
+      if [ X"$value" = XDEFAULT ] || [ X"$value" = X ] ; then
+        # Case to set DEFAULT value
+        # Read default value from filein
+        value=$( echo $pattern | awk  -F"DEFAULT *=" '{print $2}')
+
+        if [ X"$value" = X ] ; then
+          IGCM_debug_Exit "IGCM_comp_modifyNamelist : The variable $key needs a DEFAULT value in $filein."
+          IGCM_debug_Print 1 "IGCM_comp_modifyNamelist: The syntax in $filein should be:"
+          IGCM_debug_Print 1 "IGCM_comp_modifyNamelist: $key=_AUTO_:DEFAULT=def_value"
+          IGCM_debug_PopStack "IGCM_comp_modifyNamelist"
+          return
+        fi
+      fi
+
+      # Now change key in filein
+      sed -e "s/${pattern}/       $key=${value}/" $filein > $filein.tmp
+      IGCM_debug_Print 1 "IGCM_comp_modifyNamelist: In $filein set $key=$value"
+      \mv $filein.tmp $filein
+  fi
+  IGCM_debug_PopStack "IGCM_comp_modifyNamelist"
+}
+
 #=======================================================================
 function IGCM_comp_modifyXmlFile