thadvection_mod Module Reference

Specific theta advection, which involves the vertical advection of reference state and advection of mean baroclinicity. More...

Functions/Subroutines
type(component_descriptor_type) function, public	thadvection_get_descriptor ()
	Provides a description of this component for the core to register. More...
subroutine	initialisation_callback (current_state)
	Initialisation callback to set up the variables and data needed by the component. More...
subroutine	finalisation_callback (current_state)
subroutine	timestep_callback (current_state)
	Timestep callback, will call the two separate procedures to do their advection if needed. More...
subroutine	vertical_advection_of_reference_state (current_state, local_y, local_x)
	Vertical advection of the reference state. It doesn't seem consistent to do the advection in this way if TVD advection of the deviation from the reference state has been selected. Separate vertical advection of the reference state was introduced to improve energy conservation when carrying out idealized gravity wave simulations in a deep, dry isothermal layer, for which the difference in potential temp between top and bottom was of order 100K. In less extreme cases the benefits are unlikely to be significant and with TVD advection energy conservation has been compromised so the best way forward might be to recombine the reference state into l_th. More...
subroutine	advection_of_mean_baroclinicity (current_state, local_y, local_x)
	Performs advection of the mean baroclinicity if appropriate. 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	field_information_retrieval_callback (current_state, name, field_information)
	Field information retrieval callback, this returns information for a specific component's 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	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
logical	l_advect_mean_baroclinicity
real(kind=default_precision)	fcoriol
real(kind=default_precision)	fcoriol_over_g
real(kind=default_precision)	rate_change_geostrophic_wind_x
real(kind=default_precision)	rate_change_geostrophic_wind_y
real(kind=default_precision)	multiplicative_factor_x
real(kind=default_precision)	multiplicative_factor_y
real(kind=default_precision), dimension(:,:,:), allocatable	tend_3d_th
real(kind=default_precision), dimension(:,:,:), allocatable	tend_3d_tabs
logical	l_tend_3d_th
logical	l_tend_3d_tabs
real(kind=default_precision), dimension(:), allocatable	tend_pr_tot_th
real(kind=default_precision), dimension(:), allocatable	tend_pr_tot_tabs
logical	l_tend_pr_tot_th
logical	l_tend_pr_tot_tabs
integer	diagnostic_generation_frequency

Detailed Description

Specific theta advection, which involves the vertical advection of reference state and advection of mean baroclinicity.

Function/Subroutine Documentation

advection_of_mean_baroclinicity()

subroutine thadvection_mod::advection_of_mean_baroclinicity ( type(model_state_type), intent(inout), target  current_state, integer, intent(in)  local_y, integer, intent(in)  local_x  )

private

Performs advection of the mean baroclinicity if appropriate.

Parameters

current_state	The current model state
local_y	The local Y of the column
local_x	The local X of the column

Definition at line 201 of file thadvection.F90.

    type(model_state_type), target, intent(inout) :: current_state
    integer, intent(in) :: local_y, local_x
 
    integer :: k
 
    if (l_advect_mean_baroclinicity) then
       if (current_state%use_anelastic_equations) then
          do k=2, current_state%local_grid%size(z_index)
             current_state%sth%data(k, local_y, local_x)=current_state%sth%data(k, local_y, local_x)+&
                  current_state%global_grid%configuration%vertical%thref(k)*fcoriol_over_g*&
                  ((current_state%v%data(k, local_y, local_x) + current_state%vgal) * rate_change_geostrophic_wind_x-&
                  (current_state%u%data(k, local_y, local_x) + current_state%ugal) * rate_change_geostrophic_wind_y)
          end do
       else
          do k=2, current_state%local_grid%size(z_index)
             current_state%sth%data(k, local_y, local_x)=current_state%sth%data(k, local_y, local_x)+&
                  ((current_state%v%data(k, local_y, local_x) + current_state%vgal) * multiplicative_factor_x-&
                  (current_state%u%data(k, local_y, local_x) + current_state%ugal) * multiplicative_factor_y)                    
          end do
       end if
    end if
    

Here is the caller graph for this function:

compute_component_tendencies()

subroutine thadvection_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 254 of file thadvection.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_th) then
      tend_3d_th(:,tyn,txn)=current_state%sth%data(:,cyn,cxn)     - tend_3d_th(:,tyn,txn)
    endif
    if (l_tend_3d_tabs) then
      tend_3d_tabs(:,tyn,txn)=   &
       current_state%sth%data(:,cyn,cxn) * current_state%global_grid%configuration%vertical%rprefrcp(:)   &
        - tend_3d_tabs(:,tyn,txn)
    endif
 
   ! Add local tendency fields to the profile total
    if (l_tend_pr_tot_th) then
      tend_pr_tot_th(:)=tend_pr_tot_th(:) + tend_3d_th(:,tyn,txn)
    endif
    if (l_tend_pr_tot_tabs) then
      tend_pr_tot_tabs(:)=tend_pr_tot_tabs(:) + tend_3d_tabs(:,tyn,txn)
    endif
 

