ocean_bt_rem_from_visc_rem_on Function

public pure function ocean_bt_rem_from_visc_rem_on(cfg) result(on)

PR-3 (D1): is bt_rem built from av_rem (MOM6’s barotropic viscous-remnant depth mean) on, either directly (bt_rem_from_visc_rem) or via visc_rem_chain?

Arguments

Type IntentOptional Attributes Name
type(config_t), intent(in) :: cfg

Return Value logical


Called by

proc~~ocean_bt_rem_from_visc_rem_on~~CalledByGraph proc~ocean_bt_rem_from_visc_rem_on ocean_bt_rem_from_visc_rem_on proc~configure_ocean_bt configure_ocean_bt proc~configure_ocean_bt->proc~ocean_bt_rem_from_visc_rem_on proc~ocean_bt_visc_rem_producer_on ocean_bt_visc_rem_producer_on proc~configure_ocean_bt->proc~ocean_bt_visc_rem_producer_on proc~ocean_bt_visc_rem_producer_on->proc~ocean_bt_rem_from_visc_rem_on proc~validate_config validate_config proc~validate_config->proc~ocean_bt_rem_from_visc_rem_on proc~validate_config->proc~ocean_bt_visc_rem_producer_on proc~build_pending_handle build_pending_handle proc~build_pending_handle->proc~validate_config proc~engine_setup engine_setup proc~engine_setup->proc~configure_ocean_bt 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~rdb_ocean_create_from_string rdb_ocean_create_from_string proc~rdb_ocean_create_from_string->proc~build_pending_handle proc~rdb_ocean_create_from_string->proc~complete_ocean_create proc~rdb_ocean_create_pending rdb_ocean_create_pending proc~rdb_ocean_create_pending->proc~build_pending_handle 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

Source Code

   pure function ocean_bt_rem_from_visc_rem_on(cfg) result(on)
      !! PR-3 (D1): is `bt_rem` built from `av_rem` (MOM6's barotropic
      !! viscous-remnant depth mean) on, either directly
      !! (`bt_rem_from_visc_rem`) or via `visc_rem_chain`?
      type(config_t), intent(in) :: cfg
      logical :: on
      on = cfg%ocean%bt%visc_rem_chain .or. cfg%ocean%bt%bt_rem_from_visc_rem
   end function ocean_bt_rem_from_visc_rem_on