register_ocean_psurf Subroutine

private subroutine register_ocean_psurf(cfg, schema)

&ocean_psurf (PR-17 atmospheric surface-pressure loading / inverse barometer).

Arguments

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

Calls

proc~~register_ocean_psurf~~CallsGraph proc~register_ocean_psurf register_ocean_psurf proc~group_add nml_group_t%group_add proc~register_ocean_psurf->proc~group_add proc~nml_logical nml_logical proc~register_ocean_psurf->proc~nml_logical proc~nml_real nml_real proc~register_ocean_psurf->proc~nml_real proc~schema_add_group nml_schema_t%schema_add_group proc~register_ocean_psurf->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_psurf~~CalledByGraph proc~register_ocean_psurf register_ocean_psurf proc~build_rdb_schema build_rdb_schema proc~build_rdb_schema->proc~register_ocean_psurf 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_psurf(cfg, schema)
      !! `&ocean_psurf` (PR-17 atmospheric surface-pressure loading /
      !! inverse barometer).
      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_psurf"
      g%doc = "Atmospheric surface-pressure loading / inverse barometer (PR-17)."

      pl => cfg%ocean%psurf%enable
      call g%add(nml_logical("enable", pl, &
                             "Master switch (split-solver only; requires "// &
                             "&ocean_forcing_nml enable_components=.true.)"))
      pl => cfg%ocean%psurf%in_eos
      call g%add(nml_logical("in_eos", pl, &
                             "Also feed the surface load to the equation of "// &
                             "state as the top-of-column pressure p_top "// &
                             "(requires enable=.true.; refused with the "// &
                             "unported pressure builders)"))
      pr => cfg%ocean%psurf%p_surf_const
      call g%add(nml_real("p_surf_const", pr, &
                          "Uniform atmospheric surface pressure (Pa) seeded "// &
                          "into p_surf_atm (uniform => provably inert)"))

      call schema%add_group(g)
   end subroutine register_ocean_psurf