conditional_diagnostics_whole_mod Module Reference

Conditionally averaged diagnostics, Part 2 of 2. More...

Functions/Subroutines
type(component_descriptor_type) function, public	conditional_diagnostics_whole_get_descriptor ()
	Provides registry information for the component. More...
subroutine	initialisation_callback (current_state)
	Initialisation hook: currently doesn't need to do anything. More...
subroutine	timestep_callback (current_state)
	The timestep hook will perform averaging of the conditional diagnostics. More...
subroutine	finalisation_callback (current_state)
	Called on termination: currently doesn't need to do anything. More...

Variables
integer	diagnostic_generation_frequency

Detailed Description

Conditionally averaged diagnostics, Part 2 of 2.

Function/Subroutine Documentation

conditional_diagnostics_whole_get_descriptor()

type(component_descriptor_type) function, public conditional_diagnostics_whole_mod::conditional_diagnostics_whole_get_descriptor

Provides registry information for the component.

Returns

The component descriptor that describes this component

Definition at line 33 of file conditional_diagnostics_whole.F90.

    conditional_diagnostics_whole_get_descriptor%name="conditional_diagnostics_whole"
    conditional_diagnostics_whole_get_descriptor%version=0.1
    conditional_diagnostics_whole_get_descriptor%initialisation=>initialisation_callback
    conditional_diagnostics_whole_get_descriptor%timestep=>timestep_callback
    conditional_diagnostics_whole_get_descriptor%finalisation=>finalisation_callback

Here is the call graph for this function:

finalisation_callback()

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

private

Called on termination: currently doesn't need to do anything.

Parameters

current_state

The current model state

Definition at line 112 of file conditional_diagnostics_whole.F90.

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

Here is the caller graph for this function:

initialisation_callback()

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

private

Initialisation hook: currently doesn't need to do anything.

Parameters

current_state

The current model state

Definition at line 44 of file conditional_diagnostics_whole.F90.

    type(model_state_type), target, intent(inout) :: current_state
 
    ! 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:

timestep_callback()

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

private

The timestep hook will perform averaging of the conditional diagnostics.

Parameters

current_state

The current model state

Decide if conditions are appropriate to proceed with calculations

Sum conditional diagnostics total array (horizontally), placing the result on process 0 Reduction call on process 0 requires special MPI_IN_PLACE handling

Average summed diagnostics over the domain by dividing the total diagnostic for each condition by the total number of points for the associated conditions. This is NOT done for the area diagnostic, identified by the requested_area position in the array. Note: CondDiags_tot(k, ncond, ndiag)

Convert the area total number of points for each condition to fraction of the horizontal domain.

Apply missing data mask to top/bottom

Since the xml handling of CondDiags_tot will perform a sum over processes, divide by the number of proceses.

Broadcast the process-fractional solution to all processes.

Definition at line 55 of file conditional_diagnostics_whole.F90.

    type(model_state_type), target, intent(inout) :: current_state
    integer :: k,cnc,dnc,ierr
    real(kind=default_precision) :: temp
 
    if (.not. mod(current_state%timestep, diagnostic_generation_frequency) == 0) return
 
    if (current_state%parallel%my_rank == 0) then
      call mpi_reduce(mpi_in_place , conddiags_tot, ncond*2*ndiag*current_state%local_grid%size(z_index), &
                      precision_type, mpi_sum, 0, current_state%parallel%monc_communicator, ierr)
    else
      call mpi_reduce(conddiags_tot, conddiags_tot, ncond*2*ndiag*current_state%local_grid%size(z_index), &
                      precision_type, mpi_sum, 0, current_state%parallel%monc_communicator, ierr)
    end if
 
    do dnc = 1, ndiag
      if (dnc /= requested_area) then
        do cnc = 1, ncond
          do k = 2, current_state%local_grid%size(z_index) - 1
            temp = conddiags_tot(k,cnc,requested_area)
            if (temp .gt. 0) then
              conddiags_tot(k,cnc,dnc) = conddiags_tot(k,cnc,dnc) / temp
            else
              conddiags_tot(k,cnc,dnc) = rmdi
            end if
          end do ! k
        end do ! cnc over ncond*2
      end if ! check requested_area
    end do ! dnc over ndiag
 
    conddiags_tot(:,:,requested_area) = conddiags_tot(:,:,requested_area) / gpts_total
 
    conddiags_tot(1,:,:) = rmdi
    conddiags_tot(current_state%local_grid%size(z_index),:,:) = rmdi
 
    conddiags_tot = conddiags_tot / current_state%parallel%processes
 
    call mpi_bcast(conddiags_tot,  ncond*2*ndiag*current_state%local_grid%size(z_index), &
                   precision_type, 0, current_state%parallel%monc_communicator, ierr)
 

Here is the caller graph for this function:

Variable Documentation

diagnostic_generation_frequency

integer conditional_diagnostics_whole_mod::diagnostic_generation_frequency

private

Definition at line 24 of file conditional_diagnostics_whole.F90.

  integer :: diagnostic_generation_frequency