!> @file user_data_output_mask.f90 !------------------------------------------------------------------------------! ! This file is part of the PALM model system. ! ! PALM is free software: you can redistribute it and/or modify it under the ! terms of the GNU General Public License as published by the Free Software ! Foundation, either version 3 of the License, or (at your option) any later ! version. ! ! PALM is distributed in the hope that it will be useful, but WITHOUT ANY ! WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR ! A PARTICULAR PURPOSE. See the GNU General Public License for more details. ! ! You should have received a copy of the GNU General Public License along with ! PALM. If not, see . ! ! Copyright 1997-2019 Leibniz Universitaet Hannover !------------------------------------------------------------------------------! ! ! Current revisions: ! ------------------ ! ! ! Former revisions: ! ----------------- ! $Id: user_data_output_mask.f90 4069 2019-07-01 14:05:51Z forkel $ ! Masked output running index mid has been introduced as a local variable to ! avoid runtime error (Loop variable has been modified) in time_integration ! ! 3768 2019-02-27 14:35:58Z raasch ! variables commented + statement added to avoid compiler warnings about unused variables ! ! 3655 2019-01-07 16:51:22Z knoop ! Add terrain-following output ! ! 2718 2018-01-02 08:49:38Z maronga ! Corrected "Former revisions" section ! ! 2696 2017-12-14 17:12:51Z kanani ! Change in file header (GPL part) ! ! 2101 2017-01-05 16:42:31Z suehring ! ! 2000 2016-08-20 18:09:15Z knoop ! Forced header and separation lines into 80 columns ! ! 1682 2015-10-07 23:56:08Z knoop ! Code annotations made doxygen readable ! ! 1320 2014-03-20 08:40:49Z raasch ! kind-parameters added to all INTEGER and REAL declaration statements, ! kinds are defined in new module kinds, ! old module precision_kind is removed, ! comment fields (!:) to be used for variable explanations added to ! all variable declaration statements ! ! 1036 2012-10-22 13:43:42Z raasch ! code put under GPL (PALM 3.9) ! ! Description: ! ------------ !> Resorts the user-defined output quantity with indices (k,j,i) to a !> temporary array with indices (i,j,k) for masked data output. !------------------------------------------------------------------------------! SUBROUTINE user_data_output_mask( av, variable, found, local_pf, mid ) USE control_parameters USE indices USE kinds USE surface_mod, & ONLY: get_topography_top_index_ji USE user IMPLICIT NONE CHARACTER (LEN=*) :: variable !< CHARACTER (LEN=5) :: grid !< flag to distinquish between staggered grids INTEGER(iwp) :: av !< INTEGER(iwp) :: mid !< masked output running index ! INTEGER(iwp) :: i !< ! INTEGER(iwp) :: j !< ! INTEGER(iwp) :: k !< ! INTEGER(iwp) :: topo_top_ind !< k index of highest horizontal surface LOGICAL :: found !< REAL(wp), & DIMENSION(mask_size_l(mid,1),mask_size_l(mid,2),mask_size_l(mid,3)) :: & local_pf !< ! !-- Next line is to avoid compiler warning about unused variables. Please remove. IF ( av == 0 .OR. & local_pf(mask_size_l(mid,1),mask_size_l(mid,2),mask_size_l(mid,3)) == 0.0_wp ) CONTINUE found = .TRUE. grid = 's' SELECT CASE ( TRIM( variable ) ) !-- Uncomment and extend the following lines, if necessary. !-- The arrays for storing the user defined quantities (here u2 and u2_av) !-- have to be declared and defined by the user! !-- Sample for user-defined output: ! CASE ( 'u2' ) ! IF ( av == 0 ) THEN ! IF ( .NOT. mask_surface(mid) ) THEN !! !!-- Default masked output ! DO i = 1, mask_size_l(mid,1) ! DO j = 1, mask_size_l(mid,2) ! DO k = 1, mask_size_l(mid,3) ! local_pf(i,j,k) = u2(mask_k(mid,k), & ! mask_j(mid,j), & ! mask_i(mid,i)) ! ENDDO ! ENDDO ! ENDDO ! ELSE !! !!-- Terrain-following masked output ! DO i = 1, mask_size_l(mid,1) ! DO j = 1, mask_size_l(mid,2) !! !!-- Get k index of highest horizontal surface ! topo_top_ind = get_topography_top_index_ji( & ! mask_j(mid,j), & ! mask_i(mid,i), & ! grid ) !! !!-- Save output array ! DO k = 1, mask_size_l(mid,3) ! local_pf(i,j,k) = u2(MIN( topo_top_ind+mask_k(mid,k),& ! nzt+1 ), & ! mask_j(mid,j), & ! mask_i(mid,i) ) ! ENDDO ! ENDDO ! ENDDO ! ENDIF ! ELSE ! IF ( .NOT. mask_surface(mid) ) THEN !! !!-- Default masked output ! DO i = 1, mask_size_l(mid,1) ! DO j = 1, mask_size_l(mid,2) ! DO k = 1, mask_size_l(mid,3) ! local_pf(i,j,k) = u2_av(mask_k(mid,k), & ! mask_j(mid,j), & ! mask_i(mid,i) ) ! ENDDO ! ENDDO ! ENDDO ! ELSE !! !!-- Terrain-following masked output ! DO i = 1, mask_size_l(mid,1) ! DO j = 1, mask_size_l(mid,2) !! !!-- Get k index of highest horizontal surface ! topo_top_ind = get_topography_top_index_ji( & ! mask_j(mid,j), & ! mask_i(mid,i), & ! grid ) !! !!-- Save output array ! DO k = 1, mask_size_l(mid,3) ! local_pf(i,j,k) = u2_av( & ! MIN( topo_top_ind+mask_k(mid,k),& ! nzt+1 ), & ! mask_j(mid,j), & ! mask_i(mid,i) ) ! ENDDO ! ENDDO ! ENDDO ! ENDIF ! ENDIF CASE DEFAULT found = .FALSE. END SELECT END SUBROUTINE user_data_output_mask