local_BT_cont_u_type Derived Type

type, public :: local_BT_cont_u_type

Per-u-face coefficient pack for the piecewise-cubic barotropic-continuity flux closure (find_uhbt four-branch transport function consumes these).


Inherited by

type~~local_bt_cont_u_type~~InheritedByGraph type~local_bt_cont_u_type local_BT_cont_u_type type~barotropic_workstate_t barotropic_workstate_t type~barotropic_workstate_t->type~local_bt_cont_u_type BTCL_u type~ocean_dyn_t ocean_dyn_t type~ocean_dyn_t->type~barotropic_workstate_t bt_work 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
real(kind=wp), public :: FA_u_E0 = 0.0_wp

Effective face area for near-zero u with u < 0 [m].
real(kind=wp), public :: FA_u_EE = 0.0_wp

Marginal face area in the saturated far-east-draw regime u < uBT_EE [m].
real(kind=wp), public :: FA_u_W0 = 0.0_wp

Effective face area for near-zero u with u > 0 [m].
real(kind=wp), public :: FA_u_WW = 0.0_wp

Marginal face area in the saturated far-west-draw regime u > uBT_WW [m].
real(kind=wp), public :: uBT_EE = 0.0_wp

Negative velocity threshold beyond which find_uhbt switches to the saturated linear branch [m/s]. Must be ≤ 0.
real(kind=wp), public :: uBT_WW = 0.0_wp

Positive velocity threshold beyond which find_uhbt switches to the saturated linear branch [m/s]. Must be ≥ 0.
real(kind=wp), public :: uh_EE = 0.0_wp

Mass transport at u = uBT_EE so the saturated branch matches the cubic [m²/s].
real(kind=wp), public :: uh_WW = 0.0_wp

Mass transport at u = uBT_WW so the saturated branch matches the cubic [m²/s].
real(kind=wp), public :: uh_crvE = 0.0_wp

Cubic correction in the near-zero negative branch providing C¹ continuity at uBT_EE [s²/m].
real(kind=wp), public :: uh_crvW = 0.0_wp

Cubic correction in the near-zero positive branch providing C¹ continuity at uBT_WW [s²/m].

Source Code

   type :: local_BT_cont_u_type
      !! Per-u-face coefficient pack for the piecewise-cubic
      !! barotropic-continuity flux closure (`find_uhbt` four-branch
      !! transport function consumes these).
      real(wp) :: FA_u_EE = 0.0_wp
         !! Marginal face area in the saturated far-east-draw
         !! regime `u < uBT_EE` [m].
      real(wp) :: FA_u_E0 = 0.0_wp
         !! Effective face area for near-zero u with u < 0 [m].
      real(wp) :: FA_u_W0 = 0.0_wp
         !! Effective face area for near-zero u with u > 0 [m].
      real(wp) :: FA_u_WW = 0.0_wp
         !! Marginal face area in the saturated far-west-draw
         !! regime `u > uBT_WW` [m].
      real(wp) :: uBT_WW = 0.0_wp
         !! Positive velocity threshold beyond which `find_uhbt`
         !! switches to the saturated linear branch [m/s].
         !! Must be ≥ 0.
      real(wp) :: uBT_EE = 0.0_wp
         !! Negative velocity threshold beyond which `find_uhbt`
         !! switches to the saturated linear branch [m/s].
         !! Must be ≤ 0.
      real(wp) :: uh_crvW = 0.0_wp
         !! Cubic correction in the near-zero positive branch
         !! providing C¹ continuity at `uBT_WW` [s²/m].
      real(wp) :: uh_crvE = 0.0_wp
         !! Cubic correction in the near-zero negative branch
         !! providing C¹ continuity at `uBT_EE` [s²/m].
      real(wp) :: uh_WW = 0.0_wp
         !! Mass transport at `u = uBT_WW` so the saturated
         !! branch matches the cubic [m²/s].
      real(wp) :: uh_EE = 0.0_wp
         !! Mass transport at `u = uBT_EE` so the saturated
         !! branch matches the cubic [m²/s].
   end type local_BT_cont_u_type