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	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 call back which will read in the coriolis configuration and set up the geostrophic winds. More...

subroutine	finalisation_callback (current_state)

subroutine	timestep_callback (current_state)
	For each none halo cell this will calculate the coriolis terms for su and sv 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
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

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

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

logical	l_tend_3d_u

logical	l_tend_3d_v

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

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

logical	l_tend_pr_tot_u

logical	l_tend_pr_tot_v

integer	diagnostic_generation_frequency

Detailed Description

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

Function/Subroutine Documentation

◆ compute_component_tendencies()

subroutine coriolis_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 298 of file coriolis.F90.

     type(model_state_type), target, intent(inout) :: current_state
     integer, intent(in) ::  cxn, cyn, txn, tyn
  
     ! Calculate change in tendency due to component
     if (l_tend_3d_u) then
       tend_3d_u(:,tyn,txn)=current_state%su%data(:,cyn,cxn) - tend_3d_u(:,tyn,txn)
     endif
     if (l_tend_3d_v) then
       tend_3d_v(:,tyn,txn)=current_state%sv%data(:,cyn,cxn) - tend_3d_v(:,tyn,txn)
     endif
  
    ! Add local tendency fields to the profile total
     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
  

Here is the caller graph for this function:

◆ 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 38 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
     coriolis_get_descriptor%finalisation=>finalisation_callback
  
     coriolis_get_descriptor%field_value_retrieval=>field_value_retrieval_callback
     coriolis_get_descriptor%field_information_retrieval=>field_information_retrieval_callback
     allocate(coriolis_get_descriptor%published_fields(2+2))
  
     coriolis_get_descriptor%published_fields(1)= "tend_u_coriolis_3d_local"
     coriolis_get_descriptor%published_fields(2)= "tend_v_coriolis_3d_local"
  
     coriolis_get_descriptor%published_fields(2+1)= "tend_u_coriolis_profile_total_local"
     coriolis_get_descriptor%published_fields(2+2)= "tend_v_coriolis_profile_total_local"
  

Here is the call graph for this function:

◆ field_information_retrieval_callback()

subroutine coriolis_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 62 of file coriolis.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, "coriolis_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_coriolis_3d_local") then
         field_information%enabled=l_tend_3d_u
       else if (name .eq. "tend_v_coriolis_3d_local") then
         field_information%enabled=l_tend_3d_v
       else
         field_information%enabled=.true.
       end if
  
     end if !end 3d check
  
     ! Field information for profiles
     strcomp=index(name, "coriolis_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_coriolis_profile_total_local") then
         field_information%enabled=l_tend_pr_tot_u
       else if (name .eq. "tend_v_coriolis_profile_total_local") then
         field_information%enabled=l_tend_pr_tot_v
       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 coriolis_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 113 of file coriolis.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_coriolis_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_coriolis_3d_local" .and. allocated(tend_3d_v)) then
       call set_published_field_value(field_value, real_3d_field=tend_3d_v)
  
     ! Profile Tendency Fields
     else if (name .eq. "tend_u_coriolis_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_coriolis_profile_total_local" .and. allocated(tend_pr_tot_v)) then
       call set_published_field_value(field_value, real_1d_field=tend_pr_tot_v)
     end if
  
  

Here is the call graph for this function:

Here is the caller graph for this function:

◆ finalisation_callback()

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

private

Definition at line 198 of file coriolis.F90.

     type(model_state_type), target, intent(inout) :: current_state
  
     if (allocated(tend_3d_u)) deallocate(tend_3d_u)
     if (allocated(tend_3d_v)) deallocate(tend_3d_v)
  
     if (allocated(tend_pr_tot_u)) deallocate(tend_pr_tot_u)
     if (allocated(tend_pr_tot_v)) deallocate(tend_pr_tot_v)
  

Here is the caller 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 137 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
  
     ! Tendency Logicals
     l_tend_pr_tot_u   = current_state%u%active
     l_tend_pr_tot_v   = current_state%v%active
  
     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
  
     ! Allocate 3d tendency fields upon availability
     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
  
     ! Allocate profile tendency fields upon availability
     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
  
     ! 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:

◆ save_precomponent_tendencies()

subroutine coriolis_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 277 of file coriolis.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_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
  

Here is the caller graph for this function:

◆ set_published_field_value()

subroutine coriolis_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 324 of file coriolis.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:

◆ 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 211 of file coriolis.F90.

     type(model_state_type), target, intent(inout) :: current_state
  
     integer :: local_y, locaL_x, k, 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_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
     endif  ! zero totals
  
     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
  
     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
     
     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
  
     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

◆ baroclinicity_use_geostrophic_shear

logical coriolis_mod::baroclinicity_use_geostrophic_shear

private

Definition at line 16 of file coriolis.F90.

16 logical :: baroclinicity_use_geostrophic_shear

◆ diagnostic_generation_frequency

integer coriolis_mod::diagnostic_generation_frequency

private

Definition at line 30 of file coriolis.F90.

30 integer :: diagnostic_generation_frequency

◆ fcoriol

real(kind=default_precision) coriolis_mod::fcoriol

private

Definition at line 18 of file coriolis.F90.

18 real(kind=default_precision) :: fcoriol

◆ geostrophic_wind_x

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

private

Definition at line 17 of file coriolis.F90.

17 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 17 of file coriolis.F90.

◆ l_tend_3d_u

logical coriolis_mod::l_tend_3d_u

private

Definition at line 24 of file coriolis.F90.

24 logical :: l_tend_3d_u, l_tend_3d_v

◆ l_tend_3d_v

logical coriolis_mod::l_tend_3d_v

private

Definition at line 24 of file coriolis.F90.

◆ l_tend_pr_tot_u

logical coriolis_mod::l_tend_pr_tot_u

private

Definition at line 28 of file coriolis.F90.

28 logical :: l_tend_pr_tot_u, l_tend_pr_tot_v

◆ l_tend_pr_tot_v

logical coriolis_mod::l_tend_pr_tot_v

private

Definition at line 28 of file coriolis.F90.

◆ tend_3d_u

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

private

Definition at line 22 of file coriolis.F90.

22 real(kind=default_precision), dimension(:,:,:), allocatable :: &

23 tend_3d_u, tend_3d_v

◆ tend_3d_v

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

private

Definition at line 22 of file coriolis.F90.

◆ tend_pr_tot_u

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

private

Definition at line 26 of file coriolis.F90.

26 real(kind=default_precision), dimension(:), allocatable :: &

27 tend_pr_tot_u, tend_pr_tot_v

◆ tend_pr_tot_v

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

private

Definition at line 26 of file coriolis.F90.

Functions/Subroutines

Variables

Detailed Description

Function/Subroutine Documentation

◆ compute_component_tendencies()

◆ coriolis_get_descriptor()

◆ field_information_retrieval_callback()

◆ field_value_retrieval_callback()

◆ finalisation_callback()

◆ initialisation_callback()

◆ save_precomponent_tendencies()

◆ set_published_field_value()

◆ timestep_callback()

Variable Documentation

◆ baroclinicity_use_geostrophic_shear

◆ diagnostic_generation_frequency

◆ fcoriol

◆ geostrophic_wind_x

◆ geostrophic_wind_y

◆ l_tend_3d_u

◆ l_tend_3d_v

◆ l_tend_pr_tot_u

◆ l_tend_pr_tot_v

◆ tend_3d_u

◆ tend_3d_v

◆ tend_pr_tot_u

◆ tend_pr_tot_v