diffusion_mod Module Reference

Diffusion on the TH and Q fields. More...

Functions/Subroutines
type(component_descriptor_type) function, public	diffusion_get_descriptor ()
	Provides the descriptor back to the caller and is used in component registration. More...
subroutine	field_information_retrieval_callback (current_state, name, field_information)
	Field information retrieval callback, this returns information for a specific components published field. More...
subroutine	field_value_retrieval_callback (current_state, name, field_value)
	Field value retrieval callback, this returns the value of a specific published field. More...
subroutine	initialisation_callback (current_state)
	Sets up the stencil_mod (used in interpolation) and allocates data for the flux fields. More...
subroutine	finalisation_callback (current_state)
subroutine	timestep_callback (current_state)
	At each timestep will compute the diffusion source terms for TH and Q fields per column if these fields are active. More...
subroutine	perform_q_diffusion (current_state, local_y, local_x)
	Computes the diffusion source terms for each Q field. More...
subroutine	perform_th_diffusion (current_state, local_y, local_x)
	Computes the diffusion source terms for the theta field. More...
subroutine	general_diffusion (current_state, field, source_field, local_y, local_x, diagnostics)
	General diffusion computation for any field which is provided as arguments. Works in a column. More...
subroutine	perform_local_data_copy_for_diff (current_state, halo_depth, involve_corners, source_data)
	Does local data copying for diffusion coefficient variable halo swap. More...
subroutine	copy_halo_buffer_to_diff (current_state, neighbour_description, dim, target_index, neighbour_location, current_page, source_data)
	Copies the halo buffer to halo location for the diffusion coefficient field. More...
subroutine	copy_halo_buffer_to_diff_corners (current_state, neighbour_description, corner_loc, x_target_index, y_target_index, neighbour_location, current_page, source_data)
	Copies the corner halo buffer to the diffusion coefficient field corners. More...

Variables
real(kind=default_precision), dimension(:), allocatable	th_diffusion
real(kind=default_precision), dimension(:,:), allocatable	q_diffusion

Detailed Description

Diffusion on the TH and Q fields.

Function/Subroutine Documentation

copy_halo_buffer_to_diff()

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

private

Copies the halo buffer to halo location for the diffusion coefficient field.

Parameters

current_state	The current model state
neighbour_description	The halo swapping description of the neighbour we are accessing the buffer of
dim	The dimension we receive for
target_index	The target index for the dimension we are receiving for
neighbour_location	The location in the local neighbour data stores of this neighbour
current_page	The current, next, halo swap page to read from (all previous have been read and copied already)
source_data	Optional source data which is written into

Definition at line 244 of file diffusion.F90.

    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%diff_coefficient%data, dim, target_index, current_page(neighbour_location))

    current_page(neighbour_location)=current_page(neighbour_location)+1

Here is the caller graph for this function:

copy_halo_buffer_to_diff_corners()

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

private

Copies the corner halo buffer to the diffusion coefficient field corners.

Parameters

current_state	The current model state
neighbour_description	The halo swapping description of the neighbour we are accessing the buffer of
corner_loc	The corner location
x_target_index	The X target index for the dimension we are receiving for
y_target_index	The Y target index for the dimension we are receiving for
neighbour_location	The location in the local neighbour data stores of this neighbour
current_page	The current, next, halo swap page to read from (all previous have been read and copied already)
source_data	Optional source data which is written into

Definition at line 267 of file diffusion.F90.

    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%diff_coefficient%data, corner_loc, x_target_index, y_target_index, current_page(neighbour_location))

    current_page(neighbour_location)=current_page(neighbour_location)+1

Here is the caller graph for this function:

diffusion_get_descriptor()

type(component_descriptor_type) function, public diffusion_mod::diffusion_get_descriptor

(

)

Provides the descriptor back to the caller and is used in component registration.

Returns

The termination check component descriptor

Definition at line 30 of file diffusion.F90.

    diffusion_get_descriptor%name="diffusion"
    diffusion_get_descriptor%version=0.1
    diffusion_get_descriptor%initialisation=>initialisation_callback
    diffusion_get_descriptor%timestep=>timestep_callback
    diffusion_get_descriptor%finalisation=>finalisation_callback

    diffusion_get_descriptor%field_value_retrieval=>field_value_retrieval_callback
    diffusion_get_descriptor%field_information_retrieval=>field_information_retrieval_callback
    allocate(diffusion_get_descriptor%published_fields(2))
    diffusion_get_descriptor%published_fields(1)="th_diffusion"
    diffusion_get_descriptor%published_fields(2)="q_diffusion"

Here is the call graph for this function:

field_information_retrieval_callback()

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

private

Field information retrieval callback, this returns information for a specific components published field.

Parameters

current_state	Current model state
name	The name of the field to retrieve information for
field_information	Populated with information about the field

