viscosity.F90

Go to the documentation of this file.

module viscosity_mod
  use datadefn_mod, only : default_precision
  use monc_component_mod, only : component_array_field_type, component_double_data_type, component_descriptor_type, &
       component_field_value_type, component_field_information_type
  use state_mod, only : forward_stepping, model_state_type
  use prognostics_mod, only : prognostic_field_type
  use grids_mod, only : z_index, x_index, y_index
  use communication_types_mod, only : halo_communication_type, neighbour_description_type, field_data_wrapper_type
  use halo_communication_mod, only : copy_buffer_to_field, perform_local_data_copy_for_field, complete_nonblocking_halo_swap, &
       copy_buffer_to_corner
  use registry_mod, only : is_component_enabled
  use logging_mod, only : log_error, log_warn, log_master_log
  implicit none

#ifndef TEST_MODE
  private
#endif

  real(kind=DEFAULT_PRECISION), dimension(:), allocatable :: u_viscosity, v_viscosity, w_viscosity

  public viscosity_get_descriptor

contains

  type(component_descriptor_type) function viscosity_get_descriptor()
    viscosity_get_descriptor%name="viscosity"
    viscosity_get_descriptor%version=0.1
    viscosity_get_descriptor%initialisation=>initialisation_callback
    viscosity_get_descriptor%timestep=>timestep_callback
    viscosity_get_descriptor%finalisation=>finalisation_callback

    viscosity_get_descriptor%field_value_retrieval=>field_value_retrieval_callback
    viscosity_get_descriptor%field_information_retrieval=>field_information_retrieval_callback
    allocate(viscosity_get_descriptor%published_fields(3))
    viscosity_get_descriptor%published_fields(1)="u_viscosity"
    viscosity_get_descriptor%published_fields(2)="v_viscosity"
    viscosity_get_descriptor%published_fields(3)="w_viscosity"
  end function viscosity_get_descriptor

  subroutine field_information_retrieval_callback(current_state, name, field_information)
    type(model_state_type), target, intent(inout) :: current_state
    character(len=*), intent(in) :: name
    type(component_field_information_type), intent(out) :: field_information

    ! Field description is the same regardless of the specific field being retrieved
    field_information%field_type=component_array_field_type
    field_information%data_type=component_double_data_type
    field_information%number_dimensions=1
    field_information%dimension_sizes(1)=current_state%local_grid%size(z_index)
    field_information%enabled=.true.
  end subroutine field_information_retrieval_callback

  subroutine field_value_retrieval_callback(current_state, name, field_value)
    type(model_state_type), target, intent(inout) :: current_state
    character(len=*), intent(in) :: name
    type(component_field_value_type), intent(out) :: field_value
    
    if (name .eq. "u_viscosity") then
      allocate(field_value%real_1d_array(size(u_viscosity)), source=u_viscosity)
    else if (name .eq. "v_viscosity") then
      allocate(field_value%real_1d_array(size(v_viscosity)), source=v_viscosity)
    else if (name .eq. "w_viscosity") then
      allocate(field_value%real_1d_array(size(w_viscosity)), source=w_viscosity)
    end if
  end subroutine field_value_retrieval_callback

  subroutine initialisation_callback(current_state)
    type(model_state_type), target, intent(inout) :: current_state

    integer :: z_size, y_size, x_size

    z_size=current_state%local_grid%size(z_index) + current_state%local_grid%halo_size(z_index) * 2
    y_size=current_state%local_grid%size(y_index) + current_state%local_grid%halo_size(y_index) * 2
    x_size=current_state%local_grid%size(x_index) + current_state%local_grid%halo_size(x_index) * 2
    allocate(current_state%vis_coefficient%data(z_size, y_size, x_size))

    z_size=current_state%global_grid%size(z_index)
    allocate(u_viscosity(z_size), v_viscosity(z_size), w_viscosity(z_size))
   
  end subroutine initialisation_callback

  subroutine finalisation_callback(current_state)
    type(model_state_type), target, intent(inout) :: current_state

    if (allocated(u_viscosity)) deallocate(u_viscosity)
    if (allocated(v_viscosity)) deallocate(v_viscosity)
    if (allocated(w_viscosity)) deallocate(w_viscosity)
  end subroutine finalisation_callback  

  subroutine timestep_callback(current_state)
    type(model_state_type), target, intent(inout) :: current_state

    integer :: local_y, locaL_x, k
    real(kind=DEFAULT_PRECISION), dimension(current_state%local_grid%size(Z_INDEX)) :: tau12, tau12_ym1, tau12m1, &
         tau11, tau22, tau22_yp1, tau33, tau23_ym1, tau11p1, tau13, tau13m1, tau23

    if (.not. current_state%use_viscosity_and_diffusion .or. current_state%halo_column) return
    if (current_state%viscosity_halo_swap_state%swap_in_progress) then
      ! If there is a viscosity halo swap in progress then complete it
      call complete_nonblocking_halo_swap(current_state, current_state%viscosity_halo_swap_state, &
           perform_local_data_copy_for_vis, copy_halo_buffer_to_vis, copy_halo_buffer_to_vis_corners)
    end if

    local_y=current_state%column_local_y
    local_x=current_state%column_local_x
    if (current_state%field_stepping == forward_stepping) then
      call calculate_tau(current_state, local_y, local_x, current_state%u, current_state%v, current_state%w, tau12, tau12_ym1, &
           tau12m1, tau11, tau22, tau22_yp1, tau33, tau11p1, tau13, tau13m1, tau23, tau23_ym1)
    else
      call calculate_tau(current_state, local_y, local_x, current_state%zu, current_state%zv, current_state%zw, tau12, tau12_ym1, &
           tau12m1, tau11, tau22, tau22_yp1, tau33, tau11p1, tau13, tau13m1, tau23, tau23_ym1)
    end if
    call calculate_viscous_sources(current_state, local_y, local_x, tau12, tau12_ym1, tau12m1, tau11, tau22, tau22_yp1, tau33, &
         tau11p1, tau13, tau13m1, tau23, tau23_ym1)
  end subroutine timestep_callback

  subroutine calculate_viscous_sources(current_state, local_y, local_x, tau12, tau12_ym1, tau12m1, &
       tau11, tau22, tau22_yp1, tau33, tau11p1, tau13, tau13m1, tau23, tau23_ym1)
    type(model_state_type), target, intent(inout) :: current_state
    integer, intent(in) :: local_y, local_x
    real(kind=DEFAULT_PRECISION), dimension(:), intent(in) :: tau12, tau12_ym1, tau12m1, tau11, tau22, tau22_yp1, tau33, &
         tau11p1, tau13, tau13m1, tau23, tau23_ym1

    integer :: k

    do k=2, current_state%local_grid%size(z_index)
