mpp_parameter.F90

Go to the documentation of this file.

!***********************************************************************
!*                   GNU Lesser General Public License
!*
!* This file is part of the GFDL Flexible Modeling System (FMS).
!*
!* FMS is free software: you can redistribute it and/or modify it under
!* the terms of the GNU Lesser General Public License as published by
!* the Free Software Foundation, either version 3 of the License, or (at
!* your option) any later version.
!*
!* FMS is distributed in the hope that it will be useful, but WITHOUT
!* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
!* FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
!* for more details.
!*
!* You should have received a copy of the GNU Lesser General Public
!* License along with FMS.  If not, see <http://www.gnu.org/licenses/>.
!***********************************************************************
module mpp_parameter_mod
#include <fms_platform.h>

  implicit none
  private

! Include variable "version" to be written to log file.
#include<file_version.h>
  public version

  !--- public paramters which is used by mpp_mod and its components. 
  !--- All othere modules should import these parameters from mpp_mod. 
  public :: maxpes, mpp_verbose, mpp_debug, all_pes, any_pe, null_pe, note, warning, fatal
  public :: mpp_wait, mpp_ready, max_clocks, max_event_types, max_events, mpp_clock_sync
  public :: mpp_clock_detailed, clock_component, clock_subcomponent, clock_module_driver
  public :: clock_module, clock_routine, clock_loop, clock_infra, max_bins
  public :: event_allreduce, event_broadcast, event_recv, event_send, event_wait
  public :: event_alltoall, event_type_create, event_type_free
  public :: default_tag
  public :: comm_tag_1,  comm_tag_2,  comm_tag_3,  comm_tag_4
  public :: comm_tag_5,  comm_tag_6,  comm_tag_7,  comm_tag_8
  public :: comm_tag_9,  comm_tag_10, comm_tag_11, comm_tag_12
  public :: comm_tag_13, comm_tag_14, comm_tag_15, comm_tag_16
  public :: comm_tag_17, comm_tag_18, comm_tag_19, comm_tag_20
  public :: mpp_fill_int, mpp_fill_float, mpp_fill_double

  !--- public paramters which is used by mpp_domains_mod and its components. 
  !--- All othere modules should import these parameters from mpp_domains_mod. 
  public :: global_data_domain, cyclic_global_domain, bgrid_ne, bgrid_sw, cgrid_ne, cgrid_sw
  public :: dgrid_ne, dgrid_sw, fold_west_edge, fold_east_edge, fold_south_edge, fold_north_edge
  public :: wupdate, eupdate, supdate, nupdate, xupdate, yupdate, bitwise_exact_sum, non_bitwise_exact_sum
  public :: mpp_domain_time, west, east, south, north, scalar_bit, scalar_pair, bitwise_efp_sum
  public :: north_east, south_east, south_west, north_west
  public :: agrid, global, cyclic, domain_id_base, center, corner
  public :: max_domain_fields, max_tiles
  public :: zero, ninety, minus_ninety, one_hundred_eighty
  public :: nonblock_update_tag, edgeupdate, edgeonly, nonsymedgeupdate, nonsymedge

  !--- public paramters which is used by mpp_domains_mod and its components. 
  !--- All othere modules should import these parameters from mpp_io_mod. 
  public :: mpp_wronly, mpp_rdonly, mpp_append, mpp_overwr, mpp_ascii, mpp_ieee32
  public :: mpp_native, mpp_netcdf, mpp_sequential, mpp_direct, mpp_single, mpp_multi
  public :: mpp_delete, mpp_collect, nullunit, nulltime
  public :: max_file_size, root_global, global_root_only

  !--- The following paramters are used by mpp_mod and its components.
  integer, parameter :: maxpes=2048            !used for dimensioning stuff that might be indexed by pe
  integer, parameter :: mpp_verbose=1, mpp_debug=2
  integer, parameter :: all_pes=-1, any_pe=-2, null_pe=-3
  integer, parameter :: note=0, warning=1, fatal=2
  integer, parameter :: max_clocks=400, max_event_types=5, max_events=40000
  integer, parameter :: event_allreduce=1, event_broadcast=2, event_recv=3, event_send=4, event_wait=5
  integer, parameter :: event_alltoall=6
  integer, parameter :: event_type_create=7, event_type_free=8
  integer, parameter :: mpp_clock_sync=1, mpp_clock_detailed=2
  integer            :: default_tag = 1
  !--- implimented to centralize _FILL_ values for land_model.F90 into mpp_mod
  !------- instead of multiple includes of netcdf.inc and manual assignments
  integer(INT_KIND) , parameter :: mpp_fill_int    = -2147483647            !NF_FILL_INT
  real(DOUBLE_KIND) , parameter :: mpp_fill_double = 9.9692099683868690e+36 !NF_FILL_DOUBLE
  real(FLOAT_KIND)  , parameter :: mpp_fill_float  = 9.9692099683868690e+36 !NF_FILL_DOUBLE
  !--- predefined clock granularities, but you can use any integer
  !--- using CLOCK_LOOP and above may distort coarser-grain measurements
  integer, parameter :: clock_component=1      !component level, e.g model, exchange
  integer, parameter :: clock_subcomponent=11  !top level within a model component, e.g dynamics, physics
  integer, parameter :: clock_module_driver=21 !module driver level, e.g adriver that calls multiple 
                                               !related physics routines
  integer, parameter :: clock_module=31        !module level, e.g main subroutine of a physics module
  integer, parameter :: clock_routine=41       !level of individual subroutine or function
  integer, parameter :: clock_loop=51          !loops or blocks within a routine
  integer, parameter :: clock_infra=61         !infrastructure level, e.g halo update
  integer, parameter :: max_bins=20
  integer(LONG_KIND), parameter :: mpp_wait=-1, mpp_ready=-2

  !--- The following paramters are used by mpp_domains_mod and its components.
  integer, parameter :: global=0, cyclic=1
  integer, parameter :: west=2, east=3, south=4, north=5, scalar_bit=6, center=7, corner=8
  integer, parameter :: south_west=7, south_east=8, north_west=9, north_east=10
  integer, parameter :: edgeonly = 11
  integer, parameter :: nonsymedge = 12
  integer, parameter :: send=1, recv=2
  integer, parameter :: global_data_domain=2**global, cyclic_global_domain=2**cyclic
  integer, parameter :: agrid=0, bgrid=1, cgrid=2, dgrid=3
  integer, parameter :: bgrid_ne=bgrid+2**north+2**east
  integer, parameter :: bgrid_sw=bgrid+2**south+2**west
  integer, parameter :: cgrid_ne=cgrid+2**north+2**east
  integer, parameter :: cgrid_sw=cgrid+2**south+2**west
  integer, parameter :: dgrid_ne=dgrid+2**north+2**east
  integer, parameter :: dgrid_sw=dgrid+2**south+2**west
  integer, parameter :: fold_west_edge = 2**west, fold_east_edge = 2**east
  integer, parameter :: fold_south_edge=2**south, fold_north_edge=2**north
  integer, parameter :: wupdate=2**west, eupdate=2**east, supdate=2**south, nupdate=2**north
  integer, parameter :: xupdate=wupdate+eupdate, yupdate=supdate+nupdate, scalar_pair=2**scalar_bit
  integer, parameter :: edgeupdate=2**edgeonly, nonsymedgeupdate=2**nonsymedge
  integer, parameter :: zero=0, ninety=90, minus_ninety=-90, one_hundred_eighty=180
  integer, parameter :: nonblock_update_tag = 2

