Detailed Description

Store the reference profile at h points for a variable.

Definition at line 34 of file MOM_ALE_sponge.F90.

Private functions
subroutine	set_up_ale_sponge_field_fixed (sp_val, G, f_ptr, CS)
	This subroutine stores the reference profile at h points for the variable whose address is given by f_ptr. More...

subroutine	set_up_ale_sponge_field_varying (filename, fieldname, Time, G, GV, f_ptr, CS)
	This subroutine stores the reference profile at h points for the variable whose address is given by filename and fieldname. More...

Functions and subroutines

◆ set_up_ale_sponge_field_fixed()

subroutine mom_ale_sponge::set_up_ale_sponge_field::set_up_ale_sponge_field_fixed	(	real, dimension( g %isd: g %ied, g %jsd: g %jed,cs%nz_data), intent(in)	sp_val,
		type(ocean_grid_type), intent(in)	G,
		real, dimension( g %isd: g %ied, g %jsd: g %jed, g %ke), intent(in), target	f_ptr,
		type(ale_sponge_cs), pointer	CS
	)

private

This subroutine stores the reference profile at h points for the variable whose address is given by f_ptr.

Parameters

[in]	g	Grid structure
	cs	ALE sponge control structure (in/out).
[in]	sp_val	Field to be used in the sponge, it has arbritary number of layers.
[in]	f_ptr	Pointer to the field to be damped

