stepfields_mod Module Reference

Does the field stepping Stepping is called at the end of processing a column and steps the x-2 column. More...

Functions/Subroutines
type(component_descriptor_type) function, public	stepfields_get_descriptor ()
	Provides the descriptor back to the caller and is used in component registration. More...
subroutine	initialisation_callback (current_state)
	Initialisation callback. More...
subroutine	finalisation_callback (current_state)
	Finalisation callback. More...
subroutine	timestep_callback (current_state)
	Called at each timestep and will perform swapping and smoothing as required. More...
subroutine	step_all_fields (current_state)
	Steps all fields. More...
subroutine	determine_local_flow_minmax (current_state, local_y, local_x)
	Determines the minimum and maximum values for the local flow field. These are before the stepping, and are all reduced later on in the cfl test. More...
subroutine	reset_local_minmax_values (current_state)
	Resets the local min and max values for the flow fields. More...
subroutine	remove_negative_rounding_errors_for_single_field (x_local_index, y_local_index, x_prev, y_prev, field, local_grid)
	Removes the negative rounding errors from a specific single field. This works two columns behind and then catches up on the last column. More...
subroutine	remove_negative_rounding_errors_in_slice (y_local_index, x_prev, y_prev, field, local_grid)
	Removes the negative rounding errors from a slice of a single field. This works two columns behind and then catches up on the last column. More...
subroutine	step_single_field (x_local_index, y_local_index, x_prev, y_prev, field, zfield, sfield, local_grid, flow_field, direction, dtm, gal, c1, c2, do_timesmoothing, sav)
	Steps a single specific field. This will step on the yth column of the x-2 slice and x-1 and x if this is the last slice. More...
subroutine	perform_timesmooth_for_field (field, zfield, local_grid, x_index, y_index, c1, c2)
	Performs initial timesmoothing for a theta or Q field using Robert filter. This is finished off in swapsmooth. More...
subroutine	step_column_in_slice (y_local_index, x_prev, y_prev, field, zfield, sfield, local_grid, flow_field, direction, dtm, gal, c1, c2, do_timesmoothing, sav)
	Will step a column in a specific slice. If y_prev is large enough then will step the y-1 column and if this is the last column of the slice then will also step the current column. More...
subroutine	step_field (x_local_index, y_local_index, field, zfield, sfield, local_grid, flow_field, direction, dtm, gal, sav)
	Will do the actual field stepping. More...

Variables
logical	determine_flow_minmax =.false.
logical	cfl_is_enabled
real(kind=default_precision), dimension(:), allocatable	resetq_min
logical	l_nonconservative_positive_q =.true.

Detailed Description

Does the field stepping Stepping is called at the end of processing a column and steps the x-2 column.

Function/Subroutine Documentation

determine_local_flow_minmax()

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

private

Determines the minimum and maximum values for the local flow field. These are before the stepping, and are all reduced later on in the cfl test.

Parameters

current_state	The current model state
local_y	The local y index
local_x	The local x index

Definition at line 146 of file stepfields.F90.

    type(model_state_type), target, intent(inout) :: current_state
    integer, intent(in) :: local_x, local_y
    
    integer :: k
    
    do k=2, current_state%local_grid%local_domain_end_index(z_index)
#ifdef U_ACTIVE
      current_state%local_zumax = max(current_state%local_zumax, current_state%zu%data(k,local_y,local_x))
      current_state%local_zumin = min(current_state%local_zumin, current_state%zu%data(k,local_y,local_x))
#endif
#ifdef V_ACTIVE
      current_state%local_zvmax = max(current_state%local_zvmax, current_state%zv%data(k,local_y,local_x))
      current_state%local_zvmin = min(current_state%local_zvmin, current_state%zv%data(k,local_y,local_x))
#endif
#ifdef W_ACTIVE
      if (k .lt. current_state%local_grid%local_domain_end_index(z_index)) then
        current_state%abswmax(k) = max(current_state%abswmax(k), abs(current_state%zw%data(k,local_y,local_x)))
      end if
#endif
    end do    

Here is the caller graph for this function:

finalisation_callback()

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

private

