pstep_mod Module Reference

Stepping of the pressure field. Completes the time-stepping of the velocity fields by adding the pressure term (dp/dx_i). In addition, ensures that l_zu and l_zv satisfy the Galilean-transformed boundary condition. This does not do the flow field _p terms which are only needed for diagnostics, nore does it do field halo swapping which is again only needed for diagnostics. More...

Functions/Subroutines
type(component_descriptor_type) function, public	pstep_get_descriptor ()
	Descriptor of this component for 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)
	Initialisation callback hook which will check the diverr component is enabled (as this allocates p) More...
subroutine	finalisation_callback (current_state)
subroutine	timestep_callback (current_state)
	Called each timestep, this will step the pressure field for the non halo columns. More...
subroutine	step_pressure_field (current_state)
	Does the actual stepping of the pressure field. More...
subroutine	perform_galilean_transformation (current_state, y_index, x_index)
	Performs Galilean transformation of flow current and z fields. More...
subroutine	save_precomponent_tendencies (current_state, cxn, cyn, txn, tyn)
	Save the 3d tendencies coming into the component. More...
subroutine	compute_component_tendencies (current_state, cxn, cyn, txn, tyn)
	Computation of component tendencies. More...
subroutine	set_published_field_value (field_value, real_1d_field, real_2d_field, real_3d_field)
	Sets the published field value from the temporary diagnostic values held by this component. More...

Variables
real(kind=default_precision), dimension(:,:,:), allocatable	tendp_3d_u
real(kind=default_precision), dimension(:,:,:), allocatable	tendp_3d_v
real(kind=default_precision), dimension(:,:,:), allocatable	tendp_3d_w
real(kind=default_precision), dimension(:,:,:), allocatable	tend_3d_u
real(kind=default_precision), dimension(:,:,:), allocatable	tend_3d_v
real(kind=default_precision), dimension(:,:,:), allocatable	tend_3d_w
logical	l_tendp_3d_u
logical	l_tendp_3d_v
logical	l_tendp_3d_w
logical	l_tend_3d_u
logical	l_tend_3d_v
logical	l_tend_3d_w
real(kind=default_precision), dimension(:), allocatable	tendp_pr_tot_u
real(kind=default_precision), dimension(:), allocatable	tendp_pr_tot_v
real(kind=default_precision), dimension(:), allocatable	tendp_pr_tot_w
real(kind=default_precision), dimension(:), allocatable	tend_pr_tot_u
real(kind=default_precision), dimension(:), allocatable	tend_pr_tot_v
real(kind=default_precision), dimension(:), allocatable	tend_pr_tot_w
logical	l_tendp_pr_tot_u
logical	l_tendp_pr_tot_v
logical	l_tendp_pr_tot_w
logical	l_tend_pr_tot_u
logical	l_tend_pr_tot_v
logical	l_tend_pr_tot_w
integer	diagnostic_generation_frequency

Detailed Description

Stepping of the pressure field. Completes the time-stepping of the velocity fields by adding the pressure term (dp/dx_i). In addition, ensures that l_zu and l_zv satisfy the Galilean-transformed boundary condition. This does not do the flow field _p terms which are only needed for diagnostics, nore does it do field halo swapping which is again only needed for diagnostics.

Function/Subroutine Documentation

compute_component_tendencies()

subroutine pstep_mod::compute_component_tendencies ( type(model_state_type), intent(inout), target  current_state, integer, intent(in)  cxn, integer, intent(in)  cyn, integer, intent(in)  txn, integer, intent(in)  tyn  )

private

Computation of component tendencies.

Parameters

current_state	Current model state
cxn	The current slice, x, index
cyn	The current column, y, index.
txn	target_x_index
tyn	target_y_index

