coord_slight Module Reference

Detailed Description

Regrid columns for the SLight coordinate.

Data Types
type	slight_cs
	Control structure containing required parameters for the SLight coordinate. More...

Functions/Subroutines
subroutine, public	init_coord_slight (CS, nk, ref_pressure, target_density, interp_CS, m_to_H)
	Initialise a slight_CS with pointers to parameters. More...
subroutine, public	end_coord_slight (CS)
	This subroutine deallocates memory in the control structure for the coord_slight module. More...
subroutine, public	set_slight_params (CS, max_interface_depths, max_layer_thickness, min_thickness, compressibility_fraction, dz_ml_min, nz_fixed_surface, Rho_ML_avg_depth, nlay_ML_offset, fix_haloclines, halocline_filter_length, halocline_strat_tol, interp_CS)
	This subroutine can be used to set the parameters for the coord_slight module. More...
subroutine, public	build_slight_column (CS, eqn_of_state, H_to_pres, H_subroundoff, nz, depth, h_col, T_col, S_col, p_col, z_col, z_col_new, h_neglect, h_neglect_edge)
	Build a SLight coordinate column. More...
subroutine	rho_interfaces_col (rho_col, h_col, z_col, rho_tgt, nz, z_col_new, CS, reliable, debug, h_neglect, h_neglect_edge)
	Finds the new interface locations in a column of water that match the prescribed target densities. More...

Function/Subroutine Documentation

build_slight_column()

subroutine, public coord_slight::build_slight_column	(	type(slight_cs), intent(in)	CS,
		type(eos_type), pointer	eqn_of_state,
		real, intent(in)	H_to_pres,
		real, intent(in)	H_subroundoff,
		integer, intent(in)	nz,
		real, intent(in)	depth,
		real, dimension(nz), intent(in)	h_col,
		real, dimension(nz), intent(in)	T_col,
		real, dimension(nz), intent(in)	S_col,
		real, dimension(nz), intent(in)	p_col,
		real, dimension(nz+1), intent(in)	z_col,
		real, dimension(nz+1), intent(inout)	z_col_new,
		real, intent(in), optional	h_neglect,
		real, intent(in), optional	h_neglect_edge
	)

Build a SLight coordinate column.

Parameters

[in]	cs	Coordinate control structure
	eqn_of_state	Equation of state structure
[in]	h_to_pres	A conversion factor from thicknesses to scaled pressure [R L2 T-2 H-1 ~> Pa m-1 or Pa m2 kg-1]
[in]	h_subroundoff	GVH_subroundoff
[in]	nz	Number of levels
[in]	depth	Depth of ocean bottom (positive [H ~> m or kg m-2])
[in]	t_col	T for column
[in]	s_col	S for column
[in]	h_col	Layer thicknesses [H ~> m or kg m-2]
[in]	p_col	Layer center pressure [R L2 T-2 ~> Pa]
[in]	z_col	Interface positions relative to the surface [H ~> m or kg m-2]
[in,out]	z_col_new	Absolute positions of interfaces [H ~> m or kg m-2]
[in]	h_neglect	A negligibly small width for the purpose of cell reconstructions [H ~> m or kg m-2].
[in]	h_neglect_edge	A negligibly small width for the purpose of edge value calculations [H ~> m or kg m-2].