Finalisation callback.

Parameters

current_state

The current model state

Definition at line 51 of file stepfields.F90.

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

    deallocate(resetq_min)

Here is the caller graph for this function:

initialisation_callback()

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

private

Initialisation callback.

Parameters

current_state

The current model state

Definition at line 40 of file stepfields.F90.

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

    allocate(resetq_min(current_state%number_q_fields))
    cfl_is_enabled=is_component_enabled(current_state%options_database, "cfltest") 
    if (cfl_is_enabled) call reset_local_minmax_values(current_state)

Here is the call graph for this function:

Here is the caller graph for this function:

perform_timesmooth_for_field()

subroutine stepfields_mod::perform_timesmooth_for_field ( type(prognostic_field_type), intent(inout)  field, type(prognostic_field_type), intent(inout)  zfield, type(local_grid_type), intent(inout)  local_grid, integer, intent(in)  x_index, integer, intent(in)  y_index, real(kind=default_precision), intent(in)  c1, real(kind=default_precision), intent(in)  c2  )

private

Performs initial timesmoothing for a theta or Q field using Robert filter. This is finished off in swapsmooth.

Parameters

field	The field to smooth
zfield	The zfield to use in smoothing
local_grid	Description of the local grid
x_index	The X index to work on
y_index	The Y index to work on
c1	Constant to use in smoothing
c2	Constant to use in smoothing

Definition at line 296 of file stepfields.F90.

    type(prognostic_field_type), intent(inout) :: field, zfield
    type(local_grid_type), intent(inout) :: local_grid
    integer, intent(in) :: x_index, y_index
    real(kind=DEFAULT_PRECISION), intent(in) :: c1, c2

    integer :: k

    do k=1,local_grid%size(z_index)
      field%data(k, y_index, x_index)=c1*field%data(k, y_index, x_index)+c2*zfield%data(k, y_index, x_index)
    end do    

Here is the caller graph for this function:

remove_negative_rounding_errors_for_single_field()

subroutine stepfields_mod::remove_negative_rounding_errors_for_single_field ( integer, intent(in)  x_local_index, integer, intent(in)  y_local_index, integer, intent(in)  x_prev, integer, intent(in)  y_prev, type(prognostic_field_type), intent(inout)  field, type(local_grid_type), intent(inout)  local_grid  )

private

Removes the negative rounding errors from a specific single field. This works two columns behind and then catches up on the last column.

Parameters

x_local_index	The current local x index
y_local_index	The current local y index
x_prev	The previous x index to step
y_prev	The previous y index to step
field	The prognostic field
local_grid	Description of the local grid

Definition at line 190 of file stepfields.F90.

    integer, intent(in) :: x_local_index, y_local_index, x_prev, y_prev
    type(local_grid_type), intent(inout) :: local_grid
    type(prognostic_field_type), intent(inout) :: field

    if (x_prev .ge. local_grid%local_domain_start_index(x_index)) then
      call remove_negative_rounding_errors_in_slice(y_local_index, x_prev, y_prev, field, local_grid)
    end if
    if (x_local_index == local_grid%local_domain_end_index(x_index)) then
      if (x_local_index .gt. 1) then
        call remove_negative_rounding_errors_in_slice(y_local_index, x_local_index-1, y_prev, field, local_grid)
      end if
      call remove_negative_rounding_errors_in_slice(y_local_index, x_local_index, y_prev, field, local_grid)
    end if    

Here is the call graph for this function:

Here is the caller graph for this function:

remove_negative_rounding_errors_in_slice()

subroutine stepfields_mod::remove_negative_rounding_errors_in_slice ( integer, intent(in)  y_local_index, integer, intent(in)  x_prev, integer, intent(in)  y_prev, type(prognostic_field_type), intent(inout)  field, type(local_grid_type), intent(inout)  local_grid  )

private

Removes the negative rounding errors from a slice of a single field. This works two columns behind and then catches up on the last column.

Parameters

y_local_index	The current local y index
x_prev	The previous x index to step
y_prev	The previous y index to step
field	The prognostic field
local_grid	Description of the local grid

