mom_diag_mediator::downsample_diag_field Interface Reference

Detailed Description

Down sample a diagnostic field.

Definition at line 85 of file MOM_diag_mediator.F90.

Private functions
subroutine	downsample_diag_field_2d (locfield, locfield_dsamp, dl, diag_cs, diag, isv, iev, jsv, jev, mask)
	This subroutine allocates and computes a downsampled array from an input array It also determines the diagnostics-compurte indices for the downsampled array 2d interface. More...
subroutine	downsample_diag_field_3d (locfield, locfield_dsamp, dl, diag_cs, diag, isv, iev, jsv, jev, mask)
	This subroutine allocates and computes a downsampled array from an input array It also determines the diagnostics-compurte indices for the downsampled array 3d interface. More...

Functions and subroutines

downsample_diag_field_2d()

subroutine mom_diag_mediator::downsample_diag_field::downsample_diag_field_2d ( real, dimension(:,:), pointer  locfield, real, dimension(:,:), intent(inout), allocatable  locfield_dsamp, integer, intent(in)  dl, type(diag_ctrl), intent(in)  diag_cs, type(diag_type), intent(in)  diag, integer, intent(inout)  isv, integer, intent(inout)  iev, integer, intent(inout)  jsv, integer, intent(inout)  jev, real, dimension(:,:), intent(in), optional, target  mask  )

private

This subroutine allocates and computes a downsampled array from an input array It also determines the diagnostics-compurte indices for the downsampled array 2d interface.

Parameters

	locfield	Input array pointer
[in,out]	locfield_dsamp	Output (downsampled) array
[in]	diag_cs	Structure used to regulate diagnostic output
[in]	diag	A structure describing the diagnostic to post
[in]	dl	Level of down sampling
[in,out]	isv	i-start index for diagnostics
[in,out]	iev	i-end index for diagnostics
[in,out]	jsv	j-start index for diagnostics
[in,out]	jev	j-end index for diagnostics
[in]	mask	If present, use this real array as the data mask.

Definition at line 3752 of file MOM_diag_mediator.F90.

  real, dimension(:,:), pointer :: locfield !< Input array pointer
  real, dimension(:,:), allocatable, intent(inout) :: locfield_dsamp !< Output (downsampled) array
  type(diag_ctrl),   intent(in) :: diag_CS !< Structure used to regulate diagnostic output
  type(diag_type),   intent(in) :: diag    !< A structure describing the diagnostic to post
  integer, intent(in) :: dl                !< Level of down sampling
  integer, intent(inout) :: isv            !< i-start index for diagnostics
  integer, intent(inout) :: iev            !< i-end index for diagnostics
  integer, intent(inout) :: jsv            !< j-start index for diagnostics
  integer, intent(inout) :: jev            !< j-end index for diagnostics
  real,    optional,target, intent(in) :: mask(:,:) !< If present, use this real array as the data mask.
  ! Locals
  real, dimension(:,:), pointer :: locmask
  integer :: f1,f2,isv_o,jsv_o
 
  locmask => null()
  !Get the correct indices corresponding to input field
  !Shape of the input diag field
  f1=size(locfield,1)
  f2=size(locfield,2)
  !Save the extents of the original (fine) domain
  isv_o=isv;jsv_o=jsv
  !Get the shape of the downsampled field and overwrite isv,iev,jsv,jev with them
  call downsample_diag_indices_get(f1,f2, dl, diag_cs,isv,iev,jsv,jev)
  !Set the non-downsampled mask, it must be associated and initialized
  if (present(mask)) then
     locmask => mask
  elseif (associated(diag%axes%mask2d)) then
     locmask => diag%axes%mask2d
  else
     call mom_error(fatal, "downsample_diag_field_2d: Cannot downsample without a mask!!! ")
  endif
 
  call downsample_field(locfield, locfield_dsamp, dl, diag%xyz_method, locmask, diag_cs,diag, &
                      isv_o,jsv_o,isv,iev,jsv,jev)
 

downsample_diag_field_3d()

subroutine mom_diag_mediator::downsample_diag_field::downsample_diag_field_3d ( real, dimension(:,:,:), pointer  locfield, real, dimension(:,:,:), intent(inout), allocatable  locfield_dsamp, integer, intent(in)  dl, type(diag_ctrl), intent(in)  diag_cs, type(diag_type), intent(in)  diag, integer, intent(inout)  isv, integer, intent(inout)  iev, integer, intent(inout)  jsv, integer, intent(inout)  jev, real, dimension(:,:,:), intent(in), optional, target  mask  )

private

This subroutine allocates and computes a downsampled array from an input array It also determines the diagnostics-compurte indices for the downsampled array 3d interface.

Parameters

	locfield	Input array pointer
[in,out]	locfield_dsamp	Output (downsampled) array
[in]	diag_cs	Structure used to regulate diagnostic output
[in]	diag	A structure describing the diagnostic to post
[in]	dl	Level of down sampling
[in,out]	isv	i-start index for diagnostics
[in,out]	iev	i-end index for diagnostics
[in,out]	jsv	j-start index for diagnostics
[in,out]	jev	j-end index for diagnostics
[in]	mask	If present, use this real array as the data mask.

Definition at line 3711 of file MOM_diag_mediator.F90.

  real, dimension(:,:,:), pointer :: locfield  !< Input array pointer
  real, dimension(:,:,:), allocatable, intent(inout) :: locfield_dsamp !< Output (downsampled) array
  type(diag_ctrl),   intent(in) :: diag_CS !< Structure used to regulate diagnostic output
  type(diag_type),   intent(in) :: diag    !< A structure describing the diagnostic to post
  integer, intent(in) :: dl                !< Level of down sampling
  integer, intent(inout) :: isv            !< i-start index for diagnostics
  integer, intent(inout) :: iev            !< i-end index for diagnostics
  integer, intent(inout) :: jsv            !< j-start index for diagnostics
  integer, intent(inout) :: jev            !< j-end index for diagnostics
  real,    optional,target, intent(in) :: mask(:,:,:) !< If present, use this real array as the data mask.
  ! Locals
  real, dimension(:,:,:), pointer :: locmask
  integer :: f1,f2,isv_o,jsv_o
 
  locmask => null()
  !Get the correct indices corresponding to input field
  !Shape of the input diag field
  f1=size(locfield,1)
  f2=size(locfield,2)
  !Save the extents of the original (fine) domain
  isv_o=isv;jsv_o=jsv
  !Get the shape of the downsampled field and overwrite isv,iev,jsv,jev with them
  call downsample_diag_indices_get(f1,f2, dl, diag_cs,isv,iev,jsv,jev)
  !Set the non-downsampled mask, it must be associated and initialized
  if (present(mask)) then
     locmask => mask
  elseif (associated(diag%axes%mask3d)) then
     locmask => diag%axes%mask3d
  else
     call mom_error(fatal, "downsample_diag_field_3d: Cannot downsample without a mask!!! ")
  endif
 
  call downsample_field(locfield, locfield_dsamp, dl, diag%xyz_method, locmask, diag_cs, diag, &
                      isv_o,jsv_o,isv,iev,jsv,jev)
 

---

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