Definition at line 183 of file coord_slight.F90.

  type(slight_CS),       intent(in)    :: CS    !< Coordinate control structure
  type(EOS_type),        pointer       :: eqn_of_state !< Equation of state structure
  real,                  intent(in)    :: H_to_pres !< A conversion factor from thicknesses to
                                                !! scaled pressure [R L2 T-2 H-1 ~> Pa m-1 or Pa m2 kg-1]
  real,                  intent(in)    :: H_subroundoff !< GV%H_subroundoff
  integer,               intent(in)    :: nz    !< Number of levels
  real,                  intent(in)    :: depth !< Depth of ocean bottom (positive [H ~> m or kg m-2])
  real, dimension(nz),   intent(in)    :: T_col !< T for column
  real, dimension(nz),   intent(in)    :: S_col !< S for column
  real, dimension(nz),   intent(in)    :: h_col !< Layer thicknesses [H ~> m or kg m-2]
  real, dimension(nz),   intent(in)    :: p_col !< Layer center pressure [R L2 T-2 ~> Pa]
  real, dimension(nz+1), intent(in)    :: z_col !< Interface positions relative to the surface [H ~> m or kg m-2]
  real, dimension(nz+1), intent(inout) :: z_col_new !< Absolute positions of interfaces [H ~> m or kg m-2]
  real,        optional, intent(in)    :: h_neglect !< A negligibly small width for the purpose of
                                                !! cell reconstructions [H ~> m or kg m-2].
  real,        optional, intent(in)    :: h_neglect_edge !< A negligibly small width for the purpose
                                                !! of edge value calculations [H ~> m or kg m-2].
  ! Local variables
  real, dimension(nz) :: rho_col        ! Layer densities [R ~> kg m-3]
  real, dimension(nz) :: T_f, S_f       ! Filtered layer temperature [degC] and salinity [ppt]
  logical, dimension(nz+1) :: reliable  ! If true, this interface is in a reliable position.
  real, dimension(nz+1) :: T_int, S_int ! Temperature [degC] and salinity [ppt] interpolated to interfaces.
  real, dimension(nz+1) :: rho_tmp      ! A temporary density [R ~> kg m-3]
  real, dimension(nz+1) :: drho_dp      ! The partial derivative of density with pressure [T2 L-2 ~> kg m-3 Pa-1]
  real, dimension(nz+1) :: p_IS, p_R    ! Pressures [R L2 T-2 ~> Pa]
  real, dimension(nz+1) :: drhoIS_dT    ! The partial derivative of in situ density with temperature
                                        ! in [R degC-1 ~> kg m-3 degC-1]
  real, dimension(nz+1) :: drhoIS_dS    ! The partial derivative of in situ density with salinity
                                        ! in [R ppt-1 ~> kg m-3 ppt-1]
  real, dimension(nz+1) :: drhoR_dT     ! The partial derivative of reference density with temperature
                                        ! in [R degC-1 ~> kg m-3 degC-1]
  real, dimension(nz+1) :: drhoR_dS     ! The partial derivative of reference density with salinity
                                        ! in [R ppt-1 ~> kg m-3 ppt-1]
  real, dimension(nz+1) :: strat_rat
  real :: H_to_cPa    ! A conversion factor from thicknesses to the compressibility fraction times
                      ! the units of pressure [R L2 T-2 H-1 ~> Pa m-1 or Pa m2 kg-1]
  real :: drIS, drR   ! In situ and reference density differences [R ~> kg m-3]
  real :: Fn_now, I_HStol, Fn_zero_val ! Nondimensional variables [nondim]
  real :: z_int_unst  ! The depth where the stratification allows the interior grid to start [H ~> m or kg m-2]
  real :: dz          ! A uniform layer thickness in very shallow water [H ~> m or kg m-2].
  real :: dz_ur       ! The total thickness of an unstable region [H ~> m or kg m-2].
  real :: wgt, cowgt  ! A weight and its complement [nondim].
  real :: rho_ml_av   ! The average potential density in a near-surface region [R ~> kg m-3].
  real :: H_ml_av     ! A thickness to try to use in taking the near-surface average [H ~> m or kg m-2].
  real :: rho_x_z     ! A cumulative integral of a density [R H ~> kg m-2 or kg2 m-5].
  real :: z_wt        ! The thickness actually used in taking the near-surface average [H ~> m or kg m-2].
  real :: k_interior  ! The (real) value of k where the interior grid starts [nondim].
  real :: k_int2      ! The (real) value of k where the interior grid starts [nondim].
  real :: z_interior  ! The depth where the interior grid starts [H ~> m or kg m-2].
  real :: z_ml_fix    ! The depth at which the fixed-thickness near-surface layers end [H ~> m or kg m-2].
  real :: dz_dk       ! The thickness of layers between the fixed-thickness
                      ! near-surface layars and the interior [H ~> m or kg m-2].
  real :: Lfilt       ! A filtering lengthscale [H ~> m or kg m-2].
  logical :: maximum_depths_set ! If true, the maximum depths of interface have been set.
  logical :: maximum_h_set      ! If true, the maximum layer thicknesses have been set.
  real :: k2_used, k2here, dz_sum, z_max
  integer :: k2
  real :: h_tr, b_denom_1, b1, d1 ! Temporary variables used by the tridiagonal solver.
  real, dimension(nz) :: c1  ! Temporary variables used by the tridiagonal solver.
  integer :: kur1, kur2  ! The indicies at the top and bottom of an unreliable region.
  integer :: kur_ss      ! The index to start with in the search for the next unstable region.
  integer :: i, j, k, nkml
 
  maximum_depths_set = allocated(cs%max_interface_depths)
  maximum_h_set = allocated(cs%max_layer_thickness)
 
  if (z_col(nz+1) - z_col(1) < nz*cs%min_thickness) then
    ! This is a nearly massless total depth, so distribute the water evenly.
    dz = (z_col(nz+1) - z_col(1)) / real(nz)
    do k=2,nz ; z_col_new(k) = z_col(1) + dz*real(k-1) ; enddo
  else
    call calculate_density(t_col, s_col, p_col, rho_col, eqn_of_state)
 
    ! Find the locations of the target potential densities, flagging
    ! locations in apparently unstable regions as not reliable.
    call rho_interfaces_col(rho_col, h_col, z_col, cs%target_density, nz, &
                            z_col_new, cs, reliable, debug=.true., &
                            h_neglect=h_neglect, h_neglect_edge=h_neglect_edge)
 
    ! Ensure that the interfaces are at least CS%min_thickness apart.
    if (cs%min_thickness > 0.0) then
      ! Move down interfaces below overly thin layers.
      do k=2,nz ; if (z_col_new(k) < z_col_new(k-1) + cs%min_thickness) then
        z_col_new(k) = z_col_new(k-1) + cs%min_thickness
      endif ; enddo
      ! Now move up any interfaces that are too close to the bottom.
      do k=nz,2,-1 ; if (z_col_new(k) > z_col_new(k+1) - cs%min_thickness) then
        z_col_new(k) = z_col_new(k+1) - cs%min_thickness
      else
        exit ! No more interfaces can be too close to the bottom.
      endif ; enddo
    endif
 
    ! Fix up the unreliable regions.
    kur_ss = 2 ! reliable(1) and reliable(nz+1) must always be true.
    do
      ! Search for the uppermost unreliable interface postion.
      kur1 = nz+2
      do k=kur_ss,nz ; if (.not.reliable(k)) then
        kur1 = k ; exit
      endif ; enddo
      if (kur1 > nz) exit ! Everything is now reliable.
 
      kur2 = kur1-1 ! For error checking.
      do k=kur1+1,nz+1 ; if (reliable(k)) then
        kur2 = k-1 ; kur_ss = k ; exit
      endif ; enddo
      if (kur2 < kur1) call mom_error(fatal, "Bad unreliable range.")
 
      dz_ur = z_col_new(kur2+1) - z_col_new(kur1-1)
  !        drho = CS%target_density(kur2+1) - CS%target_density(kur1-1)
      ! Perhaps reset the wgt and cowgt depending on how bad the old interface
      ! locations were.
      wgt = 1.0 ; cowgt = 0.0 ! = 1.0-wgt
      do k=kur1,kur2
        z_col_new(k) = cowgt*z_col_new(k) + &
              wgt * (z_col_new(kur1-1) + dz_ur*(k - (kur1-1)) / ((kur2 - kur1) + 2))
      enddo
    enddo
 
    ! Determine which interfaces are in the s-space region and the depth extent
    ! of this region.
    z_wt = 0.0 ; rho_x_z = 0.0
    h_ml_av = cs%Rho_ml_avg_depth
    do k=1,nz
      if (z_wt + h_col(k) >= h_ml_av) then
        rho_x_z = rho_x_z + rho_col(k) * (h_ml_av - z_wt)
        z_wt = h_ml_av
        exit
      else
        rho_x_z =  rho_x_z + rho_col(k) * h_col(k)
        z_wt = z_wt + h_col(k)
      endif
    enddo
    if (z_wt > 0.0) rho_ml_av = rho_x_z / z_wt
 
    nkml = cs%nz_fixed_surface
    ! Find the interface that matches rho_ml_av.
    if (rho_ml_av <= cs%target_density(nkml)) then
      k_interior = cs%nlay_ml_offset + real(nkml)
    elseif (rho_ml_av > cs%target_density(nz+1)) then
      k_interior = real(nz+1)
    else ; do k=nkml,nz
      if ((rho_ml_av >= cs%target_density(k)) .and. &
          (rho_ml_av <  cs%target_density(k+1))) then
        k_interior = (cs%nlay_ml_offset + k) + &
                (rho_ml_av - cs%target_density(k)) / &
                (cs%target_density(k+1) - cs%target_density(k))
        exit
      endif
    enddo ; endif
    if (k_interior > real(nz+1)) k_interior = real(nz+1)
 
    ! Linearly interpolate to find z_interior.  This could be made more sophisticated.
    k = int(ceiling(k_interior))
    z_interior = (k-k_interior)*z_col_new(k-1) + (1.0+(k_interior-k))*z_col_new(k)
 
    if (cs%fix_haloclines) then
  !       ! Identify regions above the reference pressure where the chosen
  !       ! potential density significantly underestimates the actual
  !       ! stratification, and use these to find a second estimate of
  !       ! z_int_unst and k_interior.
 
      if (cs%halocline_filter_length > 0.0) then
        lfilt = cs%halocline_filter_length
 
        ! Filter the temperature and salnity with a fixed lengthscale.
        h_tr = h_col(1) + h_subroundoff
        b1 = 1.0 / (h_tr + lfilt) ; d1 = h_tr * b1
        t_f(1) = (b1*h_tr)*t_col(1) ;  s_f(1) = (b1*h_tr)*s_col(1)
        do k=2,nz
          c1(k) = lfilt * b1
          h_tr = h_col(k) + h_subroundoff ; b_denom_1 = h_tr + d1*lfilt
          b1 = 1.0 / (b_denom_1 + lfilt) ; d1 = b_denom_1 * b1
          t_f(k) = b1 * (h_tr*t_col(k) + lfilt*t_f(k-1))
          s_f(k) = b1 * (h_tr*s_col(k) + lfilt*s_f(k-1))
        enddo
        do k=nz-1,1,-1
          t_f(k) = t_f(k) + c1(k+1)*t_f(k+1) ; s_f(k) = s_f(k) + c1(k+1)*s_f(k+1)
        enddo
      else
        do k=1,nz ; t_f(k) = t_col(k) ; s_f(k) = s_col(k) ; enddo
      endif
 
      t_int(1) = t_f(1) ; s_int(1) = s_f(1)
      do k=2,nz
        t_int(k) = 0.5*(t_f(k-1) + t_f(k)) ; s_int(k) = 0.5*(s_f(k-1) + s_f(k))
        p_is(k) = z_col(k) * h_to_pres
        p_r(k) = cs%ref_pressure + cs%compressibility_fraction * ( p_is(k) - cs%ref_pressure )
      enddo
      t_int(nz+1) = t_f(nz) ; s_int(nz+1) = s_f(nz)
      p_is(nz+1) = z_col(nz+1) * h_to_pres
      call calculate_density_derivs(t_int, s_int, p_is, drhois_dt, drhois_ds, &
                                    eqn_of_state, (/2,nz/) )
      call calculate_density_derivs(t_int, s_int, p_r, drhor_dt, drhor_ds, &
                                    eqn_of_state, (/2,nz/) )
      if (cs%compressibility_fraction > 0.0) then
        call calculate_compress(t_int, s_int, p_r(:), rho_tmp, drho_dp, 2, nz-1, eqn_of_state)
      else
        do k=2,nz ; drho_dp(k) = 0.0 ; enddo
      endif
 
      h_to_cpa = cs%compressibility_fraction * h_to_pres
      strat_rat(1) = 1.0
      do k=2,nz
        dris = drhois_dt(k) * (t_f(k) - t_f(k-1)) + &
               drhois_ds(k) * (s_f(k) - s_f(k-1))
        drr = (drhor_dt(k) * (t_f(k) - t_f(k-1)) + &
               drhor_ds(k) * (s_f(k) - s_f(k-1))) + &
              drho_dp(k) * (h_to_cpa*0.5*(h_col(k) + h_col(k-1)))
 
        if (dris <= 0.0) then
          strat_rat(k) = 2.0 ! Maybe do this? => ; if (drR < 0.0) strat_rat(K) = -2.0
        else
          strat_rat(k) = 2.0*max(drr,0.0) / (dris + abs(drr))
        endif
      enddo
      strat_rat(nz+1) = 1.0
 
      z_int_unst = 0.0 ; fn_now = 0.0
      fn_zero_val = min(2.0*cs%halocline_strat_tol, &
                        0.5*(1.0 + cs%halocline_strat_tol))
      if (cs%halocline_strat_tol > 0.0) then
        ! Use Adcroft's reciprocal rule.
        i_hstol = 0.0 ; if (fn_zero_val - cs%halocline_strat_tol > 0.0) &
          i_hstol = 1.0 / (fn_zero_val - cs%halocline_strat_tol)
        do k=nz,1,-1 ; if (cs%ref_pressure > p_is(k+1)) then
          z_int_unst = z_int_unst + fn_now * h_col(k)
          if (strat_rat(k) <= fn_zero_val) then
            if (strat_rat(k) <= cs%halocline_strat_tol) then ; fn_now = 1.0
            else
              fn_now = max(fn_now, (fn_zero_val - strat_rat(k)) * i_hstol)
            endif
          endif
        endif ; enddo
      else
        do k=nz,1,-1 ; if (cs%ref_pressure > p_is(k+1)) then
          z_int_unst = z_int_unst + fn_now * h_col(k)
          if (strat_rat(k) <= cs%halocline_strat_tol) fn_now = 1.0
        endif ; enddo
      endif
 
      if (z_interior < z_int_unst) then
        ! Find a second estimate of the extent of the s-coordinate region.
        kur1 = max(int(ceiling(k_interior)),2)
        if (z_col_new(kur1-1) < z_interior) then
          k_int2 = kur1
          do k = kur1,nz+1 ; if (z_col_new(k) >= z_int_unst) then
            ! This is linear interpolation again.
            if (z_col_new(k-1) >= z_int_unst) &
              call mom_error(fatal,"build_grid_SLight, bad halocline structure.")
            k_int2 = real(k-1) + (z_int_unst - z_col_new(k-1)) / &
                                     (z_col_new(k) - z_col_new(k-1))
            exit
          endif ; enddo
          if (z_col_new(nz+1) < z_int_unst) then
            ! This should be unnecessary.
            z_int_unst = z_col_new(nz+1) ; k_int2 = real(nz+1)
          endif
 
          ! Now take the larger values.
          if (k_int2 > k_interior) then
            k_interior = k_int2 ; z_interior = z_int_unst
          endif
        endif
      endif
    endif  ! fix_haloclines
 
    z_col_new(1) = 0.0
    do k=2,nkml+1
      z_col_new(k) = min((k-1)*cs%dz_ml_min, &
                         z_col_new(nz+1) - cs%min_thickness*(nz+1-k))
    enddo
    z_ml_fix = z_col_new(nkml+1)
    if (z_interior > z_ml_fix) then
      dz_dk = (z_interior - z_ml_fix) / (k_interior - (nkml+1))
      do k=nkml+2,int(floor(k_interior))
        z_col_new(k) = z_ml_fix + dz_dk * (k - (nkml+1))
      enddo
    else ! The fixed-thickness z-region penetrates into the interior.
      do k=nkml+2,nz
        if (z_col_new(k) <= z_col_new(cs%nz_fixed_surface+1)) then
          z_col_new(k) = z_col_new(cs%nz_fixed_surface+1)
        else ; exit ; endif
      enddo
    endif
 
    if (maximum_depths_set .and. maximum_h_set) then ; do k=2,nz
      ! The loop bounds are 2 & nz so the top and bottom interfaces do not move.
      ! Recall that z_col_new is positive downward.
      z_col_new(k) = min(z_col_new(k), cs%max_interface_depths(k), &
                         z_col_new(k-1) + cs%max_layer_thickness(k-1))
    enddo ; elseif (maximum_depths_set) then ; do k=2,nz
      z_col_new(k) = min(z_col_new(k), cs%max_interface_depths(k))
    enddo ; elseif (maximum_h_set) then ; do k=2,nz
      z_col_new(k) = min(z_col_new(k), z_col_new(k-1) + cs%max_layer_thickness(k-1))
    enddo ; endif
 
  endif ! Total thickness exceeds nz*CS%min_thickness.
 

