DYCORE_typedefs.F90

Go to the documentation of this file.

!***********************************************************************
!*                   GNU Lesser General Public License
!*
!* This file is part of the FV3 dynamical core.
!*
!* The FV3 dynamical core 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.
!*
!* The FV3 dynamical core is distributed in the hope that it will be
!* useful, but WITHOUT ANYWARRANTY; 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 the FV3 dynamical core.
!* If not, see <http://www.gnu.org/licenses/>.
!***********************************************************************
module dycore_typedefs


  use platform_mod, only: r8_kind

  !--- parameter constants used for default initializations
  real(kind=r8_kind), parameter :: zero      = 0.0_r8_kind
  real(kind=r8_kind), parameter :: huge      = 9.9999d15
  real(kind=r8_kind), parameter :: clear_val = zero

  type var_subtype
    real(kind=r8_kind), pointer :: var2p(:)   => null()  
    real(kind=r8_kind), pointer :: var3p(:,:) => null()  
  end type var_subtype


!---------------------------------------------------------------------
! DYCORE_coupling_type
!   fields to/from other coupled components (e.g. land/ice/ocean/etc.)
!---------------------------------------------------------------------
  type dycore_coupling_type

    !--- surface pressure
    real (kind=r8_kind), pointer :: p_srf(:) => null()

    !--- bottom layer temperature, pressure, winds, and height
    real (kind=r8_kind), pointer :: t_bot(:) => null()
    real (kind=r8_kind), pointer :: p_bot(:) => null()
    real (kind=r8_kind), pointer :: u_bot(:) => null()
    real (kind=r8_kind), pointer :: v_bot(:) => null()
    real (kind=r8_kind), pointer :: z_bot(:) => null()

    !--- sea-level pressure
    real (kind=r8_kind), pointer :: slp(:) => null()

    !--- bottom layer tracers
    real (kind=r8_kind), pointer :: tr_bot(:,:) => null()

    !--- outgoing accumulated quantities
    contains
      procedure :: create  => coupling_create  
  end type dycore_coupling_type

!-------------------------------------------------------------
! DYCORE_diag_type
!  diagnostic type to be used with an external write component
!-------------------------------------------------------------
  type dycore_diag_type
    character(len=32)   :: name
    character(len=32)   :: output_name
    character(len=32)   :: mod_name
    character(len=32)   :: file_name
    character(len=128)  :: desc
    character(len=32)   :: unit
    character(len=32)   :: type_stat_proc
                                          !minimal, etc.
    character(len=32)   :: level_type
    integer             :: level
    real(kind=r8_kind)  :: cnvfac
    real(kind=r8_kind)  :: zhour
    real(kind=r8_kind)  :: fcst_hour
    type(var_subtype), allocatable :: data(:)
    contains
      procedure :: create => diag_create
      procedure :: zero   => diag_zero
  end type dycore_diag_type


!----------------------
! DYCORE_Data container
!----------------------
  type dycore_data_type
    type(dycore_coupling_type) :: coupling
!   type(xxxxxxxx_type) :: Xxxxxxxx
  end type dycore_data_type

!----------------
! PUBLIC ENTITIES
!----------------
  public dycore_data_type, dycore_diag_type

!*******************************************************************************************
  CONTAINS


!------------------------
! DYCORE_coupling_type%create
!------------------------
  subroutine coupling_create (Coupling, IM, Ntracers)
    implicit none

    class(DYCORE_coupling_type)            :: Coupling
    integer,                    intent(in) :: IM
    integer,                    intent(in) :: Ntracers

    !--- surface pressure
    allocate (coupling%p_srf (im))
    coupling%p_srf = clear_val

    !--- bottom layer temperature, pressure, winds, and height
    allocate (coupling%t_bot (im))
    allocate (coupling%p_bot (im))
    allocate (coupling%u_bot (im))
    allocate (coupling%v_bot (im))
    allocate (coupling%z_bot (im))
    coupling%t_bot = clear_val
    coupling%p_bot = clear_val
    coupling%u_bot = clear_val
    coupling%v_bot = clear_val
    coupling%z_bot = clear_val

    !--- sea-level pressure
    allocate (coupling%slp (im))
    coupling%slp = clear_val

    !--- bottom layer tracers
    allocate (coupling%tr_bot (im,ntracers))
    coupling%tr_bot = clear_val

  end subroutine coupling_create


!------------------------
! DYCORE_diag_type%create
!------------------------
  subroutine diag_create (Diag, IM, Ntracers)
    implicit none

    class(DYCORE_diag_type)            :: Diag
    integer,                intent(in) :: IM
    integer,                intent(in) :: Ntracers

  end subroutine diag_create


!------------------------
! DYCORE_diag_type%zero
!------------------------
  subroutine diag_zero (Diag)
    implicit none

    class(DYCORE_diag_type)            :: Diag

  end subroutine diag_zero 

end module dycore_typedefs