Here is the caller graph for this function:

field_information_retrieval_callback()

subroutine thadvection_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 component's 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
strcomp	Starting index within 1st argument string that matches substring (2nd argument); 0 if not a match.

Definition at line 284 of file thadvection.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, "thadvection_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_th_thadvection_3d_local") then
        field_information%enabled=l_tend_3d_th
      else if (name .eq. "tend_tabs_thadvection_3d_local") then
        field_information%enabled=l_tend_3d_tabs
      else
        field_information%enabled=.true.
      end if
 
    end if !end 3d check
 
    ! Field information for profiles
    strcomp=index(name, "thadvection_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_th_thadvection_profile_total_local") then
        field_information%enabled=l_tend_pr_tot_th
      else if (name .eq. "tend_tabs_thadvection_profile_total_local") then
        field_information%enabled=l_tend_pr_tot_tabs
      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 thadvection_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 335 of file thadvection.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_th_thadvection_3d_local" .and. allocated(tend_3d_th)) then
      call set_published_field_value(field_value, real_3d_field=tend_3d_th)
    else if (name .eq. "tend_tabs_thadvection_3d_local" .and. allocated(tend_3d_tabs)) then
      call set_published_field_value(field_value, real_3d_field=tend_3d_tabs)
 
    ! Profile Tendency Fields
    else if (name .eq. "tend_th_thadvection_profile_total_local" .and. allocated(tend_pr_tot_th)) then
      call set_published_field_value(field_value, real_1d_field=tend_pr_tot_th)
    else if (name .eq. "tend_tabs_thadvection_profile_total_local" .and. allocated(tend_pr_tot_tabs)) then
      call set_published_field_value(field_value, real_1d_field=tend_pr_tot_tabs)
    end if
 

Here is the call graph for this function:

Here is the caller graph for this function:

finalisation_callback()

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

private

Definition at line 119 of file thadvection.F90.

    type(model_state_type), target, intent(inout) :: current_state
 
    if (allocated(tend_3d_th)) deallocate(tend_3d_th)
    if (allocated(tend_3d_tabs)) deallocate(tend_3d_tabs)
 
    if (allocated(tend_pr_tot_th)) deallocate(tend_pr_tot_th)
    if (allocated(tend_pr_tot_tabs)) deallocate(tend_pr_tot_tabs)
 

Here is the caller graph for this function:

initialisation_callback()

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

private

Initialisation callback to set up the variables and data needed by the component.

Parameters

current_state

The current model state

