diag_vgrid_from_name Function

public pure function diag_vgrid_from_name(name) result(vgrid)

Map the &ocean_diag_nml vgrid string to a DIAG_VGRID_* tag. Unrecognised (schema-validated upstream) falls back to LAYER. Moved from rdb_driver (P2.4) so engine_configure_diag can use it without a driver dependency; re-exported by rdb_driver for any existing caller of that name.

Arguments

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

Return Value integer


Called by

proc~~diag_vgrid_from_name~~CalledByGraph proc~diag_vgrid_from_name diag_vgrid_from_name proc~engine_configure_diag engine_configure_diag proc~engine_configure_diag->proc~diag_vgrid_from_name proc~engine_setup engine_setup proc~engine_setup->proc~engine_configure_diag 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~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 diag_vgrid_from_name(name) result(vgrid)
      !! Map the `&ocean_diag_nml vgrid` string to a `DIAG_VGRID_*` tag.
      !! Unrecognised (schema-validated upstream) falls back to LAYER.
      !! Moved from `rdb_driver` (P2.4) so `engine_configure_diag` can
      !! use it without a driver dependency; re-exported by
      !! `rdb_driver` for any existing caller of that name.
      character(len=*), intent(in) :: name
      integer :: vgrid
      select case (trim(name))
      case ("z_fixed")
         vgrid = DIAG_VGRID_Z_FIXED
      case ("sigma")
         vgrid = DIAG_VGRID_SIGMA
      case ("zstar")
         vgrid = DIAG_VGRID_ZSTAR
      case ("density")
         vgrid = DIAG_VGRID_DENSITY
      case default
         vgrid = DIAG_VGRID_LAYER
      end select
   end function diag_vgrid_from_name