Definition at line 476 of file pstep.F90.

    type(model_state_type), target, intent(inout) :: current_state
    integer, intent(in) ::  cxn, cyn, txn, tyn
    real(kind=default_precision) :: dtmtmp
 
    dtmtmp=2.0_default_precision* &
         merge(current_state%dtm, 0.5_default_precision*current_state%dtm, current_state%field_stepping == centred_stepping)
 
    ! Calculate change in tendency due to component
    if (l_tendp_3d_u) then
      tendp_3d_u(:,tyn,txn)=(current_state%zu%data(:,cyn,cxn) - tendp_3d_u(:,tyn,txn))/dtmtmp
    endif
    if (l_tendp_3d_v) then
      tendp_3d_v(:,tyn,txn)=(current_state%zv%data(:,cyn,cxn) - tendp_3d_v(:,tyn,txn))/dtmtmp
    endif
    if (l_tendp_3d_w) then
      tendp_3d_w(:,tyn,txn)=(current_state%zw%data(:,cyn,cxn) - tendp_3d_w(:,tyn,txn))/dtmtmp
    endif
    if (l_tend_3d_u) then
      tend_3d_u(:,tyn,txn)=tend_3d_u(:,tyn,txn) + tendp_3d_u(:,tyn,txn)
    endif
    if (l_tend_3d_v) then
      tend_3d_v(:,tyn,txn)=tend_3d_v(:,tyn,txn) + tendp_3d_v(:,tyn,txn)
    endif
    if (l_tend_3d_w) then
      tend_3d_w(:,tyn,txn)=tend_3d_w(:,tyn,txn) + tendp_3d_w(:,tyn,txn)
    endif
 
   ! Add local tendency fields to the profile total
    if (l_tendp_pr_tot_u) then
      tendp_pr_tot_u(:)=tendp_pr_tot_u(:) + tendp_3d_u(:,tyn,txn)
    endif
    if (l_tendp_pr_tot_v) then
      tendp_pr_tot_v(:)=tendp_pr_tot_v(:) + tendp_3d_v(:,tyn,txn)
    endif
    if (l_tendp_pr_tot_w) then
      tendp_pr_tot_w(:)=tendp_pr_tot_w(:) + tendp_3d_w(:,tyn,txn)
    endif
    if (l_tend_pr_tot_u) then
      tend_pr_tot_u(:)=tend_pr_tot_u(:) + tend_3d_u(:,tyn,txn)
    endif
    if (l_tend_pr_tot_v) then
      tend_pr_tot_v(:)=tend_pr_tot_v(:) + tend_3d_v(:,tyn,txn)
    endif
    if (l_tend_pr_tot_w) then
      tend_pr_tot_w(:)=tend_pr_tot_w(:) + tend_3d_w(:,tyn,txn)
    endif
 

Here is the caller graph for this function:

field_information_retrieval_callback()

subroutine pstep_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 75 of file pstep.F90.

    type(model_state_type), target, intent(inout) :: current_state
    character(len=*), intent(in) :: name
    type(component_field_information_type), intent(out) :: field_information
    integer :: strcomp
 
    ! Field information for 3d
    strcomp=index(name, "_pstep_3d_local")
    if (strcomp .ne. 0) then
      field_information%field_type=component_array_field_type
      field_information%number_dimensions=3
      field_information%dimension_sizes(1)=current_state%local_grid%size(z_index)
      field_information%dimension_sizes(2)=current_state%local_grid%size(y_index)
      field_information%dimension_sizes(3)=current_state%local_grid%size(x_index)
      field_information%data_type=component_double_data_type
 
      if      (name .eq. "tend_u_pstep_3d_local") then
        field_information%enabled=l_tend_3d_u
      else if (name .eq. "tend_v_pstep_3d_local") then
        field_information%enabled=l_tend_3d_v
      else if (name .eq. "tend_w_pstep_3d_local") then
        field_information%enabled=l_tend_3d_w
      else
        field_information%enabled=.true.
      end if
 
    end if !end 3d check
 
    ! Field information for profiles
    strcomp=index(name, "_pstep_profile_total_local")
    if (strcomp .ne. 0) then
      field_information%field_type=component_array_field_type
      field_information%number_dimensions=1
      field_information%dimension_sizes(1)=current_state%local_grid%size(z_index)
      field_information%data_type=component_double_data_type
 
      if      (name .eq. "tend_u_pstep_profile_total_local") then
        field_information%enabled=l_tend_pr_tot_u
      else if (name .eq. "tend_v_pstep_profile_total_local") then
        field_information%enabled=l_tend_pr_tot_v
      else if (name .eq. "tend_w_pstep_profile_total_local") then
        field_information%enabled=l_tend_pr_tot_w
      else
        field_information%enabled=.true.
      end if
 
    end if !end profile check
 
    ! Field information for 3d totals
    strcomp=index(name, "_total_3d_local")
    if (strcomp .ne. 0) then
      field_information%field_type=component_array_field_type
      field_information%number_dimensions=3
      field_information%dimension_sizes(1)=current_state%local_grid%size(z_index)
      field_information%dimension_sizes(2)=current_state%local_grid%size(y_index)
      field_information%dimension_sizes(3)=current_state%local_grid%size(x_index)
      field_information%data_type=component_double_data_type
 
      if      (name .eq. "tend_u_total_3d_local") then
        field_information%enabled=l_tend_3d_u
      else if (name .eq. "tend_v_total_3d_local") then
        field_information%enabled=l_tend_3d_v
      else if (name .eq. "tend_w_total_3d_local") then
        field_information%enabled=l_tend_3d_w
      else
        field_information%enabled=.true.
      end if
 
    end if !end 3d check
 
    ! Field information for total profiles
    strcomp=index(name, "_total_profile_total_local")
    if (strcomp .ne. 0) then
      field_information%field_type=component_array_field_type
      field_information%number_dimensions=1
      field_information%dimension_sizes(1)=current_state%local_grid%size(z_index)
      field_information%data_type=component_double_data_type
 
      if      (name .eq. "tend_u_total_profile_total_local") then
        field_information%enabled=l_tend_pr_tot_u
      else if (name .eq. "tend_v_total_profile_total_local") then
        field_information%enabled=l_tend_pr_tot_v
      else if (name .eq. "tend_w_total_profile_total_local") then
        field_information%enabled=l_tend_pr_tot_w
      else
        field_information%enabled=.true.
      end if
 
    end if !end profile check
 

