mod_atmos_dyn_vars.F90

Go to the documentation of this file.

!-------------------------------------------------------------------------------
!> module Atmosphere / Dynamics
!!
!! @par Description
!!          Container for variables with dynamics component
!!
!! @author Yuta Kawai, Team SCALE
!!
!<
!-------------------------------------------------------------------------------
#include "scaleFElib.h"
module mod_atmos_dyn_vars
  !-----------------------------------------------------------------------------
  !
  !++ Used modules
  !
  use scale_precision
  use scale_io
  use scale_prc
 
  use scale_element_base, only: elementbase3d
  use scale_localmesh_base, only: localmeshbase
  use scale_localmesh_2d, only: localmesh2d
  use scale_localmesh_3d, only: localmesh3d
  use scale_mesh_base, only: meshbase
  use scale_mesh_base2d, only: meshbase2d  
  use scale_mesh_base3d, only: meshbase3d
 
  use scale_meshfield_base, only: meshfield3d, meshfield2d
  use scale_localmeshfield_base, only: localmeshfieldbase
 
  use scale_meshfieldcomm_base, only: meshfieldcontainer
  
  use scale_model_var_manager, only: &
    modelvarmanager, variableinfo
  use scale_model_meshbase_manager, only: modelmeshbase
 
  use mod_atmos_mesh, only: atmosmesh
    
  !-----------------------------------------------------------------------------
  implicit none
  private
 
  !-----------------------------------------------------------------------------
  !
  !++ Public type & procedures
  !
 
  !> Derived type to manage variables with atmospheric dynamics component
  type, public :: atmosdynvars
    type(meshfield2d), allocatable :: aux_vars2d(:) !< Array of 2D auxiliary variables
    type(modelvarmanager) :: auxvars2d_manager      !< Object to manage 2D auxiliary variables
  contains
    procedure :: init => atmosdynvars_init
    procedure :: final => atmosdynvars_final
    procedure :: history => atmosdynvars_history
  end type atmosdynvars
 
  public :: atmosdynauxvars_getlocalmeshfields
  !public :: AtmosDynVars_GetLocalMeshFields_analysis
 
  !-----------------------------------------------------------------------------
  !
  !++ Public parameters & variables
  !
 
  !-
  integer, public, parameter :: atmos_dyn_auxvars2d_num          = 1
  integer, public, parameter :: atmos_dyn_auxvars2d_coriolis_id  = 1
 
  type(variableinfo), public :: atmos_dyn_auxvars2d_vinfo(atmos_dyn_auxvars2d_num)
  DATA atmos_dyn_auxvars2d_vinfo / &
    variableinfo( atmos_dyn_auxvars2d_coriolis_id, 'CORIOLIS', 'coriolis parameter',  &
                  's-1',  2, 'XY',  ''                                             )  / 
 
 
  ! integer, public, parameter :: ATMOS_DYN_ANALYSISVARS_NUM          = 6
  ! integer, public, parameter :: ATMOS_DYN_ANALYSISVAR_MOMZ_t        = 1
  ! integer, public, parameter :: ATMOS_DYN_ANALYSISVAR_MOMZ_t_advX   = 2
  ! integer, public, parameter :: ATMOS_DYN_ANALYSISVAR_MOMZ_t_advY   = 3
  ! integer, public, parameter :: ATMOS_DYN_ANALYSISVAR_MOMZ_t_advZ   = 4
  ! integer, public, parameter :: ATMOS_DYN_ANALYSISVAR_MOMZ_t_lift   = 5
  ! integer, public, parameter :: ATMOS_DYN_ANALYSISVAR_MOMZ_t_buoy   = 6
 
  ! type(VariableInfo), public :: ATMOS_DYN_ANALYSISVAR_VINFO(ATMOS_DYN_ANALYSISVARS_NUM)
  ! DATA ATMOS_DYN_ANALYSISVAR_VINFO / &
  !   VariableInfo( ATMOS_DYN_ANALYSISVAR_MOMZ_t, 'MOMZ_t', 'MOMZ_t',    &
  !                 'kg.m-2.s-1',  3, 'XYZ',  ''                      ), & 
  !   VariableInfo( ATMOS_DYN_ANALYSISVAR_MOMZ_t_advX, 'MOMZ_t_advx', 'MOMZ_t_advX',  &
  !                 'kg.m-2.s-1',  3, 'XYZ',  ''                      ), & 
  !   VariableInfo( ATMOS_DYN_ANALYSISVAR_MOMZ_t_advY, 'MOMZ_t_advy', 'MOMZ_t_advY',  &
  !                 'kg.m-2.s-1',  3, 'XYZ',  ''                      ), & 
  !   VariableInfo( ATMOS_DYN_ANALYSISVAR_MOMZ_t_advZ, 'MOMZ_t_advz', 'MOMZ_t_advZ',  &
  !                 'kg.m-2.s-1',  3, 'XYZ',  ''                      ), & 
  !   VariableInfo( ATMOS_DYN_ANALYSISVAR_MOMZ_t_lift, 'MOMZ_t_lift', 'MOMZ_t_lift',  &
  !                 'kg.m-2.s-1',  3, 'XYZ',  ''                      ), & 
  !   VariableInfo( ATMOS_DYN_ANALYSISVAR_MOMZ_t_buoy, 'MOMZ_t_buoy', 'MOMZ_t_buo',    &
  !                 'kg.m-2.s-1',  3, 'XYZ',  ''                      ) & 
  ! / 
  
  !-----------------------------------------------------------------------------
  !
  !++ Private procedures
  !
  !-------------------
 
