Applies lateral boundary conditions. Note that these boundary conditions only make sense if bi-periodicity is switched off in the the halo swapping and solver. The FFT solver should have bi-periodic conditions. More...

Functions/Subroutines
type(component_descriptor_type) function, public	lateral_bcs_get_descriptor ()
	Provides a description of this component for the core to register. More...

subroutine	initialisation_callback (current_state)
	Initialisation callback. Sets up boundary depth and other configurable options. More...

subroutine	timestep_callback (current_state)
	Timestep callback which applies lateral boundary conditions. More...

subroutine	apply_rigid (current_state, istart, iend, jstart, jend, kstart, kend)

Variables
integer	lbc_type_x

integer	lbc_type_y

integer	idepth

integer	jdepth

integer, parameter	lbc_periodic = 1

integer, parameter	lbc_rigid = 2

integer, parameter	lbc_blend = 3

Detailed Description

Applies lateral boundary conditions. Note that these boundary conditions only make sense if bi-periodicity is switched off in the the halo swapping and solver. The FFT solver should have bi-periodic conditions.

Function/Subroutine Documentation

◆ apply_rigid()

subroutine lateral_bcs_mod::apply_rigid	(	type(model_state_type), intent(inout), target	current_state,
		integer	istart,
		integer	iend,
		integer	jstart,
		integer	jend,
		integer	kstart,
		integer	kend
	)

private

Definition at line 186 of file lateral_bcs.F90.

     type(model_state_type), target, intent(inout) :: current_state
  
     INTEGER :: istart, iend, jstart, jend, kstart, kend
  
     INTEGER :: i,j,k,iq
  
     do i=istart, iend
       do j=jstart, jend
         do k=kstart,kend
           ! Update to old values, i.e. fixed in time
 #ifdef U_ACTIVE
 !          current_state%u%data(k,j,i) = current_state%zu%data(k,j,i)
 #endif
 #ifdef V_ACTIVE
 !          current_state%v%data(k,j,i) = current_state%zv%data(k,j,i)
 #endif
 #ifdef W_ACTIVE
 !          current_state%w%data(k,j,i) = current_state%zw%data(k,j,i)
 #endif
           current_state%th%data(k,j,i) = current_state%zth%data(k,j,i)
         end do
       end do
     end do
     do iq = 1, current_state%number_q_fields
       do i=istart, iend
         do j=jstart, jend
           do k=kstart,kend
             current_state%q(iq)%data(k,j,i) = current_state%zq(iq)%data(k,j,i) 
           end do
         end do
       end do
     end do
  

Here is the caller graph for this function:

◆ initialisation_callback()

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

private

Initialisation callback. Sets up boundary depth and other configurable options.

Parameters

current_state The current model state

Definition at line 39 of file lateral_bcs.F90.

     type(model_state_type), target, intent(inout) :: current_state
     
     ! Hard wiring these for now
     idepth=3
     jdepth=2
  
     lbc_type_x=lbc_rigid
     lbc_type_y=lbc_periodic
  

Here is the caller graph for this function:

◆ lateral_bcs_get_descriptor()

type(component_descriptor_type) function, public lateral_bcs_mod::lateral_bcs_get_descriptor

Provides a description of this component for the core to register.

Returns: The descriptor containing registration information for this component

Definition at line 30 of file lateral_bcs.F90.

     lateral_bcs_get_descriptor%name="lateral_bcs"
     lateral_bcs_get_descriptor%version=0.1
     lateral_bcs_get_descriptor%initialisation=>initialisation_callback
     lateral_bcs_get_descriptor%timestep=>timestep_callback

Here is the call graph for this function:

◆ timestep_callback()

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

private

Timestep callback which applies lateral boundary conditions.

Parameters

current_state The current model state_mod