Definition at line 213 of file stepfields.F90.

    integer, intent(in) :: y_local_index, x_prev, y_prev
    type(local_grid_type), intent(inout) :: local_grid
    type(prognostic_field_type), intent(inout) :: field

    if (y_prev .ge. local_grid%local_domain_start_index(y_index)) then
      where (field%data(:, y_prev,  x_prev) < 0.0_default_precision)
        field%data(:, y_prev,  x_prev)=0.0_default_precision
      end where
    end if
    if (y_local_index == local_grid%local_domain_end_index(y_index)) then
      where (field%data(:, y_local_index,  x_prev) < 0.0_default_precision)
        field%data(:, y_local_index,  x_prev)=0.0_default_precision
      end where
    end if    

Here is the caller graph for this function:

reset_local_minmax_values()

subroutine stepfields_mod::reset_local_minmax_values ( type(model_state_type), intent(inout), target  current_state )

private

Resets the local min and max values for the flow fields.

Parameters

current_state

The current model state

Definition at line 171 of file stepfields.F90.

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

    ! Reset the local values for the next timestep
    current_state%local_zumin=rlargep
    current_state%local_zumax=-rlargep
    current_state%local_zvmin=rlargep
    current_state%local_zvmax=-rlargep
    current_state%abswmax=-rlargep

Here is the caller graph for this function:

step_all_fields()

subroutine stepfields_mod::step_all_fields ( type(model_state_type), intent(inout), target  current_state )

private

Steps all fields.

Parameters

current_state

The current model state_mod

Definition at line 98 of file stepfields.F90.

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

    integer :: x_prev, y_prev, i, k
    real(kind=DEFAULT_PRECISION) :: c1, c2

    x_prev = current_state%column_local_x-2
    y_prev = current_state%column_local_y-1

    c1 = 1.0_default_precision - 2.0_default_precision*current_state%tsmth                                               
    c2 = current_state%tsmth

#ifdef U_ACTIVE   
    call step_single_field(current_state%column_local_x,  current_state%column_local_y, &
         x_prev, y_prev, current_state%u, current_state%zu, current_state%su, current_state%local_grid, .true., &
         current_state%field_stepping, current_state%dtm, current_state%ugal, c1, c2, .false., current_state%savu)
#endif
#ifdef V_ACTIVE
    call step_single_field(current_state%column_local_x,  current_state%column_local_y, &
         x_prev, y_prev, current_state%v, current_state%zv, current_state%sv, current_state%local_grid, .true., &
         current_state%field_stepping, current_state%dtm, current_state%vgal, c1, c2, .false., current_state%savv)
#endif
#ifdef W_ACTIVE
    call step_single_field(current_state%column_local_x,  current_state%column_local_y, &
         x_prev, y_prev, current_state%w, current_state%zw, current_state%sw, current_state%local_grid, .false., &
         current_state%field_stepping, current_state%dtm, real(0., kind=DEFAULT_PRECISION), c1, c2, .false., current_state%savw)
#endif
    if (current_state%th%active) then       
       call step_single_field(current_state%column_local_x,  current_state%column_local_y, &
         x_prev, y_prev, current_state%th, current_state%zth, current_state%sth, current_state%local_grid, .false., &
         current_state%field_stepping, current_state%dtm, real(0., kind=DEFAULT_PRECISION), c1, c2, &
         current_state%field_stepping == centred_stepping)
    endif
    do i=1,current_state%number_q_fields
      if (current_state%q(i)%active) then         
        call step_single_field(current_state%column_local_x,  current_state%column_local_y, x_prev, y_prev, &
             current_state%q(i), current_state%zq(i), current_state%sq(i), current_state%local_grid, .false., &
             current_state%field_stepping, current_state%dtm, real(0., kind=DEFAULT_PRECISION), c1, c2, &
             current_state%field_stepping == centred_stepping)
      end if
    end do

Here is the call graph for this function:

Here is the caller graph for this function:

step_column_in_slice()

