timestepper_mod Module Reference

Performs the actual time stepping over groups of components. Each group can be the whole (which is one call per component per timestep) or column, which calls components for each column of the timestep. Groups are executed sequentially in the order that they have been configured (which is already set up in the registry) More...

Functions/Subroutines
subroutine, public	init_timestepper ()
	Initialises the timestepper by prefetching the groups in the order that they will be executed, this is for optimised execution in the timestep calls. More...
subroutine, public	timestep (current_state)
	Performs a timestep, which is comprised of executing each group of components in the order that they have been configured in. The components in a group can be called, depending on the type, just once per timestep (WHOLE) or per column (COLUMN). More...
subroutine, public	finalise_timestepper ()
	Finalises the timestepper by cleaning up allocated memory. More...
subroutine	timestep_column (current_state, group_descriptor)
	Performs timestepping for a group of components on a per column basis. Each component in the group is executed for every column. More...
subroutine	timestep_whole (current_state, group_descriptor)
	Executes a timestep for components in a group which are designed to be executed once per timestep. More...
subroutine	update_state_sitation_flags (current_state)
	Updates the states situation flags for easy retrieval in the components that are run per timestep. More...

Variables
type(group_descriptor_type), dimension(:), allocatable	group_descriptors
	Prefetched ordered group descriptors. More...

Detailed Description

Performs the actual time stepping over groups of components. Each group can be the whole (which is one call per component per timestep) or column, which calls components for each column of the timestep. Groups are executed sequentially in the order that they have been configured (which is already set up in the registry)

Function/Subroutine Documentation

finalise_timestepper()

subroutine, public timestepper_mod::finalise_timestepper

Finalises the timestepper by cleaning up allocated memory.

Definition at line 44 of file timestepper.F90.

    deallocate(group_descriptors)

Here is the caller graph for this function:

init_timestepper()

subroutine, public timestepper_mod::init_timestepper

Initialises the timestepper by prefetching the groups in the order that they will be executed, this is for optimised execution in the timestep calls.

Definition at line 22 of file timestepper.F90.

    call get_ordered_groups(group_descriptors)

Here is the call graph for this function:

Here is the caller graph for this function:

timestep()

subroutine, public timestepper_mod::timestep

(

type(model_state_type), intent(inout)

current_state

)

Performs a timestep, which is comprised of executing each group of components in the order that they have been configured in. The components in a group can be called, depending on the type, just once per timestep (WHOLE) or per column (COLUMN).

Parameters

current_state

The current model state

Definition at line 29 of file timestepper.F90.

    type(model_state_type), intent(inout) :: current_state
 
    integer :: i
 
    do i=1,size(group_descriptors)      
      if (group_descriptors(i)%type == group_type_whole) then
        call timestep_whole(current_state, group_descriptors(i))
      else if (group_descriptors(i)%type == group_type_column) then
        call timestep_column(current_state, group_descriptors(i))
      end if
    end do    

Here is the call graph for this function:

Here is the caller graph for this function:

timestep_column()

subroutine timestepper_mod::timestep_column ( type(model_state_type), intent(inout)  current_state, type(group_descriptor_type), intent(in)  group_descriptor  )

private

Performs timestepping for a group of components on a per column basis. Each component in the group is executed for every column.

Parameters

current_state	The current model state
group_descriptor	Description of the group of components to execute

Definition at line 52 of file timestepper.F90.

    type(model_state_type), intent(inout) :: current_state
    type(group_descriptor_type), intent(in) :: group_descriptor
 
    current_state%column_global_x=current_state%local_grid%start(x_index) - current_state%local_grid%halo_size(x_index)
    current_state%column_local_x=1
    do while (current_state%column_global_x .le. &
         current_state%local_grid%end(x_index)+current_state%local_grid%halo_size(x_index))
      current_state%column_global_y = current_state%local_grid%start(y_index) - current_state%local_grid%halo_size(y_index)
      current_state%column_local_y=1
      do while (current_state%column_global_y .le. &
           current_state%local_grid%end(y_index)+current_state%local_grid%halo_size(y_index))
        call update_state_sitation_flags(current_state)
        call execute_timestep_callbacks(current_state, group_descriptor%id)
        current_state%column_global_y = current_state%column_global_y + 1
        current_state%column_local_y = current_state%column_local_y + 1
      end do
      current_state%column_global_x = current_state%column_global_x + 1
      current_state%column_local_x = current_state%column_local_x + 1
    end do    

Here is the call graph for this function:

Here is the caller graph for this function:

timestep_whole()

subroutine timestepper_mod::timestep_whole ( type(model_state_type), intent(inout)  current_state, type(group_descriptor_type), intent(in)  group_descriptor  )

private

Executes a timestep for components in a group which are designed to be executed once per timestep.

Parameters

current_state	The current model state
group_descriptor	Description of the group of components to execute

Definition at line 77 of file timestepper.F90.

    type(model_state_type), intent(inout) :: current_state
    type(group_descriptor_type), intent(in) :: group_descriptor
 
    call execute_timestep_callbacks(current_state, group_descriptor%id)

Here is the call graph for this function:

Here is the caller graph for this function:

update_state_sitation_flags()

subroutine timestepper_mod::update_state_sitation_flags ( type(model_state_type), intent(inout)  current_state )

private

Updates the states situation flags for easy retrieval in the components that are run per timestep.

Parameters

state

The current model state

Definition at line 87 of file timestepper.F90.

    type(model_state_type), intent(inout) :: current_state
 
    current_state%first_timestep_column = (current_state%column_local_x == 1 .and. current_state%column_local_y == 1)
    current_state%last_timestep_column = (current_state%column_global_x == &
         current_state%local_grid%end(x_index) + current_state%local_grid%halo_size(x_index) .and. &
         current_state%column_global_y == current_state%local_grid%end(y_index) + current_state%local_grid%halo_size(y_index))   
 
    current_state%first_nonhalo_timestep_column = (current_state%column_local_x == current_state%local_grid%halo_size(x_index)+1 &
       .and. current_state%column_local_y == current_state%local_grid%halo_size(y_index)+1)
 
    current_state%halo_column = current_state%column_local_y .lt. current_state%local_grid%local_domain_start_index(y_index) .or.&
         current_state%column_local_x .lt. current_state%local_grid%local_domain_start_index(x_index) .or.&
         current_state%column_local_y .gt. current_state%local_grid%local_domain_end_index(y_index) .or.&
         current_state%column_local_x .gt. current_state%local_grid%local_domain_end_index(x_index)

Here is the caller graph for this function:

Variable Documentation

group_descriptors

type(group_descriptor_type), dimension(:), allocatable timestepper_mod::group_descriptors

private

Prefetched ordered group descriptors.

Definition at line 15 of file timestepper.F90.

  type(group_descriptor_type), dimension(:), allocatable :: group_descriptors