! DOMAIN_ID_BASE acts as a counter increment for domains as they are defined. It's used in
! combination with the flag parameter defined above to create a unique identifier for
! each Domain+flags combination. Therefore, the value of any flag must not exceed DOMAIN_ID_BASE.
! integer(LONG_KIND), parameter :: DOMAIN_ID_BASE=INT( 2**(4*LONG_KIND),KIND=LONG_KIND )
  integer(LONG_KIND), parameter :: domain_id_base=z'0000000100000000' ! Workaround for 64bit init problem
  integer, parameter :: non_bitwise_exact_sum=0
  integer, parameter :: bitwise_exact_sum=1
  integer, parameter :: bitwise_efp_sum=2
  integer, parameter :: mpp_domain_time=mpp_debug+1
  integer, parameter :: max_domain_fields=100
  integer, parameter :: max_tiles=10

  !--- The following paramters are used by mpp_io_mod and its components.
  integer, parameter :: mpp_wronly=100, mpp_rdonly=101, mpp_append=102, mpp_overwr=103 !action on open
  integer, parameter :: mpp_ascii=200,  mpp_ieee32=201, mpp_native=202, mpp_netcdf=203 !format
  integer, parameter :: mpp_sequential=300, mpp_direct=301 !access
  integer, parameter :: mpp_single=400, mpp_multi=401      !threading, fileset
  integer, parameter :: mpp_delete=501, mpp_collect=502    !action on close
  integer, parameter :: nullunit=-1                        !returned by PEs not participating in    
                                                           !IO after a collective call with threading
                                                           !equal to MPP_SINGLE
  !--- unique tag used in FMS
  integer, parameter :: comm_tag_1  = 1,  comm_tag_2  = 2,  comm_tag_3  = 3,  comm_tag_4  = 4
  integer, parameter :: comm_tag_5  = 5,  comm_tag_6  = 6,  comm_tag_7  = 7,  comm_tag_8  = 8
  integer, parameter :: comm_tag_9  = 9,  comm_tag_10 = 10, comm_tag_11 = 11, comm_tag_12 = 12
  integer, parameter :: comm_tag_13 = 13, comm_tag_14 = 14, comm_tag_15 = 15, comm_tag_16 = 16
  integer, parameter :: comm_tag_17 = 17, comm_tag_18 = 18, comm_tag_19 = 19, comm_tag_20 = 20

  integer, parameter :: root_global = 9
  integer, parameter :: global_root_only = 2**root_global 
  real(DOUBLE_KIND), parameter :: nulltime=-1.
#ifdef LARGE_FILE
  integer(LONG_KIND), parameter :: max_file_size = 4294967295
#else
  integer(LONG_KIND), parameter :: max_file_size = 2147483647
#endif

  !#####################################################################

end module mpp_parameter_mod