subroutine stepfields_mod::step_column_in_slice ( integer, intent(in)  y_local_index, integer, intent(in)  x_prev, integer, intent(in)  y_prev, type(prognostic_field_type), intent(inout)  field, type(prognostic_field_type), intent(inout)  zfield, type(prognostic_field_type), intent(inout)  sfield, type(local_grid_type), intent(inout)  local_grid, logical, intent(in)  flow_field, integer, intent(in)  direction, real(kind=default_precision), intent(in)  dtm, real(kind=default_precision), intent(in)  gal, real(kind=default_precision), intent(in)  c1, real(kind=default_precision), intent(in)  c2, logical, intent(in)  do_timesmoothing, type(prognostic_field_type), intent(inout), optional  sav  )

private

Will step a column in a specific slice. If y_prev is large enough then will step the y-1 column and if this is the last column of the slice then will also step the current column.

Parameters

x_local_index	The current local x index
y_local_index	The current local y index
x_prev	The previous x index to step
y_prev	The previous y index to step
field	The prognostic field
zfield	Z prognostic field
sfield	Source terms for the prognostic field
local_grid	Description of the local grid
flow_field	Whether or not this is a flow field
direction	The stepping direction (centred or forward)
dtm	The delta time per timestep
gal	Galilean transformation
c1	Constant to use in smoothing
c2	Constant to use in smoothing
do_timesmoothing	Whether timesmoothing using Robert filter should be done on the field
sav	Optional sav field

Definition at line 328 of file stepfields.F90.

    integer, intent(in) :: y_local_index, x_prev, y_prev, direction
    real(kind=DEFAULT_PRECISION), intent(in) :: dtm, gal
    logical, intent(in) :: flow_field, do_timesmoothing
    type(local_grid_type), intent(inout) :: local_grid
    type(prognostic_field_type), intent(inout) :: field, zfield, sfield
    real(kind=DEFAULT_PRECISION), intent(in) :: c1, c2
    type(prognostic_field_type), optional, intent(inout) :: sav

    if (y_prev .ge. local_grid%local_domain_start_index(y_index)) then
      if (do_timesmoothing) then
        call perform_timesmooth_for_field(field, zfield, local_grid, x_prev, y_prev, c1, c2)
      end if      
      if (present(sav)) then
        call step_field(x_prev, y_prev, field, zfield, sfield, local_grid, flow_field, direction, dtm, gal, sav)
      else
        call step_field(x_prev, y_prev, field, zfield, sfield, local_grid, flow_field, direction, dtm, gal)
      end if
    end if

    if (y_local_index == local_grid%local_domain_end_index(y_index)) then
      if (do_timesmoothing) then
        call perform_timesmooth_for_field(field, zfield, local_grid, x_prev, y_local_index, c1, c2)
      end if 
      if (present(sav)) then
        call step_field(x_prev, y_local_index, field, zfield, sfield, local_grid, flow_field, direction, dtm, gal, sav)
      else
        call step_field(x_prev, y_local_index, field, zfield, sfield, local_grid, flow_field, direction, dtm, gal)
      end if
    end if

Here is the call graph for this function:

Here is the caller graph for this function:

step_field()

subroutine stepfields_mod::step_field ( integer, intent(in)  x_local_index, integer, intent(in)  y_local_index, type(prognostic_field_type), intent(inout)  field, type(prognostic_field_type), intent(inout)  zfield, type(prognostic_field_type), intent(inout)  sfield, type(local_grid_type), intent(inout)  local_grid, logical, intent(in)  flow_field, integer, intent(in)  direction, real(kind=default_precision), intent(in)  dtm, real(kind=default_precision), intent(in)  gal, type(prognostic_field_type), intent(inout), optional  sav  )

private

Will do the actual field stepping.

Parameters

flow_field	Whether or not we are stepping a flow field
direction	1=forward, 0=centred
x_index	The local X slice index
y_index	The local Y column index
kkp	Points in the vertical column
dtm	The model timestep
field	The prognostic field
zfield	The prognostic z field (which goes to timestep t+1)
xfield	The tendency of the field
gal	The galilean transformation

