UNST-9720 Review comments

Author: KoenBussemakerDeltares

src/engines_gpl/dflowfm/packages/dflowfm_kernel/src/dflowfm_data/unstruc_inifields.f90

@@ -674,7 +674,7 @@ subroutine readIniFieldProvider(inifilename, node_ptr, groupname, quantity, file
       operand = OPERAND_OVERRIDE ! default
       call prop_get(node_ptr, '', 'operand', operand_ini, retVal)
       if (retVal) then
-         call convert_operand_string_to_integer(operand_ini, operand)
+         operand = convert_operand_string_to_integer(operand_ini)
          if (operand == OPERAND_UNKNOWN) then
             write (msgbuf, '(5a)') 'Wrong block in file ''', trim(inifilename), ''': [', trim(groupname), '] for quantity=' &
             //trim(quantity)//'. Field ''operand'' has invalid value '''//trim(operand_ini)//'''. Ignoring this block.'

src/engines_gpl/dflowfm/packages/dflowfm_kernel/src/dflowfm_kernel/timespace/fm_external_forcings_init.f90

@@ -298,7 +298,7 @@ function init_boundary_forcings(block_ptr, base_dir, file_name, group_name, itpe
       operand = OPERAND_UNKNOWN
       call prop_get(block_ptr, '', 'operand ', property_value, is_successful)
       if (is_successful) then
-         call convert_operand_string_to_integer(property_value, operand)
+         operand = convert_operand_string_to_integer(property_value)
       end if
 
       num_items_in_block = 0
@@ -740,7 +740,7 @@ function init_meteo_forcings(block_ptr, base_dir, file_name, group_name) result(
       oper = OPERAND_OVERRIDE
       call prop_get(block_ptr, '', 'operand ', operand_ini, is_successful)
       if (is_successful) then
-         call convert_operand_string_to_integer(operand_ini, oper)
+         oper = convert_operand_string_to_integer(operand_ini)
          if (oper == OPERAND_UNKNOWN) then
             write (msgbuf, '(5a)') 'Error in block in file ''', file_name, ''': [', group_name, ']. Field ''operand'' has unknown value ''' // TRIM(operand_ini) // '''.'
             call err_flush()

src/engines_gpl/dflowfm/packages/dflowfm_kernel/src/dflowfm_kernel/timespace/meteo1.f90

@@ -320,7 +320,7 @@ subroutine readprovider(minp, qid, filename, filetype, method, operand, transfor
             l1 = index(rec, '=') + 1
             call checkForSpacesInProvider(rec, l1, l2) ! l2 = l1 + #spaces after the equal-sign
             read (rec(l2:l2), '(a1)', err=990) temp
-            call convert_operand_string_to_integer(temp, operand)
+            operand = convert_operand_string_to_integer(temp)
          end block
       else
          return

src/engines_gpl/dflowfm/packages/dflowfm_kernel/src/dflowfm_kernel/timespace/time_space_parameters.f90

@@ -94,18 +94,18 @@ module timespace_parameters
    integer, parameter :: WEIGHTFACTORS_EXTRAPOLATION = 103
 
    ! enumeration for interpolation methods of providers
-   integer, parameter :: OPERAND_UNKNOWN = -1
-   integer, parameter :: OPERAND_OVERRIDE = 0
-   integer, parameter :: OPERAND_OVERRIDE_IF_MISSING = 1
-   integer, parameter :: OPERAND_ADD = 2
-   integer, parameter :: OPERAND_MULTIPLY = 3
-   integer, parameter :: OPERAND_MINIMUM = 4
-   integer, parameter :: OPERAND_MAXIMUM = 5
+   integer, parameter :: OPERAND_UNKNOWN = -1 !< Unknown operand type.
+   integer, parameter :: OPERAND_OVERRIDE = 0 !< Override existing value with new value.
+   integer, parameter :: OPERAND_OVERRIDE_IF_MISSING = 1 !< Override existing value, but only if missing.
+   integer, parameter :: OPERAND_ADD = 2 !< Add new value to existing value.
+   integer, parameter :: OPERAND_MULTIPLY = 3 !< Multiply existing value by new value.
+   integer, parameter :: OPERAND_MINIMUM = 4 !< Take the minimum of existing and new value.
+   integer, parameter :: OPERAND_MAXIMUM = 5 !< Take the maximum of existing and new value.
 contains
 
-   subroutine convert_operand_string_to_integer(string, operand)
+   function convert_operand_string_to_integer(string) result(operand)
       character(len=*), intent(in) :: string !< file type string
-      integer, intent(out) :: operand !< operand enumeration integer
+      integer :: operand !< operand enumeration integer
 
       select case (trim(str_tolower(string)))
       case ('o')
@@ -126,7 +126,7 @@ subroutine convert_operand_string_to_integer(string, operand)
       case default
          operand = OPERAND_UNKNOWN
       end select
-   end subroutine convert_operand_string_to_integer
+   end function convert_operand_string_to_integer
 
 !> Converts fileType string to an integer.
 !! Returns -1 when an invalid type string is given.