Functions/Subroutines
type(component_descriptor_type) function, public	diagnostics_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	hqlmax

integer	ncl_col

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

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

real(kind=default_precision)	totqv

real(kind=default_precision)	totql

real(kind=default_precision)	totqz

real(kind=default_precision)	wmax

real(kind=default_precision)	wmin

real(kind=default_precision)	qlmax

real(kind=default_precision)	qlcrit

real(kind=default_precision)	cltop_av

real(kind=default_precision)	clbas_av

real(kind=default_precision)	cltop

real(kind=default_precision)	clbas

Function/Subroutine Documentation

◆ diagnostics_get_descriptor()

type(component_descriptor_type) function, public diagnostics_mod::diagnostics_get_descriptor ( )

Provides the component descriptor for the core to register.

Returns: The descriptor describing this component

Definition at line 27 of file diagnostics.F90.

     diagnostics_get_descriptor%name="diagnostics"
     diagnostics_get_descriptor%version=0.1
 
     diagnostics_get_descriptor%initialisation=>initialisation_callback
     diagnostics_get_descriptor%timestep=>timestep_callback
 
     diagnostics_get_descriptor%field_value_retrieval=>field_value_retrieval_callback
     diagnostics_get_descriptor%field_information_retrieval=>field_information_retrieval_callback
     allocate(diagnostics_get_descriptor%published_fields(15))
 
     diagnostics_get_descriptor%published_fields(1)="totpnts"
     diagnostics_get_descriptor%published_fields(2)="zn_top"
     diagnostics_get_descriptor%published_fields(3)="wmax_local"
     diagnostics_get_descriptor%published_fields(4)="wmin_local"
     diagnostics_get_descriptor%published_fields(5)="totqv_local"
     diagnostics_get_descriptor%published_fields(6)="totql_local"
     diagnostics_get_descriptor%published_fields(7)="totqz_local"
     diagnostics_get_descriptor%published_fields(8)="qlmax_local"
     diagnostics_get_descriptor%published_fields(9)="hqlmax_local"
     diagnostics_get_descriptor%published_fields(10)="cltop_local"
     diagnostics_get_descriptor%published_fields(11)="clbas_local"
     diagnostics_get_descriptor%published_fields(12)="cltop_av_local"
     diagnostics_get_descriptor%published_fields(13)="clbas_av_local"
     diagnostics_get_descriptor%published_fields(14)="ncl_col_local"
     diagnostics_get_descriptor%published_fields(15)="thdiag_local"

Here is the call graph for this function:

◆ field_information_retrieval_callback()

subroutine diagnostics_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 145 of file diagnostics.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_scalar_field_type
     field_information%data_type=component_double_data_type
     field_information%enabled=.true.
     if (name .eq. "thdiag_local") 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)
     endif
 
     if (name .eq. "totpnts" .or. name .eq. "hqlmax_local" .or. name .eq. "ncl_col_local") then
       field_information%data_type=component_integer_data_type
     else
       field_information%data_type=component_double_data_type
     end if   

Here is the caller graph for this function:

◆ field_value_retrieval_callback()

subroutine diagnostics_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 170 of file diagnostics.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 :: i
 
     if (name .eq. "totpnts") then
       field_value%scalar_int=total_points
     else if (name .eq. "zn_top") then
       field_value%scalar_real=current_state%global_grid%configuration%vertical%zn(current_state%global_grid%size(z_index))
     else if (name .eq. "wmax_local") then
       field_value%scalar_real=wmax
     else if (name .eq. "wmin_local") then
       field_value%scalar_real=wmin
     else if (name .eq. "totqv_local") then
       field_value%scalar_real=totqv
     else if (name .eq. "totql_local") then
       field_value%scalar_real=totql
     else if (name .eq. "totqz_local") then
       field_value%scalar_real=totqz
     else if (name .eq. "qlmax_local") then
       field_value%scalar_real=qlmax
     else if (name .eq. "hqlmax_local") then
       field_value%scalar_int=hqlmax
     else if (name .eq. "cltop_local") then
       field_value%scalar_real=cltop
     else if (name .eq. "clbas_local") then
       field_value%scalar_real=clbas
     else if (name .eq. "cltop_av_local") then
       field_value%scalar_real=cltop_av
     else if (name .eq. "clbas_av_local") then
       field_value%scalar_real=clbas_av
     else if (name .eq. "ncl_col_local") then
       field_value%scalar_int=ncl_col
     else if (name .eq. "thdiag_local") then
        allocate(field_value%real_1d_array(current_state%local_grid%size(z_index)))            
        do i=1, current_state%local_grid%size(z_index)
           field_value%real_1d_array(i)=maxval(current_state%th%data(i,:,:) + current_state%thref0)
        enddo
     end if