Definition at line 371 of file stepfields.F90.

    integer, intent(in) :: x_local_index, y_local_index, direction
    real(kind=DEFAULT_PRECISION), intent(in) :: dtm, gal
    logical, intent(in) :: flow_field
    type(local_grid_type), intent(inout) :: local_grid
    type(prognostic_field_type), intent(inout) :: field, zfield, sfield
    type(prognostic_field_type), optional, intent(inout) :: sav

    integer :: k
    real(kind=DEFAULT_PRECISION) :: actual_gal, dtm_x2

    dtm_x2 = 2.0_default_precision * dtm

    actual_gal = merge(gal, real(0.0_DEFAULT_PRECISION, kind=DEFAULT_PRECISION), flow_field)

    sfield%data(1,y_local_index, x_local_index)=0.0_default_precision

    do k=1,local_grid%size(z_index)
      ! Save the Z field which is used in the Robert filter
      if (present(sav) .and. direction .eq. centred_stepping) &
           sav%data(k,y_local_index, x_local_index) = zfield%data(k, y_local_index, x_local_index) + actual_gal
      if (flow_field) field%data(k, y_local_index, x_local_index) = actual_gal + field%data(k, y_local_index, x_local_index)
      if (direction == forward_stepping) then
        zfield%data(k, y_local_index, x_local_index) = field%data(k, y_local_index, x_local_index) + dtm * &
             sfield%data(k, y_local_index, x_local_index)
      else
        zfield%data(k, y_local_index, x_local_index) = actual_gal+zfield%data(k, y_local_index, x_local_index)+dtm_x2*&
             sfield%data(k, y_local_index, x_local_index)
      end if
    end do

Here is the caller graph for this function:

step_single_field()

subroutine stepfields_mod::step_single_field ( integer, intent(in)  x_local_index, integer, intent(in)  y_local_index, integer, intent(in)  x_prev, integer, intent(in)  y_prev, type(prognostic_field_type), intent(inout)  field, type(prognostic_field_type), intent(inout)  zfield, type(prognostic_field_type), intent(inout)  sfield, type(local_grid_type), intent(inout)  local_grid, logical, intent(in)  flow_field, integer, intent(in)  direction, real(kind=default_precision), intent(in)  dtm, real(kind=default_precision), intent(in)  gal, real(kind=default_precision), intent(in)  c1, real(kind=default_precision), intent(in)  c2, logical, intent(in)  do_timesmoothing, type(prognostic_field_type), intent(inout), optional  sav  )

private

Steps a single specific field. This will step on the yth column of the x-2 slice and x-1 and x if this is the last slice.

Parameters

x_local_index	The current local x index
y_local_index	The current local y index
x_prev	The previous x index to step
y_prev	The previous y index to step
field	The prognostic field
zfield	Z prognostic field
sfield	Source terms for the prognostic field
local_grid	Description of the local grid
flow_field	Whether or not this is a flow field
direction	The stepping direction (centred or forward)
dtm	The delta time per timestep
gal	Galilean transformation
c1	Constant to use in smoothing
c2	Constant to use in smoothing
do_timesmoothing	Whether timesmoothing using Robert filter should be done on the field
sav	Optional sav field

