pressuresource_mod Module Reference

Calculates the gradient of the source flow fields (SU, SV, SW.) This is based upon the P field values already set for the divergence error in the diverr component. Note that some communication is required, as a process needs to know the x and y -1 values, which are held on the -1 neighbour in that dimension. These are computed here and sent to neighbour +1, the recvs from a process to neighbour -1 are also registered here and the handles are waited upon the the results combined into P in the solver. If the neighbour is local in any dimension then it is just a local memory copy. More...

Functions/Subroutines
type(component_descriptor_type) function, public	pressuresource_get_descriptor ()
	Descriptor of this component for registration. More...
subroutine	initialisation_callback (current_state)
	On initialisation this will allocate the buffer areas required and set communication handles to null. More...
subroutine	timestep_callback (current_state)
	The timestep callback will update the values of P for each column. More...
subroutine	finalisation_callback (current_state)
	Frees up the allocated buffers (if such were allocated) More...
subroutine	calculate_psrce (current_state)
	Combines the source fields with the pressure values. For U and V, if this is on the low boundary then delay dealing with the -1 values as they will be communicated. Equally, for those fields if this is the high boundary then compute the values and send them on to the neighbouring process. More...
subroutine	send_neighbouring_pressure_data (current_state)
	Sends the computed source pressure data terms to the p+1 process. More...
subroutine	register_neighbouring_pressure_data_recv (current_state)
	Registers the receive requests for each neighbouring process if that is not local, is recieves from p-1. More...

Variables
real(kind=default_precision), dimension(:,:), allocatable	send_buffer_x
real(kind=default_precision), dimension(:,:), allocatable	send_buffer_y

Detailed Description

Calculates the gradient of the source flow fields (SU, SV, SW.) This is based upon the P field values already set for the divergence error in the diverr component. Note that some communication is required, as a process needs to know the x and y -1 values, which are held on the -1 neighbour in that dimension. These are computed here and sent to neighbour +1, the recvs from a process to neighbour -1 are also registered here and the handles are waited upon the the results combined into P in the solver. If the neighbour is local in any dimension then it is just a local memory copy.

Function/Subroutine Documentation

calculate_psrce()

subroutine pressuresource_mod::calculate_psrce ( type(model_state_type), intent(inout), target  current_state )

private

Combines the source fields with the pressure values. For U and V, if this is on the low boundary then delay dealing with the -1 values as they will be communicated. Equally, for those fields if this is the high boundary then compute the values and send them on to the neighbouring process.

Parameters

current_state

The current model state

Definition at line 84 of file pressuresource.F90.

    type(model_state_type), target, intent(inout) :: current_state
 
    integer :: k, local_y, local_x, corrected_y, corrected_x
    logical :: last_x, last_y
 
    local_y=current_state%column_local_y
    local_x=current_state%column_local_x
    last_y = local_y == current_state%local_grid%local_domain_end_index(y_index)
    last_x = local_x == current_state%local_grid%local_domain_end_index(x_index)
    if (last_x .or. last_y) then
      corrected_x=local_x-current_state%local_grid%halo_size(x_index)
      corrected_y=local_y-current_state%local_grid%halo_size(y_index)
    end if
    do k=2,current_state%local_grid%size(z_index)
#ifdef W_ACTIVE
      current_state%p%data(k, local_y, local_x)=current_state%p%data(k, local_y, local_x)+&
           4.0_default_precision*(current_state%global_grid%configuration%vertical%tzc2(k)*&
           current_state%sw%data(k, local_y, local_x)-&
           current_state%global_grid%configuration%vertical%tzc1(k)*current_state%sw%data(k-1, local_y, local_x))      
#endif
#ifdef U_ACTIVE
      current_state%p%data(k, local_y, local_x)=current_state%p%data(k, local_y, local_x)+&
           current_state%global_grid%configuration%horizontal%cx * current_state%su%data(k, local_y, local_x)
#endif
#ifdef V_ACTIVE
      current_state%p%data(k, local_y, local_x)=current_state%p%data(k, local_y, local_x)+&
           current_state%global_grid%configuration%horizontal%cy * current_state%sv%data(k, local_y, local_x)
#endif
#ifdef U_ACTIVE
      if (local_x .gt. 3) then
        current_state%p%data(k, local_y, local_x)=current_state%p%data(k, local_y, local_x)-&
             current_state%global_grid%configuration%horizontal%cx * current_state%su%data(k, local_y, local_x-1)
      end if
      
      if (last_x) then
        send_buffer_x(k-1, corrected_y)=&
             current_state%global_grid%configuration%horizontal%cx * current_state%su%data(k, local_y, local_x)
      end if
#endif
#ifdef V_ACTIVE
      if (local_y .gt. 3 .and. local_x .gt. 3) then
        current_state%p%data(k, local_y, local_x)=current_state%p%data(k, local_y, local_x)-&
             current_state%global_grid%configuration%horizontal%cy * current_state%sv%data(k, local_y-1, local_x)      
      end if
      if (last_y) then
        send_buffer_y(k-1, corrected_x)=&
             current_state%global_grid%configuration%horizontal%cy * current_state%sv%data(k, local_y, local_x)
      end if
#endif
    end do

Here is the caller graph for this function:

finalisation_callback()

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

private

Frees up the allocated buffers (if such were allocated)

Parameters

current_state

The current model state

Definition at line 71 of file pressuresource.F90.

    type(model_state_type), target, intent(inout) :: current_state
 
    if (allocated(send_buffer_x)) deallocate(send_buffer_x)
    if (allocated(current_state%psrce_recv_buffer_x)) deallocate(current_state%psrce_recv_buffer_x)
    if (allocated(send_buffer_y)) deallocate(send_buffer_y)
    if (allocated(current_state%psrce_recv_buffer_y)) deallocate(current_state%psrce_recv_buffer_y)