Definition at line 554 of file MOM_ALE_sponge.F90.

   type(ocean_grid_type), intent(in) :: G  !< Grid structure
   type(ALE_sponge_CS),   pointer    :: CS !< ALE sponge control structure (in/out).
   real, dimension(SZI_(G),SZJ_(G),CS%nz_data), &
                          intent(in) :: sp_val !< Field to be used in the sponge, it has arbritary number of layers.
   real, dimension(SZI_(G),SZJ_(G),SZK_(G)), &
                  target, intent(in) :: f_ptr !< Pointer to the field to be damped
  
   integer :: j, k, col
   character(len=256) :: mesg ! String for error messages
  
   if (.not.associated(cs)) return
  
   cs%fldno = cs%fldno + 1
  
   if (cs%fldno > max_fields_) then
     write(mesg,'("Increase MAX_FIELDS_ to at least ",I3," in MOM_memory.h or decrease &
            &the number of fields to be damped in the call to &
            &initialize_sponge." )') cs%fldno
     call mom_error(fatal,"set_up_ALE_sponge_field: "//mesg)
   endif
  
   ! stores the reference profile
   allocate(cs%Ref_val(cs%fldno)%p(cs%nz_data,cs%num_col))
   cs%Ref_val(cs%fldno)%p(:,:) = 0.0
   do col=1,cs%num_col
     do k=1,cs%nz_data
       cs%Ref_val(cs%fldno)%p(k,col) = sp_val(cs%col_i(col),cs%col_j(col),k)
     enddo
   enddo
  
   cs%var(cs%fldno)%p => f_ptr
  

◆ set_up_ale_sponge_field_varying()

subroutine mom_ale_sponge::set_up_ale_sponge_field::set_up_ale_sponge_field_varying	(	character(len=*), intent(in)	filename,
		character(len=*), intent(in)	fieldname,
		type(time_type), intent(in)	Time,
		type(ocean_grid_type), intent(in)	G,
		type(verticalgrid_type), intent(in)	GV,
		real, dimension( g %isd: g %ied, g %jsd: g %jed, g %ke), intent(in), target	f_ptr,
		type(ale_sponge_cs), pointer	CS
	)

private

This subroutine stores the reference profile at h points for the variable whose address is given by filename and fieldname.

Parameters

[in]	filename	The name of the file with the time varying field data
[in]	fieldname	The name of the field in the file with the time varying field data
[in]	time	The current model time
[in]	g	Grid structure (in).
[in]	gv	ocean vertical grid structure
[in]	f_ptr	Pointer to the field to be damped (in).
	cs	Sponge control structure (in/out).

Definition at line 591 of file MOM_ALE_sponge.F90.

   character(len=*),        intent(in) :: filename !< The name of the file with the
                                                   !! time varying field data
   character(len=*),        intent(in) :: fieldname !< The name of the field in the file
                                                   !! with the time varying field data
   type(time_type),         intent(in) :: Time  !< The current model time
   type(ocean_grid_type),   intent(in) :: G     !< Grid structure (in).
   type(verticalGrid_type), intent(in) :: GV    !< ocean vertical grid structure
   real, dimension(SZI_(G),SZJ_(G),SZK_(G)), &
                    target, intent(in) :: f_ptr !< Pointer to the field to be damped (in).
   type(ALE_sponge_CS),     pointer    :: CS    !< Sponge control structure (in/out).
  
   ! Local variables
   real, allocatable, dimension(:,:,:) :: sp_val !< Field to be used in the sponge
   real, allocatable, dimension(:,:,:) :: mask_z !< Field mask for the sponge data
   real, allocatable, dimension(:), target :: z_in, z_edges_in ! Heights [Z ~> m].
   real :: missing_value
   integer :: j, k, col
   integer :: isd,ied,jsd,jed
   integer :: nPoints
   integer, dimension(4) :: fld_sz
   integer :: nz_data !< the number of vertical levels in this input field
   character(len=256) :: mesg ! String for error messages
  
   ! Local variables for ALE remapping
   real, dimension(:), allocatable :: hsrc ! Source thicknesses [Z ~> m].
   real, dimension(:), allocatable :: tmpT1d
   real :: zTopOfCell, zBottomOfCell ! Heights [Z ~> m].
   type(remapping_CS) :: remapCS ! Remapping parameters and work arrays
  
   if (.not.associated(cs)) return
  
   ! Call this in case it was not previously done.
   call time_interp_external_init()
  
   isd = g%isd; ied = g%ied; jsd = g%jsd; jed = g%jed
   cs%fldno = cs%fldno + 1
  
    if (cs%fldno > max_fields_) then
     write(mesg,'("Increase MAX_FIELDS_ to at least ",I3," in MOM_memory.h or decrease &
            &the number of fields to be damped in the call to &
            &initialize_sponge." )') cs%fldno
     call mom_error(fatal,"set_up_ALE_sponge_field: "//mesg)
   endif
  
   ! get a unique id for this field which will allow us to return an array
   ! containing time-interpolated values from an external file corresponding
   ! to the current model date.
  
   cs%Ref_val(cs%fldno)%id = init_external_field(filename, fieldname)
   fld_sz(1:4)=-1
   fld_sz = get_external_field_size(cs%Ref_val(cs%fldno)%id)
   nz_data = fld_sz(3)
   cs%Ref_val(cs%fldno)%nz_data = nz_data !< each individual sponge field is assumed to reside on a different grid
   cs%Ref_val(cs%fldno)%num_tlevs = fld_sz(4)
  
   allocate( sp_val(isd:ied,jsd:jed, nz_data) )
   allocate( mask_z(isd:ied,jsd:jed, nz_data) )
  
   ! initializes the current reference profile array
   allocate(cs%Ref_val(cs%fldno)%p(nz_data,cs%num_col))
   cs%Ref_val(cs%fldno)%p(:,:) = 0.0
   allocate( cs%Ref_val(cs%fldno)%h(nz_data,cs%num_col) )
   cs%Ref_val(cs%fldno)%h(:,:) = 0.0
  
   ! Interpolate external file data to the model grid
   ! I am hard-wiring this call to assume that the input grid is zonally re-entrant
   ! In the future, this should be generalized using an interface to return the
   ! modulo attribute of the zonal axis (mjh).
  
  ! call horiz_interp_and_extrap_tracer(CS%Ref_val(CS%fldno)%id,Time, 1.0,G,sp_val,mask_z,z_in,z_edges_in, &
  !                                     missing_value, .true., .false., .false., m_to_Z=US%m_to_Z)
  
 ! Do not think halo updates are needed (mjh)
 !  call pass_var(sp_val,G%Domain)
 !  call pass_var(mask_z,G%Domain)
  
 ! Done with horizontal interpolation.
 ! Now remap to model coordinates
 ! First we reserve a work space for reconstructions of the source data
   allocate( hsrc(nz_data) )
   allocate( tmpt1d(nz_data) )
  
   do col=1,cs%num_col
     ! Build the source grid
     ztopofcell = 0. ; zbottomofcell = 0. ; npoints = 0; hsrc(:) = 0.0; tmpt1d(:) = -99.9
     do k=1,nz_data
       if (mask_z(cs%col_i(col),cs%col_j(col),k) == 1.0) then
         zbottomofcell = -min( z_edges_in(k+1), g%bathyT(cs%col_i(col),cs%col_j(col)) )
 !        tmpT1d(k) = sp_val(CS%col_i(col),CS%col_j(col),k)
       elseif (k>1) then
         zbottomofcell = -g%bathyT(cs%col_i(col),cs%col_j(col))
 !        tmpT1d(k) = tmpT1d(k-1)
 !      else ! This next block should only ever be reached over land
 !        tmpT1d(k) = -99.9
       endif
       hsrc(k) = ztopofcell - zbottomofcell
       if (hsrc(k)>0.) npoints = npoints + 1
       ztopofcell = zbottomofcell ! Bottom becomes top for next value of k
     enddo
     ! In case data is deeper than model
     hsrc(nz_data) = hsrc(nz_data) + ( ztopofcell + g%bathyT(cs%col_i(col),cs%col_j(col)) )
     cs%Ref_val(cs%fldno)%h(1:nz_data,col) = 0.
     cs%Ref_val(cs%fldno)%p(1:nz_data,col) = -1.e24
     cs%Ref_val(cs%fldno)%h(1:nz_data,col) = gv%Z_to_H*hsrc(1:nz_data)
 !    CS%Ref_val(CS%fldno)%p(1:nz_data,col) = tmpT1d(1:nz_data)
   enddo
  
   cs%var(cs%fldno)%p => f_ptr
  
   deallocate( hsrc )
   deallocate( tmpt1d )
   deallocate(sp_val, mask_z)
  

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

/home/docs/checkouts/readthedocs.org/user_builds/mom6-doctesting/checkouts/brokenbreathe/src/parameterizations/vertical/MOM_ALE_sponge.F90

Detailed Description

Private functions

Functions and subroutines

◆ set_up_ale_sponge_field_fixed()

◆ set_up_ale_sponge_field_varying()