#ifdef U_ACTIVE
      u_viscosity(k)=((tau11p1(k)-tau11(k))*current_state%global_grid%configuration%horizontal%cx+(tau12(k)-tau12_ym1(k))*&
           current_state%global_grid%configuration%horizontal%cy+(tau13(k)-tau13(k-1))*&
           current_state%global_grid%configuration%vertical%rdz(k))/current_state%global_grid%configuration%vertical%rhon(k)
      current_state%su%data(k, local_y, local_x)=current_state%su%data(k, local_y, local_x)+u_viscosity(k)
#endif
#ifdef V_ACTIVE
      v_viscosity(k)=((tau12(k)-tau12m1(k))*current_state%global_grid%configuration%horizontal%cx+(tau22_yp1(k)-tau22(k))*&
           current_state%global_grid%configuration%horizontal%cy+(tau23(k)-tau23(k-1))*&
           current_state%global_grid%configuration%vertical%rdz(k))/current_state%global_grid%configuration%vertical%rhon(k)
      current_state%sv%data(k, local_y, local_x)=current_state%sv%data(k, local_y, local_x)+v_viscosity(k)
#endif
    end do
#ifdef W_ACTIVE
    do k=2, current_state%local_grid%size(z_index)-1
      w_viscosity(k)=((tau13(k)-tau13m1(k))*current_state%global_grid%configuration%horizontal%cx+(tau23(k)-tau23_ym1(k))*&
           current_state%global_grid%configuration%horizontal%cy+(tau33(k+1)-tau33(k))*&
           current_state%global_grid%configuration%vertical%rdzn(k+1))/current_state%global_grid%configuration%vertical%rho(k)
      current_state%sw%data(k, local_y, local_x)=current_state%sw%data(k, local_y, local_x)+w_viscosity(k)
    end do