Here is the caller graph for this function:

field_value_retrieval_callback()

subroutine pstep_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 172 of file pstep.F90.

    type(model_state_type), target, intent(inout) :: current_state
    character(len=*), intent(in) :: name
    type(component_field_value_type), intent(out) :: field_value
    ! 3d Tendency Fields
 
    if      (name .eq. "tend_u_pstep_3d_local" .and. allocated(tendp_3d_u)) then
      call set_published_field_value(field_value, real_3d_field=tendp_3d_u)
    else if (name .eq. "tend_v_pstep_3d_local" .and. allocated(tendp_3d_v)) then
      call set_published_field_value(field_value, real_3d_field=tendp_3d_v)
    else if (name .eq. "tend_w_pstep_3d_local" .and. allocated(tendp_3d_w)) then
      call set_published_field_value(field_value, real_3d_field=tendp_3d_w)
 
    ! Profile Tendency Fields
    else if (name .eq. "tend_u_pstep_profile_total_local" .and. allocated(tendp_pr_tot_u)) then
      call set_published_field_value(field_value, real_1d_field=tendp_pr_tot_u)
    else if (name .eq. "tend_v_pstep_profile_total_local" .and. allocated(tendp_pr_tot_v)) then
      call set_published_field_value(field_value, real_1d_field=tendp_pr_tot_v)
    else if (name .eq. "tend_w_pstep_profile_total_local" .and. allocated(tendp_pr_tot_w)) then
      call set_published_field_value(field_value, real_1d_field=tendp_pr_tot_w)
 
    ! 3d Tendency Fields
    else if (name .eq. "tend_u_total_3d_local" .and. allocated(tend_3d_u)) then
      call set_published_field_value(field_value, real_3d_field=tend_3d_u)
    else if (name .eq. "tend_v_total_3d_local" .and. allocated(tend_3d_v)) then
      call set_published_field_value(field_value, real_3d_field=tend_3d_v)
    else if (name .eq. "tend_w_total_3d_local" .and. allocated(tend_3d_w)) then
      call set_published_field_value(field_value, real_3d_field=tend_3d_w)
 
    ! Profile Tendency Fields
    else if (name .eq. "tend_u_total_profile_total_local" .and. allocated(tend_pr_tot_u)) then
      call set_published_field_value(field_value, real_1d_field=tend_pr_tot_u)
    else if (name .eq. "tend_v_total_profile_total_local" .and. allocated(tend_pr_tot_v)) then
      call set_published_field_value(field_value, real_1d_field=tend_pr_tot_v)
    else if (name .eq. "tend_w_total_profile_total_local" .and. allocated(tend_pr_tot_w)) then
      call set_published_field_value(field_value, real_1d_field=tend_pr_tot_w)
    end if
 

