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

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

Code annotations made doxygen readable

  • Property svn:keywords set to Id
File size: 4.1 KB
Line 
1!> @file user_init_plant_canopy.f90
2!--------------------------------------------------------------------------------!
3! This file is part of PALM.
4!
5! PALM is free software: you can redistribute it and/or modify it under the terms
6! of the GNU General Public License as published by the Free Software Foundation,
7! either version 3 of the License, or (at your option) any later version.
8!
9! PALM is distributed in the hope that it will be useful, but WITHOUT ANY
10! WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
11! A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
12!
13! You should have received a copy of the GNU General Public License along with
14! PALM. If not, see <http://www.gnu.org/licenses/>.
15!
16! Copyright 1997-2014 Leibniz Universitaet Hannover
17!--------------------------------------------------------------------------------!
18!
19! Current revisions:
20! -----------------
21! Code annotations made doxygen readable
22!
23! Former revisions:
24! -----------------
25! $Id: user_init_plant_canopy.f90 1682 2015-10-07 23:56:08Z knoop $
26!
27! 1484 2014-10-21 10:53:05Z kanani
28! Changes in the course of the canopy-model modularization:
29!   module plant_canopy_model_mod added,
30!   definition of array cdc (canopy drag coefficient) removed, since it is now
31!   defined purely as a single constant value (see module plant_canopy_model)
32!
33! 1353 2014-04-08 15:21:23Z heinze
34! REAL constants provided with KIND-attribute
35!
36! 1320 2014-03-20 08:40:49Z raasch
37! kind-parameters added to all INTEGER and REAL declaration statements,
38! kinds are defined in new module kinds,
39! old module precision_kind is removed,
40! revision history before 2012 removed,
41! comment fields (!:) to be used for variable explanations added to
42! all variable declaration statements
43!
44! 1036 2012-10-22 13:43:42Z raasch
45! code put under GPL (PALM 3.9)
46!
47! 211 2008-11-11 04:46:24Z raasch
48! Former file user_interface.f90 split into one file per subroutine
49!
50! Description:
51! ------------
52!> Initialisation of the leaf area density array (for scalar grid points) and
53!> the array of the canopy drag coefficient, if the user has not chosen any
54!> of the default cases
55!------------------------------------------------------------------------------!
56 SUBROUTINE user_init_plant_canopy
57 
58
59    USE arrays_3d
60   
61    USE control_parameters
62   
63    USE indices
64   
65    USE kinds
66
67    USE plant_canopy_model_mod
68   
69    USE user
70
71    IMPLICIT NONE
72
73    INTEGER(iwp) :: i   !< running index
74    INTEGER(iwp) :: j   !< running index
75
76!
77!-- Here the user-defined grid initializing actions follow:
78
79!
80!-- Set the 3D-array lad_s for user defined canopies
81    SELECT CASE ( TRIM( canopy_mode ) )
82
83       CASE ( 'block' )
84!
85!--       Not allowed here since this is the standard case used in init_3d_model.
86
87       CASE ( 'user_defined_canopy_1' )
88!
89!--       Here the user can define his own forest topography.
90!--       The following lines contain an example, where the plant canopy extends
91!--       only over the second half of the model domain along x.
92!--       Attention: DO-loops have to include the ghost points (nxlg-nxrg,
93!--       nysg-nyng), because no exchange of ghost point information is intended,
94!--       in order to minimize communication between CPUs
95!          DO  i = nxlg, nxrg
96!             IF ( i >= INT(nx+1/2) ) THEN
97!                DO  j = nysg, nyng
98!                   lad_s(:,j,i) = lad(:)
99!                ENDDO
100!             ELSE
101!                lad_s(:,:,i) = 0.0_wp
102!             ENDIF
103!          ENDDO
104!
105!--       After definition, please
106!--       remove the following three lines!
107          message_string = 'canopy_mode "' // canopy_mode // &
108                           '" not available yet'
109          CALL message( 'user_init_plant_canopy', 'UI0007', 0, 1, 0, 6, 0 )
110         
111       CASE DEFAULT
112!
113!--       The DEFAULT case is reached if the parameter canopy_mode contains a
114!--       wrong character string that is neither recognized in init_3d_model nor
115!--       here in user_init_plant_canopy.
116          message_string = 'unknown canopy_mode "' // canopy_mode // '"'
117          CALL message( 'user_init_plant_canopy', 'UI0008', 1, 2, 0, 6, 0 )
118
119    END SELECT
120
121
122 END SUBROUTINE user_init_plant_canopy
123
Note: See TracBrowser for help on using the repository browser.