#endif
  end subroutine calculate_viscous_sources  

  subroutine calculate_tau(current_state, local_y, local_x, zu, zv, zw, tau12, tau12_ym1, tau12m1, tau11, &
       tau22, tau22_yp1, tau33, tau11p1, tau13, tau13m1, tau23, tau23_ym1)
    type(model_state_type), target, intent(inout) :: current_state
    type(prognostic_field_type), intent(inout) :: zu, zv, zw
    integer, intent(in) :: local_y, local_x
    real(kind=DEFAULT_PRECISION), dimension(:), intent(out) :: tau12, tau12m1, tau11, tau22, tau22_yp1, tau33, &
         tau11p1, tau13, tau13m1, tau23, tau23_ym1, tau12_ym1

    integer :: k
    real(kind=DEFAULT_PRECISION) :: vistmp, vis12, vis12a, visonp2, visonp2a, vis13, vis23
    
    ! Do p levels and w-levels
    do k=1, current_state%local_grid%size(z_index)     
      if (k .gt. 1) then
        vistmp=current_state%vis_coefficient%data(k, local_y, local_x)+current_state%vis_coefficient%data(k, local_y+1, local_x)+&
             current_state%vis_coefficient%data(k-1, local_y, local_x)+current_state%vis_coefficient%data(k-1, local_y+1, local_x)
        vis12=0.125_default_precision*(vistmp + current_state%vis_coefficient%data(k, local_y, local_x+1)+&
             current_state%vis_coefficient%data(k, local_y+1, local_x+1)+&
             current_state%vis_coefficient%data(k-1, local_y, local_x+1)+&
             current_state%vis_coefficient%data(k-1, local_y+1, local_x+1))
        tau12(k)=0.0_default_precision
#ifdef U_ACTIVE
        tau12(k)=(zu%data(k, local_y+1, local_x)-zu%data(k, local_y, local_x))*&
             current_state%global_grid%configuration%horizontal%cy
#endif
#ifdef V_ACTIVE
        tau12(k)=tau12(k)+(zv%data(k, local_y, local_x+1)-zv%data(k, local_y, local_x))*&
             current_state%global_grid%configuration%horizontal%cx
#endif
        tau12(k)=tau12(k)*current_state%global_grid%configuration%vertical%rhon(k)*vis12
        
        vis12a=0.125_default_precision*(vistmp +current_state%vis_coefficient%data(k, local_y, local_x-1)+&
             current_state%vis_coefficient%data(k, local_y+1, local_x-1)+&
             current_state%vis_coefficient%data(k-1, local_y, local_x-1)+&
             current_state%vis_coefficient%data(k-1, local_y+1, local_x-1))
        tau12m1(k)=0.0_default_precision
#ifdef U_ACTIVE
        tau12m1(k)=(zu%data(k, local_y+1, local_x-1)-zu%data(k, local_y, local_x-1))*&
             current_state%global_grid%configuration%horizontal%cy
#endif
#ifdef V_ACTIVE
        tau12m1(k)=tau12m1(k)+(zv%data(k, local_y, local_x)-zv%data(k, local_y, local_x-1))*&
             current_state%global_grid%configuration%horizontal%cx
#endif
        tau12m1(k)=tau12m1(k)*current_state%global_grid%configuration%vertical%rhon(k)*vis12a

        vistmp=current_state%vis_coefficient%data(k, local_y-1, local_x)+current_state%vis_coefficient%data(k, local_y, local_x)+&
             current_state%vis_coefficient%data(k-1, local_y-1, local_x)+current_state%vis_coefficient%data(k-1, local_y, local_x)
        vis12=0.125_default_precision*(vistmp + current_state%vis_coefficient%data(k, local_y-1, local_x+1)+&
             current_state%vis_coefficient%data(k, local_y, local_x+1)+&
             current_state%vis_coefficient%data(k-1, local_y-1, local_x+1)+&
             current_state%vis_coefficient%data(k-1, local_y, local_x+1))
        tau12_ym1(k)=0.0_default_precision
#ifdef U_ACTIVE
        tau12_ym1(k)=(zu%data(k, local_y, local_x)-zu%data(k, local_y-1, local_x))*&
             current_state%global_grid%configuration%horizontal%cy
