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...

Variables
real(kind=default_precision), dimension(:), allocatable	w_buoyancy
real(kind=default_precision)	g_over_2
integer	iqv

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 29 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))
    buoyancy_get_descriptor%published_fields(1)="w_buoyancy"

Here is the call 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 46 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

    ! 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.

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 63 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)   
    end if

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

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

    if (allocated(w_buoyancy)) deallocate(w_buoyancy)

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 75 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))

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

Definition at line 102 of file buoyancy.F90.

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

    integer :: k, n
    
#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

Here is the caller graph for this function:

Variable Documentation

g_over_2

real(kind=default_precision) buoyancy_mod::g_over_2

private

Definition at line 19 of file buoyancy.F90.

  real(kind=DEFAULT_PRECISION) :: g_over_2

iqv

integer buoyancy_mod::iqv

private

Definition at line 21 of file buoyancy.F90.

  integer :: iqv ! Index for water vapour

w_buoyancy

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

private

Definition at line 17 of file buoyancy.F90.

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