Detailed Description

Ddetermine the number of points which are within sponges in this computational domain.

Only points that have positive values of Iresttime and which mask2dT indicates are ocean points are included in the sponges. It also stores the target interface heights.

Definition at line 49 of file MOM_ALE_sponge.F90.

Private functions
subroutine	initialize_ale_sponge_fixed (Iresttime, G, param_file, CS, data_h, nz_data)
	This subroutine determines the number of points which are within sponges in this computational domain. Only points that have positive values of Iresttime and which mask2dT indicates are ocean points are included in the sponges. It also stores the target interface heights. More...

subroutine	initialize_ale_sponge_varying (Iresttime, G, param_file, CS)
	This subroutine determines the number of points which are within sponges in this computational domain. Only points that have positive values of Iresttime and which mask2dT indicates are ocean points are included in the sponges. More...

Functions and subroutines

◆ initialize_ale_sponge_fixed()

subroutine mom_ale_sponge::initialize_ale_sponge::initialize_ale_sponge_fixed	(	real, dimension(szi_(g),szj_(g)), intent(in)	Iresttime,
		type(ocean_grid_type), intent(in)	G,
		type(param_file_type), intent(in)	param_file,
		type(ale_sponge_cs), pointer	CS,
		real, dimension(szi_(g),szj_(g),nz_data), intent(in)	data_h,
		integer, intent(in)	nz_data
	)

private

This subroutine determines the number of points which are within sponges in this computational domain. Only points that have positive values of Iresttime and which mask2dT indicates are ocean points are included in the sponges. It also stores the target interface heights.

Parameters

[in]	g	The ocean's grid structure.
[in]	nz_data	The total number of sponge input layers.
[in]	iresttime	The inverse of the restoring time [s-1].
[in]	param_file	A structure indicating the open file to parse for model parameter values.
	cs	A pointer that is set to point to the control structure for this module (in/out).
[in]	data_h	The thicknesses of the sponge input layers [H ~> m or kg m-2].

