Changeset 3700 for palm/trunk/SOURCE/user_module.f90

Timestamp:

Jan 26, 2019 5:03:42 PM (5 years ago)

Author:

knoop

Message:

Moved user_define_netdf_grid into user_module.f90
Added module interface for the definition of additional timeseries

File:

• palm/trunk/SOURCE/user_module.f90 (modified) (15 diffs)

palm/trunk/SOURCE/user_module.f90

@@ -86 +86 @@
     USE statistics
 
-    USE statistics,                                                            &
-        ONLY:  statistic_regions, region
-
     USE surface_mod
 
@@ -94 +91 @@
 
     INTEGER(iwp) ::  dots_num_palm   !< 
+    INTEGER(iwp) ::  dots_num_user = 0  !< 
     INTEGER(iwp) ::  user_idummy     !< 
     
@@ -117 +115 @@
        user_parin, &
        user_check_parameters, &
+       user_check_data_output_ts, &
        user_check_data_output_pr, &
        user_check_data_output, &
@@ -143 +142 @@
        MODULE PROCEDURE user_check_parameters
     END INTERFACE user_check_parameters
+
+    INTERFACE user_check_data_output_ts
+       MODULE PROCEDURE user_check_data_output_ts
+    END INTERFACE user_check_data_output_ts
 
     INTERFACE user_check_data_output_pr
@@ -322 +325 @@
 ! Description:
 ! ------------
+!> Set module-specific timeseries units and labels
+!------------------------------------------------------------------------------!
+ SUBROUTINE user_check_data_output_ts( dots_max, dots_num, dots_label, dots_unit )
+
+
+   INTEGER(iwp),      INTENT(IN)     ::  dots_max
+   INTEGER(iwp),      INTENT(INOUT)  ::  dots_num
+   CHARACTER (LEN=*), DIMENSION(dots_max), INTENT(INOUT)  :: dots_label
+   CHARACTER (LEN=*), DIMENSION(dots_max), INTENT(INOUT)  :: dots_unit
+
+
+!-- Sample for user-defined time series
+!-- For each time series quantity you have to give a label and a unit,
+!-- which will be used for the NetCDF file. They must not contain more than
+!-- seven characters. The value of dots_num has to be increased by the
+!-- number of new time series quantities. Its old value has to be store in
+!-- dots_num_palm. See routine user_statistics on how to output calculate
+!-- and output these quantities.
+
+!    dots_num_palm = dots_num
+
+!    dots_num = dots_num + 1
+!    dots_num_user = dots_num_user + 1
+!    dots_label(dots_num) = 'abs_umx'
+!    dots_unit(dots_num)  = 'm/s'
+
+!    dots_num = dots_num + 1
+!    dots_num_user = dots_num_user + 1
+!    dots_label(dots_num) = 'abs_vmx'
+!    dots_unit(dots_num)  = 'm/s'
+
+
+ END SUBROUTINE user_check_data_output_ts
+
+
+!------------------------------------------------------------------------------!
+! Description:
+! ------------
 !> Set the unit of user defined profile output quantities. For those variables
 !> not recognized by the user, the parameter unit is set to "illegal", which
@@ -327 +368 @@
 !> to a program abort.
 !------------------------------------------------------------------------------!
- SUBROUTINE user_check_data_output_pr( variable, var_count, unit )
-
-
-    USE netcdf_interface,                                                      &
-        ONLY:  dopr_unit
+ SUBROUTINE user_check_data_output_pr( variable, var_count, unit, dopr_unit )
+
 
     USE profil_parameter
@@ -338 +376 @@
     CHARACTER (LEN=*) ::  unit     !< 
     CHARACTER (LEN=*) ::  variable !< 
+    CHARACTER (LEN=*) ::  dopr_unit !< local value of dopr_unit
 
     INTEGER(iwp) ::  user_pr_index !< 
@@ -357 +396 @@
 !          user_pr_index = pr_palm + 1
 !          dopr_index(var_count)  = user_pr_index    ! quantities' user-profile-number
-!          dopr_unit(var_count)   = 'm2/s2'  ! quantity unit
+!          dopr_unit = 'm2/s2'  ! quantity unit
+!          unit = dopr_unit
 !          hom(:,2,user_pr_index,:)       = SPREAD( zu, 2, statistic_regions+1 )
 !                                            ! grid on which the quantity is
@@ -413 +453 @@
 
 
-    USE netcdf_interface,                                                      &
-        ONLY: dots_label, dots_unit, dots_num
-
-
     CHARACTER (LEN=20) :: field_char   !< 
 !
@@ -424 +460 @@
 !    ALLOCATE( ustvst(nzb:nzt+1,nysg:nyng,nxlg:nxrg) );  ustvst = 0.0_wp
 