Here is the call graph for this function:

Here is the caller graph for this function:

finalisation_callback()

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

private

Definition at line 294 of file pstep.F90.

    type(model_state_type), target, intent(inout) :: current_state
 
    if (allocated(tendp_3d_u)) deallocate(tendp_3d_u)
    if (allocated(tendp_3d_v)) deallocate(tendp_3d_v)
    if (allocated(tendp_3d_w)) deallocate(tendp_3d_w)
    if (allocated(tend_3d_u)) deallocate(tend_3d_u)
    if (allocated(tend_3d_v)) deallocate(tend_3d_v)
    if (allocated(tend_3d_w)) deallocate(tend_3d_w)
 
    if (allocated(tendp_pr_tot_u)) deallocate(tendp_pr_tot_u)
    if (allocated(tendp_pr_tot_v)) deallocate(tendp_pr_tot_v)
    if (allocated(tendp_pr_tot_w)) deallocate(tendp_pr_tot_w)
    if (allocated(tend_pr_tot_u)) deallocate(tend_pr_tot_u)
    if (allocated(tend_pr_tot_v)) deallocate(tend_pr_tot_v)
    if (allocated(tend_pr_tot_w)) deallocate(tend_pr_tot_w)
 

Here is the caller graph for this function:

initialisation_callback()

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

private

Initialisation callback hook which will check the diverr component is enabled (as this allocates p)

Parameters

current_state

The current model state

Definition at line 214 of file pstep.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 pstep component requires the diverr component to be enabled")
    end if
 
    ! Tendency Logicals
    l_tendp_pr_tot_u   = current_state%u%active
    l_tendp_pr_tot_v   = current_state%v%active
    l_tendp_pr_tot_w   = current_state%w%active
    l_tend_pr_tot_u   = current_state%u%active
    l_tend_pr_tot_v   = current_state%v%active
    l_tend_pr_tot_w   = current_state%w%active
 
    l_tendp_3d_u   = current_state%u%active .or. l_tendp_pr_tot_u
    l_tendp_3d_v   = current_state%v%active .or. l_tendp_pr_tot_v
    l_tendp_3d_w   = current_state%w%active .or. l_tendp_pr_tot_w
    l_tend_3d_u   = current_state%u%active .or. l_tend_pr_tot_u
    l_tend_3d_v   = current_state%v%active .or. l_tend_pr_tot_v
    l_tend_3d_w   = current_state%w%active .or. l_tend_pr_tot_w
 
    ! Allocate 3d tendency fields upon availability
    if (l_tendp_3d_u) then
      allocate( tendp_3d_u(current_state%local_grid%size(z_index),  &
                           current_state%local_grid%size(y_index),  &
                           current_state%local_grid%size(x_index)   )    )
    endif
    if (l_tendp_3d_v) then
      allocate( tendp_3d_v(current_state%local_grid%size(z_index),  &
                           current_state%local_grid%size(y_index),  &
                           current_state%local_grid%size(x_index)   )    )
    endif
    if (l_tendp_3d_w) then
      allocate( tendp_3d_w(current_state%local_grid%size(z_index),  &
                           current_state%local_grid%size(y_index),  &
                           current_state%local_grid%size(x_index)   )    )
    endif
    if (l_tend_3d_u) then
      allocate( tend_3d_u(current_state%local_grid%size(z_index),  &
                          current_state%local_grid%size(y_index),  &
                          current_state%local_grid%size(x_index)   )    )
    endif
    if (l_tend_3d_v) then
      allocate( tend_3d_v(current_state%local_grid%size(z_index),  &
                          current_state%local_grid%size(y_index),  &
                          current_state%local_grid%size(x_index)   )    )
    endif
    if (l_tend_3d_w) then
      allocate( tend_3d_w(current_state%local_grid%size(z_index),  &
                          current_state%local_grid%size(y_index),  &
                          current_state%local_grid%size(x_index)   )    )
    endif
 
    ! Allocate profile tendency fields upon availability
    if (l_tendp_pr_tot_u) then
      allocate( tendp_pr_tot_u(current_state%local_grid%size(z_index)) )
    endif
    if (l_tendp_pr_tot_v) then
      allocate( tendp_pr_tot_v(current_state%local_grid%size(z_index)) )
    endif
    if (l_tendp_pr_tot_w) then
      allocate( tendp_pr_tot_w(current_state%local_grid%size(z_index)) )
    endif
    if (l_tend_pr_tot_u) then
      allocate( tend_pr_tot_u(current_state%local_grid%size(z_index)) )
    endif
    if (l_tend_pr_tot_v) then
      allocate( tend_pr_tot_v(current_state%local_grid%size(z_index)) )
    endif
    if (l_tend_pr_tot_w) then
      allocate( tend_pr_tot_w(current_state%local_grid%size(z_index)) )
    endif
 
    ! Save the sampling_frequency to force diagnostic calculation on select time steps
    diagnostic_generation_frequency=options_get_integer(current_state%options_database, "sampling_frequency")
 

