source: palm/trunk/SOURCE/user_init_plant_canopy.f90 @ 3046

Last change on this file since 3046 was 2718, checked in by maronga, 4 years ago

deleting of deprecated files; headers updated where needed

  • Property svn:keywords set to Id
File size: 4.5 KB
Line 
1!> @file user_init_plant_canopy.f90
2!------------------------------------------------------------------------------!
3! This file is part of the PALM model system.
4!
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.
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!
17! Copyright 1997-2018 Leibniz Universitaet Hannover
18!------------------------------------------------------------------------------!
19!
20! Current revisions:
21! -----------------
22!
23!
24! Former revisions:
25! -----------------
26! $Id: user_init_plant_canopy.f90 2718 2018-01-02 08:49:38Z Giersch $
27! Corrected "Former revisions" section
28!
29! 2696 2017-12-14 17:12:51Z kanani
30! Change in file header (GPL part)
31!
32! 2101 2017-01-05 16:42:31Z suehring
33!
34! 2000 2016-08-20 18:09:15Z knoop
35! Forced header and separation lines into 80 columns
36!
37! 1951 2016-06-20 10:05:12Z suehring
38! Bugfix in example initialization
39!
40! 1682 2015-10-07 23:56:08Z knoop
41! Code annotations made doxygen readable
42!
43! 1484 2014-10-21 10:53:05Z kanani
44! Changes in the course of the canopy-model modularization:
45!   module plant_canopy_model_mod added,
46!   definition of array cdc (canopy drag coefficient) removed, since it is now
47!   defined purely as a single constant value (see module plant_canopy_model)
48!
49! 1353 2014-04-08 15:21:23Z heinze
50! REAL constants provided with KIND-attribute
51!
52! 1320 2014-03-20 08:40:49Z raasch
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
59!
60! 1036 2012-10-22 13:43:42Z raasch
61! code put under GPL (PALM 3.9)
62!
63! 211 2008-11-11 04:46:24Z raasch
64! Former file user_interface.f90 split into one file per subroutine
65!
66! Description:
67! ------------
68!> Initialisation of the leaf area density array (for scalar grid points) and
69!> the array of the canopy drag coefficient, if the user has not chosen any
70!> of the default cases
71!------------------------------------------------------------------------------!
72 SUBROUTINE user_init_plant_canopy
73 
74
75    USE arrays_3d
76   
77    USE control_parameters
78   
79    USE indices
80   
81    USE kinds
82
83    USE plant_canopy_model_mod
84   
85    USE user
86
87    IMPLICIT NONE
88
89    INTEGER(iwp) :: i   !< running index
90    INTEGER(iwp) :: j   !< running index
91
92!
93!-- Here the user-defined grid initializing actions follow:
94
95!
96!-- Set the 3D-array lad_s for user defined canopies
97    SELECT CASE ( TRIM( canopy_mode ) )
98
99       CASE ( 'block' )
100!
101!--       Not allowed here since this is the standard case used in init_3d_model.
102
103       CASE ( 'user_defined_canopy_1' )
104!
105!--       Here the user can define his own forest topography.
106!--       The following lines contain an example, where the plant canopy extends
107!--       only over the second half of the model domain along x.
108!--       Attention: DO-loops have to include the ghost points (nxlg-nxrg,
109!--       nysg-nyng), because no exchange of ghost point information is intended,
110!--       in order to minimize communication between CPUs.
111!          DO  i = nxlg, nxrg
112!             IF ( i >= INT( ( nx+1 ) / 2 ) ) THEN
113!                DO  j = nysg, nyng
114!                   lad_s(:,j,i) = lad(:)
115!                ENDDO
116!             ELSE
117!                lad_s(:,:,i) = 0.0_wp
118!             ENDIF
119!          ENDDO
120!
121!--       After definition, please
122!--       remove the following three lines!
123          message_string = 'canopy_mode "' // canopy_mode // &
124                           '" not available yet'
125          CALL message( 'user_init_plant_canopy', 'UI0007', 0, 1, 0, 6, 0 )
126         
127       CASE DEFAULT
128!
129!--       The DEFAULT case is reached if the parameter canopy_mode contains a
130!--       wrong character string that is neither recognized in init_3d_model nor
131!--       here in user_init_plant_canopy.
132          message_string = 'unknown canopy_mode "' // canopy_mode // '"'
133          CALL message( 'user_init_plant_canopy', 'UI0008', 1, 2, 0, 6, 0 )
134
135    END SELECT
136
137
138 END SUBROUTINE user_init_plant_canopy
139
Note: See TracBrowser for help on using the repository browser.