mom_diag_mediator::downsample_mask Interface Reference

Detailed Description

Down sample the mask of a field.

Definition at line 80 of file MOM_diag_mediator.F90.

Private functions
subroutine	downsample_mask_2d (field_in, field_out, dl, isc_o, jsc_o, isc_d, iec_d, jsc_d, jec_d, isd_d, ied_d, jsd_d, jed_d)
	Allocate and compute the 2d down sampled mask The masks are down sampled based on a minority rule, i.e., a coarse cell is open (1) if at least one of the sub-cells are open, otherwise it's closed (0) More...
subroutine	downsample_mask_3d (field_in, field_out, dl, isc_o, jsc_o, isc_d, iec_d, jsc_d, jec_d, isd_d, ied_d, jsd_d, jed_d)
	Allocate and compute the 3d down sampled mask The masks are down sampled based on a minority rule, i.e., a coarse cell is open (1) if at least one of the sub-cells are open, otherwise it's closed (0) More...

Functions and subroutines

downsample_mask_2d()

subroutine mom_diag_mediator::downsample_mask::downsample_mask_2d ( real, dimension(:,:), intent(in)  field_in, real, dimension(:,:), pointer  field_out, integer, intent(in)  dl, integer, intent(in)  isc_o, integer, intent(in)  jsc_o, integer, intent(in)  isc_d, integer, intent(in)  iec_d, integer, intent(in)  jsc_d, integer, intent(in)  jec_d, integer, intent(in)  isd_d, integer, intent(in)  ied_d, integer, intent(in)  jsd_d, integer, intent(in)  jed_d  )

private

Allocate and compute the 2d down sampled mask The masks are down sampled based on a minority rule, i.e., a coarse cell is open (1) if at least one of the sub-cells are open, otherwise it's closed (0)

Parameters

[in]	field_in	Original field to be down sampled
	field_out	Down sampled field
[in]	dl	Level of down sampling
[in]	isc_o	Original i-start index
[in]	jsc_o	Original j-start index
[in]	isc_d	Computational i-start index of down sampled data
[in]	iec_d	Computational i-end index of down sampled data
[in]	jsc_d	Computational j-start index of down sampled data
[in]	jec_d	Computational j-end index of down sampled data
[in]	isd_d	Computational i-start index of down sampled data
[in]	ied_d	Computational i-end index of down sampled data
[in]	jsd_d	Computational j-start index of down sampled data
[in]	jed_d	Computational j-end index of down sampled data

Definition at line 4139 of file MOM_diag_mediator.F90.

  real, dimension(:,:), intent(in) :: field_in !< Original field to be down sampled
  real, dimension(:,:), pointer :: field_out   !< Down sampled field
  integer, intent(in) :: dl    !< Level of down sampling
  integer, intent(in) :: isc_o !< Original i-start index
  integer, intent(in) :: jsc_o !< Original j-start index
  integer, intent(in) :: isc_d !< Computational i-start index of down sampled data
  integer, intent(in) :: iec_d !< Computational i-end index of down sampled data
  integer, intent(in) :: jsc_d !< Computational j-start index of down sampled data
  integer, intent(in) :: jec_d !< Computational j-end index of down sampled data
  integer, intent(in) :: isd_d !< Computational i-start index of down sampled data
  integer, intent(in) :: ied_d !< Computational i-end index of down sampled data
  integer, intent(in) :: jsd_d !< Computational j-start index of down sampled data
  integer, intent(in) :: jed_d !< Computational j-end index of down sampled data
  ! Locals
  integer :: i,j,ii,jj,i0,j0
  real    :: tot_non_zero
  ! down sampled mask = 0 unless the mask value of one of the down sampling cells is 1
  allocate(field_out(isd_d:ied_d,jsd_d:jed_d))
  field_out(:,:) = 0.0
  do j=jsc_d,jec_d ; do i=isc_d,iec_d
     i0 = isc_o+dl*(i-isc_d)
     j0 = jsc_o+dl*(j-jsc_d)
     tot_non_zero = 0.0
     do jj=j0,j0+dl-1 ; do ii=i0,i0+dl-1
        tot_non_zero = tot_non_zero + field_in(ii,jj)
     enddo;enddo
     if(tot_non_zero > 0.0) field_out(i,j)=1.0
  enddo; enddo

