mom_array_transform::rotate_array_pair Interface Reference

Detailed Description

Rotate a pair of arrays which map to a rotated set of indices. Rotation is applied across the first and second axes of the array. This rotation should be applied when one field is mapped onto the other. For example, a tracer indexed along u or v face points will map from one to the other after a quarter turn, and back onto itself after a half turn.

Definition at line 41 of file MOM_array_transform.F90.

Private functions
subroutine	rotate_array_pair_real_2d (A_in, B_in, turns, A, B)
	Rotate the elements of a 2d real array pair along first and second axes. More...
subroutine	rotate_array_pair_real_3d (A_in, B_in, turns, A, B)
	Rotate the elements of a 3d real array pair along first and second axes. More...
subroutine	rotate_array_pair_integer (A_in, B_in, turns, A, B)
	Rotate the elements of a 4d real array pair along first and second axes. More...

Detailed Description

Rotate a pair of arrays which map to a rotated set of indices. Rotation is applied across the first and second axes of the array. This rotation should be applied when one field is mapped onto the other. For example, a tracer indexed along u or v face points will map from one to the other after a quarter turn, and back onto itself after a half turn.

Definition at line 41 of file MOM_array_transform.F90.

Functions and subroutines

rotate_array_pair_integer()

subroutine mom_array_transform::rotate_array_pair::rotate_array_pair_integer ( integer, dimension(:,:), intent(in)  A_in, integer, dimension(:,:), intent(in)  B_in, integer, intent(in)  turns, integer, dimension(:,:), intent(out)  A, integer, dimension(:,:), intent(out)  B  )

private

Rotate the elements of a 4d real array pair along first and second axes.

Parameters

[in]	a_in	Unrotated scalar array pair
[in]	b_in	Unrotated scalar array pair
[in]	turns	Number of quarter turns
[out]	a	Rotated scalar array pair
[out]	b	Rotated scalar array pair

Definition at line 213 of file MOM_array_transform.F90.

  integer, intent(in) :: A_in(:,:)  !< Unrotated scalar array pair
  integer, intent(in) :: B_in(:,:)  !< Unrotated scalar array pair
  integer, intent(in) :: turns      !< Number of quarter turns
  integer, intent(out) :: A(:,:)    !< Rotated scalar array pair
  integer, intent(out) :: B(:,:)    !< Rotated scalar array pair

  if (modulo(turns, 2) /= 0) then
    call rotate_array(b_in, turns, a)
    call rotate_array(a_in, turns, b)
  else
    call rotate_array(a_in, turns, a)
    call rotate_array(b_in, turns, b)
  endif

rotate_array_pair_real_2d()

subroutine mom_array_transform::rotate_array_pair::rotate_array_pair_real_2d ( real, dimension(:,:), intent(in)  A_in, real, dimension(:,:), intent(in)  B_in, integer, intent(in)  turns, real, dimension(:,:), intent(out)  A, real, dimension(:,:), intent(out)  B  )

private

Rotate the elements of a 2d real array pair along first and second axes.

Parameters

[in]	a_in	Unrotated scalar array pair
[in]	b_in	Unrotated scalar array pair
[in]	turns	Number of quarter turns
[out]	a	Rotated scalar array pair
[out]	b	Rotated scalar array pair

Definition at line 178 of file MOM_array_transform.F90.

  real, intent(in) :: A_in(:,:)   !< Unrotated scalar array pair
  real, intent(in) :: B_in(:,:)   !< Unrotated scalar array pair
  integer, intent(in) :: turns    !< Number of quarter turns
  real, intent(out) :: A(:,:)     !< Rotated scalar array pair
  real, intent(out) :: B(:,:)     !< Rotated scalar array pair

  if (modulo(turns, 2) /= 0) then
    call rotate_array(b_in, turns, a)
    call rotate_array(a_in, turns, b)
  else
    call rotate_array(a_in, turns, a)
    call rotate_array(b_in, turns, b)
  endif

rotate_array_pair_real_3d()

subroutine mom_array_transform::rotate_array_pair::rotate_array_pair_real_3d ( real, dimension(:,:,:), intent(in)  A_in, real, dimension(:,:,:), intent(in)  B_in, integer, intent(in)  turns, real, dimension(:,:,:), intent(out)  A, real, dimension(:,:,:), intent(out)  B  )

private

Rotate the elements of a 3d real array pair along first and second axes.

Parameters

[in]	a_in	Unrotated scalar array pair
[in]	b_in	Unrotated scalar array pair
[in]	turns	Number of quarter turns
[out]	a	Rotated scalar array pair
[out]	b	Rotated scalar array pair

Definition at line 196 of file MOM_array_transform.F90.

  real, intent(in) :: A_in(:,:,:)   !< Unrotated scalar array pair
  real, intent(in) :: B_in(:,:,:)   !< Unrotated scalar array pair
  integer, intent(in) :: turns      !< Number of quarter turns
  real, intent(out) :: A(:,:,:)     !< Rotated scalar array pair
  real, intent(out) :: B(:,:,:)     !< Rotated scalar array pair

  integer :: k

  do k = 1, size(a_in, 3)
    call rotate_array_pair(a_in(:,:,k), b_in(:,:,k), turns, &
        a(:,:,k), b(:,:,k))
  enddo

---

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

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