Definition at line 48 of file diffusion.F90.

    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
    if (name .eq. "q_diffusion") then
      field_information%number_dimensions=2
    else
      field_information%number_dimensions=1
    end if
    field_information%dimension_sizes(1)=current_state%local_grid%size(z_index)
    if (name .eq. "q_diffusion") field_information%dimension_sizes(2)=current_state%number_q_fields
    field_information%enabled=.true.

Here is the caller graph for this function:

field_value_retrieval_callback()

subroutine diffusion_mod::field_value_retrieval_callback ( type(model_state_type), intent(inout), target  current_state, character(len=*), intent(in)  name, type(component_field_value_type), intent(out)  field_value  )

private

Field value retrieval callback, this returns the value of a specific published field.

Parameters

current_state	Current model state
name	The name of the field to retrieve the value for
field_value	Populated with the value of the field

Definition at line 70 of file diffusion.F90.

    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. "th_diffusion") then
      allocate(field_value%real_1d_array(size(th_diffusion)), source=th_diffusion)
    else if (name .eq. "q_diffusion") then
      allocate(field_value%real_2d_array(size(q_diffusion, 1), size(q_diffusion, 2)), source=q_diffusion)
    end if

Here is the caller graph for this function:

finalisation_callback()

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

private

Definition at line 100 of file diffusion.F90.

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

    if (allocated(th_diffusion)) deallocate(th_diffusion)
    if (allocated(q_diffusion)) deallocate(q_diffusion)

Here is the caller graph for this function:

general_diffusion()

subroutine diffusion_mod::general_diffusion ( type(model_state_type), intent(inout), target  current_state, type(prognostic_field_type), intent(inout)  field, type(prognostic_field_type), intent(inout)  source_field, integer, intent(in)  local_y, integer, intent(in)  local_x, real(kind=default_precision), dimension(:), intent(inout), optional  diagnostics  )

private

General diffusion computation for any field which is provided as arguments. Works in a column.

Parameters

current_state	The current model state
field	The field to take values from, typically zth or zq(n)
source_field	The source target field to update, typically sth or sq(n)
local_y	Local Y index
local_x	Local X index

Definition at line 176 of file diffusion.F90.

    type(model_state_type), target, intent(inout) :: current_state
    type(prognostic_field_type), intent(inout) :: field, source_field
    integer, intent(in) :: local_y, local_x
    real(kind=DEFAULT_PRECISION), dimension(:), intent(inout), optional :: diagnostics

    real(kind=DEFAULT_PRECISION) :: term
    integer :: k

    do k=2, current_state%local_grid%size(z_index)
      term=current_state%global_grid%configuration%horizontal%cx2*0.25_default_precision*&
           (((current_state%diff_coefficient%data(k, local_y, local_x)+&
           current_state%diff_coefficient%data(k, local_y, local_x-1))+&
           (current_state%diff_coefficient%data(k-1, local_y, local_x)+&
           current_state%diff_coefficient%data(k-1, local_y, local_x-1)))&
           *(field%data(k, local_y, local_x-1)-field%data(k, local_y, local_x)) -&
           ((current_state%diff_coefficient%data(k, local_y, local_x+1)+&
           current_state%diff_coefficient%data(k, local_y, local_x))+&
           (current_state%diff_coefficient%data(k-1, local_y, local_x+1)+&
           current_state%diff_coefficient%data(k-1, local_y, local_x)))&
           *(field%data(k, local_y, local_x)-field%data(k, local_y, local_x+1)) )&
           +current_state%global_grid%configuration%horizontal%cy2*0.25_default_precision*(&
           ((current_state%diff_coefficient%data(k, local_y, local_x)+&
           current_state%diff_coefficient%data(k, local_y-1, local_x))+&
           (current_state%diff_coefficient%data(k-1, local_y, local_x)+&
           current_state%diff_coefficient%data(k-1, local_y-1, local_x)))&
           *(field%data(k, local_y-1, local_x)-field%data(k, local_y, local_x)) -&
           ((current_state%diff_coefficient%data(k, local_y+1, local_x)+&
           current_state%diff_coefficient%data(k, local_y, local_x))+&
           (current_state%diff_coefficient%data(k-1, local_y+1, local_x)+&
           current_state%diff_coefficient%data(k-1, local_y, local_x)))&
           *(field%data(k, local_y, local_x)-field%data(k, local_y+1, local_x)) )&
           +( current_state%global_grid%configuration%vertical%czb(k)*&
           current_state%diff_coefficient%data(k-1, local_y, local_x)*&
           (field%data(k-1, local_y, local_x)-field%data(k, local_y, local_x)))

      if (k .lt. current_state%local_grid%size(z_index)) then
        term=term - current_state%global_grid%configuration%vertical%cza(k)*&
             current_state%diff_coefficient%data(k, local_y, local_x)*&
             (field%data(k, local_y, local_x)-field%data(k+1, local_y, local_x))
      end if
      source_field%data(k, local_y, local_x)=source_field%data(k, local_y, local_x)+term
      if (present(diagnostics)) diagnostics(k)=term
    end do

