pdf_analysis_mod Module Reference

Calculates fields related to distributions of data on full-domain horizontal 2d slices. More...

Functions/Subroutines
type(component_descriptor_type) function, public	pdf_analysis_get_descriptor ()
	Returns the component descriptor of pdf analysis module. More...
subroutine	init_callback (current_state)
	Called on MONC initialisation, will allocate appropriate data structures. More...
subroutine	timestep_callback (current_state)
	Will sort the values across the whole domain and calculate the value corresponding to the percentile threshold. More...
subroutine	finalisation_callback (current_state)
	Frees up the temporary data for the tm_allp. More...
subroutine	calculate_w_percentiles (current_state)
	Calculates the w percentiles over the whole domain and stores these in the w up/dwn percentile arrays of current_state. More...
subroutine	mergesortmerge (A, NA, B, NB, C, NC)
	Combines with MergeSort sorting algorithm taken from: More...
recursive subroutine	mergesort (A, N, T)
	Combines with MergeSortMerge sorting algorithm taken from: 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...

Variables
integer	start_x
integer	end_x
integer	start_y
integer	end_y
integer	xsize
integer	ysize
real(kind=default_precision)	uppercrit
real(kind=default_precision)	dwnpercrit
real(kind=default_precision), dimension(:), allocatable	tmp_all
integer, dimension(:), allocatable	gpts_on_proc
integer, dimension(:), allocatable	displacements
integer	tpts
integer	lpts
logical	show_critical_w
integer	diagnostic_generation_frequency

Detailed Description

Calculates fields related to distributions of data on full-domain horizontal 2d slices.

Function/Subroutine Documentation

calculate_w_percentiles()

subroutine pdf_analysis_mod::calculate_w_percentiles ( type(model_state_type), intent(inout), target  current_state )

private

Calculates the w percentiles over the whole domain and stores these in the w up/dwn percentile arrays of current_state.

Parameters

current_state

The current model state

initialize diagnostic thresholds

reset thresholds

Loop over levels

specify local data area

Reshape to 1-D array

Perform sort of data on local process

Gather 2d field to single process

Perform global operations

Sort the global data on single process

Determine threshold updraft and downdraft values

do some stdout diagnostic work

Inform all processes of calculated thresholds

Display some diagnostics, if requested