#endif
#ifdef V_ACTIVE
        tau12_ym1(k)=tau12_ym1(k)+(zv%data(k, local_y-1, local_x+1)-zv%data(k, local_y-1, local_x))*&
             current_state%global_grid%configuration%horizontal%cx
#endif
        tau12_ym1(k)=tau12_ym1(k)*current_state%global_grid%configuration%vertical%rhon(k)*vis12

        visonp2=current_state%global_grid%configuration%vertical%rhon(k)*&
             (current_state%vis_coefficient%data(k, local_y, local_x)+current_state%vis_coefficient%data(k-1, local_y, local_x))
#ifdef U_ACTIVE
        tau11(k)=visonp2*(zu%data(k, local_y, local_x)-zu%data(k, local_y, local_x-1))*&
             current_state%global_grid%configuration%horizontal%cx
#else
        tau11(k)=0.0_default_precision
#endif
#ifdef V_ACTIVE
        tau22(k)=visonp2*(zv%data(k, local_y, local_x)-zv%data(k, local_y-1, local_x))*&
             current_state%global_grid%configuration%horizontal%cy
#else
        tau22(k)=0.0_default_precision
#endif
#ifdef W_ACTIVE
        tau33(k)=visonp2*(zw%data(k, local_y, local_x)-zw%data(k-1, local_y, local_x))*&
             current_state%global_grid%configuration%vertical%rdz(k)
#else
        tau33(k)=0.0_default_precision
#endif

#ifdef V_ACTIVE
        visonp2=current_state%global_grid%configuration%vertical%rhon(k)*&
             (current_state%vis_coefficient%data(k, local_y+1, local_x)+&
             current_state%vis_coefficient%data(k-1, local_y+1, local_x))
        tau22_yp1(k)=visonp2*(zv%data(k, local_y+1, local_x)-zv%data(k, local_y, local_x))*&
             current_state%global_grid%configuration%horizontal%cy
#endif

#ifdef U_ACTIVE
        visonp2a=current_state%global_grid%configuration%vertical%rhon(k)*&
             (current_state%vis_coefficient%data(k, local_y, local_x+1)+&
             current_state%vis_coefficient%data(k-1, local_y, local_x+1))
        tau11p1(k)=visonp2a*(current_state%zu%data(k, local_y, local_x+1)-&
             zu%data(k, local_y, local_x))*current_state%global_grid%configuration%horizontal%cx
#endif
      else
        tau12(k)=0.0_default_precision
        tau12_ym1(k)=0.0_default_precision
        tau12m1(k)=0.0_default_precision
        tau11(k)=0.0_default_precision
        tau22(k)=0.0_default_precision
        tau22_yp1(k)=0.0_default_precision
        tau33(k)=0.0_default_precision
        tau11p1(k)=0.0_default_precision
      end if
      if (k .lt. current_state%local_grid%size(z_index)) then
        vis13=0.5_default_precision*(current_state%vis_coefficient%data(k, local_y, local_x)+&
             current_state%vis_coefficient%data(k, local_y, local_x+1))
        tau13(k)=0.0_default_precision
#ifdef U_ACTIVE
        tau13(k)=(zu%data(k+1, local_y, local_x)-zu%data(k, local_y, local_x))*&
             current_state%global_grid%configuration%vertical%rdzn(k+1)
#endif
#ifdef W_ACTIVE
        tau13(k)=tau13(k)+(zw%data(k, local_y, local_x+1)-zw%data(k, local_y, local_x))*&
             current_state%global_grid%configuration%horizontal%cx
#endif
        tau13(k)=tau13(k)*current_state%global_grid%configuration%vertical%rho(k)*vis13

        vis13=0.5_default_precision*(current_state%vis_coefficient%data(k, local_y, local_x-1)+&
             current_state%vis_coefficient%data(k, local_y, local_x))
        tau13m1(k)=0.0_default_precision
#ifdef U_ACTIVE
        tau13m1(k)=(zu%data(k+1, local_y, local_x-1)-zu%data(k, local_y, local_x-1))*&
             current_state%global_grid%configuration%vertical%rdzn(k+1)
#endif
#ifdef W_ACTIVE
        tau13m1(k)=tau13m1(k)+(zw%data(k, local_y, local_x)-zw%data(k, local_y, local_x-1))*&
             current_state%global_grid%configuration%horizontal%cx
