register_ocean_hdiff Subroutine

private subroutine register_ocean_hdiff(cfg, schema)

&ocean_hdiff_nml: along-coordinate tracer Laplacian (rdb_ocean_hdiff_tracer). Not the neutral/isopycnal path — that is &ocean_redi_nml, already reachable.

Arguments

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

Calls

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

Source Code

   subroutine register_ocean_hdiff(cfg, schema)
      !! `&ocean_hdiff_nml`: along-coordinate tracer Laplacian
      !! (`rdb_ocean_hdiff_tracer`).  Not the neutral/isopycnal path —
      !! that is `&ocean_redi_nml`, already reachable.
      type(config_t), target, intent(in) :: cfg
      type(nml_schema_t), intent(inout) :: schema
      type(nml_group_t) :: g
      real(wp), pointer :: pr

      g%name = "ocean_hdiff"
      g%doc = "Along-coordinate (not neutral) constant-coefficient tracer diffusion."
      pr => cfg%ocean%hdiff%kappa_h
      call g%add(nml_real("kappa_h", pr, &
                          "Horizontal tracer diffusivity, along the model coordinate "// &
                          "(0 disables; ocean path only — coastal's equivalent knob is "// &
                          "top-level hdiff_kappa)", &
                          units="m^2/s", min=0.0_wp))
      call schema%add_group(g)
   end subroutine register_ocean_hdiff