Derive 3-D diagnostic fields which are available in current_state. More...

Functions/Subroutines
type(component_descriptor_type) function, public	diagnostics_3d_get_descriptor ()
	Provides the component descriptor for the core to register. More...

subroutine	initialisation_callback (current_state)

subroutine	timestep_callback (current_state)

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

Variables
integer	total_points

integer	iqv

integer	iql

integer	iqr

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

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

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

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

real(kind=default_precision)	qlcrit

Detailed Description

Derive 3-D diagnostic fields which are available in current_state.

Function/Subroutine Documentation

◆ diagnostics_3d_get_descriptor()

type(component_descriptor_type) function, public diagnostics_3d_mod::diagnostics_3d_get_descriptor

Provides the component descriptor for the core to register.

Returns: The descriptor describing this component

Definition at line 39 of file diagnostics_3d.F90.

     diagnostics_3d_get_descriptor%name="diagnostics_3d"
     diagnostics_3d_get_descriptor%version=0.1
     diagnostics_3d_get_descriptor%initialisation=>initialisation_callback
     diagnostics_3d_get_descriptor%timestep=>timestep_callback
  
     diagnostics_3d_get_descriptor%field_value_retrieval=>field_value_retrieval_callback
     diagnostics_3d_get_descriptor%field_information_retrieval=>field_information_retrieval_callback
     allocate(diagnostics_3d_get_descriptor%published_fields(3))
  
     diagnostics_3d_get_descriptor%published_fields(1)="temperature"
     diagnostics_3d_get_descriptor%published_fields(2)="theta"
     diagnostics_3d_get_descriptor%published_fields(3)="thetali"
     

Here is the call graph for this function:

◆ field_information_retrieval_callback()

subroutine diagnostics_3d_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 124 of file diagnostics_3d.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_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. "temperature" .or. name .eq. "theta" &
          .or. name .eq. "thetali") then
        field_information%enabled=current_state%th%active
     else
        field_information%enabled=.true.
     endif

Here is the caller graph for this function:

◆ field_value_retrieval_callback()

subroutine diagnostics_3d_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 147 of file diagnostics_3d.F90.

     type(model_state_type), target, intent(inout) :: current_state
     character(len=*), intent(in) :: name
     type(component_field_value_type), intent(out) :: field_value
     
     integer :: k
  
     if (name .eq. "temperature") then
        allocate(field_value%real_3d_array(current_state%local_grid%size(z_index),  &
             current_state%local_grid%size(y_index),                                &
             current_state%local_grid%size(x_index)))
        field_value%real_3d_array(:,:,:) = tdegk(:,:,:)
     elseif (name .eq. "theta") then
        allocate(field_value%real_3d_array(current_state%local_grid%size(z_index),  &
             current_state%local_grid%size(y_index),                                &
             current_state%local_grid%size(x_index)))
        field_value%real_3d_array(:,:,:) = theta(:,:,:)
     elseif (name .eq. "thetali") then
        allocate(field_value%real_3d_array(current_state%local_grid%size(z_index),  &
             current_state%local_grid%size(y_index),                                &
             current_state%local_grid%size(x_index)))
        field_value%real_3d_array(:,:,:) = liquid_ice_theta(:,:,:)
     end if
     

Here is the caller graph for this function:

◆ initialisation_callback()

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

private

Definition at line 55 of file diagnostics_3d.F90.

     type(model_state_type), target, intent(inout) :: current_state
  
     if (current_state%th%active) then
        allocate(tdegk(current_state%local_grid%size(z_index),  &
             current_state%local_grid%size(y_index),            &
             current_state%local_grid%size(x_index)))
        allocate(theta(current_state%local_grid%size(z_index),  &
             current_state%local_grid%size(y_index),            &
             current_state%local_grid%size(x_index)))
        allocate(liquid_ice_theta(current_state%local_grid%size(z_index),  &
             current_state%local_grid%size(y_index),            &
             current_state%local_grid%size(x_index)))
     endif
  
     if (.not. current_state%passive_q .and. current_state%number_q_fields .gt. 0) then
        allocate(total_condensate(current_state%local_grid%size(z_index)))
        iqv=get_q_index(standard_q_names%VAPOUR, 'diagnostics_3d') 
        iql=get_q_index(standard_q_names%CLOUD_LIQUID_MASS, 'diagnostics_3d')
        if (current_state%rain_water_mixing_ratio_index > 0) & 
             iqr = current_state%rain_water_mixing_ratio_index
     endif
     