Here is the caller graph for this function:

initialisation_callback()

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

private

Sets up the stencil_mod (used in interpolation) and allocates data for the flux fields.

Parameters

current_state

The current model state_mod

Definition at line 84 of file diffusion.F90.

    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%diff_coefficient%data(z_size, y_size, x_size))

    z_size=current_state%global_grid%size(z_index)
    allocate(th_diffusion(z_size))
    allocate(q_diffusion(z_size, current_state%number_q_fields))

Here is the caller graph for this function:

perform_local_data_copy_for_diff()

subroutine diffusion_mod::perform_local_data_copy_for_diff ( 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  )

private

Does local data copying for diffusion coefficient variable halo swap.

Parameters

current_state	The current model state_mod
source_data	Optional source data which is written into

Definition at line 225 of file diffusion.F90.

    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%diff_coefficient%data, current_state%local_grid, &
         current_state%parallel%my_rank, halo_depth, involve_corners)

Here is the caller graph for this function:

perform_q_diffusion()

subroutine diffusion_mod::perform_q_diffusion ( type(model_state_type), intent(inout), target  current_state, integer, intent(in)  local_y, integer, intent(in)  local_x  )

private

Computes the diffusion source terms for each Q field.

Parameters

current_state	The current model state
local_y	Local Y index
local_x	Local X index

Definition at line 132 of file diffusion.F90.

    type(model_state_type), target, intent(inout) :: current_state
    integer, intent(in) :: local_y, local_x

    integer :: n

    do n=1, current_state%number_q_fields
      call general_diffusion(current_state, current_state%zq(n), current_state%sq(n), local_y, local_x, q_diffusion(:,n))
    end do

Here is the call graph for this function:

Here is the caller graph for this function:

perform_th_diffusion()

subroutine diffusion_mod::perform_th_diffusion ( type(model_state_type), intent(inout), target  current_state, integer, intent(in)  local_y, integer, intent(in)  local_x  )

private

Computes the diffusion source terms for the theta field.

Parameters

current_state	The current model state
local_y	Local Y index
local_x	Local X index

Definition at line 147 of file diffusion.F90.

    type(model_state_type), target, intent(inout) :: current_state
    integer, intent(in) :: local_y, local_x

    integer :: k
    real(kind=DEFAULT_PRECISION) :: adjustment

    call general_diffusion(current_state, current_state%zth, current_state%sth, local_y, local_x, th_diffusion)

    if (current_state%use_anelastic_equations) then
      ! This code only needs to be executed if anelastic, otherwise THREF is constant and the increment calculated here is zero
      do k=2, current_state%local_grid%size(z_index)
        adjustment=(current_state%global_grid%configuration%vertical%cza(k)*&
             current_state%global_grid%configuration%vertical%dthref(k)*&
             current_state%diff_coefficient%data(k, local_y, local_x) - current_state%global_grid%configuration%vertical%czb(k)*&
             current_state%global_grid%configuration%vertical%dthref(k-1)*&
             current_state%diff_coefficient%data(k-1, local_y, local_x))
        current_state%sth%data(k, local_y, local_x)=current_state%sth%data(k, local_y, local_x)+adjustment
        th_diffusion(k)=th_diffusion(k)+adjustment
      end do
    end if

Here is the call graph for this function:

Here is the caller graph for this function:

timestep_callback()

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

private

At each timestep will compute the diffusion source terms for TH and Q fields per column if these fields are active.

Parameters

current_state

The current model state

Definition at line 109 of file diffusion.F90.

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

    integer :: local_y, local_x

    if (.not. current_state%use_viscosity_and_diffusion .or. current_state%halo_column) return
    if (current_state%diffusion_halo_swap_state%swap_in_progress) then
      ! If there is a diffusion halo swap in progress then complete it
      call complete_nonblocking_halo_swap(current_state, current_state%diffusion_halo_swap_state, &
           perform_local_data_copy_for_diff, copy_halo_buffer_to_diff, copy_halo_buffer_to_diff_corners)
    end if

    local_y=current_state%column_local_y
    local_x=current_state%column_local_x

    if (current_state%th%active) call perform_th_diffusion(current_state, local_y, local_x)
    if (current_state%number_q_fields .gt. 0) call perform_q_diffusion(current_state, local_y, local_x)

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

q_diffusion

real(kind=default_precision), dimension(:,:), allocatable diffusion_mod::q_diffusion

private

Definition at line 21 of file diffusion.F90.

  real(kind=DEFAULT_PRECISION), dimension(:,:), allocatable :: q_diffusion

th_diffusion

real(kind=default_precision), dimension(:), allocatable diffusion_mod::th_diffusion

private

Definition at line 20 of file diffusion.F90.

  real(kind=DEFAULT_PRECISION), dimension(:), allocatable :: th_diffusion