register_ocean_wetdry Subroutine

private subroutine register_ocean_wetdry(cfg, schema)

&ocean_wetdry_nml: dynamic wetting/drying for the BT substep. Design + validation numbers: docs/ocean_wetdry_plan.md.

Arguments

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

Calls

proc~~register_ocean_wetdry~~CallsGraph proc~register_ocean_wetdry register_ocean_wetdry proc~group_add nml_group_t%group_add proc~register_ocean_wetdry->proc~group_add proc~nml_logical nml_logical proc~register_ocean_wetdry->proc~nml_logical proc~nml_real nml_real proc~register_ocean_wetdry->proc~nml_real proc~schema_add_group nml_schema_t%schema_add_group proc~register_ocean_wetdry->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_ocean_wetdry~~CalledByGraph proc~register_ocean_wetdry register_ocean_wetdry proc~build_rdb_schema build_rdb_schema proc~build_rdb_schema->proc~register_ocean_wetdry 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_ocean_wetdry(cfg, schema)
      !! `&ocean_wetdry_nml`: dynamic wetting/drying for the BT substep.
      !! Design + validation numbers: docs/ocean_wetdry_plan.md.
      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_wetdry"
      g%doc = "Dynamic wetting/drying for the split-explicit barotropic substep."
      pl => cfg%ocean%wetdry%enable
      call g%add(nml_logical("enable", pl, &
                             "Dynamic wet/dry: upwind BT face thickness + positive-definite "// &
                             "outflow limiter + bed-blocking momentum gate"))
      pr => cfg%ocean%wetdry%dry_depth
      call g%add(nml_real("dry_depth", pr, &
                          "Total-depth dry threshold", units="m", min=0.0_wp))
      pr => cfg%ocean%wetdry%rewet_depth
      call g%add(nml_real("rewet_depth", pr, &
                          "Hysteresis re-wet threshold (must exceed dry_depth)", &
                          units="m", min=0.0_wp))
      pr => cfg%ocean%wetdry%land_margin
      call g%add(nml_real("land_margin", pr, &
                          "Static-land headroom above rest MSL (intertidal cutoff)", &
                          units="m", min=0.0_wp))
      call schema%add_group(g)
   end subroutine register_ocean_wetdry