Here is the caller graph for this function:

perform_galilean_transformation()

subroutine pstep_mod::perform_galilean_transformation ( type(model_state_type), intent(inout), target  current_state, integer, intent(in)  y_index, integer, intent(in)  x_index  )

private

Performs Galilean transformation of flow current and z fields.

Parameters

current_state	The current model state
y_index	Local y index which we are working with
x_index	Local x index which we are working with

Definition at line 418 of file pstep.F90.

    type(model_state_type), target, intent(inout) :: current_state
    integer, intent(in) :: y_index, x_index
 
    integer :: k
 
    do k=1,current_state%local_grid%size(z_index)
#ifdef U_ACTIVE
      current_state%u%data(k, y_index, x_index)= current_state%u%data(k, y_index, x_index)-current_state%ugal
      current_state%zu%data(k, y_index, x_index)= current_state%zu%data(k, y_index, x_index)-current_state%ugal
#endif
#ifdef V_ACTIVE
      current_state%v%data(k, y_index, x_index)= current_state%v%data(k, y_index, x_index)-current_state%vgal
      current_state%zv%data(k, y_index, x_index)= current_state%zv%data(k, y_index, x_index)-current_state%vgal
#endif
    end do

Here is the caller graph for this function:

pstep_get_descriptor()

type(component_descriptor_type) function, public pstep_mod::pstep_get_descriptor

Descriptor of this component for registration.

Returns

The pstep component descriptor

Definition at line 44 of file pstep.F90.

    pstep_get_descriptor%name="pstep"
    pstep_get_descriptor%version=0.1
    pstep_get_descriptor%initialisation=>initialisation_callback
    pstep_get_descriptor%timestep=>timestep_callback
    pstep_get_descriptor%finalisation=>finalisation_callback
 
    pstep_get_descriptor%field_value_retrieval=>field_value_retrieval_callback
    pstep_get_descriptor%field_information_retrieval=>field_information_retrieval_callback
    allocate(pstep_get_descriptor%published_fields(6+6))
 
    pstep_get_descriptor%published_fields(1)= "tend_u_pstep_3d_local"
    pstep_get_descriptor%published_fields(2)= "tend_v_pstep_3d_local"
    pstep_get_descriptor%published_fields(3)= "tend_w_pstep_3d_local"
    pstep_get_descriptor%published_fields(4)= "tend_u_total_3d_local"
    pstep_get_descriptor%published_fields(5)= "tend_v_total_3d_local"
    pstep_get_descriptor%published_fields(6)= "tend_w_total_3d_local"
 
    pstep_get_descriptor%published_fields(6+1)= "tend_u_pstep_profile_total_local"
    pstep_get_descriptor%published_fields(6+2)= "tend_v_pstep_profile_total_local"
    pstep_get_descriptor%published_fields(6+3)= "tend_w_pstep_profile_total_local"
    pstep_get_descriptor%published_fields(6+4)= "tend_u_total_profile_total_local"
    pstep_get_descriptor%published_fields(6+5)= "tend_v_total_profile_total_local"
    pstep_get_descriptor%published_fields(6+6)= "tend_w_total_profile_total_local"
 