end_coord_slight()

subroutine, public coord_slight::end_coord_slight

(

type(slight_cs), pointer

CS

)

This subroutine deallocates memory in the control structure for the coord_slight module.

Parameters

cs	Coordinate control structure

Definition at line 105 of file coord_slight.F90.

  type(slight_CS), pointer :: CS !< Coordinate control structure
 
  ! nothing to do
  if (.not. associated(cs)) return
  deallocate(cs%target_density)
  deallocate(cs)

init_coord_slight()

subroutine, public coord_slight::init_coord_slight	(	type(slight_cs), pointer	CS,
		integer, intent(in)	nk,
		real, intent(in)	ref_pressure,
		real, dimension(:), intent(in)	target_density,
		type(interp_cs_type), intent(in)	interp_CS,
		real, intent(in), optional	m_to_H
	)

Initialise a slight_CS with pointers to parameters.

Parameters

	cs	Unassociated pointer to hold the control structure
[in]	nk	Number of layers in the grid
[in]	ref_pressure	Coordinate reference pressure [R L2 T-2 ~> Pa]
[in]	target_density	Nominal density of interfaces [R ~> kg m-3]
[in]	interp_cs	Controls for interpolation
[in]	m_to_h	A conversion factor from m to the units of thicknesses

Definition at line 73 of file coord_slight.F90.

  type(slight_CS),      pointer    :: CS !< Unassociated pointer to hold the control structure
  integer,              intent(in) :: nk !< Number of layers in the grid
  real,                 intent(in) :: ref_pressure !< Coordinate reference pressure [R L2 T-2 ~> Pa]
  real, dimension(:),   intent(in) :: target_density !< Nominal density of interfaces [R ~> kg m-3]
  type(interp_CS_type), intent(in) :: interp_CS !< Controls for interpolation
  real,       optional, intent(in) :: m_to_H !< A conversion factor from m to the units of thicknesses
 
  real :: m_to_H_rescale  ! A unit conversion factor.
 
  if (associated(cs)) call mom_error(fatal, "init_coord_slight: CS already associated!")
  allocate(cs)
  allocate(cs%target_density(nk+1))
 
  m_to_h_rescale = 1.0 ; if (present(m_to_h)) m_to_h_rescale = m_to_h
 
  cs%nk                = nk
  cs%ref_pressure      = ref_pressure
  cs%target_density(:) = target_density(:)
  cs%interp_CS         = interp_cs
 
  ! Set real parameter default values
  cs%compressibility_fraction = 0. ! Nondim.
  cs%Rho_ML_avg_depth = 1.0 * m_to_h_rescale
  cs%nlay_ml_offset = 2.0          ! Nondim.
  cs%dz_ml_min = 1.0 * m_to_h_rescale
  cs%halocline_filter_length = 2.0 * m_to_h_rescale
  cs%halocline_strat_tol = 0.25    ! Nondim.
 

