mom_coms::efp_sum_across_pes Interface Reference

Detailed Description

Sum a value or 1-d array of values across processors, returning the sums in place.

Definition at line 64 of file MOM_coms.F90.

Private functions
subroutine	efp_list_sum_across_pes (EFPs, nval, errors)
	This subroutine does a sum across PEs of a list of EFP variables, returning the sums in place, with all overflows carried. More...
subroutine	efp_val_sum_across_pes (EFP, error)
	This subroutine does a sum across PEs of an EFP variable, returning the sums in place, with all overflows carried. More...

Detailed Description

Sum a value or 1-d array of values across processors, returning the sums in place.

Definition at line 64 of file MOM_coms.F90.

Functions and subroutines

efp_list_sum_across_pes()

subroutine mom_coms::efp_sum_across_pes::efp_list_sum_across_pes ( type(efp_type), dimension(:), intent(inout)  EFPs, integer, intent(in)  nval, logical, dimension(:), intent(out), optional  errors  )

private

This subroutine does a sum across PEs of a list of EFP variables, returning the sums in place, with all overflows carried.

Parameters

[in,out]	efps	The list of extended fixed point numbers
[in]	nval	The number of values being summed.
[out]	errors	A list of error flags for each sum

Definition at line 789 of file MOM_coms.F90.

  type(EFP_type), dimension(:), &
              intent(inout) :: EFPs   !< The list of extended fixed point numbers
                                      !! being summed across PEs.
  integer,    intent(in)    :: nval   !< The number of values being summed.
  logical, dimension(:), &
           optional, intent(out)   :: errors !< A list of error flags for each sum
 
  !   This subroutine does a sum across PEs of a list of EFP variables,
  ! returning the sums in place, with all overflows carried.
 
  integer(kind=8), dimension(ni,nval) :: ints
  integer(kind=8) :: prec_error
  logical :: error_found
  character(len=256) :: mesg
  integer :: i, n
 
  if (num_pes() > max_count_prec) call mom_error(fatal, &
    "reproducing_sum: Too many processors are being used for the value of "//&
    "prec.  Reduce prec to (2^63-1)/num_PEs.")
 
  prec_error = (2_8**62 + (2_8**62 - 1)) / num_pes()
  ! overflow_error is an overflow error flag for the whole module.
  overflow_error = .false. ; error_found = .false.
 
  do i=1,nval ; do n=1,ni ; ints(n,i) = efps(i)%v(n) ; enddo ; enddo
 
  call sum_across_pes(ints(:,:), ni*nval)
 
  if (present(errors)) errors(:) = .false.
  do i=1,nval
    overflow_error = .false.
    call carry_overflow(ints(:,i), prec_error)
    do n=1,ni ; efps(i)%v(n) = ints(n,i) ; enddo
    if (present(errors)) errors(i) = overflow_error
    if (overflow_error) then
      write (mesg,'("EFP_list_sum_across_PEs error at ",i6," val was ",ES12.6, ", prec_error = ",ES12.6)') &
             i, efp_to_real(efps(i)), real(prec_error)
      call mom_error(warning, mesg)
    endif
    error_found = error_found .or. overflow_error
  enddo
  if (error_found .and. .not.(present(errors))) then
    call mom_error(fatal, "Overflow in EFP_list_sum_across_PEs.")
  endif
 

efp_val_sum_across_pes()

subroutine mom_coms::efp_sum_across_pes::efp_val_sum_across_pes ( type(efp_type), intent(inout)  EFP, logical, intent(out), optional  error  )

private

This subroutine does a sum across PEs of an EFP variable, returning the sums in place, with all overflows carried.

Parameters

[in,out]	efp	The extended fixed point numbers being summed across PEs.
[out]	error	An error flag for this sum

Definition at line 839 of file MOM_coms.F90.

  type(EFP_type),  intent(inout) :: EFP   !< The extended fixed point numbers
                                          !! being summed across PEs.
  logical, optional, intent(out) :: error !< An error flag for this sum
 
  !   This subroutine does a sum across PEs of a list of EFP variables,
  ! returning the sums in place, with all overflows carried.
 
  integer(kind=8), dimension(ni) :: ints
  integer(kind=8) :: prec_error
  logical :: error_found
  character(len=256) :: mesg
  integer :: n
 
  if (num_pes() > max_count_prec) call mom_error(fatal, &
    "reproducing_sum: Too many processors are being used for the value of "//&
    "prec.  Reduce prec to (2^63-1)/num_PEs.")
 
  prec_error = (2_8**62 + (2_8**62 - 1)) / num_pes()
  ! overflow_error is an overflow error flag for the whole module.
  overflow_error = .false. ; error_found = .false.
 
  do n=1,ni ; ints(n) = efp%v(n) ; enddo
 
  call sum_across_pes(ints(:), ni)
 
  if (present(error)) error = .false.
 
  overflow_error = .false.
  call carry_overflow(ints(:), prec_error)
  do n=1,ni ; efp%v(n) = ints(n) ; enddo
  if (present(error)) error = overflow_error
  if (overflow_error) then
    write (mesg,'("EFP_val_sum_across_PEs error val was ",ES12.6, ", prec_error = ",ES12.6)') &
           efp_to_real(efp), real(prec_error)
    call mom_error(warning, mesg)
  endif
  error_found = error_found .or. overflow_error
 
  if (error_found .and. .not.(present(error))) then
    call mom_error(fatal, "Overflow in EFP_val_sum_across_PEs.")
  endif
 

---

The documentation for this interface was generated from the following file:

• /home/cermak/src/MOM6.devrob/src/framework/MOM_coms.F90