ke_probe_t Derived Type

type, public :: ke_probe_t

Config + running state for the KE attribution meter. Lives on ocean_dyn_t; host-only (never device-mapped).


Inherited by

type~~ke_probe_t~~InheritedByGraph type~ke_probe_t ke_probe_t type~ocean_dyn_t ocean_dyn_t type~ocean_dyn_t->type~ke_probe_t ke_probe type~ocean_state_t ocean_state_t type~ocean_state_t->type~ocean_dyn_t dyn type~ocean_engine_t ocean_engine_t type~ocean_engine_t->type~ocean_state_t state type~ocean_handle_t ocean_handle_t type~ocean_handle_t->type~ocean_state_t state type~ocean_handle_t->type~ocean_engine_t engine

Components

Type Visibility Attributes Name Initial
integer, public :: east_band = 16

East-wall band width in cells (the Kelvin-wave region; 16 covers the ~6-cell internal-radius wall trapping).
logical, public :: enable = .false.

Master gate — &ocean_bt_nml debug_ke_attr.
integer, public :: end_step = 0

Last outer step to sample (0 = no upper bound).
logical, public :: have_prev = .false.

.true. once a sample has landed; first row prints dKE = KE.
logical, public :: header_done = .false.

Column-header row emitted.
real(kind=wp), public :: prev_east = 0.0_wp

KE at the previous sample, per region.
real(kind=wp), public :: prev_full = 0.0_wp
real(kind=wp), public :: prev_rim = 0.0_wp
integer, public :: rim_band = 8

Rim-region width in cells (distance from any physical wall).
integer, public :: start_step = 0

First outer step to sample (0 = from the start).

Source Code

   type :: ke_probe_t
      !! Config + running state for the KE attribution meter.  Lives on
      !! `ocean_dyn_t`; host-only (never device-mapped).
      logical :: enable = .false.
         !! Master gate — `&ocean_bt_nml debug_ke_attr`.
      integer :: start_step = 0
         !! First outer step to sample (0 = from the start).
      integer :: end_step = 0
         !! Last outer step to sample (0 = no upper bound).
      integer :: rim_band = 8
         !! Rim-region width in cells (distance from any physical wall).
      integer :: east_band = 16
         !! East-wall band width in cells (the Kelvin-wave region; 16
         !! covers the ~6-cell internal-radius wall trapping).
      logical :: have_prev = .false.
         !! .true. once a sample has landed; first row prints dKE = KE.
      logical :: header_done = .false.
         !! Column-header row emitted.
      real(wp) :: prev_full = 0.0_wp
      real(wp) :: prev_rim = 0.0_wp
      real(wp) :: prev_east = 0.0_wp
         !! KE at the previous sample, per region.
   end type ke_probe_t