parse_ocean_vcoord_type Function

public pure function parse_ocean_vcoord_type(name) result(code)

Ocean-path wrapper around the canonical parse_vcoord_type in rdb_vcoord. Pins the unrecognised-string fallback to VCOORD_EULERIAN_Z — the ocean path’s “do nothing” default, distinct from the coastal path’s VCOORD_SIGMA fallback. Kept as a thin name-preserving wrapper so the ocean-only semantic (fallback choice) is visible at the call site.

Arguments

Type IntentOptional Attributes Name
character(len=*), intent(in) :: name

Return Value integer


Calls

proc~~parse_ocean_vcoord_type~~CallsGraph proc~parse_ocean_vcoord_type parse_ocean_vcoord_type proc~parse_vcoord_type parse_vcoord_type proc~parse_ocean_vcoord_type->proc~parse_vcoord_type

Called by

proc~~parse_ocean_vcoord_type~~CalledByGraph proc~parse_ocean_vcoord_type parse_ocean_vcoord_type proc~configure_ocean_drag configure_ocean_drag proc~configure_ocean_drag->proc~parse_ocean_vcoord_type proc~configure_ocean_forcing configure_ocean_forcing proc~configure_ocean_forcing->proc~parse_ocean_vcoord_type proc~configure_ocean_lateral configure_ocean_lateral proc~configure_ocean_lateral->proc~parse_ocean_vcoord_type proc~configure_ocean_pgf configure_ocean_pgf proc~configure_ocean_pgf->proc~parse_ocean_vcoord_type proc~pgf_nonoverlap_gate_on pgf_nonoverlap_gate_on proc~configure_ocean_pgf->proc~pgf_nonoverlap_gate_on proc~engine_setup engine_setup proc~engine_setup->proc~parse_ocean_vcoord_type proc~engine_setup->proc~configure_ocean_drag proc~engine_setup->proc~configure_ocean_forcing proc~engine_setup->proc~configure_ocean_lateral proc~engine_setup->proc~configure_ocean_pgf proc~ocean_state_seed_from_cfg ocean_state_seed_from_cfg proc~engine_setup->proc~ocean_state_seed_from_cfg proc~ocean_state_init_from_config ocean_state_t%ocean_state_init_from_config proc~engine_setup->proc~ocean_state_init_from_config proc~ocean_state_seed_from_cfg->proc~parse_ocean_vcoord_type proc~pgf_nonoverlap_gate_on->proc~parse_ocean_vcoord_type proc~complete_ocean_create complete_ocean_create proc~complete_ocean_create->proc~engine_setup proc~driver_run_ocean driver_run_ocean proc~driver_run_ocean->proc~engine_setup proc~driver_validate driver_validate proc~driver_validate->proc~engine_setup proc~ocean_state_init_from_config->proc~pgf_nonoverlap_gate_on proc~driver_run driver_run proc~driver_run->proc~driver_run_ocean proc~rdb_ocean_create_finalize rdb_ocean_create_finalize proc~rdb_ocean_create_finalize->proc~complete_ocean_create proc~rdb_ocean_create_from_string rdb_ocean_create_from_string proc~rdb_ocean_create_from_string->proc~complete_ocean_create

Source Code

   pure function parse_ocean_vcoord_type(name) result(code)
      !! Ocean-path wrapper around the canonical `parse_vcoord_type`
      !! in `rdb_vcoord`.  Pins the unrecognised-string fallback to
      !! `VCOORD_EULERIAN_Z` — the ocean path's "do nothing" default,
      !! distinct from the coastal path's `VCOORD_SIGMA` fallback.
      !! Kept as a thin name-preserving wrapper so the ocean-only
      !! semantic (fallback choice) is visible at the call site.
      character(len=*), intent(in) :: name
      integer :: code
      code = parse_vcoord_type(name, default_code=VCOORD_EULERIAN_Z)
   end function parse_ocean_vcoord_type