register_conv Subroutine

private subroutine register_conv(cfg, schema)

&ocean_conv (Brunt-Vaisala-triggered convective adjustment, CVMix_conv-style).

Arguments

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

Calls

proc~~register_conv~~CallsGraph proc~register_conv register_conv proc~group_add nml_group_t%group_add proc~register_conv->proc~group_add proc~nml_logical nml_logical proc~register_conv->proc~nml_logical proc~nml_real nml_real proc~register_conv->proc~nml_real proc~schema_add_group nml_schema_t%schema_add_group proc~register_conv->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_conv~~CalledByGraph proc~register_conv register_conv proc~build_rdb_schema build_rdb_schema proc~build_rdb_schema->proc~register_conv 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_conv(cfg, schema)
      !! `&ocean_conv` (Brunt-Vaisala-triggered convective adjustment,
      !! CVMix_conv-style).
      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_conv"
      g%doc = "Brunt-Vaisala-triggered convective adjustment (interior closure contributor)."

      pl => cfg%ocean%conv%enable
      call g%add(nml_logical("enable", pl, &
                             "Master switch (requires use_closure + thermodynamics)"))
      pr => cfg%ocean%conv%kd_conv
      call g%add(nml_real("kd_conv", pr, "Convective tracer diffusivity (KD_CONV)", &
                          units="m^2/s"))
      pr => cfg%ocean%conv%prandtl_conv
      call g%add(nml_real("prandtl_conv", pr, "Kv_conv = prandtl_conv * kd_conv"))
      pr => cfg%ocean%conv%n2_thresh
      call g%add(nml_real("n2_thresh", pr, "Trigger threshold on N^2 (BV_SQR_CONV)", &
                          units="s^-2"))

      call schema%add_group(g)
   end subroutine register_conv