constants/constants.F90

   1 !***********************************************************************
   2 !*                   GNU Lesser General Public License
   3 !*
   4 !* This file is part of the GFDL Flexible Modeling System (FMS).
   5 !*
   6 !* FMS is free software: you can redistribute it and/or modify it under
   7 !* the terms of the GNU Lesser General Public License as published by
   8 !* the Free Software Foundation, either version 3 of the License, or (at
   9 !* your option) any later version.
  10 !*
  11 !* FMS is distributed in the hope that it will be useful, but WITHOUT
  12 !* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  13 !* FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  14 !* for more details.
  15 !*
  16 !* You should have received a copy of the GNU Lesser General Public
  17 !* License along with FMS.  If not, see <http://www.gnu.org/licenses/>.
  18 !***********************************************************************
  19 !> @file
  20 !> @brief File for @ref constants_mod
  21
  22 !> @defgroup constants_mod constants_mod
  23 !> @ingroup constants
  24 !> @brief compatibility module as we transition to an FMSConstants module
  25 !!
  26 !>    Constants have been declared as type REAL, PARAMETER.
  27 !!
  28 !!    The value a constant can not be changed in a users program.
  29 !!    New constants can be defined in terms of values from the
  30 !!    constants module using a parameter statement.<br><br>
  31 !!
  32 !!    The name given to a particular constant may be changed.<br><br>
  33 !!
  34 !!    Constants can be used on the right side on an assignment statement
  35 !!    (their value can not be reassigned).
  36 !!
  37 !!    Example:
  38 !!
  39 !! @verbatim
  40 !!    use constants_mod, only:  TFREEZE, grav_new => GRAV
  41 !!    real, parameter :: grav_inv = 1.0 / grav_new
  42 !!    tempc(:,:,:) = tempk(:,:,:) - TFREEZE
  43 !!    geopotential(:,:) = height(:,:) * grav_new
  44 !! @endverbatim
  45
  46 !> @addtogroup constants_mod
  47 !> @{
  48 module constants_mod
  49
  50 !> rename to not conflict with any other version vars
  51 use FMSConstants, version => constants_version, constants_init => FMSconstants_init
  52
  53 contains
  54
  55 end module constants_mod