Definition at line 60 of file thadvection.F90.

    type(model_state_type), target, intent(inout) :: current_state
 
    !AH (08/02/18) - by default l_advect_mean_baroclinicity is false. It
    !                is switch to true if passive_q true and baroclinicity_use_geostrophic_shear is true
    !                If passive q is false code will run but a warning is issued.
    !                Mean advection of baroclinicity only works for dry case
    baroclinicity_use_geostrophic_shear=options_get_logical(current_state%options_database, "baroclinicity_use_geostrophic_shear")
    if (baroclinicity_use_geostrophic_shear) then
       if (current_state%passive_q) then 
          l_advect_mean_baroclinicity = .true.
       else
          call log_master_log(log_warn, "The combination if baroclinicity and active q is not allowed, code will run but"// & 
               " no advection of mean baroclinicity")
          l_advect_mean_baroclinicity = .false.
       endif
    endif
    fcoriol=options_get_real(current_state%options_database, "fcoriol")
    rate_change_geostrophic_wind_x=options_get_real(current_state%options_database, "rate_change_geostrophic_wind_x")
    rate_change_geostrophic_wind_y=options_get_real(current_state%options_database, "rate_change_geostrophic_wind_y")
    fcoriol_over_g = fcoriol/g
    multiplicative_factor_x=rate_change_geostrophic_wind_x*current_state%thref0*fcoriol_over_g
    multiplicative_factor_y=rate_change_geostrophic_wind_y*current_state%thref0*fcoriol_over_g
 
    ! Set tendency diagnostic logicals based on availability
    ! Need to use 3d tendencies to compute the profiles, so they will be allocated
    !      in the case where profiles are available
    l_tend_pr_tot_th  = current_state%th%active 
    l_tend_pr_tot_tabs  = l_tend_pr_tot_th
 
    l_tend_3d_th  = current_state%th%active .or. l_tend_pr_tot_th
    l_tend_3d_tabs = l_tend_3d_th
 
    ! Allocate 3d tendency fields upon availability
    if (l_tend_3d_th) then
      allocate( tend_3d_th(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_tabs) then
      allocate( tend_3d_tabs(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_th) then
      allocate( tend_pr_tot_th(current_state%local_grid%size(z_index)) )
    endif
    if (l_tend_pr_tot_tabs) then
      allocate( tend_pr_tot_tabs(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 thadvection_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 233 of file thadvection.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_th) then
      tend_3d_th(:,tyn,txn)=current_state%sth%data(:,cyn,cxn)
    endif
    if (l_tend_3d_tabs) then
      tend_3d_tabs(:,tyn,txn)=current_state%sth%data(:,cyn,cxn) * current_state%global_grid%configuration%vertical%rprefrcp(:)
    endif
 

Here is the caller graph for this function:

set_published_field_value()

subroutine thadvection_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 360 of file thadvection.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:

thadvection_get_descriptor()

type(component_descriptor_type) function, public thadvection_mod::thadvection_get_descriptor

Provides a description of this component for the core to register.

Returns

The descriptor containing registration information for this component

Definition at line 39 of file thadvection.F90.

    thadvection_get_descriptor%name="th_advection"
    thadvection_get_descriptor%version=0.1
    thadvection_get_descriptor%initialisation=>initialisation_callback
    thadvection_get_descriptor%timestep=>timestep_callback
    thadvection_get_descriptor%finalisation=>finalisation_callback
 
    thadvection_get_descriptor%field_value_retrieval=>field_value_retrieval_callback
    thadvection_get_descriptor%field_information_retrieval=>field_information_retrieval_callback
    allocate(thadvection_get_descriptor%published_fields(2+2))
 
    thadvection_get_descriptor%published_fields(1)= "tend_th_thadvection_3d_local"
    thadvection_get_descriptor%published_fields(2)= "tend_tabs_thadvection_3d_local"
 
    thadvection_get_descriptor%published_fields(2+1)= "tend_th_thadvection_profile_total_local"
    thadvection_get_descriptor%published_fields(2+2)= "tend_tabs_thadvection_profile_total_local"
 

Here is the call graph for this function:

timestep_callback()

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

private

Timestep callback, will call the two separate procedures to do their advection if needed.

Parameters

current_state	The current model state
target_(x/y)_index	This is the index with the halos subtracted. This is needed so that diagnostic does not include halos and to prevent array out-of-bounds

Definition at line 135 of file thadvection.F90.

    type(model_state_type), target, intent(inout) :: current_state
 
    integer :: current_x_index, current_y_index, target_x_index, target_y_index
 
    current_x_index=current_state%column_local_x
    current_y_index=current_state%column_local_y
    target_y_index=current_y_index-current_state%local_grid%halo_size(y_index)
    target_x_index=current_x_index-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_th) then
        tend_pr_tot_th(:)=0.0_default_precision
      endif
      if (l_tend_pr_tot_tabs) then
        tend_pr_tot_tabs(:)=0.0_default_precision
      endif
    endif  ! zero totals
 
    if (mod(current_state%timestep, diagnostic_generation_frequency) == 0 .and. .not. current_state%halo_column) then
      call save_precomponent_tendencies(current_state, current_x_index, current_y_index, target_x_index, target_y_index)
    end if
 
    call vertical_advection_of_reference_state(current_state, current_state%column_local_y, current_state%column_local_x)
    call advection_of_mean_baroclinicity(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 compute_component_tendencies(current_state, current_x_index, current_y_index, target_x_index, target_y_index)
    end if
 

Here is the call graph for this function:

Here is the caller graph for this function:

vertical_advection_of_reference_state()

subroutine thadvection_mod::vertical_advection_of_reference_state ( type(model_state_type), intent(inout), target  current_state, integer, intent(in)  local_y, integer, intent(in)  local_x  )

private

Vertical advection of the reference state. It doesn't seem consistent to do the advection in this way if TVD advection of the deviation from the reference state has been selected. Separate vertical advection of the reference state was introduced to improve energy conservation when carrying out idealized gravity wave simulations in a deep, dry isothermal layer, for which the difference in potential temp between top and bottom was of order 100K. In less extreme cases the benefits are unlikely to be significant and with TVD advection energy conservation has been compromised so the best way forward might be to recombine the reference state into l_th.

Parameters

current_state	The current model state
local_y	The local Y of the column
local_x	The local X of the column

Definition at line 177 of file thadvection.F90.

    type(model_state_type), target, intent(inout) :: current_state
    integer, intent(in) :: local_y, local_x
 
    integer :: k
    real(kind=default_precision) :: sctmp1, sctmp2
 
    if (current_state%use_anelastic_equations) then
      ! This code only needs to be executed if anelastic, otherwise THREF is constant and the increment calculated here is zero
      do k=2, current_state%local_grid%size(z_index)
        sctmp1=current_state%global_grid%configuration%vertical%tzc1(k)*2.0_default_precision*&
             current_state%global_grid%configuration%vertical%dthref(k-1)
        sctmp2=current_state%global_grid%configuration%vertical%tzc2(k)*2.0_default_precision*&
             current_state%global_grid%configuration%vertical%dthref(k)
        current_state%sth%data(k, local_y, local_x)=current_state%sth%data(k, local_y, local_x)-(sctmp1*&
             current_state%w%data(k-1, local_y, local_x) + sctmp2*current_state%w%data(k, local_y, local_x))
      end do
    end if

Here is the caller graph for this function:

Variable Documentation

baroclinicity_use_geostrophic_shear

logical thadvection_mod::baroclinicity_use_geostrophic_shear

private

Definition at line 18 of file thadvection.F90.

  logical :: baroclinicity_use_geostrophic_shear

diagnostic_generation_frequency

integer thadvection_mod::diagnostic_generation_frequency

private

Definition at line 31 of file thadvection.F90.

  integer :: diagnostic_generation_frequency

fcoriol

real(kind=default_precision) thadvection_mod::fcoriol

private

Definition at line 20 of file thadvection.F90.

  real(kind=default_precision) :: fcoriol, fcoriol_over_g, rate_change_geostrophic_wind_x, rate_change_geostrophic_wind_y, &
       multiplicative_factor_x, multiplicative_factor_y

fcoriol_over_g

real(kind=default_precision) thadvection_mod::fcoriol_over_g

private

Definition at line 20 of file thadvection.F90.

l_advect_mean_baroclinicity

logical thadvection_mod::l_advect_mean_baroclinicity

private

Definition at line 19 of file thadvection.F90.

  logical :: l_advect_mean_baroclinicity

l_tend_3d_tabs

logical thadvection_mod::l_tend_3d_tabs

private

Definition at line 26 of file thadvection.F90.

l_tend_3d_th

logical thadvection_mod::l_tend_3d_th

private

Definition at line 26 of file thadvection.F90.

  logical :: l_tend_3d_th, l_tend_3d_tabs

l_tend_pr_tot_tabs

logical thadvection_mod::l_tend_pr_tot_tabs

private

Definition at line 29 of file thadvection.F90.

l_tend_pr_tot_th

logical thadvection_mod::l_tend_pr_tot_th

private

Definition at line 29 of file thadvection.F90.

  logical :: l_tend_pr_tot_th, l_tend_pr_tot_tabs

multiplicative_factor_x

real(kind=default_precision) thadvection_mod::multiplicative_factor_x

private

Definition at line 20 of file thadvection.F90.

multiplicative_factor_y

real(kind=default_precision) thadvection_mod::multiplicative_factor_y

private

Definition at line 20 of file thadvection.F90.

rate_change_geostrophic_wind_x

real(kind=default_precision) thadvection_mod::rate_change_geostrophic_wind_x

private

Definition at line 20 of file thadvection.F90.

rate_change_geostrophic_wind_y

real(kind=default_precision) thadvection_mod::rate_change_geostrophic_wind_y

private

Definition at line 20 of file thadvection.F90.

tend_3d_tabs

real(kind=default_precision), dimension(:,:,:), allocatable thadvection_mod::tend_3d_tabs

private

Definition at line 25 of file thadvection.F90.

tend_3d_th

real(kind=default_precision), dimension(:,:,:), allocatable thadvection_mod::tend_3d_th

private

Definition at line 25 of file thadvection.F90.

  real(kind=default_precision), dimension(:,:,:), allocatable :: tend_3d_th, tend_3d_tabs

tend_pr_tot_tabs

real(kind=default_precision), dimension(:), allocatable thadvection_mod::tend_pr_tot_tabs

private

Definition at line 28 of file thadvection.F90.

tend_pr_tot_th

real(kind=default_precision), dimension(:), allocatable thadvection_mod::tend_pr_tot_th

private

Definition at line 28 of file thadvection.F90.

  real(kind=default_precision), dimension(:), allocatable ::     tend_pr_tot_th, tend_pr_tot_tabs