buoyancy_mod Module Reference

Calculates buoyancy terms for the SW field. More...

Functions/Subroutines
type(component_descriptor_type) function, public	buoyancy_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)
	The initialisation callback sets up the buoyancy coefficient. More...
subroutine	finalisation_callback (current_state)
subroutine	timestep_callback (current_state)
	Called for each column per timestep this will calculate the buoyancy terms for the SW field. 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
real(kind=default_precision), dimension(:), allocatable	w_buoyancy
real(kind=default_precision)	g_over_2
integer	iqv
real(kind=default_precision), dimension(:,:,:), allocatable	tend_3d_w
logical	l_tend_3d_w
real(kind=default_precision), dimension(:), allocatable	tend_pr_tot_w
logical	l_tend_pr_tot_w
integer	diagnostic_generation_frequency

Detailed Description

Calculates buoyancy terms for the SW field.

Function/Subroutine Documentation

buoyancy_get_descriptor()

type(component_descriptor_type) function, public buoyancy_mod::buoyancy_get_descriptor

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

Returns

The termination check component descriptor

Definition at line 40 of file buoyancy.F90.

    buoyancy_get_descriptor%name="buoyancy"
    buoyancy_get_descriptor%version=0.1
    buoyancy_get_descriptor%initialisation=>initialisation_callback
    buoyancy_get_descriptor%timestep=>timestep_callback
    buoyancy_get_descriptor%finalisation=>finalisation_callback
 
    buoyancy_get_descriptor%field_value_retrieval=>field_value_retrieval_callback
    buoyancy_get_descriptor%field_information_retrieval=>field_information_retrieval_callback
    allocate(buoyancy_get_descriptor%published_fields(1+1+1))
 
    buoyancy_get_descriptor%published_fields(1)="w_buoyancy"
 
    buoyancy_get_descriptor%published_fields(1+1)= "tend_w_buoyancy_3d_local"
 
    buoyancy_get_descriptor%published_fields(1+1+1)= "tend_w_buoyancy_profile_total_local"
 

Here is the call graph for this function:

compute_component_tendencies()

subroutine buoyancy_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 286 of file buoyancy.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_w) then
      tend_3d_w(:,tyn,txn)=current_state%sw%data(:,cyn,cxn) - tend_3d_w(:,tyn,txn)
    endif
 
   ! Add local tendency fields to the profile total
    if (l_tend_pr_tot_w) then
      tend_pr_tot_w(:)=tend_pr_tot_w(:) + tend_3d_w(:,tyn,txn)
    endif
 

Here is the caller graph for this function:

field_information_retrieval_callback()

subroutine buoyancy_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 63 of file buoyancy.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 description is the same regardless of the specific field being retrieved
    field_information%field_type=component_array_field_type
    field_information%data_type=component_double_data_type
    field_information%number_dimensions=1
    field_information%dimension_sizes(1)=current_state%local_grid%size(z_index)
    field_information%enabled=.true.
 
    ! Field information for 3d
    strcomp=index(name, "buoyancy_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_w_buoyancy_3d_local") then
        field_information%enabled=l_tend_3d_w
      else
        field_information%enabled=.true.
      end if
 
    end if !end 3d check
 
    ! Field information for profiles
    strcomp=index(name, "buoyancy_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_w_buoyancy_profile_total_local") then
        field_information%enabled=l_tend_pr_tot_w
      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 buoyancy_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 117 of file buoyancy.F90.

    type(model_state_type), target, intent(inout) :: current_state
    character(len=*), intent(in) :: name
    type(component_field_value_type), intent(out) :: field_value
    
    if (name .eq. "w_buoyancy") then
      allocate(field_value%real_1d_array(size(w_buoyancy)), source=w_buoyancy)   
 
    ! 3d Tendency Fields
    else if (name .eq. "tend_w_buoyancy_3d_local" .and. allocated(tend_3d_w)) then
      call set_published_field_value(field_value, real_3d_field=tend_3d_w)
 
    ! Profile Tendency Fields
    else if (name .eq. "tend_w_buoyancy_profile_total_local" .and. allocated(tend_pr_tot_w)) then
      call set_published_field_value(field_value, real_1d_field=tend_pr_tot_w)
    end if
 

Here is the call graph for this function:

Here is the caller graph for this function:

finalisation_callback()

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

private

Definition at line 179 of file buoyancy.F90.

    type(model_state_type), target, intent(inout) :: current_state
 
    if (allocated(w_buoyancy)) deallocate(w_buoyancy)
 
    if (allocated(tend_3d_w)) deallocate(tend_3d_w)
 
    if (allocated(tend_pr_tot_w)) deallocate(tend_pr_tot_w)
 

Here is the caller graph for this function:

initialisation_callback()

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

private

The initialisation callback sets up the buoyancy coefficient.

Parameters

current_state

The current model state