Here is the call graph for this function:

save_precomponent_tendencies()

subroutine pstep_mod::save_precomponent_tendencies ( type(model_state_type), intent(in), target  current_state, integer, intent(in)  cxn, integer, intent(in)  cyn, integer, intent(in)  txn, integer, intent(in)  tyn  )

private

Save the 3d tendencies coming into the component.

Parameters

current_state	Current model state
cxn	The current slice, x, index
cyn	The current column, y, index.
txn	target_x_index
tyn	target_y_index

Definition at line 443 of file pstep.F90.

    type(model_state_type), target, intent(in) :: current_state
    integer, intent(in) ::  cxn, cyn, txn, tyn
 
    ! Save 3d tendency fields upon request (of 3d or profiles) and availability
    if (l_tendp_3d_u) then
      tendp_3d_u(:,tyn,txn)=current_state%zu%data(:,cyn,cxn)
    endif
    if (l_tendp_3d_v) then
      tendp_3d_v(:,tyn,txn)=current_state%zv%data(:,cyn,cxn)
    endif
    if (l_tendp_3d_w) then
      tendp_3d_w(:,tyn,txn)=current_state%zw%data(:,cyn,cxn)
    endif
    if (l_tend_3d_u) then
      tend_3d_u(:,tyn,txn)=current_state%su%data(:,cyn,cxn)
    endif
    if (l_tend_3d_v) then
      tend_3d_v(:,tyn,txn)=current_state%sv%data(:,cyn,cxn)
    endif
    if (l_tend_3d_w) then
      tend_3d_w(:,tyn,txn)=current_state%sw%data(:,cyn,cxn)
    endif
 

Here is the caller graph for this function:

set_published_field_value()

subroutine pstep_mod::set_published_field_value ( type(component_field_value_type), intent(inout)  field_value, real(kind=default_precision), dimension(:), optional  real_1d_field, real(kind=default_precision), dimension(:,:), optional  real_2d_field, real(kind=default_precision), dimension(:,:,:), optional  real_3d_field  )

private

Sets the published field value from the temporary diagnostic values held by this component.

Parameters

field_value	Populated with the value of the field
real_1d_field	Optional one dimensional real of values to publish
real_2d_field	Optional two dimensional real of values to publish

Definition at line 531 of file pstep.F90.

    type(component_field_value_type), intent(inout) :: field_value
    real(kind=default_precision), dimension(:), optional :: real_1d_field
    real(kind=default_precision), dimension(:,:), optional :: real_2d_field
    real(kind=default_precision), dimension(:,:,:), optional :: real_3d_field
 
    if (present(real_1d_field)) then
      allocate(field_value%real_1d_array(size(real_1d_field)), source=real_1d_field)
    else if (present(real_2d_field)) then
      allocate(field_value%real_2d_array(size(real_2d_field, 1), size(real_2d_field, 2)), source=real_2d_field)
    else if (present(real_3d_field)) then
      allocate(field_value%real_3d_array(size(real_3d_field, 1), size(real_3d_field, 2), size(real_3d_field, 3)), &
               source=real_3d_field)
    end if

Here is the caller graph for this function:

step_pressure_field()

subroutine pstep_mod::step_pressure_field ( type(model_state_type), intent(inout), target  current_state )

private

Does the actual stepping of the pressure field.

Parameters

current_state

The current model state

Definition at line 364 of file pstep.F90.

    type(model_state_type), target, intent(inout) :: current_state
 
    integer :: k, x_index, y_index
    real(kind=default_precision) :: dtmtmp
 
    x_index=current_state%column_local_x
    y_index=current_state%column_local_y
 
    dtmtmp=merge(current_state%dtm, 0.5_default_precision*current_state%dtm, current_state%field_stepping == centred_stepping)
    do k=2,current_state%local_grid%size(z_index)
 
#ifdef U_ACTIVE
      current_state%zu%data(k, y_index, x_index)= current_state%zu%data(k, y_index, x_index)+ 2.0_default_precision*&
           current_state%global_grid%configuration%horizontal%cx*dtmtmp*(current_state%p%data(k, y_index, x_index)-&
           current_state%p%data(k, y_index, x_index+1))      
