source: palm/trunk/SOURCE/user_init_grid.f90 @ 3759

Last change on this file since 3759 was 3655, checked in by knoop, 6 years ago

Bugfix: made "unit" and "found" intend INOUT in module interface subroutines + automatic copyright update

  • Property svn:keywords set to Id
File size: 4.7 KB
RevLine 
[1682]1!> @file user_init_grid.f90
[2000]2!------------------------------------------------------------------------------!
[2696]3! This file is part of the PALM model system.
[1036]4!
[2000]5! PALM is free software: you can redistribute it and/or modify it under the
6! terms of the GNU General Public License as published by the Free Software
7! Foundation, either version 3 of the License, or (at your option) any later
8! version.
[1036]9!
10! PALM is distributed in the hope that it will be useful, but WITHOUT ANY
11! WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
12! A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
13!
14! You should have received a copy of the GNU General Public License along with
15! PALM. If not, see <http://www.gnu.org/licenses/>.
16!
[3655]17! Copyright 1997-2019 Leibniz Universitaet Hannover
[2000]18!------------------------------------------------------------------------------!
[1036]19!
[258]20! Current revisions:
[211]21! -----------------
[1683]22!
[2233]23!
[1321]24! Former revisions:
25! -----------------
26! $Id: user_init_grid.f90 3655 2019-01-07 16:51:22Z suehring $
[3065]27! dz was replaced by dz(1)
28!
29! 2718 2018-01-02 08:49:38Z maronga
[2716]30! Corrected "Former revisions" section
31!
32! 2696 2017-12-14 17:12:51Z kanani
33! Change in file header (GPL part)
[2696]34! Extended argument list (MS)
35!
36! 2233 2017-05-30 18:08:54Z suehring
[1321]37!
[2233]38! 2232 2017-05-30 17:47:52Z suehring
39! +Generic tunnel added
40! +Example of setting user-defined topography
41!
[2001]42! 2000 2016-08-20 18:09:15Z knoop
43! Forced header and separation lines into 80 columns
44!
[1969]45! 1968 2016-07-18 12:01:49Z suehring
46! Change dimensions for nzb_local, which do not longer need to be set on
47! multigrid ghost points.
48!
[1683]49! 1682 2015-10-07 23:56:08Z knoop
50! Code annotations made doxygen readable
51!
[1321]52! 1320 2014-03-20 08:40:49Z raasch
[1320]53! kind-parameters added to all INTEGER and REAL declaration statements,
54! kinds are defined in new module kinds,
55! old module precision_kind is removed,
56! revision history before 2012 removed,
57! comment fields (!:) to be used for variable explanations added to
58! all variable declaration statements
[211]59!
[1037]60! 1036 2012-10-22 13:43:42Z raasch
61! code put under GPL (PALM 3.9)
62!
[226]63! 217 2008-12-09 18:00:48Z letzel
64! +topography_grid_convention
65! Former file user_interface.f90 split into one file per subroutine
66!
[211]67! Description:
68! ------------
[1682]69!> Execution of user-defined grid initializing actions
[211]70!------------------------------------------------------------------------------!
[2232]71 SUBROUTINE user_init_grid( topo_3d )
[1682]72 
[211]73
74    USE control_parameters
[1320]75   
[211]76    USE indices
[1320]77   
78    USE kinds
79   
[211]80    USE user
81
82    IMPLICIT NONE
83
[2232]84    INTEGER(iwp)                                           ::  k_topo      !< topography top index
85    INTEGER(iwp), DIMENSION(nzb:nzt+1,nysg:nyng,nxlg:nxrg) ::  topo_3d     !< 3D topography field
[211]86
[2232]87    REAL(wp) ::  h_topo !< user-defined topography height
88
[211]89!
90!-- Here the user-defined grid initializing actions follow:
91
92!
93!-- Set the index array nzb_local for non-flat topography.
94!-- Here consistency checks concerning domain size and periodicity are necessary
95    SELECT CASE ( TRIM( topography ) )
96
[2232]97       CASE ( 'flat', 'single_building', 'single_street_canyon', 'tunnel' )
[211]98!
99!--       Not allowed here since these are the standard cases used in init_grid.
100
101       CASE ( 'user_defined_topography_1' )
102!
[256]103!--       Here the user can define his own topography.
[217]104!--       After definition, please remove the following three lines!
[258]105          message_string = 'topography "' // topography // '" not available yet'
106          CALL message( 'user_init_grid', 'UI0005', 1, 2, 0, 6, 0 )
[2232]107!
108!--       The user is allowed to set surface-mounted as well as non-surface
109!--       mounted topography (e.g. overhanging structures). For both, use
110!--       3D array topo_3d and set bit 0. The convention is: bit is zero inside
111!--       topography, bit is 1 for atmospheric grid point.
112!--       The following example shows how to prescribe sine-like topography
[3065]113!--       along x-direction with amplitude of 10 * dz(1) and wavelength 10 * dy.
[2232]114!           DO  i = nxlg, nxrg
[3065]115!              h_topo = 10.0_wp * dz(1) * (SIN(3.14_wp*0.5_wp)*i*dx / ( 5.0_wp * dy ) )**2
[2232]116!
117!              k_topo = MINLOC( ABS( zw - h_topo ), 1 ) - 1
118!
119!              topo_3d(k_topo+1:nzt+1,:,i) =                                     &
120!                                          IBSET( topo_3d(k_topo+1:nzt+1,:,i), 0 )
121!           ENDDO
122!
[2696]123!           CALL exchange_horiz_int( topo_3d, nys, nyn, nxl, nxr, nzt, nbgp )
[211]124
125       CASE DEFAULT
126!
127!--       The DEFAULT case is reached if the parameter topography contains a
128!--       wrong character string that is neither recognized in init_grid nor
129!--       here in user_init_grid.
[258]130          message_string = 'unknown topography "' // topography // '"'
131          CALL message( 'user_init_grid', 'UI0006', 1, 2, 0, 6, 0 )
[211]132
133    END SELECT
134
135
[2232]136
137
[211]138 END SUBROUTINE user_init_grid
139
Note: See TracBrowser for help on using the repository browser.