downsample_mask_3d()

subroutine mom_diag_mediator::downsample_mask::downsample_mask_3d ( real, dimension(:,:,:), intent(in)  field_in, real, dimension(:,:,:), pointer  field_out, integer, intent(in)  dl, integer, intent(in)  isc_o, integer, intent(in)  jsc_o, integer, intent(in)  isc_d, integer, intent(in)  iec_d, integer, intent(in)  jsc_d, integer, intent(in)  jec_d, integer, intent(in)  isd_d, integer, intent(in)  ied_d, integer, intent(in)  jsd_d, integer, intent(in)  jed_d  )

private

Allocate and compute the 3d down sampled mask The masks are down sampled based on a minority rule, i.e., a coarse cell is open (1) if at least one of the sub-cells are open, otherwise it's closed (0)

Parameters

[in]	field_in	Original field to be down sampled
	field_out	down sampled field
[in]	dl	Level of down sampling
[in]	isc_o	Original i-start index
[in]	jsc_o	Original j-start index
[in]	isc_d	Computational i-start index of down sampled data
[in]	iec_d	Computational i-end index of down sampled data
[in]	jsc_d	Computational j-start index of down sampled data
[in]	jec_d	Computational j-end index of down sampled data
[in]	isd_d	Computational i-start index of down sampled data
[in]	ied_d	Computational i-end index of down sampled data
[in]	jsd_d	Computational j-start index of down sampled data
[in]	jed_d	Computational j-end index of down sampled data

Definition at line 4174 of file MOM_diag_mediator.F90.

  real, dimension(:,:,:), intent(in) :: field_in !< Original field to be down sampled
  real, dimension(:,:,:), pointer :: field_out   !< down sampled field
  integer, intent(in) :: dl    !< Level of down sampling
  integer, intent(in) :: isc_o !< Original i-start index
  integer, intent(in) :: jsc_o !< Original j-start index
  integer, intent(in) :: isc_d !< Computational i-start index of down sampled data
  integer, intent(in) :: iec_d !< Computational i-end index of down sampled data
  integer, intent(in) :: jsc_d !< Computational j-start index of down sampled data
  integer, intent(in) :: jec_d !< Computational j-end index of down sampled data
  integer, intent(in) :: isd_d !< Computational i-start index of down sampled data
  integer, intent(in) :: ied_d !< Computational i-end index of down sampled data
  integer, intent(in) :: jsd_d !< Computational j-start index of down sampled data
  integer, intent(in) :: jed_d !< Computational j-end index of down sampled data
  ! Locals
  integer :: i,j,ii,jj,i0,j0,k,ks,ke
  real    :: tot_non_zero
  ! down sampled mask = 0 unless the mask value of one of the down sampling cells is 1
  ks = lbound(field_in,3) ; ke = ubound(field_in,3)
  allocate(field_out(isd_d:ied_d,jsd_d:jed_d,ks:ke))
  field_out(:,:,:) = 0.0
  do k= ks,ke ; do j=jsc_d,jec_d ; do i=isc_d,iec_d
     i0 = isc_o+dl*(i-isc_d)
     j0 = jsc_o+dl*(j-jsc_d)
     tot_non_zero = 0.0
     do jj=j0,j0+dl-1 ; do ii=i0,i0+dl-1
        tot_non_zero = tot_non_zero + field_in(ii,jj,k)
     enddo;enddo
     if(tot_non_zero > 0.0) field_out(i,j,k)=1.0
  enddo; enddo; enddo

---

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

• /home/docs/checkouts/readthedocs.org/user_builds/mom6-doctesting/checkouts/brokenbreathe/src/framework/MOM_diag_mediator.F90