ocean_model_mod::ocean_model_data_get Interface Reference

Detailed Description

This interface extracts a named scalar field or array from the ocean surface or public type.

Definition at line 84 of file ocean_model_MOM.F90.

Private functions
subroutine	ocean_model_data1d_get (OS, Ocean, name, value)
	This subroutine extracts a named scalar field from the ocean surface or public type. More...
subroutine	ocean_model_data2d_get (OS, Ocean, name, array2D, isc, jsc)
	This subroutine extracts a named 2-D field from the ocean surface or public type. More...

Detailed Description

This interface extracts a named scalar field or array from the ocean surface or public type.

Definition at line 84 of file ocean_model_MOM.F90.

Functions and subroutines

ocean_model_data1d_get()

subroutine ocean_model_mod::ocean_model_data_get::ocean_model_data1d_get ( type(ocean_state_type), pointer  OS, type(ocean_public_type), intent(in)  Ocean, character(len=*), intent(in)  name, real, intent(out)  value  )

private

This subroutine extracts a named scalar field from the ocean surface or public type.

Parameters

	os	A pointer to the structure containing the internal ocean state (intent in).
[in]	ocean	A structure containing various publicly visible ocean surface fields.
[in]	name	The name of the field to extract
[out]	value	The value of the named field

Definition at line 1075 of file ocean_model_MOM.F90.

  type(ocean_state_type),     pointer    :: OS    !< A pointer to the structure containing the
                                                  !! internal ocean state (intent in).
  type(ocean_public_type),    intent(in) :: Ocean !< A structure containing various publicly
                                                  !! visible ocean surface fields.
  character(len=*)          , intent(in) :: name  !< The name of the field to extract
  real                      , intent(out):: value !< The value of the named field
 
  if (.not.associated(os)) return
  if (.not.os%is_ocean_pe) return
 
  select case(name)
  case('c_p')
    value = os%C_p
  case default
    call mom_error(fatal,'get_ocean_grid_data1D: unknown argument name='//name)
  end select
 

ocean_model_data2d_get()

subroutine ocean_model_mod::ocean_model_data_get::ocean_model_data2d_get ( type(ocean_state_type), pointer  OS, type(ocean_public_type), intent(in)  Ocean, character(len=*), intent(in)  name, real, dimension(isc:,jsc:), intent(out)  array2D, integer, intent(in)  isc, integer, intent(in)  jsc  )

private

This subroutine extracts a named 2-D field from the ocean surface or public type.

Parameters

	os	A pointer to the structure containing the internal ocean state (intent in).
[in]	ocean	A structure containing various publicly visible ocean surface fields.
[in]	name	The name of the field to extract
[out]	array2d	The values of the named field, it must cover only the computational domain
[in]	isc	The starting i-index of array2D
[in]	jsc	The starting j-index of array2D

Definition at line 1013 of file ocean_model_MOM.F90.

  use mom_constants, only : celsius_kelvin_offset
  type(ocean_state_type),     pointer    :: OS    !< A pointer to the structure containing the
                                                  !! internal ocean state (intent in).
  type(ocean_public_type),    intent(in) :: Ocean !< A structure containing various publicly
                                                  !! visible ocean surface fields.
  character(len=*)          , intent(in) :: name  !< The name of the field to extract
  real, dimension(isc:,jsc:), intent(out):: array2D !< The values of the named field, it must
                                                  !! cover only the computational domain
  integer                   , intent(in) :: isc   !< The starting i-index of array2D
  integer                   , intent(in) :: jsc   !< The starting j-index of array2D
 
  integer :: g_isc, g_iec, g_jsc, g_jec,g_isd, g_ied, g_jsd, g_jed, i, j
 
  if (.not.associated(os)) return
  if (.not.os%is_ocean_pe) return
 
! The problem is %areaT is on MOM domain but Ice_Ocean_Boundary%... is on mpp domain.
! We want to return the MOM data on the mpp (compute) domain
! Get MOM domain extents
  call mpp_get_compute_domain(os%grid%Domain%mpp_domain, g_isc, g_iec, g_jsc, g_jec)
  call mpp_get_data_domain   (os%grid%Domain%mpp_domain, g_isd, g_ied, g_jsd, g_jed)
 
  g_isc = g_isc-g_isd+1 ; g_iec = g_iec-g_isd+1 ; g_jsc = g_jsc-g_jsd+1 ; g_jec = g_jec-g_jsd+1
 
 
  select case(name)
  case('area')
     array2d(isc:,jsc:) = os%US%L_to_m**2*os%grid%areaT(g_isc:g_iec,g_jsc:g_jec)
  case('mask')
     array2d(isc:,jsc:) = os%grid%mask2dT(g_isc:g_iec,g_jsc:g_jec)
!OR same result
!     do j=g_jsc,g_jec ; do i=g_isc,g_iec
!        array2D(isc+i-g_isc,jsc+j-g_jsc) = OS%grid%mask2dT(i,j)
!     enddo ; enddo
  case('t_surf')
     array2d(isc:,jsc:) = ocean%t_surf(isc:,jsc:)-celsius_kelvin_offset
  case('t_pme')
     array2d(isc:,jsc:) = ocean%t_surf(isc:,jsc:)-celsius_kelvin_offset
  case('t_runoff')
     array2d(isc:,jsc:) = ocean%t_surf(isc:,jsc:)-celsius_kelvin_offset
  case('t_calving')
     array2d(isc:,jsc:) = ocean%t_surf(isc:,jsc:)-celsius_kelvin_offset
  case('btfHeat')
     array2d(isc:,jsc:) = 0
  case('cos_rot')
     array2d(isc:,jsc:) = os%grid%cos_rot(g_isc:g_iec,g_jsc:g_jec) ! =1
  case('sin_rot')
     array2d(isc:,jsc:) = os%grid%sin_rot(g_isc:g_iec,g_jsc:g_jec) ! =0
  case('s_surf')
     array2d(isc:,jsc:) = ocean%s_surf(isc:,jsc:)
  case('sea_lev')
     array2d(isc:,jsc:) = ocean%sea_lev(isc:,jsc:)
  case('frazil')
     array2d(isc:,jsc:) = ocean%frazil(isc:,jsc:)
  case default
     call mom_error(fatal,'get_ocean_grid_data2D: unknown argument name='//name)
  end select
 

---

The documentation for this interface was generated from the following file:

• /home/cermak/src/MOM6.devrob/config_src/coupled_driver/ocean_model_MOM.F90