Definition at line 54 of file lateral_bcs.F90.

     type(model_state_type), target, intent(inout) :: current_state
  
     INTEGER :: istart, iend, jstart, jend, kstart, kend
  
     INTEGER :: i,j,k,iq
  
     LOGICAL :: is_east, is_west, is_north, is_south
  
     if (current_state%timestep==1) return
  
     is_west=current_state%parallel%wrapped_around(x_index,1) 
     is_east=current_state%parallel%wrapped_around(x_index,2) 
     is_south=current_state%parallel%wrapped_around(y_index,1) 
     is_north=current_state%parallel%wrapped_around(y_index,2) 
  
     ! k points
     if (is_west .or. is_east .or. is_north .or. is_south)then
       kstart=current_state%local_grid%local_domain_start_index(z_index)
       kend=current_state%local_grid%local_domain_end_index(z_index)
     end if
  
     ! Eastern boundary
     if (is_east)then
  
       iend=current_state%local_grid%local_domain_end_index(x_index) 
       istart = iend - idepth + 1
       jstart=current_state%local_grid%local_domain_start_index(y_index)
       jend=current_state%local_grid%local_domain_end_index(y_index)
  
       if (lbc_type_x==lbc_periodic)then
         ! how should this be done best Luis?
       else if (lbc_type_x==lbc_rigid)then
         ! No communications needed assuming idepth and jdepth fit 
         ! on a single pe (what if they don't?)
         call apply_rigid(current_state,istart,iend,jstart,jend,kstart,kend)
         ! propagate winds to halos
         do i=iend+1,iend+current_state%local_grid%halo_size(x_index)
           current_state%u%data(:,:,i) = current_state%u%data(:,:,iend)
           current_state%zu%data(:,:,i) = current_state%zu%data(:,:,iend)
           current_state%w%data(:,:,i) = current_state%w%data(:,:,iend)
           current_state%zw%data(:,:,i) = current_state%zw%data(:,:,iend)
         end do
         
       else if (lbc_type_x==lbc_blend)then
         ! To be coded....
       end if
  
     end if
  
     ! Western boundary
     if (is_west)then
  
       istart=current_state%local_grid%local_domain_start_index(x_index)
       iend=istart + idepth - 1
       jstart=current_state%local_grid%local_domain_start_index(y_index)
       jend=current_state%local_grid%local_domain_end_index(y_index)
  
  
       if (lbc_type_x==lbc_periodic)then
         ! how should this be done best Luis?
       else if (lbc_type_x==lbc_rigid)then
         ! No communications needed assuming idepth and jdepth fit 
         ! on a single pe (what if they don't?)
         call apply_rigid(current_state,istart,iend,jstart,jend,kstart,kend)
         ! propagate winds to halos
         do i=istart-current_state%local_grid%halo_size(x_index),istart-1
           current_state%u%data(:,:,i) = current_state%u%data(:,:,istart)
           current_state%zu%data(:,:,i) = current_state%zu%data(:,:,istart)
           current_state%w%data(:,:,i) = current_state%w%data(:,:,istart)
           current_state%zw%data(:,:,i) = current_state%zw%data(:,:,istart)
         end do
       else if (lbc_type_x==lbc_blend)then
         ! To be coded....
       end if
     end if
       
     
     ! Northern boundary
     if (is_north)then
  
       istart=current_state%local_grid%local_domain_start_index(x_index)
       iend=current_state%local_grid%local_domain_end_index(x_index)
       jend=current_state%local_grid%local_domain_end_index(y_index)
       jstart=jend - jdepth + 1
  
       if (lbc_type_y==lbc_periodic)then
         ! how should this be done best Luis?
       else if (lbc_type_y==lbc_rigid)then
         ! No communications needed assuming idepth and jdepth fit 
         ! on a single pe (what if they don't?)
         call apply_rigid(current_state,istart,iend,jstart,jend,kstart,kend)
         do j=jend+1,jend+current_state%local_grid%halo_size(y_index)
           current_state%v%data(:,:,j) = current_state%v%data(:,:,jend)
           current_state%zv%data(:,:,j) = current_state%zv%data(:,:,jend)
           current_state%w%data(:,:,j) = current_state%w%data(:,:,jend)
           current_state%zw%data(:,:,j) = current_state%zw%data(:,:,jend)
         end do
       else if (lbc_type_y==lbc_blend)then
         ! To be coded....
       end if
  
     end if
       
  
     ! Southern boundary
     if (is_south)then
  
       istart=current_state%local_grid%local_domain_start_index(x_index)
       iend=current_state%local_grid%local_domain_end_index(x_index)
       jstart=current_state%local_grid%local_domain_start_index(y_index)
       jend=jstart + jdepth - 1
  
       if (lbc_type_y==lbc_periodic)then
         ! how should this be done best Luis?
       else if (lbc_type_y==lbc_rigid)then
         ! No communications needed assuming idepth and jdepth fit 
         ! on a single pe (what if they don't?)
         call apply_rigid(current_state,istart,iend,jstart,jend,kstart,kend)
         do j=jstart-current_state%local_grid%halo_size(y_index),jstart-1
           current_state%v%data(:,:,j) = current_state%v%data(:,:,jstart)
           current_state%zv%data(:,:,j) = current_state%zv%data(:,:,jstart)
           current_state%w%data(:,:,j) = current_state%w%data(:,:,jstart)
           current_state%zw%data(:,:,j) = current_state%zw%data(:,:,jstart)
         end do
       else if (lbc_type_y==lbc_blend)then
         ! To be coded....
       end if
  
     end if

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

◆ idepth

integer lateral_bcs_mod::idepth

private

Definition at line 18 of file lateral_bcs.F90.

18 INTEGER :: idepth, jdepth ! depth of lateral bcs in i and j directions

◆ jdepth

integer lateral_bcs_mod::jdepth

private

Definition at line 18 of file lateral_bcs.F90.

◆ lbc_blend

integer, parameter lateral_bcs_mod::lbc_blend = 3

private

Definition at line 22 of file lateral_bcs.F90.

22 INTEGER, PARAMETER :: LBC_BLEND = 3

◆ lbc_periodic

integer, parameter lateral_bcs_mod::lbc_periodic = 1

private

Definition at line 20 of file lateral_bcs.F90.

20 INTEGER, PARAMETER :: LBC_PERIODIC = 1

◆ lbc_rigid

integer, parameter lateral_bcs_mod::lbc_rigid = 2

private

Definition at line 21 of file lateral_bcs.F90.

21 INTEGER, PARAMETER :: LBC_RIGID = 2

◆ lbc_type_x

integer lateral_bcs_mod::lbc_type_x

private

Definition at line 16 of file lateral_bcs.F90.

16 INTEGER :: lbc_type_x, lbc_type_y ! probably need to add these to state

◆ lbc_type_y

integer lateral_bcs_mod::lbc_type_y

private

Definition at line 16 of file lateral_bcs.F90.

Functions/Subroutines

Variables

Detailed Description

Function/Subroutine Documentation

◆ apply_rigid()

◆ initialisation_callback()

◆ lateral_bcs_get_descriptor()

◆ timestep_callback()

Variable Documentation

◆ idepth

◆ jdepth

◆ lbc_blend

◆ lbc_periodic

◆ lbc_rigid

◆ lbc_type_x

◆ lbc_type_y