Definition at line 141 of file MOM_ALE_sponge.F90.

  
   type(ocean_grid_type),            intent(in) :: G !< The ocean's grid structure.
   integer,                          intent(in) :: nz_data !< The total number of sponge input layers.
   real, dimension(SZI_(G),SZJ_(G)), intent(in) :: Iresttime !< The inverse of the restoring time [s-1].
   type(param_file_type),            intent(in) :: param_file !< A structure indicating the open file
                                                              !! to parse for model parameter values.
   type(ALE_sponge_CS),              pointer    :: CS !< A pointer that is set to point to the control
                                                      !! structure for this module (in/out).
   real, dimension(SZI_(G),SZJ_(G),nz_data), intent(in) :: data_h !< The thicknesses of the sponge
                                                      !! input layers [H ~> m or kg m-2].
  
  
 ! This include declares and sets the variable "version".
 #include "version_variable.h"
   character(len=40)  :: mdl = "MOM_sponge"  ! This module's name.
   logical :: use_sponge
   real, allocatable, dimension(:,:,:) :: data_hu !< thickness at u points [H ~> m or kg m-2]
   real, allocatable, dimension(:,:,:) :: data_hv !< thickness at v points [H ~> m or kg m-2]
   real, allocatable, dimension(:,:) :: Iresttime_u !< inverse of the restoring time at u points [s-1]
   real, allocatable, dimension(:,:) :: Iresttime_v !< inverse of the restoring time at v points [s-1]
   logical :: bndExtrapolation = .true. ! If true, extrapolate boundaries
   integer :: i, j, k, col, total_sponge_cols, total_sponge_cols_u, total_sponge_cols_v
   character(len=10)  :: remapScheme
   if (associated(cs)) then
     call mom_error(warning, "initialize_sponge called with an associated "// &
                             "control structure.")
     return
   endif
  
 ! Set default, read and log parameters
   call log_version(param_file, mdl, version, "")
   call get_param(param_file, mdl, "SPONGE", use_sponge, &
                  "If true, sponges may be applied anywhere in the domain. "//&
                  "The exact location and properties of those sponges are "//&
                  "specified from MOM_initialization.F90.", default=.false.)
  
   if (.not.use_sponge) return
  
   allocate(cs)
  
   call get_param(param_file, mdl, "SPONGE_UV", cs%sponge_uv, &
                  "Apply sponges in u and v, in addition to tracers.", &
                  default=.false.)
  
   call get_param(param_file, mdl, "REMAPPING_SCHEME", remapscheme, &
                  "This sets the reconstruction scheme used "//&
                  " for vertical remapping for all variables.", &
                  default="PLM", do_not_log=.true.)
  
   call get_param(param_file, mdl, "BOUNDARY_EXTRAPOLATION", bndextrapolation, &
                  "When defined, a proper high-order reconstruction "//&
                  "scheme is used within boundary cells rather "//&
                  "than PCM. E.g., if PPM is used for remapping, a "//&
                  "PPM reconstruction will also be used within boundary cells.", &
                  default=.false., do_not_log=.true.)
  
   cs%new_sponges = .false.
   cs%nz = g%ke
   cs%isc = g%isc ; cs%iec = g%iec ; cs%jsc = g%jsc ; cs%jec = g%jec
   cs%isd = g%isd ; cs%ied = g%ied ; cs%jsd = g%jsd ; cs%jed = g%jed
   cs%iscB = g%iscB ; cs%iecB = g%iecB; cs%jscB = g%jscB ; cs%jecB = g%jecB
  
   ! number of columns to be restored
   cs%num_col = 0 ; cs%fldno = 0
   do j=g%jsc,g%jec ; do i=g%isc,g%iec
     if ((iresttime(i,j)>0.0) .and. (g%mask2dT(i,j)>0)) &
       cs%num_col = cs%num_col + 1
   enddo ; enddo
  
   if (cs%num_col > 0) then
     allocate(cs%Iresttime_col(cs%num_col)) ; cs%Iresttime_col = 0.0
     allocate(cs%col_i(cs%num_col))         ; cs%col_i = 0
     allocate(cs%col_j(cs%num_col))         ; cs%col_j = 0
     ! pass indices, restoring time to the CS structure
     col = 1
     do j=g%jsc,g%jec ; do i=g%isc,g%iec
       if ((iresttime(i,j)>0.0) .and. (g%mask2dT(i,j)>0)) then
         cs%col_i(col) = i ; cs%col_j(col) = j
         cs%Iresttime_col(col) = iresttime(i,j)
         col = col +1
       endif
     enddo ; enddo
     ! same for total number of arbritary layers and correspondent data
     cs%nz_data = nz_data
     allocate(cs%Ref_h%p(cs%nz_data,cs%num_col))
     do col=1,cs%num_col ; do k=1,cs%nz_data
       cs%Ref_h%p(k,col) = data_h(cs%col_i(col),cs%col_j(col),k)
     enddo ; enddo
   endif
  
   total_sponge_cols = cs%num_col
   call sum_across_pes(total_sponge_cols)
  
 ! Call the constructor for remapping control structure
   call initialize_remapping(cs%remap_cs, remapscheme, boundary_extrapolation=bndextrapolation)
  
   call log_param(param_file, mdl, "!Total sponge columns at h points", total_sponge_cols, &
                  "The total number of columns where sponges are applied at h points.")
  
   if (cs%sponge_uv) then
  
     allocate(data_hu(g%isdB:g%iedB,g%jsd:g%jed,nz_data)); data_hu(:,:,:)=0.0
     allocate(data_hv(g%isd:g%ied,g%jsdB:g%jedB,nz_data)); data_hv(:,:,:)=0.0
     allocate(iresttime_u(g%isdB:g%iedB,g%jsd:g%jed)); iresttime_u(:,:)=0.0
     allocate(iresttime_v(g%isd:g%ied,g%jsdB:g%jedB)); iresttime_v(:,:)=0.0
  
     ! u points
     cs%num_col_u = 0 ; !CS%fldno_u = 0
     do j=cs%jsc,cs%jec; do i=cs%iscB,cs%iecB
        data_hu(i,j,:) = 0.5 * (data_h(i,j,:) + data_h(i+1,j,:))
        iresttime_u(i,j) = 0.5 * (iresttime(i,j) + iresttime(i+1,j))
        if ((iresttime_u(i,j)>0.0) .and. (g%mask2dCu(i,j)>0)) &
           cs%num_col_u = cs%num_col_u + 1
     enddo ; enddo
  
     if (cs%num_col_u > 0) then
  
        allocate(cs%Iresttime_col_u(cs%num_col_u)) ; cs%Iresttime_col_u = 0.0
        allocate(cs%col_i_u(cs%num_col_u))         ; cs%col_i_u = 0
        allocate(cs%col_j_u(cs%num_col_u))         ; cs%col_j_u = 0
  
        ! pass indices, restoring time to the CS structure
        col = 1
        do j=cs%jsc,cs%jec ; do i=cs%iscB,cs%iecB
          if ((iresttime_u(i,j)>0.0) .and. (g%mask2dCu(i,j)>0)) then
            cs%col_i_u(col) = i ; cs%col_j_u(col) = j
            cs%Iresttime_col_u(col) = iresttime_u(i,j)
            col = col +1
          endif
        enddo ; enddo
  
        ! same for total number of arbritary layers and correspondent data
  
        allocate(cs%Ref_hu%p(cs%nz_data,cs%num_col_u))
        do col=1,cs%num_col_u ; do k=1,cs%nz_data
          cs%Ref_hu%p(k,col) = data_hu(cs%col_i_u(col),cs%col_j_u(col),k)
        enddo ; enddo
     endif
     total_sponge_cols_u = cs%num_col_u
     call sum_across_pes(total_sponge_cols_u)
     call log_param(param_file, mdl, "!Total sponge columns at u points", total_sponge_cols_u, &
                 "The total number of columns where sponges are applied at u points.")
  
     ! v points
     cs%num_col_v = 0 ; !CS%fldno_v = 0
     do j=cs%jscB,cs%jecB; do i=cs%isc,cs%iec
       data_hv(i,j,:) = 0.5 * (data_h(i,j,:) + data_h(i,j+1,:))
       iresttime_v(i,j) = 0.5 * (iresttime(i,j) + iresttime(i,j+1))
       if ((iresttime_v(i,j)>0.0) .and. (g%mask2dCv(i,j)>0)) &
         cs%num_col_v = cs%num_col_v + 1
     enddo ; enddo
  
     if (cs%num_col_v > 0) then
  
       allocate(cs%Iresttime_col_v(cs%num_col_v)) ; cs%Iresttime_col_v = 0.0
       allocate(cs%col_i_v(cs%num_col_v))         ; cs%col_i_v = 0
       allocate(cs%col_j_v(cs%num_col_v))         ; cs%col_j_v = 0
  
       ! pass indices, restoring time to the CS structure
       col = 1
       do j=cs%jscB,cs%jecB ; do i=cs%isc,cs%iec
         if ((iresttime_v(i,j)>0.0) .and. (g%mask2dCv(i,j)>0)) then
           cs%col_i_v(col) = i ; cs%col_j_v(col) = j
           cs%Iresttime_col_v(col) = iresttime_v(i,j)
           col = col +1
         endif
       enddo ; enddo
  
       ! same for total number of arbritary layers and correspondent data
       allocate(cs%Ref_hv%p(cs%nz_data,cs%num_col_v))
       do col=1,cs%num_col_v ; do k=1,cs%nz_data
         cs%Ref_hv%p(k,col) = data_hv(cs%col_i_v(col),cs%col_j_v(col),k)
       enddo ; enddo
     endif
     total_sponge_cols_v = cs%num_col_v
     call sum_across_pes(total_sponge_cols_v)
     call log_param(param_file, mdl, "!Total sponge columns at v points", total_sponge_cols_v, &
                  "The total number of columns where sponges are applied at v points.")
   endif
  