rho_interfaces_col()

subroutine coord_slight::rho_interfaces_col ( real, dimension(nz), intent(in)  rho_col, real, dimension(nz), intent(in)  h_col, real, dimension(nz+1), intent(in)  z_col, real, dimension(nz+1), intent(in)  rho_tgt, integer, intent(in)  nz, real, dimension(nz+1), intent(inout)  z_col_new, type(slight_cs), intent(in)  CS, logical, dimension(nz+1), intent(inout)  reliable, logical, intent(in), optional  debug, real, intent(in), optional  h_neglect, real, intent(in), optional  h_neglect_edge  )

private

Finds the new interface locations in a column of water that match the prescribed target densities.

Parameters

[in]	nz	Number of layers
[in]	rho_col	Initial layer reference densities [R ~> kg m-3].
[in]	h_col	Initial layer thicknesses [H ~> m or kg m-2].
[in]	z_col	Initial interface heights [H ~> m or kg m-2].
[in]	rho_tgt	Interface target densities.
[in,out]	z_col_new	New interface heights [H ~> m or kg m-2].
[in]	cs	Coordinate control structure
[in,out]	reliable	If true, the interface positions are well defined from a stable region.
[in]	debug	If present and true, do debugging checks.
[in]	h_neglect	A negligibly small width for the purpose of cell reconstructions [H ~> m or kg m-2]
[in]	h_neglect_edge	A negligibly small width for the purpose of edge value calculations [H ~> m or kg m-2]

