mom_checksums::is_nan Interface Reference

Detailed Description

Definition at line 77 of file MOM_checksums.F90.

Private functions
logical function	is_nan_0d (x)
	This function returns .true. if x is a NaN, and .false. otherwise. More...
logical function	is_nan_1d (x, skip_mpp)
	This function returns .true. if any element of x is a NaN, and .false. otherwise. More...
logical function	is_nan_2d (x)
	This function returns .true. if any element of x is a NaN, and .false. otherwise. More...
logical function	is_nan_3d (x)
	This function returns .true. if any element of x is a NaN, and .false. otherwise. More...

Functions and subroutines

is_nan_0d()

logical function mom_checksums::is_nan::is_nan_0d ( real, intent(in)  x )

private

This function returns .true. if x is a NaN, and .false. otherwise.

Parameters

[in]

x

The value to be checked for NaNs.

Definition at line 1322 of file MOM_checksums.F90.

  real, intent(in) :: x !< The value to be checked for NaNs.
  logical :: is_nan_0d

 !is_NaN_0d = (((x < 0.0) .and. (x >= 0.0)) .or. &
 !          (.not.(x < 0.0) .and. .not.(x >= 0.0)))
  if (((x < 0.0) .and. (x >= 0.0)) .or. &
            (.not.(x < 0.0) .and. .not.(x >= 0.0))) then
    is_nan_0d = .true.
  else
    is_nan_0d = .false.
  endif

is_nan_1d()

logical function mom_checksums::is_nan::is_nan_1d ( real, dimension(:), intent(in)  x, logical, optional  skip_mpp  )

private

This function returns .true. if any element of x is a NaN, and .false. otherwise.

Parameters

[in]	x	The array to be checked for NaNs.
	skip_mpp	If true, only check this array only on the local PE (default false).

Definition at line 1340 of file MOM_checksums.F90.

  real, dimension(:), intent(in) :: x !< The array to be checked for NaNs.
  logical :: is_nan_1d
  logical, optional :: skip_mpp  !< If true, only check this array only on the local PE (default false).

  integer :: i, n
  logical :: call_mpp

  n = 0
  do i = lbound(x,1), ubound(x,1)
    if (is_nan_0d(x(i))) n = n + 1
  enddo
  call_mpp = .true.
  if (present(skip_mpp)) call_mpp = .not.skip_mpp

  if (call_mpp) call sum_across_pes(n)
  is_nan_1d = .false.
  if (n>0) is_nan_1d = .true.

is_nan_2d()

logical function mom_checksums::is_nan::is_nan_2d ( real, dimension(:,:), intent(in)  x )

private

This function returns .true. if any element of x is a NaN, and .false. otherwise.

Parameters

[in]

x

The array to be checked for NaNs.

Definition at line 1364 of file MOM_checksums.F90.

  real, dimension(:,:), intent(in) :: x !< The array to be checked for NaNs.
  logical :: is_nan_2d

  integer :: i, j, n

  n = 0
  do j = lbound(x,2), ubound(x,2) ; do i = lbound(x,1), ubound(x,1)
    if (is_nan_0d(x(i,j))) n = n + 1
  enddo ; enddo
  call sum_across_pes(n)
  is_nan_2d = .false.
  if (n>0) is_nan_2d = .true.

is_nan_3d()

logical function mom_checksums::is_nan::is_nan_3d ( real, dimension(:,:,:), intent(in)  x )

private

This function returns .true. if any element of x is a NaN, and .false. otherwise.

Parameters

[in]

x

The array to be checked for NaNs.

Definition at line 1383 of file MOM_checksums.F90.

  real, dimension(:,:,:), intent(in) :: x !< The array to be checked for NaNs.
  logical :: is_nan_3d

  integer :: i, j, k, n

  n = 0
  do k = lbound(x,3), ubound(x,3)
    do j = lbound(x,2), ubound(x,2) ; do i = lbound(x,1), ubound(x,1)
      if (is_nan_0d(x(i,j,k))) n = n + 1
    enddo ; enddo
  enddo
  call sum_across_pes(n)
  is_nan_3d = .false.
  if (n>0) is_nan_3d = .true.

---

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

• /home/adcroft/GitHub/workspace/Gaea-stats-MOM6-examples/MOM6-examples/src/MOM6/src/framework/MOM_checksums.F90