◆ initialize_ale_sponge_varying()

subroutine mom_ale_sponge::initialize_ale_sponge::initialize_ale_sponge_varying	(	real, dimension( g %isd: g %ied, g %jsd: g %jed), intent(in)	Iresttime,
		type(ocean_grid_type), intent(in)	G,
		type(param_file_type), intent(in)	param_file,
		type(ale_sponge_cs), pointer	CS
	)

private

This subroutine determines the number of points which are within sponges in this computational domain. Only points that have positive values of Iresttime and which mask2dT indicates are ocean points are included in the sponges.

Parameters

[in]	g	The ocean's grid structure.
[in]	iresttime	The inverse of the restoring time [s-1].
[in]	param_file	A structure indicating the open file to parse for model parameter values.
	cs	A pointer that is set to point to the control structure for this module (in/out).

Definition at line 376 of file MOM_ALE_sponge.F90.

  
   type(ocean_grid_type),            intent(in) :: G !< The ocean's grid structure.
   real, dimension(SZI_(G),SZJ_(G)), intent(in) :: Iresttime !< The inverse of the restoring time [s-1].
   type(param_file_type),            intent(in) :: param_file !< A structure indicating the open file to parse
                                                              !! for model parameter values.
   type(ALE_sponge_CS),              pointer    :: CS !< A pointer that is set to point to the control
                                                      !! structure for this module (in/out).
  
  
  
 ! This include declares and sets the variable "version".
 #include "version_variable.h"
   character(len=40)  :: mdl = "MOM_sponge"  ! This module's name.
   logical :: use_sponge
     real, allocatable, dimension(:,:) :: Iresttime_u !< inverse of the restoring time at u points [s-1]
   real, allocatable, dimension(:,:) :: Iresttime_v !< inverse of the restoring time at v points [s-1]
   logical :: bndExtrapolation = .true. ! If true, extrapolate boundaries
   integer :: i, j, k, col, total_sponge_cols, total_sponge_cols_u, total_sponge_cols_v
   character(len=10)  :: remapScheme
   if (associated(cs)) then
     call mom_error(warning, "initialize_sponge called with an associated "// &
                             "control structure.")
     return
   endif
  
 ! Set default, read and log parameters
   call log_version(param_file, mdl, version, "")
   call get_param(param_file, mdl, "SPONGE", use_sponge, &
                  "If true, sponges may be applied anywhere in the domain. "//&
                  "The exact location and properties of those sponges are "//&
                  "specified from MOM_initialization.F90.", default=.false.)
  
   if (.not.use_sponge) return
  
   allocate(cs)
  
   call get_param(param_file, mdl, "SPONGE_UV", cs%sponge_uv, &
                  "Apply sponges in u and v, in addition to tracers.", &
                  default=.false.)
  
   call get_param(param_file, mdl, "REMAPPING_SCHEME", remapscheme, &
                  "This sets the reconstruction scheme used "//&
                  " for vertical remapping for all variables.", &
                  default="PLM", do_not_log=.true.)
  
   call get_param(param_file, mdl, "BOUNDARY_EXTRAPOLATION", bndextrapolation, &
                  "When defined, a proper high-order reconstruction "//&
                  "scheme is used within boundary cells rather "//&
                  "than PCM. E.g., if PPM is used for remapping, a "//&
                  "PPM reconstruction will also be used within boundary cells.", &
                  default=.false., do_not_log=.true.)
  
   cs%new_sponges = .true.
   cs%nz = g%ke
   cs%isc = g%isc ; cs%iec = g%iec ; cs%jsc = g%jsc ; cs%jec = g%jec
   cs%isd = g%isd ; cs%ied = g%ied ; cs%jsd = g%jsd ; cs%jed = g%jed
   cs%iscB = g%iscB ; cs%iecB = g%iecB; cs%jscB = g%jscB ; cs%jecB = g%jecB
  
   ! number of columns to be restored
   cs%num_col = 0 ; cs%fldno = 0
   do j=g%jsc,g%jec ; do i=g%isc,g%iec
     if ((iresttime(i,j)>0.0) .and. (g%mask2dT(i,j)>0)) &
       cs%num_col = cs%num_col + 1
   enddo ; enddo
  
  
   if (cs%num_col > 0) then
     allocate(cs%Iresttime_col(cs%num_col)) ; cs%Iresttime_col = 0.0
     allocate(cs%col_i(cs%num_col))         ; cs%col_i = 0
     allocate(cs%col_j(cs%num_col))         ; cs%col_j = 0
     ! pass indices, restoring time to the CS structure
     col = 1
     do j=g%jsc,g%jec ; do i=g%isc,g%iec
       if ((iresttime(i,j)>0.0) .and. (g%mask2dT(i,j)>0)) then
         cs%col_i(col) = i ; cs%col_j(col) = j
         cs%Iresttime_col(col) = iresttime(i,j)
         col = col +1
       endif
     enddo ; enddo
   endif
  
   total_sponge_cols = cs%num_col
   call sum_across_pes(total_sponge_cols)
  
 ! Call the constructor for remapping control structure
   call initialize_remapping(cs%remap_cs, remapscheme, boundary_extrapolation=bndextrapolation)
  
   call log_param(param_file, mdl, "!Total sponge columns at h points", total_sponge_cols, &
                  "The total number of columns where sponges are applied at h points.")
  
   if (cs%sponge_uv) then
  
      allocate(iresttime_u(g%isdB:g%iedB,g%jsd:g%jed)); iresttime_u(:,:)=0.0
      allocate(iresttime_v(g%isd:g%ied,g%jsdB:g%jedB)); iresttime_v(:,:)=0.0
  
      ! u points
      cs%num_col_u = 0 ; !CS%fldno_u = 0
      do j=cs%jsc,cs%jec; do i=cs%iscB,cs%iecB
         iresttime_u(i,j) = 0.5 * (iresttime(i,j) + iresttime(i+1,j))
         if ((iresttime_u(i,j)>0.0) .and. (g%mask2dCu(i,j)>0)) &
            cs%num_col_u = cs%num_col_u + 1
      enddo ; enddo
  
      if (cs%num_col_u > 0) then
  
         allocate(cs%Iresttime_col_u(cs%num_col_u)) ; cs%Iresttime_col_u = 0.0
         allocate(cs%col_i_u(cs%num_col_u))         ; cs%col_i_u = 0
         allocate(cs%col_j_u(cs%num_col_u))         ; cs%col_j_u = 0
  
         ! pass indices, restoring time to the CS structure
         col = 1
         do j=cs%jsc,cs%jec ; do i=cs%iscB,cs%iecB
           if ((iresttime_u(i,j)>0.0) .and. (g%mask2dCu(i,j)>0)) then
             cs%col_i_u(col) = i ; cs%col_j_u(col) = j
             cs%Iresttime_col_u(col) = iresttime_u(i,j)
             col = col +1
           endif
         enddo ; enddo
  
         ! same for total number of arbritary layers and correspondent data
  
      endif
      total_sponge_cols_u = cs%num_col_u
      call sum_across_pes(total_sponge_cols_u)
      call log_param(param_file, mdl, "!Total sponge columns at u points", total_sponge_cols_u, &
                  "The total number of columns where sponges are applied at u points.")
  
      ! v points
      cs%num_col_v = 0 ; !CS%fldno_v = 0
      do j=cs%jscB,cs%jecB; do i=cs%isc,cs%iec
         iresttime_v(i,j) = 0.5 * (iresttime(i,j) + iresttime(i,j+1))
         if ((iresttime_v(i,j)>0.0) .and. (g%mask2dCv(i,j)>0)) &
            cs%num_col_v = cs%num_col_v + 1
      enddo ; enddo
  
      if (cs%num_col_v > 0) then
  
         allocate(cs%Iresttime_col_v(cs%num_col_v)) ; cs%Iresttime_col_v = 0.0
         allocate(cs%col_i_v(cs%num_col_v))         ; cs%col_i_v = 0
         allocate(cs%col_j_v(cs%num_col_v))         ; cs%col_j_v = 0
  
         ! pass indices, restoring time to the CS structure
         col = 1
         do j=cs%jscB,cs%jecB ; do i=cs%isc,cs%iec
           if ((iresttime_v(i,j)>0.0) .and. (g%mask2dCv(i,j)>0)) then
             cs%col_i_v(col) = i ; cs%col_j_v(col) = j
             cs%Iresttime_col_v(col) = iresttime_v(i,j)
             col = col +1
           endif
         enddo ; enddo
  
      endif
      total_sponge_cols_v = cs%num_col_v
      call sum_across_pes(total_sponge_cols_v)
      call log_param(param_file, mdl, "!Total sponge columns at v points", total_sponge_cols_v, &
                  "The total number of columns where sponges are applied at v points.")
   endif
  

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

◆ initialize_ale_sponge_fixed()

◆ initialize_ale_sponge_varying()