Here is the caller graph for this function:

◆ initialisation_callback()

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

private

Definition at line 55 of file diagnostics.F90.

     type(model_state_type), target, intent(inout) :: current_state
 
     integer :: k
 
     qlcrit=options_get_real(current_state%options_database, "qlcrit")
 
     total_points=current_state%global_grid%size(z_index) * current_state%global_grid%size(y_index) * &
            current_state%global_grid%size(x_index)
 
     allocate(tempfac(current_state%local_grid%size(z_index)), theta_tot(current_state%local_grid%size(z_index)))
     do k=2, current_state%local_grid%size(z_index)
       tempfac(k)=current_state%global_grid%configuration%vertical%dz(k)*&
            current_state%global_grid%configuration%vertical%rhon(k)/total_points
     end do    

Here is the caller graph for this function:

◆ timestep_callback()

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

private

Definition at line 72 of file diagnostics.F90.

     type(model_state_type), target, intent(inout) :: current_state
 
     integer :: k, i
     real(kind=DEFAULT_PRECISION) :: cltop_col, clbas_col
 
     if (current_state%first_timestep_column) then
       totqv=0.0_default_precision
       totql=0.0_default_precision
       totqz=0.0_default_precision
       wmax=0.0_default_precision
       wmin=0.0_default_precision
       qlmax=0.0_default_precision
       cltop_av=0.0_default_precision
       clbas_av=0.0_default_precision
       cltop=0.0_default_precision
       clbas=0.0_default_precision
       ncl_col=0
     end if
     if (.not. current_state%halo_column) then
       cltop_col=0.0_default_precision
       clbas_col=0.0_default_precision
       do k=2, current_state%local_grid%size(z_index)
         wmax=max(wmax, current_state%w%data(k, current_state%column_local_y, current_state%column_local_x))
         wmin=min(wmin, current_state%w%data(k, current_state%column_local_y, current_state%column_local_x))
 
         if (current_state%number_q_fields .gt. 0) then 
           if (current_state%liquid_water_mixing_ratio_index .gt. 0 .and. &
                current_state%number_q_fields .ge. current_state%liquid_water_mixing_ratio_index) then
             if (qlmax .lt. current_state%q(current_state%liquid_water_mixing_ratio_index)%data(k, &
                  current_state%column_local_y, current_state%column_local_x)) then
               qlmax=max(qlmax, current_state%q(current_state%liquid_water_mixing_ratio_index)%data(k, &
                    current_state%column_local_y, current_state%column_local_x))
               hqlmax=k
             end if
 
             if (current_state%q(current_state%liquid_water_mixing_ratio_index)%data(k, &
                  current_state%column_local_y, current_state%column_local_x) .gt. qlcrit) then
               cltop_col=current_state%global_grid%configuration%vertical%zn(k)
               cltop=max(cltop, current_state%global_grid%configuration%vertical%zn(k))
               clbas=min(clbas, current_state%global_grid%configuration%vertical%zn(k))
             end if
 
             if (current_state%q(current_state%liquid_water_mixing_ratio_index)%data(current_state%local_grid%size(z_index)+1-k, &
                  current_state%column_local_y, current_state%column_local_x) .gt. qlcrit) then
               clbas_col=current_state%global_grid%configuration%vertical%zn(current_state%local_grid%size(z_index)+1-k)
             end if
 
             !tql_loc(J,I)=tql_loc(J,I)+DZ(K)*RHON(K)*Q(J,K,IQL,current_state%liquid_water_mixing_ratio_index)
             totqz=totqz+tempfac(k)*current_state%q(current_state%liquid_water_mixing_ratio_index)%data(k, &
                  current_state%column_local_y, current_state%column_local_x)*current_state%global_grid%configuration%vertical%zn(k)
           end if
 
           if (current_state%water_vapour_mixing_ratio_index .gt. 0 .and. &
                current_state%number_q_fields .ge. current_state%water_vapour_mixing_ratio_index) then
             totqv=totqv+tempfac(k)*current_state%q(current_state%water_vapour_mixing_ratio_index)%data(k, &
                  current_state%column_local_y, current_state%column_local_x)
             totql=totql+tempfac(k)*current_state%q(current_state%liquid_water_mixing_ratio_index)%data(k, &
                  current_state%column_local_y, current_state%column_local_x)
           end if          
         end if
       end do
       if (cltop_col .gt. 0.0_default_precision) ncl_col=ncl_col+1
       cltop_av=cltop_av+cltop_col
       clbas_av=clbas_av+clbas_col
 
    end if