contains
 
!> Setup an object to manage variables with atmospheric dynamics component
!!
!! @param model_mesh Object to manage computational mesh of atmospheric model 
!!
!OCL SERIAL
  subroutine atmosdynvars_init( this, model_mesh )
    use scale_localmeshfield_base, only: local_meshfield_type_nodes_faceval
    implicit none
    class(atmosdynvars), target, intent(inout) :: this
    class(modelmeshbase), target, intent(in) :: model_mesh
 
    integer :: v
    integer :: n
    logical :: reg_file_hist
 
    class(atmosmesh), pointer :: atm_mesh
    class(meshbase2d), pointer :: mesh2d
    class(meshbase3d), pointer :: mesh3d
 
    !--------------------------------------------------
 
    log_info('AtmosDynVars_Init',*)
 
    nullify( atm_mesh )
    select type(model_mesh)
    class is (atmosmesh)
      atm_mesh => model_mesh
    end select
    mesh3d => atm_mesh%ptr_mesh
    
    call mesh3d%GetMesh2D( mesh2d )
 
    !- Initialize 2D auxiliary variables
 
    call this%AUXVARS2D_manager%Init()
    allocate( this%AUX_VARS2D(atmos_dyn_auxvars2d_num) )
 
    reg_file_hist = .false.    
    do v = 1, atmos_dyn_auxvars2d_num
      call this%AUXVARS2D_manager%Regist(                   &
        atmos_dyn_auxvars2d_vinfo(v), mesh2d,               & ! (in) 
        this%AUX_VARS2D(v), reg_file_hist                   ) ! (out)
      
      do n = 1, mesh3d%LOCAL_MESH_NUM
        this%AUX_VARS2D(v)%local(n)%val(:,:) = 0.0_rp
      end do         
    end do
 
    !-
    ! call this%ANALYSISVARS_manager%Init()
    ! allocate( this%ANALYSIS_VARS3D(ATMOS_DYN_ANALYSISVARS_NUM) )
 
    ! reg_file_hist = .true.
    ! do v = 1, ATMOS_DYN_ANALYSISVARS_NUM
    !   call this%ANALYSISVARS_manager%Regist( &
    !     ATMOS_DYN_ANALYSISVAR_VINFO(v), atm_mesh%mesh, &
    !     this%ANALYSIS_VARS3D(v), reg_file_hist )
    ! end do
 
    return
  end subroutine atmosdynvars_init
 
