coriolis_mod Module Reference

This calculates the coriolis and mean pressure gradient terms which impact su and sv fields. More...

Functions/Subroutines
type(component_descriptor_type) function, public	coriolis_get_descriptor ()
	Provides the descriptor back to the caller and is used in component registration. More...
subroutine	initialisation_callback (current_state)
	Initialisation call back which will read in the coriolis configuration and set up the geostrophic winds. More...
subroutine	timestep_callback (current_state)
	For each none halo cell this will calculate the coriolis terms for su and sv fields. More...

Variables
logical	baroclinicity_use_geostrophic_shear
real(kind=default_precision), dimension(:), allocatable	geostrophic_wind_x
real(kind=default_precision), dimension(:), allocatable	geostrophic_wind_y
real(kind=default_precision)	fcoriol

Detailed Description

This calculates the coriolis and mean pressure gradient terms which impact su and sv fields.

Function/Subroutine Documentation

coriolis_get_descriptor()

type(component_descriptor_type) function, public coriolis_mod::coriolis_get_descriptor

(

)

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

Returns

The termination check component descriptor

Definition at line 25 of file coriolis.F90.

    coriolis_get_descriptor%name="coriolis"
    coriolis_get_descriptor%version=0.1
    coriolis_get_descriptor%initialisation=>initialisation_callback
    coriolis_get_descriptor%timestep=>timestep_callback

Here is the call graph for this function:

initialisation_callback()

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

private

Initialisation call back which will read in the coriolis configuration and set up the geostrophic winds.

Parameters

current_state

The current model state

Definition at line 34 of file coriolis.F90.

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

    integer :: k
    
    baroclinicity_use_geostrophic_shear=options_get_logical(current_state%options_database, "baroclinicity_use_geostrophic_shear")
    fcoriol=options_get_real(current_state%options_database, "fcoriol")
    current_state%geostrophic_wind_rate_of_change_in_x=options_get_real(current_state%options_database, &
         "geostrophic_wind_rate_of_change_in_x")
    current_state%geostrophic_wind_rate_of_change_in_y=options_get_real(current_state%options_database, &
         "geostrophic_wind_rate_of_change_in_y")
    current_state%surface_geostrophic_wind_x=options_get_real(current_state%options_database, "surface_geostrophic_wind_x")
    current_state%surface_geostrophic_wind_y=options_get_real(current_state%options_database, "surface_geostrophic_wind_y")

    allocate(geostrophic_wind_x(current_state%local_grid%size(z_index)), &
         geostrophic_wind_y(current_state%local_grid%size(z_index)))

    do k=1,current_state%local_grid%size(z_index)
      geostrophic_wind_x(k)=current_state%surface_geostrophic_wind_x
      geostrophic_wind_y(k)=current_state%surface_geostrophic_wind_y
      if (baroclinicity_use_geostrophic_shear) then
        geostrophic_wind_x(k)=geostrophic_wind_x(k)+current_state%geostrophic_wind_rate_of_change_in_x*&
             current_state%global_grid%configuration%vertical%zn(k)
        geostrophic_wind_y(k)=geostrophic_wind_y(k)+current_state%geostrophic_wind_rate_of_change_in_y*&
             current_state%global_grid%configuration%vertical%zn(k)
      end if
    end do

Here is the caller graph for this function:

timestep_callback()

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

private

For each none halo cell this will calculate the coriolis terms for su and sv fields.

Parameters

current_state

The current model state

Definition at line 65 of file coriolis.F90.

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

    integer :: k

    if (current_state%halo_column) then
      if (.not. ((current_state%column_local_y == current_state%local_grid%halo_size(y_index) .and. &
           current_state%column_local_x .le. current_state%local_grid%local_domain_end_index(x_index) .and. &
           current_state%column_local_x .ge. current_state%local_grid%local_domain_start_index(x_index)-1) .or. &
           (current_state%column_local_x == current_state%local_grid%halo_size(x_index) .and. &
           current_state%column_local_y .ge. current_state%local_grid%local_domain_start_index(y_index) &
           .and. current_state%column_local_y .le. current_state%local_grid%local_domain_end_index(y_index)) )) return
    end if
    
    do k=2,current_state%local_grid%size(z_index)
#if defined(U_ACTIVE) && defined(V_ACTIVE)
      current_state%su%data(k, current_state%column_local_y, current_state%column_local_x)=&
           current_state%su%data(k, current_state%column_local_y, current_state%column_local_x)+fcoriol*&
           (0.25_default_precision*(current_state%v%data(k, current_state%column_local_y, current_state%column_local_x)+&
           current_state%v%data(k, current_state%column_local_y, current_state%column_local_x+1)+&
           current_state%v%data(k, current_state%column_local_y-1, current_state%column_local_x)+&
           current_state%v%data(k, current_state%column_local_y-1, current_state%column_local_x+1))+current_state%vgal-&
           geostrophic_wind_y(k))

      current_state%sv%data(k, current_state%column_local_y, current_state%column_local_x)=&
           current_state%sv%data(k, current_state%column_local_y, current_state%column_local_x)-fcoriol*&
           (0.25_default_precision*(current_state%u%data(k, current_state%column_local_y, current_state%column_local_x)+&
           current_state%u%data(k, current_state%column_local_y, current_state%column_local_x-1)+&
           current_state%u%data(k, current_state%column_local_y+1, current_state%column_local_x)+&
           current_state%u%data(k, current_state%column_local_y+1, current_state%column_local_x-1))+current_state%ugal-&
           geostrophic_wind_x(k))
#endif
    end do

Here is the caller graph for this function:

Variable Documentation

baroclinicity_use_geostrophic_shear

logical coriolis_mod::baroclinicity_use_geostrophic_shear

private

Definition at line 14 of file coriolis.F90.

  logical :: baroclinicity_use_geostrophic_shear

fcoriol

real(kind=default_precision) coriolis_mod::fcoriol

private

Definition at line 16 of file coriolis.F90.

  real(kind=DEFAULT_PRECISION) :: fcoriol

geostrophic_wind_x

real(kind=default_precision), dimension(:), allocatable coriolis_mod::geostrophic_wind_x

private

Definition at line 15 of file coriolis.F90.

  real(kind=DEFAULT_PRECISION), dimension(:), allocatable :: geostrophic_wind_x, geostrophic_wind_y

geostrophic_wind_y

real(kind=default_precision), dimension(:), allocatable coriolis_mod::geostrophic_wind_y

private

Definition at line 15 of file coriolis.F90.