Definition at line 489 of file coord_slight.F90.

  integer,               intent(in)    :: nz      !< Number of layers
  real, dimension(nz),   intent(in)    :: rho_col !< Initial layer reference densities [R ~> kg m-3].
  real, dimension(nz),   intent(in)    :: h_col   !< Initial layer thicknesses [H ~> m or kg m-2].
  real, dimension(nz+1), intent(in)    :: z_col   !< Initial interface heights [H ~> m or kg m-2].
  real, dimension(nz+1), intent(in)    :: rho_tgt !< Interface target densities.
  real, dimension(nz+1), intent(inout) :: z_col_new !< New interface heights [H ~> m or kg m-2].
  type(slight_CS),       intent(in)    :: CS      !< Coordinate control structure
  logical, dimension(nz+1), intent(inout) :: reliable !< If true, the interface positions
                                                  !! are well defined from a stable region.
  logical,     optional, intent(in)    :: debug   !< If present and true, do debugging checks.
  real,        optional, intent(in)    :: h_neglect !< A negligibly small width for the purpose of
                                                  !! cell reconstructions [H ~> m or kg m-2]
  real,        optional, intent(in)    :: h_neglect_edge !< A negligibly small width for the purpose
                                                  !! of edge value calculations [H ~> m or kg m-2]
 
  real, dimension(nz+1) :: ru_max_int ! The maximum and minimum densities in
  real, dimension(nz+1) :: ru_min_int ! an unstable region around an interface [R ~> kg m-3].
  real, dimension(nz)   :: ru_max_lay ! The maximum and minimum densities in
  real, dimension(nz)   :: ru_min_lay ! an unstable region containing a layer [R ~> kg m-3].
  real, dimension(nz,2) :: ppoly_i_E  ! Edge value of polynomial [R ~> kg m-3]
  real, dimension(nz,2) :: ppoly_i_S  ! Edge slope of polynomial [R H-1 ~> kg m-4 or m-1]
  real, dimension(nz,DEGREE_MAX+1) :: ppoly_i_coefficients ! Coefficients of polynomial [R ~> kg m-3]
  logical, dimension(nz)   :: unstable_lay ! If true, this layer is in an unstable region.
  logical, dimension(nz+1) :: unstable_int ! If true, this interface is in an unstable region.
  real :: rt  ! The current target density [R ~> kg m-3].
  real :: zf  ! The fractional z-position within a layer of the target density [nondim].
  real :: rfn ! The target density relative to the interpolated density [R ~> kg m-3]
  real :: a(5) ! Coefficients of a local polynomial minus the target density [R ~> kg m-3].
  real :: zf1, zf2   ! Two previous estimates of zf [nondim]
  real :: rfn1, rfn2 ! Values of rfn at zf1 and zf2 [R ~> kg m-3]
  real :: drfn_dzf   ! The partial derivative of rfn with zf [R ~> kg m-3]
  real :: sgn, delta_zf, zf_prev ! [nondim]
  real :: tol  ! The tolerance for convergence of zf [nondim]
  logical :: k_found ! If true, the position has been found.
  integer :: k_layer ! The index of the stable layer containing an interface.
  integer :: ppoly_degree
  integer :: k, k1, k1_min, itt, max_itt, m
 
  real :: z_sgn  ! 1 or -1, depending on whether z increases with increasing K.
  logical :: debugging
 
  debugging = .false. ; if (present(debug)) debugging = debug
  max_itt = nr_iterations
  tol = nr_tolerance
 
  z_sgn = 1.0 ; if ( z_col(1) > z_col(nz+1) ) z_sgn = -1.0
  if (debugging) then
    do k=1,nz
      if (abs((z_col(k+1) - z_col(k)) - z_sgn*h_col(k)) > &
          1.0e-14*(abs(z_col(k+1)) + abs(z_col(k)) + abs(h_col(k))) ) &
        call mom_error(fatal, "rho_interfaces_col: Inconsistent z_col and h_col")
    enddo
  endif
 
  if ( z_col(1) == z_col(nz+1) ) then
    ! This is a massless column!
    do k=1,nz+1 ; z_col_new(k) = z_col(1) ; reliable(k) = .true. ; enddo
    return
  endif
 
  ! This sets up the piecewise polynomials based on the rho_col profile.
  call regridding_set_ppolys(cs%interp_CS, rho_col, nz, h_col, ppoly_i_e, ppoly_i_s, &
       ppoly_i_coefficients, ppoly_degree, h_neglect, h_neglect_edge)
 
  ! Determine the density ranges of unstably stratified segments.
  ! Interfaces that start out in an unstably stratified segment can
  ! only escape if they are outside of the bounds of that segment, and no
  ! interfaces are ever mapped into an unstable segment.
  unstable_int(1) = .false.
  ru_max_int(1) = ppoly_i_e(1,1)
 
  unstable_lay(1) = (ppoly_i_e(1,1) > ppoly_i_e(1,2))
  ru_max_lay(1) = max(ppoly_i_e(1,1), ppoly_i_e(1,2))
 
  do k=2,nz
    unstable_int(k) = (ppoly_i_e(k-1,2) > ppoly_i_e(k,1))
    ru_max_int(k) = max(ppoly_i_e(k-1,2), ppoly_i_e(k,1))
    ru_min_int(k) = min(ppoly_i_e(k-1,2), ppoly_i_e(k,1))
    if (unstable_int(k) .and. unstable_lay(k-1)) &
      ru_max_int(k) = max(ru_max_lay(k-1), ru_max_int(k))
 
    unstable_lay(k) = (ppoly_i_e(k,1) > ppoly_i_e(k,2))
    ru_max_lay(k) = max(ppoly_i_e(k,1), ppoly_i_e(k,2))
    ru_min_lay(k) = min(ppoly_i_e(k,1), ppoly_i_e(k,2))
    if (unstable_lay(k) .and. unstable_int(k)) &
      ru_max_lay(k) = max(ru_max_int(k), ru_max_lay(k))
  enddo
  unstable_int(nz+1) = .false.
  ru_min_int(nz+1) = ppoly_i_e(nz,2)
 
  do k=nz,1,-1
    if (unstable_lay(k) .and. unstable_int(k+1)) &
      ru_min_lay(k) = min(ru_min_int(k+1), ru_min_lay(k))
 
    if (unstable_int(k) .and. unstable_lay(k)) &
      ru_min_int(k) = min(ru_min_lay(k), ru_min_int(k))
  enddo
 
  z_col_new(1) = z_col(1) ; reliable(1) = .true.
  k1_min = 1
  do k=2,nz ! Find the locations of the various target densities for the interfaces.
    rt = rho_tgt(k)
    k_layer = -1
    k_found = .false.
 
    ! Many light layers are found at the top, so start there.
    if (rt <= ppoly_i_e(k1_min,1)) then
      z_col_new(k) = z_col(k1_min)
      k_found = .true.
      ! Do not change k1_min for the next layer.
    elseif (k1_min == nz+1) then
      z_col_new(k) = z_col(nz+1)
    else
      ! Start with the previous location and search outward.
      if (unstable_int(k) .and. (rt >= ru_min_int(k)) .and. (rt <= ru_max_int(k))) then
        ! This interface started in an unstable region and should not move due to remapping.
        z_col_new(k) = z_col(k) ; reliable(k) = .false.
        k1_min = k ; k_found = .true.
      elseif ((rt >= ppoly_i_e(k-1,2)) .and. (rt <= ppoly_i_e(k,1))) then
        ! This interface is already in the right place and does not move.
        z_col_new(k) = z_col(k) ; reliable(k) = .true.
        k1_min = k ; k_found = .true.
      elseif (rt < ppoly_i_e(k-1,2)) then   ! Search upward
        do k1=k-1,k1_min,-1
          ! Check whether rt is in layer k.
          if ((rt < ppoly_i_e(k1,2)) .and. (rt > ppoly_i_e(k1,1))) then
            ! rt is in layer k.
            k_layer = k1
            k1_min = k1 ; k_found = .true. ; exit
          elseif (unstable_lay(k1) .and. (rt >= ru_min_lay(k1)) .and. (rt <= ru_max_lay(k1))) then
            ! rt would be found at unstable layer that it can not penetrate.
            !   It is possible that this can never happen?
            z_col_new(k) = z_col(k1+1) ; reliable(k) = .false.
            k1_min = k1 ; k_found = .true. ; exit
          endif
          ! Check whether rt is at interface K.
          if (k1 > 1) then ; if ((rt <= ppoly_i_e(k1,1)) .and. (rt >= ppoly_i_e(k1-1,2))) then
            ! rt is at interface K1
            z_col_new(k) = z_col(k1) ; reliable(k) = .true.
            k1_min = k1 ; k_found = .true. ; exit
          elseif (unstable_int(k1) .and. (rt >= ru_min_int(k1)) .and. (rt <= ru_max_int(k1))) then
            ! rt would be found at an unstable interface that it can not pass.
            !   It is possible that this can never happen?
            z_col_new(k) = z_col(k1) ; reliable(k) = .false.
            k1_min = k1 ; k_found = .true. ; exit
          endif ; endif
        enddo
 
        if (.not.k_found) then
          ! This should not happen unless k1_min = 1.
          if (k1_min < 2) then
            z_col_new(k) = z_col(k1_min)
          else
            z_col_new(k) = z_col(k1_min)
          endif
        endif
 
      else  ! Search downward
        do k1=k,nz
          if ((rt < ppoly_i_e(k1,2)) .and. (rt > ppoly_i_e(k1,1))) then
            ! rt is in layer k.
            k_layer = k1
            k1_min = k1 ; k_found = .true. ; exit
          elseif (unstable_lay(k1) .and. (rt >= ru_min_lay(k1)) .and. (rt <= ru_max_lay(k1))) then
            ! rt would be found at unstable layer that it can not penetrate.
            !   It is possible that this can never happen?
            z_col_new(k) = z_col(k1)
            reliable(k) = .false.
            k1_min = k1 ; k_found = .true. ; exit
          endif
          if (k1 < nz) then ; if ((rt <= ppoly_i_e(k1+1,1)) .and. (rt >= ppoly_i_e(k1,2))) then
            ! rt is at interface K1+1
 
            z_col_new(k) = z_col(k1+1) ; reliable(k) = .true.
            k1_min = k1+1 ; k_found = .true. ; exit
          elseif (unstable_int(k1+1) .and. (rt >= ru_min_int(k1+1)) .and. (rt <= ru_max_int(k1+1))) then
            ! rt would be found at an unstable interface that it can not pass.
            !   It is possible that this can never happen?
            z_col_new(k) = z_col(k1+1)
            reliable(k) = .false.
            k1_min = k1+1 ; k_found = .true. ; exit
          endif ; endif
        enddo
        if (.not.k_found) then
          z_col_new(k) = z_col(nz+1)
          if (rt >= ppoly_i_e(nz,2)) then
            reliable(k) = .true.
          else
            reliable(k) = .false.
          endif
        endif
      endif
 
      if (k_layer > 0) then  ! The new location is inside of layer k_layer.
        ! Note that this is coded assuming that this layer is stably stratified.
        if (.not.(ppoly_i_e(k1,2) > ppoly_i_e(k1,1))) call mom_error(fatal, &
          "build_grid_SLight: Erroneously searching for an interface in an unstratified layer.")
 
        ! Use the false position method to find the location (degree <= 1) or the first guess.
        zf = (rt - ppoly_i_e(k1,1)) / (ppoly_i_e(k1,2) - ppoly_i_e(k1,1))
 
        if (ppoly_degree > 1) then ! Iterate to find the solution.
          a(:) = 0.0 ; a(1) = ppoly_i_coefficients(k_layer,1) - rt
          do m=2,ppoly_degree+1 ; a(m) = ppoly_i_coefficients(k_layer,m) ; enddo
          ! Bracket the root.
          zf1 = 0.0 ; rfn1 = a(1)
          zf2 = 1.0 ; rfn2 =  a(1) + (a(2) + (a(3) + (a(4) + a(5))))
          if (rfn1 * rfn2 > 0.0) call mom_error(fatal, "build_grid_SLight: Bad bracketing.")
 
          do itt=1,max_itt
            rfn = a(1) + zf*(a(2) + zf*(a(3) + zf*(a(4) + zf*a(5))))
            ! Reset one of the ends of the bracket.
            if (rfn * rfn1 > 0.0) then
              zf1 = zf ; rfn1 = rfn
            else
              zf2 = zf ; rfn2 = rfn
            endif
            if (rfn1 == rfn2) exit
 
            drfn_dzf = (a(2) + zf*(2.0*a(3) + zf*(3.0*a(4) + zf*4.0*a(5))))
            sgn = 1.0 ; if (drfn_dzf < 0.0) sgn = -1.0
 
            if ((sgn*(zf - rfn) >= zf1 * abs(drfn_dzf)) .and. &
                (sgn*(zf - rfn) <= zf2 * abs(drfn_dzf))) then
              delta_zf = -rfn / drfn_dzf
              zf = zf + delta_zf
            else ! Newton's method goes out of bounds, so use a false position method estimate
              zf_prev = zf
              zf = ( rfn2 * zf1 - rfn1 * zf2 ) / (rfn2 - rfn1)
              delta_zf = zf - zf_prev
            endif
 
            if (abs(delta_zf) < tol) exit
          enddo
        endif
        z_col_new(k) = z_col(k_layer) + zf * z_sgn * h_col(k_layer)
        reliable(k) = .true.
      endif
 
    endif
 
  enddo
  z_col_new(nz+1) = z_col(nz+1) ; reliable(nz+1) = .true.
 