Definition at line 139 of file buoyancy.F90.

    type(model_state_type), target, intent(inout) :: current_state
 
    integer :: z_size
 
    if (.not. current_state%passive_q .and. current_state%number_q_fields > 0)then
      if (.not. allocated(current_state%cq))then
        allocate(current_state%cq(current_state%number_q_fields))
        current_state%cq=0.0_default_precision
      end if
      iqv = get_q_index(standard_q_names%VAPOUR, 'buoyancy')
      current_state%cq(iqv) = ratio_mol_wts-1.0
    end if
 
    g_over_2 = 0.5_default_precision*g
    z_size=current_state%global_grid%size(z_index)
    allocate(w_buoyancy(z_size))
 
    ! Tendency logicals
    l_tend_pr_tot_w   = current_state%w%active
    l_tend_3d_w   = current_state%w%active .or. l_tend_pr_tot_w
 
    ! Allocate 3d tendency fields upon availability
    if (l_tend_3d_w) then
      allocate( tend_3d_w(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_w) then
      allocate( tend_pr_tot_w(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 buoyancy_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 268 of file buoyancy.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_w) then
      tend_3d_w(:,tyn,txn)=current_state%sw%data(:,cyn,cxn)
    endif
 

Here is the caller graph for this function:

set_published_field_value()

subroutine buoyancy_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 307 of file buoyancy.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 buoyancy_mod::timestep_callback ( type(model_state_type), intent(inout), target  current_state )

private

Called for each column per timestep this will calculate the buoyancy terms for the SW field.

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 195 of file buoyancy.F90.

    type(model_state_type), target, intent(inout) :: current_state
 
    integer :: k, n
    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_w) then
        tend_pr_tot_w(:)=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
 
    
#ifdef W_ACTIVE
    if (.not. current_state%passive_th .and. current_state%th%active) then
      do k=2,current_state%local_grid%size(z_index)-1    
        w_buoyancy(k)=(0.5_default_precision*current_state%global_grid%configuration%vertical%buoy_co(k))*&
             (current_state%th%data(k, current_state%column_local_y, current_state%column_local_x)&
             +current_state%th%data(k+1, current_state%column_local_y, current_state%column_local_x))
        current_state%sw%data(k, current_state%column_local_y, current_state%column_local_x)=&
             current_state%sw%data(k, current_state%column_local_y, current_state%column_local_x)+w_buoyancy(k)             
      end do
    end if
    if (.not. current_state%passive_q .and. current_state%number_q_fields .gt. 0) then
      if (current_state%use_anelastic_equations) then                                                      
        do n=1,current_state%number_q_fields
          do k=2,current_state%local_grid%size(z_index)-1            
            current_state%sw%data(k, current_state%column_local_y, current_state%column_local_x)=&
                 current_state%sw%data(k, current_state%column_local_y, current_state%column_local_x)+&
                 (0.5_default_precision*current_state%global_grid%configuration%vertical%buoy_co(k))*&
                 current_state%cq(n)* (current_state%global_grid%configuration%vertical%thref(k)*&
                 current_state%q(n)%data(k, current_state%column_local_y, current_state%column_local_x)+&
                 current_state%global_grid%configuration%vertical%thref(k+1)*&
                 current_state%q(n)%data(k+1, current_state%column_local_y, current_state%column_local_x))
          end do
        end do
      else                                                                     
        do n=1,current_state%number_q_fields
          do k=2,current_state%local_grid%size(z_index)-1
             current_state%sw%data(k, current_state%column_local_y, current_state%column_local_x)=&
                  current_state%sw%data(k, current_state%column_local_y, current_state%column_local_x)+&
                  g_over_2*current_state%cq(n)*&
                  (current_state%q(n)%data(k, current_state%column_local_y, current_state%column_local_x)+&
                  current_state%q(n)%data(k+1, current_state%column_local_y, current_state%column_local_x))
          end do
        end do
      end if
    end if
#endif
 
    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:

Variable Documentation

diagnostic_generation_frequency

integer buoyancy_mod::diagnostic_generation_frequency

private

Definition at line 32 of file buoyancy.F90.

  integer :: diagnostic_generation_frequency

g_over_2

real(kind=default_precision) buoyancy_mod::g_over_2

private

Definition at line 20 of file buoyancy.F90.

  real(kind=default_precision) :: g_over_2

iqv

integer buoyancy_mod::iqv

private

Definition at line 22 of file buoyancy.F90.

  integer :: iqv ! Index for water vapour

l_tend_3d_w

logical buoyancy_mod::l_tend_3d_w

private

Definition at line 27 of file buoyancy.F90.

  logical :: l_tend_3d_w

l_tend_pr_tot_w

logical buoyancy_mod::l_tend_pr_tot_w

private

Definition at line 30 of file buoyancy.F90.

  logical :: l_tend_pr_tot_w

tend_3d_w

real(kind=default_precision), dimension(:,:,:), allocatable buoyancy_mod::tend_3d_w

private

Definition at line 26 of file buoyancy.F90.

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

tend_pr_tot_w

real(kind=default_precision), dimension(:), allocatable buoyancy_mod::tend_pr_tot_w

private

Definition at line 29 of file buoyancy.F90.

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

w_buoyancy

real(kind=default_precision), dimension(:), allocatable buoyancy_mod::w_buoyancy

private

Definition at line 18 of file buoyancy.F90.

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