#endif
        tau13m1(k)=tau13m1(k)*current_state%global_grid%configuration%vertical%rho(k)*vis13

        vis23=0.5_default_precision*(current_state%vis_coefficient%data(k, local_y, local_x)+&
             current_state%vis_coefficient%data(k, local_y+1, local_x))
        tau23(k)=0.0_default_precision
#ifdef W_ACTIVE
        tau23(k)=(zw%data(k, local_y+1, local_x)-zw%data(k, local_y, local_x))*&
             current_state%global_grid%configuration%horizontal%cy
#endif
#ifdef V_ACTIVE
        tau23(k)=tau23(k)+(zv%data(k+1, local_y, local_x)-zv%data(k, local_y, local_x))*&
             current_state%global_grid%configuration%vertical%rdzn(k+1)
#endif
        tau23(k)=tau23(k)*current_state%global_grid%configuration%vertical%rho(k)*vis23

        vis23=0.5_default_precision*(current_state%vis_coefficient%data(k, local_y-1, local_x)+&
             current_state%vis_coefficient%data(k, local_y, local_x))
        tau23_ym1(k)=0.0_default_precision
#ifdef W_ACTIVE
        tau23_ym1(k)=(zw%data(k, local_y, local_x)-zw%data(k, local_y-1, local_x))*&
             current_state%global_grid%configuration%horizontal%cy
#endif
#ifdef V_ACTIVE
        tau23_ym1(k)=tau23_ym1(k)+(zv%data(k+1, local_y-1, local_x)-zv%data(k, local_y-1, local_x))*&
             current_state%global_grid%configuration%vertical%rdzn(k+1)
#endif
        tau23_ym1(k)=tau23_ym1(k)*current_state%global_grid%configuration%vertical%rho(k)*vis23
      else
        tau13(k)=0.0_default_precision
        tau13m1(k)=0.0_default_precision
        tau23(k)=0.0_default_precision
        tau23_ym1(k)=0.0_default_precision
      end if
    end do
  end subroutine calculate_tau  

  subroutine perform_local_data_copy_for_vis(current_state, halo_depth, involve_corners, source_data)
    type(model_state_type), intent(inout) :: current_state
    integer, intent(in) :: halo_depth
    logical, intent(in) :: involve_corners
    type(field_data_wrapper_type), dimension(:), intent(in), optional :: source_data

    call perform_local_data_copy_for_field(current_state%vis_coefficient%data, current_state%local_grid, &
         current_state%parallel%my_rank, halo_depth, involve_corners)
  end subroutine perform_local_data_copy_for_vis

  subroutine copy_halo_buffer_to_vis(current_state, neighbour_description, dim, target_index, &
       neighbour_location, current_page, source_data)
    type(model_state_type), intent(inout) :: current_state
    integer, intent(in) :: dim, target_index, neighbour_location
    integer, intent(inout) :: current_page(:)
    type(neighbour_description_type), intent(inout) :: neighbour_description
    type(field_data_wrapper_type), dimension(:), intent(in), optional :: source_data

    call copy_buffer_to_field(current_state%local_grid, neighbour_description%recv_halo_buffer, &
         current_state%vis_coefficient%data, dim, target_index, current_page(neighbour_location))

    current_page(neighbour_location)=current_page(neighbour_location)+1
  end subroutine copy_halo_buffer_to_vis

  subroutine copy_halo_buffer_to_vis_corners(current_state, neighbour_description, corner_loc, x_target_index, &
       y_target_index, neighbour_location, current_page, source_data)
    type(model_state_type), intent(inout) :: current_state
    integer, intent(in) :: corner_loc, x_target_index, y_target_index, neighbour_location
    integer, intent(inout) :: current_page(:)
    type(neighbour_description_type), intent(inout) :: neighbour_description
    type(field_data_wrapper_type), dimension(:), intent(in), optional :: source_data

    call copy_buffer_to_corner(current_state%local_grid, neighbour_description%recv_corner_buffer, &
         current_state%vis_coefficient%data, corner_loc, x_target_index, y_target_index, current_page(neighbour_location))

    current_page(neighbour_location)=current_page(neighbour_location)+1
  end subroutine copy_halo_buffer_to_vis_corners  
end module viscosity_mod