set_slight_params()

subroutine, public coord_slight::set_slight_params	(	type(slight_cs), pointer	CS,
		real, dimension(:), intent(in), optional	max_interface_depths,
		real, dimension(:), intent(in), optional	max_layer_thickness,
		real, intent(in), optional	min_thickness,
		real, intent(in), optional	compressibility_fraction,
		real, intent(in), optional	dz_ml_min,
		integer, intent(in), optional	nz_fixed_surface,
		real, intent(in), optional	Rho_ML_avg_depth,
		real, intent(in), optional	nlay_ML_offset,
		logical, intent(in), optional	fix_haloclines,
		real, intent(in), optional	halocline_filter_length,
		real, intent(in), optional	halocline_strat_tol,
		type(interp_cs_type), intent(in), optional	interp_CS
	)

This subroutine can be used to set the parameters for the coord_slight module.

Parameters

	cs	Coordinate control structure
[in]	max_interface_depths	Maximum depths of interfaces [H ~> m or kg m-2]
[in]	max_layer_thickness	Maximum thicknesses of layers [H ~> m or kg m-2]
[in]	min_thickness	Minimum thickness allowed when building the new grid through regridding [H ~> m or kg m-2]
[in]	compressibility_fraction	Fraction (between 0 and 1) of compressibility to add to potential density profiles when interpolating for target grid positions. [nondim]
[in]	dz_ml_min	The fixed resolution in the topmost SLight_nkml_min layers [H ~> m or kg m-2]
[in]	nz_fixed_surface	The number of fixed-thickness layers at the top of the model
[in]	rho_ml_avg_depth	Depth over which to average to determine the mixed layer potential density [H ~> m or kg m-2]
[in]	nlay_ml_offset	Number of layers to offset the mixed layer density to find resolved stratification [nondim]
[in]	fix_haloclines	If true, detect regions with much weaker than based on in-situ density, and use a stretched coordinate there.
[in]	halocline_filter_length	A length scale over which to filter T & S when looking for spuriously unstable water mass profiles [H ~> m or kg m-2].
[in]	halocline_strat_tol	A value of the stratification ratio that defines a problematic halocline region [nondim].
[in]	interp_cs	Controls for interpolation