Definition at line 248 of file stepfields.F90.

    integer, intent(in) :: x_local_index, y_local_index, x_prev, y_prev, direction
    real(kind=DEFAULT_PRECISION), intent(in) :: dtm, gal
    logical, intent(in) :: flow_field, do_timesmoothing
    type(local_grid_type), intent(inout) :: local_grid
    type(prognostic_field_type), intent(inout) :: field, zfield, sfield
    real(kind=DEFAULT_PRECISION), intent(in) :: c1, c2
    type(prognostic_field_type), optional, intent(inout) :: sav

    if (x_prev .ge. local_grid%local_domain_start_index(x_index)) then
      if (present(sav)) then
        call step_column_in_slice(y_local_index, x_prev, y_prev, field, zfield, sfield, local_grid, &
             flow_field, direction, dtm, gal, c1, c2, do_timesmoothing, sav)
      else               
        call step_column_in_slice(y_local_index, x_prev, y_prev, field, zfield, sfield, local_grid, &
             flow_field, direction, dtm, gal, c1, c2, do_timesmoothing)
      end if
    end if

    if (x_local_index == local_grid%local_domain_end_index(x_index)) then
      ! If this is the last slice then process x-1 (if applicable) and x too
      if (x_local_index .gt. 1) then
        if (present(sav)) then
          call step_column_in_slice(y_local_index, x_local_index-1, y_prev, field, zfield, sfield, local_grid, &
               flow_field, direction, dtm, gal, c1, c2, do_timesmoothing, sav)
        else
          call step_column_in_slice(y_local_index, x_local_index-1, y_prev, field, zfield, sfield, local_grid, &
               flow_field, direction, dtm, gal, c1, c2, do_timesmoothing)
        end if
      end if
      if (present(sav)) then
        call step_column_in_slice(y_local_index, x_local_index, y_prev, field, zfield, sfield, local_grid, &
             flow_field, direction, dtm, gal, c1, c2, do_timesmoothing, sav)     
      else
        call step_column_in_slice(y_local_index, x_local_index, y_prev, field, zfield, sfield, local_grid, &
             flow_field, direction, dtm, gal, c1, c2, do_timesmoothing)     
      end if
    end if

Here is the call graph for this function:

Here is the caller graph for this function:

stepfields_get_descriptor()

type(component_descriptor_type) function, public stepfields_mod::stepfields_get_descriptor

(

)

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

Returns

The KidReader component descriptor

Definition at line 30 of file stepfields.F90.

    stepfields_get_descriptor%name="stepfields"
    stepfields_get_descriptor%version=0.1
    stepfields_get_descriptor%initialisation=>initialisation_callback
    stepfields_get_descriptor%timestep=>timestep_callback
    stepfields_get_descriptor%finalisation=>finalisation_callback

Here is the call graph for this function:

timestep_callback()

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

private

Called at each timestep and will perform swapping and smoothing as required.

Parameters

current_state

The current model state_mod

Definition at line 59 of file stepfields.F90.

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

    integer :: iq

    if (cfl_is_enabled .and. current_state%first_timestep_column) then
      if (mod(current_state%timestep, current_state%cfl_frequency) == 1 .or. &
         current_state%timestep-current_state%start_timestep .le. current_state%cfl_frequency) then
        determine_flow_minmax=.true.
        call reset_local_minmax_values(current_state)
      else
        determine_flow_minmax=.false.
      end if
    end if

    if (.not. current_state%halo_column) then
      if (determine_flow_minmax .and. cfl_is_enabled) &
         call determine_local_flow_minmax(current_state, current_state%column_local_y,  current_state%column_local_x)
      call step_all_fields(current_state)
    end if

    ! Remove negative rounding errors
    if (l_nonconservative_positive_q)then
      do iq=1,current_state%number_q_fields
        if (current_state%first_timestep_column)then
          resetq_min(iq)=minval(current_state%zq(iq)%data(:,current_state%column_local_y,  current_state%column_local_x))
        else
          resetq_min(iq)=min(resetq_min(iq),&
             minval(current_state%zq(iq)%data(:,current_state%column_local_y,  current_state%column_local_x)))
        end if
        call remove_negative_rounding_errors_for_single_field(current_state%column_local_x, current_state%column_local_y, &
             current_state%column_local_x-2, current_state%column_local_y-1, current_state%zq(iq), current_state%local_grid)
      end do
    end if

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

cfl_is_enabled

logical stepfields_mod::cfl_is_enabled

private

Definition at line 17 of file stepfields.F90.

determine_flow_minmax

logical stepfields_mod::determine_flow_minmax =.false.

private

Definition at line 17 of file stepfields.F90.

  logical :: determine_flow_minmax=.false., cfl_is_enabled

l_nonconservative_positive_q

logical stepfields_mod::l_nonconservative_positive_q =.true.

private

Definition at line 21 of file stepfields.F90.

  logical :: l_nonconservative_positive_q=.true.

resetq_min

real(kind=default_precision), dimension(:), allocatable stepfields_mod::resetq_min

private

Definition at line 20 of file stepfields.F90.

  real(kind=DEFAULT_PRECISION), allocatable :: resetq_min(:)