Here is the caller graph for this function:

initialisation_callback()

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

private

On initialisation this will allocate the buffer areas required and set communication handles to null.

Parameters

current_state

The current model state

Definition at line 38 of file pressuresource.F90.

    type(model_state_type), target, intent(inout) :: current_state
 
    if (.not. is_component_enabled(current_state%options_database, "diverr")) then
      call log_master_log(log_error, "The pressure source component requires the diverr component to be enabled")
    end if  
 
#ifdef U_ACTIVE
    allocate(send_buffer_x(current_state%local_grid%size(z_index)-1, current_state%local_grid%size(y_index)), &
         current_state%psrce_recv_buffer_x(current_state%local_grid%size(z_index)-1, current_state%local_grid%size(y_index)))
#endif
#ifdef V_ACTIVE
    allocate(send_buffer_y(current_state%local_grid%size(z_index)-1, current_state%local_grid%size(x_index)), &
         current_state%psrce_recv_buffer_y(current_state%local_grid%size(z_index)-1, current_state%local_grid%size(x_index)))
#endif
    current_state%psrce_x_hs_send_request=mpi_request_null
    current_state%psrce_y_hs_send_request=mpi_request_null
    current_state%psrce_x_hs_recv_request=mpi_request_null
    current_state%psrce_y_hs_recv_request=mpi_request_null

Here is the caller graph for this function:

pressuresource_get_descriptor()

type(component_descriptor_type) function, public pressuresource_mod::pressuresource_get_descriptor

Descriptor of this component for registration.

Returns

The pressure source component descriptor

Definition at line 28 of file pressuresource.F90.

    pressuresource_get_descriptor%name="psrce"
    pressuresource_get_descriptor%version=0.1
    pressuresource_get_descriptor%initialisation=>initialisation_callback
    pressuresource_get_descriptor%timestep=>timestep_callback
    pressuresource_get_descriptor%finalisation=>finalisation_callback

Here is the call graph for this function:

register_neighbouring_pressure_data_recv()

subroutine pressuresource_mod::register_neighbouring_pressure_data_recv ( type(model_state_type), intent(inout), target  current_state )

private

Registers the receive requests for each neighbouring process if that is not local, is recieves from p-1.

Parameters

current_state

The current model state

Definition at line 164 of file pressuresource.F90.

    type(model_state_type), target, intent(inout) :: current_state
 
    integer :: ierr
 
#ifdef U_ACTIVE
    if (current_state%local_grid%neighbours(x_index,2) .ne. current_state%parallel%my_rank) then
      call mpi_irecv(current_state%psrce_recv_buffer_x, size(current_state%psrce_recv_buffer_x), precision_type, &
           current_state%local_grid%neighbours(x_index,2), 10, current_state%parallel%neighbour_comm, &
           current_state%psrce_x_hs_recv_request, ierr)
    end if    
#endif
#ifdef V_ACTIVE
    if (current_state%local_grid%neighbours(y_index,2) .ne. current_state%parallel%my_rank) then
      call mpi_irecv(current_state%psrce_recv_buffer_y, size(current_state%psrce_recv_buffer_y), precision_type, &
           current_state%local_grid%neighbours(y_index,2), 10, current_state%parallel%neighbour_comm, &
           current_state%psrce_y_hs_recv_request, ierr)
    end if    
#endif

Here is the caller graph for this function:

send_neighbouring_pressure_data()

subroutine pressuresource_mod::send_neighbouring_pressure_data ( type(model_state_type), intent(inout), target  current_state )

private

Sends the computed source pressure data terms to the p+1 process.

Parameters

current_state

The current model state

Definition at line 139 of file pressuresource.F90.

    type(model_state_type), target, intent(inout) :: current_state
 
    integer :: ierr
 
#ifdef U_ACTIVE
    if (current_state%local_grid%neighbours(x_index,3) .eq. current_state%parallel%my_rank) then
      current_state%psrce_recv_buffer_x=send_buffer_x
    else
      call mpi_isend(send_buffer_x, size(send_buffer_x), precision_type, current_state%local_grid%neighbours(x_index,3), &
           10, current_state%parallel%neighbour_comm, current_state%psrce_x_hs_send_request, ierr)
    end if
#endif
#ifdef V_ACTIVE
    if (current_state%local_grid%neighbours(y_index,3) .eq. current_state%parallel%my_rank) then
      current_state%psrce_recv_buffer_y=send_buffer_y
    else
      call mpi_isend(send_buffer_y, size(send_buffer_y), precision_type, current_state%local_grid%neighbours(y_index,3), &
           10, current_state%parallel%neighbour_comm, current_state%psrce_y_hs_send_request, ierr)
    end if
#endif

Here is the caller graph for this function:

timestep_callback()

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

private

The timestep callback will update the values of P for each column.

Parameters

current_state

The current model state

Definition at line 61 of file pressuresource.F90.

    type(model_state_type), target, intent(inout) :: current_state
 
    if (current_state%first_timestep_column) call register_neighbouring_pressure_data_recv(current_state)
    if (.not. current_state%halo_column) call calculate_psrce(current_state)        
    if (current_state%last_timestep_column) call send_neighbouring_pressure_data(current_state)

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

send_buffer_x

real(kind=default_precision), dimension(:,:), allocatable pressuresource_mod::send_buffer_x

private

Definition at line 21 of file pressuresource.F90.

  real(kind=default_precision), dimension(:,:), allocatable :: send_buffer_x, send_buffer_y

send_buffer_y

real(kind=default_precision), dimension(:,:), allocatable pressuresource_mod::send_buffer_y

private

Definition at line 21 of file pressuresource.F90.