Definition at line 118 of file coord_slight.F90.

  type(slight_CS),   pointer    :: CS !< Coordinate control structure
  real, dimension(:), &
           optional, intent(in) :: max_interface_depths !< Maximum depths of interfaces [H ~> m or kg m-2]
  real, dimension(:), &
           optional, intent(in) :: max_layer_thickness  !< Maximum thicknesses of layers [H ~> m or kg m-2]
  real,    optional, intent(in) :: min_thickness    !< Minimum thickness allowed when building the
                                      !! new grid through regridding [H ~> m or kg m-2]
  real,    optional, intent(in) :: compressibility_fraction !< Fraction (between 0 and 1) of
                                      !! compressibility to add to potential density profiles when
                                      !! interpolating for target grid positions. [nondim]
  real,    optional, intent(in) :: dz_ml_min        !< The fixed resolution in the topmost
                                      !! SLight_nkml_min layers [H ~> m or kg m-2]
  integer, optional, intent(in) :: nz_fixed_surface !< The number of fixed-thickness layers at the
                                      !! top of the model
  real,    optional, intent(in) :: Rho_ML_avg_depth !< Depth over which to average to determine
                                      !! the mixed layer potential density [H ~> m or kg m-2]
  real,    optional, intent(in) :: nlay_ML_offset   !< Number of layers to offset the mixed layer
                                      !! density to find resolved stratification [nondim]
  logical, optional, intent(in) :: fix_haloclines   !< If true, detect regions with much weaker than
                                      !! based on in-situ density, and use a stretched coordinate there.
  real,    optional, intent(in) :: halocline_filter_length !< A length scale over which to filter T & S
                                      !! when looking for spuriously unstable water mass profiles [H ~> m or kg m-2].
  real,    optional, intent(in) :: halocline_strat_tol !< A value of the stratification ratio that
                                      !! defines a problematic halocline region [nondim].
  type(interp_CS_type), &
           optional, intent(in) :: interp_CS !< Controls for interpolation
 
  if (.not. associated(cs)) call mom_error(fatal, "set_slight_params: CS not associated")
 
  if (present(max_interface_depths)) then
    if (size(max_interface_depths) /= cs%nk+1) &
      call mom_error(fatal, "set_slight_params: max_interface_depths inconsistent size")
    allocate(cs%max_interface_depths(cs%nk+1))
    cs%max_interface_depths(:) = max_interface_depths(:)
  endif
 
  if (present(max_layer_thickness)) then
    if (size(max_layer_thickness) /= cs%nk) &
      call mom_error(fatal, "set_slight_params: max_layer_thickness inconsistent size")
    allocate(cs%max_layer_thickness(cs%nk))
    cs%max_layer_thickness(:) = max_layer_thickness(:)
  endif
 
  if (present(min_thickness)) cs%min_thickness = min_thickness
  if (present(compressibility_fraction)) cs%compressibility_fraction = compressibility_fraction
 
  if (present(dz_ml_min)) cs%dz_ml_min = dz_ml_min
  if (present(nz_fixed_surface)) cs%nz_fixed_surface = nz_fixed_surface
  if (present(rho_ml_avg_depth)) cs%Rho_ML_avg_depth = rho_ml_avg_depth
  if (present(nlay_ml_offset)) cs%nlay_ML_offset = nlay_ml_offset
  if (present(fix_haloclines)) cs%fix_haloclines = fix_haloclines
  if (present(halocline_filter_length)) cs%halocline_filter_length = halocline_filter_length
  if (present(halocline_strat_tol)) then
    if (halocline_strat_tol > 1.0) call mom_error(fatal, "set_slight_params: "//&
        "HALOCLINE_STRAT_TOL must not exceed 1.0.")
    cs%halocline_strat_tol = halocline_strat_tol
  endif
 
  if (present(interp_cs)) cs%interp_CS = interp_cs