meanprofiles_mod Module Reference

Calculates the mean profiles of prognostic variables which are then used in smoothing and other areas. More...

Functions/Subroutines
type(component_descriptor_type) function, public	meanprofiles_get_descriptor ()
	Returns the component descriptor of the mean profiles module. More...
subroutine	init_callback (current_state)
	Called on MONC initialisation, will allocate appropriate data structures. More...
subroutine	timestep_callback (current_state)
	Will recalculate the mean profiles of each prognostic when called (for the entire local domain) More...
subroutine	finalisation_callback (current_state)
	Frees up the temporary data for the bars. More...
subroutine	calculate_mean_profiles (current_state)
	Calculates the global mean profiles and stores these in the ol bar arrays. More...
subroutine	calculate_sum_profiles (current_state)
	Calculates the sum profiles for the bars for each level globally. More...

Variables
integer	start_x
integer	end_x
integer	start_y
integer	end_y
integer	bar_fields
real(kind=default_precision)	rnhpts
real(kind=default_precision), dimension(:,:), allocatable	bartmp

Detailed Description

Calculates the mean profiles of prognostic variables which are then used in smoothing and other areas.

Function/Subroutine Documentation

calculate_mean_profiles()

subroutine meanprofiles_mod::calculate_mean_profiles ( type(model_state_type), intent(inout), target  current_state )

private

Calculates the global mean profiles and stores these in the ol bar arrays.

Parameters

current_state

The current model state

Definition at line 100 of file meanprofiles.F90.

    type(model_state_type), target, intent(inout) :: current_state
 
    integer :: bar_index, i
    
    call calculate_sum_profiles(current_state)
 
    bar_index=1
#ifdef U_ACTIVE
    current_state%global_grid%configuration%vertical%olubar(:)=bartmp(:, bar_index)*rnhpts
    current_state%global_grid%configuration%vertical%olzubar(:)=bartmp(:, bar_index+1)*rnhpts
    bar_index=bar_index+2
#endif
#ifdef V_ACTIVE
    current_state%global_grid%configuration%vertical%olvbar(:)=bartmp(:, bar_index)*rnhpts
    current_state%global_grid%configuration%vertical%olzvbar(:)=bartmp(:, bar_index+1)*rnhpts
    bar_index=bar_index+2
#endif
    if (current_state%th%active) then
      current_state%global_grid%configuration%vertical%olthbar(:)=bartmp(:, bar_index)*rnhpts
      current_state%global_grid%configuration%vertical%olzthbar(:)=bartmp(:, bar_index+1)*rnhpts
      bar_index=bar_index+2
    end if
    do i=1,current_state%number_q_fields
      if (current_state%q(i)%active) then
        current_state%global_grid%configuration%vertical%olqbar(:, i)=bartmp(:, bar_index)*rnhpts
        current_state%global_grid%configuration%vertical%olzqbar(:, i)=bartmp(:, bar_index+1)*rnhpts
        bar_index=bar_index+2
      end if
    end do
 

Here is the call graph for this function:

Here is the caller graph for this function:

calculate_sum_profiles()

subroutine meanprofiles_mod::calculate_sum_profiles ( type(model_state_type), intent(inout)  current_state )

private

Calculates the sum profiles for the bars for each level globally.

Parameters

current_state

The current model state_mod

Definition at line 135 of file meanprofiles.F90.

    type(model_state_type), intent(inout) :: current_state
 
    integer :: k, n, bar_index, ierr    
    
    do k=current_state%local_grid%local_domain_start_index(z_index), current_state%local_grid%local_domain_end_index(z_index)
      bar_index=1
#ifdef U_ACTIVE
      bartmp(k, bar_index)=sum(current_state%u%data(k, start_y:end_y, start_x:end_x))
      bartmp(k, bar_index+1)=sum(current_state%zu%data(k, start_y:end_y, start_x:end_x))
      bar_index=bar_index+2
#endif
#ifdef V_ACTIVE
      bartmp(k, bar_index)=sum(current_state%v%data(k, start_y:end_y, start_x:end_x))
      bartmp(k, bar_index+1)=sum(current_state%zv%data(k, start_y:end_y, start_x:end_x))      
      bar_index=bar_index+2