Here is the caller graph for this function:

Variable Documentation

◆ clbas

real(kind=default_precision) diagnostics_mod::clbas

private

Definition at line 18 of file diagnostics.F90.

◆ clbas_av

real(kind=default_precision) diagnostics_mod::clbas_av

private

Definition at line 18 of file diagnostics.F90.

◆ cltop

real(kind=default_precision) diagnostics_mod::cltop

private

Definition at line 18 of file diagnostics.F90.

◆ cltop_av

real(kind=default_precision) diagnostics_mod::cltop_av

private

Definition at line 18 of file diagnostics.F90.

◆ hqlmax

integer diagnostics_mod::hqlmax

private

Definition at line 16 of file diagnostics.F90.

◆ ncl_col

integer diagnostics_mod::ncl_col

private

Definition at line 16 of file diagnostics.F90.

◆ qlcrit

real(kind=default_precision) diagnostics_mod::qlcrit

private

Definition at line 18 of file diagnostics.F90.

◆ qlmax

real(kind=default_precision) diagnostics_mod::qlmax

private

Definition at line 18 of file diagnostics.F90.

◆ tempfac

real(kind=default_precision), dimension(:), allocatable diagnostics_mod::tempfac

private

Definition at line 17 of file diagnostics.F90.

17 real(kind=DEFAULT_PRECISION), dimension(:), allocatable :: tempfac, theta_tot

◆ theta_tot

real(kind=default_precision), dimension(:), allocatable diagnostics_mod::theta_tot

private

Definition at line 17 of file diagnostics.F90.

◆ total_points

integer diagnostics_mod::total_points

private

Definition at line 16 of file diagnostics.F90.

16 integer :: total_points, hqlmax, ncl_col

◆ totql

real(kind=default_precision) diagnostics_mod::totql

private

Definition at line 18 of file diagnostics.F90.

◆ totqv

real(kind=default_precision) diagnostics_mod::totqv

private

Definition at line 18 of file diagnostics.F90.

18 real(kind=DEFAULT_PRECISION) :: totqv, totql, totqz, wmax, wmin, qlmax, qlcrit, cltop_av, clbas_av, cltop, clbas

◆ totqz

real(kind=default_precision) diagnostics_mod::totqz

private

Definition at line 18 of file diagnostics.F90.

◆ wmax

real(kind=default_precision) diagnostics_mod::wmax

private

Definition at line 18 of file diagnostics.F90.

◆ wmin

real(kind=default_precision) diagnostics_mod::wmin

private

Definition at line 18 of file diagnostics.F90.

Functions/Subroutines

Variables

Function/Subroutine Documentation

◆ diagnostics_get_descriptor()

◆ field_information_retrieval_callback()

◆ field_value_retrieval_callback()

◆ initialisation_callback()

◆ timestep_callback()

Variable Documentation

◆ clbas

◆ clbas_av

◆ cltop

◆ cltop_av

◆ hqlmax

◆ ncl_col

◆ qlcrit

◆ qlmax

◆ tempfac

◆ theta_tot

◆ total_points

◆ totql

◆ totqv

◆ totqz

◆ wmax

◆ wmin