register_wavespeed Subroutine

private subroutine register_wavespeed(cfg, schema)

&ocean_wavespeed (B1 first-baroclinic wave speed + Rd).

Arguments

Type IntentOptional Attributes Name
type(config_t), intent(in), target :: cfg
type(nml_schema_t), intent(inout) :: schema

Calls

proc~~register_wavespeed~~CallsGraph proc~register_wavespeed register_wavespeed proc~group_add nml_group_t%group_add proc~register_wavespeed->proc~group_add proc~nml_int nml_int proc~register_wavespeed->proc~nml_int proc~nml_logical nml_logical proc~register_wavespeed->proc~nml_logical proc~nml_real nml_real proc~register_wavespeed->proc~nml_real proc~schema_add_group nml_schema_t%schema_add_group proc~register_wavespeed->proc~schema_add_group error error proc~group_add->error proc~lower lower proc~group_add->proc~lower proc~schema_add_group->error proc~schema_add_group->proc~lower proc~move_group move_group proc~schema_add_group->proc~move_group

Called by

proc~~register_wavespeed~~CalledByGraph proc~register_wavespeed register_wavespeed proc~build_rdb_schema build_rdb_schema proc~build_rdb_schema->proc~register_wavespeed proc~read_config_from_string_impl read_config_from_string_impl proc~read_config_from_string_impl->proc~build_rdb_schema proc~read_config_impl read_config_impl proc~read_config_impl->proc~build_rdb_schema proc~read_config read_config proc~read_config->proc~read_config_impl proc~read_config_from_string read_config_from_string proc~read_config_from_string->proc~read_config_from_string_impl proc~build_pending_handle build_pending_handle proc~build_pending_handle->proc~read_config_from_string proc~rdb_ocean_create_from_string rdb_ocean_create_from_string proc~rdb_ocean_create_from_string->proc~build_pending_handle proc~rdb_ocean_create_pending rdb_ocean_create_pending proc~rdb_ocean_create_pending->proc~build_pending_handle

Variables

Type Visibility Attributes Name Initial
type(nml_group_t), private :: g
integer, private, pointer :: pi
logical, private, pointer :: pl
real(kind=wp), private, pointer :: pr

Source Code

   subroutine register_wavespeed(cfg, schema)
      !! `&ocean_wavespeed` (B1 first-baroclinic wave speed + Rd).
      type(config_t), target, intent(in) :: cfg
      type(nml_schema_t), intent(inout) :: schema
      type(nml_group_t) :: g
      logical, pointer :: pl
      real(wp), pointer :: pr
      integer, pointer :: pi

      g%name = "ocean_wavespeed"
      g%doc = "First-baroclinic wave speed + Rossby deformation radius (diagnostic)."

      pl => cfg%ocean%wavespeed%enable
      call g%add(nml_logical("enable", pl, &
                             "Master switch (diagnostic; default off)"))
      pr => cfg%ocean%wavespeed%mono_n2
      call g%add(nml_real("mono_n2", pr, &
                          "DEFERRED N2-monotonising depth (EBT path); < 0 = off"))
      pl => cfg%ocean%wavespeed%use_ebt
      call g%add(nml_logical("use_ebt", pl, &
                             "DEFERRED equivalent-barotropic variant"))
      pi => cfg%ocean%wavespeed%n_wavespeed
      call g%add(nml_int("n_wavespeed", pi, "Recompute cadence (every N steps)", min=1))

      call schema%add_group(g)
   end subroutine register_wavespeed