#endif
      if (current_state%th%active) then
        bartmp(k, bar_index)=sum(current_state%th%data(k, start_y:end_y, start_x:end_x))
        bartmp(k, bar_index+1)=sum(current_state%zth%data(k, start_y:end_y, start_x:end_x))
        bar_index=bar_index+2
      end if
      do n=1,current_state%number_q_fields
        if (current_state%q(n)%active) then
          bartmp(k, bar_index)=sum(current_state%q(n)%data(k, start_y:end_y, start_x:end_x))
          bartmp(k, bar_index+1)=sum(current_state%zq(n)%data(k, start_y:end_y, start_x:end_x))
          bar_index=bar_index+2
        end if
      end do
    end do
 
    call mpi_allreduce(mpi_in_place, bartmp, bar_fields*current_state%local_grid%size(z_index), precision_type, mpi_sum, &
         current_state%parallel%monc_communicator, ierr)

Here is the caller graph for this function:

finalisation_callback()

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

private

Frees up the temporary data for the bars.

Parameters

current_state

The current model state

Definition at line 92 of file meanprofiles.F90.

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

Here is the caller graph for this function:

init_callback()

subroutine meanprofiles_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

Definition at line 34 of file meanprofiles.F90.

    type(model_state_type), target, intent(inout) :: current_state
 
    bar_fields=0
 
    rnhpts=1.0_default_precision/real(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)
 
#ifdef U_ACTIVE
    if (.not. current_state%continuation_run) then
      allocate(current_state%global_grid%configuration%vertical%olubar(current_state%local_grid%size(z_index)),&
           current_state%global_grid%configuration%vertical%olzubar(current_state%local_grid%size(z_index)))
    end if
    bar_fields=bar_fields+2
#endif
#ifdef V_ACTIVE
    if (.not. current_state%continuation_run) then
      allocate(current_state%global_grid%configuration%vertical%olvbar(current_state%local_grid%size(z_index)),&
           current_state%global_grid%configuration%vertical%olzvbar(current_state%local_grid%size(z_index)))
    end if
    bar_fields=bar_fields+2
#endif
    if (current_state%th%active) then
      if (.not. current_state%continuation_run) then
        allocate(current_state%global_grid%configuration%vertical%olthbar(current_state%local_grid%size(z_index)),&
             current_state%global_grid%configuration%vertical%olzthbar(current_state%local_grid%size(z_index)))
      end if
      bar_fields=bar_fields+2
    end if
    if (current_state%number_q_fields .gt. 0) then
      bar_fields=bar_fields+(current_state%number_q_fields*2)
      if (.not. current_state%continuation_run) then
        allocate(current_state%global_grid%configuration%vertical%olqbar(current_state%local_grid%size(z_index), &
             current_state%number_q_fields), current_state%global_grid%configuration%vertical%olzqbar(&
             current_state%local_grid%size(z_index), current_state%number_q_fields))
      end if
    end if
    allocate(bartmp(current_state%local_grid%size(z_index), bar_fields))
 
    ! Do the initial calculation for the first timestep
    if (.not. current_state%continuation_run) call calculate_mean_profiles(current_state)

Here is the call graph for this function:

Here is the caller graph for this function:

meanprofiles_get_descriptor()

type(component_descriptor_type) function, public meanprofiles_mod::meanprofiles_get_descriptor

Returns the component descriptor of the mean profiles module.

Returns

Component descriptor of mean profiles

Definition at line 24 of file meanprofiles.F90.

    meanprofiles_get_descriptor%name="mean_profiles"
    meanprofiles_get_descriptor%version=0.1
    meanprofiles_get_descriptor%initialisation=>init_callback
    meanprofiles_get_descriptor%timestep=>timestep_callback
    meanprofiles_get_descriptor%finalisation=>finalisation_callback

Here is the call graph for this function:

timestep_callback()

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

private

Will recalculate the mean profiles of each prognostic when called (for the entire local domain)

Parameters

current_state

The current model state

Definition at line 83 of file meanprofiles.F90.

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

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

bar_fields

integer meanprofiles_mod::bar_fields

private

Definition at line 14 of file meanprofiles.F90.

bartmp

real(kind=default_precision), dimension(:,:), allocatable meanprofiles_mod::bartmp

private

Definition at line 17 of file meanprofiles.F90.

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

end_x

integer meanprofiles_mod::end_x

private

Definition at line 14 of file meanprofiles.F90.

end_y

integer meanprofiles_mod::end_y

private

Definition at line 14 of file meanprofiles.F90.

rnhpts

real(kind=default_precision) meanprofiles_mod::rnhpts

private

Definition at line 16 of file meanprofiles.F90.

  real(kind=default_precision) :: rnhpts

start_x

integer meanprofiles_mod::start_x

private

Definition at line 14 of file meanprofiles.F90.

  integer :: start_x, end_x, start_y, end_y, bar_fields

start_y

integer meanprofiles_mod::start_y

private

Definition at line 14 of file meanprofiles.F90.