!> Finalize an object to manage variables with atmospheric dynamics component
  subroutine atmosdynvars_final( this )
    implicit none
    class(atmosdynvars), intent(inout) :: this
 
    !--------------------------------------------------
 
    log_info('AtmosDynVars_Final',*)
 
    call this%AUXVARS2D_manager%Final()
    deallocate( this%AUX_VARS2D )
    
    !call this%ANALYSISVARS_manager%Final()
 
    return
  end subroutine atmosdynvars_final
 
  subroutine atmosdynvars_history( this )
    use scale_file_history_meshfield, only: file_history_meshfield_put
    implicit none
    class(atmosdynvars), intent(in) :: this
 
    ! integer :: v
    ! integer :: hst_id
    !-------------------------------------------------------------------------
 
    ! do v = 1, ATMOS_DYN_ANALYSISVARS_NUM
    !   hst_id = this%ANALYSIS_VARS3D(v)%hist_id
    !   if ( hst_id > 0 ) call FILE_HISTORY_meshfield_put( hst_id, this%ANALYSIS_VARS3D(v) )
    ! end do
    
    return
  end subroutine atmosdynvars_history
 
  subroutine atmosdynauxvars_getlocalmeshfields( domID, mesh, auxvars_list, &
    Coriolis,                                                               &
    lcmesh3D                                                                &
    )
 
    use scale_mesh_base, only: meshbase
    use scale_meshfield_base, only: meshfieldbase
    implicit none
 
    integer, intent(in) :: domid
    class(meshbase), intent(in) :: mesh
    class(modelvarmanager), intent(inout) :: auxvars_list
    class(localmeshfieldbase), pointer, intent(out) :: coriolis
    class(localmesh3d), pointer, intent(out), optional :: lcmesh3d
 
    class(meshfieldbase), pointer :: field   
    class(localmeshbase), pointer :: lcmesh
    !-------------------------------------------------------
 
    !--
    call auxvars_list%Get(atmos_dyn_auxvars2d_coriolis_id, field)
    call field%GetLocalMeshField(domid, coriolis)
    !---
    
    if (present(lcmesh3d)) then
      call mesh%GetLocalMesh( domid, lcmesh )
      nullify( lcmesh3d )
 
      select type(lcmesh)
      type is (localmesh3d)
        if (present(lcmesh3d)) lcmesh3d => lcmesh
      end select
    end if
 
    return
  end subroutine atmosdynauxvars_getlocalmeshfields
 
  ! subroutine AtmosDynVars_GetLocalMeshFields_analysis( domID, mesh, analysis_list, &
  !   MOMZ_t, MOMZ_t_advx, MOMZ_t_advY, MOMZ_t_advZ, MOMZ_t_lift, MOMZ_t_buoy,       &
  !   lcmesh3D                                                             &
  !   )
 
  !   use scale_mesh_base, only: MeshBase
  !   use scale_meshfield_base, only: MeshFieldBase
  !   implicit none
 
  !   integer, intent(in) :: domID
  !   class(MeshBase), intent(in) :: mesh
  !   class(ModelVarManager), intent(inout) :: analysis_list
  !   class(LocalMeshFieldBase), pointer, intent(out) :: &
  !     MOMZ_t, MOMZ_t_advx, MOMZ_t_advY, MOMZ_t_advZ, MOMZ_t_lift, MOMZ_t_buoy
  !   class(LocalMesh3D), pointer, intent(out), optional :: lcmesh3D
 
  !   class(MeshFieldBase), pointer :: field   
  !   class(LocalMeshBase), pointer :: lcmesh
  !   !-------------------------------------------------------
 
  !   !--
  !   call analysis_list%Get(ATMOS_DYN_ANALYSISVAR_MOMZ_t, field)
  !   call field%GetLocalMeshField(domID, MOMZ_t)
  !   !---
  !   call analysis_list%Get(ATMOS_DYN_ANALYSISVAR_MOMZ_t_advx, field)
  !   call field%GetLocalMeshField(domID, MOMZ_t_advx)
  !   !---
  !   call analysis_list%Get(ATMOS_DYN_ANALYSISVAR_MOMZ_t_advy, field)
  !   call field%GetLocalMeshField(domID, MOMZ_t_advy)
  !   !---
  !   call analysis_list%Get(ATMOS_DYN_ANALYSISVAR_MOMZ_t_advz, field)
  !   call field%GetLocalMeshField(domID, MOMZ_t_advz)
  !   !---
  !   call analysis_list%Get(ATMOS_DYN_ANALYSISVAR_MOMZ_t_lift, field)
  !   call field%GetLocalMeshField(domID, MOMZ_t_lift)
  !   !---
  !   call analysis_list%Get(ATMOS_DYN_ANALYSISVAR_MOMZ_t_buoy, field)
  !   call field%GetLocalMeshField(domID, MOMZ_t_buoy)
 
    
  !   if (present(lcmesh3D)) then
  !     call mesh%GetLocalMesh( domID, lcmesh )
  !     nullify( lcmesh3D )
 
  !     select type(lcmesh)
  !     type is (LocalMesh3D)
  !       if (present(lcmesh3D)) lcmesh3D => lcmesh
  !     end select
  !   end if
 
  !   return
  ! end subroutine AtmosDynVars_GetLocalMeshFields_analysis
 
 
end module mod_atmos_dyn_vars