docs/grouping.h

   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 !! This header file is used exclusively for doxygen documentation
  20 !! Defines groups for each subdirectory to add their modules into
  21 !! Additional doxygen pages can be added here as well
  22
  23 !> @defgroup affinity Affinity
  24 !> @brief Modules and associated files in the affinity directory
  25
  26 !> @defgroup astronomy Astronomy
  27 !> @brief Modules and associated files in the astronomy directory
  28
  29 !> @defgroup axis_utils Axis Utilities
  30 !> @brief Modules and associated files in the axis_utils directory
  31
  32 !> @defgroup amip_interp AMIP Interpolator
  33 !> @brief Modules and associated files in the amip_interp directory
  34
  35 !> @defgroup block_control Block Control
  36 !> @brief Modules and associated files in the block_control directory
  37
  38 !> @defgroup column_diagnostics Column Diagnostics
  39 !> @brief Modules and associated files in the column_diagnostics directory
  40
  41 !> @defgroup constants Constants
  42 !> @brief Modules and associated files in the constants directory
  43
  44 !> @defgroup coupler Coupler
  45 !> @brief Modules and associated files in the coupler directory
  46
  47 !> @defgroup data_override Data Override
  48 !> @brief Modules and associated files in the data_override directory
  49
  50 !> @defgroup diag_integral Diag Integral
  51 !> @brief Modules and associated files in the diag_integral directory
  52
  53 !> @defgroup diag_manager Diag Manager
  54 !> @brief Modules and associated files in the diag_manager directory.
  55 !! See below for additional information on diag_tables.
  56
  57 !> @defgroup drifters Drifters
  58 !> @brief Modules and associated files in the drifters directory
  59
  60 !> @defgroup exchange Exchange
  61 !> @brief Modules and associated files in the exchange directory
  62
  63 !> @defgroup field_manager Field Manager
  64 !> @brief Modules and associated files in the field_manager directory
  65
  66 !> @defgroup fms FMS
  67 !> @brief Modules and associated files in the fms directory
  68
  69 !> @defgroup fms2_io FMS2 IO
  70 !> @brief Modules and associated files in the fms2_io directory
  71 !!
  72 !> Updated IO modules for parallel IO via netcdf files. Replaces the functionality of the IO
  73 !! routines in mpp_io. fms2_io_mod is the main module for external usage and provides public
  74 !! interfaces for routines defined throughout this directory, dependent on the
  75 !! type of file.
  76
  77 !> @defgroup horiz_interp Horizontal Interpolator
  78 !> @brief Modules and associated files in the horiz_interp directory
  79
  80 !> @defgroup interpolator Interpolator
  81 !> @brief Modules and associated files in the interpolator directory
  82
  83 !> @defgroup memutils Memory Utilities
  84 !> @brief Modules and associated files in the memutils directory
  85
  86 !> @defgroup monin_obukhov Monin Obukhov
  87 !> @brief Modules and associated files in the monin_obukhov directory
  88
  89 !> @defgroup mosaic Mosaic
  90 !> @brief Modules and associated files in the mosaic directory
  91
  92 !> @defgroup mosaic2 Mosaic2
  93 !> @brief Modules and associated files in the mosaic2 directory
  94 !!
  95 !> Provides a fms2_io equivalent to the mpp_io dependent routines in mosaic
  96
  97 !> @defgroup mpp MPP
  98 !> @brief Modules and associated files in the mpp directory
  99 !!
 100 !> Provides interfaces to facilitate common tasks for parallel computing and
 101 !! modeling. Originally written to provide interfaces across different message-passing libraries,
 102 !! it is now used mainly with the MPI standard, and provides wrappers to many MPI
 103 !! routines. Documentation on serial implementations of routines (usually denoted by _nocommm in
 104 !! the file name) will be excluded on these module pages, as they are currently unused but mo, but their documentation is still
 105 !! available in the Files tab.
 106
 107 !> @defgroup platform Platform
 108 !> @brief Modules and associated files in the platform directory
 109
 110 !> @defgroup random_numbers Random Numbers
 111 !> @brief Modules and associated files in the random_numbers directory
 112
 113 !> @defgroup sat_vapor_pres Saturation Vapor Pressure
 114 !> @brief Modules and associated files in the sat_vapor_pres directory
 115
 116 !> @defgroup time_interp Time Interpolator
 117 !> @brief Modules and associated files in the time_interp directory
 118
 119 !> @defgroup time_manager Time Manager
 120 !> @brief Modules and associated files in the time_manager directory
 121
 122 !> @defgroup topography Topography
 123 !> @brief Modules and associated files in the topography directory
 124
 125 !> @defgroup string_utils String Utils
 126 !> @brief Modules and associated files in the string_utils directory
 127
 128 !> @defgroup tracer_manager Tracer Manager
 129 !> @brief Modules and associated files in the tracer_manager directory
 130
 131 !> @defgroup tridiagonal Tridiagonal
 132 !> @brief Modules and associated files in the tridiagonal directory
 133
 134 !> @defgroup libfms FMS Global Module
 135 !> @brief Modules and associated files in the libfms directory
 136
 137 !> @defgroup parser Parser
 138 !> @brief Modules and associated files for the yaml parser
 139
 140 !> @page build Building and Installation
 141 !> @brief Information about the build systems and how to build and install
 142 !! @subpage install
 143 !!
 144 !! @subpage autotools
 145 !!
 146 !! @subpage cmake