register_gm Subroutine

private subroutine register_gm(cfg, schema)

&ocean_gm (Gent-McWilliams thickness diffusion, capability [2]).

Arguments

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

Calls

proc~~register_gm~~CallsGraph proc~register_gm register_gm proc~group_add nml_group_t%group_add proc~register_gm->proc~group_add proc~nml_logical nml_logical proc~register_gm->proc~nml_logical proc~nml_real nml_real proc~register_gm->proc~nml_real proc~schema_add_group nml_schema_t%schema_add_group proc~register_gm->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_gm~~CalledByGraph proc~register_gm register_gm proc~build_rdb_schema build_rdb_schema proc~build_rdb_schema->proc~register_gm 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
logical, private, pointer :: pl
real(kind=wp), private, pointer :: pr

Source Code

   subroutine register_gm(cfg, schema)
      !! `&ocean_gm` (Gent-McWilliams thickness diffusion, capability [2]).
      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

      g%name = "ocean_gm"
      g%doc = "Gent-McWilliams thickness diffusion (eddy bolus transport)."

      pl => cfg%ocean%gm%enable
      call g%add(nml_logical("enable", pl, &
                             "Master switch (requires &ocean_slopes_nml enable; default off ⇒ no-op)"))
      pr => cfg%ocean%gm%khth
      call g%add(nml_real("khth", pr, &
                          "Thickness diffusivity KhTh (constant-fill; production 1e2-1e3)", &
                          units="m^2/s"))
      pr => cfg%ocean%gm%khth_max_cfl
      call g%add(nml_real("khth_max_cfl", pr, &
                          "Fraction of the diffusive CFL the face KH may use", units="nondim"))
      pr => cfg%ocean%gm%khth_slope_max
      call g%add(nml_real("khth_slope_max", pr, &
                          "Slope magnitude above which the safe-streamfunction blend takes over", &
                          units="nondim"))

      call schema%add_group(g)
   end subroutine register_gm