Detailed Description

Store the reference profile at h points for a variable.

Definition at line 33 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, US, 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 arbitrary number of layers.
[in]	f_ptr	Pointer to the field to be damped

Definition at line 534 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 arbitrary 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,
		type(unit_scale_type), intent(in)	US,
		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]	us	A dimensional unit scaling type
[in]	f_ptr	Pointer to the field to be damped (in).
	cs	Sponge control structure (in/out).

Definition at line 571 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
   type(unit_scale_type),   intent(in)    :: US         !< A dimensional unit scaling type
   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 :: tmpT1d
   real :: zTopOfCell, zBottomOfCell ! Heights [Z ~> m].
   type(remapping_CS) :: remapCS ! Remapping parameters and work arrays
  
   if (.not.associated(cs)) return
   ! initialize time interpolator module
   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 time interp id for this field. If sponge data is ongrid, then setup
   ! to only read on the computational domain
   if (cs%spongeDataOngrid) then
     cs%Ref_val(cs%fldno)%id = init_external_field(filename, fieldname,domain=g%Domain%mpp_domain)
   else
     cs%Ref_val(cs%fldno)%id = init_external_field(filename, fieldname)
   endif
   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 !< individual sponge fields may reside on a different vertical grid
   cs%Ref_val(cs%fldno)%num_tlevs = fld_sz(4)
   ! initializes the target profile array for this field
   ! for all columns which will be masked
   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
   cs%var(cs%fldno)%p => f_ptr
  
  

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

/glade/work/altuntas/cesm.sandboxes/cesm2_2_alpha_X_mom/components/mom/MOM6/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()