grids.F90

Go to the documentation of this file.

module grids_mod
  use datadefn_mod, only : default_precision
  implicit none

#ifndef TEST_MODE
  private
#endif

  integer, parameter, public :: z_index = 1, y_index = 2, x_index = 3
  integer, parameter, public :: primal_grid=1, dual_grid=2

  type, public :: horizontal_grid_configuration_type
     real(kind=DEFAULT_PRECISION) dx, dy
     real(kind=DEFAULT_PRECISION) cx, cy
     real(kind=DEFAULT_PRECISION) cx2, cy2
     real(kind=DEFAULT_PRECISION) cxy
     real(kind=DEFAULT_PRECISION) tcx, tcy
  end type horizontal_grid_configuration_type

  type, public :: vertical_grid_configuration_type
     real(kind=DEFAULT_PRECISION), dimension(:), allocatable :: &
          z,&     !< Heights at w levels (m)
          zn,&    !< Heights at pressure levels (m)
          dz,&    !< Vertical spacing between K and K-1 w levels
          dzn,&   !< Vertical spacing between K and K-1 p levels
          rdz,&   !< Reciprocal of DZ
          rdzn,&  !< Reciprocal of DZN
          rho,&   !< Density at w levels (kg/m3)
          rhon,&  !< Density at p levels (kg/m3)
          thref,& !< Reference potential temperature (K)
          dthref,& !< Gradient of thref (K)
          tref,&  !< Reference temperature (K)
          theta_init,& !< Initial profile of theta
          u_init,&     !< Initial profile of u
          v_init,&     !< Initial profile of v
          prefn,& !< Reference pressure (Pa)
          pdiff,& !< Difference between pressure levels (Pa)
          prefrcp,&
          rprefrcp,&
          czb,&   !< (rho(k-1)/rhon(k))/(dz(k)*dzn(k)) use for diffusion onto p level from below
          cza,&   !< (rho(k)/rhon(k))/(dz(k)*dzn(k+1)) use for diffusion onto p level from above
          czg,&   !< CZB-CZA for tridiagonal solver in POISSON
          czh,&   !< CZB*CZA for tridiagonal solver in POISSON      
          tzc1,&  !< 0.25*rdz(k)*rho(k-1)/rhon(k) for advection onto p-level from below
          tzc2,&  !< 0.25*rdz(k)*rho(k)/rhon(k) for advection onto p-level from above
          tzd1,&  !< 0.25*rdzn(k+1)*rhon(k)/rho(k) for advection onto w-level from below
          tzd2,&  !< 0.25*rdzn(k+1)*rhon(k+1)/rho(k) for advection onto w-level from above 
          w_subs,& !< Subsidence velocity
          olubar,& !< Current U mean
          savolubar,&          
          olvbar,& !< Current V mean
          savolvbar,&
          olthbar,& !< Current theta mean
          olzubar,& !< Previous timestep U mean
          olzvbar,& !< Previous timestep V mean
          olzthbar,& !< Previous theta mean
          dmpco,& !< Damping coefficient on pressure levels
          dmpcoz,& !< Damping coefficient on w-levels
          tstarpr,& ! Temperature about which Taylor Expansion
          qsat,&
          dqsatdt,&
          qsatfac,&
          rneutml,&
          rneutml_sq,&
          buoy_co, &
          theta_rand, &!< profile of amplitude of theta perturbations
          theta_force, & !<profile of forcing term for theta
          u_force, & !<profile of forcing term for u
          v_force, & !<profile of forcing term for v
      w_rand



     real(kind=DEFAULT_PRECISION), dimension(:,:), allocatable :: q_init
     real(kind=DEFAULT_PRECISION), dimension(:,:), allocatable :: q_rand
     real(kind=DEFAULT_PRECISION), dimension(:,:), allocatable :: q_force

     real(kind=DEFAULT_PRECISION), dimension(:,:), allocatable :: olqbar,olzqbar     
     real(kind=DEFAULT_PRECISION), dimension(:), allocatable :: hgd
     real(kind=DEFAULT_PRECISION) :: czn, zlogm, zlogth, vk_on_zlogm
     integer, dimension(:), allocatable :: kgd
     integer :: kdmpmin
  end type vertical_grid_configuration_type

  type, public :: grid_configuration_type
     type(horizontal_grid_configuration_type) :: horizontal
     type(vertical_grid_configuration_type) :: vertical
  end type grid_configuration_type

  type, public :: global_grid_type
     type(grid_configuration_type) :: configuration
     real(kind=DEFAULT_PRECISION), dimension(3) :: bottom,&     !< Bottom (lowest) bounds in each dimension
          top,&        !< Top (highest) bounds in each dimension
          resolution
     integer, dimension(3) ::    size
     logical, dimension(3) :: active = (/ .false., .false., .false. /) 
     integer :: dimensions = 0
  end type global_grid_type

  type, public :: local_grid_type
     integer, dimension(3) :: start,& !< Global start coordinates of local grid
          end,& !< Global end coordinates of local grid
          size,& !< Grid points held locally
          halo_size,& !< Grid point size of the halo (halo_depth)
          local_domain_start_index,& !< The start index of computation data (local data is halo->data->halo so this precomputes the data start)
          local_domain_end_index
     logical, dimension(3) :: active = (/ .false., .false., .false. /) 
     integer, dimension(:,:), allocatable :: neighbours , corner_neighbours
     integer :: dimensions = 0
  end type local_grid_type
end module grids_mod