atm_phys/old_doc/atm_phys_driver.html

672ec4d5cf Jean*0001 <!--
                0002
                0003 !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
                0004 !!                                                                   !!
                0005 !!                   GNU General Public License                      !!
                0006 !!                                                                   !!
                0007 !! This file is part of the Flexible Modeling System (FMS).          !!
                0008 !!                                                                   !!
                0009 !! FMS is free software; you can redistribute it and/or modify       !!
                0010 !! it and are expected to follow the terms of the GNU General Public !!
                0011 !! License as published by the Free Software Foundation.             !!
                0012 !!                                                                   !!
                0013 !! FMS is distributed in the hope that it will be useful,            !!
                0014 !! but WITHOUT ANY WARRANTY; without even the implied warranty of    !!
                0015 !! MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the     !!
                0016 !! GNU General Public License for more details.                      !!
                0017 !!                                                                   !!
                0018 !! You should have received a copy of the GNU General Public License !!
                0019 !! along with FMS; if not, write to:                                 !!
                0020 !!          Free Software Foundation, Inc.                           !!
                0021 !!          59 Temple Place, Suite 330                               !!
                0022 !!          Boston, MA  02111-1307  USA                              !!
                0023 !! or see:                                                           !!
                0024 !!          http://www.gnu.org/licenses/gpl.txt                      !!
                0025 !!                                                                   !!
                0026 !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
                0027
                0028 -->
                0029 <HTML>
                0030 <TITLE>module atmosphere_mod</TITLE>
                0031 <BODY BGCOLOR="#AABBCC" TEXT="#332211" >
                0032
                0033 <DIV ALIGN="CENTER"> <FONT SIZE=1>
                0034 <A HREF="#INTERFACE">PUBLIC INTERFACE</A> /
                0035 <A HREF="#DATA_TYPES">DATA</A> /
                0036 <A HREF="#ROUTINES">ROUTINES</A> /
                0037 <A HREF="#NAMELIST">NAMELIST</A> /
                0038 <A HREF="#CHANGES">CHANGES</A> /
                0039 <A HREF="#ERRORS">ERRORS</A> /
                0040 </FONT>
                0041 <BR><BR></DIV><HR>
                0042
                0043
                0044 <H2>module atmosphere_mod</H2>
                0045 <A NAME="HEADER">
                0046 <!-- BEGIN HEADER -->
                0047 <PRE>
                0048      <B>Contact:</B> Isaac Held,  Peter Phillipps
                0049      <B>Reviewers:</B>
                0050
                0051 </PRE>
                0052 <!-- END HEADER --></A>
                0053 <!--------------------------------------------------------------------->
                0054 <A NAME="OVERVIEW">
                0055 <HR>
                0056 <H4>OVERVIEW</H4>
                0057 <!-- BEGIN OVERVIEW -->
                0058 <PRE>
                0059
                0060      Atmospheric driver for the spectral dynamics
                0061      using forcing from the Held-Suarez benchmark.
                0062
                0063 </PRE>
                0064 <!-- END OVERVIEW --></A>
                0065 <!--------------------------------------------------------------------->
                0066 <A NAME="DESCRIPTION">
                0067 <!-- BEGIN DESCRIPTION -->
                0068 <PRE>
                0069
                0070      This module provides a standard interface to the
                0071      spectral dynamical core and interface to the
                0072      Held Suarez physics.
                0073
                0074 </PRE>
                0075 <!-- END DESCRIPTION --></A>
                0076 <!--------------------------------------------------------------------->
                0077 <A NAME="MODULES_USED">
                0078 <HR>
                0079 <H4>OTHER MODULES USED</H4>
                0080 <!-- BEGIN MODULES_USED -->
                0081 <PRE>
                0082
                0083                     fms_mod
                0084               constants_mod
                0085              transforms_mod
                0086            time_manager_mod
                0087        press_and_geopot_mod
                0088       spectral_dynamics_mod
                0089             tracer_type_mod
                0090              hs_forcing_mod
                0091                     mpp_mod
                0092           field_manager_mod
                0093          tracer_manager_mod
                0094
                0095 </PRE>
                0096 <!-- END MODULES_USED --></A>
                0097 <!--------------------------------------------------------------------->
                0098 <A NAME="INTERFACE">
                0099 <HR>
                0100 <H4>PUBLIC INTERFACE</H4>
                0101 <!-- BEGIN INTERFACE -->
                0102 <PRE>
                0103
                0104   use atmosphere_mod [,only: atmosphere_init,
                0105                              atmosphere,
                0106                  atmosphere_end ]
                0107
                0108   Notes:
                0109
                0110       Namelist interface <b>&atmosphere_nml</b> must
                0111       exist in file <b>input.nml</b>.
                0112
                0113 </PRE>
                0114 <!-- END INTERFACE --></A>
                0115 <!--------------------------------------------------------------------->
                0116 <A NAME="DATA_TYPES">
                0117 <HR>
                0118 <H4>PUBLIC DATA</H4>
                0119 <!-- BEGIN DATA_TYPES -->
                0120 <PRE>
                0121
                0122      There are no public defined data types.
                0123
                0124 </PRE>
                0125 <!-- END DATA_TYPES --></A>
                0126 <!--------------------------------------------------------------------->
                0127 <A NAME="ROUTINES">
                0128 <HR>
                0129 <H4>PUBLIC ROUTINES</H4>
                0130 <!-- BEGIN ROUTINES -->
                0131 <PRE>
                0132
                0133 call atmosphere_init (Time_init, Time, Time_step)
                0134
                0135 input
                0136
                0137     Time        current time [time_type]
                0138
                0139     Time_step   time step [time_type]
                0140
                0141 ---------------------------------------------------------------------
                0142
                0143 call atmosphere_end
                0144
                0145    No calling arguments
                0146
                0147 ---------------------------------------------------------------------
                0148
                0149 call atmosphere (Time)
                0150
                0151 input
                0152
                0153     Time        current time [time_type]
                0154
                0155 </PRE>
                0156 <!-- END ROUTINES --></A>
                0157 <!--------------------------------------------------------------------->
                0158 <A NAME="NAMELIST">
                0159 <HR>
                0160 <H4>NAMELIST</H4>
                0161 <!-- BEGIN NAMELIST -->
                0162 <PRE>
                0163
                0164   There is no namelist
                0165
                0166 </PRE>
                0167 <!-- END NAMELIST --></A>
                0168 <!--------------------------------------------------------------------->
                0169 <A NAME="CHANGES">
                0170 <HR>
                0171 <H4>CHANGE HISTORY</H4>
                0172 <PRE>
                0173
                0174 </PRE>
                0175 <!-- END CHANGES --></A>
                0176 <!--------------------------------------------------------------------->
                0177 <A NAME="ERRORS">
                0178 <HR>
                0179 <H4>ERROR MESSAGES</H4>
                0180 <!-- BEGIN ERRORS -->
                0181 <PRE>
                0182
                0183 <b>FATAL error messages are followed by an explanation in italics</b>
                0184
                0185 <b>atmosphere module is not initialized</b>
                0186    <i>subroutine atmosphere_init must be called prior to calling subroutine atmosphere</i>
                0187
                0188
                0189 </PRE>
                0190 <!-- END ERRORS --></A>
                0191 <!--------------------------------------------------------------------->
                0192
                0193 <HR>
                0194 </BODY>
                0195 </HTML>