#endif
#ifdef V_ACTIVE
      current_state%zv%data(k, y_index, x_index)=&
           current_state%zv%data(k, y_index, x_index)+2.0_default_precision*&
           current_state%global_grid%configuration%horizontal%cy*dtmtmp*&
           (current_state%p%data(k, y_index, x_index) - current_state%p%data(k, y_index+1, x_index))
#endif
#ifdef W_ACTIVE
      if (k .lt. current_state%local_grid%size(z_index)) then
        current_state%zw%data(k, y_index, x_index)=current_state%zw%data(k, y_index, x_index)+2.0_default_precision*&
             current_state%global_grid%configuration%vertical%rdzn(k+1)*dtmtmp*(current_state%p%data(k, y_index, x_index)-&
             current_state%p%data(k+1, y_index, x_index))
      end if
#endif
    end do
    if (current_state%use_viscosity_and_diffusion .and. current_state%use_surface_boundary_conditions) then
#ifdef U_ACTIVE
      current_state%zu%data(1, y_index, x_index)=-current_state%zu%data(2, y_index, x_index)-&
           2.0_default_precision*current_state%ugal
#endif
#ifdef V_ACTIVE
      current_state%zv%data(1, y_index, x_index)=-current_state%zv%data(2, y_index, x_index)-&
           2.0_default_precision*current_state%vgal
#endif
    else
#ifdef U_ACTIVE
      current_state%zu%data(1, y_index, x_index)=current_state%zu%data(2, y_index, x_index)
#endif
#ifdef V_ACTIVE
      current_state%zv%data(1, y_index, x_index)=current_state%zv%data(2, y_index, x_index)
#endif
    end if

Here is the caller graph for this function:

timestep_callback()

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

private

Called each timestep, this will step the pressure field for the non halo columns.

Parameters

current_state

The current model state

Definition at line 315 of file pstep.F90.

    type(model_state_type), target, intent(inout) :: current_state
    integer :: local_y, local_x, target_x_index, target_y_index
 
    local_y=current_state%column_local_y
    local_x=current_state%column_local_x
    target_y_index=local_y-current_state%local_grid%halo_size(y_index)
    target_x_index=local_x-current_state%local_grid%halo_size(x_index)
 
    ! Zero profile tendency totals on first instance in the sum
    if (current_state%first_timestep_column) then
      if (l_tendp_pr_tot_u) then
        tendp_pr_tot_u(:)= 0.0_default_precision
      endif
      if (l_tendp_pr_tot_v) then
        tendp_pr_tot_v(:)= 0.0_default_precision
      endif
      if (l_tendp_pr_tot_w) then
        tendp_pr_tot_w(:)= 0.0_default_precision
      endif
      if (l_tend_pr_tot_u) then
        tend_pr_tot_u(:)= 0.0_default_precision
      endif
      if (l_tend_pr_tot_v) then
        tend_pr_tot_v(:)= 0.0_default_precision
      endif
      if (l_tend_pr_tot_w) then
        tend_pr_tot_w(:)= 0.0_default_precision
      endif
    endif  ! zero totals
    
    if (current_state%galilean_transformation) call perform_galilean_transformation(current_state, &
         current_state%column_local_y, current_state%column_local_x)
 
    if (mod(current_state%timestep, diagnostic_generation_frequency) == 0 .and. .not. current_state%halo_column) then
      call save_precomponent_tendencies(current_state, local_x, local_y, target_x_index, target_y_index)
    end if
 
    if (.not. current_state%halo_column) call step_pressure_field(current_state)
 
    if (mod(current_state%timestep, diagnostic_generation_frequency) == 0 .and. .not. current_state%halo_column) then
      call compute_component_tendencies(current_state, local_x, local_y, target_x_index, target_y_index)
    end if
 

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

diagnostic_generation_frequency

integer pstep_mod::diagnostic_generation_frequency

private

Definition at line 36 of file pstep.F90.

  integer :: diagnostic_generation_frequency

l_tend_3d_u

logical pstep_mod::l_tend_3d_u

private

Definition at line 30 of file pstep.F90.

l_tend_3d_v

logical pstep_mod::l_tend_3d_v

private

Definition at line 30 of file pstep.F90.

l_tend_3d_w

logical pstep_mod::l_tend_3d_w

private