-!-- Sample for user-defined time series
-!-- For each time series quantity you have to give a label and a unit,
-!-- which will be used for the NetCDF file. They must not contain more than
-!-- seven characters. The value of dots_num has to be increased by the
-!-- number of new time series quantities. Its old value has to be store in
-!-- dots_num_palm. See routine user_statistics on how to output calculate
-!-- and output these quantities.
-!    dots_label(dots_num+1) = 'abs_umx'
-!    dots_unit(dots_num+1)  = 'm/s'
-!    dots_label(dots_num+2) = 'abs_vmx'
-!    dots_unit(dots_num+2)  = 'm/s'
-!
-!    dots_num_palm = dots_num
-!    dots_num = dots_num + 2
 
  END SUBROUTINE user_init
+
+
+!------------------------------------------------------------------------------!
+! Description:
+! ------------
+!> Set the grids on which user-defined output quantities are defined.
+!> Allowed values for grid_x are "x" and "xu", for grid_y "y" and "yv", and
+!> for grid_z "zu" and "zw".
+!------------------------------------------------------------------------------!
+ SUBROUTINE user_define_netcdf_grid( variable, found, grid_x, grid_y, grid_z )
+
+
+    CHARACTER (LEN=*) ::  grid_x     !<
+    CHARACTER (LEN=*) ::  grid_y     !<
+    CHARACTER (LEN=*) ::  grid_z     !<
+    CHARACTER (LEN=*) ::  variable   !<
+
+    LOGICAL ::  found   !<
+
+
+    SELECT CASE ( TRIM( variable ) )
+
+!
+!--    Uncomment and extend the following lines, if necessary
+!       CASE ( 'u2', 'u2_xy', 'u2_xz', 'u2_yz' )
+!          found  = .TRUE.
+!          grid_x = 'xu'
+!          grid_y = 'y'
+!          grid_z = 'zu'
+
+!       CASE ( 'u*v*', 'u*v*_xy', 'u*v*_xz', 'u*v*_yz' )
+!          found  = .TRUE.
+!          grid_x = 'x'
+!          grid_y = 'y'
+!          grid_z = 'zu'
+
+       CASE DEFAULT
+          found  = .FALSE.
+          grid_x = 'none'
+          grid_y = 'none'
+          grid_z = 'none'
+
+    END SELECT
+
+
+ END SUBROUTINE user_define_netcdf_grid
+
+
 
 
@@ -913 +983 @@
 
 
-    USE netcdf_interface,                                                      &
-        ONLY:  dots_max
-
-
     CHARACTER (LEN=*) ::  mode   !< 
-
     INTEGER(iwp) ::  i    !< 
     INTEGER(iwp) ::  j    !< 
@@ -925 +990 @@
     INTEGER(iwp) ::  tn   !< 
 
-    REAL(wp),                                                                  &
-       DIMENSION(dots_num_palm+1:dots_max) ::                                  &
-          ts_value_l   !< 
-
+    REAL(wp), DIMENSION(:), ALLOCATABLE ::  ts_value_l   !<
 
     IF ( mode == 'profiles' )  THEN
@@ -962 +1024 @@
     ELSEIF ( mode == 'time_series' )  THEN
 
+
+!       ALLOCATE ( ts_value_l(dots_num_user) )
 !
 !--    Sample on how to add values for the user-defined time series quantities.
@@ -968 +1032 @@
 !--    velocities u and v.
 !       ts_value_l = 0.0_wp
-!       ts_value_l(dots_num_palm+1) = ABS( u_max )
-!       ts_value_l(dots_num_palm+2) = ABS( v_max )
+!       ts_value_l(1) = ABS( u_max )
+!       ts_value_l(2) = ABS( v_max )
 !
 !--     Collect / send values to PE0, because only PE0 outputs the time series.
@@ -981 +1045 @@
 !#if defined( __parallel )
 !       IF ( collective_wait )  CALL MPI_BARRIER( comm2d, ierr )
-!       CALL MPI_ALLREDUCE( ts_value_l(dots_num_palm+1),                         &
+!       CALL MPI_ALLREDUCE( ts_value_l(1),                         &
 !                           ts_value(dots_num_palm+1,sr),                        &
-!                           dots_max-dots_num_palm, MPI_REAL, MPI_SUM, comm2d,   &
+!                           dots_num_user, MPI_REAL, MPI_MAX, comm2d,   &
 !                           ierr )
 !#else
-!       ts_value(dots_num_palm+1:,sr) = ts_value_l
+!       ts_value(dots_num_palm+1:dots_num_palm+dots_num_user,sr) = ts_value_l
 !#endif