Definition at line 136 of file pdf_analysis.F90.

    type(model_state_type), target, intent(inout) :: current_state
    real(kind=default_precision), dimension(lpts) :: tmp_var
 
    integer :: i, j, k, num_neg, num_pos, dd_thresh_pos, ud_thresh_pos
    integer :: max_up_k, min_dwn_k 
    real(kind=default_precision), dimension((lpts+1)/2) :: t
    real(kind=default_precision), dimension((tpts+1)/2) :: tall
    real(kind=default_precision)                        :: max_up, min_dwn, &
                                                           max_up_th, min_dwn_th
    integer :: ierr
    real(kind=default_precision), dimension(ysize,xsize) :: l2d ! local 2d data
 
    max_up_th  = 0.0_default_precision
    min_dwn_th = 0.0_default_precision
    max_up     = max_up_th
    min_dwn    = min_dwn_th
    max_up_k   = 0
    min_dwn_k  = 0
 
    current_state%global_grid%configuration%vertical%w_dwn(:) = 0.0_default_precision 
    current_state%global_grid%configuration%vertical%w_up(:)  = 0.0_default_precision
 
    do k = 2, current_state%local_grid%size(z_index)
 
       l2d(:,:)=0.5_default_precision*(   current_state%w%data(k  , start_y:end_y, start_x:end_x)   &
                                        + current_state%w%data(k-1, start_y:end_y, start_x:end_x)    )
 
       tmp_var=pack(l2d,.true.)
 
       call mergesort(tmp_var,lpts,t)
 
       call mpi_gatherv(tmp_var, lpts, precision_type, tmp_all, gpts_on_proc, displacements, precision_type, &
                        0, current_state%parallel%monc_communicator, ierr )
 
       if (current_state%parallel%my_rank == 0) then
 
         call mergesort(tmp_all,tpts,tall)
 
         num_neg = count(tmp_all < 0.0_default_precision)
         num_pos = count(tmp_all > 0.0_default_precision)
 
         dd_thresh_pos = int(num_neg * dwnpercrit) 
         ud_thresh_pos = tpts - int(num_pos * uppercrit) + 1
 
         if ( dd_thresh_pos == 0 ) dd_thresh_pos = 1
         if ( ud_thresh_pos == 0 .or. num_pos == 0 ) ud_thresh_pos = tpts
 
         current_state%global_grid%configuration%vertical%w_dwn(k) = tmp_all(dd_thresh_pos)
         current_state%global_grid%configuration%vertical%w_up(k)  = tmp_all(ud_thresh_pos)
 
         if (show_critical_w) then
           if ( tmp_all(dd_thresh_pos) < min_dwn_th ) then
             min_dwn_th = tmp_all(dd_thresh_pos)
             min_dwn = tmp_all(1)  ! sorted array
             min_dwn_k = k
           end if 
           if ( tmp_all(ud_thresh_pos) > max_up_th ) then
             max_up_th = tmp_all(ud_thresh_pos)
             max_up = tmp_all(tpts)  ! sorted array
             max_up_k = k
           end if
         end if ! show_critical_w
 
       end if ! global operations section
 
    end do ! loop over k
 
    call mpi_bcast(current_state%global_grid%configuration%vertical%w_dwn(:), current_state%local_grid%size(z_index), &
                   precision_type, 0, current_state%parallel%monc_communicator, ierr)
    call mpi_bcast(current_state%global_grid%configuration%vertical%w_up(:),  current_state%local_grid%size(z_index), &
                   precision_type, 0, current_state%parallel%monc_communicator, ierr)
 
 
    if (show_critical_w) then
      call log_master_log(log_info, 'Time:  '//trim(conv_to_string(current_state%time))//' s')
      call log_master_log(log_info, 'Maximum updraft threshold:   '&
                          //trim(conv_to_string(max_up_th))//' found at level '//trim(conv_to_string(max_up_k)) )
      call log_master_log(log_info, 'Maximum updraft:   '&
                          //trim(conv_to_string(max_up))//' at level '//trim(conv_to_string(max_up_k)) )
      call log_master_log(log_info, 'Minimum downdraft threshold:   '&
                          //trim(conv_to_string(min_dwn_th))//' found at level '//trim(conv_to_string(min_dwn_k)) )   
      call log_master_log(log_info, 'Minimum downdraft:   '&
                          //trim(conv_to_string(min_dwn))//' at level '//trim(conv_to_string(min_dwn_k)) )
    end if ! show_critical_w
 

Here is the call graph for this function:

Here is the caller graph for this function:

field_information_retrieval_callback()

subroutine pdf_analysis_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 314 of file pdf_analysis.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=1
    field_information%dimension_sizes(1)=current_state%local_grid%size(z_index)
    field_information%data_type=component_double_data_type
    field_information%enabled=.true.
 

Here is the caller graph for this function:

field_value_retrieval_callback()

subroutine pdf_analysis_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 333 of file pdf_analysis.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. "critical_updraft_local") then
      allocate(field_value%real_1d_array(current_state%local_grid%size(z_index)), &
               source=current_state%global_grid%configuration%vertical%w_up(:))
    else if (name .eq. "critical_downdraft_local") then
      allocate(field_value%real_1d_array(current_state%local_grid%size(z_index)), &
               source=current_state%global_grid%configuration%vertical%w_dwn(:))
    end if 

Here is the caller graph for this function:

finalisation_callback()

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

private

Frees up the temporary data for the tm_allp.

Parameters

current_state

The current model state

Definition at line 127 of file pdf_analysis.F90.

    type(model_state_type), target, intent(inout) :: current_state
 
    if (allocated(tmp_all)) deallocate(tmp_all)    

Here is the caller graph for this function:

init_callback()

subroutine pdf_analysis_mod::init_callback ( type(model_state_type), intent(inout), target  current_state )

private

Called on MONC initialisation, will allocate appropriate data structures.

Parameters

current_state

The current model state

Allocate space for the global 2d field only on a single process

Allocate and collect horizontal local sizes, send to all proceses

Allocate and initialize displacement values

Allocate critial fields in current_state if a cold start

Definition at line 59 of file pdf_analysis.F90.

    type(model_state_type), target, intent(inout) :: current_state
    integer :: ierr, inc
 
    tpts = current_state%global_grid%size(x_index)*current_state%global_grid%size(y_index)
 
    start_x = current_state%local_grid%local_domain_start_index(x_index)
    end_x   = current_state%local_grid%local_domain_end_index(x_index)
    start_y = current_state%local_grid%local_domain_start_index(y_index)
    end_y   = current_state%local_grid%local_domain_end_index(y_index)
 
    xsize = end_x - start_x + 1
    ysize = end_y - start_y + 1
 
    lpts = xsize*ysize
 
    uppercrit  = options_get_real(current_state%options_database, "uppercrit")
    dwnpercrit = options_get_real(current_state%options_database, "dwnpercrit")
 
    show_critical_w = options_get_logical(current_state%options_database, "show_critical_w")
 
!    if (current_state%parallel%my_rank == 0) 
     allocate(tmp_all(tpts))
!    else
!      allocate(tmp_all(1))
!    end if
 
    allocate(gpts_on_proc(current_state%parallel%processes))
    call mpi_allgather(lpts, 1, mpi_int, gpts_on_proc, 1, mpi_int, current_state%parallel%monc_communicator, ierr)
 
    allocate(displacements(current_state%parallel%processes)) 
    displacements(1) = 0
    do inc = 2, current_state%parallel%processes
      displacements(inc) = displacements(inc-1) + gpts_on_proc(inc-1)
    end do ! loop over processes
 
    if (.not. current_state%continuation_run) then
      allocate(current_state%global_grid%configuration%vertical%w_dwn(current_state%local_grid%size(z_index)),&
               current_state%global_grid%configuration%vertical%w_up(current_state%local_grid%size(z_index)))
    end if
 
    ! 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:

mergesort()

recursive subroutine pdf_analysis_mod::mergesort ( real(kind=default_precision), dimension(n), intent(inout)  A, integer, intent(in)  N, real(kind=default_precision), dimension((n+1)/2), intent(out)  T  )

private

Combines with MergeSortMerge sorting algorithm taken from:

Definition at line 277 of file pdf_analysis.F90.

 
    integer, intent(in) :: N
    real(kind=default_precision), dimension(N), intent(in out) :: a
    real(kind=default_precision), dimension((N+1)/2), intent (out) :: t
 
    integer :: NA,NB
    real(kind=default_precision) :: v
 
    if (n < 2) return
    if (n == 2) then
      if (a(1) > a(2)) then
        v = a(1)
        a(1) = a(2)
        a(2) = v
      endif
      return
    endif      
    na=(n+1)/2
    nb=n-na
 
    call mergesort(a,na,t)
    call mergesort(a(na+1),nb,t)
 
    if (a(na) > a(na+1)) then
      t(1:na)=a(1:na)
      call mergesortmerge(t,na,a(na+1),nb,a,n)
    endif
    return
 

Here is the call graph for this function:

Here is the caller graph for this function:

mergesortmerge()

subroutine pdf_analysis_mod::mergesortmerge ( real(kind=default_precision), dimension(na), intent(inout)  A, integer, intent(in)  NA, real(kind=default_precision), dimension(nb), intent(in)  B, integer, intent(in)  NB, real(kind=default_precision), dimension(nc), intent(inout)  C, integer, intent(in)  NC  )

private

Combines with MergeSort sorting algorithm taken from:

Definition at line 242 of file pdf_analysis.F90.

 
    integer, intent(in) :: NA,NB,NC                              ! Normal usage: NA+NB = NC
    real(kind=default_precision), intent(in out) :: a(na)        ! B overlays C(NA+1:NC)
    real(kind=default_precision), intent(in)     :: b(nb)
    real(kind=default_precision), intent(in out) :: c(nc)
 
    integer :: I,J,K
 
    i = 1; j = 1; k = 1;
    do while(i <= na .and. j <= nb)
      if (a(i) <= b(j)) then
         c(k) = a(i)
         i = i+1
      else
         c(k) = b(j)
         j = j+1
      endif
      k = k + 1
    enddo
    do while (i <= na)
      c(k) = a(i)
      i = i + 1
      k = k + 1
    enddo
    return
 

Here is the caller graph for this function:

pdf_analysis_get_descriptor()

type(component_descriptor_type) function, public pdf_analysis_mod::pdf_analysis_get_descriptor

Returns the component descriptor of pdf analysis module.

Returns

Component descriptor of pdf analysis

Definition at line 41 of file pdf_analysis.F90.

    pdf_analysis_get_descriptor%name="pdf_analysis"
    pdf_analysis_get_descriptor%version=0.1
    pdf_analysis_get_descriptor%initialisation=>init_callback
    pdf_analysis_get_descriptor%timestep=>timestep_callback
    pdf_analysis_get_descriptor%finalisation=>finalisation_callback
 
    pdf_analysis_get_descriptor%field_value_retrieval=>field_value_retrieval_callback
    pdf_analysis_get_descriptor%field_information_retrieval=>field_information_retrieval_callback
    allocate(pdf_analysis_get_descriptor%published_fields(2))
    pdf_analysis_get_descriptor%published_fields(1)="critical_updraft_local"
    pdf_analysis_get_descriptor%published_fields(2)="critical_downdraft_local"
 

Here is the call graph for this function:

timestep_callback()

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

private

Will sort the values across the whole domain and calculate the value corresponding to the percentile threshold.

Parameters

current_state

The current model state

Current forumulation only handles vertical velocity percentiles. Future enhancements may employ this component to perform additional operations that require access to full horizontal fields, such as pdf calculations.

Definition at line 112 of file pdf_analysis.F90.

    type(model_state_type), target, intent(inout) :: current_state
 
 
    if (mod(current_state%timestep, diagnostic_generation_frequency) == 0) call calculate_w_percentiles(current_state)
 

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

diagnostic_generation_frequency

integer pdf_analysis_mod::diagnostic_generation_frequency

private

Definition at line 32 of file pdf_analysis.F90.

  integer :: diagnostic_generation_frequency

displacements

integer, dimension(:), allocatable pdf_analysis_mod::displacements

private

Definition at line 23 of file pdf_analysis.F90.

dwnpercrit

real(kind=default_precision) pdf_analysis_mod::dwnpercrit

private

Definition at line 21 of file pdf_analysis.F90.

end_x

integer pdf_analysis_mod::end_x

private

Definition at line 19 of file pdf_analysis.F90.

end_y

integer pdf_analysis_mod::end_y

private

Definition at line 19 of file pdf_analysis.F90.

gpts_on_proc

integer, dimension(:), allocatable pdf_analysis_mod::gpts_on_proc

private

Definition at line 23 of file pdf_analysis.F90.

  integer, dimension(:), allocatable :: gpts_on_proc, & ! number of horizontal grid points on each process
                                        displacements   ! displacement for mpi_gatherv

lpts

integer pdf_analysis_mod::lpts

private

Definition at line 28 of file pdf_analysis.F90.

  integer :: lpts  ! local number of horizontal grid points on 

show_critical_w

logical pdf_analysis_mod::show_critical_w

private

Definition at line 30 of file pdf_analysis.F90.

  logical :: show_critical_w  ! stdout diagnostic logical

start_x

integer pdf_analysis_mod::start_x

private

Definition at line 19 of file pdf_analysis.F90.

  integer :: start_x, end_x, start_y, end_y, xsize, ysize

start_y

integer pdf_analysis_mod::start_y

private

Definition at line 19 of file pdf_analysis.F90.

tmp_all

real(kind=default_precision), dimension(:), allocatable pdf_analysis_mod::tmp_all

private

Definition at line 22 of file pdf_analysis.F90.

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

tpts

integer pdf_analysis_mod::tpts

private

Definition at line 27 of file pdf_analysis.F90.

  integer :: tpts  ! total number of horizontal grid points on full domain

uppercrit

real(kind=default_precision) pdf_analysis_mod::uppercrit

private

Definition at line 21 of file pdf_analysis.F90.

  real(kind=default_precision) :: uppercrit, dwnpercrit

xsize

integer pdf_analysis_mod::xsize

private

Definition at line 19 of file pdf_analysis.F90.

ysize

integer pdf_analysis_mod::ysize

private

Definition at line 19 of file pdf_analysis.F90.