source: palm/trunk/SOURCE/user_init_3d_model.f90 @ 2716

Last change on this file since 2716 was 2716, checked in by kanani, 4 years ago

Correction of "Former revisions" section

  • Property svn:keywords set to Id
File size: 4.0 KB
RevLine 
[1682]1!> @file user_init_3d_model.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!
[2101]17! Copyright 1997-2017 Leibniz Universitaet Hannover
[2000]18!------------------------------------------------------------------------------!
[1036]19!
[484]20! Current revisions:
[211]21! -----------------
[1683]22!
[2233]23!
[211]24! Former revisions:
25! -----------------
26! $Id: user_init_3d_model.f90 2716 2017-12-29 16:35:59Z kanani $
[2716]27! Corrected "Former revisions" section
28!
29! 2696 2017-12-14 17:12:51Z kanani
30! Change in file header (GPL part)
31!
32! 2618 2017-11-16 15:37:30Z suehring
[2618]33! Provide example for user-defined initialization of surface-related quantities
34!
35! 2233 2017-05-30 18:08:54Z suehring
[211]36!
[2233]37! 2232 2017-05-30 17:47:52Z suehring
38! +surface_mod
39!
[2001]40! 2000 2016-08-20 18:09:15Z knoop
41! Forced header and separation lines into 80 columns
42!
[1683]43! 1682 2015-10-07 23:56:08Z knoop
44! Code annotations made doxygen readable
45!
[1321]46! 1320 2014-03-20 08:40:49Z raasch
47! small changes in layout
48!
[1037]49! 1036 2012-10-22 13:43:42Z raasch
50! code put under GPL (PALM 3.9)
51!
[226]52! 211 2008-11-11 04:46:24Z raasch
53! Former file user_interface.f90 split into one file per subroutine
54!
[211]55! Description:
56! ------------
[1682]57!> Allows the complete initialization of the 3d model.
58!>
59!> @attention The user is responsible to set at least all those quantities which
60!>            are normally set within init_3d_model!
[211]61!------------------------------------------------------------------------------!
[1682]62 SUBROUTINE user_init_3d_model
63 
[211]64
65    USE arrays_3d
[1320]66   
[211]67    USE control_parameters
[1320]68   
[211]69    USE indices
[1320]70   
71    USE kinds
[2232]72
73    USE surface_mod
[1320]74   
[211]75    USE user
76
77    IMPLICIT NONE
78
[2618]79    INTEGER(iwp) ::  l !< running index surface orientation
80    INTEGER(iwp) ::  m !< running index surface elements
[211]81
[2618]82!
83!-- Initialization of surface-related quantities.
84!-- The following example shows required initialization of surface quantitites
85!-- at default-type upward-facing surfaces. 
86!   DO  m = 1, surf_def_h(0)%ns
87!      surf_def_h(0)%ol(m)   = ...    ! Obukhov length
88!      surf_def_h(0)%us(m  ) = ...    ! friction velocity
89!      surf_def_h(0)%usws(m) = ...    ! vertical momentum flux, u-component
90!      surf_def_h(0)%vsws(m) = ...    ! vertical momentum flux, v-component
91!      surf_def_h(0)%z0(m)   = ...    ! roughness length for momentum
92!      IF ( .NOT. neutral )  THEN
93!         surf_def_h(0)%ts(m)   = ... ! scaling parameter
94!         surf_def_h(0)%shf(m)  = ... ! surface sensible heat flux
95!         surf_def_h(0)%z0h(m)  = ... ! roughness length for heat
96!      ENDIF
97!      IF ( humditiy )  THEN
98!         surf_def_h(0)%qs(m)   = ... ! scaling parameter
99!         surf_def_h(0)%qsws(m) = ... ! surface latent heat flux
100!         surf_def_h(0)%z0q(m)  = ... ! roughness length for moisture
101!      ENDIF
102!      IF ( passive_scalar )  THEN
103!         surf_def_h(0)%ss(m)   = ... ! scaling parameter
104!         surf_def_h(0)%ssws(m) = ... ! surface latent heat flux
105!      ENDIF
106!   ENDDO
107!
108!-- Same for natural and urban type surfaces
109!   DO  m = 1, surf_lsm_h%ns
110!      ...
111!   ENDDO
112!   DO  m = 1, surf_usm_h%ns
113!      ...
114!   ENDDO
115!
116!-- Also care for vertically aligned surfaces (default-, natural-, and
117!-- urban-type).
118!   DO  l = 0, 3
119!      DO  m = 1, surf_def_v(l)%ns
120!         ...
121!      ENDDO
122!      DO  m = 1, surf_lsm_v(l)%ns
123!         ...
124!      ENDDO
125!      DO  m = 1, surf_usm_v(l)%ns
126!         ...
127!      ENDDO
128!   ENDDO
129!
130!
131!-- In the following, initialize 3D quantities, e.g. u, v, w, pt, etc..
132
[211]133 END SUBROUTINE user_init_3d_model
134
Note: See TracBrowser for help on using the repository browser.