Here is the caller graph for this function:

◆ timestep_callback()

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

private

Definition at line 80 of file diagnostics_3d.F90.

     type(model_state_type), target, intent(inout) :: current_state
  
     real(kind=default_precision) :: exner, pmb, qv, qs
  
     integer :: k
     integer :: current_y_index, current_x_index, target_x_index, target_y_index
  
     if (current_state%halo_column) return
        
     current_y_index=current_state%column_local_y
     current_x_index=current_state%column_local_x
     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)
  
     if (current_state%th%active) then
        theta(:,target_y_index, target_x_index) =                            &
             (current_state%th%data(:,current_y_index,current_x_index)       &
             + current_state%global_grid%configuration%vertical%thref(:))
        liquid_ice_theta(:,target_y_index, target_x_index) =                 &
             (current_state%th%data(:,current_y_index,current_x_index)       &
             + current_state%global_grid%configuration%vertical%thref(:))  
             ! test for the qfields
        if (.not. current_state%passive_q .and. &
             current_state%number_q_fields .gt. 0) then
           total_condensate(:) =                                             &
                current_state%q(iql)%data(:,current_y_index,current_x_index) + &
                current_state%q(iqr)%data(:,current_y_index,current_x_index)
           liquid_ice_theta(:,target_y_index, target_x_index) =              &
                liquid_ice_theta(:,target_y_index, target_x_index) -         &
                ( total_condensate(:) * (rlvap_over_cp) )
        endif
        tdegk(:,target_y_index, target_x_index) =                            &
             (current_state%th%data(:,current_y_index,current_x_index)       &
             + current_state%global_grid%configuration%vertical%thref(:)     &
             * current_state%global_grid%configuration%vertical%rprefrcp(:))       
     endif
     

Here is the caller graph for this function:

Variable Documentation

◆ iql

integer diagnostics_3d_mod::iql

private

Definition at line 24 of file diagnostics_3d.F90.

◆ iqr

integer diagnostics_3d_mod::iqr

private

Definition at line 24 of file diagnostics_3d.F90.

◆ iqv

integer diagnostics_3d_mod::iqv

private

Definition at line 24 of file diagnostics_3d.F90.

◆ liquid_ice_theta

real(kind=default_precision), dimension(:,:,:), allocatable diagnostics_3d_mod::liquid_ice_theta

private

Definition at line 25 of file diagnostics_3d.F90.

◆ qlcrit

real(kind=default_precision) diagnostics_3d_mod::qlcrit

private

Definition at line 31 of file diagnostics_3d.F90.

31 real(kind=default_precision) :: qlcrit

◆ tdegk

real(kind=default_precision), dimension(:,:,:), allocatable diagnostics_3d_mod::tdegk

private

Definition at line 25 of file diagnostics_3d.F90.

   real(kind=default_precision), dimension(:,:,:), allocatable ::     &
        tdegk,               & ! absolute temperature in kelvin
        theta,               & ! potential temperature in kelvin (th + thref)
        liquid_ice_theta       ! liquid-ice potential temperature in kelvin

◆ theta

real(kind=default_precision), dimension(:,:,:), allocatable diagnostics_3d_mod::theta

private

Definition at line 25 of file diagnostics_3d.F90.

◆ total_condensate

real(kind=default_precision), dimension(:), allocatable diagnostics_3d_mod::total_condensate

private

Definition at line 29 of file diagnostics_3d.F90.

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

30 total_condensate

◆ total_points

integer diagnostics_3d_mod::total_points

private

Definition at line 24 of file diagnostics_3d.F90.

24 integer :: total_points, iqv, iql, iqr

Functions/Subroutines

Variables

Detailed Description

Function/Subroutine Documentation

◆ diagnostics_3d_get_descriptor()

◆ field_information_retrieval_callback()

◆ field_value_retrieval_callback()

◆ initialisation_callback()

◆ timestep_callback()

Variable Documentation

◆ iql

◆ iqr

◆ iqv

◆ liquid_ice_theta

◆ qlcrit

◆ tdegk

◆ theta

◆ total_condensate

◆ total_points