register_ocean_tides Subroutine

private subroutine register_ocean_tides(cfg, schema)

&ocean_tides (C1 equilibrium astronomical body-force tide).

Arguments

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

Calls

proc~~register_ocean_tides~~CallsGraph proc~register_ocean_tides register_ocean_tides proc~group_add nml_group_t%group_add proc~register_ocean_tides->proc~group_add proc~nml_logical nml_logical proc~register_ocean_tides->proc~nml_logical proc~nml_real nml_real proc~register_ocean_tides->proc~nml_real proc~nml_string nml_string proc~register_ocean_tides->proc~nml_string proc~schema_add_group nml_schema_t%schema_add_group proc~register_ocean_tides->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_tides~~CalledByGraph proc~register_ocean_tides register_ocean_tides proc~build_rdb_schema build_rdb_schema proc~build_rdb_schema->proc~register_ocean_tides 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
character(len=:), private, pointer :: ps

Source Code

   subroutine register_ocean_tides(cfg, schema)
      !! `&ocean_tides` (C1 equilibrium astronomical body-force tide).
      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
      character(len=:), pointer :: ps

      g%name = "ocean_tides"
      g%doc = "Equilibrium (astronomical) body-force tide (C1) + scalar SAL (C2)."

      pl => cfg%ocean%tides%enable
      call g%add(nml_logical("enable", pl, &
                             "Master switch (requires a non-cartesian grid)"))
      pl => cfg%ocean%tides%use_sal
      call g%add(nml_logical("use_sal", pl, &
                             "Apply scalar self-attraction & loading (C2)"))
      pr => cfg%ocean%tides%beta_sal
      call g%add(nml_real("beta_sal", pr, &
                          "Scalar SAL factor beta (~0.085-0.12)"))
      pl => cfg%ocean%tides%add_nodal
      call g%add(nml_logical("add_nodal", pl, &
                             "Apply the 18.6-yr nodal f/u corrections"))
      ps => cfg%ocean%tides%constituents
      call g%add(nml_string("constituents", ps, &
                            "Active constituent list (e.g. 'M2 S2 K1 O1')"))
      ps => cfg%ocean%tides%ref_date
      call g%add(nml_string("ref_date", ps, &
                            "Astronomical reference date YYYY-MM-DD"))
      ps => cfg%ocean%tides%nodal_ref_date
      call g%add(nml_string("nodal_ref_date", ps, &
                            "Nodal reference date ('' => ref_date)"))

      call schema%add_group(g)
   end subroutine register_ocean_tides