1 /*============================================================================
2  * Code_Saturne documentation page
3  *============================================================================*/
4 
5 /*
6   This file is part of Code_Saturne, a general-purpose CFD tool.
7 
8   Copyright (C) 1998-2021 EDF S.A.
9 
10   This program is free software; you can redistribute it and/or modify it under
11   the terms of the GNU General Public License as published by the Free Software
12   Foundation; either version 2 of the License, or (at your option) any later
13   version.
14 
15   This program is distributed in the hope that it will be useful, but WITHOUT
16   ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
17   FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
18   details.
19 
20   You should have received a copy of the GNU General Public License along with
21   this program; if not, write to the Free Software Foundation, Inc., 51 Franklin
22   Street, Fifth Floor, Boston, MA 02110-1301, USA.
23 */
24 
25 /*-----------------------------------------------------------------------------*/
26 
27 /*!
28   \page cs_user_atmospheric_model Atmospheric model (cs_user_atmospheric_model.f90)
29 
30   \section cs_user_atmospheric_model_h_intro Introduction
31 
32   User subroutine for the atmospheric model.
33 
34   \section cs_user_atmospheric_model_usatdv Atmospheric module
35 
36   \c imode corresponds to the number of calls of the \ref usatdv function.
37   Depending on the value of \c imode , different operations are performed
38   in the following example.
39 
40   \subsection cs_user_atmospheric_model_usatdv_imode0 imode = 0
41 
42   \snippet cs_user_atmospheric_model.f90 imode_0
43 
44   \subsection cs_user_atmospheric_model_usatdv_imode1 imode = 1
45 
46   \snippet cs_user_atmospheric_model.f90 imode_1
47 
48   \section cs_user_atmospheric_model_usatsoil Data Entry for the atmospheric ground model
49 
50   \snippet cs_user_atmospheric_model.f90 usatsoil
51 
52 */
53