Definition at line 30 of file pstep.F90.

l_tend_pr_tot_u

logical pstep_mod::l_tend_pr_tot_u

private

Definition at line 34 of file pstep.F90.

l_tend_pr_tot_v

logical pstep_mod::l_tend_pr_tot_v

private

Definition at line 34 of file pstep.F90.

l_tend_pr_tot_w

logical pstep_mod::l_tend_pr_tot_w

private

Definition at line 34 of file pstep.F90.

l_tendp_3d_u

logical pstep_mod::l_tendp_3d_u

private

Definition at line 30 of file pstep.F90.

  logical :: l_tendp_3d_u, l_tendp_3d_v, l_tendp_3d_w, l_tend_3d_u, l_tend_3d_v, l_tend_3d_w

l_tendp_3d_v

logical pstep_mod::l_tendp_3d_v

private

Definition at line 30 of file pstep.F90.

l_tendp_3d_w

logical pstep_mod::l_tendp_3d_w

private

Definition at line 30 of file pstep.F90.

l_tendp_pr_tot_u

logical pstep_mod::l_tendp_pr_tot_u

private

Definition at line 34 of file pstep.F90.

  logical :: l_tendp_pr_tot_u, l_tendp_pr_tot_v, l_tendp_pr_tot_w, l_tend_pr_tot_u, l_tend_pr_tot_v, l_tend_pr_tot_w

l_tendp_pr_tot_v

logical pstep_mod::l_tendp_pr_tot_v

private

Definition at line 34 of file pstep.F90.

l_tendp_pr_tot_w

logical pstep_mod::l_tendp_pr_tot_w

private

Definition at line 34 of file pstep.F90.

tend_3d_u

real(kind=default_precision), dimension(:,:,:), allocatable pstep_mod::tend_3d_u

private

Definition at line 28 of file pstep.F90.

tend_3d_v

real(kind=default_precision), dimension(:,:,:), allocatable pstep_mod::tend_3d_v

private

Definition at line 28 of file pstep.F90.

tend_3d_w

real(kind=default_precision), dimension(:,:,:), allocatable pstep_mod::tend_3d_w

private

Definition at line 28 of file pstep.F90.

tend_pr_tot_u

real(kind=default_precision), dimension(:), allocatable pstep_mod::tend_pr_tot_u

private

Definition at line 32 of file pstep.F90.

tend_pr_tot_v

real(kind=default_precision), dimension(:), allocatable pstep_mod::tend_pr_tot_v

private

Definition at line 32 of file pstep.F90.

tend_pr_tot_w

real(kind=default_precision), dimension(:), allocatable pstep_mod::tend_pr_tot_w

private

Definition at line 32 of file pstep.F90.

tendp_3d_u

real(kind=default_precision), dimension(:,:,:), allocatable pstep_mod::tendp_3d_u

private

Definition at line 28 of file pstep.F90.

  real(kind=default_precision), dimension(:,:,:), allocatable ::     &
               tendp_3d_u,   tendp_3d_v,   tendp_3d_w,   tend_3d_u,   tend_3d_v,   tend_3d_w

tendp_3d_v

real(kind=default_precision), dimension(:,:,:), allocatable pstep_mod::tendp_3d_v

private

Definition at line 28 of file pstep.F90.

tendp_3d_w

real(kind=default_precision), dimension(:,:,:), allocatable pstep_mod::tendp_3d_w

private

Definition at line 28 of file pstep.F90.

tendp_pr_tot_u

real(kind=default_precision), dimension(:), allocatable pstep_mod::tendp_pr_tot_u

private

Definition at line 32 of file pstep.F90.

  real(kind=default_precision), dimension(:), allocatable ::         &
               tendp_pr_tot_u,   tendp_pr_tot_v,   tendp_pr_tot_w,   tend_pr_tot_u,   tend_pr_tot_v,   tend_pr_tot_w

tendp_pr_tot_v

real(kind=default_precision), dimension(:), allocatable pstep_mod::tendp_pr_tot_v

private

Definition at line 32 of file pstep.F90.

tendp_pr_tot_w

real(kind=default_precision), dimension(:), allocatable pstep_mod::tendp_pr_tot_w

private

Definition at line 32 of file pstep.F90.